fix(workflows-sdk): name for when/then step (#10459)

packages/modules/workflow-engine-redis/integration-tests/__fixtures__/index.ts

@@ -3,3 +3,4 @@ export * from "./workflow_2"
 export * from "./workflow_async"
 export * from "./workflow_step_timeout"
 export * from "./workflow_transaction_timeout"
+export * from "./workflow_when"

packages/modules/workflow-engine-redis/integration-tests/__fixtures__/workflow_async.ts

@@ -5,7 +5,6 @@ import {
   StepResponse,
   WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
-import { setTimeout } from "timers/promises"
 
 const step_1_background = createStep(
   {
@@ -13,8 +12,6 @@ const step_1_background = createStep(
     async: true,
   },
   jest.fn(async (input) => {
-    await setTimeout(Math.random() * 300)
-
     return new StepResponse(input)
   })
 )

packages/modules/workflow-engine-redis/integration-tests/__fixtures__/workflow_when.ts

@@ -0,0 +1,52 @@
+import {
+  createStep,
+  createWorkflow,
+  StepResponse,
+  when,
+  WorkflowData,
+  WorkflowResponse,
+} from "@medusajs/framework/workflows-sdk"
+
+const step1 = createStep(
+  {
+    name: "step1",
+    async: true,
+  },
+  async (_, context) => {
+    await new Promise((resolve) => setTimeout(resolve, 2000))
+    return new StepResponse({ result: "step1" })
+  }
+)
+const step2 = createStep("step2", async (input: string, context) => {
+  return new StepResponse({ result: input })
+})
+const step3 = createStep(
+  "step3",
+  async (input: string | undefined, context) => {
+    return new StepResponse({ result: input ?? "default response" })
+  }
+)
+
+const subWorkflow = createWorkflow(
+  "wf-when-sub",
+  function (input: WorkflowData<string>) {
+    return new WorkflowResponse(step2(input))
+  }
+)
+
+createWorkflow("wf-when", function (input: { callSubFlow: boolean }) {
+  step1()
+  const subWorkflowRes = when("sub-flow", { input }, ({ input }) => {
+    return input.callSubFlow
+  }).then(() => {
+    const res = subWorkflow.runAsStep({
+      input: "hi from outside",
+    })
+
+    return {
+      result: res,
+    }
+  }) as any
+
+  return new WorkflowResponse(step3(subWorkflowRes.result))
+})

packages/modules/workflow-engine-redis/integration-tests/__tests__/index.spec.ts

@@ -18,6 +18,7 @@ import {
 import { moduleIntegrationTestRunner } from "@medusajs/test-utils"
 import { asValue } from "awilix"
 import { setTimeout } from "timers/promises"
+import { setTimeout as setTimeoutSync } from "timers"
 import { WorkflowsModuleService } from "../../src/services"
 import "../__fixtures__"
 import { createScheduled } from "../__fixtures__/workflow_scheduled"
@@ -25,6 +26,18 @@ import { TestDatabase } from "../utils"
 
 jest.setTimeout(999900000)
 
+const failTrap = (done) => {
+  setTimeoutSync(() => {
+    // REF:https://stackoverflow.com/questions/78028715/jest-async-test-with-event-emitter-isnt-ending
+    console.warn(
+      "Jest is breaking the event emit with its debouncer. This allows to continue the test by managing the timeout of the test manually."
+    )
+    done()
+  }, 5000)
+}
+
+// REF:https://stackoverflow.com/questions/78028715/jest-async-test-with-event-emitter-isnt-ending
+
 moduleIntegrationTestRunner<IWorkflowEngineService>({
   moduleName: Modules.WORKFLOW_ENGINE,
   resolve: __dirname + "/../..",
@@ -359,9 +372,9 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
           ).toBe(true)
         })
 
-        it.skip("should complete an async workflow that returns a StepResponse", (done) => {
+        it("should complete an async workflow that returns a StepResponse", (done) => {
           const transactionId = "transaction_1"
-          void workflowOrcModule
+          workflowOrcModule
             .run("workflow_async_background", {
               input: {
                 myInput: "123",
@@ -369,7 +382,7 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
               transactionId,
               throwOnError: true,
             })
-            .then(({ transaction, result }) => {
+            .then(({ transaction, result }: any) => {
               expect(transaction.flow.state).toEqual(
                 TransactionStepState.INVOKING
               )
@@ -385,14 +398,14 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
               }
             },
           })
+
+          failTrap(done)
         })
 
-        it.skip("should subscribe to a async workflow and receive the response when it finishes", (done) => {
+        it("should subscribe to a async workflow and receive the response when it finishes", (done) => {
           const transactionId = "trx_123"
 
-          const onFinish = jest.fn(() => {
-            done()
-          })
+          const onFinish = jest.fn()
 
           void workflowOrcModule.run("workflow_async_background", {
             input: {
@@ -408,11 +421,36 @@ moduleIntegrationTestRunner<IWorkflowEngineService>({
             subscriber: (event) => {
               if (event.eventType === "onFinish") {
                 onFinish()
+                done()
               }
             },
           })
 
           expect(onFinish).toHaveBeenCalledTimes(0)
+
+          failTrap(done)
+        })
+
+        it("should not skip step if condition is true", function (done) {
+          void workflowOrcModule.run("wf-when", {
+            input: {
+              callSubFlow: true,
+            },
+            transactionId: "trx_123_when",
+            throwOnError: true,
+            logOnError: true,
+          })
+
+          void workflowOrcModule.subscribe({
+            workflowId: "wf-when",
+            subscriber: (event) => {
+              if (event.eventType === "onFinish") {
+                done()
+              }
+            },
+          })
+
+          failTrap(done)
         })
       })