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

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

Merged opened this

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

Merged

scout/forge:scout/3276-the-people-page-s-server-timing-names-it → main 2 commits fork

  • Merged. scout/3276-the-people-page-s-server-timing-names-it was merged into main as 8194a47.

Review

Sign in to review this change.
2 files changed +106 −3
src/web/pages/people.ts +9 −3
@@ -9,6 +9,7 @@ import { setRole } from "../../actions/roles.ts";
99 import { GRANT_MAX_USD } from "../../core/model_grant.ts";
1010 import { listPeople, type Person } from "../../core/roles.ts";
1111 import { getUserByName, type User } from "../../core/users.ts";
12 import { notePhase, takeSessionTime, timePhase } from "../../core/route_timing.ts";
1213 import type { Ctx } from "../../http/context.ts";
1314 import { notFoundPage, settingsLayout, signInFirst } from "../chrome.ts";
1415 import { field, readForm } from "../form.ts";
@@ -21,7 +22,9 @@ import { accountSections } from "./origins.ts";
2122 export function peoplePage(ctx: Ctx): Response {
2223 if (!ctx.auth.user) return signInFirst(ctx);
2324 if (!ctx.auth.user.isAdmin) return notFoundPage(ctx);
24 const rows = listPeople(ctx.app.db);
25 notePhase(ctx.request, "session", takeSessionTime(ctx.request));
26 const rows = timePhase(ctx.request, "people", () => listPeople(ctx.app.db));
27 const rendering = performance.now();
2528 const line = (p: Person) => {
2629 const role = p.role;
2730 const at = `/settings/people/${encodeURIComponent(p.username)}/role`;
@@ -46,7 +49,7 @@ export function peoplePage(ctx: Ctx): Response {
4649 <td>${act}</td>
4750 </tr>`;
4851 };
49 return page({
52 const response = page({
5053 ctx,
5154 title: "People",
5255 body: html`<div class="page-head"><h1>People</h1></div>
@@ -69,12 +72,15 @@ export function peoplePage(ctx: Ctx): Response {
6972 "Account settings",
7073 )}`,
7174 });
75 notePhase(ctx.request, "render", performance.now() - rendering);
76 return response;
7277 }
7378
7479 // POST /settings/people/:username/role
7580 export async function roleAct(ctx: Ctx): Promise<Response> {
7681 if (!ctx.auth.user) return signInFirst(ctx);
7782 if (!ctx.auth.user.isAdmin) return notFoundPage(ctx);
83 notePhase(ctx.request, "session", takeSessionTime(ctx.request));
7884 const form = await readForm(ctx, "admin");
7985 if (form instanceof Response) return form;
8086 const username = ctx.params.username ?? "";
@@ -82,7 +88,7 @@ export async function roleAct(ctx: Ctx): Promise<Response> {
8288 if (role !== "member" && role !== "guest") return notFoundPage(ctx);
8389 const raw = field(form, "usd").trim().replace(/^\$/, "");
8490 const usd = raw === "" || Number(raw) === 0 ? null : /^\d{1,6}(\.\d{1,2})?$/.test(raw) ? Number(raw) : NaN;
85 const done = setRole(ctx.app, ctx.auth.user as User, username, role, usd);
91 const done = timePhase(ctx.request, "role", () => setRole(ctx.app, ctx.auth.user as User, username, role, usd));
8692 const back = "/settings/people";
8793 if (!done.ok) {
8894 if (done.error === "not_found" || getUserByName(ctx.app.db, username) === undefined) return notFoundPage(ctx);
test/people-timing.test.ts added +97
@@ -0,0 +1,97 @@
1 /** `/settings/people` names session, people and render (and role on the POST) in Server-Timing (#3276). */
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 { createApp, type App } from "../src/app.ts";
7 import { createUser } from "../src/core/users.ts";
8 import { serve, type Servers } from "../src/http/server.ts";
9 import { proveAll } from "./helpers/verified.ts";
10 import { quietLogs } from "./helpers/globals.ts";
11
12 quietLogs();
13
14 let root = "";
15 let app: App;
16 let servers: Servers;
17
18 beforeAll(async () => {
19 root = mkdtempSync(join(tmpdir(), "forge-people-timing-"));
20 app = createApp({ dataDir: root, port: 0, forgeRepo: "alice/forge" });
21 const u = await createUser(app.db, {
22 origin: "seed",
23 trusted: true,
24 username: "alice",
25 email: "[email protected]",
26 password: "a-good-passphrase",
27 adminIfFirst: true,
28 });
29 if (!u.ok) throw new Error(u.error);
30 proveAll(app);
31 servers = await serve(app);
32 });
33 afterAll(() => {
34 servers.stop();
35 app.close();
36 rmSync(root, { recursive: true, force: true });
37 });
38
39 async function signIn(username: string): Promise<string> {
40 const signin = await fetch(`${servers.url}/signin`, {
41 method: "POST",
42 headers: { origin: servers.url },
43 body: new URLSearchParams({ username, password: "a-good-passphrase" }),
44 redirect: "manual",
45 });
46 return (signin.headers.get("set-cookie") ?? "").split(";")[0]!;
47 }
48
49 const phase = (res: Response, name: string) =>
50 (res.headers.get("server-timing") ?? "").split(", ").find((p) => p.startsWith(`${name};`));
51
52 test("GET /settings/people names its phases", async () => {
53 const cookie = await signIn("alice");
54 const res = await fetch(`${servers.url}/settings/people`, { headers: { cookie } });
55 const body = await res.text();
56 expect(res.status).toBe(200);
57 expect(body).toContain("<h1>People</h1>");
58 const parts = (res.headers.get("server-timing") ?? "").split(", ");
59 for (const name of ["app", "session", "people", "render"])
60 expect(parts.find((p) => p.startsWith(`${name};`))).toMatch(/^[a-z]+;dur=\d+\.\d$/);
61 });
62
63 test("a non-admin gets the 404 without the admin phases", async () => {
64 const b = await createUser(app.db, {
65 origin: "seed",
66 trusted: true,
67 username: "bob",
68 email: "[email protected]",
69 password: "a-good-passphrase",
70 });
71 if (!b.ok) throw new Error(b.error);
72 proveAll(app);
73 const cookie = await signIn("bob");
74 const get = await fetch(`${servers.url}/settings/people`, { headers: { cookie } });
75 expect(get.status).toBe(404);
76 for (const name of ["people", "render", "role"]) expect(phase(get, name)).toBeUndefined();
77 const post = await fetch(`${servers.url}/settings/people/alice/role`, {
78 method: "POST",
79 headers: { cookie, origin: servers.url },
80 body: new URLSearchParams({ role: "guest" }),
81 redirect: "manual",
82 });
83 expect(post.status).toBe(404);
84 for (const name of ["session", "role"]) expect(phase(post, name)).toBeUndefined();
85 });
86
87 test("POST /settings/people/:username/role names session and role", async () => {
88 const cookie = await signIn("alice");
89 const res = await fetch(`${servers.url}/settings/people/bob/role`, {
90 method: "POST",
91 headers: { cookie, origin: servers.url },
92 body: new URLSearchParams({ role: "member" }),
93 redirect: "manual",
94 });
95 expect(res.status).toBe(303);
96 for (const name of ["session", "role"]) expect(phase(res, name)).toMatch(/^[a-z]+;dur=\d+\.\d$/);
97 });

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs