webpack 5.99.6 → 5.99.7

package/lib/stats/DefaultStatsFactoryPlugin.js

@@ -307,6 +307,8 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
  * @property {StatsModuleTraceItem[]=} moduleTrace
  * @property {string=} details
  * @property {string=} stack
+ * @property {KnownStatsError=} cause
+ * @property {KnownStatsError[]=} errors
  * @property {string=} compilerPath
  */
 
@@ -336,6 +338,7 @@ const { makePathsRelative, parseResource } = require("../util/identifier");
  * @property {ExtractorsByOption<OriginRecord, StatsChunkOrigin>} chunkOrigin
  * @property {ExtractorsByOption<WebpackError, StatsError>} error
  * @property {ExtractorsByOption<WebpackError, StatsError>} warning
+ * @property {ExtractorsByOption<WebpackError, StatsError>} cause
  * @property {ExtractorsByOption<ModuleTrace, StatsModuleTraceItem>} moduleTraceItem
  * @property {ExtractorsByOption<Dependency, StatsModuleTraceDependency>} moduleTraceDependency
  */
@@ -405,47 +408,66 @@ const countWithChildren = (compilation, getItems) => {
 	return count;
 };
 
-/** @type {ExtractorsByOption<WebpackError | string, StatsError>} */
+/** @typedef {Error & { cause?: unknown }} ErrorWithCause */
+/** @typedef {Error & { errors: EXPECTED_ANY[] }} AggregateError */
+
+/** @type {ExtractorsByOption<string | ErrorWithCause | AggregateError | WebpackError, StatsError>} */
 const EXTRACT_ERROR = {
 	_: (object, error, context, { requestShortener }) => {
 		// TODO webpack 6 disallow strings in the errors/warnings list
 		if (typeof error === "string") {
 			object.message = error;
 		} else {
-			if (error.chunk) {
+			if (/** @type {WebpackError} */ (error).chunk) {
+				const chunk = /** @type {WebpackError} */ (error).chunk;
 				object.chunkName =
 					/** @type {string | undefined} */
-					(error.chunk.name);
-				object.chunkEntry = error.chunk.hasRuntime();
-				object.chunkInitial = error.chunk.canBeInitial();
+					(chunk.name);
+				object.chunkEntry = chunk.hasRuntime();
+				object.chunkInitial = chunk.canBeInitial();
 			}
-			if (error.file) {
-				object.file = error.file;
+
+			if (/** @type {WebpackError} */ (error).file) {
+				object.file = /** @type {WebpackError} */ (error).file;
 			}
-			if (error.module) {
-				object.moduleIdentifier = error.module.identifier();
-				object.moduleName = error.module.readableIdentifier(requestShortener);
+
+			if (/** @type {WebpackError} */ (error).module) {
+				object.moduleIdentifier =
+					/** @type {WebpackError} */
+					(error).module.identifier();
+				object.moduleName =
+					/** @type {WebpackError} */
+					(error).module.readableIdentifier(requestShortener);
 			}
-			if (error.loc) {
-				object.loc = formatLocation(error.loc);
+
+			if (/** @type {WebpackError} */ (error).loc) {
+				object.loc = formatLocation(/** @type {WebpackError} */ (error).loc);
 			}
+
 			object.message = error.message;
 		}
 	},
 	ids: (object, error, { compilation: { chunkGraph } }) => {
 		if (typeof error !== "string") {
-			if (error.chunk) {
-				object.chunkId = /** @type {ChunkId} */ (error.chunk.id);
+			if (/** @type {WebpackError} */ (error).chunk) {
+				object.chunkId = /** @type {ChunkId} */ (
+					/** @type {WebpackError} */
+					(error).chunk.id
+				);
 			}
-			if (error.module) {
+
+			if (/** @type {WebpackError} */ (error).module) {
 				object.moduleId =
 					/** @type {ModuleId} */
-					(chunkGraph.getModuleId(error.module));
+					(chunkGraph.getModuleId(/** @type {WebpackError} */ (error).module));
 			}
 		}
 	},
 	moduleTrace: (object, error, context, options, factory) => {
-		if (typeof error !== "string" && error.module) {
+		if (
+			typeof error !== "string" &&
+			/** @type {WebpackError} */ (error).module
+		) {
 			const {
 				type,
 				compilation: { moduleGraph }
@@ -454,7 +476,7 @@ const EXTRACT_ERROR = {
 			const visitedModules = new Set();
 			/** @type {ModuleTrace[]} */
 			const moduleTrace = [];
-			let current = error.module;
+			let current = /** @type {WebpackError} */ (error).module;
 			while (current) {
 				if (visitedModules.has(current)) break; // circular (technically impossible, but how knows)
 				visitedModules.add(current);
@@ -481,13 +503,44 @@ const EXTRACT_ERROR = {
 			(errorDetails === true ||
 				(type.endsWith(".error") && cachedGetErrors(compilation).length < 3))
 		) {
-			object.details = error.details;
+			object.details = /** @type {WebpackError} */ (error).details;
 		}
 	},
 	errorStack: (object, error) => {
 		if (typeof error !== "string") {
 			object.stack = error.stack;
 		}
+	},
+	errorCause: (object, error, context, options, factory) => {
+		if (
+			typeof error !== "string" &&
+			/** @type {ErrorWithCause} */ (error).cause
+		) {
+			const rawCause = /** @type {ErrorWithCause} */ (error).cause;
+			/** @type {Error} */
+			const cause =
+				typeof rawCause === "string"
+					? /** @type {Error} */ ({ message: rawCause })
+					: /** @type {Error} */ (rawCause);
+			const { type } = context;
+
+			object.cause = factory.create(`${type}.cause`, cause, context);
+		}
+	},
+	errorErrors: (object, error, context, options, factory) => {
+		if (
+			typeof error !== "string" &&
+			/** @type {AggregateError} */
+			(error).errors
+		) {
+			const { type } = context;
+			object.errors = factory.create(
+				`${type}.errors`,
+				/** @type {Error[]} */
+				(/** @type {AggregateError} */ (error).errors),
+				context
+			);
+		}
 	}
 };
 
@@ -1560,6 +1613,7 @@ const SIMPLE_EXTRACTORS = {
 	},
 	error: EXTRACT_ERROR,
 	warning: EXTRACT_ERROR,
+	cause: EXTRACT_ERROR,
 	moduleTraceItem: {
 		_: (object, { origin, module }, context, { requestShortener }, factory) => {
 			const {
@@ -2474,6 +2528,8 @@ const ITEM_NAMES = {
 	"compilation.namedChunkGroups[]": "chunkGroup",
 	"compilation.errors[]": "error",
 	"compilation.warnings[]": "warning",
+	"error.errors[]": "error",
+	"warning.errors[]": "error",
 	"chunk.modules[]": "module",
 	"chunk.rootModules[]": "module",
 	"chunk.origins[]": "chunkOrigin",
@@ -2515,6 +2571,8 @@ const MERGER = {
 	"compilation.namedChunkGroups": mergeToObject
 };
 
+const PLUGIN_NAME = "DefaultStatsFactoryPlugin";
+
 class DefaultStatsFactoryPlugin {
 	/**
 	 * Apply the plugin
@@ -2522,9 +2580,9 @@ class DefaultStatsFactoryPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		compiler.hooks.compilation.tap("DefaultStatsFactoryPlugin", compilation => {
+		compiler.hooks.compilation.tap(PLUGIN_NAME, compilation => {
 			compilation.hooks.statsFactory.tap(
-				"DefaultStatsFactoryPlugin",
+				PLUGIN_NAME,
 				/**
 				 * @param {StatsFactory} stats stats factory
 				 * @param {NormalizedStatsOptions} options stats options
@@ -2537,7 +2595,7 @@ class DefaultStatsFactoryPlugin {
 						(hookFor, fn) => {
 							stats.hooks.extract
 								.for(hookFor)
-								.tap("DefaultStatsFactoryPlugin", (obj, data, ctx) =>
+								.tap(PLUGIN_NAME, (obj, data, ctx) =>
 									fn(obj, data, ctx, options, stats)
 								);
 						}
@@ -2545,28 +2603,28 @@ class DefaultStatsFactoryPlugin {
 					iterateConfig(FILTER, options, (hookFor, fn) => {
 						stats.hooks.filter
 							.for(hookFor)
-							.tap("DefaultStatsFactoryPlugin", (item, ctx, idx, i) =>
+							.tap(PLUGIN_NAME, (item, ctx, idx, i) =>
 								fn(item, ctx, options, idx, i)
 							);
 					});
 					iterateConfig(FILTER_RESULTS, options, (hookFor, fn) => {
 						stats.hooks.filterResults
 							.for(hookFor)
-							.tap("DefaultStatsFactoryPlugin", (item, ctx, idx, i) =>
+							.tap(PLUGIN_NAME, (item, ctx, idx, i) =>
 								fn(item, ctx, options, idx, i)
 							);
 					});
 					iterateConfig(SORTERS, options, (hookFor, fn) => {
 						stats.hooks.sort
 							.for(hookFor)
-							.tap("DefaultStatsFactoryPlugin", (comparators, ctx) =>
+							.tap(PLUGIN_NAME, (comparators, ctx) =>
 								fn(comparators, ctx, options)
 							);
 					});
 					iterateConfig(RESULT_SORTERS, options, (hookFor, fn) => {
 						stats.hooks.sortResults
 							.for(hookFor)
-							.tap("DefaultStatsFactoryPlugin", (comparators, ctx) =>
+							.tap(PLUGIN_NAME, (comparators, ctx) =>
 								fn(comparators, ctx, options)
 							);
 					});
@@ -2577,27 +2635,25 @@ class DefaultStatsFactoryPlugin {
 						(hookFor, fn) => {
 							stats.hooks.groupResults
 								.for(hookFor)
-								.tap("DefaultStatsFactoryPlugin", (groupConfigs, ctx) =>
+								.tap(PLUGIN_NAME, (groupConfigs, ctx) =>
 									fn(groupConfigs, ctx, options)
 								);
 						}
 					);
 					for (const key of Object.keys(ITEM_NAMES)) {
 						const itemName = ITEM_NAMES[key];
-						stats.hooks.getItemName
-							.for(key)
-							.tap("DefaultStatsFactoryPlugin", () => itemName);
+						stats.hooks.getItemName.for(key).tap(PLUGIN_NAME, () => itemName);
 					}
 					for (const key of Object.keys(MERGER)) {
 						const merger = MERGER[key];
-						stats.hooks.merge.for(key).tap("DefaultStatsFactoryPlugin", merger);
+						stats.hooks.merge.for(key).tap(PLUGIN_NAME, merger);
 					}
 					if (options.children) {
 						if (Array.isArray(options.children)) {
 							stats.hooks.getItemFactory
 								.for("compilation.children[].compilation")
 								.tap(
-									"DefaultStatsFactoryPlugin",
+									PLUGIN_NAME,
 									/**
 									 * @param {Compilation} comp compilation
 									 * @param {StatsFactoryContext} options options
@@ -2620,7 +2676,7 @@ class DefaultStatsFactoryPlugin {
 							);
 							stats.hooks.getItemFactory
 								.for("compilation.children[].compilation")
-								.tap("DefaultStatsFactoryPlugin", () => childFactory);
+								.tap(PLUGIN_NAME, () => childFactory);
 						}
 					}
 				}

package/lib/stats/DefaultStatsPresetPlugin.js

@@ -55,6 +55,8 @@ const NAMED_PRESETS = {
 		optimizationBailout: true,
 		errorDetails: true,
 		errorStack: true,
+		errorCause: true,
+		errorErrors: true,
 		publicPath: true,
 		logging: "verbose",
 		orphanModules: true,
@@ -84,6 +86,8 @@ const NAMED_PRESETS = {
 		providedExports: true,
 		optimizationBailout: true,
 		errorDetails: true,
+		errorCause: true,
+		errorErrors: true,
 		publicPath: true,
 		logging: true,
 		runtimeModules: true,
@@ -260,6 +264,8 @@ const DEFAULTS = {
 	errorsCount: NORMAL_ON,
 	errorDetails: AUTO_FOR_TO_STRING,
 	errorStack: OFF_FOR_TO_STRING,
+	errorCause: AUTO_FOR_TO_STRING,
+	errorErrors: AUTO_FOR_TO_STRING,
 	warnings: NORMAL_ON,
 	warningsCount: NORMAL_ON,
 	publicPath: OFF_FOR_TO_STRING,
@@ -364,6 +370,8 @@ const NORMALIZER = {
 	}
 };
 
+const PLUGIN_NAME = "DefaultStatsPresetPlugin";
+
 class DefaultStatsPresetPlugin {
 	/**
 	 * Apply the plugin
@@ -371,35 +379,32 @@ class DefaultStatsPresetPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		compiler.hooks.compilation.tap("DefaultStatsPresetPlugin", compilation => {
+		compiler.hooks.compilation.tap(PLUGIN_NAME, compilation => {
 			for (const key of Object.keys(NAMED_PRESETS)) {
 				const defaults = NAMED_PRESETS[/** @type {keyof NamedPresets} */ (key)];
 				compilation.hooks.statsPreset
 					.for(key)
-					.tap("DefaultStatsPresetPlugin", (options, context) => {
+					.tap(PLUGIN_NAME, (options, context) => {
 						applyDefaults(options, defaults);
 					});
 			}
-			compilation.hooks.statsNormalize.tap(
-				"DefaultStatsPresetPlugin",
-				(options, context) => {
-					for (const key of Object.keys(DEFAULTS)) {
-						if (options[key] === undefined)
-							options[key] =
-								/** @type {Defaults[DefaultsKeys]} */
-								(DEFAULTS[/** @type {DefaultsKeys} */ (key)])(
-									options,
-									context,
-									compilation
-								);
-					}
-					for (const key of Object.keys(NORMALIZER)) {
+			compilation.hooks.statsNormalize.tap(PLUGIN_NAME, (options, context) => {
+				for (const key of Object.keys(DEFAULTS)) {
+					if (options[key] === undefined)
 						options[key] =
-							/** @type {TODO} */
-							(NORMALIZER[/** @type {NormalizerKeys} */ (key)])(options[key]);
-					}
+							/** @type {Defaults[DefaultsKeys]} */
+							(DEFAULTS[/** @type {DefaultsKeys} */ (key)])(
+								options,
+								context,
+								compilation
+							);
+				}
+				for (const key of Object.keys(NORMALIZER)) {
+					options[key] =
+						/** @type {TODO} */
+						(NORMALIZER[/** @type {NormalizerKeys} */ (key)])(options[key]);
 				}
-			);
+			});
 		});
 	}
 }