From 844159ca7229bdda3c4e89f387fa903bc06d059d Mon Sep 17 00:00:00 2001 From: Tristan Cartledge Date: Fri, 13 Nov 2026 09:13:48 +1000 Subject: [PATCH 1/2] fix(go): fall back on empty error messages and prefix inferred messages with the error code --- .changesets/1794524968-fc46a4a4.yaml | 10 + .../error_field_collision_go_test.go | 12 +- .../error_message_field_access_go_test.go | 6 +- .../error_message_leaf_types_go_test.go | 242 +++++++++++++++++- ...union_error_discriminator_field_go_test.go | 4 +- templates/templates/go/includes/templating.ts | 107 +++++++- .../go/tests/primary/errors_test.go.stmpl | 31 ++- zSDKs/sdk-go/.speakeasy/gen.lock | 16 +- zSDKs/sdk-go/badrequestresponseerror.go | 2 +- zSDKs/sdk-go/errorserror.go | 4 + zSDKs/sdk-go/errortype2.go | 4 +- zSDKs/sdk-go/geterrorinunionop.go | 8 +- zSDKs/sdk-go/getunionerrorsop.go | 12 +- zSDKs/sdk-go/requesttimeouterror.go | 6 +- zSDKs/sdk-go/taggederror1.go | 4 +- zSDKs/sdk-go/taggederror2.go | 4 +- 16 files changed, 430 insertions(+), 42 deletions(-) create mode 100644 .changesets/1794524968-fc46a4a4.yaml diff --git a/.changesets/1794524968-fc46a4a4.yaml b/.changesets/1794524968-fc46a4a4.yaml new file mode 100644 index 000000000..ab41acd1c --- /dev/null +++ b/.changesets/1794524968-fc46a4a4.yaml @@ -0,0 +1,10 @@ +id: 1794524968-fc46a4a4 +features: + - errors +targets: + - go +type: fix +bump: patch +description: prefix inferred Go error messages with the error code and fall back when the message is empty +author: TristanSpeakEasy +date: "2026-11-13" diff --git a/pkg/generate/snapshots/error_field_collision_go_test.go b/pkg/generate/snapshots/error_field_collision_go_test.go index c5c10540a..aa644709d 100644 --- a/pkg/generate/snapshots/error_field_collision_go_test.go +++ b/pkg/generate/snapshots/error_field_collision_go_test.go @@ -281,7 +281,9 @@ func (u GatewayTimeout) Error() string { switch u.Type { case GatewayTimeoutTypeError: if u.ErrorInfo != nil { - return u.ErrorInfo.Message + if u.ErrorInfo.Message != "" { + return u.ErrorInfo.Message + } } data, _ := json.Marshal(u.ErrorInfo) @@ -430,7 +432,9 @@ func (u ServiceUnavailable) Error() string { switch u.Type { case ServiceUnavailableTypeAlpha: if u.AlphaError != nil { - return u.AlphaError.Message + if u.AlphaError.Message != "" { + return u.AlphaError.Message + } } data, _ := json.Marshal(u.AlphaError) @@ -459,7 +463,7 @@ var _ error = &BadGatewayError{} func (e *BadGatewayError) Error() string { if e != nil { - if e.Error_.Message != nil { + if e.Error_.Message != nil && *e.Error_.Message != "" { return *e.Error_.Message } } @@ -478,7 +482,7 @@ var _ error = &InternalServerError{} func (e *InternalServerError) Error() string { if e != nil { - if e.ErrorInfo.Message != nil { + if e.ErrorInfo.Message != nil && *e.ErrorInfo.Message != "" { return *e.ErrorInfo.Message } } diff --git a/pkg/generate/snapshots/error_message_field_access_go_test.go b/pkg/generate/snapshots/error_message_field_access_go_test.go index c0d979501..3aecb0410 100644 --- a/pkg/generate/snapshots/error_message_field_access_go_test.go +++ b/pkg/generate/snapshots/error_message_field_access_go_test.go @@ -127,7 +127,7 @@ var _ error = &ConflictError{} func (e *ConflictError) Error() string { if e != nil { if v0 := e.ErrorInfo; v0 != nil { - if v0.GetMessage() != nil { + if v0.GetMessage() != nil && *v0.GetMessage() != "" { return *v0.GetMessage() } } @@ -402,7 +402,9 @@ func (u BadRequest) Error() string { switch u.Type { case BadRequestTypeFailure: if u.WidgetFailure != nil { - return u.WidgetFailure.Error.Message + if u.WidgetFailure.Error.Message != "" { + return u.WidgetFailure.Error.Message + } } data, _ := json.Marshal(u.WidgetFailure) diff --git a/pkg/generate/snapshots/error_message_leaf_types_go_test.go b/pkg/generate/snapshots/error_message_leaf_types_go_test.go index e2ca52074..8d255a171 100644 --- a/pkg/generate/snapshots/error_message_leaf_types_go_test.go +++ b/pkg/generate/snapshots/error_message_leaf_types_go_test.go @@ -13,7 +13,9 @@ import ( // Error() reads marked messages of every field representation: optional+nullable // model fields wrapped in OptionalNullable, required+nullable pointers, and // non-string enum and integer leaves. A top-level marked field takes precedence -// over a nested marked field and an inferred `message`. +// over a nested marked field and an inferred `message`. Empty string messages +// fall back as if absent. An inferred message is prefixed with a sibling `code` +// when one is present; a marked message is not. func TestSnapGoErrorMessageLeafTypes(t *testing.T) { t.Parallel() spec := `openapi: 3.1.0 @@ -63,6 +65,30 @@ paths: application/json: schema: $ref: "#/components/schemas/PrecedenceError" + "404": + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/NestedCodeError" + "422": + description: Unprocessable Entity + content: + application/json: + schema: + $ref: "#/components/schemas/TopLevelCodeError" + "429": + description: Too Many Requests + content: + application/json: + schema: + $ref: "#/components/schemas/WrappedCodeError" + "500": + description: Internal Server Error + content: + application/json: + schema: + $ref: "#/components/schemas/MarkedMessageCodeError" components: schemas: Cause: @@ -115,7 +141,50 @@ components: x-speakeasy-error-message: true title: type: string - x-speakeasy-error-message: true` + x-speakeasy-error-message: true + NestedCodeError: + type: object + properties: + error: + type: object + properties: + code: + type: string + message: + type: string + TopLevelCodeError: + type: object + required: [code, message] + properties: + code: + type: integer + message: + type: string + WrappedCodeError: + type: object + properties: + error: + $ref: "#/components/schemas/WrappedCodeDetail" + WrappedCodeDetail: + type: object + properties: + code: + type: string + nullable: true + message: + type: string + nullable: true + MarkedMessageCodeError: + type: object + properties: + error: + type: object + properties: + code: + type: string + detail: + type: string + x-speakeasy-error-message: true` genYaml := `go: packageName: github.com/example/test @@ -128,6 +197,10 @@ components: "models/apierrors/integermessageerror.go", "models/apierrors/requirednullablemessageerror.go", "models/apierrors/precedenceerror.go", + "models/apierrors/nestedcodeerror.go", + "models/apierrors/toplevelcodeerror.go", + "models/apierrors/wrappedcodeerror.go", + "models/apierrors/markedmessagecodeerror.go", } expectedSnapshot := `--- models/apierrors/enummessageerror.go --- @@ -194,6 +267,76 @@ func (e *IntegerMessageError) Error() string { } +--- models/apierrors/markedmessagecodeerror.go --- +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// Generated under the AGPL-3.0-only license. +// SPDX-License-Identifier: AGPL-3.0-only + +package apierrors + +import ( + "encoding/json" + "github.com/example/test/models/components" +) + +type MarkedMessageCodeError struct { + ErrorInfo *components.MarkedMessageCodeErrorError ` + "`" + `json:"error,omitzero"` + "`" + ` + HTTPMeta components.HTTPMetadata ` + "`" + `json:"-"` + "`" + ` +} + +var _ error = &MarkedMessageCodeError{} + +func (e *MarkedMessageCodeError) Error() string { + if e != nil { + if v0 := e.ErrorInfo; v0 != nil { + if v0.Detail != nil && *v0.Detail != "" { + return *v0.Detail + } + } + } + + data, _ := json.Marshal(e) + return string(data) +} + + +--- models/apierrors/nestedcodeerror.go --- +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// Generated under the AGPL-3.0-only license. +// SPDX-License-Identifier: AGPL-3.0-only + +package apierrors + +import ( + "encoding/json" + "fmt" + "github.com/example/test/models/components" +) + +type NestedCodeError struct { + ErrorInfo *components.NestedCodeErrorError ` + "`" + `json:"error,omitzero"` + "`" + ` + HTTPMeta components.HTTPMetadata ` + "`" + `json:"-"` + "`" + ` +} + +var _ error = &NestedCodeError{} + +func (e *NestedCodeError) Error() string { + if e != nil { + if v0 := e.ErrorInfo; v0 != nil { + if v0.Message != nil && *v0.Message != "" { + if v0.Code != nil && *v0.Code != "" { + return fmt.Sprintf("%v: %s", *v0.Code, *v0.Message) + } + return *v0.Message + } + } + } + + data, _ := json.Marshal(e) + return string(data) +} + + --- models/apierrors/precedenceerror.go --- // Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. // Generated under the AGPL-3.0-only license. @@ -215,7 +358,7 @@ type PrecedenceError struct { var _ error = &PrecedenceError{} func (e *PrecedenceError) Error() string { - if e.Title == nil { + if e.Title == nil || *e.Title == "" { return "unknown error" } @@ -242,7 +385,7 @@ type RequiredNullableMessageError struct { var _ error = &RequiredNullableMessageError{} func (e *RequiredNullableMessageError) Error() string { - if e.Message == nil { + if e.Message == nil || *e.Message == "" { return "unknown error" } @@ -250,6 +393,39 @@ func (e *RequiredNullableMessageError) Error() string { } +--- models/apierrors/toplevelcodeerror.go --- +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// Generated under the AGPL-3.0-only license. +// SPDX-License-Identifier: AGPL-3.0-only + +package apierrors + +import ( + "encoding/json" + "fmt" + "github.com/example/test/models/components" +) + +type TopLevelCodeError struct { + Code int64 ` + "`" + `json:"code"` + "`" + ` + Message string ` + "`" + `json:"message"` + "`" + ` + HTTPMeta components.HTTPMetadata ` + "`" + `json:"-"` + "`" + ` +} + +var _ error = &TopLevelCodeError{} + +func (e *TopLevelCodeError) Error() string { + if e != nil { + if e.Message != "" { + return fmt.Sprintf("%v: %s", e.Code, e.Message) + } + } + + data, _ := json.Marshal(e) + return string(data) +} + + --- models/apierrors/wrappedcauseerror.go --- // Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. // Generated under the AGPL-3.0-only license. @@ -273,7 +449,7 @@ func (e *WrappedCauseError) Error() string { if e != nil { if v0 := e.Cause; v0 != nil { if v1, ok := v0.Inner.Get(); ok && v1 != nil { - if v2, ok := v1.Message.Get(); ok && v2 != nil { + if v2, ok := v1.Message.Get(); ok && v2 != nil && *v2 != "" { return *v2 } } @@ -285,6 +461,43 @@ func (e *WrappedCauseError) Error() string { } +--- models/apierrors/wrappedcodeerror.go --- +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// Generated under the AGPL-3.0-only license. +// SPDX-License-Identifier: AGPL-3.0-only + +package apierrors + +import ( + "encoding/json" + "fmt" + "github.com/example/test/models/components" +) + +type WrappedCodeError struct { + ErrorInfo *components.WrappedCodeDetail ` + "`" + `json:"error,omitzero"` + "`" + ` + HTTPMeta components.HTTPMetadata ` + "`" + `json:"-"` + "`" + ` +} + +var _ error = &WrappedCodeError{} + +func (e *WrappedCodeError) Error() string { + if e != nil { + if v0 := e.ErrorInfo; v0 != nil { + if v1, ok := v0.Message.Get(); ok && v1 != nil && *v1 != "" { + if code, ok := v0.Code.Get(); ok && code != nil && *code != "" { + return fmt.Sprintf("%v: %s", *code, *v1) + } + return *v1 + } + } + } + + data, _ := json.Marshal(e) + return string(data) +} + + ` // end of snapshot snaptest.DoTestSnapshot(t, snaptest.Options{ @@ -339,6 +552,7 @@ func assertJSONFallback(t *testing.T, e error, body string) { func TestErrorMessageLeafTypes(t *testing.T) { assertErrorMessage(t, &apierrors.WrappedCauseError{}, `+"`"+`{"cause":{"inner":{"message":"wrapped"}}}`+"`"+`, "wrapped") for _, body := range []string{ + `+"`"+`{"cause":{"inner":{"message":""}}}`+"`"+`, `+"`"+`{"cause":{"inner":{"message":null}}}`+"`"+`, `+"`"+`{"cause":{"inner":{}}}`+"`"+`, `+"`"+`{"cause":{"inner":null}}`+"`"+`, @@ -356,8 +570,26 @@ func TestErrorMessageLeafTypes(t *testing.T) { assertErrorMessage(t, &apierrors.RequiredNullableMessageError{}, `+"`"+`{"message":"required"}`+"`"+`, "required") assertErrorMessage(t, &apierrors.RequiredNullableMessageError{}, `+"`"+`{"message":null}`+"`"+`, "unknown error") + assertErrorMessage(t, &apierrors.RequiredNullableMessageError{}, `+"`"+`{"message":""}`+"`"+`, "unknown error") assertErrorMessage(t, &apierrors.PrecedenceError{}, `+"`"+`{"message":"inferred","detail":{"reason":"nested"},"title":"top"}`+"`"+`, "top") + assertErrorMessage(t, &apierrors.PrecedenceError{}, `+"`"+`{"message":"inferred","title":""}`+"`"+`, "unknown error") + + assertErrorMessage(t, &apierrors.NestedCodeError{}, `+"`"+`{"error":{"code":"rate_limit","message":"slow down"}}`+"`"+`, "rate_limit: slow down") + assertErrorMessage(t, &apierrors.NestedCodeError{}, `+"`"+`{"error":{"code":"","message":"slow down"}}`+"`"+`, "slow down") + assertErrorMessage(t, &apierrors.NestedCodeError{}, `+"`"+`{"error":{"message":"slow down"}}`+"`"+`, "slow down") + assertJSONFallback(t, &apierrors.NestedCodeError{}, `+"`"+`{"error":{"code":"rate_limit","message":""}}`+"`"+`) + assertJSONFallback(t, &apierrors.NestedCodeError{}, `+"`"+`{"error":{"code":"rate_limit"}}`+"`"+`) + + assertErrorMessage(t, &apierrors.TopLevelCodeError{}, `+"`"+`{"code":409,"message":"conflict"}`+"`"+`, "409: conflict") + assertJSONFallback(t, &apierrors.TopLevelCodeError{}, `+"`"+`{"code":409,"message":""}`+"`"+`) + + assertErrorMessage(t, &apierrors.WrappedCodeError{}, `+"`"+`{"error":{"code":"quota","message":"exhausted"}}`+"`"+`, "quota: exhausted") + assertErrorMessage(t, &apierrors.WrappedCodeError{}, `+"`"+`{"error":{"code":null,"message":"exhausted"}}`+"`"+`, "exhausted") + assertJSONFallback(t, &apierrors.WrappedCodeError{}, `+"`"+`{"error":{"code":"quota","message":""}}`+"`"+`) + + assertErrorMessage(t, &apierrors.MarkedMessageCodeError{}, `+"`"+`{"error":{"code":"denied","detail":"not allowed"}}`+"`"+`, "not allowed") + assertJSONFallback(t, &apierrors.MarkedMessageCodeError{}, `+"`"+`{"error":{"code":"denied","detail":""}}`+"`"+`) } `), 0o644)) t.Cleanup(func() { _ = os.Remove(path) }) diff --git a/pkg/generate/snapshots/union_error_discriminator_field_go_test.go b/pkg/generate/snapshots/union_error_discriminator_field_go_test.go index 7388d57d8..e4a007917 100644 --- a/pkg/generate/snapshots/union_error_discriminator_field_go_test.go +++ b/pkg/generate/snapshots/union_error_discriminator_field_go_test.go @@ -216,7 +216,9 @@ func (u BadRequest) Error() string { switch u.Type { case BadRequestTypeErr: if u.ErrorInfo != nil { - return u.ErrorInfo.Message + if u.ErrorInfo.Message != "" { + return u.ErrorInfo.Message + } } data, _ := json.Marshal(u.ErrorInfo) diff --git a/templates/templates/go/includes/templating.ts b/templates/templates/go/includes/templating.ts index aed7764e8..b2104a9ff 100644 --- a/templates/templates/go/includes/templating.ts +++ b/templates/templates/go/includes/templating.ts @@ -831,12 +831,31 @@ function templateErrorMessageJSONFallback(errorObject: string): string { return string(data)`; } +const errorCodeTypes = new Set([ + "string", + "integer", + "int32", + "number", + "float32", + "enum", +]); + +function inferErrorCodeField(owner: TypeDef): FieldDef | undefined { + return owner.Fields.find( + (f) => + f.Name === "code" && + errorCodeTypes.has(f.Type.Type.toString()) && + !isPointerType(f.Type), + ); +} + // @ts-ignore function templateErrorMessage(errorType: TypeDef, errorObject: string): string { const topLevelField = getErrorMessageField(errorType); - const path = topLevelField + const markedPath = topLevelField ? [topLevelField] - : getOrInferErrorMessageFieldDeep(errorType); + : getErrorMessageFieldDeep(errorType); + const path = markedPath ?? inferErrorMessageField(errorType); if (!path?.length) { return templateErrorMessageJSONFallback(errorObject); @@ -854,31 +873,45 @@ function templateErrorMessage(errorType: TypeDef, errorObject: string): string { errorType, )}`; if (topLevelKind === "pointer") { - return `if ${access} == nil { + return `if ${access} == nil || *${access} == "" { return "unknown error" } return *${access}`; } - return `return ${access}`; + return `if ${access} == "" { + return "unknown error" +} + +return ${access}`; } const lines: string[] = [`if ${errorObject} != nil {`]; let expr = errorObject; let owner = errorType; let leaf = ""; + let leafOwnerExpr = errorObject; + let leafOwner = errorType; let openBlocks = 1; const indent = () => "\t".repeat(openBlocks); path.forEach((field, hop) => { const access = `${expr}.${errorMessageHopAccessor(field, owner)}`; const isLeaf = hop === path.length - 1; + const isStringLeaf = isLeaf && field.Type.Type.toString() === "string"; const local = `v${hop}`; + if (isLeaf) { + leafOwnerExpr = expr; + leafOwner = owner; + } + switch (errorMessageHopKind(field, owner)) { case "wrapper": lines.push( - `${indent()}if ${local}, ok := ${access}.Get(); ok && ${local} != nil {`, + `${indent()}if ${local}, ok := ${access}.Get(); ok && ${local} != nil${ + isStringLeaf ? ` && *${local} != ""` : "" + } {`, ); openBlocks++; expr = local; @@ -886,7 +919,11 @@ return *${access}`; break; case "pointer": if (isLeaf) { - lines.push(`${indent()}if ${access} != nil {`); + lines.push( + `${indent()}if ${access} != nil${ + isStringLeaf ? ` && *${access} != ""` : "" + } {`, + ); leaf = `*${access}`; } else { lines.push(`${indent()}if ${local} := ${access}; ${local} != nil {`); @@ -898,6 +935,9 @@ return *${access}`; if (isLeaf && isPointerType(field.Type)) { lines.push(`${indent()}if ${access} != nil {`); openBlocks++; + } else if (isStringLeaf) { + lines.push(`${indent()}if ${access} != "" {`); + openBlocks++; } expr = access; leaf = access; @@ -906,12 +946,55 @@ return *${access}`; owner = field.Type; }); - lines.push( - `${indent()}return ${stringifyErrorMessageLeaf( - leaf, - path[path.length - 1], - )}`, - ); + const message = stringifyErrorMessageLeaf(leaf, path[path.length - 1]); + const codeField = markedPath ? undefined : inferErrorCodeField(leafOwner); + if (codeField) { + const access = `${leafOwnerExpr}.${errorMessageHopAccessor( + codeField, + leafOwner, + )}`; + const isStringCode = codeField.Type.Type.toString() === "string"; + let code = access; + let guarded = true; + switch (errorMessageHopKind(codeField, leafOwner)) { + case "wrapper": + lines.push( + `${indent()}if code, ok := ${access}.Get(); ok && code != nil${ + isStringCode ? ` && *code != ""` : "" + } {`, + ); + code = "*code"; + break; + case "pointer": + lines.push( + `${indent()}if ${access} != nil${ + isStringCode ? ` && *${access} != ""` : "" + } {`, + ); + code = `*${access}`; + break; + case "value": + if (isStringCode) { + lines.push(`${indent()}if ${access} != "" {`); + } else { + guarded = false; + } + break; + } + addImport("fmt"); + const formatted = `fmt.Sprintf("%v: %s", ${code}, ${message})`; + if (guarded) { + openBlocks++; + lines.push(`${indent()}return ${formatted}`); + openBlocks--; + lines.push(`${indent()}}`); + lines.push(`${indent()}return ${message}`); + } else { + lines.push(`${indent()}return ${formatted}`); + } + } else { + lines.push(`${indent()}return ${message}`); + } while (openBlocks > 0) { openBlocks--; lines.push(`${indent()}}`); diff --git a/templates/templates/go/tests/primary/errors_test.go.stmpl b/templates/templates/go/tests/primary/errors_test.go.stmpl index 638b64255..46c51ad7d 100644 --- a/templates/templates/go/tests/primary/errors_test.go.stmpl +++ b/templates/templates/go/tests/primary/errors_test.go.stmpl @@ -122,7 +122,7 @@ func TestStatusGetErrorXSpeakeasyErrors(t *testing.T) { res, err = s.Errors.StatusGetXSpeakeasyErrors(context.Background(), 501) assert.Nil(t, res) assert.Error(t, err) - assert.Equal(t, "an error occurred", err.Error()) + assert.Equal(t, "501: an error occurred", err.Error()) var e501 *apierrors.StatusGetXSpeakeasyErrorsResponseBody if assert.ErrorAs(t, err, &e501) { @@ -332,6 +332,35 @@ func TestOptionalNullableNestedErrorMessageExplicitNull(t *testing.T) { assert.Equal(t, `{"cause":{},"code":"512"}`, nullMessage.Error()) } +func TestErrorMessageEmptyAndCode(t *testing.T) { + jsonFallback := func(t *testing.T, e error) string { + t.Helper() + data, err := json.Marshal(e) + require.NoError(t, err) + return string(data) + } + + var inferred apierrors.StatusGetXSpeakeasyErrorsResponseBody + require.NoError(t, json.Unmarshal([]byte(`{"code":"501","message":"boom"}`), &inferred)) + assert.Equal(t, "501: boom", inferred.Error()) + + inferred = apierrors.StatusGetXSpeakeasyErrorsResponseBody{} + require.NoError(t, json.Unmarshal([]byte(`{"code":"","message":"boom"}`), &inferred)) + assert.Equal(t, "boom", inferred.Error()) + + inferred = apierrors.StatusGetXSpeakeasyErrorsResponseBody{} + require.NoError(t, json.Unmarshal([]byte(`{"code":"501","message":""}`), &inferred)) + assert.Equal(t, jsonFallback(t, &inferred), inferred.Error()) + + var marked apierrors.NullableOptionalErrorMessage + require.NoError(t, json.Unmarshal([]byte(`{"code":"512","message":""}`), &marked)) + assert.Equal(t, "unknown error", marked.Error()) + + var nested apierrors.NestedNullableOptionalErrorMessage + require.NoError(t, json.Unmarshal([]byte(`{"code":"512","cause":{"message":""}}`), &nested)) + assert.Equal(t, jsonFallback(t, &nested), nested.Error()) +} + func TestErrorUnionRedecodePreservesHTTPMeta(t *testing.T) { t.Run("discriminated", func(t *testing.T) { var u apierrors.ErrorUnionDiscriminatedPostResponseBody diff --git a/zSDKs/sdk-go/.speakeasy/gen.lock b/zSDKs/sdk-go/.speakeasy/gen.lock index 5a5a8f70f..6406ce0cc 100644 --- a/zSDKs/sdk-go/.speakeasy/gen.lock +++ b/zSDKs/sdk-go/.speakeasy/gen.lock @@ -77,7 +77,7 @@ trackedFiles: authop.go: last_write_checksum: sha1:fa2bb0e63a2630c9f0a02ff6ade9607a349d752f badrequestresponseerror.go: - last_write_checksum: sha1:bd8dcf04f96bd7369cf10c9a134d519d6677fceb + last_write_checksum: sha1:2aaa78a47b11165aa162b1656248a1f2b2b030ed bar/bike.go: last_write_checksum: sha1:926178f5c0e7415500fafcfc2004d5efa8bb7356 bar/car.go: @@ -615,11 +615,11 @@ trackedFiles: enum.go: last_write_checksum: sha1:20d9369822bfba4759edfa6ac32473554760a241 errorserror.go: - last_write_checksum: sha1:7bd78060f3240e654456cbb63df5c29481758be5 + last_write_checksum: sha1:27e02db8a17d6f68f3a13153606b4fb534591e16 errortype1.go: last_write_checksum: sha1:ab84d4fd1f8c27b62791463bbc052d288b930db2 errortype2.go: - last_write_checksum: sha1:f6047d675cd257e73bc9bd11075120c84aaaab0d + last_write_checksum: sha1:c69415f502793e1bf7008e1756406ef8d58d4615 escalation.go: last_write_checksum: sha1:191befebaa2a2fe0b8d5ed7982b97c1f73c3dbf9 exhaustiveobject.go: @@ -653,7 +653,7 @@ trackedFiles: getemptyobjecterrorop.go: last_write_checksum: sha1:28e4586ea75ef0c90c5fb912153f041400c66129 geterrorinunionop.go: - last_write_checksum: sha1:266b3474021616373766885842c5687dda36b987 + last_write_checksum: sha1:218b10cfa1a761dd1c733387a2eb542865c3690b geterroronlyexampleop.go: last_write_checksum: sha1:f5300cd22e15fa0ccf6600fb8d505c7758203bce getfullyflattenedrequestop.go: @@ -687,7 +687,7 @@ trackedFiles: gettriplenamespaceconflictop.go: last_write_checksum: sha1:dde51c485a4c22de5d0897ba2df1186d9663ceb2 getunionerrorsop.go: - last_write_checksum: sha1:f4c305f430fa70c0d4b6056050fb4cefa28325ff + last_write_checksum: sha1:bf6a6501ed6c3e335d9f147c85b830370ab036af getuserop.go: last_write_checksum: sha1:ee6b964345d6dacfa261ceab9d4377c3c0dc7e21 go.mod: @@ -785,7 +785,7 @@ trackedFiles: renderassetop.go: last_write_checksum: sha1:a788e389967e88581337759b330af30c4e562bf8 requesttimeouterror.go: - last_write_checksum: sha1:4749648528aaf316126646737bbfda9802e5f4ea + last_write_checksum: sha1:67841444fc13132948f5b84e2578d5e838fc5076 responsevalidationerror.go: last_write_checksum: sha1:20c3c29540d71569cba85300ddb6a55ecddd2e9c retry/config.go: @@ -823,9 +823,9 @@ trackedFiles: tag3.go: last_write_checksum: sha1:01c2cbab58b2ac9635116a687f199e8cd7a6c5b6 taggederror1.go: - last_write_checksum: sha1:0a5cd84a121d7a6c2591e575064d7020af956ffd + last_write_checksum: sha1:e297bfc822c4a8474857dd782798dcf2dfba04b1 taggederror2.go: - last_write_checksum: sha1:5d1cbbc4e5f336982282cebb0d20b9ef57b01842 + last_write_checksum: sha1:21e1b21c80e688109ee021dd89791ea66a2b21e8 tail.go: last_write_checksum: sha1:18aa629f78e1076f1505b5a981bbabb1a81d740c taskresponse.go: diff --git a/zSDKs/sdk-go/badrequestresponseerror.go b/zSDKs/sdk-go/badrequestresponseerror.go index 78a4d8bfc..4bb5fa269 100644 --- a/zSDKs/sdk-go/badrequestresponseerror.go +++ b/zSDKs/sdk-go/badrequestresponseerror.go @@ -168,7 +168,7 @@ var _ error = &BadRequestResponseError{} func (e *BadRequestResponseError) Error() string { if e != nil { - if e.Message != nil { + if e.Message != nil && *e.Message != "" { return *e.Message } } diff --git a/zSDKs/sdk-go/errorserror.go b/zSDKs/sdk-go/errorserror.go index 92c566cc8..c9fba825a 100644 --- a/zSDKs/sdk-go/errorserror.go +++ b/zSDKs/sdk-go/errorserror.go @@ -13,5 +13,9 @@ type ErrorsError struct { var _ error = &ErrorsError{} func (e *ErrorsError) Error() string { + if e.Error_ == "" { + return "unknown error" + } + return e.Error_ } diff --git a/zSDKs/sdk-go/errortype2.go b/zSDKs/sdk-go/errortype2.go index 1f42929b3..37ae684d9 100644 --- a/zSDKs/sdk-go/errortype2.go +++ b/zSDKs/sdk-go/errortype2.go @@ -41,7 +41,9 @@ var _ error = &ErrorType2{} func (e *ErrorType2) Error() string { if e != nil { - return e.Error_.Message + if e.Error_.Message != "" { + return e.Error_.Message + } } data, _ := json.Marshal(e) diff --git a/zSDKs/sdk-go/geterrorinunionop.go b/zSDKs/sdk-go/geterrorinunionop.go index 429f2bfde..236bb5bb4 100644 --- a/zSDKs/sdk-go/geterrorinunionop.go +++ b/zSDKs/sdk-go/geterrorinunionop.go @@ -143,10 +143,16 @@ func (u GetErrorInUnionInternalServerError) MarshalJSON() ([]byte, error) { func (u GetErrorInUnionInternalServerError) Error() string { switch u.Type { case GetErrorInUnionInternalServerErrorTypeErrorsError: + if u.ErrorsError.Error_ == "" { + return "unknown error" + } + return u.ErrorsError.Error_ case GetErrorInUnionInternalServerErrorTypeTaggedError1: if u.TaggedError1 != nil { - return u.TaggedError1.Message + if u.TaggedError1.Message != "" { + return u.TaggedError1.Message + } } data, _ := json.Marshal(u.TaggedError1) diff --git a/zSDKs/sdk-go/getunionerrorsop.go b/zSDKs/sdk-go/getunionerrorsop.go index 62c277b5d..5130b6a00 100644 --- a/zSDKs/sdk-go/getunionerrorsop.go +++ b/zSDKs/sdk-go/getunionerrorsop.go @@ -165,14 +165,18 @@ func (u ClientError) Error() string { switch u.Type { case ClientErrorTypeTag1: if u.TaggedError1 != nil { - return u.TaggedError1.Message + if u.TaggedError1.Message != "" { + return u.TaggedError1.Message + } } data, _ := json.Marshal(u.TaggedError1) return string(data) case ClientErrorTypeTag2: if u.TaggedError2 != nil { - return u.TaggedError2.Error_.Message + if u.TaggedError2.Error_.Message != "" { + return u.TaggedError2.Error_.Message + } } data, _ := json.Marshal(u.TaggedError2) @@ -325,7 +329,9 @@ func (u GetUnionErrorsInternalServerError) Error() string { return string(data) case GetUnionErrorsInternalServerErrorTypeErrorType2: if u.ErrorType2 != nil { - return u.ErrorType2.Error_.Message + if u.ErrorType2.Error_.Message != "" { + return u.ErrorType2.Error_.Message + } } data, _ := json.Marshal(u.ErrorType2) diff --git a/zSDKs/sdk-go/requesttimeouterror.go b/zSDKs/sdk-go/requesttimeouterror.go index ef8b57d7b..0754b68ce 100644 --- a/zSDKs/sdk-go/requesttimeouterror.go +++ b/zSDKs/sdk-go/requesttimeouterror.go @@ -4,6 +4,7 @@ package openapi import ( "encoding/json" + "fmt" ) // RequestTimeoutError - A spec-defined error that collides with the built-in RequestTimeoutError in httpclienterrors.ts @@ -17,7 +18,10 @@ var _ error = &RequestTimeoutError{} func (e *RequestTimeoutError) Error() string { if e != nil { - if e.Message != nil { + if e.Message != nil && *e.Message != "" { + if e.Code != nil { + return fmt.Sprintf("%v: %s", *e.Code, *e.Message) + } return *e.Message } } diff --git a/zSDKs/sdk-go/taggederror1.go b/zSDKs/sdk-go/taggederror1.go index 3652e2ec1..76762db02 100644 --- a/zSDKs/sdk-go/taggederror1.go +++ b/zSDKs/sdk-go/taggederror1.go @@ -41,7 +41,9 @@ var _ error = &TaggedError1{} func (e *TaggedError1) Error() string { if e != nil { - return e.Message + if e.Message != "" { + return e.Message + } } data, _ := json.Marshal(e) diff --git a/zSDKs/sdk-go/taggederror2.go b/zSDKs/sdk-go/taggederror2.go index e43baa913..1dda0dae1 100644 --- a/zSDKs/sdk-go/taggederror2.go +++ b/zSDKs/sdk-go/taggederror2.go @@ -42,7 +42,9 @@ var _ error = &TaggedError2{} func (e *TaggedError2) Error() string { if e != nil { - return e.Error_.Message + if e.Error_.Message != "" { + return e.Error_.Message + } } data, _ := json.Marshal(e) From 14d9d7c8a89e09a401a1e02bd7460180f61549b8 Mon Sep 17 00:00:00 2001 From: Tristan Cartledge Date: Mon, 16 Nov 2026 09:50:15 +1000 Subject: [PATCH 2/2] fix(go): guard empty string-backed enum error codes and regenerate review CLI --- .../error_message_leaf_types_go_test.go | 60 ++++++++++++++++++- templates/templates/go/includes/templating.ts | 6 +- zSDKs/sdk-cli/.speakeasy/gen.lock | 16 ++--- .../sdkerrors/badrequestresponseerror.go | 2 +- .../internal/sdk/models/sdkerrors/error.go | 4 ++ .../sdk/models/sdkerrors/errortype2.go | 4 +- .../sdk/models/sdkerrors/geterrorinunion.go | 8 ++- .../sdk/models/sdkerrors/getunionerrors.go | 12 +++- .../models/sdkerrors/requesttimeouterror.go | 6 +- .../sdk/models/sdkerrors/taggederror1.go | 4 +- .../sdk/models/sdkerrors/taggederror2.go | 4 +- 11 files changed, 106 insertions(+), 20 deletions(-) diff --git a/pkg/generate/snapshots/error_message_leaf_types_go_test.go b/pkg/generate/snapshots/error_message_leaf_types_go_test.go index 8d255a171..6967d72e6 100644 --- a/pkg/generate/snapshots/error_message_leaf_types_go_test.go +++ b/pkg/generate/snapshots/error_message_leaf_types_go_test.go @@ -89,6 +89,12 @@ paths: application/json: schema: $ref: "#/components/schemas/MarkedMessageCodeError" + "503": + description: Service Unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/EnumCodeError" components: schemas: Cause: @@ -184,7 +190,17 @@ components: type: string detail: type: string - x-speakeasy-error-message: true` + x-speakeasy-error-message: true + EnumCodeError: + type: object + required: [code] + properties: + code: + type: string + enum: [quota, overloaded] + x-speakeasy-unknown-values: allow + message: + type: string` genYaml := `go: packageName: github.com/example/test @@ -201,9 +217,46 @@ components: "models/apierrors/toplevelcodeerror.go", "models/apierrors/wrappedcodeerror.go", "models/apierrors/markedmessagecodeerror.go", + "models/apierrors/enumcodeerror.go", } - expectedSnapshot := `--- models/apierrors/enummessageerror.go --- + expectedSnapshot := `--- models/apierrors/enumcodeerror.go --- +// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. +// Generated under the AGPL-3.0-only license. +// SPDX-License-Identifier: AGPL-3.0-only + +package apierrors + +import ( + "encoding/json" + "fmt" + "github.com/example/test/models/components" +) + +type EnumCodeError struct { + Code components.Code ` + "`" + `json:"code"` + "`" + ` + Message *string ` + "`" + `json:"message,omitzero"` + "`" + ` + HTTPMeta components.HTTPMetadata ` + "`" + `json:"-"` + "`" + ` +} + +var _ error = &EnumCodeError{} + +func (e *EnumCodeError) Error() string { + if e != nil { + if e.Message != nil && *e.Message != "" { + if e.Code != "" { + return fmt.Sprintf("%v: %s", e.Code, *e.Message) + } + return *e.Message + } + } + + data, _ := json.Marshal(e) + return string(data) +} + + +--- models/apierrors/enummessageerror.go --- // Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. // Generated under the AGPL-3.0-only license. // SPDX-License-Identifier: AGPL-3.0-only @@ -590,6 +643,9 @@ func TestErrorMessageLeafTypes(t *testing.T) { assertErrorMessage(t, &apierrors.MarkedMessageCodeError{}, `+"`"+`{"error":{"code":"denied","detail":"not allowed"}}`+"`"+`, "not allowed") assertJSONFallback(t, &apierrors.MarkedMessageCodeError{}, `+"`"+`{"error":{"code":"denied","detail":""}}`+"`"+`) + + assertErrorMessage(t, &apierrors.EnumCodeError{}, `+"`"+`{"code":"overloaded","message":"try later"}`+"`"+`, "overloaded: try later") + assertErrorMessage(t, &apierrors.EnumCodeError{}, `+"`"+`{"message":"try later"}`+"`"+`, "try later") } `), 0o644)) t.Cleanup(func() { _ = os.Remove(path) }) diff --git a/templates/templates/go/includes/templating.ts b/templates/templates/go/includes/templating.ts index b2104a9ff..318c1dcbe 100644 --- a/templates/templates/go/includes/templating.ts +++ b/templates/templates/go/includes/templating.ts @@ -953,7 +953,11 @@ return ${access}`; codeField, leafOwner, )}`; - const isStringCode = codeField.Type.Type.toString() === "string"; + const codeType = codeField.Type.Type.toString(); + const isStringCode = + codeType === "string" || + (codeType === "enum" && + codeField.Type.Enum?.Type.Type.toString() === "string"); let code = access; let guarded = true; switch (errorMessageHopKind(codeField, leafOwner)) { diff --git a/zSDKs/sdk-cli/.speakeasy/gen.lock b/zSDKs/sdk-cli/.speakeasy/gen.lock index d4f44b8ff..1dbab381d 100644 --- a/zSDKs/sdk-cli/.speakeasy/gen.lock +++ b/zSDKs/sdk-cli/.speakeasy/gen.lock @@ -542,29 +542,29 @@ trackedFiles: internal/sdk/models/operations/validate.go: last_write_checksum: sha1:f47ee88aa6d2e430efe640ad5113beea9aa25e68 internal/sdk/models/sdkerrors/badrequestresponseerror.go: - last_write_checksum: sha1:555b7a6b09f85a26162b8db770e3ae4de2b3aeae + last_write_checksum: sha1:24de2cf11844f750c2da28e17241c1d38ec073cf internal/sdk/models/sdkerrors/error.go: - last_write_checksum: sha1:3973a2b79661a96c636a1e857f3b77292a5f170f + last_write_checksum: sha1:89b152278094c5816a86090cbfa09e3b7f780c16 internal/sdk/models/sdkerrors/errortype1.go: last_write_checksum: sha1:62ad7f2ed96d3a8ef23f80b2174f3711cd331d26 internal/sdk/models/sdkerrors/errortype2.go: - last_write_checksum: sha1:8c338cead9c410ef3fdd0bdf9cb22aa61deacccc + last_write_checksum: sha1:b7ace6264432974b17375b2e95e19a0c07649780 internal/sdk/models/sdkerrors/failedresponseerror.go: last_write_checksum: sha1:9f3a5f50740244b5976fde99cbb908ad289eda91 internal/sdk/models/sdkerrors/geterrorinunion.go: - last_write_checksum: sha1:8e4b3a3d943796e5007c299529a95e972de795d2 + last_write_checksum: sha1:62444e77cb829657183e16bb70e478f688e2e904 internal/sdk/models/sdkerrors/getunionerrors.go: - last_write_checksum: sha1:681f589c44bfb8d555a87869cd1ff2320909c2af + last_write_checksum: sha1:091d5897ab97c24f4b226b633a78563cd6bcd18c internal/sdk/models/sdkerrors/requesttimeouterror.go: - last_write_checksum: sha1:ea238181e76aa3559af239e7c27601484b5b6082 + last_write_checksum: sha1:2d75ee63e3044426e58a66136a4d1c7c9356b85a internal/sdk/models/sdkerrors/responsevalidationerror.go: last_write_checksum: sha1:77189808f8c0d0fc49a2e8cc77a8a4006e61682c internal/sdk/models/sdkerrors/sdkdefaulterror.go: last_write_checksum: sha1:437b3a3eacb54d8648a68f80b3cd38fa5019f006 internal/sdk/models/sdkerrors/taggederror1.go: - last_write_checksum: sha1:bb30f824856c8d13b83aa8a5695ab3c3dd73caa9 + last_write_checksum: sha1:8373049a44262caa6528874565da69935f6fe87a internal/sdk/models/sdkerrors/taggederror2.go: - last_write_checksum: sha1:9acb472e88185d6b14a453ec4fa20f397715d5da + last_write_checksum: sha1:98587f00be5f59cfede96c1b38817251800d2110 internal/sdk/models/sdkerrors/test2responseerror.go: last_write_checksum: sha1:c4410b1558064bbd65a4dbf51390eb2327da156a internal/sdk/models/webhooks/paymentcreated.go: diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/badrequestresponseerror.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/badrequestresponseerror.go index 6808b2b80..4adb235dc 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/badrequestresponseerror.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/badrequestresponseerror.go @@ -28,7 +28,7 @@ var _ error = &BadRequestResponseError{} func (e *BadRequestResponseError) Error() string { if e != nil { - if e.Message != nil { + if e.Message != nil && *e.Message != "" { return *e.Message } } diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/error.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/error.go index 8c37de0b7..694e7b7bd 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/error.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/error.go @@ -17,5 +17,9 @@ type Error struct { var _ error = &Error{} func (e *Error) Error() string { + if e.ErrorInfo == "" { + return "unknown error" + } + return e.ErrorInfo } diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/errortype2.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/errortype2.go index 3ff077ffa..d49a91577 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/errortype2.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/errortype2.go @@ -16,7 +16,9 @@ var _ error = &ErrorType2{} func (e *ErrorType2) Error() string { if e != nil { - return e.ErrorInfo.Message + if e.ErrorInfo.Message != "" { + return e.ErrorInfo.Message + } } data, _ := json.Marshal(e) diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/geterrorinunion.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/geterrorinunion.go index c42ac9a7a..f584e17db 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/geterrorinunion.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/geterrorinunion.go @@ -143,10 +143,16 @@ func (u GetErrorInUnionInternalServerError) MarshalJSON() ([]byte, error) { func (u GetErrorInUnionInternalServerError) Error() string { switch u.Type { case GetErrorInUnionInternalServerErrorTypeError: + if u.ErrorInfo.ErrorInfo == "" { + return "unknown error" + } + return u.ErrorInfo.ErrorInfo case GetErrorInUnionInternalServerErrorTypeTaggedError1: if u.TaggedError1 != nil { - return u.TaggedError1.Message + if u.TaggedError1.Message != "" { + return u.TaggedError1.Message + } } data, _ := json.Marshal(u.TaggedError1) diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/getunionerrors.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/getunionerrors.go index 95827cede..61451c038 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/getunionerrors.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/getunionerrors.go @@ -141,14 +141,18 @@ func (u ClientError) Error() string { switch u.Type { case ClientErrorTypeTag1: if u.TaggedError1 != nil { - return u.TaggedError1.Message + if u.TaggedError1.Message != "" { + return u.TaggedError1.Message + } } data, _ := json.Marshal(u.TaggedError1) return string(data) case ClientErrorTypeTag2: if u.TaggedError2 != nil { - return u.TaggedError2.ErrorInfo.Message + if u.TaggedError2.ErrorInfo.Message != "" { + return u.TaggedError2.ErrorInfo.Message + } } data, _ := json.Marshal(u.TaggedError2) @@ -300,7 +304,9 @@ func (u GetUnionErrorsInternalServerError) Error() string { return string(data) case GetUnionErrorsInternalServerErrorTypeErrorType2: if u.ErrorType2 != nil { - return u.ErrorType2.ErrorInfo.Message + if u.ErrorType2.ErrorInfo.Message != "" { + return u.ErrorType2.ErrorInfo.Message + } } data, _ := json.Marshal(u.ErrorType2) diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/requesttimeouterror.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/requesttimeouterror.go index 7728ca96f..97d94e647 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/requesttimeouterror.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/requesttimeouterror.go @@ -4,6 +4,7 @@ package sdkerrors import ( "encoding/json" + "fmt" "openapi/internal/sdk/models/components" ) @@ -18,7 +19,10 @@ var _ error = &RequestTimeoutError{} func (e *RequestTimeoutError) Error() string { if e != nil { - if e.Message != nil { + if e.Message != nil && *e.Message != "" { + if e.Code != nil { + return fmt.Sprintf("%v: %s", *e.Code, *e.Message) + } return *e.Message } } diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror1.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror1.go index afa1c29a8..c84e2f961 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror1.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror1.go @@ -18,7 +18,9 @@ var _ error = &TaggedError1{} func (e *TaggedError1) Error() string { if e != nil { - return e.Message + if e.Message != "" { + return e.Message + } } data, _ := json.Marshal(e) diff --git a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror2.go b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror2.go index 0f4f02700..2ec48ee85 100644 --- a/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror2.go +++ b/zSDKs/sdk-cli/internal/sdk/models/sdkerrors/taggederror2.go @@ -17,7 +17,9 @@ var _ error = &TaggedError2{} func (e *TaggedError2) Error() string { if e != nil { - return e.ErrorInfo.Message + if e.ErrorInfo.Message != "" { + return e.ErrorInfo.Message + } } data, _ := json.Marshal(e)