feat(plugin-api): add build time to environment compile hook (#6584)

Author: chenjiahan

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

@@ -51,8 +51,9 @@ const createPlugin = () => {
       api.onBeforeEnvironmentCompile(({ environment }) => {
         names.push(`BeforeEnvironmentCompile ${environment.name}`);
       });
-      api.onAfterEnvironmentCompile(({ stats, environment }) => {
+      api.onAfterEnvironmentCompile(({ stats, environment, time }) => {
         expect(stats?.compilation.name).toBe(environment.name);
+        expect(time).toBeGreaterThan(0);
         names.push(`AfterEnvironmentCompile ${environment.name}`);
       });
       api.onBeforeStartProdServer(() => {

packages/core/src/hooks.ts

@@ -407,15 +407,19 @@ export const registerBuildHook = ({
     await promise;
   };
 
-  const onEnvironmentDone = async (buildIndex: number, stats: Rspack.Stats) => {
+  const onEnvironmentDone = async (index: number, stats: Rspack.Stats) => {
+    const environment = environmentList[index];
+    const time = context.buildState.time[environment.name] ?? 0;
+
     await context.hooks.onAfterEnvironmentCompile.callBatch({
-      environment: environmentList[buildIndex].name,
+      environment: environment.name,
       args: [
         {
           isFirstCompile,
           stats,
-          environment: environmentList[buildIndex],
+          environment,
           isWatch,
+          time,
         },
       ],
     });
@@ -484,15 +488,19 @@ export const registerDevHook = ({
     await promise;
   };
 
-  const onEnvironmentDone = async (buildIndex: number, stats: Rspack.Stats) => {
+  const onEnvironmentDone = async (index: number, stats: Rspack.Stats) => {
+    const environment = environmentList[index];
+    const time = context.buildState.time[environment.name] ?? 0;
+
     await context.hooks.onAfterEnvironmentCompile.callBatch({
-      environment: environmentList[buildIndex].name,
+      environment: environment.name,
       args: [
         {
           isFirstCompile,
           stats,
-          environment: environmentList[buildIndex],
+          environment,
           isWatch: true,
+          time,
         },
       ],
     });

packages/core/src/types/hooks.ts

@@ -55,6 +55,10 @@ export type OnBeforeDevCompileFn<B = 'rspack'> = (
 export type OnAfterEnvironmentCompileFn = (
   params: CompileCommonParams & {
     stats?: Rspack.Stats;
+    /**
+     * The time it takes to build the current environment in milliseconds.
+     */
+    time: number;
     environment: EnvironmentContext;
   },
 ) => MaybePromise<void>;

website/docs/en/shared/onAfterEnvironmentCompile.mdx

@@ -11,6 +11,10 @@ function OnAfterEnvironmentCompile(
     isWatch: boolean;
     stats?: Stats;
     environment: EnvironmentContext;
+    /**
+     * The time it takes to build the current environment in milliseconds.
+     */
+    time: number;
   }) => Promise<void> | void,
 ): void;
 ```

website/docs/zh/shared/onAfterEnvironmentCompile.mdx

@@ -11,6 +11,10 @@ function OnAfterEnvironmentCompile(
     isWatch: boolean;
     stats?: Stats;
     environment: EnvironmentContext;
+    /**
+     * The time it takes to build the current environment in milliseconds.
+     */
+    time: number;
   }) => Promise<void> | void,
 ): void;
 ```