asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(): Workflow engine timers and notification improvements (#13434)

Browse Source 
RESOLVES CORE-1177

**What**
main changes are:
- not blocking execution when notifying
- timers management
- race condition checks improvements
This commit is contained in:
Adrien de Peretti
2025-09-08 20:19:55 +02:00
committed by GitHub
parent b776fd55dc
commit fc4d5f0ac9
14 changed files with 464 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
packages/modules/workflow-engine-redis/src/migrations/.snapshot-medusa-workflows.json
View File

@@ -186,6 +186,42 @@
"unique": false,
"expression": "CREATE INDEX IF NOT EXISTS \"IDX_workflow_execution_run_id\" ON \"workflow_execution\" (run_id) WHERE deleted_at IS NULL"
},
{
"keyName": "IDX_workflow_execution_workflow_id_transaction_id",
"columnNames": [],
"composite": false,
"constraint": false,
"primary": false,
"unique": false,
"expression": "CREATE INDEX IF NOT EXISTS \"IDX_workflow_execution_workflow_id_transaction_id\" ON \"workflow_execution\" (workflow_id, transaction_id) WHERE deleted_at IS NULL"
},
{
"keyName": "IDX_workflow_execution_state_updated_at",
"columnNames": [],
"composite": false,
"constraint": false,
"primary": false,
"unique": false,
"expression": "CREATE INDEX IF NOT EXISTS \"IDX_workflow_execution_state_updated_at\" ON \"workflow_execution\" (state, updated_at) WHERE deleted_at IS NULL"
},
{
"keyName": "IDX_workflow_execution_retention_time_updated_at_state",
"columnNames": [],
"composite": false,
"constraint": false,
"primary": false,
"unique": false,
"expression": "CREATE INDEX IF NOT EXISTS \"IDX_workflow_execution_retention_time_updated_at_state\" ON \"workflow_execution\" (retention_time, updated_at, state) WHERE deleted_at IS NULL AND retention_time IS NOT NULL"
},
{
"keyName": "IDX_workflow_execution_updated_at_retention_time",
"columnNames": [],
"composite": false,
"constraint": false,
"primary": false,
"unique": false,
"expression": "CREATE INDEX IF NOT EXISTS \"IDX_workflow_execution_updated_at_retention_time\" ON \"workflow_execution\" (updated_at, retention_time) WHERE deleted_at IS NULL AND retention_time IS NOT NULL AND state IN ('done', 'failed', 'reverted')"
},
{
"keyName": "workflow_execution_pkey",
"columnNames": [

19
packages/modules/workflow-engine-redis/src/migrations/Migration20250908080326.ts Normal file
View File

@@ -0,0 +1,19 @@
import { Migration } from '@mikro-orm/migrations';
export class Migration20250908080326 extends Migration {
override async up(): Promise<void> {
this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_workflow_execution_workflow_id_transaction_id" ON "workflow_execution" (workflow_id, transaction_id) WHERE deleted_at IS NULL;`);
this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_workflow_execution_state_updated_at" ON "workflow_execution" (state, updated_at) WHERE deleted_at IS NULL;`);
this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_workflow_execution_retention_time_updated_at_state" ON "workflow_execution" (retention_time, updated_at, state) WHERE deleted_at IS NULL AND retention_time IS NOT NULL;`);
this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_workflow_execution_updated_at_retention_time" ON "workflow_execution" (updated_at, retention_time) WHERE deleted_at IS NULL AND retention_time IS NOT NULL AND state IN ('done', 'failed', 'reverted');`);
}
override async down(): Promise<void> {
this.addSql(`drop index if exists "IDX_workflow_execution_workflow_id_transaction_id";`);
this.addSql(`drop index if exists "IDX_workflow_execution_state_updated_at";`);
this.addSql(`drop index if exists "IDX_workflow_execution_retention_time_updated_at_state";`);
this.addSql(`drop index if exists "IDX_workflow_execution_updated_at_retention_time";`);
}
}

17
packages/modules/workflow-engine-redis/src/models/workflow-execution.ts
View File

@@ -38,4 +38,21 @@ export const WorkflowExecution = model
on: ["run_id"],
where: "deleted_at IS NULL",
},
{
on: ["workflow_id", "transaction_id"],
where: "deleted_at IS NULL",
},
{
on: ["state", "updated_at"],
where: "deleted_at IS NULL",
},
{
on: ["retention_time", "updated_at", "state"],
where: "deleted_at IS NULL AND retention_time IS NOT NULL",
},
{
on: ["updated_at", "retention_time"],
where:
"deleted_at IS NULL AND retention_time IS NOT NULL AND state IN ('done', 'failed', 'reverted')",
},
])

