Files
gerbeur/api/test/routes/files.test.ts
khannurien d392be7cb8
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 50s
v3: api/ gets one layout rule and keeps to it, and whatever crosses the wire is defined once, in shared/ — api/model/interfaces.ts and src/model.ts declared the same 40 types by hand and had drifted: the error envelope, email required on one side and optional on the other, Invitee/InviteTreeEntry and LinkPreview/UrlPreviewResponse for one shape each. The validation limits, the role permissions, the chat length cap, the @mention pattern and the Bandcamp and YouTube player responses were copied too, behind "keep in sync" comments. shared/ now holds them once, one file per domain (api, category, chat, comment, dump, follow, mention, notification, permissions, player, playlist, search, user, validation, ws), and imports nothing from either half. The server sends Dates; the client reads Wire<T>, the same type with every Date an ISO string, and turns it back with src/utils/shared/deserialize.ts. APIErrorCode becomes a const object, since the frontend's erasableSyntaxOnly rejects an enum. The shared types showed two real gaps: the avatar upload and GET /api/users/me return the full self user and the frontend read them as public users, and a stored session may predate media tokens, so the client keeps it as its own Session type. The backend rule: each folder holds one kind of module, each file is named after its domain. routes/ parse and answer; services/ hold the logic and every SQL query (lib/auth.ts's token check moves to user-service); remote/ is the only place that fetches from other sites — the guarded fetch and the HTML scraping out of rich-content-service, public-address, the Bandcamp and YouTube resolvers, the link providers, the image proxy (fetch, checks and cache, out of routes/preview.ts) and the Twemoji glyphs (out of lib/site-icons.ts). model/ holds per table a row type, its guard and its mappers; validators/ the request guards; db/connection.ts the handle and transaction(), db/startup.ts the purges and default admin that db.ts ran on import, called at the same moment. Tests mirror the source one file per module, test/<layer>/<module>.test.ts, with shared/'s under shared/test/ (deno task test runs both); the test that covered the bandcamp and soundcloud providers together is two now, and the backend can() has its own, so 202 tests. deno lint src/ is clean too: window.* becomes globalThis.*, and test bodies and act() callbacks that never awaited lose their async. The README states the rule. No behaviour changes; the catalogues only move their source references.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 20:19:48 +00:00

192 lines
6.5 KiB
TypeScript

