Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/workflows/try-page.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
- "studio/**"
- "v2/**"
pull_request:
# Forge (studio/) is not read by the try page, the frame, the identity page or the try codespace: a pull
# Forge (studio/) is not read by the try page, the frame, Prism ids or the try codespace: a pull
# request that changes only Forge or the v2/ prototypes does not wait for them.
paths-ignore:
- "studio/**"
Expand Down Expand Up @@ -64,12 +64,10 @@ jobs:
fi
- name: Verify, answer add 20 22 and replay 22/22
run: npm run test:try
- name: Prism accounts - every signature check refuses, and the passkey flow signs in
- name: Prism ids - the pinned stitch copy matches its lock, every session check refuses, and two apps share one id
run: npm run test:identity
- name: Build the canonical frame every Prism app loads
run: node frame/publish.mjs "$RUNNER_TEMP/frame" "$GITHUB_SHA"
- name: Build the sign-in page for id.uor.foundation, pinned by hash
run: node identity/publish.mjs "$RUNNER_TEMP/identity" "$GITHUB_SHA"

deploy:
name: publish the try page and the canonical frame
Expand Down
1 change: 1 addition & 0 deletions bootstrap/frame-sync.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ const FRAME = [
"bootstrap/precache.mjs",
"bootstrap/register.mjs",
"bootstrap/screens.mjs",
"bootstrap/weight.mjs",
"bootstrap/worker-runtime.mjs",
"lighthouserc.json",
"site/app.mjs",
Expand Down
34 changes: 16 additions & 18 deletions bootstrap/page.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,6 @@ const prismRegistry = new URL(`https://${DEFAULT_REGISTRY}/`);
// a frame change reaches this app without rebuilding it. app.json may name
// another frame host, for a test or a mirror.
const frameHost = new URL(meta.frame ?? "https://uor-foundation.github.io/template/frame/");
// Prism accounts: the sign-in page the frame's account panel shows. The
// page's policy frames that one origin and no other. app.json may name
// another, for a test.
const accounts = new URL(meta.accounts ?? "https://id.uor.foundation/");
const shareUrl = live.href;

// The one speculation rule: the frame marks the pages a visitor is about to
Expand All @@ -121,23 +117,26 @@ const speculationRules = JSON.stringify({
// with the page's, so the frame does not wait for a TLS handshake.
const frameConnect = frameHost.origin !== live.origin ? `<link rel="preconnect" href="${escape(frameHost.origin)}" crossorigin />` : "";

// The frame's Unsplash worker, which this page's connect-src must name for
// the theme panel's search: read from the live frame at build, after its
// SHA-256 is checked as the browser checks it. The frame itself is not
// written into the page: the page's own stand-in (prism-page.css) shows,
// drawn as the bar, until the module arrives, which keeps the first load
// inside the Lighthouse budget.
async function frameUnsplash() {
// The origins this page's connect-src must name for the frame: its Unsplash
// worker, for the theme panel's search, and stitch's relay (with its
// WebSocket origin), where a visitor's Prism id devices meet. Both are read
// from the live frame at build, after its SHA-256 is checked as the browser
// checks it. The frame itself is not written into the page: the page's own
// stand-in (prism-page.css) shows, drawn as the bar, until the module
// arrives, which keeps the first load inside the Lighthouse budget.
async function frameAllowed() {
try {
const pointer = await (await fetch(new URL("current.json", frameHost), { cache: "no-store" })).json();
if (!/^[0-9a-f]{64}$/.test(pointer.sha256 ?? "")) throw new Error("the frame pointer names no sha256");
const bytes = Buffer.from(await (await fetch(new URL(pointer.module, frameHost))).arrayBuffer());
if (hex(bytes) !== pointer.sha256) throw new Error(`the frame is ${hex(bytes)}, its pointer says ${pointer.sha256}`);
const frame = await import(`data:text/javascript;base64,${bytes.toString("base64")}`);
return /^https:\/\/[a-z0-9.-]+$/.test(frame.UNSPLASH_ORIGIN ?? "") ? frame.UNSPLASH_ORIGIN : "";
const origin = (value) => (/^https:\/\/[a-z0-9.-]+$/.test(value ?? "") ? value : "");
const relay = origin(/^https:\/\/[a-z0-9.-]+/.exec(frame.PRISM_RELAY ?? "")?.[0]);
return { unsplash: origin(frame.UNSPLASH_ORIGIN), relay: relay ? `${relay} ${relay.replace(/^https:/, "wss:")}` : "" };
} catch (error) {
console.warn(`page: the frame could not be read at build (${error.message}); no Unsplash origin in connect-src`);
return "";
console.warn(`page: the frame could not be read at build (${error.message}); no Unsplash or relay origin in connect-src`);
return { unsplash: "", relay: "" };
}
}
// The repository's GitHub stars at build, so the bar shows them from its
Expand Down Expand Up @@ -166,7 +165,7 @@ async function githubStars() {
}
}
const stars = await githubStars();
const unsplashOrigin = await frameUnsplash();
const frameOrigins = await frameAllowed();

// ---------------------------------------------------------------------------
// The workspace and the spec, rendered here so the page says everything
Expand Down Expand Up @@ -432,9 +431,8 @@ const fill = {
HOLO_SEARCH_ORIGIN: holoSearch.origin,
REGISTRY_ORIGIN: prismRegistry.origin,
FRAME_ORIGIN: frameHost.origin,
ACCOUNTS: escape(accounts.href),
ACCOUNTS_ORIGIN: accounts.origin,
UNSPLASH_ORIGIN: unsplashOrigin,
UNSPLASH_ORIGIN: frameOrigins.unsplash,
PRISM_RELAY_ORIGINS: frameOrigins.relay,
OG_IMAGE: escape(new URL("og.png", live).href),
OG_ALT: escape(`${meta.name}: ${meta.purpose}`),
NAME: escape(meta.name),
Expand Down
150 changes: 150 additions & 0 deletions bootstrap/weight.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
#!/usr/bin/env node
// The weight gate (FR-03). Opens the assembled site as a first visitor on a
// phone, with no service worker, waits until the page has started (the
// canonical frame is running and the shield has replayed every example),
// then until the network is quiet, and counts every byte that came over the
// wire, the page's workers included. Measured at that state, the count is the
// same on every run: Lighthouse's resource summary was not, because the
// frame, the worker runtime and the holo wait for first paint and land in its
// trace only some of the time (72 KB one run, 152 KB the next, same build).
//
// The bytes are split two ways, each with its own budget:
// frame: what every Prism app carries and only the template changes (the
// canonical frame from its host, the fonts, the worker runtime and
// the frame-locked page modules);
// app: everything else, from the page itself to the holo and the app's
// own modules.
// A template change that grows the frame fails the template; an app that
// grows fails the app; neither can push the other over.
// node bootstrap/weight.mjs site
// Needs playwright with Chromium: npm install -g playwright && playwright install chromium
import { createServer } from "node:http";
import { readFile, stat } from "node:fs/promises";
import { extname, join, normalize } from "node:path";
import { execSync } from "node:child_process";
import { gzipSync } from "node:zlib";
import { pathToFileURL } from "node:url";

export const BUDGET = {
frame: 100 * 1024,
app: 120 * 1024,
requests: 28,
};

// Site paths the template owns: what frame.lock pins under site/, the fonts,
// and the worker runtime bootstrap/worker-runtime.mjs writes.
export function frameOwned(lock) {
const files = new Set(lock.files.map((f) => f.path).filter((p) => p.startsWith("site/")).map((p) => p.slice("site/".length)));
return (path) => files.has(path) || path.startsWith("fonts/") || path.startsWith("worker-runtime/");
}

// requests: [{ url, bytes }] for one visit; site: the page's URL; owned: from
// frameOwned; frameHost: the frame's URL from app.json.
export function weigh(requests, { site, owned, frameHost }) {
const sum = { frame: 0, app: 0, requests: 0, lines: [] };
const base = new URL(site);
const host = new URL(frameHost);
for (const { url, bytes } of requests) {
const u = new URL(url);
if (u.protocol === "blob:" || u.protocol === "data:") continue;
let part = "app";
if (u.origin === host.origin && u.pathname.startsWith(host.pathname)) part = "frame";
else if (u.origin === base.origin && u.pathname.startsWith(base.pathname) && owned(u.pathname.slice(base.pathname.length))) part = "frame";
sum[part] += bytes;
sum.requests += 1;
sum.lines.push({ part, bytes, url });
}
return sum;
}

export function judge(sum, budget = BUDGET) {
const failures = [];
if (sum.frame > budget.frame) failures.push(`the frame's bytes are ${sum.frame}, over its budget of ${budget.frame}`);
if (sum.app > budget.app) failures.push(`the app's bytes are ${sum.app}, over its budget of ${budget.app}`);
if (sum.requests > budget.requests) failures.push(`${sum.requests} requests, over the budget of ${budget.requests}`);
return failures;
}

// The page has started: the canonical frame is running and the shield has
// replayed every example (or named why it could not).
export function started() {
const frame = document.getElementById("frame");
return Boolean(customElements.get("prism-frame"))
&& /^(\d+\/\d+|error)$/.test(frame?.getAttribute("examples") ?? "");
}

// GitHub Pages compresses text and leaves woff2, png and the like as they are.
const types = { ".html": "text/html", ".css": "text/css", ".mjs": "text/javascript", ".js": "text/javascript", ".json": "application/json", ".webmanifest": "application/manifest+json", ".svg": "image/svg+xml", ".woff2": "font/woff2", ".png": "image/png", ".holo": "application/octet-stream", ".wasm": "application/wasm" };
const compressed = new Set([".html", ".css", ".mjs", ".js", ".json", ".webmanifest", ".svg", ".holo", ".wasm"]);

async function main() {
const site = process.argv[2] ?? "site";
const playwright = await import("playwright").catch(() =>
import(pathToFileURL(join(execSync("npm root -g").toString().trim(), "playwright", "index.mjs")).href));
const { chromium } = playwright;
const owned = frameOwned(JSON.parse(await readFile("frame.lock", "utf8")));
const app = JSON.parse(await readFile(join(site, "app.json"), "utf8"));
const frameHost = app.frame ?? "https://uor-foundation.github.io/template/frame/";

const server = createServer(async (request, response) => {
let path = decodeURIComponent(new URL(request.url, "http://x").pathname);
if (path.endsWith("/")) path += "index.html";
const file = normalize(join(site, path));
try {
await stat(file);
let body = await readFile(file);
const headers = { "content-type": types[extname(file)] ?? "application/octet-stream" };
if (compressed.has(extname(file)) && /\bgzip\b/.test(request.headers["accept-encoding"] ?? "")) {
body = gzipSync(body, { level: 9 });
headers["content-encoding"] = "gzip";
}
response.writeHead(200, headers);
response.end(body);
} catch {
response.writeHead(404);
response.end();
}
});
await new Promise((resolve) => server.listen(0, "127.0.0.1", resolve));
const origin = `http://127.0.0.1:${server.address().port}/`;

const browser = await chromium.launch();
const runs = [];
try {
for (let run = 0; run < 2; run++) {
const context = await browser.newContext({ viewport: { width: 412, height: 823 }, isMobile: true, hasTouch: true, serviceWorkers: "block" });
const page = await context.newPage();
const requests = [];
const pending = [];
page.on("requestfinished", (request) => pending.push(request.sizes().then((s) => {
requests.push({ url: request.url(), bytes: s.responseBodySize + s.responseHeadersSize });
}, () => {})));
await page.goto(origin, { waitUntil: "load" });
try {
await page.waitForFunction(started, null, { timeout: 30000 });
} catch {
throw new Error(`the page never started: frame ${await page.evaluate(() => Boolean(customElements.get("prism-frame")))}, examples "${await page.locator("#frame").getAttribute("examples")}"`);
}
await page.waitForLoadState("networkidle");
await Promise.all(pending);
runs.push(weigh(requests, { site: origin, owned, frameHost }));
await context.close();
}
} finally {
await browser.close();
server.close();
}

const [sum] = runs;
for (const line of sum.lines.sort((a, b) => b.bytes - a.bytes)) console.log(`${line.part.padEnd(5)} ${String(line.bytes).padStart(7)} ${line.url.replace(origin, "./")}`);
for (const r of runs) console.log(`weight: frame ${r.frame} of ${BUDGET.frame}, app ${r.app} of ${BUDGET.app}, ${r.requests} of ${BUDGET.requests} requests`);
const failures = runs.flatMap((r) => judge(r));
// Both runs see the same requests, or the measure is not the page's.
if (runs[0].requests !== runs[1].requests) failures.push(`the runs saw ${runs[0].requests} and ${runs[1].requests} requests: the page had not settled`);
if (failures.length) {
for (const f of new Set(failures)) console.error(`FR-03: ${f}`);
process.exit(1);
}
}

if (import.meta.url === pathToFileURL(process.argv[1] ?? "").href) await main();
18 changes: 11 additions & 7 deletions frame.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"spec": "prism/frame-lock/1",
"source": {
"repository": "UOR-Foundation/template",
"commit": "0b7c323035b2bbb3729f4afad75820cac228cb09",
"raw": "https://raw.githubusercontent.com/UOR-Foundation/template/0b7c323035b2bbb3729f4afad75820cac228cb09/"
"commit": "892f3ad6ad2b28b0f14e65a966c63b8722f9ef2b",
"raw": "https://raw.githubusercontent.com/UOR-Foundation/template/892f3ad6ad2b28b0f14e65a966c63b8722f9ef2b/"
},
"files": [
{
"path": "bootstrap/frame-sync.mjs",
"sha256": "c82b0a057aeccd601ec817ea71d7211b10083d884a1267f8bdf310f11199062b"
"sha256": "5d874908a8f5813b6f7c1004ec0e73ec03584139bf7ac8ffabb2ad5c0eeee7af"
},
{
"path": "bootstrap/icons.py",
Expand All @@ -20,7 +20,7 @@
},
{
"path": "bootstrap/page.mjs",
"sha256": "2df4ef057d37e778b04f67e4f63d862c7da6a77c301d0862b2bb8681fc8ec9d4"
"sha256": "8eee238bce9206ca58fc9be5471c28c0bdab82e2350ed78f1972da2a1da6581f"
},
{
"path": "bootstrap/precache.mjs",
Expand All @@ -34,13 +34,17 @@
"path": "bootstrap/screens.mjs",
"sha256": "c9787ebf5ad8e8b649034ec3e43f8812ba51777ba59eb11f1f51ca084a395b67"
},
{
"path": "bootstrap/weight.mjs",
"sha256": "de432422e9931b4adf0f422a2030d7b38097a60a4d8fc9ed62fd20fe0c468373"
},
{
"path": "bootstrap/worker-runtime.mjs",
"sha256": "0f9fbb6ec4db48fb7f7c4b779a0494e95d5411e868b36e1e163e5173fcc34557"
},
{
"path": "lighthouserc.json",
"sha256": "0145d04da93193801b0d8736ceba7e0df94b9b15f183b07a16e6feda16d72082"
"sha256": "85aa0f6219cb8396b34f5b461c1d4d7b149e4cc1674cbd2f0100c5b5e16636d9"
},
{
"path": "site/app.mjs",
Expand All @@ -52,7 +56,7 @@
},
{
"path": "site/page.template.html",
"sha256": "d7df0bc4d5190ca38ee768bdbd54cbc665ede811608de846068c8a92bd02c14d"
"sha256": "b48b9d18e23e959c9e96b4bec58e2e7d80b7b977e981d8a7b0fd369293819b08"
},
{
"path": "site/prism-page.css",
Expand All @@ -68,7 +72,7 @@
},
{
"path": "site/sw.js",
"sha256": "b4d4eb5c8314f5abed013ea9d172e7352dbdfa5aa2b503901df364ebcfbf11f7"
"sha256": "baf0fbd7da2fa0b33124951bbd1218aa6658c342340fb24415c636f220c9ea74"
},
{
"path": "site/theme.js",
Expand Down
4 changes: 2 additions & 2 deletions frame/frame.css
Original file line number Diff line number Diff line change
Expand Up @@ -252,8 +252,8 @@ svg.gh, svg.fill { fill: currentColor; stroke: none; }
#github[hidden] + .sep { display: none; }
/* Full screen: the corners point out to enter, in to leave. */
:host([fullscreen]) #fullscreen .expand, :host(:not([fullscreen])) #fullscreen .shrink { display: none; }
/* The account: a line drawing signed out; while the device is asked for its
* passkey it breathes; signed in, the same figure filled, in the full text
/* The account: a line drawing signed out; while the Prism id window is open
* it breathes; signed in, the same figure filled, in the full text
* colour, so who is signed in reads at a glance and nothing else changes. */
#account.signed-in { color: var(--foreground); }
#account.signed-in svg.person { fill: currentColor; }
Expand Down
Loading
Loading