refactor(stats): improve stats error and warning handling (#6297)

Author: chenjiahan

packages/compat/webpack/src/createCompiler.ts

@@ -1,4 +1,4 @@
-import { logger, type Rspack } from '@rsbuild/core';
+import { logger, type RsbuildStats, type Rspack } from '@rsbuild/core';
 import WebpackMultiStats from 'webpack/lib/MultiStats.js';
 import { type InitConfigsOptions, initConfigs } from './initConfigs.js';
 
@@ -35,20 +35,21 @@ export async function createCompiler(options: InitConfigsOptions) {
     context.buildState.hasErrors = false;
   });
 
-  compiler.hooks.done.tap(HOOK_NAME, (stats) => {
-    const hasErrors = stats.hasErrors();
-    context.buildState.hasErrors = hasErrors;
-    context.buildState.status = 'done';
-
+  compiler.hooks.done.tap(HOOK_NAME, (statsInstance) => {
     const statsOptions = helpers.getStatsOptions(compiler);
-    const statsJson = stats.toJson({
+    const stats = statsInstance.toJson({
       moduleTrace: true,
       children: true,
-      preset: 'errors-warnings',
+      errors: true,
+      warnings: true,
       ...statsOptions,
-    });
+    }) as RsbuildStats;
+
+    const hasErrors = helpers.getStatsErrors(stats).length > 0;
+    context.buildState.hasErrors = hasErrors;
+    context.buildState.status = 'done';
 
-    const { message, level } = helpers.formatStats(statsJson, hasErrors);
+    const { message, level } = helpers.formatStats(stats, hasErrors);
 
     if (level === 'error') {
       logger.error(message);

packages/core/src/helpers/stats.ts

@@ -1,7 +1,6 @@
-import type { StatsCompilation } from '@rspack/core';
 import color from '../../compiled/picocolors/index.js';
 import { logger } from '../logger';
-import type { Rspack } from '../types';
+import type { RsbuildStats, Rspack } from '../types';
 import { isMultiCompiler } from './';
 import { formatStatsError } from './format';
 
@@ -19,19 +18,46 @@ function formatErrorMessage(errors: string[]) {
   return `${title}\n${text}`;
 }
 
-export const getAllStatsErrors = (
-  statsData: StatsCompilation,
-): Rspack.StatsError[] | undefined => {
-  // stats error + childCompiler error
-  // only append child errors when stats error does not exist, because some errors will exist in both stats and childCompiler
-  if (statsData.errorsCount && statsData.errors?.length === 0) {
-    return statsData.children?.reduce<Rspack.StatsError[]>(
-      (errors, curr) => errors.concat(curr.errors || []),
+/**
+ * If stats has errors, return stats errors directly
+ * If stats has no errors, return child errors, as some errors exist in both
+ * stats and childCompiler
+ */
+export const getStatsErrors = ({
+  errors,
+  children,
+}: RsbuildStats): Rspack.StatsError[] => {
+  if (errors !== undefined && errors.length > 0) {
+    return errors;
+  }
+
+  if (children) {
+    return children.reduce<Rspack.StatsError[]>(
+      (errors, ret) => (ret.errors ? errors.concat(ret.errors) : errors),
+      [],
+    );
+  }
+
+  return [];
+};
+
+export const getStatsWarnings = ({
+  warnings,
+  children,
+}: RsbuildStats): Rspack.StatsError[] => {
+  if (warnings !== undefined && warnings.length > 0) {
+    return warnings;
+  }
+
+  if (children) {
+    return children.reduce<Rspack.StatsError[]>(
+      (warnings, ret) =>
+        ret.warnings ? warnings.concat(ret.warnings) : warnings,
       [],
     );
   }
 
-  return statsData.errors;
+  return [];
 };
 
 export const getAssetsFromStats = (
@@ -51,19 +77,6 @@ export const getAssetsFromStats = (
   return statsJson.assets || [];
 };
 
-export const getAllStatsWarnings = (
-  statsData: StatsCompilation,
-): Rspack.StatsError[] | undefined => {
-  if (statsData.warningsCount && statsData.warnings?.length === 0) {
-    return statsData.children?.reduce<Rspack.StatsError[]>(
-      (warnings, curr) => warnings.concat(curr.warnings || []),
-      [],
-    );
-  }
-
-  return statsData.warnings;
-};
-
 export function getStatsOptions(
   compiler: Rspack.Compiler | Rspack.MultiCompiler,
 ): Rspack.StatsOptions {
@@ -88,7 +101,7 @@ export function getStatsOptions(
 }
 
 export function formatStats(
-  statsData: Rspack.StatsCompilation,
+  stats: RsbuildStats,
   hasErrors: boolean,
 ): {
   message?: string;
@@ -98,15 +111,15 @@ export function formatStats(
   const verbose = logger.level === 'verbose';
 
   if (hasErrors) {
-    const statsErrors = getAllStatsErrors(statsData) ?? [];
+    const statsErrors = getStatsErrors(stats);
     const errors = statsErrors.map((item) => formatStatsError(item, verbose));
     return {
       message: formatErrorMessage(errors),
       level: 'error',
     };
   }
 
-  const statsWarnings = getAllStatsWarnings(statsData) ?? [];
+  const statsWarnings = getStatsWarnings(stats);
   const warnings = statsWarnings.map((item) => formatStatsError(item, verbose));
 
   if (warnings.length) {

packages/core/src/index.ts

@@ -175,6 +175,7 @@ export type {
   RsbuildPlugins,
   RsbuildProvider,
   RsbuildProviderHelpers,
+  RsbuildStats,
   RsbuildTarget,
   RspackChain,
   RspackRule,

packages/core/src/provider/createCompiler.ts

@@ -1,8 +1,8 @@
 import { sep } from 'node:path';
-import type { StatsCompilation } from '@rspack/core';
 import {
   color,
   formatStats,
+  getStatsErrors,
   getStatsOptions,
   isSatisfyRspackVersion,
   prettyTime,
@@ -11,7 +11,12 @@ import {
 import { registerDevHook } from '../hooks';
 import { logger } from '../logger';
 import { rspack } from '../rspack';
-import type { InternalContext, Rspack } from '../types';
+import type {
+  InternalContext,
+  RsbuildStats,
+  RsbuildStatsItem,
+  Rspack,
+} from '../types';
 import { type InitConfigsOptions, initConfigs } from './initConfigs';
 
 // keep the last 3 parts of the path to make logs clean
@@ -184,24 +189,25 @@ export async function createCompiler(options: InitConfigsOptions): Promise<{
 
   compiler.hooks.done.tap(
     HOOK_NAME,
-    (stats: Rspack.Stats | Rspack.MultiStats) => {
-      const hasErrors = stats.hasErrors();
-      context.buildState.hasErrors = hasErrors;
-      context.buildState.status = 'done';
-
+    (statsInstance: Rspack.Stats | Rspack.MultiStats) => {
       const statsOptions = getStatsOptions(compiler);
-      const statsJson = stats.toJson({
+      const stats = statsInstance.toJson({
         children: true,
         moduleTrace: true,
         // get the compilation time
         timings: true,
-        preset: 'errors-warnings',
+        errors: true,
+        warnings: true,
         ...statsOptions,
-      });
+      }) as RsbuildStats;
+
+      const hasErrors = getStatsErrors(stats).length > 0;
+      context.buildState.status = 'done';
+      context.buildState.hasErrors = hasErrors;
 
-      const printTime = (c: StatsCompilation, index: number) => {
-        if (c.time) {
-          const time = prettyTime(c.time / 1000);
+      const printTime = (statsItem: RsbuildStatsItem, index: number) => {
+        if (statsItem.time) {
+          const time = prettyTime(statsItem.time / 1000);
           const { name } = rspackConfigs[index];
 
           // When using multi compiler, print name to distinguish different compilers
@@ -212,16 +218,16 @@ export async function createCompiler(options: InitConfigsOptions): Promise<{
 
       if (!hasErrors) {
         // only print children compiler time when multi compiler
-        if (isMultiCompiler && statsJson.children?.length) {
-          statsJson.children.forEach((c, index) => {
+        if (isMultiCompiler && stats.children?.length) {
+          stats.children.forEach((c, index) => {
             printTime(c, index);
           });
         } else {
-          printTime(statsJson, 0);
+          printTime(stats, 0);
         }
       }
 
-      const { message, level } = formatStats(statsJson, hasErrors);
+      const { message, level } = formatStats(stats, hasErrors);
 
       if (level === 'error') {
         logger.error(message);

packages/core/src/provider/helpers.ts

@@ -3,7 +3,12 @@
  */
 
 export { modifyBundlerChain } from '../configChain';
-export { formatStats, getStatsOptions, prettyTime } from '../helpers';
+export {
+  formatStats,
+  getStatsErrors,
+  getStatsOptions,
+  prettyTime,
+} from '../helpers';
 export { registerBuildHook, registerDevHook } from '../hooks';
 export { inspectConfig } from '../inspectConfig';
 export {

packages/core/src/server/socketServer.ts

@@ -1,14 +1,15 @@
 import type { IncomingMessage } from 'node:http';
 import type { Socket } from 'node:net';
 import type Ws from '../../compiled/ws/index.js';
-import {
-  getAllStatsErrors,
-  getAllStatsWarnings,
-  getStatsOptions,
-} from '../helpers';
+import { getStatsErrors, getStatsOptions, getStatsWarnings } from '../helpers';
 import { formatStatsError } from '../helpers/format';
 import { logger } from '../logger';
-import type { DevConfig, InternalContext, Rspack } from '../types';
+import type {
+  DevConfig,
+  InternalContext,
+  RsbuildStats,
+  Rspack,
+} from '../types';
 import { formatBrowserErrorLog } from './browserLogs';
 import { genOverlayHTML } from './overlay';
 
@@ -338,9 +339,7 @@ export class SocketServer {
       all: false,
       hash: true,
       warnings: true,
-      warningsCount: true,
       errors: true,
-      errorsCount: true,
       errorDetails: false,
       entrypoints: true,
       children: true,
@@ -412,15 +411,18 @@ export class SocketServer {
       return;
     }
 
+    const statsErrors = getStatsErrors(statsJson as RsbuildStats) ?? [];
+    const statsWarnings = getStatsWarnings(statsJson as RsbuildStats) ?? [];
+
     if (statsJson.hash) {
       const prevHash = this.currentHash.get(token);
       this.currentHash.set(token, statsJson.hash);
 
       // If build hash is not changed and there is no error or warning, skip emit
       const shouldEmit =
         !force &&
-        !statsJson.errorsCount &&
-        !statsJson.warningsCount &&
+        statsErrors.length === 0 &&
+        statsWarnings.length === 0 &&
         prevHash === statsJson.hash;
 
       if (shouldEmit) {
@@ -437,8 +439,7 @@ export class SocketServer {
       );
     }
 
-    if (statsJson.errorsCount) {
-      const statsErrors = getAllStatsErrors(statsJson) ?? [];
+    if (statsErrors.length > 0) {
       const formattedErrors = statsErrors.map((item) => formatStatsError(item));
 
       this.sockWrite(
@@ -454,8 +455,7 @@ export class SocketServer {
       return;
     }
 
-    if (statsJson.warningsCount) {
-      const statsWarnings = getAllStatsWarnings(statsJson) ?? [];
+    if (statsWarnings.length > 0) {
       const formattedWarnings = statsWarnings.map((item) =>
         formatStatsError(item),
       );

packages/core/src/types/rsbuild.ts

@@ -365,3 +365,15 @@ export type RsbuildEntry = Record<
 >;
 
 export type RsbuildMode = 'development' | 'production' | 'none';
+
+export type RsbuildStatsItem = Pick<
+  Rspack.StatsCompilation,
+  'errors' | 'warnings' | 'time'
+>;
+
+/**
+ * A subset of Rspack's StatsCompilation with only the fields we need
+ */
+export type RsbuildStats = RsbuildStatsItem & {
+  children: RsbuildStatsItem[];
+};