feat: recursive search for shared version by robdonn · Pull Request #2681 · module-federation/core

robdonn · 2024-06-28T11:23:19Z

Description

Allows @module-federation/enhanced to recursively search for the version of a shared module when it is not defined in it's closest package.json. A common pattern for monorepos is to have dependencies installed in the root package.json.

/monorepo
├── package.json        <---------- "lib1" dependency defined here
├── apps
│   ├── app1
│   │   ├── package.json
│   │   ├── node_modules
│   │   ├── webpack.config.js     <-------- "lib1" added to "shared" configuration here
│   │   └── src
│   │       ├── index.js
│   │       └── ...
│   └── app2
│       ├── package.json
│       ├── node_modules
│   │   ├── webpack.config.js
│       └── src
│           ├── index.js
│           └── ...
└── node_modules

Related Issue

#2680

Types of changes

Docs change / refactoring / dependency upgrade
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Checklist

I have added tests to cover my changes.
All new and existing tests passed.
I have updated the documentation.

changeset-bot · 2024-06-28T11:23:23Z

🦋 Changeset detected

Latest commit: e36fd74

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 37 packages

Name	Type
@module-federation/enhanced	Minor
@module-federation/modern-js	Minor
@module-federation/nextjs-mf	Patch
@module-federation/node	Patch
3008-runtime-remote	Patch
host	Patch
host-v5	Patch
host-vue3	Patch
remote1	Patch
remote2	Patch
remote3	Patch
remote4	Patch
@module-federation/modernjs	Patch
modernjs-ssr-dynamic-nested-remote	Patch
modernjs-ssr-dynamic-remote-new-version	Patch
modernjs-ssr-dynamic-remote	Patch
modernjs-ssr-host	Patch
modernjs-ssr-nested-remote	Patch
modernjs-ssr-remote-new-version	Patch
modernjs-ssr-remote	Patch
@module-federation/runtime	Minor
@module-federation/rspack	Minor
@module-federation/webpack-bundler-runtime	Minor
@module-federation/sdk	Minor
@module-federation/runtime-tools	Minor
@module-federation/managers	Minor
@module-federation/manifest	Minor
@module-federation/dts-plugin	Minor
@module-federation/third-party-dts-extractor	Minor
@module-federation/devtools	Minor
@module-federation/bridge-react	Minor
@module-federation/bridge-vue3	Minor
@module-federation/bridge-shared	Minor
@module-federation/bridge-react-webpack-plugin	Minor
@module-federation/retry-plugin	Minor
@module-federation/esbuild	Patch
@module-federation/utilities	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

netlify · 2024-06-28T11:23:36Z

❌ Deploy Preview for module-federation-docs failed. Why did it fail? →

Name	Link
🔨 Latest commit	`e36fd74`
🔍 Latest deploy log	https://app.netlify.com/sites/module-federation-docs/deploys/66e9c6acc8871e000886cd74

ScriptedAlchemy · 2024-06-29T02:02:23Z

I will have to see about backporting this to rspack first before i can consider merge, will follow up

robdonn · 2024-06-29T10:01:33Z

I will have to see about backporting this to rspack first before i can consider merge, will follow up

No problem, let me know if you need any more info/context

ScriptedAlchemy · 2024-07-01T07:01:45Z

no, it makes sense. Just need to look at the rust end and sync the implementation

squadronai

Summary

This pull request introduces a significant enhancement to the @module-federation/enhanced package by enabling recursive searching for the version of shared modules. This functionality is particularly beneficial for monorepo setups where dependencies are often defined in the root package.json, rather than in individual application directories.

Key changes include:

Implemented logic to traverse parent directories to locate the version of a shared module when it is not specified in the closest package.json.
Improved compatibility with monorepo structures, allowing for seamless integration of shared dependencies across multiple applications.
Added error handling to provide warnings when the required version cannot be determined, enhancing the robustness of the module.
Comprehensive tests have been added to ensure the reliability of the new feature, with all existing tests passing successfully.

Overall, these changes enhance the functionality of the module federation setup, making it more adaptable to complex project structures while maintaining a user-friendly experience.

File Summaries

File	Summary
packages/enhanced/src/lib/sharing/ConsumeSharedPlugin.ts	Enhancements have been made to enable recursive searching for the version of a shared module when it is not specified in the nearest `package.json`. The changes primarily involve modifying the logic to traverse parent directories until the required version is found, improving compatibility with monorepo structures where dependencies may be defined at the root level. This update also includes error handling to ensure that appropriate warnings are issued when the version cannot be determined.

Issues Reviewed:

