Skip to content

docs(ai): clean up WorkflowAgent docs and examples - #3891

Open
NathanColosimo wants to merge 6 commits into
mainfrom
codex/ai-gateway-workflow-agent
Open

docs(ai): clean up WorkflowAgent docs and examples#3891
NathanColosimo wants to merge 6 commits into
mainfrom
codex/ai-gateway-workflow-agent

Conversation

@NathanColosimo

@NathanColosimo NathanColosimo commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

  • default Workflow 4 and 5 AI docs/examples to Vercel AI Gateway with xai/grok-4.6, while retaining direct provider-package alternatives
  • recommend AI SDK v7 WorkflowAgent exclusively for new Workflow 5 agents, deprecate the legacy @workflow/ai surface, and migrate the flagship v5 chat workbench to AI SDK 7
  • correct multi-turn stream lifecycle and the 100-turn boundary, use the exported prepareStep types, and give queued Hook messages a single FIFO ownership path
  • replay raw model parts from zero before applying the UI resume cursor, centralize the workbench model catalog, and remove stale model IDs and capability gaps
  • migrate cancellation guidance to WorkflowAgent with Hook-driven graceful cancellation and a run-cancellation fallback

Testing

  • pnpm typecheck
  • pnpm lint (passes with existing advisory warnings)
  • pnpm --filter docs build
  • pnpm --filter docs lint:links
  • pnpm --filter @workflow/ai build
  • pnpm --dir packages/ai test (184 pass; 22 intentional expected failures)
  • focused pnpm test:docs runs for every corrected page
  • pnpm --dir workbench/nextjs-turbopack build

Docs Preview

Base: workflow-docs preview

Page v5 v4
AI overview v5 v4
Chat session modeling v5 v4
Message queueing v5 v4
DurableAgent API v5 v4
Serializable steps v5 v4
Agent cancellation v5 v4
Human in the loop v5 v4
AI SDK integration v5 v4
Fetch in workflow v5 v4
Streaming v5 v4
API reference v5 —
Workflow AI API v5 —
Durable agent pattern v5 —

@NathanColosimo
NathanColosimo requested a review from a team as a code owner August 28, 2026 21:42
@changeset-bot

changeset-bot Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 154f3a6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 17 packages
Name Type
workflow Patch
@workflow/core Patch
@workflow/ai Patch
@workflow/world-testing Patch
@workflow/builders Patch
@workflow/cli Patch
@workflow/next Patch
@workflow/nitro Patch
@workflow/vitest Patch
@workflow/web-shared Patch
@workflow/web Patch
@workflow/astro Patch
@workflow/nest Patch
@workflow/rollup Patch
@workflow/sveltekit Patch
@workflow/vite Patch
@workflow/nuxt Patch

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

@vercel

vercel Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Aug 28, 2026 11:48pm
example-nextjs-workflow-webpack Error Error v0 Aug 28, 2026 11:48pm
example-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-astro-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-express-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-fastify-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-hono-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-nestjs-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-nitro-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-nuxt-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-python-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-sveltekit-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-tanstack-start-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workbench-vite-workflow Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workflow-docs Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workflow-swc-playground Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workflow-tarballs Ready Ready Preview, v0 Aug 28, 2026 11:48pm
workflow-web Ready Ready Preview, v0 Aug 28, 2026 11:48pm

@github-actions

github-actions Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

❌ Some tests failed

❌ Failed E2E Tests

▲ Vercel Production (8 failed)

python-node (8 failed):

  • promiseAllWorkflow | wrun_41M15CAHMZ0GYDB8R4TCWJVZY3 | 🔍 observability
  • sleepingWorkflow | wrun_41M15CB6VT0GSWAVSF0ZS7WN8C | 🔍 observability
  • parallelSleepWorkflow | wrun_41M15CBB0Y0GR73166RET327VW | 🔍 observability
  • nullByteWorkflow | wrun_41M15CBEGS0GX90A0X1SZ6ZQBG | 🔍 observability
  • cancelRun - cancelling a running workflow | wrun_41M15CG9SZ0GVSSMGXEPBM9N1B | 🔍 observability
  • cancelRun via CLI - cancelling a running workflow | wrun_41M15CGA580GSYDA7HXAQ9HCSE | 🔍 observability
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration | wrun_41M15CGK1P0GYYQ6V6BS4F1BQQ | 🔍 observability
  • resilient start: addTenWorkflow completes when run_created returns 500 | wrun_41M15CH52B0GQ1BCED42XVDWD1 | 🔍 observability

