Public: anyone can read this; the crew can change it.
The API's upstream read names its Server-Timing phases: session, upstream, render #4936
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/4907-the-api-s-upstream-read-names-its-server → main 1 commit fork
2 files
changed +75
−5
src/http/api.ts +8 −5
| @@ -2345,13 +2345,16 @@ export function apiRoutes(router: Router<Handler>): void { | ||
| 2345 | 2345 | |
| 2346 | 2346 | // Following an outside upstream (#3442): an admin reads, sets and checks. |
| 2347 | 2347 | router.add("GET", "/api/v1/repos/:owner/:name/upstream", (ctx) => { |
| 2348 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 2348 | 2349 | const denied = requireScope(ctx, "ro"); |
| 2349 | 2350 | if (denied) return denied; |
| 2350 | const repo = loadRepo(ctx); | |
| 2351 | if (!repo) return notFound(); | |
| 2352 | if (!canAdmin(ctx.app.db, repo, ctx.auth.user)) return notFound(); | |
| 2353 | const follow = getFollow(ctx.app.db, repo.id); | |
| 2354 | return json({ following: follow === undefined ? null : followJson(follow) }); | |
| 2351 | const read = timePhase(ctx.request, "upstream", () => { | |
| 2352 | const repo = loadRepo(ctx); | |
| 2353 | if (!repo || !canAdmin(ctx.app.db, repo, ctx.auth.user)) return undefined; | |
| 2354 | return getFollow(ctx.app.db, repo.id) ?? null; | |
| 2355 | }); | |
| 2356 | if (read === undefined) return notFound(); | |
| 2357 | return timePhase(ctx.request, "render", () => json({ following: read === null ? null : followJson(read) })); | |
| 2355 | 2358 | }); |
| 2356 | 2359 | |
| 2357 | 2360 | router.add("PUT", "/api/v1/repos/:owner/:name/upstream", async (ctx) => { |
test/api-upstream-timing.test.ts added +67
| @@ -0,0 +1,67 @@ | ||
| 1 | /** The API upstream read names its Server-Timing phases (#4907). */ | |
| 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 { createRepo } from "../src/actions/repos.ts"; | |
| 8 | import { createSession } from "../src/core/sessions.ts"; | |
| 9 | import { createUser } from "../src/core/users.ts"; | |
| 10 | import { serve, type Servers } from "../src/http/server.ts"; | |
| 11 | import { quietLogs } from "./helpers/globals.ts"; | |
| 12 | ||
| 13 | quietLogs(); | |
| 14 | ||
| 15 | let dataDir: string; | |
| 16 | let app: App; | |
| 17 | let servers: Servers; | |
| 18 | let cookie = ""; | |
| 19 | ||
| 20 | const cells = process.env["FORGE_CELLS"]; | |
| 21 | ||
| 22 | beforeAll(async () => { | |
| 23 | process.env["FORGE_CELLS"] = "off"; | |
| 24 | dataDir = await mkdtemp(join(tmpdir(), "forge-api-upstream-timing-")); | |
| 25 | app = createApp({ dataDir, port: 0 }); | |
| 26 | servers = await serve(app); | |
| 27 | const made = await createUser(app.db, { | |
| 28 | origin: "seed", | |
| 29 | trusted: true, | |
| 30 | username: "alice", | |
| 31 | email: "[email protected]", | |
| 32 | password: "a-good-passphrase", | |
| 33 | adminIfFirst: true, | |
| 34 | }); | |
| 35 | if (!made.ok) throw new Error(String(made.error)); | |
| 36 | const alice = made.value; | |
| 37 | cookie = `forge_session=${createSession(app.db, alice.id).token}`; | |
| 38 | const repo = await createRepo(app, alice, { name: "r", visibility: "public" }); | |
| 39 | if (!repo.ok) throw new Error(String(repo.error)); | |
| 40 | }); | |
| 41 | afterAll(async () => { | |
| 42 | await servers.stop(); | |
| 43 | app.close(); | |
| 44 | if (cells === undefined) delete process.env["FORGE_CELLS"]; | |
| 45 | else process.env["FORGE_CELLS"] = cells; | |
| 46 | await rm(dataDir, { recursive: true, force: true }); | |
| 47 | }); | |
| 48 | ||
| 49 | async function phases(path: string): Promise<{ status: number; names: string[]; body: string }> { | |
| 50 | const res = await fetch(`${servers.url}${path}`, { headers: { cookie } }); | |
| 51 | const body = await res.text(); | |
| 52 | const names = (res.headers.get("server-timing") ?? "").split(", ").map((p) => p.split(";")[0]!); | |
| 53 | return { status: res.status, names: names.slice(names.indexOf("app") + 1), body }; | |
| 54 | } | |
| 55 | ||
| 56 | test("the upstream read names session, upstream, render in order", async () => { | |
| 57 | const got = await phases("/api/v1/repos/alice/r/upstream"); | |
| 58 | expect(got.status).toBe(200); | |
| 59 | expect(got.names).toEqual(["session", "upstream", "render"]); | |
| 60 | expect(JSON.parse(got.body)).toEqual({ following: null }); | |
| 61 | }); | |
| 62 | ||
| 63 | test("a missing repository is a 404 naming session and upstream", async () => { | |
| 64 | const got = await phases("/api/v1/repos/alice/nope/upstream"); | |
| 65 | expect(got.status).toBe(404); | |
| 66 | expect(got.names).toEqual(["session", "upstream"]); | |
| 67 | }); |
new above
offline