added a simple router

CHANGELOG.md

@@ -9,6 +9,7 @@ Go to the `v1` branch to see the changelog of Lume 1.
 ### Added
 - New plugin: `json_ld` for generating JSON-LD tags in the output [#453]
 - New plugin: `purgecss` to remove unused CSS. [#693]
+- New middleware `router`.
 
 ## [2.4.3] - 2024-12-11
 ### Added

middlewares/router.ts

@@ -0,0 +1,99 @@
+import { posix } from "../deps/path.ts";
+
+import type { Middleware } from "../core/server.ts";
+
+interface RouterParams {
+  request: Request;
+  [key: string]: unknown;
+}
+
+type RouteHandler<T = RouterParams> = (
+  params: T,
+) => Response | Promise<Response>;
+
+type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE";
+
+interface RouteDefinition {
+  method: HTTPMethod;
+  pattern: URLPattern;
+  handler: RouteHandler;
+}
+
+export interface Options {
+  basePath?: string;
+  strict?: boolean;
+}
+
+const baseURL = "http://localhost/";
+
+export default class Router {
+  routes: RouteDefinition[] = [];
+  basePath: string;
+  strict: boolean;
+
+  constructor(options?: Options) {
+    this.basePath = options?.basePath ?? "/";
+    this.strict = options?.strict ?? true;
+  }
+
+  add(method: HTTPMethod, pattern: string, handler: RouteHandler) {
+    pattern = posix.join("/", this.basePath, pattern);
+
+    if (!this.strict) {
+      pattern += "{/}?";
+    }
+
+    this.routes.push({
+      method,
+      pattern: new URLPattern(pattern, baseURL),
+      handler,
+    });
+  }
+
+  get(pattern: string, handler: RouteHandler) {
+    this.add("GET", pattern, handler);
+  }
+
+  post(pattern: string, handler: RouteHandler) {
+    this.add("POST", pattern, handler);
+  }
+
+  put(pattern: string, handler: RouteHandler) {
+    this.add("PUT", pattern, handler);
+  }
+
+  delete(pattern: string, handler: RouteHandler) {
+    this.add("DELETE", pattern, handler);
+  }
+
+  async exec(request: Request): Promise<Response | undefined> {
+    for (const { method, pattern, handler } of this.routes) {
+      if (request.method !== method) {
+        continue;
+      }
+
+      const url = new URL(request.url);
+      const result = pattern.exec({
+        pathname: url.pathname,
+        baseURL,
+      });
+
+      if (result) {
+        const data = { ...result.pathname?.groups, request };
+        return await handler(data);
+      }
+    }
+  }
+
+  middleware(): Middleware {
+    return async (request, next) => {
+      const response = await this.exec(request);
+
+      if (response) {
+        return response;
+      }
+
+      return await next(request);
+    };
+  }
+}

tests/__snapshots__/cache_busting.test.ts.snap

@@ -6,6 +6,7 @@ snapshot[`cache busting middleware 1`] = `
   headers: {
     "content-type": "text/plain;charset=UTF-8",
   },
+  method: "GET",
   request: "http://localhost/v1/styles.css",
   status: 200,
   statusText: "",
@@ -18,6 +19,7 @@ snapshot[`cache busting middleware 2`] = `
   headers: {
     "content-type": "text/plain;charset=UTF-8",
   },
+  method: "GET",
   request: "http://localhost/v2873/scripts.js",
   status: 200,
   statusText: "",

tests/__snapshots__/no_cache.test.ts.snap

@@ -7,6 +7,7 @@ snapshot[`no cache middleware 1`] = `
     "cache-control": "no-cache no-store must-revalidate",
     "content-type": "text/plain;charset=UTF-8",
   },
+  method: "GET",
   request: "http://localhost/",
   status: 200,
   statusText: "",

tests/__snapshots__/no_cors.test.ts.snap

@@ -7,6 +7,7 @@ snapshot[`no_cors middleware 1`] = `
     "access-control-allow-origin": "*",
     "content-type": "text/plain;charset=UTF-8",
   },
+  method: "GET",
   request: "http://localhost/",
   status: 200,
   statusText: "",

tests/__snapshots__/router.test.ts.snap

@@ -0,0 +1,222 @@
+export const snapshot = {};
+
+snapshot[`simple routes 1`] = `
+{
+  body: "Hello World from GET",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes 2`] = `
+{
+  body: "Hello World from GET",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://example.com/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes 3`] = `
+{
+  body: "Hello World from POST",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "POST",
+  request: "http://localhost/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes 4`] = `
+{
+  body: "Hello World from POST",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "POST",
+  request: "http://example.com:1234/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes 5`] = `
+{
+  body: "Hello World from PUT",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "PUT",
+  request: "http://localhost/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes 6`] = `
+{
+  body: "Hello World from DELETE",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "DELETE",
+  request: "http://localhost/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes with base path 1`] = `
+{
+  body: "Not Found",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello",
+  status: 404,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes with base path 2`] = `
+{
+  body: "Hello World from GET",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://example.com/api/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`simple routes with base path 3`] = `
+{
+  body: "Hello World from GET",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://example.com:1234/api/hello",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters 1`] = `
+{
+  body: "Not Found",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello",
+  status: 404,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters 2`] = `
+{
+  body: "Hello oscar",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello/oscar",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters 3`] = `
+{
+  body: "Not Found",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello/oscar/",
+  status: 404,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters and strict = false 1`] = `
+{
+  body: "Not Found",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello",
+  status: 404,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters and strict = false 2`] = `
+{
+  body: "Hello oscar / null",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello/oscar",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters and strict = false 3`] = `
+{
+  body: "Hello oscar / null",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello/oscar/",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters and strict = false 4`] = `
+{
+  body: "Hello oscar / foo",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello/oscar/?query=foo",
+  status: 200,
+  statusText: "",
+}
+`;
+
+snapshot[`routes with parameters and strict = false 5`] = `
+{
+  body: "Hello oscar / foo",
+  headers: {
+    "content-type": "text/plain;charset=UTF-8",
+  },
+  method: "GET",
+  request: "http://localhost/hello/oscar?query=foo",
+  status: 200,
+  statusText: "",
+}
+`;