@vercel/microfrontends 1.5.0 → 2.0.0-canary.0

package/dist/microfrontends/server.cjs

@@ -232,8 +232,9 @@ var CONFIGURATION_FILENAMES = [
 var configCache = {};
 function findPackageWithMicrofrontendsConfig({
   repositoryRoot,
-  applicationName
+  applicationContext
 }) {
+  const applicationName = applicationContext.name;
   try {
     const microfrontendsJsonPaths = import_fast_glob.default.globSync(
       `**/{${CONFIGURATION_FILENAMES.join(",")}}`,
@@ -275,26 +276,45 @@ ${matchingPaths.join("\n  \u2022 ")}`,
       );
     }
     if (matchingPaths.length === 0) {
+      let additionalErrorMessage = "";
+      if (microfrontendsJsonPaths.length > 0) {
+        if (!applicationContext.projectName) {
+          additionalErrorMessage = `
+
+If the name in package.json (${applicationContext.packageJsonName}) differs from your Vercel Project name, set the \`packageName\` field for the application in \`microfrontends.json\` to ensure that the configuration can be found locally.`;
+        } else {
+          additionalErrorMessage = `
+
+Names of applications in \`microfrontends.json\` must match the Vercel Project name (${applicationContext.projectName}).`;
+        }
+      }
       throw new MicrofrontendError(
-        `Could not find a \`microfrontends.json\` file in the repository that contains "applications.${applicationName}". If your Vercel Microfrontends configuration is not in this repository, you can use the Vercel CLI to pull the Vercel Microfrontends configuration using the "vercel microfrontends pull" command, or you can specify the path manually using the VC_MICROFRONTENDS_CONFIG environment variable. If you suspect this is thrown in error, please reach out to the Vercel team.`,
+        `Could not find a \`microfrontends.json\` file in the repository that contains the "${applicationName}" application.${additionalErrorMessage}
+
+If your Vercel Microfrontends configuration is not in this repository, you can use the Vercel CLI to pull the Vercel Microfrontends configuration using the "vercel microfrontends pull" command, or you can specify the path manually using the VC_MICROFRONTENDS_CONFIG environment variable.
+
+If you suspect this is thrown in error, please reach out to the Vercel team.`,
         { type: "config", subtype: "inference_failed" }
       );
     }
     const [packageJsonPath] = matchingPaths;
     return (0, import_node_path2.dirname)(packageJsonPath);
   } catch (error) {
+    if (error instanceof MicrofrontendError) {
+      throw error;
+    }
     return null;
   }
 }
 function inferMicrofrontendsLocation(opts) {
-  const cacheKey = `${opts.repositoryRoot}-${opts.applicationName}`;
+  const cacheKey = `${opts.repositoryRoot}-${opts.applicationContext.name}`;
   if (configCache[cacheKey]) {
     return configCache[cacheKey];
   }
   const result = findPackageWithMicrofrontendsConfig(opts);
   if (!result) {
     throw new MicrofrontendError(
-      `Could not infer the location of the \`microfrontends.json\` file for application "${opts.applicationName}" starting in directory "${opts.repositoryRoot}".`,
+      `Could not infer the location of the \`microfrontends.json\` file for application "${opts.applicationContext.name}" starting in directory "${opts.repositoryRoot}".`,
       { type: "config", subtype: "inference_failed" }
     );
   }
@@ -366,90 +386,13 @@ function findConfig({ dir }) {
 // src/config/microfrontends-config/isomorphic/index.ts
 var import_jsonc_parser2 = require("jsonc-parser");
 
-// src/config/microfrontends-config/client/index.ts
-var import_path_to_regexp = require("path-to-regexp");
-var regexpCache = /* @__PURE__ */ new Map();
-var getRegexp = (path6) => {
-  const existing = regexpCache.get(path6);
-  if (existing) {
-    return existing;
-  }
-  const regexp = (0, import_path_to_regexp.pathToRegexp)(path6);
-  regexpCache.set(path6, regexp);
-  return regexp;
-};
-var MicrofrontendConfigClient = class {
-  constructor(config, opts) {
-    this.pathCache = {};
-    this.serialized = config;
-    if (opts?.removeFlaggedPaths) {
-      for (const app of Object.values(config.applications)) {
-        if (app.routing) {
-          app.routing = app.routing.filter((match) => !match.flag);
-        }
-      }
-    }
-    this.applications = config.applications;
-  }
-  /**
-   * Create a new `MicrofrontendConfigClient` from a JSON string.
-   * Config must be passed in to remain framework agnostic
-   */
-  static fromEnv(config, opts) {
-    if (!config) {
-      throw new Error(
-        "Could not construct MicrofrontendConfigClient: configuration is empty or undefined. Did you set up your application with `withMicrofrontends`?"
-      );
-    }
-    return new MicrofrontendConfigClient(
-      JSON.parse(config),
-      opts
-    );
-  }
-  isEqual(other) {
-    return this === other || JSON.stringify(this.applications) === JSON.stringify(other.applications);
-  }
-  getApplicationNameForPath(path6) {
-    if (!path6.startsWith("/")) {
-      throw new Error(`Path must start with a /`);
-    }
-    if (this.pathCache[path6]) {
-      return this.pathCache[path6];
-    }
-    const pathname = new URL(path6, "https://example.com").pathname;
-    for (const [name, application] of Object.entries(this.applications)) {
-      if (application.routing) {
-        for (const group of application.routing) {
-          for (const childPath of group.paths) {
-            const regexp = getRegexp(childPath);
-            if (regexp.test(pathname)) {
-              this.pathCache[path6] = name;
-              return name;
-            }
-          }
-        }
-      }
-    }
-    const defaultApplication = Object.entries(this.applications).find(
-      ([, application]) => application.default
-    );
-    if (!defaultApplication) {
-      return null;
-    }
-    this.pathCache[path6] = defaultApplication[0];
-    return defaultApplication[0];
-  }
-  serialize() {
-    return this.serialized;
-  }
-};
-
 // src/config/microfrontends-config/isomorphic/validation.ts
-var import_path_to_regexp2 = require("path-to-regexp");
+var import_path_to_regexp = require("path-to-regexp");
 var LIST_FORMATTER = new Intl.ListFormat("en", {
   style: "long",
   type: "conjunction"
 });
+var VALID_ASSET_PREFIX_REGEXP = /^[a-z](?:[a-z0-9-]*[a-z0-9])?$/;
 var validateConfigPaths = (applicationConfigsById) => {
   if (!applicationConfigsById) {
     return;
@@ -472,7 +415,7 @@ var validateConfigPaths = (applicationConfigsById) => {
           } else {
             pathsByApplicationId.set(path6, {
               applications: [id],
-              matcher: (0, import_path_to_regexp2.pathToRegexp)(path6),
+              matcher: (0, import_path_to_regexp.pathToRegexp)(path6),
               applicationId: id
             });
           }
@@ -519,7 +462,7 @@ var validateConfigPaths = (applicationConfigsById) => {
 var PATH_DEFAULT_PATTERN = "[^\\/#\\?]+?";
 function validatePathExpression(path6) {
   try {
-    const tokens = (0, import_path_to_regexp2.parse)(path6);
+    const tokens = (0, import_path_to_regexp.parse)(path6);
     if (/(?<!\\)\{/.test(path6)) {
       return `Optional paths are not supported: ${path6}`;
     }
@@ -576,6 +519,22 @@ var validateAppPaths = (name, app) => {
       }
     }
   }
+  if (app.assetPrefix) {
+    if (!VALID_ASSET_PREFIX_REGEXP.test(app.assetPrefix)) {
+      throw new MicrofrontendError(
+        `Invalid asset prefix for application "${name}". ${app.assetPrefix} must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens.`,
+        { type: "application", subtype: "invalid_asset_prefix" }
+      );
+    }
+    if (app.assetPrefix !== `vc-ap-${name}` && !app.routing.some(
+      (group) => group.paths.includes(`/${app.assetPrefix}/:path*`) && !group.flag
+    )) {
+      throw new MicrofrontendError(
+        `When \`assetPrefix\` is specified, \`/${app.assetPrefix}/:path*\` must be added the routing paths for the application. Changing the asset prefix is not a forwards and backwards compatible change, and the custom asset prefix should be added to \`paths\` and deployed before setting the \`assetPrefix\` field.`,
+        { type: "application", subtype: "invalid_asset_prefix" }
+      );
+    }
+  }
 };
 var validateConfigDefaultApplication = (applicationConfigsById) => {
   if (!applicationConfigsById) {
@@ -607,6 +566,15 @@ var validateConfigDefaultApplication = (applicationConfigsById) => {
   }
 };
 
+// src/config/microfrontends-config/isomorphic/utils/hash-application-name.ts
+var import_md5 = __toESM(require("md5"), 1);
+function hashApplicationName(name) {
+  if (!name) {
+    throw new Error("Application name is required to generate hash");
+  }
+  return (0, import_md5.default)(name).substring(0, 6).padStart(6, "0");
+}
+
 // src/config/microfrontends-config/isomorphic/utils/generate-asset-prefix.ts
 var PREFIX = "vc-ap";
 function generateAssetPrefixFromName({
@@ -615,7 +583,7 @@ function generateAssetPrefixFromName({
   if (!name) {
     throw new Error("Name is required to generate an asset prefix");
   }
-  return `${PREFIX}-${name}`;
+  return `${PREFIX}-${hashApplicationName(name)}`;
 }
 
 // src/config/microfrontends-config/isomorphic/utils/generate-port.ts
@@ -775,7 +743,13 @@ var Application = class {
     return this.default;
   }
   getAssetPrefix() {
-    return generateAssetPrefixFromName({ name: this.name });
+    const generatedAssetPrefix = generateAssetPrefixFromName({
+      name: this.name
+    });
+    if ("assetPrefix" in this.serialized) {
+      return this.serialized.assetPrefix ?? generatedAssetPrefix;
+    }
+    return generatedAssetPrefix;
   }
   getAutomationBypassEnvVarName() {
     return generateAutomationBypassEnvVarName({ name: this.name });
@@ -909,7 +883,7 @@ var MicrofrontendConfigIsomorphic = class {
     );
     if (!app) {
       throw new MicrofrontendError(
-        `Could not find microfrontends configuration for application "${name}"`,
+        `Could not find microfrontends configuration for application "${name}". If the name in package.json differs from your Vercel Project name, set the \`packageName\` field for the application in \`microfrontends.json\` to ensure that the configuration can be found locally.`,
         {
           type: "application",
           subtype: "not_found"
@@ -954,23 +928,6 @@ var MicrofrontendConfigIsomorphic = class {
   toSchemaJson() {
     return this.serialized.config;
   }
-  toClientConfig() {
-    const applications = Object.fromEntries(
-      Object.entries(this.childApplications).map(([name, application]) => [
-        name,
-        {
-          default: false,
-          routing: application.routing
-        }
-      ])
-    );
-    applications[this.defaultApplication.name] = {
-      default: true
-    };
-    return new MicrofrontendConfigClient({
-      applications
-    });
-  }
   serialize() {
     return this.serialized;
   }
@@ -983,8 +940,31 @@ function getApplicationContext(opts) {
   if (opts?.appName) {
     return { name: opts.appName };
   }
+  if (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) {
-    return { name: process.env.NX_TASK_TARGET_PROJECT };
+    return {
+      name: process.env.NX_TASK_TARGET_PROJECT,
+      packageJsonName: process.env.NX_TASK_TARGET_PROJECT
+    };
+  }
+  try {
+    const vercelProjectJsonPath = import_node_fs6.default.readFileSync(
+      import_node_path6.default.join(opts?.packageRoot || ".", ".vercel", "project.json"),
+      "utf-8"
+    );
+    const projectJson = JSON.parse(vercelProjectJsonPath);
+    if (projectJson.projectName) {
+      return {
+        name: projectJson.projectName,
+        projectName: projectJson.projectName
+      };
+    }
+  } catch (_) {
   }
   try {
     const packageJsonString = import_node_fs6.default.readFileSync(
@@ -1002,7 +982,7 @@ function getApplicationContext(opts) {
         }
       );
     }
-    return { name: packageJson.name };
+    return { name: packageJson.name, packageJsonName: packageJson.name };
   } catch (err) {
     throw MicrofrontendError.handle(err, {
       fileName: "package.json"
@@ -1142,6 +1122,10 @@ var schema_default = {
         routing: {
           $ref: "#/definitions/Routing",
           description: "Groups of path expressions that are routed to this application."
+        },
+        assetPrefix: {
+          type: "string",
+          description: "The name of the asset prefix to use instead of the auto-generated name.\n\nThe asset prefix is used to prefix all paths to static assets, such as JS, CSS, or images that are served by a specific application. It is necessary to ensure there are no conflicts with other applications on the same domain.\n\nAn auto-generated asset prefix of the form `vc-ap-<hash>` is used when this field is not provided.\n\nWhen this field is provided, `/${assetPrefix}/:path*` must also be added to the list of paths in the `routing` field. Changing the asset prefix after a microfrontend application has already been deployed is not a forwards and backwards compatible change, and the asset prefix should be added to the `routing` field and deployed before setting the `assetPrefix` field."
         }
       },
       required: [
@@ -1367,7 +1351,7 @@ var MicrofrontendsServer = class {
     }
     try {
       const packageRoot = findPackageRoot(directory);
-      const { name: appName } = getApplicationContext({ packageRoot });
+      const applicationContext = getApplicationContext({ packageRoot });
       const maybeConfig = findConfig({ dir: packageRoot });
       if (maybeConfig) {
         return MicrofrontendsServer.fromFile({
@@ -1401,7 +1385,7 @@ var MicrofrontendsServer = class {
         if (isMonorepo2) {
           const defaultPackage = inferMicrofrontendsLocation({
             repositoryRoot,
-            applicationName: appName
+            applicationContext
           });
           const maybeConfigFromDefault = findConfig({ dir: defaultPackage });
           if (maybeConfigFromDefault) {