Skip to content

fix(spec): try_catch nodeId and errorVariable describes say what the engine binds - #24694

Merged
objectstack-fleet[bot] merged 2 commits into
mainfrom
claude/issue-24659-trycatch-describes
Oct 20, 2026
Merged

objectstack-fleet[bot] merged 2 commits into
mainfrom
claude/issue-24659-trycatch-describes

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

Closes #24659

What

Two .describe() sentences in packages/spec/src/automation/control-flow.zod.ts now say what the engine actually binds. No schema shape, default or runtime path changes.

  • TryCatchErrorValue.nodeId: was "Node the failure is attributed to". The engine (packages/services/service-automation/src/builtin/try-catch-node.ts, the errorValue literal) binds nodeId: node.id, the Try / Catch node's own id; the failing inner step only appears inside message. New text: "Id of this Try / Catch node, not of the step that failed inside its try region; that step is normally named inside message".
  • TryCatchConfig.errorVariable: drops "The value is a TryCatchErrorValue: ..." and says in words what the value carries, aligned with the node descriptor text that PR fix(service-automation): try_catch Error Variable help describes the caught error in words #24655 landed ("the id of this Try / Catch node (nodeId), the failure message, which normally names the step that failed (message) ..."). The ADR-0112 $error.code branching hint is kept.

Regenerated with repo tooling (gen:schema, gen:docs): content/docs/references/automation/control-flow.mdx (the two table rows). The shipped json-schema/automation/TryCatchConfig.json and TryCatchErrorValue.json are gitignored build output and carry the new text after the build (grep count 1 each, measured on the built tree). No test pinned either sentence (git grep of both old sentences outside the generated page: zero hits besides the source).

Changeset: .changeset/24659-try-catch-describes.md, @objectstack/spec patch.

Verification (head 9112cb7)

  • pnpm --filter @objectstack/spec build && gen:schema && gen:docs: exit 0 ("Generated 227 files").
  • pnpm --filter @objectstack/spec check:generated: "All 14 generated artifacts are up to date", exit 0.
  • pnpm --filter @objectstack/spec typecheck: exit 0.
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2 src/automation: 37 files, 1576 tests passed.
  • node scripts/pm/dispatch-gates.mjs --commands: 104 derived commands run; 103 exit 0 (five of them after building @objectstack/formula, @objectstack/lint, @objectstack/client, @objectstack/client-react, which they read). NOT MEASURED: pnpm check:dual-build-cjs-loads, reason: PREREQUISITE NOT MET (it reads every package dist/, and a full workspace build was not run locally); declared to CI. --ran reconciliation: 104 derived, 104 run, 0 UNRUN.

Acceptance notes

  • Open PRs touching control-flow.zod.ts were checked before opening (all 15 open PRs' file lists): none.
  • The issue's own premise was re-read on origin/main 3a931fc and holds.

Generated by Claude Code

@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/spec, touching 3 documentable anchor(s).

1 hand-written doc(s) NAME something this change touched and may need an implementation-accuracy re-verification:

  • content/docs/automation/flows.mdx (via errorVariable (literal, a string literal in TryCatchConfigSchema))
What this run could not see
  • the SDK route bridge reached 54 of 206 client-bound route-ledger rows — the other 152 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 152: 0 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 55 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 97 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.
  • a key NAME is not a key, so the hand re-read the line above prescribes can land on the wrong schema. The same spelling is authorable on one governed type and a [REMOVED] tombstone on another for each of active, aria, joins, objects, template, tools and version (censused on [finding] tools is a key on BOTH AgentSchema (tombstoned, dead) and SkillSchema (live, cloud-attested), so a name-based search attributes skill examples to the agent key — it produced a false stop-the-line alarm on PR #19059 #19093 over the liveness ledger's governed types, top-level keys); nothing in a search result distinguishes the two, so a grep hit on a LIVE example reads as evidence about the DEAD key. Measured on fix(spec): the agent.tools liveness row says dead — it claimed live on a key the schema tombstoned #19059: content/docs/ai/agents.mdx was reported as contradicting the agent.tools tombstone over its tools: example at :161, which is inside the defineSkill({ block opened at :155 — the page was already correct. Settle ownership by PARSING the value against both schemas, never by the name: that literal PASSES SkillSchema, and as an AgentSchema it FAILS at tools with the tombstone prescription. ⛔ These names are not the whole class — a key retired through a .strict() guidance map leaves no tombstone in the walked shape and none of them here (tool.category, live as AIToolDefinition.category).

Coarse fallback — 143 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 0431002104679f10523a8c7bb1433dd2d327fa7f → packageMentionDocs.

Which tree this was computed on

This run read content/docs from a24e738df0b77e8758c0bce680bde4dd8bca949f — the merge of head 9112cb75db659db6974b94da2ae49995a9427c8b into base 0431002104679f10523a8c7bb1433dd2d327fa7f, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin a24e738df0b77e8758c0bce680bde4dd8bca949f && git checkout a24e738df0b77e8758c0bce680bde4dd8bca949f
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 0431002104679f10523a8c7bb1433dd2d327fa7f 9112cb75db659db6974b94da2ae49995a9427c8b && git checkout -B drift-repro 0431002104679f10523a8c7bb1433dd2d327fa7f && git merge --no-ff 9112cb75db659db6974b94da2ae49995a9427c8b

node scripts/docs-audit/affected-docs.mjs --json 0431002104679f10523a8c7bb1433dd2d327fa7f

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

Advisory only, and a precision-first one (#9192): a page is listed because it names a
symbol, wire route or SDK method this diff touched — not because it mentions a changed
package. Each row says which anchor put it there, so a wrong row is reportable rather than
merely annoying. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs 0431002104679f10523a8c7bb1433dd2d327fa7f → pass the list as
args.docs, on the commit named under Which tree this was computed on.

@objectstack-fleet
objectstack-fleet Bot marked this pull request as ready for review October 19, 2026 23:59
@objectstack-fleet
objectstack-fleet Bot enabled auto-merge October 19, 2026 23:59
@objectstack-fleet
objectstack-fleet Bot added this pull request to the merge queue Oct 20, 2026
Merged via the queue into main with commit 1c1144f Oct 20, 2026
41 of 42 checks passed
@objectstack-fleet
objectstack-fleet Bot deleted the claude/issue-24659-trycatch-describes branch October 20, 2026 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s tooling

Projects

None yet

2 participants