vinext 0.1.1 → 0.1.3

package/dist/server/pages-page-data.js

@@ -1,28 +1,93 @@
+import { NEXTJS_DEPLOYMENT_ID_HEADER } from "./headers.js";
 import { normalizeStaticPathname } from "../routing/route-pattern.js";
 import { buildCacheStateHeaders } from "./cache-headers.js";
+import { isUnknownRecord } from "../utils/record.js";
+import { applyCdnResponseHeaders } from "./cache-control.js";
+import { decideIsr } from "./isr-decision.js";
 import { buildPagesCacheValue } from "./isr-cache.js";
 import { isSerializableProps } from "./pages-serializable-props.js";
 import { hasPagesGetInitialProps, isResponseSent, loadPagesGetInitialProps } from "./pages-get-initial-props.js";
-import { applyCdnResponseHeaders, buildCachedRevalidateCacheControl } from "./cache-control.js";
-import { buildNextDataJsonResponse } from "./pages-data-route.js";
-import { buildPagesNextDataScript } from "./pages-page-response.js";
+import { isBotUserAgent } from "../utils/html-limited-bots.js";
+import { buildNextDataPropsJsonResponse } from "./pages-data-route.js";
+import { buildPagesNextDataScript, etagMatches, generatePagesETag, isPagesStreamingBot, requestsNoCache } from "./pages-page-response.js";
 //#region src/server/pages-page-data.ts
