Skip to content
Closed
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
1 change: 0 additions & 1 deletion express-zod-api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@
"node-forge": "^1.3.3",
"snakify-ts": "^2.3.0",
"typescript": "catalog:dev",
"undici": "^7.16.0",
"zod": "catalog:dev"
},
"keywords": [
Expand Down
104 changes: 75 additions & 29 deletions express-zod-api/tests/graceful-shutdown.spec.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
import assert from "node:assert/strict";
import http from "node:http";
import https from "node:https";
import { Agent, fetch } from "undici";
import { setTimeout } from "node:timers/promises";
import { monitor } from "../src/graceful-shutdown";
import { givePort } from "../../tools/ports";
import { signCert } from "./ssl-helpers";

interface HttpResult {
res: http.IncomingMessage;
body: string;
headers: http.IncomingHttpHeaders;
}

describe("monitor()", () => {
const sslOptions = signCert();

const makeHttpServer = (handler: http.RequestListener) => {
const { promise, resolve } = Promise.withResolvers<[http.Server, number]>();
const subject = http.createServer(handler);
Expand All @@ -19,7 +26,7 @@ describe("monitor()", () => {
const makeHttpsServer = (handler: http.RequestListener) => {
const { promise, resolve } =
Promise.withResolvers<[https.Server, number]>();
const subject = https.createServer(signCert(), handler);
const subject = https.createServer(sslOptions, handler);
const port = givePort();
subject.listen(port, () => resolve([subject, port]));
return promise;
Expand All @@ -31,6 +38,47 @@ describe("monitor()", () => {
return promise;
};

const handleResponse = (
resolve: (value: HttpResult) => void,
res: http.IncomingMessage,
) => {
const chunks: Buffer[] = [];
res.on("data", (chunk) => chunks.push(chunk));
res.on("end", () =>
resolve({
res,
body: Buffer.concat(chunks).toString(),
headers: res.headers,
}),
);
};
Comment thread
pullfrog[bot] marked this conversation as resolved.

const makeHttpRequest = (
port: number,
options?: http.RequestOptions,
): Promise<HttpResult> => {
const { promise, resolve, reject } = Promise.withResolvers<HttpResult>();
const req = http.request({ ...options, port }, (res) =>
handleResponse(resolve, res),
);
req.on("error", reject);
req.end();
return promise;
};

const makeHttpsRequest = (
port: number,
options?: https.RequestOptions,
): Promise<HttpResult> => {
const { promise, resolve, reject } = Promise.withResolvers<HttpResult>();
const req = https.request({ ...sslOptions, ...options, port }, (res) =>
handleResponse(resolve, res),
);
req.on("error", reject);
req.end();
return promise;
};

test(
"shuts down HTTP server with no connections",
{ timeout: 100 },
Expand All @@ -50,9 +98,9 @@ describe("monitor()", () => {
const handler = vi.fn();
const [httpServer, port] = await makeHttpServer(handler);
const graceful = monitor([httpServer], { timeout: 150 });
void fetch(`http://localhost:${port}`, {
headers: { connection: "close" },
}).catch(vi.fn());
makeHttpRequest(port, { headers: { connection: "close" } }).catch(
vi.fn(),
);
await vi.waitFor(() => assert(handler.mock.calls.length === 1), {
interval: 30, // unstable
});
Expand All @@ -75,19 +123,19 @@ describe("monitor()", () => {
res.end("foo");
});
const graceful = monitor([httpServer], { timeout: 150 });
const request0 = fetch(`http://localhost:${port}`, {
const request0 = makeHttpRequest(port, {
headers: { connection: "close" },
});
await setTimeout(50);
void graceful.shutdown();
await setTimeout(50);
const request1 = fetch(`http://localhost:${port}`, {
const request1 = makeHttpRequest(port, {
headers: { connection: "close" },
});
await expect(request1).rejects.toThrowError();
const response0 = await request0;
expect(response0.headers.get("connection")).toBe("close");
await expect(response0.text()).resolves.toBe("foo");
expect(response0.headers.connection).toBe("close");
expect(response0.body).toBe("foo");
},
);

Expand All @@ -100,12 +148,14 @@ describe("monitor()", () => {
res.end("foo");
});
const graceful = monitor([httpServer], { timeout: 150 });
const request = fetch(`http://localhost:${port}`, { keepalive: true });
const request = makeHttpRequest(port, {
headers: { connection: "keep-alive" },
});
await setTimeout(50);
void graceful.shutdown();
const response = await request;
expect(response.headers.get("connection")).toBe("close");
await expect(response.text()).resolves.toBe("foo");
expect(response.headers.connection).toBe("close");
expect(response.body).toBe("foo");
},
);

Expand All @@ -126,19 +176,20 @@ describe("monitor()", () => {
});
const [httpServer, port] = await makeHttpServer(handler);
const graceful = monitor([httpServer], { timeout: 150 });
const dispatcher = new Agent({ pipelining: 5, keepAliveTimeout: 5e3 });
const request0 = fetch(`http://localhost:${port}`, { dispatcher });
const agent = new http.Agent({ keepAlive: true, maxSockets: 1 });
const request0 = makeHttpRequest(port, { agent });
await setTimeout(50);
void graceful.shutdown();
const request1 = fetch(`http://localhost:${port}`, { dispatcher });
const request1 = makeHttpRequest(port, { agent });
await setTimeout(50);
expect(handler).toHaveBeenCalledTimes(2);
const response0 = await request0;
expect(response0.headers.get("connection")).toBe("keep-alive");
await expect(response0.text()).resolves.toBe("foobar");
expect(response0.headers.connection).toBe("keep-alive");
expect(response0.body).toBe("foobar");
const response1 = await request1;
expect(response1.headers.get("connection")).toBe("close");
await expect(response1.text()).resolves.toBe("baz");
expect(response1.headers.connection).toBe("close");
expect(response1.body).toBe("baz");
agent.destroy();
},
);

Expand All @@ -147,9 +198,7 @@ describe("monitor()", () => {
res.end("foo");
});
const graceful = monitor([httpServer], { timeout: 150 });
await fetch(`http://localhost:${port}`, {
headers: { connection: "close" },
});
await makeHttpRequest(port, { headers: { connection: "close" } });
await setTimeout(50);
expect(graceful.sockets.size).toBe(0);
await graceful.shutdown();
Expand All @@ -165,10 +214,7 @@ describe("monitor()", () => {
{ timeout: 500 },
async () => {
const graceful = monitor([httpsServer], { timeout: 150 });
await fetch(`https://localhost:${port}`, {
dispatcher: new Agent({ connect: { rejectUnauthorized: false } }),
headers: { connection: "close" },
});
await makeHttpsRequest(port, { headers: { connection: "close" } });
await setTimeout(50);
expect(graceful.sockets.size).toBe(0);
await graceful.shutdown();
Expand All @@ -187,9 +233,9 @@ describe("monitor()", () => {
const [httpServer, port] = await makeHttpServer(spy);
expect(httpServer.listening).toBeTruthy();
const graceful = monitor([httpServer], { timeout: 500 });
void fetch(`http://localhost:${port}`, {
headers: { connection: "close" },
});
makeHttpRequest(port, { headers: { connection: "close" } }).catch(
vi.fn(),
);
await setTimeout(50);
await expect(getConnections(httpServer)).resolves.toBe(1);
void graceful.shutdown();
Expand Down
4 changes: 3 additions & 1 deletion express-zod-api/tests/ssl-helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ export const signCert = () => {
cert.setIssuer(certAttr);
cert.setExtensions(certExt);
cert.sign(keys.privateKey, forge.md.sha256.create());
const certPem = forge.pki.certificateToPem(cert);
return {
cert: forge.pki.certificateToPem(cert),
ca: certPem,
cert: certPem,
key: forge.pki.privateKeyToPem(keys.privateKey),
};
};
9 changes: 0 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion pnpm-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ minimumReleaseAgeExclude:
- typescript
- typescript-eslint
- tsdown
- undici
- unrun
- vite
- vitest
Expand Down
Loading