feat: support logHeapUsage (#666)

Author: 9aoy

e2e/reporter/index.test.ts

@@ -93,4 +93,21 @@ describe.concurrent('reporters', () => {
     await cli.exec;
     expect(cli.stdout).not.toContain('✗ basic > b');
   });
+
+  it('logHeapUsage', async ({ onTestFinished }) => {
+    const { cli, expectLog } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', 'index', '--logHeapUsage'],
+      onTestFinished,
+      options: {
+        nodeOptions: {
+          cwd: __dirname,
+        },
+      },
+    });
+
+    await cli.exec;
+    expectLog(/fixtures\/index.test.ts.*\d+ MB heap used/);
+    expectLog(/✗ basic > b.*\d+ MB heap used/);
+  });
 });

packages/core/rslib.config.ts

@@ -1,5 +1,6 @@
 import { defineConfig, rspack } from '@rslib/core';
 import { licensePlugin } from './licensePlugin';
+import { version } from './package.json';
 
 const isBuildWatch = process.argv.includes('--watch');
 
@@ -75,7 +76,7 @@ export default defineConfig({
           worker: './src/runtime/worker/index.ts',
         },
         define: {
-          RSTEST_VERSION: JSON.stringify(require('./package.json').version),
+          RSTEST_VERSION: JSON.stringify(version),
         },
       },
       tools: {

packages/core/src/cli/commands.ts

@@ -48,6 +48,7 @@ const applyCommonOptions = (cli: CAC) => {
       'Print console traces when calling any console method',
     )
     .option('--disableConsoleIntercept', 'Disable console intercept')
+    .option('--logHeapUsage', 'Log heap usage after each test')
     .option(
       '--slowTestThreshold <value>',
       'The number of milliseconds after which a test or suite is considered slow',

packages/core/src/cli/init.ts

@@ -26,6 +26,7 @@ export type CommonOptions = {
   coverage?: boolean;
   passWithNoTests?: boolean;
   printConsoleTrace?: boolean;
+  logHeapUsage?: boolean;
   disableConsoleIntercept?: boolean;
   update?: boolean;
   testNamePattern?: RegExp | string;
@@ -76,6 +77,7 @@ async function resolveConfig(
     'disableConsoleIntercept',
     'testEnvironment',
     'hideSkippedTests',
+    'logHeapUsage',
   ];
   for (const key of keys) {
     if (options[key] !== undefined) {

packages/core/src/config.ts

@@ -147,6 +147,7 @@ const createDefaultConfig = (): NormalizedConfig => ({
   snapshotFormat: {},
   env: {},
   hideSkippedTests: false,
+  logHeapUsage: false,
   coverage: {
     exclude: [
       '**/node_modules/**',

packages/core/src/pool/index.ts

@@ -54,6 +54,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     coverage,
     snapshotFormat,
     env,
+    logHeapUsage,
   } = context.normalizedConfig;
 
   return {
@@ -76,6 +77,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     isolate,
     coverage,
     snapshotFormat,
+    logHeapUsage,
   };
 };
 

packages/core/src/reporter/utils.ts

@@ -51,7 +51,11 @@ export const logCase = (
   const retry = result.retryCount
     ? color.yellow(` (retry x${result.retryCount})`)
     : '';
-  logger.log(`  ${icon} ${nameStr}${color.gray(duration)}${retry}`);
+  const heap = result.heap
+    ? ` ${color.magenta(formatHeapUsed(result.heap))}`
+    : '';
+
+  logger.log(`  ${icon} ${nameStr}${color.gray(duration)}${retry}${heap}`);
 
   if (result.errors) {
     for (const error of result.errors) {
@@ -60,6 +64,10 @@ export const logCase = (
   }
 };
 
+const formatHeapUsed = (heap: number) => {
+  return `${Math.floor(heap / 1024 / 1024)} MB heap used`;
+};
+
 export const logFileTitle = (
   test: TestFileResult,
   relativePath: string,
@@ -77,5 +85,9 @@ export const logFileTitle = (
     title += ` ${formatDuration(test.duration!)}`;
   }
 
+  if (test.heap) {
+    title += ` ${color.magenta(formatHeapUsed(test.heap))}`;
+  }
+
   logger.log(title);
 };

packages/core/src/runtime/runner/runner.ts

@@ -349,6 +349,9 @@ export class TestRunner {
 
         result.duration = RealDate.now() - start;
         result.retryCount = retryCount - 1;
+        result.heap = state.runtimeConfig.logHeapUsage
+          ? process.memoryUsage().heapUsed
+          : undefined;
         hooks.onTestCaseResult?.(result);
         results.push(result);
       }
@@ -373,6 +376,9 @@ export class TestRunner {
         name: '',
         status: 'fail',
         results,
+        heap: state.runtimeConfig.logHeapUsage
+          ? process.memoryUsage().heapUsed
+          : undefined,
         errors: [
           {
             message: `No test suites found in file: ${testPath}`,
@@ -394,6 +400,9 @@ export class TestRunner {
       project,
       testPath,
       name: '',
+      heap: state.runtimeConfig.logHeapUsage
+        ? process.memoryUsage().heapUsed
+        : undefined,
       status: errors.length ? 'fail' : getTestStatus(results, defaultStatus),
       results,
       snapshotResult,

packages/core/src/types/config.ts

@@ -215,6 +215,12 @@ export interface RstestConfig {
    */
   maxConcurrency?: number;
 
+  /**
+   * Log heap usage after each test
+   * @default false
+   */
+  logHeapUsage?: boolean;
+
   /**
    * Custom handler for console log in tests
    */

packages/core/src/types/testSuite.ts

@@ -122,6 +122,7 @@ export type TestResult = {
   errors?: FormattedError[];
   retryCount?: number;
   project: string;
+  heap?: number;
 };
 
 export type TestFileResult = TestResult & {