rspack_plugin_mf 0.100.1

rspack module federation plugin
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
use std::sync::{Arc, RwLock};

use rspack_core::{
  AsyncDependenciesBlockIdentifier, ChunkUkey, Compilation,
  CompilationAdditionalTreeRuntimeRequirements, CompilationDependencyReferencedExports,
  CompilationOptimizeDependencies, CompilationProcessAssets, DependenciesBlock, Dependency,
  DependencyId, DependencyType, ExportsInfoArtifact, ExtendedReferencedExport, Module, ModuleGraph,
  ModuleIdentifier, Plugin, RuntimeGlobals, RuntimeModule, RuntimeModuleExt, RuntimeSpec,
  SideEffectsOptimizeArtifact,
  build_module_graph::BuildModuleGraphArtifact,
  module_declared_side_effect_free,
  rspack_sources::{RawStringSource, SourceExt, SourceValue},
};
use rspack_error::{Diagnostic, Result};
use rspack_hook::{plugin, plugin_hook};
use rspack_plugin_javascript::dependency::{ESMImportSpecifierDependency, ImportDependency};
use rspack_util::atom::Atom;
use rustc_hash::{FxHashMap, FxHashSet};

use super::{
  consume_shared_module::ConsumeSharedModule, provide_shared_module::ProvideSharedModule,
  shared_used_exports_optimizer_runtime_module::SharedUsedExportsOptimizerRuntimeModule,
};
use crate::{container::container_entry_module::ContainerEntryModule, manifest::StatsRoot};
#[derive(Debug, Clone)]
pub struct OptimizeSharedConfig {
  pub share_key: String,
  pub tree_shaking: bool,
  pub used_exports: Vec<String>,
}

#[derive(Debug, Clone)]
pub struct SharedUsedExportsOptimizerPluginOptions {
  pub shared: Vec<OptimizeSharedConfig>,
  pub inject_tree_shaking_used_exports: bool,
  pub stats_file_name: Option<String>,
  pub manifest_file_name: Option<String>,
}

#[derive(Debug, Clone)]
struct SharedEntryData {
  used_exports: Vec<Atom>,
}

#[plugin]
#[derive(Debug, Clone)]
pub struct SharedUsedExportsOptimizerPlugin {
  shared_map: FxHashMap<String, SharedEntryData>,
  shared_referenced_exports: Arc<RwLock<FxHashMap<String, FxHashSet<String>>>>,
  inject_tree_shaking_used_exports: bool,
  stats_file_name: Option<String>,
  manifest_file_name: Option<String>,
}

impl SharedUsedExportsOptimizerPlugin {
  pub fn new(options: SharedUsedExportsOptimizerPluginOptions) -> Self {
    let mut shared_map = FxHashMap::default();
    let inject_tree_shaking_used_exports = options.inject_tree_shaking_used_exports;
    for config in options.shared.into_iter().filter(|c| c.tree_shaking) {
      let atoms = config
        .used_exports
        .into_iter()
        .map(Atom::from)
        .collect::<Vec<_>>();
      shared_map.insert(
        config.share_key,
        SharedEntryData {
          used_exports: atoms,
        },
      );
    }

    let shared_referenced_exports = Arc::new(RwLock::new(
      FxHashMap::<String, FxHashSet<String>>::default(),
    ));

    Self::new_inner(
      shared_map,
      shared_referenced_exports,
      inject_tree_shaking_used_exports,
      options.stats_file_name,
      options.manifest_file_name,
    )
  }

  fn apply_custom_exports(&self) {
    let mut shared_referenced_exports = self
      .shared_referenced_exports
      .write()
      .expect("lock poisoned");
    for (share_key, shared_entry_data) in &self.shared_map {
      let export_set = shared_referenced_exports
        .entry(share_key.clone())
        .or_default();
      for used_export in &shared_entry_data.used_exports {
        export_set.insert(used_export.to_string());
      }
    }
  }
}

fn collect_processed_modules(
  module_graph: &ModuleGraph,
  module_blocks: &[AsyncDependenciesBlockIdentifier],
  module_deps: &[DependencyId],
  out: &mut Vec<ModuleIdentifier>,
) {
  for dep_id in module_deps {
    if let Some(target_id) = module_graph.module_identifier_by_dependency_id(dep_id) {
      out.push(*target_id);
    }
  }

  for block_id in module_blocks {
    if let Some(block) = module_graph.block_by_id(block_id) {
      for dep_id in block.get_dependencies() {
        if let Some(target_id) = module_graph.module_identifier_by_dependency_id(dep_id) {
          out.push(*target_id);
        }
      }
    }
  }
}

