Files
gerbeur/api/services/slug-service.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

92 lines
3.2 KiB
TypeScript

/**
* Changes and resolves the slugs of dumps and playlists. A slug changes only
* when someone edits it (the dump and playlist services call
* {@link changeSlug} with the slug their edit form sent), and the slug it
* leaves becomes an alias of the item, so that old links still reach it; the
* routes that read an item by its page path resolve the slug with
* {@link resolveSlug}, aliases included, and answer the item, whose current
* slug the client then puts in its URL.
*
* @module
*/
import { APIException } from "../lib/api-exception.ts";
import { db, transaction } from "../db/connection.ts";
import {
SLUG_TABLES,
slugHolder,
type SlugKind,
uniqueSlug,
validateSlug,
} from "../lib/slugify.ts";
import { slugify } from "../../shared/slug.ts";
import { RENAME_LIMITS } from "../../shared/validation.ts";
/**
* Returns a free slug for a new item of `userId`'s titled `title`, for the
* dump and playlist services to insert it with, inside their transaction.
*/
export function newSlug(kind: SlugKind, userId: string, title: string): string {
return uniqueSlug(db, kind, userId, slugify(title));
}
/**
* Returns the id of `userId`'s item of `kind` whose slug is or was `slug`, or
* undefined when none is.
*/
export function resolveSlug(
kind: SlugKind,
userId: string,
slug: string,
): string | undefined {
return slugHolder(db, kind, userId, slug);
}
/**
* Gives `item` the slug `slug`, keeping its current one as an alias. An alias
* always names the item itself, so redirects never chain; taking back one of
* the item's own aliases swaps it with the current slug. Unless `exempt` (a
* moderator), an item's slug changes at most `RENAME_LIMITS.SLUG.count` times
* in its window, counted from its aliases. A slug equal to the current one
* changes nothing.
*
* @throws {APIException} 400 when `slug` isn't valid, 409 when another item
* of the owner's holds it now or held it before, 429 when the item's slug
* changed too often lately.
*/
export function changeSlug(
kind: SlugKind,
item: { id: string; userId: string; slug: string },
slug: string,
exempt: boolean,
): void {
if (slug === item.slug) return;
validateSlug(slug);
const { items, aliases, itemId } = SLUG_TABLES[kind];
const now = new Date();
transaction(() => {
const holder = slugHolder(db, kind, item.userId, slug);
if (holder && holder !== item.id) {
throw new APIException(409, `The slug "${slug}" is already taken`);
}
const { count, windowMs } = RENAME_LIMITS.SLUG;
const recent = (db.prepare(
`SELECT COUNT(*) AS n FROM ${aliases} WHERE ${itemId} = ? AND created_at > ?;`,
).get(item.id, new Date(now.getTime() - windowMs).toISOString()) as {
n: number;
}).n;
if (!exempt && recent >= count) {
throw new APIException(
429,
`A slug can only be changed ${count} times a day`,
);
}
db.prepare(`DELETE FROM ${aliases} WHERE user_id = ? AND slug = ?;`)
.run(item.userId, slug);
db.prepare(
`INSERT INTO ${aliases} (user_id, slug, ${itemId}, created_at) VALUES (?, ?, ?, ?);`,
).run(item.userId, item.slug, item.id, now.toISOString());
db.prepare(`UPDATE ${items} SET slug = ? WHERE id = ?;`).run(slug, item.id);
});
}