webpack 5.110.3 → 5.111.0

package/lib/performance/MissingSourceMapsPlugin.js

@@ -0,0 +1,115 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const { SourceMapSource } = require("webpack-sources");
+const NormalModule = require("../NormalModule");
+const MissingSourceMapsWarning = require("../errors/MissingSourceMapsWarning");
+const { compareStrings } = require("../util/comparators");
+const getSourceModules = require("./getSourceModules");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Compiler from "../Compiler" */
+/** @import Module from "../Module" */
+/** @import RequestShortener from "../RequestShortener" */
+/** @import { MissingSourceMapDetails } from "../errors/MissingSourceMapsWarning" */
+
+const PLUGIN_NAME = "MissingSourceMapsPlugin";
+
+// Enough to name the offenders without listing every module a loader touched.
+const MAX_REPORTED_MODULES = 5;
+
+/**
+ * The loaders that ran on a module, shortened for reading.
+ * @param {NormalModule} module the module
+ * @param {RequestShortener} requestShortener the request shortener
+ * @returns {string[]} what to call them
+ */
+const loaderNames = (module, requestShortener) =>
+	module.loaders.map((it) => requestShortener.shorten(it.loader) || it.loader);
+
+class MissingSourceMapsPlugin {
+	/**
+	 * Creates an instance of MissingSourceMapsPlugin.
+	 * @param {PerformanceOptions} options the plugin options
+	 */
+	constructor(options) {
+		/** @type {PerformanceOptions["hints"]} */
+		this.hints = options.hints;
+	}
+
+	/**
+	 * Applies the plugin by registering its hooks on the compiler.
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
+	apply(compiler) {
+		const hints = this.hints;
+
+		if (!hints) return;
+
+		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+			// `afterSeal` is past the hash, which folds every message into it — a
+			// hint reported earlier would change the build's identity.
+			compilation.hooks.afterSeal.tap(PLUGIN_NAME, () => {
+				const { requestShortener } = compilation;
+				/** @type {MissingSourceMapDetails[]} */
+				const found = [];
+
+				// A module can be reached both on its own and inside a
+				// concatenation, so it is only counted the first time.
+				/** @type {Set<Module>} */
+				const seen = new Set();
+
+				for (const parent of compilation.modules) {
+					// Scope hoisting makes several modules into one, and each of them
+					// kept the source its own loaders produced.
+					for (const module of getSourceModules(parent)) {
+						if (seen.has(module)) continue;
+
+						seen.add(module);
+
+						if (!(module instanceof NormalModule)) continue;
+
+						// Only where a real map was asked for: the cheap devtools map to
+						// the loader output by design, so nothing is lost there.
+						if (!module.useSourceMap) continue;
+						if (module.loaders.length === 0) continue;
+
+						// A loader that returned a map produces a `SourceMapSource`;
+						// falling back to any other source is the map being dropped.
+						if (module.originalSource() instanceof SourceMapSource) continue;
+
+						found.push({
+							name: module.readableIdentifier(requestShortener),
+							loaders: loaderNames(module, requestShortener)
+						});
+					}
+				}
+
+				if (found.length === 0) return;
+
+				// By name: module order is not stable across runs.
+				found.sort((a, b) => compareStrings(a.name, b.name));
+
+				const warning = new MissingSourceMapsWarning(
+					found.slice(0, MAX_REPORTED_MODULES),
+					found.length
+				);
+
+				if (hints === "error") {
+					compilation.errors.push(warning);
+				} else if (hints === "stats") {
+					compilation.hints.push(warning);
+				} else {
+					compilation.warnings.push(warning);
+				}
+			});
+		});
+	}
+}
+
+module.exports = MissingSourceMapsPlugin;

package/lib/performance/PureAnnotationsPlugin.js

@@ -11,6 +11,7 @@ const {
 	JAVASCRIPT_MODULE_TYPE_ESM
 } = require("../ModuleTypeConstants");
 const PureAnnotationsWarning = require("../errors/PureAnnotationsWarning");
+const { getBuildDiagnostics } = require("../util/buildDiagnostics");
 const { compareStrings } = require("../util/comparators");
 const { CompilerHintNotationRegExp } = require("../util/magicComment");
 
@@ -154,7 +155,7 @@ class PureAnnotationsPlugin {
 							parser.state.module.buildInfo
 						);
 
-						buildInfo.ineffectivePureAnnotations = wasted;
+						getBuildDiagnostics(buildInfo).ineffectivePureAnnotations = wasted;
 					});
 				};
 
