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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
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

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

CopilotAI review requested due to automatic review settings January 28, 2026 01:46
@changeset-bot

changeset-botBot commented Jan 28, 2026

Copy link
Copy Markdown

⚠️ 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

vercelBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production457038495
✅ 💻 Local Development418032450
✅ 📦 Local Production418032450
✅ 🐘 Local Postgres418032450
✅ 🪟 Windows450045
❌ 🌍 Community Worlds311610192
✅ 📋 Other123012135
Total19101611462217

❌ 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
AppPassedFailedSkipped
✅ astro4104
✅ example4104
✅ express4104
✅ fastify4104
✅ hono4104
✅ nextjs-turbopack4401
✅ nextjs-webpack4401
✅ nitro4104
✅ nuxt4104
✅ sveltekit4104
✅ vite4104
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4104
✅ express-stable4104
✅ fastify-stable4104
✅ hono-stable4104
✅ nextjs-turbopack-stable4500
✅ nextjs-webpack-stable4500
✅ nitro-stable4104
✅ nuxt-stable4104
✅ sveltekit-stable4104
✅ vite-stable4104
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4500
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5400
✅ redis-dev300
❌ redis5400
✅ starter-dev300
❌ starter4410
✅ turso-dev300
❌ turso5400
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4104
✅ e2e-local-postgres-nest-stable4104
✅ e2e-local-prod-nest-stable4104

📋 View full workflow run

@github-actions

github-actionsBot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

📊 Benchmark Results

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

