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

package/lib/dependencies/CommonJsExportRequireDependency.js

@@ -11,7 +11,12 @@ const Template = require("../Template");
 const { equals } = require("../util/ArrayHelpers");
 const makeSerializable = require("../util/makeSerializable");
 const { propertyAccess } = require("../util/property");
-const { handleDependencyBase } = require("./CommonJsDependencyHelpers");
+const {
+	ESM_MODULE_EXPORTS_NAME,
+	getRequireEsmModuleExportsAccess,
+	handleDependencyBase,
+	isRequireEsmModuleExportsModule
+} = require("./CommonJsDependencyHelpers");
 const ModuleDependency = require("./ModuleDependency");
 const processExportInfo = require("./processExportInfo");
 
@@ -27,10 +32,10 @@ const processExportInfo = require("./processExportInfo");
 /** @typedef {import("../Module")} Module */
 /** @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 */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext<[undefined | boolean, Range, Range | null, CommonJSDependencyBaseKeywords, ExportInfoName[], ExportInfoName[], boolean, boolean]>} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext<[undefined | boolean, Range, Range | null, CommonJSDependencyBaseKeywords, ExportInfoName[], ExportInfoName[], boolean, boolean]>} ObjectSerializerContext */
 
 const idsSymbol = /** @type {symbol} */ (
 	Symbol("CommonJsExportRequireDependency.ids")
@@ -43,6 +48,7 @@ const EMPTY_OBJECT = {};
 
 class CommonJsExportRequireDependency extends ModuleDependency {
 	/**
+	 * Creates an instance of CommonJsExportRequireDependency.
 	 * @param {Range} range range
 	 * @param {Range | null} valueRange value range
 	 * @param {CommonJSDependencyBaseKeywords} base base
@@ -55,12 +61,20 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 		super(request);
 		this.range = range;
 		this.valueRange = valueRange;
+		/** @type {CommonJSDependencyBaseKeywords} */
 		this.base = base;
+		/** @type {string[]} */
 		this.names = names;
+		/** @type {string[]} */
 		this.ids = ids;
+		/** @type {boolean} */
 		this.resultUsed = resultUsed;
 		/** @type {undefined | boolean} */
 		this.asiSafe = undefined;
+		// true when the reexport is a lazy `{ get: () => require(...) }` accessor
+		// (as produced by `Object.defineProperty`) rather than an eager value.
+		/** @type {boolean} */
+		this.getter = false;
 	}
 
 	get type() {
@@ -72,6 +86,7 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Could affect referencing module.
 	 * @returns {boolean | TRANSITIVE} true, when changes to the referenced module could affect the referencing module; TRANSITIVE, when changes to the referenced module could affect referencing modules of the referencing module
 	 */
 	couldAffectReferencingModule() {
@@ -79,6 +94,7 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Returns the imported id.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {ExportInfoName[]} the imported id
 	 */
@@ -87,6 +103,7 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Updates ids using the provided module graph.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ExportInfoName[]} ids the imported ids
 	 * @returns {void}
@@ -103,6 +120,16 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	 */
 	getReferencedExports(moduleGraph, runtime) {
 		const ids = this.getIds(moduleGraph);
+		const importedModule = moduleGraph.getModule(this);
+		if (
+			importedModule &&
+			isRequireEsmModuleExportsModule(importedModule, moduleGraph)
+		) {
+			// `require(esm)` unwraps the "module.exports" named export; any
+			// further property access lands on that value (which webpack does
+			// not model), so only the "module.exports" export is observable.
+			return [{ name: [ESM_MODULE_EXPORTS_NAME], canInline: false }];
+		}
 		const getFullResult = () => {
 			if (ids.length === 0) {
 				return Dependency.EXPORTS_OBJECT_REFERENCED;
@@ -110,7 +137,8 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 			return [
 				{
 					name: ids,
-					canMangle: false
+					canMangle: false,
+					canInline: false
 				}
 			];
 		};
@@ -145,7 +173,8 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 		}
 		return referencedExports.map((name) => ({
 			name,
-			canMangle: false
+			canMangle: false,
+			canInline: false
 		}));
 	}
 
@@ -155,17 +184,26 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	 * @returns {ExportsSpec | undefined} export names
 	 */
 	getExports(moduleGraph) {
+		const importedModule = moduleGraph.getModule(this);
+		const esmUnwrap =
+			importedModule &&
+			isRequireEsmModuleExportsModule(importedModule, moduleGraph);
 		if (this.names.length === 1) {
 			const ids = this.getIds(moduleGraph);
 			const name = this.names[0];
 			const from = moduleGraph.getConnection(this);
 			if (!from) return;
+			const exportChain = esmUnwrap
+				? [ESM_MODULE_EXPORTS_NAME, ...ids]
+				: ids.length === 0
+					? null
+					: ids;
 			return {
 				exports: [
 					{
 						name,
 						from,
-						export: ids.length === 0 ? null : ids,
+						export: exportChain,
 						// we can't mangle names that are in an empty object
 						// because one could access the prototype property
 						// when export isn't set yet
@@ -191,6 +229,17 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 		}
 		const from = moduleGraph.getConnection(this);
 		if (!from) return;
+		if (esmUnwrap) {
+			// Full re-export `module.exports = require("./esm")` of a module
+			// with a `"module.exports"` named export: the wrapping module's
+			// `module.exports` becomes the unwrapped value, whose own
+			// properties webpack cannot enumerate statically.
+			return {
+				exports: true,
+				canMangle: false,
+				dependencies: [from.module]
+			};
+		}
 		const reexportInfo = this.getStarReexports(
 			moduleGraph,
 			undefined,
@@ -209,7 +258,6 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 						canMangle: !(name in EMPTY_OBJECT) && false
 					})
 				),
-				// TODO handle deep reexports
 				dependencies: [from.module]
 			};
 		}
@@ -222,6 +270,7 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Gets star reexports.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @param {Module} importedModule the imported module (optional)
@@ -308,33 +357,43 @@ class CommonJsExportRequireDependency extends ModuleDependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
-		const { write } = context;
-		write(this.asiSafe);
-		write(this.range);
-		write(this.valueRange);
-		write(this.base);
-		write(this.names);
-		write(this.ids);
-		write(this.resultUsed);
+		context
+			.write(this.asiSafe)
+			.write(this.range)
+			.write(this.valueRange)
+			.write(this.base)
+			.write(this.names)
+			.write(this.ids)
+			.write(this.resultUsed)
+			.write(this.getter);
 		super.serialize(context);
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
-		const { read } = context;
-		this.asiSafe = read();
-		this.range = read();
-		this.valueRange = read();
-		this.base = read();
-		this.names = read();
-		this.ids = read();
-		this.resultUsed = read();
-		super.deserialize(context);
+		this.asiSafe = context.read();
+		const c1 = context.rest;
+		this.range = c1.read();
+		const c2 = c1.rest;
+		this.valueRange = c2.read();
+		const c3 = c2.rest;
+		this.base = c3.read();
+		const c4 = c3.rest;
+		this.names = c4.read();
+		const c5 = c4.rest;
+		this.ids = c5.read();
+		const c6 = c5.rest;
+		this.resultUsed = c6.read();
+		const c7 = c6.rest;
+		this.getter = c7.read();
+		super.deserialize(c7.rest);
 	}
 }
 
