Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@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 support for `"use step"` functions in class instance methods by TooTallNate · Pull Request #777 · vercel/workflow · GitHub
Skip to content

Add support for "use step" functions in class instance methods - #777

Merged
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods
Feb 3, 2026
Merged

Add support for "use step" functions in class instance methods#777
TooTallNate merged 5 commits into
mainfrom
01-13-add_support_for_use_step_functions_in_class_instance_methods

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 14, 2026

Copy link
Copy Markdown
Member

Added support for "use step" directive in class instance methods, allowing instance methods to be used as workflow steps.

What changed?

  • Modified the SWC plugin to recognize and transform instance methods with the "use step" directive
  • Added registration logic for instance method steps using ClassName.prototype.methodName
  • Implemented proper serialization of class instances to preserve the this context across workflow/step boundaries
  • Added comprehensive end-to-end tests for instance method steps
  • Updated error handling to allow "use step" in instance methods while still preventing "use workflow" in instance methods

How to test?

The PR includes a new end-to-end test instanceMethodStepWorkflow that demonstrates the functionality:

  1. Run the e2e tests to verify the new instance method step functionality
  2. The test creates a Counter class with instance methods marked as steps
  3. It verifies that the instance methods can be called as steps with proper serialization of the this context
  4. It also verifies that multiple instances of the same class can be used independently

Why make this change?

This change enables a more natural object-oriented programming model when working with workflows. Previously, only static methods, standalone functions, and object methods could be marked as steps. Now, developers can create classes with instance methods that are steps, allowing for better encapsulation and more intuitive code organization. This is particularly useful for complex workflows that need to maintain state across multiple step invocations.

@changeset-bot

changeset-botBot commented Jan 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 16dd859

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

This PR includes changesets to release 16 packages
NameType
@workflow/swc-pluginPatch
@workflow/astroPatch
@workflow/buildersPatch
@workflow/cliPatch
@workflow/nestPatch
@workflow/nextPatch
@workflow/nitroPatch
@workflow/rollupPatch
@workflow/sveltekitPatch
workflowPatch
@workflow/vitePatch
@workflow/world-testingPatch
@workflow/docs-typecheckPatch
@workflow/nuxtPatch
@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

@vercel

vercelBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actionsBot commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production479038517
✅ 💻 Local Development438032470
✅ 📦 Local Production438032470
✅ 🐘 Local Postgres438032470
✅ 🪟 Windows470047
❌ 🌍 Community Worlds311690200
✅ 📋 Other129012141
Total20001691462315

❌ Failed Tests

🌍 Community Worlds (169 failed)

