@qwik.dev/router 2.0.0-alpha.8 → 2.0.0-beta.1

package/lib/middleware/node/index.d.ts

@@ -1,66 +1,64 @@
-/// <reference types="node" />
-
-import type { ClientConn } from '@qwik.dev/router/middleware/request-handler';
-import type { Http2ServerRequest } from 'node:http2';
-import type { IncomingMessage } from 'node:http';
-import type { ServerRenderOptions } from '@qwik.dev/router/middleware/request-handler';
-import type { ServerResponse } from 'node:http';
-
-/**
- * @deprecated Use `createQwikRouter` instead. Will be removed in V3
- * @public
- */
-export declare const createQwikCity: typeof createQwikRouter;
-
-/** @public */
-export declare function createQwikRouter(opts: QwikRouterNodeRequestOptions | QwikCityNodeRequestOptions): {
-    router: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: NodeRequestNextFunction) => Promise<void>;
-    notFound: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e: any) => void) => Promise<void>;
-    staticFile: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e?: any) => void) => Promise<void>;
-};
-
-/** @public */
-export declare interface NodeRequestNextFunction {
-    (err?: any): void;
-}
-
-/** @public */
-export declare interface PlatformNode {
-    ssr?: true;
-    incomingMessage?: IncomingMessage | Http2ServerRequest;
-    node?: string;
-}
-
-/**
- * @deprecated Use `QwikRouterNodeRequestOptions` instead. Will be removed in V3
- * @public
- */
-export declare type QwikCityNodeRequestOptions = QwikRouterNodeRequestOptions;
-
-/** @public */
-export declare interface QwikRouterNodeRequestOptions extends ServerRenderOptions {
-    /** Options for serving static files */
-    static?: {
-        /** The root folder for statics files. Defaults to /dist */
-        root?: string;
-        /** Set the Cache-Control header for all static files */
-        cacheControl?: string;
-    };
-    /**
-     * Provide a function that computes the origin of the server, used to resolve relative URLs and
-     * validate the request origin against CSRF attacks.
-     *
-     * When not specified, it defaults to the `ORIGIN` environment variable (if set).
-     *
-     * If `ORIGIN` is not set, it's derived from the incoming request, which is not recommended for
-     * production use. You can specify the `PROTOCOL_HEADER`, `HOST_HEADER` to `X-Forwarded-Proto` and
-     * `X-Forwarded-Host` respectively to override the default behavior.
-     */
-    getOrigin?: (req: IncomingMessage | Http2ServerRequest) => string | null;
-    /** Provide a function that returns a `ClientConn` for the given request. */
-    getClientConn?: (req: IncomingMessage | Http2ServerRequest) => ClientConn;
-    /** @deprecated Use `getOrigin` instead. Will be removed in V3 */
-    origin?: string;
-}
-
-export { }
+import type { ClientConn } from '@qwik.dev/router/middleware/request-handler';
+import type { Http2ServerRequest } from 'node:http2';
+import type { IncomingMessage } from 'node:http';
+import type { ServerRenderOptions } from '@qwik.dev/router/middleware/request-handler';
+import type { ServerResponse } from 'node:http';
+
+/**
+ * @deprecated Use `createQwikRouter` instead. Will be removed in V3
+ * @public
+ */
+export declare const createQwikCity: typeof createQwikRouter;
+
+/** @public */
+export declare function createQwikRouter(opts: QwikRouterNodeRequestOptions | QwikCityNodeRequestOptions): {
+    router: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: NodeRequestNextFunction) => Promise<void>;
+    notFound: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e: any) => void) => Promise<void>;
+    staticFile: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e?: any) => void) => Promise<void>;
+};
+
+/** @public */
+export declare interface NodeRequestNextFunction {
+    (err?: any): void;
+}
+
+/** @public */
+export declare interface PlatformNode {
+    ssr?: true;
+    incomingMessage?: IncomingMessage | Http2ServerRequest;
+    node?: string;
+}
+
+/**
+ * @deprecated Use `QwikRouterNodeRequestOptions` instead. Will be removed in V3
+ * @public
+ */
+export declare type QwikCityNodeRequestOptions = QwikRouterNodeRequestOptions;
+
+/** @public */
+export declare interface QwikRouterNodeRequestOptions extends ServerRenderOptions {
+    /** Options for serving static files */
+    static?: {
+        /** The root folder for statics files. Defaults to /dist */
+        root?: string;
+        /** Set the Cache-Control header for all static files */
+        cacheControl?: string;
+    };
+    /**
+     * Provide a function that computes the origin of the server, used to resolve relative URLs and
+     * validate the request origin against CSRF attacks.
+     *
+     * When not specified, it defaults to the `ORIGIN` environment variable (if set).
+     *
+     * If `ORIGIN` is not set, it's derived from the incoming request, which is not recommended for
+     * production use. You can specify the `PROTOCOL_HEADER`, `HOST_HEADER` to `X-Forwarded-Proto` and
+     * `X-Forwarded-Host` respectively to override the default behavior.
+     */
+    getOrigin?: (req: IncomingMessage | Http2ServerRequest) => string | null;
+    /** Provide a function that returns a `ClientConn` for the given request. */
+    getClientConn?: (req: IncomingMessage | Http2ServerRequest) => ClientConn;
+    /** @deprecated Use `getOrigin` instead. Will be removed in V3 */
+    origin?: string;
+}
+
+export { }

