chore: split runtime as core and entry #3154
Open
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
✅ 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
The core changes in this pull request involve splitting the runtime module into two separate parts: runtime-core and entry. The key goals of this change are:
-
Separation of Concerns: The
runtime-coremodule is designed to have no side effects, while theentrymodule will handle caching the federation instance and have side effects. This separation of concerns aims to improve the overall structure and maintainability of the codebase. -
Externalization of
runtime-core: Theruntime-coremodule is now externalized, allowing for better modularity and flexibility in the project's dependencies. This change also enables the consolidation of various utility functions, types, and theFederationHostcomponent into a single, centralized export. -
Improved Caching: The
entrymodule will now cache the federation instance, ensuring that the same instance is used across the application and improving performance and consistency.
The changes touch a wide range of files, primarily within the packages/runtime-core directory, but also in the packages/runtime directory. The updates involve modifying imports and exports, introducing new utility functions and types, and ensuring a seamless integration of the new runtime-core and entry modules with the existing codebase.
Overall, this pull request aims to enhance the structure, maintainability, and performance of the runtime module by separating its concerns and externalizing the core functionality.
File Summaries
| File | Summary |
|---|---|
| packages/runtime-core/src/constant.ts | The changes in this file involve splitting the runtime into two separate parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module will cache the federation instance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/core.ts | The changes in this file involve splitting the runtime into two separate parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module will cache the federation instance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/global.ts | The code changes introduce a split of the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. Additionally, the runtime-core is now externalized. |
| packages/runtime-core/src/helpers.ts | The code changes introduce a new module that exports two utility objects: GlobalUtils and ShareUtils. The GlobalUtils object provides a collection of functions related to managing global state and information, such as setting and retrieving global federation instances, snapshots, and preloaded data. The ShareUtils object provides functions for managing shared modules and their global scope. |
| packages/runtime-core/src/index.ts | This code change splits the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. The changes also externalize the runtime-core and update the exports to include various utility functions, types, and the FederationHost component. |
| packages/runtime-core/src/module/index.ts | The changes in this file involve splitting the runtime into two separate parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module has side effects and will cache the federationInstance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/plugins/generate-preload-assets.ts | The changes in this file split the runtime into two parts - runtime-core and entry. The runtime-core is now externalized and has no side effects, while the entry part has side effects and will cache the federationInstance. |
| packages/runtime-core/src/plugins/snapshot/SnapshotHandler.ts | This change splits the runtime into two parts - runtime-core and entry. The runtime-core module is now externalized and has no side effects, while the entry module has side effects and will cache the federationInstance. This separation of concerns helps improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/plugins/snapshot/index.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. This separation allows for better modularity and flexibility in the codebase. |
| packages/runtime-core/src/remote/index.ts | The changes in this file involve splitting the runtime into two separate parts: runtime-core and entry. The runtime-core part has no side effects, while the entry part has side effects and will cache the federationInstance. This change aims to externalize the runtime-core functionality. |
| packages/runtime-core/src/shared/index.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and will cache the federationInstance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/type/config.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module has side effects and will cache the federationInstance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/type/index.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. This separation allows for better modularity and flexibility in the codebase. |
| packages/runtime-core/src/type/plugin.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/type/preload.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/types.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module will cache the federationInstance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/env.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module has side effects and will cache the federationInstance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/hooks/asyncHook.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. |
| packages/runtime-core/src/utils/hooks/asyncWaterfallHooks.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module has side effects and will cache the federationInstance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/hooks/index.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. This change aims to externalize the runtime-core for better modularity and maintainability. |
| packages/runtime-core/src/utils/hooks/pluginSystem.ts | The code changes introduce a split of the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and will cache the federationInstance. This change aims to externalize the runtime-core module for better modularity and flexibility. |
| packages/runtime-core/src/utils/hooks/syncHook.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/hooks/syncWaterfallHook.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and will cache the federationInstance. |
| packages/runtime-core/src/utils/index.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. This separation aims to externalize the runtime-core for improved modularity and maintainability. |
| packages/runtime-core/src/utils/load.ts | The code changes split the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. Additionally, the runtime-core module is now externalized, allowing for more flexibility in the project's dependencies. |
| packages/runtime-core/src/utils/logger.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. This separation allows for better modularity and flexibility in the codebase. |
| packages/runtime-core/src/utils/manifest.ts | The code changes introduce a split of the runtime into two parts: runtime-core and entry. The runtime-core is now externalized and has no side effects, while the entry part has side effects and will cache the federationInstance. |
| packages/runtime-core/src/utils/plugin.ts | The changes in this file split the runtime into two separate parts: runtime-core and entry. The runtime-core module is now externalized and has no side effects, while the entry module handles caching the federation instance and has side effects. |
| packages/runtime-core/src/utils/preload.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module has side effects and will cache the federationInstance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/semver/compare.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and will cache the federationInstance. This change aims to externalize the runtime-core module for better modularity and maintainability. |
| packages/runtime-core/src/utils/semver/constants.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module has side effects and will cache the federation instance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/semver/index.ts | The changes in this file involve splitting the runtime into two separate parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module will cache the federation instance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/semver/parser.ts | The changes in this file involve splitting the runtime into two parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module will cache the federationInstance. This separation aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/semver/utils.ts | The code changes introduce a split of the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. This change aims to externalize the runtime-core for better modularity and maintainability. |
| packages/runtime-core/src/utils/share.ts | The changes in this file involve splitting the runtime into two separate parts: runtime-core and entry. The runtime-core module is designed to have no side effects, while the entry module will handle caching the federation instance. This separation of concerns aims to improve the overall structure and maintainability of the codebase. |
| packages/runtime-core/src/utils/tool.ts | The changes in this file split the runtime into two parts: runtime-core and entry. The runtime-core has no side effects, while the entry part has side effects and will cache the federationInstance. This separation allows for better modularity and flexibility in the codebase. |
| packages/runtime/src/helpers.ts | The code changes split the runtime into two parts: runtime-core and entry. The runtime-core module has no side effects, while the entry module has side effects and caches the federation instance. The changes also externalize the runtime-core module and provide a consolidated export for the global and share utilities. |
| packages/runtime/src/index.ts | This code change splits the runtime into two parts: runtime-core and entry. The runtime-core part has no side effects, while the entry part has side effects and will cache the federationInstance. The changes also externalize the runtime-core module and update the imports and exports accordingly. |
| packages/runtime/src/types.ts | The code changes split the runtime module into two parts: runtime-core and entry. The runtime-core module is now externalized and has no side effects, while the entry module handles caching of the federation instance and has side effects. |
| packages/runtime/src/utils.ts | The code changes introduce a new utility function getGlobalFederationInstance that retrieves a specific instance of the FederationHost based on the provided name and version. Additionally, a helper function getBuilderId is added to fetch the build identifier, which is used to identify the correct FederationHost instance when multiple instances exist. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| it('verify resources when URL specifies protocol (http)', () => { | ||
| const url = 'http://a.b.c'; | ||
| const scriptElement = document.createElement('script'); | ||
| scriptElement.src = url; |
Check warning
Code scanning / CodeQL
Inclusion of functionality from an untrusted source Medium test
|
ScriptedAlchemy
force-pushed
the
chore/external-runtime-core
branch
from
67a6235 to
d56d6fa
Compare
# Conflicts: # pnpm-lock.yaml
# Conflicts: # pnpm-lock.yaml
# Conflicts: # pnpm-lock.yaml
ScriptedAlchemy
changed the title
# Conflicts: # pnpm-lock.yaml
# Conflicts: # pnpm-lock.yaml
ScriptedAlchemy
force-pushed
the
chore/external-runtime-core
branch
from
f7479be to
8e13a48
Compare
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
Related Issue
Types of changes
Checklist