no-new-date-in-workflow - ESLint plugin rules

This rule disallows new Date(...) and any Date.*(...) static-method call 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 new Date(...) and Date.*(...) calls 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  const now = new Date()8  return new WorkflowResponse(input)9})

Instead, wrap the date in transform or compute it inside a step:

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

Why it's Important#

A workflow's constructor and when().then() callbacks run at definition time, not execution time. So, a date created there is fixed when the workflow is registered, not when it runs. Wrap it in transform or a createStep callback so it evaluates at execution time.

Learn more in the Data Manipulation in Workflows documentation.

Fixable#

This rule isn't auto-fixable.