#[plugin_hook(
  CompilationOptimizeDependencies for SharedUsedExportsOptimizerPlugin,
  stage = 1
)]
async fn optimize_dependencies(
  &self,
  _compilation: &Compilation,
  _side_effects_optimize_artifact: &mut SideEffectsOptimizeArtifact,
  build_module_graph_artifact: &mut BuildModuleGraphArtifact,
  exports_info_artifact: &mut ExportsInfoArtifact,
  _diagnostics: &mut Vec<Diagnostic>,
) -> Result<Option<bool>> {
  let module_ids: Vec<_> = {
    let module_graph = build_module_graph_artifact.get_module_graph();
    module_graph.modules_keys().copied().collect()
  };
  self.apply_custom_exports();
  for module_id in module_ids {
    let module_graph = build_module_graph_artifact.get_module_graph();
    let share_info = {
      let module = module_graph.module_by_identifier(&module_id);
      module.and_then(|module| {
        let module_type = module.module_type();
        if !matches!(
          module_type,
          rspack_core::ModuleType::ConsumeShared
            | rspack_core::ModuleType::ProvideShared
            | rspack_core::ModuleType::ShareContainerShared
        ) {
          return None;
        }
        let mut modules_to_process = Vec::new();
        let share_key = match module_type {
          rspack_core::ModuleType::ConsumeShared => {
            let consume_shared_module = module.as_any().downcast_ref::<ConsumeSharedModule>()?;
            // Use the readable_identifier to extract the share key
            // The share key is part of the identifier string in format "consume shared module ({share_scope}) {share_key}@..."
            let identifier =
              consume_shared_module.readable_identifier(&rspack_core::Context::default());
            let identifier_str = identifier.to_string();
            let parts: Vec<&str> = identifier_str.split(") ").collect();
            if parts.len() < 2 {
              return None;
            }
            let share_key_part = parts[1];
            let share_key_end = if let Some(stripped) = share_key_part.strip_prefix('@') {
              stripped.find('@').map_or(share_key_part.len(), |i| i + 1)
            } else {
              share_key_part.find('@').unwrap_or(share_key_part.len())
            };
            let sk: String = share_key_part[..share_key_end].to_string();
            collect_processed_modules(
              module_graph,
              consume_shared_module.get_blocks(),
              consume_shared_module.get_dependencies(),
              &mut modules_to_process,
            );
            sk
          }
          rspack_core::ModuleType::ProvideShared => {
            let provide_shared_module = module.as_any().downcast_ref::<ProvideSharedModule>()?;
            let sk = provide_shared_module.share_key().to_string();
            collect_processed_modules(
              module_graph,
              provide_shared_module.get_blocks(),
              provide_shared_module.get_dependencies(),
              &mut modules_to_process,
            );
            sk
          }
          rspack_core::ModuleType::ShareContainerShared => {
            let share_container_entry_module =
              module.as_any().downcast_ref::<ContainerEntryModule>()?;
            let sk = share_container_entry_module.name().to_string();
            collect_processed_modules(
              module_graph,
              share_container_entry_module.get_blocks(),
              share_container_entry_module.get_dependencies(),
              &mut modules_to_process,
            );
            sk
          }
          _ => return None,
        };
        Some((share_key, modules_to_process))
      })
    };

    let (share_key, modules_to_process) = match share_info {
      Some(result) => result,
      None => continue,
    };

    if share_key.is_empty() {
      continue;
    }

    // Get the runtime referenced exports for this share key
    let runtime_reference_exports = {
      self
        .shared_referenced_exports
        .read()
        .expect("lock poisoned")
        .get(&share_key)
        .cloned()
    };
    // Check if this share key is in our shared map and has tree_shaking enabled
    if !self.shared_map.contains_key(&share_key) {
      continue;
    }
    if let Some(runtime_reference_exports) = runtime_reference_exports {
      if runtime_reference_exports.is_empty() {
        continue;
      }

      let real_shared_identifier = modules_to_process.first().copied();

      // Check if the real shared module is side effect free
      if let Some(real_shared_identifier) = real_shared_identifier {
        let is_side_effect_free = {
          module_graph
            .module_by_identifier(&real_shared_identifier)
            .and_then(|module| module_declared_side_effect_free(module.as_ref()))
            .unwrap_or(false)
        };

        if !is_side_effect_free {
          // Clear referenced exports for this share_key when module is not side-effect free
          if let Ok(mut shared_referenced_exports) = self.shared_referenced_exports.write()
            && let Some(set) = shared_referenced_exports.get_mut(&share_key)
          {
            set.clear();
          }
          continue;
        }

        exports_info_artifact.reset_all_exports_info_used();
        // mark used for collected modules
        for module_id in &modules_to_process {
          let exports_info_data = exports_info_artifact.get_exports_info_data_mut(module_id);

          for export_name in runtime_reference_exports.iter() {
            let export_atom = Atom::from(export_name.as_str());
            if let Some(export_info) = exports_info_data.named_exports_mut(&export_atom) {
              // export_info.set_used(rspack_core::UsageState::Used, Some(&runtime_spec));
              export_info.set_used(rspack_core::UsageState::Used, None);
            }
          }
        }

        // find if can update real share module
        let exports_info_data =
          exports_info_artifact.get_exports_info_data_mut(&real_shared_identifier);
        let can_update_module_used_stage = {
          let exports_view = exports_info_data.exports();
          if exports_view.is_empty() {
            false
          } else {
            // Check if all used exports are in the runtime_reference_exports set
            exports_view.iter().all(|(name, export_info)| {
              let used = export_info.get_used(None);
              if used != rspack_core::UsageState::Unknown && used != rspack_core::UsageState::Unused
              {
                runtime_reference_exports.contains(&name.to_string())
              } else {
                true
              }
            })
          }
        };
        if can_update_module_used_stage {
          // mark used exports per runtime
          // Mark used exports
          for export_info in exports_info_data.exports_mut().values_mut() {
            export_info.set_used_conditionally(
              Box::new(|used| *used == rspack_core::UsageState::Unknown),
              rspack_core::UsageState::Unused,
              None,
            );
            export_info.set_can_mangle_provide(Some(false));
            export_info.set_can_mangle_use(Some(false));
          }
        }
      }
    }
  }

  Ok(None)
}

