Skip to content

✨ feat(agent-runtime): persist ERROR_CODE_SPECS classification on operation errors#15273

Merged
arvinxx merged 2 commits into
canaryfrom
arvinxu/feat/operation-error-classification
May 27, 2026
Merged

✨ feat(agent-runtime): persist ERROR_CODE_SPECS classification on operation errors#15273
arvinxx merged 2 commits into
canaryfrom
arvinxu/feat/operation-error-classification

Conversation

@arvinxx

@arvinxx arvinxx commented May 27, 2026

Copy link
Copy Markdown
Member

πŸ’» Change Type

  • ✨ feat
  • βœ… test

πŸ”— Related Issue

Follow-up to #15262, which introduced ERROR_CODE_SPECS but only consumed it internally (HTTP status mapping + retry decisions). This PR makes the classification a first-class field on every persisted operation error.

πŸ”€ Description of Change

When an agent operation fails, the catch block in AgentRuntimeService.executeStep normalizes the thrown value into a ChatMessageError and writes it to three sinks:

  • agent_operations.error JSONB (via agentOperationModel.recordCompletion)
  • S3 trace snapshot (via OperationTraceRecorder.finalize)
  • Agent-gateway WS push (via GatewayStreamNotifier.publishAgentRuntimeEnd, which forwards finalState.error verbatim)

Today the persisted shape is just { message, type, body }. Downstream consumers (DC observability dashboards, agent-gateway error triage, support tooling) that want to know whether an error is user-attributable, what category it belongs to, and whether it counts as a failure have to re-derive that themselves β€” typically by maintaining a parallel mirror of ERROR_CODE_SPECS.

This PR does the lookup once, at the chokepoint:

  • packages/types/src/message/common/base.ts β€” ChatMessageError gains optional attribution / category / severity / httpStatus / retryable / countAsFailure / numericId fields plus exported ChatMessageErrorAttribution and ChatMessageErrorSeverity literal types. Zod schema mirrored.
  • src/server/modules/AgentRuntime/formatErrorForState.ts (new) β€” extracted from AgentRuntimeService.ts and wraps the existing normalization with an enrichWithSpec step that merges getErrorCodeSpec(formatted.type) onto the result. Codes outside the spec table (e.g. raw InternalServerError) pass through unchanged.
  • src/server/services/agentRuntime/AgentRuntimeService.ts β€” imports the extracted helper; the error finalize call to traceRecorder.finalize forwards the classification fields so the S3 snapshot carries them too.
  • src/server/services/agentRuntime/OperationTraceRecorder.ts β€” FinalizeParams.error widened to accept the classification fields.

The agent-gateway notifier needs no changes β€” it forwards finalState.error as-is, so the new fields ride along automatically.

πŸ§ͺ How to Test

  • Tested locally
  • Added/updated tests

```bash
bun run type-check # passes
bunx vitest run src/server/modules/AgentRuntime/formatErrorForState.test.ts # 7 new cases
bunx vitest run src/server/services/agentRuntime/AgentRuntimeService.test.ts # 60 existing pass
bunx vitest run src/server/modules/AgentRuntime/tests/formatErrorEventData.test.ts \
src/server/modules/AgentRuntime/tests/llmErrorClassification.test.ts # 41 pass
```

New test cases cover:

  • Normalization for all three input shapes (ChatCompletionErrorPayload / standard Error / unknown).
  • Spec enrichment attaches the expected fields for InsufficientQuota (user / quota / non-retryable / not-a-failure) and RateLimitExceeded (provider / capacity / retryable).
  • The QuotaLimitReached β†’ RateLimitExceeded alias is resolved through to the canonical spec.
  • Codes outside the spec table leave every classification field undefined.

πŸ“Έ Screenshots / Videos

N/A (no UI changes)

πŸ“ Additional Information

Backward-compatible. All new fields on ChatMessageError are optional; the Zod schema additions are also optional. Old persisted error rows in agent_operations.error simply lack the new keys.

Forward path. Once this lands, DC's operation tracing can render attribution / severity / category badges directly from agent_operations.error without maintaining a spec mirror. Agent-gateway already imports isUserSideError from its own mirror; this PR doesn't touch that path.

πŸ€– Generated with Claude Code

…ration errors

Look up the runtime error's spec in `ERROR_CODE_SPECS` at the single catch
chokepoint and merge `attribution` / `category` / `severity` / `httpStatus`
/ `retryable` / `countAsFailure` / `numericId` onto the normalized
`ChatMessageError`. The enriched object flows through to all three
downstream sinks β€” `agent_operations.error` JSONB, S3 trace snapshot,
and the agent-gateway WS push β€” without each consumer having to re-run
pattern matching.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@vercel

