Files
gerbeur/api/lib/static.ts
khannurien d62e4a9883
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 47s
Build and deploy docs / build-and-push (push) Successful in 26s
v3: the backend is documented for deno doc, one way in every file, and the docs build and publish themselves — comments were in three shapes: file headers as // lines, as an untagged /** */ (which deno doc drops, only an @module block counts) or missing; 43 exports described by a // deno doc can't see, two JSDoc blocks sitting on the wrong declaration and one duplicated; endpoints commented in 5 of 18 route files, three ways, on router.get() calls no doc tool reads. The rule, applied to every non-test module of api/, migrations included: each opens with a /** … @module */ block; every export has JSDoc, and so does every field of an exported interface; a comment describing a declaration is /** */, // only notes code; functions open with a verb, everything else with a noun phrase; parameters are named in the prose, {@link} only for symbols in scope; whatever throws to its caller says so with @throws (for an APIException, the statuses and when); a router's JSDoc lists its endpoints, method and path, who may call it, what it does. deno doc --lint goes from 528 errors to none in api/ (shared/ keeps its 385; it is next). The lint also wanted explicit types on config.ts's settings and a few return types, JsonLdResult exported, and the routers typed Router. deno task doc builds the HTML reference into docs/ from every module of api/ and shared/ but the tests, deno task doc:lint lints it; the index page is the module doc of a root mod.ts (deno.json's exports), which introduces the backend, shared/ and the frontend to come and links every module, and mod.test.ts fails when one is missing. The docs workflow builds it on every push to main that touches them and publishes it to the gh-pages branch, like publish-assistant's. Two defects found along the way are fixed: a private playlist's cover was served to anyone who had its id or slug, and now needs its owner's media token, as private dump files do (playlistImageUrl adds it for private playlists only, so public cover URLs stay the same for everyone); og.ts and static.ts each filled index.html's placeholders, and now share lib/index-html.ts, so the OG middleware picks up a rebuilt index.html instead of keeping the first it read. The README states the documentation rule. 205 backend and 628 frontend tests pass.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-27 21:07:40 +00:00

82 lines
2.8 KiB
TypeScript

/**
* Serving the built frontend: static files, and `index.html` with its
* placeholders filled for every client-side route.
*
* @module
*/
import { Context, Next, send } from "@oak/oak";
import { loadIndexHtml } from "./index-html.ts";
/** Answers with the filled `index.html` of `root`, always revalidated. */
async function serveIndexHtml(
context: Context<Record<string, object>>,
root: string,
) {
const html = await loadIndexHtml(root);
context.response.type = "text/html";
// Always revalidated: it names the hashed chunks of the current build.
context.response.headers.set("Cache-Control", "no-cache");
context.response.body = html;
}
/**
* Build output whose URL changes whenever its content does: Vite's hashed
* chunks, and the emoji data under its package version (see vite.config.ts).
*/
const IMMUTABLE_PREFIXES = ["/assets/", "/emojibase/"];
const ONE_YEAR_MS = 365 * 24 * 60 * 60 * 1000;
/**
* Returns a middleware serving static files from the first of `staticPaths`
* that has them, and `index.html` from the first for any other path so
* client-side routes load on direct navigation. Hashed build output is cached
* for a year, and a missing chunk is a 404.
*/
export function routeStaticFilesFrom(
staticPaths: string[],
): (context: Context<Record<string, object>>, next: Next) => Promise<void> {
return async (context: Context<Record<string, object>>, next: Next) => {
const pathname = context.request.url.pathname;
// Serve index.html with runtime placeholder replacement
if (pathname === "/" || pathname === "/index.html") {
await serveIndexHtml(context, staticPaths[0]);
return;
}
const immutable = IMMUTABLE_PREFIXES.some((prefix) =>
pathname.startsWith(prefix)
);
// A request without Accept-Encoding technically accepts any coding (RFC
// 9110), but in practice it's curl or a bot that can't decode brotli.
const compress = context.request.headers.has("accept-encoding");
for (const path of staticPaths) {
try {
// send() picks a prebuilt .br or .gz sibling when the browser accepts it.
await send(context, pathname, {
root: path,
brotli: compress,
gzip: compress,
...(immutable && { maxage: ONE_YEAR_MS, immutable: true }),
});
context.response.headers.append("Vary", "Accept-Encoding");
return;
} catch {
continue;
}
}
// A chunk from an older build (an open tab after a deploy) must fail as a
// 404, not load index.html as a script; the app reloads on that failure.
if (immutable) {
context.response.status = 404;
return;
}
// SPA fallback: serve index.html so client-side routes work on direct navigation
await serveIndexHtml(context, staticPaths[0]);
await next();
};
}