refactor: centralize import.meta.env state in EnvPlugin

Author: intellild

crates/rspack/src/builder/builder_context.rs

@@ -210,6 +210,7 @@ impl BuilderContext {
       // Core module plugins
       BuiltinPluginOptions::JavascriptModulesPlugin => {
         plugins.push(rspack_plugin_javascript::JsPlugin::default().boxed());
+        plugins.push(rspack_plugin_javascript::EnvPlugin::default().boxed());
       }
       BuiltinPluginOptions::JsonModulesPlugin => {
         plugins.push(rspack_plugin_json::JsonPlugin.boxed());

crates/rspack_binding_api/src/raw_options/raw_builtins/mod.rs

@@ -76,7 +76,7 @@ use rspack_plugin_hmr::HotModuleReplacementPlugin;
 use rspack_plugin_html::HtmlRspackPlugin;
 use rspack_plugin_ignore::IgnorePlugin;
 use rspack_plugin_javascript::{
-  FlagDependencyExportsPlugin, FlagDependencyUsagePlugin, InferAsyncModulesPlugin,
+  EnvPlugin, FlagDependencyExportsPlugin, FlagDependencyUsagePlugin, InferAsyncModulesPlugin,
   InlineExportsPlugin, JsPlugin, MangleExportsPlugin, ModuleConcatenationPlugin,
   SideEffectsFlagPlugin, api_plugin::APIPlugin, define_plugin::DefinePlugin,
   provide_plugin::ProvidePlugin, url_plugin::URLPlugin,
@@ -643,7 +643,10 @@ impl<'a> BuiltinPlugin<'a> {
       BuiltinPluginName::InferAsyncModulesPlugin => {
         plugins.push(InferAsyncModulesPlugin::default().boxed())
       }
-      BuiltinPluginName::JavascriptModulesPlugin => plugins.push(JsPlugin::default().boxed()),
+      BuiltinPluginName::JavascriptModulesPlugin => {
+        plugins.push(JsPlugin::default().boxed());
+        plugins.push(EnvPlugin::default().boxed());
+      }
       BuiltinPluginName::AsyncWebAssemblyModulesPlugin => {
         plugins.push(AsyncWasmPlugin::default().boxed())
       }

crates/rspack_plugin_javascript/src/parser_plugin/define_plugin/mod.rs

@@ -6,22 +6,16 @@ use std::sync::Arc;
 
 use parser::DefineParserPlugin;
 use rspack_core::{
-  Compilation, CompilationId, CompilationParams, CompilerCompilation, ModuleType,
-  NormalModuleFactoryParser, ParserAndGenerator, ParserOptions, Plugin,
+  Compilation, CompilationParams, CompilerCompilation, ModuleType, NormalModuleFactoryParser,
+  ParserAndGenerator, ParserOptions, Plugin,
 };
 use rspack_error::{Diagnostic, Error, Result};
 use rspack_hook::{plugin, plugin_hook};
 use rspack_util::fx_hash::FxHashMap;
 use serde_json::Value;
 
 use self::walk_data::WalkData;
-use crate::{
-  parser_and_generator::JavaScriptParserAndGenerator,
-  parser_plugin::import_meta_env::{
-    finalize_import_meta_env_definitions as finalize_definitions,
-    merge_import_meta_env_definitions, remove_import_meta_env_definitions,
-  },
-};
+use crate::{parser_and_generator::JavaScriptParserAndGenerator, plugin::EnvPlugin};
 
 pub(crate) const VALUE_DEP_PREFIX: &str = "rspack/DefinePlugin ";
 
@@ -60,7 +54,7 @@ async fn collect_import_meta_env_definitions(
 ) -> Result<()> {
   compilation.extend_diagnostics(self.walk_data.diagnostics.clone());
   if compilation.options.experiments.env {
-    merge_import_meta_env_definitions(
+    EnvPlugin::collect(
       compilation.id(),
       &self.walk_data.import_meta_env_definitions,
     );
@@ -83,21 +77,6 @@ async fn collect_import_meta_env_definitions(
   Ok(())
 }
 
-#[plugin_hook(CompilerCompilation for DefinePlugin, stage = i32::MAX, tracing=false)]
-async fn finalize_import_meta_env_definitions(
-  &self,
-  compilation: &mut Compilation,
-  _params: &mut CompilationParams,
-) -> Result<()> {
-  if !compilation.options.experiments.env {
-    return Ok(());
-  }
-
-  finalize_definitions(compilation);
-
-  Ok(())
-}
-
 #[plugin_hook(NormalModuleFactoryParser for DefinePlugin, tracing=false)]
 async fn nmf_parser(
   &self,
@@ -118,19 +97,11 @@ impl Plugin for DefinePlugin {
     "rspack.DefinePlugin"
   }
 
-  fn clear_cache(&self, id: CompilationId) {
-    remove_import_meta_env_definitions(id);
-  }
-
   fn apply(&self, ctx: &mut rspack_core::ApplyContext<'_>) -> Result<()> {
     ctx
       .compiler_hooks
       .compilation
       .tap(collect_import_meta_env_definitions::new(self));
-    ctx
-      .compiler_hooks
-      .compilation
-      .tap(finalize_import_meta_env_definitions::new(self));
     ctx
       .normal_module_factory_hooks
       .parser

crates/rspack_plugin_javascript/src/parser_plugin/define_plugin/parser.rs

@@ -13,7 +13,7 @@ use super::{VALUE_DEP_PREFIX, utils::gen_const_dep, walk_data::WalkData};
 use crate::{
   JavascriptParserPlugin,
   define_plugin::walk_data::DefineRecord,
-  parser_plugin::import_meta_env::is_import_meta_env_name,
+  plugin::env_plugin::is_import_meta_env_name,
   utils::eval::{BasicEvaluatedExpression, evaluate_to_string},
   visitors::{AllowedMemberTypes, JavascriptParser, MemberExpressionInfo},
 };

crates/rspack_plugin_javascript/src/parser_plugin/define_plugin/walk_data.rs

@@ -15,7 +15,7 @@ use super::{
   utils::{code_to_string, gen_const_dep},
 };
 use crate::{
-  parser_plugin::import_meta_env::ImportMetaEnvDefinitions, utils::eval::BasicEvaluatedExpression,
+  plugin::env_plugin::ImportMetaEnvDefinitions, utils::eval::BasicEvaluatedExpression,
   visitors::JavascriptParser,
 };
 

crates/rspack_plugin_javascript/src/parser_plugin/import_meta_plugin.rs

@@ -23,11 +23,6 @@ use super::{
     import_meta_runtime_api_member, is_simple_assign_op,
     render_import_meta_runtime_api_destructuring,
   },
-  import_meta_env::{
-    add_import_meta_env_value_dependency, import_meta_env_definitions_string, import_meta_env_key,
-    is_import_meta_env_member, render_import_meta_env_definitions,
-    render_import_meta_env_expression_info, render_import_meta_env_member_chain,
-  },
   import_meta_path::{
     get_import_meta_eval_value, get_import_meta_member_replacement, should_handle_import_meta_path,
   },
@@ -37,6 +32,11 @@ use crate::{
     IMPORT_META_RSC_BINDING, ImportMetaResolveContextDependency, ImportMetaResolveDependency,
     ImportMetaResolveHeaderDependency, ImportMetaRscDependency,
   },
+  plugin::env_plugin::{
+    add_import_meta_env_value_dependency, import_meta_env_definitions_string, import_meta_env_key,
+    is_import_meta_env_member, render_import_meta_env_definitions,
+    render_import_meta_env_expression_info, render_import_meta_env_member_chain,
+  },
   utils::eval::{self, BasicEvaluatedExpression},
   visitors::{
     AllowedMemberTypes, ExportedVariableInfo, ExprRef, ExpressionExpressionInfo, JavascriptParser,

crates/rspack_plugin_javascript/src/parser_plugin/mod.rs

@@ -11,7 +11,6 @@ mod esm_export_dependency_parser_plugin;
 mod esm_import_dependency_parser_plugin;
 mod esm_top_level_this_plugin;
 mod import_meta_context_dependency_parser_plugin;
-pub(crate) mod import_meta_env;
 mod import_meta_path;
 mod import_meta_plugin;
 mod import_parser_plugin;

…ipt/src/parser_plugin/import_meta_env.rs …ugin_javascript/src/plugin/env_plugin.rscrates/rspack_plugin_javascript/src/parser_plugin/import_meta_env.rs renamed to crates/rspack_plugin_javascript/src/plugin/env_plugin.rs crates/rspack_plugin_javascript/src/parser_plugin/import_meta_env.rs renamed to crates/rspack_plugin_javascript/src/plugin/env_plugin.rs

@@ -1,14 +1,80 @@
 use std::sync::LazyLock;
 
 use concat_string::concat_string;
-use rspack_core::{Compilation, CompilationId, property_access_with_optional};
+use rspack_core::{
+  Compilation, CompilationId, CompilationParams, CompilerCompilation, Plugin,
+  property_access_with_optional,
+};
+use rspack_error::Result;
+use rspack_hook::{plugin, plugin_hook};
 use rspack_util::fx_hash::FxDashMap;
 use serde_json::{Map, Value};
 use swc_atoms::Atom;
 use swc_experimental_ecma_ast::{MemberExpr, MemberProp, MetaPropKind};
 
-use super::define_plugin::utils::{code_object_properties_to_string, code_to_string};
-use crate::visitors::{ExportedVariableInfo, ExpressionExpressionInfo, JavascriptParser};
+use crate::{
+  parser_plugin::define_plugin::utils::{code_object_properties_to_string, code_to_string},
+  visitors::{ExportedVariableInfo, ExpressionExpressionInfo, JavascriptParser},
+};
+
+#[plugin]
+#[derive(Debug, Default)]
+pub struct EnvPlugin;
+
+impl EnvPlugin {
+  pub(crate) fn collect(compilation_id: CompilationId, definitions: &ImportMetaEnvDefinitions) {
+    let mut state = IMPORT_META_ENV_DEFINITIONS_MAP
+      .entry(compilation_id)
+      .or_default();
+    state.definitions.merge(definitions);
+    state.serialized = None;
+  }
+
+  fn finalize(compilation: &mut Compilation) {
+    let compilation_id = compilation.id();
+    let mut state = IMPORT_META_ENV_DEFINITIONS_MAP
+      .entry(compilation_id)
+      .or_default();
+    let serialized = match &state.serialized {
+      Some(serialized) => serialized.clone(),
+      None => {
+        let serialized = serialize_import_meta_env_definitions(&state.definitions);
+        state.serialized = Some(serialized.clone());
+        serialized
+      }
+    };
+    compilation
+      .value_cache_versions
+      .insert(IMPORT_META_ENV_VALUE_DEP_KEY.to_string(), serialized);
+  }
+}
+
+#[plugin_hook(CompilerCompilation for EnvPlugin, stage = i32::MAX, tracing=false)]
+async fn compilation(
+  &self,
+  compilation: &mut Compilation,
+  _params: &mut CompilationParams,
+) -> Result<()> {
+  if compilation.options.experiments.env {
+    EnvPlugin::finalize(compilation);
+  }
+  Ok(())
+}
+
+impl Plugin for EnvPlugin {
+  fn name(&self) -> &'static str {
+    "rspack.EnvPlugin"
+  }
+
+  fn clear_cache(&self, id: CompilationId) {
+    IMPORT_META_ENV_DEFINITIONS_MAP.remove(&id);
+  }
+
+  fn apply(&self, ctx: &mut rspack_core::ApplyContext<'_>) -> Result<()> {
+    ctx.compiler_hooks.compilation.tap(compilation::new(self));
+    Ok(())
+  }
+}
 
 pub(crate) const IMPORT_META_ENV: &str = "import.meta.env";
 pub(crate) const IMPORT_META_ENV_PREFIX: &str = "import.meta.env.";
@@ -135,46 +201,6 @@ fn serialize_import_meta_env_definitions(definitions: &ImportMetaEnvDefinitions)
   concat_string!("{", properties, "}")
 }
 
-pub(crate) fn merge_import_meta_env_definitions(
-  compilation_id: CompilationId,
-  definitions: &ImportMetaEnvDefinitions,
-) {
-  let mut state = IMPORT_META_ENV_DEFINITIONS_MAP
-    .entry(compilation_id)
-    .or_default();
-  state.definitions.merge(definitions);
-  state.serialized = None;
-}
-
-pub(crate) fn finalize_import_meta_env_definitions(compilation: &mut Compilation) {
-  let compilation_id = compilation.id();
-  let mut state = IMPORT_META_ENV_DEFINITIONS_MAP
-    .entry(compilation_id)
-    .or_default();
-  let serialized = match &state.serialized {
-    Some(serialized) => serialized.clone(),
-    None => {
-      let serialized = serialize_import_meta_env_definitions(&state.definitions);
-      state.serialized = Some(serialized.clone());
-      serialized
-    }
-  };
-  compilation
-    .value_cache_versions
-    .insert(IMPORT_META_ENV_VALUE_DEP_KEY.to_string(), serialized);
-}
-
-pub(crate) fn seed_import_meta_env_value_cache(compilation: &mut Compilation) {
-  compilation.value_cache_versions.insert(
-    IMPORT_META_ENV_VALUE_DEP_KEY.to_string(),
-    import_meta_env_definitions_string(compilation.id()),
-  );
-}
-
-pub(crate) fn remove_import_meta_env_definitions(compilation_id: CompilationId) {
-  IMPORT_META_ENV_DEFINITIONS_MAP.remove(&compilation_id);
-}
-
 pub(crate) fn import_meta_env_definitions_string(compilation_id: CompilationId) -> String {
   IMPORT_META_ENV_DEFINITIONS_MAP
     .get(&compilation_id)

crates/rspack_plugin_javascript/src/plugin/impl_plugin_for_js_plugin.rs

@@ -47,7 +47,6 @@ use crate::{
     unsupported_dependency::UnsupportedDependencyTemplate,
   },
   parser_and_generator::JavaScriptParserAndGenerator,
-  parser_plugin::import_meta_env::seed_import_meta_env_value_cache,
 };
 
 #[plugin_hook(CompilerCompilation for JsPlugin)]
@@ -56,10 +55,6 @@ async fn compilation(
   compilation: &mut Compilation,
   params: &mut CompilationParams,
 ) -> Result<()> {
-  if compilation.options.experiments.env {
-    seed_import_meta_env_value_cache(compilation);
-  }
-
   // ESMModulesPlugin
   compilation.set_dependency_factory(
     DependencyType::EsmImport,

crates/rspack_plugin_javascript/src/plugin/mod.rs

@@ -9,6 +9,7 @@ use rayon::prelude::*;
 use rustc_hash::{FxHashMap, FxHashSet as HashSet};
 pub mod api_plugin;
 mod drive;
+pub mod env_plugin;
 mod flag_dependency_exports_plugin;
 mod flag_dependency_usage_plugin;
 pub mod impl_plugin_for_js_plugin;
@@ -21,6 +22,7 @@ mod side_effects_flag_plugin;
 pub mod url_plugin;
 
 pub use drive::*;
+pub use env_plugin::*;
 pub use flag_dependency_exports_plugin::*;
 pub use flag_dependency_usage_plugin::*;
 pub use inline_exports_plugin::*;