feat: Flatten the provider config for all modules (#7930)

integration-tests/api/medusa-config.js

@@ -14,20 +14,12 @@ const customPaymentProvider = {
   resolve: {
     services: [require("@medusajs/payment/dist/providers/system").default],
   },
-  options: {
+  id: "default_2",
-    config: {
-      default_2: {},
-    },
-  },
 }
 
 const customFulfillmentProvider = {
   resolve: "@medusajs/fulfillment-manual",
-  options: {
+  id: "test-provider",
-    config: {
-      "test-provider": {},
-    },
-  },
 }
 
 module.exports = {
@@ -74,11 +66,7 @@ module.exports = {
         providers: [
           {
             resolve: "@medusajs/file-local-next",
-            options: {
+            id: "local",
-              config: {
-                local: {},
-              },
-            },
           },
         ],
       },
@@ -116,13 +104,10 @@ module.exports = {
         providers: [
           {
             resolve: "@medusajs/notification-local",
+            id: "local-notification-provider",
             options: {
-              config: {
+              name: "Local Notification Provider",
-                "local-notification-provider": {
+              channels: ["log", "email"],
-                  name: "Local Notification Provider",
-                  channels: ["log", "email"],
-                },
-              },
             },
           },
         ],

integration-tests/http/medusa-config.js

@@ -12,11 +12,7 @@ process.env.LOG_LEVEL = "error"
 
 const customFulfillmentProvider = {
   resolve: "@medusajs/fulfillment-manual",
-  options: {
+  id: "test-provider",
-    config: {
-      "test-provider": {},
-    },
-  },
 }
 
 module.exports = defineConfig({
@@ -41,11 +37,10 @@ module.exports = defineConfig({
         providers: [
           {
             resolve: "@medusajs/file-local-next",
+            id: "local",
             options: {
-              config: {
+              // This is the directory where we can reliably write in CI environments
-                // This is the directory where we can reliably write in CI environments
+              upload_dir: path.join(os.tmpdir(), "uploads"),
-                local: { upload_dir: path.join(os.tmpdir(), "uploads") },
-              },
             },
           },
         ],

integration-tests/modules/medusa-config.js

@@ -14,20 +14,12 @@ const customPaymentProvider = {
   resolve: {
     services: [require("@medusajs/payment/dist/providers/system").default],
   },
-  options: {
+  id: "default_2",
-    config: {
-      default_2: {},
-    },
-  },
 }
 
 const customFulfillmentProvider = {
   resolve: "@medusajs/fulfillment-manual",
-  options: {
+  id: "test-provider",
-    config: {
-      "test-provider": {},
-    },
-  },
 }
 
 module.exports = {
@@ -101,13 +93,10 @@ module.exports = {
         providers: [
           {
             resolve: "@medusajs/notification-local",
+            id: "local-notification-provider",
             options: {
-              config: {
+              name: "Local Notification Provider",
-                "local-notification-provider": {
+              channels: ["log", "email"],
-                  name: "Local Notification Provider",
-                  channels: ["log", "email"],
-                },
-              },
             },
           },
         ],

packages/core/modules-sdk/src/loaders/__tests__/module-provider-loader.ts

@@ -22,6 +22,7 @@ describe("modules loader", () => {
     const moduleProviders = [
       {
         resolve: "@providers/default",
+        id: "default",
         options: {},
       },
     ]
@@ -47,6 +48,7 @@ describe("modules loader", () => {
     const moduleProviders = [
       {
         resolve: "@providers/default",
+        id: "default",
         options: {},
       },
     ]
@@ -66,6 +68,7 @@ describe("modules loader", () => {
     const moduleProviders = [
       {
         resolve: "@providers/no-service",
+        id: "default",
         options: {},
       },
     ]
@@ -83,6 +86,7 @@ describe("modules loader", () => {
     const moduleProviders = [
       {
         resolve: "@providers/no-default",
+        id: "default",
         options: {},
       },
     ]

packages/core/modules-sdk/src/loaders/module-provider-loader.ts

@@ -32,8 +32,7 @@ export async function loadModuleProvider(
   registerServiceFn?: (klass, container, moduleDetails) => Promise<void>
 ) {
   let loadedProvider: any
-
+  const moduleName = provider.resolve ?? ""
-  const moduleName = provider.resolve ?? provider.provider_name ?? ""
 
   try {
     loadedProvider = provider.resolve
@@ -60,7 +59,10 @@ export async function loadModuleProvider(
       const name = lowerCaseFirst(service.name)
       if (registerServiceFn) {
         // Used to register the specific type of service in the provider
-        await registerServiceFn(service, container, provider.options)
+        await registerServiceFn(service, container, {
+          id: provider.id,
+          options: provider.options,
+        })
       } else {
         container.register({
           [name]: asFunction(

packages/core/types/src/modules-sdk/module-provider.ts

@@ -6,6 +6,6 @@ export type ModuleProviderExports = {
 
 export type ModuleProvider = {
   resolve: string | ModuleProviderExports
-  provider_name?: string
+  id: string
-  options: Record<string, unknown>
+  options?: Record<string, unknown>
 }

packages/core/utils/src/common/__tests__/define-config.spec.ts

@@ -21,11 +21,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/file-local-next",
                 },
               ],
@@ -36,11 +32,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "manual",
-                    "config": {
-                      "manual": {},
-                    },
-                  },
                   "resolve": "@medusajs/fulfillment-manual",
                 },
               ],
@@ -52,11 +44,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/notification-local",
                 },
               ],
@@ -123,11 +111,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/file-local-next",
                 },
               ],
@@ -138,11 +122,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "manual",
-                    "config": {
-                      "manual": {},
-                    },
-                  },
                   "resolve": "@medusajs/fulfillment-manual",
                 },
               ],
@@ -157,11 +137,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/notification-local",
                 },
               ],
@@ -228,11 +204,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/file-local-next",
                 },
               ],
@@ -243,11 +215,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "manual",
-                    "config": {
-                      "manual": {},
-                    },
-                  },
                   "resolve": "@medusajs/fulfillment-manual",
                 },
               ],
@@ -259,11 +227,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/notification-local",
                 },
               ],
@@ -332,11 +296,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/file-local-next",
                 },
               ],
@@ -347,11 +307,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "manual",
-                    "config": {
-                      "manual": {},
-                    },
-                  },
                   "resolve": "@medusajs/fulfillment-manual",
                 },
               ],
