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

The flags page's Server-Timing names its phases: session, each read, render #3447

Merged opened this

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

Merged

scout/forge:scout/3406-the-flags-page-s-server-timing-names-its → main 1 commit fork 1 thread · 1 unresolved

  • Merged. scout/3406-the-flags-page-s-server-timing-names-its was merged into main as e1e27ec.

Review

Sign in to review this change.
2 files changed +74 −2
src/web/pages/flags.ts +17 −2
@@ -9,6 +9,7 @@
99 import { checkInput, flagRegistry, usesLine, winnerOffer, mayManageFlags, useFlagRegistry, type FlagDecl, type FlagValue } from "../../core/flags.ts";
1010 import { makeWinnerDefault } from "../../actions/flag_winner.ts";
1111 import type { Ctx } from "../../http/context.ts";
12 import { notePhase, takeSessionTime, timePhase } from "../../core/route_timing.ts";
1213 import { settingsLayout, signInFirst } from "../chrome.ts";
1314 import { field, readForm } from "../form.ts";
1415 import { html } from "../html.ts";
@@ -59,16 +60,26 @@ function summary(v: FlagValue | undefined) {
5960
6061 // GET /settings/flags
6162 export function flagsPage(ctx: Ctx): Response {
63 notePhase(ctx.request, "session", takeSessionTime(ctx.request));
6264 const no = denied(ctx);
6365 if (no) return no;
64 const registry = flagRegistry();
66 const registry = timePhase(ctx.request, "registry", flagRegistry);
6567 const repo = ctx.app.config.forgeRepo;
6668 const names = Object.keys(registry.decls);
69 // The per-flag reads are interleaved with building each row: sum each.
70 let valuesMs = 0;
71 let usesMs = 0;
72 const rendering = performance.now();
6773 const rows = names.map((name) => {
6874 const decl = (registry.decls as Record<string, FlagDecl>)[name]!;
75 const t0 = performance.now();
6976 const v = registry.value(name as never);
77 const t1 = performance.now();
7078 const week = registry.uses(ctx.app.db, name, 7);
7179 const month = registry.uses(ctx.app.db, name, 30);
80 const t2 = performance.now();
81 valuesMs += t1 - t0;
82 usesMs += t2 - t1;
7283 const lead = winnerOffer(month, v);
7384 return row({
7485 lead: icon("activity"),
@@ -109,12 +120,16 @@ export function flagsPage(ctx: Ctx): Response {
109120 pad: false,
110121 },
111122 );
112 return page({
123 const response = page({
113124 ctx,
114125 title: "Flags",
115126 body: html`<div class="page-head"><h1>Flags</h1></div>
116127 ${settingsLayout(accountSections("flags", { admin: true }), body, "Account settings")}`,
117128 });
129 notePhase(ctx.request, "values", valuesMs);
130 notePhase(ctx.request, "uses", usesMs);
131 notePhase(ctx.request, "render", Math.max(performance.now() - rendering - valuesMs - usesMs, 0));
132 return response;
118133 }
119134
120135 // POST /settings/flags
test/flags-timing.test.ts added +57
@@ -0,0 +1,57 @@
1 /** `/settings/flags` names session, registry, values, uses and render in Server-Timing (#3406). */

The header cites #3406; this pull is #3447. Point it at the right issue.

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
19 beforeAll(async () => {
20 root = mkdtempSync(join(tmpdir(), "forge-flags-timing-"));
21 app = createApp({ dataDir: root, port: 0, forgeRepo: "alice/forge" });
22 const u = await createUser(app.db, {
23 origin: "seed",
24 trusted: true,
25 username: "alice",
26 email: "[email protected]",
27 password: "a-good-passphrase",
28 adminIfFirst: true,
29 });
30 if (!u.ok) throw new Error(u.error);
31 proveAll(app);
32 const made = await createRepo(app, { id: u.value.id, username: "alice" } as never, { name: "forge" });
33 if (!made.ok) throw new Error(made.error);
34 servers = await serve(app);
35 });
36 afterAll(() => {
37 servers.stop();
38 app.close();
39 rmSync(root, { recursive: true, force: true });
40 });
41
42 test("GET /settings/flags names its phases", async () => {
43 const signin = await fetch(`${servers.url}/signin`, {
44 method: "POST",
45 headers: { origin: servers.url },
46 body: new URLSearchParams({ username: "alice", password: "a-good-passphrase" }),
47 redirect: "manual",
48 });
49 const cookie = (signin.headers.get("set-cookie") ?? "").split(";")[0]!;
50 const res = await fetch(`${servers.url}/settings/flags`, { headers: { cookie } });
51 const body = await res.text();
52 expect(res.status).toBe(200);
53 expect(body).toContain("<h1>Flags</h1>");
54 const parts = (res.headers.get("server-timing") ?? "").split(", ");
55 for (const name of ["app", "session", "registry", "values", "uses", "render"])
56 expect(parts.find((p) => p.startsWith(`${name};`))).toMatch(/^[a-z]+;dur=\d+\.\d$/);
57 });

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs