FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

test_runner: add context.log() and test:log event · nodejs/node@d31c168 · GitHub

/ node Public

Commit d31c168

Browse files
MoLow
authored and
aduh95
committed
test_runner: add context.log() and test:log event
Add a log(message[, data]) method to TestContext and SuiteContext that emits a new test:log event. Unlike test:diagnostic, which is buffered so it is emitted in the order tests are defined, test:log is emitted immediately, in the order tests execute, including under process isolation where it bypasses the per-file declaration order buffer. This gives reporters that render the test tree unbuffered a live, attributed logging channel that captured stdout cannot provide under concurrency. The event carries the message, an optional opaque structured payload that the runner passes through untouched, and the emitting test's name, testId, parentId, nesting, and location. Built-in reporters render it the same way they render test:diagnostic. Signed-off-by: Moses Atlow <moshe@atlow.co.il> PR-URL: #64389 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
1 parent bb24a88 commit d31c168

12 files changed

Lines changed: 233 additions & 5 deletions

File tree

‎doc/api/test.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3468,6 +3468,10 @@ ordered events, emitted immediately as the tests execute.
34683468
| [`'test:fail'`][] | [`'test:complete'`][] (`details.passed` is `false`) |
34693469
| [`'test:plan'`][] | |
34703470
| [`'test:diagnostic'`][] | |
3471+
| | [`'test:log'`][] |
3472+
3473+
[`'test:log'`][] is deliberately execution ordered only: it is the live
3474+
counterpart of [`'test:diagnostic'`][]'s buffered reporting.
34713475

34723476
File scoped and global events are always emitted immediately, in execution
34733477
order.
@@ -3735,6 +3739,38 @@ When using process isolation (the default), the test name will be the file path
37353739
since the parent runner only knows about file-level tests. When using
37363740
`--test-isolation=none`, the actual test name is shown.
37373741

3742+
### Event: `'test:log'`
3743+
3744+
<!-- YAML
3745+
added: REPLACEME
3746+
-->
3747+
3748+
* `data` {Object}
3749+
* `column` {number|undefined} The column number where the test is defined, or
3750+
`undefined` if the test was run through the REPL.
3751+
* `data` {any} The structured payload passed to [`context.log`][], or
3752+
`undefined` if none was provided. The test runner does not interpret this
3753+
value.
3754+
* `entryFile` {string|undefined} The path of the test file that was
3755+
executed as the entry point of the child process that emitted this event.
3756+
Only present when tests run with process isolation. May differ from
3757+
`file` when the test is defined in a module imported by the entry file.
3758+
* `file` {string|undefined} The path of the test file,
3759+
`undefined` if test was run through the REPL.
3760+
* `line` {number|undefined} The line number where the test is defined, or
3761+
`undefined` if the test was run through the REPL.
3762+
* `message` {string} The log message.
3763+
* `name` {string} The test name.
3764+
* `nesting` {number} The nesting level of the test.
3765+
* `parentId` {number|undefined} The `testId` of the enclosing test, or
3766+
`undefined` for top-level tests.
3767+
* `testId` {number} A numeric identifier for the test instance that emitted
3768+
the log message.
3769+
3770+
Emitted when [`context.log`][] is called. Unlike [`'test:diagnostic'`][],
3771+
this event is emitted immediately, in the order that the tests execute,
3772+
making it suitable for reporters that render test output unbuffered.
3773+
37383774
### Event: `'test:pass'`
37393775

