@jsenv/core 39.2.19 → 39.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "39.2.19",
+  "version": "39.3.1",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {
@@ -69,7 +69,7 @@
     "@financial-times/polyfill-useragent-normaliser": "1.10.2",
     "@jsenv/abort": "4.3.0",
     "@jsenv/ast": "6.2.15",
-    "@jsenv/filesystem": "4.9.10",
+    "@jsenv/filesystem": "4.10.0",
     "@jsenv/humanize": "1.2.8",
     "@jsenv/importmap": "1.2.1",
     "@jsenv/integrity": "0.0.2",

package/src/build/build.js

@@ -27,18 +27,19 @@ import { createLogger, createTaskLog } from "@jsenv/humanize";
 import { jsenvPluginBundling } from "@jsenv/plugin-bundling";
 import { jsenvPluginMinification } from "@jsenv/plugin-minification";
 import { jsenvPluginJsModuleFallback } from "@jsenv/plugin-transpilation";
-
+import { urlIsInsideOf } from "@jsenv/urls";
 import { lookupPackageDirectory } from "../helpers/lookup_package_directory.js";
 import { watchSourceFiles } from "../helpers/watch_source_files.js";
+import { jsenvCoreDirectoryUrl } from "../jsenv_core_directory_url.js";
 import { createKitchen } from "../kitchen/kitchen.js";
 import { createUrlGraphSummary } from "../kitchen/url_graph/url_graph_report.js";
 import { GRAPH_VISITOR } from "../kitchen/url_graph/url_graph_visitor.js";
+import { jsenvPluginDirectoryReferenceEffect } from "../plugins/directory_reference_effect/jsenv_plugin_directory_reference_effect.js";
 import { jsenvPluginInlining } from "../plugins/inlining/jsenv_plugin_inlining.js";
 import { getCorePlugins } from "../plugins/plugins.js";
 import { jsenvPluginReferenceAnalysis } from "../plugins/reference_analysis/jsenv_plugin_reference_analysis.js";
-import { jsenvPluginLineBreakNormalization } from "./jsenv_plugin_line_break_normalization.js";
-
 import { createBuildSpecifierManager } from "./build_specifier_manager.js";
+import { jsenvPluginLineBreakNormalization } from "./jsenv_plugin_line_break_normalization.js";
 
 // default runtimeCompat corresponds to
 // "we can keep <script type="module"> intact":
@@ -149,7 +150,10 @@ export const build = async ({
       "buildDirectoryUrl",
     );
     if (outDirectoryUrl === undefined) {
-      if (process.env.CAPTURING_SIDE_EFFECTS) {
+      if (
+        process.env.CAPTURING_SIDE_EFFECTS ||
+        urlIsInsideOf(sourceDirectoryUrl, jsenvCoreDirectoryUrl)
+      ) {
         outDirectoryUrl = new URL("../.jsenv/", sourceDirectoryUrl);
       } else {
         const packageDirectoryUrl = lookupPackageDirectory(sourceDirectoryUrl);
@@ -363,6 +367,7 @@ build ${entryPointKeys.length} entry points`);
           fetchInlineUrls: false,
           // inlineContent: false,
         }),
+        jsenvPluginDirectoryReferenceEffect(directoryReferenceEffect),
         ...(lineBreakNormalization
           ? [jsenvPluginLineBreakNormalization()]
           : []),

package/src/build/build_specifier_manager.js

@@ -16,6 +16,7 @@ import {
   ensurePathnameTrailingSlash,
   injectQueryParamIntoSpecifierWithoutEncoding,
   renderUrlOrRelativeUrlFilename,
+  urlIsInsideOf,
   urlToRelativeUrl,
 } from "@jsenv/urls";
 import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
@@ -203,7 +204,7 @@ export const createBuildSpecifierManager = ({
       if (!generatedUrl.startsWith("file:")) {
         return null;
       }
-      if (reference.isWeak) {
+      if (reference.isWeak && reference.expectedType !== "directory") {
         return null;
       }
       if (reference.type === "sourcemap_comment") {
@@ -468,6 +469,9 @@ export const createBuildSpecifierManager = ({
     if (reference.type === "sourcemap_comment") {
       return false;
     }
+    if (reference.expectedType === "directory") {
+      return true;
+    }
     // specifier comes from "normalize" hook done a bit earlier in this file
     // we want to get back their build url to access their infos
     const referencedUrlInfo = reference.urlInfo;
@@ -480,6 +484,7 @@ export const createBuildSpecifierManager = ({
   const prepareVersioning = () => {
     const contentOnlyVersionMap = new Map();
     const urlInfoToContainedPlaceholderSetMap = new Map();
+    const directoryUrlInfoSet = new Set();
     generate_content_only_versions: {
       GRAPH_VISITOR.forEachUrlInfoStronglyReferenced(
         finalKitchen.graph.rootUrlInfo,
@@ -536,6 +541,9 @@ export const createBuildSpecifierManager = ({
           const contentVersion = generateVersion([content], versionLength);
           contentOnlyVersionMap.set(urlInfo, contentVersion);
         },
+        {
+          directoryUrlInfoSet,
+        },
       );
     }
 
@@ -582,9 +590,13 @@ export const createBuildSpecifierManager = ({
         }
         return setOfUrlInfluencingVersion;
       };
-      for (const [urlInfo, contentOnlyVersion] of contentOnlyVersionMap) {
+
+      for (const [
+        contentOnlyUrlInfo,
+        contentOnlyVersion,
+      ] of contentOnlyVersionMap) {
         const setOfUrlInfoInfluencingVersion =
-          getSetOfUrlInfoInfluencingVersion(urlInfo);
+          getSetOfUrlInfoInfluencingVersion(contentOnlyUrlInfo);
         const versionPartSet = new Set();
         versionPartSet.add(contentOnlyVersion);
         for (const urlInfoInfluencingVersion of setOfUrlInfoInfluencingVersion) {
@@ -593,13 +605,42 @@ export const createBuildSpecifierManager = ({
           );
           if (!otherUrlInfoContentVersion) {
             throw new Error(
-              `cannot find content version for ${urlInfoInfluencingVersion.url} (used by ${urlInfo.url})`,
+              `cannot find content version for ${urlInfoInfluencingVersion.url} (used by ${contentOnlyUrlInfo.url})`,
             );
           }
           versionPartSet.add(otherUrlInfoContentVersion);
         }
         const version = generateVersion(versionPartSet, versionLength);
-        versionMap.set(urlInfo, version);
+        versionMap.set(contentOnlyUrlInfo, version);
+      }
+    }
+
+    generate_directory_versions: {
+      // we should grab all the files inside this directory
+      // they will influence his versioning
+      for (const directoryUrlInfo of directoryUrlInfoSet) {
+        const directoryUrl = directoryUrlInfo.url;
+        // const urlInfoInsideThisDirectorySet = new Set();
+        const versionsInfluencingThisDirectorySet = new Set();
+        for (const [url, urlInfo] of finalKitchen.graph.urlInfoMap) {
+          if (!urlIsInsideOf(url, directoryUrl)) {
+            continue;
+          }
+          // ideally we should exclude eventual directories as the are redundant
+          // with the file they contains
+          const version = versionMap.get(urlInfo);
+          if (version !== undefined) {
+            versionsInfluencingThisDirectorySet.add(version);
+          }
+        }
+        const contentVersion =
+          versionsInfluencingThisDirectorySet.size === 0
+            ? "empty"
+            : generateVersion(
+                versionsInfluencingThisDirectorySet,
+                versionLength,
+              );
+        versionMap.set(directoryUrlInfo, contentVersion);
       }
     }
   };
@@ -613,6 +654,9 @@ export const createBuildSpecifierManager = ({
       return buildSpecifier;
     }
     const version = versionMap.get(reference.urlInfo);
+    if (version === undefined) {
+      return buildSpecifier;
+    }
     const buildSpecifierVersioned = injectVersionIntoBuildSpecifier({
       buildSpecifier,
       versioningMethod,
@@ -722,9 +766,9 @@ export const createBuildSpecifierManager = ({
             generateReplacement(urlInfo.firstReference);
           }
           if (urlInfo.firstReference.type === "side_effect_file") {
+            // side effect stuff must be generated too
             generateReplacement(urlInfo.firstReference);
           }
-          // side effect stuff must be generated too
           if (mayUsePlaceholder(urlInfo)) {
             const contentBeforeReplace = urlInfo.content;
             const { content, sourcemap } = placeholderAPI.replaceAll(

package/src/build/build_urls_generator.js

@@ -33,9 +33,14 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
     if (buildUrlFromCache) {
       return buildUrlFromCache;
     }
-    if (urlInfo.type === "directory") {
+    if (
+      urlInfo.type === "directory" ||
+      (urlInfo.type === undefined && urlInfo.typeHint === "directory")
+    ) {
       let directoryPath;
-      if (urlInfo.filenameHint) {
+      if (url === sourceDirectoryUrl) {
+        directoryPath = "";
+      } else if (urlInfo.filenameHint) {
         directoryPath = urlInfo.filenameHint;
       } else {
         directoryPath = urlToRelativeUrl(url, sourceDirectoryUrl);

package/src/dev/start_dev_server.js

@@ -13,7 +13,7 @@ import {
 } from "@jsenv/server";
 import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/internal/convertFileSystemErrorToResponseProperties.js";
 import { URL_META } from "@jsenv/url-meta";
-import { urlToRelativeUrl } from "@jsenv/urls";
+import { urlIsInsideOf, urlToRelativeUrl } from "@jsenv/urls";
 import { existsSync, readFileSync } from "node:fs";
 
 import { defaultRuntimeCompat } from "../build/build.js";
@@ -21,6 +21,7 @@ import { createEventEmitter } from "../helpers/event_emitter.js";
 import { lookupPackageDirectory } from "../helpers/lookup_package_directory.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 { getCorePlugins } from "../plugins/plugins.js";
 import { jsenvPluginServerEventsClientInjection } from "../plugins/server_events/jsenv_plugin_server_events_client_injection.js";
@@ -105,7 +106,10 @@ export const startDevServer = async ({
       sourceDirectoryUrl,
     );
     if (outDirectoryUrl === undefined) {
-      if (process.env.CAPTURING_SIDE_EFFECTS) {
+      if (
+        process.env.CAPTURING_SIDE_EFFECTS ||
+        urlIsInsideOf(sourceDirectoryUrl, jsenvCoreDirectoryUrl)
+      ) {
         outDirectoryUrl = new URL("../.jsenv/", sourceDirectoryUrl);
       } else {
         const packageDirectoryUrl = lookupPackageDirectory(sourceDirectoryUrl);

package/src/jsenv_core_directory_url.js

@@ -0,0 +1 @@
+export const jsenvCoreDirectoryUrl = new URL("../", import.meta.url);

package/src/kitchen/url_graph/references.js

@@ -728,6 +728,9 @@ const applyReferenceEffectsOnUrlInfo = (reference) => {
   if (reference.filenameHint && !referencedUrlInfo.filenameHint) {
     referencedUrlInfo.filenameHint = reference.filenameHint;
   }
+  if (reference.dirnameHint && !referencedUrlInfo.dirnameHint) {
+    referencedUrlInfo.dirnameHint = reference.dirnameHint;
+  }
   if (reference.debug) {
     referencedUrlInfo.debug = true;
   }

package/src/kitchen/url_graph/url_graph_visitor.js

@@ -106,18 +106,28 @@ GRAPH_VISITOR.findDependency = (urlInfo, visitor) => {
 // because we start from root and ignore weak ref
 // The alternative would be to iterate on urlInfoMap
 // and call urlInfo.isUsed() but that would be more expensive
-GRAPH_VISITOR.forEachUrlInfoStronglyReferenced = (initialUrlInfo, callback) => {
+GRAPH_VISITOR.forEachUrlInfoStronglyReferenced = (
+  initialUrlInfo,
+  callback,
+  { directoryUrlInfoSet } = {},
+) => {
   const seen = new Set();
   seen.add(initialUrlInfo);
   const iterateOnReferences = (urlInfo) => {
     for (const referenceToOther of urlInfo.referenceToOthersSet) {
-      if (referenceToOther.isWeak) {
-        continue;
-      }
       if (referenceToOther.gotInlined()) {
         continue;
       }
       const referencedUrlInfo = referenceToOther.urlInfo;
+      if (
+        directoryUrlInfoSet &&
+        referenceToOther.expectedType === "directory"
+      ) {
+        directoryUrlInfoSet.add(referencedUrlInfo);
+      }
+      if (referenceToOther.isWeak) {
+        continue;
+      }
       if (seen.has(referencedUrlInfo)) {
         continue;
       }

package/src/plugins/directory_reference_effect/jsenv_plugin_directory_reference_effect.js

@@ -0,0 +1,63 @@
+import { urlToFilename } from "@jsenv/urls";
+
+export const jsenvPluginDirectoryReferenceEffect = (
+  directoryReferenceEffect = "error",
+) => {
+  return {
+    name: "jsenv:directory_reference_effect",
+    appliesDuring: "*",
+    redirectReference: (reference) => {
+      // http, https, data, about, ...
+      if (!reference.url.startsWith("file:")) {
+        return null;
+      }
+      if (reference.isInline) {
+        return null;
+      }
+      if (reference.ownerUrlInfo.type === "directory") {
+        reference.dirnameHint = reference.ownerUrlInfo.filenameHint;
+      }
+      const { pathname } = new URL(reference.url);
+      if (pathname[pathname.length - 1] !== "/") {
+        return null;
+      }
+      reference.leadsToADirectory = true;
+      reference.expectedType = "directory";
+      if (reference.ownerUrlInfo.type === "directory") {
+        reference.dirnameHint = reference.ownerUrlInfo.filenameHint;
+      }
+      if (reference.type === "filesystem") {
+        reference.filenameHint = `${
+          reference.ownerUrlInfo.filenameHint
+        }${urlToFilename(reference.url)}/`;
+      } else {
+        reference.filenameHint = `${urlToFilename(reference.url)}/`;
+      }
+      let actionForDirectory;
+      if (reference.type === "a_href") {
+        actionForDirectory = "copy";
+      } else if (reference.type === "filesystem") {
+        actionForDirectory = "copy";
+      } else if (typeof directoryReferenceEffect === "string") {
+        actionForDirectory = directoryReferenceEffect;
+      } else if (typeof directoryReferenceEffect === "function") {
+        actionForDirectory = directoryReferenceEffect(reference);
+      } else {
+        actionForDirectory = "error";
+      }
+      reference.actionForDirectory = actionForDirectory;
+      if (actionForDirectory !== "copy") {
+        reference.isWeak = true;
+      }
+      if (actionForDirectory === "error") {
+        const error = new Error("Reference leads to a directory");
+        error.code = "DIRECTORY_REFERENCE_NOT_ALLOWED";
+        throw error;
+      }
+      if (actionForDirectory === "preserve") {
+        return `ignore:${reference.specifier}`;
+      }
+      return null;
+    },
+  };
+};

package/src/plugins/plugin_controller.js

@@ -181,13 +181,13 @@ export const createPluginController = (
     currentPlugin = hook.plugin;
     currentHookName = hook.name;
     let valueReturned = hookFn(info);
-    currentPlugin = null;
-    currentHookName = null;
     if (info.timing) {
       info.timing[`${hook.name}-${hook.plugin.name.replace("jsenv:", "")}`] =
         performance.now() - startTimestamp;
     }
     valueReturned = assertAndNormalizeReturnValue(hook, valueReturned, info);
+    currentPlugin = null;
+    currentHookName = null;
     return valueReturned;
   };
   const callAsyncHook = async (hook, info) => {
@@ -204,13 +204,13 @@ export const createPluginController = (
     currentPlugin = hook.plugin;
     currentHookName = hook.name;
     let valueReturned = await hookFn(info);
-    currentPlugin = null;
-    currentHookName = null;
     if (info.timing) {
       info.timing[`${hook.name}-${hook.plugin.name.replace("jsenv:", "")}`] =
         performance.now() - startTimestamp;
     }
     valueReturned = assertAndNormalizeReturnValue(hook, valueReturned, info);
+    currentPlugin = null;
+    currentHookName = null;
     return valueReturned;
   };
 

package/src/plugins/plugins.js

@@ -9,6 +9,7 @@ import { jsenvPluginWebResolution } from "./resolution_web/jsenv_plugin_web_reso
 import { jsenvPluginVersionSearchParam } from "./version_search_param/jsenv_plugin_version_search_param.js";
 import { jsenvPluginProtocolFile } from "./protocol_file/jsenv_plugin_protocol_file.js";
 import { jsenvPluginProtocolHttp } from "./protocol_http/jsenv_plugin_protocol_http.js";
+import { jsenvPluginDirectoryReferenceEffect } from "./directory_reference_effect/jsenv_plugin_directory_reference_effect.js";
 import { jsenvPluginInjections } from "./injections/jsenv_plugin_injections.js";
 import { jsenvPluginInlining } from "./inlining/jsenv_plugin_inlining.js";
 import { jsenvPluginCommonJsGlobals } from "./commonjs_globals/jsenv_plugin_commonjs_globals.js";
@@ -66,7 +67,6 @@ export const getCorePlugins = ({
        - All the rest uses web standard url resolution
      */
     jsenvPluginProtocolFile({
-      directoryReferenceEffect,
       magicExtensions,
       magicDirectoryIndex,
     }),
@@ -75,6 +75,7 @@ export const getCorePlugins = ({
       ? [jsenvPluginNodeEsmResolution(nodeEsmResolution)]
       : []),
     jsenvPluginWebResolution(),
+    jsenvPluginDirectoryReferenceEffect(directoryReferenceEffect),
 
     jsenvPluginVersionSearchParam(),
     jsenvPluginCommonJsGlobals(),

package/src/plugins/protocol_file/jsenv_plugin_fs_redirection.js

@@ -0,0 +1,108 @@
+import {
+  applyFileSystemMagicResolution,
+  getExtensionsToTry,
+} from "@jsenv/node-esm-resolution";
+import { realpathSync, statSync } from "node:fs";
+import { pathToFileURL } from "node:url";
+
+export const jsenvPluginFsRedirection = ({
+  magicExtensions = ["inherit", ".js"],
+  magicDirectoryIndex = true,
+  preserveSymlinks = false,
+}) => {
+  return {
+    name: "jsenv:fs_redirection",
+    appliesDuring: "*",
+    redirectReference: (reference) => {
+      // http, https, data, about, ...
+      if (!reference.url.startsWith("file:")) {
+        return null;
+      }
+      if (reference.isInline) {
+        return null;
+      }
+      if (reference.url === "file:///" || reference.url === "file://") {
+        reference.leadsToADirectory = true;
+        return `ignore:file:///`;
+      }
+      // ignore all new URL second arg
+      if (reference.subtype === "new_url_second_arg") {
+        return `ignore:${reference.url}`;
+      }
+      // ignore "./" on new URL("./")
+      // if (
+      //   reference.subtype === "new_url_first_arg" &&
+      //   reference.specifier === "./"
+      // ) {
+      //   return `ignore:${reference.url}`;
+      // }
+      const urlObject = new URL(reference.url);
+      let stat;
+      try {
+        stat = statSync(urlObject);
+      } catch (e) {
+        if (e.code === "ENOENT") {
+          stat = null;
+        } else {
+          throw e;
+        }
+      }
+      const { search, hash } = urlObject;
+      urlObject.search = "";
+      urlObject.hash = "";
+      applyStatEffectsOnUrlObject(urlObject, stat);
+      const shouldApplyFilesystemMagicResolution =
+        reference.type === "js_import";
+      if (shouldApplyFilesystemMagicResolution) {
+        const filesystemResolution = applyFileSystemMagicResolution(
+          urlObject.href,
+          {
+            fileStat: stat,
+            magicDirectoryIndex,
+            magicExtensions: getExtensionsToTry(
+              magicExtensions,
+              reference.ownerUrlInfo.url,
+            ),
+          },
+        );
+        if (filesystemResolution.stat) {
+          stat = filesystemResolution.stat;
+          urlObject.href = filesystemResolution.url;
+          applyStatEffectsOnUrlObject(urlObject, stat);
+        }
+      }
+      if (!stat) {
+        return null;
+      }
+      const urlRaw = preserveSymlinks
+        ? urlObject.href
+        : resolveSymlink(urlObject.href);
+      const resolvedUrl = `${urlRaw}${search}${hash}`;
+      return resolvedUrl;
+    },
+  };
+};
+
+const applyStatEffectsOnUrlObject = (urlObject, stat) => {
+  const { pathname } = urlObject;
+  const pathnameUsesTrailingSlash = pathname.endsWith("/");
+  // force trailing slash on directories
+  if (stat && stat.isDirectory() && !pathnameUsesTrailingSlash) {
+    urlObject.pathname = `${pathname}/`;
+  }
+  // otherwise remove trailing slash if any
+  if (stat && !stat.isDirectory() && pathnameUsesTrailingSlash) {
+    // a warning here? (because it's strange to reference a file with a trailing slash)
+    urlObject.pathname = pathname.slice(0, -1);
+  }
+};
+
+const resolveSymlink = (fileUrl) => {
+  const urlObject = new URL(fileUrl);
+  const realpath = realpathSync(urlObject);
+  const realUrlObject = pathToFileURL(realpath);
+  if (urlObject.pathname.endsWith("/")) {
+    realUrlObject.pathname += `/`;
+  }
+  return realUrlObject.href;
+};