webpack 5.111.1 → 5.112.1

package/lib/sharing/SharePlugin.js

@@ -13,20 +13,109 @@ const { isRequiredVersion } = require("./utils");
 /**
  * @import {
  * 	ConsumesConfig
- * } from "../../declarations/plugins/sharing/ConsumeSharedPlugin"
+ * } from "./ConsumeSharedPlugin"
  */
 /**
  * @import {
  * 	ProvidesConfig
- * } from "../../declarations/plugins/sharing/ProvideSharedPlugin"
+ * } from "./ProvideSharedPlugin"
  */
+/** @import Compiler from "../Compiler" */
+
 /**
- * @import {
- * 	SharePluginOptions,
- * 	SharedConfig
- * } from "../../declarations/plugins/sharing/SharePlugin"
+ * @inline
+ * @minLength 1
+ * @typedef {string} NonEmptyString
+ */
+
+/**
+ * Modules that should be shared in the share scope.
+ * @inline
+ * @typedef {SharedItem | SharedObject} SharedBranch1Item
+ */
+
+/**
+ * No provided or fallback module.
+ * @inline
+ * @typedef {false} SharedConfigImportBranch1
+ */
+
+/**
+ * No version requirement check.
+ * @inline
+ * @typedef {false} SharedConfigRequiredVersionBranch1
+ */
+
+/**
+ * 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} SharedConfigRequiredVersionBranch2
+ */
+
+/**
+ * Don't provide a version.
+ * @inline
+ * @typedef {false} SharedConfigVersionBranch1
+ */
+
+/**
+ * Version as string. Each part of the version should be separated by a dot '.'.
+ * @inline
+ * @typedef {string} SharedConfigVersionBranch2
+ */
+
+/**
+ * Modules that should be shared in the share scope.
+ * @inline
+ * @typedef {SharedConfig | SharedItem} SharedObjectValue
+ */
+
+/**
+ * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
+ * @typedef {SharedBranch1Item[] | SharedObject} Shared
+ */
+
+/**
+ * Advanced configuration for modules that should be shared in the share scope.
+ * @typedef {object} SharedConfig
+ * @property {boolean=} eager Include the provided and fallback 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 {SharedConfigImportBranch1 | SharedItem=} import Provided module that should be provided to share scope. Also acts as fallback module if no shared module is found in share scope or version isn't valid. 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 {SharedConfigRequiredVersionBranch1 | SharedConfigRequiredVersionBranch2=} 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).
+ * @property {SharedConfigVersionBranch1 | SharedConfigVersionBranch2=} version Version of the provided module. Will replace lower matching versions, but not higher.
+ */
+
+/**
+ * A module that should be shared in the share scope.
+ * @typedef {NonEmptyString} SharedItem
+ */
+
+/**
+ * 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.
+ */
+
+/**
+ * Modules that should be shared in the 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]: SharedObjectValue }} SharedObject
+ */
+
+/**
+ * Options for shared modules.
+ * @schema plugins/sharing/SharePlugin
+ * @typedef {object} SharePluginOptions
+ * @property {NonEmptyString=} shareScope Share scope name used for all shared modules (defaults to 'default').
+ * @property {Shared} shared
  */
-/** @import Compiler from "../Compiler" */
 
 class SharePlugin {
 	/**
@@ -65,7 +154,9 @@ class SharePlugin {
 				strictVersion: options.strictVersion,
 				singleton: options.singleton,
 				packageName: options.packageName,
-				eager: options.eager
+				eager: options.eager,
+				include: options.include,
+				exclude: options.exclude
 			}
 		}));
 		/** @type {Record<string, ProvidesConfig>[]} */
@@ -76,7 +167,9 @@ class SharePlugin {
 					shareKey: options.shareKey || key,
 					shareScope: options.shareScope,
 					version: options.version,
-					eager: options.eager
+					eager: options.eager,
+					include: options.include,
+					exclude: options.exclude
 				}
 			}));
 		/** @type {string | undefined} */

package/lib/sharing/ShareRuntimeModule.js

@@ -5,18 +5,18 @@
 
 "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 {
 	compareModulesByIdentifier,
 	compareStrings
 } = require("../util/comparators");
 
-/** @import Chunk from "../Chunk" */
-/** @import ChunkGraph from "../ChunkGraph" */
+/** @import Chunk from "../graph/Chunk" */
+/** @import ChunkGraph from "../graph/ChunkGraph" */
 /** @import Compilation from "../Compilation" */
