Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/lib/pinned-http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ function pinnedHttpRequest(
&& options?.inactivityTimeoutMs === undefined;
const firstByteTimeoutMs = options?.firstByteTimeoutMs ?? legacyIdleTimeoutMs;
const inactivityTimeoutMs = options?.inactivityTimeoutMs ?? legacyIdleTimeoutMs;
const legacyFirstByteDisabled = usesLegacyIdleTimeout && legacyIdleTimeoutMs === 0;
const maxBytes = options?.maxBytes;
const headers = new Headers(options?.headers);
headers.set("host", parsed.host);
Expand Down Expand Up @@ -88,6 +89,7 @@ function pinnedHttpRequest(
};
const startFirstByteTimer = () => {
clearFirstByteTimer();
if (settled || legacyFirstByteDisabled) return;
firstByteTimer = setTimeout(
() => fail(new PinnedHttpError("first_byte_timeout", `${context} first byte timed out`)),
firstByteTimeoutMs,
Expand Down Expand Up @@ -194,8 +196,8 @@ function pinnedHttpRequest(

const requestFn = parsed.protocol === "https:" ? https.request : http.request;
req = requestFn(requestOptions, onResponse);
if (usesLegacyIdleTimeout) startFirstByteTimer();
const onAbort = () => fail(signal?.reason instanceof Error ? signal.reason : new Error("aborted"));
signal?.addEventListener("abort", onAbort, { once: true });
req.on("socket", (socket) => {
const connectedEvent = parsed.protocol === "https:" ? "secureConnect" : "connect";
if (!socket.connecting) {
Expand Down Expand Up @@ -233,6 +235,9 @@ function pinnedHttpRequest(
clearFirstByteTimer();
signal?.removeEventListener("abort", onAbort);
});
signal?.addEventListener("abort", onAbort, { once: true });
if (signal?.aborted && !settled) onAbort();
if (settled) return;
req.end(body);
});
}
Expand Down Expand Up @@ -262,4 +267,4 @@ export function pinnedHttpPost(
options?: PinnedHttpRequestOptions,
): Promise<Response> {
return pinnedHttpRequest(url, pinned, "POST", body, signal, options);
}
}
96 changes: 96 additions & 0 deletions tests/pinned-http.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
import { createServer, type Server, type Socket } from "node:net";
import { afterEach, describe, expect, test } from "bun:test";
import { PinnedHttpError, pinnedHttpGet } from "../src/lib/pinned-http";

let server: Server | undefined;
const sockets = new Set<Socket>();

function trackSocket(socket: Socket): void {
sockets.add(socket);
socket.on("error", () => { /* client timeout or cleanup can reset the peer */ });
socket.on("close", () => sockets.delete(socket));
}

async function listen(handler: (socket: Socket) => void): Promise<number> {
server = createServer((socket) => {
trackSocket(socket);
handler(socket);
});
return await new Promise<number>((resolve, reject) => {
server!.once("error", reject);
server!.listen(0, "127.0.0.1", () => {
const address = server!.address();
if (!address || typeof address === "string") {
reject(new Error("test server did not expose a TCP port"));
return;
}
resolve(address.port);
});
});
}

function request(port: number, idleTimeoutMs: number, signal?: AbortSignal): Promise<Response> {
return pinnedHttpGet(
`http://slow-header.invalid:${port}/`,
{ address: "127.0.0.1", family: 4 },
signal,
{ idleTimeoutMs },
);
}

afterEach(async () => {
for (const socket of sockets) socket.destroy();
sockets.clear();
if (server) {
const closing = server;
server = undefined;
await new Promise<void>((resolve) => closing.close(() => resolve()));
}
});

describe("pinned HTTP timeouts", () => {
test("legacy idle timeout is also an absolute response-header deadline", async () => {
const port = await listen((socket) => {
socket.write("HTTP/1.1 200 OK\r\nX-Slow: ");
const drip = setInterval(() => socket.write("x"), 20);
socket.on("close", () => clearInterval(drip));
});

const error = await request(port, 150).catch((caught: unknown) => caught);
expect(error).toBeInstanceOf(PinnedHttpError);
expect(error).toMatchObject({ code: "first_byte_timeout" });
});

test("legacy idleTimeoutMs zero still disables the header and socket timers", async () => {
const port = await listen((socket) => {
let bodyReply: ReturnType<typeof setTimeout> | undefined;
const headersReply = setTimeout(() => {
socket.write("HTTP/1.1 200 OK\r\nContent-Length: 2\r\nConnection: close\r\n\r\n");
bodyReply = setTimeout(() => socket.end("ok"), 50);
}, 50);
socket.on("close", () => {
clearTimeout(headersReply);
if (bodyReply !== undefined) clearTimeout(bodyReply);
});
});

const response = await request(port, 0);
expect(response.status).toBe(200);
expect(await response.text()).toBe("ok");
});

test("an abort between the initial check and listener installation is observed", async () => {
const port = await listen(() => { /* hold the socket until cancellation */ });
const reason = new Error("abort during listener installation");
let aborted = false;
const signal = {
get aborted() { return aborted; },
get reason() { return reason; },
addEventListener() { aborted = true; },
removeEventListener() { /* no-op test signal */ },
} as unknown as AbortSignal;

const error = await request(port, 100, signal).catch((caught: unknown) => caught);
expect(error).toBe(reason);
});
});
Loading