@@ -363,11 +319,7 @@ describe("defineConfig", function () {
             "options": {
               "providers": [
                 {
-                  "options": {
+                  "id": "local",
-                    "config": {
-                      "local": {},
-                    },
-                  },
                   "resolve": "@medusajs/notification-local",
                 },
               ],

packages/core/utils/src/common/define-config.ts

@@ -90,11 +90,7 @@ export function defineConfig(config: Partial<ConfigModule> = {}): ConfigModule {
         providers: [
           {
             resolve: "@medusajs/file-local-next",
-            options: {
+            id: "local",
-              config: {
-                local: {},
-              },
-            },
           },
         ],
       },
@@ -105,11 +101,7 @@ export function defineConfig(config: Partial<ConfigModule> = {}): ConfigModule {
         providers: [
           {
             resolve: "@medusajs/fulfillment-manual",
-            options: {
+            id: "manual",
-              config: {
-                manual: {},
-              },
-            },
           },
         ],
       },
@@ -120,11 +112,7 @@ export function defineConfig(config: Partial<ConfigModule> = {}): ConfigModule {
         providers: [
           {
             resolve: "@medusajs/notification-local",
-            options: {
+            id: "local",
-              config: {
-                local: {},
-              },
-            },
           },
         ],
       },

packages/modules/auth/integration-tests/__tests__/auth-module-service/index.spec.ts

@@ -10,11 +10,7 @@ let moduleOptions = {
         process.cwd() +
           "/integration-tests/__fixtures__/providers/default-provider"
       ),
-      options: {
+      id: "plaintextpass",
-        config: {
-          plaintextpass: {},
-        },
-      },
     },
   ],
 }

packages/modules/auth/src/loaders/providers.ts

