refactor(signal): extract rpc parse helper and validate response envelope

This commit is contained in:
Peter Steinberger
2026-02-22 15:29:43 +01:00
parent a5e2bd4eaa
commit ac3ac6a83a
2 changed files with 46 additions and 20 deletions

View File

@@ -17,7 +17,12 @@ vi.mock("../utils/fetch-timeout.js", () => ({
import { signalRpcRequest } from "./client.js";
type ErrorWithCause = Error & { cause?: unknown };
function rpcResponse(body: unknown, status = 200): Response {
if (typeof body === "string") {
return new Response(body, { status });
}
return new Response(JSON.stringify(body), { status });
}
describe("signalRpcRequest", () => {
beforeEach(() => {
@@ -27,12 +32,7 @@ describe("signalRpcRequest", () => {
it("returns parsed RPC result", async () => {
fetchWithTimeoutMock.mockResolvedValueOnce(
new Response(
JSON.stringify({ jsonrpc: "2.0", result: { version: "0.13.22" }, id: "test-id" }),
{
status: 200,
},
),
rpcResponse({ jsonrpc: "2.0", result: { version: "0.13.22" }, id: "test-id" }),
);
const result = await signalRpcRequest<{ version: string }>("version", undefined, {
@@ -43,14 +43,25 @@ describe("signalRpcRequest", () => {
});
it("throws a wrapped error when RPC response JSON is malformed", async () => {
fetchWithTimeoutMock.mockResolvedValueOnce(new Response("not-json", { status: 502 }));
fetchWithTimeoutMock.mockResolvedValueOnce(rpcResponse("not-json", 502));
const err = (await signalRpcRequest("version", undefined, {
baseUrl: "http://127.0.0.1:8080",
}).catch((error: unknown) => error)) as ErrorWithCause;
await expect(
signalRpcRequest("version", undefined, {
baseUrl: "http://127.0.0.1:8080",
}),
).rejects.toMatchObject({
message: "Signal RPC returned malformed JSON (status 502)",
cause: expect.any(SyntaxError),
});
});
expect(err).toBeInstanceOf(Error);
expect(err.message).toBe("Signal RPC returned malformed JSON (status 502)");
expect(err.cause).toBeInstanceOf(SyntaxError);
it("throws when RPC response envelope has neither result nor error", async () => {
fetchWithTimeoutMock.mockResolvedValueOnce(rpcResponse({ jsonrpc: "2.0", id: "test-id" }));
await expect(
signalRpcRequest("version", undefined, {
baseUrl: "http://127.0.0.1:8080",
}),
).rejects.toThrow("Signal RPC returned invalid response envelope (status 200)");
});
});

View File

@@ -47,6 +47,26 @@ function getRequiredFetch(): typeof fetch {
return fetchImpl;
}
function parseSignalRpcResponse<T>(text: string, status: number): SignalRpcResponse<T> {
let parsed: unknown;
try {
parsed = JSON.parse(text);
} catch (err) {
throw new Error(`Signal RPC returned malformed JSON (status ${status})`, { cause: err });
}
if (!parsed || typeof parsed !== "object") {
throw new Error(`Signal RPC returned invalid response envelope (status ${status})`);
}
const rpc = parsed as SignalRpcResponse<T>;
const hasResult = Object.hasOwn(rpc, "result");
if (!rpc.error && !hasResult) {
throw new Error(`Signal RPC returned invalid response envelope (status ${status})`);
}
return rpc;
}
export async function signalRpcRequest<T = unknown>(
method: string,
params: Record<string, unknown> | undefined,
@@ -77,12 +97,7 @@ export async function signalRpcRequest<T = unknown>(
if (!text) {
throw new Error(`Signal RPC empty response (status ${res.status})`);
}
let parsed: SignalRpcResponse<T>;
try {
parsed = JSON.parse(text) as SignalRpcResponse<T>;
} catch (err) {
throw new Error(`Signal RPC returned malformed JSON (status ${res.status})`, { cause: err });
}
const parsed = parseSignalRpcResponse<T>(text, res.status);
if (parsed.error) {
const code = parsed.error.code ?? "unknown";
const msg = parsed.error.message ?? "Signal RPC error";