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

@@ -35,8 +35,11 @@ export type WorkflowOrchestratorRunOptions<T> = Omit<
export type WorkflowOrchestratorCancelOptions = Omit<
FlowCancelOptions,
"transaction"
>
"transaction" | "transactionId" | "container"
> & {
transactionId: string
container?: ContainerLike
}
type RegisterStepSuccessOptions<T> = Omit<
WorkflowOrchestratorRunOptions<T>,
@@ -379,10 +382,8 @@ export class WorkflowOrchestratorService {
async getRunningTransaction(
workflowId: string,
transactionId: string,
options?: { context?: Context }
context?: Context
): Promise<DistributedTransactionType> {
let { context } = options ?? {}
if (!workflowId) {
throw new Error("Workflow ID is required")
}
@@ -398,10 +399,9 @@ export class WorkflowOrchestratorService {
throw new Error(`Workflow with id "${workflowId}" not found.`)
}
const transaction = await exportedWorkflow.getRunningTransaction(
transactionId,
context
)
const flow = exportedWorkflow()
const transaction = await flow.getRunningTransaction(transactionId, context)
return transaction
}

View File

@@ -17,7 +17,10 @@ import type {
} from "@medusajs/framework/workflows-sdk"
import { SqlEntityManager } from "@mikro-orm/postgresql"
import { WorkflowExecution } from "@models"
import { WorkflowOrchestratorService } from "@services"
import {
WorkflowOrchestratorCancelOptions,
WorkflowOrchestratorService,
} from "@services"
type InjectedDependencies = {
manager: SqlEntityManager
@@ -112,7 +115,7 @@ export class WorkflowsModuleService<
return await this.workflowOrchestratorService_.getRunningTransaction(
workflowId,
transactionId,
{ context }
context
)
}
@@ -194,4 +197,13 @@ export class WorkflowsModuleService<
updated_at <= (CURRENT_TIMESTAMP - INTERVAL '1 second' * retention_time);
`)
}
@InjectSharedContext()
async cancel(
workflowId: string,
options: WorkflowOrchestratorCancelOptions,
@MedusaContext() context: Context = {}
) {
return this.workflowOrchestratorService_.cancel(workflowId, options)
}
}