no-try-catch-in-workflow - ESLint plugin rules

This rule disallows try/catch statements directly inside a createWorkflow constructor or a when().then() callback.

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 try/catch statements placed directly in a workflow's constructor or in a when().then() callback.

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", (input) => {7  try {8    return new WorkflowResponse(doSomething(input))9  } catch (e) {10    return new WorkflowResponse(null)11  }12})

Instead, use a step's compensation function or its error-handling options:

src/workflows/example.ts
1import {2  createWorkflow,3  WorkflowResponse,4} from "@medusajs/framework/workflows-sdk"5
6createWorkflow("my-workflow", (input) => {7  const result = doSomethingStep(input).config({8    continueOnPermanentFailure: true,9  })10
11  return new WorkflowResponse(result)12})

Why it's Important#

A workflow's constructor and when().then() callbacks run at definition time, not execution time. So, a try/catch there doesn't catch step errors. Use steps with compensation functions, throwOnError: false, or skipOnPermanentFailure / continueOnPermanentFailure instead.

Learn more in the Error Handling in Workflows documentation.

Fixable#

This rule isn't auto-fixable.