113
packages/modules/workflow-engine-redis/src/services/workflow-orchestrator.ts
View File

@@ -12,7 +12,11 @@ import {
Logger,
MedusaContainer,
} from "@medusajs/framework/types"
import { isString, TransactionState } from "@medusajs/framework/utils"
import {
isString,
promiseAll,
TransactionState,
} from "@medusajs/framework/utils"
import {
FlowCancelOptions,
FlowRunOptions,
@@ -21,7 +25,6 @@ import {
ReturnWorkflow,
} from "@medusajs/framework/workflows-sdk"
import Redis from "ioredis"
import { setTimeout } from "timers"
import { ulid } from "ulid"
import type { RedisDistributedTransactionStorage } from "../utils"
@@ -112,7 +115,6 @@ export class WorkflowOrchestratorService {
protected redisSubscriber: Redis
protected container_: MedusaContainer
private subscribers: Subscribers = new Map()
private activeStepsCount: number = 0
readonly #logger: Logger
@@ -149,10 +151,16 @@ export class WorkflowOrchestratorService {
this.redisDistributedTransactionStorage_ =
redisDistributedTransactionStorage
this.redisSubscriber.on("message", async (_, message) => {
const { instanceId, data } = JSON.parse(message)
this.redisSubscriber.on("message", async (channel, message) => {
const workflowId = channel.split(":")[1]
if (!this.subscribers.has(workflowId)) return
await this.notify(data, false, instanceId)
try {
const { instanceId, data } = JSON.parse(message)
await this.notify(data, false, instanceId)
} catch (error) {
this.#logger.error(`Failed to process Redis message: ${error}`)
}
})
}
@@ -163,10 +171,6 @@ export class WorkflowOrchestratorService {
async onApplicationPrepareShutdown() {
// eslint-disable-next-line max-len
await this.redisDistributedTransactionStorage_.onApplicationPrepareShutdown()
while (this.activeStepsCount > 0) {
await new Promise((resolve) => setTimeout(resolve, 1000))
}
}
async onApplicationStart() {
@@ -745,70 +749,67 @@ export class WorkflowOrchestratorService {
return
}
const {
isFlowAsync,
eventType,
workflowId,
transactionId,
errors,
result,
step,
response,
state,
} = options
const { workflowId, isFlowAsync } = options
// Non-blocking Redis publishing
if (publish && isFlowAsync) {
const channel = this.getChannelName(options.workflowId)
const message = JSON.stringify({
instanceId: this.instanceId,
data: options,
setImmediate(async () => {
try {
const channel = this.getChannelName(workflowId)
const message = JSON.stringify({
instanceId: this.instanceId,
data: options,
})
await this.redisPublisher.publish(channel, message)
} catch (error) {
this.#logger.error(`Failed to publish to Redis: ${error}`)
}
})
await this.redisPublisher.publish(channel, message)
}
// Process subscribers asynchronously
setImmediate(() => this.processSubscriberNotifications(options))
}
private async processSubscriberNotifications(options: NotifyOptions) {
const { workflowId, transactionId, eventType } = options
const subscribers: TransactionSubscribers =
this.subscribers.get(workflowId) ?? new Map()
const notifySubscribers = (handlers: SubscriberHandler[]) => {
handlers.forEach((handler) => {
const args = {
eventType,
workflowId,
transactionId,
isFlowAsync,
step,
response,
result,
errors,
state,
}
const isPromise = "then" in handler
if (isPromise) {
;(handler(args) as unknown as Promise<any>).catch((e) => {
this.#logger.error(e)
})
} else {
try {
handler(args)
} catch (e) {
this.#logger.error(e)
const notifySubscribersAsync = async (handlers: SubscriberHandler[]) => {
const promises = handlers.map(async (handler) => {
try {
const result = handler(options) as void | Promise<any>
if (result && typeof result === "object" && "then" in result) {
await (result as Promise<any>)
}
} catch (error) {
this.#logger.error(`Subscriber error: ${error}`)
}
})
await promiseAll(promises)
}
const tasks: Promise<void>[] = []
if (transactionId) {
const transactionSubscribers = subscribers.get(transactionId) ?? []
notifySubscribers(transactionSubscribers)
if (transactionSubscribers.length > 0) {
tasks.push(notifySubscribersAsync(transactionSubscribers))
}
// removes transaction id subscribers on finish
if (eventType === "onFinish") {
subscribers.delete(transactionId)
}
}
const workflowSubscribers = subscribers.get(AnySubscriber) ?? []
notifySubscribers(workflowSubscribers)
if (workflowSubscribers.length > 0) {
tasks.push(notifySubscribersAsync(workflowSubscribers))
}
await promiseAll(tasks)
}
private getChannelName(workflowId: string): string {
@@ -890,8 +891,6 @@ export class WorkflowOrchestratorService {
onStepBegin: async ({ step, transaction }) => {
customEventHandlers?.onStepBegin?.({ step, transaction })
this.activeStepsCount++
await notify({
eventType: "onStepBegin",
step,
@@ -911,8 +910,6 @@ export class WorkflowOrchestratorService {
response,
isFlowAsync: transaction.getFlow().hasAsyncSteps,
})
this.activeStepsCount--
},
onStepFailure: async ({ step, transaction }) => {
const stepName = step.definition.action!
@@ -927,8 +924,6 @@ export class WorkflowOrchestratorService {
errors,
isFlowAsync: transaction.getFlow().hasAsyncSteps,
})
this.activeStepsCount--
},
onStepAwaiting: async ({ step, transaction }) => {
customEventHandlers?.onStepAwaiting?.({ step, transaction })
@@ -938,8 +933,6 @@ export class WorkflowOrchestratorService {
step,
isFlowAsync: transaction.getFlow().hasAsyncSteps,
})
this.activeStepsCount--
},
onCompensateStepSuccess: async ({ step, transaction }) => {

37
packages/modules/workflow-engine-redis/src/services/workflows-module.ts
View File

@@ -293,37 +293,24 @@ export class WorkflowsModuleService<
})
}
@InjectSharedContext()
async subscribe(
args: {
workflowId: string
transactionId?: string
subscriber: Function
subscriberId?: string
},
@MedusaContext() context: Context = {}
) {
async subscribe(args: {
workflowId: string
transactionId?: string
subscriber: Function
subscriberId?: string
}) {
return this.workflowOrchestratorService_.subscribe(args as any)
}
@InjectSharedContext()
async unsubscribe(
args: {
workflowId: string
transactionId?: string
subscriberOrId: string | Function
},
@MedusaContext() context: Context = {}
) {
async unsubscribe(args: {
workflowId: string
transactionId?: string
subscriberOrId: string | Function
}) {
return this.workflowOrchestratorService_.unsubscribe(args as any)
}
@InjectSharedContext()
async cancel(
workflowId: string,
options: WorkflowOrchestratorCancelOptions,
@MedusaContext() context: Context = {}
) {
async cancel(workflowId: string, options: WorkflowOrchestratorCancelOptions) {
return await this.workflowOrchestratorService_.cancel(workflowId, options)
}
}

85
packages/modules/workflow-engine-redis/src/utils/workflow-orchestrator-storage.ts
View File

@@ -36,6 +36,24 @@ enum JobType {
const ONE_HOUR_IN_MS = 1000 * 60 * 60
const REPEATABLE_CLEARER_JOB_ID = "clear-expired-executions"
const invokingStatesSet = new Set([
TransactionStepState.INVOKING,
TransactionStepState.NOT_STARTED,
])
const compensatingStatesSet = new Set([
TransactionStepState.COMPENSATING,
TransactionStepState.NOT_STARTED,
])
function isInvokingState(step: TransactionStep) {
return invokingStatesSet.has(step.invoke?.state)
}
function isCompensatingState(step: TransactionStep) {
return compensatingStatesSet.has(step.compensate?.state)
}
export class RedisDistributedTransactionStorage
implements IDistributedTransactionStorage, IDistributedSchedulerStorage
{
@@ -100,6 +118,7 @@ export class RedisDistributedTransactionStorage
await this.worker?.close()
await this.jobWorker?.close()
// Clean up repeatable jobs
const repeatableJobs = (await this.cleanerQueue_?.getRepeatableJobs()) ?? []
for (const job of repeatableJobs) {
if (job.id === REPEATABLE_CLEARER_JOB_ID) {
@@ -780,38 +799,48 @@ export class RedisDistributedTransactionStorage
)
}
// Predefined states for quick lookup
const invokingStates = [
TransactionStepState.INVOKING,
TransactionStepState.NOT_STARTED,
]
let currentFlowLastInvokingStepIndex = -1
for (let i = 0; i < currentFlowSteps.length; i++) {
if (isInvokingState(currentFlowSteps[i])) {
currentFlowLastInvokingStepIndex = i
break
}
}
const compensatingStates = [
TransactionStepState.COMPENSATING,
TransactionStepState.NOT_STARTED,
]
const isInvokingState = (step: TransactionStep) =>
invokingStates.includes(step.invoke?.state)
const isCompensatingState = (step: TransactionStep) =>
compensatingStates.includes(step.compensate?.state)
const currentFlowLastInvokingStepIndex =
currentFlowSteps.findIndex(isInvokingState)
const latestUpdatedFlowLastInvokingStepIndex = !latestUpdatedFlow.steps
let latestUpdatedFlowLastInvokingStepIndex = !latestUpdatedFlow.steps
? 1 // There is no other execution, so the current execution is the latest
: latestUpdatedFlowSteps.findIndex(isInvokingState)
: -1
const reversedCurrentFlowSteps = [...currentFlowSteps].reverse()
const currentFlowLastCompensatingStepIndex =
reversedCurrentFlowSteps.findIndex(isCompensatingState)
if (latestUpdatedFlow.steps) {
for (let i = 0; i < latestUpdatedFlowSteps.length; i++) {
if (isInvokingState(latestUpdatedFlowSteps[i])) {
latestUpdatedFlowLastInvokingStepIndex = i
break
}
}
}
const reversedLatestUpdatedFlowSteps = [...latestUpdatedFlowSteps].reverse()
const latestUpdatedFlowLastCompensatingStepIndex = !latestUpdatedFlow.steps
? -1
: reversedLatestUpdatedFlowSteps.findIndex(isCompensatingState)
let currentFlowLastCompensatingStepIndex = -1
for (let i = currentFlowSteps.length - 1; i >= 0; i--) {
if (isCompensatingState(currentFlowSteps[i])) {
currentFlowLastCompensatingStepIndex = currentFlowSteps.length - 1 - i
break
}
}
let latestUpdatedFlowLastCompensatingStepIndex = !latestUpdatedFlow.steps
? -1 // There is no other execution, so the current execution is the latest
: -1
if (latestUpdatedFlow.steps) {
for (let i = latestUpdatedFlowSteps.length - 1; i >= 0; i--) {
if (isCompensatingState(latestUpdatedFlowSteps[i])) {
latestUpdatedFlowLastCompensatingStepIndex =
latestUpdatedFlowSteps.length - 1 - i
break
}
}
}
const isLatestExecutionFinishedIndex = -1
const invokeShouldBeSkipped =