chore: create interface for pkgs to return codersdk errors #18719
+177
−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
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?
Comment on lines
+59
to
+71
| 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) | ||
| } |
There was a problem hiding this comment.
nit/quibble: Similarly here, when should you use Append() vs Extend()?
I would expect to use Append() like this:
var derr DiagnosticError
thing, diags := preview.Frobulate()
if diags.HasErrors() {
derr.Append(diags...)
}
Comment on lines
+9
to
+11
| type CoderSDKError interface { | ||
| Response() (int, codersdk.Response) | ||
| } |
There was a problem hiding this comment.
nit: should probably be named Responder or Responser?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.