fix: do not crash when restarting the debug session

Author: sheremet-va

package.json

@@ -278,7 +278,7 @@
     "@vue/reactivity": "^3.2.33",
     "acorn": "^8.12.0",
     "acorn-walk": "^8.3.3",
-    "birpc": "^0.2.19",
+    "birpc": "^2.4.0",
     "bumpp": "^10.1.1",
     "chai": "^5.1.0",
     "changelogithub": "^13.15.0",

pnpm-lock.yaml

@@ -95,6 +95,9 @@ export class ExtensionTerminalProcess implements ExtensionWorkerProcess {
   }
 
   close() {
+    if (this.closed) {
+      return Promise.resolve()
+    }
     // send ctrl+c to sigint any running processs (vscode/#108289)
     this.terminal.sendText('\x03')
     // and then destroy it on the next event loop tick

src/api/terminal.ts

@@ -20,88 +20,17 @@ export function waitForWsConnection(
 ) {
   return new Promise<WsConnectionMetadata>((resolve, reject) => {
     wss.once('connection', (ws) => {
-      function onMessage(_message: any) {
-        const message = JSON.parse(_message.toString()) as WorkerEvent
-
-        if (message.type === 'debug')
-          log.worker('info', ...message.args)
-
-        if (message.type === 'ready') {
-          const { api, handlers } = createVitestRpc({
-            on: listener => ws.on('message', listener),
-            send: message => ws.send(message),
-          })
-          ws.once('close', () => {
-            log.verbose?.('[API]', 'Vitest WebSocket connection closed, cannot call RPC anymore.')
-            api.$close()
-          })
-          resolve({
-            rpc: api,
-            workspaceSource: message.workspaceSource,
-            handlers: {
-              ...handlers,
-              onStdout() {
-                // do nothing by default
-              },
-            },
-            configs: message.configs,
-            ws,
-            pkg,
-          })
-        }
-
-        if (message.type === 'error') {
-          const error = new Error(`Vitest failed to start: \n${message.error}`)
-          reject(error)
-        }
-        ws.off('error', onError)
-        ws.off('message', onMessage)
-        ws.off('close', onExit)
-      }
-
-      function onError(err: Error) {
-        log.error('[API]', err)
-        reject(err)
-        ws.off('error', onError)
-        ws.off('message', onMessage)
-        ws.off('close', onExit)
-      }
-
-      function onExit(code: number) {
-        reject(new Error(`Vitest process exited with code ${code}`))
-      }
+      onWsConnection(
+        ws,
+        pkg,
+        debug,
+        shellType,
+        meta => resolve(meta),
+        err => reject(err),
+      )
 
       wss.off('error', onUnexpectedError)
       wss.off('exit', onUnexpectedExit)
-
-      ws.on('error', onError)
-      ws.on('message', onMessage)
-      ws.on('close', onExit)
-
-      const pnpLoader = pkg.loader
-      const pnp = pkg.pnp
-
-      const runnerOptions: WorkerRunnerOptions = {
-        type: 'init',
-        meta: {
-          shellType,
-          vitestNodePath: pkg.vitestNodePath,
-          env: getConfig(pkg.folder).env || undefined,
-          configFile: pkg.configFile,
-          cwd: pkg.cwd,
-          arguments: pkg.arguments,
-          workspaceFile: pkg.workspaceFile,
-          id: pkg.id,
-          pnpApi: pnp,
-          pnpLoader: pnpLoader && gte(process.version, '18.19.0')
-            ? pathToFileURL(pnpLoader).toString()
-            : undefined,
-        },
-        debug,
-        astCollect: getConfig(pkg.folder).experimentalStaticAstCollect,
-      }
-
-      ws.send(JSON.stringify(runnerOptions))
     })
 
     function onUnexpectedExit() {
@@ -116,3 +45,92 @@ export function waitForWsConnection(
     wss.once('close', onUnexpectedExit)
   })
 }
+
+export function onWsConnection(
+  ws: WebSocket,
+  pkg: VitestPackage,
+  debug: boolean,
+  shellType: 'terminal' | 'child_process',
+  onStart: (meta: WsConnectionMetadata) => unknown,
+  onFail: (err: Error) => unknown,
+) {
+  function onMessage(_message: any) {
+    const message = JSON.parse(_message.toString()) as WorkerEvent
+
+    if (message.type === 'debug')
+      log.worker('info', ...message.args)
+
+    if (message.type === 'ready') {
+      const { api, handlers } = createVitestRpc({
+        on: listener => ws.on('message', listener),
+        send: message => ws.send(message),
+      })
+      ws.once('close', () => {
+        log.verbose?.('[API]', 'Vitest WebSocket connection closed, cannot call RPC anymore.')
+        api.$close()
+      })
+      onStart({
+        rpc: api,
+        workspaceSource: message.workspaceSource,
+        handlers: {
+          ...handlers,
+          onStdout() {
+            // do nothing by default
+          },
+        },
+        configs: message.configs,
+        ws,
+        pkg,
+      })
+    }
+
+    if (message.type === 'error') {
+      const error = new Error(`Vitest failed to start: \n${message.error}`)
+      onFail(error)
+    }
+    ws.off('error', onError)
+    ws.off('message', onMessage)
+    ws.off('close', onExit)
+  }
+
+  function onError(err: Error) {
+    log.error('[API]', err)
+    onFail(err)
+    ws.off('error', onError)
+    ws.off('message', onMessage)
+    ws.off('close', onExit)
+  }
+
+  function onExit(code: number) {
+    onFail(new Error(`Vitest process exited with code ${code}`))
+  }
+
+  ws.on('error', onError)
+  ws.on('message', onMessage)
+  ws.on('close', onExit)
+
+  const pnpLoader = pkg.loader
+  const pnp = pkg.pnp
+
+  const runnerOptions: WorkerRunnerOptions = {
+    type: 'init',
+    meta: {
+      shellType,
+      vitestNodePath: pkg.vitestNodePath,
+      env: getConfig(pkg.folder).env || undefined,
+      configFile: pkg.configFile,
+      cwd: pkg.cwd,
+      arguments: pkg.arguments,
+      workspaceFile: pkg.workspaceFile,
+      id: pkg.id,
+      pnpApi: pnp,
+      pnpLoader: pnpLoader && gte(process.version, '18.19.0')
+        ? pathToFileURL(pnpLoader).toString()
+        : undefined,
+    },
+    debug,
+    astCollect: getConfig(pkg.folder).experimentalStaticAstCollect,
+  }
+
+  ws.send(JSON.stringify(runnerOptions))
+}