refactor: split module_graph into ModuleGraphRef and ModuleGraphMut (#12199)

hardfist · web-flow · commit 711cb55e07de · 2025-11-14T16:07:20.000+08:00
* refactor: split module_graph into ModuleGraphRef and ModuleGraphMut

* chore: fix check error
diff --git a/crates/rspack_binding_api/src/exports_info.rs b/crates/rspack_binding_api/src/exports_info.rs
@@ -3,7 +3,8 @@ use std::ptr::NonNull;
 use napi::Either;
 use napi_derive::napi;
 use rspack_core::{
-  Compilation, ExportsInfo, ExportsInfoGetter, ModuleGraph, PrefetchExportsInfoMode, RuntimeSpec,
+  Compilation, ExportsInfo, ExportsInfoGetter, ModuleGraphMut, ModuleGraphRef,
+  PrefetchExportsInfoMode, RuntimeSpec,
 };
 use rspack_util::atom::Atom;
 
@@ -24,13 +25,13 @@ impl JsExportsInfo {
     }
   }
 
-  fn as_ref(&self) -> napi::Result<ModuleGraph<'static>> {
+  fn as_ref(&self) -> napi::Result<ModuleGraphRef<'static>> {
     let compilation = unsafe { self.compilation.as_ref() };
     let module_graph = compilation.get_module_graph();
     Ok(module_graph)
   }
 
-  fn as_mut(&mut self) -> napi::Result<ModuleGraph<'static>> {
+  fn as_mut(&mut self) -> napi::Result<ModuleGraphMut<'static>> {
     let compilation = unsafe { self.compilation.as_mut() };
     let module_graph = compilation.get_module_graph_mut();
     Ok(module_graph)
diff --git a/crates/rspack_binding_api/src/module_graph.rs b/crates/rspack_binding_api/src/module_graph.rs
@@ -2,7 +2,7 @@ use std::ptr::NonNull;
 
 use napi::{Either, Env, JsString, bindgen_prelude::Array};
 use napi_derive::napi;
-use rspack_core::{Compilation, ModuleGraph, PrefetchExportsInfoMode, RuntimeSpec};
+use rspack_core::{Compilation, ModuleGraph, ModuleGraphRef, PrefetchExportsInfoMode, RuntimeSpec};
 
 use crate::{
   dependencies::DependencyObject,
@@ -26,7 +26,7 @@ impl JsModuleGraph {
     }
   }
 