🌐 Cross-language Conformance (9 failed)

python (9 failed):

  • deploymentId: 'latest' is a no-op in non-Vercel worlds | wrun_01M15CMK5W4AVE8R4DD2YH6T5B
  • promiseAllWorkflow | wrun_41M15CAHMZ0GYDB8R4TCWJVZY3
  • sleepingWorkflow | wrun_41M15CB6VT0GSWAVSF0ZS7WN8C
  • parallelSleepWorkflow | wrun_41M15CBB0Y0GR73166RET327VW
  • nullByteWorkflow | wrun_41M15CBEGS0GX90A0X1SZ6ZQBG
  • cancelRun - cancelling a running workflow | wrun_41M15CG9SZ0GVSSMGXEPBM9N1B
  • cancelRun via CLI - cancelling a running workflow | wrun_41M15CGA580GSYDA7HXAQ9HCSE
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration | wrun_41M15CGK1P0GYYQ6V6BS4F1BQQ
  • resilient start: addTenWorkflow completes when run_created returns 500 | wrun_41M15CH52B0GQ1BCED42XVDWD1

⚠️ Flaky E2E Tests (passed on retry)

These tests failed at least once and passed on a retry. A recurring entry here is a real race worth investigating.

  • hookWithSleepFinalStepWorkflow - step only on final payload (nextjs-turbopack)
  • hookWithSleepFinalStepWorkflow - step only on final payload (vite)
  • hookWorkflow (tanstack-start)
  • hookWorkflow (vite)
  • parallelStepsThenWebhookWorkflow - no hook_conflict from same-tick replay race (tanstack-start)

🛠 Infra Events (absorbed by the harness)

Platform anomalies the e2e harness detected and worked around (e.g. a run the queue never picked up, replaced by a fresh run). Clustered timestamps indicate a backend blip; a steady drip indicates a platform issue worth escalating.

