mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
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
This commit is contained in:
SnapOtter
+114
-124
@@ -13,24 +13,24 @@ import {
|
||||
startCleanupCron,
|
||||
} from "../../apps/api/src/lib/cleanup.js";
|
||||
|
||||
beforeAll(() => {
|
||||
runMigrations();
|
||||
beforeAll(async () => {
|
||||
await runMigrations();
|
||||
});
|
||||
|
||||
function setSetting(key: string, value: string) {
|
||||
const existing = db.select().from(schema.settings).where(eq(schema.settings.key, key)).get();
|
||||
async function setSetting(key: string, value: string) {
|
||||
const [existing] = await db.select().from(schema.settings).where(eq(schema.settings.key, key));
|
||||
if (existing) {
|
||||
db.update(schema.settings)
|
||||
await db
|
||||
.update(schema.settings)
|
||||
.set({ value, updatedAt: new Date() })
|
||||
.where(eq(schema.settings.key, key))
|
||||
.run();
|
||||
.where(eq(schema.settings.key, key));
|
||||
} else {
|
||||
db.insert(schema.settings).values({ key, value }).run();
|
||||
await db.insert(schema.settings).values({ key, value });
|
||||
}
|
||||
}
|
||||
|
||||
function removeSetting(key: string) {
|
||||
db.delete(schema.settings).where(eq(schema.settings.key, key)).run();
|
||||
async function removeSetting(key: string) {
|
||||
await db.delete(schema.settings).where(eq(schema.settings.key, key));
|
||||
}
|
||||
|
||||
async function waitForCleanup(): Promise<void> {
|
||||
@@ -39,69 +39,69 @@ async function waitForCleanup(): Promise<void> {
|
||||
}
|
||||
}
|
||||
|
||||
afterEach(() => {
|
||||
removeSetting("tempFileMaxAgeHours");
|
||||
removeSetting("startupCleanup");
|
||||
afterEach(async () => {
|
||||
await removeSetting("tempFileMaxAgeHours");
|
||||
await removeSetting("startupCleanup");
|
||||
});
|
||||
|
||||
describe("getMaxAgeMs", () => {
|
||||
it("returns DB value when tempFileMaxAgeHours is set", () => {
|
||||
setSetting("tempFileMaxAgeHours", "48");
|
||||
const result = getMaxAgeMs();
|
||||
it("returns DB value when tempFileMaxAgeHours is set", async () => {
|
||||
await setSetting("tempFileMaxAgeHours", "48");
|
||||
const result = await getMaxAgeMs();
|
||||
expect(result).toBe(48 * 60 * 60 * 1000);
|
||||
});
|
||||
|
||||
it("returns env fallback when no DB setting exists", () => {
|
||||
removeSetting("tempFileMaxAgeHours");
|
||||
const result = getMaxAgeMs();
|
||||
it("returns env fallback when no DB setting exists", async () => {
|
||||
await removeSetting("tempFileMaxAgeHours");
|
||||
const result = await getMaxAgeMs();
|
||||
expect(result).toBe(1 * 60 * 60 * 1000);
|
||||
});
|
||||
|
||||
it("returns env fallback for invalid (non-numeric) DB value", () => {
|
||||
setSetting("tempFileMaxAgeHours", "notanumber");
|
||||
const result = getMaxAgeMs();
|
||||
it("returns env fallback for invalid (non-numeric) DB value", async () => {
|
||||
await setSetting("tempFileMaxAgeHours", "notanumber");
|
||||
const result = await getMaxAgeMs();
|
||||
expect(result).toBe(1 * 60 * 60 * 1000);
|
||||
});
|
||||
|
||||
it("returns env fallback for zero or negative DB value", () => {
|
||||
setSetting("tempFileMaxAgeHours", "0");
|
||||
const result = getMaxAgeMs();
|
||||
it("returns env fallback for zero or negative DB value", async () => {
|
||||
await setSetting("tempFileMaxAgeHours", "0");
|
||||
const result = await getMaxAgeMs();
|
||||
expect(result).toBe(1 * 60 * 60 * 1000);
|
||||
|
||||
setSetting("tempFileMaxAgeHours", "-5");
|
||||
const result2 = getMaxAgeMs();
|
||||
await setSetting("tempFileMaxAgeHours", "-5");
|
||||
const result2 = await getMaxAgeMs();
|
||||
expect(result2).toBe(1 * 60 * 60 * 1000);
|
||||
});
|
||||
|
||||
it("handles fractional hours", () => {
|
||||
setSetting("tempFileMaxAgeHours", "0.5");
|
||||
const result = getMaxAgeMs();
|
||||
it("handles fractional hours", async () => {
|
||||
await setSetting("tempFileMaxAgeHours", "0.5");
|
||||
const result = await getMaxAgeMs();
|
||||
expect(result).toBe(0.5 * 60 * 60 * 1000);
|
||||
});
|
||||
});
|
||||
|
||||
describe("shouldRunStartupCleanup", () => {
|
||||
it("returns false when setting is 'false'", () => {
|
||||
setSetting("startupCleanup", "false");
|
||||
expect(shouldRunStartupCleanup()).toBe(false);
|
||||
it("returns false when setting is 'false'", async () => {
|
||||
await setSetting("startupCleanup", "false");
|
||||
expect(await shouldRunStartupCleanup()).toBe(false);
|
||||
});
|
||||
|
||||
it("returns true when setting is 'true'", () => {
|
||||
setSetting("startupCleanup", "true");
|
||||
expect(shouldRunStartupCleanup()).toBe(true);
|
||||
it("returns true when setting is 'true'", async () => {
|
||||
await setSetting("startupCleanup", "true");
|
||||
expect(await shouldRunStartupCleanup()).toBe(true);
|
||||
});
|
||||
|
||||
it("returns true when setting is not set", () => {
|
||||
removeSetting("startupCleanup");
|
||||
expect(shouldRunStartupCleanup()).toBe(true);
|
||||
it("returns true when setting is not set", async () => {
|
||||
await removeSetting("startupCleanup");
|
||||
expect(await shouldRunStartupCleanup()).toBe(true);
|
||||
});
|
||||
|
||||
it("returns true for any value other than 'false'", () => {
|
||||
setSetting("startupCleanup", "yes");
|
||||
expect(shouldRunStartupCleanup()).toBe(true);
|
||||
it("returns true for any value other than 'false'", async () => {
|
||||
await setSetting("startupCleanup", "yes");
|
||||
expect(await shouldRunStartupCleanup()).toBe(true);
|
||||
|
||||
setSetting("startupCleanup", "1");
|
||||
expect(shouldRunStartupCleanup()).toBe(true);
|
||||
await setSetting("startupCleanup", "1");
|
||||
expect(await shouldRunStartupCleanup()).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -109,42 +109,42 @@ describe("startCleanupCron", () => {
|
||||
let tempDir: string;
|
||||
let originalWorkspacePath: string;
|
||||
|
||||
beforeEach(() => {
|
||||
beforeEach(async () => {
|
||||
tempDir = join(tmpdir(), `cleanup-test-${randomUUID().slice(0, 8)}`);
|
||||
originalWorkspacePath = env.WORKSPACE_PATH;
|
||||
env.WORKSPACE_PATH = tempDir;
|
||||
setSetting("startupCleanup", "false");
|
||||
await setSetting("startupCleanup", "false");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
afterEach(async () => {
|
||||
env.WORKSPACE_PATH = originalWorkspacePath;
|
||||
removeSetting("startupCleanup");
|
||||
await removeSetting("startupCleanup");
|
||||
if (existsSync(tempDir)) {
|
||||
rmSync(tempDir, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
it("returns object with stop() method", () => {
|
||||
it("returns object with stop() method", async () => {
|
||||
vi.useFakeTimers();
|
||||
const cron = startCleanupCron();
|
||||
const cron = await startCleanupCron();
|
||||
expect(typeof cron.stop).toBe("function");
|
||||
cron.stop();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("creates workspace directory", () => {
|
||||
it("creates workspace directory", async () => {
|
||||
vi.useFakeTimers();
|
||||
expect(existsSync(tempDir)).toBe(false);
|
||||
const cron = startCleanupCron();
|
||||
const cron = await startCleanupCron();
|
||||
expect(existsSync(tempDir)).toBe(true);
|
||||
cron.stop();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("stop() clears intervals", () => {
|
||||
it("stop() clears intervals", async () => {
|
||||
vi.useFakeTimers();
|
||||
const clearSpy = vi.spyOn(globalThis, "clearInterval");
|
||||
const cron = startCleanupCron();
|
||||
const cron = await startCleanupCron();
|
||||
cron.stop();
|
||||
expect(clearSpy).toHaveBeenCalledTimes(2);
|
||||
clearSpy.mockRestore();
|
||||
@@ -158,8 +158,8 @@ describe("startCleanupCron", () => {
|
||||
const pastTime = new Date(Date.now() - 2 * 60 * 60 * 1000);
|
||||
utimesSync(oldFile, pastTime, pastTime);
|
||||
|
||||
setSetting("startupCleanup", "true");
|
||||
const cron = startCleanupCron();
|
||||
await setSetting("startupCleanup", "true");
|
||||
const cron = await startCleanupCron();
|
||||
await waitForCleanup();
|
||||
expect(existsSync(oldFile)).toBe(false);
|
||||
cron.stop();
|
||||
@@ -170,8 +170,8 @@ describe("startCleanupCron", () => {
|
||||
const recentFile = join(tempDir, "recent-file.txt");
|
||||
writeFileSync(recentFile, "recent content");
|
||||
|
||||
setSetting("startupCleanup", "true");
|
||||
const cron = startCleanupCron();
|
||||
await setSetting("startupCleanup", "true");
|
||||
const cron = await startCleanupCron();
|
||||
await waitForCleanup();
|
||||
expect(existsSync(recentFile)).toBe(true);
|
||||
cron.stop();
|
||||
@@ -187,8 +187,8 @@ describe("startCleanupCron", () => {
|
||||
utimesSync(nestedFile, pastTime, pastTime);
|
||||
utimesSync(oldDir, pastTime, pastTime);
|
||||
|
||||
setSetting("startupCleanup", "true");
|
||||
const cron = startCleanupCron();
|
||||
await setSetting("startupCleanup", "true");
|
||||
const cron = await startCleanupCron();
|
||||
await waitForCleanup();
|
||||
expect(existsSync(oldDir)).toBe(false);
|
||||
cron.stop();
|
||||
@@ -201,97 +201,87 @@ describe("startCleanupCron", () => {
|
||||
const pastTime = new Date(Date.now() - 2 * 60 * 60 * 1000);
|
||||
utimesSync(oldFile, pastTime, pastTime);
|
||||
|
||||
setSetting("startupCleanup", "false");
|
||||
const cron = startCleanupCron();
|
||||
await setSetting("startupCleanup", "false");
|
||||
const cron = await startCleanupCron();
|
||||
await waitForCleanup();
|
||||
expect(existsSync(oldFile)).toBe(true);
|
||||
cron.stop();
|
||||
});
|
||||
|
||||
it("purges expired sessions on startup when enabled", () => {
|
||||
it("purges expired sessions on startup when enabled", async () => {
|
||||
const pastDate = new Date(Date.now() - 24 * 60 * 60 * 1000);
|
||||
|
||||
const userId = `test-user-${randomUUID().slice(0, 8)}`;
|
||||
const existing = db.select().from(schema.users).where(eq(schema.users.id, userId)).get();
|
||||
const [existing] = await db.select().from(schema.users).where(eq(schema.users.id, userId));
|
||||
if (!existing) {
|
||||
db.insert(schema.users)
|
||||
.values({
|
||||
id: userId,
|
||||
username: `cleanup-test-${randomUUID().slice(0, 8)}`,
|
||||
passwordHash: "hash",
|
||||
role: "user",
|
||||
team: "Default",
|
||||
mustChangePassword: false,
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
const sessionId = `sess-${randomUUID().slice(0, 8)}`;
|
||||
db.insert(schema.sessions)
|
||||
.values({
|
||||
id: sessionId,
|
||||
userId,
|
||||
expiresAt: pastDate,
|
||||
})
|
||||
.run();
|
||||
|
||||
setSetting("startupCleanup", "true");
|
||||
const cron = startCleanupCron();
|
||||
|
||||
const session = db
|
||||
.select()
|
||||
.from(schema.sessions)
|
||||
.where(eq(schema.sessions.id, sessionId))
|
||||
.get();
|
||||
expect(session).toBeUndefined();
|
||||
cron.stop();
|
||||
|
||||
db.delete(schema.users).where(eq(schema.users.id, userId)).run();
|
||||
});
|
||||
|
||||
it("does not purge non-expired sessions", () => {
|
||||
const futureDate = new Date(Date.now() + 24 * 60 * 60 * 1000);
|
||||
|
||||
const userId = `test-user-${randomUUID().slice(0, 8)}`;
|
||||
db.insert(schema.users)
|
||||
.values({
|
||||
await db.insert(schema.users).values({
|
||||
id: userId,
|
||||
username: `cleanup-keep-${randomUUID().slice(0, 8)}`,
|
||||
username: `cleanup-test-${randomUUID().slice(0, 8)}`,
|
||||
passwordHash: "hash",
|
||||
role: "user",
|
||||
team: "Default",
|
||||
mustChangePassword: false,
|
||||
})
|
||||
.run();
|
||||
});
|
||||
}
|
||||
|
||||
const sessionId = `sess-${randomUUID().slice(0, 8)}`;
|
||||
db.insert(schema.sessions)
|
||||
.values({
|
||||
id: sessionId,
|
||||
userId,
|
||||
expiresAt: futureDate,
|
||||
})
|
||||
.run();
|
||||
await db.insert(schema.sessions).values({
|
||||
id: sessionId,
|
||||
userId,
|
||||
expiresAt: pastDate,
|
||||
});
|
||||
|
||||
setSetting("startupCleanup", "true");
|
||||
const cron = startCleanupCron();
|
||||
await setSetting("startupCleanup", "true");
|
||||
const cron = await startCleanupCron();
|
||||
|
||||
const session = db
|
||||
const [session] = await db
|
||||
.select()
|
||||
.from(schema.sessions)
|
||||
.where(eq(schema.sessions.id, sessionId))
|
||||
.get();
|
||||
.where(eq(schema.sessions.id, sessionId));
|
||||
expect(session).toBeUndefined();
|
||||
cron.stop();
|
||||
|
||||
await db.delete(schema.users).where(eq(schema.users.id, userId));
|
||||
});
|
||||
|
||||
it("does not purge non-expired sessions", async () => {
|
||||
const futureDate = new Date(Date.now() + 24 * 60 * 60 * 1000);
|
||||
|
||||
const userId = `test-user-${randomUUID().slice(0, 8)}`;
|
||||
await db.insert(schema.users).values({
|
||||
id: userId,
|
||||
username: `cleanup-keep-${randomUUID().slice(0, 8)}`,
|
||||
passwordHash: "hash",
|
||||
role: "user",
|
||||
team: "Default",
|
||||
mustChangePassword: false,
|
||||
});
|
||||
|
||||
const sessionId = `sess-${randomUUID().slice(0, 8)}`;
|
||||
await db.insert(schema.sessions).values({
|
||||
id: sessionId,
|
||||
userId,
|
||||
expiresAt: futureDate,
|
||||
});
|
||||
|
||||
await setSetting("startupCleanup", "true");
|
||||
const cron = await startCleanupCron();
|
||||
|
||||
const [session] = await db
|
||||
.select()
|
||||
.from(schema.sessions)
|
||||
.where(eq(schema.sessions.id, sessionId));
|
||||
expect(session).toBeDefined();
|
||||
cron.stop();
|
||||
|
||||
db.delete(schema.sessions).where(eq(schema.sessions.id, sessionId)).run();
|
||||
db.delete(schema.users).where(eq(schema.users.id, userId)).run();
|
||||
await db.delete(schema.sessions).where(eq(schema.sessions.id, sessionId));
|
||||
await db.delete(schema.users).where(eq(schema.users.id, userId));
|
||||
});
|
||||
|
||||
it("handles empty workspace directory gracefully", async () => {
|
||||
mkdirSync(tempDir, { recursive: true });
|
||||
setSetting("startupCleanup", "true");
|
||||
const cron = startCleanupCron();
|
||||
await setSetting("startupCleanup", "true");
|
||||
const cron = await startCleanupCron();
|
||||
await waitForCleanup();
|
||||
expect(existsSync(tempDir)).toBe(true);
|
||||
cron.stop();
|
||||
|
||||
Reference in New Issue
Block a user