Public: anyone can read this; the crew can change it.
The API's read of one repository names its Server-Timing phases: session, repo, each read, render #3795
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/3790-the-api-s-read-of-one-repository-names-i → main 3 commits fork 1 thread · 1 unresolved
2 files
changed +79
−7
src/http/api.ts +9 −7
| @@ -2276,13 +2276,15 @@ export function apiRoutes(router: Router<Handler>): void { | ||
| 2276 | 2276 | }); |
| 2277 | 2277 | |
| 2278 | 2278 | router.add("GET", "/api/v1/repos/:owner/:name", (ctx) => { |
| 2279 | const repo = loadRepo(ctx); | |
| 2280 | return repo | |
| 2281 | ? json({ | |
| 2282 | ...repoJson(ctx, repo), | |
| 2283 | audience: audienceFor(ctx.app.db, repo, ctx.auth.user), | |
| 2284 | }) | |
| 2285 | : notFound(); | |
| 2279 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 2280 | const repo = timePhase(ctx.request, "repo", () => loadRepo(ctx)); | |
| 2281 | if (!repo) return notFound(); | |
| 2282 | const facts = timePhase(ctx.request, "counts", () => repoJson(ctx, repo)); | |
| 2283 | const audience = timePhase(ctx.request, "audience", () => audienceFor(ctx.app.db, repo, ctx.auth.user)); | |
| 2284 | const rendering = performance.now(); | |
| 2285 | const res = json({ ...facts, audience }); | |
| 2286 | notePhase(ctx.request, "render", performance.now() - rendering); | |
| 2287 | return res; | |
| 2286 | 2288 | }); |
| 2287 | 2289 | |
| 2288 | 2290 | router.add("PATCH", "/api/v1/repos/:owner/:name", async (ctx) => { |
test/api-repo-timing.test.ts added +70
| @@ -0,0 +1,70 @@ | ||
| 1 | /** `GET /api/v1/repos/:owner/:name` names session, repo, its reads and render in Server-Timing (#3790). */ | |
| 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 | let cookie = ""; | |
| 19 | ||
| 20 | beforeAll(async () => { | |
| 21 | root = mkdtempSync(join(tmpdir(), "forge-api-repo-timing-")); | |
| 22 | app = createApp({ dataDir: root, port: 0, forgeRepo: "alice/forge" }); | |
| 23 | const u = await createUser(app.db, { | |
| 24 | origin: "seed", | |
| 25 | trusted: true, | |
| 26 | username: "alice", | |
| 27 | email: "[email protected]", | |
| 28 | password: "a-good-passphrase", | |
| 29 | adminIfFirst: true, | |
| 30 | }); | |
| 31 | if (!u.ok) throw new Error(u.error); | |
| 32 | proveAll(app); | |
| 33 | const made = await createRepo(app, { id: u.value.id, username: "alice" } as never, { name: "forge" }); | |
| 34 | if (!made.ok) throw new Error(made.error); | |
| 35 | servers = await serve(app); | |
| 36 | const signin = await fetch(`${servers.url}/signin`, { | |
| 37 | method: "POST", | |
| 38 | headers: { origin: servers.url }, | |
| 39 | body: new URLSearchParams({ username: "alice", password: "a-good-passphrase" }), | |
| 40 | redirect: "manual", | |
| 41 | }); | |
| 42 | cookie = (signin.headers.get("set-cookie") ?? "").split(";")[0]!; | |
| 43 | }); | |
| 44 | afterAll(() => { | |
| 45 | servers.stop(); | |
| 46 | app.close(); | |
| 47 | rmSync(root, { recursive: true, force: true }); | |
| 48 | }); | |
| 49 | ||
| 50 | const names = (res: Response): string[] => | |
| 51 | (res.headers.get("server-timing") ?? "").split(", ").map((p) => p.split(";")[0]!); | |
| 52 | ||
| 53 | test("the read of one repository names its phases", async () => { | |
| 54 | const res = await fetch(`${servers.url}/api/v1/repos/alice/forge`, { headers: { cookie } }); | |
| 55 | expect(res.status).toBe(200); | |
| 56 | const body = (await res.json()) as { name: string; audience: unknown; counts: unknown }; | |
| 57 | expect(body.name).toBe("forge"); | |
| 58 | expect(body.audience).toBeDefined(); | |
| 59 | expect(body.counts).toBeDefined(); | |
| 60 | for (const name of ["app", "session", "repo", "counts", "audience", "render"]) | |
| 61 | expect(names(res)).toContain(name); | |
| 62 | }); | |
| 63 | ||
| 64 | test("a 404 still names session and repo", async () => { | |
| 65 | const res = await fetch(`${servers.url}/api/v1/repos/alice/nope`, { headers: { cookie } }); | |
| 66 | expect(res.status).toBe(404); | |
| 67 | expect(names(res)).toContain("session"); | |
| 68 | expect(names(res)).toContain("repo"); | |
| 69 | expect(names(res)).not.toContain("render"); | |
| 70 | }); |
new above
offline
Nit, not blocking:
timePhase(ctx.request, "render", () => json({ ...facts, audience }))does the same as this hand-rolledperformance.now()pair, and it is how the pull-diff handler names its render phase. Using it would keep the two handlers alike.