mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-07-17 19:48:45 +00:00
## Description: Makes OpenFront's anonymised names **memorable and collision-proof**. Anonymised lobbies (e.g. OFM tournaments) previously showed opaque names — the `Anon420` fallback and hash-derived civ-tribe names in the overlay — that were hard to remember and could repeat within a viewer's view, so players couldn't reliably track opponents across a match. **What changed** - **`src/core/AnonAnimals.ts`** (new): an 80-word animal bank + `anonAnimalName(slot, offset)`. Consecutive slots map to **distinct** handles — the 80 animals fill first (`round 0` → a bare `AnonWolf`), then a single round digit counts up (`AnonWolf1`, …). At a fixed offset, two slots can never collide. - **`GameServer.anonName`**: assigns each player its **join-order slot** in `allClients` (stable — late-joiners append so existing names never shift; reconnects reuse their slot) plus a **per-viewer offset**. So within any one viewer's view no two players can share a name, while different viewers still see different names for the same player (**anti-team preserved**). Replaces the old per-pair hash and removes the now-dead `anonymousUsername` helper. - **Client fallback** (`genAnonUsername`): draws a random slot through the same helper (no roster client-side → best-effort); the overlay is what guarantees uniqueness in-game. - `createRandomName` (nation/other display names) is untouched. **Desync safety — audited against #4426** #4426 fixed a desync where `PlayerExecution` seeded `removeClusters()` from `player.name()`, a value anonymize-names makes per-client. This change preserves that invariant: | Check | Result | |---|---| | Deterministic state hash reads `name()`? | **No** — `PlayerImpl.hash = simpleHash(id)·(troops+numTilesOwned) + Σ unit.hash`; `UnitImpl.hash = tile + simpleHash(type)·id` | | `removeClusters` seed | `simpleHash(player.id())` — id-based (#4426 fix), untouched | | Where `anonName` is called | only `startInfoFor` / `gameInfo` — per-viewer wire payloads, never the sim | | Archived record | uses `wireGameStartInfo` (real names) — untouched → replay/scoring unaffected | | Net new sim inputs | none — only the display string + server-side roster order | The name is display-only and the simulation is name-blind, so this cannot desync. **Testing** - New `tests/AnonAnimals.test.ts`: the no-collision guarantee (250 distinct slots → 250 distinct names), round roll-over, per-viewer variation, wire-validity/length. - Existing `tests/server/AnonymizeNames.test.ts` overlay suite still passes. - Full suite green locally (`npm test` + `npm run test:coverage`), plus `build-prod`, `eslint`, and `prettier --check .` clean. ## Please complete the following: - [x] I have added screenshots for all UI updates — _N/A, no UI changes (in-game name string only)_ - [x] I process any text displayed to the user through translateText() and I've added it to the en.json file — _N/A, generated handles are not translatable identifiers_ - [x] I have added relevant tests to the test directory — `tests/AnonAnimals.test.ts` ## Please put your Discord username so you can be contacted if a bug or regression is found: <!-- TODO: fill in Discord username -->
51 lines
1.9 KiB
TypeScript
51 lines
1.9 KiB
TypeScript
import { ANON_ANIMALS, anonAnimalName } from "../src/core/AnonAnimals";
|
|
import { UsernameSchema } from "../src/core/Schemas";
|
|
import { MAX_USERNAME_LENGTH } from "../src/core/validations/username";
|
|
|
|
describe("ANON_ANIMALS", () => {
|
|
it("has 80 unique, single-word entries", () => {
|
|
expect(ANON_ANIMALS.length).toBe(80);
|
|
expect(new Set(ANON_ANIMALS).size).toBe(ANON_ANIMALS.length);
|
|
for (const a of ANON_ANIMALS) expect(a).toMatch(/^[A-Z][a-z]+$/);
|
|
});
|
|
});
|
|
|
|
describe("anonAnimalName", () => {
|
|
it("is deterministic in (slot, offset)", () => {
|
|
expect(anonAnimalName(5, 3)).toBe(anonAnimalName(5, 3));
|
|
});
|
|
|
|
it("names the first 80 slots bare, then counts the round up", () => {
|
|
expect(anonAnimalName(0, 0)).toBe(`Anon${ANON_ANIMALS[0]}`);
|
|
expect(anonAnimalName(79, 0)).toBe(`Anon${ANON_ANIMALS[79]}`);
|
|
expect(anonAnimalName(80, 0)).toBe(`Anon${ANON_ANIMALS[0]}1`);
|
|
expect(anonAnimalName(160, 0)).toBe(`Anon${ANON_ANIMALS[0]}2`);
|
|
});
|
|
|
|
it("NEVER collides for distinct slots at a fixed offset (the guarantee)", () => {
|
|
for (const offset of [0, 7, 12345]) {
|
|
const names = new Set<string>();
|
|
for (let slot = 0; slot < 250; slot++)
|
|
names.add(anonAnimalName(slot, offset));
|
|
expect(names.size).toBe(250); // 250 distinct players → 250 distinct names
|
|
}
|
|
});
|
|
|
|
it("varies by offset (per-viewer): same slot, different viewers → different name", () => {
|
|
const slot = 3;
|
|
const names = new Set(
|
|
Array.from({ length: 25 }, (_, v) => anonAnimalName(slot, v * 101)),
|
|
);
|
|
expect(names.size).toBeGreaterThan(1);
|
|
});
|
|
|
|
it("always produces a wire-valid handle within length limits", () => {
|
|
for (let slot = 0; slot < ANON_ANIMALS.length * 3; slot++) {
|
|
const name = anonAnimalName(slot, 999);
|
|
expect(name).toMatch(/^Anon[A-Z][a-z]+\d*$/);
|
|
expect(name.length).toBeLessThanOrEqual(MAX_USERNAME_LENGTH);
|
|
expect(UsernameSchema.safeParse(name).success).toBe(true);
|
|
}
|
|
});
|
|
});
|