@jsenv/core 40.2.0 → 40.3.1

package/src/plugins/package_side_effects/jsenv_plugin_package_side_effects.js

@@ -0,0 +1,213 @@
+/**
+ * Lorsqu'on bundle un package ayant pas le field sideEffects
+ * alors on fini potentiellement par dire
+ * sideEffect: false
+ * sur le package racine alors qu'on en sait rien
+ * on pourrait mettre un package.json dans dist dans ce cas
+ * qui ne déclare pas le field side effect afin
+ * d'override le package.json du project qui lui dit qu'il ny en a pas
+ *
+ * On part du principe pour le moment que c'est la respo du package racine de déclarer cela
+ *
+ */
+
+import { updateJsonFileSync } from "@jsenv/filesystem";
+import { isSpecifierForNodeBuiltin } from "@jsenv/node-esm-resolution/src/node_builtin_specifiers.js";
+import { URL_META } from "@jsenv/url-meta";
+import { urlToRelativeUrl } from "@jsenv/urls";
+
+export const jsenvPluginPackageSideEffects = ({ packageDirectory }) => {
+  if (!packageDirectory.url) {
+    return [];
+  }
+  const packageJson = packageDirectory.read(packageDirectory.url);
+  if (!packageJson) {
+    return [];
+  }
+  const { sideEffects } = packageJson;
+  if (sideEffects !== false && !Array.isArray(sideEffects)) {
+    return [];
+  }
+
+  const sideEffectFileUrlSet = new Set();
+  const packageJsonFileUrl = new URL("./package.json", packageDirectory.url)
+    .href;
+
+  const normalizeSideEffectFileUrl = (url) => {
+    const urlRelativeToPackage = urlToRelativeUrl(url, packageDirectory.url);
+    return urlRelativeToPackage[0] === "."
+      ? urlRelativeToPackage
+      : `./${urlRelativeToPackage}`;
+  };
+
+  const sideEffectBuildFileUrls = [];
+
+  const packageSideEffectsCacheMap = new Map();
+  const readSideEffectInfoFromClosestPackage = (urlInfo) => {
+    const closestPackageDirectoryUrl = urlInfo.packageDirectoryUrl;
+    const closestPackageJSON = urlInfo.packageJSON;
+    if (!closestPackageJSON) {
+      return undefined;
+    }
+    const fromCache = packageSideEffectsCacheMap.get(
+      closestPackageDirectoryUrl,
+    );
+    if (fromCache) {
+      return fromCache.value;
+    }
+    try {
+      return storePackageSideEffect(
+        closestPackageDirectoryUrl,
+        closestPackageJSON,
+      );
+    } catch {
+      return storePackageSideEffect(closestPackageDirectoryUrl, null);
+    }
+  };
+  const storePackageSideEffect = (packageDirectoryUrl, packageJSON) => {
+    if (!packageJSON) {
+      packageSideEffectsCacheMap.set(packageDirectoryUrl, { value: undefined });
+      return undefined;
+    }
+    const value = packageJSON.sideEffects;
+    if (Array.isArray(value)) {
+      const noSideEffect = {
+        has: false,
+        reason: "not listed in package.json side effects",
+        packageDirectoryUrl,
+      };
+      const hasSideEffect = {
+        has: true,
+        reason: "listed in package.json side effects",
+        packageDirectoryUrl,
+      };
+      const sideEffectPatterns = {};
+      for (const v of value) {
+        sideEffectPatterns[v] = v;
+      }
+      const associations = URL_META.resolveAssociations(
+        { sideEffects: sideEffectPatterns },
+        packageDirectoryUrl,
+      );
+      const getSideEffectInfo = (urlInfo) => {
+        const meta = URL_META.applyAssociations({
+          url: urlInfo.url,
+          associations,
+        });
+        const sideEffectKey = meta.sideEffects;
+        if (sideEffectKey) {
+          return {
+            ...hasSideEffect,
+            reason: `"${sideEffectKey}" listed in package.json side effects`,
+          };
+        }
+        return noSideEffect;
+      };
+      packageSideEffectsCacheMap.set(packageDirectoryUrl, {
+        value: getSideEffectInfo,
+      });
+      return getSideEffectInfo;
+    }
+    if (value === false) {
+      const noSideEffect = {
+        has: false,
+        reason: "package.json side effects is false",
+        packageDirectoryUrl,
+      };
+      packageSideEffectsCacheMap.set(packageDirectoryUrl, {
+        value: noSideEffect,
+      });
+      return noSideEffect;
+    }
+    const hasSideEffect = {
+      has: true,
+      reason: "package.json side effects is true",
+      packageDirectoryUrl,
+    };
+    packageSideEffectsCacheMap.set(packageDirectoryUrl, {
+      value: hasSideEffect,
+    });
+    return hasSideEffect;
+  };
+  const getSideEffectInfoFromClosestPackage = (urlInfo) => {
+    const sideEffectInfoFromClosestPackage =
+      readSideEffectInfoFromClosestPackage(urlInfo);
+    if (sideEffectInfoFromClosestPackage === undefined) {
+      return null;
+    }
+    if (typeof sideEffectInfoFromClosestPackage === "function") {
+      return sideEffectInfoFromClosestPackage(urlInfo);
+    }
+    return sideEffectInfoFromClosestPackage;
+  };
+
+  return {
+    name: "jsenv:package_side_effects",
+    appliesDuring: "build",
+    urlInfoCreated: (urlInfo) => {
+      const url = urlInfo.url;
+      if (isSpecifierForNodeBuiltin(url)) {
+        urlInfo.contentSideEffects.push({
+          sideEffect: "no",
+          reason: "node builtin module",
+        });
+        return;
+      }
+      if (url.startsWith("file:")) {
+        const sideEffectFromClosestPackage =
+          getSideEffectInfoFromClosestPackage(urlInfo);
+        if (sideEffectFromClosestPackage) {
+          // if (sideEffectFromClosestPackage.has) {
+          //    console.log(`have side effect: ${url}`);
+          // } else {
+          //  console.log(`no side effect: ${url}`);
+          // }
+          urlInfo.contentSideEffects.push(sideEffectFromClosestPackage);
+        }
+        return;
+      }
+    },
+    refineBuildUrlContent: (buildUrlInfo, { buildUrl }) => {
+      for (const sideEffect of buildUrlInfo.contentSideEffects) {
+        if (sideEffect.has) {
+          sideEffectBuildFileUrls.push(buildUrl);
+          return;
+        }
+      }
+    },
+    refineBuild: () => {
+      if (sideEffectBuildFileUrls.length === 0) {
+        return;
+      }
+      let sideEffectsToAdd = [];
+      if (sideEffects === false) {
+        sideEffectsToAdd = sideEffectBuildFileUrls;
+      } else if (Array.isArray(sideEffects)) {
+        for (const sideEffectFileRelativeUrl of sideEffects) {
+          const sideEffectFileUrl = new URL(
+            sideEffectFileRelativeUrl,
+            packageDirectory.url,
+          ).href;
+          sideEffectFileUrlSet.add(sideEffectFileUrl);
+        }
+        for (const url of sideEffectBuildFileUrls) {
+          if (sideEffectFileUrlSet.has(url)) {
+            continue;
+          }
+          sideEffectsToAdd.push(url);
+        }
+      }
+      if (sideEffectsToAdd.length === 0) {
+        return;
+      }
+
+      const finalSideEffects = Array.isArray(sideEffects) ? sideEffects : [];
+      for (const sideEffectBuildUrl of sideEffectBuildFileUrls) {
+        finalSideEffects.push(normalizeSideEffectFileUrl(sideEffectBuildUrl));
+      }
+      updateJsonFileSync(packageJsonFileUrl, {
+        sideEffects: finalSideEffects,
+      });
+    },
+  };
+};