#[plugin_hook(CompilationProcessAssets for SharedUsedExportsOptimizerPlugin, stage = 1)]
async fn process_assets(&self, compilation: &mut Compilation) -> Result<()> {
  let file_names = vec![
    self.stats_file_name.clone(),
    self.manifest_file_name.clone(),
  ];
  for file_name in file_names {
    if let Some(file_name) = &file_name
      && let Some(file) = compilation.assets().get(file_name)
      && let Some(source) = file.get_source()
      && let SourceValue::String(content) = source.source()
      && let Ok(mut stats_root) = serde_json::from_str::<StatsRoot>(&content)
    {
      let shared_referenced_exports = self
        .shared_referenced_exports
        .read()
        .expect("lock poisoned");

      for shared in &mut stats_root.shared {
        if let Some(exports_set) = shared_referenced_exports.get(&shared.name) {
          shared.usedExports = exports_set.iter().cloned().collect::<Vec<_>>();
        }
      }

      let updated_content = serde_json::to_string_pretty(&stats_root)
        .map_err(|e| rspack_error::error!("Failed to serialize stats root: {}", e))?;

      compilation.update_asset(file_name, |_, info| {
        Ok((RawStringSource::from(updated_content).boxed(), info))
      })?;
    }
  }

  Ok(())
}

#[plugin_hook(
  CompilationAdditionalTreeRuntimeRequirements for SharedUsedExportsOptimizerPlugin
)]
async fn additional_tree_runtime_requirements(
  &self,
  compilation: &Compilation,
  _chunk_ukey: &ChunkUkey,
  runtime_requirements: &mut RuntimeGlobals,
  runtime_modules: &mut Vec<Box<dyn RuntimeModule>>,
) -> Result<()> {
  if self.shared_map.is_empty() {
    return Ok(());
  }

  runtime_requirements.insert(RuntimeGlobals::RUNTIME_ID);
  runtime_modules.push(
    SharedUsedExportsOptimizerRuntimeModule::new(
      &compilation.runtime_template,
      Arc::new(
        self
          .shared_referenced_exports
          .read()
          .expect("lock poisoned")
          .clone(),
      ),
    )
    .boxed(),
  );

  Ok(())
}

