Skip to content

Commit 4a51f07

Browse files
feat(sharing): add include/exclude filters to shared modules (#22297)
* feat(sharing): add include/exclude filters to shared modules Filter shared modules by resolved version or prefix request remainder, compatible with @module-federation/enhanced. A filtered-out module is neither provided nor consumed, so it resolves as if it wasn't shared, letting a nested dependency keep its own version. Refs #15971 * fix(sharing): reset lastIndex before testing a request filter
1 parent 382ef4b commit 4a51f07

33 files changed

Lines changed: 481 additions & 40 deletions
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"webpack": minor
3+
---
4+
5+
Add `include`/`exclude` version and request filters to shared modules.

‎lib/sharing/ConsumeSharedPlugin.js‎

Lines changed: 55 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ const { parseRange } = require("./semver");
2020
const {
2121
getDescriptionFile,
2222
getRequiredVersionFromDescriptionFile,
23-
isRequiredVersion
23+
isRequiredVersion,
24+
matchesRequestFilters,
25+
matchesVersionFilters
2426
} = require("./utils");
2527

2628
const getModuleNotFoundError = memoize(() =>
@@ -39,6 +41,12 @@ const getModuleNotFoundError = memoize(() =>
3941
/** @import { SemVerRange } from "./semver" */
4042
/** @import { ConsumeOptions } from "./ConsumeSharedModule" */
4143
/** @import { DescriptionFile } from "./utils" */
44+
/** @import { SharedModuleFilter } from "../../declarations/plugins/sharing/SharePlugin" */
45+
46+
/**
47+
* Consume options plus the filters deciding which matched requests are consumed.
48+
* @typedef {ConsumeOptions & { include?: SharedModuleFilter, exclude?: SharedModuleFilter }} ConsumeConfig
49+
*/
4250

4351
/** @type {ResolveOptionsWithDependencyType} */
4452
const RESOLVE_OPTIONS = { dependencyType: "esm" };
@@ -79,12 +87,12 @@ class ConsumeSharedPlugin {
7987
});
8088
}
8189

82-
/** @type {[string, ConsumeOptions][]} */
90+
/** @type {[string, ConsumeConfig][]} */
8391
const consumes = parseOptions(
8492
this.options.consumes,
8593
(item, key) => {
8694
if (Array.isArray(item)) throw new Error("Unexpected array in options");
87-
/** @type {ConsumeOptions} */
95+
/** @type {ConsumeConfig} */
8896
const result =
8997
item === key || !isRequiredVersion(item)
9098
? // item is a request/key
@@ -126,7 +134,9 @@ class ConsumeSharedPlugin {
126134
: item.import !== false && !item.singleton,
127135
packageName: item.packageName,
128136
singleton: Boolean(item.singleton),
129-
eager: Boolean(item.eager)
137+
eager: Boolean(item.eager),
138+
include: item.include,
139+
exclude: item.exclude
130140
})
131141
);
132142

@@ -149,7 +159,7 @@ class ConsumeSharedPlugin {
149159
}))
150160
);
151161

152-
/** @typedef {Map<string, ConsumeOptions>} Consumes */
162+
/** @typedef {Map<string, ConsumeConfig>} Consumes */
153163

154164
/** @type {Consumes} */
155165
let unresolvedConsumes;
@@ -174,8 +184,8 @@ class ConsumeSharedPlugin {
174184
* Creates a consume shared module.
175185
* @param {string} context issuer directory
176186
* @param {string} request request
177-
* @param {ConsumeOptions} config options
178-
* @returns {Promise<ConsumeSharedModule>} create module
187+
* @param {ConsumeConfig} config options
188+
* @returns {Promise<ConsumeSharedModule | undefined>} create module, or undefined when filtered out
179189
*/
180190
const createConsumeSharedModule = (context, request, config) => {
181191
/**
@@ -189,6 +199,9 @@ class ConsumeSharedPlugin {
189199
error.file = `shared module ${request}`;
190200
compilation.warnings.push(error);
191201
};
202+
const { include, exclude, ...options } = config;
203+
/** @type {string | undefined} */
204+
let fallbackVersion;
192205
const directFallback =
193206
config.import &&
194207
/^(?:\.\.?(?:\/|$)|\/|[A-Z]:|\\\\)/i.test(config.import);
@@ -214,7 +227,7 @@ class ConsumeSharedPlugin {
214227
directFallback ? compiler.context : context,
215228
config.import,
216229
resolveContext,
217-
(err, result) => {
230+
(err, result, resolveRequest) => {
218231
compilation.contextDependencies.addAll(
219232
resolveContext.contextDependencies
220233
);
@@ -232,6 +245,14 @@ class ConsumeSharedPlugin {
232245
);
233246
return resolve();
234247
}
248+
const descriptionFileData =
249+
resolveRequest && resolveRequest.descriptionFileData;
250+
if (
251+
descriptionFileData &&
252+
typeof descriptionFileData.version === "string"
253+
) {
254+
fallbackVersion = descriptionFileData.version;
255+
}
235256
resolve(/** @type {string} */ (result));
236257
}
237258
);
@@ -325,18 +346,23 @@ class ConsumeSharedPlugin {
325346
);
326347
}
327348
)
328-
]).then(
329-
([importResolved, requiredVersion]) =>
330-
new ConsumeSharedModule(
331-
directFallback ? compiler.context : context,
332-
{
333-
...config,
334-
importResolved,
335-
import: importResolved ? config.import : undefined,
336-
requiredVersion
337-
}
338-
)
339-
);
349+
]).then(([importResolved, requiredVersion]) => {
350+
if (
351+
importResolved &&
352+
!matchesVersionFilters(fallbackVersion, include, exclude)
353+
) {
354+
return;
355+
}
356+
return new ConsumeSharedModule(
357+
directFallback ? compiler.context : context,
358+
{
359+
...options,
360+
importResolved,
361+
import: importResolved ? config.import : undefined,
362+
requiredVersion
363+
}
364+
);
365+
});
340366
};
341367

