Skip to content

chore: handle errors in wsproxy server for cli using buildinfo #11584

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.

Sign up for GitHub

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

Merged
merged 11 commits into from
Jan 11, 2024
Merged

chore: handle errors in wsproxy server for cli using buildinfo #11584

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8b30f94
improve some cli errors
Emyrk Jan 11, 2024
3239717
improve custom error cmd
Emyrk Jan 11, 2024
f2d978b
Fix error message printing
Emyrk Jan 11, 2024
1347d7f
added nohelper error
Emyrk Jan 11, 2024
789d3df
example with wrapped
Emyrk Jan 11, 2024
a84f368
Correct return boolean
Emyrk Jan 11, 2024
9650638
add tracing as well for better error debugging
Emyrk Jan 11, 2024
865477b
linting
Emyrk Jan 11, 2024
4066e2c
linting
Emyrk Jan 11, 2024
2ac5c17
always print traec
Emyrk Jan 11, 2024
d754fd8
conditional, do not print empty string
Emyrk Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix error message printing
  • Loading branch information
@Emyrk
Emyrk committed Jan 11, 2024
commit f2d978b6e0e3a751d50866a22a7979b31d646a18
44 changes: 28 additions & 16 deletions cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1016,7 +1016,7 @@ type prettyErrorFormatter struct {
// format formats the error to the console. This error should be human
// readable.
func (p *prettyErrorFormatter) format(err error) {
output := cliHumanFormatError(err, &formatOpts{
output, _ := cliHumanFormatError(err, &formatOpts{
Verbose: p.verbose,
})
// always trail with a newline
Expand All @@ -1030,13 +1030,23 @@ type formatOpts struct {
const indent = " "

// cliHumanFormatError formats an error for the CLI. Newlines and styling are
// included.
func cliHumanFormatError(err error, opts *formatOpts) string {
// included. The second return value is true if the error is special and the error
// chain has custom formatting applied.
//
// If you change this code, you can use the cli "example-errors" tool to
// verify all errors still look ok.
//
// go run main.go exp example-error <type>
// go run main.go exp example-error api
// go run main.go exp example-error cmd
// go run main.go exp example-error multi-error
// go run main.go exp example-error validation
func cliHumanFormatError(err error, opts *formatOpts) (string, bool) {
if opts == nil {
opts = &formatOpts{}
}
if err == nil {
return "<nil>"
return "<nil>", true
}

if multi, ok := err.(interface{ Unwrap() []error }); ok {
Expand All @@ -1045,40 +1055,41 @@ func cliHumanFormatError(err error, opts *formatOpts) string {
// Format as a single error
return cliHumanFormatError(multiErrors[0], opts)
}
return formatMultiError(multiErrors, opts)
return formatMultiError(multiErrors, opts), false
}

// 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) {
if sdkError, ok := err.(*codersdk.Error); ok {
return formatCoderSDKError(sdkError, opts)
return formatCoderSDKError(sdkError, opts), false
}

//var cmdErr *clibase.RunCommandError
//if errors.As(err, &cmdErr) {
if cmdErr, ok := err.(*clibase.RunCommandError); ok {
return formatRunCommandError(cmdErr, opts)
return formatRunCommandError(cmdErr, opts), false
}

uw, ok := err.(interface{ Unwrap() error })
if ok {
msg := cliHumanFormatError(uw.Unwrap(), opts)
if msg != "" {
return msg
msg, special := cliHumanFormatError(uw.Unwrap(), opts)
if special {
return msg, special
}
}
// If we got here, that means the error is not anything special. Just format
// it as is.
// If we got here, that means that the wrapped error chain does not have
// any special formatting below it. So we want to return the topmost non-special
// error (which is 'err')

// 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)), false
}

return pretty.Sprint(headLineStyle(), fmt.Sprintf("%v", err))
return pretty.Sprint(headLineStyle(), fmt.Sprintf("%v", err)), false
}

// formatMultiError formats a multi-error. It formats it as a list of errors.
Expand All @@ -1092,7 +1103,8 @@ func cliHumanFormatError(err error, opts *formatOpts) string {
func formatMultiError(multi []error, opts *formatOpts) string {
var errorStrings []string
for _, err := range multi {
errorStrings = append(errorStrings, cliHumanFormatError(err, opts))
msg, _ := cliHumanFormatError(err, opts)
errorStrings = append(errorStrings, msg)
}

// Write errors out
Expand Down Expand Up @@ -1126,7 +1138,7 @@ func formatRunCommandError(err *clibase.RunCommandError, opts *formatOpts) strin
var str strings.Builder
_, _ = str.WriteString(pretty.Sprint(headLineStyle(), fmt.Sprintf("Encountered an error running %q", err.Cmd.FullName())))

msgString := cliHumanFormatError(err.Err, opts)
msgString, _ := cliHumanFormatError(err.Err, opts)
_, _ = str.WriteString("\n")
_, _ = str.WriteString(pretty.Sprint(tailLineStyle(), msgString))
return str.String()
Expand Down