Repository navigation
[docs] Add a dynamic workflows cookbook recipe backed by e2e fixtures - #4541
alangenfeld wants to merge 11 commits into
Conversation
🦋 Changeset detectedLatest commit: 9bc079b The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types 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 |
📊 Workflow Benchmarkscommit Backend:
Streams
📈 STSO distribution vs main (inline / queue-hop histograms)1020 steps (inline) Cumulative STSO time: main 141207ms → this run 169824ms (Δ +28617ms, +20%) 📈 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. |
🧪 E2E Test Results❌ Some tests failed ❌ Failed E2E Tests💻 Local Development (1 failed)astro-stable-node (1 failed):
|
| Passed | Failed | Skipped | Total | |
|---|---|---|---|---|
| ✅ ▲ Vercel Production | 3904 | 0 | 1253 | 5157 |
| ❌ 💻 Local Development | 4987 | 1 | 551 | 5539 |
| ✅ 📦 Local Production | 4988 | 0 | 551 | 5539 |
| ✅ 🐘 Local Postgres | 4988 | 0 | 551 | 5539 |
| ✅ 🪟 Windows | 342 | 0 | 40 | 382 |
| ✅ 🌐 Cross-language Conformance | 68 | 0 | 84 | 152 |
| ✅ dynamic-runs | 0 | 0 | 0 | 0 |
| ✅ vercel-http-transport | 879 | 0 | 267 | 1146 |
| ✅ vercel-multi-region | 27 | 0 | 0 | 27 |
| ✅ vercel-ws-transport | 595 | 0 | 169 | 764 |
| Total | 20778 | 1 | 3466 | 24245 |
Details by Category
✅ ▲ Vercel Production
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-node | 142 | 0 | 49 |
| ✅ astro-quickjs | 142 | 0 | 49 |
| ✅ example-node | 142 | 0 | 49 |
| ✅ example-quickjs | 142 | 0 | 49 |
| ✅ express-node | 142 | 0 | 49 |
| ✅ express-quickjs | 142 | 0 | 49 |
| ✅ fastify-node | 142 | 0 | 49 |
| ✅ fastify-quickjs | 142 | 0 | 49 |
| ✅ hono-node | 142 | 0 | 49 |
| ✅ hono-quickjs | 142 | 0 | 49 |
| ✅ nest-node | 142 | 0 | 49 |
| ✅ nest-quickjs | 142 | 0 | 49 |
| ✅ nextjs-turbopack-node | 169 | 0 | 22 |
| ✅ nextjs-turbopack-quickjs | 169 | 0 | 22 |
| ✅ nextjs-webpack-node | 169 | 0 | 22 |
| ✅ nextjs-webpack-quickjs | 169 | 0 | 22 |
| ✅ nitro-node | 142 | 0 | 49 |
| ✅ nitro-quickjs | 142 | 0 | 49 |
| ✅ nuxt-node | 142 | 0 | 49 |
| ✅ nuxt-quickjs | 142 | 0 | 49 |
| ✅ python-node | 66 | 0 | 125 |
| ✅ sveltekit-node | 161 | 0 | 30 |
| ✅ sveltekit-quickjs | 161 | 0 | 30 |
| ✅ tanstack-start-node | 142 | 0 | 49 |
| ✅ tanstack-start-quickjs | 142 | 0 | 49 |
| ✅ vite-node | 142 | 0 | 49 |
| ✅ vite-quickjs | 142 | 0 | 49 |
❌ 💻 Local Development
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ❌ astro-stable-node | 161 | 1 | 29 |
| ✅ astro-stable-quickjs | 162 | 0 | 29 |
| ✅ express-stable-node | 162 | 0 | 29 |
| ✅ express-stable-quickjs | 162 | 0 | 29 |
| ✅ fastify-stable-node | 162 | 0 | 29 |
| ✅ fastify-stable-quickjs | 162 | 0 | 29 |
| ✅ hono-stable-node | 162 | 0 | 29 |
| ✅ hono-stable-quickjs | 162 | 0 | 29 |
| ✅ nest-stable-node | 162 | 0 | 29 |
| ✅ nest-stable-quickjs | 162 | 0 | 29 |
| ✅ nextjs-turbopack-canary-node | 190 | 0 | 1 |
| ✅ nextjs-turbopack-canary-quickjs | 190 | 0 | 1 |
| ✅ nextjs-turbopack-quickjs-snapshot | 190 | 0 | 1 |
| ✅ nextjs-turbopack-stable-node | 190 | 0 | 1 |
| ✅ nextjs-turbopack-stable-quickjs | 190 | 0 | 1 |
| ✅ nextjs-webpack-canary-node | 190 | 0 | 1 |
| ✅ nextjs-webpack-canary-quickjs | 190 | 0 | 1 |
| ✅ nextjs-webpack-stable-node | 190 | 0 | 1 |
| ✅ nextjs-webpack-stable-quickjs | 190 | 0 | 1 |
| ✅ nitro-stable-node | 162 | 0 | 29 |
| ✅ nitro-stable-quickjs | 162 | 0 | 29 |
| ✅ nuxt-stable-node | 162 | 0 | 29 |
| ✅ nuxt-stable-quickjs | 162 | 0 | 29 |
| ✅ sveltekit-stable-node | 181 | 0 | 10 |
| ✅ sveltekit-stable-quickjs | 181 | 0 | 10 |
| ✅ tanstack-start-node | 162 | 0 | 29 |
| ✅ tanstack-start-quickjs | 162 | 0 | 29 |
| ✅ vite-stable-node | 162 | 0 | 29 |
| ✅ vite-stable-quickjs | 162 | 0 | 29 |
✅ 📦 Local Production
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-stable-node | 162 | 0 | 29 |
| ✅ astro-stable-quickjs | 162 | 0 | 29 |
| ✅ express-stable-node | 162 | 0 | 29 |
| ✅ express-stable-quickjs | 162 | 0 | 29 |
| ✅ fastify-stable-node | 162 | 0 | 29 |
| ✅ fastify-stable-quickjs | 162 | 0 | 29 |
| ✅ hono-stable-node | 162 | 0 | 29 |
| ✅ hono-stable-quickjs | 162 | 0 | 29 |
| ✅ nest-stable-node | 162 | 0 | 29 |
| ✅ nest-stable-quickjs | 162 | 0 | 29 |
| ✅ nextjs-turbopack-canary-node | 190 | 0 | 1 |
| ✅ nextjs-turbopack-canary-quickjs | 190 | 0 | 1 |
| ✅ nextjs-turbopack-quickjs-snapshot | 190 | 0 | 1 |
| ✅ nextjs-turbopack-stable-node | 190 | 0 | 1 |
| ✅ nextjs-turbopack-stable-quickjs | 190 | 0 | 1 |
| ✅ nextjs-webpack-canary-node | 190 | 0 | 1 |
| ✅ nextjs-webpack-canary-quickjs | 190 | 0 | 1 |
| ✅ nextjs-webpack-stable-node | 190 | 0 | 1 |
| ✅ nextjs-webpack-stable-quickjs | 190 | 0 | 1 |
| ✅ nitro-stable-node | 162 | 0 | 29 |
| ✅ nitro-stable-quickjs | 162 | 0 | 29 |
| ✅ nuxt-stable-node | 162 | 0 | 29 |
| ✅ nuxt-stable-quickjs | 162 | 0 | 29 |
| ✅ sveltekit-stable-node | 181 | 0 | 10 |
| ✅ sveltekit-stable-quickjs | 181 | 0 | 10 |
| ✅ tanstack-start-node | 162 | 0 | 29 |
| ✅ tanstack-start-quickjs | 162 | 0 | 29 |
| ✅ vite-stable-node | 162 | 0 | 29 |
| ✅ vite-stable-quickjs | 162 | 0 | 29 |
✅ 🐘 Local Postgres
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-stable-node | 162 | 0 | 29 |
| ✅ astro-stable-quickjs | 162 | 0 | 29 |
| ✅ express-stable-node | 162 | 0 | 29 |
| ✅ express-stable-quickjs | 162 | 0 | 29 |
| ✅ fastify-stable-node | 162 | 0 | 29 |
| ✅ fastify-stable-quickjs | 162 | 0 | 29 |
| ✅ hono-stable-node | 162 | 0 | 29 |
| ✅ hono-stable-quickjs | 162 | 0 | 29 |
| ✅ nest-stable-node | 162 | 0 | 29 |
| ✅ nest-stable-quickjs | 162 | 0 | 29 |
| ✅ nextjs-turbopack-canary-node | 190 | 0 | 1 |
| ✅ nextjs-turbopack-canary-quickjs | 190 | 0 | 1 |
| ✅ nextjs-turbopack-quickjs-snapshot | 190 | 0 | 1 |
| ✅ nextjs-turbopack-stable-node | 190 | 0 | 1 |
| ✅ nextjs-turbopack-stable-quickjs | 190 | 0 | 1 |
| ✅ nextjs-webpack-canary-node | 190 | 0 | 1 |
| ✅ nextjs-webpack-canary-quickjs | 190 | 0 | 1 |
| ✅ nextjs-webpack-stable-node | 190 | 0 | 1 |
| ✅ nextjs-webpack-stable-quickjs | 190 | 0 | 1 |
| ✅ nitro-stable-node | 162 | 0 | 29 |
| ✅ nitro-stable-quickjs | 162 | 0 | 29 |
| ✅ nuxt-stable-node | 162 | 0 | 29 |
| ✅ nuxt-stable-quickjs | 162 | 0 | 29 |
| ✅ sveltekit-stable-node | 181 | 0 | 10 |
| ✅ sveltekit-stable-quickjs | 181 | 0 | 10 |
| ✅ tanstack-start-node | 162 | 0 | 29 |
| ✅ tanstack-start-quickjs | 162 | 0 | 29 |
| ✅ vite-stable-node | 162 | 0 | 29 |
| ✅ vite-stable-quickjs | 162 | 0 | 29 |
✅ 🪟 Windows
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ nextjs-turbopack-node | 171 | 0 | 20 |
| ✅ nextjs-turbopack-quickjs | 171 | 0 | 20 |
✅ 🌐 Cross-language Conformance
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ python | 68 | 0 | 84 |
✅ dynamic-runs
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ astro-vercel | 0 | 0 | 0 |
| ✅ example-vercel | 0 | 0 | 0 |
| ✅ express-vercel | 0 | 0 | 0 |
| ✅ fastify-vercel | 0 | 0 | 0 |
| ✅ hono-vercel | 0 | 0 | 0 |
| ✅ nest-vercel | 0 | 0 | 0 |
| ✅ nextjs-turbopack-vercel | 0 | 0 | 0 |
| ✅ nextjs-webpack-vercel | 0 | 0 | 0 |
| ✅ nitro-vercel | 0 | 0 | 0 |
| ✅ nuxt-vercel | 0 | 0 | 0 |
| ✅ sveltekit-vercel | 0 | 0 | 0 |
| ✅ tanstack-start-vercel | 0 | 0 | 0 |
| ✅ vite-vercel | 0 | 0 | 0 |
✅ vercel-http-transport
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ example | 142 | 0 | 49 |
| ✅ express | 142 | 0 | 49 |
| ✅ hono | 142 | 0 | 49 |
| ✅ nextjs-turbopack | 169 | 0 | 22 |
| ✅ nitro | 142 | 0 | 49 |
| ✅ vite | 142 | 0 | 49 |
✅ vercel-multi-region
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ nextjs-turbopack | 27 | 0 | 0 |
✅ vercel-ws-transport
| App | Passed | Failed | Skipped |
|---|---|---|---|
| ✅ example | 142 | 0 | 49 |
| ✅ express | 142 | 0 | 49 |
| ✅ nextjs-turbopack | 169 | 0 | 22 |
| ✅ vite | 142 | 0 | 49 |
Sim WorldSimulated world deterministic testing for races. Traces 🟠 world-sim scenario book — 1 fail of 42 total
Full trace: |
About these numbersSizes are gzip; parentheses show the change against
|
ac77874 to
f45166a
Compare
f45166a to
dc9bc84
Compare
4c1f9e6 to
8741a51
Compare
## Summary & Motivation Fills gaps the 5.0.0 dogfood surfaced on the dynamic workflows concept page: a table of the per-gate refusals and which of them are fatal, how a Vercel project gets dynamic-source storage, what the 2,048-byte execution-context budget actually buys, that the workflow ID hashes raw source bytes, and that "trusted" means reviewed application code rather than anything a model did not write. Stacked on #4541, which adds the cookbook recipe this page now links to. ## Test Plan Docs only. Links, anchors, quoted error messages, and the fatal/retryable behavior were checked by hand against the runtime source on main. #4534 (open) edits this page's `exportName` rule. This PR leaves that line alone, quotes only the stable prefix of the execution-context error that #4534 extends, and does not document #4534's validation messages. ## Docs Preview | Page | Link | | --- | --- | | Dynamic workflows | [/docs/advanced/dynamic-workflows](https://workflow-docs-rakhde7hj.vercel.sh/docs/advanced/dynamic-workflows) | | Errors for each gate | [#errors-for-each-gate](https://workflow-docs-rakhde7hj.vercel.sh/docs/advanced/dynamic-workflows#errors-for-each-gate) | | Enabling storage on Vercel | [#enabling-storage-on-vercel](https://workflow-docs-rakhde7hj.vercel.sh/docs/advanced/dynamic-workflows#enabling-storage-on-vercel) | --------- Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
…fter deploy Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
… proves Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
…v1 contract Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
… reject invalid parent links Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
## Summary & Motivation Fills gaps the 5.0.0 dogfood surfaced on the dynamic workflows concept page: a table of the per-gate refusals and which of them are fatal, how a Vercel project gets dynamic-source storage, what the 2,048-byte execution-context budget actually buys, that the workflow ID hashes raw source bytes, and that "trusted" means reviewed application code rather than anything a model did not write. Stacked on #4541, which adds the cookbook recipe this page now links to. ## Test Plan Docs only. Links, anchors, quoted error messages, and the fatal/retryable behavior were checked by hand against the runtime source on main. #4534 (open) edits this page's `exportName` rule. This PR leaves that line alone, quotes only the stable prefix of the execution-context error that #4534 extends, and does not document #4534's validation messages. ## Docs Preview | Page | Link | | --- | --- | | Dynamic workflows | [/docs/advanced/dynamic-workflows](https://workflow-docs-rakhde7hj.vercel.sh/docs/advanced/dynamic-workflows) | | Errors for each gate | [#errors-for-each-gate](https://workflow-docs-rakhde7hj.vercel.sh/docs/advanced/dynamic-workflows#errors-for-each-gate) | | Enabling storage on Vercel | [#enabling-storage-on-vercel](https://workflow-docs-rakhde7hj.vercel.sh/docs/advanced/dynamic-workflows#enabling-storage-on-vercel) | --------- Signed-off-by: Alex Langenfeld <alex.langenfeld@vercel.com>
8943673 to
9bc079b
Compare
Summary & Motivation
A cookbook recipe for experimental dynamic workflows, built around an integration team publishing a reviewed, customer-specific CRM migration procedure after the platform has deployed — no application release per customer. It states when static configuration, a JSON plan, or a runtime agent is the better choice instead, and leads with the
start(source, [input], { experimental_dynamic: { steps } })call and the step-catalog contract, leaving the full procedure to an appendix.setParentcycles and plans changed after staging.Test Plan
Eight e2e cases cover the migration procedures end to end, asserting the resulting destination records, the rejected families and their reasons, and the adapter's refusals; the docs typecheck covers the recipe's samples. Locally the file passed 20/20 against a nextjs-turbopack dev server with dynamic workflows enabled.
Snippet → fixture
workflows/migration-steps.ts,lib/migration-catalog.tsMIGRATION_CATALOGin99_e2e.ts(pure simulated destination)lib/start-procedure.tsstartMissionRevisionin99_e2e.tsprocedures/crm-parent-first.js(complete, and excerpt)PARENT_FIRST_SOURCEine2e-dynamic-workflow.test.tsprocedures/crm-provisional-first.js(excerpt)PROVISIONAL_FIRST_SOURCEine2e-dynamic-workflow.test.tslib/bind-revision.tsbindMissionRevisionin99_e2e.tsgetHookByToken/resumeHookdirectlyDocs Preview