webpack 5.71.0 → 5.73.0

package/lib/dependencies/CommonJsImportsParserPlugin.js

@@ -5,9 +5,12 @@
 
 "use strict";
 
+const { fileURLToPath } = require("url");
 const CommentCompilationWarning = require("../CommentCompilationWarning");
 const RuntimeGlobals = require("../RuntimeGlobals");
 const UnsupportedFeatureWarning = require("../UnsupportedFeatureWarning");
+const WebpackError = require("../WebpackError");
+const BasicEvaluatedExpression = require("../javascript/BasicEvaluatedExpression");
 const {
 	evaluateToIdentifier,
 	evaluateToString,
@@ -26,8 +29,12 @@ const RequireResolveContextDependency = require("./RequireResolveContextDependen
 const RequireResolveDependency = require("./RequireResolveDependency");
 const RequireResolveHeaderDependency = require("./RequireResolveHeaderDependency");
 
+/** @typedef {import("estree").CallExpression} CallExpressionNode */
 /** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
 
+const createRequireSpecifierTag = Symbol("createRequire");
+const createdRequireIdentifierTag = Symbol("createRequire()");
+
 class CommonJsImportsParserPlugin {
 	/**
 	 * @param {JavascriptParserOptions} options parser options
@@ -39,51 +46,72 @@ class CommonJsImportsParserPlugin {
 	apply(parser) {
 		const options = this.options;
 
-		// metadata //
+		const getContext = () => {
+			if (parser.currentTagData) {
+				const { context } = parser.currentTagData;
+				return context;
+			}
+		};
+
+		//#region metadata
 		const tapRequireExpression = (expression, getMembers) => {
 			parser.hooks.typeof
 				.for(expression)
 				.tap(
-					"CommonJsPlugin",
+					"CommonJsImportsParserPlugin",
 					toConstantDependency(parser, JSON.stringify("function"))
 				);
 			parser.hooks.evaluateTypeof
 				.for(expression)
-				.tap("CommonJsPlugin", evaluateToString("function"));
+				.tap("CommonJsImportsParserPlugin", evaluateToString("function"));
 			parser.hooks.evaluateIdentifier
 				.for(expression)
 				.tap(
-					"CommonJsPlugin",
+					"CommonJsImportsParserPlugin",
 					evaluateToIdentifier(expression, "require", getMembers, true)
 				);
 		};
+		const tapRequireExpressionTag = tag => {
+			parser.hooks.typeof
+				.for(tag)
+				.tap(
+					"CommonJsImportsParserPlugin",
+					toConstantDependency(parser, JSON.stringify("function"))
+				);
+			parser.hooks.evaluateTypeof
+				.for(tag)
+				.tap("CommonJsImportsParserPlugin", evaluateToString("function"));
+		};
 		tapRequireExpression("require", () => []);
 		tapRequireExpression("require.resolve", () => ["resolve"]);
 		tapRequireExpression("require.resolveWeak", () => ["resolveWeak"]);
+		//#endregion
 
 		// Weird stuff //
-		parser.hooks.assign.for("require").tap("CommonJsPlugin", expr => {
-			// to not leak to global "require", we need to define a local require here.
-			const dep = new ConstDependency("var require;", 0);
-			dep.loc = expr.loc;
-			parser.state.module.addPresentationalDependency(dep);
-			return true;
-		});
+		parser.hooks.assign
+			.for("require")
+			.tap("CommonJsImportsParserPlugin", expr => {
+				// to not leak to global "require", we need to define a local require here.
+				const dep = new ConstDependency("var require;", 0);
+				dep.loc = expr.loc;
+				parser.state.module.addPresentationalDependency(dep);
+				return true;
+			});
 
-		// Unsupported //
+		//#region Unsupported
 		parser.hooks.expression
-			.for("require.main.require")
+			.for("require.main")
 			.tap(
-				"CommonJsPlugin",
+				"CommonJsImportsParserPlugin",
 				expressionIsUnsupported(
 					parser,
-					"require.main.require is not supported by webpack."
+					"require.main is not supported by webpack."
 				)
 			);
 		parser.hooks.call
 			.for("require.main.require")
 			.tap(
-				"CommonJsPlugin",
+				"CommonJsImportsParserPlugin",
 				expressionIsUnsupported(
 					parser,
 					"require.main.require is not supported by webpack."
@@ -92,7 +120,7 @@ class CommonJsImportsParserPlugin {
 		parser.hooks.expression
 			.for("module.parent.require")
 			.tap(
-				"CommonJsPlugin",
+				"CommonJsImportsParserPlugin",
 				expressionIsUnsupported(
 					parser,
 					"module.parent.require is not supported by webpack."
@@ -101,63 +129,81 @@ class CommonJsImportsParserPlugin {
 		parser.hooks.call
 			.for("module.parent.require")
 			.tap(
-				"CommonJsPlugin",
+				"CommonJsImportsParserPlugin",
 				expressionIsUnsupported(
 					parser,
 					"module.parent.require is not supported by webpack."
 				)
 			);
+		//#endregion
 
-		// renaming //
-		parser.hooks.canRename.for("require").tap("CommonJsPlugin", () => true);
-		parser.hooks.rename.for("require").tap("CommonJsPlugin", expr => {
+		//#region Renaming
+		const defineUndefined = expr => {
 			// To avoid "not defined" error, replace the value with undefined
 			const dep = new ConstDependency("undefined", expr.range);
 			dep.loc = expr.loc;
 			parser.state.module.addPresentationalDependency(dep);
 			return false;
-		});
+		};
+		parser.hooks.canRename
+			.for("require")
+			.tap("CommonJsImportsParserPlugin", () => true);
+		parser.hooks.rename
+			.for("require")
+			.tap("CommonJsImportsParserPlugin", defineUndefined);
+		//#endregion
+
+		//#region Inspection
+		const requireCache = toConstantDependency(
+			parser,
+			RuntimeGlobals.moduleCache,
+			[
+				RuntimeGlobals.moduleCache,
+				RuntimeGlobals.moduleId,
+				RuntimeGlobals.moduleLoaded
+			]
+		);
 
-		// inspection //
 		parser.hooks.expression
 			.for("require.cache")
-			.tap(
-				"CommonJsImportsParserPlugin",
-				toConstantDependency(parser, RuntimeGlobals.moduleCache, [
-					RuntimeGlobals.moduleCache,
-					RuntimeGlobals.moduleId,
-					RuntimeGlobals.moduleLoaded
-				])
-			);
+			.tap("CommonJsImportsParserPlugin", requireCache);
+		//#endregion
 
-		// require as expression //
+		//#region Require as expression
+		const requireAsExpressionHandler = expr => {
+			const dep = new CommonJsRequireContextDependency(
+				{
+					request: options.unknownContextRequest,
+					recursive: options.unknownContextRecursive,
+					regExp: options.unknownContextRegExp,
+					mode: "sync"
+				},
+				expr.range,
+				undefined,
+				parser.scope.inShorthand,
+				getContext()
+			);
+			dep.critical =
+				options.unknownContextCritical &&
+				"require function is used in a way in which dependencies cannot be statically extracted";
+			dep.loc = expr.loc;
+			dep.optional = !!parser.scope.inTry;
+			parser.state.current.addDependency(dep);
+			return true;
+		};
 		parser.hooks.expression
 			.for("require")
-			.tap("CommonJsImportsParserPlugin", expr => {
-				const dep = new CommonJsRequireContextDependency(
-					{
-						request: options.unknownContextRequest,
-						recursive: options.unknownContextRecursive,
-						regExp: options.unknownContextRegExp,
-						mode: "sync"
-					},
-					expr.range,
-					undefined,
-					parser.scope.inShorthand
-				);
-				dep.critical =
-					options.unknownContextCritical &&
-					"require function is used in a way in which dependencies cannot be statically extracted";
-				dep.loc = expr.loc;
-				dep.optional = !!parser.scope.inTry;
-				parser.state.current.addDependency(dep);
-				return true;
-			});
+			.tap("CommonJsImportsParserPlugin", requireAsExpressionHandler);
+		//#endregion
 
-		// require //
+		//#region Require
 		const processRequireItem = (expr, param) => {
 			if (param.isString()) {
-				const dep = new CommonJsRequireDependency(param.string, param.range);
+				const dep = new CommonJsRequireDependency(
+					param.string,
+					param.range,
+					getContext()
+				);
 				dep.loc = expr.loc;
 				dep.optional = !!parser.scope.inTry;
 				parser.state.current.addDependency(dep);
@@ -174,7 +220,9 @@ class CommonJsImportsParserPlugin {
 				{
 					category: "commonjs"
 				},
-				parser
+				parser,
+				undefined,
+				getContext()
 			);
 			if (!dep) return;
 			dep.loc = expr.loc;
@@ -268,8 +316,9 @@ class CommonJsImportsParserPlugin {
 		parser.hooks.new
 			.for("module.require")
 			.tap("CommonJsImportsParserPlugin", createRequireHandler(true));
+		//#endregion
 
-		// require with property access //
+		//#region Require with property access
 		const chainHandler = (expr, calleeMembers, callExpr, members) => {
 			if (callExpr.arguments.length !== 1) return;
 			const param = parser.evaluateExpression(callExpr.arguments[0]);
@@ -316,8 +365,9 @@ class CommonJsImportsParserPlugin {
 		parser.hooks.callMemberChainOfCallMemberChain
 			.for("module.require")
 			.tap("CommonJsImportsParserPlugin", callChainHandler);
+		//#endregion
 
-		// require.resolve //
+		//#region Require.resolve
 		const processResolve = (expr, weak) => {
 			if (expr.arguments.length !== 1) return;
 			const param = parser.evaluateExpression(expr.arguments[0]);
@@ -345,7 +395,11 @@ class CommonJsImportsParserPlugin {
 		};
 		const processResolveItem = (expr, param, weak) => {
 			if (param.isString()) {
-				const dep = new RequireResolveDependency(param.string, param.range);
+				const dep = new RequireResolveDependency(
+					param.string,
+					param.range,
+					getContext()
+				);
 				dep.loc = expr.loc;
 				dep.optional = !!parser.scope.inTry;
 				dep.weak = weak;
@@ -364,7 +418,8 @@ class CommonJsImportsParserPlugin {
 					category: "commonjs",
 					mode: weak ? "weak" : "sync"
 				},
-				parser
+				parser,
+				getContext()
 			);
 			if (!dep) return;
 			dep.loc = expr.loc;
@@ -375,14 +430,240 @@ class CommonJsImportsParserPlugin {
 
 		parser.hooks.call
 			.for("require.resolve")
-			.tap("RequireResolveDependencyParserPlugin", expr => {
+			.tap("CommonJsImportsParserPlugin", expr => {
 				return processResolve(expr, false);
 			});
 		parser.hooks.call
 			.for("require.resolveWeak")
-			.tap("RequireResolveDependencyParserPlugin", expr => {
+			.tap("CommonJsImportsParserPlugin", expr => {
 				return processResolve(expr, true);
 			});
+		//#endregion
+
+		//#region Create require
+
+		if (!options.createRequire) return;
+
+		let moduleName;
+		let specifierName;
+
+		if (options.createRequire === true) {
+			moduleName = "module";
+			specifierName = "createRequire";
+		} else {
+			const match = /^(.*) from (.*)$/.exec(options.createRequire);
+			if (match) {
+				[, specifierName, moduleName] = match;
+			}
+			if (!specifierName || !moduleName) {
+				const err = new WebpackError(
+					`Parsing javascript parser option "createRequire" failed, got ${JSON.stringify(
+						options.createRequire
+					)}`
+				);
+				err.details =
+					'Expected string in format "createRequire from module", where "createRequire" is specifier name and "module" name of the module';
+				throw err;
+			}
+		}
+
+		tapRequireExpressionTag(createdRequireIdentifierTag);
+		tapRequireExpressionTag(createRequireSpecifierTag);
+		parser.hooks.evaluateCallExpression
+			.for(createRequireSpecifierTag)
+			.tap("CommonJsImportsParserPlugin", expr => {
+				const context = parseCreateRequireArguments(expr);
+				if (context === undefined) return;
+				const ident = parser.evaluatedVariable({
+					tag: createdRequireIdentifierTag,
+					data: { context },
+					next: undefined
+				});
+				return new BasicEvaluatedExpression()
+					.setIdentifier(ident, ident, () => [])
+					.setSideEffects(false)
+					.setRange(expr.range);
+			});
+		parser.hooks.unhandledExpressionMemberChain
+			.for(createdRequireIdentifierTag)
+			.tap("CommonJsImportsParserPlugin", (expr, members) => {
+				return expressionIsUnsupported(
+					parser,
+					`createRequire().${members.join(".")} is not supported by webpack.`
+				)(expr);
+			});
+		parser.hooks.canRename
+			.for(createdRequireIdentifierTag)
+			.tap("CommonJsImportsParserPlugin", () => true);
+		parser.hooks.canRename
+			.for(createRequireSpecifierTag)
+			.tap("CommonJsImportsParserPlugin", () => true);
+		parser.hooks.rename
+			.for(createRequireSpecifierTag)
+			.tap("CommonJsImportsParserPlugin", defineUndefined);
+		parser.hooks.expression
+			.for(createdRequireIdentifierTag)
+			.tap("CommonJsImportsParserPlugin", requireAsExpressionHandler);
+		parser.hooks.call
+			.for(createdRequireIdentifierTag)
+			.tap("CommonJsImportsParserPlugin", createRequireHandler(false));
+		/**
+		 * @param {CallExpressionNode} expr call expression
+		 * @returns {string} context
+		 */
+		const parseCreateRequireArguments = expr => {
+			const args = expr.arguments;
+			if (args.length !== 1) {
+				const err = new WebpackError(
+					"module.createRequire supports only one argument."
+				);
+				err.loc = expr.loc;
+				parser.state.module.addWarning(err);
+				return;
+			}
+			const arg = args[0];
+			const evaluated = parser.evaluateExpression(arg);
+			if (!evaluated.isString()) {
+				const err = new WebpackError(
+					"module.createRequire failed parsing argument."
+				);
+				err.loc = arg.loc;
+				parser.state.module.addWarning(err);
+				return;
+			}
+			const ctx = evaluated.string.startsWith("file://")
+				? fileURLToPath(evaluated.string)
+				: evaluated.string;
+			// argument always should be a filename
+			return ctx.slice(0, ctx.lastIndexOf(ctx.startsWith("/") ? "/" : "\\"));
+		};
+
+		parser.hooks.import.tap(
+			{
+				name: "CommonJsImportsParserPlugin",
+				stage: -10
+			},
+			(statement, source) => {
+				if (
+					source !== moduleName ||
+					statement.specifiers.length !== 1 ||
+					statement.specifiers[0].type !== "ImportSpecifier" ||
+					statement.specifiers[0].imported.type !== "Identifier" ||
+					statement.specifiers[0].imported.name !== specifierName
+				)
+					return;
+				// clear for 'import { createRequire as x } from "module"'
+				// if any other specifier was used import module
+				const clearDep = new ConstDependency(
+					parser.isAsiPosition(statement.range[0]) ? ";" : "",
+					statement.range
+				);
+				clearDep.loc = statement.loc;
+				parser.state.module.addPresentationalDependency(clearDep);
+				parser.unsetAsiPosition(statement.range[1]);
+				return true;
+			}
+		);
+		parser.hooks.importSpecifier.tap(
+			{
+				name: "CommonJsImportsParserPlugin",
+				stage: -10
+			},
+			(statement, source, id, name) => {
+				if (source !== moduleName || id !== specifierName) return;
+				parser.tagVariable(name, createRequireSpecifierTag);
+				return true;
+			}
+		);
+		parser.hooks.preDeclarator.tap(
+			"CommonJsImportsParserPlugin",
+			declarator => {
+				if (
+					declarator.id.type !== "Identifier" ||
+					!declarator.init ||
+					declarator.init.type !== "CallExpression" ||
+					declarator.init.callee.type !== "Identifier"
+				)
+					return;
+				const variableInfo = parser.getVariableInfo(
+					declarator.init.callee.name
+				);
+				if (
+					variableInfo &&
+					variableInfo.tagInfo &&
+					variableInfo.tagInfo.tag === createRequireSpecifierTag
+				) {
+					const context = parseCreateRequireArguments(declarator.init);
+					if (context === undefined) return;
+					parser.tagVariable(declarator.id.name, createdRequireIdentifierTag, {
+						name: declarator.id.name,
+						context
+					});
+					return true;
+				}
+			}
+		);
+
+		parser.hooks.memberChainOfCallMemberChain
+			.for(createRequireSpecifierTag)
+			.tap(
+				"CommonJsImportsParserPlugin",
+				(expr, calleeMembers, callExpr, members) => {
+					if (
+						calleeMembers.length !== 0 ||
+						members.length !== 1 ||
+						members[0] !== "cache"
+					)
+						return;
+					// createRequire().cache
+					const context = parseCreateRequireArguments(callExpr);
+					if (context === undefined) return;
+					return requireCache(expr);
+				}
+			);
+		parser.hooks.callMemberChainOfCallMemberChain
+			.for(createRequireSpecifierTag)
+			.tap(
+				"CommonJsImportsParserPlugin",
+				(expr, calleeMembers, innerCallExpression, members) => {
+					if (
+						calleeMembers.length !== 0 ||
+						members.length !== 1 ||
+						members[0] !== "resolve"
+					)
+						return;
+					// createRequire().resolve()
+					return processResolve(expr, false);
+				}
+			);
+		parser.hooks.expressionMemberChain
+			.for(createdRequireIdentifierTag)
+			.tap("CommonJsImportsParserPlugin", (expr, members) => {
+				// require.cache
+				if (members.length === 1 && members[0] === "cache") {
+					return requireCache(expr);
+				}
+			});
+		parser.hooks.callMemberChain
+			.for(createdRequireIdentifierTag)
+			.tap("CommonJsImportsParserPlugin", (expr, members) => {
+				// require.resolve()
+				if (members.length === 1 && members[0] === "resolve") {
+					return processResolve(expr, false);
+				}
+			});
+		parser.hooks.call
+			.for(createRequireSpecifierTag)
+			.tap("CommonJsImportsParserPlugin", expr => {
+				const clearDep = new ConstDependency(
+					"/* createRequire() */ undefined",
+					expr.range
+				);
+				clearDep.loc = expr.loc;
+				parser.state.module.addPresentationalDependency(clearDep);
+				return true;
+			});
+		//#endregion
 	}
 }
 module.exports = CommonJsImportsParserPlugin;

