webpack 5.59.0 → 5.94.0

package/lib/dependencies/CommonJsPlugin.js

@@ -24,16 +24,34 @@ const RuntimeRequirementsDependency = require("./RuntimeRequirementsDependency")
 const CommonJsExportsParserPlugin = require("./CommonJsExportsParserPlugin");
 const CommonJsImportsParserPlugin = require("./CommonJsImportsParserPlugin");
 
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC
+} = require("../ModuleTypeConstants");
 const {
 	evaluateToIdentifier,
 	toConstantDependency
 } = require("../javascript/JavascriptParserHelpers");
 const CommonJsExportRequireDependency = require("./CommonJsExportRequireDependency");
 
+/** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
+/** @typedef {import("../Compilation")} Compilation */
+/** @typedef {import("../Compiler")} Compiler */
+/** @typedef {import("../Dependency").DependencyLocation} DependencyLocation */
+/** @typedef {import("../Module").BuildInfo} BuildInfo */
+/** @typedef {import("../javascript/JavascriptParser")} Parser */
+
+const PLUGIN_NAME = "CommonJsPlugin";
+
 class CommonJsPlugin {
+	/**
+	 * Apply the plugin
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.compilation.tap(
-			"CommonJsPlugin",
+			PLUGIN_NAME,
 			(compilation, { contextModuleFactory, normalModuleFactory }) => {
 				compilation.dependencyFactories.set(
 					CommonJsRequireDependency,
@@ -126,21 +144,21 @@ class CommonJsPlugin {
 
 				compilation.hooks.runtimeRequirementInModule
 					.for(RuntimeGlobals.harmonyModuleDecorator)
-					.tap("CommonJsPlugin", (module, set) => {
+					.tap(PLUGIN_NAME, (module, set) => {
 						set.add(RuntimeGlobals.module);
 						set.add(RuntimeGlobals.requireScope);
 					});
 
 				compilation.hooks.runtimeRequirementInModule
 					.for(RuntimeGlobals.nodeModuleDecorator)
-					.tap("CommonJsPlugin", (module, set) => {
+					.tap(PLUGIN_NAME, (module, set) => {
 						set.add(RuntimeGlobals.module);
 						set.add(RuntimeGlobals.requireScope);
 					});
 
 				compilation.hooks.runtimeRequirementInTree
 					.for(RuntimeGlobals.harmonyModuleDecorator)
-					.tap("CommonJsPlugin", (chunk, set) => {
+					.tap(PLUGIN_NAME, (chunk, set) => {
 						compilation.addRuntimeModule(
 							chunk,
 							new HarmonyModuleDecoratorRuntimeModule()
@@ -149,27 +167,32 @@ class CommonJsPlugin {
 
 				compilation.hooks.runtimeRequirementInTree
 					.for(RuntimeGlobals.nodeModuleDecorator)
-					.tap("CommonJsPlugin", (chunk, set) => {
+					.tap(PLUGIN_NAME, (chunk, set) => {
 						compilation.addRuntimeModule(
 							chunk,
 							new NodeModuleDecoratorRuntimeModule()
 						);
 					});
 
+				/**
+				 * @param {Parser} parser parser parser
+				 * @param {JavascriptParserOptions} parserOptions parserOptions
+				 * @returns {void}
+				 */
 				const handler = (parser, parserOptions) => {
 					if (parserOptions.commonjs !== undefined && !parserOptions.commonjs)
 						return;
 					parser.hooks.typeof
 						.for("module")
 						.tap(
-							"CommonJsPlugin",
+							PLUGIN_NAME,
 							toConstantDependency(parser, JSON.stringify("object"))
 						);
 
 					parser.hooks.expression
 						.for("require.main")
 						.tap(
-							"CommonJsPlugin",
+							PLUGIN_NAME,
 							toConstantDependency(
 								parser,
 								`${RuntimeGlobals.moduleCache}[${RuntimeGlobals.entryModuleId}]`,
@@ -177,33 +200,35 @@ class CommonJsPlugin {
 							)
 						);
 					parser.hooks.expression
-						.for("module.loaded")
-						.tap("CommonJsPlugin", expr => {
-							parser.state.module.buildInfo.moduleConcatenationBailout =
-								"module.loaded";
+						.for(RuntimeGlobals.moduleLoaded)
+						.tap(PLUGIN_NAME, expr => {
+							/** @type {BuildInfo} */
+							(parser.state.module.buildInfo).moduleConcatenationBailout =
+								RuntimeGlobals.moduleLoaded;
 							const dep = new RuntimeRequirementsDependency([
 								RuntimeGlobals.moduleLoaded
 							]);
-							dep.loc = expr.loc;
+							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 							parser.state.module.addPresentationalDependency(dep);
 							return true;
 						});
 
 					parser.hooks.expression
-						.for("module.id")
-						.tap("CommonJsPlugin", expr => {
-							parser.state.module.buildInfo.moduleConcatenationBailout =
-								"module.id";
+						.for(RuntimeGlobals.moduleId)
+						.tap(PLUGIN_NAME, expr => {
+							/** @type {BuildInfo} */
+							(parser.state.module.buildInfo).moduleConcatenationBailout =
+								RuntimeGlobals.moduleId;
 							const dep = new RuntimeRequirementsDependency([
 								RuntimeGlobals.moduleId
 							]);
-							dep.loc = expr.loc;
+							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
 							parser.state.module.addPresentationalDependency(dep);
 							return true;
 						});
 
 					parser.hooks.evaluateIdentifier.for("module.hot").tap(
-						"CommonJsPlugin",
+						PLUGIN_NAME,
 						evaluateToIdentifier("module.hot", "module", () => ["hot"], null)
 					);
 
@@ -214,11 +239,11 @@ class CommonJsPlugin {
 				};
 
 				normalModuleFactory.hooks.parser
-					.for("javascript/auto")
-					.tap("CommonJsPlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, handler);
 				normalModuleFactory.hooks.parser
-					.for("javascript/dynamic")
-					.tap("CommonJsPlugin", handler);
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, handler);
 			}
 		);
 	}
@@ -230,10 +255,10 @@ class HarmonyModuleDecoratorRuntimeModule extends RuntimeModule {
 	}
 
 	/**
-	 * @returns {string} runtime code
+	 * @returns {string | null} runtime code
 	 */
 	generate() {
-		const { runtimeTemplate } = this.compilation;
+		const { runtimeTemplate } = /** @type {Compilation} */ (this.compilation);
 		return Template.asString([
 			`${
 				RuntimeGlobals.harmonyModuleDecorator
@@ -260,10 +285,10 @@ class NodeModuleDecoratorRuntimeModule extends RuntimeModule {
 	}
 
 	/**
-	 * @returns {string} runtime code
+	 * @returns {string | null} runtime code
 	 */
 	generate() {
-		const { runtimeTemplate } = this.compilation;
+		const { runtimeTemplate } = /** @type {Compilation} */ (this.compilation);
 		return Template.asString([
 			`${RuntimeGlobals.nodeModuleDecorator} = ${runtimeTemplate.basicFunction(
 				"module",

package/lib/dependencies/CommonJsRequireContextDependency.js

@@ -9,32 +9,53 @@ const makeSerializable = require("../util/makeSerializable");
 const ContextDependency = require("./ContextDependency");
 const ContextDependencyTemplateAsRequireCall = require("./ContextDependencyTemplateAsRequireCall");
 
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
+
 class CommonJsRequireContextDependency extends ContextDependency {
-	constructor(options, range, valueRange) {
-		super(options);
+	/**
+	 * @param {TODO} options options for the context module
+	 * @param {Range} range location in source code
+	 * @param {Range | undefined} valueRange location of the require call
+	 * @param {boolean | string } inShorthand true or name
+	 * @param {string} context context
+	 */
+	constructor(options, range, valueRange, inShorthand, context) {
+		super(options, context);
 
 		this.range = range;
 		this.valueRange = valueRange;
+		// inShorthand must be serialized by subclasses that use it
+		this.inShorthand = inShorthand;
 	}
 
 	get type() {
 		return "cjs require context";
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 
 		write(this.range);
 		write(this.valueRange);
+		write(this.inShorthand);
 
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 
 		this.range = read();
 		this.valueRange = read();
+		this.inShorthand = read();
 
 		super.deserialize(context);
 	}

package/lib/dependencies/CommonJsRequireDependency.js

@@ -9,10 +9,18 @@ const makeSerializable = require("../util/makeSerializable");
 const ModuleDependency = require("./ModuleDependency");
 const ModuleDependencyTemplateAsId = require("./ModuleDependencyTemplateAsId");
 
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+
 class CommonJsRequireDependency extends ModuleDependency {
-	constructor(request, range) {
+	/**
+	 * @param {string} request request
+	 * @param {Range=} range location in source code
+	 * @param {string=} context request context
+	 */
+	constructor(request, range, context) {
 		super(request);
 		this.range = range;
+		this._context = context;
 	}
 
 	get type() {

package/lib/dependencies/CommonJsSelfReferenceDependency.js

@@ -17,9 +17,19 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("../Dependency").ReferencedExport} ReferencedExport */
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
+/** @typedef {import("./CommonJsDependencyHelpers").CommonJSDependencyBaseKeywords} CommonJSDependencyBaseKeywords */
 
 class CommonJsSelfReferenceDependency extends NullDependency {
+	/**
+	 * @param {Range} range range
+	 * @param {CommonJSDependencyBaseKeywords} base base
+	 * @param {string[]} names names
+	 * @param {boolean} call is a call
+	 */
 	constructor(range, base, names, call) {
 		super();
 		this.range = range;
@@ -40,7 +50,7 @@ class CommonJsSelfReferenceDependency extends NullDependency {
 	 * @returns {string | null} an identifier to merge equal requests
 	 */
 	getResourceIdentifier() {
-		return `self`;
+		return "self";
 	}
 
 	/**
@@ -53,6 +63,9 @@ class CommonJsSelfReferenceDependency extends NullDependency {
 		return [this.call ? this.names.slice(0, -1) : this.names];
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.range);
@@ -62,6 +75,9 @@ class CommonJsSelfReferenceDependency extends NullDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 		this.range = read();
@@ -92,19 +108,17 @@ CommonJsSelfReferenceDependency.Template = class CommonJsSelfReferenceDependency
 		{ module, moduleGraph, runtime, runtimeRequirements }
 	) {
 		const dep = /** @type {CommonJsSelfReferenceDependency} */ (dependency);
-		let used;
-		if (dep.names.length === 0) {
-			used = dep.names;
-		} else {
-			used = moduleGraph.getExportsInfo(module).getUsedName(dep.names, runtime);
-		}
+		const used =
+			dep.names.length === 0
+				? dep.names
+				: moduleGraph.getExportsInfo(module).getUsedName(dep.names, runtime);
 		if (!used) {
 			throw new Error(
 				"Self-reference dependency has unused export name: This should not happen"
 			);
 		}
 
-		let base = undefined;
+		let base;
 		switch (dep.base) {
 			case "exports":
 				runtimeRequirements.add(RuntimeGlobals.exports);

package/lib/dependencies/ConstDependency.js

@@ -15,13 +15,16 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
 /** @typedef {import("../ModuleGraphConnection").ConnectionState} ConnectionState */
+/** @typedef {import("../javascript/JavascriptParser").Range} Range */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("../util/Hash")} Hash */
 
 class ConstDependency extends NullDependency {
 	/**
 	 * @param {string} expression the expression
-	 * @param {number|[number, number]} range the source range
-	 * @param {string[]=} runtimeRequirements runtime requirements
+	 * @param {number | Range} range the source range
+	 * @param {(string[] | null)=} runtimeRequirements runtime requirements
 	 */
 	constructor(expression, range, runtimeRequirements) {
 		super();
@@ -41,7 +44,7 @@ class ConstDependency extends NullDependency {
 	 */
 	updateHash(hash, context) {
 		if (this._hashUpdate === undefined) {
-			let hashUpdate = "" + this.range + "|" + this.expression;
+			let hashUpdate = `${this.range}|${this.expression}`;
 			if (this.runtimeRequirements) {
 				for (const item of this.runtimeRequirements) {
 					hashUpdate += "|";
@@ -61,6 +64,9 @@ class ConstDependency extends NullDependency {
 		return false;
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.expression);
@@ -69,6 +75,9 @@ class ConstDependency extends NullDependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 		this.expression = read();

package/lib/dependencies/ContextDependency.js

@@ -14,6 +14,8 @@ const memoize = require("../util/memoize");
 /** @typedef {import("../Dependency").TRANSITIVE} TRANSITIVE */
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
 /** @typedef {import("../WebpackError")} WebpackError */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 const getCriticalDependencyWarning = memoize(() =>
 	require("./CriticalDependencyWarning")
@@ -21,18 +23,23 @@ const getCriticalDependencyWarning = memoize(() =>
 
 /** @typedef {ContextOptions & { request: string }} ContextDependencyOptions */
 
-const regExpToString = r => (r ? r + "" : "");
+/**
+ * @param {RegExp | null | undefined} r regexp
+ * @returns {string} stringified regexp
+ */
+const regExpToString = r => (r ? String(r) : "");
 
 class ContextDependency extends Dependency {
 	/**
 	 * @param {ContextDependencyOptions} options options for the context module
+	 * @param {string=} context request context
 	 */
-	constructor(options) {
+	constructor(options, context) {
 		super();
 
 		this.options = options;
 		this.userRequest = this.options && this.options.request;
-		/** @type {false | string} */
+		/** @type {false | undefined | string} */
 		this.critical = false;
 		this.hadGlobalOrStickyRegExp = false;
 
@@ -47,8 +54,18 @@ class ContextDependency extends Dependency {
 		this.request = undefined;
 		this.range = undefined;
 		this.valueRange = undefined;
+		/** @type {boolean | string | undefined} */
+		this.inShorthand = undefined;
 		// TODO refactor this
 		this.replaces = undefined;
+		this._requestContext = context;
+	}
+
+	/**
+	 * @returns {string | undefined} a request context
+	 */
+	getContext() {
+		return this._requestContext;
 	}
 
 	get category() {
@@ -67,7 +84,9 @@ class ContextDependency extends Dependency {
 	 */
 	getResourceIdentifier() {
 		return (
-			`context${this.options.request} ${this.options.recursive} ` +
+			`context${this._requestContext || ""}|ctx request${
+				this.options.request
+			} ${this.options.recursive} ` +
 			`${regExpToString(this.options.regExp)} ${regExpToString(
 				this.options.include
 			)} ${regExpToString(this.options.exclude)} ` +
@@ -79,7 +98,7 @@ class ContextDependency extends Dependency {
 	/**
 	 * Returns warnings
 	 * @param {ModuleGraph} moduleGraph module graph
-	 * @returns {WebpackError[]} warnings
+	 * @returns {WebpackError[] | null | undefined} warnings
 	 */
 	getWarnings(moduleGraph) {
 		let warnings = super.getWarnings(moduleGraph);
@@ -103,6 +122,9 @@ class ContextDependency extends Dependency {
 		return warnings;
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 
@@ -111,6 +133,7 @@ class ContextDependency extends Dependency {
 		write(this.critical);
 		write(this.hadGlobalOrStickyRegExp);
 		write(this.request);
+		write(this._requestContext);
 		write(this.range);
 		write(this.valueRange);
 		write(this.prepend);
@@ -119,6 +142,9 @@ class ContextDependency extends Dependency {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 
@@ -127,6 +153,7 @@ class ContextDependency extends Dependency {
 		this.critical = read();
 		this.hadGlobalOrStickyRegExp = read();
 		this.request = read();
+		this._requestContext = read();
 		this.range = read();
 		this.valueRange = read();
 		this.prepend = read();