Files
cloudflare__vinext/tests/prerender.test.ts
T
Nathan Nguyen a3d2f92152 fix(router): honor hybrid pages route priority (#1997)
* fix(router): honor hybrid pages route priority

* fix(router): share hybrid owner decision with client navigation

PR #1997 fixed the server-side route ownership for direct document loads,
but the same invariant broke for client-side soft navigations and the
matching prefetch path:

- navigateClientSide() always delegated to the App runtime's RSC fetch,
  even when the Pages route had higher priority. renderPagesFallback()
  short-circuits RSC requests with null, so the App catch-all won.
- prefetchUrl() prefetched an RSC stream for any URL that matched an App
  route, again ignoring Pages ownership.
- The Pages entry was loaded on every hybrid request, even when a static
  App route had already matched (Pages can never win in that case).

Expose the Pages route manifest on the client via a new
__VINEXT_PAGES_LINK_PREFETCH_ROUTES__ window global emitted by both the
App and Pages browser entries. The link shim consults a shared
resolveHybridClientRouteOwner helper that mirrors the server-side
pagesRouteHasPriorityOverAppRoute comparison. When Pages owns the URL,
the click handler issues a window.location navigation and the prefetch
path returns early.

Gate the renderPagesFallback call behind a static-App-route check in
handleAppRscRequest: when a static App route matches, the bridge
cannot win, so skip the eager Pages entry load. Centralise the
comparison in a new resolveHybridRouteOwner helper so server and
client reach the same answer for the same (URL, route pair).

Adds the missing client-navigation coverage to the use-params e2e
fixture (Link from /app/ to /pages-dir/foobar) and unit tests for
the shared owner decision.

* fix(router): mirror server hybrid owner decision on the client

PR review flagged two split-brain bugs in the previous hybrid
ownership fix: a hand-copied client comparator and a Link-only
ownership gate that left programmatic App Router navigations on
the wrong path.

The hand-copied routePrecedence in hybrid-client-route-owner.ts
omitted the static-prefix reduction that lives in
routing/utils.ts#routePrecedence, and used a strict-less-than
comparison that returned App for identical dynamic patterns. The
server returns Pages for both cases (Pages providers sort ahead
of App providers, and routePrecedence subtracts 50 per static
prefix segment). The split produced a real ownership disagreement
on overlapping patterns like /_sites/:slug* (Pages) vs /:slug*
(App).

Add a shared compareHybridRoutePatterns to routing/utils.ts as
the single source of truth: the static/dynamic short-circuits plus
a sortRoutes call (which carries the static-prefix reduction and
the Pages-first equal-pattern tiebreak). The server
pagesRouteHasPriorityOverAppRoute and the client
resolveHybridClientRouteOwner both delegate to it, so they
cannot diverge. Drop the hand-copied routePrecedence entirely.

Wire the ownership check at the App navigation runtime boundary
so useRouter().push, useRouter().replace, gesturePush, and form
submits all get the same hard-nav contract as the Link click
handler. Specifically:

- navigateClientSide: after same-origin normalization, if Pages
  owns the URL, hard-navigate via window.location and return
  (matching the existing external-URL branch).
- _appRouter.prefetch: short-circuit RSC URL construction for
  Pages-owned targets so we do not warm an unusable cache entry.

Centralise the existing two inline hard-nav branches in
navigateClientSide into a hardNavigateTo helper for clarity.

Tests:

- Direct unit tests for compareHybridRoutePatterns covering
  identical-dynamic tiebreak, static-prefix dynamic overlap,
  static-prefix catch-all overlap, and infix-static bonus.
- Direct unit tests for resolveHybridClientRouteOwner mirroring
  the server assertions plus a basePath-stripping test.
- e2e: useRouter().push('/pages-dir/foobar') from an App page
  resolves to the Pages document.
- e2e: useRouter().prefetch('/pages-dir/foobar') issues zero
  RSC requests for the target URL.

* docs(router): fix stale score in static-prefix catch-all test comment

The hand-copied comparator note quoted the dynamic-segment scores
(51 / 1000) for the optional-catch-all example (/_sites/:slug*
vs /:slug*). The current optional-catch-all scoring actually
produces 1951 vs 2000. The test assertion was correct; only the
comment was stale.

* test(use-params): fix direct-load single dynamic param to use /a instead of /a/b

* fix(router): compare hybrid routes structurally

* fix(router): reject hybrid route conflicts

* fix(router): refresh hybrid route ownership

* fix(router): preserve hybrid routing lifecycle

* fix(router): recheck pages routes after rewrites

* fix(router): preserve rewritten pages queries

* fix(router): preserve rewritten route ownership

* fix(router): resolve client rewrites sequentially

* fix(router): apply rewrite phases sequentially

* fix(router): preserve rewrite params and endpoints

* fix(router): hand off endpoint navigations

* fix(router): preserve rewrite fragment params

* test(e2e): avoid hybrid fixture route conflicts

* test(pages): await async config validation

* test(hybrid): avoid duplicate page fixtures

* chore(router): clarify hybrid priority semantics

* refactor(router): remove duplicate app route matcher

* docs(router): clarify client hybrid comparator

---------

Co-authored-by: James <james@eli.cx>
2026-06-15 00:22:00 +01:00

1751 lines
67 KiB
TypeScript

/**
* Prerender phase tests.
*
* Tests assert the **structural output** of prerendering — which routes were
* rendered, which were skipped, which errored, and what files were produced.
* Tests do NOT assert on raw HTML content (that belongs to E2E/Playwright).
*
* Both `prerenderPages()` and `prerenderApp()` are tested against the
* `pages-basic` and `app-basic` fixtures respectively.
*/
import { describe, it, expect, beforeAll, afterAll } from "vite-plus/test";
import fs from "node:fs";
import { createServer, type Server } from "node:http";
import os from "node:os";
import path from "node:path";
import { buildPagesFixture, buildAppFixture, buildCloudflareAppFixture } from "./helpers.js";
import {
extractRscPayloadFromPrerenderedHtml,
resolveParentParams,
type PrerenderRouteResult,
type StaticParamsMap,
} from "../packages/vinext/src/build/prerender.js";
import { safeJsonStringify } from "../packages/vinext/src/server/html.js";
import type { AppRoute } from "../packages/vinext/src/routing/app-router.js";
const PAGES_FIXTURE = path.resolve(import.meta.dirname, "./fixtures/pages-basic");
const APP_FIXTURE = path.resolve(import.meta.dirname, "./fixtures/app-basic");
const CF_FIXTURE = path.resolve(import.meta.dirname, "./fixtures/cf-app-basic");
// ─── Helper ──────────────────────────────────────────────────────────────────
function tmpDir(prefix: string): string {
return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
}
function findRoute(
results: PrerenderRouteResult[],
route: string,
): PrerenderRouteResult | undefined {
return results.find((r) => r.route === route || ("path" in r && r.path === route));
}
function listen(server: Server): Promise<number> {
return new Promise((resolve, reject) => {
server.on("error", reject);
server.listen(0, "127.0.0.1", () => {
const address = server.address();
if (typeof address === "object" && address !== null) {
resolve(address.port);
} else {
reject(new Error("test server did not expose a TCP port"));
}
});
});
}
function closeServer(server: Server): Promise<void> {
return new Promise((resolve, reject) => {
server.close((error) => {
if (error) reject(error);
else resolve();
});
});
}
const RSC_RUNTIME_BOOTSTRAP_EXPRESSION =
'((self[Symbol.for("vinext.navigationRuntime")]??={bootstrap:{routeManifest:null},functions:{}}).bootstrap.rsc??={rsc:[]})';
function runtimeRscChunkScript(chunk: string | [3, string]): string {
return `<script>${RSC_RUNTIME_BOOTSTRAP_EXPRESSION}.rsc.push(${safeJsonStringify(chunk)})</script>`;
}
function runtimeRscDoneScript(): string {
return `<script>${RSC_RUNTIME_BOOTSTRAP_EXPRESSION}.done=true</script>`;
}
function legacyRscChunkScript(chunk: string | [3, string]): string {
return (
"<script>self.__VINEXT_RSC_CHUNKS__=self.__VINEXT_RSC_CHUNKS__||[];" +
`self.__VINEXT_RSC_CHUNKS__.push(${safeJsonStringify(chunk)})</script>`
);
}
function legacyRscDoneScript(): string {
return "<script>self.__VINEXT_RSC_DONE__=true</script>";
}
// ─── App Router RSC payload extraction ───────────────────────────────────────
describe("extractRscPayloadFromPrerenderedHtml", () => {
function decodeExtractedPayload(html: string): string | null {
const payload = extractRscPayloadFromPrerenderedHtml(html);
return payload === null ? null : new TextDecoder().decode(payload);
}
it("reconstructs streamed RSC chunks from inline bootstrap scripts", () => {
const chunks = [
'0:D{"name":"layout"}\n',
'1:["$","div",null,{"children":"hello ) world"}]\n',
'2:["$","span",null,{"children":"</script><script>alert(1)</script>"}]\n',
];
const html =
"<html><body>" +
chunks.map((chunk) => runtimeRscChunkScript(chunk)).join("") +
runtimeRscDoneScript() +
"</body></html>";
expect(decodeExtractedPayload(html)).toBe(chunks.join(""));
});
it("keeps parsing legacy streamed RSC chunk scripts", () => {
const chunks = ['0:D{"name":"layout"}\n', '1:["$","div",null,{"children":"legacy"}]\n'];
const html =
"<html><body>" +
chunks.map((chunk) => legacyRscChunkScript(chunk)).join("") +
legacyRscDoneScript() +
"</body></html>";
expect(decodeExtractedPayload(html)).toBe(chunks.join(""));
});
it("reconstructs binary RSC chunks from inline bootstrap scripts", () => {
// Ported from Next.js: test/e2e/app-dir/binary/rsc-binary.test.ts
// https://github.com/vercel/next.js/blob/canary/test/e2e/app-dir/binary/rsc-binary.test.ts
const html =
"<html><body>" +
runtimeRscChunkScript("0:text\n") +
runtimeRscChunkScript([3, "/wABAgM="]) +
runtimeRscDoneScript() +
"</body></html>";
const payload = extractRscPayloadFromPrerenderedHtml(html);
expect(payload).toEqual(
new Uint8Array([...new TextEncoder().encode("0:text\n"), 255, 0, 1, 2, 3]),
);
});
it("throws when the done marker is missing", () => {
const html = "<html><body>" + runtimeRscChunkScript("0:[]\n") + "</body></html>";
expect(() => extractRscPayloadFromPrerenderedHtml(html)).toThrow(/missing RSC done marker/);
});
it("does not treat marker-looking RSC payload text as the done control script", () => {
const html =
"<html><body>" + runtimeRscChunkScript('0:["__VINEXT_RSC_DONE__=true"]\n') + "</body></html>";
expect(() => extractRscPayloadFromPrerenderedHtml(html)).toThrow(/missing RSC done marker/);
});
it("ignores non-chunk runtime scripts that start with the bootstrap expression", () => {
const html =
"<html><body>" +
`<script>${RSC_RUNTIME_BOOTSTRAP_EXPRESSION}.metadata={}</script>` +
runtimeRscChunkScript("0:[]\n") +
runtimeRscDoneScript() +
"</body></html>";
expect(decodeExtractedPayload(html)).toBe("0:[]\n");
});
it("rejects chunk scripts with trailing code after the payload push", () => {
const html =
"<html><body>" +
`<script>${RSC_RUNTIME_BOOTSTRAP_EXPRESSION}.rsc.push(${safeJsonStringify("0:[]\n")})alert(1)</script>` +
runtimeRscDoneScript() +
"</body></html>";
// JSON.parse rejects the slice (which includes the `)` and `alert(1` after
// the JSON-encoded string), so this is reported as malformed JSON rather
// than a separate "trailing code" diagnostic.
expect(() => extractRscPayloadFromPrerenderedHtml(html)).toThrow(
"[vinext] Malformed prerender RSC embed: invalid chunk JSON",
);
});
it("rejects chunk scripts with invalid JSON", () => {
const html =
"<html><body>" +
`<script>${RSC_RUNTIME_BOOTSTRAP_EXPRESSION}.rsc.push("\\uZZZZ")</script>` +
runtimeRscDoneScript() +
"</body></html>";
expect(() => extractRscPayloadFromPrerenderedHtml(html)).toThrow(
"[vinext] Malformed prerender RSC embed: invalid chunk JSON",
);
});
it("returns null when no chunk scripts and no done marker are present (middleware short-circuit)", () => {
// Middleware that returns a custom 200 HTML body bypasses the App Router
// pipeline entirely — no chunks, no done marker. The driver detects this
// null and falls back to a second invocation with `RSC: 1`.
expect(extractRscPayloadFromPrerenderedHtml("<html><body>legacy</body></html>")).toBeNull();
});
it("throws when only the done marker is present without any chunks", () => {
// Half-emitted embed (done marker but no chunks) is a real bug — partial
// emission shouldn't fall back silently.
const html = `<html><body>${runtimeRscDoneScript()}</body></html>`;
expect(() => extractRscPayloadFromPrerenderedHtml(html)).toThrow(
"[vinext] Malformed prerender RSC embed: done marker present without chunk scripts",
);
});
});
describe("prerenderApp — RSC extraction", () => {
it("writes the .rsc file from rendered HTML without a second RSC request", async () => {
const root = tmpDir("vinext-prerender-rsc-dedupe-");
const outDir = path.join(root, "out");
const appDir = path.join(root, "app");
const pagePath = path.join(appDir, "page.tsx");
fs.mkdirSync(appDir, { recursive: true });
fs.writeFileSync(
pagePath,
"export const dynamic = 'force-static';\nexport default function Page() { return null; }\n",
);
const rscPayload = '0:["$","div",null,{"children":"from html"}]\n';
let rscRequestCount = 0;
const server = createServer((req, res) => {
if (req.headers.rsc === "1" || req.headers.accept === "text/x-component") {
rscRequestCount++;
res.statusCode = 500;
res.end("unexpected RSC request");
return;
}
if (req.url === "/__vinext_nonexistent_for_404__") {
res.statusCode = 404;
res.end("<html><body>not found</body></html>");
return;
}
res.setHeader("content-type", "text/html");
res.end(
"<html><body>" +
runtimeRscChunkScript(rscPayload) +
runtimeRscDoneScript() +
"</body></html>",
);
});
const port = await listen(server);
try {
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({});
const prerenderResult = await prerenderApp({
mode: "default",
rscBundlePath: path.join(root, "dist", "server", "index.js"),
routes,
outDir,
config,
_prodServer: { server, port },
});
expect(findRoute(prerenderResult.routes, "/")).toMatchObject({
route: "/",
status: "rendered",
});
expect(fs.readFileSync(path.join(outDir, "index.rsc"), "utf-8")).toBe(rscPayload);
expect(rscRequestCount).toBe(0);
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
});
it("falls back to a second RSC: 1 invocation when middleware short-circuits with custom HTML", async () => {
// Middleware that returns a 200 HTML body bypasses the App Router
// pipeline — the response contains no embed chunks. The driver must
// recover by issuing a second invocation with `RSC: 1` and use whatever
// that returns as the .rsc file.
const root = tmpDir("vinext-prerender-rsc-fallback-");
const outDir = path.join(root, "out");
const appDir = path.join(root, "app");
const pagePath = path.join(appDir, "page.tsx");
fs.mkdirSync(appDir, { recursive: true });
fs.writeFileSync(
pagePath,
"export const dynamic = 'force-static';\nexport default function Page() { return null; }\n",
);
const middlewareHtml = "<html><body>middleware short-circuit</body></html>";
const fallbackRscPayload = '0:["$","div",null,{"children":"from fallback"}]\n';
let pageRequestCount = 0;
let rscRequestCount = 0;
const server = createServer((req, res) => {
const isRsc = req.headers.rsc === "1" || req.headers.accept === "text/x-component";
if (req.url === "/__vinext_nonexistent_for_404__") {
res.statusCode = 404;
res.end("<html><body>not found</body></html>");
return;
}
if (isRsc) {
rscRequestCount++;
res.setHeader("content-type", "text/x-component");
res.end(fallbackRscPayload);
return;
}
// Page request: middleware short-circuits with plain HTML and no
// RSC embed chunks — exercising the fallback path.
pageRequestCount++;
res.setHeader("content-type", "text/html");
res.end(middlewareHtml);
});
const port = await listen(server);
try {
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({});
const prerenderResult = await prerenderApp({
mode: "default",
rscBundlePath: path.join(root, "dist", "server", "index.js"),
routes,
outDir,
config,
_prodServer: { server, port },
});
expect(findRoute(prerenderResult.routes, "/")).toMatchObject({
route: "/",
status: "rendered",
});
// HTML on disk is the middleware response.
expect(fs.readFileSync(path.join(outDir, "index.html"), "utf-8")).toBe(middlewareHtml);
// .rsc on disk is the fallback RSC: 1 response.
expect(fs.readFileSync(path.join(outDir, "index.rsc"), "utf-8")).toBe(fallbackRscPayload);
// Exactly one page request and one RSC fallback request per route.
expect(pageRequestCount).toBe(1);
expect(rscRequestCount).toBe(1);
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
});
it("errors without writing .rsc when the middleware short-circuit fallback RSC request fails", async () => {
const root = tmpDir("vinext-prerender-rsc-fallback-failure-");
const outDir = path.join(root, "out");
const appDir = path.join(root, "app");
const pagePath = path.join(appDir, "page.tsx");
fs.mkdirSync(appDir, { recursive: true });
fs.writeFileSync(
pagePath,
"export const dynamic = 'force-static';\nexport default function Page() { return null; }\n",
);
const middlewareHtml = "<html><body>middleware short-circuit</body></html>";
let pageRequestCount = 0;
let rscRequestCount = 0;
const server = createServer((req, res) => {
const isRsc = req.headers.rsc === "1" || req.headers.accept === "text/x-component";
if (req.url === "/__vinext_nonexistent_for_404__") {
res.statusCode = 404;
res.end("<html><body>not found</body></html>");
return;
}
if (isRsc) {
rscRequestCount++;
res.statusCode = 500;
res.end("fallback failed");
return;
}
pageRequestCount++;
res.setHeader("content-type", "text/html");
res.end(middlewareHtml);
});
const port = await listen(server);
try {
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({});
const prerenderResult = await prerenderApp({
mode: "default",
rscBundlePath: path.join(root, "dist", "server", "index.js"),
routes,
outDir,
config,
_prodServer: { server, port },
});
const route = findRoute(prerenderResult.routes, "/");
expect(route).toMatchObject({
route: "/",
status: "error",
});
if (route?.status !== "error") throw new Error("expected route to fail prerender");
expect(route.error).toContain("[vinext] prerenderApp: RSC fallback returned 500 for /");
expect(fs.existsSync(path.join(outDir, "index.rsc"))).toBe(false);
expect(pageRequestCount).toBe(1);
expect(rscRequestCount).toBe(1);
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
});
});
// ─── Pages Router ─────────────────────────────────────────────────────────────
describe("prerenderPages — default mode (pages-basic)", () => {
let outDir: string;
let results: PrerenderRouteResult[];
beforeAll(async () => {
const pagesBundlePath = await buildPagesFixture(PAGES_FIXTURE);
outDir = tmpDir("vinext-prerender-pages-");
const { prerenderPages } = await import("../packages/vinext/src/build/prerender.js");
const { pagesRouter, apiRouter } =
await import("../packages/vinext/src/routing/pages-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const pagesDir = path.resolve(PAGES_FIXTURE, "pages");
const pageRoutes = await pagesRouter(pagesDir);
const apiRoutes = await apiRouter(pagesDir);
const config = await resolveNextConfig({});
const prerenderResult = await prerenderPages({
mode: "default",
pagesBundlePath,
routes: pageRoutes,
apiRoutes,
pagesDir,
outDir,
config,
});
results = prerenderResult.routes;
}, 60_000);
afterAll(() => {
fs.rmSync(outDir, { recursive: true, force: true });
});
// ── Static pages ───────────────────────────────────────────────────────────
it("renders static index page", () => {
const r = findRoute(results, "/");
expect(r).toMatchObject({
route: "/",
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("index.html");
}
});
it("renders static about page", () => {
const r = findRoute(results, "/about");
expect(r).toMatchObject({ route: "/about", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("about.html");
}
});
it("renders 404 page", () => {
const r = findRoute(results, "/404");
expect(results.filter((result) => result.route === "/404")).toHaveLength(1);
expect(r).toMatchObject({ route: "/404", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("404.html");
}
});
// ── Dynamic routes with getStaticPaths ────────────────────────────────────
it("renders static dynamic routes from getStaticPaths (fallback: false)", () => {
const slugs = ["hello-world", "getting-started"];
for (const slug of slugs) {
const r = findRoute(results, `/blog/${slug}`);
expect(r).toMatchObject({
route: "/blog/:slug",
path: `/blog/${slug}`,
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain(`blog/${slug}.html`);
}
}
});
it("renders dynamic routes from getStaticPaths (fallback: 'blocking')", () => {
const ids = ["1", "2"];
for (const id of ids) {
const r = findRoute(results, `/articles/${id}`);
expect(r).toMatchObject({
route: "/articles/:id",
path: `/articles/${id}`,
status: "rendered",
revalidate: false,
});
}
});
// Next.js accepts both `paths: Array<{ params }>` and `paths: Array<string>`
// from getStaticPaths. The string-path variant is documented at
// https://nextjs.org/docs/pages/api-reference/functions/get-static-paths and
// implemented in .nextjs-ref/packages/next/src/build/static-paths/pages.ts
// (the `typeof entry === 'string'` branch around line 89).
it("renders dynamic routes from getStaticPaths with string paths", () => {
const slugs = ["hello-world", "another-one"];
for (const slug of slugs) {
const r = findRoute(results, `/string-paths/${slug}`);
expect(r).toMatchObject({
route: "/string-paths/:slug",
path: `/string-paths/${slug}`,
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain(`string-paths/${slug}.html`);
}
}
});
// Next.js rejects entries with a missing `params` key — see
// .nextjs-ref/packages/next/src/build/static-paths/pages.ts (around line 169)
// "A required parameter (X) was not provided as a string received undefined"
// We must NOT crash the whole prerender phase on this; surface it as a
// per-route error result, the same shape we use elsewhere.
it("surfaces missing-params entries as a per-route error (does not crash)", () => {
const errored = results.find(
(r) => r.route === "/missing-params/:slug" && r.status === "error",
);
expect(errored).toBeDefined();
if (errored && errored.status === "error") {
expect(errored.error).toMatch(/missing the `params` key|params is undefined/);
}
});
// ── ISR page ───────────────────────────────────────────────────────────────
it("renders ISR page with correct revalidate interval", () => {
const r = findRoute(results, "/isr-test");
expect(r).toMatchObject({ route: "/isr-test", status: "rendered", revalidate: 1 });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("isr-test.html");
}
});
// ── SSR pages — skipped ────────────────────────────────────────────────────
it("skips SSR pages (getServerSideProps) in default mode", () => {
const ssrRoutes = ["/ssr", "/ssr-headers"];
for (const route of ssrRoutes) {
const r = findRoute(results, route);
expect(r).toMatchObject({ route, status: "skipped", reason: "ssr" });
}
});
it("skips getServerSideProps dynamic route in default mode", () => {
// posts/[id] has getServerSideProps — pattern is /posts/:id
const ssrRoute = results.find(
(r) =>
r.status === "skipped" &&
"reason" in r &&
r.reason === "ssr" &&
r.route.startsWith("/posts"),
);
expect(ssrRoute).toBeDefined();
});
// ── API routes — always skipped ────────────────────────────────────────────
it("skips all API routes", () => {
const apiResults = results.filter(
(r) => r.status === "skipped" && "reason" in r && r.reason === "api",
);
expect(apiResults.length).toBeGreaterThan(0);
// hello API is a known API route
const hello = findRoute(results, "/api/hello");
expect(hello).toMatchObject({ route: "/api/hello", status: "skipped", reason: "api" });
});
// ── Written files ──────────────────────────────────────────────────────────
it("writes HTML files to outDir", () => {
expect(fs.existsSync(path.join(outDir, "index.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "about.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "isr-test.html"))).toBe(true);
});
// ── vinext-prerender.json ─────────────────────────────────────────────────
it("writes vinext-prerender.json with correct structure", () => {
const indexPath = path.join(outDir, "vinext-prerender.json");
expect(fs.existsSync(indexPath)).toBe(true);
const index = JSON.parse(fs.readFileSync(indexPath, "utf-8"));
expect(Array.isArray(index.routes)).toBe(true);
// Check a rendered entry
const home = index.routes.find((r: any) => r.route === "/");
expect(home).toMatchObject({ route: "/", status: "rendered", revalidate: false });
// outputFiles not in index (stripped)
expect(home.outputFiles).toBeUndefined();
// Check ISR entry
const isr = index.routes.find((r: any) => r.route === "/isr-test");
expect(isr).toMatchObject({ route: "/isr-test", status: "rendered", revalidate: 1 });
// Check a skipped entry
const ssr = index.routes.find((r: any) => r.route === "/ssr");
expect(ssr).toMatchObject({ route: "/ssr", status: "skipped", reason: "ssr" });
});
});
describe("prerenderPages — export mode (pages-basic)", () => {
let outDir: string;
let results: PrerenderRouteResult[];
beforeAll(async () => {
const pagesBundlePath = await buildPagesFixture(PAGES_FIXTURE);
outDir = tmpDir("vinext-prerender-pages-export-");
const { prerenderPages } = await import("../packages/vinext/src/build/prerender.js");
const { pagesRouter, apiRouter } =
await import("../packages/vinext/src/routing/pages-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const pagesDir = path.resolve(PAGES_FIXTURE, "pages");
const pageRoutes = await pagesRouter(pagesDir);
const apiRoutes = await apiRouter(pagesDir);
const config = await resolveNextConfig({ output: "export" });
const prerenderResult = await prerenderPages({
mode: "export",
pagesBundlePath,
routes: pageRoutes,
apiRoutes,
pagesDir,
outDir,
config,
});
results = prerenderResult.routes;
}, 60_000);
afterAll(() => {
fs.rmSync(outDir, { recursive: true, force: true });
});
it("renders static and ISR routes (ISR treated as static)", () => {
expect(findRoute(results, "/")).toMatchObject({ status: "rendered", revalidate: false });
expect(findRoute(results, "/about")).toMatchObject({ status: "rendered", revalidate: false });
// ISR route in export mode: revalidate ignored → false
expect(findRoute(results, "/isr-test")).toMatchObject({
status: "rendered",
revalidate: false,
});
});
it("errors on SSR pages in export mode", () => {
const ssr = findRoute(results, "/ssr");
expect(ssr).toMatchObject({ status: "error" });
if (ssr?.status === "error") {
expect(ssr.error).toMatch(/getServerSideProps/);
}
});
it("includes stack trace in error when enablePrerenderSourceMaps is true", () => {
// enablePrerenderSourceMaps defaults to true in resolveNextConfig (line 230)
const errorRoute = findRoute(results, "/error-throw");
expect(errorRoute).toMatchObject({ status: "error" });
if (errorRoute?.status === "error") {
// Verify the error includes a stack trace (multiple lines with "at " frames)
expect(errorRoute.error).toMatch(/\n\s+at /);
}
});
});
// ─── App Router ───────────────────────────────────────────────────────────────
describe("prerenderApp — default mode (app-basic)", () => {
let outDir: string;
let results: PrerenderRouteResult[];
beforeAll(async () => {
const rscBundlePath = await buildAppFixture(APP_FIXTURE);
outDir = tmpDir("vinext-prerender-app-");
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const appDir = path.resolve(APP_FIXTURE, "app");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({});
const prerenderResult = await prerenderApp({
mode: "default",
rscBundlePath,
routes,
outDir,
config,
});
results = prerenderResult.routes;
}, 120_000);
afterAll(() => {
fs.rmSync(outDir, { recursive: true, force: true });
});
// ── Static routes with explicit config ────────────────────────────────────
it("renders force-static page", () => {
const r = findRoute(results, "/static-test");
expect(r).toMatchObject({ route: "/static-test", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("static-test.html");
expect(r.outputFiles).toContain("static-test.rsc");
}
});
it("renders revalidate=Infinity page as static", () => {
const r = findRoute(results, "/revalidate-infinity-test");
expect(r).toMatchObject({ status: "rendered", revalidate: false });
});
// ── ISR routes ─────────────────────────────────────────────────────────────
it("renders ISR page with revalidate=1", () => {
const r = findRoute(results, "/isr-test");
expect(r).toMatchObject({ route: "/isr-test", status: "rendered", revalidate: 1 });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("isr-test.html");
expect(r.outputFiles).toContain("isr-test.rsc");
}
});
it("renders ISR page with revalidate=60", () => {
const r = findRoute(results, "/revalidate-test");
expect(r).toMatchObject({ route: "/revalidate-test", status: "rendered", revalidate: 60 });
});
it("uses the rendered cacheLife expire value for App Router ISR prerender entries", () => {
const r = findRoute(results, "/prerender-cache-life");
expect(r).toMatchObject({
route: "/prerender-cache-life",
status: "rendered",
revalidate: 1,
expire: 3,
});
const indexPath = path.join(outDir, "vinext-prerender.json");
const index = JSON.parse(fs.readFileSync(indexPath, "utf-8"));
const manifestRoute = index.routes.find(
(route: { route: string }) => route.route === "/prerender-cache-life",
);
expect(manifestRoute).toMatchObject({ revalidate: 1, expire: 3 });
});
it("infers App Router ISR prerender metadata from cacheLife without route revalidate", () => {
const r = findRoute(results, "/prerender-cache-life-only");
expect(r).toMatchObject({
route: "/prerender-cache-life-only",
status: "rendered",
revalidate: 1,
expire: 3,
});
const indexPath = path.join(outDir, "vinext-prerender.json");
const index = JSON.parse(fs.readFileSync(indexPath, "utf-8"));
const manifestRoute = index.routes.find(
(route: { route: string }) => route.route === "/prerender-cache-life-only",
);
expect(manifestRoute).toMatchObject({ revalidate: 1, expire: 3 });
});
// ── Dynamic routes — skipped ───────────────────────────────────────────────
it("skips force-dynamic page", () => {
const r = findRoute(results, "/dynamic-test");
expect(r).toMatchObject({ route: "/dynamic-test", status: "skipped", reason: "dynamic" });
});
it("skips revalidate=0 page", () => {
const r = findRoute(results, "/revalidate-zero-test");
expect(r).toMatchObject({ status: "skipped", reason: "dynamic" });
});
// ── Dynamic routes with generateStaticParams ───────────────────────────────
it("renders /blog/[slug] expanded paths", () => {
const slugs = ["hello-world", "getting-started", "advanced-guide"];
for (const slug of slugs) {
const r = findRoute(results, `/blog/${slug}`);
expect(r).toMatchObject({
route: "/blog/:slug",
path: `/blog/${slug}`,
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain(`blog/${slug}.html`);
expect(r.outputFiles).toContain(`blog/${slug}.rsc`);
}
}
});
it("renders /products/[id] expanded paths", () => {
for (const id of ["1", "2", "3"]) {
const r = findRoute(results, `/products/${id}`);
expect(r).toMatchObject({
route: "/products/:id",
path: `/products/${id}`,
status: "rendered",
revalidate: false,
});
}
});
it("renders /shop/[category] expanded paths", () => {
for (const category of ["electronics", "clothing"]) {
const r = findRoute(results, `/shop/${category}`);
expect(r).toMatchObject({
route: "/shop/:category",
path: `/shop/${category}`,
status: "rendered",
revalidate: false,
});
}
});
it("renders /shop/[category]/[item] top-down params (nested generateStaticParams)", () => {
const paths = [
"/shop/electronics/phone",
"/shop/electronics/laptop",
"/shop/clothing/shirt",
"/shop/clothing/pants",
];
for (const urlPath of paths) {
const r = findRoute(results, urlPath);
expect(r).toMatchObject({
route: "/shop/:category/:item",
path: urlPath,
status: "rendered",
revalidate: false,
});
}
});
it("skips dynamic routes without generateStaticParams", () => {
// /photos/[id] has no generateStaticParams
const r = results.find(
(r) =>
r.status === "skipped" &&
"reason" in r &&
r.reason === "no-static-params" &&
r.route.startsWith("/photos"),
);
expect(r).toBeDefined();
});
// ── Speculative rendering: unknown routes ──────────────────────────────────
it("renders / speculatively (unknown route with no dynamic APIs)", () => {
const r = findRoute(results, "/");
expect(r).toMatchObject({ route: "/", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("index.html");
expect(r.outputFiles).toContain("index.rsc");
}
});
it("renders /about speculatively", () => {
const r = findRoute(results, "/about");
expect(r).toMatchObject({ route: "/about", status: "rendered", revalidate: false });
});
it("renders /dashboard speculatively", () => {
const r = findRoute(results, "/dashboard");
expect(r).toMatchObject({ route: "/dashboard", status: "rendered", revalidate: false });
});
it("renders layout-only routes whose content comes from parallel slots", () => {
// Ported from Next.js: test/e2e/app-dir/parallel-routes-and-interception/parallel-routes-and-interception.test.ts
// https://github.com/vercel/next.js/blob/canary/test/e2e/app-dir/parallel-routes-and-interception/parallel-routes-and-interception.test.ts
const parent = findRoute(results, "/parallel-nested/home");
expect(parent).toMatchObject({
route: "/parallel-nested/home",
status: "rendered",
revalidate: false,
});
const nested = findRoute(results, "/parallel-nested/home/nested");
expect(nested).toMatchObject({
route: "/parallel-nested/home/nested",
status: "rendered",
revalidate: false,
});
const defaultOnly = findRoute(results, "/slot-collision");
expect(defaultOnly).toMatchObject({
route: "/slot-collision",
status: "rendered",
revalidate: false,
});
});
it("skips /headers-test (unknown route that calls headers())", () => {
const r = findRoute(results, "/headers-test");
// headers-test calls headers() — should be skipped as dynamic
expect(r).toBeDefined();
expect(r?.status).toBe("skipped");
});
// Ported from Next.js: test/e2e/app-dir/rsc-redirect/rsc-redirect.test.ts
// ('should get 307 status code for document request')
//
// A speculative prerender of a route that calls `redirect()` must not
// follow the redirect server-side and cache the destination's HTML under
// the redirecting URL. Doing so makes the prod server reply with 200 and
// the destination's body on every document request to the redirecting
// route, instead of emitting an HTTP 307 with a Location header.
//
// See: https://github.com/cloudflare/vinext/issues/1530
it("skips /redirect-test instead of capturing the destination HTML", () => {
const r = findRoute(results, "/redirect-test");
expect(r).toBeDefined();
expect(r?.status).toBe("skipped");
// No HTML/RSC must be written for the redirecting route — otherwise the
// prod server serves the cached destination body with status 200 for
// every document request to /redirect-test.
expect(fs.existsSync(path.join(outDir, "redirect-test.html"))).toBe(false);
expect(fs.existsSync(path.join(outDir, "redirect-test.rsc"))).toBe(false);
});
// ── API routes — always skipped ────────────────────────────────────────────
it("skips all API route handlers", () => {
const apiSkipped = results.filter(
(r) => r.status === "skipped" && "reason" in r && r.reason === "api",
);
expect(apiSkipped.length).toBeGreaterThan(0);
// Known API routes
const hello = findRoute(results, "/api/hello");
expect(hello).toMatchObject({ status: "skipped", reason: "api" });
});
// ── Written files ──────────────────────────────────────────────────────────
it("writes HTML and RSC files to outDir", () => {
expect(fs.existsSync(path.join(outDir, "index.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "index.rsc"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "static-test.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "static-test.rsc"))).toBe(true);
});
it("writes blog expanded pages to correct paths", () => {
expect(fs.existsSync(path.join(outDir, "blog/hello-world.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "blog/hello-world.rsc"))).toBe(true);
});
// ── vinext-prerender.json ─────────────────────────────────────────────────
it("writes vinext-prerender.json with correct structure", () => {
const indexPath = path.join(outDir, "vinext-prerender.json");
expect(fs.existsSync(indexPath)).toBe(true);
const index = JSON.parse(fs.readFileSync(indexPath, "utf-8"));
expect(Array.isArray(index.routes)).toBe(true);
// Rendered routes present — for dynamic routes the manifest has both route (pattern) and path (concrete URL)
const rendered = index.routes
.filter((r: any) => r.status === "rendered")
.map((r: any) => r.path ?? r.route);
expect(rendered).toContain("/");
expect(rendered).toContain("/blog/hello-world");
expect(rendered).toContain("/blog/getting-started");
expect(rendered).toContain("/blog/advanced-guide");
expect(rendered).toContain("/products/1");
expect(rendered).toContain("/products/2");
expect(rendered).toContain("/products/3");
expect(rendered).toContain("/shop/electronics");
expect(rendered).toContain("/shop/clothing");
expect(rendered).toContain("/shop/electronics/phone");
// ISR route has correct revalidate
const isrTest = index.routes.find((r: any) => r.route === "/isr-test");
expect(isrTest).toMatchObject({ route: "/isr-test", status: "rendered", revalidate: 1 });
// outputFiles not in index
expect(isrTest?.outputFiles).toBeUndefined();
// Skipped route present
const dynamic = index.routes.find((r: any) => r.route === "/dynamic-test");
expect(dynamic).toMatchObject({ route: "/dynamic-test", status: "skipped", reason: "dynamic" });
});
});
// ─── Hybrid: runPrerender with app/ + pages/ ──────────────────────────────────
describe("runPrerender — hybrid app+pages (app-basic)", () => {
let manifestDir: string;
let results: PrerenderRouteResult[];
beforeAll(async () => {
const pagesBundlePath = await buildPagesFixture(APP_FIXTURE);
manifestDir = tmpDir("vinext-prerender-hybrid-");
// runPrerender writes files to real paths derived from root, but we
// override by calling prerenderPages/prerenderApp directly with a tmp
// manifestDir. Instead, call runPrerender which needs a real-looking root.
// We test it indirectly: call prerenderPages on app-basic's pages/ dir
// with a manifestDir so we can check hybrid manifest merging.
const { prerenderPages } = await import("../packages/vinext/src/build/prerender.js");
const { pagesRouter, apiRouter } =
await import("../packages/vinext/src/routing/pages-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const pagesDir = path.resolve(APP_FIXTURE, "pages");
const pageRoutes = await pagesRouter(pagesDir);
const apiRoutes = await apiRouter(pagesDir);
const config = await resolveNextConfig({});
const prerenderResult = await prerenderPages({
mode: "default",
pagesBundlePath,
routes: pageRoutes,
apiRoutes,
pagesDir,
outDir: manifestDir,
config,
});
results = prerenderResult.routes;
}, 60_000);
afterAll(() => {
fs.rmSync(manifestDir, { recursive: true, force: true });
});
it("renders old-school static page from pages/ in app-basic fixture", () => {
const r = findRoute(results, "/old-school");
expect(r).toMatchObject({ route: "/old-school", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("old-school.html");
}
});
it("skips pages-header-override-delete (getServerSideProps) in default mode", () => {
const r = findRoute(results, "/pages-header-override-delete");
expect(r).toMatchObject({
route: "/pages-header-override-delete",
status: "skipped",
reason: "ssr",
});
});
});
describe("prerender — generateStaticParams/getStaticPaths errors (#1982)", () => {
// Ported from Next.js: test/production/app-dir/generate-static-params-errors/generate-static-params-errors.test.ts
// https://github.com/vercel/next.js/blob/canary/test/production/app-dir/generate-static-params-errors/generate-static-params-errors.test.ts
// Next.js surfaces the real generateStaticParams/getStaticPaths error and fails the build. vinext
// must not swallow the 500 returned by the static-params/static-paths endpoint into a misleading
// "stale or missing prerender secret" skip — the route must fail with the real error message.
//
// NOTE: these tests mock the prerender endpoint's HTTP response (the prod server here has no
// secret configured), so they exercise the build-side proxy's status branching, not the real
// app-prerender-endpoints.ts 500 path end-to-end. The endpoint's own behaviour (throw → 500 with
// `{ error }`) is covered by tests/app-prerender-endpoints.test.ts.
it("surfaces a thrown generateStaticParams error instead of silently skipping the route", async () => {
const root = tmpDir("vinext-prerender-gsp-error-");
const outDir = path.join(root, "out");
const appDir = path.join(root, "app");
const pageDir = path.join(appDir, "blog", "[slug]");
fs.mkdirSync(pageDir, { recursive: true });
fs.writeFileSync(
path.join(pageDir, "page.tsx"),
"export default function Page() { return null; }\n",
);
// The static-params endpoint returns 500 with the real error in the body when
// the user's generateStaticParams throws (app-prerender-endpoints.ts).
const server = createServer((req, res) => {
const url = new URL(req.url ?? "/", "http://127.0.0.1");
if (url.pathname === "/__vinext/prerender/static-params") {
res.statusCode = 500;
res.setHeader("content-type", "application/json");
res.end(JSON.stringify({ error: "Error: boom from generateStaticParams" }));
return;
}
res.setHeader("content-type", "text/html");
res.end(
"<html><body>" +
runtimeRscChunkScript(`0:["$","div",null,{}]\n`) +
runtimeRscDoneScript() +
"</body></html>",
);
});
const port = await listen(server);
try {
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({});
const result = await prerenderApp({
mode: "default",
rscBundlePath: path.join(root, "dist", "server", "index.js"),
routes,
outDir,
config,
_prodServer: { server, port },
});
const route = result.routes.find((r) => r.route.includes("slug"));
// `fatal: true` makes run-prerender fail the build in default mode too,
// matching Next.js (not just a visible-but-non-fatal error). #1982
expect(route).toMatchObject({ status: "error", fatal: true });
if (route?.status !== "error") {
throw new Error("expected the throwing generateStaticParams route to fail prerender");
}
expect(route.error).toContain("boom from generateStaticParams");
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
});
it("still warn-skips (does not fail) when the static-params endpoint 404s (disabled/stale secret)", async () => {
const root = tmpDir("vinext-prerender-gsp-secret-");
const outDir = path.join(root, "out");
const appDir = path.join(root, "app");
const pageDir = path.join(appDir, "blog", "[slug]");
fs.mkdirSync(pageDir, { recursive: true });
fs.writeFileSync(
path.join(pageDir, "page.tsx"),
"export default function Page() { return null; }\n",
);
// A 404 models the genuine disabled / stale-secret case (notFoundResponse),
// which must keep the warn-and-skip behavior rather than failing the build.
const server = createServer((req, res) => {
const url = new URL(req.url ?? "/", "http://127.0.0.1");
if (url.pathname === "/__vinext/prerender/static-params") {
res.statusCode = 404;
res.end("not found");
return;
}
res.setHeader("content-type", "text/html");
res.end(
"<html><body>" +
runtimeRscChunkScript(`0:["$","div",null,{}]\n`) +
runtimeRscDoneScript() +
"</body></html>",
);
});
const port = await listen(server);
try {
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({});
const result = await prerenderApp({
mode: "default",
rscBundlePath: path.join(root, "dist", "server", "index.js"),
routes,
outDir,
config,
_prodServer: { server, port },
});
const route = result.routes.find((r) => r.route.includes("slug"));
expect(route).toMatchObject({ status: "skipped", reason: "no-static-params" });
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
});
it("surfaces a thrown getStaticPaths error instead of silently skipping the route", async () => {
const root = tmpDir("vinext-prerender-pages-gsp-error-");
const outDir = path.join(root, "out");
const pagesDir = path.join(root, "pages");
fs.mkdirSync(path.join(pagesDir, "posts"), { recursive: true });
fs.writeFileSync(
path.join(pagesDir, "posts", "[id].tsx"),
"export default function Post() { return null; }\n",
);
const server = createServer((req, res) => {
const url = new URL(req.url ?? "/", "http://127.0.0.1");
if (url.pathname === "/__vinext/prerender/pages-static-paths") {
res.statusCode = 500;
res.setHeader("content-type", "application/json");
res.end(JSON.stringify({ error: "Error: boom from getStaticPaths" }));
return;
}
res.setHeader("content-type", "text/html");
res.end("<html><body>ok</body></html>");
});
const port = await listen(server);
try {
const { prerenderPages } = await import("../packages/vinext/src/build/prerender.js");
const { pagesRouter, apiRouter } =
await import("../packages/vinext/src/routing/pages-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await pagesRouter(pagesDir);
const apiRoutes = await apiRouter(pagesDir);
const config = await resolveNextConfig({});
const result = await prerenderPages({
mode: "default",
routes,
apiRoutes,
pagesDir,
outDir,
config,
_prodServer: { server, port },
});
const route = result.routes.find((r) => r.route.includes("posts"));
// `fatal: true` makes run-prerender fail the build in default mode too. #1982
expect(route).toMatchObject({ status: "error", fatal: true });
if (route?.status !== "error") {
throw new Error("expected the throwing getStaticPaths route to fail prerender");
}
expect(route.error).toContain("boom from getStaticPaths");
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
});
});
describe("prerenderApp — cacheComponents PPR fallback-shell artifacts", () => {
async function prerenderDynamicRootParamRoute(
cacheComponents: boolean,
experimentalFallbackShells = false,
) {
const root = tmpDir("vinext-prerender-ppr-shell-");
const outDir = path.join(root, "out");
const appDir = path.join(root, "app");
const pageDir = path.join(appDir, "[locale]", "blog", "[slug]");
fs.mkdirSync(pageDir, { recursive: true });
fs.writeFileSync(
path.join(appDir, "[locale]", "layout.tsx"),
"export default function Layout({ children }: { children: React.ReactNode }) { return children; }\n",
);
fs.writeFileSync(
path.join(pageDir, "page.tsx"),
"export default function Page() { return null; }\n",
);
const renderedPaths: string[] = [];
const server = createServer((req, res) => {
const url = new URL(req.url ?? "/", "http://127.0.0.1");
if (url.pathname === "/__vinext/prerender/static-params") {
res.setHeader("content-type", "application/json");
res.end(JSON.stringify([{ locale: "en", slug: "hello" }]));
return;
}
if (url.pathname === "/__vinext_nonexistent_for_404__") {
res.statusCode = 404;
res.end("<html><body>not found</body></html>");
return;
}
renderedPaths.push(url.pathname);
res.setHeader("content-type", "text/html");
res.end(
"<html><body>" +
runtimeRscChunkScript(
`0:["$","div",null,{"children":${JSON.stringify(url.pathname)}}]\n`,
) +
runtimeRscDoneScript() +
"</body></html>",
);
});
const port = await listen(server);
try {
const { prerenderApp } = await import("../packages/vinext/src/build/prerender.js");
const { appRouter } = await import("../packages/vinext/src/routing/app-router.js");
const { resolveNextConfig } = await import("../packages/vinext/src/config/next-config.js");
const routes = await appRouter(appDir);
const config = await resolveNextConfig({ cacheComponents });
const previousExperimentalFallbackShells =
process.env.__VINEXT_EXPERIMENTAL_PPR_FALLBACK_SHELLS;
if (experimentalFallbackShells) {
process.env.__VINEXT_EXPERIMENTAL_PPR_FALLBACK_SHELLS = "1";
} else {
delete process.env.__VINEXT_EXPERIMENTAL_PPR_FALLBACK_SHELLS;
}
let result;
try {
result = await prerenderApp({
mode: "default",
rscBundlePath: path.join(root, "dist", "server", "index.js"),
routes,
outDir,
config,
_prodServer: { server, port },
});
} finally {
if (previousExperimentalFallbackShells === undefined) {
delete process.env.__VINEXT_EXPERIMENTAL_PPR_FALLBACK_SHELLS;
} else {
process.env.__VINEXT_EXPERIMENTAL_PPR_FALLBACK_SHELLS =
previousExperimentalFallbackShells;
}
}
const fallbackHtmlPath = path.join(outDir, "en", "blog", "[slug].html");
const fallbackHtml = fs.existsSync(fallbackHtmlPath)
? fs.readFileSync(fallbackHtmlPath, "utf8")
: null;
return { fallbackHtml, renderedPaths, routes: result.routes };
} finally {
await closeServer(server);
fs.rmSync(root, { recursive: true, force: true });
}
}
it("does not queue incomplete fallback-shell artifacts by default", async () => {
const { renderedPaths, routes } = await prerenderDynamicRootParamRoute(true);
expect(findRoute(routes, "/en/blog/hello")).toMatchObject({
route: "/:locale/blog/:slug",
path: "/en/blog/hello",
status: "rendered",
});
expect(findRoute(routes, "/en/blog/[slug]")).toBeUndefined();
expect(renderedPaths).toContain("/en/blog/hello");
expect(renderedPaths).not.toContain("/en/blog/[slug]");
});
it("queues fallback-shell artifacts only with the internal opt-in", async () => {
const { fallbackHtml, renderedPaths, routes } = await prerenderDynamicRootParamRoute(
true,
true,
);
expect(findRoute(routes, "/en/blog/hello")).toMatchObject({
route: "/:locale/blog/:slug",
path: "/en/blog/hello",
status: "rendered",
});
expect(findRoute(routes, "/en/blog/[slug]")).toMatchObject({
route: "/:locale/blog/:slug",
path: "/en/blog/[slug]",
status: "rendered",
fallback: true,
});
expect(renderedPaths).toEqual(expect.arrayContaining(["/en/blog/hello", "/en/blog/[slug]"]));
expect(fallbackHtml).toContain("<!--vinext-ppr-dynamic-fallback-shell-->");
});
it("does not queue fallback-shell artifacts when cacheComponents is disabled", async () => {
const { renderedPaths, routes } = await prerenderDynamicRootParamRoute(false);
expect(findRoute(routes, "/en/blog/hello")).toMatchObject({
route: "/:locale/blog/:slug",
path: "/en/blog/hello",
status: "rendered",
});
expect(findRoute(routes, "/en/blog/[slug]")).toBeUndefined();
expect(renderedPaths).toContain("/en/blog/hello");
expect(renderedPaths).not.toContain("/en/blog/[slug]");
});
});
// ─── runPrerender — output: 'export' wiring ───────────────────────────────────
describe("runPrerender — output: 'export' wiring", () => {
let pagesBundlePath: string;
beforeAll(async () => {
// Build pages-basic to a fresh tmpdir — no fixture copying needed.
// Pass the bundle path and a nextConfigOverride to runPrerender so it
// exercises output: 'export' without touching the real next.config.mjs.
pagesBundlePath = await buildPagesFixture(PAGES_FIXTURE);
}, 120_000);
it("throws when next.config output: 'export' and SSR routes exist", async () => {
const { runPrerender } = await import("../packages/vinext/src/build/run-prerender.js");
await expect(
runPrerender({
root: PAGES_FIXTURE,
nextConfigOverride: { output: "export" },
pagesBundlePath,
}),
).rejects.toThrow(/Static export failed/);
});
it("error message names the offending SSR route", async () => {
const { runPrerender } = await import("../packages/vinext/src/build/run-prerender.js");
await expect(
runPrerender({
root: PAGES_FIXTURE,
nextConfigOverride: { output: "export" },
pagesBundlePath,
}),
).rejects.toThrow(/\/ssr/);
});
});
// ─── run-prerender fatal-route gate (#1982) ───────────────────────────────────
describe("assertNoFatalPrerenderRoutes (#1982)", () => {
it("throws (fails the build in default mode) when a route is flagged fatal", async () => {
const { assertNoFatalPrerenderRoutes } =
await import("../packages/vinext/src/build/run-prerender.js");
expect(() =>
assertNoFatalPrerenderRoutes([
{
route: "/blog/:slug",
status: "error",
error: "Failed to call generateStaticParams(): boom",
fatal: true,
},
]),
).toThrow(/Prerender failed/);
});
it("does not throw for non-fatal errors or skips (default-mode leniency preserved)", async () => {
const { assertNoFatalPrerenderRoutes } =
await import("../packages/vinext/src/build/run-prerender.js");
// A skipped SSR route and a non-fatal error (e.g. a transport failure) must
// NOT fail the default build — only fatal user-function throws do.
expect(() =>
assertNoFatalPrerenderRoutes([
{ route: "/ssr", status: "skipped", reason: "ssr" },
{ route: "/render-fail", status: "error", error: "ECONNREFUSED" },
]),
).not.toThrow();
});
});
// ─── App Router — Cloudflare Workers build ────────────────────────────────────
//
// Verifies that prerenderApp() works correctly when the production bundle is a
// Cloudflare Workers build (dist/server/index.js). Prerendering goes through a
// locally-spawned prod server over HTTP — same path as plain Node builds.
// ─── Cloudflare Workers hybrid build (app/ + pages/) ─────────────────────────
//
// Verifies that both prerenderApp() and prerenderPages() work correctly when
// the build is a Cloudflare Workers bundle. Both phases render via HTTP through
// a shared local prod server started by runPrerender().
describe("Cloudflare Workers hybrid build (cf-app-basic)", () => {
let outDir: string;
let allResults: PrerenderRouteResult[];
beforeAll(async () => {
const { root, rscBundlePath } = await buildCloudflareAppFixture(CF_FIXTURE);
outDir = path.join(root, "dist", "server", "prerendered-routes");
const { runPrerender } = await import("../packages/vinext/src/build/run-prerender.js");
const result = await runPrerender({ root, rscBundlePath });
allResults = result?.routes ?? [];
}, 180_000);
// ── App Router ──────────────────────────────────────────────────────────────
describe("prerenderApp — app router via prod server HTTP", () => {
it("renders / speculatively", () => {
const r = findRoute(allResults, "/");
expect(r).toMatchObject({ route: "/", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("index.html");
expect(r.outputFiles).toContain("index.rsc");
}
});
it("renders /about speculatively", () => {
const r = findRoute(allResults, "/about");
expect(r).toMatchObject({ route: "/about", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("about.html");
}
});
it("renders /blog/[slug] expanded from generateStaticParams", () => {
for (const slug of ["hello-world", "getting-started"]) {
const r = findRoute(allResults, `/blog/${slug}`);
expect(r).toMatchObject({
route: "/blog/:slug",
path: `/blog/${slug}`,
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain(`blog/${slug}.html`);
expect(r.outputFiles).toContain(`blog/${slug}.rsc`);
}
}
});
it("skips API routes", () => {
const apiSkipped = allResults.filter(
(r) => r.status === "skipped" && "reason" in r && r.reason === "api",
);
expect(apiSkipped.length).toBeGreaterThan(0);
});
it("writes HTML and RSC files to outDir", () => {
expect(fs.existsSync(path.join(outDir, "index.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "index.rsc"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "about.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "blog/hello-world.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "blog/hello-world.rsc"))).toBe(true);
});
});
// ── Pages Router ────────────────────────────────────────────────────────────
describe("prerenderPages — pages router via prod server HTTP", () => {
it("renders static Pages home", () => {
const r = findRoute(allResults, "/pages-home");
expect(r).toMatchObject({ route: "/pages-home", status: "rendered", revalidate: false });
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("pages-home.html");
}
});
it("renders static Pages about", () => {
const r = findRoute(allResults, "/pages-about");
expect(r).toMatchObject({
route: "/pages-about",
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain("pages-about.html");
}
});
it("renders /posts/[id] expanded from getStaticPaths", () => {
for (const id of ["first", "second"]) {
const r = findRoute(allResults, `/posts/${id}`);
expect(r).toMatchObject({
route: "/posts/:id",
path: `/posts/${id}`,
status: "rendered",
revalidate: false,
});
if (r?.status === "rendered") {
expect(r.outputFiles).toContain(`posts/${id}.html`);
}
}
});
it("skips API routes", () => {
const apiSkipped = allResults.filter(
(r) => r.status === "skipped" && "reason" in r && r.reason === "api",
);
expect(apiSkipped.length).toBeGreaterThan(0);
});
it("writes HTML files to outDir", () => {
expect(fs.existsSync(path.join(outDir, "posts/first.html"))).toBe(true);
expect(fs.existsSync(path.join(outDir, "posts/second.html"))).toBe(true);
});
});
});
// ─── resolveParentParams unit tests ─────────────────────────────────────────
function mockRoute(pattern: string, opts: { pagePath?: string | null } = {}): AppRoute {
const parts = pattern.split("/").filter(Boolean);
return {
pattern,
pagePath: opts.pagePath ?? `/app${pattern}/page.tsx`,
routePath: null,
layouts: [],
templates: [],
parallelSlots: [],
loadingPath: null,
errorPath: null,
layoutErrorPaths: [],
notFoundPath: null,
notFoundPaths: [],
forbiddenPaths: [],
forbiddenPath: null,
unauthorizedPaths: [],
unauthorizedPath: null,
routeSegments: [],
layoutTreePositions: [],
isDynamic: parts.some((p) => p.startsWith(":")),
params: parts
.filter((p) => p.startsWith(":"))
.map((p) => p.replace(/^:/, "").replace(/[+*]$/, "")),
patternParts: parts,
siblingIntercepts: [],
};
}
describe("resolveParentParams", () => {
it("returns empty array when route has no parent dynamic segments", async () => {
const route = mockRoute("/blog/:slug");
const result = await resolveParentParams(route, {});
expect(result).toEqual([]);
});
it("returns empty array when no parent generateStaticParams is registered", async () => {
const child = mockRoute("/shop/:category/:item");
const result = await resolveParentParams(child, {});
expect(result).toEqual([]);
});
it("resolves layout-level parent generateStaticParams without requiring a parent page", async () => {
// Ported from Next.js: test/e2e/app-dir/app-root-params-getters/generate-static-params.test.ts
// https://github.com/vercel/next.js/blob/canary/test/e2e/app-dir/app-root-params-getters/generate-static-params.test.ts
const child = mockRoute("/:lang/:locale/other/:slug");
const staticParamsMap: StaticParamsMap = {
"/:lang/:locale": async () => [
{ lang: "en", locale: "us" },
{ lang: "es", locale: "es" },
],
};
const result = await resolveParentParams(child, staticParamsMap);
expect(result).toEqual([
{ lang: "en", locale: "us" },
{ lang: "es", locale: "es" },
]);
});
it("returns empty array when parent has no generateStaticParams", async () => {
const child = mockRoute("/shop/:category/:item");
const staticParamsMap: StaticParamsMap = {};
const result = await resolveParentParams(child, staticParamsMap);
expect(result).toEqual([]);
});
it("skips missing parent providers but bails on malformed non-array results", async () => {
const child = mockRoute("/shop/:category/:item/:slug");
const calls: Record<string, string | string[]>[] = [];
const itemGenerateStaticParams = async ({
params,
}: {
params: Record<string, string | string[]>;
}) => {
calls.push(params);
return [{ item: "shoes" }];
};
const staticParamsMap: StaticParamsMap = {
"/shop/:category": async () => null,
"/shop/:category/:item": itemGenerateStaticParams,
};
const missingProviderResult = await resolveParentParams(child, staticParamsMap);
expect(missingProviderResult).toEqual([{ item: "shoes" }]);
expect(calls).toEqual([{}]);
calls.length = 0;
const malformedProviderResult = await resolveParentParams(child, {
"/shop/:category": async () => undefined,
"/shop/:category/:item": itemGenerateStaticParams,
});
expect(malformedProviderResult).toEqual([]);
expect(calls).toEqual([]);
});
it("resolves single parent dynamic segment", async () => {
const child = mockRoute("/shop/:category/:item");
const staticParamsMap: StaticParamsMap = {
"/shop/:category": async () => [{ category: "electronics" }, { category: "clothing" }],
};
const result = await resolveParentParams(child, staticParamsMap);
expect(result).toEqual([{ category: "electronics" }, { category: "clothing" }]);
});
it("resolves two levels of parent dynamic segments", async () => {
const child = mockRoute("/a/:b/c/:d/:e");
const staticParamsMap: StaticParamsMap = {
"/a/:b": async () => [{ b: "1" }, { b: "2" }],
"/a/:b/c/:d": async ({ params }) => {
if (params.b === "1") return [{ d: "x" }];
return [{ d: "y" }, { d: "z" }];
},
};
const result = await resolveParentParams(child, staticParamsMap);
expect(result).toEqual([
{ b: "1", d: "x" },
{ b: "2", d: "y" },
{ b: "2", d: "z" },
]);
});
it("skips static segments between dynamic parents", async () => {
const child = mockRoute("/shop/:category/details/:item");
const staticParamsMap: StaticParamsMap = {
"/shop/:category": async () => [{ category: "shoes" }],
};
const result = await resolveParentParams(child, staticParamsMap);
expect(result).toEqual([{ category: "shoes" }]);
});
it("returns empty array for a fully static route", async () => {
const route = mockRoute("/about/contact");
const result = await resolveParentParams(route, {});
expect(result).toEqual([]);
});
it("returns empty array for a single-segment dynamic route", async () => {
const route = mockRoute("/:id");
const result = await resolveParentParams(route, {});
expect(result).toEqual([]);
});
it("resolves parent with catch-all child segment", async () => {
const child = mockRoute("/shop/:category/:rest+");
const staticParamsMap: StaticParamsMap = {
"/shop/:category": async () => [{ category: "electronics" }],
};
const result = await resolveParentParams(child, staticParamsMap);
expect(result).toEqual([{ category: "electronics" }]);
});
});