Add a composable 'gzip' format prefix layer to the serialization
pipeline (compress before encrypt: encr(gzip(devl))), cutting stored
payload bytes by ~70-87% on real-world-style workloads. Compression is
gated on run specVersion 5 (new SPEC_VERSION_SUPPORTS_COMPRESSION) and
on target-deployment capabilities for cross-deployment writes; payloads
under 1KB or that don't compress meaningfully are stored unchanged.
Reads dispatch on the format prefix so both compressed and uncompressed
data are always readable. WORKFLOW_DISABLE_COMPRESSION=1 disables
writes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Add allowReservedAttributes option to start()
experimental_setAttributes already exposes allowReservedAttributes for
framework-level callers that own a $-prefixed sub-namespace, and the
run_created / run_started event schemas plus the local and Postgres
worlds already accept and validate the flag. start() was the one gap:
it always validated initial attributes with the reserved prefix
disallowed and had no way to opt out, so framework code could not seed
reserved attributes at run creation.
Thread the option through start():
- StartOptions.allowReservedAttributes, passed to client-side
validation and forwarded on the run_created eventData
- carried in the queue runInput (new RunInputSchema field) and
forwarded to run_started so the resilient/lazy run creation path
validates identically
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Add e2e coverage for reserved initial attributes via allowReservedAttributes
Verified locally against the nextjs-turbopack dev server: the reserved
key passes client and server validation, lands on the run at creation,
and survives the workflow's own attr_set writes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* Add native workflow attribute events
* Fix abbreviated attributes docs sample
* Document attribute replay ordering for step races
* Address native attribute review feedback
* Validate before claiming attr_set dedup lock; clearer start() attribute errors
- world-local: claim the attr_set correlation lock only after validation,
so a validation failure does not permanently mark the correlationId as
written and wedge the run in a re-invoke loop on retry
- world-postgres: distinguish a concurrently-deleted run from a cap
violation when the guarded attributes update matches no rows
- core: reject non-string initial attribute values in start() with a
clear error instead of a downstream schema failure
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Add attribute edge-case tests across all layers
- core: normalizeAttributeChanges unit tests (non-object inputs, FatalError
wrapping, key/value/batch limits, boundary lengths, UTF-8 byte counting)
- core: start() rejects reserved keys, oversized keys/values, and over-cap
initial attribute batches before any write
- world-local + world-postgres: per-run cap enforced against existing
attributes (upsert-at-cap allowed, removal frees room), oversized values
rejected on attr_set, invalid initial attributes rejected on run_created
- e2e: validation DX workflow asserting every invalid write throws a
catchable FatalError naming the violated rule and limit, with the run
staying healthy; start() rejects invalid initial attributes client-side
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Remove accidentally committed local e2e diagnostics artifact
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Bump world-vercel to spec version 4 for native attributes
The deployed workflow-server (vercel/workflow-server#469) materializes
native attr_set events and accepts initial run attributes, but
world-vercel still advertised spec v3 — so start(..., { attributes })
rejected itself client-side ('requires spec version 4') on every Vercel
deployment, failing the new e2e seeding test across the prod matrix.
New runs are now stamped v4.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Reject duplicate correlated attr_set before materializing in Postgres
A redelivered duplicate — including one carrying different changes for
the same correlationId — previously re-applied the run attributes update
and only then failed the event insert, leaving the snapshot out of sync
with the event log. Pre-check the event log for the correlationId before
mutating; the unique index still guards the truly-concurrent race, which
is idempotent (deterministic replay carries identical changes). Also
apply the suggested docs wording for initial attributes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Apply suggestion from @VaguelySerious
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
* Fail the run on World-rejected attribute writes; un-nest runtime test
Two fixes from review:
- runtime.test.ts: the pre-existing test "propagates transient
step_created failures..." was accidentally nested inside the new
attribute-race test, failing the new test ("Calling the test function
inside another test function is not allowed") and preventing the old
test from running. Restored it verbatim at describe level.
- A workflow-body attr_set the World rejects as invalid (e.g. the
cumulative per-run attribute cap, which only the World can check) is
deterministic: redelivering the orchestrator message replays the same
write into the same rejection, wedging the run in redelivery with no
terminal event. handleSuspension now wraps such rejections in
FatalError, and workflowEntrypoint fails the run with the validation
error instead of rejecting the delivery. Transient storage errors
still propagate and retry via redelivery.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---------
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Co-authored-by: Peter Wielander <peter.wielander@vercel.com>
The World service omits input fields from run/step snapshot responses when
payloads are externalized as RemoteRef blobs. Mirrors existing
WorkflowRunWithoutData / StepWithoutData types and extends #1939's treatment
of output/error/completedAt to input.
Fixes WorkflowWorldError schema validation failures on every event
acknowledgement after the 2026-05-12 service-side RemoteRef rollout.
Fixes#1977.
Signed-off-by: Nathan Rajlich <n@n8.io>
Co-authored-by: Nathan Rajlich <n@n8.io>
* [core] Exclude inline step execution from replay timeout
The v5 combined workflow+step handler wraps inline step bodies in the
same setTimeout(..., REPLAY_TIMEOUT_MS) guard that previously only
bounded the v4 'workflows' function's fast deterministic replay. As a
result, any workflow with a single step exceeding 240s hard-fails with
FatalError: Workflow replay exceeded maximum duration (240s) after 4
attempts — even though the step could legitimately run for the full
function maxDuration (up to 800s on Pro Fluid).
Replace the setTimeout guard with a per-invocation budget that only
accumulates non-step time. pauseReplayBudget() / resumeReplayBudget()
bracket each executeStep() call, and the loop checks the budget at
iteration boundaries. The retry-then-fail semantics from #1567 are
preserved verbatim for the pure-replay case.
Also adds a WORKFLOW_REPLAY_TIMEOUT_MS env var override (clamped to
30s..780s) so operators can adjust the bare-replay ceiling without
patching @workflow/core.
Fixes#2009.
* Address PR review feedback
- Extract budget bookkeeping into ReplayBudget class (replay-budget.ts)
with sentinel-protected idempotent pause()/resume() to avoid
double-counting in future refactors that nest step execution
- Restore VERCEL_URL gate around process.exit(1) so a long pure-replay
in local dev/non-Vercel runtimes can't hard-kill the host process
- Warn (once per distinct raw value) when WORKFLOW_REPLAY_TIMEOUT_MS is
clamped or rejected, so misconfiguration is observable
- Correct Hobby maxDuration comment (60s standard / 300s Fluid)
- Document budget-check responsiveness trade-off vs. old setTimeout
- Tighten describe-error test assertions to match the full new hint
- Shorten changeset description
- Add ReplayBudget unit tests (9) including 8-minute step regression
- Add warn-once tests for getReplayTimeoutMs (extended)
* Replace VERCEL_URL gate with World capability
Per review feedback, gating runtime behavior on process.env.VERCEL_URL
leaks deployment-environment concerns into @workflow/core. Replace the
check with a new optional capability on the World interface:
processExitTriggersQueueRedelivery (default false).
- @workflow/world: declare the new optional capability on World
- @workflow/world-vercel: set it to true (Vercel fails the function
invocation on non-zero exit and VQS redelivers via fresh invocation)
- @workflow/core: handleReplayBudgetExhausted reads world.processExitTriggersQueueRedelivery
instead of process.env.VERCEL_URL; behavior is otherwise unchanged
- Add 4 unit tests for handleReplayBudgetExhausted covering both branches
(exit-for-redelivery and best-effort run_failed)
---------
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
* Forward port stale wait replay fix
* Guard V5 replay writes against stale events
* Revert "Guard V5 replay writes against stale events"
This reverts commit 22e74d3558.
* Update wait replay comments
* Expose conflicting run id on hook conflicts
* Mark hook conflict run id as future required
* Address hook conflict docs review
* Address hook conflict review comments
* Fix hook conflict docs typecheck
* feat: add docs and test stubs for serializable AbortController/AbortSignal
Adds documentation and test infrastructure for making AbortController and
AbortSignal serializable across workflow and step boundaries. The feature
uses a dual hook+stream backing: hooks for deterministic replay in the
workflow context, streams for real-time propagation to running steps.
Docs:
- Cancellation guide (foundations) covering AbortSignal and run cancellation
- How Cancellation Works (how-it-works) explaining hook+stream internals
- AbortSignal.timeout() error page for the workflow VM restriction
- Updated serialization docs with AbortController/AbortSignal section
Tests (all .todo stubs for TDD):
- VM behavior: AbortController API, static methods, hook integration
- Step-side: stream reader setup, abort propagation, ops queue
- Serialization round-trips: all boundaries, encryption, nested structures
- Consistency: race conditions, partial failure, eventual convergence
- E2E workflows: timeout, parallel, step-initiated, hook-triggered, replay
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: use correct frontmatter type for error page
Change type from "error" to "troubleshooting" to match the valid
frontmatter schema used by all other error pages.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: address review feedback on cancellation docs
- abort() in workflow does not synchronously update signal.aborted;
instead it queues hook resumption and the replay handles state update
- stream name and hook token are generated at serialization time (not
deterministically in the workflow) and stored in the event log
- use throwIfAborted() instead of manual signal.aborted checks
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: document runtime change for processing abort queue items on completion
The current runtime only processes invocation queue items on suspension.
When abort() is called after the last suspension point and the workflow
completes, the queue items are dropped with a warning. Document that the
runtime needs to flush abort-related items on completion/failure too.
Add test stubs for this behavior.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: generalize queue processing on completion to all item types
Processing pending invocations queue items on workflow completion/failure
should apply to all queue item types (steps, hooks, waits, abort signals),
not just abort-related ones. Update docs and tests accordingly.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: abort errors in steps are automatically wrapped in FatalError
When a step throws due to an abort (AbortError from fetch, throwIfAborted,
etc.), the error is wrapped in FatalError so the step skips retries. An
abort is intentional cancellation, not a transient failure.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: remove contrived "aborting from within a step" example
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: add meaningful step-initiated abort example (quota monitor)
Replace the contrived example with a watchdog pattern where a monitoring
step polls an external condition and aborts parallel work when triggered.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: remove unnecessary "as const" from hook cancellation example
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: implement serializable AbortController/AbortSignal
Core serialization layer:
- Add AbortController/AbortSignal to SerializableSpecial interface
- Add reducers for all 4 contexts (external, workflow, step, common)
- Add revivers for all 4 contexts with stream-backed propagation
- Add reviveAbortController helper for step/external contexts
- Guard instanceof checks for VMs without AbortController global
Workflow VM:
- New workflow/abort-controller.ts with createCreateAbortController factory
- WorkflowAbortSignal class with hook-backed state
- AbortSignal static methods (abort, any, timeout blocked)
- Hook integration via invocations queue and events consumer
Supporting changes:
- Add ABORT_STREAM_NAME, ABORT_HOOK_TOKEN symbols
- Add getAbortStreamId() for system stream namespace
- Add isSystem, abortRequested, abortReason to HookInvocationQueueItem
- Add isSystem to world Hook entity and events
- Wrap AbortError in FatalError in step handler (skip retries)
- Add AbortController/AbortSignal to Serializable type
- Add observability revivers for abort types
- Add isSystem to postgres schema and web-shared attribute panel
All 454 existing tests pass with no regressions.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: wire up AbortController in workflow VM and process queue on completion
- Wire up AbortController/AbortSignal in workflow VM (workflow.ts)
- Add abort processing to suspension handler (hook resume + stream write)
- Process pending queue items on workflow completion (throw
WorkflowSuspension instead of warning for actionable items)
- Fix instanceof guards for non-function AbortSignal in VM
- Update test to expect WorkflowSuspension for unawaited steps
All 454 existing tests pass.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: implement tests and Request.signal serialization
Tests (516 passing, 18 todo for integration tests):
- 18 VM behavior tests (abort-controller.test.ts)
- 18 step-side behavior tests (abort-controller-step.test.ts)
- 4 consistency tests + 14 integration todos (abort-consistency.test.ts)
- 14 serialization round-trip tests (serialization.test.ts)
- 7 hook integration + 4 integration todos (step.test.ts)
Request.signal serialization:
- Add signal field to SerializableSpecial Request type
- Include signal in Request reducer when present
- Pass signal through in external and step Request revivers
Fix workflow reviver for AbortController/AbortSignal:
- Use plain objects instead of prototype-based stubs
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* test: implement all remaining .todo test stubs
Convert all 27 remaining .todo stubs to real implementations:
- 14 consistency tests (race conditions, partial failures, queue processing)
- 4 hook integration tests (suspension handler, hydration, eventual consistency)
- 9 e2e tests (timeout, parallel, step-abort, hook-cancel, replay, external signal)
All 558 tests pass, 0 todos remaining.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: address PR review comments + add changelog
PR review fixes:
- Move cancellation after streaming in foundations nav
- Fix AbortSignal reducer to detect WorkflowAbortSignal via symbol
- Guard AbortController reducer from matching AbortSignal objects
- Add e2e tests: throwIfAborted, reason types, uncaught fetch AbortError
Changelog:
- Add hidden changelog section (not in sidebar, accessible via URL)
- Add draft changelog entry for serializable AbortController/AbortSignal
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: show changelog in nav for preview deployments only
- Add `preview` flag to nav items in geistdocs.tsx
- Filter preview items in Navbar (server component) based on VERCEL_ENV
- Show "Preview" badge on preview nav items in DesktopMenu
- Changelog link visible in preview deployments and local dev only
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: move preview badge from home page to navbar
Move the PreviewBadge (with package tarball install modal) from the
fixed bottom-right position on the home page to the navbar, so it
appears on every page during preview deployments.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: consolidate preview tools into single Internal page
Replace separate Changelog nav item and PreviewBadge with a single
"Internal" page that only appears in preview deployments:
- Rename docs/changelog/ to docs/internal/
- Internal page includes preview package install commands and draft
changelogs in one place
- Nav shows "Internal" with Preview badge in preview/dev only
- Remove PreviewBadge from navbar (now on the Internal page)
- Add callout that page is preview-only
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: use real deployment URLs on internal page + exclude from indexing
- Add PreviewInstall component with copy-to-clipboard buttons using
the actual VERCEL_URL (not placeholders)
- Register PreviewInstallServer as MDX component for docs pages
- Exclude /internal/ pages from sitemap.xml, sitemap.md, and llms.mdx
- Add robots.txt Disallow for /internal/ paths
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: add missing type declarations for docs code sample typechecking
Add declare statements and @setup/@skip-typecheck annotations for
undeclared functions in code samples (stepA, stepB, fetchData,
cancellableStep, splitIntoChunks, processChunk).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: add missing type declarations for all docs code samples
Fix docs typecheck CI by adding declare statements and
@skip-typecheck annotations for all undeclared function references
across cancellation docs, error page, how-it-works page, and
internal changelog.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: only suspend on completion for abort items, not all pending items
The previous logic threw WorkflowSuspension for any pending queue item
on completion (steps, waits, hooks). This broke fire-and-forget patterns
like `void sleep('1d').then(...)` which intentionally leave a wait in
the queue without awaiting it.
Now only abort-related items (hooks with abortRequested) trigger
suspension on completion. Other pending items get the original warning
behavior — they may be intentional fire-and-forget operations.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: all pending queue items are fire-and-forget on completion
Remove special-case suspension for abort items on workflow completion.
ALL pending queue items (steps, hooks, waits, abort signals) are now
fire-and-forget when the workflow completes — they get warned about
but don't block completion. This matches the existing behavior for
fire-and-forget patterns like `void sleep('1d').then(...)`.
Abort signals propagate through the normal suspension flow during
the workflow (not at completion time).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: resolve docs typecheck errors in code samples
Move declare statements before imports to avoid TypeScript overload
signature conflicts with auto-inferred imports. Add @skip-typecheck
for conceptual snippets.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: abort() in workflow updates signal.aborted synchronously
abort() must update signal.aborted immediately so that:
1. Subsequent reads in the workflow see the correct state
2. Serialization captures aborted=true when passing signal to steps
3. Event listeners fire synchronously
The hook resumption still happens via the suspension handler for
durable event log recording. Both local state and durable state
are now updated.
Fixes e2e failures where steps received aborted=false for signals
that were aborted before being passed to the step.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: update how-it-works to reflect synchronous signal.aborted update
abort() now updates signal.aborted synchronously in the workflow.
Update lifecycle diagram and remove outdated paragraph about signal
not being updated synchronously.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: ensure abort listeners fire at deterministic point across replays
On replay, hook_received is processed during event consumer subscription
(at AbortController construction time), which is BEFORE the abort() call
in the workflow code. If listeners fired during event processing, they'd
fire at a different point than on first-run — breaking determinism.
Solution: split abort into two phases:
1. _markAbortedFromReplay(): Sets signal.aborted=true (for reads/serialization)
but does NOT fire listeners. Called by event consumer during replay.
2. abort(): Detects the replay flag and fires listeners at the call site.
On first-run, fires listeners immediately as before.
This ensures listeners fire at the abort() call site on BOTH first-run
and replay, maintaining consistent ordering of side effects.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* test: add replay ordering tests for interleaved hook scenarios
Add 3 tests validating that abort listeners fire at the abort() call
site on both first-run and replay, even when other hook events are
interleaved in the event log.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: signal.aborted stays false until abort() is called for deterministic replay
_markAbortedFromReplay no longer sets signal.aborted = true. Both
aborted state and listener firing are fully deferred to abort().
This prevents if-checks on signal.aborted from taking different
branches on first-run vs replay.
Add deterministic branching test (unit + e2e):
const controller = new AbortController();
if (controller.signal.aborted) {
return 'was aborted'; // never taken
} else {
controller.abort();
return 'just aborted'; // always taken, both runs
}
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* test: add abort+hook ordering matrix e2e tests (4 combinations)
Test all combinations of listener registration order and event trigger
order to validate deterministic ordering across first-run and replay:
1. addEventListener first, abort() first
2. addEventListener first, resumeHook first
3. hook.then first, abort() first
4. hook.then first, resumeHook first
Each test verifies that abort-listener fires synchronously at the
abort() call site (immediately before 'after-abort' in the log),
regardless of when the hook is resumed or when listeners are registered.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: simplify abort — event consumer calls _setAborted directly
Remove the deferred _markAbortedFromReplay approach. The event consumer
now calls _setAborted directly when hook_received is processed, which
sets signal.aborted = true AND fires listeners at that point.
This is correct because:
- Cross-execution aborts (step/external): signal.aborted SHOULD be true
on replay since the abort is a fact from a previous run. Listeners must
fire so the workflow can react to the abort.
- Same-execution aborts: abort() fires _setAborted synchronously. On
replay, the event consumer fires it first, and abort() is a no-op.
- The promiseQueue ensures listeners fire at the deterministic point
matching the hook_received event's position in the event log.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* test: skip abort+hook ordering e2e tests pending full integration
The 4 ordering matrix tests require the abort controller's internal
system hook to be fully wired through the suspension handler. The hook
creation timing interacts with the user hook lookup in getHookByToken.
Skip until the full integration is complete.
All 13 other abort e2e tests pass on CI.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* handle dangling streams
* fix postgres world
* fix abort serialization bug
* refactors
* add drizzle migration file
* fix tests
* fix tests
* replace setTimeout probe and any casts with typed abort internals
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* cover post-serialization abort and nested-in-Request reader cleanup
Two leak paths the prior fix left uncovered:
- External signal aborted after serialization: verifies the listener
attached by reduceAbortWithListener actually fires and writes the
abort packet once the caller aborts later.
- Signal nested inside a Request: exposed a real leak. The Request
constructor copies the signal to an internal AbortSignal, so the
ABORT_READER_CANCEL symbol set by reviveAbortSignal never reached
request.signal, and cancelAbortReaders' walker had no Request case
so Object.values(request) returned []. Fixed both sides:
- Request reviver copies abort-internal symbols via copyAbortInternals
- Walker descends into Request.signal explicitly
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* add v4/v5 docs switcher and pre-release gating
- Mark new abort-controller/cancellation pages with preRelease: true
(cancellation, how-it-works/cancellation, abort-signal-timeout-in-workflow,
serializable-abort-controller). preRelease is a new optional frontmatter
field declared in source.config.ts.
- lib/geistdocs/versions.ts: declarative version list (v4 Latest, v5 Pre-release)
plus getVersionFromPathname and buildVersionUrl helpers used by the switcher.
- lib/geistdocs/version-source.ts: filter preRelease pages out of the v4
sidebar tree; rewrite sidebar URLs to /v5/docs/* on v5 so links stay in
the pre-release view.
- components/geistdocs/version-switcher.tsx: dropdown at the top of the
sidebar, styled after the ai-sdk.dev pattern (label + subtitle).
- components/geistdocs/pre-release-banner.tsx: banner rendered above the
docs layout on all /v5/docs/* routes, linking back to /docs/* (Latest).
- app/[lang]/v5/docs: parallel route (layout + page) that reuses the
existing docs rendering but keeps preRelease pages visible.
- app/[lang]/docs/[[...slug]]: 404 direct access to preRelease pages on v4
so unreleased content is never reachable without the /v5 prefix.
- next.config.ts: /v5/docs -> /v5/docs/getting-started mirror of the
existing /docs -> /docs/getting-started redirect.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix version switcher URL when default locale is hidden
buildVersionUrl assumed segment 0 was the locale, but next.js i18n
middleware hides the default locale from the URL so usePathname()
returns '/docs/...' rather than '/en/docs/...'. The old logic treated
'docs' as the locale and produced '/docs/v5/getting-started' (404)
instead of '/v5/docs/getting-started'.
Detect the locale by checking whether segment 0 is a known structural
token ('docs' or 'v5') rather than by position, so the function works
for both '/docs/...' and '/<locale>/docs/...' inputs.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* match ai-sdk pre-release banner styling
Filled sparkles glyph, blue tint on the message text, and a plain
underlined "Go to ..." link in the foreground color instead of a
bordered pill. Matches the ai-sdk.dev v7 banner reference.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* match ai-sdk switcher icons and banner link color
- Switcher: colored rounded icon tile next to each version (orange tint
for pre-release, blue for latest), matching the ai-sdk.dev dropdown.
Uses a workflow glyph inside a tinted ring.
- Banner link: blue text with a softer underline by default, deeper
blue on hover. Replaces the foreground-colored link that didn't
match ai-sdk's styling.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* use exact ai-sdk icons and darker banner link
- Switcher tile: use the T-mark SVG and the bg-orange-100/border-orange-300
(pre-release) / bg-blue-100/border-blue-300 (latest) palette extracted
from the ai-sdk.dev live markup, with matching dark-mode variants.
- Pre-release banner sparkle: replaced the placeholder with the exact
three-path geist sparkle used by ai-sdk.
- Banner "Go to Latest" link: foreground color with a muted underline
by default (same weight as ai-sdk's near-black link), underline
intensifies on hover. The previous blue-600 was too light.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(docs): correct dark-mode colors for pre-release banner and version switcher
The geistcn design-system palette inverts brightness semantics in dark
mode (low indices = dim, high indices = bright) and remaps `blue-*` but
not `orange-*`, so the previous token choices rendered as dim gray-blue
text and a mid-bright blue icon inconsistent with the dropdown list.
- Banner: use `dark:text-blue-900` for icon + label and switch the "Go
to" link from `text-foreground` to the same blue (with a blue
underline) so it reads as a single colored banner.
- VersionSwitcher: move the text color onto the SVG itself so the
`DropdownMenuItem` SVG-color override no longer hijacks the T color,
and invert the dark blue palette (dark bg, light border, bright T) so
the selected/trigger icon matches the list icon.
- Active-row check icon: use green instead of `fd-primary` (which
resolves to near-white in dark mode).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: add signal field to Request serializable type
The merge from main moved the Request type into serialization/types.ts
without carrying over the signal?: AbortSignal field, causing the
abort-related reducers/revivers in serialization.ts to fail typecheck.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* refactor: address review feedback on abort serialization
- Dedupe abort listener attach in serialization reducers via marker symbol
(prevents N-listener leak when one controller is serialized to N steps,
which would double-close the backing stream on abort).
- Replace token.replace('abrt_', '') string-surgery in suspension-handler
by storing streamName directly on HookInvocationQueueItem at the point
where it's already known (workflow/abort-controller.ts construction).
- Document the deliberate sync-vs-microtask listener divergence in the
workflow VM (replay determinism > spec parity inside the VM).
- Add changeset noting the AbortError -> FatalError behavior change.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: correct cancellation docs against implementation
- Remove the contradictory paragraph claiming signal.aborted is not set
synchronously when abort() is called in the workflow. The implementation
sets it sync via _setAborted; replay re-applies via the events consumer.
- Reword the "Stream Succeeds, Hook Fails" recovery — there's no in-process
retry loop on the step-side resumeHook call; convergence comes from the
next replay re-reading the stream.
- Tighten Request.signal handling: plain non-aborted native signals are
intentionally dropped to avoid minting stream infra for auto-generated
Request signals; only already-aborted or workflow-tagged signals are
forwarded.
- Replace the wrong "Pending queue items processed on completion" bullet
with an accurate fire-and-forget note matching the warn-only behavior.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: DOMException serialization (replace broken isNativeError guard)
DOMException is `instanceof Error` in Node but does NOT pass
`types.isNativeError()` — the existing reducer's first guard was
`isNativeError(value)`, so DOMException never matched. Devalue then
fell through to its arbitrary-POJO failure path.
This surfaced as a real bug for AbortController/AbortSignal: when
abort() is called with no argument, native AbortController synthesizes
a default DOMException as signal.reason. Returning that signal's reason
from a step (e.g. `{aborted, reason: signal.reason}`) crashed step
return-value serialization.
Replace the guard with a constructor-name check (cross-VM safe; same
pattern used elsewhere for matching Error subclasses across realms).
Also fixes 7 pre-existing DOMException tests in serialization.test.ts
that were previously failing on main.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: drain pending queue items on workflow completion
End-of-run now goes through the same suspension handler that processes a
real suspension. Previously, items left in the invocations queue when the
workflow function returned (or threw) were dropped with an "uncommitted
operation" warning — `controller.abort()` called as the last statement of
a workflow never actually propagated.
Concretely fixes:
- Abort hooks now write hook_received + stream packet so in-flight steps
on other compute instances see signal.aborted=true and bail out.
- Unawaited hooks are created (so external callers can resume them).
- Unawaited steps and sleeps are queued (will execute / fire later).
Strengthens abortTimeoutWorkflow's test to inspect the event log for the
hook_received event — the original assertion only verified the workflow
VM's local signal.aborted, which was set synchronously by the abort()
call regardless of whether propagation actually happened. The strengthened
test fails on main and passes after this commit.
Drops the warnPendingQueueItems warning entirely. Drain failures are
swallowed so the workflow's own outcome (return value or thrown error)
remains the source of truth for the run's terminal state.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test: cover the deserialized AbortSignal listener path with an in-flight fetch
The existing abort tests exercised either the polled `signal.aborted` read
path (longStep busy-wait) or the already-aborted-before-fetch path. Nothing
exercised the live listener path: signal starts non-aborted, step kicks off
a fetch against a slow endpoint, abort fires while fetch is awaiting the
response, and fetch's internal `signal.addEventListener('abort', …)` listener
cancels the in-flight HTTP request.
The pre-existing `fetchWithSignal` helper step was orphaned — defined but
not referenced by any workflow. Wires it into a new `abortFetchInFlightWorkflow`
that races a 30s fetch against a 2s sleep, aborts when the sleep wins, and
returns the step's catch-path result. The test asserts both `winner=timeout`
and `fetchResult.aborted=true`, which together prove fetch saw the cancellation
mid-flight (the natural-completion path would set ok=true,aborted=false).
Adds a local /api/delay endpoint to the nextjs-turbopack workbench so the test
doesn't depend on an external service. Honors the request's own AbortSignal
so cancelled connections close immediately.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test: extend abortFromStepWorkflow to verify in-flight sibling cancellation
The original test only asserted that the workflow VM's signal saw aborted=true
after a step called controller.abort(). It didn't actually verify that another
in-flight step received the cancellation through the backing stream — those
two paths are different (workflow VM signal updates via the hook event;
sibling-step propagation runs through the live stream packet).
Restructure the workflow to run longStep (a 30s polling loop on signal.aborted)
in parallel with abortFromStep (now sleeps 1s, then aborts). The new assertion
expects longStep.result === 'aborted' — proving it exited via the abort branch
within ~1.5s, NOT ran to its 30s natural completion. Returning 'completed'
would mean realtime cross-step cancellation is broken.
abortFromStep gained an optional delayMs parameter so it can be sequenced
against a sibling without an out-of-band sleep.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: dehydrate abort stream packets via the same machinery as hook events
The abort stream packet was being encoded with bare `JSON.stringify({reason})`
on the writer and decoded with `JSON.parse(text).reason` on the reader. That
codec drops `undefined` (so a reason-less abort wrote literally `{}` and the
observability UI showed an empty stream), and doesn't handle DOMException or
any other type the rest of the codebase serializes via devalue+reducers.
Switch all three sites — suspension-handler workflow-side write, patched
abort step-side write, and `setupAbortStreamReader` — to use
`dehydrateStepArguments`/`hydrateStepArguments`. Now the `reason` round-trips
with full type fidelity (DOMException, custom errors, encrypted payloads),
matching what the hook event payload already does. The suspension handler
literally reuses the same dehydrated bytes for the event and the stream so
they're guaranteed identical.
Encryption key threading:
- Suspension handler: `encryptionKey` was already in scope.
- Patched abort: read from `contextStorage.getStore()?.encryptionKey` (set
by the step handler before invoking the deserialize chain).
- Reader (`setupAbortStreamReader`): read from `contextStorage.getStore()?.encryptionKey`
for the same reason; falls back to `undefined` when called outside step
context (the hydrate path is key-tolerant).
On-disk verification:
- Before: chunk for `controller.abort()` (no reason) was `00 7b 7d` — 3 bytes,
the literal JSON `{}`, no reason carried at all.
- After: chunk is `00 64 65 76 6c [{"aborted":1,"reason":2},true,"test"]` —
43 bytes, devalue-flat-encoded with the reason intact.
Updated the existing stream-reader unit test to encode its mock payload
through the same dehydrate path so the reader can decode it.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test: cover addEventListener, mid-flight throwIfAborted, and step-initiated determinism
The polled-`signal.aborted` path was the only abort consumption pattern
exercised end-to-end. Three new e2e tests fill the gaps:
- **abortListenerWorkflow** — `signal.addEventListener('abort', cb)` firing
on the deserialized step-side signal. Distinct from abortFetchInFlightWorkflow
which only proves it indirectly through fetch's internal listener; this one
verifies user-attached listeners directly. Step resolves with via:'listener'
if propagation worked, via:'timeout' on a 30s safety timeout if it didn't.
- **abortThrowIfAbortedMidFlightWorkflow** — throwIfAborted() in a polling
loop, not just at step entry. The existing abortThrowIfAbortedWorkflow
only covers the synchronous-throw case on a pre-aborted signal. This one
starts the signal non-aborted, polls throwIfAborted every 500ms, and aborts
from a sibling step after 1s. Verifies the DOMException propagates as
FatalError (no retries) when fired mid-flight.
- **abortDeterministicBranchFromStepWorkflow** — counterpart to
abortDeterministicBranchWorkflow, but with the abort source being a step
(via the patched abort() path / hook event) instead of the workflow body.
Both branch-reads MUST take the same path on every replay. Uncovered a
real semantic: signal.aborted reflects step-initiated aborts only after
the next promise-queue checkpoint (sleep, step await, etc.) since
_setAborted is chained on promiseQueue. The test inserts the required
sleep('1s') checkpoint and asserts both pre and post values.
Helper steps factored: stepWaitingOnAbortListener and stepPollingThrowIfAborted.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test: drop signal.aborted shortcut in stepWaitingOnAbortListener
The shortcut would have masked a regression in the addEventListener-on-an-
already-aborted-signal contract. Per the AbortSignal spec, calling
addEventListener('abort', cb) on an aborted signal fires the callback (on a
microtask), so user code that subscribes via the listener path alone — the
common pattern — depends on it. Test the contract directly: rely solely on
the listener resolving the promise. If addEventListener-on-aborted ever
silently breaks, this test now reports via:'timeout' instead of paving over
it with a fast-path that reads signal.aborted directly.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix: add DOMException reviver to observabilityRevivers so the o11y UI hydrates abort reasons
The observability UI (and CLI) hydrates step IO via `observabilityRevivers`,
which had no `DOMException` entry. When a step returned a value containing
a DOMException (typically `{aborted, reason: <DOMException>}` — synthesized
by native AbortController when abort() is called with no reason), devalue's
`parse` would throw on the `["DOMException", ...]` tag, `hydrateStepIO`'s
try/catch would swallow it, and the raw devalue-flat string survived to
the UI. The user-visible result was step Output showing literal text like:
devl[{"aborted":1,"reason":2},true,["DOMException",3]...]
instead of a JSON viewer with a proper DOMException card.
Add the reviver. Reconstruct as a real DOMException when the global is
available (modern browsers + Node 18+, where the o11y consumers run),
falling back to a name-tagged Error otherwise. Preserves message/name/
stack/cause for display.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test: cover the external-signal-aborted-in-flight propagation path
The existing abortExternalSignalWorkflow only validates a static read of
an already-aborted signal — it tells us nothing about whether an abort
that fires AFTER serialization actually propagates from the caller process,
through the listener attached at workflow-start, into the backing stream,
and out into the deserialized signals on the in-flight step compute.
Add abortExternalSignalInFlightWorkflow that takes a non-aborted signal
and runs two parallel consumption patterns against it: longStep (polling
signal.aborted) and stepWaitingOnAbortListener (addEventListener path).
The test creates a fresh AbortController, calls start() with its non-aborted
signal, and aborts the source controller 1.5s later via setTimeout — well
after both steps are mid-flight on their compute instances.
Both consumers must see the cancellation:
- pollResult === 'aborted' (NOT 'completed' — that would mean longStep ran
the full 30s without ever seeing signal.aborted=true)
- listenerResult.via === 'listener' (NOT 'timeout' — that would mean the
addEventListener callback never fired)
This exercises the longest end-to-end abort path in the codebase:
caller-process AbortController → serialization-time listener →
backing stream → step compute → deserialized signal →
(poll OR addEventListener)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(test): use httpbin.org/delay for abortFetchInFlightWorkflow
The previous setup added a /api/delay route to workbench/nextjs-turbopack
to give the test a slow endpoint to fetch against. That made the workflow
fail in CI on every other workbench (nextjs-webpack, astro, sveltekit, …)
since the route only existed on one of them — fetch returned 404 and the
test failed within 1s instead of taking the expected ~3s.
Switch to httpbin.org/delay/30, the same external-service pattern used by
other e2e workflows in this file (jsonplaceholder, example.com). Removes
the per-workbench dependency. Drops the now-unused deploymentUrl argument
from the workflow signature and test call site.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: fix serialization page — drop duplicate header, move AbortController section
Two issues on the serialization foundations page:
1. `## Pass-by-Value Semantics` appeared twice. The second occurrence had no
body, which rendered as an orphaned heading just above the AbortController
section in the docs preview.
2. `## AbortController & AbortSignal` was at the bottom of the page, after
`## Custom Class Serialization`. It belongs above the custom-class section
so the standard serializable types are grouped together before the
advanced topic.
Removes the empty duplicate; relocates the AbortController section to sit
between Request & Response and Custom Class Serialization. No content
changes inside the section.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: note that run.cancel() is the same as the observability Cancel button
The Run Cancellation section showed the programmatic path but didn't tie
it back to the UI. Add a callout: calling run.cancel() is the same action
as clicking the Cancel button on a run in the observability UI — both
produce identical run_cancelled events.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test: cover AbortSignal.any in both workflow VM and step contexts
Two distinct paths: the workflow VM ships its own AbortSignal.any impl in
workflow/abort-controller.ts (composes WorkflowAbortSignals via listeners,
no stream/hook backing on the composite), while steps use the native
Node implementation over deserialized signals. Neither was tested.
abortAnyInWorkflowWorkflow exercises the VM impl directly: creates two
controllers, composes their signals via AbortSignal.any, aborts one, and
asserts the composite reflects the abort synchronously without any stream
round-trip. Also asserts the other source signal is unaffected so a
mass-abort regression would surface here.
abortAnyInStepWorkflow exercises the longest end-to-end path that uses
AbortSignal.any: source controller is aborted by a sibling step, abort
flows through the workflow's VM, then the backing stream, into the step's
deserialized signal, into the AbortSignal.any composite, into the user's
listener. Returning via:'timeout' instead of via:'listener' would mean a
break anywhere on that chain.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Update .changeset/fix-dom-exception-serialization.md
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Signed-off-by: Pranay Prakash <pranay.gp@gmail.com>
* Update .changeset/serializable-abort-controller.md
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Signed-off-by: Pranay Prakash <pranay.gp@gmail.com>
* Update .changeset/drain-pending-queue-on-completion.md
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Signed-off-by: Pranay Prakash <pranay.gp@gmail.com>
* docs(errors): match slug-as-title convention + simplify the timeout example
Two toolbar-comment fixes on the abort-signal-timeout-in-workflow error
page:
1. The page title was Title Case ("AbortSignal.timeout() in Workflow")
while every other page in docs/content/docs/errors/ uses the kebab-case
slug as the title (e.g. timeout-in-workflow, fetch-in-workflow,
workflow-not-registered). Match the convention.
2. The recommended replacement for AbortSignal.timeout() was a
Promise.race that wrapped the abort + null sentinel + custom Error
throw. Boil it down to the much simpler:
const controller = new AbortController();
void sleep("10s").then(() => controller.abort());
return await fetchData(controller.signal);
If fetchData finishes within 10s you get the response; if not, the
timer fires controller.abort(), fetch rejects with AbortError, and
the step's failure propagates to the workflow as a FatalError (no
retries). Same observable behavior, no Promise.race scaffolding.
Adds abortVoidSleepTimeoutWorkflow + matching e2e test that exercises
this exact pattern end-to-end so the doc example is verified runnable
(not just pseudocode). Asserts the fetch is cancelled mid-flight by
the timer, returning aborted=true,ok=false from the step.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Signed-off-by: Pranay Prakash <pranay.gp@gmail.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Karthik Kalyanaraman <karthik.kalyanaraman@vercel.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
* Serialize run_failed/step_failed errors through serialization pipeline
Switch run_failed, step_failed, and step_retrying events to persist
the full thrown value via the workflow serialization pipeline (as
SerializedData / Uint8Array) instead of a lossy { message, stack, code }
StructuredError shape. Consumers hydrate via hydrateRunError /
hydrateStepError to reconstruct the original thrown value, preserving
Error subclass identity, cause chains, and custom properties.
- WorkflowRun.error and Step.error are now SerializedData
- WorkflowRun gains a top-level errorCode plaintext field
- WorkflowRunFailedError.cause is now the hydrated thrown value
- Adds world-postgres migration 0010_add_error_code.sql
- Legacy pre-pipeline errorJson records surface as undefined on read
* Update Next.js workbenches for new WorkflowRunFailedError.cause type
cause is now `unknown` (the hydrated thrown value) rather than
`Error & { code }`. Defensively extract Error-shaped fields when the
hydrated value is an Error, otherwise round-trip the raw value, and
expose the new `errorCode` classification field.
* Update docs for WorkflowRunFailedError.cause: unknown
The hydrated `cause` is now `unknown` (the original thrown value
through the serialization pipeline) and the error classification has
moved to the top-level `errorCode` property. Update the two affected
docs pages and the `TSDoc` interface to reflect the new shape, and
narrow `cause` with `instanceof Error` before accessing fields.
* Expand test coverage for the run/step error serialization pipeline
Unit tests:
- 19 new dehydrate/hydrate{Step,Run}Error round-trip tests covering
FatalError, plain Error, built-in Error subclasses, non-Error thrown
values (string, plain object), cause chains, encryption round-trip,
the binary format prefix contract, and the unserializable / unknown-
format error paths.
- 5 new tests for Run.returnValue when the run is failed: hydrated
FatalError + cause as cause, plain Error preservation, non-Error
thrown values surfaced verbatim, cross-class cause chains, and the
hydration-failure fallback that still surfaces errorCode.
E2E tests (new, in 99_e2e.ts + e2e.test.ts):
- Step throw → workflow catch round-trips a FatalError with a TypeError
cause chain, asserting class identity, fatal marker, and cause name +
message all survive the step_failed event pipeline.
- Workflow throw → run_failed reaches status with the new
top-level errorCode metadata exposed (cause-shape coverage lives at
the unit level, since the SWC plugin's class registration is not
invoked in the plain-Node e2e runner).
- Workflow throw of a non-Error value round-trips that value verbatim
as WorkflowRunFailedError.cause.
Adjustments to existing assertions:
- error.cause is now ; tests narrow with
and use the new top-level field instead of .
- step.error / run.error from CLI --withData are now hydrated payloads:
unregistered class instances surface as Instance refs whose
carries the original message + stack.
Observability hydration:
- hydrateStepIO / hydrateWorkflowIO in serialization-format.ts now
hydrate the field via hydrateData, so the CLI and web UI
continue to surface readable run/step error messages and stacks.
* Tighten error serialization changeset description
* Trim error serialization changeset to a single sentence
* Resolve FatalError/RetryableError revivers via cross-realm registry
When a workflow runs in a Node `vm` context, its bundled
`@workflow/errors` is a different module instance than the host's
import (separate prototype chains, separate class identity). Calling
`new FatalError(...)` from the host-side reviver produces a
host-realm instance that fails `err instanceof FatalError` checks
in the workflow code — even when the serialized payload was correctly
tagged via the dedicated `FatalError` reducer.
Surfaced by the local-prod e2e "step throw round-trips FatalError"
test on Next.js Turbopack: each route gets its own bundled chunk, so
the flow handler's `@workflow/errors` and the workflow VM bundle's
`@workflow/errors` are two distinct copies of the same module.
Fix:
- Each bundled copy of `@workflow/errors` self-registers its
`FatalError` and `RetryableError` classes on `globalThis` via
`Symbol.for("@workflow/errors//FatalError")` /
`Symbol.for("@workflow/errors//RetryableError")`. First load wins
per realm; the descriptor is non-writable / non-configurable to make
accidental clobbering loud.
- The revivers in `@workflow/core`'s common reducers module read the
consumer's `globalThis` (passed in as `global`) to pick up the
realm-local class, falling back to the host-imported class when no
registration is present (e.g. in the CLI / test runner).
* Use `types.isNativeError` to remap workflow stacks across VM realms
The runtime's run-failure path computes a source-map-remapped stack
and then assigns it back onto the thrown value via `if (err
instanceof Error) err.stack = errorStack`. Workflows run inside a
Node `vm` context, so a workflow-thrown error is an instance of the
VM realm's `Error` — `instanceof` against the host realm's
`Error` returns `false`, the assignment is skipped, and the
serialized `run_failed` event carries the un-remapped (bundled-line-
number) stack instead of the source-mapped one.
Switch the gate to `types.isNativeError`, which uses V8's internal
type tag and works across realms — same approach already in place
for the serialization reducers.
Caught by the local-prod e2e "nested function calls preserve message
and stack trace" and "cross-file imports preserve message and stack
trace" tests, which assert that the persisted run-error stack
contains `99_e2e.ts` / `helpers.ts`.
* Sync CLI revivers with core + add toJSON shim for Error subclasses
Two issues with the CLI's hand-rolled reviver list:
1. It hadn't been updated for the new first-class Error subclass
reducers (`TypeError`, `RangeError`, `FatalError`, `RetryableError`,
etc.). devalue throws "Unknown type X" when it encounters a
reduced value with no matching reviver, and `hydrateResourceIO`
swallows that error and surfaces the raw `Uint8Array` payload —
so `step.error` / `run.error` showed up as raw byte dumps in
`workflow inspect` output.
2. Even with all the right revivers, `Error.prototype`'s `message`
/ `stack` / `cause` are non-enumerable, so `JSON.stringify`
(used by `workflow inspect --json`) drops them — leaving the
subclass-specific enumerable fields (e.g. `FatalError.fatal`)
visible but the actual error data missing.
Fix:
- Build the CLI reviver set on top of `getCommonRevivers()` from
`@workflow/core` so the CLI stays in sync with the runtime's
reducer set automatically. New core reducers/revivers will Just
Work without any CLI-side change.
- Wrap each Error reviver from the common set with a thin shim that
attaches a non-enumerable `toJSON` method to the produced
`Error` instance. `JSON.stringify` calls `toJSON` and gets a
full object (`name` + `message` + `stack` + `cause` + any
enumerable subclass fields like `fatal` / `retryAfter` /
`errors`); `util.inspect` ignores `toJSON` and renders the
canonical `Error: msg\\n at ...` format. Best of both worlds for
CLI output without compromising the runtime hydration path.
Caught by the local-prod e2e "basic step error preserves" and
"cross-file step error preserves" tests, which read
`failedStep.error.message` / `.stack` from the CLI's JSON output.
* Clarify parseErrorJson JSDoc to match its always-null return
The previous JSDoc described preserving legacy values "for best-effort
hydration" which contradicted the implementation, where legacy errors
are intentionally surfaced as absent (the pre-pipeline shapes can't be
hydrated by the new error revivers). Rewrite the comment so the contract
matches behavior. Also rename the now-unused parameter to `_errorJson`
to reflect that the function ignores it.
Caught by a code review on #1851.
* Refine error-handler ergonomics on the step / run hot paths
Three review-driven adjustments that all touch the queue handlers and
their interaction with the error serialization pipeline:
1. Memoize the per-run encryption key fetch. The step handler used to
eagerly fetch + import the key at the top of every step delivery so
the value would be in scope for every potential dehydrateStepError
path. That pessimized step-started early-return cases (the fetch
happens unconditionally even when the step never reaches user code)
and required duplicating the same boilerplate at four call sites in
runtime.ts. Introduce `memoizeEncryptionKey(world, run)` in
runtime/helpers.ts that returns a lazy, single-fetch accessor;
step-handler / runtime call sites use `await getEncryptionKey()`
instead. The first caller pays the fetch cost, subsequent callers
await the cached promise, and steps that fail before any
encryption-aware work happens skip the fetch entirely.
2. Preserve the prior attempt's serialized error as the cause on the
defensive max-retries-exceeded `step_failed` re-invocation guard.
The existing comment explicitly opted out of cause attachment, but
the symmetric post-failure path below already does this and the
reviewer is right that consumers shouldn't have to walk the
step_retrying event history to recover the underlying error. Best-
effort: if hydration of the prior `step.error` throws, fall back
to a FatalError without cause rather than letting the event write
itself fail.
3. Document the intentional `unflatten` throw in
`hydrateStepError` / `hydrateRunError` for non-Uint8Array input.
SDK version is pinned per workflow run via skew protection so the
non-binary branch is dead in production; if a misshapen value
reaches it, surfacing the throw via the surrounding o11y try/catch
is more debuggable than masking it. Add a comment so future
reviewers don't reach for a defensive fallback.
A standalone `falls back to plaintext` suggestion on the run_failed
key fetch was rejected: when encryption is configured we should fail
loudly rather than silently emit plaintext error data. The queue's
redelivery semantics will retry the key fetch; persistent KMS outages
get logged with the existing "persistent error preventing the run from
being terminated" message rather than a security regression.
* Hydrate `event.eventData.error` in event listings
`hydrateEventData` enumerated the per-event fields that need
hydration (`result`, `input`, `output`, `metadata`, `payload`)
but omitted the new `error` field on `step_failed`,
`step_retrying`, and `run_failed` events. Without this branch,
o11y tools that list events (e.g. `workflow inspect events`) surface
the raw `Uint8Array` payload instead of a hydrated
`{ name, message, stack, … }` object even though the entity-level
`Run.error` / `Step.error` paths already hydrate.
Mirrors the existing per-field branches; the `try/catch` leaves the
field un-hydrated on parse failure rather than failing the whole
event view. Adds a unit test.
* Use `.is()` static checks in `classifyRunError` for cross-realm safety
Workflows execute inside a separate `vm` realm: the
`WorkflowRuntimeError` class bundled into the workflow code and the
host-imported one are distinct constructors, so an
`err instanceof WorkflowRuntimeError` check on a VM-thrown error
returns `false` and we'd misclassify genuine runtime errors (corrupted
event log, missing timestamps, workflow/step not registered) as user
errors.
Switch to each subclass's `.is()` static (a name-based duck check that
works across realms). Since `WorkflowRuntimeError.is` only matches its
own concrete name, enumerate every concrete subclass we want to
recognize (`StepNotRegisteredError`, `WorkflowNotRegisteredError`)
in a `RUNTIME_ERROR_CHECKS` table; keep that table in sync with the
class hierarchy in `@workflow/errors`.
Existing `classify-error.test.ts` already covers `WorkflowRuntimeError`
and `WorkflowNotRegisteredError` cases — both still pass.
* Add e2e coverage for step throws of non-Error values
We had `errorWorkflowThrowNonErrorValue` (workflow body throws a plain
object — round-trips verbatim as `WorkflowRunFailedError.cause`) but
no symmetric coverage for the step-throw side. Step-throw goes through
a different code path: non-Error values aren't recognized as
`FatalError` (no `name === 'FatalError'`) nor `RetryableError`,
so they take the transient retry path. After max retries the runtime
wraps the original thrown value as `cause` on a fresh `FatalError`
which the workflow's catch block then sees.
Add a workflow that throws a recognizable plain object from a step
with `maxRetries = 0` (so we exhaust on first attempt and avoid a
long test wait) and a workflow that asserts the wrapped FatalError
shape: `isFatal`, `instanceof FatalError`, message includes the
original object's serialized form, `cause` is the original non-Error
object verbatim with structure preserved.
Documents the current retry-then-wrap behavior so any future change
to "non-Error throws skip retries" semantics has to update the test.
* Note legacy postgres error-data loss in the run/step error changeset
Pre-upgrade failed runs that wrote into world-postgres's deprecated
`error` text column can't be hydrated through the new pipeline (the
shape is incompatible with the new revivers). The new runtime
intentionally surfaces them as `error: undefined` on read; the
original payload is still readable directly from the `errorJson`
column for manual inspection. Add a one-sentence note to the
changeset's migration text so consumers upgrading don't get blindsided
by suddenly-empty error fields on historical runs.
The previous pre-release versions (4.x.y-beta.N) caused two issues:
- semver.inc('4.0.0-beta.N', 'major') returns 4.0.0, not 5.0.0
- Pre-release numbers carried over (beta.61 -> beta.62 instead of beta.0)
Setting all versions to 4.0.0 (non-pre-release) ensures a clean major
bump to 5.0.0-beta.0. Also removes @workflow/swc-playground-wasm from
the changeset and pre.json since it is a private package.
* feat: export semantic error types and add API reference documentation
Add missing error exports (HookNotFoundError, EntityConflictError,
RunExpiredError, TooEarlyError, ThrottleError, RunNotSupportedError,
WorkflowWorldError) to workflow/internal/errors. Create new error
classes for world-level semantics. Tighten TSDoc comments on all
error classes. Add API reference docs for all error types.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: use @setup declarations, workflow/errors import, and errors/ doc section
- Replace @skip-typecheck with proper `declare` + `// @setup` lines
so code samples are typechecked but setup lines hidden from readers
- Add `workflow/errors` export to package.json (public API, replaces
`workflow/internal/errors` in docs)
- Add `workflow/errors` path mapping in docs-typecheck type-checker
- Add HookConflictError to re-export list
- Move all error docs under api-reference/workflow/errors/ subdirectory
- Update all internal cross-references and links
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* refactor: move error docs to top-level workflow-errors section
- Move semantic error docs to api-reference/workflow-errors/ (matching
the workflow/errors import path, like workflow-api for workflow/api)
- Keep FatalError and RetryableError in api-reference/workflow/ since
they're imported from workflow, not workflow/errors
- Fix all cross-reference links
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* chore: update HTTP debug logger JSDoc to clarify scope
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: make TooEarlyError.retryAfter a number (seconds) matching WorkflowWorldError
TooEarlyError.retryAfter is now seconds (number) instead of a Date,
consistent with ThrottleError and WorkflowWorldError. The conversion
from seconds to Date is done at the consumer site (step-handler) rather
than at construction time.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: address review feedback on docs accuracy
- WorkflowWorldError docs: add status, code, url, retryAfter properties
to TSDoc; clarify that .is() only matches direct instances (not
subclasses); use instanceof in catch-all example
- TooEarlyError/ThrottleError docs: mark retryAfter as optional (?)
to match actual type definitions
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* feat: add stepName field for human-readable step names
Slack-Thread: https://vercel.slack.com/archives/C09125LC4AX/p1773936163539109?thread_ts=1773936163.539109&cid=C09125LC4AX
Co-authored-by: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
* docs: add step examples with resolveData and hydration, document parseStepName/parseWorkflowName utilities
- Split step examples into two: one with resolveData: 'none' for efficient listing without data, and one showing how to hydrate input/output with observabilityRevivers
- Add TSDoc to stepName and workflowName fields explaining the machine-readable format and how to use parse utilities
- Document parseStepName() and parseWorkflowName() from @workflow/utils/parse-name for extracting shortName and moduleSpecifier for UI display
- Add Callout explaining the naming format
---------
Co-authored-by: v0 <v0[bot]@users.noreply.github.com>
Co-authored-by: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
Pranay Prakash