webpack 5.109.1 → 5.109.2

package/README.md

@@ -629,6 +629,10 @@ Before we started using OpenCollective, donations were made anonymously. Now tha
 <a href="https://opencollective.com/webpack/backer/99/website?requireActive=false" target="_blank"><img width="30" src="https://opencollective.com/webpack/backer/99/avatar.svg?requireActive=false"></a>
 <a href="https://opencollective.com/webpack/backer/100/website?requireActive=false" target="_blank"><img width="30" src="https://opencollective.com/webpack/backer/100/avatar.svg?requireActive=false"></a>
 
+## Other Partners
+
+- [CodSpeed](https://codspeed.io/?utm_source=webpack&utm_medium=readme) for generously supporting us with benchmarks on their paid runners.
+
 ## Special Thanks to
 
 <p>(In chronological order)</p>

package/lib/CleanPlugin.js

@@ -22,10 +22,17 @@ const processAsyncTree = require("./util/processAsyncTree");
 
 /** @typedef {Map<string, number>} Assets */
 
+const createCompilationHooks = () => ({
+	/**
+	 * When returning true the file/directory will be kept during cleaning, returning false will clean it and ignore the following plugins and config.
+	 * @type {SyncBailHook<[string], boolean | void>}
+	 * @since 5.20.0
+	 */
+	keep: new SyncBailHook(["ignore"])
+});
+
 /**
- * Defines the clean plugin compilation hooks type used by this module.
- * @typedef {object} CleanPluginCompilationHooks
- * @property {SyncBailHook<[string], boolean | void>} keep when returning true the file/directory will be kept during cleaning, returning false will clean it and ignore the following plugins and config
+ * @typedef {ReturnType<typeof createCompilationHooks>} CleanPluginCompilationHooks
  */
 
 /**
@@ -484,12 +491,7 @@ class CleanPlugin {
 	}
 }
 
-CleanPlugin.getCompilationHooks = createHooksRegistry(
-	() =>
-		/** @type {CleanPluginCompilationHooks} */ ({
-			keep: new SyncBailHook(["ignore"])
-		})
-);
+CleanPlugin.getCompilationHooks = createHooksRegistry(createCompilationHooks);
 
 module.exports = CleanPlugin;
 module.exports._getDirectories = getDirectories;

package/lib/Compilation.js

@@ -884,9 +884,15 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
 				"runtime"
 			]),
 
-			/** @type {SyncHook<[ExecuteModuleArgument, ExecuteModuleContext]>} */
+			/**
+			 * @type {SyncHook<[ExecuteModuleArgument, ExecuteModuleContext]>}
+			 * @since 5.32.0
+			 */
 			executeModule: new SyncHook(["options", "context"]),
-			/** @type {AsyncParallelHook<[ExecuteModuleArgument, ExecuteModuleContext]>} */
+			/**
+			 * @type {AsyncParallelHook<[ExecuteModuleArgument, ExecuteModuleContext]>}
+			 * @since 5.33.0
+			 */
 			prepareModuleExecution: new AsyncParallelHook(["options", "context"]),
 
 			/** @type {AsyncSeriesHook<[Iterable<Module>]>} */
@@ -1090,7 +1096,10 @@ BREAKING CHANGE: Asset processing hooks in Compilation has been merged into a si
 
 			processAssets: processAssetsHook,
 			afterProcessAssets: afterProcessAssetsHook,
-			/** @type {AsyncSeriesHook<[CompilationAssets]>} */
+			/**
+			 * @type {AsyncSeriesHook<[CompilationAssets]>}
+			 * @since 5.8.0
+			 */
 			processAdditionalAssets: new AsyncSeriesHook(["assets"]),
 
 			/** @type {SyncBailHook<[], boolean | void>} */

package/lib/Compiler.js

