mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-07-10 15:54:48 +00:00
a7f992e9b0
Restructure the single src/ tree into an npm-workspaces monorepo under
packages/, rename core -> engine, extract a types-only core-public layer,
and break the pre-existing engine -> client dependency cycle.
Structure (packages/):
core-public public API/wire schemas + shared enums (clean leaf)
shared framework-agnostic helpers (clean leaf)
engine deterministic simulation (was src/core)
client rendering/UI (was src/client)
server coordination (was src/server)
Dependency DAG: engine -> {core-public, shared}; client -> {core-public,
shared, engine}; server -> {core-public, engine}.
- npm workspaces: root package.json workspaces + per-package package.json;
tsconfig.base.json holds shared options + path aliases
(core-public/* shared/* engine/* client/* server/*) resolved uniformly by
tsc, Vite (resolve.tsconfigPaths), Vitest, and tsx. Lockfile regenerated.
- core-public: moved Schemas/ApiSchemas/CosmeticSchemas/StatsSchemas/
ClanApiSchemas/WorkerSchemas/Base64/PatternDecoder; extracted the enums
(GameTypes), GameEvent type, emoji table, and GraphicsOverrides schema.
Engine re-exports the moved enums/types so existing imports keep working.
- Broke engine -> client cycle:
- renderNumber/renderTroops -> shared/format
- NameBoxCalculator moved into engine
- username validation returns translation key + params; client translates
- applyStateUpdate moved to client (operates on the render-only PlayerState)
- Config/UnitGrid/execution-Util/GameImpl now use structural read
interfaces (engine/game/ReadViews: PlayerLike/UnitLike/GameLike) instead
of importing client view classes; client imports view classes from a new
client/view barrel; deleted the engine/game/GameView re-export shim.
- Build/deploy updated: vite.config, index.html, eslint, Dockerfile
(copies packages/ + tsconfig.base.json before npm ci), .vscode, tests.
Verified: tsc --noEmit clean; 1364 + 65 tests pass; production vite build
succeeds; engine has zero client/server imports; core-public and shared are
dependency leaves.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
424 lines
14 KiB
TypeScript
424 lines
14 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
vi.mock("client/Api", () => ({
|
|
getApiBase: vi.fn(() => "http://localhost:3000"),
|
|
}));
|
|
|
|
vi.mock("client/Auth", () => ({
|
|
getAuthHeader: vi.fn(async () => "Bearer test-token"),
|
|
}));
|
|
|
|
import {
|
|
approveClanRequest,
|
|
demoteMember,
|
|
denyClanRequest,
|
|
disbandClan,
|
|
joinClan,
|
|
kickMember,
|
|
leaveClan,
|
|
promoteMember,
|
|
transferLeadership,
|
|
updateClan,
|
|
withdrawClanRequest,
|
|
} from "client/ClanApi";
|
|
|
|
const okJson = (data: unknown, status = 200) => ({
|
|
ok: true,
|
|
status,
|
|
json: async () => data,
|
|
});
|
|
|
|
const failRes = (status: number, data: unknown = {}) => ({
|
|
ok: false,
|
|
status,
|
|
headers: new Headers(),
|
|
json: async () => data,
|
|
});
|
|
|
|
const mockFetch = (impl: (...args: unknown[]) => unknown) =>
|
|
vi.stubGlobal("fetch", vi.fn(impl));
|
|
|
|
beforeEach(() => {
|
|
vi.unstubAllGlobals();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
describe("joinClan", () => {
|
|
it("returns { status: 'joined' } on success", async () => {
|
|
mockFetch(() => okJson({ status: "joined" }));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ status: "joined" });
|
|
});
|
|
|
|
it("returns { status: 'requested' } for open-request clans", async () => {
|
|
mockFetch(() => okJson({ status: "requested" }));
|
|
const result = await joinClan("CLSD");
|
|
expect(result).toEqual({ status: "requested" });
|
|
});
|
|
|
|
it("returns error key on 409 (already member)", async () => {
|
|
mockFetch(() => failRes(409));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_already_member" });
|
|
});
|
|
|
|
it("returns request pending error on 409 when message contains 'request'", async () => {
|
|
mockFetch(() => failRes(409, { message: "join request already pending" }));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_request_pending" });
|
|
});
|
|
|
|
it("returns rate limited error on 429", async () => {
|
|
mockFetch(() => failRes(429));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_rate_limited_generic" });
|
|
});
|
|
|
|
it("returns generic error on other non-ok response", async () => {
|
|
mockFetch(() => failRes(400, { message: "clan is full" }));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("gone"))),
|
|
);
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
|
|
it("returns banned error with reason on 403 BANNED with reason", async () => {
|
|
mockFetch(() => failRes(403, { code: "BANNED", reason: "toxic behavior" }));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({
|
|
error: "clan_modal.error_banned_reason",
|
|
reason: "toxic behavior",
|
|
});
|
|
});
|
|
|
|
it("returns banned error without reason on 403 BANNED with null reason", async () => {
|
|
mockFetch(() => failRes(403, { code: "BANNED", reason: null }));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_banned" });
|
|
});
|
|
|
|
it("returns generic 403 error when code is not BANNED", async () => {
|
|
mockFetch(() => failRes(403, { message: "not authorized" }));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns fallback error when 403 body has no code or message", async () => {
|
|
mockFetch(() => failRes(403, {}));
|
|
const result = await joinClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
});
|
|
|
|
describe("leaveClan", () => {
|
|
it("returns true on success", async () => {
|
|
mockFetch(() => okJson({}));
|
|
const result = await leaveClan("TEST");
|
|
expect(result).toBe(true);
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(400, { message: "not a member" }));
|
|
const result = await leaveClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns generic error when no message in failure body", async () => {
|
|
mockFetch(() => failRes(500, {}));
|
|
const result = await leaveClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await leaveClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("kickMember", () => {
|
|
it("returns true on success", async () => {
|
|
mockFetch(() => okJson({}));
|
|
const result = await kickMember("TEST", "player-1");
|
|
expect(result).toBe(true);
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(403, { message: "not authorized" }));
|
|
const result = await kickMember("TEST", "player-1");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await kickMember("TEST", "player-1");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("promoteMember", () => {
|
|
it("returns true on success", async () => {
|
|
mockFetch(() => okJson({}));
|
|
const result = await promoteMember("TEST", "player-2");
|
|
expect(result).toBe(true);
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(403, { message: "insufficient permissions" }));
|
|
const result = await promoteMember("TEST", "player-2");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await promoteMember("TEST", "player-2");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("demoteMember", () => {
|
|
it("returns true on success", async () => {
|
|
mockFetch(() => okJson({}));
|
|
const result = await demoteMember("TEST", "player-3");
|
|
expect(result).toBe(true);
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(400, { message: "cannot demote leader" }));
|
|
const result = await demoteMember("TEST", "player-3");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await demoteMember("TEST", "player-3");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("transferLeadership", () => {
|
|
it("returns true on success and POSTs to /transfer with the target", async () => {
|
|
const fetchMock = vi.fn(() => okJson({}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const result = await transferLeadership("TEST", "player-4");
|
|
expect(result).toBe(true);
|
|
const [url, init] = fetchMock.mock.calls[0] as unknown as [
|
|
string,
|
|
{ method: string; body: string },
|
|
];
|
|
expect(url).toContain("/clans/TEST/transfer");
|
|
expect(init.method).toBe("POST");
|
|
expect(JSON.parse(init.body)).toEqual({ targetPublicId: "player-4" });
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(403, { message: "not the leader" }));
|
|
const result = await transferLeadership("TEST", "player-4");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await transferLeadership("TEST", "player-4");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("disbandClan", () => {
|
|
it("returns true on success and uses DELETE", async () => {
|
|
const fetchMock = vi.fn(() => okJson({}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const result = await disbandClan("TEST");
|
|
expect(result).toBe(true);
|
|
const [url, init] = fetchMock.mock.calls[0] as unknown as [
|
|
string,
|
|
{ method: string },
|
|
];
|
|
expect(url).toContain("/clans/TEST");
|
|
expect(init.method).toBe("DELETE");
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(403, { message: "not the leader" }));
|
|
const result = await disbandClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await disbandClan("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
|
|
it("encodes the tag in the URL path", async () => {
|
|
const fetchMock = vi.fn(() => okJson({}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
await disbandClan("A B");
|
|
const [url] = fetchMock.mock.calls[0] as unknown as [string];
|
|
expect(url).toContain("/clans/A%20B");
|
|
});
|
|
});
|
|
|
|
describe("withdrawClanRequest", () => {
|
|
it("returns true on success and POSTs to /requests/withdraw", async () => {
|
|
const fetchMock = vi.fn(() => okJson({}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const result = await withdrawClanRequest("TEST");
|
|
expect(result).toBe(true);
|
|
const [url, init] = fetchMock.mock.calls[0] as unknown as [
|
|
string,
|
|
{ method: string },
|
|
];
|
|
expect(url).toContain("/clans/TEST/requests/withdraw");
|
|
expect(init.method).toBe("POST");
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(404, { message: "no pending request" }));
|
|
const result = await withdrawClanRequest("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await withdrawClanRequest("TEST");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("approveClanRequest", () => {
|
|
it("returns true on success and POSTs to /requests/approve with the target", async () => {
|
|
const fetchMock = vi.fn(() => okJson({}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const result = await approveClanRequest("TEST", "applicant-1");
|
|
expect(result).toBe(true);
|
|
const [url, init] = fetchMock.mock.calls[0] as unknown as [
|
|
string,
|
|
{ method: string; body: string },
|
|
];
|
|
expect(url).toContain("/clans/TEST/requests/approve");
|
|
expect(init.method).toBe("POST");
|
|
expect(JSON.parse(init.body)).toEqual({ targetPublicId: "applicant-1" });
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(403, { message: "insufficient role" }));
|
|
const result = await approveClanRequest("TEST", "applicant-1");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await approveClanRequest("TEST", "applicant-1");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("denyClanRequest", () => {
|
|
it("returns true on success and POSTs to /requests/deny with the target", async () => {
|
|
const fetchMock = vi.fn(() => okJson({}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const result = await denyClanRequest("TEST", "applicant-2");
|
|
expect(result).toBe(true);
|
|
const [url, init] = fetchMock.mock.calls[0] as unknown as [
|
|
string,
|
|
{ method: string; body: string },
|
|
];
|
|
expect(url).toContain("/clans/TEST/requests/deny");
|
|
expect(init.method).toBe("POST");
|
|
expect(JSON.parse(init.body)).toEqual({ targetPublicId: "applicant-2" });
|
|
});
|
|
|
|
it("returns error object on failure", async () => {
|
|
mockFetch(() => failRes(404, { message: "no such request" }));
|
|
const result = await denyClanRequest("TEST", "applicant-2");
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await denyClanRequest("TEST", "applicant-2");
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|
|
|
|
describe("updateClan", () => {
|
|
const validClan = {
|
|
name: "Updated Clan",
|
|
tag: "TEST",
|
|
description: "New description",
|
|
isOpen: false,
|
|
createdAt: "2024-01-01T00:00:00.000Z",
|
|
memberCount: 10,
|
|
};
|
|
|
|
it("returns parsed ClanInfo on success and uses PATCH", async () => {
|
|
const fetchMock = vi.fn(() => okJson(validClan));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const result = await updateClan("TEST", { name: "Updated Clan" });
|
|
expect(result).toEqual(validClan);
|
|
const [url, init] = fetchMock.mock.calls[0] as unknown as [
|
|
string,
|
|
{ method: string; body: string },
|
|
];
|
|
expect(url).toContain("/clans/TEST");
|
|
expect(init.method).toBe("PATCH");
|
|
expect(JSON.parse(init.body)).toEqual({ name: "Updated Clan" });
|
|
});
|
|
|
|
it("returns error object on non-ok response", async () => {
|
|
mockFetch(() => failRes(403, { message: "not authorized" }));
|
|
const result = await updateClan("TEST", { isOpen: true });
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns error object when Zod validation fails on 200 body", async () => {
|
|
mockFetch(() => okJson({ tag: 123, name: null }));
|
|
const result = await updateClan("TEST", { description: "x" });
|
|
expect(result).toEqual({ error: "clan_modal.error_failed" });
|
|
});
|
|
|
|
it("returns network error on fetch failure", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await updateClan("TEST", { name: "x" });
|
|
expect(result).toEqual({ error: "clan_modal.error_network" });
|
|
});
|
|
});
|