Public: anyone can read this; the crew can change it.
The API's issue dependencies read names its Server-Timing phases: session, dependencies, render #4952
Check · Review · Land · Live done — Landed and live in production.
scout/forge:scout/4924-the-api-s-issue-dependencies-read-names → main 1 commit fork
2 files
changed +74
−5
src/http/api.ts +10 −5
| @@ -3326,9 +3326,12 @@ export function apiRoutes(router: Router<Handler>): void { | ||
| 3326 | 3326 | "GET", |
| 3327 | 3327 | "/api/v1/repos/:owner/:name/issues/:number/dependencies", |
| 3328 | 3328 | (ctx) => { |
| 3329 | notePhase(ctx.request, "session", takeSessionTime(ctx.request)); | |
| 3329 | 3330 | const found = loadIssue(ctx); |
| 3330 | 3331 | if ("error" in found) return found.error; |
| 3331 | const deps = dependenciesOf(ctx.app.db, found.issue.id); | |
| 3332 | const deps = timePhase(ctx.request, "dependencies", () => | |
| 3333 | dependenciesOf(ctx.app.db, found.issue.id), | |
| 3334 | ); | |
| 3332 | 3335 | const seen = (i: Issue) => |
| 3333 | 3336 | mayView(ctx.app.db, found.repo, i, ctx.auth.user); |
| 3334 | 3337 | const brief = (i: Issue) => ({ |
| @@ -3337,10 +3340,12 @@ export function apiRoutes(router: Router<Handler>): void { | ||
| 3337 | 3340 | state: i.state, |
| 3338 | 3341 | ...(i.closeReason === null ? {} : { closeReason: i.closeReason }), |
| 3339 | 3342 | }); |
| 3340 | return json({ | |
| 3341 | blockedBy: deps.blockedBy.filter(seen).map(brief), | |
| 3342 | blocks: deps.blocks.filter(seen).map(brief), | |
| 3343 | }); | |
| 3343 | return timePhase(ctx.request, "render", () => | |
| 3344 | json({ | |
| 3345 | blockedBy: deps.blockedBy.filter(seen).map(brief), | |
| 3346 | blocks: deps.blocks.filter(seen).map(brief), | |
| 3347 | }), | |
| 3348 | ); | |
| 3344 | 3349 | }, |
| 3345 | 3350 | ); |
| 3346 | 3351 | router.add( |
test/api-deps-timing.test.ts added +64
| @@ -0,0 +1,64 @@ | ||
| 1 | /** The API issue dependencies read names its Server-Timing phases (#4924). */ | |
| 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 { createIssue } from "../src/core/issues.ts"; | |
| 9 | import { createSession } from "../src/core/sessions.ts"; | |
| 10 | import { createUser } from "../src/core/users.ts"; | |
| 11 | import { serve, type Servers } from "../src/http/server.ts"; | |
| 12 | import { quietLogs } from "./helpers/globals.ts"; | |
| 13 | ||
| 14 | quietLogs(); | |
| 15 | ||
| 16 | let dataDir: string; | |
| 17 | let app: App; | |
| 18 | let servers: Servers; | |
| 19 | let cookie = ""; | |
| 20 | ||
| 21 | const cells = process.env["FORGE_CELLS"]; | |
| 22 | ||
| 23 | beforeAll(async () => { | |
| 24 | process.env["FORGE_CELLS"] = "off"; | |
| 25 | dataDir = await mkdtemp(join(tmpdir(), "forge-api-deps-timing-")); | |
| 26 | app = createApp({ dataDir, port: 0 }); | |
| 27 | servers = await serve(app); | |
| 28 | const made = await createUser(app.db, { | |
| 29 | origin: "seed", | |
| 30 | trusted: true, | |
| 31 | username: "alice", | |
| 32 | email: "[email protected]", | |
| 33 | password: "a-good-passphrase", | |
| 34 | adminIfFirst: true, | |
| 35 | }); | |
| 36 | if (!made.ok) throw new Error(String(made.error)); | |
| 37 | const alice = made.value; | |
| 38 | cookie = `forge_session=${createSession(app.db, alice.id).token}`; | |
| 39 | const repo = await createRepo(app, alice, { name: "r", visibility: "public" }); | |
| 40 | if (!repo.ok) throw new Error(String(repo.error)); | |
| 41 | const made1 = createIssue(app.db, { repoId: repo.value.id, authorId: alice.id, title: "one" }); | |
| 42 | if (!made1.ok) throw new Error(String(made1.error)); | |
| 43 | }); | |
| 44 | afterAll(async () => { | |
| 45 | await servers.stop(); | |
| 46 | app.close(); | |
| 47 | if (cells === undefined) delete process.env["FORGE_CELLS"]; | |
| 48 | else process.env["FORGE_CELLS"] = cells; | |
| 49 | await rm(dataDir, { recursive: true, force: true }); | |
| 50 | }); | |
| 51 | ||
| 52 | async function phases(path: string): Promise<{ status: number; names: string[]; body: string }> { | |
| 53 | const res = await fetch(`${servers.url}${path}`, { headers: { cookie } }); | |
| 54 | const body = await res.text(); | |
| 55 | const names = (res.headers.get("server-timing") ?? "").split(", ").map((p) => p.split(";")[0]!); | |
| 56 | return { status: res.status, names: names.slice(names.indexOf("app") + 1), body }; | |
| 57 | } | |
| 58 | ||
| 59 | test("the dependencies read names session, dependencies, render in order", async () => { | |
| 60 | const got = await phases("/api/v1/repos/alice/r/issues/1/dependencies"); | |
| 61 | expect(got.status).toBe(200); | |
| 62 | expect(got.names).toEqual(["session", "dependencies", "render"]); | |
| 63 | expect(JSON.parse(got.body)).toEqual({ blockedBy: [], blocks: [] }); | |
| 64 | }); |
new above
offline