@jsenv/server 12.4.2 → 12.5.3

package/main.js

@@ -7,7 +7,6 @@
 export { startServer } from "./src/startServer.js"
 export { composeServices } from "./src/service_composition/service_composition.js"
 export { setupRoutes } from "./src/service_composition/routing.js"
-export { jsenvServerInternalErrorToResponse } from "./src/jsenvServerInternalErrorToResponse.js"
 export { readRequestBody } from "./src/readRequestBody.js"
 export { fetchFileSystem } from "./src/fetch_filesystem.js"
 export {
@@ -42,6 +41,7 @@ export { pluginContentNegotiationCheck } from "./src/content_negotiation/plugin_
 
 // others
 export { fetchUrl } from "./src/fetch_url.js"
+export { serveDirectory } from "./src/serve_directory.js"
 export { fromFetchResponse } from "./src/from_fetch_response.js"
 export { composeTwoResponses } from "./src/internal/response_composition.js"
 export { pluginRessourceAliases } from "./src/ressource_aliases/plugin_ressource_aliases.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/server",
-  "version": "12.4.2",
+  "version": "12.5.3",
   "description": "Write your Node.js server using pure functions",
   "license": "MIT",
   "author": {
@@ -16,8 +16,7 @@
     "node": ">=16.13.0"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
   },
   "type": "module",
   "exports": {
@@ -35,9 +34,9 @@
     "importmap": "node ./script/importmap/importmap.mjs",
     "eslint": "node ./node_modules/eslint/bin/eslint.js . --ext=.js,.mjs",
     "performance": "node --expose-gc ./script/performance/performance.mjs --log",
+    "snapshot": "node ./test/internal_error/generate_html_snapshot_files.mjs",
     "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
-    "generate-html-snapshots": "node ./test/internal_error/generate_html_snapshot_files.mjs",
     "prettier": "prettier --write .",
     "certificate-install": "node ./script/certificate/certificate_install.mjs",
     "playwright-install": "npx playwright install-deps && npx playwright install"
@@ -68,4 +67,4 @@
     "playwright": "1.18.1",
     "prettier": "2.5.1"
   }
-}
+}

package/src/{jsenvServerInternalErrorToResponse.js → error_to_response_default.js}

@@ -1,14 +1,18 @@
 import { negotiateContentType } from "./content_negotiation/negotiateContentType.js"
 
