Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions backend/src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
type ArcadeScoreGame,
type ArcadeLeaderboard,
type ArcadeScoreResult,
type AuthFailureResponse,
type BlockAck,
type BlockList,
type ReportAck,
Expand Down Expand Up @@ -53,6 +54,33 @@ const moderationLog = childLogger({ module: "moderation" });
// Request schemas live in @metaverse/shared (single source of truth for wire shapes).
export const api = Router();

function credentialValidationFailure(issues: readonly z.core.$ZodIssue[], body: unknown): AuthFailureResponse {
const issue = issues.find((candidate) => candidate.path[0] === "username" || candidate.path[0] === "password");
if (!issue) return { error: "validation" };
const field = issue.path[0];
if (field !== "username" && field !== "password") return { error: "validation" };
if (typeof body === "object" && body !== null) {
let raw: unknown;
if (field === "username") {
if (!("username" in body)) return { error: "validation", field, reason: "required" };
raw = body.username;
} else {
if (!("password" in body)) return { error: "validation", field, reason: "required" };
raw = body.password;
}
if (typeof raw !== "string") return { error: "validation" };
if (raw.trim().length === 0) {
return { error: "validation", field, reason: "required" };
}
} else return { error: "validation" };
if (issue.code === "too_small") return { error: "validation", field, reason: "too-short" };
if (issue.code === "too_big") return { error: "validation", field, reason: "too-long" };
if (field === "username" && issue.code === "invalid_format") {
return { error: "validation", field, reason: "invalid-characters" };
}
return { error: "validation" };
}

