test(HAI-001): add rate limiter unit tests

This commit is contained in:
Dustin Byrne
2026-03-25 20:15:51 -04:00
parent a1397d9eb7
commit 669dc3d1da
3 changed files with 361 additions and 1 deletions

View File

@@ -23,6 +23,7 @@
"@types/react-dom": "^19.0.0",
"@vitejs/plugin-react": "^4.3.0",
"typescript": "^5.7.0",
"vite": "^6.0.0"
"vite": "^6.0.0",
"vitest": "^4.1.1"
}
}

View File

@@ -0,0 +1,117 @@
import { describe, it, expect, beforeEach } from "vitest";
import { rateLimit } from "./rate-limit.js";
import type { Request, Response, NextFunction } from "express";
function mockReq(ip = "127.0.0.1"): Partial<Request> {
return { ip, socket: { remoteAddress: ip } as any };
}
function mockRes(): Partial<Response> & { _status: number; _json: any; _headers: Record<string, string> } {
const res: any = {
_status: 200,
_json: null,
_headers: {} as Record<string, string>,
setHeader(name: string, value: string) {
res._headers[name] = value;
return res;
},
status(code: number) {
res._status = code;
return res;
},
json(body: any) {
res._json = body;
return res;
},
};
return res;
}
describe("rateLimit", () => {
let middleware: ReturnType<typeof rateLimit>;
beforeEach(() => {
middleware = rateLimit({ windowMs: 60_000, max: 3 });
});
it("allows requests under the limit", () => {
const req = mockReq();
const res = mockRes();
let called = false;
const next: NextFunction = () => { called = true; };
middleware(req as Request, res as unknown as Response, next);
expect(called).toBe(true);
expect(res._headers["RateLimit-Limit"]).toBe("3");
expect(res._headers["RateLimit-Remaining"]).toBe("2");
expect(res._headers["RateLimit-Reset"]).toBeDefined();
});
it("blocks requests over the limit with 429", () => {
const req = mockReq();
let nextCalls = 0;
const next: NextFunction = () => { nextCalls++; };
// Exhaust the limit (3 allowed)
for (let i = 0; i < 3; i++) {
middleware(req as Request, mockRes() as unknown as Response, next);
}
expect(nextCalls).toBe(3);
// 4th request should be blocked
const res = mockRes();
middleware(req as Request, res as unknown as Response, next);
expect(nextCalls).toBe(3); // next not called
expect(res._status).toBe(429);
expect(res._json).toEqual({ error: "Too many requests, please try again later." });
expect(res._headers["Retry-After"]).toBeDefined();
expect(res._headers["RateLimit-Remaining"]).toBe("0");
});
it("tracks different IPs independently", () => {
const next: NextFunction = () => {};
// Exhaust limit for IP A
for (let i = 0; i < 4; i++) {
middleware(mockReq("1.1.1.1") as Request, mockRes() as unknown as Response, next);
}
// IP B should still be allowed
const res = mockRes();
let called = false;
middleware(mockReq("2.2.2.2") as Request, res as unknown as Response, () => { called = true; });
expect(called).toBe(true);
expect(res._headers["RateLimit-Remaining"]).toBe("2");
});
it("resets after window expires", async () => {
// Use a very short window
const shortMiddleware = rateLimit({ windowMs: 50, max: 1 });
const req = mockReq();
let nextCalls = 0;
const next: NextFunction = () => { nextCalls++; };
shortMiddleware(req as Request, mockRes() as unknown as Response, next);
expect(nextCalls).toBe(1);
// Should be blocked
shortMiddleware(req as Request, mockRes() as unknown as Response, next);
expect(nextCalls).toBe(1);
// Wait for window to expire
await new Promise((resolve) => setTimeout(resolve, 60));
// Should be allowed again
shortMiddleware(req as Request, mockRes() as unknown as Response, next);
expect(nextCalls).toBe(2);
});
it("uses custom message", () => {
const mw = rateLimit({ max: 0, message: "Slow down!" });
const res = mockRes();
mw(mockReq() as Request, res as unknown as Response, () => {});
expect(res._json).toEqual({ error: "Slow down!" });
});
});