fix(vitest): close inspector immediately if run is canceled (#5519)

vitest-dev · Apr 11, 2024 · b80062d · b80062d
1 parent fc26f56
commit b80062d
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/packages/vitest/src/runtime/inspector.ts b/packages/vitest/src/runtime/inspector.ts
@@ -1,6 +1,6 @@
 import { createRequire } from 'node:module'
 
-import type { ContextRPC } from '../types'
+import type { ContextRPC, ResolvedConfig } from '../types'
 
 const __require = createRequire(import.meta.url)
 let inspector: typeof import('node:inspector')
@@ -44,11 +44,7 @@ export function setupInspect(ctx: ContextRPC) {
     }
   }
 
-  // In watch mode the inspector can persist re-runs if isolation is disabled and a single worker is used
-  const isIsolatedSingleThread = config.pool === 'threads' && config.poolOptions?.threads?.isolate === false && config.poolOptions?.threads?.singleThread
-  const isIsolatedSingleFork = config.pool === 'forks' && config.poolOptions?.forks?.isolate === false && config.poolOptions?.forks?.singleFork
-
-  const keepOpen = config.watch && (isIsolatedSingleFork || isIsolatedSingleThread)
+  const keepOpen = shouldKeepOpen(config)
 
   return function cleanup() {
     if (isEnabled && !keepOpen && inspector) {
@@ -57,3 +53,20 @@ export function setupInspect(ctx: ContextRPC) {
     }
   }
 }
+
+export function closeInspector(config: ResolvedConfig) {
+  const keepOpen = shouldKeepOpen(config)
+
+  if (inspector && !keepOpen) {
+    inspector.close()
+    session?.disconnect()
+  }
+}
+
+function shouldKeepOpen(config: ResolvedConfig) {
+  // In watch mode the inspector can persist re-runs if isolation is disabled and a single worker is used
+  const isIsolatedSingleThread = config.pool === 'threads' && config.poolOptions?.threads?.isolate === false && config.poolOptions?.threads?.singleThread
+  const isIsolatedSingleFork = config.pool === 'forks' && config.poolOptions?.forks?.isolate === false && config.poolOptions?.forks?.singleFork
+
+  return config.watch && (isIsolatedSingleFork || isIsolatedSingleThread)
+}
diff --git a/packages/vitest/src/runtime/runBaseTests.ts b/packages/vitest/src/runtime/runBaseTests.ts
@@ -8,6 +8,7 @@ import { setupChaiConfig } from '../integrations/chai/config'
 import { setupGlobalEnv, withEnv } from './setup-node'
 import type { VitestExecutor } from './execute'
 import { resolveTestRunner } from './runners'
+import { closeInspector } from './inspector'
 
 // browser shouldn't call this!
 export async function run(files: string[], config: ResolvedConfig, environment: ResolvedTestEnvironment, executor: VitestExecutor): Promise<void> {
@@ -21,7 +22,10 @@ export async function run(files: string[], config: ResolvedConfig, environment:
 
   const runner = await resolveTestRunner(config, executor)
 
-  workerState.onCancel.then(reason => runner.onCancel?.(reason))
+  workerState.onCancel.then((reason) => {
+    closeInspector(config)
+    runner.onCancel?.(reason)
+  })
 
   workerState.durations.prepare = performance.now() - workerState.durations.prepare
   workerState.durations.environment = performance.now()

diff --git a/packages/vitest/src/runtime/runVmTests.ts b/packages/vitest/src/runtime/runVmTests.ts
@@ -15,6 +15,7 @@ import * as VitestIndex from '../index'
 import type { VitestExecutor } from './execute'
 import { resolveTestRunner } from './runners'
 import { setupCommonEnv } from './setup-common'
+import { closeInspector } from './inspector'
 
 export async function run(files: string[], config: ResolvedConfig, executor: VitestExecutor): Promise<void> {
   const workerState = getWorkerState()
@@ -56,6 +57,11 @@ export async function run(files: string[], config: ResolvedConfig, executor: Vit
 
   const runner = await resolveTestRunner(config, executor)
 
+  workerState.onCancel.then((reason) => {
+    closeInspector(config)
+    runner.onCancel?.(reason)
+  })
+
   workerState.durations.prepare = performance.now() - workerState.durations.prepare
 
   const { vi } = VitestIndex