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
261 lines
8.5 KiB
TypeScript
261 lines
8.5 KiB
TypeScript
/**
|
|
* Test server helper -- builds a real Fastify app with an isolated Postgres
|
|
* database for integration tests.
|
|
*
|
|
* Environment variables (DATABASE_URL, WORKSPACE_PATH) are set per-fork in
|
|
* tests/setup/per-fork-env.ts BEFORE this module is loaded, ensuring
|
|
* apps/api/src/config.ts picks them up.
|
|
*
|
|
* Each call to `buildTestApp()` returns a fresh, fully-wired server instance
|
|
* that can be exercised with `app.inject()` (no port binding required).
|
|
*/
|
|
import { randomUUID } from "node:crypto";
|
|
import { mkdirSync } from "node:fs";
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// 1. Ensure the workspace directory exists. The Postgres database is already
|
|
// created by per-fork-env.ts (cloned from the migrated template).
|
|
// ---------------------------------------------------------------------------
|
|
mkdirSync(process.env.WORKSPACE_PATH!, { recursive: true });
|
|
|
|
import cookie from "@fastify/cookie";
|
|
import cors from "@fastify/cors";
|
|
import { APP_VERSION } from "@snapotter/shared";
|
|
import { eq } from "drizzle-orm";
|
|
// ---------------------------------------------------------------------------
|
|
// 2. Import app modules. config.ts already captured our env vars.
|
|
// ---------------------------------------------------------------------------
|
|
import Fastify from "fastify";
|
|
import { env } from "../../apps/api/src/config.js";
|
|
import { db, schema } from "../../apps/api/src/db/index.js";
|
|
import { runMigrations } from "../../apps/api/src/db/migrate.js";
|
|
import { requirePermission } from "../../apps/api/src/permissions.js";
|
|
import {
|
|
authMiddleware,
|
|
authRoutes,
|
|
ensureBuiltinRoles,
|
|
ensureDefaultAdmin,
|
|
} from "../../apps/api/src/plugins/auth.js";
|
|
import { oidcRoutes } from "../../apps/api/src/plugins/oidc.js";
|
|
import { registerUpload } from "../../apps/api/src/plugins/upload.js";
|
|
import { analyticsRoutes } from "../../apps/api/src/routes/analytics.js";
|
|
import { apiKeyRoutes } from "../../apps/api/src/routes/api-keys.js";
|
|
import { auditLogRoutes } from "../../apps/api/src/routes/audit-log.js";
|
|
import { registerBatchRoutes } from "../../apps/api/src/routes/batch.js";
|
|
import { docsRoutes } from "../../apps/api/src/routes/docs.js";
|
|
import { registerFetchUrlsRoute } from "../../apps/api/src/routes/fetch-urls.js";
|
|
import { fileRoutes } from "../../apps/api/src/routes/files.js";
|
|
import { registerMemeTemplates } from "../../apps/api/src/routes/meme-templates.js";
|
|
import { registerPipelineRoutes } from "../../apps/api/src/routes/pipeline.js";
|
|
import { registerProgressRoutes } from "../../apps/api/src/routes/progress.js";
|
|
import { rolesRoutes } from "../../apps/api/src/routes/roles.js";
|
|
import { settingsRoutes } from "../../apps/api/src/routes/settings.js";
|
|
import { teamsRoutes } from "../../apps/api/src/routes/teams.js";
|
|
import { registerToolRoutes } from "../../apps/api/src/routes/tools/index.js";
|
|
import { userFileRoutes } from "../../apps/api/src/routes/user-files.js";
|
|
|
|
// Run migrations (idempotent -- template already has the schema, but this
|
|
// ensures the __drizzle_migrations journal is consistent in each fork).
|
|
await runMigrations();
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// 3. Public API
|
|
// ---------------------------------------------------------------------------
|
|
export interface TestApp {
|
|
app: ReturnType<typeof Fastify>;
|
|
cleanup: () => Promise<void>;
|
|
}
|
|
|
|
export async function buildTestApp(): Promise<TestApp> {
|
|
// Seed built-in roles and default admin user (both idempotent)
|
|
await ensureBuiltinRoles();
|
|
await ensureDefaultAdmin();
|
|
|
|
// Clear the mustChangePassword flag so tests can use the admin freely
|
|
await db
|
|
.update(schema.users)
|
|
.set({ mustChangePassword: false })
|
|
.where(eq(schema.users.username, "admin"));
|
|
|
|
const app = Fastify({
|
|
logger: false, // quiet during tests
|
|
bodyLimit: env.MAX_UPLOAD_SIZE_MB * 1024 * 1024,
|
|
});
|
|
|
|
// Plugins
|
|
await app.register(cors, { origin: true });
|
|
|
|
// Multipart upload support
|
|
await registerUpload(app);
|
|
|
|
// Cookie support
|
|
await app.register(cookie, { secret: "test-cookie-secret", hook: "onRequest" });
|
|
|
|
// Auth middleware (must be registered before routes)
|
|
await authMiddleware(app);
|
|
|
|
// Auth routes
|
|
await authRoutes(app);
|
|
|
|
// OIDC routes
|
|
await oidcRoutes(app);
|
|
|
|
// File upload/download routes
|
|
await fileRoutes(app);
|
|
|
|
// User file library routes (persistent file management with versioning)
|
|
await userFileRoutes(app);
|
|
|
|
// Meme template routes
|
|
await registerMemeTemplates(app);
|
|
|
|
// Tool routes
|
|
await registerToolRoutes(app);
|
|
|
|
// Batch processing routes
|
|
await registerBatchRoutes(app);
|
|
|
|
// URL fetch routes
|
|
await registerFetchUrlsRoute(app);
|
|
|
|
// Pipeline routes
|
|
await registerPipelineRoutes(app);
|
|
|
|
// Progress SSE routes
|
|
await registerProgressRoutes(app);
|
|
|
|
// API key management routes
|
|
await apiKeyRoutes(app);
|
|
|
|
// Settings routes
|
|
await settingsRoutes(app);
|
|
|
|
// Teams routes
|
|
await teamsRoutes(app);
|
|
|
|
// Audit log routes
|
|
await auditLogRoutes(app);
|
|
|
|
// Roles management routes
|
|
await rolesRoutes(app);
|
|
|
|
// Analytics routes
|
|
await analyticsRoutes(app);
|
|
|
|
// API docs (Scalar)
|
|
await docsRoutes(app);
|
|
|
|
// Public health check (minimal - no internal details)
|
|
app.get("/api/v1/health", async () => ({
|
|
status: "healthy",
|
|
version: APP_VERSION,
|
|
}));
|
|
|
|
// Admin health check (full diagnostics)
|
|
app.get("/api/v1/admin/health", async (request, reply) => {
|
|
const admin = requirePermission("system:health")(request, reply);
|
|
if (!admin) return;
|
|
|
|
let dbOk = false;
|
|
try {
|
|
await db.select().from(schema.settings).limit(1);
|
|
dbOk = true;
|
|
} catch {
|
|
/* db unreachable */
|
|
}
|
|
return {
|
|
status: dbOk ? "healthy" : "degraded",
|
|
version: APP_VERSION,
|
|
uptime: `${process.uptime().toFixed(0)}s`,
|
|
storage: { mode: env.STORAGE_MODE, available: "N/A" },
|
|
database: dbOk ? "ok" : "error",
|
|
queue: { active: 0, pending: 0 },
|
|
ai: {},
|
|
};
|
|
});
|
|
|
|
// Public config endpoint
|
|
app.get("/api/v1/config/auth", async () => {
|
|
const config: Record<string, unknown> = { authEnabled: env.AUTH_ENABLED };
|
|
if (env.OIDC_ENABLED) {
|
|
config.oidcEnabled = true;
|
|
config.oidcProviderName = env.OIDC_PROVIDER_NAME || null;
|
|
config.oidcLoginUrl = "/api/auth/oidc/login";
|
|
}
|
|
return config;
|
|
});
|
|
|
|
// Ensure Fastify is ready (all plugins loaded)
|
|
await app.ready();
|
|
|
|
const cleanup = async () => {
|
|
await app.close();
|
|
// The pg pool is a module-level singleton shared across the fork.
|
|
// Do NOT call closeDb() here; let the fork process exit naturally.
|
|
// Closing prematurely would break tests that run DB queries after
|
|
// the app is closed (e.g. verifying DB state in assertions).
|
|
};
|
|
|
|
return { app, cleanup };
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test helpers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
/** Log in as the default admin and return the session token. */
|
|
export async function loginAsAdmin(app: ReturnType<typeof Fastify>): Promise<string> {
|
|
const res = await app.inject({
|
|
method: "POST",
|
|
url: "/api/auth/login",
|
|
payload: {
|
|
username: "admin",
|
|
password: "Adminpass1",
|
|
},
|
|
});
|
|
const body = JSON.parse(res.body);
|
|
if (!body.token) {
|
|
throw new Error(`Login failed: ${res.body}`);
|
|
}
|
|
return body.token as string;
|
|
}
|
|
|
|
/**
|
|
* Build a multipart/form-data payload for use with `app.inject()`.
|
|
*
|
|
* Fastify's `inject()` doesn't natively support FormData, so we construct
|
|
* the raw multipart body with proper boundaries manually.
|
|
*/
|
|
export function createMultipartPayload(
|
|
fields: Array<{
|
|
name: string;
|
|
filename?: string;
|
|
contentType?: string;
|
|
content: Buffer | string;
|
|
}>,
|
|
): { body: Buffer; contentType: string } {
|
|
const boundary = `----TestBoundary${randomUUID().replace(/-/g, "").slice(0, 16)}`;
|
|
const parts: Buffer[] = [];
|
|
|
|
for (const field of fields) {
|
|
let header = `--${boundary}\r\n`;
|
|
if (field.filename) {
|
|
header += `Content-Disposition: form-data; name="${field.name}"; filename="${field.filename}"\r\n`;
|
|
header += `Content-Type: ${field.contentType || "application/octet-stream"}\r\n`;
|
|
} else {
|
|
header += `Content-Disposition: form-data; name="${field.name}"\r\n`;
|
|
}
|
|
header += "\r\n";
|
|
parts.push(Buffer.from(header));
|
|
parts.push(Buffer.isBuffer(field.content) ? field.content : Buffer.from(field.content));
|
|
parts.push(Buffer.from("\r\n"));
|
|
}
|
|
|
|
parts.push(Buffer.from(`--${boundary}--\r\n`));
|
|
|
|
return {
|
|
body: Buffer.concat(parts),
|
|
contentType: `multipart/form-data; boundary=${boundary}`,
|
|
};
|
|
}
|