From 72ad83eb1a0ab310656d72d9bac3dfdb9fab0c00 Mon Sep 17 00:00:00 2001 From: Anuraj Jit Saikia Date: Sat, 29 Aug 2026 16:00:31 +0530 Subject: [PATCH] fix(auth): show precise signup validation errors --- backend/src/api.ts | 32 +++++- .../test/integration/api.integration.test.ts | 35 +++++- frontend/src/App.css | 14 +++ frontend/src/net/auth.test.ts | 16 ++- frontend/src/net/auth.ts | 36 +++++- frontend/src/ui/Landing.test.tsx | 107 +++++++++++++++++- frontend/src/ui/Landing.tsx | 85 +++++++++++--- shared/src/auth-failure.test.ts | 10 ++ shared/src/auth-failure.ts | 30 ++++- shared/src/rest.test.ts | 8 ++ shared/src/rest.ts | 47 +++++--- 11 files changed, 373 insertions(+), 47 deletions(-) diff --git a/backend/src/api.ts b/backend/src/api.ts index 55b3a87..701a902 100644 --- a/backend/src/api.ts +++ b/backend/src/api.ts @@ -15,6 +15,7 @@ import { type ArcadeScoreGame, type ArcadeLeaderboard, type ArcadeScoreResult, + type AuthFailureResponse, type BlockAck, type BlockList, type ReportAck, @@ -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, @@ -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); @@ -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 }>( diff --git a/backend/test/integration/api.integration.test.ts b/backend/test/integration/api.integration.test.ts index 3604a21..8e29106 100644 --- a/backend/test/integration/api.integration.test.ts +++ b/backend/test/integration/api.integration.test.ts @@ -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 () => { diff --git a/frontend/src/App.css b/frontend/src/App.css index bbc50d8..d57a52e 100644 --- a/frontend/src/App.css +++ b/frontend/src/App.css @@ -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; diff --git a/frontend/src/net/auth.test.ts b/frontend/src/net/auth.test.ts index cbc914e..a0c06e7 100644 --- a/frontend/src/net/auth.test.ts +++ b/frontend/src/net/auth.test.ts @@ -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 () => { diff --git a/frontend/src/net/auth.ts b/frontend/src/net/auth.ts index 0d14125..e470b43 100644 --- a/frontend/src/net/auth.ts +++ b/frontend/src/net/auth.ts @@ -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"; @@ -48,7 +48,16 @@ async function authFailure(response: Response): Promise { 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); } } @@ -75,7 +101,9 @@ export async function signIn(username: string, password: string): Promise ({ + 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, @@ -82,7 +89,7 @@ describe("Landing", () => { const onEntered = vi.fn(); render(); 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(); @@ -92,20 +99,112 @@ describe("Landing", () => { auth.signIn.mockRejectedValueOnce(new Error("Too many attempts. Try again in 37 seconds.")); render( {}} />); 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( {}} />); 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( {}} />); + 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( {}} />); + 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( {}} />); + 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( {}} />); + 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((_resolve, reject) => { + rejectSignup = reject; + })); + render( {}} />); + 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(); + 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(); diff --git a/frontend/src/ui/Landing.tsx b/frontend/src/ui/Landing.tsx index 18db4e1..50153c5 100644 --- a/frontend/src/ui/Landing.tsx +++ b/frontend/src/ui/Landing.tsx @@ -1,6 +1,7 @@ -import { useRef, useState } from "react"; +import { useEffect, useRef, useState } from "react"; import { ArrowRight } from "lucide-react"; -import { signUp, signIn, USE_MOCK } from "../net/auth"; +import { LIMITS, USERNAME_PATTERN } from "@metaverse/shared"; +import { AuthError, signUp, signIn, USE_MOCK } from "../net/auth"; import { CHARS, resolveCharKey } from "../game/chars"; import Logo from "./Logo"; import CampusHero from "./CampusHero"; @@ -27,13 +28,25 @@ export default function Landing({ ); const [busy, setBusy] = useState(false); const [error, setError] = useState(null); + const [fieldErrors, setFieldErrors] = useState<{ username: string | null; password: string | null }>({ + username: null, + password: null, + }); const userInputRef = useRef(null); + const passwordInputRef = useRef(null); + + useEffect(() => { + if (busy) return; + if (fieldErrors.username) userInputRef.current?.focus(); + else if (fieldErrors.password) passwordInputRef.current?.focus(); + }, [busy, fieldErrors]); const submit = async (e?: React.FormEvent) => { e?.preventDefault(); setError(null); - const u = username.trim(); + setFieldErrors({ username: null, password: null }); + const u = username.trim().toLowerCase(); localStorage.setItem("avatar", avatar); if (USE_MOCK) { @@ -44,7 +57,18 @@ export default function Landing({ return; } - if (!u || !password) return setError("Username and password are required."); + const nextErrors: { username: string | null; password: string | null } = { username: null, password: null }; + if (!u) nextErrors.username = "Username is required."; + else if (u.length < LIMITS.usernameMin) nextErrors.username = `Username must be at least ${LIMITS.usernameMin} characters.`; + else if (u.length > LIMITS.usernameMax) nextErrors.username = `Username must be at most ${LIMITS.usernameMax} characters.`; + else if (!USERNAME_PATTERN.test(u)) nextErrors.username = "Use only letters, numbers, underscores, and hyphens."; + if (!password.trim()) nextErrors.password = "Password is required."; + else if (password.length < LIMITS.passwordMin) nextErrors.password = `Password must be at least ${LIMITS.passwordMin} characters.`; + else if (password.length > LIMITS.passwordMax) nextErrors.password = `Password must be at most ${LIMITS.passwordMax} characters.`; + if (nextErrors.username || nextErrors.password) { + setFieldErrors(nextErrors); + return; + } setBusy(true); try { if (mode === "signup") await signUp(u, password); @@ -53,7 +77,10 @@ export default function Landing({ localStorage.setItem("displayName", u); onEntered(); } catch (err) { - setError(err instanceof Error ? err.message : "Could not connect."); + if (err instanceof AuthError && err.field) { + setFieldErrors({ username: err.field === "username" ? err.message : null, password: err.field === "password" ? err.message : null }); + } + else setError(err instanceof Error ? err.message : "Could not connect."); } finally { setBusy(false); } @@ -96,7 +123,7 @@ export default function Landing({ -
+

{USE_MOCK ? "Pick your character" @@ -110,9 +137,11 @@ export default function Landing({