/** Read a player's last known {x,y} from the space's Redis presence hash. */
async function presencePosition(
spaceId: string,
Expand Down Expand Up @@ -158,7 +186,7 @@ function isArcadeScoreGame(value: string): value is ArcadeScoreGame {
api.post("/signup", authLimiter, async (request, response) => {
const parsed = credentialsSchema.safeParse(request.body);
if (!parsed.success) {
response.status(400).json({ error: "validation" });
response.status(400).json(credentialValidationFailure(parsed.error.issues, request.body));
return;
}
const passwordHash = await hashSecret(parsed.data.password);
Expand All @@ -178,7 +206,7 @@ api.post("/signin", authLimiter, async (request, response) => {
const parsed = credentialsSchema.safeParse(request.body);
if (!parsed.success) {
await safelyRecordSigninOutcome(response, "validation", requestLog(response, analyticsFallbackLog));
response.status(400).json({ error: "validation" });
response.status(400).json(credentialValidationFailure(parsed.error.issues, request.body));
return;
}
const result = await pool.query<{ id: string; username: string; password_hash: string }>(
Expand Down
35 changes: 31 additions & 4 deletions backend/test/integration/api.integration.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,44 @@ describe("signup", () => {
it("reports a duplicate username as a conflict", async () => {
const username = uniqueName("su2");
expect((await api(base, "/api/v1/signup", { body: { username, password: TEST_PASSWORD } })).status).toBe(200);
const duplicate = await api(base, "/api/v1/signup", { body: { username, password: TEST_PASSWORD } });
const duplicate = await api(base, "/api/v1/signup", {
body: { username: ` ${username.toUpperCase()} `, password: TEST_PASSWORD },
});
expect(duplicate).toEqual({ status: 409, json: { error: "username-taken" } });
});

it("reports malformed signup credentials as validation, never username taken", async () => {
const short = await api(base, "/api/v1/signup", { body: { username: "ab", password: "short" } });
expect(short.status).toBe(400);
expect(short.json).toEqual({ error: "validation" });
expect(short.json).toEqual({ error: "validation", field: "username", reason: "too-short" });

expect((await api(base, "/api/v1/signup", { body: { username: "Bad Chars!", password: TEST_PASSWORD } })).status).toBe(400);
expect((await api(base, "/api/v1/signup", { body: {} })).status).toBe(400);
expect((await api(base, "/api/v1/signup", { body: { username: "Bad Chars!", password: TEST_PASSWORD } }))).toEqual({
status: 400, json: { error: "validation", field: "username", reason: "invalid-characters" },
});
expect((await api(base, "/api/v1/signup", { body: { username: "valid-name", password: "short" } }))).toEqual({
status: 400, json: { error: "validation", field: "password", reason: "too-short" },
});
expect((await api(base, "/api/v1/signup", { body: { username: "", password: TEST_PASSWORD } }))).toEqual({
status: 400, json: { error: "validation", field: "username", reason: "required" },
});
expect((await api(base, "/api/v1/signup", { body: { username: " ", password: TEST_PASSWORD } }))).toEqual({
status: 400, json: { error: "validation", field: "username", reason: "required" },
});
expect((await api(base, "/api/v1/signup", { body: { username: "valid-name", password: "" } }))).toEqual({
status: 400, json: { error: "validation", field: "password", reason: "required" },
});
expect((await api(base, "/api/v1/signup", { body: { username: "valid-name", password: " " } }))).toEqual({
status: 400, json: { error: "validation", field: "password", reason: "required" },
});
expect((await api(base, "/api/v1/signup", { body: {} }))).toEqual({
status: 400, json: { error: "validation", field: "username", reason: "required" },
});
expect((await api(base, "/api/v1/signup", { body: { username: 123, password: TEST_PASSWORD } }))).toEqual({
status: 400, json: { error: "validation" },
});
expect((await api(base, "/api/v1/signup", { body: { username: "valid-name", password: [] } }))).toEqual({
status: 400, json: { error: "validation" },
});
});

it("reports syntactically invalid signup JSON as validation", async () => {
Expand Down
14 changes: 14 additions & 0 deletions frontend/src/App.css
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,20 @@ html, body, #root {
border-color: var(--hv-leaf);
box-shadow: 0 0 0 3px rgba(95, 166, 58, 0.22);
}
.field input[aria-invalid="true"] { border-color: #b5371f; }
.field-error {
display: block;
margin-top: 5px;
color: #b5371f;
font-size: 12px;
font-weight: 600;
}
.field-hint {
display: block;
margin-top: 5px;
color: var(--hv-muted);
font-size: 12px;
}
.avatar-head { margin-top: 4px; margin-bottom: 9px; }
.console-avatars {
display: flex;
Expand Down
16 changes: 14 additions & 2 deletions frontend/src/net/auth.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,20 @@ describe("auth", () => {
});

it("distinguishes validation failures from a taken username", async () => {
fetchMock.mockReturnValue(fail(400, { error: "validation" }));
await expect(signUp("x", "y")).rejects.toThrow(/requirements/i);
fetchMock.mockReturnValue(fail(400, { error: "validation", field: "username", reason: "too-short" }));
await expect(signUp("x", "y")).rejects.toMatchObject({ field: "username", message: expect.stringMatching(/at least 3/i) });
});

it("surfaces suspension expiry truthfully", async () => {
const until = 1_800_000_000_000;
fetchMock.mockReturnValue(fail(403, { error: "suspended", until }));
await expect(signIn("alice", "password1")).rejects.toThrow(new Date(until).toLocaleString());
});

it("rejects an out-of-range suspension timestamp instead of rendering an invalid date", async () => {
fetchMock.mockReturnValue(fail(403, { error: "suspended", until: 8_640_000_000_000_001 }));
await expect(signIn("alice", "password1")).rejects.toThrow(/server is having trouble/i);
await expect(signIn("alice", "password1")).rejects.not.toThrow(/invalid date/i);
});

it("includes bounded retry guidance when auth is rate limited", async () => {
Expand Down
36 changes: 32 additions & 4 deletions frontend/src/net/auth.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** REST auth against the backend. Returns a JWT used for socket handshake + LiveKit tokens. */
import type { AuthFailureResponse, AuthTokenResponse } from "@metaverse/shared";
import { LIMITS, type AuthFailureResponse, type AuthTokenResponse } from "@metaverse/shared";
import { parseAuthFailureResponse } from "@metaverse/shared/auth-failure";
import { SERVER_URL } from "./config";
import { authTransportReason, getOperationalReporter } from "../operationalReport";
Expand Down Expand Up @@ -48,25 +48,51 @@ async function authFailure(response: Response): Promise<AuthFailureResponse | nu
function failureMessage(failure: AuthFailureResponse | null): string {
switch (failure?.error) {
case "validation":
return "Check the username and password requirements, then try again.";
if (!("field" in failure)) return "Check the username and password requirements, then try again.";
if (failure.field === "username") {
if (failure.reason === "required") return "Username is required.";
if (failure.reason === "too-short") return `Username must be at least ${LIMITS.usernameMin} characters.`;
if (failure.reason === "too-long") return `Username must be at most ${LIMITS.usernameMax} characters.`;
return "Use only letters, numbers, underscores, and hyphens.";
}
if (failure.reason === "required") return "Password is required.";
if (failure.reason === "too-short") return `Password must be at least ${LIMITS.passwordMin} characters.`;
return `Password must be at most ${LIMITS.passwordMax} characters.`;
case "username-taken":
return "That username is taken. Try signing in instead.";
case "invalid-credentials":
return "Sign in failed. Check your username and password.";
case "rate-limited":
return `Too many attempts. Try again in ${failure.retryAfterSeconds} seconds.`;
case "server-error":
return "The server is having trouble. Try again.";
case "suspended":
return `Your account is suspended until ${new Date(failure.until).toLocaleString()}.`;
default:
return "The server is having trouble. Try again.";
}
}

export class AuthError extends Error {
readonly field: "username" | "password" | undefined;

constructor(message: string, field?: "username" | "password") {
super(message);
this.name = "AuthError";
this.field = field;
}
}

/** Explicit sign-up. Does NOT sign in — the caller signs in afterwards. */
export async function signUp(username: string, password: string): Promise<void> {
const res = await postJson("/api/v1/signup", { username, password });
if (!res.ok) {
reportAuthTransport({ kind: "http", status: res.status });
throw new Error(failureMessage(await authFailure(res)));
const failure = await authFailure(res);
const field = failure?.error === "username-taken"
? "username"
: failure?.error === "validation" && "field" in failure ? failure.field : undefined;
throw new AuthError(failureMessage(failure), field);
}
}

Expand All @@ -75,7 +101,9 @@ export async function signIn(username: string, password: string): Promise<string
const res = await postJson("/api/v1/signin", { username, password });
if (!res.ok) {
reportAuthTransport({ kind: "http", status: res.status });
throw new Error(failureMessage(await authFailure(res)));
const failure = await authFailure(res);
const field = failure?.error === "validation" && "field" in failure ? failure.field : undefined;
throw new AuthError(failureMessage(failure), field);
}
const { token } = (await res.json()) as AuthTokenResponse;
return token;
Expand Down
107 changes: 103 additions & 4 deletions frontend/src/ui/Landing.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ import { render, screen, fireEvent, waitFor, cleanup } from "@testing-library/re
*/

const auth = vi.hoisted(() => ({
AuthError: class AuthError extends Error {
readonly field: "username" | "password" | undefined;
constructor(message: string, field?: "username" | "password") {
super(message);
this.field = field;
}
},
signUp: vi.fn().mockResolvedValue(undefined),
signIn: vi.fn().mockResolvedValue("test-token"),
USE_MOCK: false,
Expand Down Expand Up @@ -82,7 +89,7 @@ describe("Landing", () => {
const onEntered = vi.fn();
render(<Landing onEntered={onEntered} />);
fireEvent.change(userField(), { target: { value: "ada" } });
fireEvent.change(passField(), { target: { value: "wrongpw" } });
fireEvent.change(passField(), { target: { value: "wrongpass" } });
fireEvent.click(submitBtn());
expect((await screen.findByRole("alert")).textContent).toContain("Invalid credentials");
expect(onEntered).not.toHaveBeenCalled();
Expand All @@ -92,20 +99,112 @@ describe("Landing", () => {
auth.signIn.mockRejectedValueOnce(new Error("Too many attempts. Try again in 37 seconds."));
render(<Landing onEntered={() => {}} />);
fireEvent.change(userField(), { target: { value: "ada" } });
fireEvent.change(passField(), { target: { value: "wrongpw" } });
fireEvent.change(passField(), { target: { value: "wrongpass" } });
fireEvent.click(submitBtn());

expect((await screen.findByRole("alert")).textContent).toContain("37 seconds");
expect(submitBtn().disabled).toBe(false);
});

it("requires username and password", async () => {
it("requires username and password", () => {
render(<Landing onEntered={() => {}} />);
fireEvent.click(submitBtn());
expect((await screen.findByRole("alert")).textContent).toMatch(/required/i);
expect(screen.getByText("Username is required.")).toBeTruthy();
expect(screen.getByText("Password is required.")).toBeTruthy();
expect(auth.signIn).not.toHaveBeenCalled();
});

it("rejects a whitespace-only password as required", () => {
render(<Landing onEntered={() => {}} />);
fireEvent.change(userField(), { target: { value: "alice" } });
fireEvent.change(passField(), { target: { value: " " } });
fireEvent.click(submitBtn());

expect(screen.getByRole("alert").textContent).toBe("Password is required.");
expect(document.activeElement).toBe(passField());
expect(auth.signIn).not.toHaveBeenCalled();
});

it("shows precise local signup constraints without making a request", () => {
render(<Landing onEntered={() => {}} />);
fireEvent.click(screen.getByRole("button", { name: "Sign up" }));
fireEvent.change(userField(), { target: { value: "bad name" } });
fireEvent.change(passField(), { target: { value: "short" } });
const form = submitBtn().closest("form");
if (!form) throw new Error("no auth form rendered");
fireEvent.submit(form);
expect(screen.getByText(/only letters, numbers/i)).toBeTruthy();
expect(screen.getByText(/password must be at least 8/i)).toBeTruthy();
expect(auth.signUp).not.toHaveBeenCalled();
});

it("announces and focuses the exact short-username error without making a request", () => {
render(<Landing onEntered={() => {}} />);
fireEvent.click(screen.getByRole("button", { name: "Sign up" }));
fireEvent.change(userField(), { target: { value: "ab" } });
fireEvent.change(passField(), { target: { value: "password1" } });
fireEvent.click(submitBtn());

const alert = screen.getByRole("alert");
expect(alert.textContent).toBe("Username must be at least 3 characters.");
expect(userField().getAttribute("aria-invalid")).toBe("true");
expect(document.activeElement).toBe(userField());
expect(auth.signUp).not.toHaveBeenCalled();
expect(auth.signIn).not.toHaveBeenCalled();
});

it("places a duplicate-username response beside the username", async () => {
auth.signUp.mockRejectedValueOnce(new auth.AuthError("That username is taken.", "username"));
render(<Landing onEntered={() => {}} />);
fireEvent.click(screen.getByRole("button", { name: "Sign up" }));
fireEvent.change(userField(), { target: { value: "Taken_Name" } });
fireEvent.change(passField(), { target: { value: "password1" } });
submitBtn().focus();
expect(document.activeElement).toBe(submitBtn());
fireEvent.click(submitBtn());
expect((await screen.findByRole("alert")).textContent).toBe("That username is taken.");
expect(userField().getAttribute("aria-invalid")).toBe("true");
expect(document.activeElement).toBe(userField());
});

it("locks auth state until an in-flight signup settles", async () => {
let rejectSignup: ((reason?: unknown) => void) | undefined;
auth.signUp.mockReturnValueOnce(new Promise<void>((_resolve, reject) => {
rejectSignup = reject;
}));
render(<Landing onEntered={() => {}} />);
fireEvent.click(screen.getByRole("button", { name: "Sign up" }));
fireEvent.change(userField(), { target: { value: "taken-name" } });
fireEvent.change(passField(), { target: { value: "password1" } });
fireEvent.click(submitBtn());

await waitFor(() => expect(submitBtn().disabled).toBe(true));
expect(userField().hasAttribute("disabled")).toBe(true);
expect(passField().hasAttribute("disabled")).toBe(true);
const signInTab = screen.getByRole("button", { name: "Sign in" });
expect(signInTab.hasAttribute("disabled")).toBe(true);
fireEvent.click(signInTab);
expect(screen.getByRole("heading", { name: "Join the campus" })).toBeTruthy();

if (!rejectSignup) throw new Error("signup rejection callback was not captured");
rejectSignup(new auth.AuthError("That username is taken.", "username"));
expect((await screen.findByRole("alert")).textContent).toBe("That username is taken.");
expect(userField()).toHaveProperty("value", "taken-name");
expect(userField().hasAttribute("disabled")).toBe(false);
});

it("uses and stores the canonical normalised username", async () => {
const onEntered = vi.fn();
render(<Landing onEntered={onEntered} />);
fireEvent.click(screen.getByRole("button", { name: "Sign up" }));
fireEvent.change(userField(), { target: { value: " Ada_Lovelace " } });
fireEvent.change(passField(), { target: { value: "password1" } });
fireEvent.click(submitBtn());
await waitFor(() => expect(onEntered).toHaveBeenCalled());
expect(auth.signUp).toHaveBeenCalledWith("ada_lovelace", "password1");
expect(localStorage.getItem("displayName")).toBe("ada_lovelace");
});

it("selects a different avatar and persists it on submit", async () => {
const onEntered = vi.fn();
render(<Landing onEntered={onEntered} />);
Expand Down
Loading
Loading