vincent/gerbeur
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

v4: every page and API URL follows one of two rules, written down in API.md — pages are a hierarchy where @name is a user and any other root word a category or an app page, tabs and views are plain segments and a default view is the bare path; API resources are /api/<plural>/<key>, a user's key being an id or @name, the caller's things under /api/me, media a sub-resource, lookups by another key a query filter. ~ is gone: the feed is /, /hot, /new, /journal, /follow and /music/hot, a profile /@bob with its overview and the tabs dumps, upvoted, playlists (her own only), follow (users, and /follow/playlists), invitees and manage (role and name, for user:manage), which replace the separate UserDumps, UserUpvoted and UserPlaylists pages; /settings holds the account (now with the username) and /manage the category manager, both linked from the user menu and one's profile. Dumps and playlists live under their owner, /@bob/dumps/<slug> and /@bob/playlists/<slug>, named by slug alone: migration 0021 re-slugs them to the bare slugify(title), unique per owner and kind (the oldest keeps it, clashes get -2), renames the categories whose slug v4 reserves (hot, follow, settings…), and rewrites this site's v3 links in dump notes, comments, chat, and playlist and profile descriptions. A slug changes only when edited, through the edit forms' new link field, which proposes slugify(title) as the title changes; a username changes from /settings or, for user:manage, from /@name/manage. Every slug or name left behind stays an alias of its item or user for good (dump_slug_aliases, playlist_slug_aliases, user_aliases), so old links redirect without chaining and nobody else can take one; slugs change 3 times a day per item, names once in 30 days, moderators exempt. An alias, or a name in another case, answers the item with its current path: the pages put it in their URL (useCanonicalPath, without fetching again), and the OG middleware answers a 301. shared/paths.ts builds and parses every page path, for the client's links, the emails' (digest-service lost its own builders and its id fallbacks, and links /follow and /settings) and the server's matchers (OG tags, self previews, backlinks, self-url); shared/slug.ts holds slugify and the format categories share. Dumps and playlists carry ownerUsername and a required slug, and notifications join their users' current names and their items' paths each time they are sent or read, so renames reach them and a deleted item's has no link. The API was renamed per the plan's table: POST /api/users and /api/sessions, /api/password-resets, /api/me (with settings, password, avatar, media-token, playlists?contains=, follow, feed?from=, notifications), /api/users/:key/{dumps,upvoted,playlists,follow/users,follow/playlists,invitees,avatar} and by path /api/users/:key/{dumps,playlists}/:slug, /api/dumps?url= and ?category=, /api/dumps/:id/{file,thumbnail,metadata}, /api/playlists/:id/cover, /api/remote/{preview,image,bandcamp,youtube} (one router), and /api/unsubscribe, the v3 POST /api/users/unsubscribe staying for the digests already sent. A stored default feed tab "followed" reads as "follow" once. dumps.slug and playlists.slug stay nullable, since SQLite can't add NOT NULL without rebuilding tables others reference; every writer sets them and unique (user_id, slug) indexes hold them. 254 backend tests (new: migration 0021 on a v3 fixture, slug aliases, swaps and rate limits, username renames, aliases and limits, reads by path and their privacy, the OG 301s, both unsubscribe paths, v4-shaped digest links with no ids, notification joins, shared paths and slugs) and 668 frontend tests (new: the profile's tabs and follow views, Settings, Manage, the link field, canonical URLs on the dump, playlist and profile pages, bare default feed paths) pass, and tsc, eslint, deno check, deno lint, deno fmt and doc:lint are clean; the migration was also run on a copy of the development database.

Browse Source 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
khannurien
2026-10-06 16:08:59 +00:00
parent fd0d81fe66
commit 4468438ba7
228 changed files with 7320 additions and 5193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
api/test/routes/playlists.test.ts
View File

