feat(observability): delivery metrics, admin metrics/delivery endpoints, admin API route wiring

This commit is contained in:
RhenCloud 2026-08-15 17:03:02 +08:00
parent 2470bd786d
commit 1e9ba3c5dd
No known key found for this signature in database
GPG key ID: A574A617378C4E0B
17 changed files with 682 additions and 7 deletions

View file

@ -0,0 +1,223 @@
import { describe, it, expect } from "bun:test";
import { getDeliveryMetrics } from "../server/lib/observability/metrics";
import {
getSendLogByDelivery,
getFailedSendLog,
type SendRecord,
} from "../server/lib/lib/send-log";
import { adminApiMetrics, adminApiDelivery } from "../server/lib/web/admin";
import { createAdminSession, adminCookie } from "../server/lib/web/session";
import { makeEvent, responseStatus } from "./helpers";
import type { Env } from "../server/lib/types";
function createMockKV(): KVNamespace {
const store = new Map<string, string>();
return {
get: async (key: string, type?: string) => {
const v = store.get(key);
if (v == null) return null;
if (type === "json") return JSON.parse(v);
return v;
},
put: async (key: string, value: string) => {
store.set(key, value);
},
delete: async (key: string) => {
store.delete(key);
},
list: async () => ({
keys: [...store.keys()].map((k) => ({ name: k })),
list_complete: true,
cacheStatus: null,
}),
} as unknown as KVNamespace;
}
function createEnv(overrides: Partial<Env> = {}): Env {
return {
GITHUB_WEBHOOK_SECRET: "secret",
KV: createMockKV(),
DB: createMetricsDB({}),
...overrides,
};
}
function createMetricsDB(rowsBySql: Record<string, unknown[]>): D1Database {
const all = (sql: string) => async (): Promise<{ results: unknown[] }> => {
for (const [key, rows] of Object.entries(rowsBySql)) {
if (sql.includes(key)) return { results: rows };
}
return { results: [] };
};
return {
prepare: (sql: string) => ({
all: all(sql),
bind: (..._args: unknown[]) => ({
all: all(sql),
run: async () => ({ success: true }),
}),
}),
} as unknown as D1Database;
}
const logRow = (overrides: Record<string, unknown> = {}): Record<string, unknown> => ({
id: 1,
ts: 1700000000000,
route_id: "r1",
group_id: "mine",
event: "push",
repo: "acme/widget",
target: "discord:111",
ok: 1,
error: null,
status: 200,
message_id: "m1",
delivery_id: "d1",
platform: "discord",
actor: "alice",
action: null,
duration_ms: 100,
error_code: null,
attempts: 1,
detail: null,
...overrides,
});
describe("delivery metrics", () => {
it("aggregates send_logs into metrics", async () => {
const db = createMetricsDB({
"platform AS key": [
{ key: "discord", total: 7, ok: 6 },
{ key: "telegram", total: 3, ok: 2 },
],
"event AS key": [{ key: "push", total: 10, ok: 8 }],
"GROUP BY status": [
{ status: "200", count: 8 },
{ status: "500", count: 2 },
],
"AVG(duration_ms)": [{ avg: 120.5 }],
"SUM(attempts)": [{ total: 12, avg: 1.2 }],
"ok = 0": [logRow({ ok: 0, status: 500, error_code: "DISCORD_5XX" })],
"COUNT(*) AS total": [{ total: 10, ok: 8 }],
});
const m = await getDeliveryMetrics(db);
expect(m.total).toBe(10);
expect(m.ok).toBe(8);
expect(m.failed).toBe(2);
expect(m.failureRate).toBeCloseTo(0.2);
expect(m.byPlatform).toEqual([
{ platform: "discord", total: 7, ok: 6, failed: 1 },
{ platform: "telegram", total: 3, ok: 2, failed: 1 },
]);
expect(m.byEvent).toEqual([{ event: "push", total: 10, ok: 8, failed: 2 }]);
expect(m.byStatus).toEqual([
{ status: "200", count: 8 },
{ status: "500", count: 2 },
]);
expect(m.avgDurationMs).toBeCloseTo(120.5);
expect(m.totalAttempts).toBe(12);
expect(m.avgAttempts).toBeCloseTo(1.2);
expect(m.recentFailures).toHaveLength(1);
expect(m.recentFailures[0]!.errorCode).toBe("DISCORD_5XX");
});
it("returns zeroed metrics on empty database", async () => {
const m = await getDeliveryMetrics(createMetricsDB({}));
expect(m.total).toBe(0);
expect(m.ok).toBe(0);
expect(m.failed).toBe(0);
expect(m.failureRate).toBe(0);
expect(m.byPlatform).toEqual([]);
expect(m.recentFailures).toEqual([]);
});
it("correlates send_logs by delivery id", async () => {
const db = createMetricsDB({
delivery_id: [
logRow({ id: 1, ok: 1, delivery_id: "d1" }),
logRow({ id: 2, ok: 0, delivery_id: "d1", platform: "telegram", status: 500 }),
],
});
const rows = await getSendLogByDelivery(db, "d1");
expect(rows).toHaveLength(2);
expect(rows[0]!.deliveryId).toBe("d1");
expect(rows[1]!.ok).toBe(false);
});
it("lists failed sends", async () => {
const db = createMetricsDB({
"ok = 0": [logRow({ ok: 0, error_code: "NETWORK" })],
});
const rows: SendRecord[] = await getFailedSendLog(db, 5);
expect(rows).toHaveLength(1);
expect(rows[0]!.ok).toBe(false);
expect(rows[0]!.errorCode).toBe("NETWORK");
});
});
describe("admin metrics/delivery handlers", () => {
it("returns global metrics for super admins", async () => {
const kv = createMockKV();
const db = createMetricsDB({ "COUNT(*) AS total": [{ total: 5, ok: 4 }] });
const env = createEnv({ KV: kv, DB: db, ADMIN_USER_IDS: "1001" });
const sid = await createAdminSession(kv, "1001", "alice");
const event = makeEvent("/api/metrics", { headers: { cookie: adminCookie(sid) }, env });
const res = (await adminApiMetrics(event)) as { metrics: { total: number } };
expect(responseStatus(event)).toBe(200);
expect(res.metrics.total).toBe(5);
});
it("filters recentFailures for non-super users", async () => {
const kv = createMockKV();
await kv.put(
"config:groups",
JSON.stringify([
{ id: "mine", name: "Mine", adminIds: [], members: [{ login: "bob", role: "owner" }] },
]),
);
const db = createMetricsDB({
"ok = 0": [logRow({ ok: 0, group_id: "mine" }), logRow({ ok: 0, group_id: "theirs" })],
"COUNT(*) AS total": [{ total: 1, ok: 0 }],
});
const env = createEnv({ KV: kv, DB: db });
const sid = await createAdminSession(kv, "2002", "bob");
const event = makeEvent("/api/metrics", { headers: { cookie: adminCookie(sid) }, env });
const res = (await adminApiMetrics(event)) as {
metrics: { recentFailures: Array<{ groupId?: string }> };
};
expect(res.metrics.recentFailures).toHaveLength(1);
expect(res.metrics.recentFailures[0]!.groupId).toBe("mine");
});
it("returns 404 for an unknown delivery", async () => {
const kv = createMockKV();
const env = createEnv({
KV: kv,
DB: createMetricsDB({ delivery_id: [] }),
ADMIN_USER_IDS: "1001",
});
const sid = await createAdminSession(kv, "1001", "alice");
const event = makeEvent("/api/delivery/nope", { headers: { cookie: adminCookie(sid) }, env });
const res = (await adminApiDelivery(event, "nope")) as { error?: string };
expect(responseStatus(event)).toBe(404);
expect(res.error).toBe("Delivery not found");
});
it("returns correlated attempts for a delivery", async () => {
const kv = createMockKV();
const db = createMetricsDB({
delivery_id: [logRow({ id: 1, ok: 1, delivery_id: "d1" })],
});
const env = createEnv({ KV: kv, DB: db, ADMIN_USER_IDS: "1001" });
const sid = await createAdminSession(kv, "1001", "alice");
const event = makeEvent("/api/delivery/d1", { headers: { cookie: adminCookie(sid) }, env });
const res = (await adminApiDelivery(event, "d1")) as {
deliveryId?: string;
attempts?: Array<{ deliveryId?: string }>;
};
expect(responseStatus(event)).toBe(200);
expect(res.deliveryId).toBe("d1");
expect(res.attempts).toHaveLength(1);
expect(res.attempts![0]!.deliveryId).toBe("d1");
});
});