@jsenv/core 27.4.0 → 27.5.0

package/src/plugins/inline/jsenv_plugin_html_inline_content.js

@@ -20,129 +20,109 @@ export const jsenvPluginHtmlInlineContent = ({ analyzeConvertedScripts }) => {
       html: async (urlInfo, context) => {
         const htmlAst = parseHtmlString(urlInfo.content)
         const actions = []
-        const handleInlineStyle = (node) => {
-          const htmlNodeText = getHtmlNodeText(node)
-          if (!htmlNodeText) {
-            return
-          }
-          actions.push(async () => {
-            const { line, column, lineEnd, columnEnd, isOriginal } =
-              getHtmlNodePosition(node, {
-                preferOriginal: true,
+        visitHtmlNodes(htmlAst, {
+          style: (styleNode) => {
+            const styleNodeText = getHtmlNodeText(styleNode)
+            if (!styleNodeText) {
+              return
+            }
+            actions.push(async () => {
+              const { line, column, lineEnd, columnEnd, isOriginal } =
+                getHtmlNodePosition(styleNode, {
+                  preferOriginal: true,
+                })
+              const inlineStyleUrl = generateInlineContentUrl({
+                url: urlInfo.url,
+                extension: ".css",
+                line,
+                column,
+                lineEnd,
+                columnEnd,
               })
-            const inlineStyleUrl = generateInlineContentUrl({
-              url: urlInfo.url,
-              extension: ".css",
-              line,
-              column,
-              lineEnd,
-              columnEnd,
-            })
-            const [inlineStyleReference, inlineStyleUrlInfo] =
-              context.referenceUtils.foundInline({
-                type: "link_href",
-                expectedType: "css",
-                isOriginalPosition: isOriginal,
-                // we remove 1 to the line because imagine the following html:
-                // <style>body { color: red; }</style>
-                // -> content starts same line as <style>
-                specifierLine: line - 1,
-                specifierColumn: column,
-                specifier: inlineStyleUrl,
-                contentType: "text/css",
-                content: htmlNodeText,
+              const [inlineStyleReference, inlineStyleUrlInfo] =
+                context.referenceUtils.foundInline({
+                  node: styleNode,
+                  type: "link_href",
+                  expectedType: "css",
+                  isOriginalPosition: isOriginal,
+                  // we remove 1 to the line because imagine the following html:
+                  // <style>body { color: red; }</style>
+                  // -> content starts same line as <style>
+                  specifierLine: line - 1,
+                  specifierColumn: column,
+                  specifier: inlineStyleUrl,
+                  contentType: "text/css",
+                  content: styleNodeText,
+                })
+              await context.cook(inlineStyleUrlInfo, {
+                reference: inlineStyleReference,
               })
-            await context.cook(inlineStyleUrlInfo, {
-              reference: inlineStyleReference,
-            })
-            setHtmlNodeText(node, inlineStyleUrlInfo.content)
-            setHtmlNodeAttributes(node, {
-              "generated-by": "jsenv:html_inline_content",
-            })
-          })
-        }
-        const handleInlineScript = (node) => {
-          const htmlNodeText = getHtmlNodeText(node)
-          if (!htmlNodeText) {
-            return
-          }
-          // If the inline script was already handled by an other plugin, ignore it
-          // - we want to preserve inline scripts generated by html supervisor during dev
-          // - we want to avoid cooking twice a script during build
-          const generatedBy = getHtmlNodeAttribute(node, "generated-by")
-          if (
-            generatedBy === "jsenv:as_js_classic_html" &&
-            !analyzeConvertedScripts
-          ) {
-            return
-          }
-          if (generatedBy === "jsenv:html_supervisor") {
-            return
-          }
-          actions.push(async () => {
-            const scriptCategory = analyzeScriptNode(node)
-            const { line, column, lineEnd, columnEnd, isOriginal } =
-              getHtmlNodePosition(node, {
-                preferOriginal: true,
+              setHtmlNodeText(styleNode, inlineStyleUrlInfo.content)
+              setHtmlNodeAttributes(styleNode, {
+                "generated-by": "jsenv:html_inline_content",
               })
-            // from MDN about [type] attribute:
-            // "Any other value: The embedded content is treated as a data block
-            // which won't be processed by the browser. Developers must use a valid MIME type
-            // that is not a JavaScript MIME type to denote data blocks.
-            // The src attribute will be ignored."
-            // https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-type
-            const isJs =
-              scriptCategory === "classic" || scriptCategory === "module"
-            const isImportmap = scriptCategory === "importmap"
-            const contentType = isJs
-              ? "text/javascript"
-              : isImportmap
-              ? "application/importmap+json"
-              : scriptCategory
-
-            let inlineScriptUrl = generateInlineContentUrl({
-              url: urlInfo.url,
-              extension: CONTENT_TYPE.asFileExtension(contentType),
-              line,
-              column,
-              lineEnd,
-              columnEnd,
             })
-            const [inlineScriptReference, inlineScriptUrlInfo] =
-              context.referenceUtils.foundInline({
-                node,
-                type: "script_src",
-                expectedType: {
-                  classic: "js_classic",
-                  module: "js_module",
-                  importmap: "importmap",
-                }[scriptCategory],
-                // we remove 1 to the line because imagine the following html:
-                // <script>console.log('ok')</script>
-                // -> content starts same line as <script>
-                specifierLine: line - 1,
-                specifierColumn: column,
-                isOriginalPosition: isOriginal,
-                specifier: inlineScriptUrl,
-                contentType,
-                content: htmlNodeText,
+          },
+          script: (scriptNode) => {
+            const scriptNodeText = getHtmlNodeText(scriptNode)
+            if (!scriptNodeText) {
+              return
+            }
+            // If the inline script was already handled by an other plugin, ignore it
+            // - we want to preserve inline scripts generated by html supervisor during dev
+            // - we want to avoid cooking twice a script during build
+            const generatedBy = getHtmlNodeAttribute(scriptNode, "generated-by")
+            if (
+              generatedBy === "jsenv:as_js_classic_html" &&
+              !analyzeConvertedScripts
+            ) {
+              return
+            }
+            if (generatedBy === "jsenv:html_supervisor") {
+              return
+            }
+            actions.push(async () => {
+              const { type, contentType, extension } =
+                analyzeScriptNode(scriptNode)
+              const { line, column, lineEnd, columnEnd, isOriginal } =
+                getHtmlNodePosition(scriptNode, {
+                  preferOriginal: true,
+                })
+              let inlineScriptUrl = generateInlineContentUrl({
+                url: urlInfo.url,
+                extension:
+                  extension || CONTENT_TYPE.asFileExtension(contentType),
+                line,
+                column,
+                lineEnd,
+                columnEnd,
+              })
+              const [inlineScriptReference, inlineScriptUrlInfo] =
+                context.referenceUtils.foundInline({
+                  node: scriptNode,
+                  type: "script_src",
+                  expectedType: type,
+                  // we remove 1 to the line because imagine the following html:
+                  // <script>console.log('ok')</script>
+                  // -> content starts same line as <script>
+                  specifierLine: line - 1,
+                  specifierColumn: column,
+                  isOriginalPosition: isOriginal,
+                  specifier: inlineScriptUrl,
+                  contentType,
+                  content: scriptNodeText,
+                })
+              await context.cook(inlineScriptUrlInfo, {
+                reference: inlineScriptReference,
+              })
+              setHtmlNodeText(scriptNode, inlineScriptUrlInfo.content)
+              setHtmlNodeAttributes(scriptNode, {
+                "generated-by": "jsenv:html_inline_content",
+                ...(extension
+                  ? { type: type === "js_module" ? "module" : undefined }
+                  : {}),
               })
-
-            await context.cook(inlineScriptUrlInfo, {
-              reference: inlineScriptReference,
-            })
-            setHtmlNodeText(node, inlineScriptUrlInfo.content)
-            setHtmlNodeAttributes(node, {
-              "generated-by": "jsenv:html_inline_content",
             })
-          })
-        }
-        visitHtmlNodes(htmlAst, {
-          style: (node) => {
-            handleInlineStyle(node)
-          },
-          script: (node) => {
-            handleInlineScript(node)
           },
         })
         if (actions.length === 0) {

package/src/plugins/node_esm_resolution/jsenv_plugin_node_esm_resolution.js

@@ -17,72 +17,78 @@ import {
 } from "@jsenv/node-esm-resolution"
 
 export const jsenvPluginNodeEsmResolution = ({
-  rootDirectoryUrl,
-  urlGraph,
-  runtimeCompat,
   packageConditions,
   filesInvalidatingCache = ["package.json", "package-lock.json"],
 }) => {
-  const nodeRuntimeEnabled = Object.keys(runtimeCompat).includes("node")
-  // https://nodejs.org/api/esm.html#resolver-algorithm-specification
-  packageConditions = packageConditions || [
-    ...readCustomConditionsFromProcessArgs(),
-    nodeRuntimeEnabled ? "node" : "browser",
-    "import",
-  ]
-
-  const packageScopesCache = new Map()
-  const lookupPackageScope = (url) => {
-    const fromCache = packageScopesCache.get(url)
-    if (fromCache) {
-      return fromCache
-    }
-    const packageScope = defaultLookupPackageScope(url)
-    packageScopesCache.set(url, packageScope)
-    return packageScope
-  }
-  const packageJsonsCache = new Map()
-  const readPackageJson = (url) => {
-    const fromCache = packageJsonsCache.get(url)
-    if (fromCache) {
-      return fromCache
-    }
-    const packageJson = defaultReadPackageJson(url)
-    packageJsonsCache.set(url, packageJson)
-    return packageJson
-  }
-
   const unregisters = []
-  const onFileChange = () => {
-    packageScopesCache.clear()
-    packageJsonsCache.clear()
-    urlGraph.urlInfoMap.forEach((urlInfo) => {
-      if (urlInfo.dependsOnPackageJson) {
-        urlGraph.considerModified(urlInfo)
-      }
-    })
-  }
-  filesInvalidatingCache.forEach((file) => {
-    const unregister = registerFileLifecycle(new URL(file, rootDirectoryUrl), {
-      added: () => {
-        onFileChange()
-      },
-      updated: () => {
-        onFileChange()
-      },
-      removed: () => {
-        onFileChange()
-      },
-      keepProcessAlive: false,
-    })
-    unregisters.push(unregister)
-  })
+  let lookupPackageScope // defined in "init"
+  let readPackageJson // defined in "init"
 
   return {
     name: "jsenv:node_esm_resolution",
     appliesDuring: "*",
+    init: ({ rootDirectoryUrl, scenario, runtimeCompat, urlGraph }) => {
+      const nodeRuntimeEnabled = Object.keys(runtimeCompat).includes("node")
+      // https://nodejs.org/api/esm.html#resolver-algorithm-specification
+      packageConditions = packageConditions || [
+        ...readCustomConditionsFromProcessArgs(),
+        nodeRuntimeEnabled ? "node" : "browser",
+        "import",
+      ]
+
+      const packageScopesCache = new Map()
+      lookupPackageScope = (url) => {
+        const fromCache = packageScopesCache.get(url)
+        if (fromCache) {
+          return fromCache
+        }
+        const packageScope = defaultLookupPackageScope(url)
+        packageScopesCache.set(url, packageScope)
+        return packageScope
+      }
+      const packageJsonsCache = new Map()
+      readPackageJson = (url) => {
+        const fromCache = packageJsonsCache.get(url)
+        if (fromCache) {
+          return fromCache
+        }
+        const packageJson = defaultReadPackageJson(url)
+        packageJsonsCache.set(url, packageJson)
+        return packageJson
+      }
+
+      if (scenario === "dev") {
+        const onFileChange = () => {
+          packageScopesCache.clear()
+          packageJsonsCache.clear()
+          urlGraph.urlInfoMap.forEach((urlInfo) => {
+            if (urlInfo.dependsOnPackageJson) {
+              urlGraph.considerModified(urlInfo)
+            }
+          })
+        }
+        filesInvalidatingCache.forEach((file) => {
+          const unregister = registerFileLifecycle(
+            new URL(file, rootDirectoryUrl),
+            {
+              added: () => {
+                onFileChange()
+              },
+              updated: () => {
+                onFileChange()
+              },
+              removed: () => {
+                onFileChange()
+              },
+              keepProcessAlive: false,
+            },
+          )
+          unregisters.push(unregister)
+        })
+      }
+    },
     resolveUrl: {
-      js_import_export: (reference) => {
+      js_import_export: (reference, context) => {
         const { parentUrl, specifier } = reference
         const { type, url } = applyNodeEsmResolution({
           conditions: packageConditions,
@@ -100,7 +106,9 @@ export const jsenvPluginNodeEsmResolution = ({
           type !== "relative_specifier" &&
           type !== "absolute_specifier" &&
           type !== "node_builtin_specifier"
-        const relatedUrlInfos = urlGraph.getRelatedUrlInfos(reference.parentUrl)
+        const relatedUrlInfos = context.urlGraph.getRelatedUrlInfos(
+          reference.parentUrl,
+        )
         relatedUrlInfos.forEach((relatedUrlInfo) => {
           if (relatedUrlInfo.dependsOnPackageJson) {
             // the url may depend due to an other reference

package/src/plugins/plugin_controller.js

@@ -1,44 +1,63 @@
 import { timeStart } from "@jsenv/server"
 
-export const createPluginController = ({
-  plugins,
-  scenario,
-  hooks = [
-    "init",
-    "resolveUrl",
-    "redirectUrl",
-    "fetchUrlContent",
-    "transformUrlContent",
-    "transformUrlSearchParams",
-    "formatUrl",
-    "finalizeUrlContent",
-    "cooked",
-    "destroy",
-  ],
-}) => {
-  plugins = flattenAndFilterPlugins(plugins, { scenario })
-  // precompute a list of hooks per hookName
-  // For one major reason:
+const HOOK_NAMES = [
+  "init",
+  "serve", // is called only during dev/tests
+  "resolveUrl",
+  "redirectUrl",
+  "fetchUrlContent",
+  "transformUrlContent",
+  "transformUrlSearchParams",
+  "formatUrl",
+  "finalizeUrlContent",
+  "bundle", // is called only during build
+  "optimizeUrlContent", // is called only during build
+  "cooked",
+  "augmentResponse", // is called only during dev/tests
+  "destroy",
+]
+
+export const createPluginController = ({ plugins, scenario }) => {
+  const flatPlugins = flattenAndFilterPlugins(plugins, { scenario })
+  // precompute a list of hooks per hookName for one major reason:
   // - When debugging, there is less iteration
-  // And also it should increase perf as there is less work to do
+  // also it should increase perf as there is less work to do
+
   const hookGroups = {}
-  const addHook = (hookName) => {
-    const hooks = []
-    plugins.forEach((plugin) => {
-      const hook = plugin[hookName]
-      if (hook) {
-        hooks.push({
+  const addPlugin = (plugin, { position = "start" }) => {
+    Object.keys(plugin).forEach((key) => {
+      if (key === "name" || key === "appliesDuring" || key === "serverEvents") {
+        return
+      }
+      const isHook = HOOK_NAMES.includes(key)
+      if (!isHook) {
+        console.warn(`Unexpected "${key}" property on "${plugin.name}" plugin`)
+      }
+      const hookName = key
+      const hookValue = plugin[hookName]
+      if (hookValue) {
+        const group = hookGroups[hookName] || (hookGroups[hookName] = [])
+        const hook = {
           plugin,
-          hookName,
-          value: hook,
-        })
+          name: hookName,
+          value: hookValue,
+        }
+        if (position === "start") {
+          group.push(hook)
+        } else {
+          group.unshift(hook)
+        }
       }
     })
-    hookGroups[hookName] = hooks
-    return hooks
   }
-  hooks.forEach((hookName) => {
-    addHook(hookName)
+  const pushPlugin = (plugin) => {
+    addPlugin(plugin, { position: "start" })
+  }
+  const unshiftPlugin = (plugin) => {
+    addPlugin(plugin, { position: "end" })
+  }
+  flatPlugins.forEach((plugin) => {
+    pushPlugin(plugin)
   })
 
   let currentPlugin = null
@@ -49,15 +68,18 @@ export const createPluginController = ({
       return null
     }
     currentPlugin = hook.plugin
-    currentHookName = hook.hookName
-    const timeEnd = timeStart(
-      `${currentHookName}-${currentPlugin.name.replace("jsenv:", "")}`,
-    )
+    currentHookName = hook.name
+    let timeEnd
+    if (info.timing) {
+      timeEnd = timeStart(
+        `${currentHookName}-${currentPlugin.name.replace("jsenv:", "")}`,
+      )
+    }
     let valueReturned = hookFn(info, context)
     if (info.timing) {
       Object.assign(info.timing, timeEnd())
     }
-    valueReturned = assertAndNormalizeReturnValue(hook.hookName, valueReturned)
+    valueReturned = assertAndNormalizeReturnValue(hook.name, valueReturned)
     currentPlugin = null
     currentHookName = null
     return valueReturned
@@ -68,15 +90,18 @@ export const createPluginController = ({
       return null
     }
     currentPlugin = hook.plugin
-    currentHookName = hook.hookName
-    const timeEnd = timeStart(
-      `${currentHookName}-${currentPlugin.name.replace("jsenv:", "")}`,
-    )
+    currentHookName = hook.name
+    let timeEnd
+    if (info.timing) {
+      timeEnd = timeStart(
+        `${currentHookName}-${currentPlugin.name.replace("jsenv:", "")}`,
+      )
+    }
     let valueReturned = await hookFn(info, context)
     if (info.timing) {
       Object.assign(info.timing, timeEnd())
     }
-    valueReturned = assertAndNormalizeReturnValue(hook.hookName, valueReturned)
+    valueReturned = assertAndNormalizeReturnValue(hook.name, valueReturned)
     currentPlugin = null
     currentHookName = null
     return valueReturned
@@ -84,36 +109,45 @@ export const createPluginController = ({
 
   const callHooks = (hookName, info, context, callback) => {
     const hooks = hookGroups[hookName]
-    for (const hook of hooks) {
-      const returnValue = callHook(hook, info, context)
-      if (returnValue) {
-        callback(returnValue)
+    if (hooks) {
+      for (const hook of hooks) {
+        const returnValue = callHook(hook, info, context)
+        if (returnValue && callback) {
+          callback(returnValue)
+        }
       }
     }
   }
   const callAsyncHooks = async (hookName, info, context, callback) => {
     const hooks = hookGroups[hookName]
-    await hooks.reduce(async (previous, hook) => {
-      await previous
-      const returnValue = await callAsyncHook(hook, info, context)
-      if (returnValue && callback) {
-        await callback(returnValue)
-      }
-    }, Promise.resolve())
+    if (hooks) {
+      await hooks.reduce(async (previous, hook) => {
+        await previous
+        const returnValue = await callAsyncHook(hook, info, context)
+        if (returnValue && callback) {
+          await callback(returnValue)
+        }
+      }, Promise.resolve())
+    }
   }
 
   const callHooksUntil = (hookName, info, context) => {
     const hooks = hookGroups[hookName]
-    for (const hook of hooks) {
-      const returnValue = callHook(hook, info, context)
-      if (returnValue) {
-        return returnValue
+    if (hooks) {
+      for (const hook of hooks) {
+        const returnValue = callHook(hook, info, context)
+        if (returnValue) {
+          return returnValue
+        }
       }
     }
     return null
   }
   const callAsyncHooksUntil = (hookName, info, context) => {
     const hooks = hookGroups[hookName]
+    if (!hooks) {
+      return null
+    }
     if (hooks.length === 0) {
       return null
     }
@@ -136,8 +170,9 @@ export const createPluginController = ({
   }
 
   return {
-    plugins,
-    addHook,
+    plugins: flatPlugins,
+    pushPlugin,
+    unshiftPlugin,
     getHookFunction,
     callHook,
     callAsyncHook,
@@ -152,8 +187,8 @@ export const createPluginController = ({
   }
 }
 
-const flattenAndFilterPlugins = (pluginsRaw, { scenario }) => {
-  const plugins = []
+const flattenAndFilterPlugins = (plugins, { scenario }) => {
+  const flatPlugins = []
   const visitPluginEntry = (pluginEntry) => {
     if (Array.isArray(pluginEntry)) {
       pluginEntry.forEach((value) => visitPluginEntry(value))
@@ -169,7 +204,7 @@ const flattenAndFilterPlugins = (pluginsRaw, { scenario }) => {
         return
       }
       if (appliesDuring === "*") {
-        plugins.push(pluginEntry)
+        flatPlugins.push(pluginEntry)
         return
       }
       if (typeof appliesDuring === "string") {
@@ -179,7 +214,7 @@ const flattenAndFilterPlugins = (pluginsRaw, { scenario }) => {
           )
         }
         if (appliesDuring === scenario) {
-          plugins.push(pluginEntry)
+          flatPlugins.push(pluginEntry)
         }
         return
       }
@@ -189,7 +224,7 @@ const flattenAndFilterPlugins = (pluginsRaw, { scenario }) => {
         )
       }
       if (appliesDuring[scenario]) {
-        plugins.push(pluginEntry)
+        flatPlugins.push(pluginEntry)
         return
       }
       if (pluginEntry.destroy) {
@@ -199,8 +234,8 @@ const flattenAndFilterPlugins = (pluginsRaw, { scenario }) => {
     }
     throw new Error(`plugin must be objects, got ${pluginEntry}`)
   }
-  pluginsRaw.forEach((plugin) => visitPluginEntry(plugin))
-  return plugins
+  plugins.forEach((plugin) => visitPluginEntry(plugin))
+  return flatPlugins
 }
 
 const getHookFunction = (