37403776
* `data` {Object}
@@ -4258,6 +4294,29 @@ test('top level test', (t) => {
42584294
});
42594295
```
42604296

4297+
### `context.log(message[, data])`
4298+
4299+
<!-- YAML
4300+
added: REPLACEME
4301+
-->
4302+
4303+
* `message` {string} Message to be reported.
4304+
* `data` {any} Optional structured payload attached to the message. The test
4305+
runner passes it through untouched. When tests run with process isolation,
4306+
this value must be compatible with the [HTML structured clone algorithm][].
4307+
4308+
This function is used to write a log message to the output. Unlike
4309+
[`context.diagnostic`][], the resulting [`'test:log'`][] event is emitted
4310+
immediately, in the order that the tests execute, rather than being buffered
4311+
until the test reports its results. This function does not return a value.
4312+
4313+
```js
4314+
test('top level test', (t) => {
4315+
t.log('fetched user', { userId: 42 });
4316+
t.log('retrying flaky endpoint', { attempt: 3 });
4317+
});
4318+
```
4319+
42614320
### `context.filePath`
42624321

42634322
<!-- YAML
@@ -4739,6 +4798,26 @@ test.describe('my suite', (suite) => {
47394798
});
47404799
```
47414800

4801+
### `context.log(message[, data])`
4802+
4803+
<!-- YAML
4804+
added: REPLACEME
4805+
-->
4806+
4807+
* `message` {string} Message to be reported.
4808+
* `data` {any} Optional structured payload attached to the message. The test
4809+
runner passes it through untouched.
4810+
4811+
Write a log message to the output. The resulting [`'test:log'`][] event is
4812+
emitted immediately, in the order that the tests execute.
4813+
4814+
```js
4815+
test.describe('my suite', (suite) => {
4816+
suite.log('Suite log message');
4817+
});
4818+
```
4819+
4820+
[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
47424821
[TAP]: https://testanything.org/
47434822
[Test tags]: #test-tags
47444823
[`'test:complete'`]: #event-testcomplete
@@ -4748,6 +4827,7 @@ test.describe('my suite', (suite) => {
47484827
[`'test:enqueue'`]: #event-testenqueue
47494828
[`'test:fail'`]: #event-testfail
47504829
[`'test:interrupted'`]: #event-testinterrupted
4830+
[`'test:log'`]: #event-testlog
47514831
[`'test:pass'`]: #event-testpass
47524832
[`'test:plan'`]: #event-testplan
47534833
[`'test:start'`]: #event-teststart
@@ -4783,6 +4863,7 @@ test.describe('my suite', (suite) => {
47834863
[`TracingChannel`]: diagnostics_channel.md#class-tracingchannel
47844864
[`assert.throws`]: assert.md#assertthrowsfn-error-message
47854865
[`context.diagnostic`]: #contextdiagnosticmessage
4866+
[`context.log`]: #contextlogmessage-data
47864867
[`context.skip`]: #contextskipmessage
47874868
[`context.tags`]: #contexttags
47884869
[`context.todo`]: #contexttodomessage

‎lib/internal/test_runner/reporter/junit.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ module.exports = async function* junitReporter(source) {
154154
}
155155
break;
156156
}
157-
case 'test:diagnostic': {
157+
case 'test:diagnostic':
158+
case 'test:log': {
158159
const parent = currentSuite?.children ?? roots;
159160
ArrayPrototypePush(parent, {
160161
__proto__: null, nesting: event.data.nesting, comment: event.data.message,

‎lib/internal/test_runner/reporter/spec.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ class SpecReporter extends Transform {
9191
case 'test:stderr':
9292
case 'test:stdout':
9393
return data.message;
94-
case 'test:diagnostic':{
95-
const diagnosticColor = reporterColorMap[data.level] || reporterColorMap['test:diagnostic'];
94+
case 'test:diagnostic':
95+
case 'test:log': {
96+
const diagnosticColor = reporterColorMap[data.level] || reporterColorMap[type];
9697
return `${diagnosticColor}${indent(data.nesting)}${reporterUnicodeSymbolMap[type]}${data.message}${colors.white}\n`;
9798
}
9899
case 'test:coverage':

‎lib/internal/test_runner/reporter/tap.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ async function * tapReporter(source) {
5656
}
5757
break;
5858
} case 'test:diagnostic':
59+
case 'test:log':
5960
yield `${indent(data.nesting)}# ${tapEscape(data.message)}\n`;
6061
break;
6162
case 'test:coverage':

‎lib/internal/test_runner/reporter/utils.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ const reporterUnicodeSymbolMap = {
2121
'test:fail': '\u2716 ',
2222
'test:pass': '\u2714 ',
2323
'test:diagnostic': '\u2139 ',
24+
'test:log': '\u2139 ',
2425
'test:coverage': '\u2139 ',
2526
'arrow:right': '\u25B6 ',
2627
'hyphen:minus': '\uFE63 ',
@@ -38,6 +39,9 @@ const reporterColorMap = {
3839
get 'test:diagnostic'() {
3940
return colors.blue;
4041
},
42+
get 'test:log'() {
43+
return colors.blue;
44+
},
4145
get 'info'() {
4246
return colors.blue;
4347
},

‎lib/internal/test_runner/runner.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ const kCanceledTests = new SafeSet()
130130
// Execution-ordered events are forwarded immediately, bypassing the
131131
// per-file declaration-order buffer.
132132
const kExecutionOrderedEvents = new SafeSet()
133-
.add('test:enqueue').add('test:dequeue').add('test:complete');
133+
.add('test:enqueue').add('test:dequeue').add('test:complete').add('test:log');
134134

135135
let kResistStopPropagation;
136136

‎lib/internal/test_runner/test.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ const {
8080
validateNumber,
8181
validateObject,
8282
validateOneOf,
83+
validateString,
8384
validateUint32,
8485
} = require('internal/validators');
8586
const {
@@ -315,6 +316,10 @@ class TestContext {
315316
this.#test.diagnostic(message);
316317
}
317318

319+
log(message, data) {
320+
this.#test.log(message, data);
321+
}
322+
318323
plan(count, options = kEmptyObject) {
319324
if (this.#test.plan !== null) {
320325
throw new ERR_TEST_FAILURE(
@@ -523,6 +528,10 @@ class SuiteContext {
523528
diagnostic(message) {
524529
this.#suite.diagnostic(message);
525530
}
531+
532+
log(message, data) {
533+
this.#suite.log(message, data);
534+
}
526535
}
527536

528537
function parseExpectFailure(expectFailure) {
@@ -1198,6 +1207,12 @@ class Test extends AsyncResource {
11981207
ArrayPrototypePush(this.diagnostics, message);
11991208
}
12001209

1210+
log(message, data) {
1211+
validateString(message, 'message');
1212+
this.reporter.log(this.nesting, this.loc, message, data,
1213+
this.name, this.testId, this.parent?.testId);
1214+
}
1215+
12011216
start() {
12021217
this.applyFilters();
12031218

‎lib/internal/test_runner/tests_stream.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,19 @@ class TestsStream extends Readable {
139139
});
140140
}
141141

142+
log(nesting, loc, message, data, name, testId, parentId) {
143+
this[kEmitMessage]('test:log', {
144+
__proto__: null,
145+
name,
146+
nesting,
147+
testId,
148+
parentId,
149+
message,
150+
data,
151+
...loc,
152+
});
153+
}
154+
142155
diagnostic(nesting, loc, message, level = 'info') {
143156
this[kEmitMessage]('test:diagnostic', {
144157
__proto__: null,

‎test/fixtures/test-runner/execution-ordered-bypass/fast-fail.mjs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { test } from 'node:test';
22
import assert from 'node:assert';
33

4-
test('fast-fail', () => {
4+
test('fast-fail', (t) => {
5+
t.log('live');
56
assert.fail('fast');
67
});

‎test/fixtures/test-runner/log-events/basic.mjs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { suite, test } from 'node:test';
2+
import { setTimeout } from 'node:timers/promises';
3+
4+
suite('my suite', (s) => {
5+
s.log('suite message');
6+
test('in suite', () => {});
7+
});
8+
9+
test('parent', { concurrency: 2 }, async (t) => {
10+
await Promise.all([
11+
t.test('slow', async () => {
12+
await setTimeout(200);
13+
}),
14+
t.test('logger', (t) => {
15+
t.log('hello', { foo: 1 });
16+
t.log('warned', { level: 'warn', attempt: 2 });
17+
}),
18+
]);
19+
});

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL