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

package/lib/MultiCompiler.js

@@ -8,17 +8,19 @@
 const asyncLib = require("neo-async");
 const { MultiHook, SyncHook } = require("tapable");
 
-const ConcurrentCompilationError = require("./ConcurrentCompilationError");
 const MultiStats = require("./MultiStats");
 const MultiWatching = require("./MultiWatching");
-const WebpackError = require("./WebpackError");
+const ConcurrentCompilationError = require("./errors/ConcurrentCompilationError");
+const WebpackError = require("./errors/WebpackError");
 const ArrayQueue = require("./util/ArrayQueue");
 
 /**
+ * Defines the shared type used by this module.
  * @template T
  * @typedef {import("tapable").AsyncSeriesHook<T>} AsyncSeriesHook<T>
  */
 /**
+ * Defines the shared type used by this module.
  * @template T
  * @template R
  * @typedef {import("tapable").SyncBailHook<T, R>} SyncBailHook<T, R>
@@ -27,6 +29,7 @@ const ArrayQueue = require("./util/ArrayQueue");
 /** @typedef {import("../declarations/WebpackOptions").WatchOptions} WatchOptions */
 /** @typedef {import("./Compiler")} Compiler */
 /**
+ * Defines the callback type used by this module.
  * @template T
  * @template [R=void]
  * @typedef {import("./webpack").Callback<T, R>} Callback
@@ -40,6 +43,7 @@ const ArrayQueue = require("./util/ArrayQueue");
 /** @typedef {import("./util/fs").WatchFileSystem} WatchFileSystem */
 
 /**
+ * Defines the run with dependencies handler callback.
  * @callback RunWithDependenciesHandler
  * @param {Compiler} compiler
  * @param {Callback<MultiStats>} callback
@@ -47,6 +51,7 @@ const ArrayQueue = require("./util/ArrayQueue");
  */
 
 /**
+ * Defines the multi compiler options type used by this module.
  * @typedef {object} MultiCompilerOptions
  * @property {number=} parallelism how many Compilers are allows to run at the same time in parallel
  */
@@ -57,6 +62,7 @@ const CLASS_NAME = "MultiCompiler";
 
 module.exports = class MultiCompiler {
 	/**
+	 * Creates an instance of MultiCompiler.
 	 * @param {Compiler[] | Record<string, Compiler>} compilers child compilers
 	 * @param {MultiCompilerOptions} options options
 	 */
@@ -86,6 +92,7 @@ module.exports = class MultiCompiler {
 				compilers.map((c) => c.hooks.infrastructureLog)
 			)
 		});
+		/** @type {Compiler[]} */
 		this.compilers = compilers;
 		/** @type {MultiCompilerOptions} */
 		this._options = {
@@ -93,7 +100,10 @@ module.exports = class MultiCompiler {
 		};
 		/** @type {WeakMap<Compiler, string[]>} */
 		this.dependencies = new WeakMap();
+		/** @type {boolean} */
 		this.running = false;
+		/** @type {MultiWatching | undefined} */
+		this.watching = undefined;
 
 		/** @type {(Stats | null)[]} */
 		const compilerStats = this.compilers.map(() => null);
@@ -122,6 +132,20 @@ module.exports = class MultiCompiler {
 					doneCompilers--;
 				}
 			});
+			// Release fields on this child's Compilation once it's done. The
+			// stage: Infinity tap runs after every afterDone tap at a lower
+			// stage, so plugins observing compilation state in afterDone still
+			// see it intact. Stats remains usable; only fields Stats never reads
+			// (and that the persistent cache never serializes) are dropped.
+
+			compiler.hooks.afterDone.tap(
+				{ name: CLASS_NAME, stage: Infinity },
+				(stats) => {
+					if (stats !== undefined) {
+						compiler._releaseUnusedCompilationData(stats.compilation);
+					}
+				}
+			);
 		}
 		this._validateCompilersOptions();
 	}
@@ -129,6 +153,7 @@ module.exports = class MultiCompiler {
 	_validateCompilersOptions() {
 		if (this.compilers.length < 2) return;
 		/**
+		 * Adds the provided compiler to the multi compiler.
 		 * @param {Compiler} compiler compiler
 		 * @param {WebpackError} warning warning
 		 */
@@ -187,6 +212,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Sets input file system.
 	 * @param {InputFileSystem} value the new input file system
 	 */
 	set inputFileSystem(value) {
@@ -200,6 +226,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Sets output file system.
 	 * @param {OutputFileSystem} value the new output file system
 	 */
 	set outputFileSystem(value) {
@@ -213,6 +240,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Sets watch file system.
 	 * @param {WatchFileSystem} value the new watch file system
 	 */
 	set watchFileSystem(value) {
@@ -222,6 +250,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Sets intermediate file system.
 	 * @param {IntermediateFileSystem} value the new intermediate file system
 	 */
 	set intermediateFileSystem(value) {
@@ -235,6 +264,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Gets infrastructure logger.
 	 * @param {string | (() => string)} name name of the logger, or function called once to get the logger name
 	 * @returns {Logger} a logger with that name
 	 */
@@ -243,6 +273,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Updates dependencies using the provided compiler.
 	 * @param {Compiler} compiler the child compiler
 	 * @param {string[]} dependencies its dependencies
 	 * @returns {void}
@@ -252,6 +283,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Validate dependencies.
 	 * @param {Callback<MultiStats>} callback signals when the validation is complete
 	 * @returns {boolean} true if the dependencies are valid
 	 */
@@ -261,6 +293,7 @@ module.exports = class MultiCompiler {
 		/** @type {string[]} */
 		const missing = [];
 		/**
+		 * Returns target was found.
 		 * @param {Compiler} compiler compiler
 		 * @returns {boolean} target was found
 		 */
@@ -273,6 +306,7 @@ module.exports = class MultiCompiler {
 			return false;
 		};
 		/**
+		 * Returns result.
 		 * @param {{ source: Compiler, target: Compiler }} e1 edge 1
 		 * @param {{ source: Compiler, target: Compiler }} e2 edge 2
 		 * @returns {number} result
@@ -333,6 +367,7 @@ module.exports = class MultiCompiler {
 
 	// TODO webpack 6 remove
 	/**
+	 * Run with dependencies.
 	 * @deprecated This method should have been private
 	 * @param {Compiler[]} compilers the child compilers
 	 * @param {RunWithDependenciesHandler} fn a handler to run for each compiler
@@ -344,11 +379,13 @@ module.exports = class MultiCompiler {
 		const fulfilledNames = new Set();
 		let remainingCompilers = compilers;
 		/**
+		 * Checks whether this multi compiler is dependency fulfilled.
 		 * @param {string} d dependency
 		 * @returns {boolean} when dependency was fulfilled
 		 */
 		const isDependencyFulfilled = (d) => fulfilledNames.has(d);
 		/**
+		 * Gets ready compilers.
 		 * @returns {Compiler[]} compilers
 		 */
 		const getReadyCompilers = () => {
@@ -369,6 +406,7 @@ module.exports = class MultiCompiler {
 			return readyCompilers;
 		};
 		/**
+		 * Processes the provided stat.
 		 * @param {Callback<Stats[]>} callback callback
 		 * @returns {void}
 		 */
@@ -392,6 +430,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Returns result of setup.
 	 * @template SetupResult
 	 * @param {(compiler: Compiler, index: number, doneCallback: Callback<Stats>, isBlocked: () => boolean, setChanged: () => void, setInvalid: () => void) => SetupResult} setup setup a single compiler
 	 * @param {(compiler: Compiler, setupResult: SetupResult, callback: Callback<Stats>) => void} run run/continue a single compiler
@@ -448,6 +487,7 @@ module.exports = class MultiCompiler {
 		let running = 0;
 		const parallelism = /** @type {number} */ (this._options.parallelism);
 		/**
+		 * Processes the provided node.
 		 * @param {Node} node node
 		 * @param {(Error | null)=} err error
 		 * @param {Stats=} stats result
@@ -483,6 +523,7 @@ module.exports = class MultiCompiler {
 			processQueue();
 		};
 		/**
+		 * Node invalid from parent.
 		 * @param {Node} node node
 		 * @returns {void}
 		 */
@@ -497,6 +538,7 @@ module.exports = class MultiCompiler {
 			}
 		};
 		/**
+		 * Processes the provided node.
 		 * @param {Node} node node
 		 * @returns {void}
 		 */
@@ -511,6 +553,7 @@ module.exports = class MultiCompiler {
 			}
 		};
 		/**
+		 * Processes the provided node.
 		 * @param {Node} node node
 		 * @returns {void}
 		 */
@@ -589,6 +632,7 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Returns a compiler watcher.
 	 * @param {WatchOptions | WatchOptions[]} watchOptions the watcher's options
 	 * @param {Callback<MultiStats>} handler signals when the call finishes
 	 * @returns {MultiWatching | undefined} a compiler watcher
@@ -620,13 +664,16 @@ module.exports = class MultiCompiler {
 				},
 				handler
 			);
-			return new MultiWatching(watchings, this);
+			this.watching = new MultiWatching(watchings, this);
+			return this.watching;
 		}
 
-		return new MultiWatching([], this);
+		this.watching = new MultiWatching([], this);
+		return this.watching;
 	}
 
 	/**
+	 * Processes the provided multi stat.
 	 * @param {Callback<MultiStats>} callback signals when the call finishes
 	 * @returns {void}
 	 */
@@ -661,10 +708,18 @@ module.exports = class MultiCompiler {
 	}
 
 	/**
+	 * Processes the provided error callback.
 	 * @param {ErrorCallback} callback signals when the compiler closes
 	 * @returns {void}
 	 */
 	close(callback) {
+		if (this.watching) {
+			// When there is still an active watching, close this first
+			this.watching.close((_err) => {
+				this.close(callback);
+			});
+			return;
+		}
 		asyncLib.each(
 			this.compilers,
 			(compiler, callback) => {

package/lib/MultiStats.js

@@ -17,6 +17,7 @@ const identifierUtils = require("./util/identifier");
 /** @typedef {import("./stats/DefaultStatsFactoryPlugin").StatsError} StatsError */
 
 /**
+ * Returns indent.
  * @param {string} str string
  * @param {string} prefix pref
  * @returns {string} indent
@@ -31,9 +32,11 @@ const indent = (str, prefix) => {
 
 class MultiStats {
 	/**
+	 * Creates an instance of MultiStats.
 	 * @param {Stats[]} stats the child stats
 	 */
 	constructor(stats) {
+		/** @type {Stats[]} */
 		this.stats = stats;
 	}
 
@@ -42,6 +45,7 @@ class MultiStats {
 	}
 
 	/**
+	 * Checks whether this multi stats has errors.
 	 * @returns {boolean} true if a child compilation encountered an error
 	 */
 	hasErrors() {
@@ -49,6 +53,7 @@ class MultiStats {
 	}
 
 	/**
+	 * Checks whether this multi stats has warnings.
 	 * @returns {boolean} true if a child compilation had a warning
 	 */
 	hasWarnings() {
@@ -56,6 +61,7 @@ class MultiStats {
 	}
 
 	/**
+	 * Create child options.
 	 * @param {undefined | StatsValue} options stats options
 	 * @param {CreateStatsOptionsContext} context context
 	 * @returns {ChildOptions} context context
@@ -109,6 +115,7 @@ class MultiStats {
 	}
 
 	/**
+	 * Returns json output.
 	 * @param {StatsValue=} options stats options
 	 * @returns {StatsCompilation} json output
 	 */
@@ -138,6 +145,7 @@ class MultiStats {
 			obj.hash = obj.children.map((j) => j.hash).join("");
 		}
 		/**
+		 * Returns result.
 		 * @param {StatsCompilation} j stats error
 		 * @param {StatsError} obj Stats error
 		 * @returns {StatsError} result
@@ -184,6 +192,7 @@ class MultiStats {
 	}
 
 	/**
+	 * Returns a string representation.
 	 * @param {StatsValue=} options stats options
 	 * @returns {string} string output
 	 */

package/lib/MultiWatching.js

@@ -13,15 +13,19 @@ const asyncLib = require("neo-async");
 
 class MultiWatching {
 	/**
+	 * Creates an instance of MultiWatching.
 	 * @param {Watching[]} watchings child compilers' watchers
 	 * @param {MultiCompiler} compiler the compiler
 	 */
 	constructor(watchings, compiler) {
+		/** @type {Watching[]} */
 		this.watchings = watchings;
+		/** @type {MultiCompiler} */
 		this.compiler = compiler;
 	}
 
 	/**
+	 * Processes the provided error callback.
 	 * @param {ErrorCallback=} callback signals when the build has completed again
 	 * @returns {void}
 	 */
@@ -54,6 +58,7 @@ class MultiWatching {
 	}
 
 	/**
+	 * Processes the provided error callback.
 	 * @param {ErrorCallback} callback signals when the watcher is closed
 	 * @returns {void}
 	 */
@@ -64,6 +69,7 @@ class MultiWatching {
 				watching.close(finishedCallback);
 			},
 			(err) => {
+				if (this.compiler.watching === this) this.compiler.watching = undefined;
 				this.compiler.hooks.watchClose.call();
 				if (typeof callback === "function") {
 					this.compiler.running = false;

package/lib/NoEmitOnErrorsPlugin.js

@@ -11,7 +11,7 @@ const PLUGIN_NAME = "NoEmitOnErrorsPlugin";
 
 class NoEmitOnErrorsPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */