cartethyia 2.5.4 → 2.5.7

package/src/observability/payload-store.ts

@@ -1,440 +1,397 @@
-import { mkdir, open, readdir, readFile, stat, unlink } from "node:fs/promises";
-import { basename, join } from "node:path";
-import { randomUUID } from "node:crypto";
-import { gunzipSync, gzipSync } from "node:zlib";
-
-export interface PayloadFileReference {
-  /**
-   * `jsonb-file` is a frame written before compression existed: plain JSON.
-   * New frames are `jsonl-file`: the same JSON, gzipped. The row names its
-   * encoding, so a reader never guesses and an old row still resolves.
-   */
-  readonly storage: "jsonb-file" | "jsonl-file";
-  readonly file: string;
-  readonly offset: number;
-  readonly length: number;
-  readonly checksum: string;
-  readonly version: 1;
-}
-
-interface PayloadFrame {
-  readonly version: 1;
-  readonly id: string;
-  readonly expiresAt: string;
-  readonly payload: unknown;
-}
-
-export function isPayloadFileReference(value: unknown): value is PayloadFileReference {
-  if (typeof value !== "object" || value === null) return false;
-  const record = value as Record<string, unknown>;
-  return (
-    (record["storage"] === "jsonb-file" || record["storage"] === "jsonl-file") &&
-    typeof record["file"] === "string" &&
-    typeof record["offset"] === "number" &&
-    typeof record["length"] === "number" &&
-    typeof record["checksum"] === "string" &&
-    record["version"] === 1
-  );
-}
-
-/**
- * Builds a frame reference from a `telemetry_payloads` row's typed columns.
- * Returns undefined when any column is out of contract so callers treat a
- * corrupt index row as "no payload" rather than path-traversing or reading
- * the wrong bytes.
- */
-export function payloadReferenceFromRow(row: {
-  readonly storage: string;
-  readonly file: string;
-  readonly offset: number;
-  readonly length: number;
-  readonly checksum: string;
-  readonly version: number;
-}): PayloadFileReference | undefined {
-  const candidate = {
-    storage: row.storage,
-    file: row.file,
-    offset: row.offset,
-    length: row.length,
-    checksum: row.checksum,
-    version: row.version,
-  };
-  return isPayloadFileReference(candidate) ? candidate : undefined;
-}
-
-/** Extension for newly written frame files. Old `.jsonb` files are still read. */
-const FRAME_FILE_SUFFIX = ".jsonl";
-
-/**
- * True for a frame file, whichever extension it carries.
- *
- * Files written before the format change end `.jsonb`. They still hold live
- * frames whose rows point at them, so a prune that recognised only the new
- * extension would abandon them — and since nothing else removes them, they
- * would sit on disk indefinitely.
- */
-function isFrameFileName(name: string): boolean {
-  return name.endsWith(FRAME_FILE_SUFFIX) || name.endsWith(".jsonb");
-}
-
-const FRAME_HEADER_BYTES = 4;
-const MAX_FRAME_BYTES = 256 * 1024 * 1024;
-const DEFAULT_MAX_FILE_BYTES = 64 * 1024 * 1024;
-const DEFAULT_DIRECTORY = "./data/telemetry-payloads";
-let writeTail: Promise<void> = Promise.resolve();
-
-/**
- * Single source of truth for the telemetry payload directory: the
- * `CARTETHYIA_TELEMETRY_PAYLOAD_DIR` override when set, otherwise the
- * default `./data/telemetry-payloads`. Every writer and reader must resolve
- * the directory through this function so the two can never drift.
- */
-export function payloadDirectory(): string {
-  return process.env.CARTETHYIA_TELEMETRY_PAYLOAD_DIR?.trim() || DEFAULT_DIRECTORY;
-}
-
-function maxFileBytes(): number {
-  const raw = Number(process.env.CARTETHYIA_TELEMETRY_PAYLOAD_FILE_MAX_BYTES ?? DEFAULT_MAX_FILE_BYTES);
-  return Number.isFinite(raw) && raw > 0 ? Math.floor(raw) : DEFAULT_MAX_FILE_BYTES;
-}
-
-function checksum(value: Buffer | readonly Buffer[]): string {
-  const parts = Array.isArray(value) ? value : [value];
-  let hash = 2166136261;
-  for (const part of parts) {
-    for (let index = 0; index < part.byteLength; index += 1) {
-      hash ^= part[index]!;
-      hash = Math.imul(hash, 16777619);
-    }
-  }
-  return (hash >>> 0).toString(16).padStart(8, "0");
-}
-
-function fileName(now = new Date()): string {
-  return `${now.toISOString().slice(0, 13).replaceAll(":", "-")}-${process.pid}${FRAME_FILE_SUFFIX}`;
-}
-
-/**
- * Gzipped frame body.
- *
- * The pieces stay separate until here, because nothing before the write reads
- * them assembled and joining them earlier is a copy of the whole frame. The
- * join happens once, at the moment of compression, and the compressed buffer
- * is what gets written, checksummed, and bounded — so the cap and the
- * reference both describe bytes on disk, not bytes of JSON.
- */
-function compressFrame(parts: readonly Buffer[]): Buffer {
-  return gzipSync(Buffer.concat(parts));
-}
-
-async function appendFrame(frame: PayloadFrame, parts?: readonly Buffer[]): Promise<PayloadFileReference> {
-  const directory = payloadDirectory();
-  await mkdir(directory, { recursive: true });
-  // Encoded as a line here rather than at the write, so the cap, the checksum,
-  // and the reference all describe the same bytes that land on disk — the
-  // prebuilt-parts path and the plain one cannot disagree about the shape.
-  const json = parts === undefined
-    ? Buffer.from(JSON.stringify(frame), "utf8")
-    : Buffer.concat(parts);
-  const compressed = compressFrame([json]);
-  if (compressed.byteLength > MAX_FRAME_BYTES) throw new Error("telemetry payload frame exceeds limit");
-  const encoded = toLine(compressed);
-  const file = fileName();
-  const path = join(directory, file);
-  const currentSize = await stat(path).then((value) => value.size).catch(() => 0);
-  const offset = currentSize;
-  if (offset + encoded.byteLength > maxFileBytes()) {
-    const rotated = `${Date.now()}-${randomUUID()}${FRAME_FILE_SUFFIX}`;
-    return appendFrameToPath(join(directory, rotated), encoded, basename(rotated));
-  }
-  return appendFrameToPath(path, encoded, file, offset);
-}
-
-/**
- * One frame as a stored line: base64 of the gzipped JSON, newline-terminated.
- *
- * The 4-byte binary length header is gone. A header made every frame opaque —
- * you could not `cat` the file or read a frame without first decoding a
- * big-endian length and then gunzipping exactly that many bytes. A newline is
- * the delimiter instead, so the file is a text file of base64 lines and a
- * frame's extent is found by reading to the next `\n`.
- *
- * base64 rather than raw gzip bytes because gzip contains newlines, which
- * would make the delimiter ambiguous. The row still names `jsonl-file`, so no
- * schema change and no migration: readers tell old from new off the bytes.
- */
-function toLine(compressed: Buffer): Buffer {
-  return Buffer.from(`${compressed.toString("base64")}\n`, "utf8");
-}
-
-async function appendFrameToPath(
-  path: string,
-  encoded: Buffer,
-  knownFile = basename(path),
-  knownOffset?: number,
-): Promise<PayloadFileReference> {
-  const offset = knownOffset ?? await stat(path).then((value) => value.size).catch(() => 0);
-  const handle = await open(path, "a");
-  try {
-    await handle.write(encoded);
-  } finally {
-    await handle.close();
-  }
-  return {
-    storage: "jsonl-file",
-    file: knownFile,
-    offset,
-    length: encoded.byteLength,
-    checksum: checksum(encoded),
-    version: 1,
-  };
-}
-
-/**
- * The frame's body keys, in the same order `buildPayloadRecord` serializes
- * them.
- *
- * The record hands the writer one string per body already serialized, so the
- * two orders must agree or every body lands under the wrong key. The order is
- * drawer order with the legacy `response_body` alias last, for the same reason
- * the record accounts it last: it names no panel of its own and must not
- * spend the shared byte budget ahead of the provider stages.
- */
-const FRAME_BODY_KEYS = [
-  "request_body",
-  "provider_request_body",
-  "provider_response_body",
-  "client_response_body",
-  "response_body",
-] as const;
-
-/**
- * The pieces of a frame whose bodies were already serialized while measured.
- *
- * Returned as separate buffers rather than one assembled buffer: the file
- * write accepts a list, and assembling them first is a copy of the whole frame
- * that nothing reads back.
- */
-function prebuiltFrameParts(
-  id: string,
-  expiresAt: string,
-  capturedAt: string,
-  requestId: string | null,
-  signals: unknown,
-  bodies: readonly string[],
-): Buffer[] {
-  const parts = [
-    Buffer.from(
-      `{"version":1,"id":${JSON.stringify(id)},"expiresAt":${JSON.stringify(expiresAt)},` +
-        `"payload":{"request_id":${JSON.stringify(requestId)},"captured_at":${JSON.stringify(capturedAt)},` +
-        `"expires_at":${JSON.stringify(expiresAt)}`,
-      "utf8",
-    ),
-  ];
-  for (let index = 0; index < FRAME_BODY_KEYS.length; index += 1) {
-    parts.push(Buffer.from(`,"${FRAME_BODY_KEYS[index]}":${bodies[index] ?? "null"}`, "utf8"));
-  }
-  parts.push(Buffer.from(`,"signals":${JSON.stringify(signals)}}}`, "utf8"));
-  return parts;
-}
-
-export function writePayloadFrame(
-  payload: unknown,
-  expiresAt: Date,
-  prebuilt?: { readonly requestId: string | null; readonly capturedAt: string; readonly signals: unknown; readonly bodies: readonly string[] },
-): Promise<PayloadFileReference> {
-  const id = randomUUID();
-  const expires = expiresAt.toISOString();
-  const parts = prebuilt
-    ? prebuiltFrameParts(id, expires, prebuilt.capturedAt, prebuilt.requestId, prebuilt.signals, prebuilt.bodies)
-    : undefined;
-  const frame: PayloadFrame = { version: 1, id, expiresAt: expires, payload };
-  const task = writeTail.then(() => appendFrame(frame, parts));
-  writeTail = task.then(() => undefined, () => undefined);
-  return task;
-}
-
-export async function readPayloadFrame(reference: PayloadFileReference): Promise<unknown | undefined> {
-  // Basename-constrain the reference: a hostile/restored row carrying
-  // `../../x` must not escape the payload directory (path traversal).
-  const safeFile = basename(reference.file);
-  if (safeFile !== reference.file || safeFile.length === 0) return undefined;
-  const path = join(payloadDirectory(), safeFile);
-  // Read exactly the frame. Reading the whole file copied every earlier frame
-  // in the same hour into memory just to return one of them.
-  const handle = await open(path, "r");
-  let data: Buffer;
-  try {
-    const stat = await handle.stat();
-    if (reference.offset < 0 || reference.offset + reference.length > stat.size) return undefined;
-    data = Buffer.alloc(reference.length);
-    await handle.read(data, 0, reference.length, reference.offset);
-  } finally {
-    await handle.close();
-  }
-  const frame = data;
-  const json = frameJsonFromSlice(frame, reference.storage);
-  if (json === undefined) return undefined;
-  const parsed = JSON.parse(json.toString("utf8")) as PayloadFrame;
-  return parsed.version === 1 ? parsed.payload : undefined;
-}
-
-/** Decompressed frame body, or undefined when the bytes are not gzip. */
-function gunzipFrame(stored: Buffer): Buffer | undefined {
-  try {
-    return gunzipSync(stored);
-  } catch {
-    return undefined;
-  }
-}
-
-/**
- * The JSON of one frame read out of a file, in either on-disk shape.
- *
- * Old frames carry a 4-byte big-endian length header, so their first byte is
- * `0x00` for any frame under 16 MB. New frames are a base64 line, which never
- * begins with a null byte. That one byte separates the two without a version
- * field, a schema change, or a migration — the same trick `frameJson` already
- * uses to tell gzip from plain JSON by its magic.
- *
- * Old frames are still read because they exist on disk right now and their
- * rows point at them; they expire on their own within the retention window, so
- * tolerating both is temporary by construction.
- */
-function frameJsonFromSlice(
-  slice: Buffer,
-  storage: PayloadFileReference["storage"],
-): Buffer | undefined {
-  const hasBinaryHeader = slice.byteLength >= FRAME_HEADER_BYTES && slice[0] === 0x00;
-  if (hasBinaryHeader) {
-    const length = slice.readUInt32BE(0);
-    if (length <= 0 || length + FRAME_HEADER_BYTES !== slice.byteLength) return undefined;
-    const stored = slice.subarray(FRAME_HEADER_BYTES);
-    return storage === "jsonl-file" ? gunzipFrame(stored) : stored;
-  }
-  // New shape: a base64 line. The trailing newline is not part of the payload.
-  const text = slice.toString("utf8").trim();
-  if (text.length === 0) return undefined;
-  const gzipped = Buffer.from(text, "base64");
-  return gunzipFrame(gzipped);
-}
-
-/**
- * What a whole file's parseable frames say about reclaiming it.
- *
- * `live` — at least one frame is still inside its retention window.
- * `none` — every frame was read and every one has expired.
- * `unknown` — parsing stopped on a torn tail or a corrupt frame, so the rest
- *   of the file is unreadable and cannot be assumed empty of live frames.
- */
-type FrameLiveness = "live" | "none" | "unknown";
-
-function frameLiveness(data: Buffer, before: Date): FrameLiveness {
-  let offset = 0;
-  // One byte, not FRAME_HEADER_BYTES: a line frame is bounded by its newline
-  // and needs no minimum length of its own. Keying the loop to the old header
-  // size would stop a new-shape file a few bytes early and report it
-  // unreadable, which leaves it on disk forever.
-  while (offset < data.byteLength) {
-    // New frames end at the next newline; old ones carry a length header. The
-    // first byte tells them apart, so a file holding a mix still walks.
-    const newline = data.indexOf(0x0a, offset);
-    const hasBinaryHeader = data[offset] === 0x00;
-
-    let end: number;
-    let slice: Buffer;
-    if (hasBinaryHeader) {
-      const length = data.readUInt32BE(offset);
-      end = offset + FRAME_HEADER_BYTES + length;
-      // A length that runs past the file is a half-written tail, not a frame.
-      if (length <= 0 || end > data.byteLength) return "unknown";
-      slice = data.subarray(offset, end);
-    } else {
-      if (newline <= 0) return "unknown";
-      end = newline + 1;
-      slice = data.subarray(offset, end);
-    }
-
-    const json = frameJsonFromSlice(slice, "jsonl-file");
-    if (json === undefined) return "unknown";
-    let frame: PayloadFrame;
-    try {
-      frame = JSON.parse(json.toString("utf8")) as PayloadFrame;
-    } catch {
-      return "unknown";
-    }
-    if (new Date(frame.expiresAt).getTime() >= before.getTime()) return "live";
-    offset = end;
-  }
-  // Bytes left over that are too short to hold a header are an unreadable tail.
-  return offset === data.byteLength ? "none" : "unknown";
-}
-
-/**
- * Reclaims frame files that no longer hold a live payload.
- *
- * Frames are append-only and this pass never rewrites a file. That is a
- * correctness requirement, not an optimization: a `telemetry_payloads` row
- * addresses its body by file + offset + length, so compacting a file in place
- * would shift every later frame and leave live rows pointing at the wrong
- * bytes — the drawer then reads `undefined` and the payload silently vanishes
- * while its row is still current. A file is dropped whole, and only once
- * nothing in it is still live.
- *
- * `unparseableWrittenBefore` bounds the damaged-file case. A region that
- * cannot be parsed cannot prove it holds no live frame, so such a file is kept
- * until its last write is older than that instant — every frame it could hold
- * was written before then and has therefore expired. A caller that cannot
- * supply that bound leaves the default, which keeps damaged files rather than
- * risk dropping a frame a row still addresses.
- *
- * One damaged file must not abort the pass. A single corrupt frame used to
- * throw straight out of the loop, so every other expired file stayed on disk
- * forever and the volume only grew — and because a container restart is the
- * usual way a half-written tail appears, the failure looked Docker-specific.
- */
-export async function prunePayloadFrames(
-  before: Date,
-  unparseableWrittenBefore: Date = new Date(0),
-): Promise<number> {
-  const directory = payloadDirectory();
-  const entries = await readdir(directory, { withFileTypes: true }).catch(() => []);
-  let deleted = 0;
-  for (const entry of entries) {
-    if (!entry.isFile() || !isFrameFileName(entry.name)) continue;
-    const path = join(directory, entry.name);
-    try {
-      if (await fileReclaimable(path, before, unparseableWrittenBefore)) {
-        await unlink(path);
-        deleted += 1;
-      }
-    } catch {
-      // Stat, read, or unlink failed on this one file. Leave it for the next
-      // pass rather than abandoning every remaining file's reclaim.
-    }
-  }
-  return deleted;
-}
-
-/**
- * True when the file can be deleted without losing a frame a row still
- * addresses. A readable file is reclaimable once every frame has expired; a
- * damaged one only once `unparseableWrittenBefore` rules out a live frame in
- * the part that could not be parsed.
- */
-async function fileReclaimable(
-  path: string,
-  before: Date,
-  unparseableWrittenBefore: Date,
-): Promise<boolean> {
-  const data = await readFile(path);
-  // Nothing written yet, so nothing to lose. The old test was "shorter than a
-  // binary header", which the line format has no need of; a real frame — old
-  // or new — is far longer than that anyway.
-  if (data.byteLength === 0) return true;
-  const liveness = frameLiveness(data, before);
-  if (liveness === "live") return false;
-  if (liveness === "none") return true;
-  const written = await stat(path).then((value) => value.mtimeMs);
-  return written <= unparseableWrittenBefore.getTime();
-}
+import { mkdir, open, readdir, readFile, stat, unlink } from "node:fs/promises";
+import { basename, join } from "node:path";
+import { randomUUID } from "node:crypto";
+import { gunzipSync, gzipSync } from "node:zlib";
+
+export interface PayloadFileReference {
+  readonly storage: "jsonl-file";
+  readonly file: string;
+  readonly offset: number;
+  readonly length: number;
+  readonly checksum: string;
+  readonly version: 1;
+}
+
+interface PayloadFrame {
+  readonly version: 1;
+  readonly id: string;
+  readonly expiresAt: string;
+  readonly payload: unknown;
+}
+
+export function isPayloadFileReference(value: unknown): value is PayloadFileReference {
+  if (typeof value !== "object" || value === null) return false;
+  const record = value as Record<string, unknown>;
+  return (
+    record["storage"] === "jsonl-file" &&
+    typeof record["file"] === "string" &&
+    typeof record["offset"] === "number" &&
+    typeof record["length"] === "number" &&
+    typeof record["checksum"] === "string" &&
+    record["version"] === 1
+  );
+}
+
+/**
+ * Builds a frame reference from a `telemetry_payloads` row's typed columns.
+ * Returns undefined when any column is out of contract so callers treat a
+ * corrupt index row as "no payload" rather than path-traversing or reading
+ * the wrong bytes.
+ */
+export function payloadReferenceFromRow(row: {
+  readonly storage: string;
+  readonly file: string;
+  readonly offset: number;
+  readonly length: number;
+  readonly checksum: string;
+  readonly version: number;
+}): PayloadFileReference | undefined {
+  const candidate = {
+    storage: row.storage,
+    file: row.file,
+    offset: row.offset,
+    length: row.length,
+    checksum: row.checksum,
+    version: row.version,
+  };
+  return isPayloadFileReference(candidate) ? candidate : undefined;
+}
+
+/** Extension for frame files. */
+const FRAME_FILE_SUFFIX = ".jsonl";
+
+function isFrameFileName(name: string): boolean {
+  return name.endsWith(FRAME_FILE_SUFFIX);
+}
+
+const MAX_FRAME_BYTES = 256 * 1024 * 1024;
+const DEFAULT_MAX_FILE_BYTES = 64 * 1024 * 1024;
+const DEFAULT_DIRECTORY = "./data/telemetry-payloads";
+let writeTail: Promise<void> = Promise.resolve();
+
+/**
+ * Single source of truth for the telemetry payload directory: the
+ * `CARTETHYIA_TELEMETRY_PAYLOAD_DIR` override when set, otherwise the
+ * default `./data/telemetry-payloads`. Every writer and reader must resolve
+ * the directory through this function so the two can never drift.
+ */
+export function payloadDirectory(): string {
+  return process.env.CARTETHYIA_TELEMETRY_PAYLOAD_DIR?.trim() || DEFAULT_DIRECTORY;
+}
+
+function maxFileBytes(): number {
+  const raw = Number(process.env.CARTETHYIA_TELEMETRY_PAYLOAD_FILE_MAX_BYTES ?? DEFAULT_MAX_FILE_BYTES);
+  return Number.isFinite(raw) && raw > 0 ? Math.floor(raw) : DEFAULT_MAX_FILE_BYTES;
+}
+
+function checksum(value: Buffer | readonly Buffer[]): string {
+  const parts = Array.isArray(value) ? value : [value];
+  let hash = 2166136261;
+  for (const part of parts) {
+    for (let index = 0; index < part.byteLength; index += 1) {
+      hash ^= part[index]!;
+      hash = Math.imul(hash, 16777619);
+    }
+  }
+  return (hash >>> 0).toString(16).padStart(8, "0");
+}
+
+function fileName(now = new Date()): string {
+  return `${now.toISOString().slice(0, 13).replaceAll(":", "-")}-${process.pid}${FRAME_FILE_SUFFIX}`;
+}
+
+/**
+ * Gzipped frame body.
+ *
+ * The pieces stay separate until here, because nothing before the write reads
+ * them assembled and joining them earlier is a copy of the whole frame. The
+ * join happens once, at the moment of compression, and the compressed buffer
+ * is what gets written, checksummed, and bounded — so the cap and the
+ * reference both describe bytes on disk, not bytes of JSON.
+ */
+function compressFrame(parts: readonly Buffer[]): Buffer {
+  return gzipSync(Buffer.concat(parts));
+}
+
+async function appendFrame(frame: PayloadFrame, parts?: readonly Buffer[]): Promise<PayloadFileReference> {
+  const directory = payloadDirectory();
+  await mkdir(directory, { recursive: true });
+  // Encoded as a line here rather than at the write, so the cap, the checksum,
+  // and the reference all describe the same bytes that land on disk — the
+  // prebuilt-parts path and the plain one cannot disagree about the shape.
+  const json = parts === undefined
+    ? Buffer.from(JSON.stringify(frame), "utf8")
+    : Buffer.concat(parts);
+  const compressed = compressFrame([json]);
+  if (compressed.byteLength > MAX_FRAME_BYTES) throw new Error("telemetry payload frame exceeds limit");
+  const encoded = toLine(compressed);
+  const file = fileName();
+  const path = join(directory, file);
+  const currentSize = await stat(path).then((value) => value.size).catch(() => 0);
+  const offset = currentSize;
+  if (offset + encoded.byteLength > maxFileBytes()) {
+    const rotated = `${Date.now()}-${randomUUID()}${FRAME_FILE_SUFFIX}`;
+    return appendFrameToPath(join(directory, rotated), encoded, basename(rotated));
+  }
+  return appendFrameToPath(path, encoded, file, offset);
+}
+
+/**
+ * One frame as a stored line: base64 of the gzipped JSON, newline-terminated.
+ *
+ * A newline is the frame delimiter, so the file is a text file of base64 lines
+ * and a frame's extent is found by reading to the next `\n` — a binary length
+ * header would make every frame opaque, unreadable without first decoding a
+ * big-endian length and then gunzipping exactly that many bytes.
+ *
+ * base64 rather than raw gzip bytes because gzip contains newlines, which
+ * would make the delimiter ambiguous.
+ */
+function toLine(compressed: Buffer): Buffer {
+  return Buffer.from(`${compressed.toString("base64")}\n`, "utf8");
+}
+
+async function appendFrameToPath(
+  path: string,
+  encoded: Buffer,
+  knownFile = basename(path),
+  knownOffset?: number,
+): Promise<PayloadFileReference> {
+  const offset = knownOffset ?? await stat(path).then((value) => value.size).catch(() => 0);
+  const handle = await open(path, "a");
+  try {
+    await handle.write(encoded);
+  } finally {
+    await handle.close();
+  }
+  return {
+    storage: "jsonl-file",
+    file: knownFile,
+    offset,
+    length: encoded.byteLength,
+    checksum: checksum(encoded),
+    version: 1,
+  };
+}
+
+/**
+ * The frame's body keys, in the same order `buildPayloadRecord` serializes
+ * them.
+ *
+ * The record hands the writer one string per body already serialized, so the
+ * two orders must agree or every body lands under the wrong key. The order is
+ * drawer order with the legacy `response_body` alias last, for the same reason
+ * the record accounts it last: it names no panel of its own and must not
+ * spend the shared byte budget ahead of the provider stages.
+ *
+ * There are five, not four. `buildPayloadRecord` builds one string per surface
+ * and `response_body` is the fifth — dropping it here wrote the frame with the
+ * first four bodies and silently discarded the last, so a capture whose client
+ * response was in the legacy slot came back with that panel empty.
+ */
+const FRAME_BODY_KEYS = [
+  "request_body",
+  "provider_request_body",
+  "provider_response_body",
+  "client_response_body",
+  "response_body",
+] as const;
+
+/**
+ * The pieces of a frame whose bodies were already serialized while measured.
+ *
+ * Returned as separate buffers rather than one assembled buffer: the file
+ * write accepts a list, and assembling them first is a copy of the whole frame
+ * that nothing reads back.
+ */
+function prebuiltFrameParts(
+  id: string,
+  expiresAt: string,
+  capturedAt: string,
+  requestId: string | null,
+  signals: unknown,
+  bodies: readonly string[],
+): Buffer[] {
+  const parts = [
+    Buffer.from(
+      `{"version":1,"id":${JSON.stringify(id)},"expiresAt":${JSON.stringify(expiresAt)},` +
+        `"payload":{"request_id":${JSON.stringify(requestId)},"captured_at":${JSON.stringify(capturedAt)},` +
+        `"expires_at":${JSON.stringify(expiresAt)}`,
+      "utf8",
+    ),
+  ];
+  for (let index = 0; index < FRAME_BODY_KEYS.length; index += 1) {
+    parts.push(Buffer.from(`,"${FRAME_BODY_KEYS[index]}":${bodies[index] ?? "null"}`, "utf8"));
+  }
+  parts.push(Buffer.from(`,"signals":${JSON.stringify(signals)}}}`, "utf8"));
+  return parts;
+}
+
+export function writePayloadFrame(
+  payload: unknown,
+  expiresAt: Date,
+  prebuilt?: { readonly requestId: string | null; readonly capturedAt: string; readonly signals: unknown; readonly bodies: readonly string[] },
+): Promise<PayloadFileReference> {
+  const id = randomUUID();
+  const expires = expiresAt.toISOString();
+  const parts = prebuilt
+    ? prebuiltFrameParts(id, expires, prebuilt.capturedAt, prebuilt.requestId, prebuilt.signals, prebuilt.bodies)
+    : undefined;
+  const frame: PayloadFrame = { version: 1, id, expiresAt: expires, payload };
+  const task = writeTail.then(() => appendFrame(frame, parts));
+  writeTail = task.then(() => undefined, () => undefined);
+  return task;
+}
+
+export async function readPayloadFrame(reference: PayloadFileReference): Promise<unknown | undefined> {
+  // Basename-constrain the reference: a hostile/restored row carrying
+  // `../../x` must not escape the payload directory (path traversal).
+  const safeFile = basename(reference.file);
+  if (safeFile !== reference.file || safeFile.length === 0) return undefined;
+  const path = join(payloadDirectory(), safeFile);
+  // Read exactly the frame. Reading the whole file copied every earlier frame
+  // in the same hour into memory just to return one of them.
+  const handle = await open(path, "r");
+  let data: Buffer;
+  try {
+    const stat = await handle.stat();
+    if (reference.offset < 0 || reference.offset + reference.length > stat.size) return undefined;
+    data = Buffer.alloc(reference.length);
+    await handle.read(data, 0, reference.length, reference.offset);
+  } finally {
+    await handle.close();
+  }
+  const frame = data;
+  const json = frameJsonFromSlice(frame);
+  if (json === undefined) return undefined;
+  const parsed = JSON.parse(json.toString("utf8")) as PayloadFrame;
+  return parsed.version === 1 ? parsed.payload : undefined;
+}
+
+/** Decompressed frame body, or undefined when the bytes are not gzip. */
+function gunzipFrame(stored: Buffer): Buffer | undefined {
+  try {
+    return gunzipSync(stored);
+  } catch {
+    return undefined;
+  }
+}
+
+/**
+ * The JSON of one frame read out of a file.
+ *
+ * A frame is a base64 line — base64 because gzip contains newlines, which would
+ * make the newline delimiter ambiguous. The bytes are gunzipped only if they
+ * are gzip; `gunzipFrame` returning `undefined` is what marks a slice as not a
+ * frame.
+ */
+function frameJsonFromSlice(
+  slice: Buffer,
+): Buffer | undefined {
+  // Frames are a base64 line. The trailing newline is not part of the payload.
+  const text = slice.toString("utf8").trim();
+  if (text.length === 0) return undefined;
+  const gzipped = Buffer.from(text, "base64");
+  return gunzipFrame(gzipped);
+}
+
+/**
+ * What a whole file's parseable frames say about reclaiming it.
+ *
+ * `live` — at least one frame is still inside its retention window.
+ * `none` — every frame was read and every one has expired.
+ * `unknown` — parsing stopped on a torn tail or a corrupt frame, so the rest
+ *   of the file is unreadable and cannot be assumed empty of live frames.
+ */
+type FrameLiveness = "live" | "none" | "unknown";
+
+function frameLiveness(data: Buffer, before: Date): FrameLiveness {
+  let offset = 0;
+  while (offset < data.byteLength) {
+    const newline = data.indexOf(0x0a, offset);
+    if (newline <= 0) return "unknown";
+    const end = newline + 1;
+    const slice = data.subarray(offset, end);
+    const json = frameJsonFromSlice(slice);
+    if (json === undefined) return "unknown";
+    let frame: PayloadFrame;
+    try {
+      frame = JSON.parse(json.toString("utf8")) as PayloadFrame;
+    } catch {
+      return "unknown";
+    }
+    if (new Date(frame.expiresAt).getTime() >= before.getTime()) return "live";
+    offset = end;
+  }
+  // Bytes left over that are too short to hold a frame are an unreadable tail.
+  return offset === data.byteLength ? "none" : "unknown";
+}
+
+/**
+ * Reclaims frame files that no longer hold a live payload.
+ *
+ * Frames are append-only and this pass never rewrites a file. That is a
+ * correctness requirement, not an optimization: a `telemetry_payloads` row
+ * addresses its body by file + offset + length, so compacting a file in place
+ * would shift every later frame and leave live rows pointing at the wrong
+ * bytes — the drawer then reads `undefined` and the payload silently vanishes
+ * while its row is still current. A file is dropped whole, and only once
+ * nothing in it is still live.
+ *
+ * `unparseableWrittenBefore` bounds the damaged-file case. A region that
+ * cannot be parsed cannot prove it holds no live frame, so such a file is kept
+ * until its last write is older than that instant — every frame it could hold
+ * was written before then and has therefore expired. A caller that cannot
+ * supply that bound leaves the default, which keeps damaged files rather than
+ * risk dropping a frame a row still addresses.
+ *
+ * One damaged file must not abort the pass. If a single corrupt frame threw
+ * straight out of the loop, every other expired file would stay on disk
+ * forever and the volume would only grow — and because a container restart is
+ * the usual way a half-written tail appears, the failure would look
+ * Docker-specific.
+ */
+export async function prunePayloadFrames(
+  before: Date,
+  unparseableWrittenBefore: Date = new Date(0),
+): Promise<number> {
+  const directory = payloadDirectory();
+  const entries = await readdir(directory, { withFileTypes: true }).catch(() => []);
+  let deleted = 0;
+  for (const entry of entries) {
+    if (!entry.isFile() || !isFrameFileName(entry.name)) continue;
+    const path = join(directory, entry.name);
+    try {
+      if (await fileReclaimable(path, before, unparseableWrittenBefore)) {
+        await unlink(path);
+        deleted += 1;
+      }
+    } catch {
+      // Stat, read, or unlink failed on this one file. Leave it for the next
+      // pass rather than abandoning every remaining file's reclaim.
+    }
+  }
+  return deleted;
+}
+
+/**
+ * True when the file can be deleted without losing a frame a row still
+ * addresses. A readable file is reclaimable once every frame has expired; a
+ * damaged one only once `unparseableWrittenBefore` rules out a live frame in
+ * the part that could not be parsed.
+ */
+async function fileReclaimable(
+  path: string,
+  before: Date,
+  unparseableWrittenBefore: Date,
+): Promise<boolean> {
+  const data = await readFile(path);
+  // Nothing written yet, so nothing to lose. A real frame is far longer than
+  // any header this format could carry.
+  if (data.byteLength === 0) return true;
+  const liveness = frameLiveness(data, before);
+  if (liveness === "live") return false;
+  if (liveness === "none") return true;
+  const written = await stat(path).then((value) => value.mtimeMs);
+  return written <= unparseableWrittenBefore.getTime();
+}