fix: run mode stuck in TTY terminals (#3690)

Author: AriPerkkio

packages/vitest/src/node/cli-api.ts

@@ -87,8 +87,9 @@ export async function startVitest(
     return ctx
   }
 
+  let stdinCleanup
   if (process.stdin.isTTY)
-    registerConsoleShortcuts(ctx)
+    stdinCleanup = registerConsoleShortcuts(ctx)
 
   ctx.onServerRestart((reason) => {
     ctx.report('onServerRestart', reason)
@@ -115,6 +116,7 @@ export async function startVitest(
   if (ctx.shouldKeepServer())
     return ctx
 
+  stdinCleanup?.()
   await ctx.close()
   return ctx
 }

packages/vitest/src/node/stdin.ts

@@ -140,4 +140,8 @@ export function registerConsoleShortcuts(ctx: Vitest) {
   }
 
   on()
+
+  return function cleanup() {
+    off()
+  }
 }

pnpm-lock.yaml

@@ -64,6 +64,7 @@ for (const threads of threadsConfig) {
           exit()
         }
         else if (process.exitCode) {
+          process.exitCode = null
           console.warn(`Browser tests failed, retrying ${1 + retry}/${retries.length - 1}...`)
         }
         else {

test/coverage-test/testing.mjs

@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest'
+
+import { getHelloWorld } from './example'
+
+test('getHello', async () => {
+  expect(getHelloWorld()).toBe('Hello world')
+})

test/run/fixtures/example.test.ts

@@ -0,0 +1,3 @@
+export function getHelloWorld() {
+  return 'Hello world'
+}

test/run/fixtures/example.ts

@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest'
+
+import { sum } from './math'
+
+test('sum', () => {
+  expect(sum(1, 2)).toBe(3)
+})

test/run/fixtures/math.test.ts

@@ -0,0 +1,3 @@
+export function sum(a: number, b: number) {
+  return a + b
+}

test/run/fixtures/math.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config'
+
+// Patch stdin on the process so that we can fake it to seem like a real interactive terminal and pass the TTY checks
+process.stdin.isTTY = true
+process.stdin.setRawMode = () => process.stdin
+
+export default defineConfig({
+  test: {
+    watch: false,
+    reporters: 'verbose',
+    teardownTimeout: 5_000,
+  },
+})

test/run/fixtures/vitest.config.ts

@@ -0,0 +1,11 @@
+{
+  "name": "@vitest/test-run",
+  "private": true,
+  "scripts": {
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "vite": "latest",
+    "vitest": "workspace:*"
+  }
+}

test/run/package.json

@@ -0,0 +1,15 @@
+import { expect, test } from 'vitest'
+import { runVitestCli } from '../../test-utils'
+
+test('run mode does not get stuck when TTY', async () => {
+  const vitest = await runVitestCli('--root', 'fixtures')
+  await vitest.isDone
+
+  expect(vitest.stdout).toContain('✓ example.test.ts')
+  expect(vitest.stdout).toContain('✓ math.test.ts')
+  expect(vitest.stdout).toContain('2 passed')
+
+  // Regression #3642
+  expect(vitest.stderr).not.toContain('close timed out')
+  expect(vitest.stderr).toBe('')
+})

test/run/test/tty.test.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    reporters: 'verbose',
+    include: ['test/**/*.test.*'],
+    chaiConfig: {
+      truncateThreshold: 0,
+    },
+    testTimeout: process.env.CI ? 30_000 : 10_000,
+  },
+})