chore(framework): Move and improve links loader (#8367)

**What**
Refactor and move links loader

FIXES FRMW-2637

packages/medusa/src/commands/links.ts

@@ -2,13 +2,13 @@ import boxen from "boxen"
 import chalk from "chalk"
 import checkbox from "@inquirer/checkbox"
 
-import { logger } from "@medusajs/framework"
+import { LinkLoader, logger } from "@medusajs/framework"
 import { initializeContainer } from "../loaders"
 import { ContainerRegistrationKeys } from "@medusajs/utils"
 import { getResolvedPlugins } from "../loaders/helpers/resolve-plugins"
-import { resolvePluginsLinks } from "../loaders/helpers/resolve-plugins-links"
 import { getLinksExecutionPlanner } from "../loaders/medusa-app"
 import { LinkMigrationsPlannerAction } from "@medusajs/types"
+import { join } from "path"
 
 type Action = "sync"
 
@@ -103,11 +103,13 @@ const main = async function ({ directory }) {
     )
 
     const plugins = getResolvedPlugins(directory, configModule, true) || []
-    const pluginLinks = await resolvePluginsLinks(plugins, container)
+    const linksSourcePaths = plugins.map((plugin) =>
+      join(plugin.resolve, "links")
+    )
+    await new LinkLoader(linksSourcePaths).load()
 
     const planner = await getLinksExecutionPlanner({
       configModule,
-      linkModules: pluginLinks,
       container,
     })
 

packages/medusa/src/commands/migrate.ts

@@ -1,9 +1,9 @@
-import { logger } from "@medusajs/framework"
+import { LinkLoader, logger } from "@medusajs/framework"
 import { runMedusaAppMigrations } from "../loaders/medusa-app"
 import { initializeContainer } from "../loaders"
 import { ContainerRegistrationKeys, MedusaError } from "@medusajs/utils"
 import { getResolvedPlugins } from "../loaders/helpers/resolve-plugins"
-import { resolvePluginsLinks } from "../loaders/helpers/resolve-plugins-links"
+import { join } from "path"
 
 const TERMINAL_SIZE = process.stdout.columns
 
@@ -52,14 +52,16 @@ const main = async function ({ directory }) {
   )
 
   const plugins = getResolvedPlugins(directory, configModule, true) || []
-  const pluginLinks = await resolvePluginsLinks(plugins, container)
+  const linksSourcePaths = plugins.map((plugin) =>
+    join(plugin.resolve, "links")
+  )
+  await new LinkLoader(linksSourcePaths).load()
 
   if (action === "run") {
     logger.info("Running migrations...")
 
     await runMedusaAppMigrations({
       configModule,
-      linkModules: pluginLinks,
       container,
       action: "run",
     })
@@ -74,7 +76,6 @@ const main = async function ({ directory }) {
       await runMedusaAppMigrations({
         moduleNames: modules,
         configModule,
-        linkModules: pluginLinks,
         container,
         action: "revert",
       })
@@ -100,7 +101,6 @@ const main = async function ({ directory }) {
     await runMedusaAppMigrations({
       moduleNames: modules,
       configModule,
-      linkModules: pluginLinks,
       container,
       action: "generate",
     })

packages/medusa/src/loaders/__tests__/resolve-plugins-links.spec.ts

@@ -1,73 +0,0 @@
-import { mkdirSync, rmSync, writeFileSync } from "fs"
-import { resolve } from "path"
-import { resolvePluginsLinks } from "../helpers/resolve-plugins-links"
-import { createMedusaContainer } from "@medusajs/utils"
-import { asValue } from "awilix"
-
-const distTestTargetDirectorPath = resolve(__dirname, "__links__")
-
-const getFolderTestTargetDirectoryPath = (folderName: string): string => {
-  return resolve(distTestTargetDirectorPath, folderName)
-}
-
-describe("resolve plugins links", () => {
-  beforeEach(() => {
-    jest.resetModules()
-    jest.clearAllMocks()
-
-    rmSync(distTestTargetDirectorPath, { recursive: true, force: true })
-
-    mkdirSync(getFolderTestTargetDirectoryPath("links"), {
-      mode: "777",
-      recursive: true,
-    })
-  })
-
-  afterAll(() => {
-    rmSync(distTestTargetDirectorPath, { recursive: true, force: true })
-  })
-
-  it("should load the custom links from the links directory", async () => {
-    writeFileSync(
-      resolve(getFolderTestTargetDirectoryPath("links"), "link.js"),
-      `
-        export default {
-          isLink: true
-        }
-      `
-    )
-
-    writeFileSync(
-      resolve(getFolderTestTargetDirectoryPath("links"), "empty-link.js"),
-      `
-          export default 'string'
-      `
-    )
-
-    const loggerMock = { warn: jest.fn() }
-    const container = createMedusaContainer()
-    container.register({
-      logger: asValue(loggerMock),
-    })
-
-    const links = await resolvePluginsLinks(
-      [
-        {
-          resolve: distTestTargetDirectorPath,
-        },
-      ],
-      container
-    )
-
-    expect(loggerMock.warn).toHaveBeenCalledTimes(1)
-    expect(loggerMock.warn).toHaveBeenCalledWith(
-      `Links file ${distTestTargetDirectorPath}/links/empty-link.js does not export a default object`
-    )
-
-    expect(links).toEqual([
-      {
-        isLink: true,
-      },
-    ])
-  })
-})

packages/medusa/src/loaders/helpers/resolve-plugins-links.ts

@@ -1,57 +0,0 @@
-import { glob } from "glob"
-import {
-  MedusaContainer,
-  ModuleJoinerConfig,
-  PluginDetails,
-} from "@medusajs/types"
-import {
-  ContainerRegistrationKeys,
-  DefineLinkSymbol,
-  isObject,
-} from "@medusajs/utils"
-
-/**
- * import files from the links directory to retrieve the links to be loaded
- * @param plugins
- * @param container
- */
-export async function resolvePluginsLinks(
-  plugins: PluginDetails[],
-  container: MedusaContainer
-): Promise<ModuleJoinerConfig[]> {
-  const logger =
-    container.resolve(ContainerRegistrationKeys.LOGGER, {
-      allowUnregistered: true,
-    }) ?? console
-  return (
-    await Promise.all(
-      plugins.map(async (pluginDetails) => {
-        const files = glob.sync(
-          `${pluginDetails.resolve}/links/*.{ts,js,mjs,mts}`,
-          {
-            ignore: ["**/*.d.ts", "**/*.map"],
-          }
-        )
-        return (
-          await Promise.all(
-            files.map(async (file) => {
-              const import_ = await import(file)
-              if (import_.default && !isObject(import_.default)) {
-                logger.warn(
-                  `Links file ${file} does not export a default object`
-                )
-                return
-              }
-
-              return import_.default
-            })
-          )
-        ).filter((value) => {
-          return isObject(value) && !value[DefineLinkSymbol]
-        })
-      })
-    )
-  )
-    .flat(Infinity)
-    .filter(Boolean)
-}

packages/medusa/src/loaders/index.ts

@@ -13,6 +13,7 @@ import {
   container,
   expressLoader,
   featureFlagsLoader,
+  LinkLoader,
   JobLoader,
   logger,
   pgConnectionLoader,
@@ -20,7 +21,6 @@ import {
 } from "@medusajs/framework"
 import { registerWorkflows } from "./helpers/register-workflows"
 import { getResolvedPlugins } from "./helpers/resolve-plugins"
-import { resolvePluginsLinks } from "./helpers/resolve-plugins-links"
 import loadMedusaApp from "./medusa-app"
 
 type Options = {
@@ -151,7 +151,10 @@ export default async ({
   )
 
   const plugins = getResolvedPlugins(rootDirectory, configModule, true) || []
-  const pluginLinks = await resolvePluginsLinks(plugins, container)
+  const linksSourcePaths = plugins.map((plugin) =>
+    join(plugin.resolve, "links")
+  )
+  await new LinkLoader(linksSourcePaths).load()
 
   const {
     onApplicationStart,
@@ -159,7 +162,6 @@ export default async ({
     onApplicationPrepareShutdown,
   } = await loadMedusaApp({
     container,
-    linkModules: pluginLinks,
   })
 
   await registerWorkflows(plugins)