refactor: make compilation readonly for runtimeModule hook (#12670)

Author: hardfist

crates/rspack_binding_api/src/plugins/interceptor.rs

@@ -10,7 +10,7 @@ use napi::{
   Env, JsValue,
   bindgen_prelude::{Buffer, FromNapiValue, Function, JsValuesTupleIntoVec, Promise, ToNapiValue},
 };
-use rspack_collections::IdentifierSet;
+use rspack_collections::{IdentifierMap, IdentifierSet};
 use rspack_core::{
   AfterResolveResult, AssetEmittedInfo, AsyncModulesArtifact, BeforeResolveResult, BindingCell,
   BoxModule, ChunkUkey, Compilation, CompilationAdditionalTreeRuntimeRequirements,
@@ -41,7 +41,7 @@ use rspack_core::{
   NormalModuleFactoryFactorizeHook, NormalModuleFactoryResolve,
   NormalModuleFactoryResolveForScheme, NormalModuleFactoryResolveForSchemeHook,
   NormalModuleFactoryResolveHook, NormalModuleFactoryResolveResult, ResourceData, RuntimeGlobals,
-  Scheme, build_module_graph::BuildModuleGraphArtifact, parse_resource,
+  RuntimeModule, Scheme, build_module_graph::BuildModuleGraphArtifact, parse_resource,
   rspack_sources::RawStringSource,
 };
 use rspack_error::Diagnostic;
@@ -1340,11 +1340,12 @@ impl CompilationRuntimeRequirementInTree for CompilationRuntimeRequirementInTree
 impl CompilationRuntimeModule for CompilationRuntimeModuleTap {
   async fn run(
     &self,
-    compilation: &mut Compilation,
+    compilation: &Compilation,
     m: &ModuleIdentifier,
     chunk_ukey: &ChunkUkey,
+    runtime_modules: &mut IdentifierMap<Box<dyn RuntimeModule>>,
   ) -> rspack_error::Result<()> {
-    let Some(module) = compilation.runtime_modules.get(m) else {
+    let Some(module) = runtime_modules.get(m) else {
       return Ok(());
     };
     let source_string = module.generate(compilation).await?;
@@ -1364,10 +1365,7 @@ impl CompilationRuntimeModule for CompilationRuntimeModuleTap {
     if let Some(module) = self.function.call_with_sync(arg).await?
       && let Some(source) = module.source
     {
-      let module = compilation
-        .runtime_modules
-        .get_mut(m)
-        .expect("should have module");
+      let module = runtime_modules.get_mut(m).expect("should have module");
       match source.source {
         napi::Either::A(string) => {
           module.set_custom_source(string);

crates/rspack_core/src/compilation/mod.rs

@@ -86,7 +86,7 @@ define_hook!(CompilationOptimizeTree: Series(compilation: &Compilation));
 define_hook!(CompilationOptimizeChunkModules: SeriesBail(compilation: &mut Compilation) -> bool);
 define_hook!(CompilationModuleIds: Series(compilation: &Compilation, module_ids: &mut ModuleIdsArtifact, diagnostics: &mut Vec<Diagnostic>));
 define_hook!(CompilationChunkIds: Series(compilation: &Compilation, chunk_by_ukey: &mut ChunkByUkey, named_chunk_ids_artifact: &mut ChunkNamedIdArtifact, diagnostics: &mut Vec<Diagnostic>));
-define_hook!(CompilationRuntimeModule: Series(compilation: &mut Compilation, module: &ModuleIdentifier, chunk: &ChunkUkey));
+define_hook!(CompilationRuntimeModule: Series(compilation: &Compilation, module: &ModuleIdentifier, chunk: &ChunkUkey, runtime_modules: &mut IdentifierMap<Box<dyn RuntimeModule>>));
 define_hook!(CompilationAdditionalModuleRuntimeRequirements: Series(compilation: &Compilation, module_identifier: &ModuleIdentifier, runtime_requirements: &mut RuntimeGlobals),tracing=false);
 define_hook!(CompilationRuntimeRequirementInModule: SeriesBail(compilation: &Compilation, module_identifier: &ModuleIdentifier, all_runtime_requirements: &RuntimeGlobals, runtime_requirements: &RuntimeGlobals, runtime_requirements_mut: &mut RuntimeGlobals),tracing=false);
 define_hook!(CompilationAdditionalChunkRuntimeRequirements: Series(compilation: &mut Compilation, chunk_ukey: &ChunkUkey, runtime_requirements: &mut RuntimeGlobals));
@@ -2286,6 +2286,7 @@ impl Compilation {
     // NOTE: webpack runs hooks.runtime_module in compilation.add_runtime_module
     // and overwrite the runtime_module.generate() to get new source in create_chunk_assets
     // this needs full runtime requirements, so run hooks.runtime_module after runtime_requirements_in_tree
+    let mut runtime_modules = mem::take(&mut self.runtime_modules);
     for entry_ukey in &entries {
       let runtime_module_ids: Vec<_> = self
         .chunk_graph
@@ -2296,11 +2297,12 @@ impl Compilation {
         plugin_driver
           .compilation_hooks
           .runtime_module
-          .call(self, &runtime_module_id, entry_ukey)
+          .call(self, &runtime_module_id, entry_ukey, &mut runtime_modules)
           .await
           .map_err(|e| e.wrap_err("caused by plugins in Compilation.hooks.runtimeModule"))?;
       }
     }
+    self.runtime_modules = runtime_modules;
 
     logger.time_end(start);
     Ok(())

crates/rspack_plugin_devtool/src/source_map_dev_tool_module_options_plugin.rs

@@ -1,6 +1,7 @@
+use rspack_collections::IdentifierMap;
 use rspack_core::{
   BoxModule, ChunkUkey, Compilation, CompilationBuildModule, CompilationId,
-  CompilationRuntimeModule, CompilerId, ModuleIdentifier, Plugin,
+  CompilationRuntimeModule, CompilerId, ModuleIdentifier, Plugin, RuntimeModule,
 };
 use rspack_error::Result;
 use rspack_hook::{plugin, plugin_hook};
@@ -46,21 +47,22 @@ async fn build_module(
 #[plugin_hook(CompilationRuntimeModule for SourceMapDevToolModuleOptionsPlugin)]
 async fn runtime_module(
   &self,
-  compilation: &mut Compilation,
-  module: &ModuleIdentifier,
+  _compilation: &Compilation,
+  module_identifier: &ModuleIdentifier,
   _chunk: &ChunkUkey,
+  runtime_modules: &mut IdentifierMap<Box<dyn RuntimeModule>>,
 ) -> Result<()> {
-  let Some(module) = compilation.runtime_modules.get_mut(module) else {
+  let Some(runtime_module) = runtime_modules.get_mut(module_identifier) else {
     return Ok(());
   };
   if self.module {
-    module.set_source_map_kind(SourceMapKind::SourceMap);
+    runtime_module.set_source_map_kind(SourceMapKind::SourceMap);
   } else {
-    module.set_source_map_kind(SourceMapKind::SimpleSourceMap);
+    runtime_module.set_source_map_kind(SourceMapKind::SimpleSourceMap);
   }
   if self.cheap {
-    let current_kind = *module.get_source_map_kind();
-    module.set_source_map_kind(current_kind | SourceMapKind::Cheap)
+    let current_kind = *runtime_module.get_source_map_kind();
+    runtime_module.set_source_map_kind(current_kind | SourceMapKind::Cheap)
   }
   Ok(())
 }