@@ -347,6 +406,7 @@ CommonJsExportRequireDependency.Template = class CommonJsExportRequireDependency
 	ModuleDependency.Template
 ) {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object
@@ -365,9 +425,10 @@ CommonJsExportRequireDependency.Template = class CommonJsExportRequireDependency
 		}
 	) {
 		const dep = /** @type {CommonJsExportRequireDependency} */ (dependency);
-		const used = moduleGraph
-			.getExportsInfo(module)
-			.getUsedName(dep.names, runtime);
+		// CJS exports are never inlined
+		const used = /** @type {string | string[] | false} */ (
+			moduleGraph.getExportsInfo(module).getUsedName(dep.names, runtime)
+		);
 
 		const [type, base] = handleDependencyBase(
 			dep.base,
@@ -385,14 +446,24 @@ CommonJsExportRequireDependency.Template = class CommonJsExportRequireDependency
 		});
 		if (importedModule) {
 			const ids = dep.getIds(moduleGraph);
-			const usedImported = moduleGraph
-				.getExportsInfo(importedModule)
-				.getUsedName(ids, runtime);
-			if (usedImported) {
-				const comment = equals(usedImported, ids)
-					? ""
-					: `${Template.toNormalComment(propertyAccess(ids))} `;
-				requireExpr += `${comment}${propertyAccess(usedImported)}`;
+			const esmRequireAccess = getRequireEsmModuleExportsAccess(
+				importedModule,
+				moduleGraph,
+				runtime
+			);
+			if (esmRequireAccess !== null) {
+				requireExpr += `${esmRequireAccess}${propertyAccess(ids)}`;
+			} else {
+				// CJS exports are never inlined
+				const usedImported = /** @type {string | string[] | false} */ (
+					moduleGraph.getExportsInfo(importedModule).getUsedName(ids, runtime)
+				);
+				if (usedImported) {
+					const comment = equals(usedImported, ids)
+						? ""
+						: `${Template.toNormalComment(propertyAccess(ids))} `;
+					requireExpr += `${comment}${propertyAccess(/** @type {string[]} */ (usedImported))}`;
+				}
 			}
 		}
 
@@ -402,12 +473,41 @@ CommonJsExportRequireDependency.Template = class CommonJsExportRequireDependency
 					dep.range[0],
 					dep.range[1] - 1,
 					used
-						? `${base}${propertyAccess(used)} = ${requireExpr}`
+						? `${base}${propertyAccess(/** @type {string[]} */ (used))} = ${requireExpr}`
 						: `/* unused reexport */ ${requireExpr}`
 				);
 				return;
