refactor: remove option in module_graph_module_by_identifier_mut (#12610)

Author: hardfist

crates/rspack_core/src/cache/persistent/occasion/make/module_graph.rs

@@ -181,9 +181,7 @@ pub async fn recovery_module_graph(
     });
   // recovery incoming connections
   for (dep_id, module_identifier) in need_check_dep {
-    let mgm = mg
-      .module_graph_module_by_identifier_mut(&module_identifier)
-      .expect("should mgm exist");
+    let mgm = mg.module_graph_module_by_identifier_mut(&module_identifier);
     mgm.add_incoming_connection(dep_id);
   }
 

crates/rspack_core/src/compilation/build_chunk_graph/artifact.rs

@@ -200,10 +200,7 @@ where
       let module_idx = cache.module_idx.clone();
       let module_graph = compilation.get_module_graph_mut();
       for (m, (pre, post)) in module_idx {
-        let Some(mgm) = module_graph.module_graph_module_by_identifier_mut(&m) else {
-          continue;
-        };
-
+        let mgm = module_graph.module_graph_module_by_identifier_mut(&m);
         mgm.pre_order_index = Some(pre);
         mgm.post_order_index = Some(post);
       }

crates/rspack_core/src/compilation/build_chunk_graph/code_splitter.rs

@@ -1162,9 +1162,7 @@ Or do you want to use the entrypoints '{name}' and '{runtime}' independently on
 
     {
       let module_graph = compilation.get_module_graph_mut();
-      let module = module_graph
-        .module_graph_module_by_identifier_mut(&item.module)
-        .unwrap_or_else(|| panic!("No module found {:?}", &item.module));
+      let module = module_graph.module_graph_module_by_identifier_mut(&item.module);
 
       if module.pre_order_index.is_none() {
         module.pre_order_index = Some(self.next_free_module_pre_order_index);
@@ -1207,9 +1205,7 @@ Or do you want to use the entrypoints '{name}' and '{runtime}' independently on
     }
 
     let module_graph = compilation.get_module_graph_mut();
-    let module = module_graph
-      .module_graph_module_by_identifier_mut(&item.module)
-      .unwrap_or_else(|| panic!("no module found: {:?}", &item.module));
+    let module = module_graph.module_graph_module_by_identifier_mut(&item.module);
 
     if module.post_order_index.is_none() {
       module.post_order_index = Some(self.next_free_module_post_order_index);

crates/rspack_core/src/compilation/build_module_graph/graph_updater/cutout/fix_issuers.rs

@@ -4,7 +4,10 @@ use rspack_collections::{IdentifierMap, IdentifierSet};
 use rustc_hash::FxHashSet as HashSet;
 
 use super::BuildModuleGraphArtifact;
-use crate::{DependencyId, ModuleGraph, ModuleIdentifier, ModuleIssuer};
+use crate::{
+  DependencyId, ModuleGraph, ModuleIdentifier, ModuleIssuer,
+  module_graph::internal::try_get_module_graph_module_mut_by_identifier,
+};
 
 /// Result of IssuerHelper.is_issuer.
 enum IsIssuerResult {
@@ -215,7 +218,7 @@ impl FixIssuers {
     need_check_modules
       .into_iter()
       .filter_map(|mid| {
-        let Some(mgm) = module_graph.module_graph_module_by_identifier_mut(&mid) else {
+        let Some(mgm) = try_get_module_graph_module_mut_by_identifier(module_graph, &mid) else {
           // no mgm means the module has been removed, ignored.
           return None;
         };
@@ -308,9 +311,7 @@ impl FixIssuers {
         revoke_module.insert(mid);
         continue;
       };
-      let mgm = module_graph
-        .module_graph_module_by_identifier_mut(&mid)
-        .expect("should mgm exist");
+      let mgm = module_graph.module_graph_module_by_identifier_mut(&mid);
       artifact.issuer_update_modules.insert(mgm.module_identifier);
       mgm.set_issuer(match first_parent {
         Some(id) => ModuleIssuer::Some(*id),
@@ -359,9 +360,7 @@ impl FixIssuers {
     for (mid, parents) in need_check_available_modules {
       match helper.calc_issuer(module_graph, &mid, parents) {
         CalcIssuerResult::Ok(issuer) => {
-          let mgm = module_graph
-            .module_graph_module_by_identifier_mut(&mid)
-            .expect("should have mgm");
+          let mgm = module_graph.module_graph_module_by_identifier_mut(&mid);
           artifact.issuer_update_modules.insert(mgm.module_identifier);
           mgm.set_issuer(issuer);
           // check cycled modules.
@@ -375,9 +374,7 @@ impl FixIssuers {
             need_clean_cycle_modules.retain(|id, paths| {
               for (issuer, cycle_paths) in paths {
                 if cycle_paths.contains(&current_id) {
-                  let mgm = module_graph
-                    .module_graph_module_by_identifier_mut(id)
-                    .expect("should have mgm");
+                  let mgm = module_graph.module_graph_module_by_identifier_mut(id);
                   artifact.issuer_update_modules.insert(mgm.module_identifier);
                   mgm.set_issuer(ModuleIssuer::Some(*issuer));
                   // this module issuer has been update, add module to queue to recheck need_clean_cycle_modules
@@ -440,9 +437,7 @@ impl FixIssuers {
 
           match helper.calc_issuer(module_graph, &mid, parents) {
             CalcIssuerResult::Ok(issuer) => {
-              let mgm = module_graph
-                .module_graph_module_by_identifier_mut(&mid)
-                .expect("should have mgm");
+              let mgm = module_graph.module_graph_module_by_identifier_mut(&mid);
               artifact.issuer_update_modules.insert(mgm.module_identifier);
               mgm.set_issuer(issuer);
               // fix child issuer
@@ -461,9 +456,7 @@ impl FixIssuers {
                   .collect();
                 for child_mid in child_modules {
                   if useless_module.remove(&child_mid) {
-                    let mgm = module_graph
-                      .module_graph_module_by_identifier_mut(&child_mid)
-                      .expect("should have mgm");
+                    let mgm = module_graph.module_graph_module_by_identifier_mut(&child_mid);
                     artifact.issuer_update_modules.insert(mgm.module_identifier);
                     mgm.set_issuer(ModuleIssuer::Some(mid));
                     fixing_queue.push_back(child_mid);

crates/rspack_core/src/compilation/build_module_graph/graph_updater/repair/build.rs

@@ -197,9 +197,7 @@ impl Task<TaskContext> for BuildResultTask {
     }
 
     {
-      let mgm = module_graph
-        .module_graph_module_by_identifier_mut(&module.identifier())
-        .expect("Failed to get mgm");
+      let mgm = module_graph.module_graph_module_by_identifier_mut(&module.identifier());
       mgm.all_dependencies = all_dependencies.clone();
       if let Some(current_profile) = current_profile {
         mgm.set_profile(current_profile);

crates/rspack_core/src/module_graph/internal.rs

@@ -0,0 +1,33 @@
+/// Internal helpers for ModuleGraph that should only be used by specific modules.
+///
+/// **DO NOT USE THESE FUNCTIONS** unless you're in `compilation::build_module_graph`.
+///
+/// This module provides restricted access to potentially unsafe ModuleGraph operations
+/// that should only be used in specific contexts where modules may legitimately not exist.
+use crate::{ModuleGraph, ModuleGraphModule, ModuleIdentifier};
+
+/// Try to get a mutable module graph module by identifier, returning None if not found.
+///
+/// # Restricted Use - DO NOT USE
+///
+/// **WARNING**: This function should ONLY be used in `compilation::build_module_graph`
+/// for handling module removal during graph updates where modules may have been removed
+/// during incremental compilation.
+///
+/// **All other code must use `ModuleGraph::module_graph_module_by_identifier_mut()`**
+/// which enforces the invariant that the module exists with a clear panic message.
+///
+/// # When to Use (only in build_module_graph)
+///
+/// Only use when you have a legitimate reason to expect the module might not exist:
+/// - During incremental compilation where modules may have been removed
+/// - During graph cleanup operations where referenced modules may already be deleted
+///
+/// If you're unsure, use `module_graph_module_by_identifier_mut()` instead.
+#[inline]
+pub(crate) fn try_get_module_graph_module_mut_by_identifier<'a>(
+  module_graph: &'a mut ModuleGraph,
+  identifier: &ModuleIdentifier,
+) -> Option<&'a mut ModuleGraphModule> {
+  module_graph.inner.module_graph_modules.get_mut(identifier)
+}