chore(router): lint++

Author: wmertens

packages/qwik-router/src/buildtime/build.ts

@@ -1,5 +1,6 @@
 import { addError, addWarning } from '../utils/format';
 import { resolveSourceFiles } from './routing/resolve-source-file';
+import { routeSortCompare } from './routing/sort-routes';
 import { walkRoutes } from './routing/walk-routes-dir';
 import { walkServerPlugins } from './routing/walk-server-plugins';
 import type { RoutingContext, BuiltRoute, RewriteRouteOption } from './types';
@@ -21,35 +22,29 @@ export async function parseRoutesDir(ctx: RoutingContext) {
   }
 }
 
-export async function updateRoutingContext(ctx: RoutingContext) {
-  if (!ctx.activeBuild) {
-    ctx.activeBuild = new Promise<void>((resolve, reject) => {
-      walkServerPlugins(ctx.opts)
-        .then((serverPlugins) => {
-          ctx.serverPlugins = serverPlugins;
-          return walkRoutes(ctx.opts.routesDir);
-        })
-        .then((sourceFiles) => {
-          const resolved = resolveSourceFiles(ctx.opts, sourceFiles);
-          rewriteRoutes(ctx, resolved);
-          ctx.layouts = resolved.layouts;
-          ctx.routes = resolved.routes;
-          ctx.entries = resolved.entries;
-          ctx.serviceWorkers = resolved.serviceWorkers;
-          ctx.menus = resolved.menus;
-          resolve();
-        }, reject)
-        .finally(() => {
-          ctx.activeBuild = null;
-        });
-    });
-  }
+export function updateRoutingContext(ctx: RoutingContext) {
+  ctx.activeBuild ||= _updateRoutingContext(ctx).finally(() => {
+    ctx.activeBuild = null;
+  });
   return ctx.activeBuild;
 }
 
-function rewriteRoutes(ctx: RoutingContext, resolvedFiles: ReturnType<typeof resolveSourceFiles>) {
-  if (!ctx.opts.rewriteRoutes || !resolvedFiles.routes) {
-    return;
+async function _updateRoutingContext(ctx: RoutingContext) {
+  const serverPlugins = await walkServerPlugins(ctx.opts);
+  const sourceFiles = await walkRoutes(ctx.opts.routesDir);
+  const resolved = resolveSourceFiles(ctx.opts, sourceFiles);
+  resolved.routes = rewriteRoutes(ctx, resolved.routes);
+  ctx.serverPlugins = serverPlugins;
+  ctx.layouts = resolved.layouts;
+  ctx.routes = resolved.routes;
+  ctx.entries = resolved.entries;
+  ctx.serviceWorkers = resolved.serviceWorkers;
+  ctx.menus = resolved.menus;
+}
+
+function rewriteRoutes(ctx: RoutingContext, routes: BuiltRoute[]) {
+  if (!ctx.opts.rewriteRoutes) {
+    return routes;
   }
 
   const translatedRoutes: BuiltRoute[] = [];
@@ -60,7 +55,7 @@ function rewriteRoutes(ctx: RoutingContext, resolvedFiles: ReturnType<typeof res
 
   segmentsToTranslate = Array.from(new Set(segmentsToTranslate));
 
-  resolvedFiles.routes.forEach((route) => {
+  routes.forEach((route) => {
     // always push the original route
     translatedRoutes.push(route);
 
@@ -91,7 +86,7 @@ function rewriteRoutes(ctx: RoutingContext, resolvedFiles: ReturnType<typeof res
     }
   });
 
-  resolvedFiles.routes = translatedRoutes;
+  return translatedRoutes.sort(routeSortCompare);
 }
 
 function translateRoute(

packages/qwik-router/src/buildtime/routing/sort-routes.ts

@@ -1,5 +1,6 @@
 import type { BuiltRoute } from '../types';
 
+/** Sort routes by pathname, then by extension. Longer routes are sorted first. */
 export function routeSortCompare(a: BuiltRoute, b: BuiltRoute) {
   const maxSegments = Math.max(a.segments.length, b.segments.length);
 

packages/qwik-router/src/middleware/request-handler/request-event.ts

@@ -144,9 +144,11 @@ export function createRequestEvent(
     return exit();
   };
 
-  const exit = () => {
+  const exit = <T extends AbortMessage | RedirectMessage | RewriteMessage>(
+    message: T = new AbortMessage() as T
+  ) => {
     routeModuleIndex = ABORT_INDEX;
-    return new AbortMessage();
+    return message;
   };
 
   const loaders: Record<string, ValueOrPromise<unknown> | undefined> = {};
@@ -252,8 +254,7 @@ export function createRequestEvent(
       if (statusCode > 301) {
         headers.set('Cache-Control', 'no-store');
       }
-      exit();
-      return new RedirectMessage();
+      return exit(new RedirectMessage());
     },
 
     rewrite: (pathname: string) => {
@@ -262,7 +263,7 @@ export function createRequestEvent(
         throw new Error('Rewrite does not support absolute urls');
       }
       sharedMap.set(RequestEvIsRewrite, true);
-      return new RewriteMessage(pathname.replace(/\/+/g, '/'));
+      return exit(new RewriteMessage(pathname.replace(/\/+/g, '/')));
     },
 
     defer: (returnData) => {

packages/qwik-router/src/middleware/request-handler/request-handler.ts

@@ -11,7 +11,7 @@ import { getRouteMatchPathname, runQwikRouter, type QwikRouterRun } from './user
  */
 let qwikRouterConfigActual: QwikRouterConfig;
 /**
- * The request handler for QwikRouter. Called by every integration.
+ * The request handler for QwikRouter. Called by every adapter.
  *
  * @public
  */

packages/qwik-router/src/middleware/request-handler/user-response.ts

@@ -8,19 +8,31 @@ import type {
 import { getErrorHtml } from './error-handler';
 import { createRequestEvent, getRequestMode, type RequestEventInternal } from './request-event';
 import { encoder } from './resolve-request-handlers';
-import type { ServerRequestEvent, StatusCodes } from './types';
 // Import separately to avoid duplicate imports in the vite dev server
 import {
   AbortMessage,
   RedirectMessage,
   RewriteMessage,
   ServerError,
 } from '@qwik.dev/router/middleware/request-handler';
+import type { QwikSerializer, ServerRequestEvent, StatusCodes } from './types';
 
 export 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;
-  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 | Error | undefined>;
 }
 
 let asyncStore: AsyncStore | undefined;
@@ -67,7 +79,7 @@ async function runNext(
   requestEv: RequestEventInternal,
   rebuildRouteInfo: RebuildRouteInfoInternal,
   resolve: (value: any) => void
-) {
+): Promise<Error | RedirectMessage | undefined> {
   try {
     const isValidURL = (url: URL) => new URL(url.pathname + url.search, url);
     isValidURL(requestEv.originalUrl);
@@ -90,9 +102,10 @@ async function runNext(
       if (e instanceof RedirectMessage) {
         const stream = requestEv.getWritableStream();
         await stream.close();
+        return e;
       } else if (e instanceof RewriteMessage) {
         if (rewriteAttempt > 50) {
-          throw new Error(`Infinite rewrite loop`);
+          return new Error(`Infinite rewrite loop`);
         }
 
         rewriteAttempt += 1;
@@ -101,48 +114,47 @@ async function runNext(
         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 as StatusCodes;
-          const accept = requestEv.request.headers.get('Accept');
-          if (accept && !accept.includes('text/html')) {
-            requestEv.headers.set('Content-Type', 'application/qwik-json');
-            requestEv.send(status, await _serialize([e.data]));
-          } else {
-            const html = getErrorHtml(e.status, e.data);
-            requestEv.html(status, html);
-          }
+      } else if (e instanceof AbortMessage) {
+        return;
+      } else if (e instanceof ServerError && !requestEv.headersSent) {
+        const status = e.status as StatusCodes;
+        const accept = requestEv.request.headers.get('Accept');
+        if (accept && !accept.includes('text/html')) {
+          requestEv.headers.set('Content-Type', 'application/qwik-json');
+          requestEv.send(status, await _serialize([e.data]));
+        } else {
+          // TODO render the custom error route
+          requestEv.html(status, getErrorHtml(status, e.data));
         }
-      } 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(getErrorHtml(500, 'Internal Server Error')));
-              await writer.close();
-            }
-          } catch {
-            console.error('Unable to render error page');
+        return e;
+      }
+      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(getErrorHtml(500, 'Internal Server Error')));
+            await writer.close();
           }
+        } catch {
+          console.error('Unable to render error page');
         }
-
-        return e;
       }
-    }
 
-    return undefined;
+      return e as Error;
+    }
   }
 
   try {
     return await _runNext();
   } finally {
     if (!requestEv.isDirty()) {
+      // The request didn't get handled, so we need to resolve with null.
       resolve(null);
     }
   }

packages/qwik-router/src/utils/fs.ts

@@ -79,7 +79,7 @@ export function normalizePath(path: string) {
 export function normalizePathSlash(path: string) {
   // MIT https://github.com/sindresorhus/slash/blob/main/license
   // Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar
-  const isExtendedLengthPath = /^\\\\\?\\/.test(path);
+  const isExtendedLengthPath = path.startsWith('\\\\?\\');
   const hasNonAscii = /[^\u0000-\u0080]+/.test(path); // eslint-disable-line no-control-regex
 
   if (isExtendedLengthPath || hasNonAscii) {
@@ -139,17 +139,17 @@ export function createFileId(
 const PAGE_MODULE_EXTS: { [type: string]: boolean } = {
   '.tsx': true,
   '.jsx': true,
-};
+} as const;
 
 const MODULE_EXTS: { [type: string]: boolean } = {
   '.ts': true,
   '.js': true,
-};
+} as const;
 
 const MARKDOWN_EXTS: { [type: string]: boolean } = {
   '.md': true,
   '.mdx': true,
-};
+} as const;
 
 export function isIndexModule(extlessName: string) {
   return /^index(|!|@.+)$/.test(extlessName);
@@ -192,13 +192,7 @@ export function isEntryName(extlessName: string) {
 }
 
 export function isErrorName(extlessName: string) {
-  try {
-    const statusCode = parseInt(extlessName, 10);
-    return statusCode >= 400 && statusCode <= 599;
-  } catch (e) {
-    //
-  }
-  return false;
+  return /^[45][0-9]{2}$/.test(extlessName);
 }
 
 export function isGroupedLayoutName(dirName: string, warn = true) {