vercel Bot commented May 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lobehub Ready Ready Preview, Comment May 27, 2026 6:06pm

Request Review

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. feature:agent Assistant/Agent configuration and behavior labels May 27, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've reviewed this pull request using the Sourcery rules engine

@arvinxx arvinxx changed the title ✨ feat(agent-runtime): persist ERROR_CODE_SPECS classification on operation errors ✨ feat(agent-runtime): persist ERROR_CODE_SPECS classification on operation errors May 27, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ’‘ Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e2615f07f5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with πŸ‘.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/server/services/agentRuntime/AgentRuntimeService.ts
@codecov

codecov Bot commented May 27, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 97.43590% with 2 lines in your changes missing coverage. Please review.
βœ… Project coverage is 70.96%. Comparing base (c4b1475) to head (56118e0).
⚠️ Report is 1 commits behind head on canary.

Additional details and impacted files
@@           Coverage Diff            @@
##           canary   #15273    +/-   ##
========================================
  Coverage   70.95%   70.96%            
========================================
  Files        3160     3161     +1     
  Lines      317287   317334    +47     
  Branches    34491    33581   -910     
========================================
+ Hits       225127   225181    +54     
+ Misses      91991    91984     -7     
  Partials      169      169            
Flag Coverage Ξ”
app 61.72% <97.18%> (+0.01%) ⬆️
database 92.22% <ΓΈ> (ΓΈ)
packages/agent-runtime 80.48% <ΓΈ> (ΓΈ)
packages/builtin-tool-lobe-agent 19.87% <ΓΈ> (ΓΈ)
packages/context-engine 84.13% <ΓΈ> (ΓΈ)
packages/conversation-flow 91.28% <ΓΈ> (ΓΈ)
packages/file-loaders 87.89% <ΓΈ> (ΓΈ)
packages/memory-user-memory 74.99% <ΓΈ> (ΓΈ)
packages/model-bank 99.99% <ΓΈ> (ΓΈ)
packages/model-runtime 84.55% <ΓΈ> (ΓΈ)
packages/prompts 72.67% <ΓΈ> (ΓΈ)
packages/python-interpreter 92.90% <ΓΈ> (ΓΈ)
packages/ssrf-safe-fetch 0.00% <ΓΈ> (ΓΈ)
packages/types 35.64% <100.00%> (+0.25%) ⬆️
packages/utils 88.47% <ΓΈ> (ΓΈ)
packages/web-crawler 88.08% <ΓΈ> (ΓΈ)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Ξ”
Store 67.71% <ΓΈ> (ΓΈ)
Services 54.64% <ΓΈ> (ΓΈ)
Server 72.26% <97.18%> (+0.02%) ⬆️
Libs 56.97% <ΓΈ> (ΓΈ)
Utils 85.94% <ΓΈ> (ΓΈ)
πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • πŸ“¦ JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Model-runtime failures caught inside `runtime.step()` resolve normally with
`newState.status = 'error'` instead of throwing, so the prior commit's outer
`executeStep` catch never sees common provider errors like
`InvalidProviderAPIKey` / `InsufficientQuota`. Those were reaching
`agent_operations.error` JSONB and the success-path trace snapshot raw β€”
without `attribution` / `category` / `severity` / …

Run `formatErrorForState` on `stepResult.newState.error` immediately after
`runtime.step()` returns, before the state is saved to Redis, hooks are
dispatched, or the trace is finalized. Made the helper idempotent (recognizes
already-normalized `ChatMessageError` shape) so a second pass through the
outer catch can't collapse it back to `AgentRuntimeError`. Success-path
`traceRecorder.finalize` now forwards the classification fields too.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@arvinxx

arvinxx commented May 27, 2026

Copy link
Copy Markdown
Member Author

Good catch β€” fixed in 56118e0. The inner runtime.step() catch resolves with newState.status = 'error' instead of throwing, so the outer executeStep catch never sees InvalidProviderAPIKey / InsufficientQuota etc. Those were reaching agent_operations.error JSONB and the success-path trace snapshot raw.

Now:

  • stepResult.newState.error runs through formatErrorForState immediately after runtime.step() returns, before saveStepResult / publishStreamEvent / dispatchHooks β†’ persistCompletion / traceRecorder.finalize.
  • formatErrorForState is now idempotent β€” it recognizes an already-normalized ChatMessageError (type present, no errorType) and re-enriches in place. Without this, the outer catch running over state.error a second time would collapse it to AgentRuntimeError.
  • The success-path traceRecorder.finalize call (around line 960) now forwards attribution / category / severity / httpStatus / retryable / countAsFailure / numericId from newState.error, matching the outer-catch finalize.

