chore: create interface for pkgs to return codersdk errors #18719
+182
−119
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 stack of pull requests is managed by Graphite. Learn more about stacking. |
b43bd8e to
15a6ca1
Compare
f0dd768 to
a87678d
Compare
96c83c7 to
8d594a7
Compare
johnstcn
approved these changes
Jul 3, 2025
coderd/dynamicparameters/error.go
Outdated
Comment on lines
31
to
32
| Diagnostics hcl.Diagnostics | ||
| KeyedDiagnostics map[string]hcl.Diagnostics |
There was a problem hiding this comment.
nit: What's the difference between Diagnostics and KeyedDiagnostics?
When should you use one or the other?
There was a problem hiding this comment.
I will leave more comments!
There was a problem hiding this comment.
Pull Request Overview
Adds a unified error interface and refactors workspace‐build and parameter validation errors to produce structured codersdk.Response payloads.
- Introduce
CoderSDKErrorinterface andIsCoderSDKErrorhelper inhttperror/responserror.go - Implement
Response()onBuildErrorand createDiagnosticErrorfor dynamic parameters - Update HTTP error writer and tests to use the new interface
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| coderd/wsbuilder/wsbuilder_test.go | Added TestWsbuildError to verify BuildError meets the new interface |
| coderd/wsbuilder/wsbuilder.go | Implemented Response() on BuildError for structured responses |
| coderd/httpapi/httperror/wsbuild.go | Simplified error handling to use IsCoderSDKError |
| coderd/httpapi/httperror/responserror.go | Defined CoderSDKError interface and IsCoderSDKError function |
| coderd/dynamicparameters/resolver.go | Swapped out ResolverError for calls to ParameterValidationError |
| coderd/dynamicparameters/error.go | Added DiagnosticError type, constructors, and response logic |
Comments suppressed due to low confidence (3)
coderd/httpapi/httperror/responserror.go:9
- Add a doc comment above the
CoderSDKErrorinterface explaining its purpose and usage to improve discoverability.
type CoderSDKError interface {
coderd/dynamicparameters/error.go:13
- Add unit tests for
ParameterValidationError(and the resultingDiagnosticError.Response) to ensure validation error formatting remains correct.
func ParameterValidationError(diags hcl.Diagnostics) *DiagnosticError {
coderd/dynamicparameters/error.go:21
- Include doc comments for
TagValidationErrorand theDiagnosticErrortype to describe when and how these should be used.
func TagValidationError(diags hcl.Diagnostics) *DiagnosticError {
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.
The dynamic parameter code lives in a package far removed from the httpapi and handlers. This interface allows it to create rich codersdk errors and pass them up to the
wsbuildererror handling.This interface should probably be used in more places. I got tired of making custom error handling code for unique types.