Files
gerbeur/api/test/db/migrations/0021_page_urls.test.ts
khannurien 4468438ba7 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.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 16:08:59 +00:00

169 lines
5.8 KiB
TypeScript

import "../../setup.ts";
import { assertEquals } from "@std/assert";
import { DatabaseSync } from "node:sqlite";
import { up as up0021 } from "../../../db/migrations/0021_page_urls.ts";
/** A database as v3 left it: schema.sql without 0021's tables and indexes. */
function v3Db(): DatabaseSync {
const db = new DatabaseSync(":memory:");
db.exec(
Deno.readTextFileSync(new URL("../../../db/schema.sql", import.meta.url)),
);
db.exec(`
DROP TABLE dump_slug_aliases;
DROP TABLE playlist_slug_aliases;
DROP TABLE user_aliases;
DROP INDEX idx_dumps_user_slug;
DROP INDEX idx_playlists_user_slug;
CREATE INDEX idx_dumps_slug ON dumps(slug);
CREATE INDEX idx_playlists_slug ON playlists(slug);
`);
return db;
}
const NOW = "2024-01-01T00:00:00.000Z";
const later = (n: number) => new Date(Date.parse(NOW) + n * 1000).toISOString();
function user(db: DatabaseSync, username: string): string {
const id = crypto.randomUUID();
db.prepare(
`INSERT INTO users (id, username, password_hash, created_at, email) VALUES (?, ?, 'x', ?, ?);`,
).run(id, username, NOW, `${username}@example.test`);
return id;
}
/** Inserts a dump or playlist with its v3 slug, and returns its id and slug. */
function item(
db: DatabaseSync,
table: "dumps" | "playlists",
userId: string,
title: string,
at: number,
): { id: string; v3: string } {
const id = crypto.randomUUID();
const v3 = `${title.toLowerCase().replace(/[^a-z0-9]+/g, "-")}-${
id.slice(0, 8)
}`;
db.prepare(
table === "dumps"
? `INSERT INTO dumps (id, kind, title, slug, user_id, created_at, url) VALUES (?, 'url', ?, ?, ?, ?, 'https://x.test');`
: `INSERT INTO playlists (id, title, slug, user_id, created_at) VALUES (?, ?, ?, ?, ?);`,
).run(id, title, v3, userId, later(at));
return { id, v3 };
}
const slugOf = (db: DatabaseSync, table: string, id: string) =>
(db.prepare(`SELECT slug FROM ${table} WHERE id = ?;`).get(id) as {
slug: string;
}).slug;
Deno.test("migration 0021: bare slugs unique per owner, reserved categories renamed", () => {
const db = v3Db();
const bob = user(db, "Bob");
const ann = user(db, "ann");
const first = item(db, "dumps", bob, "Never Gonna", 0);
const second = item(db, "dumps", bob, "Never gonna!", 1);
const anns = item(db, "dumps", ann, "Never Gonna", 2);
const mix = item(db, "playlists", bob, "Never Gonna", 3);
for (
const [slug, name] of [
["hot", "Hot"],
["hot-2", "Hot 2"],
["follow", "F"],
["music", "M"],
]
) {
db.prepare(
`INSERT INTO categories (id, slug, name, created_at) VALUES (?, ?, ?, ?);`,
).run(crypto.randomUUID(), slug, name, NOW);
}
up0021(db);
// The oldest keeps the bare slug; each kind and owner is its own space.
assertEquals(slugOf(db, "dumps", first.id), "never-gonna");
assertEquals(slugOf(db, "dumps", second.id), "never-gonna-2");
assertEquals(slugOf(db, "dumps", anns.id), "never-gonna");
assertEquals(slugOf(db, "playlists", mix.id), "never-gonna");
assertEquals(
(db.prepare(`SELECT slug FROM categories ORDER BY slug;`).all() as {
slug: string;
}[]).map((r) => r.slug),
["follow-2", "hot-2", "hot-3", "music"],
);
// The new index holds.
let clash = false;
try {
db.prepare(`UPDATE dumps SET slug = 'never-gonna' WHERE id = ?;`).run(
second.id,
);
} catch {
clash = true;
}
assertEquals(clash, true);
db.close();
});
Deno.test("migration 0021: v3 links in notes, comments and chat become v4 paths", () => {
const db = v3Db();
const bob = user(db, "Bob");
const dump = item(db, "dumps", bob, "Never Gonna", 0);
const mix = item(db, "playlists", bob, "Sunday Mix", 1);
const text = [
`[by slug](http://gerbeur.test/dumps/${dump.v3}#comment-1)`,
`[relative by id](/dumps/${dump.id}/edit)`,
`http://gerbeur.test/playlists/${mix.id}?x=1`,
`<http://gerbeur.test/users/bob/~/followed>`,
`[list](/users/BOB/upvoted) [settings](/users/bob/~/settings)`,
`[feed](/~/followed) [search](/search/~/users?q=a)`,
// Another site's, a bare path in prose and a deleted dump stay as they are.
`https://elsewhere.test/dumps/${dump.v3} see /dumps/${dump.v3}`,
`http://gerbeur.test/dumps/gone-12345678`,
].join("\n");
const expected = [
`[by slug](http://gerbeur.test/@Bob/dumps/never-gonna#comment-1)`,
`[relative by id](/@Bob/dumps/never-gonna/edit)`,
`http://gerbeur.test/@Bob/playlists/sunday-mix?x=1`,
`<http://gerbeur.test/@Bob/follow>`,
`[list](/@Bob/upvoted) [settings](/settings)`,
`[feed](/follow) [search](/search/users?q=a)`,
`https://elsewhere.test/dumps/${dump.v3} see /dumps/${dump.v3}`,
`http://gerbeur.test/dumps/gone-12345678`,
].join("\n");
const commentId = crypto.randomUUID();
const messageId = crypto.randomUUID();
db.prepare(`UPDATE dumps SET comment = ? WHERE id = ?;`).run(text, dump.id);
db.prepare(`UPDATE playlists SET description = ? WHERE id = ?;`).run(
text,
mix.id,
);
db.prepare(
`INSERT INTO comments (id, dump_id, user_id, body, created_at) VALUES (?, ?, ?, ?, ?);`,
).run(commentId, dump.id, bob, text, NOW);
db.prepare(
`INSERT INTO chat_messages (id, user_id, body, created_at) VALUES (?, ?, ?, ?);`,
).run(messageId, bob, text, NOW);
up0021(db);
const read = (sql: string, id: string) =>
(db.prepare(sql).get(id) as { text: string }).text;
assertEquals(
read(`SELECT comment AS text FROM dumps WHERE id = ?;`, dump.id),
expected,
);
assertEquals(
read(`SELECT body AS text FROM comments WHERE id = ?;`, commentId),
expected,
);
assertEquals(
read(`SELECT body AS text FROM chat_messages WHERE id = ?;`, messageId),
expected,
);
assertEquals(
read(`SELECT description AS text FROM playlists WHERE id = ?;`, mix.id),
expected,
);
db.close();
});