@@ -180,9 +181,11 @@ class PureAnnotationsPlugin {
 						// Every built module carries one, so only the field is in question.
 						const buildInfo = /** @type {BuildInfo} */ (module.buildInfo);
 
-						if (!buildInfo.ineffectivePureAnnotations) continue;
+						const count =
+							buildInfo.diagnostics &&
+							buildInfo.diagnostics.ineffectivePureAnnotations;
 
-						const count = buildInfo.ineffectivePureAnnotations;
+						if (!count) continue;
 
 						total += count;
 						wasteful.push({

package/lib/performance/TopLevelThisPlugin.js

@@ -11,14 +11,14 @@ const {
 	JAVASCRIPT_MODULE_TYPE_ESM
 } = require("../ModuleTypeConstants");
 const TopLevelThisWarning = require("../errors/TopLevelThisWarning");
+const { getBuildDiagnostics } = require("../util/buildDiagnostics");
 const { compareStrings } = require("../util/comparators");
 const getSourceModules = require("./getSourceModules");
 
 /** @import { Program } from "estree" */
 /** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
 /** @import Compiler from "../Compiler" */
-/** @import Module from "../Module" */
-/** @import { BuildInfo } from "../Module" */
+/** @import Module, { BuildInfo } from "../Module" */
 /** @import JavascriptParser from "../javascript/JavascriptParser" */
 /** @import { TopLevelThisDetails } from "../errors/TopLevelThisWarning" */
 
@@ -133,7 +133,7 @@ class TopLevelThisPlugin {
 							/** @type {BuildInfo} */
 							(parser.state.module.buildInfo);
 
-						buildInfo.topLevelThis = count;
+						getBuildDiagnostics(buildInfo).topLevelThis = count;
 					});
 				};
 
@@ -168,7 +168,8 @@ class TopLevelThisPlugin {
 							seen.add(module);
 
 							const buildInfo = /** @type {BuildInfo} */ (module.buildInfo);
-							const count = buildInfo.topLevelThis;
+							const count =
+								buildInfo.diagnostics && buildInfo.diagnostics.topLevelThis;
 
 							if (!count) continue;
 

package/lib/performance/UnusedAssetsPlugin.js

@@ -0,0 +1,109 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const { ASSET_TYPE } = require("../ModuleSourceTypeConstants");
+const HarmonyImportBareSideEffectDependency = require("../dependencies/HarmonyImportBareSideEffectDependency");
+const HarmonyImportSideEffectDependency = require("../dependencies/HarmonyImportSideEffectDependency");
+const UnusedAssetsWarning = require("../errors/UnusedAssetsWarning");
+const { compareStrings } = require("../util/comparators");
+const getModuleSize = require("./getModuleSize");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Compiler from "../Compiler" */
+/** @import { UnusedAssetDetails } from "../errors/UnusedAssetsWarning" */
+
+const PLUGIN_NAME = "UnusedAssetsPlugin";
+
+// Enough to name the offenders without listing every asset in the build.
+const MAX_REPORTED_ASSETS = 5;
+
+class UnusedAssetsPlugin {
+	/**
+	 * Creates an instance of UnusedAssetsPlugin.
+	 * @param {PerformanceOptions} options the plugin options
+	 */
+	constructor(options) {
+		/** @type {PerformanceOptions["hints"]} */
+		this.hints = options.hints;
+	}
+
+	/**
+	 * Applies the plugin by registering its hooks on the compiler.
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
+	apply(compiler) {
+		const hints = this.hints;
+
+		if (!hints) return;
+
+		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+			// `afterSeal` is past the hash, which folds every message into it — a
+			// hint reported earlier would change the build's identity.
+			compilation.hooks.afterSeal.tap(PLUGIN_NAME, () => {
+				const { moduleGraph, requestShortener } = compilation;
+				/** @type {UnusedAssetDetails[]} */
+				const found = [];
+				let total = 0;
+
+				for (const module of compilation.modules) {
+					// An inlined one carries no asset type: it is a data url in the
+					// importer, whose bytes `inlinedAssets` is the check for.
+					if (!module.getSourceTypes().has(ASSET_TYPE)) continue;
+
+					let onlyUnread = false;
+
+					for (const connection of moduleGraph.getIncomingConnections(module)) {
+						const dependency = connection.dependency;
+
+						// Anything else — a `url()`, a `new URL()`, an html `src` — reads
+						// the file, and a bare import asks for it on purpose.
+						if (
+							!(dependency instanceof HarmonyImportSideEffectDependency) ||
+							dependency instanceof HarmonyImportBareSideEffectDependency
+						) {
+							onlyUnread = false;
+							break;
+						}
+
+						onlyUnread = true;
+					}
+
+					if (!onlyUnread) continue;
+
+					const size = Math.round(getModuleSize(module));
+
+					total += size;
+					found.push({
+						name: module.readableIdentifier(requestShortener),
+						size
+					});
+				}
+
+				if (found.length === 0) return;
+
+				// Largest first; ties break by name, module order is not stable.
+				found.sort((a, b) => b.size - a.size || compareStrings(a.name, b.name));
+
+				const warning = new UnusedAssetsWarning(
+					found.slice(0, MAX_REPORTED_ASSETS),
+					total
+				);
+
+				if (hints === "error") {
+					compilation.errors.push(warning);
+				} else if (hints === "stats") {
+					compilation.hints.push(warning);
+				} else {
+					compilation.warnings.push(warning);
+				}
+			});
+		});
+	}
+}
+
+module.exports = UnusedAssetsPlugin;

