feat(medusa, link-modules): sales channel <> order link

.changeset/swift-carpets-count.md

@@ -0,0 +1,8 @@
+---
+"@medusajs/link-modules": patch
+"@medusajs/core-flows": patch
+"@medusajs/medusa": patch
+"@medusajs/utils": patch
+---
+
+feat: sales channel <> order link

integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap

@@ -425,7 +425,9 @@ Object {
   ],
   "locale": null,
   "order": Object {
+    "afterLoad": [Function],
     "beforeInsert": [Function],
+    "beforeUpdate": [Function],
     "billing_address_id": null,
     "canceled_at": null,
     "cart_id": null,
@@ -753,7 +755,9 @@ Object {
 
 exports[`medusa-plugin-sendgrid order canceled data 1`] = `
 Object {
+  "afterLoad": [Function],
   "beforeInsert": [Function],
+  "beforeUpdate": [Function],
   "billing_address": null,
   "billing_address_id": null,
   "canceled_at": Any<Date>,
@@ -982,7 +986,9 @@ Object {
 
 exports[`medusa-plugin-sendgrid order placed data 1`] = `
 Object {
+  "afterLoad": [Function],
   "beforeInsert": [Function],
+  "beforeUpdate": [Function],
   "billing_address": null,
   "billing_address_id": null,
   "canceled_at": null,
@@ -1236,7 +1242,9 @@ Object {
   },
   "locale": null,
   "order": Object {
+    "afterLoad": [Function],
     "beforeInsert": [Function],
+    "beforeUpdate": [Function],
     "billing_address": null,
     "billing_address_id": null,
     "canceled_at": null,
@@ -1612,7 +1620,9 @@ Object {
   ],
   "locale": null,
   "order": Object {
+    "afterLoad": [Function],
     "beforeInsert": [Function],
+    "beforeUpdate": [Function],
     "billing_address_id": null,
     "canceled_at": null,
     "cart_id": null,
@@ -2078,7 +2088,9 @@ Object {
   ],
   "locale": null,
   "order": Object {
+    "afterLoad": [Function],
     "beforeInsert": [Function],
+    "beforeUpdate": [Function],
     "billing_address_id": null,
     "canceled_at": null,
     "cart_id": null,
@@ -2533,4 +2545,4 @@ Object {
   "tracking_links": Array [],
   "tracking_number": "",
 }
-`;
+`;

integration-tests/plugins/__tests__/medusa-plugin-sendgrid/index.js

@@ -4,10 +4,7 @@ const {
   startBootstrapApp,
 } = require("../../../environment-helpers/bootstrap-app")
 const { initDb, useDb } = require("../../../environment-helpers/use-db")
-const {
-  useApi,
-  useExpressServer,
-} = require("../../../environment-helpers/use-api")
+const { useApi } = require("../../../environment-helpers/use-api")
 
 const adminSeeder = require("../../../helpers/admin-seeder")
 

packages/core-flows/src/handlers/product/detach-sales-channel-from-products.ts

@@ -38,14 +38,13 @@ export async function detachSalesChannelFromProducts({
 
   if (featureFlagRouter.isFeatureEnabled(MedusaV2Flag.key)) {
     const remoteLink = container.resolve("remoteLink")
-    const promises: Promise<unknown>[] = []
 
     for (const [
       salesChannelId,
       productIds,
     ] of salesChannelIdProductIdsMap.entries()) {
-      productIds.forEach((id) =>
-        promises.push(
+      await promiseAll(
+        productIds.map((id) =>
           remoteLink.dismiss({
             [Modules.PRODUCT]: {
               product_id: id,
@@ -57,8 +56,6 @@ export async function detachSalesChannelFromProducts({
         )
       )
     }
-
-    return
   } else {
     await promiseAll(
       Array.from(salesChannelIdProductIdsMap.entries()).map(

packages/link-modules/src/definitions/index.ts

@@ -4,3 +4,4 @@ export * from "./product-variant-price-set"
 export * from "./product-shipping-profile"
 export * from "./product-sales-channel"
 export * from "./cart-sales-channel"
+export * from "./order-sales-channel"

packages/link-modules/src/definitions/order-sales-channel.ts

@@ -0,0 +1,66 @@
+import { ModuleJoinerConfig } from "@medusajs/types"
+
+import { LINKS } from "../links"
+
+export const OrderSalesChannel: ModuleJoinerConfig = {
+  serviceName: LINKS.OrderSalesChannel,
+  isLink: true,
+  databaseConfig: {
+    tableName: "order_sales_channel",
+    idPrefix: "ordersc",
+  },
+  alias: [
+    {
+      name: "order_sales_channel",
+    },
+    {
+      name: "order_sales_channels",
+    },
+  ],
+  primaryKeys: ["id", "order_id", "sales_channel_id"],
+  relationships: [
+    {
+      serviceName: "orderService",
+      isInternalService: true,
+      primaryKey: "id",
+      foreignKey: "order_id",
+      alias: "order",
+    },
+    {
+      serviceName: "salesChannelService",
+      isInternalService: true,
+      primaryKey: "id",
+      foreignKey: "sales_channel_id",
+      alias: "sales_channel",
+    },
+  ],
+  extends: [
+    {
+      serviceName: "orderService",
+      fieldAlias: {
+        sales_channel: "sales_channel_link.sales_channel",
+      },
+      relationship: {
+        serviceName: LINKS.OrderSalesChannel,
+        isInternalService: true,
+        primaryKey: "order_id",
+        foreignKey: "id",
+        alias: "sales_channel_link",
+      },
+    },
+    {
+      serviceName: "salesChannelService",
+      fieldAlias: {
+        orders: "order_link.order",
+      },
+      relationship: {
+        serviceName: LINKS.OrderSalesChannel,
+        isInternalService: true,
+        primaryKey: "sales_channel_id",
+        foreignKey: "id",
+        alias: "order_link",
+        isList: true,
+      },
+    },
+  ],
+}

packages/link-modules/src/links.ts

@@ -34,4 +34,10 @@ export const LINKS = {
     "salesChannelService",
     "sales_channel_id"
   ),
+  OrderSalesChannel: composeLinkName(
+    "orderService",
+    "order_id",
+    "salesChannelService",
+    "sales_channel_id"
+  ),
 }

packages/medusa/src/joiner-configs/order-service.ts

@@ -0,0 +1,15 @@
+import { ModuleJoinerConfig } from "@medusajs/types"
+
+export default {
+  serviceName: "orderService",
+  primaryKeys: ["id"],
+  linkableKeys: { order_id: "Order" },
+  alias: [
+    {
+      name: "order",
+    },
+    {
+      name: "orders",
+    },
+  ],
+} as ModuleJoinerConfig

packages/medusa/src/migrations/1701860329931-order-sales-channels-link.ts

@@ -0,0 +1,43 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import { MedusaV2Flag } from "@medusajs/utils"
+
+import SalesChannelFeatureFlag from "../loaders/feature-flags/sales-channels"
+
+export const featureFlag = [SalesChannelFeatureFlag.key, MedusaV2Flag.key]
+
+export class OrderSalesChannelLink1701860329931 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        CREATE TABLE IF NOT EXISTS "order_sales_channel"
+        (
+            "id"                character varying        NOT NULL,
+            "order_id"          character varying        NOT NULL,
+            "sales_channel_id"  character varying        NOT NULL,
+            "created_at"        TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(),
+            "updated_at"        TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(),
+            "deleted_at"        TIMESTAMP WITH TIME ZONE,
+                                CONSTRAINT "order_sales_channel_pk" PRIMARY KEY ("order_id", "sales_channel_id"),
+                                CONSTRAINT "order_sales_channel_order_id_unique"  UNIQUE ("order_id")
+            );
+        CREATE INDEX IF NOT EXISTS "IDX_id_order_sales_channel" ON "order_sales_channel" ("id");
+
+        insert into "order_sales_channel" (id, order_id, sales_channel_id)
+            (select 'ordersc_' || substr(md5(random()::text), 0, 27), id, sales_channel_id from "order" WHERE sales_channel_id IS NOT NULL);
+
+        ALTER TABLE "order" DROP CONSTRAINT IF EXISTS "FK_6ff7e874f01b478c115fdd462eb";
+    `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        UPDATE "order" 
+            SET "sales_channel_id" = "order_sales_channel"."sales_channel_id"
+            FROM "order_sales_channel"
+            WHERE "order"."id" = "order_sales_channel"."order_id";
+
+        DROP TABLE IF EXISTS "order_sales_channel";
+
+        ALTER TABLE "order" ADD CONSTRAINT "FK_6ff7e874f01b478c115fdd462eb" FOREIGN KEY ("sales_channel_id") REFERENCES "sales_channel"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
+    `)
+  }
+}

packages/medusa/src/models/order-sales-channel.ts

@@ -0,0 +1,29 @@
+import { BeforeInsert, Column, Index, PrimaryColumn } from "typeorm"
+import { MedusaV2Flag, SalesChannelFeatureFlag } from "@medusajs/utils"
+
+import { generateEntityId } from "../utils"
+import { SoftDeletableEntity } from "../interfaces"
+import { FeatureFlagEntity } from "../utils/feature-flag-decorators"
+
+@FeatureFlagEntity([MedusaV2Flag.key, SalesChannelFeatureFlag.key])
+export class OrderSalesChannel extends SoftDeletableEntity {
+  @Column()
+  id: string
+
+  @Index("order_sales_channel_order_id_unique", {
+    unique: true,
+  })
+  @PrimaryColumn()
+  order_id: string
+
+  @PrimaryColumn()
+  sales_channel_id: string
+
+  /**
+   * @apiIgnore
+   */
+  @BeforeInsert()
+  private beforeInsert(): void {
+    this.id = generateEntityId(this.id, "ordersc")
+  }
+}