feat: add module federation plugin (#1764)

* feat: support module federation

* feat: mf exposes to remote entries

* chore: code styles

* feat: mf container entry impl

* fix: mf container entry

* fix: mf runtime initOptions

* feat: add containter references

* feat: impl mf remote

* feat: improve mf exposes

* fix: mf exposes runtime factory

* fix: mf plugin execution order

* chore: update mf demo

* feat: generate mf manifest in rust

* fix: remote stats.json

* refactor: code styles

* chore: add some FIXME

* refactor: mf plugin mods files

* refactor: mf plugin mods files

* chore: remove dead code

* --wip-- [skip ci]

* fix: remote stats.json

* fix: typos

* chore: simpify mf runtime codes fmt

* refactor: mf containter plugin

* feat: mf shared workaround

* feat: mf shared workaround

* fix: runtime template and remove some useless codes

* fix: mf dev server

* fix: mf shared config

* feat: supports chunk group exclude

* feat: mf patch code splitting

* feat: mf shared manifest

* feat: add config hash for mf shared module

* chore: update mako typings

* chore: code styles

* chore: fix typo

* chore: code styles

* perf: improve performance

* chore: code styles

* chore: rename types

* feat: add options to disable mf manifest

* feat: entry config should be defined as BTreeMap

* fix: mf shared consume and supports eager config

* fix: mf shared eager

* fix: not generate chunk for mf remote module

* fix: typos

* feat: add entry filename supports

* chore: remove meaning less changes

* fix: entry filename and mf config

* release: @umijs/[email protected]

* fix: ignore shared dep when it is been external

* Revert "release: @umijs/[email protected]"

This reverts commit d3105d9.

* release: @umijs/[email protected]

* fix: skip serialize mf manifest remoteEntry if none

* fix: mf manifest remoteEntry address

* Revert "release: @umijs/[email protected]"

This reverts commit 6179982.

* fix: typo

* fix: mako mf manifest publicPath

* fix: mf manifest panic

* fix: mf typings

* test: add e2e test for mf

* fix: typo

* chore: update README

* fix: update mf bingding typings

* fix: typings

* fix: should not generate mf remotes runtime when remotes is empty

* chore: remote wrong comment

* feat: add chunk matcher for mf

Author: xusd320

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  
+
 <img src="https://img.alicdn.com/imgextra/i2/O1CN01kdmA7X1FVqCPcRi3L_!!6000000000493-2-tps-584-584.png" alt="Mako logo" width="160" height="160" />
 
 # Mako 🦈
@@ -10,7 +10,7 @@
 [![](https://badgen.net/npm/license/umi)](https://www.npmjs.com/package/@umijs/mako)
 [![codecov](https://codecov.io/gh/umijs/mako/graph/badge.svg?token=ptCnNedFGf)](https://codecov.io/gh/umijs/mako)
 
-Mako `['mɑːkoʊ]` is an **extremely fast**, **production-grade** web bundler based on **Rust**. 
+Mako `['mɑːkoʊ]` is an **extremely fast**, **production-grade** web bundler based on **Rust**.
 
 ✨ See more at [makojs.dev](https://makojs.dev).
 </div>
@@ -56,6 +56,7 @@ This project is inspired by:
 - [oxc-resolver](https://github.com/oxc-project/oxc-resolver) by [@Boshen](https://github.com/Boshen) which powered the resolver of Mako.
 - [Oxc](https://github.com/oxc-project/oxc/) by [@Boshen](https://github.com/Boshen) from which we learned a lot about how to develop efficiently in Rust.
 - [biome](https://github.com/biomejs/biome) by [@ematipico](https://github.com/ematipico) from which we learned a lot about how to develop efficiently in Rust.
+- [module-federation](https://github.com/module-federation/core) by [@ScriptedAlchemy](https://github.com/ScriptedAlchemy)，which inspired a lot and powered the module federation feature of Mako.
 
 ## LICENSE
 

crates/binding/src/js_plugin.rs

@@ -218,6 +218,7 @@ impl Plugin for JsPlugin {
         &self,
         content: &mut Content,
         path: &str,
+        _is_entry: bool,
         context: &Arc<Context>,
     ) -> Result<Option<Content>> {
         if let Some(hook) = &self.hooks.transform_include {

crates/binding/src/lib.rs

@@ -157,9 +157,34 @@ pub struct BuildParams {
     rscClient?: false | {
         "logServerComponent": "error" | "ignore";
     };
+    moduleFederation?: {
+        name: string;
+        filename?: string;
+        exposes?: Record<string, string>;
+        shared: Record<string,
+            {
+                singleton?: bool;
+                strictVersion?: bool;
+                requiredVersion?: string;
+                eager?: bool;
+                shareScope?: string;
+            }
+        >;
+        remotes?: Record<string, string>;
+        runtimePlugins?: string[];
+        shareScope?: string;
+        shareStrategy?: "version-first" | "loaded-first";
+        implementation: string;
+    };
     experimental?: {
         webpackSyntaxValidate?: string[];
+        requireContext?: bool;
+        ignoreNonLiteralRequire?: bool;
+        magicComment?: bool;
+        detectCircularDependence?: { ignore?: string[] };
         rustPlugins?: Array<[string, any]>;
+        centralEnsure?: bool,
+        importsChecker?: bool,
     };
     watch?: {
         ignoredPaths?: string[];

crates/mako/src/build.rs

@@ -16,9 +16,9 @@ use crate::ast::file::{Content, File, JsContent};
 use crate::ast::utils::get_module_system;
 use crate::compiler::{Compiler, Context};
 use crate::generate::chunk_pot::util::hash_hashmap;
-use crate::module::{Module, ModuleAst, ModuleId, ModuleInfo};
+use crate::module::{FedereationModuleType, Module, ModuleAst, ModuleId, ModuleInfo, ModuleSystem};
 use crate::plugin::NextBuildParam;
-use crate::resolve::ResolverResource;
+use crate::resolve::{ConsumeSharedInfo, RemoteInfo, ResolverResource};
 use crate::utils::thread_pool;
 
 #[derive(Debug, Error)]
@@ -46,6 +46,15 @@ impl Compiler {
                 rs.send(result).unwrap();
             });
         };
+
+        let build_consume_share_with_pool = |consume_share_info: ConsumeSharedInfo| {
+            let rs = rs.clone();
+            let context = self.context.clone();
+            thread_pool::spawn(move || {
+                let result = Self::build_consume_shared_module(consume_share_info, context.clone());
+                rs.send(result).unwrap();
+            });
+        };
         let mut count = 0;
         for file in files {
             count += 1;
@@ -127,13 +136,22 @@ impl Compiler {
                         ResolverResource::Ignored(_) => {
                             Self::create_ignored_module(&path, self.context.clone())
                         }
+                        ResolverResource::Remote(remote_into) => {
+                            Self::create_remote_module(remote_into)
+                        }
+                        ResolverResource::Shared(consume_share_info) => {
+                            count += 1;
+                            build_consume_share_with_pool(consume_share_info.clone());
+                            Self::create_empty_module(&dep_module_id)
+                        }
                     };
 
                     // 拿到依赖之后需要直接添加 module 到 module_graph 里，不能等依赖 build 完再添加
                     // 是因为由于是异步处理各个模块，后者会导致大量重复任务的 build_module 任务（3 倍左右）
                     module_ids.insert(module.id.clone());
                     module_graph.add_module(module);
                 }
+
                 module_graph.add_dependency(&module_id, &dep_module_id, dep.dependency);
             }
             if count == 0 {
@@ -267,6 +285,12 @@ __mako_require__.loadScript('{}', (e) => e.type === 'load' ? resolve() : reject(
             result
         }
     }
+    pub fn build_consume_shared_module(
+        consume_share_info: ConsumeSharedInfo,
+        _context: Arc<Context>,
+    ) -> Result<Module> {
+        Ok(Self::create_consume_share_module(consume_share_info))
+    }
 
     pub fn build_module(
         file: &File,
@@ -279,6 +303,7 @@ __mako_require__.loadScript('{}', (e) => e.type === 'load' ? resolve() : reject(
         let content = context.plugin_driver.load_transform(
             &mut content,
             &file.path.to_string_lossy(),
+            file.is_entry,
             &context,
         )?;
         file.set_content(content);
@@ -329,4 +354,32 @@ __mako_require__.loadScript('{}', (e) => e.type === 'load' ? resolve() : reject(
         let module = Module::new(module_id, is_entry, Some(info));
         Ok(module)
     }
+
+    pub(crate) fn create_remote_module(remote_info: RemoteInfo) -> Module {
+        Module {
+            is_entry: false,
+            id: remote_info.module_id.as_str().into(),
+            info: Some(ModuleInfo {
+                resolved_resource: Some(ResolverResource::Remote(remote_info.clone())),
+                federation: Some(FedereationModuleType::Remote),
+                ..Default::default()
+            }),
+            side_effects: true,
+        }
+    }
+
+    pub(crate) fn create_consume_share_module(consume_share_info: ConsumeSharedInfo) -> Module {
+        Module {
+            is_entry: false,
+            id: consume_share_info.module_id.as_str().into(),
+            info: Some(ModuleInfo {
+                deps: consume_share_info.deps.clone(),
+                resolved_resource: Some(ResolverResource::Shared(consume_share_info.clone())),
+                federation: Some(FedereationModuleType::ConsumeShare),
+                module_system: ModuleSystem::Custom,
+                ..Default::default()
+            }),
+            side_effects: true,
+        }
+    }
 }

crates/mako/src/build/analyze_deps.rs

@@ -59,10 +59,14 @@ impl AnalyzeDeps {
             );
             match result {
                 Ok(resolver_resource) => {
-                    resolved_deps.push(ResolvedDep {
+                    let resolved_dep = ResolvedDep {
                         resolver_resource,
                         dependency: dep,
-                    });
+                    };
+                    context
+                        .plugin_driver
+                        .after_resolve(&resolved_dep, &context)?;
+                    resolved_deps.push(resolved_dep);
                 }
                 Err(_err) => {
                     missing_deps.insert(dep.source.clone(), dep);

crates/mako/src/compiler.rs

@@ -23,6 +23,7 @@ use crate::generate::optimize_chunk::OptimizeChunksInfo;
 use crate::module_graph::ModuleGraph;
 use crate::plugin::{Plugin, PluginDriver, PluginGenerateEndParams};
 use crate::plugins;
+use crate::plugins::module_federation::ModuleFederationPlugin;
 use crate::resolve::{get_resolvers, Resolvers};
 use crate::share::helpers::SWC_HELPERS;
 use crate::stats::StatsInfo;
@@ -314,7 +315,6 @@ impl Compiler {
                 Arc::new(plugins::bundless_compiler::BundlessCompilerPlugin {}),
             );
         }
-
         if std::env::var("DEBUG_GRAPH").is_ok_and(|v| v == "true") {
             plugins.push(Arc::new(plugins::graphviz::Graphviz {}));
         }
@@ -327,6 +327,10 @@ impl Compiler {
             plugins.push(Arc::new(plugins::central_ensure::CentralChunkEnsure {}));
         }
 
+        if let Some(mf_cfg) = config.module_federation.as_ref() {
+            plugins.push(Arc::new(ModuleFederationPlugin::new(mf_cfg.clone())));
+        }
+
         if let Some(minifish_config) = &config._minifish {
             let inject = if let Some(inject) = &minifish_config.inject {
                 let mut map = HashMap::new();
@@ -423,7 +427,7 @@ impl Compiler {
                 .entry
                 .values()
                 .map(|entry| {
-                    let mut entry = entry.to_string_lossy().to_string();
+                    let mut entry = entry.import.to_string_lossy().to_string();
                     let is_browser = matches!(
                         self.context.config.platform,
                         crate::config::Platform::Browser
@@ -492,6 +496,7 @@ impl Compiler {
                 self.context
                     .plugin_driver
                     .generate_end(&params, &self.context)?;
+
                 self.context.plugin_driver.write_bundle(&self.context)?;
                 Ok(())
             }

crates/mako/src/config.rs

@@ -3,6 +3,7 @@ mod code_splitting;
 mod dev_server;
 mod devtool;
 mod duplicate_package_checker;
+pub mod entry;
 mod experimental;
 mod external;
 mod generic_usize;
@@ -12,6 +13,7 @@ mod macros;
 mod manifest;
 mod minifish;
 mod mode;
+pub mod module_federation;
 mod module_id_strategy;
 mod optimization;
 mod output;
@@ -28,9 +30,9 @@ mod tree_shaking;
 mod umd;
 mod watch;
 
-use std::collections::{BTreeMap, HashMap};
+use std::collections::HashMap;
 use std::fmt;
-use std::path::{Path, PathBuf};
+use std::path::Path;
 
 pub use analyze::AnalyzeConfig;
 use anyhow::{anyhow, Result};
@@ -42,6 +44,7 @@ pub use devtool::{deserialize_devtool, DevtoolConfig};
 pub use duplicate_package_checker::{
     deserialize_check_duplicate_package, DuplicatePackageCheckerConfig,
 };
+use entry::{Entry, EntryItem};
 use experimental::ExperimentalConfig;
 pub use external::{
     ExternalAdvanced, ExternalAdvancedSubpath, ExternalAdvancedSubpathConverter,
@@ -54,6 +57,7 @@ pub use manifest::{deserialize_manifest, ManifestConfig};
 use miette::{miette, ByteOffset, Diagnostic, NamedSource, SourceOffset, SourceSpan};
 pub use minifish::{deserialize_minifish, MinifishConfig};
 pub use mode::Mode;
+use module_federation::ModuleFederationConfig;
 pub use module_id_strategy::ModuleIdStrategy;
 pub use optimization::{deserialize_optimization, OptimizationConfig};
 use output::get_default_chunk_loading_global;
@@ -135,7 +139,7 @@ pub enum CopyConfig {
 #[derive(Deserialize, Serialize, Debug)]
 #[serde(rename_all = "camelCase")]
 pub struct Config {
-    pub entry: BTreeMap<String, PathBuf>,
+    pub entry: Entry,
     pub output: OutputConfig,
     pub resolve: ResolveConfig,
     #[serde(deserialize_with = "deserialize_manifest", default)]
@@ -228,6 +232,7 @@ pub struct Config {
         default
     )]
     pub check_duplicate_package: Option<DuplicatePackageCheckerConfig>,
+    pub module_federation: Option<ModuleFederationConfig>,
     // 是否开启 case sensitive 检查,只有mac平台才需要开启
     #[serde(rename = "caseSensitiveCheck")]
     pub case_sensitive_check: bool,
@@ -369,7 +374,13 @@ impl Config {
                     for ext in JS_EXTENSIONS {
                         let file_path = root.join(file_path).with_extension(ext);
                         if file_path.exists() {
-                            config.entry.insert("index".to_string(), file_path);
+                            config.entry.insert(
+                                "index".to_string(),
+                                EntryItem {
+                                    filename: None,
+                                    import: file_path,
+                                },
+                            );
                             break 'outer;
                         }
                     }
@@ -382,28 +393,29 @@ impl Config {
             // normalize entry
             config.entry.iter_mut().try_for_each(|(k, v)| {
                 #[allow(clippy::needless_borrows_for_generic_args)]
-                if let Ok(entry_path) = root.join(&v).canonicalize()
+                if let Ok(entry_path) = root.join(&v.import).canonicalize()
                     && entry_path.is_file()
                 {
-                    *v = entry_path;
+                    v.import = entry_path;
                 } else {
                     for ext in JS_EXTENSIONS {
                         #[allow(clippy::needless_borrows_for_generic_args)]
-                        if let Ok(entry_path) = root.join(&v).with_extension(ext).canonicalize()
+                        if let Ok(entry_path) =
+                            root.join(&v.import).with_extension(ext).canonicalize()
                             && entry_path.is_file()
                         {
-                            *v = entry_path;
+                            v.import = entry_path;
                             return Ok(());
                         }
 
                         if let Ok(entry_path) = root
-                            .join(&v)
+                            .join(&v.import)
                             .join("index")
                             .with_extension(ext)
                             .canonicalize()
                             && entry_path.is_file()
                         {
-                            *v = entry_path;
+                            v.import = entry_path;
                             return Ok(());
                         }
                     }

crates/mako/src/config/entry.rs

@@ -0,0 +1,37 @@
+use std::collections::BTreeMap;
+use std::path::PathBuf;
+
+use serde::{Deserialize, Serialize};
+use serde_json::Value;
+
+#[derive(Serialize, Debug)]
+pub struct EntryItem {
+    #[serde(default)]
+    pub filename: Option<String>,
+    pub import: PathBuf,
+}
+
+pub type Entry = BTreeMap<String, EntryItem>;
+
+impl<'de> Deserialize<'de> for EntryItem {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: serde::Deserializer<'de>,
+    {
+        let value: serde_json::Value = serde_json::Value::deserialize(deserializer)?;
+        match &value {
+            Value::String(s) => Ok(EntryItem {
+                filename: None,
+                import: s.into(),
+            }),
+            Value::Object(_) => {
+                Ok(serde_json::from_value::<EntryItem>(value).map_err(serde::de::Error::custom)?)
+            }
+            _ => Err(serde::de::Error::custom(format!(
+                "invalid `{}` value: {}",
+                stringify!(deserialize_umd).replace("deserialize_", ""),
+                value
+            ))),
+        }
+    }
+}