Issue	Result	Reason
2680	✅	The pull request addresses the issue of resolving shared dependency versions in a monorepo setup, as described in the associated issue.

squadronai

Incremental Review

Comments posted: 0

Configuration

Squadron Mode: essential

Commits Reviewed

13861194dc80ea7ea416d3bd9fe45dc348ef9d97...a4c6d417937f7d93dcce1eaaa832b0cf47f47a5f

Files Reviewed

packages/enhanced/src/lib/sharing/ConsumeSharedPlugin.ts

Files Ignored

These files were ignored due to the filter in the squadron.yaml file.

.changeset/lucky-fans-exist.md
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/lib4/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/lib4/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/lib5/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/store/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/store/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/relative1.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/relative2.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib1/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib1/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib2/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib3/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib3/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/webpack.config.js

squadronai

Incremental Review

Comments posted: 6

Configuration

Squadron Mode: essential

Commits Reviewed

13975e1793d1e1eda4b3aed0ed919fddcff02aaf...e36fd749db46438c4097ab3b54130a6514109157

Files Reviewed

packages/enhanced/src/lib/sharing/ConsumeSharedPlugin.ts

Files Ignored

These files were ignored due to the filter in the squadron.yaml file.

.changeset/lucky-fans-exist.md
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/lib4/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/lib4/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/lib5/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/store/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/node_modules/store/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/relative1.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/app1/relative2.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib1/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib1/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib2/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib3/index.js
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/node_modules/lib3/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/package.json
packages/enhanced/test/configCases/sharing/share-plugin-monorepo/webpack.config.js

github-actions · 2024-12-08T15:40:03Z

Stale pull request message

github-actions bot added the change: feat label Jun 28, 2024

robdonn force-pushed the feat/recursive-shared-version-search branch 2 times, most recently from 5b9a3ac to 6d7a50b Compare June 28, 2024 11:30

robdonn force-pushed the feat/recursive-shared-version-search branch from cb92225 to 79b38b5 Compare July 21, 2024 17:31

robdonn force-pushed the feat/recursive-shared-version-search branch from 79b38b5 to a4c6d41 Compare September 3, 2024 15:49

squadronai bot reviewed Sep 3, 2024

View reviewed changes

robdonn added 2 commits September 17, 2024 19:12

feat: recursive search for shared version

7b2c6da

chore: add tests for share plugin recursive search

e36fd74

robdonn force-pushed the feat/recursive-shared-version-search branch from a4c6d41 to e36fd74 Compare September 17, 2024 18:12

squadronai bot reviewed Sep 17, 2024

View reviewed changes

module-federation deleted a comment from squadronai bot Oct 8, 2024

barabaiiika mentioned this pull request Oct 14, 2024

feat(enhanced): Recursive search for versions of shared dependencies #3078

Merged

6 tasks

github-actions bot added the no-pr-activity label Dec 8, 2024

ScriptedAlchemy closed this Dec 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: recursive search for shared version#2681

feat: recursive search for shared version#2681
robdonn wants to merge 2 commits intomodule-federation:mainfrom
robdonn:feat/recursive-shared-version-search

robdonn commented Jun 28, 2024

Uh oh!

changeset-bot bot commented Jun 28, 2024 •

edited

Loading

Uh oh!

netlify bot commented Jun 28, 2024 •

edited

Loading

Uh oh!

ScriptedAlchemy commented Jun 29, 2024

Uh oh!

robdonn commented Jun 29, 2024

Uh oh!

ScriptedAlchemy commented Jul 1, 2024

Uh oh!

squadronai bot left a comment

Uh oh!

squadronai bot left a comment

Uh oh!

squadronai bot left a comment

Uh oh!

github-actions bot commented Dec 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

robdonn commented Jun 28, 2024

Description

Related Issue

Types of changes

Checklist

Uh oh!

changeset-bot bot commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

netlify bot commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy Preview for module-federation-docs failed. Why did it fail? →

Uh oh!

ScriptedAlchemy commented Jun 29, 2024

Uh oh!

robdonn commented Jun 29, 2024

Uh oh!

ScriptedAlchemy commented Jul 1, 2024

Uh oh!

squadronai bot left a comment

Choose a reason for hiding this comment

Summary

Issues Reviewed:

Uh oh!

squadronai bot left a comment

Choose a reason for hiding this comment

Incremental Review

Uh oh!

squadronai bot left a comment

Choose a reason for hiding this comment

Incremental Review

Uh oh!

github-actions bot commented Dec 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot bot commented Jun 28, 2024 •

edited

Loading

netlify bot commented Jun 28, 2024 •

edited

Loading