-  fn as_ref(&self) -> napi::Result<(&'static Compilation, ModuleGraph<'static>)> {
+  fn as_ref(&self) -> napi::Result<(&'static Compilation, ModuleGraphRef<'static>)> {
     let compilation = unsafe { self.compilation.as_ref() };
     let module_graph = compilation.get_module_graph();
 
diff --git a/crates/rspack_binding_api/src/module_graph_connection.rs b/crates/rspack_binding_api/src/module_graph_connection.rs
@@ -3,7 +3,7 @@ use std::{cell::RefCell, ptr::NonNull};
 use napi::bindgen_prelude::ToNapiValue;
 use napi_derive::napi;
 use rspack_collections::UkeyMap;
-use rspack_core::{Compilation, CompilationId, DependencyId, ModuleGraph};
+use rspack_core::{Compilation, CompilationId, DependencyId, ModuleGraphRef};
 use rspack_napi::OneShotRef;
 
 use crate::{dependency::DependencyWrapper, module::ModuleObject};
@@ -15,7 +15,7 @@ pub struct ModuleGraphConnection {
 }
 
 impl ModuleGraphConnection {
-  fn as_ref(&self) -> napi::Result<(&'static Compilation, ModuleGraph<'static>)> {
+  fn as_ref(&self) -> napi::Result<(&'static Compilation, ModuleGraphRef<'static>)> {
     let compilation = unsafe { self.compilation.as_ref() };
     let module_graph = compilation.get_module_graph();
 
diff --git a/crates/rspack_core/src/cache/persistent/occasion/make/mod.rs b/crates/rspack_core/src/cache/persistent/occasion/make/mod.rs
@@ -51,7 +51,7 @@ impl MakeOccasion {
     need_update_modules.extend(affected_modules.active());
 
     // The updated dependencies should be synced to persistent cache.
-    let mg = ModuleGraph::new([Some(module_graph_partial), None], None);
+    let mg = ModuleGraph::new_ref([Some(module_graph_partial), None]);
     for dep_id in affected_dependencies.updated() {
       if let Some(m) = mg.get_parent_module(dep_id) {
         need_update_modules.insert(*m);
@@ -74,7 +74,7 @@ impl MakeOccasion {
       module_graph::recovery_module_graph(&self.storage, &self.context).await?;
 
     // regenerate statistical data
-    let mg = ModuleGraph::new([Some(&partial), None], None);
+    let mg = ModuleGraph::new_ref([Some(&partial), None]);
     // recovery make_failed_module
     let mut make_failed_module = IdentifierSet::default();
     // recovery *_dep
diff --git a/crates/rspack_core/src/cache/persistent/occasion/make/module_graph.rs b/crates/rspack_core/src/cache/persistent/occasion/make/module_graph.rs
@@ -43,7 +43,7 @@ pub fn save_module_graph(
   storage: &Arc<dyn Storage>,
   context: &CacheableContext,
 ) {
-  let mg = ModuleGraph::new([Some(partial), None], None);
+  let mg = ModuleGraph::new_ref([Some(partial), None]);
   for identifier in removed_modules {
     storage.remove(SCOPE, identifier.as_bytes());
   }
@@ -135,7 +135,7 @@ pub async fn recovery_module_graph(
   let mut need_check_dep = vec![];
   let mut partial = ModuleGraphPartial::default();
   let mut module_to_lazy_make = ModuleToLazyMake::default();
-  let mut mg = ModuleGraph::new([None, None], Some(&mut partial));
+  let mut mg = ModuleGraph::new_mut([None, None], &mut partial);
   storage
     .load(SCOPE)
     .await?
diff --git a/crates/rspack_core/src/compilation/build_module_graph/artifact.rs b/crates/rspack_core/src/compilation/build_module_graph/artifact.rs
@@ -5,7 +5,8 @@ use rspack_error::Diagnostic;
 use rustc_hash::FxHashSet as HashSet;
 
 use crate::{
-  BuildDependency, DependencyId, FactorizeInfo, ModuleGraph, ModuleGraphPartial, ModuleIdentifier,
+  BuildDependency, DependencyId, FactorizeInfo, ModuleGraph, ModuleGraphMut, ModuleGraphPartial,
+  ModuleGraphRef, ModuleIdentifier,
   compilation::build_module_graph::ModuleToLazyMake,
   incremental_info::IncrementalInfo,
   utils::{FileCounter, ResourceId},
@@ -68,11 +69,11 @@ pub struct BuildModuleGraphArtifact {
 }
 
 impl BuildModuleGraphArtifact {
-  pub fn get_module_graph(&self) -> ModuleGraph<'_> {
-    ModuleGraph::new([Some(&self.module_graph_partial), None], None)
+  pub fn get_module_graph(&self) -> ModuleGraphRef<'_> {
+    ModuleGraph::new_ref([Some(&self.module_graph_partial), None])
   }
-  pub fn get_module_graph_mut(&mut self) -> ModuleGraph<'_> {
-    ModuleGraph::new([None, None], Some(&mut self.module_graph_partial))
+  pub fn get_module_graph_mut(&mut self) -> ModuleGraphMut<'_> {
+    ModuleGraph::new_mut([None, None], &mut self.module_graph_partial)
   }
   // TODO remove it
   pub fn get_module_graph_partial(&self) -> &ModuleGraphPartial {
@@ -87,7 +88,7 @@ impl BuildModuleGraphArtifact {
   ///
   /// This function will update index on MakeArtifact.
   pub fn revoke_module(&mut self, module_identifier: &ModuleIdentifier) -> Vec<BuildDependency> {
-    let mut mg = ModuleGraph::new([None, None], Some(&mut self.module_graph_partial));
+    let mut mg = ModuleGraph::new_mut([None, None], &mut self.module_graph_partial);
     let module = mg
       .module_by_identifier(module_identifier)
       .expect("should have module");
@@ -150,7 +151,7 @@ impl BuildModuleGraphArtifact {
   pub fn revoke_dependency(&mut self, dep_id: &DependencyId, force: bool) -> Vec<BuildDependency> {
     self.make_failed_dependencies.remove(dep_id);
 
-    let mut mg = ModuleGraph::new([None, None], Some(&mut self.module_graph_partial));
+    let mut mg = ModuleGraph::new_mut([None, None], &mut self.module_graph_partial);
     let revoke_dep_ids = if let Some(factorize_info) = mg
       .dependency_by_id_mut(dep_id)
       .and_then(FactorizeInfo::revoke)
diff --git a/crates/rspack_core/src/compilation/build_module_graph/graph_updater/cutout/fix_issuers.rs b/crates/rspack_core/src/compilation/build_module_graph/graph_updater/cutout/fix_issuers.rs
@@ -211,7 +211,7 @@ impl FixIssuers {
       mut force_build_module_issuers,
       need_check_modules,
     } = self;
-    let mut module_graph = ModuleGraph::new([None, None], Some(&mut artifact.module_graph_partial));
+    let mut module_graph = ModuleGraph::new_mut([None, None], &mut artifact.module_graph_partial);
     need_check_modules
       .into_iter()
       .filter_map(|mid| {
@@ -261,7 +261,7 @@ impl FixIssuers {
       queue.push_back((mid, parents));
     }
 
-    let mut module_graph = ModuleGraph::new([None, None], Some(&mut artifact.module_graph_partial));
+    let mut module_graph = ModuleGraph::new_mut([None, None], &mut artifact.module_graph_partial);
     let mut revoke_module = IdentifierSet::default();
     let mut need_check_available_modules = IdentifierMap::default();
     loop {
@@ -353,7 +353,7 @@ impl FixIssuers {
     helper: &mut IssuerHelper,
     need_check_available_modules: IdentifierMap<Vec<Option<ModuleIdentifier>>>,
   ) -> IdentifierMap<IdentifierSet> {
-    let mut module_graph = ModuleGraph::new([None, None], Some(&mut artifact.module_graph_partial));
+    let mut module_graph = ModuleGraph::new_mut([None, None], &mut artifact.module_graph_partial);
     let mut need_clean_cycle_modules: IdentifierMap<IdentifierMap<IdentifierSet>> =
       IdentifierMap::default();
     for (mid, parents) in need_check_available_modules {
@@ -414,7 +414,7 @@ impl FixIssuers {
     clean_modules: IdentifierMap<IdentifierSet>,
   ) -> IdentifierMap<Vec<Option<ModuleIdentifier>>> {
     let mut revoke_module = IdentifierSet::default();
-    let mut module_graph = ModuleGraph::new([None, None], Some(&mut artifact.module_graph_partial));
+    let mut module_graph = ModuleGraph::new_mut([None, None], &mut artifact.module_graph_partial);
     for (mid, paths) in clean_modules {
       if revoke_module.contains(&mid) {
         continue;
diff --git a/crates/rspack_core/src/compilation/build_module_graph/graph_updater/repair/context.rs b/crates/rspack_core/src/compilation/build_module_graph/graph_updater/repair/context.rs
@@ -9,7 +9,7 @@ use crate::{
   Compilation, CompilationId, CompilerId, CompilerOptions, DependencyTemplate,
   DependencyTemplateType, DependencyType, ModuleFactory, ResolverFactory, SharedPluginDriver,
   incremental::Incremental,
-  module_graph::{ModuleGraph, ModuleGraphPartial},
+  module_graph::{ModuleGraph, ModuleGraphMut, ModuleGraphPartial},
   old_cache::Cache as OldCache,
 };
 
@@ -54,8 +54,8 @@ impl TaskContext {
   }
 
   // TODO use module graph with make artifact
-  pub fn get_module_graph_mut(partial: &mut ModuleGraphPartial) -> ModuleGraph<'_> {
-    ModuleGraph::new([None, None], Some(partial))
+  pub fn get_module_graph_mut(partial: &mut ModuleGraphPartial) -> ModuleGraphMut<'_> {
+    ModuleGraph::new_mut([None, None], partial)
   }
 
   // TODO remove it after incremental rebuild cover all stage
diff --git a/crates/rspack_core/src/compilation/mod.rs b/crates/rspack_core/src/compilation/mod.rs
@@ -48,10 +48,11 @@ use crate::{
   DependencyCodeGeneration, DependencyTemplate, DependencyTemplateType, DependencyType, Entry,
   EntryData, EntryOptions, EntryRuntime, Entrypoint, ExecuteModuleId, Filename, ImportPhase,
   ImportVarMap, ImportedByDeferModulesArtifact, Logger, MemoryGCStorage, ModuleFactory,
-  ModuleGraph, ModuleGraphCacheArtifact, ModuleGraphPartial, ModuleIdentifier, ModuleIdsArtifact,
-  ModuleStaticCacheArtifact, PathData, ResolverFactory, RuntimeGlobals, RuntimeKeyMap, RuntimeMode,
-  RuntimeModule, RuntimeSpec, RuntimeSpecMap, RuntimeTemplate, SharedPluginDriver,
-  SideEffectsOptimizeArtifact, SourceType, Stats, ValueCacheVersions,
+  ModuleGraph, ModuleGraphCacheArtifact, ModuleGraphMut, ModuleGraphPartial, ModuleGraphRef,
+  ModuleIdentifier, ModuleIdsArtifact, ModuleStaticCacheArtifact, PathData, ResolverFactory,
+  RuntimeGlobals, RuntimeKeyMap, RuntimeMode, RuntimeModule, RuntimeSpec, RuntimeSpecMap,
+  RuntimeTemplate, SharedPluginDriver, SideEffectsOptimizeArtifact, SourceType, Stats,
+  ValueCacheVersions,
   build_chunk_graph::artifact::BuildChunkGraphArtifact,
   compilation::build_module_graph::{
     BuildModuleGraphArtifact, ModuleExecutor, UpdateParam, build_module_graph,
@@ -452,23 +453,17 @@ impl Compilation {
     std::mem::swap(&mut self.build_module_graph_artifact, make_artifact);
   }
 
-  pub fn get_module_graph(&self) -> ModuleGraph<'_> {
+  pub fn get_module_graph(&self) -> ModuleGraphRef<'_> {
     if let Some(other_module_graph) = &self.other_module_graph {
-      ModuleGraph::new(
-        [
-          Some(self.build_module_graph_artifact.get_module_graph_partial()),
-          Some(other_module_graph),
-        ],
-        None,
-      )
+      ModuleGraph::new_ref([
+        Some(self.build_module_graph_artifact.get_module_graph_partial()),
+        Some(other_module_graph),
+      ])
     } else {
-      ModuleGraph::new(
-        [
-          Some(self.build_module_graph_artifact.get_module_graph_partial()),
-          None,
-        ],
+      ModuleGraph::new_ref([
+        Some(self.build_module_graph_artifact.get_module_graph_partial()),
         None,
-      )
+      ])
     }
   }
 
@@ -492,23 +487,21 @@ impl Compilation {
     None
   }
 
-  pub fn get_module_graph_mut(&mut self) -> ModuleGraph<'_> {
+  pub fn get_module_graph_mut(&mut self) -> ModuleGraphMut<'_> {
     if let Some(other) = &mut self.other_module_graph {
-      ModuleGraph::new(
+      ModuleGraph::new_mut(
         [
           Some(self.build_module_graph_artifact.get_module_graph_partial()),
           None,
         ],
-        Some(other),
+        other,
       )
     } else {
-      ModuleGraph::new(
+      ModuleGraph::new_mut(
         [None, None],
-        Some(
-          self
-            .build_module_graph_artifact
-            .get_module_graph_partial_mut(),
-        ),
+        self
+          .build_module_graph_artifact
+          .get_module_graph_partial_mut(),
       )
     }
   }
diff --git a/crates/rspack_core/src/module_graph/mod.rs b/crates/rspack_core/src/module_graph/mod.rs
@@ -1,4 +1,7 @@
-use std::collections::hash_map::Entry;
+use std::{
+  collections::hash_map::Entry,
+  ops::{Deref, DerefMut},
+};
 
 use rayon::prelude::*;
 use rspack_collections::{IdentifierMap, UkeyMap};
@@ -97,12 +100,48 @@ pub struct ModuleGraph<'a> {
   active: Option<&'a mut ModuleGraphPartial>,
 }
 
+#[derive(Debug)]
+pub struct ModuleGraphRef<'a>(ModuleGraph<'a>);
+
+#[derive(Debug)]
+pub struct ModuleGraphMut<'a>(ModuleGraph<'a>);
+
+impl<'a> Deref for ModuleGraphRef<'a> {
+  type Target = ModuleGraph<'a>;
+  fn deref(&self) -> &Self::Target {
+    &self.0
+  }
+}
+
+impl<'a> Deref for ModuleGraphMut<'a> {
+  type Target = ModuleGraph<'a>;
+  fn deref(&self) -> &Self::Target {
+    &self.0
+  }
+}
+
+impl<'a> DerefMut for ModuleGraphMut<'a> {
+  fn deref_mut(&mut self) -> &mut Self::Target {
+    &mut self.0
+  }
+}
+
 impl<'a> ModuleGraph<'a> {
-  pub fn new(
+  pub fn new_ref(partials: [Option<&'a ModuleGraphPartial>; 2]) -> ModuleGraphRef<'a> {
+    ModuleGraphRef(Self {
+      partials,
+      active: None,
+    })
+  }
+
+  pub fn new_mut(
     partials: [Option<&'a ModuleGraphPartial>; 2],
-    active: Option<&'a mut ModuleGraphPartial>,
-  ) -> Self {
-    Self { partials, active }
+    active: &'a mut ModuleGraphPartial,
+  ) -> ModuleGraphMut<'a> {
+    ModuleGraphMut(Self {
+      partials,
+      active: Some(active),
+    })
   }
 
   fn loop_partials<T>(&self, f: impl Fn(&ModuleGraphPartial) -> Option<&T>) -> Option<&T> {
diff --git a/crates/rspack_plugin_esm_library/src/link.rs b/crates/rspack_plugin_esm_library/src/link.rs
@@ -437,7 +437,7 @@ impl EsmLibraryPlugin {
   ) {
     let context = &compilation.options.context;
 
-    let module_graph: rspack_core::ModuleGraph<'_> = compilation.get_module_graph();
+    let module_graph = compilation.get_module_graph();
 
     let mut all_used_names: FxHashSet<Atom> = RESERVED_NAMES
       .iter()
@@ -1599,7 +1599,7 @@ impl EsmLibraryPlugin {
   ) -> Vec<Diagnostic> {
     let mut errors = vec![];
     let context = &compilation.options.context;
-    let module_graph: rspack_core::ModuleGraph<'_> = compilation.get_module_graph();
+    let module_graph = compilation.get_module_graph();
 
     // we don't modify exports and imports in chunk_link directly unless,
     // we re-borrow data from the chunk_link many times to avoid borrow
diff --git a/crates/rspack_plugin_library/src/modern_module_library_plugin.rs b/crates/rspack_plugin_library/src/modern_module_library_plugin.rs
@@ -71,7 +71,7 @@ impl ModernModuleLibraryPlugin {
   // Force trigger concatenation for single modules what bails from `ModuleConcatenationPlugin.is_empty`,
   // to keep all chunks can benefit from runtime optimization.
   async fn optimize_chunk_modules_impl(&self, compilation: &mut Compilation) -> Result<()> {
-    let module_graph: rspack_core::ModuleGraph = compilation.get_module_graph();
+    let module_graph = compilation.get_module_graph();
 
     let module_ids: Vec<_> = module_graph
       .module_graph_modules()

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ use std::ptr::NonNull;`
`2`	`2`
`3`	`3`	`use napi::{Either, Env, JsString, bindgen_prelude::Array};`
`4`	`4`	`use napi_derive::napi;`
`5`		`-use rspack_core::{Compilation, ModuleGraph, PrefetchExportsInfoMode, RuntimeSpec};`
	`5`	`+use rspack_core::{Compilation, ModuleGraph, ModuleGraphRef, PrefetchExportsInfoMode, RuntimeSpec};`
`6`	`6`
`7`	`7`	`use crate::{`
`8`	`8`	`dependencies::DependencyObject,`
`@@ -26,7 +26,7 @@ impl JsModuleGraph {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`		`- fn as_ref(&self) -> napi::Result<(&'static Compilation, ModuleGraph<'static>)> {`
	`29`	`+ fn as_ref(&self) -> napi::Result<(&'static Compilation, ModuleGraphRef<'static>)> {`
`30`	`30`	`let compilation = unsafe { self.compilation.as_ref() };`
`31`	`31`	`let module_graph = compilation.get_module_graph();`
`32`	`32`