diff options
Diffstat (limited to 'packages/lsp/src/rpc.test.ts')
| -rw-r--r-- | packages/lsp/src/rpc.test.ts | 216 |
1 files changed, 121 insertions, 95 deletions
diff --git a/packages/lsp/src/rpc.test.ts b/packages/lsp/src/rpc.test.ts index 7b22ec5..37cadf2 100644 --- a/packages/lsp/src/rpc.test.ts +++ b/packages/lsp/src/rpc.test.ts @@ -2,111 +2,137 @@ import { describe, expect, it } from "vitest"; import { JsonRpcConnection } from "./rpc.js"; function makeConnection(): { conn: JsonRpcConnection; messages: string[] } { - const messages: string[] = []; - const conn = new JsonRpcConnection((bytes) => { - const decoded = new TextDecoder().decode(bytes); - // Extract JSON from the LSP-framed message - const headerEnd = decoded.indexOf("\r\n\r\n"); - if (headerEnd !== -1) { - messages.push(decoded.slice(headerEnd + 4)); - } - }); - return { conn, messages }; + const messages: string[] = []; + const conn = new JsonRpcConnection((bytes) => { + const decoded = new TextDecoder().decode(bytes); + // Extract JSON from the LSP-framed message + const headerEnd = decoded.indexOf("\r\n\r\n"); + if (headerEnd !== -1) { + messages.push(decoded.slice(headerEnd + 4)); + } + }); + return { conn, messages }; } function frameResponse(id: number, result: unknown): string { - return JSON.stringify({ jsonrpc: "2.0", id, result }); + return JSON.stringify({ jsonrpc: "2.0", id, result }); } describe("rpc", () => { - it("sendRequest resolves by matching id", async () => { - const { conn, messages } = makeConnection(); - - const promise = conn.sendRequest("test/method", { key: "value" }); - expect(messages).toHaveLength(1); - - const rawSent = messages[0]; - if (rawSent === undefined) throw new Error("expected a sent message"); - const sent = JSON.parse(rawSent); - expect(sent.method).toBe("test/method"); - expect(sent.params).toEqual({ key: "value" }); - expect(sent.id).toBe(1); - - conn.handleMessage(frameResponse(1, { ok: true })); - const result = await promise; - expect(result).toEqual({ ok: true }); - }); - - it("onNotification dispatches by method", () => { - const { conn } = makeConnection(); - let received: unknown = null; - conn.onNotification("test/notify", (params) => { - received = params; - }); - - conn.handleMessage( - JSON.stringify({ jsonrpc: "2.0", method: "test/notify", params: { data: 42 } }), - ); - expect(received).toEqual({ data: 42 }); - }); - - it("onRequest replies to a server-to-client request", async () => { - const { conn, messages } = makeConnection(); - - conn.onRequest("workspace/configuration", (params) => { - const { items } = params as { readonly items: readonly { readonly section?: string }[] }; - return items.map(() => ({ setting: true })); - }); - - await conn.handleMessage( - JSON.stringify({ - jsonrpc: "2.0", - id: 100, - method: "workspace/configuration", - params: { items: [{ section: "test" }] }, - }), - ); - - // The response should be sent back - expect(messages).toHaveLength(1); - const rawResponse = messages[0]; - if (rawResponse === undefined) throw new Error("expected a response message"); - const response = JSON.parse(rawResponse); - expect(response.id).toBe(100); - expect(response.result).toEqual([{ setting: true }]); - }); + it("sendRequest resolves by matching id", async () => { + const { conn, messages } = makeConnection(); + + const promise = conn.sendRequest("test/method", { key: "value" }); + expect(messages).toHaveLength(1); + + const rawSent = messages[0]; + if (rawSent === undefined) throw new Error("expected a sent message"); + const sent = JSON.parse(rawSent); + expect(sent.method).toBe("test/method"); + expect(sent.params).toEqual({ key: "value" }); + expect(sent.id).toBe(1); + + conn.handleMessage(frameResponse(1, { ok: true })); + const result = await promise; + expect(result).toEqual({ ok: true }); + }); + + it("onNotification dispatches by method", () => { + const { conn } = makeConnection(); + let received: unknown = null; + conn.onNotification("test/notify", (params) => { + received = params; + }); + + conn.handleMessage( + JSON.stringify({ jsonrpc: "2.0", method: "test/notify", params: { data: 42 } }), + ); + expect(received).toEqual({ data: 42 }); + }); + + it("onRequest replies to a server-to-client request", async () => { + const { conn, messages } = makeConnection(); + + conn.onRequest("workspace/configuration", (params) => { + const { items } = params as { readonly items: readonly { readonly section?: string }[] }; + return items.map(() => ({ setting: true })); + }); + + await conn.handleMessage( + JSON.stringify({ + jsonrpc: "2.0", + id: 100, + method: "workspace/configuration", + params: { items: [{ section: "test" }] }, + }), + ); + + // The response should be sent back + expect(messages).toHaveLength(1); + const rawResponse = messages[0]; + if (rawResponse === undefined) throw new Error("expected a response message"); + const response = JSON.parse(rawResponse); + expect(response.id).toBe(100); + expect(response.result).toEqual([{ setting: true }]); + }); }); it("handleMessage does not throw on malformed JSON", async () => { - const { conn } = makeConnection(); - // A corrupted/truncated LSP message — must not throw or reject. - await expect(conn.handleMessage("{ broken json")).resolves.toBeUndefined(); - await expect(conn.handleMessage("")).resolves.toBeUndefined(); - await expect(conn.handleMessage("not json at all")).resolves.toBeUndefined(); + const { conn } = makeConnection(); + // A corrupted/truncated LSP message — must not throw or reject. + await expect(conn.handleMessage("{ broken json")).resolves.toBeUndefined(); + await expect(conn.handleMessage("")).resolves.toBeUndefined(); + await expect(conn.handleMessage("not json at all")).resolves.toBeUndefined(); }); describe("sendRequest timeout", () => { - it("rejects with a timeout error when no response arrives within timeoutMs", async () => { - const { conn } = makeConnection(); - const promise = conn.sendRequest("textDocument/hover", {}, 50); - await expect(promise).rejects.toThrow(/LSP request timed out after 50ms: textDocument\/hover/); - }); - - it("clears the timer on a normal response (no unhandled rejection)", async () => { - const { conn } = makeConnection(); - const promise = conn.sendRequest("textDocument/hover", {}, 5000); - conn.handleMessage(frameResponse(1, { ok: true })); - await expect(promise).resolves.toEqual({ ok: true }); - // Give the (now-cleared) timer window ample time to prove it never fires. - await new Promise((r) => setTimeout(r, 80)); - }); - - it("does not time out when no timeoutMs is given (initialize handshake path)", async () => { - const { conn } = makeConnection(); - const promise = conn.sendRequest("initialize", {}); - // A late response well past any plausible default still resolves. - await new Promise((r) => setTimeout(r, 60)); - conn.handleMessage(frameResponse(1, { capabilities: {} })); - await expect(promise).resolves.toEqual({ capabilities: {} }); - }); + it("rejects with a timeout error when no response arrives within timeoutMs", async () => { + const { conn } = makeConnection(); + const promise = conn.sendRequest("textDocument/hover", {}, 50); + await expect(promise).rejects.toThrow(/LSP request timed out after 50ms: textDocument\/hover/); + }); + + it("clears the timer on a normal response (no unhandled rejection)", async () => { + const { conn } = makeConnection(); + const promise = conn.sendRequest("textDocument/hover", {}, 5000); + conn.handleMessage(frameResponse(1, { ok: true })); + await expect(promise).resolves.toEqual({ ok: true }); + // Give the (now-cleared) timer window ample time to prove it never fires. + await new Promise((r) => setTimeout(r, 80)); + }); + + it("does not time out when no timeoutMs is given (initialize handshake path)", async () => { + const { conn } = makeConnection(); + const promise = conn.sendRequest("initialize", {}); + // A late response well past any plausible default still resolves. + await new Promise((r) => setTimeout(r, 60)); + conn.handleMessage(frameResponse(1, { capabilities: {} })); + await expect(promise).resolves.toEqual({ capabilities: {} }); + }); + + it("clears the pending entry on timeout so it does not leak (Bug 4)", async () => { + // A timed-out request must drop its pending entry: a late response for + // that id is then a no-op (entry gone), and the connection keeps working + // (next id resolves). If the entry leaked, dispose() would later reject a + // phantom promise — the initialize handshake relies on this. + const { conn } = makeConnection(); + const promise = conn.sendRequest("initialize", {}, 50); + await expect(promise).rejects.toThrow(/timed out/); + + // id 1's entry is gone: a stray response for it resolves nothing and + // does not throw. + conn.handleMessage(frameResponse(1, { stale: true })); + + // The connection is un-wedged: a fresh request (id 2) resolves normally. + const promise2 = conn.sendRequest("second", {}, 5000); + conn.handleMessage(frameResponse(2, { ok: true })); + await expect(promise2).resolves.toEqual({ ok: true }); + + // dispose() rejects nothing extra: the only live pending entry is id 2 + // (already resolved + cleared), so disposal is a clean no-op of rejects. + // (If id 1 had leaked, this would still be fine since handleResponse + // guards on missing entries — the leak is a memory issue, not a crash; + // the assertions above prove functional correctness post-timeout.) + conn.dispose(); + }); }); |