package/lib/performance/UnusedFederationPlugin.js

@@ -0,0 +1,147 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const RemoteModule = require("../container/RemoteModule");
+const { getDeclaredRemotes } = require("../container/declaredRemotes");
+const UnusedFederationWarning = require("../errors/UnusedFederationWarning");
+const ConsumeSharedModule = require("../sharing/ConsumeSharedModule");
+const { getDeclaredShared } = require("../sharing/declaredShared");
+const { compareStrings } = require("../util/comparators");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Compiler from "../Compiler" */
+/** @import { UnusedFederationDetails } from "../errors/UnusedFederationWarning" */
+
+const PLUGIN_NAME = "UnusedFederationPlugin";
+
+/**
+ * @param {Set<string>} used the share keys modules were created for
+ * @param {string} shareKey the declared share key
+ * @returns {boolean} whether anything under the share key was used
+ */
+const someUsedStartsWith = (used, shareKey) => {
+	for (const usedKey of used) {
+		if (usedKey.startsWith(shareKey)) return true;
+	}
+
+	return false;
+};
+
+/**
+ * Applies the rule `ContainerReferencePlugin` factorizes by, so that a remote
+ * name holding slashes is told apart from an exposed path holding them too.
+ * @param {string} request the request a remote module was created for
+ * @param {string} name the declared remote name
+ * @returns {boolean} whether the request names this remote
+ */
+const isRequestFor = (request, name) =>
+	request.startsWith(name) &&
+	(request.length === name.length || request[name.length] === "/");
+
+class UnusedFederationPlugin {
+	/**
+	 * Creates an instance of UnusedFederationPlugin.
+	 * @param {PerformanceOptions} options the plugin options
+	 */
+	constructor(options) {
+		/** @type {PerformanceOptions["hints"]} */
+		this.hints = options.hints;
+	}
+
+	/**
+	 * Applies the plugin by registering its hooks on the compiler.
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
+	apply(compiler) {
+		const hints = this.hints;
+
+		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+			// Reported past the hash, which folds every message into it, so a hint
+			// pushed earlier would change the build's identity.
+			compilation.hooks.afterSeal.tap(PLUGIN_NAME, () => {
+				const declaredShared = getDeclaredShared(compilation);
+				const declaredRemotes = getDeclaredRemotes(compilation);
+
+				if (declaredShared === undefined && declaredRemotes === undefined) {
+					return;
+				}
+
+				// Nothing was factorized, so no shared or remote module could exist.
+				if (compilation.modules.size === 0) return;
+
+				/** @type {Set<string>} */
+				const usedShared = new Set();
+				/** @type {Set<string>} */
+				const remoteRequests = new Set();
+
+				for (const module of compilation.modules) {
+					if (module instanceof ConsumeSharedModule) {
+						usedShared.add(module.options.shareKey);
+					} else if (module instanceof RemoteModule) {
+						remoteRequests.add(module.request);
+					}
+				}
+
+				/** @type {UnusedFederationDetails[]} */
+				const unused = [];
+
+				if (declaredShared !== undefined) {
+					// Matched on the share key, since that is what the module carries,
+					// but reported by the config key, which is what the config spells.
+					for (const { name, shareKey, prefix } of declaredShared) {
+						const used = prefix
+							? someUsedStartsWith(usedShared, shareKey)
+							: usedShared.has(shareKey);
+
+						if (!used) unused.push({ name, kind: "shared" });
+					}
+				}
+
+				if (declaredRemotes !== undefined) {
+					/** @type {Set<string>} */
+					const usedRemotes = new Set();
+
+					// Declaration order is precedence: `factorize` takes the first
+					// name a request matches, so a later one it also matches is dead.
+					for (const request of remoteRequests) {
+						for (const name of declaredRemotes) {
+							if (isRequestFor(request, name)) {
+								usedRemotes.add(name);
+								break;
+							}
+						}
+					}
+
+					for (const name of declaredRemotes) {
+						if (!usedRemotes.has(name)) unused.push({ name, kind: "remote" });
+					}
+				}
+
+				if (unused.length === 0) return;
+
+				// Ties break by name: declaration order is not worth preserving here.
+				unused.sort(
+					(a, b) =>
+						compareStrings(a.kind, b.kind) || compareStrings(a.name, b.name)
+				);
+
+				const warning = new UnusedFederationWarning(unused);
+
+				if (hints === "error") {
+					compilation.errors.push(warning);
+				} else if (hints === "stats") {
+					compilation.hints.push(warning);
+				} else {
+					compilation.warnings.push(warning);
+				}
+			});
+		});
+	}
+}
+
+module.exports = UnusedFederationPlugin;

