chore(workflow-engine): export cancel method (#11844)

What:
  * Workflow engine exports the method `cancel` to revert a workflow.
This commit is contained in:
Carlos R. L. Rodrigues
2025-03-17 09:59:09 -03:00
committed by GitHub
parent 3db146c56e
commit 0625f76cd4
14 changed files with 309 additions and 92 deletions

View File

@@ -1,7 +1,8 @@
export * from "./workflow_1"
export * from "./workflow_2"
export * from "./workflow_async"
export * from "./workflow_async_compensate"
export * from "./workflow_step_timeout"
export * from "./workflow_sync"
export * from "./workflow_transaction_timeout"
export * from "./workflow_when"
export * from "./workflow_async_compensate"

View File

@@ -0,0 +1,64 @@
import {
createStep,
createWorkflow,
StepResponse,
WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"
const step_1 = createStep(
"step_1",
jest.fn((input) => {
input.test = "test"
return new StepResponse(input, { compensate: 123 })
}),
jest.fn((compensateInput) => {
if (!compensateInput) {
return
}
return new StepResponse({
reverted: true,
})
})
)
const step_2 = createStep(
"step_2",
jest.fn((input, context) => {
if (input) {
return new StepResponse({ notAsyncResponse: input.hey })
}
}),
jest.fn((_, context) => {
return new StepResponse({
step: context.metadata.action,
idempotency_key: context.metadata.idempotency_key,
reverted: true,
})
})
)
const step_3 = createStep(
"step_3",
jest.fn((res) => {
return new StepResponse({
done: {
inputFromSyncStep: res.notAsyncResponse,
},
})
})
)
createWorkflow(
{
name: "workflow_sync",
idempotent: true,
},
function (input) {
step_1(input)
const ret2 = step_2({ hey: "oh" })
return new WorkflowResponse(step_3(ret2))
}
)

View File

@@ -512,6 +512,26 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
failTrap(done)
})
it("should cancel and revert a completed workflow", async () => {
const workflowId = "workflow_sync"
const { acknowledgement, transaction: trx } =
await workflowOrcModule.run(workflowId, {
input: {
value: "123",
},
})
expect(trx.getFlow().state).toEqual("done")
expect(acknowledgement.hasFinished).toBe(true)
const { transaction } = await workflowOrcModule.cancel(workflowId, {
transactionId: acknowledgement.transactionId,
})
expect(transaction.getFlow().state).toEqual("reverted")
})
})
// Note: These tests depend on actual Redis instance and waiting for the scheduled jobs to run, which isn't great.