Compare commits

..
Author SHA1 Message Date
Brent Vatne 1c54139eb3 Release 0.20.2 2026-10-19 19:47:18 -07:00
Brent Vatne b1edd7ea81 Reviews survive one target's flaky session: resend a tool whose service didn't start, and report the targets that captured (#48) 2026-10-19 19:47:06 -07:00
Brent Vatne 50230b7f93 Viewer previews: wait 20 s for the alias, then link it with a going-live note (#46) 2026-10-19 19:18:48 -07:00
Brent Vatne 33f31da08e CI: retry a failed simulator:control action and a GitHub lookup the Actions API hasn't caught up on (#47) 2026-10-19 19:18:43 -07:00
Brent Vatne 7fc0f34c9b Release 0.20.1 (#45) 2026-10-19 17:23:51 -07:00
devin-ai-integration[bot]andbrent 6daf0a4391 Phone header: the pill leaves out the app's name, then the PR link, before anything overlaps (#43)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-19 17:20:22 -07:00
Brent Vatne 1796a9b810 Viewer: screenshots fade in, go blank on a target switch, and Compare reads the next screen ahead (#44) 2026-10-19 16:17:56 -07:00
Brent Vatne 87aec5b820 Screens, search and the counts leave out routes a public report never captured, as the Map does (#42) 2026-10-19 12:51:11 -07:00
Brent Vatne 89f18cad05 README: Screens and the PR comment open full size when clicked (#41) 2026-10-19 10:38:10 -07:00
Brent Vatne bb8b73e16e README: refresh for 0.20.0 (#40) 2026-10-19 10:25:49 -07:00
Brent Vatne 7360502e86 Release 0.20.0 (#39) 2026-10-19 09:41:41 -07:00
Brent Vatne 6539b5c002 Source planning: follow every single-directory tsconfig paths alias (#38) 2026-10-19 09:28:17 -07:00
Brent Vatne 422cf8caf4 Viewer: theme, full screen and shortcuts in a "…" menu; the top right keeps only the Map's camera (#37) 2026-10-19 09:24:13 -07:00
devin-ai-integration[bot]andbrent b281c734f4 Viewer: make the Inspector resizable from its left edge (#34)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 22:39:36 -07:00
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
168 changed files with 10608 additions and 1965 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:
+6 -1
View File
@@ -67,9 +67,12 @@ jobs:
shell: bash
env:
COMMENT_ID: ${{ steps.comment.outputs.id }}
# How long an alias can keep serving the previous push: an EAS Hosting edge that served it keeps it for about
# five minutes (FIXTURE_ALIAS_WAIT_MS in src/report/preview-deploy.ts).
ALIAS_CATCH_UP: 5 minutes
run: |
set -euo pipefail
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" '
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" --arg catchup "$ALIAS_CATCH_UP" '
.previewUrl as $url
| ([.reports[] | select(.platform == "android")] + [.reports[] | select(.platform != "android")]) as $reports
| ($reports[0].source // "") as $source
@@ -85,6 +88,8 @@ jobs:
| ((.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 alias still served the previous push when the deploy stopped waiting for it: say so, and link the new deployment.
(if .aliasBehind then "> **Going live:** this link can take up to \($catchup) to show \($sha); until then it shows the previous push, or nothing on a new pull request. [This push'"'"'s deployment](\(.deploymentUrl)/p/\($url | split("/p/")[1])) is live now.\n" else empty end),
"The link stays the same on every push. [Deploy run](\($run))"]
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
if [[ -n "$COMMENT_ID" ]]; then
+4 -4
View File
@@ -49,16 +49,16 @@ Each workflow starts with a `targets` job: it installs the pinned CLI and runs `
| | checkout `app-base`, `app-head` | Checks out the exact base and head SHAs with full history and without persisted credentials. |
| | Verify deterministic source planning | `source:verify` builds the capture plan from source alone in two fresh processes and compares the bytes. Runs before any build or simulator work and needs no credentials. |
| | Install app dependencies | `npm ci --ignore-scripts` in both checkouts (`APP_INSTALL_DIR` for monorepos). |
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<target>` artifact (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a finished run's `explore-baseline-<base sha>-<target>` artifact (a run another target's baseline failed in counts: a baseline job uploads its artifact only after its own steps passed) (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
| | Capture review | `capture:review` (§3). `EXPO_TOKEN`, the provider key and the app's `{{secret:NAME}}` values reach only this step. The sticky PR comment is updated while it runs. It writes `preview=<hosting>` to the step outputs, which decides whether the deploy job runs. |
| | Stop capture sessions and check the checkouts | `ci:after-capture`, whenever the PR was resolved, success or not: stops the EAS Simulator sessions named in `head-session` / `base-session`, nothing else, then fails with `CHECKOUT_MODIFIED` if capture modified an app checkout. |
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<target>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<target>` keeps plans, exports and agent diagnostics for 7 days. |
| report (matrix: target) | Install Explore, download the capture | Runs without Expo or model credentials. |
| report (matrix: target) | Download the capture, install Explore | Runs without Expo or model credentials, after every capture job, whether or not each succeeded (`!cancelled()`). Each leg downloads its own target's capture by an exact-name pattern: a target whose capture failed uploaded none, so its leg packages and publishes nothing, and the other targets' reports still reach the comment. |
| | Package hosted review bundle | `ci:report` writes the report directory. |
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
| `deploy` (only when `report.preview` is set; after every report job, once any of them published) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every capture and report artifact the run has (a target whose capture or report job failed has none and is left out), writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only each failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with (or, when download-artifact extracted a lone artifact without its directory, the `target` its `error.json` records), and its label comes from the record the capture job already posted. Once the other targets published, the comment shows their reports and this failure, with no new-run line. |
A reviewer downloads the report ZIP and drops it on the hosted Viewer; downloading needs read access to the repository.
+17 -10
View File
@@ -4,32 +4,36 @@ Explore maps your app: a screenshot of every screen, connected by the taps betwe
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-hero-dark.svg">
<img alt="Explore's Map of a euxy pull request, animated: the screen cards appear row by row, the new About screen marked Added among the modified Patterns screens, the transitions between them wipe in, then a click selects About, its transitions light up and the Inspector slides in on it, shown as a window on a soft stage" src="docs/screenshots/readme-hero-light.svg">
<img alt="Explore's Map of a euxy pull request, animated: the screen cards appear row by row, the new /lane-editor/0 marked Added beside the removed /lane-editor and the modified /new-pattern, the transitions between them wipe in, then a click selects /lane-editor/0: a blue ring circles it, its transitions turn blue while the rest fade to hairlines, and the Inspector slides in on it, shown as a window on a soft stage" src="docs/screenshots/readme-hero-light.svg">
</picture>
**See a real report:** [euxy](https://explore-example--euxy.expo.app/p/rfcoic27ccgnrmzgijubxkmuzmptcrva?platform=ios), a MIDI sequencer, reviewed by Explore. It is redeployed with the current Viewer on every merge to main.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-compare-dark.svg">
<img alt="The euxy Patterns screen wiping from its capture before the pull request to its capture after it: each pattern row's tempo moves out of the subtitle into its own column on the right, then the changed subtitles are outlined" src="docs/screenshots/readme-compare-light.svg">
<img alt="The euxy New Pattern sheet wiping from its capture before the pull request to its capture after it: the suggested pattern name and the row of pattern icons differ, and those regions are outlined on the after capture" src="docs/screenshots/readme-compare-light.svg">
</picture>
**Compare**: each changed screen before and after, with the changed regions outlined.
**Compare**: each changed screen before and after, with the changed regions outlined on the after.
<table>
<tr>
<td width="50%" valign="top">
<a href="docs/screenshots/readme-screens-light.png">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-screens-dark.png">
<img width="100%" alt="The Screens view of a euxy review: the app/ route tree on the left under Changed 9 and All 19, and a grid of screen cards beside it in the same order, each with its route below the screenshot and a dot before it: green for the new /about, orange for modified screens such as /activity-log, /settings and /patterns, red for the removed /channel-surf" src="docs/screenshots/readme-screens-light.png">
<img width="100%" alt="The Screens view of a euxy review showing Changed 7 of All 19: the app/ route tree on the left, and beside it a grid of the changed screens in the same order, each with its route below the screenshot: a red dot for the removed /lane-editor, orange for the modified /new-pattern and /channel-surf, green for the new /lane-editor/0, and Changed in dark under /p and /patterns" src="docs/screenshots/readme-screens-light.png">
</picture>
<strong>Screens</strong>: every capture in one grid, beside the route tree, with a dot for what changed.
</a>
<strong>Screens</strong>: every capture in one grid, or only the changed ones, beside the route tree, with a dot for what changed.
</td>
<td width="50%" valign="top">
<a href="docs/screenshots/readme-pr-comment-light.png">
<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: the heading 2 screens changed with a Review in Explore link; a line of links to each device's report (iPhone 17, three iPhone Duo poses and Android) and to the two commits compared; then the changed screens as a list, /tempo with the text it added and the devices it is on, fading out below" src="docs/screenshots/readme-pr-comment-light.png">
</picture>
</a>
<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>
</tr>
@@ -41,7 +45,9 @@ Explore maps your app: a screenshot of every screen, connected by the taps betwe
Paste this into Claude Code, Codex, Cursor, or any tool that can fetch a URL. In the Viewer, **Hand off to AI** fills it in for you:
```text
Review the visual changes in this PR. Expo Explore report: <report link>
Review the visual changes in PR #<number> of <owner>/<repo>.
Expo Explore report:
<report link>
Fetch the link first. It explains the report's JSON API. Go through the changed screens,
compare the before and after screenshots, and tell me which changes look intended and
@@ -298,7 +304,7 @@ platforms:
easProfile: explore-android # android.buildType: apk in eas.json
```
- The workflows run one capture job per platform, and the PR gets one comment with a section per platform.
- The workflows run one capture job per platform, and the PR gets one comment that links each platform's report and lists the changed screens of both.
- A failed platform fails the check; the other platform's report still publishes.
- An Android-only app sets `app.platform: android` with no `platforms` map.
@@ -319,7 +325,8 @@ targets:
- A target takes the `app` fields it does not set, and `device.name` when it is of `app.platform`; a target of another platform sets its own `bundleId` and `easProfile` (an Android one's device defaults to `pixel_7`). `pose` is `closed`, `half-open` or `open`. `label` names it in reports (by default its device and pose).
- Ids are up to 32 lowercase letters, digits and dashes, start with a letter, and are not `base`, `head` or `report`. A config names at most 8 targets. A config with `platforms` has one target per platform, named `ios` and `android`.
- The workflows run one capture job per target, the PR comment has a section per target, and each report links its sibling targets' reports.
- The workflows run one capture job per target. The PR comment links each target's report and says which targets a change is on, and each report links its sibling targets' reports.
- A review runs at most `capture.maxSessions` EAS Simulator sessions at once across its targets (default 5, a typical plan's limit); see the [config reference](docs/quickstart-ci.md#config-reference).
- A target can also set its own `controller` and `simulator` over `capture`'s, such as Android on agent-device beside iOS targets on Argent. `--controller` and `--simulator` override every target's for one run.
- `capture --target duo-open` reviews one target on this machine; `--platform ios` the iOS ones. On your machine a review's targets run at once (at most `--parallel N`), and targets of one platform and EAS profile share each commit's build; in CI each target is its own job. A target that fails outright costs only its own report.
- A device controller that stops answering on one screen costs that route, up to three times per capture: Explore restarts the app, goes on with the next route, and records what happened in `capture-diagnostics/controller-recoveries.jsonl`.
@@ -580,7 +587,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
+6 -4
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
@@ -130,7 +132,7 @@ platforms:
easProfile: explore-android
```
Commands that capture or publish (`source:verify`, `capture:review`, `capture:baseline`, `ci:report`, `ci:publish`) take `--platform ios|android`; with one configured platform it is optional, with two it is required (`PLATFORM_REQUIRED`). `expo-explore config:platforms` prints the configured list as JSON, which the workflows use as their matrix. Artifacts carry the platform (`explore-capture-<run>-<attempt>-android`, `explore-baseline-<sha>-ios`); an iOS job still reuses an older unsuffixed baseline. The PR comment has one section per platform, and a hosted preview serves both reports from one link.
Commands that capture or publish (`source:verify`, `capture:review`, `capture:baseline`, `ci:report`, `ci:publish`) take `--platform ios|android`; with one configured platform it is optional, with two it is required (`PLATFORM_REQUIRED`). `expo-explore config:platforms` prints the configured list as JSON, which the workflows use as their matrix. Artifacts carry the platform (`explore-capture-<run>-<attempt>-android`, `explore-baseline-<sha>-ios`); an iOS job still reuses an older unsuffixed baseline. The PR comment is one list of changed screens that says which platforms each is on, and a hosted preview serves both reports from one link.
### Several devices (targets)
@@ -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 report (the Map, Screens, search 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:
+1 -1
View File
@@ -1 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /patterns screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(1,4,9,0.6)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#151B23"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#151B23" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCANqAZIDASIAAhEBAxEB/8QAHAABAAICAwEAAAAAAAAAAAAAAAMFBAYBAgcI/8QAWBAAAQMDAQQECwQHBAUKBQQDAQACAwQFERIGEyExFEFR0QcVIjJSU2GBkZKTNFRxsQgjM2OhouEWQmLBJHJ1gtIYNkNVVrKz1OLwFzdzlJUmNThEg8Px/8QAGAEBAQEBAQAAAAAAAAAAAAAAAAEDAgT/xAAdEQEBAAMBAAMBAAAAAAAAAAAAEQECAwQSMUFR/9oADAMBAAIRAxEAPwD5UREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBFs2wdn2aut0kftXeZrbbaZgkdHTRa6ircXACKIHgHHOdTuAAXptz8CuzVB4X9sLRPUXCHZPZS3suVSWva6olbuI37priManOecHHIY9qDwxF6dtdsfspd/B5Dt9sZT19sp4Lj4suNurZxPuXFupkrHhoJaRwII5nhy449DsjsFs/tZc6faXa2K8Wm3UQqIDZ8g3KcgEQNeQQzBJy49nUeQecovVdtdiNjpdktlNsrGa/Z2gvVdJQ1NLXvNTuGscA6eNzWhz2AZyMZzwCu6fYTwZbVWvaaLZ2j2lo4rHbpa2n2jrZR0atdHgBroyxujWT5IB1ezIwg8PREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEReh+C3YDZbaenr7xthtdDZLXb3sjdSwDXW1TneaImYPPB4gO4jl1oPPEX0xUeDTwVMt5kqvB34VrbQacm7vpc7tvrHMy4hvXnR7l414T9iLNsXdaQbP7U0O0druEHSaeaA4ljZnGmVv913A+3gcgckGmIvQPA/4M5PCZtDFao5IY3SF+XzaiyJjG5c4hpBceLQACOJ4ngve/wDkWUn/AGlt3/4qf/ziD5ERfXf/ACLKT/tJbv8A8VP/AOcXgHhU8GtT4P8AaOstGGSvpHfrHQajG5hYx7ZAHZLQQ8Agk4IPEhBoaIiAiIgIiICIiAiIgIiIJaRwZVQucQAHtJJ6uK+jL54QNlLp4afCLQTXyljsW1tqit8F2YdcMM7aeIMc4j+4HBwJ6j2DJXzciD17aipsuwXgiOwlNtBar/d7rdm3GsltMxmp6eBjNLGCTABeSM+zjnqzjbJbPeC7a3wkSOddp9ntkKWGObc3ioa2eqeAAYg9uQ0F2SSMkDlgnh5UiD2HwsNprxe7Vc7xtlsxWWKKojoIbTs1O6R1so+JJjY6NoOA3ieZcR1YxttnqLBsfZ7xS3vwmWLarYQ0M8dssYeZqt0jsmI7osG4e0k+UCME9XV84ogIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgszQ2/pMEfTsxvYS93onsURpaPo1TJ0r9ZHIWxtx57e1YKIMuvp6aDddGqN9qbl3+ErI2a2iuGyV+ob7aZWRV1DKJYXPYHgEdoPAjGQqxEH0HV+HF9u2Lt+1Nr8I21VXttUTaaq01W7dQMx553OjS1mCNJack9mDjwKsq5q+rnq6l+ueeR0sjsAanOOScDgOJ6lCiD1DwD+Eel8HG1ENzqoRPGzeMki3jY3Pje0AlrnEN1AtacOIBGeIX0t/yuNiP+rLz9eg/80vhlEH3N/wArjYj/AKsvP16D/wA0vmbwzeEwbb7WXC7UDRTMrf1Zia9shZCGRsDXOHAuOgk6SQMgZPFeZIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIilhpZ6jO6ie/HMgcB+JQRIsw2qrAzu2fUb3rHlp5YDiSNzOzI5oI0REBERARSw0s9RndRPfjmQOA/Eqc2qLine truncated
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /new-pattern screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(1,4,9,0.6)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#151B23"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#151B23" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCAQ4AfEDASIAAhEBAxEB/8QAHAABAAIDAQEBAAAAAAAAAAAAAAQFAgMGBwEI/8QAXxAAAQMDAQQFBggJCAYHBwMFAQACAwQFEQYSEyExFEFRUpEHImFxgbEVMjM0U2JykhYjQlRVc6HR0gg2dJOUssHhFxg1ZcLwJDdDRIKVsyUmVld1otOD4vEnRWOjw//EABYBAQEBAAAAAAAAAAAAAAAAAAABAv/EABgRAQEBAQEAAAAAAAAAAAAAAAABEUEh/9oADAMBAAIRAxEAPwD8qIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiD1PyJz6Bo7rQHUdokv16rrnDRUtDMB0SGN7mtM0gIw8+ccN4jhx7Vca9o/J/pfy36r/CC0vNqt4Y+is9uYII6iXYjwwloAYzi4kj9vJeceTUhvlF0sSQALvSZJ/XNXTfyj3Nf5adTOa4OBmjwQcj5JiDpf5Q9o0zTaz0Y+mtdFp613KzUlVVst1M1gjD5H7btloG04N6zxOAouiPJporWHlxZYbBc6q66SpYjWzTytLHysYwFzOIacF5Dc4HAn1qb/KIdb5dR+TwXCSXoP4N0AqXU+DI2PbftbOeG1jOMrX5NNW6E0F5d2zWCtrPwTrYHUBqq4YfHvGDLjwHmiQDiRwHqQdNozUmlfLTqq6eT6u0XYLTQTQzi0VdvpGx1FK6Pi0lw+NkDJ6jjHWuA015SH2FtLpJvk00VerhBMaMTVdrZLUVEm2RhzjzOeC9I8nvkvqPIrra66/1XXUEOn7ZDO6gniqWPdXueCGBjQc5LSeB6z2cVx/kRpqWjrNS+WDUEUbqOx7yWlhcfnFdJktaPs7Q9Rc0oMP5TrrBbr9ZtO2ux2O2XO3UYfdX2mlZBE+okDTsYaASGgZGe8vFVNvV4rdQ3etu9xmM9ZWzPnmkP5T3HJ9XPkoSAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICKdabcy5SvjdMItlu1yzlbKW0sqKWpnNS1phJAGPjYQVqKxfa2MtTK7pALnHGxj04Xy52tlBDBI2cS70ZxjkgsNBWex37V1ttuo7v8D2qeTZnrNnOwMEgdgycDaPAZyeS/TemZ9OQ7dF5IvI3HqmnpiY3326buOOZw5lkk3Fw9Rb6l+RF7T5JPKRd9RTWbye3/AF3cNNafi2mU9RQ4ile8nzInzc2tznBORxAPDGA9S1LLpmpcyh8rnkdj0lDUkRx322bt8cTzy25IR5vtLvSF+Y9eWey2DVtytunrv8MWynlLIawNxtjrHYcHhtDgcZC9G8rXlJvFjlvPk8smuK/UunXuY2Worw2SZr2k7cbZebmZAyeXDA4Zz40g9D8jGjWa01VbrSJWwS11XuN+WB5hjbE+V7mg8NotjwCeWV+tmfyZ9ItaA67alJHM9OAz7Nhfk3yJavj0bqy3XYwGpfQVZndTscA+WJ8MkT9jPAuAkyB14X67Z/KR0I5gc431hIyWm0zkjwaQgj/6tGkP0rqb+3j+BV2of5M2njZqw2283yOrbE50Rqp2zxFwGQHMLeIKu/8AWP0F373/AOU1H8CrtQfyk9JMs9WLXS3qtrXxObDE6gkhYXEYBc94Aa3tKD8T6hs76aZ9ZBAGUrmxOds/FjfIza2R6ODsKkV7qO8STzPoYZ2vpmtha/Y4te+NmzkHsyXYVEgIiICIiAiIgIiICIiAiIgIiLine truncated

Before

Width:  |  Height:  |  Size: 107 KiB

After

Width:  |  Height:  |  Size: 103 KiB

+1 -1
View File
@@ -1 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /patterns screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(17,17,17,0.14)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#F6F8FA"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#F6F8FA" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCANqAZIDASIAAhEBAxEB/8QAHQABAAEFAQEBAAAAAAAAAAAAAAECAwQFBgcICf/EAFkQAAEDAwICBwQHBAYFCgQDCQEAAgMEBREGEiExBxMUQVFSkSIyYaEVM1NxgZLhCCNisRgkNELR0xZWlJXBJTdDcnN1gqKz8Bdjk9QmNTY4RlV0g4Sy0vH/xAAYAQEBAQEBAAAAAAAAAAAAAAAAAQIDBP/EABoRAQEBAQEBAQAAAAAAAAAAAAARAQIDIQT/2gAMAwEAAhEDEQA/APpxERFEREBERAREQEREBERAREQEREBERARYl0u9uslI6sulfSUFMz3pqmVsbB+LiAuCuH7RnRXbZDHNq6mkcOH9XgmmHqxhHzQekIvKv6UPRP8A6zSf7vqf8tP6UPRP/rNJ/u+p/wAtB6qi8q/pQ9E/+s0n+76n/LT+lD0T/wCs0n+76n/LQeqovKv6UPRP/rNJ/u+p/wAtP6UPRP8A6zSf7vqf8tB6qi8q/pQ9E/8ArNJ/u+p/y0/pQ9E/+s0n+76n/LQeqovKv6UPRP8A6zSf7vqf8tP6UPRP/rNJ/u+p/wAtB6qi8vpv2mOiipeGN1W1hP2lFUMHqY8Lt9O6z03q2IyWG+W65hoy4U07XuZ/1mg5H4hBuUREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBFq9TXK4Wix1NZabTJeK9m1sFFHIIzK9zg0ZceDWjOSe4Aryaz9NOobTofXl91ZTW2W4aauLqCKChDmxPkO1rW5JJI3uHHngIPbUXkdFq/X+jdTaYpNcVFor6DUzzTf1KndC+3VRbubHkuO9p93J48M93HprprLVD7Vqf6F0ZXPudrnbTW9lW5rIrhuIHWtOR7DcknjxAxnOQA7ZF5PZ9Va6030lWLSOqrjZ73HfaSeoD6GmMD6F0TdxyMndGfdBOCT4YwadM9I2trl0s02nb9Z6KzWyutUlxpqPcZKpjWybGmVwO0OOCdoHAEDOcoPWkREBERAXE9LvSdQ9FWkZbzUMbUVkrupoqUnHXSkZ4+DQOJP4cyF2y+MP2wtRT3LpIpbNvPZrVRM2s7usk9pzvxb1Y/BB5NrLXWodfXZ901DcpqyZxOxhOI4R5WN5NH3fjkrQIiIIiICIiAiIgIiICIiAsm3XKttFbFXW+rno6qF26OaCQsew+II4hYyIPtX9nDp2m6RaaTTuopGfT9HH1kc4AaK2IcCcDgHt4ZxzBz3Fe5L83ujTUU+k9f2C8wPLDTVsW/H96Nztr2/i0uH4r9IUUREQEREBEXn/AEn681RpmooLRpHSc15udwY97aqc7KKla3mZH5HLI4Et4Hn3IPQEXzbT9JHSk+vEdL0g9Flyrt3C0sqcb3fZtfhoLu7G/wDFew9GetbxrK11Zv8Apiu09c6Cfs1RDOMxSOxndE7+83iPhxGCeaDsUXBdLnSTH0bWCW6SRyyNjDcMh2h8r3uw1oLgQ0cHEkg8BwHFeEf0y6r/AFcuH+9IP/tEH1oi+TP6ZdV/q5cP96Qf/aL3rou6R6bXunaS7ZfEyrb+7bPtEjXhz2ujJbgOILCQQBkEcAUHcoiICIiAiIgIiICIiAiIgLwGp6ML/qTSPSxZ+xS0lVdL/JXW0zjY2oDHMe0tJ4YdtLc8uK9+RB4pPUak6WdV6LbU6RvNgpNP1QudznuUIiY6oY3DI4eJ6wF2fa8F2t0uut9MWrVF1qKCl1AWTA2S321jhMYzhoEue8E5OM8A74AdsiDxHogq7jBqB9x1Lo3V79U3r2a281tGxlLSsALhDH7ZLIhgAcMuOCe7HS3CxXOT9oK13xlDO62Radlpn1Yb+7bKZiQwnxxxwvSUQEREBERAXxV+19Yprd0ox3NzD1FzoYnsf3FzMsc37wA0/wDiC+1VLine truncated
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /new-pattern screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(17,17,17,0.14)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#F6F8FA"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#F6F8FA" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCAQ4AfEDASIAAhEBAxEB/8QAHQABAAEFAQEBAAAAAAAAAAAAAAUCAwQGBwEICf/EAGMQAAEDAwEEBAcHDgoGBwcFAQEAAgMEBREGEiExkQcTQVEUFSJSU2FxFjI1c4GxsggXMzRCcoKSk5ShwdHSGCM2VFVWYnSk4jdDdaKzwiQlRVeV4eMmRmaD0/DxJ0RjZKNl/8QAFgEBAQEAAAAAAAAAAAAAAAAAAAEC/8QAGhEBAQEBAQEBAAAAAAAAAAAAABEBIUECMf/aAAwDAQACEQMRAD8A62iIiiIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIi0npd163QGkJq2Eg3CpPg9I0+eRvcfU0ZPtwO1BhdI/TVYuj97qHBuN1xnwWJwAjzw23fc+ziuF336orXV2ld4JV01qhPCOlhaTj1ufk59mFzWqqp66plqqmV808zy+SR5y5zickkq0iNom6UdbzvLn6qu+T5tS5o5Aqj65etP61Xn87f+1a0iDZfrl60/rVefzt/7U+uXrT+tV5/O3/tWtIg2X65etP61Xn87f8AtT65etP61Xn87f8AtWtIg2X65etP61Xn87f+1Prl60/rVefzt/7VrSINl+uXrT+tV5/O3/tT65etP61Xn87f+1a0iDZfrl60/rVefzt/7U+uXrT+tV5/O3/tWtIg2X65etP61Xn87f8AtVTOk7W0bg5uqrzkd9U8/rWsIg6PZvqgdfWmVpkukdxiHGKrha4H8JuHfpXaejrp/susqmK2XOEWm5ykNjDn5imd3NceBPYD7MlfJ69BLSCCQRvBCD9BUXLegPpFk1ppyS3XGUyXS2bLHvccmaI+9f7dxB9gPaupIoiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiDk/TU/Wsdoutwt92Nms1thjkY6leW1FXIXNBG0DljRn5VIzs1hfdE6dhs10FDHU28S3C5yEvqG4Y3AZk52nZd5XZjOcrP6bWl3Rbfw0Ekws3D4xik9Hgjo8tIIIPiyPd/8sINO6KL5qSv6HXXKmfLeb2Hz9QK2cuMjg7cC5x/WrnSLrDU9p0TYqQRx23Ul9nio5OqdtCmLvflp37+A4nGTg7srD6F/HEHQrmyQwuugkqDTsqNzC/b3ZVzpSsupbjozTt+qKKKe92OpiraumpcuBH3ewN5OCGn2ZQYN+oLp0O3SwXan1Hd7nbq2rZR3KCvnMrXbX+sbngRvPyBbb0nakr4GUOldPzFl+vb+rjkYcGlhHv5iRvGBw9eccFpOrNU0XTPcdOae03DVzQx1jK24zSQuY2mjbxaSRx3n1Zwp2p0b0gUWvLvqe01GnZ3VjWwQG4CVzoIW8GNDcAZO88eHtQX+gysuVRbtQU1yutdc3UV2lpo5qyZ0r9huAN7icd66auM9ALNRiu1G6sNvFvNxqDOGNeJDU7QyW53dXjPHfwXZkBERAREQF80fVTXOSbUtptu1/FU9KZcf2nuwTyaF9Lr5o+qmtckOpLTctn+KqKUw5/tMdnHJwQcQRERBERAREQEREBERAREQEREBERAREQdO+p1uclB0l0sDXYZWQSwvHeNnaH6WhfXC+R/qdbXJcOkulna3LKOCWd57t2yP0uC+uEXBERARYlxrXUMbHti6zaOOPBUT3F8NRBEICRKASc8MoM5FhNr3OuDqTqTgD3+fUlBXurJJWOhMfVnjnigw9X3K62jTldXWS2+M7hCzMVNnG2c7z68DJwN5xhcIvsV7k2arpI6TX6fmnG2200G298TTw2mRbh8ufavpBcu6Line truncated

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 113 KiB

+1 -1
View File
@@ -1 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /about and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.33%{opacity:0;transform:scale(.92)}8.08%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}4.00%{opacity:0;transform:scale(.92)}7.75%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}4.67%{opacity:0;transform:scale(.92)}8.42%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}6.08%{opacity:0;transform:scale(.92)}9.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}6.41%{opacity:0;transform:scale(.92)}10.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}6.75%{opacity:0;transform:scale(.92)}10.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}7.08%{opacity:0;transform:scale(.92)}10.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}3.66%{opacity:0;transform:scale(.92)}7.41%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}7.41%{opacity:0;transform:scale(.92)}11.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}7.75%{opacity:0;transform:scale(.92)}11.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}8.08%{opacity:0;transform:scale(.92)}11.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}8.42%{opacity:0;transform:scale(.92)}12.17%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}10.83%{clip-path:inset(0 0 100% 0)}21.67%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(978.5px,714.0px)}25.83%{opacity:0;transform:translate(978.5px,714.0px)}27.50%{opacity:1;transform:translate(978.5px,714.0px)}35.83%{opacity:1;transform:translate(718.5px,505.2px)}36.67%{opacity:1;transform:translate(718.5px,505.2px) scale(.82)}37.92%{opacity:1;transform:translate(718.5px,505.2px)}45.83%{opacity:0;transform:translate(718.5px,505.2px)}100.00%{opacity:0;transform:translate(718.5px,505.2px)}}.sel{animation:sel 12s ease-out infinite}@keyframes sel{0.00%{opacity:0}36.67%{opacity:0}39.17%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}37.08%{opacity:0;transform:translateX(48px)}42.08%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{opacity:0;animation:cover 12s linear infinite}@keyframes cover{0.00%{opacity:1}1.67%{opacity:0}94.17%{opacity:0}100.00%{opacity:1}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><image id="empty" width="1376" height="774" href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAALine truncated
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /lane-editor/0 and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.44%{opacity:0;transform:scale(.92)}8.19%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}7.86%{opacity:0;transform:scale(.92)}11.61%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}7.19%{opacity:0;transform:scale(.92)}10.94%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}9.27%{opacity:0;transform:scale(.92)}13.02%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}4.77%{opacity:0;transform:scale(.92)}8.52%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}8.19%{opacity:0;transform:scale(.92)}11.94%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}9.60%{opacity:0;transform:scale(.92)}13.35%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}9.94%{opacity:0;transform:scale(.92)}13.69%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}10.27%{opacity:0;transform:scale(.92)}14.02%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}10.61%{opacity:0;transform:scale(.92)}14.36%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}6.85%{opacity:0;transform:scale(.92)}10.60%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}10.94%{opacity:0;transform:scale(.92)}14.69%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c12{transform-origin:0 0;animation:c12 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c12{0.00%{opacity:0;transform:scale(.92)}11.27%{opacity:0;transform:scale(.92)}15.02%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c13{transform-origin:0 0;animation:c13 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c13{0.00%{opacity:0;transform:scale(.92)}11.61%{opacity:0;transform:scale(.92)}15.36%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c14{transform-origin:0 0;animation:c14 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c14{0.00%{opacity:0;transform:scale(.92)}7.52%{opacity:0;transform:scale(.92)}11.27%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}13.75%{clip-path:inset(0 0 100% 0)}24.58%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(853.5px,575.2px)}28.75%{opacity:0;transform:translate(853.5px,575.2px)}30.42%{opacity:1;transform:translate(853.5px,575.2px)}38.75%{opacity:1;transform:translate(593.5px,355.2px)}39.58%{opacity:1;transform:translate(593.5px,355.2px) scale(.82)}40.83%{opacity:1;transform:translate(593.5px,355.2px)}48.75%{opacity:0;transform:translate(593.5px,355.2px)}100.00%{opacity:0;transform:translate(593.5px,355.2px)}}.sel{animation:sel 12s linear infinite}@keyframes sel{0.00%{opacity:0}39.58%{opacity:0}40.42%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}40.00%{opacity:0;transform:translateX(48px)}45.00%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{oLine truncated

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

+1 -1
View File
@@ -1 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /about and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.33%{opacity:0;transform:scale(.92)}8.08%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}4.00%{opacity:0;transform:scale(.92)}7.75%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}4.67%{opacity:0;transform:scale(.92)}8.42%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}6.08%{opacity:0;transform:scale(.92)}9.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}6.41%{opacity:0;transform:scale(.92)}10.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}6.75%{opacity:0;transform:scale(.92)}10.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}7.08%{opacity:0;transform:scale(.92)}10.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}3.66%{opacity:0;transform:scale(.92)}7.41%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}7.41%{opacity:0;transform:scale(.92)}11.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}7.75%{opacity:0;transform:scale(.92)}11.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}8.08%{opacity:0;transform:scale(.92)}11.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}8.42%{opacity:0;transform:scale(.92)}12.17%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}10.83%{clip-path:inset(0 0 100% 0)}21.67%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(978.5px,714.0px)}25.83%{opacity:0;transform:translate(978.5px,714.0px)}27.50%{opacity:1;transform:translate(978.5px,714.0px)}35.83%{opacity:1;transform:translate(718.5px,505.2px)}36.67%{opacity:1;transform:translate(718.5px,505.2px) scale(.82)}37.92%{opacity:1;transform:translate(718.5px,505.2px)}45.83%{opacity:0;transform:translate(718.5px,505.2px)}100.00%{opacity:0;transform:translate(718.5px,505.2px)}}.sel{animation:sel 12s ease-out infinite}@keyframes sel{0.00%{opacity:0}36.67%{opacity:0}39.17%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}37.08%{opacity:0;transform:translateX(48px)}42.08%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{opacity:0;animation:cover 12s linear infinite}@keyframes cover{0.00%{opacity:1}1.67%{opacity:0}94.17%{opacity:0}100.00%{opacity:1}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><image id="empty" width="1376" height="774" href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAALine truncated
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /lane-editor/0 and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.44%{opacity:0;transform:scale(.92)}8.19%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}7.86%{opacity:0;transform:scale(.92)}11.61%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}7.19%{opacity:0;transform:scale(.92)}10.94%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}9.27%{opacity:0;transform:scale(.92)}13.02%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}4.77%{opacity:0;transform:scale(.92)}8.52%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}8.19%{opacity:0;transform:scale(.92)}11.94%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}9.60%{opacity:0;transform:scale(.92)}13.35%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}9.94%{opacity:0;transform:scale(.92)}13.69%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}10.27%{opacity:0;transform:scale(.92)}14.02%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}10.61%{opacity:0;transform:scale(.92)}14.36%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}6.85%{opacity:0;transform:scale(.92)}10.60%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}10.94%{opacity:0;transform:scale(.92)}14.69%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c12{transform-origin:0 0;animation:c12 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c12{0.00%{opacity:0;transform:scale(.92)}11.27%{opacity:0;transform:scale(.92)}15.02%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c13{transform-origin:0 0;animation:c13 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c13{0.00%{opacity:0;transform:scale(.92)}11.61%{opacity:0;transform:scale(.92)}15.36%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c14{transform-origin:0 0;animation:c14 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c14{0.00%{opacity:0;transform:scale(.92)}7.52%{opacity:0;transform:scale(.92)}11.27%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}13.75%{clip-path:inset(0 0 100% 0)}24.58%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(853.5px,575.2px)}28.75%{opacity:0;transform:translate(853.5px,575.2px)}30.42%{opacity:1;transform:translate(853.5px,575.2px)}38.75%{opacity:1;transform:translate(593.5px,355.2px)}39.58%{opacity:1;transform:translate(593.5px,355.2px) scale(.82)}40.83%{opacity:1;transform:translate(593.5px,355.2px)}48.75%{opacity:0;transform:translate(593.5px,355.2px)}100.00%{opacity:0;transform:translate(593.5px,355.2px)}}.sel{animation:sel 12s linear infinite}@keyframes sel{0.00%{opacity:0}39.58%{opacity:0}40.42%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}40.00%{opacity:0;transform:translateX(48px)}45.00%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{oLine truncated

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 151 KiB

After

Width:  |  Height:  |  Size: 149 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 KiB

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 169 KiB

After

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 179 KiB

After

Width:  |  Height:  |  Size: 167 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 640 KiB

After

Width:  |  Height:  |  Size: 315 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 642 KiB

After

Width:  |  Height:  |  Size: 316 KiB

+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@expo/explore",
"version": "0.19.8",
"version": "0.20.2",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.19.8",
"version": "0.20.2",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.19.8",
"version": "0.20.2",
"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;
+30 -8
View File
@@ -25,19 +25,40 @@ function keyframes(name, loop, frames) {
return `@keyframes ${name}{${frames.map(([at, css]) => `${((at / loop) * 100).toFixed(2)}%{${css}}`).join("")}}`;
}
/**
* The Map card of `route`: the screenshot button of the node whose id is that route's surface in `review`. The button
* is named after the screen's title, which is not the route when the report has plain titles.
*/
export function mapCard(page, review, route) {
const surface = review.surfaces.find(s => (s.head ?? s.base)?.route === route && s.colorScheme !== "dark");
if (!surface) throw new Error(`The report has no screen at ${route}.`);
return page.locator(`.react-flow__node-screen[data-id="${surface.id}"] .screen-screenshot-target`);
}
/**
* Photographs the hero's states from a Viewer page whose Map has its camera set and nothing selected: the Map without
* its screens, without its edges, and whole; then it clicks `select`, which opens the Inspector without moving the
* camera, and photographs that. Returns the frames and where each screen card, the Inspector and the selected card are.
* camera, and photographs that (`card` is its screenshot button, from mapCard). Returns the frames and where each screen card, the Inspector and the selected card are.
*/
export async function captureHeroFrames(page, { select, viewport }) {
export async function captureHeroFrames(page, { select, card: target, viewport }) {
const shoot = () => page.screenshot({ type: "jpeg", quality: JPEG_QUALITY });
const neutral = () => page.mouse.move(viewport.width - 4, viewport.height - 4);
// Park the pointer on bare canvas, found once the camera is set: over a card it takes a grey ring and darkens the
// card's transitions, over a transition it darkens that one, and over a control it can raise a tooltip.
const rest = await page.evaluate(({ width, height }) => {
for (let y = height - 120; y > 120; y -= 20) for (let x = 40; x < width - 40; x += 20) {
if (document.elementFromPoint(x, y)?.classList.contains("react-flow__pane")) return { x, y };
}
return null;
}, viewport);
if (!rest) throw new Error("The hero's Map has no bare canvas to park the pointer on.");
const neutral = async () => {
await page.mouse.move(rest.x, rest.y);
await page.waitForTimeout(200);
if (await page.locator(".canvas-hovering, .graph-node-hover-subject").count()) throw new Error("The pointer at rest still hovers the Map.");
};
const rect = locator => locator.boundingBox().then(b => b && { x: Math.round(b.x), y: Math.round(b.y), width: Math.round(b.width), height: Math.round(b.height) });
const camera = () => page.locator(".react-flow__viewport").evaluate(el => el.style.transform);
const target = page.locator(`.screen-screenshot-target[title="${select}"]`);
// A card under the pointer dims the others and highlights its edges; let that fade before the first frame.
await neutral();
await page.waitForTimeout(1000);
const at = await camera();
@@ -124,8 +145,9 @@ export function heroSvg(frames, theme, alt) {
]));
defs.push(`<clipPath id="canvas"><rect x="0" y="0" width="${p.x}" height="${v.height}"/></clipPath>`);
defs.push(`<clipPath id="panel"><rect ${box(p)}/></clipPath>`);
css.push(`.sel{animation:sel ${LOOP}s ease-out infinite}`);
css.push(keyframes("sel", LOOP, [[0, "opacity:0"], [CLICK + 0.1, "opacity:0"], [CLICK + 0.4, "opacity:1"], [LOOP, "opacity:1"]]));
// The selection lands as the Viewer draws it, at once: a ring and its transitions in the accent, nothing fading.
css.push(`.sel{animation:sel ${LOOP}s linear infinite}`);
css.push(keyframes("sel", LOOP, [[0, "opacity:0"], [CLICK + 0.1, "opacity:0"], [CLICK + 0.2, "opacity:1"], [LOOP, "opacity:1"]]));
css.push(`.insp{animation:insp ${LOOP}s cubic-bezier(.2,.8,.2,1) infinite}`);
css.push(keyframes("insp", LOOP, [[0, "opacity:0;transform:translateX(48px)"], [CLICK + 0.15, "opacity:0;transform:translateX(48px)"], [CLICK + 0.75, "opacity:1;transform:translateX(0)"], [LOOP, "opacity:1;transform:translateX(0)"]]));
layers.push(`<use class="sel" href="#inspecting" clip-path="url(#canvas)"/>`);
@@ -237,7 +259,7 @@ export async function compareSvg(browser, report, surface, theme, alt) {
+ `<g class="divider"><rect x="${x - 1.5}" y="${y}" width="3" height="${PH}" fill="${t.accent}"/><circle cx="${x}" cy="${y + PH / 2}" r="13" fill="${t.accent}"/>`
+ `<path d="M${x - 5} ${y + PH / 2 - 4}l-3 4l3 4M${x + 5} ${y + PH / 2 - 4}l3 4l-3 4" stroke="#fff" stroke-width="1.8" fill="none" stroke-linecap="round" stroke-linejoin="round"/></g>`
+ `<g class="regions">${regions}</g>`
+ label("before-label", "end", x - 44, "Before", `${pullRequest.base.ref} ·${pullRequest.base.sha.slice(0, 7)}`)
+ label("before-label", "end", x - 44, "Before", `${pullRequest.base.ref} · ${pullRequest.base.sha.slice(0, 7)}`)
+ label("after-label", "start", x + PW + 44, "After", `PR #${pullRequest.number} · ${pullRequest.head.sha.slice(0, 7)}`, `${count} changed region${count === 1 ? "" : "s"}`)
+ "</g></svg>";
}
+33 -19
View File
@@ -13,12 +13,14 @@
// It becomes readme-compare-*.svg, its before capture wiping to its after capture
// --pr a GitHub PR URL whose Explore comment becomes readme-pr-comment-light.png (public repository): the comment
// at its own size on a soft stage, cut off with a fade after the list of changed screens
// --only the pictures to write, comma-separated, of hero, compare, screens and pr-comment; default all of them (the
// PR comment only with --pr). --only pr-comment needs no --report
import { chromium } from "@playwright/test";
import { readFile, writeFile } from "node:fs/promises";
import { parseArgs } from "node:util";
import { fileURLToPath } from "node:url";
import { startReportViewer } from "../test/ci/lib/report-viewer.mjs";
import { captureHeroFrames, compareSurface, compareSvg, heroSvg, openReport } from "./readme-animations.mjs";
import { captureHeroFrames, compareSurface, compareSvg, heroSvg, mapCard, openReport } from "./readme-animations.mjs";
const { values: args } = parseArgs({
options: {
@@ -27,25 +29,36 @@ const { values: args } = parseArgs({
compare: { type: "string", default: "patterns" },
pr: { type: "string" },
zoom: { type: "string", default: "73" },
only: { type: "string" },
},
});
if (!args.report) {
const PICTURES = ["hero", "compare", "screens", "pr-comment"];
const only = args.only?.split(",").map(name => name.trim()).filter(Boolean);
const unknown = only?.filter(name => !PICTURES.includes(name)) ?? [];
if (unknown.length) {
console.error(`Unknown --only ${unknown.join(", ")}; pass some of ${PICTURES.join(", ")}.`);
process.exit(2);
}
const wanted = name => !only || only.includes(name);
const fromReport = PICTURES.filter(name => name !== "pr-comment").some(wanted);
if (fromReport && !args.report) {
console.error("Pass --report <review report zip>. See skills/readme-refresh/SKILL.md for where the euxy report comes from.");
process.exit(2);
}
const out = fileURLToPath(new URL("../docs/screenshots/", import.meta.url));
const SHOTS = [
{ file: "readme-hero", hash: "#/map", viewport: { width: 1376, height: 774 }, click: "Fit canvas", select: args.select, zoom: Number(args.zoom), animated: true },
{ file: "readme-screens", hash: "#/screens", viewport: { width: 1760, height: 1000 } },
];
{ name: "hero", file: "readme-hero", hash: "#/map", viewport: { width: 1376, height: 774 }, click: page => page.getByRole("button", { name: "Fit canvas" }), select: args.select, zoom: Number(args.zoom), animated: true },
// Screens shows its Changed filter, so the added, removed and modified dots are all in view wherever the tree sorts them.
{ name: "screens", file: "readme-screens", hash: "#/screens", viewport: { width: 1760, height: 1000 }, click: page => page.locator(".screens-chip", { hasText: "Changed" }) },
].filter(shot => wanted(shot.name));
const bytes = await readFile(args.report);
const report = await openReport(bytes);
const { server, url } = await startReportViewer({ bytes, watch: false });
const bytes = fromReport ? await readFile(args.report) : undefined;
const report = bytes && await openReport(bytes);
const { server, url } = bytes ? await startReportViewer({ bytes, watch: false }) : {};
const browser = await chromium.launch();
try {
for (const theme of ["light", "dark"]) {
for (const theme of wanted("compare") ? ["light", "dark"] : []) {
const surface = compareSurface(report.review, args.compare, theme);
const path = `${out}readme-compare-${theme}.svg`;
await writeFile(path, await compareSvg(browser, report, surface, theme,
@@ -60,20 +73,20 @@ try {
await page.waitForSelector(".react-flow__node, .compare-stage, .screens-cell", { timeout: 60_000 });
await page.waitForTimeout(4000);
if (shot.click) {
await page.getByRole("button", { name: shot.click }).click();
await shot.click(page).click();
await page.mouse.move(400, shot.viewport.height - 30);
await page.waitForTimeout(1500);
}
if (shot.select && !shot.animated) {
// Selecting a screen opens the Inspector without moving the fitted camera. The animated hero selects it last.
await page.locator(`.screen-screenshot-target[title="${shot.select}"]`).click();
await mapCard(page, report.review, shot.select).click();
await page.mouse.move(400, shot.viewport.height - 30);
await page.waitForTimeout(1500);
}
if (shot.zoom) {
// Zoom around the selected screen with the wheel, which keeps it under the pointer, then pan it left and up, clear
// of the minimap and the bottom bar. The camera stops at the first wheel step past the zoom asked for.
const box = await page.locator(`.screen-screenshot-target[title="${shot.select}"]`).boundingBox();
const box = await mapCard(page, report.review, shot.select).boundingBox();
await page.mouse.move(box.x + box.width / 2, box.y + box.height / 2);
for (let step = 0; step < 60; step++) {
if (Number((await page.locator(".zoom-button span").first().textContent()).replace("%", "")) >= shot.zoom) break;
@@ -88,29 +101,30 @@ try {
}
const path = `${out}${shot.file}-${theme}.${shot.animated ? "svg" : "png"}`;
if (shot.animated) {
const frames = await captureHeroFrames(page, { select: shot.select, viewport: shot.viewport });
const frames = await captureHeroFrames(page, { select: shot.select, card: mapCard(page, report.review, shot.select), viewport: shot.viewport });
await writeFile(path, heroSvg(frames, theme,
`Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects ${shot.select} and the Inspector opens on it`));
} else await page.screenshot({ path });
console.log(path);
await context.close();
}
for (const theme of args.pr ? ["light", "dark"] : []) {
for (const theme of args.pr && wanted("pr-comment") ? ["light", "dark"] : []) {
// Signed-out github.com follows prefers-color-scheme.
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 });
@@ -121,7 +135,7 @@ try {
}
} finally {
await browser.close();
await server.close?.();
await server?.close?.();
}
/**
+7 -7
View File
@@ -12,8 +12,8 @@ This is a repository-maintenance skill (it is not shipped in the npm package; `s
The README's screenshots and its live example (`https://explore-example--euxy.expo.app/p/<token>`, deployed by `.github/workflows/example-report.yml`) must show the same report. The example serves the `viewer-preview-fixtures` release, the same reports every pull request's Viewer preview uses, so start there:
```sh
gh release download viewer-preview-fixtures --pattern reports.json --output - | jq -r '.[0].source' # e.g. brentvatne/euxy#154
mkdir -p ~/euxy-report && gh release download viewer-preview-fixtures --pattern ios.zip --dir ~/euxy-report --clobber
gh release download viewer-preview-fixtures --pattern reports.json --output - | jq -r '.[0] | "\(.target) \(.source)"' # e.g. iphone brentvatne/euxy#163
mkdir -p ~/euxy-report && gh release download viewer-preview-fixtures --pattern iphone.zip --dir ~/euxy-report --clobber
```
Keep those fixtures when their euxy PR still shows a real change (an added or removed screen, modified screens with outlined regions). To move to a newer euxy PR, open its Explore comment and follow **iOS report** to the hosted link `https://euxy-explore--<id>.expo.app/p/<token>`. Then refresh the fixtures from that link and download them again:
@@ -28,13 +28,13 @@ Do not pick a same-tree demo PR, where every change is noise. The refreshed fixt
```sh
npm ci
node scripts/readme-screenshots.mjs --report ~/euxy-report/ios.zip --select /about --compare patterns --pr https://github.com/brentvatne/euxy/pull/<n>
node scripts/readme-screenshots.mjs --report ~/euxy-report/iphone.zip --select /lane-editor/0 --compare new-pattern --pr https://github.com/brentvatne/euxy/pull/<n>
```
- `--select` is the route the hero's pointer clicks on the Map (the Inspector opens on it): choose an added or clearly modified screen. The script zooms in around it, so it must be a screen the Map shows.
- `--compare` is the key in the Viewer's `#/compare/<key>` URL for a **modified** screen with outlined regions (open the report, click the screen in Compare, copy the key): the route without its slash. The script fails if the report has no visually modified screen at that route.
- `--pr` screenshots the Explore comment on that PR: the fixtures' `source`. Headless Chromium needs a colour emoji font for the result glyphs (`sudo apt-get install fonts-noto-color-emoji` on Debian/Ubuntu); a comment with hollow boxes where 🟩 should be is not acceptable.
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` file for every picture (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right.
- `--pr` screenshots the Explore comment on that PR: the fixtures' `source`, or a newer euxy PR when that comment predates the current layout. `--only pr-comment --pr <url>` rewrites only the comment pictures (it needs no `--report`); `--only` takes any of `hero`, `compare`, `screens` and `pr-comment`. Headless Chromium needs a colour emoji font for the result glyphs (`sudo apt-get install fonts-noto-color-emoji` on Debian/Ubuntu); a comment with hollow boxes where 🟩 should be is not acceptable.
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` file for every picture (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right. The Screens and PR comment pictures, shown at half the column, are each wrapped in an `<a>` to their light PNG so a reader can open them full size; GitHub links a plain Markdown image itself, but not a `<picture>`.
Two of the pictures are animated SVGs, built by `scripts/readme-animations.mjs` in the same run; there is nothing else to run when the screenshots change:
@@ -53,7 +53,7 @@ npx @expo/explore reports list # your sa
export EXPLORE_CACHE_DIR=$(mktemp -d) # a scratch store for the image, not your own runs
cd ~/code/euxy # inside euxy, so the commit messages are found
npx @expo/explore reports add ~/.cache/expo-explore/reports/<that id>/ios.zip
npx @expo/explore reports add ~/euxy-report/ios.zip # the PR report from step 1
npx @expo/explore reports add ~/euxy-report/iphone.zip # the PR report from step 1
npx @expo/explore reports add <an explore:binary report directory> # an exploration, so all three kinds show
cd - && npm run build:cli && node scripts/readme-reports-rows.mjs > /tmp/reports-rows.html
```
@@ -61,7 +61,7 @@ cd - && npm run build:cli && node scripts/readme-reports-rows.mjs > /tmp/reports
- The script renders the picker as the CLI draws it (96 columns, the newest run selected) and writes the terminal body as HTML: each coloured piece is exactly its characters wide, so columns line up, and the wordmark is drawn as cell rectangles, since a design tool's font does not draw `█▀▄` cell for cell.
- In Paper, replace the frame named "Terminal" inside each artboard's window with that HTML, check both artboards in a screenshot (crisp wordmark, aligned columns, the selected row highlighted to the end, coloured counts), and export both at 2x as `readme-reports-light.png` and `readme-reports-dark.png`. The window's title bar reads `npx @expo/explore reports`, as people run it.
Look at every PNG you produced before committing, light and dark: the Screens grid must show the added, removed and modified status dots, the PR comment must show the heading links and result glyphs. Describe each in its Markdown alt text as what the picture shows, not what the feature is.
Look at every PNG you produced before committing, light and dark: the Screens grid must show the added, removed and modified status dots, the PR comment must show the heading links, the line of device links and the list of changed screens. Describe each in its Markdown alt text as what the picture shows, not what the feature is.
## 3. Pass over the content as a first-time user
+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();
+27 -3
View File
@@ -216,6 +216,21 @@ const KEYBOARD_DISMISS_LABELS = ["Hide keyboard", "Dismiss keyboard", "Done"];
const KEYBOARD_TOP = 0.4;
const ALERT_PREFERRED_BUTTONS = ["Open", "OK", "Allow", "Allow While Using App", "Continue"];
const READ_TOOLS = new Set(["ui-tree", "list-devices", "screenshot", "foreground-app", "await-screen-idle", "describe"]);
/**
* Argent 0.29's answer when a service a tool depends on (the device's simulator-server, its accessibility service) did
* not start: the registry resolves a tool's services before it calls the tool, and wraps a start failure as
* "[Tool:<id>] Service dependency failed: …", so the tool itself never ran and resending it is safe, a UI action too.
* The tools the bridge sends that resolve a service while they run (keyboard, fill, restart-app, screen-recording-start)
* resolve it before they act, and run-sequence answers a step's failure in its result rather than raising it. A failed
* start leaves the service in the registry's ERROR state, so the next call starts it afresh.
*/
const SERVICE_DEPENDENCY_FAILED = "Service dependency failed:";
/**
* In brentvatne/euxy#172 (review run 39348956443) capture restarted SpringBoard and folded the iPhone Duo open again 8 s
* later; that fold's simulator-server did not become ready within Argent's 30 s, and the whole target failed. The resend
* comes after a pause, so a device still coming back from the restart has the time it needs.
*/
const DEPENDENCY_RETRY_DELAYS_MS = [3_000, 6_000] as const;
const SPRINGBOARD = "com.apple.springboard";
const ANDROID_SYSTEM_UI = "com.android.systemui";
const OPEN_IN_APP_PROMPT = /^Open in “.+”\?$/;
@@ -299,14 +314,23 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
const { positional, flags } = parseCommand(rest);
const bundleFlag = typeof flags["bundle-id"] === "string" ? flags["bundle-id"] : context.bundleId;
/** Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check. */
/**
* Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check.
* Any tool, a UI action too, is resent when Argent could not start a service it depends on, which it raises before
* the tool runs (see SERVICE_DEPENDENCY_FAILED).
*/
const call = async (tool: string, args: Record<string, unknown> = {}, options?: { out?: string }): Promise<Record<string, unknown>> => {
// Tools that name devices their own way (or none) take no udid.
const withDevice = tool === "list-devices" || tool === "stop-all-simulator-servers" ? args : { udid: state.udid, ...args };
for (let attempt = 0; ; attempt++) {
for (let readRetry = 0, dependencyRetry = 0; ;) {
try { return record(await context.call(tool, withDevice, options)); }
catch (error) {
if (READ_TOOLS.has(tool) && attempt < 2) { await context.sleep(1_000 * (attempt + 1)); continue; }
if (error instanceof ArgentCallError && error.message.includes(`[Tool:${tool}] ${SERVICE_DEPENDENCY_FAILED}`)
&& dependencyRetry < DEPENDENCY_RETRY_DELAYS_MS.length) {
await context.sleep(DEPENDENCY_RETRY_DELAYS_MS[dependencyRetry++]!);
continue;
}
if (READ_TOOLS.has(tool) && readRetry < 2) { await context.sleep(1_000 * ++readRetry); continue; }
throw error;
}
}
+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. */
+57 -19
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();
@@ -441,6 +454,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
// `eas simulator:control` names the session by id, from the session's own project directory.
const sessionEas: EasCommand = (args, commandOptions) => runner({ command: options.easCommand, args, cwd: simulatorProject, environment: easEnvironment,
timeoutMs: commandOptions?.timeoutMs ?? 5 * 60_000, ...(commandOptions?.allowFailure ? { allowFailure: true } : {}) });
// A failed simulator:control action is sent again after a pause, which a test's clock replaces.
const controlOptions = { sleep: options.sleep };
// What the EAS session's host can do through simulator:control (iOS sessions on serve-sim 0.10.0 or later).
let controlActions = new Set<string>();
const configResult = eas(["config", "--platform", options.platform, "--profile", options.easProfile, "--json", "--non-interactive"]);
@@ -481,6 +496,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 +579,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 +590,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 +604,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 +620,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 +775,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}`);
@@ -763,7 +787,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
"--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
// Before any link opens, as a local capture does with simctl: the app's own links then open without the prompt.
if (sessionId && scheme) {
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme]);
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme], controlOptions);
if (approved.length) say(`approved ${approved.map(item => `${item}://`).join(", ")} links on session ${sessionId}`);
}
}
@@ -774,8 +798,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const target = deviceArgs({ platform: options.platform, deviceModel: options.device, ...(localDevice() ? { provider: "local-simulator" as const, controllerDeviceId: localDevice()! } : {}) });
// agent-device reads the hinge back after folding and fails to (locally and on EAS); its display is checked instead.
const easAgentDevice = !!sessionId && controller === "agent-device";
// Argent's bridge sends a fold again, twice, when the simulator-server it needs did not start within Argent's 30 s,
// so a fold can take three of those waits and the panel checks after it: 4 minutes covers that.
const fold = () => runner({ command: controllerCommand, args: ["fold", options.devicePose!, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 4 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
const pause = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
if (localSimulator && controller === "argent") {
// Argent folds without a session and checks the fold against its own reader; this machine also checks the display.
@@ -822,7 +848,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
if (!controlActions.has("springboard.restart")) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
message: `${options.device} did not show the ${options.devicePose} display after folding.`, nextAction: "Rerun the capture on a new session." });
say(`${options.device} did not draw the ${options.devicePose} display after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
simulatorControl(sessionEas, sessionId, "springboard.restart");
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
pause(8_000);
open(true);
fold();
@@ -837,7 +863,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
catch (error) {
if (toCiError(error).code !== "CONTROLLER_FOLD_UNVERIFIED") throw error;
say(`Argent kept reading the other panel after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
simulatorControl(sessionEas, sessionId, "springboard.restart");
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
pause(8_000);
try { fold(); }
catch (retry) {
@@ -870,7 +896,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
nextAction: "Rerun the capture; if it keeps happening, report it to Explore: this session's Argent tool-server needs a restart that EAS cannot do yet.", cause: error });
if (recovery === 1) {
say("Argent still did not read the app; restarting SpringBoard, then resetting Argent's device helpers and opening the app again");
simulatorControl(sessionEas, sessionId, "springboard.restart");
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
// SpringBoard takes a moment to come back, and sends the app to the background; the next open brings it back.
(options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); }))(8_000);
} else say("Argent did not read the app after starting it; resetting Argent's device helpers and opening the app again");
@@ -914,12 +940,15 @@ 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],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme]);
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme], controlOptions);
else if (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
@@ -944,16 +973,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 +1052,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) {
+35 -5
View File
@@ -20,23 +20,53 @@ export function simulatorControlActions(eas: EasCommand, sessionId: string): Set
} catch { return new Set(); }
}
/** Runs one `eas simulator:control` action on the session; eas-cli fills in the device. Throws with EAS's reason. */
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = []): void {
/**
* Pauses before each resend of a failed action. Every action Explore runs is idempotent, and the session's host can fail
* one once: in brentvatne/euxy's baseline run 39348933440, `app.approveUrlScheme` failed in its `simctl spawn … defaults
* write`, which failed the dark-appearance session and with it the target's whole baseline.
*/
const SIMULATOR_CONTROL_RETRY_DELAYS_MS = [3_000, 6_000] as const;
/** Lets a test replace the pause between resends of a failed action. */
export type SimulatorControlOptions = { sleep?: ((milliseconds: number) => void) | undefined };
/**
* Runs one `eas simulator:control` action on the session; eas-cli fills in the device. A failed action is sent again
* after a pause; one that still fails throws with EAS's reason.
*/
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = [], options: SimulatorControlOptions = {}): void {
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
// Values follow `--` so one that starts with a dash is never read as a flag.
eas(["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values], { timeoutMs: 2 * 60_000 });
const args = ["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values];
for (let retry = 0; ; retry += 1) {
try { eas(args, { timeoutMs: 2 * 60_000 }); return; }
catch (error) {
const delayMs = SIMULATOR_CONTROL_RETRY_DELAYS_MS[retry];
if (delayMs === undefined) throw error;
// A resend that succeeds would otherwise leave no trace of the failure in the job log.
process.stderr.write(`simulator:control ${action} failed (${firstLine(error)}); sending it again in ${delayMs / 1000} s\n`);
sleep(delayMs);
}
}
}
/**
* Lets the app open its own links without iOS asking "Open in “App”?" first, like local captures do with simctl. A
* session without the action keeps the controllers' prompt handling; http and https never prompt and are skipped.
*/
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[]): string[] {
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[],
options: SimulatorControlOptions = {}): string[] {
if (!actions.has("app.approveUrlScheme")) return [];
const approved: string[] = [];
for (const scheme of new Set(schemes.map(value => value.toLowerCase()))) {
if (scheme === "http" || scheme === "https" || !/^[a-z][a-z0-9+.-]*$/.test(scheme)) continue;
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme]);
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme], options);
approved.push(scheme);
}
return approved;
}
/** The first line of a failure, for a log line. */
function firstLine(error: unknown): string {
return (error instanceof Error ? error.message : String(error)).split("\n", 1)[0]!.slice(0, 300);
}
+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.
+129 -12
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"];
@@ -308,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`];
@@ -328,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));
@@ -369,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 } : {}),
@@ -462,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). */
@@ -487,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] };
}
+8 -4
View File
@@ -106,8 +106,11 @@ type GithubArtifact = { id: number; expired: boolean; workflow_run?: { id?: numb
type GithubRun = { conclusion: string | null; workflow_id: number; head_sha: string; head_branch: string; event: string; head_repository?: { full_name?: string } };
/**
* `ci:find-baseline`: the newest successful baseline-workflow artifact of exactly this commit, uploaded from the
* default branch of this repository. Its id and run go to the step outputs for actions/download-artifact.
* `ci:find-baseline`: the newest baseline-workflow artifact of exactly this commit, uploaded from the default branch of
* this repository by a finished run. Its id and run go to the step outputs for actions/download-artifact. A run that
* failed counts: a target's baseline job uploads its artifact only after every step before it passed, so another
* target's failure (one flaky simulator session, as in brentvatne/euxy#172) does not make this target's baseline
* unusable. A run still in progress or cancelled does not.
*/
export async function findBaselineArtifact(options: { sha: string; target?: string;
/** What callers from before targets pass: a platform is the id of its default target. */ platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
@@ -131,7 +134,7 @@ export async function findBaselineArtifact(options: { sha: string; target?: stri
for (const artifact of artifacts.filter(candidate => !candidate.expired).sort((a, b) => b.id - a.id)) {
if (!artifact.workflow_run?.id) continue;
const run = await githubGet<GithubRun>(`repos/${context.repository}/actions/runs/${artifact.workflow_run.id}`, context, transport);
if (!run || run.conclusion !== "success" || run.workflow_id !== workflow.id || run.head_sha !== options.sha
if (!run || (run.conclusion !== "success" && run.conclusion !== "failure") || run.workflow_id !== workflow.id || run.head_sha !== options.sha
|| run.head_branch !== repository.default_branch || !["push", "workflow_dispatch"].includes(run.event)
|| run.head_repository?.full_name !== context.repository) continue;
return { id: artifact.id, run: artifact.workflow_run.id };
@@ -196,7 +199,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. */ }
}
+4
View File
@@ -5,6 +5,7 @@ import { resolve } from "node:path";
import { ExploreStore } from "./map/store.js";
import { QUERY_CONTRACT } from "./types.js";
import { EXPLORE_VERSION } from "./shared/package-paths.js";
import { isTargetId } from "./config/explore-config.js";
import { command, resultContract, argumentError, validateCommandArguments, flag, has, setStore } from "./cli/args.js";
import { help } from "./cli/help.js";
import { listScreens, getScreen, listElements, listObservations, getObservation, nextFrontier, listAttempts, getAttempt, listTransitions, getTransition, neighbors, pathQuery, listJourneys, getJourney, listFrontier, listGaps, summary, search, status, validate, exportArtifacts } from "./cli/map-commands.js";
@@ -81,8 +82,11 @@ try {
await handler();
} catch (error) {
if (command.startsWith("capture:") || command.startsWith("source:") || command.startsWith("ci:") || command.startsWith("config:")) {
// The failure comment names the target from this: a capture, report or publication of one matrix target.
const target = (() => { try { return flag("target"); } catch { return undefined; } })();
const diagnostic = await reportCiError(ciErrorForCommand(error, command), {
...(process.env.RUNNER_TEMP ? { diagnosticsPath: resolve(process.env.RUNNER_TEMP, "explore-diagnostics", "error.json") } : {}),
...(isTargetId(target) ? { target } : {}),
...(has("json") ? { write: (line: string) => { if (process.env.GITHUB_ACTIONS === "true") console.log(line); } } : {}),
});
if (has("json")) console.error(JSON.stringify({ contract: resultContract, command, ok: false, error: diagnostic.message, diagnostic }));
+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) {
+73
View File
@@ -0,0 +1,73 @@
import type { PublicReview } from "./capture.js";
import { navigationCaptureContext } from "./navigation-graph.js";
type Surface = PublicReview["surfaces"][number];
type Side = "base" | "head";
/** Navigation is route-level: a secondary-appearance surface (`<id>@<scheme>`) rides on its route's entry. */
const SCHEME_SUFFIX = /@(light|dark)$/;
const routeOf = (id: string): string => id.replace(SCHEME_SUFFIX, "");
/**
* The surfaces a side planned to capture: every route in `all` mode, the changed routes and their navigation context in
* `changes` mode. Undefined without navigation, which leaves no route outside the context.
*/
export function captureContext(review: PublicReview, side: Side): ReadonlySet<string> | undefined {
const navigation = review.navigation?.[side];
if (!navigation) return undefined;
const inventory = review.surfaces.filter((surface) => surface[side]);
const routes = new Map<string, NonNullable<Surface[Side]>>();
for (const surface of inventory) {
const id = routeOf(surface.id);
if (!routes.has(id)) routes.set(id, { ...surface[side]!, id });
}
const selected = new Set(review.mode === "all" ? [...routes.keys()] : navigationCaptureContext(navigation,
inventory.filter((surface) => surface.status !== "unchanged").map((surface) => routeOf(surface.id)),
[...routes.values()]));
return new Set(inventory.filter((surface) => selected.has(routeOf(surface.id))).map((surface) => surface.id));
}
/** Both a screenshot of the planned route and a verified landing on it. */
export function verifiedCapture(surface: Surface, side: Side): boolean {
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
return Boolean(surface[side]?.kind === "screen" && (side === "base" ? surface.baseImage : surface.headImage)
&& outcome?.status === "captured" && outcome.landing === "verified");
}
/**
* Why a side that exists in its revision has no verified capture, as the report's capture gap: `accepted` when the run
* left it uncaptured on purpose (a redirect declaration, a route named in `exploration.exclude`, or a route outside the
* capture context), `open` for anything else, such as a capture that failed. Undefined for a verified capture or an
* absent side. `context` is the side's `captureContext`.
*/
export function captureGap(review: PublicReview, surface: Surface, side: Side,
context: ReadonlySet<string> | undefined): "accepted" | "open" | undefined {
const entry = surface[side];
if (!entry || verifiedCapture(surface, side)) return undefined;
const image = side === "base" ? surface.baseImage : surface.headImage;
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
const outsideCaptureContext = review.mode === "changes" && context !== undefined && !context.has(surface.id);
const deliberate = !image && !outcome && (entry.kind === "redirect" || surface.excluded === true || outsideCaptureContext
|| (!review.navigation?.[side] && review.mode === "changes" && surface.status === "unchanged"));
return deliberate ? "accepted" : "open";
}
/**
* The surfaces the run never captured on purpose: no screenshot of their own on either side, and every side that exists
* left uncaptured deliberately (`captureGap` is `accepted`). None is one of the report's screens. The Viewer leaves them
* out (viewer/src/utils/omitted-screens.ts reaches the same set from the map's gaps), and the PR comment skips them.
* A side with an open gap, such as a failed capture, keeps the surface: its failure is part of the report.
*/
export function neverCapturedSurfaceIds(review: PublicReview): ReadonlySet<string> {
// The Viewer refuses a review whose navigation names a route its inventory lacks; the comment still renders one,
// without a capture context, so no route counts as outside it.
const contextOf = (side: Side) => { try { return captureContext(review, side); } catch { return undefined; } };
const contexts = { base: contextOf("base"), head: contextOf("head") };
const omitted = new Set<string>();
for (const surface of review.surfaces) {
if (surface.baseImage || surface.headImage) continue;
const gaps = (["base", "head"] as const).map((side) => captureGap(review, surface, side, contexts[side]));
if (gaps.includes("accepted") && !gaps.includes("open")) omitted.add(surface.id);
}
return omitted;
}
+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 {
+11 -3
View File
@@ -8,6 +8,7 @@ import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPres
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
import { upsertStickyComment } from "./pr-comment.js";
import { retryGitHubLookup } from "./github-lookup.js";
import { previewLinks, viewerLinks } from "./viewer-links.js";
import type { PublicReview } from "../contracts/capture.js";
import { CiError, toCiError } from "../shared/ci-errors.js";
@@ -136,6 +137,8 @@ export async function publishCiReportComment(options: {
preview?: { url: string; expiresAt: number | null };
/** Set by `ci:deploy` when the hosted preview failed: the comment falls back to the central Viewer and the ZIP. */
previewFailed?: boolean;
/** Pause between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
sleep?: (milliseconds: number) => Promise<void>;
}) {
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
const input = await readInput(options.inputPath); const review = input.publicReview; const pr = review.pullRequest;
@@ -186,16 +189,21 @@ export async function publishCiReportComment(options: {
catch (error) { throw new CiError({ code: "GITHUB_RESPONSE_INVALID", stage: "publication",
message: "GitHub returned invalid report metadata.", nextAction: "Rerun publication; if the response remains invalid, inspect the GitHub metadata request.", cause: error }); }
};
const artifact = await api(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
// A lookup is made again when GitHub may answer it later: no answer, a 5xx, or a 404 from the Actions API, which may
// not list a just-uploaded artifact yet. A bad token, a missing permission or a rate limit fails at once, as before.
const lookup = (path: string) => retryGitHubLookup(() => api(path), error => error instanceof CiError
&& (error.code === "GITHUB_NETWORK_FAILED" || error.code === "GITHUB_REQUEST_FAILED" && error.retryable
|| error.code === "GITHUB_RESOURCE_NOT_FOUND" && path.startsWith("actions/")), options.sleep);
const artifact = await lookup(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${target ? `-${target}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
throw new CiError({ code: artifact.expired ? "REPORT_ARTIFACT_EXPIRED" : "REPORT_ARTIFACT_MISMATCH", stage: "publication",
message: "The uploaded report artifact is unavailable or belongs to another run",
nextAction: artifact.expired ? "Rerun Explore to upload a fresh report artifact." : "Pass the final report artifact from this workflow run and attempt." });
}
const attempt = await api(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
const attempt = await lookup(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
if (String(attempt.id) !== review.runId || String(attempt.run_attempt) !== review.runAttempt) throw new CiError({ code: "REPORT_RUN_MISMATCH", stage: "publication",
message: "Report run attempt mismatch", nextAction: "Publish the artifact and report input from the same current workflow attempt." });
const current = await api(`pulls/${pr.number}`);
const current = await lookup(`pulls/${pr.number}`);
if (current.state !== "open" || current.head?.repo?.full_name !== pr.repository || current.head?.ref !== pr.head.ref) {
throw new CiError({ code: "PR_CHANGED", stage: "publication", message: "PR closed or changed branches before the report artifact was ready",
nextAction: "Run Explore for the current PR head and base before publishing a ready report." });
+69 -41
View File
@@ -15,7 +15,7 @@ export type FailureCommentOptions = {
runAttempt: string;
/** The directory the failure job downloaded diagnostics artifacts into (`<stage>/<artifact>/…/error.json`). */
diagnosticsPath?: string;
/** The failed target's id; otherwise the one the first diagnostics artifact's name carries. */
/** The failed target's id; otherwise every target the diagnostics artifacts name. */
target?: string;
/** What callers from before targets pass: a platform is the id of its default target. */
platform?: ExplorePlatform;
@@ -25,6 +25,8 @@ export type FailureCommentOptions = {
};
type Diagnostic = { code: string; stage: string; message: string; nextAction: string };
/** A failed target's diagnostic. `target` is absent when neither the artifact's name nor the file names one. */
export type LocatedFailure = { diagnostic?: Diagnostic; target?: string; platform?: ExplorePlatform };
const SHA = /^[0-9a-f]{40}$/;
// `explore-<kind>-<run>-<attempt>-<target>`: the kind has no digits, so the first number is the run and the rest is the target id.
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
@@ -34,11 +36,14 @@ const MAX_DIAGNOSTIC_BYTES = 32_768;
const CODE = /^[A-Z][A-Z0-9_]{1,63}$/;
const STAGE = /^[a-z][a-z0-9-]{0,63}$/;
function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
function parseJson(text: string): Record<string, unknown> | undefined {
let parsed: unknown;
try { parsed = JSON.parse(text); } catch { return undefined; }
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return undefined;
const value = parsed as Record<string, unknown>;
return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed as Record<string, unknown> : undefined;
}
function parseDiagnostic(value: Record<string, unknown> | undefined, stage: string): Diagnostic | undefined {
if (!value) return undefined;
const field = (name: string, max: number) => typeof value[name] === "string" && (value[name] as string).trim() && (value[name] as string).length <= max ? value[name] as string : undefined;
const code = field("code", 64), message = field("message", 4000), nextAction = field("nextAction", 4000), stageName = field("stage", 64) ?? stage;
if (!code || !CODE.test(code) || !message || !nextAction || !STAGE.test(stageName)) return undefined;
@@ -46,32 +51,51 @@ function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
return { code, stage: stageName, message, nextAction };
}
/** Reads one error.json; `named` is the target its artifact directory names, else the one the file records. */
async function readFailure(path: string, stage: string, named: string | undefined): Promise<LocatedFailure | undefined> {
const info = await lstat(path).catch(() => undefined);
if (!info) return undefined;
const located = (target: string | undefined): LocatedFailure => ({ ...(target ? { target } : {}), ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) });
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located(named);
const value = parseJson(await readFile(path, "utf8"));
const target = named ?? (isTargetId(value?.target) ? value.target : undefined);
const diagnostic = parseDiagnostic(value, stage);
return diagnostic ? { diagnostic, ...located(target) } : located(target);
}
/**
* The error.json a failed job left behind and the target its artifact name carries (`ios` or `android` for a config
* without targets, and for artifacts of versions before targets). A report failure's diagnostic takes precedence over
* capture's; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
* Every failed target's error.json and the target it belongs to (`ios` or `android` for a config without targets, and
* for artifacts of versions before targets). actions/download-artifact puts each artifact a pattern matches in a
* directory named after it, except when the pattern matches exactly one: that one lands in the stage's directory
* itself, and the file names its target. A report failure's diagnostic takes precedence over its target's capture
* diagnostic; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
* regular files count (never symlinks out of the artifact). `platform` is set when the target id is a platform's.
*/
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; target: string; platform?: ExplorePlatform } | undefined> {
export async function locateFailureDiagnostics(root: string): Promise<LocatedFailure[]> {
const failures: LocatedFailure[] = [];
const seen = new Set<string>();
for (const [stage, file] of [["report", "error.json"], ["capture", join("explore-diagnostics", "error.json")]] as const) {
const entries = await readdir(join(root, stage), { withFileTypes: true }).catch(() => []);
for (const entry of entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
const path = join(root, stage, entry.name, file);
const info = await lstat(path).catch(() => undefined);
if (!info) continue;
const target = artifactTarget(entry.name)!;
const located: { target: string; platform?: ExplorePlatform } = { target, ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) };
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located;
const diagnostic = parseDiagnostic(await readFile(path, "utf8"), stage);
return diagnostic ? { diagnostic, ...located } : located;
const candidates = [...entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))
.map(entry => ({ path: join(root, stage, entry.name, file), named: artifactTarget(entry.name) })), { path: join(root, stage, file), named: undefined }];
for (const { path, named } of candidates) {
const located = await readFailure(path, stage, named);
if (!located || seen.has(located.target ?? "")) continue;
seen.add(located.target ?? "");
failures.push(located);
}
}
return undefined;
return failures;
}
/** The first failure locateFailureDiagnostics finds: a report failure before a capture failure. */
export async function locateFailureDiagnostic(root: string): Promise<LocatedFailure | undefined> {
return (await locateFailureDiagnostics(root))[0];
}
/**
* The failure job's comment: a job died outside Explore's own progress comments (install, checkout, a crash
* before the pipeline posted), so the sticky comment gets a failed record for that target from the same
* before the pipeline posted), so the sticky comment gets a failed record for each failed target from the same
* renderer every other writer uses. Nothing is posted when the PR is closed; a PR that moved on is marked
* superseded so the failure lands under previous runs.
*/
@@ -94,27 +118,31 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
return { posted: false, reason: "The PR is no longer an open same-repository PR." };
}
const superseded = pr.head?.sha !== options.headSha || pr.base?.sha !== options.baseSha;
const located = options.diagnosticsPath ? await locateFailureDiagnostic(options.diagnosticsPath) : undefined;
const target = requested ?? located?.target;
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
const configPath = options.configPath ?? ".expo-explore/config.yaml";
const now = Date.now();
const diagnostic = located?.diagnostic;
const state: PublicCommentState = {
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
startedAt: now, updatedAt: now, artifactOnly: true,
...(platform ? { build: { platform, easProfile: "" } } : {}),
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
...(superseded ? { superseded: true } : {}),
};
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
...platformSectionMerge(state, target), token, fetchImpl: transport });
const located = options.diagnosticsPath ? await locateFailureDiagnostics(options.diagnosticsPath) : [];
// Each failed target gets its own failed record: since one target's failed capture no longer stops the others'
// reports (brentvatne/euxy#172), several targets of one run can fail in different jobs.
const failures: LocatedFailure[] = requested !== undefined ? [{ ...(located.find(failure => failure.target === requested) ?? located[0]), target: requested }]
: located.length ? located : [{}];
for (const { target, diagnostic } of failures) {
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
const configPath = options.configPath ?? ".expo-explore/config.yaml";
const now = Date.now();
const state: PublicCommentState = {
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
startedAt: now, updatedAt: now, artifactOnly: true,
...(platform ? { build: { platform, easProfile: "" } } : {}),
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
...(superseded ? { superseded: true } : {}),
};
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
...platformSectionMerge(state, target), token, fetchImpl: transport });
}
return { posted: true, ...(superseded ? { superseded: true } : {}) };
}
+25
View File
@@ -0,0 +1,25 @@
/**
* Pauses between attempts of a GitHub lookup that may succeed later, 45 seconds in all. GitHub's Actions API is
* eventually consistent just after an upload: in brentvatne/euxy's review run 39348956443, the duo-closed report job's
* `actions/artifacts/<id>` answered 404 for the artifact that job had just uploaded, while the other four targets'
* jobs found theirs.
*/
const GITHUB_LOOKUP_RETRY_DELAYS_MS = [3_000, 6_000, 12_000, 24_000] as const;
/**
* Runs a read-only GitHub lookup again after each pause while `transient` says its failure may clear on its own. The
* caller decides what is transient; any other failure, or the last one, is thrown as it is.
*/
export async function retryGitHubLookup<T>(lookup: () => Promise<T>, transient: (error: unknown) => boolean,
sleep: (milliseconds: number) => Promise<void> = milliseconds => new Promise<void>(done => setTimeout(done, milliseconds))): Promise<T> {
for (let retry = 0; ; retry += 1) {
try { return await lookup(); }
catch (error) {
const delayMs = GITHUB_LOOKUP_RETRY_DELAYS_MS[retry];
if (delayMs === undefined || !transient(error)) throw error;
// A lookup that succeeds later would otherwise leave no trace of the failure in the job log.
process.stderr.write(`GitHub lookup failed (${(error instanceof Error ? error.message : String(error)).split("\n", 1)[0]}); trying again in ${delayMs / 1000} s\n`);
await sleep(delayMs);
}
}
}
+197 -233
View File
@@ -2,9 +2,10 @@ 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 { neverCapturedSurfaceIds } from "../contracts/surface-capture.js";
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
import type { ReviewPresentation } from "../contracts/review.js";
import type { ViewerLinks } from "./viewer-links.js";
@@ -64,13 +65,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 +109,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 +177,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 +201,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 +227,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 } {
@@ -305,8 +295,10 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
if (state.review) {
const evidenceBased = state.review.surfaces.some(surface => surface.review);
record.changes = [];
// A route the run never captured on purpose is not one of the report's screens, here as in the Viewer.
const omitted = neverCapturedSurfaceIds(state.review);
for (const surface of state.review.surfaces) {
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
if (omitted.has(surface.id)) continue;
const group = groupOf(surface, evidenceBased);
if (group === "unlisted") continue;
const scheme = schemeOf(surface.id);
@@ -316,7 +308,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) {
@@ -359,9 +351,10 @@ function navigationOf(review: PublicReview, groups: Map<string, ChangeGroup>): C
if (!review.navigation) return undefined;
const keyOf = new Map<string, string>();
const groupOf = new Map<string, NavigationGroup>();
const omitted = neverCapturedSurfaceIds(review);
for (const surface of review.surfaces) {
const route = surface.head ?? surface.base;
if (!route || route.kind === "redirect") continue;
if (!route || omitted.has(surface.id)) continue;
const key = routePattern(route);
keyOf.set(surface.id.replace(/@(light|dark)$/, ""), key);
const group = groups.get(surface.id);
@@ -447,214 +440,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 +647,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 +695,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
@@ -759,8 +722,9 @@ export function reviewDevice(state: { runtime?: Pick<SimulatorRuntimeMetadata, "
export function reviewChanges(review: PublicReview): Map<string, ChangeGroup> {
const evidenceBased = review.surfaces.some(surface => surface.review);
const changes = new Map<string, ChangeGroup>();
const omitted = neverCapturedSurfaceIds(review);
for (const surface of review.surfaces) {
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
if (omitted.has(surface.id)) continue;
const group = groupOf(surface, evidenceBased);
if (group !== "unlisted") changes.set(surface.id, group);
}
+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;
+81 -20
View File
@@ -7,6 +7,7 @@ import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from "@zip.j
import { loadReport, MAX_METADATA_BYTES } from "./agent-api.js";
import { MAX_ASSET_BYTES, manifestBody, PREVIEW_ASSET } from "./preview-manifest.js";
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
import { retryGitHubLookup } from "./github-lookup.js";
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
import { isTargetId, warnIgnoredExpiry, type ExplorePlatform } from "../config/explore-config.js";
@@ -54,7 +55,7 @@ export type PreviewDeployOptions = (PreviewReportInput | {
environment?: NodeJS.ProcessEnv;
transport?: typeof fetch;
run?: CommandRunner;
/** Pause between `eas deploy` attempts; tests replace it so retries take no real time. */
/** Pause between `eas deploy` attempts and between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
sleep?: (milliseconds: number) => Promise<void>;
/** The preview export (client/ and server/); defaults to the one shipped in this package. */
exportPath?: string;
@@ -386,7 +387,7 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
if (pr.origin !== "compare") for (const report of reports) {
try {
await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
...commentTarget(report), previewFailed: true });
...commentTarget(report), previewFailed: true, ...(options.sleep ? { sleep: options.sleep } : {}) });
} catch { /* the deployment failure is the one to report */ }
}
throw error;
@@ -398,7 +399,7 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
let headSha = pr.head.sha;
if (pr.origin !== "compare") for (const report of reports) {
const published = await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
...commentTarget(report), preview: { url: previewUrl, expiresAt: null } });
...commentTarget(report), preview: { url: previewUrl, expiresAt: null }, ...(options.sleep ? { sleep: options.sleep } : {}) });
headSha = published.headSha;
}
return { previewUrl, expiresAt: null, deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
@@ -435,7 +436,9 @@ async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: C
}
type HostedReportInput = { zip: Uint8Array; sha256: string; file: string; query: string };
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string; project: string; owner: string };
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string;
/** The link is the alias, which still served an earlier deployment when the wait for it ran out. */
aliasBehind?: true; project: string; owner: string };
/** EAS Hosting alias names: lowercase slugs, as `eas deploy --alias` normalises them. */
export const HOSTING_ALIAS = /^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$/;
@@ -495,6 +498,13 @@ async function deployReports(options: {
alias?: string;
/** A caller-chosen `/p/<token>`; with `alias`, the hosted link is identical from one run to the next. */
token?: string;
/** How long the alias has to serve this deployment once the deployment does; `verifyTimeoutMs` by default. */
aliasWaitMs?: number;
/**
* Link the alias even when it still serves an earlier deployment after `aliasWaitMs`, for a link whose readers are
* told it can lag, rather than the deployment's own host.
*/
linkBehindAlias?: boolean;
sleep?: (milliseconds: number) => Promise<void>;
}): Promise<HostedDeployment> {
const { reports, project, environment, run, transport, now, random } = options;
@@ -571,7 +581,8 @@ async function deployReports(options: {
throw deployError("PREVIEW_DEPLOY_FAILED", `EAS Hosting deployed ${deploymentUrl.origin} but did not report the alias ${options.alias}.`,
"Check the deployment's aliases in the EAS Hosting dashboard and rerun.", { retryable: true, details: { project, owner, alias: options.alias } });
}
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, timeoutMs: options.verifyTimeoutMs, alias,
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, alias,
timeoutMs: alias ? options.aliasWaitMs ?? options.verifyTimeoutMs : options.verifyTimeoutMs,
reports: reports.map((report, index) => ({ query: report.query, ...written[index]! })),
...(listing ? { listing: JSON.stringify(listing.map(({ path: _path, ...rest }) => rest)) } : {}) });
const seconds = (milliseconds: number) => `${Math.round(milliseconds / 1000)} s after eas deploy returned`;
@@ -581,7 +592,9 @@ async function deployReports(options: {
// taken longer than the whole budget (every verification failure of 2026-10-14 was the alias, with the deployment
// serving in 1 s). The deployment is verified and immutable, so when the alias is still behind the pull request
// links the deployment instead of failing the job; the alias catches up on its own and the next push relinks it.
// With `linkBehindAlias` it links the alias anyway, and its readers are told the link can lag.
let linkOrigin = deploymentUrl.origin;
let aliasBehind = false;
if (aliasUrl) {
try {
const alias = await verify(aliasUrl.origin, true);
@@ -589,12 +602,16 @@ async function deployReports(options: {
linkOrigin = aliasUrl.origin;
} catch (error) {
if ((error as { code?: string }).code !== "PREVIEW_ALIAS_BEHIND") throw error;
process.stderr.write(`::warning::${(error as Error).message} The pull request links the deployment ${deploymentUrl.origin} instead.\n`);
aliasBehind = Boolean(options.linkBehindAlias);
if (aliasBehind) linkOrigin = aliasUrl.origin;
process.stderr.write(`::warning::${(error as Error).message} ${aliasBehind
? `The pull request links it anyway, until it catches up, beside the deployment ${deploymentUrl.origin}.`
: `The pull request links the deployment ${deploymentUrl.origin} instead.`}\n`);
}
}
const previewUrl = `${linkOrigin}/p/${token}`;
return { previewUrl, expiresAt: null, deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), project, owner };
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), ...(aliasBehind ? { aliasBehind: true as const } : {}), project, owner };
} finally {
await rm(work, { recursive: true, force: true });
}
@@ -668,8 +685,20 @@ export type FixturePreviewOptions = {
random?: (bytes: number) => Uint8Array;
onSecret?: (secret: string) => void;
verifyTimeoutMs?: number;
/** How long the alias has to serve the new deployment before the link is the alias anyway; FIXTURE_ALIAS_WAIT_MS by default. */
aliasWaitMs?: number;
};
/**
* How long a fixture preview waits for its alias. An edge of EAS Hosting that served an alias keeps serving the
* deployment it named for about five minutes (307–314 s, measured 2026-10-19 redeploying back to back from one machine),
* so a deploy whose check reaches an edge that served the alias in the last five minutes, to the previous deploy's check
* or to a reviewer, finds it behind; otherwise it has moved within seconds. Waiting the whole verification budget for
* that held a third of the pull requests' deploy jobs for three minutes, only to link the deployment instead. The pull
* request's comment says when the alias is behind.
*/
export const FIXTURE_ALIAS_WAIT_MS = 20_000;
/**
* Host fixed reports behind a fixed alias with this checkout's Viewer: the Explore repository's own pull requests
* preview their Viewer changes on real data. No GitHub token, no expiry; each run replaces what the alias serves.
@@ -697,6 +726,7 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
projectHint: "Give EXPO_TOKEN's account permission to create projects, or pass --project with an existing slug.",
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000, alias: options.alias,
aliasWaitMs: options.aliasWaitMs ?? FIXTURE_ALIAS_WAIT_MS, linkBehindAlias: true,
...(options.token ? { token: options.token } : {}) });
}
@@ -760,23 +790,43 @@ export async function deployLocalReports(options: {
/** explore-(capture|review)-<run>-<attempt>-<target id>; the id starts with a letter, so the run and attempt end unambiguously. */
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
/**
* The target a lone artifact holds. actions/download-artifact puts each artifact a pattern matches in a directory named
* after it, except when the pattern matches exactly one, which it extracts into the download path itself: then only the
* report names its target (its platform for configs without targets).
*/
async function unnamedArtifactTarget(root: string, kind: "capture" | "review"): Promise<string | undefined> {
const file = join(root, kind === "capture" ? "report-input.json" : "review.json");
if (!(await lstat(file).catch(() => undefined))?.isFile()) return undefined;
const runtime = kind === "capture" ? (await readCiReportInput(file)).publicReview.runtime
: (JSON.parse(await readFile(file, "utf8")) as Partial<ArtifactReport>).review?.runtime;
const id = readTarget(runtime?.target)?.id ?? runtime?.platform;
return isTargetId(id) ? id : undefined;
}
/**
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<target>
* directory under --inputs and each explore-review-… directory under --reports (the target is the platform for
* configs without targets). Pairs them by target, in the order the run's review lists its targets, and looks up each
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward. A target whose capture
* failed uploaded no capture artifact, and one whose report job failed no report artifact: the preview serves the
* targets that have both, and the review workflow's failure job names the others on the comment.
*/
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch }): Promise<PreviewReportInput[]> {
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
/** Pause between artifact lookups that may succeed later; tests replace it so retries take no real time. */
sleep?: (milliseconds: number) => Promise<void> }): Promise<PreviewReportInput[]> {
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
const directories = async (root: string, kind: "capture" | "review") => {
const found = new Map<string, string>();
for (const name of (await readdir(root)).sort()) {
// A pattern that matched nothing leaves no directory behind.
for (const name of (await readdir(root).catch(() => [] as string[])).sort()) {
const match = ARTIFACT_DIRECTORY.exec(name);
if (!match || match[1] !== kind || !isTargetId(match[2])) continue;
if (found.has(match[2]!)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
found.set(match[2]!, join(root, name));
}
if (!found.size) { const id = await unnamedArtifactTarget(root, kind); if (id) found.set(id, root); }
return found;
};
const inputs = await directories(options.inputsPath, "capture"); const reports = await directories(options.reportsPath, "review");
@@ -787,8 +837,9 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
const entries: PreviewReportInput[] = [];
for (const [id, inputDirectory] of inputs) {
const reportPath = reports.get(id);
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${id} capture has no report artifact to deploy`,
"Rerun the workflow; the report job for that target did not upload its explore-review artifact.");
// In brentvatne/euxy#172 (review run 39348956443) one target's failed job kept every other target's report off the
// PR; a target without a report is left out of the preview instead.
if (!reportPath) { process.stderr.write(`The ${id} capture has no report artifact (its report job failed), so the preview leaves it out.\n`); continue; }
const inputPath = join(inputDirectory, "report-input.json");
const runtime = (await readCiReportInput(inputPath)).publicReview.runtime;
// A report from before targets names only its platform, and its artifact is named after it.
@@ -798,6 +849,8 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
const target = named ?? (id === "ios" || id === "android" ? platformTarget(id) : { id, platform: runtime.platform ?? "ios", label: id });
entries.push({ ...(id === target.platform ? { platform: target.platform } : {}), target, inputPath, reportPath, artifactUrl: "" });
}
if (!entries.length) throw previewError("PREVIEW_REPORTS_INCOMPLETE", "No target's capture has a report artifact to deploy",
"Rerun the workflow; the report jobs did not upload their explore-review artifacts.");
// Config order, as the review lists its targets (or, before targets, its platforms); directory order otherwise.
const listed = (await readCiReportInput(entries[0]!.inputPath)).publicReview.runtime;
const order: string[] = listed.targets?.map(target => target.id) ?? listed.platforms ?? [];
@@ -812,14 +865,22 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
for (const entry of entries) {
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.target!.id}`;
const url = `https://api.github.com/repos/${repository}/actions/runs/${review.runId}/artifacts?per_page=100&name=${encodeURIComponent(name)}`;
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
const body = response.ok ? await response.json() as { artifacts?: Array<{ id?: unknown; name?: unknown; expired?: unknown }> } : undefined;
const artifact = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
if (!artifact || typeof artifact.id !== "number" || !Number.isSafeInteger(artifact.id) || artifact.id <= 0) {
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true });
}
// The run's artifact list can lag an upload, as the artifact lookup of a report job's publication does, so an
// empty list, a 404, a 5xx or no answer is looked up again; a bad token or a missing permission fails at once.
const artifact = await retryGitHubLookup(async () => {
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
const body = response.ok ? await response.json() as { artifacts?: Array<{ id?: unknown; name?: unknown; expired?: unknown }> } : undefined;
const found = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
if (!found || typeof found.id !== "number" || !Number.isSafeInteger(found.id) || found.id <= 0) {
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true, details: { status: response.status } });
}
return found;
}, error => {
const status = error instanceof CiError ? error.details?.status : undefined;
return !(error instanceof CiError) || typeof status === "number" && (status === 200 || status === 404 || status >= 500);
}, options.sleep);
entry.artifactUrl = `https://github.com/${repository}/actions/runs/${review.runId}/artifacts/${artifact.id}`;
}
return entries;
+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}`);
}
+7 -1
View File
@@ -148,6 +148,12 @@ export async function reportCiError(error: unknown, options: {
env?: NodeJS.ProcessEnv;
secrets?: readonly string[];
diagnosticsPath?: string;
/**
* The matrix target the failed command ran for, written into the diagnostics file. actions/download-artifact puts an
* artifact in a directory named after it only when a pattern matches several, so the failure job cannot always read
* the target from where the file lands.
*/
target?: string;
write?: (value: string) => void;
} = {}): Promise<CiErrorData> {
const env = options.env ?? process.env;
@@ -166,7 +172,7 @@ export async function reportCiError(error: unknown, options: {
if (env.GITHUB_STEP_SUMMARY) outputs.push({ label: "job summary", operation: appendFile(env.GITHUB_STEP_SUMMARY, `${renderCiErrorSummary(error, renderOptions)}\n`) });
if (options.diagnosticsPath) outputs.push({ label: "diagnostics file", operation: (async () => {
await mkdir(dirname(options.diagnosticsPath!), { recursive: true });
await writeFile(options.diagnosticsPath!, `${JSON.stringify(diagnostic, null, 2)}\n`);
await writeFile(options.diagnosticsPath!, `${JSON.stringify(options.target ? { ...diagnostic, target: options.target } : diagnostic, null, 2)}\n`);
})() });
const results = await Promise.allSettled(outputs.map(output => output.operation));
for (const [index, result] of results.entries()) {
+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)) {
+38 -14
View File
@@ -1,33 +1,57 @@
import { posix } from "node:path";
import ts from "typescript";
/** The `@/*` import alias a tsconfig maps to one project directory, such as `src/` or the root. */
/** The import aliases a tsconfig maps to project directories, such as `@/*` to `src/` and `@/assets/*` to `assets/`. */
export type TsconfigAlias = {
/** Directory prefix that replaces `@/`, with a trailing slash or empty for the project root. */
target: string;
/** Each alias prefix (`@/`, `@/assets/`) and the directory prefix that replaces it, longest prefix first. */
prefixes: readonly { prefix: string; target: string }[];
/** `baseUrl` is the project root: a bare specifier no alias matches is looked up there before it is taken for a package. */
baseUrl?: true;
/** Set when the tsconfig asks for module resolution the static analysis cannot follow. */
unsupported?: string;
};
const SINGLE_DIRECTORY_TARGET = /^(?:\.\/)?((?:[\w.-]+\/)*)\*$/;
// A relative-looking key (`./*`, `/*`) is never applied: TypeScript and Metro resolve relative specifiers directly.
const PREFIX_KEY = /^([^*./][^*]*\/)\*$/;
const DEFAULT: TsconfigAlias = { prefixes: [{ prefix: "@/", target: "src/" }] };
/**
* Static analysis follows one alias, `@/*`, pointing at a single directory (`./*`, `src/*`, `./src/*`),
* which is what create-expo-app and the Expo docs set up. Anything else is reported, not guessed.
* Static analysis follows `paths` entries of the form `prefix/*` that each point at a single directory (`./*`, `src/*`,
* `./assets/*`), which covers create-expo-app's `@/*` and the extra entries apps add beside it. Anything else is
* reported, not guessed.
*/
export function readTsconfigAlias(configText: string | undefined): TsconfigAlias {
if (configText === undefined) return { target: "src/" };
if (configText === undefined) return DEFAULT;
const parsed = ts.parseConfigFileTextToJson("tsconfig.json", configText);
const options = parsed.config?.compilerOptions ?? {};
const unsupported = { target: "src/", unsupported: "custom module resolution is not statically supported" };
const unsupported = { ...DEFAULT, unsupported: "custom module resolution is not statically supported" };
if (parsed.error) return unsupported;
if (options.baseUrl && ![".", "./"].includes(options.baseUrl)) return unsupported;
if (parsed.config?.extends && parsed.config.extends !== "expo/tsconfig.base") return unsupported;
const baseUrl = options.baseUrl ? { baseUrl: true as const } : {};
const entries = Object.entries(options.paths ?? {}) as [string, unknown][];
if (entries.length === 0) return { target: "src/" };
if (entries.length > 1 || entries[0]![0] !== "@/*") return unsupported;
const targets = entries[0]![1];
if (!Array.isArray(targets) || targets.length !== 1 || typeof targets[0] !== "string") return unsupported;
const match = SINGLE_DIRECTORY_TARGET.exec(targets[0]);
if (!match || match[1]!.split("/").includes("..")) return unsupported;
return { target: match[1]! };
if (entries.length === 0) return { ...DEFAULT, ...baseUrl };
const prefixes: { prefix: string; target: string }[] = [];
for (const [key, targets] of entries) {
const prefix = PREFIX_KEY.exec(key)?.[1];
if (!prefix || !Array.isArray(targets) || targets.length !== 1 || typeof targets[0] !== "string") return unsupported;
const match = SINGLE_DIRECTORY_TARGET.exec(targets[0]);
if (!match || match[1]!.split("/").some(segment => segment === "." || segment === "..")) return unsupported;
prefixes.push({ prefix, target: match[1]! });
}
// TypeScript picks the pattern with the longest prefix, so `@/assets/x` goes to `assets/`, not `src/assets/`.
return { prefixes: prefixes.sort((a, b) => b.prefix.length - a.prefix.length), ...baseUrl };
}
/** The project path an aliased specifier names, before extensions, or undefined when no alias matches it. */
export function resolveTsconfigAlias(alias: TsconfigAlias, specifier: string): string | undefined {
const entry = alias.prefixes.find(({ prefix }) => specifier.startsWith(prefix));
// Normalized as Metro joins it: `@app/a/../b` is `src/b`, and a trailing slash still finds `index`.
return entry ? posix.normalize(`${entry.target}${specifier.slice(entry.prefix.length)}`).replace(/\/$/, "") : undefined;
}
/** The project path a bare specifier names under a root `baseUrl`, or undefined; a miss there is a package, not a gap. */
export function resolveTsconfigBaseUrl(alias: TsconfigAlias, specifier: string): string | undefined {
return alias.baseUrl && !/^[./]/.test(specifier) ? specifier : undefined;
}
+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;
+9 -7
View File
@@ -3,7 +3,7 @@ import { spawnSync } from "node:child_process";
import ts from "typescript";
import type { SourceChange } from "./git-diff.js";
import { validateSourceRoutes, type SourceRoute } from "../contracts/source-route.js";
import { readTsconfigAlias } from "../shared/tsconfig-alias.js";
import { readTsconfigAlias, resolveTsconfigAlias, resolveTsconfigBaseUrl } from "../shared/tsconfig-alias.js";
/** Repository path → file text at one exact commit. Non-source files carry an empty string. */
export type SourceSnapshot = ReadonlyMap<string, string>;
@@ -50,11 +50,12 @@ export function surfaceDependencies(routes: readonly SourceRoute[], files: Sourc
if (alias.unsupported) unresolved.add("Custom TypeScript module resolution requires conservative capture");
const cache = new Map<string, string[]>();
const resolveModule = (importer: string, specifier: string): string | undefined => {
const base = specifier.startsWith("@/") ? `${alias.target}${specifier.slice(2)}`
: specifier.startsWith(".") ? posix.normalize(posix.join(posix.dirname(importer), specifier))
: undefined;
const base = resolveTsconfigAlias(alias, specifier)
?? (specifier.startsWith(".") ? posix.normalize(posix.join(posix.dirname(importer), specifier))
: resolveTsconfigBaseUrl(alias, specifier));
if (!base) return undefined;
const extensions = ["tsx", "ts", "jsx", "js"].flatMap(ext => [`.${platform}.${ext}`, ...(platform === "web" ? [] : [`.native.${ext}`]), `.${ext}`]).concat([".mjs", ".cjs", ".json"]);
// Metro tries a platform suffix with every extension before the next suffix, so `Foo.ios.ts` beats `Foo.tsx`.
const extensions = [`.${platform}`, ...(platform === "web" ? [] : [".native"]), ""].flatMap(suffix => ["tsx", "ts", "jsx", "js"].map(ext => `${suffix}.${ext}`)).concat([".mjs", ".cjs", ".json"]);
return [...extensions.map((ext) => base + ext), base,
...extensions.map((ext) => `${base}/index${ext}`)].find((candidate) => !/(?:^|\/)surfaces?\.json$/.test(candidate) && files.has(candidate));
};
@@ -78,7 +79,8 @@ export function surfaceDependencies(routes: readonly SourceRoute[], files: Sourc
const specifier = node.text;
const resolved = resolveModule(path, specifier);
if (resolved) dependencies.push(resolved);
else if (specifier.startsWith(".") || specifier.startsWith("@/") || specifier.startsWith("~")) {
// An alias that matches but finds no file (an .svg, a scale variant) is local code this analysis cannot follow, not a package.
else if (specifier.startsWith(".") || resolveTsconfigAlias(alias, specifier) !== undefined || specifier.startsWith("@/") || specifier.startsWith("~")) {
unresolved.add(`Unresolved runtime import: ${path} -> ${specifier}`);
}
// Bare npm packages are covered by lockfile/package changes.
@@ -103,7 +105,7 @@ export function surfaceDependencies(routes: readonly SourceRoute[], files: Sourc
const pending = [surface.routeFile, ...surface.sourceFiles];
let directory = posix.dirname(surface.routeFile);
while (directory !== "." && directory !== "/") {
const suffixes = ["tsx", "ts", "jsx", "js"].flatMap(extension => [`.${platform}.${extension}`, ...(platform === "web" ? [] : [`.native.${extension}`]), `.${extension}`]);
const suffixes = [`.${platform}`, ...(platform === "web" ? [] : [".native"]), ""].flatMap(suffix => ["tsx", "ts", "jsx", "js"].map(ext => `${suffix}.${ext}`));
const layout = suffixes.map(suffix => `${directory}/_layout${suffix}`).find(path => files.has(path));
if (layout) pending.push(layout);
directory = posix.dirname(directory);
+5 -5
View File
@@ -1,7 +1,7 @@
import { posix } from "node:path";
import ts from "typescript";
import type { SourceSnapshot } from "./dependency-graph.js";
import { readTsconfigAlias } from "../shared/tsconfig-alias.js";
import { readTsconfigAlias, resolveTsconfigAlias, resolveTsconfigBaseUrl } from "../shared/tsconfig-alias.js";
import { detectAppDir, routeGroupOf } from "./route-providers/expo-router.js";
import { validateSourceRoutes, type SourceRoute } from "../contracts/source-route.js";
import { validateNavigationGraph, type NavigationEdge, type NavigationGraph } from "../contracts/navigation-graph.js";
@@ -54,7 +54,7 @@ export function extractSourceNavigation(routes: readonly SourceRoute[], files: S
if (routes.length > 5_000 || files.size > 50_000) throw new Error("Source navigation inventory exceeds its analysis limit");
const appDir = detectAppDir(files, analysis.entry);
const platform = analysis.platform ?? "ios";
const extensions = ["tsx", "ts", "jsx", "js"].flatMap(extension => [`.${platform}.${extension}`, ...(platform === "web" ? [] : [`.native.${extension}`]), `.${extension}`]).concat([".mjs", ".cjs"]);
const extensions = [`.${platform}`, ...(platform === "web" ? [] : [".native"]), ""].flatMap(suffix => ["tsx", "ts", "jsx", "js"].map(ext => `${suffix}.${ext}`)).concat([".mjs", ".cjs"]);
const unresolved = new Set<string>();
const edges = new Map<string, NavigationEdge>();
const modalSurfaceIds = new Set<string>();
@@ -65,8 +65,8 @@ export function extractSourceNavigation(routes: readonly SourceRoute[], files: S
const alias = readTsconfigAlias(files.get("tsconfig.json"));
if (alias.unsupported) unresolved.add(`Unresolved navigation: tsconfig.json: ${alias.unsupported}`);
const resolveModule = (specifier: string, importer: string): string | undefined => {
const base = specifier.startsWith("@/") ? `${alias.target}${specifier.slice(2)}`
: specifier.startsWith(".") ? posix.normalize(posix.join(posix.dirname(importer.replace(/^\//, "")), specifier)) : undefined;
const base = resolveTsconfigAlias(alias, specifier)
?? (specifier.startsWith(".") ? posix.normalize(posix.join(posix.dirname(importer.replace(/^\//, "")), specifier)) : resolveTsconfigBaseUrl(alias, specifier));
if (!base || base.startsWith("../")) return undefined;
const withoutJs = /\.[cm]?jsx?$/.test(base) ? base.replace(/\.[cm]?jsx?$/, "") : base;
return [...extensions.map((ext) => base + ext), base,
@@ -542,7 +542,7 @@ export function extractSourceNavigation(routes: readonly SourceRoute[], files: S
let parent: ts.Node = declaration;
while (!ts.isImportDeclaration(parent) && !ts.isSourceFile(parent)) parent = parent.parent;
if (ts.isImportDeclaration(parent) && ts.isStringLiteral(parent.moduleSpecifier)
&& /^(?:\.|@\/|~)/.test(parent.moduleSpecifier.text)
&& (/^(?:\.|@\/|~)/.test(parent.moduleSpecifier.text) || resolveTsconfigAlias(alias, parent.moduleSpecifier.text) !== undefined)
&& !assetFile.test(parent.moduleSpecifier.text)
&& !resolveModule(parent.moduleSpecifier.text, parent.getSourceFile().fileName)) issue(parent, "local imported code could not be resolved");
}
+4 -4
View File
@@ -1,6 +1,6 @@
import { posix } from "node:path";
import ts from "typescript";
import { readTsconfigAlias } from "../../shared/tsconfig-alias.js";
import { readTsconfigAlias, resolveTsconfigAlias, resolveTsconfigBaseUrl } from "../../shared/tsconfig-alias.js";
const UNKNOWN = "\u0000";
const MAX_VALUES = 64;
@@ -15,7 +15,7 @@ function unwrap(node: ts.Node): ts.Node {
/** Prove that every render path forwards elsewhere; unknown behavior remains capturable. */
export function expoRedirectTargets(files: ReadonlyMap<string, string>, routeFiles: readonly string[], platform = "ios"): Map<string, string[]> {
const extensions = ["tsx", "ts", "jsx", "js"].flatMap(ext => [`.${platform}.${ext}`, ...(platform === "web" ? [] : [`.native.${ext}`]), `.${ext}`]).concat([".mjs", ".cjs"]);
const extensions = [`.${platform}`, ...(platform === "web" ? [] : [".native"]), ""].flatMap(suffix => ["tsx", "ts", "jsx", "js"].map(ext => `${suffix}.${ext}`)).concat([".mjs", ".cjs"]);
const sources = new Map<string, ts.SourceFile | undefined>();
let sourceBytes = 0;
const sourceFile = (name: string): ts.SourceFile | undefined => {
@@ -34,8 +34,8 @@ export function expoRedirectTargets(files: ReadonlyMap<string, string>, routeFil
};
const alias = readTsconfigAlias(files.get("tsconfig.json"));
const resolveModule = (specifier: string, importer: string): string | undefined => {
const base = specifier.startsWith("@/") && !alias.unsupported ? `${alias.target}${specifier.slice(2)}`
: specifier.startsWith(".") ? posix.normalize(posix.join(posix.dirname(importer.replace(/^\//, "")), specifier)) : undefined;
const base = (alias.unsupported ? undefined : resolveTsconfigAlias(alias, specifier))
?? (specifier.startsWith(".") ? posix.normalize(posix.join(posix.dirname(importer.replace(/^\//, "")), specifier)) : alias.unsupported ? undefined : resolveTsconfigBaseUrl(alias, specifier));
if (!base || base.startsWith("../")) return undefined;
const withoutJs = base.replace(/\.[cm]?jsx?$/, "");
return [...extensions.map(ext => base + ext), base, ...extensions.map(ext => `${base}/index${ext}`),
@@ -45,6 +45,8 @@ export function discoverReactNavigation(files: Record<string, string>, options:
}
}
}
// TypeScript uses the pattern with the longest prefix and no other, so `@/assets/x` never falls back to `@/*`.
aliases.sort((a, b) => b.pattern.split("*")[0]!.length - a.pattern.split("*")[0]!.length);
const resolveModule = (file: string, specifier: string): string | undefined => {
const bases: string[] = [];
if (specifier.startsWith(".")) bases.push(posix.normalize(posix.join(posix.dirname(file), specifier)));
@@ -54,6 +56,7 @@ export function discoverReactNavigation(files: Record<string, string>, options:
if (suffix === undefined ? specifier === prefix : specifier.startsWith(prefix!) && specifier.endsWith(suffix)) {
const replacement = suffix === undefined ? "" : specifier.slice(prefix!.length, specifier.length - suffix.length);
bases.push(...alias.targets.map((target) => posix.normalize(posix.join(alias.base, target.replace("*", replacement)))));
break;
}
}
}
+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
+39 -9
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
@@ -215,8 +219,12 @@ jobs:
${{ runner.temp }}/explore-review/agent-usage.jsonl
retention-days: 7
if-no-files-found: ignore
# Each target's report runs once its own capture uploaded one, whatever the other targets' captures did, as in the
# review workflow (brentvatne/euxy#172): needs.capture.result is the whole matrix's, so each leg looks for its own
# artifact, and a target whose capture failed packages and links nothing. !cancelled() keeps a cancelled run stopped.
report:
needs: [targets, capture]
if: needs.targets.result == 'success' && !cancelled()
strategy:
fail-fast: false
matrix:
@@ -225,19 +233,34 @@ jobs:
timeout-minutes: 20
permissions:
contents: read
outputs:
# "true" from every leg that linked its report, so "true" once any did: the deploy job runs only then.
published: ${{ steps.publish.outputs.published }}
env:
TARGET: ${{ matrix.target }}
steps:
# Downloading by name fails when the artifact is missing. A pattern that matches nothing downloads nothing and
# succeeds, so only a download that went wrong fails this step; its one match is extracted into the path itself.
- name: Download this target's captured review
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Check that this target's capture succeeded
id: captured
shell: bash
run: |
set -euo pipefail
if [[ -f "$RUNNER_TEMP/explore-review/report-input.json" ]]; then echo "found=true" >> "$GITHUB_OUTPUT"
else echo "The $TARGET capture uploaded no review: its capture job failed."; fi
- *setup-node
- *install-explore
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Package the report
if: steps.captured.outputs.found == 'true'
shell: bash
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --target "$TARGET"
- name: Upload the report
if: steps.captured.outputs.found == 'true'
id: report
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
@@ -246,10 +269,15 @@ jobs:
retention-days: 30
if-no-files-found: error
- name: Link the report from the run summary
if: steps.captured.outputs.found == 'true'
id: publish
env:
ARTIFACT_URL: ${{ steps.report.outputs.artifact-url }}
shell: bash
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
run: |
set -euo pipefail
node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
echo "published=true" >> "$GITHUB_OUTPUT"
- name: Upload report failure diagnostics
if: always()
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
@@ -260,9 +288,10 @@ jobs:
if-no-files-found: ignore
# Hosted report (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment serving every target's report.
# This is the only job after capture that holds EXPO_TOKEN; it writes the link to the run summary.
# It runs once any target linked its report, and serves the targets that did; a failed target has no report to wait for.
deploy:
needs: [targets, capture, report]
if: needs.capture.outputs.preview == 'eas'
if: needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()
runs-on: ubuntu-22.04
timeout-minutes: 20
permissions:
@@ -271,7 +300,8 @@ jobs:
steps:
- *setup-node
- *install-explore
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>),
# or a lone artifact's files in the path itself; ci:deploy reads both.
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
+43 -11
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
@@ -203,8 +207,14 @@ jobs:
${{ runner.temp }}/explore-review/agent-usage.jsonl
retention-days: 7
if-no-files-found: ignore
# Each target's report runs once its own capture uploaded one, whatever the other targets' captures did: in
# brentvatne/euxy#172 (run 39348956443) one flaky simulator session failed one of five captures, and with the report
# waiting on every capture the PR got no report at all. needs.capture.result is the whole matrix's, so each leg looks
# for its own artifact instead; a target whose capture failed uploaded none, packages and publishes nothing here, and
# is named by the failure job. !cancelled() lets the legs run after a failed capture leg, but not in a cancelled run.
report:
needs: [targets, capture]
if: needs.targets.result == 'success' && !cancelled()
strategy:
fail-fast: false
matrix:
@@ -215,19 +225,34 @@ jobs:
contents: read
actions: read
pull-requests: write
outputs:
# "true" from every leg that published, so "true" once any did: the deploy job runs only then.
published: ${{ steps.publish.outputs.published }}
env:
TARGET: ${{ matrix.target }}
steps:
# Downloading by name fails when the artifact is missing. A pattern that matches nothing downloads nothing and
# succeeds, so only a download that went wrong fails this step; its one match is extracted into the path itself.
- name: Download this target's captured review
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Check that this target's capture succeeded
id: captured
shell: bash
run: |
set -euo pipefail
if [[ -f "$RUNNER_TEMP/explore-review/report-input.json" ]]; then echo "found=true" >> "$GITHUB_OUTPUT"
else echo "The $TARGET capture uploaded no review: its capture job failed, and the failure job reports it."; fi
- *setup-node
- *install-explore
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Package hosted review bundle
if: steps.captured.outputs.found == 'true'
shell: bash
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --target "$TARGET"
- name: Upload hosted review bundle
if: steps.captured.outputs.found == 'true'
id: viewer
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
@@ -236,11 +261,16 @@ jobs:
retention-days: 30
if-no-files-found: error
- name: Publish current PR hosted links
if: steps.captured.outputs.found == 'true'
id: publish
env:
GITHUB_TOKEN: ${{ github.token }}
ARTIFACT_URL: ${{ steps.viewer.outputs.artifact-url }}
shell: bash
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
run: |
set -euo pipefail
node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
echo "published=true" >> "$GITHUB_OUTPUT"
- name: Upload report failure diagnostics
if: always()
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
@@ -252,9 +282,10 @@ jobs:
# Hosted preview (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment per review, serving every target's report.
# This is the only job after capture that holds EXPO_TOKEN; the report job stays credential-free and has already
# published the Download report link, so a failed deployment leaves the comment on the download-and-drop flow.
# It runs once any target published its report, and serves the targets that did; a failed target has no report to wait for.
deploy:
needs: [targets, capture, report]
if: needs.capture.outputs.preview == 'eas'
if: needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()
runs-on: ubuntu-22.04
timeout-minutes: 20
permissions:
@@ -264,7 +295,8 @@ jobs:
steps:
- *setup-node
- *install-explore
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>),
# or a lone artifact's files in the path itself; ci:deploy reads both.
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
@@ -313,6 +345,6 @@ jobs:
shell: bash
run: |
set -euo pipefail
# The diagnostics artifacts are data files from this run and attempt, never executable report code;
# the first error.json names the failed target, and the comment keeps every other target's result.
# The diagnostics artifacts are data files from this run and attempt, never executable report code; each
# error.json names its failed target, which gets a failed record, and the comment keeps every other target's result.
node "$TOOLS/dist/cli.js" ci:failure --pr "${PR_NUMBER:-0}" --head "${HEAD_SHA:-}" --base "${BASE_SHA:-}" --diagnostics "$RUNNER_TEMP/explore-failure"
File diff suppressed because it is too large. Load diff
@@ -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");
+53 -5
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');
@@ -234,6 +242,14 @@ test("Compare steps through changed screens and their changed areas", { timeout:
await expect(outlines.nth(1)).toHaveClass(/active/);
await page.keyboard.press("k");
await expect(outlines.nth(0)).toHaveClass(/active/);
// Esc in the bottom bar's More menu closes the menu and only the menu.
const more = page.getByRole("button", { name: "More", exact: true });
await more.click();
await expect(page.getByRole("menu", { name: "More" })).toBeVisible();
await page.keyboard.press("Escape");
await expect(page.getByRole("menu", { name: "More" })).toHaveCount(0);
await expect(more).toBeFocused();
await expect(outlines.nth(0)).toHaveClass(/active/);
await page.keyboard.press("Escape");
await expect(compare.locator(".visual-change-outline.active")).toHaveCount(0);
@@ -302,7 +318,7 @@ test("Compare steps through changed screens and their changed areas", { timeout:
/** The Inspector's one frame for a screen outside the review, and its Swipe frame for a changed one, in this viewport. */
async function inspectorFrames(page, url) {
const games = "expo-tabs-games-index-2c6605360b11";
const index = "expo-index-02872ff9f2ca";
const unchanged = "expo-tabs-scan-index-2bbf42237cc6";
const open = async id => {
await page.goto(`${url}#/screens`);
const all = page.getByRole("button", { name: /^All/ }).first();
@@ -317,14 +333,14 @@ async function inspectorFrames(page, url) {
const swipeImage = page.locator(".sidebar-review-stage img").first();
await expect(swipeImage).toBeVisible();
const changed = await swipeImage.boundingBox();
await open(index);
await open(unchanged);
const single = page.locator(".sidebar-review-off .variant-preview");
await expect(single).toBeVisible();
return { changed, single: await single.boundingBox() };
}
test("the Inspector frames an unchanged screen at the size of a changed screen's Swipe frame", { timeout: 90_000 }, async t => {
// / is unchanged (not compared); /games is modified. The single frame used to take at most half the panel, the
// /scan is unchanged; /games is modified. The single frame used to take at most half the panel, the
// width of one frame of a Before/After pair, while Swipe and Flip fill the panel up to 70 % (phone: 52 %) of the window.
for (const viewport of [{ width: 1024, height: 820 }, { width: 390, height: 844 }]) {
const { page, url, errors } = await openReport(t, viewport);
@@ -416,6 +432,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()),
+295 -4
View File
@@ -35,12 +35,21 @@ 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 = `
import { useEffect, useState } from "react";
import { createRoot } from "react-dom/client";
import { ScreenshotImage } from "/src/components/shared/screenshot-image.tsx";
// The Viewer's own rules hide a waiting screenshot and fade a ready one in.
if (window.fixture.styles) await import("/src/styles.css");
function Harness() {
const [state, setState] = useState(window.fixture);
@@ -59,14 +68,18 @@ function Harness() {
return <main style={{ position: "relative", height: state.layout === "scroll" ? 3300 : 300,
width: 600, overflow: state.layout === "pan" ? "hidden" : undefined }}>
{state.normalSource && <ScreenshotImage src={state.normalSource} alt="Hosted screenshot"
width={24} height={18} decoding="async" onLoad={loaded} />}
width={24} height={18} decoding="async" onLoad={loaded} {...(state.holdPrevious ? { holdPrevious: true } : {})}
{...(state.fallback ? { fallback: <span data-testid="hosted-fallback">No hosted screenshot</span> } : {})} />}
<div data-testid="positioner" style={{ position: "absolute", left: 20,
top: state.layout === "scroll" ? 3000 : 30,
transform: state.layout === "pan" ? "translateX(2500px)" : undefined }}>
transform: state.layout === "pan" ? "translateX(2500px)" : undefined }}
{...(state.instant ? { "data-screenshot-instant": "" } : {})}
{...(state.thumbnail ? { className: "variant-thumbnail", "aria-selected": "false" } : {})}>
{state.mounted !== false && <ScreenshotImage src={state.source} alt="Captured checkout"
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>;
@@ -98,6 +111,18 @@ async function fixture(t, options = {}) {
response.end(firstImage);
return;
}
// A hosted screenshot that is not there.
if (request.url === "/__missing.png") {
response.statusCode = 404;
response.end("Not found");
return;
}
// A hosted screenshot that takes a while to arrive.
if (request.url === "/__slow.png") {
response.setHeader("Content-Type", "image/png");
setTimeout(() => response.end(secondImage), 600);
return;
}
if (request.url !== "/") return next();
response.setHeader("Content-Type", "text/html");
response.end('<!doctype html><html><head><style>body{margin:0}</style></head><body><div id="root"></div><script type="module" src="/__screenshot_image.tsx"></script></body></html>');
@@ -121,6 +146,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.
@@ -153,7 +180,15 @@ async function fixture(t, options = {}) {
window.pendingScreenshots.delete(source);
for (const { reject } of pending) reject(new Error("Screenshot resolution failed"));
};
if (fixture.decode === "manual") {
// The test settles each decode; one it never settles stands in for a decode that hangs.
window.pendingDecodes = [];
HTMLImageElement.prototype.decode = function () {
return new Promise((resolve, reject) => window.pendingDecodes.push({ image: this, resolve, reject }));
};
}
}, { source: firstSource, layout: "visible", ...options });
if (options.reducedMotion) await page.emulateMedia({ reducedMotion: "reduce" });
await page.goto(`http://127.0.0.1:${address.port}/`);
await page.waitForFunction(() => window.harnessReady);
return { page, image: page.getByRole("img", { name: "Captured checkout", exact: true }) };
@@ -351,17 +386,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 +412,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");
@@ -423,3 +530,187 @@ test("an image that leaves and re-enters the viewport within one render is ready
await expect(image).not.toHaveAttribute("aria-busy", /.*/);
assert.equal(await page.evaluate(() => window.imageLoads.length), 1, "No second load event fired");
});
/** The image's opacity and state in each of the next `frames` frames, from the frame after `change` runs. */
async function framesAfter(page, change, frames = 4, selector = "img[alt='Captured checkout']") {
return page.evaluate(({ change, frames, selector }) => new Promise(resolve => {
const samples = [];
new Function(change)();
const sample = () => {
const image = document.querySelector(selector);
samples.push(image ? { source: image.dataset.screenshotSrc ?? image.getAttribute("src"),
state: image.dataset.screenshotState, opacity: getComputedStyle(image).opacity } : undefined);
if (samples.length < frames) requestAnimationFrame(sample);
else resolve(samples);
};
requestAnimationFrame(sample);
}), { change, frames, selector });
}
/** The reveal animation on the image, paused and sought to `at` milliseconds: its opacity there. */
async function revealOpacityAt(image, at) {
return image.evaluate((element, at) => {
const [animation] = element.getAnimations().filter(animation => animation.animationName === "screenshot-reveal");
if (!animation) return undefined;
animation.pause();
animation.currentTime = at;
return Number(getComputedStyle(element).opacity);
}, at);
}
test("a waiting screenshot is hidden from its first frame, and one that fills its empty frame fades in", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true });
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
await expect(image).toHaveCSS("opacity", "0");
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.equal(await revealOpacityAt(image, 0), 0, "The fade starts from nothing");
const midway = await revealOpacityAt(image, 80);
assert.ok(midway > 0 && midway < 1, `Halfway through the fade the picture is partly shown (${midway})`);
await image.evaluate(element => element.getAnimations().forEach(animation => animation.finish()));
await expect(image).toHaveCSS("opacity", "1");
// Another source: the picture before is hidden in the very frame the new source lands, never faded out.
const samples = await framesAfter(page, `window.updateScreenshot({ source: ${JSON.stringify(secondSource)} })`);
const landed = samples.filter(sample => sample?.source === secondSource);
assert.ok(landed.length > 0, "The new source landed within a few frames");
assert.deepEqual(landed.map(sample => sample.opacity), landed.map(() => "0"));
assert.deepEqual(samples.filter(sample => sample?.source !== secondSource).map(sample => sample.opacity),
samples.filter(sample => sample?.source !== secondSource).map(() => "1"), "Until then, the shown picture is the one it names");
assert.deepEqual(await image.evaluate(element => element.getAnimations().map(animation => animation.constructor.name)), [],
"Nothing animates the hiding");
});
test("a loaded screenshot is shown only once it has decoded, or after a short wait for a decode that hangs", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, decode: "manual" });
await resolveImage(page, firstSource);
// The caller hears the load at once (Compare takes its shape from it); the picture waits for its pixels.
await expect.poll(() => page.evaluate(() => window.imageLoads.length)).toBe(1);
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
await page.waitForTimeout(100);
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
await expect(image).toHaveCSS("opacity", "0");
await page.evaluate(() => window.pendingDecodes.shift().resolve());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
// A decode that never settles: shown anyway, with its fade.
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await resolveImage(page, secondSource, secondImage);
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
const loadedAt = await page.evaluate(() => performance.now());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
const waited = await page.evaluate(() => performance.now()) - loadedAt;
assert.ok(waited >= 200, `The hung decode was waited for before the picture was shown (${Math.round(waited)}ms)`);
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.equal(await image.evaluate(element => element.naturalWidth), 4);
});
test("a screenshot the report still holds decoded fades in when it is shown again", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true });
const url = 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 });
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// Shown again (Compare stepping back to it, a view mounting again) while the report still holds its decoded URL.
await page.evaluate(() => window.updateScreenshot({ mounted: false }));
await expect(image).toHaveCount(0);
await page.evaluate(({ source, url }) => {
window.immediateScreenshots.set(source, url);
window.updateScreenshot({ mounted: true });
}, { source: firstSource, url });
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.equal(await revealOpacityAt(image, 0), 0);
});
test("an ordinary URL is a new image for each source and never shows the one before while it loads", { timeout: 30_000 }, async t => {
const { page } = await fixture(t, { loading: "eager", styles: true, normalSource: "/__normal.png" });
const hosted = page.getByRole("img", { name: "Hosted screenshot", exact: true });
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
await expect(hosted).toHaveAttribute("data-screenshot-reveal", "");
await hosted.evaluate(element => { element.dataset.first = "true"; });
const samples = await framesAfter(page, "window.updateScreenshot({ normalSource: '/__slow.png' })", 6, "img[alt='Hosted screenshot']");
const landed = samples.filter(sample => sample?.source === "/__slow.png");
assert.ok(landed.length > 0);
assert.deepEqual(landed.map(sample => [sample.state, sample.opacity]), landed.map(() => ["loading", "0"]));
await expect(hosted).not.toHaveAttribute("data-first", /.*/);
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
await expect(hosted).toHaveAttribute("data-screenshot-reveal", "");
await expectDecoded(hosted, 4, 5);
});
test("a held picture stays shown while its replacement loads, and the replacement appears without a fade", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, holdPrevious: true, fallback: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await expect(image).toHaveAttribute("data-screenshot-held", "");
await expect(image).toHaveCSS("opacity", "1");
await resolveImage(page, secondSource, secondImage);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expectDecoded(image, 4, 5);
await expect(image).not.toHaveAttribute("data-screenshot-reveal", /.*/);
await expect(image).not.toHaveAttribute("data-screenshot-held", /.*/);
assert.deepEqual(await image.evaluate(element => element.getAnimations().length), 0);
});
test("inside an instant stage a picture appears at once", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, instant: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).not.toHaveAttribute("data-screenshot-reveal", /.*/);
await expect(image).toHaveCSS("opacity", "1");
});
test("with reduced motion a screenshot appears without a fade", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, reducedMotion: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// The Viewer's reduced-motion rule leaves every transition a hundredth of a millisecond long; the fade is gone.
assert.deepEqual(await image.evaluate(element => element.getAnimations().map(animation => animation.animationName).filter(Boolean)), []);
await expect(image).toHaveCSS("opacity", "1");
});
test("an unselected variant thumbnail that changes source hides at once, despite its own dimmed opacity and its transition", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, thumbnail: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await image.evaluate(element => element.getAnimations().forEach(animation => animation.finish()));
await expect(image).toHaveCSS("opacity", "0.35");
const samples = await framesAfter(page, `window.updateScreenshot({ source: ${JSON.stringify(secondSource)} })`);
const landed = samples.filter(sample => sample?.source === secondSource);
assert.ok(landed.length > 0);
assert.deepEqual(landed.map(sample => sample.opacity), landed.map(() => "0"));
});
test("an ordinary URL that cannot be loaded shows the fallback, and a held one gives way to it", { timeout: 30_000 }, async t => {
const { page } = await fixture(t, { loading: "eager", styles: true, fallback: true, holdPrevious: true, normalSource: "/__normal.png" });
const hosted = page.getByRole("img", { name: "Hosted screenshot", exact: true });
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
// The app icon's case: a held picture whose replacement is missing ends on the fallback, not on the picture before.
await page.evaluate(() => window.updateScreenshot({ normalSource: "/__missing.png" }));
await expect(page.getByTestId("hosted-fallback")).toHaveText("No hosted screenshot");
await expect(hosted).toHaveCount(0);
// A new source tries again.
await page.evaluate(() => window.updateScreenshot({ normalSource: "/__normal.png" }));
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
await expect(page.getByTestId("hosted-fallback")).toHaveCount(0);
});
test("re-rendering an image that waits for its decode starts no second wait", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, decode: "manual" });
await resolveImage(page, firstSource);
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
// Renders while the decode is pending find the image loaded but not shown yet.
for (let render = 0; render < 5; render++) {
await page.evaluate(render => window.updateScreenshot({ render }), render);
await page.evaluate(() => new Promise(resolve => requestAnimationFrame(resolve)));
}
assert.equal(await page.evaluate(() => window.pendingDecodes.length), 1, "One decode wait for the one picture");
await page.evaluate(() => window.pendingDecodes.shift().resolve());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
});
+186
View File
@@ -0,0 +1,186 @@
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 pngBytes(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 PNG.sync.write(image);
}
const png = (width, height, color) => `data:image/png;base64,${pngBytes(width, height, color).toString("base64")}`;
const GREEN = [40, 200, 40];
// 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);
}, []);
// The second screen has screenshots of its own when the test gives it some.
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: screen && window.nextBefore || window.before,
afterScreenshot: screen && window.nextAfter || 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 = {}, images = {}) {
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) => {
// The next screen's Before, which takes a while to arrive.
if (request.url === "/__slow-before.png") {
response.setHeader("Content-Type", "image/png");
setTimeout(() => response.end(pngBytes(100, 100, GREEN)), 1000);
return;
}
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]), ...images });
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);
});
test("Stepping never shows the screen before's pictures under the next one's outlines: a side still loading is an empty frame", { timeout: 30_000 }, async t => {
const images = { before: png(100, 100, [200, 40, 40]), after: png(100, 100, [40, 40, 200]),
nextBefore: "/__slow-before.png", nextAfter: png(100, 100, [200, 200, 40]) };
const { page } = await openSplit(t, {}, images);
for (const side of ["before", "after"]) await expect(page.locator(`[data-side="${side}"] img`)).toHaveAttribute("data-screenshot-state", "ready");
// Every frame from the step on: the screen the outlines belong to, and any picture of the screen before still showing.
await page.evaluate(previous => {
window.stepFrames = [];
const sample = () => {
const outlines = document.querySelectorAll('[data-side="after"] .visual-change-outline').length;
const stale = [...document.querySelectorAll(".compare-frame img")].filter(image => previous.includes(image.getAttribute("src"))
&& Number(getComputedStyle(image).opacity) > 0).length;
window.stepFrames.push({ outlines, stale });
if (window.stepFrames.length < 30) requestAnimationFrame(sample);
};
requestAnimationFrame(sample);
}, [images.before, images.after]);
await page.keyboard.press("n");
await expect.poll(() => page.evaluate(() => window.stepFrames.length)).toBe(30);
const frames = await page.evaluate(() => window.stepFrames);
assert.ok(frames.some(frame => frame.outlines === 1), "The step landed while the frames were sampled");
assert.deepEqual(frames.filter(frame => frame.outlines === 1 && frame.stale > 0), [], "No frame showed a picture of the screen before under the next one's outlines");
// Before is still loading: its frame is empty, After's shows the new screen.
const before = page.locator('[data-side="before"] img');
await expect(before).toHaveAttribute("data-screenshot-state", "loading");
await expect(before).toHaveCSS("opacity", "0");
await expect(page.locator('[data-side="after"] img')).toHaveAttribute("data-screenshot-state", "ready");
await expect(before).toHaveAttribute("data-screenshot-state", "ready", { timeout: 5000 });
});
+111
View File
@@ -0,0 +1,111 @@
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 pngBytes(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 PNG.sync.write(image);
}
const png = (width, height, color) => `data:image/png;base64,${pngBytes(width, height, color).toString("base64")}`;
const RED = [200, 40, 40];
const BLUE = [40, 40, 200];
// 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={window.position ?? 50} />
</div>);
`;
async function openSwipe(t, images) {
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) => {
// A Before that takes a while to arrive.
if (request.url === "/__slow-before.png") {
response.setHeader("Content-Type", "image/png");
setTimeout(() => response.end(pngBytes(100, 100, RED)), 1000);
return;
}
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));
t.after(() => assert.deepEqual(errors, []));
await page.addInitScript(images => Object.assign(window, images), images);
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
return page;
}
/** The colour on screen at `x` (a share of the frame's width), a fifth of the way down the Swipe frame, clear of the divider's handle. */
async function colourAt(page, x) {
const box = await page.locator(".visual-swipe").boundingBox();
const shot = PNG.sync.read(await page.screenshot({ clip: { x: box.x + box.width * x, y: box.y + box.height / 5, width: 1, height: 1 } }));
return [...shot.data.subarray(0, 3)];
}
const near = (colour, expected) => colour.every((value, index) => Math.abs(value - expected[index]) <= 6);
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 page = await openSwipe(t, { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
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]);
});
test("Swipe never shows After on Before's half: while Before loads, its half is the empty frame", { timeout: 30_000 }, async t => {
const page = await openSwipe(t, { before: "/__slow-before.png", after: png(100, 100, BLUE) });
const before = page.locator("img.visual-swipe-before");
await expect(page.locator("img.visual-swipe-after")).toHaveAttribute("data-screenshot-state", "ready");
await expect(before).toHaveAttribute("data-screenshot-state", "loading");
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
assert.ok(near(await colourAt(page, 0.75), BLUE), "After shows on its own half");
const waiting = await colourAt(page, 0.25);
assert.ok(!near(waiting, BLUE) && !near(waiting, RED), `Before's half is the empty frame while Before loads: ${waiting}`);
await expect(before).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
assert.ok(near(await colourAt(page, 0.25), RED));
assert.ok(near(await colourAt(page, 0.75), BLUE));
});
for (const [position, shown] of [[0, BLUE], [100, RED]]) {
test(`Swipe at ${position}% shows only ${position ? "Before" : "After"}, across the whole frame`, { timeout: 30_000 }, async t => {
const page = await openSwipe(t, { before: png(100, 100, RED), after: png(100, 100, BLUE), position });
for (const side of ["before", "after"]) await expect(page.locator(`img.visual-swipe-${side}`)).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
for (const x of [0.03, 0.5, 0.97]) assert.ok(near(await colourAt(page, x), shown), `${position}%: ${x} of the way across`);
});
}
+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 } : {}) } });
+266
View File
@@ -0,0 +1,266 @@
import { expect, test, type Page } from "@playwright/test";
const STORAGE_KEY = "expo-explore:inspector-width";
const panel = (page: Page) => page.getByRole("complementary", { name: "Inspector panel" });
const handle = (page: Page) => page.getByRole("separator", { name: "Resize inspector" });
const panelWidth = async (page: Page) => (await panel(page).boundingBox())!.width;
const storedWidth = (page: Page) => page.evaluate((key) => localStorage.getItem(key), STORAGE_KEY);
/** Drags the panel's edge `dx` pixels (negative is left, which widens the panel). */
async function dragEdge(page: Page, dx: number) {
const box = (await handle(page).boundingBox())!;
const x = box.x + box.width / 2;
const y = box.y + box.height / 2;
await page.mouse.move(x, y);
await page.mouse.down();
await page.mouse.move(x + dx / 2, y);
await page.mouse.move(x + dx, y);
await page.mouse.up();
}
test.describe("Inspector resize", () => {
test("dragging the edge resizes the Inspector, and the width is kept for the next visit", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
// The 1280px test window takes the wide default.
expect(await panelWidth(page)).toBe(400);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "400");
await dragEdge(page, -150);
await expect.poll(() => panelWidth(page)).toBe(550);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "550");
expect(await storedWidth(page)).toBe("550");
await page.reload();
await expect(panel(page)).toBeVisible();
await expect.poll(() => panelWidth(page)).toBe(550);
// Dragging back right narrows it, never below the minimum.
await dragEdge(page, 400);
await expect.poll(() => panelWidth(page)).toBe(320);
expect(await storedWidth(page)).toBe("320");
});
test("the width stops at half the window, and a double-click restores the default", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
await dragEdge(page, -600);
await expect.poll(() => panelWidth(page)).toBe(640);
await expect(handle(page)).toHaveAttribute("aria-valuemax", "640");
await expect(handle(page)).toHaveAttribute("aria-valuenow", "640");
// The canvas toolbar moves left, out from under the wide panel, instead of being covered.
const toolbar = page.getByRole("toolbar", { name: "Canvas tools" });
await expect(toolbar).toBeVisible();
await expect.poll(async () => {
const toolbarBox = (await toolbar.boundingBox())!;
const panelBox = (await panel(page).boundingBox())!;
return panelBox.x - (toolbarBox.x + toolbarBox.width);
}).toBeGreaterThanOrEqual(8);
await handle(page).dblclick();
await expect.poll(() => panelWidth(page)).toBe(400);
expect(await storedWidth(page)).toBeNull();
});
test("arrow keys move the edge a step; Home and End take it to its limits", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
await handle(page).focus();
await page.keyboard.press("ArrowLeft");
await expect.poll(() => panelWidth(page)).toBe(416);
await page.keyboard.press("ArrowLeft");
await expect.poll(() => panelWidth(page)).toBe(432);
await page.keyboard.press("ArrowRight");
await expect.poll(() => panelWidth(page)).toBe(416);
await page.keyboard.press("End");
await expect.poll(() => panelWidth(page)).toBe(640);
await page.keyboard.press("Home");
await expect.poll(() => panelWidth(page)).toBe(320);
// The arrows resized the panel; they did not step the selected screen.
expect(new URL(page.url()).searchParams.get("screen")).toBe("area-0-screen-1");
});
test("a saved width wider than half of a smaller window is held to half of it", async ({ page }) => {
await page.addInitScript((key) => localStorage.setItem(key, "760"), STORAGE_KEY);
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
expect(await panelWidth(page)).toBe(640);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "640");
});
test("a drag that ends where it started leaves the default width in place", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
const box = (await handle(page).boundingBox())!;
const x = box.x + box.width / 2;
const y = box.y + box.height / 2;
await page.mouse.move(x, y);
await page.mouse.down();
await page.mouse.move(x - 100, y);
await expect.poll(() => panelWidth(page)).toBe(500);
await page.mouse.move(x, y);
await page.mouse.up();
await expect.poll(() => panelWidth(page)).toBe(400);
expect(await storedWidth(page)).toBeNull();
// Still the default: a narrower window takes the narrow default, not the 400 the drag passed through.
await page.setViewportSize({ width: 1100, height: 820 });
await expect.poll(() => panelWidth(page)).toBe(320);
});
test("a saved width below the minimum is held to it", async ({ page }) => {
await page.addInitScript((key) => localStorage.setItem(key, "40"), STORAGE_KEY);
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
expect(await panelWidth(page)).toBe(320);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "320");
});
test.describe("in a window wider than two maximum panels", () => {
test.use({ viewport: { width: 1700, height: 900 } });
test("a saved width above the maximum is held to it", async ({ page }) => {
await page.addInitScript((key) => localStorage.setItem(key, "5000"), STORAGE_KEY);
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
// Half of this window is 850.
expect(await panelWidth(page)).toBe(800);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "800");
});
});
test("a key that cannot move the edge keeps the saved width", async ({ page }) => {
await page.addInitScript((key) => localStorage.setItem(key, "760"), STORAGE_KEY);
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
expect(await panelWidth(page)).toBe(640);
await handle(page).focus();
await page.keyboard.press("End");
await page.keyboard.press("ArrowLeft");
expect(await storedWidth(page)).toBe("760");
await page.keyboard.press("ArrowRight");
await expect.poll(() => panelWidth(page)).toBe(624);
expect(await storedWidth(page)).toBe("624");
});
test("the separator's values follow the window", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
await handle(page).focus();
await page.keyboard.press("End");
await expect(handle(page)).toHaveAttribute("aria-valuenow", "640");
await page.setViewportSize({ width: 1000, height: 820 });
await expect.poll(() => panelWidth(page)).toBe(500);
await expect(handle(page)).toHaveAttribute("aria-valuemax", "500");
await expect(handle(page)).toHaveAttribute("aria-valuenow", "500");
// Back in the wide window the saved width returns.
await page.setViewportSize({ width: 1280, height: 820 });
await expect.poll(() => panelWidth(page)).toBe(640);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "640");
});
test("closing the Inspector mid-drag ends the drag", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
const box = (await handle(page).boundingBox())!;
const x = box.x + box.width / 2;
const y = box.y + box.height / 2;
await page.mouse.move(x, y);
await page.mouse.down();
await page.mouse.move(x - 100, y);
await expect(page.locator("html")).toHaveClass(/inspector-resizing/);
await page.keyboard.press("i");
await expect(panel(page)).toHaveCount(0);
await page.mouse.up();
await expect(page.locator("html")).not.toHaveClass(/inspector-resizing/);
// The width the drag reached is kept.
await page.keyboard.press("i");
await expect.poll(() => panelWidth(page)).toBe(500);
});
test.describe("in a window too narrow for the toolbar beside a half-window Inspector", () => {
test.use({ viewport: { width: 820, height: 800 } });
/** The widest the panel may be here: the window less the bottom bar and a 12px gap either side. */
async function widestBesideToolbar(page: Page) {
const toolbarBox = (await page.getByRole("toolbar", { name: "Canvas tools" }).boundingBox())!;
return Math.floor(820 - (toolbarBox.width + 2 * 12));
}
async function expectToolbarBesidePanel(page: Page) {
const toolbar = page.getByRole("toolbar", { name: "Canvas tools" });
await expect(toolbar).toBeVisible();
await expect(toolbar.getByRole("button", { name: "More", exact: true })).toBeVisible();
const toolbarBox = (await toolbar.boundingBox())!;
const panelBox = (await panel(page).boundingBox())!;
expect(toolbarBox.x).toBeGreaterThanOrEqual(12 - 1);
expect(toolbarBox.x + toolbarBox.width + 12).toBeLessThanOrEqual(panelBox.x + 1);
}
test("End stops the Inspector where the toolbar still fits beside it, with More in reach", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
const widest = await widestBesideToolbar(page);
// Half the window would be 410; the toolbar needs more of the canvas than that leaves.
expect(widest).toBeLessThan(410);
expect(widest).toBeGreaterThan(320);
await expect(handle(page)).toHaveAttribute("aria-valuemax", String(widest));
await handle(page).focus();
await page.keyboard.press("End");
await expect.poll(() => panelWidth(page)).toBe(widest);
await expect(handle(page)).toHaveAttribute("aria-valuenow", String(widest));
await page.keyboard.press("ArrowLeft");
await expect.poll(() => panelWidth(page)).toBe(widest);
await expectToolbarBesidePanel(page);
// Narrowed again, the toolbar keeps its gap to the panel.
await page.keyboard.press("Home");
await expect.poll(() => panelWidth(page)).toBe(320);
await expectToolbarBesidePanel(page);
});
test("a drag or a saved width stops there too", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
const widest = await widestBesideToolbar(page);
await dragEdge(page, -300);
await expect.poll(() => panelWidth(page)).toBe(widest);
expect(await storedWidth(page)).toBe(String(widest));
await expectToolbarBesidePanel(page);
await page.evaluate((key) => localStorage.setItem(key, "800"), STORAGE_KEY);
await page.reload();
await expect(panel(page)).toBeVisible();
await expect.poll(() => panelWidth(page)).toBe(widest);
await expectToolbarBesidePanel(page);
// A wider window gives the saved width more room again.
await page.setViewportSize({ width: 1280, height: 800 });
await expect.poll(() => panelWidth(page)).toBe(640);
});
});
test.describe("in a narrow window", () => {
test.use({ viewport: { width: 1180, height: 820 } });
test("the Inspector starts at its narrow default, and a saved width is held to half the window", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
expect(await panelWidth(page)).toBe(320);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "320");
await page.evaluate((key) => localStorage.setItem(key, "760"), STORAGE_KEY);
await page.reload();
await expect(panel(page)).toBeVisible();
expect(await panelWidth(page)).toBe(590);
await expect(handle(page)).toHaveAttribute("aria-valuenow", "590");
});
});
test.describe("on a phone", () => {
test.use({ viewport: { width: 390, height: 844 }, hasTouch: true, isMobile: true });
test("the Inspector sheet has no resize edge", async ({ page }) => {
await page.goto("/map?screen=area-0-screen-1");
await expect(panel(page)).toBeVisible();
await expect(handle(page)).toHaveCount(0);
});
});
});
+1067 -253
View File
File diff suppressed because it is too large. Load diff
+2 -2
View File
@@ -54,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 }));
@@ -67,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' }; }
+80 -7
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");
@@ -292,7 +293,7 @@ test("action rejects unsupported Node versions before installing tools", async t
test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it runs only for a requested hosted preview", () => {
const deploy = review.jobs.deploy;
assert.deepEqual(deploy.needs, ["targets", "capture", "report"]);
assert.equal(deploy.if, "needs.capture.outputs.preview == 'eas'");
assert.equal(deploy.if, "needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()");
assert.deepEqual(deploy.permissions, { contents: "read", actions: "read", "pull-requests": "write" });
const step = deploy.steps.find(step => step.name === "Deploy the hosted preview and publish its Explore report links");
assert.equal(step.env.EXPO_TOKEN, "${{ secrets.EXPO_TOKEN }}");
@@ -304,7 +305,8 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
assert.deepEqual(downloads.map(step => step.with.pattern), ["explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*", "explore-review-${{ github.run_id }}-${{ github.run_attempt }}-*"]);
assert.ok(downloads.every(step => step.with.name === undefined && step.with["merge-multiple"] === undefined));
assert.doesNotMatch(JSON.stringify(deploy), /OPENAI_API_KEY|ANTHROPIC_API_KEY/);
assert.equal(review.jobs.report.outputs, undefined);
// A report job hands forward only whether it published; its artifact URL is looked up again (matrix outputs keep one leg's value).
assert.deepEqual(review.jobs.report.outputs, { published: "${{ steps.publish.outputs.published }}" });
// capture:review writes preview=<hosting> to the step outputs from the reviewed config.
assert.equal(review.jobs.capture.outputs.preview, "${{ steps.capture.outputs.preview }}");
assert.match(review.jobs.capture.steps.find(step => step.id === "capture").run, /capture:review/);
@@ -313,6 +315,48 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
assert.match(review.jobs.failure.if, /needs\.deploy\.result == 'failure'/);
});
test("one target's failed capture keeps neither the other targets' reports nor the preview off the PR (brentvatne/euxy#172)", async t => {
for (const workflow of [review, compare]) {
const report = workflow.jobs.report;
// A plain needs: [capture] skips every report once one capture leg fails; !cancelled() runs them, except in a cancelled run.
assert.equal(report.if, "needs.targets.result == 'success' && !cancelled()");
assert.deepEqual(report.needs, ["targets", "capture"]);
const [download, check] = report.steps;
assert.ok(download.uses.startsWith("actions/download-artifact@"));
// A pattern without a wildcard names this leg's artifact alone, and matching nothing is not a failure, as a name is.
assert.deepEqual(download.with, { pattern: "explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}", path: "${{ runner.temp }}/explore-review" });
assert.equal(download["continue-on-error"], undefined, "a download that went wrong still fails the leg");
assert.equal(check.id, "captured");
const explore = report.steps.filter(step => /cli\.js" ci:(report|publish)/.test(step.run ?? "") || step.uses?.startsWith("actions/upload-artifact@") && step.if !== "always()");
assert.equal(explore.length, 3);
for (const step of explore) assert.equal(step.if, "steps.captured.outputs.found == 'true'", step.name);
const publish = report.steps.find(step => step.id === "publish");
assert.match(publish.run, /ci:publish[^\n]*\n\s*echo "published=true" >> "\$GITHUB_OUTPUT"/, "published only once ci:publish succeeded");
assert.deepEqual(report.outputs, { published: "${{ steps.publish.outputs.published }}" });
assert.equal(workflow.jobs.deploy.if, "needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()");
assert.deepEqual(workflow.jobs.deploy.needs, ["targets", "capture", "report"]);
// The check reads what the download left: this target's report input, or nothing.
const root = await mkdtemp(join(tmpdir(), "explore-report-check-"));
t.after(() => rm(root, { recursive: true, force: true }));
const runCheck = async () => {
const output = join(root, "output"); await writeFile(output, "");
const result = spawnSync("bash", ["-c", check.run], { encoding: "utf8", env: { ...process.env, RUNNER_TEMP: root, GITHUB_OUTPUT: output, TARGET: "duo-open" } });
assert.equal(result.status, 0, result.stderr);
return { output: await readFile(output, "utf8"), stdout: result.stdout };
};
const failed = await runCheck();
assert.equal(failed.output, "");
assert.match(failed.stdout, /The duo-open capture uploaded no review: its capture job failed/);
await mkdir(join(root, "explore-review"), { recursive: true });
await writeFile(join(root, "explore-review", "report-input.json"), "{}");
assert.equal((await runCheck()).output, "found=true\n");
}
// The failure job still runs when a capture leg failed, and names that target from its diagnostics.
const failure = review.jobs.failure;
assert.match(failure.if, /^always\(\) && \(.*needs\.capture\.result == 'failure'.*needs\.report\.result == 'failure'/);
for (const step of failure.steps.filter(step => step.uses?.startsWith("actions/download-artifact@"))) assert.equal(step["continue-on-error"], true, step.name);
});
test("closing a pull request runs nothing: hosted previews stay until a developer deletes them", () => {
assert.ok(!review.on.pull_request_target.types.includes("closed"));
assert.doesNotMatch(review.jobs.targets.if, /closed/);
@@ -325,16 +369,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 +427,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" });
});
+36
View File
@@ -439,6 +439,42 @@ test("a reader stuck on the dark panel after a fold is reset once more before th
assert.equal(stuck.calls.filter(call => call.tool === "stop-all-simulator-servers").length, 2, "before the fold and once after, not in a loop");
});
// brentvatne/euxy#172, review run 39348956443: the fold after capture restarted SpringBoard failed with this, before it ran.
const DEPENDENCY_FAILED = "argent run fold failed: [Tool:fold] Service dependency failed: [SimulatorServer:74195B53-4DBC-4EAA-9991-F98E5BB86BA8] Timed out waiting for simulator-server to become ready";
test("a fold whose simulator-server did not start is sent again after a pause, and then folds", async () => {
const lit = { activeScreen: 3, screen: { id: 3, panel: "inner panel", width: 2007, height: 2853 }, posture: "open", hingeAngle: 180 };
const { run, calls, context } = harness("ios", { "list-devices": DUO_DEVICES, "ui-tree": DUO_OPEN_EDIT_LANE, "stop-all-simulator-servers": { stopped: [] },
fold: [new ArgentCallError(DEPENDENCY_FAILED, true), lit] });
const pauses = [];
context.sleep = async milliseconds => { pauses.push(milliseconds); };
assert.deepEqual((await run(["fold", "open", ...flags("ios")])).json.data, { action: "fold", pose: "open" });
assert.equal(calls.filter(call => call.tool === "fold").length, 2);
assert.deepEqual(pauses, [3_000], "one pause before the fold is sent again");
});
test("a fold whose simulator-server never starts fails as it did before, after two more tries", async () => {
const { run, calls, context } = harness("ios", { "list-devices": DUO_DEVICES, "ui-tree": DUO_OPEN_EDIT_LANE, "stop-all-simulator-servers": { stopped: [] },
fold: new ArgentCallError(DEPENDENCY_FAILED, true) });
const pauses = [];
context.sleep = async milliseconds => { pauses.push(milliseconds); };
const failed = await run(["fold", "open", ...flags("ios")]);
assert.deepEqual(failed.json.error, { code: "ARGENT_TOOL_FAILED", message: DEPENDENCY_FAILED });
assert.equal(calls.filter(call => call.tool === "fold").length, 3);
assert.deepEqual(pauses, [3_000, 6_000]);
});
test("a UI action that failed for another reason is still sent once, even when its message mentions a dependency", async () => {
// Only the tool's own wrap counts: a nested tool's dependency failure is not this tool failing to start.
for (const message of ["argent run gesture-tap failed: [Tool:gesture-tap] simulator-server answered 500",
"argent run gesture-tap failed: [Tool:gesture-tap] [Tool:keyboard] Service dependency failed: [SimulatorServer:x] Timed out"]) {
const { run, calls } = harness("ios", { "list-devices": IOS_DEVICES, "ui-tree": IOS_HOME, "gesture-tap": new ArgentCallError(message, true) });
const pressed = await run(["press", "10", "10", ...flags("ios")]);
assert.deepEqual(pressed.json.error, { code: "ARGENT_TOOL_FAILED", message });
assert.equal(calls.filter(call => call.tool === "gesture-tap").length, 1, message);
}
});
test("an alert that is not the link prompt is left for capture to answer", async () => {
const other = { ...IOS_HOME, alertVisible: true, foregroundApp: "com.apple.springboard",
roots: [{ type: "Alert", label: "Delete all data?", frame: { x: 0.1, y: 0.4, width: 0.8, height: 0.2 }, children: [
+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");
+16
View File
@@ -173,6 +173,22 @@ test("CI argument failures preserve JSON output, annotation, summary, and diagno
assert.match(await readFile(summary, "utf8"), /Next action/);
});
test("a failed command's diagnostics file names the matrix target it ran for, so the failure comment can", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-cli-target-"));
t.after(() => rm(root, { recursive: true, force: true }));
const cli = new URL("../../src/cli.ts", import.meta.url);
const run = target => {
const result = spawnSync(process.execPath, ["--import", "tsx", cli.pathname, "ci:report", "--input", join(root, "missing.json"), "--output", join(root, "out"), "--target", target],
{ encoding: "utf8", env: { ...process.env, GITHUB_ACTIONS: "true", RUNNER_TEMP: root } });
assert.equal(result.status, 1, result.stderr);
return readFile(join(root, "explore-diagnostics/error.json"), "utf8").then(JSON.parse);
};
const written = await run("duo-closed");
assert.equal(written.target, "duo-closed");
assert.equal(written.code, "REPORT_INPUT_INVALID");
assert.equal((await run("../ios")).target, undefined, "only a valid target id is written");
});
test("source worker failures emit a structured diagnostic without a raw stack", () => {
const worker = new URL("../../src/source/plan-worker.ts", import.meta.url);
const result = spawnSync(process.execPath, ["--import", "tsx", worker.pathname], { input: "{", encoding: "utf8" });
+58 -1
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';
@@ -3557,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");
});
+35
View File
@@ -0,0 +1,35 @@
import assert from "node:assert/strict";
import test from "node:test";
const { tsImport } = await import("tsx/esm/api");
const { clampInspectorWidth, inspectorWidthBounds, INSPECTOR_WIDTH_MAX, INSPECTOR_WIDTH_MIN } =
await tsImport("../../viewer/src/utils/inspector-width.ts", import.meta.url);
test("the Inspector may take at most half the window, within its fixed range", () => {
assert.deepEqual(inspectorWidthBounds(1440), { min: INSPECTOR_WIDTH_MIN, max: 720 });
assert.deepEqual(inspectorWidthBounds(2560), { min: INSPECTOR_WIDTH_MIN, max: INSPECTOR_WIDTH_MAX });
// A window narrower than two minimum panels still allows the minimum.
assert.deepEqual(inspectorWidthBounds(500), { min: INSPECTOR_WIDTH_MIN, max: INSPECTOR_WIDTH_MIN });
});
test("the bounds are in the panel's own pixels when the chrome is zoomed", () => {
assert.deepEqual(inspectorWidthBounds(1600, 1.25), { min: INSPECTOR_WIDTH_MIN, max: 640 });
assert.deepEqual(inspectorWidthBounds(1600, 0), inspectorWidthBounds(1600, 1));
});
test("the Inspector stops where the canvas keeps the bottom bar's room, never below the minimum", () => {
// 820 - 424 leaves 396, less than half of 820.
assert.deepEqual(inspectorWidthBounds(820, 1, 424), { min: INSPECTOR_WIDTH_MIN, max: 396 });
// In a wide window half of it is the tighter cap.
assert.deepEqual(inspectorWidthBounds(1440, 1, 424), { min: INSPECTOR_WIDTH_MIN, max: 720 });
// The room is in window pixels, the width in the panel's own: (1000 - 530) / 1.25 = 376.
assert.deepEqual(inspectorWidthBounds(1000, 1.25, 530), { min: INSPECTOR_WIDTH_MIN, max: 376 });
assert.deepEqual(inspectorWidthBounds(700, 1, 424), { min: INSPECTOR_WIDTH_MIN, max: INSPECTOR_WIDTH_MIN });
});
test("a width is clamped to the bounds and rounded to whole pixels", () => {
const bounds = { min: 320, max: 720 };
assert.equal(clampInspectorWidth(100, bounds), 320);
assert.equal(clampInspectorWidth(1000, bounds), 720);
assert.equal(clampInspectorWidth(455.6, bounds), 456);
});
+130 -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", () => {
@@ -60,6 +60,29 @@ test("ending a hold, or beginning another key, stops the first", (t) => {
assert.equal(left, 2);
});
test("a hold says when it ends, however it ends, and whether any key is held", (t) => {
t.mock.timers.enable({ apis: ["setTimeout"] });
const hold = createKeyHold();
const ended = [];
assert.ok(!hold.holding());
hold.begin("ArrowRight", () => true, () => ended.push("released"));
assert.ok(hold.holding());
hold.release("ArrowLeft");
assert.deepEqual(ended, [], "another key going up leaves it held");
hold.release("ArrowRight");
hold.begin("ArrowLeft", () => true, () => ended.push("replaced"));
hold.begin("ArrowRight", () => true, () => ended.push("ended"));
hold.end();
let steps = 0;
hold.begin("ArrowDown", () => (steps += 1) < 2, () => ended.push("at the end"));
t.mock.timers.tick(HOLD_INITIAL_DELAY_MS);
t.mock.timers.tick(holdIntervalMs(1));
assert.deepEqual(ended, ["released", "replaced", "ended", "at the end"]);
assert.ok(!hold.holding());
hold.end();
assert.equal(ended.length, 4, "an ended hold does not end again");
});
test("another key ends a hold, as the OS's own repeat stops; its own repeats and a modifier do not", () => {
const key = (code, key = code, repeat = false) => ({ code, key, repeat });
const hold = createKeyHold();
@@ -76,10 +99,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 });
+105 -17
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, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, FIXTURE_ALIAS_WAIT_MS, 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) {
@@ -388,11 +387,76 @@ test("collectPlatformReports pairs downloaded artifact directories by platform a
const lookups = eas.requests.filter(request => request.url.pathname.endsWith("/actions/runs/10/artifacts"));
assert.deepEqual(lookups.map(request => request.url.searchParams.get("name")), ["explore-review-10-1-android", "explore-review-10-1-ios"]);
assert.ok(lookups.every(request => request.options.headers.authorization === "Bearer test-token"));
// A target whose report job failed (brentvatne/euxy#172) is left out; the others still deploy, without waiting for it.
await rm(join(root, "reports", "explore-review-10-1-android"), { recursive: true });
const before = eas.requests.length;
const remaining = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport });
assert.deepEqual(remaining.map(entry => entry.target.id), ["ios"]);
assert.deepEqual(eas.requests.slice(before).map(request => request.url.searchParams.get("name")), ["explore-review-10-1-ios"], "no lookup for the target without a report");
await rm(join(root, "reports", "explore-review-10-1-ios"), { recursive: true });
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport }),
error => error.code === "PREVIEW_REPORTS_INCOMPLETE");
});
test("collectPlatformReports reads a lone target's artifacts, which download-artifact extracts into the path itself", async t => {
const fixture = await asTarget(await exportFixture(t), TARGETS[2]);
const root = await mkdtemp(join(tmpdir(), "explore-fanin-lone-")); t.after(() => rm(root, { recursive: true, force: true }));
// Four of five captures failed, so each pattern matched one artifact: its files sit in --inputs and --reports themselves.
await mkdir(join(root, "inputs"), { recursive: true }); await cp(fixture.inputPath, join(root, "inputs", "report-input.json"));
await cp(fixture.reportPath, join(root, "reports"), { recursive: true });
const eas = easFixture();
const transport = async (input, options) => {
const url = new URL(input);
if (url.pathname.endsWith("/actions/runs/10/artifacts") && url.searchParams.get("name") === "explore-review-10-1-duo-open") {
return new Response(JSON.stringify({ artifacts: [{ id: 33, name: "explore-review-10-1-duo-open" }] }), { status: 200 });
}
return eas.transport(input, options);
};
const [entry, ...rest] = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport });
assert.deepEqual(rest, []);
assert.deepEqual([entry.target.id, entry.inputPath, entry.reportPath, entry.artifactUrl.split("/").at(-1)],
["duo-open", join(root, "inputs", "report-input.json"), join(root, "reports"), "33"]);
// A pattern that matched nothing left no directory: there is nothing to deploy, and that is said plainly.
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "missing"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport }),
error => error.code === "PREVIEW_REPORTS_MISSING");
});
test("collectPlatformReports looks up a report artifact the run does not list yet again, but not one its token cannot read", async t => {
const ios = await exportFixture(t);
const root = await mkdtemp(join(tmpdir(), "explore-fanin-late-")); t.after(() => rm(root, { recursive: true, force: true }));
const { cp } = await import("node:fs/promises");
await mkdir(join(root, "inputs", "explore-capture-10-1-ios"), { recursive: true }); await cp(ios.inputPath, join(root, "inputs", "explore-capture-10-1-ios", "report-input.json"));
await cp(ios.reportPath, join(root, "reports", "explore-review-10-1-ios"), { recursive: true });
const eas = easFixture();
const listing = answers => {
const lookups = [];
const transport = async (input, options) => {
const url = new URL(input);
if (!url.pathname.endsWith("/actions/runs/10/artifacts")) return eas.transport(input, options);
lookups.push(url);
const answer = answers[Math.min(lookups.length, answers.length) - 1];
return answer ? new Response(JSON.stringify(answer.body ?? {}), { status: answer.status }) : eas.transport(input, options);
};
return { lookups, transport };
};
const pauses = [];
const sleep = async milliseconds => { pauses.push(milliseconds); };
// The list lags the report job's upload: empty, then a 404, then the artifact.
const late = listing([{ status: 200, body: { artifacts: [] } }, { status: 404 }, undefined]);
const [entry] = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: late.transport, sleep });
assert.equal(entry.artifactUrl, artifactUrl.replace(/20$/, "21"));
assert.equal(late.lookups.length, 3);
assert.equal(pauses.length, 2);
const denied = listing([{ status: 403 }]);
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: denied.transport, sleep }),
error => error.code === "REPORT_ARTIFACT_MISSING" && /HTTP 403/.test(error.message));
assert.equal(denied.lookups.length, 1);
const never = listing([{ status: 200, body: { artifacts: [] } }]);
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: never.transport, sleep }),
error => error.code === "REPORT_ARTIFACT_MISSING");
assert.equal(never.lookups.length, 5);
});
const now = Date.UTC(2026, 8, 11, 3, 7);
const STALE_COMMENT = `<!-- expo-explore-ci -->
Explore review for abc · Managed via config
@@ -422,7 +486,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(""));
@@ -457,6 +521,20 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
assert.match(plain.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
assert.notEqual(plain.previewUrl, result.previewUrl, "without a fixed token the link is random");
// A standalone report's alias that is still behind after the whole budget: its link is the deployment, which
// serves this run, and nothing says the alias is behind (only a fixture preview's comment explains a lagging link).
const behind = easFixture({ aliasServes: false });
let clock = now;
const quiet = process.stderr.write.bind(process.stderr);
process.stderr.write = () => true;
let fallback;
try {
fallback = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky", token,
environment: deployEnvironment, transport: behind.transport, run: behind.run, now: () => (clock += 31_000), verifyTimeoutMs: 60_000 });
} finally { process.stderr.write = quiet; }
assert.equal(fallback.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.equal(fallback.aliasBehind, undefined);
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "Blue Sky",
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_ALIAS_INVALID");
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, token: "short",
@@ -488,21 +566,28 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/manifest.json`).map(request => request.url.searchParams.get("platform"));
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' manifests are verified");
// The alias lagging the deployment past the budget is not a failed deployment: the deployment is verified, so the
// link is the deployment's own origin and the job log carries a warning (every 2026-10-14 "HTTP 404" failure was this).
// The alias lagging the deployment is not a failed deployment (every 2026-10-14 "HTTP 404" failure was this): the
// deployment is verified, so after FIXTURE_ALIAS_WAIT_MS, not the whole verification budget, the pull request links
// the alias anyway, says it is behind, and the job log carries a warning.
const behind = easFixture({ aliasOrigin: "https://explore-viewer-pr--pr-12.expo.app", aliasServes: false });
let clock = now; const ticking = () => (clock += 31_000);
// Each poll really waits 3 s, so the clock moves 7 s a reading: the 20 s wait is three polls, not twenty.
let clock = now; const ticking = () => (clock += 7_000);
const quiet = process.stderr.write.bind(process.stderr); const logged = [];
process.stderr.write = chunk => { logged.push(String(chunk)); return true; };
let linked;
try {
linked = await deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }], project: "explore-viewer-pr", owner: "brent-org", alias: "pr-12", token,
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 60_000 });
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 180_000 });
} finally { process.stderr.write = quiet; }
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
assert.equal(linked.aliasUrl, "https://explore-viewer-pr--pr-12.expo.app");
assert.equal(linked.aliasBehind, true);
assert.equal(linked.deploymentUrl, "https://acme-explore--1lcbdcpwn3.expo.app", "the comment links the verified deployment beside the alias");
assert.equal(logged.filter(line => /^Deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app serves this run's report \(\d+ s after eas deploy returned\)\./.test(line)).length, 1);
assert.equal(logged.filter(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still answers HTTP 404 \d+ s after eas deploy returned\. The pull request links the deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app instead\./.test(line)).length, 1);
const warning = logged.find(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still answers HTTP 404 \d+ s after eas deploy returned\. The pull request links it anyway, until it catches up, beside the deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\./.test(line));
assert.ok(warning, logged.join(""));
const waited = Number(/HTTP 404 (\d+) s/.exec(warning)[1]);
assert.ok(waited >= FIXTURE_ALIAS_WAIT_MS / 1000 && waited < FIXTURE_ALIAS_WAIT_MS / 1000 + 15, `gave up on the alias after ${waited} s, not the 180 s budget`);
assert.ok(behind.requests.some(request => request.url.origin === "https://explore-viewer-pr--pr-12.expo.app"), "the alias was polled");
// The example report keeps one token and the same fixtures, so an alias still on the previous deployment serves the
@@ -514,7 +599,8 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
linked = await deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }], project: "explore-viewer-pr", owner: "brent-org", alias: "pr-12", token,
exportPath, environment: deployEnvironment, transport: stale.transport, run: stale.run, now: ticking, verifyTimeoutMs: 60_000 });
} finally { process.stderr.write = quiet; }
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
assert.equal(linked.aliasBehind, true);
assert.equal(logged.filter(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still serves an earlier deployment \d+ s after eas deploy returned\./.test(line)).length, 1);
await assert.rejects(deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }, { platform: "ios", zipPath: join(root, "ios.zip") }],
@@ -790,7 +876,9 @@ test("ci:deploy pairs target-named artifacts, deploys them in config order, and
const entries = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport });
assert.deepEqual(entries.map(entry => [entry.target.id, entry.platform, entry.artifactUrl.split("/").at(-1)]),
[["iphone", undefined, "31"], ["duo-closed", undefined, "32"], ["duo-open", undefined, "33"], ["android", "android", "34"]], "config order, not directory order");
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 })
// The fixture serves none of these artifacts by id, so each comment's artifact lookup answers 404 through all its retries.
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1,
sleep: async () => {} })
.catch(error => error);
// Publishing each target's comment section after the deployment is the comment code's (publishCiReportComment, which needs
// the target to name the artifact); the deployment itself must have been written per target either way.
+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);
});
+397 -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,24 +692,71 @@ 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 /);
});
test('one of five targets failed: the comment shows the four reports and that failure, and no new-run banner (brentvatne/euxy#172)', async t => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const { publishFailureComment } = await import('../../dist/report/failure-comment.js');
const { mkdir, mkdtemp, rm, writeFile } = await import('node:fs/promises');
const { tmpdir } = await import('node:os');
const { join } = await import('node:path');
const targets = [...duoTargets, { id: 'pixel-dark', platform: 'android', label: 'Pixel 7 (dark)' }];
const configPath = '.expo-explore/config.yaml';
const firstAttempt = viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/42/artifacts/7650', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '1', configPath });
const working = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath });
// Attempt 1 published every target; attempt 2 captured them all at once, and the iPhone Duo (open) session failed.
let body;
for (const target of targets) body = platformSectionMerge(targetState(target, { targets, links: firstAttempt }), target.id).merge(body);
for (const target of targets) body = platformSectionMerge(targetState(target, { targets, links: working, phase: 'capturing', review: undefined, evidence: undefined,
capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 1 }, baseFromCache: false, current: 'head' } }), target.id).merge(body);
assert.match(visible(body), /New run in progress/);
for (const target of targets.filter(target => target.id !== 'duo-open')) body = platformSectionMerge(targetState(target, { targets }), target.id).merge(body);
const root = await mkdtemp(join(tmpdir(), 'explore-one-failed-')); t.after(() => rm(root, { recursive: true, force: true }));
for (const target of targets) await mkdir(join(root, 'capture', `explore-diagnostics-42-2-${target.id}`, 'explore-diagnostics'), { recursive: true });
await writeFile(join(root, 'capture', 'explore-diagnostics-42-2-duo-open', 'explore-diagnostics', 'error.json'), JSON.stringify({ code: 'ARGENT_TOOL_FAILED', stage: 'session',
message: 'fold: argent run fold failed: [Tool:fold] Service dependency failed', nextAction: 'Rerun the capture.', retryable: false, target: 'duo-open' }));
let comments = [{ id: 5, user: { login: 'github-actions[bot]' }, body }];
const transport = async (input, init = {}) => {
const url = new URL(input);
if (url.pathname === '/repos/expo/explore-playground/pulls/1') return Response.json({ state: 'open', draft: false, title: pullRequest.title, html_url: pullRequest.url,
base: { ref: 'main', sha: baseSha, repo: { id: 1, full_name: pullRequest.repository } }, head: { ref: pullRequest.head.ref, sha: headSha, repo: { full_name: pullRequest.repository } } });
if (url.pathname === '/repos/expo/explore-playground/issues/1/comments') return Response.json(comments);
if (url.pathname === '/repos/expo/explore-playground/issues/comments/5' && init.method === 'PATCH') {
comments = [{ ...comments[0], body: JSON.parse(init.body).body }]; return Response.json({ id: 5 });
}
throw new Error(`unexpected request ${init.method ?? 'GET'} ${url}`);
};
assert.deepEqual(await publishFailureComment({ repository: pullRequest.repository, pullNumber: 1, headSha, baseSha, runId: '42', runAttempt: '2', diagnosticsPath: root,
environment: { GITHUB_TOKEN: 'test-token' }, transport }), { posted: true });
const final = comments[0].body;
assert.doesNotMatch(visible(final), /New run in progress|New run failed/);
assert.equal(readCommentRecords(final).previous, undefined, "attempt 1's records go once every target of attempt 2 finished");
const records = readCommentRecords(final).current;
assert.deepEqual(targets.map(target => [records[target.id].runAttempt, records[target.id].phase]),
[['2', 'ready'], ['2', 'ready'], ['2', 'failed'], ['2', 'ready'], ['2', 'ready']]);
assert.match(statusOf(final, 'iPhone Duo \\(open\\)'), /^\*\*iPhone Duo \\\(open\\\) failed\*\* · session · ARGENT\\_TOOL\\_FAILED\\: fold\\: argent run fold failed/);
// Each published target links its report; the failure's record is the newest, so it sets the updated time.
assert.ok(subtitleOf(final).startsWith(`<sub>[iPhone 17](<${reportUrl}>) · [iPhone Duo \\(closed\\)](<${reportUrl}>) · iPhone Duo \\(open\\) · [Pixel 7](<${reportUrl}>) · [Pixel 7 \\(dark\\)](<${reportUrl}>) · ${commits} · updated `), subtitleOf(final));
assert.equal(titleOf(final), `### 3 screens changed · [Review in Explore](<${reportUrl}>)`);
});
test('a comment written by a per-platform version keeps parsing, and malformed target records are dropped', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const { encodeRecordPayload } = await import('../../dist/report/pr-comment-record.js');
@@ -587,6 +778,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 +797,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 +817,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 +825,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 +835,24 @@ 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/);
});
test('an excluded route that is new is not one of the changed screens, nor of the ones the list links to', () => {
const screens = Array.from({ length: 11 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
review: { status: 'modified', description: `Changed ${index}` },
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' },
} }));
const excluded = surface('channel', 'added', { route: '/c/[channel]', extra: { excluded: true } });
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete excluded[key];
const body = renderPublicComment(state({ review: review([...screens, excluded]) }));
assert.equal(titleOf(body), `### 11 screens changed · [Review in Explore](<${reportUrl}>)`);
assert.equal(listOf(body).at(-1), `- [1 more screen in the report](<${reportUrl}>)`);
assert.doesNotMatch(body, /\/c\/\[channel\]/);
});
Loaded 100 of 168 files, more files were not shown because too many files have changed in this diff. Show more