package/src/plugins/plugin_controller.js

@@ -289,15 +289,18 @@ const HOOK_NAMES = [
   "redirectReference",
   "transformReferenceSearchParams",
   "formatReference",
+  "urlInfoCreated",
   "fetchUrlContent",
   "transformUrlContent",
   "finalizeUrlContent",
   "bundle", // is called only during build
-  "optimizeUrlContent", // is called only during build
+  "optimizeBuildUrlContent", // is called only during build
   "cooked",
   "augmentResponse", // is called only during dev/tests
   "destroy",
   "effect",
+  "refineBuildUrlContent", // called only during build
+  "refineBuild", // called only during build
 ];
 
 const testAppliesDuring = (plugin, kitchen) => {
@@ -408,7 +411,7 @@ const returnValueAssertions = [
       "fetchUrlContent",
       "transformUrlContent",
       "finalizeUrlContent",
-      "optimizeUrlContent",
+      "optimizeBuildUrlContent",
     ],
     assertion: (valueReturned, urlInfo, { hook }) => {
       if (typeof valueReturned === "string" || Buffer.isBuffer(valueReturned)) {

package/src/plugins/plugins.js

@@ -25,11 +25,13 @@ import { jsenvPluginRibbon } from "./ribbon/jsenv_plugin_ribbon.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";
 
 export const getCorePlugins = ({
   rootDirectoryUrl,
   mainFilePath,
   runtimeCompat,
+  packageDirectory,
   sourceFilesConfig,
 
   referenceAnalysis = {},
@@ -50,6 +52,7 @@ export const getCorePlugins = ({
   cacheControl,
   scenarioPlaceholders = true,
   ribbon = true,
+  packageSideEffects = false,
 } = {}) => {
   if (cacheControl === true) {
     cacheControl = {};
@@ -90,6 +93,7 @@ export const getCorePlugins = ({
       directoryListing,
       rootDirectoryUrl,
       mainFilePath,
+      packageDirectory,
       sourceFilesConfig,
     }),
     {
@@ -133,5 +137,8 @@ export const getCorePlugins = ({
     ...(ribbon ? [jsenvPluginRibbon({ rootDirectoryUrl, ...ribbon })] : []),
     jsenvPluginCleanHTML(),
     jsenvPluginChromeDevtoolsJson(),
+    ...(packageSideEffects
+      ? [jsenvPluginPackageSideEffects({ rootDirectoryUrl, packageDirectory })]
+      : []),
   ];
 };

package/src/plugins/protocol_file/jsenv_plugin_directory_listing.js

@@ -24,7 +24,6 @@
 
 import {
   compareFileUrls,
-  lookupPackageDirectory,
   readEntryStatSync,
   registerDirectoryLifecycle,
 } from "@jsenv/filesystem";
@@ -49,6 +48,7 @@ export const jsenvPluginDirectoryListing = ({
   urlMocks = false,
   autoreload = true,
   directoryContentMagicName,
+  packageDirectory,
   rootDirectoryUrl,
   mainFilePath,
   sourceFilesConfig,
@@ -134,6 +134,7 @@ export const jsenvPluginDirectoryListing = ({
               directoryContentMagicName,
               rootDirectoryUrl,
               mainFilePath,
+              packageDirectory,
               enoent,
             }),
           },
@@ -221,6 +222,7 @@ const generateDirectoryListingInjection = (
   {
     rootDirectoryUrl,
     mainFilePath,
+    packageDirectory,
     request,
     urlMocks,
     directoryContentMagicName,
@@ -240,14 +242,13 @@ const generateDirectoryListingInjection = (
     firstExistingDirectoryUrl,
   });
   package_workspaces: {
-    const packageDirectoryUrl = lookupPackageDirectory(serverRootDirectoryUrl);
-    if (!packageDirectoryUrl) {
+    if (!packageDirectory.url) {
       break package_workspaces;
     }
-    if (String(packageDirectoryUrl) === String(serverRootDirectoryUrl)) {
+    if (String(packageDirectory.url) === String(serverRootDirectoryUrl)) {
       break package_workspaces;
     }
-    rootDirectoryUrl = packageDirectoryUrl;
+    rootDirectoryUrl = packageDirectory.url;
     // if (String(firstExistingDirectoryUrl) === String(serverRootDirectoryUrl)) {
     //   let packageContent;
     //   try {

package/src/plugins/protocol_file/jsenv_plugin_protocol_file.js

@@ -15,6 +15,7 @@ export const jsenvPluginProtocolFile = ({
   directoryListing,
   rootDirectoryUrl,
   mainFilePath,
+  packageDirectory,
   sourceFilesConfig,
 }) => {
   return [
@@ -78,6 +79,7 @@ export const jsenvPluginProtocolFile = ({
             directoryContentMagicName,
             rootDirectoryUrl,
             mainFilePath,
+            packageDirectory,
             sourceFilesConfig,
           }),
         ]