feat: Remote Joiner

.changeset/afraid-otters-train.md

@@ -0,0 +1,7 @@
+---
+"@medusajs/orchestration": patch
+"@medusajs/types": patch
+"@medusajs/utils": patch
+---
+
+feat: Remote Joiner

packages/orchestration/jest.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  globals: {
+    "ts-jest": {
+      tsConfig: "tsconfig.json",
+      isolatedModules: false,
+    },
+  },
+  transform: {
+    "^.+\\.[jt]s?$": "ts-jest",
+  },
+  testEnvironment: `node`,
+  moduleFileExtensions: [`js`, `ts`],
+}

packages/orchestration/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@medusajs/orchestration",
+  "version": "0.0.1",
+  "description": "Medusa utilities to orchestrate modules",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/orchestration"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Medusa",
+  "license": "MIT",
+  "devDependencies": {
+    "@medusajs/types": "^1.8.7",
+    "cross-env": "^5.2.1",
+    "jest": "^25.5.4",
+    "ts-jest": "^25.5.1",
+    "typescript": "^4.4.4"
+  },
+  "dependencies": {
+    "@medusajs/utils": "^1.9.1",
+    "graphql": "^16.6.0"
+  },
+  "scripts": {
+    "prepare": "cross-env NODE_ENV=production yarn run build",
+    "build": "tsc --build",
+    "watch": "tsc --build --watch",
+    "test": "jest"
+  }
+}

packages/orchestration/src/__fixtures__/joiner/data.ts

@@ -0,0 +1,189 @@
+export const remoteJoinerData = {
+  user: [
+    {
+      id: 1,
+      email: "[email protected]",
+      name: "John Doe",
+      fullname: "John Doe full name",
+      products: [
+        {
+          id: 1,
+          product_id: 102,
+        },
+      ],
+      nested: {
+        lala: "lala",
+        multiple: [
+          {
+            abc: 1,
+          },
+          {
+            abc: 2,
+          },
+        ],
+      },
+    },
+    {
+      id: 2,
+      email: "[email protected]",
+      name: "Jane Doe",
+      products: [
+        {
+          id: 2,
+          product_id: [101, 102],
+        },
+      ],
+      nested: {
+        lala: "lele",
+        multiple: [
+          {
+            a: 33,
+          },
+          {
+            a: 44,
+          },
+        ],
+      },
+    },
+    {
+      id: 3,
+      email: "[email protected]",
+      name: "aaa bbb",
+      fullname: "3333 Doe full name",
+      nested: {
+        lala: "lolo",
+        multiple: [
+          {
+            a: 555,
+          },
+          {
+            a: 555,
+          },
+        ],
+      },
+    },
+    {
+      id: 4,
+      email: "[email protected]",
+      name: "a4444 44 44",
+      fullname: "444 Doe full name",
+      products: [
+        {
+          id: 4,
+          product_id: 103,
+        },
+      ],
+      nested: {
+        lala: "lulu",
+        multiple: [
+          {
+            a: 6666,
+          },
+          {
+            a: 7777,
+          },
+        ],
+      },
+    },
+  ],
+  product: {
+    rows: [
+      {
+        id: 101,
+        name: "Product 1",
+        handler: "product-1-handler",
+        user_id: 2,
+      },
+      {
+        id: 102,
+        name: "Product 2",
+        handler: "product-2-handler",
+        user_id: 1,
+      },
+      {
+        id: 103,
+        name: "Product 3",
+        handler: "product-3-handler",
+        user_id: 3,
+      },
+    ],
+    limit: 3,
+    skip: 0,
+  },
+  variant: [
+    {
+      id: 991,
+      name: "Product variant 1",
+      product_id: 101,
+    },
+    {
+      id: 992,
+      name: "Product variant 2",
+      product_id: 101,
+    },
+    {
+      id: 993,
+      name: "Product variant 33",
+      product_id: 103,
+    },
+  ],
+  order_variant: [
+    {
+      order_id: 201,
+      product_id: 101,
+      variant_id: 991,
+      quantity: 1,
+    },
+    {
+      order_id: 201,
+      product_id: 101,
+      variant_id: 992,
+      quantity: 5,
+    },
+    {
+      order_id: 205,
+      product_id: 101,
+      variant_id: 992,
+      quantity: 4,
+    },
+    {
+      order_id: 205,
+      product_id: 103,
+      variant_id: 993,
+      quantity: 1,
+    },
+  ],
+  order: [
+    {
+      id: 201,
+      number: "ORD-001",
+      date: "2023-04-01T12:00:00Z",
+      products: [
+        {
+          product_id: 101,
+          variant_id: 991,
+          quantity: 1,
+        },
+        {
+          product_id: 101,
+          variant_id: 992,
+          quantity: 5,
+        },
+      ],
+      user_id: 4,
+    },
+    {
+      id: 205,
+      number: "ORD-202",
+      date: "2023-04-01T12:00:00Z",
+      products: [
+        {
+          product_id: [101, 103],
+          variant_id: 993,
+          quantity: 4,
+        },
+      ],
+      user_id: 1,
+    },
+  ],
+}

