Compare commits

..
Author SHA1 Message Date
Brent Vatne 8d238b3785 Merge remote-tracking branch 'origin/main' into devin/1792344317-command-palette 2026-10-18 16:40:55 -07:00
Brent Vatne 39225ea1d0 Merge the branch as rebased onto main; this branch already has those changes and the review fixes 2026-10-18 16:40:55 -07:00
devin-ai-integration[bot]andbrent 95be8b5248 Viewer: calmer Map hover — no screen fading, Open in Inspector as a tooltip (#30)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:40:12 -07:00
devin-ai-integration[bot]andbrent 6fa7cba087 Viewer: switch targets in place, glide [ ] and +/- from the key down, keep screenshots up while they swap (#20)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:38:35 -07:00
devin-ai-integration[bot]andbrent f728eb187b Quiet PR comment: count + report link heading, per-device subtitle, changed screens as a list, previous run kept while a new run works (#19)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:36:23 -07:00
Brent Vatne f276247860 Merge remote-tracking branch 'origin/main' into devin/1792344317-command-palette 2026-10-18 16:34:16 -07:00
Brent Vatne 91c16317dc Merge remote-tracking branch 'origin/main' into devin/1792344317-command-palette
# Conflicts:
#	test/e2e/viewer.spec.ts
#	viewer/src/components/compare/shortcuts-dialog.tsx
2026-10-18 16:34:15 -07:00
devin-ai-integration[bot]andbrent d069a892dc Clip diff regions that cross a system band; Android status-bar band 7 % (#25)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:33:21 -07:00
brentandDevin AI 1da81fb511 Phone type-scale test: the palette now has one section label per kind
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 23:33:19 +00:00
brentandDevin AI 2c8795c896 Test the palette's ranking and its commands per canvas
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 23:33:19 +00:00
brentandDevin AI 558d396644 Viewer: ⌘K is a command palette
The search dialog lists commands alongside screens: go to a canvas, find a screen, hand off, the shortcuts, the changes menu; next/previous changed screen and the selected change in Compare; the inspector, theme, app appearance and full screen; the run's other devices; fit, center and zoom; the PR and repository on GitHub. Each prints the key that also runs it. Word queries rank commands first, route-shaped queries screens first; the empty palette suggests what to do next on this canvas instead of listing the inventory.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 23:33:19 +00:00
devin-ai-integration[bot]andbrent 4499a999d1 Viewer: / finds screens on the Screens page (#21)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:32:31 -07:00
devin-ai-integration[bot]andbrent 929ac82765 A comment or whitespace-only edit to a source file changes no screen (#26)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:31:59 -07:00
devin-ai-integration[bot]andbrent d5d6a5ff72 Inspector says why an excluded or redirect route has no screenshot (#31)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:31:26 -07:00
Brent Vatne 9a63514fc4 Merge remote-tracking branch 'origin/devin/1792343737-screens-find' into devin/1792344317-command-palette
# Conflicts:
#	test/e2e/viewer.spec.ts
2026-10-18 16:30:23 -07:00
Brent Vatne c6998a9c0d Palette: a word that is a screen's last segment opens that screen ahead of the commands 2026-10-18 16:29:59 -07:00
Brent Vatne 913a366ba2 Screens find: a / opens it once, its keys stay in the field, and it leaves the folds and the phone alone
A / from Map or Compare is consumed once Screens opens the field (onFindRequestDone), so Screens opened again later comes up without it. Only the input takes ↓, ↑ and Return: the clear button keeps its own Return, and a Return that confirms an input method's text opens nothing. A fold tried while a find holds every row open is ignored, where it replaced all the stored folds with that one. The phone layout, which has no field, is not narrowed by a query typed on desktop. Inside Changed, a find that only matches other screens says "No changed screens match" and offers All, instead of suggesting Esc shows every screen.
2026-10-18 16:10:12 -07:00
Brent Vatne 0d7cbc0fa5 Palette commands: a target is found by its own platform, Next and Previous stop at the ends, and a query with a slash is after a screen 2026-10-18 16:08:17 -07:00
Brent Vatne 1057fd658f Palette: ↑ and ↓ step through the rows in the order they read, and a command that moves focus keeps it 2026-10-18 16:08:17 -07:00
devin-ai-integration[bot] 5c19061b0f Excluded routes leave the public map instead of showing as "Not compared" (#27) 2026-10-18 14:45:06 -07:00
brentandDevin AI 250a6ee182 Phone type-scale test: the palette now has one section label per kind
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 17:49:53 +00:00
brentandDevin AI cf890cd8e3 Test the palette's ranking and its commands per canvas
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 17:49:53 +00:00
brentandDevin AI f7fa742abd Viewer: ⌘K is a command palette
The search dialog lists commands alongside screens: go to a canvas, find a screen, hand off, the shortcuts, the changes menu; next/previous changed screen and the selected change in Compare; the inspector, theme, app appearance and full screen; the run's other devices; fit, center and zoom; the PR and repository on GitHub. Each prints the key that also runs it. Word queries rank commands first, route-shaped queries screens first; the empty palette suggests what to do next on this canvas instead of listing the inventory.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 17:49:53 +00:00
brentandDevin AI c6005add19 Screens find: the tree head keeps one height, and the field's text sits centered
The head shrank to its buttons when the tree overflowed, so the find field (two pixels taller) pushed the tree down as it opened; it is now a fixed 34px that neither state changes. The field's input fills its row with no search-field appearance, which on macOS sat the text low in the box.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 17:46:20 +00:00
brentandDevin AI 90fff65588 Screens find: ↓ and ↑ step the pick through the matches from the field, Return opens it
The results are the field's, as in a quick-open: the arrows move the pick in page order while the field keeps the keyboard, and Return opens the picked screen in the Inspector (the first match before any step).

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 17:40:15 +00:00
brentandDevin AI 20c99122c1 Viewer: / finds screens on the Screens page
The tree head gains a find field (/ or the magnifier): the query narrows the tree to its matches and the rows above them, and the grid to the same screens, inside Changed or All. Enter picks the first match, Esc clears then closes. On Map and Compare, / opens Screens with the field focused.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 17:23:11 +00:00
Brent Vatne ec75e37e45 Release 0.19.8 2026-10-18 10:00:42 -07:00
Brent Vatne 1254a99841 Viewer preview fixtures: one report per target (#16) 2026-10-18 10:00:26 -07:00
Brent Vatne c2bae00f31 Fix flaky CI: stray SIGTERMs, port-lock race, fixture colour collisions, mid-review downloads, cold-Vite reloads (#17) 2026-10-18 09:56:13 -07:00
Brent Vatne 65b79684f3 Hosted previews serve the report as static files under the token, with no encryption and no Explore expiry (#14) 2026-10-18 09:45:24 -07:00
Brent Vatne b8b43ee2c8 Hosted previews open from a manifest, load screenshots on demand, and switch targets in place (#11) 2026-10-18 09:45:23 -07:00
70 changed files with 2756 additions and 815 deletions

No files matched your search

+7 -2
View File
@@ -76,9 +76,14 @@ jobs:
| [$marker,
"**Viewer preview** of \($sha)\(if $source != "" then " · reports from \($source)" else "" end)",
"",
"| Platform | Changes | Open |",
"| Report | Changes | Open |",
"| --- | --- | --- |",
($reports[] | "| \(if .platform == "ios" then "iOS" else "Android" end)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?platform=\(.platform)) · [Screens](\($url)?platform=\(.platform)#/screens) · [Compare](\($url)?platform=\(.platform)&view=compare) |"),
# One row per target, named by its label; a target named after its platform keeps ?platform= links.
($reports[]
| (.target // .platform) as $id
| "\(if $id == "ios" or $id == "android" then "platform" else "target" end)=\($id)" as $query
| ((.label // (if .platform == "ios" then "iOS" else "Android" end)) | gsub("\\|"; "\\\\|")) as $name
| "| \($name)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?\($query)) · [Screens](\($url)?\($query)#/screens) · [Compare](\($url)?\($query)&view=compare) |"),
"",
"The link stays the same on every push. [Deploy run](\($run))"]
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
+1 -1
View File
@@ -28,7 +28,7 @@ Explore maps your app: a screenshot of every screen, connected by the taps betwe
<td width="50%" valign="top">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-pr-comment-dark.png">
<img width="100%" alt="Explore's GitHub PR comment on a euxy PR: the heading links to the iOS and Android reports, a table with one row per platform giving device, result and an Open link, the Added, Removed, Modified, Needs review and Source-affected screens as collapsed lists, fading out below them" src="docs/screenshots/readme-pr-comment-light.png">
<img width="100%" alt="Explore's GitHub PR comment on a euxy PR: a heading with how many screens changed and a Review in Explore link, a line naming each device with a link to its report, and the changed screens as a short list, fading out below them" src="docs/screenshots/readme-pr-comment-light.png">
</picture>
<strong>A comment on every PR</strong>: with <a href="#set-up-ci">CI</a>, the report links and the added, removed and modified screens.
</td>
+1 -1
View File
@@ -8,7 +8,7 @@ The same workflow supports Expo Router and React Navigation applications on iOS.
Expo Router inventory comes from route files and layouts. React Navigation inventory comes from statically readable JSX or object screen registrations and navigator hierarchies. Linking determines entry paths independently of route discovery. Unsupported computed declarations and unresolved paths remain diagnostics; analysis does not execute the app to guess their values.
`changes` starts with the exact two-dot Git diff and dependency impact, then adds, independently on each revision, the routes one navigation step before or after an affected route. Layout or screen guards do not count as steps. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. `all` selects the full inventory. Source context does not imply a visible modification.
`changes` starts with the exact two-dot Git diff and dependency impact (a JavaScript or TypeScript file whose two revisions parse to the same syntax tree, differing only in comments or in whitespace the compiler and JSX transform drop, reaches no screen; a comment a compiler reads, such as `@jsx` or `#__PURE__`, still counts), then adds, independently on each revision, the routes one navigation step before or after an affected route. Layout or screen guards do not count as steps. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. `all` selects the full inventory. Source context does not imply a visible modification.
Before app build or simulator allocation, CI regenerates the canonical plan in fresh processes and compares bytes. A mismatch fails with diagnostic plans and their diff. Run identities, timestamps, absolute checkout paths, screenshots, and cache hits are excluded from planning data. Tests also vary enumeration order and checkout location.
+2 -2
View File
@@ -215,7 +215,7 @@ exploration:
- /c/[channel]
```
An excluded route stays in the map and in its neighbors' navigation context, but neither revision captures it, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the map and the screen counts, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
Capture handles iOS's confirmation to open a link in the expected app. After a form submits a password, iOS may offer to save or update it depending on the simulator's AutoFill state; capture declines that prompt with Not Now in both modes, never stores the credential, and records each decision in `capture-diagnostics/system-prompts.jsonl`. Do not script that tap in setup. Include required system-alert handling in setup or app instructions; Explore does not automatically grant application permissions.
@@ -360,7 +360,7 @@ Create an Expo access token for an account with access to the app's EAS project.
Capture uses the automatic GitHub token with `pull-requests: write`, so it can keep the sticky comment current while the run works; publication rewrites that comment from a separate job. `GITHUB_TOKEN_MISSING` means the workflow environment is missing the automatic token mapping.
The sticky comment is one comment for the whole run: a header with the base and head commits, one row per captured platform (device, result, **Open** / **zip** / **run** links), every changed screen listed once with a link per platform, and a collapsed validation table with one column per platform. Each platform's job updates only its own hidden record in the comment, so iOS and Android jobs never overwrite each other. When a new run starts (a push, a rerun), the earlier run moves to a collapsed **Previous runs** list that keeps its head commit, result, report and run links; the last five runs are kept. A run that finishes after the PR moved on is still published, under previous runs, instead of failing. The failure job posts through the same renderer (`ci:failure`), so a crash before the pipeline's own comment still lands in that platform's row.
The sticky comment is one comment for the whole run: a heading with what changed (**17 screens changed · Review in Explore**), a line naming every target with a link to its report plus the compared commits and when the comment was last updated, one line for any target that is still working, failed, or finished with captures missing, then the changed screens as a short list (the first ten, each linking its Before/After in the report, with a link to the rest). Capture problems, when there are any, sit in a collapsed **Capture issues** block; the footer links the workflow run and the config. Each target's job updates only its own hidden record in the comment, so iOS and Android jobs never overwrite each other. When a new run starts (a push, or a rerun's new attempt), the comment keeps the last review under a **New run in progress** line until the new run has a ready target of its own; a target of the new run that fails is named on that line, which reads **New run failed** once nothing is still working. A push also moves the earlier run to a collapsed **Previous runs** list that keeps its head commit, result, report and run links; the last five runs are kept. A run that finishes after the PR moved on is still published, under previous runs, instead of failing. The failure job posts through the same renderer (`ci:failure`), so a crash before the pipeline's own comment still lands in that target's line.
The comment can also draw a map of the change: the added, removed and visually changed screens, the screens one step before them, and the transitions among them, as a collapsed Mermaid flowchart that GitHub draws in place. It is off by default; turn it on with:
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@expo/explore",
"version": "0.19.7",
"version": "0.19.8",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.19.7",
"version": "0.19.8",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.19.7",
"version": "0.19.8",
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
"license": "MIT",
"type": "module",
+6 -5
View File
@@ -3,13 +3,14 @@
//
// node scripts/deploy-viewer-preview.mjs --fixtures DIR --alias pr-123 --project explore-viewer-pr [--owner expo-public]
//
// DIR holds reports.json ([{ platform, changes?, device? }], as a hosted preview's /reports.json lists them) and one
// <platform>.zip per entry (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an
// earlier link's /p/<token>; without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
// DIR holds reports.json ([{ target?, platform, label?, changes?, device? }], as a hosted preview's /reports.json lists
// them) and one <target>.zip per entry, or <platform>.zip for an entry without a target
// (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an earlier link's /p/<token>;
// without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
import { readFile } from "node:fs/promises";
import { join } from "node:path";
import { parseArgs } from "node:util";
import { deployFixturePreview } from "../dist/report/preview-deploy.js";
import { deployFixturePreview, fixtureReports } from "../dist/report/preview-deploy.js";
const { values } = parseArgs({ options: { fixtures: { type: "string" }, alias: { type: "string" }, project: { type: "string" }, owner: { type: "string" } } });
if (!values.fixtures || !values.alias || !values.project) {
@@ -19,7 +20,7 @@ if (!values.fixtures || !values.alias || !values.project) {
const listing = JSON.parse(await readFile(join(values.fixtures, "reports.json"), "utf8"));
const token = process.env.EXPLORE_PREVIEW_TOKEN?.trim() || undefined;
const result = await deployFixturePreview({
reports: listing.map(({ platform, changes, device }) => ({ platform, zipPath: join(values.fixtures, `${platform}.zip`), changes, device })),
reports: fixtureReports(listing, values.fixtures),
project: values.project, alias: values.alias, ...(values.owner ? { owner: values.owner } : {}), ...(token ? { token } : {}),
});
console.log(JSON.stringify({ ...result, reports: listing }));
+5 -4
View File
@@ -100,17 +100,18 @@ try {
const context = await browser.newContext({ viewport: { width: 1000, height: 1400 }, deviceScaleFactor: 2, colorScheme: theme });
const page = await context.newPage();
await page.goto(args.pr, { waitUntil: "domcontentloaded" });
const comment = page.locator(".timeline-comment").filter({ has: page.locator("h3", { hasText: /Explore review/ }) }).first();
const comment = page.locator(".timeline-comment").filter({ has: page.locator("h3", { hasText: /Review in Explore|Explore review/ }) }).first();
await comment.waitFor({ timeout: 30_000 });
await comment.scrollIntoViewIfNeeded();
// The comment's pointer toward the avatar would show as a stray tick above the card.
await page.addStyleTag({ content: ".timeline-comment::before, .timeline-comment::after { display: none !important; }" });
await page.waitForTimeout(1000);
// Cut after the list of changed screens: the launch timings, validation, and footer below it are detail.
// Cut after the list of changed screens: the collapsed blocks and footer below it are detail.
const clip = await comment.evaluate((card) => {
const box = card.getBoundingClientRect();
const after = [...card.querySelectorAll("p")].find(p => /Launch:/.test(p.textContent ?? ""));
const bottom = after ? after.getBoundingClientRect().top : box.bottom;
const list = [...card.querySelectorAll("ul")].find(ul => ul.querySelector(":scope > li code"));
const after = list?.nextElementSibling;
const bottom = after ? after.getBoundingClientRect().top : list ? list.getBoundingClientRect().bottom : box.bottom;
return { x: box.left + window.scrollX, y: box.top + window.scrollY, width: box.width, height: Math.round(bottom - box.top) };
});
const shot = await page.screenshot({ clip, fullPage: true });
+21 -16
View File
@@ -18,30 +18,35 @@ trap 'rm -rf "$work"' EXIT
if ! curl -fsS "$base/reports.json" -o "$work/listing.json"; then
echo '[{"platform":"ios"}]' > "$work/listing.json"
fi
# One ZIP per target, named for it: <target>.zip, or <platform>.zip for a report from before targets. A target named
# after its platform is selected with ?platform=, any other with ?target= (as viewer-links.ts targetParameter does).
# A preview deployed before Explore wrote static files serves each target's ZIP; a newer one serves its manifest and
# screenshots, so the ZIP is put back together here. Screenshot requests keep ?platform=, which deployments that
# answered them from the ZIP need and static files ignore.
for platform in $(jq -r '.[].platform' "$work/listing.json"); do
if curl -fsS "$base/report.zip?platform=$platform" -o "$work/$platform.zip" 2> /dev/null; then
unzip -tq "$work/$platform.zip" > /dev/null
# screenshots, so the ZIP is put back together here. Screenshot requests keep the target's query, which deployments
# that answered them from the ZIP need and static files ignore.
for key in $(jq -r '.[] | .target // .platform' "$work/listing.json"); do
# The listing comes from the hosted preview: a key names files here, so it must be a target id.
[[ "$key" =~ ^[a-z][a-z0-9-]{0,31}$ ]] || { echo "Not a target id in reports.json: $key" >&2; exit 2; }
case "$key" in ios|android) query="platform=$key" ;; *) query="target=$key" ;; esac
if curl -fsS "$base/report.zip?$query" -o "$work/$key.zip" 2> /dev/null; then
unzip -tq "$work/$key.zip" > /dev/null
continue
fi
report="$work/$platform"
report="$work/$key"
mkdir -p "$report/assets"
curl -fsS "$base/manifest.json?platform=$platform" -o "$work/$platform.manifest.json"
file="$(jq -r .file "$work/$platform.manifest.json")"
[[ "$file" == review.json || "$file" == exploration.json ]] || { echo "Not a report manifest: $platform" >&2; exit 1; }
jq -c .report "$work/$platform.manifest.json" > "$report/$file"
for asset in $(jq -r '.entries | keys[]' "$work/$platform.manifest.json"); do
curl -fsS "$base/manifest.json?$query" -o "$work/$key.manifest.json"
file="$(jq -r .file "$work/$key.manifest.json")"
[[ "$file" == review.json || "$file" == exploration.json ]] || { echo "Not a report manifest: $key" >&2; exit 1; }
jq -c .report "$work/$key.manifest.json" > "$report/$file"
for asset in $(jq -r '.entries | keys[]' "$work/$key.manifest.json"); do
[[ "$asset" =~ ^assets/[a-f0-9]{64}\.(png|jpg|mp4)$ ]] || { echo "Unexpected asset name: $asset" >&2; exit 1; }
curl -fsS "$base/$asset?platform=$platform" -o "$report/$asset"
curl -fsS "$base/$asset?$query" -o "$report/$asset"
[[ "$(shasum -a 256 "$report/$asset" | cut -c1-64)" == "${asset:7:64}" ]] || { echo "Checksum mismatch: $asset" >&2; exit 1; }
done
rm -f "$work/$platform.zip"
(cd "$report" && zip -qrX "$work/$platform.zip" "$file" assets)
unzip -tq "$work/$platform.zip" > /dev/null
rm -f "$work/$key.zip"
(cd "$report" && zip -qrX "$work/$key.zip" "$file" assets)
unzip -tq "$work/$key.zip" > /dev/null
done
jq --arg source "$source_name" '[.[] | {platform, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
jq --arg source "$source_name" '[.[] | {target, platform, label, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
gh release view "$tag" > /dev/null 2>&1 || gh release create "$tag" --prerelease --latest=false --title "Viewer preview fixtures" \
--notes "Reports the Viewer preview workflow serves on every pull request. Refresh with scripts/refresh-viewer-preview-fixtures.sh."
+3 -2
View File
@@ -294,8 +294,9 @@ export async function reservePort(port: number, environment: NodeJS.ProcessEnv):
const abandoned = async (path: string) => {
const info = await stat(path).catch(() => undefined);
if (!info) return false;
const owner = await readFile(join(path, "owner"), "utf8").catch(() => undefined);
return owner === undefined ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
// writeFile creates the owner file before it writes the pid, so an empty one is a holder mid-write too.
const owner = await readFile(join(path, "owner"), "utf8").catch(() => "");
return owner === "" ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
};
for (;;) {
try { await mkdir(mutex); await writeFile(join(mutex, "owner"), String(process.pid)); break; }
+2 -1
View File
@@ -268,7 +268,8 @@ export async function runCiReview(options: {
const { projects, output, config, environment, state, assertCurrentHead, postComment } = options;
const progress = options.progress ?? silentProgress;
// The controllers are fetched before any EAS work, so a blocked download fails before a session is paid for. agent-device
// also compares the screenshots. An injected runner (tests) runs no real controller.
// also compares the screenshots. An injected runner (tests) stands in for the controllers' calls, but not for that
// comparison: it still runs the real agent-device, which fetches itself on first use.
if (!options.runner) await prefetchControllers(config, environment, progress);
const pr = options.presentation;
const now = options.now ?? Date.now;
+8 -4
View File
@@ -144,11 +144,13 @@ export function assertAgentAcceptance(bundle: CaptureBundle,
* capture, and the Android emulator's clock and indicators sit inside the same fraction of a
* Pixel frame. Its glyphs differ between sessions even after `--normalize-status-bar`, and within one
* session whenever the clock or an indicator redraws, so evidence never treats a difference that
* lies entirely inside this band as an app change. The Viewer marks the same band.
* lies entirely inside this band as an app change; a difference that crosses its edge counts only for
* its pixels below it. The Viewer marks the same band. Android: the glyphs of `sdk_gphone64` on Android 15
* (720x1600) reach 6.4 % of the frame, measured on euxy #164, so its band is 7.
*/
export const STATUS_BAR_BAND_PERCENT = 6.5;
/** The top band of a portrait screenshot that holds the system status bar, per platform. */
export const STATUS_BAR_BAND_PERCENT_BY_PLATFORM: Record<"ios" | "android", number> = { ios: STATUS_BAR_BAND_PERCENT, android: 5 };
export const STATUS_BAR_BAND_PERCENT_BY_PLATFORM: Record<"ios" | "android", number> = { ios: STATUS_BAR_BAND_PERCENT, android: 7 };
export function statusBarBandPercent(platform: "ios" | "android" | undefined): number {
return STATUS_BAR_BAND_PERCENT_BY_PLATFORM[platform ?? "ios"];
}
@@ -187,9 +189,9 @@ export type PublicVisualVerdict = {
* content. Absent when any region changed, or moves were not measured.
*/
allRegionsMoved?: true;
/** Diff regions inside the iOS status-bar band that were excluded from the verdict. */
/** Diff regions inside the status-bar band that were excluded from the verdict, or clipped to their part below it. */
ignoredStatusBarRegions?: number;
/** Diff regions that lay entirely inside the home-indicator band and were left out of the verdict. */
/** Diff regions that lay inside the home-indicator band and were left out of the verdict, or clipped to their part above it. */
ignoredHomeIndicatorRegions?: number;
};
/**
@@ -277,6 +279,8 @@ export type PublicReview = {
note?: PublicChangeNote;
/** The appearance this surface rendered in; a secondary appearance is its own surface, `<id>@<scheme>`. */
colorScheme?: "light" | "dark";
/** Named in `exploration.exclude`: kept for its neighbors' navigation context, never captured on either side. */
excluded?: true;
}>;
};
export function validateCapturePlan(value: unknown): SourceCapturePlan {
+4
View File
@@ -345,6 +345,10 @@ function validatePublicReview(review: PublicReview, enforceComparisonEvidence: b
throw new Error("Public review source presence or status is inconsistent");
}
ids.add(surface.id);
if (surface.excluded !== undefined && (surface.excluded !== true
|| surface.baseImage || surface.headImage || surface.baseOutcome || surface.headOutcome || surface.visual)) {
throw new Error("Public review excluded surface carries capture evidence");
}
assertReviewFields(surface, enforceComparisonEvidence);
assertChangeNote(surface, review);
if (surface.sourceChange) {
+6 -3
View File
@@ -176,7 +176,8 @@ const edgeItem = (edge: Json): Json => defined({ from: str(edge.from), to: str(e
* means a visible change. A screen whose source changed but whose captures match is unchanged, including in reports
* from before 0.19.1, which called it "needs review". A modified screen whose screenshots match changed only in what
* assistive technology reads: `accessibility-only`. A screen whose capture failed is `unavailable`, and one whose
* source changed but that has no verdict was not compared: `not-compared`.
* source changed but that has no verdict was not compared: `not-compared`. A route named in `exploration.exclude` is
* `excluded`: never captured on either side.
*/
/** Both sides captured at their verified destination route, as a verdict requires (isAccessibilityOnlyChange in the contract). */
function verifiedPair(surface: Json): boolean {
@@ -194,6 +195,8 @@ function captureUnavailable(surface: Json, side: "base" | "head"): boolean {
}
function verdictOf(surface: Json): string | undefined {
// Named in exploration.exclude: never captured, so there is nothing to compare or to miss.
if (surface.excluded === true) return "excluded";
// A capture that failed is unavailable, as the Viewer says, whatever the source or an older verdict claims.
if (str(surface.status) !== "removed" && captureUnavailable(surface, "head")) return "unavailable";
if (["modified", "unchanged"].includes(str(surface.status) ?? "") && captureUnavailable(surface, "base")) return "unavailable";
@@ -206,9 +209,9 @@ function verdictOf(surface: Json): string | undefined {
return status ?? str(surface.status);
}
const STATUS_ORDER = ["modified", "accessibility-only", "added", "removed", "needs-review", "unavailable", "not-compared", "unchanged", "variant"];
const STATUS_ORDER = ["modified", "accessibility-only", "added", "removed", "needs-review", "unavailable", "not-compared", "excluded", "unchanged", "variant"];
const STATUS_WORDS: Record<string, string> = { "accessibility-only": "accessibility only (screenshots match, the accessibility tree does not)",
"needs-review": "need review", "not-compared": "not compared", variant: "screen variants" };
"needs-review": "need review", "not-compared": "not compared", excluded: "excluded by config (exploration.exclude), never captured", variant: "screen variants" };
/** "3 modified, 1 added, 1 removed, 30 unchanged": every status counted, so the parts add up to the total. */
function screenCounts(screens: Json): string {
+189 -230
View File
@@ -2,7 +2,7 @@ import type { PublicReview } from "../contracts/capture.js";
import type { RunTarget } from "../types.js";
import type { SimulatorRuntimeMetadata } from "../capture/run.js";
import { CI_COMMENT_MARKER } from "./pr-comment.js";
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, changeCountText, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedRecords, readCommentRecords, recordLabel, recordLine, recordSummary, recordTarget,
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedPrevious, orderedRecords, previousLine, readCommentRecords, recordLabel, recordLine, recordSummary,
type ChangeGroup, type CommentNavigation, type CommentTarget, type CommentRecords, type HistoryEntry, type NavigationGroup, type NavigationKind, type PlatformRecord } from "./pr-comment-record.js";
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
@@ -64,13 +64,6 @@ export type PublicCommentState = {
type ReviewGroup = ChangeGroup;
const GROUP_ORDER: ReviewGroup[] = CHANGE_GROUPS;
const GROUP_LABEL: Record<ReviewGroup, string> = {
added: "🟩 Added",
modified: "🟧 Modified",
removed: "🟥 Removed",
"accessibility-only": "🟦 Accessibility only",
"needs-review": "🟨 Needs review",
};
/** The body is HTML, so no blank lines are needed and the block keeps its natural spacing. */
function details(summary: string, content: string[]): string[] {
@@ -115,14 +108,6 @@ function link(label: string, destination: string): string {
const SUPERSEDED_NOTE = "The pull request moved while this run worked; its report is kept here until the current run replaces it.";
function duration(startedAt: number, updatedAt: number): string {
const total = Math.max(0, Math.round((updatedAt - startedAt) / 1000));
if (startedAt <= 0 || total > 24 * 3600) return "";
const minutes = Math.floor(total / 60);
const seconds = total % 60;
return minutes > 0 ? `${minutes}m ${String(seconds).padStart(2, "0")}s` : `${seconds}s`;
}
function plural(count: number, noun: string): string {
return `${count} ${noun}${count === 1 ? "" : "s"}`;
}
@@ -191,12 +176,7 @@ function previewExpiry(expiresAt: number): string {
return new Date(expiresAt).toLocaleDateString("en-US", { month: "short", day: "numeric", year: "numeric", timeZone: "UTC" }) + " (UTC)";
}
/**
* Differences that are not review targets, stated once instead of per screen: screen variants
* (source-unchanged screens captured in another runtime state) and app-wide source changes that
* left some screens without a visible difference.
*/
/** "Launch: splash unchanged for 3.1 s" — the app launch per appearance, kept apart from the screen rows. */
/** "Launch: splash unchanged for 3.1 s" — the app launch per appearance, for the local text summary. */
function launchLine(review: PublicReview): string | undefined {
const launch = review.launch ?? [];
if (!launch.length) return undefined;
@@ -220,9 +200,19 @@ function launchLine(review: PublicReview): string | undefined {
return `Launch: ${parts.join("; ")}.`;
}
/** "Splash screen changed": the launch comparison when it found a difference; a steady splash is not news for the comment. */
function splashLines(review: PublicReview): string[] {
const launch = review.launch ?? [];
const changed = launch.filter(entry => entry.visual && entry.visual.verdict !== "unchanged");
if (!changed.length) return [];
const verdict = changed.every(entry => entry.visual!.verdict === "needs-review") ? "needs review" : "changed";
const schemes = changed.map(entry => entry.colorScheme).filter((scheme): scheme is NonNullable<typeof scheme> => Boolean(scheme));
return [`Splash screen ${verdict}${schemes.length && changed.length < launch.length ? ` in ${schemes.join(" and ")} mode` : ""}`];
}
function contextLines(review: PublicReview): string[] {
const variants = review.surfaces.filter(surface => surface.review?.status === "variant").length;
const appWide = review.surfaces.filter(surface => surface.sourceScope === "app-wide");
const appWide = review.surfaces.filter(surface => surface.sourceScope === "app-wide" && !surface.excluded);
const files = [...new Set(appWide.flatMap(surface => surface.sourceChange?.files.filter(file => file.relation === "global").map(file => file.path) ?? []))].sort();
const lines: string[] = [];
const launch = launchLine(review);
@@ -236,7 +226,6 @@ function contextLines(review: PublicReview): string[] {
}
const SURFACE_ID = /^[A-Za-z0-9._-]{1,200}(@(light|dark))?$/;
const MAX_ROWS_PER_GROUP = 200;
/** The run id and attempt the run link names (`…/actions/runs/<id>/attempts/<n>`). */
function runIdentity(run: string): { runId: string; runAttempt: string } {
@@ -316,7 +305,7 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
if (navigation) record.navigation = navigation;
const notCompared = state.review.surfaces.filter(notComparedChange).length;
if (notCompared) record.notCompared = notCompared;
record.context = contextLines(state.review).filter(line => line.length);
record.context = splashLines(state.review);
const diagnostics = [...(state.evidence?.diagnostics ?? [])];
for (const surface of state.review.surfaces) {
for (const side of ["base", "head"] as const) {
@@ -447,214 +436,185 @@ function surfaceLink(report: string, id: string): string | undefined {
return url.href;
}
function resultCell(record: PlatformRecord): string {
switch (record.phase) {
case "pending": return "⏳ starting";
case "capturing": {
const capture = record.capture;
if (!capture) return "⏳ capturing";
const side = capture.current ?? (capture.done.head > 0 || capture.baseFromCache ? "head" : "base");
return `⏳ capturing ${side} ${capture.done[side]}/${capture.planned[side]}${capture.baseFromCache && side === "head" ? " · base reused" : ""}`;
}
case "failed": return `🟥 failed · ${inlineText(record.failure?.step ?? "capture", 48)}`;
case "ready": {
const unavailable = record.health ? record.health.base.unavailable + record.health.head.unavailable : 0;
const unverified = record.health ? record.health.base.unverified + record.health.head.unverified : 0;
const failed = (record.validation?.visual?.failed ?? 0) + (record.validation?.accessibility?.failed ?? 0);
const notCompared = record.notCompared ?? 0;
const icon = unavailable || unverified || failed || notCompared ? "🟨" : "🟩";
return [`${icon} ${changeCountText(record.changes?.map(change => change.group) ?? [])}`, notCompared ? `${notCompared} not compared` : undefined, unavailable ? `${unavailable} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
failed ? `${failed} comparison${failed === 1 ? "" : "s"} failed` : undefined, duration(record.startedAt, record.updatedAt)].filter(Boolean).join(" · ");
}
}
}
/** The report link alone; the workflow run and the report zip sit in the footer, where someone debugging looks for them. */
function reportCell(record: PlatformRecord): string {
const run = link("run", record.links.run);
if (record.phase === "failed") return `${run} · ${link("evidence", record.links.artifacts)}`;
if (record.phase !== "ready") return run;
return record.links.report ? link(record.links.report.includes(".expo.app/") ? "Open" : "Viewer", record.links.report) : record.links.deploying ? "deploying…" : run;
}
const ROW_LIMIT = 10;
const MAX_FAILURE_MESSAGE = 600;
/** A target's label as Markdown text. */
const labelOf = (record: PlatformRecord) => inlineText(recordLabel(record), 80);
const finished = (record: PlatformRecord) => record.phase === "ready" || record.phase === "failed";
const firstReport = (records: PlatformRecord[]) => records.find(record => record.phase === "ready" && record.links.report)?.links.report;
/** "platform" for the per-platform targets of a config without targets, "device" once a config names its own. */
function targetNoun(records: PlatformRecord[]): "platform" | "device" {
return records.every(record => !record.target && record.label === undefined) ? "platform" : "device";
}
/** "Workflow iOS run · zip; Android run · zip" for the ready targets, with the target named only when there are several. */
function artifactLinks(records: PlatformRecord[]): string | undefined {
function updatedText(records: PlatformRecord[]): string {
const at = Math.max(...records.map(record => record.updatedAt));
return `${new Date(at).toLocaleString("en-US", { month: "short", day: "numeric", hour: "numeric", minute: "2-digit", timeZone: "UTC" })} UTC`;
}
/** "17 screens changed · Review in Explore": what the run found, with the report as the heading's link; until a target finished, what it is doing. */
function title(records: PlatformRecord[], rows: ChangeRow[]): string {
const ready = records.filter(record => record.phase === "ready");
if (!ready.length) return undefined;
const parts = ready.map(record => {
const links = [link("run", record.links.run), record.links.download ? link("zip", record.links.download) : undefined].filter(Boolean).join(" · ");
return ready.length > 1 ? `${labelOf(record)} ${links}` : links;
});
return `Workflow ${parts.join("; ")}`;
}
function deviceCell(record: PlatformRecord): string {
const parts = [record.device ? inlineText(record.device, 80) : undefined,
record.app?.version ? inlineText(`${record.app.name ? `${record.app.name} ` : ""}${record.app.version}${record.app.build ? ` (${record.app.build})` : ""}`, 80) : undefined].filter(Boolean);
return parts.length ? parts.join(" · ") : "—";
}
type ChangeRow = { id: string; route: string; scheme?: string; group: ReviewGroup; description: string; perTarget: Partial<Record<CommentTarget, { group: ReviewGroup; href?: string }>> };
function changeRows(records: PlatformRecord[]): Map<ReviewGroup, ChangeRow[]> {
const rows = new Map<string, ChangeRow>();
for (const record of records) {
if (record.phase !== "ready") continue;
for (const change of record.changes ?? []) {
const href = record.links.report ? surfaceLink(record.links.report, change.id) : undefined;
const row = rows.get(change.id) ?? { id: change.id, route: change.route, group: change.group, description: change.description, perTarget: {}, ...(change.scheme ? { scheme: change.scheme } : {}) };
// A screen accessibility-only on one target and visibly changed on another is listed as the visible change.
if (strongerGroup(row.group, change.group) !== row.group) Object.assign(row, { group: change.group, description: change.description });
row.perTarget[recordTarget(record)] = { group: change.group, ...(href ? { href } : {}) };
rows.set(change.id, row);
}
}
const groups = new Map<ReviewGroup, ChangeRow[]>();
for (const row of rows.values()) groups.set(row.group, [...(groups.get(row.group) ?? []), row]);
return groups;
}
function renderChangeRow(row: ChangeRow, records: PlatformRecord[]): string {
const where = records.flatMap(record => {
const entry = row.perTarget[recordTarget(record)];
if (!entry) return [];
const label = labelOf(record) + (entry.group !== row.group ? ` (${GROUP_LABEL[entry.group].replace(/^\S+ /, "").toLowerCase()})` : "");
return [entry.href ? link(label, entry.href) : label];
});
const route = `\`${plainText(row.route, MAX_ROUTE_LENGTH).replace(/`/g, "")}\`${row.scheme ? ` (${inlineText(row.scheme, 20)})` : ""}`;
return `- ${route} — ${inlineText(row.description, MAX_DESCRIPTION_LENGTH)}${where.length ? ` · ${where.join(" · ")}` : ""}`;
}
function changesSection(records: PlatformRecord[], rowCap: number, withMap: boolean): string[] {
const ready = records.filter(record => record.phase === "ready");
if (!ready.length) return [];
const groups = changeRows(ready);
const lines: string[] = [];
const noun = targetNoun(records);
const total = [...groups.values()].reduce((sum, rows) => sum + rows.length, 0);
lines.push(`**Changes** · ${plural(total, "screen")}${records.length > 1 && ready.length > 1 ? ` · a screen is listed once, with a link per ${noun}` : ""}`, "");
// With screens left uncompared, nothing changed only among the ones compared.
if (total === 0) lines.push(ready.some(record => record.notCompared) ? `No compared screen changed on the reviewed ${noun}s.` : `No screen changed on the reviewed ${noun}s.`, "");
for (const group of GROUP_ORDER) {
const rows = groups.get(group) ?? [];
if (!rows.length) continue;
const shown = rows.slice(0, rowCap);
const content = ["", ...(group === "accessibility-only" ? ["Before and After look the same. What screen readers and voice control read changed.", ""] : []),
...shown.map(row => renderChangeRow(row, records))];
if (rows.length > shown.length) {
const report = ready.find(record => record.links.report)?.links.report;
content.push(`- ${rows.length - shown.length} more${report ? ` — ${link("Explore report", report)}` : ""}`);
}
content.push("");
lines.push(...details(`${GROUP_LABEL[group]} (${rows.length})`, content));
}
if (withMap) lines.push(...mapSection(ready));
const seen = new Set<string>();
for (const record of ready) for (const line of record.context ?? []) {
if (seen.has(line)) continue;
seen.add(line);
const everywhere = ready.every(other => other.context?.includes(line));
lines.push(everywhere ? line : `${labelOf(record)} · ${line}`, "");
}
return lines;
}
/**
* The heading carries the report links: on a phone the table's last column is clipped, and the
* commits it reviews are a subtitle under it. A target still capturing adds its link when it is ready.
*/
function heading(records: PlatformRecord[]): string {
const ready = records.filter(record => record.phase === "ready" && record.links.report);
if (!ready.length) {
return records.some(record => record.phase === "ready" && record.links.deploying) ? "### Explore review · report deploying, not ready yet" : "### Explore review";
if (records.every(record => record.phase === "failed")) return "### Explore review · capture failed";
const active = records.filter(record => !finished(record));
const verb = active.some(record => record.phase === "capturing") ? "capturing" : "starting";
return `### Explore review · ${verb}${records.length > 1 ? ` on ${plural(active.length, targetNoun(records))}` : ""}`;
}
const links = ready.length === 1 ? [link("Open report", ready[0]!.links.report!)]
: ready.map(record => link(`${labelOf(record)} report`, record.links.report!));
return `### Explore review · ${links.join(" · ")}`;
// With screens left uncompared, nothing changed only among the ones compared.
const summary = rows.length ? `${plural(rows.length, "screen")} changed` : ready.some(record => gaps(record).length) ? "No compared screens changed" : "No screens changed";
const report = firstReport(ready);
const open = report ? link("Review in Explore", report) : ready.some(record => record.links.deploying) ? "report deploying…" : undefined;
return `### ${summary}${open ? ` · ${open}` : ""}`;
}
function validationCell(record: PlatformRecord, check: "capture" | "routes" | "visual" | "accessibility" | "inventory"): string {
if (record.phase === "pending" || record.phase === "capturing") return "⏳";
if (record.phase === "failed") {
if (check !== "capture") return "—";
const capture = record.capture;
return capture ? `🟥 ${capture.done.base + capture.done.head}/${capture.planned.base + capture.planned.head} surfaces` : "🟥 not started";
}
const health = record.health;
switch (check) {
case "capture": {
const planned = health ? health.base.planned + health.head.planned : (record.capture?.planned.base ?? 0) + (record.capture?.planned.head ?? 0);
const done = health ? health.base.captured + health.head.captured : (record.capture?.done.base ?? 0) + (record.capture?.done.head ?? 0);
const cache = record.capture?.baseFromCache ? " · base cache reused" : "";
return done < planned ? `🟨 ${done}/${planned} surfaces · ${planned - done} unavailable${cache}` : `🟩 ${done}/${planned} surfaces${cache}`;
}
case "routes": {
if (!health) return "—";
const verified = health.base.verified + health.head.verified, planned = health.base.planned + health.head.planned;
const unverified = health.base.unverified + health.head.unverified, unavailable = health.base.unavailable + health.head.unavailable;
return `${verified === planned ? "🟩" : "🟨"} ${verified}/${planned} verified${unverified ? ` · ${unverified} unattributed` : ""}${unavailable ? ` · ${unavailable} unavailable` : ""}`;
}
case "visual": {
const v = record.validation?.visual;
if (!v) return "🟨 not run";
const mark = v.compared === 0 || v.failed > 0 || v.skipped ? "🟨" : "🟩";
return `${mark} ${v.compared} compared · threshold ${v.threshold}${v.failed ? ` · ${v.failed} failed` : ""}${v.skipped ? ` · ${v.skipped} skipped` : ""}`;
}
case "accessibility": {
const a = record.validation?.accessibility;
if (!a) return "🟨 not run";
return `${a.compared === 0 || a.failed > 0 ? "🟨" : "🟩"} ${a.compared} compared · ${plural(a.described, "description")}${a.failed ? ` · ${a.failed} failed` : ""}`;
}
case "inventory": return record.validation?.routes !== undefined ? `🟩 ${plural(record.validation.routes, "route")}` : "🟩 analyzed";
}
/** Every target by name, each linking its own report, then the commits and when the comment last changed. */
function subtitle(records: PlatformRecord[], repository: string): string {
const first = records[0]!;
const targets = records.map(record => record.phase === "ready" && record.links.report ? link(labelOf(record), record.links.report) : labelOf(record));
return `<sub>${[...targets, `${commitLink(repository, first.headSha)} vs ${commitLink(repository, first.baseSha)}`, `updated ${updatedText(records)}`].join(" · ")}</sub>`;
}
function validationSummary(record: PlatformRecord): string {
/** One line for a target that is not simply done: still working, failed, or finished with captures missing. */
function statusLine(record: PlatformRecord): string | undefined {
const label = labelOf(record), run = link("run", record.links.run);
switch (record.phase) {
case "failed": return "🟥 failed";
case "pending": return `${label} · starting · ${run}`;
case "capturing": {
const capture = record.capture;
if (!capture) return `${label} · capturing · ${run}`;
const side = capture.current ?? (capture.done.head > 0 || capture.baseFromCache ? "head" : "base");
return `${label} · capturing ${side} ${capture.done[side]}/${capture.planned[side]}${capture.baseFromCache && side === "head" ? " · base reused" : ""} · ${run}`;
}
case "failed": return [`**${label} failed**`, inlineText(record.failure?.step ?? "capture", 48), record.failure?.message ? inlineText(record.failure.message, MAX_FAILURE_MESSAGE) : undefined,
run, link("evidence", record.links.artifacts)].filter(Boolean).join(" · ");
case "ready": {
const health = record.health;
if (!health) return "🟩 reviewed";
const captured = health.base.captured + health.head.captured, planned = health.base.planned + health.head.planned;
return `${captured < planned ? "🟨" : "🟩"} ${captured}/${planned} captured`;
const parts = gaps(record);
return parts.length ? `${label} · ${parts.join(" · ")} · ${run}` : undefined;
}
default: return "⏳ in progress";
}
}
function validationSection(byTarget: PlatformRecord[]): string[] {
if (!byTarget.some(record => record.phase === "ready" || record.phase === "failed")) return [];
const summary = `Validation · ${byTarget.map(record => `${labelOf(record)} ${validationSummary(record)}`).join(" · ")}`;
const header = `| Check | ${byTarget.map(labelOf).join(" | ")} |`;
const checks: [string, Parameters<typeof validationCell>[1]][] = [["Capture", "capture"], ["Route verification", "routes"], ["Visual comparison", "visual"], ["Accessibility comparison", "accessibility"], ["Source inventory", "inventory"]];
const content = ["", header, `|---|${byTarget.map(() => "---").join("|")}|`,
...checks.map(([label, check]) => `| ${label} | ${byTarget.map(record => validationCell(record, check)).join(" | ")} |`), ""];
for (const record of byTarget) {
if (record.phase === "failed" && record.failure) {
content.push(`**${labelOf(record)} failed** — ${inlineText(record.failure.message, 1200)} ${link("Open the failed run", record.links.run)} · ${link("Evidence artifact", record.links.artifacts)}`, "");
}
if (record.phase !== "ready") continue;
const health = record.health;
const gaps = health ? health.base.unavailable + health.base.unverified + health.head.unavailable + health.head.unverified : 0;
if (!gaps && !record.diagnostics?.length) continue;
const sideLine = (side: "base" | "head") => { const h = health![side]; return `${side} ${h.verified}/${h.planned} verified${h.unverified ? ` · ${h.unverified} unattributed` : ""}${h.unavailable ? ` · ${h.unavailable} unavailable` : ""}`; };
content.push(health ? `**${labelOf(record)}** · ${sideLine("base")} · ${sideLine("head")}` : `**${labelOf(record)}**`, "");
/** What a finished target has no verdict on: captures missing or unattributed, comparisons that did not run or failed. */
function gaps(record: PlatformRecord): string[] {
const unavailable = record.health ? record.health.base.unavailable + record.health.head.unavailable : 0;
const unverified = record.health ? record.health.base.unverified + record.health.head.unverified : 0;
const failed = (record.validation?.visual?.failed ?? 0) + (record.validation?.accessibility?.failed ?? 0);
return [unavailable ? `${plural(unavailable, "capture")} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
record.notCompared ? `${record.notCompared} not compared` : undefined, failed ? `${plural(failed, "comparison")} failed` : undefined]
.filter((part): part is string => Boolean(part));
}
/** The per-screen capture problems, collapsed: the status line already counts them. */
function diagnosticsSection(records: PlatformRecord[]): string[] {
const flagged = records.filter(record => record.phase === "ready" && ((record.diagnostics?.length ?? 0) > 0 || (record.diagnosticCount ?? 0) > 0));
if (!flagged.length) return [];
const content: string[] = [""];
for (const record of flagged) {
if (records.length > 1) content.push(`**${labelOf(record)}**`, "");
for (const diagnostic of record.diagnostics ?? []) {
content.push(`- ${diagnostic.side ? `${diagnostic.side === "base" ? "Base" : "Head"} · ` : ""}${inlineText(diagnostic.route, MAX_ROUTE_LENGTH)} · ${inlineText(diagnostic.code, 80)}: ${inlineText(diagnostic.message, 160)} Next action: ${inlineText(diagnostic.nextAction, 240)}`);
}
const more = (record.diagnosticCount ?? 0) - (record.diagnostics?.length ?? 0);
if (more > 0) content.push(`- ${more} more — ${link("View run", record.links.run)}`);
if (record.diagnostics?.length) content.push("");
if (more > 0) content.push(`- ${more} more — ${link("run", record.links.run)}`);
content.push("");
}
return details(summary, content);
const total = flagged.reduce((sum, record) => sum + Math.max(record.diagnosticCount ?? 0, record.diagnostics?.length ?? 0), 0);
return details(`Capture issues (${total})`, content);
}
type ChangeRow = { id: string; route: string; scheme?: string; group: ReviewGroup; description: string; href?: string; targets: PlatformRecord[] };
/** Every changed screen once, in group order (added, removed, modified, …), linking the first target in config order that shows its group. */
function changeRows(ready: PlatformRecord[]): ChangeRow[] {
const rows = new Map<string, ChangeRow>();
for (const record of ready) {
for (const change of record.changes ?? []) {
const href = record.links.report ? surfaceLink(record.links.report, change.id) : undefined;
const row = rows.get(change.id) ?? { id: change.id, route: change.route, group: change.group, description: change.description, targets: [], ...(change.scheme ? { scheme: change.scheme } : {}) };
// A screen accessibility-only on one target and visibly changed on another is listed as the visible change.
// The link opens the target the row describes.
if (strongerGroup(row.group, change.group) !== row.group) Object.assign(row, { group: change.group, description: change.description, href });
else if (!row.href && href && change.group === row.group) row.href = href;
row.targets.push(record);
rows.set(change.id, row);
}
}
return [...rows.values()].sort((a, b) => GROUP_ORDER.indexOf(a.group) - GROUP_ORDER.indexOf(b.group));
}
function renderChangeRow(row: ChangeRow, ready: PlatformRecord[]): string {
const code = `\`${plainText(row.route, MAX_ROUTE_LENGTH).replace(/`/g, "")}\``;
const route = `${row.href ? link(code, row.href) : code}${row.scheme ? ` (${inlineText(row.scheme, 20)})` : ""}`;
const description = inlineText(row.description.replace(/\.$/, ""), MAX_DESCRIPTION_LENGTH);
let text: string;
if (row.group === "added" || row.group === "removed") {
const verb = row.group === "added" ? "Added" : "Removed";
// The default description repeats the verb and route; an agent's note does not.
text = row.description === `${verb} ${row.route} screen` ? `${verb} ${route}` : `${verb} ${route} · ${description}`;
} else {
text = `${route} · ${description}`;
}
const tag = row.group === "accessibility-only" ? "accessibility only" : row.group === "needs-review" ? "needs review" : undefined;
// A target with screens it has no verdict on may have changed this one too: name where it changed, not where it did not.
const where = ready.some(record => !row.targets.includes(record) && gaps(record).length)
? `on ${row.targets.map(labelOf).join(", ")}` : targetsNote(row.targets, ready);
return `- ${[text, tag, where].filter(Boolean).join(" · ")}`;
}
/** "Android only" / "not on Android": the targets a screen changed on, when not all of them, named the shorter way. */
function targetsNote(on: PlatformRecord[], ready: PlatformRecord[]): string | undefined {
if (ready.length < 2 || on.length >= ready.length) return undefined;
const missing = ready.filter(record => !on.includes(record));
return missing.length < on.length ? `not on ${missing.map(labelOf).join(", ")}` : `${on.map(labelOf).join(", ")} only`;
}
function changesSection(ready: PlatformRecord[], rows: ChangeRow[], rowCap: number, withMap: boolean): string[] {
if (!ready.length) return [];
const lines: string[] = [];
const shown = rows.slice(0, rowCap);
lines.push(...shown.map(row => renderChangeRow(row, ready)));
if (rows.length > shown.length) {
const report = firstReport(ready);
const more = `${plural(rows.length - shown.length, "more screen")} in the report`;
lines.push(`- ${report ? link(more, report) : more}`);
}
if (lines.length) lines.push("");
if (withMap) lines.push(...mapSection(ready));
const byLine = new Map<string, PlatformRecord[]>();
for (const record of ready) for (const line of record.context ?? []) byLine.set(line, [...(byLine.get(line) ?? []), record]);
for (const [line, records] of byLine) lines.push(records.length === ready.length ? line : `${line} · ${targetsNote(records, ready)}`, "");
return lines;
}
/**
* The previous run stays on the comment while a new one works or has only failed; this line, above it, says which,
* with each failure's step and message.
*/
function newRunLine(current: PlatformRecord[], shown: PlatformRecord[], repository: string): string {
const first = current[0]!;
const active = current.filter(record => !finished(record));
const failed = current.filter(record => record.phase === "failed");
const named = current.length > 1 || shown.length > 1 || Boolean(first.target) || first.label !== undefined;
const verb = active.some(record => record.phase === "capturing") ? "capturing" : "starting";
const working = active.length ? [`${verb}${named ? ` on ${active.map(labelOf).join(", ")}` : ""}`] : [];
const failures = failed.map(record => [named ? `**${labelOf(record)} failed**` : undefined, inlineText(record.failure?.step ?? "capture", 48),
record.failure?.message ? inlineText(record.failure.message, MAX_FAILURE_MESSAGE) : undefined].filter(Boolean).join(" · "));
const links = [link("run", first.links.run), ...(failed.length ? [link("evidence", failed[0]!.links.artifacts)] : [])];
return `> **${active.length ? "New run in progress" : "New run failed"}** for ${commitLink(repository, first.headSha)} · ${[...working, ...failures, ...links].join(" · ")}`;
}
function footer(records: PlatformRecord[]): string {
const parts: string[] = [];
const expiries = records.filter(record => record.phase === "ready" && record.links.expiresAt !== undefined).map(record => record.links.expiresAt);
if (expiries.length) parts.push(expiries.some(at => at === null) ? "Preview links work for anyone who has them until the deployment is deleted"
: `Preview links work for anyone who has them until ${previewExpiry(Math.min(...expiries.filter((at): at is number => at !== null)))}`);
const runs = records.filter((record, index, all) => all.findIndex(other => other.links.run === record.links.run) === index);
parts.push(runs.length === 1 ? link("Workflow run", runs[0]!.links.run) : runs.map(record => link(`${labelOf(record)} run`, record.links.run)).join(" · "));
parts.push(link("Config", records[0]!.links.config));
return `<sub>${parts.join(" · ")}</sub>`;
}
function historySection(repository: string, history: HistoryEntry[]): string[] {
@@ -683,44 +643,47 @@ function deploymentOf(url: string | undefined): string | undefined {
}
function deploymentMarkerOf(records: CommentRecords): string | undefined {
const names = new Set<string>();
for (const record of Object.values(records.current)) { const name = deploymentOf(record?.links.report); if (name) names.add(name); }
for (const record of [...Object.values(records.current), ...Object.values(records.previous ?? {})]) { const name = deploymentOf(record?.links.report); if (name) names.add(name); }
for (const entry of records.history) for (const item of Object.values(entry.platforms)) { const name = deploymentOf(item?.report); if (name) names.add(name); }
return names.size ? `<!-- expo-explore-deployments:${[...names].sort().join(",")} -->` : undefined;
}
/** The whole comment from its records: hidden lines first, then one review for every target of the current run, in config order. */
/**
* The whole comment from its records: hidden lines first, then the review. Until a target of the current run is ready,
* the previous run's review stays up under a line that says a new run is working or failed.
*/
export function renderCommentRecords(records: CommentRecords, existing?: string, budget = PUBLIC_COMMENT_BODY_BUDGET): string {
const current = orderedRecords(records);
const previous = orderedPrevious(records);
const hidden = [CI_COMMENT_MARKER, ...[deploymentMarkerOf(records)].filter((line): line is string => Boolean(line)),
...current.map(recordLine), ...[historyLine(records.history)].filter((line): line is string => Boolean(line))];
...current.map(recordLine), ...previous.map(previousLine), ...[historyLine(records.history)].filter((line): line is string => Boolean(line))];
if (!current.length) return [...hidden, "### Explore review", "", ...(records.history.some(entry => Object.values(entry.platforms).some(item => item?.superseded)) ? [SUPERSEDED_NOTE, ""] : []),
...historySection("", records.history)].join("\n");
const first = current[0]!;
const shown = current.some(record => record.phase === "ready") || !previous.length ? current : previous;
const first = shown[0]!;
const repository = repositoryOf(first.links.run);
const ready = shown.filter(record => record.phase === "ready");
const rows = changeRows(ready);
const render = (rowCap: number, withMap: boolean): string => {
const lines: string[] = [...hidden, heading(current), "",
`<sub>base ${commitLink(repository, first.baseSha)} → ${commitLink(repository, first.headSha)}</sub>`, ""];
const lines: string[] = [...hidden];
if (shown !== current) lines.push(newRunLine(current, shown, repository), "");
lines.push(title(shown, rows), "", subtitle(shown, repository), "");
if (first.superseded) lines.push(SUPERSEDED_NOTE, "");
lines.push(`| | Device | Result | Report |`, `|---|---|---|---|`,
...current.map(record => `| ${labelOf(record)} | ${deviceCell(record)} | ${resultCell(record)} | ${reportCell(record)} |`), "");
lines.push(...changesSection(current, rowCap, withMap));
lines.push(...validationSection(current));
for (const line of shown.map(statusLine)) if (line) lines.push(line, "");
lines.push(...changesSection(ready, rows, rowCap, withMap));
lines.push(...diagnosticsSection(shown));
lines.push(...historySection(repository, records.history));
const expiries = current.filter(record => record.phase === "ready" && record.links.expiresAt !== undefined).map(record => record.links.expiresAt);
const footer: string[] = [];
if (expiries.length) footer.push(expiries.some(at => at === null) ? "Preview links work for anyone who has them until the deployment is deleted."
: `Preview links work until ${previewExpiry(Math.min(...expiries.filter((at): at is number => at !== null)))} for anyone who has them.`);
footer.push(`Managed via ${link("`" + plainText(configPathOf(first.links.config), 120).replace(/`/g, "") + "`", first.links.config)}`);
const artifacts = artifactLinks(current);
if (artifacts) footer.push(artifacts);
lines.push(footer.join(" · "));
lines.push(footer(shown));
return lines.join("\n");
};
// The map goes first when the body is over budget, then the change lists shrink.
let rowCap = MAX_ROWS_PER_GROUP;
// The map goes first when the body is over budget, then the list shrinks, then the previous run's records go; once the
// current run shows, nothing renders them, so they go first.
let rowCap = ROW_LIMIT;
let body = render(rowCap, true);
if (body.length > budget && shown === current && previous.length) return renderCommentRecords({ ...records, previous: {} }, existing, budget);
if (body.length > budget) body = render(rowCap, false);
while (body.length > budget && rowCap > 1) { rowCap = Math.max(1, Math.floor(rowCap / 2)); body = render(rowCap, false); }
if (body.length > budget && previous.length) return renderCommentRecords({ ...records, previous: {} }, existing, budget);
return body;
}
@@ -728,10 +691,6 @@ function repositoryOf(run: string): string {
const match = /^https:\/\/github\.com\/([^/]+)\/([^/]+)\/actions\//.exec(run);
return match ? `${decodeURIComponent(match[1]!)}/${decodeURIComponent(match[2]!)}` : "";
}
function configPathOf(config: string): string {
const match = /\/blob\/[0-9a-f]{40}\/(.+)$/.exec(config);
return match ? decodeURIComponent(match[1]!) : "config";
}
/**
* Render the sticky pull-request comment for any phase of a public review run, folding this writer into the existing
+67 -13
View File
@@ -127,7 +127,12 @@ export type HistoryEntry = {
};
export type HistoryItem = { phase: RecordPhase; summary: string; run: string; report?: string; download?: string; superseded?: boolean; label?: string; order?: number };
export type CommentRecords = { current: Partial<Record<CommentTarget, PlatformRecord>>; history: HistoryEntry[] };
export type CommentRecords = {
current: Partial<Record<CommentTarget, PlatformRecord>>;
/** The last finished run's records, shown while the current run has no finished record of its own. */
previous?: Partial<Record<CommentTarget, PlatformRecord>>;
history: HistoryEntry[];
};
/** The id a record is keyed by. */
export function recordTarget(record: Pick<PlatformRecord, "platform" | "target">): CommentTarget {
@@ -146,12 +151,22 @@ export function compareTargets(a: { id: CommentTarget; order?: number | undefine
/** The current records in display order. */
export function orderedRecords(records: CommentRecords): PlatformRecord[] {
return Object.values(records.current).filter((record): record is PlatformRecord => Boolean(record))
return ordered(records.current);
}
/** The previous run's records in display order. */
export function orderedPrevious(records: CommentRecords): PlatformRecord[] {
return ordered(records.previous ?? {});
}
function ordered(records: Partial<Record<CommentTarget, PlatformRecord>>): PlatformRecord[] {
return Object.values(records).filter((record): record is PlatformRecord => Boolean(record))
.sort((a, b) => compareTargets({ id: recordTarget(a), order: a.order }, { id: recordTarget(b), order: b.order }));
}
export const HISTORY_LIMIT = 5;
const RECORD_LINE = /^<!-- expo-explore-record:([a-z][a-z0-9-]{0,31}):([A-Za-z0-9_-]+) -->$/gm;
const PREVIOUS_LINE = /^<!-- expo-explore-previous:([a-z][a-z0-9-]{0,31}):([A-Za-z0-9_-]+) -->$/gm;
const HISTORY_LINE = /^<!-- expo-explore-history:([A-Za-z0-9_-]+) -->$/m;
const MAX_ENCODED = 24_000;
const MAX_DECODED = 256_000;
@@ -176,6 +191,10 @@ export function recordLine(record: PlatformRecord): string {
return `<!-- expo-explore-record:${recordTarget(record)}:${encodeRecordPayload(record)} -->`;
}
export function previousLine(record: PlatformRecord): string {
return `<!-- expo-explore-previous:${recordTarget(record)}:${encodeRecordPayload(record)} -->`;
}
export function historyLine(history: HistoryEntry[]): string | undefined {
return history.length ? `<!-- expo-explore-history:${encodeRecordPayload(history)} -->` : undefined;
}
@@ -312,12 +331,18 @@ export function parseHistory(value: unknown): HistoryEntry[] {
export function readCommentRecords(body: string | undefined): CommentRecords {
const records: CommentRecords = { current: {}, history: [] };
if (!body) return records;
for (const match of body.matchAll(RECORD_LINE)) {
const record = parsePlatformRecord(decodePayload(match[2]!));
const target = record && recordTarget(record);
if (!record || target !== match[1] || !isTargetId(target)) continue;
if (records.current[target] || Object.keys(records.current).length < MAX_COMMENT_TARGETS) records.current[target] = record;
}
const read = (pattern: RegExp, into: Partial<Record<CommentTarget, PlatformRecord>>) => {
for (const match of body.matchAll(pattern)) {
const record = parsePlatformRecord(decodePayload(match[2]!));
const target = record && recordTarget(record);
if (!record || target !== match[1] || !isTargetId(target)) continue;
if (into[target] || Object.keys(into).length < MAX_COMMENT_TARGETS) into[target] = record;
}
};
read(RECORD_LINE, records.current);
const previous: Partial<Record<CommentTarget, PlatformRecord>> = {};
read(PREVIOUS_LINE, previous);
if (Object.keys(previous).length) records.previous = previous;
const history = body.match(HISTORY_LINE);
if (history) records.history = parseHistory(decodePayload(history[1]!));
return records;
@@ -371,14 +396,43 @@ export function foldRecord(existing: CommentRecords, incoming: PlatformRecord):
const record = withKnownTarget(incoming, existing);
const target = recordTarget(record);
const currentRun = current[0];
if (!currentRun && record.superseded) return { current: {}, history: pushHistory(existing.history, historyEntryOf([record])) };
const previous = existing.previous ?? {};
if (!currentRun && record.superseded) return { current: {}, previous, history: pushHistory(existing.history, historyEntryOf([record])) };
if (!currentRun || currentRun.runId === record.runId) {
return { current: { ...existing.current, [target]: record }, history: existing.history };
const next = { ...existing.current, [target]: record };
// A rerun's new attempt replaces a ready record with one that is not; the ready one stays readable meanwhile.
const replaced = existing.current[target];
const rerun = replaced && isReady(replaced) && !isReady(record) && Number(record.runAttempt) > Number(replaced.runAttempt);
return { current: next, previous: trimPrevious(rerun ? { ...ofRun(previous, record.runId), [target]: replaced } : previous, next), history: existing.history };
}
if (runOrder(currentRun.runId) > runOrder(record.runId) || record.superseded) {
return { current: existing.current, history: pushHistory(existing.history, historyEntryOf([{ ...record, superseded: true }])) };
return { current: existing.current, previous, history: pushHistory(existing.history, historyEntryOf([{ ...record, superseded: true }])) };
}
return { current: { [target]: record }, history: pushHistory(existing.history, historyEntryOf(current)) };
// The review of the run being replaced stays readable until the new run has a ready target. It replaces older
// previous records rather than joining them: what the comment shows as one review comes from one run. A run without a
// ready target has no review, so the one before it stays.
const kept = current.some(isReady) ? Object.fromEntries(current.filter(isFinished).map(item => [recordTarget(item), item])) : previous;
const next = { [target]: record };
return { current: next, previous: trimPrevious(kept, next), history: pushHistory(existing.history, historyEntryOf(current)) };
}
const isFinished = (record: PlatformRecord) => record.phase === "ready" || record.phase === "failed";
const isReady = (record: PlatformRecord) => record.phase === "ready";
function ofRun(records: Partial<Record<CommentTarget, PlatformRecord>>, runId: string): Partial<Record<CommentTarget, PlatformRecord>> {
return Object.fromEntries(Object.entries(records).filter(([, record]) => record?.runId === runId));
}
/**
* A target's previous record goes once its current one is ready; all of them go once every current record finished
* and one is ready. A failure is no review: the previous one stays up beside it.
*/
function trimPrevious(previous: Partial<Record<CommentTarget, PlatformRecord>>, current: Partial<Record<CommentTarget, PlatformRecord>>): Partial<Record<CommentTarget, PlatformRecord>> {
const records = Object.values(current).filter((record): record is PlatformRecord => Boolean(record));
if (records.every(isFinished) && records.some(isReady)) return {};
const trimmed = { ...previous };
for (const record of records) if (isReady(record)) delete trimmed[recordTarget(record)];
return trimmed;
}
/**
@@ -388,7 +442,7 @@ export function foldRecord(existing: CommentRecords, incoming: PlatformRecord):
function withKnownTarget(record: PlatformRecord, existing: CommentRecords): PlatformRecord {
const target = recordTarget(record);
if (!record.target || record.label !== undefined || record.order !== undefined) return record;
const known = existing.current[target];
const known = existing.current[target] ?? existing.previous?.[target];
if (known) return { ...record, platform: known.platform, ...(known.label !== undefined ? { label: known.label } : {}), ...(known.order !== undefined ? { order: known.order } : {}) };
const item = existing.history.find(entry => entry.platforms[target])?.platforms[target];
return item ? { ...record, ...(item.label !== undefined ? { label: item.label } : {}), ...(item.order !== undefined ? { order: item.order } : {}) } : record;
+22
View File
@@ -700,6 +700,28 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
...(options.token ? { token: options.token } : {}) });
}
/**
* The reports a fixture directory holds (scripts/refresh-viewer-preview-fixtures.sh writes it): its reports.json, as a
* hosted preview's /reports.json lists them, with `<target>.zip` beside it for each entry. An entry without a target,
* from fixtures refreshed before targets, is its platform's target with `<platform>.zip`.
*/
export function fixtureReports(listing: unknown, directory: string): FixturePreviewOptions["reports"] {
const invalid = () => previewError("PREVIEW_REPORTS_INVALID", "The fixtures' reports.json does not list valid reports",
"Refresh the fixtures with scripts/refresh-viewer-preview-fixtures.sh.");
if (!Array.isArray(listing)) throw invalid();
return listing.map((entry: unknown) => {
if (typeof entry !== "object" || entry === null) throw invalid();
const { platform, target: id, label, changes, device } = entry as Record<string, unknown>;
if (platform !== "ios" && platform !== "android") throw invalid();
const target = id === undefined ? undefined : readTarget({ id, platform, label });
if (id !== undefined && !target) throw invalid();
return {
platform, ...(target ? { target } : {}), zipPath: join(directory, `${target?.id ?? platform}.zip`),
...(typeof changes === "number" ? { changes } : {}), ...(typeof device === "string" ? { device } : {}),
};
});
}
/**
* Report ZIPs on this machine behind one token (`capture:review --upload`, `report:upload`), one per target: the same
* sealed deployment as a PR preview, from ZIPs instead of GitHub artifacts, with the local EAS login or EXPO_TOKEN.
+2
View File
@@ -268,6 +268,7 @@ export type CaptureReviewOptions = {
/** Build the validated review independently of where its metadata and images will be stored. */
async function constructCaptureReview(options: CaptureReviewOptions, store: ScreenshotStore) {
const plan = validateCapturePlan(options.plan);
const excluded = new Set(plan.excludedSurfaceIds ?? []);
const pr = projectReviewPresentation(options.pullRequest);
if (pr.head.sha !== plan.headSha || pr.base.sha !== plan.baseSha) throw new Error("PR identity differs from capture plan");
const run = `${identifier(options.runId)}-${identifier(options.runAttempt)}`;
@@ -341,6 +342,7 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
return { id, status, base: headOnly ? null : withId(s.baseSurface), head: withId(s.headSurface),
...(colorSchemes.length > 1 ? { colorScheme: scheme } : {}),
...(s.sourceChange ? { sourceChange: s.sourceChange } : {}),
...(excluded.has(s.id) ? { excluded: true as const } : {}),
...(impactKinds(s).length ? { sourceImpact: impactKinds(s) } : {}),
...(!headOnly && surfaceSourceScope(s) ? { sourceScope: surfaceSourceScope(s)! } : {}),
...(baseOutcome ? { baseOutcome } : {}),
+66 -16
View File
@@ -26,7 +26,7 @@ import {
type VisualEvidenceAssessment,
} from "./visual-evidence.js";
import { AGENT_DEVICE_VERSION } from "../shared/agent-device-version.js";
import { STATUS_BAR_BAND_PERCENT } from "../shared/png-evidence.js";
import { STATUS_BAR_BAND_PERCENT, decodePng, differentPixelsInRect, maxColorDistance, type DecodedFrame } from "../shared/png-evidence.js";
import { measureRegionShifts } from "./region-shift.js";
export const DEFAULT_VISUAL_THRESHOLD = 0.1;
@@ -171,31 +171,80 @@ export function ignoreStatusBar(measurement: ScreenshotDiffMeasurement, bandPerc
return { measurement: bands.measurement, ignored: bands.ignoredTop };
}
/** Both frames a measurement compared, decoded on demand: only a region that crosses a band's edge needs them. */
export type SystemBandFrames = { baseline: DecodedFrame; current: DecodedFrame; distance: number };
export type SystemBandFrameLoader = () => SystemBandFrames | undefined;
/** Reads the measurement's two screenshots when a band's edge has to be resolved pixel by pixel. */
export function systemBandFrameLoader(measurement: ScreenshotDiffMeasurement, threshold: number): SystemBandFrameLoader {
return () => {
try {
const baseline = decodePng(readFileSync(measurement.baselinePath)); const current = decodePng(readFileSync(measurement.currentPath));
if (!baseline || !current || baseline.width !== current.width || baseline.height !== current.height) return undefined;
return { baseline, current, distance: maxColorDistance(threshold) };
} catch { return undefined; }
};
}
/**
* Leaves out of a measurement every diff region that lies entirely inside the system's bands: the status bar at the
* top and, on iOS, the home indicator at the bottom. Both are drawn by the OS and differ between captures without
* the app having changed. A region that crosses into the app's area is kept whole.
* Leaves out of a measurement every diff region that lies inside the system's bands: the status bar at the top and,
* on iOS, the home indicator at the bottom. Both are drawn by the OS and differ between captures without the app
* having changed. A region that crosses a band's edge is clipped to the part below (above) it when the frames can be
* read: its pixels inside the band are dropped, and it stays only for what differs in the app's area.
* Without frames such a region is kept whole, as before. (A region's pixel count is its own cluster's, while its rect
* can overlap other regions, so what it keeps is counted outside the band and clamped to its own count.)
*/
export function ignoreSystemBands(measurement: ScreenshotDiffMeasurement, bands: { top: number; bottom: number }):
export function ignoreSystemBands(measurement: ScreenshotDiffMeasurement, bands: { top: number; bottom: number }, frames?: SystemBandFrameLoader):
{ measurement: ScreenshotDiffMeasurement; ignoredTop: number; ignoredBottom: number } {
if (measurement.match || measurement.regions.length === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
const inTop = (region: VisualDiffRegion) => bands.top > 0 && region.normalizedRect.y + region.normalizedRect.height <= bands.top;
const inBottom = (region: VisualDiffRegion) => bands.bottom > 0 && region.normalizedRect.y >= 100 - bands.bottom;
const inBand = (region: VisualDiffRegion) => inTop(region) || inBottom(region);
const ignoredRegions = measurement.regions.filter(inBand);
if (ignoredRegions.length === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
const ignoredPixels = ignoredRegions.reduce((total, region) => total + region.differentPixels, 0);
const crossesTop = (region: VisualDiffRegion) => bands.top > 0 && !inTop(region) && region.normalizedRect.y < bands.top;
const crossesBottom = (region: VisualDiffRegion) => bands.bottom > 0 && !inBottom(region) && region.normalizedRect.y + region.normalizedRect.height > 100 - bands.bottom;
let loaded: SystemBandFrames | undefined | null = null;
const load = () => { if (loaded === null) loaded = frames?.() ?? undefined; return loaded; };
let ignoredTop = 0; let ignoredBottom = 0; let ignoredPixels = 0;
const remaining: VisualDiffRegion[] = [];
for (const region of measurement.regions) {
if (inTop(region)) { ignoredTop += 1; ignoredPixels += region.differentPixels; continue; }
if (inBottom(region)) { ignoredBottom += 1; ignoredPixels += region.differentPixels; continue; }
const top = crossesTop(region); const bottom = crossesBottom(region);
const decoded = top || bottom ? load() : undefined;
if (!decoded) { remaining.push(region); continue; }
const { height, width } = decoded.baseline;
const bandRows = Math.floor((height * bands.top) / 100); const indicatorStart = height - Math.floor((height * bands.bottom) / 100);
const rect = { ...region.rect };
if (top) { const rows = Math.max(0, Math.min(rect.y + rect.height, bandRows) - rect.y); rect.y += rows; rect.height -= rows; }
if (bottom) rect.height = Math.min(rect.y + rect.height, indicatorStart) - rect.y;
// Counted in what is left of the rect, not in what the band takes: the rect can enclose another region's pixels,
// which can only add to what is kept (up to the region's own count), never take from it.
const differentPixels = rect.height > 0 ? Math.min(region.differentPixels, differentPixelsInRect(decoded.baseline, decoded.current, rect, decoded.distance)) : 0;
const inside = region.differentPixels - differentPixels;
if (differentPixels === 0) {
if (top) ignoredTop += 1; else ignoredBottom += 1;
ignoredPixels += region.differentPixels;
continue;
}
// Its pixels inside the band were left out too, so the band is marked as not compared, as for a dropped region.
if (inside > 0) { if (top) ignoredTop += 1; if (bottom) ignoredBottom += 1; }
ignoredPixels += inside;
const round = (value: number) => Math.round(value * 100) / 100;
remaining.push({ ...region, rect, differentPixels,
normalizedRect: { x: round((rect.x / width) * 100), y: round((rect.y / height) * 100), width: round((rect.width / width) * 100), height: round((rect.height / height) * 100) } });
}
if (ignoredPixels === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
const differentPixels = Math.max(0, measurement.differentPixels - ignoredPixels);
const remaining = measurement.regions.filter((region) => !inBand(region));
const regions = remaining.map((region) => ({ ...region,
shareOfDiffPercentage: differentPixels > 0 ? Math.round((region.differentPixels / differentPixels) * 10000) / 100 : 0 }));
return {
ignoredTop: ignoredRegions.filter(inTop).length,
ignoredBottom: ignoredRegions.filter((region) => !inTop(region)).length,
ignoredTop,
ignoredBottom,
measurement: {
...measurement,
differentPixels,
mismatchPercentage: measurement.totalPixels > 0 ? Math.round((differentPixels / measurement.totalPixels) * 10000) / 100 : 0,
match: differentPixels === 0 || remaining.length === 0,
regions: remaining,
match: differentPixels === 0 || regions.length === 0,
regions,
},
};
}
@@ -476,7 +525,7 @@ export async function assessPublicEvidence(options: {
} else {
try {
const raw = await measure(basePath, headPath);
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) }, systemBandFrameLoader(raw, threshold));
assessment = assessVisualMeasurements({
baselineSamples: 1,
currentSamples: 1,
@@ -544,7 +593,8 @@ export async function assessPublicEvidence(options: {
const basePath = localEvidencePath(options.base, baseLaunch.splash.path); const headPath = localEvidencePath(options.head, headLaunch.splash.path);
if (!basePath || !headPath) continue;
try {
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(await measure(basePath, headPath), { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
const raw = await measure(basePath, headPath);
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) }, systemBandFrameLoader(raw, threshold));
const visual = visualVerdict(assessVisualMeasurements({ baselineSamples: 1, currentSamples: 1, requiredSamples: 1,
baselineWithin: [], currentWithin: [], crossBuild: [measurement], representative: measurement }), threshold);
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
+11 -2
View File
@@ -17,7 +17,7 @@ import type {
ObservedElement,
Screen,
} from "../types.js";
import type { VisualEvidenceAssessment } from "./visual-evidence.js";
import type { VisualDiffRegion, VisualEvidenceAssessment } from "./visual-evidence.js";
import { CAPTURE_OBSERVER_IDENTIFIER, parseCaptureDestination } from "../capture/observer.js";
export type StableReviewerElementAnnotation = {
@@ -925,11 +925,20 @@ function visualFact(
fact: supported({ kind: "visual-changed", scope: { kind: "landmark", label } }, refs),
};
}
const near = nearEdge(input.visualAssessment.representative?.regions ?? []);
return {
fact: supported({ kind: "visual-changed", scope: { kind: "main-content" } }, refs),
fact: supported({ kind: "visual-changed", scope: { kind: "main-content", ...(near ? { near } : {}) } }, refs),
};
}
/** Which edge every diff region hugs, when all of them sit in the outer 12 % of the frame: not "the main content". */
function nearEdge(regions: readonly VisualDiffRegion[]): "top" | "bottom" | undefined {
if (regions.length === 0) return undefined;
if (regions.every((region) => region.normalizedRect.y + region.normalizedRect.height <= 12)) return "top";
if (regions.every((region) => region.normalizedRect.y >= 88)) return "bottom";
return undefined;
}
function comparisonForAdded(head: RuntimeEvidence): RuntimeEvidenceComparison {
return {
contract: RUNTIME_EVIDENCE_COMPARISON_CONTRACT,
+2 -2
View File
@@ -121,7 +121,7 @@ export type VisualReviewerChange = {
kind: "visual-changed";
scope:
| { kind: "landmark"; label: string }
| { kind: "main-content" };
| { kind: "main-content"; near?: "top" | "bottom" };
};
/**
@@ -466,7 +466,7 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
fact: {
category: "visual",
templateId: "visual.main-content-changed",
bullet: "Updated visual styling in the main content area.",
bullet: change.scope.near ? `Updated visual styling near the ${change.scope.near} of the screen.` : "Updated visual styling in the main content area.",
subjectRole: "content",
subjectLabel: "Main content",
priority: PRIORITY.visual,
+34
View File
@@ -38,6 +38,40 @@ export function frameChangedForTap(first: DecodedFrame, second: DecodedFrame, y:
return !first.data.subarray(start).equals(second.data.subarray(start));
}
/** The decoded frame, or undefined when the bytes are not a PNG pngjs can read. */
export function decodePng(png: Buffer): DecodedFrame | undefined {
try { return createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs").PNG.sync.read(png, { checkCRC: false }) as DecodedFrame; }
catch { return undefined; }
}
/** agent-device's rule for a changed pixel: an RGB distance above `threshold` of the longest diagonal. */
export function maxColorDistance(threshold: number): number {
return threshold * Math.sqrt(3 * 255 ** 2);
}
/** How many pixels of `rect` (clipped to the frames) differ between two same-sized frames by agent-device's rule. */
export function differentPixelsInRect(
first: DecodedFrame,
second: DecodedFrame,
rect: { x: number; y: number; width: number; height: number },
distance: number,
): number {
if (first.width !== second.width || first.height !== second.height) return 0;
const left = Math.max(0, rect.x); const right = Math.min(first.width, rect.x + rect.width);
const top = Math.max(0, rect.y); const bottom = Math.min(first.height, rect.y + rect.height);
let count = 0;
for (let y = top; y < bottom; y += 1) {
for (let x = left; x < right; x += 1) {
const offset = (y * first.width + x) * 4;
const r = first.data[offset]! - second.data[offset]!;
const g = first.data[offset + 1]! - second.data[offset + 1]!;
const b = first.data[offset + 2]! - second.data[offset + 2]!;
if (Math.sqrt(r * r + g * g + b * b) > distance) count += 1;
}
}
return count;
}
export function assertDecodedPng(contents: Buffer, label: string): void {
const signature = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
if (contents.length < 45 || !contents.subarray(0, 8).equals(signature)) {
+11 -2
View File
@@ -2,6 +2,7 @@ import { createHash } from "node:crypto";
import { canonicalizeSourceChanges, type SourceChange } from "./git-diff.js";
import type { SourceChangeSummary } from "./change-summary.js";
import { hasRuntimeChange, readSourceSnapshot, surfaceDependencies, type SourceSnapshot } from "./dependency-graph.js";
import { sameCodeIgnoringTrivia } from "./trivia.js";
import { discoverRoutes, type DiscoverRouteOptions } from "./route-inventory.js";
import { sourceRouteNames, validateSourceRoutes, type SourceRoute } from "../contracts/source-route.js";
import { navigationCaptureContext, type NavigationGraph } from "../contracts/navigation-graph.js";
@@ -120,7 +121,15 @@ export function createSourceCapturePlan(options: CapturePlanOptions): SourceCapt
const headRoutes = checkedRoutes(options.headRoutes, headInventory.routes, "head");
const base = surfaceDependencies(baseRoutes, options.baseFiles, options.platform);
const head = surfaceDependencies(headRoutes, options.headFiles, options.platform);
const changes = canonicalizeSourceChanges(options.changedFiles).filter(change => !/(?:^|\/)surfaces?\.json$/.test(change.path));
// A file whose two versions differ only in comments or whitespace compiles to the same program, so it changes no screen.
// Parsed once per path: every surface that imports a shared file asks about it.
const trivia = new Map<string, boolean>();
const triviaOnly = (path: string) => {
if (!trivia.has(path)) trivia.set(path, sameCodeIgnoringTrivia(path, options.baseFiles.get(path), options.headFiles.get(path)));
return trivia.get(path)!;
};
const changes = canonicalizeSourceChanges(options.changedFiles).filter(change => !/(?:^|\/)surfaces?\.json$/.test(change.path)
&& !(change.status === "modified" && triviaOnly(change.path)));
const changedPaths = new Set(changes.flatMap(change => [change.path, ...("previousPath" in change ? [change.previousPath] : [])]));
const externalRuntimeChange = hasRuntimeChange(options.externalChanges ?? []);
const unresolved = [...new Set([...base.unresolved, ...head.unresolved,
@@ -138,7 +147,7 @@ export function createSourceCapturePlan(options: CapturePlanOptions): SourceCapt
const headSurface = headById.get(id) ?? null;
const dependencies = new Set([...(baseSurface?.sourceFiles ?? []), ...(headSurface?.sourceFiles ?? [])]);
const touched = [...changedPaths].filter(path => dependencies.has(path)).sort();
const sourceChanged = baseSurface && headSurface && [...dependencies].some(path => options.baseFiles.get(path) !== options.headFiles.get(path));
const sourceChanged = baseSurface && headSurface && [...dependencies].some(path => options.baseFiles.get(path) !== options.headFiles.get(path) && !triviaOnly(path));
const definitionChanged = baseSurface && headSurface && canonicalJSON(baseSurface) !== canonicalJSON(headSurface);
// A redirect renders no interface: only its own declaration can change what it does, so
// imported or app-wide edits cannot make it a reviewable difference.
+18 -8
View File
@@ -3,6 +3,7 @@ import ts from "typescript";
import { parseTwoDotNameStatus, type SourceChange } from "./git-diff.js";
import type { SourceCapturePlan } from "./capture-plan.js";
import { DEFAULT_GLOBAL_IMPACT_PATHS } from "./impact.js";
import { sameCodeIgnoringTrivia } from "./trivia.js";
import { sourceImpactKinds, sourceImpactSentences } from "../contracts/source-change.js";
export type SourceLineRange = { start: number; end: number };
@@ -376,10 +377,13 @@ function changedPaths(change: SourceChange): string[] {
return [change.path, ...("previousPath" in change ? [change.previousPath] : [])];
}
/** A modified file whose program did not change (comments or whitespace only) leaves no evidence: it changes no screen. */
type FileEvidence = Omit<SourceFileChangeSummary, "relation"> | { triviaOnly: true };
function fileEvidence(options: {
baseProject: string; headProject: string; baseSha: string; headSha: string;
change: SourceChange; budget: { remaining: number };
}): Omit<SourceFileChangeSummary, "relation"> {
}): FileEvidence {
const { change } = options;
const previousPath = "previousPath" in change ? change.previousPath : undefined;
const base = readBlob(options.baseProject, options.baseSha, previousPath ?? change.path, options.budget);
@@ -392,6 +396,7 @@ function fileEvidence(options: {
baseStart: Number(match[1]), baseLines: Number(match[2] ?? 1),
headStart: Number(match[3]), headLines: Number(match[4] ?? 1),
}));
if (change.status === "modified" && !base.truncated && !head.truncated && sameCodeIgnoringTrivia(change.path, base.source, head.source)) return { triviaOnly: true };
const extracted = base.truncated || head.truncated ? undefined : codeFacts(change.path, base.source ?? "", head.source ?? "");
const facts = extracted?.length ? extracted : [{
kind: "code" as const,
@@ -461,7 +466,7 @@ export function createSourceChangeSummaries(options: {
], 4 * 1024 * 1024).stdout));
if (changes.length > SOURCE_CHANGE_SUMMARY_LIMITS.changedFiles) throw new Error("Source summary exceeds changed-file limit");
const globals = new Set<string>([...DEFAULT_GLOBAL_IMPACT_PATHS.filter((path) => !path.endsWith("/")), "tsconfig.json"]);
const cache = new Map<string, Omit<SourceFileChangeSummary, "relation">>();
const cache = new Map<string, FileEvidence>();
const budget = { remaining: SOURCE_CHANGE_SUMMARY_LIMITS.totalSourceBytes };
const summaries: Record<string, SourceChangeSummary> = {};
for (const surface of plan.surfaces) {
@@ -480,18 +485,23 @@ export function createSourceChangeSummaries(options: {
!/^(?:\.github\/|docs\/|tests?\/|scripts\/)|(?:\.md$|\.(?:test|spec)\.[jt]sx?$)/.test(path)
))));
}
const selected = relevant.sort((left, right) => {
const ranked = relevant.sort((left, right) => {
const rank = { route: 0, "declared-source": 1, dependency: 2, global: 3 };
return rank[relation(surface, left)] - rank[relation(surface, right)] || left.path.localeCompare(right.path);
}).slice(0, SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface);
const files = selected.map((change): SourceFileChangeSummary => {
});
// A comment-only file leaves no evidence, so it does not take one of the surface's file slots either.
const files: SourceFileChangeSummary[] = [];
let considered = 0;
for (const change of ranked) {
if (files.length === SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface) break;
considered += 1;
let evidence = cache.get(change.path);
if (!evidence) {
evidence = fileEvidence({ ...options, baseSha: plan.baseSha, headSha: plan.headSha, change, budget });
cache.set(change.path, evidence);
}
return { ...evidence, relation: relation(surface, change) };
});
if (!("triviaOnly" in evidence)) files.push({ ...evidence, relation: relation(surface, change) });
}
const impact: SourceChangeSummary["impact"] = files.some((file) => file.relation === "route" || file.relation === "declared-source")
? "direct" : files.some((file) => file.relation === "dependency") ? "dependency"
: globalImpact || (surface.status === "modified" && plan.conservative) ? "global"
@@ -501,7 +511,7 @@ export function createSourceChangeSummaries(options: {
baseSha: plan.baseSha, headSha: plan.headSha, impact,
summary: summaryText(surface, impact, files),
files,
truncated: relevant.length > selected.length || files.some((file) => file.truncated),
truncated: ranked.length > considered || files.some((file) => file.truncated),
};
}
return summaries;
+80
View File
@@ -0,0 +1,80 @@
import ts from "typescript";
const code = /\.([cm]?[jt]sx?)$/;
/** Comments a compiler or bundler reads: JSX pragmas, Flow, pure annotations, Fast Refresh, Haste names and import hints. */
const directive = /[@#]\s*(?:jsx\w*|flow|noflow|__[A-Z_]+__|refresh|providesModule)\b[^\r\n*]*|webpack[A-Z]\w*\s*:[^\r\n*]*|@vite-ignore/g;
function scriptKind(path: string): ts.ScriptKind {
const extension = code.exec(path)?.[1] ?? "";
if (extension === "tsx") return ts.ScriptKind.TSX;
if (extension.endsWith("ts")) return ts.ScriptKind.TS;
if (extension === "jsx") return ts.ScriptKind.JSX;
return ts.ScriptKind.JS;
}
/**
* JSX text as the JSX transform keeps it (Babel's `cleanJSXElementLiteralChild`): each line is trimmed where it meets a
* line break, blank lines are dropped and the rest are joined by a space. Space within a line is kept, and so is a tab.
*/
function jsxText(raw: string): string {
const lines = raw.split(/\r\n|\n|\r/);
let last = 0;
lines.forEach((line, index) => { if (/[^ \t]/.test(line)) last = index; });
let text = "";
lines.forEach((line, index) => {
let trimmed = index > 0 ? line.replace(/^[ \t]+/, "") : line;
if (index < lines.length - 1) trimmed = trimmed.replace(/[ \t]+$/, "");
if (trimmed) text += index === last ? trimmed : `${trimmed} `;
});
return text;
}
/**
* The program a file compiles to, in order: its syntax tree's nodes and tokens, JSX text as the transform keeps it, and
* any directive comment. Other comments and the whitespace between tokens are not part of it. The tree keeps a line
* break that changes the program (`return` then a value on the next line), and drops one that does not.
*/
function tokens(path: string, text: string): string[] | undefined {
const file = ts.createSourceFile(path, text, ts.ScriptTarget.Latest, false, scriptKind(path));
const { parseDiagnostics } = file as unknown as { parseDiagnostics?: unknown[] };
if (!parseDiagnostics || parseDiagnostics.length > 0) return undefined;
const out: string[] = [];
const directives = (trivia: string): void => {
for (const [match] of trivia.matchAll(directive)) out.push(`directive:${match.replace(/\s+/g, " ").trim()}`);
};
const visit = (node: ts.Node): void => {
if (ts.isJsxExpression(node) && !node.expression) return directives(text.slice(node.pos, node.end)); // `{/* a comment */}` compiles to nothing
if (node.kind >= ts.SyntaxKind.FirstJSDocNode && node.kind <= ts.SyntaxKind.LastJSDocNode) return; // a comment the parser attaches, read below as trivia
if (node.kind === ts.SyntaxKind.JsxText) {
const value = jsxText(text.slice(node.pos, node.end));
if (value) out.push(`${node.kind}:${value}`);
return;
}
if (node.getChildCount(file) === 0) {
directives(text.slice(node.pos, node.getStart(file)));
if (node.kind !== ts.SyntaxKind.EndOfFileToken) out.push(`${node.kind}:${node.getText(file)}`);
return;
}
out.push(`${node.kind}(`);
node.getChildren(file).forEach(visit);
out.push(")");
};
visit(file);
return out;
}
/**
* Whether two versions of a JavaScript or TypeScript file compile to the same program: the same syntax tree with the
* same tokens, so only comments, blank lines, indentation or line endings differ. Such an edit cannot change what a
* screen renders, so the planner does not treat it as a change to the files that import it. JSX text keeps the
* whitespace the transform keeps (a space inside a `<Text>` renders), a comment a compiler reads (`@jsx`, `#__PURE__`)
* counts, a file that does not parse is never called the same, and neither are two identical texts: a diff entry a
* caller supplies for them is theirs to explain (a mode change, a fixture).
*/
export function sameCodeIgnoringTrivia(path: string, base: string | undefined, head: string | undefined): boolean {
if (base === undefined || head === undefined || !code.test(path)) return false;
if (base === head) return false;
const before = tokens(path, base);
const after = before && tokens(path, head);
return Boolean(before && after && before.length === after.length && before.every((token, index) => token === after[index]));
}
+96 -7
View File
@@ -88,6 +88,8 @@ async function harness(t, bytes, { app = false, open = true, name = fileName, re
preview.requests = (preview.requests ?? 0) + 1;
preview.queries = [...(preview.queries ?? []), url.search];
if (preview.status && preview.status !== 200) { response.statusCode = preview.status; return response.end(preview.body ?? "Not found"); }
// A target the Worker cannot read (`failures` by query) answers with that status.
if (preview.failures?.[url.search]) { response.statusCode = preview.failures[url.search]; return response.end("Unavailable"); }
response.setHeader("content-type", "application/json");
// A slow target (`delays` by query) keeps its manifest in flight while the reviewer moves on.
// `padding` makes the manifest larger than the Viewer reads.
@@ -272,6 +274,8 @@ test("choosing the report file opens it with the link's selection and keeps Modi
await expect(page.locator("html")).toHaveAttribute("data-theme", "light");
await page.getByRole("button", { name: "Screens", exact: true }).click();
const screenshot = page.locator(".screens-page img[data-screenshot-src]").first();
// The placeholder is the screenshot's size too, so wait for the screenshot itself.
await expect(screenshot).toHaveAttribute("data-screenshot-state", "ready");
await expect.poll(() => screenshot.evaluate(image => image.naturalWidth)).toBe(32);
const screenshotUrl = await screenshot.getAttribute("src");
assert.match(page.url(), /#\/screens/);
@@ -328,6 +332,8 @@ test("a reload and a later per-screen link reopen the dropped report from the br
await expect(page.getByText("Greeting changed from Hello to Welcome", { exact: true })).toBeVisible();
await page.getByRole("button", { name: "Screens", exact: true }).click();
const screenshot = page.locator(".screens-page img[data-screenshot-src]").first();
// The placeholder is the screenshot's size too, so wait for the screenshot itself.
await expect(screenshot).toHaveAttribute("data-screenshot-state", "ready");
await expect.poll(() => screenshot.evaluate(image => image.naturalWidth)).toBe(32);
// Comment links to one screen carry the same run identity, so they open without a new drop.
await page.goto(`${origin}/r?${new URLSearchParams(identity)}&screen=home&inspect=diff`);
@@ -541,6 +547,30 @@ test("switching back to a prefetched target shows the screenshots it showed befo
assert.deepEqual(errors, []);
});
test("a target whose download fails leaves the report on screen and its link, and a toast says why", { timeout: 60_000 }, async t => {
const report = reportFixture();
report.review.runtime = { ...report.review.runtime, platform: "android", platforms: ["ios", "android"] };
const preview = { token: "mnopqrstuvwxyz234567234567234567", listing: [{ platform: "ios" }, { platform: "android" }],
failures: { "?platform=ios": 500 } };
const { page, errors } = await harness(t, await archive(report), { app: true, reportIdentity: null, preview, query: "&platform=android" });
const trigger = page.getByRole("button", { name: "Platform: Android. Open another platform's report" });
await expect(trigger).toBeVisible();
await page.evaluate(() => { window.__samePage = true; });
const place = new URL(page.url()).hash;
await trigger.click();
await page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio").nth(0).click();
await expect(page.locator(".app-toast")).toContainText("Couldn’t open iOS");
await expect(page.locator(".app-toast")).toContainText("The report could not be downloaded (HTTP 500).");
await expect(page.locator(".app-shell")).toBeVisible();
await expect(page.locator(".report-loading-shell")).toHaveCount(0);
await expect(trigger).not.toHaveAttribute("aria-busy", /.*/);
// The link is the Android report's again, at the place it was.
await expect.poll(() => new URL(page.url()).searchParams.get("platform")).toBe("android");
assert.equal(new URL(page.url()).hash, place);
assert.equal(await page.evaluate(() => window.__samePage), true, "the failed switch stays on the page");
assert.deepEqual(errors, []);
});
test("Forward onto a target still downloading keeps the preview link and its place in history", { timeout: 60_000 }, async t => {
const { page, errors, switchToIos } = await slowSwitchHarness(t, "jklmnopqrstuvwxyz234567234567234", 3000);
await page.evaluate(() => { window.location.hash = "#/map?inspect=diff"; });
@@ -563,6 +593,60 @@ test("Forward onto a target still downloading keeps the preview link and its pla
assert.deepEqual(errors, []);
});
test("a switch to a target whose screenshots have another shape lays the map out again for its cards, so none overlap", { timeout: 60_000 }, async t => {
const targets = [
{ id: "iphone", platform: "ios", label: "iPhone 17" },
{ id: "duo-open", platform: "ios", label: "iPhone Duo (open)" },
];
// Home leads to Settings and About, Settings on to Profile: three layers, so the map runs left to right with
// Settings and About stacked, a card's height plus a gap apart. A Duo card is shorter than a phone's.
const shaped = async (target, width, height) => {
const picture = new PNG({ width, height });
picture.data.fill(255);
const capture = PNG.sync.write(picture);
const report = reportFixture();
const home = report.review.surfaces[0];
for (const side of ["baseImage", "headImage"]) {
Object.assign(home[side], { width, height, sha256: createHash("sha256").update(capture).digest("hex") });
}
const route = id => {
const side = { ...home.head, id, route: `/${id}`, path: `/${id}`, routeFile: `app/${id}.tsx`, logicalPath: `app/${id}.tsx` };
return { id, status: "unchanged", base: { ...side }, head: side, baseImage: { ...home.baseImage }, headImage: { ...home.headImage },
baseOutcome: { ...home.baseOutcome }, headOutcome: { ...home.headOutcome } };
};
report.review.surfaces.push(route("settings"), route("about"), route("profile"));
const edge = (from, to) => ({ from, to, kind: "push", provenance: "source", sourceFile: `app/${from}.tsx` });
const graph = { contract: "explore.navigation", edges: [edge("home", "settings"), edge("home", "about"), edge("settings", "profile")],
modalSurfaceIds: [], unresolved: [] };
report.review.navigation = { base: structuredClone(graph), head: graph };
report.review.runtime = { ...report.review.runtime, platform: "ios", platforms: ["ios"], target: targets.find(entry => entry.id === target), targets };
return Buffer.from((await imageArchive([capture], 0, report)).bytes);
};
const preview = { token: "klmnopqrstuvwxyz2345672345672345",
listing: targets.map(({ id, platform, label }) => ({ target: id, platform, label })),
archives: { "?target=iphone": await shaped("iphone", 130, 282) } };
const { page, errors } = await harness(t, await shaped("duo-open", 233, 339), { app: true, reportIdentity: null, preview,
query: "&target=duo-open" });
const nodes = page.locator(".map-canvas .react-flow__node");
await expect(nodes).toHaveCount(4);
/** Overlaps between the cards' boxes on screen, and how tall the cards stand against their width. */
const layout = () => nodes.evaluateAll(elements => {
const boxes = elements.map(element => element.getBoundingClientRect());
let overlaps = 0;
for (const [index, a] of boxes.entries()) for (const b of boxes.slice(index + 1)) {
if (a.left < b.right - 1 && b.left < a.right - 1 && a.top < b.bottom - 1 && b.top < a.bottom - 1) overlaps += 1;
}
return { overlaps, shape: Math.round(boxes[0].height / boxes[0].width * 10) / 10 };
});
await expect.poll(layout).toEqual({ overlaps: 0, shape: 1.6 });
await page.getByRole("button", { name: "Device: iPhone Duo (open). Open another device's report" }).click();
await page.getByRole("menu", { name: "Device" }).getByRole("menuitemradio").nth(0).click();
await expect(page.locator(".collapsed-platform").first()).toHaveText("iPhone 17");
await expect.poll(layout, { timeout: 10_000 }).toEqual({ overlaps: 0, shape: 2.3 });
assert.deepEqual(errors, []);
});
test("a hosted manifest larger than the Viewer reads is refused before it is parsed", { timeout: 60_000 }, async t => {
const preview = { token: "klmnopqrstuvwxyz2345672345672345", padding: 11 * 1024 * 1024 };
const { page, errors } = await harness(t, await archive(), { app: true, reportIdentity: null, preview, query: "" });
@@ -588,11 +672,13 @@ test("D, ⌥1–⌥8 and ` switch targets from the keyboard, and the other repor
const place = new URL(page.url()).hash;
await page.evaluate(() => { window.__samePage = true; });
const target = () => new URL(page.url()).searchParams.get("platform");
// The other report swaps into the running Viewer (no loading screen between): the pill names it once it is up.
const shown = async (label) => expect(page.locator(".collapsed-platform").first()).toHaveText(label);
// ` returns to the last target; before there is one, it opens the next in the menu.
await page.keyboard.press("Backquote");
await expect.poll(target).toBe("ios");
await expect(page.locator(".app-shell")).toBeVisible();
await shown("iOS");
const carried = new URL(page.url()).hash;
assert.equal(carried.split("?")[0], place.split("?")[0], "the other report opens at the same canvas and route");
assert.equal(new URLSearchParams(carried.split("?")[1]).get("inspect"), "diff");
@@ -600,9 +686,9 @@ test("D, ⌥1–⌥8 and ` switch targets from the keyboard, and the other repor
await expect(page.locator(".map-canvas .is-selected")).toHaveCount(1);
await page.keyboard.press("Backquote");
await expect.poll(target).toBe("android");
await shown("Android");
// D opens the menu, which prints each target's ⌥ key.
await expect(page.locator(".app-shell")).toBeVisible();
await page.keyboard.press("KeyD");
const items = page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio");
await expect(items).toHaveCount(2);
@@ -612,11 +698,12 @@ test("D, ⌥1–⌥8 and ` switch targets from the keyboard, and the other repor
await page.keyboard.press("Alt+Digit1");
await expect.poll(target).toBe("ios");
await expect(page.locator(".app-shell")).toBeVisible();
await shown("iOS");
// The shown target's own key does nothing.
await page.keyboard.press("Alt+Digit1");
await page.keyboard.press("Alt+Digit2");
await expect.poll(target).toBe("android");
await shown("Android");
assert.equal(await page.evaluate(() => window.__samePage), true, "every switch stays on the page");
await page.keyboard.press("Shift+Slash");
@@ -1275,20 +1362,22 @@ test("a docs-only report with zero images and no EAS build opens Screens without
await page.getByRole("button", { name: "Screens", exact: true }).click();
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(1);
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(1);
// The Inspector's missing screenshot matches the canvas node: the icon above a short label,
// centred in a phone-shaped preview frame.
// The Inspector's missing screenshot matches the canvas node: the icon above a short label and
// the report's reason for the gap, centred in a phone-shaped preview frame.
await page.locator(".screens-page .screen-screenshot-target").click();
const placeholder = page.locator(".inspector .inspector-preview .screenshot-placeholder");
await expect(placeholder).toHaveText("No screenshot");
await expect(placeholder.locator("span")).toHaveText("No screenshot");
await expect(placeholder.locator(".screenshot-placeholder-detail")).toHaveText("Not compared; no capture was recorded");
const layout = await placeholder.evaluate(node => {
const box = element => element.getBoundingClientRect();
const frame = box(node.closest(".inspector-preview"));
const icon = box(node.querySelector("svg"));
const label = box(node.querySelector("span"));
const detail = box(node.querySelector(".screenshot-placeholder-detail"));
return { frameRatio: frame.width / frame.height, iconSize: [icon.width, icon.height], iconAboveLabel: icon.bottom <= label.top,
iconOffset: Math.abs(icon.left + icon.width / 2 - (frame.left + frame.width / 2)),
labelOffset: Math.abs(label.left + label.width / 2 - (frame.left + frame.width / 2)),
verticalOffset: Math.abs((icon.top + label.bottom) / 2 - (frame.top + frame.height / 2)),
verticalOffset: Math.abs((icon.top + detail.bottom) / 2 - (frame.top + frame.height / 2)),
labelSize: getComputedStyle(node.querySelector("span")).fontSize };
});
assert.deepEqual(layout.iconSize, [20, 20]);
+33 -1
View File
@@ -102,7 +102,7 @@ test("a recorded review opens on the real map and before/after evidence and surv
await expect(page.locator(".collapsed-pr")).toContainText("PR #1");
// The map is one card per screen; changed screens carry their diff status on the card.
await expect(page.locator(".map-canvas .react-flow__node-screen")).toHaveCount(33);
await expect(page.locator('.map-canvas .screen-screenshot-target[title="/games"]')).toBeVisible();
await expect(page.locator('.map-canvas .screen-node-title[aria-label="Copy deep link /games"]')).toBeVisible();
await expect(page.getByText("No report open")).toHaveCount(0);
const menu = await openChangesMenu(page);
// Changes lists the screens with something to see: the three with pixel changes, the added and the removed one.
@@ -416,6 +416,38 @@ test("the Screens tree folds by row, by keyboard, and all at once, and remembers
assert.deepEqual(errors, []);
});
test("a fold tried during a find changes nothing: the tree's own folds come back, and are what a reload remembers", { timeout: 60_000 }, async t => {
const { page, url, errors } = await openReport(t, { width: 1440, height: 900 });
await page.goto(`${url}#/screens`);
const tree = page.locator(".screens-tree");
await tree.getByRole("button", { name: /^All/ }).click();
const folder = tree.locator(".screens-tree-row.folder", { hasText: "onboarding/" });
const other = tree.locator(".screens-tree-row.folder").filter({ hasNotText: "onboarding/" }).first();
await expect(other).toHaveAttribute("aria-expanded", "true");
await folder.click();
await expect(folder).toHaveAttribute("aria-expanded", "false");
// While a find is on every row stays open; folding one there neither shows nor sticks.
await page.keyboard.press("/");
const field = page.getByRole("searchbox", { name: "Find screens" });
await field.fill("/");
await expect(folder).toHaveAttribute("aria-expanded", "true");
await other.click();
await page.keyboard.press("ArrowLeft");
await expect(other).toHaveAttribute("aria-expanded", "true");
await field.press("Escape");
await field.press("Escape");
await expect(field).toHaveCount(0);
await expect(folder).toHaveAttribute("aria-expanded", "false");
await expect(other).toHaveAttribute("aria-expanded", "true");
await page.reload();
await tree.getByRole("button", { name: /^All/ }).click();
await expect(folder).toHaveAttribute("aria-expanded", "false");
await expect(other).toHaveAttribute("aria-expanded", "true");
assert.deepEqual(errors, []);
});
test("dev opens the report ZIP named by EXPLORE_REPORT and preserves the explicit map API proxy", { timeout: 90_000 }, async t => {
const reportDev = await launcher(t, "scripts/dev-viewer.mjs", [], {
EXPLORE_DIR: "", EXPLORE_REPORT: fileURLToPath(REPORT), EXPLORE_DEV_PORT: String(await freePort()),
+84 -2
View File
@@ -35,6 +35,13 @@ export function resolveEmbeddedArtifactUrl(source, priority) {
window.pendingScreenshots.set(source, pending);
});
}
// \`window.shownReport\` stands in for the report the page shows; a hosted preview's target switch changes it.
export function leaseEmbeddedArtifactUrl(source, priority) {
const report = window.shownReport;
return { url: resolveEmbeddedArtifactUrl(source, priority),
release: () => { window.releasedFrom.push(report); return releaseEmbeddedArtifactUrl(source); },
current: () => window.shownReport === report };
}
`;
const entry = `
@@ -67,6 +74,7 @@ function Harness() {
width={120} height={80} loading={state.loading} decoding="async" className="captured-image"
data-screen="checkout" onLoad={loaded} onError={failed}
{...(state.indicator ? { indicator: state.indicator } : {})}
{...(state.holdPrevious ? { holdPrevious: true } : {})}
{...(state.fallback ? { fallback: <span data-testid="fallback">No screenshot</span> } : {})} />}
</div>
</main>;
@@ -121,6 +129,8 @@ async function fixture(t, options = {}) {
window.resolverCalls = [];
window.resolverPriorities = [];
window.releaseCalls = [];
window.shownReport = "android";
window.releasedFrom = [];
window.immediateScreenshots = new Map();
if (fixture.observer === "manual") {
// The test decides when the image enters or leaves the viewport, down to one task.
@@ -351,17 +361,19 @@ async function blobUrl(page, bytes) {
}
test("returning to a screenshot before the next one resolves waits for a fresh URL, never the released one", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", fallback: true });
const { page, image } = await fixture(t, { loading: "eager", fallback: true, indicator: "spinner" });
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
const released = await blobUrl(page, firstImage);
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: released });
await expectDecoded(image, 2, 3);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// A to B releases A's URL; while B still resolves, the report evicts and revokes it.
// A to B releases A's URL; while B still resolves, the report evicts and revokes it. Without `holdPrevious` (Compare,
// the Inspector) nothing of A stays up under B's name and outlines: B waits with its spinner.
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(secondSource);
await expectWaiting(image);
await expect(page.getByRole("status", { name: "Loading screenshot" })).toBeVisible();
await expect.poll(() => page.evaluate(() => window.releaseCalls)).toEqual([firstSource]);
await page.evaluate(url => URL.revokeObjectURL(url), released);
@@ -375,10 +387,80 @@ test("returning to a screenshot before the next one resolves waits for a fresh U
await expectDecoded(image, 2, 3);
await expect(image).toHaveAttribute("src", fresh);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
assert.deepEqual(await page.evaluate(() => window.imageErrors), []);
});
test("a new source keeps the picture before it on screen until it decodes; returning to the first waits for a fresh URL, never reloading the released one", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", fallback: true, holdPrevious: true });
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
const released = await blobUrl(page, firstImage);
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: released });
await expectDecoded(image, 2, 3);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// A to B releases A's URL, but A's picture stays up (nothing blanks while every screenshot of a report swaps at once);
// while B still resolves, the report evicts and revokes the URL behind it, which the decoded picture survives.
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(secondSource);
await expect(image).toHaveAttribute("src", released);
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
await expect(image).toHaveAttribute("aria-busy", "true");
await expect.poll(() => page.evaluate(() => window.releaseCalls)).toEqual([firstSource]);
await page.evaluate(url => URL.revokeObjectURL(url), released);
// Back to A before B resolves: A keeps the picture and waits for its new resolution instead of reloading the revoked URL.
await page.evaluate(source => window.updateScreenshot({ source }), firstSource);
await expect.poll(() => page.evaluate(source => window.resolverCalls.filter(value => value === source).length, firstSource)).toBe(2);
await expect(image).toHaveAttribute("src", released);
await expect(image).toHaveAttribute("aria-busy", "true");
const fresh = await blobUrl(page, firstImage);
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: fresh });
await expectDecoded(image, 2, 3);
await expect(image).toHaveAttribute("src", fresh);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(page.getByTestId("fallback")).toHaveCount(0);
assert.deepEqual(await page.evaluate(() => window.imageErrors), []);
});
test("a held picture is not handed on past a source that failed: the next source waits on its own stand-in", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", fallback: true, holdPrevious: true });
const first = await blobUrl(page, firstImage);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: first });
await expectDecoded(image, 2, 3);
// A to B, which cannot be read: B's fallback, with A's picture gone with it.
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(secondSource);
await expect(image).toHaveAttribute("src", first);
await page.evaluate(source => window.rejectScreenshot(source), secondSource);
await expect(page.getByTestId("fallback")).toHaveText("No screenshot");
// On to C: A's picture does not come back under C while C resolves.
await page.evaluate(source => window.updateScreenshot({ source }), thirdSource);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(thirdSource);
await expectWaiting(image);
});
test("a target switch that drops a screenshot still waiting asks the report shown next, which holds the same one", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", fallback: true });
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
// The Viewer swaps in the other target's report; the same screenshot keeps its source, so this image stays mounted.
// Trimming the report it waited on rejects the wait.
await page.evaluate(source => { window.shownReport = "ios"; window.rejectScreenshot(source); }, firstSource);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource, firstSource]);
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
await resolveImage(page, firstSource);
await expectDecoded(image, 2, 3);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
assert.deepEqual(await page.evaluate(() => window.imageErrors), []);
// Let go after switching back, it releases to the report that resolved it, not the one shown.
await page.evaluate(() => { window.shownReport = "android"; window.updateScreenshot({ mounted: false }); });
await expect.poll(() => page.evaluate(() => window.releasedFrom)).toEqual(["ios"]);
});
test("a fresh URL for a screenshot that failed to decode gives it another try", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { layout: "pan", loading: "lazy" });
const positioner = page.getByTestId("positioner");
+371 -10
View File
@@ -127,6 +127,13 @@ async function expectMapScreenSelectionDimming(
}));
const hoverTargetCount = options.hoverTargetCount ?? 1;
expect(hoverableDimmedIndexes.length).toBeGreaterThanOrEqual(hoverTargetCount);
// A card fades through its frame's --map-card-opacity (the node itself stays opaque over the
// connectors). The property is not animated, so it reads what hover asks for at once.
const cardOpacities = () => screens.evaluateAll((nodes) => Object.fromEntries(nodes.map((node) => [
node.getAttribute("data-id") ?? "",
getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim(),
])));
const restingOpacities = await cardOpacities();
let lastHoverTarget = dimmed.nth(hoverableDimmedIndexes[0]!);
for (const index of hoverableDimmedIndexes.slice(0, hoverTargetCount)) {
@@ -149,7 +156,9 @@ async function expectMapScreenSelectionDimming(
return label.startsWith(`Edge from ${nodeId} to `) || label.endsWith(` to ${nodeId}`);
}).length, hoverTargetId!);
expect(directEdgeCount).toBeGreaterThan(0);
// The hovered screen and every screen it shares an edge with stay bright; the rest recede.
// The hovered screen and every screen it shares an edge with are marked related; nothing on
// the map recedes while hovering, so the only changes are the subject ring, the incident
// edges and the neighbours' frames.
const neighbourIds = await allEdges.evaluateAll((edges, nodeId) => {
const ids = new Set<string>([nodeId]);
for (const edge of edges) {
@@ -166,14 +175,15 @@ async function expectMapScreenSelectionDimming(
await expect.poll(() => brightNodes.evaluateAll((nodes) => (
nodes.map((node) => node.getAttribute("data-id") ?? "").sort()
))).toEqual(neighbourIds);
const receded = page.locator(
".map-canvas .react-flow__node-screen:not(.graph-node-hover-related)",
const unrelated = page.locator(
".map-canvas .react-flow__node-screen:not(.graph-node-hover-related):not(.canvas-node-exit)",
);
if (await receded.count() > 0) {
await expect.poll(() => receded.first().evaluate(
(node) => Number.parseFloat(getComputedStyle(node).opacity),
)).toBeGreaterThan(0.5);
}
const unrelatedIds = await unrelated.evaluateAll((nodes) => nodes.map((node) => node.getAttribute("data-id") ?? ""));
expect(unrelatedIds.length).toBeGreaterThan(0);
const hoverOpacities = await cardOpacities();
expect(unrelatedIds.map((id) => hoverOpacities[id])).toEqual(unrelatedIds.map((id) => restingOpacities[id]));
expect(await unrelated.evaluateAll((nodes) => nodes.every((node) => getComputedStyle(node).filter === "none"))).toBe(true);
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
const activeEdges = page.locator(
".map-canvas .react-flow__edge.graph-edge-hover-related",
);
@@ -1998,6 +2008,148 @@ test("fits the visible Map screenshot frame to the capture's intrinsic ratio", a
expect(metrics.slotBackground).toBe("rgba(0, 0, 0, 0)");
});
/** Each Map card's --map-card-opacity by id: what fades its frame. The property is not animated. */
function mapCardOpacities(page: Page) {
return page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)").evaluateAll((nodes) => (
Object.fromEntries(nodes.map((node) => [
node.getAttribute("data-id") ?? "",
getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim(),
]))
));
}
/** Waits until the Map camera stops moving. */
async function expectMapCameraAtRest(page: Page) {
await expect(page.locator(".map-canvas.canvas-focus-animating")).toHaveCount(0);
const viewport = page.locator(".map-canvas .react-flow__viewport");
let transform = "";
await expect.poll(async () => {
const next = await viewport.evaluate((element) => getComputedStyle(element).transform);
const resting = next === transform;
transform = next;
return resting;
}).toBe(true);
}
/** The first `candidates` card whose screenshot is under the pointer near its top, with `room` above and below. */
async function hoverableMapScreen(candidates: Locator, room = 80) {
const index = await candidates.evaluateAll((nodes, room) => nodes.findIndex((node) => {
const target = node.querySelector(".screen-screenshot-target")!.getBoundingClientRect();
const hit = document.elementFromPoint(target.left + target.width / 2, target.top + target.height / 4);
return hit !== null && node.contains(hit) && target.top > room && target.bottom < window.innerHeight - room;
}), room);
expect(index).toBeGreaterThanOrEqual(0);
return candidates.nth(index);
}
test("hovering a Map screen fades nothing and says Open in Inspector in a tooltip below the card that keeps to it", async ({ page }) => {
await serveSyntheticWorkspace(page);
await page.goto("/map");
const screens = page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)");
await expect(screens.first()).toBeVisible();
await expectMapCameraAtRest(page);
const resting = await mapCardOpacities(page);
// A screen at one end of a secondary transition, which rests a little faded.
const secondaryEnds = await page.locator(".map-canvas .react-flow__edge.graph-edge-secondary").evaluateAll((edges) => (
[...new Set(edges.flatMap((edge) => /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "")?.slice(1) ?? []))]
));
expect(secondaryEnds.length).toBeGreaterThan(0);
const node = await hoverableMapScreen(page.locator(
secondaryEnds.map((id) => `.map-canvas .react-flow__node-screen[data-id="${id}"]`).join(", "),
));
const target = node.locator(".screen-screenshot-target");
const heading = node.locator(".screen-node-heading");
// The tooltip says what a click does; no native title tooltip joins it.
await expect(target).not.toHaveAttribute("title");
// Near the card's top, so the pan below keeps the pointer on it.
const box = (await target.boundingBox())!;
await target.hover({ position: { x: box.width / 2, y: box.height / 4 } });
await expect(page.locator(".connection-canvas-surface.canvas-hovering")).toHaveCount(1);
const tooltip = page.locator(".tooltip", { hasText: "Open in Inspector" });
await expect(tooltip).toBeVisible();
const related = await page.locator(".map-canvas .react-flow__node-screen.graph-node-hover-related")
.evaluateAll((nodes) => nodes.map((element) => element.getAttribute("data-id") ?? ""));
const unrelated = Object.keys(resting).filter((id) => !related.includes(id));
expect(unrelated.length).toBeGreaterThan(0);
const hovering = await mapCardOpacities(page);
expect(unrelated.map((id) => hovering[id])).toEqual(unrelated.map((id) => resting[id]));
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
// The transitions into and out of it come fully up, the secondary one too.
const incident = page.locator(".map-canvas .react-flow__edge.graph-edge-hover-related");
await expect(incident.and(page.locator(".graph-edge-secondary"))).not.toHaveCount(0);
await expect.poll(() => incident.evaluateAll((edges) => edges.every((edge) => getComputedStyle(edge).opacity === "1"))).toBe(true);
// The route heads a Map card, so the bubble sits below the screenshot, clear of both.
const clearance = async () => {
const [bubble, card, title] = await Promise.all([tooltip.boundingBox(), target.boundingBox(), heading.boundingBox()]);
if (!bubble || !card || !title) return Number.NaN;
const headingOverlap = bubble.y < title.y + title.height && title.y < bubble.y + bubble.height
&& bubble.x < title.x + title.width && title.x < bubble.x + bubble.width;
return headingOverlap ? -1 : bubble.y - (card.y + card.height);
};
expect(await clearance()).toBeGreaterThan(0);
// Panning with the pointer still on the card moves the card by transform; the bubble follows it
// rather than staying behind over the screenshot.
const before = await target.boundingBox();
await page.mouse.wheel(0, 40);
await expect.poll(async () => (await target.boundingBox())!.y).toBeLessThan(before!.y - 10);
await expect.poll(clearance).toBeGreaterThan(0);
});
test("hovering a Map screen the Changes filter muted brings it and its neighbours back up, and nothing else", async ({ page }) => {
await serveSyntheticWorkspace(page);
await page.goto("/map?focus=modified");
const muted = page.locator(".map-canvas .react-flow__node-screen.graph-node-muted:not(.canvas-node-exit)");
await expect.poll(() => muted.count()).toBeGreaterThan(0);
await expectMapCameraAtRest(page);
const resting = await mapCardOpacities(page);
const node = await hoverableMapScreen(muted, 0);
const id = (await node.getAttribute("data-id"))!;
expect(Number.parseFloat(resting[id]!)).toBeLessThan(1);
await node.locator(".screen-screenshot-target").hover();
await expect(node).toHaveClass(/graph-node-hover-subject/);
const related = await page.locator(".map-canvas .react-flow__node-screen.graph-node-hover-related")
.evaluateAll((nodes) => nodes.map((element) => element.getAttribute("data-id") ?? ""));
expect(related).toContain(id);
expect(related.length).toBeGreaterThan(1);
const hovering = await mapCardOpacities(page);
expect(related.map((relatedId) => hovering[relatedId])).toEqual(related.map(() => "1"));
const unrelated = Object.keys(resting).filter((otherId) => !related.includes(otherId));
expect(unrelated.length).toBeGreaterThan(0);
expect(unrelated.map((otherId) => hovering[otherId])).toEqual(unrelated.map((otherId) => resting[otherId]));
// The transitions between them come up with them.
const edges = page.locator(".map-canvas .react-flow__edge.graph-edge-hover-related");
await expect.poll(() => edges.count()).toBeGreaterThan(0);
await expect.poll(() => edges.evaluateAll((elements) => elements.every((edge) => getComputedStyle(edge).opacity === "1"))).toBe(true);
});
test("on Screens the Open in Inspector tooltip sits above the screenshot, clear of the route under it", async ({ page }) => {
await serveSyntheticWorkspace(page);
await page.goto("/screens");
const card = page.locator(".screens-page .screen-screenshot-card:not(.selected)").nth(1);
const target = card.locator(".screen-screenshot-target");
await target.scrollIntoViewIfNeeded();
await target.hover();
const tooltip = page.locator(".tooltip", { hasText: "Open in Inspector" });
await expect(tooltip).toBeVisible();
const [bubble, screenshot, title] = await Promise.all([
tooltip.boundingBox(), target.boundingBox(), card.locator(".screen-node-heading").boundingBox(),
]);
expect(bubble!.y + bubble!.height).toBeLessThanOrEqual(screenshot!.y);
expect(title!.y).toBeGreaterThanOrEqual(screenshot!.y + screenshot!.height - 1);
});
test("a narrow window with a mouse gets the phone map's Open pill on the selected screen, as it has no tooltips", async ({ page }) => {
// The phone layout is a width, not a device: the first click there only selects, as a tap does.
await page.setViewportSize({ width: 800, height: 820 });
await serveSyntheticWorkspace(page);
await page.goto("/map?screen=area-0-screen-1");
expect(await page.evaluate(() => matchMedia("(hover: hover)").matches)).toBe(true);
await expect(page.locator(".app-shell.phone-layout")).toHaveCount(1);
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
await expect(selected.locator(".screen-open-hint")).toBeVisible();
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(1);
});
test("fits a landscape Map capture at render time without app-specific dimensions", async ({ page }) => {
const source = viewerMapFixture() as ExploreMap;
await serveMap(page, {
@@ -4312,7 +4464,6 @@ test("desktop Compare: one command bar with the modes in it, even gaps to both b
await expect(divider).toHaveAttribute("aria-valuenow", "45");
const dividerAt = async () => Number(await divider.getAttribute("aria-valuenow"));
await page.keyboard.down("BracketRight");
await expect(divider).toHaveAttribute("aria-valuenow", "50");
await expect.poll(dividerAt, { timeout: 4000 }).toBeGreaterThanOrEqual(65);
await page.keyboard.up("BracketRight");
const dividerHeld = await dividerAt();
@@ -4488,7 +4639,7 @@ test.describe("phone layout", () => {
await page.goto("/map");
await page.getByRole("button", { name: "Search", exact: true }).tap();
await page.keyboard.type("c");
await expect(page.locator(".search-command-section-label")).toBeVisible();
await expect(page.locator(".search-command-section-label").first()).toBeVisible();
expect(await offScaleText(page, ".search-command")).toEqual([]);
// iOS zooms into any field under 16px.
expect(await page.locator(".search-command-input-row input").evaluate((element) => getComputedStyle(element).fontSize))
@@ -5053,3 +5204,213 @@ test("the theme is Auto until the toggle picks one: it follows the system, then
await expect(html).toHaveAttribute("data-theme", "light");
await expect(page.getByRole("button", { name: "Toggle theme" })).toHaveAttribute("data-theme-preference", "light");
});
test("/ finds screens on the Screens page: the tree and the grid narrow to the query, Enter picks the first match, Esc clears then closes", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const grid = page.getByRole("main", { name: "Screens" });
const cells = grid.locator(".screens-grid .screens-cell");
const treeRows = grid.locator(".screens-tree-row[data-screen-id]");
await expect(cells.first()).toBeVisible();
const all = await cells.count();
const titles = await cells.locator(".screen-node-title").allTextContents();
// A query that keeps some screens and drops others: the last path segment of a route only some routes share.
const query = titles.map(title => title.split("/").filter(Boolean).at(-1) ?? "")
.find(segment => segment && titles.filter(title => title.includes(segment)).length < titles.length)!;
expect(query).toBeTruthy();
// Opening the field does not move the tree under it: the head keeps one height in every state.
const heading = grid.locator(".screens-tree h2");
const headingTop = (await heading.boundingBox())!.y;
await page.keyboard.press("/");
const field = grid.getByRole("searchbox", { name: "Find screens" });
await expect(field).toBeFocused();
expect((await heading.boundingBox())!.y).toBe(headingTop);
await field.fill(query);
const matching = titles.filter(title => title.toLowerCase().includes(query.toLowerCase()));
await expect(cells).toHaveCount(matching.length);
for (const title of await cells.locator(".screen-node-title").allTextContents()) expect(title.toLowerCase()).toContain(query.toLowerCase());
await expect(treeRows).toHaveCount(matching.length);
// Every row stays open while finding, so the fold-all control steps aside.
await expect(grid.locator(".screens-tree-fold-all")).toHaveCount(0);
// The results are the field's: ↓ and ↑ step the pick through them while typing can go on; Return opens the pick.
await field.press("ArrowDown");
await expect(cells.nth(0).locator(".screen-screenshot-card")).toHaveClass(/selected/);
await expect(field).toBeFocused();
if (matching.length > 1) {
await field.press("ArrowDown");
await expect(cells.nth(1).locator(".screen-screenshot-card")).toHaveClass(/selected/);
await field.press("ArrowUp");
await expect(cells.nth(0).locator(".screen-screenshot-card")).toHaveClass(/selected/);
}
await expect(page.getByRole("complementary", { name: "Inspector panel" })).toBeHidden();
await field.press("Enter");
await expect(page.getByRole("complementary", { name: "Inspector panel" })).toBeVisible();
await expect(cells.first().locator(".screen-screenshot-card")).toHaveClass(/selected/);
await expect(cells).toHaveCount(matching.length);
await expect(field).toBeFocused();
await field.fill("no-such-route-anywhere");
await expect(grid.getByRole("status").filter({ hasText: "No screens match" }).first()).toBeVisible();
await field.press("Escape");
await expect(field).toHaveValue("");
await expect(cells).toHaveCount(all);
await field.press("Escape");
await expect(field).toHaveCount(0);
await expect(grid.getByRole("button", { name: "Find a screen" })).toBeVisible();
// From the Map, "/" opens Screens with the field focused.
await chooseCanvasView(page, "Map");
await expect(page.getByRole("main", { name: "Screens" })).toHaveCount(0);
await page.keyboard.press("/");
await expect(page.getByRole("main", { name: "Screens" }).getByRole("searchbox", { name: "Find screens" })).toBeFocused();
});
test("⌘K is a command palette: suggested commands lead, word queries rank commands first and run on Enter, route queries rank screens first", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/map");
const mod = process.platform === "darwin" ? "Meta" : "Control";
await page.keyboard.press(`${mod}+KeyK`);
const palette = page.getByRole("dialog", { name: "Search Explore" });
await expect(palette).toBeVisible();
const box = palette.getByRole("combobox", { name: "Search screens and commands" });
await expect(box).toBeFocused();
// The empty palette suggests what to do next on this canvas, not the screen inventory.
const suggested = palette.getByRole("group", { name: "Suggested" });
await expect(suggested.getByRole("option").filter({ hasText: "Next changed screen" })).toBeVisible();
expect(await palette.getByRole("option").count()).toBeLessThanOrEqual(7);
// A word query ranks commands first; each prints the key that also runs it.
await box.fill("dark");
await expect(palette.getByRole("option").first()).toContainText("Theme: Dark");
await box.fill("fit");
const fit = palette.getByRole("option").filter({ hasText: "Fit the canvas" });
await expect(fit).toBeVisible();
await expect(fit.locator("kbd")).toBeVisible();
// Enter runs the command.
await box.fill("dark");
await box.press("Enter");
await expect(palette).toHaveCount(0);
await expect(page.locator("html")).toHaveAttribute("data-theme", "dark");
// A route-shaped query ranks screens first, with the commands after them.
await page.keyboard.press(`${mod}+KeyK`);
await box.fill("/");
await expect(palette.getByRole("option").first().locator("code")).toBeVisible();
await expect(palette.getByRole("group", { name: "Screens" })).toBeVisible();
// A navigation command.
await box.fill("screens");
await expect(palette.getByRole("option").first()).toHaveText(/^Screens/);
await box.press("Enter");
await expect(page.getByRole("main", { name: "Screens" })).toBeVisible();
});
test("⌘K steps through its results in the order it shows them, and a command that opens a menu keeps it open", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/map");
await page.getByRole("button", { name: "Search", exact: true }).click();
const palette = page.getByRole("dialog", { name: "Search Explore" });
const box = palette.getByRole("combobox", { name: "Search screens and commands" });
// "c" matches commands and screens alike: ↓ walks the rows top to bottom, across the sections.
await box.fill("c");
const options = palette.getByRole("option");
const count = await options.count();
expect(await palette.getByRole("group").count()).toBe(2);
for (let step = 0; step < count; step += 1) {
await expect(options.nth(step)).toHaveAttribute("aria-selected", "true");
await expect(box).toHaveAttribute("aria-activedescendant", (await options.nth(step).getAttribute("id"))!);
await box.press("ArrowDown");
}
await expect(options.first()).toHaveAttribute("aria-selected", "true");
// The palette hands focus to the menu it opens instead of taking it back.
await box.fill("Changed screens menu");
await box.press("Enter");
await expect(palette).toHaveCount(0);
await expect(page.locator(".changes-menu")).toBeVisible();
await expect(page.locator(".changes-menu-body")).toBeFocused();
});
test("a / from the Map opens the find once: Screens opened again from the toolbar comes up without it", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/map");
await page.keyboard.press("/");
const grid = page.getByRole("main", { name: "Screens" });
const field = grid.getByRole("searchbox", { name: "Find screens" });
await expect(field).toBeFocused();
await field.press("Escape");
await expect(field).toHaveCount(0);
await chooseCanvasView(page, "Map");
await chooseCanvasView(page, "Screens");
await expect(grid.locator(".screens-grid .screens-cell").first()).toBeVisible();
await expect(grid.getByRole("button", { name: "Find a screen" })).toBeVisible();
await expect(field).toHaveCount(0);
});
test("the find's keys stay in its field: Return on the clear button clears, and Return while composing text opens nothing", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const grid = page.getByRole("main", { name: "Screens" });
const inspector = page.getByRole("complementary", { name: "Inspector panel" });
await expect(grid.locator(".screens-grid .screens-cell").first()).toBeVisible();
await page.keyboard.press("/");
const field = grid.getByRole("searchbox", { name: "Find screens" });
await field.fill("/");
await field.press("Tab");
await expect(grid.getByRole("button", { name: "Clear find query" })).toBeFocused();
await page.keyboard.press("Enter");
await expect(field).toHaveValue("");
await expect(inspector).toBeHidden();
await field.fill("/");
// An input method's Return confirms the composed text; it is not the find's Return.
await field.evaluate((input) => input.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", code: "Enter", isComposing: true, bubbles: true, cancelable: true })));
await page.waitForTimeout(200);
await expect(inspector).toBeHidden();
});
test("a find inside Changed that only matches other screens says so and offers All", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const grid = page.getByRole("main", { name: "Screens" });
const cells = grid.locator(".screens-grid .screens-cell");
const titles = () => cells.locator(".screen-node-title").allTextContents();
await expect(cells.first()).toBeVisible();
const all = await titles();
await grid.getByRole("button", { name: /^Changed/ }).click();
await expect.poll(async () => (await titles()).length).toBeLessThan(all.length);
const changed = (await titles()).map(title => title.toLowerCase());
const query = all.find(title => !changed.some(other => other.includes(title.toLowerCase())));
test.skip(!query, "every unchanged screen's title is part of a changed one's");
await page.keyboard.press("/");
const field = grid.getByRole("searchbox", { name: "Find screens" });
await field.fill(query!);
await expect(grid.getByRole("status").filter({ hasText: `No changed screens match “${query}”` }).first()).toBeVisible();
await grid.getByRole("button", { name: /^Show all/ }).click();
await expect(cells.filter({ hasText: query! }).first()).toBeVisible();
await expect(field).toBeFocused();
await field.press("Escape");
await field.press("Escape");
await expect(grid.getByRole("button", { name: /^All/ })).toHaveAttribute("aria-pressed", "true");
});
test("a find left on when the window narrows to the phone layout does not filter the phone's screens", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const grid = page.getByRole("main", { name: "Screens" });
const cells = grid.locator(".screens-grid .screens-cell");
await expect(cells.first()).toBeVisible();
await grid.getByRole("button", { name: /^All/ }).click();
const all = await cells.count();
await page.keyboard.press("/");
await grid.getByRole("searchbox", { name: "Find screens" }).fill("no-such-route-anywhere");
await expect(cells).toHaveCount(0);
await page.setViewportSize({ width: 390, height: 844 });
await expect(cells).toHaveCount(all);
});
+4 -1
View File
@@ -27,7 +27,10 @@ export async function createBrowserVite(test, options) {
});
const requested = options.server;
const port = requested?.port === 0 ? await freePort(requested.host ?? "127.0.0.1") : requested?.port;
server = await createServer({ ...options, cacheDir,
// A cold cacheDir optimizes dependencies as the page asks for them; one found late (the JSX dev runtime, which
// esbuild's JSX imports) makes Vite reload the page, dropping whatever the test has done in it.
const optimizeDeps = { ...options.optimizeDeps, include: [...(options.optimizeDeps?.include ?? []), "react/jsx-dev-runtime"] };
server = await createServer({ ...options, cacheDir, optimizeDeps,
...(requested ? { server: { ...requested, port, ...(requested.port === 0 ? { strictPort: true } : {}) } } : {}) });
return server;
}
+16 -3
View File
@@ -8,11 +8,13 @@ import { createHash } from 'node:crypto';
import { PNG } from 'pngjs';
import { AGENT_DEVICE_VERSION } from '../../dist/capture/run.js';
import { CAPTURE_OBSERVER_IDENTIFIER } from '../../dist/capture/observer.js';
import { controllerCacheRoot, ensureController } from '../../dist/shared/controller-cache.js';
import { writeCaptureObserverPackages } from './capture-observer-fixture.mjs';
/**
* In-process public CI fixture: a git project with base/head commits plus mocked `eas`, `repack-app`,
* `agent-device` and GitHub transports, so a review runs end to end without network or a simulator.
* `agent-device` and GitHub transports, so a review runs end to end without a simulator, and without network once the
* real agent-device that compares screenshots is cached.
*/
export const PROJECT_ID = '00000000-0000-4000-8000-000000000001';
@@ -27,6 +29,17 @@ export const usageReceipt = (overrides = {}) => ({ provider: 'anthropic', model:
totals: { inputTokens: 100, outputTokens: 20, cacheReadInputTokens: 40, estimatedCostUsd: 0.012 },
models: [{ model: 'fixture-model', inputTokens: 100, outputTokens: 20, cacheReadInputTokens: 40, estimatedCostUsd: 0.012, costBasis: 'list' }],
...overrides });
/**
* The review's screenshot comparison runs the real agent-device, which fetches itself on first use. The fixture fetches
* it once, with retries, into the machine's controller cache, so a review never downloads it mid-run.
*/
const CONTROLLER_CACHE = controllerCacheRoot(process.env);
for (let attempt = 1; ; attempt++) {
try { await ensureController('agent-device', { environment: { ...process.env, EXPLORE_CONTROLLER_CACHE: CONTROLLER_CACHE } }); break; }
catch (error) { if (attempt === 3) throw error; await new Promise(resolve => setTimeout(resolve, attempt * 2_000)); }
}
export async function readUsage(output) {
const path = join(output, 'agent-usage.jsonl');
assert.equal((await stat(path)).mode & 0o777, 0o600, 'usage receipts are private artifacts');
@@ -103,7 +116,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
const pr = { repositoryId: '123', repository: 'acme/example', number: 7, title: 'Source capture integration', url: 'https://github.com/acme/example/pull/7',
base: { ref: 'main', sha: baseSha }, head: { ref: 'feature', sha: headSha } };
const pullRequestPath = join(root, 'pull-request.json'); await writeFile(pullRequestPath, JSON.stringify(pr));
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPLORE_CONTROLLER_CACHE: CONTROLLER_CACHE, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
GITHUB_RUN_ID: '1234', GITHUB_RUN_ATTEMPT: '1', GITHUB_REPOSITORY: pr.repository, TOOLS_COMMIT: 'c'.repeat(40), EXPLORE_VIEWER_ORIGIN: 'https://viewer.example' };
const requests = []; const comments = []; const sessions = new Map(); let currentSession; const idleDevice = { path: '/', scheme: 'light' }; let sessionCounter = 0; let repackedSha; let openFailed = false;
const identity = (session) => ({ session: 'expo-explore-runtime', appBundleId: config.app.bundleId,
@@ -206,7 +219,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
] });
}
if (command === 'settings') { if (request.args[1] === 'appearance') device.scheme = request.args[2]; return ok({ setting: request.args[1], value: request.args[2] }); }
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); /* Hashed colours can land within the diff threshold, so /home's red channel keeps the base build apart from any other. */ if (device.path === '/home') color[0] = device.build?.endsWith(baseSha) ? 0 : 255; const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
}
throw new Error(`Unexpected mocked command: ${request.command} ${request.args.join(' ')}`);
};
+3 -2
View File
@@ -87,7 +87,7 @@ test("the Android controller open response is accepted only for the Android plat
assert.throws(() => openedSimulatorDevice(response, "dev.brent.euxy", "open", "ios"), /full ios device shape/);
});
test("the PR comment names Android builds and runtimes", () => {
test("the PR comment names the Android target while it captures", () => {
const pullRequest = { repositoryId: "1", repository: "expo/explore-playground", number: 1, title: "Android", url: "https://github.com/expo/explore-playground/pull/1",
base: { ref: "main", sha: "a".repeat(40) }, head: { ref: "android", sha: "b".repeat(40) } };
const body = renderPublicComment({
@@ -99,7 +99,8 @@ test("the PR comment names Android builds and runtimes", () => {
deviceModel: "EasAndroidDevice01", osVersion: "35", locale: "en-US", orientation: "portrait", colorScheme: "light" },
capture: { planned: { base: 3, head: 3 }, done: { base: 0, head: 1 }, baseFromCache: false },
});
assert.match(body, /\| Android \| EasAndroidDevice01 35 · euxy 1\\\.2\\\.0 \\\(1\\\) \| ⏳ capturing head 1\/3 \|/);
assert.match(body, /^### Explore review · capturing$/m);
assert.match(body, /^Android · capturing head 1\/3 · \[run\]\(<[^>]+>\)$/m);
assert.doesNotMatch(body, /iOS/);
});
+2 -1
View File
@@ -145,7 +145,8 @@ async function fixture(t, settings = {}) {
if (request.args[1]?.includes('server start')) {
const port = 4100 + serverStarts++;
writeFileSync(request.environment.EXPLORE_ARGENT_SERVER_LOG, ` (or: argent link --host 127.0.0.1 --port ${port} --token abc123)\n[t] Tools server listening on http://127.0.0.1:${port}\n`);
return { stdout: `${4242 + serverStarts}\n`, stderr: '' };
// A pid no process can have: stopping the server signals it for real.
return { stdout: `${999_999_000 + serverStarts}\n`, stderr: '' };
}
return { stdout: '', stderr: '' };
}
+107 -7
View File
@@ -2,7 +2,7 @@ import assert from "node:assert/strict";
import test from "node:test";
const { tsImport } = await import("tsx/esm/api");
const { HOLD_INITIAL_DELAY_MS, HOLD_FIRST_INTERVAL_MS, HOLD_FLOOR_INTERVAL_MS, createKeyHold, glideRate, holdIntervalMs, holdSchedule } =
const { HOLD_INITIAL_DELAY_MS, HOLD_FIRST_INTERVAL_MS, HOLD_FLOOR_INTERVAL_MS, createKeyHold, glideRate, glideWhileHeld, holdIntervalMs, holdSchedule } =
await tsImport("../../viewer/src/utils/key-hold.ts", import.meta.url);
test("a held paging key waits, then steps sooner and sooner down to a floor", () => {
@@ -76,10 +76,110 @@ test("another key ends a hold, as the OS's own repeat stops; its own repeats and
hold.end();
});
test("a glide picks up from rest, then eases from the stepped hold's first speed up to its top speed", () => {
assert.equal(glideRate(0), 0, "it starts at rest, where the tap's step ended");
assert.ok(Math.abs(glideRate(80) - 1000 / HOLD_FIRST_INTERVAL_MS) < 0.2, "within a few frames it moves a step per first interval");
for (let at = 10; at <= 1200; at += 10) assert.ok(glideRate(at) >= glideRate(at - 10), `never slows, at ${at}ms`);
assert.equal(glideRate(1000), 1000 / HOLD_FLOOR_INTERVAL_MS, "after a second, a step per floor interval");
assert.equal(glideRate(5000), glideRate(1000), "and no faster");
test("a glide moves at its start speed from the key down, then eases up to its top speed", () => {
const profile = { startRate: 8, topRate: 20, rampMs: 700 };
assert.equal(glideRate(0, profile), 8, "no pause: it moves at full start speed on the first frame");
for (let at = 10; at <= 1200; at += 10) assert.ok(glideRate(at, profile) >= glideRate(at - 10, profile), `never slows, at ${at}ms`);
assert.equal(glideRate(700, profile), 20, "at the end of the ramp, the top speed");
assert.equal(glideRate(5000, profile), 20, "and no faster");
});
/** Frames on demand: `tick` advances the clock and runs the frame callbacks queued so far. */
function fakeFrames(t) {
let clock = 0;
let queue = [];
t.mock.method(performance, "now", () => clock);
const previous = globalThis.requestAnimationFrame;
globalThis.requestAnimationFrame = (callback) => { queue.push(callback); return queue.length; };
t.after(() => { globalThis.requestAnimationFrame = previous; });
return {
tick(ms) {
clock += ms;
const due = queue;
queue = [];
for (const callback of due) callback(clock);
},
get pending() { return queue.length; },
};
}
test("a glide starts on the first frame after key down; a tap completes one step, a hold stops where it is released", (t) => {
t.mock.timers.enable({ apis: ["setTimeout"] });
const frames = fakeFrames(t);
const profile = { startRate: 10, topRate: 10, rampMs: 1 };
const hold = createKeyHold();
let moved = 0;
const move = (steps) => { moved += steps; return true; };
// A tap: released a third of the way into its step, it goes on to exactly one step at the same speed.
glideWhileHeld(hold.begin("BracketRight", () => true), move, profile);
frames.tick(0);
frames.tick(16);
assert.ok(Math.abs(moved - 0.16) < 1e-9, `moves on the first frame, with no initial delay (${moved})`);
frames.tick(16);
hold.release("BracketRight");
for (let frame = 0; frame < 20 && frames.pending; frame += 1) frames.tick(16);
assert.ok(Math.abs(moved - 1) < 1e-9, `a tap covers one step (${moved})`);
assert.equal(frames.pending, 0, "and the glide is over");
// A hold: a second in it is well past one step, and it stops on the frame the key is released.
moved = 0;
glideWhileHeld(hold.begin("BracketRight", () => true), move, profile);
for (let frame = 0; frame < 61; frame += 1) frames.tick(16);
assert.ok(moved > 9 && moved < 11, `ten steps a second (${moved})`);
hold.release("BracketRight");
const released = moved;
for (let frame = 0; frame < 10 && frames.pending; frame += 1) frames.tick(16);
assert.equal(moved, released, "nothing after release");
assert.equal(frames.pending, 0);
// A limit ends the hold.
glideWhileHeld(hold.begin("BracketLeft", () => true), () => false, profile);
frames.tick(16);
assert.ok(!hold.holding("BracketLeft"), "a move that finds nothing ends the hold");
assert.equal(frames.pending, 0);
});
test("each press glides on its own: a tap still finishing is not taken over by the next press, and an interruption stops it at once", (t) => {
t.mock.timers.enable({ apis: ["setTimeout"] });
const frames = fakeFrames(t);
const profile = { startRate: 10, topRate: 10, rampMs: 1 };
const hold = createKeyHold();
const moved = { first: 0, second: 0 };
const mover = (name) => (steps) => { moved[name] += steps; return true; };
// Tap ], then hold ] again before the tap's step is done: the tap still ends at one step.
glideWhileHeld(hold.begin("BracketRight", () => true), mover("first"), profile);
frames.tick(0);
frames.tick(16);
hold.release("BracketRight");
frames.tick(16);
glideWhileHeld(hold.begin("BracketRight", () => true), mover("second"), profile);
for (let frame = 0; frame < 61; frame += 1) frames.tick(16);
assert.ok(Math.abs(moved.first - 1) < 1e-9, `the tap covers one step, not the hold after it (${moved.first})`);
assert.ok(moved.second > 9 && moved.second < 11, `the hold glides on its own (${moved.second})`);
hold.release("BracketRight");
for (let frame = 0; frame < 10 && frames.pending; frame += 1) frames.tick(16);
assert.equal(frames.pending, 0, "both glides are over");
// An interruption (Esc, blur, a dialog) stops a glide on its next frame, short of a step.
moved.first = 0;
glideWhileHeld(hold.begin("Equal", () => true), mover("first"), profile);
frames.tick(0);
frames.tick(16);
hold.interrupt({ code: "Escape", key: "Escape", repeat: false });
for (let frame = 0; frame < 10 && frames.pending; frame += 1) frames.tick(16);
assert.ok(Math.abs(moved.first - 0.16) < 1e-9, `no motion after the interruption (${moved.first})`);
assert.equal(frames.pending, 0);
// A finishing tap that reaches a limit leaves the newer hold alone.
let calls = 0;
glideWhileHeld(hold.begin("BracketRight", () => true), () => (calls += 1) < 2, profile);
frames.tick(0);
frames.tick(16);
hold.release("BracketRight");
glideWhileHeld(hold.begin("BracketLeft", () => true), () => true, profile);
frames.tick(16);
assert.ok(hold.holding("BracketLeft"), "[ is still held after ]'s tap hit 100%");
hold.end();
});
+29 -9
View File
@@ -7,7 +7,7 @@ import test from "node:test";
import { prepareCaptureReview } from "../../dist/review/capture-review.js";
import { createSourceCapturePlan } from "../../dist/source/capture-plan.js";
import { writeCiReportInput, exportCiReport } from "../../dist/report/artifact.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { spawnSync } from "node:child_process";
import { ZipReader, Uint8ArrayReader, TextWriter, configure } from "@zip.js/zip.js";
import { viewerLinks } from "../../dist/report/viewer-links.js";
@@ -203,8 +203,8 @@ test("ci:deploy seals the exact report, deploys it with the preview export, veri
assert.ok(eas.requests.every(request => request.url.origin !== "https://acme-explore--1lcbdcpwn3.expo.app" || request.options.cache === "no-store"));
const posted = eas.requests.find(request => request.options.method === "POST");
const body = JSON.parse(posted.options.body).body;
assert.match(body, new RegExp(`\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\) \\|`));
assert.match(body, /Preview links work for anyone who has them until the deployment is deleted\./);
assert.match(body, new RegExp(`^### [^\\n]*\\[Review in Explore\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\)$`, 'm'));
assert.match(body, /Preview links work for anyone who has them until the deployment is deleted · /);
assert.doesNotMatch(body, /explore-preview\.expo\.app\/\?/);
assert.ok(eas.requests.indexOf(posted) > eas.requests.findIndex(request => request.url.pathname === `/p/${token}/viewer/index.html`), "publish after verification");
});
@@ -359,11 +359,10 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
"/", `/p/${wrong}`, `/p/${wrong}/manifest.json`, `/p/${token}/viewer/index.html`]);
const posted = eas.requests.filter(request => request.options.method === "POST" || request.options.method === "PATCH").map(request => JSON.parse(request.options.body).body);
assert.equal(posted.length, 2, "the second platform updates the comment the first created");
assert.match(posted[0], new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?platform=ios>\\)`));
assert.doesNotMatch(posted[0], /\| Android \|/);
assert.match(posted[1], new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<[^>]+/p/${token}\\?platform=ios>\\)`), 'the Android writer keeps the iOS row');
assert.match(posted[1], new RegExp(`\\| Android \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<[^>]+/p/${token}\\?platform=android>\\)`));
assert.equal(posted[1].split("<summary>Validation").length, 2, 'one validation block for both platforms');
assert.match(posted[0], new RegExp(`^<sub>\\[iOS\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?platform=ios>\\) · \\[`, 'm'));
assert.doesNotMatch(posted[0], /Android/);
assert.match(posted[1], new RegExp(`^<sub>\\[iOS\\]\\(<[^>]+/p/${token}\\?platform=ios>\\) · \\[Android\\]\\(<[^>]+/p/${token}\\?platform=android>\\) · \\[`, 'm'), 'the Android writer keeps the iOS link');
assert.equal(posted[1].split("### ").length, 2, 'one heading for both platforms');
});
function captureListing(listing) {
@@ -422,7 +421,7 @@ test("a preview sets no expiry of its own: an old config's expiresAfter is noted
assert.equal("EXPLORE_PREVIEW_EXPIRES_AT" in eas.captured.env, false);
assert.equal(result.expiresAt, null);
const body = JSON.parse(eas.requests.find(request => request.options.method === "PATCH" || request.options.method === "POST").options.body).body;
assert.match(body, /^Preview links work for anyone who has them until the deployment is deleted\. · Managed via /m);
assert.match(body, /^<sub>Preview links work for anyone who has them until the deployment is deleted · \[Workflow run\]/m);
assert.doesNotMatch(body, /works until/);
assert.ok(warnings.some(line => line.includes("report.preview.expiresAfter no longer applies: a hosted preview lasts as long as its EAS Hosting deployment")), warnings.join(""));
@@ -525,6 +524,27 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
error => error.code === "PREVIEW_ALIAS_INVALID");
});
test("fixture reports name each target's ZIP, and a listing from before targets its platform's", () => {
const listing = [
{ target: "iphone", platform: "ios", label: "iPhone 17", changes: 11, device: "iPhone 17 26.5 · light + dark", source: "brentvatne/euxy#163" },
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", changes: 34 },
{ target: "android", platform: "android", label: "Android", changes: 5 },
];
assert.deepEqual(fixtureReports(listing, "/fixtures"), [
{ platform: "ios", target: { id: "iphone", platform: "ios", label: "iPhone 17" }, zipPath: "/fixtures/iphone.zip", changes: 11, device: "iPhone 17 26.5 · light + dark" },
{ platform: "ios", target: { id: "duo-open", platform: "ios", label: "iPhone Duo (open)" }, zipPath: "/fixtures/duo-open.zip", changes: 34 },
{ platform: "android", target: { id: "android", platform: "android", label: "Android" }, zipPath: "/fixtures/android.zip", changes: 5 },
]);
assert.deepEqual(fixtureReports([{ platform: "ios", changes: 3 }, { platform: "android" }], "/fixtures"), [
{ platform: "ios", zipPath: "/fixtures/ios.zip", changes: 3 },
{ platform: "android", zipPath: "/fixtures/android.zip" },
]);
// reports.json comes from a hosted preview: a target that is not an id never names a file.
for (const bad of [[{ target: "../escape", platform: "ios" }], [{ platform: "web" }], [null], { platform: "ios" }]) {
assert.throws(() => fixtureReports(bad, "/fixtures"), error => error.code === "PREVIEW_REPORTS_INVALID", JSON.stringify(bad));
}
});
test("a deployment that does not report the requested alias is a retryable deploy failure", async t => {
const { reportPath, exportPath } = await exportFixture(t);
await asExploration(reportPath);
+30 -6
View File
@@ -78,8 +78,7 @@ for (const provider of ['expo-router', 'react-navigation']) {
const published = await publishCiReportComment({ inputPath: result.inputPath,
artifactUrl: 'https://github.com/acme/example/actions/runs/1234/artifacts/900', environment: f.environment, transport: f.transport });
assert.equal(new URL(published.artifactUrl).origin, 'https://explore-preview.expo.app', 'CI always uses the hosted viewer, even with a legacy origin override');
assert.match(f.comments.at(-1), /\[Open\]\(<https:\/\/explore-preview\.expo\.app\/\?[^>]+>\)/);
assert.match(f.comments.at(-1), /\[zip\]\(<https:\/\/github\.com\/acme\/example\/actions\/runs\/1234\/artifacts\/900>\)/);
assert.match(f.comments.at(-1), /\[Review in Explore\]\(<https:\/\/explore-preview\.expo\.app\/\?[^>]+artifact=900>\)/);
assert.match(f.comments.at(-1), /explore-preview\.expo\.app/);
assert.doesNotMatch(f.comments.at(-1), /viewer\.example/);
// A matrix job's report artifact carries its target id: an unsuffixed artifact is not target duo-open's.
@@ -132,12 +131,12 @@ test('unreachable screens do not fail CI: both revisions, the report and an Inco
await publishCiReportComment({ inputPath: result.inputPath,
artifactUrl: 'https://github.com/acme/example/actions/runs/1234/artifacts/900', environment: f.environment, transport: f.transport });
const comment = f.comments.at(-1).replaceAll('\\', '');
assert.match(comment, /\| iOS \| [^|]+\| 🟨 [^|]*unavailable[^|]*\| \[Open\]\(<https:\/\/explore-preview\.expo\.app/, 'the report link is published even though a screen is unavailable');
assert.match(comment, /^### \d+ screens? changed · \[Review in Explore\]\(<https:\/\/explore-preview\.expo\.app/m, 'the report link is published even though a screen is unavailable');
assert.match(comment, /^iOS · 1 capture unavailable · 1 unattributed · \[run\]/m);
assert.doesNotMatch(comment, /🟥 failed/);
assert.match(comment, /Head · \/home · CAPTURE_OBSERVER_NOT_READY/);
assert.match(comment, /Base · \/home · CAPTURE_OBSERVER_MISSING/);
assert.match(comment, /1 unavailable/);
assert.match(comment, /1 unattributed/);
assert.match(comment, /<summary>Capture issues \(2\)<\/summary>/);
assert.equal(f.requests.filter(request => request.args[0] === 'simulator:stop').length, 2);
assert.equal(git(f.baseProject, 'status', '--porcelain'), '');
assert.equal(git(f.headProject, 'status', '--porcelain'), '');
@@ -290,7 +289,7 @@ test('a PR that moved during a verification retry still publishes, as a previous
assert.ok(f.comments.length > 0, 'the run keeps posting; its report is kept under previous runs');
assert.match(f.comments.at(-1), /Previous runs \(1\)/);
assert.match(f.comments.at(-1), /The pull request moved while this run worked/);
assert.doesNotMatch(f.comments.at(-1), /^<sub>base \[/m, 'nothing is presented as the current review');
assert.match(f.comments.at(-1), /^### Explore review$/m, 'nothing is presented as the current review');
});
test('authorization and other non-server PR verification failures are never retried', async t => {
@@ -520,3 +519,28 @@ for (const failedPhase of ['preflight', 'capture-head']) {
assert.doesNotMatch(f.comments.join('\n'), /agent-usage|estimatedCostUsd|cacheReadInputTokens|query-pipeline/);
});
}
test('an excluded route is flagged in the published review and never captured on either side', async t => {
const f = await fixture(t, 'expo-router');
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
const output = join(f.root, 'review');
const result = await runPublicCi({ baseProject: f.baseProject, headProject: f.headProject, pullRequestPath: f.pullRequestPath, output,
config: { ...f.config, exploration: { scope: 'changes', exclude: ['/settings'] } }, environment: f.environment,
transport: f.transport, runner: f.runner, now: f.now, sleep: f.sleep });
const plan = JSON.parse(await readFile(join(output, 'execution-plan.json'), 'utf8'));
const settings = plan.surfaces.find(surface => surface.headSurface?.route === '/settings');
assert.deepEqual(plan.excludedSurfaceIds, [settings.id]);
for (const side of ['base', 'head']) {
const bundle = await readCaptureBundle(join(output, `${side}-export`));
assert.equal(settings.id in bundle.outcomes, false, `${side}: an excluded route is not captured`);
}
const packaged = await exportCiReport({ inputPath: result.inputPath, outputPath: join(f.root, 'artifact') });
const report = JSON.parse(await readFile(join(packaged.outputPath, 'review.json'), 'utf8'));
const published = report.review.surfaces.find(surface => surface.id === settings.id);
assert.equal(published.excluded, true);
assert.equal(published.headImage ?? published.baseImage ?? published.headOutcome ?? published.baseOutcome, undefined);
assert.ok(report.review.surfaces.filter(surface => surface.id !== settings.id).every(surface => surface.excluded === undefined));
// /home changed and links to /settings: the neighbor is still captured, the excluded route is not a missing screen.
const home = report.review.surfaces.find(surface => surface.head?.route === '/home');
assert.ok(home.headImage && home.baseImage);
});
+337 -183
View File
@@ -88,60 +88,61 @@ function reviewOnlyState(review) {
};
}
const visible = body => body.split('\n').filter(line => !line.startsWith('<!-- expo-explore-record') && !line.startsWith('<!-- expo-explore-history')).join('\n');
const visible = body => body.split('\n').filter(line => !line.startsWith('<!-- expo-explore-record') && !line.startsWith('<!-- expo-explore-previous') && !line.startsWith('<!-- expo-explore-history')).join('\n');
const summaries = body => [...body.matchAll(/<summary>([^<]+)<\/summary>/g)].map(match => match[1]);
const platformRow = (body, platform) => body.split('\n').find(line => line.startsWith(`| ${platform} |`));
const checkRow = (body, check) => body.split('\n').find(line => line.startsWith(`| ${check} |`));
const titleOf = body => body.split('\n').find(line => line.startsWith('### '));
/** The `<sub>` two lines under the heading; the footer is the last line. */
const subtitleOf = body => { const lines = body.split('\n'); return lines[lines.findIndex(line => line.startsWith('### ')) + 2]; };
const statusOf = (body, label) => body.split('\n').find(line => line.startsWith(`${label} · `) || line.startsWith(`**${label} failed**`));
/** The changed-screen rows: the list before any collapsed block. */
const listOf = body => visible(body).split('\n<details>')[0].split('\n').filter(line => line.startsWith('- '));
const runLink = '[run](<https://github.com/expo/explore-playground/actions/runs/42/attempts/2>)';
const workflowRun = '[Workflow run](<https://github.com/expo/explore-playground/actions/runs/42/attempts/2>)';
const evidenceLink = '[evidence](<https://github.com/expo/explore-playground/actions/runs/42#artifacts>)';
const reportUrl = 'https://explore-preview.expo.app/?repo=expo%2Fexplore-playground&run=42&attempt=2&artifact=7654';
const commits = `[bbbbbbbb](<https://github.com/expo/explore-playground/commit/${headSha}>) vs [aaaaaaaa](<https://github.com/expo/explore-playground/commit/${baseSha}>)`;
const configLink = `[Config](<https://github.com/expo/explore-playground/blob/${headSha}/.expo-explore/config.yaml>)`;
test('the ready comment is one header, a platform table, the changes listed once, and a collapsed validation block', () => {
test('the ready comment is a heading with the count and the report, a subtitle, the changed screens, and a footer', () => {
const body = renderPublicComment(state({ artifactOnly: true }));
const lines = body.split('\n');
assert.equal(lines[0], CI_COMMENT_MARKER);
assert.match(lines[1], /^<!-- expo-explore-record:ios:[A-Za-z0-9_-]+ -->$/);
assert.match(lines[2], /^### Explore review · \[Open report\]\(<https:\/\/explore-preview\.expo\.app\/\?repo=expo%2Fexplore-playground&run=42&attempt=2[^>]*>\)$/, 'the report link is the heading, where a phone shows it first');
assert.equal(lines[4], '<sub>base [aaaaaaaa](<https://github.com/expo/explore-playground/commit/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>) → [bbbbbbbb](<https://github.com/expo/explore-playground/commit/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb>)</sub>');
assert.deepEqual([lines[3], ...lines.slice(5, 8)], ['', '', '| | Device | Result | Report |', '|---|---|---|---|']);
assert.equal(lines[8], `| iOS | iPhone 17 26\\.5 · Example 1\\.4\\.0 \\(27\\) | 🟩 3 changes · 6m 12s | [Open](<https://explore-preview.expo.app/?repo=expo%2Fexplore-playground&run=42&attempt=2&artifact=7654>) |`, 'the Report cell is the report link alone');
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', 'Validation · iOS 🟩 6/6 captured']);
assert.match(body, /\n\*\*Changes\*\* · 3 screens\n/);
assert.match(body, /\n- `\/settings` — Changed button title from “Share” to “Share Example”\\\. · \[iOS\]\(<https:\/\/explore-preview\.expo\.app\/\?repo=expo%2Fexplore-playground&run=42&attempt=2&artifact=7654&view=compare&screen=settings>\)\n/);
assert.match(body, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iOS\]\(<[^>]+screen=care-guide>\)\n/);
assert.match(body, /\n- `\/cats\/sweet-bee` — Removed \/cats\/sweet\\-bee screen · \[iOS\]\(<[^>]+screen=sweet-bee>\)\n/);
assert.equal(checkRow(body, 'Capture'), '| Capture | 🟩 6/6 surfaces · base cache reused |');
assert.equal(checkRow(body, 'Route verification'), '| Route verification | 🟩 6/6 verified |');
assert.equal(checkRow(body, 'Visual comparison'), '| Visual comparison | 🟩 2 compared · threshold 0.1 |');
assert.equal(checkRow(body, 'Accessibility comparison'), '| Accessibility comparison | 🟩 2 compared · 1 description |');
assert.equal(checkRow(body, 'Source inventory'), '| Source inventory | 🟩 54 routes |');
assert.equal(lines.at(-1), `Managed via [\`.expo-explore/config.yaml\`](<https://github.com/expo/explore-playground/blob/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/.expo-explore/config.yaml>) · Workflow ${runLink} · [zip](<https://github.com/expo/explore-playground/actions/runs/42/artifacts/7654>)`, 'the run and the report zip sit in the footer');
assert.doesNotMatch(body, /<img|### Review target|### What changed|### Validation|Unchanged|screen=cats|\/home|Reviewed at|Open Explore|Download report|View run/);
assert.ok(body.indexOf('**Changes**') < body.indexOf('<summary>Validation'));
assert.equal(lines[2], `### 3 screens changed · [Review in Explore](<${reportUrl}>)`, 'the report link is the heading, where a phone shows it first');
assert.equal(lines[4], `<sub>[iOS](<${reportUrl}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
assert.deepEqual(lines.slice(5, 10), ['',
`- Added [\`/cats/care-guide\`](<${reportUrl}&view=compare&screen=care-guide>)`,
`- Removed [\`/cats/sweet-bee\`](<${reportUrl}&view=compare&screen=sweet-bee>)`,
`- [\`/settings\`](<${reportUrl}&view=compare&screen=settings>) · Changed button title from “Share” to “Share Example”`, '']);
assert.equal(lines.at(-1), `<sub>${workflowRun} · ${configLink}</sub>`, 'the run and the config sit in the footer');
assert.equal(lines.length, 11);
assert.deepEqual(summaries(body), []);
assert.doesNotMatch(body, /<img|\*\*Changes\*\*|Validation|Capture issues|🟩|🟧|🟨|Managed via|zip|6m 12s|iPhone 17|Example 1|Unchanged|screen=cats|\/home|Reviewed at|Open Explore|Download report|View run|^\|/m);
// Hidden state is the only thing the comment carries besides markdown.
assert.equal(lines.filter(line => line.startsWith('<!--')).length, 2);
});
test('report links appear only once a report exists; a failed run links the run and its evidence', () => {
test('report links appear only once a report exists; a failed target says so with its run and evidence', () => {
const beforeUpload = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
const ready = renderPublicComment(state({ links: beforeUpload }));
assert.match(platformRow(ready, 'iOS'), /\| 🟩 3 changes · 6m 12s \| \[run\]\(<[^>]+>\) \|$/, 'before the artifact exists there is nothing to open');
assert.doesNotMatch(ready, /\[zip\]|\[Open\]/);
assert.equal(titleOf(ready), '### 3 screens changed', 'before the artifact exists there is nothing to open');
assert.match(subtitleOf(ready), /^<sub>iOS · \[bbbbbbbb\]/);
assert.match(ready, /\n- Added `\/cats\/care-guide`\n/);
assert.doesNotMatch(ready, /\[zip\]|\[Open\]|Review in Explore|explore-preview/);
const failed = renderPublicComment(state({ phase: 'failed', review: undefined, evidence: undefined, failure: { step: 'capture-head', message: 'head capture did not complete; token=abc123 leaked' } }));
assert.equal(platformRow(failed, 'iOS'), `| iOS | iPhone 17 26\\.5 · Example 1\\.4\\.0 \\(27\\) | 🟥 failed · capture\\-head | ${runLink} · [evidence](<https://github.com/expo/explore-playground/actions/runs/42#artifacts>) |`);
assert.deepEqual(summaries(failed), ['Validation · iOS 🟥 failed']);
assert.match(failed, /\*\*iOS failed\*\* — head capture did not complete; token=\\\[redacted\\\] leaked \[Open the failed run\]\(<[^>]+>\) · \[Evidence artifact\]\(<[^>]+>\)/);
assert.equal(checkRow(failed, 'Capture'), '| Capture | 🟥 6/6 surfaces |');
assert.equal(checkRow(failed, 'Visual comparison'), '| Visual comparison | — |');
assert.doesNotMatch(failed, /\*\*Changes\*\*|\[Open\]|\[zip\]|abc123/);
assert.equal(titleOf(failed), '### Explore review · capture failed');
assert.equal(statusOf(failed, 'iOS'), `**iOS failed** · capture\\-head · head capture did not complete; token=\\[redacted\\] leaked · ${runLink} · ${evidenceLink}`);
assert.deepEqual(listOf(failed), []);
assert.doesNotMatch(failed, /\[Open\]|\[zip\]|abc123|Review in Explore|Validation/);
});
test('a secondary appearance surface (<route>@<scheme>) is listed with its scheme and deep-linked like any other route', () => {
const dark = surface('settings@dark', 'added', { route: '/settings', extra: { colorScheme: 'dark', review: { status: 'added', description: 'Added the dark appearance of /settings.' } } });
const body = renderPublicComment(state({ review: review([dark]) }));
assert.match(body, /\n- `\/settings` \(dark\) — Added [^·]+ · \[iOS\]\(<[^>]+&view=compare&screen=settings%40dark>\)\n/);
assert.match(body, /\n- Added \[`\/settings`\]\(<[^>]+&view=compare&screen=settings%40dark>\) \(dark\)\n/, 'an added screen needs no description beyond its route');
});
test('agent notes replace descriptions without changing groups, counts, or the rest of the comment', () => {
test('agent notes replace descriptions without changing counts or the rest of the comment', () => {
const original = evidenceReview();
const annotated = structuredClone(original);
for (const [index, text] of [[0, 'Added care guidance and a daily reminder action.'], [1, 'Removed the Sweet Bee activity screen.'], [2, 'The settings share action now reads “Share Example”.']]) {
@@ -149,83 +150,78 @@ test('agent notes replace descriptions without changing groups, counts, or the r
}
const before = visible(renderPublicComment(state({ review: original })));
const after = visible(renderPublicComment(state({ review: annotated })));
assert.deepEqual(summaries(after), summaries(before));
assert.equal(after.slice(after.indexOf('<summary>Validation')), before.slice(before.indexOf('<summary>Validation')));
assert.equal(after.slice(0, after.indexOf('**Changes**')), before.slice(0, before.indexOf('**Changes**')));
assert.match(after, /Added care guidance and a daily reminder action/);
assert.match(after, /The settings share action now reads “Share Example”/);
assert.equal(titleOf(after), titleOf(before));
assert.equal(subtitleOf(after), subtitleOf(before));
assert.equal(after.split('\n').at(-1), before.split('\n').at(-1));
assert.equal(listOf(after).length, listOf(before).length);
assert.match(after, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · Added care guidance and a daily reminder action\n/, 'a note on an added screen follows the route');
assert.match(after, /\n- \[`\/settings`\]\(<[^>]+>\) · The settings share action now reads “Share Example”\n/);
assert.doesNotMatch(after, /Changed button title from|evidenceDigest|Model|Tokens/);
});
test('a long group is capped before the body budget and the comment stays under GitHub\'s limit', () => {
const many = review(Array.from({ length: 40 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
review: { status: 'modified', description: `Changed ${index}` },
test('the list shows ten screens and links the rest; the comment stays under GitHub\'s limit', () => {
const screens = (count, description) => review(Array.from({ length: count }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
review: { status: 'modified', description: description(index) },
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' },
} })));
const body = renderPublicComment(state({ review: many, capture: { planned: { base: 40, head: 40 }, done: { base: 40, head: 40 }, baseFromCache: false } }));
assert.match(body, /<summary>🟧 Modified \(40\)<\/summary>/);
assert.equal((body.match(/\n- `\/screen-\d+`/g) ?? []).length, 40);
const body = renderPublicComment(state({ review: screens(40, index => `Changed ${index}`), capture: { planned: { base: 40, head: 40 }, done: { base: 40, head: 40 }, baseFromCache: false } }));
assert.equal(titleOf(body), `### 40 screens changed · [Review in Explore](<${reportUrl}>)`);
assert.equal((body.match(/\n- \[`\/screen-\d+`\]/g) ?? []).length, 10);
assert.equal(listOf(body).at(-1), `- [30 more screens in the report](<${reportUrl}>)`);
assert.ok(body.length < PUBLIC_COMMENT_BODY_BUDGET);
const huge = review(Array.from({ length: 900 }, (_, index) => surface(`s${index}`, 'modified', { extra: { review: { status: 'modified', description: `Changed ${index} in a way that takes a sentence to describe for the budget check.` } } })));
const long = renderPublicComment(state({ review: huge }));
assert.equal(listOf(renderPublicComment(state({ review: screens(11, () => 'Changed') }))).at(-1), `- [1 more screen in the report](<${reportUrl}>)`);
assert.equal(listOf(renderPublicComment(state({ review: screens(10, () => 'Changed') }))).length, 10, 'ten screens need no link to the rest');
const long = renderPublicComment(state({ review: screens(900, index => `Changed ${index} in a way that takes a sentence to describe for the budget check.`) }));
assert.ok(long.length < PUBLIC_COMMENT_BODY_BUDGET, String(long.length));
assert.match(long, /<summary>🟧 Modified \(900\)<\/summary>/);
assert.match(long, /\n- \d+ more — \[Explore report\]\(<[^>]+>\)\n/);
assert.match(titleOf(long), /^### 900 screens changed · /);
assert.match(long, /\n- \[890 more screens in the report\]\(<[^>]+>\)\n/);
});
test('pending and capturing runs show progress in the platform table and no change lists', () => {
const links = viewerLinks({ viewerUrl: 'https://explore-preview.expo.app/map', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
test('pending and capturing runs say what they are doing in the heading and a line per target, with no list', () => {
const links = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
const pending = renderPublicComment(state({ phase: 'pending', links, review: undefined, evidence: undefined, runtime: undefined, capture: { planned: { base: 3, head: 3 }, done: { base: 0, head: 0 }, baseFromCache: false } }));
assert.equal(platformRow(pending, 'iOS'), `| iOS | Example 1\\.4\\.0 \\(27\\) | ⏳ starting | ${runLink} |`);
assert.equal(titleOf(pending), '### Explore review · starting');
assert.equal(subtitleOf(pending), `<sub>iOS · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
assert.equal(statusOf(pending, 'iOS'), `iOS · starting · ${runLink}`);
assert.deepEqual(listOf(pending), []);
assert.deepEqual(summaries(pending), []);
assert.doesNotMatch(pending, /\*\*Changes\*\*|Validation|Waiting|Open|zip/);
const progress = (current, baseFromCache) => platformRow(renderPublicComment(state({ phase: 'capturing', links, review: undefined, evidence: undefined,
assert.doesNotMatch(pending, /changed|Review in Explore|Validation|Waiting|Open|zip/);
const progress = (current, baseFromCache) => statusOf(renderPublicComment(state({ phase: 'capturing', links, review: undefined, evidence: undefined,
capture: { planned: { base: 3, head: 3 }, done: { base: 2, head: 1 }, baseFromCache, current } })), 'iOS');
assert.match(progress('base', false), /\| ⏳ capturing base 2\/3 \| /);
assert.match(progress('head', false), /\| ⏳ capturing head 1\/3 \| /);
assert.match(progress('head', true), /\| ⏳ capturing head 1\/3 · base reused \| /);
assert.match(progress(undefined, false), /\| ⏳ capturing head 1\/3 \| /);
assert.equal(progress('base', false), `iOS · capturing base 2/3 · ${runLink}`);
assert.equal(progress('head', false), `iOS · capturing head 1/3 · ${runLink}`);
assert.equal(progress('head', true), `iOS · capturing head 1/3 · base reused · ${runLink}`);
assert.equal(progress(undefined, false), `iOS · capturing head 1/3 · ${runLink}`);
assert.equal(titleOf(renderPublicComment(state({ phase: 'capturing', links, review: undefined, evidence: undefined }))), '### Explore review · capturing');
const none = renderPublicComment(state({ review: review([surface('cats', 'modified', { extra: { review: { status: 'unchanged', description: 'No visible change' } } })]) }));
assert.deepEqual(summaries(none), ['Validation · iOS 🟩 6/6 captured'], 'unchanged surfaces produce no group');
assert.match(none, /\*\*Changes\*\* · 0 screens\n\nNo screen changed on the reviewed platforms\./);
assert.equal(titleOf(none), `### No screens changed · [Review in Explore](<${reportUrl}>)`, 'unchanged surfaces are no change');
assert.deepEqual(listOf(none), []);
});
test('an OS version the simulator did not report is omitted, not shown as unknown', () => {
const body = renderPublicComment(state({ runtime: { ...state().runtime, osVersion: 'unknown' } }));
assert.match(platformRow(body, 'iOS'), /^\| iOS \| iPhone 17 · Example 1\\\.4\\\.0 \\\(27\\\) \|/);
assert.doesNotMatch(body, /unknown/i);
});
test('without evidence the comment lists only added and removed screens and says comparisons did not run', () => {
test('without evidence the comment lists only added and removed screens and counts the uncompared one', () => {
const plain = review([surface('care-guide', 'added'), surface('sweet-bee', 'removed'), surface('settings', 'modified'), surface('cats', 'unchanged')]);
const body = renderPublicComment(reviewOnlyState(plain));
// A source change nobody compared is not a change the captures show.
assert.deepEqual(summaries(body).slice(0, 2), ['🟩 Added (1)', '🟥 Removed (1)']);
assert.doesNotMatch(body, /Source-affected|screen=settings/);
assert.equal(checkRow(body, 'Visual comparison'), '| Visual comparison | 🟨 not run |');
assert.equal(checkRow(body, 'Accessibility comparison'), '| Accessibility comparison | 🟨 not run |');
assert.match(platformRow(body, 'iOS'), /^\| iOS \| Example 1\\\.4\\\.0 \\\(27\\\) \| 🟨 2 changes · 1 not compared · 0s \|/, 'the uncompared /settings is counted, not hidden');
assert.doesNotMatch(body, /Needs review|Unchanged|screen=cats/);
assert.match(titleOf(body), /^### 2 screens changed · /);
assert.deepEqual(listOf(body).map(line => /^- (Added|Removed) /.exec(line)?.[1]), ['Added', 'Removed']);
assert.equal(statusOf(body, 'iOS'), `iOS · 1 not compared · ${runLink}`, 'the uncompared /settings is counted, not hidden');
assert.doesNotMatch(body, /Source-affected|screen=settings|Needs review|Unchanged|screen=cats|not run/);
});
test('the completed duration stays tied to the captured review when the comment is republished', () => {
const original = platformRow(renderPublicComment(state()), 'iOS');
assert.equal(platformRow(renderPublicComment(state({ updatedAt: Date.parse('2026-09-12T09:42:00Z') })), 'iOS'), original);
assert.match(original, /🟩 3 changes · 6m 12s/);
assert.doesNotMatch(renderPublicComment(state({ phase: 'capturing', review: undefined })), /6m 12s/);
test('the subtitle says when the comment last changed: the review\'s time once ready, the writer\'s before', () => {
assert.match(subtitleOf(renderPublicComment(state({ updatedAt: Date.parse('2026-09-12T09:42:00Z') }))), /· updated Sep 11, 3:07 AM UTC<\/sub>$/, 'a republished review keeps its time');
assert.match(subtitleOf(renderPublicComment(state({ phase: 'capturing', review: undefined, updatedAt: Date.parse('2026-09-12T09:42:00Z') }))), /· updated Sep 12, 9:42 AM UTC<\/sub>$/);
});
test('needs-review surfaces keep their group and validation status without capture warnings', () => {
test('needs-review surfaces are tagged on their row; screen variants and capture warnings stay out', () => {
const flagged = evidenceReview();
flagged.surfaces[2].review = { status: 'needs-review', description: 'Screenshots differ (2.1%) without a source change' };
flagged.surfaces.push(surface('coins', 'unchanged', { extra: { sourceScope: 'none', review: { status: 'variant', description: 'Runtime state differs: Removed text “84”.' },
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 0.2, threshold: 0.1, tool: '[email protected]' } } }));
const body = renderPublicComment(state({ review: flagged, warnings: ['src/app/orphan.tsx has unresolved navigation'], inventory: { routes: 54 } }));
assert.match(body, /<summary>🟨 Needs review \(1\)<\/summary>/);
assert.doesNotMatch(body, /<summary>🟧 Modified/);
assert.match(body, /\n- `\/settings` — Screenshots differ \\\(2\\\.1%\\\) without a source change · \[iOS\]/);
assert.equal(checkRow(body, 'Source inventory'), '| Source inventory | 🟩 54 routes |');
assert.doesNotMatch(body, /Capture warnings|orphan/);
assert.match(titleOf(body), /^### 3 screens changed · /);
assert.match(body, /\n- \[`\/settings`\]\(<[^>]+>\) · Screenshots differ \\\(2\\\.1%\\\) without a source change · needs review\n/);
assert.doesNotMatch(body, /coins|Capture warnings|orphan|Needs review \(|54 routes/);
});
test('text is redacted and escaped before it reaches the comment, and credentialed links are refused', () => {
@@ -236,19 +232,18 @@ test('text is redacted and escaped before it reaches the comment, and credential
assert.throws(() => renderPublicComment(state({ links: { ...state().links, run: 'https://user:[email protected]/x' } })), /credentials/);
});
test('completed partial capture shows unavailable targets rather than ongoing work', () => {
test('a completed partial capture gets one line with the count of missing captures, not ongoing work', () => {
const capture = { planned: { base: 34, head: 34 }, done: { base: 21, head: 34 }, baseFromCache: false };
const ready = renderPublicComment(state({ capture }));
assert.equal(checkRow(ready, 'Capture'), '| Capture | 🟨 55/68 surfaces · 13 unavailable |');
assert.match(platformRow(ready, 'iOS'), /\| 🟨 3 changes · 13 unavailable · 6m 12s \|/);
assert.doesNotMatch(ready, /⏳/);
assert.equal(checkRow(renderPublicComment(state({ phase: 'failed', capture, failure: { step: 'capture-base', message: 'failed' } })), 'Capture'), '| Capture | 🟥 55/68 surfaces |');
assert.equal(checkRow(renderPublicComment(state({ capture: { ...capture, done: { base: 34, head: 34 } } })), 'Capture'), '| Capture | 🟩 68/68 surfaces |');
assert.equal(checkRow(renderPublicComment(state({ capture: { ...capture, done: { base: 0, head: 0 } } })), 'Capture'), '| Capture | 🟨 6/68 surfaces · 62 unavailable |', 'the review’s own frames count as captured');
assert.equal(checkRow(renderPublicComment(state({ capture: { ...capture, baseFromCache: true } })), 'Capture'), '| Capture | 🟨 55/68 surfaces · 13 unavailable · base cache reused |');
assert.equal(statusOf(ready, 'iOS'), `iOS · 13 captures unavailable · ${runLink}`);
assert.match(titleOf(ready), /^### 3 screens changed · /);
assert.doesNotMatch(ready, /⏳|Capture issues|surfaces/);
assert.equal(statusOf(renderPublicComment(state({ phase: 'failed', capture, failure: { step: 'capture-base', message: 'failed' } })), 'iOS'), `**iOS failed** · capture\\-base · failed · ${runLink} · ${evidenceLink}`);
assert.equal(statusOf(renderPublicComment(state({ capture: { ...capture, done: { base: 34, head: 34 } } })), 'iOS'), undefined, 'a complete capture needs no line');
assert.equal(statusOf(renderPublicComment(state({ capture: { ...capture, done: { base: 0, head: 0 } } })), 'iOS'), `iOS · 62 captures unavailable · ${runLink}`, 'the review’s own frames count as captured');
});
test('capture problems are listed as diagnostics inside the validation block with both sides', () => {
test('capture problems are counted on the target\'s line and listed, collapsed, with both sides', () => {
const flagged = evidenceReview();
const failure = side => ({ status: 'failed', attempts: 1, landing: 'unverified', error: {
code: `${side.toUpperCase()}_SESSION_FAILED`, stage: 'capture', message: `${side} simulator disconnected; token=private`,
@@ -262,17 +257,18 @@ test('capture problems are listed as diagnostics inside the validation block wit
flagged.surfaces[2].headOutcome.landing = 'unverified';
flagged.surfaces[2].review = { status: 'needs-review', description: 'old destination failure' };
const body = renderPublicComment(state({ review: flagged, capture: { planned: { base: 3, head: 3 }, done: { base: 1, head: 2 }, baseFromCache: false } }));
// /settings could not be compared, so it is no change: its failures are named under Validation.
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', 'Validation · iOS 🟨 3/6 captured']);
assert.match(platformRow(body, 'iOS'), /\| 🟨 2 changes · 3 unavailable · 1 unattributed · 6m 12s \|/);
// /settings could not be compared, so it is no change: its failures are named under Capture issues.
assert.match(titleOf(body), /^### 2 screens changed · /);
assert.equal(statusOf(body, 'iOS'), `iOS · 3 captures unavailable · 1 unattributed · ${runLink}`);
assert.deepEqual(summaries(body), ['Capture issues (4)']);
assert.ok(body.indexOf('<summary>Capture issues') > body.indexOf('\n- Removed '), 'the list comes first');
assert.match(body, /\n- Base · \/settings · /);
assert.match(body, /\*\*iOS\*\* · base 1\/3 verified · 2 unavailable · head 1\/3 verified · 1 unattributed · 1 unavailable/);
assert.match(body, /\n- Base · \/cats\/sweet\\-bee · BASE\\_SESSION\\_FAILED: base simulator disconnected; token=\\\[redacted\\\] Next action: Restart the base simulator session and rerun capture\\\./);
assert.match(body, /\n- Head · \/cats\/care\\-guide · HEAD\\_SESSION\\_FAILED/);
assert.doesNotMatch(body, /Needs review|Modified|old capture|old destination|token=private/);
assert.doesNotMatch(body, /needs review|Modified|old capture|old destination|token=private|\*\*iOS\*\*|Validation/);
});
test('zero eligible pairs are visibly skipped instead of successful comparisons', () => {
test('zero eligible pairs are counted as unattributed instead of successful comparisons', () => {
const flagged = evidenceReview();
for (const surface of flagged.surfaces) {
for (const side of ['base', 'head']) if (surface[`${side}Outcome`]) surface[`${side}Outcome`].landing = 'unverified';
@@ -284,30 +280,29 @@ test('zero eligible pairs are visibly skipped instead of successful comparisons'
visual: { compared: 0, modified: 0, unchanged: 0, needsReview: 0, failed: 0, errors: [], threshold: 0.1, tool: '[email protected]' },
accessibility: { compared: 0, described: 0, failed: 0, skipped: 0, errors: [] },
} }));
assert.equal(checkRow(body, 'Route verification'), '| Route verification | 🟨 0/6 verified · 6 unattributed |');
assert.equal(checkRow(body, 'Visual comparison'), '| Visual comparison | 🟨 0 compared · threshold 0.1 · 2 skipped |');
assert.equal(checkRow(body, 'Accessibility comparison'), '| Accessibility comparison | 🟨 0 compared · 0 descriptions |');
assert.match(platformRow(body, 'iOS'), /\| 🟨 2 changes · 6 unattributed · 6m 12s \|/, 'the uncompared modified screens are not changes');
assert.match(titleOf(body), /^### 2 screens changed · /, 'the uncompared modified screens are not changes');
assert.equal(statusOf(body, 'iOS'), `iOS · 6 unattributed · ${runLink}`);
});
test('the review-only comment counts failed outcomes in planned coverage and lists the reason', () => {
test('the review-only comment counts failed outcomes as unavailable and lists the reason', () => {
const added = surface('added', 'added');
delete added.headImage;
added.headOutcome = { status: 'missing-params', attempts: 0, landing: 'unverified', reason: 'Provide the item ID.' };
const body = renderPublicComment(reviewOnlyState(review([added])));
assert.equal(checkRow(body, 'Capture'), '| Capture | 🟨 0/1 surfaces · 1 unavailable |');
assert.match(body, /<summary>🟩 Added \(1\)<\/summary>/);
assert.equal(statusOf(body, 'iOS'), `iOS · 1 capture unavailable · ${runLink}`);
assert.match(body, /\n- Added \[`\/added`\]\(<[^>]+screen=added>\)\n/);
assert.deepEqual(summaries(body), ['Capture issues (1)']);
assert.match(body, /CAPTURE\\_UNAVAILABLE: Provide the item ID\\\./);
});
test('a failed run keeps the source additions and removals of its partial report', () => {
test('a failed run keeps its message on the target\'s line and lists nothing', () => {
const body = renderPublicComment(state({ phase: 'failed', failure: { step: 'capture', message: 'Capture coverage is incomplete.' } }));
assert.match(platformRow(body, 'iOS'), /\| 🟥 failed · capture \|/);
assert.match(body, /\*\*iOS failed\*\* — Capture coverage is incomplete\\\./);
assert.doesNotMatch(body, /\*\*Changes\*\*|🟩 Added/, 'a failed run has no review to list');
assert.equal(titleOf(body), '### Explore review · capture failed');
assert.equal(statusOf(body, 'iOS'), `**iOS failed** · capture · Capture coverage is incomplete\\. · ${runLink} · ${evidenceLink}`);
assert.deepEqual(listOf(body), [], 'a failed run has no review to list');
});
test('screen variants and app-wide changes are stated once, not listed as review targets', () => {
test('screen variants and app-wide source changes are left to the report', () => {
const variant = surface('coins', 'unchanged', { extra: { sourceScope: 'none',
review: { status: 'variant', description: 'Runtime state differs: Removed text “84”.' },
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 0.2, threshold: 0.1, tool: '[email protected]' } } });
@@ -315,29 +310,40 @@ test('screen variants and app-wide changes are stated once, not listed as review
review: { status: 'unchanged', description: 'No visible change' },
sourceChange: { ...sourceChange('Dependency update.', 'global'), files: [{ path: 'package.json', status: 'modified', relation: 'global', hunks: [], facts: [], truncated: false }] } } });
const body = renderPublicComment(state({ review: review([...evidenceReview().surfaces, variant, appWide]) }));
assert.doesNotMatch(body, /\/coins|\/profile|Needs review \(/);
assert.match(body, /1 screen differs only in runtime state \(screen variants\); no source change reaches it\./);
assert.match(body, /App-wide source changes \(`package\.json`\) reach every screen; screens without a visible difference are not listed\./);
assert.match(titleOf(body), /^### 3 screens changed · /);
assert.doesNotMatch(body, /\/coins|\/profile|runtime state|App-wide|package\.json/);
});
test('a hosted preview is the Open link, the footer keeps the zip and run and says how long the link works', () => {
test('a changed splash screen is one line after the list; an unchanged one is not mentioned', () => {
const launch = verdict => ({ ...evidenceReview(), launch: [
{ colorScheme: 'light', head: { status: 'observed', source: 'recording', splashVisibleMs: 900, firstScreenMs: 1900 }, base: { status: 'observed' }, visual: { verdict } },
{ colorScheme: 'dark', head: { status: 'observed', source: 'recording', splashVisibleMs: 900, firstScreenMs: 1900 }, base: { status: 'observed' }, visual: { verdict: 'unchanged' } }] });
const changed = renderPublicComment(state({ review: launch('modified'), artifactOnly: true }));
assert.match(changed, /\n- \[`\/settings`\][^\n]+\n\nSplash screen changed in light mode\n\n<sub>/);
assert.match(renderPublicComment(state({ review: launch('needs-review'), artifactOnly: true })), /\nSplash screen needs review in light mode\n/);
assert.doesNotMatch(renderPublicComment(state({ review: launch('unchanged'), artifactOnly: true })), /Splash|Launch|first screen/);
const both = { ...evidenceReview(), launch: [{ head: { status: 'observed', source: 'recording' }, base: { status: 'observed' }, visual: { verdict: 'modified' } }] };
assert.match(renderPublicComment(state({ review: both, artifactOnly: true })), /\nSplash screen changed\n/);
});
test('a hosted preview is the report link, and the footer says how long the links work', () => {
const token = 'abcdefghijklmnopqrstuvwxyz234567';
const preview = previewLinks(`https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`, Date.parse('2026-09-18T03:07:00Z'));
const links = { ...viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml', artifactUrl }), preview };
const body = renderPublicComment(state({ links, artifactOnly: true }));
const lines = body.split('\n');
assert.equal(lines[1], '<!-- expo-explore-deployments:acme-explore--1lcbdcpwn3 -->');
assert.match(platformRow(body, 'iOS'), new RegExp(`\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\) \\|$`));
assert.match(lines.at(-1), /· Workflow \[run\]\(<[^>]+>\) · \[zip\]\(<[^>]+>\)$/);
assert.match(body, new RegExp(`\\[iOS\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?view=compare&screen=settings>\\)`));
assert.match(lines.at(-1), /^Preview links work until Sep 18, 2026 \(UTC\) for anyone who has them\. · Managed via /);
assert.doesNotMatch(body, /Open Explore|explore-viewer\.expo\.app|explore-preview\.expo\.app/);
assert.equal(titleOf(body), `### 3 screens changed · [Review in Explore](<https://acme-explore--1lcbdcpwn3.expo.app/p/${token}>)`);
assert.equal(subtitleOf(body), `<sub>[iOS](<https://acme-explore--1lcbdcpwn3.expo.app/p/${token}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
assert.match(body, new RegExp(`\\n- \\[\`/settings\`\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?view=compare&screen=settings>\\) · `));
assert.equal(lines.at(-1), `<sub>Preview links work for anyone who has them until Sep 18, 2026 (UTC) · ${workflowRun} · ${configLink}</sub>`);
assert.doesNotMatch(body, /Open Explore|explore-viewer\.expo\.app|explore-preview\.expo\.app|zip/);
assert.doesNotMatch(renderPublicComment(state({ links, phase: 'failed', review: undefined, failure: { step: 'capture-head', message: 'boom' } })), /acme-explore--1lcbdcpwn3\.expo\.app\/p|for anyone who has/);
const forever = renderPublicComment(state({ links: { ...links, preview: previewLinks(`https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`, null) }, artifactOnly: true }));
assert.match(forever, /\nPreview links work for anyone who has them until the deployment is deleted\. · Managed via /);
assert.match(forever, /\n<sub>Preview links work for anyone who has them until the deployment is deleted · \[Workflow run\]/);
});
test('two platforms share one comment: one table row each, every changed screen listed once with a link per platform, one validation table', async () => {
test('two platforms share one comment: both named in the subtitle, every changed screen listed once, a line only for the one still working', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const ready = state({ artifactOnly: true });
const single = renderPublicComment(ready);
@@ -347,29 +353,24 @@ test('two platforms share one comment: one table row each, every changed screen
runtime: { ...state().runtime, platform: 'android', deviceModel: 'EasAndroidDevice01', osVersion: '15.0' }, ...overrides });
const capturing = platformSectionMerge(androidState({ phase: 'capturing', review: undefined, evidence: undefined, capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 1 }, baseFromCache: false, current: 'head' } }), 'android').merge(single);
assert.deepEqual(Object.keys(readCommentRecords(capturing).current), ['ios', 'android']);
assert.equal(platformRow(capturing, 'iOS'), platformRow(single, 'iOS'));
assert.equal(platformRow(capturing, 'Android'), `| Android | EasAndroidDevice01 15\\.0 · Example 1\\.4\\.0 \\(27\\) | ⏳ capturing head 1/3 | ${runLink} |`);
assert.deepEqual(summaries(capturing), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', 'Validation · iOS 🟩 6/6 captured · Android ⏳ in progress']);
assert.match(capturing, /\| Check \| iOS \| Android \|\n\|---\|---\|---\|\n\| Capture \| 🟩 6\/6 surfaces · base cache reused \| ⏳ \|/);
assert.match(capturing, /\n- `\/settings` — Changed button title from “Share” to “Share Example”\\\. · \[iOS\]\(<[^>]+>\)\n/, 'a platform still capturing adds no link');
assert.equal(titleOf(capturing), titleOf(single), 'a platform still capturing has no report to link yet');
assert.equal(subtitleOf(capturing), `<sub>[iOS](<${reportUrl}>) · Android · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
assert.equal(statusOf(capturing, 'Android'), `Android · capturing head 1/3 · ${runLink}`);
assert.equal(statusOf(capturing, 'iOS'), undefined);
assert.deepEqual(listOf(capturing), listOf(single), 'a platform still capturing adds nothing to the list');
const flagged = evidenceReview();
flagged.surfaces[2].review = { status: 'needs-review', description: 'Screenshots differ (2.1%) without a source change' };
flagged.surfaces.push(surface('coins', 'unchanged', { extra: { sourceScope: 'none', review: { status: 'variant', description: 'Runtime state differs: Removed text “84”.' },
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 0.2, threshold: 0.1, tool: '[email protected]' } } }));
const both = platformSectionMerge(androidState({ review: flagged }), 'android').merge(capturing);
assert.deepEqual(Object.keys(readCommentRecords(both).current), ['ios', 'android']);
assert.equal(platformRow(both, 'iOS'), platformRow(single, 'iOS'));
assert.match(platformRow(both, 'Android'), /^\| Android \| EasAndroidDevice01 15\\\.0 · Example 1\\\.4\\\.0 \\\(27\\\) \| 🟩 3 changes · 6m 12s \| \[Open\]/);
assert.match(both, /\*\*Changes\*\* · 3 screens · a screen is listed once, with a link per platform\n/);
assert.match(capturing, /^### Explore review · \[Open report\]\(<[^>]+>\)$/m, 'a platform still capturing has no report to link yet');
assert.match(both, /^### Explore review · \[iOS report\]\(<[^>]+>\) · \[Android report\]\(<[^>]+>\)$/m, 'with two platforms the heading links each report');
assert.match(both, /\nAndroid · 1 screen differs only in runtime state \(screen variants\); no source change reaches it\.\n/, 'a context line from one platform names it');
assert.doesNotMatch(both, /iOS · /);
assert.match(both, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iOS\]\(<[^>]+screen=care-guide>\) · \[Android\]\(<[^>]+screen=care-guide>\)\n/);
assert.match(both, /\n- `\/settings` — Changed button title from “Share” to “Share Example”\\\. · \[iOS\]\(<[^>]+>\) · \[Android \(needs review\)\]\(<[^>]+>\)\n/, 'a platform whose verdict differs says so on the row');
assert.deepEqual(summaries(both), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', 'Validation · iOS 🟩 6/6 captured · Android 🟩 8/8 captured']);
assert.equal((both.match(/\n- `/g) ?? []).length, 3, 'no screen is listed twice');
assert.equal((both.match(/\| Capture \|/g) ?? []).length, 1);
assert.equal(titleOf(both), titleOf(single), 'the heading links the first platform’s report');
assert.match(subtitleOf(both), /^<sub>\[iOS\]\(<[^>]+artifact=7654>\) · \[Android\]\(<[^>]+artifact=7654>\) · \[bbbbbbbb\]/);
assert.equal(statusOf(both, 'Android'), undefined);
assert.equal(listOf(both).length, 3, 'no screen is listed twice');
assert.match(both, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+screen=care-guide>\)\n/);
assert.match(both, /\n- \[`\/settings`\]\(<[^>]+>\) · Changed button title from “Share” to “Share Example”\n/, 'a platform whose verdict differs does not change the row');
assert.doesNotMatch(both, / only\n|not on |coins|runtime state|iOS · /);
assert.ok(both.length < 8_000, String(both.length));
// A writer that finds no records (a legacy or hand-edited comment) starts over rather than failing.
const legacy = `${CI_COMMENT_MARKER}\nExplore review for x\n<!-- expo-explore-platform:ios -->\n## iOS · 3 changes\n<!-- /expo-explore-platform:ios -->`;
@@ -378,32 +379,68 @@ test('two platforms share one comment: one table row each, every changed screen
assert.equal(platformSectionMerge(ready, 'ios').merge(tampered), single);
});
test('a newer run moves the current run into Previous runs; a run the PR moved past joins history without displacing the current review', async () => {
test('a screen that changed on some devices only says which, the shorter way', async () => {
const { platformSectionMerge } = await import('../../dist/report/pr-comment-body.js');
const [iphone, closed, open, android] = duoTargets;
const settingsOnly = review([evidenceReview().surfaces[2]]);
let body;
for (const target of [iphone, closed, open]) body = platformSectionMerge(targetState(target), target.id).merge(body);
body = platformSectionMerge(targetState(android, { review: settingsOnly }), 'android').merge(body);
assert.match(body, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · not on Pixel 7\n/);
assert.match(body, /\n- \[`\/settings`\]\(<[^>]+>\) · Changed button title from “Share” to “Share Example”\n/, 'a screen changed everywhere names no device');
const two = platformSectionMerge(targetState(android, { review: settingsOnly }), 'android').merge(platformSectionMerge(targetState(iphone), 'iphone').merge(undefined));
assert.match(two, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · iPhone 17 only\n/);
// A device missing a capture may have changed the screen too: the row says where it changed, not where it did not.
const missing = platformSectionMerge(targetState(android, { review: settingsOnly, capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 2 }, baseFromCache: false } }), 'android')
.merge(platformSectionMerge(targetState(iphone), 'iphone').merge(undefined));
assert.match(missing, /\nPixel 7 · 1 capture unavailable · /);
assert.match(missing, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · on iPhone 17\n/);
assert.doesNotMatch(missing, / only\n|not on /);
});
test('a new run keeps the last finished review up, under a line saying it is working, until it has a finished target; the old run joins Previous runs', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const first = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
const androidReady = state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' } });
const both = platformSectionMerge(androidReady, 'android').merge(first);
const nextHead = 'd'.repeat(40);
const nextLinks = runId => viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId, runAttempt: '1', configPath: '.expo-explore/config.yaml' });
const nextLinks = (runId, artifact) => viewerLinks({ ...(artifact ? { artifactUrl: `https://github.com/expo/explore-playground/actions/runs/${runId}/artifacts/${artifact}` } : {}),
repository: pullRequest.repository, headSha: nextHead, runId, runAttempt: '1', configPath: '.expo-explore/config.yaml' });
const nextState = overrides => state({ phase: 'capturing', review: undefined, evidence: undefined, links: nextLinks('43'), pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
startedAt: Date.parse('2026-09-11T04:00:00Z'), updatedAt: Date.parse('2026-09-11T04:01:00Z'), capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 0 }, baseFromCache: true, current: 'head' }, ...overrides });
const next = platformSectionMerge(nextState(), 'ios').merge(both);
assert.match(next.split('\n').find(line => line.startsWith('<sub>')), /^<sub>base \[aaaaaaaa\]\(<[^>]+>\) → \[dddddddd\]/);
assert.equal(visible(next).split('\n')[1], `> **New run in progress** for [dddddddd](<https://github.com/expo/explore-playground/commit/${nextHead}>) · capturing on iOS · [run](<https://github.com/expo/explore-playground/actions/runs/43/attempts/1>)`);
assert.equal(titleOf(next), titleOf(both), 'the previous review stays up');
assert.equal(subtitleOf(next), subtitleOf(both));
assert.deepEqual(listOf(next), listOf(both));
assert.deepEqual(Object.keys(readCommentRecords(next).current), ['ios']);
assert.deepEqual(Object.keys(readCommentRecords(next).previous), ['ios', 'android']);
assert.deepEqual(summaries(next), ['Previous runs (1)']);
assert.match(next, /\n- \[bbbbbbbb\]\(<https:\/\/github\.com\/expo\/explore-playground\/commit\/b{40}>\) · iOS 🟩 3 changes \(\[report\]\(<https:\/\/explore-preview\.expo\.app\/\?repo=[^>]+&artifact=7654>\) · \[run\]\(<[^>]+runs\/42\/attempts\/2>\)\) · Android 🟩 3 changes \(\[report\]\(<[^>]+>\) · \[run\]\(<[^>]+>\)\)\n/);
assert.doesNotMatch(next, /\*\*Changes\*\*|screen=settings/);
// The previous run's Android report job finishes after the new run started: it is superseded and lands in history.
const late = platformSectionMerge(androidReady, 'android').merge(next);
assert.deepEqual(Object.keys(readCommentRecords(late).current), ['ios']);
assert.equal(readCommentRecords(late).history.length, 1);
assert.match(late, /^<sub>base \[aaaaaaaa\]\(<[^>]+>\) → \[dddddddd\]/m);
// The new run's Android writer joins the current run, and the previous run stays listed.
assert.equal(titleOf(late), titleOf(both));
// The new run's Android writer joins; nothing finished yet, so the previous review stays.
const joined = platformSectionMerge(nextState({ build: { ...state().build, platform: 'android' } }), 'android').merge(late);
assert.deepEqual(Object.keys(readCommentRecords(joined).current), ['ios', 'android']);
assert.match(visible(joined).split('\n')[1], /^> \*\*New run in progress\*\* for \[dddddddd\]\(<[^>]+>\) · capturing on iOS, Android · \[run\]/);
assert.deepEqual(listOf(joined), listOf(both));
assert.deepEqual(summaries(joined), ['Previous runs (1)']);
// The new run's iOS finishes: its review takes over; the previous Android record waits for the new one.
const iosDone = platformSectionMerge(nextState({ phase: 'ready', review: evidenceReview(), links: nextLinks('43', '7700') }), 'ios').merge(joined);
assert.doesNotMatch(iosDone, /New run in progress/);
assert.match(titleOf(iosDone), /^### 3 screens changed · \[Review in Explore\]\(<[^>]+artifact=7700>\)$/);
assert.match(subtitleOf(iosDone), /^<sub>\[iOS\]\(<[^>]+artifact=7700>\) · Android · \[dddddddd\]/);
assert.equal(statusOf(iosDone, 'Android'), 'Android · capturing head 0/3 · base reused · [run](<https://github.com/expo/explore-playground/actions/runs/43/attempts/1>)');
assert.deepEqual(Object.keys(readCommentRecords(iosDone).previous), ['android']);
const androidDone = platformSectionMerge(nextState({ phase: 'ready', review: evidenceReview(), links: nextLinks('43', '7700'), build: { ...state().build, platform: 'android' } }), 'android').merge(iosDone);
assert.equal(readCommentRecords(androidDone).previous, undefined, 'once every target finished nothing previous is kept');
assert.doesNotMatch(androidDone, /expo-explore-previous/);
assert.equal(statusOf(androidDone, 'Android'), undefined);
// Each later run pushes one more entry; history is capped.
let body = joined;
let body = androidDone;
for (let run = 44; run < 52; run += 1) {
const sha = run.toString(16).padStart(40, '0');
body = platformSectionMerge(state({ links: viewerLinks({ repository: pullRequest.repository, headSha: sha, runId: String(run), runAttempt: '1', configPath: '.expo-explore/config.yaml' }),
@@ -414,13 +451,112 @@ test('a newer run moves the current run into Previous runs; a run the PR moved p
assert.deepEqual(history.map(entry => entry.runId), ['50', '49', '48', '47', '46']);
assert.match(body, /<summary>Previous runs \(5\)<\/summary>/);
assert.ok(body.length < PUBLIC_COMMENT_BODY_BUDGET);
assert.doesNotMatch(body, /expo-explore-previous|New run in progress/);
// A state marked superseded by its own writer goes straight to history even when the comment has nothing newer yet.
const superseded = platformSectionMerge(state({ artifactOnly: true, superseded: true }), 'ios').merge(undefined);
assert.match(superseded, /The pull request moved while this run worked; its report is kept here until the current run replaces it\./);
assert.match(superseded, /^### Explore review\n\nThe pull request moved while this run worked; its report is kept here until the current run replaces it\./m);
const replaced = platformSectionMerge(nextState(), 'ios').merge(superseded);
assert.equal(titleOf(replaced), '### Explore review · capturing');
assert.match(replaced, /Previous runs \(1\)/);
});
test('the review a new run keeps up comes from one run: a target the last run never finished does not bring back an older run', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const androidOf = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' }, ...overrides });
const run = (runId, head, artifact) => ({ pullRequest: { ...pullRequest, head: { ref: 'feature', sha: head } },
links: viewerLinks({ ...(artifact ? { artifactUrl: `https://github.com/expo/explore-playground/actions/runs/${runId}/artifacts/${artifact}` } : {}),
repository: pullRequest.repository, headSha: head, runId, runAttempt: '1', configPath: '.expo-explore/config.yaml' }) });
const working = { phase: 'capturing', review: undefined, evidence: undefined };
const [c, d] = ['c'.repeat(40), 'd'.repeat(40)];
let body = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
body = platformSectionMerge(androidOf({}), 'android').merge(body);
// Run 43 finishes Android only; its iOS job never reports (cancelled).
body = platformSectionMerge(state({ ...working, ...run('43', c) }), 'ios').merge(body);
body = platformSectionMerge(androidOf({ ...run('43', c, '7800'), review: review([evidenceReview().surfaces[2]]) }), 'android').merge(body);
body = platformSectionMerge(state({ ...working, ...run('44', d) }), 'ios').merge(body);
const previous = readCommentRecords(body).previous;
assert.deepEqual(Object.keys(previous), ['android']);
assert.equal(previous.android.runId, '43');
assert.match(subtitleOf(body), /^<sub>\[Android\]\(<[^>]+artifact=7800>\) · \[cccccccc\]/);
assert.equal(titleOf(body), '### 1 screen changed · [Review in Explore](<https://explore-preview.expo.app/?repo=expo%2Fexplore-playground&run=43&attempt=1&artifact=7800>)');
assert.doesNotMatch(visible(body).split('<details>')[0], /artifact=7654/, 'run 42 is only under Previous runs');
});
test('a new run\'s failure does not replace the previous review: it is named on the new-run line until a target is ready', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const androidOf = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' }, ...overrides });
const both = platformSectionMerge(androidOf({}), 'android').merge(platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined));
const nextHead = 'd'.repeat(40);
const next = { pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) };
const commit = `[dddddddd](<https://github.com/expo/explore-playground/commit/${nextHead}>)`;
const run43 = '[run](<https://github.com/expo/explore-playground/actions/runs/43/attempts/1>) · [evidence](<https://github.com/expo/explore-playground/actions/runs/43#artifacts>)';
const failure = { phase: 'failed', review: undefined, evidence: undefined, failure: { step: 'capture-head', message: 'boom' } };
// Android fails before iOS posts anything.
const failed = platformSectionMerge(androidOf({ ...next, ...failure }), 'android').merge(both);
assert.equal(visible(failed).split('\n')[1], `> **New run failed** for ${commit} · **Android failed** · capture\\-head · boom · ${run43}`);
assert.equal(titleOf(failed), titleOf(both));
assert.deepEqual(listOf(failed), listOf(both));
assert.deepEqual(Object.keys(readCommentRecords(failed).previous), ['ios', 'android']);
const working = platformSectionMerge(state({ ...next, phase: 'capturing', review: undefined, evidence: undefined, capture: undefined }), 'ios').merge(failed);
assert.equal(visible(working).split('\n')[1], `> **New run in progress** for ${commit} · capturing on iOS · **Android failed** · capture\\-head · boom · ${run43}`);
assert.deepEqual(listOf(working), listOf(both));
// iOS is ready: its review takes over, and Android's failure is its own line.
const ready = platformSectionMerge(state({ ...next, artifactOnly: true }), 'ios').merge(working);
assert.doesNotMatch(ready, /New run|expo-explore-previous/);
assert.match(statusOf(ready, 'Android'), /^\*\*Android failed\*\* · capture\\-head · boom · /);
// A single target that failed keeps the review before it, and the run after it still has that review to keep.
const single = platformSectionMerge(state({ ...next, ...failure }), 'ios').merge(platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined));
assert.equal(visible(single).split('\n')[1], `> **New run failed** for ${commit} · capture\\-head · boom · ${run43}`);
assert.match(titleOf(single), /^### 3 screens changed · /);
const later = platformSectionMerge(state({ phase: 'capturing', review: undefined, evidence: undefined, capture: undefined,
links: viewerLinks({ repository: pullRequest.repository, headSha: 'e'.repeat(40), runId: '44', runAttempt: '1', configPath: '.expo-explore/config.yaml' }),
pullRequest: { ...pullRequest, head: { ref: 'feature', sha: 'e'.repeat(40) } } }), 'ios').merge(single);
assert.equal(readCommentRecords(later).previous.ios.runId, '42');
assert.match(titleOf(later), /^### 3 screens changed · /);
});
test('a rerun keeps the attempt it replaces up until the new attempt finishes', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const ready = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
const attempt3 = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '3', configPath: '.expo-explore/config.yaml' });
const rerun = platformSectionMerge(state({ phase: 'capturing', review: undefined, evidence: undefined, links: attempt3 }), 'ios').merge(ready);
assert.equal(visible(rerun).split('\n')[1], `> **New run in progress** for [bbbbbbbb](<https://github.com/expo/explore-playground/commit/${headSha}>) · capturing · [run](<https://github.com/expo/explore-playground/actions/runs/42/attempts/3>)`);
assert.equal(titleOf(rerun), titleOf(ready));
assert.deepEqual(listOf(rerun), listOf(ready));
assert.equal(readCommentRecords(rerun).previous.ios.runAttempt, '2');
// The same attempt writing again (capture progress, a republish) keeps nothing.
assert.equal(readCommentRecords(platformSectionMerge(state({ phase: 'capturing', review: undefined, evidence: undefined }), 'ios').merge(ready)).previous, undefined);
const done = platformSectionMerge(state({ artifactOnly: true, links: { ...attempt3, viewer: state().links.viewer } }), 'ios').merge(rerun);
assert.equal(readCommentRecords(done).previous, undefined);
assert.doesNotMatch(done, /New run in progress/);
});
test('over budget, the previous run\'s records go before the hidden state is cut', async () => {
const { readCommentRecords, renderCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const previous = platformRecordOf(state({ artifactOnly: true }));
const nextHead = 'd'.repeat(40);
const current = platformRecordOf(state({ phase: 'capturing', review: undefined, evidence: undefined, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }));
const records = { current: { ios: current }, previous: { ios: previous }, history: [] };
const full = renderCommentRecords(records);
assert.match(full, /New run in progress/);
assert.deepEqual(Object.keys(readCommentRecords(full).previous), ['ios']);
const without = renderCommentRecords({ current: { ios: current }, history: [] });
assert.equal(renderCommentRecords(records, undefined, without.length + 10), without);
// Once the new run shows a finished target, the previous records it still carries are hidden: they go before the list shrinks.
const twelve = review(Array.from({ length: 12 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
review: { status: 'modified', description: `Changed ${index} in a way that takes a sentence to describe for the budget check.` },
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' } } })));
const finished = platformRecordOf(state({ artifactOnly: true, review: twelve, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
links: viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/43/artifacts/7700', repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }));
const android = { ...current, platform: 'android' };
const hidden = { current: { ios: finished, android }, previous: { android: { ...previous, platform: 'android' } }, history: [] };
const lean = renderCommentRecords({ ...hidden, previous: {} });
assert.equal(renderCommentRecords(hidden, undefined, lean.length + 10), lean);
assert.equal(listOf(lean).length, 11, 'ten screens and the link to the rest');
});
test('the deployments line names every hosted preview the comment links right now, current and previous', async () => {
const { platformSectionMerge, existingDeploymentMarker } = await import('../../dist/report/pr-comment-body.js');
const marker = '<!-- expo-explore-deployments:acme-explore--abc123 -->';
@@ -437,24 +573,28 @@ test('the deployments line names every hosted preview the comment links right no
const next = state({ links: { ...viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }),
preview: previewLinks('https://acme-explore--def456.expo.app/p/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', Date.now() + 86_400_000) }, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } } });
assert.equal(platformSectionMerge(next, 'ios').merge(single).split('\n')[1], '<!-- expo-explore-deployments:acme-explore--abc123,acme-explore--def456 -->');
// While the new run works the previous run's preview is still the one on show.
const working = platformSectionMerge({ ...next, phase: 'capturing', review: undefined, evidence: undefined, links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }, 'ios').merge(single);
assert.equal(working.split('\n')[1], marker);
assert.equal(existingDeploymentMarker(`${CI_COMMENT_MARKER}\n<!-- expo-explore-deployments:Bad Host -->\nx`), undefined);
});
test('a report whose hosted preview is still deploying says so instead of linking the central Viewer', () => {
const deploying = renderPublicComment(state({ links: { ...state().links, deploying: true }, artifactOnly: true }));
assert.match(deploying, /^### Explore review · report deploying, not ready yet$/m, 'the heading says the report is not ready');
assert.equal(titleOf(deploying), '### 3 screens changed · report deploying…', 'the heading says the report is not ready');
assert.ok(!deploying.includes('explore-preview.expo.app'), 'no download-and-drop Viewer link while the hosted report is on its way');
assert.match(deploying, /\| deploying… \|/, 'the Report cell says so');
assert.match(deploying, /· Workflow \[run\]\(<[^>]+>\) · \[zip\]\(<[^>]+>\)$/, 'the footer keeps the zip and run');
assert.match(subtitleOf(deploying), /^<sub>iOS · \[bbbbbbbb\]/, 'nothing to link the platform to yet');
assert.match(deploying, /\n- Added `\/cats\/care-guide`\n/);
assert.equal(deploying.split('\n').at(-1), `<sub>${workflowRun} · ${configLink}</sub>`);
const deployed = renderPublicComment(state({ links: { ...state().links, deploying: true,
preview: previewLinks('https://acme-explore--1lcbdcpwn3.expo.app/p/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', null) } }));
assert.match(deployed, /^### Explore review · \[Open report\]\(<https:\/\/acme-explore--1lcbdcpwn3\.expo\.app[^>]*>\)$/m, 'once deployed the hosted report is the heading');
assert.match(titleOf(deployed), /^### 3 screens changed · \[Review in Explore\]\(<https:\/\/acme-explore--1lcbdcpwn3\.expo\.app[^>]*>\)$/, 'once deployed the hosted report is the heading');
const record = JSON.parse(JSON.stringify(platformRecordOf(state({ links: { ...state().links, deploying: true }, artifactOnly: true }))));
assert.equal(record.links.report, undefined, 'the record carries no report link while deploying');
assert.equal(parsePlatformRecord(record).links.deploying, true, 'the deploying flag survives the comment round trip');
});
test('a screen whose screenshots match but whose accessibility tree changed is listed as accessibility only, apart from the visual changes', () => {
test('a screen whose screenshots match but whose accessibility tree changed is listed after the visual changes, tagged accessibility only', () => {
const accessibilityOnly = (id) => surface(id, 'modified', { extra: {
review: { status: 'modified', description: 'Added button “Edit tempo”.', facts: [
{ category: 'element', templateId: 'element.added', bullet: 'Added button “Edit tempo”.' },
@@ -465,27 +605,28 @@ test('a screen whose screenshots match but whose accessibility tree changed is l
} });
const withAccessibility = review([...evidenceReview().surfaces, accessibilityOnly('device-picker'), accessibilityOnly('enable-midi')]);
const body = renderPublicComment(state({ review: withAccessibility, artifactOnly: true }));
assert.match(platformRow(body, 'iOS'), /\| 🟩 3 visual changes · 2 accessibility only · 6m 12s \|/);
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', '🟦 Accessibility only (2)', 'Validation · iOS 🟩 10/10 captured']);
assert.match(body, /\n\*\*Changes\*\* · 5 screens\n/);
assert.match(body, /<summary>🟦 Accessibility only \(2\)<\/summary>\n\nBefore and After look the same\. What screen readers and voice control read changed\.\n\n- `\/device-picker` — Added button “Edit tempo”\\\. · \[iOS\]/);
assert.match(titleOf(body), /^### 5 screens changed · /);
assert.deepEqual(listOf(body).slice(3), [
`- [\`/device-picker\`](<${reportUrl}&view=compare&screen=device-picker>) · Added button “Edit tempo” · accessibility only`,
`- [\`/enable-midi\`](<${reportUrl}&view=compare&screen=enable-midi>) · Added button “Edit tempo” · accessibility only`]);
assert.doesNotMatch(body, /Before and After look the same/);
const record = parsePlatformRecord(JSON.parse(JSON.stringify(platformRecordOf(state({ review: withAccessibility, artifactOnly: true })))));
assert.deepEqual(record.changes.filter(change => change.group === 'accessibility-only').map(change => change.id), ['device-picker', 'enable-midi'],
'the group survives the comment round trip');
// A comment with no accessibility-only screen keeps its plain count.
assert.match(platformRow(renderPublicComment(state({ artifactOnly: true })), 'iOS'), /\| 🟩 3 changes · 6m 12s \|/);
});
test('a comment whose only changes are for assistive technology counts just those', () => {
test('a comment whose only change is for assistive technology counts it like any other', () => {
const only = review([surface('device-picker', 'modified', { extra: {
review: { status: 'modified', description: 'Changed “Play” from a text to a button.', facts: [{ category: 'accessibility', templateId: 'accessibility.role-changed', bullet: 'Changed “Play” from a text to a button.' }] },
visual: { verdict: 'unchanged', reason: 'matched', mismatchPercentage: 0, threshold: 0.1, tool: '[email protected]' },
sourceChange: sourceChange('Made Play a button.'),
} })]);
assert.match(platformRow(renderPublicComment(state({ review: only, artifactOnly: true })), 'iOS'), /\| 🟩 1 accessibility only · 6m 12s \|/);
const body = renderPublicComment(state({ review: only, artifactOnly: true }));
assert.match(titleOf(body), /^### 1 screen changed · /);
assert.deepEqual(listOf(body), [`- [\`/device-picker\`](<${reportUrl}&view=compare&screen=device-picker>) · Changed “Play” from a text to a button · accessibility only`]);
});
test('a screen accessibility-only on iOS and visibly modified on Android is listed as Modified, whichever platform comes first', async () => {
test('a screen accessibility-only on iOS and visibly modified on Android is listed as the visible change, whichever platform comes first', async () => {
const { platformSectionMerge } = await import('../../dist/report/pr-comment-body.js');
const settings = (verdict) => {
const changed = evidenceReview();
@@ -494,25 +635,28 @@ test('a screen accessibility-only on iOS and visibly modified on Android is list
};
const androidState = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' },
runtime: { ...state().runtime, platform: 'android', deviceModel: 'EasAndroidDevice01', osVersion: '15.0' }, ...overrides });
const androidLinks = viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/42/artifacts/7700', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
const ios = renderPublicComment(state({ review: settings('unchanged'), artifactOnly: true }));
assert.ok(summaries(ios).includes('🟦 Accessibility only (1)'), 'iOS alone: the screenshots match');
const both = platformSectionMerge(androidState({ review: settings('modified') }), 'android').merge(ios);
assert.deepEqual(summaries(both).slice(0, 3), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)']);
assert.doesNotMatch(both, /Accessibility only \(|Before and After look the same/);
assert.match(both, /\n- `\/settings` — [^\n]+ · \[iOS \(accessibility only\)\]\(<[^>]+>\) · \[Android\]\(<[^>]+>\)\n/);
assert.match(ios, /\n- \[`\/settings`\]\(<[^>]+>\) · [^\n]+ · accessibility only\n/, 'iOS alone: the screenshots match');
const both = platformSectionMerge(androidState({ review: settings('modified'), links: androidLinks }), 'android').merge(ios);
assert.match(both, /\n- \[`\/settings`\]\(<[^>]+artifact=7700&view=compare&screen=settings>\) · Changed button title from “Share” to “Share Example”\n/, 'the link opens Android, where it changed visibly');
assert.doesNotMatch(both, /accessibility only/);
const androidFirst = platformSectionMerge(state({ review: settings('unchanged'), artifactOnly: true }), 'ios')
.merge(platformSectionMerge(androidState({ review: settings('modified'), links: androidLinks }), 'android').merge(undefined));
assert.match(androidFirst, /\n- \[`\/settings`\]\(<[^>]+artifact=7700&view=compare&screen=settings>\) · Changed button title from “Share” to “Share Example”\n/);
});
test('screens whose comparison did not run are counted as not compared, never as a green "no change"', () => {
const uncompared = review([surface('settings', 'modified'), surface('tempo', 'modified')]);
const body = renderPublicComment(state({ review: uncompared, artifactOnly: true }));
assert.match(platformRow(body, 'iOS'), /\| 🟨 0 changes · 2 not compared · 6m 12s \|/);
assert.match(body, /\nNo compared screen changed on the reviewed platforms\.\n/);
assert.equal(titleOf(body), `### No compared screens changed · [Review in Explore](<${reportUrl}>)`);
assert.equal(statusOf(body, 'iOS'), `iOS · 2 not compared · ${runLink}`);
// A screen that was never captured (outside the capture scope) stays out of the count.
const outOfScope = surface('channel', 'modified');
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete outOfScope[key];
const quiet = renderPublicComment(state({ review: review([outOfScope]), artifactOnly: true, evidence: undefined, capture: { planned: { base: 0, head: 0 }, done: { base: 0, head: 0 }, baseFromCache: false } }));
assert.match(platformRow(quiet, 'iOS'), /\| 🟩 0 changes · 6m 12s \|/);
assert.match(quiet, /\nNo screen changed on the reviewed platforms\.\n/);
assert.equal(titleOf(quiet), `### No screens changed · [Review in Explore](<${reportUrl}>)`);
assert.equal(statusOf(quiet, 'iOS'), undefined);
});
const duoTargets = [{ id: 'iphone', platform: 'ios', label: 'iPhone 17' }, { id: 'duo-closed', platform: 'ios', label: 'iPhone Duo (closed)' },
@@ -535,7 +679,7 @@ test('a config without targets writes the same records and comment as before tar
assert.deepEqual(Object.keys(readCommentRecords(after).current), ['ios', 'android']);
});
test('several targets share a comment: one row each in config order, labelled by target, keyed by id in the records and history', async () => {
test('several targets share a comment: named in config order in the subtitle, each linking its report, keyed by id in the records and history', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const [iphone, closed, open, android] = duoTargets;
// Report jobs finish in any order; the comment follows config order.
@@ -548,19 +692,19 @@ test('several targets share a comment: one row each in config order, labelled by
assert.deepEqual(Object.keys(records).sort(), ['android', 'duo-closed', 'duo-open', 'iphone']);
assert.deepEqual([records['duo-open'].platform, records['duo-open'].target, records['duo-open'].label, records['duo-open'].order], ['ios', 'duo-open', 'iPhone Duo (open)', 2]);
assert.deepEqual([records.android.platform, records.android.target, records.android.label, records.android.order], ['android', undefined, 'Pixel 7', 3]);
const lines = body.split('\n'), header = lines.indexOf('| | Device | Result | Report |');
assert.deepEqual(lines.slice(header + 2, lines.indexOf('', header)).map(line => line.split(' | ')[0]),
['| iPhone 17', '| iPhone Duo \\(closed\\)', '| iPhone Duo \\(open\\)', '| Pixel 7']);
assert.match(body, /^### Explore review · \[iPhone 17 report\]\(<[^>]+>\) · \[iPhone Duo \\\(open\\\) report\]\(<[^>]+>\) · \[Pixel 7 report\]\(<[^>]+>\)$/m);
assert.match(body, /\*\*Changes\*\* · 3 screens · a screen is listed once, with a link per device\n/);
assert.match(body, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iPhone 17\]\(<[^>]+>\) · \[iPhone Duo \\\(open\\\)\]\(<[^>]+>\) · \[Pixel 7\]\(<[^>]+>\)\n/);
assert.match(body, /\| Check \| iPhone 17 \| iPhone Duo \\\(closed\\\) \| iPhone Duo \\\(open\\\) \| Pixel 7 \|\n\|---\|---\|---\|---\|---\|/);
assert.deepEqual(summaries(body).at(-1), 'Validation · iPhone 17 🟩 6/6 captured · iPhone Duo \\(closed\\) ⏳ in progress · iPhone Duo \\(open\\) 🟩 6/6 captured · Pixel 7 🟩 6/6 captured');
// A newer run moves them all into history, still labelled and ordered by target.
assert.equal(titleOf(body), `### 3 screens changed · [Review in Explore](<${reportUrl}>)`);
assert.equal(subtitleOf(body), `<sub>[iPhone 17](<${reportUrl}>) · iPhone Duo \\(closed\\) · [iPhone Duo \\(open\\)](<${reportUrl}>) · [Pixel 7](<${reportUrl}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
assert.equal(statusOf(body, 'iPhone Duo \\(closed\\)'), `iPhone Duo \\(closed\\) · capturing head 1/3 · ${runLink}`);
assert.equal(listOf(body).length, 3);
assert.doesNotMatch(body, / only\n|not on /);
// A newer run moves them all into history, still labelled and ordered by target, and keeps their review up while it works.
const nextHead = 'd'.repeat(40);
const next = platformSectionMerge(targetState(open, { phase: 'capturing', review: undefined, evidence: undefined, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }), 'duo-open').merge(body);
assert.deepEqual(Object.keys(readCommentRecords(next).current), ['duo-open']);
assert.deepEqual(Object.keys(readCommentRecords(next).previous).sort(), ['android', 'duo-open', 'iphone'], 'the target still capturing had nothing to keep');
assert.match(visible(next).split('\n')[1], /^> \*\*New run in progress\*\* for \[dddddddd\]\(<[^>]+>\) · capturing on iPhone Duo \\\(open\\\) · \[run\]/);
assert.equal(subtitleOf(next), `<sub>[iPhone 17](<${reportUrl}>) · [iPhone Duo \\(open\\)](<${reportUrl}>) · [Pixel 7](<${reportUrl}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
const history = readCommentRecords(next).history;
assert.deepEqual(Object.keys(history[0].platforms).sort(), ['android', 'duo-closed', 'duo-open', 'iphone']);
assert.match(next, /\n- \[bbbbbbbb\]\(<[^>]+>\) · iPhone 17 🟩 3 changes \(.*?\) · iPhone Duo \\\(closed\\\) ⏳ did not finish \(.*?\) · iPhone Duo \\\(open\\\) 🟩 3 changes \(.*?\) · Pixel 7 🟩 3 changes /);
@@ -587,6 +731,8 @@ test('a comment written by a per-platform version keeps parsing, and malformed t
assert.deepEqual(parse(line('duo-open', { ...valid, order: 8 })), []);
const many = Array.from({ length: 10 }, (_, index) => line(`t${index}`, { ...valid, target: `t${index}` }));
assert.equal(parse(...many).length, 8, 'a comment holds at most one record per configurable target');
const previous = readCommentRecords([CI_COMMENT_MARKER, line('duo-open', valid), `<!-- expo-explore-previous:iphone:${encodeRecordPayload({ ...valid, target: 'iphone' })} -->`, '<!-- expo-explore-previous:iphone:AAAA -->'].join('\n')).previous;
assert.deepEqual(Object.keys(previous), ['iphone'], 'previous records parse the same way');
});
test('with report.comment.map, the map draws the added, removed and visually changed screens, the screens one step before them, and tabs as a group', async () => {
@@ -604,13 +750,13 @@ test('with report.comment.map, the map draws the added, removed and visually cha
assert.ok(!/<summary>Map/.test(renderPublicComment(state({ artifactOnly: true, review: withNavigation }))));
assert.equal(platformRecordOf(state({ review: withNavigation })).navigation, undefined);
const body = renderPublicComment(state({ artifactOnly: true, map: true, review: withNavigation }));
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (2)', 'Map (4 screens)', 'Validation · iOS 🟩 8/8 captured']);
assert.deepEqual(summaries(body), ['Map (4 screens)']);
const map = body.slice(body.indexOf('```mermaid'), body.indexOf('```\n', body.indexOf('```mermaid')) + 3);
assert.equal(map, ['```mermaid', 'flowchart LR', ' subgraph tabs["Tabs"]', ' n0["/cats"]', ' n3["/settings"]', ' end',
' n1["/cats/care-guide"]', ' n2["/cats/sweet-bee"]', ' n0 -->|push| n1', ' n0 -.->|push| n2',
' classDef added stroke:#1a7f37,stroke-width:3px', ' class n1 added', ' classDef modified stroke:#bc4c00,stroke-width:3px', ' class n3 modified',
' classDef removed stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 4', ' class n2 removed', '```'].join('\n'));
assert.ok(body.indexOf('<summary>🟧 Modified') < body.indexOf('<summary>Map') && body.indexOf('<summary>Map') < body.indexOf('<summary>Validation'));
assert.ok(body.indexOf('\n- [`/settings`]') < body.indexOf('<summary>Map'), 'the map follows the list');
assert.match(body, /<summary>Map \(4 screens\)<\/summary>\n\n```mermaid\n/, 'a blank line opens the fence inside the collapsible');
assert.deepEqual(readCommentRecords(body).current.ios.navigation, platformRecordOf(state({ map: true, review: withNavigation })).navigation, 'the map is carried in the record');
@@ -624,7 +770,7 @@ test('with report.comment.map, the map draws the added, removed and visually cha
assert.ok(!/<summary>Map/.test(renderPublicComment(state({ map: true, review: unchanged }))));
});
test('the map is dropped before the change lists shrink, and a malformed map is dropped from the record', async () => {
test('the map is dropped before the list shrinks, and a malformed map is dropped from the record', async () => {
const { encodeRecordPayload } = await import('../../dist/report/pr-comment-record.js');
const { readCommentRecords, renderCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const record = { ...platformRecordOf(state()), navigation: { nodes: [{ route: '/a', group: 'modified' }, { route: '/b' }], edges: [{ from: 1, to: 0, kinds: ['push'] }] } };
@@ -632,7 +778,7 @@ test('the map is dropped before the change lists shrink, and a malformed map is
assert.match(renderCommentRecords(records), /<summary>Map \(2 screens\)<\/summary>/);
const tight = renderCommentRecords(records, undefined, renderCommentRecords(records).length - 1);
assert.ok(!tight.includes('```mermaid'));
assert.match(tight, /<summary>🟧 Modified \(1\)<\/summary>/);
assert.equal(listOf(tight).length, 3, 'the list is intact');
const parse = navigation => readCommentRecords(`<!-- expo-explore-record:ios:${encodeRecordPayload({ ...record, navigation })} -->`).current.ios;
assert.deepEqual(parse(record.navigation).navigation, record.navigation);
for (const navigation of [{ ...record.navigation, edges: [{ from: 0, to: 2, kinds: ['push'] }] }, { ...record.navigation, edges: [{ from: 0, to: 1, kinds: ['teleport'] }] },
@@ -642,3 +788,11 @@ test('the map is dropped before the change lists shrink, and a malformed map is
assert.equal(parsed.navigation, undefined);
}
});
test('an excluded route is neither listed nor counted as an app-wide screen', () => {
const excluded = surface('channel', 'modified', { extra: { sourceScope: 'app-wide', excluded: true,
sourceChange: { ...sourceChange('Dependency update.', 'global'), files: [{ path: 'package.json', status: 'modified', relation: 'global', hunks: [], facts: [], truncated: false }] } } });
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete excluded[key];
const body = renderPublicComment(state({ review: review([...evidenceReview().surfaces, excluded]) }));
assert.doesNotMatch(body, /\/channel|App-wide source changes|not compared/);
});
+28
View File
@@ -3,6 +3,7 @@ import { chmod, mkdtemp, mkdir, rm, symlink, writeFile } from "node:fs/promises"
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { PNG as PngImage } from "pngjs";
import { assessPublicEvidence, presenceDescription, ignoreStatusBar, ignoreSystemBands, readExportedMap } from "../../dist/review/evidence-assessment.js";
import { STATUS_BAR_BAND_PERCENT } from "../../dist/shared/png-evidence.js";
@@ -419,6 +420,33 @@ test("status-bar glyph differences never count as an app change", async (t) => {
const android = ignoreSystemBands({ ...statusBarOnly, differentPixels: 140, regions: [indicator] }, { top: statusBarBandPercent("android"), bottom: homeIndicatorBandPercent("android") });
assert.deepEqual([android.ignoredTop, android.ignoredBottom, android.measurement.match], [0, 0, false]);
// A region that crosses the band's edge is clipped to its pixels below the band, read from the frames themselves:
// in a 100x874 frame the iOS band is 56 rows, so a glyph drawn over rows 50-59 keeps only its 4 rows below. The
// band still counts as ignored, so the Viewer marks the pixels left out of the comparison.
const frame = (paint) => { const png = new PngImage({ width: 100, height: 874 }); png.data.fill(255); paint?.(png); return png; };
const paintRows = (from, to) => (png) => { for (let y = from; y < to; y += 1) for (let x = 10; x < 20; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
const frames = (to) => () => ({ baseline: frame(), current: frame(paintRows(50, to)), distance: 0.1 * Math.sqrt(3 * 255 ** 2) });
const straddling = (height, pixels) => ({ index: 0, rect: { x: 10, y: 50, width: 10, height }, normalizedRect: { x: 10, y: 5.72, width: 10, height: (height / 874) * 100 }, differentPixels: pixels, shareOfDiffPercentage: 100, densityPercentage: 100, shape: "block", size: "small", location: "top-left", dominantChange: "darker" });
const whole = { ...statusBarOnly, totalPixels: 87400, differentPixels: 100, mismatchPercentage: 0.11, regions: [straddling(10, 100)] };
const clipped = ignoreSystemBands(whole, { top: statusBarBandPercent("ios"), bottom: 0 }, frames(60));
assert.deepEqual([clipped.ignoredTop, clipped.measurement.match, clipped.measurement.differentPixels, clipped.measurement.mismatchPercentage], [1, false, 40, 0.05]);
assert.deepEqual(clipped.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels, entry.shareOfDiffPercentage]), [[56, 4, 40, 100]]);
assert.equal(clipped.measurement.regions[0].normalizedRect.y, 6.41);
const glyph = ignoreSystemBands({ ...whole, differentPixels: 60, regions: [straddling(7, 60)] }, { top: statusBarBandPercent("ios"), bottom: 0 }, frames(56));
assert.deepEqual([glyph.ignoredTop, glyph.measurement.match, glyph.measurement.regions], [1, true, []]);
// agent-device's regions can overlap: a clock merged with a header line below the band has a rect that also holds the
// battery, a region of its own. The header line is still what the merged region keeps, not cancelled by the battery.
const paintRects = (...rects) => (png) => { for (const [x0, y0, w, h] of rects) for (let y = y0; y < y0 + h; y += 1) for (let x = x0; x < x0 + w; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
const overlapFrames = () => ({ baseline: frame(), current: frame(paintRects([10, 40, 10, 10], [70, 40, 20, 10], [0, 60, 100, 1])), distance: 0.1 * Math.sqrt(3 * 255 ** 2) });
const merged = { ...straddling(21, 200), rect: { x: 0, y: 40, width: 100, height: 21 }, normalizedRect: { x: 0, y: 4.58, width: 100, height: 2.4 } };
const battery = { ...straddling(10, 200), index: 1, rect: { x: 70, y: 40, width: 20, height: 10 }, normalizedRect: { x: 70, y: 4.58, width: 20, height: 1.14 } };
const overlapping = ignoreSystemBands({ ...whole, differentPixels: 400, regions: [merged, battery] }, { top: statusBarBandPercent("ios"), bottom: 0 }, overlapFrames);
assert.deepEqual([overlapping.ignoredTop, overlapping.measurement.match, overlapping.measurement.differentPixels], [2, false, 100]);
assert.deepEqual(overlapping.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels]), [[56, 5, 100]]);
const unreadable = ignoreSystemBands(whole, { top: statusBarBandPercent("ios"), bottom: 0 }, () => undefined);
assert.deepEqual([unreadable.ignoredTop, unreadable.measurement.differentPixels], [0, 100]);
assert.equal(statusBarBandPercent("android"), 7, "Android 15 status glyphs on a 720x1600 emulator reach 6.4 %");
const root = await mkdtemp(join(tmpdir(), "explore-public-evidence-")); t.after(() => rm(root, { recursive: true, force: true }));
const base = await side(root, "base", manifests.base);
const head = await side(root, "head", manifests.head);
@@ -286,3 +286,13 @@ test('allRegionsMoved is only true, and only where every published region carrie
assert.throws(() => assertPublicReview(input), /visual verdict is inconsistent/, label);
}
});
test("an excluded surface carries no capture evidence", () => {
const excluded = review();
excluded.surfaces[1].excluded = true;
assert.throws(() => assertPublicReview(excluded), /excluded surface carries capture evidence/);
for (const key of ["baseImage", "headImage", "baseOutcome", "headOutcome", "review"]) delete excluded.surfaces[1][key];
assert.doesNotThrow(() => assertPublicReview(excluded));
excluded.surfaces[1].excluded = false;
assert.throws(() => assertPublicReview(excluded), /excluded surface carries capture evidence/);
});
+60
View File
@@ -825,3 +825,63 @@ test("a target's review carries its target and the run's targets into the map; a
assert.equal(oddRun.target, undefined, "a malformed target is dropped, and the report reads as its platform's");
assert.equal(oddRun.targets, undefined);
});
test("an excluded route leaves the map with an accepted gap, like a redirect", () => {
const review = navigationReview();
const excluded = review.surfaces.find(surface => surface.id === "games-pro");
excluded.status = "modified";
excluded.excluded = true;
for (const side of ["base", "head"]) { delete excluded[`${side}Image`]; delete excluded[`${side}Outcome`]; }
const { current } = workspaceSides(publicReviewToWorkspace(review));
const graph = buildViewerGraph(current.map, indexMap(current.map));
assert.equal(graph.screens.some(screen => screen.id === "games-pro"), false, "never captured, so not a card on the map");
assert.ok(current.map.screens.some(screen => screen.id === "games-pro"), "the inventory still knows the route");
const gap = current.map.gaps.find(gap => gap.screenId === "games-pro");
assert.equal(gap.status, "accepted");
assert.equal(gap.message, "Excluded by exploration.exclude; never captured");
assert.equal(
indexMap(current.map).screenNotes.get("games-pro"),
"Excluded by exploration.exclude; never captured",
"the inspector's placeholder says why there is no screenshot",
);
const projection = publicReviewProjection(review);
assert.equal(projection.runtimeEvidence["public:games-pro"].current.groups.capture.find((row) => row.label === "Capture").value,
"Excluded by exploration.exclude; never captured");
});
test("an unchanged excluded route outside the capture context still says it was excluded", () => {
const review = navigationReview();
const excluded = review.surfaces.find(surface => surface.id === "games-pro");
excluded.excluded = true;
for (const side of ["base", "head"]) { delete excluded[`${side}Image`]; delete excluded[`${side}Outcome`]; }
const { current } = workspaceSides(publicReviewToWorkspace(review));
const gap = current.map.gaps.find(gap => gap.screenId === "games-pro");
assert.equal(gap.status, "accepted");
assert.equal(gap.message, "Excluded by exploration.exclude; never captured");
assert.equal(diffFor(review).index.screenNotes.get("games-pro"), "Excluded by exploration.exclude; never captured");
});
test("a screen's note is its first open gap of any kind, and an accepted gap only when nothing is open", () => {
// A redirect on base that became a screen whose head capture failed: the comparison carries both sides' gaps.
const review = verifyImages(fixture());
const home = review.surfaces.find(surface => surface.id === "home");
home.status = "modified";
home.head = entry("home", "/", "fresh");
home.headOutcome = { status: "failed", attempts: 1, landing: "unverified", reason: "Configured UI prerequisites did not complete." };
const diff = diffFor(review);
const messages = diff.map.gaps.filter(gap => gap.screenId === "home").map(gap => [gap.status, gap.message]);
assert.deepEqual(messages.map(([status]) => status), ["open", "accepted"]);
assert.equal(indexMap(diff.map).screenNotes.get("home"), messages[0][1], "the head's failure, not the baseline's redirect");
assert.equal(presentScreensByPath(diff.map).index.screenNotes.get("home"), messages[0][1]);
const { current } = workspaceSides(publicReviewToWorkspace(verifyImages(fixture())));
const gap = (id, kind, status, message) => ({ id, kind, status, message, screenId: "games-free", createdAt: review.createdAt });
const open = [gap("parse-1", "controller-parse", "open", "Unreadable element tree"), gap("parse-2", "controller-parse", "open", "Second warning")];
const accepted = gap("accepted", "coverage", "accepted", "Not compared; no capture was recorded");
const resolved = gap("resolved", "coverage", "resolved", "Captured on retry");
for (const gaps of [[...open, accepted, resolved], [resolved, accepted, ...open]]) {
assert.equal(indexMap({ ...current.map, gaps }).screenNotes.get("games-free"), "Unreadable element tree");
}
assert.equal(indexMap({ ...current.map, gaps: [resolved, accepted] }).screenNotes.get("games-free"), accepted.message);
assert.equal(indexMap({ ...current.map, gaps: [resolved] }).screenNotes.has("games-free"), false);
});
+10 -5
View File
@@ -16,7 +16,8 @@ test('round trip: light + dark on both sides with a fully reused baseline', asyn
const inconclusiveDark = report.review.surfaces.filter(surface => surface.id.endsWith('@dark') && surface.review?.status === 'needs-review');
assert.deepEqual(inconclusiveDark.map(surface => `${surface.id}: ${surface.review.description}`), [], 'an unchanged dark pair compares conclusively');
assert.ok(!progress.some(line => line.startsWith('::warning')), progress.filter(line => line.startsWith('::warning')).join('\n'));
assert.match(comment, /\| iOS \| [^|]*light \+ dark[^|]*\| 🟩 /);
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
assert.doesNotMatch(comment, /^iOS · /m, 'nothing is missing on iOS');
assert.equal(records.current.ios?.phase, 'ready');
assert.ok(records.current.ios?.capture, 'the final record keeps the capture counts');
assert.deepEqual(records.current.ios.capture.done, records.current.ios.capture.planned, 'progress counts surfaces (routes), not light + dark images');
@@ -33,7 +34,8 @@ test('round trip: a dark-only base against a light + dark head (the first PR tha
const lightOnly = report.review.surfaces.filter(surface => surface.head && !surface.base && !surface.id.endsWith('@dark') && surface.head.route !== '/added');
assert.ok(lightOnly.length > 0, 'the light appearance is an added surface, not a modified one');
assert.ok(!progress.some(line => line.startsWith('::warning')), progress.filter(line => line.startsWith('::warning')).join('\n'));
assert.match(comment, /\| iOS \| [^|]*light \+ dark[^|]*\| 🟩 /);
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
assert.doesNotMatch(comment, /^iOS · /m, 'nothing is missing on iOS');
assert.equal(records.current.ios?.phase, 'ready');
});
@@ -41,14 +43,16 @@ test('round trip: light + dark with a freshly captured base', async t => {
const { result, bundles, comment } = await roundTrip(t, { userInterfaceStyle: 'automatic' }, { cachedBase: false });
assert.deepEqual(schemesOf(bundles.base), ['light', 'dark']);
assert.equal(result.evidence.summary.visual.failed, 0);
assert.match(comment, /\| iOS \| [^|]*light \+ dark[^|]*\| 🟩 /);
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
assert.doesNotMatch(comment, /^iOS · /m, 'nothing is missing on iOS');
});
test('round trip: Android light + dark', async t => {
const { result, bundles, comment, records } = await roundTrip(t, { userInterfaceStyle: 'automatic', platform: 'android' });
assert.deepEqual(schemesOf(bundles.head), ['light', 'dark']);
assert.equal(result.evidence.summary.visual.failed, 0);
assert.match(comment, /\| Android \| [^|]*light \+ dark[^|]*\| 🟩 /);
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
assert.doesNotMatch(comment, /^Android · /m, 'nothing is missing on Android');
assert.equal(records.current.android?.phase, 'ready');
});
@@ -57,7 +61,8 @@ test('round trip: a single-scheme app (no userInterfaceStyle) captures light onl
assert.deepEqual(bundleColorSchemes(bundles.head), ['light']);
assert.ok(!report.review.surfaces.some(surface => /@(light|dark)$/.test(surface.id)), 'no secondary appearance surfaces');
assert.equal(report.review.runtime.colorSchemes, undefined);
assert.match(comment, /\| iOS \| [^|]*\| 🟩 /);
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
assert.doesNotMatch(comment, /^iOS · /m);
assert.doesNotMatch(comment, /light \+ dark/);
assert.equal(records.current.ios.phase, 'ready');
});
+3 -3
View File
@@ -11,7 +11,7 @@ test('round trip: light + dark with an unavailable screen publishes an incomplet
assert.ok(unattributed.length >= 1);
assert.ok(unattributed.every(surface => surface.headImage && surface.headOutcome.observed?.reason === 'observer-not-ready'));
assert.ok(progress.some(line => line.startsWith('::warning title=Explore head capture unavailable')), progress.filter(line => line.startsWith('::warning')).join('\n'));
assert.match(comment, /\| iOS \| [^|]*\| 🟨 [^|]*unattributed/);
assert.match(comment, /^iOS · [^\n]*unattributed · \[run\]/m);
assert.doesNotMatch(comment, /🟥 failed/);
assert.equal(records.current.ios?.phase, 'ready');
});
@@ -33,7 +33,7 @@ test('round trip: a failed screenshot comparison is a named gap, not a failed ru
assert.ok(surface, `${id} stays in the report`);
assert.notEqual(surface.review?.status, 'modified', 'a failed comparison is not reported as a change');
}
assert.match(comment, /\| iOS \| [^|]*\| 🟨 [^|]*2 comparisons failed/);
assert.match(comment, /^iOS · [^\n]*2 comparisons failed · \[run\]/m);
assert.doesNotMatch(comment, /🟥 failed/);
assert.equal(records.current.ios?.phase, 'ready');
});
@@ -44,7 +44,7 @@ test('round trip: a baseline with an unavailable screen is still cached, and the
assert.ok(progress.some(line => line.startsWith('baseline: ::warning title=Explore head capture unavailable')));
assert.ok(progress.some(line => !line.startsWith('baseline:') && /reused from the baseline, \d+ to capture/.test(line)), progress.filter(line => line.includes('capture')).join('\n'));
assert.ok(result.evidence.summary.visual.compared > 0);
assert.match(comment, /\| iOS \| [^|]*\| 🟨 /);
assert.match(comment, /^iOS · [^\n]*· \[run\]/m, 'the gap is named on the iOS line');
assert.equal(records.current.ios?.phase, 'ready');
});
+6 -7
View File
@@ -28,7 +28,7 @@ test('round trip: a push mid-review publishes the finished run under previous ru
assert.equal(records.current.ios.headSha, newHead);
assert.equal(records.history.length, 1);
assert.equal(records.history[0].headSha, f.headSha);
assert.match(comment, new RegExp(`base \\[${f.baseSha.slice(0, 8)}\\][^\\n]*\\[${newHead.slice(0, 8)}\\]`));
assert.match(comment, new RegExp(`^<sub>\\[iOS\\]\\(<[^>]+>\\) · \\[${newHead.slice(0, 8)}\\]\\(<[^>]+>\\) vs \\[${f.baseSha.slice(0, 8)}\\]`, 'm'));
assert.match(comment, /Previous runs \(1\)/);
assert.ok(comment.includes(f.headSha.slice(0, 8)), 'the previous head is named');
assert.ok(comment.includes('/actions/runs/1234/'), 'the previous run stays linked');
@@ -46,13 +46,12 @@ test('round trip: iOS and Android jobs of one run share a single comment: one ro
assert.equal(records.current.ios.phase, 'ready');
assert.equal(records.current.android.phase, 'ready');
assert.equal(records.current.ios.runId, records.current.android.runId);
assert.equal((comment.match(/^\| iOS \|/gm) ?? []).length, 1);
assert.equal((comment.match(/^\| Android \|/gm) ?? []).length, 1);
assert.equal(comment.match(/^### Explore review/gm).length, 1, 'one header');
const routeLines = comment.split('\n').filter(line => /^- `\/(added|removed|home)`/.test(line));
assert.equal(comment.match(/^### /gm).length, 1, 'one header');
assert.match(comment, /^<sub>\[iOS\]\(<[^>]+>\) · \[Android\]\(<[^>]+>\) · /m, 'the subtitle links each platform\'s report');
const routeLines = comment.split('\n').filter(line => /^- (Added |Removed )?\[`\/(added|removed|home)`\]\(</.test(line));
assert.ok(routeLines.length >= 1, `the comment lists changed routes once:\n${comment}`);
assert.equal(routeLines.length, 6, `each changed screen is listed once:\n${comment}`);
for (const line of routeLines) assert.ok(/\[iOS\]\(/.test(line) && /\[Android\]\(/.test(line), `each changed route carries both platforms once: ${line}`);
for (const line of routeLines) assert.doesNotMatch(line, / only$|not on /, `a screen changed on both platforms names neither: ${line}`);
const projection = publicReviewProjection(android.report.review);
for (const surface of android.report.review.surfaces) assert.ok(projection.surfaces[surface.id], `the Viewer projects the Android surface ${surface.id}`);
assert.ok(ios.projection.surfaces[ios.report.review.surfaces[0].id], 'the iOS report still opens');
@@ -82,5 +81,5 @@ test('round trip: a run on an old head that finishes after the new head\'s run f
assert.ok(late.records.history.some(entry => entry.headSha === f.headSha && entry.platforms?.ios?.superseded === true || entry.superseded === true), JSON.stringify(late.records.history));
assert.match(late.comment, /Previous runs \(2\)/);
assert.ok(late.comment.includes('/actions/runs/1236/'), 'the late report stays reachable');
assert.match(late.comment, new RegExp(`base \\[${f.baseSha.slice(0, 8)}\\][^\\n]*\\[${newHead.slice(0, 8)}\\]`));
assert.match(late.comment, new RegExp(`^<sub>\\[iOS\\]\\(<[^>]+>\\) · \\[${newHead.slice(0, 8)}\\]\\(<[^>]+>\\) vs \\[${f.baseSha.slice(0, 8)}\\]`, 'm'));
});
+75
View File
@@ -65,3 +65,78 @@ test("empty queries and non-positive limits do not return an unbounded inventory
assert.deepEqual(search.searchItems(items, "money", 0), []);
assert.deepEqual(search.suggestedSearchItems(items, {}, 0), []);
});
test("the palette ranks commands first for a word and screens first for a route, matching command keywords", () => {
const items = [
{ id: "screen:a", kind: "screen", title: "/settings/dark-mode", keywords: ["/settings/dark-mode"], context: "", order: 0, screenId: "a" },
{ id: "command:theme", kind: "command", title: "Theme: Dark", keywords: ["theme", "appearance"], context: "View", order: 1, run() {} },
{ id: "command:fit", kind: "command", title: "Fit the canvas", keywords: ["zoom"], context: "Canvas", order: 2, run() {} },
];
assert.deepEqual(search.searchItems(items, "dark").map((item) => item.id), ["command:theme", "screen:a"]);
assert.deepEqual(search.searchItems(items, "/settings").map((item) => item.id), ["screen:a"]);
const open = { id: "command:open", kind: "command", title: "Open /settings/dark-mode in Compare", keywords: [], context: "Changes", order: 3, run() {} };
assert.deepEqual(search.searchItems([...items, open], "settings/dark").map((item) => item.id), ["screen:a", "command:open"]);
assert.deepEqual(search.searchItems(items, "appearance").map((item) => item.id), ["command:theme"]);
assert.deepEqual(search.searchItems(items, "zoom").map((item) => item.id), ["command:fit"]);
// A word that is a screen's last segment opens that screen; part of one still leads with the command.
const theme = { id: "screen:theme", kind: "screen", title: "/settings/theme", keywords: ["/settings/theme"], context: "", order: 3, screenId: "theme" };
assert.deepEqual(search.searchItems([...items, theme], "theme").map((item) => item.id), ["screen:theme", "command:theme"]);
assert.deepEqual(search.searchItems([...items, theme], "Theme ").map((item) => item.id), ["screen:theme", "command:theme"]);
assert.deepEqual(search.searchItems([...items, theme], "them").map((item) => item.id), ["command:theme", "screen:theme"]);
});
test("the palette's commands follow the canvas: Compare steps changes with the arrows, the Map fits its camera, and suggestions lead with the next change", async () => {
const { commandItems, suggestedCommands } = await tsImport("../../viewer/src/utils/commands.ts", import.meta.url);
const calls = [];
const actions = Object.fromEntries(["selectCanvas", "openFind", "openHandoff", "openShortcuts", "toggleChanges", "openChangedScreen", "setTheme", "chooseAppearance", "toggleInspector", "toggleFullscreen", "switchTarget", "zoom"]
.map((name) => [name, (...args) => calls.push([name, ...args])]));
const base = {
phone: false, changed: [{ id: "a", route: "/a" }, { id: "b", route: "/b" }], selectedScreenId: "a", find: true, handoff: true,
pullRequest: { number: 7, url: "https://github.com/expo/explore/pull/7" }, theme: "system", appearances: [], targets: [{ id: "android", label: "Pixel 8", platform: "android", place: 1, noun: "device" }], camera: true,
};
const map = commandItems({ ...base, canvas: "map", inspector: { open: false } }, actions);
const ids = (items) => items.map((item) => item.id.replace(/^command:/, ""));
assert.ok(ids(map).includes("camera:fit"));
assert.ok(ids(map).includes("changes:open-selected"));
assert.ok(ids(map).includes("link:repository"));
assert.equal(map.find((item) => item.id === "command:changes:next").shortcut, undefined);
assert.deepEqual(ids(suggestedCommands(map, "map")).slice(0, 3), ["changes:next", "changes:open-selected", "go:compare"]);
map.find((item) => item.id === "command:changes:next").run();
map.find((item) => item.id === "command:target:android").run();
assert.deepEqual(calls, [["openChangedScreen", "b"], ["switchTarget", "android"]]);
const compare = commandItems({ ...base, canvas: "compare", camera: false }, actions);
assert.ok(!ids(compare).includes("camera:fit"));
assert.ok(!ids(compare).includes("changes:open-selected"));
assert.ok(compare.find((item) => item.id === "command:changes:next").shortcut);
assert.ok(!ids(compare).includes("go:compare"));
assert.ok(ids(compare).includes("go:map"));
// A phone has no keyboard shortcuts to list.
assert.ok(ids(map).includes("go:shortcuts"));
assert.ok(!ids(commandItems({ ...base, canvas: "map", phone: true }, actions)).includes("go:shortcuts"));
// Next and Previous stop at the ends of the review, as Compare's arrows do.
const last = commandItems({ ...base, canvas: "compare", camera: false, selectedScreenId: "b" }, actions);
assert.ok(!ids(last).includes("changes:next"));
assert.ok(ids(last).includes("changes:previous"));
assert.ok(!ids(compare).includes("changes:previous"));
const none = commandItems({ ...base, canvas: "map", selectedScreenId: undefined }, actions);
assert.ok(ids(none).includes("changes:next") && ids(none).includes("changes:previous"));
// An app appearance is found by its own scheme, not the other one.
const schemes = commandItems({ ...base, canvas: "map", appearances: [{ id: "light", label: "Light", current: true }, { id: "dark", label: "Dark", current: false }] }, actions);
assert.deepEqual(search.searchItems(schemes, "dark").filter((item) => item.id.includes("appearance")).map((item) => item.id), ["command:view:appearance:dark"]);
});
test("the palette finds a device by its own platform only", async () => {
const { commandItems } = await tsImport("../../viewer/src/utils/commands.ts", import.meta.url);
const actions = new Proxy({}, { get: () => () => {} });
const items = commandItems({
canvas: "map", phone: false, changed: [], find: true, handoff: false, theme: "system", appearances: [], camera: false,
targets: [{ id: "duo-open", label: "iPhone Duo open", platform: "ios", place: 1, noun: "device" }, { id: "pixel", label: "Pixel 8", platform: "android", place: 2, noun: "device" }],
}, actions);
assert.deepEqual(search.searchItems(items, "android").map((item) => item.id), ["command:target:pixel"]);
assert.deepEqual(search.searchItems(items, "ios").map((item) => item.id), ["command:target:duo-open"]);
});
+50 -1
View File
@@ -36,6 +36,55 @@ test("changed routes include ancestors and descendants without ancestor sibling
assert.equal(result.surfaces.find(row=>row.headSurface.route==="/end").status,"unchanged");
});
test("a comment or whitespace-only edit to an imported file changes no surface; an edit to its tokens does", () => {
const theme = "export const theme = { tint: 'blue' };\n";
const files = [["app/one.tsx", 'import { theme } from "../src/theme"; export default () => theme;'], ["app/two.tsx", page], ["src/theme.ts", theme]];
const head = (text) => [files[0], files[1], ["src/theme.ts", text]];
const change = [{ status: "modified", path: "src/theme.ts" }];
for (const text of ["// Palette.\nexport const theme = { tint: 'blue' };\n", "/** The palette, attached to the declaration as JSDoc. */\nexport const theme = { tint: 'blue' };\n", "export const theme = {\n tint: 'blue' /* default */\n};\r\n", theme + "\n\n"]) {
const result = plan({ base: files, head: head(text), changes: change });
assert.deepEqual(result.surfaces.map((row) => [row.status, row.reasons]), [["unchanged", []], ["unchanged", []]], text);
assert.deepEqual(selectedPaths(result), []);
}
for (const text of ["export const theme = { tint: 'red' };\n", "export const theme = { tint: 'blue' }\n", "export const theme = { tint: 'blue' };; \n", "export const theme = { tint: 'blue' ;\n"]) {
assert.equal(plan({ base: files, head: head(text), changes: change }).surfaces[0].status, "modified", text);
}
// JSX text keeps its whitespace: a space inside a Text is rendered.
const jsx = (text) => [["app/one.tsx", `import {Text} from "react-native"; export default () => <Text>${text}</Text>;`]];
assert.equal(plan({ base: jsx("a"), head: jsx(" a "), changes: [{ status: "modified", path: "app/one.tsx" }] }).surfaces[0].status, "modified");
assert.equal(plan({ base: jsx("a"), head: jsx("{/* note */}a"), changes: [{ status: "modified", path: "app/one.tsx" }] }).surfaces[0].status, "unchanged");
});
test("a line break, JSX space or compiler comment that changes the program is a change; re-wrapping is not", () => {
const status = (path, before, after) => plan({ base: [[path, before]], head: [[path, after]], changes: [{ status: "modified", path }] }).surfaces[0].status;
const screen = (body) => `import {Text, View} from "react-native"; export default function Screen({ n, a, b }) { ${body} }`;
// Automatic semicolon insertion: the same tokens, a different program.
for (const [before, after] of [
['return "hello";', 'return\n"hello";'],
['return /* x */ "hello";', 'return /*\n*/ "hello";'],
["return (\n<View/>);", "return\n(<View/>);"],
["a\n++b; return null;", "a++\nb; return null;"],
]) assert.equal(status("app/one.tsx", screen(before), screen(after)), "modified", after);
// The JSX transform keeps space within a line, and trims it only where a line breaks.
for (const [before, after] of [["<Text>a</Text>", "<Text> a</Text>"], ["<Text>{n} items</Text>", "<Text>{n}items</Text>"], ["<Text>{a} {b}</Text>", "<Text>{a} {b}</Text>"]]) {
assert.equal(status("app/one.tsx", screen(`return ${before};`), screen(`return ${after};`)), "modified", after);
}
for (const [before, after] of [
["return (<View><Text>hello world</Text></View>);", "return (\n <View>\n <Text>\n hello\n world\n </Text>\n </View>\n);"],
["return f(a, b);", "return f(\n a,\n b\n);"],
]) assert.equal(status("app/one.tsx", screen(before), screen(after)), "unchanged", after);
// A comment a compiler or bundler reads is not trivia.
for (const [before, after] of [
["/** @jsxImportSource react */\n", "/** @jsxImportSource other */\n"],
["/** @jsx h */\n", "/** @jsx g */\n"],
["", "// @flow\n"],
]) assert.equal(status("app/one.jsx", `${before}export default () => <a/>;`, `${after}export default () => <a/>;`), "modified", after);
assert.equal(status("app/one.tsx", screen("return f();"), screen("return /*#__PURE__*/ f();")), "modified");
assert.equal(status("app/one.tsx", screen("return <Text>a</Text>;"), screen("return <Text>{/* @jsx h */}a</Text>;")), "modified");
// An ordinary JSDoc tag is still a comment.
assert.equal(status("app/one.tsx", `/** @param n a count */\n${screen("return null;")}`, `/**\n * @param n the count\n * @returns nothing\n */\n${screen("return null;")}`), "unchanged");
});
test("source snapshots detect modifications even when a caller omits a diff entry", () => {
const result=plan({base:[["app/one.tsx",page]],head:[["app/one.tsx",page.replace("null","<View/>")]]});
assert.equal(result.surfaces[0].status,"modified");
@@ -136,7 +185,7 @@ test("package.json changes are app-wide unless they only touch scripts that inst
test("app-wide inputs that no route imports mark every surface modified", () => {
const files = [["app/one.tsx", page], ["app/two.tsx", page], ["package.json", JSON.stringify({ main: "index.js" })], ["index.js", "import 'expo-router/entry';"]];
for (const path of ["eas.json", ".env", ".env.production", "tailwind.config.js", "postcss.config.cjs", "index.js"]) {
const head = files.some(([name]) => name === path) ? files.map(([name, text]) => [name, name === path ? `${text}\n` : text]) : [...files, [path, "{}"]];
const head = files.some(([name]) => name === path) ? files.map(([name, text]) => [name, name === path ? `${text};` : text]) : [...files, [path, "{}"]];
assert.deepEqual(selectedPaths(plan({ base: files, head, changes: [{ status: files.some(([name]) => name === path) ? "modified" : "added", path }] })), ["/one", "/two"], path);
}
assert.deepEqual(selectedPaths(plan({ base: files, head: [...files, ["docs/eas.json", "{}"]], changes: [{ status: "added", path: "docs/eas.json" }] })), []);
+23
View File
@@ -228,6 +228,29 @@ test("summary bounds retain blob identities and explicitly mark omitted source e
assert.ok(Object.values(results).every((result) => result.summary.length <= SOURCE_CHANGE_SUMMARY_LIMITS.summaryCharacters));
});
test("a comment-only edit to an imported file leaves no source evidence and no imported impact", (t) => {
const repo = repository(t,
{ "src/theme.ts": "export const tint = 'blue';\n", "src/label.ts": "export const label = 'Before';\n" },
{ "src/theme.ts": "// Palette.\nexport const tint = 'blue';\n", "src/label.ts": "export const label = 'After';\n" });
const entry = surface("home", "src/home.tsx", ["src/theme.ts", "src/label.ts"]);
const result = summarize(repo, plan(repo, [tracked(entry, ["src/label.ts"])])).home;
assert.equal(result.impact, "dependency");
assert.deepEqual(result.files.map((file) => file.path), ["src/label.ts"]);
assert.equal(result.truncated, false);
});
test("comment-only files do not take the file slots of a real change", (t) => {
const comments = Array.from({ length: SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface }, (_, index) => `src/a${index}.ts`);
const repo = repository(t,
{ ...Object.fromEntries(comments.map((path) => [path, "export const value = 1;\n"])), "src/z-theme.ts": "export const tint = 'blue';\n" },
{ ...Object.fromEntries(comments.map((path) => [path, "// Note.\nexport const value = 1;\n"])), "src/z-theme.ts": "export const tint = 'red';\n" });
const entry = surface("home", "src/home.tsx", [...comments, "src/z-theme.ts"]);
const result = summarize(repo, plan(repo, [tracked(entry, ["src/z-theme.ts"])])).home;
assert.equal(result.impact, "dependency");
assert.deepEqual(result.files.map((file) => file.path), ["src/z-theme.ts"]);
assert.equal(result.truncated, false);
});
test("unrelated surfaces remain unchanged and exact SHA validation rejects an ungrounded comparison", (t) => {
const repo = repository(t, { "README.md": "Before\n" }, { "README.md": "After\n" });
const entry = surface("unrelated", "src/unrelated.tsx");
+8 -8
View File
@@ -155,14 +155,14 @@ test("only a live uploaded final artifact becomes Ready with a central Viewer de
const posted = calls.find(call => call.options.method === "POST");
assert.ok(posted);
const body = JSON.parse(posted.options.body).body;
assert.match(body, /\| iOS \| [^|]*\| 🟩 /);
assert.match(body, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]\(<https:\/\/explore-preview/m);
const viewer = new URL(result.artifactUrl);
assert.equal(viewer.origin, "https://explore-preview.expo.app");
assert.equal(viewer.pathname, "/");
assert.deepEqual(Object.fromEntries(viewer.searchParams), { repo: pr.repository, run: "10", attempt: "1", artifact: "20" });
assert.ok(body.includes(result.artifactUrl));
assert.match(body, new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<${result.artifactUrl.replace(/[.?+*]/g, "\\$&")}>\\) \\|$`, "m"), "the Report cell is the report link alone");
assert.match(body, new RegExp(`· Workflow \\[run\\]\\(<https://github\\.com/expo/explore-playground/actions/runs/10/attempts/1>\\) · \\[zip\\]\\(<${artifactUrl.replace(/[.?+*]/g, "\\$&")}>\\)$`, "m"), "the run and zip links sit in the footer");
assert.match(body, new RegExp(`^### (\\d+ screens?|No screens) changed · \\[Review in Explore\\]\\(<${result.artifactUrl.replace(/[.?+*]/g, "\\$&")}>\\)$`, "m"), "the report link is the heading");
assert.match(body, /^<sub>\[Workflow run\]\(<https:\/\/github\.com\/expo\/explore-playground\/actions\/runs\/10\/attempts\/1>\) · \[Config\]\(<[^>]+>\)<\/sub>$/m, "the run sits in the footer");
assert.doesNotMatch(body, /embedded\.expo-explore\.invalid|<img|convex/);
assert.ok(calls.some(call => call.url.pathname.endsWith("/actions/runs/10/attempts/1")));
});
@@ -172,10 +172,10 @@ test("an uploaded diagnostic artifact with unverified landings remains Incomplet
const { transport, calls } = transportFixture();
await publishCiReportComment({ inputPath, artifactUrl, environment, transport });
const body = JSON.parse(calls.find(call => call.options.method === "POST").options.body).body;
assert.match(body, /\| iOS \| [^|]+\| 🟨 [^|]*2 unattributed/);
assert.match(body, /\| Route verification \| 🟨 0\/2 verified · 2 unattributed \|/);
assert.match(body, /\*\*iOS\*\* · base 0\/1 verified · 1 unattributed · head 0\/1 verified · 1 unattributed/);
assert.doesNotMatch(body, /\| iOS \| [^|]+\| 🟩|⏳|Needs review/);
assert.match(body, /^iOS · 2 unattributed · \[run\]/m);
assert.match(body, /<summary>Capture issues \(2\)<\/summary>/);
assert.match(body, /\n- Base · [^\n]+ · CAPTURE\\_LANDING\\_UNVERIFIED/);
assert.doesNotMatch(body, /⏳|capturing|Needs review/);
});
test("report publication separates credential, permission, rate limit, and service failures", async t => {
@@ -209,7 +209,7 @@ test("stale PRs, expired artifacts, foreign artifacts, and replayed attempts can
await publishCiReportComment({ inputPath, artifactUrl, environment, transport: moved.transport });
const movedBody = JSON.parse(moved.calls.find(call => call.options.method === "POST").options.body).body;
assert.match(movedBody, /Previous runs \(1\)/, "a PR that moved on still gets its report, under previous runs");
assert.doesNotMatch(movedBody, /^<sub>base \[/m);
assert.match(movedBody, /^### Explore review$/m, "nothing is presented as the current review");
for (const configuration of [{ expired: true }, { artifactName: "explore-capture-evidence-1" },
{ artifactRun: 11 }, { attempt: 2 }]) {
const { transport, calls } = transportFixture(configuration);
+9 -10
View File
@@ -175,7 +175,7 @@ test("failure comments use actionable capture diagnostics and update only the bo
assert.equal(writes.length, 1);
assert.equal(writes[0].action, "update");
assert.equal(writes[0].comment_id, 3);
assert.match(writes[0].body, /\| iOS \| [^|]*\| 🟥 failed · capture\\-head \|/);
assert.match(writes[0].body, /^\*\*iOS failed\*\* · capture\\-head · /m);
assert.match(writes[0].body, /APP\\_INPUT\\_MISSING/);
assert.match(writes[0].body, /Required app input is missing/);
assert.match(writes[0].body, /Next action\\: Set APP\\_REVIEW\\_PASSWORD/);
@@ -232,7 +232,7 @@ test("closed, draft, and forked PRs receive no failure comment; a PR that moved
const [write] = Object.assign([], await reportFailure(t, { capture: sampleDiagnostic(), pr: moved }));
assert.match(write.body, /<summary>Previous runs \(1\)<\/summary>/);
assert.match(write.body, /bbbbbbbb.*iOS 🟥 failed · capture\\-head/);
assert.doesNotMatch(write.body, /^<sub>base \[/m);
assert.match(write.body, /^### Explore review$/m);
const invalid = await reportFailure(t, { capture: sampleDiagnostic(), head: "not-a-sha" });
assert.deepEqual([...invalid], []);
});
@@ -249,14 +249,14 @@ test("a failed platform joins the other platform's row in a multi-platform comme
const comments = [{ id: 7, user: { login: "github-actions[bot]" }, body: existing }];
const [write] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "android", comments });
assert.equal(write.comment_id, 7);
assert.match(write.body, /\| iOS \| [^|]*\| ⏳ capturing head 1\/2 \|/);
assert.match(write.body, /\| Android \| [^|]*\| 🟥 failed · capture\\-head \|/);
assert.match(write.body, /^iOS · capturing head 1\/2 · \[run\]/m);
assert.match(write.body, /^\*\*Android failed\*\* · capture\\-head · /m);
assert.match(write.body, /APP\\_INPUT\\_MISSING/);
assert.equal(write.body.split("<!-- expo-explore-ci -->").length, 2);
// A comment without records (a legacy layout) is replaced by the failure alone.
const [whole] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "android", comments: [{ id: 8, user: { login: "github-actions[bot]" }, body: "<!-- expo-explore-ci -->\nPrevious run" }] });
assert.match(whole.body, /^<!-- expo-explore-ci -->\n<!-- expo-explore-record:android:/);
assert.doesNotMatch(whole.body, /\| iOS \|/);
assert.doesNotMatch(whole.body, /iOS/);
});
test("a failed target is named by its artifact and keeps the label and config order its capture record posted", async t => {
@@ -276,14 +276,13 @@ test("a failed target is named by its artifact and keeps the label and config or
const [write] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "duo-open", comments: [{ id: 7, user: { login: "github-actions[bot]" }, body: existing }] });
assert.equal(write.comment_id, 7);
assert.match(write.body, /^<!-- expo-explore-record:duo-open:/m);
const lines = write.body.split("\n"), header = lines.indexOf("| | Device | Result | Report |");
const rows = lines.slice(header + 2, lines.indexOf("", header));
assert.deepEqual(rows.map(line => line.split(" | ")[0].slice(2)), ["iPhone 17", "iPhone Duo \\(open\\)", "Pixel 7"], "config order, each target's own label");
assert.match(write.body, /\| iPhone Duo \\\(open\\\) \| [^|]*\| 🟥 failed · capture\\-head \|/);
const subtitle = write.body.split("\n").find(line => line.startsWith("<sub>"));
assert.deepEqual([...subtitle.matchAll(/(?:^<sub>|· )\[?(iPhone 17|iPhone Duo \\\(open\\\)|Pixel 7)/g)].map(match => match[1]), ["iPhone 17", "iPhone Duo \\(open\\)", "Pixel 7"], "config order, each target's own label");
assert.match(write.body, /^\*\*iPhone Duo \\\(open\\\) failed\*\* · capture\\-head · /m);
// A target the comment has not seen yet is labelled by its id.
const [fresh] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "duo-closed" });
assert.match(fresh.body, /^<!-- expo-explore-record:duo-closed:/m);
assert.match(fresh.body, /\| duo\\-closed \| [^|]*\| 🟥 failed/);
assert.match(fresh.body, /^\*\*duo\\-closed failed\*\* · /m);
// Artifact directories: any valid id, never a reserved or malformed one.
const root = await mkdtemp(join(tmpdir(), "explore-failure-targets-"));
t.after(() => rm(root, { recursive: true, force: true }));
+117 -42
View File
@@ -1,5 +1,5 @@
import { appearanceLabel, appearanceOptions, appearanceScope, filterComparisonAppearance, filterMapAppearance, filterReviewAppearance, rememberAppearance, rememberedAppearance, type Appearance } from "./utils/appearance";
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
import { memo, useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
import { createPortal, flushSync } from "react-dom";
import { AlertCircle, RefreshCw } from "lucide-react";
import { Toaster } from "sonner";
@@ -11,12 +11,15 @@ import { CanvasVisibleFrameProvider } from "./components/canvas/visible-frame-pr
import { AppLoading } from "./components/shared/app-loading";
import { ReportLoadingShell } from "./components/shared/report-loading-shell";
import { screenLabel } from "./utils/screen-path";
import { AppPill, PLATFORM_NAMES, targetSwitch } from "./components/panels/app-pill";
import { AppPill, PLATFORM_NAMES, runTargets, siblingReportUrl, targetSwitch } from "./components/panels/app-pill";
import { useFullscreen } from "./components/panels/shell-actions";
import { getCanvasZoomState, runCanvasZoomCommand } from "./utils/canvas-zoom";
import { commandItems, suggestedCommands } from "./utils/commands";
import { changedScreens, focusCounts as countFocusStatuses, isCapturedChange, type ChangedScreen } from "./utils/changed-screens";
import { MapView } from "./components/views/semantic-map";
import { RightPanel } from "./components/panels/right";
import { SearchCommand } from "./components/search-command";
import { ScreensView } from "./components/views/screens";
import { FIND_KEY, ScreensView } from "./components/views/screens";
import { publicReviewProjection, publicReviewToWorkspace } from "./public/public-workspace";
import type { PublicReview } from "../../src/contracts/capture";
import {
@@ -287,11 +290,12 @@ export function App() {
{...(droppable ? { onOpenFile: openFile } : {})}
{...(droppable && source.status === "failed" ? { onRetry: retry } : {})} />;
}
// A hosted preview switches targets in place; the new report gets a fresh Viewer.
return <ViewerApp key={source.reportKey} />;
// A hosted preview switches targets in place; the running Viewer swaps in the new report.
return <ViewerApp reportKey={source.reportKey} />;
}
function ViewerApp() {
// The report source changes on every chunk while another target downloads; the Viewer re-renders only for a new report.
const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number }) {
const [payload, setPayload] = useState<ViewerPayload>();
const [workspace, setWorkspace] = useState<ViewerWorkspace>();
const [loadedPublicReview, setLoadedPublicReview] = useState<PublicReview>();
@@ -322,7 +326,11 @@ function ViewerApp() {
const focusSeq = useRef(0);
const landed = useRef(false);
const [searchOpen, setSearchOpen] = useState(false);
/** `/` on another canvas: Screens opens with its find field focused; each press is a new request. */
const [findRequest, setFindRequest] = useState<number>();
const clearFindRequest = useCallback(() => setFindRequest(undefined), []);
const [shortcutsOpen, setShortcutsOpen] = useState(false);
const [fullscreen, toggleFullscreen] = useFullscreen();
// Compare steps through the changed screens in review order. Callbacks read it from a ref,
// because they are created before the diff that produces it.
const compareOrderRef = useRef<readonly ChangedScreen[]>([]);
@@ -384,41 +392,60 @@ function ViewerApp() {
setThemePreference(current => (current === "system" ? preferredSystemTheme : current) === "dark" ? "light" : "dark");
}, [preferredSystemTheme]);
/** Takes the report the page holds (an opened file, a hosted preview's target), synchronously; false when there is none. */
const adoptEmbeddedReport = useCallback((): boolean => {
if (REPORT_SOURCE.data?.exploration) {
const { map, coverage } = REPORT_SOURCE.data.exploration;
workspaceModeRef.current = false;
revisionRef.current = { runId: map.run.id, revision: map.revision };
setLoadedPublicReview(undefined);
setWorkspace(undefined);
setPayload({ map, coverage });
const nextContext = routeContextForMap(map);
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
contextRef.current = nextContext;
routeRef.current = nextRoute;
setRoute(nextRoute);
setError(undefined);
return true;
}
if (REPORT_SOURCE.data) {
const publicReview = REPORT_SOURCE.data.publicReview;
const body = publicReview ? publicReviewToWorkspace(publicReview) : REPORT_SOURCE.data.workspace!;
const current = body.builds[body.catalog.currentBuildId];
if (!current) throw new Error(`Current build is missing: ${body.catalog.currentBuildId}`);
workspaceModeRef.current = true;
setLoadedPublicReview(publicReview);
setWorkspace(body);
setPayload(current);
const nextContext = routeContextForMap(current.map, body.catalog);
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
contextRef.current = nextContext;
routeRef.current = nextRoute;
setRoute(nextRoute);
setError(undefined);
return true;
}
return false;
}, []);
// Another report took the page (a hosted preview switched targets): adopt it in this very render, so no frame shows
// the old report against the new report's assets, and the chrome, the camera and the view stay instead of a fresh
// Viewer flashing its loading screen and an empty canvas.
const [shownReportKey, setShownReportKey] = useState(reportKey);
if (shownReportKey !== reportKey) {
setShownReportKey(reportKey);
try {
adoptEmbeddedReport();
} catch (adoptError) {
setError(adoptError instanceof Error ? adoptError.message : String(adoptError));
}
}
const load = useCallback(async (silent = false) => {
void silent;
try {
if (REPORT_SOURCE.data?.exploration) {
const { map, coverage } = REPORT_SOURCE.data.exploration;
workspaceModeRef.current = false;
revisionRef.current = { runId: map.run.id, revision: map.revision };
setLoadedPublicReview(undefined);
setWorkspace(undefined);
setPayload({ map, coverage });
const nextContext = routeContextForMap(map);
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
contextRef.current = nextContext;
routeRef.current = nextRoute;
setRoute(nextRoute);
setError(undefined);
return;
}
if (REPORT_SOURCE.data) {
const publicReview = REPORT_SOURCE.data.publicReview;
const body = publicReview ? publicReviewToWorkspace(publicReview) : REPORT_SOURCE.data.workspace!;
const current = body.builds[body.catalog.currentBuildId];
if (!current) throw new Error(`Current build is missing: ${body.catalog.currentBuildId}`);
workspaceModeRef.current = true;
setLoadedPublicReview(publicReview);
setWorkspace(body);
setPayload(current);
const nextContext = routeContextForMap(current.map, body.catalog);
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
contextRef.current = nextContext;
routeRef.current = nextRoute;
setRoute(nextRoute);
setError(undefined);
return;
}
if (adoptEmbeddedReport()) return;
if (STATIC_VIEWER_SOURCE.mode === "invalid") {
throw new Error(STATIC_VIEWER_SOURCE.error);
}
@@ -524,7 +551,7 @@ function ViewerApp() {
} catch (loadError) {
setError(loadError instanceof Error ? loadError.message : String(loadError));
}
}, []);
}, [adoptEmbeddedReport]);
const poll = useCallback(async () => {
if (pollingRef.current) return;
@@ -1003,6 +1030,14 @@ function ViewerApp() {
setShortcutsOpen(true);
return;
}
// "/" finds a screen: on Screens the page itself opens its field; elsewhere it goes to Screens with the field open.
if (event.key === FIND_KEY && !event.metaKey && !event.ctrlKey && !event.altKey) {
if (routeRef.current.canvas === "screens" || phoneRef.current) return;
event.preventDefault();
selectCanvas("screens");
setFindRequest((count) => (count ?? 0) + 1);
return;
}
if (matchesShortcut(event, SHORTCUTS.app.handoff)) {
if (!handoffAvailableRef.current) return;
setHandoffOpen(true);
@@ -1527,6 +1562,44 @@ function ViewerApp() {
};
const openHandoff = () => setHandoffOpen(true);
handoffAvailableRef.current = Boolean(handoffInput);
// ⌘K: the commands for this canvas, built while the palette is open, ahead of the screens in its search.
const paletteCommands = searchOpen ? commandItems({
canvas: route.canvas,
phone,
changed: compareOrder,
selectedScreenId,
find: !phone,
handoff: Boolean(handoffInput),
pullRequest: review?.pullRequest,
theme: themePreference,
appearances: appearances.length > 1 ? appearances.map((option) => ({ id: option, label: appearanceLabel(option), current: option === appearance })) : [],
inspector: phone || comparingScreens ? undefined : { open: !rightCollapsed },
fullscreen: !phone && typeof document.documentElement.requestFullscreen === "function" ? fullscreen : undefined,
targets: (() => {
const run = runTargets(map.run);
const noun = run.targets.every((target) => target.id === target.platform) ? "platform" as const : "device" as const;
const page = new URL(window.location.href);
return run.targets.flatMap((target, place) => target.id !== run.current && siblingReportUrl(page, target.id) ? [{ id: target.id, label: target.label, platform: target.platform, place, noun }] : []);
})(),
camera: !phone && route.canvas === "map" && Boolean(getCanvasZoomState().api),
}, {
selectCanvas,
openFind: () => { selectCanvas("screens"); setFindRequest((count) => (count ?? 0) + 1); },
openHandoff,
openShortcuts: () => setShortcutsOpen(true),
toggleChanges: () => setChangesOpen((open) => !open),
openChangedScreen,
setTheme: setThemePreference,
chooseAppearance,
toggleInspector: toggleRightPanel,
toggleFullscreen,
switchTarget: (id) => {
const url = siblingReportUrl(new URL(window.location.href), id);
if (url && !REPORT_SOURCE.switchTarget(id, url)) window.location.assign(url);
},
zoom: (command) => runCanvasZoomCommand(command === "fit" && getCanvasZoomState().api?.hasSelection() ? "selection" : command),
}) : [];
const paletteSuggestions = [...suggestedCommands(paletteCommands, route.canvas), ...searchSuggestions.filter((item) => item.screenId === selectedScreenId)];
const handoffAction = handoffInput ? <HandoffButton {...(phone ? { className: "collapsed-search" } : { tooltip: true })} onOpen={openHandoff} /> : null;
const viewer = (
@@ -1564,6 +1637,8 @@ function ViewerApp() {
{...(focusRequest ? { focusRequest } : {})}
focus={focusFilter}
phone={phone}
findRequest={findRequest}
onFindRequestDone={clearFindRequest}
onSelectScreen={selectScreenOnCanvas}
onPickScreen={pickScreenInPlace}
onClearSelection={clearSelectedScreen}
@@ -1649,8 +1724,8 @@ function ViewerApp() {
) : null}
<SearchCommand
open={searchOpen}
items={searchIndex}
suggestions={searchSuggestions}
items={[...paletteCommands, ...searchIndex]}
suggestions={paletteSuggestions}
onClose={closeSearch}
onSelectScreen={selectSearchScreen}
/>
@@ -1683,4 +1758,4 @@ function ViewerApp() {
</>
);
return viewer;
}
});
@@ -2,6 +2,7 @@ import type { CSSProperties, MouseEventHandler, ReactNode } from "react";
import { ImageOff, PanelRight } from "lucide-react";
import { diffClass, type DiffStatus } from "../../utils/build-diff";
import { ScreenPathText } from "../shared/screen-path-text";
import { Tooltip } from "../shared/tooltip";
import { DEFAULT_SCREENSHOT_SIZE, ScreenshotImage } from "../shared/screenshot-image";
import { CanvasActiveFrame } from "./active-frame";
import { DiffFrame } from "./diff-frame";
@@ -30,6 +31,8 @@ export type ScreenScreenshotCardProps = {
loading?: "eager" | "lazy";
leading?: ReactNode;
trailing?: ReactNode;
/** Where the "Open in Inspector" tooltip sits: away from the route heading, which is above the screenshot on the Map. */
tooltipPlacement?: "top" | "bottom";
/** Short lines about the screen, inside the card after its screenshot (Screens: how it was reached, where else it changed). */
note?: ReactNode;
onClick: MouseEventHandler<HTMLButtonElement>;
@@ -89,10 +92,13 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
free of block children. */}
<span className="screen-screenshot-slot">
{props.leading}
{/* With a pointer, what a click does is said once, zoom-independent, in the shared tooltip
after its usual delay; the selected screen is already in the Inspector. The button has
no title of its own, so no native tooltip joins it; the heading names the screen. */}
<Tooltip label="Open in Inspector" placement={props.tooltipPlacement ?? "top"} disabled={Boolean(props.selected)}>
<button
type="button"
className="screen-screenshot-target"
title={props.plainTitle ? props.title : props.path}
aria-label={props.ariaLabel ?? `Open ${props.plainTitle ? props.title : props.path}`}
{...(props.ariaPressed !== undefined ? { "aria-pressed": props.ariaPressed } : {})}
onClick={props.onClick}>
@@ -108,18 +114,18 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
decoding="async"
loading={props.loading ?? "lazy"}
fallback={missing}
holdPrevious
/>
) : missing}
{/* On hover, says what a click does; on a phone's map, what the second tap does.
See styles.css for when each wording shows. */}
{/* On a phone's map, says what the second tap on the selected screen does. */}
<span className="screen-open-hint" aria-hidden="true">
<PanelRight />
<span className="screen-open-hint-long">Open in Inspector</span>
<span className="screen-open-hint-short">Open</span>
<span>Open</span>
</span>
</span>
</DiffFrame>
</button>
</Tooltip>
{props.trailing}
</span>
{props.note ? <span className="screen-node-note">{props.note}</span> : null}
+8 -18
View File
@@ -3,7 +3,7 @@ import { useReactFlow, useStore } from "@xyflow/react";
import { publishZoom, registerZoomApi, runCanvasZoomCommand } from "../../utils/canvas-zoom";
import { isTyping, matchesShortcut, SHORTCUTS } from "../../utils/shortcuts";
import { useCanvasVisibleFrame } from "./visible-frame-provider";
import { createKeyHold, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
import { createKeyHold, glideWhileHeld, ZOOM_GLIDE, type KeyHold } from "../../utils/key-hold";
import {
canvasBoundsViewport,
canvasPriorityProjectionBounds,
@@ -16,7 +16,7 @@ import {
} from "./camera";
const DURATION = 160;
/** React Flow's zoomIn/zoomOut step, which a tap of + or − takes. */
/** The step a tap of + or − takes, React Flow's own zoomIn/zoomOut step. */
const KEY_ZOOM_STEP = 1.2;
const PIXEL_WHEEL_ZOOM_RATE = 0.002;
const LINE_WHEEL_ZOOM_RATE = 0.05;
@@ -216,18 +216,10 @@ export function ZoomBridge(props: {
};
registerZoomApi(api);
// A tap of + or − takes one eased step. Held, the OS key repeat is ignored (each repeat
// restarting the easing made holding slower than tapping); once the tap's step has landed the
// camera glides instead, frame by frame about the pane's centre, as zoomIn does, until the key
// is released, the hold is interrupted, or the zoom reaches its limit.
const zoomStep = (direction: 1 | -1): boolean => {
const viewport = getViewport();
const next = Math.min(maxZoom, Math.max(minZoom, viewport.zoom * KEY_ZOOM_STEP ** direction));
if (next === viewport.zoom) return false;
if (direction === 1) void zoomIn({ duration: DURATION });
else void zoomOut({ duration: DURATION });
return true;
};
// A tap of + or − zooms one step; held, the camera keeps gliding from that same motion, frame
// by frame about the pane's centre, as zoomIn does, until the key is released, the hold is
// interrupted, or the zoom reaches its limit. The OS key repeat is ignored (each repeat
// restarting an eased step made holding slower than tapping).
const zoomGlide = (direction: 1 | -1) => (steps: number): boolean => {
const viewport = getViewport();
const zoom = Math.min(maxZoom, Math.max(minZoom, viewport.zoom * KEY_ZOOM_STEP ** (direction * steps)));
@@ -273,14 +265,12 @@ export function ZoomBridge(props: {
if (!direction) return;
event.preventDefault();
onCameraGestureStart.current?.();
if (!zoomStep(direction)) return;
// The hold only tracks the key (released, interrupted, a field or dialog taking over); the
// glide reads it every frame and stops with it.
hold.begin(event.code, () => true);
glideWhileHeld(hold, event.code, DURATION, zoomGlide(direction));
glideWhileHeld(hold.begin(event.code, () => true), zoomGlide(direction), ZOOM_GLIDE);
};
const onKeyUp = (event: KeyboardEvent) => {
if (hold.holding(event.code)) hold.end();
hold.release(event.code);
};
const onModifierWheel = (event: WheelEvent) => {
@@ -6,7 +6,7 @@ import type { MapIndex } from "../../utils/model";
import type { ChangedScreen } from "../../utils/changed-screens";
import { groupVisualRegions, layoutShiftSummary, type VisualChange } from "../../utils/visual-diff";
import { formatShortcut, matchesShortcut, SHORTCUTS, shortcutsLive } from "../../utils/shortcuts";
import { createKeyHold, glideWhileHeld, HOLD_INITIAL_DELAY_MS, type KeyHold } from "../../utils/key-hold";
import { createKeyHold, DIVIDER_GLIDE, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
import { optionalStorage } from "../../utils/embedded-report";
import { usePhoneLayout } from "../../utils/phone-layout";
import { ToggleGroup } from "../shared/toggle-group";
@@ -186,10 +186,10 @@ export function useCompareController(options: CompareControllerOptions) {
holdRef.current ??= createKeyHold();
const hold = holdRef.current;
useEffect(() => hold.end, [hold]);
// The hold only tracks the key; the glide reads it every frame and stops with it.
// A tap of [ or ] moves the divider one step; held, it keeps going from the same motion. The hold only
// tracks the key; the glide reads it every frame and stops with it.
const glideDivider = (code: string, direction: 1 | -1) => {
hold.begin(code, () => true);
glideWhileHeld(hold, code, HOLD_INITIAL_DELAY_MS, (steps) => moveDivider(direction, steps));
glideWhileHeld(hold.begin(code, () => true), (steps) => moveDivider(direction, steps), DIVIDER_GLIDE);
};
useEffect(() => {
@@ -225,10 +225,10 @@ export function useCompareController(options: CompareControllerOptions) {
flip();
} else if (matchesShortcut(event, keys.dividerLeft)) {
if (state.mode !== "swipe") return;
if (moveDivider(-1)) glideDivider(event.code, -1);
glideDivider(event.code, -1);
} else if (matchesShortcut(event, keys.dividerRight)) {
if (state.mode !== "swipe") return;
if (moveDivider(1)) glideDivider(event.code, 1);
glideDivider(event.code, 1);
} else if (matchesShortcut(event, keys.outlines)) {
toggleOutlines();
} else if (matchesShortcut(event, keys.whatChanged)) {
@@ -239,7 +239,7 @@ export function useCompareController(options: CompareControllerOptions) {
event.preventDefault();
};
const onKeyUp = (event: KeyboardEvent) => {
if (hold.holding(event.code)) hold.end();
hold.release(event.code);
};
window.addEventListener("keydown", onKeyDown);
window.addEventListener("keyup", onKeyUp);
@@ -81,7 +81,8 @@ export function shortcutGroups(context: ShortcutContext): Group[][] {
...(CANVAS_NUMBER_KEYS
? [{ label: "The same, by their place in the toolbar", keys: sections.map((section) => SHORTCUTS.canvasByNumber[section]) }]
: []),
{ label: "Search screens", keys: [SHORTCUTS.app.search] },
{ label: "Search screens and commands", keys: [SHORTCUTS.app.search] },
{ label: "Find a screen on the Screens page", keys: ["/"] },
...(context.handoff ? [{ label: "Hand off to AI", keys: [SHORTCUTS.app.handoff] }] : []),
...(context.hasChanges ? [{ label: "Changed screens menu", keys: [SHORTCUTS.app.changes] }] : []),
...(context.targets ? targetRows(context.targets) : []),
+17 -6
View File
@@ -1,6 +1,7 @@
import { appearanceLabel, type Appearance } from "../../utils/appearance";
import { useEffect, useRef, useState, type ReactNode } from "react";
import { Search } from "lucide-react";
import { useEffect, useRef, useState, useSyncExternalStore, type ReactNode } from "react";
import { LoaderCircle, Search } from "lucide-react";
import { toast } from "sonner";
import { ExpoLogo } from "../shared/expo-logo";
import { Menu } from "../shared/menu";
import { isPreviewPath, isReportTargetId, previewReportsUrl, targetQuery } from "../../utils/artifact-report";
@@ -136,6 +137,8 @@ export function AppPill(props: AppPillProps) {
const pillRef = useRef<HTMLDivElement>(null);
const platformRef = useRef<HTMLButtonElement>(null);
const [platformOpen, setPlatformOpen] = useState(false);
// A target still downloading: this report stays up, the trigger and the menu row say so. One that failed says why.
const { switching, switchError } = useSyncExternalStore(REPORT_SOURCE.subscribe, REPORT_SOURCE.getSnapshot, REPORT_SOURCE.getSnapshot);
const appearanceRef = useRef<HTMLButtonElement>(null);
const [appearanceOpen, setAppearanceOpen] = useState(false);
const appearanceItems = (props.appearance?.options ?? []).map(option => ({
@@ -189,8 +192,9 @@ export function AppPill(props: AppPillProps) {
const sibling = siblings.find(entry => entry.target.id === target.id);
return sibling ? [{
kind: "item" as const, label: target.label,
description: [sibling.report?.changes === undefined ? undefined : `${sibling.report.changes} ${sibling.report.changes === 1 ? "change" : "changes"}`, sibling.report?.device]
.filter(Boolean).join(" · ") || (target.platform === platform ? "Same review, other device" : "Same review, other platform"),
description: switching?.target === target.id ? "Downloading…"
: [sibling.report?.changes === undefined ? undefined : `${sibling.report.changes} ${sibling.report.changes === 1 ? "change" : "changes"}`, sibling.report?.device]
.filter(Boolean).join(" · ") || (target.platform === platform ? "Same review, other device" : "Same review, other platform"),
checked: false, ...numberHint(target), onSelect: () => openTarget(target.id),
}] : [];
}) : [];
@@ -201,6 +205,10 @@ export function AppPill(props: AppPillProps) {
// the menu's order before there is one). The handler reads the current targets from a ref.
const last = useLastTarget(run.current);
const targetKeys = { siblings: siblings.map(entry => entry.target.id), order: run.targets.map(target => target.id), current: run.current, last, openTarget };
const failedLabel = switchError ? run.targets.find(target => target.id === switchError.target)?.label : undefined;
useEffect(() => {
if (switchError) toast.error(failedLabel ? `Couldn’t open ${failedLabel}` : "Couldn’t open the other report", { description: switchError.error });
}, [switchError, failedLabel]);
const targetKeysRef = useRef(targetKeys);
targetKeysRef.current = targetKeys;
useEffect(() => {
@@ -236,7 +244,7 @@ export function AppPill(props: AppPillProps) {
<button type="button" className="panel-logo-button" aria-label="Map" onClick={props.onOpenMap}>
{appIcon ? (
<ScreenshotImage className="panel-app-icon" src={appIcon} alt="" loading="eager" draggable={false}
fallback={<ExpoLogo mark />} />
fallback={<ExpoLogo mark />} holdPrevious />
) : <ExpoLogo mark />}
</button>
</Tooltip>
@@ -255,9 +263,12 @@ export function AppPill(props: AppPillProps) {
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} shortcut={formatShortcut(SHORTCUTS.target.menu)} placement="bottom">
<button ref={platformRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={platformOpen}
aria-label={`${noun === "device" ? "Device" : "Platform"}: ${targetLabel}. Open another ${noun}'s report`}
aria-busy={switching ? true : undefined}
onClick={() => setPlatformOpen(open => !open)}>
{targetLabel}
<svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>
{switching
? <LoaderCircle aria-hidden="true" className="collapsed-platform-busy" />
: <svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>}
</button>
</Tooltip>
<Menu items={platformItems} open={platformOpen} anchorRef={platformRef} ariaLabel={noun === "device" ? "Device" : "Platform"} onDismiss={() => setPlatformOpen(false)} />
+60 -32
View File
@@ -1,15 +1,36 @@
import { useEffect, useId, useMemo, useRef, useState } from "react";
import { CornerDownLeft, Route, Search, X } from "lucide-react";
import { searchItems, type SearchItem } from "../utils/search";
import { Command, CornerDownLeft, Route, Search, X } from "lucide-react";
import { searchItems, type SearchItem, type SearchItemKind } from "../utils/search";
import { AutoHideScrollArea } from "./shared/auto-hide-scroll-area";
import { useModalDialog } from "../hooks/use-modal-dialog";
const KIND_LABELS: Record<SearchItem["kind"], string> = {
/** Screens are labelled; a command's key, or nothing, sits where the label would. */
const KIND_LABELS: Record<SearchItemKind, string> = {
screen: "Screen",
command: "Command",
};
function ResultIcon() {
return <Route strokeWidth={1.75} />;
function ResultIcon({ kind }: { kind: SearchItemKind }) {
return kind === "screen" ? <Route strokeWidth={1.75} /> : <Command strokeWidth={1.75} />;
}
/** The results grouped by kind, in the order the first result sets, so ↑ and ↓ step through the rows as they read. */
function groupedByKind(results: readonly SearchItem[]): SearchItem[] {
return [...new Set(results.map((item) => item.kind))].flatMap((kind) => results.filter((item) => item.kind === kind));
}
/** Grouped results in their sections, with each item's place in the flat list. */
function sections(results: readonly SearchItem[], suggested: boolean): { label: string; entries: { item: SearchItem; index: number }[] }[] {
const byKind = new Map<SearchItemKind, { item: SearchItem; index: number }[]>();
results.forEach((item, index) => {
const entries = byKind.get(item.kind) ?? [];
entries.push({ item, index });
byKind.set(item.kind, entries);
});
return [...byKind].map(([kind, entries]) => ({
label: kind === "command" ? (suggested ? "Suggested" : "Commands") : suggested ? "Selected screen" : "Screens",
entries,
}));
}
type SearchCommandProps = {
@@ -27,7 +48,7 @@ export function SearchCommand(props: SearchCommandProps) {
const dialogRef = useModalDialog(props.open, props.onClose);
const listboxId = useId();
const results = useMemo(
() => query.trim() ? searchItems(props.items, query) : [...props.suggestions],
() => groupedByKind(query.trim() ? searchItems(props.items, query) : props.suggestions),
[props.items, props.suggestions, query],
);
@@ -59,8 +80,11 @@ export function SearchCommand(props: SearchCommandProps) {
props.onClose();
if (item.kind === "screen" && item.screenId) {
props.onSelectScreen(item.screenId);
} else if (item.kind === "command") {
item.run?.();
}
};
const suggested = !query.trim();
const moveActive = (delta: number) => {
if (results.length === 0) return;
@@ -85,7 +109,7 @@ export function SearchCommand(props: SearchCommandProps) {
<input
ref={inputRef}
role="combobox"
aria-label="Search screens"
aria-label="Search screens and commands"
aria-autocomplete="list"
aria-expanded="true"
aria-controls={listboxId}
@@ -94,7 +118,7 @@ export function SearchCommand(props: SearchCommandProps) {
: {})}
autoComplete="off"
spellCheck="false"
placeholder="Search screens"
placeholder="Search screens and commands"
value={query}
onChange={(event) => setQuery(event.target.value)}
onKeyDown={(event) => {
@@ -116,42 +140,46 @@ export function SearchCommand(props: SearchCommandProps) {
</button>
</div>
<div className="search-command-section-label">
{query.trim() ? "Results" : "Suggested"}
</div>
{results.length > 0 ? (
<AutoHideScrollArea
id={listboxId}
shellClassName="search-command-results-shell"
className="search-command-results"
role="listbox">
{results.map((item, index) => (
<button
key={item.id}
id={`${listboxId}-option-${index}`}
type="button"
role="option"
aria-selected={activeIndex === index}
className={`search-command-result${activeIndex === index ? " active" : ""}`}
onPointerMove={() => setActiveIndex(index)}
onClick={() => select(item)}>
<span className={`search-command-result-icon result-${item.kind}`} aria-hidden="true">
<ResultIcon />
</span>
<span className="search-command-result-copy">
<strong>{item.kind === "screen" ? <code>{item.title}</code> : item.title}</strong>
{item.context && <small>{item.context}</small>}
</span>
<span className="search-command-result-kind">{KIND_LABELS[item.kind]}</span>
{activeIndex === index && <CornerDownLeft className="search-command-enter" aria-hidden="true" />}
</button>
{sections(results, suggested).map((section) => (
<div key={section.label} className="search-command-section" role="group" aria-label={section.label}>
<div className="search-command-section-label">{section.label}</div>
{section.entries.map(({ item, index }) => (
<button
key={item.id}
id={`${listboxId}-option-${index}`}
type="button"
role="option"
aria-selected={activeIndex === index}
className={`search-command-result${activeIndex === index ? " active" : ""}`}
onPointerMove={() => setActiveIndex(index)}
onClick={() => select(item)}>
<span className={`search-command-result-icon result-${item.kind}`} aria-hidden="true">
<ResultIcon kind={item.kind} />
</span>
<span className="search-command-result-copy">
<strong>{item.kind === "screen" ? <code>{item.title}</code> : item.title}</strong>
{item.context && <small>{item.context}</small>}
</span>
{item.shortcut
? <kbd className="search-command-result-key">{item.shortcut}</kbd>
: item.kind === "screen" ? <span className="search-command-result-kind">{KIND_LABELS[item.kind]}</span> : null}
{activeIndex === index && <CornerDownLeft className="search-command-enter" aria-hidden="true" />}
</button>
))}
</div>
))}
</AutoHideScrollArea>
) : (
<div className="search-command-empty" role="status">
<Search aria-hidden="true" />
<strong>No results</strong>
<span>Try another screen.</span>
<span>Try a route, or a command such as “dark” or “fit”.</span>
</div>
)}
</div>
@@ -26,7 +26,14 @@
.panel-search input {
width: 100%;
min-width: 0;
height: 100%;
margin: 0;
padding: 0;
border: 0;
/* A search field's own look on macOS sets its text low in the box; the flex row centers plain text. */
appearance: none;
-webkit-appearance: none;
line-height: normal;
outline: 0;
color: var(--text);
background: transparent;
@@ -1,6 +1,6 @@
import { useEffect, useLayoutEffect, useRef, useState, type ImgHTMLAttributes, type ReactNode, type SyntheticEvent } from "react";
import { ImageOff, LoaderCircle } from "lucide-react";
import { isEmbeddedArtifactUrl, releaseEmbeddedArtifactUrl, resolveEmbeddedArtifactUrl } from "../../utils/embedded-report";
import { isEmbeddedArtifactUrl, leaseEmbeddedArtifactUrl } from "../../utils/embedded-report";
/** A phone screen's width over height; frames size to it until a screenshot supplies its own. */
export const DEFAULT_SCREENSHOT_RATIO = 9 / 19.5;
@@ -12,6 +12,12 @@ type ScreenshotImageProps = ImgHTMLAttributes<HTMLImageElement> & {
indicator?: "spinner";
/** Stands in for an embedded screenshot that cannot be read: the caller's own no-screenshot state. */
fallback?: ReactNode;
/**
* Keeps the picture of the source before on screen until the new one has decoded: for a map card, whose source
* changes only when the report's other appearance or target swaps every screenshot at once. Never for a view that
* steps between screens or draws changes over the picture, where it would show the screen before under the new one.
*/
holdPrevious?: boolean;
};
type ScreenshotState = "loading" | "ready" | "failed";
@@ -37,17 +43,21 @@ function waitingSource(width: number | string | undefined, height: number | stri
* embedded screenshot resolves, the image shows an empty frame (and, with `indicator`, a spinner)
* and never its alt text; a screenshot that cannot be read shows `fallback`.
*/
export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onError, ...props }: ScreenshotImageProps) {
export function ScreenshotImage({ src, loading, indicator, fallback, holdPrevious, onLoad, onError, ...props }: ScreenshotImageProps) {
const imageRef = useRef<HTMLImageElement>(null);
const [resolved, setResolved] = useState<{ source: string; url: string }>();
const [failed, setFailed] = useState<string>();
const [shown, setShown] = useState<string>();
const [lastSource, setLastSource] = useState(src);
// With `holdPrevious`, the picture of the source before, kept on screen until the new one has decoded.
const [held, setHeld] = useState<string>();
const embedded = typeof src === "string" && isEmbeddedArtifactUrl(src);
// A new source starts over: a fresh attempt, even for one that failed before, and never a URL
// resolved on an earlier visit, which was released on leaving and may since have been revoked.
if (lastSource !== src) {
setLastSource(src);
// A source that failed has no picture of its own to hand on, and drops the one it held.
setHeld(holdPrevious && failed !== lastSource ? shown ?? held : undefined);
setResolved(undefined);
setShown(undefined);
setFailed(undefined);
@@ -61,13 +71,18 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
let requested = false;
let generation = 0;
let observer: IntersectionObserver | undefined;
// Released against the report that resolved it: a hosted preview's other target can hold the same screenshot,
// so this image can outlive its report without its source changing.
let lease: ReturnType<typeof leaseEmbeddedArtifactUrl> | undefined;
const load = () => {
if (disposed || requested) return;
requested = true;
const current = ++generation;
const leased = leaseEmbeddedArtifactUrl(src, loading === "eager" ? "eager" : "lazy");
lease = leased;
void (async () => {
try {
const url = await resolveEmbeddedArtifactUrl(src, loading === "eager" ? "eager" : "lazy");
const url = await leased.url;
if (disposed || generation !== current) return;
setResolved({ source: src, url });
// A fresh URL gets its own chance to decode.
@@ -76,6 +91,11 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
if (disposed || generation !== current) return;
// A failed load holds no reference, so nothing is released for it later.
requested = false;
// The report it waited on was switched away from and let it go: ask the one shown now, which may hold it too.
if (!leased.current()) {
load();
return;
}
observer?.disconnect();
image.dispatchEvent(new Event("error"));
setFailed(src);
@@ -86,7 +106,7 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
else {
observer = new IntersectionObserver(entries => {
if (entries.some(entry => entry.isIntersecting)) load();
else if (requested && releaseEmbeddedArtifactUrl(src)) {
else if (requested && lease?.release()) {
requested = false;
generation++;
setResolved(undefined);
@@ -98,21 +118,24 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
return () => {
disposed = true;
observer?.disconnect();
if (requested) releaseEmbeddedArtifactUrl(src);
if (requested) lease?.release();
};
}, [embedded, src, loading]);
const url = embedded && resolved?.source === src ? resolved.url : undefined;
const state: ScreenshotState = failed === src ? "failed" : url && shown === url ? "ready" : "loading";
const displayed = state !== "failed" ? url : undefined;
const displayed = state !== "failed" ? url ?? held : undefined;
// Re-committing the URL the image already shows (it left the viewport and came back before a
// render, and the report still held the URL) fires no load event: the decoded image is ready.
useLayoutEffect(() => {
const image = imageRef.current;
if (!displayed || shown === displayed || !image || image.getAttribute("src") !== displayed) return;
if (image.complete && image.naturalWidth > 0) setShown(displayed);
}, [displayed, shown]);
if (!displayed || displayed !== url || shown === displayed || !image || image.getAttribute("src") !== displayed) return;
if (image.complete && image.naturalWidth > 0) {
setShown(displayed);
setHeld(undefined);
}
}, [displayed, url, shown]);
if (!embedded) return <img {...props} ref={imageRef} loading={loading} src={src} onLoad={onLoad} onError={onError} />;
if (state === "failed" && fallback !== undefined) return <>{fallback}</>;
@@ -129,10 +152,13 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
onLoad={event => {
if (!isScreenshot(event)) return;
setShown(url);
setHeld(undefined);
onLoad?.(event);
}}
onError={event => {
if (event.nativeEvent.isTrusted) {
// The held picture's URL was revoked since (the report let it go): nothing to show until the new one.
if (held && !url && event.currentTarget.getAttribute("src") === held) { setHeld(undefined); return; }
if (!isScreenshot(event)) return;
setFailed(src);
}
+11
View File
@@ -162,7 +162,18 @@ export function Tooltip({
if (bubbleRef.current) observer.observe(bubbleRef.current);
window.addEventListener("resize", update);
window.addEventListener("scroll", update, true);
// A canvas pans and zooms its cards by transform, which neither observer reports: while open,
// follow the anchor frame by frame so the bubble never stays behind over what it labels.
let followed = "";
let frame = requestAnimationFrame(function follow() {
const anchor = anchorRef.current?.getBoundingClientRect();
const key = anchor ? `${anchor.left} ${anchor.top} ${anchor.width} ${anchor.height}` : "";
if (followed && key !== followed) update();
followed = key;
frame = requestAnimationFrame(follow);
});
return () => {
cancelAnimationFrame(frame);
observer.disconnect();
window.removeEventListener("resize", update);
window.removeEventListener("scroll", update, true);
+25 -1
View File
@@ -67,7 +67,8 @@
.screens-tree ul { margin: 0; padding: 0; list-style: none; }
/* Changed / All filter the tree and the grid alike, so they sit in the tree's head as one segmented control,
beside the button that folds or unfolds every folder. */
.screens-tree-head { display: flex; align-items: center; gap: 6px; margin: 0 0 10px; }
/* One height in every state (chips, the find field, or only the icons), so opening the find does not move the tree. */
.screens-tree-head { display: flex; height: 34px; flex: none; align-items: center; gap: 6px; margin: 0 0 10px; }
.screens-tree-head > .screens-filter {
flex: 1;
gap: 2px;
@@ -337,3 +338,26 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
.screens-tree.phone .screens-tree-row { min-height: 34px; font-size: var(--phone-body-size); }
.screens-tree.phone .screens-tree-label.path { font-size: var(--phone-body-mono-size); }
.screens-tree.phone .screens-tree-kind { font-size: var(--phone-micro-size); }
/* ── Find: `/` or the magnifier turns the tree's head into a field; the tree and the grid narrow to its matches ── */
.screens-tree-head > .tooltip-anchor { display: flex; flex: none; margin-left: auto; }
.screens-tree-head > .tooltip-anchor + .screens-tree-fold-all { margin-left: 0; }
.screens-tree-find {
display: grid;
width: 32px;
height: 32px;
flex: none;
place-items: center;
border-radius: 8px;
color: var(--secondary);
background: transparent;
}
.screens-tree-find:hover { color: var(--text); background: var(--panel-hover); }
.screens-tree-find > svg { width: 16px; height: 16px; }
.screens-tree-head.searching { gap: 4px; }
.screens-find { display: flex; min-width: 0; flex: 1; }
.screens-find .panel-search { height: 34px; border-radius: 9px; }
.screens-find-empty { margin: 0; padding: 4px 8px; color: var(--tertiary); font-size: 12px; }
.screens-empty { min-height: 240px; flex: 1; }
.screens-empty-all { padding: 0; color: var(--accent); font: inherit; background: transparent; }
.screens-empty-all:hover { text-decoration-line: underline; text-underline-offset: 3px; }
+141 -16
View File
@@ -1,5 +1,5 @@
import { useEffect, useMemo, useRef, useState, type CSSProperties, type KeyboardEvent, type ReactNode } from "react";
import { ChevronRight, ChevronsDownUp, ChevronsUpDown, ListTree } from "lucide-react";
import { ChevronRight, ChevronsDownUp, ChevronsUpDown, ListTree, Search } from "lucide-react";
import { artifactUrl, isLaunchScreen, type ExploreMap, type MapIndex, type Screen } from "../../utils/model";
import { primaryScreenshotForScreen, screenshotSize, typicalScreenshotSize, type ScreenshotSize } from "../../utils/screen-images";
import { diffClass, type BuildDiff, type DiffStatus } from "../../utils/build-diff";
@@ -9,11 +9,14 @@ import { screenTree, treeIndex, treeNodeKey, treeScreenOrder, type ScreenTree, t
import type { Appearance } from "../../utils/appearance";
import type { FocusRequest, FocusStatus } from "../../utils/navigation";
import { shortcutsLive } from "../../utils/shortcuts";
import { normalizeSearchText } from "../../utils/search";
import { createKeyHold } from "../../utils/key-hold";
import { placeholderScreen } from "../../utils/map-frame";
import { ScreenScreenshotCard } from "../canvas/screen-screenshot-card";
import { useCanvasVisibleFrame } from "../canvas/visible-frame-provider";
import { PhoneSheet } from "../phone/phone-chrome";
import { PanelSearch } from "../shared/panel-search";
import { Tooltip } from "../shared/tooltip";
import "./screens.css";
/** The statuses a tree dot marks. The Changed filter keeps only the screens whose captures differ (isCapturedChange). */
@@ -36,6 +39,10 @@ export type ScreensViewProps = {
focus?: readonly FocusStatus[] | undefined;
/** The phone layout: a jump bar and a Tree sheet stand in for the sidebar. */
phone?: boolean;
/** A request to open the find field (`/` pressed on another canvas); a new key asks again. */
findRequest?: number | undefined;
/** The find opened for `findRequest`; the parent drops it so a later visit to Screens does not open it again. */
onFindRequestDone?: (() => void) | undefined;
onSelectScreen: (id: string) => void;
/** The tree and jump bar pick a screen without opening the Inspector; a screenshot click selects it as the canvas does. */
onPickScreen?: ((id: string) => void) | undefined;
@@ -74,6 +81,35 @@ function writeFolded(key: string, folded: ReadonlySet<string>): void {
} catch { /* Folds last for this visit only. */ }
}
/** The key that opens the find field: a character, not a key position, so it is read from the layout like "?". */
export const FIND_KEY = "/";
function isFindKey(event: globalThis.KeyboardEvent): boolean {
return event.key === FIND_KEY && !event.metaKey && !event.ctrlKey && !event.altKey;
}
/** The screens whose route or title contains the query, by id; `undefined` when there is no query. */
function findMatches(screens: readonly Screen[], index: MapIndex, rawQuery: string): Set<string> | undefined {
const query = normalizeSearchText(rawQuery);
if (!query) return undefined;
return new Set(screens
.filter(screen => [displayPathForScreen(screen), screenLabel(screen, index), screen.title]
.some(text => normalizeSearchText(text).includes(query)))
.map(screen => screen.id));
}
/**
* The tree with only the matching screens and the rows above them, so a find reads as a short list in the tree's own
* shape; a folder or parent screen kept only for what is under it is marked, as a row outside Changed is.
*/
function pruneTree(nodes: readonly ScreenTreeNode[], matches: ReadonlySet<string>): ScreenTreeNode[] {
return nodes.flatMap((node) => {
const children = pruneTree(node.children, matches);
if (node.kind === "screen" ? matches.has(node.screenId) || children.length : children.length) return [{ ...node, children }];
return [];
});
}
function cardId(id: string): string {
return `screens-card-${id.replace(/[^A-Za-z0-9_-]/g, "_")}`;
}
@@ -249,7 +285,15 @@ export function ScreensView(props: ScreensViewProps) {
);
const [filter, setFilter] = useState<Filter>(props.phone && changedIds.size > 0 ? "changed" : "all");
const [treeOpen, setTreeOpen] = useState(false);
const shown = filter === "changed" && changedIds.size > 0 ? changedIds : new Set(props.map.screens.map(screen => screen.id));
// Find: a query narrows the tree and the grid to the screens whose route or title contains it, inside Changed or All.
const [findOpen, setFindOpen] = useState(false);
const [query, setQuery] = useState("");
// The phone layout has no field to show or clear a query, so a query typed on desktop does not narrow it.
const findQuery = findOpen && !props.phone ? query : "";
const matches = useMemo(() => findMatches(props.map.screens, props.index, findQuery), [props.index, props.map.screens, findQuery]);
const inChanged = filter === "changed" && changedIds.size > 0;
const inFilter = inChanged ? changedIds : new Set(props.map.screens.map(screen => screen.id));
const shown = matches ? new Set([...inFilter].filter(id => matches.has(id))) : inFilter;
const sections = tree.sections
.map(section => ({ ...section, screenIds: section.screenIds.filter(id => shown.has(id)) }))
.filter(section => section.screenIds.length > 0);
@@ -267,9 +311,12 @@ export function ScreensView(props: ScreensViewProps) {
const [foldedAll, setFoldedAll] = useState<ReadonlySet<string>>(() => readFolded(storageKey));
const [foldedChanged, setFoldedChanged] = useState<ReadonlySet<string>>(foldedWithoutChanges);
useEffect(() => writeFolded(storageKey, foldedAll), [foldedAll, storageKey]);
const folded = changedMode ? foldedChanged : foldedAll;
// While a find is on, every row stays open: the pruned tree is the result, and folding it would hide matches.
const folded = matches ? new Set<string>() : changedMode ? foldedChanged : foldedAll;
const setFolded = changedMode ? setFoldedChanged : setFoldedAll;
const toggleFold = (key: string, deep: boolean) => {
// The find's open rows are not the reader's folds; a fold tried there would replace them all.
if (matches) return;
const fold = !folded.has(key);
// ⌥-click folds or unfolds every row inside this one too.
const inside = (candidate: string): boolean => {
@@ -282,7 +329,7 @@ export function ScreensView(props: ScreensViewProps) {
setFolded(next);
};
const anyOpen = shape.keys.some(key => !folded.has(key));
const foldAll = shape.keys.length ? (
const foldAll = shape.keys.length && !matches ? (
<button type="button" className="screens-tree-fold-all" aria-label={anyOpen ? "Collapse all" : "Expand all"}
title={anyOpen ? "Collapse all" : "Expand all"}
onClick={() => setFolded(anyOpen ? new Set(shape.keys) : new Set())}>
@@ -303,6 +350,53 @@ export function ScreensView(props: ScreensViewProps) {
event.preventDefault();
event.stopPropagation();
};
const jumpTo = (id: string) => {
setTreeOpen(false);
if (!inFilter.has(id)) setFilter("all");
(props.onPickScreen ?? props.onSelectScreen)(id);
requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "center", behavior: "smooth" }));
};
const findField = useRef<HTMLDivElement>(null);
const focusFind = () => findField.current?.querySelector("input")?.focus();
const openFind = () => {
setFindOpen(true);
requestAnimationFrame(focusFind);
};
const closeFind = () => {
setQuery("");
setFindOpen(false);
// The field took the keyboard; hand it back to the page so its arrows work again.
if (document.activeElement instanceof HTMLElement) document.activeElement.blur();
};
// `/` from another canvas lands here with the field open.
useEffect(() => {
if (props.findRequest === undefined) return;
if (!props.phone) openFind();
props.onFindRequestDone?.();
// eslint-disable-next-line react-hooks/exhaustive-deps -- a new request opens it once
}, [props.findRequest]);
const findButton = props.phone ? null : (
<Tooltip label="Find a screen" shortcut={FIND_KEY} placement="bottom">
<button type="button" className="screens-tree-find" aria-label="Find a screen" onClick={openFind}>
<Search aria-hidden="true" />
</button>
</Tooltip>
);
const findSearch = findOpen ? (
<div ref={findField} className="screens-find">
<PanelSearch
value={query}
placeholder="Find…"
ariaLabel="Find screens"
clearLabel="Clear find query"
name="screens-find"
autoFocus
onEscape={() => (query ? setQuery("") : closeFind())}
onChange={setQuery}
/>
</div>
) : null;
const filterChips = changedIds.size > 0 ? (
<div className="screens-filter" role="group" aria-label="Show">
{(["changed", "all"] as const).map((value) => (
@@ -329,7 +423,9 @@ export function ScreensView(props: ScreensViewProps) {
// A screen selected elsewhere that Changed hides shows every screen instead, as a pick in the tree does.
// Only a new selection or request switches it; choosing Changed afterwards is the reader's call.
useEffect(() => {
if (selected && !selectedShownRef.current) setFilter("all");
if (!selected || selectedShownRef.current) return;
setFilter("all");
setQuery("");
}, [selected, focusKey]);
// A selection made anywhere unfolds the rows above it, in both filters.
useEffect(() => {
@@ -348,13 +444,6 @@ export function ScreensView(props: ScreensViewProps) {
if (bounds.top < view.top || bounds.bottom > view.bottom) card.scrollIntoView({ block: "center", behavior: "smooth" });
}, [selected, selectedShown, focusKey]);
const jumpTo = (id: string) => {
setTreeOpen(false);
if (!shown.has(id)) setFilter("all");
(props.onPickScreen ?? props.onSelectScreen)(id);
requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "center", behavior: "smooth" }));
};
// On desktop the arrow keys move through the cards: ← and → in their order on the page (`order`), as the arrows step
// through screens in Compare, and ↑ and ↓ to the card above or below, by where the cards sit, so they follow the grid
// at any width. A step picks the screen as the tree does, leaving the Inspector as it is, and focus follows it; with
@@ -372,6 +461,8 @@ export function ScreensView(props: ScreensViewProps) {
pickRef.current = props.onPickScreen ?? props.onSelectScreen;
const openRef = useRef(props.onSelectScreen);
openRef.current = props.onSelectScreen;
const openFindRef = useRef(openFind);
openFindRef.current = openFind;
useEffect(() => {
if (props.phone) return;
/** The card an arrow moves to from `from` (the pick, or the last card a hold stepped to). */
@@ -406,8 +497,29 @@ export function ScreensView(props: ScreensViewProps) {
};
const onKeyDown = (event: globalThis.KeyboardEvent) => {
hold.interrupt(event);
if (isFindKey(event)) {
if (event.defaultPrevented || !shortcutsLive(event)) return;
event.preventDefault();
openFindRef.current();
return;
}
const arrow = ["ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown"].includes(event.code);
if (!arrow && event.key !== "Enter") return;
// In the find field the results below are the field's: ↓ and ↑ step the pick through them in page order while
// the field keeps the keyboard, and Return opens the picked one (the first match before any step).
// Its clear button keeps its own Return, and an input method's Return confirms the text being composed.
if (event.target instanceof Element && event.target.matches(".screens-find input")) {
if (event.isComposing || event.metaKey || event.ctrlKey || event.altKey || event.shiftKey || event.code === "ArrowLeft" || event.code === "ArrowRight") return;
const ids = orderRef.current;
const picked = selectedRef.current && ids.includes(selectedRef.current) ? selectedRef.current : undefined;
const id = !arrow ? picked ?? ids[0] : next(event.code === "ArrowDown" ? "ArrowRight" : "ArrowLeft", picked);
if (!id) return;
event.preventDefault();
if (!arrow) { openRef.current(id); return; }
pickRef.current(id);
requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "nearest" }));
return;
}
// The browser's own repeat of a held arrow would scroll the page under the hold.
if (event.repeat && hold.holding(event.code)) { event.preventDefault(); return; }
if (event.metaKey || event.ctrlKey || event.altKey || event.shiftKey || event.defaultPrevented || !shortcutsLive(event)) return;
@@ -464,9 +576,13 @@ export function ScreensView(props: ScreensViewProps) {
) : null;
};
// A find inside Changed can match only screens Changed hides; the empty state says so and offers All.
const noMatch = `No ${inChanged ? "changed " : ""}screens match “${findQuery.trim()}”`;
const matchedElsewhere = matches && inChanged ? [...matches].filter(id => !inFilter.has(id)).length : 0;
const treeRows = (
<ul className="screens-tree-list" onKeyDown={onTreeKey}>
<TreeRows nodes={tree.tree} depth={0} index={props.index} diff={props.diff} elsewhere={props.changedElsewhere}
<TreeRows nodes={matches ? pruneTree(tree.tree, matches) : tree.tree} depth={0} index={props.index} diff={props.diff} elsewhere={props.changedElsewhere}
visible={shown} selectedScreenId={props.selectedScreenId} folded={folded}
onToggle={toggleFold} onSelect={jumpTo} />
</ul>
@@ -507,9 +623,12 @@ export function ScreensView(props: ScreensViewProps) {
{props.phone ? null : (
<aside className="screens-side">
<nav className="screens-tree" aria-label={tree.mode === "source" ? "Route files" : "Navigation"}>
{filterChips || foldAll ? <div className="screens-tree-head">{filterChips}{foldAll}</div> : null}
{findSearch ? <div className="screens-tree-head searching">{findSearch}</div>
: filterChips || foldAll || findButton ? <div className="screens-tree-head">{filterChips}{findButton}{foldAll}</div> : null}
<h2>{tree.mode === "source" ? "app/" : "Explored app"}</h2>
{treeRows}
{matches && order.length === 0
? <p className="screens-find-empty" role="status">{noMatch}</p>
: treeRows}
{props.diff ? <Legend others={others} /> : null}
</nav>
</aside>
@@ -527,7 +646,13 @@ export function ScreensView(props: ScreensViewProps) {
)) : (
// On desktop the tree beside the page already shows the folders, so every screen sits in one evenly
// spaced grid in the tree's order, without headings between them.
<div className="screens-grid">{order.map(cell)}</div>
matches && order.length === 0
? <div className="page-empty compact-empty screens-empty" role="status"><h2>{noMatch}</h2>{matchedElsewhere
? <p>{matchedElsewhere === 1 ? "1 screen outside Changed matches." : `${matchedElsewhere} screens outside Changed match.`}{" "}
<button type="button" className="screens-empty-all" onPointerDown={(event) => event.preventDefault()}
onClick={() => { setFilter("all"); focusFind(); }}>Show all</button></p>
: <p>Try part of a route, or press Esc to show every {inChanged ? "changed " : ""}screen.</p>}</div>
: <div className="screens-grid">{order.map(cell)}</div>
)}
</div>
</div>
+6 -1
View File
@@ -115,6 +115,8 @@ function ScreenNodeCard({ data, selected }: NodeProps<ScreenGraphNode>) {
imageHeight={data.screenshotSize?.imageHeight ?? data.frame.screen.height}
placeholderSize={data.frame.screen}
loading="lazy"
// The route heads the card, so the tooltip goes below it.
tooltipPlacement="bottom"
leading={<Handle type="target" position={horizontal ? Position.Left : Position.Top} className="graph-handle" />}
trailing={<Handle type="source" position={horizontal ? Position.Right : Position.Bottom} className="graph-handle" />}
onMouseEnter={() => data.onHover(data.screen.id)}
@@ -618,13 +620,16 @@ function ConnectionCanvas(props: MapViewProps) {
}, [hoverScreen, props.diff, props.direction, props.focus, props.selectedScreenId, selectScreen, structure]);
const focusTarget = useMemo(() => screenFocus(props.focusRequest), [props.focusRequest]);
// The card size places the cards too: a hosted preview's other target, with the same screens in another shape, is a new
// layout, not the old positions under bigger cards.
const layoutIdentity = useMemo(() => [
MAP_LAYOUT_REVISION,
props.map.run.id,
props.direction,
`${structure.frame.width}x${structure.frame.height}`,
projection.nodes.map((node) => node.id).join(","),
projection.groups.map((group) => `${group.from}>${group.to}`).join(","),
].join(":"), [projection.groups, projection.nodes, props.direction, props.map.run.id]);
].join(":"), [projection.groups, projection.nodes, props.direction, props.map.run.id, structure.frame]);
// Screens closest to the start load first; within a layer, in reading order.
const priorityNodeIds = useMemo(() => layout.nodes
.map((node, index) => ({ id: node.id, depth: node.data.screen.depth, y: node.position.y, x: node.position.x, index }))
+3 -2
View File
@@ -9,7 +9,7 @@ const FOCUSABLE = [
'[tabindex]:not([tabindex="-1"])',
].join(", ");
/** Escape to close, Tab wrapped inside the dialog, focus restored to the opener. */
/** Escape to close, Tab wrapped inside the dialog, focus restored to the opener unless what closed it moved focus on. */
export function useModalDialog(open: boolean, onClose: () => void) {
const dialogRef = useRef<HTMLDivElement>(null);
const restoreFocusRef = useRef<Element | null>(null);
@@ -17,6 +17,7 @@ export function useModalDialog(open: boolean, onClose: () => void) {
useEffect(() => {
if (!open) return;
restoreFocusRef.current = document.activeElement;
const dialog = dialogRef.current;
const onKeyDown = (event: KeyboardEvent) => {
if (event.key === "Escape") onClose();
if (event.key !== "Tab") return;
@@ -36,7 +37,7 @@ export function useModalDialog(open: boolean, onClose: () => void) {
window.addEventListener("keydown", onKeyDown);
return () => {
window.removeEventListener("keydown", onKeyDown);
(restoreFocusRef.current as HTMLElement | null)?.focus?.();
if (document.activeElement === document.body || dialog?.contains(document.activeElement)) (restoreFocusRef.current as HTMLElement | null)?.focus?.();
};
}, [open, onClose]);
+3 -2
View File
@@ -171,6 +171,7 @@ function titleFor(entry: Pick<NonNullable<Surface["head"]>, "route">): string {
function captureStatus(review: PublicReview, surface: Surface, side: Side): string {
if (!surface[side]) return "Absent from this source revision";
if (surface.excluded) return "Excluded by exploration.exclude; never captured";
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
if (imageFor(surface, side)) {
if (verifiedCapture(surface, side)) return "Captured; destination verified";
@@ -358,14 +359,14 @@ function sidePayload(review: PublicReview, side: Side): { map: ExploreMap; cover
if (!verifiedCapture(surface, side)) {
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
const outsideCaptureContext = review.mode === "changes" && selected !== undefined && !selected.has(surface.id);
const deliberatelyOmitted = !image && !outcome && (entry.kind === "redirect" || outsideCaptureContext
const deliberatelyOmitted = !image && !outcome && (entry.kind === "redirect" || surface.excluded === true || outsideCaptureContext
|| (!navigation && review.mode === "changes" && surface.status === "unchanged"));
map.gaps.push({
id: `capture:${side}:${surface.id}`,
screenId: surface.id,
kind: "coverage",
status: deliberatelyOmitted ? "accepted" : "open",
message: deliberatelyOmitted && outsideCaptureContext && entry.kind !== "redirect"
message: deliberatelyOmitted && outsideCaptureContext && entry.kind !== "redirect" && !surface.excluded
? "Not compared; no capture was recorded" : captureStatus(review, surface, side),
createdAt: review.createdAt,
});
+44 -40
View File
@@ -110,7 +110,7 @@
/* How far an item the Changes filter does not cover falls back. Low enough to read as
background at a glance, high enough that the canvas keeps its shape. */
--dim-out: 0.35;
--hover-recede: 0.6;
--hover-neighbour-frame: color-mix(in srgb, var(--accent) 55%, var(--border-subtle));
--shadow-xs: 0 1px 3px rgba(0, 0, 0, 0.025), 0 1px 2px rgba(0, 0, 0, 0.05);
--shadow-md: 0 10px 20px rgba(0, 0, 0, 0.1), 0 3px 6px rgba(0, 0, 0, 0.05);
@@ -517,13 +517,14 @@ code {
opacity: 1;
--map-card-opacity: 1;
}
/* Hover isolates the subject and its directly incident transitions. These selectors come after
diff focus so the pointer's immediate context is always the strongest signal. */
.graph-canvas .react-flow__node.graph-node-hover-related {
/* Hover never recedes anything, but where focus or a selection has already dimmed the map, the
hovered screen and the screens it connects to come back up, with the transitions between them,
so the neighbourhood reads. These come after both dimming rules so the pointer's context wins. */
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related {
opacity: 1;
--map-card-opacity: 1;
filter: none;
}
.connection-canvas-surface.canvas-hovering .react-flow__edge.graph-edge-hover-related { opacity: 1; }
/* Re-layout: the canvas blinks out whole — nodes, edges and labels together — so the graph can
change shape and the camera can cut unseen, then comes straight back. Both transitions live
inside their class, so once the sequence ends the stylesheet owns opacity again. */
@@ -555,6 +556,10 @@ code {
/* The screenshot's positioned diff frame paints after the leading handle in tree order; lift
both handles over the image while the diff label (z-index 2) still covers them. */
.screen-screenshot-slot > .react-flow__handle { z-index: 1; }
/* The tooltip anchor around the screenshot button is layout-transparent: it takes the slot's
remaining height and hands it on, and stays static so the diff label and the handles keep
anchoring to the slot (or, on Screens, the card). */
.screen-screenshot-slot > .tooltip-anchor { position: static; display: flex; width: 100%; min-height: 0; flex: 1; flex-direction: column; }
.screen-screenshot-target {
display: flex;
width: 100%;
@@ -733,27 +738,23 @@ code {
opacity: 1;
}
/* Hover is transient canvas state. One container class dims the field; only the symmetric
difference of related nodes/edges receives a class, avoiding a React commit across the graph.
The hovered screen and the screens it connects to stay as they are; the rest recede a little,
enough to read the neighbourhood without losing the map. */
.connection-canvas-surface.canvas-hovering .react-flow__node-screen {
opacity: var(--hover-recede);
--map-card-opacity: var(--hover-recede);
transition: opacity 90ms ease;
}
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related,
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-subject {
opacity: 1;
--map-card-opacity: 1;
}
.connection-canvas-surface.canvas-hovering .react-flow__edge { opacity: 0.3; }
.connection-canvas-surface.canvas-hovering .react-flow__edge.graph-edge-hover-related { opacity: 1; }
/* Hover is transient canvas state. Nothing recedes: the pointer's screen gets its ring, the
transitions into and out of it turn accent, and the screens at their other ends take a tinted
frame, so the neighbourhood reads without the rest of the map changing. Only the symmetric
difference of related nodes/edges receives a class, avoiding a React commit across the graph. */
.connection-canvas-surface.canvas-hovering .graph-edge-hover-related .transition-edge-path {
stroke: var(--accent) !important;
stroke-width: 2.2 !important;
stroke-dasharray: none !important;
}
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related:not(.graph-node-hover-subject)
.screen-screenshot-card:not(.selected, .diff-added, .diff-modified, .diff-removed) {
--screen-frame: var(--hover-neighbour-frame);
}
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related:not(.graph-node-hover-subject)
.screen-screenshot-card:not(.selected, .diff-added, .diff-modified, .diff-removed) .screen-node-image :is(img, .image-placeholder) {
border-color: var(--hover-neighbour-frame);
}
/* Semantic Map: an area is a meaningful destination, never an anonymous "X states" step. */
.semantic-summary-node {
@@ -925,10 +926,9 @@ code {
transition-duration: 0ms;
}
/* Hovering a screenshot says what a click does: it opens the screen in the Inspector. The hint
sits in the middle of the screenshot, so it is always on the image whatever the slot's shape.
With a pointer, an already selected screen is in the Inspector. On a phone's map the first tap
only selects, so the hint sits on the selected screen and says what the next tap does. */
/* The phone map's open hint. The first tap there only selects, so the pill sits in the middle of
the selected screenshot (always on the image whatever the slot's shape) and says what the next
tap does. In a wider window the card's tooltip carries the message and nothing covers the image. */
.screen-screenshot-target { cursor: pointer; }
.screen-open-hint {
position: absolute;
@@ -952,21 +952,12 @@ code {
backdrop-filter: blur(6px);
}
.screen-open-hint > svg { width: 14px; height: 14px; flex: none; }
.screen-open-hint-short { display: none; }
@media (hover: hover) and (pointer: fine) {
.screen-screenshot-card:not(.selected) .screen-screenshot-target:hover .screen-open-hint {
display: inline-flex;
animation: screen-open-hint-in 140ms ease-out;
}
}
@media (hover: none) {
.phone-layout .map-canvas .screen-screenshot-card.selected .screen-open-hint {
display: inline-flex;
animation: screen-open-hint-in 140ms ease-out;
}
/* Phone map screens are narrow, so the hint is one word there and stays on the screenshot. */
.phone-layout .map-canvas .screen-open-hint-long { display: none; }
.phone-layout .map-canvas .screen-open-hint-short { display: inline; }
/* Only the phone layout's map shows the pill, on the selected screen, where a second tap or click
opens the Inspector. That layout is a width, not a device, and has no tooltips, so a narrow
desktop window shows it too. Elsewhere the screenshot button's tooltip says it instead. */
.phone-layout .map-canvas .screen-screenshot-card.selected .screen-open-hint {
display: inline-flex;
animation: screen-open-hint-in 140ms ease-out;
}
@keyframes screen-open-hint-in { from { opacity: 0; transform: translate(-50%, -40%); } }
@media (prefers-reduced-motion: reduce) { .screen-open-hint { animation: none !important; } }
@@ -2209,6 +2200,18 @@ code {
line-height: 1.45;
}
.search-command-result-copy code { color: inherit; font-size: inherit; }
.search-command-section + .search-command-section { margin-top: 4px; }
.search-command-section > .search-command-section-label { padding: 8px 8px 4px; }
.search-command-result-key {
padding: 2px 6px;
border: 1px solid var(--border);
border-radius: 5px;
color: var(--tertiary);
font: inherit;
font-size: 11px;
line-height: 16px;
white-space: nowrap;
}
.search-command-result-kind {
padding: 2px 6px;
border: 1px solid var(--border-subtle);
@@ -2356,6 +2359,7 @@ html [data-sonner-toaster][data-sonner-theme] {
background: var(--element); color: var(--secondary); font: inherit; font-size: 12.5px; font-weight: 500; line-height: 16px; white-space: nowrap; cursor: pointer;
}
.collapsed-platform > svg { width: 9px; height: 9px; }
.collapsed-platform > .collapsed-platform-busy { width: 11px; height: 11px; animation: spin 1s linear infinite; }
.collapsed-platform:hover, .collapsed-platform[aria-expanded="true"] { color: var(--text); background: var(--hover); }
.collapsed-platform:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
+141
View File
@@ -0,0 +1,141 @@
import type { Appearance } from "./appearance";
import type { CanvasView, ThemePreference } from "./navigation";
import type { CanvasZoomCommand } from "./canvas-zoom";
import type { SearchItem } from "./search";
import { formatShortcut, SHORTCUTS, TARGET_NUMBER_KEYS } from "./shortcuts";
/** What the reader is looking at decides which commands the palette offers. */
export type CommandContext = {
canvas: CanvasView;
phone: boolean;
/** The changed screens in review order; empty without a baseline. */
changed: readonly { id: string; route: string }[];
selectedScreenId?: string | undefined;
/** The Screens page has a find field (desktop). */
find: boolean;
/** The report can be handed off to an agent (a hosted preview). */
handoff: boolean;
pullRequest?: { origin?: "local" | "compare" | undefined; number?: number | undefined; url?: string | undefined } | undefined;
theme: ThemePreference;
/** The captured appearances, when there is more than one to show. */
appearances: readonly { id: Appearance; label: string; current: boolean }[];
/** The Inspector's state where it exists (not on Compare, not on a phone). */
inspector?: { open: boolean } | undefined;
/** Full screen's state where the browser supports it. */
fullscreen?: boolean | undefined;
/** The run's other targets this page can open, with their platform and their place in the targets menu. */
targets: readonly { id: string; label: string; platform: string; place: number; noun: "device" | "platform" }[];
/** A canvas camera is on screen (Map), so fit, center and zoom apply. */
camera: boolean;
};
export type CommandActions = {
selectCanvas: (canvas: CanvasView) => void;
openFind: () => void;
openHandoff: () => void;
openShortcuts: () => void;
toggleChanges: () => void;
openChangedScreen: (id: string) => void;
setTheme: (theme: ThemePreference) => void;
chooseAppearance: (appearance: Appearance) => void;
toggleInspector: () => void;
toggleFullscreen: () => void;
switchTarget: (id: string) => void;
zoom: (command: CanvasZoomCommand) => void;
};
const THEME_TITLES: Record<ThemePreference, string> = { system: "Theme: Auto (system)", dark: "Theme: Dark", light: "Theme: Light" };
function repositoryOf(url: string | undefined): string | undefined {
return /^https:\/\/github\.com\/([^/]+\/[^/]+)\/(?:pull\/\d+|compare\/.+)$/.exec(url ?? "")?.[1];
}
function openLink(url: string): void {
window.open(url, "_blank", "noopener,noreferrer");
}
/**
* The palette's commands for one context, as search items: each names its group as context and prints the key that
* also runs it, so the list doubles as the shortcuts a reader can discover by typing.
*/
export function commandItems(context: CommandContext, actions: CommandActions): SearchItem[] {
const items: SearchItem[] = [];
const add = (id: string, group: string, title: string, run: () => void, options: { keywords?: string[]; shortcut?: string | undefined } = {}) => {
items.push({ id: `command:${id}`, kind: "command", title, keywords: options.keywords ?? [], context: group, order: items.length, run,
...(options.shortcut ? { shortcut: options.shortcut } : {}) });
};
const key = formatShortcut;
const hasChanges = context.changed.length > 0;
const selectedChange = context.changed.find((entry) => entry.id === context.selectedScreenId);
if (context.canvas !== "map") add("go:map", "Go to", "Map", () => actions.selectCanvas("map"), { keywords: ["canvas", "overview"], shortcut: key(SHORTCUTS.canvas.map) });
if (context.canvas !== "screens") add("go:screens", "Go to", "Screens", () => actions.selectCanvas("screens"), { keywords: ["inventory", "grid", "list"], shortcut: key(SHORTCUTS.canvas.screens) });
if (hasChanges && context.canvas !== "compare") add("go:compare", "Go to", "Compare", () => actions.selectCanvas("compare"), { keywords: ["review", "changes", "diff", "before", "after"], shortcut: key(SHORTCUTS.canvas.compare) });
if (context.find) add("go:find", "Go to", "Find a screen", actions.openFind, { keywords: ["filter", "screens", "search"], shortcut: "/" });
if (context.handoff) add("go:handoff", "Go to", "Hand off to AI", actions.openHandoff, { keywords: ["agent", "prompt", "claude", "codex", "copy"], shortcut: key(SHORTCUTS.app.handoff) });
if (!context.phone) add("go:shortcuts", "Go to", "Keyboard shortcuts", actions.openShortcuts, { keywords: ["keys", "help"], shortcut: "?" });
if (hasChanges && !context.phone) add("go:changes-menu", "Go to", "Changed screens menu", actions.toggleChanges, { keywords: ["changes", "list", "filter"], shortcut: key(SHORTCUTS.app.changes) });
if (hasChanges) {
// The ends stop, as Compare's arrows do; with no change selected, the steps start from either end.
const at = context.changed.findIndex((entry) => entry.id === context.selectedScreenId);
const next = context.changed[at < 0 ? 0 : at + 1];
const previous = context.changed[at < 0 ? context.changed.length - 1 : at - 1];
const compare = context.canvas === "compare";
if (next) add("changes:next", "Changes", "Next changed screen", () => actions.openChangedScreen(next.id),
{ keywords: ["change", "step", "forward"], shortcut: compare ? key(SHORTCUTS.compare.nextScreen) : undefined });
if (previous) add("changes:previous", "Changes", "Previous changed screen", () => actions.openChangedScreen(previous.id),
{ keywords: ["change", "step", "back"], shortcut: compare ? key(SHORTCUTS.compare.previousScreen) : undefined });
if (selectedChange && !compare) add("changes:open-selected", "Changes", `Open ${selectedChange.route} in Compare`, () => actions.selectCanvas("compare"), { keywords: ["selected", "review", "diff"] });
}
if (context.inspector) {
add("view:inspector", "View", context.inspector.open ? "Hide the inspector" : "Show the inspector", actions.toggleInspector,
{ keywords: ["panel", "details", "sidebar"], shortcut: key(SHORTCUTS.panel.right) });
}
for (const theme of ["system", "dark", "light"] as const) {
add(`view:theme:${theme}`, context.theme === theme ? "View · current" : "View", THEME_TITLES[theme], () => actions.setTheme(theme),
{ keywords: ["theme", "appearance", "viewer", "color", "mode"] });
}
for (const appearance of context.appearances) {
add(`view:appearance:${appearance.id}`, appearance.current ? "View · current" : "View", `App appearance: ${appearance.label}`, () => actions.chooseAppearance(appearance.id),
{ keywords: ["app", "appearance", "scheme", "captured"], shortcut: !appearance.current && context.appearances.length === 2 ? key(SHORTCUTS.appearance.app) : undefined });
}
if (context.fullscreen !== undefined) {
add("view:fullscreen", "View", context.fullscreen ? "Exit full screen" : "Enter full screen", actions.toggleFullscreen, { keywords: ["fullscreen", "window", "focus"] });
}
for (const target of context.targets) {
const numbered = TARGET_NUMBER_KEYS ? SHORTCUTS.targetByNumber[target.place] : undefined;
add(`target:${target.id}`, target.noun === "device" ? "Devices" : "Platforms", `Switch to ${target.label}`, () => actions.switchTarget(target.id),
{ keywords: [target.noun, "report", "switch", target.platform], shortcut: numbered ? key(numbered) : undefined });
}
if (context.camera) {
add("camera:fit", "Canvas", "Fit the canvas", () => actions.zoom("fit"), { keywords: ["zoom", "fit", "all"], shortcut: key(SHORTCUTS.camera.fit) });
add("camera:center", "Canvas", "Center the canvas", () => actions.zoom("recenter"), { keywords: ["zoom", "center", "recenter"], shortcut: key(SHORTCUTS.camera.center) });
add("camera:100", "Canvas", "Zoom to 100%", () => actions.zoom("100"), { keywords: ["zoom", "actual", "reset"], shortcut: key(SHORTCUTS.camera.zoom100) });
add("camera:in", "Canvas", "Zoom in", () => actions.zoom("in"), { keywords: ["zoom", "closer"], shortcut: key(SHORTCUTS.camera.zoomIn) });
add("camera:out", "Canvas", "Zoom out", () => actions.zoom("out"), { keywords: ["zoom", "away"], shortcut: key(SHORTCUTS.camera.zoomOut) });
}
const pr = context.pullRequest;
if (pr?.url) {
const url = pr.url;
const title = pr.origin === "compare" ? "Open the compare on GitHub" : pr.origin === "local" ? "Open the review on GitHub" : `Open pull request #${pr.number} on GitHub`;
add("link:pull-request", "Links", title, () => openLink(url), { keywords: ["github", "pr", "pull request", "browser"] });
const repository = repositoryOf(url);
if (repository) add("link:repository", "Links", `Open ${repository} on GitHub`, () => openLink(`https://github.com/${repository}`), { keywords: ["github", "repo", "repository", "source"] });
}
return items;
}
/** The commands the empty palette leads with: what a reader on this canvas is most likely to do next. */
export function suggestedCommands(items: readonly SearchItem[], canvas: CanvasView, limit = 6): SearchItem[] {
const priority: Record<CanvasView, string[]> = {
map: ["changes:next", "changes:open-selected", "go:compare", "camera:fit", "go:find", "go:handoff", "go:screens", "view:inspector"],
screens: ["go:find", "changes:next", "changes:open-selected", "go:compare", "go:map", "go:handoff", "view:inspector"],
compare: ["changes:next", "changes:previous", "go:map", "go:screens", "go:handoff", "go:shortcuts"],
};
return priority[canvas].flatMap((id) => items.filter((item) => item.id === `command:${id}`)).slice(0, limit);
}
+6 -4
View File
@@ -23,12 +23,14 @@ export function resolveEmbeddedArtifactUrl(reference: string, priority: Screensh
/**
* Resolve, with a release bound to the report that resolved it: for a caller that may let go after a hosted preview has
* switched to another target's report, whose screenshots it must not release.
* switched to another target's report, whose screenshots it must not release. `release` says whether there was a report
* to release to; `current` whether that report is still the one shown.
*/
export function leaseEmbeddedArtifactUrl(reference: string, priority: ScreenshotPriority = "lazy"): { url: Promise<string>; release: () => void } {
export function leaseEmbeddedArtifactUrl(reference: string, priority: ScreenshotPriority = "lazy"): { url: Promise<string>; release: () => boolean; current: () => boolean } {
const archive = activeArtifactReport;
if (!archive) return { url: resolveEmbeddedArtifactUrl(reference, priority), release: () => {} };
return { url: archive.resolve(reference, priority), release: () => archive.release(reference) };
const current = () => activeArtifactReport === archive;
if (!archive) return { url: resolveEmbeddedArtifactUrl(reference, priority), release: () => false, current };
return { url: archive.resolve(reference, priority), release: () => { archive.release(reference); return true; }, current };
}
/** Artifact screenshots release their Blob URL when no visible image or download uses it; the report keeps a few for a quick return. */
+68 -31
View File
@@ -28,13 +28,26 @@ export function holdSchedule(count: number): number[] {
return times;
}
/** One press of a held key, which a glide can outlive. */
export type KeyPress = {
/** Whether its key is still down, and nothing interrupted the hold or began a newer one. */
readonly held: boolean;
/** Whether it ended by its key going up, rather than by an interruption. */
readonly released: boolean;
/** Ends the hold, if this press still is it. */
end: () => void;
};
export type KeyHold = {
/**
* Starts holding `code` after its first step already landed. `step` takes the next step and
* says whether there was one; the hold ends by itself when there is not.
*/
begin: (code: string, step: () => boolean) => void;
begin: (code: string, step: () => boolean) => KeyPress;
/** Ends the hold as an interruption: another key, blur, a field or dialog taking the keyboard. */
end: () => void;
/** Ends the hold because `code` went up, if it is the key being held. */
release: (code: string) => void;
/**
* Ends the hold when another key goes down, as the OS's own key repeat stops. A modifier does
* not end it, so ⇧ or ⌘ can join a held key. Call it first in the listener, before any guard.
@@ -52,38 +65,48 @@ function keyboardFree(): boolean {
return !isTyping(document.activeElement) && !modalOpen();
}
// A glide moves at the stepped hold's speeds, in tap steps per second: one step per first
// interval at first, easing up to one per floor interval.
const GLIDE_START_RATE = 1000 / HOLD_FIRST_INTERVAL_MS;
const GLIDE_TOP_RATE = 1000 / HOLD_FLOOR_INTERVAL_MS;
const GLIDE_RAMP_MS = 1000;
/** A glide picks up from rest over this long, so it does not lurch out of the tap's step. */
const GLIDE_PICKUP_MS = 80;
export type GlideProfile = {
/** Tap steps per second as the key goes down. */
startRate: number;
/** Tap steps per second once the ramp is over. */
topRate: number;
rampMs: number;
};
/** How fast a glide moves `elapsed` milliseconds after it began, in tap steps per second. */
export function glideRate(elapsed: number): number {
const ramp = Math.min(1, elapsed / GLIDE_RAMP_MS);
return GLIDE_START_RATE * Math.min(1, elapsed / GLIDE_PICKUP_MS)
+ (GLIDE_TOP_RATE - GLIDE_START_RATE) * ramp * ramp * (3 - 2 * ramp);
/** The Swipe divider: a 5% step in 125ms at first, up to a width a second. */
export const DIVIDER_GLIDE: GlideProfile = { startRate: 8, topRate: 20, rampMs: 700 };
/** The canvas zoom: a 1.2x step in 167ms at first, up to about three doublings a second. */
export const ZOOM_GLIDE: GlideProfile = { startRate: 6, topRate: 12, rampMs: 700 };
/** How fast a glide moves `elapsed` milliseconds after the key went down, in tap steps per second. */
export function glideRate(elapsed: number, profile: GlideProfile): number {
const ramp = Math.min(1, Math.max(0, elapsed / profile.rampMs));
return profile.startRate + (profile.topRate - profile.startRate) * ramp * ramp * (3 - 2 * ramp);
}
/**
* For a continuous value (a zoom, a divider) a held key glides instead of stepping: from `delayMs`
* on, `move` is called every frame with how far to go, in tap steps (fractions of one), until the
* hold ends. `move` says whether it moved; at a limit it does not, and the hold ends there.
* For a continuous value (a zoom, a divider) a key glides instead of stepping, from the moment it
* goes down: `move` is called every frame with how far to go, in tap steps (fractions of one), at
* the profile's speed, while `press` is held. A tap, released before a whole step is covered, still
* completes its one step at that speed, so a tap and a hold begin as one motion; an interrupted
* press stops where it is. `move` says whether it moved; at a limit it does not, and the press's
* hold ends there.
*/
export function glideWhileHeld(hold: KeyHold, code: string, delayMs: number, move: (steps: number) => boolean): void {
const start = performance.now() + delayMs;
export function glideWhileHeld(press: KeyPress, move: (steps: number) => boolean, profile: GlideProfile): void {
const start = performance.now();
let last = start;
let covered = 0;
const frame = (now: number) => {
if (!hold.holding(code)) return;
if (now > start) {
const steps = glideRate(now - start) * (now - Math.max(last, start)) / 1000;
last = now;
if (!move(steps)) {
hold.end();
return;
}
const held = press.held;
if (!held && !(press.released && covered < 1)) return;
// A frame's timestamp can predate the key down that scheduled it.
let steps = glideRate(now - start, profile) * Math.max(0, now - last) / 1000;
last = Math.max(last, now);
if (!held) steps = Math.min(steps, 1 - covered);
covered += steps;
if (steps > 0 && !move(steps)) {
press.end();
return;
}
requestAnimationFrame(frame);
};
@@ -92,11 +115,16 @@ export function glideWhileHeld(hold: KeyHold, code: string, delayMs: number, mov
/** One held key at a time, timed on the schedule above. */
export function createKeyHold(): KeyHold {
let current: { code: string; timer: ReturnType<typeof setTimeout> } | undefined;
const end = () => {
if (current) clearTimeout(current.timer);
let current: { code: string; timer: ReturnType<typeof setTimeout>; press: { held: boolean; released: boolean } } | undefined;
const finish = (released: boolean) => {
if (current) {
clearTimeout(current.timer);
current.press.held = false;
current.press.released = released;
}
current = undefined;
};
const end = () => finish(false);
return {
begin(code, step) {
end();
@@ -105,12 +133,21 @@ export function createKeyHold(): KeyHold {
const next = holdIntervalMs(count);
// A field or a dialog took the keyboard mid-hold: end, rather than step behind it.
if (!current || !keyboardFree() || !step()) { end(); return; }
current = { code, timer: setTimeout(tick, next) };
current.timer = setTimeout(tick, next);
count += 1;
};
current = { code, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS) };
const state = { held: true, released: false };
current = { code, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS), press: state };
return {
get held() { return state.held; },
get released() { return state.released; },
end: () => { if (current?.press === state) end(); },
};
},
end,
release(code) {
if (current?.code === code) finish(true);
},
interrupt(event) {
if (current && !event.repeat && event.code !== current.code && !MODIFIER_KEYS.has(event.key)) end();
},
+4 -1
View File
@@ -69,8 +69,11 @@ export function indexMap(map: ExploreMap): MapIndex {
outgoing,
incoming,
plainTitles: map.run?.exploration === "black-box",
// Why a screen has no screenshot, in the report's words: its first open gap, else its first accepted one.
// The map keeps a screen's last entry, so the gaps are reversed and then open ones are sorted after accepted ones.
screenNotes: new Map(
(map.gaps ?? []).filter((gap) => gap.status === "open" && gap.screenId).reverse().map((gap) => [gap.screenId!, gap.message]),
(map.gaps ?? []).filter((gap) => gap.status !== "resolved" && gap.screenId)
.reverse().sort((a, b) => Number(a.status === "open") - Number(b.status === "open")).map((gap) => [gap.screenId!, gap.message]),
),
};
}
+61 -11
View File
@@ -2,7 +2,7 @@ import type { EmbeddedReport } from "../../../src/contracts/standalone-report";
import {
ARTIFACT_LIMITS, ArtifactReportArchive, artifactIdentity, isReportPage, isReportTargetId, openCachedReport, openReportFile, previewAssetUrl,
previewManifestUrl, previewReportsUrl, previewToken, reportDownloadUrl, reportFileName, reportTarget, ReportFileError,
showArchive, workflowRunUrl, type ArtifactIdentity, type ArtifactLoadProgress, type ReportFileErrorCode,
showArchive, targetQuery, workflowRunUrl, type ArtifactIdentity, type ArtifactLoadProgress, type ReportFileErrorCode,
} from "./artifact-report";
export type ReportSourceStatus = "checking-cache" | "downloading" | "awaiting-file" | "opening" | "ready" | "failed";
@@ -14,8 +14,12 @@ export type ReportSourceSnapshot = {
error?: string;
errorCode?: ReportFileErrorCode;
fileName?: string;
/** Counts the reports this page has shown; a hosted preview switching targets starts a fresh Viewer per report. */
/** Counts the reports this page has shown; the Viewer reloads its report in place when it changes. */
reportKey: number;
/** A hosted preview downloading another target while the report on screen stays: the pill shows the download. */
switching?: { target: string; progress: ArtifactLoadProgress };
/** The last switch whose download failed, while the report on screen stayed: the pill toasts why. */
switchError?: { target: string; error: string };
};
/** The metadata the ZIP path accepts, plus room for the manifest's list of assets and their sizes. */
@@ -47,6 +51,8 @@ export class ReportSource {
/** Everyone waiting on a download hears its progress: a switch can join one the prefetch started. */
private readonly loadingProgress = new Map<string, Set<(progress: ArtifactLoadProgress) => void>>();
private current: string | undefined;
/** The link to the report on screen while another target downloads, for a switch that fails to go back to. */
private returnUrl: string | undefined;
private generation = 0;
private prefetched = false;
@@ -96,7 +102,18 @@ export class ReportSource {
for (const listener of this.listeners) listener();
}
private progressed = (progress: ArtifactLoadProgress): void => { this.set({ ...this.snapshot, progress }); };
private progressed = (progress: ArtifactLoadProgress): void => {
const { switching } = this.snapshot;
this.set(switching ? { ...this.snapshot, switching: { ...switching, progress } } : { ...this.snapshot, progress });
};
/** The snapshot without a switch in progress, or one that failed. */
private settled(): ReportSourceSnapshot {
const { switching, switchError, ...snapshot } = this.snapshot;
void switching;
void switchError;
return snapshot;
}
/** Reopen the copy this browser kept of the linked report; otherwise wait for the file. */
load(): Promise<void> {
@@ -119,8 +136,9 @@ export class ReportSource {
*/
switchTarget(target: string, url: string): boolean {
if (!this.preview || typeof window === "undefined") return false;
const from = window.location.href;
window.history.pushState(null, "", url);
this.activateTarget(target);
this.activateTarget(target, from);
return true;
}
@@ -130,23 +148,34 @@ export class ReportSource {
this.activateTarget(target);
};
private activateTarget(target: string | undefined): void {
private activateTarget(target: string | undefined, from?: string): void {
const key = target ?? "";
const archive = this.archives.get(key);
// Already shown (a hash-only navigation); going back to it from a switch still loading or failed shows it again.
if (this.snapshot.status === "ready" && this.current !== undefined && archive && archive === this.archives.get(this.current)) {
this.current = key;
// Back during a switch: the download it started is no longer wanted on screen.
if (this.snapshot.switching) {
this.generation += 1;
this.pending = undefined;
this.set(this.settled());
}
return;
}
const generation = ++this.generation;
this.pending = undefined;
if (archive) {
this.set({ ...this.snapshot, reportKey: this.snapshot.reportKey + 1 });
this.adopt(key, archive);
return;
}
this.data = undefined;
this.set({ status: "downloading", progress: { phase: "downloading" }, reportKey: this.snapshot.reportKey + 1 });
// The report on screen stays up while the other target downloads; only a page with none yet shows the loading screen.
if (this.snapshot.status === "ready" && this.data) {
this.returnUrl = from;
this.set({ ...this.settled(), switching: { target: key, progress: { phase: "downloading" } } });
} else {
this.data = undefined;
this.set({ status: "downloading", progress: { phase: "downloading" }, reportKey: this.snapshot.reportKey });
}
this.pending = this.show(target, generation).finally(() => { if (generation === this.generation) this.pending = undefined; });
}
@@ -160,18 +189,39 @@ export class ReportSource {
this.adopt(key, archive);
} catch (error) {
if (generation !== this.generation) return;
this.set({ ...this.snapshot, status: "failed",
error: error instanceof Error && error.message ? error.message : "The report could not be downloaded.",
const message = error instanceof Error && error.message ? error.message : "The report could not be downloaded.";
// A switch away from a report on screen keeps it there: the link goes back to it, and the pill toasts why.
if (this.snapshot.switching && this.data) {
window.history.replaceState(null, "", this.returnUrl ?? this.shownLink());
this.returnUrl = undefined;
this.set({ ...this.settled(), switchError: { target: key, error: message } });
return;
}
this.set({ ...this.settled(), status: "failed", error: message,
errorCode: error instanceof ReportFileError ? error.code : "invalid" });
}
}
/** This page's link with the target of the report on screen: for a Back or Forward onto a target that failed. */
private shownLink(): string {
const url = new URL(window.location.href);
url.searchParams.delete("platform");
url.searchParams.delete("target");
if (this.current) {
const [name, value] = targetQuery(this.current).split("=") as [string, string];
url.searchParams.set(name, value);
}
return url.href;
}
private adopt(key: string, archive: ArtifactReportArchive): void {
this.remember(key, archive);
showArchive(archive);
const shown = this.data === archive.data;
this.data = archive.data;
this.current = key;
this.set({ ...this.snapshot, status: "ready", identity: archive.identity });
const snapshot = this.settled();
this.set({ ...snapshot, status: "ready", identity: archive.identity, reportKey: shown ? snapshot.reportKey : snapshot.reportKey + 1 });
this.schedulePrefetch();
}
+14 -3
View File
@@ -1,7 +1,7 @@
import type { Screen } from "../../../src/types";
import { displayPathForScreen } from "./screen-path";
export type SearchItemKind = "screen";
export type SearchItemKind = "screen" | "command";
export type SearchItem = {
id: string;
@@ -12,13 +12,19 @@ export type SearchItem = {
order: number;
route?: string;
screenId?: string;
/** Commands: the key that also runs it, printed, and what it does. */
shortcut?: string;
run?: () => void;
};
export type SearchSuggestionContext = {
screenId?: string;
};
const KIND_ORDER: Record<SearchItemKind, number> = { screen: 0 };
/** Route-shaped queries ("/settings", "settings/profile") are after a screen; words ("dark", "fit") are after a command. */
function preferredKind(query: string): SearchItemKind {
return query.includes("/") ? "screen" : "command";
}
export function normalizeSearchText(value: string): string {
return value.trim().toLocaleLowerCase().replace(/\s+/g, " ");
@@ -26,10 +32,13 @@ export function normalizeSearchText(value: string): string {
function resultScore(item: SearchItem, query: string): number | undefined {
const title = normalizeSearchText(item.title);
// A word that is a screen's last segment ("theme" for /settings/theme) names that screen, ahead of any command.
if (item.kind === "screen" && title.split("/").filter(Boolean).pop() === query) return -1;
if (title === query) return 0;
if (title.startsWith(query)) return 1;
if (title.split(/[^\p{L}\p{N}]+/u).some((word) => word.startsWith(query))) return 2;
if (title.includes(query)) return 3;
if (item.keywords.some((keyword) => normalizeSearchText(keyword).includes(query))) return 4;
if (item.route && normalizeSearchText(item.route).includes(query)) return 4;
return undefined;
}
@@ -41,6 +50,8 @@ export function searchItems(
): SearchItem[] {
const query = normalizeSearchText(rawQuery);
if (!query || limit <= 0) return [];
const preferred = preferredKind(query);
const kindOrder = (item: SearchItem) => (item.kind === preferred ? 0 : 1);
return items
.flatMap((item) => {
const score = resultScore(item, query);
@@ -48,7 +59,7 @@ export function searchItems(
})
.sort((left, right) => (
left.score - right.score
|| KIND_ORDER[left.item.kind] - KIND_ORDER[right.item.kind]
|| kindOrder(left.item) - kindOrder(right.item)
|| left.item.order - right.item.order
|| left.item.title.localeCompare(right.item.title)
|| left.item.id.localeCompare(right.item.id)