Files
SnapOtter/tests/unit/api/audit-log-route.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

271 lines
8.1 KiB
TypeScript

/**
* Unit tests for audit log route query parsing and response serialization.
*
* Tests pagination, action filtering, date range filtering, and the
* response format for audit log entries.
*/
import { describe, expect, it, vi } from "vitest";
// ── Mocks ───────────────────────────────────────────────────────────────
vi.mock("../../../apps/api/src/db/index.js", () => ({
db: {
select: () => ({
from: () => ({
where: () => ({
orderBy: () => ({
limit: () => ({
offset: () => ({ all: () => [] }),
}),
}),
get: () => ({ count: 0 }),
}),
orderBy: () => ({
limit: () => ({
offset: () => ({ all: () => [] }),
}),
}),
all: () => [],
}),
}),
},
pool: {},
closeDb: async () => {},
schema: {
auditLog: {
action: {},
createdAt: {},
},
},
}));
// ── Reproduce query parsing logic from audit-log.ts ────────────────────
function parsePagination(query: { page?: string; limit?: string }) {
const page = Math.max(1, parseInt(query.page ?? "1", 10) || 1);
const limit = Math.min(100, Math.max(1, parseInt(query.limit ?? "50", 10) || 50));
const offset = (page - 1) * limit;
return { page, limit, offset };
}
function parseFilters(query: { action?: string; from?: string; to?: string }) {
const conditions: Array<{ type: string; value: unknown }> = [];
if (query.action) {
conditions.push({ type: "action", value: query.action });
}
if (query.from) {
const fromDate = new Date(query.from);
if (!Number.isNaN(fromDate.getTime())) {
conditions.push({ type: "from", value: fromDate });
}
}
if (query.to) {
const toDate = new Date(query.to);
if (!Number.isNaN(toDate.getTime())) {
conditions.push({ type: "to", value: toDate });
}
}
return conditions;
}
interface AuditEntry {
id: string;
actorId: string | null;
actorUsername: string;
action: string;
targetType: string | null;
targetId: string | null;
details: string | null;
ipAddress: string | null;
createdAt: Date;
}
function serializeEntry(e: AuditEntry) {
return {
id: e.id,
actorId: e.actorId,
actorUsername: e.actorUsername,
action: e.action,
targetType: e.targetType,
targetId: e.targetId,
details: e.details ? JSON.parse(e.details) : null,
ipAddress: e.ipAddress,
createdAt: e.createdAt.toISOString(),
};
}
// ── Tests ───────────────────────────────────────────────────────────────
describe("audit log route logic", () => {
describe("pagination parsing", () => {
it("defaults to page 1, limit 50", () => {
const result = parsePagination({});
expect(result).toEqual({ page: 1, limit: 50, offset: 0 });
});
it("parses valid page and limit", () => {
const result = parsePagination({ page: "3", limit: "20" });
expect(result).toEqual({ page: 3, limit: 20, offset: 40 });
});
it("clamps page to minimum 1", () => {
const result = parsePagination({ page: "0" });
expect(result.page).toBe(1);
expect(result.offset).toBe(0);
});
it("clamps negative page to 1", () => {
const result = parsePagination({ page: "-5" });
expect(result.page).toBe(1);
});
it("clamps limit to maximum 100", () => {
const result = parsePagination({ limit: "500" });
expect(result.limit).toBe(100);
});
it("clamps limit to minimum 1", () => {
const result = parsePagination({ limit: "0" });
expect(result.limit).toBe(50); // 0 falls through to default
});
it("handles non-numeric page", () => {
const result = parsePagination({ page: "abc" });
expect(result.page).toBe(1);
});
it("handles non-numeric limit", () => {
const result = parsePagination({ limit: "xyz" });
expect(result.limit).toBe(50);
});
it("calculates correct offset for page 2 with limit 25", () => {
const result = parsePagination({ page: "2", limit: "25" });
expect(result.offset).toBe(25);
});
it("calculates correct offset for page 5 with limit 10", () => {
const result = parsePagination({ page: "5", limit: "10" });
expect(result.offset).toBe(40);
});
});
describe("filter parsing", () => {
it("returns empty conditions for no filters", () => {
const conditions = parseFilters({});
expect(conditions).toHaveLength(0);
});
it("adds action filter", () => {
const conditions = parseFilters({ action: "LOGIN_SUCCESS" });
expect(conditions).toHaveLength(1);
expect(conditions[0].type).toBe("action");
expect(conditions[0].value).toBe("LOGIN_SUCCESS");
});
it("adds from date filter", () => {
const conditions = parseFilters({ from: "2025-01-01" });
expect(conditions).toHaveLength(1);
expect(conditions[0].type).toBe("from");
});
it("adds to date filter", () => {
const conditions = parseFilters({ to: "2025-12-31" });
expect(conditions).toHaveLength(1);
expect(conditions[0].type).toBe("to");
});
it("handles all filters together", () => {
const conditions = parseFilters({
action: "USER_CREATED",
from: "2025-01-01",
to: "2025-12-31",
});
expect(conditions).toHaveLength(3);
});
it("ignores invalid from date", () => {
const conditions = parseFilters({ from: "not-a-date" });
expect(conditions).toHaveLength(0);
});
it("ignores invalid to date", () => {
const conditions = parseFilters({ to: "also-not-a-date" });
expect(conditions).toHaveLength(0);
});
it("keeps valid filters even when one is invalid", () => {
const conditions = parseFilters({
action: "LOGIN_SUCCESS",
from: "bad-date",
to: "2025-12-31",
});
expect(conditions).toHaveLength(2);
expect(conditions[0].type).toBe("action");
expect(conditions[1].type).toBe("to");
});
});
describe("entry serialization", () => {
it("serializes a complete entry", () => {
const entry: AuditEntry = {
id: "entry-1",
actorId: "user-1",
actorUsername: "alice",
action: "LOGIN_SUCCESS",
targetType: "user",
targetId: "user-1",
details: JSON.stringify({ ip: "127.0.0.1" }),
ipAddress: "127.0.0.1",
createdAt: new Date("2025-06-01T12:00:00Z"),
};
const serialized = serializeEntry(entry);
expect(serialized.id).toBe("entry-1");
expect(serialized.actorId).toBe("user-1");
expect(serialized.actorUsername).toBe("alice");
expect(serialized.action).toBe("LOGIN_SUCCESS");
expect(serialized.details).toEqual({ ip: "127.0.0.1" });
expect(serialized.createdAt).toBe("2025-06-01T12:00:00.000Z");
});
it("handles null details", () => {
const entry: AuditEntry = {
id: "entry-2",
actorId: null,
actorUsername: "system",
action: "SETTINGS_UPDATED",
targetType: "setting",
targetId: null,
details: null,
ipAddress: null,
createdAt: new Date("2025-06-01T12:00:00Z"),
};
const serialized = serializeEntry(entry);
expect(serialized.details).toBeNull();
expect(serialized.actorId).toBeNull();
expect(serialized.ipAddress).toBeNull();
});
it("parses JSON details string", () => {
const entry: AuditEntry = {
id: "entry-3",
actorId: "admin-1",
actorUsername: "admin",
action: "USER_CREATED",
targetType: "user",
targetId: "new-user-1",
details: JSON.stringify({ username: "newuser", role: "editor" }),
ipAddress: "192.168.1.1",
createdAt: new Date("2025-07-15T08:30:00Z"),
};
const serialized = serializeEntry(entry);
expect(serialized.details).toEqual({ username: "newuser", role: "editor" });
});
});
});