@rollup/plugin-commonjs 22.0.0-0 → 22.0.0-4

package/README.md

@@ -51,9 +51,9 @@ When used together with the node-resolve plugin
 Type: `"auto" | boolean | "debug" | string[]`<br>
 Default: `"auto"`
 
-By default, this plugin will try to hoist `require` statements as imports to the top of each file. While this works well for many code bases and allows for very efficient ESM output, it does not perfectly capture CommonJS semantics as the order of side effects like log statements may change. But it is especially problematic when there are circular `require` calls between CommonJS modules as those often rely on the lazy execution of nested `require` calls.
+By default, this plugin will try to hoist `require` statements as imports to the top of each file. While this works well for many code bases and allows for very efficient ESM output, it does not perfectly capture CommonJS semantics as the initialisation order of required modules will be different. The resultant side effects can include log statements being emitted in a different order, and some code that is dependent on the initialisation order of polyfills in require statements may not work. But it is especially problematic when there are circular `require` calls between CommonJS modules as those often rely on the lazy execution of nested `require` calls.
 
-Setting this option to `true` will wrap all CommonJS files in functions which are executed when they are required for the first time, preserving NodeJS semantics. Note that this can have an impact on the size and performance of the generated code.
+Setting this option to `true` will wrap all CommonJS files in functions which are executed when they are required for the first time, preserving NodeJS semantics. This is the safest setting and should be used if the generated code does not work correctly with `"auto"`. Note that `strictRequires: true` can have a small impact on the size and performance of generated code, but less so if the code is minified.
 
 The default value of `"auto"` will only wrap CommonJS files when they are part of a CommonJS dependency cycle, e.g. an index file that is required by some of its dependencies, or if they are only required in a potentially "conditional" way like from within an if-statement or a function. All other CommonJS files are hoisted. This is the recommended setting for most code bases. Note that the detection of conditional requires can be subject to race conditions if there are both conditional and unconditional requires of the same file, which in edge cases may result in inconsistencies between builds. If you think this is a problem for you, you can avoid this by using any value other than `"auto"` or `"debug"`.
 

package/dist/index.es.js

@@ -7,9 +7,9 @@ import { walk } from 'estree-walker';
 import MagicString from 'magic-string';
 import isReference from 'is-reference';
 
