fix(orchestrato): copy data before saving

medusajs · Nov 11, 2024 · 9e195ce · 9e195ce
1 parent 1a0882c
commit 9e195ce
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 185 deletions.
diff --git a/packages/core/orchestration/src/transaction/distributed-transaction.ts b/packages/core/orchestration/src/transaction/distributed-transaction.ts
@@ -215,9 +215,10 @@ class DistributedTransaction extends EventEmitter {
       this.modelId,
       this.transactionId
     )
-    await DistributedTransaction.keyValueStore.save(key, data, ttl, options)
+    const rawData = JSON.parse(JSON.stringify(data))
+    await DistributedTransaction.keyValueStore.save(key, rawData, ttl, options)
 
-    return data
+    return rawData
   }
 
   public static async loadTransaction(

diff --git a/packages/core/workflows-sdk/src/helper/__tests__/workflow-export.spec.ts b/packages/core/workflows-sdk/src/helper/__tests__/workflow-export.spec.ts
diff --git a/packages/core/workflows-sdk/src/helper/workflow-export.ts b/packages/core/workflows-sdk/src/helper/workflow-export.ts
@@ -3,7 +3,6 @@ import {
   DistributedTransactionEvents,
   DistributedTransactionType,
   LocalWorkflow,
-  TransactionHandlerType,
   TransactionState,
 } from "@medusajs/orchestration"
 import {
@@ -18,6 +17,7 @@ import {
   isPresent,
   MedusaContextType,
   Modules,
+  TransactionHandlerType,
 } from "@medusajs/utils"
 import { EOL } from "os"
 import { ulid } from "ulid"
@@ -41,13 +41,11 @@ function createContextualWorkflowRunner<
 >({
   workflowId,
   defaultResult,
-  dataPreparation,
   options,
   container,
 }: {
   workflowId: string
   defaultResult?: string | Symbol
-  dataPreparation?: (data: TData) => Promise<unknown>
   options?: {
     wrappedInput?: boolean
     sourcePath?: string
@@ -110,22 +108,27 @@ function createContextualWorkflowRunner<
       events,
       flowMetadata,
     ]
-    const transaction = await method.apply(method, args) as DistributedTransactionType
+    const transaction = (await method.apply(
+      method,
+      args
+    )) as DistributedTransactionType
 
     let errors = transaction.getErrors(TransactionHandlerType.INVOKE)
 
     const failedStatus = [TransactionState.FAILED, TransactionState.REVERTED]
     const isCancelled =
       isCancel && transaction.getState() === TransactionState.REVERTED
 
+    const isRegisterStepFailure =
+      method === originalRegisterStepFailure &&
+      transaction.getState() === TransactionState.REVERTED
+
     if (
-      !isCancelled &&
+      throwOnError &&
       failedStatus.includes(transaction.getState()) &&
-      throwOnError
+      !isCancelled &&
+      !isRegisterStepFailure
     ) {
-      /*const errorMessage = errors
-        ?.map((err) => `${err.error?.message}${EOL}${err.error?.stack}`)
-        ?.join(`${EOL}`)*/
       const firstError = errors?.[0]?.error ?? new Error("Unknown error")
       throw firstError
     }
@@ -175,22 +178,6 @@ function createContextualWorkflowRunner<
     context.transactionId ??= ulid()
     context.eventGroupId ??= ulid()
 
-    if (typeof dataPreparation === "function") {
-      try {
-        const copyInput = input ? JSON.parse(JSON.stringify(input)) : input
-        input = await dataPreparation(copyInput as TData)
-      } catch (err) {
-        if (throwOnError) {
-          throw new Error(
-            `Data preparation failed: ${err.message}${EOL}${err.stack}`
-          )
-        }
-        return {
-          errors: [err],
-        }
-      }
-    }
-
     return await originalExecution(
       originalRun,
       {
@@ -339,7 +326,6 @@ function createContextualWorkflowRunner<
 export const exportWorkflow = <TData = unknown, TResult = unknown>(
   workflowId: string,
   defaultResult?: string | Symbol,
-  dataPreparation?: (data: TData) => Promise<unknown>,
   options?: {
     wrappedInput?: boolean
     sourcePath?: string
@@ -364,7 +350,6 @@ export const exportWorkflow = <TData = unknown, TResult = unknown>(
     >({
       workflowId,
       defaultResult,
-      dataPreparation,
       options,
       container,
     })
@@ -390,7 +375,6 @@ export const exportWorkflow = <TData = unknown, TResult = unknown>(
     >({
       workflowId,
       defaultResult,
-      dataPreparation,
       options,
       container,
     })

diff --git a/packages/core/workflows-sdk/src/utils/composer/create-workflow.ts b/packages/core/workflows-sdk/src/utils/composer/create-workflow.ts
@@ -152,15 +152,10 @@ export function createWorkflow<TData, TResult, THooks extends any[]>(
     WorkflowManager.register(name, context.flow, handlers, options)
   }
 
-  const workflow = exportWorkflow<TData, TResult>(
-    name,
-    returnedStep,
-    undefined,
-    {
-      wrappedInput: true,
-      sourcePath: fileSourcePath,
-    }
-  )
+  const workflow = exportWorkflow<TData, TResult>(name, returnedStep, {
+    wrappedInput: true,
+    sourcePath: fileSourcePath,
+  })
 
   const mainFlow = <TDataOverride = undefined, TResultOverride = undefined>(
     container?: LoadedModule[] | MedusaContainer

diff --git a/packages/modules/workflow-engine-redis/integration-tests/__fixtures__/workflow_2.ts b/packages/modules/workflow-engine-redis/integration-tests/__fixtures__/workflow_2.ts
@@ -2,6 +2,7 @@ import {
   createStep,
   createWorkflow,
   StepResponse,
+  WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
 
 const step_1 = createStep(
@@ -49,6 +50,14 @@ const step_3 = createStep(
   })
 )
 
+const broken_step_2 = createStep(
+  "broken_step_2",
+  jest.fn(() => {}),
+  jest.fn((_, context) => {
+    throw new Error("Broken compensation step")
+  })
+)
+
 createWorkflow(
   {
     name: "workflow_2",
@@ -67,3 +76,19 @@ createWorkflow(
     return step_3(ret2)
   }
 )
+
+createWorkflow(
+  {
+    name: "workflow_2_revert_fail",
+    retentionTime: 1000,
+  },
+  function (input) {
+    step_1(input)
+
+    broken_step_2().config({
+      async: true,
+    })
+
+    return new WorkflowResponse("done")
+  }
+)