@netlify/plugin-nextjs 4.29.2 → 4.29.3-appdir.0

package/lib/helpers/edge.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.writeEdgeFunctions = exports.writeDevEdgeFunction = exports.cleanupEdgeFunctions = exports.loadMiddlewareManifest = void 0;
+exports.writeEdgeFunctions = exports.writeDevEdgeFunction = exports.cleanupEdgeFunctions = exports.loadAppPathRoutesManifest = exports.loadMiddlewareManifest = void 0;
 /* eslint-disable max-lines */
 const fs_1 = require("fs");
 const path_1 = require("path");
@@ -13,14 +13,15 @@ const fs_extra_1 = require("fs-extra");
 const outdent_1 = require("outdent");
 const config_1 = require("./config");
 const matchers_1 = require("./matchers");
-const loadMiddlewareManifest = (netlifyConfig) => {
-    const middlewarePath = (0, path_1.resolve)(netlifyConfig.build.publish, 'server', 'middleware-manifest.json');
-    if (!(0, fs_1.existsSync)(middlewarePath)) {
-        return null;
+const maybeLoadJson = (path) => {
+    if ((0, fs_1.existsSync)(path)) {
+        return (0, fs_extra_1.readJson)(path);
     }
-    return (0, fs_extra_1.readJson)(middlewarePath);
 };
+const loadMiddlewareManifest = (netlifyConfig) => maybeLoadJson((0, path_1.resolve)(netlifyConfig.build.publish, 'server', 'middleware-manifest.json'));
 exports.loadMiddlewareManifest = loadMiddlewareManifest;
+const loadAppPathRoutesManifest = (netlifyConfig) => maybeLoadJson((0, path_1.resolve)(netlifyConfig.build.publish, 'app-path-routes-manifest.json'));
+exports.loadAppPathRoutesManifest = loadAppPathRoutesManifest;
 /**
  * Convert the Next middleware name into a valid Edge Function name
  */
@@ -35,27 +36,23 @@ import {
 // Deno defines "window", but naughty libraries think this means it's a browser
 delete globalThis.window
 globalThis.process = { env: {...Deno.env.toObject(), NEXT_RUNTIME: 'edge', 'NEXT_PRIVATE_MINIMAL_MODE': '1' } }
+globalThis.EdgeRuntime = "netlify-edge"
 // Next uses "self" as a function-scoped global-like object
 const self = {}
 let _ENTRIES = {}
 
-class Response extends globalThis.Response {
-  constructor(body, init) {
-    super(body, init);
-    // Next.js uses this extension to the Headers API implemented by Cloudflare workerd
-    this.headers.getAll = (name) => {
-      name = name.toLowerCase();
-      if (name !== "set-cookie") {
-        throw new Error("Headers.getAll is only supported for Set-Cookie");
-      }
-      return [...this.headers.entries()]
-        .filter(([key]) => key === name)
-        .map(([, value]) => value);
-    };
-  }
+// Next.js uses this extension to the Headers API implemented by Cloudflare workerd
+if(!('getAll' in Headers.prototype)) {
+  Headers.prototype.getAll = function getAll(name) {
+    name = name.toLowerCase();
+    if (name !== "set-cookie") {
+      throw new Error("Headers.getAll is only supported for Set-Cookie");
+    }
+    return [...this.entries()]
+      .filter(([key]) => key === name)
+      .map(([, value]) => value);
+  };
 }
-
-
 //  Next uses blob: urls to refer to local assets, so we need to intercept these
 const _fetch = globalThis.fetch
 const fetch = async (url, init) => {
@@ -112,7 +109,7 @@ const getMiddlewareBundle = async ({ edgeFunctionDefinition, netlifyConfig, }) =
 };
 const getEdgeTemplatePath = (file) => (0, path_1.join)(__dirname, '..', '..', 'src', 'templates', 'edge', file);
 const copyEdgeSourceFile = ({ file, target, edgeFunctionDir, }) => fs_1.promises.copyFile(getEdgeTemplatePath(file), (0, path_1.join)(edgeFunctionDir, target !== null && target !== void 0 ? target : file));
-const writeEdgeFunction = async ({ edgeFunctionDefinition, edgeFunctionRoot, netlifyConfig, nextConfig, }) => {
+const writeEdgeFunction = async ({ edgeFunctionDefinition, edgeFunctionRoot, netlifyConfig, pageRegexMap, appPathRoutesManifest = {}, nextConfig, cache, }) => {
     const name = sanitizeName(edgeFunctionDefinition.name);
     const edgeFunctionDir = (0, path_1.join)(edgeFunctionRoot, name);
     const bundle = await getMiddlewareBundle({
@@ -140,11 +137,19 @@ const writeEdgeFunction = async ({ edgeFunctionDefinition, edgeFunctionRoot, net
     else {
         matchers.push(...edgeFunctionDefinition.matchers);
     }
+    // If the EF matches a page, it's an app dir page so needs a matcher too
+    // The object will be empty if appDir isn't enabled in the Next config
+    if (pageRegexMap && edgeFunctionDefinition.page in appPathRoutesManifest) {
+        const regexp = pageRegexMap.get(appPathRoutesManifest[edgeFunctionDefinition.page]);
+        if (regexp) {
+            matchers.push({ regexp });
+        }
+    }
     await (0, fs_extra_1.writeJson)((0, path_1.join)(edgeFunctionDir, 'matchers.json'), matchers);
     // We add a defintion for each matching path
     return matchers.map((matcher) => {
         const pattern = (0, matchers_1.stripLookahead)(matcher.regexp);
-        return { function: name, pattern, name: edgeFunctionDefinition.name };
+        return { function: name, pattern, name: edgeFunctionDefinition.name, cache };
     });
 };
 const cleanupEdgeFunctions = ({ INTERNAL_EDGE_FUNCTIONS_SRC = '.netlify/edge-functions', }) => (0, fs_extra_1.emptyDir)(INTERNAL_EDGE_FUNCTIONS_SRC);
@@ -172,7 +177,7 @@ exports.writeDevEdgeFunction = writeDevEdgeFunction;
 /**
  * Writes Edge Functions for the Next middleware
  */
-const writeEdgeFunctions = async (netlifyConfig) => {
+const writeEdgeFunctions = async ({ netlifyConfig, routesManifest, }) => {
     const manifest = {
         functions: [],
         version: 1,
@@ -219,13 +224,22 @@ const writeEdgeFunctions = async (netlifyConfig) => {
         // Older versions of the manifest format don't have the functions field
         // No, the version field was not incremented
         if (typeof middlewareManifest.functions === 'object') {
+            // When using the app dir, we also need to check if the EF matches a page
+            const appPathRoutesManifest = await (0, exports.loadAppPathRoutesManifest)(netlifyConfig);
+            const pageRegexMap = new Map([...(routesManifest.dynamicRoutes || []), ...(routesManifest.staticRoutes || [])].map((route) => [
+                route.page,
+                route.regex,
+            ]));
             for (const edgeFunctionDefinition of Object.values(middlewareManifest.functions)) {
                 usesEdge = true;
                 const functionDefinitions = await writeEdgeFunction({
                     edgeFunctionDefinition,
                     edgeFunctionRoot,
                     netlifyConfig,
+                    pageRegexMap,
+                    appPathRoutesManifest,
                     nextConfig,
+                    cache: 'manual',
                 });
                 manifest.functions.push(...functionDefinitions);
             }

package/lib/helpers/files.js

@@ -70,7 +70,6 @@ exports.getMiddleware = getMiddleware;
 const moveStaticPages = async ({ netlifyConfig, target, i18n, basePath, }) => {
     console.log('Moving static page files to serve from CDN...');
     const outputDir = (0, pathe_1.join)(netlifyConfig.build.publish, target === 'server' ? 'server' : 'serverless');
-    const root = (0, pathe_1.join)(outputDir, 'pages');
     const buildId = (0, fs_extra_1.readFileSync)((0, pathe_1.join)(netlifyConfig.build.publish, 'BUILD_ID'), 'utf8').trim();
     const dataDir = (0, pathe_1.join)('_next', 'data', buildId);
     await (0, fs_extra_1.ensureDir)((0, pathe_1.join)(netlifyConfig.build.publish, dataDir));
@@ -92,14 +91,17 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, basePath, }) => {
             }
         }
     });
-    const files = [];
+    let fileCount = 0;
     const filesManifest = {};
     const moveFile = async (file) => {
+        // Strip the initial 'app' or 'pages' directory from the output path
+        const pathname = file.split('/').slice(1).join('/');
+        // .rsc data files go next to the html file
         const isData = file.endsWith('.json');
-        const source = (0, pathe_1.join)(root, file);
-        const targetFile = isData ? (0, pathe_1.join)(dataDir, file) : file;
+        const source = (0, pathe_1.join)(outputDir, file);
+        const targetFile = isData ? (0, pathe_1.join)(dataDir, pathname) : pathname;
         const targetPath = basePath ? (0, pathe_1.join)(basePath, targetFile) : targetFile;
-        files.push(file);
+        fileCount += 1;
         filesManifest[file] = targetPath;
         const dest = (0, pathe_1.join)(netlifyConfig.build.publish, targetPath);
         try {
@@ -110,8 +112,8 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, basePath, }) => {
         }
     };
     // Move all static files, except error documents and nft manifests
-    const pages = await (0, globby_1.default)(['**/*.{html,json}', '!**/(500|404|*.js.nft).{html,json}'], {
-        cwd: root,
+    const pages = await (0, globby_1.default)(['{app,pages}/**/*.{html,json,rsc}', '!**/(500|404|*.js.nft).{html,json}'], {
+        cwd: outputDir,
         dot: true,
     });
     const matchingMiddleware = new Set();
@@ -149,7 +151,7 @@ const moveStaticPages = async ({ netlifyConfig, target, i18n, basePath, }) => {
         return limit(moveFile, filePath);
     });
     await Promise.all(promises);
-    console.log(`Moved ${files.length} files`);
+    console.log(`Moved ${fileCount} files`);
     if (matchedPages.size !== 0) {
         console.log((0, chalk_1.yellowBright)((0, outdent_1.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.

package/lib/helpers/functions.js

@@ -20,10 +20,13 @@ const utils_1 = require("./utils");
 const generateFunctions = async ({ FUNCTIONS_SRC = constants_1.DEFAULT_FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC, PUBLISH_DIR }, appDir, apiRoutes) => {
     const publish = (0, pathe_1.resolve)(PUBLISH_DIR);
     const functionsDir = (0, pathe_1.resolve)(INTERNAL_FUNCTIONS_SRC || FUNCTIONS_SRC);
-    console.log({ functionsDir });
     const functionDir = (0, pathe_1.join)(functionsDir, constants_1.HANDLER_FUNCTION_NAME);
     const publishDir = (0, pathe_1.relative)(functionDir, publish);
     for (const { route, config, compiled } of apiRoutes) {
+        // Don't write a lambda if the runtime is edge
+        if (config.runtime === 'experimental-edge') {
+            continue;
+        }
         const apiHandlerSource = await (0, getApiHandler_1.getApiHandler)({
             page: route,
             config,

package/lib/index.js

@@ -44,7 +44,7 @@ const plugin = {
         }
         const { publish } = netlifyConfig.build;
         (0, verification_1.checkNextSiteHasBuilt)({ publish, failBuild });
-        const { appDir, basePath, i18n, images, target, ignore, trailingSlash, outdir, experimental } = await (0, config_1.getNextConfig)({
+        const { appDir, basePath, i18n, images, target, ignore, trailingSlash, outdir, experimental, routesManifest } = await (0, config_1.getNextConfig)({
             publish,
             failBuild,
         });
@@ -118,7 +118,7 @@ const plugin = {
             buildId,
             apiRoutes,
         });
-        await (0, edge_1.writeEdgeFunctions)(netlifyConfig);
+        await (0, edge_1.writeEdgeFunctions)({ netlifyConfig, routesManifest });
     },
     async onPostBuild({ netlifyConfig: { build: { publish }, redirects, headers, }, utils: { status, cache, functions, build: { failBuild }, }, constants: { FUNCTIONS_DIST }, }) {
         await (0, cache_1.saveCache)({ cache, publish });
@@ -134,11 +134,14 @@ const plugin = {
         await (0, verification_1.checkForOldFunctions)({ functions });
         await (0, verification_1.checkZipSize)((0, path_1.join)(FUNCTIONS_DIST, `${constants_1.ODB_FUNCTION_NAME}.zip`));
         const nextConfig = await (0, config_1.getNextConfig)({ publish, failBuild });
-        const { basePath, appDir } = nextConfig;
+        const { basePath, appDir, experimental } = nextConfig;
         (0, config_1.generateCustomHeaders)(nextConfig, headers);
         (0, verification_1.warnForProblematicUserRewrites)({ basePath, redirects });
         (0, verification_1.warnForRootRedirects)({ appDir });
         await (0, functions_1.warnOnApiRoutes)({ FUNCTIONS_DIST });
+        if (experimental === null || experimental === void 0 ? void 0 : experimental.appDir) {
+            console.log('🧪 Thank you for testing "appDir" support on Netlify. For known issues and to give feedback, visit https://ntl.fyi/next-13-feedback');
+        }
     },
 };
 // The types haven't been updated yet

package/lib/templates/getApiHandler.js

@@ -105,7 +105,7 @@ const getApiHandler = ({ page, config, publishDir = '../../../.next', appDir = '
   const { config }  = require("${publishDir}/required-server-files.json")
   let staticManifest
   const path = require("path");
-  const pageRoot = path.resolve(path.join(__dirname, "${publishDir}", "serverless", "pages"));
+  const pageRoot = path.resolve(path.join(__dirname, "${publishDir}", "server"));
   const handler = (${makeHandler.toString()})(config, "${appDir}", pageRoot, ${JSON.stringify(page)})
   exports.handler = ${config.type === "experimental-scheduled" /* ApiRouteType.SCHEDULED */ ? `schedule(${JSON.stringify(config.schedule)}, handler);` : 'handler'}
 `;

package/lib/templates/getHandler.js

@@ -37,9 +37,7 @@ const makeHandler = (conf, app, pageRoot, staticManifest = [], mode = 'ssr') =>
     for (const [key, value] of Object.entries(conf.env)) {
         process.env[key] = String(value);
     }
-    // Set during the request as it needs the host header. Hoisted so we can define the function once
-    let base;
-    augmentFsModule({ promises, staticManifest, pageRoot, getBase: () => base });
+    augmentFsModule({ promises, staticManifest, pageRoot });
     // We memoize this because it can be shared between requests, but don't instantiate it until
     // the first request because we need the host and port.
     let bridge;
@@ -49,9 +47,6 @@ const makeHandler = (conf, app, pageRoot, staticManifest = [], mode = 'ssr') =>
         }
         const url = new URL(event.rawUrl);
         const port = Number.parseInt(url.port) || 80;
-        const { host } = event.headers;
-        const protocol = event.headers['x-forwarded-proto'] || 'http';
-        base = `${protocol}://${host}`;
         const NextServer = getNextServer();
         const nextServer = new NextServer({
             conf,
@@ -149,7 +144,7 @@ const getHandler = ({ isODB = false, publishDir = '../../../.next', appDir = '..
     staticManifest = require("${publishDir}/static-manifest.json")
   } catch {}
   const path = require("path");
-  const pageRoot = path.resolve(path.join(__dirname, "${publishDir}", config.target === "server" ? "server" : "serverless", "pages"));
+  const pageRoot = path.resolve(path.join(__dirname, "${publishDir}", "server"));
   exports.handler = ${isODB
     ? `builder((${makeHandler.toString()})(config, "${appDir}", pageRoot, staticManifest, 'odb'));`
     : `(${makeHandler.toString()})(config, "${appDir}", pageRoot, staticManifest, 'ssr');`}

package/lib/templates/handlerUtils.js

@@ -75,7 +75,7 @@ exports.getMultiValueHeaders = getMultiValueHeaders;
 /**
  * Monkey-patch the fs module to download missing files from the CDN
  */
-const augmentFsModule = ({ promises, staticManifest, pageRoot, getBase, }) => {
+const augmentFsModule = ({ promises, staticManifest, pageRoot, }) => {
     // Only do this if we have some static files moved to the CDN
     if (staticManifest.length === 0) {
         return;
@@ -93,22 +93,23 @@ const augmentFsModule = ({ promises, staticManifest, pageRoot, getBase, }) => {
     const statsOrig = promises.stat;
     // ...then money-patch it to see if it's requesting a CDN file
     promises.readFile = (async (file, options) => {
-        const base = getBase();
+        // In production use the public URL (e.g. https://example.com). Otherwise use the deploy URL, e.g. https://deploy-preview-123--example.netlify.app
+        const baseUrl = process.env.CONTEXT === 'production' ? process.env.URL : process.env.DEPLOY_PRIME_URL;
         // We only care about page files
         if (file.startsWith(pageRoot)) {
-            // We only want the part after `pages/`
+            // We only want the part after `.next/server/`
             const filePath = file.slice(pageRoot.length + 1);
             // Is it in the CDN and not local?
             if (staticFiles.has(filePath) && !(0, fs_1.existsSync)(file)) {
                 // This name is safe to use, because it's one that was already created by Next
                 const cacheFile = path_1.default.join(cacheDir, filePath);
-                const url = `${base}/${staticFiles.get(filePath)}`;
+                const url = `${baseUrl}/${staticFiles.get(filePath)}`;
                 // If it's already downloading we can wait for it to finish
                 if (downloadPromises.has(url)) {
                     await downloadPromises.get(url);
                 }
                 // Have we already cached it? We download every time if running locally to avoid staleness
-                if ((!(0, fs_1.existsSync)(cacheFile) || process.env.NETLIFY_DEV) && base) {
+                if ((!(0, fs_1.existsSync)(cacheFile) || process.env.NETLIFY_DEV) && baseUrl) {
                     await promises.mkdir(path_1.default.dirname(cacheFile), { recursive: true });
                     try {
                         // Append the path to our host and we can load it like a regular page
@@ -129,7 +130,7 @@ const augmentFsModule = ({ promises, staticManifest, pageRoot, getBase, }) => {
     promises.stat = ((file, options) => {
         // We only care about page files
         if (file.startsWith(pageRoot)) {
-            // We only want the part after `pages/`
+            // We only want the part after `.next/server`
             const cacheFile = path_1.default.join(cacheDir, file.slice(pageRoot.length + 1));
             if ((0, fs_1.existsSync)(cacheFile)) {
                 return statsOrig(cacheFile, options);

package/lib/templates/ipx.js

@@ -10,4 +10,4 @@ exports.handler = (0, ipx_1.createIPXHandler)({
     remotePatterns: imageconfig_json_1.remotePatterns,
     responseHeaders: imageconfig_json_1.responseHeaders,
 });
-/* eslint-enable n/no-missing-import, import/no-unresolved, @typescript-eslint/ban-ts-comment  */
+/* eslint-enable import/no-unresolved, @typescript-eslint/ban-ts-comment  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.29.2",
+  "version": "4.29.3-appdir.0",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "index.js",
   "files": [
@@ -36,7 +36,7 @@
   },
   "devDependencies": {
     "@delucis/if-env": "^1.1.2",
-    "@netlify/build": "^28.2.2",
+    "@netlify/build": "^28.4.4",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",
     "@types/merge-stream": "^1.1.2",

package/src/templates/edge/runtime.ts

@@ -13,6 +13,12 @@ export interface FetchEventResult {
   waitUntil: Promise<any>
 }
 
+export interface I18NConfig {
+  defaultLocale: string
+  localeDetection?: false
+  locales: string[]
+}
+
 export interface RequestData {
   geo?: {
     city?: string
@@ -27,7 +33,7 @@ export interface RequestData {
   method: string
   nextConfig?: {
     basePath?: string
-    i18n?: Record<string, unknown>
+    i18n?: I18NConfig | null
     trailingSlash?: boolean
   }
   page?: {