perf(reporters): update summary only when needed (#7291)

AriPerkkio · web-flow · commit 7f36b6f9ebf4 · 2025-01-20T15:15:53.000+01:00
diff --git a/packages/vitest/src/node/reporters/dot.ts b/packages/vitest/src/node/reporters/dot.ts
@@ -66,11 +66,13 @@ export class DotReporter extends BaseReporter {
       return
     }
     this.tests.set(test.id, test.result().state || 'run')
+    this.renderer?.schedule()
   }
 
   onTestCaseResult(test: TestCase) {
     this.finishedTests.add(test.id)
     this.tests.set(test.id, test.result().state || 'skipped')
+    this.renderer?.schedule()
   }
 
   onTestModuleEnd() {
@@ -104,6 +106,7 @@ export class DotReporter extends BaseReporter {
     }
 
     this.ctx.logger.log(formatTests(states))
+    this.renderer?.schedule()
   }
 
   private createSummary() {
diff --git a/packages/vitest/src/node/reporters/renderers/windowedRenderer.ts b/packages/vitest/src/node/reporters/renderers/windowedRenderer.ts
@@ -2,7 +2,7 @@ import type { Writable } from 'node:stream'
 import type { Vitest } from '../../core'
 import { stripVTControlCharacters } from 'node:util'
 
-const DEFAULT_RENDER_INTERVAL = 16
+const DEFAULT_RENDER_INTERVAL_MS = 1_000
 
 const ESC = '\x1B['
 const CLEAR_LINE = `${ESC}K`
@@ -27,14 +27,15 @@ export class WindowRenderer {
   private streams!: Record<StreamType, Vitest['logger']['outputStream' | 'errorStream']['write']>
   private buffer: { type: StreamType; message: string }[] = []
   private renderInterval: NodeJS.Timeout | undefined = undefined
+  private renderScheduled = false
 
   private windowHeight = 0
   private finished = false
   private cleanups: (() => void)[] = []
 
   constructor(options: Options) {
     this.options = {
-      interval: DEFAULT_RENDER_INTERVAL,
+      interval: DEFAULT_RENDER_INTERVAL_MS,
       ...options,
     }
 
@@ -59,7 +60,7 @@ export class WindowRenderer {
 
   start() {
     this.finished = false
-    this.renderInterval = setInterval(() => this.flushBuffer(), this.options.interval).unref()
+    this.renderInterval = setInterval(() => this.schedule(), this.options.interval).unref()
   }
 
   stop() {
@@ -77,6 +78,20 @@ export class WindowRenderer {
     clearInterval(this.renderInterval)
   }
 
+  /**
+   * Queue new render update
+   */
+  schedule() {
+    if (!this.renderScheduled) {
+      this.renderScheduled = true
+      this.flushBuffer()
+
+      setTimeout(() => {
+        this.renderScheduled = false
+      }, 100).unref()
+    }
+  }
+
   private flushBuffer() {
     if (this.buffer.length === 0) {
       return this.render()
diff --git a/packages/vitest/src/node/reporters/summary.ts b/packages/vitest/src/node/reporters/summary.ts
@@ -109,6 +109,7 @@ export class SummaryReporter implements Reporter {
     }
 
     this.runningModules.set(module.id, initializeStats(module))
+    this.renderer.schedule()
   }
 
   onTestModuleCollected(module: TestModule) {
@@ -124,6 +125,7 @@ export class SummaryReporter implements Reporter {
     stats.total = total
 
     this.maxParallelTests = Math.max(this.maxParallelTests, this.runningModules.size)
+    this.renderer.schedule()
   }
 
   onHookStart(options: ReportedHookContext) {
@@ -213,6 +215,8 @@ export class SummaryReporter implements Reporter {
     else if (!result?.state || result?.state === 'skipped') {
       this.tests.skipped++
     }
+
+    this.renderer.schedule()
   }
 
   onTestModuleEnd(module: TestModule) {
@@ -247,6 +251,8 @@ export class SummaryReporter implements Reporter {
       // Remove finished test immediatelly.
       this.removeTestModule(module.id)
     }
+
+    this.renderer.schedule()
   }
 
   private getHookStats({ entity }: ReportedHookContext) {

Original file line number	Diff line number	Diff line change
`@@ -66,11 +66,13 @@ export class DotReporter extends BaseReporter {`
`66`	`66`	`return`
`67`	`67`	`}`
`68`	`68`	`this.tests.set(test.id, test.result().state \|\| 'run')`
	`69`	`+ this.renderer?.schedule()`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`onTestCaseResult(test: TestCase) {`
`72`	`73`	`this.finishedTests.add(test.id)`
`73`	`74`	`this.tests.set(test.id, test.result().state \|\| 'skipped')`
	`75`	`+ this.renderer?.schedule()`
`74`	`76`	`}`
`75`	`77`
`76`	`78`	`onTestModuleEnd() {`
`@@ -104,6 +106,7 @@ export class DotReporter extends BaseReporter {`
`104`	`106`	`}`
`105`	`107`
`106`	`108`	`this.ctx.logger.log(formatTests(states))`
	`109`	`+ this.renderer?.schedule()`
`107`	`110`	`}`
`108`	`111`
`109`	`112`	`private createSummary() {`
Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,7 @@ export class SummaryReporter implements Reporter {`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`this.runningModules.set(module.id, initializeStats(module))`
	`112`	`+ this.renderer.schedule()`
`112`	`113`	`}`
`113`	`114`
`114`	`115`	`onTestModuleCollected(module: TestModule) {`
`@@ -124,6 +125,7 @@ export class SummaryReporter implements Reporter {`
`124`	`125`	`stats.total = total`
`125`	`126`
`126`	`127`	`this.maxParallelTests = Math.max(this.maxParallelTests, this.runningModules.size)`
	`128`	`+ this.renderer.schedule()`
`127`	`129`	`}`
`128`	`130`
`129`	`131`	`onHookStart(options: ReportedHookContext) {`
`@@ -213,6 +215,8 @@ export class SummaryReporter implements Reporter {`
`213`	`215`	`else if (!result?.state \|\| result?.state === 'skipped') {`
`214`	`216`	`this.tests.skipped++`
`215`	`217`	`}`
	`218`	`+`
	`219`	`+ this.renderer.schedule()`
`216`	`220`	`}`
`217`	`221`
`218`	`222`	`onTestModuleEnd(module: TestModule) {`
`@@ -247,6 +251,8 @@ export class SummaryReporter implements Reporter {`
`247`	`251`	`// Remove finished test immediatelly.`
`248`	`252`	`this.removeTestModule(module.id)`
`249`	`253`	`}`
	`254`	`+`
	`255`	`+ this.renderer.schedule()`
`250`	`256`	`}`
`251`	`257`
`252`	`258`	`private getHookStats({ entity }: ReportedHookContext) {`