Skip to content

Commit f79e7db

Browse files
authored
fix(reporters): summary to intercept logger's streams even when they are not process.std* streams (#10340)
1 parent c5e2e75 commit f79e7db

9 files changed

Lines changed: 309 additions & 8 deletions

File tree

‎packages/vitest/src/node/reporters/default.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ import { SummaryReporter } from './summary'
99

1010
export interface DefaultReporterOptions extends BaseOptions {
1111
summary?: boolean
12+
13+
/** @internal */
14+
summaryOptions?: SummaryReporter['options']
1215
}
1316

1417
export class DefaultReporter extends BaseReporter {
@@ -87,6 +90,6 @@ export class DefaultReporter extends BaseReporter {
8790

8891
onInit(ctx: Vitest): void {
8992
super.onInit(ctx)
90-
this.summary?.onInit(ctx, { verbose: this.verbose })
93+
this.summary?.onInit(ctx, { verbose: this.verbose, ...this.options.summaryOptions })
9194
}
9295
}

‎packages/vitest/src/node/reporters/renderers/windowedRenderer.ts‎

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ import type { Writable } from 'node:stream'
22
import type { Vitest } from '../../core'
33
import { stripVTControlCharacters } from 'node:util'
44

5+
/** Minimum time between two renders, no matter how many scheduled renderes were called */
6+
const DEFAULT_RENDER_THRESHOLD_MS = 100
7+
8+
/** Interval between automatic renders. If no test state changes happened, this will increase just duration field */
59
const DEFAULT_RENDER_INTERVAL_MS = 1_000
610

711
const ESC = '\x1B['
@@ -10,9 +14,10 @@ const MOVE_CURSOR_ONE_ROW_UP = `${ESC}1A`
1014
const SYNC_START = `${ESC}?2026h`
1115
const SYNC_END = `${ESC}?2026l`
1216

13-
interface Options {
17+
export interface Options {
1418
logger: Vitest['logger']
1519
interval?: number
20+
threshold?: number
1621
getWindow: () => string[]
1722
}
1823

@@ -36,10 +41,12 @@ export class WindowRenderer {
3641

3742
constructor(options: Options) {
3843
this.options = {
39-
interval: DEFAULT_RENDER_INTERVAL_MS,
4044
...options,
45+
threshold: options.threshold ?? DEFAULT_RENDER_THRESHOLD_MS,
46+
interval: options.interval ?? DEFAULT_RENDER_INTERVAL_MS,
4147
}
4248

49+
// Capture the original write methods early, before intercepting these
4350
this.streams = {
4451
output: options.logger.outputStream.write.bind(options.logger.outputStream),
4552
error: options.logger.errorStream.write.bind(options.logger.errorStream),
@@ -50,6 +57,14 @@ export class WindowRenderer {
5057
this.interceptStream(process.stderr, 'error'),
5158
)
5259

60+
// Intercept calls to custom VitestOptions.stdout and stderr streams
61+
if (options.logger.outputStream !== process.stdout) {
62+
this.cleanups.push(this.interceptStream(options.logger.outputStream, 'output'))
63+
}
64+
if (options.logger.errorStream !== process.stderr) {
65+
this.cleanups.push(this.interceptStream(options.logger.errorStream, 'error'))
66+
}
67+
5368
// Write buffered content on unexpected exits, e.g. direct `process.exit()` calls
5469
this.options.logger.onTerminalCleanup(() => {
5570
this.flushBuffer()
@@ -86,9 +101,14 @@ export class WindowRenderer {
86101
this.renderScheduled = true
87102
this.flushBuffer()
88103

89-
setTimeout(() => {
104+
if (this.options.threshold) {
105+
setTimeout(() => {
106+
this.renderScheduled = false
107+
}, this.options.threshold).unref()
108+
}
109+
else {
90110
this.renderScheduled = false
91-
}, 100).unref()
111+
}
92112
}
93113
}
94114

@@ -121,9 +141,12 @@ export class WindowRenderer {
121141
}
122142

123143
private render(message?: string, type: StreamType = 'output') {
144+
this.write(SYNC_START)
145+
124146
if (this.finished) {
125147
this.clearWindow()
126-
return this.write(message || '', type)
148+
this.write(message || '', type)
149+
return this.write(SYNC_END)
127150
}
128151

129152
const windowContent = this.options.getWindow()
@@ -134,7 +157,6 @@ export class WindowRenderer {
134157
padding -= getRenderedRowCount([message], this.options.logger.getColumns())
135158
}
136159

137-
this.write(SYNC_START)
138160
this.clearWindow()
139161

140162
if (message) {
@@ -165,7 +187,7 @@ export class WindowRenderer {
165187
this.windowHeight = 0
166188
}
167189

168-
private interceptStream(stream: NodeJS.WriteStream, type: StreamType) {
190+
private interceptStream(stream: NodeJS.WriteStream | Writable, type: StreamType) {
169191
const original = stream.write
170192

171193
// @ts-expect-error -- not sure how 2 overloads should be typed

‎packages/vitest/src/node/reporters/summary.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import type { Vitest } from '../core'
22
import type { TestSpecification } from '../test-specification'
33
import type { Reporter } from '../types/reporter'
4+
import type { Options as WindowRendererOptions } from './renderers/windowedRenderer'
45
import type { ReportedHookContext, TestCase, TestModule } from './reported-tasks'
56
import c from 'tinyrainbow'
67
import { F_POINTER, F_TREE_NODE_END, F_TREE_NODE_MIDDLE } from './renderers/figures'
@@ -12,6 +13,12 @@ const FINISHED_TEST_CLEANUP_TIME_MS = 1_000
1213

1314
interface Options {
1415
verbose?: boolean
16+
17+
/** @internal */
18+
interval?: WindowRendererOptions['interval']
19+
20+
/** @internal */
21+
threshold?: WindowRendererOptions['threshold']
1522
}
1623

1724
interface Counter {
@@ -76,6 +83,8 @@ export class SummaryReporter implements Reporter {
7683
this.renderer = new WindowRenderer({
7784
logger: ctx.logger,
7885
getWindow: () => this.createSummary(),
86+
interval: this.options.interval,
87+
threshold: this.options.threshold,
7988
})
8089

8190
this.ctx.onClose(() => {

‎pnpm-lock.yaml‎

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pnpm-workspace.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ catalog:
6868
'@vitejs/plugin-vue': ^6.0.4
6969
'@vueuse/core': ^14.2.1
7070
acorn-walk: ^8.3.5
71+
ansivision: ^0.2.7
7172
birpc: ^4.0.0
7273
cac: ^6.7.14
7374
chai: ^6.2.2
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { setTimeout } from 'node:timers/promises'
2+
import { describe, test } from 'vitest'
3+
4+
const TIMEOUT = 100;
5+
6+
// Test queue time
7+
await setTimeout(TIMEOUT);
8+
9+
describe("suite", () => {
10+
test("one",async () => {
11+
await setTimeout(TIMEOUT);
12+
})
13+
14+
test("two", async () => {
15+
await setTimeout(TIMEOUT);
16+
})
17+
18+
test("three", async () => {
19+
await setTimeout(TIMEOUT);
20+
})
21+
})
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { setTimeout } from 'node:timers/promises'
2+
import { describe, test } from 'vitest'
3+
4+
const TIMEOUT = 100;
5+
6+
// Test queue time
7+
await setTimeout(TIMEOUT);
8+
9+
describe("suite", () => {
10+
test("one",async () => {
11+
await setTimeout(TIMEOUT);
12+
})
13+
14+
test("two", async () => {
15+
await setTimeout(TIMEOUT);
16+
})
17+
18+
test("three", async () => {
19+
await setTimeout(TIMEOUT);
20+
})
21+
})

‎test/e2e/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"@vitest/mocker": "workspace:*",
2727
"@vitest/runner": "workspace:*",
2828
"@vitest/utils": "workspace:*",
29+
"ansivision": "catalog:",
2930
"flatted": "catalog:",
3031
"jest-image-snapshot": "^6.5.1",
3132
"obug": "^2.1.1",

0 commit comments

Comments
 (0)