fix: handle circular init shared #2876
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: a714fc8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 36 packages
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 |
✅ Deploy Preview for module-federation-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![squadronai[bot]](https://avatars.githubusercontent.com/in/901096?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary
This pull request focuses on fixing a bug related to the handling of circular initialization of shared dependencies in the federation runtime. The key changes include:
- Introduction of a new
InitTokenstype and aCallFromtype to better manage the initialization process of shared modules. - Modifications to the
initializeSharingmethod of theFederationHostclass to accept additional options, including aninitScopeand afromparameter, to handle circular dependencies. - Updates to the
loadRemotemethod to accept an optionalfromparameter of typeCallFromto specify the origin of the remote module loading request. - Enhancements to the
SharedHandlerclass to introduce new propertiesinitTokensandinitScopeto track and manage the initialization process of shared modules, and modifications to theinitfunction of remote modules to pass theinitScopeparameter.
These changes aim to improve the robustness and reliability of the federation runtime's handling of shared dependencies, especially in scenarios where circular dependencies may arise.
File Summaries
| File | Summary |
|---|---|
| packages/runtime/src/core.ts | The code changes introduce a new InitTokens type and a CallFrom type, and update the initializeSharing method of the FederationHost class to accept additional options, including an initScope and a from parameter. These changes appear to be part of a fix for handling circular initialization of shared dependencies. |
| packages/runtime/src/remote/index.ts | The code changes introduce a new type called CallFrom to handle the source of the remote module loading, whether it's from the build or runtime. Additionally, the loadRemote method now accepts an optional from parameter of type CallFrom to specify the origin of the remote module loading request. |
| packages/runtime/src/shared/index.ts | The code changes introduce a mechanism to handle circular dependencies in the initialization of shared modules. The key modifications are: |
- Addition of new properties
initTokensandinitScopeto theSharedHandlerclass to track and manage the initialization process of shared modules. - Modification of the
initializeSharingmethod to check for circular dependencies and avoid re-initializing shared modules that are already in the process of being initialized. - The
initfunction of remote modules is now called with theinitScopeparameter to provide information about the current initialization context. |
| packages/runtime/src/type/config.ts | The code changes introduce a new typeInitTokensto represent a record of tokens with their associated data, and modify theInitScopetype to be an array ofInitTokens. Additionally, a new typeCallFromis introduced to represent the context in which the remote entry is being initialized, either 'build' or 'runtime'. |
|
@2heal1 - don't mind me :) just testing out some changes |
|
@squadronai review |
There was a problem hiding this comment.
Incremental Review
Comments posted: 0
Configuration
Squadron Mode: essential
Commits Reviewed
b90fa7ded8786022d900081dd7c871f317c5e4b9...a714fc84999f44a49dbf6e31b127ed6084df825d
Files Reviewed
- packages/runtime/src/core.ts
- packages/runtime/src/remote/index.ts
- packages/runtime/src/shared/index.ts
- packages/runtime/src/type/config.ts
Files Ignored
These files were ignored due to the filter in the squadron.yaml file.
- .changeset/itchy-ducks-crash.md
- packages/webpack-bundler-runtime/src/initializeSharing.ts
zhoushaw
approved these changes
Aug 26, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
handle circular init shared
Related Issue
idonava/base-mf-app#2
Types of changes
Checklist