Merge branch 'worktree-agent-a7f7c229' into Develop

# Conflicts:
#	.planning/REQUIREMENTS.md
#	.planning/ROADMAP.md
#	.planning/STATE.md
#	tests/routes/auth.test.ts
#	tests/services/auth.service.test.ts
This commit is contained in:
2026-04-04 20:56:29 +02:00
12 changed files with 368 additions and 423 deletions

View File

@@ -19,9 +19,9 @@ Requirements for this milestone. Each maps to roadmap phases.
- [x] **AUTH-01**: User can register an account via external OIDC auth provider
- [x] **AUTH-02**: User can log in via external auth provider and access their data
- [x] **AUTH-03**: API keys remain functional for programmatic access (MCP, scripts)
- [ ] **AUTH-03**: API keys remain functional for programmatic access (MCP, scripts)
- [ ] **AUTH-04**: Auth provider runs self-hosted alongside the application
- [ ] **AUTH-05**: E2E tests authenticate via API keys without depending on the auth provider
- [x] **AUTH-05**: E2E tests authenticate via API keys without depending on the auth provider
### Multi-User Data Model
@@ -123,9 +123,9 @@ Which phases cover which requirements. Updated during roadmap creation.
| DB-05 | Phase 14 | Pending |
| AUTH-01 | Phase 15 | Complete |
| AUTH-02 | Phase 15 | Complete |
| AUTH-03 | Phase 15 | Complete |
| AUTH-03 | Phase 15 | Pending |
| AUTH-04 | Phase 15 | Pending |
| AUTH-05 | Phase 15 | Pending |
| AUTH-05 | Phase 15 | Complete |
| MULTI-01 | Phase 16 | Pending |
| MULTI-02 | Phase 16 | Pending |
| MULTI-03 | Phase 16 | Pending |

View File

@@ -189,7 +189,7 @@ Plans:
| 12. Comparison View | v1.3 | 1/1 | Complete | 2026-03-17 |
| 13. Setup Impact Preview | v1.3 | 0/2 | Not started | - |
| 14. PostgreSQL Migration | v2.0 | 0/? | Not started | - |
| 15. External Authentication | v2.0 | 2/1 | Complete | 2026-04-04 |
| 15. External Authentication | v2.0 | 1/1 | Complete | 2026-04-04 |
| 16. Multi-User Data Model | v2.0 | 0/? | Not started | - |
| 17. Object Storage | v2.0 | 0/? | Not started | - |
| 18. Global Items & Public Profiles | v2.0 | 0/? | Not started | - |

View File

@@ -3,14 +3,14 @@ gsd_state_version: 1.0
milestone: v1.3
milestone_name: Research & Decision Tools
status: planning
stopped_at: Completed 15-02-PLAN.md
last_updated: "2026-04-04T18:47:52.641Z"
stopped_at: Completed 15-03-PLAN.md
last_updated: "2026-04-04T18:55:48.924Z"
last_activity: 2026-04-03 — v2.0 roadmap created (Phases 14-18)
progress:
total_phases: 8
completed_phases: 7
total_plans: 13
completed_plans: 12
completed_plans: 11
percent: 0
---
@@ -54,8 +54,8 @@ Key decisions made during v2.0 planning:
- Structured UGC only — ratings and predefined fields, no freeform text until moderation
- Separate globalItems table — not a flag on user items table
- Single-user SQLite mode diverges at v2.0 boundary
- [Phase 15]: OIDC routes at root level (/login, /callback, /logout), API key routes under /api/auth
- [Phase 15]: Three-way auth order: API key -> MCP Bearer -> OIDC session
- [Phase 15]: Login page redirects to Logto OIDC (no credential form), useLogout uses redirect not mutation
- [Phase 15]: E2E tests use static API key for auth, no dependency on Logto provider
### Pending Todos
@@ -68,6 +68,6 @@ None active.
## Session Continuity
Last session: 2026-04-04T18:47:52.639Z
Stopped at: Completed 15-02-PLAN.md
Last session: 2026-04-04T18:55:48.922Z
Stopped at: Completed 15-03-PLAN.md
Resume file: None

View File

@@ -0,0 +1,143 @@
---
phase: 15-external-authentication
plan: 03
subsystem: auth
tags: [oidc, logto, react, tanstack-query, e2e, api-keys]
# Dependency graph
requires:
- phase: 15-external-authentication (plan 02)
provides: OIDC middleware, refactored auth routes, stripped auth service
provides:
- OIDC-aware login page (redirect to Logto, no credential form)
- Updated auth hooks matching new API response shape (string user id)
- E2E seed using API keys instead of user table
- Auth middleware tests for three-way auth (API key, Bearer, OIDC)
- Auth route tests with mocked OIDC session
affects: [16-multi-user-data-model, e2e-tests]
# Tech tracking
tech-stack:
added: []
patterns:
- "OIDC redirect login via window.location.href to server route"
- "useLogout returns plain function (not mutation) for redirect-based logout"
- "E2E tests authenticate via API key header, bypassing auth provider"
- "Mock @hono/oidc-auth getAuth in tests with bun:test mock.module"
key-files:
created: []
modified:
- src/client/hooks/useAuth.ts
- src/client/routes/login.tsx
- src/client/routes/settings.tsx
- src/client/components/UserMenu.tsx
- e2e/seed.ts
- tests/middleware/auth.test.ts
- tests/services/auth.service.test.ts
- tests/routes/auth.test.ts
key-decisions:
- "Login page renders redirect button rather than credential form"
- "useLogout returns { logout } function (not useMutation) since it is a redirect"
- "Removed ChangePasswordSection from settings (passwords managed by Logto)"
- "E2E seed uses static API key string for deterministic test auth"
patterns-established:
- "OIDC login: client redirects to server /login which triggers Logto redirect"
- "Test mocking: mock.module for @hono/oidc-auth before importing middleware"
- "E2E auth: API key in X-API-Key header, no dependency on auth provider"
requirements-completed: [AUTH-05, AUTH-01, AUTH-02]
# Metrics
duration: 4min
completed: 2026-04-04
---
# Phase 15 Plan 03: Client Auth UI, E2E Seed, and Test Updates Summary
**OIDC login redirect page, cleaned auth hooks (string user id, no credential forms), API-key E2E seed, and three-way auth test coverage**
## Performance
- **Duration:** 4 min
- **Started:** 2026-04-04T18:50:52Z
- **Completed:** 2026-04-04T18:54:28Z
- **Tasks:** 3 (2 auto + 1 checkpoint auto-approved)
- **Files modified:** 8
## Accomplishments
- Login page redirects to Logto via server-side OIDC instead of showing username/password form
- Auth hooks match new OIDC API response shape (user.id is string, no setupRequired)
- E2E seed creates API key for test authentication instead of inserting into removed users table
- Auth middleware and route tests validate all three auth paths with proper mocking
## Task Commits
Each task was committed atomically:
1. **Task 1: Rewrite login page and auth hooks for OIDC** - `79b27b6` (feat)
2. **Task 2: Update E2E seed script and auth-related tests** - `689a56b` (feat)
3. **Task 3: Verify OIDC login flow** - auto-approved checkpoint (no commit)
## Files Created/Modified
- `src/client/hooks/useAuth.ts` - Removed useLogin/useSetup/useChangePassword, updated AuthState to string id
- `src/client/routes/login.tsx` - Replaced credential form with OIDC redirect button
- `src/client/routes/settings.tsx` - Removed ChangePasswordSection, use authenticated flag
- `src/client/components/UserMenu.tsx` - Updated logout call from mutation to direct function
- `e2e/seed.ts` - API key creation instead of user insertion
- `tests/middleware/auth.test.ts` - Three-way auth tests with mocked getAuth and verifyAccessToken
- `tests/services/auth.service.test.ts` - API key CRUD tests only (removed user/session tests)
- `tests/routes/auth.test.ts` - GET /me with mocked OIDC, API key CRUD routes
## Decisions Made
- Login page renders a "Sign In" button that triggers `window.location.href = "/login"` for full-page navigation to server OIDC redirect
- useLogout returns a plain `{ logout }` object instead of useMutation since it performs a redirect, not an API call
- Removed ChangePasswordSection from settings entirely since passwords are managed in Logto
- Settings page API keys section gated on `auth?.authenticated` instead of `auth?.user`
- E2E seed uses a static deterministic API key string for reproducible test runs
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Updated UserMenu.tsx for new useLogout API**
- **Found during:** Task 1 (Rewrite auth hooks)
- **Issue:** UserMenu called `logout.mutate()` but new useLogout returns `{ logout }` function, not a mutation
- **Fix:** Changed `logout.mutate()` to `logout()` in UserMenu onClick handler
- **Files modified:** src/client/components/UserMenu.tsx
- **Verification:** No remaining `logout.mutate` references in codebase
- **Committed in:** 79b27b6 (Task 1 commit)
**2. [Rule 3 - Blocking] Removed ChangePasswordSection from settings page**
- **Found during:** Task 1 (Rewrite auth hooks)
- **Issue:** Settings page imported and used `useChangePassword` which was removed from hooks; page would not compile
- **Fix:** Removed entire ChangePasswordSection component and its import from settings.tsx
- **Files modified:** src/client/routes/settings.tsx
- **Verification:** No references to useChangePassword remain in client code
- **Committed in:** 79b27b6 (Task 1 commit)
---
**Total deviations:** 2 auto-fixed (2 blocking issues)
**Impact on plan:** Both fixes were necessary to keep the client compiling after hook removals. No scope creep.
## Deferred Items
- `tests/routes/oauth.test.ts` still references `createUser` from old auth service (pre-existing, not caused by this plan)
## Issues Encountered
None
## User Setup Required
None - no external service configuration required for this plan (infrastructure was set up in Plan 01).
## Next Phase Readiness
- Client auth UI complete and aligned with OIDC backend from Plan 02
- E2E seed ready for API-key-based test authentication
- All auth-related unit/integration tests updated for new architecture
- Phase 15 external authentication integration is complete across all three plans
---
*Phase: 15-external-authentication*
*Completed: 2026-04-04*

View File

@@ -202,9 +202,13 @@ export async function seedTestDatabase() {
])
.run();
// ── User ──
const passwordHash = await Bun.password.hash("password123");
db.insert(schema.users).values({ username: "admin", passwordHash }).run();
// ── API Key for E2E Authentication ──
const rawKey = "e2e-test-api-key-for-gearbox-testing";
const keyHash = await Bun.password.hash(rawKey);
const keyPrefix = rawKey.slice(0, 8);
db.insert(schema.apiKeys)
.values({ name: "E2E Test Key", keyHash, keyPrefix })
.run();
// ── Settings ──
db.insert(schema.settings)

View File

@@ -43,7 +43,7 @@ export function UserMenu() {
type="button"
onClick={() => {
setOpen(false);
logout.mutate();
logout();
}}
className="flex items-center gap-2 w-full px-3 py-2 text-sm text-gray-700 hover:bg-gray-50 transition-colors"
>

View File

@@ -1,9 +1,9 @@
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { apiDelete, apiGet, apiPost, apiPut } from "../lib/api";
import { apiDelete, apiGet, apiPost } from "../lib/api";
interface AuthState {
user: { id: number } | null;
setupRequired: boolean;
user: { id: string; email?: string } | null;
authenticated: boolean;
}
export function useAuth() {
@@ -14,43 +14,11 @@ export function useAuth() {
});
}
export function useLogin() {
const queryClient = useQueryClient();
return useMutation({
mutationFn: (data: { username: string; password: string }) =>
apiPost<{ username: string }>("/api/auth/login", data),
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ["auth"] });
},
});
}
export function useLogout() {
const queryClient = useQueryClient();
return useMutation({
mutationFn: () => apiPost<{ success: boolean }>("/api/auth/logout", {}),
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ["auth"] });
},
});
}
export function useSetup() {
const queryClient = useQueryClient();
return useMutation({
mutationFn: (data: { username: string; password: string }) =>
apiPost<{ username: string }>("/api/auth/setup", data),
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ["auth"] });
},
});
}
export function useChangePassword() {
return useMutation({
mutationFn: (data: { currentPassword: string; newPassword: string }) =>
apiPut<{ success: boolean }>("/api/auth/password", data),
});
const logout = () => {
window.location.href = "/logout";
};
return { logout };
}
interface ApiKeyListItem {

View File

@@ -1,6 +1,6 @@
import { createFileRoute, useNavigate } from "@tanstack/react-router";
import { useState } from "react";
import { useAuth, useLogin, useSetup } from "../hooks/useAuth";
import { useEffect } from "react";
import { useAuth } from "../hooks/useAuth";
export const Route = createFileRoute("/login")({
component: LoginPage,
@@ -8,96 +8,42 @@ export const Route = createFileRoute("/login")({
function LoginPage() {
const navigate = useNavigate();
const { data: auth } = useAuth();
const login = useLogin();
const setup = useSetup();
const { data: auth, isLoading } = useAuth();
const [username, setUsername] = useState("");
const [password, setPassword] = useState("");
const [error, setError] = useState("");
const isSetup = auth?.setupRequired ?? false;
async function handleSubmit(e: React.FormEvent) {
e.preventDefault();
setError("");
try {
if (isSetup) {
await setup.mutateAsync({ username, password });
} else {
await login.mutateAsync({ username, password });
}
useEffect(() => {
if (auth?.authenticated) {
navigate({ to: "/" });
} catch (err) {
setError((err as Error).message);
}
}
}, [auth, navigate]);
const isPending = login.isPending || setup.isPending;
if (isLoading) {
return (
<div className="min-h-screen bg-gray-50 flex items-center justify-center">
<p className="text-gray-500 text-sm">Loading...</p>
</div>
);
}
return (
<div className="min-h-screen bg-gray-50 flex items-center justify-center px-4">
<div className="w-full max-w-sm">
<h1 className="text-xl font-semibold text-gray-900 text-center mb-6">
{isSetup ? "Create Account" : "Sign In"}
Sign in to GearBox
</h1>
<form
onSubmit={handleSubmit}
className="bg-white rounded-xl border border-gray-100 p-6 space-y-4"
>
{isSetup && (
<p className="text-sm text-gray-500">
Create your admin account to manage your gear collection.
</p>
)}
<div>
<label
htmlFor="username"
className="block text-sm font-medium text-gray-700 mb-1"
>
Username
</label>
<input
id="username"
type="text"
value={username}
onChange={(e) => setUsername(e.target.value)}
required
className="w-full px-3 py-2 border border-gray-200 rounded-lg text-sm focus:outline-none focus:ring-2 focus:ring-gray-200"
/>
</div>
<div>
<label
htmlFor="password"
className="block text-sm font-medium text-gray-700 mb-1"
>
Password
</label>
<input
id="password"
type="password"
value={password}
onChange={(e) => setPassword(e.target.value)}
required
minLength={isSetup ? 6 : undefined}
className="w-full px-3 py-2 border border-gray-200 rounded-lg text-sm focus:outline-none focus:ring-2 focus:ring-gray-200"
/>
</div>
{error && <p className="text-sm text-red-600">{error}</p>}
<div className="bg-white rounded-xl border border-gray-100 p-6 space-y-4">
<p className="text-sm text-gray-500 text-center">
You will be redirected to sign in with your account.
</p>
<button
type="submit"
disabled={isPending}
className="w-full py-2 px-4 text-sm font-medium text-white bg-gray-700 hover:bg-gray-800 disabled:opacity-50 rounded-lg transition-colors"
type="button"
onClick={() => {
window.location.href = "/login";
}}
className="w-full py-2 px-4 text-sm font-medium text-white bg-gray-700 hover:bg-gray-800 rounded-lg transition-colors"
>
{isPending ? "..." : isSetup ? "Create Account" : "Sign In"}
Sign In
</button>
</form>
</div>
</div>
</div>
);

View File

@@ -3,7 +3,6 @@ import { useRef, useState } from "react";
import {
useApiKeys,
useAuth,
useChangePassword,
useCreateApiKey,
useDeleteApiKey,
} from "../hooks/useAuth";
@@ -16,9 +15,9 @@ import type { Currency, WeightUnit } from "../lib/formatters";
const UNITS: WeightUnit[] = ["g", "oz", "lb", "kg"];
const CURRENCIES: { value: Currency; label: string }[] = [
{ value: "USD", label: "$" },
{ value: "EUR", label: "" },
{ value: "GBP", label: "£" },
{ value: "JPY", label: "¥" },
{ value: "EUR", label: "\u20AC" },
{ value: "GBP", label: "\u00A3" },
{ value: "JPY", label: "\u00A5" },
{ value: "CAD", label: "CA$" },
{ value: "AUD", label: "A$" },
];
@@ -27,66 +26,6 @@ export const Route = createFileRoute("/settings")({
component: SettingsPage,
});
function ChangePasswordSection() {
const changePassword = useChangePassword();
const [currentPassword, setCurrentPassword] = useState("");
const [newPassword, setNewPassword] = useState("");
const [message, setMessage] = useState<{
type: "success" | "error";
text: string;
} | null>(null);
async function handleSubmit(e: React.FormEvent) {
e.preventDefault();
setMessage(null);
try {
await changePassword.mutateAsync({ currentPassword, newPassword });
setMessage({ type: "success", text: "Password changed" });
setCurrentPassword("");
setNewPassword("");
} catch (err) {
setMessage({ type: "error", text: (err as Error).message });
}
}
return (
<form onSubmit={handleSubmit} className="space-y-3">
<h3 className="text-sm font-medium text-gray-900">Change Password</h3>
<input
type="password"
placeholder="Current password"
value={currentPassword}
onChange={(e) => setCurrentPassword(e.target.value)}
required
className="w-full px-3 py-2 border border-gray-200 rounded-lg text-sm focus:outline-none focus:ring-2 focus:ring-gray-200"
/>
<input
type="password"
placeholder="New password"
value={newPassword}
onChange={(e) => setNewPassword(e.target.value)}
required
minLength={6}
className="w-full px-3 py-2 border border-gray-200 rounded-lg text-sm focus:outline-none focus:ring-2 focus:ring-gray-200"
/>
{message && (
<p
className={`text-sm ${message.type === "success" ? "text-green-600" : "text-red-600"}`}
>
{message.text}
</p>
)}
<button
type="submit"
disabled={changePassword.isPending}
className="px-4 py-2 text-sm font-medium text-white bg-gray-700 hover:bg-gray-800 disabled:opacity-50 rounded-lg transition-colors"
>
{changePassword.isPending ? "..." : "Change Password"}
</button>
</form>
);
}
function ApiKeySection() {
const { data: keys } = useApiKeys();
const createKey = useCreateApiKey();
@@ -349,10 +288,8 @@ function SettingsPage() {
<ImportExportSection />
</div>
{auth?.user && (
{auth?.authenticated && (
<div className="bg-white rounded-xl border border-gray-100 p-5 space-y-6 mt-4">
<ChangePasswordSection />
<div className="border-t border-gray-100" />
<ApiKeySection />
</div>
)}

View File

@@ -1,17 +1,34 @@
import { beforeEach, describe, expect, test } from "bun:test";
import { beforeEach, describe, expect, mock, test } from "bun:test";
import { Hono } from "hono";
import { requireAuth } from "../../src/server/middleware/auth";
import {
createApiKey,
createSession,
createUser,
} from "../../src/server/services/auth.service";
import { createApiKey } from "../../src/server/services/auth.service";
import { createTestDb } from "../helpers/db";
// Mock @hono/oidc-auth - must be before importing middleware
const mockGetAuth = mock(() => null as any);
mock.module("@hono/oidc-auth", () => ({
getAuth: mockGetAuth,
oidcAuthMiddleware: () => async (_c: any, next: any) => next(),
processOAuthCallback: async (c: any) => c.json({ ok: true }),
revokeSession: async () => {},
}));
// Mock verifyAccessToken from oauth.service
const mockVerifyAccessToken = mock(() => Promise.resolve(false));
mock.module("../../src/server/services/oauth.service", () => ({
verifyAccessToken: mockVerifyAccessToken,
}));
// Import middleware AFTER mocks are set up
const { requireAuth } = await import("../../src/server/middleware/auth");
let db: ReturnType<typeof createTestDb>;
beforeEach(() => {
db = createTestDb();
mockGetAuth.mockReset();
mockGetAuth.mockReturnValue(null);
mockVerifyAccessToken.mockReset();
mockVerifyAccessToken.mockReturnValue(Promise.resolve(false));
});
function createApp() {
@@ -37,35 +54,16 @@ describe("auth middleware", () => {
expect(res.status).toBe(200);
});
test("returns 403 setup_required when no users exist", async () => {
test("rejects POST with no auth credentials", async () => {
const app = createApp();
const res = await app.request("/items", { method: "POST" });
expect(res.status).toBe(403);
const body = await res.json();
expect(body.error).toBe("setup_required");
});
test("rejects POST without auth when users exist", async () => {
const app = createApp();
await createUser(db, "admin", "pass");
const res = await app.request("/items", { method: "POST" });
expect(res.status).toBe(401);
});
test("allows POST with valid session cookie", async () => {
const app = createApp();
const user = await createUser(db, "admin", "pass");
const session = createSession(db, user.id);
const res = await app.request("/items", {
method: "POST",
headers: { Cookie: `gearbox_session=${session.id}` },
});
expect(res.status).toBe(200);
const body = await res.json();
expect(body.error).toBe("Authentication required");
});
test("allows POST with valid API key", async () => {
const app = createApp();
await createUser(db, "admin", "pass");
const key = await createApiKey(db, "test");
const res = await app.request("/items", {
method: "POST",
@@ -76,11 +74,52 @@ describe("auth middleware", () => {
test("rejects POST with invalid API key", async () => {
const app = createApp();
await createUser(db, "admin", "pass");
const res = await app.request("/items", {
method: "POST",
headers: { "X-API-Key": "invalid" },
headers: { "X-API-Key": "invalid-key-value" },
});
expect(res.status).toBe(401);
const body = await res.json();
expect(body.error).toBe("Invalid API key");
});
test("allows POST with valid Bearer token", async () => {
const app = createApp();
mockVerifyAccessToken.mockReturnValue(Promise.resolve(true));
const res = await app.request("/items", {
method: "POST",
headers: { Authorization: "Bearer valid-token-123" },
});
expect(res.status).toBe(200);
});
test("rejects POST with invalid Bearer token", async () => {
const app = createApp();
mockVerifyAccessToken.mockReturnValue(Promise.resolve(false));
const res = await app.request("/items", {
method: "POST",
headers: { Authorization: "Bearer invalid-token" },
});
expect(res.status).toBe(401);
const body = await res.json();
expect(body.error).toBe("invalid_token");
});
test("allows POST with valid OIDC session", async () => {
const app = createApp();
mockGetAuth.mockReturnValue({ sub: "user-123", email: "test@example.com" });
const res = await app.request("/items", { method: "POST" });
expect(res.status).toBe(200);
});
test("API key takes priority over OIDC session", async () => {
const app = createApp();
const key = await createApiKey(db, "test");
mockGetAuth.mockReturnValue({ sub: "user-123" });
const res = await app.request("/items", {
method: "POST",
headers: { "X-API-Key": key.rawKey },
});
expect(res.status).toBe(200);
});
});

View File

@@ -1,10 +1,27 @@
import { beforeEach, describe, expect, it } from "bun:test";
import { beforeEach, describe, expect, it, mock } from "bun:test";
import { Hono } from "hono";
import { authRoutes } from "../../src/server/routes/auth.ts";
import { createApiKey } from "../../src/server/services/auth.service.ts";
import { createTestDb } from "../helpers/db.ts";
async function createTestApp() {
const db = await createTestDb();
// Mock @hono/oidc-auth
const mockGetAuth = mock(() => null as any);
mock.module("@hono/oidc-auth", () => ({
getAuth: mockGetAuth,
oidcAuthMiddleware: () => async (_c: any, next: any) => next(),
processOAuthCallback: async (c: any) => c.json({ ok: true }),
revokeSession: async () => {},
}));
// Mock verifyAccessToken from oauth.service
mock.module("../../src/server/services/oauth.service", () => ({
verifyAccessToken: mock(() => Promise.resolve(false)),
}));
// Import routes AFTER mocks
const { authRoutes } = await import("../../src/server/routes/auth.ts");
function createTestApp() {
const db = createTestDb();
const app = new Hono<{ Variables: { db?: any } }>();
app.use("*", async (c, next) => {
@@ -18,111 +35,105 @@ async function createTestApp() {
describe("Auth Routes", () => {
let app: Hono;
let db: ReturnType<typeof createTestDb>;
beforeEach(async () => {
const testApp = await createTestApp();
beforeEach(() => {
const testApp = createTestApp();
app = testApp.app;
db = testApp.db;
mockGetAuth.mockReset();
mockGetAuth.mockReturnValue(null);
});
describe("GET /api/auth/me", () => {
it("returns null user and setupRequired true when no users exist", async () => {
it("returns authenticated false when no OIDC session", async () => {
const res = await app.request("/api/auth/me");
expect(res.status).toBe(200);
const body = await res.json();
expect(body.user).toBeNull();
expect(body.setupRequired).toBe(true);
});
});
describe("POST /api/auth/setup", () => {
it("creates first user and returns 201", async () => {
const res = await app.request("/api/auth/setup", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "secret123" }),
});
expect(res.status).toBe(201);
const body = await res.json();
expect(body.username).toBe("admin");
// Should set a session cookie
const setCookie = res.headers.get("set-cookie");
expect(setCookie).toContain("gearbox_session");
expect(body.authenticated).toBe(false);
});
it("rejects second setup attempt with 403", async () => {
// First setup
await app.request("/api/auth/setup", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "secret123" }),
it("returns user info when OIDC session exists", async () => {
mockGetAuth.mockReturnValue({
sub: "logto-user-abc123",
email: "user@example.com",
});
// Second attempt
const res = await app.request("/api/auth/setup", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "other", password: "secret456" }),
});
expect(res.status).toBe(403);
});
it("rejects password shorter than 6 characters", async () => {
const res = await app.request("/api/auth/setup", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "short" }),
});
expect(res.status).toBe(400);
});
});
describe("POST /api/auth/login", () => {
beforeEach(async () => {
// Create a user first
await app.request("/api/auth/setup", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "secret123" }),
});
});
it("returns session cookie on valid login", async () => {
const res = await app.request("/api/auth/login", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "secret123" }),
});
const res = await app.request("/api/auth/me");
expect(res.status).toBe(200);
const body = await res.json();
expect(body.username).toBe("admin");
expect(body.authenticated).toBe(true);
expect(body.user.id).toBe("logto-user-abc123");
expect(body.user.email).toBe("user@example.com");
});
});
const setCookie = res.headers.get("set-cookie");
expect(setCookie).toContain("gearbox_session");
describe("GET /api/auth/keys", () => {
it("returns 401 without authentication", async () => {
const res = await app.request("/api/auth/keys");
expect(res.status).toBe(401);
});
it("rejects invalid credentials with 401", async () => {
const res = await app.request("/api/auth/login", {
it("returns empty key list with API key auth", async () => {
const key = await createApiKey(db, "test-key");
const res = await app.request("/api/auth/keys", {
headers: { "X-API-Key": key.rawKey },
});
expect(res.status).toBe(200);
const body = await res.json();
// Contains at least the key we created for auth
expect(Array.isArray(body)).toBe(true);
expect(body.length).toBeGreaterThanOrEqual(1);
});
});
describe("POST /api/auth/keys", () => {
it("creates a new API key when authenticated", async () => {
const authKey = await createApiKey(db, "auth-key");
const res = await app.request("/api/auth/keys", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": authKey.rawKey,
},
body: JSON.stringify({ name: "my-new-key" }),
});
expect(res.status).toBe(201);
const body = await res.json();
expect(body.name).toBe("my-new-key");
expect(body.key).toBeDefined();
expect(body.prefix).toBeDefined();
});
it("rejects without auth", async () => {
const res = await app.request("/api/auth/keys", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ username: "admin", password: "wrongpassword" }),
body: JSON.stringify({ name: "my-key" }),
});
expect(res.status).toBe(401);
});
});
describe("POST /api/auth/logout", () => {
it("clears session cookie", async () => {
const res = await app.request("/api/auth/logout", {
method: "POST",
});
describe("DELETE /api/auth/keys/:id", () => {
it("deletes an API key when authenticated", async () => {
const authKey = await createApiKey(db, "auth-key");
const targetKey = await createApiKey(db, "to-delete");
const res = await app.request(`/api/auth/keys/${targetKey.id}`, {
method: "DELETE",
headers: { "X-API-Key": authKey.rawKey },
});
expect(res.status).toBe(200);
const body = await res.json();
expect(body.ok).toBe(true);
});
it("rejects without auth", async () => {
const res = await app.request("/api/auth/keys/1", {
method: "DELETE",
});
expect(res.status).toBe(401);
});
});
});

View File

@@ -1,120 +1,17 @@
import { beforeEach, describe, expect, it } from "bun:test";
import {
changePassword,
createApiKey,
createSession,
createUser,
deleteApiKey,
deleteSession,
getSession,
getUserCount,
listApiKeys,
verifyApiKey,
verifyPassword,
} from "../../src/server/services/auth.service.ts";
import { createTestDb } from "../helpers/db.ts";
describe("Auth Service", () => {
let db: any;
let db: ReturnType<typeof createTestDb>;
beforeEach(async () => {
db = await createTestDb();
});
describe("User Management", () => {
it("creates a user with hashed password (hash !== plaintext)", async () => {
const user = await createUser(db, "admin", "secret123");
expect(user).toBeDefined();
expect(user.id).toBeGreaterThan(0);
expect(user.username).toBe("admin");
expect(user.passwordHash).not.toBe("secret123");
expect(user.passwordHash.length).toBeGreaterThan(0);
});
it("verifies correct password returns user", async () => {
await createUser(db, "admin", "secret123");
const user = await verifyPassword(db, "admin", "secret123");
expect(user).not.toBeNull();
expect(user!.username).toBe("admin");
});
it("rejects incorrect password returns null", async () => {
await createUser(db, "admin", "secret123");
const user = await verifyPassword(db, "admin", "wrongpassword");
expect(user).toBeNull();
});
it("getUserCount returns 0 then 1", async () => {
const countBefore = await getUserCount(db);
expect(countBefore).toBe(0);
await createUser(db, "admin", "secret123");
const countAfter = await getUserCount(db);
expect(countAfter).toBe(1);
});
it("changes password successfully", async () => {
await createUser(db, "admin", "oldpass");
const changed = await changePassword(db, "admin", "oldpass", "newpass");
expect(changed).toBe(true);
// Verify new password works
const user = await verifyPassword(db, "admin", "newpass");
expect(user).not.toBeNull();
// Verify old password no longer works
const oldAttempt = await verifyPassword(db, "admin", "oldpass");
expect(oldAttempt).toBeNull();
});
it("rejects password change with wrong current password", async () => {
await createUser(db, "admin", "secret123");
const changed = await changePassword(
db,
"admin",
"wrongcurrent",
"newpass",
);
expect(changed).toBe(false);
});
});
describe("Session Management", () => {
it("creates and retrieves a session (id length is 64 hex chars)", async () => {
const user = await createUser(db, "admin", "secret123");
const session = await createSession(db, user.id);
expect(session).toBeDefined();
expect(session.id).toHaveLength(64);
expect(session.userId).toBe(user.id);
expect(session.expiresAt).toBeInstanceOf(Date);
const retrieved = await getSession(db, session.id);
expect(retrieved).not.toBeNull();
expect(retrieved!.id).toBe(session.id);
});
it("returns null for expired session (expiryDays = -1)", async () => {
const user = await createUser(db, "admin", "secret123");
const session = await createSession(db, user.id, -1);
const retrieved = await getSession(db, session.id);
expect(retrieved).toBeNull();
});
it("deletes a session", async () => {
const user = await createUser(db, "admin", "secret123");
const session = await createSession(db, user.id);
await deleteSession(db, session.id);
const retrieved = await getSession(db, session.id);
expect(retrieved).toBeNull();
});
beforeEach(() => {
db = createTestDb();
});
describe("API Key Management", () => {
@@ -144,7 +41,7 @@ describe("Auth Service", () => {
it("deletes key so it is no longer valid", async () => {
const result = await createApiKey(db, "test-key");
await deleteApiKey(db, result.id);
deleteApiKey(db, result.id);
const isValid = await verifyApiKey(db, result.rawKey);
expect(isValid).toBe(false);
@@ -154,7 +51,7 @@ describe("Auth Service", () => {
await createApiKey(db, "key-one");
await createApiKey(db, "key-two");
const keys = await listApiKeys(db);
const keys = listApiKeys(db);
expect(keys).toHaveLength(2);
expect(keys[0].name).toBe("key-one");
expect(keys[1].name).toBe("key-two");