-var version = "22.0.0-0";
+var version = "22.0.0-4";
 var peerDependencies = {
-	rollup: "^2.60.0"
+	rollup: "^2.61.1"
 };
 
 function tryParse(parse, code, id) {
@@ -194,6 +194,9 @@ function getDynamicRequireModules(patterns, dynamicRequireRoot) {
 
 const FAILED_REQUIRE_ERROR = `throw new Error('Could not dynamically require "' + path + '". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.');`;
 
+const COMMONJS_REQUIRE_EXPORT = 'commonjsRequire';
+const CREATE_COMMONJS_REQUIRE_EXPORT = 'createCommonjsRequire';
+
 function getDynamicModuleRegistry(
   isDynamicRequireModulesEnabled,
   dynamicRequireModules,
@@ -201,7 +204,7 @@ function getDynamicModuleRegistry(
   ignoreDynamicRequires
 ) {
   if (!isDynamicRequireModulesEnabled) {
-    return `export function commonjsRequire(path) {
+    return `export function ${COMMONJS_REQUIRE_EXPORT}(path) {
 	${FAILED_REQUIRE_ERROR}
 }`;
   }
@@ -231,25 +234,25 @@ ${dynamicModuleProps}
 	});
 }
 
-export function commonjsRequire(path, originalModuleDir) {
-	var resolvedPath = commonjsResolveImpl(path, originalModuleDir);
-	if (resolvedPath !== null) {
-		return getDynamicModules()[resolvedPath]();
+export function ${CREATE_COMMONJS_REQUIRE_EXPORT}(originalModuleDir) {
+	function handleRequire(path) {
+		var resolvedPath = commonjsResolve(path, originalModuleDir);
+		if (resolvedPath !== null) {
+			return getDynamicModules()[resolvedPath]();
+		}
+		${ignoreDynamicRequires ? 'return require(path);' : FAILED_REQUIRE_ERROR}
 	}
-	${ignoreDynamicRequires ? 'return require(path);' : FAILED_REQUIRE_ERROR}
-}
-
-function commonjsResolve (path, originalModuleDir) {
-	const resolvedPath = commonjsResolveImpl(path, originalModuleDir);
-	if (resolvedPath !== null) {
-		return resolvedPath;
+	handleRequire.resolve = function (path) {
+		var resolvedPath = commonjsResolve(path, originalModuleDir);
+		if (resolvedPath !== null) {
+			return resolvedPath;
+		}
+		return require.resolve(path);
 	}
-	return require.resolve(path);
+	return handleRequire;
 }
 
-commonjsRequire.resolve = commonjsResolve;
-
-function commonjsResolveImpl (path, originalModuleDir) {
+function commonjsResolve (path, originalModuleDir) {
 	var shouldTryNodeModules = isPossibleNodeModulesPath(path);
 	path = normalize(path);
 	var relPath;
@@ -478,6 +481,14 @@ function resolveExtensions(importee, importer, extensions) {
 
 function getResolveId(extensions) {
   return async function resolveId(importee, importer, resolveOptions) {
+    // We assume that all requires are pre-resolved
+    if (
+      resolveOptions.custom &&
+      resolveOptions.custom['node-resolve'] &&
+      resolveOptions.custom['node-resolve'].isRequire
+    ) {
+      return null;
+    }
     if (isWrappedId(importee, WRAPPED_SUFFIX)) {
       return unwrapId(importee, WRAPPED_SUFFIX);
     }
@@ -497,7 +508,7 @@ function getResolveId(extensions) {
     if (importer) {
       if (
         importer === DYNAMIC_MODULES_ID ||
-        // Except for exports, proxies are only importing resolved ids, no need to resolve again
+        // Proxies are only importing resolved ids, no need to resolve again
         isWrappedId(importer, PROXY_SUFFIX) ||
         isWrappedId(importer, ES_IMPORT_SUFFIX)
       ) {
@@ -546,9 +557,39 @@ function getResolveRequireSourcesAndGetMeta(extensions, detectCyclesAndCondition
   const knownCjsModuleTypes = Object.create(null);
   const requiredIds = Object.create(null);
   const unconditionallyRequiredIds = Object.create(null);
-  const dependentModules = Object.create(null);
-  const getDependentModules = (id) =>
-    dependentModules[id] || (dependentModules[id] = Object.create(null));
+  const dependencies = Object.create(null);
+  const getDependencies = (id) => dependencies[id] || (dependencies[id] = new Set());
+
+  const isCyclic = (id) => {
+    const dependenciesToCheck = new Set(getDependencies(id));
+    for (const dependency of dependenciesToCheck) {
+      if (dependency === id) {
+        return true;
+      }
+      for (const childDependency of getDependencies(dependency)) {
+        dependenciesToCheck.add(childDependency);
+      }
+    }
+    return false;
+  };
+
+  const fullyAnalyzedModules = Object.create(null);
+
+  const getTypeForFullyAnalyzedModule = (id) => {
+    const knownType = knownCjsModuleTypes[id];
+    if (
+      knownType === IS_WRAPPED_COMMONJS ||
+      !detectCyclesAndConditional ||
+      fullyAnalyzedModules[id]
+    ) {
+      return knownType;
+    }
+    fullyAnalyzedModules[id] = true;
+    if (isCyclic(id)) {
+      return (knownCjsModuleTypes[id] = IS_WRAPPED_COMMONJS);
+    }
+    return knownType;
+  };
 
   return {
     getWrappedIds: () =>
@@ -561,8 +602,9 @@ function getResolveRequireSourcesAndGetMeta(extensions, detectCyclesAndCondition
       isParentCommonJS,
       sources
     ) => {
-      knownCjsModuleTypes[parentId] = knownCjsModuleTypes[parentId] || isParentCommonJS;
+      knownCjsModuleTypes[parentId] = isParentCommonJS;
       if (
+        detectCyclesAndConditional &&
         knownCjsModuleTypes[parentId] &&
         requiredIds[parentId] &&
         !unconditionallyRequiredIds[parentId]
@@ -577,9 +619,7 @@ function getResolveRequireSourcesAndGetMeta(extensions, detectCyclesAndCondition
           }
           const resolved =
             (await rollupContext.resolve(source, parentId, {
-              custom: {
-                'node-resolve': { isRequire: true }
-              }
+              custom: { 'node-resolve': { isRequire: true } }
             })) || resolveExtensions(source, parentId, extensions);
           if (!resolved) {
             return { id: wrapId(source, EXTERNAL_SUFFIX), allowProxy: false };
@@ -589,44 +629,25 @@ function getResolveRequireSourcesAndGetMeta(extensions, detectCyclesAndCondition
             return { id: wrapId(childId, EXTERNAL_SUFFIX), allowProxy: false };
           }
           requiredIds[childId] = true;
-          if (
-            !(
-              detectCyclesAndConditional &&
-              (isConditional || knownCjsModuleTypes[parentId] === IS_WRAPPED_COMMONJS)
-            )
-          ) {
+          if (!(isConditional || knownCjsModuleTypes[parentId] === IS_WRAPPED_COMMONJS)) {
             unconditionallyRequiredIds[childId] = true;
           }
-          const parentDependentModules = getDependentModules(parentId);
-          const childDependentModules = getDependentModules(childId);
-          childDependentModules[parentId] = true;
-          for (const dependentId of Object.keys(parentDependentModules)) {
-            childDependentModules[dependentId] = true;
-          }
-          if (parentDependentModules[childId]) {
-            // If we depend on one of our dependencies, we have a cycle. Then all modules that
-            // we depend on that also depend on the same module are part of a cycle as well.
-            if (detectCyclesAndConditional && isParentCommonJS) {
-              knownCjsModuleTypes[parentId] = IS_WRAPPED_COMMONJS;
-              knownCjsModuleTypes[childId] = IS_WRAPPED_COMMONJS;
-              for (const dependentId of Object.keys(parentDependentModules)) {
-                if (getDependentModules(dependentId)[childId]) {
-                  knownCjsModuleTypes[dependentId] = IS_WRAPPED_COMMONJS;
-                }
-              }
-            }
-          } else {
+
+          getDependencies(parentId).add(childId);
+          if (!isCyclic(childId)) {
             // This makes sure the current transform handler waits for all direct dependencies to be
             // loaded and transformed and therefore for all transitive CommonJS dependencies to be
             // loaded as well so that all cycles have been found and knownCjsModuleTypes is reliable.
             await rollupContext.load(resolved);
+          } else if (detectCyclesAndConditional && knownCjsModuleTypes[parentId]) {
+            knownCjsModuleTypes[parentId] = IS_WRAPPED_COMMONJS;
           }
           return { id: childId, allowProxy: true };
         })
       );
       return {
         requireTargets: requireTargets.map(({ id: dependencyId, allowProxy }, index) => {
-          const isCommonJS = knownCjsModuleTypes[dependencyId];
+          const isCommonJS = getTypeForFullyAnalyzedModule(dependencyId);
           return {
             source: sources[index].source,
             id: allowProxy
@@ -637,29 +658,39 @@ function getResolveRequireSourcesAndGetMeta(extensions, detectCyclesAndCondition
             isCommonJS
           };
         }),
-        usesRequireWrapper: knownCjsModuleTypes[parentId] === IS_WRAPPED_COMMONJS
+        usesRequireWrapper: getTypeForFullyAnalyzedModule(parentId) === IS_WRAPPED_COMMONJS
       };
     }
   };
 }
 
-function validateRollupVersion(rollupVersion, peerDependencyVersion) {
-  const [major, minor] = rollupVersion.split('.').map(Number);
-  const versionRegexp = /\^(\d+\.\d+)\.\d+/g;
+function validateVersion(actualVersion, peerDependencyVersion, name) {
+  const versionRegexp = /\^(\d+\.\d+\.\d+)/g;
   let minMajor = Infinity;
   let minMinor = Infinity;
+  let minPatch = Infinity;
   let foundVersion;
   // eslint-disable-next-line no-cond-assign
   while ((foundVersion = versionRegexp.exec(peerDependencyVersion))) {
-    const [foundMajor, foundMinor] = foundVersion[1].split('.').map(Number);
+    const [foundMajor, foundMinor, foundPatch] = foundVersion[1].split('.').map(Number);
     if (foundMajor < minMajor) {
       minMajor = foundMajor;
       minMinor = foundMinor;
+      minPatch = foundPatch;
     }
   }
-  if (major < minMajor || (major === minMajor && minor < minMinor)) {
+  if (!actualVersion) {
     throw new Error(
-      `Insufficient Rollup version: "@rollup/plugin-commonjs" requires at least rollup@${minMajor}.${minMinor} but found rollup@${rollupVersion}.`
+      `Insufficient ${name} version: "@rollup/plugin-commonjs" requires at least ${name}@${minMajor}.${minMinor}.${minPatch}.`
+    );
+  }
+  const [major, minor, patch] = actualVersion.split('.').map(Number);
+  if (
+    major < minMajor ||
+    (major === minMajor && (minor < minMinor || (minor === minMinor && patch < minPatch)))
+  ) {
+    throw new Error(
+      `Insufficient ${name} version: "@rollup/plugin-commonjs" requires at least ${name}@${minMajor}.${minMinor}.${minPatch} but found ${name}@${actualVersion}.`
     );
   }
 }
@@ -1105,14 +1136,16 @@ function getRequireHandlers() {
     resolveRequireSourcesAndGetMeta,
     needsRequireWrapper,
     isEsModule,
-    usesRequire,
+    isDynamicRequireModulesEnabled,
     getIgnoreTryCatchRequireStatementMode
   ) {
     const imports = [];
     imports.push(`import * as ${helpersName} from "${HELPERS_ID}";`);
-    if (usesRequire) {
+    if (dynamicRequireName) {
       imports.push(
-        `import { commonjsRequire as ${dynamicRequireName} } from "${DYNAMIC_MODULES_ID}";`
+        `import { ${
+          isDynamicRequireModulesEnabled ? CREATE_COMMONJS_REQUIRE_EXPORT : COMMONJS_REQUIRE_EXPORT
+        } as ${dynamicRequireName} } from "${DYNAMIC_MODULES_ID}";`
       );
     }
     if (exportMode === 'module') {
@@ -1398,15 +1431,9 @@ async function transformCommonjs(
             isRequire(node.callee.object, scope) &&
             node.callee.property.name === 'resolve'
           ) {
-            checkDynamicRequire();
+            checkDynamicRequire(node.start);
             uses.require = true;
             const requireNode = node.callee.object;
-            magicString.appendLeft(
-              node.end - 1,
-              `,${JSON.stringify(
-                dirname(id) === '.' ? null /* default behavior */ : virtualDynamicRequirePath
-              )}`
-            );
             replacedDynamicRequires.push(requireNode);
             return;
           }
@@ -1420,15 +1447,9 @@ async function transformCommonjs(
 
           if (hasDynamicArguments(node)) {
             if (isDynamicRequireModulesEnabled) {
-              magicString.appendLeft(
-                node.end - 1,
-                `, ${JSON.stringify(
-                  dirname(id) === '.' ? null /* default behavior */ : virtualDynamicRequirePath
-                )}`
-              );
+              checkDynamicRequire(node.start);
             }
             if (!ignoreDynamicRequires) {
-              checkDynamicRequire();
               replacedDynamicRequires.push(node.callee);
             }
             return;
@@ -1486,7 +1507,6 @@ async function transformCommonjs(
                 return;
               }
               if (!ignoreDynamicRequires) {
-                checkDynamicRequire();
                 if (isShorthandProperty(parent)) {
                   magicString.prependRight(node.start, 'require: ');
                 }
@@ -1570,9 +1590,10 @@ async function transformCommonjs(
             if (scope.contains(flattened.name)) return;
 
             if (
-              flattened.keypath === 'module.exports' ||
-              flattened.keypath === 'module' ||
-              flattened.keypath === 'exports'
+              !isEsModule &&
+              (flattened.keypath === 'module.exports' ||
+                flattened.keypath === 'module' ||
+                flattened.keypath === 'exports')
             ) {
               magicString.overwrite(node.start, node.end, `'object'`, {
                 storeName: false
@@ -1600,7 +1621,13 @@ async function transformCommonjs(
   const requireName = deconflict([scope], globals, `require${capitalize(nameBase)}`);
   const isRequiredName = deconflict([scope], globals, `hasRequired${capitalize(nameBase)}`);
   const helpersName = deconflict([scope], globals, 'commonjsHelpers');
-  const dynamicRequireName = deconflict([scope], globals, 'commonjsRequire');
+  const dynamicRequireName =
+    replacedDynamicRequires.length > 0 &&
+    deconflict(
+      [scope],
+      globals,
+      isDynamicRequireModulesEnabled ? CREATE_COMMONJS_REQUIRE_EXPORT : COMMONJS_REQUIRE_EXPORT
+    );
   const deconflictedExportNames = Object.create(null);
   for (const [exportName, { scopes }] of exportsAssignmentsByName) {
     deconflictedExportNames[exportName] = deconflict([...scopes], globals, exportName);
@@ -1612,10 +1639,17 @@ async function transformCommonjs(
     });
   }
   for (const node of replacedDynamicRequires) {
-    magicString.overwrite(node.start, node.end, dynamicRequireName, {
-      contentOnly: true,
-      storeName: true
-    });
+    magicString.overwrite(
+      node.start,
+      node.end,
+      isDynamicRequireModulesEnabled
+        ? `${dynamicRequireName}(${JSON.stringify(virtualDynamicRequirePath)})`
+        : dynamicRequireName,
+      {
+        contentOnly: true,
+        storeName: true
+      }
+    );
   }
 
   // We cannot wrap ES/mixed modules
@@ -1670,7 +1704,7 @@ async function transformCommonjs(
     resolveRequireSourcesAndGetMeta,
     needsRequireWrapper,
     isEsModule,
-    uses.require,
+    isDynamicRequireModulesEnabled,
     getIgnoreTryCatchRequireStatementMode
   );
   const exportBlock = isEsModule
@@ -1831,16 +1865,19 @@ function commonjs(options = {}) {
       !isEsModule &&
       (dynamicRequireModules.has(normalizePathSlashes(id)) || strictRequiresFilter(id));
 
-    const checkDynamicRequire = () => {
+    const checkDynamicRequire = (position) => {
       if (id.indexOf(dynamicRequireRoot) !== 0) {
-        this.error({
-          code: 'DYNAMIC_REQUIRE_OUTSIDE_ROOT',
-          id,
-          dynamicRequireRoot,
-          message: `"${id}" contains dynamic require statements but it is not within the current dynamicRequireRoot "${dynamicRequireRoot}". You should set dynamicRequireRoot to "${dirname(
-            id
-          )}" or one of its parent directories.`
-        });
+        this.error(
+          {
+            code: 'DYNAMIC_REQUIRE_OUTSIDE_ROOT',
+            id,
+            dynamicRequireRoot,
+            message: `"${id}" contains dynamic require statements but it is not within the current dynamicRequireRoot "${dynamicRequireRoot}". You should set dynamicRequireRoot to "${dirname(
+              id
+            )}" or one of its parent directories.`
+          },
+          position
+        );
       }
     };
 
@@ -1886,8 +1923,12 @@ function commonjs(options = {}) {
       return { ...rawOptions, plugins };
     },
 
-    buildStart() {
-      validateRollupVersion(this.meta.rollupVersion, peerDependencies.rollup);
+    buildStart({ plugins }) {
+      validateVersion(this.meta.rollupVersion, peerDependencies.rollup, 'rollup');
+      const nodeResolve = plugins.find(({ name }) => name === 'node-resolve');
+      if (nodeResolve) {
+        validateVersion(nodeResolve.version, '^13.0.6', '@rollup/plugin-node-resolve');
+      }
       if (options.namedExports != null) {
         this.warn(
           'The namedExports option from "@rollup/plugin-commonjs" is deprecated. Named exports are now handled automatically.'