@netlify/plugin-nextjs 5.4.0-canary-perf-debug.0 → 5.4.0

package/README.md

@@ -1,6 +1,6 @@
-![Next.js Runtime](https://github.com/netlify/next-runtime/raw/main/next-js-runtime.png)
+![Next.js Runtime](next-js-runtime.png)
 
-# `@netlify/plugin-nextjs`
+# Next.js Runtime
 
 <p align="center">
   <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
@@ -16,3 +16,63 @@ Netlify. You should not normally need to install it yourself, as it is used auto
 builds of Next.js sites. See
 [the docs for using Next.js on Netlify](https://docs.netlify.com/frameworks/next-js/overview/) for
 more details.
+
+Next.js is supported natively on Netlify, and in most cases you will not need to install or
+configure anything. This repo includes the packages used to support Next.js on Netlify.
+
+## Prerequisites
+
+- Next.js 13.5 or later
+- Node.js 18 or later
+- The latest version of the [Netlify CLI](https://docs.netlify.com/cli/get-started/)
+
+## Deploying
+
+If you build on Netlify, the Next.js Runtime will work with no additional configuration.
+
+## Manually installing the Next.js Runtime
+
+The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it
+manually in the following ways:
+
+### From the UI (Recommended)
+
+You can go to the [UI](https://app.netlify.com/plugins/@netlify/plugin-nextjs/install) and choose
+the site to install the Next.js Runtime on. This method is recommended because you will benefit from
+auto-upgrades to important fixes and feature updates.
+
+### From `npm`
+
+```shell
+npm install -D @netlify/plugin-nextjs
+```
+
+...then add the following to your `netlify.toml` file:
+
+```toml
+[[plugins]]
+  package = "@netlify/plugin-nextjs"
+```
+
+This method is recommended if you wish to pin the Next.js Runtime to a specific version.
+
+## v4
+
+If you are using Next.js 10-13.4 or Node.js < 18, you must use v4 of the Next.js Runtime.
+
+If you are still using v4, you can find
+[its README here](https://github.com/netlify/next-runtime/blob/v4/README.md) and the
+[v4 Runtime docs here](https://docs.netlify.com/frameworks/next-js/runtime-v4/overview/).
+
+### Upgrading from v4 to v5
+
+To upgrade from v4 to v5, please visit
+[the v5 documentation](https://docs.netlify.com/frameworks/next-js/overview/).
+
+## Feedback
+
+If you think you have found a bug in Next.js on Netlify,
+[please open an issue](https://github.com/netlify/next-runtime/issues). If you have comments or
+feature requests, [see the discussion board](https://github.com/netlify/next-runtime/discussions)
+
+Please note that v4 will only receive security fixes and critical bug fixes.

package/dist/build/content/prerendered.js

@@ -14,6 +14,9 @@ import {
   init_esm,
   trace
 } from "../../esm-chunks/chunk-GNGHTHMQ.js";
+import {
+  require_semver
+} from "../../esm-chunks/chunk-EFGWM7RS.js";
 import {
   __toESM
 } from "../../esm-chunks/chunk-OEQOKJGE.js";
@@ -132,7 +135,9 @@ function pLimit(concurrency) {
 }
 
 // src/build/content/prerendered.ts
+var import_semver = __toESM(require_semver(), 1);
 import { encodeBlobKey } from "../../shared/blobkey.js";
+import { verifyNoNetlifyForms } from "../verification.js";
 var tracer = wrapTracer(trace.getTracer("Next runtime"));
 var writeCacheEntry = async (route, value, lastModified, ctx) => {
   const path = join(ctx.blobDir, await encodeBlobKey(route));
@@ -147,21 +152,31 @@ var buildPagesCacheValue = async (path) => ({
   kind: "PAGE",
   html: await readFile(`${path}.html`, "utf-8"),
   pageData: JSON.parse(await readFile(`${path}.json`, "utf-8")),
-  postponed: void 0,
   headers: void 0,
   status: void 0
 });
-var buildAppCacheValue = async (path) => {
+var buildAppCacheValue = async (path, shouldUseAppPageKind) => {
   const meta = JSON.parse(await readFile(`${path}.meta`, "utf-8"));
+  const html = await readFile(`${path}.html`, "utf-8");
+  if (shouldUseAppPageKind) {
+    return {
+      kind: "APP_PAGE",
+      html,
+      rscData: await readFile(`${path}.rsc`, "base64").catch(
+        () => readFile(`${path}.prefetch.rsc`, "base64")
+      ),
+      ...meta
+    };
+  }
   const rsc = await readFile(`${path}.rsc`, "utf-8").catch(
     () => readFile(`${path}.prefetch.rsc`, "utf-8")
   );
-  if (!meta.status && rsc.includes("NEXT_NOT_FOUND")) {
+  if (!meta.status && rsc.includes("NEXT_NOT_FOUND") && !meta.headers["x-next-cache-tags"].includes("/@")) {
     meta.status = 404;
   }
   return {
     kind: "PAGE",
-    html: await readFile(`${path}.html`, "utf-8"),
+    html,
     pageData: rsc,
     ...meta
   };
@@ -182,6 +197,9 @@ var copyPrerenderedContent = async (ctx) => {
       await mkdir(ctx.blobDir, { recursive: true });
       const manifest = await ctx.getPrerenderManifest();
       const limitConcurrentPrerenderContentHandling = pLimit(10);
+      const shouldUseAppPageKind = ctx.nextVersion ? (0, import_semver.satisfies)(ctx.nextVersion, ">=15.0.0-canary.13 <15.0.0-d || >15.0.0-rc.0", {
+        includePrerelease: true
+      }) : false;
       await Promise.all(
         Object.entries(manifest.routes).map(
           ([route, meta]) => limitConcurrentPrerenderContentHandling(async () => {
@@ -198,7 +216,10 @@ var copyPrerenderedContent = async (ctx) => {
                 value = await buildPagesCacheValue(join(ctx.publishDir, "server/pages", key));
                 break;
               case meta.dataRoute?.endsWith(".rsc"):
-                value = await buildAppCacheValue(join(ctx.publishDir, "server/app", key));
+                value = await buildAppCacheValue(
+                  join(ctx.publishDir, "server/app", key),
+                  shouldUseAppPageKind
+                );
                 break;
               case meta.dataRoute === null:
                 value = await buildRouteCacheValue(
@@ -209,6 +230,9 @@ var copyPrerenderedContent = async (ctx) => {
               default:
                 throw new Error(`Unrecognized content: ${route}`);
             }
+            if (value.kind === "PAGE" || value.kind === "APP_PAGE") {
+              verifyNoNetlifyForms(ctx, value.html);
+            }
             await writeCacheEntry(key, value, lastModified, ctx);
           })
         )
@@ -216,7 +240,10 @@ var copyPrerenderedContent = async (ctx) => {
       if (existsSync(join(ctx.publishDir, `server/app/_not-found.html`))) {
         const lastModified = Date.now();
         const key = "/404";
-        const value = await buildAppCacheValue(join(ctx.publishDir, "server/app/_not-found"));
+        const value = await buildAppCacheValue(
+          join(ctx.publishDir, "server/app/_not-found"),
+          shouldUseAppPageKind
+        );
         await writeCacheEntry(key, value, lastModified, ctx);
       }
     } catch (error) {

package/dist/build/content/server.js

@@ -28,8 +28,8 @@ import {
   access,
   cp,
   mkdir,
-  readFile,
   readdir,
+  readFile,
   readlink,
   symlink,
   writeFile
@@ -40,8 +40,6 @@ import { join as posixJoin, sep as posixSep } from "node:path/posix";
 var import_fast_glob = __toESM(require_out(), 1);
 var import_semver = __toESM(require_semver(), 1);
 import { RUN_CONFIG } from "../../run/constants.js";
-import { logger } from "../../run/systemlog.cjs";
-import { verifyNextVersion } from "../verification.js";
 var tracer = wrapTracer(trace.getTracer("Next runtime"));
 var toPosixPath = (path) => path.split(sep).join(posixSep);
 function isError(error) {
@@ -192,17 +190,8 @@ var copyNextDependencies = async (ctx) => {
     }
     await Promise.all(promises);
     const serverHandlerRequire = createRequire(posixJoin(ctx.serverHandlerDir, ":internal:"));
-    let nextVersion;
-    try {
-      const { version } = serverHandlerRequire("next/package.json");
-      if (version) {
-        nextVersion = version;
-      }
-    } catch {
-    }
-    if (nextVersion) {
-      verifyNextVersion(ctx, nextVersion);
-      await patchNextModules(ctx, nextVersion, serverHandlerRequire.resolve);
+    if (ctx.nextVersion) {
+      await patchNextModules(ctx, ctx.nextVersion, serverHandlerRequire.resolve);
     }
     try {
       const nextEntryAbsolutePath = serverHandlerRequire.resolve("next");
@@ -215,36 +204,6 @@ var copyNextDependencies = async (ctx) => {
     }
   });
 };
-var writeTagsManifest = async (ctx) => {
-  const manifest = await ctx.getPrerenderManifest();
-  const routes = Object.entries(manifest.routes).map(async ([route, definition]) => {
-    let tags;
-    if (definition.dataRoute?.endsWith(".rsc")) {
-      const path = join(ctx.publishDir, `server/app/${route === "/" ? "/index" : route}.meta`);
-      try {
-        const file = await readFile(path, "utf-8");
-        const meta = JSON.parse(file);
-        tags = meta.headers["x-next-cache-tags"];
-      } catch {
-        if (!definition.dataRoute?.endsWith("/default.rsc")) {
-          logger.log(`Unable to read cache tags for: ${path}`);
-        }
-      }
-    }
-    if (definition.dataRoute?.endsWith(".json")) {
-      tags = `_N_T_${route}`;
-    }
-    if (definition.dataRoute === null) {
-      tags = definition.initialHeaders?.["x-next-cache-tags"];
-    }
-    return [route, tags];
-  });
-  await writeFile(
-    join(ctx.serverHandlerDir, ".netlify/tags-manifest.json"),
-    JSON.stringify(Object.fromEntries(await Promise.all(routes))),
-    "utf-8"
-  );
-};
 var replaceMiddlewareManifest = async (sourcePath, destPath) => {
   await mkdir(dirname(destPath), { recursive: true });
   const data = await readFile(sourcePath, "utf8");
@@ -269,6 +228,5 @@ export {
   copyNextDependencies,
   copyNextServerCode,
   getPatchesToApply,
-  verifyHandlerDirStructure,
-  writeTagsManifest
+  verifyHandlerDirStructure
 };

package/dist/build/content/static.js

@@ -21,10 +21,11 @@ import {
 // src/build/content/static.ts
 init_esm();
 import { existsSync } from "node:fs";
-import { cp, mkdir, rename, rm } from "node:fs/promises";
+import { cp, mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
 import { basename, join } from "node:path";
 var import_fast_glob = __toESM(require_out(), 1);
 import { encodeBlobKey } from "../../shared/blobkey.js";
+import { verifyNoNetlifyForms } from "../verification.js";
 var tracer = wrapTracer(trace.getTracer("Next runtime"));
 var copyStaticContent = async (ctx) => {
   return tracer.withActiveSpan("copyStaticContent", async () => {
@@ -35,12 +36,12 @@ var copyStaticContent = async (ctx) => {
       extglob: true
     });
     try {
+      await mkdir(destDir, { recursive: true });
       await Promise.all(
         paths.filter((path) => !paths.includes(`${path.slice(0, -5)}.json`)).map(async (path) => {
-          await cp(join(srcDir, path), join(destDir, await encodeBlobKey(path)), {
-            recursive: true,
-            force: true
-          });
+          const html = await readFile(join(srcDir, path), "utf-8");
+          verifyNoNetlifyForms(ctx, html);
+          await writeFile(join(destDir, await encodeBlobKey(path)), html, "utf-8");
         })
       );
     } catch (error) {

package/dist/build/functions/server.js

@@ -27,8 +27,7 @@ var import_fast_glob = __toESM(require_out(), 1);
 import {
   copyNextDependencies,
   copyNextServerCode,
-  verifyHandlerDirStructure,
-  writeTagsManifest
+  verifyHandlerDirStructure
 } from "../content/server.js";
 import { SERVER_HANDLER_NAME } from "../plugin-context.js";
 var tracer = wrapTracer(trace.getTracer("Next runtime"));
@@ -128,7 +127,6 @@ var createServerHandler = async (ctx) => {
     await mkdir(join(ctx.serverHandlerDir, ".netlify"), { recursive: true });
     await copyNextServerCode(ctx);
     await copyNextDependencies(ctx);
-    await writeTagsManifest(ctx);
     await copyHandlerDependencies(ctx);
     await writeHandlerManifest(ctx);
     await writePackageMetadata(ctx);

package/dist/build/plugin-context.js

@@ -15,7 +15,9 @@ import {
 var import_semver = __toESM(require_semver(), 1);
 import { existsSync, readFileSync } from "node:fs";
 import { readFile } from "node:fs/promises";
+import { createRequire } from "node:module";
 import { join, relative, resolve } from "node:path";
+import { join as posixJoin } from "node:path/posix";
 import { fileURLToPath } from "node:url";
 var MODULE_DIR = fileURLToPath(new URL(".", import.meta.url));
 var PLUGIN_DIR = join(MODULE_DIR, "../..");
@@ -248,6 +250,22 @@ var PluginContext = class {
   async getRoutesManifest() {
     return JSON.parse(await readFile(join(this.publishDir, "routes-manifest.json"), "utf-8"));
   }
+  #nextVersion = void 0;
+  /**
+   * Get Next.js version that was used to build the site
+   */
+  get nextVersion() {
+    if (this.#nextVersion === void 0) {
+      try {
+        const serverHandlerRequire = createRequire(posixJoin(this.standaloneRootDir, ":internal:"));
+        const { version } = serverHandlerRequire("next/package.json");
+        this.#nextVersion = version;
+      } catch {
+        this.#nextVersion = null;
+      }
+    }
+    return this.#nextVersion;
+  }
   /** Fails a build with a message and an optional error */
   failBuild(message, error) {
     return this.utils.build.failBuild(message, error instanceof Error ? { error } : void 0);

package/dist/build/templates/handler-monorepo.tmpl.js

@@ -1,4 +1,3 @@
-import { enableModuleImportTracing } from '{{cwd}}/.netlify/dist/run/handlers/import-time-debug.cjs'
 import {
   createRequestContext,
   runWithRequestContext,
@@ -11,17 +10,13 @@ process.chdir('{{cwd}}')
 // Set feature flag for regional blobs
 process.env.USE_REGIONAL_BLOBS = '{{useRegionalBlobs}}'
 
-if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL || process.env.NETLIFY_NEXT_PERF_DEBUG) {
-  tracing.start()
-}
-
-if (process.env.NETLIFY_NEXT_PERF_DEBUG) {
-  enableModuleImportTracing()
-}
-
 let cachedHandler
 export default async function (req, context) {
-  const requestContext = createRequestContext(req.headers.get('x-next-debug-logging'))
+  if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL) {
+    tracing.start()
+  }
+
+  const requestContext = createRequestContext(req)
   const tracer = getTracer()
 
   const handlerResponse = await runWithRequestContext(requestContext, () => {

package/dist/build/templates/handler.tmpl.js

@@ -1,4 +1,3 @@
-import { enableModuleImportTracing } from './.netlify/dist/run/handlers/import-time-debug.cjs'
 import {
   createRequestContext,
   runWithRequestContext,
@@ -10,16 +9,11 @@ import tracing from './.netlify/dist/run/handlers/tracing.js'
 // Set feature flag for regional blobs
 process.env.USE_REGIONAL_BLOBS = '{{useRegionalBlobs}}'
 
-if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL || process.env.NETLIFY_NEXT_PERF_DEBUG) {
-  tracing.start()
-}
-
-if (process.env.NETLIFY_NEXT_PERF_DEBUG) {
-  enableModuleImportTracing()
-}
-
 export default async function handler(req, context) {
-  const requestContext = createRequestContext(req.headers.get('x-next-debug-logging'))
+  if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL) {
+    tracing.start()
+  }
+  const requestContext = createRequestContext(req)
   const tracer = getTracer()
 
   const handlerResponse = await runWithRequestContext(requestContext, () => {

package/dist/build/verification.js

@@ -17,6 +17,7 @@ import { existsSync } from "node:fs";
 import { join } from "node:path";
 import { ApiRouteType, getAPIRoutesConfigs } from "./advanced-api-routes.js";
 var SUPPORTED_NEXT_VERSIONS = ">=13.5.0";
+var warnings = /* @__PURE__ */ new Set();
 function verifyPublishDir(ctx) {
   if (!existsSync(ctx.publishDir)) {
     ctx.failBuild(
@@ -46,6 +47,11 @@ function verifyPublishDir(ctx) {
         `Your publish directory does not contain expected Next.js build output. Please make sure you are using Next.js version (${SUPPORTED_NEXT_VERSIONS})`
       );
     }
+    if (ctx.nextVersion && !(0, import_semver.satisfies)(ctx.nextVersion, SUPPORTED_NEXT_VERSIONS, { includePrerelease: true })) {
+      ctx.failBuild(
+        `@netlify/plugin-next@5 requires Next.js version ${SUPPORTED_NEXT_VERSIONS}, but found ${ctx.nextVersion}. Please upgrade your project's Next.js version.`
+      );
+    }
   }
   if (ctx.buildConfig.output === "export") {
     if (!ctx.exportDetail?.success) {
@@ -58,13 +64,6 @@ function verifyPublishDir(ctx) {
     }
   }
 }
-function verifyNextVersion(ctx, nextVersion) {
-  if (!(0, import_semver.satisfies)(nextVersion, SUPPORTED_NEXT_VERSIONS, { includePrerelease: true })) {
-    ctx.failBuild(
-      `@netlify/plugin-next@5 requires Next.js version ${SUPPORTED_NEXT_VERSIONS}, but found ${nextVersion}. Please upgrade your project's Next.js version.`
-    );
-  }
-}
 async function verifyNoAdvancedAPIRoutes(ctx) {
   const apiRoutesConfigs = await getAPIRoutesConfigs(ctx);
   const unsupportedAPIRoutes = apiRoutesConfigs.filter((apiRouteConfig) => {
@@ -79,8 +78,16 @@ Refer to https://ntl.fyi/next-scheduled-bg-function-migration as migration examp
     );
   }
 }
+function verifyNoNetlifyForms(ctx, html) {
+  if (!warnings.has("netlifyForms") && /<form[^>]*?\s(netlify|data-netlify)[=>\s]/.test(html)) {
+    console.warn(
+      "@netlify/plugin-next@5 does not support Netlify Forms. Refer to https://ntl.fyi/next-runtime-forms-migration for migration example."
+    );
+    warnings.add("netlifyForms");
+  }
+}
 export {
-  verifyNextVersion,
   verifyNoAdvancedAPIRoutes,
+  verifyNoNetlifyForms,
   verifyPublishDir
 };

package/dist/esm-chunks/{package-NQYUR3EH.js → package-7DG4KM7X.js}

@@ -8,7 +8,7 @@ import "./chunk-OEQOKJGE.js";
 
 // package.json
 var name = "@netlify/plugin-nextjs";
-var version = "5.4.0-canary-perf-debug.0";
+var version = "5.4.0";
 var description = "Run Next.js seamlessly on Netlify";
 var main = "./dist/index.js";
 var type = "module";
@@ -42,7 +42,7 @@ var scripts = {
 };
 var repository = {
   type: "git",
-  url: "git+https://github.com/netlify/next-runtime-minimal.git"
+  url: "git+https://github.com/netlify/next-runtime.git"
 };
 var keywords = [
   "nextjs",
@@ -52,19 +52,19 @@ var keywords = [
 ];
 var license = "MIT";
 var bugs = {
-  url: "https://github.com/netlify/next-runtime-minimal/issues"
+  url: "https://github.com/netlify/next-runtime/issues"
 };
-var homepage = "https://github.com/netlify/next-runtime-minimal#readme";
+var homepage = "https://github.com/netlify/next-runtime#readme";
 var devDependencies = {
   "@fastly/http-compute-js": "1.1.4",
   "@netlify/blobs": "^7.3.0",
-  "@netlify/build": "^29.42.2",
-  "@netlify/edge-bundler": "^12.0.1",
+  "@netlify/build": "^29.50.1",
+  "@netlify/edge-bundler": "^12.1.1",
   "@netlify/edge-functions": "^2.8.1",
   "@netlify/eslint-config-node": "^7.0.1",
-  "@netlify/functions": "^2.7.0",
-  "@netlify/serverless-functions-api": "^1.18.2",
-  "@netlify/zip-it-and-ship-it": "^9.33.0",
+  "@netlify/functions": "^2.8.0",
+  "@netlify/serverless-functions-api": "^1.18.5",
+  "@netlify/zip-it-and-ship-it": "^9.37.2",
   "@opentelemetry/api": "^1.8.0",
   "@opentelemetry/exporter-trace-otlp-http": "^0.51.0",
   "@opentelemetry/resources": "^1.24.0",
@@ -87,7 +87,7 @@ var devDependencies = {
   memfs: "^4.9.2",
   "mock-require": "^3.0.3",
   msw: "^2.0.7",
-  next: "^14.0.4",
+  next: "^15.0.0-canary.28",
   os: "^0.1.2",
   outdent: "^0.8.0",
   "p-limit": "^5.0.0",

package/dist/run/config.js

@@ -21,17 +21,15 @@ var setRunConfig = (config) => {
   }
   config.experimental = {
     ...config.experimental,
+    // @ts-expect-error incrementalCacheHandlerPath was removed from config type
+    // but we still need to set it for older Next.js versions
     incrementalCacheHandlerPath: cacheHandler
   };
   config.cacheHandler = cacheHandler;
   config.cacheMaxMemorySize = 0;
   process.env.__NEXT_PRIVATE_STANDALONE_CONFIG = JSON.stringify(config);
 };
-var getTagsManifest = async () => {
-  return JSON.parse(await readFile(resolve(PLUGIN_DIR, ".netlify/tags-manifest.json"), "utf-8"));
-};
 export {
   getRunConfig,
-  getTagsManifest,
   setRunConfig
 };