Files
SnapOtter/tests/unit/api/files-route.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

247 lines
7.5 KiB
TypeScript

/**
* Unit tests for file serving route helper functions.
*
* Tests the path traversal guard, content type mapping, and download/upload
* logic helpers from the files route.
*/
import { describe, expect, it, vi } from "vitest";
// ── Mocks ───────────────────────────────────────────────────────────────
vi.mock("../../../apps/api/src/db/index.js", () => ({
db: {},
pool: {},
closeDb: async () => {},
schema: {},
}));
// ── Reproduce helper functions from files.ts ────────────────────────────
function isPathTraversal(segment: string): boolean {
return (
segment.includes("..") ||
segment.includes("/") ||
segment.includes("\\") ||
segment.includes("\0")
);
}
function getContentType(ext: string): string {
const map: Record<string, string> = {
jpg: "image/jpeg",
jpeg: "image/jpeg",
png: "image/png",
webp: "image/webp",
gif: "image/gif",
bmp: "image/bmp",
tiff: "image/tiff",
tif: "image/tiff",
avif: "image/avif",
svg: "image/svg+xml",
pdf: "application/pdf",
zip: "application/zip",
ico: "image/x-icon",
json: "application/json",
jxl: "image/jxl",
dng: "image/x-adobe-dng",
cr2: "image/x-canon-cr2",
nef: "image/x-nikon-nef",
arw: "image/x-sony-arw",
orf: "image/x-olympus-orf",
rw2: "image/x-panasonic-rw2",
tga: "image/x-tga",
psd: "image/vnd.adobe.photoshop",
exr: "image/x-exr",
hdr: "image/vnd.radiance",
heic: "image/heic",
heif: "image/heif",
};
return map[ext] ?? "application/octet-stream";
}
// ── Tests ───────────────────────────────────────────────────────────────
describe("files route logic", () => {
describe("isPathTraversal", () => {
it("detects double dot traversal", () => {
expect(isPathTraversal("..")).toBe(true);
});
it("detects double dot with prefix", () => {
expect(isPathTraversal("foo..bar")).toBe(true);
});
it("detects forward slash", () => {
expect(isPathTraversal("foo/bar")).toBe(true);
});
it("detects backslash", () => {
expect(isPathTraversal("foo\\bar")).toBe(true);
});
it("detects null byte", () => {
expect(isPathTraversal("foo\0bar")).toBe(true);
});
it("allows clean UUID-like segment", () => {
expect(isPathTraversal("550e8400-e29b-41d4-a716-446655440000")).toBe(false);
});
it("allows clean filename", () => {
expect(isPathTraversal("photo.jpg")).toBe(false);
});
it("allows alphanumeric-only segment", () => {
expect(isPathTraversal("abc123")).toBe(false);
});
it("detects relative path traversal (../)", () => {
expect(isPathTraversal("../etc/passwd")).toBe(true);
});
it("detects Windows-style path traversal (..\\)", () => {
expect(isPathTraversal("..\\windows\\system32")).toBe(true);
});
it("allows single dot in filename (extension)", () => {
expect(isPathTraversal("file.name.ext")).toBe(false);
});
it("allows hyphens and underscores", () => {
expect(isPathTraversal("my-file_name")).toBe(false);
});
});
describe("getContentType", () => {
it("maps jpg to image/jpeg", () => {
expect(getContentType("jpg")).toBe("image/jpeg");
});
it("maps jpeg to image/jpeg", () => {
expect(getContentType("jpeg")).toBe("image/jpeg");
});
it("maps png to image/png", () => {
expect(getContentType("png")).toBe("image/png");
});
it("maps webp to image/webp", () => {
expect(getContentType("webp")).toBe("image/webp");
});
it("maps gif to image/gif", () => {
expect(getContentType("gif")).toBe("image/gif");
});
it("maps bmp to image/bmp", () => {
expect(getContentType("bmp")).toBe("image/bmp");
});
it("maps tiff to image/tiff", () => {
expect(getContentType("tiff")).toBe("image/tiff");
});
it("maps tif to image/tiff", () => {
expect(getContentType("tif")).toBe("image/tiff");
});
it("maps avif to image/avif", () => {
expect(getContentType("avif")).toBe("image/avif");
});
it("maps svg to image/svg+xml", () => {
expect(getContentType("svg")).toBe("image/svg+xml");
});
it("maps pdf to application/pdf", () => {
expect(getContentType("pdf")).toBe("application/pdf");
});
it("maps zip to application/zip", () => {
expect(getContentType("zip")).toBe("application/zip");
});
it("maps ico to image/x-icon", () => {
expect(getContentType("ico")).toBe("image/x-icon");
});
it("maps json to application/json", () => {
expect(getContentType("json")).toBe("application/json");
});
it("maps jxl to image/jxl", () => {
expect(getContentType("jxl")).toBe("image/jxl");
});
it("maps RAW formats correctly", () => {
expect(getContentType("dng")).toBe("image/x-adobe-dng");
expect(getContentType("cr2")).toBe("image/x-canon-cr2");
expect(getContentType("nef")).toBe("image/x-nikon-nef");
expect(getContentType("arw")).toBe("image/x-sony-arw");
expect(getContentType("orf")).toBe("image/x-olympus-orf");
expect(getContentType("rw2")).toBe("image/x-panasonic-rw2");
});
it("maps specialty formats correctly", () => {
expect(getContentType("tga")).toBe("image/x-tga");
expect(getContentType("psd")).toBe("image/vnd.adobe.photoshop");
expect(getContentType("exr")).toBe("image/x-exr");
expect(getContentType("hdr")).toBe("image/vnd.radiance");
});
it("maps HEIC/HEIF formats correctly", () => {
expect(getContentType("heic")).toBe("image/heic");
expect(getContentType("heif")).toBe("image/heif");
});
it("returns application/octet-stream for unknown extension", () => {
expect(getContentType("xyz")).toBe("application/octet-stream");
});
it("returns application/octet-stream for empty string", () => {
expect(getContentType("")).toBe("application/octet-stream");
});
});
describe("filename encoding for Content-Disposition", () => {
it("encodes special characters", () => {
const filename = "my photo (1).jpg";
const encoded = encodeURIComponent(filename);
expect(encoded).toBe("my%20photo%20(1).jpg");
});
it("preserves simple filenames", () => {
const filename = "photo.jpg";
const encoded = encodeURIComponent(filename);
expect(encoded).toBe("photo.jpg");
});
it("encodes unicode characters", () => {
const filename = "写真.png";
const encoded = encodeURIComponent(filename);
expect(encoded).toContain("%");
});
});
describe("extension extraction from filename", () => {
it("extracts extension from simple filename", () => {
const filename = "photo.jpg";
const ext = filename.split(".").pop()?.toLowerCase() ?? "";
expect(ext).toBe("jpg");
});
it("handles filename with multiple dots", () => {
const filename = "my.photo.2024.png";
const ext = filename.split(".").pop()?.toLowerCase() ?? "";
expect(ext).toBe("png");
});
it("handles filename without extension", () => {
const filename = "no-extension";
const parts = filename.split(".");
const ext = parts.length > 1 ? (parts.pop()?.toLowerCase() ?? "") : "";
expect(ext).toBe("");
});
});
});