fix(reporters): write buffered stdout/stderr on process exit (#6932)

AriPerkkio · web-flow · commit 80cde2a090bb · 2024-11-26T07:55:25.000+02:00
diff --git a/packages/vitest/LICENSE.md b/packages/vitest/LICENSE.md
@@ -1245,30 +1245,6 @@ Repository: git://github.com/feross/run-parallel.git
 
 ---------------------------------------
 
-## signal-exit
-License: ISC
-By: Ben Coe
-Repository: https://github.com/tapjs/signal-exit.git
-
-> The ISC License
->
-> Copyright (c) 2015, Contributors
->
-> Permission to use, copy, modify, and/or distribute this software
-> for any purpose with or without fee is hereby granted, provided
-> that the above copyright notice and this permission notice
-> appear in all copies.
->
-> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
-> OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE
-> LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
-> OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
-> WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
-> ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
----------------------------------------
-
 ## sisteransi
 License: MIT
 By: Terkel Gjervig
diff --git a/packages/vitest/package.json b/packages/vitest/package.json
@@ -162,7 +162,6 @@
     "expect-type": "^1.1.0",
     "magic-string": "^0.30.12",
     "pathe": "^1.1.2",
-    "restore-cursor": "^5.1.0",
     "std-env": "^3.8.0",
     "tinybench": "^2.9.0",
     "tinyexec": "^0.3.1",
diff --git a/packages/vitest/src/node/reporters/base.ts b/packages/vitest/src/node/reporters/base.ts
@@ -140,7 +140,7 @@ export abstract class BaseReporter implements Reporter {
       }
 
       else if (this.renderSucceed || anyFailed) {
-        this.log(`   ${c.green(c.dim(F_CHECK))} ${getTestName(test, c.dim(' > '))}`)
+        this.log(`   ${c.dim(getStateSymbol(test))} ${getTestName(test, c.dim(' > '))}`)
       }
     }
   }
diff --git a/packages/vitest/src/node/reporters/renderers/windowedRenderer.ts b/packages/vitest/src/node/reporters/renderers/windowedRenderer.ts
@@ -1,7 +1,6 @@
 import type { Writable } from 'node:stream'
 import type { Vitest } from '../../core'
 import { stripVTControlCharacters } from 'node:util'
-import restoreCursor from 'restore-cursor'
 
 const DEFAULT_RENDER_INTERVAL = 16
 
@@ -49,9 +48,9 @@ export class WindowRenderer {
     this.cleanups.push(
       this.interceptStream(process.stdout, 'output'),
       this.interceptStream(process.stderr, 'error'),
+      this.addProcessExitListeners(),
     )
 
-    restoreCursor()
     this.write(HIDE_CURSOR, 'output')
 
     this.start()
@@ -175,6 +174,32 @@ export class WindowRenderer {
   private write(message: string, type: 'output' | 'error' = 'output') {
     (this.streams[type] as Writable['write'])(message)
   }
+
+  private addProcessExitListeners() {
+    const onExit = (signal?: string | number, exitCode?: number) => {
+      // Write buffered content on unexpected exits, e.g. direct `process.exit()` calls
+      this.flushBuffer()
+      this.stop()
+
+      // Interrupted signals don't set exit code automatically.
+      // Use same exit code as node: https://nodejs.org/api/process.html#signal-events
+      if (process.exitCode === undefined) {
+        process.exitCode = exitCode !== undefined ? (128 + exitCode) : Number(signal)
+      }
+
+      process.exit()
+    }
+
+    process.once('SIGINT', onExit)
+    process.once('SIGTERM', onExit)
+    process.once('exit', onExit)
+
+    return function cleanup() {
+      process.off('SIGINT', onExit)
+      process.off('SIGTERM', onExit)
+      process.off('exit', onExit)
+    }
+  }
 }
 
 /** Calculate the actual row count needed to render `rows` into `stream` */
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ export abstract class BaseReporter implements Reporter {`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`else if (this.renderSucceed \|\| anyFailed) {`
`143`		- this.log(` ${c.green(c.dim(F_CHECK))} ${getTestName(test, c.dim(' > '))}`)
	`143`	+ this.log(` ${c.dim(getStateSymbol(test))} ${getTestName(test, c.dim(' > '))}`)
`144`	`144`	`}`
`145`	`145`	`}`
`146`	`146`	`}`