feat: client log with request ids, joined to the server's
The browser now keeps its half of the one event shape logs.py defines: lib/log.ts is a levelled, redacted, bounded (2000 events) in-memory ring with the server's level names and severity numbers. Nothing leaves the browser yet; sending is the consented diagnostics level (S5). - lib/http.ts `send` is the one fetch: every request carries an X-Request-Id and becomes one http.request event. The server echoes the matched route template in X-Route (only for a matched route, so a raw path with a value in it is never sent back); without one the client templates the path itself. req, beacon, the upload XHR, the public watch page and the legal pages all go through it. - Hooks: app start snapshot, uncaught errors and rejections, History push/replace/popstate (a scroll-only replace is not an event; parameter values only at DEBUG, typed search only at TRACE), notifications, the error dialog, the crash boundary, failed queries and mutations (key head only), and the messages socket (lifecycle, frame types at DEBUG). - Redaction is one contract: backend/tests/fixtures/log_redaction_cases.json runs against both redact() implementations. - Lint: fetch, XMLHttpRequest and WebSocket each belong to one logging module, console to none; a contract test proves the rules fire. Fixes a socket takeover: the close of a socket released by the last subscriber cleared the newer socket a quick re-subscribe had opened and scheduled a third, leaving two live sockets that delivered every message twice (measured in Chromium: 3 created / 2 live before, 2 / 1 after).
This commit is contained in:
@@ -0,0 +1,99 @@
|
||||
// The ONE place the app calls `fetch` (lint-enforced: eslint.config.js). Every request gets an
|
||||
// `X-Request-Id`, and every answer — or network failure — becomes one `http.request` event in the
|
||||
// client log, the browser's copy of the server's access line with the same id.
|
||||
//
|
||||
// Deliberately nothing else: no error dialog, no connection notice, no account header. `req` and
|
||||
// `beacon` (lib/api/core.ts) add the app's policy on top; the public pages (/watch, the legal pages)
|
||||
// use this directly, because they render outside the app and must not pull its notification and
|
||||
// dialog machinery into their chunks.
|
||||
import { log, newRequestId, type Level } from "./log";
|
||||
|
||||
/** The route TEMPLATE the server matched (`/api/videos/{video_id}`), which it sends back in `X-Route`.
|
||||
* Grouping by it is what makes a client line comparable, and it is safe by construction: a token in
|
||||
* the path (`/api/public/watch/{token}`) arrives already replaced by its parameter name. */
|
||||
export const ROUTE_HEADER = "X-Route";
|
||||
export const REQUEST_ID_HEADER = "X-Request-Id";
|
||||
|
||||
// A static path word: kept. Anything else (an id, a channel id, a share token) becomes `{}`.
|
||||
const STATIC_SEGMENT = /^[a-z]+(?:[-_.][a-z]+)*$/;
|
||||
|
||||
/** The path to log when the server named no template (a network failure, a gateway's own answer):
|
||||
* the path alone, with every segment that is not a plain lowercase word replaced — never a query,
|
||||
* never an id or a token. */
|
||||
export function pathTemplate(url: string): string {
|
||||
const path = url.split(/[?#]/, 1)[0] ?? "";
|
||||
return path
|
||||
.split("/")
|
||||
.map((seg) => (seg === "" || STATIC_SEGMENT.test(seg) ? seg : "{}"))
|
||||
.join("/");
|
||||
}
|
||||
|
||||
/** Level of a request line — the server's own rule (`logs.log_requests`), so both sides agree on
|
||||
* what a 404 is. */
|
||||
function statusLevel(status: number): Level {
|
||||
return status >= 500 ? "ERROR" : status >= 400 ? "WARNING" : "INFO";
|
||||
}
|
||||
|
||||
/** Record one request's outcome. `route` is the server's template when it sent one. */
|
||||
export function logRequest(
|
||||
requestId: string,
|
||||
method: string,
|
||||
url: string,
|
||||
started: number,
|
||||
outcome: { status: number; route?: string | null } | { failed: "network" | "aborted" },
|
||||
extra: Record<string, unknown> = {},
|
||||
): void {
|
||||
const duration_ms = Math.round((performance.now() - started) * 10) / 10;
|
||||
if ("failed" in outcome) {
|
||||
const path = pathTemplate(url);
|
||||
log.request(
|
||||
outcome.failed === "aborted" ? "INFO" : "WARNING",
|
||||
`${method} ${path} ${outcome.failed}`,
|
||||
{ method, path, failed: outcome.failed, duration_ms, ...extra },
|
||||
requestId,
|
||||
);
|
||||
return;
|
||||
}
|
||||
const path = outcome.route || pathTemplate(url);
|
||||
log.request(
|
||||
statusLevel(outcome.status),
|
||||
`${method} ${path} ${outcome.status}`,
|
||||
{ method, path, status: outcome.status, duration_ms, ...extra },
|
||||
requestId,
|
||||
);
|
||||
}
|
||||
|
||||
function headerOf(r: Response, name: string): string | null {
|
||||
// Test doubles hand back plain objects; a real Response always has Headers.
|
||||
return typeof r.headers?.get === "function" ? r.headers.get(name) : null;
|
||||
}
|
||||
|
||||
/** `fetch`, with a request id and one log event. Rejects exactly as `fetch` does. */
|
||||
export async function send(
|
||||
url: string,
|
||||
init: RequestInit = {},
|
||||
extra: Record<string, unknown> = {},
|
||||
): Promise<Response> {
|
||||
const requestId = newRequestId();
|
||||
const method = (init.method ?? "GET").toUpperCase();
|
||||
const headers = new Headers(init.headers);
|
||||
headers.set(REQUEST_ID_HEADER, requestId);
|
||||
const started = performance.now();
|
||||
let r: Response;
|
||||
try {
|
||||
r = await fetch(url, { ...init, headers });
|
||||
} catch (e) {
|
||||
const aborted = e instanceof DOMException && e.name === "AbortError";
|
||||
logRequest(requestId, method, url, started, { failed: aborted ? "aborted" : "network" }, extra);
|
||||
throw e;
|
||||
}
|
||||
logRequest(
|
||||
requestId,
|
||||
method,
|
||||
url,
|
||||
started,
|
||||
{ status: r.status, route: headerOf(r, ROUTE_HEADER) },
|
||||
extra,
|
||||
);
|
||||
return r;
|
||||
}
|
||||
Reference in New Issue
Block a user