-			case "Object.defineProperty":
-				throw new Error("TODO");
+			case "Object.defineProperty": {
+				// `Object.defineProperty(exports, "name", { value: require("...") })`
+				// or the lazy getter form `{ get: () => require("...") }` used by
+				// barrel files (e.g. webpack's own `lib/index.js`).
+				const valueRange = /** @type {Range} */ (dep.valueRange);
+				if (!used) {
+					// A lazy getter never runs `require` until accessed, so an unused
+					// one can be dropped entirely; an eager value must keep side effects.
+					source.replace(
+						dep.range[0],
+						dep.range[1] - 1,
+						dep.getter
+							? "/* unused reexport */ 0"
+							: `/* unused reexport */ ${requireExpr}`
+					);
+					return;
+				}
+				const descriptor = dep.getter
+					? "enumerable: true, get: () => ("
+					: "value: (";
+				source.replace(
+					dep.range[0],
+					valueRange[0] - 1,
+					`Object.defineProperty(${base}${propertyAccess(
+						/** @type {string[]} */ (used).slice(0, -1)
+					)}, ${JSON.stringify(used[used.length - 1])}, { ${descriptor}`
+				);
+				source.replace(valueRange[0], valueRange[1] - 1, requireExpr);
+				source.replace(valueRange[1], dep.range[1] - 1, ") })");
+				return;
+			}
 			default:
 				throw new Error("Unexpected type");
 		}

package/lib/dependencies/CommonJsExportsDependency.js

@@ -8,7 +8,10 @@
 const InitFragment = require("../InitFragment");
 const makeSerializable = require("../util/makeSerializable");
 const { propertyAccess } = require("../util/property");
-const { handleDependencyBase } = require("./CommonJsDependencyHelpers");
+const {
+	getConcatenatedExportAccess,
+	handleDependencyBase
+} = require("./CommonJsDependencyHelpers");
 const NullDependency = require("./NullDependency");
 
 /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
@@ -18,14 +21,15 @@ const NullDependency = require("./NullDependency");
 /** @typedef {import("../ModuleGraph")} ModuleGraph */
 /** @typedef {import("../ExportsInfo").ExportInfoName} ExportInfoName */
 /** @typedef {import("../javascript/JavascriptParser").Range} Range */
-/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
-/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("./CommonJsDependencyHelpers").CommonJSDependencyBaseKeywords} CommonJSDependencyBaseKeywords */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext<[Range, Range | null, CommonJSDependencyBaseKeywords, ExportInfoName[]]>} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext<[Range, Range | null, CommonJSDependencyBaseKeywords, ExportInfoName[]]>} ObjectSerializerContext */
 
 const EMPTY_OBJECT = {};
 
 class CommonJsExportsDependency extends NullDependency {
 	/**
+	 * Creates an instance of CommonJsExportsDependency.
 	 * @param {Range} range range
 	 * @param {Range | null} valueRange value range
 	 * @param {CommonJSDependencyBaseKeywords} base base
@@ -35,7 +39,9 @@ class CommonJsExportsDependency extends NullDependency {
 		super();
 		this.range = range;
 		this.valueRange = valueRange;
+		/** @type {CommonJSDependencyBaseKeywords} */
 		this.base = base;
+		/** @type {string[]} */
 		this.names = names;
 	}
 
