Compare commits

..
Author SHA1 Message Date
Brent Vatne c99c26f9bb Release 0.20.0-next.0; prereleases publish under the next tag (#36) 2026-10-18 22:09:03 -07:00
Brent Vatne 9150a24cd9 Map: ring the selected screen instead of fading the rest; Return opens the screen the arrows reached (#35) 2026-10-18 22:05:21 -07:00
devin-ai-integration[bot]andbrent 2c5f8f85a3 Compare: outline changed areas on After only, linked to Before on hover (#33)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 21:52:45 -07:00
devin-ai-integration[bot]andBrent Vatne 23227ca55c capture.maxSessions: a review-wide session ceiling, spent on separate light/dark sessions when that pays (#32)
Co-authored-by: Brent Vatne <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 21:42:28 -07:00
devin-ai-integration[bot]andBrent Vatne ed1bf34434 Faster capture: parallel compare with early-abort region search, one Argent bridge thread per capture (#29)
Co-authored-by: Brent Vatne <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 21:29:58 -07:00
Brent Vatne bdf9e597d3 Large moves read as one moved region instead of fragments (#18) 2026-10-18 17:03:07 -07:00
devin-ai-integration[bot]andbrent 9063de5c52 Inspector: stack Before over After for landscape screenshots (#24)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:55:35 -07:00
devin-ai-integration[bot]andbrent 21ed8c06f6 Text that differs between a build's own light and dark captures is runtime state, not a change (#28)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:49:03 -07:00
devin-ai-integration[bot]andbrent 6795f19d04 Viewer: ⌘K is a command palette (#22)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:47:31 -07:00
devin-ai-integration[bot]andbrent 990e2ecc8d Ignore a foldable's rail status-bar pill like a phone's status bar (#23)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:44:10 -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
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
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
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
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
122 changed files with 6174 additions and 1319 deletions

No files matched your search

+7 -1
View File
@@ -61,7 +61,13 @@ jobs:
env:
# npm cannot generate provenance for a private repository.
NPM_CONFIG_PROVENANCE: "false"
run: npm publish --access public
VERSION: ${{ steps.version.outputs.version }}
shell: bash
# A prerelease (0.20.0-next.0) goes to the next tag, so latest keeps the last release.
run: |
set -euo pipefail
if [[ "$VERSION" == *-* ]]; then tag=next; else tag=latest; fi
npm publish --access public --tag "$tag"
- name: Tag the release
if: steps.version.outputs.publish == 'true'
env:
+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"
+2 -2
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>
@@ -580,7 +580,7 @@ npm test
- `npm test` rebuilds the CLI and the Viewer first, because the node tests run the compiled `dist/`. After one `npm run build`, `npm run test:node` skips the rebuild.
- The agent runtimes and `eas-cli` are optional dependencies that only capture needs. Do not install with `--omit=optional`, which also drops esbuild's platform package.
- To release, bump `version` in `package.json` and merge to main. The [publish workflow](.github/workflows/publish.yml) publishes any version npm does not have yet.
- To release, bump `version` in `package.json` and merge to main. The [publish workflow](.github/workflows/publish.yml) publishes any version npm does not have yet. A prerelease version such as `0.20.0-next.0` goes to the `next` tag, so `latest` stays on the last release.
```sh
npx playwright install chromium
+7 -3
View File
@@ -157,6 +157,10 @@ runs:
EXPO_TOKEN: ${{ inputs.expo_token }}
run: |
set -euo pipefail
if [[ ! -e "$OUTPUT/head-session" && ! -L "$OUTPUT/head-session" && ! -e "$OUTPUT/base-session" && ! -L "$OUTPUT/base-session" ]]; then exit 0; fi
node "$TOOLS/scripts/cleanup-ci-sessions.mjs" --eas "$TOOLS/node_modules/.bin/eas" \
--session-file "$OUTPUT/head-session" --session-file "$OUTPUT/base-session"
# A side that captures an appearance in a session of its own records it as <side>-session-<scheme>.
files=()
for name in head-session base-session head-session-light head-session-dark base-session-light base-session-dark; do
if [[ -e "$OUTPUT/$name" || -L "$OUTPUT/$name" ]]; then files+=(--session-file "$OUTPUT/$name"); fi
done
if (( ${#files[@]} == 0 )); then exit 0; fi
node "$TOOLS/scripts/cleanup-ci-sessions.mjs" --eas "$TOOLS/node_modules/.bin/eas" "${files[@]}"
+3 -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.
@@ -103,6 +103,8 @@ exploration:
capture:
maxMinutes: 30
maxActions: 500
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
repack: eas # eas (hosted workflow job; the default on EAS Simulator) | local (repack-app on the runner; the default with simulator: local)
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
+5 -3
View File
@@ -109,6 +109,8 @@ capture:
# simulator: eas # eas (EAS Simulator, default) | local (a simulator or emulator Explore starts on this machine with Xcode or the Android SDK; --simulator overrides it for one run)
maxMinutes: 30
maxActions: 500
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
repack: eas # eas (hosted EAS workflow job, the default on EAS Simulator) | local (repack-app on the runner, the default with simulator: local; --repack overrides it for one run)
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
@@ -215,13 +217,13 @@ 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.
### Stable captures (optional)
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. When both builds capture light and dark, text that differs between each build's own two captures (a clock, a relative date, a random name) is reported as runtime state, never as the change that makes a screen Modified; text that only follows the appearance, or a word beside it that changed, is still a change. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
### Agent usage and reuse
@@ -360,7 +362,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.20.0-next.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.19.7",
"version": "0.20.0-next.0",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.19.7",
"version": "0.20.0-next.0",
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
"license": "MIT",
"type": "module",
@@ -50,7 +50,7 @@
"test:node": "node --test test/node/*.test.mjs",
"test:hosting": "npm --prefix viewer-host run typecheck && npm --prefix viewer-host test",
"test:viewer:artifacts": "node --test test/browser/artifact-report.browser.mjs test/browser/artifact-cache.browser.mjs",
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/swipe-outlines.browser.mjs test/browser/split-outlines.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
"test:viewer:e2e": "npm run test:viewer:browser && playwright test",
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p viewer/tsconfig.json --noEmit",
"lint": "eslint .",
+2 -1
View File
@@ -10,7 +10,8 @@ const SESSION_ID = /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/;
/** Stop only exact sessions whose ownership the capture coordinator already verified. */
export async function cleanupCiSessions({ sessionFiles, easCommand, environment = process.env, runCommand = spawnSync }) {
if (!Array.isArray(sessionFiles) || sessionFiles.length > 3) throw new Error('Provide at most three explicit session handoff files.');
// head, base and baseline, each with a session per appearance pass (light, dark) beside its own.
if (!Array.isArray(sessionFiles) || sessionFiles.length > 9) throw new Error('Provide at most nine explicit session handoff files.');
const temporary = await realpath(environment.RUNNER_TEMP || tmpdir());
const result = { stopped: [], failures: [] };
let project;
+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."
+99
View File
@@ -0,0 +1,99 @@
/**
* Runs the Argent bridge's commands on a worker thread of this process, through a synchronous runner, so the
* capture's command-at-a-time control flow keeps one bridge and one tool-server connection for the whole run
* instead of starting a process per command. Commands for any other executable go to the fallback runner.
*/
import { Worker } from "node:worker_threads";
import { commandOutcome } from "./controller.js";
import type { CommandRequest, CommandResult, CommandRunner } from "./run.js";
import { BRIDGE_HEADER_BYTES, BRIDGE_KIND_UNAVAILABLE, BRIDGE_SLOT_KIND, BRIDGE_SLOT_LENGTH, BRIDGE_SLOT_READY, type BridgeRequest, type BridgeWorkerData } from "./argent-bridge-worker.js";
/** Room for one answer: an accessibility tree of a large screen is a few megabytes. */
const BRIDGE_BUFFER_BYTES = 64 * 1024 * 1024;
/** How long a command gets when its request names no timeout. */
const DEFAULT_COMMAND_TIMEOUT_MS = 10 * 60_000;
/** After a timeout, how long the thread gets to confirm it dropped the command. */
const ABORT_GRACE_MS = 15_000;
export type ArgentBridgeRunner = {
runner: CommandRunner;
/** Whether commands still go to the thread (false after it proved unavailable or stopped answering). */
readonly active: boolean;
close(): void;
};
export function startArgentBridgeRunner(options: {
/** The bridge executable the callers name; its commands run on the thread. */
command: string;
/** The bridge's environment, as argentControllerInvocation builds it. */
environment: NodeJS.ProcessEnv;
fallback: CommandRunner;
/** Tests: a module exporting `createArgentClient` in place of the pinned Argent release's client. */
clientModule?: string;
progress?: (message: string) => void;
}): ArgentBridgeRunner {
const shared = new SharedArrayBuffer(BRIDGE_HEADER_BYTES + BRIDGE_BUFFER_BYTES);
const header = new Int32Array(shared, 0, BRIDGE_HEADER_BYTES / 4);
const bytes = new Uint8Array(shared, BRIDGE_HEADER_BYTES);
const workerData: BridgeWorkerData = { shared, ...(options.clientModule ? { clientModule: options.clientModule } : {}) };
let worker: Worker | undefined;
// The environment the thread runs with: a copy, so a caller that changes the session's (a restarted local
// tool-server's URL and token) is seen by the next command, which starts a thread with the new one.
let environment: NodeJS.ProcessEnv = {};
const start = (from: NodeJS.ProcessEnv) => {
environment = { ...from };
try {
const started = new Worker(new URL("./argent-bridge-worker.js", import.meta.url), { workerData, env: environment });
// A thread that crashes stops serving; the commands after it run per command.
started.on("error", error => { if (worker === started) stop(`the Argent bridge thread failed (${error.message}); running the bridge per command`); });
worker = started;
} catch (error) { options.progress?.(`the Argent bridge thread could not start (${(error as Error).message}); running the bridge per command`); }
};
let sequence = 0;
const stop = (reason: string) => {
if (!worker) return;
options.progress?.(reason);
void worker.terminate();
worker = undefined;
};
const changed = (next: NodeJS.ProcessEnv) => {
const keys = new Set([...Object.keys(environment), ...Object.keys(next)]);
return [...keys].some(key => environment[key] !== next[key]);
};
const waitFor = (id: number, timeoutMs: number): boolean => {
const deadline = Date.now() + timeoutMs;
for (;;) {
// The value waited on is the one just compared: an answer stored after the comparison wakes the wait at once.
const ready = Atomics.load(header, BRIDGE_SLOT_READY);
if (ready === id) return true;
const remaining = deadline - Date.now();
if (remaining <= 0) return false;
Atomics.wait(header, BRIDGE_SLOT_READY, ready, remaining);
}
};
start(options.environment);
const runner: CommandRunner = (request: CommandRequest): CommandResult => {
// A recording runs per command, in the session's own directory: Argent's client saves one under the project its
// working directory is in, and this thread's is the caller's checkout. The state file carries it between hosts.
if (!worker || request.command !== options.command || request.args[0] === "record") return options.fallback(request);
if (changed(request.environment)) { void worker.terminate(); worker = undefined; start(request.environment); }
if (!worker) return options.fallback(request);
const id = ++sequence;
Atomics.store(header, BRIDGE_SLOT_READY, 0);
worker.postMessage({ id, argv: request.args, ...(request.timeoutMs !== undefined ? { timeoutMs: request.timeoutMs } : {}) } satisfies BridgeRequest);
const timeoutMs = request.timeoutMs ?? DEFAULT_COMMAND_TIMEOUT_MS;
if (!waitFor(id, timeoutMs)) {
worker.postMessage({ abort: id } satisfies BridgeRequest);
if (!waitFor(id, ABORT_GRACE_MS)) stop("the Argent bridge thread stopped answering; running the bridge per command");
throw Object.assign(new Error(`${request.command} ${request.args[0] ?? ""} timed out after ${timeoutMs} ms`), { code: "ETIMEDOUT" });
}
const text = Buffer.from(bytes.subarray(0, Atomics.load(header, BRIDGE_SLOT_LENGTH))).toString("utf8");
if (Atomics.load(header, BRIDGE_SLOT_KIND) === BRIDGE_KIND_UNAVAILABLE) {
stop(`the Argent bridge thread is unavailable (${text}); running the bridge per command`);
return options.fallback(request);
}
const result = JSON.parse(text) as { exitCode: number; stdout: string };
return commandOutcome(request, { status: result.exitCode, stdout: result.stdout, stderr: "" });
};
return { runner, get active() { return worker !== undefined; }, close: () => { if (worker) { void worker.terminate(); worker = undefined; } } };
}
+144
View File
@@ -0,0 +1,144 @@
/**
* The Argent bridge on a worker thread: one bridge and one tool-server connection for a whole capture, instead of a
* process (and a TLS handshake) per command. The capture thread posts a command and blocks on the shared buffer;
* this thread runs it through Argent's own client library (the code `argent run` uses) and writes the answer back.
*/
import { isMainThread, parentPort, workerData } from "node:worker_threads";
import { copyFile, mkdir, open, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path";
import { pathToFileURL } from "node:url";
import { ArgentCallError, type ArgentCall } from "./argent-driver.js";
import { argentBridgeSettings, createArgentBridge, type ArgentBridge } from "./argent-bridge.js";
import { ensureController } from "../shared/controller-cache.js";
/** The shared buffer: four Int32 header slots, then the UTF-8 answer. */
export const BRIDGE_HEADER_BYTES = 16;
export const BRIDGE_SLOT_READY = 0;
export const BRIDGE_SLOT_LENGTH = 1;
export const BRIDGE_SLOT_KIND = 2;
export const BRIDGE_KIND_RESULT = 0;
/** The bridge cannot run on this thread (Argent's client did not load); the host falls back to the process bridge. */
export const BRIDGE_KIND_UNAVAILABLE = 1;
export type BridgeWorkerData = { shared: SharedArrayBuffer; clientModule?: string };
export type BridgeRequest = { id: number; argv: readonly string[]; timeoutMs?: number } | { abort: number };
const ARGENT_CALL_TIMEOUT_MS = 180_000;
/** Argent's programmatic client, as `dist/client.js` of the pinned release exports it. */
type ArgentClient = { callTool(name: string, args: Record<string, unknown>, options?: { signal?: AbortSignal }): Promise<{ data: unknown; note?: string }> };
/** Whether some bytes begin as a PNG or a JPEG does: `--out` is a screenshot, and nothing else is taken for one. */
function isImage(head: Uint8Array): boolean {
const png = [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a], jpeg = [0xff, 0xd8, 0xff];
return [png, jpeg].some(signature => signature.every((byte, index) => head[index] === byte));
}
/** Whether a path names a file that is an image by its content. */
async function imageFile(path: string): Promise<boolean> {
const file = await open(path, "r").catch(() => undefined);
if (!file) return false;
try {
if (!(await file.stat()).isFile()) return false;
const head = new Uint8Array(8);
const { bytesRead } = await file.read(head, 0, head.length, 0);
return isImage(head.subarray(0, bytesRead));
} finally { await file.close(); }
}
/** The first string in a tool's answer that names an image file: the materialized screenshot (`path` first). */
async function materializedFile(data: unknown): Promise<string | undefined> {
const candidates: string[] = [];
const walk = (value: unknown, key?: string) => {
if (typeof value === "string") { if (key === "path") candidates.unshift(value); else candidates.push(value); }
else if (Array.isArray(value)) value.forEach(item => walk(item));
else if (value && typeof value === "object") Object.entries(value).forEach(([k, v]) => walk(v, k));
};
walk(data);
for (const candidate of candidates) {
if (candidate.startsWith("/") && await imageFile(candidate)) return candidate;
}
return undefined;
}
async function loadClient(environment: NodeJS.ProcessEnv, clientModule?: string): Promise<ArgentClient> {
const module = clientModule ?? join(dirname(await ensureController("argent", { environment })), "client.js");
const loaded = await import(pathToFileURL(module).href) as { createArgentClient?: () => ArgentClient };
if (typeof loaded.createArgentClient !== "function") throw new Error(`${module} does not export createArgentClient`);
return loaded.createArgentClient();
}
/** The in-thread Argent call: the client's `callTool`, with `--out` served from the artifact it materialized. */
export function argentClientCall(client: ArgentClient, signal: () => AbortSignal): ArgentCall {
return async (tool, args, options) => {
const active = signal();
if (active.aborted) throw new ArgentCallError(`argent run ${tool} was not sent: the command was given up.`, false);
let answer: { data: unknown };
try { answer = await client.callTool(tool, args, { signal: AbortSignal.any([active, AbortSignal.timeout(ARGENT_CALL_TIMEOUT_MS)]) }); }
catch (error) { throw new ArgentCallError(`argent run ${tool} failed: ${(error instanceof Error ? error.message : String(error)).slice(0, 800)}`, true); }
if (!options?.out) return answer.data;
const file = await materializedFile(answer.data);
if (!file) {
const url = (answer.data as { url?: unknown } | null)?.url;
if (typeof url !== "string") throw new ArgentCallError(`argent run ${tool} did not write ${options.out}`, true);
const response = await fetch(url, { signal: signal() });
if (!response.ok) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}: ${response.status}`, true);
const body = Buffer.from(await response.arrayBuffer());
if (!isImage(body)) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}: the answer is not an image`, true);
await mkdir(dirname(options.out), { recursive: true });
await writeFile(options.out, body);
return { path: options.out };
}
await mkdir(dirname(options.out), { recursive: true });
if (file !== options.out) await copyFile(file, options.out);
return { path: options.out };
};
}
if (!isMainThread && parentPort && (workerData as Partial<BridgeWorkerData> | null)?.shared instanceof SharedArrayBuffer) {
const port = parentPort;
const { shared, clientModule } = workerData as BridgeWorkerData;
const header = new Int32Array(shared, 0, BRIDGE_HEADER_BYTES / 4);
const bytes = new Uint8Array(shared, BRIDGE_HEADER_BYTES);
const answer = (id: number, kind: number, text: string) => {
let encoded = Buffer.from(text, "utf8");
if (encoded.length > bytes.length) {
encoded = Buffer.from(JSON.stringify({ exitCode: 1, stdout: JSON.stringify({ success: false,
error: { code: "COMMAND_FAILED", message: `The controller's answer (${encoded.length} bytes) exceeds the bridge buffer.` } }) }));
}
bytes.set(encoded);
Atomics.store(header, BRIDGE_SLOT_LENGTH, encoded.length);
Atomics.store(header, BRIDGE_SLOT_KIND, kind);
Atomics.store(header, BRIDGE_SLOT_READY, id);
Atomics.notify(header, BRIDGE_SLOT_READY);
};
const controllers = new Map<number, AbortController>();
let current: AbortController | undefined;
const settings = argentBridgeSettings(process.env);
const bridge: Promise<ArgentBridge> = settings && settings.toolsUrl
? loadClient(process.env, clientModule).then(client => createArgentBridge(settings, argentClientCall(client, () => current?.signal ?? new AbortController().signal), "thread"))
: Promise.reject(new Error("The Argent bridge needs EXPLORE_ARGENT_STATE, EXPLORE_ARGENT_PLATFORM and ARGENT_TOOLS_URL."));
bridge.catch(() => undefined);
let queue: Promise<unknown> = Promise.resolve();
port.on("message", (request: BridgeRequest) => {
if ("abort" in request) { controllers.get(request.abort)?.abort(new Error("The capture gave up waiting for this command.")); return; }
const controller = new AbortController();
controllers.set(request.id, controller);
queue = queue.then(async () => {
current = controller;
try {
const ready = await bridge.catch(error => { throw Object.assign(error as Error, { unavailable: true }); });
if (controller.signal.aborted) throw controller.signal.reason;
const result = await ready.run(request.argv);
answer(request.id, BRIDGE_KIND_RESULT, JSON.stringify(result));
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
if ((error as { unavailable?: boolean }).unavailable) answer(request.id, BRIDGE_KIND_UNAVAILABLE, message);
else answer(request.id, BRIDGE_KIND_RESULT, JSON.stringify({ exitCode: 1, stdout: JSON.stringify({ success: false, error: { code: "COMMAND_FAILED", message } }) }));
} finally {
controllers.delete(request.id);
current = undefined;
}
});
});
}
+137
View File
@@ -0,0 +1,137 @@
/**
* The Argent bridge behind both of its hosts: the command-line worker Explore spawns per command, and the
* in-process worker thread that keeps one bridge (and one tool-server connection) for a whole capture. Each command
* reads the shared state file, runs through `runBridgeCommand`, and writes the state back, so the two hosts can
* take turns on one session.
*/
import { spawnSync } from "node:child_process";
import { appendFile, copyFile, mkdir, readFile, realpath, rename, rm, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path";
import { createRequire } from "node:module";
import type { DecodedFrame } from "../shared/png-evidence.js";
import { runBridgeCommand, type ArgentBridgeState, type ArgentCall, type ArgentPlatform, type ArgentTree, type BridgeResult } from "./argent-driver.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
export type ArgentBridgeSettings = {
environment: NodeJS.ProcessEnv;
statePath: string;
platform: ArgentPlatform;
toolsUrl: string | undefined;
};
/** Reads the settings the bridge takes from its environment; absent when they are incomplete. */
export function argentBridgeSettings(environment: NodeJS.ProcessEnv): ArgentBridgeSettings | undefined {
const statePath = environment.EXPLORE_ARGENT_STATE;
const platform = environment.EXPLORE_ARGENT_PLATFORM;
if (!statePath || (platform !== "ios" && platform !== "android")) return undefined;
return { environment, statePath, platform, toolsUrl: environment.ARGENT_TOOLS_URL };
}
async function readState(path: string): Promise<ArgentBridgeState> {
try { return JSON.parse(await readFile(path, "utf8")) as ArgentBridgeState; }
catch { return { generation: 0 }; }
}
/** Written whole and renamed into place, so a command stopped mid-write never leaves a torn state. */
async function writeState(path: string, state: ArgentBridgeState): Promise<void> {
const temporary = `${path}.${process.pid}.tmp`;
await writeFile(temporary, JSON.stringify(state), { mode: 0o600 });
await rename(temporary, path);
}
/** A call's arguments for the debug log: text that could be typed into a field is logged by length only. */
function loggedArgs(args: Record<string, unknown>): Record<string, unknown> {
return Object.fromEntries(Object.entries(args).map(([key, value]) => key === "text" && typeof value === "string" ? [key, `<${value.length} characters>`]
: key === "steps" && Array.isArray(value) ? [key, `<${value.length} steps>`] : [key, value]));
}
/** What a call answered, for the debug log: a tree's shape, not its contents. */
function summarize(tool: string, value: unknown): unknown {
if (!value || typeof value !== "object") return value;
if (tool !== "ui-tree") return Object.keys(value);
const tree = value as ArgentTree;
let nodes = 0;
const walk = (node: { children?: unknown[] }) => { nodes++; (node.children ?? []).forEach(child => walk(child as { children?: unknown[] })); };
(tree.roots ?? []).forEach(walk);
return { foregroundApp: tree.foregroundApp, alertVisible: tree.alertVisible, keyboardVisible: tree.keyboardVisible, truncated: tree.truncated,
screen: tree.screen, nodes, roots: (tree.roots ?? []).map(root => [root.type ?? null, root.bundleId ?? null, (root.children ?? []).length]) };
}
export type ArgentBridge = {
/** Runs one agent-device-shaped command against the session. */
run(argv: readonly string[]): Promise<BridgeResult>;
};
/**
* One bridge over the given Argent call. `host` names the process running it in the debug log.
*/
export function createArgentBridge(settings: ArgentBridgeSettings, call: ArgentCall, host: "process" | "thread"): ArgentBridge {
const { environment, statePath, platform, toolsUrl } = settings;
const logPath = environment.EXPLORE_ARGENT_LOG_DIR
? join(environment.EXPLORE_ARGENT_LOG_DIR, `argent-${platform}-${environment.EXPLORE_ARGENT_LOG_NAME ?? "bridge"}.jsonl`) : undefined;
return {
async run(argv) {
// EXPLORE_ARGENT_LOG_DIR (opt-in): every Argent call this bridge makes, how long it took, and the shape of what it read.
const log = async (entry: Record<string, unknown>) => {
if (!logPath) return;
await appendFile(logPath, `${JSON.stringify({ at: new Date().toISOString(), host, command: argv[0], ...entry })}\n`, { mode: 0o600 }).catch(() => undefined);
};
const state = await readState(statePath);
const result = await runBridgeCommand(argv, {
state, platform, version: ARGENT_VERSION,
...(environment.EXPLORE_ARGENT_BUNDLE_ID ? { bundleId: environment.EXPLORE_ARGENT_BUNDLE_ID } : {}),
...(environment.EXPLORE_ARGENT_DEVICE ? { device: environment.EXPLORE_ARGENT_DEVICE } : {}),
// An opened foldable's inner panel shows its UI in landscape (Argent's fold: "Unfolded, the UI is landscape").
...(platform === "ios" && ["open", "half-open"].includes(environment.EXPLORE_ARGENT_POSE ?? "") ? { landscape: true } : {}),
call: async (tool, args, options) => {
const started = Date.now();
try {
const value = await call(tool, args, options);
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, summary: summarize(tool, value) });
return value;
} catch (error) {
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, error: (error instanceof Error ? error.message : String(error)).slice(0, 400) });
throw error;
}
},
reachable: async () => {
let ok = false;
try {
const token = environment.ARGENT_AUTH_TOKEN;
// The same URL Argent's own client checks: ARGENT_TOOLS_URL may carry a path, which /tools is appended to.
const response = await fetch(`${(toolsUrl ?? "").replace(/\/+$/, "")}/tools`, { headers: token ? { authorization: `Bearer ${token}` } : {}, signal: AbortSignal.timeout(5_000) });
await response.body?.cancel();
ok = response.status < 500;
} catch { ok = false; }
if (!ok) await log({ tool: "reachable", ok });
return ok;
},
sleep: milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds)),
orientVideo: async path => {
const probed = spawnSync("ffprobe", ["-v", "error", "-select_streams", "v:0", "-show_entries", "stream=width,height", "-of", "csv=p=0:s=x", path], { encoding: "utf8", timeout: 30_000 });
const [width, height] = (probed.stdout ?? "").trim().split("x").map(Number);
if (probed.status !== 0 || !width || !height || width >= height) return;
const turned = `${path}.upright.mp4`;
const ffmpeg = spawnSync("ffmpeg", ["-nostdin", "-y", "-loglevel", "error", "-i", path, "-vf", "transpose=clock", "-an", turned], { encoding: "utf8", timeout: 120_000 });
if (ffmpeg.status === 0) await rename(turned, path);
else await rm(turned, { force: true });
},
scratchImage: { path: join(dirname(statePath), "argent-scratch.png"), read: async path => {
const { PNG } = createRequire(import.meta.url)("pngjs") as { PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
return PNG.sync.read(await readFile(path), { checkCRC: false });
} },
moveFile: async (from, to) => {
const source = await realpath(from);
const roots = await Promise.all([environment.HOME, process.cwd()].filter((root): root is string => !!root).map(root => realpath(root).catch(() => root)));
if (!roots.some(root => source.startsWith(`${root}/`))) throw new Error(`Argent returned a recording outside its own directories: ${from}`);
await mkdir(dirname(to), { recursive: true });
try { await rename(from, to); }
catch { await copyFile(from, to); await rm(from, { force: true }); }
},
});
await writeState(statePath, state);
await log({ result: result.exitCode === 0 ? "ok" : result.stdout.slice(0, 300) });
return result;
},
};
}
+9 -106
View File
@@ -2,71 +2,30 @@
* The Argent controller's command line: Explore runs it where it would run agent-device, with the same
* arguments. Each command becomes `argent run <tool> --args <json>` calls, as EAS Simulator recommends
* driving an `argent` session, with the session's ARGENT_TOOLS_URL and ARGENT_AUTH_TOKEN in the environment.
* A capture keeps the same bridge on a worker thread instead (argent-bridge-host); this entry serves the callers
* that run one command at a time.
*/
import { spawnSync } from "node:child_process";
import { appendFile, copyFile, mkdir, readFile, realpath, rename, rm, stat, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path";
import { createRequire } from "node:module";
import type { DecodedFrame } from "../shared/png-evidence.js";
import { ArgentCallError, runBridgeCommand, type ArgentBridgeState, type ArgentPlatform, type ArgentTree } from "./argent-driver.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
import { stat } from "node:fs/promises";
import { ArgentCallError } from "./argent-driver.js";
import { argentBridgeSettings, createArgentBridge } from "./argent-bridge.js";
import { ensureController } from "../shared/controller-cache.js";
const ARGENT_CALL_TIMEOUT_MS = 180_000;
async function readState(path: string): Promise<ArgentBridgeState> {
try { return JSON.parse(await readFile(path, "utf8")) as ArgentBridgeState; }
catch { return { generation: 0 }; }
}
/** Written whole and renamed into place, so a command stopped mid-write never leaves a torn state. */
async function writeState(path: string, state: ArgentBridgeState): Promise<void> {
const temporary = `${path}.${process.pid}.tmp`;
await writeFile(temporary, JSON.stringify(state), { mode: 0o600 });
await rename(temporary, path);
}
/** A call's arguments for the debug log: text that could be typed into a field is logged by length only. */
function loggedArgs(args: Record<string, unknown>): Record<string, unknown> {
return Object.fromEntries(Object.entries(args).map(([key, value]) => key === "text" && typeof value === "string" ? [key, `<${value.length} characters>`]
: key === "steps" && Array.isArray(value) ? [key, `<${value.length} steps>`] : [key, value]));
}
/** What a call answered, for the debug log: a tree's shape, not its contents. */
function summarize(tool: string, value: unknown): unknown {
if (!value || typeof value !== "object") return value;
if (tool !== "ui-tree") return Object.keys(value);
const tree = value as ArgentTree;
let nodes = 0;
const walk = (node: { children?: unknown[] }) => { nodes++; (node.children ?? []).forEach(child => walk(child as { children?: unknown[] })); };
(tree.roots ?? []).forEach(walk);
return { foregroundApp: tree.foregroundApp, alertVisible: tree.alertVisible, keyboardVisible: tree.keyboardVisible, truncated: tree.truncated,
screen: tree.screen, nodes, roots: (tree.roots ?? []).map(root => [root.type ?? null, root.bundleId ?? null, (root.children ?? []).length]) };
}
async function main(): Promise<number> {
const environment = process.env;
const statePath = environment.EXPLORE_ARGENT_STATE;
const platform = environment.EXPLORE_ARGENT_PLATFORM as ArgentPlatform | undefined;
const toolsUrl = environment.ARGENT_TOOLS_URL;
if (!statePath || (platform !== "ios" && platform !== "android")) {
const settings = argentBridgeSettings(environment);
if (!settings) {
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: "The Argent controller needs EXPLORE_ARGENT_STATE and EXPLORE_ARGENT_PLATFORM." } }));
return 1;
}
const argv = process.argv.slice(2);
if (argv[0] !== "--version" && !toolsUrl) {
if (argv[0] !== "--version" && !settings.toolsUrl) {
// Without a URL the Argent client would start a local tool-server; Explore only drives the session's own.
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: "ARGENT_TOOLS_URL is not set for the Argent controller." } }));
return 1;
}
// EXPLORE_ARGENT_LOG_DIR (opt-in): every Argent call this bridge makes, how long it took, and the shape of what it read.
const logPath = environment.EXPLORE_ARGENT_LOG_DIR
? join(environment.EXPLORE_ARGENT_LOG_DIR, `argent-${platform}-${environment.EXPLORE_ARGENT_LOG_NAME ?? "bridge"}.jsonl`) : undefined;
const log = async (entry: Record<string, unknown>) => {
if (!logPath) return;
await appendFile(logPath, `${JSON.stringify({ at: new Date().toISOString(), command: argv[0], ...entry })}\n`, { mode: 0o600 }).catch(() => undefined);
};
const state = await readState(statePath);
let cli: string;
try { cli = argv[0] === "--version" ? "" : await ensureController("argent", { environment, progress: message => process.stderr.write(`[explore] ${message}\n`) }); }
catch (error) {
@@ -93,65 +52,9 @@ async function main(): Promise<number> {
catch { throw new ArgentCallError(`argent run ${tool} did not answer with JSON`, true); }
};
const result = await runBridgeCommand(argv, {
state, platform, version: ARGENT_VERSION,
...(environment.EXPLORE_ARGENT_BUNDLE_ID ? { bundleId: environment.EXPLORE_ARGENT_BUNDLE_ID } : {}),
...(environment.EXPLORE_ARGENT_DEVICE ? { device: environment.EXPLORE_ARGENT_DEVICE } : {}),
// An opened foldable's inner panel shows its UI in landscape (Argent's fold: "Unfolded, the UI is landscape").
...(platform === "ios" && ["open", "half-open"].includes(environment.EXPLORE_ARGENT_POSE ?? "") ? { landscape: true } : {}),
call: async (tool, args, options) => {
const started = Date.now();
try {
const value = await callArgent(tool, args, options);
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, summary: summarize(tool, value) });
return value;
} catch (error) {
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, error: (error instanceof Error ? error.message : String(error)).slice(0, 400) });
throw error;
}
},
reachable: async () => {
let ok = false;
try {
const token = environment.ARGENT_AUTH_TOKEN;
// The same URL Argent's own client checks: ARGENT_TOOLS_URL may carry a path, which /tools is appended to.
const response = await fetch(`${(toolsUrl ?? "").replace(/\/+$/, "")}/tools`, { headers: token ? { authorization: `Bearer ${token}` } : {}, signal: AbortSignal.timeout(5_000) });
await response.body?.cancel();
ok = response.status < 500;
} catch { ok = false; }
if (!ok) await log({ tool: "reachable", ok });
return ok;
},
sleep: milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds)),
orientVideo: async path => {
// Turned with ffmpeg, which observing a launch needs anyway; without it the recording is left as it is.
const probed = spawnSync("ffprobe", ["-v", "error", "-select_streams", "v:0", "-show_entries", "stream=width,height", "-of", "csv=p=0:s=x", path], { encoding: "utf8", timeout: 30_000 });
const [width, height] = (probed.stdout ?? "").trim().split("x").map(Number);
if (probed.status !== 0 || !width || !height || width >= height) return;
const turned = `${path}.upright.mp4`;
const ffmpeg = spawnSync("ffmpeg", ["-nostdin", "-y", "-loglevel", "error", "-i", path, "-vf", "transpose=clock", "-an", turned], { encoding: "utf8", timeout: 120_000 });
if (ffmpeg.status === 0) await rename(turned, path);
else await rm(turned, { force: true });
},
scratchImage: { path: join(dirname(statePath), "argent-scratch.png"), read: async path => {
const { PNG } = createRequire(import.meta.url)("pngjs") as { PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
return PNG.sync.read(await readFile(path), { checkCRC: false });
} },
moveFile: async (from, to) => {
// Argent's client downloads a recording under its HOME or the working directory; nothing else is moved.
const source = await realpath(from);
const roots = await Promise.all([environment.HOME, process.cwd()].filter((root): root is string => !!root).map(root => realpath(root).catch(() => root)));
if (!roots.some(root => source.startsWith(`${root}/`))) throw new Error(`Argent returned a recording outside its own directories: ${from}`);
await mkdir(dirname(to), { recursive: true });
try { await rename(from, to); }
catch { await copyFile(from, to); await rm(from, { force: true }); }
},
});
await writeState(statePath, state);
await log({ result: result.exitCode === 0 ? "ok" : result.stdout.slice(0, 300) });
const result = await createArgentBridge(settings, callArgent, "process").run(argv);
process.stdout.write(result.stdout);
return result.exitCode;
}
process.exitCode = await main();
+8 -3
View File
@@ -14,20 +14,25 @@ export function defaultRunner(request: CommandRequest): CommandResult {
...(request.timeoutMs ? { timeout: request.timeoutMs } : {}),
});
if (result.error) throw result.error;
return commandOutcome(request, { status: result.status, stdout: result.stdout ?? "", stderr: result.stderr ?? "" });
}
/** A finished command's output, or the error its exit status and output describe. */
export function commandOutcome(request: CommandRequest, result: { status: number | null; stdout: string; stderr: string }): CommandResult {
if (result.status !== 0 && !request.allowFailure) {
const sessionIndex = request.args.indexOf("--session");
// Our own session or a caller's session attached by explore:session: both answer --json failures with a structured error.
const structuredFailure = (sessionIndex >= 0 && request.args[sessionIndex + 1] === CONTROLLER_SESSION) || request.args.includes("--json")
? controllerCommandFailure(result.stdout ?? "", request.args[0] ?? "command") : undefined;
? controllerCommandFailure(result.stdout, request.args[0] ?? "command") : undefined;
if (structuredFailure) throw structuredFailure;
const subcommand = typeof request.args[0] === "string" ? ` ${request.args[0]}` : "";
const detail = failureDetail(`${result.stderr ?? ""}\n${result.stdout ?? ""}`);
const detail = failureDetail(`${result.stderr}\n${result.stdout}`);
throw new Error(
`${request.command}${subcommand} exited with status ${result.status ?? "unknown"}`
+ (detail ? `: ${detail}` : ""),
);
}
return { stdout: result.stdout ?? "", stderr: result.stderr ?? "" };
return { stdout: result.stdout, stderr: result.stderr };
}
/** Keep the CLI tool host responsive while a remote controller request is in flight. */
+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; }
+47 -13
View File
@@ -1,4 +1,4 @@
import { appearanceArgs, argentColorSchemes, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, type AppearanceSetting, type ColorScheme } from "./appearance.js";
import { appearanceArgs, argentColorSchemes, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, schemeScreenId, type AppearanceSetting, type ColorScheme } from "./appearance.js";
import { assertNoCaptureHealthIssues, captureHealthIssues, partitionCaptureHealthIssues } from "./health.js";
import { type RouteResetSetting } from "./route-reset.js";
import { defaultReadinessSeconds } from "./readiness.js";
@@ -24,6 +24,7 @@ import { silentProgress, type Progress } from "../shared/progress.js";
import { assertCaptureEasProfile, assertSimulatorAvailable, fingerprintFrom, hasEasEnvironmentFetchFailure, nativeBuildFrom, existingBuild, repackProfileFrom, prepareExactSourceBuild, type RepackMode } from "./eas-build.js";
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, endedOwnSimulatorSession, liveSimulatorSessionsNamed, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, controllerVersion, simulatorOsVersion, type ActiveSimulatorRuntime, type SimulatorConnection } from "./simulator.js";
import { argentControllerInvocation } from "./controller-invocation.js";
import { startArgentBridgeRunner, type ArgentBridgeRunner } from "./argent-bridge-host.js";
import { sharedBuild } from "./shared-build.js";
import { LOCAL_EMULATOR_STATE_PREFIX, LOCAL_SIMULATOR_STATE_PREFIX, agentDeviceClaims, assertLocalEmulatorCompatible, createLocalSimulator, startLocalEmulator, waitForLocalEmulator, waitForLocalSimulator, deleteLocalEmulator,
deleteLocalSimulator, hostEmulatorAbi, installOnLocalEmulator, installOnLocalSimulator, approveLinkScheme, localPoseShown,
@@ -72,6 +73,12 @@ export type CiMapOptions = {
buildShare?: string;
/** Which appearances to capture; `auto` (default) follows the app's `userInterfaceStyle`. */
appearance?: AppearanceSetting;
/**
* One session's share of the appearance passes when a side splits them across sessions: `capture` names the passes
* this run makes, out of the `all` it would make alone, so frames keep the ids of a single run (`<id>@dark`) and the
* exports merge. Absent: every resolved appearance.
*/
appearancePass?: { all: readonly ColorScheme[]; capture: readonly ColorScheme[] };
/** Whether to observe the app launch (splash screen) per appearance; `video` also keeps the recording. Defaults to `off`. */
launch?: LaunchSetting;
/** Decodes launch recordings; defaults to ffmpeg when installed. */
@@ -218,7 +225,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
});
const routes = inventory.filter(route => selected.has(route.id));
const setup = revisionSetup(options.setup ?? [], plan, side);
const runner = options.runner ?? defaultRunner;
let runner = options.runner ?? defaultRunner;
const sourceEnvironment = options.environment ?? process.env;
const controller = options.controller ?? "agent-device";
const local = options.simulator === "local";
@@ -353,7 +360,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
let captureFailure: unknown;
const finish = async (): Promise<CiMapResult> => {
if (!(await store.exists())) await store.initialize(map, false);
const incomplete = captureFailure !== undefined || selectedIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
// A session making only secondary passes owns the `<id>@<scheme>` frames of those passes, not the primary ones.
const ownFrameIds = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
? selectedIds.flatMap(id => colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)).map(scheme => schemeScreenId(id, scheme)))
: selectedIds;
const incomplete = captureFailure !== undefined || ownFrameIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
|| map.gaps.some(gap => gap.status === "open");
map.run.status = incomplete || map.screens.length === 0 ? "partial" : "complete";
if (routes.length === 0) map.run.stopReason = "No source targets require capture.";
@@ -422,7 +433,9 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
if (options.agent) assertAgentAcceptance(bundle, map, { required: true });
// The side that produces the evidence checks it the way the review will: an integrity defect fails here, naming
// its codes, instead of on the consuming side after both captures. Unavailable screens are not defects.
assertNoCaptureHealthIssues(partitionCaptureHealthIssues(captureHealthIssues(bundle, selectedIds)).integrity);
// A session capturing only a secondary appearance has no primary frames by design; the merged export is checked instead.
const partialPass = options.appearancePass !== undefined && !options.appearancePass.capture.includes(colorSchemes[0]!);
if (!partialPass) assertNoCaptureHealthIssues(partitionCaptureHealthIssues(captureHealthIssues(bundle, selectedIds)).integrity);
await writeFile(join(outputDirectory, "bundle.json"), `${JSON.stringify(bundle, null, 2)}\n`, { flag: "wx" });
if (metadata) await writeFile(join(outputDirectory, "execution.json"), `${JSON.stringify(metadata, null, 2)}\n`, { flag: "wx" });
assertCheckout();
@@ -481,6 +494,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
let localOsVersion: string | undefined;
// Argent's tool-server on this machine, when Argent drives a local device.
let localArgent: LocalArgentServer | undefined;
let argentBridge: ArgentBridgeRunner | undefined;
const localDevice = () => localSimulator ?? localEmulator;
// A local device starts booting now and finishes while the app is built and repacked; the session waits for it.
let localEmulatorStart: Awaited<ReturnType<typeof startLocalEmulator>> | undefined;
@@ -563,7 +577,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const appDirectory = !options.buildShare ? await realpath(await mkdtemp(join(tmpdir(), "expo-explore-app-"))) : undefined;
let localApp: string | undefined;
type BuiltApp = { fingerprint: string; nativeEasBuildId: string | null; easBuildId: string | null; app?: string; reused: boolean; version?: string; buildNumber?: string };
const buildApp = async (keepApp: string): Promise<BuiltApp> => {
// `repacking` tells the captures sharing this build that their sessions can start too (sharedBuild).
const buildApp = async (keepApp: string, repacking?: () => Promise<void>): Promise<BuiltApp> => {
options.signal?.throwIfAborted();
say("computing the native fingerprint");
const fingerprintResult = eas(["fingerprint:generate", "--platform", options.platform, "--build-profile", options.easProfile, "--json", "--non-interactive"]);
@@ -573,7 +588,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
"--fingerprint-hash", sourceFingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
if (reusable) {
say(`reusing EAS build ${reusable.id} (fingerprint ${sourceFingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
startSession();
startSession(); await repacking?.();
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
project, nativeBuildId: reusable.id, fingerprint: sourceFingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
@@ -587,7 +602,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
: `no finished simulator build has fingerprint ${sourceFingerprint.slice(0, 12)}; building on EAS and waiting for it to finish`);
const built = nativeBuildFrom(eas(["build", "--platform", options.platform, "--profile", options.easProfile, "--wait", "--json", "--non-interactive"], 45 * 60_000).stdout);
say(`EAS build ${built.id} finished; repacking it with the route observer`);
startSession();
startSession(); await repacking?.();
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
project, nativeBuildId: built.id, fingerprint: built.fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
@@ -603,9 +618,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
? await sharedBuild({ directory: options.buildShare, appName, ...(options.signal ? { signal: options.signal } : {}), build: buildApp, owner: options.outputDirectory,
key: { platform: options.platform, easProfile: options.easProfile, bundleId: options.bundleId, gitCommit: options.gitCommit, repack: options.repack ?? "eas", local,
routes: inventory.map(route => route.id) },
waiting: () => say("using the build another target of this review is preparing for this commit") })
waiting: () => say("using the build another target of this review is preparing for this commit"),
// The session is named before its app exists, so a waiter's session boots while the other capture repacks.
repacking: () => startSession() })
: await buildApp(join(appDirectory!, appName));
// A capture that used another target's build starts its session now.
// A capture that used another capture's build has its session started above; this starts the rest.
startSession();
fingerprint = built.fingerprint; nativeEasBuildId = built.nativeEasBuildId; easBuildId = built.easBuildId; localApp = built.app; reusedEasBuild = built.reused;
if (!app.version && built.version) app.version = built.version;
@@ -756,6 +773,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
AGENT_DEVICE_SESSION: CONTROLLER_SESSION, AGENT_DEVICE_SESSION_LOCK: "reject", AGENT_DEVICE_PLATFORM: options.platform };
// Every controller call below goes to the session's controller; for Argent that is the bridge.
const controllerCommand = argent?.command ?? options.agentDeviceCommand;
// The capture's commands keep one bridge on a worker thread (EXPLORE_ARGENT_BRIDGE=process: one process per command, as before).
if (argent && !options.runner && sourceEnvironment.EXPLORE_ARGENT_BRIDGE !== "process") {
argentBridge = startArgentBridgeRunner({ command: argent.command, environment: argent.environment, fallback: defaultRunner, progress: say });
runner = argentBridge.runner;
}
if (!local && localApp) {
// The session started empty while the app was repacked; the controller installs it now.
say(`installing the app on session ${sessionId}`);
@@ -914,7 +936,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
// Every pass sets the appearance explicitly, so a capture does not inherit whatever the simulator last used.
const passes: CaptureBundle["outcomes"][] = [];
const recordingTools = launchSetting === "off" ? undefined : options.recordingTools === undefined ? ffmpegRecordingTools() : options.recordingTools ?? undefined;
const capturedSchemes = options.appearancePass ? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : colorSchemes;
for (const [index, colorScheme] of colorSchemes.entries()) {
// A pass another session makes leaves its slot empty, so the passes stay aligned with the appearances they merge by.
if (!capturedSchemes.includes(colorScheme)) { passes.push({}); continue; }
// Argent cannot switch the appearance yet (software-mansion/argent#1509): the host does, simctl or adb on this
// machine and serve-sim on an EAS iOS session; elsewhere its single pass runs as the device starts.
if (controller !== "argent") runner({ command: controllerCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(runtime), "--platform", options.platform],
@@ -944,16 +969,22 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
...deviceArgs(runtime), "--platform", options.platform, "--level", "full", "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
runtime.colorScheme = colorScheme;
if (colorSchemes.length > 1) say(`appearance ${colorScheme} (${index + 1}/${colorSchemes.length})`);
passes.push(await capturePlannedRoutes({ capture: { ...options, agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
passes.push(await capturePlannedRoutes({ capture: { ...options, ...(argentBridge && !options.agent ? { runner: argentBridge.runner } : {}), agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
...(colorSchemes.length > 1 ? { appearance: { scheme: colorScheme, primary: index === 0 } } : {}) }));
}
runtime.colorScheme = colorSchemes[0]!;
Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
// A session without the primary pass keeps each outcome as its pass recorded it, under `<id>@<scheme>`: the export
// merge recombines them with the primary pass's (mergeSchemeOutcomes), which only then can tell an unattributed
// frame beside a primary one from a lost route.
if (options.appearancePass && !capturedSchemes.includes(colorSchemes[0]!)) {
for (const [index, pass] of passes.entries()) for (const [id, outcome] of Object.entries(pass)) outcomes[schemeScreenId(id, colorSchemes[index])] = outcome;
} else Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
} catch (error) { primaryError = toCiError(error, { code: `CAPTURE_${runtimeStage.toUpperCase()}_FAILED`, stage: runtimeStage,
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." }); }
finally {
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
argentBridge?.close();
if (localArgent) stopLocalArgentServer(localArgent);
if (localEmulator) {
try {
@@ -1017,7 +1048,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
throw primaryError;
}
setStage("export");
const captured = selectedIds.filter(id => outcomes[id]?.status === "captured").length;
say(`${captured} of ${selectedIds.length} ${selectedIds.length === 1 ? "route" : "routes"} captured`);
const ownSchemes = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : undefined;
const captured = selectedIds.filter(id => ownSchemes
? ownSchemes.every(scheme => outcomes[schemeScreenId(id, scheme)]?.status === "captured") : outcomes[id]?.status === "captured").length;
say(`${captured} of ${selectedIds.length} ${selectedIds.length === 1 ? "route" : "routes"} captured${ownSchemes ? ` in ${ownSchemes.join(", ")}` : ""}`);
return finish();
}
+8 -4
View File
@@ -19,21 +19,23 @@ const POLL_MS = 2_000;
/**
* Runs `build` once per key across every capture sharing `directory`; the app it leaves goes in the build's folder
* (`keepApp`), which outlives each capture. A waiter is told so it can say whose build it uses.
* (`keepApp`), which outlives each capture. A waiter is told so it can say whose build it uses, and told again
* (`repacking`) once the builder calls its `repacking` (the native build is known and is being repacked), or the
* build is done: a waiter starts its session then, not while a native build may run for most of an hour.
*/
export async function sharedBuild<T extends object>(options: { directory: string; key: SharedBuildKey; appName: string; signal?: AbortSignal;
build: (keepApp: string) => Promise<T>; waiting?: () => void;
build: (keepApp: string, repacking: () => Promise<void>) => Promise<T>; waiting?: () => void; repacking?: () => void;
/** Who builds it (the capture's output directory), so a review can fail its waiters if that capture dies (abandonSharedBuilds). */
owner?: string }): Promise<T> {
const folder = join(options.directory, sharedBuildId(options.key));
const result = join(folder, "result.json"), failure = join(folder, "failure.json");
const result = join(folder, "result.json"), failure = join(folder, "failure.json"), repack = join(folder, "repacking");
await mkdir(options.directory, { recursive: true });
let owner = true;
try { await mkdir(folder); } catch (error) { if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error; owner = false; }
if (owner) {
if (options.owner) await writeFile(join(folder, "owner"), options.owner);
try {
const built = await options.build(join(folder, options.appName));
const built = await options.build(join(folder, options.appName), () => writeFile(repack, "").catch(() => undefined));
await writeFile(`${result}.tmp`, JSON.stringify(built));
await rename(`${result}.tmp`, result);
return built;
@@ -44,9 +46,11 @@ export async function sharedBuild<T extends object>(options: { directory: string
}
}
options.waiting?.();
let repackSeen = false;
for (;;) {
options.signal?.throwIfAborted();
const done = await readFile(result, "utf8").catch(() => undefined);
if (!repackSeen && (done !== undefined || existsSync(repack))) { repackSeen = true; options.repacking?.(); }
if (done !== undefined) return JSON.parse(done) as T;
const failed = await readFile(failure, "utf8").catch(() => undefined);
if (failed !== undefined) {
+4 -1
View File
@@ -28,6 +28,9 @@ const recipeKey = ({ inventory, profile, config, toolsCommit }: Recipe) => {
/** Only settings that can change captured runtime evidence belong in the recipe. */
export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?: string): string {
// How many sessions capture the evidence (capture.maxSessions) does not change it.
const { maxSessions: _maxSessions, ...capture } = config.capture;
void _maxSessions;
return canonicalJson({
observer: CAPTURE_OBSERVER_HASH,
mode: config.mode,
@@ -36,7 +39,7 @@ export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?:
...(config.app.scheme === undefined ? {} : { scheme: config.app.scheme }) },
device: config.device, parameters: config.parameters, setup: config.setup ?? [],
// The repack as it resolves, so a config that leaves it to the default keeps the recipe it had when the default was written out.
capture: { ...config.capture, repack: captureRepack(config) },
capture: { ...capture, repack: captureRepack(config) },
// agent-device recipes stay as they were; an Argent capture is keyed to the Argent release that drove it.
...(config.capture.controller === "argent" ? { controllerVersion: ARGENT_VERSION } : {}),
});
+83
View File
@@ -0,0 +1,83 @@
import { copyFile, mkdir, readdir, readFile, writeFile, appendFile, lstat } from "node:fs/promises";
import { dirname, join, relative } from "node:path";
import { bundleColorSchemes, mergeSchemeOutcomes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
import type { CaptureOutcome } from "../contracts/capture.js";
import type { CaptureBundle } from "../contracts/capture.js";
import type { ExploreMap } from "../types.js";
const LIST_FIELDS = ["artifacts", "screens", "variants", "observations", "elements", "actionAttempts", "transitions", "journeys", "frontier", "gaps"] as const;
async function readJson<T>(path: string): Promise<T> { return JSON.parse(await readFile(path, "utf8")) as T; }
async function copyTree(source: string, destination: string, skip: (relativePath: string) => boolean, root = source): Promise<void> {
for (const entry of await readdir(source, { withFileTypes: true })) {
const from = join(source, entry.name), to = join(destination, entry.name), rel = relative(root, from);
if (skip(rel)) continue;
if (entry.isDirectory()) { await mkdir(to, { recursive: true }); await copyTree(from, to, skip, root); continue; }
if (!entry.isFile()) continue;
if ((await lstat(to).catch(() => undefined))) continue;
await mkdir(dirname(to), { recursive: true });
await copyFile(from, to);
}
}
/**
* Fold the exports of a side's secondary appearance sessions into its primary export, in place: the frames, outcomes,
* launch evidence and map records of each `<id>@<scheme>` screen, and their files. Each session captured its passes as
* one run would (`appearancePass`), so records only append; a secondary export never replaces a primary record.
*/
export async function mergeCaptureExports(primary: string, secondaries: readonly { directory: string; scheme: ColorScheme }[]): Promise<void> {
if (secondaries.length === 0) return;
const bundle = await readJson<CaptureBundle>(join(primary, "bundle.json"));
const map = await readJson<ExploreMap>(join(primary, "screen-map.json"));
const known = { screens: new Set(map.screens.map(screen => screen.id)), artifacts: new Set(map.artifacts.map(artifact => artifact.id)) };
// The outcomes recombine as one run's passes do (mergeSchemeOutcomes): a secondary pass records a verified frame under
// `<id>@<scheme>` and a lost route under `<id>`, which the merge folds into the primary record the same way.
const schemes = bundleColorSchemes(bundle);
const passes: Record<string, CaptureOutcome>[] = schemes.map(() => ({}));
for (const [id, outcome] of Object.entries(bundle.outcomes)) if (!routeIdOfScreen(id).scheme) passes[0]![id] = outcome;
for (const { directory: secondary, scheme } of secondaries) {
const other = await readJson<CaptureBundle>(join(secondary, "bundle.json"));
const pass = passes[schemes.indexOf(scheme)];
// A session that could not show its appearance (Argent without appearance.set captures one) has nothing to add, as
// one run would have no pass for it.
if (!pass && !bundleColorSchemes(other).includes(scheme)) continue;
if (!pass) throw new Error(`The ${scheme} session's export is not an appearance of the primary export (${schemes.join(", ")})`);
for (const [id, outcome] of Object.entries(other.outcomes)) pass[routeIdOfScreen(id).routeId] = outcome;
const otherMap = await readJson<ExploreMap>(join(secondary, "screen-map.json"));
for (const [id, image] of Object.entries(other.images)) if (routeIdOfScreen(id).scheme && !bundle.images[id]) bundle.images[id] = image;
for (const [scheme, record] of Object.entries(other.launch ?? {})) { bundle.launch ??= {}; bundle.launch[scheme] ??= record; }
for (const [id, context] of Object.entries(other.captureContexts ?? {})) { bundle.captureContexts ??= {}; bundle.captureContexts[id] ??= context; }
for (const field of LIST_FIELDS) {
const records = (otherMap[field] ?? []) as Array<Record<string, unknown>>;
const target = ((map as unknown as Record<string, unknown[]>)[field] ??= []);
for (const record of records) {
if (field === "screens" && known.screens.has(record.id as string)) continue;
if (field === "artifacts" && known.artifacts.has(record.id as string)) continue;
if (field === "screens") known.screens.add(record.id as string);
if (field === "artifacts") known.artifacts.add(record.id as string);
target.push(record);
}
}
// Files: artifacts and launch evidence are new paths; diagnostics append to the primary's lines.
await copyTree(secondary, primary, rel => rel === "bundle.json" || rel === "screen-map.json" || rel === "screen-map.schema.json" || rel === "manifest.json"
|| rel === "execution.json" || rel.startsWith("capture-diagnostics"));
const diagnostics = join(secondary, "capture-diagnostics");
for (const entry of await readdir(diagnostics, { withFileTypes: true }).catch(() => [])) {
if (!entry.isFile()) continue;
const to = join(primary, "capture-diagnostics", entry.name);
await mkdir(dirname(to), { recursive: true });
if (entry.name.endsWith(".jsonl")) await appendFile(to, await readFile(join(diagnostics, entry.name)));
else if (!(await lstat(to).catch(() => undefined))) await copyFile(join(diagnostics, entry.name), to);
}
}
// An open gap a secondary pass left makes the run partial, as it does one run's (a complete run has none).
if (map.gaps.some(gap => gap.status === "open")) map.run.status = "partial";
const manifest = await readJson<{ files: unknown[] }>(join(primary, "manifest.json"));
manifest.files = map.artifacts.map(artifact => ({ path: artifact.path, sha256: artifact.sha256, bytes: artifact.bytes, mimeType: artifact.mimeType }));
await writeFile(join(primary, "screen-map.json"), JSON.stringify(map));
bundle.outcomes = mergeSchemeOutcomes(passes, schemes);
await writeFile(join(primary, "bundle.json"), JSON.stringify(bundle));
await writeFile(join(primary, "manifest.json"), `${JSON.stringify(manifest, null, 2)}\n`);
}
+16 -7
View File
@@ -1,14 +1,14 @@
import type { RunTarget } from "../types.js";
import { spawnSync } from "node:child_process";
import { randomBytes } from "node:crypto";
import { readFileSync } from "node:fs";
import { readFileSync, readdirSync } from "node:fs";
import { copyFile, cp, lstat, mkdir, mkdtemp, readdir, readFile, realpath, rename, rm, stat, utimes, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join, relative, resolve } from "node:path";
import { runCiReview } from "./pipeline.js";
import { resolveCommit } from "./workflow-steps.js";
import { ciLayout, installCommand, type PackageManager } from "./workflow-install.js";
import { configPlatforms, readExploreConfig, resolveTargetConfig, configTargets, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { configPlatforms, readExploreConfig, resolveTargetConfig, configTargets, posedTargets, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { AGENT_PROVIDERS, defaultExploreConfig } from "../config/setup.js";
import type { PrepareCiExplorationOptions } from "../capture/agent/exploration.js";
import { createCiAgentSession } from "../capture/agent/session.js";
@@ -26,6 +26,7 @@ import { abandonSharedBuilds } from "../capture/shared-build.js";
import { exploreCacheRoot } from "../shared/cache-root.js";
import { packageBin } from "../shared/package-paths.js";
import { silentProgress, type Progress } from "../shared/progress.js";
import { maxParallelTargets } from "./session-plan.js";
/**
* `capture:review --base REF [--head REF]` on a laptop: the same review CI runs (`runCiReview`), on two commits of the
@@ -44,7 +45,7 @@ export type LocalReviewOptions = {
platform?: ExplorePlatform | undefined;
/** `--target`: capture this config.yaml target alone; with `platform`, the targets of that platform. */
target?: string | undefined;
/** `--parallel`: how many targets capture at once (each runs a simulator or emulator per side); all of them by default. */
/** `--parallel`: how many targets capture at once (each runs a simulator or emulator per side); by default all of them, up to capture.maxSessions. */
parallel?: number | undefined;
scope?: string | undefined;
expiresIn?: string | undefined;
@@ -285,8 +286,15 @@ export async function keepCapture(exported: string, target: string): Promise<boo
}
}
/** The session state files a review writes: `<side>-session`, and `<side>-session-<scheme>` for appearance passes in their own sessions. */
function sessionStateFiles(output: string): string[] {
const rank = (name: string) => ["head", "base", "baseline"].indexOf(name.split("-")[0]!);
try { return readdirSync(output).filter(name => /^(head|base|baseline)-session(-[a-z]+)?$/.test(name)).sort((a, b) => rank(a) - rank(b) || a.localeCompare(b)); }
catch { return []; }
}
function recordedSessionIds(outputs: string[]): string[] {
return outputs.flatMap(output => ["head-session", "base-session"].flatMap(name => {
return outputs.flatMap(output => sessionStateFiles(output).flatMap(name => {
try { const id = readFileSync(join(output, name), "utf8").trim(); return /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id) ? [id] : []; } catch { return []; }
}));
}
@@ -307,7 +315,7 @@ export async function stopRecordedSessions(outputs: string[], environment: NodeJ
simctl: (args: string[]) => { status: number | null } = args => spawnSync("xcrun", ["simctl", ...args], { env: environment, encoding: "utf8", timeout: 120_000 }),
adb: (args: string[]) => { status: number | null } = args => spawnSync(androidTools(environment).adb, args, { env: environment, encoding: "utf8", timeout: 60_000 })): Promise<string[]> {
const stopped: string[] = [];
for (const output of outputs) for (const name of ["head-session", "base-session"]) {
for (const output of outputs) for (const name of sessionStateFiles(output)) {
const file = join(output, name);
const id = (await readFile(file, "utf8").catch(() => "")).trim();
if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id)) continue;
@@ -479,7 +487,7 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
target, ...(targets.length > 1 ? { targets } : {}) };
progress(`${target.id}: reviewing${target.id === platform ? "" : ` (${target.label})`}`);
const result = await runCiReview({ projects, output, config, presentation, runId, runAttempt: "1", state, environment: platformEnvironment,
...(platforms.length > 1 ? { platforms } : {}), ...(targets.length > 1 ? { targets } : {}),
...(platforms.length > 1 ? { platforms } : {}), ...(targets.length > 1 ? { targets } : {}), posedTargets: posedTargets(rawConfig),
// Targets of one platform capture the same commits from the same build; it is built and repacked once.
...(targets.length > 1 ? { buildShare: join(work, ".builds") } : {}),
subscription, useLocalEasSession, progress: message => progress(`${target.id}: ${message}`),
@@ -537,7 +545,8 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
await abandonSharedBuilds(join(work, ".builds"), owner => owner === join(work, target.id, `${side}-export`), failure.code);
}
};
const settled = await settleLimited(targets, options.parallel ?? targets.length,
// Each target needs a simulator session: no more run at once than capture.maxSessions, unless --parallel says.
const settled = await settleLimited(targets, options.parallel ?? maxParallelTargets(rawConfig.capture.maxSessions, targets.length),
target => captureTarget(target).catch(async (error: unknown) => { await releaseBuilds(target, error).catch(() => undefined); throw error; }));
// One target that fails costs that target's report, not the others': they are kept, and the failure is named.
// Only an interrupted review, or one where every target failed, fails as a whole.
+131 -13
View File
@@ -1,12 +1,18 @@
import { systemRegions } from "../contracts/capture.js";
import type { RunTarget } from "../types.js";
import { spawnSync } from "node:child_process";
import { mkdir, open, readFile, realpath, writeFile } from "node:fs/promises";
import { execFile, spawnSync } from "node:child_process";
import { mkdir, mkdtemp, open, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { join, relative, resolve, isAbsolute } from "node:path";
import { tmpdir } from "node:os";
import { setTimeout as delay } from "node:timers/promises";
import { promisify } from "node:util";
import { buildVerifiedPlan } from "./verified-plan.js";
import { runCiMap, type CommandRunner } from "../capture/run.js";
import { routeIdOfScreen } from "../capture/appearance.js";
import { runCiMap, type CiMapOptions, type CommandRunner } from "../capture/run.js";
import { resolveColorSchemes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
import { baseEnvironment } from "../capture/common.js";
import { DEFAULT_MAX_SESSIONS, planSideSessions, sessionShare } from "./session-plan.js";
import { mergeCaptureExports } from "./export-merge.js";
import { abandonSharedBuilds } from "../capture/shared-build.js";
import { prepareCaptureReview, readCaptureBundle } from "../review/capture-review.js";
import { quarantineReviewContract } from "../contracts/review-validation.js";
import { agentCaptureConstraints } from "../capture/agent/source-context.js";
@@ -63,6 +69,8 @@ async function recipe(config: ExploreConfig, plan: SourceCapturePlan, side: "bas
/** The capture's clock and host-side pause; tests pair them with an injected runner so readiness budgets are not real time. */
type CaptureClock = { now?: (() => number) | undefined; sleep?: ((milliseconds: number) => void) | undefined };
const execFileAsync = promisify(execFile);
function captureOptions(config: ExploreConfig, environment: NodeJS.ProcessEnv, runner?: CommandRunner, clock: CaptureClock = {}) {
return { ...(runner && clock.now ? { now: clock.now } : {}), ...(runner && clock.sleep ? { sleep: clock.sleep } : {}), platform: config.app.platform, bundleId: config.app.bundleId,
...(config.app.scheme ? { scheme: config.app.scheme } : {}), device: config.device.name, ...(config.device.pose ? { devicePose: config.device.pose } : {}),
@@ -84,6 +92,87 @@ async function prefetchControllers(config: ExploreConfig, environment: NodeJS.Pr
if (config.capture.controller === "argent" && config.capture.simulator === "local") await ensureArgentToolServer({ environment, progress });
}
/**
* The appearances a capture of this side renders, read before any session starts so the sessions can divide them. The
* app config comes from `eas config` in a child process, as the capture reads it, with the capture's restricted
* environment: never evaluated in this process, which holds the review's secrets. Unknown: undefined.
*/
async function expectedColorSchemes(config: ExploreConfig, project: string, environment: NodeJS.ProcessEnv, easCommand: string): Promise<ColorScheme[] | undefined> {
// Argent switches the appearance only through serve-sim on an EAS iOS session; elsewhere it captures one.
if (config.capture.controller === "argent" && config.capture.simulator !== "local" && config.app.platform !== "ios") return undefined;
if (config.capture.appearance !== "auto") return resolveColorSchemes(config.capture.appearance, undefined, config.app.platform);
const easEnvironment = { ...baseEnvironment(environment), ...(environment.EXPO_TOKEN ? { EXPO_TOKEN: environment.EXPO_TOKEN } : {}) };
try {
const { stdout } = await execFileAsync(easCommand, ["config", "--platform", config.app.platform, "--profile", config.app.easProfile, "--json", "--non-interactive"],
{ cwd: project, env: easEnvironment, timeout: 5 * 60_000, maxBuffer: 16 * 1024 * 1024 });
const app = (JSON.parse(stdout) as { appConfig?: Record<string, unknown> }).appConfig;
return app && typeof app === "object" ? resolveColorSchemes("auto", app, config.app.platform) : undefined;
} catch {
// The capture reads the same config and reports why it cannot; until then the side keeps one session.
return undefined;
}
}
/**
* Run one side's capture: in one session, or when `passes` splits its appearances, one worker session per pass. The
* primary pass exports to `mapOptions.outputDirectory`; the others beside it, named by their appearances, then merge.
*/
async function captureSideInSessions(mapOptions: CiMapOptions, passes: readonly (readonly ColorScheme[])[] | undefined,
progress: Progress, signal: AbortSignal | undefined, worker: boolean): Promise<Awaited<ReturnType<typeof runCiMap>>> {
const runOnWorker = (passOptions: CiMapOptions) =>
runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(passOptions), progress, signal);
if (!passes || passes.length <= 1) return worker ? runOnWorker(mapOptions) : runCiMap(mapOptions);
const schemes = passes.flat();
progress(`${mapOptions.side}: capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions`);
// The passes install the same app: they share one build and repack, as the targets of a local review do.
const ownBuildShare = mapOptions.buildShare ? undefined : await mkdtemp(join(tmpdir(), "expo-explore-builds-"));
const buildShare = mapOptions.buildShare ?? ownBuildShare!;
const settled = await Promise.allSettled(passes.map(async (pass, index) => {
const suffix = index === 0 ? "" : `-${pass.join("-")}`;
const outputDirectory = `${mapOptions.outputDirectory}${suffix}`;
try {
return await runOnWorker({ ...mapOptions, mapDirectory: `${mapOptions.mapDirectory}${suffix}`, outputDirectory, buildShare,
...(mapOptions.sessionStatePath ? { sessionStatePath: `${mapOptions.sessionStatePath}${suffix}` } : {}), appearancePass: { all: schemes, capture: pass } });
} catch (error) {
// A pass that dies mid-build must not leave the others polling for its result.
await abandonSharedBuilds(buildShare, owner => owner === outputDirectory, toCiError(error).code).catch(() => undefined);
throw error;
}
}));
// The build folder holds the repacked app, which the sessions have installed.
if (ownBuildShare) await rm(ownBuildShare, { recursive: true, force: true });
for (const outcome of settled) if (outcome.status === "rejected") throw outcome.reason;
await mergeCaptureExports(mapOptions.outputDirectory, passes.slice(1).map(pass => ({ directory: `${mapOptions.outputDirectory}-${pass.join("-")}`, scheme: pass[0]! })));
return (settled[0] as PromiseFulfilledResult<Awaited<ReturnType<typeof runCiMap>>>).value;
}
/**
* This target's share of `capture.maxSessions`: the targets are this review's (`targets`), or the config's one, and
* `posedTargets` (foldables) take the sessions that do not divide evenly.
*/
function targetSessionShare(config: ExploreConfig, targets: readonly RunTarget[] | undefined, posedTargets: readonly string[] | undefined): number {
const targetIds: string[] = (targets ?? []).map(target => target.id);
if (targetIds.length === 0) targetIds.push(...(config.targets ? Object.keys(config.targets) : [config.target?.id ?? "default"]));
return sessionShare({ maxSessions: config.capture.maxSessions, targets: targetIds, target: config.target?.id ?? targetIds[0]!,
prefer: id => posedTargets?.includes(id) ? 1 : 0 });
}
/**
* The appearance passes one side spreads over sessions of its own, out of its target's share of `capture.maxSessions`;
* undefined keeps the side in one session. The side's app config is read only when its share and routes could pay for
* a split.
*/
export async function sideAppearancePasses(config: ExploreConfig, environment: NodeJS.ProcessEnv,
input: { share: number; sides: 1 | 2; routes: number; project: string; easCommand?: string }): Promise<ColorScheme[][] | undefined> {
// A pass observes its launch only when capture.launch asks for it.
const plan = (schemes: readonly ColorScheme[]) => planSideSessions({ share: input.share, sides: input.sides, routes: input.routes, schemes,
...(config.capture.launch === "off" ? { launchSeconds: 0 } : {}) }).passes;
if (plan(["light", "dark"]).length < 2) return undefined;
const schemes = await expectedColorSchemes(config, input.project, environment, input.easCommand ?? packageBin("eas-cli", "eas"));
const passes = schemes ? plan(schemes) : [];
return passes.length > 1 ? passes.map(pass => [...pass]) : undefined;
}
export function captureSidesConcurrently(input: { plan: SourceCapturePlan; agent: boolean; injectedRunner: boolean; baselineMayExist: boolean }): boolean {
return !input.agent && !input.injectedRunner && !input.baselineMayExist
&& input.plan.headCaptureSurfaceIds.length > 0 && input.plan.baseCaptureSurfaceIds.length > 0;
@@ -111,6 +200,8 @@ export type PublicCiOptions = {
platforms?: ExplorePlatform[];
/** Every target config.yaml captures, in config order; recorded in the report so the Viewer links the sibling targets' reports. */
targets?: RunTarget[];
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
posedTargets?: readonly string[];
baseProject: string; headProject: string; pullRequestPath: string; output: string;
config: ExploreConfig; configPath?: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
now?: () => number; sleep?: (milliseconds: number) => void; onComment?: (state: PublicCommentState, body: string) => void;
@@ -253,6 +344,8 @@ export async function runCiReview(options: {
platforms?: ExplorePlatform[];
/** Every target config.yaml captures; `config.target` is the one this review captures. */
targets?: RunTarget[];
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
posedTargets?: readonly string[];
/** A folder shared with the other targets' reviews, so the targets of one platform build each commit once. */
buildShare?: string;
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
@@ -268,7 +361,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;
@@ -307,7 +401,20 @@ export async function runCiReview(options: {
// A baseline that may be restored needs the head runtime profile first; otherwise both sides capture at once.
const baselineMayExist = plan.baseCaptureSurfaceIds.length > 0 && await captureArtifactCacheMayMatch({ ...cacheRecipes.base,
...(environment.EXPLORE_CAPTURE_CACHE ? { sourceDirectory: environment.EXPLORE_CAPTURE_CACHE } : {}), commit: pr.base.sha });
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist });
const share = targetSessionShare(config, options.targets, options.posedTargets);
// A share of one session captures the sides in turn.
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist }) && share >= 2;
// Each side's appearances split by its own app config: a pull request can change userInterfaceStyle. Sides taken in
// turn (a baseline may be restored) each have the whole share. Passes run on worker threads, which cannot take an
// injected runner or an agent session.
const sidePasses = { head: undefined as ColorScheme[][] | undefined, base: undefined as ColorScheme[][] | undefined };
if (!exploration.agent && !options.runner) await Promise.all((["head", "base"] as const).map(async side => {
sidePasses[side] = await sideAppearancePasses(config, environment, { share, sides: concurrent ? 2 : 1, routes: plan[`${side}CaptureSurfaceIds`].length, project: projects[side] });
}));
const split = (["head", "base"] as const).filter(side => sidePasses[side]);
progress(`sessions: ${share} of ${config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
+ (split.length ? `${split.join(" and ")} ${split.length === 1 ? "captures its" : "capture their"} appearances in separate sessions`
: concurrent ? "one session per side" : "the sides in turn"));
const captureSide = async (side: "head" | "base") => {
const directory = join(output, `${side}-export`);
const selectedIds = plan[`${side}CaptureSurfaceIds`];
@@ -327,9 +434,8 @@ export async function runCiReview(options: {
name: config.app.name ?? pr.repository, buildId: pr.origin === "local" ? `local-${pr.runId}-${side}` : pr.origin === "compare" ? `compare-${options.runId}-${side}` : `pr-${pr.number}-${side}`, buildVersion: pr[side].sha.slice(0, 8), gitCommit: pr[side].sha,
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`), ...(options.buildShare ? { buildShare: options.buildShare } : {}),
...(reuseDirectory ? { reuseDirectory } : {}), ...(options.signal ? { signal: options.signal } : {}) };
const captured = concurrent
? await runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(mapOptions), progress, options.signal)
: await runCiMap(mapOptions);
// A restored baseline already holds every appearance pass, so it never splits.
const captured = await captureSideInSessions(mapOptions, reuseDirectory ? undefined : sidePasses[side], progress, options.signal, concurrent);
const bundle = await readCaptureBundle(directory);
bundle.profile = cacheRecipe.profile;
await writeFile(join(directory, "bundle.json"), JSON.stringify(bundle));
@@ -368,8 +474,9 @@ export async function runCiReview(options: {
stage = "compare";
progress("comparing base and head captures");
const sides = { base: await evidenceSide(join(output, "base-export")), head: await evidenceSide(join(output, "head-export")) };
const evidence = await assessPublicEvidence({ platform: config.app.platform, plan, ...sides, ...(options.measure ? { measure: options.measure } : {}), profile: `${config.app.easProfile}:${config.app.bundleId}`, agentDeviceCommand: agentDeviceLauncher(options.environment) });
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory,
const system = systemRegions({ platform: config.app.platform, device: config.device.name, pose: config.device.pose });
const evidence = await assessPublicEvidence({ platform: config.app.platform, systemRegions: system, plan, ...sides, ...(options.measure ? { measure: options.measure } : {}), profile: `${config.app.easProfile}:${config.app.bundleId}`, agentDeviceCommand: agentDeviceLauncher(options.environment) });
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory, systemRegions: system,
runId: options.runId, runAttempt: options.runAttempt, assertCurrentHead, assessments: evidence.surfaces,
...(options.platforms ? { platforms: options.platforms } : {}),
...(config.target ? { target: config.target } : {}), ...(options.targets ? { targets: options.targets } : {}),
@@ -461,6 +568,10 @@ export async function runCiReview(options: {
}
export async function runBaselineCi(options: { platform?: ExplorePlatform; project: string; sha: string; output: string; config: ExploreConfig; environment?: NodeJS.ProcessEnv; runner?: CommandRunner;
/** Every target config.yaml captures, so this baseline takes its target's share of `capture.maxSessions`. */
targets?: RunTarget[];
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
posedTargets?: readonly string[];
now?: () => number; sleep?: (milliseconds: number) => void;
agentSessionFactory?: PrepareCiExplorationOptions["createSession"]; progress?: Progress;
/** Use the local `eas login` session instead of EXPO_TOKEN (expo-explore doctor --capture). */
@@ -486,12 +597,19 @@ export async function runBaselineCi(options: { platform?: ExplorePlatform; proje
onUsage: recordAgentUsage(output, () => usagePhase), ...(options.subscription ? { subscription: true } : {}) });
const directory = join(output, "baseline-export");
usagePhase = "capture-baseline";
const result = await runCiMap({ ...captureOptions(options.config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
const baselineOptions: CiMapOptions = { ...captureOptions(options.config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
...(options.useLocalEasSession ? { useLocalEasSession: true } : {}),
...(exploration.agent ? { agent: exploration.agent } : {}), project: options.project,
mapDirectory: join(output, "baseline-map"), outputDirectory: directory, name: options.config.app.name ?? options.config.app.bundleId,
buildId: `baseline-${options.sha.slice(0, 12)}`, buildVersion: options.sha.slice(0, 8), gitCommit: options.sha,
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") });
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") };
const share = targetSessionShare(options.config, options.targets, options.posedTargets);
// Passes on worker threads cannot take an injected runner or an agent session.
const passes = !options.runner && !exploration.agent
? await sideAppearancePasses(options.config, environment, { share, sides: 1, routes: plan.headCaptureSurfaceIds.length, project: options.project }) : undefined;
progress(`sessions: ${share} of ${options.config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
+ (passes ? `capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions` : "one session"));
const result = await captureSideInSessions(baselineOptions, passes, progress, undefined, passes !== undefined);
const cacheRecipe = await recipe(options.config, plan, "head", environment, exploration.instructionsSha256);
if (options.subscription) cacheRecipe.toolsCommit += ":local-subscription";
const bundle = await readCaptureBundle(directory); bundle.profile = cacheRecipe.profile;
+70
View File
@@ -0,0 +1,70 @@
import type { ColorScheme } from "../capture/appearance.js";
/** One route capture on a remote session, with the bridge thread (observed ~5 s; 9.4 s before it). */
export const ROUTE_SECONDS = 5;
/** Observing the app launch once per appearance. */
export const LAUNCH_SECONDS = 28;
/** A pass moves to its own session only when that shortens the side by at least this much. */
export const SPLIT_MIN_SAVING_SECONDS = 60;
/**
* `capture.maxSessions` when the config sets none: the simulators a typical EAS plan runs at once. A starter plan runs
* one per platform, so its config sets the ceiling lower (2 for an iOS and an Android target).
*/
export const DEFAULT_MAX_SESSIONS = 5;
export type SessionShareInput = {
/** `capture.maxSessions`: the review-wide ceiling; absent means DEFAULT_MAX_SESSIONS. */
maxSessions: number | undefined;
/** The review's target ids in config order, and the one this job captures. */
targets: readonly string[];
target: string;
/** Targets a split pays off most for take the sessions that do not divide evenly: foldables and large screens first. */
prefer?: (target: string) => number;
};
/**
* This job's share of the review's session ceiling: the ceiling divided over the targets, the remainder going to the
* preferred targets (foldables) in config order, and unused when there are none. Never below 1 (a side then captures after the other): under a ceiling below the
* number of targets, at most that many target jobs run at once (maxParallelTargets).
*/
export function sessionShare(input: SessionShareInput): number {
const count = Math.max(1, input.targets.length);
const ceiling = input.maxSessions ?? DEFAULT_MAX_SESSIONS;
const base = Math.floor(ceiling / count);
let remainder = ceiling - base * count;
// A session left over goes to a preferred target only; without one it stays unused (two targets of five: two each).
const ranked = input.targets.filter(id => (input.prefer?.(id) ?? 0) > 0)
.sort((a, b) => input.prefer!(b) - input.prefer!(a) || input.targets.indexOf(a) - input.targets.indexOf(b));
const extra = new Set<string>();
for (const id of ranked) { if (remainder <= 0) break; extra.add(id); remainder -= 1; }
return Math.max(1, base + (extra.has(input.target) ? 1 : 0));
}
/** How many target jobs one review runs at once: each needs a session, so never more than the ceiling. */
export function maxParallelTargets(maxSessions: number | undefined, targets: number): number {
return Math.max(1, Math.min(targets, maxSessions ?? DEFAULT_MAX_SESSIONS));
}
export type SidePlan = {
/** Whether head and base capture at the same time. */
concurrentSides: boolean;
/** The appearance passes of one side, each on its own session; one entry means the side keeps a single session. */
passes: readonly (readonly ColorScheme[])[];
};
/**
* How one target's job spends its share of sessions: both sides at once when it has two, and a side's appearance passes
* in separate sessions only when the pass moved out shortens the side by at least a minute (a session costs its fixed
* boot and install time, so a few routes are not worth one). Sessions the work cannot fill stay unused: the ceiling is
* a limit, not a target.
*/
export function planSideSessions(input: { share: number; sides: 1 | 2; routes: number; schemes: readonly ColorScheme[];
minSavingSeconds?: number; routeSeconds?: number; launchSeconds?: number }): SidePlan {
const minSaving = input.minSavingSeconds ?? SPLIT_MIN_SAVING_SECONDS, perRoute = input.routeSeconds ?? ROUTE_SECONDS, launch = input.launchSeconds ?? LAUNCH_SECONDS;
const concurrentSides = input.sides === 1 || input.share >= 2;
const perSide = Math.floor(input.share / (concurrentSides ? input.sides : 1));
const schemes = [...input.schemes];
const passSeconds = input.routes * perRoute + launch;
const splitAppearances = schemes.length > 1 && perSide >= schemes.length && passSeconds >= minSaving;
return { concurrentSides, passes: splitAppearances ? schemes.map(scheme => [scheme]) : [schemes] };
}
+2 -1
View File
@@ -196,7 +196,8 @@ export async function cleanupAfterCapture(options: { output: string; checkouts:
const environment = options.environment ?? process.env;
const result: { stopped: string[]; failures: Array<{ code: string; message: string; nextAction: string }> } = { stopped: [], failures: [] };
const sessionFiles: string[] = [];
for (const name of ["head-session", "base-session", "baseline-session"]) {
// A side that captures an appearance in a session of its own (capture.maxSessions) records it as `<side>-session-<scheme>`.
for (const name of ["head", "base", "baseline"].flatMap(side => ["", "-light", "-dark"].map(scheme => `${side}-session${scheme}`))) {
const path = resolve(options.output, name);
try { await lstat(path); sessionFiles.push(path); } catch { /* That side never started a session. */ }
}
+12 -6
View File
@@ -15,12 +15,13 @@ import { installCiFiles } from "../ci/workflow-install.js";
import { readRouteEntry } from "../ci/route-entry.js";
import { buildVerifiedPlan } from "../ci/verified-plan.js";
import { formatCaptureCheck, formatDoctorReport, referencedSecretNames, runCaptureCheck, runDoctor } from "../ci/doctor.js";
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, posedTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf, positiveInteger } from "./args.js";
import { help } from "./help.js";
import { CiError } from "../shared/ci-errors.js";
import { cleanupAfterCapture, findOptionalBaseline, resolveCompareRefs, resolvePullRequest, writeCaptureOutputs, writeStepOutputs } from "../ci/workflow-steps.js";
import { stderrProgress } from "../shared/progress.js";
import { maxParallelTargets } from "../ci/session-plan.js";
export async function doctor(): Promise<void> {
if (has("help")) return help();
@@ -159,10 +160,14 @@ export async function configPlatforms(): Promise<void> {
output({ ok: true, platforms: configTargets(config).map(target => target.id) });
}
/** The targets config.yaml captures, in order, with their platforms and labels: the review workflow's matrix. */
/**
* The targets config.yaml captures, in order, with their platforms and labels: the review workflow's matrix, and how
* many of its jobs run at once (`maxParallel`), since each needs a session of capture.maxSessions.
*/
export async function configTargetList(): Promise<void> {
const config = await readExploreConfig(flag("project") ?? process.cwd(), flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
output({ ok: true, targets: configTargets(config) });
const targets = configTargets(config);
output({ ok: true, targets, maxParallel: maxParallelTargets(config.capture.maxSessions, targets.length) });
}
async function exists(path: string): Promise<boolean> {
@@ -229,7 +234,7 @@ export async function captureReview(): Promise<void> {
// A matrix job names its target; its artifacts, report and comment section carry the target's id.
const named = selection.target !== undefined || selection.platform !== undefined;
const common = { ...(named ? { target: config.target!.id } : {}), ...(selection.platform ? { platform: selection.platform } : {}),
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), baseProject: required("base-project"), headProject,
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), baseProject: required("base-project"), headProject,
output: required("output"), config, configPath, progress: stderrProgress() };
const result = has("compare") ? await runCompareCi({ ...common, comparePath: required("compare") })
: await runPublicCi({ ...common, pullRequestPath: required("pull-request") });
@@ -240,8 +245,9 @@ export async function captureReview(): Promise<void> {
export async function captureBaseline(): Promise<void> {
const project = required("project");
const config = withRunOverrides(resolveTargetConfig(await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), targetSelection()), { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, progress: stderrProgress() }) });
const rawConfig = await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
const config = withRunOverrides(resolveTargetConfig(rawConfig, targetSelection()), { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), progress: stderrProgress() }) });
}
/** `capture` (or `capture:review`) `[--base REF] [--head REF | --committed]`: a local review, opened in the Viewer or hosted with --upload. */
+1 -1
View File
@@ -31,7 +31,7 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
machine, instead of EAS Simulator, and removes it afterwards (or set capture.simulator in config.yaml); builds
still run on EAS, and the host switches appearance for either controller; the app is repacked with the route
observer on this machine too (--repack eas, or capture.repack, keeps the hosted EAS job);
with targets in config.yaml it reviews them at once (--parallel N at most N at a time; the targets of a platform
with targets in config.yaml it reviews them at once, up to capture.maxSessions (--parallel N at most N at a time; the targets of a platform
share each commit's build), --target ID one of them, --platform those of a platform)
view [--catalog FILE] [--port N] [--no-open]
(opens a report in the Viewer)
+12 -1
View File
@@ -94,6 +94,11 @@ export type ExploreConfig = {
/** `exclude` names routes, as `requiresRoute` does, that stay in the map but are never captured. */
exploration: { scope: "changes" | "all"; exclude?: string[] };
capture: { maxMinutes: number; maxActions: number;
/**
* The most EAS Simulator sessions one review may run at once, across its targets and sides; absent:
* DEFAULT_MAX_SESSIONS (5). Below the number of targets, that many target jobs run at once, one session each.
*/
maxSessions?: number;
/** Where the route observer is bundled into the app, when the config chooses; captureRepack gives the default. */
repack?: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number;
/** The device controller; absent means agent-device, so configs that never chose one keep their cache recipes. */
@@ -295,7 +300,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
const exploration = optionalRecord(root.exploration, "exploration");
exactKeys(exploration, ["scope", "exclude"], "exploration");
const capture = optionalRecord(root.capture, "capture");
exactKeys(capture, ["maxMinutes", "maxActions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
exactKeys(capture, ["maxMinutes", "maxActions", "maxSessions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
const controller = literal(capture.controller, ["agent-device", "argent"] as const, "capture.controller", "agent-device");
const simulator = literal(capture.simulator, ["eas", "local"] as const, "capture.simulator", "eas");
const mode = literal(root.mode, ["deterministic", "agent"] as const, "mode", "deterministic");
@@ -342,6 +347,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
capture: {
maxMinutes: positiveInteger(capture.maxMinutes, "capture.maxMinutes", 30),
maxActions: positiveInteger(capture.maxActions, "capture.maxActions", 500),
...(capture.maxSessions === undefined ? {} : { maxSessions: positiveInteger(capture.maxSessions, "capture.maxSessions", 2) }),
...(capture.repack === undefined ? {} : { repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack") }),
appearance: parseAppearance(capture.appearance, "capture.appearance"),
launch: parseLaunchSetting(capture.launch, "capture.launch"),
@@ -440,6 +446,11 @@ export function configTargets(config: ExploreConfig): RunTarget[] {
label: target.label ?? `${target.device ?? (target.platform === config.app.platform ? config.device.name : DEFAULT_ANDROID_DEVICE)}${target.pose ? ` (${target.pose})` : ""}` }));
}
/** The targets with a device pose (foldables): they take the sessions `capture.maxSessions` does not divide evenly. */
export function posedTargets(config: ExploreConfig): string[] {
return Object.entries(config.targets ?? {}).filter(([, target]) => target.pose).map(([id]) => id);
}
/**
* The flat configuration capture consumes for one target, with `target` naming it. `--target` names one; `--platform`
* names the target of that platform, when only one has it; with neither, the config must have a single target.
+53 -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"];
}
@@ -164,6 +166,47 @@ export function homeIndicatorBandPercent(platform: "ios" | "android" | undefined
return HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM[platform ?? "ios"];
}
/**
* An area of a screenshot the system draws, in percent of the screenshot's width and height. A difference that
* lies entirely inside one is never an app change; the verdict leaves it out and the Viewer blurs it.
*/
export type SystemRegion = { kind: "status-bar" | "home-indicator"; x: number; y: number; width: number; height: number };
/**
* iPhone Duo (iOS 27) has no status bar across the top: its clock and Wi-Fi indicator stack in one pill in the
* right-hand rail, 28 points from the edge, lower on the outer (closed) panel than on the inner one. Measured on
* EAS Simulator captures of both panels; the pill is the same 40×64 points on each, only its top differs. The app's own
* rail controls start about 3% of the height below it on the outer panel, so the padding stays small.
*/
const DUO_PANELS = {
outer: { width: 466, height: 678, statusBar: { x: 398, y: 87, width: 40, height: 64 } },
inner: { width: 951, height: 669, statusBar: { x: 883, y: 34, width: 40, height: 64 } },
} as const;
const DUO_STATUS_BAR_PADDING_POINTS = 4;
const isFoldable = (platform: "ios" | "android" | undefined, device: string | undefined) => platform !== "android" && /\bduo\b/i.test(device ?? "");
/**
* The areas the verdict leaves out for a capture: the platform's status-bar band and, on iOS, its home-indicator
* band; on an iPhone foldable, the lit panel's status-bar pill instead of a top band. `pose` is the capture's device pose
* (closed lights the outer panel; open and half-open the inner one); a foldable with none boots closed.
*/
export function systemRegions(options: { platform?: "ios" | "android" | undefined; device?: string | undefined; pose?: string | undefined }): SystemRegion[] {
const regions: SystemRegion[] = [];
if (isFoldable(options.platform, options.device)) {
const panel = options.pose === "open" || options.pose === "half-open" ? DUO_PANELS.inner : DUO_PANELS.outer;
const pad = DUO_STATUS_BAR_PADDING_POINTS;
const percent = (value: number, of: number) => Math.round((value / of) * 10000) / 100;
regions.push({ kind: "status-bar",
x: percent(panel.statusBar.x - pad, panel.width), y: percent(panel.statusBar.y - pad, panel.height),
width: percent(panel.statusBar.width + 2 * pad, panel.width), height: percent(panel.statusBar.height + 2 * pad, panel.height) });
} else {
regions.push({ kind: "status-bar", x: 0, y: 0, width: 100, height: statusBarBandPercent(options.platform) });
}
const home = homeIndicatorBandPercent(options.platform);
if (home > 0) regions.push({ kind: "home-indicator", x: 0, y: 100 - home, width: 100, height: home });
return regions;
}
/** Deterministic pixel comparison of one surface's base and head screenshots. */
export type PublicVisualVerdict = {
verdict: "unchanged" | "modified" | "needs-review";
@@ -187,10 +230,12 @@ 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;
/** The system-drawn areas the verdict left out, present when a difference inside one was ignored. */
systemRegions?: SystemRegion[];
};
/**
* Evidence-based reviewer status. `status` on the surface stays source-derived because capture
@@ -248,6 +293,8 @@ export type PublicReview = {
statusBarBandPercent?: number;
/** The share of each screenshot's height, from the bottom, the verdict ignored as the home indicator. */
homeIndicatorBandPercent?: number;
/** Every system-drawn area the verdict leaves out of each screenshot; the bands above, or a foldable's rail pill. */
systemRegions?: SystemRegion[];
/** Every platform the config captures, so the Viewer can offer the sibling platform's report of the same run. */
platforms?: Array<"ios" | "android">;
/** The target this report captured; absent in reports from before targets, whose target is their platform. */
@@ -277,6 +324,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 {
+12 -2
View File
@@ -75,11 +75,17 @@ function assertReviewFields(surface: Surface, enforceComparisonEvidence: boolean
}
}
/** A region's move between the screenshots: finite, and small enough to be layout drift rather than another screen. */
/**
* The farthest a region may move between the screenshots, in screenshot pixels: within the largest screenshot a
* device takes (an element recentred on a wide display moves hundreds of pixels), not an unbounded number.
*/
const MAX_SHIFT = 8192;
/** A region's move between the screenshots: finite, and within a screenshot. */
function validShift(shift: unknown): boolean {
if (!shift || typeof shift !== "object") return false;
const { x, y } = shift as { x?: unknown; y?: unknown };
return typeof x === "number" && typeof y === "number" && Number.isFinite(x) && Number.isFinite(y) && Math.abs(x) <= 64 && Math.abs(y) <= 64;
return typeof x === "number" && typeof y === "number" && Number.isFinite(x) && Number.isFinite(y) && Math.abs(x) <= MAX_SHIFT && Math.abs(y) <= MAX_SHIFT;
}
function assertVisualVerdict(visual: PublicVisualVerdict, enforceComparisonEvidence: boolean, paired: boolean): void {
@@ -345,6 +351,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.
+9 -1
View File
@@ -4,7 +4,7 @@ import { createHash } from "node:crypto";
import { lstat, readFile, realpath } from "node:fs/promises";
import { isAbsolute, relative, resolve, sep } from "node:path";
import { assertDecodedPng } from "../shared/png-evidence.js";
import { assertAgentAcceptance, validateCapturePlan, type AppIconImage, type BundleLaunchCapture, type CaptureBundle, type CaptureOutcome, type CapturedImage, type LaunchFilmstrip, type LaunchFrame, type PublicLaunchSide, type PublicReview, homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
import { assertAgentAcceptance, validateCapturePlan, type AppIconImage, type BundleLaunchCapture, type CaptureBundle, type CaptureOutcome, type CapturedImage, type LaunchFilmstrip, type LaunchFrame, type PublicLaunchSide, type PublicReview, homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent, systemRegions, type SystemRegion } from "../contracts/capture.js";
import { COLOR_SCHEMES } from "../capture/appearance.js";
import { launchDirectory } from "../capture/launch-capture.js";
import { APP_ICON_FILE, APP_ICON_MAX_SIZE } from "../capture/app-icon.js";
@@ -263,11 +263,17 @@ export type CaptureReviewOptions = {
/** The target this report captures, and every target config.yaml captures (this one among them), when more than one. */
target?: RunTarget;
targets?: RunTarget[];
/**
* The system-drawn areas the verdict left out of each screenshot; absent, the platform's bands, as the assessment's
* default. A bundle does not record a foldable's pose, so its panel is not guessed here.
*/
systemRegions?: SystemRegion[];
};
/** 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)}`;
@@ -301,6 +307,7 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
runtime: { projectId: head.bundle.easProjectId ?? "", buildId: head.bundle.easBuildId ?? "", gitCommit: plan.headSha,
platform: head.bundle.platform ?? "ios", ...(head.bundle.controller === "argent" ? { controller: "argent" as const } : {}), statusBarBandPercent: statusBarBandPercent(head.bundle.platform),
...(homeIndicatorBandPercent(head.bundle.platform) > 0 ? { homeIndicatorBandPercent: homeIndicatorBandPercent(head.bundle.platform) } : {}),
systemRegions: (options.systemRegions ?? systemRegions({ platform: head.bundle.platform })).map((area) => ({ ...area })),
...(options.platforms && options.platforms.length > 1 ? { platforms: [...options.platforms] } : {}),
...(options.target ? { target: { ...options.target } } : {}),
...(options.targets && options.targets.length > 1 ? { targets: options.targets.map(target => ({ ...target })) } : {}),
@@ -341,6 +348,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 } : {}),
+265 -66
View File
@@ -1,6 +1,6 @@
import { unattributedIssue } from "../capture/health.js";
import { appearancePairs, bundleColorSchemes } from "../capture/appearance.js";
import { homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
import { appearancePairs, bundleColorSchemes, type ColorScheme } from "../capture/appearance.js";
import { launchSurfaceId, systemRegions as defaultSystemRegions, type SystemRegion } from "../contracts/capture.js";
import { readFileSync, statSync } from "node:fs";
import { stat } from "node:fs/promises";
import { isAbsolute, resolve } from "node:path";
@@ -26,8 +26,10 @@ 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 { measureRegionShifts } from "./region-shift.js";
import { STATUS_BAR_BAND_PERCENT, decodePng, differentPixelsInRect, maxColorDistance, type DecodedFrame } from "../shared/png-evidence.js";
import type { RegionMove, RegionShift } from "./region-shift.js";
import { measureRegionMovesInWorker } from "./region-shift-worker.js";
import { availableParallelism } from "node:os";
export const DEFAULT_VISUAL_THRESHOLD = 0.1;
export const DEFAULT_EVIDENCE_TIME_BUDGET_MS = 10 * 60_000;
@@ -142,16 +144,61 @@ function visualVerdict(assessment: VisualEvidenceAssessment, threshold: number):
};
}
type PublishedRegion = NonNullable<PublicVisualVerdict["regions"]>[number];
/** A region as published: the fields a review carries, without the comparison's own bookkeeping. */
function publishedRegion(region: VisualDiffRegion): PublishedRegion {
return { rect: region.rect, normalizedRect: region.normalizedRect, differentPixels: region.differentPixels,
shareOfDiffPercentage: region.shareOfDiffPercentage, dominantChange: region.dominantChange, location: region.location };
}
/**
* The regions to publish from every region the comparison found, given what moved: each region with its small
* shift, if one explains it, and each large move as one region in place of the regions it explains (where the
* content is now, their pixels and share, its location the region the content arrived in), largest share first.
* `allRegionsMoved` when every region, before any are left out, moved.
*/
export function publishMeasuredRegions(all: readonly VisualDiffRegion[], shifts: ReadonlyArray<RegionShift | undefined>,
moves: readonly RegionMove[], width: number, height: number): Pick<PublicVisualVerdict, "regions" | "allRegionsMoved"> {
const merged = new Set(moves.flatMap(move => move.members));
const percent = (value: number, total: number) => Math.round((value / total) * 10_000) / 100;
const regions: PublishedRegion[] = [
...all.flatMap((region, index) => {
if (merged.has(index)) return [];
const shift = shifts[index];
return [{ ...publishedRegion(region), ...(shift ? { shift } : {}) }];
}),
...moves.map(move => {
const members = move.members.map(index => all[index]!);
return {
rect: move.rect,
normalizedRect: { x: percent(move.rect.x, width), y: percent(move.rect.y, height), width: percent(move.rect.width, width), height: percent(move.rect.height, height) },
differentPixels: members.reduce((sum, region) => sum + region.differentPixels, 0),
// Each member's share is rounded, so their sum can pass 100; a share is at most the whole difference.
shareOfDiffPercentage: Math.min(100, Math.round(members.reduce((sum, region) => sum + region.shareOfDiffPercentage, 0) * 100) / 100),
dominantChange: "mixed", location: members[0]!.location, shift: move.shift,
};
}),
];
return {
regions: regions.sort((left, right) => right.shareOfDiffPercentage - left.shareOfDiffPercentage).slice(0, MAX_REGIONS),
...(regions.length > 0 && regions.every(region => region.shift) ? { allRegionsMoved: true as const } : {}),
};
}
/**
* The published regions with how far their content moved, where a move explains it: a layout that shifted by a
* device pixel reads as moved, not as changed. Every region the comparison found is measured, not only the ones
* published, so `allRegionsMoved` can say nothing else on the screen changed. A measurement that fails leaves the
* regions as they were.
* device pixel reads as moved, not as changed, and an element that moved further (a card recentred on a wider
* screen) reads as one moved region instead of the fragments the comparison split it into. Every region the
* comparison found is measured, not only the ones published, so `allRegionsMoved` can say nothing else on the
* screen changed. A measurement that fails leaves the regions as they were.
*/
async function withRegionShifts(basePath: string, headPath: string, all: readonly VisualDiffRegion[], published: NonNullable<PublicVisualVerdict["regions"]>):
Promise<Pick<PublicVisualVerdict, "regions" | "allRegionsMoved">> {
try {
const shifts = await measureRegionShifts(basePath, headPath, all.map(region => region.rect));
const { shifts, moves, width, height } = await measureRegionMovesInWorker(basePath, headPath,
all.map(region => ({ ...region.rect, dominantChange: region.dominantChange })));
if (moves.length) return publishMeasuredRegions(all, shifts, moves, width, height);
const shiftOf = new Map(all.map((region, index) => [region.rect, shifts[index]] as const));
return {
regions: published.map(region => {
@@ -171,31 +218,103 @@ export function ignoreStatusBar(measurement: ScreenshotDiffMeasurement, bandPerc
return { measurement: bands.measurement, ignored: bands.ignoredTop };
}
/**
* 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.
*/
export function ignoreSystemBands(measurement: ScreenshotDiffMeasurement, bands: { top: number; bottom: number }):
/** 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; }
};
}
/** `ignoreSystemRegions` for the plain case: a status-bar band across the top and a home-indicator band along the bottom. */
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 regions: SystemRegion[] = [
...(bands.top > 0 ? [{ kind: "status-bar" as const, x: 0, y: 0, width: 100, height: bands.top }] : []),
...(bands.bottom > 0 ? [{ kind: "home-indicator" as const, x: 0, y: 100 - bands.bottom, width: 100, height: bands.bottom }] : []),
];
const result = ignoreSystemRegions(measurement, regions, frames);
return { measurement: result.measurement, ignoredTop: result.ignoredStatusBar, ignoredBottom: result.ignoredHomeIndicator };
}
/**
* Leaves out of a measurement every diff region that lies inside a system-drawn area: the status bar (a band across
* the top of a phone, a pill in the rail of a foldable) and, on iOS, the home indicator at the bottom. Both differ
* between captures without the app having changed. A region that crosses the edge of a band across the whole width
* is clipped to the part outside 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, and across a pill's edge, such a region is kept whole.
* (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 ignoreSystemRegions(measurement: ScreenshotDiffMeasurement, system: readonly SystemRegion[], frames?: SystemBandFrameLoader):
{ measurement: ScreenshotDiffMeasurement; ignoredStatusBar: number; ignoredHomeIndicator: number } {
if (measurement.match || measurement.regions.length === 0 || system.length === 0) return { measurement, ignoredStatusBar: 0, ignoredHomeIndicator: 0 };
// agent-device rounds each of x, y, width and height to 0.01%, so an edge it reports can be up to 0.01% past the real one.
const slack = 0.015;
const inside = (region: VisualDiffRegion, area: SystemRegion) => {
const rect = region.normalizedRect;
return rect.x >= area.x - slack && rect.y >= area.y - slack
&& rect.x + rect.width <= area.x + area.width + slack && rect.y + rect.height <= area.y + area.height + slack;
};
const across = system.filter((area) => area.x <= slack && area.x + area.width >= 100 - slack);
const topBand = across.find((area) => area.y <= slack);
const bottomBand = across.find((area) => area !== topBand && area.y + area.height >= 100 - slack);
const crossesTop = (region: VisualDiffRegion) => topBand !== undefined && region.normalizedRect.y < topBand.y + topBand.height - slack;
const crossesBottom = (region: VisualDiffRegion) => bottomBand !== undefined && region.normalizedRect.y + region.normalizedRect.height > bottomBand.y + slack;
let loaded: SystemBandFrames | undefined | null = null;
const load = () => { if (loaded === null) loaded = frames?.() ?? undefined; return loaded; };
const ignored: Record<SystemRegion["kind"], number> = { "status-bar": 0, "home-indicator": 0 };
let ignoredPixels = 0;
const remaining: VisualDiffRegion[] = [];
for (const region of measurement.regions) {
const area = system.find((candidate) => inside(region, candidate));
if (area) { ignored[area.kind] += 1; ignoredPixels += region.differentPixels; continue; }
const top = crossesTop(region) ? topBand : undefined; const bottom = crossesBottom(region) ? bottomBand : undefined;
const decoded = top || bottom ? load() : undefined;
if (!decoded) { remaining.push(region); continue; }
const { height, width } = decoded.baseline;
const rect = { ...region.rect };
if (top) {
const bandRows = Math.floor((height * (top.y + top.height)) / 100);
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, height - Math.floor((height * bottom.height) / 100)) - 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 inBand = region.differentPixels - differentPixels;
if (differentPixels === 0) {
ignored[(top ?? bottom)!.kind] += 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 (inBand > 0) { if (top) ignored[top.kind] += 1; if (bottom) ignored[bottom.kind] += 1; }
ignoredPixels += inBand;
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, ignoredStatusBar: 0, ignoredHomeIndicator: 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,
ignoredStatusBar: ignored["status-bar"],
ignoredHomeIndicator: ignored["home-indicator"],
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,
},
};
}
@@ -289,6 +408,40 @@ function impactFor(surface: PlanSurface, presence: ComparatorSurfaceImpact["pres
};
}
/** The screenshot pairs `assessPublicEvidence` compares: both sides captured and landed, in the loop's order. */
function comparablePairs(options: { plan: SourceCapturePlan; base: PublicEvidenceSide; head: PublicEvidenceSide }, colorSchemes: readonly ColorScheme[],
baseColorSchemes: readonly ColorScheme[]): Array<{ id: string; basePath: string; headPath: string }> {
const pairs: Array<{ id: string; basePath: string; headPath: string }> = [];
for (const surface of options.plan.surfaces) {
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen" || (!surface.baseCapture && !surface.headCapture)) continue;
for (const { id, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
if (baseId === null) continue;
const basePath = localImagePath(options.base, baseId);
const headPath = localImagePath(options.head, id);
if (!basePath || !headPath || captureDiagnostic(surface, "base", options.base, baseId) || captureDiagnostic(surface, "head", options.head, id)) continue;
pairs.push({ id, basePath, headPath });
}
}
return pairs;
}
/** Runs tasks at most `size` at a time, each started in the order it was queued. */
function concurrencyLimit(size: number): <T>(task: () => Promise<T>) => Promise<T> {
let active = 0;
const queue: Array<() => void> = [];
const next = () => { if (active < size) queue.shift()?.(); };
return task => new Promise((resolve, reject) => {
queue.push(() => {
active += 1;
task().then(resolve, reject).finally(() => { active -= 1; next(); });
});
next();
});
}
/** The limit the reviews in this process share when none is given: a local review compares its targets at once. */
let processLimit: ReturnType<typeof concurrencyLimit> | undefined;
function localImagePath(side: PublicEvidenceSide, id: string): string | undefined {
const frame = side.bundle.images[id];
return frame ? localEvidencePath(side, frame.path) : undefined;
@@ -309,19 +462,21 @@ function localEvidencePath(side: PublicEvidenceSide, relativePath: string): stri
*/
export function decideReview(scope: SurfaceSourceScope, visual: PublicVisualVerdict, summary?: WhatChangedSummary): PublicSurfaceReview {
const facts = summary?.facts.map((fact) => ({ category: fact.category, templateId: fact.templateId, bullet: truncate(fact.bullet) })) ?? [];
const differs = visual.verdict === "modified" || facts.length > 0;
// Text that also differs between two captures of the same build is runtime state: listed, never what makes a change.
const changes = facts.filter((fact) => fact.templateId !== "visible-text.unstable-within-build");
const differs = visual.verdict === "modified" || changes.length > 0;
const inconclusive = !differs && (visual.verdict === "needs-review" || Boolean(summary?.needsReview));
const issue = summary?.reviewIssues[0]?.reason;
const evidenceText = facts[0]?.bullet ?? visualDescription(visual);
const evidenceText = changes[0]?.bullet ?? visualDescription(visual);
if (scope === "none") {
if (!differs) return { status: "unchanged", description: "No visible change" };
// The comparator's generic visual fact reads as a styling change; a variant names what differs.
const state = facts.find((fact) => fact.category !== "visual")?.bullet
const state = [...changes, ...facts].find((fact) => fact.category !== "visual")?.bullet
?? `${percentage(visual.mismatchPercentage)}${visual.regions?.[0]?.location ? ` · ${visual.regions[0].location}` : ""}`;
return { status: "variant", description: truncate(`Runtime state differs: ${state}`), ...(facts.length ? { facts } : {}) };
}
if (differs) {
const description = !facts.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
const description = !changes.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
return { status: "modified", description: truncate(description), ...(facts.length ? { facts } : {}) };
}
if (inconclusive) {
@@ -369,6 +524,8 @@ function captureDiagnostic(surface: PlanSurface, side: "base" | "head", evidence
export async function assessPublicEvidence(options: {
/** The captured platform; its status bar band is left out of the visual verdict. Absent: iOS. */
platform?: "ios" | "android";
/** The system-drawn areas left out of the visual verdict; absent, the platform's bands. */
systemRegions?: SystemRegion[];
plan: SourceCapturePlan;
base: PublicEvidenceSide;
head: PublicEvidenceSide;
@@ -378,8 +535,11 @@ export async function assessPublicEvidence(options: {
timeBudgetMs?: number;
now?: () => number;
measure?: (baselinePath: string, currentPath: string) => Promise<ScreenshotDiffMeasurement>;
/** How many screenshot pairs compare at once. Absent: one per available CPU, shared by every review in this process. */
concurrency?: number;
}): Promise<PublicEvidenceResult> {
const threshold = options.threshold ?? DEFAULT_VISUAL_THRESHOLD;
const system = options.systemRegions ?? defaultSystemRegions({ platform: options.platform });
const now = options.now ?? Date.now;
const deadline = now() + (options.timeBudgetMs ?? DEFAULT_EVIDENCE_TIME_BUDGET_MS);
const surfaces: Record<string, PublicSurfaceAssessment> = {};
@@ -395,6 +555,34 @@ export async function assessPublicEvidence(options: {
const measure = options.measure ?? (async (baselinePath: string, currentPath: string) => (
await diffScreenshots({ baselinePath, currentPath, command: options.agentDeviceCommand, threshold })
));
type ComparedPair = { visual: PublicVisualVerdict; assessment: VisualEvidenceAssessment };
/** One pair's measurement, verdict and region moves: the work that runs ahead of the surface loop. */
const comparePair = async (basePath: string, headPath: string): Promise<ComparedPair> => {
const raw = await measure(basePath, headPath);
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
const assessment = assessVisualMeasurements({
baselineSamples: 1,
currentSamples: 1,
requiredSamples: 1,
baselineWithin: [],
currentWithin: [],
crossBuild: [measurement],
representative: measurement,
});
const visual = visualVerdict(assessment, threshold);
// Measuring moves is extra: once the comparison budget is spent, regions go out unmeasured.
if (visual.verdict === "modified" && visual.regions?.length && now() <= deadline) {
Object.assign(visual, await withRegionShifts(basePath, headPath, measurement.regions, visual.regions));
}
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
return { visual, assessment };
};
/** A pair compared if the budget has not expired when its turn to start comes; undefined when it has. */
const compareInBudget = async (basePath: string, headPath: string): Promise<ComparedPair | undefined> => (
now() > deadline ? undefined : await comparePair(basePath, headPath)
);
const visualCounts = { compared: 0, modified: 0, unchanged: 0, needsReview: 0, failed: 0, errors: [] as string[] };
const accessibilityCounts = { compared: 0, described: 0, failed: 0, skipped: 0, errors: [] as string[] };
const reviewCounts = { modified: 0, needsReview: 0, variants: 0, unchanged: 0 };
@@ -411,6 +599,20 @@ export async function assessPublicEvidence(options: {
const colorSchemes = bundleColorSchemes(options.head.bundle);
const baseColorSchemes = bundleColorSchemes(options.base.bundle);
// The pairs the loop below compares start now, a few at a time: each is a comparator process and a pixel search
// that take seconds on a large screenshot, so they overlap instead of queueing behind one another. The loop reads
// them in its own order, so the result does not depend on which finishes first. A pair whose turn comes after the
// budget expired is not started; one started in time is waited for and used.
const ahead = new Map<string, Promise<ComparedPair | undefined>>();
if (visualAvailable) {
const limit = options.concurrency !== undefined ? concurrencyLimit(Math.max(1, Math.floor(options.concurrency)))
: processLimit ??= concurrencyLimit(availableParallelism());
for (const { id, basePath, headPath } of comparablePairs(options, colorSchemes, baseColorSchemes)) {
const started = limit(() => compareInBudget(basePath, headPath));
started.catch(() => undefined);
ahead.set(id, started);
}
}
for (const surface of options.plan.surfaces) {
for (const side of ["base", "head"] as const) {
if (!surface[`${side}Capture`] || surface[`${side}Surface`]?.kind !== "screen") continue;
@@ -439,7 +641,19 @@ export async function assessPublicEvidence(options: {
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen"
|| (!surface.baseCapture && !surface.headCapture)) continue;
// Every appearance the capture rendered is compared like-for-like: `<id>@<scheme>` frames against each other.
for (const { id, scheme, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
const pairs = appearancePairs(surface.id, colorSchemes, baseColorSchemes);
// The screen's other appearances, rendered by both builds and verified on both: a label that varies between a
// build's own appearances is runtime state. An unverified capture may show another screen, so it is no evidence.
const baseRoute = surface.baseSurface, headRoute = surface.headSurface;
const siblings = (current: string) => pairs.flatMap((pair) => {
if (pair.id === current || pair.baseId === null || captureDiagnostic(surface, "base", options.base, pair.baseId)
|| captureDiagnostic(surface, "head", options.head, pair.id)) return [];
try {
return [{ base: matchedSide("base", options.base, { ...baseRoute, id: pair.baseId }, options.profile),
head: matchedSide("head", options.head, { ...headRoute, id: pair.id }, options.profile) }];
} catch { return []; }
});
for (const { id, scheme, baseId } of pairs) {
// An appearance the base never rendered has nothing to compare against: the head frame is new evidence.
if (baseId === null) {
if (localImagePath(options.head, id)) {
@@ -464,47 +678,29 @@ export async function assessPublicEvidence(options: {
continue;
}
let visual: PublicVisualVerdict;
let assessment: VisualEvidenceAssessment | undefined;
if (now() > deadline) {
let compared: ComparedPair | undefined;
try {
compared = await (ahead.get(id) ?? compareInBudget(basePath, headPath));
} catch (error) {
visualCounts.failed += 1;
const diagnostic = comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
message: "Screenshot comparison failed.", nextAction: "Check the screenshot files and the agent-device comparison diagnostics, then rerun comparison.", retryable: true });
recordError(visualCounts.errors, id, diagnostic.message);
continue;
}
if (!compared) {
visualCounts.failed += 1;
const diagnostic = comparisonError(id, undefined, { code: "VISUAL_COMPARISON_BUDGET_EXHAUSTED", stage: "compare",
message: "The time budget expired before screenshot comparison.",
nextAction: "Increase the evidence comparison time budget or reduce the number of selected routes, then rerun comparison.", retryable: true });
recordError(visualCounts.errors, id, diagnostic.message);
continue;
} else {
try {
const raw = await measure(basePath, headPath);
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
assessment = assessVisualMeasurements({
baselineSamples: 1,
currentSamples: 1,
requiredSamples: 1,
baselineWithin: [],
currentWithin: [],
crossBuild: [measurement],
representative: measurement,
});
visual = visualVerdict(assessment, threshold);
// Measuring moves is extra: once the comparison budget is spent, regions go out unmeasured.
if (visual.verdict === "modified" && visual.regions?.length && now() <= deadline) {
Object.assign(visual, await withRegionShifts(basePath, headPath, measurement.regions, visual.regions));
}
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
visualCounts.compared += 1;
if (visual.verdict === "modified") visualCounts.modified += 1;
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
else visualCounts.needsReview += 1;
} catch (error) {
visualCounts.failed += 1;
const diagnostic = comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
message: "Screenshot comparison failed.", nextAction: "Check the screenshot files and the agent-device comparison diagnostics, then rerun comparison.", retryable: true });
recordError(visualCounts.errors, id, diagnostic.message);
continue;
}
}
const { visual, assessment } = compared;
visualCounts.compared += 1;
if (visual.verdict === "modified") visualCounts.modified += 1;
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
else visualCounts.needsReview += 1;
const scope = surfaceSourceScope(surface) ?? "none";
let review: PublicSurfaceReview | undefined;
@@ -515,6 +711,7 @@ export async function assessPublicEvidence(options: {
base: matchedSide("base", options.base, { ...surface.baseSurface, id: baseId }, options.profile),
head: matchedSide("head", options.head, { ...surface.headSurface, id }, options.profile),
visualAssessment: assessment,
siblings: siblings(id),
});
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
accessibilityCounts.compared += 1;
@@ -544,11 +741,13 @@ 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, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, 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;
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
surfaces[id] = { visual };
} catch (error) {
comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
+114 -8
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 = {
@@ -70,6 +70,11 @@ export type CommonSurfaceComparatorInput = {
visualAssessment: VisualEvidenceAssessment;
/** Explicit stable runtime scope; semantic meaning is never inferred from diff pixels. */
visualScope?: VisualReviewerChange["scope"];
/**
* The screen's other appearances, captured and verified on both builds. A label that varies between each build's own
* captures, in the words that differ between the builds, is runtime state, and its difference is reported as such.
*/
siblings?: readonly { base: MatchedSurfaceSide; head: MatchedSurfaceSide }[];
};
export type EvidenceComparatorInput =
@@ -139,6 +144,7 @@ const CHANGE_PRIORITY: Record<SupportedReviewerChange["kind"], number> = {
"element-added": 20,
"element-removed": 20,
"visible-text-changed": 30,
"unstable-text": 35,
"action-target-changed": 40,
"accessibility-label-changed": 50,
"accessibility-role-changed": 50,
@@ -772,10 +778,76 @@ function actionTarget(side: ResolvedSide, element: ObservedElement): ActionTarge
return target ? { kind: "target", target } : { kind: "none", evidenceRefs: [] };
}
type ResolvedSibling = { base: ResolvedSide; head: ResolvedSide };
function resolveSiblings(input: CommonSurfaceComparatorInput, requiredSamples: 1 | 3): ResolvedSibling[] {
const resolve = (side: "base" | "head", sibling: MatchedSurfaceSide) => {
const screenId = sibling.map.observations.find((candidate) => candidate.id === sibling.observationId)?.screenId;
const resolution = screenId === undefined ? undefined : resolveSide(side, sibling, { ...input.impact, id: screenId }, requiredSamples);
// A sibling is evidence only when it resolves as cleanly as a comparison would.
return resolution?.kind === "resolved" && resolution.side.issues.length === 0 ? resolution.side : undefined;
};
return (input.siblings ?? []).flatMap((sibling) => {
const base = resolve("base", sibling.base);
const head = resolve("head", sibling.head);
return base && head ? [{ base, head }] : [];
});
}
function sameBounds(left: ElementBounds | undefined, right: ElementBounds | undefined): boolean {
return !!left && !!right && left.x === right.x && left.y === right.y && left.width === right.width && left.height === right.height;
}
/** The element at the same place in another capture: the one of its role with its identifier or, without one, its bounds. */
function counterpart(element: ObservedElement, other: ResolvedSide): ObservedElement | undefined {
const identifier = compact(element.identifier ?? "");
const bounds = boundsOf(element);
const candidates = other.elements.filter((candidate) => candidate.role === element.role && (identifier
? compact(candidate.identifier ?? "") === identifier
: !compact(candidate.identifier ?? "") && sameBounds(bounds, boundsOf(candidate))));
return candidates.length === 1 ? candidates[0] : undefined;
}
/** The word positions at which two labels differ, or undefined when they have different numbers of words. */
function changedWords(left: string, right: string): number[] | undefined {
const leftWords = left.split(" ");
const rightWords = right.split(" ");
return leftWords.length === rightWords.length
? leftWords.flatMap((word, index) => word === rightWords[index] ? [] : [index])
: undefined;
}
/**
* What the head showed in its other appearance, when a label's difference between the builds is runtime state: each
* build shows the label differently in its own two appearances, the other appearance differs between the builds too,
* and every word that differs between the builds is one that varies within a build. A label that follows the
* appearance ("Switch to dark mode") does not vary within a build that broke it, or keeps a word that changed, so
* its change is still a change.
*/
function unstableWithin(base: ObservedElement, head: ObservedElement, siblings: readonly ResolvedSibling[]): string | undefined {
const baseLabel = compact(base.label);
const headLabel = compact(head.label);
for (const sibling of siblings) {
const baseOther = compact(counterpart(base, sibling.base)?.label ?? "");
const headOther = compact(counterpart(head, sibling.head)?.label ?? "");
if (!baseLabel || !headLabel || !baseOther || !headOther) continue;
const withinBase = changedWords(baseLabel, baseOther);
const withinHead = changedWords(headLabel, headOther);
const across = changedWords(baseLabel, headLabel);
const acrossOther = changedWords(baseOther, headOther);
if (!withinBase?.length || !withinHead?.length || !across?.length || !acrossOther?.length) continue;
const varying = new Set([...withinBase, ...withinHead]);
if ([...across, ...acrossOther].every((index) => varying.has(index))) return headOther;
}
return undefined;
}
function comparePair(
pair: ElementPair,
base: ResolvedSide,
head: ResolvedSide,
/** What the head showed in its other appearance when this element's label is runtime state. */
within?: string,
): { facts: SupportedInput[]; issues: IssueInput[] } {
const facts: SupportedInput[] = [];
const issues: IssueInput[] = [];
@@ -784,6 +856,10 @@ function comparePair(
const headLabel = compact(pair.head.label);
const baseAnnotation = base.annotationsByElementId.get(pair.base.elementId);
const headAnnotation = head.annotationsByElementId.get(pair.head.elementId);
// Runtime state replaces a label change only where the label comparison itself holds: provenance still decides first.
const labelChange = (change: SupportedReviewerChange): SupportedReviewerChange => within
? { kind: "unstable-text", subjectRole: reviewerRole(pair.head.role), before: baseLabel, after: headLabel, within }
: change;
if (baseLabel !== headLabel) {
if (baseAnnotation && headAnnotation) {
@@ -793,14 +869,14 @@ function comparePair(
} else if (!baseLabel || !headLabel) {
issues.push(inconclusive("Visible-title comparison is missing before or after text.", refs));
} else {
facts.push(supported({
facts.push(supported(labelChange({
kind: "visible-text-changed",
subjectRole: subject.subjectRole,
subjectLabel: subject.subjectLabel,
textKind: pair.head.role === "button" ? "title" : "label",
before: baseLabel,
after: headLabel,
}, refs));
}), refs));
}
} else if (baseAnnotation || headAnnotation) {
issues.push(inconclusive(
@@ -810,12 +886,12 @@ function comparePair(
} else if (!baseLabel || !headLabel) {
issues.push(inconclusive("Accessibility label comparison is missing before or after text.", refs));
} else {
facts.push(supported({
facts.push(supported(labelChange({
kind: "accessibility-label-changed",
subjectRole: reviewerRole(pair.head.role),
before: baseLabel,
after: headLabel,
}, refs));
}), refs));
}
}
if (pair.base.role !== pair.head.role) {
@@ -925,11 +1001,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,
@@ -1101,6 +1186,27 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
gone = base.elements.filter(element => content(element, headWords));
arrived = head.elements.filter(element => content(element, baseWords));
}
// Text without an identifier is matched by its label, so a label that changed on its own leaves as one element and
// arrives as another: the one of its role at the same place on both sides is runtime state when its label is.
const siblings = mixedBackends ? [] : resolveSiblings(input, input.impact.baseSamples);
const runtimeText = { base: new Set<string>(), head: new Set<string>() };
for (const removed of siblings.length ? specificByLabel(gone) : []) {
const added = counterpart(removed, head);
if (!added || !arrived.includes(added) || counterpart(added, base) !== removed) continue;
const within = unstableWithin(removed, added, siblings);
if (!within) continue;
runtimeText.base.add(compact(removed.label));
runtimeText.head.add(compact(added.label));
facts.push(supported({
kind: "unstable-text",
subjectRole: reviewerRole(added.role),
before: compact(removed.label),
after: compact(added.label),
within,
}, [elementRef("base", removed), elementRef("head", added)]));
}
gone = gone.filter((element) => !runtimeText.base.has(compact(element.label)));
arrived = arrived.filter((element) => !runtimeText.head.has(compact(element.label)));
for (const element of outermost(specificByLabel(gone))) {
const label = compact(element.label);
if (!label) {
@@ -1132,7 +1238,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
}
}
for (const pair of pairing.pairs) {
const comparison = comparePair(pair, base, head);
const comparison = comparePair(pair, base, head, unstableWithin(pair.base, pair.head, siblings));
facts.push(...comparison.facts);
issues.push(...comparison.issues);
}
@@ -1145,7 +1251,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
const visual = visualFact(input, base, head);
// Pixels always move when an element appears or its text changes. The generic styling line
// only informs when nothing in the accessibility tree accounts for the difference.
const explained = facts.length > 0 && input.visualScope?.kind !== "landmark";
const explained = facts.some((fact) => fact.change.kind !== "unstable-text") && input.visualScope?.kind !== "landmark";
if (visual.fact && !explained) facts.push(visual.fact);
if (visual.issue) issues.push(visual.issue);
+33
View File
@@ -0,0 +1,33 @@
import { Worker, isMainThread, parentPort, workerData } from "node:worker_threads";
import { measureRegionMoves, type Rect } from "./region-shift.js";
type MeasuredRegions = Awaited<ReturnType<typeof measureRegionMoves>>;
type RegionMoveWork = { regionMoveWork: true; basePath: string; headPath: string; regions: ReadonlyArray<Rect & { dominantChange?: string }> };
type RegionMoveReply = { measured: MeasuredRegions } | { error: string };
/**
* Measures region shifts and large moves on a worker thread, so several screenshot pairs search at once while the
* main thread stays free: the search is CPU-bound and takes seconds on a tablet-sized screenshot. Falls back to the
* calling thread when no worker can start.
*/
export async function measureRegionMovesInWorker(basePath: string, headPath: string, regions: RegionMoveWork["regions"]): Promise<MeasuredRegions> {
const work: RegionMoveWork = { regionMoveWork: true, basePath, headPath, regions };
let worker: Worker;
try { worker = new Worker(new URL("./region-shift-worker.js", import.meta.url), { workerData: work }); }
catch { return measureRegionMoves(basePath, headPath, regions); }
return new Promise((resolve, reject) => {
let settled = false;
const finish = (outcome: () => void) => { if (!settled) { settled = true; outcome(); } };
worker.once("message", (reply: RegionMoveReply) => finish(() => "error" in reply ? reject(new Error(reply.error)) : resolve(reply.measured)));
// A worker that fails to load or dies before answering is a worker that did not start: the calling thread measures.
worker.once("error", () => finish(() => resolve(measureRegionMoves(basePath, headPath, regions))));
worker.once("exit", () => finish(() => resolve(measureRegionMoves(basePath, headPath, regions))));
});
}
if (!isMainThread && parentPort && (workerData as Partial<RegionMoveWork> | null)?.regionMoveWork === true) {
const port = parentPort;
const work = workerData as RegionMoveWork;
measureRegionMoves(work.basePath, work.headPath, work.regions)
.then(measured => port.postMessage({ measured } satisfies RegionMoveReply), (error: unknown) => port.postMessage({ error: (error as Error).message } satisfies RegionMoveReply));
}
+304 -8
View File
@@ -4,7 +4,7 @@ import type { DecodedFrame } from "../shared/png-evidence.js";
/** How far a region's content moved from Before to After, in screenshot pixels (right and down are positive). */
export type RegionShift = { x: number; y: number };
type Rect = { x: number; y: number; width: number; height: number };
export type Rect = { x: number; y: number; width: number; height: number };
/**
* The farthest a region is searched for, in screenshot pixels: layout drift, not a different screen. Drift adds up
@@ -63,13 +63,38 @@ function at(source: Image, x: number, y: number, channel?: number): number {
return value(x0, y0) * (1 - fx) * (1 - fy) + value(x1, y0) * fx * (1 - fy) + value(x0, y1) * (1 - fx) * fy + value(x1, y1) * fx * fy;
}
/** How badly After's region matches Before shifted by (sx, sy). */
function mismatch(base: Image, head: Image, rect: Rect, sx: number, sy: number): number {
/**
* How badly After's region matches Before shifted by (sx, sy): the summed luminance difference, row by row. A sum
* that passes `limit` stops early and returns a value above it: such a fit is neither the best, nor a tie, nor an
* ambiguity, so its exact error is never read. Whole-pixel shifts read the pixel directly (the bilinear weights are
* exactly 1 and 0 there); fractional ones interpolate like `at`.
*/
function mismatch(base: Image, head: Image, rect: Rect, sx: number, sy: number, limit = Infinity): number {
const { width, height, luminance } = base;
const maxX = width - 1, maxY = height - 1;
const headLuminance = head.luminance, headWidth = head.width;
const whole = Number.isInteger(sx) && Number.isInteger(sy);
let error = 0;
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
error += Math.abs(at(base, x - sx, y - sy) - head.luminance[y * head.width + x]!);
const headRow = y * headWidth;
if (whole) {
const row = Math.min(maxY, Math.max(0, y - sy)) * width;
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
error += Math.abs(luminance[row + Math.min(maxX, Math.max(0, x - sx))]! - headLuminance[headRow + x]!);
}
} else {
const cy = Math.min(maxY, Math.max(0, y - sy));
const y0 = Math.floor(cy), y1 = Math.min(maxY, y0 + 1), fy = cy - y0;
const row0 = y0 * width, row1 = y1 * width;
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
const cx = Math.min(maxX, Math.max(0, x - sx));
const x0 = Math.floor(cx), x1 = Math.min(maxX, x0 + 1), fx = cx - x0;
const sample = luminance[row0 + x0]! * (1 - fx) * (1 - fy) + luminance[row0 + x1]! * fx * (1 - fy)
+ luminance[row1 + x0]! * (1 - fx) * fy + luminance[row1 + x1]! * fx * fy;
error += Math.abs(sample - headLuminance[headRow + x]!);
}
}
if (error > limit) return error;
}
return error;
}
@@ -110,18 +135,29 @@ function regionShift(base: Image, head: Image, region: Rect): RegionShift | unde
const unshifted = mismatch(base, head, rect, 0, 0);
if (unshifted === 0) return undefined;
// Whole pixels first, every pixel counting: sampling every other row aliases on thin shapes (text, hairlines).
// A fit worse than the best so far by more than the ambiguity margin cannot become the best, tie with it, or make
// it ambiguous; its measurement stops as soon as that is known. The margin is taken from the worst fit the tie
// could choose, since a tie goes to the smallest move, not the least error.
const whole: Fit[] = [];
let least = unshifted;
for (let sy = -MAX_SHIFT_Y; sy <= MAX_SHIFT_Y; sy += 1) {
for (let sx = -MAX_SHIFT_X; sx <= MAX_SHIFT_X; sx += 1) whole.push({ sx, sy, error: mismatch(base, head, rect, sx, sy) });
for (let sx = -MAX_SHIFT_X; sx <= MAX_SHIFT_X; sx += 1) {
const error = sx === 0 && sy === 0 ? unshifted : mismatch(base, head, rect, sx, sy, (least * TIE + 1e-6) * AMBIGUOUS + 1e-6);
least = Math.min(least, error);
whole.push({ sx, sy, error });
}
}
const coarse = bestOf(whole);
if (whole.some(fit => Math.abs(fit.sy - coarse.sy) >= 2 && fit.error <= coarse.error * AMBIGUOUS + 1e-6)) return undefined;
// Then sixths of a pixel around it, from whole-number steps so a move up and a move down round alike.
const fine: Fit[] = [];
least = coarse.error;
for (let iy = -STEPS_PER_PIXEL; iy <= STEPS_PER_PIXEL; iy += 1) {
for (let ix = -STEPS_PER_PIXEL; ix <= STEPS_PER_PIXEL; ix += 1) {
const sx = coarse.sx + ix / STEPS_PER_PIXEL, sy = coarse.sy + iy / STEPS_PER_PIXEL;
fine.push({ sx, sy, error: ix === 0 && iy === 0 ? coarse.error : mismatch(base, head, rect, sx, sy) });
const error = ix === 0 && iy === 0 ? coarse.error : mismatch(base, head, rect, sx, sy, least * TIE + 1e-6);
least = Math.min(least, error);
fine.push({ sx, sy, error });
}
}
const best = bestOf(fine);
@@ -141,10 +177,270 @@ export function regionShifts(baseFrame: DecodedFrame, headFrame: DecodedFrame, r
return regions.map(region => regionShift(base, head, region));
}
/**
* A move too large for the drift search: content that left one area and arrived in another, such as a card that
* went from the left of a wide sheet to its centre. `rect` is where the moved content is in After, `shift` how far it
* went, and `members` the regions it explains (indices into the regions measured), the region it arrived in first.
*/
export type RegionMove = { rect: Rect; shift: RegionShift; members: number[] };
type Axis = "x" | "y";
/** How alike two regions' extents across the move must be to be one element's two ends: overlap and size. */
const PAIR_OVERLAP = 0.8;
const PAIR_SIZE = 0.25;
/** Rows (or columns) sampled for the brightness profiles that estimate a large move: every second one is plenty. */
const PROFILE_STEP = 2;
/** Another local best this close to the best makes a large move ambiguous: repeating content (a grid, a list). */
const AMBIGUOUS_LARGE = 1.05;
/** The share of the arrived region the move must explain, as for a small move. */
const MIN_EXPLAINED_LARGE = MIN_EXPLAINED;
/** After aligning by the move, at most this share of a region may still differ strongly (antialiased edges). */
const CHANGED_SHARE = 0.001;
/** How far across the move a large one may also drift, as layout below a moved element does; ties keep it in line. */
const ACROSS_OFFSETS = [0, -1, 1, -2, 2, -3, 3];
/**
* Blocks that give something drawn away, where every pixel differs by more than `channel` in some channel: a 2×2
* block of strongly different pixels (an icon, a badge, a mark), or a 4×4 block of moderately different ones (a
* tint, a low-contrast label, a grey badge). Antialiased edges and hairlines against another backdrop are thinner:
* the chevrons in euxy's Patterns rows (brentvatne/euxy#163) cross a curve that differs by up to 69 in 3×3 blocks
* but only 26 in 4×4 ones, while a grey "Off" label the move did not bring differs by 55 in 4×4 blocks.
*/
const SOLID_BLOCKS = [{ size: 2, channel: CHANGED_CHANNEL }, { size: 4, channel: 40 }];
const extent = (rect: Rect, axis: Axis) => axis === "x" ? { start: rect.x, size: rect.width } : { start: rect.y, size: rect.height };
const across = (axis: Axis): Axis => axis === "x" ? "y" : "x";
const shiftAlong = (axis: Axis, along: number, other = 0): RegionShift => axis === "x" ? { x: along, y: other } : { x: other, y: along };
/** Whether two regions could be one element's two ends of a move along `axis`: side by side, alike across it. */
function pairAlong(a: Rect, b: Rect, axis: Axis): boolean {
const ea = extent(a, axis), eb = extent(b, axis), ca = extent(a, across(axis)), cb = extent(b, across(axis));
const separate = ea.start + ea.size <= eb.start || eb.start + eb.size <= ea.start;
const overlap = Math.min(ca.start + ca.size, cb.start + cb.size) - Math.max(ca.start, cb.start);
const alike = Math.abs(ea.size - eb.size) <= PAIR_SIZE * Math.max(ea.size, eb.size);
return separate && alike && overlap >= PAIR_OVERLAP * Math.min(ca.size, cb.size);
}
/** Mean luminance along `axis` of a band across it: one value per column (axis x) or row (axis y). */
function profile(source: Image, axis: Axis, bandStart: number, bandEnd: number): Float32Array {
const length = axis === "x" ? source.width : source.height;
const values = new Float32Array(length);
for (let position = 0; position < length; position += 1) {
let sum = 0, count = 0;
for (let other = bandStart; other < bandEnd; other += PROFILE_STEP) {
sum += axis === "x" ? source.luminance[other * source.width + position]! : source.luminance[position * source.width + other]!;
count += 1;
}
values[position] = count ? sum / count : 0;
}
return values;
}
/**
* Whether a region holds something drawn: a solid block (SOLID_BLOCKS), or more than `allowed` strongly different
* pixels anywhere. `difference` is how much the pixel at (x, y) differs, in its most different channel.
*/
function drawnIn(rect: Rect, difference: (x: number, y: number) => number, allowed = Infinity): boolean {
// Per block: how many pixels differ in a row up to here, and for each column, how many rows have such a run.
const blocks = SOLID_BLOCKS.map(block => ({ ...block, run: 0, rows: new Uint32Array(rect.width) }));
let strong = 0;
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
for (const block of blocks) block.run = 0;
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
const value = difference(x, y), column = x - rect.x;
if (value > CHANGED_CHANNEL && ++strong > allowed) return true;
for (const block of blocks) {
block.run = value > block.channel ? block.run + 1 : 0;
block.rows[column] = block.run >= block.size ? block.rows[column]! + 1 : 0;
if (block.rows[column]! >= block.size) return true;
}
}
}
return false;
}
/**
* Whether, aligned by an integer move, some of the region still differs: content that changed, not only moved. A
* whole-pixel move copies the pixels, so only a sliver may differ strongly (antialiased edges against another
* backdrop, never more than CHANGED_SHARE of the region), and never a solid block. Pixels the move brings in from
* off screen differ.
*/
function changedAfterLargeMove(base: Image, head: Image, rect: Rect, sx: number, sy: number): boolean {
return drawnIn(rect, (x, y) => {
const bx = x - sx, by = y - sy;
if (bx < 0 || by < 0 || bx >= base.width || by >= base.height) return 255;
const h = (y * head.width + x) * 4, b = (by * base.width + bx) * 4;
return Math.max(Math.abs(base.frame.data[b]! - head.frame.data[h]!), Math.abs(base.frame.data[b + 1]! - head.frame.data[h + 1]!),
Math.abs(base.frame.data[b + 2]! - head.frame.data[h + 2]!));
}, Math.max(CHANGED_PIXELS, rect.width * rect.height * CHANGED_SHARE));
}
/** How much of a region's difference an integer move explains: 1 is all of it, 0 none. `unshifted` is the region's own. */
function explained(base: Image, head: Image, rect: Rect, shift: RegionShift, unshifted = mismatch(base, head, rect, 0, 0)): number {
return unshifted === 0 ? 0 : 1 - mismatch(base, head, rect, shift.x, shift.y) / unshifted;
}
/** Whether a region's content, moved by `shift`, is the same in After: explained, and nothing changed in it. */
function movedIntact(base: Image, head: Image, rect: Rect, shift: RegionShift): boolean {
return rect.width > 0 && rect.height > 0 && explained(base, head, rect, shift) >= MIN_EXPLAINED_LARGE
&& !changedAfterLargeMove(base, head, rect, shift.x, shift.y);
}
/**
* Whether a part of After where content left is plain backdrop: the colour around it (the median of the pixels just
* outside it, not in the moved content's `outline`), with nothing drawn on it. A part with nothing around it is not.
*/
function plain(head: Image, rect: Rect, outline: Rect): boolean {
if (rect.width <= 0 || rect.height <= 0) return true;
const around: number[][] = [[], [], []];
const add = (x: number, y: number) => {
if (x < 0 || y < 0 || x >= head.width || y >= head.height) return;
if (x >= outline.x && y >= outline.y && x < outline.x + outline.width && y < outline.y + outline.height) return;
for (let channel = 0; channel < 3; channel += 1) around[channel]!.push(head.frame.data[(y * head.width + x) * 4 + channel]!);
};
for (let x = rect.x - 1; x <= rect.x + rect.width; x += 1) { add(x, rect.y - 1); add(x, rect.y + rect.height); }
for (let y = rect.y; y < rect.y + rect.height; y += 1) { add(rect.x - 1, y); add(rect.x + rect.width, y); }
if (!around[0]!.length) return false;
const backdrop = around.map(values => values.sort((a, b) => a - b)[values.length >> 1]!);
return !drawnIn(rect, (x, y) => {
const offset = (y * head.width + x) * 4;
return Math.max(Math.abs(head.frame.data[offset]! - backdrop[0]!), Math.abs(head.frame.data[offset + 1]! - backdrop[1]!),
Math.abs(head.frame.data[offset + 2]! - backdrop[2]!));
});
}
/** The parts of `rect` before and after `outline` along `axis`: what is left of it outside the outline. */
function outside(rect: Rect, outline: Rect, axis: Axis): Rect[] {
const r = extent(rect, axis), o = extent(outline, axis);
const parts: Array<[number, number]> = [[r.start, Math.min(r.start + r.size, o.start)], [Math.max(r.start, o.start + o.size), r.start + r.size]];
return parts.filter(([from, to]) => to > from)
.map(([from, to]) => (axis === "x" ? { ...rect, x: from, width: to - from } : { ...rect, y: from, height: to - from }));
}
function clip(rect: Rect, width: number, height: number): Rect {
const x = Math.max(0, Math.floor(rect.x)), y = Math.max(0, Math.floor(rect.y));
return { x, y, width: Math.max(0, Math.min(width, Math.ceil(rect.x + rect.width)) - x), height: Math.max(0, Math.min(height, Math.ceil(rect.y + rect.height)) - y) };
}
function union(a: Rect, b: Rect): Rect {
const x = Math.min(a.x, b.x), y = Math.min(a.y, b.y);
return { x, y, width: Math.max(a.x + a.width, b.x + b.width) - x, height: Math.max(a.y + a.height, b.y + b.height) - y };
}
/**
* The large move a pair of regions shows, if one does: `left` is where content was (it differs because the content
* left), `arrived` where it is now, both already clipped to the screenshot. The pair only names the axis and how far
* to look; the distance is where After's brightness profile across the arrived region best matches Before's, and
* the pixels must agree once aligned, both where the content arrived and where the content that left went.
*/
function pairMove(base: Image, head: Image, left: Rect, arrived: Rect, axis: Axis): RegionShift | undefined {
const a = extent(arrived, axis), l = extent(left, axis), band = extent(arrived, across(axis)), lb = extent(left, across(axis));
const bandStart = Math.max(band.start, lb.start), bandEnd = Math.min(band.start + band.size, lb.start + lb.size);
if (bandEnd <= bandStart || a.size <= 0) return undefined;
const baseProfile = profile(base, axis, bandStart, bandEnd), headProfile = profile(head, axis, bandStart, bandEnd);
const length = baseProfile.length;
// Content moving toward the arrived region: the distance is positive when it lies after the region it left.
const sign = a.start > l.start ? 1 : -1;
const farthest = Math.abs(a.start + a.size - l.start) + Math.abs(l.start + l.size - a.start);
const errors: Array<{ distance: number; error: number }> = [];
for (let distance = (axis === "x" ? MAX_SHIFT_X : MAX_SHIFT_Y) + 1; distance <= farthest; distance += 1) {
const move = sign * distance;
let sum = 0, count = 0;
for (let position = a.start; position < a.start + a.size; position += 1) {
const from = position - move;
if (from < 0 || from >= length) continue;
sum += Math.abs(headProfile[position]! - baseProfile[from]!);
count += 1;
}
if (count >= a.size / 2) errors.push({ distance: move, error: sum / count });
}
if (errors.length < 3) return undefined;
const minima = errors.filter((fit, index) => index > 0 && index < errors.length - 1
&& fit.error <= errors[index - 1]!.error && fit.error <= errors[index + 1]!.error);
if (!minima.length) return undefined;
const best = minima.reduce((least, fit) => (fit.error < least.error ? fit : least));
if (minima.some(fit => fit !== best && Math.abs(fit.distance - best.distance) > 2 && fit.error <= best.error * AMBIGUOUS_LARGE + 1e-6)) return undefined;
// The pixels decide: across the move it may also drift a little, as content below a moved element does. A tie
// keeps the move in line (content the same all across it fits every drift equally).
let chosen: RegionShift | undefined, fit = -Infinity;
const unshifted = mismatch(base, head, arrived, 0, 0);
for (const other of ACROSS_OFFSETS) {
const shift = shiftAlong(axis, best.distance, other);
const share = explained(base, head, arrived, shift, unshifted);
if (share > fit) { fit = share; chosen = shift; }
}
if (!chosen || fit < MIN_EXPLAINED_LARGE || changedAfterLargeMove(base, head, arrived, chosen.x, chosen.y)) return undefined;
// The content that left must be intact where the move takes it: a deletion is not a move.
const landed = clip({ ...left, x: left.x + chosen.x, y: left.y + chosen.y }, head.width, head.height);
return movedIntact(base, head, landed, chosen) ? chosen : undefined;
}
/**
* Moves too large for the drift search, among the regions it left unexplained: two regions alike across an axis
* and side by side along it, one darker and one brighter, are the two ends of something that moved. Where the
* content left must be plain backdrop in After for that region to be part of the move; anything drawn there is a
* change of its own and stays one. A move that checks out also takes in any other unexplained region it explains
* (fragments of the same element where its old and new places overlap), and its outline is the moved content in After.
*/
export function regionMoves(baseFrame: DecodedFrame, headFrame: DecodedFrame,
regions: ReadonlyArray<Rect & { dominantChange?: string }>, shifts: ReadonlyArray<RegionShift | undefined>): RegionMove[] {
if (baseFrame.width !== headFrame.width || baseFrame.height !== headFrame.height) return [];
const base = image(baseFrame), head = image(headFrame);
const clipped = regions.map(region => clip(region, head.width, head.height));
const open = new Set(regions.map((_, index) => index).filter(index => !shifts[index] && clipped[index]!.width > 0 && clipped[index]!.height > 0));
const moves: RegionMove[] = [];
// Largest first: the element that moved the most content is the one a reader is looking at.
const order = [...open].sort((left, right) => clipped[right]!.width * clipped[right]!.height - clipped[left]!.width * clipped[left]!.height);
for (let first = 0; first < order.length; first += 1) {
for (let second = first + 1; second < order.length; second += 1) {
const i = order[first]!, j = order[second]!;
if (!open.has(i) || !open.has(j)) continue;
const opposite = new Set([regions[i]!.dominantChange, regions[j]!.dominantChange]);
if (!(opposite.has("brighter") && opposite.has("darker"))) continue;
const a = clipped[i]!, b = clipped[j]!;
for (const axis of ["x", "y"] as const) {
if (!pairAlong(a, b, axis)) continue;
// Either could be where the content arrived; the pixels decide which.
const forward = pairMove(base, head, a, b, axis);
const shift = forward ?? pairMove(base, head, b, a, axis);
if (!shift) continue;
const [leftIndex, arrivedIndex] = forward ? [i, j] : [j, i];
const left = clipped[leftIndex]!, arrived = clipped[arrivedIndex]!;
let rect = clip(union(arrived, { ...left, x: left.x + shift.x, y: left.y + shift.y }), head.width, head.height);
open.delete(i); open.delete(j);
// Where the content left: plain backdrop belongs to the move, anything drawn there is a change of its own.
const members = outside(left, rect, axis).every(part => plain(head, part, rect)) ? [arrivedIndex, leftIndex] : [arrivedIndex];
// Fragments of the same element inside its new place, where the old and new overlap.
for (const k of [...open]) {
const fragment = clipped[k]!;
const inside = fragment.x >= rect.x && fragment.y >= rect.y && fragment.x + fragment.width <= rect.x + rect.width && fragment.y + fragment.height <= rect.y + rect.height;
if (!inside || !movedIntact(base, head, fragment, shift)) continue;
members.push(k); open.delete(k); rect = union(rect, fragment);
}
moves.push({ rect, shift, members });
break;
}
}
}
return moves;
}
/** Reads both PNG screenshots and measures each region's shift. */
export async function measureRegionShifts(basePath: string, headPath: string, regions: readonly Rect[]): Promise<Array<RegionShift | undefined>> {
const [base, head] = await readFrames(basePath, headPath);
return regionShifts(base, head, regions);
}
/** Reads both PNG screenshots once and measures each region's shift, then the large moves the rest show. */
export async function measureRegionMoves(basePath: string, headPath: string, regions: ReadonlyArray<Rect & { dominantChange?: string }>):
Promise<{ shifts: Array<RegionShift | undefined>; moves: RegionMove[]; width: number; height: number }> {
const [base, head] = await readFrames(basePath, headPath);
const shifts = regionShifts(base, head, regions);
return { shifts, moves: regionMoves(base, head, regions, shifts), width: head.width, height: head.height };
}
async function readFrames(basePath: string, headPath: string): Promise<[DecodedFrame, DecodedFrame]> {
const { PNG } = createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs") as
{ PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
const [base, head] = await Promise.all([readFile(basePath), readFile(headPath)]);
return regionShifts(PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false }), regions);
return [PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false })];
}
+39 -2
View File
@@ -28,6 +28,7 @@ export type ReviewerChangeTemplateId =
| "element.removed"
| "visible-text.changed-short"
| "visible-text.changed-long"
| "visible-text.unstable-within-build"
| "interaction.target-changed"
| "accessibility.label-changed"
| "accessibility.role-changed"
@@ -95,6 +96,19 @@ export type VisibleTextReviewerChange = {
after: string;
};
/**
* A label that differs between the two builds but also between two captures of the same build (its light and dark
* appearances): a clock, a relative time, a random name. Runtime state, not a change.
*/
export type UnstableTextReviewerChange = {
kind: "unstable-text";
subjectRole: ReviewerSubjectRole;
before: string;
after: string;
/** What the same build showed in its other capture. */
within: string;
};
export type InteractionReviewerChange = {
kind: "action-target-changed";
subjectRole: ReviewerSubjectRole;
@@ -121,7 +135,7 @@ export type VisualReviewerChange = {
kind: "visual-changed";
scope:
| { kind: "landmark"; label: string }
| { kind: "main-content" };
| { kind: "main-content"; near?: "top" | "bottom" };
};
/**
@@ -134,6 +148,7 @@ export type SupportedReviewerChange =
| ScreenReviewerChange
| ElementReviewerChange
| VisibleTextReviewerChange
| UnstableTextReviewerChange
| InteractionReviewerChange
| AccessibilityReviewerChange
| VisualReviewerChange
@@ -387,6 +402,28 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
},
};
}
case "unstable-text": {
const before = compact(change.before);
const after = compact(change.after);
const within = compact(change.within);
if (!before || !after || !within) return invalidChange("An unstable-text change requires all three labels.", evidenceRefs);
if (before === after) return invalidChange("An unstable-text change has identical labels.", evidenceRefs);
const seen = [...new Set([before, within, after])];
return {
kind: "fact",
fact: {
category: "visible-text",
templateId: "visible-text.unstable-within-build",
bullet: `Text varies between captures of the same build: ${seen.map(quote).join(" / ")}.`,
subjectRole: change.subjectRole,
subjectLabel: after,
before,
after,
priority: PRIORITY["visible-text"],
evidenceRefs,
},
};
}
case "accessibility-label-changed": {
const before = compact(change.before);
const after = compact(change.after);
@@ -466,7 +503,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,
+28 -24
View File
@@ -1,4 +1,4 @@
import { spawnSync } from "node:child_process";
import { execFile } from "node:child_process";
import { lstat, readFile, realpath } from "node:fs/promises";
import { isAbsolute } from "node:path";
@@ -133,30 +133,34 @@ export async function diffScreenshots(options: {
|| !isAbsolute(options.command)
|| /[\u0000-\u001f\u007f]/.test(options.command)
) throw new Error("agent-device command must be an absolute path");
const result = spawnSync(
options.command,
[
"--json",
"diff",
"screenshot",
"--baseline",
baselinePath,
currentPath,
"--threshold",
String(threshold),
],
{
encoding: "utf8",
shell: false,
timeout: options.timeoutMs ?? 60_000,
env: {
PATH: process.env.PATH,
const result = await new Promise<{ error: (Error & { code?: unknown }) | null; stdout: string; stderr: string }>(resolve => {
execFile(
options.command,
[
"--json",
"diff",
"screenshot",
"--baseline",
baselinePath,
currentPath,
"--threshold",
String(threshold),
],
{
encoding: "utf8",
shell: false,
timeout: options.timeoutMs ?? 60_000,
env: {
PATH: process.env.PATH,
},
maxBuffer: 4 * 1024 * 1024,
},
maxBuffer: 4 * 1024 * 1024,
},
);
if (result.error) throw new Error(`Could not run screenshot diff: ${result.error.message}`);
if (result.status !== 0) {
(error, stdout, stderr) => resolve({ error, stdout, stderr }),
);
});
// execFile reports a non-zero exit as an error carrying the exit status; a spawn failure or timeout carries none.
if (result.error && typeof result.error.code !== "number") throw new Error(`Could not run screenshot diff: ${result.error.message}`);
if (result.error) {
const detail = (result.stderr || result.stdout || "unknown error").trim().slice(0, 500);
throw new Error(`Screenshot diff failed: ${detail}`);
}
+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]));
}
+6 -2
View File
@@ -25,6 +25,7 @@ jobs:
contents: read
outputs:
targets: ${{ steps.targets.outputs.targets }}
max_parallel: ${{ steps.targets.outputs.max_parallel }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with: { ref: '${{ github.sha }}', path: app, persist-credentials: false }
@@ -51,12 +52,15 @@ jobs:
shell: bash
run: |
set -euo pipefail
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
echo "targets=$targets" >> "$GITHUB_OUTPUT"
listed="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --config .expo-explore/config.yaml)"
echo "targets=$(jq -c '[.targets[].id]' <<< "$listed")" >> "$GITHUB_OUTPUT"
# Each target job needs a simulator session: at most capture.maxSessions of them run at once.
echo "max_parallel=$(jq '.maxParallel // (.targets | length)' <<< "$listed")" >> "$GITHUB_OUTPUT"
baseline:
needs: targets
strategy:
fail-fast: false
max-parallel: ${{ fromJSON(needs.targets.outputs.max_parallel) }}
matrix:
target: ${{ fromJSON(needs.targets.outputs.targets) }}
runs-on: ubuntu-22.04
+6 -2
View File
@@ -48,6 +48,7 @@ jobs:
contents: read
outputs:
targets: ${{ steps.targets.outputs.targets }}
max_parallel: ${{ steps.targets.outputs.max_parallel }}
base: ${{ steps.refs.outputs.base }}
head: ${{ steps.refs.outputs.head }}
compare: ${{ steps.refs.outputs.compare }}
@@ -89,12 +90,15 @@ jobs:
shell: bash
run: |
set -euo pipefail
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
echo "targets=$targets" >> "$GITHUB_OUTPUT"
listed="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml)"
echo "targets=$(jq -c '[.targets[].id]' <<< "$listed")" >> "$GITHUB_OUTPUT"
# Each target job needs a simulator session: at most capture.maxSessions of them run at once.
echo "max_parallel=$(jq '.maxParallel // (.targets | length)' <<< "$listed")" >> "$GITHUB_OUTPUT"
capture:
needs: targets
strategy:
fail-fast: false
max-parallel: ${{ fromJSON(needs.targets.outputs.max_parallel) }}
matrix:
target: ${{ fromJSON(needs.targets.outputs.targets) }}
runs-on: ubuntu-22.04
+6 -2
View File
@@ -33,6 +33,7 @@ jobs:
pull-requests: read
outputs:
targets: ${{ steps.targets.outputs.targets }}
max_parallel: ${{ steps.targets.outputs.max_parallel }}
# The failure job comments with these when a capture job fails before it resolves the PR itself.
pr_number: ${{ steps.pr.outputs.pr_number }}
base: ${{ steps.pr.outputs.base }}
@@ -69,12 +70,15 @@ jobs:
shell: bash
run: |
set -euo pipefail
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
echo "targets=$targets" >> "$GITHUB_OUTPUT"
listed="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml)"
echo "targets=$(jq -c '[.targets[].id]' <<< "$listed")" >> "$GITHUB_OUTPUT"
# Each target job needs a simulator session: at most capture.maxSessions of them run at once.
echo "max_parallel=$(jq '.maxParallel // (.targets | length)' <<< "$listed")" >> "$GITHUB_OUTPUT"
capture:
needs: targets
strategy:
fail-fast: false
max-parallel: ${{ fromJSON(needs.targets.outputs.max_parallel) }}
matrix:
target: ${{ fromJSON(needs.targets.outputs.targets) }}
runs-on: ubuntu-22.04
+239 -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]);
@@ -1454,3 +1543,146 @@ test("local run ZIP opens and reloads without a fabricated GitHub identity", asy
await expect(localRun).toHaveText("Local");
assert.deepEqual(errors, []);
});
test("the Inspector stacks Before over After for a landscape screenshot; Swipe and Flip keep one frame", async t => {
// An opened iPhone Duo's inner display, as a screenshot: wider than tall.
const picture = new PNG({ width: 951, height: 669 });
picture.data.fill(255);
const capture = PNG.sync.write(picture);
const report = reportFixture();
for (const side of ["baseImage", "headImage"]) Object.assign(report.review.surfaces[0][side], { width: 951, height: 669 });
const { bytes } = await imageArchive([capture], 0, report);
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true, fault: holdScreenshotHashes(capture.length) });
await expect(page.locator(".app-shell")).toBeVisible();
const stage = page.locator(".sidebar-review-stage");
const box = locator => locator.evaluate(element => {
const { left, top, width, height } = element.getBoundingClientRect();
return { left, top, width, height };
});
const frames = page.locator(".sidebar-review .compare-frame");
await expect(frames).toHaveCount(2);
// The report's recorded size shapes the pair before the screenshots load: no side-by-side flash.
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "loading");
await expect(stage).toHaveClass(/landscape/);
const waiting = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
await page.evaluate(() => window.releaseScreenshotHashes());
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "ready");
await expect(stage).toHaveClass(/landscape/);
const [before, after] = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
assert.deepEqual([before, after], waiting, "The frames do not move or resize when the screenshots load");
const panel = await box(stage);
// Each frame takes the review's width; After sits under Before, not beside it.
assert.ok(Math.abs(before.width - panel.width) <= 2, `Before spans the panel: ${JSON.stringify({ before, panel })}`);
assert.ok(Math.abs(after.width - panel.width) <= 2, `After spans the panel: ${JSON.stringify({ after, panel })}`);
assert.ok(after.top >= before.top + before.height, `After is under Before: ${JSON.stringify({ before, after })}`);
assert.ok(Math.abs(before.width / before.height - 951 / 669) < 0.02, `The frame keeps the screenshot's shape: ${JSON.stringify(before)}`);
// Swipe and Flip show one frame the panel's width, as before.
for (const mode of ["Swipe", "Flip"]) {
await page.locator(".sidebar-review-modes").getByRole("button", { name: mode, exact: true }).click();
const frame = await box(page.locator(".sidebar-review :is(.visual-swipe, .compare-frame)").first());
assert.ok(Math.abs(frame.width - panel.width) <= 2, `${mode} spans the panel: ${JSON.stringify({ frame, panel })}`);
}
await page.locator(".sidebar-review-modes").getByRole("button", { name: "Split", exact: true }).click();
await expect(frames).toHaveCount(2);
assert.deepEqual(errors, []);
});
test("the Inspector keeps a portrait pair side by side", async t => {
const { page, errors } = await harness(t, await archive(), { app: true });
await expect(page.locator(".app-shell")).toBeVisible();
const frames = page.locator(".sidebar-review .compare-frame");
await expect(frames).toHaveCount(2);
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "ready");
await expect(page.locator(".sidebar-review-stage")).not.toHaveClass(/landscape/);
const box = locator => locator.evaluate(element => {
const { left, top, width } = element.getBoundingClientRect();
return { left, top, width };
});
const [before, after] = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
assert.equal(after.top, before.top, `Before and After share a row: ${JSON.stringify({ before, after })}`);
assert.ok(after.left >= before.left + before.width, `After is beside Before: ${JSON.stringify({ before, after })}`);
assert.deepEqual(errors, []);
});
/** A white PNG of `width` × `height`, and the asset entry and record fields a report gives it. */
function sizedCapture(width, height) {
const picture = new PNG({ width, height });
picture.data.fill(255);
const bytes = PNG.sync.write(picture);
const digest = createHash("sha256").update(bytes).digest("hex");
return { bytes, sha256: digest, path: `assets/${digest}.png`,
record: { url: `https://artifact.expo-explore.invalid/${digest}.png`, sha256: digest, width, height } };
}
test("the Inspector takes a pair's shape from After, whichever side loads last", async t => {
// A screen that turned landscape: Before is the 32×64 portrait fixture, After is landscape.
const landscape = sizedCapture(951, 669);
const report = reportFixture();
Object.assign(report.review.surfaces[0].headImage, landscape.record);
report.assets.push({ sha256: landscape.sha256, path: landscape.path });
// Before's screenshot is held until After's has loaded, so it loads last.
const { page, errors } = await harness(t, await archive(report, [{ name: landscape.path, bytes: landscape.bytes }]),
{ app: true, fault: holdScreenshotHashes(png.length) });
await expect(page.locator(".app-shell")).toBeVisible();
const stage = page.locator(".sidebar-review-stage");
const frames = page.locator(".sidebar-review .compare-frame");
await expect(frames).toHaveCount(2);
await expect(frames.nth(1).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
await expect(stage).toHaveClass(/landscape/);
await page.evaluate(() => window.releaseScreenshotHashes());
await expect(frames.nth(0).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
await expect(stage).toHaveClass(/landscape/);
const ratio = await frames.nth(0).evaluate(element => element.getBoundingClientRect().width / element.getBoundingClientRect().height);
assert.ok(Math.abs(ratio - 951 / 669) < 0.02, `Both frames keep After's shape: ${ratio}`);
assert.deepEqual(errors, []);
});
test("Swipe takes the loaded screenshot's shape when it differs from the recorded one", async t => {
// The record says portrait; the screenshot is landscape. Swipe's frame follows the image, as
// Split's and Flip's do, so a capture whose size the report does not hold is not cropped.
const landscape = sizedCapture(951, 669);
const { bytes } = await imageArchive([landscape.bytes]);
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true, fault: holdScreenshotHashes(landscape.bytes.length) });
await expect(page.locator(".app-shell")).toBeVisible();
// Swipe is chosen before any screenshot loads, so only Swipe's images report a size.
await page.locator(".sidebar-review-modes").getByRole("button", { name: "Swipe", exact: true }).click();
const swipe = page.locator(".sidebar-review .visual-swipe");
await expect(swipe).toBeVisible();
await page.evaluate(() => window.releaseScreenshotHashes());
await expect(swipe.locator("img.visual-swipe-after")).toHaveAttribute("data-screenshot-state", "ready");
await expect.poll(() => swipe.evaluate(element => {
const { width, height } = element.getBoundingClientRect();
return Math.abs(width / height - 951 / 669) < 0.02;
})).toBe(true);
assert.deepEqual(errors, []);
});
test("a near-square landscape pair in a short window keeps both halves on screen, centred", async t => {
// An unfolded foldable's inner display on its side: barely wider than tall.
const foldable = sizedCapture(960, 800);
const report = reportFixture();
for (const side of ["baseImage", "headImage"]) Object.assign(report.review.surfaces[0][side], { width: 960, height: 800 });
const { bytes } = await imageArchive([foldable.bytes], 0, report);
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true });
await page.setViewportSize({ width: 1440, height: 760 });
await expect(page.locator(".app-shell")).toBeVisible();
const stage = page.locator(".sidebar-review-stage");
await expect(stage).toHaveClass(/landscape/);
const frames = page.locator(".sidebar-review .compare-frame");
await expect(frames).toHaveCount(2);
await expect(frames.nth(1).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
const box = locator => locator.evaluate(element => {
const { left, top, width, height, bottom } = element.getBoundingClientRect();
return { left, top, width, height, bottom };
});
const [before, after, panel] = await Promise.all([box(frames.nth(0)), box(frames.nth(1)), box(stage)]);
const viewport = page.viewportSize();
assert.ok(after.top >= before.top + before.height, `After is under Before: ${JSON.stringify({ before, after })}`);
assert.ok(before.top >= 0 && after.bottom <= viewport.height, `Both halves are on screen: ${JSON.stringify({ before, after, viewport })}`);
for (const frame of [before, after]) {
assert.ok(frame.width < panel.width - 2, `The frame is held under the panel's width: ${JSON.stringify({ frame, panel })}`);
assert.ok(Math.abs(frame.left + frame.width / 2 - (panel.left + panel.width / 2)) <= 1, `The frame is centred: ${JSON.stringify({ frame, panel })}`);
assert.ok(Math.abs(frame.width / frame.height - 960 / 800) < 0.02, `The frame keeps the screenshot's shape: ${JSON.stringify(frame)}`);
}
assert.deepEqual(errors, []);
});
@@ -188,12 +188,11 @@ test("Map keeps selected elevated arrows behind screenshots without rendering na
await expect(sourceHitArea.locator("title")).toHaveText("Source navigation\npush · app/home.tsx");
await page.mouse.move(1320, 30);
const dimmedComparisons = [];
for (const presentation of ["muted", "selection"]) {
// Only the Changes filter dims a screen; a selection fades nothing.
for (const presentation of ["muted"]) {
await page.evaluate(mode => {
const profile = document.querySelector('.react-flow__node[data-id="profile"]');
const canvas = document.querySelector(".map-canvas");
profile.classList.toggle("graph-node-muted", mode === "muted");
canvas.classList.toggle("screen-selection-active", mode === "selection");
}, presentation);
const dimmedWithArrows = await profileImage.screenshot({ animations: "disabled" });
await page.locator(".map-surface .react-flow__edges").evaluate(node => { node.style.visibility = "hidden"; });
@@ -216,7 +215,6 @@ test("Map keeps selected elevated arrows behind screenshots without rendering na
}
await page.evaluate(() => {
document.querySelector('.react-flow__node[data-id="profile"]').classList.remove("graph-node-muted");
document.querySelector(".map-canvas").classList.remove("screen-selection-active");
});
await page.getByRole("button", { name: "Open Profile", exact: true }).click();
assert.equal(await page.evaluate(() => window.selectedScreen), "profile");
+42 -2
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.
@@ -155,7 +155,7 @@ test("Compare steps through changed screens and their changed areas", { timeout:
// A changed screen opens the same review in the Inspector on every canvas: Compare at sidebar
// size. CI compares the images pixel for pixel, so /games's four CI regions read as changed
// areas, outlined at the same place on both sides.
// areas, outlined on After; Before keeps the same outlines unseen until one is hovered on After.
await openChangedScreen(page, /, Modified, \/games$/);
const inspector = page.locator(".right-panel");
const review = inspector.getByRole("region", { name: "Changes in /games" });
@@ -166,6 +166,8 @@ test("Compare steps through changed screens and their changed areas", { timeout:
await expect.poll(() => outlineCount("after")).toBeGreaterThan(0);
const areas = await outlineCount("after");
assert.equal(await outlineCount("before"), areas);
await expect(review.locator('[data-side="after"] .visual-change-outlines')).toHaveClass(/linked/);
await expect(review.locator('[data-side="before"] .visual-change-outlines')).toHaveClass(/ghost/);
// Esc closes the Inspector; the selection stays, a second Esc clears it.
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
await page.keyboard.press("Escape");
@@ -225,6 +227,12 @@ test("Compare steps through changed screens and their changed areas", { timeout:
await expect.poll(() => compare.locator(`[data-side="${side}"] img`).first()
.evaluate(image => image.naturalWidth)).toBe(402);
}
// Hovering an outline on After lights the same area on Before, and only that one.
await compare.locator('[data-side="after"] .visual-change-outline').nth(1).hover();
await expect(compare.locator('[data-side="before"] .visual-change-outline.hovered')).toHaveCount(1);
await expect(compare.locator('[data-side="before"] .visual-change-outline').nth(1)).toHaveClass(/hovered/);
await page.mouse.move(0, 0);
await expect(compare.locator(".visual-change-outline.hovered")).toHaveCount(0);
// J and K step through the changed areas; Esc clears the highlight.
const outlines = compare.locator('[data-side="after"] .visual-change-outline');
@@ -416,6 +424,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");
+145
View File
@@ -0,0 +1,145 @@
import assert from "node:assert/strict";
import test from "node:test";
import { fileURLToPath } from "node:url";
import { chromium, expect } from "@playwright/test";
import { PNG } from "pngjs";
import { createBrowserVite } from "../helpers/browser-vite.mjs";
function png(width, height, color) {
const image = new PNG({ width, height });
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
}
// Split over one screen with two changed areas and a card that moved 40% of the width right (at 60% in After, so
// at 20% in Before), and a second screen with one changed area elsewhere. The status bar CI left out is a foldable's
// rail pill, not a band across the top. Keys stand in for the controller's, so the pointer can stay where it is:
// 1 and 2 pick Split and Swipe, o toggles the outlines, n steps to the other screen, j selects the first area.
const entry = `
import { useState, useEffect } from "react";
import { createRoot } from "react-dom/client";
import { CompareStage } from "/src/components/compare/compare-section.tsx";
import "/src/styles.css";
const screens = [
[
{ x: 10, y: 20, width: 30, height: 20, share: 40, regionCount: 1 },
{ x: 60, y: 60, width: 30, height: 20, share: 30, regionCount: 1, move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } },
{ x: 55, y: 20, width: 35, height: 20, share: 30, regionCount: 1 },
],
[{ x: 10, y: 85, width: 20, height: 10, share: 100, regionCount: 1 }],
];
const systemRegions = [{ kind: "status-bar", x: 40, y: 0, width: 20, height: 4 }];
function Harness() {
const [mode, setMode] = useState("split");
const [outlines, setOutlines] = useState(true);
const [screen, setScreen] = useState(0);
const [active, setActive] = useState();
useEffect(() => {
const onKey = (event) => {
if (event.key === "1") setMode("split");
if (event.key === "2") setMode("swipe");
if (event.key === "o") setOutlines((shown) => !shown);
if (event.key === "n") setScreen((index) => 1 - index);
if (event.key === "j") setActive(0);
};
window.addEventListener("keydown", onKey);
return () => window.removeEventListener("keydown", onKey);
}, []);
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: window.before, afterScreenshot: window.after };
return (
<div className={"compare-stage mode-" + mode} style={{ width: 800, height: 500, display: "flex" }}>
<CompareStage key="stage" mode={mode} diff={diff} title="Share" areas={screens[screen]} activeArea={active}
showOutlines={outlines} systemRegions={systemRegions} overlay={null} flipSide="after" onFlip={() => {}}
swipePosition={50} onSwipePosition={() => {}} aspect={1} onAspect={() => {}} />
</div>
);
}
createRoot(document.getElementById("root")).render(<Harness />);
`;
async function openSplit(t, contextOptions = {}) {
const vite = await createBrowserVite(t, {
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
logLevel: "error", esbuild: { jsx: "automatic" },
plugins: [{
name: "split-outlines-fixture",
resolveId: id => id === "/__split-outlines.tsx" ? id : undefined,
load: id => id === "/__split-outlines.tsx" ? entry : undefined,
configureServer(server) {
server.middlewares.use((request, response, next) => {
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
response.setHeader("Content-Type", "text/html");
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__split-outlines.tsx"></script></body></html>');
});
},
}],
server: { host: "127.0.0.1", port: 0 },
});
await vite.listen();
const browser = await chromium.launch({ headless: true });
t.after(() => browser.close());
const page = await browser.newPage({ viewport: { width: 900, height: 600 }, ...contextOptions });
const errors = [];
page.on("pageerror", error => errors.push(error.message));
t.after(() => assert.deepEqual(errors, []));
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
const outline = (side, index) => page.locator(`[data-side="${side}"] .visual-change-outline`).nth(index);
await expect(outline("after", 0)).toBeVisible();
return { page, outline };
}
const opacity = locator => locator.evaluate(element => Number(getComputedStyle(element).opacity));
test("Split keeps the ignored system regions the report names on both sides", { timeout: 30_000 }, async t => {
const { page } = await openSplit(t);
for (const side of ["before", "after"]) {
const band = page.locator(`[data-side="${side}"] .visual-system-region-status-bar`);
await expect(band).toHaveCount(1);
const [frame, box] = await Promise.all([page.locator(`[data-side="${side}"] .compare-frame`).boundingBox(), band.boundingBox()]);
assert.ok(Math.abs((box.x - frame.x) - 0.4 * frame.width) < 1, `${side}'s band sits where the report puts the rail pill`);
assert.ok(Math.abs(box.width - 0.2 * frame.width) < 1);
}
});
test("Split hides Before's changed outlines but keeps a moved area where its content was", { timeout: 30_000 }, async t => {
const { page, outline } = await openSplit(t);
await expect.poll(() => opacity(outline("before", 0))).toBe(0);
await expect.poll(() => opacity(outline("before", 1))).toBe(1);
await expect(outline("before", 1).locator(".visual-change-measure")).toHaveCount(1);
const frame = side => page.locator(`[data-side="${side}"] .compare-frame`).boundingBox();
const [before, after, beforeFrame, afterFrame] = await Promise.all([outline("before", 1).boundingBox(), outline("after", 1).boundingBox(),
frame("before"), frame("after")]);
assert.ok(Math.abs(((after.x - afterFrame.x) - (before.x - beforeFrame.x)) - 0.4 * afterFrame.width) < 1, "Before's moved outline is back by the move");
});
test("A hover is dropped when the screen, the mode or the outlines change under the pointer", { timeout: 30_000 }, async t => {
const { page, outline } = await openSplit(t);
const hovered = page.locator(".visual-change-outline.hovered");
for (const [away, back] of [["2", "1"], ["o", "o"], ["n", "n"]]) {
await outline("after", 0).hover();
await expect(outline("before", 0)).toHaveClass(/hovered/);
// The outline goes from under the pointer, which then moves off the frame before it comes back.
await page.keyboard.press(away);
await page.mouse.move(0, 0);
await page.keyboard.press(back);
await expect(outline("after", 0)).toBeVisible();
await expect(hovered).toHaveCount(0);
}
});
test("The hovered outline on After stays lit while another area is selected", { timeout: 30_000 }, async t => {
const { page, outline } = await openSplit(t);
await page.keyboard.press("j");
await outline("after", 2).hover();
await expect.poll(() => opacity(outline("after", 2))).toBe(1);
await expect.poll(() => opacity(outline("before", 2))).toBe(1);
await expect.poll(() => opacity(outline("after", 1))).toBe(0.35);
});
test("A screen without hover keeps Before's outlines, as it cannot reveal one", { timeout: 30_000 }, async t => {
const { page, outline } = await openSplit(t, { hasTouch: true, isMobile: true });
assert.equal(await page.evaluate(() => matchMedia("(hover: none)").matches), true);
await expect.poll(() => opacity(outline("before", 0))).toBe(1);
await expect.poll(() => opacity(outline("before", 2))).toBe(1);
});
+64
View File
@@ -0,0 +1,64 @@
import assert from "node:assert/strict";
import test from "node:test";
import { fileURLToPath } from "node:url";
import { chromium, expect } from "@playwright/test";
import { PNG } from "pngjs";
import { createBrowserVite } from "../helpers/browser-vite.mjs";
function png(width, height, color) {
const image = new PNG({ width, height });
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
}
// A card that moved 40% of the width right: it is at 60% in After, so it was at 20% in Before.
const entry = `
import { createRoot } from "react-dom/client";
import { SwipeCompare } from "/src/components/panels/visual-diff.tsx";
import "/src/styles.css";
const changes = [{ x: 60, y: 30, width: 30, height: 30, share: 100, regionCount: 1,
move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } }];
createRoot(document.getElementById("root")).render(<div style={{ width: 400, display: "flex" }}>
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={50} />
</div>);
`;
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
const vite = await createBrowserVite(t, {
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
logLevel: "error", esbuild: { jsx: "automatic" },
plugins: [{
name: "swipe-outlines-fixture",
resolveId: id => id === "/__swipe-outlines.tsx" ? id : undefined,
load: id => id === "/__swipe-outlines.tsx" ? entry : undefined,
configureServer(server) {
server.middlewares.use((request, response, next) => {
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
response.setHeader("Content-Type", "text/html");
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__swipe-outlines.tsx"></script></body></html>');
});
},
}],
server: { host: "127.0.0.1", port: 0 },
});
await vite.listen();
const browser = await chromium.launch({ headless: true });
t.after(() => browser.close());
const page = await browser.newPage({ viewport: { width: 600, height: 600 } });
const errors = [];
page.on("pageerror", error => errors.push(error.message));
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
const frame = page.locator(".visual-swipe");
const before = page.locator(".visual-swipe-outlines.before .visual-change-outline.moved");
const after = page.locator(".visual-swipe-outlines.after .visual-change-outline.moved");
await expect(before).toHaveCount(1);
await expect(after).toHaveCount(1);
const [box, beforeBox, afterBox] = await Promise.all([frame.boundingBox(), before.boundingBox(), after.boundingBox()]);
assert.ok(Math.abs((afterBox.x - beforeBox.x) - 0.4 * box.width) < 1, "Before's outline is back by the move");
// Each side's outlines show only over its own half of the frame.
const clips = await page.locator(".visual-swipe-outlines").evaluateAll(spans => spans.map(span => getComputedStyle(span).clipPath));
assert.deepEqual(clips.map(clip => clip.startsWith("inset(")), [true, true]);
assert.deepEqual(errors, []);
});
+5 -2
View File
@@ -6,6 +6,7 @@ import { join, resolve } from 'node:path';
import { parseArgs } from 'node:util';
import { parse } from 'yaml';
import { assessPublicEvidence, readExportedMap } from '../../dist/review/evidence-assessment.js';
import { systemRegions } from '../../dist/contracts/capture.js';
import { prepareCaptureReview, readCaptureBundle } from '../../dist/review/capture-review.js';
import { parseRuntimeExecutionContext } from '../../dist/review/runtime-adapter.js';
import { generateAgentChangeNotes } from '../../dist/capture/agent/change-notes.js';
@@ -28,11 +29,13 @@ export async function recompare(runDirectory) {
const existing = (await readdir(join(run, 'artifacts'))).filter(name => /^recompare-\d+$/.test(name)).length;
const label = `recompare-${existing + 1}`;
const sides = { base: await side(join(capture, 'base-export')), head: await side(join(capture, 'head-export')) };
const evidence = await assessPublicEvidence({ plan, ...sides, profile: `${config.app.easProfile}:${config.app.bundleId}`,
// The run's own device and pose, as its comparison had them: a foldable's rail pill, or the platform's bands.
const system = systemRegions({ platform: config.app.platform, device: config.device.name, pose: config.device.pose });
const evidence = await assessPublicEvidence({ platform: config.app.platform, systemRegions: system, plan, ...sides, profile: `${config.app.easProfile}:${config.app.bundleId}`,
agentDeviceCommand: join(repository, 'node_modules/.bin/agent-device') });
const state = { ...previous.commentState };
let { review, assets } = await prepareCaptureReview({ plan, pullRequest: state.pullRequest,
baseDirectory: sides.base.directory, headDirectory: sides.head.directory, runId: previous.publicReview.runId,
baseDirectory: sides.base.directory, headDirectory: sides.head.directory, systemRegions: system, runId: previous.publicReview.runId,
runAttempt: previous.publicReview.runAttempt, assertCurrentHead: async () => {}, assessments: evidence.surfaces,
app: { ...(state.build?.appVersion ? { version: state.build.appVersion } : {}),
...(state.build?.appBuildNumber ? { buildNumber: state.build.appBuildNumber } : {}) } });
+512 -116
View File
@@ -80,126 +80,121 @@ async function expectAutoHideScrollbar(
await expect(scrollbar).toHaveCSS("opacity", "0");
}
async function expectMapScreenSelectionDimming(
page: Page,
options: { hoverTargetCount?: number } = {},
) {
const screens = page.locator(
".map-canvas .react-flow__node-screen:not(.canvas-node-exit)",
);
const selected = page.locator(
".map-canvas .react-flow__node-screen.selected:not(.canvas-node-exit)",
);
const dimmed = page.locator(
".map-canvas .react-flow__node-screen:not(.selected):not(.canvas-node-exit)",
);
await expect(page.locator(".map-canvas")).toHaveClass(/screen-selection-active/);
await expect(selected).toHaveCount(1);
await expect.poll(async () => dimmed.count()).toBe((await screens.count()) - 1);
expect(await screens.evaluateAll(nodes => nodes.every(node => getComputedStyle(node).opacity === "1"))).toBe(true);
/** The Map's canvas tokens as computed colours, to compare with what a ring or an edge draws. */
async function mapCanvasColors(page: Page) {
return page.locator(".map-canvas").evaluate((canvas) => {
const resolve = (token: string) => {
const probe = document.createElement("span");
probe.style.color = `var(${token})`;
canvas.append(probe);
const color = getComputedStyle(probe).color;
probe.remove();
return color;
};
return {
accent: resolve("--accent"),
accentStrong: resolve("--accent-strong"),
hoverRing: resolve("--hover-ring"),
quiet: resolve("--border-subtle"),
hoverEdge: resolve("--tertiary"),
};
});
}
await expect.poll(async () => {
const [selectedOpacity, dimmedOpacity] = await Promise.all([
selected.locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
dimmed.first().locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
]);
return dimmedOpacity < selectedOpacity;
}).toBe(true);
/** The screenshot frame's box shadow on a Map card: where its ring is drawn. */
function mapCardRing(node: Locator) {
return node.locator(".screen-node-image :is(img, .image-placeholder)").first()
.evaluate((frame) => getComputedStyle(frame).boxShadow);
}
// Selection focus moves the canvas before hover affordances are exercised. Choose hover
// targets only after that flight settles so a node cannot move underneath the minimap between
// the hit-test below and Playwright's pointer action.
await expect(page.locator(".map-canvas.canvas-focus-animating")).toHaveCount(0);
const hoverableDimmedIndexes = await dimmed.evaluateAll((nodes) => nodes.flatMap((node, index) => {
const bounds = node.getBoundingClientRect();
const centerTarget = document.elementFromPoint(
bounds.left + bounds.width / 2,
bounds.top + bounds.height / 2,
);
const nodeId = node.getAttribute("data-id");
const hasDirectEdge = nodeId !== null && [...document.querySelectorAll(".react-flow__edge")]
.some((edge) => {
const label = edge.getAttribute("aria-label") ?? "";
return label.startsWith(`Edge from ${nodeId} to `) || label.endsWith(` to ${nodeId}`);
});
return centerTarget !== null && node.contains(centerTarget) && hasDirectEdge ? [index] : [];
/** Each Map edge's id, ends and drawn stroke. */
function mapEdgeStrokes(page: Page) {
return page.locator(".map-canvas .react-flow__edge").evaluateAll((edges) => edges.map((edge) => {
const match = /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "");
const path = getComputedStyle(edge.querySelector(".transition-edge-path")!);
return {
id: edge.getAttribute("data-id") ?? "",
from: match?.[1] ?? "",
to: match?.[2] ?? "",
stroke: path.stroke,
strokeWidth: Number.parseFloat(path.strokeWidth),
};
}));
const hoverTargetCount = options.hoverTargetCount ?? 1;
expect(hoverableDimmedIndexes.length).toBeGreaterThanOrEqual(hoverTargetCount);
let lastHoverTarget = dimmed.nth(hoverableDimmedIndexes[0]!);
}
for (const index of hoverableDimmedIndexes.slice(0, hoverTargetCount)) {
const hoverTarget = dimmed.nth(index);
const hoverTargetId = await hoverTarget.getAttribute("data-id");
expect(hoverTargetId).not.toBeNull();
await hoverTarget.hover();
await expect.poll(() => hoverTarget.locator(":scope > .canvas-active-frame").evaluate(
(node) => Number.parseFloat(getComputedStyle(node).opacity),
)).toBe(1);
await expect(hoverTarget).toHaveCSS("filter", "none");
const hoverSubject = page.locator(
".map-canvas .react-flow__node-screen.graph-node-hover-subject",
);
await expect(hoverSubject).toHaveCount(1);
await expect(hoverSubject).toHaveAttribute("data-id", hoverTargetId!);
const allEdges = page.locator(".map-canvas .react-flow__edge");
const directEdgeCount = await allEdges.evaluateAll((edges, nodeId) => edges.filter((edge) => {
const label = edge.getAttribute("aria-label") ?? "";
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.
const neighbourIds = await allEdges.evaluateAll((edges, nodeId) => {
const ids = new Set<string>([nodeId]);
for (const edge of edges) {
const match = /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "");
if (!match) continue;
if (match[1] === nodeId) ids.add(match[2]!);
if (match[2] === nodeId) ids.add(match[1]!);
}
return [...ids].sort();
}, hoverTargetId!);
const brightNodes = page.locator(
".map-canvas .react-flow__node-screen.graph-node-hover-related",
);
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)",
);
if (await receded.count() > 0) {
await expect.poll(() => receded.first().evaluate(
(node) => Number.parseFloat(getComputedStyle(node).opacity),
)).toBeGreaterThan(0.5);
}
const activeEdges = page.locator(
".map-canvas .react-flow__edge.graph-edge-hover-related",
);
await expect(activeEdges).toHaveCount(directEdgeCount);
const activeEdgeLabels = await activeEdges.evaluateAll((edges) => (
edges.map((edge) => edge.getAttribute("aria-label") ?? "")
/**
* A selected Map screen is ringed in the accent, its route turns accent and its transitions stay
* accent while every other transition quiets to a hairline. No card fades. Hovering another card
* rings it in grey beside the selection, with no tooltip, and darkens its own transitions;
* hovering the selected card keeps its accent ring.
*/
async function expectMapSelectionRing(page: Page) {
const screens = page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)");
const selected = page.locator(".map-canvas .react-flow__node-screen.selected:not(.canvas-node-exit)");
await expect(selected).toHaveCount(1);
const selectedId = (await selected.getAttribute("data-id"))!;
const colors = await mapCanvasColors(page);
await expect.poll(() => mapCardRing(selected)).toContain(colors.accent);
await expect(selected.locator(".screen-node-title")).toHaveCSS("color", colors.accentStrong);
// Nothing fades: every card and its frame stay at full strength.
await expect.poll(() => screens.evaluateAll((nodes) => nodes.every((node) => (
getComputedStyle(node).opacity === "1"
&& getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).opacity === "1"
&& ["", "1"].includes(getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim())
)))).toBe(true);
const unselected = page.locator(".map-canvas .react-flow__node-screen:not(.selected):not(.canvas-node-exit)");
expect(await unselected.evaluateAll((nodes, accent) => nodes.every((node) => (
!getComputedStyle(node.querySelector(".screen-node-image :is(img, .image-placeholder)")!).boxShadow.includes(accent)
)), colors.accent)).toBe(true);
// The selection's transitions are accent and a little heavier; every other one is a hairline.
const edges = await mapEdgeStrokes(page);
const incident = edges.filter((edge) => edge.from === selectedId || edge.to === selectedId);
const others = edges.filter((edge) => edge.from !== selectedId && edge.to !== selectedId);
expect(incident.length).toBeGreaterThan(0);
expect(others.length).toBeGreaterThan(0);
expect(incident.every((edge) => edge.stroke === colors.accent && edge.strokeWidth === 2.5)).toBe(true);
expect(others.every((edge) => edge.stroke === colors.quiet && edge.strokeWidth === 1)).toBe(true);
await expect(page.locator(".map-canvas .react-flow__edge.graph-edge-quiet")).toHaveCount(others.length);
// Hover a card that shares no edge with the selection but has edges of its own.
await expect(page.locator(".map-canvas.canvas-focus-animating")).toHaveCount(0);
const neighbours = new Set(incident.flatMap((edge) => [edge.from, edge.to]));
const hoverId = await unselected.evaluateAll((nodes, excluded) => nodes.find((node) => {
const id = node.getAttribute("data-id") ?? "";
const target = node.querySelector(".screen-screenshot-target")!.getBoundingClientRect();
const hit = document.elementFromPoint(target.left + target.width / 2, target.top + target.height / 3);
const linked = [...document.querySelectorAll(".map-canvas .react-flow__edge")].some((edge) => (
(edge.getAttribute("aria-label") ?? "").split(/ (?:from|to) /).slice(1).includes(id)
));
expect(activeEdgeLabels.every((label) => (
label.startsWith(`Edge from ${hoverTargetId} to `)
|| label.endsWith(` to ${hoverTargetId}`)
))).toBe(true);
lastHoverTarget = hoverTarget;
if (index !== hoverableDimmedIndexes.slice(0, hoverTargetCount).at(-1)) {
await page.mouse.move(1, 1);
await page.waitForTimeout(160);
}
return !excluded.includes(id) && linked && hit !== null && node.contains(hit);
})?.getAttribute("data-id"), [...neighbours]);
expect(hoverId).toBeTruthy();
const hovered = page.locator(`.map-canvas .react-flow__node-screen[data-id="${hoverId}"]`);
const target = hovered.locator(".screen-screenshot-target");
const box = (await target.boundingBox())!;
await target.hover({ position: { x: box.width / 2, y: box.height / 3 } });
await expect(hovered).toHaveClass(/graph-node-hover-subject/);
await expect.poll(() => mapCardRing(hovered)).toContain(colors.hoverRing);
await expect.poll(() => mapCardRing(selected)).toContain(colors.accent);
// Past the tooltip delay, nothing says Open in Inspector.
await page.waitForTimeout(600);
await expect(page.locator(".tooltip")).toHaveCount(0);
// The hovered card's transitions darken to grey; the selection's stay accent; the rest stay quiet.
const hovering = await mapEdgeStrokes(page);
for (const edge of hovering) {
if (edge.from === selectedId || edge.to === selectedId) expect(edge.stroke, edge.id).toBe(colors.accent);
else if (edge.from === hoverId || edge.to === hoverId) expect(edge.stroke, edge.id).toBe(colors.hoverEdge);
else expect(edge.stroke, edge.id).toBe(colors.quiet);
}
// Hovering the selected card keeps its accent ring.
const selectedTarget = selected.locator(".screen-screenshot-target");
const selectedBox = (await selectedTarget.boundingBox())!;
await selectedTarget.hover({ position: { x: selectedBox.width / 2, y: selectedBox.height / 3 } });
await expect(selected).toHaveClass(/graph-node-hover-subject/);
await expect.poll(() => mapCardRing(selected)).toContain(colors.accent);
expect(await mapCardRing(selected)).not.toContain(colors.hoverRing);
await expect.poll(() => mapCardRing(hovered)).not.toContain(colors.hoverRing);
await page.mouse.move(1, 1);
await expect.poll(async () => {
const [selectedOpacity, dimmedOpacity] = await Promise.all([
selected.locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
lastHoverTarget.locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
]);
return dimmedOpacity < selectedOpacity;
}).toBe(true);
}
/** The camera chrome's theme button steps Auto → Dark → Light; press it until the page shows the option. */
@@ -1519,6 +1514,59 @@ test("Esc closes the Inspector first, then deselects; arrows and hjkl walk the m
await expect(selected).toHaveAttribute("data-id", child!);
});
test("Return after the arrow keys opens the screen they reached, not the one clicked before, on the Map and on Screens", async ({ page }) => {
await serveSyntheticWorkspace(page);
const inspector = page.getByRole("complementary", { name: "Inspector panel" });
const accent = await page.evaluate(() => {
const probe = document.createElement("span");
probe.style.color = "#0588f0";
document.body.append(probe);
const color = getComputedStyle(probe).color;
probe.remove();
return color;
});
// Map: the click leaves the keyboard focus on the first screen's button; Return must not press it.
await page.goto("/map?screen=area-0-screen-1");
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
await expect(selected).toHaveAttribute("data-id", "area-0-screen-1");
await expectMapCameraAtRest(page);
await selected.locator(".screen-screenshot-target").click();
await expect(inspector).toBeVisible();
await page.keyboard.press("Escape");
await expect(inspector).toBeHidden();
await page.keyboard.press("ArrowDown");
await expect(selected).not.toHaveAttribute("data-id", "area-0-screen-1");
const reached = (await selected.getAttribute("data-id"))!;
// The ring went with the selection.
const ring = (id: string) => page.locator(`.map-canvas .react-flow__node-screen[data-id="${id}"] .screen-node-image img`)
.evaluate((image) => getComputedStyle(image).boxShadow);
await expect.poll(() => ring(reached)).toContain(accent);
await expect.poll(() => ring("area-0-screen-1")).not.toContain(accent);
const reachedPath = (await selected.locator(".screen-node-title").textContent())!;
await page.keyboard.press("Enter");
await expect(inspector).toBeVisible();
await expect(selected).toHaveAttribute("data-id", reached);
await expect(page).toHaveURL(new RegExp(`screen=${reached}`));
await expect(inspector).toContainText(reachedPath);
// Screens: the same walk, from a clicked card.
await chooseCanvasView(page, "Screens");
const grid = page.getByRole("main", { name: "Screens" });
await grid.getByRole("button", { name: /^All/ }).click();
const ids = await grid.locator(".screens-grid .screens-cell")
.evaluateAll((elements) => elements.map((element) => element.getAttribute("data-screen-id")!));
await grid.locator(`.screens-cell[data-screen-id="${ids[0]}"] .screen-screenshot-target`).click();
await expect(inspector).toBeVisible();
await page.keyboard.press("Escape");
await expect(inspector).toBeHidden();
await page.keyboard.press("ArrowRight");
await expect(grid.locator(`.screens-cell[data-screen-id="${ids[1]}"] .screen-screenshot-card`)).toHaveClass(/selected/);
await page.keyboard.press("Enter");
await expect(inspector).toBeVisible();
await expect(page).toHaveURL(new RegExp(`screen=${ids[1]}`));
});
test("a held key stops when Esc, another key or a dialog takes the keyboard; a menu keeps its own arrows", async ({ page }) => {
await page.goto("/map");
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
@@ -1945,7 +1993,7 @@ test("fits the visible Map screenshot frame to the capture's intrinsic ratio", a
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
const image = selected.locator(".screen-node-image img");
await expect(image).toBeVisible();
await expectMapScreenSelectionDimming(page);
await expectMapSelectionRing(page);
const pathStyle = await selected.locator(".screen-node-title").evaluate((element) => {
const style = getComputedStyle(element);
const bounds = element.getBoundingClientRect();
@@ -1998,6 +2046,145 @@ 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, rings it in grey, darkens its transitions and shows no tooltip", 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 colors = await mapCanvasColors(page);
const resting = await mapCardOpacities(page);
// With nothing selected no transition is quiet: they keep their own colours.
await expect(page.locator(".map-canvas .react-flow__edge.graph-edge-quiet")).toHaveCount(0);
const restingEdges = await mapEdgeStrokes(page);
expect(restingEdges.some((edge) => edge.stroke === colors.quiet)).toBe(false);
// 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 id = (await node.getAttribute("data-id"))!;
const target = node.locator(".screen-screenshot-target");
// No native title tooltip either; the heading names the screen.
await expect(target).not.toHaveAttribute("title");
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);
await expect.poll(() => mapCardRing(node)).toContain(colors.hoverRing);
expect(await mapCardRing(node)).not.toContain(colors.accent);
// Past the tooltip delay, nothing covers or labels the card.
await page.waitForTimeout(600);
await expect(page.locator(".tooltip")).toHaveCount(0);
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
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((other) => !related.includes(other));
expect(unrelated.length).toBeGreaterThan(0);
const hovering = await mapCardOpacities(page);
expect(unrelated.map((other) => hovering[other])).toEqual(unrelated.map((other) => resting[other]));
// The transitions into and out of it come fully up in a darker grey, the secondary one too; the rest stay as they were.
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);
const hoverEdges = await mapEdgeStrokes(page);
for (const edge of hoverEdges) {
if (edge.from === id || edge.to === id) expect(edge.stroke, edge.id).toBe(colors.hoverEdge);
else expect(edge.stroke, edge.id).toBe(restingEdges.find((resting) => resting.id === edge.id)!.stroke);
}
});
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 +4499,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 +4674,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 +5239,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;
}
+18 -5
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');
@@ -41,7 +54,7 @@ export async function readUsage(output) {
export async function fixture(t, provider, { docsOnly = false, unresolvedParameters = false, observerFailurePath, agentMode = false,
instructions = 'Explore selected routes in a stable, comparable state.', recoverableOpenFailure = false,
userInterfaceStyle, headUserInterfaceStyle, platform: initialPlatform = 'ios', targets } = {}) {
userInterfaceStyle, headUserInterfaceStyle, platform: initialPlatform = 'ios', targets, maxSessions } = {}) {
let platform = initialPlatform;
const root = await realpath(await mkdtemp(join(tmpdir(), 'explore-ci-integration-')));
t.after(() => rm(root, { recursive: true, force: true }));
@@ -54,7 +67,7 @@ export async function fixture(t, provider, { docsOnly = false, unresolvedParamet
const commit = message => { git(headProject, 'add', '.'); git(headProject, 'commit', '-m', message); return git(headProject, 'rev-parse', 'HEAD'); };
const config = { mode: 'deterministic', app: { name: 'Example', platform, bundleId: 'com.example.app', easProfile: 'capture', scheme: 'sample' },
device: { name: 'iPhone 17 Pro' }, navigation: { provider, ...(provider === 'react-navigation' ? { entry: 'src/App.tsx' } : {}) },
exploration: { scope: 'changes' }, capture: { maxMinutes: 30, maxActions: 500, repack: 'eas' },
exploration: { scope: 'changes' }, capture: { maxMinutes: 30, maxActions: 500, repack: 'eas', ...(maxSessions ? { maxSessions } : {}) },
parameters: provider === 'expo-router' && !unresolvedParameters ? { '/item/[id]': { id: 'example-item' } } : {} };
if (targets) config.targets = targets;
if (agentMode) { config.mode = 'agent'; config.agent = { provider: 'anthropic', model: 'fixture-model', instructions: '.expo-explore/instructions.md' }; }
@@ -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(' ')}`);
};
+35 -5
View File
@@ -138,9 +138,10 @@ test("baseline captures a complete single default-branch commit without a PR", (
const job = baseline.jobs.baseline;
assert.match(baseline.jobs.targets.if, /github\.event\.repository\.default_branch/);
assert.deepEqual(job.needs, "targets");
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
assert.deepEqual(job.strategy, { "fail-fast": false, "max-parallel": "${{ fromJSON(needs.targets.outputs.max_parallel) }}",
matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
assert.equal(job.env.TARGET, "${{ matrix.target }}");
assert.match(baseline.jobs.targets.steps.at(-1).run, /config:targets .* \| jq -c '\[\.targets\[\]\.id\]'/);
assert.match(baseline.jobs.targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app\/\$APP_PROJECT_DIR"/);
const verify = job.steps.find(step => step.name === "Verify deterministic source planning");
assert.match(verify.run, /--base-sha "\$GITHUB_SHA" --head-sha "\$GITHUB_SHA" --scope all/);
const capture = job.steps.find(step => step.name === "Capture complete single-commit baseline");
@@ -325,16 +326,21 @@ test("review captures and reports each configured target in its own matrix job,
assert.deepEqual(targets.permissions, { contents: "read", "pull-requests": "read" });
assert.equal(targets.outputs.targets, "${{ steps.targets.outputs.targets }}");
// config:targets lists ids in config order; a config without targets: lists ["ios"] / ["ios","android"], as config:platforms did.
assert.match(targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app-head\/\$APP_PROJECT_DIR" --config \.expo-explore\/config\.yaml \| jq -c '\[\.targets\[\]\.id\]'/);
assert.match(targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app-head\/\$APP_PROJECT_DIR" --config \.expo-explore\/config\.yaml/);
assert.equal(targets.outputs.max_parallel, "${{ steps.targets.outputs.max_parallel }}");
assert.doesNotMatch(JSON.stringify(targets), /EXPO_TOKEN|OPENAI_API_KEY|ANTHROPIC_API_KEY|APP_REVIEW/);
for (const workflow of [review, compare, baseline]) {
assert.doesNotMatch(JSON.stringify(workflow), /matrix\.platform|config:platforms|\$PLATFORM|needs\.platforms/, "every job is keyed by target, never by platform");
assert.match(JSON.stringify(workflow), /matrix\.target/, "doctor looks for matrix.target in an installed workflow");
}
for (const job of [review.jobs.capture, review.jobs.report]) {
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
// Each capture job needs a simulator session, so at most capture.maxSessions of them run at once; a report needs none.
for (const job of [review.jobs.capture, compare.jobs.capture]) {
assert.deepEqual(job.strategy, { "fail-fast": false, "max-parallel": "${{ fromJSON(needs.targets.outputs.max_parallel) }}",
matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
assert.equal(job.env.TARGET, "${{ matrix.target }}");
}
assert.deepEqual(review.jobs.report.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
assert.equal(review.jobs.report.env.TARGET, "${{ matrix.target }}");
assert.equal(review.jobs.capture.needs, "targets");
assert.deepEqual(review.jobs.report.needs, ["targets", "capture"]);
const runs = [review.jobs.capture, review.jobs.report, baseline.jobs.baseline].flatMap(job => job.steps.filter(step => step.run).map(step => step.run));
@@ -378,3 +384,27 @@ test("compare reviews any two refs from a manual run or another workflow, with n
assert.match(compare.jobs.capture.steps.find(step => step.id === "capture").run, /printf '%s' "\$COMPARE" > "\$RUNNER_TEMP\/explore-compare\.json"/);
assert.match(compare.jobs.deploy.steps.at(-1).run, /ci:deploy --inputs/);
});
test("the targets job lists the target ids and how many capture jobs run at once: no more than capture.maxSessions", async t => {
const root = await mkdtemp(join(tmpdir(), "explore-targets-step-"));
t.after(() => rm(root, { recursive: true, force: true }));
const tools = new URL("../..", import.meta.url).pathname;
const run = async (workflow, checkout, config) => {
const project = join(root, checkout); await mkdir(join(project, ".expo-explore"), { recursive: true });
await writeFile(join(project, ".expo-explore", "config.yaml"), config);
const output = join(root, "output"); await writeFile(output, "");
const step = workflow.jobs.targets.steps.find(entry => entry.id === "targets");
const result = spawnSync("bash", ["-c", step.run], { encoding: "utf8",
env: { PATH: process.env.PATH, HOME: root, TOOLS: tools, GITHUB_WORKSPACE: root, APP_PROJECT_DIR: ".", GITHUB_OUTPUT: output } });
assert.equal(result.status, 0, result.stderr);
const outputs = Object.fromEntries((await readFile(output, "utf8")).trim().split("\n").map(line => line.split(/=(.*)/s).slice(0, 2)));
return { targets: JSON.parse(outputs.targets), maxParallel: JSON.parse(outputs.max_parallel) };
};
const app = "app:\n bundleId: com.example.app\n easProfile: explore\ndevice:\n name: iPhone 17\n";
const five = "targets:\n" + ["iphone", "ipad", "duo-closed", "duo-open"].map(id => ` ${id}: { platform: ios }\n`).join("") + " pixel: { platform: android, bundleId: com.example.app, easProfile: explore }\n";
for (const [workflow, checkout] of [[review, "app-head"], [compare, "app-head"], [baseline, "app"]]) {
assert.deepEqual(await run(workflow, checkout, app + five), { targets: ["iphone", "ipad", "duo-closed", "duo-open", "pixel"], maxParallel: 5 }, "unset: five");
assert.deepEqual((await run(workflow, checkout, app + "capture:\n maxSessions: 2\n" + five)).maxParallel, 2, "a starter plan's two");
assert.deepEqual(await run(workflow, checkout, app), { targets: ["ios"], maxParallel: 1 });
}
});
+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/);
});
+135
View File
@@ -0,0 +1,135 @@
import assert from "node:assert/strict";
import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { startArgentBridgeRunner } from "../../dist/capture/argent-bridge-host.js";
import { ARGENT_VERSION } from "../../dist/shared/argent-version.js";
const PNG = Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "base64");
async function fakeClient(root, body) {
const module = join(root, "client.mjs");
await writeFile(module, `const calls = [];\nexport function createArgentClient() { return { calls, async callTool(name, args, options) { calls.push({ name, args }); ${body} } }; }\n`);
return module;
}
test("the bridge thread answers the capture's commands through Argent's client and falls back for other executables", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
await writeFile(join(root, "shot.png"), PNG);
const clientModule = await fakeClient(root, `
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
if (name === "screenshot") return { data: { path: ${JSON.stringify(join(root, "shot.png"))} } };
if (name === "await-screen-idle") { if (options?.signal?.aborted) throw options.signal.reason; await new Promise((resolve, reject) => { const timer = setTimeout(resolve, 5_000); options?.signal?.addEventListener("abort", () => { clearTimeout(timer); reject(options.signal.reason); }); }); return { data: { idle: true } }; }
throw new Error("unexpected tool " + name);`);
const fallbackCalls = [];
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/tools", HOME: root, PATH: process.env.PATH };
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule, fallback: request => { fallbackCalls.push(request.args[0]); return { stdout: "{}", stderr: "" }; } });
t.after(() => bridge.close());
const request = args => ({ command: "/opt/argent-controller", args, cwd: root, environment, timeoutMs: 20_000 });
const version = bridge.runner(request(["--version"]));
assert.equal(version.stdout.trim(), ARGENT_VERSION);
const shot = JSON.parse(bridge.runner(request(["screenshot", join(root, "out", "screen.png"), "--session", "explore", "--platform", "ios", "--json"])).stdout);
assert.equal(shot.success, true);
assert.deepEqual(await readFile(join(root, "out", "screen.png")), PNG, "the materialized artifact is copied where the command asked");
assert.ok(bridge.active);
bridge.runner({ command: "/usr/bin/other", args: ["noop"], cwd: root, environment });
assert.deepEqual(fallbackCalls, ["noop"], "other executables go to the fallback runner");
const started = Date.now();
assert.throws(() => bridge.runner({ ...request(["wait", "stable", "500", "8000", "--session", "explore", "--platform", "ios", "--json"]), timeoutMs: 300 }), /timed out after 300 ms/);
assert.ok(Date.now() - started < 5_000, "a timed-out command is aborted, not waited out");
assert.ok(bridge.active, "the thread answered the abort, so it keeps serving");
assert.equal(bridge.runner(request(["--version"])).stdout.trim(), ARGENT_VERSION);
});
test("a thread whose Argent client cannot load hands every command to the fallback runner", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
const fallbackCalls = [];
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/tools", HOME: root, PATH: process.env.PATH };
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule: join(root, "missing.mjs"), fallback: request => { fallbackCalls.push(request.args[0]); return { stdout: "{}", stderr: "" }; } });
t.after(() => bridge.close());
bridge.runner({ command: "/opt/argent-controller", args: ["snapshot", "--json"], cwd: root, environment, timeoutMs: 20_000 });
bridge.runner({ command: "/opt/argent-controller", args: ["screenshot", "x.png", "--json"], cwd: root, environment, timeoutMs: 20_000 });
assert.deepEqual(fallbackCalls, ["snapshot", "screenshot"]);
assert.equal(bridge.active, false);
});
test("a session whose tool-server was replaced is driven at the new one: the thread starts again with the changed environment", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
await writeFile(join(root, "shot.png"), PNG);
// The fake client notes which tool-server it was given, as Argent's reads ARGENT_TOOLS_URL from its environment.
const clientModule = await fakeClient(root, `
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
if (name === "screenshot") { (await import("node:fs")).appendFileSync(${JSON.stringify(join(root, "servers.txt"))}, process.env.ARGENT_TOOLS_URL + "\\n"); return { data: { path: ${JSON.stringify(join(root, "shot.png"))} } }; }
throw new Error("unexpected tool " + name);`);
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/old", HOME: root, PATH: process.env.PATH };
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule, fallback: () => assert.fail("the thread serves every command") });
t.after(() => bridge.close());
const screenshot = () => JSON.parse(bridge.runner({ command: "/opt/argent-controller", args: ["screenshot", join(root, "out", "screen.png"), "--session", "explore", "--platform", "ios", "--json"],
cwd: root, environment, timeoutMs: 20_000 }).stdout);
assert.equal(screenshot().success, true);
// As the capture's local recovery does: the same environment object, pointed at the restarted tool-server.
Object.assign(environment, { ARGENT_TOOLS_URL: "http://127.0.0.1:9/new", ARGENT_AUTH_TOKEN: "new-token" });
assert.equal(screenshot().success, true);
assert.deepEqual((await readFile(join(root, "servers.txt"), "utf8")).trim().split("\n"), ["http://127.0.0.1:9/old", "http://127.0.0.1:9/new"]);
assert.ok(bridge.active);
});
test("a thread that crashes stops serving, and the commands after it run per command", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
await writeFile(join(root, "shot.png"), PNG);
// An exception nothing catches, thrown on the thread well after its answer.
const clientModule = await fakeClient(root, `
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
if (name === "screenshot") { setTimeout(() => { throw new Error("the client crashed"); }, 300); return { data: { path: ${JSON.stringify(join(root, "shot.png"))} } }; }
throw new Error("unexpected tool " + name);`);
const fallbackCalls = [], messages = [];
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/tools", HOME: root, PATH: process.env.PATH };
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule, progress: message => messages.push(message),
fallback: request => { fallbackCalls.push(request.args[0]); return { stdout: "{}", stderr: "" }; } });
t.after(() => bridge.close());
const request = args => ({ command: "/opt/argent-controller", args, cwd: root, environment, timeoutMs: 20_000 });
assert.equal(JSON.parse(bridge.runner(request(["screenshot", join(root, "out", "screen.png"), "--session", "explore", "--platform", "ios", "--json"])).stdout).success, true);
await new Promise(resolve => setTimeout(resolve, 1_500));
assert.equal(bridge.active, false);
assert.match(messages.join("\n"), /the Argent bridge thread failed \(the client crashed\)/);
bridge.runner(request(["snapshot", "--json"]));
assert.deepEqual(fallbackCalls, ["snapshot"]);
});
test("a recording runs per command, and a screenshot is taken only from a file that is an image", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
await writeFile(join(root, "shot.png"), PNG);
await writeFile(join(root, "notes.txt"), "not a screenshot\n");
const answer = join(root, "answer.json");
const clientModule = await fakeClient(root, `
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
if (name === "screenshot") return { data: JSON.parse((await import("node:fs")).readFileSync(${JSON.stringify(answer)}, "utf8")) };
throw new Error("unexpected tool " + name);`);
const fallbackCalls = [];
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/tools", HOME: root, PATH: process.env.PATH };
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule,
fallback: request => { fallbackCalls.push(request.args.slice(0, 2).join(" ")); return { stdout: "{}", stderr: "" }; } });
t.after(() => bridge.close());
const request = args => ({ command: "/opt/argent-controller", args, cwd: root, environment, timeoutMs: 20_000 });
bridge.runner(request(["record", "start", join(root, "launch.mp4"), "--scope", "app", "--json"]));
bridge.runner(request(["record", "stop", "--json"]));
assert.deepEqual(fallbackCalls, ["record start", "record stop"], "recordings go to the per-command bridge");
assert.ok(bridge.active);
const screenshot = out => JSON.parse(bridge.runner({ ...request(["screenshot", out, "--session", "explore", "--platform", "ios", "--json"]), allowFailure: true }).stdout);
// A path to a file that is not an image is not a screenshot, whatever its key; the image beside it is.
await writeFile(answer, JSON.stringify({ path: join(root, "notes.txt"), image: join(root, "shot.png") }));
assert.equal(screenshot(join(root, "out", "one.png")).success, true);
assert.deepEqual(await readFile(join(root, "out", "one.png")), PNG);
await writeFile(answer, JSON.stringify({ path: join(root, "notes.txt") }));
const failed = screenshot(join(root, "out", "two.png"));
assert.equal(failed.success, false);
assert.match(failed.error.message, /did not write/);
await assert.rejects(readFile(join(root, "out", "two.png")), { code: "ENOENT" });
});
+25
View File
@@ -94,6 +94,31 @@ test("reviewed build diff preserves exact cross-build evidence and split/merge s
);
});
test("a screen diff carries the compared screenshot's recorded shape, After's first", async () => {
const fixture = await createBuildWorkspaceFixture();
const currentBuild = fixture.catalog.builds.find((build) => build.id === "build-2.0.0");
const baselineBuild = fixture.catalog.builds.find((build) => build.id === "build-1.0.0");
const artifact = (map, id) => map.artifacts.find((entry) => entry.id === `artifact-observation-${id}`);
// The reviewed After turned landscape; Before stays portrait.
Object.assign(artifact(fixture.currentMap, "build-2.0.0-current-profile-reviewed"), { width: 60, height: 30 });
// A capture without a recorded size (not a PNG) gives the frame nothing to take.
const added = artifact(fixture.currentMap, "build-2.0.0-current-added-primary");
delete added.width;
delete added.height;
const diff = diffModel.buildDiff({
currentBuild,
currentMap: fixture.currentMap,
baselineBuild,
baselineMap: fixture.baselineMap,
comparison: fixture.comparison,
});
assert.equal(diff.screens.get("current-profile")?.screenshotAspect, 2);
assert.equal(diff.screens.get(removedScreenId("build-1.0.0", "baseline-legacy"))?.screenshotAspect, 0.5);
assert.equal(diff.screens.get("current-added")?.screenshotAspect, undefined);
});
test("catalog route context contains only the two real builds", async () => {
const fixture = await createBuildWorkspaceFixture();
assert.deepEqual(diffModel.routeContextForCatalog(fixture.catalog), {
@@ -135,6 +135,9 @@ test("capture recipes exclude display settings but bind agent instructions and c
assert.equal(JSON.parse(key).observer, CAPTURE_OBSERVER_HASH);
assert.match(JSON.parse(key).observer, /^[a-f0-9]{64}$/);
assert.equal(key,captureRecipeConfig({...config,app:{...config.app,name:"Renamed display"}}));
// How many sessions capture it does not change the evidence: a baseline captured under any ceiling serves the review.
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,maxSessions:16}}));
assert.equal(captureRecipeConfig({...config,capture:{...config.capture,maxSessions:4}}),captureRecipeConfig({...config,capture:{...config.capture,maxSessions:16}}));
// An unset repack is keyed as it resolves, so configs that never chose one keep the recipe of the old written-out default.
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,repack:"eas"}}));
assert.equal(JSON.parse(key).capture.repack, "eas");
+60 -2
View File
@@ -14,7 +14,10 @@ import { AGENT_DEVICE_VERSION, captureDeepLink, controllerCommandFailure, revisi
import { CiError, serializeCiError } from '../../dist/shared/ci-errors.js';
import { createSourceCapturePlan } from '../../dist/source/capture-plan.js';
import { CAPTURE_OBSERVER_IDENTIFIER } from '../../dist/capture/observer.js';
import { parseRuntimeExecutionContext } from '../../dist/review/runtime-adapter.js';
import { parseRuntimeExecutionContext, runtimeEvidenceInputFromMap } from '../../dist/review/runtime-adapter.js';
import { readExportedMap } from '../../dist/review/evidence-assessment.js';
import { projectRuntimeEvidence } from '../../dist/review/runtime-evidence.js';
import { mergeCaptureExports } from '../../dist/ci/export-merge.js';
import { assertCompleteCaptures, hasVerifiedCapture } from '../../dist/capture/health.js';
import { readCaptureBundle } from '../../dist/review/capture-review.js';
import { writeCaptureObserverPackages } from '../helpers/capture-observer-fixture.mjs';
@@ -145,7 +148,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: '' };
}
@@ -3556,3 +3560,57 @@ test('a verified label is located on the image\'s axes when the screenshot is th
// A 669 x 951 portrait panel captured upright as a 951 x 669 image: the button near its bottom-left is near the image's top-left.
assert.deepEqual(verifiedCaptureLabels(nodes, ['Done'], { height: 951 })[0].rect, { x: 11, y: 10, width: 40, height: 100 });
});
test('a session given only the dark pass (appearancePass) captures @dark screens shaped as in a single run', async t => {
const f = await fixture(t, { userInterfaceStyle: 'automatic' });
const result = await runCiMap({ ...f.options, appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
assert.equal(result.runStatus, 'complete');
assert.deepEqual(f.requests.filter(request => request.args[0] === 'settings').map(request => request.args.slice(1, 3)), [['appearance', 'dark']]);
assert.equal(f.requests.filter(request => request.args[0] === 'screenshot').length, 2);
const map = JSON.parse(await readFile(join(f.options.outputDirectory, 'screen-map.json'), 'utf8'));
assert.deepEqual(map.run.environment.colorSchemes, ['light', 'dark']);
assert.deepEqual(map.screens.map(screen => [screen.id, screen.colorScheme]), [[`${f.ids.home}@dark`, 'dark'], [`${f.ids.settings}@dark`, 'dark']]);
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
assert.deepEqual(Object.keys(bundle.images).sort(), [`${f.ids.home}@dark`, `${f.ids.settings}@dark`]);
assert.deepEqual(Object.keys(bundle.outcomes).sort(), [`${f.ids.home}@dark`, `${f.ids.settings}@dark`]);
assert.equal(bundle.runtimeProfile.colorSchemes, 'light,dark');
});
test('a session given only the dark pass keeps a wrong landing as the unattributed frame its pass recorded, for the export merge', async t => {
const f = await fixture(t, { userInterfaceStyle: 'automatic', markerMismatchAt: { path: '/settings', scheme: 'dark' } });
const result = await runCiMap({ ...f.options, appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
const dark = `${f.ids.settings}@dark`;
// Without the light pass beside it, the frame is not demoted to a lost route: the merge decides, as one run's passes do.
assert.equal(result.outcomes[dark].status, 'captured');
assert.equal(result.outcomes[dark].landing, 'unverified');
assert.equal(result.outcomes[f.ids.settings], undefined);
assert.equal(result.runStatus, 'partial');
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
assert.equal(bundle.images[dark].sha256, result.outcomes[dark].screenshotSha256);
assert.deepEqual(Object.keys(bundle.outcomes).sort(), [`${f.ids.home}@dark`, dark].sort());
});
test('a split side merges into the export one run makes: each appearance a verified sibling, its runtime evidence resolvable', async t => {
const f = await fixture(t, { userInterfaceStyle: 'automatic' });
const at = name => ({ mapDirectory: join(f.root, `map${name}`), outputDirectory: join(f.root, `export${name}`) });
await runCiMap({ ...f.options, ...at('-single') });
await runCiMap({ ...f.options, ...at(''), appearancePass: { all: ['light', 'dark'], capture: ['light'] } });
await runCiMap({ ...f.options, ...at('-dark'), appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
await mergeCaptureExports(join(f.root, 'export'), [{ directory: join(f.root, 'export-dark'), scheme: 'dark' }]);
const [single, merged] = await Promise.all(['export-single', 'export'].map(name => readCaptureBundle(join(f.root, name))));
assert.deepEqual(Object.keys(merged.images).sort(), Object.keys(single.images).sort());
assert.deepEqual(merged.outcomes, single.outcomes);
// What a review needs of a sibling appearance (#28): its own verified frame and a map that resolves it as one run's would.
const map = await readExportedMap(join(f.root, 'export'));
const execution = parseRuntimeExecutionContext(JSON.parse(await readFile(join(f.root, 'export', 'execution.json'), 'utf8')));
for (const [route, id] of Object.values(f.ids).flatMap(id => [[id, id], [id, `${id}@dark`]])) {
// A verified secondary frame has no outcome of its own: it is verified under its route's, as the review reads it.
const outcome = merged.outcomes[id] ?? merged.outcomes[route];
assert.equal(outcome.status, 'captured', id); assert.equal(outcome.landing, 'verified', id);
assert.ok(existsSync(join(f.root, 'export', merged.images[id].path)), id);
const screen = map.screens.find(entry => entry.id === id);
assert.equal(screen.observationIds.length, 1, id);
projectRuntimeEvidence(runtimeEvidenceInputFromMap({ side: 'head', map, screenId: id, representativeObservationId: screen.observationIds[0],
sampleObservationIds: screen.observationIds, expectedSampleCount: 1, profile: 'capture:com.example.app', execution }));
}
});
+99
View File
@@ -17,6 +17,7 @@ function element(options = {}) {
label: options.label ?? "Continue",
...(options.visible === undefined ? { visible: true } : { visible: options.visible }),
...(options.selector === undefined ? {} : { selector: options.selector }),
...(options.bounds === undefined ? {} : { bounds: options.bounds }),
occurrence: options.occurrence ?? 0,
controller: "agent-device",
actions: options.actions ?? ["press"],
@@ -320,6 +321,104 @@ test("keeps an unannotated label delta in the accessibility category", () => {
);
});
test("a label that varies within both builds, in the words that differ between them, is runtime state", () => {
const stamp = (label) => [element({ elementId: "stamp", identifier: "stamp", role: "text", label, actions: [], actionable: false })];
const sibling = (base, head) => ({ base: side("base", base), head: side("head", head) });
const input = {
impact: impact(),
base: side("base", stamp("edited 2m ago")),
head: side("head", stamp("edited 3m ago")),
visualAssessment: visual(),
};
const plain = supportedChanges(compareSurfaceEvidence(input));
assert.ok(plain.some((change) => change.kind === "accessibility-label-changed"), "without a sibling capture the label difference is a change");
const result = compareSurfaceEvidence({ ...input, siblings: [sibling(stamp("edited 1m ago"), stamp("edited 4m ago"))] });
const changes = supportedChanges(result);
assert.deepEqual(changes.map((change) => change.kind), ["unstable-text"]);
assert.deepEqual(changes[0], { kind: "unstable-text", subjectRole: "text", before: "edited 2m ago", after: "edited 3m ago", within: "edited 4m ago" });
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
assert.deepEqual(summary.facts.map((fact) => [fact.templateId, fact.bullet]),
[["visible-text.unstable-within-build", "Text varies between captures of the same build: \u201cedited 2m ago\u201d / \u201cedited 4m ago\u201d / \u201cedited 3m ago\u201d."]]);
assert.equal(summary.needsReview, false);
// A stable label beside it is still a change.
const save = (label) => element({ identifier: "save", label });
const mixed = compareSurfaceEvidence({
...input,
base: side("base", [...stamp("edited 2m ago"), save("Submit")]),
head: side("head", [...stamp("edited 3m ago"), save("Save")]),
siblings: [sibling([...stamp("edited 1m ago"), save("Submit")], [...stamp("edited 4m ago"), save("Save")])],
});
assert.deepEqual(supportedChanges(mixed).map((change) => change.kind).sort(), ["accessibility-label-changed", "unstable-text"]);
// Pixels that only an unstable label explains still get the generic styling line.
const pixels = compareSurfaceEvidence({ ...input, visualAssessment: visual("modified"), siblings: [sibling(stamp("edited 1m ago"), stamp("edited 4m ago"))] });
assert.deepEqual(supportedChanges(pixels).map((change) => change.kind), ["unstable-text", "visual-changed"]);
});
test("a label that follows the appearance, or changed in a word that does not vary, is still a change", () => {
const label = (text) => [element({ identifier: "toggle", label: text })];
const compare = ([baseLight, baseDark], [headLight, headDark], options = {}) => supportedChanges(compareSurfaceEvidence({
impact: impact(),
base: side("base", label(baseLight), options.base),
head: side("head", label(headLight), options.head),
visualAssessment: visual(),
siblings: [{ base: side("base", label(baseDark)), head: side("head", label(headDark), options.headSibling) }],
})).map((change) => change.kind);
// The theme toggle's label follows the appearance; the head broke it in light only.
assert.deepEqual(compare(["Switch to dark mode", "Switch to light mode"], ["Switch to light mode", "Switch to light mode"]), ["accessibility-label-changed"]);
assert.deepEqual(compare(["Switch to dark mode", "Switch to light mode"], ["Enable dark mode", "Switch to light mode"]), ["accessibility-label-changed"]);
// The base varies, the head does not.
assert.deepEqual(compare(["Save", "Save draft"], ["Submit", "Submit"]), ["accessibility-label-changed"]);
// The time varies; the name beside it changed.
assert.deepEqual(compare(["Posted by Alice · 2m", "Posted by Alice · 3m"], ["Posted by Bob · 4m", "Posted by Bob · 5m"]), ["accessibility-label-changed"]);
// A sibling capture that did not resolve cleanly is no evidence.
assert.deepEqual(compare(["Saved 2m ago", "Saved 3m ago"], ["Saved 4m ago", "Saved 5m ago"], { headSibling: { capturedSamples: 1 } }), ["accessibility-label-changed"]);
assert.deepEqual(compare(["Saved 2m ago", "Saved 3m ago"], ["Saved 4m ago", "Saved 5m ago"]), ["unstable-text"]);
// Provenance on one side only stays inconclusive.
const annotation = [{ identifier: "toggle", role: "button", textSource: "visible-title" }];
const result = compareSurfaceEvidence({
impact: impact(),
base: side("base", label("Saved 2m ago"), { annotations: annotation }),
head: side("head", label("Saved 4m ago")),
visualAssessment: visual(),
siblings: [{ base: side("base", label("Saved 3m ago"), { annotations: annotation }), head: side("head", label("Saved 5m ago")) }],
});
assert.equal(result.needsReview, true);
assert.ok(result.reviewReasons.some((reason) => /provenance.*one side/i.test(reason)));
assert.equal(supportedChanges(result).some((change) => change.kind === "unstable-text"), false);
});
test("text without an identifier that varies within both builds is matched by its place, not its label", () => {
const bounds = { x: 0, y: 120, width: 390, height: 64 };
// A pattern row: a pressable with one accessibility label and no testID, exposed again by its container on iOS.
const row = (label) => [
element({ elementId: "row", role: "button", label, selector: `label=${label}`, bounds }),
element({ elementId: "row-cell", role: "other", label, selector: `label=${label}`, bounds, actions: [], actionable: false }),
];
const compare = (baseLabels, headLabels) => compareSurfaceEvidence({
impact: impact(),
base: side("base", row(baseLabels[0])),
head: side("head", row(headLabels[0])),
visualAssessment: visual(),
...(baseLabels[1] ? { siblings: [{ base: side("base", row(baseLabels[1])), head: side("head", row(headLabels[1])) }] } : {}),
});
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo, 4 lanes, edited 2m ago"], ["Velvet Tresillo, 4 lanes, edited 4m ago"])).map((change) => change.kind).sort(),
["element-added", "element-removed"], "without a sibling capture the row left and arrived");
const result = compare(["Velvet Tresillo, 4 lanes, edited 2m ago", "Velvet Tresillo, 4 lanes, edited 3m ago"],
["Velvet Tresillo, 4 lanes, edited 4m ago", "Velvet Tresillo, 4 lanes, edited 5m ago"]);
assert.deepEqual(supportedChanges(result), [{ kind: "unstable-text", subjectRole: "button",
before: "Velvet Tresillo, 4 lanes, edited 2m ago", after: "Velvet Tresillo, 4 lanes, edited 4m ago", within: "Velvet Tresillo, 4 lanes, edited 5m ago" }]);
assert.equal(result.needsReview, false);
// A random name is runtime state the same way.
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo", "Copper Pulse"], ["Hollow Echo", "Ghost Relay"])).map((change) => change.kind), ["unstable-text"]);
// A real change in the same row is still a change.
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo, 4 lanes, edited 2m ago", "Velvet Tresillo, 4 lanes, edited 3m ago"],
["Velvet Tresillo, 5 lanes, edited 4m ago", "Velvet Tresillo, 5 lanes, edited 5m ago"])).map((change) => change.kind).sort(), ["element-added", "element-removed"]);
});
test("fails closed when visible-title provenance exists on only one side", () => {
const annotation = [{
identifier: "primary-cta",
+9
View File
@@ -346,6 +346,15 @@ test("target ids and entries are validated", () => {
assert.throws(() => validateExploreConfig({ ...base(), targets }), error => error.code === "CONFIG_INVALID", JSON.stringify(targets));
}
assert.throws(() => validateExploreConfig({ ...base(), platforms: { ios: {} }, targets: { iphone: { platform: "ios" } } }), /targets or platforms, not both/);
const twoTargets = { iphone: { platform: "ios" }, ipad: { platform: "ios" } };
assert.equal(validateExploreConfig({ ...base(), targets: twoTargets, capture: { maxSessions: 2 } }).capture.maxSessions, 2);
assert.equal("maxSessions" in validateExploreConfig({ ...base(), targets: twoTargets }).capture, false);
// A ceiling below the number of targets runs that many target jobs at once (a starter plan's one simulator per platform).
assert.equal(validateExploreConfig({ ...base(), targets: twoTargets, capture: { maxSessions: 1 } }).capture.maxSessions, 1);
assert.throws(() => validateExploreConfig({ ...base(), capture: { maxSessions: 0 } }), /capture.maxSessions must be a positive integer/);
assert.throws(() => validateExploreConfig({ ...base(), capture: { maxSessions: 1.5 } }), /capture.maxSessions must be a positive integer/);
const platforms = { ios: {}, android: { bundleId: "com.example.app", easProfile: "explore" } };
assert.equal(validateExploreConfig({ ...base(), platforms, capture: { maxSessions: 1 } }).capture.maxSessions, 1);
});
test("a target can choose its own controller and simulator over capture's", () => {
+96
View File
@@ -0,0 +1,96 @@
import assert from "node:assert/strict";
import { mkdtemp, mkdir, readFile, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { mergeSchemeOutcomes } from "../../dist/capture/appearance.js";
import { mergeCaptureExports } from "../../dist/ci/export-merge.js";
async function writeExport(root, { screens, images, outcomes, launch, diagnostics }) {
await mkdir(join(root, "artifacts"), { recursive: true });
await mkdir(join(root, "capture-diagnostics"), { recursive: true });
const artifacts = [];
for (const screen of screens) {
const path = `artifacts/${screen}.png`;
await writeFile(join(root, path), screen);
artifacts.push({ id: `artifact-${screen}`, path, sha256: screen, bytes: screen.length, mimeType: "image/png" });
}
const map = { contract: "explore.map", revision: 1, run: { id: "run", environment: { colorSchemes: ["light", "dark"] } }, artifacts,
screens: screens.map(id => ({ id, colorScheme: id.endsWith("@dark") ? "dark" : "light" })), variants: [], observations: screens.map(id => ({ screenId: id })),
elements: [], actionAttempts: [], transitions: [], journeys: [], frontier: [], gaps: [] };
await writeFile(join(root, "screen-map.json"), JSON.stringify(map));
await writeFile(join(root, "bundle.json"), JSON.stringify({ contract: "explore.bundle", side: "head", runtimeProfile: { colorSchemes: "light,dark" }, images, outcomes, ...(launch ? { launch } : {}) }));
await writeFile(join(root, "manifest.json"), JSON.stringify({ contract: "explore.map", runId: "run", revision: 1, files: artifacts.map(({ id: _id, ...file }) => file) }));
await writeFile(join(root, "capture-diagnostics", "controller-timing.jsonl"), diagnostics);
return root;
}
test("a dark session's export folds into the light session's: @dark frames, outcomes, launch, map records, files and diagnostics", async () => {
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
const primary = await writeExport(join(root, "head-export"), { screens: ["home", "settings"],
images: { home: { path: "artifacts/home.png" }, settings: { path: "artifacts/settings.png" } },
outcomes: { home: { status: "captured", landing: "verified", attempts: 1 }, settings: { status: "captured", landing: "verified", attempts: 1 } },
launch: { light: { splash: "l" } }, diagnostics: "{\"pass\":\"light\"}\n" });
const dark = await writeExport(join(root, "head-export-dark"), { screens: ["home@dark", "settings@dark"],
images: { "home@dark": { path: "artifacts/[email protected]" }, "settings@dark": { path: "artifacts/[email protected]" } },
// A secondary-only run reports a route it lost under the route id, as a run's dark pass does before the passes merge.
outcomes: { "home@dark": { status: "captured", landing: "verified", attempts: 2 }, settings: { status: "failed", landing: "unverified", attempts: 3 } },
launch: { dark: { splash: "d" } }, diagnostics: "{\"pass\":\"dark\"}\n" });
await mergeCaptureExports(primary, [{ directory: dark, scheme: "dark" }]);
const bundle = JSON.parse(await readFile(join(primary, "bundle.json"), "utf8"));
assert.deepEqual(Object.keys(bundle.images).sort(), ["home", "home@dark", "settings", "settings@dark"]);
// As in one run: a dark frame verified beside its light one needs no record of its own; a lost one is the scheme's own outcome.
assert.deepEqual(bundle.outcomes, { home: { status: "captured", landing: "verified", attempts: 2 }, settings: { status: "captured", landing: "verified", attempts: 3 },
"settings@dark": { status: "failed", landing: "unverified", attempts: 3 } });
assert.deepEqual(bundle.launch, { light: { splash: "l" }, dark: { splash: "d" } });
const map = JSON.parse(await readFile(join(primary, "screen-map.json"), "utf8"));
assert.deepEqual(map.screens.map(screen => screen.id), ["home", "settings", "home@dark", "settings@dark"]);
assert.equal(map.observations.length, 4);
assert.equal(map.artifacts.length, 4);
const manifest = JSON.parse(await readFile(join(primary, "manifest.json"), "utf8"));
assert.deepEqual(manifest.files.map(file => file.path).sort(), ["artifacts/home.png", "artifacts/[email protected]", "artifacts/settings.png", "artifacts/[email protected]"]);
assert.equal(await readFile(join(primary, "artifacts/[email protected]"), "utf8"), "home@dark");
assert.equal(await readFile(join(primary, "capture-diagnostics/controller-timing.jsonl"), "utf8"), "{\"pass\":\"light\"}\n{\"pass\":\"dark\"}\n");
// Merging is idempotent for records already present.
await mergeCaptureExports(primary, [{ directory: dark, scheme: "dark" }]);
assert.equal(JSON.parse(await readFile(join(primary, "screen-map.json"), "utf8")).screens.length, 4);
});
test("merged passes recombine as one run's: an unattributed dark frame beside a verified light one is kept", async () => {
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
const light = { status: "captured", landing: "verified", attempts: 1 };
const wrong = { status: "captured", landing: "unverified", attempts: 2, screenshotSha256: "x", observed: { reason: "landing-mismatch", route: "/login", attempts: 2 } };
const primary = await writeExport(join(root, "head-export"), { screens: ["settings"], images: { settings: { path: "artifacts/settings.png" } },
outcomes: { settings: light }, diagnostics: "" });
const dark = await writeExport(join(root, "head-export-dark"), { screens: ["settings@dark"], images: { "settings@dark": { path: "artifacts/[email protected]" } },
outcomes: { "settings@dark": wrong }, diagnostics: "" });
await mergeCaptureExports(primary, [{ directory: dark, scheme: "dark" }]);
const bundle = JSON.parse(await readFile(join(primary, "bundle.json"), "utf8"));
assert.deepEqual(bundle.outcomes, mergeSchemeOutcomes([{ settings: light }, { settings: wrong }], ["light", "dark"]));
assert.deepEqual(bundle.outcomes["settings@dark"], wrong);
});
test("a dark session that could not show dark (Argent without appearance.set) adds nothing, and an open gap leaves the run partial", async () => {
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
const primary = await writeExport(join(root, "head-export"), { screens: ["home"], images: { home: { path: "artifacts/home.png" } },
outcomes: { home: { status: "captured", landing: "verified", attempts: 1 } }, diagnostics: "" });
const bundlePath = join(primary, "bundle.json"), mapPath = join(primary, "screen-map.json");
// The primary session could not switch either: it captured light only.
await writeFile(bundlePath, JSON.stringify({ ...JSON.parse(await readFile(bundlePath, "utf8")), runtimeProfile: { colorScheme: "light" } }));
await writeFile(mapPath, JSON.stringify({ ...JSON.parse(await readFile(mapPath, "utf8")), run: { id: "run", status: "complete", environment: {} } }));
const narrowed = await writeExport(join(root, "head-export-dark"), { screens: [], images: {}, outcomes: {}, diagnostics: "" });
const narrowedBundle = join(narrowed, "bundle.json");
await writeFile(narrowedBundle, JSON.stringify({ ...JSON.parse(await readFile(narrowedBundle, "utf8")), runtimeProfile: { colorScheme: "light" } }));
await mergeCaptureExports(primary, [{ directory: narrowed, scheme: "dark" }]);
assert.deepEqual(Object.keys(JSON.parse(await readFile(bundlePath, "utf8")).outcomes), ["home"]);
assert.equal(JSON.parse(await readFile(mapPath, "utf8")).run.status, "complete");
const gapped = await writeExport(join(root, "other-export-dark"), { screens: ["home@dark"], images: { "home@dark": { path: "artifacts/[email protected]" } },
outcomes: { "home@dark": { status: "captured", landing: "verified", attempts: 1 } }, diagnostics: "" });
const gappedMap = join(gapped, "screen-map.json");
await writeFile(gappedMap, JSON.stringify({ ...JSON.parse(await readFile(gappedMap, "utf8")), gaps: [{ id: "gap-1", status: "open" }] }));
await writeFile(bundlePath, JSON.stringify({ ...JSON.parse(await readFile(bundlePath, "utf8")), runtimeProfile: { colorSchemes: "light,dark" } }));
await mergeCaptureExports(primary, [{ directory: gapped, scheme: "dark" }]);
assert.equal(JSON.parse(await readFile(mapPath, "utf8")).run.status, "partial", "a complete run has no open gaps");
});
+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();
});
+24
View File
@@ -437,6 +437,30 @@ test('a review runs at most --parallel targets at once, and every target settles
assert.deepEqual(results.map(result => result.status === 'fulfilled' ? result.value : result.reason.message), [10, 20, 'three', 40, 50]);
});
test('a local review runs no more targets at once than capture.maxSessions', async t => {
const targets = { phone: { platform: 'ios' }, tablet: { platform: 'ios', device: 'iPad Air' } };
// Whether one target's review began before the other's ended, from the order of their progress lines.
const overlapped = async (maxSessions, parallel) => {
const f = await fixture(t, 'expo-router', { targets, maxSessions });
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
const environment = { ...f.environment, EXPLORE_CACHE_DIR: await scratch(t, 'explore-local-cache-'), GITHUB_RUN_ID: '', GITHUB_RUN_ATTEMPT: '', GITHUB_TOKEN: '' };
const lines = [];
const result = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, cache: false, ...(parallel ? { parallel } : {}),
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner: f.runner, now: f.now, sleep: f.sleep,
progress: message => lines.push(message) });
t.after(() => rm(result.work, { recursive: true, force: true }));
assert.deepEqual(result.reports.map(report => report.target.id).sort(), ['phone', 'tablet']);
const span = id => [lines.findIndex(line => line.startsWith(`${id}: `)), lines.findLastIndex(line => line.startsWith(`${id}: `))];
const [phone, tablet] = [span('phone'), span('tablet')];
return phone[0] < tablet[1] && tablet[0] < phone[1];
};
// One simulator at a time: the targets take turns.
assert.equal(await overlapped(1), false);
// The default ceiling (five) runs both at once, and --parallel still chooses for itself.
assert.equal(await overlapped(undefined), true);
assert.equal(await overlapped(1, 2), true);
});
test('a target that fails outright costs only its own report', async t => {
const targets = { phone: { platform: 'ios' }, tablet: { platform: 'ios', device: 'iPad Air' } };
const f = await fixture(t, 'expo-router', { targets });
+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);
+11
View File
@@ -127,6 +127,17 @@ test('local review preparation preserves metadata and verified evidence without
await assert.rejects(readCaptureBundle(join(f.root, 'bad')), /explore\.bundle/);
});
test('a review names the system areas its verdict left out, the platform\'s bands unless told otherwise', async t => {
const f = await captureFixture(t);
// The bundle names the device but not its pose, so preparation does not guess a foldable's panel from it.
const duo = { ...runtimeProfile, deviceModel: 'iPhone Duo' };
for (const side of ['base', 'head']) await writeFile(join(f.options[`${side}Directory`], 'bundle.json'), JSON.stringify({ ...f.bundles[side], runtimeProfile: duo }));
const bands = [{ kind: 'status-bar', x: 0, y: 0, width: 100, height: 6.5 }, { kind: 'home-indicator', x: 0, y: 97, width: 100, height: 3 }];
assert.deepEqual((await prepareCaptureReview(f.options)).review.runtime.systemRegions, bands);
const pill = [{ kind: 'status-bar', x: 92.43, y: 4.48, width: 5.05, height: 10.76 }, bands[1]];
assert.deepEqual((await prepareCaptureReview({ ...f.options, systemRegions: pill })).review.runtime.systemRegions, pill);
});
test('review preparation rejects altered image hashes, metadata and paths outside the capture directory', async t => {
for (const mutation of ['hash', 'dimensions', 'source-commit', 'parent-path', 'absolute-path', 'symlink']) {
await t.test(mutation, async t => {
+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/);
});
+191 -4
View File
@@ -3,10 +3,11 @@ 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 { assessPublicEvidence, decideReview, presenceDescription, ignoreStatusBar, ignoreSystemBands, ignoreSystemRegions, readExportedMap } from "../../dist/review/evidence-assessment.js";
import { STATUS_BAR_BAND_PERCENT } from "../../dist/shared/png-evidence.js";
import { homeIndicatorBandPercent, statusBarBandPercent } from "../../dist/contracts/capture.js";
import { homeIndicatorBandPercent, statusBarBandPercent, systemRegions } from "../../dist/contracts/capture.js";
import { AGENT_DEVICE_VERSION } from "../../dist/capture/run.js";
const BASE_SHA = "a".repeat(40);
@@ -339,8 +340,10 @@ test("expired comparison budgets produce diagnostics rather than review verdicts
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);
let clock = 0;
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", timeBudgetMs: 0, now: () => clock++, measure: async () => { assert.fail('expired comparisons do not run'); } });
let clock = 0, measured = 0;
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", timeBudgetMs: 0, now: () => clock++,
measure: async (...args) => { measured += 1; return measurer({})(...args); } });
assert.equal(measured, 0, "expired comparisons do not run");
assert.equal(result.summary.visual.compared, 0);
assert.equal(result.summary.visual.failed, 3);
assert.equal(result.summary.visual.needsReview, 0);
@@ -419,6 +422,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);
@@ -497,3 +527,160 @@ test("a presence verdict for a long route (an encoded share link) stays within t
}
assert.equal(presenceDescription("Added ", "/home", " screen."), "Added /home screen.");
});
test("screenshot pairs compare a few at a time, in the loop's order, with the same verdicts as one at a time", async (t) => {
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);
const run = async (concurrency) => {
let active = 0, peak = 0;
const started = [];
const measure = async (baselinePath, currentPath) => {
started.push(baselinePath);
active += 1; peak = Math.max(peak, active);
await new Promise(resolve => setTimeout(resolve, 20));
active -= 1;
return measurer({ changed: 3.2, stable: 0.4 })(baselinePath, currentPath);
};
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure, concurrency });
return { peak, started, surfaces: result.surfaces, summary: result.summary };
};
const sequential = await run(1);
const parallel = await run(4);
assert.equal(sequential.peak, 1);
assert.ok(parallel.peak > 1, `comparisons overlap (peak ${parallel.peak})`);
assert.deepEqual(parallel.started, sequential.started, "pairs start in the loop's order");
assert.deepEqual(parallel.surfaces, sequential.surfaces);
assert.deepEqual(parallel.summary, sequential.summary);
});
test("a pair whose turn comes after the budget expired is not started, and one started in time is used", async (t) => {
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);
// The first comparison takes past the budget: it was started in time, the two queued behind it were not.
let time = 0, measured = 0;
const measure = async (...args) => { measured += 1; time += 1_000; return measurer({})(...args); };
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device",
timeBudgetMs: 100, now: () => time, measure, concurrency: 1 });
assert.equal(measured, 1);
assert.equal(result.summary.visual.compared, 1);
assert.equal(result.summary.visual.failed, 2);
assert.ok(result.summary.diagnostics.every(item => item.code === 'VISUAL_COMPARISON_BUDGET_EXHAUSTED'));
});
test("unstable text never makes a screen Modified, and names a variant's runtime state", () => {
const unstable = { category: "visible-text", templateId: "visible-text.unstable-within-build", bullet: 'Text varies between captures of the same build: "2m" / "4m" / "3m".' };
const summary = (facts) => ({ facts, needsReview: false, reviewIssues: [] });
const unchanged = { verdict: "unchanged", reason: "matched", mismatchPercentage: 0, threshold: 0.1, tool: "t" };
const modified = { ...unchanged, verdict: "modified", reason: "repeated-cross-build-delta", mismatchPercentage: 0.4, regions: [{ location: "center" }] };
assert.deepEqual(decideReview("screen", unchanged, summary([unstable])), { status: "unchanged", description: "No visible change" });
const pixels = decideReview("screen", modified, summary([unstable]));
assert.deepEqual([pixels.status, pixels.description, pixels.facts.length], ["modified", "Visual change · 0.4% · center", 1]);
const real = decideReview("screen", modified, summary([{ category: "accessibility", templateId: "accessibility.label-changed", bullet: 'Changed accessibility label from "Submit" to "Save".' }, unstable]));
assert.equal(real.description, 'Changed accessibility label from "Submit" to "Save".');
assert.equal(decideReview("none", modified, summary([unstable])).description, 'Runtime state differs: Text varies between captures of the same build: "2m" / "4m" / "3m".');
// A variant is named by what else differs, ahead of the runtime text.
const target = { category: "interaction", templateId: "interaction.target-changed", bullet: "Changed where “Open” leads." };
assert.equal(decideReview("none", modified, summary([unstable, target])).description, "Runtime state differs: Changed where “Open” leads.");
});
test("text that varies between both builds' own verified appearances is runtime state; an unverified one is no evidence", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-public-evidence-")); t.after(() => rm(root, { recursive: true, force: true }));
const capture = async (unverifiedHeadDark) => {
const base = await side(join(root, `${unverifiedHeadDark}`), "base", manifests.base);
const head = await side(join(root, `${unverifiedHeadDark}`), "head", manifests.head);
const labels = { base: ["edited 2m ago", "edited 3m ago"], head: ["edited 4m ago", "edited 5m ago"] };
for (const [name, current] of [["base", base], ["head", head]]) {
current.bundle.runtimeProfile = { deviceModel: "iPhone 17", osVersion: "26.0", locale: "en-US", orientation: "portrait", colorScheme: "light", colorSchemes: "light,dark" };
await addDarkAppearance(current, manifests[name]);
for (const [index, suffix] of ["", "@dark"].entries()) {
const observation = current.map.observations.find((entry) => entry.id === `${name}-changed-observation${suffix}`);
observation.elements[0].label = labels[name][index];
}
}
if (unverifiedHeadDark) head.bundle.outcomes["changed@dark"] = { status: "captured", attempts: 1, landing: "unverified" };
return assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure: measurer({}) });
};
const verified = await capture(false);
assert.deepEqual(verified.surfaces.changed.review, { status: "unchanged", description: "No visible change" });
assert.deepEqual(verified.surfaces["changed@dark"].review, { status: "unchanged", description: "No visible change" });
// The head's dark capture may show another screen: the light label difference stays a change.
const unverified = await capture(true);
assert.equal(unverified.surfaces.changed.review.status, "modified");
assert.deepEqual(unverified.surfaces.changed.review.facts.map((fact) => fact.templateId), ["accessibility.label-changed"]);
});
test("a foldable's rail clock pill is left out of the verdict like a phone's status bar", () => {
// Measured on EAS Simulator captures of an iPhone Duo (iOS 27.1): a 40×64 pt clock + Wi-Fi pill 28 pt from the right edge.
const closed = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "closed" });
const open = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "open" });
assert.deepEqual(closed, [{ kind: "status-bar", x: 84.55, y: 12.24, width: 10.3, height: 10.62 }, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }]);
assert.deepEqual(open[0], { kind: "status-bar", x: 92.43, y: 4.48, width: 5.05, height: 10.76 });
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone Duo", pose: "half-open" })[0], open[0]);
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone Duo" })[0], closed[0], "a foldable boots closed");
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone 17" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 6.5 }, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }]);
assert.deepEqual(systemRegions({ platform: "android" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 7 }]);
// Diff regions from a comment-only PR's report: the ticking clock on each panel, in that report's normalized rects.
const region = (rect, location) => ({ index: 0, rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: rect, differentPixels: 400, shareOfDiffPercentage: 100, densityPercentage: 50, shape: "wide", size: "small", location, dominantChange: "brighter" });
const closedClock = region({ x: 85.12, y: 12.78, width: 9.08, height: 1.77 }, "middle-right");
const openClock = region({ x: 92.71, y: 5.08, width: 4.45, height: 1.79 }, "top-right");
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 2843532, differentPixels: 400 * regions.length, mismatchPercentage: 0.01, match: false, regions });
const closedOnly = ignoreSystemRegions(measurement([closedClock]), closed);
assert.equal(closedOnly.ignoredStatusBar, 1);
assert.equal(closedOnly.measurement.match, true);
assert.deepEqual(closedOnly.measurement.regions, []);
assert.equal(ignoreSystemRegions(measurement([openClock]), open).measurement.match, true);
// Each panel's pill is only ignored on that panel: the other pose's clock is app content there.
assert.equal(ignoreSystemRegions(measurement([openClock]), closed).ignoredStatusBar, 0);
assert.equal(ignoreSystemRegions(measurement([closedClock]), open).ignoredStatusBar, 0);
// The phone's top band never reached the closed panel's pill, and the open clock's bottom edge (6.9%) crossed it.
assert.equal(ignoreSystemBands(measurement([closedClock, openClock]), { top: 6.5, bottom: 0 }).ignoredTop, 0);
// The app's own rail control just below the pill is kept whole, as is a region that straddles the pill's edge.
const railButton = region({ x: 85.4, y: 25.2, width: 8.6, height: 7.4 }, "middle-right");
const straddling = region({ x: 83, y: 12.78, width: 11.2, height: 1.77 }, "middle-right");
const mixed = ignoreSystemRegions(measurement([closedClock, railButton, straddling]), closed);
assert.equal(mixed.ignoredStatusBar, 1);
// What is kept shares the remaining difference between them.
assert.deepEqual(mixed.measurement.regions, [railButton, straddling].map((kept) => ({ ...kept, shareOfDiffPercentage: 50 })));
assert.equal(mixed.measurement.differentPixels, 800);
assert.equal(mixed.measurement.match, false);
// A region inside the home indicator counts under its own kind.
const indicator = region({ x: 40, y: 97.5, width: 20, height: 1 }, "bottom-center");
const both = ignoreSystemRegions(measurement([closedClock, indicator]), closed);
assert.deepEqual([both.ignoredStatusBar, both.ignoredHomeIndicator, both.measurement.match], [1, 1, true]);
});
test("only an iPhone foldable gets the rail pill, and a region reaching the right edge stays inside a band", () => {
// An Android device whose name matches keeps its own top band; the iPhone Duo's rail is not on its screen.
assert.deepEqual(systemRegions({ platform: "android", device: "Surface Duo", pose: "open" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 7 }]);
// agent-device rounds x and width to 0.01% each, so a region that ends at the right edge can read as ending at 100.01%.
const region = (rect) => ({ index: 0, rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: rect, differentPixels: 400, shareOfDiffPercentage: 100, densityPercentage: 50, shape: "wide", size: "small", location: "top-right", dominantChange: "brighter" });
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 2843532, differentPixels: 400 * regions.length, mismatchPercentage: 0.01, match: false, regions });
const battery = region({ x: 0.63, y: 2, width: 99.38, height: 2 }); // minX 9 of 1440 px
assert.equal(ignoreSystemBands(measurement([battery]), { top: 6.5, bottom: 0 }).ignoredTop, 1);
const indicator = region({ x: 0.63, y: 97.5, width: 99.38, height: 1 });
assert.equal(ignoreSystemRegions(measurement([indicator]), systemRegions({ platform: "ios", device: "iPhone 17" })).ignoredHomeIndicator, 1);
// The slack is the rounding, no more: a region a tenth of a percent past the band is still kept.
assert.equal(ignoreSystemBands(measurement([region({ x: 10, y: 2, width: 20, height: 4.6 })]), { top: 6.5, bottom: 0 }).ignoredTop, 0);
});
test("on a foldable a region across the pill's edge is kept whole, and one across the home indicator's edge is clipped", () => {
const duo = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "closed" });
const region = (rect, normalizedRect, differentPixels) => ({ index: 0, rect, normalizedRect, differentPixels, shareOfDiffPercentage: 100, densityPercentage: 100, shape: "block", size: "small", location: "middle-right", dominantChange: "darker" });
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 87400, differentPixels: regions.reduce((total, entry) => total + entry.differentPixels, 0), mismatchPercentage: 0.11, match: false, regions });
// A pill is not a band: what crosses its edge is the app's own rail, so the frames are never read for it.
const belowPill = region({ x: 85, y: 190, width: 10, height: 20 }, { x: 85, y: 21.74, width: 10, height: 2.29 }, 200);
const kept = ignoreSystemRegions(measurement([belowPill]), duo, () => assert.fail("a pill's edge needs no frames"));
assert.deepEqual([kept.ignoredStatusBar, kept.measurement.match, kept.measurement.regions], [0, false, [belowPill]]);
// The home indicator is a band across the width, as on a phone: in a 100x874 frame its 3% is the last 26 rows, from 848.
const frame = (paint) => { const png = new PngImage({ width: 100, height: 874 }); png.data.fill(255); paint?.(png); return png; };
const painted = (png) => { for (let y = 840; y < 850; y += 1) for (let x = 10; x < 20; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
const crossing = region({ x: 10, y: 840, width: 10, height: 10 }, { x: 10, y: 96.11, width: 10, height: 1.14 }, 100);
const clipped = ignoreSystemRegions(measurement([crossing]), duo, () => ({ baseline: frame(), current: frame(painted), distance: 0.1 * Math.sqrt(3 * 255 ** 2) }));
assert.deepEqual([clipped.ignoredStatusBar, clipped.ignoredHomeIndicator, clipped.measurement.match, clipped.measurement.differentPixels], [0, 1, false, 80]);
assert.deepEqual(clipped.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels, entry.shareOfDiffPercentage]), [[840, 8, 80, 100]]);
});
+35 -1
View File
@@ -258,7 +258,9 @@ test('a visual region may carry the shift its content moved by, and a malformed
const { assertPublicReview } = await import('../../dist/contracts/review-validation.js');
const valid = JSON.parse(JSON.stringify(reviewWithRegion({ x: 0, y: -4.17 })));
assert.doesNotThrow(() => assertPublicReview(valid));
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 500 }, 'up']) {
// A card recentred on iPhone Duo's inner display moved 395 pixels: a large move is still a move.
assert.doesNotThrow(() => assertPublicReview(JSON.parse(JSON.stringify(reviewWithRegion({ x: 395, y: 0 })))));
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 9000 }, 'up']) {
assert.throws(() => assertPublicReview(reviewWithRegion(shift)), /visual verdict is inconsistent/, JSON.stringify(shift));
}
});
@@ -286,3 +288,35 @@ test('allRegionsMoved is only true, and only where every published region carrie
assert.throws(() => assertPublicReview(input), /visual verdict is inconsistent/, label);
}
});
test('a large move publishes as one region where the content is now, with its members\' pixels and the arrived region\'s location', async () => {
const { publishMeasuredRegions } = await import('../../dist/review/evidence-assessment.js');
const region = (x, share, location, dominantChange) => ({ index: 0, rect: { x, y: 100, width: 100, height: 200 },
normalizedRect: { x: x / 10, y: 10, width: 10, height: 20 }, differentPixels: share * 100, shareOfDiffPercentage: share,
densityPercentage: 50, shape: 'block', size: 'large', location, dominantChange });
// Arrived first: the card is centred now, so the region says center whichever member has more pixels.
const all = [region(100, 50.01, 'middle-left', 'brighter'), region(450, 50.01, 'center', 'darker')];
const moves = [{ rect: { x: 450, y: 100, width: 100, height: 200 }, shift: { x: 350, y: 0 }, members: [1, 0] }];
const published = publishMeasuredRegions(all, [undefined, undefined], moves, 1000, 1000);
assert.deepEqual(published.regions, [{ rect: { x: 450, y: 100, width: 100, height: 200 }, normalizedRect: { x: 45, y: 10, width: 10, height: 20 },
differentPixels: 10002, shareOfDiffPercentage: 100, dominantChange: 'mixed', location: 'center', shift: { x: 350, y: 0 } }],
'two shares of 50.01 cap at 100, the Viewer\'s bound');
assert.equal(published.allRegionsMoved, true, 'nothing else on the screen changed');
// A change that is not part of the move keeps the screen from reading as only moved, and more regions than the
// published limit keep the largest.
const crowded = [...all, ...Array.from({ length: 9 }, (_, index) => region(index, 0.5, 'top-left', 'mixed'))];
const withChanges = publishMeasuredRegions(crowded, crowded.map(() => undefined), moves, 1000, 1000);
assert.equal(withChanges.allRegionsMoved, undefined);
assert.equal(withChanges.regions.length, 8);
assert.deepEqual(withChanges.regions[0].shift, { x: 350, y: 0 });
});
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);
});
+198 -1
View File
@@ -1,7 +1,12 @@
import assert from "node:assert/strict";
import test from "node:test";
import { Buffer } from "node:buffer";
import { regionShifts } from "../../dist/review/region-shift.js";
import { mkdtemp, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { PNG } from "pngjs";
import { measureRegionMoves, regionMoves, regionShifts } from "../../dist/review/region-shift.js";
import { measureRegionMovesInWorker } from "../../dist/review/region-shift-worker.js";
/** A 120×160 frame of a light background with dark text-like bars, drawn `offsetY` pixels lower (fractions blend rows). */
function frame(offsetY, { barColor = 40, extraBar = false } = {}) {
@@ -101,3 +106,195 @@ test("a half-pixel move up and down is judged alike", () => {
const up = regionShifts(frame(0), frame(-0.5), [region])[0], down = regionShifts(frame(0), frame(0.5), [region])[0];
assert.deepEqual([up?.y, down?.y], [-0.5, 0.5]);
});
test("a move whose best fit ties with a smaller one is still a move: the search stops no fit that could make it ambiguous", () => {
// Two and a half pixels lower, with a sparse speckle of noise. The tie goes to a fit a little worse than the least error,
// and an ambiguity is judged against that one, so a fit stopped short against the least error must not pass for one.
const moved = frame(2.5), speckled = { ...moved, data: Buffer.from(moved.data) };
for (let y = 0; y < moved.height; y += 1) for (let x = 0; x < moved.width; x += 1) {
if ((x * 3 + y * 5) % 11 !== 0) continue;
const offset = (y * moved.width + x) * 4, value = Math.max(0, Math.min(255, moved.data[offset] + ((x + y) % 2 ? 10 : -10)));
speckled.data.fill(value, offset, offset + 3);
}
assert.deepEqual(regionShifts(frame(0), speckled, [region]), [{ x: 0, y: 2.5 }]);
});
/**
* A light frame with a dark card of irregular blocks at (x, y): the blocks make every offset look different, as a
* real card's text and icons do. `tile` repeats one such block pattern every `tile` pixels across the whole row
* instead, as a grid of identical cells does, starting `x` pixels in.
*/
function cardFrame({ width = 600, height = 300, x = 60, y = 80, cardWidth = 150, cardHeight = 120, seed = 7, tile } = {}) {
const data = Buffer.alloc(width * height * 4, 240);
for (let index = 3; index < data.length; index += 4) data[index] = 255;
const paint = (px, py, value) => data.fill(value, (py * width + px) * 4, (py * width + px) * 4 + 3);
let state = seed;
const random = () => (state = (state * 1103515245 + 12345) % 2147483648) / 2147483648;
const blocks = Array.from({ length: tile ? 6 : 40 }, () => {
const span = tile ?? cardWidth;
return [Math.floor(random() * (span - 12)), Math.floor(random() * (cardHeight - 8)), 4 + Math.floor(random() * 8), 3 + Math.floor(random() * 5), 80 + Math.floor(random() * 160)];
});
for (let py = y; py < y + cardHeight; py += 1) {
for (let px = tile ? 0 : x; px < (tile ? width : x + cardWidth); px += 1) {
const local = tile ? (((px - x) % tile) + tile) % tile : px - x;
const block = blocks.find(([bx, by, bw, bh]) => local >= bx && local < bx + bw && py - y >= by && py - y < by + bh);
paint(px, py, block ? block[4] : 12);
}
}
return { width, height, data };
}
test("a card that moved far along a row is one move, from the regions where it left and where it arrived", () => {
const regions = [
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
];
const shifts = regionShifts(cardFrame(), cardFrame({ x: 330 }), regions);
assert.deepEqual(shifts, [undefined, undefined], "too far for the drift search");
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, shifts),
[{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1, 0] }], "the region it arrived in first");
});
test("a large move is measured on a worker thread the same as on the calling thread", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-region-shift-")); t.after(() => rm(root, { recursive: true, force: true }));
const write = async (name, frame) => {
const png = new PNG({ width: frame.width, height: frame.height }); frame.data.copy(png.data);
await writeFile(join(root, name), PNG.sync.write(png)); return join(root, name);
};
const basePath = await write("base.png", cardFrame()), headPath = await write("head.png", cardFrame({ x: 330 }));
const regions = [
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
];
const measured = await measureRegionMovesInWorker(basePath, headPath, regions);
assert.deepEqual(measured, await measureRegionMoves(basePath, headPath, regions));
assert.deepEqual(measured.moves, [{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1, 0] }]);
});
test("a move whose old and new places overlap takes in the fragments of it the comparison found in between", () => {
// A 300-wide card moved 120 right: the comparison sees where it only was, where it only is, and a fragment of the
// overlap whose pixels differ because the card's own content moved over itself.
const base = cardFrame({ width: 700, cardWidth: 300 }), head = cardFrame({ width: 700, cardWidth: 300, x: 180 });
const regions = [
{ x: 60, y: 80, width: 120, height: 120, dominantChange: "brighter" },
{ x: 360, y: 80, width: 120, height: 120, dominantChange: "darker" },
{ x: 200, y: 100, width: 120, height: 40, dominantChange: "mixed" },
];
const [move] = regionMoves(base, head, regions, regions.map(() => undefined));
assert.deepEqual(move, { rect: { x: 180, y: 80, width: 300, height: 120 }, shift: { x: 120, y: 0 }, members: [1, 0, 2] });
});
test("a card that moved far down a column is a vertical move", () => {
const regions = [
{ x: 100, y: 20, width: 150, height: 100, dominantChange: "brighter" },
{ x: 100, y: 330, width: 150, height: 100, dominantChange: "darker" },
];
const base = cardFrame({ height: 480, x: 100, y: 20, cardHeight: 100 }), head = cardFrame({ height: 480, x: 100, y: 330, cardHeight: 100 });
assert.deepEqual(regionMoves(base, head, regions, [undefined, undefined]),
[{ rect: { x: 100, y: 330, width: 150, height: 100 }, shift: { x: 0, y: 310 }, members: [1, 0] }]);
});
test("content that left one place while other content arrived elsewhere is not a move", () => {
const regions = [
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
];
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330, seed: 99 }), regions, [undefined, undefined]), [], "another card arrived");
// The pair must be opposite: two regions that both got darker are two changes.
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions.map(region => ({ ...region, dominantChange: "darker" })), [undefined, undefined]), []);
// Regions already explained by a small move are not reconsidered.
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, [{ x: 0, y: 1 }, undefined]), []);
});
test("repeating content that lines up at several distances is not a move: the distance would be a guess", () => {
// A row of identical cells every 40 pixels, all moved 260 right: 220, 260 and 300 fit about as well.
const regions = [
{ x: 60, y: 80, width: 100, height: 120, dominantChange: "brighter" },
{ x: 300, y: 80, width: 100, height: 120, dominantChange: "darker" },
];
assert.deepEqual(regionMoves(cardFrame({ tile: 40 }), cardFrame({ tile: 40, x: 320 }), regions, [undefined, undefined]), []);
});
/** Two frames laid over each other: the darker pixel of each wins, so a dark card in either shows. */
function overlay(first, second) {
const data = Buffer.from(first.data);
for (let index = 0; index < data.length; index += 1) data[index] = Math.min(first.data[index], second.data[index]);
return { ...first, data };
}
/** Paints a block of one colour into a frame, as a badge or icon drawn on top. */
function withBlock(frame, { x, y, width, height, value }) {
const data = Buffer.from(frame.data);
for (let py = y; py < y + height; py += 1) for (let px = x; px < x + width; px += 1) data.fill(value, (py * frame.width + px) * 4, (py * frame.width + px) * 4 + 3);
return { ...frame, data };
}
const farMove = [
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
];
test("something new where the card was stays a change: the move takes only the place it arrived", () => {
// The card moved right, and another card took its old place.
const head = overlay(cardFrame({ x: 330 }), cardFrame({ x: 60, seed: 99 }));
assert.deepEqual(regionMoves(cardFrame(), head, farMove, [undefined, undefined]),
[{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1] }]);
// A flat panel in another colour than the backdrop around it: nothing spreads, but it is not the backdrop.
const panel = withBlock(cardFrame({ x: 330 }), { x: 60, y: 80, width: 150, height: 120, value: 180 });
assert.deepEqual(regionMoves(cardFrame(), panel, farMove, [undefined, undefined])[0]?.members, [1]);
// An 8×8 badge where a large card was: a small mark in a large plain area is still something drawn.
const large = [
{ x: 60, y: 80, width: 300, height: 400, dominantChange: "brighter" },
{ x: 600, y: 80, width: 300, height: 400, dominantChange: "darker" },
];
const card = x => cardFrame({ width: 960, height: 560, x, cardWidth: 300, cardHeight: 400 });
assert.deepEqual(regionMoves(card(60), card(600), large, [undefined, undefined])[0]?.members, [1, 0], "plain backdrop joins the move");
const badge = withBlock(card(600), { x: 200, y: 250, width: 8, height: 8, value: 0 });
assert.deepEqual(regionMoves(card(60), badge, large, [undefined, undefined])[0]?.members, [1]);
});
test("content that did not arrive intact is not a move: part of it deleted, or something changed inside it", () => {
// Only the card's top half arrived; its body was deleted.
const deleted = withBlock(cardFrame({ x: 330 }), { x: 330, y: 140, width: 150, height: 60, value: 240 });
assert.deepEqual(regionMoves(cardFrame(), deleted, farMove, [undefined, undefined]), []);
// The card moved, and an 8×8 white mark appeared inside it: a badge is a change, however small.
const marked = withBlock(cardFrame({ x: 330 }), { x: 400, y: 130, width: 8, height: 8, value: 255 });
assert.deepEqual(regionMoves(cardFrame(), marked, farMove, [undefined, undefined]), []);
// Changes of moderate contrast on the dark card: a grey badge, and a button in another shade.
for (const block of [{ x: 400, y: 130, width: 8, height: 8, value: 120 }, { x: 340, y: 160, width: 40, height: 20, value: 60 }]) {
assert.deepEqual(regionMoves(cardFrame(), withBlock(cardFrame({ x: 330 }), block), farMove, [undefined, undefined]), [], JSON.stringify(block));
}
});
test("a hairline that differs where the content arrived is not a change: antialiased edges against another backdrop", () => {
// Two pixels wide and of moderate contrast, as the curve under euxy's Patterns chevrons (brentvatne/euxy#163).
const crossed = withBlock(cardFrame({ x: 330 }), { x: 330, y: 150, width: 150, height: 2, value: 90 });
assert.deepEqual(regionMoves(cardFrame(), crossed, farMove, [undefined, undefined])[0]?.shift, { x: 270, y: 0 });
});
test("content that is the same all down a move along a row keeps the move in line", () => {
// Vertical bars of irregular widths: every small vertical drift fits as well as none.
const bars = x => {
const frame = cardFrame({ x });
const data = Buffer.from(frame.data);
const widths = [6, 11, 4, 9, 14, 5, 8, 12, 7, 10, 6, 13, 9, 5, 11, 7, 6, 8];
let px = x, dark = true;
for (const width of widths) {
for (let py = 80; py < 200; py += 1) for (let column = px; column < Math.min(px + width, x + 150); column += 1) data.fill(dark ? 20 : 200, (py * frame.width + column) * 4, (py * frame.width + column) * 4 + 3);
px += width; dark = !dark;
}
return { ...frame, data };
};
const [move] = regionMoves(bars(60), bars(330), farMove, [undefined, undefined]);
assert.deepEqual(move?.shift, { x: 270, y: 0 });
assert.deepEqual(move?.rect, { x: 330, y: 80, width: 150, height: 120 });
});
test("regions with fractional edges, or reaching past the screenshot, are measured on the pixels they cover", () => {
const regions = [
{ x: 60.4, y: 79.6, width: 149.8, height: 120.5, dominantChange: "brighter" },
{ x: 330.2, y: 80, width: 150.3, height: 400, dominantChange: "darker" },
];
const [move] = regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, [undefined, undefined]);
assert.deepEqual(move?.shift, { x: 270, y: 0 });
});
+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"]);
});
+86
View File
@@ -0,0 +1,86 @@
import assert from "node:assert/strict";
import { chmod, mkdir, mkdtemp, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { sideAppearancePasses } from "../../dist/ci/pipeline.js";
import { DEFAULT_MAX_SESSIONS, maxParallelTargets, planSideSessions, sessionShare } from "../../dist/ci/session-plan.js";
import { validateExploreConfig } from "../../dist/config/explore-config.js";
test("the review-wide session ceiling is divided over the targets, the remainder going to the preferred ones", () => {
const targets = ["iphone", "duo-closed", "duo-open", "android"];
const prefer = target => target.startsWith("duo") ? 1 : 0;
assert.equal(sessionShare({ maxSessions: 8, targets, target: "android" }), 2);
assert.equal(sessionShare({ maxSessions: 16, targets, target: "iphone" }), 4);
assert.equal(sessionShare({ maxSessions: 10, targets, target: "duo-closed", prefer }), 3, "remainder goes to the foldable first");
assert.equal(sessionShare({ maxSessions: 10, targets, target: "duo-open", prefer }), 3);
assert.equal(sessionShare({ maxSessions: 10, targets, target: "iphone", prefer }), 2);
assert.equal(sessionShare({ maxSessions: 2, targets, target: "iphone" }), 1, "never below one");
});
test("unset, the ceiling is a typical plan's five simulators; below the number of targets, that many target jobs run at once", () => {
assert.equal(DEFAULT_MAX_SESSIONS, 5);
// One target: head and base at once, with sessions left to split light and dark.
assert.equal(sessionShare({ maxSessions: undefined, targets: ["iphone"], target: "iphone" }), 5);
assert.deepEqual(planSideSessions({ share: 5, sides: 2, routes: 16, schemes: ["light", "dark"] }), { concurrentSides: true, passes: [["light"], ["dark"]] });
// Two targets: two each, head and base at once, as before the option.
for (const target of ["iphone", "android"]) assert.equal(sessionShare({ maxSessions: undefined, targets: ["iphone", "android"], target }), 2);
// Five targets: one each, head then base.
const five = ["iphone", "ipad", "duo-closed", "duo-open", "android"];
for (const target of five) assert.equal(sessionShare({ maxSessions: undefined, targets: five, target }), 1);
assert.equal(planSideSessions({ share: 1, sides: 2, routes: 16, schemes: ["light", "dark"] }).concurrentSides, false);
assert.deepEqual([maxParallelTargets(undefined, 1), maxParallelTargets(undefined, 2), maxParallelTargets(undefined, 5), maxParallelTargets(undefined, 7)], [1, 2, 5, 5]);
// A starter plan, one simulator per platform: an iOS and an Android target, one session each, both jobs at once.
for (const target of ["iphone", "android"]) assert.equal(sessionShare({ maxSessions: 2, targets: ["iphone", "android"], target }), 1);
assert.equal(maxParallelTargets(2, 2), 2);
// A ceiling below the targets: one session each, and only that many target jobs at a time.
for (const target of five) assert.equal(sessionShare({ maxSessions: 2, targets: five, target }), 1);
assert.equal(maxParallelTargets(2, 5), 2);
assert.equal(maxParallelTargets(16, 4), 4);
});
test("a side splits its appearance passes only when the pass moved out saves at least a minute", () => {
const euxy = { sides: 2, routes: 16, schemes: ["light", "dark"] };
assert.deepEqual(planSideSessions({ share: 2, ...euxy }), { concurrentSides: true, passes: [["light", "dark"]] });
assert.deepEqual(planSideSessions({ share: 4, ...euxy }), { concurrentSides: true, passes: [["light"], ["dark"]] });
assert.deepEqual(planSideSessions({ share: 3, ...euxy }), { concurrentSides: true, passes: [["light", "dark"]] }, "one spare session cannot host a pass for both sides");
assert.deepEqual(planSideSessions({ share: 8, ...euxy, routes: 3 }), { concurrentSides: true, passes: [["light", "dark"]] }, "three routes would save under a minute");
assert.deepEqual(planSideSessions({ share: 8, ...euxy, schemes: ["light"] }), { concurrentSides: true, passes: [["light"]] }, "one appearance never splits");
assert.deepEqual(planSideSessions({ share: 1, ...euxy }), { concurrentSides: false, passes: [["light", "dark"]] }, "one session: the sides take turns");
assert.deepEqual(planSideSessions({ share: 2, sides: 1, routes: 16, schemes: ["light", "dark"] }), { concurrentSides: true, passes: [["light"], ["dark"]] }, "a baseline has one side");
});
test("a side's appearances come from eas config in a child with the capture's environment, read only when a split could pay", async t => {
const root = await mkdtemp(join(tmpdir(), "explore-session-plan-"));
t.after(() => rm(root, { recursive: true, force: true }));
// The app config would leak this process's environment if it were evaluated here.
await writeFile(join(root, "app.config.js"), `module.exports = () => { require("fs").writeFileSync(${JSON.stringify(join(root, "evaluated"))}, "yes"); return {}; };\n`);
const eas = join(root, "eas");
await writeFile(eas, `#!/usr/bin/env node
require("fs").appendFileSync(${JSON.stringify(join(root, "calls"))}, JSON.stringify({ args: process.argv.slice(2), cwd: process.cwd(), env: process.env }) + "\\n");
process.stdout.write(JSON.stringify({ appConfig: { userInterfaceStyle: require("fs").existsSync("light-only") ? "light" : "automatic" }, buildProfile: {} }));
`);
await chmod(eas, 0o755);
const calls = async () => (await readFile(join(root, "calls"), "utf8").catch(() => "")).split("\n").filter(Boolean).map(line => JSON.parse(line));
const config = maxSessions => validateExploreConfig({ app: { bundleId: "com.example.app", easProfile: "explore" }, device: { name: "iPhone 17" },
...(maxSessions === undefined ? {} : { capture: { maxSessions } }) });
const environment = { PATH: process.env.PATH, HOME: process.env.HOME, EXPO_TOKEN: "expo-token", GITHUB_TOKEN: "github-token", ANTHROPIC_API_KEY: "agent-key" };
const side = { share: 2, sides: 1, routes: 16, project: root, easCommand: eas };
assert.equal(await sideAppearancePasses(config(8), environment, { ...side, routes: 3 }), undefined, "three routes would save under a minute");
assert.equal(await sideAppearancePasses(config(1), environment, { ...side, share: 1 }), undefined);
assert.deepEqual(await calls(), [], "no app config is read when no split could pay");
assert.deepEqual(await sideAppearancePasses(config(2), environment, side), [["light"], ["dark"]]);
const [call] = await calls();
assert.deepEqual(call.args, ["config", "--platform", "ios", "--profile", "explore", "--json", "--non-interactive"]);
assert.equal(await realpath(call.cwd), await realpath(root));
assert.equal(call.env.EXPO_TOKEN, "expo-token");
assert.equal(call.env.GITHUB_TOKEN, undefined);
assert.equal(call.env.ANTHROPIC_API_KEY, undefined);
await assert.rejects(readFile(join(root, "evaluated")), "the app config is never evaluated in the review's process");
assert.deepEqual(await sideAppearancePasses(config(undefined), environment, side), [["light"], ["dark"]], "unset, the default ceiling's share splits too");
// Each side reads its own app config: one that declares a single appearance keeps one session.
const lightOnly = join(root, "base"); await mkdir(lightOnly); await writeFile(join(lightOnly, "light-only"), "");
assert.equal(await sideAppearancePasses(config(2), environment, { ...side, project: lightOnly }), undefined);
assert.equal(await sideAppearancePasses(config(2), environment, { ...side, easCommand: join(root, "missing-eas") }), undefined, "an unreadable config keeps one session");
});
+30
View File
@@ -59,3 +59,33 @@ test("a capture that ends without finishing its shared build releases the target
assert.equal(error.code, "CAPTURE_BUILD_FAILED");
assert.match(error.message, /the capture building it stopped \(CAPTURE_WORKER_EXITED\)/);
});
test("a waiter is told the build is repacking only when its builder says so, not while a native build may run", async t => {
const directory = await scratch(t);
let started, repack, finish;
const building = new Promise(resolve => { started = resolve; });
const owner = sharedBuild({ directory, key, appName: "App.app", build: (_keepApp, repacking) => new Promise(resolve => {
started(); repack = repacking; finish = () => resolve({ buildId: "native" }); }) });
await building;
const told = [];
const waiter = sharedBuild({ directory, key, appName: "App.app", build: async () => assert.fail("only the owner builds"),
waiting: () => told.push("waiting"), repacking: () => told.push("repacking") });
// The owner is still in its native build: two polls go by without the waiter's session starting.
await new Promise(resolve => setTimeout(resolve, 4_500));
assert.deepEqual(told, ["waiting"]);
await repack();
await new Promise(resolve => setTimeout(resolve, 2_500));
assert.deepEqual(told, ["waiting", "repacking"]);
finish();
await owner; await waiter;
assert.deepEqual(told, ["waiting", "repacking"]);
});
test("a waiter whose build finished before it looked is told it is repacking once, with the result", async t => {
const directory = await scratch(t);
await sharedBuild({ directory, key, appName: "App.app", build: async () => ({ buildId: "native" }) });
const told = [];
assert.deepEqual(await sharedBuild({ directory, key, appName: "App.app", build: async () => assert.fail("only the owner builds"),
waiting: () => told.push("waiting"), repacking: () => told.push("repacking") }), { buildId: "native" });
assert.deepEqual(told, ["waiting", "repacking"]);
});
+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);
+4
View File
@@ -82,6 +82,10 @@ test("visual diff data from a report is validated before the viewer draws it", (
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 2 }), { regions: [], ignoredStatusBarRegions: 2 });
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 0 }), { regions: [] });
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: "2" }), { regions: [] });
const pill = { kind: "status-bar", x: 84.55, y: 12.24, width: 10.3, height: 10.62 };
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 1, systemRegions: [pill, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }] }),
{ regions: [], ignoredStatusBarRegions: 1, systemRegions: [pill, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }] });
assert.deepEqual(visualDiff({ regions: [], systemRegions: [{ kind: "notch", x: 0, y: 0, width: 10, height: 10 }, { ...pill, width: 0 }, { ...pill, x: 101 }, "pill"] }), { regions: [] });
assert.equal(visualDiff({ regions: Array.from({ length: 200 }, () => PAYWALL[0]) }).regions.length, 64);
});
+9
View File
@@ -45,3 +45,12 @@ test("What changed summarizes a screen whose every area moved, per direction, an
assert.equal(layoutShiftSummary([...moved, ...groupVisualRegions([region(90, 3)])]), undefined);
assert.equal(layoutShiftSummary([]), undefined);
});
test("the Viewer keeps a move hundreds of pixels long: a card recentred on a wide screen", async () => {
const { visualDiff } = await tsImport("../../viewer/src/utils/review-model.ts", import.meta.url);
const parsed = visualDiff({ regions: [{ x: 31.2, y: 21.2, width: 37.6, height: 70.3, share: 63, move: { x: 13.8, y: 0, amount: { x: 395, y: 0 }, unit: "pt" } }], allRegionsMoved: true });
assert.deepEqual(parsed?.regions[0]?.move, { x: 13.8, y: 0, amount: { x: 395, y: 0 }, unit: "pt" });
// An offset is a percent of the image and still bounded by it; the amount only by the review's own limit.
assert.equal(visualDiff({ regions: [{ x: 1, y: 1, width: 10, height: 10, share: 50, move: { x: 140, y: 0, amount: { x: 395, y: 0 }, unit: "pt" } }] })?.regions[0]?.move, undefined);
assert.equal(visualDiff({ regions: [{ x: 1, y: 1, width: 10, height: 10, share: 50, move: { x: 1, y: 0, amount: { x: 9000, y: 0 }, unit: "pt" } }] })?.regions[0]?.move, undefined);
});
+10
View File
@@ -93,3 +93,13 @@ test("doctor names a workflow that sets the app directory in one job but not ano
assert.deepEqual(issues.map(issue => issue.code), ["WORKFLOW_APP_DIR_MISMATCH"]);
assert.match(issues[0].message, /APP_PROJECT_DIR is \. in one of its jobs/);
});
test("ci:after-capture stops the sessions a side's appearance passes recorded, not only the side's own", async t => {
const output = await mkdtemp(join(tmpdir(), "explore-steps-sessions-"));
t.after(() => rm(output, { recursive: true, force: true }));
// Unreadable ids make the cleanup report each file it was handed without calling EAS.
for (const name of ["head-session-dark", "base-session-dark", "baseline-session-light"]) await writeFile(join(output, name), "not a session id\n");
await writeFile(join(output, "head-session-sepia"), "not a session id\n");
const result = await cleanupAfterCapture({ output, checkouts: [], environment: { RUNNER_TEMP: output, EXPO_TOKEN: "token" } });
assert.deepEqual(result.failures.map(failure => failure.message), Array(3).fill("Refusing an invalid session ID."));
});
+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;
/** Say "Open in Inspector" in a tooltip over the screenshot (Screens). The Map's cards go without. */
inspectorTooltip?: boolean;
/** 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}
{/* On Screens, with a pointer, what a click does is said once 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="top" disabled={props.inspectorTooltip === false || 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}
@@ -12,7 +12,8 @@ export type TransitionEdgeData = {
transitionCount: number;
active: boolean;
primary: boolean;
dimmed: boolean;
/** Another screen is selected: the edge steps back to a hairline, so the selection's own stand out. */
quiet: boolean;
sourceOnly?: boolean;
previousSource?: boolean;
tooltip?: string;
@@ -39,9 +40,10 @@ export function TransitionEdge(props: EdgeProps<TransitionGraphEdge>) {
curvature: 0.24,
});
const emphasized = Boolean(props.data?.active || props.selected || hovered);
const dimmed = Boolean(props.data?.dimmed && !emphasized);
const quiet = Boolean(props.data?.quiet && !emphasized);
const stroke = emphasized
? "var(--accent)"
: quiet ? "var(--border-subtle)"
: props.data?.previousSource ? "var(--danger)" : props.data?.primary ? "var(--graph-line)" : "var(--graph-line-soft)";
return (
@@ -66,9 +68,8 @@ export function TransitionEdge(props: EdgeProps<TransitionGraphEdge>) {
style={{
...props.style,
stroke,
strokeWidth: emphasized ? 2.2 : props.data?.primary ? 1.15 : 0.9,
strokeWidth: emphasized ? 2.5 : quiet ? 1 : props.data?.primary ? 1.15 : 0.9,
strokeDasharray: props.data?.sourceOnly ? "6 5" : emphasized || props.data?.primary ? undefined : "4 7",
opacity: dimmed ? 0.12 : 1,
}}
/>
</>
+15 -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;
@@ -107,6 +107,13 @@ export function ZoomBridge(props: {
publishZoom(Math.round(zoom * 100) / 100);
}, [props.cameraReady, zoom]);
// What a stroke that must stay legible at any zoom divides by (the Map's selection ring). It
// moves in quarter-octave steps, so a pinch restyles the canvas a few times, not every frame.
const strokeZoom = 2 ** (Math.round(Math.log2(zoom) * 4) / 4);
useEffect(() => {
canvas?.style.setProperty("--canvas-zoom", String(strokeZoom));
}, [canvas, strokeZoom]);
useEffect(() => {
// Re-registering after selection changes publishes the new capability to the zoom menu.
// Reading through getNodes keeps the commands themselves on the latest canvas snapshot.
@@ -216,18 +223,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 +272,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) => {
@@ -308,11 +308,14 @@
.compare-frame-wrap { position: relative; }
/* Flip: one frame, centred under its Before/After names, in Compare and in the Inspector. The wrap
is a flex row because a block sized by height + aspect-ratio does not shrink-wrap in every engine
(WebKit left the frame at the left edge). */
(WebKit left the frame at the left edge). A stacked landscape pair whose frames are held to part
of the window's height centres them the same way. */
.compare-stage.mode-flip .compare-side,
.sidebar-review-stage.mode-flip .compare-side { width: 100%; align-items: center; }
.sidebar-review-stage.mode-flip .compare-side,
.sidebar-review-stage.mode-split.landscape .compare-side { width: 100%; align-items: center; }
.compare-stage.mode-flip .compare-frame-wrap,
.sidebar-review-stage.mode-flip .compare-frame-wrap { display: flex; justify-content: center; }
.sidebar-review-stage.mode-flip .compare-frame-wrap,
.sidebar-review-stage.mode-split.landscape .compare-frame-wrap { display: flex; justify-content: center; }
.compare-frame {
position: relative;
display: block;
@@ -496,6 +499,15 @@
.sidebar-review-stage.mode-flip {
--compare-frame-height: min(calc(100cqw / var(--compare-aspect)), 70dvh);
}
/* A landscape screenshot (an opened iPhone Duo, an iPad on its side) is too wide for two frames to
share the panel: Before stacks over After, each the panel's width, up to about a third of
the window's height (half of Swipe's and Flip's one frame), so a near-square pair (an unfolded
foldable) and a short window still show both. */
.sidebar-review-stage.mode-split.landscape {
flex-direction: column;
align-items: stretch;
--compare-frame-height: min(calc(100cqw / var(--compare-aspect)), 35dvh);
}
/* Split's labels sit inside the frames here, as Swipe's do. */
.compare-side-tag {
position: absolute;
@@ -1,4 +1,4 @@
import { useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
import { ImageOff, ScanSearch } from "lucide-react";
import type { ChangesMenuData } from "../panels/changes-menu";
import { diffLabel, ACCESSIBILITY_ONLY_HIGHLIGHT, type BuildDiff, type ScreenDiff } from "../../utils/build-diff";
@@ -6,13 +6,14 @@ 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";
import { Tooltip } from "../shared/tooltip";
import { DEFAULT_SCREENSHOT_RATIO, ScreenshotImage, ScreenshotPlaceholder } from "../shared/screenshot-image";
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand, SwipeCompare, SWIPE_STEP } from "../panels/visual-diff";
import { ChangeOutlines, ignoredSystemRegions, SwipeCompare, SystemRegionBands, SWIPE_STEP } from "../panels/visual-diff";
import type { SystemRegion } from "../../utils/review-model";
import { placeholderFor, presentedChanges, splitForAssistiveTechnology } from "../../utils/presented-changes";
import { CompareNav, WhatChangedPopover } from "./compare-header";
import "./compare-section.css";
@@ -135,7 +136,19 @@ export function useCompareController(options: CompareControllerOptions) {
const [flipSide, setFlipSide] = useState<"before" | "after">("after");
const [swipePosition, setSwipePosition] = useState(50);
const [factsOpen, setFactsOpen] = useState(false);
const [aspect, setAspect] = useState(DEFAULT_SCREENSHOT_RATIO);
// The frame takes the recorded screenshot's shape at once, then the loaded image's (they agree
// unless the report's record is off), so a landscape pair stacks before its pixels arrive. A
// screen with no recorded size keeps the last screen's shape until its own image loads. After
// decides, as it does for the recorded shape: Before's image counts only on a screen without one,
// so a pair whose shape changed does not take whichever side loaded last.
const [loadedAspect, setLoadedAspect] = useState<{ screenId: string; aspect: number }>();
const aspect = (loadedAspect?.screenId === options.screenId ? loadedAspect.aspect : undefined)
?? screenDiff?.screenshotAspect ?? loadedAspect?.aspect ?? DEFAULT_SCREENSHOT_RATIO;
const hasAfter = Boolean(screenDiff?.afterScreenshot);
const setAspect = useCallback((value: number, side: "before" | "after") => {
if (side === "before" && hasAfter) return;
setLoadedAspect({ screenId: options.screenId, aspect: value });
}, [options.screenId, hasAfter]);
// Each screen starts whole: no area selected, After showing, the facts closed.
useEffect(() => {
@@ -186,10 +199,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 +238,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 +252,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);
@@ -255,6 +268,7 @@ export function useCompareController(options: CompareControllerOptions) {
const shownOutlines = outlines && areas.length > 0;
const statusBarIgnored = (screenDiff?.visual?.ignoredStatusBarRegions ?? 0) > 0;
const homeIndicatorIgnored = (screenDiff?.visual?.ignoredHomeIndicatorRegions ?? 0) > 0;
const systemRegions = useMemo(() => ignoredSystemRegions(screenDiff?.visual), [screenDiff]);
const modeOptions = compareModeOptions();
// The switch shows the mode the reviewer chose, not the one-screenshot view a screen with nothing
// to compare falls back to. Such a screen turns the whole switch off, with nothing current, so
@@ -263,7 +277,7 @@ export function useCompareController(options: CompareControllerOptions) {
const modesDisabled = !comparable;
return {
screen, screenDiff, route, position, previous, next, comparable, areas, facts, split, layoutShift, measurable,
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, toggleOutlines,
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines,
activeArea, setActiveArea, stepArea, flipSide, flip, swipePosition, setSwipePosition,
aspect, setAspect, factsOpen, setFactsOpen,
};
@@ -318,7 +332,7 @@ export function CompareSection(props: CompareSectionProps) {
const compare = useCompareController(props);
const {
screen, screenDiff, route, areas, facts, mode, chooseMode, modeOptions, outlines, shownOutlines,
statusBarIgnored, homeIndicatorIgnored, toggleOutlines, activeArea, flipSide, flip, swipePosition, setSwipePosition, aspect,
statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines, activeArea, flipSide, flip, swipePosition, setSwipePosition, aspect,
setAspect, factsOpen, setFactsOpen,
} = compare;
const sectionRef = useRef<HTMLElement>(null);
@@ -336,8 +350,7 @@ export function CompareSection(props: CompareSectionProps) {
const overlay = shownOutlines ? (
<>
<ChangeOutlines changes={areas} activeIndex={activeArea} />
{statusBarIgnored ? <StatusBarBand /> : null}
{homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
<SystemRegionBands regions={systemRegions} />
</>
) : null;
@@ -390,8 +403,7 @@ export function CompareSection(props: CompareSectionProps) {
areas={areas}
activeArea={activeArea}
showOutlines={shownOutlines}
statusBarIgnored={statusBarIgnored}
homeIndicatorIgnored={homeIndicatorIgnored}
systemRegions={systemRegions}
overlay={overlay}
flipSide={flipSide}
onFlip={flip}
@@ -441,21 +453,25 @@ type StageProps = {
areas: VisualChange[];
activeArea: number | undefined;
showOutlines: boolean;
statusBarIgnored: boolean;
homeIndicatorIgnored: boolean;
systemRegions: readonly SystemRegion[];
overlay: ReactNode;
flipSide: "before" | "after";
onFlip: () => void;
swipePosition: number;
onSwipePosition: (position: number) => void;
aspect: number;
onAspect: (aspect: number) => void;
/** A screenshot of the stage loaded: its width over its height, and which side it shows. */
onAspect: (aspect: number, side: "before" | "after") => void;
};
export function CompareStage(props: StageProps) {
const { diff } = props;
const before = diff.beforeScreenshot;
const after = diff.afterScreenshot;
const [hoverIndex, setHoverIndex] = useState<number>();
// An outline taken out from under the pointer reports no leave, so another screen, mode or outline
// toggle drops the hover rather than lighting an area the pointer is not on.
useLayoutEffect(() => setHoverIndex(undefined), [props.areas, props.mode, props.showOutlines]);
if (!before && !after) {
const reason = diff.captureNotes?.after ?? diff.captureNotes?.before;
return (
@@ -474,11 +490,11 @@ export function CompareStage(props: StageProps) {
before={before}
after={after}
imageAspect={props.aspect}
onAspect={props.onAspect}
changes={props.areas}
activeIndex={props.activeArea}
showOutlines={props.showOutlines}
statusBarIgnored={props.statusBarIgnored}
homeIndicatorIgnored={props.homeIndicatorIgnored}
systemRegions={props.systemRegions}
position={props.swipePosition}
onPositionChange={props.onSwipePosition}
labels={props.swipeLabels !== "above"}
@@ -514,7 +530,7 @@ export function CompareStage(props: StageProps) {
<button type="button" className="compare-frame compare-flip-frame" data-side={showing}
aria-label={`Show ${showing === "after" ? "Before" : "After"}`} onClick={props.onFlip}>
<CompareImage src={showing === "after" ? after : before} alt={`${props.title}, ${showing}`}
placeholder="No screenshot" onAspect={props.onAspect} />
placeholder="No screenshot" side={showing} onAspect={props.onAspect} />
{props.overlay}
</button>
</div>
@@ -535,7 +551,7 @@ export function CompareStage(props: StageProps) {
<div className="compare-frame-wrap">
<div className="compare-frame">
<CompareImage src={src} alt={`${props.title}, ${showing}`}
placeholder={placeholderFor(showing, diff.status, diff.captureNotes)} onAspect={props.onAspect} />
placeholder={placeholderFor(showing, diff.status, diff.captureNotes)} side={showing} onAspect={props.onAspect} />
</div>
</div>
</figure>
@@ -544,6 +560,21 @@ export function CompareStage(props: StageProps) {
const sides = (["before", "after"] as const).filter((side) => (
side === "before" ? diff.status !== "added" : diff.status !== "removed"
));
// Split outlines the changed areas on After, where the eye lands; Before keeps the same outlines
// unseen, and shows one while its twin on After is hovered or the area is selected (J, K). A moved area keeps
// its outline on Before, where its content was.
// One frame, or no outlines, takes the caller's overlay as the other modes do.
const paired = Boolean(before && after) && props.showOutlines && props.areas.length > 0;
const sideOverlay = (side: "before" | "after"): ReactNode => {
if (!paired) return props.overlay;
return (
<>
<ChangeOutlines changes={props.areas} activeIndex={props.activeArea} hoverIndex={hoverIndex}
reveal={side === "after" ? "linked" : "ghost"} onHover={side === "after" ? setHoverIndex : undefined} />
<SystemRegionBands regions={props.systemRegions} />
</>
);
};
return (
<>
{sides.map((side) => {
@@ -558,11 +589,11 @@ export function CompareStage(props: StageProps) {
<div className="compare-frame">
{src ? (
<CompareImage src={src} alt={`${props.title}, ${side}`}
placeholder={placeholderFor(side, diff.status, diff.captureNotes)} onAspect={props.onAspect} />
placeholder={placeholderFor(side, diff.status, diff.captureNotes)} side={side} onAspect={props.onAspect} />
) : (
<ScreenshotPlaceholder label={placeholderFor(side, diff.status, diff.captureNotes)} />
)}
{src ? props.overlay : null}
{src ? sideOverlay(side) : null}
</div>
{props.labels === "inside" ? (
<span className={`compare-side-label compare-side-tag ${side}`}>{label}{note}</span>
@@ -575,7 +606,10 @@ export function CompareStage(props: StageProps) {
);
}
function CompareImage(props: { src: string; alt: string; placeholder: string; onAspect: (aspect: number) => void }) {
function CompareImage(props: {
src: string; alt: string; placeholder: string; side: "before" | "after";
onAspect: (aspect: number, side: "before" | "after") => void;
}) {
return (
<ScreenshotImage
src={props.src}
@@ -586,7 +620,7 @@ function CompareImage(props: { src: string; alt: string; placeholder: string; on
fallback={<ScreenshotPlaceholder label={props.placeholder} />}
onLoad={(event) => {
const { naturalWidth, naturalHeight } = event.currentTarget;
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect(naturalWidth / naturalHeight);
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect(naturalWidth / naturalHeight, props.side);
}}
/>
);
@@ -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) : []),
@@ -1,7 +1,7 @@
import { type CSSProperties, type ReactNode } from "react";
import { ChevronDown } from "lucide-react";
import { ToggleGroup } from "../shared/toggle-group";
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand } from "../panels/visual-diff";
import { ChangeOutlines, SystemRegionBands } from "../panels/visual-diff";
import { WhatChangedContent, type LayoutShift } from "./compare-header";
import {
CompareStage,
@@ -110,8 +110,7 @@ export function SidebarReview(props: CompareControllerOptions) {
? (
<>
<ChangeOutlines changes={areas} activeIndex={activeArea} />
{compare.statusBarIgnored ? <StatusBarBand /> : null}
{compare.homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
<SystemRegionBands regions={compare.systemRegions} />
</>
)
: null;
@@ -123,7 +122,7 @@ export function SidebarReview(props: CompareControllerOptions) {
<section className="sidebar-review" aria-label={`Changes in ${route}`}>
<ReviewModes value={compare.chosenMode} disabled={compare.modesDisabled} onChange={compare.chooseMode} />
<div className={`compare-stage sidebar-review-stage mode-${mode}`}
<div className={`compare-stage sidebar-review-stage mode-${mode}${compare.aspect > 1 ? " landscape" : ""}`}
style={{ "--compare-aspect": compare.aspect } as CSSProperties}>
{/* Before and After are named above the frames in every mode, as in Compare. */}
<CompareStage
@@ -135,8 +134,7 @@ export function SidebarReview(props: CompareControllerOptions) {
areas={areas}
activeArea={activeArea}
showOutlines={compare.shownOutlines}
statusBarIgnored={compare.statusBarIgnored}
homeIndicatorIgnored={compare.homeIndicatorIgnored}
systemRegions={compare.systemRegions}
overlay={overlay}
flipSide={compare.flipSide}
onFlip={compare.flip}
+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)} />
Loaded 100 of 122 files, more files were not shown because too many files have changed in this diff. Show more