feat(plugin_mf): Module Hoisting, Entry initialization via __webpack_require__.x, Custom Hooks #10524

ScriptedAlchemy · 2025-05-30T03:07:58Z

Summary

This pull request introduces significant enhancements to the Module Federation system by implementing new runtime modules, plugins, and dependency management features. The changes focus on enabling runtime dependency tracking, improving federation runtime initialization, and adding new hooks for better plugin communication.

Module Federation Enhancements:

Embed Federation Runtime Module: Added a new runtime module, EmbedFederationRuntimeModule, which ensures federation runtime dependencies execute before other modules by wrapping the startup function. This module generates a startup wrapper pattern to manage execution order. (crates/rspack_plugin_mf/src/container/embed_federation_runtime_module.rs)
Embed Federation Runtime Plugin: Introduced EmbedFederationRuntimePlugin to manage federation runtime initialization. It adds runtime requirements to federation-enabled chunks, injects the EmbedFederationRuntimeModule into runtime chunks, and handles explicit startup calls for entry chunks. (crates/rspack_plugin_mf/src/container/embed_federation_runtime_plugin.rs)
Federation Runtime Dependency: Implemented a new dependency type, FederationRuntimeDependency, to track runtime dependencies for federation modules. This dependency is cacheable and integrates with the existing dependency system. (crates/rspack_plugin_mf/src/container/federation_runtime_dependency.rs)

Plugin Communication and Hooks:

Federation Modules Plugin: Added FederationModulesPlugin, a central hook management system for Module Federation. It provides hooks for plugins to share dependency information and communicate through a publish-subscribe pattern. (crates/rspack_plugin_mf/src/container/federation_modules_plugin.rs)
Runtime Module for Federation: Added FederationRuntimeModule, a runtime module that initializes the federation runtime environment. It includes a chunk matcher and root output directory logic to support federation runtime initialization. (crates/rspack_plugin_mf/src/container/federation_runtime_module.rs)

Additional Changes:

New Options for Module Federation Runtime Plugin: Added RawModuleFederationRuntimePluginOptions to support custom configurations like entry_runtime and runtime_chunk. These options are used to initialize the ModuleFederationRuntimePlugin. (crates/node_binding/src/raw_options/raw_builtins/raw_mf.rs)
Dependency Updates: Updated Cargo.toml to include new dependencies such as rspack_plugin_javascript and rspack_sources, which are required for the new runtime modules and plugins. (crates/rspack_plugin_mf/Cargo.toml)

Checklist

Other notes

Should reduce bundle size by 70kb per entrypoint when there are multiple entrypoints with runtimeChunk: single

Tests updated (or not required).
Documentation updated (or not required).

…bedFederationRuntimePlugin with startup logic injection, FederationRuntimeModule for initialization, and proper runtime requirements handling. Migrated from JS to Rust for better performance and webpack compatibility.

…move all dbg! macros, debug_runtime_globals function, and related debug code - Code now runs cleanly without verbose debug output while maintaining full functionality - Federation runtime initialization and startup logic injection still work correctly

…gs - Convert multiple-entrypoints, multiple-runtime-chunk, and multiple-entrypoints-1 test cases - Update import statements to use @rspack/core.container instead of webpack dist - Add proper TypeScript type annotations for rspack Configuration - Remove deprecated webpack.config.js files after verification - Maintain identical functionality and configuration options

…tructure

…ontainer_entry_dependency.rs

…ntime initialization - Core implementation with oldStartup wrapper pattern - Handles all federation chunk scenarios - Fixed container-1-5 test dependencies

…s and options field from EmbedFederationRuntimePlugin

… field - Remove unused ChunkGraph import from embed_federation_runtime_plugin - Fix needless borrows by removing & from string literals - Replace unwrap() calls with expect() calls with descriptive messages - Remove unnecessary #[allow(dead_code)] annotations where appropriate - Add #[derive(Default)] instead of manual Default implementation - Add missing runtime_chunk field to RawModuleFederationRuntimePluginOptions - Update node binding conversion to include runtime_chunk field All clippy warnings resolved and tests passing (2337/2338)

…er plugins - Remove all println! debugging statements from embed_federation_runtime_plugin.rs - Remove all println! debugging statements from embed_federation_runtime_module.rs - Clean up console output for production readiness

