@jsenv/core 41.0.2 → 41.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "41.0.2",
+  "version": "41.0.4",
   "description": "Tool to develop, test and build js projects",
   "repository": {
     "type": "git",
@@ -81,7 +81,7 @@
     "@jsenv/plugin-minification": "1.7.3",
     "@jsenv/plugin-supervisor": "1.7.15",
     "@jsenv/plugin-transpilation": "1.5.70",
-    "@jsenv/server": "17.0.1",
+    "@jsenv/server": "17.0.3",
     "@jsenv/sourcemap": "1.3.17",
     "react-table": "7.8.0"
   },

package/src/build/start_build_server.js

@@ -14,16 +14,14 @@
  */
 
 import { Abort, raceProcessTeardownEvents } from "@jsenv/abort";
-import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem";
 import { createLogger, createTaskLog } from "@jsenv/humanize";
 import {
+  createFileSystemFetch,
   jsenvAccessControlAllowedHeaders,
   serverPluginCORS,
   serverPluginErrorHandler,
-  serverPluginStaticFiles,
   startServer,
 } from "@jsenv/server";
-import { existsSync } from "node:fs";
 
 /**
  * Start a server for build files.
@@ -35,7 +33,7 @@ export const startBuildServer = async ({
   buildDirectoryUrl,
   buildDirectoryMainFileRelativeUrl = "index.html",
   port = 9779,
-  routes,
+  routes = [],
   serverPlugins = [],
   acceptAnyIp,
   hostname,
@@ -47,55 +45,7 @@ export const startBuildServer = async ({
   signal = new AbortController().signal,
   handleSIGINT = true,
   keepProcessAlive = true,
-
-  ...rest
 }) => {
-  // params validation
-  {
-    const unexpectedParamNames = Object.keys(rest);
-    if (unexpectedParamNames.length > 0) {
-      throw new TypeError(
-        `${unexpectedParamNames.join(",")}: there is no such param`,
-      );
-    }
-    buildDirectoryUrl = assertAndNormalizeDirectoryUrl(
-      buildDirectoryUrl,
-      "buildDirectoryUrl",
-    );
-
-    if (buildDirectoryMainFileRelativeUrl) {
-      if (typeof buildDirectoryMainFileRelativeUrl !== "string") {
-        throw new TypeError(
-          `buildDirectoryMainFileRelativeUrl must be a string, got ${buildDirectoryMainFileRelativeUrl}`,
-        );
-      }
-      if (buildDirectoryMainFileRelativeUrl[0] === "/") {
-        buildDirectoryMainFileRelativeUrl =
-          buildDirectoryMainFileRelativeUrl.slice(1);
-      } else {
-        const buildMainFileUrl = new URL(
-          buildDirectoryMainFileRelativeUrl,
-          buildDirectoryUrl,
-        ).href;
-        if (!buildMainFileUrl.startsWith(buildDirectoryUrl)) {
-          throw new Error(
-            `buildDirectoryMainFileRelativeUrl must be relative, got ${buildDirectoryMainFileRelativeUrl}`,
-          );
-        }
-        buildDirectoryMainFileRelativeUrl = buildMainFileUrl.slice(
-          buildDirectoryUrl.length,
-        );
-      }
-      if (
-        !existsSync(
-          new URL(buildDirectoryMainFileRelativeUrl, buildDirectoryUrl),
-        )
-      ) {
-        buildDirectoryMainFileRelativeUrl = null;
-      }
-    }
-  }
-
   const logger = createLogger({ logLevel });
   const operation = Abort.startOperation();
   operation.addAbortSignal(signal);
@@ -129,7 +79,6 @@ export const startBuildServer = async ({
     port,
     serverTiming: true,
     requestWaitingMs: 60_000,
-    routes,
     plugins: [
       serverPluginCORS({
         accessControlAllowRequestOrigin: true,
@@ -140,15 +89,20 @@ export const startBuildServer = async ({
         timingAllowOrigin: true,
       }),
       ...serverPlugins,
-      serverPluginStaticFiles({
-        serverRelativeUrl: "/",
-        directoryUrl: buildDirectoryUrl,
-        directoryMainFileRelativeUrl: buildDirectoryMainFileRelativeUrl,
-      }),
       serverPluginErrorHandler({
         sendErrorDetails: false,
       }),
     ],
+    routes: [
+      ...routes,
+      {
+        endpoint: "GET /",
+        description: "Serve build files",
+        fetch: createFileSystemFetch(buildDirectoryUrl, {
+          mainFileRelativeUrl: buildDirectoryMainFileRelativeUrl,
+        }),
+      },
+    ],
   });
   startBuildServerTask.done();
   if (hostname) {

package/src/{plugins/chrome_devtools_json/jsenv_plugin_chrome_devtools_json.js → dev/dev_server_plugins/dev_server_plugin_chrome_devtools_json.js}

@@ -9,7 +9,7 @@ import { urlToFileSystemPath } from "@jsenv/urls";
 import { randomUUID } from "node:crypto";
 import { existsSync, readFileSync } from "node:fs";
 
-export const jsenvPluginChromeDevtoolsJson = () => {
+export const devServerPluginChromeDevToolsJson = ({ sourceDirectoryUrl }) => {
   const getOrCreateUUID = (kitchen) => {
     const { outDirectoryUrl } = kitchen.context;
     const uuidFileUrl = new URL("./uuid.json", outDirectoryUrl);
@@ -23,17 +23,15 @@ export const jsenvPluginChromeDevtoolsJson = () => {
   };
 
   return {
-    name: "jsenv_plugin_chrome_devtools_json",
-    appliesDuring: "dev",
-    serverRoutes: [
+    name: "jsenv:chrome_devtools_json",
+    routes: [
       {
         endpoint: "GET /.well-known/appspecific/com.chrome.devtools.json",
         declarationSource: import.meta.url,
         fetch: (request, { kitchen }) => {
-          const { rootDirectoryUrl } = kitchen.context;
           return Response.json({
             workspace: {
-              root: urlToFileSystemPath(rootDirectoryUrl),
+              root: urlToFileSystemPath(sourceDirectoryUrl),
               uuid: getOrCreateUUID(kitchen),
             },
           });

package/src/dev/dev_server_plugins/dev_server_plugin_inject_server_response_header.js

@@ -0,0 +1,27 @@
+export const devServerPluginInjectServerResponseHeader = ({
+  sourceDirectoryUrl,
+}) => {
+  return {
+    name: "jsenv:jsenv_inject_server_response_header",
+    routes: [
+      {
+        endpoint: "GET /.internal/server.json",
+        description: "Get information about jsenv dev server",
+        availableMediaTypes: ["application/json"],
+        declarationSource: import.meta.url,
+        fetch: () =>
+          Response.json({
+            server: "jsenv_dev_server/1",
+            sourceDirectoryUrl,
+          }),
+      },
+    ],
+    injectResponseProperties: () => {
+      return {
+        headers: {
+          server: "jsenv_dev_server/1",
+        },
+      };
+    },
+  };
+};

package/src/dev/dev_server_plugins/dev_server_plugin_omega_error_handler.js

@@ -0,0 +1,44 @@
+import { serverPluginErrorHandler } from "@jsenv/server";
+import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/plugins/filesystem/filesystem_error_to_response.js";
+
+export const devServerPluginOmegaErrorHandler = () => {
+  return [
+    {
+      name: "jsenv:omega_error_handler",
+      handleError: (error) => {
+        const getResponseForError = () => {
+          if (error && error.asResponse) {
+            return error.asResponse();
+          }
+          if (error && error.statusText === "Unexpected directory operation") {
+            return {
+              status: 403,
+            };
+          }
+          return convertFileSystemErrorToResponseProperties(error);
+        };
+        const response = getResponseForError();
+        if (!response) {
+          return null;
+        }
+        const body = JSON.stringify({
+          status: response.status,
+          statusText: response.statusText,
+          headers: response.headers,
+          body: response.body,
+        });
+        return {
+          status: response.status,
+          headers: {
+            "content-type": "application/json",
+            "content-length": Buffer.byteLength(body),
+          },
+          body,
+        };
+      },
+    },
+    serverPluginErrorHandler({
+      sendErrorDetails: true,
+    }),
+  ];
+};

package/src/dev/dev_server_plugins/dev_server_plugin_serve_source_files.js

@@ -0,0 +1,410 @@
+import { bufferToEtag } from "@jsenv/filesystem";
+import { formatError } from "@jsenv/humanize";
+import { composeTwoResponses, fetchDirectory } from "@jsenv/server";
+import { URL_META } from "@jsenv/url-meta";
+import { readFileSync } from "node:fs";
+
+import { watchSourceFiles } from "../../helpers/watch_source_files.js";
+import { WEB_URL_CONVERTER } from "../../helpers/web_url_converter.js";
+import { createKitchen } from "../../kitchen/kitchen.js";
+import { createJsenvPluginsController } from "../../plugins/jsenv_plugins_controller.js";
+
+import { parseUserAgentHeader } from "./user_agent.js";
+
+export const devServerPluginServeSourceFiles = ({
+  packageDirectory,
+  sourceDirectoryUrl,
+  sourceMainFilePath,
+  ignore,
+  sourceFilesConfig,
+  clientAutoreload,
+  logLevel,
+
+  runtimeCompat,
+  onKitchenCreated,
+
+  supervisor,
+  sourcemaps,
+  sourcemapsSourcesContent,
+  outDirectoryUrl,
+
+  serverStopAbortSignal,
+  serverStopCallbackSet,
+  devServerJsenvPluginStore,
+  kitchenCache,
+}) => {
+  const { clientFileChangeEventEmitter, clientFileDereferencedEventEmitter } =
+    clientAutoreload;
+
+  const stopWatchingSourceFiles = watchSourceFiles(
+    sourceDirectoryUrl,
+    (fileInfo) => {
+      clientFileChangeEventEmitter.emit(fileInfo);
+    },
+    {
+      sourceFilesConfig,
+      keepProcessAlive: false,
+      cooldownBetweenFileEvents: clientAutoreload.cooldownBetweenFileEvents,
+    },
+  );
+  serverStopCallbackSet.add(stopWatchingSourceFiles);
+
+  const getOrCreateKitchen = async (request) => {
+    const { runtimeName, runtimeVersion } = parseUserAgentHeader(
+      request.headers["user-agent"] || "",
+    );
+    const runtimeId = `${runtimeName}@${runtimeVersion}`;
+    const existing = kitchenCache.get(runtimeId);
+    if (existing) {
+      return existing;
+    }
+    const watchAssociations = URL_META.resolveAssociations(
+      { watch: stopWatchingSourceFiles.watchPatterns },
+      sourceDirectoryUrl,
+    );
+    let kitchen;
+    clientFileChangeEventEmitter.on(({ url, event }) => {
+      const urlInfo = kitchen.graph.getUrlInfo(url);
+      if (urlInfo) {
+        if (event === "removed") {
+          urlInfo.onRemoved();
+        } else {
+          urlInfo.onModified();
+        }
+      }
+    });
+    const clientRuntimeCompat = { [runtimeName]: runtimeVersion };
+
+    kitchen = createKitchen({
+      name: runtimeId,
+      signal: serverStopAbortSignal,
+      logLevel,
+      rootDirectoryUrl: sourceDirectoryUrl,
+      mainFilePath: sourceMainFilePath,
+      ignore,
+      dev: true,
+      runtimeCompat,
+      clientRuntimeCompat,
+      supervisor,
+      sourcemaps,
+      sourcemapsSourcesContent,
+      outDirectoryUrl: outDirectoryUrl
+        ? new URL(`${runtimeName}@${runtimeVersion}/`, outDirectoryUrl)
+        : undefined,
+      packageDirectory,
+    });
+    kitchen.graph.urlInfoCreatedEventEmitter.on((urlInfoCreated) => {
+      const { watch } = URL_META.applyAssociations({
+        url: urlInfoCreated.url,
+        associations: watchAssociations,
+      });
+      urlInfoCreated.isWatched = watch;
+      // when an url depends on many others, we check all these (like package.json)
+      urlInfoCreated.isValid = () => {
+        const seenSet = new Set();
+        const checkValidity = (urlInfo) => {
+          if (seenSet.has(urlInfo)) {
+            return true;
+          }
+          seenSet.add(urlInfo);
+          if (!urlInfo.url.startsWith("file:")) {
+            return false;
+          }
+          if (urlInfo.content === undefined) {
+            // urlInfo content is undefined when:
+            // - url info content never fetched
+            // - it is considered as modified because undelying file is watched and got saved
+            // - it is considered as modified because underlying file content
+            //   was compared using etag and it has changed
+            return false;
+          }
+          if (!urlInfo.isWatched) {
+            // file is not watched, check the filesystem
+            let fileContentAsBuffer;
+            try {
+              fileContentAsBuffer = readFileSync(new URL(urlInfo.url));
+            } catch (e) {
+              if (e.code === "ENOENT") {
+                urlInfo.onModified();
+                return false;
+              }
+              return false;
+            }
+            const fileContentEtag = bufferToEtag(fileContentAsBuffer);
+            if (fileContentEtag !== urlInfo.originalContentEtag) {
+              urlInfo.onModified();
+              // restore content to be able to compare it again later
+              urlInfo.kitchen.urlInfoTransformer.setContent(
+                urlInfo,
+                String(fileContentAsBuffer),
+                {
+                  contentEtag: fileContentEtag,
+                },
+              );
+              return false;
+            }
+          }
+          for (const implicitUrl of urlInfo.implicitUrlSet) {
+            const implicitUrlInfo = urlInfo.graph.getUrlInfo(implicitUrl);
+            if (!implicitUrlInfo) {
+              continue;
+            }
+            if (implicitUrlInfo.content === undefined) {
+              // happens when we explicitely load an url with a search param
+              // - it creates an implicit url info to the url without params
+              // - we never explicitely request the url without search param so it has no content
+              // in that case the underlying urlInfo cannot be invalidate by the implicit
+              // we use modifiedTimestamp to detect if the url was loaded once
+              // or is just here to be used later
+              if (implicitUrlInfo.modifiedTimestamp) {
+                return false;
+              }
+              continue;
+            }
+            if (!checkValidity(implicitUrlInfo)) {
+              return false;
+            }
+          }
+          return true;
+        };
+        const valid = checkValidity(urlInfoCreated);
+        return valid;
+      };
+    });
+    kitchen.graph.urlInfoDereferencedEventEmitter.on(
+      (urlInfoDereferenced, lastReferenceFromOther) => {
+        clientFileDereferencedEventEmitter.emit(
+          urlInfoDereferenced,
+          lastReferenceFromOther,
+        );
+      },
+    );
+    const devServerJsenvPluginController = await createJsenvPluginsController(
+      devServerJsenvPluginStore,
+      kitchen,
+    );
+    kitchen.setJsenvPluginsController(devServerJsenvPluginController);
+
+    serverStopCallbackSet.add(() => {
+      devServerJsenvPluginController.callHooks("destroy", kitchen.context);
+    });
+    kitchenCache.set(runtimeId, kitchen);
+    onKitchenCreated(kitchen);
+    return kitchen;
+  };
+
+  const devServerPluginRoutes = {
+    name: "jsenv:dev_server_routes",
+    augmentRouteFetchSecondArg: async (request) => {
+      const kitchen = await getOrCreateKitchen(request);
+      return { kitchen };
+    },
+    routes: [
+      ...devServerJsenvPluginStore.allServerRoutes,
+      {
+        endpoint: "GET *",
+        description: "Serve project files.",
+        declarationSource: import.meta.url,
+        fetch: async (request, { kitchen }) => {
+          const { rootDirectoryUrl, mainFilePath } = kitchen.context;
+          let requestResource = request.resource;
+          let requestedUrl;
+          if (requestResource.startsWith("/@fs/")) {
+            const fsRootRelativeUrl = requestResource.slice("/@fs/".length);
+            requestedUrl = `file:///${fsRootRelativeUrl}`;
+          } else {
+            const requestedUrlObject = new URL(
+              requestResource === "/" ? mainFilePath : requestResource.slice(1),
+              rootDirectoryUrl,
+            );
+            requestedUrlObject.searchParams.delete("hot");
+            requestedUrl = requestedUrlObject.href;
+          }
+          const { referer } = request.headers;
+          const parentUrl = referer
+            ? WEB_URL_CONVERTER.asFileUrl(referer, {
+                origin: request.origin,
+                rootDirectoryUrl: sourceDirectoryUrl,
+              })
+            : sourceDirectoryUrl;
+          let reference = kitchen.graph.inferReference(
+            request.resource,
+            parentUrl,
+          );
+          if (reference) {
+            reference.urlInfo.context.request = request;
+            reference.urlInfo.context.requestedUrl = requestedUrl;
+          } else {
+            const rootUrlInfo = kitchen.graph.rootUrlInfo;
+            rootUrlInfo.context.request = request;
+            rootUrlInfo.context.requestedUrl = requestedUrl;
+            reference = rootUrlInfo.dependencies.createResolveAndFinalize({
+              trace: { message: parentUrl },
+              type: "http_request",
+              specifier: request.resource,
+            });
+            reference.urlInfo.context.requestedUrl = requestedUrl;
+            rootUrlInfo.context.request = null;
+            rootUrlInfo.context.requestedUrl = null;
+          }
+          const urlInfo = reference.urlInfo;
+          const ifNoneMatch = request.headers["if-none-match"];
+          const urlInfoTargetedByCache =
+            urlInfo.findParentIfInline() || urlInfo;
+
+          try {
+            if (!urlInfo.error && ifNoneMatch) {
+              const [clientOriginalContentEtag, clientContentEtag] =
+                ifNoneMatch.split("_");
+              if (
+                urlInfoTargetedByCache.originalContentEtag ===
+                  clientOriginalContentEtag &&
+                urlInfoTargetedByCache.contentEtag === clientContentEtag &&
+                urlInfoTargetedByCache.isValid()
+              ) {
+                const headers = {
+                  "cache-control": `private,max-age=0,must-revalidate`,
+                };
+                Object.keys(urlInfo.headers).forEach((key) => {
+                  if (key !== "content-length") {
+                    headers[key] = urlInfo.headers[key];
+                  }
+                });
+                return {
+                  status: 304,
+                  headers,
+                };
+              }
+            }
+            await urlInfo.cook({ request, reference });
+            let { response } = urlInfo;
+            if (response) {
+              return response;
+            }
+            response = {
+              url: reference.url,
+              status: 200,
+              headers: {
+                // when we send eTag to the client the next request to the server
+                // will send etag in request headers.
+                // If they match jsenv bypass cooking and returns 304
+                // This must not happen when a plugin uses "no-store" or "no-cache" as it means
+                // plugin logic wants to happens for every request to this url
+                ...(cacheIsDisabledInResponseHeader(urlInfoTargetedByCache)
+                  ? {
+                      "cache-control": "no-store", // for inline file we force no-store when parent is no-store
+                    }
+                  : {
+                      "cache-control": `private,max-age=0,must-revalidate`,
+                      // it's safe to use "_" separator because etag is encoded with base64 (see https://stackoverflow.com/a/13195197)
+                      "eTag": `${urlInfoTargetedByCache.originalContentEtag}_${urlInfoTargetedByCache.contentEtag}`,
+                    }),
+                ...urlInfo.headers,
+                "content-type": urlInfo.contentType,
+                "content-length": urlInfo.contentLength,
+              },
+              body: urlInfo.content,
+              timing: urlInfo.timing, // TODO: use something else
+            };
+            const augmentResponseInfo = {
+              ...kitchen.context,
+              reference,
+              urlInfo,
+            };
+            kitchen.jsenvPluginsController.callHooks(
+              "augmentResponse",
+              augmentResponseInfo,
+              (returnValue) => {
+                response = composeTwoResponses(response, returnValue);
+              },
+            );
+            return response;
+          } catch (error) {
+            const originalError = error ? error.cause || error : error;
+            if (originalError.asResponse) {
+              return originalError.asResponse();
+            }
+            const code = originalError.code;
+            if (code === "PARSE_ERROR") {
+              // when possible let browser re-throw the syntax error
+              // it's not possible to do that when url info content is not available
+              // (happens for js_module_fallback for instance)
+              if (urlInfo.content !== undefined) {
+                kitchen.context.logger
+                  .error(`Error while handling ${request.url}:
+  ${originalError.reasonCode || originalError.code}
+  ${error.trace?.message}`);
+                return {
+                  url: reference.url,
+                  status: 200,
+                  // reason becomes the http response statusText, it must not contain invalid chars
+                  // https://github.com/nodejs/node/blob/0c27ca4bc9782d658afeaebcec85ec7b28f1cc35/lib/_http_common.js#L221
+                  statusText: error.reason,
+                  statusMessage: originalError.message,
+                  headers: {
+                    "content-type": urlInfo.contentType,
+                    "content-length": urlInfo.contentLength,
+                    "cache-control": "no-store",
+                  },
+                  body: urlInfo.content,
+                };
+              }
+              return {
+                url: reference.url,
+                status: 500,
+                statusText: error.reason,
+                statusMessage: originalError.message,
+                headers: {
+                  "cache-control": "no-store",
+                },
+                body: urlInfo.content,
+              };
+            }
+            if (code === "DIRECTORY_REFERENCE_NOT_ALLOWED") {
+              return fetchDirectory(reference.url, {
+                headers: {
+                  accept: "text/html",
+                },
+                canReadDirectory: true,
+                rootDirectoryUrl: sourceDirectoryUrl,
+              });
+            }
+            if (code === "NOT_ALLOWED") {
+              return {
+                url: reference.url,
+                status: 403,
+                statusText: originalError.reason,
+              };
+            }
+            if (code === "NOT_FOUND") {
+              return {
+                url: reference.url,
+                status: 404,
+                statusText: originalError.reason,
+                statusMessage: originalError.message,
+              };
+            }
+            return {
+              url: reference.url,
+              status: 500,
+              statusText: error.reason,
+              statusMessage: formatError(error),
+              headers: {
+                "cache-control": "no-store",
+              },
+            };
+          }
+        },
+      },
+    ],
+  };
+
+  return [devServerPluginRoutes, ...devServerJsenvPluginStore.allServerPlugins];
+};
+
+const cacheIsDisabledInResponseHeader = (urlInfo) => {
+  return (
+    urlInfo.headers["cache-control"] === "no-store" ||
+    urlInfo.headers["cache-control"] === "no-cache"
+  );
+};