@jsenv/server 15.5.3 → 16.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jsenv/server",
-  "version": "15.5.3",
-  "description": "Write your Node.js server using pure functions",
+  "version": "16.0.0",
+  "description": "A modern Node.js HTTP server with declarative routing, content negotiation, and WebSocket support",
   "license": "MIT",
   "author": {
     "name": "dmail",
@@ -13,7 +13,7 @@
     "directory": "packages/independent/backend/server"
   },
   "engines": {
-    "node": ">=16.13.0"
+    "node": ">=22.13.1"
   },
   "publishConfig": {
     "access": "public"
@@ -21,20 +21,31 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./src/main.js"
+      "import": {
+        "development": "./src/main.js",
+        "default": "./dist/jsenv_server.js"
+      }
     },
     "./*": "./*"
   },
   "main": "./src/main.js",
   "files": [
+    "/dist/",
     "/src/"
   ],
+  "scripts": {
+    "build": "node --experimental-import-meta-resolve ./scripts/build.mjs",
+    "prepublishOnly": "npm run build"
+  },
   "dependencies": {
-    "@jsenv/abort": "4.3.0",
-    "@jsenv/humanize": "1.2.8",
-    "@jsenv/url-meta": "8.5.3",
-    "@jsenv/utils": "2.1.3",
-    "ws": "8.18.0"
+    "@jsenv/router": "0.0.8",
+    "launch-editor": "2.10.0",
+    "@jsenv/abort": "4.3.1",
+    "@jsenv/humanize": "1.3.0",
+    "@jsenv/url-meta": "8.5.4",
+    "@jsenv/utils": "2.2.0",
+    "ws": "8.18.0",
+    "formidable": "3.5.2"
   },
   "devDependencies": {
     "eventsource": "3.0.2",

package/src/content_negotiation/pick_content_version.js

@@ -0,0 +1,63 @@
+import { parseMultipleHeader } from "../internal/multiple-header.js";
+import { pickAcceptedContent } from "./pick_accepted_content.js";
+
+export const pickContentVersion = (request, availableVersions) => {
+  const { headers = {} } = request;
+  const requestAcceptVersionHeader = headers["accept-version"];
+  if (!requestAcceptVersionHeader) {
+    return null;
+  }
+
+  const versionsAccepted = parseAcceptVersionHeader(requestAcceptVersionHeader);
+  return pickAcceptedContent({
+    accepteds: versionsAccepted,
+    availables: availableVersions,
+    getAcceptanceScore: getVersionAcceptanceScore,
+  });
+};
+
+const parseAcceptVersionHeader = (acceptVersionHeaderString) => {
+  const acceptVersionHeader = parseMultipleHeader(acceptVersionHeaderString, {
+    validateProperty: ({ name }) => {
+      // read only q, anything else is ignored
+      return name === "q";
+    },
+  });
+
+  const versionsAccepted = [];
+  for (const key of Object.keys(acceptVersionHeader)) {
+    const { q = 1 } = acceptVersionHeader[key];
+    const value = key;
+    versionsAccepted.push({
+      value,
+      quality: q,
+    });
+  }
+  versionsAccepted.sort((a, b) => {
+    return b.quality - a.quality;
+  });
+  return versionsAccepted;
+};
+
+const getVersionAcceptanceScore = ({ value, quality }, availableVersion) => {
+  if (value === "*") {
+    return quality;
+  }
+
+  if (typeof availableVersion === "function") {
+    if (availableVersion(value)) {
+      return quality;
+    }
+    return -1;
+  }
+
+  if (typeof availableVersion === "number") {
+    availableVersion = String(availableVersion);
+  }
+
+  if (value === availableVersion) {
+    return quality;
+  }
+
+  return -1;
+};

package/src/{fetch_filesystem.js → filesystem/fetch_filesystem.js}

@@ -6,23 +6,27 @@
 
 import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 import { createReadStream, readFile, statSync } from "node:fs";
-import { pickContentEncoding } from "./content_negotiation/pick_content_encoding.js";
-import { convertFileSystemErrorToResponseProperties } from "./internal/convertFileSystemErrorToResponseProperties.js";
-import { bufferToEtag } from "./internal/etag.js";
+import { pickContentEncoding } from "../content_negotiation/pick_content_encoding.js";
+import { convertFileSystemErrorToResponseProperties } from "../internal/convertFileSystemErrorToResponseProperties.js";
+import { bufferToEtag } from "../internal/etag.js";
 import {
   fileSystemPathToUrl,
   isFileSystemPath,
-} from "./internal/filesystem.js";
-import { composeTwoResponses } from "./internal/response_composition.js";
+} from "../internal/filesystem.js";
+import { composeTwoResponses } from "../internal/response_composition.js";
 import { serveDirectory } from "./serve_directory.js";