@@ -9,18 +9,19 @@ import {
 } from "@types"
 
 const registrationFn = async (klass, container, pluginOptions) => {
-  Object.entries(pluginOptions.config || []).map(([name, config]) => {
+  container.register({
-    container.register({
+    [AuthProviderRegistrationPrefix + pluginOptions.id]: asFunction(
-      [AuthProviderRegistrationPrefix + name]: asFunction(
+      (cradle) => new klass(cradle, pluginOptions.options ?? {}),
-        (cradle) => new klass(cradle, config),
+      {
-        {
+        lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
-          lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
+      }
-        }
+    ),
-      ),
-    })
-
-    container.registerAdd(AuthIdentifiersRegistrationName, asValue(name))
   })
+
+  container.registerAdd(
+    AuthIdentifiersRegistrationName,
+    asValue(pluginOptions.id)
+  )
 }
 
 export default async ({
@@ -32,21 +33,13 @@ export default async ({
     | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions
   ) & { providers: ModuleProvider[] }
 >): Promise<void> => {
-  // TODO: Temporary settings used by the starter, remove once the auth module is updated
-  const isLegacyOptions =
-    options?.providers?.length && !!(options?.providers[0] as any)?.name
-
   // Note: For now we want to inject some providers out of the box
   const providerConfig = [
     {
       resolve: EmailPassProvider,
-      options: {
+      id: "emailpass",
-        config: {
-          emailpass: {},
-        },
-      },
     },
-    ...(isLegacyOptions ? [] : options?.providers ?? []),
+    ...(options?.providers ?? []),
   ]
 
   await moduleProviderLoader({

packages/modules/auth/src/types/index.ts

@@ -19,11 +19,13 @@ export type AuthModuleOptions = Partial<ModuleServiceInitializeOptions> & {
      * The module provider to be registered
      */
     resolve: string | ModuleProviderExports
-    options: {
+    /**
-      /**
+     * The id of the provider
-       * key value pair of the provider name and the configuration to be passed to the provider constructor
+     */
-       */
+    id: string
-      config: Record<string, unknown>
+    /**
-    }
+     * key value pair of the configuration to be passed to the provider constructor
+     */
+    options?: Record<string, unknown>
   }[]
 }

packages/modules/file/integration-tests/__tests__/module.spec.ts

@@ -20,11 +20,7 @@ const moduleOptions = {
         process.cwd() +
           "/integration-tests/__fixtures__/providers/default-provider"
       ),
-      options: {
+      id: "default-provider",
-        config: {
-          "default-provider": {},
-        },
-      },
     },
   ],
 }

packages/modules/file/src/loaders/providers.ts

@@ -8,20 +8,21 @@ import {
 import { Lifetime, asFunction, asValue } from "awilix"
 
 const registrationFn = async (klass, container, pluginOptions) => {
-  Object.entries(pluginOptions.config || []).map(([name, config]) => {
+  const key = FileProviderService.getRegistrationIdentifier(
-    const key = FileProviderService.getRegistrationIdentifier(klass, name)
+    klass,
+    pluginOptions.id
+  )
 
-    container.register({
+  container.register({
-      [FileProviderRegistrationPrefix + key]: asFunction(
+    [FileProviderRegistrationPrefix + key]: asFunction(
-        (cradle) => new klass(cradle, config),
+      (cradle) => new klass(cradle, pluginOptions.options ?? {}),
-        {
+      {
-          lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
+        lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
-        }
+      }
-      ),
+    ),
-    })
-
-    container.registerAdd(FileProviderIdentifierRegistrationName, asValue(key))
   })
+
+  container.registerAdd(FileProviderIdentifierRegistrationName, asValue(key))
 }
 
 export default async ({

packages/modules/file/src/types/index.ts

@@ -17,11 +17,13 @@ export type FileModuleOptions = Partial<ModuleServiceInitializeOptions> & {
      * The module provider to be registered
      */
     resolve: string | ModuleProviderExports
-    options: {
+    /**
-      /**
+     * The id of the provider
-       * key value pair of the provider name and the configuration to be passed to the provider constructor
+     */
-       */
+    id: string
-      config: Record<string, unknown>
+    /**
-    }
+     * key value pair of the configuration to be passed to the provider constructor
+     */
+    options?: Record<string, unknown>
   }
 }

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

@@ -23,11 +23,7 @@ const moduleOptions = {
         process.cwd() +
           "/integration-tests/__fixtures__/providers/default-provider"
       ),
-      options: {
+      id: "test-provider",
-        config: {
-          "test-provider": {},
-        },
-      },
     },
   ],
 }

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

@@ -18,11 +18,7 @@ let moduleOptions = {
         process.cwd() +
           "/integration-tests/__fixtures__/providers/default-provider"
       ),
-      options: {
+      id: "test-provider",
-        config: {
-          "test-provider": {},
-        },
-      },
     },
   ],
 }
@@ -125,17 +121,13 @@ moduleIntegrationTestRunner({
               definition: ModulesDefinition[Modules.FULFILLMENT],
               options: {
                 databaseConfig,
-                providers: [
+                providers: Object.keys(providersConfig).map((id) => ({
-                  {
+                  resolve: resolve(
-                    resolve: resolve(
+                    process.cwd() +
-                      process.cwd() +
+                      "/integration-tests/__fixtures__/providers/default-provider"
-                        "/integration-tests/__fixtures__/providers/default-provider"
+                  ),
-                    ),
+                  id,
-                    options: {
+                })),
-                      config: providersConfig,
-                    },
-                  },
-                ],
               },
             },
           },
@@ -179,17 +171,13 @@ moduleIntegrationTestRunner({
               definition: ModulesDefinition[Modules.FULFILLMENT],
               options: {
                 databaseConfig,
-                providers: [
+                providers: Object.keys(providersConfig2).map((id) => ({
-                  {
+                  resolve: resolve(
-                    resolve: resolve(
+                    process.cwd() +
-                      process.cwd() +
+                      "/integration-tests/__fixtures__/providers/default-provider"
-                        "/integration-tests/__fixtures__/providers/default-provider"
+                  ),
-                    ),
+                  id,
-                    options: {
+                })),
-                      config: providersConfig2,
-                    },
-                  },
-                ],
               },
             },
           },

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

@@ -25,11 +25,7 @@ const moduleOptions = {
         process.cwd() +
           "/integration-tests/__fixtures__/providers/default-provider"
       ),
-      options: {
+      id: "test-provider",
-        config: {
-          "test-provider": {},
-        },
-      },
     },
   ],
 }

