@vercel/microfrontends 2.2.0 → 2.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/microfrontends
 
+## 2.2.1
+
+### Patch Changes
+
+- d1e7cf7: Improve debug logging when inferring the microfrontends.json configuration when the MFE_DEBUG env var is set.
+
 ## 2.2.0
 
 ### Minor Changes

package/dist/bin/cli.cjs

@@ -30,7 +30,7 @@ var import_env = require("@next/env");
 // package.json
 var package_default = {
   name: "@vercel/microfrontends",
-  version: "2.2.0",
+  version: "2.2.1",
   private: false,
   description: "Defines configuration and utilities for microfrontends development",
   keywords: [
@@ -1117,6 +1117,28 @@ var import_node_fs2 = require("fs");
 var import_jsonc_parser2 = require("jsonc-parser");
 var import_fast_glob = __toESM(require("fast-glob"), 1);
 
+// src/bin/logger.ts
+function debug(...args) {
+  if (process.env.MFE_DEBUG) {
+    console.log(...args);
+  }
+}
+function info(...args) {
+  console.log(...args);
+}
+function warn(...args) {
+  console.warn(...args);
+}
+function error(...args) {
+  console.error(...args);
+}
+var logger = {
+  debug,
+  info,
+  warn,
+  error
+};
+
 // src/config/microfrontends/utils/get-config-file-name.ts
 var DEFAULT_CONFIGURATION_FILENAMES = [
   "microfrontends.json",
@@ -1146,6 +1168,10 @@ function findPackageWithMicrofrontendsConfig({
   customConfigFilename
 }) {
   const applicationName = applicationContext.name;
+  logger.debug(
+    "[MFE Config] Searching repository for configs containing application:",
+    applicationName
+  );
   try {
     const microfrontendsJsonPaths = import_fast_glob.default.globSync(
       `**/{${getPossibleConfigurationFilenames({ customConfigFilename }).join(",")}}`,
@@ -1157,6 +1183,11 @@ function findPackageWithMicrofrontendsConfig({
         ignore: ["**/node_modules/**", "**/.git/**"]
       }
     );
+    logger.debug(
+      "[MFE Config] Found",
+      microfrontendsJsonPaths.length,
+      "config file(s) in repository"
+    );
     const matchingPaths = [];
     for (const microfrontendsJsonPath of microfrontendsJsonPaths) {
       try {
@@ -1166,12 +1197,20 @@ function findPackageWithMicrofrontendsConfig({
         );
         const microfrontendsJson = (0, import_jsonc_parser2.parse)(microfrontendsJsonContent);
         if (microfrontendsJson.applications[applicationName]) {
+          logger.debug(
+            "[MFE Config] Found application in config:",
+            microfrontendsJsonPath
+          );
           matchingPaths.push(microfrontendsJsonPath);
         } else {
           for (const [_, app] of Object.entries(
             microfrontendsJson.applications
           )) {
             if (app.packageName === applicationName) {
+              logger.debug(
+                "[MFE Config] Found application via packageName in config:",
+                microfrontendsJsonPath
+              );
               matchingPaths.push(microfrontendsJsonPath);
             }
           }
@@ -1179,6 +1218,10 @@ function findPackageWithMicrofrontendsConfig({
       } catch (error2) {
       }
     }
+    logger.debug(
+      "[MFE Config] Total matching config files:",
+      matchingPaths.length
+    );
     if (matchingPaths.length > 1) {
       throw new MicrofrontendError(
         `Found multiple \`microfrontends.json\` files in the repository referencing the application "${applicationName}", but only one is allowed.
@@ -1238,30 +1281,6 @@ function inferMicrofrontendsLocation(opts) {
 // src/config/microfrontends/utils/is-monorepo.ts
 var import_node_fs3 = __toESM(require("fs"), 1);
 var import_node_path3 = __toESM(require("path"), 1);
-
-// src/bin/logger.ts
-function debug(...args) {
-  if (process.env.MFE_DEBUG) {
-    console.log(...args);
-  }
-}
-function info(...args) {
-  console.log(...args);
-}
-function warn(...args) {
-  console.warn(...args);
-}
-function error(...args) {
-  console.error(...args);
-}
-var logger = {
-  debug,
-  info,
-  warn,
-  error
-};
-
-// src/config/microfrontends/utils/is-monorepo.ts
 function isMonorepo({
   repositoryRoot
 }) {
@@ -1330,15 +1349,18 @@ var import_node_fs6 = __toESM(require("fs"), 1);
 var import_node_path6 = __toESM(require("path"), 1);
 function getApplicationContext(opts) {
   if (opts?.appName) {
+    logger.debug("[MFE Config] Application name from appName parameter:", opts.appName);
     return { name: opts.appName };
   }
   if (process.env.VERCEL_PROJECT_NAME) {
+    logger.debug("[MFE Config] Application name from VERCEL_PROJECT_NAME:", process.env.VERCEL_PROJECT_NAME);
     return {
       name: process.env.VERCEL_PROJECT_NAME,
       projectName: process.env.VERCEL_PROJECT_NAME
     };
   }
   if (process.env.NX_TASK_TARGET_PROJECT) {
+    logger.debug("[MFE Config] Application name from NX_TASK_TARGET_PROJECT:", process.env.NX_TASK_TARGET_PROJECT);
     return {
       name: process.env.NX_TASK_TARGET_PROJECT,
       packageJsonName: process.env.NX_TASK_TARGET_PROJECT
@@ -1351,6 +1373,7 @@ function getApplicationContext(opts) {
     );
     const projectJson = JSON.parse(vercelProjectJsonPath);
     if (projectJson.projectName) {
+      logger.debug("[MFE Config] Application name from .vercel/project.json:", projectJson.projectName);
       return {
         name: projectJson.projectName,
         projectName: projectJson.projectName
@@ -1374,6 +1397,7 @@ function getApplicationContext(opts) {
         }
       );
     }
+    logger.debug("[MFE Config] Application name from package.json:", packageJson.name);
     return { name: packageJson.name, packageJsonName: packageJson.name };
   } catch (err) {
     throw MicrofrontendError.handle(err, {
@@ -1745,7 +1769,13 @@ var MicrofrontendsServer = class {
     filePath,
     cookies
   } = {}) {
+    logger.debug("[MFE Config] Starting config inference", {
+      appName,
+      directory: directory || process.cwd(),
+      filePath
+    });
     if (filePath) {
+      logger.debug("[MFE Config] Using explicit filePath:", filePath);
       return MicrofrontendsServer.fromFile({
         filePath,
         cookies
@@ -1753,16 +1783,25 @@ var MicrofrontendsServer = class {
     }
     try {
       const packageRoot = findPackageRoot(directory);
+      logger.debug("[MFE Config] Package root:", packageRoot);
       const applicationContext = getApplicationContext({
         appName,
         packageRoot
       });
+      logger.debug("[MFE Config] Application context:", applicationContext);
       const customConfigFilename = process.env.VC_MICROFRONTENDS_CONFIG_FILE_NAME;
+      if (customConfigFilename) {
+        logger.debug(
+          "[MFE Config] Custom config filename from VC_MICROFRONTENDS_CONFIG_FILE_NAME:",
+          customConfigFilename
+        );
+      }
       const maybeConfig = findConfig({
         dir: packageRoot,
         customConfigFilename
       });
       if (maybeConfig) {
+        logger.debug("[MFE Config] Config found at package root:", maybeConfig);
         return MicrofrontendsServer.fromFile({
           filePath: maybeConfig,
           cookies
@@ -1770,42 +1809,78 @@ var MicrofrontendsServer = class {
       }
       const repositoryRoot = findRepositoryRoot();
       const isMonorepo2 = isMonorepo({ repositoryRoot });
+      logger.debug(
+        "[MFE Config] Repository root:",
+        repositoryRoot,
+        "Is monorepo:",
+        isMonorepo2
+      );
       const configFromEnv = process.env.VC_MICROFRONTENDS_CONFIG;
       if (typeof configFromEnv === "string") {
+        logger.debug(
+          "[MFE Config] Checking VC_MICROFRONTENDS_CONFIG:",
+          configFromEnv
+        );
         const maybeConfigFromEnv = (0, import_node_path8.resolve)(packageRoot, configFromEnv);
         if (maybeConfigFromEnv) {
+          logger.debug(
+            "[MFE Config] Config loaded from VC_MICROFRONTENDS_CONFIG:",
+            maybeConfigFromEnv
+          );
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromEnv,
             cookies
           });
         }
       } else {
+        const vercelDir = (0, import_node_path8.join)(packageRoot, ".vercel");
+        logger.debug(
+          "[MFE Config] Searching for config in .vercel directory:",
+          vercelDir
+        );
         const maybeConfigFromVercel = findConfig({
-          dir: (0, import_node_path8.join)(packageRoot, ".vercel"),
+          dir: vercelDir,
           customConfigFilename
         });
         if (maybeConfigFromVercel) {
+          logger.debug(
+            "[MFE Config] Config found in .vercel directory:",
+            maybeConfigFromVercel
+          );
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromVercel,
             cookies
           });
         }
         if (isMonorepo2) {
+          logger.debug(
+            "[MFE Config] Inferring microfrontends location in monorepo for application:",
+            applicationContext.name
+          );
           const defaultPackage = inferMicrofrontendsLocation({
             repositoryRoot,
             applicationContext,
             customConfigFilename
           });
+          logger.debug(
+            "[MFE Config] Inferred package location:",
+            defaultPackage
+          );
           const maybeConfigFromDefault = findConfig({
             dir: defaultPackage,
             customConfigFilename
           });
           if (maybeConfigFromDefault) {
+            logger.debug(
+              "[MFE Config] Config found in inferred package:",
+              maybeConfigFromDefault
+            );
             return MicrofrontendsServer.fromFile({
               filePath: maybeConfigFromDefault,
               cookies
             });
           }
+          logger.debug("[MFE Config] No config found in inferred package");
         }
       }
       throw new MicrofrontendError(
@@ -1831,8 +1906,13 @@ var MicrofrontendsServer = class {
     cookies
   }) {
     try {
+      logger.debug("[MFE Config] Reading config from file:", filePath);
       const configJson = import_node_fs7.default.readFileSync(filePath, "utf-8");
       const config = MicrofrontendsServer.validate(configJson);
+      logger.debug(
+        "[MFE Config] Config loaded with applications:",
+        Object.keys(config.applications)
+      );
       return new MicrofrontendsServer({
         config,
         overrides: cookies ? parseOverrides(cookies) : void 0
@@ -2890,6 +2970,7 @@ function loadConfig({
 
 // src/bin/port.ts
 function displayPort() {
+  delete process.env.MFE_DEBUG;
   const portInfo = mfePort((0, import_node_process.cwd)());
   header(portInfo);
   logger.info(portInfo.port);

package/dist/experimental/sveltekit.cjs

@@ -287,6 +287,10 @@ function findPackageWithMicrofrontendsConfig({
   customConfigFilename
 }) {
   const applicationName = applicationContext.name;
+  logger.debug(
+    "[MFE Config] Searching repository for configs containing application:",
+    applicationName
+  );
   try {
     const microfrontendsJsonPaths = import_fast_glob.default.globSync(
       `**/{${getPossibleConfigurationFilenames({ customConfigFilename }).join(",")}}`,
@@ -298,6 +302,11 @@ function findPackageWithMicrofrontendsConfig({
         ignore: ["**/node_modules/**", "**/.git/**"]
       }
     );
+    logger.debug(
+      "[MFE Config] Found",
+      microfrontendsJsonPaths.length,
+      "config file(s) in repository"
+    );
     const matchingPaths = [];
     for (const microfrontendsJsonPath of microfrontendsJsonPaths) {
       try {
@@ -307,12 +316,20 @@ function findPackageWithMicrofrontendsConfig({
         );
         const microfrontendsJson = (0, import_jsonc_parser.parse)(microfrontendsJsonContent);
         if (microfrontendsJson.applications[applicationName]) {
+          logger.debug(
+            "[MFE Config] Found application in config:",
+            microfrontendsJsonPath
+          );
           matchingPaths.push(microfrontendsJsonPath);
         } else {
           for (const [_, app] of Object.entries(
             microfrontendsJson.applications
           )) {
             if (app.packageName === applicationName) {
+              logger.debug(
+                "[MFE Config] Found application via packageName in config:",
+                microfrontendsJsonPath
+              );
               matchingPaths.push(microfrontendsJsonPath);
             }
           }
@@ -320,6 +337,10 @@ function findPackageWithMicrofrontendsConfig({
       } catch (error2) {
       }
     }
+    logger.debug(
+      "[MFE Config] Total matching config files:",
+      matchingPaths.length
+    );
     if (matchingPaths.length > 1) {
       throw new MicrofrontendError(
         `Found multiple \`microfrontends.json\` files in the repository referencing the application "${applicationName}", but only one is allowed.
@@ -1118,15 +1139,18 @@ var import_node_fs6 = __toESM(require("fs"), 1);
 var import_node_path6 = __toESM(require("path"), 1);
 function getApplicationContext(opts) {
   if (opts?.appName) {
+    logger.debug("[MFE Config] Application name from appName parameter:", opts.appName);
     return { name: opts.appName };
   }
   if (process.env.VERCEL_PROJECT_NAME) {
+    logger.debug("[MFE Config] Application name from VERCEL_PROJECT_NAME:", process.env.VERCEL_PROJECT_NAME);
     return {
       name: process.env.VERCEL_PROJECT_NAME,
       projectName: process.env.VERCEL_PROJECT_NAME
     };
   }
   if (process.env.NX_TASK_TARGET_PROJECT) {
+    logger.debug("[MFE Config] Application name from NX_TASK_TARGET_PROJECT:", process.env.NX_TASK_TARGET_PROJECT);
     return {
       name: process.env.NX_TASK_TARGET_PROJECT,
       packageJsonName: process.env.NX_TASK_TARGET_PROJECT
@@ -1139,6 +1163,7 @@ function getApplicationContext(opts) {
     );
     const projectJson = JSON.parse(vercelProjectJsonPath);
     if (projectJson.projectName) {
+      logger.debug("[MFE Config] Application name from .vercel/project.json:", projectJson.projectName);
       return {
         name: projectJson.projectName,
         projectName: projectJson.projectName
@@ -1162,6 +1187,7 @@ function getApplicationContext(opts) {
         }
       );
     }
+    logger.debug("[MFE Config] Application name from package.json:", packageJson.name);
     return { name: packageJson.name, packageJsonName: packageJson.name };
   } catch (err) {
     throw MicrofrontendError.handle(err, {
@@ -1533,7 +1559,13 @@ var MicrofrontendsServer = class {
     filePath,
     cookies
   } = {}) {
+    logger.debug("[MFE Config] Starting config inference", {
+      appName,
+      directory: directory || process.cwd(),
+      filePath
+    });
     if (filePath) {
+      logger.debug("[MFE Config] Using explicit filePath:", filePath);
       return MicrofrontendsServer.fromFile({
         filePath,
         cookies
@@ -1541,16 +1573,25 @@ var MicrofrontendsServer = class {
     }
     try {
       const packageRoot = findPackageRoot(directory);
+      logger.debug("[MFE Config] Package root:", packageRoot);
       const applicationContext = getApplicationContext({
         appName,
         packageRoot
       });
+      logger.debug("[MFE Config] Application context:", applicationContext);
       const customConfigFilename = process.env.VC_MICROFRONTENDS_CONFIG_FILE_NAME;
+      if (customConfigFilename) {
+        logger.debug(
+          "[MFE Config] Custom config filename from VC_MICROFRONTENDS_CONFIG_FILE_NAME:",
+          customConfigFilename
+        );
+      }
       const maybeConfig = findConfig({
         dir: packageRoot,
         customConfigFilename
       });
       if (maybeConfig) {
+        logger.debug("[MFE Config] Config found at package root:", maybeConfig);
         return MicrofrontendsServer.fromFile({
           filePath: maybeConfig,
           cookies
@@ -1558,42 +1599,78 @@ var MicrofrontendsServer = class {
       }
       const repositoryRoot = findRepositoryRoot();
       const isMonorepo2 = isMonorepo({ repositoryRoot });
+      logger.debug(
+        "[MFE Config] Repository root:",
+        repositoryRoot,
+        "Is monorepo:",
+        isMonorepo2
+      );
       const configFromEnv = process.env.VC_MICROFRONTENDS_CONFIG;
       if (typeof configFromEnv === "string") {
+        logger.debug(
+          "[MFE Config] Checking VC_MICROFRONTENDS_CONFIG:",
+          configFromEnv
+        );
         const maybeConfigFromEnv = (0, import_node_path8.resolve)(packageRoot, configFromEnv);
         if (maybeConfigFromEnv) {
+          logger.debug(
+            "[MFE Config] Config loaded from VC_MICROFRONTENDS_CONFIG:",
+            maybeConfigFromEnv
+          );
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromEnv,
             cookies
           });
         }
       } else {
+        const vercelDir = (0, import_node_path8.join)(packageRoot, ".vercel");
+        logger.debug(
+          "[MFE Config] Searching for config in .vercel directory:",
+          vercelDir
+        );
         const maybeConfigFromVercel = findConfig({
-          dir: (0, import_node_path8.join)(packageRoot, ".vercel"),
+          dir: vercelDir,
           customConfigFilename
         });
         if (maybeConfigFromVercel) {
+          logger.debug(
+            "[MFE Config] Config found in .vercel directory:",
+            maybeConfigFromVercel
+          );
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromVercel,
             cookies
           });
         }
         if (isMonorepo2) {
+          logger.debug(
+            "[MFE Config] Inferring microfrontends location in monorepo for application:",
+            applicationContext.name
+          );
           const defaultPackage = inferMicrofrontendsLocation({
             repositoryRoot,
             applicationContext,
             customConfigFilename
           });
+          logger.debug(
+            "[MFE Config] Inferred package location:",
+            defaultPackage
+          );
           const maybeConfigFromDefault = findConfig({
             dir: defaultPackage,
             customConfigFilename
           });
           if (maybeConfigFromDefault) {
+            logger.debug(
+              "[MFE Config] Config found in inferred package:",
+              maybeConfigFromDefault
+            );
             return MicrofrontendsServer.fromFile({
               filePath: maybeConfigFromDefault,
               cookies
             });
           }
+          logger.debug("[MFE Config] No config found in inferred package");
         }
       }
       throw new MicrofrontendError(
@@ -1619,8 +1696,13 @@ var MicrofrontendsServer = class {
     cookies
   }) {
     try {
+      logger.debug("[MFE Config] Reading config from file:", filePath);
       const configJson = import_node_fs7.default.readFileSync(filePath, "utf-8");
       const config = MicrofrontendsServer.validate(configJson);
+      logger.debug(
+        "[MFE Config] Config loaded with applications:",
+        Object.keys(config.applications)
+      );
       return new MicrofrontendsServer({
         config,
         overrides: cookies ? parseOverrides(cookies) : void 0