fix(benchmark): print table on non TTY output

vitest-dev · Apr 4, 2024 · 48f762a · 48f762a
1 parent d400388
commit 48f762a
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 6 deletions.
diff --git a/packages/vitest/src/node/reporters/benchmark/table/index.ts b/packages/vitest/src/node/reporters/benchmark/table/index.ts
@@ -1,7 +1,10 @@
 import c from 'picocolors'
 import type { UserConsoleLog } from '../../../../types/general'
 import { BaseReporter } from '../../base'
-import { type TableRendererOptions, createTableRenderer } from './tableRender'
+import { getFullName } from '../../../../utils'
+import type { TaskResultPack } from '../../../../types'
+import { getStateSymbol } from '../../renderers/utils'
+import { type TableRendererOptions, createTableRenderer, renderTree } from './tableRender'
 
 export class TableReporter extends BaseReporter {
   renderer?: ReturnType<typeof createTableRenderer>
@@ -18,10 +21,11 @@ export class TableReporter extends BaseReporter {
   }
 
   onCollected() {
+    this.rendererOptions.logger = this.ctx.logger
+    this.rendererOptions.showHeap = this.ctx.config.logHeapUsage
+    this.rendererOptions.slowTestThreshold = this.ctx.config.slowTestThreshold
+    this.rendererOptions.recurse = this.isTTY
     if (this.isTTY) {
-      this.rendererOptions.logger = this.ctx.logger
-      this.rendererOptions.showHeap = this.ctx.config.logHeapUsage
-      this.rendererOptions.slowTestThreshold = this.ctx.config.slowTestThreshold
       const files = this.ctx.state.getFiles(this.watchFilters)
       if (!this.renderer)
         this.renderer = createTableRenderer(files, this.rendererOptions).start()
@@ -30,6 +34,22 @@ export class TableReporter extends BaseReporter {
     }
   }
 
+  onTaskUpdate(packs: TaskResultPack[]) {
+    if (this.isTTY)
+      return
+    for (const pack of packs) {
+      const task = this.ctx.state.idMap.get(pack[0])
+      if (task && task.type === 'suite' && task.result?.state && task.result?.state !== 'run') {
+        // render static table when all benches inside single suite are finished
+        const benches = task.tasks.filter(t => t.meta.benchmark)
+        if (benches.length > 0 && benches.every(t => t.result?.state !== 'run')) {
+          this.ctx.logger.log(` ${getStateSymbol(task)} ${getFullName(task, c.dim(' > '))}`)
+          this.ctx.logger.log(renderTree(benches, this.rendererOptions, 1))
+        }
+      }
+    }
+  }
+
   async onFinished(files = this.ctx.state.getFiles(), errors = this.ctx.state.getUnhandledErrors()) {
     await this.stopListRender()
     this.ctx.logger.log()

diff --git a/packages/vitest/src/node/reporters/benchmark/table/tableRender.ts b/packages/vitest/src/node/reporters/benchmark/table/tableRender.ts
@@ -12,6 +12,7 @@ export interface TableRendererOptions {
   logger: Logger
   showHeap: boolean
   slowTestThreshold: number
+  recurse: boolean
 }
 
 const outputMap = new WeakMap<Task, string>()
@@ -100,7 +101,7 @@ function renderBenchmark(task: Benchmark, tasks: Task[]): string {
   ].join('  ')
 }
 
-function renderTree(tasks: Task[], options: TableRendererOptions, level = 0): string {
+export function renderTree(tasks: Task[], options: TableRendererOptions, level = 0): string {
   const output: string[] = []
 
   let idx = 0
@@ -151,7 +152,7 @@ function renderTree(tasks: Task[], options: TableRendererOptions, level = 0): st
       }
     }
 
-    if (task.type === 'suite' && task.tasks.length > 0) {
+    if (options.recurse && task.type === 'suite' && task.tasks.length > 0) {
       if (task.result?.state)
         output.push(renderTree(task.tasks, options, level + 1))
     }