34 infra events
  • cold-start-warmup · suite warmup (python) · at 23:49:08Z · abandoned wrun_41M15CA8NW0GGXE413JVTY0WM4 · (+7 more)
  • run-pickup-stall · sleepingWorkflow (python) · at 23:49:24Z · abandoned wrun_41M15CDXKE0GWN40DXMXBYQBFV
  • run-pickup-stall · parallelSleepWorkflow (python) · at 23:49:24Z · abandoned wrun_41M15CDXKE0GWN40DXMXBYQBFW
  • run-pickup-stall · promiseAllWorkflow (python) · at 23:49:24Z · abandoned wrun_41M15CDXK80GGPPRG1G1EE7FH4
  • run-pickup-stall · nullByteWorkflow (python) · at 23:49:24Z · abandoned wrun_41M15CDXKH0GWGNV0916NYGA92
  • run-pickup-stall · cancelRun - cancelling a running workflow (python) · at 23:49:24Z · abandoned wrun_41M15CDXZ80GVDN9890BXKTWY3
  • run-pickup-stall · cancelRun - cancelling a running workflow (python) · at 23:49:57Z · abandoned wrun_41M15CEXJA0GK9FA6G10RY7CCA
  • cold-start-warmup · suite warmup (astro) · at 23:50:17Z · abandoned wrun_01M15CFGNYQHS47MSKX4P1F8XF
  • cold-start-warmup · suite warmup (tanstack-start) · at 23:50:24Z · abandoned wrun_01M15CFCVMF7B7Q3SVJDTNZMM9
  • run-pickup-stall · parallelSleepWorkflow (python) · at 23:50:25Z · abandoned wrun_41M15CFS2M0GR8FARBFPXTW4Y7
  • run-pickup-stall · nullByteWorkflow (python) · at 23:50:25Z · abandoned wrun_41M15CFS3D0GM64TGJCPQCCTTC
  • run-pickup-stall · promiseAllWorkflow (python) · at 23:50:25Z · abandoned wrun_41M15CFS3Z0GJMKQNJX6WVXEEG
  • run-pickup-stall · sleepingWorkflow (python) · at 23:50:25Z · abandoned wrun_41M15CFS5Q0GGBK8Y976ABRFPK
  • cold-start-warmup · suite warmup (python) · at 23:51:31Z · abandoned wrun_01M15CEMR4DHPEXEYES57JAVXZ · (+7 more)
  • run-pickup-stall · deploymentId: 'latest' is a no-op in non-Vercel worlds (python) · at 23:51:47Z · abandoned wrun_01M15CJ9WWGBKFPNT4TMMPGS8J
  • run-pickup-stall · promiseAllWorkflow (python) · at 23:51:47Z · abandoned wrun_01M15CJ9WXM7X20K6NKB4DH83N
  • run-pickup-stall · sleepingWorkflow (python) · at 23:51:47Z · abandoned wrun_01M15CJ9X2QX96VM7XR00J7CZ7
  • run-pickup-stall · nullByteWorkflow (python) · at 23:51:47Z · abandoned wrun_01M15CJ9X6T5R7T7M92TQVJP1G
  • run-pickup-stall · parallelSleepWorkflow (python) · at 23:51:47Z · abandoned wrun_01M15CJ9X5ZX47JTBEEX1MP4AK
  • run-pickup-stall · cancelRun via CLI - cancelling a running workflow (python) · at 23:51:55Z · abandoned wrun_41M15CFXB40GX4CEJTR3N0JFS0
  • run-pickup-stall · Calculator.calculate - static workflow method using static step methods from another class (hono) · at 23:52:23Z · abandoned wrun_01M15CKDE36G835ZQEJ99BTC9V
  • run-pickup-stall · deploymentId: 'latest' is a no-op in non-Vercel worlds (python) · at 23:52:47Z · abandoned wrun_01M15CM4GQR190Q7FA5HMB2S5W
  • run-pickup-stall · sleepingWorkflow (python) · at 23:52:47Z · abandoned wrun_01M15CM4GRMF551XWNQVFB80Q1
  • run-pickup-stall · nullByteWorkflow (python) · at 23:52:47Z · abandoned wrun_01M15CM4GYFNQS3HWWZF7MKP6K
  • run-pickup-stall · promiseAllWorkflow (python) · at 23:52:47Z · abandoned wrun_01M15CM4GVEA9FMJRKAFWNYEBG
  • run-pickup-stall · parallelSleepWorkflow (python) · at 23:52:47Z · abandoned wrun_01M15CM4GX0G65W46AE7WTFHFR
  • run-pickup-stall · cancelRun via CLI - cancelling a running workflow (python) · at 23:53:37Z · abandoned wrun_41M15CHTM90GSN1RZ94H20PT6H
  • run-pickup-stall · sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration (python) · at 23:53:37Z · abandoned wrun_41M15CJGZ70GW8P3E2EWAN87H6
  • run-pickup-stall · cancelRun - cancelling a running workflow (python) · at 23:53:47Z · abandoned wrun_01M15CNZ49PZVA6CEMHHQ9YCVQ
  • run-pickup-stall · cancelRun via CLI - cancelling a running workflow (python) · at 23:53:47Z · abandoned wrun_01M15CNZ4EV79X67NK8S1F589D
  • run-pickup-stall · sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration (python) · at 23:53:47Z · abandoned wrun_01M15CNZ4KAVYJ1Q3364E7WMX4
  • run-pickup-stall · cancelRun - cancelling a running workflow (python) · at 23:54:17Z · abandoned wrun_01M15CPWFT0PV1TKV6G53FK1M4
  • run-pickup-stall · cancelRun via CLI - cancelling a running workflow (python) · at 23:54:17Z · abandoned wrun_01M15CPWFX80Y038FQGCTY3XH9
  • run-pickup-stall · sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration (python) · at 23:54:47Z · abandoned wrun_01M15CQSQQT7008RANGDQ9W5VH

E2E Test Summary

