@netlify/plugin-nextjs 4.0.0-beta.7 → 4.0.0-beta.8

package/lib/helpers/files.js

@@ -1,15 +1,39 @@
 //  @ts-check
 const { cpus } = require('os');
+const { yellowBright } = require('chalk');
 const { existsSync, readJson, move, cpSync, copy, writeJson } = require('fs-extra');
 const globby = require('globby');
+const { outdent } = require('outdent');
 const pLimit = require('p-limit');
 const { join } = require('pathe');
 const slash = require('slash');
 const TEST_ROUTE = /(|\/)\[[^/]+?](\/|\.html|$)/;
 const isDynamicRoute = (route) => TEST_ROUTE.test(route);
-exports.moveStaticPages = async ({ netlifyConfig, target, i18n, failBuild }) => {
+const stripLocale = (rawPath, locales = []) => {
+    const [locale, ...segments] = rawPath.split('/');
+    if (locales.includes(locale)) {
+        return segments.join('/');
+    }
+    return rawPath;
+};
+const matchMiddleware = (middleware, filePath) => middleware.includes('') ||
+    (middleware === null || middleware === void 0 ? void 0 : middleware.find((middlewarePath) => filePath === middlewarePath || filePath === `${middlewarePath}.html` || filePath.startsWith(`${middlewarePath}/`)));
+exports.matchMiddleware = matchMiddleware;
+exports.stripLocale = stripLocale;
+exports.isDynamicRoute = isDynamicRoute;
+exports.moveStaticPages = async ({ netlifyConfig, target, i18n }) => {
     console.log('Moving static page files to serve from CDN...');
-    const root = join(netlifyConfig.build.publish, target === 'server' ? 'server' : 'serverless', 'pages');
+    const outputDir = join(netlifyConfig.build.publish, target === 'server' ? 'server' : 'serverless');
+    const root = join(outputDir, 'pages');
+    // Load the middleware manifest so we can check if a file matches it before moving
+    let middleware;
+    const manifestPath = join(outputDir, 'middleware-manifest.json');
+    if (existsSync(manifestPath)) {
+        const manifest = await readJson(manifestPath);
+        if (manifest === null || manifest === void 0 ? void 0 : manifest.middleware) {
+            middleware = Object.keys(manifest.middleware).map((path) => path.slice(1));
+        }
+    }
     const files = [];
     const moveFile = async (file) => {
         const source = join(root, file);
@@ -22,6 +46,8 @@ exports.moveStaticPages = async ({ netlifyConfig, target, i18n, failBuild }) =>
         cwd: root,
         dot: true,
     });
+    const matchingMiddleware = new Set();
+    const matchedPages = new Set();
     // Limit concurrent file moves to number of cpus or 2 if there is only 1
     const limit = pLimit(Math.max(2, cpus().length));
     const promises = pages.map(async (rawPath) => {
@@ -29,10 +55,37 @@ exports.moveStaticPages = async ({ netlifyConfig, target, i18n, failBuild }) =>
         if (isDynamicRoute(filePath)) {
             return;
         }
+        // Middleware matches against the unlocalised path
+        const unlocalizedPath = stripLocale(rawPath, i18n === null || i18n === void 0 ? void 0 : i18n.locales);
+        const middlewarePath = matchMiddleware(middleware, unlocalizedPath);
+        // If a file matches middleware it can't be offloaded to the CDN, and needs to stay at the origin to be served by next/server
+        if (middlewarePath) {
+            matchingMiddleware.add(middlewarePath);
+            matchedPages.add(rawPath);
+            return;
+        }
         return limit(moveFile, filePath);
     });
     await Promise.all(promises);
     console.log(`Moved ${files.length} files`);
+    if (matchedPages.size !== 0) {
+        console.log(yellowBright(outdent `
+        Skipped moving ${matchedPages.size} ${matchedPages.size === 1 ? 'file because it matches' : 'files because they match'} middleware, so cannot be deployed to the CDN and will be served from the origin instead. This is fine, but we're letting you know because it may not be what you expect.
+      `));
+        console.log(outdent `
+        The following middleware matched statically-rendered pages:
+
+        ${yellowBright([...matchingMiddleware].map((mid) => `- /${mid}/_middleware`).join('\n'))}
+      `);
+        // There could potentially be thousands of matching pages, so we don't want to spam the console with this
+        if (matchedPages.size < 50) {
+            console.log(outdent `
+          The following files matched middleware and were not moved to the CDN:
+
+          ${yellowBright([...matchedPages].map((mid) => `- ${mid}`).join('\n'))}
+        `);
+        }
+    }
     // Write the manifest for use in the serverless functions
     await writeJson(join(netlifyConfig.build.publish, 'static-manifest.json'), files);
     if (i18n === null || i18n === void 0 ? void 0 : i18n.defaultLocale) {

package/lib/helpers/verification.js

@@ -21,15 +21,14 @@ exports.checkForOldFunctions = async ({ functions }) => {
     const oldFunctions = (await functions.list()).filter(({ name }) => name.startsWith('next_'));
     if (oldFunctions.length !== 0) {
         console.log(yellowBright(outdent `
-      We have found the following functions in your site that seem to be left over from the old Next.js plugin (v3). We have guessed this because the name starts with "next_".
+        We have found the following functions in your site that seem to be left over from the old Next.js plugin (v3). We have guessed this because the name starts with "next_".
 
-      ${reset(oldFunctions.map(({ name }) => `- ${name}`).join('\n'))}
+        ${reset(oldFunctions.map(({ name }) => `- ${name}`).join('\n'))}
 
-      If they were created by the old plugin, these functions are likely to cause errors so should be removed. You can do this by deleting the following directories:
+        If they were created by the old plugin, these functions are likely to cause errors so should be removed. You can do this by deleting the following directories:
 
-      ${reset(oldFunctions.map(({ mainFile }) => `- ${path.relative(process.cwd(), path.dirname(mainFile))}`).join('\n'))}
-
-    `));
+        ${reset(oldFunctions.map(({ mainFile }) => `- ${path.relative(process.cwd(), path.dirname(mainFile))}`).join('\n'))}
+      `));
     }
 };
 exports.checkNextSiteHasBuilt = ({ publish, failBuild }) => {
@@ -38,20 +37,22 @@ exports.checkNextSiteHasBuilt = ({ publish, failBuild }) => {
       The directory "${path.relative(process.cwd(), publish)}" does not contain a Next.js production build. Perhaps the build command was not run, or you specified the wrong publish directory. 
       In most cases it should be set to the site's ".next" directory path, unless you have chosen a custom "distDir" in your Next config. 
       If you are using "next export" then the Essential Next.js plugin should be removed. See https://ntl.fyi/remove-plugin for details.
-      `);
+    `);
     }
     if (existsSync(path.join(publish, 'export-detail.json'))) {
         failBuild(outdent `
       Detected that "next export" was run, but site is incorrectly publishing the ".next" directory.
       This plugin is not needed for "next export" so should be removed, and publish directory set to "out".
-      See https://ntl.fyi/remove-plugin for more details on how to remove this plugin.`);
+      See https://ntl.fyi/remove-plugin for more details on how to remove this plugin.
+    `);
     }
 };
 exports.checkForRootPublish = ({ publish, failBuild }) => {
     if (path.resolve(publish) === path.resolve('.')) {
         failBuild(outdent `
       Your publish directory is pointing to the base directory of your site. This is not supported for Next.js sites, and is probably a mistake. 
-      In most cases it should be set to ".next", unless you have chosen a custom "distDir" in your Next config, or the Next site is in a subdirectory.`);
+      In most cases it should be set to ".next", unless you have chosen a custom "distDir" in your Next config, or the Next site is in a subdirectory.
+    `);
     }
 };
 // 50MB, which is the documented max, though the hard max seems to be higher
