chore: improve dynamic parameter validation errors #18501
Merged
+168
−56
Conversation
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 was referenced Jun 23, 2025
Member
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
0e3dc00 to
a51570a
Compare
0923f4d to
817afe8
Compare
This was referenced Jun 23, 2025
4f52076 to
c1d05a0
Compare
817afe8 to
21556db
Compare
c1d05a0 to
129235b
Compare
21556db to
5f30d20
Compare
129235b to
6a5ee9e
Compare
5f30d20 to
40063cd
Compare
0523a2f to
f4e5548
Compare
686b2f7 to
6849a80
Compare
f4e5548 to
0523a2f
Compare
0523a2f to
82af2e0
Compare
6849a80 to
a5f35dd
Compare
a5f35dd to
3c2904c
Compare
johnstcn
approved these changes
Jun 23, 2025
Comment on lines
+30
to
+31
| Diagnostics hcl.Diagnostics | ||
| Parameter map[string]hcl.Diagnostics |
Member
There was a problem hiding this comment.
suggestion: unexport and return a clone via method?
Member
Author
There was a problem hiding this comment.
No one should really mutate the diagnostics. But I can do that 👍
Member
Author
There was a problem hiding this comment.
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)
coderd/httpapi/httperror/wsbuild.go
Outdated
| Validations: nil, | ||
| } | ||
|
|
||
| for name, diag := range parameterErr.Parameter { |
Member
There was a problem hiding this comment.
suggestion: sort map keys for deterministic output?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What this does
The current
BuildErrorresponse fromwsbuilderdoes not support rich errors from validation. Changed this to use theValidationsblock of codersdk responses to return all errors for invalid parameters.Example http response
{ "message": "Unable to validate parameters", "validations": [ { "field": "big_number", "detail": "Invalid parameter value according to 'validation' block; Number must be between 500 and 1000" }, { "field": "colors", "detail": "Values must be a valid option; Value \"[\\\"potatoe\\\"]\" is not a valid option, values \"potatoe\" are missing from the options" }, { "field": "intro", "detail": "Invalid parameter value according to 'validation' block; All messages must start with 'Hello' (value \"Goodbye!\" does not match \"^Hello\")" } ] }Cli error