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

package/lib/cache/MemoryWithGcCachePlugin.js

@@ -12,6 +12,7 @@ const Cache = require("../Cache");
 /** @typedef {import("../Compiler")} Compiler */
 
 /**
+ * Defines the memory with gc cache plugin options type used by this module.
  * @typedef {object} MemoryWithGcCachePluginOptions
  * @property {number} maxGenerations max generations
  */
@@ -20,14 +21,16 @@ const PLUGIN_NAME = "MemoryWithGcCachePlugin";
 
 class MemoryWithGcCachePlugin {
 	/**
+	 * Creates an instance of MemoryWithGcCachePlugin.
 	 * @param {MemoryWithGcCachePluginOptions} options options
 	 */
 	constructor({ maxGenerations }) {
+		/** @type {number} */
 		this._maxGenerations = maxGenerations;
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/cache/PackFileCacheStrategy.js

@@ -7,9 +7,9 @@
 
 const FileSystemInfo = require("../FileSystemInfo");
 const ProgressPlugin = require("../ProgressPlugin");
-const { formatSize } = require("../SizeFormatHelpers");
 const SerializerMiddleware = require("../serialization/SerializerMiddleware");
 const LazySet = require("../util/LazySet");
+const formatSize = require("../util/formatSize");
 const makeSerializable = require("../util/makeSerializable");
 const memoize = require("../util/memoize");
 const {
@@ -37,6 +37,7 @@ const {
 
 class PackContainer {
 	/**
+	 * Creates an instance of PackContainer.
 	 * @param {Pack} data stored data
 	 * @param {string} version version identifier
 	 * @param {Snapshot} buildSnapshot snapshot of all build dependencies
@@ -67,6 +68,7 @@ class PackContainer {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize({ write, writeLazy }) {
@@ -80,6 +82,7 @@ class PackContainer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize({ read }) {
@@ -102,10 +105,11 @@ const MIN_CONTENT_SIZE = 1024 * 1024; // 1 MB
 const CONTENT_COUNT_TO_MERGE = 10;
 const MIN_ITEMS_IN_FRESH_PACK = 100;
 const MAX_ITEMS_IN_FRESH_PACK = 50000;
-const MAX_TIME_IN_FRESH_PACK = 1 * 60 * 1000; // 1 min
+const MAX_TIME_IN_FRESH_PACK = 60 * 1000; // 1 min
 
 class PackItemInfo {
 	/**
+	 * Creates an instance of PackItemInfo.
 	 * @param {string} identifier identifier of item
 	 * @param {string | null | undefined} etag etag of item
 	 * @param {Data} value fresh value of item
@@ -126,6 +130,7 @@ class PackItemInfo {
 
 class Pack {
 	/**
+	 * Creates an instance of Pack.
 	 * @param {Logger} logger a logger
 	 * @param {number} maxAge max age of cache items
 	 */
@@ -149,6 +154,7 @@ class Pack {
 	}
 
 	/**
+	 * Adds the provided identifier to the pack.
 	 * @param {string} identifier identifier
 	 */
 	_addRequest(identifier) {
@@ -170,6 +176,7 @@ class Pack {
 	}
 
 	/**
+	 * Returns cached content.
 	 * @param {string} identifier unique name for the resource
 	 * @param {string | null} etag etag of the resource
 	 * @returns {Data} cached content
@@ -193,6 +200,7 @@ class Pack {
 	}
 
 	/**
+	 * Updates value using the provided identifier.
 	 * @param {string} identifier unique name for the resource
 	 * @param {string | null} etag etag of the resource
 	 * @param {Data} data cached content
@@ -244,6 +252,7 @@ class Pack {
 	}
 
 	/**
+	 * Returns new location of data entries.
 	 * @returns {number} new location of data entries
 	 */
 	_findLocation() {
@@ -254,6 +263,7 @@ class Pack {
 	}
 
 	/**
+	 * Gc and update location.
 	 * @private
 	 * @param {Items} items items
 	 * @param {Items} usedItems used items
@@ -604,6 +614,7 @@ class Pack {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize({ write, writeSeparate }) {
@@ -637,6 +648,7 @@ class Pack {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext & { logger: Logger }} context context
 	 */
 	deserialize({ read, logger }) {
@@ -694,13 +706,16 @@ makeSerializable(Pack, "webpack/lib/cache/PackFileCacheStrategy", "Pack");
 
 class PackContentItems {
 	/**
+	 * Creates an instance of PackContentItems.
 	 * @param {Content} map items
 	 */
 	constructor(map) {
+		/** @type {Content} */
 		this.map = map;
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext & { logger: Logger, profile: boolean | undefined }} context context
 	 */
 	serialize({ write, snapshot, rollback, logger, profile }) {
@@ -778,13 +793,14 @@ class PackContentItems {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext & { logger: Logger, profile: boolean | undefined }} context context
 	 */
 	deserialize({ read, logger, profile }) {
 		if (read()) {
 			this.map = read();
 		} else if (profile) {
-			/** @type {Map<EXPECTED_ANY, EXPECTED_ANY>} */
+			/** @type {Content} */
 			const map = new Map();
 			let key = read();
 			while (key !== null) {
@@ -810,7 +826,7 @@ class PackContentItems {
 			}
 			this.map = map;
 		} else {
-			/** @type {Map<EXPECTED_ANY, EXPECTED_ANY>} */
+			/** @type {Content} */
 			const map = new Map();
 			let key = read();
 			while (key !== null) {
@@ -851,6 +867,7 @@ class PackContent {
 	*/
 
 	/**
+	 * Creates an instance of PackContent.
 	 * @param {Items} items keys
 	 * @param {Items} usedItems used keys
 	 * @param {PackContentItems | (() => Promise<PackContentItems>)} dataOrFn sync or async content
@@ -875,6 +892,7 @@ class PackContent {
 	}
 
 	/**
+	 * Returns result.
 	 * @param {string} identifier identifier
 	 * @returns {string | Promise<string>} result
 	 */
@@ -927,6 +945,7 @@ class PackContent {
 	}
 
 	/**
+	 * Returns maybe a promise if lazy.
 	 * @param {string} reason explanation why unpack is necessary
 	 * @returns {void | Promise<void>} maybe a promise if lazy
 	 */
@@ -971,6 +990,7 @@ class PackContent {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @returns {number} size of the content or -1 if not known
 	 */
 	getSize() {
@@ -985,6 +1005,7 @@ class PackContent {
 	}
 
 	/**
+	 * Processes the provided identifier.
 	 * @param {string} identifier identifier
 	 */
 	delete(identifier) {
@@ -994,6 +1015,7 @@ class PackContent {
 	}
 
 	/**
+	 * Processes the provided write.
 	 * @param {(lazy: LazyFunction) => (() => PackContentItems | Promise<PackContentItems>)} write write function
 	 * @returns {void}
 	 */
@@ -1086,6 +1108,7 @@ class PackContent {
 }
 
 /**
+ * Allow collecting memory.
  * @param {Buffer} buf buffer
  * @returns {Buffer} buffer that can be collected
  */
@@ -1099,6 +1122,7 @@ const allowCollectingMemory = (buf) => {
 
 class PackFileCacheStrategy {
 	/**
+	 * Creates an instance of PackFileCacheStrategy.
 	 * @param {object} options options
 	 * @param {Compiler} options.compiler the compiler
 	 * @param {IntermediateFileSystem} options.fs the filesystem
@@ -1110,7 +1134,7 @@ class PackFileCacheStrategy {
 	 * @param {number} options.maxAge max age of cache items
 	 * @param {boolean=} options.profile track and log detailed timing information for individual cache items
 	 * @param {boolean=} options.allowCollectingMemory allow to collect unused memory created during deserialization
-	 * @param {false | "gzip" | "brotli"=} options.compression compression used
+	 * @param {false | "gzip" | "brotli" | "zstd"=} options.compression compression used
 	 * @param {boolean=} options.readonly disable storing cache into filesystem
 	 */
 	constructor({
@@ -1158,15 +1182,21 @@ class PackFileCacheStrategy {
 		this.readonly = readonly;
 		/** @type {boolean | undefined} */
 		this.allowCollectingMemory = allowCollectingMemory;
-		/** @type {false | "gzip" | "brotli" | undefined} */
+		/** @type {false | "gzip" | "brotli" | "zstd" | undefined} */
 		this.compression = compression;
+		// eslint-disable-next-line n/no-unsupported-features/node-builtins
+		if (compression === "zstd" && !require("zlib").createZstdCompress) {
+			throw new Error("cache.compression: 'zstd' requires Node.js >= 22.15.0");
+		}
 		/** @type {string} */
 		this._extension =
 			compression === "brotli"
 				? ".pack.br"
 				: compression === "gzip"
 					? ".pack.gz"
-					: ".pack";
+					: compression === "zstd"
+						? ".pack.zst"
+						: ".pack";
 		/** @type {SnapshotOptions} */
 		this.snapshot = snapshot;
 		/** @type {BuildDependencies} */
@@ -1186,6 +1216,7 @@ class PackFileCacheStrategy {
 	}
 
 	/**
+	 * Returns pack.
 	 * @returns {Promise<Pack>} pack
 	 */
 	_getPack() {
@@ -1196,6 +1227,7 @@ class PackFileCacheStrategy {
 	}
 
 	/**
+	 * Returns the pack.
 	 * @returns {Promise<Pack>} the pack
 	 */
 	_openPack() {
@@ -1362,6 +1394,7 @@ class PackFileCacheStrategy {
 	}
 
 	/**
+	 * Returns promise.
 	 * @param {string} identifier unique name for the resource
 	 * @param {Etag | null} etag etag of the resource
 	 * @param {Data} data cached content
@@ -1376,6 +1409,7 @@ class PackFileCacheStrategy {
 	}
 
 	/**
+	 * Returns promise to the cached content.
 	 * @param {string} identifier unique name for the resource
 	 * @param {Etag | null} etag etag of the resource
 	 * @returns {Promise<Data>} promise to the cached content
@@ -1396,6 +1430,7 @@ class PackFileCacheStrategy {
 	}
 
 	/**
+	 * Stores build dependencies.
 	 * @param {FileSystemDependencies | Iterable<string>} dependencies dependencies to store
 	 */
 	storeBuildDependencies(dependencies) {
@@ -1429,6 +1464,7 @@ class PackFileCacheStrategy {
 					);
 					promise = new Promise(
 						/**
+						 * Handles the callback logic for this hook.
 						 * @param {(value?: undefined) => void} resolve resolve
 						 * @param {(reason?: Error) => void} reject reject
 						 */

package/lib/cache/ResolverCachePlugin.js

@@ -22,6 +22,7 @@ const makeSerializable = require("../util/makeSerializable");
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 
 /**
+ * Defines the sync hook type used by this module.
  * @template T
  * @typedef {import("tapable").SyncHook<T>} SyncHook
  */
@@ -30,15 +31,19 @@ const makeSerializable = require("../util/makeSerializable");
 
 class CacheEntry {
 	/**
+	 * Creates an instance of CacheEntry.
 	 * @param {ResolveRequest} result result
 	 * @param {Snapshot} snapshot snapshot
 	 */
 	constructor(result, snapshot) {
+		/** @type {ResolveRequest} */
 		this.result = result;
+		/** @type {Snapshot} */
 		this.snapshot = snapshot;
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize({ write }) {
@@ -47,6 +52,7 @@ class CacheEntry {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize({ read }) {
@@ -58,6 +64,7 @@ class CacheEntry {
 makeSerializable(CacheEntry, "webpack/lib/cache/ResolverCachePlugin");
 
 /**
+ * Adds the provided set to the cache entry.
  * @template T
  * @param {Set<T> | LazySet<T>} set set to add items to
  * @param {Set<T> | LazySet<T> | Iterable<T>} otherSet set to add items from
@@ -74,6 +81,7 @@ const addAllToSet = (set, otherSet) => {
 };
 
 /**
+ * Returns stringified version.
  * @template {object} T
  * @param {T} object an object
  * @param {boolean} excludeContext if true, context is not included in string
@@ -98,7 +106,7 @@ const PLUGIN_NAME = "ResolverCachePlugin";
 
 class ResolverCachePlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -135,6 +143,7 @@ class ResolverCachePlugin {
 		/** @typedef {ResolveRequest & { _ResolverCachePluginCacheMiss: true }} ResolveRequestWithCacheMiss */
 
 		/**
+		 * Processes the provided item cache.
 		 * @param {ItemCacheFacade} itemCache cache
 		 * @param {Resolver} resolver the resolver
 		 * @param {ResolveContext} resolveContext context for resolving meta info
@@ -175,6 +184,7 @@ class ResolverCachePlugin {
 					(yieldResult).push(obj);
 			}
 			/**
+			 * Processes the provided key.
 			 * @param {"fileDependencies" | "contextDependencies" | "missingDependencies"} key key
 			 */
 			const propagate = (key) => {
@@ -375,6 +385,7 @@ class ResolverCachePlugin {
 										}
 									};
 							/**
+							 * Process cache result.
 							 * @param {(Error | null)=} err error if any
 							 * @param {(CacheEntry | null)=} cacheEntry cache entry
 							 * @returns {void}

package/lib/cache/getLazyHashedEtag.js

@@ -13,17 +13,19 @@ const createHash = require("../util/createHash");
 /** @typedef {import("../util/Hash").HashFunction} HashFunction */
 
 /**
+ * Represents the lazy hashed etag runtime component.
  * @typedef {object} HashableObject
  * @property {(hash: Hash) => void} updateHash
  */
 
 class LazyHashedEtag {
 	/**
+	 * Creates an instance of LazyHashedEtag.
 	 * @param {HashableObject} obj object with updateHash method
 	 * @param {HashFunction} hashFunction the hash function to use
 	 */
 	constructor(obj, hashFunction = DEFAULTS.HASH_FUNCTION) {
-		/** @type {HashableObject} */
+		/** @type {HashableObject | undefined} */
 		this._obj = obj;
 		/** @type {undefined | string} */
 		this._hash = undefined;
@@ -32,13 +34,21 @@ class LazyHashedEtag {
 	}
 
 	/**
+	 * Returns a string representation.
 	 * @returns {string} hash of object
 	 */
 	toString() {
 		if (this._hash === undefined) {
 			const hash = createHash(this._hashFunction);
-			this._obj.updateHash(hash);
+			/** @type {HashableObject} */
+			(this._obj).updateHash(hash);
 			this._hash = hash.digest("base64");
+			// Drop the captured object once the hash is memoized. The hash is
+			// never reset, so we never need `_obj` again — and many callers
+			// (e.g. `SourceMapDevToolPlugin`, `RealContentHashPlugin`) capture
+			// a heavy `CachedSource` here that would otherwise stay reachable
+			// through this etag for the lifetime of the compilation cache.
+			this._obj = undefined;
 		}
 		return this._hash;
 	}
@@ -53,6 +63,7 @@ const mapStrings = new Map();
 const mapObjects = new WeakMap();
 
 /**
+ * Returns etag.
  * @param {HashableObject} obj object with updateHash method
  * @param {HashFunction=} hashFunction the hash function to use
  * @returns {LazyHashedEtag} etag

package/lib/cache/mergeEtags.js

@@ -9,11 +9,14 @@
 
 class MergedEtag {
 	/**
+	 * Creates an instance of MergedEtag.
 	 * @param {Etag} a first
 	 * @param {Etag} b second
 	 */
 	constructor(a, b) {
+		/** @type {Etag} */
 		this.a = a;
+		/** @type {Etag} */
 		this.b = b;
 	}
 
@@ -28,6 +31,7 @@ const dualObjectMap = new WeakMap();
 const objectStringMap = new WeakMap();
 
 /**
+ * Merges the provided values into a single result.
  * @param {Etag} a first
  * @param {Etag} b second
  * @returns {string | MergedEtag} result