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

@@ -6,7 +6,11 @@ import {
TransactionStep,
WorkflowScheduler,
} from "@medusajs/framework/orchestration"
import { ContainerLike, MedusaContainer } from "@medusajs/framework/types"
import {
ContainerLike,
Context,
MedusaContainer,
} from "@medusajs/framework/types"
import {
isString,
MedusaError,
@@ -18,9 +22,9 @@ import {
resolveValue,
ReturnWorkflow,
} from "@medusajs/framework/workflows-sdk"
import { WorkflowOrchestratorCancelOptions } from "@types"
import { ulid } from "ulid"
import { InMemoryDistributedTransactionStorage } from "../utils"
import { WorkflowOrchestratorCancelOptions } from "@types"
export type WorkflowOrchestratorRunOptions<T> = Omit<
FlowRunOptions<T>,
@@ -319,10 +323,8 @@ export class WorkflowOrchestratorService {
async getRunningTransaction(
workflowId: string,
transactionId: string,
options?: WorkflowOrchestratorRunOptions<unknown>
context?: Context
): Promise<DistributedTransactionType> {
let { context, container } = options ?? {}
if (!workflowId) {
throw new Error("Workflow ID is required")
}
@@ -339,9 +341,7 @@ export class WorkflowOrchestratorService {
throw new Error(`Workflow with id "${workflowId}" not found.`)
}
const flow = exportedWorkflow(
(container as MedusaContainer) ?? this.container_
)
const flow = exportedWorkflow()
const transaction = await flow.getRunningTransaction(transactionId, context)

View File

@@ -18,6 +18,7 @@ import type {
import { SqlEntityManager } from "@mikro-orm/postgresql"
import { WorkflowExecution } from "@models"
import { WorkflowOrchestratorService } from "@services"
import { WorkflowOrchestratorCancelOptions } from "@types"
type InjectedDependencies = {
manager: SqlEntityManager
@@ -185,4 +186,16 @@ export class WorkflowsModuleService<
updated_at <= (CURRENT_TIMESTAMP - INTERVAL '1 second' * retention_time);
`)
}
@InjectSharedContext()
async cancel<TWorkflow extends string | ReturnWorkflow<any, any, any>>(
workflowIdOrWorkflow: TWorkflow,
options: WorkflowOrchestratorCancelOptions,
@MedusaContext() context: Context = {}
) {
return this.workflowOrchestratorService_.cancel(
workflowIdOrWorkflow,
options
)
}
}

View File

@@ -8,7 +8,8 @@ export type InitializeModuleInjectableDependencies = {
export type WorkflowOrchestratorCancelOptions = Omit<
FlowCancelOptions,
"transaction" | "container"
"transaction" | "transactionId" | "container"
> & {
transactionId: string
container?: ContainerLike
}