Public: anyone can read this; the crew can change it.
The telemetry settings page's Server-Timing names its phases: session, each read, render #3530
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/3497-the-telemetry-settings-page-s-server-tim → main 1 commit fork 1 thread · 1 unresolved
2 files
changed +65
−3
src/web/pages/telemetry.ts +8 −3
| @@ -5,6 +5,7 @@ | ||
| 5 | 5 | import { setTelemetryGrant } from "../../actions/telemetry.ts"; |
| 6 | 6 | import { grantable, recentReads } from "../../core/telemetry.ts"; |
| 7 | 7 | import type { Ctx } from "../../http/context.ts"; |
| 8 | import { notePhase, takeSessionTime, timePhase } from "../../core/route_timing.ts"; | |
| 8 | 9 | import { notFoundPage, signInFirst } from "../chrome.ts"; |
| 9 | 10 | import { field, readForm } from "../form.ts"; |
| 10 | 11 | import { html } from "../html.ts"; |
| @@ -19,10 +20,12 @@ function owner(ctx: Ctx): Response | undefined { | ||
| 19 | 20 | |
| 20 | 21 | // GET /settings/telemetry |
| 21 | 22 | export function telemetryPage(ctx: Ctx): Response { |
| 23 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 22 | 24 | const denied = owner(ctx); |
| 23 | 25 | if (denied) return denied; |
| 24 | const agents = grantable(ctx.app.db); | |
| 25 | const reads = recentReads(ctx.app.db); | |
| 26 | const agents = timePhase(ctx.request, "agents", () => grantable(ctx.app.db)); | |
| 27 | const reads = timePhase(ctx.request, "reads", () => recentReads(ctx.app.db)); | |
| 28 | const rendering = performance.now(); | |
| 26 | 29 | const body = html`${card( |
| 27 | 30 | html`<div class="card-body"><p class="muted small"> |
| 28 | 31 | A granted agent reads <a href="/boards">Boards</a>, <a href="/system">System</a> and the |
| @@ -60,7 +63,9 @@ export function telemetryPage(ctx: Ctx): Response { | ||
| 60 | 63 | )}</ul>`, |
| 61 | 64 | { head: html`${icon("history")}<h2>Reads</h2>`, pad: false }, |
| 62 | 65 | )}`; |
| 63 | return usageShell(ctx, "telemetry", body); | |
| 66 | const response = usageShell(ctx, "telemetry", body); | |
| 67 | notePhase(ctx.request, "render", performance.now() - rendering); | |
| 68 | return response; | |
| 64 | 69 | } |
| 65 | 70 | |
| 66 | 71 | // POST /settings/telemetry |
test/telemetry-timing.test.ts added +57
| @@ -0,0 +1,57 @@ | ||
| 1 | /** `/settings/telemetry` names session, agents, reads and render in Server-Timing (#3497). */ | |
| 2 | import { afterAll, beforeAll, expect, test } from "bun:test"; | |
| 3 | import { mkdtempSync, rmSync } from "node:fs"; | |
| 4 | import { tmpdir } from "node:os"; | |
| 5 | import { join } from "node:path"; | |
| 6 | import { createRepo } from "../src/actions/repos.ts"; | |
| 7 | import { createApp, type App } from "../src/app.ts"; | |
| 8 | import { createUser } from "../src/core/users.ts"; | |
| 9 | import { serve, type Servers } from "../src/http/server.ts"; | |
| 10 | import { proveAll } from "./helpers/verified.ts"; | |
| 11 | import { quietLogs } from "./helpers/globals.ts"; | |
| 12 | ||
| 13 | quietLogs(); | |
| 14 | ||
| 15 | let root = ""; | |
| 16 | let app: App; | |
| 17 | let servers: Servers; | |
| 18 | ||
| 19 | beforeAll(async () => { | |
| 20 | root = mkdtempSync(join(tmpdir(), "forge-telemetry-timing-")); | |
| 21 | app = createApp({ dataDir: root, port: 0, forgeRepo: "alice/forge" }); | |
| 22 | const u = await createUser(app.db, { | |
| 23 | origin: "seed", | |
| 24 | trusted: true, | |
| 25 | username: "alice", | |
| 26 | email: "[email protected]", | |
| 27 | password: "a-good-passphrase", | |
| 28 | adminIfFirst: true, | |
| 29 | }); | |
| 30 | if (!u.ok) throw new Error(u.error); | |
| 31 | proveAll(app); | |
| 32 | const made = await createRepo(app, { id: u.value.id, username: "alice" } as never, { name: "forge" }); | |
| 33 | if (!made.ok) throw new Error(made.error); | |
| 34 | servers = await serve(app); | |
| 35 | }); | |
| 36 | afterAll(() => { | |
| 37 | servers.stop(); | |
| 38 | app.close(); | |
| 39 | rmSync(root, { recursive: true, force: true }); | |
| 40 | }); | |
| 41 | ||
| 42 | test("GET /settings/telemetry names its phases", async () => { | |
| 43 | const signin = await fetch(`${servers.url}/signin`, { | |
| 44 | method: "POST", | |
| 45 | headers: { origin: servers.url }, | |
| 46 | body: new URLSearchParams({ username: "alice", password: "a-good-passphrase" }), | |
| 47 | redirect: "manual", | |
| 48 | }); | |
| 49 | const cookie = (signin.headers.get("set-cookie") ?? "").split(";")[0]!; | |
| 50 | const res = await fetch(`${servers.url}/settings/telemetry`, { headers: { cookie } }); | |
| 51 | const body = await res.text(); | |
| 52 | expect(res.status).toBe(200); | |
| 53 | expect(body).toContain("Telemetry grants"); | |
| 54 | const parts = (res.headers.get("server-timing") ?? "").split(", "); | |
| 55 | for (const name of ["app", "session", "agents", "reads", "render"]) | |
| 56 | expect(parts.find((p) => p.startsWith(`${name};`))).toMatch(/^[a-z]+;dur=\d+\.\d$/); | |
| 57 | }); |
new above
offline
Nit: this import sits after ../../http/context.ts. Put it with the other ../../core imports.