feat: support OutputChunk#imports and RenderedChunk#imports (#999)

underfin · web-flow · commit 76a0f3f13f67 · 2024-04-29T10:09:07.000Z
diff --git a/crates/rolldown/src/stages/generate_stage/mod.rs b/crates/rolldown/src/stages/generate_stage/mod.rs
@@ -173,6 +173,7 @@ impl<'a> GenerateStage<'a> {
         modules: rendered_chunk.modules,
         exports: rendered_chunk.exports,
         module_ids: rendered_chunk.module_ids,
+        imports: rendered_chunk.imports,
         map,
         sourcemap_file_name,
       })));
diff --git a/crates/rolldown/src/utils/chunk/finalize_chunks.rs b/crates/rolldown/src/utils/chunk/finalize_chunks.rs
@@ -90,5 +90,18 @@ pub fn finalize_chunks(
     },
   );
 
+  // Replace hash placeholder in `imports`
+  chunk_graph.chunks.iter().zip(chunks.iter_mut()).par_bridge().for_each(
+    |(chunk, chunk_render_return)| {
+      chunk_render_return.rendered_chunk.imports = chunk
+        .cross_chunk_imports
+        .iter()
+        .map(|id| {
+          chunk_graph.chunks[*id].filename.as_ref().expect("should have file name").to_string()
+        })
+        .collect();
+    },
+  );
+
   chunks
 }
diff --git a/crates/rolldown/src/utils/chunk/mod.rs b/crates/rolldown/src/utils/chunk/mod.rs
@@ -3,7 +3,7 @@ use rolldown_common::{
 };
 use rustc_hash::FxHashMap;
 
-use crate::{stages::link_stage::LinkStageOutput, SharedOptions};
+use crate::{chunk_graph::ChunkGraph, stages::link_stage::LinkStageOutput, SharedOptions};
 
 use self::render_chunk_exports::get_chunk_export_names;
 
@@ -41,6 +41,7 @@ pub fn generate_rendered_chunk(
   graph: &LinkStageOutput,
   output_options: &SharedOptions,
   render_modules: FxHashMap<FilePath, RenderedModule>,
+  chunk_graph: &ChunkGraph,
 ) -> RenderedChunk {
   let pre_rendered_chunk = generate_pre_rendered_chunk(chunk, graph, output_options);
   RenderedChunk {
@@ -55,5 +56,16 @@ pub fn generate_rendered_chunk(
       .expect("should have preliminary_filename")
       .to_string(),
     modules: render_modules,
+    imports: chunk
+      .cross_chunk_imports
+      .iter()
+      .map(|id| {
+        chunk_graph.chunks[*id]
+          .preliminary_filename
+          .as_ref()
+          .expect("should have preliminary_filename")
+          .to_string()
+      })
+      .collect(),
   }
 }
diff --git a/crates/rolldown/src/utils/chunk/render_chunk.rs b/crates/rolldown/src/utils/chunk/render_chunk.rs
@@ -73,7 +73,7 @@ pub async fn render_chunk(
       }
       rendered_modules.insert(module_path, rendered_module);
     });
