Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/vitest-dev/vscode. VS Code extension for Vitest vitest.dev/vscode
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396import type { AddressInfo, WebSocket } from 'ws'import type { ExtensionDiagnostic } from './diagnostic'import type { ImportsBreakdownProvider } from './importsBreakdownProvider'import type { VitestPackage } from './spawn/pkg'import type { ExtensionWorkerProcess } from './spawn/types'import type { TestTree } from './testTree'import crypto from 'node:crypto'import { pathToFileURL } from 'node:url'import * as vscode from 'vscode'import { createBoundServer } from './net'import { WebSocketServer } from 'ws'import { VitestProcessAPI } from './apiProcess'import { getConfig } from './config'import { workerPath } from './constants'import { log } from './log'import { TestRunner } from './runner'import { onWsConnection } from './spawn/ws'import { getTestData, TestCase, TestFile, TestFolder, TestSuite } from './testTreeData'import { findRuntimeExecutable } from './utils'
const DebugSessionName = 'Vitest'const BrowserDebugSessionName = 'Vitest_Browser'const AttachSessionName = 'Vitest (Test)'
export async function debugTests( controller: vscode.TestController, tree: TestTree, pkg: VitestPackage, diagnostic: ExtensionDiagnostic | undefined, importsBreakdown: ImportsBreakdownProvider,
request: vscode.TestRunRequest, token: vscode.CancellationToken, debugManager: DebugManager,) { const server = await createBoundServer() const { port } = server.address() as AddressInfo const wss = new WebSocketServer({ server }) const wsAddress = `ws://localhost:${port}`
const config = getConfig(pkg.folder) const deferredPromise = Promise.withResolvers<void>()
const { runtimeArgs, runtimeExecutable } = await getRuntimeOptions(pkg) const env = config.env || {} const debugEnv = config.debugEnv || {} const logLevel = config.logLevel
if (pkg.runtime === 'deno') { runtimeArgs.push('-A') }
log.info('[DEBUG]', 'Starting debugging session', runtimeExecutable, ...(runtimeArgs || []))
const debugId = crypto.randomUUID() const browserDebug = getBrowserDebugInfo(controller, request)
const skipFiles = [ ...(config.debugExclude || []), '**/node_modules/@vitest/{runner,utils}/**', '**/node_modules/vitest/dist/**', ]
const debugConfig = { __name: DebugSessionName, __vitestId: debugId, type: config.shellType === 'terminal' ? 'node-terminal' : 'pwa-node', request: 'launch', name: 'Debug Tests', autoAttachChildProcesses: true, skipFiles, ...(config.debugOutFiles?.length ? { outFiles: config.debugOutFiles } : {}), smartStep: true, ...(config.shellType === 'terminal' ? { command: `${runtimeExecutable} ${workerPath};exit`, } : { program: workerPath, runtimeArgs, runtimeExecutable, }), cwd: pkg.cwd, env: { ...process.env, ...env, ...debugEnv, VITEST_VSCODE_LOG: env.VITEST_VSCODE_LOG ?? process.env.VITEST_VSCODE_LOG ?? logLevel, 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', FORCE_COLOR: '1', }, }
if (debugManager.sessions.size) { await Promise.all( Array.from(debugManager.sessions, (session) => vscode.debug.stopDebugging(session)), ).catch((error) => { log.error('[DEBUG] Failed to stop debugging sessions', error) }) }
vscode.debug.startDebugging(pkg.folder, debugConfig, { suppressDebugView: true }).then( (fulfilled) => { if (fulfilled) { log.info('[DEBUG] Debugging started') } else { deferredPromise.reject( new Error('Failed to start debugging. See output for more information.'), ) log.error('[DEBUG] Debugging failed') } }, (err) => { deferredPromise.reject(new Error('Failed to start debugging', { cause: err })) log.error('[DEBUG] Start debugging failed') log.error(err.toString()) }, )
const disposables: vscode.Disposable[] = []
const attachDebug = browserDebug || pkg.runtime === 'deno' ? { browser: browserDebug?.browser, // wdio support this only since Vitest 4.beta-13 port: config.debuggerPort ?? 9229, host: browserDebug ? 'localhost' : '127.0.0.1', } : undefined
wss.on('connection', (ws) => onWsConnection( ws, pkg, attachDebug ?? true, config.shellType, async (metadata) => { metadata.handlers.onProcessLog((type, message) => { log.worker(type === 'stderr' ? 'error' : 'info', message) })
try { const api = VitestProcessAPI.forDebug(pkg, { ...metadata, process: new ExtensionDebugProcess(metadata.ws), }) const handle = await api.spawnForRun() const runner = new TestRunner(handle, controller, tree, api, diagnostic, importsBreakdown) disposables.push(api, runner)
token.onCancellationRequested(async () => { await metadata.dispose() })
if (attachDebug) { const attachConfig: vscode.DebugConfiguration = { __name: browserDebug ? BrowserDebugSessionName : AttachSessionName, __parentId: debugId, type: browserDebug ? (browserDebug.browser === 'edge' ? 'msedge' : 'chrome') : 'node', request: 'attach', name: `Debug Tests (${attachDebug.browser || 'test'})`, address: attachDebug.host, port: attachDebug.port, ...(config.debugOutFiles?.length ? { outFiles: config.debugOutFiles } : {}), webRoot: browserDebug?.webRoot, smartStep: true, skipFiles, cwd: pkg.cwd, } log.info('[DEBUG] Attaching to', attachConfig) let parentSession: vscode.DebugSession | undefined for (const session of debugManager.sessions.values()) { if (session.configuration.__vitestId === debugId) { parentSession = session } } vscode.debug .startDebugging(pkg.folder, attachConfig, { parentSession, // this is required for the "restart" button to work // TODO: but it still doesn't work lifecycleManagedByParent: true, compact: true, }) .then( (fullfilled) => { log.info('[DEBUG] Debug session started') metadata.rpc.onDebugAttached(fullfilled).catch(() => {}) if (fullfilled) { log.info('[DEBUG] Debug session attached') } else { log.error('[DEBUG] Debugger failed to attach') } }, (error) => { metadata.rpc.onDebugAttached(false).catch(() => {}) log.error('[DEBUG] Attach session failed to launch', error.message) }, ) }
await runner.runTests(request)
deferredPromise.resolve() } catch (err: any) { if (err.message.startsWith('[birpc] rpc is closed')) { deferredPromise.resolve() return }
deferredPromise.reject(err) } }, (err) => { if (err.message.startsWith('[birpc] rpc is closed')) { deferredPromise.resolve() return }
deferredPromise.reject(err) }, { sendLog: true }, ), )
const onDidWorkerTerminate = vscode.debug.onDidTerminateDebugSession((session) => { const parent = session.parentSession
// dispose all test runners if ( session.configuration.__name !== BrowserDebugSessionName && parent && parent.configuration.__name === DebugSessionName ) { disposables.reverse().forEach((d) => d.dispose()) disposables.length = 0 } })
const onDidTerminate = vscode.debug.onDidTerminateDebugSession((session) => { if (session.configuration.__name !== DebugSessionName) return server.close() onDidTerminate.dispose() onDidWorkerTerminate.dispose() })
await deferredPromise.promise}
async function getRuntimeOptions(pkg: VitestPackage) { const config = getConfig(pkg.folder)
const runtimeArgs = config.nodeExecArgs || [] const pnpLoader = pkg.loader const pnp = pkg.pnp const execArgv = pnpLoader && pnp ? [ '--require', pnp, '--experimental-loader', pathToFileURL(pnpLoader).toString(), ...runtimeArgs, ] : runtimeArgs if (config.shellType === 'child_process') { const executable = await findRuntimeExecutable(pkg.runtime, pkg.cwd) return { runtimeExecutable: executable, runtimeArgs: [...execArgv], } } return { runtimeExecutable: config.runtime, runtimeArgs: [...execArgv], }}
class ExtensionDebugProcess implements ExtensionWorkerProcess { public closed = false
private _onDidExit = new vscode.EventEmitter<void>()
constructor(ws: WebSocket) { // if websocket connection stopped working, close the debug session // otherwise it might hang indefinitely ws.on('close', () => { this.closed = true this._onDidExit.fire() this._onDidExit.dispose() }) }
onExit(listener: (code: number | null) => void) { const { dispose } = this._onDidExit.event(() => { listener(null) }) return dispose }}
export class DebugManager { public sessions: Set<vscode.DebugSession> = new Set()
constructor() { vscode.debug.onDidStartDebugSession((session) => { if (session.configuration.__name === DebugSessionName) { this.sessions.add(session) } })
vscode.debug.onDidTerminateDebugSession((session) => { this.sessions.delete(session) }) }}
function getBrowserDebugInfo(controller: vscode.TestController, request: vscode.TestRunRequest) { let provider: string | undefined let browser: string | undefined const webRootsFound: Set<string> = new Set()
function traverse(testItem: vscode.TestItem) { const data = getTestData(testItem)
if (data instanceof TestFile) { if (request.exclude?.includes(testItem)) { return }
const options = data.metadata.browser if (!options) { return } // this can actually be supported, but should we? if (provider && provider !== options.provider) { throw new Error(`Cannot mix both "playwright" and "webdriverio" tests together.`) }
if (options.provider === 'playwright' && options.name !== 'chromium') { throw new Error( `VSCode can only debug tests running in the "chromium" browser. ${testItem.label} runs in ${options.name} instead.`, ) } if ( options.provider === 'webdriverio' && options.name !== 'chrome' && options.name !== 'edge' ) { throw new Error( `VSCode can only debug tests running in the "chrome" or "edge" browser. ${testItem.label} runs in ${options.name} instead.`, ) } if (options.provider === 'preview') { throw new Error( `Cannot debug tests running in the "preview" provider. Choose either "playwright" or "webdriverio" to be able to debug tests.`, ) }
provider = options.provider browser = options.name webRootsFound.add(options.webRoot) } else if (data instanceof TestFolder) { testItem.children.forEach(traverse) } else if (data instanceof TestCase || data instanceof TestSuite) { if (testItem.parent) { traverse(testItem.parent) } } }
if (request.include) { request.include.forEach(traverse) } else { controller.items.forEach(traverse) }
let webRoot: string | undefined if (webRootsFound.size === 1) { ;[webRoot] = webRootsFound // Grab the first (and only) value } else if (webRootsFound.size > 1) { log.info( '[DEBUG] Multiple webRoots found for browser debugging. Breakpoints in source code may not work as expected. Try debugging again by selecting specific tests or test files to debug.', ) }
return provider && browser ? { provider, browser, webRoot } : null}