feat: support entrypoint.getEntrypointChunk() (#9625)

Author: ahabhgk

crates/node_binding/binding.d.ts

@@ -109,6 +109,7 @@ export declare class JsChunkGroup {
   isInitial(): boolean
   getParents(): JsChunkGroup[]
   getRuntimeChunk(): JsChunk
+  getEntrypointChunk(): JsChunk
   getFiles(): Array<string>
   getModulePreOrderIndex(module: JsModule): number | null
   getModulePostOrderIndex(module: JsModule): number | null

crates/node_binding/src/chunk_group.rs

@@ -119,6 +119,13 @@ impl JsChunkGroup {
     Ok(JsChunkWrapper::new(chunk_ukey, compilation))
   }
 
+  #[napi(ts_return_type = "JsChunk")]
+  pub fn get_entrypoint_chunk(&self) -> napi::Result<JsChunkWrapper> {
+    let (compilation, chunk_group) = self.as_ref()?;
+    let chunk_ukey = chunk_group.get_entrypoint_chunk();
+    Ok(JsChunkWrapper::new(chunk_ukey, compilation))
+  }
+
   #[napi]
   pub fn get_files(&self) -> napi::Result<Vec<&String>> {
     let (compilation, chunk_group) = self.as_ref()?;

crates/rspack_core/src/build_chunk_graph/code_splitter.rs

@@ -437,7 +437,7 @@ impl CodeSplitter {
       entrypoint.set_runtime_chunk(chunk.ukey());
     }
 
-    entrypoint.set_entry_point_chunk(chunk.ukey());
+    entrypoint.set_entrypoint_chunk(chunk.ukey());
     entrypoint.connect_chunk(chunk);
 
     compilation
@@ -529,7 +529,7 @@ Remove the 'runtime' option from the entrypoint."
           compilation
             .chunk_group_by_ukey
             .expect_get(key)
-            .get_entry_point_chunk()
+            .get_entrypoint_chunk()
             .as_u32()
         })),
       );
@@ -550,7 +550,7 @@ Remove the 'runtime' option from the entrypoint."
         let entry_point = compilation.chunk_group_by_ukey.expect_get(ukey);
         let entry_point_chunk = compilation
           .chunk_by_ukey
-          .expect_get(&entry_point.get_entry_point_chunk());
+          .expect_get(&entry_point.get_entrypoint_chunk());
         let referenced_chunks =
           entry_point_chunk.get_all_referenced_chunks(&compilation.chunk_group_by_ukey);
 
@@ -559,13 +559,13 @@ Remove the 'runtime' option from the entrypoint."
             let dependency_chunk_ukey = compilation
               .chunk_group_by_ukey
               .expect_get(dependency_ukey)
-              .get_entry_point_chunk();
+              .get_entrypoint_chunk();
             if referenced_chunks.contains(&dependency_chunk_ukey) {
               runtime_errors.push(Diagnostic::from(
                 error!(
                   "Entrypoints '{name}' and '{dep}' use 'dependOn' to depend on each other in a circular way."
                 ),
-              ).with_chunk(Some(entry_point.get_entry_point_chunk().as_u32())));
+              ).with_chunk(Some(entry_point.get_entrypoint_chunk().as_u32())));
               entry_point_runtime = Some(entry_point_chunk.ukey());
               has_error = true;
               break;
