skills/vercel__workflow
1
0
Fork 0
mirror of https://github.com/vercel/workflow.git synced 2026-09-14 19:59:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

Set workflowId property directly after function declarations (#548)

Browse Source 
Set `workflowId` property directly after function declarations in the SWC plugin.

### What changed?

Modified the SWC plugin to add the `workflowId` property immediately after workflow function declarations instead of collecting and adding them at the end of the file. This change applies to all transform modes (Client, Step, and Workflow).

The key changes include:
- Removed mode-specific conditions for adding `workflowId` assignments
- Simplified the code by adding `workflowId` inline for all workflow functions
- Cleared the `workflow_exports_to_expand` collection since it's no longer needed

### How to test?

1. Run the test suite to verify that all tests pass with the updated output format
2. Check the test fixtures to confirm that `workflowId` properties now appear directly after their respective function declarations
3. Verify that the behavior is consistent across all transform modes

### Why make this change?

This change improves code organization by placing the `workflowId` property closer to its associated function declaration, making the generated code more readable and maintainable. It also simplifies the plugin's logic by using a consistent approach across all transform modes rather than handling different modes separately.
This commit is contained in:
Nathan Rajlich
2025-12-05 14:30:04 -08:00
committed by GitHub
parent f46c51e30f
commit fa37d26275
5 changed files with 64 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/odd-years-fail.md
+5
View File
@@ -0,0 +1,5 @@
---
"@workflow/swc-plugin": patch
---
Set `workflowId` property directly after function declarations
packages/swc-plugin-workflow/transform/src/lib.rs
+54 -108
View File
@@ -3721,43 +3721,38 @@ impl VisitMut for StepTransform {
item.visit_mut_with(self);
// After visiting the item, check if we need to add a workflowId assignment
// In Client/Step modes: add for all workflow functions
// In Workflow mode: add for non-exported workflow functions that are later exported via `export { ... }`
// (directly exported ones are handled by workflow_exports_to_expand at end of file)
// Add workflowId directly after the function declaration for all modes
match item {
ModuleItem::ModuleDecl(ModuleDecl::ExportDecl(export_decl)) => {
// Directly exported - only handle in Client/Step modes
// (Workflow mode handles these via workflow_exports_to_expand)
if matches!(self.mode, TransformMode::Client | TransformMode::Step) {
if let Decl::Fn(fn_decl) = &export_decl.decl {
let fn_name = fn_decl.ident.sym.to_string();
if self.workflow_function_names.contains(&fn_name) {
items_to_insert.push((
i + 1,
ModuleItem::Stmt(self.create_workflow_id_assignment(
&fn_name,
fn_decl.function.span,
)),
));
}
} else if let Decl::Var(var_decl) = &export_decl.decl {
for declarator in &var_decl.decls {
if let Pat::Ident(binding) = &declarator.name {
let name = binding.id.sym.to_string();
if self.workflow_function_names.contains(&name) {
if let Some(init) = &declarator.init {
let span = match &**init {
Expr::Fn(fn_expr) => fn_expr.function.span,
Expr::Arrow(arrow_expr) => arrow_expr.span,
_ => declarator.span,
};
items_to_insert.push((
i + 1,
ModuleItem::Stmt(
self.create_workflow_id_assignment(&name, span),
),
));
}
// Directly exported function/variable declaration
if let Decl::Fn(fn_decl) = &export_decl.decl {
let fn_name = fn_decl.ident.sym.to_string();
if self.workflow_function_names.contains(&fn_name) {
items_to_insert.push((
i + 1,
ModuleItem::Stmt(self.create_workflow_id_assignment(
&fn_name,
fn_decl.function.span,
)),
));
}
} else if let Decl::Var(var_decl) = &export_decl.decl {
for declarator in &var_decl.decls {
if let Pat::Ident(binding) = &declarator.name {
let name = binding.id.sym.to_string();
if self.workflow_function_names.contains(&name) {
if let Some(init) = &declarator.init {
let span = match &**init {
Expr::Fn(fn_expr) => fn_expr.function.span,
Expr::Arrow(arrow_expr) => arrow_expr.span,
_ => declarator.span,
};
items_to_insert.push((
i + 1,
ModuleItem::Stmt(
self.create_workflow_id_assignment(&name, span),
),
));
}
}
}
@@ -3765,26 +3760,24 @@ impl VisitMut for StepTransform {
}
}
ModuleItem::ModuleDecl(ModuleDecl::ExportDefaultDecl(default_decl)) => {
// Default exports - only handle in Client/Step modes
if matches!(self.mode, TransformMode::Client | TransformMode::Step) {
if let DefaultDecl::Fn(fn_expr) = &default_decl.decl {
// Check if this is a workflow function by checking for "default" key
if self.workflow_function_names.contains("default") {
// Only add workflowId for named default exports
// Anonymous ones are handled by default_workflow_exports
if let Some(ident) = &fn_expr.ident {
// Named default export: use the function name
let fn_name = ident.sym.to_string();
items_to_insert.push((
i + 1,
ModuleItem::Stmt(self.create_workflow_id_assignment(
&fn_name,
fn_expr.function.span,
)),
));
}
// Anonymous default exports will have workflowId added by default_workflow_exports processing
// Default exports
if let DefaultDecl::Fn(fn_expr) = &default_decl.decl {
// Check if this is a workflow function by checking for "default" key
if self.workflow_function_names.contains("default") {
// Only add workflowId for named default exports
// Anonymous ones are handled by default_workflow_exports
if let Some(ident) = &fn_expr.ident {
// Named default export: use the function name
let fn_name = ident.sym.to_string();
items_to_insert.push((
i + 1,
ModuleItem::Stmt(self.create_workflow_id_assignment(
&fn_name,
fn_expr.function.span,
)),
));
}
// Anonymous default exports will have workflowId added by default_workflow_exports processing
}
}
}
@@ -3849,19 +3842,8 @@ impl VisitMut for StepTransform {
items.insert(index, item);
}
// In workflow mode, add workflowId property to workflow functions (at end of file)
// Note: This handles directly exported workflow functions
if self.mode == TransformMode::Workflow && !self.workflow_exports_to_expand.is_empty() {
// Process workflow functions to add workflowId property
let workflow_functions: Vec<_> = self.workflow_exports_to_expand.drain(..).collect();
for (fn_name, _, span) in workflow_functions {
// Add workflowId assignment after the function declaration
items.push(ModuleItem::Stmt(
self.create_workflow_id_assignment(&fn_name, span),
));
}
}
// Clear workflow_exports_to_expand since workflowId is now added inline
self.workflow_exports_to_expand.clear();
// Handle default workflow exports (all modes)
// We need to: 1) find the export default position, 2) replace it with const declaration,
@@ -4301,22 +4283,8 @@ impl VisitMut for StepTransform {
// Store fn_name for later use after visiting children
}
TransformMode::Workflow => {
// Remove directive before cloning (for the metadata)
// Clone without the directive
// Note: We keep the directive in place for now so nested steps can detect it,
// but we'll remove it from the clone. The original will have it removed later.
// Just remove the directive - workflowId is added inline in visit_mut_module_items
self.remove_use_workflow_directive(&mut fn_decl.function.body);
let cloned_ident = fn_decl.ident.clone();
let cloned_function = fn_decl.function.clone();
let span = fn_decl.function.span;
self.workflow_exports_to_expand.push((
fn_name,
Expr::Fn(FnExpr {
ident: Some(cloned_ident),
function: cloned_function,
}),
span,
));
}
TransformMode::Client => {
// Only replace with throw if function has inline directive
@@ -4534,17 +4502,10 @@ impl VisitMut for StepTransform {
));
}
TransformMode::Workflow => {
// In workflow mode, just remove the directive
// Just remove the directive - workflowId is added inline in visit_mut_module_items
self.remove_use_workflow_directive(
&mut fn_expr.function.body,
);
// Mark this function for expansion
self.workflow_exports_to_expand.push((
name.clone(),
Expr::Fn(fn_expr.clone()),
fn_expr.function.span,
));
}
TransformMode::Client => {
// Only replace with throw if function has inline directive
@@ -4711,17 +4672,10 @@ impl VisitMut for StepTransform {
.push((name.clone(), arrow_expr.span));
}
TransformMode::Workflow => {
// In workflow mode, just remove the directive
// Just remove the directive - workflowId is added inline in visit_mut_module_items
self.remove_use_workflow_directive_arrow(
&mut arrow_expr.body,
);
// Mark this function for expansion
self.workflow_exports_to_expand.push((
name.clone(),
Expr::Arrow(arrow_expr.clone()),
arrow_expr.span,
));
}
TransformMode::Client => {
// Only replace with throw if function has inline directive
@@ -5789,7 +5743,7 @@ impl VisitMut for StepTransform {
}
}
TransformMode::Workflow => {
// In workflow mode, just remove the directive
// Remove the directive - workflowId for named default exports is handled inline
self.remove_use_workflow_directive(&mut fn_expr.function.body);
if fn_name == "default" {
@@ -5810,16 +5764,8 @@ impl VisitMut for StepTransform {
SyntaxContext::empty(),
)),
));
} else {
// Named default export: can reference by name
// export default async function name() { ... }
// name.workflowId = "...";
self.workflow_exports_to_expand.push((
const_name,
Expr::Fn(fn_expr.clone()),
fn_expr.function.span,
));
}
// Named default exports: workflowId is added inline in visit_mut_module_items
}
}
}
packages/swc-plugin-workflow/transform/tests/fixture/mixed-functions/output-workflow.js
+1 -1
View File
@@ -6,7 +6,7 @@ export async function workflowFunction(a, b) {
const result2 = await stepFunctionWithoutExport(a, b);
return result + result2;
}
workflowFunction.workflowId = "workflow//input.js//workflowFunction";
export async function normalFunction(a, b) {
return a * b;
}
workflowFunction.workflowId = "workflow//input.js//workflowFunction";
packages/swc-plugin-workflow/transform/tests/fixture/module-level-workflow/output-workflow.js
+1 -1
View File
@@ -2,8 +2,8 @@
export async function workflow(input) {
return input.foo;
}
workflow.workflowId = "workflow//input.js//workflow";
export const arrowWorkflow = async (input)=>{
return input.bar;
};
workflow.workflowId = "workflow//input.js//workflow";
arrowWorkflow.workflowId = "workflow//input.js//arrowWorkflow";
packages/swc-plugin-workflow/transform/tests/fixture/workflow-client-property/output-workflow.js
+3 -3
View File
@@ -4,13 +4,16 @@ export async function myWorkflow() {
const result = await someStep();
return result;
}
myWorkflow.workflowId = "workflow//input.js//myWorkflow";
export const arrowWorkflow = async ()=>{
const data = await fetchData();
return data;
};
arrowWorkflow.workflowId = "workflow//input.js//arrowWorkflow";
export default async function defaultWorkflow() {
return await process();
}
defaultWorkflow.workflowId = "workflow//input.js//defaultWorkflow";
// Non-export workflow function
async function internalWorkflow() {
return 'internal';
@@ -21,6 +24,3 @@ regularFunction(internalWorkflow);
export function regularFunction() {
return 'regular';
}
myWorkflow.workflowId = "workflow//input.js//myWorkflow";
arrowWorkflow.workflowId = "workflow//input.js//arrowWorkflow";
defaultWorkflow.workflowId = "workflow//input.js//defaultWorkflow";