@depup/webpack 5.109.2-depup.0 → 5.110.3-depup.0

package/lib/performance/PureAnnotationsPlugin.js

@@ -0,0 +1,219 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const {
+	JAVASCRIPT_MODULE_TYPE_AUTO,
+	JAVASCRIPT_MODULE_TYPE_DYNAMIC,
+	JAVASCRIPT_MODULE_TYPE_ESM
+} = require("../ModuleTypeConstants");
+const PureAnnotationsWarning = require("../errors/PureAnnotationsWarning");
+const { compareStrings } = require("../util/comparators");
+const { CompilerHintNotationRegExp } = require("../util/magicComment");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Compiler from "../Compiler" */
+/** @import { Program } from "estree" */
+/** @import { BuildInfo } from "../Module" */
+/** @import JavascriptParser from "../javascript/JavascriptParser" */
+/** @import { PureAnnotationDetails } from "../errors/PureAnnotationsWarning" */
+
+const PLUGIN_NAME = "PureAnnotationsPlugin";
+
+// Enough to name the offenders without listing every module.
+const MAX_REPORTED_MODULES = 5;
+
+// The only three the parser reads the annotation for; before anything else it
+// is just a comment. Kept in step with `JavascriptParser.isPure`.
+const ANNOTATED_TYPES = new Set([
+	"CallExpression",
+	"NewExpression",
+	"TaggedTemplateExpression"
+]);
+
+/**
+ * Collects where every node starts, and which of those starts carry a node the
+ * annotation is read for.
+ * @param {Program} ast the program
+ * @returns {{ starts: number[], annotated: Set<number> }} the two of them
+ */
+const collectStarts = (ast) => {
+	/** @type {number[]} */
+	const starts = [];
+	/** @type {Set<number>} */
+	const annotated = new Set();
+	/** @type {unknown[]} */
+	const queue = [ast];
+
+	while (queue.length > 0) {
+		const node = queue.pop();
+
+		if (!node || typeof node !== "object") continue;
+
+		if (Array.isArray(node)) {
+			for (const item of /** @type {unknown[]} */ (node)) queue.push(item);
+			continue;
+		}
+
+		// Walked structurally rather than per node type, so a node the estree
+		// types do not name is still reached.
+		const fields = /** @type {Record<string, unknown>} */ (node);
+		const { type, range } = fields;
+
+		const start = Array.isArray(range)
+			? /** @type {unknown[]} */ (range)[0]
+			: undefined;
+
+		if (typeof type === "string" && typeof start === "number") {
+			starts.push(start);
+
+			if (ANNOTATED_TYPES.has(type)) annotated.add(start);
+		}
+
+		for (const key of Object.keys(fields)) {
+			if (key !== "range" && key !== "loc") queue.push(fields[key]);
+		}
+	}
+
+	// Sorted so each annotation can binary-search for the node after it rather
+	// than walking every start, which is quadratic on a generated file.
+	starts.sort((a, b) => a - b);
+
+	return { starts, annotated };
+};
+
+class PureAnnotationsPlugin {
+	/**
+	 * Creates an instance of PureAnnotationsPlugin.
+	 * @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, { normalModuleFactory }) => {
+				/**
+				 * @param {JavascriptParser} parser the parser
+				 */
+				const handler = (parser) => {
+					parser.hooks.program.tap(PLUGIN_NAME, (ast, comments) => {
+						const pure = comments.filter((comment) =>
+							CompilerHintNotationRegExp.Pure.test(comment.value)
+						);
+
+						if (pure.length === 0) return;
+
+						const { starts, annotated } = collectStarts(ast);
+						let wasted = 0;
+
+						for (const comment of pure) {
+							const range = /** @type {[number, number]} */ (comment.range);
+							const after = range[1];
+
+							// Comments are outside every node's range, so the node the
+							// annotation applies to is whichever starts first after it.
+							let low = 0;
+							let high = starts.length;
+
+							while (low < high) {
+								const middle = (low + high) >> 1;
+
+								if (starts[middle] < after) {
+									low = middle + 1;
+								} else {
+									high = middle;
+								}
+							}
+
+							if (low === starts.length || !annotated.has(starts[low])) {
+								wasted++;
+							}
+						}
+
+						if (wasted === 0) return;
+
+						// Kept on the module rather than in a map here, so a module the
+						// filesystem cache restores rather than parses still reports.
+						const buildInfo = /** @type {BuildInfo} */ (
+							parser.state.module.buildInfo
+						);
+
+						buildInfo.ineffectivePureAnnotations = wasted;
+					});
+				};
+
+				normalModuleFactory.hooks.parser
+					.for(JAVASCRIPT_MODULE_TYPE_AUTO)
+					.tap(PLUGIN_NAME, handler);
+				normalModuleFactory.hooks.parser
+					.for(JAVASCRIPT_MODULE_TYPE_ESM)
+					.tap(PLUGIN_NAME, handler);
+				normalModuleFactory.hooks.parser
+					.for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
+					.tap(PLUGIN_NAME, handler);
+
+				// `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 {PureAnnotationDetails[]} */
+					const wasteful = [];
+					let total = 0;
+
+					for (const module of compilation.modules) {
+						// 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.ineffectivePureAnnotations;
+
+						total += count;
+						wasteful.push({
+							name: module.readableIdentifier(requestShortener),
+							count
+						});
+					}
+
+					if (wasteful.length === 0) return;
+
+					// Ties break by name: module order is not stable across runs.
+					wasteful.sort(
+						(a, b) => b.count - a.count || compareStrings(a.name, b.name)
+					);
+
+					const warning = new PureAnnotationsWarning(
+						wasteful.slice(0, MAX_REPORTED_MODULES),
+						total
+					);
+
+					if (hints === "error") {
+						compilation.errors.push(warning);
+					} else if (hints === "stats") {
+						compilation.hints.push(warning);
+					} else {
+						compilation.warnings.push(warning);
+					}
+				});
+			}
+		);
+	}
+}
+
+module.exports = PureAnnotationsPlugin;

