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>
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* Resolves a Bandcamp page to its streamable tracks when the native player
|
||||
* starts it, for `GET /api/bandcamp/tracks`. The stream URLs are signed and
|
||||
* starts it, for `GET /api/remote/bandcamp`. The stream URLs are signed and
|
||||
* expire 24 hours after the page is fetched, so unlike the embed URL they
|
||||
* can't be stored in the dump's preview. The browser plays them from bcbits
|
||||
* directly.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* Shows the thumbnails a browser can't load from their own site: those on plain
|
||||
* http, which an https page would block, and those behind hotlink protection.
|
||||
* It fetches and caches the images `GET /api/proxy-image` serves, which the
|
||||
* It fetches and caches the images `GET /api/remote/image` serves, which the
|
||||
* frontend routes a thumbnail through when it is on http or when loading it
|
||||
* directly failed.
|
||||
*
|
||||
@@ -11,7 +11,7 @@
|
||||
import { fetchWithTimeout, readBytesCapped } from "./fetch.ts";
|
||||
|
||||
/**
|
||||
* Returned to `GET /api/proxy-image` by {@link fetchProxiedImage}, which sends
|
||||
* Returned to `GET /api/remote/image` by {@link fetchProxiedImage}, which sends
|
||||
* it back under `contentType`.
|
||||
*/
|
||||
export interface ProxiedImage {
|
||||
|
||||
@@ -15,7 +15,7 @@ import { BANDCAMP_HOST_RE } from "../bandcamp-tralbum.ts";
|
||||
* Claims bandcamp.com and its subdomains, where artists have their pages, and
|
||||
* takes the embed player's URL from the page's `og:video`. The native player
|
||||
* fetches the page's streams itself at play time, through
|
||||
* `GET /api/bandcamp/tracks`.
|
||||
* `GET /api/remote/bandcamp`.
|
||||
*/
|
||||
export const bandcampProvider: RichContentProvider = {
|
||||
name: "bandcamp",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* Previews links to this site's own dump, user and playlist pages from the
|
||||
* database, for `rich-content-service.ts`. No request goes out, so this works
|
||||
* Previews links to this site's own dump, user and playlist pages, as
|
||||
* `parsePagePath` reads them, from the database, for `rich-content-service.ts`. No request goes out, so this works
|
||||
* even when the site runs on a private host that `fetchWithTimeout` refuses.
|
||||
*
|
||||
* @module
|
||||
@@ -8,16 +8,13 @@
|
||||
|
||||
import type { RichContent } from "../../../shared/dump.ts";
|
||||
import type { RichContentProvider } from "./provider.ts";
|
||||
import { getDump } from "../../services/dump-service.ts";
|
||||
import { getUserByUsername } from "../../services/user-service.ts";
|
||||
import { getPlaylistById } from "../../services/playlist-service.ts";
|
||||
import { getDumpByPath } from "../../services/dump-service.ts";
|
||||
import { resolveUsername } from "../../services/user-service.ts";
|
||||
import { getPlaylistByPath } from "../../services/playlist-service.ts";
|
||||
import { APIException } from "../../lib/api-exception.ts";
|
||||
import { PUBLIC_URL, THEME_COLOR } from "../../config.ts";
|
||||
import { isSelfUrl } from "../../lib/self-url.ts";
|
||||
|
||||
const DUMP_RE = /^\/dumps\/([^/]+)$/;
|
||||
const USER_RE = /^\/users\/([^/]+)$/;
|
||||
const PLAYLIST_RE = /^\/playlists\/([^/]+)$/;
|
||||
import { parsePagePath } from "../../../shared/paths.ts";
|
||||
|
||||
/**
|
||||
* Gives a link to this site without a thumbnail a placeholder in the site's
|
||||
@@ -30,10 +27,10 @@ const SELF_BRANDING = {
|
||||
} as const;
|
||||
|
||||
/**
|
||||
* Comes before the generic provider, and claims what `isSelfUrl` accepts. Its
|
||||
* `fetch` rejects with a 404 `APIException` for a missing page, a private dump
|
||||
* or a private playlist: the preview is stored in the linking dump, which
|
||||
* others may see.
|
||||
* Comes before the generic provider, and claims what `isSelfUrl` accepts. A
|
||||
* profile's tab previews as the profile. Its `fetch` rejects with a 404
|
||||
* `APIException` for a missing page, a private dump or a private playlist:
|
||||
* the preview is stored in the linking dump, which others may see.
|
||||
*/
|
||||
export const selfProvider: RichContentProvider = {
|
||||
name: "self",
|
||||
@@ -47,14 +44,15 @@ export const selfProvider: RichContentProvider = {
|
||||
},
|
||||
|
||||
fetch(url: string): Promise<RichContent> {
|
||||
const { pathname } = new URL(url);
|
||||
// matches() let only these paths through.
|
||||
const page = parsePagePath(new URL(url).pathname)!;
|
||||
const user = resolveUsername(page.username);
|
||||
|
||||
const dumpMatch = pathname.match(DUMP_RE);
|
||||
if (dumpMatch) {
|
||||
const dump = getDump(dumpMatch[1]);
|
||||
if (page.kind === "dump") {
|
||||
const dump = getDumpByPath(user.id, page.slug);
|
||||
let thumbnailUrl: string | undefined;
|
||||
if (dump.kind === "file" && dump.fileMime?.startsWith("image/")) {
|
||||
thumbnailUrl = `${PUBLIC_URL}/api/files/${dump.id}`;
|
||||
thumbnailUrl = `${PUBLIC_URL}/api/dumps/${dump.id}/file`;
|
||||
} else if (dump.richContent?.thumbnailUrl) {
|
||||
thumbnailUrl = dump.richContent.thumbnailUrl;
|
||||
}
|
||||
@@ -68,30 +66,13 @@ export const selfProvider: RichContentProvider = {
|
||||
});
|
||||
}
|
||||
|
||||
const userMatch = pathname.match(USER_RE);
|
||||
if (userMatch) {
|
||||
const user = getUserByUsername(userMatch[1]);
|
||||
const thumbnailUrl = user.avatarMime
|
||||
? `${PUBLIC_URL}/api/avatars/${user.id}`
|
||||
: undefined;
|
||||
return Promise.resolve({
|
||||
type: "generic",
|
||||
url,
|
||||
...SELF_BRANDING,
|
||||
title: user.username,
|
||||
description: user.description,
|
||||
thumbnailUrl,
|
||||
});
|
||||
}
|
||||
|
||||
const playlistMatch = pathname.match(PLAYLIST_RE);
|
||||
if (playlistMatch) {
|
||||
const playlist = getPlaylistById(playlistMatch[1]);
|
||||
if (page.kind === "playlist") {
|
||||
const playlist = getPlaylistByPath(user.id, page.slug);
|
||||
if (!playlist.isPublic) {
|
||||
throw new APIException(404, "Playlist not found");
|
||||
}
|
||||
const thumbnailUrl = playlist.imageMime
|
||||
? `${PUBLIC_URL}/api/playlists/${playlist.id}/image`
|
||||
? `${PUBLIC_URL}/api/playlists/${playlist.id}/cover`
|
||||
: undefined;
|
||||
return Promise.resolve({
|
||||
type: "generic",
|
||||
@@ -103,7 +84,16 @@ export const selfProvider: RichContentProvider = {
|
||||
});
|
||||
}
|
||||
|
||||
// Unreachable: isSelfUrl accepts only the three paths above.
|
||||
return Promise.resolve({ type: "generic", url });
|
||||
const thumbnailUrl = user.avatarMime
|
||||
? `${PUBLIC_URL}/api/users/${user.id}/avatar`
|
||||
: undefined;
|
||||
return Promise.resolve({
|
||||
type: "generic",
|
||||
url,
|
||||
...SELF_BRANDING,
|
||||
title: user.username,
|
||||
description: user.description,
|
||||
thumbnailUrl,
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* Gives the global player a tracklist for a YouTube playlist, which the embed
|
||||
* plays but doesn't list. It resolves the playlist to its entries' titles and
|
||||
* lengths, for `GET /api/youtube/playlist`.
|
||||
* lengths, for `GET /api/remote/youtube`.
|
||||
*
|
||||
* They are read from the `ytInitialData` JSON of the public playlist page,
|
||||
* whose undocumented shape changes, so both the current `lockupViewModel` rows
|
||||
|
||||
Reference in New Issue
Block a user