mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
* 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
283 lines
8.2 KiB
TypeScript
283 lines
8.2 KiB
TypeScript
import type { Permission, Role } from "@snapotter/shared";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
vi.mock("../../../apps/api/src/db/index.js", () => ({
|
|
db: {
|
|
select: () => ({
|
|
from: () => ({ where: () => ({ get: () => null }) }),
|
|
}),
|
|
},
|
|
pool: {},
|
|
closeDb: async () => {},
|
|
schema: { roles: {}, settings: {} },
|
|
}));
|
|
|
|
const mockGetAuthUser = vi.fn();
|
|
vi.mock("../../../apps/api/src/plugins/auth.js", () => ({
|
|
getAuthUser: (...args: unknown[]) => mockGetAuthUser(...args),
|
|
}));
|
|
|
|
import {
|
|
hasEffectivePermission,
|
|
hasPermission,
|
|
requireOwnershipOrPermission,
|
|
requirePermission,
|
|
} from "../../../apps/api/src/permissions.js";
|
|
import type { AuthUser } from "../../../apps/api/src/plugins/auth.js";
|
|
|
|
function makeUser(overrides: Partial<AuthUser> & { role: string }): AuthUser {
|
|
return {
|
|
id: "u-test",
|
|
username: "tester",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function makeMockReply() {
|
|
const sent: { status?: number; body?: unknown } = {};
|
|
const reply = {
|
|
status(code: number) {
|
|
sent.status = code;
|
|
return reply;
|
|
},
|
|
send(body: unknown) {
|
|
sent.body = body;
|
|
return reply;
|
|
},
|
|
};
|
|
return { reply, sent };
|
|
}
|
|
|
|
beforeEach(() => {
|
|
mockGetAuthUser.mockReset();
|
|
});
|
|
|
|
describe("hasPermission extended", () => {
|
|
const adminPerms: Permission[] = [
|
|
"tools:use",
|
|
"files:own",
|
|
"files:all",
|
|
"apikeys:own",
|
|
"apikeys:all",
|
|
"pipelines:own",
|
|
"pipelines:all",
|
|
"settings:read",
|
|
"settings:write",
|
|
"users:manage",
|
|
"teams:manage",
|
|
"features:manage",
|
|
"system:health",
|
|
"audit:read",
|
|
];
|
|
|
|
it("admin has all 14 permissions", async () => {
|
|
for (const perm of adminPerms) {
|
|
expect(await hasPermission("admin", perm)).toBe(true);
|
|
}
|
|
});
|
|
|
|
it("editor has the expected permissions", async () => {
|
|
const editorYes: Permission[] = [
|
|
"tools:use",
|
|
"files:own",
|
|
"files:all",
|
|
"apikeys:own",
|
|
"pipelines:own",
|
|
"pipelines:all",
|
|
"settings:read",
|
|
];
|
|
for (const perm of editorYes) {
|
|
expect(await hasPermission("editor", perm)).toBe(true);
|
|
}
|
|
});
|
|
|
|
it("editor does NOT have admin-only permissions", async () => {
|
|
const editorNo: Permission[] = [
|
|
"users:manage",
|
|
"teams:manage",
|
|
"settings:write",
|
|
"features:manage",
|
|
"system:health",
|
|
"audit:read",
|
|
];
|
|
for (const perm of editorNo) {
|
|
expect(await hasPermission("editor", perm)).toBe(false);
|
|
}
|
|
});
|
|
|
|
it("user has the expected permissions", async () => {
|
|
const userYes: Permission[] = [
|
|
"tools:use",
|
|
"files:own",
|
|
"apikeys:own",
|
|
"pipelines:own",
|
|
"settings:read",
|
|
];
|
|
for (const perm of userYes) {
|
|
expect(await hasPermission("user", perm)).toBe(true);
|
|
}
|
|
});
|
|
|
|
it("user does NOT have elevated permissions", async () => {
|
|
const userNo: Permission[] = [
|
|
"files:all",
|
|
"pipelines:all",
|
|
"users:manage",
|
|
"teams:manage",
|
|
"settings:write",
|
|
"features:manage",
|
|
"apikeys:all",
|
|
"system:health",
|
|
"audit:read",
|
|
];
|
|
for (const perm of userNo) {
|
|
expect(await hasPermission("user", perm)).toBe(false);
|
|
}
|
|
});
|
|
|
|
it("unknown role returns false for any permission", async () => {
|
|
expect(await hasPermission("ghost" as Role, "tools:use")).toBe(false);
|
|
expect(await hasPermission("ghost" as Role, "users:manage")).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("hasEffectivePermission extended", () => {
|
|
it("admin without apiKeyPermissions has all permissions", async () => {
|
|
const admin = makeUser({ role: "admin" });
|
|
expect(await hasEffectivePermission(admin, "tools:use")).toBe(true);
|
|
expect(await hasEffectivePermission(admin, "users:manage")).toBe(true);
|
|
expect(await hasEffectivePermission(admin, "audit:read")).toBe(true);
|
|
});
|
|
|
|
it("user with apiKeyPermissions only gets intersecting permissions", async () => {
|
|
const user = makeUser({
|
|
role: "user",
|
|
apiKeyPermissions: ["tools:use", "settings:read"],
|
|
});
|
|
expect(await hasEffectivePermission(user, "tools:use")).toBe(true);
|
|
expect(await hasEffectivePermission(user, "settings:read")).toBe(true);
|
|
expect(await hasEffectivePermission(user, "files:own")).toBe(false);
|
|
});
|
|
|
|
it("apiKeyPermissions that include the permission returns true", async () => {
|
|
const editor = makeUser({
|
|
role: "editor",
|
|
apiKeyPermissions: ["files:all"],
|
|
});
|
|
expect(await hasEffectivePermission(editor, "files:all")).toBe(true);
|
|
});
|
|
|
|
it("apiKeyPermissions that do NOT include the permission returns false", async () => {
|
|
const editor = makeUser({
|
|
role: "editor",
|
|
apiKeyPermissions: ["tools:use"],
|
|
});
|
|
expect(await hasEffectivePermission(editor, "files:all")).toBe(false);
|
|
});
|
|
|
|
it("role lacking the permission returns false even if apiKeyPermissions include it", async () => {
|
|
const user = makeUser({
|
|
role: "user",
|
|
apiKeyPermissions: ["users:manage", "settings:write"],
|
|
});
|
|
expect(await hasEffectivePermission(user, "users:manage")).toBe(false);
|
|
expect(await hasEffectivePermission(user, "settings:write")).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("requirePermission", () => {
|
|
it("returns null and sends 401 when getAuthUser returns null", async () => {
|
|
mockGetAuthUser.mockReturnValue(null);
|
|
const { reply, sent } = makeMockReply();
|
|
const result = await requirePermission("tools:use")({} as never, reply as never);
|
|
expect(result).toBeNull();
|
|
expect(sent.status).toBe(401);
|
|
expect(sent.body).toEqual({
|
|
error: "Authentication required",
|
|
code: "AUTH_REQUIRED",
|
|
});
|
|
});
|
|
|
|
it("returns null and sends 403 when user lacks permission", async () => {
|
|
mockGetAuthUser.mockReturnValue(makeUser({ role: "user" }));
|
|
const { reply, sent } = makeMockReply();
|
|
const result = await requirePermission("users:manage")({} as never, reply as never);
|
|
expect(result).toBeNull();
|
|
expect(sent.status).toBe(403);
|
|
expect(sent.body).toEqual({
|
|
error: "Insufficient permissions",
|
|
code: "FORBIDDEN",
|
|
});
|
|
});
|
|
|
|
it("returns user when user has the permission", async () => {
|
|
const admin = makeUser({ role: "admin" });
|
|
mockGetAuthUser.mockReturnValue(admin);
|
|
const { reply } = makeMockReply();
|
|
const result = await requirePermission("users:manage")({} as never, reply as never);
|
|
expect(result).toEqual(admin);
|
|
});
|
|
|
|
it("returns user when editor has an editor-level permission", async () => {
|
|
const editor = makeUser({ role: "editor" });
|
|
mockGetAuthUser.mockReturnValue(editor);
|
|
const { reply } = makeMockReply();
|
|
const result = await requirePermission("tools:use")({} as never, reply as never);
|
|
expect(result).toEqual(editor);
|
|
});
|
|
});
|
|
|
|
describe("requireOwnershipOrPermission", () => {
|
|
it("returns null and sends 401 when no user", async () => {
|
|
mockGetAuthUser.mockReturnValue(null);
|
|
const { reply, sent } = makeMockReply();
|
|
const result = await requireOwnershipOrPermission(
|
|
{} as never,
|
|
reply as never,
|
|
"other-user",
|
|
"files:all",
|
|
);
|
|
expect(result).toBeNull();
|
|
expect(sent.status).toBe(401);
|
|
});
|
|
|
|
it("returns user when resourceUserId matches user.id (own resource)", async () => {
|
|
const user = makeUser({ role: "user", id: "u-owner" });
|
|
mockGetAuthUser.mockReturnValue(user);
|
|
const { reply } = makeMockReply();
|
|
const result = await requireOwnershipOrPermission(
|
|
{} as never,
|
|
reply as never,
|
|
"u-owner",
|
|
"files:all",
|
|
);
|
|
expect(result).toEqual(user);
|
|
});
|
|
|
|
it("returns user when user has the allPermission", async () => {
|
|
const admin = makeUser({ role: "admin", id: "u-admin" });
|
|
mockGetAuthUser.mockReturnValue(admin);
|
|
const { reply } = makeMockReply();
|
|
const result = await requireOwnershipOrPermission(
|
|
{} as never,
|
|
reply as never,
|
|
"u-someone-else",
|
|
"files:all",
|
|
);
|
|
expect(result).toEqual(admin);
|
|
});
|
|
|
|
it("returns null when not owner and lacks allPermission", async () => {
|
|
const user = makeUser({ role: "user", id: "u-basic" });
|
|
mockGetAuthUser.mockReturnValue(user);
|
|
const { reply } = makeMockReply();
|
|
const result = await requireOwnershipOrPermission(
|
|
{} as never,
|
|
reply as never,
|
|
"u-someone-else",
|
|
"files:all",
|
|
);
|
|
expect(result).toBeNull();
|
|
});
|
|
});
|