Skip to content

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

@TooTallNate@ijjk@VaguelySerious
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add discovery for custom classes with workflow serialization by TooTallNate · Pull Request #859 · vercel/workflow · GitHub
Skip to content

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

@TooTallNate@ijjk@VaguelySerious
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add discovery for custom classes with workflow serialization by TooTallNate · Pull Request #859 · vercel/workflow · GitHub
Skip to content

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

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

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

@TooTallNate@ijjk@VaguelySerious
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add discovery for custom classes with workflow serialization by TooTallNate · Pull Request #859 · vercel/workflow · GitHub
Skip to content

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

@TooTallNate@ijjk@VaguelySerious
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add discovery for custom classes with workflow serialization by TooTallNate · Pull Request #859 · vercel/workflow · GitHub
Skip to content

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

@TooTallNate@ijjk@VaguelySerious
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add discovery for custom classes with workflow serialization by TooTallNate · Pull Request #859 · vercel/workflow · GitHub
Skip to content

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

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

Add discovery for custom classes with workflow serialization - #859

Merged
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization
Feb 3, 2026
Merged

Add discovery for custom classes with workflow serialization#859
TooTallNate merged 10 commits into
mainfrom
01-26-add_discovery_for_custom_classes_with_workflow_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 26, 2026

Copy link
Copy Markdown
Member

Added automatic discovery for custom classes with workflow serialization, allowing serialization classes to be defined in separate files without requiring explicit directives.

What changed?

  • Added detection for files containing custom class serialization patterns:
    • Files importing from @workflow/serde
    • Files using Symbol.for('workflow-serialize') or Symbol.for('workflow-deserialize')
  • Created shared utilities in transform-utils.ts for consistent pattern detection across all build tools
  • Updated Next.js, Nitro, Rollup, and Vite plugins to use the new detection patterns
  • Added exclusion logic to prevent re-processing of generated workflow files
  • Added tests to verify the pattern detection works correctly
  • Updated documentation in the SWC plugin spec to explain the new discovery mechanism

How to test?

  1. Create a class with custom serialization in a separate file:
// models/point.jsexportclassPoint{constructor(x,y){this.x=x;this.y=y;}static[Symbol.for('workflow-serialize')](instance){return{x: instance.x,y: instance.y};}static[Symbol.for('workflow-deserialize')](data){returnnewPoint(data.x,data.y);}}
  1. Import and use this class in a workflow or step file:
'use workflow';import{Point}from'../models/point';exportfunctionmyWorkflow(){constpoint=newPoint(10,20);returnpoint;}
  1. Verify the class is properly serialized when passed between client and server

Why make this change?

Previously, files containing custom serialization classes needed to include a 'use step' directive to be discovered and transformed, even if they weren't actual step functions. This was unintuitive and could lead to confusion.

This change allows for a more natural code organization pattern where model classes with serialization can be defined in their own files without requiring directives. The build system will automatically discover and transform these files to ensure the serialization works correctly when the classes are used in workflows or steps.

@changeset-bot

changeset-botBot commented Jan 26, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 14a46e1

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