workflow with no steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Nitro0.042s (~)1.007s (~)0.964s101.00x
💻 LocalExpress0.043s (+2.6%)1.007s (~)0.964s101.02x
💻 LocalNext.js (Turbopack)0.047s (-8.6% 🟢)1.019s (~)0.972s101.11x
🐘 PostgresNitro0.125s (-49.9% 🟢)1.020s (+0.7%)0.895s102.96x
🐘 PostgresNext.js (Turbopack)0.170s (-17.3% 🟢)1.022s (~)0.853s104.02x
🐘 PostgresExpress0.384s (+41.5% 🔺)1.015s (~)0.631s109.09x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.656s (-17.5% 🟢)1.736s (+6.0% 🔺)1.080s101.00x
▲ VercelNitro0.703s (-6.4% 🟢)1.619s (~)0.916s101.07x
▲ VercelNext.js (Turbopack)0.707s (-31.0% 🟢)1.634s (-10.8% 🟢)0.926s101.08x

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

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.095s (~)2.014s (~)0.919s101.00x
💻 LocalNitro1.115s (~)2.006s (~)0.891s101.02x
💻 LocalExpress1.116s (~)2.007s (~)0.891s101.02x
🐘 PostgresExpress2.227s (+3.1%)3.015s (~)0.788s102.03x
🐘 PostgresNext.js (Turbopack)2.385s (~)3.022s (~)0.637s102.18x
🐘 PostgresNitro2.458s (+12.3% 🔺)3.013s (~)0.556s102.24x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)2.831s (-3.9%)3.613s (-1.3%)0.783s101.00x
▲ VercelExpress2.907s (-2.6%)3.813s (+2.8%)0.906s101.03x
▲ VercelNitro2.983s (+7.0% 🔺)3.817s (+3.7%)0.834s101.05x

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

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)10.696s (~)11.017s (~)0.321s51.00x
💻 LocalNitro10.832s (~)11.009s (~)0.177s51.01x
💻 LocalExpress10.840s (~)11.015s (~)0.175s51.01x
🐘 PostgresNext.js (Turbopack)20.269s (+27.3% 🔺)21.041s (+26.5% 🔺)0.772s51.90x
🐘 PostgresExpress20.333s (-0.7%)21.034s (~)0.701s51.90x
🐘 PostgresNitro20.338s (~)21.026s (~)0.688s51.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express22.813s (-1.1%)23.696s (-0.6%)0.883s51.00x
▲ VercelNitro22.870s (+0.6%)23.709s (+1.0%)0.839s51.00x
▲ VercelNext.js (Turbopack)23.498s (+2.8%)24.189s (+2.7%)0.691s51.03x

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

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.399s (~)2.011s (~)0.612s151.00x
💻 LocalNitro1.403s (~)2.007s (~)0.604s151.00x
💻 LocalExpress1.407s (~)2.006s (~)0.599s151.01x
🐘 PostgresExpress2.234s (~)3.013s (~)0.779s101.60x
🐘 PostgresNext.js (Turbopack)2.401s (+5.7% 🔺)3.017s (+12.5% 🔺)0.616s101.72x
🐘 PostgresNitro2.414s (+7.6% 🔺)3.015s (~)0.601s101.73x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro3.021s (-3.2%)3.800s (-6.6% 🟢)0.779s91.00x
▲ VercelNext.js (Turbopack)3.070s (-5.3% 🟢)3.819s (-7.1% 🟢)0.749s81.02x
▲ VercelExpress3.337s (+19.3% 🔺)4.210s (+15.9% 🔺)0.873s81.10x

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

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.423s (+0.8%)3.336s (~)0.913s101.00x
💻 LocalExpress2.493s (+1.5%)3.026s (-0.8%)0.533s101.03x
💻 LocalNitro2.596s (+4.0%)3.017s (~)0.421s101.07x
🐘 PostgresNitro8.922s (+10.8% 🔺)9.551s (+14.7% 🔺)0.629s43.68x
🐘 PostgresExpress9.151s (+18.3% 🔺)9.562s (+11.8% 🔺)0.411s43.78x
🐘 PostgresNext.js (Turbopack)11.240s (-11.4% 🟢)11.734s (-10.0% 🟢)0.494s34.64x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Next.js (Turbopack)3.287s (-2.6%)3.929s (-5.9% 🟢)0.642s81.00x
▲ VercelExpress3.319s (+5.6% 🔺)4.379s (+17.0% 🔺)1.060s71.01x
▲ VercelNitro3.885s (+25.0% 🔺)4.668s (+22.9% 🔺)0.782s71.18x

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

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)1.398s (-1.3%)2.011s (~)0.613s151.00x
💻 LocalExpress1.426s (~)2.007s (~)0.581s151.02x
💻 LocalNitro1.451s (+1.7%)2.007s (~)0.556s151.04x
🐘 PostgresNitro2.045s (+8.3% 🔺)2.692s (+16.8% 🔺)0.647s121.46x
🐘 PostgresExpress2.199s (+6.4% 🔺)2.598s (+3.3%)0.399s121.57x
🐘 PostgresNext.js (Turbopack)2.336s (+2.8%)2.849s (-3.1%)0.513s111.67x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Nitro2.777s (-4.7%)3.754s (-0.9%)0.977s81.00x
▲ VercelNext.js (Turbopack)2.825s (-2.6%)3.706s (-1.9%)0.881s91.02x
▲ VercelExpress3.010s (+4.0%)3.881s (+4.5%)0.871s81.08x

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

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)2.490s (+2.4%)3.044s (~)0.554s101.00x
💻 LocalExpress2.573s (-1.1%)3.017s (~)0.443s101.03x
💻 LocalNitro2.734s (+8.0% 🔺)3.010s (~)0.276s101.10x
🐘 PostgresNitro10.603s (-10.4% 🟢)11.385s (-7.9% 🟢)0.781s34.26x
🐘 PostgresExpress11.491s (+14.3% 🔺)12.022s (+16.0% 🔺)0.531s34.61x
🐘 PostgresNext.js (Turbopack)13.456s (-3.8%)14.025s (-4.6%)0.569s35.40x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.373s (+14.7% 🔺)4.302s (+19.2% 🔺)0.930s71.00x
▲ VercelNitro3.507s (+5.8% 🔺)4.358s (+5.9% 🔺)0.851s71.04x
▲ VercelNext.js (Turbopack)3.731s (+7.7% 🔺)4.294s (+5.0%)0.562s81.11x

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

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Next.js (Turbopack)0.143s (+0.9%)1.003s (~)0.018s (+15.8% 🔺)1.030s (~)0.886s101.00x
💻 LocalExpress0.183s (+1.6%)0.992s (~)0.015s (+4.9%)1.022s (~)0.839s101.28x
💻 LocalNitro0.185s (+2.8%)0.993s (~)0.015s (-0.7%)1.022s (~)0.837s101.29x
🐘 PostgresNitro2.165s (-2.5%)2.882s (+2.1%)0.000s (NaN%)3.015s (~)0.850s1015.10x
🐘 PostgresNext.js (Turbopack)2.246s (+118.8% 🔺)2.803s (+92.4% 🔺)0.000s (-100.0% 🟢)3.020s (+86.0% 🔺)0.775s1015.66x
🐘 PostgresExpress2.324s (~)2.721s (~)0.000s (NaN%)3.017s (~)0.693s1016.21x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.201s (+3.3%)3.284s (+4.6%)0.981s (+8.6% 🔺)4.923s (+8.0% 🔺)1.722s101.00x
▲ VercelNext.js (Turbopack)3.300s (+3.5%)3.570s (+9.6% 🔺)0.708s (-31.4% 🟢)4.821s (~)1.521s101.03x
▲ VercelNitro3.322s (+10.9% 🔺)3.432s (+7.8% 🔺)0.885s (+43.2% 🔺)4.895s (+13.3% 🔺)1.572s101.04x

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

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalNext.js (Turbopack)7/8
🐘 PostgresNitro5/8
▲ VercelExpress4/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local8/8
Next.js (Turbopack)💻 Local8/8
Nitro💻 Local8/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

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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.

FileDescription
CLAUDE.mdAdds documentation for fixed versioning strategy, common patterns (genversion, turbo caching), and architecture notes (executionContext, observability hydration)
.changeset/config.jsonImplements 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.

- 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp