webpack 5.76.1 → 5.88.2

package/lib/FileSystemInfo.js

@@ -18,6 +18,8 @@ const processAsyncTree = require("./util/processAsyncTree");
 
 /** @typedef {import("./WebpackError")} WebpackError */
 /** @typedef {import("./logging/Logger").Logger} Logger */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {typeof import("./util/Hash")} Hash */
 /** @typedef {import("./util/fs").IStats} IStats */
 /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
@@ -97,8 +99,8 @@ const INVALID = Symbol("invalid");
  * @typedef {Object} SnapshotOptimizationEntry
  * @property {Snapshot} snapshot
  * @property {number} shared
- * @property {Set<string>} snapshotContent
- * @property {Set<SnapshotOptimizationEntry>} children
+ * @property {Set<string> | undefined} snapshotContent
+ * @property {Set<SnapshotOptimizationEntry> | undefined} children
  */
 
 /**
@@ -113,6 +115,12 @@ const INVALID = Symbol("invalid");
  * @property {Set<string>} resolveDependencies.missing list of missing entries
  */
 
+/**
+ * @typedef {Object} SnapshotOptions
+ * @property {boolean=} hash should use hash to snapshot
+ * @property {boolean=} timestamp should use timestamp to snapshot
+ */
+
 const DONE_ITERATOR_RESULT = new Set().keys().next();
 
 // cspell:word tshs