-import { timeFunction } from "./server_timing/timing_measure.js";
+
+export const createFileSystemFetch = (directoryUrl, options) => {
+  return (request, helpers) => {
+    return fetchFileSystem(request, helpers, directoryUrl, options);
+  };
+};
 
 export const fetchFileSystem = async (
-  filesystemUrl,
+  request,
+  helpers,
+  directoryUrl,
   {
-    // signal,
-    method = "GET",
-    headers = {},
     etagEnabled = false,
     etagMemory = true,
     etagMemoryMaxSize = 1000,
@@ -33,37 +37,34 @@ export const fetchFileSystem = async (
       ? "private,max-age=0,must-revalidate"
       : "no-store",
     canReadDirectory = false,
-    rootDirectoryUrl, //  = `${pathToFileURL(process.cwd())}/`,
     ENOENTFallback = () => {},
   } = {},
 ) => {
-  const urlString = asUrlString(filesystemUrl);
-  if (!urlString) {
-    return create500Response(
-      `fetchFileSystem first parameter must be a file url, got ${filesystemUrl}`,
+  let directoryUrlString = asUrlString(directoryUrl);
+  if (!directoryUrlString) {
+    throw new TypeError(
+      `directoryUrl must be a string or an url, got ${directoryUrl}`,
     );
   }
-  if (!urlString.startsWith("file://")) {
-    return create500Response(
-      `fetchFileSystem url must use "file://" scheme, got ${filesystemUrl}`,
+  if (!directoryUrlString.startsWith("file://")) {
+    throw new Error(
+      `directoryUrl must start with "file://", got ${directoryUrlString}`,
     );
   }
-  if (rootDirectoryUrl) {
-    let rootDirectoryUrlString = asUrlString(rootDirectoryUrl);
-    if (!rootDirectoryUrlString) {
-      return create500Response(
-        `rootDirectoryUrl must be a string or an url, got ${rootDirectoryUrl}`,
-      );
-    }
-    if (!rootDirectoryUrlString.endsWith("/")) {
-      rootDirectoryUrlString = `${rootDirectoryUrlString}/`;
-    }
-    if (!urlString.startsWith(rootDirectoryUrlString)) {
-      return create500Response(
-        `fetchFileSystem url must be inside root directory, got ${urlString}`,
-      );
-    }
-    rootDirectoryUrl = rootDirectoryUrlString;
+  if (!directoryUrlString.endsWith("/")) {
+    directoryUrlString = `${directoryUrlString}/`;
+  }
+  let resource;
+  if (request.params && "0" in request.params) {
+    resource = request.params["0"];
+  } else {
+    resource = request.resource.slice(1);
+  }
+  const filesystemUrl = new URL(resource, directoryUrl);
+  const urlString = asUrlString(filesystemUrl);
+
+  if (typeof cacheControl === "function") {
+    cacheControl = cacheControl(request);
   }
 
   // here you might be tempted to add || cacheControl === 'no-cache'
@@ -86,24 +87,22 @@ export const fetchFileSystem = async (
     mtimeEnabled = false;
   }
 
-  if (method !== "GET" && method !== "HEAD") {
-    return {
-      status: 501,
-    };
+  if (request.method !== "GET" && request.method !== "HEAD") {
+    return null;
   }
 
   const serveFile = async (fileUrl) => {
     try {
-      const [readStatTiming, fileStat] = timeFunction(
-        "file service>read file stat",
-        () => statSync(new URL(fileUrl)),
-      );
+      const readStatTiming = helpers?.timing("file service>read file stat");
+      const fileStat = statSync(new URL(fileUrl));
+      readStatTiming?.end();
+
       if (fileStat.isDirectory()) {
         if (canReadDirectory) {
           return serveDirectory(fileUrl, {
-            headers,
+            headers: request.headers,
             canReadDirectory,
-            rootDirectoryUrl,
+            rootDirectoryUrl: directoryUrl,
           });
         }
         return {
@@ -115,12 +114,12 @@ export const fetchFileSystem = async (
       if (!fileStat.isFile()) {
         return {
           status: 404,
-          timing: readStatTiming,
         };
       }
 
       const clientCacheResponse = await getClientCacheResponse({
-        headers,
+        headers: request.headers,
+        helpers,
         etagEnabled,
         etagMemory,
         etagMemoryMaxSize,
@@ -134,7 +133,6 @@ export const fetchFileSystem = async (
       if (clientCacheResponse.status === 304) {
         return composeTwoResponses(
           {
-            timing: readStatTiming,
             headers: {
               ...(cacheControl ? { "cache-control": cacheControl } : {}),
             },
@@ -146,7 +144,7 @@ export const fetchFileSystem = async (
       let response;
       if (compressionEnabled && fileStat.size >= compressionSizeThreshold) {
         const compressedResponse = await getCompressedResponse({
-          headers,
+          headers: request.headers,
           fileUrl,
         });
         if (compressedResponse) {
@@ -162,7 +160,6 @@ export const fetchFileSystem = async (
 
       const intermediateResponse = composeTwoResponses(
         {
-          timing: readStatTiming,
           headers: {
             ...(cacheControl ? { "cache-control": cacheControl } : {}),
             // even if client cache is disabled, server can still
@@ -197,19 +194,9 @@ export const fetchFileSystem = async (
   return serveFile(`file://${new URL(urlString).pathname}`);
 };
 
-const create500Response = (message) => {
-  return {
-    status: 500,
-    headers: {
-      "content-type": "text/plain",
-      "content-length": Buffer.byteLength(message),
-    },
-    body: message,
-  };
-};
-
 const getClientCacheResponse = async ({
   headers,
+  helpers,
   etagEnabled,
   etagMemory,
   etagMemoryMaxSize,
@@ -232,6 +219,7 @@ const getClientCacheResponse = async ({
   if (etagEnabled) {
     return getEtagResponse({
       headers,
+      helpers,
       etagMemory,
       etagMemoryMaxSize,
       fileStat,
@@ -251,21 +239,20 @@ const getClientCacheResponse = async ({
 
 const getEtagResponse = async ({
   headers,
+  helpers,
   etagMemory,
   etagMemoryMaxSize,
   fileUrl,
   fileStat,
 }) => {
-  const [computeEtagTiming, fileContentEtag] = await timeFunction(
-    "file service>generate file etag",
-    () =>
-      computeEtag({
-        etagMemory,
-        etagMemoryMaxSize,
-        fileUrl,
-        fileStat,
-      }),
-  );
+  const etagTiming = helpers?.timing("file service>generate file etag");
+  const fileContentEtag = await computeEtag({
+    etagMemory,
+    etagMemoryMaxSize,
+    fileUrl,
+    fileStat,
+  });
+  etagTiming?.end();
 
   const requestHasIfNoneMatchHeader = "if-none-match" in headers;
   if (
@@ -274,7 +261,6 @@ const getEtagResponse = async ({
   ) {
     return {
       status: 304,
-      timing: computeEtagTiming,
     };
   }
 
@@ -283,7 +269,6 @@ const getEtagResponse = async ({
     headers: {
       etag: fileContentEtag,
     },
-    timing: computeEtagTiming,
   };
 };
 

package/src/{serve_directory.js → filesystem/serve_directory.js}

@@ -1,6 +1,5 @@
 import { lstatSync, readdirSync } from "node:fs";
-
-import { pickContentType } from "./content_negotiation/pick_content_type.js";
+import { pickContentType } from "../content_negotiation/pick_content_type.js";
 
 export const serveDirectory = (
   url,