@jsenv/core 41.0.2 → 41.0.4

package/src/dev/start_dev_server.js

@@ -1,35 +1,27 @@
 import {
   assertAndNormalizeDirectoryUrl,
-  bufferToEtag,
   lookupPackageDirectory,
 } from "@jsenv/filesystem";
-import { createLogger, createTaskLog, formatError } from "@jsenv/humanize";
+import { createLogger, createTaskLog } from "@jsenv/humanize";
 import {
-  composeTwoResponses,
   jsenvAccessControlAllowedHeaders,
-  serveDirectory,
   serverPluginCORS,
-  serverPluginErrorHandler,
   startServer,
 } from "@jsenv/server";
-import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/plugins/filesystem/filesystem_error_to_response.js";
-import { URL_META } from "@jsenv/url-meta";
 import { urlIsOrIsInsideOf, urlToRelativeUrl } from "@jsenv/urls";
-import { existsSync, readFileSync } from "node:fs";
+import { existsSync } from "node:fs";
+
 import { defaultRuntimeCompat } from "../build/build_params.js";
 import { createEventEmitter } from "../helpers/event_emitter.js";
-import { watchSourceFiles } from "../helpers/watch_source_files.js";
-import { WEB_URL_CONVERTER } from "../helpers/web_url_converter.js";
 import { jsenvCoreDirectoryUrl } from "../jsenv_core_directory_url.js";
-import { createKitchen } from "../kitchen/kitchen.js";
 import { createPackageDirectory } from "../kitchen/package_directory.js";
-import {
-  createJsenvPluginsController,
-  createJsenvPluginStore,
-} from "../plugins/jsenv_plugins_controller.js";
+import { createJsenvPluginStore } from "../plugins/jsenv_plugins_controller.js";
 import { getCorePlugins } from "../plugins/plugins.js";
 import { jsenvPluginServerEvents } from "../plugins/server_events/jsenv_plugin_server_events.js";
-import { parseUserAgentHeader } from "./user_agent.js";
+import { devServerPluginChromeDevToolsJson } from "./dev_server_plugins/dev_server_plugin_chrome_devtools_json.js";
+import { devServerPluginInjectServerResponseHeader } from "./dev_server_plugins/dev_server_plugin_inject_server_response_header.js";
+import { devServerPluginOmegaErrorHandler } from "./dev_server_plugins/dev_server_plugin_omega_error_handler.js";
+import { devServerPluginServeSourceFiles } from "./dev_server_plugins/dev_server_plugin_serve_source_files.js";
 
 const EXECUTED_BY_TEST_PLAN = process.argv.includes("--jsenv-test");
 
@@ -152,7 +144,6 @@ export const startDevServer = async ({
       );
     }
   }
