mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-22 18:06:39 +00:00
df05d21fc2
## Description: Continuation from #3276 Adds the complete client-side clan UI as a Lit web component (`<clan-modal>`), a typed API client with Zod-validated responses, shared response schemas, and a reusable `<confirm-dialog>` component. ### New: `ClanModal.ts` | View | What it does | |------|-------------| | **My Clans** | Lists joined clans + pending join requests (built from `/users/@me`, no extra fetches) | | **Browse** | Search by tag (min 3 chars), paginated results, configurable per-page (10/25/50) | | **Clan Detail** | Stats, paginated + searchable member list, role badges, join/leave/request actions | | **Manage** | Edit name (max 35 chars) + description, toggle open/invite-only, disband | | **Transfer** | Leadership transfer with member selector + confirmation | | **Requests** | Approve/deny join requests (leader/officer) | | **Bans** | View and unban (leader/officer) | | **My Requests** | View and withdraw outgoing requests | ### New: `ConfirmDialog.ts` Reusable `<confirm-dialog>` Lit component — replaces native `confirm()`/`prompt()` which are blocked or broken on mobile and CrazyGames iframes. Supports danger/warning variants and an optional textarea (used for ban reasons). Fires `confirm`/`cancel` events. ### New: `ClanApi.ts` Typed API client covering all clan endpoints. Every response is Zod-validated. Auth header is always last in the spread (can't be overridden by callers). Unknown server error messages always fall back to a generic client-side string — never displayed verbatim. ### New: `ClanApiSchemas.ts` (in `src/core/`) Shared Zod schemas for clan API responses with max-length constraints on `name` (35) and `description` (200). Lives in `core/` so it can be consumed by both client code and the leaderboard table. ### Modified: `ApiSchemas.ts` - Added `clans` and `clanRequests` arrays to `UserMeResponseSchema` - Moved clan leaderboard schemas out to `ClanApiSchemas.ts` - Renamed `LeaderboardClanTagSchema` → `RequiredClanTagSchema` ### Modified: `Api.ts` - Added `invalidateUserMe()` to bust the cached `/users/me` response after mutations - Removed `fetchClanLeaderboard` (moved to `ClanApi.ts`) ### Tests - `ClanModal.test.ts` — rendering, view navigation, user actions - `ClanApiQueries.test.ts` — fetch functions, error handling, pagination - `ClanApiMutations.test.ts` — join, leave, kick, ban, promote, transfer, etc. - `ClanApiBans.test.ts` — ban/unban calls and error paths - `ClanApiSchemas.test.ts` — Zod schema validation edge cases - `LeaderboardModal.test.ts` — updated imports ## Notable design decisions - **Not-logged-in state** — shows "Sign in to join clans" instead of false "no clans" empty state - **Rate limit feedback** — reads `Retry-After` header and surfaces wait time to the user ## 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: w.o.n --------- Co-authored-by: evanpelle <evanpelle@gmail.com>
397 lines
11 KiB
TypeScript
397 lines
11 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
vi.mock("../../../src/client/Api", () => ({
|
|
getApiBase: vi.fn(() => "http://localhost:3000"),
|
|
}));
|
|
|
|
vi.mock("../../../src/client/Auth", () => ({
|
|
getAuthHeader: vi.fn(async () => "Bearer test-token"),
|
|
}));
|
|
|
|
import {
|
|
fetchClanDetail,
|
|
fetchClanLeaderboard,
|
|
fetchClanMembers,
|
|
fetchClanRequests,
|
|
fetchClans,
|
|
fetchClanStats,
|
|
} from "../../../src/client/ClanApi";
|
|
|
|
const okJson = (data: unknown, status = 200) => ({
|
|
ok: true,
|
|
status,
|
|
json: async () => data,
|
|
});
|
|
|
|
const failRes = (status: number, data: unknown = {}) => ({
|
|
ok: false,
|
|
status,
|
|
json: async () => data,
|
|
});
|
|
|
|
const mockFetch = (impl: (...args: unknown[]) => unknown) =>
|
|
vi.stubGlobal("fetch", vi.fn(impl));
|
|
|
|
beforeEach(() => {
|
|
vi.unstubAllGlobals();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
describe("fetchClanLeaderboard", () => {
|
|
const leaderboardData = {
|
|
start: "2024-01-01T00:00:00.000Z",
|
|
end: "2024-01-07T23:59:59.000Z",
|
|
clans: [],
|
|
};
|
|
|
|
it("returns parsed data on success", async () => {
|
|
mockFetch(() => okJson(leaderboardData));
|
|
const result = await fetchClanLeaderboard();
|
|
expect(result).toEqual(leaderboardData);
|
|
});
|
|
|
|
it("returns false on non-ok response", async () => {
|
|
mockFetch(() => failRes(500));
|
|
const result = await fetchClanLeaderboard();
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on network error", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("Network failure"))),
|
|
);
|
|
const result = await fetchClanLeaderboard();
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false when Zod validation fails", async () => {
|
|
mockFetch(() => okJson({ start: "bad-date", end: "bad-date", clans: [] }));
|
|
const result = await fetchClanLeaderboard();
|
|
expect(result).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("fetchClanStats", () => {
|
|
const clanStats = {
|
|
clanTag: "TEST",
|
|
games: 20,
|
|
wins: 15,
|
|
losses: 5,
|
|
stats: {
|
|
total: { wins: 15, losses: 5 },
|
|
ffa: { wins: 7, losses: 3 },
|
|
team: { wins: 4, losses: 1 },
|
|
hvn: { wins: 1, losses: 0 },
|
|
ranked: { wins: 3, losses: 1 },
|
|
"1v1": { wins: 3, losses: 1 },
|
|
},
|
|
teamTypeWL: { ffa: { wl: [15, 5] } },
|
|
teamCountWL: { "2": { wl: [10, 3] } },
|
|
};
|
|
|
|
it("returns parsed data from json.clan on success", async () => {
|
|
mockFetch(() => okJson({ clan: clanStats }));
|
|
const result = await fetchClanStats("TEST");
|
|
expect(result).toEqual(clanStats);
|
|
});
|
|
|
|
it("returns false when json.clan is missing", async () => {
|
|
mockFetch(() => okJson({}));
|
|
const result = await fetchClanStats("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on non-ok response", async () => {
|
|
mockFetch(() => failRes(404));
|
|
const result = await fetchClanStats("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on network error", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await fetchClanStats("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("fetchClanDetail", () => {
|
|
const clanInfo = {
|
|
name: "Test Clan",
|
|
tag: "TEST",
|
|
description: "We test things",
|
|
isOpen: false,
|
|
createdAt: "2024-01-01T00:00:00.000Z",
|
|
memberCount: 10,
|
|
};
|
|
|
|
it("returns parsed data on success", async () => {
|
|
mockFetch(() => okJson(clanInfo));
|
|
const result = await fetchClanDetail("TEST");
|
|
expect(result).toEqual(clanInfo);
|
|
});
|
|
|
|
it("returns false on 404", async () => {
|
|
mockFetch(() => failRes(404));
|
|
const result = await fetchClanDetail("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on network error", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("timeout"))),
|
|
);
|
|
const result = await fetchClanDetail("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false when Zod validation fails", async () => {
|
|
mockFetch(() => okJson({ tag: 123, name: null, isOpen: "not-a-boolean" }));
|
|
const result = await fetchClanDetail("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("fetchClans", () => {
|
|
const browseResponse = {
|
|
results: [],
|
|
total: 0,
|
|
page: 1,
|
|
limit: 20,
|
|
};
|
|
|
|
it("passes page and limit as query params", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(browseResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClans(undefined, 3, 10);
|
|
|
|
const calledUrl = fetchSpy.mock.calls[0]![0] as string;
|
|
const url = new URL(calledUrl);
|
|
expect(url.searchParams.get("page")).toBe("3");
|
|
expect(url.searchParams.get("limit")).toBe("10");
|
|
});
|
|
|
|
it("passes search param when provided and long enough", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(browseResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClans("abc", 1, 20);
|
|
|
|
const calledUrl = fetchSpy.mock.calls[0]![0] as string;
|
|
const url = new URL(calledUrl);
|
|
expect(url.searchParams.get("search")).toBe("abc");
|
|
});
|
|
|
|
it("omits search param for 2-char query (below min length of 3)", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(browseResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClans("AB", 1, 20);
|
|
|
|
const calledUrl = fetchSpy.mock.calls[0]![0] as string;
|
|
const url = new URL(calledUrl);
|
|
expect(url.searchParams.get("search")).toBeNull();
|
|
});
|
|
|
|
it("omits search param when too short and non-alphanumeric", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(browseResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClans("a", 1, 20);
|
|
|
|
const calledUrl = fetchSpy.mock.calls[0]![0] as string;
|
|
const url = new URL(calledUrl);
|
|
expect(url.searchParams.has("search")).toBe(false);
|
|
});
|
|
|
|
it("returns false on failure", async () => {
|
|
mockFetch(() => failRes(500));
|
|
const result = await fetchClans();
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false when Zod validation fails", async () => {
|
|
mockFetch(() => okJson({ results: "not-an-array", total: "bad" }));
|
|
const result = await fetchClans();
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on network error", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await fetchClans();
|
|
expect(result).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("fetchClanMembers", () => {
|
|
const membersResponse = {
|
|
results: [
|
|
{
|
|
publicId: "abc123",
|
|
role: "leader",
|
|
joinedAt: "2024-01-01T00:00:00.000Z",
|
|
},
|
|
],
|
|
total: 1,
|
|
page: 1,
|
|
limit: 20,
|
|
};
|
|
|
|
it("returns parsed data on success", async () => {
|
|
mockFetch(() => okJson(membersResponse));
|
|
const result = await fetchClanMembers("TEST");
|
|
expect(result).toEqual(membersResponse);
|
|
});
|
|
|
|
it("passes page and limit as query params", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(membersResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClanMembers("TEST", 3, 50);
|
|
|
|
const calledUrl = fetchSpy.mock.calls[0]![0] as string;
|
|
const url = new URL(calledUrl);
|
|
expect(url.searchParams.get("page")).toBe("3");
|
|
expect(url.searchParams.get("limit")).toBe("50");
|
|
});
|
|
|
|
it("includes the optional pendingRequests field", async () => {
|
|
mockFetch(() => okJson({ ...membersResponse, pendingRequests: 5 }));
|
|
const result = await fetchClanMembers("TEST");
|
|
expect(result).not.toBe(false);
|
|
if (result) expect(result.pendingRequests).toBe(5);
|
|
});
|
|
|
|
it("returns false on non-ok response", async () => {
|
|
mockFetch(() => failRes(500));
|
|
const result = await fetchClanMembers("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false when Zod validation fails", async () => {
|
|
mockFetch(() => okJson({ results: "not-array", total: "bad" }));
|
|
const result = await fetchClanMembers("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on network error", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await fetchClanMembers("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("sends Authorization header", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(membersResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClanMembers("TEST");
|
|
|
|
const headers = fetchSpy.mock.calls[0]![1]?.headers as Record<
|
|
string,
|
|
string
|
|
>;
|
|
expect(headers.Authorization).toBe("Bearer test-token");
|
|
});
|
|
});
|
|
|
|
describe("fetchClanRequests", () => {
|
|
const requestsResponse = {
|
|
results: [
|
|
{
|
|
publicId: "player1",
|
|
createdAt: "2024-06-01T00:00:00.000Z",
|
|
},
|
|
],
|
|
total: 1,
|
|
page: 1,
|
|
limit: 20,
|
|
};
|
|
|
|
it("returns parsed data on success", async () => {
|
|
mockFetch(() => okJson(requestsResponse));
|
|
const result = await fetchClanRequests("TEST");
|
|
expect(result).toEqual(requestsResponse);
|
|
});
|
|
|
|
it("passes page and limit as query params", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(requestsResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClanRequests("TEST", 2, 10);
|
|
|
|
const calledUrl = fetchSpy.mock.calls[0]![0] as string;
|
|
const url = new URL(calledUrl);
|
|
expect(url.searchParams.get("page")).toBe("2");
|
|
expect(url.searchParams.get("limit")).toBe("10");
|
|
});
|
|
|
|
it("returns false on non-ok response", async () => {
|
|
mockFetch(() => failRes(403));
|
|
const result = await fetchClanRequests("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false when Zod validation fails", async () => {
|
|
mockFetch(() => okJson({ results: 42, total: "bad" }));
|
|
const result = await fetchClanRequests("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("returns false on network error", async () => {
|
|
vi.stubGlobal(
|
|
"fetch",
|
|
vi.fn(() => Promise.reject(new Error("offline"))),
|
|
);
|
|
const result = await fetchClanRequests("TEST");
|
|
expect(result).toBe(false);
|
|
});
|
|
|
|
it("sends Authorization header", async () => {
|
|
const fetchSpy = vi.fn(
|
|
(_input: string | URL | Request, _init?: RequestInit) =>
|
|
Promise.resolve(okJson(requestsResponse)),
|
|
);
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
|
|
await fetchClanRequests("TEST");
|
|
|
|
const headers = fetchSpy.mock.calls[0]![1]?.headers as Record<
|
|
string,
|
|
string
|
|
>;
|
|
expect(headers.Authorization).toBe("Bearer test-token");
|
|
});
|
|
});
|