no-async-workflow-constructor - ESLint plugin rules

This rule disallows passing an async function to createWorkflow, since workflow constructors run at definition time and can't await.

Severity#

error. This rule is enabled in the recommended preset.

What it Targets#

This rule targets files in your project's src/workflows directory. It reports an async function passed as the second argument to createWorkflow.

The following code is reported by the rule:

src/workflows/example.ts
1import {2  createWorkflow,3  WorkflowResponse,4} from "@medusajs/framework/workflows-sdk"5
6createWorkflow("my-workflow", async (input) => {7  return new WorkflowResponse(input)8})

Instead, use a synchronous constructor and move asynchronous work into steps:

src/workflows/example.ts
1import {2  createWorkflow,3  WorkflowResponse,4} from "@medusajs/framework/workflows-sdk"5
6createWorkflow("my-workflow", (input) => {7  return new WorkflowResponse(input)8})

Why it's Important#

A workflow's constructor only defines the workflow's steps. It runs once at definition time, not on each execution, so it can't await asynchronous work. Use steps for asynchronous operations instead.

Learn more in the Workflow Constraints documentation.

Fixable#

This rule is auto-fixable. Run the linter with the --fix option to apply the fix automatically.