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

fix(): Properly handle workflow as step now that events are fixed entirely (#12196)

Browse Source 
**What**
Now that all events management are fixed in the workflows life cycle, the run as step needs to leverage the workflow engine if present (which should always be the case for async workflows) in order to ensure the continuation and the ability to mark parent step in parent workflow as success or failure

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
This commit is contained in:
Adrien de Peretti
2025-04-17 11:34:19 +02:00
committed by GitHub
parent 9abcf7a83a
commit 8618e6ee38
16 changed files with 410 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
packages/modules/workflow-engine-inmemory/integration-tests/__tests__/index.spec.ts
View File

@@ -12,6 +12,12 @@ import {
Modules,
TransactionHandlerType,
} from "@medusajs/framework/utils"
import {
createStep,
createWorkflow,
StepResponse,
WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"
import { moduleIntegrationTestRunner } from "@medusajs/test-utils"
import { WorkflowsModuleService } from "@services"
import { asFunction } from "awilix"
@@ -31,7 +37,7 @@ import {
} from "../__fixtures__/workflow_event_group_id"
import { createScheduled } from "../__fixtures__/workflow_scheduled"
jest.setTimeout(300000)
jest.setTimeout(60000)
const failTrap = (done) => {
setTimeoutSync(() => {
@@ -157,6 +163,83 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
)
})
it("should compose nested workflows w/ async steps", (done) => {
const asyncResults: any[] = []
const mockStep1Fn = jest.fn().mockImplementation(() => {
const res = { obj: "return from 1" }
asyncResults.push(res)
return new StepResponse(res)
})
const mockStep2Fn = jest.fn().mockImplementation(async () => {
await setTimeoutPromise(100)
const res = { obj: "return from 2" }
asyncResults.push(res)
return new StepResponse(res)
})
const mockStep3Fn = jest.fn().mockImplementation(() => {
const res = { obj: "return from 3" }
asyncResults.push(res)
return new StepResponse(res)
})
const step1 = createStep("step1", mockStep1Fn)
const step2 = createStep(
{
name: "step2",
async: true,
backgroundExecution: true,
},
mockStep2Fn
)
const step3 = createStep("step3", mockStep3Fn)
const wf3 = createWorkflow("workflow3", function (input) {
return new WorkflowResponse(step2(input))
})
const wf2 = createWorkflow("workflow2", function (input) {
const ret3 = wf3.runAsStep({
input: {},
})
return new WorkflowResponse(ret3)
})
const workflowId = "workflow1"
createWorkflow(workflowId, function (input) {
step1(input)
wf2.runAsStep({ input })
const fourth = step3({})
return new WorkflowResponse(fourth)
})
asyncResults.push("begin workflow")
workflowOrcModule
.run(workflowId, {
input: {},
})
.then(() => {
asyncResults.push("returned workflow")
void workflowOrcModule.subscribe({
workflowId,
subscriber: (event) => {
if (event.eventType === "onFinish") {
expect(asyncResults).toEqual([
"begin workflow",
{ obj: "return from 1" },
"returned workflow",
{ obj: "return from 2" },
{ obj: "return from 3" },
])
}
},
})
})
failTrap(done)
})
describe("Testing basic workflow", function () {
beforeEach(() => {
jest.clearAllMocks()
@@ -270,7 +353,7 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
expect(transaction.getFlow().state).toEqual("reverted")
})
it.skip("should subscribe to a async workflow and receive the response when it finishes", (done) => {
it("should subscribe to a async workflow and receive the response when it finishes", (done) => {
const transactionId = "trx_123"
const onFinish = jest.fn(() => {
@@ -296,6 +379,7 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
})
expect(onFinish).toHaveBeenCalledTimes(0)
failTrap(done)
})
it("should cancel and revert a completed workflow", async () => {

50
packages/modules/workflow-engine-inmemory/src/services/workflows-module.ts
View File

@@ -8,6 +8,7 @@ import {
} from "@medusajs/framework/types"
import {
InjectSharedContext,
isDefined,
MedusaContext,
ModulesSdkUtils,
} from "@medusajs/framework/utils"
@@ -90,13 +91,38 @@ export class WorkflowsModuleService<
transactionManager,
preventReleaseEvents,
transactionId,
parentStepIdempotencyKey,
...restContext
} = context
options_.context ??= restContext
options_.context.preventReleaseEvents ??=
!!options_.context.parentStepIdempotencyKey
delete options_.context.parentStepIdempotencyKey
let localPreventReleaseEvents = false
if (isDefined(options_.context?.preventReleaseEvents)) {
localPreventReleaseEvents = options_.context!.preventReleaseEvents!
} else {
if (
isDefined(context.eventGroupId) &&
isDefined(options_.context?.eventGroupId) &&
context.eventGroupId === options_.context?.eventGroupId
) {
localPreventReleaseEvents = true
}
}
let eventGroupId
if (options_.context?.eventGroupId) {
eventGroupId = options_.context.eventGroupId
} else if (localPreventReleaseEvents && context.eventGroupId) {
eventGroupId = context.eventGroupId
}
options_.context = {
...(restContext ?? {}),
...(options_.context ?? {}),
eventGroupId,
preventReleaseEvents: localPreventReleaseEvents,
}
const ret = await this.workflowOrchestratorService_.run<
TWorkflow extends ReturnWorkflow<any, any, any>
@@ -133,8 +159,11 @@ export class WorkflowsModuleService<
},
@MedusaContext() context: Context = {}
) {
options ??= {}
options.context ??= context
const options_ = JSON.parse(JSON.stringify(options ?? {}))
const { manager, transactionManager, ...restContext } = context
options_.context ??= restContext
return await this.workflowOrchestratorService_.setStepSuccess({
idempotencyKey,
@@ -156,8 +185,11 @@ export class WorkflowsModuleService<
},
@MedusaContext() context: Context = {}
) {
options ??= {}
options.context ??= context
const options_ = JSON.parse(JSON.stringify(options ?? {}))
const { manager, transactionManager, ...restContext } = context
options_.context ??= restContext
return await this.workflowOrchestratorService_.setStepFailure({
idempotencyKey,
@@ -205,7 +237,7 @@ export class WorkflowsModuleService<
options: WorkflowOrchestratorCancelOptions,
@MedusaContext() context: Context = {}
) {
return this.workflowOrchestratorService_.cancel(
return await this.workflowOrchestratorService_.cancel(
workflowIdOrWorkflow,
options
)

20
packages/modules/workflow-engine-inmemory/src/utils/workflow-orchestrator-storage.ts
View File

@@ -310,10 +310,16 @@ export class InMemoryDistributedTransactionStorage
const { modelId: workflowId, transactionId } = transaction
const inter = setTimeout(async () => {
const context = transaction.getFlow().metadata ?? {}
await this.workflowOrchestratorService_.run(workflowId, {
transactionId,
logOnError: true,
throwOnError: false,
context: {
eventGroupId: context.eventGroupId,
parentStepIdempotencyKey: context.parentStepIdempotencyKey,
preventReleaseEvents: context.preventReleaseEvents,
},
})
}, interval * 1e3)
@@ -343,9 +349,16 @@ export class InMemoryDistributedTransactionStorage
const { modelId: workflowId, transactionId } = transaction
const inter = setTimeout(async () => {
const context = transaction.getFlow().metadata ?? {}
await this.workflowOrchestratorService_.run(workflowId, {
transactionId,
logOnError: true,
throwOnError: false,
context: {
eventGroupId: context.eventGroupId,
parentStepIdempotencyKey: context.parentStepIdempotencyKey,
preventReleaseEvents: context.preventReleaseEvents,
},
})
}, interval * 1e3)
@@ -375,9 +388,16 @@ export class InMemoryDistributedTransactionStorage
const { modelId: workflowId, transactionId } = transaction
const inter = setTimeout(async () => {
const context = transaction.getFlow().metadata ?? {}
await this.workflowOrchestratorService_.run(workflowId, {
transactionId,
logOnError: true,
throwOnError: false,
context: {
eventGroupId: context.eventGroupId,
parentStepIdempotencyKey: context.parentStepIdempotencyKey,
preventReleaseEvents: context.preventReleaseEvents,
},
})
}, interval * 1e3)

2
packages/modules/workflow-engine-redis/integration-tests/__fixtures__/workflow_scheduled.ts
View File

@@ -13,7 +13,7 @@ export const createScheduled = (
const workflowScheduledStepInvoke = jest.fn((input, { container }) => {
try {
return new StepResponse({
testValue: "test-value",
testValue: container.resolve("test-value", { allowUnregistered: true }),
})
} finally {
next()

50
packages/modules/workflow-engine-redis/integration-tests/__tests__/index.spec.ts
View File

@@ -19,6 +19,12 @@ import {
TransactionHandlerType,
TransactionStepState,
} from "@medusajs/framework/utils"
import {
createStep,
createWorkflow,
StepResponse,
WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"
import { moduleIntegrationTestRunner } from "@medusajs/test-utils"
import { asValue } from "awilix"
import { setTimeout as setTimeoutSync } from "timers"
@@ -27,12 +33,6 @@ import { WorkflowsModuleService } from "../../src/services"
import "../__fixtures__"
import { createScheduled } from "../__fixtures__/workflow_scheduled"
import { TestDatabase } from "../utils"
import {
createStep,
createWorkflow,
StepResponse,
WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"
jest.setTimeout(300000)
@@ -66,7 +66,7 @@ function times(num) {
new Promise((_, reject) => {
setTimeoutSync(
() => reject("times has not been resolved after 10 seconds."),
1000
10000
)
}),
]),
@@ -736,27 +736,39 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
WorkflowManager["workflows"].delete("remove-scheduled")
await setTimeout(1100)
0
expect(spy).toHaveBeenCalledTimes(1)
expect(logSpy).toHaveBeenCalledWith(
"Tried to execute a scheduled workflow with ID remove-scheduled that does not exist, removing it from the scheduler."
)
})
it.skip("the scheduled workflow should have access to the shared container", async () => {
const wait = times(1)
sharedContainer_.register("test-value", asValue("test"))
const spy = await createScheduled("shared-container-job", wait.next, {
interval: 1000,
// TODO: investigate why sometimes flow doesn't have access to the new key registered
describe.skip("Scheduled workflows", () => {
beforeEach(() => {
sharedContainer_.register("test-value", asValue("test"))
})
await wait.promise
expect(spy).toHaveBeenCalledTimes(1)
it("the scheduled workflow should have access to the shared container", async () => {
const wait = times(1)
expect(spy).toHaveReturnedWith(
expect.objectContaining({ output: { testValue: "test" } })
)
WorkflowManager.unregister("shared-container-job")
const spy = await createScheduled(
"shared-container-job",
wait.next,
{
interval: 1000,
}
)
await wait.promise
expect(spy).toHaveBeenCalledTimes(1)
console.log(spy.mock.results)
expect(spy).toHaveReturnedWith(
expect.objectContaining({ output: { testValue: "test" } })
)
WorkflowManager.unregister("shared-container-job")
})
})
})
})

7
packages/modules/workflow-engine-redis/integration-tests/__tests__/race.spec.ts
View File

@@ -180,18 +180,19 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
subscriber: (event) => {
if (event.eventType === "onFinish") {
expect(step0InvokeMock).toHaveBeenCalledTimes(1)
expect(step0CompensateMock).toHaveBeenCalledTimes(1)
expect(step1InvokeMock.mock.calls.length).toBeGreaterThan(2)
expect(step0CompensateMock).toHaveBeenCalledTimes(2) // TODO: review this.
expect(step1InvokeMock).toHaveBeenCalledTimes(1)
expect(step1CompensateMock).toHaveBeenCalledTimes(1)
expect(step2InvokeMock).toHaveBeenCalledTimes(0)
expect(transformMock).toHaveBeenCalledTimes(0)
done()
}
},
})
workflowOrcModule
.run(workflowId, { transactionId })
.run(workflowId, { transactionId, throwOnError: false })
.then(({ result }) => {
expect(result).toBe("result from step 0")
})

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

@@ -8,6 +8,7 @@ import {
} from "@medusajs/framework/types"
import {
InjectSharedContext,
isDefined,
MedusaContext,
ModulesSdkUtils,
} from "@medusajs/framework/utils"
@@ -102,13 +103,38 @@ export class WorkflowsModuleService<
transactionManager,
preventReleaseEvents,
transactionId,
parentStepIdempotencyKey,
...restContext
} = context
options_.context ??= restContext
options_.context.preventReleaseEvents ??=
!!options_.context.parentStepIdempotencyKey
delete options_.context.parentStepIdempotencyKey
let localPreventReleaseEvents = false
if (isDefined(options_.context?.preventReleaseEvents)) {
localPreventReleaseEvents = options_.context!.preventReleaseEvents!
} else {
if (
isDefined(context.eventGroupId) &&
isDefined(options_.context?.eventGroupId) &&
context.eventGroupId === options_.context?.eventGroupId
) {
localPreventReleaseEvents = true
}
}
let eventGroupId
if (options_.context?.eventGroupId) {
eventGroupId = options_.context.eventGroupId
} else if (localPreventReleaseEvents && context.eventGroupId) {
eventGroupId = context.eventGroupId
}
options_.context = {
...(restContext ?? {}),
...(options_.context ?? {}),
eventGroupId,
preventReleaseEvents: localPreventReleaseEvents,
}
const ret = await this.workflowOrchestratorService_.run<
TWorkflow extends ReturnWorkflow<any, any, any>
@@ -145,13 +171,16 @@ export class WorkflowsModuleService<
},
@MedusaContext() context: Context = {}
) {
options ??= {}
options.context ??= context
const options_ = JSON.parse(JSON.stringify(options ?? {}))
const { manager, transactionManager, ...restContext } = context
options_.context ??= restContext
return await this.workflowOrchestratorService_.setStepSuccess({
idempotencyKey,
stepResponse,
options,
options: options_,
} as any)
}
@@ -168,13 +197,16 @@ export class WorkflowsModuleService<
},
@MedusaContext() context: Context = {}
) {
options ??= {}
options.context ??= context
const options_ = JSON.parse(JSON.stringify(options ?? {}))
const { manager, transactionManager, ...restContext } = context
options_.context ??= restContext
return await this.workflowOrchestratorService_.setStepFailure({
idempotencyKey,
stepResponse,
options,
options: options_,
} as any)
}
@@ -217,6 +249,6 @@ export class WorkflowsModuleService<
options: WorkflowOrchestratorCancelOptions,
@MedusaContext() context: Context = {}
) {
return this.workflowOrchestratorService_.cancel(workflowId, options)
return await this.workflowOrchestratorService_.cancel(workflowId, options)
}
}

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

@@ -118,7 +118,8 @@ export class RedisDistributedTransactionStorage
if (allowedJobs.includes(job.name as JobType)) {
await this.executeTransaction(
job.data.workflowId,
job.data.transactionId
job.data.transactionId,
job.data.transactionMetadata
)
}
@@ -180,11 +181,20 @@ export class RedisDistributedTransactionStorage
])
}
private async executeTransaction(workflowId: string, transactionId: string) {
private async executeTransaction(
workflowId: string,
transactionId: string,
transactionMetadata: TransactionFlow["metadata"] = {}
) {
return await this.workflowOrchestratorService_.run(workflowId, {
transactionId,
logOnError: true,
throwOnError: false,
context: {
eventGroupId: transactionMetadata.eventGroupId,
parentStepIdempotencyKey: transactionMetadata.parentStepIdempotencyKey,
preventReleaseEvents: transactionMetadata.preventReleaseEvents,
},
})
}
@@ -326,6 +336,7 @@ export class RedisDistributedTransactionStorage
{
workflowId: transaction.modelId,
transactionId: transaction.transactionId,
transactionMetadata: transaction.getFlow().metadata,
stepId: step.id,
},
{
@@ -353,6 +364,7 @@ export class RedisDistributedTransactionStorage
{
workflowId: transaction.modelId,
transactionId: transaction.transactionId,
transactionMetadata: transaction.getFlow().metadata,
},
{
delay: interval * 1000,
@@ -379,6 +391,7 @@ export class RedisDistributedTransactionStorage
{
workflowId: transaction.modelId,
transactionId: transaction.transactionId,
transactionMetadata: transaction.getFlow().metadata,
stepId: step.id,
},
{