fix(builder-rsbuild): pass through lazyCompilation options

fi3ework · fi3ework · commit 0264e5a6a905 · 2026-01-12T20:12:07.000+08:00
- align lazyCompilation handling with Rsbuild dev config typing
- default lazyCompilation to entries:false when option is unset
- pass through lazyCompilation booleans/objects to virtual module mapping
- expand iframe config tests for lazyCompilation scenarios
diff --git a/biome.json b/biome.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.3.11/schema.json",
   "assist": {
     "includes": ["**", "!**/*.vue"],
     "actions": { "source": { "organizeImports": "on" } }
diff --git a/packages/builder-rsbuild/src/preview/iframe-rsbuild.config.ts b/packages/builder-rsbuild/src/preview/iframe-rsbuild.config.ts
@@ -137,12 +137,13 @@ export default async (
   const builderOptions = await getBuilderOptions<BuilderOptions>(options)
   const cacheConfig = builderOptions.fsCache ? true : undefined
 
-  const lazyCompilationConfig: Rspack.LazyCompilationOptions | undefined =
-    builderOptions.lazyCompilation && !isProd
+  const lazyCompilationConfig: Rspack.Configuration['lazyCompilation'] = !isProd
+    ? builderOptions.lazyCompilation === undefined
       ? {
           entries: false,
         }
-      : undefined
+      : builderOptions.lazyCompilation
+    : undefined
 
   if (!template) {
     throw new Error(dedent`
diff --git a/packages/builder-rsbuild/src/preview/virtual-module-mapping.ts b/packages/builder-rsbuild/src/preview/virtual-module-mapping.ts
@@ -46,7 +46,8 @@ export const getVirtualModules = async (options: Options) => {
   const storiesFilename = 'storybook-stories.js'
   const storiesPath = resolve(join(workingDir, storiesFilename))
 
-  const needPipelinedImport = !!builderOptions.lazyCompilation && !isProd
+  const needPipelinedImport =
+    builderOptions.lazyCompilation !== false && !isProd
   virtualModules[storiesPath] = toImportFn(stories, {
     needPipelinedImport,
   })
diff --git a/packages/builder-rsbuild/src/types.ts b/packages/builder-rsbuild/src/types.ts
@@ -1,4 +1,4 @@
-import type { RsbuildConfig } from '@rsbuild/core'
+import type { DevConfig, RsbuildConfig } from '@rsbuild/core'
 import type { PluginTypeCheckerOptions } from '@rsbuild/plugin-type-check'
 import type {
   Builder,
@@ -42,9 +42,9 @@ export type BuilderOptions = {
    */
   rsbuildConfigPath?: string
   /**
-   * Enable Rspack's lazy compilation (experimental).
+   * Pass-through Rsbuild `dev.lazyCompilation` options.
    */
-  lazyCompilation?: NonNullable<RsbuildConfig['performance']>['buildCache']
+  lazyCompilation?: DevConfig['lazyCompilation']
   /**
    * Enable Rspack's [persistent cache(experimental)](https://rspack.dev/config/experiments#experimentscache).
    * We continue to use the name `fsCache` here to maintain better compatibility with the webpack builder.
diff --git a/packages/builder-rsbuild/tests/preview/iframe-rsbuild.config.test.ts b/packages/builder-rsbuild/tests/preview/iframe-rsbuild.config.test.ts
@@ -1,5 +1,6 @@
 import { resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
+import type { Rspack } from '@rsbuild/core'
 import { describe, expect, it, vi } from 'vitest'
 import type { RsbuildBuilderOptions } from '../../src/preview/iframe-rsbuild.config'
 import createIframeRsbuildConfig from '../../src/preview/iframe-rsbuild.config'
@@ -16,19 +17,25 @@ const storiesConfig = [
   },
 ]
 
-const createOptions = () => {
+type LazyCompilationOption = Rspack.Configuration['lazyCompilation']
+
+const createOptions = (
+  lazyCompilation: LazyCompilationOption | 'unset' = false,
+) => {
+  const builderCoreOptions: Record<string, unknown> = {
+    rsbuildConfigPath: fixtureRsbuildConfig,
+    addonDocs: {},
+    fsCache: false,
+    ...(lazyCompilation === 'unset' ? {} : { lazyCompilation }),
+  }
+
   const presetValues = new Map<string, unknown>([
     [
       'core',
       {
         builder: {
           name: 'storybook-builder-rsbuild',
-          options: {
-            rsbuildConfigPath: fixtureRsbuildConfig,
-            addonDocs: {},
-            fsCache: false,
-            lazyCompilation: false,
-          },
+          options: builderCoreOptions,
         },
       },
     ],
@@ -108,4 +115,49 @@ describe('iframe-rsbuild.config', () => {
       main: [storybookEntries[0], expectedDynamicEntry],
     })
   })
+
+  const runRspackTool = async (
+    lazyCompilation: LazyCompilationOption | 'unset',
+  ) => {
+    const { options } = createOptions(lazyCompilation)
+    const config = await createIframeRsbuildConfig(
+      options as RsbuildBuilderOptions,
+    )
+
+    const rspackTool = config.tools?.rspack
+    expect(typeof rspackTool).toBe('function')
+
+    const baseConfig = {} as any
+
+    return (rspackTool as any)(baseConfig, {
+      addRules: vi.fn(),
+      rspack: {
+        experiments: {
+          VirtualModulesPlugin: class VirtualModulesPlugin {},
+        },
+        ProvidePlugin: class ProvidePlugin {},
+      },
+      mergeConfig: (c: any) => c,
+    }) as any
+  }
+
+  it('uses entries:false when lazyCompilation is unset', async () => {
+    const rspackConfig = await runRspackTool('unset')
+    expect(rspackConfig.lazyCompilation).toEqual({ entries: false })
+  })
+
+  it('disables lazyCompilation when set to false', async () => {
+    const rspackConfig = await runRspackTool(false)
+    expect(rspackConfig.lazyCompilation).toBe(false)
+  })
+
+  it('passes through lazyCompilation when set to true', async () => {
+    const rspackConfig = await runRspackTool(true)
+    expect(rspackConfig.lazyCompilation).toBe(true)
+  })
+
+  it('passes through lazyCompilation options object', async () => {
+    const rspackConfig = await runRspackTool({ entries: true })
+    expect(rspackConfig.lazyCompilation).toEqual({ entries: true })
+  })
 })
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",`
	`2`	`+ "$schema": "https://biomejs.dev/schemas/2.3.11/schema.json",`
`3`	`3`	`"assist": {`
`4`	`4`	`"includes": ["", "!/*.vue"],`
`5`	`5`	`"actions": { "source": { "organizeImports": "on" } }`