webpack 5.76.1 → 5.88.0

package/lib/CompatibilityPlugin.js

@@ -5,12 +5,22 @@
 
 "use strict";
 
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC,
+	JAVASCRIPT_MODULE_TYPE_ESM
+} = require("./ModuleTypeConstants");
+const RuntimeGlobals = require("./RuntimeGlobals");
 const ConstDependency = require("./dependencies/ConstDependency");
 
+/** @typedef {import("estree").CallExpression} CallExpression */
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Dependency").DependencyLocation} DependencyLocation */
 /** @typedef {import("./javascript/JavascriptParser")} JavascriptParser */
+/** @typedef {import("./javascript/JavascriptParser").Range} Range */
 
-const nestedWebpackRequireTag = Symbol("nested __webpack_require__");
+const nestedWebpackIdentifierTag = Symbol("nested webpack identifier");
+const PLUGIN_NAME = "CompatibilityPlugin";
 
 class CompatibilityPlugin {
 	/**
@@ -20,7 +30,7 @@ class CompatibilityPlugin {
 	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
-			"CompatibilityPlugin",
+			PLUGIN_NAME,
 			(compilation, { normalModuleFactory }) => {
 				compilation.dependencyTemplates.set(
 					ConstDependency,
@@ -28,24 +38,31 @@ class CompatibilityPlugin {
 				);
 
 				normalModuleFactory.hooks.parser
-					.for("javascript/auto")
-					.tap("CompatibilityPlugin", (parser, parserOptions) => {
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, (parser, parserOptions) => {
 						if (
 							parserOptions.browserify !== undefined &&
 							!parserOptions.browserify
 						)
 							return;
 
-						parser.hooks.call
-							.for("require")
-							.tap("CompatibilityPlugin", expr => {
+						parser.hooks.call.for("require").tap(
+							PLUGIN_NAME,
+							/**
+							 * @param {CallExpression} expr call expression
+							 * @returns {boolean | void} true when need to handle
+							 */
+							expr => {
 								// support for browserify style require delegator: "require(o, !0)"
 								if (expr.arguments.length !== 2) return;
 								const second = parser.evaluateExpression(expr.arguments[1]);
 								if (!second.isBoolean()) return;
 								if (second.asBool() !== true) return;
-								const dep = new ConstDependency("require", expr.callee.range);
-								dep.loc = expr.loc;
+								const dep = new ConstDependency(
+									"require",
+									/** @type {Range} */ (expr.callee.range)
+								);
+								dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 								if (parser.state.current.dependencies.length > 0) {
 									const last =
 										parser.state.current.dependencies[
@@ -62,7 +79,8 @@ class CompatibilityPlugin {
 								}
 								parser.state.module.addPresentationalDependency(dep);
 								return true;
-							});
+							}
+						);
 					});
 
 				/**
@@ -71,30 +89,51 @@ class CompatibilityPlugin {
 				 */
 				const handler = parser => {
 					// Handle nested requires
-					parser.hooks.preStatement.tap("CompatibilityPlugin", statement => {
+					parser.hooks.preStatement.tap(PLUGIN_NAME, statement => {
 						if (
 							statement.type === "FunctionDeclaration" &&
 							statement.id &&
-							statement.id.name === "__webpack_require__"
+							statement.id.name === RuntimeGlobals.require
 						) {
-							const newName = `__nested_webpack_require_${statement.range[0]}__`;
-							parser.tagVariable(statement.id.name, nestedWebpackRequireTag, {
+							const newName = `__nested_webpack_require_${
+								/** @type {Range} */ (statement.range)[0]
+							}__`;
+							parser.tagVariable(
+								statement.id.name,
+								nestedWebpackIdentifierTag,
+								{
+									name: newName,
+									declaration: {
+										updated: false,
+										loc: statement.id.loc,
+										range: statement.id.range
+									}
+								}
+							);
+							return true;
+						}
+					});
+					parser.hooks.pattern
+						.for(RuntimeGlobals.require)
+						.tap(PLUGIN_NAME, pattern => {
+							const newName = `__nested_webpack_require_${
+								/** @type {Range} */ (pattern.range)[0]
+							}__`;
+							parser.tagVariable(pattern.name, nestedWebpackIdentifierTag, {
 								name: newName,
 								declaration: {
 									updated: false,
-									loc: statement.id.loc,
-									range: statement.id.range
+									loc: pattern.loc,
+									range: pattern.range
 								}
 							});
 							return true;
-						}
-					});
+						});
 					parser.hooks.pattern
-						.for("__webpack_require__")
-						.tap("CompatibilityPlugin", pattern => {
-							const newName = `__nested_webpack_require_${pattern.range[0]}__`;
-							parser.tagVariable(pattern.name, nestedWebpackRequireTag, {
-								name: newName,
+						.for(RuntimeGlobals.exports)
+						.tap(PLUGIN_NAME, pattern => {
+							parser.tagVariable(pattern.name, nestedWebpackIdentifierTag, {
+								name: "__nested_webpack_exports__",
 								declaration: {
 									updated: false,
 									loc: pattern.loc,
@@ -104,8 +143,8 @@ class CompatibilityPlugin {
 							return true;
 						});
 					parser.hooks.expression
-						.for(nestedWebpackRequireTag)
-						.tap("CompatibilityPlugin", expr => {
+						.for(nestedWebpackIdentifierTag)
+						.tap(PLUGIN_NAME, expr => {
 							const { name, declaration } = parser.currentTagData;
 							if (!declaration.updated) {
 								const dep = new ConstDependency(name, declaration.range);
@@ -113,38 +152,38 @@ class CompatibilityPlugin {
 								parser.state.module.addPresentationalDependency(dep);
 								declaration.updated = true;
 							}
-							const dep = new ConstDependency(name, expr.range);
-							dep.loc = expr.loc;
+							const dep = new ConstDependency(
+								name,
+								/** @type {Range} */ (expr.range)
+							);
+							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 							parser.state.module.addPresentationalDependency(dep);
 							return true;
 						});
 
 					// Handle hashbang
-					parser.hooks.program.tap(
-						"CompatibilityPlugin",
-						(program, comments) => {
-							if (comments.length === 0) return;
-							const c = comments[0];
-							if (c.type === "Line" && c.range[0] === 0) {
-								if (parser.state.source.slice(0, 2).toString() !== "#!") return;
-								// this is a hashbang comment
-								const dep = new ConstDependency("//", 0);
-								dep.loc = c.loc;
-								parser.state.module.addPresentationalDependency(dep);
-							}
+					parser.hooks.program.tap(PLUGIN_NAME, (program, comments) => {
+						if (comments.length === 0) return;
+						const c = comments[0];
+						if (c.type === "Line" && /** @type {Range} */ (c.range)[0] === 0) {
+							if (parser.state.source.slice(0, 2).toString() !== "#!") return;
+							// this is a hashbang comment
+							const dep = new ConstDependency("//", 0);
+							dep.loc = /** @type {DependencyLocation} */ (c.loc);
+							parser.state.module.addPresentationalDependency(dep);
 						}
-					);
+					});
 				};
 
 				normalModuleFactory.hooks.parser
-					.for("javascript/auto")
-					.tap("CompatibilityPlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, handler);
 				normalModuleFactory.hooks.parser
-					.for("javascript/dynamic")
-					.tap("CompatibilityPlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, handler);
 				normalModuleFactory.hooks.parser
-					.for("javascript/esm")
-					.tap("CompatibilityPlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_ESM)
+					.tap(PLUGIN_NAME, handler);
 			}
 		);
 	}

package/lib/Compilation.js

@@ -49,6 +49,7 @@ const ModuleProfile = require("./ModuleProfile");
 const ModuleRestoreError = require("./ModuleRestoreError");
 const ModuleStoreError = require("./ModuleStoreError");
 const ModuleTemplate = require("./ModuleTemplate");
+const { WEBPACK_MODULE_TYPE_RUNTIME } = require("./ModuleTypeConstants");
 const RuntimeGlobals = require("./RuntimeGlobals");
 const RuntimeTemplate = require("./RuntimeTemplate");
 const Stats = require("./Stats");
@@ -61,7 +62,7 @@ const StatsPrinter = require("./stats/StatsPrinter");
 const { equals: arrayEquals } = require("./util/ArrayHelpers");
 const AsyncQueue = require("./util/AsyncQueue");
 const LazySet = require("./util/LazySet");
-const { provide } = require("./util/MapHelpers");
+const { getOrInsert } = require("./util/MapHelpers");
 const WeakTupleMap = require("./util/WeakTupleMap");
 const { cachedCleverMerge } = require("./util/cleverMerge");
 const {
@@ -646,7 +647,12 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
 
 			/** @type {SyncHook<[]>} */
 			beforeChunks: new SyncHook([]),
-			/** @type {SyncHook<[Iterable<Chunk>]>} */
+			/**
+			 * The `afterChunks` hook is called directly after the chunks and module graph have
+			 * been created and before the chunks and modules have been optimized. This hook is useful to
+			 * inspect, analyze, and/or modify the chunk graph.
+			 * @type {SyncHook<[Iterable<Chunk>]>}
+			 */
 			afterChunks: new SyncHook(["chunks"]),
 
 			/** @type {SyncBailHook<[Iterable<Module>]>} */
@@ -675,7 +681,7 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
 			optimizeChunkModules: new AsyncSeriesBailHook(["chunks", "modules"]),
 			/** @type {SyncHook<[Iterable<Chunk>, Iterable<Module>]>} */
 			afterOptimizeChunkModules: new SyncHook(["chunks", "modules"]),
-			/** @type {SyncBailHook<[], boolean>} */
+			/** @type {SyncBailHook<[], boolean | undefined>} */
 			shouldRecord: new SyncBailHook([]),
 
 			/** @type {SyncHook<[Chunk, Set<string>, RuntimeRequirementsContext]>} */
@@ -2578,6 +2584,8 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
 			p.calculate();
 
 			const logger = this.getLogger("webpack.Compilation.ModuleProfile");
+			// Avoid coverage problems due indirect changes
+			/* istanbul ignore next */
 			const logByValue = (value, msg) => {
 				if (value > 1000) {
 					logger.error(msg);
@@ -2618,7 +2626,7 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
 			const logByLoadersSummary = (category, getDuration, getParallelism) => {
 				const map = new Map();
 				for (const [module, profile] of modulesWithProfiles) {
-					const list = provide(
+					const list = getOrInsert(
 						map,
 						module.type + "!" + module.identifier().replace(/(!|^)[^!]*$/, ""),
 						() => []
@@ -3200,6 +3208,7 @@ Or do you want to use the entrypoints '${name}' and '${runtime}' independently o
 		const { chunkGraph, moduleGraph, dependencyTemplates, runtimeTemplate } =
 			this;
 		const results = this.codeGenerationResults;
+		/** @type {WebpackError[]} */
 		const errors = [];
 		/** @type {Set<Module> | undefined} */
 		let notCodeGeneratedModules = undefined;
@@ -3295,7 +3304,7 @@ Or do you want to use the entrypoints '${name}' and '${runtime}' independently o
 	 * @param {RuntimeTemplate} runtimeTemplate runtimeTemplate
 	 * @param {WebpackError[]} errors errors
 	 * @param {CodeGenerationResults} results results
-	 * @param {function(WebpackError=, boolean=): void} callback callback
+	 * @param {function((WebpackError | null)=, boolean=): void} callback callback
 	 */
 	_codeGenerationModule(
 		module,
@@ -5016,13 +5025,13 @@ This prevents using hashes of each other and should be avoided.`);
 									};
 									const interceptModuleExecution = (__webpack_require__[
 										RuntimeGlobals.interceptModuleExecution.replace(
-											"__webpack_require__.",
+											`${RuntimeGlobals.require}.`,
 											""
 										)
 									] = []);
 									const moduleCache = (__webpack_require__[
 										RuntimeGlobals.moduleCache.replace(
-											"__webpack_require__.",
+											`${RuntimeGlobals.require}.`,
 											""
 										)
 									] = {});
@@ -5119,7 +5128,7 @@ This prevents using hashes of each other and should be avoided.`);
 		const usedIds = new Set();
 
 		for (const module of this.modules) {
-			if (module.type === "runtime") continue;
+			if (module.type === WEBPACK_MODULE_TYPE_RUNTIME) continue;
 			const moduleId = chunkGraph.getModuleId(module);
 			if (moduleId === null) continue;
 			if (usedIds.has(moduleId)) {

package/lib/Compiler.js

@@ -126,7 +126,7 @@ class Compiler {
 			/** @type {SyncHook<[]>} */
 			initialize: new SyncHook([]),
 
-			/** @type {SyncBailHook<[Compilation], boolean>} */
+			/** @type {SyncBailHook<[Compilation], boolean | undefined>} */
 			shouldEmit: new SyncBailHook(["compilation"]),
 			/** @type {AsyncSeriesHook<[Stats]>} */
 			done: new AsyncSeriesHook(["stats"]),
@@ -970,10 +970,13 @@ ${other}`);
 	readRecords(callback) {
 		if (this.hooks.readRecords.isUsed()) {
 			if (this.recordsInputPath) {
-				asyncLib.parallel([
-					cb => this.hooks.readRecords.callAsync(cb),
-					this._readRecords.bind(this)
-				]);
+				asyncLib.parallel(
+					[
+						cb => this.hooks.readRecords.callAsync(cb),
+						this._readRecords.bind(this)
+					],
+					err => callback(err)
+				);
 			} else {
 				this.records = {};
 				this.hooks.readRecords.callAsync(callback);
@@ -1008,8 +1011,7 @@ ${other}`);
 				try {
 					this.records = parseJson(content.toString("utf-8"));
 				} catch (e) {
-					e.message = "Cannot parse records: " + e.message;
-					return callback(e);
+					return callback(new Error(`Cannot parse records: ${e.message}`));
 				}
 
 				return callback();
@@ -1071,7 +1073,9 @@ ${other}`);
 		childCompiler.root = this.root;
 		if (Array.isArray(plugins)) {
 			for (const plugin of plugins) {
-				plugin.apply(childCompiler);
+				if (plugin) {
+					plugin.apply(childCompiler);
+				}
 			}
 		}
 		for (const name in this.hooks) {

package/lib/ConcatenationScope.js

@@ -108,7 +108,7 @@ class ConcatenationScope {
 		module,
 		{ ids = undefined, call = false, directImport = false, asiSafe = false }
 	) {
-		const info = this._modulesMap.get(module);
+		const info = /** @type {ModuleInfo} */ (this._modulesMap.get(module));
 		const callFlag = call ? "_call" : "";
 		const directImportFlag = directImport ? "_directImport" : "";
 		const asiSafeFlag = asiSafe
@@ -133,7 +133,7 @@ class ConcatenationScope {
 
 	/**
 	 * @param {string} name the identifier
-	 * @returns {ModuleReferenceOptions & { index: number }} parsed options and index
+	 * @returns {ModuleReferenceOptions & { index: number } | null} parsed options and index
 	 */
 	static matchModuleReference(name) {
 		const match = MODULE_REFERENCE_REGEXP.exec(name);

package/lib/ConditionalInitFragment.js

@@ -14,6 +14,11 @@ const { mergeRuntime } = require("./util/runtime");
 /** @typedef {import("./Generator").GenerateContext} GenerateContext */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
+/**
+ * @param {string} condition condition
+ * @param {string | Source} source source
+ * @returns {string | Source} wrapped source
+ */
 const wrapInCondition = (condition, source) => {
 	if (typeof source === "string") {
 		return Template.asString([
@@ -33,13 +38,14 @@ const wrapInCondition = (condition, source) => {
 
 /**
  * @typedef {GenerateContext} Context
+ * @extends {InitFragment<Context>}
  */
 class ConditionalInitFragment extends InitFragment {
 	/**
 	 * @param {string|Source} content the source code that will be included as initialization code
 	 * @param {number} stage category of initialization code (contribute to order)
 	 * @param {number} position position in the category (contribute to order)
-	 * @param {string} key unique key to avoid emitting the same initialization code twice
+	 * @param {string | undefined} key unique key to avoid emitting the same initialization code twice
 	 * @param {RuntimeSpec | boolean} runtimeCondition in which runtime this fragment should be executed
 	 * @param {string|Source=} endContent the source code that will be included at the end of the module
 	 */
@@ -89,6 +95,10 @@ class ConditionalInitFragment extends InitFragment {
 		return wrapInCondition(expr, this.endContent);
 	}
 
+	/**
+	 * @param {ConditionalInitFragment} other fragment to merge with
+	 * @returns {ConditionalInitFragment} merged fragment
+	 */
 	merge(other) {
 		if (this.runtimeCondition === true) return this;
 		if (other.runtimeCondition === true) return other;