… - Add detailed module-level documentation for EmbedFederationRuntimeModule explaining runtime initialization - Add comprehensive plugin documentation for EmbedFederationRuntimePlugin covering chunk handling strategy - Document FederationModulesPlugin as the central hook management system - Explain HoistContainerReferencesPlugin optimization features and processing strategy - Document ModuleFederationRuntimePlugin as the main orchestration plugin - Update ContainerPlugin documentation to reflect federation hook integration - All documentation includes key features, responsibilities, and usage patterns

…ith detailed chunk handling - Update top-level documentation to clearly explain what gets added to different chunk types - Add detailed explanations for Runtime Chunks, Entry Chunks (Delegating), and Entry Chunks (With Own Runtime) - Include activation conditions and when the plugin processes chunks - Add comprehensive inline comments explaining the three scenarios in render_startup - Document the specific purpose of EmbedFederationRuntimeModule injection in runtime chunks - Clarify when explicit startup calls are added vs when JavaScript plugin handles them naturally

…Fix misunderstanding about STARTUP runtime requirement purpose - STARTUP signals creation of __webpack_require__.startup function for entry module execution - Not specifically for federation initialization, but for webpack startup mechanism - Update comments to reflect that STARTUP enables callable startup function creation - Clarify that our plugin wraps the startup function rather than creating federation-specific logic - Explain the relationship between startup function creation and entry module execution deferral

…tation - Remove verbose explanations and keep only essential information - Simplify module-level documentation to concise descriptions - Streamline inline comments to be brief and relevant - Remove redundant sections like detailed feature lists and usage patterns - Keep only core functionality descriptions and necessary technical details - Maintain clarity while reducing documentation verbosity

netlify · 2025-05-30T03:08:03Z

✅ Deploy Preview for rspack canceled.

Name	Link
🔨 Latest commit	`f50ac94`
🔍 Latest deploy log	https://app.netlify.com/projects/rspack/deploys/683a39749fc65b00085d5b8c

…hange 'Federation runtime initialization call' to 'Federation startup call' - Keep comment concise and to the point

…in - Simplify 'Add the original FederationRuntimeModule' to 'Add base FederationRuntimeModule' - Remove verbose TokioMutex comments and keep only essential code - Add concise 'Apply supporting plugins' comment for clarity - Remove unnecessary import comments

…Remove detailed documentation sections to keep only essential code - Align with simplified documentation approach for container plugins

ScriptedAlchemy · 2025-05-30T03:14:32Z

crates/rspack_plugin_mf/src/container/embed_federation_runtime_module.rs