import { createUser, db, get, insertDump, test, TEST_DIR } from "../helpers.ts";
import { assertEquals, assertStringIncludes } from "@std/assert";
const BYTES = new TextEncoder().encode("0123456789");
function createdAtOf(id: string): string {
return (db.prepare(`SELECT created_at FROM dumps WHERE id = ?;`).get(id) as {
created_at: string;
}).created_at;
}
test("GET /api/files/:id: headers for a safe inline type", async () => {
const user = await createUser();
const { id } = insertDump({
userId: user.id,
fileName: "notes.txt",
fileMime: "text/plain",
fileData: BYTES,
});
const res = await get(`/api/files/${id}`);
assertEquals(res.status, 200);
assertEquals(res.bytes, BYTES);
assertEquals(res.headers.get("content-type"), "text/plain");
assertEquals(res.headers.get("content-length"), "10");
assertEquals(res.headers.get("accept-ranges"), "bytes");
assertEquals(res.headers.get("x-content-type-options"), "nosniff");
assertEquals(res.headers.get("referrer-policy"), "no-referrer");
assertStringIncludes(res.headers.get("content-security-policy")!, "sandbox");
assertStringIncludes(res.headers.get("content-disposition")!, "inline;");
// No version in the URL: kept, but asked about again each time.
assertEquals(res.headers.get("cache-control"), "public, no-cache");
const etag = res.headers.get("etag")!;
assertStringIncludes(etag, 'W/"');
// The client already has it: a 304, no bytes.
const again = await get(`/api/files/${id}`, {
headers: { "If-None-Match": etag },
});
assertEquals(again.status, 304);
assertEquals(again.bytes.byteLength, 0);
// The app's URL names the file's current version, which never changes.
const v = `${BYTES.byteLength}-${Date.parse(createdAtOf(id))}`;
assertEquals(
(await get(`/api/files/${id}?v=${v}`)).headers.get("cache-control"),
"public, max-age=31536000, immutable",
);
// A stale version is revalidated like no version at all.
assertEquals(
(await get(`/api/files/${id}?v=10-0`)).headers.get("cache-control"),
"public, no-cache",
);
});
test("GET /api/files/:id: active content downloads instead of rendering", async () => {
const user = await createUser();
for (const mime of ["text/html", "image/svg+xml", "application/xml"]) {
const { id } = insertDump({
userId: user.id,
fileName: "x",
fileMime: mime,
});
const res = await get(`/api/files/${id}`);
assertStringIncludes(
res.headers.get("content-disposition")!,
"attachment;",
mime,
);
}
const pdf = insertDump({
userId: user.id,
fileName: "a.pdf",
fileMime: "application/pdf",
});
const res = await get(`/api/files/${pdf.id}`);
assertStringIncludes(res.headers.get("content-disposition")!, "inline;");
assertEquals(res.headers.get("content-security-policy"), null);
});
test("GET /api/files/:id: a non-Latin-1 filename doesn't break the header", async () => {
const user = await createUser();
const { id } = insertDump({
userId: user.id,
fileName: 'mix "été" 🎵.mp3',
fileMime: "audio/mpeg",
});
const res = await get(`/api/files/${id}`);
assertEquals(res.status, 200);
assertEquals(
res.headers.get("content-disposition"),
`inline; filename="mix __t__ __.mp3"; filename*=UTF-8''${
encodeURIComponent('mix "été" 🎵.mp3')
}`,
);
});
test("GET /api/files/:id: byte ranges", async () => {
const user = await createUser();
const { id } = insertDump({
userId: user.id,
fileName: "d",
fileData: BYTES,
});
const range = (r: string) =>
get(`/api/files/${id}`, { headers: { Range: r } });
let res = await range("bytes=2-5");
assertEquals(res.status, 206);
assertEquals(new TextDecoder().decode(res.bytes), "2345");
assertEquals(res.headers.get("content-range"), "bytes 2-5/10");
assertEquals(res.headers.get("content-length"), "4");
res = await range("bytes=7-");
assertEquals(new TextDecoder().decode(res.bytes), "789");
res = await range("bytes=-3");
assertEquals(new TextDecoder().decode(res.bytes), "789");
assertEquals(res.headers.get("content-range"), "bytes 7-9/10");
// A suffix longer than the file is the whole file.
res = await range("bytes=-100");
assertEquals(new TextDecoder().decode(res.bytes), "0123456789");
assertEquals(res.headers.get("content-range"), "bytes 0-9/10");
res = await range("bytes=5-100");
assertEquals(new TextDecoder().decode(res.bytes), "56789");
for (
const bad of [
"bytes=10-",
"bytes=6-2",
"bytes=-0",
"bytes=-",
]
) {
res = await range(bad);
assertEquals(res.status, 416, bad);
assertEquals(res.headers.get("content-range"), "bytes */10", bad);
}
// Several ranges, or a unit other than bytes, aren't refused: the header is
// ignored and the whole file sent, as RFC 9110 allows.
for (
const unsupported of [
"bytes=0-0,5-6",
"bytes=0-1, 3-4",
"items=0-1",
"bytes=zero-one",
]
) {
res = await range(unsupported);
assertEquals(res.status, 200, unsupported);
assertEquals(new TextDecoder().decode(res.bytes), "0123456789");
assertEquals(res.headers.get("content-range"), null, unsupported);
assertEquals(res.headers.get("content-length"), "10", unsupported);
}
});
test("GET /api/files/:id: private files need the owner's media token", async () => {
const owner = await createUser();
const other = await createUser();
const { id } = insertDump({
userId: owner.id,
fileName: "p",
isPrivate: true,
});
assertEquals((await get(`/api/files/${id}`)).status, 404);
assertEquals(
(await get(`/api/files/${id}?token=${other.mediaToken}`)).status,
404,
);
assertEquals((await get(`/api/files/${id}?token=garbage`)).status, 404);
const res = await get(`/api/files/${id}?token=${owner.mediaToken}`);
assertEquals(res.status, 200);
assertEquals(res.headers.get("cache-control"), "private, no-cache");
// A legacy session token still works in the query string.
assertEquals(
(await get(`/api/files/${id}?token=${owner.token}`)).status,
200,
);
});
test("GET /api/files/:id: bad ids, URL dumps and missing bytes", async () => {
const user = await createUser();
assertEquals((await get(`/api/files/..%2F..%2Fetc%2Fpasswd`)).status, 400);
const url = insertDump({ userId: user.id });
assertEquals((await get(`/api/files/${url.id}`)).status, 404);
const gone = insertDump({ userId: user.id, fileName: "g" });
Deno.removeSync(`${TEST_DIR}/uploads/dumps/${gone.id}`);
assertEquals((await get(`/api/files/${gone.id}`)).status, 404);
});