CLI-18: customize error messages for test command #115
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
cyx
reviewed
Feb 26, 2021
internal/cli/test.go
Outdated
| @@ -46,14 +46,14 @@ Launch a browser to try out your universal login box for the given client. | |||
| if clientID == "" { | |||
| client, err := getOrCreateCLITesterClient(cli.api.Client) | |||
| if err != nil { | |||
| return err | |||
| return fmt.Errorf("Unable to test the login box; please check your internet connection and verify you haven't reached your apps limit") | |||
There was a problem hiding this comment.
Suggested change
| return fmt.Errorf("Unable to test the login box; please check your internet connection and verify you haven't reached your apps limit") | |
| return errors.New("Unable to test the login box; please check your internet connection and verify you haven't reached your apps limit") |
Given you're not passing %s style args, can just errors.New it.
There was a problem hiding this comment.
can we identify if the error is "reach app limit" vs internet issue? I would want to see the underlying error message, unless we know the two type of things that can happen are internet issue or app limit...
There was a problem hiding this comment.
Good call. Updated to Unable to create an app for testing the login box: {error} and Unable to create an app to test getting a token: {error}.
cyx
approved these changes
Feb 26, 2021
Ah thanks! Updated |
|
@morganelle thanks! |
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.
Description
After talking with @Widcket, our error style guide is writing custom error messages for errors with known causes and prefixing and passing through unknown errors.
This PR takes a pass at error messages for the
testcommand.References
https://auth0team.atlassian.net/wiki/spaces/~474568858/pages/1675758375/Auth0+CLI+DX+Proposal#Keep-error-messages-user-focused
https://auth0team.atlassian.net/jira/software/projects/CLI/boards/1063?selectedIssue=CLI-18
Testing
Tested manually
Checklist
master