@netlify/plugin-nextjs 5.3.3-canary-no-cache-fix.0 → 5.3.3

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,6 +135,7 @@ function pLimit(concurrency) {
 }
 
 // src/build/content/prerendered.ts
+var import_semver = __toESM(require_semver(), 1);
 import { encodeBlobKey } from "../../shared/blobkey.js";
 var tracer = wrapTracer(trace.getTracer("Next runtime"));
 var writeCacheEntry = async (route, value, lastModified, ctx) => {
@@ -147,12 +151,22 @@ 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")
   );
@@ -161,7 +175,7 @@ var buildAppCacheValue = async (path) => {
   }
   return {
     kind: "PAGE",
-    html: await readFile(`${path}.html`, "utf-8"),
+    html,
     pageData: rsc,
     ...meta
   };
@@ -182,6 +196,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 +215,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(
@@ -216,7 +236,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

@@ -40,7 +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 { verifyNextVersion } from "../verification.js";
 var tracer = wrapTracer(trace.getTracer("Next runtime"));
 var toPosixPath = (path) => path.split(sep).join(posixSep);
 function isError(error) {
@@ -191,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");

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/verification.js

@@ -46,6 +46,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 +63,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) => {
@@ -80,7 +78,6 @@ Refer to https://ntl.fyi/next-scheduled-bg-function-migration as migration examp
   }
 }
 export {
-  verifyNextVersion,
   verifyNoAdvancedAPIRoutes,
   verifyPublishDir
 };

package/dist/esm-chunks/{package-VUTYVNOL.js → package-7AUBRXLQ.js}

@@ -8,7 +8,7 @@ import "./chunk-OEQOKJGE.js";
 
 // package.json
 var name = "@netlify/plugin-nextjs";
-var version = "5.3.3-canary-no-cache-fix.0";
+var version = "5.3.3";
 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.47.2",
+  "@netlify/build": "^29.48.1",
   "@netlify/edge-bundler": "^12.0.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.4",
-  "@netlify/zip-it-and-ship-it": "^9.34.3",
+  "@netlify/zip-it-and-ship-it": "^9.37.0",
   "@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,6 +21,8 @@ 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;

package/dist/run/handlers/cache.cjs

@@ -95,8 +95,6 @@ var pipeline = (0, import_util.promisify)(import_stream.pipeline);
 
 // src/run/handlers/cache.cts
 var import_constants = require("next/dist/lib/constants.js");
-var import_load_manifest = require("next/dist/server/load-manifest.js");
-var import_normalize_page_path = require("next/dist/shared/lib/page-path/normalize-page-path.js");
 var import_regional_blob_store = require("../regional-blob-store.cjs");
 var import_request_context = require("./request-context.cjs");
 var import_tracer = require("./tracer.cjs");
@@ -157,20 +155,31 @@ var NetlifyCacheHandler = class {
     }
     return restOfRouteValue;
   }
