Public: anyone can read this; the crew can change it.
The API's runs list names its Server-Timing phases: session, runs, render #4909
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/4893-the-api-s-runs-list-names-its-server-tim → main 1 commit fork
2 files
changed +77
−7
src/http/api.ts +10 −7
| @@ -5897,22 +5897,25 @@ export function apiRoutes(router: Router<Handler>): void { | ||
| 5897 | 5897 | }); |
| 5898 | 5898 | |
| 5899 | 5899 | router.add("GET", "/api/v1/repos/:owner/:name/runs", (ctx) => { |
| 5900 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 5900 | 5901 | const repo = loadRepo(ctx); |
| 5901 | 5902 | if (!repo) return notFound(); |
| 5902 | 5903 | const q = ctx.url.searchParams; |
| 5903 | 5904 | const kind = q.get("kind"); |
| 5904 | 5905 | const env = q.get("env"); |
| 5905 | 5906 | const limit = Math.min(Math.max(Number(q.get("limit")) || 50, 1), 200); |
| 5906 | const runs = listRepoRuns(ctx.app, ctx.auth.user, repo, { | |
| 5907 | ...(kind === "deploy" || kind === "agent" ? { kind } : {}), | |
| 5908 | ...(env !== null && isEnvName(env) ? { env } : {}), | |
| 5909 | ...(q.get("cursor") ? { cursor: q.get("cursor")! } : {}), | |
| 5910 | limit, | |
| 5911 | }); | |
| 5907 | const runs = timePhase(ctx.request, "runs", () => | |
| 5908 | listRepoRuns(ctx.app, ctx.auth.user, repo, { | |
| 5909 | ...(kind === "deploy" || kind === "agent" ? { kind } : {}), | |
| 5910 | ...(env !== null && isEnvName(env) ? { env } : {}), | |
| 5911 | ...(q.get("cursor") ? { cursor: q.get("cursor")! } : {}), | |
| 5912 | limit, | |
| 5913 | }), | |
| 5914 | ); | |
| 5912 | 5915 | if (!runs.ok) return notFound(); |
| 5913 | 5916 | // Already as this reader may see them (`runForReader`): a stranger's |
| 5914 | 5917 | // runs carry no cost, turns, agent session or node. |
| 5915 | return json(paged(runs.value, limit, (r) => r.id)); | |
| 5918 | return timePhase(ctx.request, "render", () => json(paged(runs.value, limit, (r) => r.id))); | |
| 5916 | 5919 | }); |
| 5917 | 5920 | |
| 5918 | 5921 | router.add("GET", "/api/v1/repos/:owner/:name/runs/:id", (ctx) => { |
test/api-runs-timing.test.ts added +67
| @@ -0,0 +1,67 @@ | ||
| 1 | /** The API runs list names its Server-Timing phases (#4893). */ | |
| 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-runs-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 runs list names session, runs, render in order", async () => { | |
| 57 | const got = await phases("/api/v1/repos/alice/r/runs"); | |
| 58 | expect(got.status).toBe(200); | |
| 59 | expect(got.names).toEqual(["session", "runs", "render"]); | |
| 60 | expect(Array.isArray(JSON.parse(got.body).items)).toBe(true); | |
| 61 | }); | |
| 62 | ||
| 63 | test("a missing repository is a 404 naming session", async () => { | |
| 64 | const got = await phases("/api/v1/repos/alice/nope/runs"); | |
| 65 | expect(got.status).toBe(404); | |
| 66 | expect(got.names).toEqual(["session"]); | |
| 67 | }); |
new above
offline