-
Notifications
You must be signed in to change notification settings - Fork 43
feat: support configurable CLI global config #1011
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
EhabY
wants to merge
4
commits into
main
Choose a base branch
from
feat/global-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
47e6efd
feat: support configurable CLI global config
EhabY b5695de
refactor: address global config review feedback
EhabY 6d03c00
refactor: reorganize util modules and return token source
EhabY e67abdc
test: cover keyring login path, toRemoteAuthority, and dedupe URL nor…
EhabY File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of separate variables could we just have users add the flag to
coder.globalFlags? Then we change the order so theirs takes precedence.If we combine this with always running
coder login tokenthen we never need to actually know where the global dir is ourselves.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In that case all deployments would share the same location by default which is why we introduced this per-deployment storage and the internal use of the
global-configUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure I follow, we should keep our current default. The simplest solution would be to just prepend our default so the user's takes precedence when the CLI parses the flags (at least, I am pretty sure when the flag is duplicated the last takes precedence).
We could also check for the flag and avoid adding our default if we wanted the flags to be a bit "cleaner" without repeats.
That does make me think though, I wonder if we should provide a variable so users can configure their own multi-deployment setup with different paths to avoid collisions. So they could do something like
--global-config /path/to/my/global/configs/${env:CODER_URL}or something like that.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In file mode the extension reads/writes the url+session files itself (and defaults the binary cache under this dir), so it needs the path directly, a flag in
coder.globalFlagsonly reaches CLI invocations, not our ownfscalls, which is exactly why--global-configis stripped from user flags today.We could potentially extract the global-config from the
globalFlagsbut this means we need to parse arguments and deal with that headache. Also, we do actually support${env:XXX}format here anyway!Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I forgot we do that and thought we stored them with
coder loginlike the Toolbox plugin (we should switch though).Oh wait this is a really good point, IMO the user setting the
--global-configflag should not affect the binary path, it should keep going into the plugin's data directory (or the binary dir if they configured that of course).--global-configshould be for the CLI only, so it makes no sense to store the plugin's data there too (currently they are the same by coincidence basically).I just feel like we are going down a path of adding more and more global settings when we already have the one, but not gonna block over it.
True true, I meant to make sure we are setting
CODER_URLsince not sure we are doing that right now.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can make it something like this (remove the setting, use the CLI whenever possible):
Global config / credential changes
Custom CLI config dir: was the
coder.globalConfigsetting; now--global-configincoder.globalFlags(2.31+ only, flag-only, never touches the extension's own files).Behavioral diff (only what changed)
coder login --global-configcoder login token --global-configfs+ flag + binary cachecoder.binaryDestinationstill applies)Unchanged: keyring write/read on supported versions, all writes/reads on
<2.31default dir, and delete (fs.rm+coder logout).Residual: with an override,
deleteTokenstill cleans only the default dir.