chore(medusa, modules-sdk, types): Refactor modules loading from medusa (#5018)

packages/medusa/src/helpers/test-request.js

@@ -1,6 +1,8 @@
 import {
   moduleHelper,
   moduleLoader,
+  ModulesDefinition,
+  registerMedusaModule,
   registerModules,
 } from "@medusajs/modules-sdk"
 import { asValue, createContainer } from "awilix"
@@ -17,6 +19,7 @@ import passportLoader from "../loaders/passport"
 import repositories from "../loaders/repositories"
 import servicesLoader from "../loaders/services"
 import strategiesLoader from "../loaders/strategies"
+import modules from "../modules-config"
 
 const adminSessionOpts = {
   cookieName: "session",
@@ -31,6 +34,14 @@ const clientSessionOpts = {
 }
 
 const moduleResolutions = registerModules({})
+// Load non legacy modules
+Object.keys(modules).map((moduleKey) => {
+  moduleResolutions[moduleKey] = registerMedusaModule(
+    moduleKey,
+    ModulesDefinition[moduleKey]
+  )[moduleKey]
+})
+
 const config = {
   projectConfig: {
     jwt_secret: "supersecret",
@@ -91,24 +102,37 @@ testApp.use((req, res, next) => {
   next()
 })
 
-featureFlagLoader(config)
-models({ container, configModule: config, isTest: true })
-repositories({ container, isTest: true })
-servicesLoader({ container, configModule: config })
-strategiesLoader({ container, configModule: config })
-passportLoader({ app: testApp, container, configModule: config })
-moduleLoader({ container, moduleResolutions })
-
-testApp.use((req, res, next) => {
-  req.scope = container.createScope()
-  next()
+let supertestRequest
+let resolveIsInit
+const isInit = new Promise((resolve) => {
+  resolveIsInit = resolve
 })
 
-apiLoader({ container, app: testApp, configModule: config })
+async function init() {
+  featureFlagLoader(config)
+  models({ container, configModule: config, isTest: true })
+  repositories({ container, isTest: true })
+  servicesLoader({ container, configModule: config })
+  strategiesLoader({ container, configModule: config })
+  await passportLoader({ app: testApp, container, configModule: config })
+  await moduleLoader({ container, moduleResolutions })
 
-const supertestRequest = supertest(testApp)
+  testApp.use((req, res, next) => {
+    req.scope = container.createScope()
+    next()
+  })
+
+  await apiLoader({ container, app: testApp, configModule: config })
+
+  supertestRequest = supertest(testApp)
+  resolveIsInit(true)
+}
+
+init()
 
 export async function request(method, url, opts = {}) {
+  await isInit
+
   const { payload, query, headers = {}, flags = [] } = opts
 
   flags.forEach((flag) => {

packages/medusa/src/loaders/index.ts

@@ -1,4 +1,11 @@
-import { MedusaApp, moduleLoader, registerModules } from "@medusajs/modules-sdk"
+import {
+  ExternalModuleDeclaration,
+  InternalModuleDeclaration,
+  MedusaApp,
+  moduleLoader,
+  ModulesDefinition,
+  registerModules,
+} from "@medusajs/modules-sdk"
 import { ContainerRegistrationKeys } from "@medusajs/utils"
 import { asValue } from "awilix"
 import { Express, NextFunction, Request, Response } from "express"
@@ -11,7 +18,7 @@ import { Connection } from "typeorm"
 import { joinerConfig } from "../joiner-config"
 import modulesConfig from "../modules-config"
 import { MedusaContainer } from "../types/global"
-import { remoteQueryFetchData } from "../utils"
+import { isObject, remoteQueryFetchData } from "../utils"
 import apiLoader from "./api"
 import loadConfig from "./config"
 import databaseLoader, { dataSource } from "./database"
@@ -30,6 +37,7 @@ import searchIndexLoader from "./search-index"
 import servicesLoader from "./services"
 import strategiesLoader from "./strategies"
 import subscribersLoader from "./subscribers"
+import { ConfigModule } from "@medusajs/types"
 
 type Options = {
   directory: string
@@ -37,6 +45,34 @@ type Options = {
   isTest: boolean
 }
 
+/**
+ * Merge the modules config from the medusa-config file with the modules config from medusa package
+ * @param modules
+ * @param medusaInternalModulesConfig
+ */
+function mergeModulesConfig(
+  modules: ConfigModule["modules"],
+  medusaInternalModulesConfig
+) {
+  for (const [moduleName, moduleConfig] of Object.entries(modules as any)) {
+    const moduleDefinition = ModulesDefinition[moduleName]
+
+    if (moduleDefinition?.isLegacy) {
+      continue
+    }
+
+    const isModuleEnabled = moduleConfig === true || isObject(moduleConfig)
+
+    if (!isModuleEnabled) {
+      delete medusaInternalModulesConfig[moduleName]
+    } else {
+      medusaInternalModulesConfig[moduleName] = moduleConfig as Partial<
+        InternalModuleDeclaration | ExternalModuleDeclaration
+      >
+    }
+  }
+}
+
 export default async ({
   directory: rootDirectory,
   expressApp,
@@ -98,10 +134,15 @@ export default async ({
   await pgConnectionLoader({ container, configModule })
 
   const modulesActivity = Logger.activity(`Initializing modules${EOL}`)
+
   track("MODULES_INIT_STARTED")
   await moduleLoader({
     container,
-    moduleResolutions: registerModules(configModule?.modules),
+    moduleResolutions: registerModules(configModule?.modules, {
+      loadLegacyOnly: featureFlagRouter.isFeatureEnabled(
+        IsolateProductDomainFeatureFlag.key
+      ),
+    }),
     logger: Logger,
   })
   const modAct = Logger.success(modulesActivity, "Modules initialized") || {}
@@ -185,7 +226,10 @@ export default async ({
     Logger.success(searchActivity, "Indexing event emitted") || {}
   track("SEARCH_ENGINE_INDEXING_COMPLETED", { duration: searchAct.duration })
 
+  // Only load non legacy modules, the legacy modules (non migrated yet) are retrieved by the registerModule above
   if (featureFlagRouter.isFeatureEnabled(IsolateProductDomainFeatureFlag.key)) {
+    mergeModulesConfig(configModule.modules ?? {}, modulesConfig)
+
     const { query } = await MedusaApp({
       modulesConfig,
       servicesConfig: joinerConfig,

packages/medusa/src/modules-config.ts

@@ -1,9 +1,7 @@
 import { MedusaModuleConfig, Modules } from "@medusajs/modules-sdk"
 
-const modules: MedusaModuleConfig = [
-  {
-    module: Modules.PRODUCT,
-  },
-]
+const modules: MedusaModuleConfig = {
+  [Modules.PRODUCT]: true,
+}
 
 export default modules