feat(core-flows,medusa,types): fulfillment API: create (#7101)

what: - adds fulfillment create API RESOLVES CORE-1962
2024-04-23 08:35:44 +00:00
parent 14a7378375
commit 18f3aacee6
26 changed files with 1037 additions and 14 deletions
@@ -0,0 +1,261 @@
+import {
+  createFulfillmentWorkflow,
+  createFulfillmentWorkflowId,
+  createShipmentWorkflow,
+  createShipmentWorkflowId,
+  updateFulfillmentWorkflow,
+  updateFulfillmentWorkflowId,
+} from "@medusajs/core-flows"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IFulfillmentModuleService } from "@medusajs/types"
+import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
+import {
+  generateCreateFulfillmentData,
+  generateCreateShippingOptionsData,
+} from "../fixtures"
+
+jest.setTimeout(50000)
+
+const providerId = "manual_test-provider"
+
+medusaIntegrationTestRunner({
+  env: { MEDUSA_FF_MEDUSA_V2: true },
+  testSuite: ({ getContainer }) => {
+    describe("Workflows: Fulfillment", () => {
+      let appContainer
+      let service: IFulfillmentModuleService
+
+      beforeAll(async () => {
+        appContainer = getContainer()
+        service = appContainer.resolve(ModuleRegistrationName.FULFILLMENT)
+      })
+
+      describe("createFulfillmentWorkflow", () => {
+        describe("compensation", () => {
+          it("should cancel created fulfillment if step following step throws error", async () => {
+            const workflow = createFulfillmentWorkflow(appContainer)
+
+            workflow.appendAction("throw", createFulfillmentWorkflowId, {
+              invoke: async function failStep() {
+                throw new Error(
+                  `Failed to do something after creating fulfillment`
+                )
+              },
+            })
+
+            const shippingProfile = await service.createShippingProfiles({
+              name: "test",
+              type: "default",
+            })
+
+            const fulfillmentSet = await service.create({
+              name: "test",
+              type: "test-type",
+            })
+
+            const serviceZone = await service.createServiceZones({
+              name: "test",
+              fulfillment_set_id: fulfillmentSet.id,
+            })
+
+            const shippingOption = await service.createShippingOptions(
+              generateCreateShippingOptionsData({
+                provider_id: providerId,
+                service_zone_id: serviceZone.id,
+                shipping_profile_id: shippingProfile.id,
+              })
+            )
+
+            const data = generateCreateFulfillmentData({
+              provider_id: providerId,
+              shipping_option_id: shippingOption.id,
+            })
+            const { errors } = await workflow.run({
+              input: data,
+              throwOnError: false,
+            })
+
+            expect(errors).toEqual([
+              {
+                action: "throw",
+                handlerType: "invoke",
+                error: expect.objectContaining({
+                  message: `Failed to do something after creating fulfillment`,
+                }),
+              },
+            ])
+
+            const fulfillments = await service.listFulfillments()
+
+            expect(fulfillments.filter((f) => !!f.canceled_at)).toHaveLength(1)
+          })
+        })
+      })
+
+      describe("updateFulfillmentWorkflow", () => {
+        describe("compensation", () => {
+          it("should rollback updated fulfillment if step following step throws error", async () => {
+            const workflow = updateFulfillmentWorkflow(appContainer)
+
+            workflow.appendAction("throw", updateFulfillmentWorkflowId, {
+              invoke: async function failStep() {
+                throw new Error(
+                  `Failed to do something after updating fulfillment`
+                )
+              },
+            })
+
+            const shippingProfile = await service.createShippingProfiles({
+              name: "test",
+              type: "default",
+            })
+
+            const fulfillmentSet = await service.create({
+              name: "test",
+              type: "test-type",
+            })
+
+            const serviceZone = await service.createServiceZones({
+              name: "test",
+              fulfillment_set_id: fulfillmentSet.id,
+            })
+
+            const shippingOption = await service.createShippingOptions(
+              generateCreateShippingOptionsData({
+                provider_id: providerId,
+                service_zone_id: serviceZone.id,
+                shipping_profile_id: shippingProfile.id,
+              })
+            )
+
+            const data = generateCreateFulfillmentData({
+              provider_id: providerId,
+              shipping_option_id: shippingOption.id,
+            })
+
+            const fulfillment = await service.createFulfillment(data)
+
+            const date = new Date()
+            const { errors } = await workflow.run({
+              input: {
+                id: fulfillment.id,
+                shipped_at: date,
+                packed_at: date,
+                location_id: "new location",
+              },
+              throwOnError: false,
+            })
+
+            expect(errors).toEqual([
+              {
+                action: "throw",
+                handlerType: "invoke",
+                error: expect.objectContaining({
+                  message: `Failed to do something after updating fulfillment`,
+                }),
+              },
+            ])
+
+            const fulfillmentAfterRollback = await service.retrieveFulfillment(
+              fulfillment.id
+            )
+
+            expect(fulfillmentAfterRollback).toEqual(
+              expect.objectContaining({
+                location_id: data.location_id,
+                shipped_at: data.shipped_at,
+                packed_at: data.packed_at,
+              })
+            )
+          })
+        })
+      })
+
+      describe("createShipmentWorkflow", () => {
+        describe("compensation", () => {
+          it("should rollback shipment workflow if following step throws error", async () => {
+            const workflow = createShipmentWorkflow(appContainer)
+
+            workflow.appendAction("throw", createShipmentWorkflowId, {
+              invoke: async function failStep() {
+                throw new Error(
+                  `Failed to do something after creating shipment`
+                )
+              },
+            })
+
+            const shippingProfile = await service.createShippingProfiles({
+              name: "test",
+              type: "default",
+            })
+
+            const fulfillmentSet = await service.create({
+              name: "test",
+              type: "test-type",
+            })
+
+            const serviceZone = await service.createServiceZones({
+              name: "test",
+              fulfillment_set_id: fulfillmentSet.id,
+            })
+
+            const shippingOption = await service.createShippingOptions(
+              generateCreateShippingOptionsData({
+                provider_id: providerId,
+                service_zone_id: serviceZone.id,
+                shipping_profile_id: shippingProfile.id,
+              })
+            )
+
+            const data = generateCreateFulfillmentData({
+              provider_id: providerId,
+              shipping_option_id: shippingOption.id,
+            })
+
+            const fulfillment = await service.createFulfillment({
+              ...data,
+              labels: [],
+            })
+
+            const { errors } = await workflow.run({
+              input: {
+                id: fulfillment.id,
+                labels: [
+                  {
+                    tracking_number: "test-tracking-number",
+                    tracking_url: "test-tracking-url",
+                    label_url: "test-label-url",
+                  },
+                ],
+              },
+              throwOnError: false,
+            })
+
+            expect(errors).toEqual([
+              {
+                action: "throw",
+                handlerType: "invoke",
+                error: expect.objectContaining({
+                  message: `Failed to do something after creating shipment`,
+                }),
+              },
+            ])
+
+            const fulfillmentAfterRollback = await service.retrieveFulfillment(
+              fulfillment.id,
+              { select: ["shipped_at"], relations: ["labels"] }
+            )
+
+            expect(fulfillmentAfterRollback).toEqual(
+              expect.objectContaining({
+                shipped_at: null,
+                // TODO: the revert isn't handling deleting the labels. This needs to be handled uniformly across.
+                // labels: [],
+              })
+            )
+          })
+        })
+      })
+    })
+  },
+})