@@ -222,9 +222,15 @@ class Compiler {
 			/** @type {AsyncSeriesHook<[Compilation]>} */
 			afterCompile: new AsyncSeriesHook(["compilation"]),
 
-			/** @type {AsyncSeriesHook<[]>} */
+			/**
+			 * @type {AsyncSeriesHook<[]>}
+			 * @since 5.67.0
+			 */
 			readRecords: new AsyncSeriesHook([]),
-			/** @type {AsyncSeriesHook<[]>} */
+			/**
+			 * @type {AsyncSeriesHook<[]>}
+			 * @since 5.67.0
+			 */
 			emitRecords: new AsyncSeriesHook([]),
 
 			/** @type {AsyncSeriesHook<[Compiler]>} */
@@ -235,7 +241,10 @@ class Compiler {
 			invalid: new SyncHook(["filename", "changeTime"]),
 			/** @type {SyncHook<[]>} */
 			watchClose: new SyncHook([]),
-			/** @type {AsyncSeriesHook<[]>} */
+			/**
+			 * @type {AsyncSeriesHook<[]>}
+			 * @since 5.17.0
+			 */
 			shutdown: new AsyncSeriesHook([]),
 
 			/** @type {SyncBailHook<[string, string, EXPECTED_ANY[] | undefined], true | void>} */
@@ -243,7 +252,10 @@ class Compiler {
 
 			// TODO the following hooks are weirdly located here
 			// TODO move them for webpack 5
-			/** @type {SyncHook<[]>} */
+			/**
+			 * @type {SyncHook<[]>}
+			 * @since 5.106.0
+			 */
 			validate: new SyncHook([]),
 			/** @type {SyncHook<[]>} */
 			environment: new SyncHook([]),

package/lib/DefinePlugin.js

@@ -628,6 +628,14 @@ const getRuntimeRequirements = (code) => {
 		: [RuntimeGlobals.requireScope];
 };
 
+const createCompilationHooks = () => ({
+	/**
+	 * @type {SyncWaterfallHook<[Record<string, CodeValue>]>}
+	 * @since 5.104.0
+	 */
+	definitions: new SyncWaterfallHook(["definitions"])
+});
+
 /**
  * Prefixes an evaluation error with the offending define key so a bare
  * "Unexpected token" becomes actionable. The original error is mutated and
@@ -649,9 +657,7 @@ const annotateEvaluationError = (key, code, error) => {
 };
 
 /**
- * Defines the define plugin hooks type used by this module.
- * @typedef {object} DefinePluginHooks
- * @property {SyncWaterfallHook<[Record<string, CodeValue>]>} definitions
+ * @typedef {ReturnType<typeof createCompilationHooks>} DefinePluginHooks
  */
 
 /** @typedef {Record<string, CodeValue>} Definitions */
@@ -1259,12 +1265,7 @@ class DefinePlugin {
 	}
 }
 
-DefinePlugin.getCompilationHooks = createHooksRegistry(
-	() =>
-		/** @type {DefinePluginHooks} */ ({
-			definitions: new SyncWaterfallHook(["definitions"])
-		})
-);
+DefinePlugin.getCompilationHooks = createHooksRegistry(createCompilationHooks);
 
 module.exports = DefinePlugin;
 module.exports.VALUE_DEP_MAIN = VALUE_DEP_MAIN;

package/lib/ExternalModule.js

@@ -810,10 +810,16 @@ const getSourceForDefaultCase = (optional, request, runtimeTemplate) => {
 /** @typedef {Record<string, string | string[]>} RequestRecord */
 /** @typedef {string | string[] | RequestRecord} ExternalModuleRequest */
 
+const createCompilationHooks = () => ({
+	/**
+	 * @type {SyncBailHook<[Chunk, Compilation], boolean>}
+	 * @since 5.106.0
+	 */
+	chunkCondition: new SyncBailHook(["chunk", "compilation"])
+});
+
 /**
- * Defines the external module hooks type used by this module.
- * @typedef {object} ExternalModuleHooks
- * @property {SyncBailHook<[Chunk, Compilation], boolean>} chunkCondition
+ * @typedef {ReturnType<typeof createCompilationHooks>} ExternalModuleHooks
  */
 
 /**
@@ -1486,10 +1492,7 @@ class ExternalModule extends Module {
 }
 
 ExternalModule.getCompilationHooks = createHooksRegistry(
-	() =>
-		/** @type {ExternalModuleHooks} */ ({
-			chunkCondition: new SyncBailHook(["chunk", "compilation"])
-		})
+	createCompilationHooks
 );
 
 makeSerializable(ExternalModule, "webpack/lib/ExternalModule");

package/lib/ModuleFilenameHelpers.js

@@ -169,11 +169,14 @@ ModuleFilenameHelpers.createFilename = (
 	let moduleId;
 	/** @type {ReturnStringCallback} */
 	let shortIdentifier;
+	/** @type {ReturnStringCallback} */
+	let resourceIdentifier;
 	if (typeof module === "string") {
 		shortIdentifier =
 			/** @type {ReturnStringCallback} */
 			(memoize(() => requestShortener.shorten(module)));
 		identifier = shortIdentifier;
+		resourceIdentifier = shortIdentifier;
 		moduleId = () => "";
 		absoluteResourcePath = () =>
 			/** @type {string} */ (module.split("!").pop());
@@ -182,6 +185,14 @@ ModuleFilenameHelpers.createFilename = (
 		shortIdentifier = memoize(() =>
 			module.readableIdentifier(requestShortener)
 		);
+		// `[resource]` and `[loaders]` must stay request paths: a subclass's
+		// readable identifier may carry display-only decorations (e.g. CssModule's
+		// `css ` prefix)
+		resourceIdentifier = memoize(() =>
+			module instanceof NormalModule
+				? /** @type {string} */ (requestShortener.shorten(module.userRequest))
+				: module.readableIdentifier(requestShortener)
+		);
 		identifier =
 			/** @type {ReturnStringCallback} */
 			(memoize(() => requestShortener.shorten(module.identifier())));
@@ -196,9 +207,9 @@ ModuleFilenameHelpers.createFilename = (
 	}
 	const resource =
 		/** @type {ReturnStringCallback} */
-		(memoize(() => shortIdentifier().split("!").pop()));
+		(memoize(() => resourceIdentifier().split("!").pop()));
 
-	const loaders = getBefore(shortIdentifier, "!");
+	const loaders = getBefore(resourceIdentifier, "!");
 	const allLoaders = getBefore(identifier, "!");
 	const query = getAfter(resource, "?");
 	const resourcePath = () => {

package/lib/NormalModule.js

@@ -52,7 +52,7 @@ const {
 	ABSOLUTE_PATH_REGEXP,
 	absolutify,
 	contextify,
-	makePathsRelative
+	contextifySourceUrl
 } = require("./util/identifier");
 const makeSerializable = require("./util/makeSerializable");
 const memoize = require("./util/memoize");
@@ -391,21 +391,6 @@ const walkSideEffects = (rootMod, moduleGraph, SideEffectDep) => {
  * @property {string | null=} type
  */
 
-/**
- * @param {string} context absolute context path
- * @param {string} source a source path
- * @param {AssociatedObjectForCache=} associatedObjectForCache an object to which the cache will be attached
- * @returns {string} new source path
- */
-const contextifySourceUrl = (context, source, associatedObjectForCache) => {
-	if (source.startsWith("webpack://")) return source;
-	return `webpack://${makePathsRelative(
-		context,
-		source,
-		associatedObjectForCache
-	)}`;
-};
-
 /**
  * @param {string} context absolute context path
  * @param {string | RawSourceMap} sourceMap a source map
@@ -471,16 +456,79 @@ const asBuffer = (input) => {
  * @typedef {HookMap<FakeHook<AsyncSeriesBailHook<[string, NormalModule], string | Buffer | null>>>} DeprecatedReadResourceForScheme
  */
 
+const createCompilationHooks = () => {
+	/** @type {HookMap<AsyncSeriesBailHook<[AnyLoaderContext], string | Buffer | null>>} */
+	const readResource = new HookMap(
+		() => new AsyncSeriesBailHook(["loaderContext"])
+	);
+	return {
+		// TODO webpack 6 deprecate
+		/**
+		 * @deprecated Use the `readResource` hook instead.
+		 * @type {DeprecatedReadResourceForScheme}
+		 */
+		readResourceForScheme: new HookMap((scheme) => {
+			const hook = readResource.for(scheme);
+			return createFakeHook(
+				/** @type {AsyncSeriesBailHook<[string, NormalModule], string | Buffer | null>} */ ({
+					tap: (options, fn) =>
+						hook.tap(options, (loaderContext) =>
+							fn(
+								loaderContext.resource,
+								/** @type {NormalModule} */ (loaderContext._module)
+							)
+						),
+					tapAsync: (options, fn) =>
+						hook.tapAsync(options, (loaderContext, callback) =>
+							fn(
+								loaderContext.resource,
+								/** @type {NormalModule} */ (loaderContext._module),
+								callback
+							)
+						),
+					tapPromise: (options, fn) =>
+						hook.tapPromise(options, (loaderContext) =>
+							fn(
+								loaderContext.resource,
+								/** @type {NormalModule} */ (loaderContext._module)
+							)
+						)
+				})
+			);
+		}),
+		/**
+		 * @since 5.58.0
+		 */
+		readResource,
+		/** @type {SyncHook<[AnyLoaderContext, NormalModule]>} */
+		loader: new SyncHook(["loaderContext", "module"]),
+		/** @type {SyncHook<[LoaderItem[], NormalModule, AnyLoaderContext]>} */
+		beforeLoaders: new SyncHook(["loaders", "module", "loaderContext"]),
+		/**
+		 * @type {SyncHook<[NormalModule]>}
+		 * @since 5.59.0
+		 */
+		beforeParse: new SyncHook(["module"]),
+		/**
+		 * @type {SyncHook<[NormalModule]>}
+		 * @since 5.59.0
+		 */
+		beforeSnapshot: new SyncHook(["module"]),
+		/**
+		 * @type {SyncWaterfallHook<[Result, NormalModule]>}
+		 * @since 5.99.0
+		 */
+		processResult: new SyncWaterfallHook(["result", "module"]),
+		/**
+		 * @type {AsyncSeriesBailHook<[NormalModule, NeedBuildContext], boolean>}
+		 * @since 5.49.0
+		 */
+		needBuild: new AsyncSeriesBailHook(["module", "context"])
+	};
+};
+
 /**
- * @typedef {object} NormalModuleCompilationHooks
- * @property {SyncHook<[AnyLoaderContext, NormalModule]>} loader
- * @property {SyncHook<[LoaderItem[], NormalModule, AnyLoaderContext]>} beforeLoaders
- * @property {SyncHook<[NormalModule]>} beforeParse
- * @property {SyncHook<[NormalModule]>} beforeSnapshot
- * @property {DeprecatedReadResourceForScheme} readResourceForScheme
- * @property {HookMap<AsyncSeriesBailHook<[AnyLoaderContext], string | Buffer | null>>} readResource
- * @property {SyncWaterfallHook<[Result, NormalModule]>} processResult
- * @property {AsyncSeriesBailHook<[NormalModule, NeedBuildContext], boolean>} needBuild
+ * @typedef {ReturnType<typeof createCompilationHooks>} NormalModuleCompilationHooks
  */
 
 /**
@@ -524,52 +572,7 @@ const asBuffer = (input) => {
 
 /** @typedef {BuildInfo & KnownNormalModuleBuildInfo} NormalModuleBuildInfo */
 
-const normalModuleHooksRegistry = createHooksRegistry(() => {
-	// TODO webpack 6 deprecate
-	/** @type {Partial<NormalModuleCompilationHooks>} */
-	const hooks = {};
-	hooks.readResourceForScheme = new HookMap((scheme) => {
-		const hook =
-			/** @type {NormalModuleCompilationHooks} */
-			(hooks).readResource.for(scheme);
-		return createFakeHook(
-			/** @type {AsyncSeriesBailHook<[string, NormalModule], string | Buffer | null>} */ ({
-				tap: (options, fn) =>
-					hook.tap(options, (loaderContext) =>
-						fn(
-							loaderContext.resource,
-							/** @type {NormalModule} */ (loaderContext._module)
-						)
-					),
-				tapAsync: (options, fn) =>
-					hook.tapAsync(options, (loaderContext, callback) =>
-						fn(
-							loaderContext.resource,
-							/** @type {NormalModule} */ (loaderContext._module),
-							callback
-						)
-					),
-				tapPromise: (options, fn) =>
-					hook.tapPromise(options, (loaderContext) =>
-						fn(
-							loaderContext.resource,
-							/** @type {NormalModule} */ (loaderContext._module)
-						)
-					)
-			})
-		);
-	});
-	hooks.readResource = new HookMap(
-		() => new AsyncSeriesBailHook(["loaderContext"])
-	);
-	hooks.loader = new SyncHook(["loaderContext", "module"]);
-	hooks.beforeLoaders = new SyncHook(["loaders", "module", "loaderContext"]);
-	hooks.beforeParse = new SyncHook(["module"]);
-	hooks.beforeSnapshot = new SyncHook(["module"]);
-	hooks.processResult = new SyncWaterfallHook(["result", "module"]);
-	hooks.needBuild = new AsyncSeriesBailHook(["module", "context"]);
-	return /** @type {NormalModuleCompilationHooks} */ (hooks);
-});
+const normalModuleHooksRegistry = createHooksRegistry(createCompilationHooks);
 
 class NormalModule extends Module {
 	/**

package/lib/NormalModuleFactory.js

@@ -435,7 +435,10 @@ class NormalModuleFactory extends ModuleFactory {
 			resolveForScheme: new HookMap(
 				() => new AsyncSeriesBailHook(["resourceData", "resolveData"])
 			),
-			/** @type {HookMap<AsyncSeriesBailHook<[ResourceDataWithData, ResolveData], true | void>>} */
+			/**
+			 * @type {HookMap<AsyncSeriesBailHook<[ResourceDataWithData, ResolveData], true | void>>}
+			 * @since 5.49.0
+			 */
 			resolveInScheme: new HookMap(
 				() => new AsyncSeriesBailHook(["resourceData", "resolveData"])
 			),
@@ -461,7 +464,10 @@ class NormalModuleFactory extends ModuleFactory {
 			generator: new HookMap(
 				() => new SyncHook(["generator", "generatorOptions"])
 			),
-			/** @type {HookMap<SyncBailHook<[CreateData, ResolveData], Module | void>>} */
+			/**
+			 * @type {HookMap<SyncBailHook<[CreateData, ResolveData], Module | void>>}
+			 * @since 5.81.0
+			 */
 			createModuleClass: new HookMap(
 				() => new SyncBailHook(["createData", "resolveData"])
 			)