- Notifications
You must be signed in to change notification settings - Fork925
chore: improve dynamic parameter validation errors#18501
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
+168 −56
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
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
77 changes: 65 additions & 12 deletionscoderd/dynamicparameters/resolver.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 |
|---|---|---|
| @@ -26,6 +26,45 @@ type parameterValue struct { | ||
| Source parameterValueSource | ||
| } | ||
| type ResolverError struct { | ||
| Diagnostics hcl.Diagnostics | ||
| Parameter map[string]hcl.Diagnostics | ||
Comment on lines +30 to +31 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. suggestion: unexport and return a clone via method? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. No one should really mutate the diagnostics. But I can do that 👍 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Actually I am going to leave it for now. If I make a method to export it, I would either need 1 method to return both diag sets. Or 2 methods. I think the usage is less intuitive in those cases. func (e*ResolveError)Diagnostics()(hcl.Diagnostics,map[string]hcl.Diagnostics)// Or// This name is not ideal, since Diagnostics does not include the parameter ones :thinking:func (e*ResolveError)Diagnostics()(hcl.Diagnostics)func (e*ResolveError)ParameterDiagnostics()(map[string]hcl.Diagnostics) | ||
| } | ||
| // Error is a pretty bad format for these errors. Try to avoid using this. | ||
| func (e *ResolverError) Error() string { | ||
| var diags hcl.Diagnostics | ||
| diags = diags.Extend(e.Diagnostics) | ||
| for _, d := range e.Parameter { | ||
| diags = diags.Extend(d) | ||
| } | ||
| return diags.Error() | ||
| } | ||
| func (e *ResolverError) HasError() bool { | ||
| if e.Diagnostics.HasErrors() { | ||
| return true | ||
| } | ||
| for _, diags := range e.Parameter { | ||
| if diags.HasErrors() { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
| func (e *ResolverError) Extend(parameterName string, diag hcl.Diagnostics) { | ||
| if e.Parameter == nil { | ||
| e.Parameter = make(map[string]hcl.Diagnostics) | ||
| } | ||
| if _, ok := e.Parameter[parameterName]; !ok { | ||
| e.Parameter[parameterName] = hcl.Diagnostics{} | ||
| } | ||
| e.Parameter[parameterName] = e.Parameter[parameterName].Extend(diag) | ||
| } | ||
| //nolint:revive // firstbuild is a control flag to turn on immutable validation | ||
| func ResolveParameters( | ||
| ctx context.Context, | ||
| @@ -35,7 +74,7 @@ func ResolveParameters( | ||
| previousValues []database.WorkspaceBuildParameter, | ||
| buildValues []codersdk.WorkspaceBuildParameter, | ||
| presetValues []database.TemplateVersionPresetParameter, | ||
| ) (map[string]string,error) { | ||
| previousValuesMap := slice.ToMapFunc(previousValues, func(p database.WorkspaceBuildParameter) (string, string) { | ||
| return p.Name, p.Value | ||
| }) | ||
| @@ -73,7 +112,10 @@ func ResolveParameters( | ||
| // always be valid. If there is a case where this is not true, then this has to | ||
| // be changed to allow the build to continue with a different set of values. | ||
| return nil, &ResolverError{ | ||
| Diagnostics: diags, | ||
| Parameter: nil, | ||
| } | ||
| } | ||
| // The user's input now needs to be validated against the parameters. | ||
| @@ -113,12 +155,16 @@ func ResolveParameters( | ||
| // are fatal. Additional validation for immutability has to be done manually. | ||
| output, diags = renderer.Render(ctx, ownerID, values.ValuesMap()) | ||
| if diags.HasErrors() { | ||
| return nil, &ResolverError{ | ||
| Diagnostics: diags, | ||
| Parameter: nil, | ||
| } | ||
| } | ||
| // parameterNames is going to be used to remove any excess values that were left | ||
| // around without a parameter. | ||
| parameterNames := make(map[string]struct{}, len(output.Parameters)) | ||
| parameterError := &ResolverError{} | ||
| for _, parameter := range output.Parameters { | ||
| parameterNames[parameter.Name] = struct{}{} | ||
| @@ -132,20 +178,22 @@ func ResolveParameters( | ||
| } | ||
| // An immutable parameter was changed, which is not allowed. | ||
| // Add a failed diagnostic to the output. | ||
| parameterError.Extend(parameter.Name, hcl.Diagnostics{ | ||
| &hcl.Diagnostic{ | ||
| Severity: hcl.DiagError, | ||
| Summary: "Immutable parameter changed", | ||
| Detail: fmt.Sprintf("Parameter %q is not mutable, so it can't be updated after creating a workspace.", parameter.Name), | ||
| Subject: src, | ||
| }, | ||
| }) | ||
| } | ||
| } | ||
| // TODO: Fix the `hcl.Diagnostics(...)` type casting. It should not be needed. | ||
| if hcl.Diagnostics(parameter.Diagnostics).HasErrors() { | ||
| // All validation errors are raised here for each parameter. | ||
| parameterError.Extend(parameter.Name,hcl.Diagnostics(parameter.Diagnostics)) | ||
| } | ||
| // If the parameter has a value, but it was not set explicitly by the user at any | ||
| @@ -174,8 +222,13 @@ func ResolveParameters( | ||
| } | ||
| } | ||
| if parameterError.HasError() { | ||
| // If there are any errors, return them. | ||
| return nil, parameterError | ||
| } | ||
| // Return the values to be saved for the build. | ||
| return values.ValuesMap(),nil | ||
| } | ||
| type parameterValueMap map[string]parameterValue | ||
4 changes: 4 additions & 0 deletionscoderd/httpapi/httperror/doc.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,4 @@ | ||
| // Package httperror handles formatting and writing some sentinel errors returned | ||
| // within coder to the API. | ||
| // This package exists outside httpapi to avoid some cyclic dependencies | ||
| package httperror |
91 changes: 91 additions & 0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| package httperror | ||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "sort" | ||
| "github.com/hashicorp/hcl/v2" | ||
| "github.com/coder/coder/v2/coderd/dynamicparameters" | ||
| "github.com/coder/coder/v2/coderd/httpapi" | ||
| "github.com/coder/coder/v2/coderd/wsbuilder" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| func WriteWorkspaceBuildError(ctx context.Context, rw http.ResponseWriter, err error) { | ||
| var buildErr wsbuilder.BuildError | ||
| if errors.As(err, &buildErr) { | ||
| if httpapi.IsUnauthorizedError(err) { | ||
| buildErr.Status = http.StatusForbidden | ||
| } | ||
| httpapi.Write(ctx, rw, buildErr.Status, codersdk.Response{ | ||
| Message: buildErr.Message, | ||
| Detail: buildErr.Error(), | ||
| }) | ||
| return | ||
| } | ||
| var parameterErr *dynamicparameters.ResolverError | ||
| if errors.As(err, ¶meterErr) { | ||
| resp := codersdk.Response{ | ||
| Message: "Unable to validate parameters", | ||
| Validations: nil, | ||
| } | ||
| // Sort the parameter names so that the order is consistent. | ||
| sortedNames := make([]string, 0, len(parameterErr.Parameter)) | ||
| for name := range parameterErr.Parameter { | ||
| sortedNames = append(sortedNames, name) | ||
| } | ||
| sort.Strings(sortedNames) | ||
| for _, name := range sortedNames { | ||
| diag := parameterErr.Parameter[name] | ||
| resp.Validations = append(resp.Validations, codersdk.ValidationError{ | ||
| Field: name, | ||
| Detail: DiagnosticsErrorString(diag), | ||
| }) | ||
| } | ||
| if parameterErr.Diagnostics.HasErrors() { | ||
| resp.Detail = DiagnosticsErrorString(parameterErr.Diagnostics) | ||
| } | ||
| httpapi.Write(ctx, rw, http.StatusBadRequest, resp) | ||
| return | ||
| } | ||
| httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{ | ||
| Message: "Internal error creating workspace build.", | ||
| Detail: err.Error(), | ||
| }) | ||
| } | ||
| func DiagnosticError(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 DiagnosticError(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)", DiagnosticError(d), count-1) | ||
| } | ||
| } | ||
| // All warnings? ok... | ||
| return fmt.Sprintf("%s, and %d other diagnostic(s)", DiagnosticError(d[0]), count-1) | ||
| } | ||
| } |
23 changes: 2 additions & 21 deletionscoderd/workspacebuilds.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
15 changes: 3 additions & 12 deletionscoderd/workspaces.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
14 changes: 3 additions & 11 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
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.