-  let rendered_chunk = generate_rendered_chunk(this, graph, options, rendered_modules);
+  let rendered_chunk = generate_rendered_chunk(this, graph, options, rendered_modules, chunk_graph);
 
   // add banner
   if let Some(banner) = options.banner.as_ref() {
diff --git a/crates/rolldown_binding/src/types/binding_output_chunk.rs b/crates/rolldown_binding/src/types/binding_output_chunk.rs
@@ -57,6 +57,11 @@ impl BindingOutputChunk {
       .collect()
   }
 
+  #[napi(getter)]
+  pub fn imports(&self) -> Vec<String> {
+    self.inner.imports.clone()
+  }
+
   // OutputChunk
   #[napi(getter)]
   pub fn code(&self) -> String {
diff --git a/crates/rolldown_binding/src/types/binding_rendered_chunk.rs b/crates/rolldown_binding/src/types/binding_rendered_chunk.rs
@@ -20,6 +20,7 @@ pub struct RenderedChunk {
   pub file_name: String,
   #[serde(skip)]
   pub modules: HashMap<String, BindingRenderedModule>,
+  pub imports: Vec<String>,
 }
 
 impl From<rolldown_common::RenderedChunk> for RenderedChunk {
@@ -36,6 +37,7 @@ impl From<rolldown_common::RenderedChunk> for RenderedChunk {
         .into_iter()
         .map(|(key, value)| (key.to_string(), value.into()))
         .collect(),
+      imports: value.imports,
     }
   }
 }
diff --git a/crates/rolldown_common/src/types/output_chunk.rs b/crates/rolldown_common/src/types/output_chunk.rs
@@ -17,6 +17,7 @@ pub struct OutputChunk {
   // RenderedChunk
   pub file_name: String,
   pub modules: FxHashMap<FilePath, RenderedModule>,
+  pub imports: Vec<String>,
   // OutputChunk
   pub code: String,
   pub map: Option<SourceMap>,
diff --git a/crates/rolldown_common/src/types/rendered_chunk.rs b/crates/rolldown_common/src/types/rendered_chunk.rs
@@ -13,4 +13,5 @@ pub struct RenderedChunk {
   // RenderedChunk
   pub file_name: String,
   pub modules: FxHashMap<FilePath, RenderedModule>,
+  pub imports: Vec<String>,
 }
diff --git a/packages/rolldown/src/binding.d.ts b/packages/rolldown/src/binding.d.ts
@@ -24,6 +24,7 @@ export class BindingOutputChunk {
   get exports(): Array<string>
   get fileName(): string
   get modules(): Record<string, BindingRenderedModule>
+  get imports(): Array<string>
   get code(): string
   get map(): string | null
   get sourcemapFileName(): string | null
@@ -158,5 +159,6 @@ export interface RenderedChunk {
   exports: Array<string>
   fileName: string
   modules: Record<string, BindingRenderedModule>
+  imports: Array<string>
 }
 
diff --git a/packages/rolldown/src/types/rolldown-output.ts b/packages/rolldown/src/types/rolldown-output.ts
@@ -36,6 +36,7 @@ export interface RolldownOutputChunk {
   modules: {
     [id: string]: RenderedModule
   }
+  imports: string[]
   facadeModuleId: string | null
   isDynamicEntry: boolean
   moduleIds: string[]
diff --git a/packages/rolldown/src/utils/transform-to-rollup-output.ts b/packages/rolldown/src/utils/transform-to-rollup-output.ts
@@ -24,6 +24,9 @@ function transformToRollupOutputChunk(
         Object.entries(chunk.modules).map(([key, _]) => [key, {}]),
       )
     },
+    get imports() {
+      return chunk.imports
+    },
     exports: chunk.exports,
     isEntry: chunk.isEntry,
     facadeModuleId: chunk.facadeModuleId || null,
diff --git a/packages/rolldown/tests/fixtures/output/hashFileNames/_config.ts b/packages/rolldown/tests/fixtures/output/hashFileNames/_config.ts
@@ -0,0 +1,65 @@
+import { defineTest } from '@tests'
+import { expect } from 'vitest'
+import { getOutputChunk } from '@tests/utils'
+
+const renderChunks: any[] = []
+
+export default defineTest({
+  config: {
+    input: ['main.js', 'entry.js'],
+    output: {
+      entryFileNames: '[name]-[hash].js',
+      chunkFileNames: '[name]-[hash].js',
+    },
+    plugins: [
+      {
+        name: 'test-plugin',
+        renderChunk: (code, chunk) => {
+          renderChunks.push(chunk)
+        },
+      },
+    ],
+  },
+  afterTest: (output) => {
+    // The `RenderChunk` should has file names hash placeholder.
+    expect(renderChunks.map((chunk) => chunk.fileName)).toMatchInlineSnapshot(`
+      [
+        "main-!~{000}~.js",
+        "entry-!~{001}~.js",
+        "shared-!~{002}~.js",
+      ]
+    `)
+    expect(renderChunks.map((chunk) => chunk.imports)).toMatchInlineSnapshot(`
+      [
+        [
+          "shared-!~{002}~.js",
+        ],
+        [
+          "shared-!~{002}~.js",
+        ],
+        [],
+      ]
+    `)
+
+    // The `OutputChunk` file names hash placeholder should be replaced.
+    const chunks = getOutputChunk(output)
+    expect(chunks.map((chunk) => chunk.fileName)).toMatchInlineSnapshot(`
+      [
+        "main-oEQ4m6Um.js",
+        "entry-6EYT-FfB.js",
+        "shared-RtRL5WZ7.js",
+      ]
+    `)
+    expect(chunks.map((chunk) => chunk.imports)).toMatchInlineSnapshot(`
+      [
+        [
+          "shared-RtRL5WZ7.js",
+        ],
+        [
+          "shared-RtRL5WZ7.js",
+        ],
+        [],
+      ]
+    `)
+  },
+})
diff --git a/packages/rolldown/tests/fixtures/output/hashFileNames/entry.js b/packages/rolldown/tests/fixtures/output/hashFileNames/entry.js
@@ -0,0 +1,3 @@
+import { value } from './shared.js'
+
+console.log(value)
diff --git a/packages/rolldown/tests/fixtures/output/hashFileNames/main.js b/packages/rolldown/tests/fixtures/output/hashFileNames/main.js
@@ -0,0 +1,3 @@
+import { value } from './shared.js'
+
+console.log(value)
diff --git a/packages/rolldown/tests/fixtures/output/hashFileNames/shared.js b/packages/rolldown/tests/fixtures/output/hashFileNames/shared.js
@@ -0,0 +1 @@
+export const value = 1
diff --git a/packages/rolldown/tests/fixtures/plugin/render-chunk/_config.ts b/packages/rolldown/tests/fixtures/plugin/render-chunk/_config.ts
@@ -20,6 +20,7 @@ export default defineTest({
           expect(chunk.isDynamicEntry).toBe(false)
           expect(chunk.facadeModuleId).toBe(entry)
           expect(chunk.exports.length).toBe(0)
+          expect(chunk.imports).toStrictEqual([])
           expect(chunk.moduleIds).toStrictEqual([entry])
           expect(Object.keys(chunk.modules).length).toBe(1)
           return 'render-chunk-code'
diff --git a/packages/rolldown/tests/src/utils.ts b/packages/rolldown/tests/src/utils.ts
@@ -1,4 +1,4 @@
-import { RollupOutput } from '../../src'
+import { RollupOutput, RolldownOutputChunk } from '../../src'
 import { TestConfig } from './types'
 
 export function getOutputChunkNames(output: RollupOutput) {
@@ -8,6 +8,12 @@ export function getOutputChunkNames(output: RollupOutput) {
     .sort()
 }
 
+export function getOutputChunk(output: RollupOutput): RolldownOutputChunk[] {
+  return output.output.filter(
+    (chunk) => chunk.type === 'chunk',
+  ) as RolldownOutputChunk[]
+}
+
 export function getOutputFileNames(output: RollupOutput) {
   return output.output.map((chunk) => chunk.fileName).sort()
 }

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ pub async fn render_chunk(`
`73`	`73`	`}`
`74`	`74`	`rendered_modules.insert(module_path, rendered_module);`
`75`	`75`	`});`
`76`		`- let rendered_chunk = generate_rendered_chunk(this, graph, options, rendered_modules);`
	`76`	`+ let rendered_chunk = generate_rendered_chunk(this, graph, options, rendered_modules, chunk_graph);`
`77`	`77`
`78`	`78`	`// add banner`
`79`	`79`	`if let Some(banner) = options.banner.as_ref() {`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ pub struct RenderedChunk {`
`20`	`20`	`pub file_name: String,`
`21`	`21`	`#[serde(skip)]`
`22`	`22`	`pub modules: HashMap<String, BindingRenderedModule>,`
	`23`	`+ pub imports: Vec<String>,`
`23`	`24`	`}`
`24`	`25`
`25`	`26`	`impl From<rolldown_common::RenderedChunk> for RenderedChunk {`
`@@ -36,6 +37,7 @@ impl From<rolldown_common::RenderedChunk> for RenderedChunk {`
`36`	`37`	`.into_iter()`
`37`	`38`	`.map(\|(key, value)\| (key.to_string(), value.into()))`
`38`	`39`	`.collect(),`
	`40`	`+ imports: value.imports,`
`39`	`41`	`}`
`40`	`42`	`}`
`41`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,5 @@ pub struct RenderedChunk {`
`13`	`13`	`// RenderedChunk`
`14`	`14`	`pub file_name: String,`
`15`	`15`	`pub modules: FxHashMap<FilePath, RenderedModule>,`
	`16`	`+ pub imports: Vec<String>,`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ export interface RolldownOutputChunk {`
`36`	`36`	`modules: {`
`37`	`37`	`[id: string]: RenderedModule`
`38`	`38`	`}`
	`39`	`+ imports: string[]`
`39`	`40`	`facadeModuleId: string \| null`
`40`	`41`	`isDynamicEntry: boolean`
`41`	`42`	`moduleIds: string[]`