@netlify/plugin-nextjs 4.0.0 → 4.1.0

package/README.md

@@ -76,6 +76,15 @@ If you are using Nx, then you will need to point `publish` to the folder inside
 The Essential Next.js plugin now fully supports ISR on Netlify. For more details see
 [the ISR docs](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/isr.md).
 
+## Use with `next export`
+
+If you are using `next export` to generate a static site, you do not need most of the functionality of this plugin and
+you can remove it. Alternatively you can
+[set the environment variable](https://docs.netlify.com/configure-builds/environment-variables/)
+`NETLIFY_NEXT_PLUGIN_SKIP` to `true` and the plugin will handle caching but won't generate any functions for SSR
+support. See [`demos/next-export`](https://github.com/netlify/netlify-plugin-nextjs/tree/main/demos/next-export) for an
+example.
+
 ## Feedback
 
 If you think you have found a bug in the plugin,

package/lib/helpers/files.js

@@ -75,7 +75,7 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, }) => {
     Object.entries(prerenderManifest.routes).forEach(([route, { initialRevalidateSeconds }]) => {
         if (initialRevalidateSeconds) {
             // Find all files used by ISR routes
-            const trimmedPath = route.slice(1);
+            const trimmedPath = route === '/' ? 'index' : route.slice(1);
             isrFiles.add(`${trimmedPath}.html`);
             isrFiles.add(`${trimmedPath}.json`);
             if (initialRevalidateSeconds < constants_1.MINIMUM_REVALIDATE_SECONDS) {

package/lib/helpers/redirects.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.generateRedirects = void 0;
+exports.generateRedirects = exports.generateStaticRedirects = void 0;
 const fs_extra_1 = require("fs-extra");
 const globby_1 = __importDefault(require("globby"));
 const pathe_1 = require("pathe");
@@ -37,6 +37,14 @@ const generateLocaleRedirects = ({ i18n, basePath, trailingSlash, }) => {
     });
     return redirects;
 };
+const generateStaticRedirects = ({ netlifyConfig, nextConfig: { i18n, basePath }, }) => {
+    // Static files are in `static`
+    netlifyConfig.redirects.push({ from: `${basePath}/_next/static/*`, to: `/static/:splat`, status: 200 });
+    if (i18n) {
+        netlifyConfig.redirects.push({ from: `${basePath}/:locale/_next/static/*`, to: `/static/:splat`, status: 200 });
+    }
+};
+exports.generateStaticRedirects = generateStaticRedirects;
 const generateRedirects = async ({ netlifyConfig, nextConfig: { i18n, basePath, trailingSlash, appDir }, }) => {
     const { dynamicRoutes, routes: staticRoutes } = await fs_extra_1.readJSON(pathe_1.join(netlifyConfig.build.publish, 'prerender-manifest.json'));
     netlifyConfig.redirects.push(...constants_1.HIDDEN_PATHS.map((path) => ({
@@ -72,14 +80,9 @@ const generateRedirects = async ({ netlifyConfig, nextConfig: { i18n, basePath,
         pageRedirects.push(...utils_1.netlifyRoutesForNextRoute(route));
         dataRedirects.push(...utils_1.netlifyRoutesForNextRoute(dataRoute));
     });
-    if (i18n) {
-        netlifyConfig.redirects.push({ from: `${basePath}/:locale/_next/static/*`, to: `/static/:splat`, status: 200 });
-    }
     const publicFiles = await globby_1.default('**/*', { cwd: pathe_1.join(appDir, 'public') });
     // This is only used in prod, so dev uses `next dev` directly
     netlifyConfig.redirects.push(
-    // Static files are in `static`
-    { from: `${basePath}/_next/static/*`, to: `/static/:splat`, status: 200 }, 
     // API routes always need to be served from the regular function
     {
         from: `${basePath}/api`,

package/lib/helpers/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.netlifyRoutesForNextRoute = void 0;
+exports.shouldSkip = exports.netlifyRoutesForNextRoute = void 0;
 const constants_1 = require("../constants");
 const netlifyRoutesForNextRoute = (nextRoute) => {
     const netlifyRoutes = [nextRoute];
@@ -30,3 +30,8 @@ const netlifyRoutesForNextRoute = (nextRoute) => {
         .replace(constants_1.DYNAMIC_PARAMETER_REGEX, '/:$1'));
 };
 exports.netlifyRoutesForNextRoute = netlifyRoutesForNextRoute;
+const shouldSkip = () => process.env.NEXT_PLUGIN_FORCE_RUN === 'false' ||
+    process.env.NEXT_PLUGIN_FORCE_RUN === '0' ||
+    process.env.NETLIFY_NEXT_PLUGIN_SKIP === 'true' ||
+    process.env.NETLIFY_NEXT_PLUGIN_SKIP === '1';
+exports.shouldSkip = shouldSkip;

package/lib/helpers/verification.js

@@ -22,7 +22,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkZipSize = exports.checkForRootPublish = exports.checkNextSiteHasBuilt = exports.checkForOldFunctions = exports.verifyNetlifyBuildVersion = void 0;
+exports.warnForProblematicUserRewrites = exports.getProblematicUserRewrites = exports.checkZipSize = exports.checkForRootPublish = exports.checkNextSiteHasBuilt = exports.checkForOldFunctions = exports.verifyNetlifyBuildVersion = void 0;
+/* eslint-disable max-lines */
 const fs_1 = require("fs");
 const path_1 = __importStar(require("path"));
 const chalk_1 = require("chalk");
@@ -67,14 +68,13 @@ const checkNextSiteHasBuilt = ({ publish, failBuild, }) => {
         return failBuild(outdent_1.outdent `
       The directory "${path_1.default.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.
       ${outWarning}
-      If you are using "next export" then the Essential Next.js plugin should be removed. See https://ntl.fyi/remove-plugin for details.
+      If you are using "next export" then you should set the environment variable NETLIFY_NEXT_PLUGIN_SKIP to "true".
     `);
     }
     if (fs_1.existsSync(path_1.default.join(publish, 'export-detail.json'))) {
         failBuild(outdent_1.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.
+      The publish directory should be set to "out", and you should set the environment variable NETLIFY_NEXT_PLUGIN_SKIP to "true".
     `);
     }
 };
@@ -119,3 +119,38 @@ const checkZipSize = async (file, maxSize = constants_1.LAMBDA_MAX_SIZE) => {
     console.log(chalk_1.greenBright `\n\nFor more information on fixing this, see ${chalk_1.blueBright `https://ntl.fyi/large-next-functions`}`);
 };
 exports.checkZipSize = checkZipSize;
+const getProblematicUserRewrites = ({ redirects, basePath, }) => {
+    const userRewrites = [];
+    for (const redirect of redirects) {
+        // This is the first of the plugin-generated redirects so we can stop checking
+        if (redirect.from === `${basePath}/_next/static/*` && redirect.to === `/static/:splat` && redirect.status === 200) {
+            break;
+        }
+        if (
+        // Redirects are fine
+        (redirect.status === 200 || redirect.status === 404) &&
+            // Rewriting to a function is also fine
+            !redirect.to.startsWith('/.netlify/') &&
+            // ...so is proxying
+            !redirect.to.startsWith('http')) {
+            userRewrites.push(redirect);
+        }
+    }
+    return userRewrites;
+};
+exports.getProblematicUserRewrites = getProblematicUserRewrites;
+const warnForProblematicUserRewrites = ({ redirects, basePath, }) => {
+    const userRewrites = exports.getProblematicUserRewrites({ redirects, basePath });
+    if (userRewrites.length === 0) {
+        return;
+    }
+    console.log(chalk_1.yellowBright(outdent_1.outdent `
+      You have the following Netlify rewrite${userRewrites.length === 1 ? '' : 's'} that might cause conflicts with the Next.js plugin:
+
+      ${chalk_1.reset(userRewrites.map(({ from, to, status }) => `- ${from} ${to} ${status}`).join('\n'))}
+
+      For more information, see https://ntl.fyi/next-rewrites
+    `));
+};
+exports.warnForProblematicUserRewrites = warnForProblematicUserRewrites;
+/* eslint-enable max-lines */

package/lib/index.js

@@ -1,17 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = require("path");
+const fs_extra_1 = require("fs-extra");
 const constants_1 = require("./constants");
 const cache_1 = require("./helpers/cache");
 const config_1 = require("./helpers/config");
 const files_1 = require("./helpers/files");
 const functions_1 = require("./helpers/functions");
 const redirects_1 = require("./helpers/redirects");
+const utils_1 = require("./helpers/utils");
 const verification_1 = require("./helpers/verification");
 const plugin = {
     async onPreBuild({ constants, netlifyConfig, utils: { build: { failBuild }, cache, }, }) {
         var _a;
         const { publish } = netlifyConfig.build;
+        if (utils_1.shouldSkip()) {
+            await cache_1.restoreCache({ cache, publish });
+            console.log('Not running Essential Next.js plugin');
+            if (fs_extra_1.existsSync(path_1.join(constants.INTERNAL_FUNCTIONS_SRC, constants_1.HANDLER_FUNCTION_NAME))) {
+                console.log(`Please ensure you remove any generated functions from ${constants.INTERNAL_FUNCTIONS_SRC}`);
+            }
+            return;
+        }
         verification_1.checkForRootPublish({ publish, failBuild });
         verification_1.verifyNetlifyBuildVersion({ failBuild, ...constants });
         await cache_1.restoreCache({ cache, publish });
@@ -20,6 +30,9 @@ const plugin = {
         netlifyConfig.build.environment.NEXT_PRIVATE_TARGET = 'server';
     },
     async onBuild({ constants, netlifyConfig, utils: { build: { failBuild }, }, }) {
+        if (utils_1.shouldSkip()) {
+            return;
+        }
         const { publish } = netlifyConfig.build;
         verification_1.checkNextSiteHasBuilt({ publish, failBuild });
         const { appDir, basePath, i18n, images, target, ignore, trailingSlash, outdir } = await config_1.getNextConfig({
@@ -39,17 +52,31 @@ const plugin = {
         if (!process.env.SERVE_STATIC_FILES_FROM_ORIGIN) {
             await files_1.moveStaticPages({ target, netlifyConfig, i18n });
         }
+        await redirects_1.generateStaticRedirects({
+            netlifyConfig,
+            nextConfig: { basePath, i18n },
+        });
         await functions_1.setupImageFunction({ constants, imageconfig: images, netlifyConfig, basePath });
         await redirects_1.generateRedirects({
             netlifyConfig,
             nextConfig: { basePath, i18n, trailingSlash, appDir },
         });
     },
-    async onPostBuild({ netlifyConfig, utils: { cache, functions, build: { failBuild }, }, constants: { FUNCTIONS_DIST }, }) {
-        await cache_1.saveCache({ cache, publish: netlifyConfig.build.publish });
+    async onPostBuild({ netlifyConfig: { build: { publish }, redirects, }, utils: { status, cache, functions, build: { failBuild }, }, constants: { FUNCTIONS_DIST }, }) {
+        await cache_1.saveCache({ cache, publish });
+        if (utils_1.shouldSkip()) {
+            status.show({
+                title: 'Essential Next.js plugin did not run',
+                summary: `Next cache was stored, but all other functions were skipped because ${process.env.NETLIFY_NEXT_PLUGIN_SKIP
+                    ? `NETLIFY_NEXT_PLUGIN_SKIP is set`
+                    : `NEXT_PLUGIN_FORCE_RUN is set to ${process.env.NEXT_PLUGIN_FORCE_RUN}`}`,
+            });
+            return;
+        }
         await verification_1.checkForOldFunctions({ functions });
         await verification_1.checkZipSize(path_1.join(FUNCTIONS_DIST, `${constants_1.ODB_FUNCTION_NAME}.zip`));
-        const { basePath } = await config_1.getNextConfig({ publish: netlifyConfig.build.publish, failBuild });
+        const { basePath } = await config_1.getNextConfig({ publish, failBuild });
+        verification_1.warnForProblematicUserRewrites({ basePath, redirects });
         await files_1.unpatchNextFiles(basePath);
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -74,8 +74,8 @@
     "@babel/core": "^7.15.8",
     "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.16.0",
-    "@netlify/build": "^20.3.0",
-    "@netlify/eslint-config-node": "^4.0.0",
+    "@netlify/build": "^25.0.1",
+    "@netlify/eslint-config-node": "^4.0.1",
     "@testing-library/cypress": "^8.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.0.2",