Summary
Passed Failed Skipped Total
❌ ▲ Vercel Production 3256 8 736 4000
✅ 💻 Local Development 3320 0 520 3840
✅ 📦 Local Production 2718 0 482 3200
✅ 🐘 Local Postgres 2718 0 482 3200
✅ 🪟 Windows 320 0 0 320
❌ 🌐 Cross-language Conformance 0 9 132 141
✅ vercel-http-transport 817 0 143 960
✅ vercel-multi-region 27 0 0 27
✅ vercel-ws-transport 553 0 87 640
Total 13729 17 2582 16328
Details by Category

❌ ▲ Vercel Production

App Passed Failed Skipped
✅ astro-node 132 0 28
✅ astro-quickjs 132 0 28
✅ example-node 132 0 28
✅ example-quickjs 132 0 28
✅ express-node 132 0 28
✅ express-quickjs 132 0 28
✅ fastify-node 132 0 28
✅ fastify-quickjs 132 0 28
✅ hono-node 132 0 28
✅ hono-quickjs 132 0 28
✅ nest-node 132 0 28
✅ nest-quickjs 132 0 28
✅ nextjs-turbopack-node 157 0 3
✅ nextjs-turbopack-quickjs 157 0 3
✅ nitro-node 132 0 28
✅ nitro-quickjs 132 0 28
✅ nuxt-node 132 0 28
✅ nuxt-quickjs 132 0 28
❌ python-node 0 8 152
✅ sveltekit-node 151 0 9
✅ sveltekit-quickjs 151 0 9
✅ tanstack-start-node 132 0 28
✅ tanstack-start-quickjs 132 0 28
✅ vite-node 132 0 28
✅ vite-quickjs 132 0 28

✅ 💻 Local Development

App Passed Failed Skipped
✅ astro-stable-node 134 0 26
✅ astro-stable-quickjs 134 0 26
✅ express-stable-node 134 0 26
✅ express-stable-quickjs 134 0 26
✅ fastify-stable-node 134 0 26
✅ fastify-stable-quickjs 134 0 26
✅ hono-stable-node 134 0 26
✅ hono-stable-quickjs 134 0 26
✅ nest-stable-node 134 0 26
✅ nest-stable-quickjs 134 0 26
✅ nextjs-turbopack-canary-node 141 0 19
✅ nextjs-turbopack-canary-quickjs 141 0 19
✅ nextjs-turbopack-stable-node 160 0 0
✅ nextjs-turbopack-stable-quickjs 160 0 0
✅ nitro-stable-node 134 0 26
✅ nitro-stable-quickjs 134 0 26
✅ nuxt-stable-node 134 0 26
✅ nuxt-stable-quickjs 134 0 26
✅ sveltekit-stable-node 153 0 7
✅ sveltekit-stable-quickjs 153 0 7
✅ tanstack-start-node 134 0 26
✅ tanstack-start-quickjs 134 0 26
✅ vite-stable-node 134 0 26
✅ vite-stable-quickjs 134 0 26

✅ 📦 Local Production

App Passed Failed Skipped
✅ astro-stable-node 134 0 26
✅ astro-stable-quickjs 134 0 26
✅ express-stable-node 134 0 26
✅ express-stable-quickjs 134 0 26
✅ fastify-stable-node 134 0 26
✅ fastify-stable-quickjs 134 0 26
✅ hono-stable-node 134 0 26
✅ hono-stable-quickjs 134 0 26
✅ nest-stable-node 134 0 26
✅ nest-stable-quickjs 134 0 26
✅ nitro-stable-node 134 0 26
✅ nitro-stable-quickjs 134 0 26
✅ nuxt-stable-node 134 0 26
✅ nuxt-stable-quickjs 134 0 26
✅ sveltekit-stable-node 153 0 7
✅ sveltekit-stable-quickjs 153 0 7
✅ tanstack-start-node 134 0 26
✅ tanstack-start-quickjs 134 0 26
✅ vite-stable-node 134 0 26
✅ vite-stable-quickjs 134 0 26

✅ 🐘 Local Postgres

