@depup/webpack 5.106.0-depup.0 → 5.109.0-depup.0

package/lib/javascript/JavascriptGenerator.js

@@ -10,7 +10,15 @@ const { RawSource, ReplaceSource } = require("webpack-sources");
 const Generator = require("../Generator");
 const InitFragment = require("../InitFragment");
 const { JAVASCRIPT_TYPES } = require("../ModuleSourceTypeConstants");
+const RuntimeGlobals = require("../RuntimeGlobals");
+const CommonJsExportsDependency = require("../dependencies/CommonJsExportsDependency");
+const CommonJsFullRequireDependency = require("../dependencies/CommonJsFullRequireDependency");
+const CommonJsRequireDependency = require("../dependencies/CommonJsRequireDependency");
+const CommonJsSelfReferenceDependency = require("../dependencies/CommonJsSelfReferenceDependency");
+const ContextDependency = require("../dependencies/ContextDependency");
 const HarmonyCompatibilityDependency = require("../dependencies/HarmonyCompatibilityDependency");
+const ImportDependency = require("../dependencies/ImportDependency");
+const RequireResolveDependency = require("../dependencies/RequireResolveDependency");
 
 /** @typedef {import("webpack-sources").Source} Source */
 /** @typedef {import("../Compilation").DependencyConstructor} DependencyConstructor */
