fix: rm useFailureFunction option and allow failure callback without failure function in serve

Author: CahidArda

src/client/index.test.ts

@@ -108,7 +108,6 @@ describe("workflow client", () => {
       async () => {
         const { workflowRunId } = await liveClient.trigger({
           url: "http://requestcatcher.com",
-          useFailureFunction: true,
         });
 
         const cancel = await liveClient.cancel({
@@ -244,6 +243,18 @@ describe("workflow client", () => {
               "upstash-telemetry-runtime": expect.stringMatching(/bun@/),
               "upstash-telemetry-sdk": expect.stringContaining("@upstash/workflow"),
               "upstash-workflow-sdk-version": "1",
+              "upstash-failure-callback-forward-upstash-label": "test-label",
+              "upstash-failure-callback": "https://requestcatcher.com/api",
+              "upstash-failure-callback-feature-set": "LazyFetch,InitialBody,WF_DetectTrigger",
+              "upstash-failure-callback-forward-upstash-workflow-failure-callback": "true",
+              "upstash-failure-callback-forward-upstash-workflow-is-failure": "true",
+              "upstash-failure-callback-forward-user-header": "user-header-value",
+              "upstash-failure-callback-retries": "15",
+              "upstash-failure-callback-retry-delay": "1000",
+              "upstash-failure-callback-workflow-calltype": "failureCall",
+              "upstash-failure-callback-workflow-init": "false",
+              "upstash-failure-callback-workflow-runid": `wfr_${myWorkflowRunId}`,
+              "upstash-failure-callback-workflow-url": "https://requestcatcher.com/api",
             },
             body,
           },
@@ -277,7 +288,6 @@ describe("workflow client", () => {
             retries: 15,
             retryDelay: "2000",
             notBefore: new Date("2100-01-01T00:00:00Z").getTime() / 1000,
-            useFailureFunction: true,
           },
         ]);
         expect(result).toEqual([
@@ -312,6 +322,17 @@ describe("workflow client", () => {
               "upstash-telemetry-runtime": expect.stringMatching(/bun@/),
               "upstash-telemetry-sdk": expect.stringContaining("@upstash/workflow"),
               "upstash-workflow-sdk-version": "1",
+              "upstash-failure-callback": "https://requestcatcher.com/api",
+              "upstash-failure-callback-feature-set": "LazyFetch,InitialBody,WF_DetectTrigger",
+              "upstash-failure-callback-forward-upstash-workflow-failure-callback": "true",
+              "upstash-failure-callback-forward-upstash-workflow-is-failure": "true",
+              "upstash-failure-callback-forward-user-header": "user-header-value",
+              "upstash-failure-callback-retries": "15",
+              "upstash-failure-callback-retry-delay": "1000",
+              "upstash-failure-callback-workflow-calltype": "failureCall",
+              "upstash-failure-callback-workflow-init": "false",
+              "upstash-failure-callback-workflow-runid": `wfr_${myWorkflowRunId}`,
+              "upstash-failure-callback-workflow-url": "https://requestcatcher.com/api",
             },
             body,
           },

src/client/index.ts

@@ -240,7 +240,7 @@ export class Client {
     const options = isBatchInput ? params : [params];
 
     const invocations = options.map((option) => {
-      const failureUrl = option.useFailureFunction ? option.url : option.failureUrl;
+      const failureUrl = option.failureUrl ?? option.url;
       const finalWorkflowRunId = getWorkflowRunId(option.workflowRunId);
 
       const context = new WorkflowContext({

src/client/types.ts

@@ -427,34 +427,11 @@ export type TriggerOptions = {
    * @default false
    */
   disableTelemetry?: boolean;
-} & (
-  | {
-      /**
-       * URL to call if the first request to the workflow endpoint fails
-       */
-      failureUrl?: never;
-      /**
-       * Whether the workflow endpoint has a failure function
-       * defined to be invoked if the first request fails.
-       *
-       * If true, the failureUrl will be ignored.
-       */
-      useFailureFunction?: true;
-    }
-  | {
-      /**
-       * URL to call if the first request to the workflow endpoint fails
-       */
-      failureUrl?: string;
-      /**
-       * Whether the workflow endpoint has a failure function
-       * defined to be invoked if the first request fails.
-       *
-       * If true, the failureUrl will be ignored.
-       */
-      useFailureFunction?: never;
-    }
-);
+  /**
+   * URL to call if the first request to the workflow endpoint fails
+   */
+  failureUrl?: string;
+};
 
 export type DLQResumeRestartOptions<TDLQId extends string | string[] = string | string[]> = {
   dlqId: TDLQId;

src/serve/index.ts

@@ -148,13 +148,17 @@ export const serveBase = <
     if (failureCheck.isErr()) {
       // unexpected error during handleFailure
       throw failureCheck.error;
-    } else if (failureCheck.value.result === "is-failure-callback") {
+    } else if (failureCheck.value.result === "failure-function-executed") {
       // is a failure ballback.
       await debug?.log("WARN", "RESPONSE_DEFAULT", "failureFunction executed");
-      return onStepFinish(workflowRunId, "failure-callback", {
-        condition: "failure-callback",
+      return onStepFinish(workflowRunId, "failure-callback-executed", {
+        condition: "failure-callback-executed",
         result: failureCheck.value.response,
       });
+    } else if (failureCheck.value.result === "failure-function-undefined") {
+      return onStepFinish(workflowRunId, "failure-callback-undefined", {
+        condition: "failure-callback-undefined",
+      });
     }
 
     const invokeCount = Number(request.headers.get(WORKFLOW_INVOKE_COUNT_HEADER) ?? "0");

src/serve/options.ts

@@ -81,7 +81,7 @@ export const processOptions = <TResponse extends Response = Response, TInitialPa
           },
           status: 429,
         }) as TResponse;
-      } else if (detailedFinishCondition?.condition === "failure-callback") {
+      } else if (detailedFinishCondition?.condition === "failure-callback-executed") {
         return new Response(
           JSON.stringify({ result: detailedFinishCondition.result ?? undefined }),
           {

src/types.ts

@@ -132,13 +132,14 @@ export type FinishCondition =
   | "duplicate-step"
   | "fromCallback"
   | "auth-fail"
-  | "failure-callback"
+  | "failure-callback-executed"
+  | "failure-callback-undefined"
   | "workflow-already-ended"
   | WorkflowNonRetryableError;
 
 export type DetailedFinishCondition =
   | {
-      condition: Exclude<FinishCondition, WorkflowNonRetryableError | "failure-callback">;
+      condition: Exclude<FinishCondition, WorkflowNonRetryableError | "failure-callback-executed">;
       result?: never;
     }
   | {
@@ -150,7 +151,7 @@ export type DetailedFinishCondition =
       result: WorkflowRetryAfterError;
     }
   | {
-      condition: "failure-callback";
+      condition: "failure-callback-executed";
       result: string | void;
     };
 

src/workflow-parser.test.ts

@@ -874,7 +874,7 @@ describe("Workflow Parser", () => {
       expect(calledFailureFunction).toBeTrue();
     });
 
-    test("should throw WorkflowError if header is set but function is not passed", async () => {
+    test("should not throw if failure callback but there is no failure function", async () => {
       let called = false;
       const routeFunction = async (context: WorkflowContext) => {
         called = true;
@@ -893,14 +893,9 @@ describe("Workflow Parser", () => {
         undefined,
         undefined
       );
-      expect(result.isErr()).toBeTrue();
-      expect(result.isErr() && result.error.name).toBe(WorkflowError.name);
-      expect(result.isErr() && result.error.message).toBe(
-        "Workflow endpoint is called to handle a failure," +
-          " but a failureFunction is not provided in serve options." +
-          " Either provide a failureUrl or a failureFunction."
-      );
-      expect(called).toBeFalse(); // not called since we threw before auth check
+      expect(result.isOk()).toBeTrue();
+      expect(result.isOk() && result.value.result === "failure-function-undefined").toBeTrue();
+      expect(called).toBeFalse(); // not called since we returned before auth check
     });
 
     test("should return error when the failure function throws an error", async () => {
@@ -965,7 +960,7 @@ describe("Workflow Parser", () => {
 
       expect(result.isOk()).toBeTrue();
       expect(result.isOk() && result.value).toEqual({
-        result: "is-failure-callback",
+        result: "failure-function-executed",
         response: failureFunctionResponse,
       });
       expect(called).toBeTrue();

src/workflow-parser.ts

@@ -140,12 +140,10 @@ const checkIfLastOneIsDuplicate = async (
   debug?: WorkflowLogger
 ): Promise<boolean> => {
   // return false if the length is 0 or 1
-  // eslint-disable-next-line @typescript-eslint/no-magic-numbers
   if (steps.length < 2) {
     return false;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   const lastStep = steps.at(-1)!;
   const lastStepId = lastStep.stepId;
   const lastTargetStepId = lastStep.targetStep;
@@ -309,8 +307,9 @@ export const handleFailure = async <TInitialPayload>(
   debug?: WorkflowLogger
 ): Promise<
   | Ok<
-      | { result: "is-failure-callback"; response: string | void }
-      | { result: "not-failure-callback" },
+      | { result: "not-failure-callback" }
+      | { result: "failure-function-executed"; response: string | void }
+      | { result: "failure-function-undefined" },
       never
     >
   | Err<never, Error>
@@ -320,13 +319,7 @@ export const handleFailure = async <TInitialPayload>(
   }
 
   if (!failureFunction) {
-    return err(
-      new WorkflowError(
-        "Workflow endpoint is called to handle a failure," +
-          " but a failureFunction is not provided in serve options." +
-          " Either provide a failureUrl or a failureFunction."
-      )
-    );
+    return ok({ result: "failure-function-undefined" });
   }
 
   try {
@@ -390,7 +383,7 @@ export const handleFailure = async <TInitialPayload>(
     if (authCheck.isErr()) {
       // got error while running until first step
       await debug?.log("ERROR", "ERROR", { error: authCheck.error.message });
-      throw authCheck.error;
+      return err(authCheck.error);
     } else if (authCheck.value === "run-ended") {
       // finished routeFunction while trying to run until first step.
       // either there is no step or auth check resulted in `return`
@@ -404,7 +397,7 @@ export const handleFailure = async <TInitialPayload>(
       failHeaders: header,
       failStack,
     });
-    return ok({ result: "is-failure-callback", response: failureResponse });
+    return ok({ result: "failure-function-executed", response: failureResponse });
   } catch (error) {
     return err(error as Error);
   }