Files
SnapOtter/tests/unit/api/tool-factory.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

176 lines
5.6 KiB
TypeScript

import { describe, expect, it, vi } from "vitest";
vi.mock("../../../apps/api/src/db/index.js", () => ({
db: {
select: () => ({
from: () => ({ where: () => ({ get: () => null }) }),
}),
insert: () => ({ values: () => ({ run: vi.fn() }) }),
},
pool: {},
closeDb: async () => {},
schema: { settings: {}, userFiles: {} },
}));
vi.mock("../../../apps/api/src/config.js", () => ({
env: {
WORKSPACE_PATH: "/tmp/test",
MAX_MEGAPIXELS: 100,
MAX_SVG_SIZE_MB: 10,
},
}));
import type { AnyToolRouteConfig } from "../../../apps/api/src/routes/tool-factory.js";
import {
getRegisteredToolIds,
getToolConfig,
registerToolProcessFn,
} from "../../../apps/api/src/routes/tool-factory.js";
const mockSchema = {
safeParse: (data: unknown) => ({ success: true, data }),
parse: (data: unknown) => data,
};
const strictSchema = {
safeParse: (data: unknown) => {
const obj = data as Record<string, unknown>;
if (typeof obj?.quality !== "number" || obj.quality < 1 || obj.quality > 100) {
return { success: false, error: { issues: [{ message: "Invalid" }] } };
}
return { success: true, data };
},
parse: (data: unknown) => data,
};
function makeMockConfig(toolId: string): AnyToolRouteConfig {
return {
toolId,
settingsSchema: mockSchema as never,
process: async (buf: Buffer, _settings: unknown, filename: string) => ({
buffer: buf,
filename,
contentType: "image/png",
}),
};
}
describe("tool-factory registry functions", () => {
const uniqueId = () => `test-tool-${Math.random().toString(36).slice(2, 10)}`;
describe("registerToolProcessFn", () => {
it("adds a tool to the registry", () => {
const id = uniqueId();
registerToolProcessFn(makeMockConfig(id));
expect(getToolConfig(id)).toBeDefined();
});
it("stores the correct config", () => {
const id = uniqueId();
const config = makeMockConfig(id);
registerToolProcessFn(config);
const stored = getToolConfig(id);
expect(stored?.toolId).toBe(id);
expect(stored?.process).toBe(config.process);
expect(stored?.settingsSchema).toBe(config.settingsSchema);
});
});
describe("getToolConfig", () => {
it("returns the config for a registered tool", () => {
const id = uniqueId();
registerToolProcessFn(makeMockConfig(id));
const config = getToolConfig(id);
expect(config).toBeDefined();
expect(config?.toolId).toBe(id);
});
it("returns undefined for an unregistered tool", () => {
expect(getToolConfig("nonexistent-tool-xyz-999")).toBeUndefined();
});
});
describe("getRegisteredToolIds", () => {
it("includes a registered tool", () => {
const id = uniqueId();
registerToolProcessFn(makeMockConfig(id));
expect(getRegisteredToolIds()).toContain(id);
});
it("includes multiple registered tools", () => {
const id1 = uniqueId();
const id2 = uniqueId();
registerToolProcessFn(makeMockConfig(id1));
registerToolProcessFn(makeMockConfig(id2));
const ids = getRegisteredToolIds();
expect(ids).toContain(id1);
expect(ids).toContain(id2);
});
it("returns an array", () => {
expect(Array.isArray(getRegisteredToolIds())).toBe(true);
});
});
describe("overwrite behavior", () => {
it("later registration overwrites earlier for the same toolId", async () => {
const id = uniqueId();
const original = makeMockConfig(id);
registerToolProcessFn(original);
const replacement: AnyToolRouteConfig = {
toolId: id,
settingsSchema: strictSchema as never,
process: async (buf: Buffer, _settings: unknown, filename: string) => ({
buffer: buf,
filename: `replaced-${filename}`,
contentType: "image/jpeg",
}),
};
registerToolProcessFn(replacement);
const stored = getToolConfig(id);
expect(stored?.process).toBe(replacement.process);
expect(stored?.settingsSchema).toBe(replacement.settingsSchema);
expect(stored?.process).not.toBe(original.process);
});
it("overwriting does not change the count for that toolId", () => {
const id = uniqueId();
registerToolProcessFn(makeMockConfig(id));
const countBefore = getRegisteredToolIds().filter((x) => x === id).length;
registerToolProcessFn(makeMockConfig(id));
const countAfter = getRegisteredToolIds().filter((x) => x === id).length;
expect(countBefore).toBe(1);
expect(countAfter).toBe(1);
});
});
describe("process function execution", () => {
it("stored process function returns expected output", async () => {
const id = uniqueId();
registerToolProcessFn(makeMockConfig(id));
const config = getToolConfig(id)!;
const input = Buffer.from("test-data");
const result = await config.process(input, {}, "photo.png");
expect(result.buffer).toBe(input);
expect(result.filename).toBe("photo.png");
expect(result.contentType).toBe("image/png");
});
it("stored process function with custom schema validates correctly", () => {
const id = uniqueId();
registerToolProcessFn({
toolId: id,
settingsSchema: strictSchema as never,
process: async (buf, _s, fn) => ({ buffer: buf, filename: fn, contentType: "image/png" }),
});
const config = getToolConfig(id)!;
const valid = config.settingsSchema.safeParse({ quality: 50 });
expect(valid.success).toBe(true);
const invalid = config.settingsSchema.safeParse({ quality: 200 });
expect(invalid.success).toBe(false);
});
});
});