fix: Improve the UI for the influx v1 auth commands #19935
Merged
Conversation
This file contains 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
The enhancements and fixes to the user experience are as follows: * Rename active and inactive commands to the actions set-active and set-inactive respectively to clarify their behavior To set a token to active: ``` influx v1 auth set-active ``` To set a token to inactive, preventing its use: ``` influx v1 auth set-inactive ``` * allow `--id` or `--username` anywhere a single authentication token is required * use separate vars to store the flag state of each command * factor out the behavior to find a single authentication token into a shared function, `v1FindOneAuthorization`
danxmoran
reviewed
Nov 9, 2020
cmd/influx/v1_authorization.go
Outdated
| @@ -479,9 +519,78 @@ func v1AuthorizationInactiveF(cmd *cobra.Command, args []string) error { | |||
| }) | |||
| } | |||
|
|
|||
| var ( | |||
| errMultipleMarchingAuthorizations = errors.New("multiple authorizations found") | |||
There was a problem hiding this comment.
Suggested change
| errMultipleMarchingAuthorizations = errors.New("multiple authorizations found") | |
| errMultipleMatchingAuthorizations = errors.New("multiple authorizations found") |
There was a problem hiding this comment.
Thanks! I am not used to typing on this laptop keyboard – one of the joys of being in quarantine in Australia right now, and not having access to my external keyboard 🤣
cmd/influx/v1_authorization.go
Outdated
| func (f *v1AuthLookupFlags) validate() error { | ||
| switch { | ||
| case f.id.Valid() && f.username != "": | ||
| return errors.New("specify id or username") |
There was a problem hiding this comment.
Could we reword the error to make it more clear that it's an XOR? At first glance I wasn't sure why this was an error.
There was a problem hiding this comment.
How about
specify id or username, not both
2 tasks
assuming CI passes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #19933
This PR improves the
v1 authcommands of theinfluxCLI tool, and includes some minor improvements to thekit/clipackage. The enhancements and fixes to the user experience are as follows:Rename
--auth-tokento--usernamefor thev1 auth createcommand to clarify its purpose in the context of v1 requestsv1 auth createnow requires a password when creating a new authorisation. It can be optionally disabled with the--no-passwordflag, however, the user much set a password using thev1 auth set-passwordcommand prior to using the token.Rename
v1 auth activeandv1 auth inactivecommands to the actionsset-activeandset-inactiverespectively to clarify their behaviour.For example, to set a token to active:
To set a token to inactive, preventing its use in subsequent requests:
Universally allow the
--idor--usernameflags anywhere a single authentication token isrequired
Use separate global variables to store the flag state of each v1 auth command
factor out the behavior to find a single authentication token into
a shared function,
v1FindOneAuthorization