@@ -135,7 +143,7 @@ class SnapshotIterable {
 		let state = 0;
 		/** @type {IterableIterator<string>} */
 		let it;
-		/** @type {(Snapshot) => (Map<string, any> | Set<string>)[]} */
+		/** @type {(snapshot: Snapshot) => (Map<string, any> | Set<string>)[]} */
 		let getMaps;
 		/** @type {(Map<string, any> | Set<string>)[]} */
 		let maps;
@@ -378,6 +386,9 @@ class Snapshot {
 		this.children.add(child);
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize({ write }) {
 		write(this._flags);
 		if (this.hasStartTime()) write(this.startTime);
@@ -395,6 +406,9 @@ class Snapshot {
 		if (this.hasChildren()) write(this.children);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize({ read }) {
 		this._flags = read();
 		if (this.hasStartTime()) this.startTime = read();
@@ -544,7 +558,7 @@ class SnapshotOptimization {
 			}
 		};
 
-		/** @type {SnapshotOptimizationEntry} */
+		/** @type {SnapshotOptimizationEntry | undefined} */
 		let newOptimizationEntry = undefined;
 
 		const capturedFilesSize = capturedFiles.size;
@@ -749,10 +763,9 @@ const mergeMaps = (a, b) => {
 
 /**
  * @template T
- * @template K
- * @param {Set<T, K>} a source map
- * @param {Set<T, K>} b joining map
- * @returns {Set<T, K>} joined map
+ * @param {Set<T>} a source map
+ * @param {Set<T>} b joining map
+ * @returns {Set<T>} joined map
  */
 const mergeSets = (a, b) => {
 	if (!b || b.size === 0) return a;
@@ -850,8 +863,8 @@ const getManagedItem = (managedPath, path) => {
 
 /**
  * @template {ContextFileSystemInfoEntry | ContextTimestampAndHash} T
- * @param {T} entry entry
- * @returns {T["resolved"] | undefined} the resolved entry
+ * @param {T | null} entry entry
+ * @returns {T["resolved"] | null | undefined} the resolved entry
  */
 const getResolvedTimestamp = entry => {
 	if (entry === null) return null;
@@ -860,8 +873,8 @@ const getResolvedTimestamp = entry => {
 };
 
 /**
- * @param {ContextHash} entry entry
- * @returns {string | undefined} the resolved entry
+ * @param {ContextHash | null} entry entry
+ * @returns {string | null | undefined} the resolved entry
  */
 const getResolvedHash = entry => {
 	if (entry === null) return null;
@@ -869,6 +882,11 @@ const getResolvedHash = entry => {
 	return entry.symlinks === undefined ? entry.hash : undefined;
 };
 
+/**
+ * @template T
+ * @param {Set<T>} source source
+ * @param {Set<T>} target target
+ */
 const addAll = (source, target) => {
 	for (const key of source) target.add(key);
 };
@@ -1137,6 +1155,11 @@ class FileSystemInfo {
 		);
 	}
 
+	/**
+	 * @param {string} path path
+	 * @param {string} reason reason
+	 * @param {any[]} args arguments
+	 */
 	_log(path, reason, ...args) {
 		const key = path + reason;
 		if (this._loggedPaths.has(key)) return;
@@ -1250,7 +1273,7 @@ class FileSystemInfo {
 
 	/**
 	 * @param {string} path file path
-	 * @param {function((WebpackError | null)=, string=): void} callback callback function
+	 * @param {function((WebpackError | null)=, (string | null)=): void} callback callback function
 	 * @returns {void}
 	 */
 	getFileHash(path, callback) {
@@ -1281,7 +1304,7 @@ class FileSystemInfo {
 
 	/**
 	 * @param {string} path context path
-	 * @param {function((WebpackError | null)=, ContextHash=): void} callback callback function
+	 * @param {function((WebpackError | null)=, (ContextHash | null)=): void} callback callback function
 	 * @returns {void}
 	 */
 	_getUnresolvedContextHash(path, callback) {
@@ -1312,7 +1335,7 @@ class FileSystemInfo {
 
 	/**
 	 * @param {string} path context path
-	 * @param {function((WebpackError | null)=, ContextTimestampAndHash=): void} callback callback function
+	 * @param {function((WebpackError | null)=, (ContextTimestampAndHash | null)=): void} callback callback function
 	 * @returns {void}
 	 */
 	_getUnresolvedContextTsh(path, callback) {
@@ -1375,7 +1398,7 @@ class FileSystemInfo {
 		const resolveDirectories = new Set();
 		/** @type {Set<string>} */
 		const resolveMissing = new Set();
-		/** @type {Map<string, string | false>} */
+		/** @type {Map<string, string | false | undefined>} */
 		const resolveResults = new Map();
 		const invalidResolveResults = new Set();
 		const resolverContext = {
@@ -1383,6 +1406,10 @@ class FileSystemInfo {
 			contextDependencies: resolveDirectories,
 			missingDependencies: resolveMissing
 		};
+		/**
+		 * @param {string} expected expected result
+		 * @returns {string} expected result
+		 */
 		const expectedToString = expected => {
 			return expected ? ` (expected ${expected})` : "";
 		};
@@ -1456,7 +1483,7 @@ class FileSystemInfo {
 						push({
 							type: RBDT_DIRECTORY,
 							context: undefined,
-							path: resultPath,
+							path: /** @type {string} */ (resultPath),
 							expected: undefined,
 							issuer: job
 						});
@@ -1602,7 +1629,7 @@ class FileSystemInfo {
 							break;
 						}
 						// Check commonjs cache for the module
-						/** @type {NodeModule} */
+						/** @type {NodeModule | undefined} */
 						const module = require.cache[path];
 						if (module && Array.isArray(module.children)) {
 							children: for (const child of module.children) {
@@ -1902,13 +1929,11 @@ class FileSystemInfo {
 
 	/**
 	 *
-	 * @param {number} startTime when processing the files has started
+	 * @param {number | null | undefined} startTime when processing the files has started
 	 * @param {Iterable<string>} files all files
 	 * @param {Iterable<string>} directories all directories
 	 * @param {Iterable<string>} missing all missing files or directories
-	 * @param {Object} options options object (for future extensions)
-	 * @param {boolean=} options.hash should use hash to snapshot
-	 * @param {boolean=} options.timestamp should use timestamp to snapshot
+	 * @param {SnapshotOptions | null | undefined} options options object (for future extensions)
 	 * @param {function((WebpackError | null)=, (Snapshot | null)=): void} callback callback function
 	 * @returns {void}
 	 */
@@ -2045,6 +2070,9 @@ class FileSystemInfo {
 			}
 			return capturedItems;
 		};
+		/**
+		 * @param {Set<string>} capturedFiles captured files
+		 */
 		const processCapturedFiles = capturedFiles => {
 			switch (mode) {
 				case 3:
@@ -2631,6 +2659,10 @@ class FileSystemInfo {
 				}
 			}
 		}
+		/**
+		 * @param {string} path file path
+		 * @param {string} hash hash
+		 */
 		const processFileHashSnapshot = (path, hash) => {
 			const cache = this._fileHashes.get(path);
 			if (cache !== undefined) {
@@ -2913,7 +2945,7 @@ class FileSystemInfo {
 
 			const hash = createHash(this._hashFunction);
 
-			hash.update(content);
+			hash.update(/** @type {string | Buffer} */ (content));
 
 			const digest = /** @type {string} */ (hash.digest("hex"));
 
@@ -2977,7 +3009,7 @@ class FileSystemInfo {
 	 * @param {function(string, IStats, function(Error=, ItemType=): void): void} options.fromFile called when context item is a file
 	 * @param {function(string, IStats, function(Error=, ItemType=): void): void} options.fromDirectory called when context item is a directory
 	 * @param {function(string[], ItemType[]): T} options.reduce called from all context items
-	 * @param {function((Error | null)=, (T)=): void} callback callback
+	 * @param {function((Error | null)=, (T | null)=): void} callback callback
 	 */
 	_readContext(
 		{
@@ -3164,6 +3196,7 @@ class FileSystemInfo {
 	 * @returns {void}
 	 */
 	_resolveContextTimestamp(entry, callback) {
+		/** @type {string[]} */
 		const hashes = [];
 		let safeTime = 0;
 		processAsyncTree(
@@ -3272,6 +3305,7 @@ class FileSystemInfo {
 	 * @returns {void}
 	 */
 	_resolveContextHash(entry, callback) {
+		/** @type {string[]} */
 		const hashes = [];
 		processAsyncTree(
 			entry.symlinks,
@@ -3428,7 +3462,9 @@ class FileSystemInfo {
 	 * @returns {void}
 	 */
 	_resolveContextTsh(entry, callback) {
+		/** @type {string[]} */
 		const hashes = [];
+		/** @type {string[]} */
 		const tsHashes = [];
 		let safeTime = 0;
 		processAsyncTree(
@@ -3546,7 +3582,7 @@ class FileSystemInfo {
 				}
 				let data;
 				try {
-					data = JSON.parse(content.toString("utf-8"));
+					data = JSON.parse(/** @type {Buffer} */ (content).toString("utf-8"));
 				} catch (e) {
 					return callback(e);
 				}

package/lib/FlagAllModulesAsUsedPlugin.js

@@ -8,9 +8,14 @@
 const { getEntryRuntime, mergeRuntimeOwned } = require("./util/runtime");
 
 /** @typedef {import("./Compiler")} Compiler */
+/** @typedef {import("./Module").FactoryMeta} FactoryMeta */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
+const PLUGIN_NAME = "FlagAllModulesAsUsedPlugin";
 class FlagAllModulesAsUsedPlugin {
+	/**
+	 * @param {string} explanation explanation
+	 */
 	constructor(explanation) {
 		this.explanation = explanation;
 	}
@@ -21,34 +26,29 @@ class FlagAllModulesAsUsedPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		compiler.hooks.compilation.tap(
-			"FlagAllModulesAsUsedPlugin",
-			compilation => {
-				const moduleGraph = compilation.moduleGraph;
-				compilation.hooks.optimizeDependencies.tap(
-					"FlagAllModulesAsUsedPlugin",
-					modules => {
-						/** @type {RuntimeSpec} */
-						let runtime = undefined;
-						for (const [name, { options }] of compilation.entries) {
-							runtime = mergeRuntimeOwned(
-								runtime,
-								getEntryRuntime(compilation, name, options)
-							);
-						}
-						for (const module of modules) {
-							const exportsInfo = moduleGraph.getExportsInfo(module);
-							exportsInfo.setUsedInUnknownWay(runtime);
-							moduleGraph.addExtraReason(module, this.explanation);
-							if (module.factoryMeta === undefined) {
-								module.factoryMeta = {};
-							}
-							module.factoryMeta.sideEffectFree = false;
-						}
+		compiler.hooks.compilation.tap(PLUGIN_NAME, compilation => {
+			const moduleGraph = compilation.moduleGraph;
+			compilation.hooks.optimizeDependencies.tap(PLUGIN_NAME, modules => {
+				/** @type {RuntimeSpec} */
+				let runtime = undefined;
+				for (const [name, { options }] of compilation.entries) {
+					runtime = mergeRuntimeOwned(
+						runtime,
+						getEntryRuntime(compilation, name, options)
+					);
+				}
+				for (const module of modules) {
+					const exportsInfo = moduleGraph.getExportsInfo(module);
+					exportsInfo.setUsedInUnknownWay(runtime);
+					moduleGraph.addExtraReason(module, this.explanation);
+					if (module.factoryMeta === undefined) {
+						module.factoryMeta = {};
 					}
-				);
-			}
-		);
+					/** @type {FactoryMeta} */
+					(module.factoryMeta).sideEffectFree = false;
+				}
+			});
+		});
 	}
 }