packages/orchestration/src/__mocks__/joiner/mock_data.ts

@@ -0,0 +1,118 @@
+import { JoinerServiceConfig } from "@medusajs/types"
+import { remoteJoinerData } from "./../../__fixtures__/joiner/data"
+
+export const serviceConfigs: JoinerServiceConfig[] = [
+  {
+    serviceName: "User",
+    primaryKeys: ["id"],
+    relationships: [
+      {
+        foreignKey: "products.product_id",
+        serviceName: "Product",
+        primaryKey: "id",
+        alias: "product",
+      },
+    ],
+    extends: [
+      {
+        serviceName: "Variant",
+        resolve: {
+          foreignKey: "user_id",
+          serviceName: "User",
+          primaryKey: "id",
+          alias: "user",
+        },
+      },
+    ],
+  },
+  {
+    serviceName: "Product",
+    primaryKeys: ["id", "sku"],
+    relationships: [
+      {
+        foreignKey: "user_id",
+        serviceName: "User",
+        primaryKey: "id",
+        alias: "user",
+      },
+    ],
+  },
+  {
+    serviceName: "Variant",
+    primaryKeys: ["id"],
+    relationships: [
+      {
+        foreignKey: "product_id",
+        serviceName: "Product",
+        primaryKey: "id",
+        alias: "product",
+      },
+      {
+        foreignKey: "variant_id",
+        primaryKey: "id",
+        serviceName: "Order",
+        alias: "orders",
+        inverse: true, // In an inverted relationship the foreign key is on Order and the primary key is on variant
+      },
+    ],
+  },
+  {
+    serviceName: "Order",
+    primaryKeys: ["id"],
+    relationships: [
+      {
+        foreignKey: "product_id",
+        serviceName: "Product",
+        primaryKey: "id",
+        alias: "product",
+      },
+      {
+        foreignKey: "products.variant_id,product_id",
+        serviceName: "Variant",
+        primaryKey: "id,product_id",
+        alias: "variant",
+      },
+      {
+        foreignKey: "user_id",
+        serviceName: "User",
+        primaryKey: "id",
+        alias: "user",
+      },
+    ],
+  },
+]
+
+export const mockServiceList = (serviceName) => {
+  return jest.fn().mockImplementation((data) => {
+    const src = {
+      userService: remoteJoinerData.user,
+      productService: remoteJoinerData.product,
+      variantService: remoteJoinerData.variant,
+      orderService: remoteJoinerData.order,
+    }
+
+    let resultset = JSON.parse(JSON.stringify(src[serviceName]))
+
+    if (
+      serviceName === "userService" &&
+      !data.fields?.some((field) => field.includes("multiple"))
+    ) {
+      resultset = resultset.map((item) => {
+        delete item.nested.multiple
+        return item
+      })
+    }
+
+    return {
+      data: resultset,
+      path: serviceName === "productService" ? "rows" : undefined,
+    }
+  })
+}
+
+export const serviceMock = {
+  orderService: mockServiceList("orderService"),
+  userService: mockServiceList("userService"),
+  productService: mockServiceList("productService"),
+  variantService: mockServiceList("variantService"),
+}