Module: Rubino::LLM::ErrorClassifier
- Defined in:
- lib/rubino/llm/error_classifier.rb
Overview
Centralized API-error classifier — the single source of truth for “is this error worth a retry?”, replacing the adapter’s boolean transient_error?. Port of the reference classify_api_error, reduced to the structural signals ruby_llm actually surfaces: a typed error class and the wrapped HTTP status. We do NOT port the giant message-pattern tables (billing/rate-limit/context phrase lists) — ruby_llm raises typed classes, so status + class carry the same information without the brittle matching. The one message-based branch kept is the MiniMax “unknown error” (code 999/1000) blip, which arrives statusless and must stay in the retryable ‘unknown` bucket.
Constant Summary collapse
- STREAM_DROP_ERRORS =
Transport-level drops that surface mid-request and never reach an HTTP status — always retryable. faraday-net_http re-raises IOError/EOFError (and friends) as Faraday::ConnectionFailed, the type we actually see for an upstream socket close; the rest are defensive.
[ Faraday::ConnectionFailed, Faraday::TimeoutError, Net::OpenTimeout, Net::ReadTimeout, EOFError, IOError, Errno::ECONNRESET, Errno::EPIPE ].freeze
- RETRYABLE_HTTP =
ruby_llm 1.15 raises a typed error per HTTP status. Map the classes we can name directly; everything else falls through to status-based then unknown classification.
->(status) { status && (status >= 500 || status == 429) }.freeze
- UNKNOWN_PROVIDER_ERROR_PATTERNS =
Body/message fragments identifying a transient provider “unknown error” (MiniMax api_error 999/1000 on the Anthropic-compatible endpoint). Kept narrow and provider-blip-specific. Moved here from the adapter so the classifier is the single source of truth (folds Slice 0(b)).
[ "unknown error", "api_error 999", "api_error 1000", "\"code\":999", "\"code\": 999", "\"code\":1000", "\"code\": 1000", "code 999", "code 1000" ].freeze
- TRANSIENT_TRANSPORT_PATTERNS =
Last-resort transport-drop phrases for statusless errors that never surfaced as a typed transport class.
[ "timeout", "timed out", "connection reset", "connection refused", "broken pipe", "end of file reached" ].freeze
- LOCAL_PROGRAMMING_ERRORS =
Local Ruby PROGRAMMING errors — unambiguous bugs in our own code (or a caller’s), not provider/API blips. These must NEVER be retried: a retry storm would mask the bug behind backoff (the very thing that turned a mid-turn ‘NoMethodError` from the UI into three `llm.retry` warnings). They reach `classify` only because ModelCallRunner rescues StandardError broadly around the boundary call; the reference classify_api_error never sees them because it only ever runs at the API layer. So we short-circuit them to NON-retryable (reason stays :unknown) BEFORE the unknown→retryable fallback, surfacing the bug immediately. The set is curated by CLASS, not message: every entry is a clear local bug. RuntimeError is deliberately EXCLUDED — it is too generic (ruby_llm/providers raise it for transient conditions), so it stays on the message-based path and keeps its provider-blip retryability.
[ NoMethodError, NameError, NoMatchingPatternError, NoMatchingPatternKeyError, ArgumentError, TypeError, NotImplementedError, FrozenError, LocalJumpError, ThreadError, FiberError ].freeze
- MISSING_CREDENTIAL_PATTERNS =
A missing / unconfigured credential — raised BEFORE any HTTP call, so it carries no status and would otherwise fall through to the unknown→retryable default and trigger an ~80s retry storm that exits empty (#93). ruby_llm raises RubyLLM::ConfigurationError (“Missing configuration for OpenRouter: openrouter_api_key”) when a provider’s key is unset; our own adapter raises Rubino::Error (“Missing API key for provider …”). A missing key is a credential problem the user must fix — classify it as a NON-retryable AUTH error so the runner surfaces it immediately.
[ "missing configuration for", "missing api key", "no api key", "api key is not set", "_api_key" ].freeze
- INVALID_CREDENTIAL_PATTERNS =
A PRESENT but INVALID credential rejected by the provider via a statusless / untyped error body (MiniMax’s Anthropic-compatible endpoint says “login fail” with no 401), which used to fall through to the unknown→retryable default and burn ~60-90s of silent retries on a deterministic auth failure (#126). Same deal as a typed 401/403: NON-retryable AUTH, surfaced immediately. Patterns are the literal provider phrasings, kept narrow.
[ "login fail", "invalid api key", "incorrect api key", "invalid x-api-key", "authentication_error", "authentication failed" ].freeze
- DNS_FAILURE_PATTERNS =
An UNRESOLVABLE host is a PERMANENT misconfiguration, not a transient transport blip: every retry re-runs the same DNS lookup and fails identically, so retrying burns the whole budget (~81s) on a typo’d base_url (#361a). faraday-net_http wraps the underlying SocketError (“getaddrinfo: Name or service not known” / “nodename nor servname provided” / “Temporary failure in name resolution”) in a Faraday::ConnectionFailed, so we match on the literal resolver phrasings rather than the wrapper class. Kept narrow so a genuine connection reset/refused (transient) still retries via classify_transport below.
[ "getaddrinfo", "name or service not known", "nodename nor servname provided", "temporary failure in name resolution", "no address associated with hostname", "failure in name resolution" ].freeze
- INVALID_MEDIA_PATTERNS =
Provider media/image validation rejections — a PERMANENT 4xx-class complaint about the attachment itself, which some providers (MiniMax Anthropic-compat) surface statusless so it used to fall through to the unknown→retryable default and burn the whole retry budget (~80s) on a bad image (#98). The same attachment fails identically on every retry, so fail fast. Patterns are the literal provider phrasings, kept narrow.
[ "media exceeds size limit", "invalid image content", "image: unknown format", "could not process image" ].freeze
- INVALID_PARAMS_PATTERNS =
A deterministic request-VALIDATION rejection (a 4xx “invalid params” / “invalid request” / unprocessable body) that some providers surface STATUSLESS, so it used to fall through to the unknown→retryable default and burn the full api_max_retries:5 backoff (~85s) on a request that fails identically every time (#327). The same body is rejected on every retry, so fail fast. Kept narrow (literal provider phrasings) and ordered AFTER the media check so an image rejection keeps its own reason. The context-overflow phrases are deliberately excluded — those are handled by the compress-not-fail path above.
[ "invalid params", "invalid parameter", "invalid request", "unprocessable entity", "validation error", "invalid_request_error" ].freeze
- CONTEXT_OVERFLOW_PATTERNS =
[ "context length", "context window", "maximum context", "token limit", "too many tokens", "prompt is too long", "max_tokens" ].freeze
- MODEL_NOT_FOUND_PATTERNS =
[ "is not a valid model", "invalid model", "model not found", "model_not_found", "does not exist", "no such model", "unknown model" ].freeze
Class Method Summary collapse
-
.classify(error) ⇒ Object
Classify an error into a ClassifiedError with reason + recovery hints.
-
.classify_by_status(status, error) ⇒ Object
HTTP status classification with message-aware refinement, mirroring _classify_by_status (error_classifier.py:725) for the CORE reasons.
- .classify_invalid_credential(error) ⇒ Object
- .classify_invalid_media(error) ⇒ Object
- .classify_invalid_params(error) ⇒ Object
- .classify_missing_credential(error) ⇒ Object
-
.classify_statusless(error) ⇒ Object
No decisive status: the MiniMax “unknown error” blip and bare transport drops.
-
.classify_transport(error) ⇒ Object
Transport drops (Faraday::ConnectionFailed for the MiniMax EOF, read/ connect timeouts, …) are retryable regardless of message — they never reach an HTTP status.
-
.classify_typed(error) ⇒ Object
Typed ruby_llm errors we can name without a status lookup.
- .classify_unresolvable_host(error) ⇒ Object
- .context_overflow?(error) ⇒ Boolean
-
.http_status(error) ⇒ Object
HTTP status from a typed RubyLLM::Error’s wrapped Faraday response, or nil.
- .local_programming_error?(error) ⇒ Boolean
- .model_not_found?(error) ⇒ Boolean
-
.result_for(reason, status, error, retryable:, should_compress: false, should_rotate_credential: false, should_fallback: false) ⇒ Object
── helpers ──────────────────────────────────────────────────────────.
-
.retryable?(error) ⇒ Boolean
Convenience: just the boolean the adapter’s retry loop needs.
Class Method Details
.classify(error) ⇒ Object
Classify an error into a ClassifiedError with reason + recovery hints. Priority mirrors the reference pipeline: typed/transport class → HTTP status →statusless provider-unknown / transport → unknown (retryable default).
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/rubino/llm/error_classifier.rb', line 124 def classify(error) status = http_status(error) result = classify_missing_credential(error) || classify_invalid_credential(error) || classify_unresolvable_host(error) || classify_transport(error) || classify_invalid_media(error) || classify_invalid_params(error) || classify_typed(error) || (status && classify_by_status(status, error)) || classify_statusless(error) return result if result # A genuine local Ruby bug (NoMethodError, ArgumentError, …) is NOT a # retryable provider blip — propagate it immediately instead of letting # the unknown→retryable default mask it behind a backoff storm. return result_for(FailoverReason::UNKNOWN, status, error, retryable: false) if local_programming_error?(error) result_for(FailoverReason::UNKNOWN, status, error, retryable: true) end |
.classify_by_status(status, error) ⇒ Object
HTTP status classification with message-aware refinement, mirroring _classify_by_status (error_classifier.py:725) for the CORE reasons.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/rubino/llm/error_classifier.rb', line 335 def classify_by_status(status, error) case status when 401, 403 result_for(FailoverReason::AUTH, status, error, retryable: false, should_rotate_credential: true, should_fallback: true) when 402 result_for(FailoverReason::BILLING, status, error, retryable: false, should_rotate_credential: true, should_fallback: true) when 404 # Generic 404 with no "model not found" signal is treated as unknown # (retryable) per the reference: a misconfigured # endpoint or proxy glitch shouldn't masquerade as a missing model. if model_not_found?(error) result_for(FailoverReason::MODEL_NOT_FOUND, status, error, retryable: false, should_fallback: true) else result_for(FailoverReason::UNKNOWN, status, error, retryable: true) end when 429 result_for(FailoverReason::RATE_LIMIT, status, error, retryable: true, should_rotate_credential: true, should_fallback: true) when 503, 529 result_for(FailoverReason::OVERLOADED, status, error, retryable: true) when 400 if context_overflow?(error) result_for(FailoverReason::CONTEXT_OVERFLOW, status, error, retryable: false, should_compress: true) elsif model_not_found?(error) result_for(FailoverReason::MODEL_NOT_FOUND, status, error, retryable: false, should_fallback: true) else result_for(FailoverReason::FORMAT_ERROR, status, error, retryable: false, should_fallback: true) end else if status >= 500 result_for(FailoverReason::SERVER_ERROR, status, error, retryable: true) elsif status >= 400 result_for(FailoverReason::FORMAT_ERROR, status, error, retryable: false, should_fallback: true) end end end |
.classify_invalid_credential(error) ⇒ Object
195 196 197 198 199 200 201 |
# File 'lib/rubino/llm/error_classifier.rb', line 195 def classify_invalid_credential(error) msg = error..to_s.downcase return unless INVALID_CREDENTIAL_PATTERNS.any? { |p| msg.include?(p) } result_for(FailoverReason::AUTH, http_status(error), error, retryable: false, should_rotate_credential: true, should_fallback: true) end |
.classify_invalid_media(error) ⇒ Object
253 254 255 256 257 258 259 |
# File 'lib/rubino/llm/error_classifier.rb', line 253 def classify_invalid_media(error) msg = error..to_s.downcase return unless INVALID_MEDIA_PATTERNS.any? { |p| msg.include?(p) } result_for(FailoverReason::FORMAT_ERROR, http_status(error), error, retryable: false, should_fallback: true) end |
.classify_invalid_params(error) ⇒ Object
279 280 281 282 283 284 285 286 287 |
# File 'lib/rubino/llm/error_classifier.rb', line 279 def classify_invalid_params(error) return if context_overflow?(error) msg = error..to_s.downcase return unless INVALID_PARAMS_PATTERNS.any? { |p| msg.include?(p) } result_for(FailoverReason::FORMAT_ERROR, http_status(error), error, retryable: false, should_fallback: true) end |
.classify_missing_credential(error) ⇒ Object
169 170 171 172 173 174 175 176 177 |
# File 'lib/rubino/llm/error_classifier.rb', line 169 def classify_missing_credential(error) is_config_error = defined?(RubyLLM::ConfigurationError) && error.is_a?(RubyLLM::ConfigurationError) msg = error..to_s.downcase return unless is_config_error || MISSING_CREDENTIAL_PATTERNS.any? { |p| msg.include?(p) } result_for(FailoverReason::AUTH, http_status(error), error, retryable: false, should_rotate_credential: true, should_fallback: true) end |
.classify_statusless(error) ⇒ Object
No decisive status: the MiniMax “unknown error” blip and bare transport drops. A permanent 4xx never reaches here (returned above), so the provider-unknown net stays narrow — mirrors the reference unknown→retryable.
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/rubino/llm/error_classifier.rb', line 382 def classify_statusless(error) msg = error..to_s.downcase if UNKNOWN_PROVIDER_ERROR_PATTERNS.any? { |p| msg.include?(p) } return result_for(FailoverReason::UNKNOWN, nil, error, retryable: true) end if TRANSIENT_TRANSPORT_PATTERNS.any? { |p| msg.include?(p) } return result_for(FailoverReason::TIMEOUT, nil, error, retryable: true) end # A statusless "unknown model" / "invalid model" (some providers, or # ruby_llm's pre-flight, report it as an untyped error rather than a # ModelNotFoundError) is a deterministic config error — fail fast instead # of the unknown→retryable backoff storm (#417). if model_not_found?(error) return result_for(FailoverReason::MODEL_NOT_FOUND, nil, error, retryable: false, should_fallback: true) end nil end |
.classify_transport(error) ⇒ Object
Transport drops (Faraday::ConnectionFailed for the MiniMax EOF, read/ connect timeouts, …) are retryable regardless of message — they never reach an HTTP status. STREAM_DROP_ERRORS lives on the adapter. An unresolvable host is caught BEFORE this (in #classify) so a permanent DNS failure does not get swept into the retryable timeout bucket.
234 235 236 237 238 |
# File 'lib/rubino/llm/error_classifier.rb', line 234 def classify_transport(error) return unless STREAM_DROP_ERRORS.any? { |klass| error.is_a?(klass) } result_for(FailoverReason::TIMEOUT, nil, error, retryable: true) end |
.classify_typed(error) ⇒ Object
Typed ruby_llm errors we can name without a status lookup.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/rubino/llm/error_classifier.rb', line 290 def classify_typed(error) # A permanent context-overflow can arrive DISGUISED as a 5xx: MiniMax # wraps the "context window exceeds limit" 400 in a RubyLLM::ServerError, # which the blanket ServerError/OverloadedError branches below would # blindly mark retryable -> a 5x retry storm (~133s) on a request that # fails identically every time (#356). Run the message-based overflow # check FIRST so an overflow masquerading as 5xx routes to # compress-not-retry, regardless of the wrapping error class. if context_overflow?(error) return result_for(FailoverReason::CONTEXT_OVERFLOW, http_status(error), error, retryable: false, should_compress: true) end case error when RubyLLM::ContextLengthExceededError result_for(FailoverReason::CONTEXT_OVERFLOW, http_status(error), error, retryable: false, should_compress: true) when RubyLLM::ModelNotFoundError # A deterministic CONFIG error: ruby_llm raises ModelNotFoundError # ("Unknown model: ...") BEFORE any HTTP call when the configured model # id isn't registered — statusless, so it used to fall through to the # unknown→retryable default and burn the full api_max_retries backoff # (~73s) on a request that can NEVER succeed (#417). The model id is # fixed for the run, so every retry re-fails identically: fail fast as a # non-retryable config error with the actionable message. result_for(FailoverReason::MODEL_NOT_FOUND, http_status(error), error, retryable: false, should_fallback: true) when RubyLLM::UnauthorizedError, RubyLLM::ForbiddenError result_for(FailoverReason::AUTH, http_status(error), error, retryable: false, should_rotate_credential: true, should_fallback: true) when RubyLLM::PaymentRequiredError result_for(FailoverReason::BILLING, http_status(error), error, retryable: false, should_rotate_credential: true, should_fallback: true) when RubyLLM::RateLimitError result_for(FailoverReason::RATE_LIMIT, http_status(error) || 429, error, retryable: true, should_rotate_credential: true, should_fallback: true) when RubyLLM::OverloadedError, RubyLLM::ServiceUnavailableError result_for(FailoverReason::OVERLOADED, http_status(error), error, retryable: true) when RubyLLM::ServerError result_for(FailoverReason::SERVER_ERROR, http_status(error), error, retryable: true) end end |
.classify_unresolvable_host(error) ⇒ Object
221 222 223 224 225 226 227 |
# File 'lib/rubino/llm/error_classifier.rb', line 221 def classify_unresolvable_host(error) msg = error..to_s.downcase return unless DNS_FAILURE_PATTERNS.any? { |p| msg.include?(p) } result_for(FailoverReason::FORMAT_ERROR, nil, error, retryable: false, should_fallback: true) end |
.context_overflow?(error) ⇒ Boolean
435 436 437 438 439 440 |
# File 'lib/rubino/llm/error_classifier.rb', line 435 def context_overflow?(error) return true if error.is_a?(RubyLLM::ContextLengthExceededError) msg = error..to_s.downcase CONTEXT_OVERFLOW_PATTERNS.any? { |p| msg.include?(p) } end |
.http_status(error) ⇒ Object
HTTP status from a typed RubyLLM::Error’s wrapped Faraday response, or nil.
418 419 420 421 422 423 |
# File 'lib/rubino/llm/error_classifier.rb', line 418 def http_status(error) return unless error.respond_to?(:response) && error.response.respond_to?(:status) status = error.response.status status if status.is_a?(Integer) end |
.local_programming_error?(error) ⇒ Boolean
447 448 449 |
# File 'lib/rubino/llm/error_classifier.rb', line 447 def local_programming_error?(error) LOCAL_PROGRAMMING_ERRORS.any? { |klass| error.is_a?(klass) } end |
.model_not_found?(error) ⇒ Boolean
442 443 444 445 |
# File 'lib/rubino/llm/error_classifier.rb', line 442 def model_not_found?(error) msg = error..to_s.downcase MODEL_NOT_FOUND_PATTERNS.any? { |p| msg.include?(p) } end |
.result_for(reason, status, error, retryable:, should_compress: false, should_rotate_credential: false, should_fallback: false) ⇒ Object
── helpers ──────────────────────────────────────────────────────────
404 405 406 407 408 409 410 411 412 413 414 415 |
# File 'lib/rubino/llm/error_classifier.rb', line 404 def result_for(reason, status, error, retryable:, should_compress: false, should_rotate_credential: false, should_fallback: false) ClassifiedError.new( reason: reason, status_code: status, message: error.respond_to?(:message) ? error..to_s[0, 500] : error.to_s[0, 500], retryable: retryable, should_compress: should_compress, should_rotate_credential: should_rotate_credential, should_fallback: should_fallback ) end |
.retryable?(error) ⇒ Boolean
Convenience: just the boolean the adapter’s retry loop needs.
147 148 149 |
# File 'lib/rubino/llm/error_classifier.rb', line 147 def retryable?(error) classify(error).retryable end |