"""Typed failure-reason codes for bot turns and relay replies. A closed vocabulary of machine-readable reason codes carried ALONGSIDE the free-text ``error`` fields (additive — old consumers keep working). Platform-side codes are assigned by the transport/relay layer; agent-side codes are derived from raw agent/provider error text via ``classify_agent_error``. Classifier precedence is the order of ``_RULES``: auth outranks quota by design — real provider 401 bodies (e.g. Anthropic) say "invalid, blocked or out of funds". """ from __future__ import annotations import re from typing import Any # platform-side RUNTIME_OFFLINE = "runtime_offline" QUEUED_EXPIRED = "queued_expired" DELIVERY_TIMEOUT = "delivery_timeout" AGENT_BLOCKED = "agent_blocked" CANCELLED = "cancelled" # agent-side PROVIDER_AUTH_OR_ACCESS = "provider_auth_or_access" PROVIDER_QUOTA_LIMIT = "provider_quota_limit" PROVIDER_RATE_LIMIT = "provider_rate_limit" PROVIDER_SERVER_ERROR = "provider_server_error" CONTEXT_OVERFLOW = "context_overflow" MISSING_CONFIG = "missing_config" MODEL_UNAVAILABLE = "model_unavailable" # A spawn site could not resolve the target profile's secret scope: no turn ran, no provider was called. TARGET_SCOPE_UNRESOLVED = "target_scope_unresolved" UNKNOWN = "unknown" ALL_REASONS = frozenset({ RUNTIME_OFFLINE, QUEUED_EXPIRED, DELIVERY_TIMEOUT, AGENT_BLOCKED, CANCELLED, PROVIDER_AUTH_OR_ACCESS, PROVIDER_QUOTA_LIMIT, PROVIDER_RATE_LIMIT, PROVIDER_SERVER_ERROR, CONTEXT_OVERFLOW, MISSING_CONFIG, MODEL_UNAVAILABLE, TARGET_SCOPE_UNRESOLVED, UNKNOWN, }) # Not a bot-turn reason (kept out of ALL_REASONS): the runtime refusal code a Bot Chat delivery id's # settled not-sent receipt carries (``gateway/session_bot.py:_not_sent_record``). The Bot DM tool # recognises that definite no-send by it, so owner and tool share this one literal. HELD_NOT_SENT = "runtime_coordination_required" #: Reasons a supervisor may retry automatically without human intervention. AUTO_RETRYABLE = frozenset({RUNTIME_OFFLINE, DELIVERY_TIMEOUT, PROVIDER_RATE_LIMIT, PROVIDER_SERVER_ERROR}) def is_auto_retryable(reason: str) -> bool: return reason in AUTO_RETRYABLE # Retry session policy: a retried bot turn NEVER mints a fresh session. Transient # classes resume as-is; context_overflow runs context compression (the one # sanctioned context mutation) on the same session first; everything else # (auth/quota/config/model/unknown) is never auto-retried — it can't be fixed by # a retry and only burns quota. # See #93091. RETRY_RESUME = "resume" RETRY_COMPRESS_THEN_RESUME = "compress_then_resume" RETRY_NONE = "none" def retry_action(reason: str) -> str: """Map a failure reason to the bot-turn retry action (see policy above).""" if reason in AUTO_RETRYABLE: return RETRY_RESUME if reason == CONTEXT_OVERFLOW: return RETRY_COMPRESS_THEN_RESUME return RETRY_NONE _STATUS = r"(?:error code:?\s*|status(?:\s*code)?:?\s*|http\s*)" # Ordered (pattern, code) — first match wins. _RULES: tuple[tuple[re.Pattern[str], str], ...] = tuple( (re.compile(pat, re.IGNORECASE), code) for pat, code in ( # FIRST: the copy says "API key" and "restart", so it must be claimed before the auth rules. # ``UnscopedSecretError`` names the secret when it has one ("this profile's OPENROUTER_API_KEY"); # the ``served_profile_child_env`` detail rides in tracebacks. (r"could not read this profile's [^(]+\(an internal profile-scoping bug" r"|served_profile_child_env\(inherit_credentials=true\)", TARGET_SCOPE_UNRESOLVED), (rf"authentication_error|invalid api key|{_STATUS}(?:401|403)\b", PROVIDER_AUTH_OR_ACCESS), (rf"{_STATUS}402\b|out of funds|quota|balance", PROVIDER_QUOTA_LIMIT), (rf"{_STATUS}429\b|rate.?limit", PROVIDER_RATE_LIMIT), # ``server[ _]?error`` / ``overloaded_error`` are the providers' own JSON spellings of the # agent's typed ``server_error`` / ``overloaded`` verdicts (FailoverReason), which the # in-process lanes classify from ``failure_reason`` rather than a status number. (rf"{_STATUS}5\d{{2}}\b|server[ _]?error|overloaded", PROVIDER_SERVER_ERROR), (r"context length|context_overflow|maximum context", CONTEXT_OVERFLOW), (r"no llm provider configured|missing config|no access token", MISSING_CONFIG), (r"model .*(not found|does not exist)|model_not_found", MODEL_UNAVAILABLE), ) ) def turn_failure_text(stdout: str | None, stderr: str | None) -> str: """The error text of a failed ``hermes … -Q`` delivery turn: both streams, in the order the CLI writes them. The provider prose is the turn's final_response and lands on STDOUT; stderr carries session bookkeeping (``session_id: …``) on every run, so ``stderr or stdout`` only ever saw the banner and every transient failure classified as ``unknown``. The in-process lanes hand over the same two pieces of prose as an agent result dict (``error`` + ``failure_reason``); ``result_retry_action`` joins them here too, so one classifier sees every lane's failure text.""" return "\n".join(text.strip() for text in (stdout, stderr) if text and text.strip()) def result_retry_action(result: Any) -> str: """The retry action for a finished IN-PROCESS turn (an ``_run_agent`` result dict). The transport-agnostic twin of the child-process lanes' ``retry_action(classify_agent_error( turn_failure_text(stdout, stderr)))``: same policy, the failure text just arrives as result fields instead of two streams — ``error`` carries the raw provider summary (status codes included) and ``failure_reason`` the turn loop's own typed verdict, which is what names an overflow the copy only describes in prose. ``RETRY_NONE`` for anything that did not fail (and for a non-dict result), so a successful turn whose text happens to mention 429 is never re-run.""" if not isinstance(result, dict) or not result.get("failed"): return RETRY_NONE return retry_action(classify_agent_error( turn_failure_text(result.get("error"), result.get("failure_reason")))) def classify_agent_error(text: str) -> str: """Map raw agent/provider error text to a closed reason code (``unknown`` when unmatched/empty).""" raw = str(text or "") if raw.strip(): for pattern, code in _RULES: if pattern.search(raw): return code return UNKNOWN def delivery_failure_reason(error: BaseException) -> str: """The typed reason for a delivery refusal, kept inside the documented vocabulary. An exception's own ``reason`` is trusted only when it names a real code: ``TurnBusyError`` carries ``target_busy``, but ``reason`` is also a stdlib attribute on ``ssl.SSLError`` and ``urllib.error.URLError``, and forwarding one of those would put free text where consumers expect a closed set. Anything else is classified like every other failure. Shared by the relay lane (``bot_relay.deliver``) and the local runner (``bot_mode_dm --run-delivery``). """ # 'target_busy' extends the structured refusal enum and predates ALL_REASONS. supplied = str(getattr(error, "reason", "") or "").strip() if supplied == "target_busy" or supplied in ALL_REASONS: return supplied return classify_agent_error(str(error))