Public: anyone can read this; the crew can change it.
A repository's reports list's Server-Timing names its phases: session, each read, render #3450
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/3421-a-repository-s-reports-list-s-server-tim → main 1 commit fork 1 thread · 1 unresolved
2 files
changed +72
−3
src/web/pages/reports.ts +15 −3
| @@ -22,6 +22,11 @@ import { | ||
| 22 | 22 | import { canRead, type Repo } from "../../core/repos.ts"; |
| 23 | 23 | import { scopeAllows } from "../../core/tokens.ts"; |
| 24 | 24 | import type { Ctx } from "../../http/context.ts"; |
| 25 | import { | |
| 26 | notePhase, | |
| 27 | takeSessionTime, | |
| 28 | timePhase, | |
| 29 | } from "../../core/route_timing.ts"; | |
| 25 | 30 | import { clientBucket } from "../../http/peer.ts"; |
| 26 | 31 | import { |
| 27 | 32 | crumbsFor, |
| @@ -231,16 +236,21 @@ function reportCard(base: string, report: Report): Html { | ||
| 231 | 236 | |
| 232 | 237 | // GET /:owner/:name/reports |
| 233 | 238 | export function reportsPage(ctx: Ctx): Response { |
| 234 | const repo = loadRepo(ctx); | |
| 239 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 240 | const repo = timePhase(ctx.request, "repo", () => loadRepo(ctx)); | |
| 235 | 241 | if (!repo) return notFoundPage(ctx); |
| 236 | 242 | if (!ctx.auth.user) return signInFirst(ctx); |
| 237 | 243 | // A read-only token (an app process holds its owner's) never reads them. |
| 238 | 244 | if (ctx.auth.scope === undefined || !scopeAllows(ctx.auth.scope, "rw")) |
| 239 | 245 | return notFoundPage(ctx); |
| 240 | const waiting = waitingReports(ctx.app, ctx.auth.user, repo); | |
| 246 | const user = ctx.auth.user; | |
| 247 | const waiting = timePhase(ctx.request, "reports", () => | |
| 248 | waitingReports(ctx.app, user, repo), | |
| 249 | ); | |
| 241 | 250 | if (!waiting.ok) return notFoundPage(ctx); |
| 242 | 251 | const base = repoBase(repo); |
| 243 | return page({ | |
| 252 | const rendering = performance.now(); | |
| 253 | const response = page({ | |
| 244 | 254 | ctx, |
| 245 | 255 | title: `Reports from outside · ${repo.ownerName}/${repo.name}`, |
| 246 | 256 | crumbs: crumbsFor(repo), |
| @@ -264,6 +274,8 @@ export function reportsPage(ctx: Ctx): Response { | ||
| 264 | 274 | : waiting.value.map((r) => reportCard(base, r))} |
| 265 | 275 | </div>`, |
| 266 | 276 | }); |
| 277 | notePhase(ctx.request, "render", performance.now() - rendering); | |
| 278 | return response; | |
| 267 | 279 | } |
| 268 | 280 | |
| 269 | 281 | // POST /:owner/:name/reports/:id/accept |
test/reports-timing.test.ts added +57
| @@ -0,0 +1,57 @@ | ||
| 1 | /** A repository's `/reports` names session, repo, reports and render in Server-Timing (#3421). */ | |
| 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-reports-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: "garden" }); | |
| 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("a writer's GET /:owner/:name/reports 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}/alice/garden/reports`, { headers: { cookie } }); | |
| 51 | const body = await res.text(); | |
| 52 | expect(res.status).toBe(200); | |
| 53 | expect(body).toContain("Reports from outside"); | |
| 54 | const parts = (res.headers.get("server-timing") ?? "").split(", "); | |
| 55 | for (const name of ["app", "session", "repo", "reports", "render"]) | |
| 56 | expect(parts.find((p) => p.startsWith(`${name};`))).toMatch(/^[a-z]+;dur=\d+\.\d$/); | |
| 57 | }); |
new above
offline
Avoid
as never: pass the user returned by createUser so the test breaks if createRepo changes its input.