feat(fulfillment): Module service implementation first iteration

packages/customer/src/migrations/Migration20240124154000.ts

@@ -23,7 +23,7 @@ export class Migration20240124154000 extends Migration {
       'create index if not exists "IDX_customer_address_customer_id" on "customer_address" ("customer_id");'
     )
     this.addSql(
-      'create unique index "IDX_customer_address_unqiue_customer_billing" on "customer_address" ("customer_id") where "is_default_billing" = true;'
+      'create unique index "IDX_customer_address_unique_customer_billing" on "customer_address" ("customer_id") where "is_default_billing" = true;'
     )
     this.addSql(
       'create unique index "IDX_customer_address_unique_customer_shipping" on "customer_address" ("customer_id") where "is_default_shipping" = true;'

packages/fulfillment/integration-tests/__tests__/fulfillment-module-service.spec.ts

@@ -0,0 +1,314 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { initModules } from "medusa-test-utils/dist"
+import {
+  CreateFulfillmentSetDTO,
+  IFulfillmentModuleService,
+} from "@medusajs/types"
+import { getInitModuleConfig, MikroOrmWrapper } from "../utils"
+import { GeoZoneType } from "@medusajs/utils"
+
+describe("fulfillment module service", function () {
+  let service: IFulfillmentModuleService
+  let shutdownFunc: () => Promise<void>
+
+  beforeAll(async () => {
+    const initModulesConfig = getInitModuleConfig()
+
+    const { medusaApp, shutdown } = await initModules(initModulesConfig)
+
+    service = medusaApp.modules[Modules.FULFILLMENT]
+
+    shutdownFunc = shutdown
+  })
+
+  beforeEach(async () => {
+    await MikroOrmWrapper.setupDatabase()
+  })
+
+  afterEach(async () => {
+    await MikroOrmWrapper.clearDatabase()
+  })
+
+  afterAll(async () => {
+    await shutdownFunc()
+  })
+
+  describe("on create", () => {
+    it("should create a new fulfillment set", async function () {
+      const data: CreateFulfillmentSetDTO = {
+        name: "test",
+        type: "test-type",
+      }
+
+      const fulfillmentSets = await service.create(data)
+
+      expect(fulfillmentSets).toHaveLength(1)
+      expect(fulfillmentSets[0]).toEqual(
+        expect.objectContaining({
+          id: expect.any(String),
+          name: data.name,
+          type: data.type,
+        })
+      )
+    })
+
+    it("should create a collection of fulfillment sets", async function () {
+      const data = [
+        {
+          name: "test",
+          type: "test-type",
+        },
+        {
+          name: "test2",
+          type: "test-type2",
+        },
+      ]
+
+      const fulfillmentSets = await service.create(data)
+
+      expect(fulfillmentSets).toHaveLength(2)
+
+      let i = 0
+      for (const data_ of data) {
+        expect(fulfillmentSets[i]).toEqual(
+          expect.objectContaining({
+            id: expect.any(String),
+            name: data_.name,
+            type: data_.type,
+          })
+        )
+        ++i
+      }
+    })
+
+    it("should create a new fulfillment set with new service zones", async function () {
+      const data = {
+        name: "test",
+        type: "test-type",
+        service_zones: [
+          {
+            name: "test",
+          },
+        ],
+      }
+
+      const fulfillmentSets = await service.create(data)
+
+      expect(fulfillmentSets).toHaveLength(1)
+      expect(fulfillmentSets[0]).toEqual(
+        expect.objectContaining({
+          id: expect.any(String),
+          name: data.name,
+          type: data.type,
+          service_zones: expect.arrayContaining([
+            expect.objectContaining({
+              id: expect.any(String),
+              name: data.service_zones[0].name,
+            }),
+          ]),
+        })
+      )
+    })
+
+    it("should create a collection of fulfillment sets with new service zones", async function () {
+      const data = [
+        {
+          name: "test",
+          type: "test-type",
+          service_zones: [
+            {
+              name: "test",
+            },
+          ],
+        },
+        {
+          name: "test2",
+          type: "test-type2",
+          service_zones: [
+            {
+              name: "test",
+            },
+          ],
+        },
+        {
+          name: "test3",
+          type: "test-type3",
+          service_zones: [
+            {
+              name: "test2",
+            },
+          ],
+        },
+      ]
+
+      const fulfillmentSets = await service.create(data)
+
+      expect(fulfillmentSets).toHaveLength(3)
+
+      let i = 0
+      for (const data_ of data) {
+        expect(fulfillmentSets[i]).toEqual(
+          expect.objectContaining({
+            id: expect.any(String),
+            name: data_.name,
+            type: data_.type,
+            service_zones: expect.arrayContaining([
+              expect.objectContaining({
+                id: expect.any(String),
+                name: data_.service_zones[0].name,
+              }),
+            ]),
+          })
+        )
+        ++i
+      }
+
+      // The two first fulfillment sets share the same service zone
+      expect(fulfillmentSets[0].service_zones[0].id).toEqual(
+        fulfillmentSets[1].service_zones[0].id
+      )
+    })
+
+    it("should create a new fulfillment set with new service zones and new geo zones", async function () {
+      const data: CreateFulfillmentSetDTO = {
+        name: "test",
+        type: "test-type",
+        service_zones: [
+          {
+            name: "test",
+            geo_zones: [
+              {
+                type: GeoZoneType.COUNTRY,
+                country_code: "fr",
+              },
+            ],
+          },
+        ],
+      }
+
+      const fulfillmentSets = await service.create(data)
+
+      expect(fulfillmentSets).toHaveLength(1)
+      expect(fulfillmentSets[0]).toEqual(
+        expect.objectContaining({
+          id: expect.any(String),
+          name: data.name,
+          type: data.type,
+          service_zones: expect.arrayContaining([
+            expect.objectContaining({
+              id: expect.any(String),
+              name: (data.service_zones![0] as any).name,
+              geo_zones: expect.arrayContaining([
+                expect.objectContaining({
+                  type: (data.service_zones![0] as any).geo_zones[0].type,
+                  country_code: (data.service_zones![0] as any).geo_zones[0]
+                    .country_code,
+                }),
+              ]),
+            }),
+          ]),
+        })
+      )
+    })
+
+    it("should create a collection of fulfillment sets with new service zones and new geo zones", async function () {
+      const data: CreateFulfillmentSetDTO[] = [
+        {
+          name: "test",
+          type: "test-type",
+          service_zones: [
+            {
+              name: "test",
+              geo_zones: [
+                {
+                  type: GeoZoneType.COUNTRY,
+                  country_code: "fr",
+                },
+              ],
+            },
+          ],
+        },
+        {
+          name: "test2",
+          type: "test-type2",
+          service_zones: [
+            {
+              name: "test",
+              geo_zones: [
+                {
+                  type: GeoZoneType.COUNTRY,
+                  country_code: "fr",
+                },
+              ],
+            },
+          ],
+        },
+        {
+          name: "test3",
+          type: "test-type3",
+          service_zones: [
+            {
+              name: "test2",
+              geo_zones: [
+                {
+                  type: GeoZoneType.CITY,
+                  country_code: "fr",
+                  city: "lyon",
+                },
+              ],
+            },
+          ],
+        },
+      ]
+
+      const fulfillmentSets = await service.create(data)
+
+      expect(fulfillmentSets).toHaveLength(3)
+
+      let i = 0
+      for (const data_ of data) {
+        expect(fulfillmentSets[i]).toEqual(
+          expect.objectContaining({
+            id: expect.any(String),
+            name: data_.name,
+            type: data_.type,
+            service_zones: expect.arrayContaining([
+              expect.objectContaining({
+                id: expect.any(String),
+                name: (data_.service_zones![0] as any).name,
+                geo_zones: expect.arrayContaining([
+                  expect.objectContaining({
+                    type: (data_.service_zones![0] as any).geo_zones[0].type,
+                    country_code: (data_.service_zones![0] as any).geo_zones[0]
+                      .country_code,
+                  }),
+                ]),
+              }),
+            ]),
+          })
+        )
+        ++i
+      }
+
+      // The two first fulfillment sets share the same geo zone for their service zones
+      expect(fulfillmentSets[0].service_zones[0].geo_zones[0].id).toEqual(
+        fulfillmentSets[1].service_zones[0].geo_zones[0].id
+      )
+    })
+
+    describe("should fail", () => {
+      it(`on duplicated fulfillment set name`, async function () {
+        const data: CreateFulfillmentSetDTO = {
+          name: "test",
+          type: "test-type",
+        }
+
+        await service.create(data)
+        await service.create(data)
+
+        const ful = await service.list({})
+        console.log(JSON.stringify(ful, null, 2))
+      })
+    })
+  })
+})

packages/fulfillment/integration-tests/utils/database.ts

@@ -2,17 +2,12 @@ import { TestDatabaseUtils } from "medusa-test-utils"
 
 import * as Models from "@models"
 
-const pathToMigrations = "../../src/migrations"
 const mikroOrmEntities = Models as unknown as any[]
 
 export const MikroOrmWrapper = TestDatabaseUtils.getMikroOrmWrapper(
   mikroOrmEntities,
-  pathToMigrations
-)
-
-export const MikroOrmConfig = TestDatabaseUtils.getMikroOrmConfig(
-  mikroOrmEntities,
-  pathToMigrations
+  null,
+  process.env.MEDUSA_FULFILLMENT_DB_SCHEMA
 )
 
 export const DB_URL = TestDatabaseUtils.getDatabaseURL()

packages/fulfillment/integration-tests/utils/index.ts

@@ -1 +1,2 @@
 export * from "./database"
+export * from "./get-init-module-config"

packages/fulfillment/jest.config.js

@@ -4,6 +4,7 @@ module.exports = {
     "^@services": "<rootDir>/src/services",
     "^@repositories": "<rootDir>/src/repositories",
     "^@types": "<rootDir>/src/types",
+    "^@migrations": "<rootDir>/src/migrations",
   },
   transform: {
     "^.+\\.[jt]s?$": [