- Notifications
You must be signed in to change notification settings - Fork1k
chore: create interface for pkgs to return codersdk errors#18719
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| package dynamicparameters | ||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "sort" | ||
| "github.com/hashicorp/hcl/v2" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| func ParameterValidationError(diags hcl.Diagnostics) *DiagnosticError { | ||
| return &DiagnosticError{ | ||
| Message: "Unable to validate parameters", | ||
| Diagnostics: diags, | ||
| KeyedDiagnostics: make(map[string]hcl.Diagnostics), | ||
| } | ||
| } | ||
| func TagValidationError(diags hcl.Diagnostics) *DiagnosticError { | ||
| return &DiagnosticError{ | ||
| Message: "Failed to parse workspace tags", | ||
| Diagnostics: diags, | ||
| KeyedDiagnostics: make(map[string]hcl.Diagnostics), | ||
| } | ||
| } | ||
| type DiagnosticError struct { | ||
| // Message is the human-readable message that will be returned to the user. | ||
| Message string | ||
| // Diagnostics are top level diagnostics that will be returned as "Detail" in the response. | ||
| Diagnostics hcl.Diagnostics | ||
| // KeyedDiagnostics translate to Validation errors in the response. A key could | ||
| // be a parameter name, or a tag name. This allows diagnostics to be more closely | ||
| // associated with a specific index/parameter/tag. | ||
| KeyedDiagnostics map[string]hcl.Diagnostics | ||
| } | ||
| // Error is a pretty bad format for these errors. Try to avoid using this. | ||
| func (e *DiagnosticError) Error() string { | ||
| var diags hcl.Diagnostics | ||
| diags = diags.Extend(e.Diagnostics) | ||
| for _, d := range e.KeyedDiagnostics { | ||
| diags = diags.Extend(d) | ||
| } | ||
| return diags.Error() | ||
| } | ||
| func (e *DiagnosticError) HasError() bool { | ||
| if e.Diagnostics.HasErrors() { | ||
| return true | ||
| } | ||
| for _, diags := range e.KeyedDiagnostics { | ||
| if diags.HasErrors() { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
| func (e *DiagnosticError) Append(key string, diag *hcl.Diagnostic) { | ||
| e.Extend(key, hcl.Diagnostics{diag}) | ||
| } | ||
| func (e *DiagnosticError) Extend(key string, diag hcl.Diagnostics) { | ||
| if e.KeyedDiagnostics == nil { | ||
| e.KeyedDiagnostics = make(map[string]hcl.Diagnostics) | ||
| } | ||
| if _, ok := e.KeyedDiagnostics[key]; !ok { | ||
| e.KeyedDiagnostics[key] = hcl.Diagnostics{} | ||
| } | ||
| e.KeyedDiagnostics[key] = e.KeyedDiagnostics[key].Extend(diag) | ||
| } | ||
Emyrk marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| func (e *DiagnosticError) Response() (int, codersdk.Response) { | ||
| resp := codersdk.Response{ | ||
| Message: e.Message, | ||
| Validations: nil, | ||
| } | ||
| // Sort the parameter names so that the order is consistent. | ||
| sortedNames := make([]string, 0, len(e.KeyedDiagnostics)) | ||
| for name := range e.KeyedDiagnostics { | ||
| sortedNames = append(sortedNames, name) | ||
| } | ||
| sort.Strings(sortedNames) | ||
| for _, name := range sortedNames { | ||
| diag := e.KeyedDiagnostics[name] | ||
| resp.Validations = append(resp.Validations, codersdk.ValidationError{ | ||
| Field: name, | ||
| Detail: DiagnosticsErrorString(diag), | ||
| }) | ||
| } | ||
| if e.Diagnostics.HasErrors() { | ||
| resp.Detail = DiagnosticsErrorString(e.Diagnostics) | ||
| } | ||
| return http.StatusBadRequest, resp | ||
| } | ||
| func DiagnosticErrorString(d *hcl.Diagnostic) string { | ||
| return fmt.Sprintf("%s; %s", d.Summary, d.Detail) | ||
| } | ||
| func DiagnosticsErrorString(d hcl.Diagnostics) string { | ||
| count := len(d) | ||
| switch { | ||
| case count == 0: | ||
| return "no diagnostics" | ||
| case count == 1: | ||
| return DiagnosticErrorString(d[0]) | ||
| default: | ||
| for _, d := range d { | ||
| // Render the first error diag. | ||
| // If there are warnings, do not priority them over errors. | ||
| if d.Severity == hcl.DiagError { | ||
| return fmt.Sprintf("%s, and %d other diagnostic(s)", DiagnosticErrorString(d), count-1) | ||
| } | ||
| } | ||
| // All warnings? ok... | ||
| return fmt.Sprintf("%s, and %d other diagnostic(s)", DiagnosticErrorString(d[0]), count-1) | ||
| } | ||
| } | ||
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
19 changes: 19 additions & 0 deletionscoderd/httpapi/httperror/responserror.go
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,19 @@ | ||
| package httperror | ||
| import ( | ||
| "errors" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| type Responder interface { | ||
| Response() (int, codersdk.Response) | ||
| } | ||
| func IsResponder(err error) (Responder, bool) { | ||
| var responseErr Responder | ||
| if errors.As(err, &responseErr) { | ||
| return responseErr, true | ||
| } | ||
| return nil, false | ||
| } |
74 changes: 3 additions & 71 deletionscoderd/httpapi/httperror/wsbuild.go
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
10 changes: 10 additions & 0 deletionscoderd/wsbuilder/wsbuilder.go
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 |
|---|---|---|
| @@ -240,13 +240,23 @@ type BuildError struct { | ||
| } | ||
| func (e BuildError) Error() string { | ||
| if e.Wrapped == nil { | ||
| return e.Message | ||
| } | ||
| return e.Wrapped.Error() | ||
Emyrk marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| func (e BuildError) Unwrap() error { | ||
| return e.Wrapped | ||
| } | ||
| func (e BuildError) Response() (int, codersdk.Response) { | ||
| return e.Status, codersdk.Response{ | ||
| Message: e.Message, | ||
| Detail: e.Error(), | ||
| } | ||
| } | ||
| // Build computes and inserts a new workspace build into the database. If authFunc is provided, it also performs | ||
| // authorization preflight checks. | ||
| func (b *Builder) Build( | ||
18 changes: 18 additions & 0 deletionscoderd/wsbuilder/wsbuilder_test.go
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.
Uh oh!
There was an error while loading.Please reload this page.
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.