@@ -605,7 +605,7 @@ Remove the 'runtime' option from the entrypoint."
       let chunk = match compilation.named_chunks.get(runtime) {
         Some(ukey) => {
           if !self.runtime_chunks.contains(ukey) {
-            let entry_chunk = entry_point.get_entry_point_chunk();
+            let entry_chunk = entry_point.get_entrypoint_chunk();
             runtime_errors.push(Diagnostic::from(
               error!(
                 "Entrypoint '{name}' has a 'runtime' option which points to another entrypoint named '{runtime}'.
@@ -707,7 +707,7 @@ Or do you want to use the entrypoints '{name}' and '{runtime}' independently on
         self.chunk_groups_for_combining.insert(*cgi);
       } else {
         // The application may start here: We start with an empty list of available modules
-        let chunk = chunk_group.get_entry_point_chunk();
+        let chunk = chunk_group.get_entrypoint_chunk();
         for module in modules {
           self
             .queue
@@ -847,7 +847,7 @@ Or do you want to use the entrypoints '{name}' and '{runtime}' independently on
 
         Some(root_modules)
       } else if chunk_group.kind.is_entrypoint() && chunk_group.is_initial() {
-        let entry_chunk_ukey = chunk_group.get_entry_point_chunk();
+        let entry_chunk_ukey = chunk_group.get_entrypoint_chunk();
         let entry_modules = compilation
           .chunk_graph
           .get_chunk_entry_modules(&entry_chunk_ukey);
@@ -1395,7 +1395,7 @@ Or do you want to use the entrypoints '{name}' and '{runtime}' independently on
             self.chunk_group_infos.entry(ukey).or_insert(cgi);
 
             entrypoint.set_runtime_chunk(chunk.ukey());
-            entrypoint.set_entry_point_chunk(chunk.ukey());
+            entrypoint.set_entrypoint_chunk(chunk.ukey());
             compilation.async_entrypoints.push(entrypoint.ukey);
             self.next_chunk_group_index += 1;
             entrypoint.index = Some(self.next_chunk_group_index);

crates/rspack_core/src/build_chunk_graph/new_code_splitter.rs

@@ -898,7 +898,7 @@ impl CodeSplitter {
           entrypoint.module_post_order_indices = post_order_indices;
 
           let entry_chunk = compilation.chunk_by_ukey.expect_get_mut(&entry_chunk_ukey);
-          entrypoint.set_entry_point_chunk(entry_chunk_ukey);
+          entrypoint.set_entrypoint_chunk(entry_chunk_ukey);
 
           if initial {
             compilation
@@ -1161,7 +1161,7 @@ Or do you want to use the entrypoints '{name}' and '{entry_runtime}' independent
         .expect("unreachable");
       let entry_point_chunk = compilation
         .chunk_by_ukey
-        .expect_get(&entrypoint.get_entry_point_chunk());
+        .expect_get(&entrypoint.get_entrypoint_chunk());
       let entry_point_chunk_ukey = entry_point_chunk.ukey();
       let referenced_chunks =
         entry_point_chunk.get_all_referenced_chunks(&compilation.chunk_group_by_ukey);
@@ -1173,7 +1173,7 @@ Or do you want to use the entrypoints '{name}' and '{entry_runtime}' independent
           let dep_entrypoint = compilation
             .chunk_group_by_ukey
             .expect_get_mut(dep_entrypoint_ukey);
-          let dependency_chunk_ukey = dep_entrypoint.get_entry_point_chunk();
+          let dependency_chunk_ukey = dep_entrypoint.get_entrypoint_chunk();
           if referenced_chunks.contains(&dependency_chunk_ukey) {
             // cycle dep
             compilation

crates/rspack_core/src/chunk_graph/chunk_graph_chunk.rs

@@ -693,7 +693,7 @@ impl ChunkGraph {
     for chunk_group_ukey in chunk.get_sorted_groups_iter(chunk_group_by_ukey) {
       let chunk_group = chunk_group_by_ukey.expect_get(chunk_group_ukey);
       if chunk_group.kind.is_entrypoint() {
-        let entry_point_chunk = chunk_group.get_entry_point_chunk();
+        let entry_point_chunk = chunk_group.get_entrypoint_chunk();
         let cgc = self.expect_chunk_graph_chunk(&entry_point_chunk);
         for (_, chunk_group_ukey) in cgc.entry_modules.iter() {
           let chunk_group = chunk_group_by_ukey.expect_get(chunk_group_ukey);

crates/rspack_core/src/chunk_group.rs

@@ -49,7 +49,7 @@ pub struct ChunkGroup {
   pub(crate) next_post_order_index: usize,
   // Entrypoint
   pub(crate) runtime_chunk: Option<ChunkUkey>,
-  pub(crate) entry_point_chunk: Option<ChunkUkey>,
+  pub(crate) entrypoint_chunk: Option<ChunkUkey>,
   origins: Vec<OriginRecord>,
   pub(crate) is_over_size_limit: Option<bool>,
 }
@@ -68,7 +68,7 @@ impl ChunkGroup {
       next_pre_order_index: 0,
       next_post_order_index: 0,
       runtime_chunk: None,
-      entry_point_chunk: None,
+      entrypoint_chunk: None,
       index: None,
       origins: vec![],
       is_over_size_limit: None,
@@ -159,14 +159,14 @@ impl ChunkGroup {
     }
   }
 
-  pub fn set_entry_point_chunk(&mut self, chunk_ukey: ChunkUkey) {
-    self.entry_point_chunk = Some(chunk_ukey);
+  pub fn set_entrypoint_chunk(&mut self, chunk_ukey: ChunkUkey) {
+    self.entrypoint_chunk = Some(chunk_ukey);
   }
 
-  pub fn get_entry_point_chunk(&self) -> ChunkUkey {
+  pub fn get_entrypoint_chunk(&self) -> ChunkUkey {
     match self.kind {
       ChunkGroupKind::Entrypoint { .. } => self
-        .entry_point_chunk
+        .entrypoint_chunk
         .expect("EntryPoint runtime chunk not set"),
       ChunkGroupKind::Normal { .. } => {
         unreachable!("Normal chunk group doesn't have runtime chunk")
@@ -240,9 +240,9 @@ impl ChunkGroup {
       }
     }
 
-    if let Some(entry_point_chunk) = self.entry_point_chunk {
+    if let Some(entry_point_chunk) = self.entrypoint_chunk {
       if entry_point_chunk == *old_chunk {
-        self.entry_point_chunk = Some(*new_chunk);
+        self.entrypoint_chunk = Some(*new_chunk);
       }
     }
 

crates/rspack_core/src/compiler/module_executor/execute.rs

@@ -138,7 +138,7 @@ impl Task<MakeTaskContext> for ExecuteTask {
     );
     entrypoint.connect_chunk(chunk);
     entrypoint.set_runtime_chunk(chunk.ukey());
-    entrypoint.set_entry_point_chunk(chunk.ukey());
+    entrypoint.set_entrypoint_chunk(chunk.ukey());
 
     compilation.chunk_group_by_ukey.add(entrypoint);
 

crates/rspack_plugin_javascript/src/dependency/worker/mod.rs

@@ -111,7 +111,7 @@ impl DependencyTemplate for WorkerDependency {
           .chunk_graph
           .get_block_chunk_group(block, &compilation.chunk_group_by_ukey)
       })
-      .map(|entrypoint| entrypoint.get_entry_point_chunk())
+      .map(|entrypoint| entrypoint.get_entrypoint_chunk())
       .and_then(|ukey| compilation.chunk_by_ukey.get(&ukey))
       .and_then(|chunk| chunk.id(&compilation.chunk_ids_artifact))
       .and_then(|chunk_id| serde_json::to_string(chunk_id).ok())

crates/rspack_plugin_runtime/src/runtime_module/get_chunk_filename.rs

@@ -116,7 +116,7 @@ impl RuntimeModule for GetChunkFilenameRuntimeModule {
             chunk.get_all_referenced_async_entrypoints(&compilation.chunk_group_by_ukey)
           {
             let entrypoint = compilation.chunk_group_by_ukey.expect_get(&entrypoint);
-            chunks.insert(entrypoint.get_entry_point_chunk());
+            chunks.insert(entrypoint.get_entrypoint_chunk());
           }
           chunks
         }

crates/rspack_plugin_runtime/src/runtime_module/mod.rs

@@ -39,7 +39,7 @@ mod rspack_unique_id;
 mod rspack_version;
 mod runtime_id;
 mod startup_chunk_dependencies;
-mod startup_entry_point;
+mod startup_entrypoint;
 mod system_context;
 mod utils;
 pub use amd_define::AmdDefineRuntimeModule;
@@ -83,6 +83,6 @@ pub use rspack_unique_id::RspackUniqueIdRuntimeModule;
 pub use rspack_version::RspackVersionRuntimeModule;
 pub use runtime_id::RuntimeIdRuntimeModule;
 pub use startup_chunk_dependencies::StartupChunkDependenciesRuntimeModule;
-pub use startup_entry_point::StartupEntrypointRuntimeModule;
+pub use startup_entrypoint::StartupEntrypointRuntimeModule;
 pub use system_context::SystemContextRuntimeModule;
 pub use utils::*;

crates/rspack_plugin_runtime/src/runtime_module/startup_entry_point.rs crates/rspack_plugin_runtime/src/runtime_module/startup_entrypoint.rs

@@ -0,0 +1 @@
+export const a = 1;

packages/rspack-test-tools/tests/configCases/chunks/get-entrypoint-chunk/async.js

@@ -0,0 +1,4 @@
+it("should compile", async () => {
+	const { a } = await import(/* webpackChunkName: "async" */ "./async");
+	expect(a).toBe(1);
+});

packages/rspack-test-tools/tests/configCases/chunks/get-entrypoint-chunk/index.js

@@ -0,0 +1,30 @@
+/** @type {import("@rspack/core").Configuration} */
+module.exports = {
+	entry: "./index.js",
+	output: {
+		filename: "[name].js"
+	},
+	optimization: {
+		runtimeChunk: true
+	},
+	plugins: [
+		{
+			/**@param {import("@rspack/core").Compiler} compiler */
+			apply(compiler) {
+				compiler.hooks.thisCompilation.tap("test", compilation => {
+					compilation.hooks.afterSeal.tap("test", () => {
+						let entrypoint = compilation.entrypoints.get("main");
+						let entrypointChunk = entrypoint.getEntrypointChunk();
+						expect(entrypointChunk.name).toBe("main");
+						let chunks = entrypointChunk.getAllReferencedChunks();
+						expect([...chunks].map(c => c.name)).toEqual([
+							"runtime~main",
+							"main",
+							"async"
+						]);
+					});
+				});
+			}
+		}
+	]
+};

packages/rspack-test-tools/tests/configCases/chunks/get-entrypoint-chunk/rspack.config.js

@@ -1776,6 +1776,8 @@ class Entrypoint extends ChunkGroup {
     // (undocumented)
     static __from_binding(binding: JsChunkGroup): Entrypoint;
     // (undocumented)
+    getEntrypointChunk(): Readonly<Chunk | null>;
+    // (undocumented)
     getRuntimeChunk(): Readonly<Chunk | null>;
 }
 

packages/rspack/etc/core.api.md

@@ -27,4 +27,9 @@ export class Entrypoint extends ChunkGroup {
 		const chunkBinding = this.#inner.getRuntimeChunk();
 		return chunkBinding ? Chunk.__from_binding(chunkBinding) : null;
 	}
+
+	getEntrypointChunk(): Readonly<Chunk | null> {
+		const chunkBinding = this.#inner.getEntrypointChunk();
+		return chunkBinding ? Chunk.__from_binding(chunkBinding) : null;
+	}
 }