-  injectEntryToPrerenderManifest(key, revalidate) {
+  async injectEntryToPrerenderManifest(key, revalidate) {
     if (this.options.serverDistDir && (typeof revalidate === "number" || revalidate === false)) {
-      const prerenderManifest = (0, import_load_manifest.loadManifest)(
-        (0, import_node_path.join)(this.options.serverDistDir, "..", "prerender-manifest.json")
-      );
-      prerenderManifest.routes[key] = {
-        experimentalPPR: void 0,
-        dataRoute: (0, import_posix.join)("/_next/data", `${(0, import_normalize_page_path.normalizePagePath)(key)}.json`),
-        srcRoute: null,
-        // FIXME: provide actual source route, however, when dynamically appending it doesn't really matter
-        initialRevalidateSeconds: revalidate,
-        // Pages routes do not have a prefetch data route.
-        prefetchDataRoute: void 0
-      };
+      try {
+        const { loadManifest } = await import("next/dist/server/load-manifest.js");
+        const prerenderManifest = loadManifest(
+          (0, import_node_path.join)(this.options.serverDistDir, "..", "prerender-manifest.json")
+        );
+        try {
+          const { normalizePagePath } = await import("next/dist/shared/lib/page-path/normalize-page-path.js");
+          prerenderManifest.routes[key] = {
+            experimentalPPR: void 0,
+            dataRoute: (0, import_posix.join)("/_next/data", `${normalizePagePath(key)}.json`),
+            srcRoute: null,
+            // FIXME: provide actual source route, however, when dynamically appending it doesn't really matter
+            initialRevalidateSeconds: revalidate,
+            // Pages routes do not have a prefetch data route.
+            prefetchDataRoute: void 0
+          };
+        } catch {
+          const { SharedRevalidateTimings } = await import("next/dist/server/lib/incremental-cache/shared-revalidate-timings.js");
+          const sharedRevalidateTimings = new SharedRevalidateTimings(prerenderManifest);
+          sharedRevalidateTimings.set(key, revalidate);
+        }
+      } catch {
+      }
     }
   }
   async get(...args) {
@@ -216,12 +225,24 @@ var NetlifyCacheHandler = class {
         case "PAGE": {
           span.addEvent("PAGE", { lastModified: blob.lastModified });
           const { revalidate, ...restOfPageValue } = blob.value;
-          this.injectEntryToPrerenderManifest(key, revalidate);
+          await this.injectEntryToPrerenderManifest(key, revalidate);
           return {
             lastModified: blob.lastModified,
             value: restOfPageValue
           };
         }
+        case "APP_PAGE": {
+          span.addEvent("APP_PAGE", { lastModified: blob.lastModified });
+          const { revalidate, rscData, ...restOfPageValue } = blob.value;
+          await this.injectEntryToPrerenderManifest(key, revalidate);
+          return {
+            lastModified: blob.lastModified,
+            value: {
+              ...restOfPageValue,
+              rscData: rscData ? import_node_buffer.Buffer.from(rscData, "base64") : void 0
+            }
+          };
+        }
         default:
           span.recordException(new Error(`Unknown cache entry kind: ${blob.value?.kind}`));
       }
@@ -242,6 +263,13 @@ var NetlifyCacheHandler = class {
         revalidate: context.revalidate
       };
     }
+    if (data?.kind === "APP_PAGE") {
+      return {
+        ...data,
+        revalidate: context.revalidate,
+        rscData: data.rscData?.toString("base64")
+      };
+    }
     return data;
   }
   async set(...args) {
@@ -298,7 +326,7 @@ var NetlifyCacheHandler = class {
     let cacheTags = [];
     if (cacheEntry.value?.kind === "FETCH") {
       cacheTags = [...tags, ...softTags];
-    } else if (cacheEntry.value?.kind === "PAGE" || cacheEntry.value?.kind === "ROUTE") {
+    } else if (cacheEntry.value?.kind === "PAGE" || cacheEntry.value?.kind === "APP_PAGE" || cacheEntry.value?.kind === "ROUTE") {
       cacheTags = cacheEntry.value.headers?.[import_constants.NEXT_CACHE_TAGS_HEADER]?.split(",") || [];
     } else {
       return false;

package/dist/run/handlers/tracing.js

@@ -67385,7 +67385,7 @@ var import_semantic_conventions = __toESM(require_src(), 1);
 import { getLogger } from "./request-context.cjs";
 var {
   default: { version, name }
-} = await import("../../esm-chunks/package-VUTYVNOL.js");
+} = await import("../../esm-chunks/package-7AUBRXLQ.js");
 var sdk = new import_sdk_node.NodeSDK({
   resource: new import_resources.Resource({
     [import_semantic_conventions.SEMRESATTRS_SERVICE_NAME]: name,

package/edge-runtime/lib/next-request.ts

@@ -1,6 +1,12 @@
 import type { Context } from '@netlify/edge-functions'
 
-import { addBasePath, normalizeDataUrl, normalizeLocalePath, removeBasePath } from './util.ts'
+import {
+  addBasePath,
+  addTrailingSlash,
+  normalizeDataUrl,
+  normalizeLocalePath,
+  removeBasePath,
+} from './util.ts'
 
 interface I18NConfig {
   defaultLocale: string
@@ -41,43 +47,25 @@ const normalizeRequestURL = (
 ): { url: string; detectedLocale?: string } => {
   const url = new URL(originalURL)
 
-  url.pathname = removeBasePath(url.pathname, nextConfig?.basePath)
-  const didRemoveBasePath = url.toString() !== originalURL
+  let pathname = removeBasePath(url.pathname, nextConfig?.basePath)
 
-  let detectedLocale: string | undefined
-
-  if (nextConfig?.i18n) {
-    const { pathname, detectedLocale: detected } = normalizeLocalePath(
-      url.pathname,
-      nextConfig?.i18n?.locales,
-    )
-    if (!nextConfig?.skipMiddlewareUrlNormalize) {
-      url.pathname = pathname || '/'
-    }
-    detectedLocale = detected
-  }
+  // If it exists, remove the locale from the URL and store it
+  const { detectedLocale } = normalizeLocalePath(pathname, nextConfig?.i18n?.locales)
 
   if (!nextConfig?.skipMiddlewareUrlNormalize) {
     // We want to run middleware for data requests and expose the URL of the
     // corresponding pages, so we have to normalize the URLs before running
     // the handler.
-    url.pathname = normalizeDataUrl(url.pathname)
+    pathname = normalizeDataUrl(pathname)
 
     // Normalizing the trailing slash based on the `trailingSlash` configuration
     // property from the Next.js config.
-    if (nextConfig?.trailingSlash && url.pathname !== '/' && !url.pathname.endsWith('/')) {
-      url.pathname = `${url.pathname}/`
+    if (nextConfig?.trailingSlash) {
+      pathname = addTrailingSlash(pathname)
     }
   }
 
-  if (didRemoveBasePath) {
-    url.pathname = addBasePath(url.pathname, nextConfig?.basePath)
-  }
-
-  // keep the locale in the url for request.nextUrl object
-  if (detectedLocale) {
-    url.pathname = `/${detectedLocale}${url.pathname}`
-  }
+  url.pathname = addBasePath(pathname, nextConfig?.basePath)
 
   return {
     url: url.toString(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "5.3.3-canary-no-cache-fix.0",
+  "version": "5.3.3",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "./dist/index.js",
   "type": "module",
@@ -14,7 +14,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/netlify/next-runtime-minimal.git"
+    "url": "git+https://github.com/netlify/next-runtime.git"
   },
   "keywords": [
     "nextjs",
@@ -24,7 +24,7 @@
   ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/netlify/next-runtime-minimal/issues"
+    "url": "https://github.com/netlify/next-runtime/issues"
   },
-  "homepage": "https://github.com/netlify/next-runtime-minimal#readme"
+  "homepage": "https://github.com/netlify/next-runtime#readme"
 }