webpack 5.111.1 → 5.112.1

package/lib/sharing/ConsumeSharedPlugin.js

@@ -5,22 +5,24 @@
 
 "use strict";
 
-const RuntimeGlobals = require("../RuntimeGlobals");
 const { parseOptions } = require("../container/options");
 const WebpackError = require("../errors/WebpackError");
+const isDependencyKind = require("../graph/isDependencyKind");
+const RuntimeGlobals = require("../runtime/RuntimeGlobals");
 const LazySet = require("../util/LazySet");
 const memoize = require("../util/memoize");
-const { parseRange } = require("../util/semver");
 const ConsumeSharedFallbackDependency = require("./ConsumeSharedFallbackDependency");
 const ConsumeSharedModule = require("./ConsumeSharedModule");
 const ConsumeSharedRuntimeModule = require("./ConsumeSharedRuntimeModule");
-const ProvideForSharedDependency = require("./ProvideForSharedDependency");
 const { addDeclaredShared } = require("./declaredShared");
 const { resolveMatchedConfigs } = require("./resolveMatchedConfigs");
+const { parseRange } = require("./semver");
 const {
 	getDescriptionFile,
 	getRequiredVersionFromDescriptionFile,
-	isRequiredVersion
+	isRequiredVersion,
+	matchesRequestFilters,
+	matchesVersionFilters
 } = require("./utils");
 
 const getModuleNotFoundError = memoize(() =>
@@ -28,17 +30,100 @@ const getModuleNotFoundError = memoize(() =>
 );
 
 /** @import { ResolveContext } from "enhanced-resolve" */
-/**
- * @import {
- * 	ConsumeSharedPluginOptions
- * } from "../../declarations/plugins/sharing/ConsumeSharedPlugin"
- */
 /** @import Compiler from "../Compiler" */
 /** @import { FileSystemDependencies } from "../Compilation" */
-/** @import { ResolveOptionsWithDependencyType } from "../ResolverFactory" */
-/** @import { SemVerRange } from "../util/semver" */
+/** @import { ResolveOptionsWithDependencyType } from "../resolve/ResolverFactory" */
+/** @import { SemVerRange } from "./semver" */
 /** @import { ConsumeOptions } from "./ConsumeSharedModule" */
 /** @import { DescriptionFile } from "./utils" */
+/** @import { SharedModuleFilter } from "./SharePlugin" */
+
+/**
+ * @inline
+ * @minLength 1
+ * @typedef {string} NonEmptyString
+ */
+
+/**
+ * Modules that should be consumed from share scope.
+ * @inline
+ * @typedef {ConsumesItem | ConsumesObject} ConsumesBranch1Item
+ */
+
+/**
+ * No fallback module.
+ * @inline
+ * @typedef {false} ConsumesConfigImportBranch1
+ */
+
+/**
+ * No version requirement check.
+ * @inline
+ * @typedef {false} ConsumesConfigRequiredVersionBranch1
+ */
+
+/**
+ * Version as string. Can be prefixed with '^' or '~' for minimum matches. Each part of the version should be separated by a dot '.'.
+ * @inline
+ * @typedef {string} ConsumesConfigRequiredVersionBranch2
+ */
+
+/**
+ * Modules that should be consumed from share scope.
+ * @inline
+ * @typedef {ConsumesConfig | ConsumesItem} ConsumesObjectValue
+ */
+
+/**
+ * Modules that should be consumed from share scope. When provided, property names are used to match requested modules in this compilation.
+ * @typedef {ConsumesBranch1Item[] | ConsumesObject} Consumes
+ */
+
+/**
+ * Advanced configuration for modules that should be consumed from share scope.
+ * @typedef {object} ConsumesConfig
+ * @property {boolean=} eager Include the fallback module directly instead behind an async request. This allows to use fallback module in initial load too. All possible shared modules need to be eager too.
+ * @property {SharedModuleFilter=} exclude
+ * @property {ConsumesConfigImportBranch1 | ConsumesItem=} import Fallback module if no shared module is found in share scope. Defaults to the property name.
+ * @property {SharedModuleFilter=} include
+ * @property {NonEmptyString=} packageName Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
+ * @property {ConsumesConfigRequiredVersionBranch1 | ConsumesConfigRequiredVersionBranch2=} requiredVersion Version requirement from module in share scope.
+ * @property {NonEmptyString=} shareKey Module is looked up under this key from the share scope.
+ * @property {NonEmptyString=} shareScope Share scope name.
+ * @property {boolean=} singleton Allow only a single version of the shared module in share scope (disabled by default).
+ * @property {boolean=} strictVersion Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
+ */
+
+/**
+ * A module that should be consumed from share scope.
+ * @typedef {NonEmptyString} ConsumesItem
+ */
+
+/**
+ * Modules that should be consumed from share scope. Property names are used to match requested modules in this compilation. Relative requests are resolved, module requests are matched unresolved, absolute paths will match resolved requests. A trailing slash will match all requests with this prefix. In this case shareKey must also have a trailing slash.
+ * @typedef {{ [key: string]: ConsumesObjectValue }} ConsumesObject
+ */
+
+/**
+ * Filters shared modules by version or request: with 'include' only matching modules are shared, with 'exclude' matching ones are not. A filtered-out module is resolved and bundled as if it wasn't shared.
+ * @since 5.112.0
+ * @typedef {object} SharedModuleFilter
+ * @property {RegExp | NonEmptyString=} request Request remainder after a key ending in a slash (e.g. 'get' for 'lodash/get' under 'lodash/'). Has no effect on other keys.
+ * @property {NonEmptyString=} version Version range the module's version (from its description file or the 'version' option) is tested against. A consumed module is tested through its fallback module, so this has no effect on consumes without one.
+ */
+
+/**
+ * Options for consuming shared modules.
+ * @schema plugins/sharing/ConsumeSharedPlugin
+ * @typedef {object} ConsumeSharedPluginOptions
+ * @property {Consumes} consumes
+ * @property {NonEmptyString=} shareScope Share scope name used for all consumed modules (defaults to 'default').
+ */
+
+/**
+ * Consume options plus the filters deciding which matched requests are consumed.
+ * @typedef {ConsumeOptions & { include?: SharedModuleFilter, exclude?: SharedModuleFilter }} ConsumeConfig
+ */
 
 /** @type {ResolveOptionsWithDependencyType} */
 const RESOLVE_OPTIONS = { dependencyType: "esm" };
@@ -60,7 +145,7 @@ class ConsumeSharedPlugin {
 	 * @returns {void}
 	 */
 	apply(compiler) {
-		// TODO webpack 6 remove string support
+		// TODO in the next major release: remove string support
 		if (typeof this.options !== "string") {
 			compiler.hooks.validate.tap(PLUGIN_NAME, () => {
 				compiler.validate(
@@ -79,12 +164,12 @@ class ConsumeSharedPlugin {
 			});
 		}
 
-		/** @type {[string, ConsumeOptions][]} */
+		/** @type {[string, ConsumeConfig][]} */
 		const consumes = parseOptions(
 			this.options.consumes,
 			(item, key) => {
 				if (Array.isArray(item)) throw new Error("Unexpected array in options");
-				/** @type {ConsumeOptions} */
+				/** @type {ConsumeConfig} */
 				const result =
 					item === key || !isRequiredVersion(item)
 						? // item is a request/key
@@ -126,7 +211,9 @@ class ConsumeSharedPlugin {
 						: item.import !== false && !item.singleton,
 				packageName: item.packageName,
 				singleton: Boolean(item.singleton),
-				eager: Boolean(item.eager)
+				eager: Boolean(item.eager),
+				include: item.include,
+				exclude: item.exclude
 			})
 		);
 
@@ -149,13 +236,13 @@ class ConsumeSharedPlugin {
 					}))
 				);
 
-				/** @typedef {Map<string, ConsumeOptions>} Consumes */
+				/** @typedef {Map<string, ConsumeConfig>} ConsumeMap */
 
-				/** @type {Consumes} */
+				/** @type {ConsumeMap} */
 				let unresolvedConsumes;
-				/** @type {Consumes} */
+				/** @type {ConsumeMap} */
 				let resolvedConsumes;
-				/** @type {Consumes} */
+				/** @type {ConsumeMap} */
 				let prefixedConsumes;
 				const promise = resolveMatchedConfigs(compilation, consumes).then(
 					({ resolved, unresolved, prefixed }) => {
@@ -174,8 +261,8 @@ class ConsumeSharedPlugin {
 				 * Creates a consume shared module.
 				 * @param {string} context issuer directory
 				 * @param {string} request request
-				 * @param {ConsumeOptions} config options
-				 * @returns {Promise<ConsumeSharedModule>} create module
+				 * @param {ConsumeConfig} config options
+				 * @returns {Promise<ConsumeSharedModule | undefined>} create module, or undefined when filtered out
 				 */
 				const createConsumeSharedModule = (context, request, config) => {
 					/**
@@ -189,6 +276,9 @@ class ConsumeSharedPlugin {
 						error.file = `shared module ${request}`;
 						compilation.warnings.push(error);
 					};
+					const { include, exclude, ...options } = config;
+					/** @type {string | undefined} */
+					let fallbackVersion;
 					const directFallback =
 						config.import &&
 						/^(?:\.\.?(?:\/|$)|\/|[A-Z]:|\\\\)/i.test(config.import);
@@ -214,7 +304,7 @@ class ConsumeSharedPlugin {
 									directFallback ? compiler.context : context,
 									config.import,
 									resolveContext,
-									(err, result) => {
+									(err, result, resolveRequest) => {
 										compilation.contextDependencies.addAll(
 											resolveContext.contextDependencies
 										);
@@ -232,6 +322,14 @@ class ConsumeSharedPlugin {
 											);
 											return resolve();
 										}
+										const descriptionFileData =
+											resolveRequest && resolveRequest.descriptionFileData;
+										if (
+											descriptionFileData &&
+											typeof descriptionFileData.version === "string"
+										) {
+											fallbackVersion = descriptionFileData.version;
+										}
 										resolve(/** @type {string} */ (result));
 									}
 								);
@@ -325,18 +423,23 @@ class ConsumeSharedPlugin {
 								);
 							}
 						)
-					]).then(
-						([importResolved, requiredVersion]) =>
-							new ConsumeSharedModule(
-								directFallback ? compiler.context : context,
-								{
-									...config,
-									importResolved,
-									import: importResolved ? config.import : undefined,
-									requiredVersion
-								}
-							)
-					);
+					]).then(([importResolved, requiredVersion]) => {
+						if (
+							importResolved &&
+							!matchesVersionFilters(fallbackVersion, include, exclude)
+						) {
+							return;
+						}
+						return new ConsumeSharedModule(
+							directFallback ? compiler.context : context,
+							{
+								...options,
+								importResolved,
+								import: importResolved ? config.import : undefined,
+								requiredVersion
+							}
+						);
+					});
 				};
 
 				normalModuleFactory.hooks.factorize.tapPromise(
@@ -344,10 +447,7 @@ class ConsumeSharedPlugin {
 					({ context, request, dependencies }) =>
 						// wait for resolving to be complete
 						promise.then(() => {
-							if (
-								dependencies[0] instanceof ConsumeSharedFallbackDependency ||
-								dependencies[0] instanceof ProvideForSharedDependency
-							) {
+							if (isDependencyKind(dependencies[0], "sharing-request")) {
 								return;
 							}
 							const match = unresolvedConsumes.get(request);
@@ -357,6 +457,15 @@ class ConsumeSharedPlugin {
 							for (const [prefix, options] of prefixedConsumes) {
 								if (request.startsWith(prefix)) {
 									const remainder = request.slice(prefix.length);
+									if (
+										!matchesRequestFilters(
+											remainder,
+											options.include,
+											options.exclude
+										)
+									) {
+										continue;
+									}
 									return createConsumeSharedModule(context, request, {
 										...options,
 										import: options.import
@@ -371,10 +480,7 @@ class ConsumeSharedPlugin {
 				normalModuleFactory.hooks.createModule.tapPromise(
 					PLUGIN_NAME,
 					({ resource }, { context, dependencies }) => {
-						if (
-							dependencies[0] instanceof ConsumeSharedFallbackDependency ||
-							dependencies[0] instanceof ProvideForSharedDependency
-						) {
+						if (isDependencyKind(dependencies[0], "sharing-request")) {
 							return Promise.resolve();
 						}
 						const options = resolvedConsumes.get(resource);

package/lib/sharing/ConsumeSharedRuntimeModule.js

@@ -5,23 +5,23 @@
 
 "use strict";
 
-const RuntimeGlobals = require("../RuntimeGlobals");
-const RuntimeModule = require("../RuntimeModule");
-const Template = require("../Template");
+const RuntimeGlobals = require("../runtime/RuntimeGlobals");
+const RuntimeModule = require("../runtime/RuntimeModule");
+const Template = require("../template/Template");
 const { compareModulesById } = require("../util/comparators");
 const {
 	parseVersionRuntimeCode,
 	rangeToStringRuntimeCode,
 	satisfyRuntimeCode,
 	versionLtRuntimeCode
-} = require("../util/semver");
+} = require("./semver");
 
 /** @import { Source } from "webpack-sources" */
-/** @import Chunk, { ChunkId } from "../Chunk" */
-/** @import ChunkGraph, { ModuleId } from "../ChunkGraph" */
+/** @import Chunk, { ChunkId } from "../graph/Chunk" */
+/** @import ChunkGraph, { ModuleId } from "../graph/ChunkGraph" */
 /** @import Compilation from "../Compilation" */
-/** @import Module, { ReadOnlyRuntimeRequirements } from "../Module" */
-/** @import CodeGenerationResults from "../CodeGenerationResults" */
+/** @import Module, { ReadOnlyRuntimeRequirements } from "../module/Module" */
+/** @import CodeGenerationResults from "../module/CodeGenerationResults" */
 
 class ConsumeSharedRuntimeModule extends RuntimeModule {
 	/**

package/lib/sharing/ProvideForSharedDependency.js

@@ -5,7 +5,9 @@
 
 "use strict";
 
-const ModuleDependency = require("../dependencies/ModuleDependency");
+/** @import { DependencyKinds } from "../graph/Dependency" */
+
+const ModuleDependency = require("../dependencies/core/ModuleDependency");
 const makeSerializable = require("../util/makeSerializable");
 
 class ProvideForSharedDependency extends ModuleDependency {
@@ -31,4 +33,10 @@ makeSerializable(
 	"webpack/lib/sharing/ProvideForSharedDependency"
 );
 
+/** @type {Set<keyof DependencyKinds>} */
+ProvideForSharedDependency.KINDS = new Set([
+	...ModuleDependency.KINDS,
+	"sharing-request"
+]);
+
 module.exports = ProvideForSharedDependency;

package/lib/sharing/ProvideSharedDependency.js

@@ -5,7 +5,7 @@
 
 "use strict";
 
-const Dependency = require("../Dependency");
+const Dependency = require("../graph/Dependency");
 const makeSerializable = require("../util/makeSerializable");
 
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext<[string, string, string, string | false, boolean]>} ObjectDeserializerContext */

package/lib/sharing/ProvideSharedModule.js

@@ -5,11 +5,13 @@
 
 "use strict";
 
-const AsyncDependenciesBlock = require("../AsyncDependenciesBlock");
-const Module = require("../Module");
-const { SHARED_INIT_TYPES } = require("../ModuleSourceTypeConstants");
-const { WEBPACK_MODULE_TYPE_PROVIDE } = require("../ModuleTypeConstants");
-const RuntimeGlobals = require("../RuntimeGlobals");
+const AsyncDependenciesBlock = require("../graph/AsyncDependenciesBlock");
+const Module = require("../module/Module");
+const { SHARED_INIT_TYPES } = require("../module/ModuleSourceTypeConstants");
+const {
+	WEBPACK_MODULE_TYPE_PROVIDE
+} = require("../module/ModuleTypeConstants");
+const RuntimeGlobals = require("../runtime/RuntimeGlobals");
 const makeSerializable = require("../util/makeSerializable");
 const ProvideForSharedDependency = require("./ProvideForSharedDependency");
 
@@ -31,13 +33,13 @@ const ProvideForSharedDependency = require("./ProvideForSharedDependency");
  * 	Sources,
  * 	SourceTypes,
  * 	CodeGenerationResultData
- * } from "../Module"
+ * } from "../module/Module"
  */
-/** @import RequestShortener from "../RequestShortener" */
-/** @import { ResolverWithOptions } from "../ResolverFactory" */
+/** @import RequestShortener from "../util/RequestShortener" */
+/** @import { ResolverWithOptions } from "../resolve/ResolverFactory" */
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext<[string, string, string | false, string, boolean]>} ObjectDeserializerContext */
 /** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext<[string, string, string | false, string, boolean]>} ObjectSerializerContext */
-/** @import { InputFileSystem } from "../util/fs" */
+/** @import { InputFileSystem } from "../fs/fs" */
 
 class ProvideSharedModule extends Module {
 	/**

package/lib/sharing/ProvideSharedModuleFactory.js

@@ -5,14 +5,14 @@
 
 "use strict";
 
-const ModuleFactory = require("../ModuleFactory");
+const ModuleFactory = require("../module/ModuleFactory");
 const ProvideSharedModule = require("./ProvideSharedModule");
 
 /**
  * @import {
  * 	ModuleFactoryCallback,
  * 	ModuleFactoryCreateData
- * } from "../ModuleFactory"
+ * } from "../module/ModuleFactory"
  */
 /** @import ProvideSharedDependency from "./ProvideSharedDependency" */
 

package/lib/sharing/ProvideSharedPlugin.js

@@ -11,15 +11,83 @@ const { ABSOLUTE_PATH_REGEXP } = require("../util/identifier");
 const ProvideForSharedDependency = require("./ProvideForSharedDependency");
 const ProvideSharedDependency = require("./ProvideSharedDependency");
 const ProvideSharedModuleFactory = require("./ProvideSharedModuleFactory");
+const { matchesRequestFilters, matchesVersionFilters } = require("./utils");
 
-/**
- * @import {
- * 	ProvideSharedPluginOptions
- * } from "../../declarations/plugins/sharing/ProvideSharedPlugin"
- */
 /** @import Compilation from "../Compilation" */
 /** @import Compiler from "../Compiler" */
-/** @import { NormalModuleCreateData } from "../NormalModule" */
+/** @import { NormalModuleCreateData } from "../module/NormalModule" */
+/** @import { SharedModuleFilter } from "./SharePlugin" */
+
+/**
+ * @inline
+ * @minLength 1
+ * @typedef {string} NonEmptyString
+ */
+
+/**
+ * Modules that should be provided as shared modules to the share scope.
+ * @inline
+ * @typedef {ProvidesItem | ProvidesObject} ProvidesBranch1Item
+ */
+
+/**
+ * Don't provide a version.
+ * @inline
+ * @typedef {false} ProvidesConfigVersionBranch1
+ */
+
+/**
+ * Version as string. Each part of the version should be separated by a dot '.'.
+ * @inline
+ * @typedef {string} ProvidesConfigVersionBranch2
+ */
+
+/**
+ * Modules that should be provided as shared modules to the share scope.
+ * @inline
+ * @typedef {ProvidesConfig | ProvidesItem} ProvidesObjectValue
+ */
+
+/**
+ * Modules that should be provided as shared modules to the share scope. When provided, property name is used to match modules, otherwise this is automatically inferred from share key.
+ * @typedef {ProvidesBranch1Item[] | ProvidesObject} Provides
+ */
+
+/**
+ * Advanced configuration for modules that should be provided as shared modules to the share scope.
+ * @typedef {object} ProvidesConfig
+ * @property {boolean=} eager Include the provided module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.
+ * @property {SharedModuleFilter=} exclude
+ * @property {SharedModuleFilter=} include
+ * @property {NonEmptyString=} shareKey Key in the share scope under which the shared modules should be stored.
+ * @property {NonEmptyString=} shareScope Share scope name.
+ * @property {ProvidesConfigVersionBranch1 | ProvidesConfigVersionBranch2=} version Version of the provided module. Will replace lower matching versions, but not higher.
+ */
+
+/**
+ * Request to a module that should be provided as shared module to the share scope (will be resolved when relative).
+ * @typedef {NonEmptyString} ProvidesItem
+ */
+
+/**
+ * Modules that should be provided as shared modules to the share scope. Property names are used as share keys.
+ * @typedef {{ [key: string]: ProvidesObjectValue }} ProvidesObject
+ */
+
+/**
+ * Filters shared modules by version or request: with 'include' only matching modules are shared, with 'exclude' matching ones are not. A filtered-out module is resolved and bundled as if it wasn't shared.
+ * @since 5.112.0
+ * @typedef {object} SharedModuleFilter
+ * @property {RegExp | NonEmptyString=} request Request remainder after a key ending in a slash (e.g. 'get' for 'lodash/get' under 'lodash/'). Has no effect on other keys.
+ * @property {NonEmptyString=} version Version range the module's version (from its description file or the 'version' option) is tested against. A consumed module is tested through its fallback module, so this has no effect on consumes without one.
+ */
+
+/**
+ * @schema plugins/sharing/ProvideSharedPlugin
+ * @typedef {object} ProvideSharedPluginOptions
+ * @property {Provides} provides
+ * @property {NonEmptyString=} shareScope Share scope name used for all provided modules (defaults to 'default').
+ */
 
 /**
  * Defines the provide options type used by this module.
@@ -28,6 +96,8 @@ const ProvideSharedModuleFactory = require("./ProvideSharedModuleFactory");
  * @property {string} shareScope
  * @property {string | undefined | false} version
  * @property {boolean} eager
+ * @property {SharedModuleFilter=} include
+ * @property {SharedModuleFilter=} exclude
  */
 
 /** @typedef {Map<string, { config: ProvideOptions, version: string | undefined | false }>} ResolvedProvideMap */
@@ -77,7 +147,9 @@ class ProvideSharedPlugin {
 					shareKey: item,
 					version: undefined,
 					shareScope: this.options.shareScope || "default",
-					eager: false
+					eager: false,
+					include: undefined,
+					exclude: undefined
 				};
 				return result;
 			},
@@ -85,7 +157,9 @@ class ProvideSharedPlugin {
 				shareKey: /** @type {string} */ (item.shareKey),
 				version: item.version,
 				shareScope: item.shareScope || this.options.shareScope || "default",
-				eager: Boolean(item.eager)
+				eager: Boolean(item.eager),
+				include: item.include,
+				exclude: item.exclude
 			})
 		).sort(([a], [b]) => {
 			if (a < b) return -1;
@@ -106,18 +180,23 @@ class ProvideSharedPlugin {
 				/** @type {Map<string, ProvideOptions>} */
 				const prefixMatchProvides = new Map();
 				for (const [request, config] of provides) {
-					if (/^\.\.?(?:\/|$)/.test(request)) {
-						// relative request
-						resolvedProvideMap.set(request, {
-							config,
-							version: config.version
-						});
-					} else if (ABSOLUTE_PATH_REGEXP.test(request)) {
-						// absolute path
-						resolvedProvideMap.set(request, {
-							config,
-							version: config.version
-						});
+					if (
+						/^\.\.?(?:\/|$)/.test(request) ||
+						ABSOLUTE_PATH_REGEXP.test(request)
+					) {
+						// relative request or absolute path
+						if (
+							matchesVersionFilters(
+								config.version,
+								config.include,
+								config.exclude
+							)
+						) {
+							resolvedProvideMap.set(request, {
+								config,
+								version: config.version
+							});
+						}
 					} else if (request.endsWith("/")) {
 						// module request prefix
 						prefixMatchProvides.set(request, config);
@@ -167,6 +246,9 @@ class ProvideSharedPlugin {
 							compilation.warnings.push(error);
 						}
 					}
+					if (!matchesVersionFilters(version, config.include, config.exclude)) {
+						return;
+					}
 					resolvedProvideMap.set(resource, {
 						config,
 						version
@@ -194,6 +276,15 @@ class ProvideSharedPlugin {
 						for (const [prefix, config] of prefixMatchProvides) {
 							if (request.startsWith(prefix)) {
 								const remainder = request.slice(prefix.length);
+								if (
+									!matchesRequestFilters(
+										remainder,
+										config.include,
+										config.exclude
+									)
+								) {
+									continue;
+								}
 								provideSharedModule(
 									resource,
 									{