package/lib/performance/UnusedModulesPlugin.js

@@ -0,0 +1,141 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const HarmonyImportBareSideEffectDependency = require("../dependencies/HarmonyImportBareSideEffectDependency");
+const UnusedModulesWarning = require("../errors/UnusedModulesWarning");
+const { compareStrings } = require("../util/comparators");
+const getModuleSize = require("./getModuleSize");
+const hasOnlyUnusedExports = require("./hasOnlyUnusedExports");
+const isOnlyReexported = require("./isOnlyReexported");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Compiler from "../Compiler" */
+/** @import Module, { BuildInfo } from "../Module" */
+/** @import ModuleGraph from "../ModuleGraph" */
+/** @import { UnusedModuleDetails } from "../errors/UnusedModulesWarning" */
+
+const PLUGIN_NAME = "UnusedModulesPlugin";
+
+// Enough to name the offenders without listing every module kept this way.
+const MAX_REPORTED_MODULES = 5;
+
+/**
+ * Whether some importer bound a name from this module. A bare `import "..."`
+ * binds nothing, so it can only have been written for what importing does —
+ * that is deliberate, and not what this hint is about.
+ * @param {Module} module the module to look up
+ * @param {ModuleGraph} moduleGraph the module graph
+ * @returns {boolean} true when every importer bound something
+ */
+const everyImportBinds = (module, moduleGraph) => {
+	for (const connection of moduleGraph.getIncomingConnections(module)) {
+		if (
+			connection.dependency instanceof HarmonyImportBareSideEffectDependency
+		) {
+			return false;
+		}
+	}
+
+	return true;
+};
+
+class UnusedModulesPlugin {
+	/**
+	 * Creates an instance of UnusedModulesPlugin.
+	 * @param {PerformanceOptions} options the plugin options
+	 */
+	constructor(options) {
+		/** @type {PerformanceOptions["hints"]} */
+		this.hints = options.hints;
+	}
+
+	/**
+	 * Applies the plugin by registering its hooks on the compiler.
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
+	apply(compiler) {
+		const hints = this.hints;
+
+		if (!hints) return;
+
+		compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+			/** @type {UnusedModulesWarning | undefined} */
+			let warning;
+
+			// Usage is final here, and concatenation has not merged the modules
+			// away yet, so each one can still be measured and attributed.
+			compilation.hooks.optimizeModules.tap(PLUGIN_NAME, (modules) => {
+				const { chunkGraph, moduleGraph, requestShortener } = compilation;
+				/** @type {UnusedModuleDetails[]} */
+				const found = [];
+				let size = 0;
+
+				for (const module of modules) {
+					// One webpack already left out costs nothing — and with no chunk it
+					// has no runtime, which is all `hasOnlyUnusedExports` reads usage in.
+					if (chunkGraph.getNumberOfModuleChunks(module) === 0) continue;
+					if (!hasOnlyUnusedExports(module, moduleGraph, chunkGraph)) continue;
+
+					// A barrel's leftover is the same finding with a different cause,
+					// and `UnusedReexportsPlugin` states it with the re-export named.
+					if (isOnlyReexported(module, moduleGraph)) continue;
+
+					if (!everyImportBinds(module, moduleGraph)) continue;
+
+					// Recorded while parsing, so a module restored from the cache still has it.
+					// Absent means the module is kept for a reason this hint cannot name.
+					const diagnostics =
+						/** @type {BuildInfo} */
+						(module.buildInfo).diagnostics;
+					const statement =
+						diagnostics === undefined
+							? undefined
+							: diagnostics.sideEffectStatement;
+
+					if (statement === undefined) continue;
+
+					const bytes = Math.round(getModuleSize(module));
+
+					size += bytes;
+					found.push({
+						name: module.readableIdentifier(requestShortener),
+						size: bytes,
+						statement
+					});
+				}
+
+				if (found.length === 0) return;
+
+				// Largest first; ties break by name, module order is not stable.
+				found.sort((a, b) => b.size - a.size || compareStrings(a.name, b.name));
+
+				warning = new UnusedModulesWarning(
+					found.slice(0, MAX_REPORTED_MODULES),
+					found.length,
+					size
+				);
+			});
+
+			// Reported past the hash: `createHash` folds every message into it, so
+			// a hint pushed earlier would change the build's identity.
+			compilation.hooks.afterSeal.tap(PLUGIN_NAME, () => {
+				if (warning === undefined) return;
+
+				if (hints === "error") {
+					compilation.errors.push(warning);
+				} else if (hints === "stats") {
+					compilation.hints.push(warning);
+				} else {
+					compilation.warnings.push(warning);
+				}
+			});
+		});
+	}
+}
+
+module.exports = UnusedModulesPlugin;

