DX-2134: export error stack trace in error response (#132)

* feat: export error stack trace in error response

* fix: add failStack to failure function

Author: CahidArda

src/error.ts

@@ -67,6 +67,7 @@ export const formatWorkflowError = (error: unknown): FailureFunctionPayload => {
     ? {
         error: error.name,
         message: error.message,
+        stack: error.stack,
       }
     : {
         error: "Error",

src/serve/serve.test.ts

@@ -322,6 +322,7 @@ describe("serve", () => {
         expect(result).toEqual({
           error: "Error",
           message: "some-error",
+          stack: expect.any(String),
         });
         called = true;
       },
@@ -903,6 +904,7 @@ describe("serve", () => {
         expect(body).toEqual({
           error: "WorkflowNonRetryableError",
           message: "This is a non-retryable error",
+          stack: expect.any(String),
         });
       },
       responseFields: { body: undefined, status: 489 },
@@ -1227,6 +1229,7 @@ describe("serve", () => {
       expect(content).toEqual({
         error: "WorkflowError",
         message: `Workflow URL should start with 'http://' or 'https://'. Recevied is '${url}'`,
+        stack: expect.any(String),
       });
 
       expect(logSpy).toBeCalledWith("WARN", "ENDPOINT_START", {

src/types.ts

@@ -230,6 +230,7 @@ export type WorkflowServeOptions<
     failStatus: number;
     failResponse: string;
     failHeaders: Record<string, string[]>;
+    failStack: string;
   }) => Promise<void | string> | void | string;
   /**
    * Base Url of the workflow endpoint
@@ -360,6 +361,10 @@ export type FailureFunctionPayload = {
    * error message
    */
   message: string;
+  /**
+   * error stack trace if available
+   */
+  stack?: string;
 };
 
 /**

src/workflow-parser.ts

@@ -343,11 +343,15 @@ export const handleFailure = async <TInitialPayload>(
 
     const decodedBody = body ? decodeBase64(body) : "{}";
     let errorMessage: string = "";
+    let failStack: string = "";
     try {
       const errorPayload = JSON.parse(decodedBody) as FailureFunctionPayload;
       if (errorPayload.message) {
         errorMessage = errorPayload.message;
       }
+      if (errorPayload.stack) {
+        failStack = errorPayload.stack;
+      }
     } catch {
       // skip
     }
@@ -398,6 +402,7 @@ export const handleFailure = async <TInitialPayload>(
       failStatus: status,
       failResponse: errorMessage,
       failHeaders: header,
+      failStack,
     });
     return ok({ result: "is-failure-callback", response: failureResponse });
   } catch (error) {