@netlify/plugin-nextjs 4.2.1 → 4.2.5

package/lib/helpers/files.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.movePublicFiles = exports.unpatchNextFiles = exports.patchNextFiles = exports.moveStaticPages = exports.matchesRewrite = exports.matchesRedirect = exports.matchMiddleware = exports.stripLocale = exports.isDynamicRoute = void 0;
+exports.movePublicFiles = exports.unpatchNextFiles = exports.patchNextFiles = exports.moveStaticPages = exports.getMiddleware = exports.matchesRewrite = exports.matchesRedirect = exports.matchMiddleware = exports.stripLocale = exports.isDynamicRoute = void 0;
 /* eslint-disable max-lines */
 const os_1 = require("os");
 const chalk_1 = require("chalk");
@@ -14,6 +14,7 @@ const p_limit_1 = __importDefault(require("p-limit"));
 const pathe_1 = require("pathe");
 const slash_1 = __importDefault(require("slash"));
 const constants_1 = require("../constants");
+const utils_1 = require("./utils");
 const TEST_ROUTE = /(|\/)\[[^/]+?](\/|\.html|$)/;
 const isDynamicRoute = (route) => TEST_ROUTE.test(route);
 exports.isDynamicRoute = isDynamicRoute;
@@ -51,6 +52,16 @@ const matchesRewrite = (file, rewrites) => {
     return (0, exports.matchesRedirect)(file, rewrites.beforeFiles);
 };
 exports.matchesRewrite = matchesRewrite;
+const getMiddleware = async (publish) => {
+    var _a;
+    const manifestPath = (0, pathe_1.join)(publish, 'server', 'middleware-manifest.json');
+    if ((0, fs_extra_1.existsSync)(manifestPath)) {
+        const manifest = await (0, fs_extra_1.readJson)(manifestPath, { throws: false });
+        return (_a = manifest === null || manifest === void 0 ? void 0 : manifest.sortedMiddleware) !== null && _a !== void 0 ? _a : [];
+    }
+    return [];
+};
+exports.getMiddleware = getMiddleware;
 // eslint-disable-next-line max-lines-per-function
 const moveStaticPages = async ({ netlifyConfig, target, i18n, }) => {
     console.log('Moving static page files to serve from CDN...');
@@ -60,14 +71,8 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, }) => {
     const dataDir = (0, pathe_1.join)('_next', 'data', buildId);
     await (0, fs_extra_1.ensureDir)(dataDir);
     // Load the middleware manifest so we can check if a file matches it before moving
-    let middleware;
-    const manifestPath = (0, pathe_1.join)(outputDir, 'middleware-manifest.json');
-    if ((0, fs_extra_1.existsSync)(manifestPath)) {
-        const manifest = await (0, fs_extra_1.readJson)(manifestPath);
-        if (manifest === null || manifest === void 0 ? void 0 : manifest.middleware) {
-            middleware = Object.keys(manifest.middleware).map((path) => path.slice(1));
-        }
-    }
+    const middlewarePaths = await (0, exports.getMiddleware)(netlifyConfig.build.publish);
+    const middleware = middlewarePaths.map((path) => path.slice(1));
     const prerenderManifest = await (0, fs_extra_1.readJson)((0, pathe_1.join)(netlifyConfig.build.publish, 'prerender-manifest.json'));
     const { redirects, rewrites } = await (0, fs_extra_1.readJson)((0, pathe_1.join)(netlifyConfig.build.publish, 'routes-manifest.json'));
     const isrFiles = new Set();
@@ -216,47 +221,52 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, }) => {
     }
 };
 exports.moveStaticPages = moveStaticPages;
+/**
+ * Attempt to patch a source file, preserving a backup
+ */
 const patchFile = async ({ file, from, to }) => {
     if (!(0, fs_extra_1.existsSync)(file)) {
-        return;
+        console.warn('File was not found');
+        return false;
     }
     const content = await (0, fs_extra_1.readFile)(file, 'utf8');
     if (content.includes(to)) {
-        return;
+        console.log('File already patched');
+        return false;
     }
     const newContent = content.replace(from, to);
+    if (newContent === content) {
+        console.warn('File was not changed');
+        return false;
+    }
     await (0, fs_extra_1.writeFile)(`${file}.orig`, content);
     await (0, fs_extra_1.writeFile)(file, newContent);
+    console.log('Done');
+    return true;
 };