Tests: 69 pass (61 existing AgentRuntimeService + 8 in formatErrorForState.test.ts including the new idempotency + partial-input cases). bun run type-check clean.

@arvinxx arvinxx merged commit 8c0e66b into canary May 27, 2026
35 checks passed
@arvinxx arvinxx deleted the arvinxu/feat/operation-error-classification branch May 27, 2026 18:25
arvinxx added a commit that referenced this pull request May 29, 2026
# πŸš€ LobeHub Release (20260528)

**Release Date:** May 28, 2026  
**Since v2.2.0:** 220 merged PRs Β· 15 contributors

> This cycle brings heterogeneous "platform agents" you can dispatch to
local or remote devices, a rebuilt onboarding flow, document-centric
chat, and a unified model-runtime error model β€” with new DeepSeek V4 and
Gemini 3.5 Flash support along the way.

---

## ✨ Highlights

- **More Hetero Agents (OpenClaw / Hermes)** β€” Create heterogeneous
agents and dispatch them to local or remote devices through the device
gateway, with an execution-target switcher in the composer and
persistent CLI sessions. (#15065, #15179, #15022)
- **iMessage on Desktop** β€” New iMessage setup and bridge on desktop,
plus bot attachments across every platform. (#15228, #15227, #15029)
- **Skills in the Composer** β€” Drag skill chips into chat, trigger
installed skills from the slash menu mid-line, and surface project-level
skills in the homogeneous agent runtime. (#15095, #15061, #15110)
- **New Models** β€” DeepSeek V4 Flash/Pro and Gemini 3.5 Flash across
providers, with thinking params for structured output and chat cost
estimates. (#15031, #15001, #15051, #14876)
- **Agent Runtime Observability** β€” OpenTelemetry GenAI semantic
conventions plus per-call generation tracing. (#15123, #15124)

---

## πŸ€– Agents & Heterogeneous Runtime

- **Platform agent creation** β€” OpenClaw/Hermes creation UI, device
guard, and remote dispatch backend. (#15065)
- **Execution-target switcher** β€” Pick local vs remote execution
directly in the composer; device-selection UX with actionable guidance.
(#15179, #15111)
- **CLI hetero dispatch** β€” OpenClaw/Hermes dispatch with persistent
sessions and a notify protocol. (#15022)
- **Gateway snapshot as source of truth** β€” Consume the gateway
`uiMessages` snapshot at step boundaries to keep chat state consistent.
(#15153, #15152)
- **Client sub-agent as a normal tool call** β€” Simplifies the sub-agent
execution path. (#15281)
- **Hermes agent chain** β€” Implements the Hermes agent chain logic.
(#15189)
- **Device registry** β€” TRPC endpoints to register, list, update, and
remove devices. (#15299)
- **Desktop device routing** β€” Route gateway agent runs through `lh
hetero exec`; restore `userId` in gateway dispatch and gate local-system
by execution target. (#15132, #15232)
- **Agent signals** β€” Anchor agent-signal receipts to messages and
isolate memory-agent messages into a child thread. (#14969, #14921)

---

## πŸš€ Onboarding

- **Simplified first screen** β€” Defer topic creation to first send.
(#15090)
- **Market Agent Picker** β€” Added as a classic onboarding step, with
template prefetch. (#14980, #15041)
- **Welcome guidance** β€” Show agent welcome guidance on first run.
(#15098)
- **Mobile** β€” Adapt agent onboarding UI and restore Classic-step
padding on mobile. (#15019, #15032)
- **Discovery** β€” Streamline discovery to a single profession question.
(#14987)
- **Analytics** β€” Track onboarding step events and create-agent modal
source. (#15133, #15028)

---

## πŸ“„ Documents, Pages & Knowledge

- **Thread chat in preview** β€” Embed thread chat in the document preview
portal. (#15216)
- **Non-markdown rendering** β€” Render non-markdown docs as a read-only
highlight. (#15272)
- **Multi-select** β€” Multi-select delete in the document tree. (#15125)
- **Page-agent streaming** β€” Preview `initPage` streaming arguments.
(#15039)
- **Per-agent topics** β€” Per-agent topic management page. (#15207)
- **Server-side category** β€” Derive document category server-side and
drop frontend predicates. (#15076)

---

## 🧩 Skills & Tools

- **Drag skill chips** β€” Drag skills into chat input and register
agent-document skills. (#15095)
- **Slash menu** β€” Installed skills appear in the slash menu with a
mid-line trigger. (#15061)
- **Project skills** β€” Recognize project-level skills in the homogeneous
agent runtime and surface them regardless of active device. (#15110,
#15177)
- **VFS archiving** β€” Archive oversized tool results to VFS instead of
truncating. (#15074)
- **@localfile mentions** β€” Drag folders into chat input as `@localFile`
mentions on desktop. (#15071)

---

## 🧠 Model Runtime & Providers

- **Error spec registry** β€” Unify error codes into a spec + pattern
registry, split `ProviderBizError` into finer codes, classify Cloud-only
codes via a tier digit, and add `DatabasePersistError`. (#15262, #15286,
#15278, #15279)
- **New models** β€” DeepSeek V4 Flash/Pro (opencode-go) and Gemini 3.5
Flash; DeepSeek V4 Pro on SiliconCloud. (#15031, #15001, #15017, #15267)
- **Structured output** β€” Thinking params for structured output, Bedrock
structured generation, and DeepSeek `generateObject` tool choice.
(#15051, #15174, #15054)
- **Cost** β€” Chat cost estimate support; preserve usage cost in custom
streams. (#14876, #15218)

---

## πŸ’¬ Chat & User Experience

- **Follow-up chips** β€” Extend follow-up chip suggestions to general
chat with scene-specific model config. (#15101, #14797)
- **Input drafts** β€” Persist unsent input drafts across tab switches and
prevent repeated draft restore. (#14992, #15024)
- **Command menu** β€” Order topic/message search by recency and promote
inline type filters. (#15094, #14986)
- **Zoom HUD** β€” Show a zoom-level HUD on Cmd +/βˆ’ and Cmd 0. (#15294)
- **Copy** β€” Unescape markdown escapes when copying user messages.
(#15253)

---

## πŸ–₯️ Desktop

- **App Nap fix** β€” Prevent App Nap from dropping the gateway WebSocket
during display sleep. (#14994)
- **File preview** β€” Preview `.cjs`/`.mjs`/no-extension files instead of
binary fallback and expand `~` when opening local files. (#15168,
#15284)
- **Cross-platform settings** β€” Open settings via main-window navigation
on Windows/Linux and restore the route after an update restart. (#15036,
#14922)
- **Token refresh** β€” Prevent frequent logout from token-refresh
retries. (#14928)

---

## πŸ“Š Observability

- **OTel GenAI** β€” Instrument Agent Runtime with OpenTelemetry GenAI
semantic conventions. (#15123)
- **Generation tracing** β€” Per-call `llm_generation_tracing` with a
pre-allocated tracingId and recordFeedback router. (#15124, #15146)
- **Error classification** β€” Persist `ERROR_CODE_SPECS` classification
on operation errors. (#15273)

---

## πŸ—ƒοΈ Database Migrations

- **Batch migrations** β€” Topic usage stats, push tokens,
`tasks.editor_data`, and document shares. (#15280)
- **Tracing & eval tables** β€” Add `llm_generation_tracing` and agent
eval experiment tables. (#15126)

> Self-hosted operators should run the database migration (`pnpm
db:migrate`, or restart with auto-migrate enabled) after upgrading. The
changes are additive and backwards-compatible.

---

## πŸ”’ Security & Reliability

- **Security:** Remove the `getPlaintextCred` tool to prevent plaintext
credential exposure. (#14998)
- **Security:** Prompt account selection for Google OAuth and add
`prompt=consent` to the OIDC authorization URL to fix missing refresh
tokens. (#15234, #15010)
- **Reliability:** Preserve streamed content across a mid-stream cancel.
(#15173)
- **Reliability:** Bound the Redis command timeout and configure the
Anthropic client timeout. (#15091, #15042)
- **Reliability:** Prevent infinite recursion in the assistant chain.
(#15288)

---

## πŸ‘₯ Contributors

Huge thanks to **15 contributors** who shipped **220 merged PRs** this
cycle.

@AnotiaWang Β· @sxjeru Β· @algojogacor Β· @hardy-one Β· @arvinxx Β· @Innei Β·
@tjx666 Β· @lijian Β· @AmAzing129 Β· @rdmclin2 Β· @neko Β· @cy948 Β·
@CanisMinor Β· @sudongyuer Β· @rivertwilight

Plus @lobehubbot and renovate[bot] for maintenance.

---

**Full Changelog**: v2.2.0...release/weekly-20260528
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature:agent Assistant/Agent configuration and behavior size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant