Back to Medusa

{metadata.title}

www/apps/resources/app/lint/rules/no-new-date-in-workflow/page.mdx

2.17.01.6 KB
Original Source

export const metadata = { title: no-new-date-in-workflow - ESLint plugin rules, }

{metadata.title}

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:

ts
import {
  createWorkflow,
  WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"

createWorkflow("my-workflow", (input) => {
  const now = new Date()
  return new WorkflowResponse(input)
})

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

ts
import {
  createWorkflow,
  transform,
  WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"

createWorkflow("my-workflow", (input) => {
  const now = transform({}, () => new Date())

  return new WorkflowResponse(now)
})

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.