feat(vscode): report test run progress

Author: claneo

.vscode/settings.json

@@ -53,5 +53,10 @@
   "[less]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "rstest.configFileGlobPattern": [
+    "packages/core/rstest.config.ts",
+    "packages/vscode/rstest.config.ts",
+    "e2e/rstest.config.ts"
+  ]
 }

e2e/package.json

@@ -8,7 +8,7 @@
   },
   "devDependencies": {
     "@rsbuild/core": "1.6.0-beta.1",
-    "@rslib/core": "0.17.1",
+    "@rslib/core": "0.18.1",
     "@rstest/core": "workspace:*",
     "@rstest/tsconfig": "workspace:*",
     "@types/jest-image-snapshot": "^6.4.0",

e2e/reporter/index.test.ts

@@ -71,15 +71,28 @@ describe.concurrent('reporters', () => {
     });
 
     await cli.exec;
+
+    expect(cli.stdout).toContain('[custom reporter] onTestSuiteStart');
+    expect(
+      cli.stdout.match(/\[custom reporter\] onTestSuiteStart/g)?.length,
+    ).toBe(1);
+
+    expect(cli.stdout).toContain('[custom reporter] onTestSuiteResult');
+    expect(
+      cli.stdout.match(/\[custom reporter\] onTestSuiteResult/g)?.length,
+    ).toBe(1);
+
     expect(cli.stdout).toContain('[custom reporter] onTestCaseStart');
     expect(
       cli.stdout.match(/\[custom reporter\] onTestCaseStart/g)?.length,
     ).toBe(3);
+
     expect(cli.stdout).toContain('[custom reporter] onTestFileStart');
 
     expect(
       cli.stdout.match(/\[custom reporter\] onTestCaseResult/g)?.length,
     ).toBe(3);
+
     expect(cli.stdout).toContain('[custom reporter] onTestRunEnd');
   });
 

e2e/reporter/rstest.customReporterConfig.ts

@@ -4,6 +4,7 @@ import type {
   TestFileInfo,
   TestFileResult,
   TestResult,
+  TestSuiteInfo,
 } from '@rstest/core';
 import { defineConfig } from '@rstest/core';
 
@@ -14,6 +15,14 @@ class MyReporter implements Reporter {
     reporterResult.push('[custom reporter] onTestFileStart');
   }
 
+  onTestSuiteStart(_test: TestSuiteInfo) {
+    reporterResult.push('[custom reporter] onTestSuiteStart');
+  }
+
+  onTestSuiteResult(_result: TestResult) {
+    reporterResult.push('[custom reporter] onTestSuiteResult');
+  }
+
   onTestCaseStart(_test: TestCaseInfo) {
     reporterResult.push('[custom reporter] onTestCaseStart');
   }

e2e/rstest.config.ts

@@ -2,7 +2,7 @@ import { defineConfig } from '@rstest/core';
 
 export default defineConfig({
   setupFiles: ['../scripts/rstest.setup.ts'],
-  testTimeout: process.env.CI ? 10_000 : 5_000,
+  testTimeout: 10_000,
   slowTestThreshold: 2_000,
   output: {
     externals: {

packages/core/package.json

@@ -48,7 +48,7 @@
   "scripts": {
     "build": "rslib build && npx prettier ./LICENSE.md --write",
     "typecheck": "tsc --noEmit",
-    "dev": "rslib build --watch",
+    "dev": "cross-env SOURCEMAP=true rslib build --watch",
     "test": "npx rstest --globals"
   },
   "dependencies": {
@@ -65,7 +65,7 @@
     "@babel/code-frame": "^7.27.1",
     "@jridgewell/trace-mapping": "0.3.31",
     "@microsoft/api-extractor": "^7.53.3",
-    "@rslib/core": "0.17.1",
+    "@rslib/core": "0.18.1",
     "@rstest/tsconfig": "workspace:*",
     "@sinonjs/fake-timers": "^14.0.0",
     "@types/babel__code-frame": "^7.0.6",

packages/core/rslib.config.ts

@@ -14,23 +14,26 @@ export default defineConfig({
         advancedEsm: true,
       },
       dts: {
-        bundle: {
-          bundledPackages: [
-            '@types/sinonjs__fake-timers',
-            '@types/istanbul-reports',
-            '@types/istanbul-lib-report',
-            '@types/istanbul-lib-coverage',
-            '@jridgewell/trace-mapping',
-            '@vitest/expect',
-            '@vitest/snapshot',
-            '@vitest/utils',
-            '@vitest/spy',
-            'tinyrainbow',
-            '@vitest/pretty-format',
-          ],
-        },
+        bundle: process.env.SOURCEMAP
+          ? false
+          : {
+              bundledPackages: [
+                '@types/sinonjs__fake-timers',
+                '@types/istanbul-reports',
+                '@types/istanbul-lib-report',
+                '@types/istanbul-lib-coverage',
+                '@jridgewell/trace-mapping',
+                '@vitest/expect',
+                '@vitest/snapshot',
+                '@vitest/utils',
+                '@vitest/spy',
+                'tinyrainbow',
+                '@vitest/pretty-format',
+              ],
+            },
       },
       output: {
+        sourceMap: process.env.SOURCEMAP === 'true',
         externals: {
           // Temporary fix: `import * as timers from 'timers'` reassign error
           timers: 'commonjs timers',

packages/core/src/index.ts

@@ -84,4 +84,5 @@ export type {
   TestFileInfo,
   TestFileResult,
   TestResult,
+  TestSuiteInfo,
 } from './types';

packages/core/src/pool/index.ts

@@ -7,11 +7,13 @@ import type {
   ProjectContext,
   RstestContext,
   RuntimeConfig,
+  RuntimeRPC,
   Test,
   TestCaseInfo,
   TestFileInfo,
   TestFileResult,
   TestResult,
+  TestSuiteInfo,
   UserConsoleLog,
 } from '../types';
 import {
@@ -62,6 +64,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     logHeapUsage,
     bail,
     chaiConfig,
+    exact,
   } = context.normalizedConfig;
 
   return {
@@ -87,6 +90,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     logHeapUsage,
     bail,
     chaiConfig,
+    exact,
   };
 };
 
@@ -204,7 +208,7 @@ export const createPool = async ({
     },
   });
 
-  const rpcMethods = {
+  const rpcMethods: Omit<RuntimeRPC, 'getAssetsByEntry'> = {
     onTestCaseStart: async (test: TestCaseInfo) => {
       context.stateManager.onTestCaseStart(test);
       Promise.all(
@@ -231,6 +235,16 @@ export const createPool = async ({
         reporters.map((reporter) => reporter.onTestFileStart?.(test)),
       );
     },
+    onTestSuiteStart: async (test: TestSuiteInfo) => {
+      await Promise.all(
+        reporters.map((reporter) => reporter.onTestSuiteStart?.(test)),
+      );
+    },
+    onTestSuiteResult: async (result: TestResult) => {
+      await Promise.all(
+        reporters.map((reporter) => reporter.onTestSuiteResult?.(result)),
+      );
+    },
     resolveSnapshotPath: (testPath: string): string => {
       const snapExtension = '.snap';
       const resolver =

packages/core/src/reporter/index.ts

@@ -37,8 +37,12 @@ export class DefaultReporter implements Reporter {
     this.rootPath = rootPath;
     this.config = config;
     this.options = options;
-    if (isTTY()) {
-      this.statusRenderer = new StatusRenderer(rootPath, testState);
+    if (isTTY() || options.logger) {
+      this.statusRenderer = new StatusRenderer(
+        rootPath,
+        testState,
+        options.logger,
+      );
     }
   }