Uh oh!
There was an error while loading. Please reload this page.
Normalize anonymous default export workflow IDs to "default" - #484
Merged
TooTallNate merged 3 commits intoDec 2, 2025
Merged
Conversation
🦋 Changeset detectedLatest commit: 0346122 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
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
📊 Benchmark Results
workflow with no steps
workflow with 1 step
workflow with 10 sequential steps
workflow with 10 parallel steps
Stream BenchmarksStream benchmarks include Time to First Byte (TTFB) metrics. workflow with stream
Summary: Fastest Framework by WorldWinner determined by most benchmark wins
Summary: Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
|
TooTallNate
marked this pull request as ready for review
December 2, 2025 08:29
TooTallNate
requested review from
Schniz, VaguelySerious, adriandlam and pranaygpDecember 2, 2025 08:29
| .into_iter() | ||
| .map(|fn_name| { | ||
| // Check if this export name has a different const name (e.g., "default" -> "__default") | ||
| // Use the export name for the workflow ID (e.g., "default" not "__default") |
Contributor
There was a problem hiding this comment.
The metadata comment generation was simplified to always use "default" as the workflow ID for default exports, but this creates an inconsistency for named default exports where the actual function property gets a different workflow ID.
View Details
📝 Patch Details
diff --git a/packages/swc-plugin-workflow/transform/src/lib.rs b/packages/swc-plugin-workflow/transform/src/lib.rs
index 35a7d1d..a89f7fb 100644
--- a/packages/swc-plugin-workflow/transform/src/lib.rs+++ b/packages/swc-plugin-workflow/transform/src/lib.rs@@ -2684,13 +2684,34 @@ impl StepTransform {
let workflow_entries: Vec<String> = sorted_workflow_names
.into_iter()
.map(|fn_name| {
- // Use the export name for the workflow ID (e.g., "default" not "__default")
let fn_name_str: &str = fn_name;
- let workflow_id = self.create_id(Some(fn_name_str), DUMMY_SP, true);- format!("\"{}\":{{\"workflowId\":\"{}\"}}", fn_name_str, workflow_id)++ // For default exports, determine the actual function name+ // Apply the same normalization logic as create_workflow_id_assignment+ let actual_fn_name = if fn_name_str == "default" {+ // Look up the actual const name for this default export+ if let Some(const_name) = self.workflow_export_to_const_name.get("default") {+ // Check if this is an auto-generated __default variant+ if (const_name == "__default" || const_name.starts_with("__default$")) {+ // Auto-generated: use "default" as the key+ "default"+ } else {+ // Named: use the actual function name+ const_name.as_str()+ }+ } else {+ // Fallback to "default" if mapping not found+ "default"+ }+ } else {+ fn_name_str+ };++ let workflow_id = self.create_id(Some(actual_fn_name), DUMMY_SP, true);+ format!("\"{}\":{{\"workflowId\":\"{}\"}}", actual_fn_name, workflow_id)+
})
.collect();
-
metadata.insert("workflows", format!("{{{}}}", workflow_entries.join(",")));
}
diff --git a/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-client.js b/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-client.js
index 55698e3..32024d9 100644
--- a/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-client.js+++ b/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-client.js@@ -1,5 +1,5 @@
// Test workflow functions in client mode
-/**__internal_workflows{"workflows":{"input.js":{"arrowWorkflow":{"workflowId":"workflow//input.js//arrowWorkflow"},"default":{"workflowId":"workflow//input.js//default"},"internalWorkflow":{"workflowId":"workflow//input.js//internalWorkflow"},"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;+/**__internal_workflows{"workflows":{"input.js":{"arrowWorkflow":{"workflowId":"workflow//input.js//arrowWorkflow"},"defaultWorkflow":{"workflowId":"workflow//input.js//defaultWorkflow"},"internalWorkflow":{"workflowId":"workflow//input.js//internalWorkflow"},"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;
export async function myWorkflow() {
throw new Error("You attempted to execute workflow myWorkflow function directly. To start a workflow, use start(myWorkflow) from workflow/api");
}
diff --git a/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-step.js b/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-step.js
index 55698e3..32024d9 100644
--- a/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-step.js+++ b/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-step.js@@ -1,5 +1,5 @@
// Test workflow functions in client mode
-/**__internal_workflows{"workflows":{"input.js":{"arrowWorkflow":{"workflowId":"workflow//input.js//arrowWorkflow"},"default":{"workflowId":"workflow//input.js//default"},"internalWorkflow":{"workflowId":"workflow//input.js//internalWorkflow"},"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;+/**__internal_workflows{"workflows":{"input.js":{"arrowWorkflow":{"workflowId":"workflow//input.js//arrowWorkflow"},"defaultWorkflow":{"workflowId":"workflow//input.js//defaultWorkflow"},"internalWorkflow":{"workflowId":"workflow//input.js//internalWorkflow"},"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;
export async function myWorkflow() {
throw new Error("You attempted to execute workflow myWorkflow function directly. To start a workflow, use start(myWorkflow) from workflow/api");
}
diff --git a/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-workflow.js b/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-workflow.js
index 9a8dd4c..27047e0 100644
--- a/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-workflow.js+++ b/packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-workflow.js@@ -1,5 +1,5 @@
// Test workflow functions in client mode
-/**__internal_workflows{"workflows":{"input.js":{"arrowWorkflow":{"workflowId":"workflow//input.js//arrowWorkflow"},"default":{"workflowId":"workflow//input.js//default"},"internalWorkflow":{"workflowId":"workflow//input.js//internalWorkflow"},"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;+/**__internal_workflows{"workflows":{"input.js":{"arrowWorkflow":{"workflowId":"workflow//input.js//arrowWorkflow"},"defaultWorkflow":{"workflowId":"workflow//input.js//defaultWorkflow"},"internalWorkflow":{"workflowId":"workflow//input.js//internalWorkflow"},"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;
export async function myWorkflow() {
const result = await someStep();
return result;
Analysis
Inconsistent metadata keys for named default export workflows
What fails: For named default exports like export default async function defaultWorkflow(), the metadata comment uses the export name "default" as the key while the actual function property is set with the function name "defaultWorkflow", creating an inconsistency.
How to reproduce:
// input.jsexportdefaultasyncfunctiondefaultWorkflow(){'use workflow';returnawaitprocess();}Run the SWC plugin in client mode on this file.
Result before fix:
- Metadata comment key:
"default":{"workflowId":"workflow//input.js//default"} - Actual function property:
defaultWorkflow.workflowId = "workflow//input.js//defaultWorkflow"
The metadata key doesn't match the actual function name.
Result after fix:
- Metadata comment key:
"defaultWorkflow":{"workflowId":"workflow//input.js//defaultWorkflow"} - Actual function property:
defaultWorkflow.workflowId = "workflow//input.js//defaultWorkflow"
Now they are consistent - the metadata key and the function property both reference the actual function name.
Why this matters: The metadata is used to map workflow identifiers to their implementations. When the metadata key doesn't match the actual function name, consumers of this metadata need special logic to handle default exports. By normalizing the metadata to use the actual function name for named default exports (while preserving "default" for truly anonymous exports), the metadata becomes consistent and easier to consume.
Contributor
looks like e2e tests are failing @TooTallNate ohh turborepo related? https://github.com/vercel/workflow/actions/runs/19868199087/job/56936552363?pr=484 |
pranaygp
approved these changes
Dec 2, 2025
TooTallNateforce-pushed
the
12-02-normalize_anonymous_default_export_workflow_ids_to_default_
branch
from
December 2, 2025 18:36
f2f6418 to
0346122CompareUh oh!
There was an error while loading. Please reload this page.
TooTallNate
deleted the
12-02-normalize_anonymous_default_export_workflow_ids_to_default_
branch
December 2, 2025 19:26
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
2 participants
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.
So that we show "default" as the workflow name in o11y UI instead of "__default"