Public: anyone can read this; the crew can change it.
The telemetry reads name their Server-Timing phases: system, history, flow and sources #4987
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/4980-the-telemetry-reads-name-their-server-ti → main 1 commit fork
2 files
changed +52
−1
src/http/api.ts +3 −1
| @@ -1431,13 +1431,15 @@ export function apiRoutes(router: Router<Handler>): void { | ||
| 1431 | 1431 | const telemetryRead = |
| 1432 | 1432 | (what: string, out: (ctx: Ctx, reader: Reader) => unknown) => |
| 1433 | 1433 | (ctx: Ctx): Response => { |
| 1434 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 1434 | 1435 | if (!ctx.auth.user) return unauthorized(); |
| 1435 | 1436 | const denied = requireScope(ctx, "ro"); |
| 1436 | 1437 | if (denied) return denied; |
| 1437 | 1438 | const reader = telemetryReader(ctx.app, ctx.auth.user); |
| 1438 | 1439 | if (!reader) return forbidden(); |
| 1439 | 1440 | noteRead(ctx.app, ctx.auth.user, reader, what); |
| 1440 | return json(out(ctx, reader)); | |
| 1441 | const body = timePhase(ctx.request, what, () => out(ctx, reader)); | |
| 1442 | return timePhase(ctx.request, "render", () => json(body)); | |
| 1441 | 1443 | }; |
| 1442 | 1444 | router.add("GET", "/api/v1/telemetry/system", telemetryRead("system", (c, r) => systemFor(c.app, r))); |
| 1443 | 1445 | router.add("GET", "/api/v1/telemetry/flow", telemetryRead("flow", (c, r) => flowFor(c.app, r))); |
test/telemetry-reads-timing.test.ts added +49
| @@ -0,0 +1,49 @@ | ||
| 1 | /** The /api/v1/telemetry reads name their phases in Server-Timing. */ | |
| 2 | import { afterAll, beforeAll, expect, test } from "bun:test"; | |
| 3 | import { mkdtemp, rm } from "node:fs/promises"; | |
| 4 | import { tmpdir } from "node:os"; | |
| 5 | import { join } from "node:path"; | |
| 6 | import { createApp, type App } from "../src/app.ts"; | |
| 7 | import { serve, type Servers } from "../src/http/server.ts"; | |
| 8 | import { seedAdmin } from "./helpers/admin.ts"; | |
| 9 | ||
| 10 | let dataDir = ""; | |
| 11 | let app: App, servers: Servers, bearer = ""; | |
| 12 | ||
| 13 | beforeAll(async () => { | |
| 14 | dataDir = await mkdtemp(join(tmpdir(), "forge-ttime-")); | |
| 15 | app = createApp({ dataDir, port: 0 }); | |
| 16 | servers = await serve(app); | |
| 17 | await seedAdmin(app, { username: "alice", email: "[email protected]", password: "correct-horse-battery" }); | |
| 18 | const minted = await fetch(`${servers.url}/api/v1/tokens`, { | |
| 19 | method: "POST", | |
| 20 | headers: { "content-type": "application/json" }, | |
| 21 | body: JSON.stringify({ adminConfirm: true, username: "alice", password: "correct-horse-battery", name: "cli", scope: "admin" }), | |
| 22 | }); | |
| 23 | bearer = ((await minted.json()) as { token: string }).token; | |
| 24 | }); | |
| 25 | ||
| 26 | afterAll(async () => { | |
| 27 | servers.stop(); | |
| 28 | app.close(); | |
| 29 | await rm(dataDir, { recursive: true, force: true }); | |
| 30 | }); | |
| 31 | ||
| 32 | const phases = (res: Response) => | |
| 33 | (res.headers.get("server-timing") ?? "").split(", ").map((p) => p.split(";")[0]!).filter((n) => n && n !== "app"); | |
| 34 | ||
| 35 | for (const what of ["system", "history", "flow", "sources"]) { | |
| 36 | test(`telemetry/${what} names session, ${what}, render in order`, async () => { | |
| 37 | const res = await fetch(`${servers.url}/api/v1/telemetry/${what}`, { headers: { authorization: `Bearer ${bearer}` } }); | |
| 38 | await res.arrayBuffer(); | |
| 39 | expect(res.status).toBe(200); | |
| 40 | expect(phases(res)).toEqual(["session", what, "render"]); | |
| 41 | }); | |
| 42 | } | |
| 43 | ||
| 44 | test("a refused telemetry read still names session", async () => { | |
| 45 | const res = await fetch(`${servers.url}/api/v1/telemetry/system`); | |
| 46 | await res.arrayBuffer(); | |
| 47 | expect(res.status).toBe(401); | |
| 48 | expect(phases(res)).toEqual(["session"]); | |
| 49 | }); |
new above
offline