-function buildPagesDataNotFoundResponse() {
+function buildPagesDataNotFoundResponse(deploymentId) {
+	const headers = { "Content-Type": "application/json" };
+	if (deploymentId) headers[NEXTJS_DEPLOYMENT_ID_HEADER] = deploymentId;
 	return new Response("{}", {
 		status: 404,
-		headers: { "Content-Type": "application/json" }
+		headers
 	});
 }
 function buildPagesNotFoundResult(options) {
 	if (options.isDataReq) return {
 		kind: "response",
-		response: buildPagesDataNotFoundResponse()
+		response: buildPagesDataNotFoundResponse(options.deploymentId)
 	};
 	return { kind: "notFound" };
 }
 function resolvePagesRedirectStatus(redirect) {
 	return redirect.statusCode != null ? redirect.statusCode : redirect.permanent ? 308 : 307;
 }
+function normalizePagesRenderProps(props) {
+	return {
+		...props,
+		pageProps: props.pageProps
+	};
+}
+/**
+* Load `_app.getInitialProps` and return the normalized render props and the
+* extracted `pageProps`. This is shared between the foreground render path and
+* the stale-while-revalidate background regeneration path so both produce the
+* same full props envelope (app-level props plus the page's `pageProps`).
+*
+* `getSharedReqRes` lets callers share the same mock req/res with other
+* data-fetching steps (e.g. `getServerSideProps`) when they run in the same
+* request context.
+*/
+async function loadPagesAppInitialRenderProps(options, getSharedReqRes) {
+	let pageProps = {};
+	let renderProps = { pageProps };
+	if (!hasPagesGetInitialProps(options.AppComponent)) return {
+		kind: "props",
+		pageProps,
+		renderProps
+	};
+	const { req, res, responsePromise } = getSharedReqRes();
+	const initialProps = await loadPagesGetInitialProps(options.AppComponent, {
+		AppTree: options.createAppTree ?? options.createPageElement,
+		Component: options.pageModule.default,
+		router: {
+			pathname: options.routePattern,
+			query: options.query,
+			asPath: options.asPath ?? options.routeUrl
+		},
+		ctx: {
+			req,
+			res,
+			err: options.err,
+			pathname: options.routePattern,
+			query: options.query,
+			asPath: options.asPath ?? options.routeUrl,
+			locale: options.i18n.locale,
+			locales: options.i18n.locales,
+			defaultLocale: options.i18n.defaultLocale
+		}
+	});
+	if (isResponseSent(res)) return {
+		kind: "response",
+		response: responsePromise
+	};
+	if (initialProps) {
+		renderProps = normalizePagesRenderProps(initialProps);
+		pageProps = isUnknownRecord(renderProps.pageProps) ? renderProps.pageProps : {};
+	}
+	return {
+		kind: "props",
+		pageProps,
+		renderProps
+	};
+}
 /**
 * Build the response for a `getServerSideProps` / `getStaticProps`
 * `{ redirect }` result.
@@ -44,12 +109,20 @@ function resolvePagesRedirectStatus(redirect) {
 * redirects (search `__N_REDIRECT`), consumed in
 * `packages/next/src/shared/lib/router/router.ts` (`pageProps.__N_REDIRECT`).
 */
-function buildPagesRedirectResponse(redirect, options) {
+function buildPagesRedirectResponse(redirect, options, props = { pageProps: {} }) {
 	const destination = options.sanitizeDestination(redirect.destination);
-	if (options.isDataReq) return buildNextDataJsonResponse({
-		__N_REDIRECT: destination,
-		__N_REDIRECT_STATUS: resolvePagesRedirectStatus(redirect)
-	}, options.safeJsonStringify);
+	if (options.isDataReq) {
+		const init = { headers: {} };
+		if (options.deploymentId) init.headers[NEXTJS_DEPLOYMENT_ID_HEADER] = options.deploymentId;
+		return buildNextDataPropsJsonResponse({
+			...props,
+			pageProps: {
+				...isUnknownRecord(props.pageProps) ? props.pageProps : {},
+				__N_REDIRECT: destination,
+				__N_REDIRECT_STATUS: resolvePagesRedirectStatus(redirect)
+			}
+		}, options.safeJsonStringify, init);
+	}
 	return new Response(null, {
 		status: resolvePagesRedirectStatus(redirect),
 		headers: { Location: destination }
@@ -81,19 +154,47 @@ function matchesPagesStaticPath(pathEntry, params, routeUrl) {
 	});
 }
 function buildPagesCacheResponse(html, cacheState, fontLinkHeader, revalidateSeconds, expireSeconds, cacheControl, status) {
-	const effectiveRevalidateSeconds = cacheControl?.revalidate ?? revalidateSeconds ?? 60;
-	const effectiveExpireSeconds = cacheControl === void 0 ? void 0 : cacheControl.expire ?? expireSeconds;
+	const { cacheControl: cacheControlHeader } = decideIsr({
+		cacheState,
+		kind: "pages",
+		revalidateSeconds: revalidateSeconds ?? 60,
+		expireSeconds,
+		cacheControlMeta: cacheControl
+	});
 	const headers = new Headers({
 		"Content-Type": "text/html",
 		...buildCacheStateHeaders(cacheState)
 	});
-	applyCdnResponseHeaders(headers, { cacheControl: buildCachedRevalidateCacheControl(cacheState, effectiveRevalidateSeconds, effectiveExpireSeconds) });
+	applyCdnResponseHeaders(headers, { cacheControl: cacheControlHeader });
 	if (fontLinkHeader) headers.set("Link", fontLinkHeader);
 	return new Response(html, {
 		status: status ?? 200,
 		headers
 	});
 }
+/**
+* For bot / crawler UAs, attach an ETag to a cached ISR response (HIT or
+* STALE) so it is consistent with the fresh-MISS path, then check for a
+* matching `If-None-Match`. When the check passes — and the request did NOT
+* carry `Cache-Control: no-cache` — returns a 304 response; otherwise returns
+* `null` so the caller can return the full response.
+*
+* Extracted to avoid duplicating the same three-line block across the HIT and
+* STALE branches.
+*/
+function applyBotETagAndCheck(cachedResponse, html, options) {
+	if (!options.userAgent || !isPagesStreamingBot(options.userAgent)) return null;
+	const etag = generatePagesETag(html);
+	cachedResponse.headers.set("ETag", etag);
+	if (!requestsNoCache(options.requestCacheControl) && options.ifNoneMatch && etagMatches(etag, options.ifNoneMatch)) return {
+		kind: "response",
+		response: new Response(null, {
+			status: 304,
+			headers: cachedResponse.headers
+		})
+	};
+	return null;
+}
 function rewritePagesCachedHtml(cachedHtml, freshBody, nextDataScript) {
 	const bodyStart = cachedHtml.indexOf("<div id=\"__next\">");
 	const contentStart = bodyStart >= 0 ? bodyStart + 17 : -1;
@@ -109,11 +210,13 @@ function rewritePagesCachedHtml(cachedHtml, freshBody, nextDataScript) {
 	return "<!DOCTYPE html>\n<html>\n<head>\n</head>\n<body>\n  <div id=\"__next\">" + freshBody + "</div>\n  " + nextDataScript + "\n</body>\n</html>";
 }
 async function renderPagesIsrHtml(options) {
-	const freshBody = await options.renderIsrPassToStringAsync(options.createPageElement(options.pageProps));
+	const renderProps = options.props ?? { pageProps: options.pageProps };
+	const freshBody = await options.renderIsrPassToStringAsync(options.createPageElement(renderProps));
 	const nextDataScript = buildPagesNextDataScript({
 		buildId: options.buildId,
 		i18n: options.i18n,
 		pageProps: options.pageProps,
+		props: renderProps,
 		params: options.params,
 		routePattern: options.routePattern,
 		safeJsonStringify: options.safeJsonStringify,
@@ -125,6 +228,7 @@ async function renderPagesIsrHtml(options) {
 async function resolvePagesPageData(options) {
 	const userFacingParams = options.route.isDynamic ? options.params : null;
 	let isFallback = false;
+	let shouldPersistFallbackData = false;
 	if (typeof options.pageModule.getStaticPaths === "function" && options.route.isDynamic) {
 		const pathsResult = await options.pageModule.getStaticPaths({
 			locales: options.i18n.locales ?? [],
@@ -133,25 +237,62 @@ async function resolvePagesPageData(options) {
 		const fallback = pathsResult?.fallback ?? false;
 		const isValidPath = (pathsResult?.paths ?? []).some((pathEntry) => matchesPagesStaticPath(pathEntry, options.params, options.routeUrl));
 		if (fallback === false && !isValidPath) return buildPagesNotFoundResult(options);
-		if (fallback === true && !isValidPath && !options.isDataReq) isFallback = true;
+		const isBotRequest = !!options.userAgent && isBotUserAgent(options.userAgent, options.htmlLimitedBots);
+		if (fallback === true && !isValidPath && !options.isDataReq && !isBotRequest) isFallback = true;
+		shouldPersistFallbackData = fallback === true && !isValidPath && options.isDataReq === true;
 	}
 	let pageProps = {};
 	let gsspRes = null;
-	if (isFallback) return {
-		kind: "render",
-		gsspRes: null,
-		isrRevalidateSeconds: null,
-		pageProps,
-		isFallback: true
-	};
+	let sharedReqRes = null;
+	function getSharedReqRes() {
+		sharedReqRes ??= options.createGsspReqRes();
+		return sharedReqRes;
+	}
+	let renderProps = { pageProps };
+	async function loadForegroundAppInitialRenderProps() {
+		const result = await loadPagesAppInitialRenderProps(options, getSharedReqRes);
+		if (result.kind === "response") return {
+			kind: "response",
+			response: await result.response
+		};
+		renderProps = result.renderProps;
+		pageProps = result.pageProps;
+		return null;
+	}
+	if (isFallback) {
+		const pathname = options.routeUrl.split("?")[0];
+		if ((await options.isrGet(options.isrCacheKey("pages", pathname)))?.value.value?.kind !== "PAGES") {
+			const appShortCircuit = await loadForegroundAppInitialRenderProps();
+			if (appShortCircuit) return appShortCircuit;
+			pageProps = {};
+			renderProps = {
+				...renderProps,
+				pageProps
+			};
+			return {
+				kind: "render",
+				gsspRes: null,
+				isrRevalidateSeconds: null,
+				pageProps,
+				props: renderProps,
+				isFallback: true
+			};
+		}
+	}
 	if (typeof options.pageModule.getServerSideProps === "function") {
-		const { req, res, responsePromise } = options.createGsspReqRes();
+		const shortCircuit = await loadForegroundAppInitialRenderProps();
+		if (shortCircuit) return shortCircuit;
+		renderProps = {
+			...renderProps,
+			__N_SSP: true
+		};
+		const { req, res, responsePromise } = getSharedReqRes();
 		const result = await options.pageModule.getServerSideProps({
 			params: userFacingParams,
 			req,
 			res,
 			query: options.query,
-			resolvedUrl: options.routeUrl,
+			resolvedUrl: options.resolvedUrl ?? options.routeUrl,
 			locale: options.i18n.locale,
 			locales: options.i18n.locales,
 			defaultLocale: options.i18n.defaultLocale
@@ -160,10 +301,19 @@ async function resolvePagesPageData(options) {
 			kind: "response",
 			response: await responsePromise
 		};
-		if (result?.props) pageProps = await Promise.resolve(result.props);
+		if (result?.props) {
+			pageProps = {
+				...pageProps,
+				...await Promise.resolve(result.props)
+			};
+			renderProps = {
+				...renderProps,
+				pageProps
+			};
+		}
 		if (result?.redirect) return {
 			kind: "response",
-			response: buildPagesRedirectResponse(result.redirect, options)
+			response: buildPagesRedirectResponse(result.redirect, options, renderProps)
 		};
 		if (result?.notFound) return buildPagesNotFoundResult(options);
 		if (result?.props !== void 0) isSerializableProps(options.routePattern, "getServerSideProps", pageProps);
@@ -175,13 +325,23 @@ async function resolvePagesPageData(options) {
 		const cacheKey = options.isrCacheKey("pages", pathname);
 		const cached = await options.isrGet(cacheKey);
 		const cachedValue = cached?.value.value;
-		if (!options.isOnDemandRevalidate && cachedValue?.kind === "PAGES" && cached && !cached.isStale && !options.scriptNonce && !options.isDataReq) return {
-			kind: "response",
-			response: buildPagesCacheResponse(cachedValue.html, "HIT", options.fontLinkHeader, void 0, options.expireSeconds, cached.value.cacheControl, cachedValue.status)
-		};
-		if (!options.isOnDemandRevalidate && cachedValue?.kind === "PAGES" && cached && cached.isStale && !options.scriptNonce && !options.isDataReq) {
+		if (!options.isOnDemandRevalidate && cached?.isStale === false && cachedValue?.kind === "PAGES" && !cachedValue.generatedFromDataRequest && cached && !cached.isStale && !options.scriptNonce && !options.isDataReq) {
+			const hitResponse = buildPagesCacheResponse(cachedValue.html, "HIT", options.fontLinkHeader, void 0, options.expireSeconds, cached.value.cacheControl, cachedValue.status);
+			const hitBotResult = applyBotETagAndCheck(hitResponse, cachedValue.html, options);
+			if (hitBotResult) return hitBotResult;
+			return {
+				kind: "response",
+				response: hitResponse
+			};
+		}
+		if (!options.isOnDemandRevalidate && cachedValue?.kind === "PAGES" && !cachedValue.generatedFromDataRequest && cached && cached.isStale && !options.scriptNonce && !options.isDataReq) {
 			options.triggerBackgroundRegeneration(cacheKey, async function() {
 				return options.runInFreshUnifiedContext(async () => {
+					options.applyRequestContexts();
+					const freshAppResult = await loadPagesAppInitialRenderProps(options, () => options.createGsspReqRes());
+					if (freshAppResult.kind === "response") return;
+					let freshPageProps = freshAppResult.pageProps;
+					let freshRenderProps = freshAppResult.renderProps;
 					const freshResult = await options.pageModule.getStaticProps?.({
 						params: userFacingParams,
 						locale: options.i18n.locale,
@@ -189,14 +349,25 @@ async function resolvePagesPageData(options) {
 						defaultLocale: options.i18n.defaultLocale,
 						revalidateReason: "stale"
 					});
-					if (freshResult?.props && typeof freshResult.revalidate === "number" && freshResult.revalidate > 0) {
-						options.applyRequestContexts();
+					if (freshResult?.props) {
+						freshPageProps = {
+							...freshPageProps,
+							...freshResult.props
+						};
+						freshRenderProps = {
+							...freshRenderProps,
+							pageProps: freshPageProps
+						};
+					}
+					const freshRevalidateSeconds = typeof freshResult?.revalidate === "number" && freshResult.revalidate > 0 ? freshResult.revalidate : cached.value.cacheControl?.revalidate;
+					if (freshResult?.props && freshRevalidateSeconds && freshRevalidateSeconds > 0) {
 						const freshHtml = await renderPagesIsrHtml({
 							buildId: options.buildId,
 							cachedHtml: cachedValue.html,
 							createPageElement: options.createPageElement,
 							i18n: options.i18n,
-							pageProps: freshResult.props,
+							pageProps: freshPageProps,
+							props: freshRenderProps,
 							params: options.params,
 							renderIsrPassToStringAsync: options.renderIsrPassToStringAsync,
 							routePattern: options.routePattern,
@@ -204,7 +375,7 @@ async function resolvePagesPageData(options) {
 							nextData: options.nextData,
 							vinext: options.vinext
 						});
-						await options.isrSet(cacheKey, buildPagesCacheValue(freshHtml, freshResult.props, options.statusCode), freshResult.revalidate, void 0, options.expireSeconds);
+						await options.isrSet(cacheKey, buildPagesCacheValue(freshHtml, freshRenderProps, options.statusCode), freshRevalidateSeconds, void 0, options.expireSeconds);
 					}
 				});
 			}, {
@@ -212,29 +383,66 @@ async function resolvePagesPageData(options) {
 				routePath: options.routePattern,
 				routeType: "render"
 			});
+			const staleResponse = buildPagesCacheResponse(cachedValue.html, "STALE", options.fontLinkHeader, void 0, options.expireSeconds, cached.value.cacheControl, cachedValue.status);
+			const staleBotResult = applyBotETagAndCheck(staleResponse, cachedValue.html, options);
+			if (staleBotResult) return staleBotResult;
 			return {
 				kind: "response",
-				response: buildPagesCacheResponse(cachedValue.html, "STALE", options.fontLinkHeader, void 0, options.expireSeconds, cached.value.cacheControl, cachedValue.status)
+				response: staleResponse
 			};
 		}
-		const result = await options.pageModule.getStaticProps({
+		const generatedPageData = !options.isOnDemandRevalidate && cached?.isStale === false && cachedValue?.kind === "PAGES" && cachedValue.generatedFromDataRequest && isUnknownRecord(cachedValue.pageData) ? cachedValue.pageData : null;
+		if (!generatedPageData) {
+			const shortCircuit = await loadForegroundAppInitialRenderProps();
+			if (shortCircuit) return shortCircuit;
+		}
+		const result = generatedPageData ? null : await options.pageModule.getStaticProps({
 			params: userFacingParams,
 			locale: options.i18n.locale,
 			locales: options.i18n.locales,
 			defaultLocale: options.i18n.defaultLocale,
 			revalidateReason: options.isOnDemandRevalidate ? "on-demand" : options.isBuildTimePrerendering ? "build" : "stale"
 		});
-		if (result?.props) pageProps = result.props;
+		if (generatedPageData) {
+			renderProps = generatedPageData;
+			pageProps = isUnknownRecord(renderProps.pageProps) ? renderProps.pageProps : {};
+		}
+		if (result?.props) {
+			pageProps = {
+				...pageProps,
+				...result.props
+			};
+			renderProps = {
+				...renderProps,
+				pageProps
+			};
+		}
 		if (result?.redirect) return {
 			kind: "response",
-			response: buildPagesRedirectResponse(result.redirect, options)
+			response: buildPagesRedirectResponse(result.redirect, options, renderProps)
 		};
 		if (result?.notFound) return buildPagesNotFoundResult(options);
 		if (result?.props !== void 0) isSerializableProps(options.routePattern, "getStaticProps", pageProps);
 		if (typeof result?.revalidate === "number" && result.revalidate > 0) isrRevalidateSeconds = result.revalidate;
+		else if (cachedValue?.kind === "PAGES" && cachedValue.generatedFromDataRequest) isrRevalidateSeconds = cached?.value.cacheControl?.revalidate ?? 31536e3;
+		if (shouldPersistFallbackData) {
+			const revalidateSeconds = isrRevalidateSeconds ?? 31536e3;
+			await options.isrSet(cacheKey, {
+				kind: "PAGES",
+				html: "",
+				pageData: renderProps,
+				generatedFromDataRequest: true,
+				headers: void 0,
+				status: void 0
+			}, revalidateSeconds, void 0, options.expireSeconds);
+		}
+	}
+	if (typeof options.pageModule.getServerSideProps !== "function" && typeof options.pageModule.getStaticProps !== "function" && hasPagesGetInitialProps(options.AppComponent)) {
+		const shortCircuit = await loadForegroundAppInitialRenderProps();
+		if (shortCircuit) return shortCircuit;
 	}
-	if (typeof options.pageModule.getServerSideProps !== "function" && typeof options.pageModule.getStaticProps !== "function" && hasPagesGetInitialProps(options.pageModule.default)) {
-		const { req, res, responsePromise } = options.createGsspReqRes();
+	if (typeof options.pageModule.getServerSideProps !== "function" && typeof options.pageModule.getStaticProps !== "function" && !hasPagesGetInitialProps(options.AppComponent) && hasPagesGetInitialProps(options.pageModule.default)) {
+		const { req, res, responsePromise } = getSharedReqRes();
 		const initialProps = await loadPagesGetInitialProps(options.pageModule.default, {
 			req,
 			res,
@@ -250,16 +458,23 @@ async function resolvePagesPageData(options) {
 			kind: "response",
 			response: await responsePromise
 		};
-		if (initialProps) pageProps = {
-			...pageProps,
-			...initialProps
-		};
+		if (initialProps) {
+			pageProps = {
+				...pageProps,
+				...initialProps
+			};
+			renderProps = {
+				...renderProps,
+				pageProps
+			};
+		}
 	}
 	return {
 		kind: "render",
 		gsspRes,
 		isrRevalidateSeconds,
 		pageProps,
+		props: renderProps,
 		isFallback: false
 	};
 }

package/dist/server/pages-page-handler.d.ts

@@ -28,8 +28,10 @@ type I18nConfig = {
 } | null;
 type VinextConfigSubset = {
   basePath: string;
+  assetPrefix: string;
   trailingSlash: boolean;
   expireTime?: number;
+  htmlLimitedBots?: string;
   clientTraceMetadata?: readonly string[];
   disableOptimizedLoading: boolean;
 };
@@ -72,8 +74,8 @@ type CreatePagesPageHandlerOptions = {
   renderIsrPassToStringAsync: (element: ReactNode) => Promise<string>; /** `safeJsonStringify` from `vinext/html`. */
   safeJsonStringify: (value: unknown) => string; /** `sanitizeDestination` from the config-matchers module. */
   sanitizeDestination: (dest: string) => string; /** Build the React page element for a given set of page props. */
-  createPageElement: (PageComponent: ComponentType, AppComponent: ComponentType | null, pageProps: Record<string, unknown>) => ReactNode; /** Build the element with optional App/Component enhancers (for _document). */
-  enhancePageElement: (PageComponent: ComponentType, AppComponent: ComponentType | null, pageProps: Record<string, unknown>, opts: RenderPageEnhancers) => ReactNode; /** The `_app` page component (or null). */
+  createPageElement: (PageComponent: ComponentType, AppComponent: ComponentType | null, props: Record<string, unknown>) => ReactNode; /** Build the element with optional App/Component enhancers (for _document). */
+  enhancePageElement: (PageComponent: ComponentType, AppComponent: ComponentType | null, props: Record<string, unknown>, opts: RenderPageEnhancers) => ReactNode; /** The `_app` page component (or null). */
   AppComponent: ComponentType | null; /** The `_document` page component (or null). */
   DocumentComponent: ComponentType | null;
 };
@@ -81,6 +83,7 @@ type RenderPageOptions = {
   isDataReq?: boolean;
   statusCode?: number;
   asPath?: string;
+  originalUrl?: string;
   renderErrorPageOnMiss?: boolean;
   __isInternalErrorRender?: boolean;
   __forcedRoute?: PageRoute;