The Playwright suite had no linter and no formatter — only tsc. Add flat-config ESLint
(typescript-eslint, type-aware) and Prettier (2-space, matching the suite's style).
Rules keep the ones that catch real TEST bugs and drop the noise:
- no-floating-promises KEPT — an un-awaited request/assertion can let a test end before it runs,
passing vacuously. It caught one: the SSE reader loop in sse-listener is now explicitly `void`.
- no-unused-vars KEPT — caught three dead bindings (an unused adminToken fixture arg, an unused
`api` arg, an unused JPEG_MAGIC import), all removed.
- no-explicit-any OFF — all test code; `any` is the honest type for an untyped res.json() body or
a page.evaluate() return.
- no-empty-pattern OFF — Playwright's dependency-free fixtures are `async ({}, use) => {}`.
Refactor: `const BASE = process.env.E2E_FRONTEND_URL ?? '...'` was redeclared verbatim in 23
files — extracted to helpers/env.ts and imported, so a port/scheme change is one edit not a sweep.
Then `prettier --write`. Verified: eslint clean, tsc clean, prettier clean, desktop suite 210
passed / 1 skipped. (One mobile spec flaked once under retries:0 — a pre-existing cross-test
reflow-timing vector from the flakiness audit, not this change: the each-key edit is stable across
16 isolated runs and a clean full mobile re-run.)
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
190 lines
6.7 KiB
TypeScript
190 lines
6.7 KiB
TypeScript
/**
|
|
* Tiny typed wrapper around the EventSnap REST API for use inside tests.
|
|
* Used to seed data far faster than driving the UI through every join /
|
|
* upload, and to set up adversarial states (banned users, locked PINs) that
|
|
* the UI cannot reach.
|
|
*
|
|
* Auth: pass `token` on individual calls; no global state.
|
|
*/
|
|
|
|
export const ADMIN_PASSWORD = 'admin-test-pw';
|
|
|
|
export class ApiClient {
|
|
constructor(private baseUrl: string = process.env.E2E_FRONTEND_URL ?? 'http://localhost:3101') {}
|
|
|
|
private async request<T>(
|
|
method: string,
|
|
path: string,
|
|
opts: { token?: string; body?: unknown; expectedStatus?: number | number[] } = {}
|
|
): Promise<{ status: number; body: T }> {
|
|
const headers: Record<string, string> = {};
|
|
if (opts.token) headers['Authorization'] = `Bearer ${opts.token}`;
|
|
if (opts.body !== undefined) headers['Content-Type'] = 'application/json';
|
|
|
|
const res = await fetch(`${this.baseUrl}/api/v1${path}`, {
|
|
method,
|
|
headers,
|
|
body: opts.body !== undefined ? JSON.stringify(opts.body) : undefined,
|
|
});
|
|
|
|
const expected = opts.expectedStatus ?? [200, 201, 204];
|
|
const allowed = Array.isArray(expected) ? expected : [expected];
|
|
let body: unknown = undefined;
|
|
if (res.status !== 204) {
|
|
const text = await res.text();
|
|
try {
|
|
body = text.length > 0 ? JSON.parse(text) : undefined;
|
|
} catch {
|
|
body = text;
|
|
}
|
|
}
|
|
if (!allowed.includes(res.status)) {
|
|
throw new Error(
|
|
`API ${method} ${path} → ${res.status} (expected ${allowed.join('/')}). Body: ${JSON.stringify(body)}`
|
|
);
|
|
}
|
|
return { status: res.status, body: body as T };
|
|
}
|
|
|
|
// ── Auth ───────────────────────────────────────────────────────────────
|
|
async join(
|
|
displayName: string
|
|
): Promise<{ jwt: string; pin: string; user_id: string; is_new: boolean }> {
|
|
const { body } = await this.request<any>('POST', '/join', {
|
|
body: { display_name: displayName },
|
|
expectedStatus: [201],
|
|
});
|
|
return body;
|
|
}
|
|
|
|
async recover(
|
|
displayName: string,
|
|
pin: string,
|
|
opts: { expectedStatus?: number | number[] } = {}
|
|
) {
|
|
return this.request<any>('POST', '/recover', {
|
|
body: { display_name: displayName, pin },
|
|
expectedStatus: opts.expectedStatus ?? [200],
|
|
});
|
|
}
|
|
|
|
async adminLogin(password: string = ADMIN_PASSWORD): Promise<string> {
|
|
const { body } = await this.request<{ jwt: string }>('POST', '/admin/login', {
|
|
body: { password },
|
|
});
|
|
return body.jwt;
|
|
}
|
|
|
|
async logout(token: string) {
|
|
return this.request<void>('DELETE', '/session', { token, expectedStatus: [204] });
|
|
}
|
|
|
|
// ── Test-mode helpers ──────────────────────────────────────────────────
|
|
async truncate(adminToken: string) {
|
|
return this.request<void>('POST', '/admin/__truncate', {
|
|
token: adminToken,
|
|
expectedStatus: [204],
|
|
});
|
|
}
|
|
|
|
// ── Config ─────────────────────────────────────────────────────────────
|
|
async patchConfig(adminToken: string, patch: Record<string, string>) {
|
|
return this.request<void>('PATCH', '/admin/config', {
|
|
token: adminToken,
|
|
body: patch,
|
|
expectedStatus: [204],
|
|
});
|
|
}
|
|
|
|
async getConfig(adminToken: string): Promise<Record<string, string>> {
|
|
const { body } = await this.request<Record<string, string>>('GET', '/admin/config', {
|
|
token: adminToken,
|
|
});
|
|
return body;
|
|
}
|
|
|
|
// ── Host moderation ────────────────────────────────────────────────────
|
|
async listUsers(token: string) {
|
|
const { body } = await this.request<any[]>('GET', '/host/users', { token });
|
|
return body;
|
|
}
|
|
|
|
async setRole(token: string, userId: string, role: 'guest' | 'host') {
|
|
return this.request<void>('PATCH', `/host/users/${userId}/role`, {
|
|
token,
|
|
body: { role },
|
|
expectedStatus: [200, 204],
|
|
});
|
|
}
|
|
|
|
// A ban ALWAYS hides the user's uploads — the backend takes no body and ignores any
|
|
// `hide_uploads` flag (the old opt-out was removed). No per-request options.
|
|
async banUser(token: string, userId: string) {
|
|
return this.request<void>('POST', `/host/users/${userId}/ban`, {
|
|
token,
|
|
expectedStatus: [200, 204],
|
|
});
|
|
}
|
|
|
|
async unbanUser(
|
|
token: string,
|
|
userId: string,
|
|
opts: { expectedStatus?: number | number[] } = {}
|
|
) {
|
|
return this.request<void>('POST', `/host/users/${userId}/unban`, {
|
|
token,
|
|
expectedStatus: opts.expectedStatus ?? [200, 204],
|
|
});
|
|
}
|
|
|
|
/** Reset another user's PIN. Returns the plaintext PIN the host must relay once. */
|
|
async resetUserPin(
|
|
token: string,
|
|
userId: string,
|
|
opts: { expectedStatus?: number | number[] } = {}
|
|
): Promise<{ status: number; body: { pin?: string } }> {
|
|
return this.request<{ pin?: string }>('POST', `/host/users/${userId}/pin-reset`, {
|
|
token,
|
|
expectedStatus: opts.expectedStatus ?? [200],
|
|
});
|
|
}
|
|
|
|
async listPinResetRequests(token: string): Promise<any[]> {
|
|
const { body } = await this.request<any[]>('GET', '/host/pin-reset-requests', { token });
|
|
return body;
|
|
}
|
|
|
|
async closeEvent(token: string) {
|
|
return this.request<void>('POST', '/host/event/close', { token, expectedStatus: [200, 204] });
|
|
}
|
|
|
|
async openEvent(token: string) {
|
|
return this.request<void>('POST', '/host/event/open', { token, expectedStatus: [200, 204] });
|
|
}
|
|
|
|
// ── Feed ───────────────────────────────────────────────────────────────
|
|
async getFeed(token: string) {
|
|
const { body } = await this.request<any>('GET', '/feed', { token });
|
|
return body;
|
|
}
|
|
|
|
async getStats(adminToken: string) {
|
|
const { body } = await this.request<any>('GET', '/admin/stats', { token: adminToken });
|
|
return body;
|
|
}
|
|
|
|
// ── Health ─────────────────────────────────────────────────────────────
|
|
async waitForHealth(retries = 60): Promise<void> {
|
|
for (let i = 0; i < retries; i++) {
|
|
try {
|
|
const res = await fetch(`${this.baseUrl}/health`);
|
|
if (res.ok) return;
|
|
} catch {
|
|
/* keep retrying */
|
|
}
|
|
await new Promise((r) => setTimeout(r, 1000));
|
|
}
|
|
throw new Error(`Backend never became healthy at ${this.baseUrl}/health`);
|
|
}
|
|
}
|