+    }
+
+    // Generate oldStartup wrapper pattern
+    let result = format!(


patch webpack_require.x which is entry startup function.

first initialize federation, then call previous startup if exists - if it exists, it will be webpack require of entrypoint module.

If startup doesnt exist in entrypoint bootstrap, like in single runtime chunk, another plugin will manually add require.x() to the entrypoint chunks at the begenning of startup

ScriptedAlchemy · 2025-05-30T03:17:47Z

crates/rspack_plugin_mf/src/container/embed_federation_runtime_plugin.rs

@@ -0,0 +1,244 @@
+//! # EmbedFederationRuntimePlugin


Embeds the module federation runtime module into runtime chunks, handles management of startup calls and rendering the startup of entrypoints.

ScriptedAlchemy · 2025-05-30T03:19:26Z

crates/rspack_plugin_mf/src/container/federation_modules_plugin.rs

+define_hook!(AddRemoteDependencyHook: Series(dependency: &dyn Dependency));
+
+// Struct to hold instances of the hooks for a specific compilation
+pub struct FederationModulesPluginCompilationHooks {


adds compilation hooks module federation so that communication between all plugins and modules can be simplified.

For instance we need to know when container plugin is added, we need to know when federation runtime dependency is injected, and have to track various modules in the graph throughout the compilation.

ScriptedAlchemy · 2025-05-30T03:22:24Z

crates/rspack_plugin_mf/src/container/module_federation_runtime_plugin.rs

+}
+
+#[plugin_hook(CompilerFinishMake for ModuleFederationRuntimePlugin)]
+async fn finish_make(&self, compilation: &mut Compilation) -> Result<()> {


instead of injecting a entrypoint or patching entry dependencies into each entrypoint. We will use a dependency to addInclude the module.

This will inject it with no require calls, so that our runtime module can handle startup of federation ahead of the entrypoint.

ScriptedAlchemy · 2025-05-30T03:25:42Z

crates/rspack_plugin_mf/src/container/hoist_container_references_plugin.rs

@@ -0,0 +1,388 @@
+//! # HoistContainerReferencesPlugin


Due to a bug in webpack, when using runtime chunk single, container reference modules which are external modules, as well as the federation runtime are injected into each entrypoint.

This causes initialization to fail because not all container reference modules exist in the module tree at initialization, to correct this - we will hoist these modules into the runtime chunks and remove / clean up the modules from whatever chunk they were in - we also hoist the federation runtime entry module and any referencing modules found - so that even after split chunks, these modules are always in runtime chunks for eager startup ahead of entry - also removes duplication of runtime code in all entrypoints.

… - Remove all references to "matching TypeScript implementation" - Simplify verbose comments about module collection and runtime chunks - Streamline comments about dependency processing and chunk hoisting - Remove redundant explanations while keeping essential information - Make comments more concise and focused on functionality

…_module

# Conflicts: # crates/rspack_plugin_mf/src/container/remote_module.rs # pnpm-lock.yaml

codspeed-hq · 2025-05-30T07:13:56Z

CodSpeed Performance Report

Merging #10524 will not alter performance

_{Comparing hoist-container-references (f50ac94) with main (ac67c6b)}

🎉 Hooray! `codspeed-rust` just leveled up to 2.7.2!

A heads-up, this is a breaking change and it might affect your current performance baseline a bit. But here's the exciting part - it's packed with new, cool features and promises improved result stability 🥳!
Curious about what's new? Visit our releases page to delve into all the awesome details about this new version.

Summary

✅ 12 untouched benchmarks

…timePlugin

ScriptedAlchemy · 2025-05-30T08:18:48Z

crates/rspack_plugin_mf/src/container/embed_federation_runtime_plugin.rs

+  let has_runtime = chunk.has_runtime(&compilation.chunk_group_by_ukey);
+  if has_runtime {
+    // Collect federation dependencies snapshot
+    let collected_ids_snapshot = self


hooks work a little different, since i cannot nest hooks easily, i am passing the tap results from the parent

ScriptedAlchemy · 2025-05-30T08:19:56Z

crates/rspack_plugin_mf/src/container/hoist_container_references_plugin.rs

+  Ok(())
+}
+
+#[plugin_hook(CompilationOptimizeChunks for HoistContainerReferencesPlugin, stage = Compilation::OPTIMIZE_CHUNKS_STAGE_ADVANCED + 1)]


perform this after split chunks plugin runs to correct the results.

…nerReferencesPlugin

…ell, rspack_macros)

…ESM builds

ahabhgk · 2025-06-03T02:02:57Z

This seems fix #7417 since the federation runtime is injected by runtime module instead of entry

ahabhgk

LGTM

ScriptedAlchemy · 2025-06-03T15:11:33Z

Yeah this fixed workers in v1 webpack
V2 may need some extra adjustment but it'll likely fix the bundler side and if theres any remaining issue it'll be that I need to add importScript to my runtime

ScriptedAlchemy added 16 commits May 13, 2025 12:38

feat(module-federation): add HoistContainerReferencesPlugin

5a73444

fix(federation): update ModuleFederationPlugin to use finishMake hook

10881bb

feat: add intelligent build optimization and clean up basic example s…

0b308a1

…tructure

choreL lock

effb92b

refactor(container): simplify import statement for ExposeOptions in c…

4cc9a2d

…ontainer_entry_dependency.rs

feat: implement EmbedFederationRuntimePlugin for module federation ru…

6029eb4

…ntime initialization - Core implementation with oldStartup wrapper pattern - Handles all federation chunk scenarios - Fixed container-1-5 test dependencies

refactor(plugin-mf): remove unused EmbedFederationRuntimePluginOption…

d0f2d83

…s and options field from EmbedFederationRuntimePlugin

github-actions bot added the release: feature release: feature related release(mr only) label May 30, 2025

ScriptedAlchemy added 3 commits May 29, 2025 20:08

docs(plugin-mf): further simplify federation startup call comment - C…

0bd4ad5

…hange 'Federation runtime initialization call' to 'Federation startup call' - Keep comment concise and to the point

docs(plugin-mf): remove verbose documentation from ContainerPlugin - …

6652291

…Remove detailed documentation sections to keep only essential code - Align with simplified documentation approach for container plugins

ScriptedAlchemy commented May 30, 2025

View reviewed changes

ScriptedAlchemy added 4 commits May 29, 2025 20:26

chore: fix example

4b4b57c

refactor: rename federation_runtime_module to federation_data_runtime…

4328cfe

…_module

refactor: fix import style in container_plugin.rs for consistency

ef69998

ScriptedAlchemy added 3 commits May 29, 2025 21:00

refactor: remove unnecessary variable declarations in hook calls

3dc7649

Merge branch 'main' into hoist-container-references

b8b8850

# Conflicts: # crates/rspack_plugin_mf/src/container/remote_module.rs # pnpm-lock.yaml

fix: resolve compilation errors in plugin_mf

637872c

ScriptedAlchemy and others added 4 commits May 30, 2025 01:08

Merge branch 'main' into hoist-container-references

410040a

chore: revert mistakes

91d3abf

chore: revert mistakes

74508ad

refactor: remove unused runtime_chunk option from ModuleFederationRun…

0ba4e5a

…timePlugin

ScriptedAlchemy commented May 30, 2025

View reviewed changes

ScriptedAlchemy and others added 5 commits May 30, 2025 01:33

refactor: consolidate federation dependency processing in HoistContai…

28db4f8

…nerReferencesPlugin

chore: remove unused dependencies from rspack_plugin_mf (rkyv, once_c…

fae970d

…ell, rspack_macros)

chore: update Cargo.lock after removing unused dependencies

69ed29e

test: fix Module Federation runtime test to handle both CommonJS and …

9617f90

…ESM builds

Merge branch 'main' into hoist-container-references

e1ff251

ScriptedAlchemy marked this pull request as ready for review May 30, 2025 09:32

ScriptedAlchemy added 2 commits May 30, 2025 02:56

test: fix Module Federation test for Windows path separators

4bf769a

Merge branch 'main' into hoist-container-references

f50ac94

chenjiahan requested a review from ahabhgk June 3, 2025 01:17

ahabhgk approved these changes Jun 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(plugin_mf): Module Hoisting, Entry initialization via __webpack_require__.x, Custom Hooks #10524

feat(plugin_mf): Module Hoisting, Entry initialization via __webpack_require__.x, Custom Hooks #10524

ScriptedAlchemy commented May 30, 2025 •

edited

Loading

Uh oh!

netlify bot commented May 30, 2025 •

edited

Loading

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

codspeed-hq bot commented May 30, 2025 •

edited

Loading

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

ScriptedAlchemy May 30, 2025

Uh oh!

ahabhgk commented Jun 3, 2025

Uh oh!

ahabhgk left a comment

Uh oh!

ScriptedAlchemy commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

feat(plugin_mf): Module Hoisting, Entry initialization via __webpack_require__.x, Custom Hooks #10524

Are you sure you want to change the base?

feat(plugin_mf): Module Hoisting, Entry initialization via __webpack_require__.x, Custom Hooks #10524

Conversation

ScriptedAlchemy commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Module Federation Enhancements:

Plugin Communication and Hooks:

Additional Changes:

Checklist

Other notes

Uh oh!

netlify bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rspack canceled.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging #10524 will not alter performance

🎉 Hooray! codspeed-rust just leveled up to 2.7.2!

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahabhgk commented Jun 3, 2025

Uh oh!

ahabhgk left a comment

Choose a reason for hiding this comment

Uh oh!

ScriptedAlchemy commented Jun 3, 2025

Uh oh!

Uh oh!

ScriptedAlchemy commented May 30, 2025 •

edited

Loading

netlify bot commented May 30, 2025 •

edited

Loading

codspeed-hq bot commented May 30, 2025 •

edited

Loading

🎉 Hooray! `codspeed-rust` just leveled up to 2.7.2!