Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: spawn a separate process when debugging (#376)
* feat: spawn a separate process when debugging * chore: dispose when session is terminated * chore: cleanup
- Loading branch information
1 parent
b71f433
commit 6736630
Showing
14 changed files
with
428 additions
and
376 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| import { createServer } from 'node:http' | ||
| import * as vscode from 'vscode' | ||
| import WebSocket, { WebSocketServer } from 'ws' | ||
| import getPort from 'get-port' | ||
| import type { ResolvedMeta } from '../api' | ||
| import { VitestFolderAPI } from '../api' | ||
| import type { VitestPackage } from '../api/pkg' | ||
| import { createVitestRpc } from '../api/rpc' | ||
| import type { VitestProcess } from '../process' | ||
| import type { TestTree } from '../testTree' | ||
| import { log } from '../log' | ||
| import { getConfig } from '../config' | ||
| import type { WorkerRunnerOptions } from '../worker/types' | ||
| import { TestRunner } from '../runner/runner' | ||
| import { findNode } from '../utils' | ||
| import { debuggerPath } from '../constants' | ||
|
|
||
| export async function debugTests( | ||
| controller: vscode.TestController, | ||
| tree: TestTree, | ||
| pkg: VitestPackage, | ||
|
|
||
| request: vscode.TestRunRequest, | ||
| token: vscode.CancellationToken, | ||
| ) { | ||
| const port = await getPort() | ||
| const server = createServer().listen(port) | ||
| const wss = new WebSocketServer({ server }) | ||
| const wsAddress = `ws://localhost:${port}` | ||
|
|
||
| const config = getConfig(pkg.folder) | ||
| const promise = Promise.withResolvers<void>() | ||
|
|
||
| const execPath = getConfig().nodeExecutable || await findNode( | ||
| vscode.workspace.workspaceFile?.fsPath || pkg.folder.uri.fsPath, | ||
| ) | ||
| const env = config.env || {} | ||
|
|
||
| const debugConfig = { | ||
| type: 'pwa-node', | ||
| request: 'launch', | ||
| name: 'Debug Tests', | ||
| autoAttachChildProcesses: true, | ||
| skipFiles: config.debugExclude, | ||
| smartStep: true, | ||
| runtimeExecutable: execPath, | ||
| program: debuggerPath, | ||
| __name: 'Vitest', | ||
| env: { | ||
| ...process.env, | ||
| ...env, | ||
| VITEST_VSCODE: 'true', | ||
| VITEST_WS_ADDRESS: wsAddress, | ||
| // same env var as `startVitest` | ||
| // https://github.com/vitest-dev/vitest/blob/5c7e9ca05491aeda225ce4616f06eefcd068c0b4/packages/vitest/src/node/cli/cli-api.ts | ||
| TEST: 'true', | ||
| VITEST: 'true', | ||
| NODE_ENV: env.NODE_ENV ?? process.env.NODE_ENV ?? 'test', | ||
| }, | ||
| } | ||
|
|
||
| vscode.debug.startDebugging( | ||
| pkg.folder, | ||
| debugConfig, | ||
| { suppressDebugView: true }, | ||
| ).then( | ||
| (fulfilled) => { | ||
| if (fulfilled) { | ||
| log.info('[DEBUG] Debugging started') | ||
| promise.resolve() | ||
| } | ||
| else { | ||
| promise.reject(new Error('Failed to start debugging. See output for more information.')) | ||
| log.error('[DEBUG] Debugging failed') | ||
| } | ||
| }, | ||
| (err) => { | ||
| promise.reject(new Error('Failed to start debugging', { cause: err })) | ||
| log.error('[DEBUG] Start debugging failed') | ||
| log.error(err.toString()) | ||
| }, | ||
| ) | ||
|
|
||
| const disposables: vscode.Disposable[] = [] | ||
|
|
||
| const onDidStart = vscode.debug.onDidStartDebugSession(async (session) => { | ||
| if (session.configuration.__name !== 'Vitest') | ||
| return | ||
| if (token.isCancellationRequested) { | ||
| vscode.debug.stopDebugging(session) | ||
| return | ||
| } | ||
| const vitest = await startWebsocketServer(wss, pkg) | ||
| const api = new VitestFolderAPI(pkg, vitest) | ||
| const runner = new TestRunner( | ||
| controller, | ||
| tree, | ||
| api, | ||
| ) | ||
| disposables.push(api, runner) | ||
|
|
||
| token.onCancellationRequested(async () => { | ||
| await vitest.rpc.close() | ||
| await vscode.debug.stopDebugging(session) | ||
| }) | ||
|
|
||
| await runner.runTests(request, token) | ||
|
|
||
| if (!token.isCancellationRequested) { | ||
| await vitest.rpc.close() | ||
| await vscode.debug.stopDebugging(session) | ||
| } | ||
| }) | ||
|
|
||
| const onDidTerminate = vscode.debug.onDidTerminateDebugSession((session) => { | ||
| if (session.configuration.__name !== 'Vitest') | ||
| return | ||
| disposables.forEach(d => d.dispose()) | ||
| server.close() | ||
| }) | ||
|
|
||
| disposables.push(onDidStart, onDidTerminate) | ||
| } | ||
|
|
||
| function startWebsocketServer(wss: WebSocketServer, pkg: VitestPackage) { | ||
| return new Promise<ResolvedMeta>((resolve, reject) => { | ||
| wss.once('connection', (ws) => { | ||
| function ready(_message: any) { | ||
| const message = JSON.parse(_message.toString()) | ||
|
|
||
| if (message.type === 'debug') | ||
| log.worker('info', ...message.args) | ||
|
|
||
| if (message.type === 'ready') { | ||
| ws.off('message', ready) | ||
| const { api, handlers } = createVitestRpc({ | ||
| on: listener => ws.on('message', listener), | ||
| send: message => ws.send(message), | ||
| }) | ||
| resolve({ | ||
| rpc: api, | ||
| handlers, | ||
| process: new VitestWebSocketProcess(Math.random(), wss, ws), | ||
| packages: [pkg], | ||
| }) | ||
| } | ||
| if (message.type === 'error') { | ||
| ws.off('message', ready) | ||
| const error = new Error(`Vitest failed to start: \n${message.errors.map((r: any) => r[1]).join('\n')}`) | ||
| reject(error) | ||
| } | ||
| ws.off('error', error) | ||
| ws.off('message', ready) | ||
| ws.off('close', exit) | ||
| } | ||
|
|
||
| function error(err: Error) { | ||
| log.error('[API]', err) | ||
| reject(err) | ||
| ws.off('error', error) | ||
| ws.off('message', ready) | ||
| ws.off('close', exit) | ||
| } | ||
|
|
||
| function exit(code: number) { | ||
| reject(new Error(`Vitest process exited with code ${code}`)) | ||
| } | ||
|
|
||
| ws.on('error', error) | ||
| ws.on('message', ready) | ||
| ws.on('close', exit) | ||
|
|
||
| const runnerOptions: WorkerRunnerOptions = { | ||
| type: 'init', | ||
| meta: [ | ||
| { | ||
| vitestNodePath: pkg.vitestNodePath, | ||
| env: getConfig(pkg.folder).env || undefined, | ||
| configFile: pkg.configFile, | ||
| cwd: pkg.cwd, | ||
| arguments: pkg.arguments, | ||
| workspaceFile: pkg.workspaceFile, | ||
| id: pkg.id, | ||
| }, | ||
| ], | ||
| } | ||
|
|
||
| ws.send(JSON.stringify(runnerOptions)) | ||
| }) | ||
| wss.on('error', err => reject(err)) | ||
| // TODO close if unexpected | ||
| // wss.once('close', () => reject(err)) | ||
| }) | ||
| } | ||
|
|
||
| class VitestWebSocketProcess implements VitestProcess { | ||
| constructor( | ||
| public id: number, | ||
| private wss: WebSocketServer, | ||
| private ws: WebSocket, | ||
| ) {} | ||
|
|
||
| get closed() { | ||
| return this.ws.readyState === WebSocket.CLOSED | ||
| } | ||
|
|
||
| close() { | ||
| this.wss.close() | ||
| } | ||
|
|
||
| on(event: string, listener: (...args: any[]) => void) { | ||
| this.ws.on(event, listener) | ||
| } | ||
|
|
||
| once(event: string, listener: (...args: any[]) => void) { | ||
| this.ws.once(event, listener) | ||
| } | ||
| } |
Oops, something went wrong.