feat: allow to configure dev.writeToDisk in environments (#3946)

Co-authored-by: neverland <[email protected]>

Author: 9aoy

e2e/cases/server/write-to-disk-environments/index.test.ts

@@ -0,0 +1,58 @@
+import fs from 'node:fs';
+import { join } from 'node:path';
+import { dev } from '@e2e/helper';
+import { expect, test } from '@playwright/test';
+
+const cwd = __dirname;
+
+test('multiple environments writeToDisk should work correctly', async ({
+  page,
+}) => {
+  const rsbuild = await dev({
+    cwd,
+    page,
+    rsbuildConfig: {
+      dev: {
+        writeToDisk: true,
+      },
+      environments: {
+        web: {
+          output: {
+            distPath: {
+              root: 'dist',
+            },
+          },
+          dev: {
+            writeToDisk: false,
+          },
+        },
+        web1: {
+          output: {
+            distPath: {
+              root: 'dist-1',
+            },
+          },
+          dev: {
+            writeToDisk: true,
+          },
+        },
+        web2: {
+          output: {
+            distPath: {
+              root: 'dist-2',
+            },
+          },
+        },
+      },
+    },
+  });
+
+  const test = page.locator('#test');
+  await expect(test).toHaveText('Hello Rsbuild!');
+
+  expect(fs.existsSync(join(cwd, 'dist/index.html'))).toBeFalsy();
+  expect(fs.existsSync(join(cwd, 'dist-1/index.html'))).toBeTruthy();
+  expect(fs.existsSync(join(cwd, 'dist-2/index.html'))).toBeTruthy();
+
+  await rsbuild.close();
+});

e2e/cases/server/write-to-disk-environments/src/index.js

@@ -0,0 +1,5 @@
+const testEl = document.createElement('div');
+testEl.id = 'test';
+testEl.innerHTML = 'Hello Rsbuild!';
+
+document.body.appendChild(testEl);

packages/core/package.json

@@ -89,7 +89,7 @@
     "prebundle": "1.2.5",
     "reduce-configs": "^1.0.0",
     "rimraf": "^6.0.1",
-    "rsbuild-dev-middleware": "0.1.1",
+    "rsbuild-dev-middleware": "0.1.2",
     "rslog": "^1.2.3",
     "rspack-chain": "^1.0.3",
     "rspack-manifest-plugin": "5.0.2",

packages/core/src/provider/createCompiler.ts

@@ -153,7 +153,9 @@ export type DevMiddlewareOptions = {
 
   /** The options need by compiler middleware (like webpackMiddleware) */
   headers?: Record<string, string | string[]>;
-  writeToDisk?: boolean | ((filename: string) => boolean);
+  writeToDisk?:
+    | boolean
+    | ((filename: string, compilationName?: string) => boolean);
   stats?: boolean;
 
   /** should trigger when compiler hook called */

packages/core/src/provider/initConfigs.ts

@@ -106,6 +106,7 @@ const initEnvironmentConfigs = (
               {
                 ...rsbuildSharedConfig,
                 dev: pick(dev, [
+                  'writeToDisk',
                   'hmr',
                   'assetPrefix',
                   'progressBar',
@@ -139,7 +140,13 @@ const initEnvironmentConfigs = (
   return {
     [defaultEnvironmentName]: applyEnvironmentDefaultConfig({
       ...rsbuildSharedConfig,
-      dev: pick(dev, ['hmr', 'assetPrefix', 'progressBar', 'lazyCompilation']),
+      dev: pick(dev, [
+        'hmr',
+        'assetPrefix',
+        'progressBar',
+        'lazyCompilation',
+        'writeToDisk',
+      ]),
     } as MergedEnvironmentConfig),
   };
 };
@@ -178,6 +185,7 @@ export async function initRsbuildConfig({
       assetPrefix,
       progressBar,
       lazyCompilation,
+      writeToDisk,
       ...rsbuildSharedDev
     },
     server,

packages/core/src/server/compilerDevMiddleware.ts

@@ -2,7 +2,13 @@ import type { IncomingMessage, ServerResponse } from 'node:http';
 import { createRequire } from 'node:module';
 import type { Socket } from 'node:net';
 import { pathnameParse } from '../helpers/path';
-import type { DevConfig, NextFunction, Rspack, ServerConfig } from '../types';
+import type {
+  EnvironmentContext,
+  NextFunction,
+  DevConfig as OriginDevConfig,
+  Rspack,
+  ServerConfig,
+} from '../types';
 import {
   type DevMiddleware as CustomDevMiddleware,
   type DevMiddlewareAPI,
@@ -15,11 +21,44 @@ const require = createRequire(import.meta.url);
 
 type Options = {
   publicPaths: string[];
-  dev: DevConfig;
+  environments: Record<string, EnvironmentContext>;
+  dev: OriginDevConfig;
   server: ServerConfig;
   compiler: Rspack.Compiler | Rspack.MultiCompiler;
 };
 
+type DevConfig = Omit<OriginDevConfig, 'writeToDisk'> & {
+  writeToDisk?:
+    | boolean
+    | ((filename: string, compilationName?: string) => boolean);
+};
+
+// allow to configure dev.writeToDisk in environments
+const formatDevConfig = (
+  config: OriginDevConfig,
+  environments: Record<string, EnvironmentContext>,
+): DevConfig => {
+  const writeToDiskValues = Object.values(environments).map(
+    (env) => env.config.dev.writeToDisk,
+  );
+  if (new Set(writeToDiskValues).size === 1) {
+    return config;
+  }
+
+  return {
+    ...config,
+    writeToDisk(filePath: string, compilationName?: string) {
+      let { writeToDisk } = config;
+      if (compilationName && environments[compilationName]) {
+        writeToDisk =
+          environments[compilationName].config.dev.writeToDisk ?? writeToDisk;
+      }
+      return typeof writeToDisk === 'function'
+        ? writeToDisk(filePath)
+        : writeToDisk!;
+    },
+  };
+};
 const noop = () => {
   // noop
 };
@@ -58,8 +97,8 @@ export class CompilerDevMiddleware {
 
   private socketServer: SocketServer;
 
-  constructor({ dev, server, compiler, publicPaths }: Options) {
-    this.devConfig = dev;
+  constructor({ dev, server, compiler, publicPaths, environments }: Options) {
+    this.devConfig = formatDevConfig(dev, environments);
     this.serverConfig = server;
     this.compiler = compiler;
     this.publicPaths = publicPaths;

packages/core/src/server/devServer.ts

@@ -163,6 +163,7 @@ export async function createDevServer<
       server: config.server,
       publicPaths: publicPaths,
       compiler,
+      environments: options.context.environments,
     });
 
     await compilerDevMiddleware.init();

packages/core/src/types/config.ts

@@ -1368,7 +1368,7 @@ export interface EnvironmentConfig {
    */
   dev?: Pick<
     DevConfig,
-    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation'
+    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation' | 'writeToDisk'
   >;
   /**
    * Options for HTML generation.
@@ -1447,7 +1447,7 @@ export type MergedEnvironmentConfig = {
   root: string;
   dev: Pick<
     NormalizedDevConfig,
-    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation'
+    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation' | 'writeToDisk'
   >;
   html: NormalizedHtmlConfig;
   tools: NormalizedToolsConfig;

pnpm-lock.yaml

@@ -10,7 +10,7 @@ Rsbuild supports building outputs for multiple environments. You can use `enviro
 interface EnvironmentConfig {
   dev?: Pick<
     DevConfig,
-    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation'
+    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation' | 'writeToDisk'
   >;
   html?: HtmlConfig;
   tools?: ToolsConfig;