import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' import { mkdtemp, mkdir, readFile, rm, writeFile } from 'node:fs/promises' import { realpath } from 'node:fs/promises' import { tmpdir } from 'node:os' import { join } from 'node:path' import { pathToFileURL, fileURLToPath } from 'node:url' import { Context } from 'cordis' import Lsp, { type LspProvider, type LspQueryRequest, type LspQueryResult } from '@deepseek-ai/dsh-lsp' import { deadline } from '@deepseek-ai/dsh-timeout' import * as LspLocal from '@deepseek-ai/dsh-lsp-local' import type { LspLocalServerConfig } from '@deepseek-ai/dsh-lsp-local' const fixtureServer = fileURLToPath(new URL('./fixture-server.ts', import.meta.url)) let root: string let ws: string beforeEach(async () => { root = await realpath(await mkdtemp(join(tmpdir(), 'lsp-local-'))) ws = join(root, 'ws') await mkdir(ws) await writeFile(join(ws, 'a.ts'), 'const x = 1\nconst y = x\n') }) afterEach(async () => { await rm(root, { recursive: true, force: true }) }) /** One fake stdio server entry with optional behavior and host-bound overrides. */ function fakeServer(fakeEnv: Record = {}, overrides: Partial = {}): LspLocalServerConfig { return { command: process.execPath, args: [fixtureServer], env: { ...fakeEnv }, extensionToLanguage: { '.ts': 'typescript' }, ...overrides, } } /** Mount the real seam + lsp-local plugin driving one fake server. */ async function mount( fakeEnv: Record = {}, overrides: Partial = {}, captureProvider?: (provider: LspProvider) => void, ): Promise { const ctx = new Context() await ctx.plugin(Lsp) const register = ctx.lsp.registerProvider.bind(ctx.lsp) const registrationSpy = captureProvider === undefined ? undefined : vi.spyOn(ctx.lsp, 'registerProvider').mockImplementation((provider) => { captureProvider(provider) return register(provider) }) try { await ctx.plugin(LspLocal, { servers: { fake: fakeServer(fakeEnv, overrides) }, }) } finally { registrationSpy?.mockRestore() } return ctx } function query(operation: LspQueryRequest['operation'], filePath = 'a.ts'): LspQueryRequest { return { operation, filePath, position: { line: 0, character: 6 }, workspaceRoot: ws } } /** A single Location JSON pointing into the workspace. */ function locationJson(line: number): unknown { return { uri: pathToFileURL(join(ws, 'a.ts')).href, range: { start: { line, character: 0 }, end: { line, character: 3 } } } } describe('lsp-local end to end over a fake server', () => { it('routes different extensions to independent configured servers', async () => { await writeFile(join(ws, 'a.py'), 'x = 1\n') const ctx = new Context() await ctx.plugin(Lsp) await ctx.plugin(LspLocal, { servers: { typescript: fakeServer({ LSP_FAKE_HOVER: JSON.stringify({ contents: 'ts' }) }), python: fakeServer( { LSP_FAKE_HOVER: JSON.stringify({ contents: 'py' }) }, { extensionToLanguage: { '.py': 'python' } }, ), }, }) expect(await ctx.lsp.query(query('hover', 'a.ts'))).toEqual({ kind: 'hover', hover: { contents: 'ts' } }) expect(await ctx.lsp.query(query('hover', 'a.py'))).toEqual({ kind: 'hover', hover: { contents: 'py' } }) await ctx.fiber.dispose() }) it('resolves definition to normalized locations', async () => { const ctx = await mount({ LSP_FAKE_DEF: JSON.stringify(locationJson(0)) }) const result = await ctx.lsp.query(query('goToDefinition')) expect(result).toEqual({ kind: 'locations', locations: [{ uri: pathToFileURL(join(ws, 'a.ts')).href, range: { start: { line: 0, character: 0 }, end: { line: 0, character: 3 } } }], resolvedWorkspaceRoot: ws, }) await ctx.fiber.dispose() }) it('maps a LocationLink for implementation', async () => { const link = { targetUri: pathToFileURL(join(ws, 'a.ts')).href, targetSelectionRange: { start: { line: 1, character: 0 }, end: { line: 1, character: 2 } } } const ctx = await mount({ LSP_FAKE_IMPL: JSON.stringify([link]) }) const result = await ctx.lsp.query(query('goToImplementation')) expect(result).toMatchObject({ kind: 'locations', locations: [{ range: { start: { line: 1, character: 0 } } }] }) await ctx.fiber.dispose() }) it('returns references (server includes the declaration)', async () => { const ctx = await mount({ LSP_FAKE_REFS: JSON.stringify([locationJson(0), locationJson(1)]) }) const result = await ctx.lsp.query(query('findReferences')) expect(result).toMatchObject({ kind: 'locations' }) if (result.kind !== 'locations') throw new Error('expected locations') expect(result.locations).toHaveLength(2) await ctx.fiber.dispose() }) it('normalizes a hover MarkupContent', async () => { const ctx = await mount({ LSP_FAKE_HOVER: JSON.stringify({ contents: { kind: 'markdown', value: 'docs' } }) }) const result = await ctx.lsp.query(query('hover')) expect(result).toEqual({ kind: 'hover', hover: { contents: 'docs' } }) await ctx.fiber.dispose() }) it('returns an empty locations result for a null definition', async () => { const ctx = await mount({ LSP_FAKE_DEF: 'null' }) expect(await ctx.lsp.query(query('goToDefinition'))).toEqual({ kind: 'locations', locations: [], resolvedWorkspaceRoot: ws }) await ctx.fiber.dispose() }) it('returns a null hover for a null result', async () => { const ctx = await mount({ LSP_FAKE_HOVER: 'null' }) expect(await ctx.lsp.query(query('hover'))).toEqual({ kind: 'hover', hover: null }) await ctx.fiber.dispose() }) it('rejects a non-utf-16 position encoding at initialize without retrying', async () => { const marker = join(root, 'initialize-rejection-exit.log') const ctx = await mount({ LSP_FAKE_ENCODING: 'utf-8', LSP_FAKE_DEF: 'null', LSP_FAKE_EXIT_MARKER: marker, }) await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow(/unsupported position encoding/) expect(await readFile(marker, 'utf8')).toBe('EXIT\nCLEAN\n') await ctx.fiber.dispose() }) it('does not pool a poisoned instance when initialize rejects', async () => { // A utf-8 server makes `initialize` reject; the instance must be torn down (not left with a // permanently-rejecting `ready`) so a later query starts a fresh process rather than reusing it. const ctx = await mount({ LSP_FAKE_ENCODING: 'utf-8', LSP_FAKE_DEF: 'null' }) await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow(/unsupported position encoding/) // A second query must also fail the same way (fresh instance), and must NOT hang on a poisoned one. await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow(/unsupported position encoding/) await ctx.fiber.dispose() }) it('rejects a server without transient-open sync (None)', async () => { const ctx = await mount({ LSP_FAKE_SYNC: '0', LSP_FAKE_DEF: 'null' }) await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow(/transient textDocument\/didOpen/) await ctx.fiber.dispose() }) it('accepts openClose options sync', async () => { const ctx = await mount({ LSP_FAKE_SYNC: JSON.stringify({ openClose: true, change: 2 }), LSP_FAKE_DEF: 'null' }) expect(await ctx.lsp.query(query('goToDefinition'))).toEqual({ kind: 'locations', locations: [], resolvedWorkspaceRoot: ws }) await ctx.fiber.dispose() }) it('fails a query for an unsupported operation', async () => { const ctx = await mount({ LSP_FAKE_CAPS: JSON.stringify({ hoverProvider: false }), LSP_FAKE_DEF: 'null' }) await expect(ctx.lsp.query(query('hover'))).rejects.toThrow(/does not support hover/) await ctx.fiber.dispose() }) it('rejects a source outside the workspace before startup', async () => { const outside = join(root, 'out.ts') await writeFile(outside, 'x') const ctx = await mount({ LSP_FAKE_DEF: 'null' }) await expect(ctx.lsp.query({ ...query('goToDefinition'), filePath: outside })).rejects.toThrow(/outside the workspace/) await ctx.fiber.dispose() }) it('serializes queries through one instance and runs them in order', async () => { const ctx = await mount({ LSP_FAKE_DEF: JSON.stringify(locationJson(0)) }) const results = await Promise.all([ ctx.lsp.query(query('goToDefinition')), ctx.lsp.query(query('goToDefinition')), ctx.lsp.query(query('goToDefinition')), ]) for (const result of results) expect(result).toMatchObject({ kind: 'locations' }) await ctx.fiber.dispose() }) it('reads a queued query source only when its lifecycle starts', async () => { const marker = join(root, 'opened.jsonl') const ctx = await mount({ LSP_FAKE_DEF: 'null', LSP_FAKE_REPLY_DELAY_MS: '300', LSP_FAKE_OPEN_MARKER: marker, }) const first = ctx.lsp.query(query('goToDefinition')) await waitFor(async () => (await markerLines(marker)).length === 1) const second = ctx.lsp.query(query('goToDefinition')) await writeFile(join(ws, 'a.ts'), 'const changed = 2\n') await Promise.all([first, second]) expect(await markerLines(marker)).toEqual([ 'const x = 1\nconst y = x\n', 'const changed = 2\n', ]) await ctx.fiber.dispose() }) it('aborts an in-flight query when the signal fires', async () => { const ctx = await mount({ LSP_FAKE_HANG: '1' }) const controller = new AbortController() const pending = ctx.lsp.query(query('goToDefinition'), controller.signal) controller.abort(new Error('caller cancelled')) await expect(pending).rejects.toThrow(/cancelled/) await ctx.fiber.dispose() }) it('honors an already-aborted signal before any host I/O or startup', async () => { const ctx = await mount({ LSP_FAKE_DEF: 'null' }) const controller = new AbortController() controller.abort(new Error('pre-aborted')) await expect(ctx.lsp.query(query('goToDefinition'), controller.signal)).rejects.toThrow(/pre-aborted/) await ctx.fiber.dispose() }) it('surfaces the server stderr tail in the exit error', async () => { // A server that writes to stderr then exits without answering: the query rejection carries the // retained stderr tail so the failure is diagnosable. const ctx = await mount({}, { command: process.execPath, args: ['-e', 'process.stderr.write("FATAL: boom\\n"); setTimeout(()=>process.exit(1), 50)'], }) await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow(/FATAL: boom/) await ctx.fiber.dispose() }) it('classifies a timeout deadline as the abort reason', async () => { const ctx = await mount({ LSP_FAKE_HANG: '1' }) using d = deadline(undefined, 50, 'TEST_TIMEOUT') await expect(ctx.lsp.query(query('goToDefinition'), d.signal)).rejects.toThrow(/TEST_TIMEOUT/) await ctx.fiber.dispose() }) it('fails the active query when the server crashes on open, and replaces it next query', async () => { const ctx = await mount({ LSP_FAKE_CRASH_ON_OPEN: '1', LSP_FAKE_DEF: 'null' }, { shutdownTimeoutMs: 100, killGraceMs: 100 }) await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow() // A later query starts a fresh process; still crashes, but proves the slot was replaced (no hang). await expect(ctx.lsp.query(query('goToDefinition'))).rejects.toThrow() await ctx.fiber.dispose() }) it('evicts a pooled server that died while idle and serves the next query from a fresh one', async () => { // The first query succeeds, then the server exits before the second arrives, leaving a dead // instance in the pool. The next query must evict-and-replace it and still succeed, rather than // failing once on the closed connection first. let provider: LspProvider | undefined const ctx = await mount( { LSP_FAKE_EXIT_AFTER_REPLY: '1', LSP_FAKE_DEF: JSON.stringify(locationJson(0)) }, {}, (registered) => { provider = registered }, ) expect(await ctx.lsp.query(query('goToDefinition'))).toMatchObject({ kind: 'locations' }) if (provider === undefined) throw new Error('expected lsp-local to register a provider') // This implementation-local test reaches the private pool only to synchronize with its actual // close state. A fixed wall-clock sleep can expire before a CPU-starved child runs its exit timer. const instances = (provider as unknown as { readonly instances: ReadonlyMap }).instances const instance = [...instances.values()][0] if (instance === undefined) throw new Error('expected one pooled LSP instance') await waitFor(async () => instance.dead) expect(await ctx.lsp.query(query('goToDefinition'))).toMatchObject({ kind: 'locations' }) await ctx.fiber.dispose() }) it('does not spawn a server when the signal aborts during source read', async () => { // Abort right after issuing the query: the abort lands while canonicalizeWorkspace/readHostSource // are awaited, so the pre-spawn recheck must reject without ever creating a pooled instance. const ctx = await mount({ LSP_FAKE_DEF: 'null' }) const controller = new AbortController() const pending = ctx.lsp.query(query('goToDefinition'), controller.signal) controller.abort(new Error('mid-read cancel')) await expect(pending).rejects.toThrow(/mid-read cancel/) // A subsequent live query still works, proving no half-created instance poisoned the pool. expect(await ctx.lsp.query(query('goToDefinition'))).toEqual({ kind: 'locations', locations: [], resolvedWorkspaceRoot: ws }) await ctx.fiber.dispose() }) it('runs distinct workspaces in parallel instances', async () => { const ws2 = join(root, 'ws2') await mkdir(ws2) await writeFile(join(ws2, 'a.ts'), 'const z = 2\n') const ctx = await mount({ LSP_FAKE_DEF: JSON.stringify(locationJson(0)) }) const [r1, r2] = await Promise.all([ ctx.lsp.query({ ...query('goToDefinition'), workspaceRoot: ws }), ctx.lsp.query({ ...query('goToDefinition'), workspaceRoot: ws2 }), ]) expect(r1).toMatchObject({ kind: 'locations' }) expect(r2).toMatchObject({ kind: 'locations' }) await ctx.fiber.dispose() }) it('disposes cleanly, terminating a server that ignores shutdown', async () => { const ctx = await mount({ LSP_FAKE_NO_SHUTDOWN: '1', LSP_FAKE_DEF: 'null' }, { killGraceMs: 100, shutdownTimeoutMs: 100 }) await ctx.lsp.query(query('goToDefinition')) await expect(ctx.fiber.dispose()).resolves.toBeUndefined() }) it('rejects at load when the command is not found', async () => { const ctx = new Context() await ctx.plugin(Lsp) await expect(ctx.plugin(LspLocal, { servers: { missing: { command: 'definitely-not-a-real-lsp-binary-xyz', args: [], extensionToLanguage: { '.ts': 'typescript' }, }, }, })).rejects.toThrow(/was not found on PATH/) await ctx.fiber.dispose() }) }) /** Read the fixture's JSON-lines didOpen marker, returning no entries before it exists. */ async function markerLines(path: string): Promise { try { const text = await readFile(path, 'utf8') return text.trim().split('\n').filter(Boolean).map(line => JSON.parse(line) as string) } catch (error) { if ((error as NodeJS.ErrnoException).code === 'ENOENT') return [] throw error } } /** Poll an asynchronous condition until it succeeds or the test-local deadline expires. */ async function waitFor(condition: () => Promise, timeoutMs = 3000): Promise { const started = Date.now() while (!await condition()) { if (Date.now() - started > timeoutMs) throw new Error('waitFor timed out') await new Promise(resolve => setTimeout(resolve, 10)) } }