@@ -23,6 +31,7 @@ const HarmonyCompatibilityDependency = require("../dependencies/HarmonyCompatibi
 /** @typedef {import("../Module").ConcatenationBailoutReasonContext} ConcatenationBailoutReasonContext */
 /** @typedef {import("../Module").SourceType} SourceType */
 /** @typedef {import("../Module").SourceTypes} SourceTypes */
+/** @typedef {import("./JavascriptModule").JavascriptModuleBuildInfo} JavascriptModuleBuildInfo */
 /** @typedef {import("../NormalModule")} NormalModule */
 
 const DEFAULT_SOURCE = {
@@ -30,6 +39,7 @@ const DEFAULT_SOURCE = {
 		return new RawSource("throw new Error('No source available');");
 	},
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @returns {number} size of the DEFAULT_SOURCE.source()
 	 */
 	size() {
@@ -40,8 +50,146 @@ const DEFAULT_SOURCE = {
 // TODO: clean up this file
 // replace with newer constructs
 
+// Runtime requirements whose presence on a presentational dependency means the
+// code references the module/exports objects, which do not exist for an inner
+// concatenated module (e.g. `module.id`, `module.hot`, top-level `this`).
+/** @type {ReadonlySet<string>} */
+const CONCATENATION_INCOMPATIBLE_RUNTIME_REQUIREMENTS = new Set([
+	RuntimeGlobals.module,
+	RuntimeGlobals.moduleId,
+	RuntimeGlobals.moduleLoaded,
+	RuntimeGlobals.moduleCache,
+	RuntimeGlobals.exports,
+	RuntimeGlobals.thisAsExports,
+	RuntimeGlobals.harmonyModuleDecorator,
+	RuntimeGlobals.nodeModuleDecorator
+]);
+
+// A wrapped CommonJS module keeps real `module`/`exports` objects and top-level
+// `this`, so only requirements that need a module object webpack does not
+// synthesize here (id, loaded state, cache, decorators) block wrapping.
+/** @type {ReadonlySet<string>} */
+const WRAPPING_INCOMPATIBLE_RUNTIME_REQUIREMENTS = new Set([
+	RuntimeGlobals.moduleId,
+	RuntimeGlobals.moduleLoaded,
+	RuntimeGlobals.moduleCache,
+	RuntimeGlobals.harmonyModuleDecorator,
+	RuntimeGlobals.nodeModuleDecorator
+]);
+
+/**
+ * Returns the reason a CommonJS module cannot take part in concatenation at
+ * all — neither hoisted (as a "nice" module) nor wrapped. A module passing
+ * this check can be hoisted or wrapped; {@link isCommonJsHoistable} decides
+ * which.
+ * @param {NormalModule} module the module
+ * @returns {string | undefined} reason it can't be concatenated
+ */
+const getCommonJsConcatenationBailoutReason = (module) => {
+	const buildMeta = module.buildMeta;
+	// "flagged"/"default" are hoistable; a dynamic (undefined) exports type is a
+	// reassigned/computed `module.exports`, only reachable by wrapping. Proper ESM
+	// modules ("namespace") never reach this path.
+	if (
+		!buildMeta ||
+		(buildMeta.exportsType !== "flagged" &&
+			buildMeta.exportsType !== "default" &&
+			buildMeta.exportsType !== undefined)
+	) {
+		return "Module is not an ECMAScript module";
+	}
+	// Sloppy-mode modules bail out in ModuleConcatenationPlugin anyway,
+	// so skip the dependency scan for them (most of node_modules)
+	if (!(/** @type {JavascriptModuleBuildInfo} */ (module.buildInfo).strict)) {
+		return "Module is not in strict mode";
+	}
+	const wrapped = !isCommonJsHoistable(module);
+	// A dynamic exports type only makes sense when wrapping; a hoistable module
+	// with no static exports keeps its previous (bailed) behavior.
+	if (buildMeta.exportsType === undefined && !wrapped) {
+		return "Module is not an ECMAScript module";
+	}
+	for (const dep of module.dependencies) {
+		if (
+			dep instanceof CommonJsExportsDependency ||
+			dep instanceof CommonJsSelfReferenceDependency
+		) {
+			// Any export shape is fine: hoisted modules restrict these below,
+			// wrapped modules keep them verbatim inside the wrapper.
+			continue;
+		} else if (
+			dep instanceof CommonJsRequireDependency ||
+			dep instanceof CommonJsFullRequireDependency ||
+			dep instanceof RequireResolveDependency ||
+			dep instanceof ContextDependency
+		) {
+			// A wrapped module renders with its own module ids intact, so a
+			// require() target that is itself inlined (no id) would break. Only
+			// hoisted ("nice") modules — whose require targets always stay
+			// external — may keep these.
+			if (wrapped) {
+				return `Module uses ${dep.type} which is not supported when wrapping`;
+			}
+		} else if (!(dep instanceof ImportDependency)) {
+			return `Module uses an unsupported dependency (${dep.type})`;
+		}
+	}
+	if (module.presentationalDependencies !== undefined) {
+		const incompatible = wrapped
+			? WRAPPING_INCOMPATIBLE_RUNTIME_REQUIREMENTS
+			: CONCATENATION_INCOMPATIBLE_RUNTIME_REQUIREMENTS;
+		for (const dep of module.presentationalDependencies) {
+			const runtimeRequirements =
+				/** @type {{ runtimeRequirements?: ReadonlySet<string> | null }} */
+				(dep).runtimeRequirements;
+			if (!runtimeRequirements) continue;
+			for (const requirement of runtimeRequirements) {
+				if (incompatible.has(requirement)) {
+					return `Module uses ${requirement}`;
+				}
+			}
+		}
+	}
+	return undefined;
+};
+
+/**
+ * A "nice" CommonJS module has a static list of exports, assigned only via
+ * plain `exports.x = …` / `module.exports.x = …`, and never uses the
+ * `module`/`exports` objects in any other way, so every reference can be
+ * rewritten to a hoisted module-scope variable. Modules eligible for
+ * concatenation but not hoistable are wrapped instead.
+ * @param {NormalModule} module the module
+ * @returns {boolean} true when the module can be hoisted rather than wrapped
+ */
+const isCommonJsHoistable = (module) => {
+	for (const dep of module.dependencies) {
+		if (dep instanceof CommonJsExportsDependency) {
+			if (dep.base !== "exports" && dep.base !== "module.exports") return false;
+			if (dep.names.length === 0) return false;
+		} else if (dep instanceof CommonJsSelfReferenceDependency) {
+			if (dep.base !== "exports" && dep.base !== "module.exports") return false;
+			if (dep.names.length === 0) return false;
+			// `exports.f()` passes the exports object as `this`
+			if (dep.call && dep.names.length === 1) return false;
+		}
+	}
+	return true;
+};
+
+/**
+ * Whether a concatenation-eligible CommonJS module must be wrapped (rendered
+ * inside an IIFE with real `module`/`exports` objects) rather than hoisted.
+ * @param {NormalModule} module the module
+ * @returns {boolean} true when the module needs wrapping
+ */
+const isCommonJsWrapped = (module) =>
+	getCommonJsConcatenationBailoutReason(module) === undefined &&
+	!isCommonJsHoistable(module);
+
 const deprecatedGetInitFragments = util.deprecate(
 	/**
+	 * Handles the callback logic for this hook.
 	 * @param {DependencyTemplate} template template
 	 * @param {Dependency} dependency dependency
 	 * @param {DependencyTemplateContext} templateContext template context
@@ -56,6 +204,7 @@ const deprecatedGetInitFragments = util.deprecate(
 
 class JavascriptGenerator extends Generator {
 	/**
+	 * Returns the source types available for this module.
 	 * @param {NormalModule} module fresh module
 	 * @returns {SourceTypes} available types (do not mutate)
 	 */
@@ -64,6 +213,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {NormalModule} module the module
 	 * @param {SourceType=} type source type
 	 * @returns {number} estimate size of the module
@@ -77,12 +227,14 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the reason this module cannot be concatenated, when one exists.
 	 * @param {NormalModule} module module for which the bailout reason should be determined
 	 * @param {ConcatenationBailoutReasonContext} context context
 	 * @returns {string | undefined} reason why this module can't be concatenated, undefined when it can be concatenated
 	 */
 	getConcatenationBailoutReason(module, context) {
-		// Only harmony modules are valid for optimization
+		// Harmony modules and CommonJS modules with statically rewritable
+		// exports are valid for optimization
 		if (
 			!module.buildMeta ||
 			module.buildMeta.exportsType !== "namespace" ||
@@ -91,26 +243,33 @@ class JavascriptGenerator extends Generator {
 				(d) => d instanceof HarmonyCompatibilityDependency
 			)
 		) {
-			return "Module is not an ECMAScript module";
+			// CommonJS concatenation is opt-in via optimization.concatenateCommonJsModules
+			const reason = context.concatenateCommonJsModules
+				? getCommonJsConcatenationBailoutReason(module)
+				: "Module is not an ECMAScript module";
+			if (reason !== undefined) return reason;
 		}
 
 		// Some expressions are not compatible with module concatenation
 		// because they may produce unexpected results. The plugin bails out
 		// if some were detected upfront.
-		if (module.buildInfo && module.buildInfo.moduleConcatenationBailout) {
-			return `Module uses ${module.buildInfo.moduleConcatenationBailout}`;
+		const buildInfo = /** @type {JavascriptModuleBuildInfo | undefined} */ (
+			module.buildInfo
+		);
+		if (buildInfo && buildInfo.moduleConcatenationBailout) {
+			return `Module uses ${buildInfo.moduleConcatenationBailout}`;
 		}
 	}
 
 	/**
-	 * @param {Module} module the current module
+	 * Processes the provided module.
 	 * @param {Dependency} dependency the dependency to generate
-	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
 	 * @param {ReplaceSource} source the current replace source which can be modified
+	 * @param {DependencyTemplateContext} templateContext the template context shared for the whole module
 	 * @param {GenerateContext} generateContext the render context
 	 * @returns {void}
 	 */
-	sourceDependency(module, dependency, initFragments, source, generateContext) {
+	sourceDependency(dependency, source, templateContext, generateContext) {
 		const constructor =
 			/** @type {DependencyConstructor} */
 			(dependency.constructor);
@@ -121,39 +280,6 @@ class JavascriptGenerator extends Generator {
 			);
 		}
 
-		/** @type {InitFragment<GenerateContext>[] | undefined} */
-		let chunkInitFragments;
-
-		/** @type {DependencyTemplateContext} */
-		const templateContext = {
-			runtimeTemplate: generateContext.runtimeTemplate,
-			dependencyTemplates: generateContext.dependencyTemplates,
-			moduleGraph: generateContext.moduleGraph,
-			chunkGraph: generateContext.chunkGraph,
-			module,
-			runtime: generateContext.runtime,
-			runtimeRequirements: generateContext.runtimeRequirements,
-			concatenationScope: generateContext.concatenationScope,
-			codeGenerationResults:
-				/** @type {NonNullable<GenerateContext["codeGenerationResults"]>} */
-				(generateContext.codeGenerationResults),
-			initFragments,
-			get chunkInitFragments() {
-				if (!chunkInitFragments) {
-					const data =
-						/** @type {NonNullable<GenerateContext["getData"]>} */
-						(generateContext.getData)();
-					chunkInitFragments = data.get("chunkInitFragments");
-					if (!chunkInitFragments) {
-						chunkInitFragments = [];
-						data.set("chunkInitFragments", chunkInitFragments);
-					}
-				}
-
-				return chunkInitFragments;
-			}
-		};
-
 		template.apply(dependency, source, templateContext);
 
 		// TODO remove in webpack 6
@@ -166,27 +292,27 @@ class JavascriptGenerator extends Generator {
 
 			if (fragments) {
 				for (const fragment of fragments) {
-					initFragments.push(fragment);
+					templateContext.initFragments.push(fragment);
 				}
 			}
 		}
 	}
 
 	/**
+	 * Processes the provided module.
 	 * @param {Module} module the module to generate
 	 * @param {DependenciesBlock} block the dependencies block which will be processed
-	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
+	 * @param {DependencyTemplateContext} templateContext the template context shared for the whole module
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {GenerateContext} generateContext the generateContext
 	 * @returns {void}
 	 */
-	sourceBlock(module, block, initFragments, source, generateContext) {
+	sourceBlock(module, block, templateContext, source, generateContext) {
 		for (const dependency of block.dependencies) {
 			this.sourceDependency(
-				module,
 				dependency,
-				initFragments,
 				source,
+				templateContext,
 				generateContext
 			);
 		}
@@ -195,7 +321,7 @@ class JavascriptGenerator extends Generator {
 			this.sourceBlock(
 				module,
 				childBlock,
-				initFragments,
+				templateContext,
 				source,
 				generateContext
 			);
@@ -203,6 +329,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Processes the provided module.
 	 * @param {Module} module the module to generate
 	 * @param {InitFragment<GenerateContext>[]} initFragments mutable list of init fragments
 	 * @param {ReplaceSource} source the current replace source which can be modified
@@ -210,12 +337,45 @@ class JavascriptGenerator extends Generator {
 	 * @returns {void}
 	 */
 	sourceModule(module, initFragments, source, generateContext) {
+		/** @type {InitFragment<GenerateContext>[] | undefined} */
+		let chunkInitFragments;
+
+		// one template context for all dependencies of the module (hot path)
+		/** @type {DependencyTemplateContext} */
+		const templateContext = {
+			runtimeTemplate: generateContext.runtimeTemplate,
+			dependencyTemplates: generateContext.dependencyTemplates,
+			moduleGraph: generateContext.moduleGraph,
+			chunkGraph: generateContext.chunkGraph,
+			module,
+			runtime: generateContext.runtime,
+			runtimeRequirements: generateContext.runtimeRequirements,
+			concatenationScope: generateContext.concatenationScope,
+			codeGenerationResults:
+				/** @type {NonNullable<GenerateContext["codeGenerationResults"]>} */
+				(generateContext.codeGenerationResults),
+			initFragments,
+			get chunkInitFragments() {
+				if (!chunkInitFragments) {
+					const data =
+						/** @type {NonNullable<GenerateContext["getData"]>} */
+						(generateContext.getData)();
+					chunkInitFragments = data.get("chunkInitFragments");
+					if (!chunkInitFragments) {
+						chunkInitFragments = [];
+						data.set("chunkInitFragments", chunkInitFragments);
+					}
+				}
+
+				return chunkInitFragments;
+			}
+		};
+
 		for (const dependency of module.dependencies) {
 			this.sourceDependency(
-				module,
 				dependency,
-				initFragments,
 				source,
+				templateContext,
 				generateContext
 			);
 		}
@@ -223,10 +383,9 @@ class JavascriptGenerator extends Generator {
 		if (module.presentationalDependencies !== undefined) {
 			for (const dependency of module.presentationalDependencies) {
 				this.sourceDependency(
-					module,
 					dependency,
-					initFragments,
 					source,
+					templateContext,
 					generateContext
 				);
 			}
@@ -236,7 +395,7 @@ class JavascriptGenerator extends Generator {
 			this.sourceBlock(
 				module,
 				childBlock,
-				initFragments,
+				templateContext,
 				source,
 				generateContext
 			);
@@ -244,6 +403,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Generates generated code for this runtime module.
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
 	 * @returns {Source | null} generated code
@@ -264,6 +424,7 @@ class JavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Generates fallback output for the provided error condition.
 	 * @param {Error} error the error
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
@@ -275,3 +436,4 @@ class JavascriptGenerator extends Generator {
 }
 
 module.exports = JavascriptGenerator;
+module.exports.isCommonJsWrapped = isCommonJsWrapped;

package/lib/javascript/JavascriptModule.js

@@ -0,0 +1,54 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+*/
+
+"use strict";
+
+const NormalModule = require("../NormalModule");
+const makeSerializable = require("../util/makeSerializable");
+
+/** @typedef {import("../Module").BuildMeta} BuildMeta */
+/** @typedef {import("../NormalModule").NormalModuleBuildInfo} NormalModuleBuildInfo */
+/** @typedef {import("../NormalModule").NormalModuleCreateData} NormalModuleCreateData */
+
+/**
+ * Defines the build info properties specific to javascript modules.
+ * @typedef {object} KnownJavascriptModuleBuildInfo
+ * @property {string=} moduleConcatenationBailout using in CommonJs
+ * @property {boolean=} needCreateRequire using in APIPlugin
+ * @property {Set<string>=} pureFunctions names of locally declared functions known to be free of side effects
+ * @property {boolean=} inlineExports whether this module was parsed with `optimization.inlineExports` enabled (gates inlining of its exports)
+ */
+
+/** @typedef {NormalModuleBuildInfo & KnownJavascriptModuleBuildInfo} JavascriptModuleBuildInfo */
+
+/**
+ * Defines the build meta properties specific to javascript modules.
+ * @typedef {object} KnownJavascriptModuleBuildMeta
+ * @property {boolean=} strictHarmonyModule
+ * @property {boolean=} treatAsCommonJs
+ */
+
+/** @typedef {BuildMeta & KnownJavascriptModuleBuildMeta} JavascriptModuleBuildMeta */
+
+/**
+ * Module class for all `javascript/*` modules. JavaScript-specific properties should live here instead of `NormalModule`.
+ */
+class JavascriptModule extends NormalModule {
+	/**
+	 * @param {NormalModuleCreateData} options options object
+	 */
+	constructor(options) {
+		super(options);
+
+		// Redeclared with the javascript specific shape
+		/** @type {JavascriptModuleBuildInfo | undefined} */
+		this.buildInfo = undefined;
+		/** @type {JavascriptModuleBuildMeta | undefined} */
+		this.buildMeta = undefined;
+	}
+}
+
+makeSerializable(JavascriptModule, "webpack/lib/javascript/JavascriptModule");
+
+module.exports = JavascriptModule;