Uh oh!
There was an error while loading. Please reload this page.
Inline class serialization registration to fix 3rd-party package support (v2) - #1503
Merged
TooTallNate merged 2 commits intoMar 24, 2026
Merged
Conversation
…ort (#1480) * Inline class serialization registration to fix 3rd-party package support The SWC plugin previously generated: import { registerSerializationClass } from "workflow/internal/class-serialization"; registerSerializationClass("class//...", ClassName); This broke for 3rd-party packages (e.g. @vercel/sandbox) that define serializable classes but don't depend on the 'workflow' package. The bare 'workflow' specifier is unresolvable from within node_modules of a package that doesn't list it as a dependency. Now the plugin generates a self-contained IIFE that uses Symbol.for('workflow-class-registry') on globalThis directly, with zero module dependencies: (function(__wf_cls, __wf_id) { var __wf_sym = Symbol.for("workflow-class-registry"), __wf_reg = globalThis[__wf_sym] || (globalThis[__wf_sym] = new Map()); __wf_reg.set(__wf_id, __wf_cls); Object.defineProperty(__wf_cls, "classId", { ... }); })(ClassName, "class//..."); This is fully compatible with the existing deserialization side in @workflow/core which reads from the same globalThis registry. * Address review feedback: fix comment and update docstring - Fix inaccurate IIFE comment in lib.rs: the second arg is the generated class ID string, not the literal "classId" - Update registerSerializationClass docstring to reflect that the SWC plugin now inlines equivalent logic rather than importing it
The original PR #1480 was merged but reverted because it didn't include updated fixtures for the CJS require patterns added by PR #1144 (custom-serialization-require-destructured and custom-serialization-require-namespace). These fixtures still had the old 'import { registerSerializationClass }' pattern instead of the new inline IIFE.
🦋 Changeset detectedLatest commit: 9dba3d5 The changes in this PR will be included in the next version bump. 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 |
Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests▲ Vercel Production (1 failed)nextjs-turbopack (1 failed):
🌍 Community Worlds (56 failed)mongodb (3 failed):
redis (2 failed):
turso (51 failed):
Details by Category❌ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
✅ 📋 Other
❌ Some E2E test jobs failed:
Check the workflow run for details. |
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 25 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 50 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) Promise.all with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) Promise.race with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 10 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro workflow with 25 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 50 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 10 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 25 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) workflow with 50 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) Stream Benchmarks(includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) stream pipeline with 5 transform steps (1MB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro 10 parallel streams (1MB each)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) fan-out fan-in 10 streams (1MB each)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
❌ Some benchmark jobs failed:
Check the workflow run for details. |
Contributor
There was a problem hiding this comment.
Pull request overview
Re-lands the SWC transform change that inlines class-serialization registration (to avoid importing workflow/internal/class-serialization from transformed 3rd-party packages), and updates fixture outputs (including the missing CommonJS require() fixtures) to match the new generated IIFE.
Changes:
- SWC plugin now emits a self-contained IIFE to register serializable classes in
globalThis[Symbol.for("workflow-class-registry")](noworkflow/*import required). - Updates many SWC transform fixture outputs (workflow/step/client + CJS require fixtures) to reflect the new inlined registration.
- Updates SWC plugin spec examples + core class-serialization docs, and adds a Changeset entry.
Reviewed changes
Copilot reviewed 37 out of 37 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/swc-plugin-workflow/transform/src/lib.rs | Generate inline IIFE for class registration; remove import-based registration path. |
| packages/swc-plugin-workflow/spec.md | Update documentation examples to the new inlined registration output. |
| packages/core/src/class-serialization.ts | Update docs to note SWC no longer imports this helper in generated code. |
| .changeset/inline-class-serialization.md | Adds release note for the SWC plugin change. |
| packages/swc-plugin-workflow/transform/tests/fixture/step-with-this-arguments-super/output-workflow.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/step-with-this-arguments-super/output-step.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/step-with-this-arguments-super/output-client.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/static-method-step/output-workflow.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/static-method-step/output-step.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/static-method-step/output-client.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-workflow.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-step.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/instance-method-step/output-client.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-workflow.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-step.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/instance-method-nested-step/output-client.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization/output-workflow.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization/output-step.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization/output-client.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-require-namespace/output-workflow.js | CJS require fixture output updated to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-require-namespace/output-step.js | CJS require fixture output updated to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-require-namespace/output-client.js | CJS require fixture output updated to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-require-destructured/output-workflow.js | CJS require fixture output updated to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-require-destructured/output-step.js | CJS require fixture output updated to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-require-destructured/output-client.js | CJS require fixture output updated to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-local-const/output-workflow.js | Fixture output updated for multiple class registrations via repeated IIFEs. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-local-const/output-step.js | Fixture output updated for multiple class registrations via repeated IIFEs. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-local-const/output-client.js | Fixture output updated for multiple class registrations via repeated IIFEs. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-imported/output-workflow.js | Fixture output updated for multiple class registrations via repeated IIFEs. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-imported/output-step.js | Fixture output updated for multiple class registrations via repeated IIFEs. |
| packages/swc-plugin-workflow/transform/tests/fixture/custom-serialization-imported/output-client.js | Fixture output updated for multiple class registrations via repeated IIFEs. |
| packages/swc-plugin-workflow/transform/tests/fixture/class-expression-binding-name/output-workflow.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/class-expression-binding-name/output-step.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/fixture/class-expression-binding-name/output-client.js | Fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-workflow.js | Error fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-step.js | Error fixture output updated from import+call to inline IIFE registration. |
| packages/swc-plugin-workflow/transform/tests/errors/instance-methods/output-client.js | Error fixture output updated from import+call to inline IIFE registration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "@workflow/swc-plugin-workflow": patch | |||
There was a problem hiding this comment.
The changeset targets a package name that doesn’t exist in this repo. packages/swc-plugin-workflow/package.json declares the SWC plugin package as @workflow/swc-plugin, so this changeset should likely bump that package instead (otherwise Changesets will fail or ignore the release).
Suggested change
| "@workflow/swc-plugin-workflow": patch | |
| "@workflow/swc-plugin": patch |
| right: Box::new(Expr::New(NewExpr { | ||
| span: DUMMY_SP, | ||
| ctxt: SyntaxContext::empty(), | ||
| callee: ident_expr("Map"), |
There was a problem hiding this comment.
The inlined registration uses unqualified globals (Map/Object/Symbol). If the transformed module has local bindings named Map or Object, this will change behavior compared to the previous imported helper (which referenced built-ins from its own module scope). Consider referencing built-ins off globalThis (e.g. globalThis.Map, globalThis.Object, globalThis.Symbol) to avoid shadowing issues in user code.
Suggested change
| callee:ident_expr("Map"), | |
| callee:Box::new(Expr::Member(MemberExpr{ | |
| span:DUMMY_SP, | |
| obj:ident_expr("globalThis"), | |
| prop:MemberProp::Ident(IdentName{ | |
| span:DUMMY_SP, | |
| sym:"Map".into(), | |
| }), | |
| })), |
Uh oh!
There was an error while loading. Please reload this page.
TooTallNate
deleted the
nrajlich/inline-class-serialization-registration-v2
branch
March 24, 2026 12:30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-lands #1480 (which was reverted in #1493) with the missing CJS require fixture updates.
What happened
PR #1480 was merged to main but the post-merge E2E CI failed with 6 SWC fixture test failures. The failures were in
custom-serialization-require-destructuredandcustom-serialization-require-namespace— fixture directories that were added by PR #1144 (CJS require detection) which landed on main after #1480's branch was created. The original PR's fixtures were correct for all tests that existed at branch time, but the 6 new CJS fixtures still had the oldimport { registerSerializationClass }pattern.Fix
Updated the 6 CJS require fixture output files to use the inline IIFE registration pattern, matching all other fixture outputs. All 135 SWC tests pass (129 original + 6 CJS).
Changes
This PR contains two commits:
The core change is identical to #1480 — see that PR for full context.