Files
SnapOtter/tests/unit/api/auth-routes.test.ts
T
SnapOtterandGitHub 1c724d5d21 feat(db)!: SnapOtter 2.0 phase 1 foundation: postgres, migrator, compose stack (#216)
* feat(infra): add dev compose stack with postgres and redis

* fix(infra): comment dev env defaults until wired; harden dev compose restart and start_period

* chore(deps): add pg driver and testcontainers for postgres migration

* feat(db): translate schema to drizzle pg-core (timestamptz, boolean, pgEnum, jsonb)

Schema translation (apps/api/src/db/schema.ts):
- sqlite-core -> pg-core, all 10 tables preserved 1:1
- integer(mode:'timestamp') -> timestamp({ withTimezone: true })
- integer(mode:'boolean') -> boolean
- jobs.status text enum -> pgEnum('job_status') with same 4 values
- 7 columns changed from text to jsonb: jobs.inputFiles, jobs.settings,
  pipelines.steps, apiKeys.permissions, roles.permissions,
  auditLog.details, userFiles.toolChain
- settings.value stays text, jobs.error stays text, jobs.progress stays real

jsonb call-site sweep (removed JSON.stringify on writes, JSON.parse on reads):
- apps/api/src/routes/roles.ts: permissions read/write (3 sites)
- apps/api/src/routes/api-keys.ts: permissions write + read (2 sites)
- apps/api/src/routes/audit-log.ts: details read (1 site)
- apps/api/src/routes/pipeline.ts: steps write + read (2 sites)
- apps/api/src/routes/progress.ts: inputFiles write (2 sites)
- apps/api/src/routes/tool-factory.ts: toolChain read + write (2 sites)
- apps/api/src/routes/user-files.ts: toolChain read + write (4 sites)
- apps/api/src/permissions.ts: roles.permissions read (1 site)
- apps/api/src/lib/audit.ts: details write (1 site)
- apps/api/src/plugins/auth.ts: apiKeys.permissions read (1 site)

* refactor(db): type jsonb columns via $type and note raw CTE conversion requirements

* feat(db): archive sqlite migrations and generate postgres baseline

* chore(db): dockerignore legacy migrations, add archive breadcrumb, fix trailing newline

* feat(db): pg pool connection, advisory-locked boot migrations, DATABASE_URL config

* fix(db): friendly fatal on unreachable postgres, idempotent closeDb, lock-key convention note

* refactor(db): async drizzle calls in plugins, lib, permissions

* fix(api): analytics never throws, typed permission guard, single-query session invalidation

* refactor(db): async drizzle calls across all routes and bootstrap

Convert every route file and index.ts from sync SQLite drizzle
patterns to async node-postgres drizzle:

- .all() removed (bare await on select)
- .get() converted to destructured [row] = await ...
- .run() removed (bare await on insert/update/delete)
- .changes replaced with .rowCount (null-guarded) in progress.ts
- sqlite import removed from user-files.ts; raw CTEs converted to
  await db.execute(sql`...`) with postgres-dialect recursive CTEs
- ChainRow types updated: tool_chain is parsed jsonb (string[] | null),
  created_at is Date (timestamptz) with no * 1000 conversion
- All requirePermission() guard calls awaited (security: unawaited
  async guard returns truthy Promise, bypassing permission check)
- All hasEffectivePermission() and getPermissions() calls awaited
- All auditLog() calls awaited (preserves write-before-response order)
- trackEvent() and captureException() left un-awaited (fire-and-forget
  by design, guaranteed never-throw)
- ensureAnonymousUser(), startCleanupCron(), recoverStaleJobs() awaited
  in bootstrap sequence
- ensureInstanceId() and ensureDefaultSettings() made async

Files converted: 14 (index.ts + 12 route files + tools/index.ts)

* fix(db): await async checkStorageQuota in user-files upload/save routes

* fix(db): await checkStorageQuota in save-result route (missed second call site)

* feat(db): sqlite-to-postgres migrator with CLI and first-boot import

* fix(db): migrator error context, honest force semantics, boot-hook fatal, null-variance tests

* test: run suite against per-file postgres databases via testcontainers

- Add tests/global-setup.ts: spins up a Postgres testcontainer,
  creates a migrated template database once per vitest run.
- Rewrite tests/setup/per-fork-env.ts: each test file (forks pool)
  clones the template into its own database via CREATE DATABASE ...
  TEMPLATE, preserving the same per-file isolation granularity.
- Update vitest.config.ts: add globalSetup, pg alias, update comment.
- Fix tests/integration/test-server.ts: remove DB_PATH mkdir, async
  runMigrations, async db operations, remove SQLite WAL checkpoint.
- Fix 21 unit test db/index mocks: add pool and closeDb exports.
- Fix 8 unit test files: add async/await for now-async permission,
  audit, and analytics functions.
- Fix 18 integration test files: convert sync .run()/.all()/.get()
  to async drizzle patterns, add async to callbacks.
- Production change: apps/api/src/routes/teams.ts: cast COUNT(*)
  to ::int so Postgres returns a number instead of bigint string.

* fix(db): seed built-in roles, reject NUL bytes, cast COUNT, serialize job persists

- Seed built-in roles (admin, editor, user) at boot via ensureBuiltinRoles()
  with onConflictDoNothing, restoring data that legacy SQLite migration 0007
  provided via INSERT statements (the pg baseline is DDL-only).
- Reject NUL bytes in login credentials with 401 (postgres rejects \x00 in
  text columns; valid usernames never contain NUL, matching 1.x behavior).
- Cast COUNT(*)::int in user-files, audit-log, and roles listing queries so
  postgres returns a JS number instead of bigint-as-string.
- Serialize fire-and-forget job progress DB writes per jobId so the final
  "completed" status is never overwritten by a late-arriving "processing"
  write (race condition exposed by async postgres round-trips).

* test: fix teams race, seed roles in test server, poll for job status

- Add missing await to resetTeams() in teams PUT beforeEach (the async
  delete raced with the subsequent insert under postgres).
- Call ensureBuiltinRoles() in test server bootstrap so integration tests
  have the same built-in roles as production.
- Replace fixed 100ms flushPersist delay with a polling helper that waits
  for terminal job status, eliminating timing-dependent failures caused by
  postgres network round-trip latency.

* test: make heic temp-file cleanup assertion resilient to concurrent workers

Use a set-based diff instead of raw file count when checking that
decodeHeic cleans up temp files. Other concurrent test workers can
create heic-in-*/heic-out-* files in the shared tmpdir, inflating the
"after" count and causing spurious failures under full-suite load.

* fix(db): align builtin-role seed to post-0010 legacy state; test polish

* feat(docker): three-container compose (app, postgres, redis) with boot wait and migrations

* fix(docker): set TEST_DATABASE_URL so containerized tests skip testcontainers

* chore(docker): test compose project name, clearer 1.x upgrade comment, unref probe timer

* feat(enterprise): enforce D15 license boundary; move s3 storage into packages/enterprise

* fix(enterprise): restore lazy aws-sdk loading; community installs load no s3 code at boot

* fix(enterprise): boundary check catches dynamic imports; document getS3 concurrency

* feat(db)!: SnapOtter 2.0 phase 1 foundation: postgres, migrator, compose stack

BREAKING CHANGE: SQLite is no longer the runtime database. Deployments now
require Postgres (and Redis, used from phase 2). Existing installs migrate
with SQLITE_MIGRATE_PATH or 'pnpm --filter @snapotter/api migrate:sqlite'.

* fix(ci): postgres service + fresh e2e database per run; ignore unfixable torch CVE-2025-3000
2026-06-13 10:15:23 +08:00

364 lines
12 KiB
TypeScript

/**
* Unit tests for auth route helper functions and validation logic.
*
* Tests getAuthUser, requireAuth, requireAdmin, validatePasswordStrength,
* validateUsername, isPublicRoute, and extractToken -- all extracted from
* apps/api/src/plugins/auth.ts.
*/
import { describe, expect, it, vi } from "vitest";
// Mock DB to avoid SQLite connection
vi.mock("../../../apps/api/src/db/index.js", () => ({
db: {
select: () => ({
from: () => ({
where: () => ({ get: () => null, all: () => [] }),
all: () => [],
}),
}),
insert: () => ({
values: () => ({ onConflictDoNothing: () => ({ run: vi.fn() }), run: vi.fn() }),
}),
delete: () => ({ where: () => ({ run: vi.fn() }) }),
update: () => ({ set: () => ({ where: () => ({ run: vi.fn() }) }) }),
},
pool: {},
closeDb: async () => {},
schema: {
users: { id: {}, username: {}, role: {} },
sessions: { id: {}, userId: {} },
settings: { key: {} },
apiKeys: { id: {}, userId: {}, keyPrefix: {} },
teams: { id: {}, name: {} },
roles: { name: {} },
auditLog: {},
},
}));
vi.mock("../../../apps/api/src/config.js", () => ({
env: {
AUTH_ENABLED: true,
DEFAULT_USERNAME: "admin",
DEFAULT_PASSWORD: "Adminpass1",
SKIP_MUST_CHANGE_PASSWORD: false,
SESSION_DURATION_HOURS: 168,
RATE_LIMIT_PER_MIN: 10000,
LOGIN_ATTEMPT_LIMIT: 500,
MAX_USERS: 50,
},
}));
vi.mock("../../../apps/api/src/lib/audit.js", () => ({
auditLog: vi.fn(),
}));
import {
computeKeyPrefix,
getAuthUser,
hashPassword,
requireAdmin,
requireAuth,
verifyPassword,
} from "../../../apps/api/src/plugins/auth.js";
// ── getAuthUser ─────────────────────────────────────────────────────────
describe("getAuthUser", () => {
it("returns null when request has no user property", () => {
const req = {} as never;
expect(getAuthUser(req)).toBeNull();
});
it("returns the user when request has user property", () => {
const user = { id: "u1", username: "alice", role: "admin" };
const req = { user } as never;
expect(getAuthUser(req)).toEqual(user);
});
it("returns null when user is undefined", () => {
const req = { user: undefined } as never;
expect(getAuthUser(req)).toBeNull();
});
});
// ── requireAuth ─────────────────────────────────────────────────────────
describe("requireAuth", () => {
it("returns the user when authenticated", () => {
const user = { id: "u1", username: "alice", role: "editor" };
const req = { user } as never;
const reply = { status: vi.fn().mockReturnThis(), send: vi.fn() } as never;
const result = requireAuth(req, reply);
expect(result).toEqual(user);
expect((reply as { status: ReturnType<typeof vi.fn> }).status).not.toHaveBeenCalled();
});
it("returns null and sends 401 when not authenticated", () => {
const req = {} as never;
const reply = { status: vi.fn().mockReturnThis(), send: vi.fn() } as never;
const result = requireAuth(req, reply);
expect(result).toBeNull();
expect((reply as { status: ReturnType<typeof vi.fn> }).status).toHaveBeenCalledWith(401);
expect((reply as { send: ReturnType<typeof vi.fn> }).send).toHaveBeenCalledWith(
expect.objectContaining({ error: "Authentication required" }),
);
});
});
// ── requireAdmin ────────────────────────────────────────────────────────
describe("requireAdmin", () => {
it("returns the user when role is admin", () => {
const user = { id: "u1", username: "boss", role: "admin" };
const req = { user } as never;
const reply = { status: vi.fn().mockReturnThis(), send: vi.fn() } as never;
const result = requireAdmin(req, reply);
expect(result).toEqual(user);
});
it("returns null and sends 403 when role is not admin", () => {
const user = { id: "u2", username: "worker", role: "user" };
const req = { user } as never;
const reply = { status: vi.fn().mockReturnThis(), send: vi.fn() } as never;
const result = requireAdmin(req, reply);
expect(result).toBeNull();
expect((reply as { status: ReturnType<typeof vi.fn> }).status).toHaveBeenCalledWith(403);
expect((reply as { send: ReturnType<typeof vi.fn> }).send).toHaveBeenCalledWith(
expect.objectContaining({ error: "Admin access required" }),
);
});
it("returns null and sends 401 when not authenticated at all", () => {
const req = {} as never;
const reply = { status: vi.fn().mockReturnThis(), send: vi.fn() } as never;
const result = requireAdmin(req, reply);
expect(result).toBeNull();
expect((reply as { status: ReturnType<typeof vi.fn> }).status).toHaveBeenCalledWith(401);
});
it("returns null for editor role", () => {
const user = { id: "u3", username: "editor", role: "editor" };
const req = { user } as never;
const reply = { status: vi.fn().mockReturnThis(), send: vi.fn() } as never;
const result = requireAdmin(req, reply);
expect(result).toBeNull();
expect((reply as { status: ReturnType<typeof vi.fn> }).status).toHaveBeenCalledWith(403);
});
});
// ── Password hashing (deeper coverage) ─────────────────────────────────
describe("hashPassword (additional coverage)", () => {
it("handles empty string password", async () => {
const hash = await hashPassword("");
const parts = hash.split(":");
expect(parts).toHaveLength(2);
expect(parts[0]).toHaveLength(64);
expect(parts[1]).toHaveLength(128);
});
it("handles very long passwords", async () => {
const longPw = "A".repeat(1000);
const hash = await hashPassword(longPw);
const ok = await verifyPassword(longPw, hash);
expect(ok).toBe(true);
});
it("different passwords produce different hashes even with same salt length", async () => {
const h1 = await hashPassword("Password1");
const h2 = await hashPassword("Password2");
const hash1 = h1.split(":")[1];
const hash2 = h2.split(":")[1];
expect(hash1).not.toBe(hash2);
});
});
describe("verifyPassword (additional coverage)", () => {
it("returns false for completely empty input", async () => {
expect(await verifyPassword("", "")).toBe(false);
});
it("returns false when stored has colon but empty salt", async () => {
expect(await verifyPassword("test", ":somehash")).toBe(false);
});
it("handles special characters in password", async () => {
const stored = await hashPassword("p@$$w0rd!#%^&*");
expect(await verifyPassword("p@$$w0rd!#%^&*", stored)).toBe(true);
expect(await verifyPassword("p@$$w0rd!#%^&", stored)).toBe(false);
});
});
// ── computeKeyPrefix (additional coverage) ──────────────────────────────
describe("computeKeyPrefix (additional coverage)", () => {
it("returns consistent 16-char prefix for empty string", () => {
const prefix = computeKeyPrefix("");
expect(prefix).toHaveLength(16);
expect(prefix).toMatch(/^[0-9a-f]{16}$/);
});
it("prefix for binary-like input still works", () => {
const prefix = computeKeyPrefix("\x00\x01\x02");
expect(prefix).toHaveLength(16);
});
});
// ── Password strength validation (reproduced logic) ────────────────────
// Reproduce the validation function from auth.ts since it's not exported
function validatePasswordStrength(password: string): string | null {
const rules = "Password must be at least 8 characters with uppercase, lowercase, and a number";
if (password.length < 8) return rules;
if (!/[A-Z]/.test(password)) return rules;
if (!/[a-z]/.test(password)) return rules;
if (!/[0-9]/.test(password)) return rules;
return null;
}
describe("validatePasswordStrength", () => {
it("accepts valid password", () => {
expect(validatePasswordStrength("MyPass12")).toBeNull();
});
it("rejects password shorter than 8 chars", () => {
expect(validatePasswordStrength("Ab1")).not.toBeNull();
});
it("rejects password without uppercase", () => {
expect(validatePasswordStrength("lowercase1")).not.toBeNull();
});
it("rejects password without lowercase", () => {
expect(validatePasswordStrength("UPPERCASE1")).not.toBeNull();
});
it("rejects password without number", () => {
expect(validatePasswordStrength("NoNumberHere")).not.toBeNull();
});
it("accepts password with special characters", () => {
expect(validatePasswordStrength("Sp3c!al@")).toBeNull();
});
it("rejects empty string", () => {
expect(validatePasswordStrength("")).not.toBeNull();
});
});
// ── Username validation (reproduced logic) ─────────────────────────────
function validateUsername(username: string): string | null {
if (username.length < 3 || username.length > 50) {
return "Username must be between 3 and 50 characters";
}
if (!/^[a-zA-Z0-9_.-]+$/.test(username)) {
return "Username can only contain letters, numbers, dots, hyphens, and underscores";
}
return null;
}
describe("validateUsername", () => {
it("accepts valid usernames", () => {
expect(validateUsername("alice")).toBeNull();
expect(validateUsername("bob_123")).toBeNull();
expect(validateUsername("user.name")).toBeNull();
expect(validateUsername("a-b")).toBeNull();
});
it("rejects username shorter than 3 chars", () => {
expect(validateUsername("ab")).not.toBeNull();
});
it("rejects username longer than 50 chars", () => {
expect(validateUsername("a".repeat(51))).not.toBeNull();
});
it("rejects username with spaces", () => {
expect(validateUsername("has space")).not.toBeNull();
});
it("rejects username with special characters", () => {
expect(validateUsername("user@name")).not.toBeNull();
expect(validateUsername("user!name")).not.toBeNull();
expect(validateUsername("user#name")).not.toBeNull();
});
it("accepts exactly 3 chars", () => {
expect(validateUsername("abc")).toBeNull();
});
it("accepts exactly 50 chars", () => {
expect(validateUsername("a".repeat(50))).toBeNull();
});
});
// ── isPublicRoute (reproduced logic) ────────────────────────────────────
const PUBLIC_PATHS = [
"/api/v1/health",
"/api/v1/config/",
"/api/auth/",
"/api/v1/download/",
"/api/v1/jobs/",
"/api/docs",
"/api/v1/openapi.yaml",
"/api/v1/meme-templates/",
];
function isPublicRoute(url: string): boolean {
if (!url.startsWith("/api/")) return true;
return PUBLIC_PATHS.some((path) => url.startsWith(path));
}
describe("isPublicRoute", () => {
it("treats non-API routes as public", () => {
expect(isPublicRoute("/")).toBe(true);
expect(isPublicRoute("/some-page")).toBe(true);
expect(isPublicRoute("/static/image.png")).toBe(true);
});
it("treats auth routes as public", () => {
expect(isPublicRoute("/api/auth/login")).toBe(true);
expect(isPublicRoute("/api/auth/logout")).toBe(true);
expect(isPublicRoute("/api/auth/session")).toBe(true);
});
it("treats health endpoint as public", () => {
expect(isPublicRoute("/api/v1/health")).toBe(true);
});
it("treats download routes as public", () => {
expect(isPublicRoute("/api/v1/download/abc/file.png")).toBe(true);
});
it("treats job progress as public", () => {
expect(isPublicRoute("/api/v1/jobs/some-id/progress")).toBe(true);
});
it("treats docs as public", () => {
expect(isPublicRoute("/api/docs")).toBe(true);
expect(isPublicRoute("/api/v1/openapi.yaml")).toBe(true);
});
it("treats tool endpoints as private", () => {
expect(isPublicRoute("/api/v1/tools/resize")).toBe(false);
expect(isPublicRoute("/api/v1/features")).toBe(false);
expect(isPublicRoute("/api/v1/files")).toBe(false);
});
it("treats admin routes as private", () => {
expect(isPublicRoute("/api/v1/admin/features/bundle/install")).toBe(false);
});
it("treats meme templates as public", () => {
expect(isPublicRoute("/api/v1/meme-templates/list")).toBe(true);
});
});