@netlify/plugin-nextjs 4.41.3 → 5.0.0-beta.1

package/README.md

@@ -1,17 +1,61 @@
-![Next.js Runtime](https://github.com/netlify/next-runtime/raw/main/next-js-runtime.png)
-
-# `@netlify/plugin-nextjs`
-
-<p align="center">
-  <a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
-    <img alt="" src="https://img.shields.io/npm/v/@netlify/plugin-nextjs">
-  </a>
-  <a aria-label="MIT License" href="https://img.shields.io/npm/l/@netlify/plugin-nextjs">
-    <img alt="" src="https://img.shields.io/npm/l/@netlify/plugin-nextjs">
-  </a>
-</p>
-
-This package handles the build process for Next.js sites on Netlify. You should not normally need to install it
-yourself, as it is used automatically during builds of Next.js sites. See
-[the docs for using Next.js on Netlify](https://docs.netlify.com/integrations/frameworks/next-js/overview/) for more
-details.
+# Next.js Runtime
+
+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.
+
+## Testing
+
+### Integration testing
+
+How to add new integration test scenarios to the application:
+
+1. Create a new folder under `tests/fixtures/<your-name>`
+2. Adapt the `next.config.js` to be a standalone application
+3. Create a `postinstall` script that runs the `next build`. It's important to notice that the
+   integration tests rely on a already built next.js application in this folder. They rely on the
+   `.next` folder.
+4. Add your test
+
+> Currently the tests require a built version of the `dist/run/handlers/cache.cjs` so you need to
+> run `npm run build` before executing the integration tests. In addition, the integration tests
+> need to be prepared before first use. You can do this by running `npm run pretest`.
+
+### E2E testing
+
+> **Prerequisite**
+>
+> Needs the `netlify-cli` installed and being logged in having access to Netlify Testing
+> Organization
+
+The e2e tests can be invoked with `npm run e2e` and perform a full e2e test. This means they do the
+following:
+
+1. Building the next-runtime (just running `npm run build` in the repository)
+2. Creating a temp directory and copying the provided fixture over to the directory.
+3. Packing the runtime with `npm pack` to the temp directory.
+4. Installing the runtime from the created zip artifact of `npm pack` (this is like installing a
+   node_module from the registry)
+5. Creating a `netlify.toml` inside the temp directory of the fixture and adding the runtime as a
+   plugin.
+6. Running `netlify deploy --build` invoking the runtime. This will use the
+   [next-runtime-testing](https://app.netlify.com/sites/next-runtime-testing/overview) as site to
+   deploy to.
+7. Using the `deployId` and `url` of the deployed site to run some
+   [playwright](https://playwright.dev/) tests against, asserting the correctness of the runtime.
+8. After the tests where run successfully, it will delete the deployment again and clean everything
+   up. In case of a failure, the deploy won't be cleaned up to leave it for troubleshooting
+   purposes.
+
+> [!TIP] If you'd like to always keep the deployment and the local fixture around for
+> troubleshooting, run `E2E_PERSIST=1 npm run e2e`.
+
+#### cleanup old deploys
+
+To cleanup old and dangling deploys from failed builds you can run the following script:
+
+```bash
+npx tsx ./tools/e2e/cleanup-deploys.ts
+```
+
+This will cleanup all created deploys on the
+[next-runtime-testing](https://app.netlify.com/sites/next-runtime-testing/overview) site.

package/dist/build/cache.js

@@ -0,0 +1,15 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  restoreBuildCache,
+  saveBuildCache
+} from "../esm-chunks/chunk-GGHAQM5D.js";
+import "../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  restoreBuildCache,
+  saveBuildCache
+};

package/dist/build/content/prerendered.js

@@ -0,0 +1,16 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  copyFetchContent,
+  copyPrerenderedContent
+} from "../../esm-chunks/chunk-G3GM7JNF.js";
+import "../../esm-chunks/chunk-AVWFCGVE.js";
+import "../../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  copyFetchContent,
+  copyPrerenderedContent
+};

package/dist/build/content/server.js

@@ -0,0 +1,18 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  copyNextDependencies,
+  copyNextServerCode,
+  writeTagsManifest
+} from "../../esm-chunks/chunk-A22224GM.js";
+import "../../esm-chunks/chunk-AVWFCGVE.js";
+import "../../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  copyNextDependencies,
+  copyNextServerCode,
+  writeTagsManifest
+};

package/dist/build/content/static.js

@@ -0,0 +1,20 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  copyStaticAssets,
+  copyStaticContent,
+  publishStaticDir,
+  unpublishStaticDir
+} from "../../esm-chunks/chunk-Z7ZMLVTM.js";
+import "../../esm-chunks/chunk-AVWFCGVE.js";
+import "../../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  copyStaticAssets,
+  copyStaticContent,
+  publishStaticDir,
+  unpublishStaticDir
+};

package/dist/build/functions/edge.js

@@ -0,0 +1,14 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  createEdgeHandlers
+} from "../../esm-chunks/chunk-UXLNY5XK.js";
+import "../../esm-chunks/chunk-VP3PT3VV.js";
+import "../../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  createEdgeHandlers
+};

package/dist/build/functions/server.js

@@ -0,0 +1,16 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  createServerHandler
+} from "../../esm-chunks/chunk-NOX2JUQZ.js";
+import "../../esm-chunks/chunk-A22224GM.js";
+import "../../esm-chunks/chunk-AVWFCGVE.js";
+import "../../esm-chunks/chunk-VP3PT3VV.js";
+import "../../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  createServerHandler
+};

package/dist/build/plugin-context.js

@@ -0,0 +1,17 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+import {
+  EDGE_HANDLER_NAME,
+  PluginContext,
+  SERVER_HANDLER_NAME
+} from "../esm-chunks/chunk-VP3PT3VV.js";
+import "../esm-chunks/chunk-RSKIKBZH.js";
+export {
+  EDGE_HANDLER_NAME,
+  PluginContext,
+  SERVER_HANDLER_NAME
+};

package/dist/esm-chunks/chunk-4AJYXTWN.js

@@ -0,0 +1,17 @@
+
+      const require = await (async () => {
+        const { createRequire } = await import("node:module");
+        return createRequire(import.meta.url);
+      })();
+    
+
+// src/run/constants.ts
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+var MODULE_DIR = fileURLToPath(new URL(".", import.meta.url));
+var PLUGIN_DIR = resolve(`${MODULE_DIR}../..`);
+
+export {
+  MODULE_DIR,
+  PLUGIN_DIR
+};