@@ -67,11 +68,9 @@ exports.checkZipSize = async (file, maxSize = LAMBDA_MAX_SIZE) => {
     }
     // We don't fail the build, because the actual hard max size is larger so it might still succeed
     console.log(redBright(outdent `
-
-    The function zip ${yellowBright(relative(process.cwd(), file))} size is ${prettyBytes(size)}, which is larger than the maximum supported size of ${prettyBytes(maxSize)}.
-    There are a few reasons this could happen. You may have accidentally bundled a large dependency, or you might have a
-    large number of pre-rendered pages included.
-  
+      The function zip ${yellowBright(relative(process.cwd(), file))} size is ${prettyBytes(size)}, which is larger than the maximum supported size of ${prettyBytes(maxSize)}.
+      There are a few reasons this could happen. You may have accidentally bundled a large dependency, or you might have a
+      large number of pre-rendered pages included.
     `));
     const zip = new StreamZip({ file });
     console.log(`Contains ${await zip.entriesCount} files`);

package/lib/index.js

@@ -27,6 +27,9 @@ module.exports = {
         await generatePagesResolver({ netlifyConfig, target, constants });
         await movePublicFiles({ appDir, publish });
         if (process.env.EXPERIMENTAL_MOVE_STATIC_PAGES) {
+            console.log("The flag 'EXPERIMENTAL_MOVE_STATIC_PAGES' is no longer required, as it is now the default. To disable this behavior, set the env var 'SERVE_STATIC_FILES_FROM_ORIGIN' to 'true'");
+        }
+        if (!process.env.SERVE_STATIC_FILES_FROM_ORIGIN) {
             await moveStaticPages({ target, failBuild, netlifyConfig, i18n });
         }
         await setupImageFunction({ constants, imageconfig: images, netlifyConfig, basePath });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.8",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -72,8 +72,8 @@
   "devDependencies": {
     "@babel/core": "^7.15.8",
     "@babel/preset-env": "^7.15.8",
-    "@netlify/build": "^18.23.0",
-    "@netlify/eslint-config-node": "^3.3.0",
+    "@netlify/build": "^18.25.1",
+    "@netlify/eslint-config-node": "^3.3.7",
     "@testing-library/cypress": "^8.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.0.2",