@qwik.dev/router 2.0.0-beta.11 → 2.0.0-beta.14

package/lib/middleware/node/index.mjs

@@ -1,205 +1,222 @@
-import { setServerPlatform as R } from "@qwik.dev/core/server";
-import { requestHandler as b, isStaticPath as x, getNotFound as C } from "@qwik.dev/router/middleware/request-handler";
-import { createReadStream as k } from "node:fs";
-import { join as v, basename as S, extname as T } from "node:path";
-import { fileURLToPath as j } from "node:url";
-import { Http2ServerRequest as O } from "node:http2";
-const _ = {
-  "3gp": "video/3gpp",
-  "3gpp": "video/3gpp",
-  asf: "video/x-ms-asf",
-  asx: "video/x-ms-asf",
-  avi: "video/x-msvideo",
-  avif: "image/avif",
-  bmp: "image/x-ms-bmp",
-  css: "text/css",
-  flv: "video/x-flv",
-  gif: "image/gif",
-  htm: "text/html",
-  html: "text/html",
-  ico: "image/x-icon",
-  jng: "image/x-jng",
-  jpeg: "image/jpeg",
-  jpg: "image/jpeg",
-  js: "application/javascript",
-  json: "application/json",
-  kar: "audio/midi",
-  m4a: "audio/x-m4a",
-  m4v: "video/x-m4v",
-  mid: "audio/midi",
-  midi: "audio/midi",
-  mng: "video/x-mng",
-  mov: "video/quicktime",
-  mp3: "audio/mpeg",
-  mp4: "video/mp4",
-  mpeg: "video/mpeg",
-  mpg: "video/mpeg",
-  ogg: "audio/ogg",
-  pdf: "application/pdf",
-  png: "image/png",
-  rar: "application/x-rar-compressed",
-  shtml: "text/html",
-  svg: "image/svg+xml",
-  svgz: "image/svg+xml",
-  tif: "image/tiff",
-  tiff: "image/tiff",
-  ts: "video/mp2t",
-  txt: "text/plain",
-  wbmp: "image/vnd.wap.wbmp",
-  webm: "video/webm",
-  webp: "image/webp",
-  wmv: "video/x-ms-wmv",
-  woff: "font/woff",
-  woff2: "font/woff2",
-  xml: "text/xml",
-  zip: "application/zip"
-};
-function w(e, t) {
-  return t?.getOrigin?.(e) ?? t?.origin ?? process.env.ORIGIN ?? A(e);
+import { isDev } from '@qwik.dev/core';
+import { setServerPlatform } from '@qwik.dev/core/server';
+import { isStaticPath, getNotFound, requestHandler } from '@qwik.dev/router/middleware/request-handler';
+import { createReadStream } from 'node:fs';
+import { join, basename, extname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { M as MIME_TYPES } from '../../chunks/mime-types.mjs';
+import { Http2ServerRequest } from 'node:http2';
+
+function computeOrigin(req, opts) {
+  return opts?.getOrigin?.(req) ?? opts?.origin ?? process.env.ORIGIN ?? fallbackOrigin(req);
 }
-function A(e) {
-  const { PROTOCOL_HEADER: t, HOST_HEADER: n } = process.env, u = e.headers, h = t && u[t] || (e.socket.encrypted || e.connection.encrypted ? "https" : "http"), o = n ?? (e instanceof O ? ":authority" : "host"), r = u[o];
-  return `${h}://${r}`;
+function fallbackOrigin(req) {
+  const { PROTOCOL_HEADER, HOST_HEADER } = process.env;
+  const headers = req.headers;
+  const protocol = PROTOCOL_HEADER && headers[PROTOCOL_HEADER] || (req.socket.encrypted || req.connection.encrypted ? "https" : "http");
+  const hostHeader = HOST_HEADER ?? (req instanceof Http2ServerRequest ? ":authority" : "host");
+  const host = headers[hostHeader];
+  return `${protocol}://${host}`;
 }
-function y(e, t) {
-  return F(e.originalUrl || e.url || "/", t);
+function getUrl(req, origin) {
+  return normalizeUrl(req.originalUrl || req.url || "/", origin);
 }
-function P(e = "") {
-  return ["The stream has been destroyed", "write after end"].some((n) => e.includes(n));
+function isIgnoredError(message = "") {
+  const ignoredErrors = ["The stream has been destroyed", "write after end"];
+  return ignoredErrors.some((ignored) => message.includes(ignored));
 }
-const H = /^:(method|scheme|authority|path)$/i;
-function F(e, t) {
-  const n = /\/\/|\\\\/g;
-  return new URL(e.replace(n, "/"), t);
+const invalidHeadersPattern = /^:(method|scheme|authority|path)$/i;
+function normalizeUrl(url, base) {
+  const DOUBLE_SLASH_REG = /\/\/|\\\\/g;
+  return new URL(url.replace(DOUBLE_SLASH_REG, "/"), base);
 }
-async function L(e, t, n, u, h) {
-  const o = new Headers(), r = t.headers;
+async function fromNodeHttp(url, req, res, mode, getClientConn) {
+  const requestHeaders = new Headers();
+  const nodeRequestHeaders = req.headers;
   try {
-    for (const [a, l] of Object.entries(r))
-      if (!H.test(a)) {
-        if (typeof l == "string")
-          o.set(a, l);
-        else if (Array.isArray(l))
-          for (const f of l)
-            o.append(a, f);
+    for (const [key, value] of Object.entries(nodeRequestHeaders)) {
+      if (invalidHeadersPattern.test(key)) {
+        continue;
       }
-  } catch (a) {
-    console.error(a);
+      if (typeof value === "string") {
+        requestHeaders.set(key, value);
+      } else if (Array.isArray(value)) {
+        for (const v of value) {
+          requestHeaders.append(key, v);
+        }
+      }
+    }
+  } catch (err) {
+    console.error(err);
   }
-  const m = async function* () {
-    for await (const a of t)
-      yield a;
-  }, i = t.method === "HEAD" || t.method === "GET" ? void 0 : m(), c = new AbortController(), s = {
-    method: t.method,
-    headers: o,
-    body: i,
-    signal: c.signal,
+  const getRequestBody = async function* () {
+    for await (const chunk of req) {
+      yield chunk;
+    }
+  };
+  const body = req.method === "HEAD" || req.method === "GET" ? void 0 : getRequestBody();
+  const controller = new AbortController();
+  const options = {
+    method: req.method,
+    headers: requestHeaders,
+    body,
+    signal: controller.signal,
     duplex: "half"
   };
-  return n.on("close", () => {
-    c.abort();
-  }), {
-    mode: u,
-    url: e,
-    request: new Request(e.href, s),
+  res.on("close", () => {
+    controller.abort();
+  });
+  const serverRequestEv = {
+    mode,
+    url,
+    request: new Request(url.href, options),
     env: {
-      get(a) {
-        return process.env[a];
+      get(key) {
+        return process.env[key];
       }
     },
-    getWritableStream: (a, l, f) => {
-      n.statusCode = a;
+    getWritableStream: (status, headers, cookies) => {
+      res.statusCode = status;
       try {
-        for (const [g, E] of l)
-          H.test(g) || n.setHeader(g, E);
-        const p = f.headers();
-        p.length > 0 && n.setHeader("Set-Cookie", p);
-      } catch (p) {
-        console.error(p);
+        for (const [key, value] of headers) {
+          if (invalidHeadersPattern.test(key)) {
+            continue;
+          }
+          res.setHeader(key, value);
+        }
+        const cookieHeaders = cookies.headers();
+        if (cookieHeaders.length > 0) {
+          res.setHeader("Set-Cookie", cookieHeaders);
+        }
+      } catch (err) {
+        console.error(err);
       }
       return new WritableStream({
-        write(p) {
-          n.closed || n.destroyed || n.write(p, (g) => {
-            g && !P(g.message) && console.error(g);
+        write(chunk) {
+          if (res.closed || res.destroyed) {
+            return;
+          }
+          res.write(chunk, (error) => {
+            if (error && !isIgnoredError(error.message)) {
+              console.error(error);
+            }
           });
         },
         close() {
-          n.end();
+          res.end();
         }
       });
     },
-    getClientConn: () => h ? h(t) : {
-      ip: t.socket.remoteAddress
+    getClientConn: () => {
+      return getClientConn ? getClientConn(req) : {
+        ip: req.socket.remoteAddress
+      };
     },
     platform: {
-      ssr: !0,
-      incomingMessage: t,
+      ssr: true,
+      incomingMessage: req,
       node: process.versions.node
       // Weirdly needed to make typecheck of insights happy
     },
     locale: void 0
   };
+  return serverRequestEv;
 }
-function N(e) {
-  e.qwikCityPlan && !e.qwikRouterConfig && (console.warn("qwikCityPlan is deprecated. Simply remove it."), e.qwikRouterConfig = e.qwikCityPlan), e.manifest && R(e.manifest);
-  const t = e.static?.root ?? v(j(import.meta.url), "..", "..", "dist");
-  return {
-    router: async (o, r, m) => {
-      try {
-        const i = w(o, e), c = await L(
-          y(o, i),
-          o,
-          r,
-          "server",
-          e.getClientConn
-        ), s = await b(c, e);
-        if (s) {
-          const d = await s.completion;
-          if (d)
-            throw d;
-          if (s.requestEv.headersSent)
-            return;
-        }
-        m();
-      } catch (i) {
-        console.error(i), m(i);
+
+function createQwikRouter(opts) {
+  if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
+    console.warn("qwikCityPlan is deprecated. Simply remove it.");
+    opts.qwikRouterConfig = opts.qwikCityPlan;
+  }
+  if (opts.manifest) {
+    setServerPlatform(opts.manifest);
+  }
+  const staticFolder = opts.static?.root ?? join(fileURLToPath(import.meta.url), "..", "..", "dist");
+  const router = async (req, res, next) => {
+    try {
+      const origin = computeOrigin(req, opts);
+      const serverRequestEv = await fromNodeHttp(
+        getUrl(req, origin),
+        req,
+        res,
+        "server",
+        opts.getClientConn
+      );
+      if (isDev && opts.platform) {
+        Object.assign(serverRequestEv.platform, opts.platform);
       }
-    },
-    notFound: async (o, r, m) => {
-      try {
-        if (!r.headersSent) {
-          const i = w(o, e), c = y(o, i), s = !o.headers.accept?.includes("text/html") || x(o.method || "GET", c) ? "Not Found" : C(c.pathname);
-          r.writeHead(404, {
-            "Content-Type": "text/html; charset=utf-8",
-            "X-Not-Found": c.pathname
-          }), r.end(s);
+      const handled = await requestHandler(serverRequestEv, opts);
+      if (handled) {
+        const err = await handled.completion;
+        if (err) {
+          throw err;
         }
-      } catch (i) {
-        console.error(i), m(i);
-      }
-    },
-    staticFile: async (o, r, m) => {
-      try {
-        const i = w(o, e), c = y(o, i);
-        if (x(o.method || "GET", c)) {
-          const s = c.pathname;
-          let d;
-          S(s).includes(".") ? d = v(t, s) : globalThis.__NO_TRAILING_SLASH__ ? d = v(t, s, "index.html") : d = v(t, s + "index.html");
-          const a = T(d).replace(/^\./, ""), l = k(d);
-          l.on("error", m);
-          const f = _[a];
-          f && r.setHeader("Content-Type", f), e.static?.cacheControl && r.setHeader("Cache-Control", e.static.cacheControl), l.pipe(r);
+        if (handled.requestEv.headersSent) {
           return;
         }
-        return m();
-      } catch (i) {
-        console.error(i), m(i);
       }
+      next();
+    } catch (e) {
+      console.error(e);
+      next(e);
     }
   };
+  const notFound = async (req, res, next) => {
+    try {
+      if (!res.headersSent) {
+        const origin = computeOrigin(req, opts);
+        const url = getUrl(req, origin);
+        const notFoundHtml = !req.headers.accept?.includes("text/html") || isStaticPath(req.method || "GET", url) ? "Not Found" : getNotFound(url.pathname);
+        res.writeHead(404, {
+          "Content-Type": "text/html; charset=utf-8",
+          "X-Not-Found": url.pathname
+        });
+        res.end(notFoundHtml);
+      }
+    } catch (e) {
+      console.error(e);
+      next(e);
+    }
+  };
+  const staticFile = async (req, res, next) => {
+    try {
+      const origin = computeOrigin(req, opts);
+      const url = getUrl(req, origin);
+      if (isStaticPath(req.method || "GET", url)) {
+        const pathname = url.pathname;
+        let filePath;
+        if (basename(pathname).includes(".")) {
+          filePath = join(staticFolder, pathname);
+        } else if (!globalThis.__NO_TRAILING_SLASH__) {
+          filePath = join(staticFolder, pathname + "index.html");
+        } else {
+          filePath = join(staticFolder, pathname, "index.html");
+        }
+        const ext = extname(filePath).replace(/^\./, "");
+        const stream = createReadStream(filePath);
+        stream.on("error", next);
+        const contentType = MIME_TYPES[ext];
+        if (contentType) {
+          res.setHeader("Content-Type", contentType);
+        }
+        if (opts.static?.cacheControl) {
+          res.setHeader("Cache-Control", opts.static.cacheControl);
+        }
+        stream.pipe(res);
+        return;
+      }
+      return next();
+    } catch (e) {
+      console.error(e);
+      next(e);
+    }
+  };
+  return {
+    router,
+    notFound,
+    staticFile
+  };
 }
-const $ = N;
-export {
-  $ as createQwikCity,
-  N as createQwikRouter
-};
+const createQwikCity = createQwikRouter;
+
+export { createQwikCity, createQwikRouter };

package/lib/middleware/request-handler/index.d.ts

@@ -1,10 +1,12 @@
 import type { Action } from '@qwik.dev/router';
+import type { AsyncLocalStorage } from 'node:async_hooks';
 import type { EnvGetter as EnvGetter_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { FailReturn } from '@qwik.dev/router';
 import type { Loader as Loader_2 } from '@qwik.dev/router';
 import type { QwikCityPlan } from '@qwik.dev/router';
 import type { QwikIntrinsicElements } from '@qwik.dev/core';
 import type { QwikRouterConfig } from '@qwik.dev/router';
+import { RedirectMessage as RedirectMessage_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { Render } from '@qwik.dev/core/server';
 import type { RenderOptions } from '@qwik.dev/core/server';
 import { RequestEvent as RequestEvent_2 } from '@qwik.dev/router/middleware/request-handler';
@@ -17,6 +19,9 @@ import type { ValueOrPromise } from '@qwik.dev/core';
 export declare class AbortMessage {
 }
 
+/** @internal */
+export declare let _asyncRequestStore: AsyncLocalStorage<RequestEventInternal> | undefined;
+
 /** @public */
 export declare type CacheControl = CacheControlOptions | number | 'day' | 'week' | 'month' | 'year' | 'no-cache' | 'immutable' | 'private';
 
@@ -204,6 +209,7 @@ declare type DocumentHead = DocumentHeadValue | ((props: DocumentHeadProps) => D
 /** @public */
 declare interface DocumentHeadProps extends RouteLocation {
     readonly head: ResolvedDocumentHead;
+    /** @deprecated This is not necessary, it works correctly without */
     readonly withLocale: <T>(fn: () => T) => T;
     readonly resolveValue: ResolveSyncValue_2;
 }
@@ -330,9 +336,21 @@ declare interface PageModule extends RouteModule {
 declare type PathParams = Record<string, string>;
 
 declare interface QwikRouterRun<T> {
+    /**
+     * The response to the request, if any. If there is no response, there might have been an error,
+     * or the request was aborted.
+     */
     response: Promise<T | null>;
     requestEv: RequestEvent_2;
-    completion: Promise<unknown>;
+    /**
+     * Promise for the completion of the request.
+     *
+     * If it returns a RedirectMessage, it means the request must be redirected.
+     *
+     * If it returns an Error, it means there was an error, and if possible, the response already
+     * includes the error. The error is informational only.
+     */
+    completion: Promise<RedirectMessage_2 | Error | undefined>;
 }
 
 /**
@@ -570,7 +588,7 @@ export declare const RequestEvShareQData = "qData";
 export declare type RequestHandler<PLATFORM = QwikRouterPlatform> = (ev: RequestEvent<PLATFORM>) => Promise<void> | void;
 
 /**
- * The request handler for QwikRouter. Called by every integration.
+ * The request handler for QwikRouter. Called by every adapter.
  *
  * @public
  */
@@ -581,14 +599,14 @@ declare type ResolvedDocumentHead<FrontMatter extends Record<string, any> = Reco
 
 /** @public */
 export declare interface ResolveSyncValue {
+    <T, INPUT, OPTIONAL extends boolean>(action: Action<T, INPUT, OPTIONAL>): Awaited<T> | undefined;
     <T>(loader: Loader_2<T>): Awaited<T> extends () => any ? never : Awaited<T>;
-    <T>(action: Action<T>): Awaited<T> | undefined;
 }
 
 /** @public */
 export declare interface ResolveValue {
+    <T, INPUT, OPTIONAL extends boolean>(action: Action<T, INPUT, OPTIONAL>): Promise<T | undefined>;
     <T>(loader: Loader_2<T>): Awaited<T> extends () => any ? never : Promise<T>;
-    <T>(action: Action<T>): Promise<T | undefined>;
 }
 
 /** @public */