Skip to content

Add documentation for common patterns and architecture notes#875

Merged
pranaygp merged 1 commit into
mainfrom
pranaygp/fixed-versioning-strategy
Jan 28, 2026
Merged

Add documentation for common patterns and architecture notes#875
pranaygp merged 1 commit into
mainfrom
pranaygp/fixed-versioning-strategy

Conversation

@pranaygp
Copy link
Copy Markdown
Contributor

@pranaygp pranaygp commented Jan 28, 2026

Summary

Adds documentation to CLAUDE.md based on learnings from implementing the workflow version observability feature (#868).

Changes

  • Document fixed versioning strategy for workflow and @workflow/core
  • Add genversion pattern for build-time version injection
  • Add turbo caching guidance for generated files
  • Document executionContext field flexibility
  • Document observability data hydration behavior in hydrateResourceIO

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot
Copy link
Copy Markdown

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

⚠️ No Changeset found

Latest commit: 9249853

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Jan 28, 2026 •
edited
Loading

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

Project Deployment Review Updated (UTC)
example-nextjs-workflow-turbopack Ready Ready Preview, Comment Jan 28, 2026 1:56am
example-nextjs-workflow-webpack Ready Ready Preview, Comment Jan 28, 2026 1:56am
example-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-astro-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-express-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-fastify-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-hono-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-nitro-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-nuxt-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-sveltekit-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workbench-vite-workflow Ready Ready Preview, Comment Jan 28, 2026 1:56am
workflow-docs Ready Ready Preview, Comment Jan 28, 2026 1:56am
workflow-nest Ready Ready Preview, Comment Jan 28, 2026 1:56am

@github-actions
Copy link
Copy Markdown
Contributor

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

🧪 E2E Test Results

❌ Some tests failed

Summary

Passed Failed Skipped Total
✅ ▲ Vercel Production 457 0 38 495
✅ 💻 Local Development 418 0 32 450
✅ 📦 Local Production 418 0 32 450
✅ 🐘 Local Postgres 418 0 32 450
✅ 🪟 Windows 45 0 0 45
❌ 🌍 Community Worlds 31 161 0 192
✅ 📋 Other 123 0 12 135
Total 1910 161 146 2217

❌ Failed Tests

🌍 Community Worlds (161 failed)

mongodb (40 failed):

  • addTenWorkflow
  • addTenWorkflow
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • readableStreamWorkflow
  • hookWorkflow
  • webhookWorkflow
  • sleepingWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • outputStreamWorkflow
  • outputStreamInsideStepWorkflow - getWritable() called inside step functions
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (40 failed):

  • addTenWorkflow
  • addTenWorkflow
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • readableStreamWorkflow
  • hookWorkflow
  • webhookWorkflow
  • sleepingWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • outputStreamWorkflow
  • outputStreamInsideStepWorkflow - getWritable() called inside step functions
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (41 failed):

  • addTenWorkflow
  • addTenWorkflow
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • readableStreamWorkflow
  • hookWorkflow
  • webhookWorkflow
  • sleepingWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • outputStreamWorkflow
  • outputStreamInsideStepWorkflow - getWritable() called inside step functions
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (CLI) - workflow health command reports healthy endpoints
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (40 failed):

  • addTenWorkflow
  • addTenWorkflow
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • readableStreamWorkflow
  • hookWorkflow
  • webhookWorkflow
  • sleepingWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • outputStreamWorkflow
  • outputStreamInsideStepWorkflow - getWritable() called inside step functions
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
App Passed Failed Skipped
✅ astro 41 0 4
✅ example 41 0 4
✅ express 41 0 4
✅ fastify 41 0 4
✅ hono 41 0 4
✅ nextjs-turbopack 44 0 1
✅ nextjs-webpack 44 0 1
✅ nitro 41 0 4
✅ nuxt 41 0 4
✅ sveltekit 41 0 4
✅ vite 41 0 4
✅ 💻 Local Development
App Passed Failed Skipped
✅ astro-stable 41 0 4
✅ express-stable 41 0 4
✅ fastify-stable 41 0 4
✅ hono-stable 41 0 4
✅ nextjs-turbopack-stable 45 0 0
✅ nextjs-webpack-stable 45 0 0
✅ nitro-stable 41 0 4
✅ nuxt-stable 41 0 4
✅ sveltekit-stable 41 0 4
✅ vite-stable 41 0 4
✅ 📦 Local Production
App Passed Failed Skipped
✅ astro-stable 41 0 4
✅ express-stable 41 0 4
✅ fastify-stable 41 0 4
✅ hono-stable 41 0 4
✅ nextjs-turbopack-stable 45 0 0
✅ nextjs-webpack-stable 45 0 0
✅ nitro-stable 41 0 4
✅ nuxt-stable 41 0 4
✅ sveltekit-stable 41 0 4
✅ vite-stable 41 0 4
✅ 🐘 Local Postgres
App Passed Failed Skipped
✅ astro-stable 41 0 4
✅ express-stable 41 0 4
✅ fastify-stable 41 0 4
✅ hono-stable 41 0 4
✅ nextjs-turbopack-stable 45 0 0
✅ nextjs-webpack-stable 45 0 0
✅ nitro-stable 41 0 4
✅ nuxt-stable 41 0 4
✅ sveltekit-stable 41 0 4
✅ vite-stable 41 0 4
✅ 🪟 Windows
App Passed Failed Skipped
✅ nextjs-turbopack 45 0 0
❌ 🌍 Community Worlds
App Passed Failed Skipped
✅ mongodb-dev 3 0 0
❌ mongodb 5 40 0
✅ redis-dev 3 0 0
❌ redis 5 40 0
✅ starter-dev 3 0 0
❌ starter 4 41 0
✅ turso-dev 3 0 0
❌ turso 5 40 0
✅ 📋 Other
App Passed Failed Skipped
✅ e2e-local-dev-nest-stable 41 0 4
✅ e2e-local-postgres-nest-stable 41 0 4
✅ e2e-local-prod-nest-stable 41 0 4

📋 View full workflow run

@github-actions
Copy link
Copy Markdown
Contributor

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

📊 Benchmark Results

📈 Comparing against baseline from main branch. Green 🟢 = faster, Red 🔺 = slower.

workflow with no steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Nitro 0.042s (~) 1.007s (~) 0.964s 10 1.00x
💻 Local Express 0.043s (+2.6%) 1.007s (~) 0.964s 10 1.02x
💻 Local Next.js (Turbopack) 0.047s (-8.6% 🟢) 1.019s (~) 0.972s 10 1.11x
🐘 Postgres Nitro 0.125s (-49.9% 🟢) 1.020s (+0.7%) 0.895s 10 2.96x
🐘 Postgres Next.js (Turbopack) 0.170s (-17.3% 🟢) 1.022s (~) 0.853s 10 4.02x
🐘 Postgres Express 0.384s (+41.5% 🔺) 1.015s (~) 0.631s 10 9.09x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 0.656s (-17.5% 🟢) 1.736s (+6.0% 🔺) 1.080s 10 1.00x
▲ Vercel Nitro 0.703s (-6.4% 🟢) 1.619s (~) 0.916s 10 1.07x
▲ Vercel Next.js (Turbopack) 0.707s (-31.0% 🟢) 1.634s (-10.8% 🟢) 0.926s 10 1.08x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

workflow with 1 step

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 1.095s (~) 2.014s (~) 0.919s 10 1.00x
💻 Local Nitro 1.115s (~) 2.006s (~) 0.891s 10 1.02x
💻 Local Express 1.116s (~) 2.007s (~) 0.891s 10 1.02x
🐘 Postgres Express 2.227s (+3.1%) 3.015s (~) 0.788s 10 2.03x
🐘 Postgres Next.js (Turbopack) 2.385s (~) 3.022s (~) 0.637s 10 2.18x
🐘 Postgres Nitro 2.458s (+12.3% 🔺) 3.013s (~) 0.556s 10 2.24x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 2.831s (-3.9%) 3.613s (-1.3%) 0.783s 10 1.00x
▲ Vercel Express 2.907s (-2.6%) 3.813s (+2.8%) 0.906s 10 1.03x
▲ Vercel Nitro 2.983s (+7.0% 🔺) 3.817s (+3.7%) 0.834s 10 1.05x

🔍 Observability: Next.js (Turbopack) | Express | Nitro

workflow with 10 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 10.696s (~) 11.017s (~) 0.321s 5 1.00x
💻 Local Nitro 10.832s (~) 11.009s (~) 0.177s 5 1.01x
💻 Local Express 10.840s (~) 11.015s (~) 0.175s 5 1.01x
🐘 Postgres Next.js (Turbopack) 20.269s (+27.3% 🔺) 21.041s (+26.5% 🔺) 0.772s 5 1.90x
🐘 Postgres Express 20.333s (-0.7%) 21.034s (~) 0.701s 5 1.90x
🐘 Postgres Nitro 20.338s (~) 21.026s (~) 0.688s 5 1.90x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 22.813s (-1.1%) 23.696s (-0.6%) 0.883s 5 1.00x
▲ Vercel Nitro 22.870s (+0.6%) 23.709s (+1.0%) 0.839s 5 1.00x
▲ Vercel Next.js (Turbopack) 23.498s (+2.8%) 24.189s (+2.7%) 0.691s 5 1.03x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

Promise.all with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 1.399s (~) 2.011s (~) 0.612s 15 1.00x
💻 Local Nitro 1.403s (~) 2.007s (~) 0.604s 15 1.00x
💻 Local Express 1.407s (~) 2.006s (~) 0.599s 15 1.01x
🐘 Postgres Express 2.234s (~) 3.013s (~) 0.779s 10 1.60x
🐘 Postgres Next.js (Turbopack) 2.401s (+5.7% 🔺) 3.017s (+12.5% 🔺) 0.616s 10 1.72x
🐘 Postgres Nitro 2.414s (+7.6% 🔺) 3.015s (~) 0.601s 10 1.73x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 3.021s (-3.2%) 3.800s (-6.6% 🟢) 0.779s 9 1.00x
▲ Vercel Next.js (Turbopack) 3.070s (-5.3% 🟢) 3.819s (-7.1% 🟢) 0.749s 8 1.02x
▲ Vercel Express 3.337s (+19.3% 🔺) 4.210s (+15.9% 🔺) 0.873s 8 1.10x

🔍 Observability: Nitro | Next.js (Turbopack) | Express

Promise.all with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 2.423s (+0.8%) 3.336s (~) 0.913s 10 1.00x
💻 Local Express 2.493s (+1.5%) 3.026s (-0.8%) 0.533s 10 1.03x
💻 Local Nitro 2.596s (+4.0%) 3.017s (~) 0.421s 10 1.07x
🐘 Postgres Nitro 8.922s (+10.8% 🔺) 9.551s (+14.7% 🔺) 0.629s 4 3.68x
🐘 Postgres Express 9.151s (+18.3% 🔺) 9.562s (+11.8% 🔺) 0.411s 4 3.78x
🐘 Postgres Next.js (Turbopack) 11.240s (-11.4% 🟢) 11.734s (-10.0% 🟢) 0.494s 3 4.64x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 3.287s (-2.6%) 3.929s (-5.9% 🟢) 0.642s 8 1.00x
▲ Vercel Express 3.319s (+5.6% 🔺) 4.379s (+17.0% 🔺) 1.060s 7 1.01x
▲ Vercel Nitro 3.885s (+25.0% 🔺) 4.668s (+22.9% 🔺) 0.782s 7 1.18x

🔍 Observability: Next.js (Turbopack) | Express | Nitro

Promise.race with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 1.398s (-1.3%) 2.011s (~) 0.613s 15 1.00x
💻 Local Express 1.426s (~) 2.007s (~) 0.581s 15 1.02x
💻 Local Nitro 1.451s (+1.7%) 2.007s (~) 0.556s 15 1.04x
🐘 Postgres Nitro 2.045s (+8.3% 🔺) 2.692s (+16.8% 🔺) 0.647s 12 1.46x
🐘 Postgres Express 2.199s (+6.4% 🔺) 2.598s (+3.3%) 0.399s 12 1.57x
🐘 Postgres Next.js (Turbopack) 2.336s (+2.8%) 2.849s (-3.1%) 0.513s 11 1.67x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.777s (-4.7%) 3.754s (-0.9%) 0.977s 8 1.00x
▲ Vercel Next.js (Turbopack) 2.825s (-2.6%) 3.706s (-1.9%) 0.881s 9 1.02x
▲ Vercel Express 3.010s (+4.0%) 3.881s (+4.5%) 0.871s 8 1.08x

🔍 Observability: Nitro | Next.js (Turbopack) | Express

Promise.race with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 2.490s (+2.4%) 3.044s (~) 0.554s 10 1.00x
💻 Local Express 2.573s (-1.1%) 3.017s (~) 0.443s 10 1.03x
💻 Local Nitro 2.734s (+8.0% 🔺) 3.010s (~) 0.276s 10 1.10x
🐘 Postgres Nitro 10.603s (-10.4% 🟢) 11.385s (-7.9% 🟢) 0.781s 3 4.26x
🐘 Postgres Express 11.491s (+14.3% 🔺) 12.022s (+16.0% 🔺) 0.531s 3 4.61x
🐘 Postgres Next.js (Turbopack) 13.456s (-3.8%) 14.025s (-4.6%) 0.569s 3 5.40x

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 3.373s (+14.7% 🔺) 4.302s (+19.2% 🔺) 0.930s 7 1.00x
▲ Vercel Nitro 3.507s (+5.8% 🔺) 4.358s (+5.9% 🔺) 0.851s 7 1.04x
▲ Vercel Next.js (Turbopack) 3.731s (+7.7% 🔺) 4.294s (+5.0%) 0.562s 8 1.11x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

Stream Benchmarks (includes TTFB metrics)
workflow with stream

💻 Local Development

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Next.js (Turbopack) 0.143s (+0.9%) 1.003s (~) 0.018s (+15.8% 🔺) 1.030s (~) 0.886s 10 1.00x
💻 Local Express 0.183s (+1.6%) 0.992s (~) 0.015s (+4.9%) 1.022s (~) 0.839s 10 1.28x
💻 Local Nitro 0.185s (+2.8%) 0.993s (~) 0.015s (-0.7%) 1.022s (~) 0.837s 10 1.29x
🐘 Postgres Nitro 2.165s (-2.5%) 2.882s (+2.1%) 0.000s (NaN%) 3.015s (~) 0.850s 10 15.10x
🐘 Postgres Next.js (Turbopack) 2.246s (+118.8% 🔺) 2.803s (+92.4% 🔺) 0.000s (-100.0% 🟢) 3.020s (+86.0% 🔺) 0.775s 10 15.66x
🐘 Postgres Express 2.324s (~) 2.721s (~) 0.000s (NaN%) 3.017s (~) 0.693s 10 16.21x

▲ Production (Vercel)

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 3.201s (+3.3%) 3.284s (+4.6%) 0.981s (+8.6% 🔺) 4.923s (+8.0% 🔺) 1.722s 10 1.00x
▲ Vercel Next.js (Turbopack) 3.300s (+3.5%) 3.570s (+9.6% 🔺) 0.708s (-31.4% 🟢) 4.821s (~) 1.521s 10 1.03x
▲ Vercel Nitro 3.322s (+10.9% 🔺) 3.432s (+7.8% 🔺) 0.885s (+43.2% 🔺) 4.895s (+13.3% 🔺) 1.572s 10 1.04x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World 🥇 Fastest Framework Wins
💻 Local Next.js (Turbopack) 7/8
🐘 Postgres Nitro 5/8
▲ Vercel Express 4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework 🥇 Fastest World Wins
Express 💻 Local 8/8
Next.js (Turbopack) 💻 Local 8/8
Nitro 💻 Local 8/8
Column Definitions
  • Workflow Time: Runtime reported by workflow (completedAt - createdAt) - primary metric
  • TTFB: Time to First Byte - time from workflow start until first stream byte received (stream benchmarks only)
  • Slurp: Time from first byte to complete stream consumption (stream benchmarks only)
  • Wall Time: Total testbench time (trigger workflow + poll for result)
  • Overhead: Testbench overhead (Wall Time - Workflow Time)
  • Samples: Number of benchmark iterations run
  • vs Fastest: How much slower compared to the fastest configuration for this benchmark

Worlds:

  • 💻 Local: In-memory filesystem world (local development)
  • 🐘 Postgres: PostgreSQL database world (local development)
  • ▲ Vercel: Vercel production/preview deployment
  • 🌐 Starter: Community world (local development)
  • 🌐 Turso: Community world (local development)
  • 🌐 MongoDB: Community world (local development)
  • 🌐 Redis: Community world (local development)
  • 🌐 Jazz: Community world (local development)

📋 View full workflow run

Copilot AI reviewed Jan 28, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation to CLAUDE.md based on implementation learnings from PR #868, which added SDK version tracking to workflow runs for observability purposes.

Changes:

  • Document the fixed versioning strategy for workflow and @workflow/core packages
  • Add guidance for common patterns: genversion for build-time version injection and turbo caching for generated files
  • Document architecture notes about the executionContext field flexibility and observability data hydration behavior

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
CLAUDE.md Adds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.json Implements fixed versioning configuration to ensure workflow and @workflow/core packages maintain the same version

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@pranaygp @claude
Add documentation for common patterns and architecture notes
9249853 
- Document fixed versioning for workflow and @workflow/core
- Add genversion pattern for build-time version injection
- Add turbo caching guidance for generated files
- Document executionContext field flexibility
- Document observability data hydration behavior

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@pranaygp pranaygp force-pushed the pranaygp/fixed-versioning-strategy branch from cf65667 to 9249853 Compare January 28, 2026 01:54
@pranaygp pranaygp merged commit 1b78efa into main Jan 28, 2026
91 checks passed
@pranaygp pranaygp deleted the pranaygp/fixed-versioning-strategy branch January 28, 2026 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

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

@pranaygp