342368
normalModuleFactory.hooks.factorize.tapPromise(
@@ -357,6 +383,15 @@ class ConsumeSharedPlugin {
357383
for (const [prefix, options] of prefixedConsumes) {
358384
if (request.startsWith(prefix)) {
359385
const remainder = request.slice(prefix.length);
386+
if (
387+
!matchesRequestFilters(
388+
remainder,
389+
options.include,
390+
options.exclude
391+
)
392+
) {
393+
continue;
394+
}
360395
return createConsumeSharedModule(context, request, {
361396
...options,
362397
import: options.import

‎lib/sharing/ProvideSharedPlugin.js‎

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const { ABSOLUTE_PATH_REGEXP } = require("../util/identifier");
1111
const ProvideForSharedDependency = require("./ProvideForSharedDependency");
1212
const ProvideSharedDependency = require("./ProvideSharedDependency");
1313
const ProvideSharedModuleFactory = require("./ProvideSharedModuleFactory");
14+
const { matchesRequestFilters, matchesVersionFilters } = require("./utils");
1415

1516
/**
1617
* @import {
@@ -20,6 +21,7 @@ const ProvideSharedModuleFactory = require("./ProvideSharedModuleFactory");
2021
/** @import Compilation from "../Compilation" */
2122
/** @import Compiler from "../Compiler" */
2223
/** @import { NormalModuleCreateData } from "../module/NormalModule" */
24+
/** @import { SharedModuleFilter } from "../../declarations/plugins/sharing/SharePlugin" */
2325

2426
/**
2527
* Defines the provide options type used by this module.
@@ -28,6 +30,8 @@ const ProvideSharedModuleFactory = require("./ProvideSharedModuleFactory");
2830
* @property {string} shareScope
2931
* @property {string | undefined | false} version
3032
* @property {boolean} eager
33+
* @property {SharedModuleFilter=} include
34+
* @property {SharedModuleFilter=} exclude
3135
*/
3236

3337
/** @typedef {Map<string, { config: ProvideOptions, version: string | undefined | false }>} ResolvedProvideMap */
@@ -77,15 +81,19 @@ class ProvideSharedPlugin {
7781
shareKey: item,
7882
version: undefined,
7983
shareScope: this.options.shareScope || "default",
80-
eager: false
84+
eager: false,
85+
include: undefined,
86+
exclude: undefined
8187
};
8288
return result;
8389
},
8490
(item) => ({
8591
shareKey: /** @type {string} */ (item.shareKey),
8692
version: item.version,
8793
shareScope: item.shareScope || this.options.shareScope || "default",
88-
eager: Boolean(item.eager)
94+
eager: Boolean(item.eager),
95+
include: item.include,
96+
exclude: item.exclude
8997
})
9098
).sort(([a], [b]) => {
9199
if (a < b) return -1;
@@ -106,18 +114,23 @@ class ProvideSharedPlugin {
106114
/** @type {Map<string, ProvideOptions>} */
107115
const prefixMatchProvides = new Map();
108116
for (const [request, config] of provides) {
109-
if (/^\.\.?(?:\/|$)/.test(request)) {
110-
// relative request
111-
resolvedProvideMap.set(request, {
112-
config,
113-
version: config.version
114-
});
115-
} else if (ABSOLUTE_PATH_REGEXP.test(request)) {
116-
// absolute path
117-
resolvedProvideMap.set(request, {
118-
config,
119-
version: config.version
120-
});
117+
if (
118+
/^\.\.?(?:\/|$)/.test(request) ||
119+
ABSOLUTE_PATH_REGEXP.test(request)
120+
) {
121+
// relative request or absolute path
122+
if (
123+
matchesVersionFilters(
124+
config.version,
125+
config.include,
126+
config.exclude
127+
)
128+
) {
129+
resolvedProvideMap.set(request, {
130+
config,
131+
version: config.version
132+
});
133+
}
121134
} else if (request.endsWith("/")) {
122135
// module request prefix
123136
prefixMatchProvides.set(request, config);
@@ -167,6 +180,9 @@ class ProvideSharedPlugin {
167180
compilation.warnings.push(error);
168181
}
169182
}
183+
if (!matchesVersionFilters(version, config.include, config.exclude)) {
184+
return;
185+
}
170186
resolvedProvideMap.set(resource, {
171187
config,
172188
version
@@ -194,6 +210,15 @@ class ProvideSharedPlugin {
194210
for (const [prefix, config] of prefixMatchProvides) {
195211
if (request.startsWith(prefix)) {
196212
const remainder = request.slice(prefix.length);
213+
if (
214+
!matchesRequestFilters(
215+
remainder,
216+
config.include,
217+
config.exclude
218+
)
219+
) {
220+
continue;
221+
}
197222
provideSharedModule(
198223
resource,
199224
{

‎lib/sharing/SharePlugin.js‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ class SharePlugin {
6565
strictVersion: options.strictVersion,
6666
singleton: options.singleton,
6767
packageName: options.packageName,
68-
eager: options.eager
68+
eager: options.eager,
69+
include: options.include,
70+
exclude: options.exclude
6971
}
7072
}));
7173
/** @type {Record<string, ProvidesConfig>[]} */
@@ -76,7 +78,9 @@ class SharePlugin {
7678
shareKey: options.shareKey || key,
7779
shareScope: options.shareScope,
7880
version: options.version,
79-
eager: options.eager
81+
eager: options.eager,
82+
include: options.include,
83+
exclude: options.exclude
8084
}
8185
}));
8286
/** @type {string | undefined} */

‎lib/sharing/utils.js‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
"use strict";
77

88
const { dirname, join, readJson } = require("../fs/fs");
9+
const { parseRange, satisfy } = require("./semver");
910

1011
/** @import { InputFileSystem, JsonObject, JsonPrimitive } from "../fs/fs" */
12+
/** @import { SharedModuleFilter } from "../../declarations/plugins/sharing/SharePlugin" */
1113

1214
// Extreme shorthand only for github. eg: foo/bar
1315
const RE_URL_GITHUB_EXTREME_SHORT = /^[^/@:.\s][^/@:\s]*\/[^@:\s]*[^/@:\s]#\S+/;
@@ -425,3 +427,58 @@ function normalizeVersion(versionDesc) {
425427
}
426428

427429
module.exports.normalizeVersion = normalizeVersion;
430+
431+
/**
432+
* Tests the request remainder under a prefix key against `include`/`exclude` request filters.
433+
* @param {string} remainder request after the prefix
434+
* @param {SharedModuleFilter=} include only share matching requests
435+
* @param {SharedModuleFilter=} exclude don't share matching requests
436+
* @returns {boolean} true, when the request should be shared
437+
*/
438+
const matchesRequestFilters = (remainder, include, exclude) => {
439+
/**
440+
* @param {string | RegExp} pattern request filter
441+
* @returns {boolean} true, when the remainder matches
442+
*/
443+
const matches = (pattern) => {
444+
if (typeof pattern === "string") return remainder === pattern;
445+
// a global or sticky RegExp would resume from the previous match
446+
pattern.lastIndex = 0;
447+
return pattern.test(remainder);
448+
};
449+
if (include && include.request !== undefined && !matches(include.request)) {
450+
return false;
451+
}
452+
return !(
453+
exclude &&
454+
exclude.request !== undefined &&
455+
matches(exclude.request)
456+
);
457+
};
458+
459+
module.exports.matchesRequestFilters = matchesRequestFilters;
460+
461+
/**
462+
* Tests a module version against `include`/`exclude` version filters; an unknown version fails `include`.
463+
* @param {string | false | undefined} version version of the module
464+
* @param {SharedModuleFilter=} include only share matching versions
465+
* @param {SharedModuleFilter=} exclude don't share matching versions
466+
* @returns {boolean} true, when the version should be shared
467+
*/
468+
const matchesVersionFilters = (version, include, exclude) => {
469+
if (
470+
include &&
471+
include.version !== undefined &&
472+
(!version || !satisfy(parseRange(include.version), version))
473+
) {
474+
return false;
475+
}
476+
return !(
477+
exclude &&
478+
exclude.version !== undefined &&
479+
version &&
480+
satisfy(parseRange(exclude.version), version)
481+
);
482+
};
483+
484+
module.exports.matchesVersionFilters = matchesVersionFilters;

0 commit comments

Comments
 (0)