+/**
+ * The file we need has moved around a bit over the past few versions,
+ * so we iterate through the options until we find it
+ */
 const getServerFile = (root) => {
-    let serverFile;
-    try {
-        serverFile = require.resolve('next/dist/server/next-server', { paths: [root] });
-    }
-    catch {
-        // Ignore
-    }
-    if (!serverFile) {
-        try {
-            // eslint-disable-next-line node/no-missing-require
-            serverFile = require.resolve('next/dist/next-server/server/next-server', { paths: [root] });
-        }
-        catch {
-            // Ignore
-        }
-    }
-    return serverFile;
+    const candidates = [
+        'next/dist/server/base-server',
+        'next/dist/server/next-server',
+        'next/dist/next-server/server/next-server',
+    ];
+    return (0, utils_1.findModuleFromBase)({ candidates, paths: [root] });
 };
-const patchNextFiles = async (root) => {
+const patchNextFiles = (root) => {
     const serverFile = getServerFile(root);
     console.log(`Patching ${serverFile}`);
     if (serverFile) {
-        await patchFile({
+        return patchFile({
             file: serverFile,
             from: `let ssgCacheKey = `,
             to: `let ssgCacheKey = process.env._BYPASS_SSG || `,
         });
     }
+    return false;
 };
 exports.patchNextFiles = patchNextFiles;
 const unpatchNextFiles = async (root) => {

package/lib/helpers/redirects.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateRedirects = exports.generateStaticRedirects = void 0;
+const chalk_1 = require("chalk");
 const fs_extra_1 = require("fs-extra");
+const outdent_1 = require("outdent");
 const pathe_1 = require("pathe");
 const constants_1 = require("../constants");
+const files_1 = require("./files");
 const utils_1 = require("./utils");
+const matchesMiddleware = (middleware, route) => middleware.some((middlewarePath) => route.startsWith(middlewarePath));
 const generateLocaleRedirects = ({ i18n, basePath, trailingSlash, }) => {
     const redirects = [];
     // If the cookie is set, we need to redirect at the origin
@@ -41,27 +45,38 @@ const generateStaticRedirects = ({ netlifyConfig, nextConfig: { i18n, basePath }
     }
 };
 exports.generateStaticRedirects = generateStaticRedirects;
-const generateRedirects = async ({ netlifyConfig, nextConfig: { i18n, basePath, trailingSlash, appDir }, buildId, }) => {
-    const { dynamicRoutes: prerenderedDynamicRoutes, routes: prerenderedStaticRoutes } = await (0, fs_extra_1.readJSON)((0, pathe_1.join)(netlifyConfig.build.publish, 'prerender-manifest.json'));
-    const { dynamicRoutes, staticRoutes } = await (0, fs_extra_1.readJSON)((0, pathe_1.join)(netlifyConfig.build.publish, 'routes-manifest.json'));
-    netlifyConfig.redirects.push(...constants_1.HIDDEN_PATHS.map((path) => ({
-        from: `${basePath}${path}`,
-        to: '/404.html',
-        status: 404,
-        force: true,
-    })));
-    if (i18n && i18n.localeDetection !== false) {
-        netlifyConfig.redirects.push(...generateLocaleRedirects({ i18n, basePath, trailingSlash }));
-    }
-    // This is only used in prod, so dev uses `next dev` directly
-    netlifyConfig.redirects.push(
-    // API routes always need to be served from the regular function
-    ...(0, utils_1.getApiRewrites)(basePath), 
-    // Preview mode gets forced to the function, to bypass pre-rendered pages, but static files need to be skipped
-    ...(await (0, utils_1.getPreviewRewrites)({ basePath, appDir })));
-    const staticRouteEntries = Object.entries(prerenderedStaticRoutes);
+/**
+ * Routes that match middleware need to always use the SSR function
+ * This generates a rewrite for every middleware in every locale, both with and without a splat
+ */
+const generateMiddlewareRewrites = ({ basePath, middleware, i18n, buildId }) => {
+    const handlerRewrite = (from) => ({
+        from: `${basePath}${from}`,
+        to: constants_1.HANDLER_FUNCTION_PATH,
+        status: 200,
+    });
+    return (middleware
+        .map((route) => {
+        var _a;
+        const unlocalized = [handlerRewrite(`${route}`), handlerRewrite(`${route}/*`)];
+        if (((_a = i18n === null || i18n === void 0 ? void 0 : i18n.locales) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+            const localized = i18n.locales.map((locale) => [
+                handlerRewrite(`/${locale}${route}`),
+                handlerRewrite(`/${locale}${route}/*`),
+                handlerRewrite(`/_next/data/${buildId}/${locale}${route}/*`),
+            ]);
+            // With i18n, all data routes are prefixed with the locale, but the HTML also has the unprefixed default
+            return [...unlocalized, ...localized];
+        }
+        return [...unlocalized, handlerRewrite(`/_next/data/${buildId}${route}/*`)];
+    })
+        // Flatten the array of arrays. Can't use flatMap as it might be 2 levels deep
+        .flat(2));
+};
+const generateStaticIsrRewrites = ({ staticRouteEntries, basePath, i18n, buildId, middleware, }) => {
+    const staticIsrRoutesThatMatchMiddleware = [];
     const staticRoutePaths = new Set();
-    // First add all static ISR routes
+    const staticIsrRewrites = [];
     staticRouteEntries.forEach(([route, { initialRevalidateSeconds }]) => {
         if ((0, utils_1.isApiRoute)(route)) {
             return;
@@ -75,7 +90,10 @@ const generateRedirects = async ({ netlifyConfig, nextConfig: { i18n, basePath,
         if ((i18n === null || i18n === void 0 ? void 0 : i18n.defaultLocale) && route.startsWith(`/${i18n.defaultLocale}/`)) {
             route = route.slice(i18n.defaultLocale.length + 1);
             staticRoutePaths.add(route);
-            netlifyConfig.redirects.push(...(0, utils_1.redirectsForNextRouteWithData)({
+            if (matchesMiddleware(middleware, route)) {
+                staticIsrRoutesThatMatchMiddleware.push(route);
+            }
+            staticIsrRewrites.push(...(0, utils_1.redirectsForNextRouteWithData)({
                 route,
                 dataRoute: (0, utils_1.routeToDataRoute)(route, buildId, i18n.defaultLocale),
                 basePath,
@@ -83,41 +101,116 @@ const generateRedirects = async ({ netlifyConfig, nextConfig: { i18n, basePath,
                 force: true,
             }));
         }
+        else if (matchesMiddleware(middleware, route)) {
+            //  Routes that match middleware can't use the ODB
+            staticIsrRoutesThatMatchMiddleware.push(route);
+        }
         else {
             // ISR routes use the ODB handler
-            netlifyConfig.redirects.push(
+            staticIsrRewrites.push(
             // No i18n, because the route is already localized
             ...(0, utils_1.redirectsForNextRoute)({ route, basePath, to: constants_1.ODB_FUNCTION_PATH, force: true, buildId, i18n: null }));
         }
     });
-    // Add rewrites for all static SSR routes. This is Next 12+
-    staticRoutes === null || staticRoutes === void 0 ? void 0 : staticRoutes.forEach((route) => {
-        if (staticRoutePaths.has(route.page) || (0, utils_1.isApiRoute)(route.page)) {
-            // Prerendered static routes are either handled by the CDN or are ISR
-            return;
-        }
-        netlifyConfig.redirects.push(...(0, utils_1.redirectsForNextRoute)({ route: route.page, buildId, basePath, to: constants_1.HANDLER_FUNCTION_PATH, i18n }));
-    });
-    // Add rewrites for all dynamic routes (both SSR and ISR)
+    return {
+        staticRoutePaths,
+        staticIsrRoutesThatMatchMiddleware,
+        staticIsrRewrites,
+    };
+};
+/**
+ * Generate rewrites for all dynamic routes
+ */
+const generateDynamicRewrites = ({ dynamicRoutes, prerenderedDynamicRoutes, middleware, basePath, buildId, i18n, }) => {
+    const dynamicRewrites = [];
+    const dynamicRoutesThatMatchMiddleware = [];
     dynamicRoutes.forEach((route) => {
         if ((0, utils_1.isApiRoute)(route.page)) {
             return;
         }
         if (route.page in prerenderedDynamicRoutes) {
-            const { fallback } = prerenderedDynamicRoutes[route.page];
-            const { to, status } = (0, utils_1.targetForFallback)(fallback);
-            netlifyConfig.redirects.push(...(0, utils_1.redirectsForNextRoute)({ buildId, route: route.page, basePath, to, status, i18n }));
+            if (matchesMiddleware(middleware, route.page)) {
+                dynamicRoutesThatMatchMiddleware.push(route.page);
+            }
+            else {
+                dynamicRewrites.push(...(0, utils_1.redirectsForNextRoute)({ buildId, route: route.page, basePath, to: constants_1.ODB_FUNCTION_PATH, status: 200, i18n }));
+            }
         }
         else {
             // If the route isn't prerendered, it's SSR
-            netlifyConfig.redirects.push(...(0, utils_1.redirectsForNextRoute)({ route: route.page, buildId, basePath, to: constants_1.HANDLER_FUNCTION_PATH, i18n }));
+            dynamicRewrites.push(...(0, utils_1.redirectsForNextRoute)({ route: route.page, buildId, basePath, to: constants_1.HANDLER_FUNCTION_PATH, i18n }));
         }
     });
+    return {
+        dynamicRoutesThatMatchMiddleware,
+        dynamicRewrites,
+    };
+};
+const generateRedirects = async ({ netlifyConfig, nextConfig: { i18n, basePath, trailingSlash, appDir }, buildId, }) => {
+    const { dynamicRoutes: prerenderedDynamicRoutes, routes: prerenderedStaticRoutes } = await (0, fs_extra_1.readJSON)((0, pathe_1.join)(netlifyConfig.build.publish, 'prerender-manifest.json'));
+    const { dynamicRoutes, staticRoutes } = await (0, fs_extra_1.readJSON)((0, pathe_1.join)(netlifyConfig.build.publish, 'routes-manifest.json'));
+    netlifyConfig.redirects.push(...constants_1.HIDDEN_PATHS.map((path) => ({
+        from: `${basePath}${path}`,
+        to: '/404.html',
+        status: 404,
+        force: true,
+    })));
+    if (i18n && i18n.localeDetection !== false) {
+        netlifyConfig.redirects.push(...generateLocaleRedirects({ i18n, basePath, trailingSlash }));
+    }
+    // This is only used in prod, so dev uses `next dev` directly
+    netlifyConfig.redirects.push(
+    // API routes always need to be served from the regular function
+    ...(0, utils_1.getApiRewrites)(basePath), 
+    // Preview mode gets forced to the function, to bypass pre-rendered pages, but static files need to be skipped
+    ...(await (0, utils_1.getPreviewRewrites)({ basePath, appDir })));
+    const middleware = await (0, files_1.getMiddleware)(netlifyConfig.build.publish);
+    netlifyConfig.redirects.push(...generateMiddlewareRewrites({ basePath, i18n, middleware, buildId }));
+    const staticRouteEntries = Object.entries(prerenderedStaticRoutes);
+    const routesThatMatchMiddleware = [];
+    const { staticRoutePaths, staticIsrRewrites, staticIsrRoutesThatMatchMiddleware } = generateStaticIsrRewrites({
+        staticRouteEntries,
+        basePath,
+        i18n,
+        buildId,
+        middleware,
+    });
+    routesThatMatchMiddleware.push(...staticIsrRoutesThatMatchMiddleware);
+    netlifyConfig.redirects.push(...staticIsrRewrites);
+    // Add rewrites for all static SSR routes. This is Next 12+
+    staticRoutes === null || staticRoutes === void 0 ? void 0 : staticRoutes.forEach((route) => {
+        if (staticRoutePaths.has(route.page) || (0, utils_1.isApiRoute)(route.page)) {
+            // Prerendered static routes are either handled by the CDN or are ISR
+            return;
+        }
+        netlifyConfig.redirects.push(...(0, utils_1.redirectsForNextRoute)({ route: route.page, buildId, basePath, to: constants_1.HANDLER_FUNCTION_PATH, i18n }));
+    });
+    // Add rewrites for all dynamic routes (both SSR and ISR)
+    const { dynamicRewrites, dynamicRoutesThatMatchMiddleware } = generateDynamicRewrites({
+        dynamicRoutes,
+        prerenderedDynamicRoutes,
+        middleware,
+        basePath,
+        buildId,
+        i18n,
+    });
+    netlifyConfig.redirects.push(...dynamicRewrites);
+    routesThatMatchMiddleware.push(...dynamicRoutesThatMatchMiddleware);
     // Final fallback
     netlifyConfig.redirects.push({
         from: `${basePath}/*`,
         to: constants_1.HANDLER_FUNCTION_PATH,
         status: 200,
     });
+    const middlewareMatches = new Set(routesThatMatchMiddleware).size;
+    if (middlewareMatches > 0) {
+        console.log((0, chalk_1.yellowBright)((0, outdent_1.outdent) `
+        There ${middlewareMatches === 1
+            ? `is one statically-generated or ISR route that matches`
+            : `are ${middlewareMatches} statically-generated or ISR routes that match`} a middleware function. Matched routes will always be served from the SSR function and will not use ISR or be served from the CDN.
+        If this was not intended, ensure that your middleware only matches routes that you intend to use SSR.
+      `));
+    }
 };
 exports.generateRedirects = generateRedirects;
+/* eslint-enable max-lines */

package/lib/helpers/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldSkip = exports.getPreviewRewrites = exports.getApiRewrites = exports.redirectsForNextRouteWithData = exports.redirectsForNextRoute = exports.targetForFallback = exports.isApiRoute = exports.routeToDataRoute = exports.netlifyRoutesForNextRouteWithData = exports.toNetlifyRoute = void 0;
+exports.findModuleFromBase = exports.shouldSkip = exports.getPreviewRewrites = exports.getApiRewrites = exports.redirectsForNextRouteWithData = exports.redirectsForNextRoute = exports.isApiRoute = exports.routeToDataRoute = exports.netlifyRoutesForNextRouteWithData = exports.toNetlifyRoute = void 0;
 const globby_1 = __importDefault(require("globby"));
 const pathe_1 = require("pathe");
 const constants_1 = require("../constants");
@@ -63,16 +63,6 @@ const netlifyRoutesForNextRoute = (route, buildId, i18n) => {
 };
 const isApiRoute = (route) => route.startsWith('/api/') || route === '/api';
 exports.isApiRoute = isApiRoute;
-const targetForFallback = (fallback) => {
-    if (fallback === null || fallback === false) {
-        // fallback = null mean "blocking", which uses ODB. For fallback=false then anything prerendered should 404.
-        // However i18n pages may not have been prerendered, so we still need to hit the origin
-        return { to: constants_1.ODB_FUNCTION_PATH, status: 200 };
-    }
-    // fallback = true is also ODB
-    return { to: constants_1.ODB_FUNCTION_PATH, status: 200 };
-};
-exports.targetForFallback = targetForFallback;
 const redirectsForNextRoute = ({ route, buildId, basePath, to, i18n, status = 200, force = false, }) => netlifyRoutesForNextRoute(route, buildId, i18n).map((redirect) => ({
     from: `${basePath}${redirect}`,
     to,
@@ -126,3 +116,21 @@ const shouldSkip = () => process.env.NEXT_PLUGIN_FORCE_RUN === 'false' ||
     process.env.NETLIFY_NEXT_PLUGIN_SKIP === 'true' ||
     process.env.NETLIFY_NEXT_PLUGIN_SKIP === '1';
 exports.shouldSkip = shouldSkip;
+/**
+ * Given an array of base paths and candidate modules, return the first one that exists
+ */
+const findModuleFromBase = ({ paths, candidates }) => {
+    for (const candidate of candidates) {
+        try {
+            const modulePath = require.resolve(candidate, { paths });
+            if (modulePath) {
+                return modulePath;
+            }
+        }
+        catch {
+            // Ignore the error
+        }
+    }
+    return null;
+};
+exports.findModuleFromBase = findModuleFromBase;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.2.1",
+  "version": "4.2.5",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -54,12 +54,13 @@
   "homepage": "https://github.com/netlify/netlify-plugin-nextjs#readme",
   "dependencies": {
     "@netlify/functions": "^0.11.0",
-    "@netlify/ipx": "^0.0.8",
+    "@netlify/ipx": "^0.0.9",
     "@vercel/node-bridge": "^2.1.0",
     "chalk": "^4.1.2",
     "fs-extra": "^10.0.0",
     "globby": "^11.0.4",
     "moize": "^6.1.0",
+    "next": "^12.0.10",
     "node-fetch": "^2.6.6",
     "node-stream-zip": "^1.15.0",
     "outdent": "^0.8.0",
@@ -74,13 +75,16 @@
     "@babel/core": "^7.15.8",
     "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.16.0",
-    "@netlify/build": "^26.2.0",
-    "@netlify/eslint-config-node": "^4.1.6",
+    "@netlify/build": "^26.2.3",
+    "@netlify/eslint-config-node": "^5.1.4",
+    "@reach/dialog": "^0.16.2",
+    "@reach/visually-hidden": "^0.16.0",
     "@testing-library/cypress": "^8.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.0.2",
     "@types/mocha": "^9.0.0",
     "@types/node": "^17.0.10",
+    "@types/react": "^17.0.38",
     "babel-jest": "^27.2.5",
     "cpy": "^8.1.2",
     "cypress": "^9.0.0",
@@ -88,12 +92,12 @@
     "husky": "^7.0.4",
     "jest": "^27.0.0",
     "netlify-plugin-cypress": "^2.2.0",
-    "next": "^12.0.8",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.2",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "rimraf": "^3.0.2",
+    "sass": "^1.49.0",
     "tmp-promise": "^3.0.2",
     "typescript": "^4.3.4"
   },