App Passed Failed Skipped
✅ astro-stable-node 134 0 26
✅ astro-stable-quickjs 134 0 26
✅ express-stable-node 134 0 26
✅ express-stable-quickjs 134 0 26
✅ fastify-stable-node 134 0 26
✅ fastify-stable-quickjs 134 0 26
✅ hono-stable-node 134 0 26
✅ hono-stable-quickjs 134 0 26
✅ nest-stable-node 134 0 26
✅ nest-stable-quickjs 134 0 26
✅ nitro-stable-node 134 0 26
✅ nitro-stable-quickjs 134 0 26
✅ nuxt-stable-node 134 0 26
✅ nuxt-stable-quickjs 134 0 26
✅ sveltekit-stable-node 153 0 7
✅ sveltekit-stable-quickjs 153 0 7
✅ tanstack-start-node 134 0 26
✅ tanstack-start-quickjs 134 0 26
✅ vite-stable-node 134 0 26
✅ vite-stable-quickjs 134 0 26

✅ 🪟 Windows

App Passed Failed Skipped
✅ nextjs-turbopack-node 160 0 0
✅ nextjs-turbopack-quickjs 160 0 0

❌ 🌐 Cross-language Conformance

App Passed Failed Skipped
❌ python 0 9 132

✅ vercel-http-transport

App Passed Failed Skipped
✅ example 132 0 28
✅ express 132 0 28
✅ hono 132 0 28
✅ nextjs-turbopack 157 0 3
✅ nitro 132 0 28
✅ vite 132 0 28

✅ vercel-multi-region

App Passed Failed Skipped
✅ nextjs-turbopack 27 0 0

✅ vercel-ws-transport

App Passed Failed Skipped
✅ example 132 0 28
✅ express 132 0 28
✅ nextjs-turbopack 157 0 3
✅ vite 132 0 28

📋 View full workflow run

@github-actions

github-actions Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

📊 Workflow Benchmarks

commit 154f3a6 · Sat, 29 Aug 2026 00:10:07 GMT · run logs

Backend: vercel · app: nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 1409 (+108%) 🔻 1571 🔴 (+39%) 🔻 1640 🔴 (+44%) 🔻 1768 🔴 (+54%) 🔻 30
TTFS stream 247 (+7.9%) 1546 🔴 (+43%) 🔻 1573 🔴 (+43%) 🔻 1812 🔴 (+55%) 🔻 30
TTFS hook + stream 1657 (+238%) 🔻 1791 🔴 (+33%) 🔻 1836 🔴 (+33%) 🔻 5862 🔴 (+303%) 🔻 30
Fan-out TTFS Promise.all(100 steps) 649 (+15%) 🔻 2106 (+23%) 🔻 2421 (+33%) 🔻 6369 (+224%) 🔻 10
Fan-out TTLS Promise.all(100 steps) 1852 (-16%) 💚 3703 (±0%) 4647 (+23%) 🔻 15061 (+91%) 🔻 10
STSO 1020 steps (inline) 86 (-24%) 💚 142 (+1.4%) 160 (-0.6%) 229 (+16%) 🔻 1019
WO 1020 steps 141880 (+0.7%) 141880 (+0.7%) 141880 (+0.7%) 141880 (+0.7%) 1
CRTT first chunk (pooled) 103 (-10%) 133 (-43%) 💚 174 (-66%) 💚 374 (-44%) 💚 28

Streams

Scenario CRTT 1st p75 p90 p99 CDV max iters
paced control (100/s, 60B) 120 (-17%) 152 (-70%) 250 (-64%) 398 (-60%) 129 (-71%) 10
size sweep (100/s, 160B-12KB) 119 (-33%) 146 (-38%) 185 (-67%) 342 (-62%) 113 (-52%) 10
replay gateway-gpt-5.4-nano-2000t (1x) 133 (-32%) 131 (-44%) 176 (-60%) 573 (-41%) 330 (-55%) 3
replay eve-gpt-5.6-sol-2000t (1x) 146 (-62%) 136 (-76%) 170 (-90%) 334 (-92%) 265 (-88%) 2
replay eve-gpt-5.6-sol-2000t (2x) 125 (-20%) 178 (-76%) 241 (-77%) 595 (-55%) 251 (-56%) 3
📈 STSO distribution vs main (inline / queue-hop histograms)

1020 steps (inline)

Cumulative STSO time: main 139837ms → this run 140410ms (Δ +573ms, +0%)

 50-100 ms  ┃                         main   0  this   2    +2