@@ -26,7 +26,7 @@ function ids(res: ApiResponse<PlaylistWithDumps>): string[] {
return res.data.dumps.map((d) => d.id);
}
test("POST /api/playlists creates; GET finds it by id or slug", async () => {
test("POST /api/playlists creates; GET finds it by id, or by path under its owner", async () => {
const user = await createUser();
const res = await post<Playlist>("/api/playlists", {
auth: user.auth,
@@ -34,12 +34,16 @@ test("POST /api/playlists creates; GET finds it by id or slug", async () => {
});
assertEquals(res.status, 201);
const { id, slug } = res.data;
assertMatch(slug ?? "", /^road-trip-/);
assertEquals(slug, "road-trip");
assertEquals(res.data.ownerUsername, user.username);
assertEquals(
(await get<PlaylistWithDumps>(`/api/playlists/${id}`)).data.title,
"Road Trip",
);
const bySlug = await get<PlaylistWithDumps>(`/api/playlists/${slug}`);
assertEquals((await get(`/api/playlists/${slug}`)).status, 404);
const bySlug = await get<PlaylistWithDumps>(
`/api/users/@${user.username}/playlists/${slug}`,
);
assertEquals(bySlug.data.id, id);
assertEquals(bySlug.data.ownerUsername, user.username);
assertEquals(bySlug.data.dumps, []);
@@ -69,7 +73,7 @@ test("private playlists are the owner's alone", async () => {
200,
);
insertPlaylist({ userId: owner.id });
const path = `/api/users/${owner.username}/playlists`;
const path = `/api/users/@${owner.username}/playlists`;
assertEquals((await get<PaginatedData<Playlist>>(path)).data.items.length, 1);
assertEquals(
(await get<PaginatedData<Playlist>>(path, { auth: owner.auth })).data.items
@@ -220,8 +224,28 @@ test("removing a dump; updating; deleting", async () => {
json: { title: "New", description: "d", isPublic: false },
});
assertEquals(updated.data.title, "New");
assertMatch(updated.data.slug ?? "", /^new-/);
// A new title never changes the slug by itself; a slug sent does.
assertEquals(updated.data.slug, "old");
assertEquals(updated.data.isPublic, false);
const reslugged = await put<Playlist>(`/api/playlists/${id}`, {
auth: owner.auth,
json: { slug: "new" },
});
assertEquals(reslugged.data.slug, "new");
assertEquals(
(await get<PlaylistWithDumps>(
`/api/users/@${owner.username}/playlists/old`,
{ auth: owner.auth },
)).data.slug,
"new",
);
assertEquals(
(await put(`/api/playlists/${id}`, {
auth: owner.auth,
json: { slug: "Bad slug" },
})).status,
400,
);
const cleared = await put<Playlist>(`/api/playlists/${id}`, {
auth: owner.auth,
json: { description: null },
@@ -253,7 +277,7 @@ test("memberships: which of my playlists hold this dump", async () => {
const d = insertDump({ userId: owner.id });
await post(`/api/playlists/${p1.id}/dumps/${d.id}`, { auth: owner.auth });
const res = await get<PlaylistMembership[]>(
`/api/playlists/by-dump/${d.id}/memberships`,
`/api/me/playlists?contains=${d.id}`,
{
auth: owner.auth,
},
@@ -273,7 +297,7 @@ test("adding to a followed public playlist notifies followers, private dumps exc
const owner = await createUser();
const follower = await createUser();
const { id } = insertPlaylist({ userId: owner.id, title: "Mix" });
await post(`/api/follows/playlists/${id}`, { auth: follower.auth });
await put(`/api/me/follow/playlists/${id}`, { auth: follower.auth });
db.exec(`DELETE FROM notifications;`); // the follow notified the owner
const priv = insertDump({ userId: owner.id, isPrivate: true });
await post(`/api/playlists/${id}/dumps/${priv.id}`, { auth: owner.auth });
@@ -296,20 +320,20 @@ test("adding to a followed public playlist notifies followers, private dumps exc
});
});
test("playlist images: upload and serve", async () => {
test("playlist covers: upload and serve", async () => {
const owner = await createUser();
const other = await createUser();
const { id, slug } = insertPlaylist({ userId: owner.id });
assertEquals((await get(`/api/playlists/${id}/image`)).status, 404);
const { id } = insertPlaylist({ userId: owner.id });
assertEquals((await get(`/api/playlists/${id}/cover`)).status, 404);
assertEquals(
(await post(`/api/playlists/${id}/image`, {
(await put(`/api/playlists/${id}/cover`, {
auth: other.auth,
form: formWithFile(PNG),
}))
.status,
403,
);
const res = await post<Playlist>(`/api/playlists/${slug}/image`, {
const res = await put<Playlist>(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(PNG),
});
@@ -317,37 +341,37 @@ test("playlist images: upload and serve", async () => {
assertEquals(res.data.imageMime, "image/png");
// A new cover counts as an edit, so image URLs versioned on it change.
assert(res.data.updatedAt);
const served = await get(`/api/playlists/${slug}/image`);
const served = await get(`/api/playlists/${id}/cover`);
assertEquals(served.status, 200);
assertEquals(served.bytes, PNG);
});
test("playlist images: a private playlist's cover only for its owner's media token", async () => {
test("playlist covers: a private playlist's cover only for its owner's media token", async () => {
const owner = await createUser();
const other = await createUser();
const { id } = insertPlaylist({ userId: owner.id, isPublic: false });
await post(`/api/playlists/${id}/image`, {
await put(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(PNG),
});
assertEquals((await get(`/api/playlists/${id}/image`)).status, 404);
assertEquals((await get(`/api/playlists/${id}/cover`)).status, 404);
assertEquals(
(await get(`/api/playlists/${id}/image?token=${other.mediaToken}`)).status,
(await get(`/api/playlists/${id}/cover?token=${other.mediaToken}`)).status,
404,
);
assertEquals(
(await get(`/api/playlists/${id}/image?token=garbage`)).status,
(await get(`/api/playlists/${id}/cover?token=garbage`)).status,
404,
);
const served = await get(
`/api/playlists/${id}/image?token=${owner.mediaToken}`,
`/api/playlists/${id}/cover?token=${owner.mediaToken}`,
);
assertEquals(served.status, 200);
assertEquals(served.bytes, PNG);
assertMatch(served.headers.get("cache-control") ?? "", /^private/);
});
test("playlist images: a failed write leaves the row and the old cover alone", async () => {
test("playlist covers: a failed write leaves the row and the old cover alone", async () => {
const owner = await createUser();
const { id } = insertPlaylist({ userId: owner.id });
const dir = `${TEST_DIR}/uploads/playlist-images`;
@@ -359,27 +383,27 @@ test("playlist images: a failed write leaves the row and the old cover alone", a
// the playlist mustn't claim a cover it hasn't got.
await Deno.mkdir(`${dir}/${id}/blocker`, { recursive: true });
try {
const failed = await post(`/api/playlists/${id}/image`, {
const failed = await put(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(PNG),
});
assertEquals(failed.status, 500);
assertEquals(row(), { image_mime: null, updated_at: null });
assertEquals((await get(`/api/playlists/${id}/image`)).status, 404);
assertEquals((await get(`/api/playlists/${id}/cover`)).status, 404);
} finally {
await Deno.remove(`${dir}/${id}`, { recursive: true });
}
// With a cover in place, a failed replacement keeps serving the old one
// under the old version, and leaves no stray temporary file behind.
await post(`/api/playlists/${id}/image`, {
await put(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(PNG),
});
const before = row();
await Deno.chmod(dir, 0o555);
try {
const failed = await post(`/api/playlists/${id}/image`, {
const failed = await put(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(new Uint8Array([...PNG, 0])),
});
@@ -388,28 +412,28 @@ test("playlist images: a failed write leaves the row and the old cover alone", a
await Deno.chmod(dir, 0o755);
}
assertEquals(row(), before);
assertEquals((await get(`/api/playlists/${id}/image`)).bytes, PNG);
assertEquals((await get(`/api/playlists/${id}/cover`)).bytes, PNG);
const left = [...Deno.readDirSync(dir)]
.map((e) => e.name)
.filter((name) => name.startsWith(id));
assertEquals(left, [id]);
});
test("playlist images: a replaced cover is served under the new version", async () => {
test("playlist covers: a replaced cover is served under the new version", async () => {
const owner = await createUser();
const { id } = insertPlaylist({ userId: owner.id });
const first = await post<Playlist>(`/api/playlists/${id}/image`, {
const first = await put<Playlist>(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(PNG),
});
await new Promise((r) => setTimeout(r, 5)); // a distinct updated_at
const other = new Uint8Array([...PNG, 1, 2, 3]);
const second = await post<Playlist>(`/api/playlists/${id}/image`, {
const second = await put<Playlist>(`/api/playlists/${id}/cover`, {
auth: owner.auth,
form: formWithFile(other),
});
assert(second.data.updatedAt !== first.data.updatedAt);
assertEquals((await get(`/api/playlists/${id}/image`)).bytes, other);
assertEquals((await get(`/api/playlists/${id}/cover`)).bytes, other);
});
test("reorder: someone else's dump that went private keeps its slot", async () => {