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

A pin's screenshots get a gallery page on the builds page #9269

Parked opened this
Closed without merging

mason/forge:mason/9218-a-pin-s-screenshots-get-a-gallery-page-o → main 3 commits fork

  • Closed without merging. Nothing was applied to main.

Review

Sign in to review this change.
5 files changed +69 −5
docs/features/pin-screenshots.md +3 −1
@@ -15,4 +15,6 @@ A build pin can keep curated screenshots: PNG, JPEG or WebP pictures, in order,
1515 - **Forks.** A fork starts with its parent's pins, covers and screenshots as they are at the fork (`refs/builds`, `refs/covers`, `refs/shots`). Pins and screenshots added upstream later are not synced. A fork whose pin refs cannot be copied is not made, and leaves nothing behind.
1616 - **Live.** Every change emits `build.shots` (`added`, `picked`, `moved`, `captioned`, `removed`), read by the repository's readers.
1717
18 Left out: a gallery page, the demo/arcade side of Jay Moran's port, activity wording for `build.shots`.
18 - **Gallery.** `GET /:owner/:name/builds/:label/shots` shows the pictures with their captions, linked from each pin on the Builds page, and re-reads itself on `build.shots`.
19
20 Left out: the demo/arcade side of Jay Moran's port, activity wording for `build.shots`.
src/http/server.ts +2 −1
@@ -185,7 +185,7 @@ import {
185185 } from "../web/pages/branches.ts";
186186 import { iterationsPage, noteSubmit } from "../web/pages/iterations.ts";
187187 import { buildsPage, deletePinSubmit, newBuildPage, pinBuildSubmit, previewBuildSubmit } from "../web/pages/builds.ts";
188 import { shotImage } from "../web/pages/build_shots.ts";
188 import { shotImage, shotsPage } from "../web/pages/build_shots.ts";
189189 import { cartArt, cartPage } from "../web/pages/build_cart.ts";
190190 import { wavePage, wavesAtom, wavesPage } from "../web/pages/waves.ts";
191191 import {
@@ -1263,6 +1263,7 @@ export function buildRouter(): Router<Handler> {
12631263 router.add("GET", "/:owner/:name/builds", buildsPage);
12641264 router.add("GET", "/:owner/:name/builds/new", newBuildPage);
12651265 // A pin's screenshot, read: a tree kept by refs/shots/<label> (`git/shots.ts`).
1266 router.add("GET", "/:owner/:name/builds/:label/shots", shotsPage);
12661267 router.add("GET", "/:owner/:name/builds/:label/shots/:file", shotImage);
12671268 // A pin's cart: its captured page, played sandboxed, and its picture (`arcade/carts.ts`).
12681269 router.add("GET", "/:owner/:name/builds/:label/cart", cartPage);
src/web/pages/build_shots.ts +45 −3
@@ -1,14 +1,56 @@
11 /**
22 * A pin's screenshots, read: one picture by name, to whoever reads the
33 * repository (`git/shots.ts`). They are written through the API and the
4 * terminal (`actions/build_shots.ts`); there is no gallery page yet.
4 * terminal (`actions/build_shots.ts`); the gallery page below shows them,
5 * following `build.shots` live.
56 */
67
7 import { readShotBytes } from "../../git/shots.ts";
8 import { readBuildPin } from "../../git/builds.ts";
9 import { readShotBytes, readShots } from "../../git/shots.ts";
810 import { repoDir } from "../../git/repos.ts";
911 import { notePhase, takeSessionTime, timePhase } from "../../core/route_timing.ts";
1012 import type { Ctx } from "../../http/context.ts";
11 import { loadRepo, notFoundPage } from "../chrome.ts";
13 import { crumbsFor, loadRepo, notFoundPage, repoBase, repoHeader, repoPalette } from "../chrome.ts";
14 import { html, type Html } from "../html.ts";
15 import { page } from "../layout.ts";
16 import { card } from "../ui.ts";
17
18 export const SHOTS_LIVE = "build.shots,build.pinned";
19
20 export const GALLERY_CSS = `
21 .shots-grid{display:grid;grid-template-columns:repeat(auto-fill,minmax(240px,1fr));gap:var(--s-3,12px);margin:0;padding:0;list-style:none}
22 .shots-grid figure{margin:0}
23 .shots-grid img{display:block;width:100%;height:auto;aspect-ratio:4/3;object-fit:contain;background:var(--bg-2,#0001);border-radius:6px}
24 .shots-grid figcaption{margin-top:4px;overflow-wrap:anywhere}
25 `;
26
27 // GET /:owner/:name/builds/:label/shots — the gallery: server-rendered, re-fetched on build.shots.
28 export async function shotsPage(ctx: Ctx): Promise<Response> {
29 notePhase(ctx.request, "session", takeSessionTime(ctx.request));
30 const repo = loadRepo(ctx);
31 if (!repo) return notFoundPage(ctx);
32 const label = ctx.params.label ?? "";
33 const dir = repoDir(ctx.app.reposRoot, repo.ownerName, repo.name);
34 if ((await timePhase(ctx.request, "read", () => readBuildPin(dir, label))) === undefined) return notFoundPage(ctx);
35 const shots = await readShots(dir, label);
36 const base = repoBase(repo);
37 const at = `${base}/builds/${encodeURIComponent(label)}/shots`;
38 const grid: Html =
39 shots.items.length === 0
40 ? html`<p class="muted small">No screenshots on ${label} yet.</p>`
41 : html`<ul class="shots-grid">${shots.items.map(
42 (s) => html`<li><figure>
43 <a href="${at}/${s.file}?v=${s.oid.slice(0, 12)}"><img src="${at}/${s.file}?v=${s.oid.slice(0, 12)}" alt="${s.caption === "" ? `Screenshot ${s.file}` : s.caption}" width="320" height="240" loading="lazy" decoding="async" /></a>
44 ${s.caption === "" ? null : html`<figcaption class="small">${s.caption}</figcaption>`}
45 </figure></li>`,
46 )}</ul>`;
47 const body = html`${repoHeader(ctx, repo, "branches", { compact: true })}
48 <div class="mt"><p class="small"><a href="${base}/builds">← Builds</a></p>
49 <div id="pin-shots" data-live="${SHOTS_LIVE}" data-live-repo="${repo.ownerName}/${repo.name}" aria-live="polite">${card(grid, { head: html`<h2>Screenshots · ${label}</h2>` })}</div></div>`;
50 return timePhase(ctx.request, "render", () =>
51 page({ ctx, title: `Screenshots ${label} · ${repo.name}`, crumbs: crumbsFor(repo), palette: repoPalette(ctx, repo), body, styleCss: GALLERY_CSS }),
52 );
53 }
1254
1355 // GET /:owner/:name/builds/:label/shots/:file — one screenshot. Typed by
1456 // its first bytes, never by its name, and never sniffed into anything else.
src/web/pages/builds.ts +5
@@ -113,6 +113,10 @@ export function buildsCard(
113113 >▶ ${n.pin.demo?.name ?? ""} ${n.pin.demo?.version ?? ""}</a
114114 >`,
115115 )}
116 ${when(
117 n.from === undefined,
118 () => html`<a class="build-shots small" href="${base}/builds/${encodeURIComponent(n.pin.label)}/shots">Screenshots</a>`,
119 )}
116120 ${when(
117121 canPreview && n.from === undefined,
118122 () => html`<form method="post" action="${base}/builds/preview" class="build-preview">
@@ -159,6 +163,7 @@ ${[1, 2, 3, 4, 5, 6, 7, 8].map((d) => `.build-row[data-depth="${d}"]{padding-lef
159163 .build-note{min-width:0;flex:1}
160164 .build-meta{flex:none;margin-left:auto}
161165 .build-preview{flex:none;margin:0}
166 .build-shots{flex:none}
162167 .builds-none{padding:10px 14px;margin:0}
163168 @media (max-width:640px){.build-meta{display:none}}
164169 `;
test/build-shots.test.ts +14
@@ -167,6 +167,20 @@ describe("pin screenshots", () => {
167167 expect((await get("/alice/karts/builds/v1/shots/..%2Fa.txt")).status).toBe(404);
168168 });
169169
170 test("the gallery page shows the pictures, escapes captions, hides a private pin, and is linked from Builds", async () => {
171 const page = await get("/alice/karts/builds/v1/shots", "bob");
172 expect(page.status).toBe(200);
173 const text = await page.text();
174 expect(text).toContain("/alice/karts/builds/v1/shots/01.png?v=");
175 expect(text).toContain('data-live="build.shots');
176 expect(text).not.toContain("<script>alert");
177 expect((await get("/alice/karts/builds/nope/shots")).status).toBe(404);
178 expect((await get("/alice/secret/builds/v1/shots", "bob")).status).toBe(404);
179 expect((await get("/alice/secret/builds/v1/shots")).status).toBe(404);
180 expect((await get("/alice/secret/builds/v1/shots", "alice")).status).toBe(200);
181 expect(await (await get("/alice/karts/builds", "bob")).text()).toContain("/alice/karts/builds/v1/shots");
182 });
183
170184 test("a picture is one by its first bytes, within 2 MB and 12 a pin", async () => {
171185 const before = (await shots()).tree;
172186 // A page named .png is refused; so is a picture past the limit.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs