@netlify/plugin-nextjs 4.0.0-beta.11 → 4.0.0-beta.12

package/lib/helpers/config.js

@@ -102,7 +102,7 @@ exports.generateRedirects = async ({ netlifyConfig, basePath, i18n }) => {
     // ISR redirects are handled by the regular function. Forced to avoid pre-rendered pages
     ...isrRedirects.map((redirect) => ({
         from: `${basePath}${redirect}`,
-        to: HANDLER_FUNCTION_PATH,
+        to: process.env.EXPERIMENTAL_ODB_TTL ? ODB_FUNCTION_PATH : HANDLER_FUNCTION_PATH,
         status: 200,
         force: true,
     })), 
@@ -158,7 +158,7 @@ exports.configureHandlerFunctions = ({ netlifyConfig, publish, ignore = [] }) =>
         (_a = netlifyConfig.functions)[functionName] || (_a[functionName] = { included_files: [], external_node_modules: [] });
         netlifyConfig.functions[functionName].node_bundler = 'nft';
         (_b = netlifyConfig.functions[functionName]).included_files || (_b.included_files = []);
-        netlifyConfig.functions[functionName].included_files.push(`${publish}/server/**`, `${publish}/serverless/**`, `${publish}/*.json`, `${publish}/BUILD_ID`, `${publish}/static/chunks/webpack-middleware*.js`, `!${publish}/server/**/*.js.nft.json`, ...ignore.map((path) => `!${slash(path)}`));
+        netlifyConfig.functions[functionName].included_files.push('.env', '.env.local', '.env.production', '.env.production.local', `${publish}/server/**`, `${publish}/serverless/**`, `${publish}/*.json`, `${publish}/BUILD_ID`, `${publish}/static/chunks/webpack-middleware*.js`, `!${publish}/server/**/*.js.nft.json`, ...ignore.map((path) => `!${slash(path)}`));
         const nextRoot = resolveModuleRoot('next');
         if (nextRoot) {
             netlifyConfig.functions[functionName].included_files.push(`!${nextRoot}/dist/server/lib/squoosh/**/*.wasm`, `!${nextRoot}/dist/next-server/server/lib/squoosh/**/*.wasm`, `!${nextRoot}/dist/compiled/webpack/bundle4.js`, `!${nextRoot}/dist/compiled/webpack/bundle5.js`, `!${nextRoot}/dist/compiled/terser/bundle.min.js`);

package/lib/helpers/files.js

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 const { cpus } = require('os');
 const { yellowBright } = require('chalk');
-const { existsSync, readJson, move, cpSync, copy, writeJson } = require('fs-extra');
+const { existsSync, readJson, move, cpSync, copy, writeJson, readFile, writeFile } = require('fs-extra');
 const globby = require('globby');
 const { outdent } = require('outdent');
 const pLimit = require('p-limit');
@@ -178,6 +178,55 @@ exports.moveStaticPages = async ({ netlifyConfig, target, i18n }) => {
         }
     }
 };
+const patchFile = async ({ file, from, to }) => {
+    if (!existsSync(file)) {
+        return;
+    }
+    const content = await readFile(file, 'utf8');
+    if (content.includes(to)) {
+        return;
+    }
+    const newContent = content.replace(from, to);
+    await writeFile(`${file}.orig`, content);
+    await writeFile(file, newContent);
+};
+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;
+};
+exports.patchNextFiles = async (root) => {
+    const serverFile = getServerFile(root);
+    console.log(`Patching ${serverFile}`);
+    if (serverFile) {
+        await patchFile({
+            file: serverFile,
+            from: `let ssgCacheKey = `,
+            to: `let ssgCacheKey = process.env._BYPASS_SSG || `,
+        });
+    }
+};
+exports.unpatchNextFiles = async (root) => {
+    const serverFile = getServerFile(root);
+    const origFile = `${serverFile}.orig`;
+    if (existsSync(origFile)) {
+        await move(origFile, serverFile, { overwrite: true });
+    }
+};
 exports.movePublicFiles = async ({ appDir, publish }) => {
     const publicDir = join(appDir, 'public');
     if (existsSync(publicDir)) {

package/lib/helpers/verification.js

@@ -18,7 +18,8 @@ exports.verifyNetlifyBuildVersion = ({ IS_LOCAL, NETLIFY_BUILD_VERSION, failBuil
     }
 };
 exports.checkForOldFunctions = async ({ functions }) => {
-    const oldFunctions = (await functions.list()).filter(({ name }) => name.startsWith('next_'));
+    const allOldFunctions = await functions.list();
+    const oldFunctions = allOldFunctions.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_".

package/lib/index.js

@@ -2,7 +2,7 @@ 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 { moveStaticPages, movePublicFiles, patchNextFiles, unpatchNextFiles } = require('./helpers/files');
 const { generateFunctions, setupImageFunction, generatePagesResolver } = require('./helpers/functions');
 const { verifyNetlifyBuildVersion, checkNextSiteHasBuilt, checkForRootPublish, logBetaMessage, checkZipSize, checkForOldFunctions, } = require('./helpers/verification');
 /** @type import("@netlify/build").NetlifyPlugin */
@@ -26,6 +26,9 @@ module.exports = {
         await generateFunctions(constants, appDir);
         await generatePagesResolver({ netlifyConfig, target, constants });
         await movePublicFiles({ appDir, publish });
+        if (process.env.EXPERIMENTAL_ODB_TTL) {
+            await patchNextFiles(basePath);
+        }
         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'");
         }
@@ -39,10 +42,12 @@ module.exports = {
             i18n,
         });
     },
-    async onPostBuild({ netlifyConfig, utils: { cache, functions }, constants: { FUNCTIONS_DIST } }) {
+    async onPostBuild({ netlifyConfig, utils: { cache, functions, failBuild }, constants: { FUNCTIONS_DIST } }) {
         await saveCache({ cache, publish: netlifyConfig.build.publish });
         await checkForOldFunctions({ functions });
         await checkZipSize(join(FUNCTIONS_DIST, `${ODB_FUNCTION_NAME}.zip`));
+        const { basePath } = await getNextConfig({ publish: netlifyConfig.build.publish, failBuild });
+        await unpatchNextFiles(basePath);
     },
     onEnd() {
         logBetaMessage();

package/lib/templates/getHandler.js

@@ -3,7 +3,7 @@ const { Server } = require('http');
 const { tmpdir } = require('os');
 const path = require('path');
 const { Bridge } = require('@vercel/node/dist/bridge');
-const { downloadFile } = require('./handlerUtils');
+const { downloadFile, getMaxAge, getMultiValueHeaders } = require('./handlerUtils');
 const makeHandler = () => 
 // We return a function and then call `toString()` on it to serialise it as the launcher function
 // eslint-disable-next-line max-params
@@ -14,6 +14,9 @@ const makeHandler = () =>
         require.resolve('./pages.js');
     }
     catch { }
+    // eslint-disable-next-line no-underscore-dangle
+    process.env._BYPASS_SSG = 'true';
+    const ONE_YEAR_IN_SECONDS = 31536000;
     // We don't want to write ISR files to disk in the lambda environment
     conf.experimental.isrFlushToDisk = false;
     // Set during the request as it needs the host header. Hoisted so we can define the function once
@@ -97,6 +100,7 @@ const makeHandler = () =>
     bridge.listen();
     return async (event, context) => {
         var _a, _b, _c;
+        let requestMode = mode;
         // 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
@@ -111,15 +115,7 @@ const makeHandler = () =>
         const { headers, ...result } = await bridge.launcher(event, context);
         /** @type import("@netlify/functions").HandlerResponse */
         // Convert all headers to multiValueHeaders
-        const multiValueHeaders = {};
-        for (const key of Object.keys(headers)) {
-            if (Array.isArray(headers[key])) {
-                multiValueHeaders[key] = headers[key];
-            }
-            else {
-                multiValueHeaders[key] = [headers[key]];
-            }
-        }
+        const multiValueHeaders = getMultiValueHeaders(headers);
         if ((_b = (_a = multiValueHeaders['set-cookie']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.includes('__prerender_bypass')) {
             delete multiValueHeaders.etag;
             multiValueHeaders['cache-control'] = ['no-cache'];
@@ -127,10 +123,18 @@ const makeHandler = () =>
         // Sending SWR headers causes undefined behaviour with the Netlify CDN
         const cacheHeader = (_c = multiValueHeaders['cache-control']) === null || _c === void 0 ? void 0 : _c[0];
         if (cacheHeader === null || cacheHeader === void 0 ? void 0 : cacheHeader.includes('stale-while-revalidate')) {
-            console.log({ cacheHeader });
+            if (requestMode === 'odb' && process.env.EXPERIMENTAL_ODB_TTL) {
+                requestMode = 'isr';
+                const ttl = getMaxAge(cacheHeader);
+                // Long-expiry TTL is basically no TTL
+                if (ttl > 0 && ttl < ONE_YEAR_IN_SECONDS) {
+                    result.ttl = ttl;
+                }
+                multiValueHeaders['x-rendered-at'] = [new Date().toISOString()];
+            }
             multiValueHeaders['cache-control'] = ['public, max-age=0, must-revalidate'];
         }
-        multiValueHeaders['x-render-mode'] = [mode];
+        multiValueHeaders['x-render-mode'] = [requestMode];
         return {
             ...result,
             multiValueHeaders,
@@ -144,7 +148,7 @@ const { tmpdir } = require('os')
 const { promises, existsSync } = require("fs");
 // We copy the file here rather than requiring from the node module
 const { Bridge } = require("./bridge");
-const { downloadFile } = require('./handlerUtils')
+const { downloadFile, getMaxAge, getMultiValueHeaders } = require('./handlerUtils')
 
 const { builder } = require("@netlify/functions");
 const { config }  = require("${publishDir}/required-server-files.json")

package/lib/templates/handlerUtils.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.downloadFile = void 0;
+exports.getMultiValueHeaders = exports.getMaxAge = exports.downloadFile = void 0;
 const fs_1 = require("fs");
 const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
@@ -34,3 +34,33 @@ const downloadFile = async (url, destination) => {
     });
 };
 exports.downloadFile = downloadFile;
+const getMaxAge = (header) => {
+    const parts = header.split(',');
+    let maxAge;
+    for (const part of parts) {
+        const [key, value] = part.split('=');
+        if ((key === null || key === void 0 ? void 0 : key.trim()) === 's-maxage') {
+            maxAge = value === null || value === void 0 ? void 0 : value.trim();
+        }
+    }
+    if (maxAge) {
+        const result = Number.parseInt(maxAge);
+        return Number.isNaN(result) ? 0 : result;
+    }
+    return 0;
+};
+exports.getMaxAge = getMaxAge;
+const getMultiValueHeaders = (headers) => {
+    const multiValueHeaders = {};
+    for (const key of Object.keys(headers)) {
+        const header = headers[key];
+        if (Array.isArray(header)) {
+            multiValueHeaders[key] = header;
+        }
+        else {
+            multiValueHeaders[key] = [header];
+        }
+    }
+    return multiValueHeaders;
+};
+exports.getMultiValueHeaders = getMultiValueHeaders;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.0.0-beta.11",
+  "version": "4.0.0-beta.12",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "lib/index.js",
   "files": [
@@ -8,10 +8,10 @@
     "manifest.yml"
   ],
   "scripts": {
-    "build:demo": "next build demo",
+    "build:demo": "next build demos/default",
     "cy:open": "cypress open --config-file cypress/config/all.json",
-    "cy:run": "cypress run --config-file ../cypress/config/ci.json",
-    "dev:demo": "next dev demo",
+    "cy:run": "cypress run --config-file ../../cypress/config/ci.json",
+    "dev:demo": "next dev demos/default",
     "format": "run-s format:check-fix:*",
     "format:ci": "run-s format:check:*",
     "format:check-fix:lint": "run-e format:check:lint format:fix:lint",
@@ -26,6 +26,8 @@
     "publish:test": "npm test",
     "test": "run-s build build:demo test:jest",
     "test:jest": "jest",
+    "test:jest:update": "jest --updateSnapshot",
+    "test:update": "run-s build build:demo test:jest:update",
     "prepare": "npm run build",
     "clean": "rimraf lib",
     "build": "tsc",
@@ -72,8 +74,9 @@
   "devDependencies": {
     "@babel/core": "^7.15.8",
     "@babel/preset-env": "^7.15.8",
-    "@netlify/build": "^18.25.2",
-    "@netlify/eslint-config-node": "^3.3.7",
+    "@babel/preset-typescript": "^7.16.0",
+    "@netlify/build": "^19.0.7",
+    "@netlify/eslint-config-node": "^3.3.9",
     "@testing-library/cypress": "^8.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.0.2",
@@ -81,7 +84,7 @@
     "babel-jest": "^27.2.5",
     "cpy": "^8.1.2",
     "cypress": "^9.0.0",
-    "eslint-config-next": "^11.0.0",
+    "eslint-config-next": "^12.0.0",
     "husky": "^4.3.0",
     "jest": "^27.0.0",
     "netlify-plugin-cypress": "^2.2.0",