fix: rerun onBeforeDevCompile hook correctly with multiple environments (#5980)

Author: 9aoy

e2e/cases/plugin-api/plugin-hooks-environment/rebuild.test.ts

@@ -0,0 +1,94 @@
+import { join } from 'node:path';
+import {
+  getRandomPort,
+  gotoPage,
+  proxyConsole,
+  rspackOnlyTest,
+} from '@e2e/helper';
+import { expect } from '@playwright/test';
+import { createRsbuild, type RsbuildPlugin } from '@rsbuild/core';
+import fse from 'fs-extra';
+
+const createPlugin = () => {
+  const names: string[] = [];
+
+  const plugin: RsbuildPlugin = {
+    name: 'test-plugin',
+    setup(api) {
+      api.onBeforeEnvironmentCompile(({ environment }) => {
+        names.push(`BeforeEnvironmentCompile ${environment.name}`);
+      });
+      api.onBeforeDevCompile(() => {
+        names.push('BeforeDevCompile');
+      });
+    },
+  };
+
+  return { plugin, names };
+};
+
+rspackOnlyTest(
+  'should run onBeforeDevCompile hook correctly when rebuild in dev with multiple environments',
+  async ({ page }) => {
+    process.env.NODE_ENV = 'development';
+    const cwd = __dirname;
+    const filePath = join(cwd, 'test-temp-src', 'index.js');
+    await fse.outputFile(filePath, "console.log('1');");
+
+    const port = await getRandomPort();
+
+    const { plugin, names } = createPlugin();
+
+    const { expectLog, restore, expectBuildEnd } = proxyConsole();
+
+    const rsbuild = await createRsbuild({
+      cwd: __dirname,
+      rsbuildConfig: {
+        plugins: [plugin],
+        server: {
+          port,
+        },
+        environments: {
+          web: {},
+          node: {
+            source: {
+              entry: {
+                index: './test-temp-src/index.js',
+              },
+            },
+          },
+        },
+        performance: {
+          printFileSize: false,
+        },
+      },
+    });
+
+    const result = await rsbuild.startDevServer();
+
+    await gotoPage(page, result);
+
+    expect(names.includes('BeforeDevCompile')).toBeTruthy();
+    expect(names.includes('BeforeEnvironmentCompile node')).toBeTruthy();
+    expect(names.includes('BeforeEnvironmentCompile web')).toBeTruthy();
+
+    names.length = 0;
+
+    // rebuild
+    await fse.outputFile(filePath, "console.log('2');");
+    await expectLog('building test-temp-src');
+    await expectBuildEnd();
+
+    expect(names).toEqual([
+      'BeforeDevCompile',
+      // only recompile the node environment which is affected by the file change
+      'BeforeEnvironmentCompile node',
+    ]);
+
+    await result.server.close();
+
+    restore();
+
+    process.env.NODE_ENV = 'test';
+  },
+);

packages/core/src/hooks.ts

@@ -271,22 +271,19 @@ const onBeforeCompile = ({
   if (isMultiCompiler(compiler)) {
     const { compilers } = compiler;
 
-    let doneCompilers = 0;
-
     let waitBeforeCompileDone: Promise<void> | undefined;
 
+    // Executed when a watching compilation has been invalidated (re-compilation)
+    compiler.hooks.invalid.tap(name, () => {
+      waitBeforeCompileDone = undefined;
+    });
+
     for (let index = 0; index < compilers.length; index++) {
       const compiler = compilers[index];
-      let compilerDone = false;
 
       (isWatch ? compiler.hooks.watchRun : compiler.hooks.run).tapPromise(
         name,
         async () => {
-          if (!compilerDone) {
-            compilerDone = true;
-            doneCompilers++;
-          }
-
           if (!waitBeforeCompileDone) {
             waitBeforeCompileDone = beforeCompile?.();
           }
@@ -297,17 +294,6 @@ const onBeforeCompile = ({
           await beforeEnvironmentCompiler(index);
         },
       );
-
-      compiler.hooks.invalid.tap(name, () => {
-        if (compilerDone) {
-          compilerDone = false;
-          doneCompilers--;
-        }
-
-        if (doneCompilers <= 0) {
-          waitBeforeCompileDone = undefined;
-        }
-      });
     }
   } else {
     (isWatch ? compiler.hooks.watchRun : compiler.hooks.run).tapPromise(