This PR includes changesets to release 18 packages
NameType
@workflow/swc-pluginPatch
@workflow/buildersPatch
@workflow/rollupPatch
@workflow/nextPatch
@workflow/astroPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nitroPatch
@workflow/sveltekitPatch
@workflow/vitePatch
workflowPatch
@workflow/docs-typecheckPatch
@workflow/world-testingPatch
@workflow/example-nestPatch
@workflow/nuxtPatch
@workflow/aiPatch
@workflow/corePatch
@workflow/web-sharedPatch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 26, 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🥇 Express0.042s (-4.7%)1.007s (~)0.965s101.00x
🐘 PostgresExpress0.315s (+9.2% 🔺)1.013s (~)0.698s107.47x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.649s (-16.1% 🟢)1.534s (-5.8% 🟢)0.884s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.115s (~)2.007s (~)0.892s101.00x
🐘 PostgresExpress2.171s (+2.4%)3.014s (~)0.843s101.95x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.035s (+3.7%)3.767s (+2.7%)0.732s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.835s (~)11.016s (~)0.181s51.00x
🐘 PostgresExpress20.411s (~)21.033s (~)0.622s51.88x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.095s (-3.8%)24.115s (-2.4%)1.020s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.179s (-5.3% 🟢)5.432s (-15.7% 🟢)0.253s61.00x
🐘 PostgresExpress28.910s (+3.3%)29.662s (+5.1% 🔺)0.752s25.58x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.296s (-8.0% 🟢)3.764s (-5.3% 🟢)0.468s81.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.155s (-2.9%)6.012s (-4.3%)0.857s61.00x
🐘 PostgresExpress31.548s (-6.2% 🟢)32.098s (-5.9% 🟢)0.550s16.12x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.223s (-3.4%)3.802s (-4.9%)0.579s81.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.284s (-6.8% 🟢)6.266s (-4.9%)0.981s51.00x
🐘 PostgresExpress34.150s (-1.4%)35.096s (~)0.946s16.46x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.122s (-5.7% 🟢)3.682s (-7.4% 🟢)0.560s91.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.305s (-5.8% 🟢)6.306s (-4.1%)1.002s51.00x
🐘 PostgresExpress34.477s (+13.8% 🔺)35.152s (+12.1% 🔺)0.675s16.50x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.443s (+4.4%)4.067s (+4.5%)0.624s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.183s (-3.4%)0.993s (~)0.014s (-4.7%)1.021s (~)0.838s101.00x
🐘 PostgresExpress2.341s (+6.4% 🔺)2.702s (-5.0%)0.000s (~)3.014s (~)0.673s1012.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.976s (-14.3% 🟢)3.206s (-8.9% 🟢)1.096s (-6.6% 🟢)4.826s (-10.7% 🟢)1.850s101.00x

🔍 Observability: Express

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World🥇 Fastest FrameworkWins
💻 LocalExpress8/8
🐘 PostgresExpress8/8
▲ VercelExpress8/8
Fastest World by Framework

Winner determined by most benchmark wins

Framework🥇 Fastest WorldWins
Express💻 Local4/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

@github-actions

github-actionsBot commented Jan 26, 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

@vercel

vercelBot commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@TooTallNate
TooTallNate marked this pull request as ready for review January 27, 2026 00:01
CopilotAI review requested due to automatic review settings January 27, 2026 00:01

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 pull request adds automatic discovery of files containing custom serialization classes for the workflow system, eliminating the need for explicit "use workflow" or "use step" directives in files that only define serialization classes.

Changes:

  • Added pattern detection for files importing from @workflow/serde or using Symbol.for('workflow-serialize'/'workflow-deserialize')
  • Updated discovery and transformation logic in builders, Rollup plugin, Next.js loader, and Vite hot-update plugin
  • Added comprehensive test coverage for the new pattern detection
  • Updated documentation explaining the automatic discovery mechanism

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
packages/vite/src/hot-update.tsAdded serde pattern detection to trigger hot reloads when custom serialization files change
packages/swc-plugin-workflow/spec.mdDocumented the new automatic file discovery mechanism for custom serialization
packages/rollup/src/index.tsAdded serde pattern detection and exclusion patterns for generated files and SDK packages
packages/next/src/loader.tsAdded serde pattern detection and exclusion patterns for the Next.js webpack loader
packages/next/src/index.tsUpdated Turbopack conditions to detect serde patterns and exclude generated files
packages/builders/src/discover-entries-esbuild-plugin.tsAdded serde pattern detection to treat files with custom serialization like step files
packages/builders/src/discover-entries-esbuild-plugin.test.tsAdded comprehensive tests for all pattern detection regex patterns
.changeset/stale-eagles-pay.mdAdded changeset documenting the feature addition

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

Comment threadpackages/next/src/index.ts Outdated
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The regex pattern for detecting @workflow/serde imports doesn't use backreferences to ensure matching quote types. The pattern from\s+['"]@workflow\/serde['"] would incorrectly match malformed imports like from '@workflow/serde" (mixed quotes).

