feat: allow external modules placed in async chunks (#11421)

Author: JSerFeng

crates/node_binding/napi-binding.d.ts

@@ -2144,6 +2144,7 @@ export interface RawExternalItemFnResult {
 export interface RawExternalsPluginOptions {
   type: string
   externals: (string | RegExp | Record<string, string | boolean | string[] | Record<string, string[]>> | ((...args: any[]) => any))[]
+  placeInInitial: boolean
 }
 
 export interface RawExternalsPresets {

crates/rspack/src/builder/builder_context.rs

@@ -12,7 +12,7 @@ use rspack_core::{
 #[repr(u8)]
 pub(super) enum BuiltinPluginOptions {
   // External handling plugins
-  ExternalsPlugin((ExternalType, Vec<ExternalItem>)),
+  ExternalsPlugin((ExternalType, Vec<ExternalItem>, bool)),
   NodeTargetPlugin,
   ElectronTargetPlugin(rspack_plugin_externals::ElectronTargetContext),
   HttpExternalsRspackPlugin((bool /* css */, bool /* web_async */)),
@@ -111,9 +111,11 @@ impl BuilderContext {
     let mut plugins = Vec::new();
     self.plugins.drain(..).for_each(|plugin| match plugin {
       // External handling plugins
-      BuiltinPluginOptions::ExternalsPlugin((external_type, externals)) => {
-        plugins
-          .push(rspack_plugin_externals::ExternalsPlugin::new(external_type, externals).boxed());
+      BuiltinPluginOptions::ExternalsPlugin((external_type, externals, place_in_initial)) => {
+        plugins.push(
+          rspack_plugin_externals::ExternalsPlugin::new(external_type, externals, place_in_initial)
+            .boxed(),
+        );
       }
       BuiltinPluginOptions::NodeTargetPlugin => {
         plugins.push(rspack_plugin_externals::node_target_plugin())

crates/rspack/src/builder/mod.rs

@@ -1084,6 +1084,7 @@ impl CompilerOptionsBuilder {
         .push(BuiltinPluginOptions::ExternalsPlugin((
           expect!(self.externals_type.clone()),
           externals,
+          false,
         )));
     }
 
@@ -1135,6 +1136,7 @@ impl CompilerOptionsBuilder {
         .push(BuiltinPluginOptions::ExternalsPlugin((
           "node-commonjs".to_string(),
           vec!["nw.gui".to_string().into()],
+          false,
         )));
     }
 

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

@@ -364,7 +364,12 @@ impl<'a> BuiltinPlugin<'a> {
           .map(|e| RawExternalItemWrapper(e).try_into())
           .collect::<Result<Vec<_>>>()
           .map_err(|report| napi::Error::from_reason(report.to_string()))?;
-        let plugin = ExternalsPlugin::new(plugin_options.r#type, externals).boxed();
+        let plugin = ExternalsPlugin::new(
+          plugin_options.r#type,
+          externals,
+          plugin_options.place_in_initial,
+        )
+        .boxed();
         plugins.push(plugin);
       }
       BuiltinPluginName::NodeTargetPlugin => plugins.push(node_target_plugin()),

crates/rspack_binding_api/src/raw_options/raw_external.rs

@@ -36,6 +36,7 @@ pub struct RawExternalsPluginOptions {
     ts_type = "(string | RegExp | Record<string, string | boolean | string[] | Record<string, string[]>> | ((...args: any[]) => any))[]"
   )]
   pub externals: Vec<RawExternalItem>,
+  pub place_in_initial: bool,
 }
 
 type RawExternalItem = Either4<

crates/rspack_core/src/external_module.rs

@@ -209,6 +209,7 @@ pub struct ExternalModule {
   build_info: BuildInfo,
   build_meta: BuildMeta,
   dependency_meta: DependencyMeta,
+  place_in_initial: bool,
 }
 
 #[cacheable]
@@ -234,6 +235,7 @@ impl ExternalModule {
     external_type: ExternalType,
     user_request: String,
     dependency_meta: DependencyMeta,
+    place_in_initial: bool,
   ) -> Self {
     Self {
       dependencies: Vec::new(),
@@ -255,6 +257,7 @@ impl ExternalModule {
       build_meta: Default::default(),
       source_map_kind: SourceMapKind::empty(),
       dependency_meta,
+      place_in_initial,
     }
   }
 
@@ -765,15 +768,15 @@ impl Module for ExternalModule {
   }
 
   fn chunk_condition(&self, chunk_key: &ChunkUkey, compilation: &Compilation) -> Option<bool> {
-    if self.external_type == "css-import" {
-      return Some(true);
+    match self.external_type.as_str() {
+      "css-import" | "module" | "import" | "module-import" if !self.place_in_initial => Some(true),
+      _ => Some(
+        compilation
+          .chunk_graph
+          .get_number_of_entry_modules(chunk_key)
+          > 0,
+      ),
     }
-    Some(
-      compilation
-        .chunk_graph
-        .get_number_of_entry_modules(chunk_key)
-        > 0,
-    )
   }
 
   fn source(&self) -> Option<&BoxSource> {

crates/rspack_plugin_dll/src/dll_reference/dll_reference_agency_plugin.rs

@@ -67,7 +67,7 @@ impl Plugin for DllReferenceAgencyPlugin {
 
     let external = ExternalItem::Object(external_item_object);
 
-    ExternalsPlugin::new(source_type.unwrap_or("var".into()), vec![external]).apply(ctx)?;
+    ExternalsPlugin::new(source_type.unwrap_or("var".into()), vec![external], false).apply(ctx)?;
 
     DelegatedPlugin::new(DelegatedPluginOptions {
       source: source.clone(),

crates/rspack_plugin_externals/src/electron_target_plugin.rs

@@ -41,6 +41,7 @@ pub fn electron_target_plugin(context: ElectronTargetContext, plugins: &mut Vec<
       .into_iter()
       .map(|i| ExternalItem::String(i.to_string()))
       .collect(),
+      false,
     )
     .boxed(),
   );
@@ -68,6 +69,7 @@ pub fn electron_target_plugin(context: ElectronTargetContext, plugins: &mut Vec<
         .into_iter()
         .map(|i| ExternalItem::String(i.to_string()))
         .collect(),
+        false,
       )
       .boxed(),
     ),
@@ -78,6 +80,7 @@ pub fn electron_target_plugin(context: ElectronTargetContext, plugins: &mut Vec<
           .into_iter()
           .map(|i| ExternalItem::String(i.to_string()))
           .collect(),
+        false,
       )
       .boxed(),
     ),

crates/rspack_plugin_externals/src/http_externals_plugin.rs

@@ -6,9 +6,19 @@ use crate::ExternalsPlugin;
 
 pub fn http_externals_rspack_plugin(css: bool, web_async: bool) -> BoxPlugin {
   if web_async {
-    ExternalsPlugin::new("import".to_owned(), vec![http_external_item_web_async(css)]).boxed()
+    ExternalsPlugin::new(
+      "import".to_owned(),
+      vec![http_external_item_web_async(css)],
+      false,
+    )
+    .boxed()
   } else {
-    ExternalsPlugin::new("module".to_owned(), vec![http_external_item_web(css)]).boxed()
+    ExternalsPlugin::new(
+      "module".to_owned(),
+      vec![http_external_item_web(css)],
+      false,
+    )
+    .boxed()
   }
 }
 

crates/rspack_plugin_externals/src/node_target_plugin.rs

@@ -65,6 +65,7 @@ pub fn node_target_plugin() -> BoxPlugin {
       // Yarn PnP adds pnpapi as "builtin"
       ExternalItem::from("pnpapi".to_string()),
     ],
+    false,
   )
   .boxed()
 }