fix(core): serialize reporter output on CI (#1304)

Author: 9aoy

packages/browser/src/dispatchCapabilities.ts

@@ -18,9 +18,10 @@ type RunnerPayload<TType extends BrowserClientMessage['type']> =
     ? TPayload
     : never;
 
-type ReporterHookArg<THook extends keyof Reporter> = Parameters<
-  NonNullable<Reporter[THook]>
->[0];
+type ReporterHookArg<THook extends keyof Reporter> =
+  NonNullable<Reporter[THook]> extends (...args: infer TArgs) => unknown
+    ? TArgs[0]
+    : never;
 
 type RunnerDispatchFileReadyPayload = ReporterHookArg<'onTestFileReady'>;
 type RunnerDispatchSuiteStartPayload = ReporterHookArg<'onTestSuiteStart'>;

packages/browser/src/hostController.ts

@@ -184,9 +184,10 @@ type FatalPayload = {
   stack?: string;
 };
 
-type ReporterHookArg<THook extends keyof Reporter> = Parameters<
-  NonNullable<Reporter[THook]>
->[0];
+type ReporterHookArg<THook extends keyof Reporter> =
+  NonNullable<Reporter[THook]> extends (...args: infer TArgs) => unknown
+    ? TArgs[0]
+    : never;
 
 type TestFileReadyPayload = ReporterHookArg<'onTestFileReady'>;
 type TestSuiteStartPayload = ReporterHookArg<'onTestSuiteStart'>;

packages/core/src/core/mergeReports.ts

@@ -13,7 +13,7 @@ import type {
   TestResult,
 } from '../types';
 import type { CoverageMap } from '../types/coverage';
-import { color, logger, prettyTime } from '../utils';
+import { color, flushOutputStreams, logger, prettyTime } from '../utils';
 import type { Rstest } from './rstest';
 
 const DEFAULT_BLOB_DIR = '.rstest-reports';
@@ -223,6 +223,9 @@ export async function mergeReports(
         : undefined,
       getSourcemap: async () => null,
     });
+    if (reporter.flushOutputStreams !== false) {
+      await flushOutputStreams();
+    }
   }
 
   if (

packages/core/src/core/runTests.ts

@@ -17,6 +17,7 @@ import {
   getForceRerunTriggerMessage,
   getNoTestFilesMessage,
   isDebug,
+  flushOutputStreams,
   logger,
   resolveShardedEntries,
   type TraceEvent,
@@ -141,6 +142,9 @@ const notifyReportersOnTestRunEnd = async ({
       getSourcemap,
       filterRerunTestPaths,
     });
+    if (reporter.flushOutputStreams !== false) {
+      await flushOutputStreams();
+    }
   }
 };
 

packages/core/src/reporter/dot.ts

@@ -32,6 +32,8 @@ const COLOR_BY_STATUS: Record<
 };
 
 export class DotReporter implements Reporter {
+  readonly flushOutputStreams: boolean;
+
   private readonly rootPath: string;
   private readonly options: Pick<DefaultReporterOptions, 'logger' | 'summary'>;
   private readonly outputStream: NonNullable<
@@ -53,6 +55,7 @@ export class DotReporter implements Reporter {
   }) {
     this.rootPath = rootPath;
     this.options = options;
+    this.flushOutputStreams = !options.logger;
     this.outputStream = options.logger?.outputStream ?? process.stdout;
     this.getColumns =
       options.logger?.getColumns ??

packages/core/src/reporter/githubActions.ts

@@ -30,6 +30,8 @@ import {
 } from './utils';
 
 export class GithubActionsReporter {
+  readonly flushOutputStreams = true;
+
   private readonly onWritePath: (path: string) => string;
   private readonly rootPath: string;
   private readonly stepSummaryPath?: string;

packages/core/src/reporter/index.ts

@@ -19,6 +19,8 @@ import { printSummaryErrorLogs, printSummaryLog } from './summary';
 import { logCase, logFileTitle, logUserConsoleLog } from './utils';
 
 export class DefaultReporter implements Reporter {
+  readonly flushOutputStreams: boolean;
+
   protected rootPath: string;
   protected config: NormalizedConfig;
   protected projectConfigs: Map<string, NormalizedProjectConfig>;
@@ -45,6 +47,7 @@ export class DefaultReporter implements Reporter {
     this.projectConfigs = projectConfigs ?? new Map();
     this.options = options;
     this.testState = testState;
+    this.flushOutputStreams = !options.logger;
     if (isTTY() || options.logger) {
       this.statusRenderer = new StatusRenderer(
         rootPath,

packages/core/src/types/reporter.ts

@@ -190,6 +190,11 @@ export type ReporterWithOptions<
   : [Name, Record<string, unknown>];
 
 export interface Reporter {
+  /**
+   * Set to `false` when the reporter does not write to process stdout/stderr.
+   * @default true
+   */
+  flushOutputStreams?: boolean;
   /**
    * Called before test file run.
    */

packages/core/src/utils/logger.ts

@@ -118,6 +118,18 @@ export const clearScreen = (force = false): void => {
   }
 };
 
+const waitForStream = (stream: NodeJS.WritableStream): Promise<void> =>
+  new Promise((resolve) => {
+    stream.write('', () => {
+      resolve();
+    });
+  });
+
+export const flushOutputStreams = async (): Promise<void> => {
+  await waitForStream(process.stderr);
+  await waitForStream(process.stdout);
+};
+
 const logger: Logger & { stderr: (message: string, ...args: any[]) => void } = {
   ...rslog,
   stderr: (message: string, ...args: any[]) => {

packages/vscode/src/worker/reporter.ts

@@ -10,6 +10,8 @@ import type vscode from 'vscode';
 import { masterApi } from '.';
 
 export class ProgressReporter implements Reporter {
+  readonly flushOutputStreams = false;
+
   onTestRunStart = masterApi.onTestRunStart.asEvent;
   onTestRunEnd = () => masterApi.onTestRunEnd.asEvent();
   onTestFileStart = masterApi.onTestFileStart.asEvent;