feat: exclude version ranges from federation #17425

tmpaul · 2023-06-26T21:58:38Z

Summary

`🤖 Generated by Copilot at 4a3cc04`

No summary available (Limit exceeded: required to process 50446 tokens, but only 50000 are allowed per call)

Details

`🤖 Generated by Copilot at 4a3cc04`

Add a new feature to allow excluding modules or version ranges from sharing based on the exclusion criteria (link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link, link)
Define the SharedExclusionCriteria type and schema, which has a version property that represents a version or semver range of the dependency to exclude from sharing (link, link, link, link, link, link)
Add the exclusionCriteria property to the SharedConfig type and schema, which references the SharedExclusionCriteria type and schema (link, link, link, link, link)
Add the exclusionCriteria property to the config object and the item object for the ConsumeSharedPlugin and the ProvideSharedPlugin (link, link, link, link, link, link)
Add the fallbackVersion property to the exclusionCriteria property for the ConsumeSharedPlugin, which is set to the version property of the config object if it exists (link, link)
Add the path, semver, and utils modules as dependencies for the ConsumeSharedPlugin and the ProvideSharedPlugin (link, link, link, link, link)
Add the validateShareOptions function to the utils module, which performs additional validation logic for the share options and throws an error if any of the options have both exclusionCriteria and singleton set to true (link)
Add the exclusionCriteria property to the ConsumeSharedFallbackDependency class, which holds the criteria used to exclude modules or version ranges from sharing for the dependency (link)
Add a variable declaration for the consumedModule, which is an instance of the ConsumeSharedModule class, representing a module that consumes a shared module (link)
Add a block of code that checks if the exclusionCriteria is provided for the consumedModule, and if so, performs a check against the resolved import and the fallback version to determine if the consumption should be excluded (link)
Add a block of code that checks if the exclusionCriteria is provided for the shared module in the ProvideSharedPlugin, and if so, performs a check against the version of the module using the satisfy and parseRange functions from the semver module (link)
Add a call to the validateShareOptions function in the SharePlugin, passing the sharedOptions array, which contains the options for each shared module (link)
Update the generated code for the schema validation files for the ModuleFederationPlugin, the ConsumeSharedPlugin, the ProvideSharedPlugin, and the SharePlugin to reflect the changes in the JSON schema files (link, link, link, link)
Add test cases for the new feature of excluding modules from sharing based on the exclusion criteria (link, link, link, link, link, link)
- Add a test case in test/configCases/container/container-exclude-sharing to test the feature with the ModuleFederationPlugin (link, link, link, link)
- Add a test case in test/configCases/sharing/consume-module to test the feature with the SharePlugin (link, link)

First PR based on the discussion here: #17404 (comment)

New property `exclusionCriteria`

This new property is a object that in the current PR accepts a version range object using the version property.

The following logic is used for excluding a module/package from sharing

ProvideSharedPlugin

Check if exclusionCriteria.version is defined.
If yes, check if version is defined. If version is not provided, attempt to find version from closest package.json.
Check if version satisfies the exclusion range. If yes, exclude, else include.

ConsumeSharedPlugin

This plugin is more involved since there is no "inherent" version, but there is only requiredVersion. While it is possible to do range intersection of requiredVersion and exclusionCriteria.version, the current semver util lib in webpack makes this difficult to do. Instead, we pass the version property from ModuleFederationPlugin as exclusionCriteria.fallbackVersion, and use that version to check. If this property is missing, use the nearest package.json file corresponding to the resolved import.

If neither conditions match, it will be shared.

I've added inline comments to the PR to explain what I'm doing. Open to feedback/suggestions, thank you.

Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 27.2.1 to 27.2.2. - [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases) - [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md) - [Commits](jest-community/eslint-plugin-jest@v27.2.1...v27.2.2) --- updated-dependencies: - dependency-name: eslint-plugin-jest dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

Merge branch 'main' of github.com:tmpaul/webpack into feat/version-exclude

webpack-bot · 2023-06-26T21:58:46Z

For maintainers only:

This needs to be documented (issue in webpack/webpack.js.org will be filed when merged)
This needs to be backported to webpack 4 (issue will be created when merged)

tmpaul · 2023-06-26T21:59:57Z

declarations/plugins/sharing/ConsumeSharedPlugin.d.ts

+ /**
+ * Version of the package provided by the fallback if there is one.
+ */
+ fallbackVersion?: string;


Adds a new property called fallbackVersion, which is only exposed to ConsumeSharedPlugin. It is not directly accessible to ModuleFederationPlugin consumers. The value of this property is the truthy value of version property passed to ModuleFederationPlugin.

tmpaul · 2023-06-26T22:01:05Z

lib/sharing/ConsumeSharedPlugin.js

+ // Without a resolved import, we cannot proceed with exclusion check
+ if (!importResolved) {
+ return consumedModule;
+ }


Here, we check if importResolved can be mapped out. If there is no resolved import path for a request, we cannot decide whether to exclude it from sharing, so by default include it.

tmpaul · 2023-06-26T22:01:33Z

lib/sharing/ConsumeSharedPlugin.js

