feat(workflows-sdk): add response to permanent failure (#10177)

packages/core/orchestration/src/transaction/errors.ts

@@ -1,4 +1,18 @@
-export class PermanentStepFailureError extends Error {
+class BaseStepErrror extends Error {
+  #stepResponse: unknown
+
+  constructor(name, message?: string, stepResponse?: unknown) {
+    super(message)
+    this.name = name
+    this.#stepResponse = stepResponse
+  }
+
+  getStepResponse(): unknown {
+    return this.#stepResponse
+  }
+}
+
+export class PermanentStepFailureError extends BaseStepErrror {
   static isPermanentStepFailureError(
     error: Error
   ): error is PermanentStepFailureError {
@@ -8,26 +22,24 @@ export class PermanentStepFailureError extends Error {
     )
   }
 
-  constructor(message?: string) {
-    super(message)
-    this.name = "PermanentStepFailure"
+  constructor(message?: string, stepResponse?: unknown) {
+    super("PermanentStepFailure", message, stepResponse)
   }
 }
 
-export class SkipStepResponse extends Error {
+export class SkipStepResponse extends BaseStepErrror {
   static isSkipStepResponse(error: Error): error is SkipStepResponse {
     return (
       error instanceof SkipStepResponse || error?.name === "SkipStepResponse"
     )
   }
 
-  constructor(message?: string) {
-    super(message)
-    this.name = "SkipStepResponse"
+  constructor(message?: string, stepResponse?: unknown) {
+    super("SkipStepResponse", message, stepResponse)
   }
 }
 
-export class TransactionStepTimeoutError extends Error {
+export class TransactionStepTimeoutError extends BaseStepErrror {
   static isTransactionStepTimeoutError(
     error: Error
   ): error is TransactionStepTimeoutError {
@@ -37,13 +49,12 @@ export class TransactionStepTimeoutError extends Error {
     )
   }
 
-  constructor(message?: string) {
-    super(message)
-    this.name = "TransactionStepTimeoutError"
+  constructor(message?: string, stepResponse?: unknown) {
+    super("TransactionStepTimeoutError", message, stepResponse)
   }
 }
 
-export class TransactionTimeoutError extends Error {
+export class TransactionTimeoutError extends BaseStepErrror {
   static isTransactionTimeoutError(
     error: Error
   ): error is TransactionTimeoutError {
@@ -53,8 +64,7 @@ export class TransactionTimeoutError extends Error {
     )
   }
 
-  constructor(message?: string) {
-    super(message)
-    this.name = "TransactionTimeoutError"
+  constructor(message?: string, stepResponse?: unknown) {
+    super("TransactionTimeoutError", message, stepResponse)
   }
 }

packages/core/orchestration/src/transaction/transaction-orchestrator.ts

@@ -18,6 +18,7 @@ import {
 } from "./types"
 
 import {
+  isDefined,
   isErrorLike,
   MedusaError,
   promiseAll,
@@ -764,8 +765,24 @@ export class TransactionOrchestrator extends EventEmitter {
 
         const setStepFailure = async (
           error: Error | any,
-          { endRetry }: { endRetry?: boolean } = {}
+          {
+            endRetry,
+            response,
+          }: {
+            endRetry?: boolean
+            response?: unknown
+          } = {}
         ) => {
+          if (isDefined(response) && step.saveResponse) {
+            transaction.addResponse(
+              step.definition.action!,
+              step.isCompensating()
+                ? TransactionHandlerType.COMPENSATE
+                : TransactionHandlerType.INVOKE,
+              response
+            )
+          }
+
           await TransactionOrchestrator.setStepFailure(
             transaction,
             step,
@@ -841,6 +858,8 @@ export class TransactionOrchestrator extends EventEmitter {
                 )
               })
               .catch(async (error) => {
+                const response = error?.getStepResponse?.()
+
                 if (this.hasExpired({ transaction, step }, Date.now())) {
                   await this.checkStepTimeout(transaction, step)
                   await this.checkTransactionTimeout(
@@ -852,11 +871,14 @@ export class TransactionOrchestrator extends EventEmitter {
                 if (
                   PermanentStepFailureError.isPermanentStepFailureError(error)
                 ) {
-                  await setStepFailure(error, { endRetry: true })
+                  await setStepFailure(error, {
+                    endRetry: true,
+                    response,
+                  })
                   return
                 }
 
-                await setStepFailure(error)
+                await setStepFailure(error, { response })
               })
           )
         } else {
@@ -917,14 +939,19 @@ export class TransactionOrchestrator extends EventEmitter {
                   )
                 })
                 .catch(async (error) => {
+                  const response = error?.getStepResponse?.()
+
                   if (
                     PermanentStepFailureError.isPermanentStepFailureError(error)
                   ) {
-                    await setStepFailure(error, { endRetry: true })
+                    await setStepFailure(error, {
+                      endRetry: true,
+                      response,
+                    })
                     return
                   }
 
-                  await setStepFailure(error)
+                  await setStepFailure(error, { response })
                 })
             })
           )