From 6bd758f249fbcac23a7519e59cb446df360488da Mon Sep 17 00:00:00 2001
From: Shiba <128208841+HinataKah0@users.noreply.github.com>
Date: Tue, 23 May 2023 12:44:48 +0800
Subject: [PATCH] test_runner: delegate stderr and stdout formatting to
 reporter

Introduce new `TestsStream` events `test:stderr` and `test:stdout`
to delegate `stderr` and `stdout` (e.g. `console.log()`) formatting
to the reporter. And patch existing reporters to:
- Spec: output the message as it is
- TAP: stay the same with existing `test:diagnostic`

PR-URL: https://github.com/nodejs/node/pull/48045
Fixes: https://github.com/nodejs/node/issues/48011
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
---
 doc/api/test.md                           | 18 ++++++++++++++++++
 lib/internal/test_runner/reporter/spec.js |  3 +++
 lib/internal/test_runner/reporter/tap.js  |  2 ++
 lib/internal/test_runner/runner.js        | 13 ++++++-------
 lib/internal/test_runner/tests_stream.js  |  8 ++++++++
 5 files changed, 37 insertions(+), 7 deletions(-)

diff --git a/doc/api/test.md b/doc/api/test.md
index dd9cbfb03e0062..748c5117d5cc83 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1454,6 +1454,24 @@ Emitted when all subtests have completed for a given test.
 
 Emitted when a test starts.
 
+### Event: `'test:stderr'`
+
+* `data` {Object}
+  * `file` {string} The path of the test file.
+  * `message` {string} The message written to `stderr`.
+
+Emitted when a running test writes to `stderr`.
+This event is only emitted if `--test` flag is passed.
+
+### Event: `'test:stdout'`
+
+* `data` {Object}
+  * `file` {string} The path of the test file.
+  * `message` {string} The message written to `stdout`.
+
+Emitted when a running test writes to `stdout`.
+This event is only emitted if `--test` flag is passed.
+
 ## Class: `TestContext`
 
 <!-- YAML
diff --git a/lib/internal/test_runner/reporter/spec.js b/lib/internal/test_runner/reporter/spec.js
index 848b5cfa245d1e..8b7674571c5b95 100644
--- a/lib/internal/test_runner/reporter/spec.js
+++ b/lib/internal/test_runner/reporter/spec.js
@@ -117,6 +117,9 @@ class SpecReporter extends Transform {
       case 'test:start':
         ArrayPrototypeUnshift(this.#stack, { __proto__: null, data, type });
         break;
+      case 'test:stderr':
+      case 'test:stdout':
+        return `${data.message}\n`;
       case 'test:diagnostic':
         return `${colors[type]}${this.#indent(data.nesting)}${symbols[type]}${data.message}${white}\n`;
       case 'test:coverage':
diff --git a/lib/internal/test_runner/reporter/tap.js b/lib/internal/test_runner/reporter/tap.js
index 01c7436c6a6b67..80289ef225788f 100644
--- a/lib/internal/test_runner/reporter/tap.js
+++ b/lib/internal/test_runner/reporter/tap.js
@@ -45,6 +45,8 @@ async function * tapReporter(source) {
       case 'test:start':
         yield `${indent(data.nesting)}# Subtest: ${tapEscape(data.name)}\n`;
         break;
+      case 'test:stderr':
+      case 'test:stdout':
       case 'test:diagnostic':
         yield `${indent(data.nesting)}# ${tapEscape(data.message)}\n`;
         break;
diff --git a/lib/internal/test_runner/runner.js b/lib/internal/test_runner/runner.js
index adb9ee2a4f3b0c..03bb0e2629728b 100644
--- a/lib/internal/test_runner/runner.js
+++ b/lib/internal/test_runner/runner.js
@@ -284,8 +284,8 @@ class FileTest extends Test {
         const message = messages[i];
         this.addToReport({
           __proto__: null,
-          type: 'test:diagnostic',
-          data: { __proto__: null, nesting: 0, file: this.name, message },
+          type: 'test:stdout',
+          data: { __proto__: null, file: this.name, message },
         });
       }
     }
@@ -356,13 +356,12 @@ function runTestFile(path, root, inspectPort, filesWatcher, testNamePatterns) {
       }
 
       // stderr cannot be treated as TAP, per the spec. However, we want to
-      // surface stderr lines as TAP diagnostics to improve the DX. Inject
-      // each line into the test output as an unknown token as if it came
-      // from the TAP parser.
+      // surface stderr lines to improve the DX. Inject each line into the
+      // test output as an unknown token as if it came from the TAP parser.
       subtest.addToReport({
         __proto__: null,
-        type: 'test:diagnostic',
-        data: { __proto__: null, nesting: 0, file: path, message: line },
+        type: 'test:stderr',
+        data: { __proto__: null, file: path, message: line },
       });
     });
 
diff --git a/lib/internal/test_runner/tests_stream.js b/lib/internal/test_runner/tests_stream.js
index 7640e6742c19ce..89fff7f28e586c 100644
--- a/lib/internal/test_runner/tests_stream.js
+++ b/lib/internal/test_runner/tests_stream.js
@@ -57,6 +57,14 @@ class TestsStream extends Readable {
     this[kEmitMessage]('test:diagnostic', { __proto__: null, nesting, file, message });
   }
 
+  stderr(file, message) {
+    this[kEmitMessage]('test:stderr', { __proto__: null, file, message });
+  }
+
+  stdout(file, message) {
+    this[kEmitMessage]('test:stdout', { __proto__: null, file, message });
+  }
+
   coverage(nesting, file, summary) {
     this[kEmitMessage]('test:coverage', { __proto__: null, nesting, file, summary });
   }