Files
OpenFrontIO/tests/server/ClientMsgRateLimiter.test.ts
T
Evan 5e7317a818 Update socket rate limiting (#3447)
## Description:

On replays, there can be a burst of traffic from hashes, so instead just
have a 2MB limit per client for the entire game. Also the winner message
can be 100s of kb on a large game with many players, so now we don't
need to put a special case for that.

## Please complete the following:

- [x] I have added screenshots for all UI updates
- [x] I process any text displayed to the user through translateText()
and I've added it to the en.json file
- [x] I have added relevant tests to the test directory
- [x] I confirm I have thoroughly tested these changes and take full
responsibility for any bugs introduced

## Please put your Discord username so you can be contacted if a bug or
regression is found:

evan
2026-03-16 20:26:56 -07:00

76 lines
2.5 KiB
TypeScript

import { describe, expect, it } from "vitest";
import { ClientMsgRateLimiter } from "../../src/server/ClientMsgRateLimiter";
const CLIENT_A = "clientA" as any;
const CLIENT_B = "clientB" as any;
const SMALL = 100;
describe("ClientMsgRateLimiter", () => {
describe("intent messages", () => {
it("allows intents within limits", () => {
const limiter = new ClientMsgRateLimiter();
expect(limiter.check(CLIENT_A, "intent", SMALL)).toBe("ok");
});
it("limits when per-second count exceeded", () => {
const limiter = new ClientMsgRateLimiter();
for (let i = 0; i < 10; i++) {
expect(limiter.check(CLIENT_A, "intent", SMALL)).toBe("ok");
}
expect(limiter.check(CLIENT_A, "intent", SMALL)).toBe("limit");
});
it("rate limits are per client", () => {
const limiter = new ClientMsgRateLimiter();
for (let i = 0; i < 10; i++) {
limiter.check(CLIENT_A, "intent", SMALL);
}
expect(limiter.check(CLIENT_B, "intent", SMALL)).toBe("ok");
});
});
describe("non-intent messages", () => {
it("does not rate-limit non-intent messages", () => {
const limiter = new ClientMsgRateLimiter();
for (let i = 0; i < 20; i++) {
expect(limiter.check(CLIENT_A, "winner", 50)).toBe("ok");
}
});
it("does not rate-limit ping messages", () => {
const limiter = new ClientMsgRateLimiter();
for (let i = 0; i < 20; i++) {
expect(limiter.check(CLIENT_A, "ping", 50)).toBe("ok");
}
});
});
describe("total bytes limit", () => {
it("kicks when cumulative bytes reach 2MB", () => {
const limiter = new ClientMsgRateLimiter();
const chunkSize = 512 * 1024; // 512KB
// Send 3 chunks = 1.5MB, should be ok
for (let i = 0; i < 3; i++) {
expect(limiter.check(CLIENT_A, "other", chunkSize)).toBe("ok");
}
// 4th chunk pushes to 2MB, should kick
expect(limiter.check(CLIENT_A, "other", chunkSize)).toBe("kick");
});
it("byte tracking is per client", () => {
const limiter = new ClientMsgRateLimiter();
const almostFull = 2 * 1024 * 1024 - 1;
expect(limiter.check(CLIENT_A, "other", almostFull)).toBe("ok");
// CLIENT_B should still be fine
expect(limiter.check(CLIENT_B, "other", 100)).toBe("ok");
});
it("kicks on bytes regardless of message type", () => {
const limiter = new ClientMsgRateLimiter();
const twoMB = 2 * 1024 * 1024;
expect(limiter.check(CLIENT_A, "intent", twoMB)).toBe("kick");
});
});
});