Public: anyone can read this; the crew can change it.

The API's prompt sources read names its Server-Timing phases: session, prompts, render #4935

Merged opened this

Check · Review · Land · Live done — Landed and live in production.

Merged

scout/forge:scout/4906-the-api-s-prompt-sources-read-names-its → main 1 commit fork

  • Merged. scout/4906-the-api-s-prompt-sources-read-names-its was merged into main as 7785a84.

Review

Sign in to review this change.
2 files changed +64 −2
src/http/api.ts +3 −2
@@ -5597,13 +5597,14 @@ export function apiRoutes(router: Router<Handler>): void {
55975597 // (docs/APPS.md, "Prompts from Instagram"). Admin scope and admin over
55985598 // the repository; the token goes in once and never comes back out.
55995599 router.add("GET", "/api/v1/repos/:owner/:name/prompts", (ctx) => {
5600 notePhase(ctx.request, "session", takeSessionTime(ctx.request));
56005601 const denied = requireScope(ctx, "admin");
56015602 if (denied) return denied;
56025603 const repo = loadRepo(ctx);
56035604 if (!repo) return notFound();
5604 const listed = listPromptSources(ctx.app, ctx.auth.user, repo);
5605 const listed = timePhase(ctx.request, "prompts", () => listPromptSources(ctx.app, ctx.auth.user, repo));
56055606 if (!listed.ok) return respondAccess(listed.error, 422);
5606 return json({ items: listed.value, next_cursor: null });
5607 return timePhase(ctx.request, "render", () => json({ items: listed.value, next_cursor: null }));
56075608 });
56085609
56095610 router.add("POST", "/api/v1/repos/:owner/:name/prompts", async (ctx) => {
test/api-prompts-timing.test.ts added +61
@@ -0,0 +1,61 @@
1 /** The API prompt sources read names its Server-Timing phases (#4906). */
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-prompts-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 prompt sources read names session, prompts, render in order", async () => {
57 const got = await phases("/api/v1/repos/alice/r/prompts");
58 expect(got.status).toBe(200);
59 expect(got.names).toEqual(["session", "prompts", "render"]);
60 expect(JSON.parse(got.body).items).toEqual([]);
61 });

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs