@vercel/microfrontends 0.19.4 → 0.19.6

package/dist/next/config.d.ts

@@ -1,6 +1,6 @@
 import { NextConfig } from 'next';
 
-type TransformKeys = 'assetPrefix' | 'draftMode' | 'headers' | 'rewrites' | 'serverActions' | 'webpack';
+type TransformKeys = 'assetPrefix' | 'draftMode' | 'redirects' | 'rewrites' | 'serverActions' | 'webpack';
 
 interface WithMicrofrontendsOptions {
     /**

package/dist/next/config.js

@@ -1588,13 +1588,13 @@ function transform(args) {
       next
     };
   }
-  if (next.assetPrefix !== void 0 && next.assetPrefix !== app.getAssetPrefix()) {
-    console.log(
-      `"assetPrefix" already set. This route must be manually configured in your microfrontend.json file.`
+  const assetPrefix = `/${app.getAssetPrefix()}`;
+  if (next.assetPrefix !== void 0 && next.assetPrefix !== assetPrefix) {
+    throw new Error(
+      `"assetPrefix" already set and does not equal "${assetPrefix}". Either omit the assetPrefix in your next config, or set it to "${assetPrefix}".`
     );
-  } else {
-    next.assetPrefix = `/${app.getAssetPrefix()}`;
   }
+  next.assetPrefix = assetPrefix;
   return {
     next
   };
@@ -1615,58 +1615,114 @@ function transform2(args) {
   };
 }
 
-// src/next/config/transforms/headers.ts
+// src/next/config/transforms/redirects.ts
 function transform3(args) {
-  const { next, app } = args;
-  if (app.isDefault()) {
-    return {
-      next
+  const { next, microfrontend, opts } = args;
+  const isProduction2 = opts?.isProduction ?? false;
+  const isDevEnv = (process.env.VERCEL_ENV ?? "development") === "development";
+  const requireLocalProxyHeader = !isProduction2 && isDevEnv && Boolean(process.env.TURBO_TASK_HAS_MFE_PROXY) && !process.env.MFE_DISABLE_LOCAL_PROXY_REWRITE;
+  if (requireLocalProxyHeader) {
+    const proxyRedirect = {
+      source: "/:path*",
+      destination: `http://localhost:${microfrontend.getLocalProxyPort()}/:path*`,
+      permanent: false,
+      missing: [{ type: "header", key: "x-vercel-mfe-local-proxy-origin" }]
     };
+    if (next.redirects && typeof next.redirects === "function") {
+      const originalRedirectsFn = next.redirects;
+      next.redirects = async () => {
+        const originalRedirects = await originalRedirectsFn();
+        return [proxyRedirect, ...originalRedirects];
+      };
+    } else {
+      next.redirects = async () => [proxyRedirect];
+    }
   }
-  const headersToAdd = [
-    {
-      source: "/:path*",
-      headers: [
-        {
-          key: "X-Vercel-Zone",
-          value: app.name
-        },
-        {
-          key: "X-Vercel-MFE-App",
-          value: app.name
+  return { next };
+}
+
+// src/next/config/transforms/rewrites.ts
+function debugRewrites(rewrites) {
+  if (process.env.MFE_DEBUG === "true") {
+    const indent = " ".repeat(4);
+    const header = "rewrites (source \u2192 destination)";
+    const separator = "\u23AF".repeat(header.length);
+    const maxSourceLength = Math.max(
+      ...rewrites.map((key) => key.source.length)
+    );
+    const table = rewrites.map((route, idx) => {
+      const paddedSource = route.source.padEnd(maxSourceLength);
+      return `${indent} ${idx + 1}. ${paddedSource} \u2192  ${route.destination}`;
+    }).join("\n");
+    console.log(`${indent}${header}
+${indent}${separator}
+${table}
+`);
+  }
+}
+function rewritesMapToArr(rewrites) {
+  return Array.from(rewrites.entries()).flatMap(([source, rewrite]) => {
+    const destination = `${rewrite.destination.domain || ""}${rewrite.destination.pathname}`;
+    if (source === destination)
+      return [];
+    return [
+      {
+        source,
+        destination
+      }
+    ];
+  });
+}
+function transform4(args) {
+  const { next, app } = args;
+  const buildBeforeFiles = () => {
+    const rewrites = /* @__PURE__ */ new Map();
+    if (!app.isDefault()) {
+      rewrites.set(`/${app.getAssetPrefix()}/_next/:path+`, {
+        destination: {
+          pathname: `/_next/:path+`
         }
-      ]
-    },
-    {
-      source: "/:path*",
-      has: [
-        {
-          type: "host",
-          value: "(?<host>.*)"
+      });
+      rewrites.set(`/${app.getAssetPrefix()}/.well-known/vercel/flags`, {
+        destination: {
+          pathname: `/.well-known/vercel/flags`
         }
-      ],
-      headers: [
-        {
-          // TODO: we may want to revisit before launch whether we want to expose this
-          // value on all responses publicly since users may not want to reveal this host
-          // (maybe just in preview? or when the user is logged in to the toolbar?)
-          key: "X-Vercel-Host",
-          value: ":host"
+      });
+      rewrites.set(`/${app.getAssetPrefix()}/_vercel/:path*`, {
+        destination: {
+          pathname: `/_vercel/:path*`
         }
-      ]
+      });
     }
-  ];
-  if (next.headers && typeof next.headers === "function") {
-    const originalHeadersFn = next.headers;
-    next.headers = async () => {
-      const originalHeaders = await originalHeadersFn();
-      return [...originalHeaders, ...headersToAdd];
+    return rewritesMapToArr(rewrites);
+  };
+  const newBeforeFiles = buildBeforeFiles();
+  if (next.rewrites && typeof next.rewrites === "function") {
+    const originalRewritesFn = next.rewrites;
+    next.rewrites = async () => {
+      const originalRewrites = await originalRewritesFn();
+      if (typeof originalRewrites === "object" && !Array.isArray(originalRewrites)) {
+        const { beforeFiles = [] } = originalRewrites;
+        return {
+          beforeFiles: [...newBeforeFiles, ...beforeFiles],
+          afterFiles: originalRewrites.afterFiles,
+          fallback: originalRewrites.fallback
+        };
+      }
+      return {
+        beforeFiles: newBeforeFiles,
+        afterFiles: originalRewrites,
+        fallback: []
+      };
     };
   } else {
-    next.headers = () => {
-      return Promise.resolve(headersToAdd);
-    };
+    next.rewrites = async () => ({
+      beforeFiles: newBeforeFiles,
+      afterFiles: [],
+      fallback: []
+    });
   }
+  debugRewrites(newBeforeFiles);
   return {
     next
   };
@@ -1755,138 +1811,6 @@ function getDomainForCurrentEnvironment(config, appName, opts = {}) {
   }
 }
 
-// src/next/config/transforms/rewrites.ts
-function debugRewrites(rewrites) {
-  if (process.env.MFE_DEBUG === "true") {
-    const indent = " ".repeat(4);
-    const header = "rewrites (source \u2192 destination)";
-    const separator = "\u23AF".repeat(header.length);
-    const maxSourceLength = Math.max(
-      ...rewrites.map((key) => key.source.length)
-    );
-    const table = rewrites.map((route, idx) => {
-      const paddedSource = route.source.padEnd(maxSourceLength);
-      return `${indent} ${idx + 1}. ${paddedSource} \u2192  ${route.destination}`;
-    }).join("\n");
-    console.log(`${indent}${header}
-${indent}${separator}
-${table}
-`);
-  }
-}
-function pathToRewrites(path5) {
-  const regex = /(?<base>^.+)\/:.+\*$/;
-  const match = regex.exec(path5);
-  const paths = [path5];
-  if (match?.groups?.base) {
-    paths.unshift(match.groups.base);
-  }
-  return paths;
-}
-function rewritesMapToArr(rewrites) {
-  return Array.from(rewrites.entries()).flatMap(([source, rewrite]) => {
-    const destination = `${rewrite.destination.domain || ""}${rewrite.destination.pathname}`;
-    if (source === destination)
-      return [];
-    return [
-      {
-        source,
-        destination,
-        missing: [
-          // if this header is present, the proxy has performed the rewrite.
-          // once the proxy routing is fully rolled out, this package should
-          // be updated to not perform any rewrites when deployed.
-          {
-            type: "header",
-            key: "x-vercel-mfe-host"
-          }
-        ]
-      }
-    ];
-  });
-}
-function transform4(args) {
-  const { next, microfrontend, app } = args;
-  const buildBeforeFiles = () => {
-    const rewrites = /* @__PURE__ */ new Map();
-    if (!app.isDefault()) {
-      rewrites.set(`/${app.getAssetPrefix()}/_next/:path+`, {
-        destination: {
-          pathname: `/_next/:path+`
-        }
-      });
-      rewrites.set(`/${app.getAssetPrefix()}/.well-known/vercel/flags`, {
-        destination: {
-          pathname: `/.well-known/vercel/flags`
-        }
-      });
-      if (process.env.VERCEL_MICROFRONTENDS_CONSOLIDATE_SPEED_INSIGHTS === "1") {
-        rewrites.set(`/${app.getAssetPrefix()}/_vercel/:path*`, {
-          destination: { pathname: "/_vercel/:path*" }
-        });
-      }
-    } else if (microfrontend instanceof MicrofrontendMainConfig) {
-      for (const [_, a] of Object.entries(
-        microfrontend.getChildApplications()
-      )) {
-        const { routing } = a;
-        const domain = getDomainForCurrentEnvironment(microfrontend, a.name);
-        rewrites.set(`/${a.getAssetPrefix()}/:path+`, {
-          destination: {
-            domain,
-            pathname: `/${a.getAssetPrefix()}/:path+`
-          }
-        });
-        for (const group of routing) {
-          if (group.flag) {
-            continue;
-          } else {
-            for (const source of group.paths) {
-              const paths = pathToRewrites(source);
-              for (const p of paths) {
-                rewrites.set(p, {
-                  destination: { domain, pathname: p }
-                });
-              }
-            }
-          }
-        }
-      }
-    }
-    return rewritesMapToArr(rewrites);
-  };
-  const newBeforeFiles = buildBeforeFiles();
-  if (next.rewrites && typeof next.rewrites === "function") {
-    const originalRewritesFn = next.rewrites;
-    next.rewrites = async () => {
-      const originalRewrites = await originalRewritesFn();
-      if (typeof originalRewrites === "object" && !Array.isArray(originalRewrites)) {
-        const { beforeFiles = [] } = originalRewrites;
-        return {
-          beforeFiles: [...newBeforeFiles, ...beforeFiles],
-          afterFiles: originalRewrites.afterFiles,
-          fallback: originalRewrites.fallback
-        };
-      }
-      return {
-        beforeFiles: newBeforeFiles,
-        afterFiles: originalRewrites,
-        fallback: []
-      };
-    };
-  } else {
-    next.rewrites = async () => ({
-      beforeFiles: newBeforeFiles,
-      afterFiles: [],
-      fallback: []
-    });
-  }
-  debugRewrites(newBeforeFiles);
-  return {
-    next
-  };
-}
-
 // src/next/config/transforms/server-actions.ts
 function debugRewrites2(allowedOrigins) {
   if (process.env.MFE_DEBUG === "true" && allowedOrigins) {
@@ -2008,7 +1932,7 @@ function transform6(args) {
 var transforms = {
   assetPrefix: transform,
   draftMode: transform2,
-  headers: transform3,
+  redirects: transform3,
   rewrites: transform4,
   serverActions: transform5,
   webpack: transform6
@@ -2040,9 +1964,9 @@ function setEnvironment({
     NEXT_PUBLIC_MFE_CLIENT_CONFIG: JSON.stringify(
       microfrontends.config.toClientConfig().serialize()
     ),
-    ...process.env.ROUTE_OBSERVABILITY_TO_DEFAULT_APP || !app.getAssetPrefix() ? {} : {
+    ...process.env.ROUTE_OBSERVABILITY_TO_THIS_PROJECT && app.getAssetPrefix() ? {
       NEXT_PUBLIC_VERCEL_OBSERVABILITY_BASEPATH: `/${app.getAssetPrefix()}/_vercel`
-    }
+    } : {}
   };
   const serverEnvs = {
     MFE_CURRENT_APPLICATION: app.name,