@@ -65,27 +71,31 @@ class CommonJsExportsDependency extends NullDependency {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
-		const { write } = context;
-		write(this.range);
-		write(this.valueRange);
-		write(this.base);
-		write(this.names);
+		context
+			.write(this.range)
+			.write(this.valueRange)
+			.write(this.base)
+			.write(this.names);
 		super.serialize(context);
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
-		const { read } = context;
-		this.range = read();
-		this.valueRange = read();
-		this.base = read();
-		this.names = read();
-		super.deserialize(context);
+		this.range = context.read();
+		const c1 = context.rest;
+		this.valueRange = c1.read();
+		const c2 = c1.rest;
+		this.base = c2.read();
+		const c3 = c2.rest;
+		this.names = c3.read();
+		super.deserialize(c3.rest);
 	}
 }
 
@@ -98,6 +108,7 @@ CommonJsExportsDependency.Template = class CommonJsExportsDependencyTemplate ext
 	NullDependency.Template
 ) {
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Dependency} dependency the dependency for which the template should be applied
 	 * @param {ReplaceSource} source the current replace source which can be modified
 	 * @param {DependencyTemplateContext} templateContext the context object
@@ -106,12 +117,55 @@ CommonJsExportsDependency.Template = class CommonJsExportsDependencyTemplate ext
 	apply(
 		dependency,
 		source,
-		{ module, moduleGraph, initFragments, runtimeRequirements, runtime }
+		{
+			module,
+			moduleGraph,
+			initFragments,
+			runtimeRequirements,
+			runtime,
+			concatenationScope
+		}
 	) {
 		const dep = /** @type {CommonJsExportsDependency} */ (dependency);
-		const used = moduleGraph
-			.getExportsInfo(module)
-			.getUsedName(dep.names, runtime);
+		// CJS exports are never inlined
+		const used = /** @type {string | string[] | false} */ (
+			moduleGraph.getExportsInfo(module).getUsedName(dep.names, runtime)
+		);
+
+		if (concatenationScope) {
+			// eligibility is enforced by JavascriptGenerator.getConcatenationBailoutReason
+			if (dep.base !== "exports" && dep.base !== "module.exports") {
+				throw new Error(
+					`Unsupported base ${dep.base} in concatenated CommonJS module`
+				);
+			}
+			if (!used) {
+				initFragments.push(
+					new InitFragment(
+						"var __webpack_unused_export__;\n",
+						InitFragment.STAGE_CONSTANTS,
+						0,
+						"__webpack_unused_export__"
+					)
+				);
+				source.replace(
+					dep.range[0],
+					dep.range[1] - 1,
+					"__webpack_unused_export__"
+				);
+				return;
+			}
+			source.replace(
+				dep.range[0],
+				dep.range[1] - 1,
+				getConcatenatedExportAccess(
+					concatenationScope,
+					initFragments,
+					dep.names
+				)
+			);
+			return;
+		}
 
 		const [type, base] = handleDependencyBase(
 			dep.base,
@@ -140,7 +194,7 @@ CommonJsExportsDependency.Template = class CommonJsExportsDependencyTemplate ext
 				source.replace(
 					dep.range[0],
 					dep.range[1] - 1,
-					`${base}${propertyAccess(used)}`
+					`${base}${propertyAccess(/** @type {string[]} */ (used))}`
 				);
 				return;
 			case "Object.defineProperty":
@@ -169,7 +223,7 @@ CommonJsExportsDependency.Template = class CommonJsExportsDependencyTemplate ext
 					dep.range[0],
 					/** @type {Range} */ (dep.valueRange)[0] - 1,
 					`Object.defineProperty(${base}${propertyAccess(
-						used.slice(0, -1)
+						/** @type {string[]} */ (used).slice(0, -1)
 					)}, ${JSON.stringify(used[used.length - 1])}, (`
 				);
 				source.replace(