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

package/README.md

@@ -2,8 +2,8 @@
 
 # Essential Next.js Build Plugin (beta)
 
-
-:warning: This is the beta version of the Essential Next.js plugin. For the stable version, see [Essential Next.js plugin v3](https://github.com/netlify/netlify-plugin-nextjs/tree/v3#readme) :warning:
+:warning: This is the beta version of the Essential Next.js plugin. For the stable version, refer to
+[Essential Next.js plugin v3](https://github.com/netlify/netlify-plugin-nextjs/tree/v3#readme) :warning:
 
 <p align="center">
   <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
@@ -16,16 +16,19 @@
 
 ## What's new in this version
 
-Version 4 is a complete rewrite of the Essential Next.js plugin. For full details of everything that's new, see [the v4 release notes](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/release-notes/v4.md)
+Version 4 is a complete rewrite of the Essential Next.js plugin. For full details of everything that's new, check out
+[the v4 release notes](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/release-notes/v4.md)
 
 ## Installing the beta
 
-
 - Install the module:
+
 ```shell
 npm install -D @netlify/plugin-nextjs@beta
 ```
-- Change the `publish` directory to `.next`  and add the plugin to `netlify.toml` if not already installed:
+
+- Change the `publish` directory to `.next` and add the plugin to `netlify.toml` if not already installed:
+
 ```toml
 [build]
 publish = ".next"
@@ -34,14 +37,27 @@ publish = ".next"
 package = "@netlify/plugin-nextjs"
 ```
 
-If you previously set `target: "serverless"` or a custom `distDir` in your `next.config.js`, or set `node_bundler` or `external_node_modules` in your `netlify.toml` these are no longer needed and can be removed. 
+If you previously set a custom `distDir` in your `next.config.js`, or set `node_bundler` or `external_node_modules` in
+your `netlify.toml` these are no longer needed and can be removed.
+
+The `serverless` and `experimental-serverless-trace` targets are deprecated in Next 12, and all builds with this plugin
+will now use the default `server` target. If you previously set the target in your `next.config.js`, you should remove
+it.
+
+If you are using a monorepo you will need to change `publish` to point to the full path to the built `.next` directory,
+which may be in a subdirectory. If you have changed your `distDir` then it will need to match that.
 
-The `serverless` and `experimental-serverless-trace` targets are deprecated in Next 12, and all builds with this plugin will now use the default `server` target.
+If you are using Nx, then you will need to point `publish` to the folder inside `dist`, e.g. `dist/apps/myapp/.next`.
 
-If you are using a monorepo you will need to change `publish` to point to the full path to the built `.next` directory, which may be in a subdirectory. If you have changed your `distDir` then it will need to match that. 
+If you currently use redirects or rewrites on your site, see
+[the Rewrites and Redirects guide](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/redirects-rewrites.md)
+for information on changes to how they are handled in this version.
 
-If you are using Nx, then you will need to point `publish` to the folder inside `dist`, e.g. `dist/apps/myapp/.next`. 
+If you want to use Next 12's beta Middleware feature, this will mostly work as expected but please
+[read the docs on some caveats and workarounds](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/middleware.md)
+that are currently needed.
 
 ## Beta feedback
 
-Please share any thoughts, feedback or questions about the beta [in our discussion](https://github.com/netlify/netlify-plugin-nextjs/discussions/706).
+Please share any thoughts, feedback or questions about the beta
+[in our discussion](https://github.com/netlify/netlify-plugin-nextjs/discussions/706).

package/lib/helpers/config.js

@@ -59,24 +59,13 @@ exports.generateRedirects = async ({ netlifyConfig, basePath, i18n }) => {
     if (i18n) {
         netlifyConfig.redirects.push({ from: `${basePath}/:locale/_next/static/*`, to: `/static/:splat`, status: 200 });
     }
-    const staticManifest = join(netlifyConfig.build.publish, 'static-manifest.json');
-    if (process.env.EXPERIMENTAL_MOVE_STATIC_PAGES && existsSync(staticManifest)) {
-        // Static page files need to have a forced redirect for preview mode. Otherwise it's non-forced
-        const staticFiles = await readJSON(staticManifest);
-        netlifyConfig.redirects.push(...staticFiles.map((file) => ({
-            from: `${basePath}/${file}`,
-            to: HANDLER_FUNCTION_PATH,
-            status: 200,
-            force: true,
-            conditions: { Cookie: ['__prerender_bypass', '__next_preview_data'] },
-        })));
-    }
     // This is only used in prod, so dev uses `next dev` directly
     netlifyConfig.redirects.push({ from: `${basePath}/_next/static/*`, to: `/static/:splat`, status: 200 }, {
         from: `${basePath}/*`,
         to: HANDLER_FUNCTION_PATH,
         status: 200,
         conditions: { Cookie: ['__prerender_bypass', '__next_preview_data'] },
+        force: true,
     }, ...redirects.map((redirect) => ({
         from: `${basePath}${redirect}`,
         to: ODB_FUNCTION_PATH,

package/lib/helpers/verification.js

@@ -1,7 +1,7 @@
 const { existsSync, promises } = require('fs');
 const path = require('path');
 const { relative } = require('path');
-const { yellowBright, greenBright, blueBright, redBright } = require('chalk');
+const { yellowBright, greenBright, blueBright, redBright, reset } = require('chalk');
 const { async: StreamZip } = require('node-stream-zip');
 const outdent = require('outdent');
 const prettyBytes = require('pretty-bytes');
@@ -17,6 +17,21 @@ exports.verifyNetlifyBuildVersion = ({ IS_LOCAL, NETLIFY_BUILD_VERSION, failBuil
     `);
     }
 };
+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_".
+
+      ${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:
+
+      ${reset(oldFunctions.map(({ mainFile }) => `- ${path.relative(process.cwd(), path.dirname(mainFile))}`).join('\n'))}
+
+    `));
+    }
+};
 exports.checkNextSiteHasBuilt = ({ publish, failBuild }) => {
     if (!existsSync(path.join(publish, 'BUILD_ID'))) {
         return failBuild(outdent `

package/lib/index.js

@@ -1,11 +1,11 @@
-// @ts-check
 const { join, relative } = require('path');
 const { ODB_FUNCTION_NAME } = require('./constants');
 const { restoreCache, saveCache } = require('./helpers/cache');
 const { getNextConfig, configureHandlerFunctions, generateRedirects } = require('./helpers/config');
 const { moveStaticPages, movePublicFiles } = require('./helpers/files');
 const { generateFunctions, setupImageFunction, generatePagesResolver } = require('./helpers/functions');
-const { verifyNetlifyBuildVersion, checkNextSiteHasBuilt, checkForRootPublish, logBetaMessage, checkZipSize, } = require('./helpers/verification');
+const { verifyNetlifyBuildVersion, checkNextSiteHasBuilt, checkForRootPublish, logBetaMessage, checkZipSize, checkForOldFunctions, } = require('./helpers/verification');
+/** @type import("@netlify/build").NetlifyPlugin */
 module.exports = {
     async onPreBuild({ constants, netlifyConfig, utils: { build: { failBuild }, cache, }, }) {
         var _a;
@@ -36,8 +36,9 @@ module.exports = {
             i18n,
         });
     },
-    async onPostBuild({ netlifyConfig, utils: { cache }, constants: { FUNCTIONS_DIST } }) {
+    async onPostBuild({ netlifyConfig, utils: { cache, functions }, constants: { FUNCTIONS_DIST } }) {
         await saveCache({ cache, publish: netlifyConfig.build.publish });
+        await checkForOldFunctions({ functions });
         await checkZipSize(join(FUNCTIONS_DIST, `${ODB_FUNCTION_NAME}.zip`));
     },
     onEnd() {

package/lib/templates/getHandler.js

@@ -103,6 +103,8 @@ const makeHandler = () =>
     bridge.listen();
     return async (event, context) => {
         var _a, _b, _c, _d;
+        // Ensure that paths are encoded - but don't double-encode them
+        event.path = new URL(event.path, event.rawUrl).pathname;
         // Next expects to be able to parse the query from the URL
         const query = new URLSearchParams(event.queryStringParameters).toString();
         event.path = query ? `${event.path}?${query}` : event.path;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.0.0-beta.6",
+  "version": "4.0.0-beta.7",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -52,7 +52,7 @@
   },
   "homepage": "https://github.com/netlify/netlify-plugin-nextjs#readme",
   "dependencies": {
-    "@netlify/functions": "^0.8.0",
+    "@netlify/functions": "^0.9.0",
     "@netlify/ipx": "^0.0.7",
     "@vercel/node": "^1.11.2-canary.4",
     "chalk": "^4.1.2",
@@ -72,6 +72,7 @@
   "devDependencies": {
     "@babel/core": "^7.15.8",
     "@babel/preset-env": "^7.15.8",
+    "@netlify/build": "^18.23.0",
     "@netlify/eslint-config-node": "^3.3.0",
     "@testing-library/cypress": "^8.0.1",
     "@types/fs-extra": "^9.0.13",