src/portal-activity.ts

Functions

Imports

It imports src/audit-detail.ts, src/ops-types/portal.ts. Imported by src/portal-actions.ts.

Source

1import { auditDetail } from "./audit-detail";
2import type { AuditDetail } from "./ops-types/portal";
3
4// Recent activity: a bounded, filtered read of audit_log across every namespace, for
5// Capsid Portal's Activity view. The filter comes off a query string, so every value is a
6// bound parameter; the test asserts the statement's shape as well as its results. One
7// row by id is what the Activity drawer reads (?id=), through the primary key.
8
9export const ACTIVITY_LIMIT = 50;
10
11export interface ActivityFilter {
12  namespace: string | null;
13  actor: string | null;
14  id: number | null;
15}
16
17// What an audit row records, where the row says. A job transition writes two rows with
18// one action, actor and path: one for the job (params carry job_id) and one for its
19// mirror document (params carry the body's sha256, as every document write does).
20// null when the params name neither, or are not JSON.
21type ActivityTarget = "job" | "document";
22
23export interface ActivityRow {
24  id: number;
25  at: string;
26  actor: string | null;
27  action: string | null;
28  namespace: string | null;
29  path: string | null;
30  target: ActivityTarget | null;
31  detail: AuditDetail;
32}
33
34function param(url: URL, name: string): string | null {
35  const raw = url.searchParams.get(name);
36  if (raw === null) return null;
37  const trimmed = raw.trim();
38  // An empty value is no filter, not a filter on the empty string.
39  return trimmed.length ? trimmed : null;
40}
41
42// An audit row id: a positive whole number, as the autoincrement writes it.
43const ROW_ID = /^[1-9][0-9]{0,15}$/;
44
45/** The filter, or why the query string cannot be one. An id that is not a row id is
46 *  refused rather than dropped, which would answer with the whole log instead. */
47export function activityFilterFrom(url: URL): { ok: true; filter: ActivityFilter } | { ok: false; refusal: string } {
48  const id = param(url, "id");
49  if (id !== null && !ROW_ID.test(id)) return { ok: false, refusal: `id must be an audit row id, a positive whole number; got ${JSON.stringify(id.slice(0, 40))}.` };
50  return { ok: true, filter: { namespace: param(url, "namespace"), actor: param(url, "actor"), id: id === null ? null : Number(id) } };
51}
52
53// json_valid first: json_extract on a params value that is not JSON would fail the
54// whole read, and rows written before params were always JSON exist.
55const TARGET_SQL = `CASE WHEN NOT json_valid(params) THEN NULL
56  WHEN json_extract(params, '$.job_id') IS NOT NULL THEN 'job'
57  WHEN json_extract(params, '$.sha256') IS NOT NULL THEN 'document'
58  ELSE NULL END`;
59
60export async function loadActivity(db: D1Database, filter: ActivityFilter): Promise<ActivityRow[]> {
61  const where: string[] = [];
62  const binds: unknown[] = [];
63  if (filter.id !== null) {
64    binds.push(filter.id);
65    where.push(`id = ?${binds.length}`);
66  } else if (filter.namespace) {
67    binds.push(filter.namespace);
68    where.push(`namespace = ?${binds.length}`);
69  }
70  if (filter.id === null && filter.actor) {
71    binds.push(filter.actor);
72    where.push(`actor = ?${binds.length}`);
73  }
74  binds.push(ACTIVITY_LIMIT);
75  const clause = where.length ? `WHERE ${where.join(" AND ")}` : "";
76  // ORDER BY id, not `at`: `at` is text written in two formats, and the
77  // autoincrement id is what orders rows as they happened.
78  const { results } = await db
79    .prepare(
80      `SELECT id, at, actor, action, namespace, path, ${TARGET_SQL} AS target, params FROM audit_log ${clause} ORDER BY id DESC LIMIT ?${binds.length}`
81    )
82    .bind(...binds)
83    .all<Omit<ActivityRow, "detail"> & { params: string | null }>();
84  // The params never leave here: each row carries its named fields instead.
85  return (results ?? []).map(({ params, ...row }) => ({ ...row, detail: auditDetail(params) }));
86}