For consistency with the patterns used in other files (rollup, loader, vite, builders), consider using a backreference pattern like from\s+(['"])@workflow\/serde\1 to ensure the opening and closing quotes match. The same issue applies to the Symbol.for pattern which should use Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\1\s*\) to ensure matching quotes around the symbol name.

Suggested change
/(useworkflow|usestep|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
/(useworkflow|usestep|from\s+(['"])@workflow\/serde\2|Symbol\.for\s*\(\s*(['"])workflow-(?:serialize|deserialize)\3\s*\))/,

Copilot uses AI. Check for mistakes.
Comment threadpackages/rollup/src/index.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment threadpackages/next/src/loader.ts Outdated
// These packages are already built and don't need client-side transformation
// Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths
const workflowSdkPathPattern =
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The workflowSdkPathPattern regex /[/\\](?:@workflow[/\\]|packages[/\\]...) doesn't match its comment which states it "Matches both: node_modules/@workflow/* and monorepo packages/*/dist paths". The regex will match any path containing @workflow[/\\], not just those under node_modules/.

This could incorrectly exclude user files from transformation if they have a directory named @workflow outside of node_modules. For consistency with the builders plugin (line 31-32 in packages/builders/src/discover-entries-esbuild-plugin.ts), consider either:

  1. Updating the regex to include node_modules prefix: /[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\]...)/
  2. Or updating the comment to accurately reflect what the regex matches
Suggested change
/[/\\](?:@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;
/[/\\](?:node_modules[/\\]@workflow[/\\]|packages[/\\](?:builders|core|rollup|vite|next|nitro|serde|workflow|swc-plugin-workflow)[/\\])/;

Copilot uses AI. Check for mistakes.
Comment on lines +79 to 88
// Use 'all' to combine: must match content AND must NOT be in generated path
all: [
// Exclude generated workflow route files from transformation
{ not: { path: /[/\\]\.well-known[/\\]workflow[/\\]/ } },
// Match files with workflow directives or custom serialization patterns
{
content: /(use workflow|use step)/,
content:
/(use workflow|use step|from\s+['"]@workflow\/serde['"]|Symbol\.for\s*\(\s*['"]workflow-(?:serialize|deserialize)['"]\s*\))/,
},
],

CopilotAIJan 27, 2026

Copy link

Choose a reason for hiding this comment

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

The change from using any to all may not properly merge with existing conditions from existingRules[key]?.condition. The previous code (visible in the diff's removed lines) attempted to preserve existing conditions with ...existingRules[key]?.condition and merge with existingRules[key]?.condition.any || [].

The new implementation using all doesn't include any merge logic for pre-existing conditions. If there are existing conditions in existingRules[key], they will be completely overwritten rather than merged. This could break user configurations that already define custom turbopack rules for these file extensions.

Consider preserving existing conditions by merging them appropriately, for example:

  • If existing conditions use all, merge the new conditions into the existing all array
  • If existing conditions use any or other structures, wrap both old and new conditions appropriately

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kind of valid but before we most likely still weren't going to match the same conditions if a user configured a loader with same regex so not new and a different regex could be used to avoid conflict by the user.

@vercelvercelBot 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.

🔧 Build Fix:

The code is trying to instantiate OpenAI as a constructor, but the OpenAI type from the imported module has no construct signatures. This is a TypeScript type error where the OpenAI class is not being instantiated correctly.

Fix on Vercel

Create shared transform-utils.ts in @workflow/builders with:
- Pattern detection (directives, serde imports, Symbol.for)
- Path exclusion checks (generated files, SDK files)
- Combined shouldTransformFile logic
Update rollup, next, and vite packages to use shared utilities
instead of duplicated regex patterns.

@VaguelySeriousVaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM but would love @ijjk 's input

ijjk
ijjk approved these changes Feb 3, 2026
@TooTallNateGraphite App

TooTallNate commented Feb 3, 2026

Copy link
Copy Markdown
MemberAuthor

Merge activity

  • Feb 3, 7:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Feb 3, 7:19 AM UTC: @TooTallNate merged this pull request with Graphite.

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.

4 participants

@TooTallNate@ijjk@VaguelySerious