packages/modules/fulfillment/src/loaders/providers.ts

@@ -10,20 +10,21 @@ import { FulfillmentIdentifiersRegistrationName } from "@types"
 import { Lifetime, asFunction, asValue } from "awilix"
 
 const registrationFn = async (klass, container, pluginOptions) => {
-  Object.entries(pluginOptions.config || []).map(([name, config]) => {
+  const key = FulfillmentProviderService.getRegistrationIdentifier(
-    const key = FulfillmentProviderService.getRegistrationIdentifier(
+    klass,
-      klass,
+    pluginOptions.id
-      name
+  )
-    )
 
-    container.register({
+  container.register({
-      ["fp_" + key]: asFunction((cradle) => new klass(cradle, config), {
+    ["fp_" + key]: asFunction(
+      (cradle) => new klass(cradle, pluginOptions.options),
+      {
         lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
-      }),
+      }
-    })
+    ),
-
-    container.registerAdd(FulfillmentIdentifiersRegistrationName, asValue(key))
   })
+
+  container.registerAdd(FulfillmentIdentifiersRegistrationName, asValue(key))
 }
 
 export default async ({

packages/modules/fulfillment/src/types/index.ts

@@ -23,11 +23,13 @@ export type FulfillmentModuleOptions =
        * The module provider to be registered
        */
       resolve: string | ModuleProviderExports
-      options: {
+      /**
-        /**
+       * The id of the provider
-         * key value pair of the provider name and the configuration to be passed to the provider constructor
+       */
-         */
+      id: string
-        config: Record<string, unknown>
+      /**
-      }
+       * key value pair of the configuration to be passed to the provider constructor
+       */
+      options?: Record<string, unknown>
     }[]
   }

packages/modules/notification/integration-tests/__tests__/notification-module-service/index.spec.ts

@@ -10,13 +10,10 @@ let moduleOptions = {
         process.cwd() +
           "/integration-tests/__fixtures__/providers/default-provider"
       ),
+      id: "test-provider",
       options: {
-        config: {
+        name: "Test provider",
-          "test-provider": {
+        channels: ["email"],
-            name: "Test provider",
-            channels: ["email"],
-          },
-        },
       },
     },
   ],

packages/modules/notification/src/loaders/providers.ts

@@ -1,11 +1,5 @@
 import { moduleProviderLoader } from "@medusajs/modules-sdk"
-import {
+import { LoaderOptions, ModuleProvider, ModulesSdkTypes } from "@medusajs/types"
-  DAL,
-  InferEntityType,
-  LoaderOptions,
-  ModuleProvider,
-  ModulesSdkTypes,
-} from "@medusajs/types"
 import {
   ContainerRegistrationKeys,
   lowerCaseFirst,
@@ -20,21 +14,19 @@ import {
 import { Lifetime, asFunction, asValue } from "awilix"
 
 const registrationFn = async (klass, container, pluginOptions) => {
-  Object.entries(pluginOptions.config || []).map(([name, config]) => {
+  container.register({
-    container.register({
+    [NotificationProviderRegistrationPrefix + pluginOptions.id]: asFunction(
-      [NotificationProviderRegistrationPrefix + name]: asFunction(
+      (cradle) => new klass(cradle, pluginOptions.options ?? {}),
-        (cradle) => new klass(cradle, config),
+      {
-        {
+        lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
-          lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
+      }
-        }
+    ),
-      ),
-    })
-
-    container.registerAdd(
-      NotificationIdentifiersRegistrationName,
-      asValue(name)
-    )
   })
+
+  container.registerAdd(
+    NotificationIdentifiersRegistrationName,
+    asValue(pluginOptions.id)
+  )
 }
 
 export default async ({
@@ -74,20 +66,17 @@ async function syncDatabaseProviders({
 
   const logger = container.resolve(ContainerRegistrationKeys.LOGGER) ?? console
   const normalizedProviders = providers.map((provider) => {
-    const [name, config] = Object.entries(
+    if (!provider.id) {
-      provider.options?.config as any
-    )?.[0] as any
-    if (!name) {
       throw new Error(
         "An entry in the provider config is required to initialize notification providers"
       )
     }
 
-    const id = name
+    const config = provider.options as { channels: string[] }
     return {
-      id,
+      id: provider.id,
-      handle: name,
+      handle: provider.id,
-      name: config?.name ?? name,
+      name: provider.id,
       is_enabled: true,
       channels: config?.channels ?? [],
     }

packages/modules/notification/src/types/index.ts

@@ -23,11 +23,13 @@ export type NotificationModuleOptions =
        * The module provider to be registered
        */
       resolve: string | ModuleProviderExports
-      options: {
+      /**
-        /**
+       * The id of the provider
-         * key value pair of the provider name and the configuration to be passed to the provider constructor
+       */
-         */
+      id: string
-        config: Record<string, unknown>
+      /**
-      }
+       * key value pair of the configuration to be passed to the provider constructor
+       */
+      options?: Record<string, unknown>
     }[]
   }

packages/modules/payment/src/loaders/providers.ts

@@ -11,17 +11,15 @@ import * as providers from "../providers"
 import { PaymentProviderService } from "@services"
 
 const registrationFn = async (klass, container, pluginOptions) => {
-  Object.entries(pluginOptions.config || []).map(([name, config]) => {
+  const key = `pp_${klass.PROVIDER}_${pluginOptions.id}`
-    const key = `pp_${klass.PROVIDER}_${name}`
 
-    container.register({
+  container.register({
-      [key]: asFunction((cradle) => new klass(cradle, config), {
+    [key]: asFunction((cradle) => new klass(cradle, pluginOptions.options), {
-        lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
+      lifetime: klass.LIFE_TIME || Lifetime.SINGLETON,
-      }),
+    }),
-    })
-
-    container.registerAdd("payment_providers", asValue(key))
   })
+
+  container.registerAdd("payment_providers", asValue(key))
 }
 
 export default async ({
@@ -35,7 +33,7 @@ export default async ({
 >): Promise<void> => {
   // Local providers
   for (const provider of Object.values(providers)) {
-    await registrationFn(provider, container, { config: { default: {} } })
+    await registrationFn(provider, container, { id: "default" })
   }
 
   await moduleProviderLoader({

packages/modules/payment/src/types/index.ts

@@ -17,11 +17,13 @@ export type PaymentModuleOptions = Partial<ModuleServiceInitializeOptions> & {
      * The module provider to be registered
      */
     resolve: string | ModuleProviderExports
-    options: {
+    /**
-      /**
+     * The id of the provider
-       * key value pair of the provider name and the configuration to be passed to the provider constructor
+     */
-       */
+    id: string
-      config: Record<string, unknown>
+    /**
-    }
+     * key value pair of the configuration to be passed to the provider constructor
+     */
+    options?: Record<string, unknown>
   }[]
 }