100-150 ms  ██████████████████████┃█  main 857  this 838   -19
150-200 ms  ███┃                      main 152  this 160    +8
200-250 ms  ┃                         main   8  this  13    +5
250-300 ms  ┃                         main   0  this   4    +4
300-350 ms  ┃                         main   2  this   2    +0
📈 CRTT drill-down vs main (RTT distributions & profiles) 
variant  RTT 1ms→5s+             avg         p50         p90         p99     n
control  ······▄█▁····  124.4 (-55%)  114 (-41%)  250 (-64%)  398 (-60%)  3000
sweep    ······▄█▁····    122 (-41%)  114 (-34%)  185 (-67%)  342 (-62%)  3000
gw 1x    ·····▁██▁▁···    115 (-44%)   99 (-39%)  176 (-60%)  573 (-41%)  5295
eve 1x   ·····▁▆█▁····  116.6 (-72%)  106 (-42%)  170 (-90%)  334 (-92%)  5186
eve 2x   ·····▁▃█▂▁···  154.3 (-60%)  134 (-46%)  241 (-77%)  595 (-55%)  7779

RTT over stream progress (avg per tenth of stream, bars scaled min→max):

control  ▄▃▇▇▂█▂▁▁▁  116–138ms
sweep    █▄▃▃▄▁▅▄▂▆  112–137ms
gw 1x    █▆▅▅▃█▄▁▅▂  96–132ms
eve 1x   ▃▁▃▃▁▃▆█▃▂  101–150ms
eve 2x   ▂▁▁▅▂▂▅█▅▂  127–203ms

RTT by chunk size (avg per log size bin, ~160B → ~12KB serialized, bars scaled min→max):

sweep  ▄▆█▇▅▂▁  119–125ms

Delivery jitter over stream progress (avg positive CDV per tenth of stream, bars scaled min→max):

control  ▁▅█▅▅▇▄▃▃▂  34–45ms
sweep    ▁█▄▄▇▅▇▄▅▄  41–52ms
gw 1x    █▇▁▅▄▇▇▂▅▃  26–36ms
eve 1x   ▃▁▄▅▁▅▆█▃▅  20–29ms
eve 2x   ▆▅▃▂▃▄▆▂▁█  20–28ms
📜 Previous results (2)

cf66a83

Fri, 28 Aug 2026 23:21:42 GMT · run logs

vercel / nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 261 (-62%) 💚 1545 🔴 (+36%) 🔻 1673 🔴 (+47%) 🔻 1769 🔴 (+54%) 🔻 30
TTFS stream 1363 (+495%) 🔻 1479 🔴 (+37%) 🔻 1496 🔴 (+36%) 🔻 1611 🔴 (+38%) 🔻 30
TTFS hook + stream 424 (-13%) 1713 🔴 (+27%) 🔻 1771 🔴 (+28%) 🔻 6169 🔴 (+324%) 🔻 30
Fan-out TTFS Promise.all(100 steps) 492 (-13%) 2079 (+22%) 🔻 2097 (+15%) 🔻 2197 (+12%) 10
Fan-out TTLS Promise.all(100 steps) 1858 (-15%) 💚 3789 (+2.1%) 5312 (+41%) 🔻 8532 (+8.5%) 10
STSO 1020 steps (inline) 87 (-23%) 💚 133 (-5.0%) 147 (-8.7%) 203 (+3.0%) 1019
WO 1020 steps 134045 (-4.8%) 134045 (-4.8%) 134045 (-4.8%) 134045 (-4.8%) 1
CRTT first chunk (pooled) 78 (-32%) 💚 106 (-55%) 💚 130 (-74%) 💚 177 (-73%) 💚 28

Streams

