chore: PR fixups, renames and comments

Emyrk · Emyrk · commit 46146b99f904 · 2025-07-03T07:10:09.000-05:00
diff --git a/coderd/dynamicparameters/error.go b/coderd/dynamicparameters/error.go
@@ -27,8 +27,13 @@ func TagValidationError(diags hcl.Diagnostics) *DiagnosticError {
 }
 
 type DiagnosticError struct {
-	Message          string
-	Diagnostics      hcl.Diagnostics
+	// 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
 }
 
diff --git a/coderd/httpapi/httperror/responserror.go b/coderd/httpapi/httperror/responserror.go
@@ -6,12 +6,12 @@ import (
 	"github.com/coder/coder/v2/codersdk"
 )
 
-type CoderSDKError interface {
+type Responder interface {
 	Response() (int, codersdk.Response)
 }
 
-func IsCoderSDKError(err error) (CoderSDKError, bool) {
-	var responseErr CoderSDKError
+func IsResponder(err error) (Responder, bool) {
+	var responseErr Responder
 	if errors.As(err, &responseErr) {
 		return responseErr, true
 	}
diff --git a/coderd/httpapi/httperror/wsbuild.go b/coderd/httpapi/httperror/wsbuild.go
@@ -9,7 +9,7 @@ import (
 )
 
 func WriteWorkspaceBuildError(ctx context.Context, rw http.ResponseWriter, err error) {
-	if responseErr, ok := IsCoderSDKError(err); ok {
+	if responseErr, ok := IsResponder(err); ok {
 		code, resp := responseErr.Response()
 
 		httpapi.Write(ctx, rw, code, resp)
diff --git a/coderd/wsbuilder/wsbuilder_test.go b/coderd/wsbuilder/wsbuilder_test.go
@@ -1010,7 +1010,7 @@ func TestWsbuildError(t *testing.T) {
 		Message: msg,
 	}
 
-	respErr, ok := httperror.IsCoderSDKError(buildErr)
+	respErr, ok := httperror.IsResponder(buildErr)
 	require.True(t, ok, "should be a Coder SDK error")
 
 	code, resp := respErr.Response()

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,13 @@ func TagValidationError(diags hcl.Diagnostics) *DiagnosticError {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`type DiagnosticError struct {`
`30`		`- Message string`
`31`		`- Diagnostics hcl.Diagnostics`
	`30`	`+ // Message is the human-readable message that will be returned to the user.`
	`31`	`+ Message string`
	`32`	`+ // Diagnostics are top level diagnostics that will be returned as "Detail" in the response.`
	`33`	`+ Diagnostics hcl.Diagnostics`
	`34`	`+ // KeyedDiagnostics translate to Validation errors in the response. A key could`
	`35`	`+ // be a parameter name, or a tag name. This allows diagnostics to be more closely`
	`36`	`+ // associated with a specific index/parameter/tag.`
`32`	`37`	`KeyedDiagnostics map[string]hcl.Diagnostics`
`33`	`38`	`}`
`34`	`39`
Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,12 @@ import (`
`6`	`6`	`"github.com/coder/coder/v2/codersdk"`
`7`	`7`	`)`
`8`	`8`
`9`		`-type CoderSDKError interface {`
	`9`	`+type Responder interface {`
`10`	`10`	`Response() (int, codersdk.Response)`
`11`	`11`	`}`
`12`	`12`
`13`		`-func IsCoderSDKError(err error) (CoderSDKError, bool) {`
`14`		`- var responseErr CoderSDKError`
	`13`	`+func IsResponder(err error) (Responder, bool) {`
	`14`	`+ var responseErr Responder`
`15`	`15`	`if errors.As(err, &responseErr) {`
`16`	`16`	`return responseErr, true`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func WriteWorkspaceBuildError(ctx context.Context, rw http.ResponseWriter, err error) {`
`12`		`- if responseErr, ok := IsCoderSDKError(err); ok {`
	`12`	`+ if responseErr, ok := IsResponder(err); ok {`
`13`	`13`	`code, resp := responseErr.Response()`
`14`	`14`
`15`	`15`	`httpapi.Write(ctx, rw, code, resp)`
Original file line number	Diff line number	Diff line change
`@@ -1010,7 +1010,7 @@ func TestWsbuildError(t *testing.T) {`
`1010`	`1010`	`Message: msg,`
`1011`	`1011`	`}`
`1012`	`1012`
`1013`		`- respErr, ok := httperror.IsCoderSDKError(buildErr)`
	`1013`	`+ respErr, ok := httperror.IsResponder(buildErr)`
`1014`	`1014`	`require.True(t, ok, "should be a Coder SDK error")`
`1015`	`1015`
`1016`	`1016`	`code, resp := respErr.Response()`