Implements all of unify-auth-completion (12/14 tasks done; manual
smoke + archive-time spec sync remain).
Design refinement during implementation: completeAuth supports two
response shapes via a `mode` parameter:
- mode: 'redirect' (loaders / direct browser navigation; auth.verify.tsx)
- mode: 'json' (action handlers called by imperative fetch from
client forms; api.auth.login, api.auth.register)
Both modes share createSession + safeReturnTo + Set-Cookie. JSON mode
carries `{ ok: true, step: "done", redirectTo }` (the `step` field
preserves the existing client-form check).
Why two modes: passkey ceremonies are inherently imperative
(start → browser WebAuthn API → finish), so action handlers can't
move to <Form>/useFetcher. Picking option (B) from the design grill —
the chokepoint owns destination selection while clients navigate —
required this dual shape. The 3 hardcoded client-side targets
(returnTo ?? "/", "/", "/?add-passkey=1") collapse into 1 server-side
sanitization pass (safeReturnTo) inside completeAuth.
New module:
- apps/journal/app/lib/auth/session.ts: cookie session storage
(sessionStorage, createSession, getSessionUser, destroySession)
moved from auth.server.ts. Legacy import path kept via re-exports
with @deprecated JSDoc.
- apps/journal/app/lib/auth/completion.ts: completeAuth + safeReturnTo.
- apps/journal/app/lib/auth/completion.test.ts: 10 contract tests
covering both modes, returnTo sanitization (path-relative, protocol-
relative, absolute-URL, malformed), Set-Cookie attachment, redirect
status, JSON shape.
Caller migration:
- api.auth.register.ts passkey-finish → completeAuth(json)
- api.auth.login.ts finish-passkey → completeAuth(json)
- api.auth.login.ts verify-code → completeAuth(json)
- auth.verify.tsx magic-link consumer → completeAuth(redirect)
Client form updates:
- auth.login.tsx: pass returnTo in fetch body, read result.redirectTo
on done.
- auth.register.tsx: pass returnTo: "/?add-passkey=1" for the magic-
link verify-code path (preserves the post-register passkey prompt
via the chokepoint's safeReturnTo, instead of hardcoding it
client-side).
Verified:
- pnpm typecheck && pnpm lint: green across all 15 workspaces.
- pnpm --filter @trails-cool/journal test: 126 passed.
- pnpm test:e2e auth: 4/4 passed without modification — confirms the
refactor is behaviour-preserving for the user-facing flows that
matter most (passkey register + login).
Spec delta in openspec/changes/unify-auth-completion/specs/ applies at
/opsx:archive time.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
112 lines
3.5 KiB
TypeScript
112 lines
3.5 KiB
TypeScript
// Contract tests for the completeAuth chokepoint. See ADR-0004 +
|
|
// docs/adr/0005-no-authmethod-polymorphism.md for why this exists.
|
|
|
|
import { describe, it, expect } from "vitest";
|
|
import { completeAuth } from "./completion.ts";
|
|
|
|
function reqWith(headers: Record<string, string> = {}) {
|
|
return new Request("https://localhost/whatever", { headers });
|
|
}
|
|
|
|
describe("completeAuth (mode=redirect)", () => {
|
|
it("redirects to returnTo when it's a same-origin path", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "/profile",
|
|
});
|
|
expect(res.status).toBe(302);
|
|
expect(res.headers.get("Location")).toBe("/profile");
|
|
});
|
|
|
|
it("redirects to / when returnTo is missing", async () => {
|
|
const res = await completeAuth({ userId: "u1", request: reqWith() });
|
|
expect(res.headers.get("Location")).toBe("/");
|
|
});
|
|
|
|
it("redirects to / when returnTo is null", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: null,
|
|
});
|
|
expect(res.headers.get("Location")).toBe("/");
|
|
});
|
|
|
|
it("rejects protocol-relative returnTo (//evil.com/x) → /", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "//evil.com/x",
|
|
});
|
|
expect(res.headers.get("Location")).toBe("/");
|
|
});
|
|
|
|
it("rejects absolute-URL returnTo (https://evil.com) → /", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "https://evil.com",
|
|
});
|
|
expect(res.headers.get("Location")).toBe("/");
|
|
});
|
|
|
|
it("rejects returnTo that doesn't start with / → /", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "javascript:alert(1)",
|
|
});
|
|
expect(res.headers.get("Location")).toBe("/");
|
|
});
|
|
|
|
it("attaches a __session Set-Cookie carrying the userId", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "/",
|
|
});
|
|
const setCookie = res.headers.get("Set-Cookie");
|
|
expect(setCookie).not.toBeNull();
|
|
expect(setCookie!).toMatch(/^__session=/);
|
|
// HttpOnly is required for a session cookie.
|
|
expect(setCookie!.toLowerCase()).toContain("httponly");
|
|
});
|
|
});
|
|
|
|
describe("completeAuth (mode=json)", () => {
|
|
it("returns 200 JSON with sanitized redirectTo and Set-Cookie", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "/profile",
|
|
mode: "json",
|
|
});
|
|
expect(res.status).toBe(200);
|
|
expect(res.headers.get("Content-Type")).toContain("application/json");
|
|
expect(res.headers.get("Set-Cookie")).toMatch(/^__session=/);
|
|
const body = (await res.json()) as { ok: boolean; step: string; redirectTo: string };
|
|
expect(body).toEqual({ ok: true, step: "done", redirectTo: "/profile" });
|
|
});
|
|
|
|
it("falls back to / when returnTo is unsafe (json mode)", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
returnTo: "https://evil.com",
|
|
mode: "json",
|
|
});
|
|
const body = (await res.json()) as { ok: boolean; redirectTo: string };
|
|
expect(body.redirectTo).toBe("/");
|
|
});
|
|
|
|
it("redirectTo defaults to / when no returnTo (json mode)", async () => {
|
|
const res = await completeAuth({
|
|
userId: "u1",
|
|
request: reqWith(),
|
|
mode: "json",
|
|
});
|
|
const body = (await res.json()) as { ok: boolean; redirectTo: string };
|
|
expect(body.redirectTo).toBe("/");
|
|
});
|
|
});
|