Repository navigation
fix(core): preserve replay order for hook registration outcomes - #4215
Conversation
Signed-off-by: Jude Gao <32973745+gaojude@users.noreply.github.com>
🦋 Changeset detectedLatest commit: 27a7db1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 16 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
🧪 E2E Test Results✅ All tests passed
|
| Passed | Failed | Skipped | Total | |
|---|---|---|---|---|
| ✅ ▲ Vercel Production | 3662 | 0 | 685 | 4347 |
| ✅ 💻 Local Development | 3998 | 0 | 510 | 4508 |
| ✅ 📦 Local Production | 3998 | 0 | 510 | 4508 |
| ✅ 🐘 Local Postgres | 3998 | 0 | 510 | 4508 |
| ✅ 🪟 Windows | 320 | 0 | 2 | 322 |
| ✅ 🌐 Cross-language Conformance | 68 | 0 | 74 | 142 |
| ✅ vercel-http-transport | 823 | 0 | 143 | 966 |
| ✅ vercel-multi-region | 27 | 0 | 0 | 27 |
| ✅ vercel-ws-transport | 557 | 0 | 87 | 644 |
| Total | 17451 | 0 | 2521 | 19972 |
Details by Category
✅ ▲ Vercel Production
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-node | 133 | 0 | 28 |
| ✅ astro-quickjs | 133 | 0 | 28 |
| ✅ example-node | 133 | 0 | 28 |
| ✅ example-quickjs | 133 | 0 | 28 |
| ✅ express-node | 133 | 0 | 28 |
| ✅ express-quickjs | 133 | 0 | 28 |
| ✅ fastify-node | 133 | 0 | 28 |
| ✅ fastify-quickjs | 133 | 0 | 28 |
| ✅ hono-node | 133 | 0 | 28 |
| ✅ hono-quickjs | 133 | 0 | 28 |
| ✅ nest-node | 133 | 0 | 28 |
| ✅ nest-quickjs | 133 | 0 | 28 |
| ✅ nextjs-turbopack-node | 158 | 0 | 3 |
| ✅ nextjs-turbopack-quickjs | 158 | 0 | 3 |
| ✅ nextjs-webpack-node | 158 | 0 | 3 |
| ✅ nextjs-webpack-quickjs | 158 | 0 | 3 |
| ✅ nitro-node | 133 | 0 | 28 |
| ✅ nitro-quickjs | 133 | 0 | 28 |
| ✅ nuxt-node | 133 | 0 | 28 |
| ✅ nuxt-quickjs | 133 | 0 | 28 |
| ✅ python-node | 66 | 0 | 95 |
| ✅ sveltekit-node | 152 | 0 | 9 |
| ✅ sveltekit-quickjs | 152 | 0 | 9 |
| ✅ tanstack-start-node | 133 | 0 | 28 |
| ✅ tanstack-start-quickjs | 133 | 0 | 28 |
| ✅ vite-node | 133 | 0 | 28 |
| ✅ vite-quickjs | 133 | 0 | 28 |
✅ 💻 Local Development
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-stable-node | 134 | 0 | 27 |
| ✅ astro-stable-quickjs | 134 | 0 | 27 |
| ✅ express-stable-node | 134 | 0 | 27 |
| ✅ express-stable-quickjs | 134 | 0 | 27 |
| ✅ fastify-stable-node | 134 | 0 | 27 |
| ✅ fastify-stable-quickjs | 134 | 0 | 27 |
| ✅ hono-stable-node | 134 | 0 | 27 |
| ✅ hono-stable-quickjs | 134 | 0 | 27 |
| ✅ nest-stable-node | 134 | 0 | 27 |
| ✅ nest-stable-quickjs | 134 | 0 | 27 |
| ✅ nextjs-turbopack-canary-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-canary-quickjs | 160 | 0 | 1 |
| ✅ nextjs-turbopack-stable-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-stable-quickjs | 160 | 0 | 1 |
| ✅ nextjs-webpack-canary-node | 160 | 0 | 1 |
| ✅ nextjs-webpack-canary-quickjs | 160 | 0 | 1 |
| ✅ nextjs-webpack-stable-node | 160 | 0 | 1 |
| ✅ nextjs-webpack-stable-quickjs | 160 | 0 | 1 |
| ✅ nitro-stable-node | 134 | 0 | 27 |
| ✅ nitro-stable-quickjs | 134 | 0 | 27 |
| ✅ nuxt-stable-node | 134 | 0 | 27 |
| ✅ nuxt-stable-quickjs | 134 | 0 | 27 |
| ✅ sveltekit-stable-node | 153 | 0 | 8 |
| ✅ sveltekit-stable-quickjs | 153 | 0 | 8 |
| ✅ tanstack-start-node | 134 | 0 | 27 |
| ✅ tanstack-start-quickjs | 134 | 0 | 27 |
| ✅ vite-stable-node | 134 | 0 | 27 |
| ✅ vite-stable-quickjs | 134 | 0 | 27 |
✅ 📦 Local Production
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-stable-node | 134 | 0 | 27 |
| ✅ astro-stable-quickjs | 134 | 0 | 27 |
| ✅ express-stable-node | 134 | 0 | 27 |
| ✅ express-stable-quickjs | 134 | 0 | 27 |
| ✅ fastify-stable-node | 134 | 0 | 27 |
| ✅ fastify-stable-quickjs | 134 | 0 | 27 |
| ✅ hono-stable-node | 134 | 0 | 27 |
| ✅ hono-stable-quickjs | 134 | 0 | 27 |
| ✅ nest-stable-node | 134 | 0 | 27 |
| ✅ nest-stable-quickjs | 134 | 0 | 27 |
| ✅ nextjs-turbopack-canary-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-canary-quickjs | 160 | 0 | 1 |
| ✅ nextjs-turbopack-stable-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-stable-quickjs | 160 | 0 | 1 |
| ✅ nextjs-webpack-canary-node | 160 | 0 | 1 |
| ✅ nextjs-webpack-canary-quickjs | 160 | 0 | 1 |
| ✅ nextjs-webpack-stable-node | 160 | 0 | 1 |
| ✅ nextjs-webpack-stable-quickjs | 160 | 0 | 1 |
| ✅ nitro-stable-node | 134 | 0 | 27 |
| ✅ nitro-stable-quickjs | 134 | 0 | 27 |
| ✅ nuxt-stable-node | 134 | 0 | 27 |
| ✅ nuxt-stable-quickjs | 134 | 0 | 27 |
| ✅ sveltekit-stable-node | 153 | 0 | 8 |
| ✅ sveltekit-stable-quickjs | 153 | 0 | 8 |
| ✅ tanstack-start-node | 134 | 0 | 27 |
| ✅ tanstack-start-quickjs | 134 | 0 | 27 |
| ✅ vite-stable-node | 134 | 0 | 27 |
| ✅ vite-stable-quickjs | 134 | 0 | 27 |
✅ 🐘 Local Postgres
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-stable-node | 134 | 0 | 27 |
| ✅ astro-stable-quickjs | 134 | 0 | 27 |
| ✅ express-stable-node | 134 | 0 | 27 |
| ✅ express-stable-quickjs | 134 | 0 | 27 |
| ✅ fastify-stable-node | 134 | 0 | 27 |
| ✅ fastify-stable-quickjs | 134 | 0 | 27 |
| ✅ hono-stable-node | 134 | 0 | 27 |
| ✅ hono-stable-quickjs | 134 | 0 | 27 |
| ✅ nest-stable-node | 134 | 0 | 27 |
| ✅ nest-stable-quickjs | 134 | 0 | 27 |
| ✅ nextjs-turbopack-canary-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-canary-quickjs | 160 | 0 | 1 |
| ✅ nextjs-turbopack-stable-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-stable-quickjs | 160 | 0 | 1 |
| ✅ nextjs-webpack-canary-node | 160 | 0 | 1 |
| ✅ nextjs-webpack-canary-quickjs | 160 | 0 | 1 |
| ✅ nextjs-webpack-stable-node | 160 | 0 | 1 |
| ✅ nextjs-webpack-stable-quickjs | 160 | 0 | 1 |
| ✅ nitro-stable-node | 134 | 0 | 27 |
| ✅ nitro-stable-quickjs | 134 | 0 | 27 |
| ✅ nuxt-stable-node | 134 | 0 | 27 |
| ✅ nuxt-stable-quickjs | 134 | 0 | 27 |
| ✅ sveltekit-stable-node | 153 | 0 | 8 |
| ✅ sveltekit-stable-quickjs | 153 | 0 | 8 |
| ✅ tanstack-start-node | 134 | 0 | 27 |
| ✅ tanstack-start-quickjs | 134 | 0 | 27 |
| ✅ vite-stable-node | 134 | 0 | 27 |
| ✅ vite-stable-quickjs | 134 | 0 | 27 |
✅ 🪟 Windows
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ nextjs-turbopack-node | 160 | 0 | 1 |
| ✅ nextjs-turbopack-quickjs | 160 | 0 | 1 |
✅ 🌐 Cross-language Conformance
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ python | 68 | 0 | 74 |
✅ vercel-http-transport
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ example | 133 | 0 | 28 |
| ✅ express | 133 | 0 | 28 |
| ✅ hono | 133 | 0 | 28 |
| ✅ nextjs-turbopack | 158 | 0 | 3 |
| ✅ nitro | 133 | 0 | 28 |
| ✅ vite | 133 | 0 | 28 |
✅ vercel-multi-region
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ nextjs-turbopack | 27 | 0 | 0 |
✅ vercel-ws-transport
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ example | 133 | 0 | 28 |
| ✅ express | 133 | 0 | 28 |
| ✅ nextjs-turbopack | 158 | 0 | 3 |
| ✅ vite | 133 | 0 | 28 |
📊 Workflow Benchmarkscommit Backend:
Streams
📈 STSO distribution vs main (inline / queue-hop histograms)1020 steps (inline) Cumulative STSO time: main 192073ms → this run 141113ms (Δ -50960ms, -27%) 📈 CRTT drill-down vs main (RTT distributions & profiles)RTT over stream progress (avg per tenth of stream, bars scaled min→max): RTT by chunk size (avg per log size bin, ~160B → ~12KB serialized, bars scaled min→max): Delivery jitter over stream progress (avg positive CDV per tenth of stream, bars scaled min→max): ℹ️ Metric definitions & methodologyStreams: first-chunk RTT (the stream-open path, before any buffering/backpressure), CRTT percentiles, and worst delivery stall (CDV max). Cells are medians across iterations; per-run values in the artifacts. No 🔴/🟢 marks until targets attach. The collapsed STSO distribution section above buckets every step gap, split inline (same warm process — pure framework overhead) vs queue-hop (fresh process — dispatch, reinit, replay). The collapsed CRTT drill-down: per-variant RTT histograms (fixed log bins, Best/P75/P90/P99 deltas compare against the most recent benchmark run on Metrics — TTFS: time to first step body (in-deployment start() → first step body) · Fan-out TTFS: fan-out time to first step (in-deployment start() → first of the parallel step bodies to complete) · Fan-out TTLS: fan-out time to last step (in-deployment start() → last of the parallel step bodies to complete, i.e. when the Promise.all resolves) · STSO: step-to-step overhead (gap between consecutive step bodies) · WO: workflow overhead (whole-run time outside step bodies, in-deployment anchored) · CRTT: chunk round-trip time (per-chunk write → read latency, one clock domain: deployment → stream backend → same deployment) · CDV: chunk delay variation / delivery jitter (inter-arrival gap minus inter-write gap per seq-adjacent pair; skew-free; the row is each run's MAX positive value, so one stall moves it) Scenarios — step: one trivial no-op step, no stream; no hooks, so the run stays in turbo mode (in-process fast path) · stream: one streaming step; no hooks, so the run stays in turbo mode (in-process fast path) · hook + stream: registers a hook before one step, which exits turbo mode (dispatch path) · 1020 steps: 1020 trivial sequential steps; STSO is measured between consecutive steps in the given step ranges, and WO is the whole-run overhead outside step bodies · Promise.all(100 steps): 100 trivial no-op steps started together in a single Promise.all; Fan-out TTFS is the first of them to complete and Fan-out TTLS the last, both from the in-deployment clientStart, so their gap is the spread the runtime adds across the fan-out · paced control (100/s, 60B): the control: 300 tiny (~60B) deltas metronome-paced at 100/s — zero workload structure, so it reads the transport floor and flush cadence, and disambiguates transport-wide vs workload-specific when a replay row moves · size sweep (100/s, 160B-12KB): same pacing as the control with deltas padded in rotation across seven log-spaced sizes (~160B–12KB) — rotation decouples size from stream position, so it isolates whether chunk size causes latency · replay gateway-gpt-5.4-nano-2000t (1x): raw provider SSE cadence captured at the AI gateway boundary (gpt-5.4-nano, the most popular gateway model; per-token deltas p50 208B = the modal production chunk size), replayed exactly as measured — the typical customer's workload; its CDV is the typical customer's real delivery jitter · replay eve-gpt-5.6-sol-2000t (1x): a captured eve turn (gpt-5.6-sol, the most-used demanding eve model; ~2000 output tokens = production p50 turn length) replayed exactly as measured — eve's envelope protocol re-ships the cumulative message so sizes ramp 142B→13KB; the demanding outlier tenant's reality · replay eve-gpt-5.6-sol-2000t (2x): the same eve capture at 2x — the headroom/stress row; real fast-tier models emit the same chunk sizes at proportionally higher rate, so time compression is a faithful speed model · first chunk (pooled): every run's seq-0 RTT pooled across all stream scenarios — the first chunk precedes any workload differentiation, so pooling samples one shared stream-open path with exact percentiles Replay cadences (semantic sha256) — eve-gpt-5.6-sol-2000t 🔴 marks a percentile over its target (within target is left unmarked). Targets (p75/p90/p99, ms) — TTFS 200/300/600 All timestamps are deployment-side; runs are triggered in-deployment, so the CI runner and api.vercel.com sit outside every measured window. TTFS = Cold starts stay in the numbers (real bursty-workload latency, inflates P75+); Best is the warm floor. |
Sim WorldSimulated world deterministic testing for races. Traces 🟠 world-sim scenario book — 1 fail of 41 total
Full trace: |
About these numbersSizes are gzip; parentheses show the change against
|
Signed-off-by: Jude Gao <32973745+gaojude@users.noreply.github.com> Signed-off-by: Jude Gao <jude.gao@vercel.com>
|
Backport PR opened against |
…edAt hook_created and hook_conflict now advance the clock through the barrier release that main already hands them over on, instead of the explicit advanceClock calls this branch added before that barrier existed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* [core] Anchor the replay clock to deliveries, not consumption The VM's Date.now() advanced in EventsConsumer.onConsumedEvent, i.e. when the walk read an event. The walk runs ahead of delivery: within one drain window it consumes every event whose consumer exists, so a hook_received for a hook the workflow has not read, or a sibling step's later result, was consumed while an earlier delivery still sat on its barrier, and its timestamp leaked into that delivery's cascade. Date.now() at a body position then depended on how much log the replay held: the writing execution saw the heartbeat's time, a later replay holding one more payload saw the payload's. A workflow whose control flow reads the clock (an idle loop budgeted by Date.now(), a deadline) drew different ordinals in different replays and died CORRUPTED_EVENT_LOG. This is the production wake-loop family of the 2026-08-31 beta.46 spike: step and heartbeat wait bound to one ordinal by the same invocation a second apart, with the wait's resumeAt computed from the earlier step's completion time. The clock now advances in registerDeliveryBarrier's markDelivered, with the delivered event's createdAt, for step results, hook payloads, wait completions and aborts. Deliveries reach the workflow in log order, so the clock a cascade observes is a function of the log prefix. The long-parked it.fails "should maintain determinism of Date across executions" (a race of two sleeps) passes and is flipped to it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Apply suggestion from @VaguelySerious Signed-off-by: Peter Wielander <mittgfu@gmail.com> * docs: say when the workflow clock advances Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Address review: registration outcomes advance the clock; deliveredAt required; more cases hook_created and hook_conflict settle awaiters the workflow is blocked on, so they are deliveries and now advance the clock in their settlement slots (they registered no barrier on this branch and had stopped moving it, a regression against main). registerDeliveryBarrier requires deliveredAt so a new delivery site cannot forget the clock, with one hoisted deliver() closure behind both handle shapes. Tests cover the buffered-payload claim (a delivery carrying an older time than the clock), both registration outcomes, and aborts. Comments that described the consumption-anchored clock are updated, and the QuickJS note now says that engine still advances per event and why that is prefix-stable there. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Rebase onto main: the registration barrier from #4215 carries deliveredAt hook_created and hook_conflict now advance the clock through the barrier release that main already hands them over on, instead of the explicit advanceClock calls this branch added before that barrier existed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Apply suggestion from @VaguelySerious Signed-off-by: Peter Wielander <mittgfu@gmail.com> --------- Signed-off-by: Peter Wielander <mittgfu@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* [core] Anchor the replay clock to deliveries, not consumption The VM's Date.now() advanced in EventsConsumer.onConsumedEvent, i.e. when the walk read an event. The walk runs ahead of delivery: within one drain window it consumes every event whose consumer exists, so a hook_received for a hook the workflow has not read, or a sibling step's later result, was consumed while an earlier delivery still sat on its barrier, and its timestamp leaked into that delivery's cascade. Date.now() at a body position then depended on how much log the replay held: the writing execution saw the heartbeat's time, a later replay holding one more payload saw the payload's. A workflow whose control flow reads the clock (an idle loop budgeted by Date.now(), a deadline) drew different ordinals in different replays and died CORRUPTED_EVENT_LOG. This is the production wake-loop family of the 2026-08-31 beta.46 spike: step and heartbeat wait bound to one ordinal by the same invocation a second apart, with the wait's resumeAt computed from the earlier step's completion time. The clock now advances in registerDeliveryBarrier's markDelivered, with the delivered event's createdAt, for step results, hook payloads, wait completions and aborts. Deliveries reach the workflow in log order, so the clock a cascade observes is a function of the log prefix. The long-parked it.fails "should maintain determinism of Date across executions" (a race of two sleeps) passes and is flipped to it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Apply suggestion from @VaguelySerious Signed-off-by: Peter Wielander <mittgfu@gmail.com> * docs: say when the workflow clock advances Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Address review: registration outcomes advance the clock; deliveredAt required; more cases hook_created and hook_conflict settle awaiters the workflow is blocked on, so they are deliveries and now advance the clock in their settlement slots (they registered no barrier on this branch and had stopped moving it, a regression against main). registerDeliveryBarrier requires deliveredAt so a new delivery site cannot forget the clock, with one hoisted deliver() closure behind both handle shapes. Tests cover the buffered-payload claim (a delivery carrying an older time than the clock), both registration outcomes, and aborts. Comments that described the consumption-anchored clock are updated, and the QuickJS note now says that engine still advances per event and why that is prefix-stable there. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Rebase onto main: the registration barrier from #4215 carries deliveredAt hook_created and hook_conflict now advance the clock through the barrier release that main already hands them over on, instead of the explicit advanceClock calls this branch added before that barrier existed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Apply suggestion from @VaguelySerious Signed-off-by: Peter Wielander <mittgfu@gmail.com> --------- Signed-off-by: Peter Wielander <mittgfu@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Peter Wielander <mittgfu@gmail.com>
…n outcomes (#4220) Automated backport of #4215 to `stable` ([backport job run](https://github.com/vercel/workflow/actions/runs/35239340733)). Signed-off-by: Jude Gao <jude.gao@vercel.com> Co-authored-by: Peter Wielander <mittgfu@gmail.com> Co-authored-by: Jude Gao <jude.gao@vercel.com>
) Closes #4770. ### Problem When `setAttributes()` resolves, its `attr_set` acknowledgement settled straight off `promiseQueue` without registering a delivery barrier. Every other delivery that resumes a branch (step results, waits, hook payloads and, since #4215, hook registration outcomes) registers one and waits for earlier deliveries. A branch awaiting `setAttributes()` could therefore resume ahead of a sibling's step result that comes earlier in the log, and draw that sibling's next correlation ID. Depending on what the sibling draws next, the run either fails with `REPLAY_DIVERGENCE`, or both branches call the same step and silently receive each other's results. ### Fix - Add an `attribute` `DeliveryKind`. It defers behind every earlier kind, and every kind defers behind an earlier `attribute`. Like a step, it skips unclaimed buffered hook payloads, because resolving it never depends on a hook read. - `attribute-dispatcher.ts` registers the barrier and captures `awaitEarlierDeliveries` when it consumes the event, then resolves from a continuation that is detached from the queue tail, following the same pattern as `sleep.ts`. - `setAttributes()` resolution still does not move the workflow clock. `registerDeliveryBarrier` now accepts `deliveredAt: null` to opt out explicitly. - The QuickJS runtime needs no change. It delivers events strictly in log order and drains jobs after each one. Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Description
A workflow that concurrently awaits a sleep/hook registration and a read/save chain can replay a longer history with
starttaking the correlation ID already committed forsave:hook_createdandhook_conflictsettled directly throughpromiseQueue. An earlier step result can still be parked behind a wait after that queue drains, allowing the registration acknowledgement to resume its branch first. ThehasCreated/hasConflictfast paths have the same gap. This remains reproducible on main at59a7c5bb, after #3139 and #3406.Register hook outcomes with the existing delivery barriers, capture their predecessors when consuming the event, and settle off the serial queue. Late registration/conflict awaits share that delivery gate. The delivery runs even without an existing awaiter, so the armed barrier cannot wait indefinitely for workflow code to claim it.
How did you test your changes?
runWorkflow,replayWorkflow, andresumeWorkflowengines. It learns IDs from a shorter history and checks the extended history through suspension and completion, with cold/warm payload caches, both log-order-draws modes, registration/conflict outcomes, and buffered payloads left unread or claimed after registration.hook.tswhile keeping these tests: 14 failed, 2 passed; the replay failures show the mismatch above. With the fix all 16 pass.WORKFLOW_TARGET_WORLD=local vitest run packages/core/src packages/core/e2e/utils.test.ts): 117 files passed; 2,537 tests passed, 3 expected failures, 1 skipped.git diff --checkpass. Biome reports existing warnings.The regression needs no deployment or external workflow executions. Hosted/deployment E2E suites were not run.
PR Checklist - Required to merge
@workflow/corecreated withpnpm changeset add@vercel/workflowwhen ready for review (this PR is a draft)