#[plugin_hook(CompilationDependencyReferencedExports for SharedUsedExportsOptimizerPlugin,tracing=false)]
fn dependency_referenced_exports(
  &self,
  compilation: &Compilation,
  dependency_id: &DependencyId,
  referenced_exports: &Option<Vec<ExtendedReferencedExport>>,
  _runtime: Option<&RuntimeSpec>,
  module_graph: Option<&ModuleGraph>,
) -> Result<()> {
  let module_graph = module_graph.unwrap_or_else(|| compilation.get_module_graph());
  if referenced_exports.is_none() {
    return Ok(());
  }
  let Some(exports) = referenced_exports else {
    return Ok(());
  };

  let dependency = module_graph.dependency_by_id(dependency_id);

  let Some(module_dependency) = dependency.as_module_dependency() else {
    return Ok(());
  };

  let share_key: &str = module_dependency.request();

  // Check if dependency type is EsmImportSpecifier and share_key is in shared_map
  if !self.shared_map.contains_key(share_key) {
    return Ok(());
  }
  let mut final_exports = exports.clone();

  // If it's an import dependency and referenced exports indicate "exports object referenced",
  // clear any recorded shared referenced exports for this share key and stop here.
  let is_exports_object = matches!(
    final_exports.as_slice(),
    [ExtendedReferencedExport::Array(arr)] if arr.is_empty()
  );
  if dependency
    .as_any()
    .downcast_ref::<ImportDependency>()
    .is_some()
    && is_exports_object
  {
    let mut shared_referenced_exports = self
      .shared_referenced_exports
      .write()
      .expect("lock poisoned");
    shared_referenced_exports.remove(share_key);
    return Ok(());
  }
  if (final_exports.is_empty() || is_exports_object)
    && dependency.dependency_type() == &DependencyType::EsmImportSpecifier
    && let Some(esm_dep) = dependency
      .as_any()
      .downcast_ref::<ESMImportSpecifierDependency>()
  {
    let ids: &[Atom] = esm_dep.get_ids(module_graph);
    if ids.is_empty() {
      return Ok(());
    }
    if let Some(first) = ids.first()
      && *first == "default"
    {
      final_exports = esm_dep.get_referenced_exports_in_destructuring(Some(ids));
    } else {
      final_exports = esm_dep.get_referenced_exports(
        module_graph,
        &compilation.module_graph_cache_artifact,
        &compilation.exports_info_artifact,
        _runtime,
      );
    }
  }

  // Process each referenced export
  if self.shared_map.contains_key(share_key) {
    let mut shared_referenced_exports = self
      .shared_referenced_exports
      .write()
      .expect("lock poisoned");
    let export_set = shared_referenced_exports
      .entry(share_key.to_string())
      .or_default();

    for referenced_export in &final_exports {
      match referenced_export {
        ExtendedReferencedExport::Array(exports_array) => {
          for export in exports_array {
            export_set.insert(export.to_string());
          }
        }
        ExtendedReferencedExport::Export(referenced) => {
          if referenced.name.is_empty() {
            continue;
          }
          for atom in &referenced.name {
            export_set.insert(atom.to_string());
          }
        }
      }
    }
  }
  Ok(())
}

impl Plugin for SharedUsedExportsOptimizerPlugin {
  fn name(&self) -> &'static str {
    "rspack.sharing.SharedUsedExportsOptimizerPlugin"
  }

  fn apply(&self, ctx: &mut rspack_core::ApplyContext<'_>) -> Result<()> {
    if self.shared_map.is_empty() {
      return Ok(());
    }
    ctx
      .compilation_hooks
      .dependency_referenced_exports
      .tap(dependency_referenced_exports::new(self));
    ctx
      .compilation_hooks
      .optimize_dependencies
      .tap(optimize_dependencies::new(self));
    ctx
      .compilation_hooks
      .process_assets
      .tap(process_assets::new(self));
    if self.inject_tree_shaking_used_exports {
      ctx
        .compilation_hooks
        .additional_tree_runtime_requirements
        .tap(additional_tree_runtime_requirements::new(self));
    }
    Ok(())
  }
}