-export const jsenvServerInternalErrorToResponse = (
+export const applyDefaultErrorToResponse = (
   serverInternalError,
-  { request, sendServerInternalErrorDetails = false },
+  { request, sendErrorDetails = false },
 ) => {
   const serverInternalErrorIsAPrimitive =
     serverInternalError === null ||
     (typeof serverInternalError !== "object" &&
       typeof serverInternalError !== "function")
 
+  if (!serverInternalErrorIsAPrimitive && serverInternalError.asResponse) {
+    return serverInternalError.asResponse()
+  }
+
   const dataToSend = serverInternalErrorIsAPrimitive
     ? {
         code: "VALUE_THROWED",
@@ -16,7 +20,7 @@ export const jsenvServerInternalErrorToResponse = (
       }
     : {
         code: serverInternalError.code || "UNKNOWN_ERROR",
-        ...(sendServerInternalErrorDetails
+        ...(sendErrorDetails
           ? {
               stack: serverInternalError.stack,
               ...serverInternalError,
@@ -27,7 +31,7 @@ export const jsenvServerInternalErrorToResponse = (
   const availableContentTypes = {
     "text/html": () => {
       const renderHtmlForErrorWithoutDetails = () => {
-        return `<p>Details not available: to enable them server must be started with sendServerInternalErrorDetails: true.</p>`
+        return `<p>Details not available: to enable them server must be started with sendErrorDetails: true.</p>`
       }
 
       const renderHtmlForErrorWithDetails = () => {
@@ -55,7 +59,7 @@ export const jsenvServerInternalErrorToResponse = (
     <details>
       <summary>See internal error details</summary>
       ${
-        sendServerInternalErrorDetails
+        sendErrorDetails
           ? renderHtmlForErrorWithDetails()
           : renderHtmlForErrorWithoutDetails()
       }

package/src/fetch_filesystem.js

@@ -16,9 +16,9 @@ import { composeTwoResponses } from "./internal/response_composition.js"
 import { convertFileSystemErrorToResponseProperties } from "./internal/convertFileSystemErrorToResponseProperties.js"
 import { jsenvContentTypeMap } from "./jsenvContentTypeMap.js"
 import { timeFunction } from "./server_timing/timing_measure.js"
-import { negotiateContentType } from "./content_negotiation/negotiateContentType.js"
 import { negotiateContentEncoding } from "./content_negotiation/negotiateContentEncoding.js"
 import { urlToContentType } from "./urlToContentType.js"
+import { serveDirectory } from "./serve_directory.js"
 
 const ETAG_MEMORY_MAP = new Map()
 
@@ -39,7 +39,7 @@ export const fetchFileSystem = async (
       ? "private,max-age=0,must-revalidate"
       : "no-store",
     canReadDirectory = false,
-    rootDirectoryUrl = `${fileSystemPathToUrl(process.cwd())}/`,
+    rootDirectoryUrl,
   } = {},
 ) => {
   const urlString = asUrlString(filesystemUrl)
@@ -88,83 +88,13 @@ export const fetchFileSystem = async (
       "file service>read file stat",
       () => statSync(sourceFilesystemPath),
     )
-
     if (sourceStat.isDirectory()) {
-      sourceUrl =
-        urlString[urlString.length - 1] === "/" ? urlString : `${urlString}/`
-
-      if (canReadDirectory === false) {
-        return {
-          status: 403,
-          statusText: "not allowed to read directory",
-          timing: readStatTiming,
-        }
-      }
-
-      const [readDirectoryTiming, directoryContentArray] = await timeFunction(
-        "file service>read directory",
-        () => promises.readdir(sourceFilesystemPath),
-      )
-
-      const responseProducers = {
-        "application/json": () => {
-          const directoryContentJson = JSON.stringify(directoryContentArray)
-          return {
-            status: 200,
-            headers: {
-              "content-type": "application/json",
-              "content-length": directoryContentJson.length,
-            },
-            body: directoryContentJson,
-            timing: {
-              ...readStatTiming,
-              ...readDirectoryTiming,
-            },
-          }
-        },
-        "text/html": () => {
-          const directoryAsHtml = `<!DOCTYPE html>
-<html>
-  <head>
-    <title>Directory explorer</title>
-    <meta charset="utf-8" />
-    <link rel="icon" href="data:," />
-  </head>
-
-  <body>
-    <h1>Content of directory ${sourceUrl}</h1>
-    <ul>
-      ${directoryContentArray.map((filename) => {
-        const fileUrl = String(new URL(filename, sourceUrl))
-        const fileUrlRelativeToServer = fileUrl.slice(
-          String(rootDirectoryUrl).length,
-        )
-        return `<li>
-        <a href="/${fileUrlRelativeToServer}">${fileUrlRelativeToServer}</a>
-      </li>`
-      }).join(`
-      `)}
-    </ul>
-  </body>
-</html>`
-
-          return {
-            status: 200,
-            headers: {
-              "content-type": "text/html",
-              "content-length": Buffer.byteLength(directoryAsHtml),
-            },
-            body: directoryAsHtml,
-          }
-        },
-      }
-      const bestContentType = negotiateContentType(
-        { headers },
-        Object.keys(responseProducers),
-      )
-      return responseProducers[bestContentType || "application/json"]()
+      return serveDirectory(urlString, {
+        headers,
+        canReadDirectory,
+        rootDirectoryUrl,
+      })
     }
-
     // not a file, give up
     if (!sourceStat.isFile()) {
       return {
@@ -239,7 +169,7 @@ export const fetchFileSystem = async (
           ...(cacheControl ? { "cache-control": cacheControl } : {}),
         },
       },
-      convertFileSystemErrorToResponseProperties(e),
+      convertFileSystemErrorToResponseProperties(e) || {},
     )
   }
 }

package/src/internal/convertFileSystemErrorToResponseProperties.js

@@ -6,21 +6,18 @@ export const convertFileSystemErrorToResponseProperties = (error) => {
       statusText: `EACCES: No permission to read file at ${error.path}`,
     }
   }
-
   if (isErrorWithCode(error, "EPERM")) {
     return {
       status: 403,
       statusText: `EPERM: No permission to read file at ${error.path}`,
     }
   }
-
   if (isErrorWithCode(error, "ENOENT")) {
     return {
       status: 404,
       statusText: `ENOENT: File not found at ${error.path}`,
     }
   }
-
   // file access may be temporarily blocked
   // (by an antivirus scanning it because recently modified for instance)
   if (isErrorWithCode(error, "EBUSY")) {
@@ -32,7 +29,6 @@ export const convertFileSystemErrorToResponseProperties = (error) => {
       },
     }
   }
-
   // emfile means there is too many files currently opened
   if (isErrorWithCode(error, "EMFILE")) {
     return {
@@ -43,15 +39,13 @@ export const convertFileSystemErrorToResponseProperties = (error) => {
       },
     }
   }
-
   if (isErrorWithCode(error, "EISDIR")) {
     return {
       status: 500,
       statusText: `EISDIR: Unexpected directory operation at ${error.path}`,
     }
   }
-
-  return Promise.reject(error)
+  return null
 }
 
 const isErrorWithCode = (error, code) => {

package/src/serve_directory.js

@@ -0,0 +1,76 @@
+import { readdirSync } from "node:fs"
+import { pathToFileURL } from "node:url"
+
+import { negotiateContentType } from "./content_negotiation/negotiateContentType.js"
+
+export const serveDirectory = (
+  url,
+  {
+    headers = {},
+    canReadDirectory = false,
+    rootDirectoryUrl = `${pathToFileURL(process.cwd())}/`,
+  } = {},
+) => {
+  if (canReadDirectory === false) {
+    return {
+      status: 403,
+      statusText: "not allowed to read directory",
+    }
+  }
+  url = String(url)
+  url = url[url.length - 1] === "/" ? url : `${url}/`
+  const directoryContentArray = readdirSync(new URL(url))
+  const responseProducers = {
+    "application/json": () => {
+      const directoryContentJson = JSON.stringify(directoryContentArray)
+      return {
+        status: 200,
+        headers: {
+          "content-type": "application/json",
+          "content-length": directoryContentJson.length,
+        },
+        body: directoryContentJson,
+      }
+    },
+    "text/html": () => {
+      const directoryAsHtml = `<!DOCTYPE html>
+<html>
+  <head>
+    <title>Directory explorer</title>
+    <meta charset="utf-8" />
+    <link rel="icon" href="data:," />
+  </head>
+
+  <body>
+    <h1>Content of directory ${url}</h1>
+    <ul>
+      ${directoryContentArray.map((filename) => {
+        const fileUrl = String(new URL(filename, url))
+        const fileUrlRelativeToServer = fileUrl.slice(
+          String(rootDirectoryUrl).length,
+        )
+        return `<li>
+        <a href="/${fileUrlRelativeToServer}">${fileUrlRelativeToServer}</a>
+      </li>`
+      }).join(`
+      `)}
+    </ul>
+  </body>
+</html>`
+
+      return {
+        status: 200,
+        headers: {
+          "content-type": "text/html",
+          "content-length": Buffer.byteLength(directoryAsHtml),
+        },
+        body: directoryAsHtml,
+      }
+    },
+  }
+  const bestContentType = negotiateContentType(
+    { headers },
+    Object.keys(responseProducers),
+  )
+  return responseProducers[bestContentType || "application/json"]()
+}

package/src/startServer.js

@@ -23,7 +23,7 @@ import { composeTwoResponses } from "./internal/response_composition.js"
 import { listenRequest } from "./internal/listenRequest.js"
 import { listenServerConnectionError } from "./internal/listenServerConnectionError.js"
 import { memoize } from "./internal/memoize.js"
-import { jsenvServerInternalErrorToResponse } from "./jsenvServerInternalErrorToResponse.js"
+import { applyDefaultErrorToResponse } from "./error_to_response_default.js"
 import {
   STOP_REASON_INTERNAL_ERROR,
   STOP_REASON_PROCESS_SIGHUP,
@@ -62,8 +62,8 @@ export const startServer = async ({
   requestToResponse = () => null,
   plugins = {},
 
-  sendServerInternalErrorDetails = false,
-  serverInternalErrorToResponse = jsenvServerInternalErrorToResponse,
+  sendErrorDetails = false,
+  errorToResponse = () => null,
 
   onListenStart = () => {},
   onListenEnd = () => {},
@@ -554,13 +554,15 @@ export const startServer = async ({
             // il faudrais pouvoir stop que les autres response ?
             stop(STOP_REASON_INTERNAL_ERROR)
           }
-          const propertiesFromError = await serverInternalErrorToResponse(
-            error,
-            {
+          const responseDescriptionFromError =
+            (await errorToResponse(error, {
               request,
-              sendServerInternalErrorDetails,
-            },
-          )
+              sendErrorDetails,
+            })) ||
+            (await applyDefaultErrorToResponse(error, {
+              request,
+              sendErrorDetails,
+            }))
           addRequestLog(requestNode, {
             type: "error",
             value: createDetailedMessage(
@@ -580,7 +582,7 @@ export const startServer = async ({
                 "content-type": "text/plain",
               },
             },
-            propertiesFromError,
+            responseDescriptionFromError,
           )
         }