@reckona/mreact-router 0.0.202 → 0.0.204

package/src/adapters/cloudflare.ts

@@ -10,6 +10,7 @@ import {
   isQueryClientScopeUnavailableError,
   runWithQueryClient,
   type DehydratedQueryClient,
+  type DehydrateOptions,
   type QueryAsyncStorage,
   type QueryClient,
 } from "@reckona/mreact-query";
@@ -32,13 +33,17 @@ import { middlewareMatches, type MiddlewareModule } from "../middleware.js";
 import { normalizeRoutePath } from "../route-path.js";
 import type { AppRoute } from "../routes.js";
 import { contentSecurityPolicy } from "../csp.js";
-import { isNotFoundError, rewriteLocation } from "../navigation.js";
+import { isNotFoundError, isRedirectError, rewriteLocation } from "../navigation.js";
 import { validateRouteMetadata } from "../metadata.js";
 import { routeSecurityHeaders } from "../security-headers.js";
 import type { AppRouterPrerenderStore } from "../serve.js";
 import { emitRouterDevtoolsEvent } from "./devtools.js";
 import { escapeHtmlAttribute, escapeHtmlText } from "@reckona/mreact-shared/html-escape";
-import { isCurrentPrerenderedRoute } from "../prerender-entry.js";
+import {
+  isCurrentPrerenderedRoute,
+  replayedPrerenderedRouteHeaders,
+  validatedPrerenderedNavigationHtml,
+} from "../prerender-entry.js";
 
 /** Re-exports build manifest contracts used by Cloudflare handlers. */
 export type {
@@ -66,6 +71,8 @@ export type {
   AppRouterRequestStartLogEvent,
   AppRouterRequestTimingLogEvent,
   AppRouterRuntime,
+  AppRouterUpgradeErrorLogEvent,
+  AppRouterUpgradeRejectedLogEvent,
 } from "../logger.js";
 /** Re-exports response hook contracts used by Cloudflare handlers. */
 export type { AppRouterResponseHook, AppRouterResponseHookContext } from "../render.js";
@@ -212,6 +219,7 @@ export type CloudflareRouteModuleComponent<Data = unknown, Env = unknown> = (
  * Defines the exports accepted from a Cloudflare page route module.
  */
 export interface CloudflareRouteModule<Data = unknown, Env = unknown> {
+  [exportName: string]: unknown;
   App?: CloudflareRouteModuleComponent<Data, Env> | undefined;
   CloudflareRouteComponent?: CloudflareRouteModuleComponent<Data, Env> | undefined;
   default?: CloudflareRouteModuleComponent<Data, Env> | undefined;
@@ -291,6 +299,7 @@ export type CloudflareRouteModuleRegistry<Env = unknown> = Record<
  * Configures the Cloudflare route module renderer.
  */
 export interface CloudflareRouteModuleRendererOptions<Env = unknown> {
+  dehydrateOptions?: DehydrateOptions | undefined;
   document?:
     | ((
         context: CloudflareRouteModuleComponentProps<unknown, Env> & {
@@ -496,7 +505,7 @@ export function createCloudflareRouteModuleRenderer<Env = unknown>(
     const prerendered = prerenderedResponse(
       context.serverManifest.prerenderedRoutes,
       normalizeRoutePath(new URL(request.url).pathname),
-      request.method,
+      request,
       isCloudflareNavigationRequest(request),
     );
 
@@ -570,12 +579,24 @@ export function createCloudflareRouteModuleRenderer<Env = unknown>(
         return error;
       }
 
+      if (isRedirectError(error)) {
+        return new Response(null, {
+          headers: { location: error.location },
+          status: error.status,
+        });
+      }
+
       if (isNotFoundError(error)) {
         return cloudflareNotFoundResponse(request);
       }
 
       throw error;
     }
+
+    if (data instanceof Response) {
+      return data;
+    }
+
     const props = {
       ...context,
       data,
@@ -587,6 +608,13 @@ export function createCloudflareRouteModuleRenderer<Env = unknown>(
     try {
       rendered = await runWithCloudflareQueryClient(queryClient, () => component(props));
     } catch (error) {
+      if (isRedirectError(error)) {
+        return new Response(null, {
+          headers: { location: error.location },
+          status: error.status,
+        });
+      }
+
       if (isNotFoundError(error)) {
         return cloudflareNotFoundResponse(request);
       }
@@ -599,6 +627,16 @@ export function createCloudflareRouteModuleRenderer<Env = unknown>(
     );
 
     if (rendered instanceof Response) {
+      if (
+        (
+          pageModule as CloudflareRouteModule<unknown, Env> & {
+            __mreactSecurityHeadersApplied?: boolean | undefined;
+          }
+        ).__mreactSecurityHeadersApplied === true
+      ) {
+        return rendered;
+      }
+
       return withDefaultSecurityHeaders(rendered, request, metadata);
     }
 
@@ -623,7 +661,7 @@ export function createCloudflareRouteModuleRenderer<Env = unknown>(
           );
     const documentedWithQueryState = await injectCloudflareQueryState(
       documented,
-      dehydrate(queryClient),
+      dehydrate(queryClient, options.dehydrateOptions),
     );
 
     return withDefaultSecurityHeaders(
@@ -722,6 +760,9 @@ async function runWithCloudflareQueryClient<T>(
     if (isQueryClientScopeUnavailableError(error)) {
       installQueryAsyncStorage(cloudflareQueryClientStorage);
       cloudflareQueryClientFallbackInstalled = true;
+      console.warn(
+        '[mreact] Cloudflare AsyncLocalStorage is unavailable. Enable the "nodejs_compat" compatibility flag; rendering is serialized until native request-local storage is available.',
+      );
       return await runWithSerializedCloudflareQueryClient(queryClient, fn);
     }
 
@@ -733,6 +774,11 @@ const cloudflareQueryClientStorage = createCloudflareQueryClientStorage();
 let cloudflareQueryClientFallbackQueue: Promise<void> = Promise.resolve();
 let cloudflareQueryClientFallbackInstalled = false;
 
+export function __resetCloudflareQueryClientFallbackForTesting(): void {
+  cloudflareQueryClientFallbackQueue = Promise.resolve();
+  cloudflareQueryClientFallbackInstalled = false;
+}
+
 async function runWithSerializedCloudflareQueryClient<T>(
   queryClient: QueryClient,
   fn: () => T,
@@ -1234,7 +1280,7 @@ async function handleCloudflareRequest<Env>(
     : prerenderedResponse(
         options.serverManifest.prerenderedRoutes,
         normalizeRoutePath(url.pathname),
-        request.method,
+        request,
         isCloudflareNavigationRequest(request),
       );
 
@@ -1377,25 +1423,25 @@ function builtServerManifestHasMiddleware(manifest: {
 function prerenderedResponse(
   prerenderedRoutes: Record<string, BuiltPrerenderedRoute> | undefined,
   path: string,
-  method: string,
+  request: Request,
   isNavigation: boolean,
 ): Response | undefined {
-  if (method !== "GET" && method !== "HEAD") {
+  if (request.method !== "GET" && request.method !== "HEAD") {
     return undefined;
   }
 
   const prerendered = prerenderedRoutes?.[path];
-
   if (!isCurrentPrerenderedRoute(prerendered)) {
     return undefined;
   }
 
-  if (isNavigation && !prerendered.html.includes("data-mreact-route-id")) {
+  const html = isNavigation ? validatedPrerenderedNavigationHtml(prerendered) : prerendered.html;
+  if (html === undefined) {
     return cloudflareDocumentReloadNavigationResponse();
   }
 
-  return new Response(method === "HEAD" ? null : prerendered.html, {
-    headers: prerendered.headers,
+  return new Response(request.method === "HEAD" ? null : html, {
+    headers: replayedPrerenderedRouteHeaders(prerendered, request),
     status: prerendered.status,
   });
 }
@@ -1622,7 +1668,7 @@ function cloudflareHydrationMarkerParts(options: {
   const propsJson = escapeScriptJson(
     JSON.stringify({
       params: options.params,
-      request: { url: options.request.url },
+      request: { url: new URL(options.request.url).pathname },
       data: options.data,
     }),
   );

package/src/adapters/edge.ts

@@ -20,6 +20,8 @@ export type {
   AppRouterRequestStartLogEvent,
   AppRouterRequestTimingLogEvent,
   AppRouterRuntime,
+  AppRouterUpgradeErrorLogEvent,
+  AppRouterUpgradeRejectedLogEvent,
 } from "../logger.js";
 
 /**

package/src/adapters/node.ts

@@ -1,4 +1,5 @@
 import type { IncomingMessage, ServerResponse } from "node:http";
+import type { DehydrateOptions } from "@reckona/mreact-query";
 import type { AppRouterCache } from "../cache.js";
 import { nodeRequestToWebRequest, sendResponse } from "../http.js";
 import type { AppRouterServerActionOptions } from "../actions.js";
@@ -19,10 +20,7 @@ import { resolveNodeRequestProtocol } from "../node-server.js";
 /** Re-exports cache contracts used by Node handlers. */
 export type { AppRouterCache, AppRouterCacheEntry } from "../cache.js";
 /** Re-exports server action contracts used by Node handlers. */
-export type {
-  AppRouterAllowedServerAction,
-  AppRouterServerActionOptions,
-} from "../actions.js";
+export type { AppRouterAllowedServerAction, AppRouterServerActionOptions } from "../actions.js";
 /** Re-exports import policy contracts used by Node handlers. */
 export type { AppRouterImportPolicy } from "../import-policy.js";
 /** Re-exports logger contracts used by Node handlers. */
@@ -37,6 +35,8 @@ export type {
   AppRouterRequestStartLogEvent,
   AppRouterRequestTimingLogEvent,
   AppRouterRuntime,
+  AppRouterUpgradeErrorLogEvent,
+  AppRouterUpgradeRejectedLogEvent,
 } from "../logger.js";
 /** Re-exports response hook contracts used by Node handlers. */
 export type { AppRouterResponseHook, AppRouterResponseHookContext } from "../render.js";
@@ -63,17 +63,14 @@ import {
 } from "../serve.js";
 
 /** Re-exports request and rendering contracts used by Node handlers. */
-export type {
-  AppRouterPrerenderStore,
-  RequestHostPolicy,
-  ResponseSinkStrategy,
-} from "../serve.js";
+export type { AppRouterPrerenderStore, RequestHostPolicy, ResponseSinkStrategy } from "../serve.js";
 
 /**
  * Configures a Node request handler for built app-router output.
  */
 export interface NodeRequestHandlerOptions {
   allowedHosts?: readonly string[] | undefined;
+  dehydrateOptions?: DehydrateOptions | undefined;
   errorHandler?:
     | ((error: unknown) => {
         body: string;
@@ -139,13 +136,14 @@ export function createNodeRequestHandler(options: NodeRequestHandlerOptions): No
         forwardedProto: incoming.headers["x-forwarded-proto"],
         trustForwardedProto: options.trustForwardedProto,
       });
-      const request = nodeRequestToWebRequest(incoming, `${protocol}://${host}`);
+      const request = nodeRequestToWebRequest(incoming, `${protocol}://${host}`, outgoing);
       const logFields = requestLogFields(request, "node");
       emitRouterLog(options.logger, "info", {
         ...logFields,
         type: "router:request:start",
       });
       const response = await renderBuiltAppRequest({
+        dehydrateOptions: options.dehydrateOptions,
         outDir: options.outDir,
         importPolicy: options.importPolicy,
         instrumentation: options.instrumentation,

package/src/adapters/static.ts

@@ -1,7 +1,13 @@
 import { cp, mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { dirname, join, resolve, sep } from "node:path";
 import type { BuiltPrerenderedRoute, BuiltServerManifest } from "../build.js";
-import { isCurrentPrerenderedRoute } from "../prerender-entry.js";
+import {
+  isCurrentPrerenderedRoute,
+  validatedPrerenderedNavigationHtml,
+} from "../prerender-entry.js";
+
+const staticNavigationBase = "/_mreact/navigation";
+const staticNavigationMetadata = `<meta name="mreact-static-navigation" content="${staticNavigationBase}">`;
 
 /**
  * Configures static export from a built app-router output directory.
@@ -104,8 +110,31 @@ async function writePrerenderedRoute(
   }
 
   const file = routeToHtmlFile(exportDir, route);
+  const navigationHtml = validatedPrerenderedNavigationHtml(entry);
+  if (navigationHtml === undefined) {
+    throw new Error(`Cannot export route ${route} without a valid navigation variant.`);
+  }
+  const navigationFile = routeToHtmlFile(join(exportDir, staticNavigationBase), route);
   await mkdir(dirname(file), { recursive: true });
-  await writeFile(file, entry.html);
+  await mkdir(dirname(navigationFile), { recursive: true });
+  await writeFile(file, withStaticNavigationMetadata(entry.html));
+  await writeFile(navigationFile, navigationHtml);
+}
+
+function withStaticNavigationMetadata(html: string): string {
+  const head = /<head(?:\s[^>]*)?>/i.exec(html);
+  if (head?.index !== undefined) {
+    const insertion = head.index + head[0].length;
+    return `${html.slice(0, insertion)}${staticNavigationMetadata}${html.slice(insertion)}`;
+  }
+
+  const doctype = /^\s*<!doctype\s+html\s*>/i.exec(html);
+  if (doctype !== null) {
+    const insertion = doctype[0].length;
+    return `${html.slice(0, insertion)}${staticNavigationMetadata}${html.slice(insertion)}`;
+  }
+
+  return `${staticNavigationMetadata}${html}`;
 }
 
 function routeToHtmlFile(exportDir: string, route: string): string {