@jsenv/core 39.14.3 → 40.0.0

package/src/plugins/plugin_controller.js

@@ -1,46 +1,13 @@
 import { performance } from "node:perf_hooks";
+import { jsenvPluginHtmlSyntaxErrorFallback } from "./html_syntax_error_fallback/jsenv_plugin_html_syntax_error_fallback.js";
 
-const HOOK_NAMES = [
-  "init",
-  "serve", // is called only during dev/tests
-  "serveWebsocket",
-  "resolveReference",
-  "redirectReference",
-  "transformReferenceSearchParams",
-  "formatReference",
-  "fetchUrlContent",
-  "transformUrlContent",
-  "finalizeUrlContent",
-  "bundle", // is called only during build
-  "optimizeUrlContent", // is called only during build
-  "cooked",
-  "augmentResponse", // is called only during dev/tests
-  "destroy",
-  "effect",
-];
-
-export const createPluginController = (
-  kitchenContext,
-  initialPuginsMeta = {},
-) => {
-  const pluginsMeta = initialPuginsMeta;
-
-  kitchenContext.getPluginMeta = (id) => {
-    const value = pluginsMeta[id];
-    return value;
-  };
-
-  const pluginCandidates = [];
-  const activeEffectSet = new Set();
-  const activePlugins = [];
-  // precompute a list of hooks per hookName because:
-  // 1. [MAJOR REASON] when debugging, there is less iteration (so much better)
-  // 2. [MINOR REASON] it should increase perf as there is less work to do
-  const hookSetMap = new Map();
-  const addPlugin = (plugin, options) => {
+export const createPluginStore = (plugins) => {
+  const allDevServerRoutes = [];
+  const pluginArray = [];
+  const addPlugin = (plugin) => {
     if (Array.isArray(plugin)) {
-      for (const value of plugin) {
-        addPlugin(value, options);
+      for (const subplugin of plugin) {
+        addPlugin(subplugin);
       }
       return;
     }
@@ -50,175 +17,140 @@ export const createPluginController = (
     if (!plugin.name) {
       plugin.name = "anonymous";
     }
-    if (!testAppliesDuring(plugin) || !initPlugin(plugin)) {
-      plugin.destroy?.();
-      return;
-    }
-    pluginCandidates.push(plugin);
-  };
-  const testAppliesDuring = (plugin) => {
-    const { appliesDuring } = plugin;
-    if (appliesDuring === undefined) {
-      // console.debug(`"appliesDuring" is undefined on ${pluginEntry.name}`)
-      return true;
-    }
-    if (appliesDuring === "*") {
-      return true;
-    }
-    if (typeof appliesDuring === "string") {
-      if (appliesDuring !== "dev" && appliesDuring !== "build") {
-        throw new TypeError(
-          `"appliesDuring" must be "dev" or "build", got ${appliesDuring}`,
-        );
+    if (plugin.devServerRoutes) {
+      const devServerRoutes = plugin.devServerRoutes;
+      for (const devServerRoute of devServerRoutes) {
+        allDevServerRoutes.push(devServerRoute);
       }
-      if (kitchenContext[appliesDuring]) {
-        return true;
-      }
-      return false;
     }
-    if (typeof appliesDuring === "object") {
-      for (const key of Object.keys(appliesDuring)) {
-        if (!appliesDuring[key] && kitchenContext[key]) {
-          return false;
-        }
-        if (appliesDuring[key] && kitchenContext[key]) {
-          return true;
-        }
-      }
-      // throw new Error(`"appliesDuring" is empty`)
-      return false;
-    }
-    throw new TypeError(
-      `"appliesDuring" must be an object or a string, got ${appliesDuring}`,
-    );
+    pluginArray.push(plugin);
   };
-  const initPlugin = (plugin) => {
-    const { init } = plugin;
-    if (!init) {
-      return true;
-    }
-    const initReturnValue = init(kitchenContext, { plugin });
-    if (initReturnValue === false) {
-      return false;
+  addPlugin(jsenvPluginHtmlSyntaxErrorFallback());
+  for (const plugin of plugins) {
+    addPlugin(plugin);
+  }
+
+  return {
+    pluginArray,
+
+    allDevServerRoutes,
+  };
+};
+
+export const createPluginController = (
+  pluginStore,
+  kitchen,
+  { initialPuginsMeta = {} } = {},
+) => {
+  const pluginsMeta = initialPuginsMeta;
+  kitchen.context.getPluginMeta = (id) => {
+    const value = pluginsMeta[id];
+    return value;
+  };
+
+  // precompute a list of hooks per hookName because:
+  // 1. [MAJOR REASON] when debugging, there is less iteration (so much better)
+  // 2. [MINOR REASON] it should increase perf as there is less work to do
+  const hookSetMap = new Map();
+  const pluginCandidates = pluginStore.pluginArray;
+  const activePluginArray = [];
+  const pluginWithEffectCandidateForActivationArray = [];
+  for (const pluginCandidate of pluginCandidates) {
+    if (!testAppliesDuring(pluginCandidate, kitchen)) {
+      pluginCandidate.destroy?.();
+      continue;
     }
-    if (typeof initReturnValue === "function" && !plugin.destroy) {
-      plugin.destroy = initReturnValue;
+    const initPluginResult = initPlugin(pluginCandidate, kitchen);
+    if (!initPluginResult) {
+      pluginCandidate.destroy?.();
+      continue;
     }
-    return true;
-  };
-  const pushPlugin = (...args) => {
-    for (const arg of args) {
-      addPlugin(arg);
+    if (pluginCandidate.effect) {
+      pluginWithEffectCandidateForActivationArray.push(pluginCandidate);
+    } else {
+      activePluginArray.push(pluginCandidate);
     }
-    updateActivePlugins();
-  };
-  const updateActivePlugins = () => {
-    // construct activePlugins and hooks according
-    // to the one present in candidates and their effects
-    // 1. active plugins is an empty array
-    // 2. all active effects are cleaned-up
-    // 3. all effects are re-activated if still relevant
-    // 4. hooks are precomputed according to plugin order
+  }
 
-    // 1.
-    activePlugins.length = 0;
-    // 2.
-    for (const { cleanup } of activeEffectSet) {
-      cleanup();
+  const activeEffectSet = new Set();
+  for (const pluginWithEffectCandidateForActivation of pluginWithEffectCandidateForActivationArray) {
+    const returnValue = pluginWithEffectCandidateForActivation.effect({
+      kitchenContext: kitchen.context,
+      otherPlugins: activePluginArray,
+    });
+    if (!returnValue) {
+      continue;
     }
-    activeEffectSet.clear();
-    for (const pluginCandidate of pluginCandidates) {
-      const effect = pluginCandidate.effect;
-      if (!effect) {
-        activePlugins.push(pluginCandidate);
+    activePluginArray.push(pluginWithEffectCandidateForActivation);
+    activeEffectSet.add({
+      plugin: pluginWithEffectCandidateForActivation,
+      cleanup: typeof returnValue === "function" ? returnValue : () => {},
+    });
+  }
+  activePluginArray.sort((a, b) => {
+    return pluginCandidates.indexOf(a) - pluginCandidates.indexOf(b);
+  });
+  for (const activePlugin of activePluginArray) {
+    for (const key of Object.keys(activePlugin)) {
+      if (key === "meta") {
+        const value = activePlugin[key];
+        if (typeof value !== "object" || value === null) {
+          console.warn(`plugin.meta must be an object, got ${value}`);
+          continue;
+        }
+        Object.assign(pluginsMeta, value);
+        // any extension/modification on plugin.meta
+        // won't be taken into account so we freeze object
+        // to throw in case it happen
+        Object.freeze(value);
         continue;
       }
-    }
-    // 3.
-    for (const pluginCandidate of pluginCandidates) {
-      const effect = pluginCandidate.effect;
-      if (!effect) {
+      if (
+        key === "name" ||
+        key === "appliesDuring" ||
+        key === "init" ||
+        key === "serverEvents" ||
+        key === "mustStayFirst" ||
+        key === "devServerRoutes" ||
+        key === "effect"
+      ) {
         continue;
       }
-      const returnValue = effect({
-        kitchenContext,
-        otherPlugins: activePlugins,
-      });
-      if (!returnValue) {
+      const isHook = HOOK_NAMES.includes(key);
+      if (!isHook) {
+        console.warn(
+          `Unexpected "${key}" property on "${activePlugin.name}" plugin`,
+        );
         continue;
       }
-      activePlugins.push(pluginCandidate);
-      activeEffectSet.add({
-        plugin: pluginCandidate,
-        cleanup: typeof returnValue === "function" ? returnValue : () => {},
-      });
-    }
-    // 4.
-    activePlugins.sort((a, b) => {
-      return pluginCandidates.indexOf(a) - pluginCandidates.indexOf(b);
-    });
-    hookSetMap.clear();
-    for (const activePlugin of activePlugins) {
-      for (const key of Object.keys(activePlugin)) {
-        if (key === "meta") {
-          const value = activePlugin[key];
-          if (typeof value !== "object" || value === null) {
-            console.warn(`plugin.meta must be an object, got ${value}`);
-            continue;
-          }
-          Object.assign(pluginsMeta, value);
-          // any extension/modification on plugin.meta
-          // won't be taken into account so we freeze object
-          // to throw in case it happen
-          Object.freeze(value);
-          continue;
-        }
-        if (
-          key === "name" ||
-          key === "appliesDuring" ||
-          key === "init" ||
-          key === "serverEvents" ||
-          key === "mustStayFirst" ||
-          key === "effect"
-        ) {
-          continue;
-        }
-        const isHook = HOOK_NAMES.includes(key);
-        if (!isHook) {
-          console.warn(
-            `Unexpected "${key}" property on "${activePlugin.name}" plugin`,
-          );
-          continue;
-        }
-        const hookName = key;
-        const hookValue = activePlugin[hookName];
-        if (hookValue) {
-          let hookSet = hookSetMap.get(hookName);
-          if (!hookSet) {
-            hookSet = new Set();
-            hookSetMap.set(hookName, hookSet);
-          }
-          const hook = {
-            plugin: activePlugin,
-            name: hookName,
-            value: hookValue,
-          };
-          // if (position === "start") {
-          //   let i = 0;
-          //   while (i < group.length) {
-          //     const before = group[i];
-          //     if (!before.plugin.mustStayFirst) {
-          //       break;
-          //     }
-          //     i++;
-          //   }
-          //   group.splice(i, 0, hook);
-          // } else {
-          hookSet.add(hook);
+      const hookName = key;
+      const hookValue = activePlugin[hookName];
+      if (hookValue) {
+        let hookSet = hookSetMap.get(hookName);
+        if (!hookSet) {
+          hookSet = new Set();
+          hookSetMap.set(hookName, hookSet);
         }
+        const hook = {
+          plugin: activePlugin,
+          name: hookName,
+          value: hookValue,
+        };
+        // if (position === "start") {
+        //   let i = 0;
+        //   while (i < group.length) {
+        //     const before = group[i];
+        //     if (!before.plugin.mustStayFirst) {
+        //       break;
+        //     }
+        //     i++;
+        //   }
+        //   group.splice(i, 0, hook);
+        // } else {
+        hookSet.add(hook);
       }
     }
-  };
+  }
 
   let lastPluginUsed = null;
   let currentPlugin = null;
@@ -268,7 +200,6 @@ export const createPluginController = (
     currentHookName = null;
     return valueReturned;
   };
-
   const callHooks = (hookName, info, callback) => {
     const hookSet = hookSetMap.get(hookName);
     if (!hookSet) {
@@ -296,7 +227,6 @@ export const createPluginController = (
       }
     }
   };
-
   const callHooksUntil = (hookName, info) => {
     const hookSet = hookSetMap.get(hookName);
     if (!hookSet) {
@@ -337,13 +267,10 @@ export const createPluginController = (
   };
 
   return {
-    pluginsMeta,
-    activePlugins,
-    pushPlugin,
-    getHookFunction,
+    activePlugins: activePluginArray,
+
     callHook,
     callAsyncHook,
-
     callHooks,
     callHooksUntil,
     callAsyncHooks,
@@ -355,6 +282,74 @@ export const createPluginController = (
   };
 };
 
+const HOOK_NAMES = [
+  "init",
+  "devServerRoutes", // is called only during dev/tests
+  "resolveReference",
+  "redirectReference",
+  "transformReferenceSearchParams",
+  "formatReference",
+  "fetchUrlContent",
+  "transformUrlContent",
+  "finalizeUrlContent",
+  "bundle", // is called only during build
+  "optimizeUrlContent", // is called only during build
+  "cooked",
+  "augmentResponse", // is called only during dev/tests
+  "destroy",
+  "effect",
+];
+
+const testAppliesDuring = (plugin, kitchen) => {
+  const { appliesDuring } = plugin;
+  if (appliesDuring === undefined) {
+    // console.debug(`"appliesDuring" is undefined on ${pluginEntry.name}`)
+    return true;
+  }
+  if (appliesDuring === "*") {
+    return true;
+  }
+  if (typeof appliesDuring === "string") {
+    if (appliesDuring !== "dev" && appliesDuring !== "build") {
+      throw new TypeError(
+        `"appliesDuring" must be "dev" or "build", got ${appliesDuring}`,
+      );
+    }
+    if (kitchen.context[appliesDuring]) {
+      return true;
+    }
+    return false;
+  }
+  if (typeof appliesDuring === "object") {
+    for (const key of Object.keys(appliesDuring)) {
+      if (!appliesDuring[key] && kitchen.context[key]) {
+        return false;
+      }
+      if (appliesDuring[key] && kitchen.context[key]) {
+        return true;
+      }
+    }
+    // throw new Error(`"appliesDuring" is empty`)
+    return false;
+  }
+  throw new TypeError(
+    `"appliesDuring" must be an object or a string, got ${appliesDuring}`,
+  );
+};
+const initPlugin = (plugin, kitchen) => {
+  const { init } = plugin;
+  if (!init) {
+    return true;
+  }
+  const initReturnValue = init(kitchen.context, { plugin });
+  if (initReturnValue === false) {
+    return false;
+  }
+  if (typeof initReturnValue === "function" && !plugin.destroy) {
+    plugin.destroy = initReturnValue;
+  }
+  return true;
+};
 const getHookFunction = (
   hook,
   // can be undefined, reference, or urlInfo
@@ -391,7 +386,6 @@ const assertAndNormalizeReturnValue = (hook, returnValue, info) => {
   }
   return returnValue;
 };
-
 const returnValueAssertions = [
   {
     name: "url_assertion",

package/src/plugins/plugins.js

@@ -26,7 +26,9 @@ import { jsenvPluginCleanHTML } from "./clean_html/jsenv_plugin_clean_html.js";
 
 export const getCorePlugins = ({
   rootDirectoryUrl,
+  mainFilePath,
   runtimeCompat,
+  sourceFilesConfig,
 
   referenceAnalysis = {},
   nodeEsmResolution = {},
@@ -82,6 +84,9 @@ export const getCorePlugins = ({
       magicExtensions,
       magicDirectoryIndex,
       directoryListing,
+      rootDirectoryUrl,
+      mainFilePath,
+      sourceFilesConfig,
     }),
     {
       name: "jsenv:resolve_root_as_main",

package/src/plugins/protocol_file/client/directory_listing.jsx

@@ -68,6 +68,11 @@ const ErrorMessage = () => {
         </code>
         .
       </span>
+      <br />
+      <span className="error_text" style="font-size: 70%;">
+        See also available routes in the{" "}
+        <a href="/.internal/route_inspector">route inspector</a>.
+      </span>
     </p>
   );
 };