package/lib/middleware/request-handler/index.cjs

@@ -28,32 +28,27 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // packages/qwik-router/src/middleware/request-handler/index.ts
-var request_handler_exports = {};
-__export(request_handler_exports, {
+var index_exports = {};
+__export(index_exports, {
   AbortMessage: () => AbortMessage,
   RedirectMessage: () => RedirectMessage,
+  RewriteMessage: () => RewriteMessage,
   ServerError: () => ServerError,
   _TextEncoderStream_polyfill: () => _TextEncoderStream_polyfill,
   getErrorHtml: () => getErrorHtml,
   mergeHeadersCookies: () => mergeHeadersCookies,
   requestHandler: () => requestHandler
 });
-module.exports = __toCommonJS(request_handler_exports);
+module.exports = __toCommonJS(index_exports);
 
 // packages/qwik-router/src/middleware/request-handler/error-handler.ts
 var ServerError = class extends Error {
   constructor(status, data) {
-    super();
+    super(typeof data === "string" ? data : void 0);
     this.status = status;
     this.data = data;
   }
 };
-var ErrorResponse = class extends Error {
-  constructor(status, message) {
-    super(message);
-    this.status = status;
-  }
-};
 function getErrorHtml(status, e) {
   let message = "Server Error";
   if (e != null) {
@@ -266,6 +261,14 @@ var AbortMessage = class {
 var RedirectMessage = class extends AbortMessage {
 };
 
+// packages/qwik-router/src/middleware/request-handler/rewrite-handler.ts
+var RewriteMessage = class extends AbortMessage {
+  constructor(pathname) {
+    super();
+    this.pathname = pathname;
+  }
+};
+
 // packages/qwik-router/src/runtime/src/constants.ts
 var MODULE_CACHE = /* @__PURE__ */ new WeakMap();
 var QACTION_KEY = "qaction";
@@ -501,8 +504,7 @@ function createCacheControl(cacheControl) {
     cacheControl = {
       public: true,
       immutable: true,
-      maxAge: 60 * 60 * 24 * 365,
-      staleWhileRevalidate: 60 * 60 * 24 * 365
+      maxAge: 60 * 60 * 24 * 365
     };
   } else if (cacheControl === "no-cache") {
     cacheControl = {
@@ -512,8 +514,7 @@ function createCacheControl(cacheControl) {
   if (typeof cacheControl === "number") {
     cacheControl = {
       maxAge: cacheControl,
-      sMaxAge: cacheControl,
-      staleWhileRevalidate: cacheControl
+      sMaxAge: cacheControl
     };
   }
   if (cacheControl.immutable) {
@@ -558,14 +559,13 @@ import("node:async_hooks").then((module2) => {
     err
   );
 });
-function runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, manifest, trailingSlash = true, basePathname = "/", qwikSerializer) {
+function runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, rebuildRouteInfo, trailingSlash = true, basePathname = "/", qwikSerializer) {
   let resolve;
   const responsePromise = new Promise((r) => resolve = r);
   const requestEv = createRequestEvent(
     serverRequestEv,
     loadedRoute,
     requestHandlers,
-    manifest,
     trailingSlash,
     basePathname,
     qwikSerializer,
@@ -574,49 +574,71 @@ function runQwikRouter(serverRequestEv, loadedRoute, requestHandlers, manifest,
   return {
     response: responsePromise,
     requestEv,
-    completion: asyncStore ? asyncStore.run(requestEv, runNext, requestEv, resolve) : runNext(requestEv, resolve)
+    completion: asyncStore ? asyncStore.run(requestEv, runNext, requestEv, rebuildRouteInfo, resolve) : runNext(requestEv, rebuildRouteInfo, resolve)
   };
 }
-async function runNext(requestEv, resolve) {
-  try {
-    await requestEv.next();
-  } catch (e) {
-    if (e instanceof RedirectMessage) {
-      const stream = requestEv.getWritableStream();
-      await stream.close();
-    } else if (e instanceof ErrorResponse) {
-      console.error(e);
-      if (!requestEv.headersSent) {
-        const html = getErrorHtml(e.status, e);
-        const status = e.status;
-        requestEv.html(status, html);
-      }
-    } else if (!(e instanceof AbortMessage)) {
-      if (getRequestMode(requestEv) !== "dev") {
-        try {
-          if (!requestEv.headersSent) {
-            requestEv.headers.set("content-type", "text/html; charset=utf-8");
-            requestEv.cacheControl({ noCache: true });
-            requestEv.status(500);
+async function runNext(requestEv, rebuildRouteInfo, resolve) {
+  let rewriteAttempt = 1;
+  async function _runNext() {
+    try {
+      await requestEv.next();
+    } catch (e) {
+      if (e instanceof RedirectMessage) {
+        const stream = requestEv.getWritableStream();
+        await stream.close();
+      } else if (e instanceof RewriteMessage) {
+        if (rewriteAttempt > 50) {
+          throw new Error(`Infinite rewrite loop`);
+        }
+        rewriteAttempt += 1;
+        const url = new URL(requestEv.url);
+        url.pathname = e.pathname;
+        const { loadedRoute, requestHandlers } = await rebuildRouteInfo(url);
+        requestEv.resetRoute(loadedRoute, requestHandlers, url);
+        return await _runNext();
+      } else if (e instanceof ServerError) {
+        if (!requestEv.headersSent) {
+          const status = e.status;
+          const accept = requestEv.request.headers.get("Accept");
+          if (accept && !accept.includes("text/html")) {
+            const qwikSerializer = requestEv[RequestEvQwikSerializer];
+            requestEv.headers.set("Content-Type", "application/qwik-json");
+            requestEv.send(status, await qwikSerializer._serialize([e.data]));
+          } else {
+            const html = getErrorHtml(e.status, e.data);
+            requestEv.html(status, html);
           }
-          const stream = requestEv.getWritableStream();
-          if (!stream.locked) {
-            const writer = stream.getWriter();
-            await writer.write(encoder.encode(minimalHtmlResponse(500, "Internal Server Error")));
-            await writer.close();
+        }
+      } else if (!(e instanceof AbortMessage)) {
+        if (getRequestMode(requestEv) !== "dev") {
+          try {
+            if (!requestEv.headersSent) {
+              requestEv.headers.set("content-type", "text/html; charset=utf-8");
+              requestEv.cacheControl({ noCache: true });
+              requestEv.status(500);
+            }
+            const stream = requestEv.getWritableStream();
+            if (!stream.locked) {
+              const writer = stream.getWriter();
+              await writer.write(encoder.encode(minimalHtmlResponse(500, "Internal Server Error")));
+              await writer.close();
+            }
+          } catch {
+            console.error("Unable to render error page");
           }
-        } catch {
-          console.error("Unable to render error page");
         }
+        return e;
       }
-      return e;
     }
+    return void 0;
+  }
+  try {
+    return await _runNext();
   } finally {
     if (!requestEv.isDirty()) {
       resolve(null);
     }
   }
-  return void 0;
 }
 function getRouteMatchPathname(pathname, trailingSlash) {
   if (pathname.endsWith(QDATA_JSON)) {
@@ -642,7 +664,8 @@ var RequestRouteName = "@routeName";
 var RequestEvSharedActionId = "@actionId";
 var RequestEvSharedActionFormData = "@actionFormData";
 var RequestEvSharedNonce = "@nonce";
-function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manifest, trailingSlash, basePathname, qwikSerializer, resolved) {
+var RequestEvIsRewrite = "@rewrite";
+function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trailingSlash, basePathname, qwikSerializer, resolved) {
   const { request, platform, env } = serverRequestEv;
   const sharedMap = /* @__PURE__ */ new Map();
   const cookie = new Cookie(request.headers.get("cookie"));
@@ -655,7 +678,6 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
     }
     sharedMap.set(IsQData, true);
   }
-  sharedMap.set("@manifest", manifest);
   let routeModuleIndex = -1;
   let writableStream = null;
   let requestData = void 0;
@@ -673,6 +695,13 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
       routeModuleIndex++;
     }
   };
+  const resetRoute = (_loadedRoute, _requestHandlers, _url = url) => {
+    loadedRoute = _loadedRoute;
+    requestHandlers = _requestHandlers;
+    url.pathname = _url.pathname;
+    url.search = _url.search;
+    routeModuleIndex = -1;
+  };
   const check = () => {
     if (writableStream !== null) {
       throw new Error("Response already sent");
@@ -707,11 +736,7 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
         const writableStream2 = requestEv.getWritableStream();
         statusOrResponse.body.pipeTo(writableStream2);
       } else {
-        if (status >= 300 && status < 400) {
-          return new RedirectMessage();
-        } else {
-          requestEv.getWritableStream().getWriter().close();
-        }
+        requestEv.getWritableStream().getWriter().close();
       }
     }
     return exit();
@@ -725,17 +750,26 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
     [RequestEvLoaders]: loaders,
     [RequestEvMode]: serverRequestEv.mode,
     [RequestEvTrailingSlash]: trailingSlash,
-    [RequestEvRoute]: loadedRoute,
+    get [RequestEvRoute]() {
+      return loadedRoute;
+    },
     [RequestEvQwikSerializer]: qwikSerializer,
     cookie,
     headers,
     env,
     method: request.method,
     signal: request.signal,
-    params: (loadedRoute == null ? void 0 : loadedRoute[1]) ?? {},
-    pathname: url.pathname,
+    originalUrl: new URL(url),
+    get params() {
+      return (loadedRoute == null ? void 0 : loadedRoute[1]) ?? {};
+    },
+    get pathname() {
+      return url.pathname;
+    },
     platform,
-    query: url.searchParams,
+    get query() {
+      return url.searchParams;
+    },
     request,
     url,
     basePathname,
@@ -750,6 +784,7 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
       return serverRequestEv.getClientConn();
     },
     next,
+    resetRoute,
     exit,
     cacheControl: (cacheControl, target = "Cache-Control") => {
       check();
@@ -782,7 +817,7 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
     },
     error: (statusCode, message) => {
       status = statusCode;
-      return new ErrorResponse(statusCode, message);
+      return new ServerError(statusCode, message);
     },
     redirect: (statusCode, url2) => {
       check();
@@ -800,6 +835,14 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, manif
       exit();
       return new RedirectMessage();
     },
+    rewrite: (pathname) => {
+      check();
+      if (pathname.startsWith("http")) {
+        throw new Error("Rewrite does not support absolute urls");
+      }
+      sharedMap.set(RequestEvIsRewrite, true);
+      return new RewriteMessage(pathname.replace(/\/+/g, "/"));
+    },
     defer: (returnData) => {
       return typeof returnData === "function" ? returnData : () => returnData;
     },
@@ -883,7 +926,7 @@ var parseRequest = async ({ request, method, query }, sharedMap, qwikSerializer)
       if (data) {
         try {
           return qwikSerializer._deserialize(decodeURIComponent(data));
-        } catch (err) {
+        } catch {
         }
       }
     }
@@ -911,7 +954,7 @@ var formToObj = (formData) => {
 
 // packages/qwik-router/src/middleware/request-handler/response-page.ts
 function getQwikRouterServerData(requestEv) {
-  const { url, params, request, status, locale } = requestEv;
+  const { params, request, status, locale, originalUrl } = requestEv;
   const requestHeaders = {};
   request.headers.forEach((value, key) => requestHeaders[key] = value);
   const action = requestEv.sharedMap.get(RequestEvSharedActionId);
@@ -919,7 +962,7 @@ function getQwikRouterServerData(requestEv) {
   const routeName = requestEv.sharedMap.get(RequestRouteName);
   const nonce = requestEv.sharedMap.get(RequestEvSharedNonce);
   const headers = requestEv.request.headers;
-  const reconstructedUrl = new URL(url.pathname + url.search, url);
+  const reconstructedUrl = new URL(originalUrl.pathname + originalUrl.search, originalUrl);
   const host = headers.get("X-Forwarded-Host");
   const protocol = headers.get("X-Forwarded-Proto");
   if (host) {
@@ -1194,13 +1237,9 @@ async function pureServerFunction(ev) {
           }
         } catch (err) {
           if (err instanceof ServerError) {
-            ev.headers.set("Content-Type", "application/qwik-json");
-            ev.send(err.status, await qwikSerializer._serialize([err.data]));
-            return;
+            throw ev.error(err.status, err.data);
           }
-          ev.headers.set("Content-Type", "application/qwik-json");
-          ev.send(500, await qwikSerializer._serialize([err]));
-          return;
+          throw ev.error(500, "Invalid request");
         }
         if (isAsyncIterator(result)) {
           ev.headers.set("Content-Type", "text/qwik-json-stream");
@@ -1232,18 +1271,19 @@ async function pureServerFunction(ev) {
 }
 function fixTrailingSlash(ev) {
   const trailingSlash = getRequestTrailingSlash(ev);
-  const { basePathname, pathname, url, sharedMap } = ev;
+  const { basePathname, originalUrl, sharedMap } = ev;
+  const { pathname, search } = originalUrl;
   const isQData = sharedMap.has(IsQData);
   if (!isQData && pathname !== basePathname && !pathname.endsWith(".html")) {
     if (trailingSlash) {
       if (!pathname.endsWith("/")) {
-        throw ev.redirect(301 /* MovedPermanently */, pathname + "/" + url.search);
+        throw ev.redirect(301 /* MovedPermanently */, pathname + "/" + search);
       }
     } else {
       if (pathname.endsWith("/")) {
         throw ev.redirect(
           301 /* MovedPermanently */,
-          pathname.slice(0, pathname.length - 1) + url.search
+          pathname.slice(0, pathname.length - 1) + search
         );
       }
     }
@@ -1395,7 +1435,7 @@ async function renderQData(requestEv) {
     return;
   }
   const status = requestEv.status();
-  const location = requestEv.headers.get("Location");
+  const redirectLocation = requestEv.headers.get("Location");
   const trailingSlash = getRequestTrailingSlash(requestEv);
   const requestHeaders = {};
   requestEv.request.headers.forEach((value, key) => requestHeaders[key] = value);
@@ -1405,7 +1445,8 @@ async function renderQData(requestEv) {
     action: requestEv.sharedMap.get(RequestEvSharedActionId),
     status: status !== 200 ? status : 200,
     href: getPathname(requestEv.url, trailingSlash),
-    redirect: location ?? void 0
+    redirect: redirectLocation ?? void 0,
+    isRewrite: requestEv.sharedMap.get(RequestEvIsRewrite)
   };
   const writer = requestEv.getWritableStream().getWriter();
   const qwikSerializer = requestEv[RequestEvQwikSerializer];
@@ -1448,7 +1489,7 @@ function isContentType(headers, ...types) {
 
 // packages/qwik-router/src/middleware/request-handler/request-handler.ts
 async function requestHandler(serverRequestEv, opts, qwikSerializer) {
-  const { render, qwikRouterConfig, manifest, checkOrigin } = opts;
+  const { render, qwikRouterConfig, checkOrigin } = opts;
   if (!qwikRouterConfig) {
     throw new Error("qwikRouterConfig is required.");
   }
@@ -1463,11 +1504,27 @@ async function requestHandler(serverRequestEv, opts, qwikSerializer) {
   );
   if (routeAndHandlers) {
     const [route, requestHandlers] = routeAndHandlers;
+    const rebuildRouteInfo = async (url) => {
+      const matchPathname2 = getRouteMatchPathname(url.pathname, qwikRouterConfig.trailingSlash);
+      const routeAndHandlers2 = await loadRequestHandlers(
+        qwikRouterConfig,
+        matchPathname2,
+        serverRequestEv.request.method,
+        checkOrigin ?? true,
+        render
+      );
+      if (routeAndHandlers2) {
+        const [loadedRoute, requestHandlers2] = routeAndHandlers2;
+        return { loadedRoute, requestHandlers: requestHandlers2 };
+      } else {
+        return { loadedRoute: null, requestHandlers: [] };
+      }
+    };
     return runQwikRouter(
       serverRequestEv,
       route,
       requestHandlers,
-      manifest,
+      rebuildRouteInfo,
       qwikRouterConfig.trailingSlash,
       qwikRouterConfig.basePathname,
       qwikSerializer
@@ -1548,6 +1605,7 @@ var _TextEncoderStream_polyfill = class {
 0 && (module.exports = {
   AbortMessage,
   RedirectMessage,
+  RewriteMessage,
   ServerError,
   _TextEncoderStream_polyfill,
   getErrorHtml,