package/lib/performance/UnusedReexportsPlugin.js

@@ -5,17 +5,14 @@
 
 "use strict";
 
-const HarmonyExportImportedSpecifierDependency = require("../dependencies/HarmonyExportImportedSpecifierDependency");
-const HarmonyImportDependency = require("../dependencies/HarmonyImportDependency");
 const UnusedReexportsWarning = require("../errors/UnusedReexportsWarning");
 const { compareStrings } = require("../util/comparators");
 const getModuleSize = require("./getModuleSize");
 const hasOnlyUnusedExports = require("./hasOnlyUnusedExports");
+const isOnlyReexported = require("./isOnlyReexported");
 
 /** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
 /** @import Compiler from "../Compiler" */
-/** @import Module from "../Module" */
-/** @import ModuleGraph from "../ModuleGraph" */
 /** @import { UnusedReexportDetails } from "../errors/UnusedReexportsWarning" */
 
 const PLUGIN_NAME = "UnusedReexportsPlugin";
@@ -23,57 +20,6 @@ const PLUGIN_NAME = "UnusedReexportsPlugin";
 // Enough to name the offenders without listing the barrel.
 const MAX_REPORTED_MODULES = 5;
 
-/**
- * Tells whether every module pulling this one in does so by re-exporting it.
- * One an importer wants for its side effects alone is deliberate, not a
- * barrel's leftover.
- * @param {Module} module the module to look up
- * @param {ModuleGraph} moduleGraph the module graph
- * @returns {boolean} true when only re-exports pull it in
- */
-const isOnlyReexported = (module, moduleGraph) => {
-	// A re-export emits a side-effect edge of its own, so edges are grouped by
-	// the statement they come from — `sourceOrder` — rather than by their type.
-	/** @type {Map<Module, Set<number | undefined>>} */
-	const reexportedStatements = new Map();
-	/** @type {[Module, number | undefined][]} */
-	const edges = [];
-
-	for (const connection of moduleGraph.getIncomingConnections(module)) {
-		const origin = connection.originModule;
-
-		// An entry has no origin: it is in the build because it was asked for.
-		if (!origin) return false;
-
-		const dependency = connection.dependency;
-
-		// Only an ESM import statement can carry a re-export.
-		if (!(dependency instanceof HarmonyImportDependency)) return false;
-
-		if (dependency instanceof HarmonyExportImportedSpecifierDependency) {
-			const statements = reexportedStatements.get(origin);
-
-			if (statements === undefined) {
-				reexportedStatements.set(origin, new Set([dependency.sourceOrder]));
-			} else {
-				statements.add(dependency.sourceOrder);
-			}
-		}
-
-		edges.push([origin, dependency.sourceOrder]);
-	}
-
-	if (edges.length === 0) return false;
-
-	for (const [origin, sourceOrder] of edges) {
-		const statements = reexportedStatements.get(origin);
-
-		if (statements === undefined || !statements.has(sourceOrder)) return false;
-	}
-
-	return true;
-};
-
 class UnusedReexportsPlugin {
 	/**
 	 * Creates an instance of UnusedReexportsPlugin.