chore: Refactor batch product workflows and add tests (#7540)

2024-05-30 15:53:03 +02:00
parent fe96bd39b1
commit 4117beed58
7 changed files with 222 additions and 198 deletions
@@ -0,0 +1,156 @@
+import {
+  batchProductsWorkflow,
+  batchProductsWorkflowId,
+  batchProductVariantsWorkflow,
+  batchProductVariantsWorkflowId,
+} from "@medusajs/core-flows"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IProductModuleService } from "@medusajs/types"
+import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
+
+jest.setTimeout(50000)
+
+medusaIntegrationTestRunner({
+  env: {},
+  testSuite: ({ getContainer }) => {
+    describe("Workflows: Batch Product", () => {
+      let appContainer
+      let service: IProductModuleService
+
+      beforeAll(async () => {
+        appContainer = getContainer()
+        service = appContainer.resolve(ModuleRegistrationName.PRODUCT)
+      })
+
+      describe("batchProductWorkflow", () => {
+        describe("compensation", () => {
+          it("should cancel created and deleted products if step throws error", async () => {
+            const workflow = batchProductsWorkflow(appContainer)
+
+            workflow.appendAction("throw", batchProductsWorkflowId, {
+              invoke: async function failStep() {
+                throw new Error(
+                  `Failed the update product workflow after creating product`
+                )
+              },
+            })
+
+            const product1 = await service.create({ title: "test1" })
+            const product2 = await service.create({ title: "test2" })
+
+            const { errors } = await workflow.run({
+              input: {
+                create: [{ title: "test3" }],
+                update: [{ id: product1.id, title: "test1-updated" }],
+                delete: [product2.id],
+              },
+              throwOnError: false,
+            })
+
+            expect(errors).toEqual([
+              {
+                action: "throw",
+                handlerType: "invoke",
+                error: expect.objectContaining({
+                  message: `Failed the update product workflow after creating product`,
+                }),
+              },
+            ])
+
+            const products = await service.list()
+
+            expect(products).toHaveLength(2)
+            expect(products).toEqual([
+              expect.objectContaining({
+                title: "test1",
+              }),
+              expect.objectContaining({
+                title: "test2",
+              }),
+            ])
+          })
+        })
+      })
+
+      describe("batchVariantWorkflow", () => {
+        describe("compensation", () => {
+          it("should cancel created and deleted variant if step throws error", async () => {
+            const workflow = batchProductVariantsWorkflow(appContainer)
+
+            workflow.appendAction("throw", batchProductVariantsWorkflowId, {
+              invoke: async function failStep() {
+                throw new Error(`Failed the update product variant workflow`)
+              },
+            })
+
+            const res = await batchProductsWorkflow(appContainer).run({
+              input: {
+                create: [
+                  {
+                    title: "test1",
+                    variants: [
+                      {
+                        title: "variant1",
+                        prices: [{ amount: 100, currency_code: "EUR" }],
+                      },
+                      {
+                        title: "variant2",
+                        prices: [{ amount: 100, currency_code: "EUR" }],
+                      },
+                    ],
+                  },
+                ],
+              },
+            })
+            const product1 = res.result.created[0]
+
+            const { errors } = await workflow.run({
+              input: {
+                create: [
+                  {
+                    title: "variant3",
+                    product_id: product1.id,
+                    prices: [{ amount: 100, currency_code: "EUR" }],
+                  },
+                ],
+                update: [
+                  {
+                    id: product1.variants[0].id,
+                    product_id: product1.id,
+                    title: "variant1-updated",
+                  },
+                ],
+                delete: [product1.variants[1].id],
+              },
+              throwOnError: false,
+            })
+
+            expect(errors).toEqual([
+              {
+                action: "throw",
+                handlerType: "invoke",
+                error: expect.objectContaining({
+                  message: `Failed the update product variant workflow`,
+                }),
+              },
+            ])
+
+            const product = await service.retrieve(product1.id, {
+              relations: ["variants"],
+            })
+
+            expect(product.variants).toHaveLength(2)
+            expect(product.variants).toEqual([
+              expect.objectContaining({
+                title: "variant1",
+              }),
+              expect.objectContaining({
+                title: "variant2",
+              }),
+            ])
+          })
+        })
+      })
+    })
+  },
+})