Files
SnapOtter/tests/integration/migrate-from-sqlite.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

132 lines
7.1 KiB
TypeScript

import { mkdtempSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import Database from "better-sqlite3";
import { sql } from "drizzle-orm";
import { afterAll, beforeAll, describe, expect, it } from "vitest";
import { db } from "../../apps/api/src/db/index.js";
import { migrateFromSqlite } from "../../apps/api/src/db/migrate-from-sqlite.js";
function buildFixtureSqlite(path: string): void {
const s = new Database(path);
s.exec(`
CREATE TABLE users (id text PRIMARY KEY, username text NOT NULL, password_hash text,
role text NOT NULL DEFAULT 'user', team text NOT NULL DEFAULT 'Default',
must_change_password integer NOT NULL DEFAULT 1, auth_provider text NOT NULL DEFAULT 'local',
external_id text, email text, created_at integer NOT NULL, updated_at integer NOT NULL,
analytics_enabled integer, analytics_consent_shown_at integer, analytics_consent_remind_at integer);
CREATE TABLE teams (id text PRIMARY KEY, name text NOT NULL, created_at integer NOT NULL);
CREATE TABLE settings ("key" text PRIMARY KEY, value text NOT NULL, updated_at integer NOT NULL);
CREATE TABLE roles (id text PRIMARY KEY, name text NOT NULL, description text NOT NULL DEFAULT '',
permissions text NOT NULL, is_builtin integer NOT NULL DEFAULT 0, created_by text,
created_at integer NOT NULL, updated_at integer NOT NULL);
CREATE TABLE sessions (id text PRIMARY KEY, user_id text NOT NULL, expires_at integer NOT NULL,
id_token text, created_at integer NOT NULL);
CREATE TABLE api_keys (id text PRIMARY KEY, user_id text NOT NULL, key_hash text NOT NULL,
key_prefix text, name text NOT NULL DEFAULT 'Default API Key', permissions text,
created_at integer NOT NULL, last_used_at integer, expires_at integer);
CREATE TABLE pipelines (id text PRIMARY KEY, user_id text, name text NOT NULL, description text,
steps text NOT NULL, created_at integer NOT NULL);
CREATE TABLE jobs (id text PRIMARY KEY, type text NOT NULL, status text NOT NULL DEFAULT 'queued',
progress real NOT NULL DEFAULT 0, input_files text NOT NULL, output_path text, settings text,
error text, created_at integer NOT NULL, completed_at integer);
CREATE TABLE audit_log (id text PRIMARY KEY, actor_id text, actor_username text NOT NULL,
action text NOT NULL, target_type text, target_id text, details text, ip_address text,
created_at integer NOT NULL);
CREATE TABLE user_files (id text PRIMARY KEY, user_id text, original_name text NOT NULL,
stored_name text NOT NULL, mime_type text NOT NULL, size integer NOT NULL, width integer,
height integer, version integer NOT NULL DEFAULT 1, parent_id text, tool_chain text,
created_at integer NOT NULL);
`);
const now = 1750000000; // seconds epoch, as 1.x stored
s.prepare(
"INSERT INTO users (id, username, password_hash, must_change_password, created_at, updated_at, analytics_enabled, analytics_consent_shown_at) VALUES (?,?,?,?,?,?,?,?)",
).run("u1", "alice", "hash", 0, now, now, 1, null);
s.prepare("INSERT INTO teams (id, name, created_at) VALUES (?,?,?)").run("t1", "Legal", now);
s.prepare('INSERT INTO settings ("key", value, updated_at) VALUES (?,?,?)').run(
"cookieSecret",
"not-json-value",
now,
);
s.prepare(
"INSERT INTO roles (id, name, permissions, is_builtin, created_by, created_at, updated_at) VALUES (?,?,?,?,?,?,?)",
).run("r1", "auditor", '["audit:read"]', 1, "u1", now, now);
s.prepare("INSERT INTO pipelines (id, user_id, name, steps, created_at) VALUES (?,?,?,?,?)").run(
"p1",
"u1",
"shrink",
'[{"toolId":"compress","settings":{"quality":70}}]',
now,
);
s.prepare(
"INSERT INTO jobs (id, type, status, progress, input_files, created_at, completed_at) VALUES (?,?,?,?,?,?,?)",
).run("j1", "batch", "completed", 1, '["a.png"]', now, null);
s.prepare(
"INSERT INTO audit_log (id, actor_username, action, details, created_at) VALUES (?,?,?,?,?)",
).run("al1", "alice", "login", null, now);
s.prepare(
"INSERT INTO user_files (id, user_id, original_name, stored_name, mime_type, size, version, tool_chain, created_at) VALUES (?,?,?,?,?,?,?,?,?)",
).run("uf1", "u1", "photo.png", "abc123.png", "image/png", 1024, 1, null, now);
s.close();
}
describe("migrate-from-sqlite", () => {
const dir = mkdtempSync(join(tmpdir(), "snapotter-migrator-"));
const sqlitePath = join(dir, "snapotter-1x.db");
beforeAll(async () => {
buildFixtureSqlite(sqlitePath);
// simulate empty 2.0 target: wipe all rows the suite DB may have
await db.execute(
sql`TRUNCATE user_files, audit_log, jobs, pipelines, api_keys, sessions, roles, settings, teams, users CASCADE`,
);
});
afterAll(async () => {
await db.execute(
sql`TRUNCATE user_files, audit_log, jobs, pipelines, api_keys, sessions, roles, settings, teams, users CASCADE`,
);
});
it("copies all rows with converted types", async () => {
const result = await migrateFromSqlite(sqlitePath, { force: false });
expect(result.tables.users).toBe(1);
expect(result.tables.pipelines).toBe(1);
const [user] = (await db.execute(sql`SELECT * FROM users WHERE id = 'u1'`)).rows;
expect(user.username).toBe("alice");
expect(user.must_change_password).toBe(false); // 0 became boolean false
expect(user.analytics_enabled).toBe(true); // 1 became boolean true
expect(user.analytics_consent_shown_at).toBeNull(); // explicit NULL preserved
expect(new Date(user.created_at as string).getTime()).toBe(1750000000 * 1000); // seconds became timestamptz
const [pipeline] = (await db.execute(sql`SELECT * FROM pipelines WHERE id = 'p1'`)).rows;
expect((pipeline.steps as Array<{ toolId: string }>)[0].toolId).toBe("compress"); // text JSON became jsonb
const [setting] = (await db.execute(sql`SELECT * FROM settings WHERE key = 'cookieSecret'`))
.rows;
expect(setting.value).toBe("not-json-value"); // settings.value stayed text, untouched
const [job] = (await db.execute(sql`SELECT * FROM jobs WHERE id = 'j1'`)).rows;
expect(job.completed_at).toBeNull(); // explicit NULL preserved
// audit_log with NULL details
const alRows = (await db.execute(sql`SELECT * FROM audit_log WHERE id = 'al1'`)).rows;
expect(alRows).toHaveLength(1);
expect(alRows[0].details).toBeNull();
expect(result.tables.audit_log).toBe(1);
// user_files with NULL tool_chain
const ufRows = (await db.execute(sql`SELECT * FROM user_files WHERE id = 'uf1'`)).rows;
expect(ufRows).toHaveLength(1);
expect(ufRows[0].tool_chain).toBeNull();
expect(result.tables.user_files).toBe(1);
});
it("refuses a non-empty target without force", async () => {
await expect(migrateFromSqlite(sqlitePath, { force: false })).rejects.toThrow(/non-empty/i);
});
it("force on populated target fails on PK collision and rolls back", async () => {
// The first test already inserted rows; forcing again should hit a PK/unique violation
await expect(migrateFromSqlite(sqlitePath, { force: true })).rejects.toThrow();
// Rollback must leave previous data intact
const { rows } = await db.execute(sql`SELECT count(*)::int AS n FROM users`);
expect(rows[0].n).toBe(1);
});
});