package/lib/dependencies/CommonJsRequireContextDependency.js

@@ -10,8 +10,8 @@ const ContextDependency = require("./ContextDependency");
 const ContextDependencyTemplateAsRequireCall = require("./ContextDependencyTemplateAsRequireCall");
 
 class CommonJsRequireContextDependency extends ContextDependency {
-	constructor(options, range, valueRange, inShorthand) {
-		super(options);
+	constructor(options, range, valueRange, inShorthand, context) {
+		super(options, context);
 
 		this.range = range;
 		this.valueRange = valueRange;

package/lib/dependencies/CommonJsRequireDependency.js

@@ -10,9 +10,10 @@ const ModuleDependency = require("./ModuleDependency");
 const ModuleDependencyTemplateAsId = require("./ModuleDependencyTemplateAsId");
 
 class CommonJsRequireDependency extends ModuleDependency {
-	constructor(request, range) {
+	constructor(request, range, context) {
 		super(request);
 		this.range = range;
+		this._context = context;
 	}
 
 	get type() {

package/lib/dependencies/ContextDependency.js

@@ -26,8 +26,9 @@ const regExpToString = r => (r ? 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;
@@ -50,6 +51,14 @@ class ContextDependency extends Dependency {
 		this.inShorthand = undefined;
 		// TODO refactor this
 		this.replaces = undefined;
+		this._requestContext = context;
+	}
+
+	/**
+	 * @returns {string | undefined} a request context
+	 */
+	getContext() {
+		return this._requestContext;
 	}
 
 	get category() {
@@ -68,7 +77,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)} ` +
@@ -112,6 +123,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);
@@ -128,6 +140,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();

package/lib/dependencies/ContextDependencyHelpers.js

@@ -39,7 +39,7 @@ const splitContextFromPrefix = prefix => {
 
 /** @typedef {Partial<Omit<ContextDependencyOptions, "resource">>} PartialContextDependencyOptions */
 
-/** @typedef {{ new(options: ContextDependencyOptions, range: [number, number], valueRange: [number, number]): ContextDependency }} ContextDependencyConstructor */
+/** @typedef {{ new(options: ContextDependencyOptions, range: [number, number], valueRange: [number, number], ...args: any[]): ContextDependency }} ContextDependencyConstructor */
 
 /**
  * @param {ContextDependencyConstructor} Dep the Dependency class
@@ -49,9 +49,19 @@ const splitContextFromPrefix = prefix => {
  * @param {Pick<JavascriptParserOptions, `${"expr"|"wrapped"}Context${"Critical"|"Recursive"|"RegExp"}` | "exprContextRequest">} options options for context creation
  * @param {PartialContextDependencyOptions} contextOptions options for the ContextModule
  * @param {JavascriptParser} parser the parser
+ * @param {...any} depArgs depArgs
  * @returns {ContextDependency} the created Dependency
  */
-exports.create = (Dep, range, param, expr, options, contextOptions, parser) => {
+exports.create = (
+	Dep,
+	range,
+	param,
+	expr,
+	options,
+	contextOptions,
+	parser,
+	...depArgs
+) => {
 	if (param.isTemplateString()) {
 		let prefixRaw = param.quasis[0].string;
 		let postfixRaw =
@@ -97,7 +107,8 @@ exports.create = (Dep, range, param, expr, options, contextOptions, parser) => {
 				...contextOptions
 			},
 			range,
-			valueRange
+			valueRange,
+			...depArgs
 		);
 		dep.loc = expr.loc;
 		const replaces = [];
@@ -180,7 +191,8 @@ exports.create = (Dep, range, param, expr, options, contextOptions, parser) => {
 				...contextOptions
 			},
 			range,
-			valueRange
+			valueRange,
+			...depArgs
 		);
 		dep.loc = expr.loc;
 		const replaces = [];
@@ -218,7 +230,8 @@ exports.create = (Dep, range, param, expr, options, contextOptions, parser) => {
 				...contextOptions
 			},
 			range,
-			param.range
+			param.range,
+			...depArgs
 		);
 		dep.loc = expr.loc;
 		dep.critical =