-/** @import CodeGenerationResults from "../CodeGenerationResults" */
+/** @import CodeGenerationResults from "../module/CodeGenerationResults" */
 
 class ShareRuntimeModule extends RuntimeModule {
 	constructor() {

package/lib/sharing/resolveMatchedConfigs.js

@@ -15,7 +15,7 @@ const getModuleNotFoundError = memoize(() =>
 
 /** @import { ResolveContext } from "enhanced-resolve" */
 /** @import Compilation, { FileSystemDependencies } from "../Compilation" */
-/** @import { ResolveOptionsWithDependencyType } from "../ResolverFactory" */
+/** @import { ResolveOptionsWithDependencyType } from "../resolve/ResolverFactory" */
 
 /**
  * Defines the matched configs item type used by this module.

package/lib/{util → sharing}/semver.js

@@ -5,7 +5,7 @@
 
 "use strict";
 
-/** @import RuntimeTemplate from "../RuntimeTemplate" */
+/** @import RuntimeTemplate from "../template/RuntimeTemplate" */
 /** @typedef {string | number} VersionValue */
 /** @typedef {VersionValue | undefined} SemVerRangeItem */
 /** @typedef {(SemVerRangeItem | SemVerRangeItem[])[]} SemVerRange */
@@ -199,18 +199,16 @@ module.exports.parseRange = (str) => {
 
 		switch (start) {
 			case "^":
-				if (remainder.length > 1 && remainder[1] === 0) {
-					if (remainder.length > 2 && remainder[2] === 0) {
+				// never fix more components than the partial wrote
+				if (remainder.length > 2 && remainder[1] === 0) {
+					if (remainder.length > 3 && remainder[2] === 0) {
 						return [3, ...remainder.slice(1)];
 					}
 					return [2, ...remainder.slice(1)];
 				}
-				return [1, ...remainder.slice(1)];
+				return [Math.min(1, remainder.length - 1), ...remainder.slice(1)];
 			case "~":
-				if (remainder.length === 2 && remainder[0] === 0) {
-					return [1, ...remainder.slice(1)];
-				}
-				return [2, ...remainder.slice(1)];
+				return [Math.min(2, remainder.length - 1), ...remainder.slice(1)];
 			case ">=":
 				return remainder;
 			case "=":
@@ -577,9 +575,9 @@ module.exports.stringifyHoley = (json) => {
  * @param {RuntimeTemplate} runtimeTemplate
  * @returns {string}
  */
-exports.parseVersionRuntimeCode = (runtimeTemplate) =>
+module.exports.parseVersionRuntimeCode = (runtimeTemplate) =>
 	`var parseVersion = ${runtimeTemplate.basicFunction("str", [
-		"// see webpack/lib/util/semver.js for original code",
+		"// see webpack/lib/sharing/semver.js for original code",
 		`var p=${runtimeTemplate.supportsArrowFunction() ? "p=>" : "function(p)"}{return p.split(".").map(${runtimeTemplate.supportsArrowFunction() ? "p=>" : "function(p)"}{return+p==p?+p:p})},n=/^([^-+]+)?(?:-([^+]+))?(?:\\+(.+))?$/.exec(str),r=n[1]?p(n[1]):[];return n[2]&&(r.length++,r.push.apply(r,p(n[2]))),n[3]&&(r.push([]),r.push.apply(r,p(n[3]))),r;`
 	])}`;
 //#endregion
@@ -589,9 +587,9 @@ exports.parseVersionRuntimeCode = (runtimeTemplate) =>
  * @param {RuntimeTemplate} runtimeTemplate
  * @returns {string}
  */
-exports.versionLtRuntimeCode = (runtimeTemplate) =>
+module.exports.versionLtRuntimeCode = (runtimeTemplate) =>
 	`var versionLt = ${runtimeTemplate.basicFunction("a, b", [
-		"// see webpack/lib/util/semver.js for original code",
+		"// see webpack/lib/sharing/semver.js for original code",
 		'a=parseVersion(a),b=parseVersion(b);for(var r=0;;){if(r>=a.length)return r<b.length&&"u"!=(typeof b[r])[0];var e=a[r],n=(typeof e)[0];if(r>=b.length)return"u"==n;var t=b[r],f=(typeof t)[0];if(n!=f)return"o"==n&&"n"==f||("s"==f||"u"==n);if("o"!=n&&"u"!=n&&e!=t)return e<t;r++}'
 	])}`;
 //#endregion
@@ -601,9 +599,9 @@ exports.versionLtRuntimeCode = (runtimeTemplate) =>
  * @param {RuntimeTemplate} runtimeTemplate
  * @returns {string}
  */
-exports.rangeToStringRuntimeCode = (runtimeTemplate) =>
+module.exports.rangeToStringRuntimeCode = (runtimeTemplate) =>
 	`var rangeToString = ${runtimeTemplate.basicFunction("range", [
-		"// see webpack/lib/util/semver.js for original code",
+		"// see webpack/lib/sharing/semver.js for original code",
 		'var r=range[0],n="";if(1===range.length)return"*";if(r+.5){n+=0==r?">=":-1==r?"<":1==r?"^":2==r?"~":r>0?"=":"!=";for(var e=1,a=1;a<range.length;a++){e--,n+="u"==(typeof(t=range[a]))[0]?"-":(e>0?".":"")+(e=2,t)}return n}var g=[];for(a=1;a<range.length;a++){var t=range[a];g.push(0===t?"not("+o()+")":1===t?"("+o()+" || "+o()+")":2===t?g.pop()+" "+g.pop():rangeToString(t))}return o();function o(){return g.pop().replace(/^\\((.+)\\)$/,"$1")}'
 	])}`;
 //#endregion
@@ -613,9 +611,9 @@ exports.rangeToStringRuntimeCode = (runtimeTemplate) =>
  * @param {RuntimeTemplate} runtimeTemplate
  * @returns {string}
  */
-exports.satisfyRuntimeCode = (runtimeTemplate) =>
+module.exports.satisfyRuntimeCode = (runtimeTemplate) =>
 	`var satisfy = ${runtimeTemplate.basicFunction("range, version", [
-		"// see webpack/lib/util/semver.js for original code",
+		"// see webpack/lib/sharing/semver.js for original code",
 		'if(0 in range){version=parseVersion(version);var e=range[0],r=e<0;r&&(e=-e-1);for(var n=0,i=1,a=!0;;i++,n++){var f,s,g=i<range.length?(typeof range[i])[0]:"";if(n>=version.length||"o"==(s=(typeof(f=version[n]))[0]))return!a||("u"==g?i>e&&!r:""==g!=r);if("u"==s){if(!a||"u"!=g)return!1}else if(a)if(g==s)if(i<=e){if(f!=range[i])return!1}else{if(r?f>range[i]:f<range[i])return!1;f!=range[i]&&(a=!1)}else if("s"!=g&&"n"!=g){if(r||i<=e)return!1;a=!1,i--}else{if(i<=e||s<g!=r)return!1;a=!1}else"s"!=g&&"n"!=g&&(a=!1,i--)}}var t=[],o=t.pop.bind(t);for(n=1;n<range.length;n++){var u=range[n];t.push(1==u?o()|o():2==u?o()&o():u?satisfy(u,version):!o())}return!!o();'
 	])}`;
 //#endregion

package/lib/sharing/utils.js

@@ -5,9 +5,11 @@
 
 "use strict";
 
-const { dirname, join, readJson } = require("../util/fs");
+const { dirname, join, readJson } = require("../fs/fs");
+const { parseRange, satisfy } = require("./semver");
 
-/** @import { InputFileSystem, JsonObject, JsonPrimitive } from "../util/fs" */
+/** @import { InputFileSystem, JsonObject, JsonPrimitive } from "../fs/fs" */
+/** @import { SharedModuleFilter } from "./SharePlugin" */
 
 // Extreme shorthand only for github. eg: foo/bar
 const RE_URL_GITHUB_EXTREME_SHORT = /^[^/@:.\s][^/@:\s]*\/[^@:\s]*[^/@:\s]#\S+/;
@@ -425,3 +427,58 @@ function normalizeVersion(versionDesc) {
 }
 
 module.exports.normalizeVersion = normalizeVersion;
+
+/**
+ * Tests the request remainder under a prefix key against `include`/`exclude` request filters.
+ * @param {string} remainder request after the prefix
+ * @param {SharedModuleFilter=} include only share matching requests
+ * @param {SharedModuleFilter=} exclude don't share matching requests
+ * @returns {boolean} true, when the request should be shared
+ */
+const matchesRequestFilters = (remainder, include, exclude) => {
+	/**
+	 * @param {string | RegExp} pattern request filter
+	 * @returns {boolean} true, when the remainder matches
+	 */
+	const matches = (pattern) => {
+		if (typeof pattern === "string") return remainder === pattern;
+		// a global or sticky RegExp would resume from the previous match
+		pattern.lastIndex = 0;
+		return pattern.test(remainder);
+	};
+	if (include && include.request !== undefined && !matches(include.request)) {
+		return false;
+	}
+	return !(
+		exclude &&
+		exclude.request !== undefined &&
+		matches(exclude.request)
+	);
+};
+
+module.exports.matchesRequestFilters = matchesRequestFilters;
+
+/**
+ * Tests a module version against `include`/`exclude` version filters; an unknown version fails `include`.
+ * @param {string | false | undefined} version version of the module
+ * @param {SharedModuleFilter=} include only share matching versions
+ * @param {SharedModuleFilter=} exclude don't share matching versions
+ * @returns {boolean} true, when the version should be shared
+ */
+const matchesVersionFilters = (version, include, exclude) => {
+	if (
+		include &&
+		include.version !== undefined &&
+		(!version || !satisfy(parseRange(include.version), version))
+	) {
+		return false;
+	}
+	return !(
+		exclude &&
+		exclude.version !== undefined &&
+		version &&
+		satisfy(parseRange(exclude.version), version)
+	);
+};
+
+module.exports.matchesVersionFilters = matchesVersionFilters;