mongodb (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

redis (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

starter (43 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

turso (42 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
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro4304
✅ example4304
✅ express4304
✅ fastify4304
✅ hono4304
✅ nextjs-turbopack4601
✅ nextjs-webpack4601
✅ nitro4304
✅ nuxt4304
✅ sveltekit4304
✅ vite4304
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable4304
✅ express-stable4304
✅ fastify-stable4304
✅ hono-stable4304
✅ nextjs-turbopack-stable4700
✅ nextjs-webpack-stable4700
✅ nitro-stable4304
✅ nuxt-stable4304
✅ sveltekit-stable4304
✅ vite-stable4304
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack4700
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev300
❌ mongodb5420
✅ redis-dev300
❌ redis5420
✅ starter-dev300
❌ starter4430
✅ turso-dev300
❌ turso5420
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable4304
✅ e2e-local-postgres-nest-stable4304
✅ e2e-local-prod-nest-stable4304

📋 View full workflow run

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs

@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:

MDX syntax error: unexpected ! character on line 29. This appears to be invalid MDX code that should use {/* text */} for comments instead.

Fix on Vercel

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

Additional Suggestion:

Invalid MDX syntax: Vitepress-specific [!code highlight] comments cause MDX parsing errors and are not compatible with MDX rendering.

Fix on Vercel

@github-actions

github-actionsBot commented Jan 19, 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.044s (-1.8%)1.008s (~)0.963s101.00x
🐘 PostgresExpress0.295s (+0.8%)1.015s (~)0.720s106.65x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express0.675s (+3.5%)1.771s (+19.5% 🔺)1.096s101.00x

🔍 Observability: Express

workflow with 1 step

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express1.120s (~)2.008s (~)0.888s101.00x
🐘 PostgresExpress2.131s (~)3.016s (~)0.885s101.90x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express2.776s (+0.6%)3.943s (+5.2% 🔺)1.167s101.00x

🔍 Observability: Express

workflow with 10 sequential steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express10.964s (+1.0%)11.021s (~)0.057s51.00x
🐘 PostgresExpress20.458s (~)21.032s (~)0.574s51.87x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express23.160s (+1.1%)24.045s (+1.2%)0.885s51.00x

🔍 Observability: Express

Promise.all with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.537s (+5.0% 🔺)6.500s (+3.4%)0.963s51.00x
🐘 PostgresExpress30.927s (+11.6% 🔺)31.254s (+10.9% 🔺)0.327s25.59x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.954s (+26.1% 🔺)4.842s (+33.1% 🔺)0.888s71.00x

🔍 Observability: Express

Promise.all with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express5.493s (-0.8%)6.404s (-1.7%)0.910s51.00x
🐘 PostgresExpress33.888s (-0.6%)34.154s (-0.6%)0.266s16.17x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.700s (+13.1% 🔺)4.594s (+16.9% 🔺)0.894s71.00x

🔍 Observability: Express

Promise.race with 10 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.124s (+8.4% 🔺)6.601s (~)0.477s51.00x
🐘 PostgresExpress28.227s (-8.6% 🟢)28.610s (-8.3% 🟢)0.383s24.61x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.017s (-11.3% 🟢)3.786s (-3.6%)0.770s81.00x

🔍 Observability: Express

Promise.race with 25 concurrent steps

💻 Local Development

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express6.305s (+9.8% 🔺)7.250s (+8.8% 🔺)0.945s51.00x
🐘 PostgresExpress35.332s (+8.3% 🔺)36.085s (+9.1% 🔺)0.753s15.60x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.375s (+9.7% 🔺)4.106s (+7.6% 🔺)0.731s81.00x

🔍 Observability: Express

Stream Benchmarks(includes TTFB metrics)
workflow with stream

💻 Local Development

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
💻 Local🥇 Express0.208s (+10.8% 🔺)0.992s (~)0.018s (+19.9% 🔺)1.027s (~)0.819s101.00x
🐘 PostgresExpress2.243s (-3.0%)2.800s (+2.6%)0.000s (+Infinity% 🔺)3.015s (~)0.773s1010.80x

▲ Production (Vercel)

WorldFrameworkWorkflow TimeTTFBSlurpWall TimeOverheadSamplesvs Fastest
▲ Vercel🥇 Express3.029s (+1.8%)3.294s (+2.7%)0.794s (-33.9% 🟢)4.724s (-4.4%)1.695s101.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

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

Adds SWC transform + runtime support so class instance methods can be marked with "use step" and invoked as workflow steps while preserving this via serialization.

Changes:

  • Update SWC transform to detect "use step" in instance methods, generate ClassName.prototype.methodName step registrations, and proxy instance methods in workflow bundles.
  • Register serialization classes so this values can be dehydrated/hydrated across workflow ↔ step boundaries.
  • Add end-to-end coverage plus transform fixtures for instance-method steps (including nested steps), and adjust error fixtures.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 7 comments.

Show a summary per file
FileDescription
workbench/example/workflows/99_e2e.tsAdds Counter + instanceMethodStepWorkflow e2e workflow demonstrating instance-method steps with custom serialization.
packages/core/e2e/e2e.test.tsAdds e2e test validating instance-method step execution + step list expectations.
packages/swc-plugin-workflow/transform/src/lib.rsCore transform changes: allow "use step" on instance methods, register prototype step functions, and proxy them in workflow mode.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/input.jsNew fixture input for instance-method step transformation.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.jsExpected client output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.jsExpected step-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.jsExpected workflow-bundle output for instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/input.jsNew fixture input for nested steps inside an instance-method step.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.jsExpected client output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.jsExpected step-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.jsExpected workflow-bundle output for nested instance-method step fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/input.jsUpdates error fixture to allow "use step" on instance methods but still forbid "use workflow".
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.jsExpected client output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.stderrUpdated expected stderr for client mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.jsExpected step output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.stderrUpdated expected stderr for step mode.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.jsExpected workflow output for updated instance-method error fixture.
packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.stderrUpdated expected stderr for workflow mode.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.jsUpdates expected output to treat instance method step as supported.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-step.stderrAdjusted expected stderr (now empty).
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.jsUpdates expected output to proxy/register the instance method step.
packages/swc-plugin-workflow/transform/tests/errors/forbidden-expressions/output-workflow.stderrAdjusted expected stderr (now empty).
.changeset/legal-parts-happen.mdPublishes a patch changeset for @workflow/swc-plugin.

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

Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs Outdated
Comment threadpackages/swc-plugin-workflow/transform/src/lib.rs
Comment threadworkbench/example/workflows/99_e2e.ts
Comment on lines 6522 to 6531
class_decl.class.body.retain(|member| {
if let ClassMember::Method(method) = member {
if method.is_static {
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
return !methods_to_strip.contains(&method_name);
if let PropName::Ident(ident) = &method.key {
let method_name = ident.sym.to_string();
if method.is_static {
return !static_methods_to_strip.contains(&method_name);
} else {
return !instance_methods_to_strip.contains(&method_name);
}
}

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

The workflow-mode stripping logic only checks PropName::Ident for class methods. Instance (and static) methods with string keys (e.g. async 'foo-bar'() { 'use step' }) are supported earlier, but won’t be removed here, so the original method body can remain in the workflow bundle instead of being replaced by the step proxy. Extend this retain() filter to also handle PropName::Str (and keep the stripping key representation consistent with how method_name is collected).

Copilot uses AI. Check for mistakes.
Comment on lines +21 to +22
const helper = helper;
const doubled = await helper(input);

CopilotAIJan 30, 2026

Copy link

Choose a reason for hiding this comment

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

Callee is not a function: it has type undefined.

Suggested change
consthelper=helper;
constdoubled=awaithelper(input);
constlocalHelper=helper;
constdoubled=awaitlocalHelper(input);

Copilot uses AI. Check for mistakes.
@@ -1,10 +0,0 @@
x Instance methods cannot be marked with "use step". Only static methods, functions, and object methods are supported.

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.

Should these .stderr files be deleted then?

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.

3 participants

@TooTallNate@VaguelySerious