package/lib/performance/RedundantDynamicImportsPlugin.js

@@ -0,0 +1,225 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const AsyncDependenciesBlock = require("../AsyncDependenciesBlock");
+const Entrypoint = require("../Entrypoint");
+const RedundantDynamicImportWarning = require("../errors/RedundantDynamicImportWarning");
+const { compareStrings } = require("../util/comparators");
+const formatLocation = require("../util/formatLocation");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Chunk from "../Chunk" */
+/** @import ChunkGroup from "../ChunkGroup" */
+/** @import Compiler from "../Compiler" */
+/** @import DependenciesBlock from "../DependenciesBlock" */
+/** @import Module from "../Module" */
+
+const PLUGIN_NAME = "RedundantDynamicImportsPlugin";
+
+// Enough to name the offenders without printing every call site.
+const MAX_REPORTED_IMPORTS = 5;
+
+class RedundantDynamicImportsPlugin {
+	/**
+	 * Creates an instance of RedundantDynamicImportsPlugin.
+	 * @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) => {
+			compilation.hooks.afterSeal.tap(PLUGIN_NAME, () => {
+				const { chunkGraph, moduleGraph, requestShortener } = compilation;
+				/** @type {string[]} */
+				const descriptions = [];
+
+				/**
+				 * The chunks certain to be loaded when `chunk` runs: itself, plus what
+				 * every entrypoint able to reach it brings. Entrypoints are alternative
+				 * load paths, so they are intersected — one that carries the target says
+				 * nothing about a page that loads another. A shared runtime name is not
+				 * enough either: with `runtimeChunk: "single"` two entrypoints share one
+				 * runtime while neither loads the other's initial chunks.
+				 * @param {Chunk} chunk the chunk the importer runs in
+				 * @returns {Set<Chunk>} the chunks loaded before it runs
+				 */
+				const computeLoadedChunks = (chunk) => {
+					const chunks = new Set([chunk]);
+					/** @type {Set<ChunkGroup>} */
+					const entrypoints = new Set();
+					/** @type {Set<ChunkGroup>} */
+					const queue = new Set(chunk.groupsIterable);
+
+					for (const group of queue) {
+						// An entrypoint is a load path in itself and carries nothing of
+						// what reaches it: an async one — a worker — starts from its own
+						// chunks, however much the module spawning it had loaded.
+						if (group.isInitial() || group instanceof Entrypoint) {
+							entrypoints.add(group);
+							continue;
+						}
+
+						// Only initial chunks are certain: an async ancestor is loaded on
+						// the path taken, and a group can be reached by several.
+						for (const parent of group.getParents()) queue.add(parent);
+					}
+
+					if (entrypoints.size === 0) return chunks;
+
+					/** @type {Set<Chunk> | undefined} */
+					let common;
+
+					for (const entrypoint of entrypoints) {
+						/** @type {Set<Chunk>} */
+						const loaded = new Set();
+						/** @type {Set<ChunkGroup>} */
+						const chain = new Set([entrypoint]);
+
+						// An entrypoint reached through `dependOn` is loaded first too, so
+						// within one path they add up rather than cancel each other out.
+						for (const group of chain) {
+							for (const member of group.chunks) loaded.add(member);
+							for (const parent of group.getParents()) chain.add(parent);
+						}
+
+						if (common === undefined) {
+							common = loaded;
+							continue;
+						}
+
+						for (const member of common) {
+							if (!loaded.has(member)) common.delete(member);
+						}
+					}
+
+					for (const member of /** @type {Set<Chunk>} */ (common)) {
+						chunks.add(member);
+					}
+
+					return chunks;
+				};
+
+				// The answer depends on the chunk alone, and every module sharing one
+				// asks the same question. Dropped with the hook it is built in.
+				/** @type {Map<Chunk, Set<Chunk>>} */
+				const loadedChunks = new Map();
+
+				/**
+				 * @param {Chunk} chunk the chunk the importer runs in
+				 * @returns {Set<Chunk>} the chunks loaded before it runs
+				 */
+				const getLoadedChunks = (chunk) => {
+					let loaded = loadedChunks.get(chunk);
+
+					if (loaded === undefined) {
+						loaded = computeLoadedChunks(chunk);
+						loadedChunks.set(chunk, loaded);
+					}
+
+					return loaded;
+				};
+
+				/**
+				 * @param {DependenciesBlock} block the block to walk
+				 * @param {Module} importer the module the block belongs to
+				 * @param {Set<Chunk>[]} contexts what is loaded in each place it runs
+				 * @returns {void}
+				 */
+				const walk = (block, importer, contexts) => {
+					for (const nested of block.blocks) {
+						if (nested instanceof AsyncDependenciesBlock) {
+							for (const dependency of nested.dependencies) {
+								const target = moduleGraph.getModule(dependency);
+
+								if (!target) continue;
+
+								// Redundant only where it is redundant everywhere: a shared
+								// importer still defers for an entry that lacks the target.
+								let redundant = true;
+
+								for (const loaded of contexts) {
+									let present = false;
+
+									for (const chunk of chunkGraph.getModuleChunksIterable(
+										target
+									)) {
+										if (loaded.has(chunk)) {
+											present = true;
+											break;
+										}
+									}
+
+									if (!present) {
+										redundant = false;
+										break;
+									}
+								}
+
+								if (!redundant) continue;
+
+								descriptions.push(
+									`${importer.readableIdentifier(requestShortener)}${
+										nested.loc ? ` ${formatLocation(nested.loc)}` : ""
+									} imports ${target.readableIdentifier(requestShortener)}`
+								);
+							}
+						}
+
+						walk(nested, importer, contexts);
+					}
+				};
+
+				for (const module of compilation.modules) {
+					if (module.blocks.length === 0) continue;
+
+					/** @type {Set<Chunk>[]} */
+					const contexts = [];
+
+					for (const chunk of chunkGraph.getModuleChunksIterable(module)) {
+						contexts.push(getLoadedChunks(chunk));
+					}
+
+					if (contexts.length === 0) continue;
+
+					walk(module, module, contexts);
+				}
+
+				if (descriptions.length === 0) return;
+
+				// Module order is not stable across runtimes, so the reported subset
+				// would otherwise differ between them.
+				descriptions.sort(compareStrings);
+
+				const warning = new RedundantDynamicImportWarning(
+					descriptions.slice(0, MAX_REPORTED_IMPORTS)
+				);
+
+				if (hints === "error") {
+					compilation.errors.push(warning);
+				} else if (hints === "stats") {
+					compilation.hints.push(warning);
+				} else {
+					compilation.warnings.push(warning);
+				}
+			});
+		});
+	}
+}
+
+module.exports = RedundantDynamicImportsPlugin;

package/lib/performance/RuntimeInLargeChunkWarning.js

@@ -0,0 +1,27 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const WebpackError = require("../errors/WebpackError");
+
+class RuntimeInLargeChunkWarning extends WebpackError {
+	/**
+	 * Creates an instance of RuntimeInLargeChunkWarning.
+	 * @param {string[]} entrypoints names of the entrypoints carrying the runtime
+	 */
+	constructor(entrypoints) {
+		super(
+			`webpack performance recommendations: \nThe runtime is part of the initial chunk of ${entrypoints.join(
+				", "
+			)}. It describes every other chunk, so a change anywhere in the build rewrites these assets and clients download them again.\nSet 'optimization.runtimeChunk' to emit the runtime as its own chunk.\nFor more info visit https://webpack.js.org/configuration/optimization/#optimizationruntimechunk`
+		);
+
+		/** @type {string} */
+		this.name = "RuntimeInLargeChunkWarning";
+	}
+}
+
+module.exports = RuntimeInLargeChunkWarning;

package/lib/performance/ScopeHoistingBailoutsPlugin.js

@@ -0,0 +1,164 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+const ScopeHoistingBailoutsWarning = require("../errors/ScopeHoistingBailoutsWarning");
+const {
+	BAILOUT_PREFIX,
+	REJECTED_PREFIX
+} = require("../optimize/ModuleConcatenationPlugin");
+const { compareStrings } = require("../util/comparators");
+const getModuleSize = require("./getModuleSize");
+
+/** @import { PerformanceOptions } from "../../declarations/WebpackOptions" */
+/** @import Compiler from "../Compiler" */
+/** @import Module from "../Module" */
+/** @import RequestShortener from "../RequestShortener" */
+/**
+ * @import {
+ * 	ScopeHoistingBailoutGroup
+ * } from "../errors/ScopeHoistingBailoutsWarning"
+ */
+
+const PLUGIN_NAME = "ScopeHoistingBailoutsPlugin";
+
+// Reasons repeat far more than they differ, so a few name the problem.
+const MAX_REPORTED_REASONS = 5;
+
+// Enough per reason to recognize the offenders without listing every module.
+const MAX_REPORTED_NAMES = 3;
+
+// A source position makes two identical reasons look like two problems.
+const POSITION_REGEXP = / at \d+:\d+-\d+$/;
+
+/**
+ * The module's own reasons for staying out of a scope, without the ones it
+ * only carries because something it imports bailed out.
+ * @param {(string | ((requestShortener: RequestShortener) => string))[]} bailouts what the module graph recorded
+ * @param {RequestShortener} requestShortener the request shortener
+ * @returns {string[]} the reasons, stripped of their prefix and position
+ */
+const getOwnReasons = (bailouts, requestShortener) => {
+	/** @type {string[]} */
+	const reasons = [];
+
+	for (const bailout of bailouts) {
+		const message =
+			typeof bailout === "function" ? bailout(requestShortener) : bailout;
+
+		if (!message.startsWith(BAILOUT_PREFIX)) continue;
+
+		const reason = message.slice(BAILOUT_PREFIX.length);
+
+		// One root lists every module it could not take in; each of those
+		// modules reports the same problem itself.
+		if (reason.startsWith(REJECTED_PREFIX)) continue;
+
+		reasons.push(reason.replace(POSITION_REGEXP, ""));
+	}
+
+	return reasons;
+};
+
+class ScopeHoistingBailoutsPlugin {
+	/**
+	 * Creates an instance of ScopeHoistingBailoutsPlugin.
+	 * @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) => {
+			// After seal: a module that was hoisted is gone from `modules` by now,
+			// absorbed into the concatenation that took it.
+			compilation.hooks.afterSeal.tap(PLUGIN_NAME, () => {
+				const { chunkGraph, moduleGraph, requestShortener } = compilation;
+				/** @type {Map<string, { size: number, name: string }[]>} */
+				const byReason = new Map();
+				/** @type {Set<Module>} */
+				const affected = new Set();
+
+				for (const module of compilation.modules) {
+					// One webpack left out was never a candidate.
+					if (chunkGraph.getNumberOfModuleChunks(module) === 0) continue;
+
+					const reasons = getOwnReasons(
+						moduleGraph.getOptimizationBailout(module),
+						requestShortener
+					);
+
+					if (reasons.length === 0) continue;
+
+					affected.add(module);
+
+					const entry = {
+						name: module.readableIdentifier(requestShortener),
+						size: getModuleSize(module)
+					};
+
+					for (const reason of new Set(reasons)) {
+						const modules = byReason.get(reason);
+
+						if (modules === undefined) {
+							byReason.set(reason, [entry]);
+						} else {
+							modules.push(entry);
+						}
+					}
+				}
+
+				if (affected.size === 0) return;
+
+				/** @type {ScopeHoistingBailoutGroup[]} */
+				const groups = [];
+
+				for (const [reason, modules] of byReason) {
+					// Ties break by name: module order is not stable across runtimes.
+					modules.sort(
+						(a, b) => b.size - a.size || compareStrings(a.name, b.name)
+					);
+
+					groups.push({
+						reason,
+						count: modules.length,
+						names: modules.slice(0, MAX_REPORTED_NAMES).map((m) => m.name)
+					});
+				}
+
+				groups.sort(
+					(a, b) => b.count - a.count || compareStrings(a.reason, b.reason)
+				);
+
+				const warning = new ScopeHoistingBailoutsWarning(
+					groups.slice(0, MAX_REPORTED_REASONS),
+					affected.size
+				);
+
+				if (hints === "error") {
+					compilation.errors.push(warning);
+				} else if (hints === "stats") {
+					compilation.hints.push(warning);
+				} else {
+					compilation.warnings.push(warning);
+				}
+			});
+		});
+	}
+}
+
+module.exports = ScopeHoistingBailoutsPlugin;