+ config.exclusionCriteria.fallbackVersion
+ )
+ ) {
+ return undefined;


If user has supplied a version property to ModuleFed plugin, use that to check against the exclusionCriteria.version range

tmpaul · 2023-06-26T22:03:04Z

lib/sharing/ConsumeSharedPlugin.js

+ // not exist in the package.json file, then we use the "version" property
+ // set by users in the share config, which is passed here as fallbackVersion
+ // a.k.a the version used to register the package in the scope.
+ getDescriptionFile(


Find the closest package.json for the resolved import. This gives us the version of the package/module that corresponds to the request. Note that there are shared modules that do not have a corresponding package.json file, and for these, we do not exclude them from sharing unless the user supplies a version property. If that is the case, the check in line 269 will activate

tmpaul · 2023-06-26T22:03:38Z

lib/sharing/ConsumeSharedPlugin.js

+ !data ||
+ (data && !data.version) ||
+ (data && data.name !== request)
+ ) {


Check that the package.json name matches the requested module. Otherwise it can resolve to the root package.json of the project.

tmpaul · 2023-06-26T22:04:25Z

lib/sharing/SharePlugin.js

+ ...options.exclusionCriteria,
+ fallbackVersion: options.version ? options.version : undefined
+ }
+ : undefined,


Pass in version as fallbackVersion to exclusionCriteria. As far a consumed module is concerned, the version property represents the version of the fallback.

Merge branch 'main' of github.com:tmpaul/webpack into feat/version-exclude

tmpaul · 2023-07-02T14:51:14Z

@alexander-akait Friendly bump

alexander-akait · 2024-01-04T14:46:45Z

@tmpaul Sorry for long delay (long store), is it still valid?

tmpaul · 2024-01-23T16:58:32Z

@tmpaul Sorry for long delay (long store), is it still valid?

@alexander-akait Yes. Due to the time gap, I assumed that it would not be reviewed. I have merged the latest changes. Please take a look when you can

alexander-akait · 2024-01-23T17:01:47Z

@ScriptedAlchemy Hello, what do you think about this PR?

tmpaul and others added 30 commits June 21, 2023 00:34

feat: add version exclusion

f097be1

chore: add test case for exclusion

3c6910d

chore: adjust warnings

84a3fc3

chore: add additional statements to test

b684b01

chore: adjust test case

c398bb5

fix: require.context and layer

1477416

test: update

4a27246

test: added

aec247b

test: fixed

43ec503

test: fix name and bug in test

15399c6

fix: runtime for CSS loading

563c6ac

test: fix

831094e

feat: use css/auto as default css type

213b01b

test: update snapshots

91309bf

refactor: rewrite defaults

c6767ff

test: update snapshots

d20a11f

test: update tests

b62b334

test: update snapshots

2046031

feat: update regex to match valid css file names

b5daf64

test: add tests for module extensions

f0b3556

test: fix tests

e299975

test: prefer relative

90472f8

fix: bug with css/auto

babf240

fix: indirect call to tagged template expression

8d31b66

refactor(types): fix

dd75c40

fix: update environment support for KaiOS browser

417fea9

test: update

30ae157

fix: tla for await won't run

fbaafa7

fix: forgot .d

f90cc6e

ersachin3112 and others added 14 commits June 23, 2023 13:18

docs: add example for stats minimal output

c2019c3

chore: fix lint

c268246

chore: fix lint

0236599

chore: fix lint

02e93e9

refactor(types): more

034a8eb

refactor(types): more

65313c6

refactor(types): more

a9f661a

refactor(types): more

dfa531c

refactor(types): more

487ba3e

refactor(types): more

cbd3c88

refactor(types): more

8429fad

5.88.0

ac68a79

chore: merge main branch

683bb8f

Merge branch 'main' of github.com:tmpaul/webpack into feat/version-exclude

fix: use fallback version in consume shared

4a3cc04

webpack-bot added the PR: unreviewed label Jun 26, 2023

tmpaul commented Jun 26, 2023

View reviewed changes

tmpaul added 3 commits June 26, 2023 18:08

chore(lint): Add description in schema

9735e40

chore(lint): update consume shared

6be2a1a

chore: merge upstream

35f67c0

Merge branch 'main' of github.com:tmpaul/webpack into feat/version-exclude

webpack-bot added the PR: conflict label Aug 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: exclude version ranges from federation #17425

feat: exclude version ranges from federation #17425

tmpaul commented Jun 26, 2023 •

edited

Loading

webpack-bot commented Jun 26, 2023

tmpaul Jun 26, 2023

tmpaul Jun 26, 2023

tmpaul Jun 26, 2023

tmpaul Jun 26, 2023

tmpaul Jun 26, 2023

tmpaul Jun 26, 2023

tmpaul commented Jul 2, 2023

alexander-akait commented Jan 4, 2024

tmpaul commented Jan 23, 2024

alexander-akait commented Jan 23, 2024

feat: exclude version ranges from federation #17425

Are you sure you want to change the base?

feat: exclude version ranges from federation #17425

Conversation

tmpaul commented Jun 26, 2023 • edited Loading

Summary

🤖 Generated by Copilot at 4a3cc04

Details

🤖 Generated by Copilot at 4a3cc04

First PR based on the discussion here: #17404 (comment)

New property exclusionCriteria

ProvideSharedPlugin

ConsumeSharedPlugin

webpack-bot commented Jun 26, 2023

tmpaul Jun 26, 2023

Choose a reason for hiding this comment

tmpaul Jun 26, 2023

Choose a reason for hiding this comment

tmpaul Jun 26, 2023

Choose a reason for hiding this comment

tmpaul Jun 26, 2023

Choose a reason for hiding this comment

tmpaul Jun 26, 2023

Choose a reason for hiding this comment

tmpaul Jun 26, 2023

Choose a reason for hiding this comment

tmpaul commented Jul 2, 2023

alexander-akait commented Jan 4, 2024

tmpaul commented Jan 23, 2024

alexander-akait commented Jan 23, 2024

tmpaul commented Jun 26, 2023 •

edited

Loading

`🤖 Generated by Copilot at 4a3cc04`

`🤖 Generated by Copilot at 4a3cc04`

New property `exclusionCriteria`