Scenario CRTT 1st p75 p90 p99 CDV max iters
paced control (100/s, 60B) 96 (-33%) 125 (-75%) 172 (-76%) 343 (-65%) 133 (-71%) 10
size sweep (100/s, 160B-12KB) 100 (-44%) 128 (-45%) 263 (-53%) 517 (-43%) 162 (-31%) 10
replay gateway-gpt-5.4-nano-2000t (1x) 105 (-46%) 116 (-50%) 138 (-69%) 258 (-74%) 164 (-78%) 3
replay eve-gpt-5.6-sol-2000t (1x) 96 (-75%) 111 (-80%) 148 (-92%) 249 (-94%) 264 (-88%) 2
replay eve-gpt-5.6-sol-2000t (2x) 130 (-17%) 148 (-80%) 193 (-82%) 381 (-71%) 197 (-65%) 3

840bd33

Fri, 28 Aug 2026 21:59:11 GMT · run logs

vercel / nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 243 (-64%) 💚 1305 🔴 (+15%) 🔻 1314 🔴 (+15%) 🔻 1375 🔴 (+19%) 🔻 30
TTFS stream 267 (+17%) 🔻 1311 🔴 (+22%) 🔻 1335 🔴 (+21%) 🔻 1386 🔴 (+19%) 🔻 30
TTFS hook + stream 452 (-7.8%) 1535 🔴 (+14%) 1570 🔴 (+14%) 1712 🔴 (+18%) 🔻 30
Fan-out TTFS Promise.all(100 steps) 575 (+2.1%) 1259 (-26%) 💚 1884 (+3.7%) 2069 (+5.3%) 10
Fan-out TTLS Promise.all(100 steps) 1993 (-9.3%) 3067 (-17%) 💚 3509 (-6.8%) 8088 (+2.8%) 10
STSO 1020 steps (inline) 90 (-20%) 💚 118 (-16%) 💚 142 (-12%) 204 (+3.6%) 1019
WO 1020 steps 119595 (-15%) 💚 119595 (-15%) 💚 119595 (-15%) 💚 119595 (-15%) 💚 1
CRTT first chunk (pooled) 84 (-27%) 💚 117 (-50%) 💚 170 (-67%) 💚 381 (-43%) 💚 28

Streams

Scenario CRTT 1st p75 p90 p99 CDV max iters
paced control (100/s, 60B) 104 (-28%) 112 (-78%) 159 (-77%) 278 (-72%) 102 (-77%) 10
size sweep (100/s, 160B-12KB) 97.5 (-45%) 116 (-50%) 161 (-71%) 421 (-53%) 102 (-57%) 10
replay gateway-gpt-5.4-nano-2000t (1x) 100 (-49%) 109 (-53%) 136 (-69%) 367 (-62%) 305 (-58%) 3
replay eve-gpt-5.6-sol-2000t (1x) 94.5 (-76%) 109 (-81%) 134 (-92%) 230 (-94%) 226 (-90%) 2
replay eve-gpt-5.6-sol-2000t (2x) 170 (+8%) 143 (-81%) 183 (-83%) 417 (-68%) 211 (-63%) 3
ℹ️ Metric definitions & methodology

Streams: 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). █ = main, ┃ = this run, ░ = fill.

The collapsed CRTT drill-down: per-variant RTT histograms (fixed log bins, · = empty) and mean RTT/positive-CDV profile lines over stream progress and chunk size. Histograms, avgs, and profiles merge exactly across runs; p50–p99 are percentile-of-percentiles. Per-index rows live in the artifacts.

Best/P75/P90/P99 deltas compare against the most recent benchmark run on main at the time of this run. 🔻 flags a delta worse than +15%, 💚 one better than −15%.

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 eaf22f5946e7c61f3c65c7006d550df180cfabd4e706254a09f22aec0cfb420d · gateway-gpt-5.4-nano-2000t 6f24ac518b6b83ff1d0e85a5fe78230db192716d66a7fc6b2fe022752001d041

🔴 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 = start() → first step body (includes dispatch + any cold start); Fan-out TTFS/TTLS = first/last step completion of one Promise.all from the same anchor (the gap is the runtime’s fan-out spread); STSO/WO between step bodies; CRTT inside the workflow (excludes the api.vercel.com read path).

Cold starts stay in the numbers (real bursty-workload latency, inflates P75+); Best is the warm floor.

@github-actions

github-actions Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟠 world-sim scenario book — 1 fail of 41 total

fence=per-spec

