Files
gerbeur/api/remote/image-proxy.ts
khannurien f3f07ed1e3
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 49s
Build and Deploy Static Documentation Site / build-and-push (push) Successful in 22s
v3: every doc opens with the role, then the mechanism, then the details — the docs were written bottom-up: what a thing does first ("Declares the three contexts WSProvider fills…"), details that only make sense once its purpose is known next, and the reason it exists last ("…so that a feed doesn't re-render"), so a reader had nothing to hang the first sentences on. The README's rule caused it, since a module doc "opened with what the module does"; it now opens with the module's role in the app, and the value-side phrasing of a type ("Returned to Y by X") comes once the role is said, with WSContext as the before and after. WSContext.ts is rewritten that way throughout, and so are the docs elsewhere that buried their purpose in a trailing "so that" (the migrations, og, image-proxy, public-address, useFading, useFeedCache, the drafts), opened on a generic verb that hid it ("Holds", "Declares", "Loads", "Defines", "Types": the contexts and providers, the shared types, the models, the hooks), or were label fragments ("The page of a dump…", "A row of tabs."). A function whose verb is its action ("Stores session"), a props or result type, and a protocol message ("Sent by X when Y") already say their role and are left as they are. Only comments changed, and the catalogs only move their references; deno fmt, deno lint and doc:lint are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 21:42:08 +00:00

132 lines
3.7 KiB
TypeScript

/**
* 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
* frontend routes a thumbnail through when it is on http or when loading it
* directly failed.
*
* @module
*/
import { fetchWithTimeout, readBytesCapped } from "./fetch.ts";
/**
* Returned to `GET /api/proxy-image` by {@link fetchProxiedImage}, which sends
* it back under `contentType`.
*/
export interface ProxiedImage {
bytes: Uint8Array;
/** One of the raster types, without parameters. */
contentType: string;
}
const PROXYABLE_IMAGE_TYPES = new Set([
"image/jpeg",
"image/png",
"image/gif",
"image/webp",
"image/avif",
"image/bmp",
"image/x-icon",
"image/vnd.microsoft.icon",
]);
const IMAGE_CACHE_TTL_MS = 24 * 60 * 60 * 1000;
const IMAGE_CACHE_MAX_BYTES = 32 * 1024 * 1024;
/**
* Proxied images, by URL, since every viewer of a feed asks for the same
* thumbnails. The least recently used go first, and the Map's order is that
* of use.
*/
const imageCache = new Map<
string,
{ bytes: Uint8Array; contentType: string; at: number }
>();
let imageCacheBytes = 0;
function readImageCache(
url: string,
): { bytes: Uint8Array; contentType: string } | undefined {
const hit = imageCache.get(url);
if (!hit) return undefined;
imageCache.delete(url);
if (Date.now() - hit.at > IMAGE_CACHE_TTL_MS) {
imageCacheBytes -= hit.bytes.byteLength;
return undefined;
}
imageCache.set(url, hit); // Moves it to the end: most recently used.
return hit;
}
function writeImageCache(
url: string,
bytes: Uint8Array,
contentType: string,
): void {
const old = imageCache.get(url);
if (old) {
imageCache.delete(url);
imageCacheBytes -= old.bytes.byteLength;
}
while (
imageCacheBytes + bytes.byteLength > IMAGE_CACHE_MAX_BYTES &&
imageCache.size > 0
) {
const [oldestUrl, oldest] = imageCache.entries().next().value!;
imageCache.delete(oldestUrl);
imageCacheBytes -= oldest.bytes.byteLength;
}
imageCache.set(url, { bytes, contentType, at: Date.now() });
imageCacheBytes += bytes.byteLength;
}
/** Empties the cache, for the tests' reset between cases. */
export function clearImageCache(): void {
imageCache.clear();
imageCacheBytes = 0;
}
/**
* Returns the image at `url`, from the cache or else from its host; null when
* the host answers with an error, or with anything but a raster image of 5 MB
* at most. The route
* checks `url` with `isValidHttpUrl` first.
*
* @throws {Error} When the host can't be reached, as
* {@link fetchWithTimeout} reports it.
*/
export async function fetchProxiedImage(
url: string,
): Promise<ProxiedImage | null> {
const cached = readImageCache(url);
if (cached) return cached;
const res = await fetchWithTimeout(url, 8000);
if (!res.ok) {
await res.body?.cancel();
return null;
}
// Raster formats only: the bytes go out under this site's origin, where an
// SVG, which can carry script, would run if opened directly.
const contentType = (res.headers.get("content-type") ?? "")
.split(";")[0].trim().toLowerCase();
if (!PROXYABLE_IMAGE_TYPES.has(contentType)) {
await res.body?.cancel();
return null;
}
const MAX_SIZE = 5 * 1024 * 1024;
const contentLength = Number(res.headers.get("content-length") ?? "0");
if (contentLength > MAX_SIZE) {
await res.body?.cancel();
return null;
}
// Without a Content-Length, the cap is found by reading one byte past it.
const bytes = await readBytesCapped(res, MAX_SIZE + 1);
if (bytes.length > MAX_SIZE) return null;
writeImageCache(url, bytes, contentType);
return { bytes, contentType };
}