Feat: Improvements to the migrations CLI and workflow (#8060)

medusajs · Jul 11, 2024 · 45c573b · 45c573b
1 parent bb0303c
commit 45c573b
Show file tree

Hide file tree

Showing 10 changed files with 255 additions and 142 deletions.
diff --git a/packages/cli/medusa-cli/src/create-cli.ts b/packages/cli/medusa-cli/src/create-cli.ts
@@ -170,13 +170,18 @@ function buildLocalCommands(cli, isLocalProject) {
       ),
     })
     .command({
-      command: `migrations [action]`,
+      command: `migrations [action] [modules...]`,
       desc: `Manage migrations from the core and your own project`,
       builder: {
         action: {
           demand: true,
+          description: "The action to perform on migrations",
           choices: ["run", "revert", "show"],
         },
+        modules: {
+          description: "Revert migrations for defined modules",
+          demand: false,
+        },
       },
       handler: handlerP(
         getCommandHandler(`migrate`, (args, cmd) => {

diff --git a/packages/core/modules-sdk/src/loaders/utils/load-internal.ts b/packages/core/modules-sdk/src/loaders/utils/load-internal.ts
@@ -180,7 +180,6 @@ export async function loadModuleMigrations(
     let runMigrations = loadedModule.runMigrations
     let revertMigration = loadedModule.revertMigration
 
-    // Generate migration scripts if they are not present
     if (!runMigrations || !revertMigration) {
       const moduleResources = await loadResources(
         resolution,
@@ -190,8 +189,7 @@ export async function loadModuleMigrations(
 
       const migrationScriptOptions = {
         moduleName: resolution.definition.key,
-        models: moduleResources.models,
-        pathToMigrations: moduleResources.normalizedPath + "/migrations",
+        pathToMigrations: join(moduleResources.normalizedPath, "migrations"),
       }
 
       runMigrations ??= ModulesSdkUtils.buildMigrationScript(

diff --git a/packages/core/modules-sdk/src/medusa-app.ts b/packages/core/modules-sdk/src/medusa-app.ts
@@ -8,6 +8,7 @@ import type {
   LoadedModule,
   Logger,
   MedusaContainer,
+  ModuleBootstrapDeclaration,
   ModuleDefinition,
   ModuleExports,
   ModuleJoinerConfig,
@@ -21,6 +22,7 @@ import {
   createMedusaContainer,
   isObject,
   isString,
+  MedusaError,
   ModuleRegistrationName,
   Modules,
   ModulesSdkUtils,
@@ -47,10 +49,8 @@ declare module "@medusajs/types" {
   }
 }
 
-export type RunMigrationFn = (
-  options?: ModuleServiceInitializeOptions,
-  injectedDependencies?: Record<any, any>
-) => Promise<void>
+export type RunMigrationFn = () => Promise<void>
+export type RevertMigrationFn = (moduleNames: string[]) => Promise<void>
 
 export type MedusaModuleConfig = {
   [key: string | Modules]:
@@ -176,11 +176,11 @@ async function initializeLinks({
     }
   } catch (err) {
     console.warn("Error initializing link modules.", err)
-
     return {
       remoteLink: undefined,
       linkResolution: undefined,
-      runMigrations: undefined,
+      runMigrations: () => void 0,
+      revertMigrations: () => void 0,
     }
   }
 }
@@ -224,7 +224,7 @@ export type MedusaAppOutput = {
   entitiesMap?: Record<string, any>
   notFound?: Record<string, Record<string, string>>
   runMigrations: RunMigrationFn
-  revertMigrations: RunMigrationFn
+  revertMigrations: RevertMigrationFn
   onApplicationShutdown: () => Promise<void>
   onApplicationPrepareShutdown: () => Promise<void>
   sharedContainer?: MedusaContainer
@@ -317,10 +317,12 @@ async function MedusaApp_({
   delete modules[LinkModulePackage]
   delete modules[Modules.LINK]
 
-  let linkModuleOptions = {}
+  let linkModuleOrOptions:
+    | Partial<ModuleServiceInitializeOptions>
+    | Partial<ModuleBootstrapDeclaration> = {}
 
   if (isObject(linkModule)) {
-    linkModuleOptions = linkModule
+    linkModuleOrOptions = linkModule
   }
 
   for (const injectedDependency of Object.keys(injectedDependencies)) {
@@ -380,7 +382,7 @@ async function MedusaApp_({
     runMigrations: linkModuleMigration,
     revertMigrations: revertLinkModuleMigration,
   } = await initializeLinks({
-    config: linkModuleOptions,
+    config: linkModuleOrOptions,
     linkModules,
     injectedDependencies,
     moduleExports: isMedusaModule(linkModule) ? linkModule : undefined,
@@ -402,10 +404,38 @@ async function MedusaApp_({
     return await remoteQuery.query(query, variables, options)
   }
 
-  const applyMigration = async (linkModuleOptions, revert = false) => {
-    for (const moduleName of Object.keys(allModules)) {
-      const moduleResolution = MedusaModule.getModuleResolutions(moduleName)
+  const applyMigration = async ({
+    modulesNames,
+    revert = false,
+  }: {
+    modulesNames: string[]
+    revert?: boolean
+  }) => {
+    const moduleResolutions = modulesNames.map((moduleName) => {
+      return {
+        moduleName,
+        resolution: MedusaModule.getModuleResolutions(moduleName),
+      }
+    })
+
+    const missingModules = moduleResolutions
+      .filter(({ resolution }) => !resolution)
+      .map(({ moduleName }) => moduleName)
+
+    if (missingModules.length) {
+      const action = revert ? "revert" : "run"
+      const error = new MedusaError(
+        MedusaError.Types.UNKNOWN_MODULES,
+        `Cannot ${action} migrations for unknown module(s) ${missingModules.join(
+          ","
+        )}`,
+        MedusaError.Codes.UNKNOWN_MODULES
+      )
+      error["allModules"] = Object.keys(allModules)
+      throw error
+    }
 
+    for (const { resolution: moduleResolution } of moduleResolutions) {
       if (!moduleResolution.options?.database) {
         moduleResolution.options ??= {}
         moduleResolution.options.database = {
@@ -417,55 +447,73 @@ async function MedusaApp_({
         await MedusaModule.migrateDown(
           moduleResolution.definition.key,
           moduleResolution.resolutionPath as string,
+          sharedContainer,
           moduleResolution.options,
           moduleResolution.moduleExports
         )
       } else {
         await MedusaModule.migrateUp(
           moduleResolution.definition.key,
           moduleResolution.resolutionPath as string,
+          sharedContainer,
           moduleResolution.options,
           moduleResolution.moduleExports
         )
       }
     }
+  }
 
-    const linkModuleOpt = { ...(linkModuleOptions ?? {}) }
-    linkModuleOpt.database ??= {
-      ...(sharedResourcesConfig?.database ?? {}),
-    }
+  const runMigrations: RunMigrationFn = async (): Promise<void> => {
+    await applyMigration({
+      modulesNames: Object.keys(allModules),
+    })
 
-    if (revert) {
-      revertLinkModuleMigration &&
-        (await revertLinkModuleMigration(
-          {
-            options: linkModuleOpt,
-            injectedDependencies,
-          },
-          linkModules
-        ))
-    } else {
-      linkModuleMigration &&
-        (await linkModuleMigration(
-          {
-            options: linkModuleOpt,
-            injectedDependencies,
-          },
-          linkModules
-        ))
+    const options: Partial<ModuleServiceInitializeOptions> =
+      "scope" in linkModuleOrOptions
+        ? { ...linkModuleOrOptions.options }
+        : {
+            ...(linkModuleOrOptions as Partial<ModuleServiceInitializeOptions>),
+          }
+
+    options.database ??= {
+      ...sharedResourcesConfig?.database,
     }
-  }
 
-  const runMigrations: RunMigrationFn = async (
-    linkModuleOptions
-  ): Promise<void> => {
-    await applyMigration(linkModuleOptions)
+    await linkModuleMigration(
+      {
+        options,
+        injectedDependencies,
+      },
+      linkModules
+    )
   }
 
-  const revertMigrations: RunMigrationFn = async (
-    linkModuleOptions
+  const revertMigrations: RevertMigrationFn = async (
+    modulesNames
   ): Promise<void> => {
-    await applyMigration(linkModuleOptions, true)
+    await applyMigration({
+      modulesNames,
+      revert: true,
+    })
+
+    const options: Partial<ModuleServiceInitializeOptions> =
+      "scope" in linkModuleOrOptions
+        ? { ...linkModuleOrOptions.options }
+        : {
+            ...(linkModuleOrOptions as Partial<ModuleServiceInitializeOptions>),
+          }
+
+    options.database ??= {
+      ...sharedResourcesConfig?.database,
+    }
+
+    await revertLinkModuleMigration(
+      {
+        options,
+        injectedDependencies,
+      },
+      linkModules
+    )
   }
 
   return {
@@ -506,6 +554,7 @@ export async function MedusaAppMigrateUp(
 }
 
 export async function MedusaAppMigrateDown(
+  moduleNames: string[],
   options: MedusaAppOptions = {}
 ): Promise<void> {
   const migrationOnly = true
@@ -515,5 +564,5 @@ export async function MedusaAppMigrateDown(
     migrationOnly,
   })
 
-  await revertMigrations().finally(MedusaModule.clearInstances)
+  await revertMigrations(moduleNames).finally(MedusaModule.clearInstances)
 }
diff --git a/packages/core/modules-sdk/src/medusa-module.ts b/packages/core/modules-sdk/src/medusa-module.ts
@@ -12,6 +12,7 @@ import {
   ModuleResolution,
 } from "@medusajs/types"
 import {
+  ContainerRegistrationKeys,
   createMedusaContainer,
   promiseAll,
   simpleHash,
@@ -344,7 +345,9 @@ class MedusaModule {
     )
 
     const logger_ =
-      container.resolve("logger", { allowUnregistered: true }) ?? logger
+      container.resolve(ContainerRegistrationKeys.LOGGER, {
+        allowUnregistered: true,
+      }) ?? logger
 
     try {
       await moduleLoader({
@@ -475,7 +478,9 @@ class MedusaModule {
     )
 
     const logger_ =
-      container.resolve("logger", { allowUnregistered: true }) ?? logger
+      container.resolve(ContainerRegistrationKeys.LOGGER, {
+        allowUnregistered: true,
+      }) ?? logger
 
     try {
       await moduleLoader({
@@ -534,6 +539,7 @@ class MedusaModule {
   public static async migrateUp(
     moduleKey: string,
     modulePath: string,
+    container?: MedusaContainer,
     options?: Record<string, any>,
     moduleExports?: ModuleExports
   ): Promise<void> {
@@ -544,6 +550,11 @@ class MedusaModule {
       options,
     })
 
+    const logger_ =
+      container?.resolve(ContainerRegistrationKeys.LOGGER, {
+        allowUnregistered: true,
+      }) ?? logger
+
     for (const mod in moduleResolutions) {
       const [migrateUp] = await loadModuleMigrations(
         moduleResolutions[mod],
@@ -553,7 +564,7 @@ class MedusaModule {
       if (typeof migrateUp === "function") {
         await migrateUp({
           options,
-          logger,
+          logger: logger_,
         })
       }
     }
@@ -562,6 +573,7 @@ class MedusaModule {
   public static async migrateDown(
     moduleKey: string,
     modulePath: string,
+    container?: MedusaContainer,
     options?: Record<string, any>,
     moduleExports?: ModuleExports
   ): Promise<void> {
@@ -572,6 +584,11 @@ class MedusaModule {
       options,
     })
 
+    const logger_ =
+      container?.resolve(ContainerRegistrationKeys.LOGGER, {
+        allowUnregistered: true,
+      }) ?? logger
+
     for (const mod in moduleResolutions) {
       const [, migrateDown] = await loadModuleMigrations(
         moduleResolutions[mod],
@@ -581,7 +598,7 @@ class MedusaModule {
       if (typeof migrateDown === "function") {
         await migrateDown({
           options,
-          logger,
+          logger: logger_,
         })
       }
     }

diff --git a/packages/core/utils/src/common/errors.ts b/packages/core/utils/src/common/errors.ts
@@ -13,13 +13,15 @@ export const MedusaErrorTypes = {
   NOT_ALLOWED: "not_allowed",
   UNEXPECTED_STATE: "unexpected_state",
   CONFLICT: "conflict",
+  UNKNOWN_MODULES: "unknown_modules",
   PAYMENT_AUTHORIZATION_ERROR: "payment_authorization_error",
   PAYMENT_REQUIRES_MORE_ERROR: "payment_requires_more_error",
 }
 
 export const MedusaErrorCodes = {
   INSUFFICIENT_INVENTORY: "insufficient_inventory",
   CART_INCOMPATIBLE_STATE: "cart_incompatible_state",
+  UNKNOWN_MODULES: "unknown_modules",
 }
 
 /**