scenario outcome events virt replay violations
✅ smoke-no-steps completed 3 0ms ok 0
✅ smoke-one-step completed 6 0ms ok 0
✅ hook-at-step-started completed 12 0ms ok 0
✅ hook-at-step-completed completed 12 0ms ok 0
✅ hook-at-hook-created completed 12 0ms ok 0
✅ deadline-hook-wins completed 7 1.0h ok 0
✅ deadline-expires completed 7 1.0h ok 0
✅ long-sleep completed 11 30.0d ok 0
✅ hook-never-arrives stalled 3 0ms skipped 0
✅ step-retries-twice completed 10 2.0s ok 0
✅ parallel-steps completed 9 0ms ok 0
✅ hook-on-execution-state completed 12 0ms ok 0
✅ peek-hook-before-branch completed 12 0ms ok 0
✅ peek-hook-after-branch completed 12 0ms ok 0
✅ peek-hook-at-registration completed 12 0ms ok 0
✅ race-hook-before-probe completed 12 0ms ok 0
✅ race-hook-after-probe completed 12 0ms ok 0
✅ race-duplicate-delivery completed 13 0ms ok 0
✅ attr-hook-before-step completed 11 0ms ok 0
✅ attr-hook-after-step completed 11 0ms ok 0
✅ attr-from-step-body completed 13 0ms ok 0
✅ fork-hook-after-timeout completed 14 1.0m ok 0
✅ fork-hook-before-timeout completed 14 1.0m ok 0
✅ count-hook-after-timeout completed 17 1.0m ok 0
✅ count-hook-before-timeout completed 20 1.0m ok 0
✅ stale-read-step-count-fork completed 20 1.0m ok 0
✅ stale-read-equal-step-counts completed 14 1.0m ok 0
✅ step-vs-step-fork completed 12 0ms ok 0
✅ step-vs-step-fork-fenced completed 12 0ms ok 0
✅ fence-catches-benign-direction completed 12 5ms ok 0
✅ in-flight-before-decision completed 17 1.0m ok 0
❌ in-flight-before-decision-counted completed 17 1.0m ok 0
✅ in-flight-after-decision completed 19 2.0m ok 0
✅ stale-read-step-count-fork-fenced completed 20 1.0m ok 0
✅ fork-hook-wins completed 13 1.0m ok 0
✅ fork-timeout-wins completed 13 1.0m ok 0
✅ unclaimed-payload-under-fork completed 17 1.0m ok 0
✅ claimed-payload-under-fork completed 17 1.0m ok 0
✅ writers-independent-step-bodies completed 12 0ms ok 0
✅ writers-scripted-tempo completed 12 0ms ok 0
✅ cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

@github-actions

github-actions Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
Framework Flow route Step reg. Framework output
hono 200.9 KiB (+2 B) 40.4 KiB (±0) 1.76 MiB (+2 B)
nextjs-turbopack 271.4 KiB (+65.1 KiB) ⚠️ 448 B (+9 B) 903.5 KiB (+139.6 KiB)
About these numbers

Sizes are gzip; parentheses show the change against main.
Flow route and Step reg. gate this job, on raw bytes rather than the gzip shown, at max(2%, 50.0 KiB). Framework output is informational.
⚠️ marks growth past the threshold. Add the allow-bundle-size-growth label to accept it.

154f3a6 · run

@NathanColosimo NathanColosimo changed the title docs(ai): default Workflow examples to AI Gateway docs(ai): clean up WorkflowAgent docs and examples Aug 28, 2026
@socket-security

socket-security Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security		 Vulnerability Quality Maintenance License
Addednpm/​@​ai-sdk/​react@​4.0.85991007598100
Addednpm/​@​ai-sdk/​workflow@​2.0.12991009898100
Addednpm/​ai@​7.0.829910010099100

View full report

TooTallNate
TooTallNate reviewed Aug 29, 2026
View reviewed changes
Comment thread .changeset/fluffy-apes-worry.md
Comment on lines +2 to +3
"workflow": patch
"@workflow/core": patch

@TooTallNate TooTallNate Aug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Don't think we need these?

Suggested change
"workflow": patch
"@workflow/core": patch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TooTallNate TooTallNate TooTallNate left review comments
@vercel vercel[bot] vercel[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@NathanColosimo @TooTallNate