chore: change cli error message handling #9952
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| package cli | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
|
|
||
| "github.com/coder/coder/v2/cli/clibase" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| func (RootCmd) errorExample() *clibase.Cmd { | ||
| errorCmd := func(use string, err error) *clibase.Cmd { | ||
| return &clibase.Cmd{ | ||
| Use: use, | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| return err | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // Make an api error | ||
| recorder := httptest.NewRecorder() | ||
| recorder.WriteHeader(http.StatusBadRequest) | ||
| resp := recorder.Result() | ||
| _ = resp.Body.Close() | ||
| resp.Request, _ = http.NewRequest(http.MethodPost, "http://example.com", nil) | ||
| apiError := codersdk.ReadBodyAsError(resp) | ||
| //nolint:errorlint,forcetypeassert | ||
| apiError.(*codersdk.Error).Response = codersdk.Response{ | ||
| Message: "Top level sdk error message.", | ||
| Detail: "magic dust unavailable, please try again later", | ||
| Validations: []codersdk.ValidationError{ | ||
| { | ||
| Field: "region", | ||
| Detail: "magic dust is not available in your region", | ||
| }, | ||
| }, | ||
| } | ||
| //nolint:errorlint,forcetypeassert | ||
| apiError.(*codersdk.Error).Helper = "Have you tried turning it off and on again?" | ||
|
|
||
| // Some flags | ||
| var magicWord clibase.String | ||
|
|
||
| cmd := &clibase.Cmd{ | ||
| Use: "example-error", | ||
| Short: "Shows what different error messages look like", | ||
| Long: "This command is pretty pointless, but without it testing errors is" + | ||
| "difficult to visually inspect. Error message formatting is inherently" + | ||
| "visual, so we need a way to quickly see what they look like.", | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| return inv.Command.HelpHandler(inv) | ||
| }, | ||
| Children: []*clibase.Cmd{ | ||
| // Typical codersdk api error | ||
| errorCmd("api", apiError), | ||
|
|
||
| // Typical cli error | ||
| errorCmd("cmd", xerrors.Errorf("some error: %w", errorWithStackTrace())), | ||
|
|
||
| // A multi-error | ||
| { | ||
| Use: "multi-error", | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| // Closing the stdin file descriptor will cause the next close | ||
| // to fail. This is joined to the returned Command error. | ||
| if f, ok := inv.Stdin.(*os.File); ok { | ||
| _ = f.Close() | ||
| } | ||
|
|
||
| return xerrors.Errorf("some error: %w", errorWithStackTrace()) | ||
| }, | ||
| }, | ||
|
|
||
| { | ||
| Use: "validation", | ||
| Options: clibase.OptionSet{ | ||
| clibase.Option{ | ||
| Name: "magic-word", | ||
| Description: "Take a good guess.", | ||
| Required: true, | ||
| Flag: "magic-word", | ||
| Default: "", | ||
| Value: clibase.Validate(&magicWord, func(value *clibase.String) error { | ||
| return xerrors.Errorf("magic word is incorrect") | ||
| }), | ||
| }, | ||
| }, | ||
| Handler: func(i *clibase.Invocation) error { | ||
| _, _ = fmt.Fprint(i.Stdout, "Try setting the --magic-word flag\n") | ||
| return nil | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func errorWithStackTrace() error { | ||
| return xerrors.Errorf("function decided not to work, and it never will") | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,6 @@ import ( | |
| "text/tabwriter" | ||
| "time" | ||
|
|
||
| "github.com/mattn/go-isatty" | ||
| "github.com/mitchellh/go-wordwrap" | ||
| "golang.org/x/exp/slices" | ||
|
|
@@ -131,14 +130,13 @@ func (r *RootCmd) RunMain(subcommands []*clibase.Cmd) { | |
| if err != nil { | ||
| panic(err) | ||
| } | ||
| err = cmd.Invoke().WithOS().Run() | ||
| if err != nil { | ||
| if errors.Is(err, cliui.Canceled) { | ||
| //nolint:revive | ||
| os.Exit(1) | ||
| } | ||
| f := prettyErrorFormatter{w: os.Stderr, verbose: r.verbose} | ||
| f.format(err) | ||
| //nolint:revive | ||
| os.Exit(1) | ||
|
|
@@ -951,67 +949,148 @@ func isConnectionError(err error) bool { | |
|
|
||
| type prettyErrorFormatter struct { | ||
| w io.Writer | ||
| // verbose turns on more detailed error logs, such as stack traces. | ||
| verbose bool | ||
| } | ||
|
|
||
| // format formats the error to the console. This error should be human | ||
| // readable. | ||
| func (p *prettyErrorFormatter) format(err error) { | ||
| output := cliHumanFormatError(err, &formatOpts{ | ||
| Verbose: p.verbose, | ||
| }) | ||
| // always trail with a newline | ||
| _, _ = p.w.Write([]byte(output + "\n")) | ||
| } | ||
|
|
||
| type formatOpts struct { | ||
| Verbose bool | ||
| } | ||
|
|
||
| const indent = " " | ||
|
|
||
| // cliHumanFormatError formats an error for the CLI. Newlines and styling are | ||
| // included. | ||
| func cliHumanFormatError(err error, opts *formatOpts) string { | ||
| if opts == nil { | ||
| opts = &formatOpts{} | ||
| } | ||
|
|
||
| //nolint:errorlint | ||
| if multi, ok := err.(interface{ Unwrap() []error }); ok { | ||
| multiErrors := multi.Unwrap() | ||
| if len(multiErrors) == 1 { | ||
| // Format as a single error | ||
| return cliHumanFormatError(multiErrors[0], opts) | ||
| } | ||
| return formatMultiError(multiErrors, opts) | ||
| } | ||
|
|
||
| // First check for sentinel errors that we want to handle specially. | ||
| // Order does matter! We want to check for the most specific errors first. | ||
| var sdkError *codersdk.Error | ||
| if errors.As(err, &sdkError) { | ||
| return formatCoderSDKError(sdkError, opts) | ||
| } | ||
|
|
||
| var cmdErr *clibase.RunCommandError | ||
| if errors.As(err, &cmdErr) { | ||
| return formatRunCommandError(cmdErr, opts) | ||
| } | ||
|
|
||
| // Default just printing the error. Use +v for verbose to handle stack | ||
| // traces of xerrors. | ||
| if opts.Verbose { | ||
| return pretty.Sprint(headLineStyle(), fmt.Sprintf("%+v", err)) | ||
| } | ||
|
|
||
| return pretty.Sprint(headLineStyle(), fmt.Sprintf("%v", err)) | ||
| } | ||
|
|
||
| // formatMultiError formats a multi-error. It formats it as a list of errors. | ||
| // | ||
| // Multiple Errors: | ||
| // <# errors encountered>: | ||
| // 1. <heading error message> | ||
| // <verbose error message> | ||
| // 2. <heading error message> | ||
| // <verbose error message> | ||
| func formatMultiError(multi []error, opts *formatOpts) string { | ||
| var errorStrings []string | ||
| for _, err := range multi { | ||
| errorStrings = append(errorStrings, cliHumanFormatError(err, opts)) | ||
| } | ||
|
|
||
| // Write errors out | ||
| var str strings.Builder | ||
| _, _ = str.WriteString(pretty.Sprint(headLineStyle(), fmt.Sprintf("%d errors encountered:", len(multi)))) | ||
| for i, errStr := range errorStrings { | ||
| // Indent each error | ||
| errStr = strings.ReplaceAll(errStr, "\n", "\n"+indent) | ||
| // Error now looks like | ||
| // | <line> | ||
| // | <line> | ||
| prefix := fmt.Sprintf("%d. ", i+1) | ||
| if len(prefix) < len(indent) { | ||
| // Indent the prefix to match the indent | ||
| prefix = prefix + strings.Repeat(" ", len(indent)-len(prefix)) | ||
| } | ||
| errStr = prefix + errStr | ||
| // Now looks like | ||
| // |1.<line> | ||
| // | <line> | ||
| _, _ = str.WriteString("\n" + errStr) | ||
| } | ||
| return str.String() | ||
| } | ||
|
There was a problem hiding this comment. I believe this is the last remnant of There was a problem hiding this comment. Lipgloss is still in the go.mod file because of slogtest: https://github.com/coder/slog/blob/main/internal/entryhuman/entry.go#L19 |
||
|
|
||
| // formatRunCommandError are cli command errors. This kind of error is very | ||
| // broad, as it contains all errors that occur when running a command. | ||
| // If you know the error is something else, like a codersdk.Error, make a new | ||
| // formatter and add it to cliHumanFormatError function. | ||
| func formatRunCommandError(err *clibase.RunCommandError, opts *formatOpts) string { | ||
| var str strings.Builder | ||
| _, _ = str.WriteString(pretty.Sprint(headLineStyle(), fmt.Sprintf("Encountered an error running %q", err.Cmd.FullName()))) | ||
|
|
||
| msgString := fmt.Sprintf("%v", err.Err) | ||
| if opts.Verbose { | ||
| // '%+v' includes stack traces | ||
| msgString = fmt.Sprintf("%+v", err.Err) | ||
| } | ||
| _, _ = str.WriteString("\n") | ||
| _, _ = str.WriteString(pretty.Sprint(tailLineStyle(), msgString)) | ||
| return str.String() | ||
| } | ||
|
|
||
| // formatCoderSDKError come from API requests. In verbose mode, add the | ||
| // request debug information. | ||
| func formatCoderSDKError(err *codersdk.Error, opts *formatOpts) string { | ||
| var str strings.Builder | ||
| if opts.Verbose { | ||
| _, _ = str.WriteString(pretty.Sprint(headLineStyle(), fmt.Sprintf("API request error to \"%s:%s\". Status code %d", err.Method(), err.URL(), err.StatusCode()))) | ||
| _, _ = str.WriteString("\n") | ||
| } | ||
|
|
||
| _, _ = str.WriteString(pretty.Sprint(headLineStyle(), err.Message)) | ||
| if err.Helper != "" { | ||
| _, _ = str.WriteString("\n") | ||
| _, _ = str.WriteString(pretty.Sprint(tailLineStyle(), err.Helper)) | ||
| } | ||
| // By default we do not show the Detail with the helper. | ||
| if opts.Verbose || (err.Helper == "" && err.Detail != "") { | ||
| _, _ = str.WriteString("\n") | ||
| _, _ = str.WriteString(pretty.Sprint(tailLineStyle(), err.Detail)) | ||
| } | ||
| return str.String() | ||
| } | ||
|
|
||
| // These styles are arbitrary. | ||
| func headLineStyle() pretty.Style { | ||
| return cliui.DefaultStyles.Error | ||
| } | ||
|
|
||
| func tailLineStyle() pretty.Style { | ||
| return pretty.Style{pretty.Nop} | ||
| } | ||
|
|
||
| //nolint:unused | ||
|
|
||
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
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.
[Re: lines 103 to 103]
Nifty
See this comment inline on Graphite.