-
   // params normalization
   {
     if (clientAutoreload === true) {
@@ -174,511 +165,94 @@ export const startDevServer = async ({
     serverStopAbortController.abort();
   });
   const serverStopAbortSignal = serverStopAbortController.signal;
-  const kitchenCache = new Map();
 
-  const finalServerPlugins = [];
-  // x-server-inspect service
-  {
-    finalServerPlugins.push({
-      name: "jsenv:server_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",
-          },
-        };
-      },
-    });
-  }
-  // cors service
-  {
-    finalServerPlugins.push(
-      serverPluginCORS({
-        accessControlAllowRequestOrigin: true,
-        accessControlAllowRequestMethod: true,
-        accessControlAllowRequestHeaders: true,
-        accessControlAllowedRequestHeaders: [
-          ...jsenvAccessControlAllowedHeaders,
-          "x-jsenv-execution-id",
-        ],
-        accessControlAllowCredentials: true,
-        timingAllowOrigin: true,
-      }),
-    );
-  }
-  // custom server plugins
-  {
-    finalServerPlugins.push(...serverPlugins);
-  }
-  // file_service
-  {
-    const clientFileChangeEventEmitter = createEventEmitter();
-    const clientFileDereferencedEventEmitter = createEventEmitter();
-    clientAutoreload = {
-      enabled: true,
-      clientServerEventsConfig: {},
-      clientFileChangeEventEmitter,
-      clientFileDereferencedEventEmitter,
-      ...clientAutoreload,
-    };
-    const stopWatchingSourceFiles = watchSourceFiles(
-      sourceDirectoryUrl,
-      (fileInfo) => {
-        clientFileChangeEventEmitter.emit(fileInfo);
-      },
-      {
-        sourceFilesConfig,
-        keepProcessAlive: false,
-        cooldownBetweenFileEvents: clientAutoreload.cooldownBetweenFileEvents,
-      },
-    );
-    serverStopCallbackSet.add(stopWatchingSourceFiles);
+  const kitchenCache = new Map();
+  const packageDirectory = createPackageDirectory({ sourceDirectoryUrl });
+  const clientFileChangeEventEmitter = createEventEmitter();
+  const clientFileDereferencedEventEmitter = createEventEmitter();
+  clientAutoreload = {
+    enabled: true,
+    clientServerEventsConfig: {},
+    clientFileChangeEventEmitter,
+    clientFileDereferencedEventEmitter,
+    ...clientAutoreload,
+  };
 
-    const packageDirectory = createPackageDirectory({
-      sourceDirectoryUrl,
-    });
+  const devServerJsenvPluginStore = await createJsenvPluginStore([
+    jsenvPluginServerEvents({ clientAutoreload }),
+    ...plugins,
+    ...getCorePlugins({
+      packageDirectory,
+      rootDirectoryUrl: sourceDirectoryUrl,
+      mainFilePath: sourceMainFilePath,
+      runtimeCompat,
+      sourceFilesConfig,
 
-    const devServerJsenvPluginStore = await createJsenvPluginStore([
-      jsenvPluginServerEvents({ clientAutoreload }),
-      ...plugins,
-      ...getCorePlugins({
-        packageDirectory,
-        rootDirectoryUrl: sourceDirectoryUrl,
-        mainFilePath: sourceMainFilePath,
-        runtimeCompat,
-        sourceFilesConfig,
+      referenceAnalysis,
+      nodeEsmResolution,
+      packageConditions,
+      packageConditionsConfig,
+      magicExtensions,
+      magicDirectoryIndex,
+      directoryListing,
+      supervisor,
+      injections,
+      transpilation,
+      spa,
+      packageBundle,
 
-        referenceAnalysis,
-        nodeEsmResolution,
-        packageConditions,
-        packageConditionsConfig,
-        magicExtensions,
-        magicDirectoryIndex,
-        directoryListing,
-        supervisor,
-        injections,
-        transpilation,
-        spa,
-        packageBundle,
+      clientAutoreload,
+      clientAutoreloadOnServerRestart,
+      cacheControl,
+      ribbon,
+      dropToOpen,
+    }),
+  ]);
 
-        clientAutoreload,
-        clientAutoreloadOnServerRestart,
-        cacheControl,
-        ribbon,
-        dropToOpen,
-      }),
-    ]);
-    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);
+  const finalServerPlugins = [];
+  finalServerPlugins.push(
+    // "header" service
+    devServerPluginInjectServerResponseHeader({ sourceDirectoryUrl }),
+    // cors service
+    serverPluginCORS({
+      accessControlAllowRequestOrigin: true,
+      accessControlAllowRequestMethod: true,
+      accessControlAllowRequestHeaders: true,
+      accessControlAllowedRequestHeaders: [
+        ...jsenvAccessControlAllowedHeaders,
+        "x-jsenv-execution-id",
+      ],
+      accessControlAllowCredentials: true,
+      timingAllowOrigin: true,
+    }),
+    // chrome devtools
+    devServerPluginChromeDevToolsJson({ sourceDirectoryUrl }),
+    ...serverPlugins,
+    devServerPluginServeSourceFiles({
+      packageDirectory,
+      sourceDirectoryUrl,
+      sourceMainFilePath,
+      ignore,
+      sourceFilesConfig,
+      clientAutoreload,
 
-      serverStopCallbackSet.add(() => {
-        devServerJsenvPluginController.callHooks("destroy", kitchen.context);
-      });
-      kitchenCache.set(runtimeId, kitchen);
-      onKitchenCreated(kitchen);
-      return kitchen;
-    };
+      logLevel,
+      runtimeCompat,
+      onKitchenCreated,
 
-    finalServerPlugins.push({
-      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;
+      supervisor,
+      sourcemaps,
+      sourcemapsSourcesContent,
+      outDirectoryUrl,
 
-            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 serveDirectory(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",
-                },
-              };
-            }
-          },
-        },
-      ],
-    });
-    finalServerPlugins.push(...devServerJsenvPluginStore.allServerPlugins);
-  }
-  // jsenv error handler service
-  {
-    finalServerPlugins.push({
-      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,
-        };
-      },
-    });
-  }
-  // default error handler
-  {
-    finalServerPlugins.push(
-      serverPluginErrorHandler({
-        sendErrorDetails: true,
-      }),
-    );
-  }
+      serverStopAbortSignal,
+      serverStopCallbackSet,
+      devServerJsenvPluginStore,
+      kitchenCache,
+    }),
+    // jsenv error handler service
+    devServerPluginOmegaErrorHandler(),
+  );
 
   const server = await startServer({
     signal,
@@ -724,10 +298,3 @@ export const startDevServer = async ({
     kitchenCache,
   };
 };
-
-const cacheIsDisabledInResponseHeader = (urlInfo) => {
-  return (
-    urlInfo.headers["cache-control"] === "no-store" ||
-    urlInfo.headers["cache-control"] === "no-cache"
-  );
-};

package/src/plugins/plugins.js

@@ -25,7 +25,6 @@ import { jsenvPluginCacheControl } from "./cache_control/jsenv_plugin_cache_cont
 import { jsenvPluginRibbon } from "./ribbon/jsenv_plugin_ribbon.js";
 import { jsenvPluginDropToOpen } from "./drop_to_open/jsenv_plugin_drop_to_open.js";
 import { jsenvPluginCleanHTML } from "./clean_html/jsenv_plugin_clean_html.js";
-import { jsenvPluginChromeDevtoolsJson } from "./chrome_devtools_json/jsenv_plugin_chrome_devtools_json.js";
 import { jsenvPluginAutoreloadOnServerRestart } from "./autoreload_on_server_restart/jsenv_plugin_autoreload_on_server_restart.js";
 import { jsenvPluginPackageSideEffects } from "./package_side_effects/jsenv_plugin_package_side_effects.js";
 import { jsenvPluginWorkspaceBundle } from "./workspace_bundle/jsenv_plugin_workspace_bundle.js";
@@ -156,7 +155,6 @@ export const getCorePlugins = ({
     ...(ribbon ? [jsenvPluginRibbon({ rootDirectoryUrl, ...ribbon })] : []),
     ...(dropToOpen ? [jsenvPluginDropToOpen()] : []),
     jsenvPluginCleanHTML(),
-    jsenvPluginChromeDevtoolsJson(),
     ...(packageSideEffects
       ? [jsenvPluginPackageSideEffects({ packageDirectory })]
       : []),