@jsenv/server 17.7.0 → 17.7.2

package/dist/client/route_inspector/route_inspector.html

@@ -853,6 +853,18 @@ main {
   font-weight: 700;
 }
 
+.route_also_method {
+  color: #fff;
+  text-shadow: 0 1px #0000001a;
+  background: var(--method-color);
+  border-radius: 3px;
+  margin-left: 6px;
+  padding: 3px 6px;
+  font-family: sans-serif;
+  font-size: 11px;
+  font-weight: 700;
+}
+
 .route_resource {
   word-break: break-word;
   margin-top: 0;
@@ -897,7 +909,7 @@ main {
   opacity: .85;
 }
 
-.route_details[data-forbidden] .route_method {
+.route_details[data-forbidden] .route_method, .route_details[data-forbidden] .route_also_method {
   opacity: .7;
   filter: grayscale(60%);
 }
@@ -1835,6 +1847,7 @@ const routesLoadingSignal = M$1(false);
       const RouteDetails = ({
         meta,
         method,
+        methods,
         resource,
         description,
         availableMediaTypes,
@@ -1858,6 +1871,10 @@ const routesLoadingSignal = M$1(false);
         if (selectedPackageName && packageName !== selectedPackageName) {
           return null;
         }
+        // what the router answers beyond the declared method (a GET route
+        // also answers HEAD); a "*" route answers everything, its chip says so
+        const alsoMethods =
+          method === "*" ? [] : methods.filter((m) => m !== method);
 
         return p$3`<details
             class="route_details"
@@ -1867,6 +1884,14 @@ const routesLoadingSignal = M$1(false);
           >
             <summary class="route_summary_container">
               <span class="route_method">${method}</span>
+              ${alsoMethods.map(
+                (alsoMethod) => p$3`<span
+                    class="route_also_method"
+                    style="--method-color: var(--method-${alsoMethod.toLowerCase()}-color)"
+                    title="Also answers ${alsoMethod}"
+                    >+${alsoMethod}</span
+                  >`,
+              )}
               <p class="route_resource">${resource}</p>
               ${method === "GET" && !forbidden
                 ? p$3`<a

package/dist/jsenv_server.js

@@ -6317,9 +6317,7 @@ const createRouter = (
     };
   };
   const forEachMethodAllowed = (route, onMethodAllowed) => {
-    const supportedMethods =
-      route.method === "*" ? HTTP_METHODS : [route.method];
-    for (const supportedMethod of supportedMethods) {
+    for (const supportedMethod of route.methods) {
       onMethodAllowed(supportedMethod);
     }
   };
@@ -6555,7 +6553,9 @@ It should be should be one of route.${routePropertyName}: ${availableValues.join
           // matching every resource ("GET *", "GET /*") names no resource, so
           // it cannot make that assertion and an unknown address stays a 404
           if (!route.isFallback && !route.matchesEveryResource) {
-            wouldHaveMatched.methodSet.add(route.method);
+            for (const routeMethod of route.methods) {
+              wouldHaveMatched.methodSet.add(routeMethod);
+            }
           }
           continue;
         }
@@ -6876,6 +6876,14 @@ const createRoute = ({
   ) {
     availableMediaTypes.push(extensionWellKnownContentType);
   }
+  // HEAD is GET without the body (RFC 9110 §9.3.2): a GET route answers it and
+  // the server drops the body when sending
+  const methods =
+    method === "*"
+      ? HTTP_METHODS
+      : method === "GET"
+        ? ["GET", "HEAD"]
+        : [method];
   const resourcePattern = createResourcePattern(resource);
   const headersPattern = headers ? createHeadersPattern(headers) : null;
 
@@ -6895,8 +6903,11 @@ const createRoute = ({
     availableVersions,
     availableEncodings,
     acceptedMediaTypes,
+    methods,
     matchMethod:
-      method === "*" ? () => true : (requestMethod) => requestMethod === method,
+      method === "*"
+        ? () => true
+        : (requestMethod) => methods.includes(requestMethod),
     matchResource:
       resource === "*"
         ? () => true
@@ -6948,6 +6959,7 @@ const createRoute = ({
       }
       return {
         method,
+        methods,
         resource,
         description,
         availableMediaTypes,

package/docs/handling_requests.md

@@ -31,6 +31,8 @@ await startServer({
 | `GET /*`               | anything, with the path in `request.params[0]`                                                          |
 | `GET *`                | anything: a catch-all, put it last                                                                      |
 
+A `GET` route also answers `HEAD`: the response is built the same way and sent without its body. When building that body is costly, declare a `HEAD` route for the same resource before the `GET` one: it answers `HEAD` in its place.
+
 Only `*` widens a pattern. Routes are tried in order, so a route covering others (`GET /docs/*`, `GET *`) goes after them. `fetch` can be async; returning `null` or `undefined` declines the request and the next route is tried.
 
 When no route answers, the router builds the response from what almost matched:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/server",
-  "version": "17.7.0",
+  "version": "17.7.2",
   "type": "module",
   "description": "A modern Node.js HTTP server with declarative routing, content negotiation, and WebSocket support",
   "repository": {
@@ -37,7 +37,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "launch-editor": "2.14.1"
+    "launch-editor": "2.14.2"
   },
   "devDependencies": {
     "@jsenv/abort": "../../tooling/abort",

package/src/plugins/route_inspector/client/route_inspector.html

@@ -443,6 +443,17 @@
         background: var(--method-color);
         border-radius: 3px;
       }
+      .route_also_method {
+        margin-left: 6px;
+        padding: 3px 6px;
+        color: #fff;
+        font-weight: 700;
+        font-size: 11px;
+        font-family: sans-serif;
+        text-shadow: 0 1px 0 rgba(0, 0, 0, 0.1);
+        background: var(--method-color);
+        border-radius: 3px;
+      }
       .route_resource {
         margin-top: 0;
         margin-bottom: 0;
@@ -486,7 +497,8 @@
         border-color: var(--forbidden-border-color);
         opacity: 0.85;
       }
-      .route_details[data-forbidden] .route_method {
+      .route_details[data-forbidden] .route_method,
+      .route_details[data-forbidden] .route_also_method {
         opacity: 0.7;
         filter: grayscale(60%);
       }
@@ -1428,6 +1440,7 @@
       const RouteDetails = ({
         meta,
         method,
+        methods,
         resource,
         description,
         availableMediaTypes,
@@ -1451,6 +1464,10 @@
         if (selectedPackageName && packageName !== selectedPackageName) {
           return null;
         }
+        // what the router answers beyond the declared method (a GET route
+        // also answers HEAD); a "*" route answers everything, its chip says so
+        const alsoMethods =
+          method === "*" ? [] : methods.filter((m) => m !== method);
 
         return html`<details
             class="route_details"
@@ -1460,6 +1477,14 @@
           >
             <summary class="route_summary_container">
               <span class="route_method">${method}</span>
+              ${alsoMethods.map(
+                (alsoMethod) => html`<span
+                    class="route_also_method"
+                    style="--method-color: var(--method-${alsoMethod.toLowerCase()}-color)"
+                    title="Also answers ${alsoMethod}"
+                    >+${alsoMethod}</span
+                  >`,
+              )}
               <p class="route_resource">${resource}</p>
               ${method === "GET" && !forbidden
                 ? html`<a

package/src/router/router.js

@@ -121,9 +121,7 @@ export const createRouter = (
     };
   };
   const forEachMethodAllowed = (route, onMethodAllowed) => {
-    const supportedMethods =
-      route.method === "*" ? HTTP_METHODS : [route.method];
-    for (const supportedMethod of supportedMethods) {
+    for (const supportedMethod of route.methods) {
       onMethodAllowed(supportedMethod);
     }
   };
@@ -359,7 +357,9 @@ It should be should be one of route.${routePropertyName}: ${availableValues.join
           // matching every resource ("GET *", "GET /*") names no resource, so
           // it cannot make that assertion and an unknown address stays a 404
           if (!route.isFallback && !route.matchesEveryResource) {
-            wouldHaveMatched.methodSet.add(route.method);
+            for (const routeMethod of route.methods) {
+              wouldHaveMatched.methodSet.add(routeMethod);
+            }
           }
           continue;
         }
@@ -683,6 +683,14 @@ const createRoute = ({
   ) {
     availableMediaTypes.push(extensionWellKnownContentType);
   }
+  // HEAD is GET without the body (RFC 9110 §9.3.2): a GET route answers it and
+  // the server drops the body when sending
+  const methods =
+    method === "*"
+      ? HTTP_METHODS
+      : method === "GET"
+        ? ["GET", "HEAD"]
+        : [method];
   const resourcePattern = createResourcePattern(resource);
   const headersPattern = headers ? createHeadersPattern(headers) : null;
 
@@ -702,8 +710,11 @@ const createRoute = ({
     availableVersions,
     availableEncodings,
     acceptedMediaTypes,
+    methods,
     matchMethod:
-      method === "*" ? () => true : (requestMethod) => requestMethod === method,
+      method === "*"
+        ? () => true
+        : (requestMethod) => methods.includes(requestMethod),
     matchResource:
       resource === "*"
         ? () => true
@@ -755,6 +766,7 @@ const createRoute = ({
       }
       return {
         method,
+        methods,
         resource,
         description,
         availableMediaTypes,