package chaterror_test import ( "context" "io" "net/http" "strings" "testing" "time" "charm.land/fantasy" "github.com/stretchr/testify/require" "golang.org/x/net/http2" "golang.org/x/xerrors" "github.com/coder/coder/v2/coderd/x/chatd/chaterror" "github.com/coder/coder/v2/codersdk" ) func TestClassify(t *testing.T) { t.Parallel() tests := []struct { name string err error want chaterror.ClassifiedError }{ { name: "AmbiguousOverloadKeepsProviderUnknown", err: xerrors.New("status 529 from upstream"), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily overloaded.", Kind: codersdk.ChatErrorKindOverloaded, Provider: "", Retryable: true, StatusCode: 529, }, }, { name: "ExplicitAnthropicOverload", err: xerrors.New("anthropic overloaded_error"), want: chaterror.ClassifiedError{ Message: "Anthropic is temporarily overloaded.", Kind: codersdk.ChatErrorKindOverloaded, Provider: "anthropic", Retryable: true, StatusCode: 0, }, }, { name: "AnthropicMissingMessageStop", err: xerrors.Errorf( "anthropic stream closed before message_stop: %w", io.EOF, ), want: chaterror.ClassifiedError{ Message: "Anthropic stream closed unexpectedly before the response completed.", Kind: codersdk.ChatErrorKindTimeout, Provider: "anthropic", Retryable: true, StatusCode: 0, }, }, { name: "OpenAIResponsesMissingTerminalEvent", err: xerrors.Errorf( "openai responses stream closed before terminal event: %w", io.EOF, ), want: chaterror.ClassifiedError{ Message: "OpenAI stream closed unexpectedly before the response completed.", Kind: codersdk.ChatErrorKindTimeout, Provider: "openai", Retryable: true, StatusCode: 0, }, }, { name: "AuthBeatsConfig", err: xerrors.New("authentication failed: invalid model"), want: chaterror.ClassifiedError{ Message: "Authentication with the AI provider failed. Check the API key, permissions, and billing settings.", Kind: codersdk.ChatErrorKindAuth, Provider: "", Retryable: false, StatusCode: 0, }, }, { name: "PureConfig", err: xerrors.New("invalid model"), want: chaterror.ClassifiedError{ Message: "The AI provider rejected the model configuration. Check the selected model and provider settings.", Kind: codersdk.ChatErrorKindConfig, Provider: "", Retryable: false, StatusCode: 0, }, }, { name: "BareForbiddenClassifiesAsAuth", err: xerrors.New("forbidden"), want: chaterror.ClassifiedError{ Message: "Authentication with the AI provider failed. Check the API key, permissions, and billing settings.", Kind: codersdk.ChatErrorKindAuth, Provider: "", Retryable: false, StatusCode: 0, }, }, { name: "ExplicitStatus401ClassifiesAsAuth", err: xerrors.New("status 401 from upstream"), want: chaterror.ClassifiedError{ Message: "Authentication with the AI provider failed. Check the API key, permissions, and billing settings.", Kind: codersdk.ChatErrorKindAuth, Provider: "", Retryable: false, StatusCode: 401, }, }, { name: "ExplicitStatus403ClassifiesAsAuth", err: xerrors.New("status 403 from upstream"), want: chaterror.ClassifiedError{ Message: "Authentication with the AI provider failed. Check the API key, permissions, and billing settings.", Kind: codersdk.ChatErrorKindAuth, Provider: "", Retryable: false, StatusCode: 403, }, }, { name: "ForbiddenContextLengthClassifiesAsConfig", err: xerrors.New("forbidden: context length exceeded"), want: chaterror.ClassifiedError{ Message: "The AI provider rejected the model configuration. Check the selected model and provider settings.", Kind: codersdk.ChatErrorKindConfig, Provider: "", Retryable: false, StatusCode: 0, }, }, { name: "ExplicitStatus429ClassifiesAsRateLimit", err: xerrors.New("status 429 from upstream"), want: chaterror.ClassifiedError{ Message: "The AI provider is rate limiting requests.", Kind: codersdk.ChatErrorKindRateLimit, Provider: "", Retryable: true, StatusCode: 429, }, }, { name: "RateLimitDoesNotBeatConfig", err: xerrors.New("status 429: invalid model"), want: chaterror.ClassifiedError{ Message: "The AI provider rejected the model configuration. Check the selected model and provider settings.", Kind: codersdk.ChatErrorKindConfig, Provider: "", Retryable: false, StatusCode: 429, }, }, { name: "ServiceUnavailableClassifiesAsRetryableTimeout", err: xerrors.New("service unavailable"), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Provider: "", Retryable: true, StatusCode: 0, }, }, { name: "TimeoutDoesNotBeatConfigViaStatusCode", err: xerrors.New("status 503: invalid model"), want: chaterror.ClassifiedError{ Message: "The AI provider rejected the model configuration. Check the selected model and provider settings.", Kind: codersdk.ChatErrorKindConfig, Provider: "", Retryable: false, StatusCode: 503, }, }, { name: "TimeoutDoesNotBeatConfigViaMessage", err: xerrors.New("service unavailable: model not found"), want: chaterror.ClassifiedError{ Message: "The AI provider rejected the model configuration. Check the selected model and provider settings.", Kind: codersdk.ChatErrorKindConfig, Provider: "", Retryable: false, StatusCode: 0, }, }, { name: "ConnectionRefusedUnsupportedModelClassifiesAsConfig", err: xerrors.New("connection refused: unsupported model"), want: chaterror.ClassifiedError{ Message: "The AI provider rejected the model configuration. Check the selected model and provider settings.", Kind: codersdk.ChatErrorKindConfig, Provider: "", Retryable: false, StatusCode: 0, }, }, { name: "DeadlineExceededStaysNonRetryableTimeout", err: context.DeadlineExceeded, want: chaterror.ClassifiedError{ Message: "The request timed out before it completed.", Kind: codersdk.ChatErrorKindTimeout, Provider: "", Retryable: false, StatusCode: 0, }, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { t.Parallel() require.Equal(t, tt.want, chaterror.Classify(tt.err)) }) } } func TestClassify_OpenAIResponsesAPIDiagnostics(t *testing.T) { t.Parallel() tests := []struct { name string err string responseBody string wantDetail string forbidden []string }{ { name: "FunctionCallOutputMissing", err: "No Tool Output Found For Function Call call_sensitive123", responseBody: `{"error":{"message":"No tool output found for function call call_sensitive123"}}`, wantDetail: "OpenAI Responses API request continuity diagnostic: match=function_call_output_missing.", forbidden: []string{"call_sensitive123"}, }, { name: "WebSearchReasoningMissing", err: "Item 'ws_sensitive123' of type 'web_search_call' WAS PROVIDED WITHOUT ITS REQUIRED 'reasoning' item: 'rs_sensitive123'", responseBody: `{"error":{"message":"Item 'ws_sensitive123' of type 'web_search_call' was provided without its required 'reasoning' item: 'rs_sensitive123'"}}`, wantDetail: "OpenAI Responses API request continuity diagnostic: match=web_search_reasoning_missing.", forbidden: []string{"ws_sensitive123", "rs_sensitive123"}, }, } assertNoLeak := func(t *testing.T, classified chaterror.ClassifiedError, forbidden []string) { t.Helper() for _, value := range forbidden { require.NotContains(t, classified.Message, value) require.NotContains(t, classified.Detail, value) } } assertDirectionalMessage := func(t *testing.T, message string) { t.Helper() require.Contains(t, message, "chat continuation") require.Contains(t, message, "internal state mismatch") require.Contains(t, message, "not a configuration or billing issue") } for _, tt := range tests { t.Run(tt.name+"/BareString", func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New(tt.err)) require.Equal(t, codersdk.ChatErrorKindGeneric, classified.Kind) require.False(t, classified.Retryable) require.Zero(t, classified.StatusCode) assertDirectionalMessage(t, classified.Message) require.Equal(t, tt.wantDetail, classified.Detail) assertNoLeak(t, classified, tt.forbidden) }) t.Run(tt.name+"/WrappedProviderError", func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.Errorf( "provider request failed: %w", testProviderError( "", 400, nil, testProviderResponseDump(tt.responseBody), ), )) require.Equal(t, codersdk.ChatErrorKindGeneric, classified.Kind) require.False(t, classified.Retryable) require.Equal(t, 400, classified.StatusCode) assertDirectionalMessage(t, classified.Message) require.Equal(t, tt.wantDetail, classified.Detail) assertNoLeak(t, classified, tt.forbidden) }) } } func TestClassify_PatternCoverage(t *testing.T) { t.Parallel() tests := []struct { name string err string wantKind codersdk.ChatErrorKind wantRetry bool }{ {name: "OverloadedLiteral", err: "overloaded", wantKind: codersdk.ChatErrorKindOverloaded, wantRetry: true}, {name: "RateLimitLiteral", err: "rate limit", wantKind: codersdk.ChatErrorKindRateLimit, wantRetry: true}, {name: "RateLimitUnderscoreLiteral", err: "rate_limit", wantKind: codersdk.ChatErrorKindRateLimit, wantRetry: true}, {name: "RateLimitedLiteral", err: "rate limited", wantKind: codersdk.ChatErrorKindRateLimit, wantRetry: true}, {name: "RateLimitedHyphenLiteral", err: "rate-limited", wantKind: codersdk.ChatErrorKindRateLimit, wantRetry: true}, {name: "TooManyRequestsLiteral", err: "too many requests", wantKind: codersdk.ChatErrorKindRateLimit, wantRetry: true}, {name: "TimeoutLiteral", err: "timeout", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "TimedOutLiteral", err: "timed out", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "ServiceUnavailableLiteral", err: "service unavailable", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "UnavailableLiteral", err: "unavailable", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "ConnectionResetLiteral", err: "connection reset", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "ConnectionRefusedLiteral", err: "connection refused", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "EOFLiteral", err: "eof", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "BrokenPipeLiteral", err: "broken pipe", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "BadGatewayLiteral", err: "bad gateway", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "GatewayTimeoutLiteral", err: "gateway timeout", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "ClientConnLiteral", err: "client conn", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "GOAWAYLiteral", err: "goaway", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "HTTP2StreamClosedLiteral", err: "http2: stream closed", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "UseOfClosedNetworkConnectionLiteral", err: "use of closed network connection", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "HTTP2InternalErrorReceivedFromPeerLiteral", err: "internal_error; received from peer", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "HTTP2RefusedStreamReceivedFromPeerLiteral", err: "refused_stream; received from peer", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "HTTP2CancelReceivedFromPeerLiteral", err: "cancel; received from peer", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "HTTP2EnhanceYourCalmReceivedFromPeerLiteral", err: "enhance_your_calm; received from peer", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "HTTP2NoErrorReceivedFromPeerLiteral", err: "no_error; received from peer", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "AuthenticationLiteral", err: "authentication", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "UnauthorizedLiteral", err: "unauthorized", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "InvalidAPIKeyLiteral", err: "invalid api key", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "InvalidAPIKeyUnderscoreLiteral", err: "invalid_api_key", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "QuotaLiteral", err: "quota", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "BillingLiteral", err: "billing", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "InsufficientQuotaLiteral", err: "insufficient_quota", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "PaymentRequiredLiteral", err: "payment required", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "ForbiddenLiteral", err: "forbidden", wantKind: codersdk.ChatErrorKindAuth, wantRetry: false}, {name: "InvalidModelLiteral", err: "invalid model", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "ModelNotFoundLiteral", err: "model not found", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "ModelNotFoundUnderscoreLiteral", err: "model_not_found", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "UnsupportedModelLiteral", err: "unsupported model", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "ContextLengthExceededLiteral", err: "context length exceeded", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "ContextExceededLiteral", err: "context_exceeded", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "MaximumContextLengthLiteral", err: "maximum context length", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "MalformedConfigLiteral", err: "malformed config", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "MalformedConfigurationLiteral", err: "malformed configuration", wantKind: codersdk.ChatErrorKindConfig, wantRetry: false}, {name: "ServerErrorLiteral", err: "server error", wantKind: codersdk.ChatErrorKindGeneric, wantRetry: true}, {name: "InternalServerErrorLiteral", err: "internal server error", wantKind: codersdk.ChatErrorKindGeneric, wantRetry: true}, {name: "ChatInterruptedLiteral", err: "chat interrupted", wantKind: codersdk.ChatErrorKindGeneric, wantRetry: false}, {name: "RequestInterruptedLiteral", err: "request interrupted", wantKind: codersdk.ChatErrorKindGeneric, wantRetry: false}, {name: "OperationInterruptedLiteral", err: "operation interrupted", wantKind: codersdk.ChatErrorKindGeneric, wantRetry: false}, {name: "Status408", err: "status 408", wantKind: codersdk.ChatErrorKindTimeout, wantRetry: true}, {name: "Status500", err: "status 500", wantKind: codersdk.ChatErrorKindGeneric, wantRetry: true}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New(tt.err)) require.Equal(t, tt.wantKind, classified.Kind) require.Equal(t, tt.wantRetry, classified.Retryable) }) } } func TestClassify_TransportFailuresUseBroaderRetryMessage(t *testing.T) { t.Parallel() tests := []struct { name string err string }{ {name: "TimeoutLiteral", err: "timeout"}, {name: "EOFLiteral", err: "eof"}, {name: "BrokenPipeLiteral", err: "broken pipe"}, {name: "ConnectionResetLiteral", err: "connection reset"}, {name: "ConnectionRefusedLiteral", err: "connection refused"}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New(tt.err)) require.Equal(t, codersdk.ChatErrorKindTimeout, classified.Kind) require.True(t, classified.Retryable) require.Equal( t, "The AI provider is temporarily unavailable.", classified.Message, ) }) } } // TestClassify_HTTP2TransportErrors checks HTTP/2 transport errors // classify as retryable ChatErrorKindTimeout. Split into two sub-tables so a // bug in transport matching cannot be masked by provider detection // (and vice versa). func TestClassify_HTTP2TransportErrors(t *testing.T) { t.Parallel() // Transport patterns, no provider hint. Provider stays empty and // Message uses the generic subject. transportOnly := []struct { name string err string }{ { name: "HTTP2ClientConnForceClosed", err: "http2: client connection force closed via ClientConn.Close", }, { name: "HTTP2TransportGOAWAY", err: "http2: Transport received Server's graceful shutdown GOAWAY", }, { name: "HTTP2ServerGOAWAY", err: "http2: server sent GOAWAY and closed the connection", }, { name: "HTTP2StreamClosed", err: "http2: stream closed", }, { name: "HTTP2PeerInternalStreamReset", err: "stream error: stream ID 455; INTERNAL_ERROR; received from peer", }, { name: "UseOfClosedNetworkConnectionOnPOST", err: `Post "https://example.com/v1/messages": use of closed network connection`, }, { name: "HTTP2ClientConnIsClosed", err: "http2: client conn is closed", }, { name: "HTTP2ClientConnNotUsable", err: "http2: client conn not usable", }, { name: "HTTP2ClientConnNotEstablished", err: "http2: client conn could not be established", }, { name: "HTTP2ClientConnectionLost", err: "http2: client connection lost", }, } for _, tt := range transportOnly { t.Run("TransportOnly/"+tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New(tt.err)) require.Equal(t, codersdk.ChatErrorKindTimeout, classified.Kind, "Kind") require.True(t, classified.Retryable, "Retryable") require.Equal(t, "", classified.Provider, "Provider") require.Equal(t, "The AI provider is temporarily unavailable.", classified.Message, "Message", ) }) } // Same transport signature with a provider host in the URL so // detectProvider can stamp Provider. providerDetection := []struct { name string err string provider string wantMessage string }{ { name: "CustomerRegressionAnthropic", err: `stream response: Post "https://api.anthropic.com/v1/messages": http2: client connection force closed via ClientConn.Close`, provider: "anthropic", wantMessage: "Anthropic is temporarily unavailable.", }, { name: "OpenAIForceClosed", err: `stream response: Post "https://api.openai.com/v1/chat/completions": http2: client connection force closed via ClientConn.Close`, provider: "openai", wantMessage: "OpenAI is temporarily unavailable.", }, { name: "AnthropicPeerInternalStreamReset", err: `stream response: Post "https://api.anthropic.com/v1/messages": stream error: stream ID 455; INTERNAL_ERROR; received from peer`, provider: "anthropic", wantMessage: "Anthropic is temporarily unavailable.", }, { name: "GoogleGOAWAY", err: `stream response: Post "https://generativelanguage.googleapis.com/v1beta/models/gemini-pro:streamGenerateContent": http2: server sent GOAWAY and closed the connection`, provider: "google", wantMessage: "Google is temporarily unavailable.", }, } for _, tt := range providerDetection { t.Run("ProviderDetection/"+tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New(tt.err)) require.Equal(t, codersdk.ChatErrorKindTimeout, classified.Kind, "Kind") require.True(t, classified.Retryable, "Retryable") require.Equal(t, tt.provider, classified.Provider, "Provider") require.Equal(t, tt.wantMessage, classified.Message, "Message") }) } } func TestClassify_HTTP2StreamErrorValues(t *testing.T) { t.Parallel() peerReset := func(code http2.ErrCode) http2.StreamError { return http2.StreamError{ StreamID: 455, Code: code, Cause: xerrors.New("received from peer"), } } retryable := []struct { name string err error want chaterror.ClassifiedError }{ { name: "Internal", err: peerReset(http2.ErrCodeInternal), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, { name: "RefusedStream", err: peerReset(http2.ErrCodeRefusedStream), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, { name: "CancelPointer", err: &http2.StreamError{ StreamID: 455, Code: http2.ErrCodeCancel, Cause: xerrors.New("received from peer"), }, want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, { name: "EnhanceYourCalm", err: peerReset(http2.ErrCodeEnhanceYourCalm), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, { name: "NoError", err: peerReset(http2.ErrCodeNo), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, } for _, tt := range retryable { t.Run("Retryable/"+tt.name, func(t *testing.T) { t.Parallel() require.Equal(t, tt.want, chaterror.Classify(tt.err)) }) } localNonRetryable := []struct { name string err error }{ { name: "CancelWithoutPeerCause", err: http2.StreamError{ StreamID: 455, Code: http2.ErrCodeCancel, }, }, { name: "InternalWithLocalCause", err: http2.StreamError{ StreamID: 455, Code: http2.ErrCodeInternal, Cause: xerrors.New("local transport reset"), }, }, } for _, tt := range localNonRetryable { t.Run("NonRetryable/"+tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(tt.err) require.Equal(t, codersdk.ChatErrorKindGeneric, classified.Kind) require.False(t, classified.Retryable) }) } nonRetryable := []struct { name string code http2.ErrCode }{ {name: "Protocol", code: http2.ErrCodeProtocol}, {name: "FlowControl", code: http2.ErrCodeFlowControl}, {name: "FrameSize", code: http2.ErrCodeFrameSize}, {name: "Compression", code: http2.ErrCodeCompression}, } for _, tt := range nonRetryable { t.Run("NonRetryable/"+tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(peerReset(tt.code)) require.Equal(t, codersdk.ChatErrorKindGeneric, classified.Kind) require.False(t, classified.Retryable) }) } } func TestClassify_HTTP2StreamIDDoesNotBecomeStatusCode(t *testing.T) { t.Parallel() tests := []struct { name string err error want chaterror.ClassifiedError }{ { name: "RetryableInternalWithAuthLikeStreamID", err: http2.StreamError{ StreamID: 401, Code: http2.ErrCodeInternal, Cause: xerrors.New("received from peer"), }, want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, { name: "NonRetryableProtocolWithTimeoutLikeStreamID", err: http2.StreamError{ StreamID: 503, Code: http2.ErrCodeProtocol, Cause: xerrors.New("received from peer"), }, want: chaterror.ClassifiedError{ Message: "The chat request failed unexpectedly.", Kind: codersdk.ChatErrorKindGeneric, }, }, { name: "StringFallbackInternalWithAuthLikeStreamID", err: xerrors.New("stream error: stream ID 401; INTERNAL_ERROR; received from peer"), want: chaterror.ClassifiedError{ Message: "The AI provider is temporarily unavailable.", Kind: codersdk.ChatErrorKindTimeout, Retryable: true, }, }, { name: "StringProtocolWithTimeoutLikeStreamID", err: xerrors.New("stream error: stream ID 503; PROTOCOL_ERROR; received from peer"), want: chaterror.ClassifiedError{ Message: "The chat request failed unexpectedly.", Kind: codersdk.ChatErrorKindGeneric, }, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { t.Parallel() require.Equal(t, tt.want, chaterror.Classify(tt.err)) }) } } func TestClassify_StatusCodeBeatsTypedHTTP2StreamError(t *testing.T) { t.Parallel() err := xerrors.Errorf( "provider returned status 401: %w", http2.StreamError{ StreamID: 455, Code: http2.ErrCodeInternal, Cause: xerrors.New("received from peer"), }, ) require.Equal(t, chaterror.ClassifiedError{ Message: "Authentication with the AI provider failed. Check the API key, permissions, and billing settings.", Kind: codersdk.ChatErrorKindAuth, Retryable: false, StatusCode: 401, }, chaterror.Classify(err)) } // TestClassify_StatusCodeBeatsHTTP2Transport ensures explicit status // codes still win over the new HTTP/2 patterns. func TestClassify_StatusCodeBeatsHTTP2Transport(t *testing.T) { t.Parallel() tests := []struct { name string err string wantKind codersdk.ChatErrorKind wantRetryable bool wantStatus int }{ { name: "HTTP2With429", err: "http2: server error 429 Too Many Requests", wantKind: codersdk.ChatErrorKindRateLimit, wantRetryable: true, wantStatus: 429, }, { name: "HTTP2With401", err: "http2: 401 unauthorized", wantKind: codersdk.ChatErrorKindAuth, wantRetryable: false, wantStatus: 401, }, { name: "ClientConnWith429RateLimitWins", err: "http2: client conn is closed: status 429 Too Many Requests", wantKind: codersdk.ChatErrorKindRateLimit, wantRetryable: true, wantStatus: 429, }, { name: "GOAWAYWith401AuthWins", err: "http2: server sent GOAWAY: status 401 unauthorized", wantKind: codersdk.ChatErrorKindAuth, wantRetryable: false, wantStatus: 401, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New(tt.err)) require.Equal(t, tt.wantKind, classified.Kind, "Kind") require.Equal(t, tt.wantRetryable, classified.Retryable, "Retryable") require.Equal(t, tt.wantStatus, classified.StatusCode, "StatusCode") }) } } func TestClassify_StartupTimeoutWrappedClassificationWins(t *testing.T) { t.Parallel() wrapped := chaterror.WithClassification( xerrors.New("context canceled"), chaterror.ClassifiedError{ Kind: codersdk.ChatErrorKindStartupTimeout, Provider: "openai", Retryable: true, }, ) require.Equal(t, chaterror.ClassifiedError{ Message: "OpenAI did not start responding in time.", Kind: codersdk.ChatErrorKindStartupTimeout, Provider: "openai", Retryable: true, StatusCode: 0, }, chaterror.Classify(wrapped)) } func TestWithProviderUsesExplicitHint(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New("openai received status 429 from upstream")) require.Equal(t, "openai", classified.Provider) enriched := classified.WithProvider("azure openai") require.Equal(t, chaterror.ClassifiedError{ Message: "Azure OpenAI is rate limiting requests.", Kind: codersdk.ChatErrorKindRateLimit, Provider: "azure", Retryable: true, StatusCode: 429, }, enriched) } func TestWithProviderAddsProviderWhenUnknown(t *testing.T) { t.Parallel() classified := chaterror.Classify(xerrors.New("received status 429 from upstream")) require.Empty(t, classified.Provider) enriched := classified.WithProvider("openai") require.Equal(t, chaterror.ClassifiedError{ Message: "OpenAI is rate limiting requests.", Kind: codersdk.ChatErrorKindRateLimit, Provider: "openai", Retryable: true, StatusCode: 429, }, enriched) } func TestClassify_UsesStructuredProviderStatusAndRetryAfter(t *testing.T) { t.Parallel() classified := chaterror.Classify(testProviderError( "", 429, map[string]string{"Retry-After": "30"}, )) require.Equal(t, chaterror.ClassifiedError{ Message: "The AI provider is rate limiting requests.", Kind: codersdk.ChatErrorKindRateLimit, Provider: "", Retryable: true, StatusCode: 429, RetryAfter: 30 * time.Second, }, classified) } func TestClassify_PrefersRetryAfterMsOverRetryAfter(t *testing.T) { t.Parallel() classified := chaterror.Classify(testProviderError( "upstream failed", 429, map[string]string{ "Retry-After": "30", "ReTrY-AfTeR-Ms": "1500", }, )) require.Equal(t, 429, classified.StatusCode) require.Equal(t, 1500*time.Millisecond, classified.RetryAfter) } func TestClassify_ParsesRetryAfterHTTPDate(t *testing.T) { t.Parallel() // http.TimeFormat has second precision, so formatting truncates the // sub-second component (up to ~1s of loss). Round the target up to the // next whole second before formatting so the parsed deadline is never // earlier than now+offset, regardless of where now's fractional second // lands. Without this, a now with frac near 1s plus any scheduling // jitter can drive the computed RetryAfter just under offset-1s and // flake the lower bound. offset := 3 * time.Second target := time.Now().Add(offset).Truncate(time.Second).Add(time.Second) retryAt := target.UTC().Format(http.TimeFormat) classified := chaterror.Classify(testProviderError( "upstream failed", 429, map[string]string{"Retry-After": retryAt}, )) require.Equal(t, 429, classified.StatusCode) require.GreaterOrEqual(t, classified.RetryAfter, offset-time.Second) require.LessOrEqual(t, classified.RetryAfter, offset+time.Second) } func TestClassify_IgnoresInvalidRetryAfter(t *testing.T) { t.Parallel() classified := chaterror.Classify(testProviderError( "upstream failed", 429, map[string]string{"Retry-After": "definitely not a delay"}, )) require.Zero(t, classified.RetryAfter) } func TestWithProviderPreservesRetryAfter(t *testing.T) { t.Parallel() classified := chaterror.Classify(testProviderError( "", 429, map[string]string{"Retry-After": "30"}, )) enriched := classified.WithProvider("openai") require.Equal(t, 30*time.Second, enriched.RetryAfter) require.Equal(t, chaterror.ClassifiedError{ Message: "OpenAI is rate limiting requests.", Kind: codersdk.ChatErrorKindRateLimit, Provider: "openai", Retryable: true, StatusCode: 429, RetryAfter: 30 * time.Second, }, enriched) } func TestClassify_UsesStructuredProviderDetailFromResponseDump(t *testing.T) { t.Parallel() classified := chaterror.Classify(testProviderError( "", 400, nil, testProviderResponseDump(`{"error":{"type":"invalid_request_error","message":"Image exceeds 5 MB maximum."}}`), )) require.Equal(t, chaterror.ClassifiedError{ Message: "The AI provider returned an unexpected error.", Detail: "Image exceeds 5 MB maximum.", Kind: codersdk.ChatErrorKindGeneric, Provider: "", Retryable: false, StatusCode: 400, }, classified) } func TestClassify_FallsBackToProviderMessageForDetail(t *testing.T) { t.Parallel() classified := chaterror.Classify(testProviderError( " image exceeds 5 MB maximum ", 400, nil, testProviderResponseDump("not-json"), )) require.Equal(t, "image exceeds 5 MB maximum", classified.Detail) } func TestClassify_TruncatesProviderDetail(t *testing.T) { t.Parallel() detail := strings.Repeat("x", 510) classified := chaterror.Classify(testProviderError( "", 400, nil, testProviderResponseDump(`{"error":{"message":"`+detail+`"}}`), )) require.Len(t, []rune(classified.Detail), 500) require.True(t, strings.HasSuffix(classified.Detail, "…")) } func TestClassify_ChainBroken(t *testing.T) { t.Parallel() tests := []struct { name string err error wantChainBroken bool wantRetryable bool wantProvider string wantStatusCode int }{ { name: "OpenAIPreviousResponseNotFoundBareString", err: xerrors.New( "Previous response with id 'resp_abc' not found.", ), wantChainBroken: true, wantRetryable: true, wantProvider: "openai", wantStatusCode: 0, }, { name: "OpenAIPreviousResponseNotFoundProviderError", err: testProviderError( "Previous response with id 'resp_096c70c5bb8d52bc0069fa11e0630c81a3ba210cddfa75bae9' not found.", 404, nil, ), wantChainBroken: true, wantRetryable: true, wantProvider: "openai", wantStatusCode: 404, }, { name: "OpenAIPreviousResponseCaseInsensitive", err: testProviderError( "PREVIOUS RESPONSE WITH ID 'resp_abc' NOT FOUND.", 404, nil, ), wantChainBroken: true, wantRetryable: true, wantProvider: "openai", wantStatusCode: 404, }, { name: "PreviousResponseWithoutNotFoundIsNotChainBroken", err: testProviderError( "Previous response with id 'resp_abc' is invalid.", 400, nil, ), wantChainBroken: false, }, { name: "UnrelatedNotFoundIsNotChainBroken", err: testProviderError( "resource not found", 404, nil, ), wantChainBroken: false, }, { name: "UnrelatedInvalidRequestIsNotChainBroken", err: testProviderError( "", 400, nil, testProviderResponseDump(`{"error":{"type":"invalid_request_error","message":"Image exceeds 5 MB maximum."}}`), ), wantChainBroken: false, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { t.Parallel() classified := chaterror.Classify(tt.err) require.Equal(t, tt.wantChainBroken, classified.ChainBroken, "chain broken flag mismatch") if !tt.wantChainBroken { return } require.Equal(t, tt.wantRetryable, classified.Retryable, "chain-broken errors must be retryable so the loop"+ " can self-heal") require.Equal(t, tt.wantProvider, classified.Provider) require.Equal(t, tt.wantStatusCode, classified.StatusCode) require.Equal(t, codersdk.ChatErrorKindGeneric, classified.Kind, "chain-broken keeps the user-visible kind unchanged"+ " so we don't add a new codersdk surface") }) } } func TestClassify_ChainBrokenSurvivesWithClassification(t *testing.T) { t.Parallel() original := chaterror.Classify(testProviderError( "Previous response with id 'resp_abc' not found.", 404, nil, )) require.True(t, original.ChainBroken) wrapped := chaterror.WithClassification( xerrors.New("transport blew up"), original, ) round := chaterror.Classify(wrapped) require.True(t, round.ChainBroken, "WithClassification round-trips ChainBroken so the retry path"+ " can detect it after re-classification") } func testProviderError( message string, statusCode int, headers map[string]string, responseBody ...[]byte, ) error { var body []byte if len(responseBody) > 0 { body = responseBody[0] } return &fantasy.ProviderError{ Message: message, StatusCode: statusCode, ResponseHeaders: headers, ResponseBody: body, } } func testProviderResponseDump(body string) []byte { return []byte(`HTTP/1.1 400 Bad Request Content-Type: application/json ` + body) }