Compare commits

..
Author SHA1 Message Date
Brent Vatne fc5b465513 Release 0.19.3 2026-10-15 20:42:49 -07:00
Brent Vatne 09b9f34e33 Label outlines with how far moved areas moved (#3) 2026-10-15 20:42:38 -07:00
Brent Vatne d61d9b9fc5 Release 0.19.2 2026-10-15 18:25:01 -07:00
Brent Vatne e8a03a362e Label accessibility-only changes and stop reporting uncompared source changes (#2) 2026-10-15 18:24:49 -07:00
Brent Vatne bdd2d8349c Release 0.19.1 2026-10-15 16:00:46 -07:00
Brent Vatne 4d0eddd811 Count only visible changes
A screen whose source changed but whose before and after captures match is
now Unchanged ("No visible change"), not Needs review: Explore reports
visual changes. Needs review is left for comparisons that could not tell.
The PR comment's counts and lists, saved runs, report uploads and the agent
API follow, and reports from before this change read the same way: their
"Source changed; no visible difference was captured" verdict is unchanged.

The agent API's screen counts and status filter use the review verdict the
Viewer and comment show (with sourceStatus kept when it differs), so
status=modified means visibly modified.
2026-10-15 16:00:40 -07:00
Brent Vatne 02f470dde4 README: split Set up CI into PR reviews and comparisons
Set up CI now has two subsections, each with a sentence and a prompt:
Review on every PR (the setup prompt) and Compare any two commits (a prompt
that sets up release comparisons, then the ways to snapshot a release). The
PR setup collapsibles are grouped into five, with Hosted previews first and
the setup steps as one ordered Manual setup; Requirements sit collapsed under
the example report; More is now Additional information.

The explore-setup skill gains a "Compare any two commits" section for the
new prompt to follow, and the readme-refresh skill describes the layout.
2026-10-15 15:38:05 -07:00
Brent Vatne a0f192b1d7 README: answer how to explore a release
The comparison section opens with the ways to snapshot a release or release
candidate (on demand from the Actions tab, automatically on every tag, or on
your machine), titled "Explore a release or release candidate, or any two
commits".
2026-10-15 15:24:25 -07:00
Brent Vatne d9137f1647 README: show the reports picker at the top level
Review a change before you push it had been placed between Try it on your
app's prompt and its collapsibles, so two "Run it yourself" sections sat
together. It now follows Try it on your app, with the reports picker image
at the top level of the section instead of inside a collapsible. The
readme-refresh skill's outline says the same.
2026-10-15 14:15:14 -07:00
Brent Vatne 4481b50fc7 Review any two commits, in CI or on your machine (#1)
Adds explore-compare.yml and capture:review --compare for reviews without a PR; local reviews with capture:review (worktrees, local logins, capture cache, local Viewer with the agent API); report:upload and expo-explore reports (saved runs and a terminal picker); and moves the workflows' inline logic into ci:* commands. Release 0.19.0.
2026-10-15 14:01:56 -07:00
58 changed files with 1512 additions and 347 deletions

No files matched your search

+32 -1
View File
@@ -139,12 +139,43 @@ A failure at any stage is recorded in `state.failure`, a partial report is writt
| Source change \ evidence | Differs | Same | Not comparable |
| --- | --- | --- | --- |
| Route added / removed | Added / Removed | Added / Removed | Added / Removed |
| Screen source changed (`screen`) | Modified | Needs review | Needs review |
| Screen source changed (`screen`) | Modified | Unchanged (not counted as a change) | Needs review |
| Only app-wide inputs changed (`app-wide`) | Modified | Unchanged (one line in the PR comment) | Needs review |
| No source change (`none`) | Screen variant (listed apart from Changes) | Unchanged | Unchanged |
A screen whose source changed but whose screenshots were not compared (it is outside the capture scope) has no
verdict: the PR comment does not list it, the agent API reports `not-compared`, and the Viewer marks it Not compared.
Earlier versions listed it as Source-affected. A planned capture that failed is counted as unavailable and named under
Validation.
"Differs" means the screenshots differ or the accessibility tree does. A Modified screen whose screenshots match is
**Accessibility only**: what screen readers and voice control read changed (a label, a role, an element added to the tree)
but nothing shows in the capture. It is still a change: the PR comment counts it apart ("3 visual changes · 12
accessibility only") under 🟦 Accessibility only, the Viewer marks it blue and Compare steps through it, and the agent API
reports `status: "accessibility-only"` with `sourceStatus: "modified"`. The report contract is unchanged (its review
status stays `modified`), so earlier reports read the same way. The accessibility tree can include content outside the
screenshot, such as rows scrolled below the fold or elements under a sheet, so an accessibility-only change is not always
invisible on a device.
A pixel mismatch that rounds to 0.00% is noise and counts as "same". Diff regions inside the status-bar band are excluded from the verdict and reported as `ignoredStatusBarRegions`; the Viewer marks that band in Compare.
Each changed region also records whether its content only moved. CI searches for the shift (up to 20 screenshot
pixels vertically and 4 horizontally, whole pixels and then sixths of one) that best lines Before up with After inside
the region; near-ties go to the smallest move, and a second fit nearly as good two or more pixels away (repeating
content) or a best fit at the edge of the search leaves the region unmeasured. When the shift explains most of the
region's difference (a quarter for a move of half a pixel or less, where text re-rasterizes rather than moves; 60%
above that) and, aligned by it, no more than two pixels still differ by over 140 in any channel, the region gets
`shift: { x, y }` in screenshot pixels (right and down positive). New text, another colour or a caret is not a move.
Every region the comparison found is measured, not only the eight it publishes, and `allRegionsMoved: true` says all
of them moved. Moves are measured while the comparison's time budget lasts.
The Viewer draws moved areas dashed, at each side's own position, labelled with how far they moved to a tenth
("↑4.1pt"); areas whose moves are within a third of each other merge into one outline, never around a changed area.
When every region moved, What changed says how far per direction in place of the generic visual finding, and adds
"Nothing on this screen changed content" when no other finding remains. A switch there turns the labels off. iOS
screenshots are one pixel per point, so labels read in points; Android's are labelled in screenshot pixels, since the
report does not know the screen's density.
## 7. Local CI test
`test/ci/run.mjs` runs the production pipeline against an app folder in this repository (`test/ci/apps/wallet`) and a scenario (`test/ci/scenarios/<app>/<name>/`: `scenario.json`, `overlay/`, `expected.json`, optional `setup.yaml`). The [local CI test harness README](test/ci/README.md) covers prerequisites, scenarios, expectations, the matrix runner and how to revisit a result. In outline:
+111 -106
View File
@@ -9,6 +9,17 @@ Explore maps your app: a screenshot of every screen, connected by the taps betwe
**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.
<details>
<summary><strong>Requirements</strong></summary>
- An iOS app, an Android app, or both. Explore is in v0; Android capture is newer than iOS.
- Expo SDK 57 or newer, with Expo Router (57 or newer) or React Navigation (6 or newer).
- An EAS build profile per platform: `ios.simulator: true` for iOS, `android.buildType: apk` for Android. Its EAS environment cannot have secret-visibility variables.
- EAS Simulator access (in preview, [join the waitlist](https://expo.dev/services/simulators)).
- Node.js 24.12 or newer, and admin access to the GitHub repository.
</details>
## Try it on your app
Paste this into Claude Code or Codex from your app's directory. It explores a build you point to, or an Expo project straight from its source:
@@ -25,40 +36,6 @@ need to log in to something first, tell me the command.
For apps behind a sign-in, see [Sign-in and other app state](#sign-in-and-other-app-state).
### Review a change before you push it
Once Explore is [set up](#set-up-ci-reviews-on-every-pr) (`.expo-explore/config.yaml` committed), the review a PR gets also runs on your machine, between any two commits. No tokens or keys to set: it uses your `eas login` and your Claude Code or Codex login.
```text
Review my current changes with Expo Explore. Follow the "Review a change on this machine"
section of https://unpkg.com/@expo/explore/skills/explore-setup/SKILL.md, compare my
branch (with my uncommitted changes) against main, and open the report.
```
<details>
<summary><strong>Run it yourself</strong></summary>
```sh
npx @expo/explore capture:review # HEAD against where it left the default branch
npx @expo/explore capture:review --uncommitted # your uncommitted changes too
npx @expo/explore capture:review --base v1.3.0 --head v1.4.0 --scope all --upload
```
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform on EAS Simulator (`--platform` picks one), and opens the report in a local Viewer. `--upload` hosts it and prints the link; `report:upload <report.zip>` hosts one you already have.
- Your checkout, index and branches are never touched. `--uncommitted` takes tracked changes only; `--include-untracked` adds untracked files, which are uploaded with the EAS build.
- It runs both commits' code on your machine, as you: installing their dependencies, evaluating the app config, and bundling the JavaScript. That is what checking them out and running them would do, so review only commits you would run, and someone else's branch only if you trust it.
- Installs run without credential environment variables, which keeps tokens out of reach of a registry a commit's `.npmrc` names; that is not a sandbox. A registry that needs `${NPM_TOKEN}` in the project's `.npmrc` must be authenticated in your own `~/.npmrc`.
- Captures are cached in `~/.cache/expo-explore`, so the same base is not captured twice (`--no-cache` skips it); a capture unused for 30 days goes, and the cache stays under 2 GB. Ctrl+C stops the run's simulator sessions.
- Like a CI review, it builds on EAS (reusing a matching build) and runs simulator sessions: expect several minutes and EAS usage.
- Every run is kept for 30 days (up to 2 GB in all): `npx @expo/explore reports` lists your local reviews, explorations and uploaded reports with their commits, and opens or hosts one without capturing again. `reports add <report.zip>` keeps a report you downloaded, such as a PR's `explore-review` artifact.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-reports-dark.png">
<img alt="npx @expo/explore reports in a terminal: the Expo Explore wordmark, then one line per saved run (a local review of HEAD vs main selected, an exploration of an app, and PR #1), and below them the selected run's head and base commits with their messages and its 13 modified, 2 added, 2 removed and 17 need-review screens" src="docs/screenshots/readme-reports-light.png">
</picture>
</details>
<details>
<summary><strong>Run it yourself</strong></summary>
@@ -104,15 +81,55 @@ npx @expo/explore explore:session <session-id> --env-file path/.env.eas-simulato
<details>
<summary><strong>What a run without source shows</strong></summary>
One card per screen the run reached, laid out by how many taps it took, with the tapped control on each edge. There is no before and after; that needs [CI](#set-up-ci-reviews-on-every-pr).
One card per screen the run reached, laid out by how many taps it took, with the tapped control on each edge. There is no before and after; that needs [CI](#set-up-ci).
![The Map of an exploration report for the euxy app: one card per screen the run reached, laid out by taps from the launch screen, each edge labelled with the control that was tapped](docs/screenshots/readme-exploration-light.png)
</details>
## Set up CI: reviews on every PR
### Review a change before you push it
Paste this into Claude Code or Codex from your app's repository:
Once Explore is [set up](#set-up-ci) (`.expo-explore/config.yaml` committed), the review a PR gets also runs on your machine, between any two commits. No tokens or keys to set: it uses your `eas login` and your Claude Code or Codex login.
```text
Review my current changes with Expo Explore. Follow the "Review a change on this machine"
section of https://unpkg.com/@expo/explore/skills/explore-setup/SKILL.md, compare my
branch (with my uncommitted changes) against main, and open the report.
```
Every run is kept on your machine for 30 days. `npx @expo/explore reports` lists your local reviews, explorations and uploaded reports with their commits, and reopens or hosts one without capturing again:
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-reports-dark.png">
<img alt="npx @expo/explore reports in a terminal: the Expo Explore wordmark, then one line per saved run (a local review of HEAD vs main selected, an exploration of an app, and PR #1), and below them the selected run's head and base commits with their messages and its 13 modified, 2 added, 2 removed and 17 need-review screens" src="docs/screenshots/readme-reports-light.png">
</picture>
<details>
<summary><strong>Run it yourself</strong></summary>
```sh
npx @expo/explore capture:review # HEAD against where it left the default branch
npx @expo/explore capture:review --uncommitted # your uncommitted changes too
npx @expo/explore capture:review --base v1.3.0 --head v1.4.0 --scope all --upload
```
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform on EAS Simulator (`--platform` picks one), and opens the report in a local Viewer. `--upload` hosts it and prints the link; `report:upload <report.zip>` hosts one you already have.
- Your checkout, index and branches are never touched. `--uncommitted` takes tracked changes only; `--include-untracked` adds untracked files, which are uploaded with the EAS build.
- It runs both commits' code on your machine, as you: installing their dependencies, evaluating the app config, and bundling the JavaScript. That is what checking them out and running them would do, so review only commits you would run, and someone else's branch only if you trust it.
- Installs run without credential environment variables, which keeps tokens out of reach of a registry a commit's `.npmrc` names; that is not a sandbox. A registry that needs `${NPM_TOKEN}` in the project's `.npmrc` must be authenticated in your own `~/.npmrc`.
- Captures are cached in `~/.cache/expo-explore`, so the same base is not captured twice (`--no-cache` skips it); a capture unused for 30 days goes, and the cache stays under 2 GB. Ctrl+C stops the run's simulator sessions.
- Like a CI review, it builds on EAS (reusing a matching build) and runs simulator sessions: expect several minutes and EAS usage.
- Saved runs take up to 2 GB in all, the oldest going first. `reports add <report.zip>` keeps a report you downloaded, such as a PR's `explore-review` artifact.
</details>
## Set up CI
Explore runs in your repository's GitHub Actions in two ways, both from the same setup: a review on every pull request, and a comparison of any two commits, such as a release against the last one.
### Review on every PR
Each pull request gets a comment linking its report: the screens it added, removed or changed, before and after, on each platform you capture. Paste this into Claude Code or Codex from your app's repository:
```text
Set up this app for Expo Explore CI reviews. Follow
@@ -124,45 +141,45 @@ what to merge and how to start the first review.
```
<details>
<summary><strong>Requirements</strong></summary>
<summary id="hosted-previews"><strong>Hosted previews</strong></summary>
- An iOS app, an Android app, or both. Explore is in v0; Android capture is newer than iOS.
- Expo SDK 57 or newer, with Expo Router (57 or newer) or React Navigation (6 or newer).
- An EAS build profile per platform: `ios.simulator: true` for iOS, `android.buildType: apk` for Android. Its EAS environment cannot have secret-visibility variables.
- EAS Simulator access (in preview, [join the waitlist](https://expo.dev/services/simulators)).
- Node.js 24.12 or newer, and admin access to the GitHub repository.
By default reviewers download the report from GitHub. With hosted previews, the comment's **Explore report** link opens it in one click, even in private repositories.
```yaml
report:
preview:
hosting: eas # default: off
expiresAfter: 30d # default 30d, max 365d, or never
# project: acme-explore # default <repository name>-explore, created on first run
```
- Run `expo-explore setup --workflows` after enabling it to add the `deploy` job.
- A [comparison of two commits](#compare-any-two-commits) links its hosted report from the run's summary instead of a PR comment. `capture:review --upload` on your machine deploys to the same project with your `eas login`.
- `expo-explore report:upload <report.zip>...` hosts reports already on your machine the same way: a review's reports (one per platform, from `capture:review --output` or a downloaded `explore-review` artifact) or an `explore:binary` report.
- `EXPO_TOKEN` must be able to create the EAS project, so use a [robot user's](https://docs.expo.dev/accounts/programmatic-access/) token.
- The report is encrypted, and only a request carrying the link's token can open it. Treat the link like a shared file link; see [report access](docs/private-review.md#hosted-previews).
</details>
<details>
<summary><strong>After setup: your first review</strong></summary>
<summary><strong>Manual setup</strong></summary>
1. Set the repository secrets that `expo-explore doctor` lists, such as `EXPO_TOKEN`.
2. Merge the setup to the default branch and run **Expo Explore baseline** from GitHub Actions.
3. Open a PR. **Expo Explore review** runs and posts a comment with the report.
The prompt above walks through these steps with you. To do them yourself:
```sh
expo-explore doctor # check every step; exits 1 until ready
expo-explore doctor --capture # capture the committed app on EAS once, before the first PR
expo-explore capture:review # or see a whole review of your branch on this machine first
```
1. Run `npx @expo/explore setup` in your app's directory (in a monorepo, add `--project apps/mobile`). It writes `.expo-explore/config.yaml` and the workflows.
2. Run `npx @expo/explore doctor` and fix each problem it reports, until it exits 0. `doctor --capture` captures the committed app on EAS once, to check every screen before your first PR.
3. Set the repository secrets `doctor` lists:
- `EXPO_TOKEN`: create it in [Expo access tokens](https://expo.dev/settings/access-tokens). For [hosted previews](#hosted-previews), use a [robot user](https://docs.expo.dev/accounts/programmatic-access/) that can create projects.
- A secret for each `{{secret:NAME}}` in your setup steps. Run `npx @expo/explore setup --workflows` after you add one.
4. Commit, merge to the default branch, and run **Expo Explore baseline** from GitHub Actions.
5. Open a PR. **Expo Explore review** runs and posts a comment with the report. To see a whole review of your branch first, run `npx @expo/explore capture:review` on your machine.
A failed run shows an error code and a next action in the PR comment; see [CI troubleshooting](docs/quickstart-ci.md#diagnose-a-failed-run).
</details>
<details>
<summary><strong>Set up without a coding agent</strong></summary>
```sh
npx @expo/explore setup # writes .expo-explore/config.yaml and the workflows; in a monorepo: --project apps/mobile
npx @expo/explore doctor # fix each problem it reports, then commit
```
</details>
<details>
<summary><strong>Choose a capture mode</strong></summary>
<summary><strong>Capture modes: deterministic or agent</strong></summary>
| | **Deterministic** (recommended to start) | **Agent** |
| --- | --- | --- |
@@ -173,10 +190,7 @@ npx @expo/explore doctor # fix each problem it reports, then commit
Both modes use the same comparison rules and report. You can change modes later.
</details>
<details>
<summary><strong>Configure agent mode</strong></summary>
**To use agent mode:**
1. Create an [Anthropic](https://platform.claude.com/settings/keys) or [OpenAI](https://platform.openai.com/api-keys) API key.
2. Set `mode: agent` and an `agent.model` your account can use.
@@ -188,15 +202,7 @@ The model navigates and recovers on each uncaptured revision; see [agent usage](
</details>
<details>
<summary><strong>Repository settings</strong></summary>
- `EXPO_TOKEN`: create it in [Expo access tokens](https://expo.dev/settings/access-tokens). For [hosted previews](#hosted-previews), use a [robot user](https://docs.expo.dev/accounts/programmatic-access/) that can create projects.
- A secret for each `{{secret:NAME}}` in your setup steps. Run `expo-explore setup --workflows` after you add one.
</details>
<details>
<summary id="platforms"><strong>Android and several platforms</strong></summary>
<summary id="platforms"><strong>iOS, Android, or both</strong></summary>
`app.platform` names the primary platform, and a `platforms` map adds the other. Each entry can set its own `device`, `bundleId`, and `easProfile`.
@@ -222,28 +228,36 @@ platforms:
</details>
<details>
<summary id="hosted-previews"><strong>Hosted previews</strong></summary>
<summary><strong>Keep your setup current</strong></summary>
By default reviewers download the report from GitHub. With hosted previews, the comment's **Explore report** link opens it in one click, even in private repositories.
```yaml
report:
preview:
hosting: eas # default: off
expiresAfter: 30d # default 30d, max 365d, or never
# project: acme-explore # default <repository name>-explore, created on first run
```
- Run `expo-explore setup --workflows` after enabling it to add the `deploy` job.
- A [comparison of two commits](#compare) links its hosted report from the run's summary instead of a PR comment. `capture:review --upload` on your machine deploys to the same project with your `eas login`.
- `expo-explore report:upload <report.zip>...` hosts reports already on your machine the same way: a review's reports (one per platform, from `capture:review --output` or a downloaded `explore-review` artifact) or an `explore:binary` report.
- `EXPO_TOKEN` must be able to create the EAS project, so use a [robot user's](https://docs.expo.dev/accounts/programmatic-access/) token.
- The report is encrypted, and only a request carrying the link's token can open it. Treat the link like a shared file link; see [report access](docs/private-review.md#hosted-previews).
- A PR that adds a guarded screen or a dynamic route should also update `config.yaml`.
- Renamed identifiers or labels break deterministic setup steps.
- To update Explore, run `npx @expo/explore@latest setup --workflows` and commit the new version. It also adds `explore-compare.yml` if you don't have it, and `doctor` warns when it is missing.
</details>
### Compare any two commits
A release, a release candidate, a nightly: any two branches, tags or commits, reviewed like a PR without one, with the report linked from the run's summary. Once CI reviews PRs, paste this into Claude Code or Codex:
```text
Set up Expo Explore to review this app's releases. Follow the "Compare any two commits"
section of https://unpkg.com/@expo/explore/skills/explore-setup/SKILL.md: make sure
explore-compare.yml is installed, add a workflow that compares each release tag (and
release candidate) with the last stable release, then run it once on the latest tag and
give me the report link.
```
There are a few ways to snapshot a release:
- **On demand:** in your repository's Actions tab, open **Expo Explore compare**, choose **Run workflow**, and set `base` to the last release's tag (`v1.3.0`), `head` to the new tag or release candidate (`v1.4.0-rc.1`), `scope` to `all` and `expires-in` to `never`. The run's summary links the report.
- **Automatically, on every tag:** add the `release-review.yml` in [The comparison workflow](#compare) below. It compares each tag, release candidates included, with the last stable tag, so a release candidate is reviewed against what people have now.
- **On your machine, without CI:** `npx @expo/explore capture:review --base v1.3.0 --head v1.4.0 --scope all --upload`, with your `eas login`. `npx @expo/explore reports` lists the runs you have kept.
`scope: all` captures every screen, not only those whose source changed, so the report shows the whole release with what changed since the last one marked; `expires-in: never` keeps its link.
<details>
<summary id="compare"><strong>Review any two commits: releases, nightlies, any event</strong></summary>
<summary id="compare"><strong>The comparison workflow</strong></summary>
`.github/workflows/explore-compare.yml` reviews a `head` against a `base`, each a branch, tag or commit SHA, with no pull request. It captures, compares and reports exactly like a PR review, and links the report from the run's summary.
@@ -280,21 +294,12 @@ jobs:
- Pick whatever `base` the event calls for: `main` for a release branch, yesterday's tag for a nightly, the last stable tag for a release candidate.
- `scope` and `expires-in` are optional and override `exploration.scope` and `report.preview.expiresAfter` for that run. Without them a comparison captures what a PR review would (`scope: changes` captures only screens whose source changed), and the hosted link expires like a PR's.
- The run summary links each platform's report (**Open** and **zip**, like a PR comment) and, with hosting, the hosted report.
- `setup --workflows` installs it. The caller grants `contents: read` and `actions: read`; `secrets: inherit` passes `EXPO_TOKEN` and any app-test secrets.
- `setup --workflows` installs it from 0.19.0; `npx @expo/explore@latest setup --workflows` adds it to an existing setup. The caller grants `contents: read` and `actions: read`; `secrets: inherit` passes `EXPO_TOKEN` and any app-test secrets.
- Call it once per workflow run. A called workflow runs inside its caller's run, so a second call in the same run would reuse the first one's artifact names; use separate workflows instead.
- When the baseline workflow captured `base` in the last 30 days, that capture is reused and only `head` is captured. The report artifact is kept 30 days; only a hosted link with `expires-in: never` lasts longer.
</details>
<details>
<summary><strong>Keep your setup current</strong></summary>
- A PR that adds a guarded screen or a dynamic route should also update `config.yaml`.
- Renamed identifiers or labels break deterministic setup steps.
- To update Explore, run `npx @expo/explore@latest setup --workflows` and commit the new version. It also adds `explore-compare.yml` if you don't have it, and `doctor` warns when it is missing.
</details>
## Sign-in and other app state
Each run starts on a fresh install. Tell Explore how to get past what the app needs: with `--hints` when running without source, or with [setup steps or agent instructions](docs/quickstart-ci.md#when-the-config-needs-setup-steps) in CI.
@@ -382,7 +387,7 @@ The same link answers differently depending on who asks. It already carries the
- A browser gets the Viewer.
- Anything that does not ask for HTML (`curl`, `fetch`, agents' URL tools) gets a Markdown index of the report, also at `/llms.txt`.
- The index links to a read-only JSON API under `/api/v1`: `/screens?status=modified,added,removed`, `/screens/<id>`, `/transitions`, and `/raw` for the report file.
- The index links to a read-only JSON API under `/api/v1`: `/screens?status=modified,accessibility-only,added,removed`, `/screens/<id>`, `/transitions`, and `/raw` for the report file.
- Reports without source also expose `/journeys`, `/gaps`, and `/frontier`.
- Multi-platform reports take `?platform=ios|android`. Expired links answer `410`.
@@ -392,7 +397,7 @@ curl -s "$LINK/api/v1/screens?status=modified" | jq '.items[] | {route, status,
</details>
## More
## Additional information
<details>
<summary><strong>How it works</strong></summary>
@@ -403,7 +408,7 @@ curl -s "$LINK/api/v1/screens?status=modified" | jq '.items[] | {route, status,
4. It compares the captures. A screen with a source change is **Modified** if its captures differ.
5. It uploads the report to GitHub Actions and posts a PR comment.
The same review runs for any two commits without a PR ([`explore-compare.yml`](#compare), linking the report from the run summary) and on your machine (`capture:review`, [above](#review-a-change-before-you-push-it)). The workflows' logic lives in `expo-explore ci:*` commands, so a fix reaches CI with the `@expo/explore` version the workflows pin.
The same review runs for any two commits without a PR ([`explore-compare.yml`](#compare-any-two-commits), linking the report from the run summary) and on your machine (`capture:review`, [above](#review-a-change-before-you-push-it)). The workflows' logic lives in `expo-explore ci:*` commands, so a fix reaches CI with the `@expo/explore` version the workflows pin.
Reports and baselines are kept for 30 days and diagnostics for 7. Hosted deployments are never deleted automatically; see [report access](docs/private-review.md).
+12 -5
View File
@@ -164,7 +164,7 @@ imported source changed), `app-wide` (only app-wide inputs such as dependencies,
| Source \ Evidence | Differs | No visible difference | Inconclusive |
| --- | --- | --- | --- |
| Added / removed route | Added / Removed | Added / Removed | Added / Removed |
| Screen source changed | Modified | Needs review | Needs review |
| Screen source changed | Modified | Unchanged (not counted as a change) | Needs review |
| Only app-wide inputs changed | Modified | Unchanged (the PR comment names the app-wide change once) | Needs review |
| Source unchanged | Screen variant | Unchanged | Unchanged |
@@ -172,13 +172,20 @@ imported source changed), `app-wide` (only app-wide inputs such as dependencies,
| --- | --- |
| Added / Removed | Route presence differs between source inventories |
| Modified | The screen's source changed and comparable evidence differs |
| Needs review | The screen's source changed but no visible difference was captured, or its evidence is inconclusive; still a review target |
| Accessibility only | Modified, but the screenshots match: only the accessibility tree (what screen readers and voice control read) differs. Counted as a change and listed apart from the visual ones |
| Needs review | The screen's source changed and the comparison could not tell whether it looks different; a review target |
| Screen variant | No source change reaches the screen, but its captures differ in runtime UI state (balances, timestamps, loaded content). Listed apart from changes |
| Source-affected | Source impact without a comparison |
| Unchanged | No visible difference and no screen-specific source change |
| Not compared | No comparison was performed |
| Unchanged | No visible difference, whether or not the screen's source changed. Explore reports visual changes; reports before 0.19.1 called a source change with no visible difference Needs review |
| Not compared | No comparison was performed, including for a screen whose source changed. Not counted as a change: Explore reports what the captures show, not what the code might do. Earlier versions listed these as Source-affected |
A difference that rounds to 0.00% of pixels is rendering noise and counts as no difference.
A changed region whose content only moved (a layout that grew by a device pixel, a sheet that is taller) carries
`shift`, how far it moved in screenshot pixels, and `allRegionsMoved: true` says every region CI found moved (it
publishes the largest eight); the Viewer labels each outline with its move. A shift does not change the verdict: a
moved screen is still Modified.
Accessibility only is how readers present a `modified` verdict whose visual verdict is `unchanged`; the contract has no
separate status for it, so reports from earlier versions show it too. The accessibility tree can include content outside
the screenshot (rows below the fold, elements under a sheet), so such a change may still be visible on a device.
A runtime difference is not proof that the code change caused it. Deterministic mode uses template notes and evidence facts. Agent mode adds AI explanations from the captured evidence and source changes through a separate CLI session; those explanations cannot override fixed verdicts. Structural flows describe possible source navigation; semantic business grouping remains deferred.
## Artifacts and cache
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@expo/explore",
"version": "0.19.0",
"version": "0.19.3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.19.0",
"version": "0.19.3",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.19.0",
"version": "0.19.3",
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
"license": "MIT",
"type": "module",
+10
View File
@@ -170,6 +170,16 @@ npx @expo/explore capture:review --base v1.3.0 --head v1.4.0 --scope all
- Captures are cached in `~/.cache/expo-explore`, so a second review of the same base does not capture it again (`--no-cache` skips the cache). Ctrl+C stops the EAS Simulator sessions the review started.
- It builds on EAS and runs simulator sessions, like a CI review: expect several minutes and EAS usage per run.
## Compare any two commits
`explore-compare.yml` (installed by `setup --workflows` from 0.19.0; run `npx @expo/explore@latest setup --workflows` to add it to an existing setup) reviews a `head` against a `base`, each a branch, tag or commit SHA, with no pull request. It captures, compares and reports like a PR review and links the report from the run's summary. Its inputs are `base`, `head`, and the optional `scope` (`changes` or `all`) and `expires-in` (such as `30d`, or `never`).
- **Releases.** Unless the user asks otherwise, compare each release with the last stable release, with `scope: all` (every screen, so the report shows the whole release with what changed marked) and, when hosted previews are on, `expires-in: never` (the link outlives the 30-day artifact). For every tag as it is pushed, add the `release-review.yml` from the README's "Compare any two commits" section: it finds the newest earlier tag without a `-` (so a release candidate is compared with the last stable release) and calls `explore-compare.yml` with `secrets: inherit` and `permissions: { contents: read, actions: read }`. A nightly compares with yesterday's tag; a release branch with `main`.
- **Once, on demand.** The workflow must be on the default branch to be dispatched: `gh workflow run explore-compare.yml -f base=<ref> -f head=<ref> -f scope=all -f expires-in=never`, or **Run workflow** under Actions → Expo Explore compare.
- **Without CI.** `npx @expo/explore capture:review --base <ref> --head <ref> --scope all --upload` runs the same comparison on this machine (see the previous section).
- Call the workflow once per workflow run (a second call in the same run reuses the first one's artifact names). A `base` the baseline workflow captured in the last 30 days is reused, so only `head` is captured.
- To verify, run it once on the latest tag and open the run's summary: it lists each platform's result and links the report.
## Learn from observed failures
When revising an existing setup, read the previous run's diagnostics, navigation trace and screenshots together. Separate an app prerequisite or defect from a controller failure and a provider or configuration failure. A successful tool response alone does not prove recovery: check the field value, destination, or visible content. For agent mode, inspect `agent-usage.jsonl` before proposing another paid run; missing accounting is unknown, not zero, and dollar fields are estimates. Respect exhausted credit and requests to stop paid calls.
+3 -3
View File
@@ -60,11 +60,11 @@ Look at every PNG you produced before committing, light and dark: the selected s
Read the README top to bottom once without opening a collapsible. At that level it may only answer, in this order:
1. What Explore is (one short paragraph), the hero image, and the link to the live euxy example (`explore-example--euxy.expo.app`, redeployed on every merge to main by `.github/workflows/example-report.yml`).
2. **Try it on your app**: one sentence and a prompt to paste into Claude Code or Codex that gets a simulator build of any app (Expo or not, or just a build) and runs `explore:binary` on it. Under it, **Review a change before you push it**: one sentence and a prompt that runs `capture:review` locally (the explore-setup skill's "Review a change on this machine" section) on a set-up app.
3. **Set up CI: reviews on every PR**: one sentence and the setup prompt.
2. **Try it on your app**: one sentence and a prompt to paste into Claude Code or Codex that gets a simulator build of any app (Expo or not, or just a build) and runs `explore:binary` on it. After its collapsibles, **Review a change before you push it**: one sentence, a prompt that runs `capture:review` locally (the explore-setup skill's "Review a change on this machine" section) on a set-up app, and the `reports` picker image (`readme-reports-*.png`) with one sentence on saved runs, at the top level, not inside a collapsible. Each section keeps its own "Run it yourself"; never put one section between another's prompt and its collapsibles.
3. **Set up CI**: one sentence, then two subsections, each a sentence on what it gives and a prompt to paste: **Review on every PR** (the setup prompt, then a few grouped collapsibles: Hosted previews first, then Manual setup (the setup prompt's steps done by hand, in order: setup, doctor, secrets, baseline, first PR), Capture modes: deterministic or agent, iOS, Android, or both, Keep your setup current) and **Compare any two commits** (a prompt that follows the explore-setup skill's "Compare any two commits" section, the ways to snapshot a release as bullets, then the comparison workflow collapsed).
4. **What you get**: the PR comment, Compare, and Screens, each a heading, one line, and its picture, then a prompt for asking an agent about a report.
Lead with prompts, not explanations: a reader should be able to copy something and see Explore work. Everything else, the manual commands, requirements, options, the manual setup, capture modes, hosted previews, several platforms, agent mode, repository settings, how agents read a report, how it works, limitations, contributing, goes into a `<details>` block under the section it belongs to, with a `<summary>` that says what the reader will find. Keep bullets to one or two sentences. Keep the collapsibles' `id` attributes that other docs link to (`#hosted-previews`, `#platforms`, `#agents`), and keep the Inspiration section (screenmap and Revyl's Atlas).
Lead with prompts, not explanations: a reader should be able to copy something and see Explore work. Everything else, the manual commands, requirements, options, the manual setup, capture modes, hosted previews, iOS and Android, agent mode, repository settings, how agents read a report, how it works, limitations, contributing, goes into a `<details>` block under the section it belongs to, with a `<summary>` that says what the reader will find. Keep bullets to one or two sentences. Group related collapsibles rather than adding one per topic, so a section shows a handful, not nine. Requirements sit collapsed right under the example report link. Keep the collapsibles' `id` attributes that other docs link to (`#hosted-previews`, `#platforms`, `#compare`, `#agents`), and keep the Inspiration section (screenmap and Revyl's Atlas).
Check that each prompt still works as written:
- the skill links it names (`https://unpkg.com/@expo/explore/skills/...`) are files the package ships (`files` in `package.json`), and they open from the published release;
+2 -2
View File
@@ -88,8 +88,8 @@ export function visibleRuns(state: PickerState): SavedRun[] {
function counts(run: SavedRun, paint: Paint): string {
if (run.explored) return `${paint.text(String(run.explored.screens))} ${paint.dim("screens")} ${paint.dim(`${run.explored.unexplored} unexplored`)}`;
const parts = ([["modified", paint.amber, "modified"], ["added", paint.green, "added"], ["removed", paint.red, "removed"], ["needs-review", paint.yellow, "need review"],
["source-affected", paint.yellow, "source-affected"]] as const)
const parts = ([["modified", paint.amber, "modified"], ["accessibility-only", paint.blue, "accessibility only"], ["added", paint.green, "added"], ["removed", paint.red, "removed"],
["needs-review", paint.yellow, "need review"]] as const)
.filter(([group]) => run.changes?.[group]).map(([group, colour, label]) => `${colour(String(run.changes![group]))} ${paint.dim(label)}`);
return parts.length ? parts.join(" ") : paint.dim("no visible changes");
}
+10
View File
@@ -172,8 +172,18 @@ export type PublicVisualVerdict = {
rect: { x: number; y: number; width: number; height: number };
normalizedRect: { x: number; y: number; width: number; height: number };
differentPixels: number; shareOfDiffPercentage: number; dominantChange: string; location: string;
/**
* Set when the region's content is the same in both screenshots, only moved: how far, in screenshot pixels
* (right and down are positive). Absent when the content itself changed.
*/
shift?: { x: number; y: number };
}>;
tool: string;
/**
* Every region the comparison found (not only the published ones) only moved: nothing on the screen changed
* 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. */
ignoredStatusBarRegions?: number;
/** Diff regions that lay entirely inside the home-indicator band and were left out of the verdict. */
+27 -2
View File
@@ -8,12 +8,13 @@ const REVIEW_STATUSES = new Set(["added", "modified", "removed", "unchanged", "n
const SOURCE_SCOPES = new Set(["screen", "app-wide", "none"]);
/** Verdicts each source scope allows: only a source change makes a screen a review target. */
const SCOPE_VERDICTS: Record<string, readonly string[]> = {
screen: ["modified", "needs-review"],
screen: ["modified", "needs-review", "unchanged"],
"app-wide": ["modified", "needs-review", "unchanged"],
none: ["unchanged", "variant"],
};
const VISUAL_VERDICTS = new Set(["unchanged", "modified", "needs-review"]);
const MAX_REVIEW_DESCRIPTION = 160;
const LEGACY_NO_VISIBLE_DIFFERENCE = "Source changed; no visible difference was captured.";
/** Source analysis belongs to capture planning; delivered reports contain runtime review evidence. */
/** Capture shrinks the app icon to at most this many pixels on a side. */
@@ -31,6 +32,14 @@ function hasVerifiedPair(surface: Surface): boolean {
&& surface[`${side}Outcome`]?.landing === "verified");
}
/**
* A modified screen whose verified screenshots match: only what assistive technology reads (its accessibility tree)
* changed. Screen readers and voice control see it, so it is a change to review, listed apart from the visual ones.
*/
export function isAccessibilityOnlyChange(surface: Surface): boolean {
return surface.review?.status === "modified" && surface.visual?.verdict === "unchanged" && hasVerifiedPair(surface);
}
function assertReviewFields(surface: Surface, enforceComparisonEvidence: boolean): void {
const assertVerifiedPair = () => {
if (enforceComparisonEvidence && !hasVerifiedPair(surface)) {
@@ -66,13 +75,23 @@ 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. */
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;
}
function assertVisualVerdict(visual: PublicVisualVerdict, enforceComparisonEvidence: boolean, paired: boolean): void {
if (!visual || typeof visual !== "object" || !VISUAL_VERDICTS.has(visual.verdict)
|| typeof visual.reason !== "string" || (enforceComparisonEvidence && visual.reason === "diff-failed") || typeof visual.tool !== "string"
|| typeof visual.threshold !== "number" || !Number.isFinite(visual.threshold)
|| (visual.mismatchPercentage !== undefined
&& (typeof visual.mismatchPercentage !== "number" || !Number.isFinite(visual.mismatchPercentage) || visual.mismatchPercentage < 0))
|| (visual.regions !== undefined && (!Array.isArray(visual.regions) || visual.regions.length > 64))
|| (visual.regions !== undefined && (!Array.isArray(visual.regions) || visual.regions.length > 64
|| visual.regions.some(region => region?.shift !== undefined && !validShift(region.shift))))
|| (visual.allRegionsMoved !== undefined && (visual.allRegionsMoved !== true || !visual.regions?.length
|| visual.regions.some(region => region.shift === undefined)))
|| !paired) {
throw new Error("Public visual verdict is inconsistent");
}
@@ -207,6 +226,12 @@ export function normalizePublicReviewForReading(review: PublicReview, onGap?: (g
surface = { ...surface, review: { ...surface.review, status: "variant",
description: description.length > MAX_REVIEW_DESCRIPTION ? `${description.slice(0, MAX_REVIEW_DESCRIPTION - 1)}…` : description } };
}
// Reports before 0.19.1 called a screen whose source changed but whose captures matched "needs review". It has no
// visible change, so it reads as unchanged and is not counted as a change.
if (surface.review?.status === "needs-review" && surface.review.description === LEGACY_NO_VISIBLE_DIFFERENCE) {
changed = true;
surface = { ...surface, review: { ...surface.review, status: "unchanged", description: "No visible change" } };
}
const comparisonVerdict = surface.review && surface.review.status !== "added" && surface.review.status !== "removed";
if (!((!hasVerifiedPair(surface) && (comparisonVerdict || surface.visual)) || surface.visual?.reason === "diff-failed")) return surface;
changed = true;
+54 -6
View File
@@ -98,7 +98,8 @@ function reviewSurfaceItem(context: AgentContext, surface: Json): Json {
const visual = rec(surface.visual), review = rec(surface.review);
const id = str(surface.id) ?? "";
return defined({
id, route: str(route.route), kind: str(route.kind), routeFile: str(route.routeFile), status: str(surface.status), colorScheme: str(surface.colorScheme),
id, route: str(route.route), kind: str(route.kind), routeFile: str(route.routeFile), status: verdictOf(surface),
sourceStatus: verdictOf(surface) === str(surface.status) ? undefined : str(surface.status), colorScheme: str(surface.colorScheme),
review: surface.review === undefined ? undefined : defined({ status: str(review.status), description: str(review.description), facts: arr(review.facts).map(fact => str(rec(fact).bullet)).filter(Boolean) }),
visual: surface.visual === undefined ? undefined : defined({ verdict: str(visual.verdict), reason: str(visual.reason), mismatchPercentage: num(visual.mismatchPercentage), threshold: num(visual.threshold) }),
note: str(rec(surface.note).text),
@@ -120,10 +121,57 @@ function reviewSurfaceDetail(context: AgentContext, review: Json, surface: Json)
}
const edgeItem = (edge: Json): Json => defined({ from: str(edge.from), to: str(edge.to), kind: str(edge.kind), sourceFile: str(edge.sourceFile), provenance: str(edge.provenance) });
/**
* A screen's status as the Viewer and the PR comment show it: the review's verdict where there is one, so `modified`
* 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`.
*/
/** Both sides captured at their verified destination route, as a verdict requires (isAccessibilityOnlyChange in the contract). */
function verifiedPair(surface: Json): boolean {
return (["base", "head"] as const).every(side => str(rec(surface[side]).kind) === "screen" && Boolean(surface[`${side}Image`])
&& str(rec(surface[`${side}Outcome`]).status) === "captured" && str(rec(surface[`${side}Outcome`]).landing) === "verified");
}
/** The side's planned capture ended without a screenshot, or captured another screen than the route (the Viewer's Unavailable). */
function captureUnavailable(surface: Json, side: "base" | "head"): boolean {
const outcome = surface[`${side}Outcome`];
if (str(rec(surface[side]).kind) !== "screen" || outcome === undefined) return false;
const image = Boolean(surface[`${side}Image`]);
if (!image) return str(rec(outcome).status) !== "captured";
return str(rec(outcome).status) === "captured" && str(rec(outcome).landing) !== "verified" && rec(outcome).observed !== undefined;
}
function verdictOf(surface: Json): string | undefined {
// 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";
const review = rec(surface.review);
const status = str(review.status);
if (status === "needs-review" && str(review.description) === "Source changed; no visible difference was captured.") return "unchanged";
if (status === "modified" && str(rec(surface.visual).verdict) === "unchanged" && verifiedPair(surface)) return "accessibility-only";
// A source change nobody compared is not a change Explore saw.
if (status === undefined && str(surface.status) === "modified") return "not-compared";
return status ?? str(surface.status);
}
const STATUS_ORDER = ["modified", "accessibility-only", "added", "removed", "needs-review", "unavailable", "not-compared", "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" };
/** "3 modified, 1 added, 1 removed, 30 unchanged": every status counted, so the parts add up to the total. */
function screenCounts(screens: Json): string {
const statuses = Object.keys(screens).filter(status => status !== "total")
.sort((left, right) => (STATUS_ORDER.indexOf(left) + 1 || 99) - (STATUS_ORDER.indexOf(right) + 1 || 99));
const parts = statuses.flatMap(status => (num(screens[status]) ? [`${num(screens[status])} ${STATUS_WORDS[status] ?? status}`] : []));
return parts.length ? parts.join(", ") : "none";
}
function reviewSummary(context: AgentContext, review: Json): Json {
const surfaces = arr(review.surfaces).map(rec);
const counts: Record<string, number> = {};
for (const surface of surfaces) { const status = str(surface.status) ?? "unknown"; counts[status] = (counts[status] ?? 0) + 1; }
for (const surface of surfaces) { const status = verdictOf(surface) ?? "unknown"; counts[status] = (counts[status] ?? 0) + 1; }
const pr = rec(review.pullRequest), runtime = rec(review.runtime);
return defined({
kind: "pr-review", api: AGENT_API_VERSION, contract: str(review.contract),
@@ -132,7 +180,7 @@ function reviewSummary(context: AgentContext, review: Json): Json {
createdAt: str(review.createdAt), mode: str(review.mode), platforms: context.platforms, expiresAt: context.expiresAt,
screens: { total: surfaces.length, ...counts },
links: {
screens: withPlatform(context, apiUrl(context, "/screens")), changed: withPlatform(context, apiUrl(context, "/screens?status=modified,added,removed")),
screens: withPlatform(context, apiUrl(context, "/screens")), changed: withPlatform(context, apiUrl(context, "/screens?status=modified,accessibility-only,added,removed")),
transitions: withPlatform(context, apiUrl(context, "/transitions")), raw: withPlatform(context, apiUrl(context, "/raw")),
viewer: viewerUrl(context), viewerChanges: viewerUrl(context, { focus: "modified", inspect: "diff" }), markdown: `${context.pageUrl}/llms.txt`,
},
@@ -216,10 +264,10 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
// A comparison of two commits, or a local review on someone's machine, has no pull request: its title names both refs.
const compared = pr.origin === "compare" || pr.origin === "local";
lines.push(`# Expo Explore report: ${escapeMd(app.name ?? pr.repository)} ${compared ? escapeMd(pr.title) : `PR #${escapeMd(pr.number)}`}${app.platform ? ` (${escapeMd(app.platform)})` : ""}`, "",
`> Visual review of ${compared ? `${escapeMd(pr.repository)} ${escapeMd(pr.title)}` : `pull request ${escapeMd(pr.repository)}#${escapeMd(pr.number)}`} by Expo Explore. ${screens.total} screens captured: ${screens.modified ?? 0} modified, ${screens.added ?? 0} added, ${screens.removed ?? 0} removed, ${screens.unchanged ?? 0} unchanged.${context.expiresAt ? ` This link stops serving the report after ${context.expiresAt}.` : ""}`, "",
`> Visual review of ${compared ? `${escapeMd(pr.repository)} ${escapeMd(pr.title)}` : `pull request ${escapeMd(pr.repository)}#${escapeMd(pr.number)}`} by Expo Explore. ${screens.total} screens: ${screenCounts(screens)}.${context.expiresAt ? ` This link stops serving the report after ${context.expiresAt}.` : ""}`, "",
"This URL is the human Viewer. The same report is available as read-only JSON (no credentials beyond this URL):", "",
`- [Summary](${links.summary ?? withPlatform(context, apiUrl(context))}): kind, counts by status, app and PR identity, links`,
`- [Changed screens](${links.changed}): the modified, added and removed screens with the review description, visual verdict and mismatch percentage; \`status=\` filters, \`limit=\`/\`cursor=\` page`,
`- [Changed screens](${links.changed}): the modified, accessibility-only (screenshots match, the accessibility tree does not), added and removed screens with the review description, visual verdict and mismatch percentage; \`status=\` filters, \`limit=\`/\`cursor=\` page`,
`- [All screens](${links.screens}): every captured screen; \`${links.screens}/{id}\` (the \`id\` field of a screen) adds source files and navigation in and out`,
`- [Transitions](${links.transitions}): navigation edges between screens (\`?from=\`/\`?to=\` take a screen id or route)`,
`- Screenshots: each screen's \`headImage\`/\`baseImage\` URL returns the PNG`,
@@ -339,7 +387,7 @@ export async function agentApiReply(context: AgentContext, loaded: LoadedReport,
const surfaces = arr(loaded.json.surfaces).map(rec);
if (id !== undefined) { const surface = surfaces.find(s => s.id === id); return surface ? json(reviewSurfaceDetail(context, loaded.json, surface)) : notFound(); }
const statuses = params.get("status")?.split(",").filter(Boolean);
const items = surfaces.filter(s => !statuses || statuses.includes(str(s.status) ?? "")).map(s => reviewSurfaceItem(context, s));
const items = surfaces.filter(s => !statuses || statuses.includes(verdictOf(s) ?? "")).map(s => reviewSurfaceItem(context, s));
const paged = page(items, params);
if (!paged) return json({ error: "bad_request", message: `limit must be 1-${MAX_LIMIT} and cursor a non-negative integer` }, 400);
return wantsMarkdown ? markdown(screensMarkdown(loaded, paged.items, paged.total)) : json(paged);
+2 -2
View File
@@ -5,7 +5,7 @@ import { assertPublicReview, projectPublicReviewForReport } from "../contracts/r
import { createHash } from "node:crypto";
import type { ArtifactReport } from "../contracts/artifact-report.js";
import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPresentation } from "../contracts/review.js";
import { renderPublicComment, platformSectionMerge, type PublicCommentState } from "./pr-comment-body.js";
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
import type { ExplorePlatform } from "../config/explore-config.js";
import { upsertStickyComment } from "./pr-comment.js";
import { previewLinks, viewerLinks } from "./viewer-links.js";
@@ -214,7 +214,7 @@ async function publishCompareSummary(input: CiReportInput, options: { artifactUr
runAttempt: review.runAttempt, configPath: input.commentState.configPath, artifactUrl: options.artifactUrl,
...(options.platform ? { platform: options.platform } : {}) });
const changes = input.commentState.review ?? review;
const count = changes.surfaces.filter(surface => surface.review ? surface.review.status !== "unchanged" && surface.review.status !== "variant" : surface.status !== "unchanged").length;
const count = reviewChangeCount({ review: changes }) ?? 0;
const platform = (options.platform ?? review.runtime.platform) === "android" ? "Android" : "iOS";
if (environment.GITHUB_STEP_SUMMARY) {
await appendFile(environment.GITHUB_STEP_SUMMARY, `- ${platform} report of ${compareTitleMarkdown(comparison)}: [Open](${links.viewer!.open}) · [zip](${links.download!}) · ${count} ${count === 1 ? "change" : "changes"}\n`);
+51 -23
View File
@@ -1,8 +1,8 @@
import type { PublicReview } from "../contracts/capture.js";
import type { SimulatorRuntimeMetadata } from "../capture/run.js";
import { CI_COMMENT_MARKER } from "./pr-comment.js";
import { CHANGE_GROUPS, foldRecord, historyLine, readCommentRecords, recordLine, recordSummary, type ChangeGroup, type CommentPlatform, type CommentRecords, type HistoryEntry, type PlatformRecord } from "./pr-comment-record.js";
import { sourceImpactSentences } from "../contracts/source-change.js";
import { CHANGE_GROUPS, changeCountText, foldRecord, strongerGroup, historyLine, readCommentRecords, recordLine, recordSummary, type ChangeGroup, type CommentPlatform, type CommentRecords, type HistoryEntry, type PlatformRecord } from "./pr-comment-record.js";
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
import type { ReviewPresentation } from "../contracts/review.js";
import type { ViewerLinks } from "./viewer-links.js";
@@ -60,8 +60,8 @@ const GROUP_LABEL: Record<ReviewGroup, string> = {
added: "🟩 Added",
modified: "🟧 Modified",
removed: "🟥 Removed",
"accessibility-only": "🟦 Accessibility only",
"needs-review": "🟨 Needs review",
"source-affected": "🟨 Source-affected",
};
/** The body is HTML, so no blank lines are needed and the block keeps its natural spacing. */
@@ -121,16 +121,32 @@ function plural(count: number, noun: string): string {
type Surface = PublicReview["surfaces"][number];
/** Evidence-based group when the run produced verdicts; otherwise the source-based status. */
function groupOf(surface: Surface, evidenceBased: boolean): ReviewGroup | "unchanged" | "variant" {
/**
* The group a surface is listed under, from the run's verdicts. A screen without one (its source changed but no
* screenshots were compared) is not listed: Explore reports what the captures show. A capture that failed is counted as
* unavailable in the result and named under Validation instead.
*/
function groupOf(surface: Surface, evidenceBased: boolean): ReviewGroup | "unlisted" {
if (surface.status === "added" || surface.status === "removed") return surface.status;
const verified = (["base", "head"] as const).every(side => surface[`${side}Image`]
&& surface[`${side}Outcome`]?.status === "captured" && surface[`${side}Outcome`]?.landing === "verified");
if (evidenceBased && verified && surface.review && surface.visual?.reason !== "diff-failed") return surface.review.status;
switch (surface.status) {
case "modified": return "source-affected";
case "unchanged": return "unchanged";
if (evidenceBased && verified && surface.review && surface.visual?.reason !== "diff-failed") {
const status = surface.review.status;
if (status === "unchanged" || status === "variant") return "unlisted";
return isAccessibilityOnlyChange(surface) ? "accessibility-only" : status;
}
return "unlisted";
}
/**
* A screen whose source changed and whose captures were both verified, but that has no verdict: the comparison did
* not run or failed. Not a change, but not a screen that looks the same either, so the result says how many.
*/
function notComparedChange(surface: Surface): boolean {
if (surface.status !== "modified" || (surface.head ?? surface.base)?.kind === "redirect") return false;
const verified = (["base", "head"] as const).every(side => surface[`${side}Image`]
&& surface[`${side}Outcome`]?.status === "captured" && surface[`${side}Outcome`]?.landing === "verified");
return verified && (!surface.review || surface.visual?.reason === "diff-failed");
}
function routeOf(surface: Surface): string {
@@ -143,9 +159,6 @@ function descriptionOf(surface: Surface, group: ReviewGroup): string {
if (group === "added") return `Added ${route} screen`;
if (group === "removed") return `Removed ${route} screen`;
// A group's own label already says added or removed; the route makes the line readable alone.
if (group === "source-affected") {
return sourceImpactSentences(surface.sourceImpact) ?? "Source-affected; not compared";
}
if (surface.review) return plainText(surface.review.description, MAX_DESCRIPTION_LENGTH);
return "No visible change";
}
@@ -270,10 +283,12 @@ export function platformRecordOf(state: PublicCommentState, platform?: CommentPl
for (const surface of state.review.surfaces) {
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
const group = groupOf(surface, evidenceBased);
if (group === "unchanged" || group === "variant") continue;
if (group === "unlisted") continue;
const scheme = schemeOf(surface.id);
record.changes.push({ id: surface.id, route: routeOf(surface), group, description: descriptionOf(surface, group), ...(scheme ? { scheme } : {}) });
}
const notCompared = state.review.surfaces.filter(notComparedChange).length;
if (notCompared) record.notCompared = notCompared;
record.context = contextLines(state.review).filter(line => line.length);
const diagnostics = [...(state.evidence?.diagnostics ?? [])];
for (const surface of state.review.surfaces) {
@@ -318,12 +333,12 @@ function resultCell(record: PlatformRecord): string {
}
case "failed": return `🟥 failed · ${inlineText(record.failure?.step ?? "capture", 48)}`;
case "ready": {
const changes = record.changes?.length ?? 0;
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 icon = unavailable || unverified || failed ? "🟨" : "🟩";
return [`${icon} ${plural(changes, "change")}`, unavailable ? `${unavailable} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
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(" · ");
}
}
@@ -363,6 +378,8 @@ function changeRows(records: PlatformRecord[]): Map<ReviewGroup, ChangeRow[]> {
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, perPlatform: {}, ...(change.scheme ? { scheme: change.scheme } : {}) };
// A screen accessibility-only on one platform 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.perPlatform[record.platform] = { group: change.group, ...(href ? { href } : {}) };
rows.set(change.id, row);
}
@@ -390,12 +407,14 @@ function changesSection(records: PlatformRecord[], platforms: CommentPlatform[],
const lines: string[] = [];
const total = [...groups.values()].reduce((sum, rows) => sum + rows.length, 0);
lines.push(`**Changes** · ${plural(total, "screen")}${platforms.length > 1 && ready.length > 1 ? " · a screen is listed once, with a link per platform" : ""}`, "");
if (total === 0) lines.push("No screen changed on the reviewed platforms.", "");
// 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 platforms." : "No screen changed on the reviewed platforms.", "");
for (const group of GROUP_ORDER) {
const rows = groups.get(group) ?? [];
if (!rows.length) continue;
const shown = rows.slice(0, rowCap);
const content = ["", ...shown.map(row => renderChangeRow(row, platforms))];
const content = ["", ...(group === "accessibility-only" ? ["Before and After look the same. What screen readers and voice control read changed.", ""] : []),
...shown.map(row => renderChangeRow(row, platforms))];
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)}` : ""}`);
@@ -606,19 +625,28 @@ export function reviewChanges(review: PublicReview): Map<string, ChangeGroup> {
for (const surface of review.surfaces) {
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
const group = groupOf(surface, evidenceBased);
if (group !== "unchanged" && group !== "variant") changes.set(surface.id, group);
if (group !== "unlisted") changes.set(surface.id, group);
}
return changes;
}
/** Surfaces the review calls changed (reviewer verdicts first, raw status otherwise); undefined before the review exists. */
/** How many screens the comment lists as changed; undefined before the review exists. */
export function reviewChangeCount(state: Pick<PublicCommentState, "review">): number | undefined {
return state.review?.surfaces.filter(surface => surface.review ? surface.review.status !== "unchanged" && surface.review.status !== "variant"
: surface.status !== "unchanged").length;
return state.review ? reviewChanges(state.review).size : undefined;
}
export { recordSummary, readCommentRecords };
/** A surface's status in the local text summary, named as the comment groups it. */
function localStatus(surface: Surface): string {
if (isAccessibilityOnlyChange(surface)) return "accessibility only";
if (surface.review) return surface.review.status;
if (surface.status === "added" || surface.status === "removed") return surface.status;
const failed = (["base", "head"] as const).some(side => surface[side]?.kind === "screen" && !surface[`${side}Image`]
&& surface[`${side}Outcome`] && surface[`${side}Outcome`]?.status !== "captured");
return failed ? "unavailable" : "not compared";
}
function renderLocalText(state: PublicCommentState): string {
const pr = state.pullRequest as Extract<ReviewPresentation, { origin: "local" }>;
const counts = state.capture;
@@ -630,6 +658,6 @@ function renderLocalText(state: PublicCommentState): string {
...(counts && counts.planned.base + counts.planned.head === 0 ? ["No captures selected; visual comparison was not required.", ""] : []),
...(state.review?.surfaces.filter(s => (s.status === "added" || s.status === "removed"
|| s.baseOutcome || s.headOutcome || s.review) && s.review?.status !== "unchanged" && s.review?.status !== "variant").map(s =>
`- ${inlineText((s.head ?? s.base)?.route ?? s.id, 160)}: ${s.review?.status ?? (s.status === "added" || s.status === "removed" ? s.status : "not compared")}${s.note ? ` — ${inlineText(s.note.text, 500)}` : ""}`) ?? []),
`- ${inlineText((s.head ?? s.base)?.route ?? s.id, 160)}: ${localStatus(s)}${s.note ? ` — ${inlineText(s.note.text, 500)}` : ""}`) ?? []),
"", ...(state.review ? contextLines(state.review) : []), "Report: artifacts/report.zip", "Details: README.md, agent-mode-cost.md, issues.md", ""].join("\n");
}
+31 -5
View File
@@ -13,8 +13,32 @@ import { deflateRawSync, inflateRawSync } from "node:zlib";
*/
export type CommentPlatform = "ios" | "android";
export type RecordPhase = "pending" | "capturing" | "ready" | "failed";
export type ChangeGroup = "added" | "modified" | "removed" | "needs-review" | "source-affected";
export const CHANGE_GROUPS: ChangeGroup[] = ["added", "removed", "modified", "needs-review", "source-affected"];
/**
* `accessibility-only`: modified, but the screenshots match; only what assistive technology reads changed. A screen
* whose source changed but that was not compared is no group: Explore reports what the captures show, not what the code
* might do.
*/
export type ChangeGroup = "added" | "modified" | "removed" | "accessibility-only" | "needs-review";
export const CHANGE_GROUPS: ChangeGroup[] = ["added", "removed", "modified", "accessibility-only", "needs-review"];
/**
* "12 changes", or "3 visual changes · 12 accessibility only" when some changed only for assistive technology: those
* are changes too (screen readers and voice control see them), but not ones a screenshot shows.
*/
/**
* The group of a screen that changed on several platforms. Accessibility only says the screenshots match, so it
* yields to any other group; otherwise the first platform's group stands, as it always has.
*/
export function strongerGroup(first: ChangeGroup, other: ChangeGroup): ChangeGroup {
return first === "accessibility-only" ? other : first;
}
export function changeCountText(groups: readonly ChangeGroup[]): string {
const accessibility = groups.filter(group => group === "accessibility-only").length;
const visual = groups.length - accessibility;
if (!accessibility) return `${visual} change${visual === 1 ? "" : "s"}`;
return [visual ? `${visual} visual change${visual === 1 ? "" : "s"}` : undefined, `${accessibility} accessibility only`].filter(Boolean).join(" · ");
}
export type SideHealth = { planned: number; captured: number; verified: number; unverified: number; unavailable: number };
@@ -41,6 +65,8 @@ export type PlatformRecord = {
};
/** The review's changed surfaces, one per surface; `scheme` for a secondary appearance (`<route>@<scheme>`). */
changes?: { id: string; route: string; group: ChangeGroup; description: string; scheme?: string }[];
/** Screens whose source changed and whose captures were verified, but that got no verdict: the comparison did not run or failed. */
notCompared?: number;
/** Differences stated once rather than per screen (variants, app-wide source changes). */
context?: string[];
diagnostics?: { side?: "base" | "head"; route: string; code: string; message: string; nextAction: string }[];
@@ -166,6 +192,7 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
&& isString(entry.message) && isString(entry.nextAction)
? [{ ...(isSide(entry.side) ? { side: entry.side } : {}), route: entry.route, code: entry.code, message: entry.message, nextAction: entry.nextAction }] : []).slice(0, 20);
}
if (isCount(value.notCompared) && value.notCompared > 0) record.notCompared = value.notCompared;
if (isCount(value.diagnosticCount)) record.diagnosticCount = value.diagnosticCount;
if (isRecord(value.failure) && isString(value.failure.step, 200) && isString(value.failure.message)) record.failure = { step: value.failure.step, message: value.failure.message };
if (value.superseded === true) record.superseded = true;
@@ -207,13 +234,12 @@ export function readCommentRecords(body: string | undefined): CommentRecords {
/** A short result for a run that is no longer current: "🟩 34 changes", "🟨 12 changes · 4 unavailable", "🟥 failed · capture". */
export function recordSummary(record: PlatformRecord): string {
const changes = record.changes?.length;
switch (record.phase) {
case "failed": return `🟥 failed · ${record.failure?.step ?? "capture"}`;
case "ready": {
const unavailable = record.health ? record.health.base.unavailable + record.health.head.unavailable : 0;
const icon = unavailable > 0 || (record.validation?.visual?.failed ?? 0) > 0 ? "🟨" : "🟩";
return `${icon} ${changes ?? 0} change${changes === 1 ? "" : "s"}${unavailable > 0 ? ` · ${unavailable} unavailable` : ""}`;
const icon = unavailable > 0 || (record.validation?.visual?.failed ?? 0) > 0 || record.notCompared ? "🟨" : "🟩";
return `${icon} ${changeCountText(record.changes?.map(change => change.group) ?? [])}${unavailable > 0 ? ` · ${unavailable} unavailable` : ""}${record.notCompared ? ` · ${record.notCompared} not compared` : ""}`;
}
default: return "⏳ did not finish";
}
+2 -1
View File
@@ -10,6 +10,7 @@ import { readZipDirectory, readZipEntry } from "./zip-reader.js";
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
import type { ExplorePlatform } from "../config/explore-config.js";
import type { ArtifactReport } from "../contracts/artifact-report.js";
import { normalizePublicReviewForReading } from "../contracts/review-validation.js";
import { EXPLORATION_REPORT_KIND, type ExplorationReport } from "../contracts/standalone-report.js";
import { compareTitleMarkdown, type CompareReviewPresentation } from "../contracts/review.js";
import { CiError, toCiError } from "../shared/ci-errors.js";
@@ -203,7 +204,7 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
if (!sha(pr.head?.sha) || !sha(pr.base?.sha) || !text(pr.head?.ref) || !text(pr.base?.ref) || !text(pr.repository) || !text(pr.title) || !text(review.runId)) {
throw new Error("review.json does not name its repository, title and commits as a report does");
}
const changes = reviewChangeCount({ review });
const changes = reviewChangeCount({ review: normalizePublicReviewForReading(review) });
const device = reviewDevice({ runtime: { deviceModel: review.runtime?.device?.model ?? "", osVersion: review.runtime?.device?.osVersion ?? "",
...(review.runtime?.colorSchemes ? { colorSchemes: review.runtime.colorSchemes } : {}) } });
return { kind: "review", platform, repository: pr.repository, runId: review.runId, base: pr.base.sha, head: pr.head.sha,
+7 -3
View File
@@ -6,8 +6,9 @@ import type { ArtifactReport } from "../contracts/artifact-report.js";
import { EXPLORATION_REPORT_KIND, type ExplorationReport } from "../contracts/standalone-report.js";
import { exploreCacheRoot } from "../shared/cache-root.js";
import { MAX_METADATA_BYTES } from "./agent-api.js";
import { normalizePublicReviewForReading } from "../contracts/review-validation.js";
import { reviewChanges, reviewDevice } from "./pr-comment-body.js";
import type { ChangeGroup } from "./pr-comment-record.js";
import { strongerGroup, type ChangeGroup } from "./pr-comment-record.js";
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
/**
@@ -99,9 +100,12 @@ export async function describeReports(reports: SavedReport[], extra: { subjects?
const review = reviews[0];
const pr = review?.pullRequest;
if (!review || !pr) throw new Error("Not an Explore review report");
// One surface changed on two platforms is one change, under the first platform's group, as the PR comment lists it.
// One surface changed on two platforms is one change, under the group the PR comment lists it in (strongerGroup).
const merged = new Map<string, ChangeGroup>();
for (const each of reviews) if (each) for (const [id, group] of reviewChanges(each)) if (!merged.has(id)) merged.set(id, group);
for (const each of reviews) if (each) for (const [id, group] of reviewChanges(normalizePublicReviewForReading(each))) {
const first = merged.get(id);
merged.set(id, first ? strongerGroup(first, group) : group);
}
const changes: Partial<Record<ChangeGroup, number>> = {};
for (const group of merged.values()) changes[group] = (changes[group] ?? 0) + 1;
const devices = [...new Set(reviews.map(each => each ? reviewDevice({ runtime: { deviceModel: each.runtime?.device?.model ?? "", osVersion: each.runtime?.device?.osVersion ?? "",
+34 -7
View File
@@ -27,6 +27,7 @@ import {
} 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";
export const DEFAULT_VISUAL_THRESHOLD = 0.1;
export const DEFAULT_EVIDENCE_TIME_BUDGET_MS = 10 * 60_000;
@@ -141,6 +142,29 @@ function visualVerdict(assessment: VisualEvidenceAssessment, threshold: number):
};
}
/**
* 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.
*/
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 shiftOf = new Map(all.map((region, index) => [region.rect, shifts[index]] as const));
return {
regions: published.map(region => {
const shift = shiftOf.get(region.rect);
return shift ? { ...region, shift } : region;
}),
...(all.length > 0 && shifts.every(Boolean) ? { allRegionsMoved: true as const } : {}),
};
} catch {
return { regions: published };
}
}
/** Remove status-bar-only diff regions from a measurement and recompute its verdict inputs. */
export function ignoreStatusBar(measurement: ScreenshotDiffMeasurement, bandPercent: number = STATUS_BAR_BAND_PERCENT): { measurement: ScreenshotDiffMeasurement; ignored: number } {
const bands = ignoreSystemBands(measurement, { top: bandPercent, bottom: 0 });
@@ -277,11 +301,11 @@ function localEvidencePath(side: PublicEvidenceSide, relativePath: string): stri
/**
* The verdict combines the source scope with the evidence. Only a source change makes a surface a
* review target: a changed screen is Modified when evidence differs and Needs review when nothing
* visible differs. A source-unchanged screen is never a review target: a difference there is the
* same screen captured in another runtime state (a screen variant), not a change. When only
* app-wide inputs changed, a screen without a visible difference stays Unchanged; the PR comment
* names the app-wide change once.
* review target: a changed screen is Modified when its evidence differs, Needs review when the
* comparison could not tell, and Unchanged when both captures show the same thing. Explore reports
* visual changes, so a source change nobody can see is not one. A source-unchanged screen is never a
* review target: a difference there is the same screen captured in another runtime state (a screen
* variant), not a change. The PR comment names an app-wide change once.
*/
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) })) ?? [];
@@ -303,8 +327,7 @@ export function decideReview(scope: SurfaceSourceScope, visual: PublicVisualVerd
if (inconclusive) {
return { status: "needs-review", description: truncate(visual.verdict === "needs-review" ? visualReasonText(visual) : issue ?? "Needs review") };
}
if (scope === "app-wide") return { status: "unchanged", description: "No visible change" };
return { status: "needs-review", description: "Source changed; no visible difference was captured." };
return { status: "unchanged", description: "No visible change" };
}
function captureDiagnostic(surface: PlanSurface, side: "base" | "head", evidence: PublicEvidenceSide, surfaceId: string = surface.id): PublicEvidenceDiagnostic | undefined {
@@ -464,6 +487,10 @@ export async function assessPublicEvidence(options: {
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;
+150
View File
@@ -0,0 +1,150 @@
import { createRequire } from "node:module";
import { readFile } from "node:fs/promises";
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 };
/**
* The farthest a region is searched for, in screenshot pixels: layout drift, not a different screen. Drift adds up
* down a long screen (a device pixel per text element above), so the vertical reach is the larger.
*/
const MAX_SHIFT_X = 4;
const MAX_SHIFT_Y = 20;
/** How close to the edge of the search a best fit may land and still count: the real one may lie beyond it. */
const EDGE = 1.5;
/**
* The share of a region's difference one shift must explain for the region to have moved rather than changed.
* A move of half a pixel or less re-rasterizes text rather than shifting it, so a pure shift explains only a
* quarter to a half of it; content that changed (new text, a caret) explains under a quarter at that size, and
* anything larger has to be explained mostly by the shift. Measured on euxy's SDK 58 upgrade (brentvatne/euxy#161).
*/
const MIN_EXPLAINED = 0.6;
const MIN_EXPLAINED_SUBPIXEL = 0.25;
const SUBPIXEL = 0.5;
/** A smaller shift is rendering noise, not a move. */
const MIN_SHIFT = 0.25;
/** Sixths of a pixel in the refining search: a third of a 1x pixel is one device pixel on a 3x screen. */
const STEPS_PER_PIXEL = 6;
/** Fits this close to the best are ties, which go to the smallest move (content that is the same all along one axis). */
const TIE = 1.005;
/** Another fit this close at a vertical offset two or more pixels away makes the move ambiguous (repeating content). */
const AMBIGUOUS = 1.05;
/**
* After aligning by the move, content is the same only where every channel is within this: re-rasterized text
* differs by at most about 125 (brentvatne/euxy#161), new content by about 200. A few pixels over it are noise; more are a change.
*/
const CHANGED_CHANNEL = 140;
const CHANGED_PIXELS = 3;
type Image = { width: number; height: number; frame: DecodedFrame; luminance: Float32Array };
type Fit = { sx: number; sy: number; error: number };
function image(frame: DecodedFrame): Image {
const luminance = new Float32Array(frame.width * frame.height);
for (let index = 0; index < luminance.length; index += 1) {
const offset = index * 4;
luminance[index] = 0.299 * frame.data[offset]! + 0.587 * frame.data[offset + 1]! + 0.114 * frame.data[offset + 2]!;
}
return { width: frame.width, height: frame.height, frame, luminance };
}
/** Bilinear sample of one plane: `channel` 0–2 of the frame, or luminance when undefined. */
function at(source: Image, x: number, y: number, channel?: number): number {
const cx = Math.min(source.width - 1, Math.max(0, x));
const cy = Math.min(source.height - 1, Math.max(0, y));
const x0 = Math.floor(cx), y0 = Math.floor(cy);
const x1 = Math.min(source.width - 1, x0 + 1), y1 = Math.min(source.height - 1, y0 + 1);
const fx = cx - x0, fy = cy - y0;
const value = channel === undefined
? (px: number, py: number) => source.luminance[py * source.width + px]!
: (px: number, py: number) => source.frame.data[(py * source.width + px) * 4 + channel]!;
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 {
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]!);
}
}
return error;
}
/** The best of some fits, with near-ties going to the smallest move. */
function bestOf(fits: readonly Fit[]): Fit {
const least = Math.min(...fits.map(fit => fit.error));
return fits.filter(fit => fit.error <= least * TIE + 1e-6)
.sort((a, b) => Math.hypot(a.sx, a.sy) - Math.hypot(b.sx, b.sy))[0]!;
}
/** Whether, aligned by the move, some of the region still differs strongly in any channel: content that changed. */
function changedAfterMove(base: Image, head: Image, rect: Rect, sx: number, sy: number): boolean {
let strong = 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) {
for (let channel = 0; channel < 3; channel += 1) {
if (Math.abs(at(base, x - sx, y - sy, channel) - head.frame.data[(y * head.width + x) * 4 + channel]!) > CHANGED_CHANNEL) {
strong += 1;
if (strong >= CHANGED_PIXELS) return true;
break;
}
}
}
}
return false;
}
/**
* The shift that explains one region's difference, if one does: the region's content is the same in both
* screenshots, only moved. A region whose content changed (new text, another colour) has no shift, and neither has
* one whose content repeats so that several shifts fit.
*/
function regionShift(base: Image, head: Image, region: Rect): RegionShift | undefined {
const x = Math.max(0, Math.floor(region.x)), y = Math.max(0, Math.floor(region.y));
const rect = { x, y, width: Math.min(head.width - x, Math.ceil(region.width)), height: Math.min(head.height - y, Math.ceil(region.height)) };
if (rect.width <= 0 || rect.height <= 0) return undefined;
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).
const whole: Fit[] = [];
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) });
}
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[] = [];
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 best = bestOf(fine);
if (Math.abs(best.sx) > MAX_SHIFT_X - EDGE || Math.abs(best.sy) > MAX_SHIFT_Y - EDGE) return undefined;
const distance = Math.hypot(best.sx, best.sy);
const needed = distance <= SUBPIXEL + 1e-6 ? MIN_EXPLAINED_SUBPIXEL : MIN_EXPLAINED;
if (distance < MIN_SHIFT - 1e-6 || 1 - best.error / unshifted < needed) return undefined;
if (changedAfterMove(base, head, rect, best.sx, best.sy)) return undefined;
const round = (value: number) => Math.round(value * 100) / 100 || 0;
return { x: round(best.sx), y: round(best.sy) };
}
/** Each region's shift between two screenshots of the same size; undefined where a region's content changed. */
export function regionShifts(baseFrame: DecodedFrame, headFrame: DecodedFrame, regions: readonly Rect[]): Array<RegionShift | undefined> {
if (baseFrame.width !== headFrame.width || baseFrame.height !== headFrame.height) return regions.map(() => undefined);
const base = image(baseFrame), head = image(headFrame);
return regions.map(region => regionShift(base, head, region));
}
/** 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 { 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);
}
+7 -6
View File
@@ -1005,7 +1005,7 @@ test("a docs-only report with zero images and no EAS build opens Screens without
assert.deepEqual(errors, []);
});
test("unverified capture diagnostics stay separate from verified Needs review and source impact filters", async t => {
test("unverified capture diagnostics stay separate from verified Needs review, and source changes nobody compared are not changes", async t => {
const report = reportFixture();
const home = report.review.surfaces[0];
const uncertain = structuredClone(home);
@@ -1029,12 +1029,13 @@ test("unverified capture diagnostics stay separate from verified Needs review an
await expect(page.locator(".app-shell")).toBeVisible();
await page.getByRole("button", { name: "Screens", exact: true }).click();
await expect(page.locator(".screens-page .diff-frame.diff-needs-review")).toHaveCount(1);
await expect(page.locator(".screens-page .diff-frame.diff-source-affected")).toHaveCount(2);
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(1);
// The unverified /home and the never-captured /candidate changed in source only: not compared, like /untouched.
await expect(page.locator(".screens-page .diff-frame.diff-source-affected")).toHaveCount(0);
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(3);
await expect(page.locator(".screens-page .diff-frame.diff-modified")).toHaveCount(0);
const menu = await openChangesMenu(page);
const chips = menu.getByRole("group", { name: "Filter changes" }).getByRole("button");
await expect(chips).toHaveText(["Modified 0", "No visible change 1", "Source-affected 2"]);
await expect(chips).toHaveText(["Modified 0", "No visible change 1"]);
assert.deepEqual(errors, []);
});
@@ -1068,8 +1069,8 @@ test("an existing report with operational verdicts opens as diagnostics without
const { page, errors } = await harness(t, await archive(report), { app: true });
await expect(page.locator(".app-shell")).toBeVisible();
await page.getByRole("button", { name: "Screens", exact: true }).click();
await expect(page.locator(".screens-page .diff-frame.diff-source-affected")).toHaveCount(1);
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(1);
await expect(page.locator(".screens-page .diff-frame.diff-source-affected")).toHaveCount(0);
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(2);
await expect(page.locator(".screens-page .diff-frame.diff-unavailable")).toHaveCount(1, "an added route whose capture failed has nothing to show");
await expect(page.locator(".screens-page .diff-frame.diff-removed")).toHaveCount(1);
await expect(page.locator(".diff-frame.diff-needs-review, .diff-frame.diff-modified, .diff-frame.diff-unchanged, .diff-frame.diff-added")).toHaveCount(0);
+14 -11
View File
@@ -103,7 +103,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
const pullRequestPath = join(root, 'pull-request.json'); await writeFile(pullRequestPath, JSON.stringify(pr));
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
GITHUB_RUN_ID: '1234', GITHUB_RUN_ATTEMPT: '1', GITHUB_REPOSITORY: pr.repository, TOOLS_COMMIT: 'c'.repeat(40), EXPLORE_VIEWER_ORIGIN: 'https://viewer.example' };
const requests = []; const comments = []; const sessions = new Map(); let currentSession; let currentPath = '/'; let sessionCounter = 0; let repackedSha; let openFailed = false; let currentScheme = 'light';
const requests = []; const comments = []; const sessions = new Map(); let currentSession; const idleDevice = { path: '/', scheme: 'light' }; let sessionCounter = 0; let repackedSha; let openFailed = false;
const identity = () => ({ session: 'expo-explore-runtime', appBundleId: config.app.bundleId,
device: { id: 'device-1', name: config.device.name, platform, target: 'mobile', osVersion: '26.0', locale: 'en-US', orientation: 'portrait', colorScheme: 'light' },
identifiers: { session: 'expo-explore-runtime', appBundleId: config.app.bundleId, deviceId: 'device-1', deviceName: config.device.name } });
@@ -140,8 +140,8 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
return json({ jobs: [{ key: 'repack', status: 'SUCCESS', outputs: { build_id: `repacked-${repackedSha}`, platform } }] });
}
if (command === 'simulator:start') {
const id = `session-${++sessionCounter}`; currentSession = id; currentPath = '/'; openFailed = false;
const session = { id, name: value(request, '--name'), build: value(request, '--build-id') }; sessions.set(id, session);
const id = `session-${++sessionCounter}`; currentSession = id; openFailed = false;
const session = { id, name: value(request, '--name'), build: value(request, '--build-id'), path: '/', scheme: 'light' }; sessions.set(id, session);
writeFileSync(join(request.cwd, '.env.eas-simulator'), `${HEADER}EAS_SIMULATOR_SESSION_ID='${id}'\nAGENT_DEVICE_DAEMON_BASE_URL='https://controller.example/${id}'\nAGENT_DEVICE_DAEMON_AUTH_TOKEN='controller-private-token'\n`);
return { stdout: 'ready', stderr: '' };
}
@@ -155,6 +155,9 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
return { stdout: '', stderr: '' };
}
if (basename(request.command) === 'agent-device') {
// Base and head capture in parallel, each on its own simulator: a request names its session in the daemon URL,
// so the route, appearance and build it sees are that session's, not whichever session started last.
const device = sessions.get(/\/([^/]+)$/.exec(request.environment?.AGENT_DEVICE_DAEMON_BASE_URL ?? '')?.[1]) ?? sessions.get(currentSession) ?? idleDevice;
if (command === '--version') return { stdout: AGENT_DEVICE_VERSION, stderr: '' };
if (command === 'open') {
if (request.args[2]?.startsWith('sample://')) {
@@ -162,7 +165,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
openFailed = true;
return json({ success: false, error: { code: 'COMMAND_FAILED', message: 'The app is not ready for this link yet.' } });
}
currentPath = '/' + request.args[2].slice('sample://'.length);
device.path = '/' + request.args[2].slice('sample://'.length);
}
return ok(identity());
}
@@ -170,17 +173,17 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
if (command === 'wait') return ok({});
if (command === 'alert' && request.args[1] === 'get') return json({ success: false, error: { code: 'COMMAND_FAILED', message: 'alert not found' } });
if (command === 'snapshot') {
const dynamic = currentPath.startsWith('/item/');
const dynamic = device.path.startsWith('/item/');
const destination = provider === 'expo-router'
? { provider, pathname: currentPath, segments: dynamic ? ['item', '[id]'] : currentPath.split('/').filter(Boolean), parameters: dynamic ? { id: currentPath.slice('/item/'.length) } : {} }
: { provider, segments: [currentPath.slice(1).replace(/^./, first => first.toUpperCase())], parameters: {} };
? { provider, pathname: device.path, segments: dynamic ? ['item', '[id]'] : device.path.split('/').filter(Boolean), parameters: dynamic ? { id: device.path.slice('/item/'.length) } : {} }
: { provider, segments: [device.path.slice(1).replace(/^./, first => first.toUpperCase())], parameters: {} };
return ok({ truncated: false, nodes: [
{ index: 0, type: 'StaticText', label: currentPath, identifier: 'screen-title', enabled: true, visible: true, rect: { x: 0, y: 0, width: 16, height: 24 } },
...(currentPath === observerFailurePath ? [] : [{ index: 1, type: 'StaticText', label: JSON.stringify(destination), identifier: CAPTURE_OBSERVER_IDENTIFIER, enabled: true, visible: true }]),
{ index: 0, type: 'StaticText', label: device.path, identifier: 'screen-title', enabled: true, visible: true, rect: { x: 0, y: 0, width: 16, height: 24 } },
...(device.path === observerFailurePath ? [] : [{ index: 1, type: 'StaticText', label: JSON.stringify(destination), identifier: CAPTURE_OBSERVER_IDENTIFIER, enabled: true, visible: true }]),
] });
}
if (command === 'settings') { if (request.args[1] === 'appearance') currentScheme = request.args[2]; return ok({ setting: request.args[1], value: request.args[2] }); }
if (command === 'screenshot') { const color = createHash('sha256').update(`${currentPath}:${currentScheme}:${currentPath === '/home' ? sessions.get(currentSession).build : 'unchanged-source'}`).digest(); const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
if (command === 'settings') { if (request.args[1] === 'appearance') device.scheme = request.args[2]; return ok({ setting: request.args[1], value: request.args[2] }); }
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
}
throw new Error(`Unexpected mocked command: ${request.command} ${request.args.join(' ')}`);
};
+38 -10
View File
@@ -2,16 +2,44 @@ import assert from "node:assert/strict";
import test from "node:test";
const { tsImport } = await import("tsx/esm/api");
const { isVisibleChange } = await tsImport("../../viewer/src/utils/changed-screens.ts", import.meta.url);
const { isCapturedChange } = await tsImport("../../viewer/src/utils/changed-screens.ts", import.meta.url);
test("only a change the captures show counts for Compare and Screens' Changed filter", () => {
assert.equal(isVisibleChange({ status: "added" }), true);
assert.equal(isVisibleChange({ status: "removed" }), true);
assert.equal(isVisibleChange({ status: "modified" }), true);
// The source changed but the captures look the same.
assert.equal(isVisibleChange({ status: "modified", notVisible: true }), false);
assert.equal(isVisibleChange({ status: "needs-review" }), false);
assert.equal(isVisibleChange({ status: "source-affected" }), false);
assert.equal(isVisibleChange({ status: "unchanged" }), false);
assert.equal(isVisibleChange(undefined), false);
assert.equal(isCapturedChange({ status: "added" }), true);
assert.equal(isCapturedChange({ status: "removed" }), true);
assert.equal(isCapturedChange({ status: "modified" }), true);
// The screenshots match but the accessibility tree changed: screen readers see it, so it is reviewed.
assert.equal(isCapturedChange({ status: "modified", accessibilityOnly: true }), true);
// The source changed but the captures show nothing different.
assert.equal(isCapturedChange({ status: "needs-review" }), false);
assert.equal(isCapturedChange({ status: "source-affected" }), false);
assert.equal(isCapturedChange({ status: "unchanged" }), false);
assert.equal(isCapturedChange(undefined), false);
});
const { splitForAssistiveTechnology } = await tsImport("../../viewer/src/utils/presented-changes.ts", import.meta.url);
test("What changed lists what assistive technology reads under its own heading", () => {
const change = (id, category) => ({ id, copy: id, fact: { id, category, templateId: `${category}.x`, priority: 0, evidenceRefs: [] } });
const changes = [change("Added button “Play”.", "element"), change("Changed accessibility label.", "accessibility")];
const ids = ({ visible, assistive }) => [visible.map(entry => entry.id), assistive.map(entry => entry.id)];
// Pixels differ: an added element may be visible, a label is not.
assert.deepEqual(ids(splitForAssistiveTechnology(changes, { status: "modified" })), [["Added button “Play”."], ["Changed accessibility label."]]);
// The screenshots match: nothing on the screen looks different, so every finding is for assistive technology.
assert.deepEqual(ids(splitForAssistiveTechnology(changes, { status: "modified", accessibilityOnly: true })), [[], ["Added button “Play”.", "Changed accessibility label."]]);
// A reviewer note is not a finding about the accessibility tree.
assert.deepEqual(ids(splitForAssistiveTechnology([{ id: "review-note", copy: "Note" }], { status: "modified", accessibilityOnly: true })), [["review-note"], []]);
});
const { focusCounts, focusStatusOf } = await tsImport("../../viewer/src/utils/changed-screens.ts", import.meta.url);
test("the Changes filter counts Accessibility only apart from Modified", () => {
const screens = new Map([
["a", { status: "modified" }], ["b", { status: "modified", accessibilityOnly: true }], ["c", { status: "modified", accessibilityOnly: true }],
["d", { status: "added" }], ["e", { status: "not-compared" }], ["f", { status: "unchanged" }],
]);
assert.deepEqual(focusCounts({ screens }), { added: 1, modified: 1, "accessibility-only": 2, removed: 0, "needs-review": 0, "source-affected": 0 });
assert.equal(focusStatusOf({ status: "modified", accessibilityOnly: true }), "accessibility-only");
assert.equal(focusStatusOf({ status: "modified" }), "modified");
assert.equal(focusStatusOf(undefined), undefined);
});
+71 -7
View File
@@ -196,14 +196,15 @@ test('an OS version the simulator did not report is omitted, not shown as unknow
assert.doesNotMatch(body, /unknown/i);
});
test('without evidence the comment falls back to source statuses and says comparisons did not run', () => {
test('without evidence the comment lists only added and removed screens and says comparisons did not run', () => {
const plain = review([surface('care-guide', 'added'), surface('sweet-bee', 'removed'), surface('settings', 'modified'), surface('cats', 'unchanged')]);
const body = renderPublicComment(reviewOnlyState(plain));
assert.match(body, /<summary>🟨 Source-affected \(1\)<\/summary>/);
assert.match(body, /\n- `\/settings` — Source\\-affected; not compared · \[iOS\]/);
// 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\\\) \| 🟩 3 changes · 0s \|/);
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/);
});
@@ -261,8 +262,10 @@ 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 } }));
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟨 Source-affected (1)', 'Validation · iOS 🟨 3/6 captured']);
assert.match(platformRow(body, 'iOS'), /\| 🟨 3 changes · 3 unavailable · 1 unattributed · 6m 12s \|/);
// /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 \|/);
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/);
@@ -284,7 +287,7 @@ test('zero eligible pairs are visibly skipped instead of successful comparisons'
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'), /\| 🟨 4 changes · 6 unattributed · 6m 12s \|/);
assert.match(platformRow(body, 'iOS'), /\| 🟨 2 changes · 6 unattributed · 6m 12s \|/, 'the uncompared modified screens are not changes');
});
test('the review-only comment counts failed outcomes in planned coverage and lists the reason', () => {
@@ -450,3 +453,64 @@ test('a report whose hosted preview is still deploying says so instead of linkin
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', () => {
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”.' },
{ category: 'accessibility', templateId: 'accessibility.label-changed', bullet: 'Changed accessibility label from “lane-row-title-3” to “Clap”.' },
] },
visual: { verdict: 'unchanged', reason: 'matched', mismatchPercentage: 0, threshold: 0.1, tool: '[email protected]' },
sourceChange: sourceChange('Labelled the lane rows.'),
} });
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\]/);
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', () => {
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 \|/);
});
test('a screen accessibility-only on iOS and visibly modified on Android is listed as Modified, whichever platform comes first', async () => {
const { platformSectionMerge } = await import('../../dist/report/pr-comment-body.js');
const settings = (verdict) => {
const changed = evidenceReview();
changed.surfaces[2].visual = { ...changed.surfaces[2].visual, verdict, mismatchPercentage: verdict === 'modified' ? 3.2 : 0 };
return changed;
};
const androidState = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' },
runtime: { ...state().runtime, platform: 'android', deviceModel: 'EasAndroidDevice01', osVersion: '15.0' }, ...overrides });
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/);
});
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/);
// 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/);
});
+2 -3
View File
@@ -210,10 +210,9 @@ test("the verdict table: source scope decides whether a screen is a review targe
const head = await side(root, "head", manifests.head);
const assess = (overrides, mismatches = {}) => assessPublicEvidence({ plan: plan("all", overrides), base, head,
profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure: measurer(mismatches) });
// Screen-specific source change, identical evidence: still a review target.
// Screen-specific source change, identical evidence: not a visible change, so Unchanged and not counted.
let result = await assess({});
assert.equal(result.surfaces.pixels.review.status, "needs-review");
assert.equal(result.surfaces.pixels.review.description, "Source changed; no visible difference was captured.");
assert.deepEqual(result.surfaces.pixels.review, { status: "unchanged", description: "No visible change" });
assert.equal(result.surfaces.changed.review.status, "modified", "an accessibility fact is a visible difference");
// Only app-wide inputs changed: no visible difference is Unchanged; a difference is Modified.
result = await assess({ pixels: { status: "modified", reasons: ["App configuration changed: package.json"] },
+41 -1
View File
@@ -172,7 +172,7 @@ test("reader never shows malformed original verdicts, capture outcomes, or prove
});
test("a source scope allows only its verdicts, and legacy source-unchanged differences read as variants", () => {
const allowed = { screen: ["modified", "needs-review"], "app-wide": ["modified", "needs-review", "unchanged"], none: ["unchanged", "variant"] };
const allowed = { screen: ["modified", "needs-review", "unchanged"], "app-wide": ["modified", "needs-review", "unchanged"], none: ["unchanged", "variant"] };
for (const [scope, statuses] of Object.entries(allowed)) {
for (const status of ["modified", "needs-review", "unchanged", "variant"]) {
const input = review();
@@ -194,6 +194,13 @@ test("a source scope allows only its verdicts, and legacy source-unchanged diffe
const read = normalizePublicReviewForReading(legacy);
assert.deepEqual(read.surfaces[0].review, { status: "variant", description: "Runtime state differs: Removed text “84”." });
assert.deepEqual(read.surfaces[1].review, legacy.surfaces[1].review, "a legacy source-changed verdict has no scope to re-judge");
// A report from before 0.19.1 called a source change with matching captures "needs review": it reads as unchanged.
const older = review();
older.surfaces[0].review = { status: "needs-review", description: "Source changed; no visible difference was captured." };
older.surfaces[1].review = { status: "needs-review", description: "Visual comparison was inconclusive" };
const reread = normalizePublicReviewForReading(older);
assert.deepEqual(reread.surfaces[0].review, { status: "unchanged", description: "No visible change" });
assert.equal(reread.surfaces[1].review.status, "needs-review", "an inconclusive comparison still needs a look");
});
test("launch evidence carries verified splash and settled frames, an mp4 with provenance, and a splash verdict only when both sides observed one", () => {
@@ -246,3 +253,36 @@ test("quarantine: a report-level contract failure still throws", () => {
assert.throws(() => quarantineReviewContract(provenance), /disagree with their build provenance/);
});
test('a visual region may carry the shift its content moved by, and a malformed one is rejected', async () => {
const { assertPublicReview } = await import('../../dist/contracts/review-validation.js');
const valid = JSON.parse(JSON.stringify(reviewWithRegion({ x: 0, y: -4.17 })));
assert.doesNotThrow(() => assertPublicReview(valid));
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 500 }, 'up']) {
assert.throws(() => assertPublicReview(reviewWithRegion(shift)), /visual verdict is inconsistent/, JSON.stringify(shift));
}
});
function reviewWithRegion(shift) {
const input = review();
input.surfaces[0].review = { status: "modified", description: "Updated visual styling in the main content area." };
input.surfaces[0].visual = { verdict: "modified", reason: "repeated-cross-build-delta", mismatchPercentage: 1, threshold: 0.1, tool: "agent-device",
regions: [{ rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: { x: 0, y: 0, width: 100, height: 100 },
differentPixels: 1, shareOfDiffPercentage: 100, dominantChange: "mixed", location: "center", shift }] };
return input;
}
test('allRegionsMoved is only true, and only where every published region carries its shift', async () => {
const { assertPublicReview } = await import('../../dist/contracts/review-validation.js');
const moved = reviewWithRegion({ x: 0, y: 1 });
moved.surfaces[0].visual.allRegionsMoved = true;
assert.doesNotThrow(() => assertPublicReview(moved));
for (const [label, mutate] of [['false', visual => { visual.allRegionsMoved = false; }],
['a region without a shift', visual => { delete visual.regions[0].shift; }],
['no regions', visual => { delete visual.regions; }]]) {
const input = reviewWithRegion({ x: 0, y: 1 });
input.surfaces[0].visual.allRegionsMoved = true;
mutate(input.surfaces[0].visual);
assert.throws(() => assertPublicReview(input), /visual verdict is inconsistent/, label);
}
});
+10 -10
View File
@@ -211,7 +211,7 @@ test("public inventory preserves source classification while unverified images s
const workspace = publicReviewToWorkspace(review);
const { baseline, current } = workspaceSides(workspace);
assert.deepEqual(workspace.comparison.entries.map(({ id, status }) => ({ id, status })), [
{ id: "games-free", status: "source-affected" }, { id: "games-pro", status: "not-compared" },
{ id: "games-free", status: "not-compared" }, { id: "games-pro", status: "not-compared" },
{ id: "care-guide", status: "added" }, { id: "sweet-bee", status: "removed" },
{ id: "scan-mood", status: "not-compared" }, { id: "scan-breed", status: "not-compared" },
{ id: "home", status: "not-compared" }, { id: "camera-alias", status: "not-compared" },
@@ -231,9 +231,9 @@ test("public inventory preserves source classification while unverified images s
assert.ok(payload.map.screens.every((screen) => !screen.start && !screen.terminal));
}
const diff = diffFor(review);
assert.equal(diff.screens.get("games-free").status, "source-affected", "Equal PNG hashes cannot prove verified destinations");
assert.equal(diff.screens.get("games-free").status, "not-compared", "Equal PNG hashes cannot prove verified destinations");
assert.equal(diff.screens.get("games-pro").status, "not-compared", "Different PNG hashes cannot prove a route modification");
assert.deepEqual(diff.counts, { added: 1, modified: 0, removed: 1, unchanged: 0, "needs-review": 0, "source-affected": 1, "not-compared": 5, unavailable: 0, variant: 0 });
assert.deepEqual(diff.counts, { added: 1, modified: 0, removed: 1, unchanged: 0, "needs-review": 0, "source-affected": 0, "not-compared": 6, unavailable: 0, variant: 0 });
assert.equal(workspace.review, undefined, "The adapter must not fabricate semantic review evidence");
assert.deepEqual(review, before, "The source publication remains immutable");
});
@@ -281,7 +281,7 @@ test("existing route-family presentation groups query variants without losing th
assert.equal(scan.observationIds.length, 2);
assert.deepEqual(scan.variantIds.map((id) => presentation.index.variants.get(id).name), ["mood", "breed"]);
const displayed = presentBuildDiff(diff, presentation);
assert.deepEqual(displayed.counts, { added: 1, modified: 0, removed: 1, unchanged: 0, "needs-review": 0, "source-affected": 1, "not-compared": 3, unavailable: 0, variant: 0 });
assert.deepEqual(displayed.counts, { added: 1, modified: 0, removed: 1, unchanged: 0, "needs-review": 0, "source-affected": 0, "not-compared": 4, unavailable: 0, variant: 0 });
assert.equal(presentation.map.screens.length, 6);
assert.equal(scan.title, "Scan — Instruction");
const graph = buildObservedGraph(presentation.map, presentation.index);
@@ -455,7 +455,7 @@ test("What changed uses commit-bound Git summaries without changing screenshot i
review.surfaces[0].sourceChange = summary;
const diff = diffFor(review).screens.get("games-free");
assert.equal(diff.changeSummary, summary.summary);
assert.equal(diff.status, "source-affected");
assert.equal(diff.status, "not-compared");
assert.equal(diff.beforeScreenshot, review.surfaces[0].baseImage.url);
assert.equal(diff.afterScreenshot, review.surfaces[0].headImage.url);
assert.doesNotMatch(diff.changeSummary, /Visual changes have not been classified/);
@@ -583,16 +583,16 @@ test("public notes survive viewer projection without changing deterministic verd
});
test("source-only impact and untouched uncaptured inventory stay distinct from runtime verdicts", () => {
test("a source change without a comparison is not compared, as untouched uncaptured inventory is: it is no change the captures show", () => {
const review = fixture("changes");
delete review.surfaces[0].baseImage;
delete review.surfaces[0].headImage;
const diff = diffFor(review);
assert.equal(diff.screens.get("games-free").status, "source-affected");
assert.equal(diff.screens.get("games-free").status, "not-compared");
assert.equal(diff.screens.get("games-pro").status, "not-compared");
assert.equal(diff.counts.modified, 0);
assert.equal(diff.counts.unchanged, 0);
assert.equal(diff.counts["source-affected"], 1);
assert.equal(diff.counts["source-affected"], 0);
assert.equal(review.surfaces[0].status, "modified", "source classification is retained without inventing a visual verdict");
});
@@ -657,7 +657,7 @@ test("unverified captures on either side remain diagnostics and cannot become ap
assert.equal(affected.coverage.observations, 6, "an unverified image is retained as diagnostic evidence");
assert.match(affected.map.gaps.find(gap => gap.screenId === surface.id).message, /destination unverified/);
const diff = diffFor(review);
assert.equal(diff.screens.get(surface.id).status, "source-affected");
assert.equal(diff.screens.get(surface.id).status, "not-compared");
assert.equal(diff.screens.get(surface.id).noVisibleChange, false);
assert.deepEqual(diff.screens.get(surface.id).reviewerChanges, []);
assert.equal(diff.counts["needs-review"], 0);
@@ -710,7 +710,7 @@ test("direct reads of existing operational verdicts preserve diagnostics without
deepFreeze(input);
publicReviewToWorkspace(input);
const diff = diffFor(input);
assert.equal(diff.screens.get(surface.id).status, "source-affected");
assert.equal(diff.screens.get(surface.id).status, "not-compared");
assert.equal(diff.counts["needs-review"], 0);
assert.deepEqual(diff.screens.get(surface.id).reviewerChanges, []);
assert.equal(surface.review.status, "needs-review", "the original report is not mutated by reading");
+103
View File
@@ -0,0 +1,103 @@
import assert from "node:assert/strict";
import test from "node:test";
import { Buffer } from "node:buffer";
import { regionShifts } from "../../dist/review/region-shift.js";
/** A 120×160 frame of a light background with dark text-like bars, drawn `offsetY` pixels lower (fractions blend rows). */
function frame(offsetY, { barColor = 40, extraBar = false } = {}) {
const width = 120, height = 160;
const data = Buffer.alloc(width * height * 4, 240);
const bars = [[10, 20, 80, 6], [10, 34, 60, 4], [10, 60, 90, 8], ...(extraBar ? [[10, 90, 70, 6]] : [])];
for (let y = 0; y < height; y += 1) {
for (let x = 0; x < width; x += 1) {
// Coverage of the pixel row [y, y+1) by each bar after the vertical offset, for sub-pixel moves.
let coverage = 0;
for (const [bx, by, bw, bh] of bars) {
if (x < bx || x >= bx + bw) continue;
const top = by + offsetY, bottom = top + bh;
coverage += Math.max(0, Math.min(y + 1, bottom) - Math.max(y, top));
}
const value = Math.round(240 - Math.min(1, coverage) * (240 - barColor));
data.fill(value, (y * width + x) * 4, (y * width + x) * 4 + 3);
data[(y * width + x) * 4 + 3] = 255;
}
}
return { width, height, data };
}
const region = { x: 0, y: 10, width: 110, height: 70 };
test("a region whose content only moved reports how far, to a sixth of a pixel", () => {
assert.deepEqual(regionShifts(frame(0), frame(2), [region]), [{ x: 0, y: 2 }]);
assert.deepEqual(regionShifts(frame(0), frame(-4), [region]), [{ x: 0, y: -4 }]);
const [third] = regionShifts(frame(0), frame(1 / 3), [region]);
assert.ok(third && Math.abs(third.y - 1 / 3) < 0.1 && third.x === 0, JSON.stringify(third));
});
test("a region whose content changed, or that did not change, has no shift", () => {
assert.deepEqual(regionShifts(frame(0), frame(0, { barColor: 200 }), [region]), [undefined], "another colour is a change, not a move");
assert.deepEqual(regionShifts(frame(0), frame(0, { extraBar: true }), [{ x: 0, y: 80, width: 110, height: 30 }]), [undefined], "new content is a change");
assert.deepEqual(regionShifts(frame(0), frame(0), [region]), [undefined], "identical pixels have nothing to explain");
});
test("screenshots of different sizes are not measured", () => {
const small = { ...frame(0), width: 60, data: Buffer.alloc(60 * 160 * 4, 240) };
assert.deepEqual(regionShifts(small, frame(2), [region]), [undefined]);
});
test("a third of a pixel counts as a move even when re-rasterized text explains only part of it, but changed content does not", () => {
// A third of a pixel down, then every bar a shade darker: the shift explains roughly a third of the difference,
// as re-rasterized text does on a 3x screen.
const shifted = frame(1 / 3), base = frame(0);
const noisy = { ...shifted, data: Buffer.from(shifted.data.map((value, index) => (index % 4 === 3 || value === 240 ? value : Math.max(0, value - 14)))) };
const [move] = regionShifts(base, noisy, [region]);
assert.ok(move && Math.abs(move.y - 1 / 3) < 0.1, JSON.stringify(move));
});
test("a best fit at the edge of the search is not a move: repeating content lines up with itself a pitch away", () => {
// Bars repeating every 12 pixels; After is the same pattern 12 pixels lower, which also matches unshifted rows.
const stripes = offset => {
const width = 60, height = 120, data = Buffer.alloc(width * height * 4, 240);
for (let y = 0; y < height; y += 1) if (((y - offset) % 12 + 12) % 12 < 4) for (let x = 0; x < width; x += 1) data.fill(30, (y * width + x) * 4, (y * width + x) * 4 + 3);
for (let i = 3; i < data.length; i += 4) data[i] = 255;
return { width, height, data };
};
// Moved down 5 also fits as up 7: two fits that good are ambiguous, so the region is not a move rather than a wrong one.
assert.deepEqual(regionShifts(stripes(0), stripes(5), [{ x: 0, y: 20, width: 60, height: 60 }]), [undefined]);
});
/** A frame painted by `paint(x, y)` (dark where true) on a light background, optionally in colour. */
function painted(width, height, paint, colour = [30, 30, 30]) {
const data = Buffer.alloc(width * height * 4, 240);
for (let y = 0; y < height; y += 1) for (let x = 0; x < width; x += 1) {
const offset = (y * width + x) * 4;
if (paint(x, y)) { data[offset] = colour[0]; data[offset + 1] = colour[1]; data[offset + 2] = colour[2]; }
data[offset + 3] = 255;
}
return { width, height, data };
}
test("content that is the same all along one axis is measured along the other: full-width bars and hairlines", () => {
const bar = offset => painted(80, 100, (x, y) => y >= 40 + offset && y < 46 + offset);
assert.deepEqual(regionShifts(bar(0), bar(2), [{ x: 0, y: 30, width: 80, height: 30 }]), [{ x: 0, y: 2 }]);
const hairline = offset => painted(80, 100, (x, y) => y === 50 + offset);
assert.deepEqual(regionShifts(hairline(0), hairline(1), [{ x: 0, y: 44, width: 80, height: 12 }]), [{ x: 0, y: 1 }]);
assert.deepEqual(regionShifts(hairline(0), hairline(-3), [{ x: 0, y: 40, width: 80, height: 16 }]), [{ x: 0, y: -3 }]);
});
test("a region that moved and also changed is not a move: the leftover after aligning it gives the change away", () => {
// Three bars moved down 2px, plus a new short bar inside the region, as a digit that changed in a row that moved.
const bars = (offset, extra) => painted(120, 160, (x, y) => (x >= 10 && x < 90 && ((y >= 20 + offset && y < 26 + offset)
|| (y >= 34 + offset && y < 38 + offset) || (y >= 60 + offset && y < 68 + offset))) || (extra && x >= 95 && x < 105 && y >= 45 && y < 48));
assert.deepEqual(regionShifts(bars(0, false), bars(2, false), [region]), [{ x: 0, y: 2 }]);
assert.deepEqual(regionShifts(bars(0, false), bars(2, true), [region]), [undefined]);
// Another colour of the same brightness, moved: luminance alone would call it moved.
const red = painted(120, 160, (x, y) => x >= 10 && x < 90 && y >= 20 && y < 40, [200, 40, 40]);
const green = painted(120, 160, (x, y) => x >= 10 && x < 90 && y >= 22 && y < 42, [40, 112, 40]);
assert.deepEqual(regionShifts(red, green, [region]), [undefined]);
});
test("a half-pixel move up and down is judged alike", () => {
const up = regionShifts(frame(0), frame(-0.5), [region])[0], down = regionShifts(frame(0), frame(0.5), [region])[0];
assert.deepEqual([up?.y, down?.y], [-0.5, 0.5]);
});
+1 -1
View File
@@ -51,7 +51,7 @@ test('round trip: iOS and Android jobs of one run share a single comment: one ro
assert.equal(comment.match(/^### Explore review/gm).length, 1, 'one header');
const routeLines = comment.split('\n').filter(line => /^- `\/(added|removed|home)`/.test(line));
assert.ok(routeLines.length >= 1, `the comment lists changed routes once:\n${comment}`);
assert.equal(routeLines.length, 6, 'each changed screen is listed once');
assert.equal(routeLines.length, 6, `each changed screen is listed once:\n${comment}`);
for (const line of routeLines) assert.ok(/\[iOS\]\(/.test(line) && /\[Android\]\(/.test(line), `each changed route carries both platforms once: ${line}`);
const projection = publicReviewProjection(android.report.review);
for (const surface of android.report.review.surfaces) assert.ok(projection.surfaces[surface.id], `the Viewer projects the Android surface ${surface.id}`);
+26
View File
@@ -180,3 +180,29 @@ test('cached captures go after 30 days unused, then the least recently used past
assert.deepEqual((await readdir(join(environment.EXPLORE_CACHE_DIR, 'captures', 'ios'))), ['c'.repeat(40)]);
assert.ok(newest);
});
test('a screen accessibility-only on one platform and visibly modified on the other counts as modified, whatever the order', async t => {
const { readZipDirectory, readZipEntry } = await import('../../dist/report/zip-reader.js');
const directory = readZipDirectory(review);
const original = JSON.parse(new TextDecoder().decode(await readZipEntry(review, directory.get('review.json'), 50_000_000)));
const variant = async (platform, verdict) => {
const report = structuredClone(original);
report.review.runtime.platform = platform;
const surface = report.review.surfaces.find(entry => entry.id === 'expo-cats-add-9b770c554b11');
surface.review = { status: 'modified', description: 'Changed accessibility label from “Add” to “Add a cat”.',
facts: [{ category: 'accessibility', templateId: 'accessibility.label-changed', bullet: 'Changed accessibility label from “Add” to “Add a cat”.' }] };
surface.visual = { ...surface.visual, verdict, mismatchPercentage: verdict === 'modified' ? 2.4 : 0 };
const folder = await mkdtemp(join(tmpdir(), 'explore-saved-a11y-'));
t.after(() => rm(folder, { recursive: true, force: true }));
await writeFile(join(folder, 'review.json'), JSON.stringify(report));
return zipReportDirectory(folder);
};
const ios = { platform: 'ios', zip: await variant('ios', 'unchanged') };
const android = { platform: 'android', zip: await variant('android', 'modified') };
const alone = (await describeReports([ios])).changes;
assert.equal(alone['accessibility-only'], 1, 'on iOS alone the screenshots match');
const both = (await describeReports([ios, android])).changes;
assert.equal(both['accessibility-only'], undefined);
assert.equal(both.modified, alone.modified + 1, 'the Android visual change is what the run counts');
assert.deepEqual((await describeReports([android, ios])).changes, both);
});
+24
View File
@@ -327,3 +327,27 @@ test("keeps source provenance while reducing the viewer to route-level screens",
false,
);
});
test("a route family is accessibility-only only when every changed member is", () => {
const family = (statuses) => {
// Screens recorded on one router path are one family.
const members = statuses.map((_, index) => screen(`screen-${index}`, `Policy ${index}`, "/policies", [`variant-${index}`]));
const sourceMap = mapWith(members);
const presentation = presentationModel.presentScreensByPath(sourceMap);
const screens = new Map(members.map((member, index) => {
const [status, accessibilityOnly] = statuses[index];
return [member.id, { status, changeSummary: "", reviewerChanges: [], runtimeEvidenceRefs: [], noVisibleChange: false,
...(status !== "added" ? { beforeScreenshot: `before-${index}.png` } : {}), afterScreenshot: `after-${index}.png`,
...(accessibilityOnly ? { accessibilityOnly: true } : {}) }];
}));
const presented = presentationModel.presentBuildDiff({ baselineId: "build-1", map: sourceMap, index: indexMap(sourceMap), screens,
counts: { added: 0, modified: 0, removed: 0, unchanged: 0 } }, presentation);
assert.equal(presented.screens.size, 1, "the members are one family");
return [...presented.screens.values()][0];
};
assert.equal(family([["modified", true], ["modified", true]]).accessibilityOnly, true);
assert.equal(family([["modified", true], ["unchanged", false]]).accessibilityOnly, true);
// An added or visibly modified member is a visible change, so the family is not accessibility-only.
assert.equal(family([["modified", true], ["added", false]]).accessibilityOnly, undefined);
assert.equal(family([["modified", true], ["modified", false]]).accessibilityOnly, undefined);
});
+47
View File
@@ -0,0 +1,47 @@
import assert from "node:assert/strict";
import test from "node:test";
const { tsImport } = await import("tsx/esm/api");
const { groupVisualRegions, formatMove, layoutShiftSummary } = await tsImport("../../viewer/src/utils/visual-diff.ts", import.meta.url);
const move = (y, x = 0, unit = "pt") => ({ x: x / 4, y: y / 8, amount: { x, y }, unit });
const region = (y, height, shift, x = 10, width = 60) => ({ x, y, width, height, share: 10, ...(shift === undefined ? {} : { move: shift }) });
test("areas that moved by the same amount read as one, across a gap that keeps changed areas apart", () => {
// A sheet's title, button and footer moved up about 4pt (measured 3.8–4.3 across its parts), 5% of the height apart.
const sheet = groupVisualRegions([region(60, 5, move(-4)), region(70, 5, move(-4.33)), region(80, 3, move(-3.83)), region(86, 3, move(-4.17))]);
assert.equal(sheet.length, 1);
assert.equal(formatMove(sheet[0]), "↑4.1pt", "one number: the parts' average, to a tenth");
// The same areas with changed content stay apart, as before.
assert.equal(groupVisualRegions([region(60, 5), region(70, 5), region(80, 3)]).length, 3);
// A moved area and a changed one that touch are not merged, and up and down did not move together.
assert.equal(groupVisualRegions([region(60, 5, move(-4)), region(65, 5)]).length, 2);
assert.equal(groupVisualRegions([region(30, 5, move(1)), region(36, 5, move(-1))]).length, 2);
});
test("rows that drifted by different amounts keep their own outlines and numbers", () => {
// List rows a device pixel and more apart: 1, 1.5 and 2pt, as the rows behind euxy's sheet.
const rows = groupVisualRegions([region(40, 5, move(1)), region(46, 5, move(1.5)), region(52, 5, move(2))]);
assert.deepEqual(rows.map(row => formatMove(row)), ["↓1pt", "↓1.5pt", "↓2pt"]);
// Two-thirds of a point apart is a different move too, as on euxy's channel-surf sheet (1.3 and 2pt).
assert.equal(groupVisualRegions([region(40, 5, move(1.33)), region(46, 5, move(2))]).length, 2);
});
test("a moved outline never grows around a changed area", () => {
const changes = groupVisualRegions([region(10, 4, move(1)), region(15, 4), region(20, 4, move(1))]);
assert.deepEqual(changes.map(change => `${change.move ? "moved" : "changed"} ${change.y}`), ["moved 10", "changed 15", "moved 20"]);
});
test("labels are one number, never empty or zero", () => {
assert.equal(formatMove({ move: move(1, 2, "px") }), "→2 ↓1px", "a sideways move is named too, in Android's screenshot pixels");
assert.equal(formatMove({ move: move(1.33) }), "↓1.3pt");
// Two nudges a third of a pixel apart, one sideways and one down, average under a quarter on both axes.
assert.equal(formatMove({ move: move(0.17, 0.16) }), "↓0.2pt");
});
test("What changed summarizes a screen whose every area moved, per direction, and nothing when any content changed", () => {
const moved = groupVisualRegions([region(20, 5, move(1)), region(40, 5, move(2)), region(70, 5, move(-4.17))]);
assert.deepEqual(layoutShiftSummary(moved), ["2 areas moved down 1–2pt.", "1 area moved up 4.2pt."]);
assert.equal(layoutShiftSummary([...moved, ...groupVisualRegions([region(90, 3)])]), undefined);
assert.equal(layoutShiftSummary([]), undefined);
});
+51 -3
View File
@@ -4,7 +4,7 @@ import { webcrypto, createHash } from "node:crypto";
import { deflateRawSync } from "node:zlib";
import { readFileSync } from "node:fs";
import { PREVIEW_CIPHER, previewResponse, type PreviewEnvironment } from "../src/server/preview";
import { loadReport, prefersHtml, prefersMarkdown } from "../../src/report/agent-api";
import { agentApiReply, agentIndexMarkdown, loadReport, prefersHtml, prefersMarkdown } from "../../src/report/agent-api";
import { readZipDirectory } from "../../src/report/zip-reader";
const subtle = webcrypto.subtle as SubtleCrypto;
@@ -105,7 +105,7 @@ test("the token page negotiates: browsers get the shell carrying the agent index
const shell = await browser.text();
assert.ok(shell.startsWith("<!doctype html>"));
assert.match(shell, /<div id="root"><section data-explore-agent-index style="[^"]*clip:rect\(0 0 0 0\)[^"]*"><h1>Expo Explore report: .* PR #\d+/);
assert.match(shell, new RegExp(`href="${origin}/p/${token}/api/v1/screens\\?status=modified,added,removed"`));
assert.match(shell, new RegExp(`href="${origin}/p/${token}/api/v1/screens\\?status=modified,accessibility-only,added,removed"`));
assert.match(shell, /<\/section><\/div><script type="module"/);
assert.equal(browser.headers.get("vary"), "Accept");
assert.equal(browser.headers.get("link"), `<${origin}/p/${token}/api/v1>; rel="alternate"; type="application/json", <${origin}/p/${token}/llms.txt>; rel="alternate"; type="text/markdown"`);
@@ -119,7 +119,7 @@ test("the token page negotiates: browsers get the shell carrying the agent index
const body = await response.text();
assert.match(body, /^# Expo Explore report: /, String(accept));
assert.match(body, /This link stops serving the report after 2030-01-01T00:00:00.000Z/);
assert.ok(body.includes(`(${origin}/p/${token}/api/v1/screens?status=modified,added,removed)`), body);
assert.ok(body.includes(`(${origin}/p/${token}/api/v1/screens?status=modified,accessibility-only,added,removed)`), body);
assert.equal(response.headers.get("content-security-policy"), browser.headers.get("content-security-policy"));
}
const llms = await site.get("/llms.txt", "text/html");
@@ -286,3 +286,51 @@ test("Accept negotiation honours quality values and listing order, and wildcards
assert.equal(prefersMarkdown("text/markdown;q=0"), false);
assert.equal(prefersMarkdown("*/*"), false);
});
test("screens count and filter by what changed visibly: a source change with matching captures is unchanged, even from an older report", async () => {
const surface = (id: string, status: string, review: { status: string; description: string }) =>
({ id, status, sourceScope: "screen", head: { route: `/${id}`, kind: "screen" }, base: { route: `/${id}`, kind: "screen" }, review });
const report = { kind: "explore.report", review: { contract: "explore.review", pullRequest: { origin: "local", repository: "a/b", title: "HEAD vs main", base: { ref: "main", sha: "a".repeat(40) }, head: { ref: "HEAD", sha: "b".repeat(40) } },
runtime: { platform: "ios" }, surfaces: [
surface("tempo", "modified", { status: "modified", description: "Added text “Beat pulse”." }),
surface("enable-midi", "modified", { status: "needs-review", description: "Source changed; no visible difference was captured." }),
surface("lane-editor", "modified", { status: "needs-review", description: "Visual comparison was inconclusive" }),
] }, assets: [] };
const loaded = (await loadReport(zip({ "review.json": new TextEncoder().encode(JSON.stringify(report)) })))!;
const context = { pageUrl: "http://127.0.0.1:1/p/t", platforms: ["ios"], expiresAt: null };
const summary = JSON.parse((await agentApiReply(context, loaded, "", new URLSearchParams(), "application/json")).body as string);
assert.deepEqual(summary.screens, { total: 3, modified: 1, unchanged: 1, "needs-review": 1 });
const modified = JSON.parse((await agentApiReply(context, loaded, "/screens", new URLSearchParams("status=modified"), "application/json")).body as string);
assert.deepEqual(modified.items.map((item: { id: string }) => item.id), ["tempo"]);
const all = JSON.parse((await agentApiReply(context, loaded, "/screens", new URLSearchParams(), "application/json")).body as string);
const midi = all.items.find((item: { id: string }) => item.id === "enable-midi");
assert.deepEqual([midi.status, midi.sourceStatus], ["unchanged", "modified"], "its source status is still there");
});
test("statuses follow the Viewer: accessibility-only, unavailable for a failed or misattributed capture, not-compared for the rest", async () => {
const side = (id: string) => ({ route: `/${id}`, kind: "screen" });
const verified = { status: "captured", landing: "verified", attempts: 1 };
const surface = (id: string, verdict: string) => ({ id, status: "modified", sourceScope: "screen", head: side(id), base: side(id),
headImage: { sha256: "c".repeat(64) }, baseImage: { sha256: "c".repeat(64) }, headOutcome: verified, baseOutcome: verified,
review: { status: "modified", description: "Added button “Edit tempo”." }, visual: { verdict, reason: "matched", threshold: 0.1, tool: "agent-device" } });
const report = { kind: "explore.report", review: { contract: "explore.review", pullRequest: { origin: "local", repository: "a/b", title: "HEAD vs main", base: { ref: "main", sha: "a".repeat(40) }, head: { ref: "HEAD", sha: "b".repeat(40) } },
runtime: { platform: "ios" }, surfaces: [surface("tempo", "modified"), surface("device-picker", "unchanged"),
// Its source changed but nothing was compared: not a change Explore saw.
{ id: "c-explore", status: "modified", sourceScope: "screen", head: side("c/_explore"), base: side("c/_explore") },
// Its head capture failed, and another landed on the wrong screen: both unavailable, as the Viewer says.
{ id: "cards", status: "modified", sourceScope: "screen", head: side("cards"), base: side("cards"), baseImage: { sha256: "c".repeat(64) },
baseOutcome: verified, headOutcome: { status: "failed", attempts: 1, landing: "unverified" } },
{ id: "login", status: "modified", sourceScope: "screen", head: side("login"), base: side("login"), ...{ baseImage: { sha256: "c".repeat(64) }, headImage: { sha256: "c".repeat(64) } },
baseOutcome: verified, headOutcome: { status: "captured", attempts: 2, landing: "unverified", observed: { reason: "landing-mismatch", route: "/home", attempts: 2 } } }] }, assets: [] };
const loaded = (await loadReport(zip({ "review.json": new TextEncoder().encode(JSON.stringify(report)) })))!;
const context = { pageUrl: "http://127.0.0.1:1/p/t", platforms: ["ios"], expiresAt: null };
const summary = JSON.parse((await agentApiReply(context, loaded, "", new URLSearchParams(), "application/json")).body as string);
assert.deepEqual(summary.screens, { total: 5, modified: 1, "accessibility-only": 1, "not-compared": 1, unavailable: 2 });
const unavailable = JSON.parse((await agentApiReply(context, loaded, "/screens", new URLSearchParams("status=unavailable"), "application/json")).body as string);
assert.deepEqual(unavailable.items.map((item: { id: string }) => item.id), ["cards", "login"]);
// The index sentence names every status, so its parts add up to the total.
assert.match(agentIndexMarkdown(context, loaded), /5 screens: 1 modified, 1 accessibility only \(screenshots match, the accessibility tree does not\), 2 unavailable, 1 not compared\./);
assert.match(summary.links.changed, /status=modified,accessibility-only,added,removed/);
const only = JSON.parse((await agentApiReply(context, loaded, "/screens", new URLSearchParams("status=accessibility-only"), "application/json")).body as string);
assert.deepEqual(only.items.map((item: { id: string; status: string; sourceStatus: string }) => [item.id, item.status, item.sourceStatus]), [["device-picker", "accessibility-only", "modified"]]);
});
+3 -9
View File
@@ -12,7 +12,7 @@ import { AppLoading } from "./components/shared/app-loading";
import { ReportLoadingShell } from "./components/shared/report-loading-shell";
import { screenLabel } from "./utils/screen-path";
import { AppPill, PLATFORM_NAMES } from "./components/panels/app-pill";
import { changedScreens, isVisibleChange, type ChangedScreen } from "./utils/changed-screens";
import { changedScreens, focusCounts as countFocusStatuses, isCapturedChange, type ChangedScreen } from "./utils/changed-screens";
import { MapView } from "./components/views/semantic-map";
import { RightPanel } from "./components/panels/right";
import { SearchCommand } from "./components/search-command";
@@ -1181,16 +1181,10 @@ function ViewerApp() {
), [presentedMap, workspace]);
// Focus singles out diff states, so it means nothing without a baseline to diff against.
const focusFilter = diff ? route.focus : [];
const focusCounts = {
added: diff?.counts.added ?? 0,
modified: diff?.counts.modified ?? 0,
removed: diff?.counts.removed ?? 0,
"needs-review": diff?.counts["needs-review"] ?? 0,
"source-affected": diff?.counts["source-affected"] ?? 0,
};
const focusCounts = useMemo(() => countFocusStatuses(diff), [diff]);
const index = diff?.index ?? screenPresentation?.index;
const compareOrder = useMemo(
() => (diff && index ? changedScreens(diff, index).filter(entry => isVisibleChange(diff.screens.get(entry.id))) : []),
() => (diff && index ? changedScreens(diff, index).filter(entry => isCapturedChange(diff.screens.get(entry.id))) : []),
[diff, index],
);
compareOrderRef.current = compareOrder;
+5 -4
View File
@@ -1,15 +1,16 @@
import { diffLabel, type DiffStatus } from "../../utils/build-diff";
import { diffClass, diffLabel, type DiffStatus } from "../../utils/build-diff";
/**
* Colour ring + label chip around a screenshot item on any canvas. It sits outside the
* item's box (negative margins) so layout geometry is untouched. Renders as a span so it can
* sit inside a button.
*/
export function DiffFrame(props: { status?: DiffStatus | undefined; notVisible?: boolean | undefined; children: React.ReactNode }) {
export function DiffFrame(props: { status?: DiffStatus | undefined; accessibilityOnly?: boolean | undefined; children: React.ReactNode }) {
const status = props.status ?? "unchanged";
const label = diffLabel({ status, ...(props.notVisible ? { notVisible: true as const } : {}) });
const diff = { status, ...(props.accessibilityOnly ? { accessibilityOnly: true as const } : {}) };
const label = diffLabel(diff);
return (
<span className={`diff-frame diff-${status}`}>
<span className={`diff-frame ${diffClass(diff)}`}>
{status !== "unchanged" && (
<span className="diff-label" aria-label={`${label} in this build`}>
{label}
@@ -1,6 +1,6 @@
import type { CSSProperties, MouseEventHandler, ReactNode } from "react";
import { ImageOff, PanelRight } from "lucide-react";
import type { DiffStatus } from "../../utils/build-diff";
import { diffClass, type DiffStatus } from "../../utils/build-diff";
import { ScreenPathText } from "../shared/screen-path-text";
import { DEFAULT_SCREENSHOT_SIZE, ScreenshotImage } from "../shared/screenshot-image";
import { CanvasActiveFrame } from "./active-frame";
@@ -15,8 +15,8 @@ export type ScreenScreenshotCardProps = {
/** Shown in place of the image when the run recorded why there is none. */
missingReason?: string;
diff?: DiffStatus;
/** A modified screen whose screenshots match: the label says the change is not visible. */
notVisible?: boolean;
/** A modified screen whose screenshots match: the label says only what assistive technology reads changed. */
accessibilityOnly?: boolean;
className?: string;
style?: CSSProperties;
selected?: boolean;
@@ -56,7 +56,7 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
"screen-screenshot-card",
props.className,
// The status class carries the frame colour to the card, so its handles can share it.
props.diff ? `diff-${props.diff}` : undefined,
props.diff ? diffClass({ status: props.diff, ...(props.accessibilityOnly ? { accessibilityOnly: true as const } : {}) }) : undefined,
props.selected ? "selected" : undefined,
props.highlighted ? "highlighted" : undefined,
].filter(Boolean).join(" ");
@@ -92,7 +92,7 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
aria-label={props.ariaLabel ?? `Open ${props.plainTitle ? props.title : props.path}`}
{...(props.ariaPressed !== undefined ? { "aria-pressed": props.ariaPressed } : {})}
onClick={props.onClick}>
<DiffFrame status={props.diff} notVisible={props.notVisible}>
<DiffFrame status={props.diff} accessibilityOnly={props.accessibilityOnly}>
<span className={`screen-node-image${props.screenshot ? " has-screenshot" : " is-missing"}`}>
{props.screenshot ? (
<ScreenshotImage
@@ -1,10 +1,14 @@
import { useEffect, useRef } from "react";
import { useEffect, useId, useRef } from "react";
import { ChevronLeft, ChevronRight, List } from "lucide-react";
import { ChangesMenu } from "../panels/changes-menu";
import { StatusGlyph } from "../shared/status-icon";
import { Tooltip } from "../shared/tooltip";
import { DIFF_LABELS, type DiffStatus } from "../../utils/build-diff";
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
import { setMeasurementsShown, useMeasurementsShown } from "../../utils/measurements-setting";
/** A screen whose every changed area only moved: how far, per direction, and whether no other finding remains. */
export type LayoutShift = { lines: string[]; nothingElse: boolean };
import type { ComparePicker } from "./compare-section";
/**
@@ -15,6 +19,8 @@ import type { ComparePicker } from "./compare-section";
*/
export function CompareNav(props: {
status: DiffStatus;
/** Modified only in what assistive technology reads: the mark takes that status's colour and shape. */
accessibilityOnly?: boolean | undefined;
route: string;
title: string;
/** Zero-based; below zero when the screen is not in the order. */
@@ -39,7 +45,7 @@ export function CompareNav(props: {
disabled={!desktop || picker.open}>
<button type="button" className="compare-nav-picker" aria-haspopup="true"
aria-expanded={picker.open} onClick={() => picker.onOpenChange(!picker.open)}>
<StatusGlyph status={props.status} label={props.statusLabel ?? DIFF_LABELS[props.status]} />
<StatusGlyph status={props.status} accessibilityOnly={props.accessibilityOnly} label={props.statusLabel ?? DIFF_LABELS[props.status]} />
{/* A route that does not fit loses its start, not the end that names the screen. */}
<code className="compare-nav-route" title={props.title}><bdi>{props.route}</bdi></code>
</button>
@@ -87,21 +93,68 @@ export function CompareSteps(props: {
/**
* What changed on a screen, as the phone's sheet and the desktop popover both list it: CI's
* findings as bullets, then the notes about the comparison under a hairline.
* findings as bullets, then what changed for assistive technology under its own heading, then the
* notes about the comparison under a hairline.
*/
export function WhatChangedContent(props: { facts: string[]; notes: string[] }) {
export function WhatChangedContent(props: {
facts: string[];
assistive?: string[];
accessibilityOnly?: boolean | undefined;
/** Set when every changed area only moved: a line per direction (layoutShiftSummary), and whether nothing else changed. */
layoutShift?: LayoutShift | undefined;
/** Some outlined area moved, so its outline can be labelled with how far. */
measurable?: boolean | undefined;
notes: string[];
}) {
const assistive = props.assistive ?? [];
const assistiveTitle = useId();
const measurements = useMeasurementsShown();
return (
<div className="what-changed-content" role="region" aria-label="What changed on this screen">
{props.layoutShift ? (
<div className="what-changed-shift">
<p>{props.layoutShift.nothingElse ? "Layout shifted. Nothing on this screen changed content." : "Layout shifted."}</p>
<ul className="what-changed-content-list">
{props.layoutShift.lines.map((line) => <li key={line}>{line}</li>)}
</ul>
</div>
) : null}
{props.facts.length > 0 ? (
<ul className="what-changed-content-list">
{props.facts.map((fact) => <li key={fact}>{fact}</li>)}
</ul>
) : null}
{assistive.length > 0 ? (
<section className="what-changed-assistive" aria-labelledby={assistiveTitle}>
<h4 id={assistiveTitle} className="what-changed-assistive-title">
<span className="status-glyph-dot diff-accessibility-only" aria-hidden="true" />
For assistive technology
</h4>
<p className="what-changed-assistive-context">
{props.accessibilityOnly
? "Before and After look the same. Only what screen readers and voice control read changed."
: "Read by screen readers and voice control, not shown in the screenshot."}
</p>
<ul className="what-changed-content-list">
{assistive.map((fact) => <li key={fact}>{fact}</li>)}
</ul>
</section>
) : null}
{props.notes.length > 0 ? (
<div className="what-changed-content-notes">
{props.notes.map((note) => <p key={note}>{note}</p>)}
</div>
) : null}
{props.measurable ? (
<label className="what-changed-measurements">
<span className="what-changed-measurements-text">
<span>Show measurements</span>
<small>How far each outlined area moved</small>
</span>
<input type="checkbox" role="switch" className="what-changed-switch" checked={measurements}
onChange={(event) => setMeasurementsShown(event.target.checked)} />
</label>
) : null}
</div>
);
}
@@ -113,13 +166,17 @@ export function WhatChangedContent(props: { facts: string[]; notes: string[] })
*/
export function WhatChangedPopover(props: {
facts: string[];
assistive?: string[];
accessibilityOnly?: boolean | undefined;
layoutShift?: LayoutShift | undefined;
measurable?: boolean | undefined;
notes: string[];
open: boolean;
onOpenChange: (open: boolean) => void;
}) {
const ref = useRef<HTMLDivElement>(null);
const { open, onOpenChange } = props;
const empty = props.facts.length === 0 && props.notes.length === 0;
const empty = props.facts.length === 0 && !props.assistive?.length && !props.layoutShift && props.notes.length === 0;
useEffect(() => {
if (!open) return;
const onPointerDown = (event: PointerEvent) => {
@@ -149,8 +206,11 @@ export function WhatChangedPopover(props: {
</Tooltip>
{open ? (
<div className="compare-what-changed-popover" role="dialog" aria-modal="false" aria-label="What changed">
<strong className="compare-what-changed-popover-title">What changed</strong>
<WhatChangedContent facts={props.facts} notes={props.notes} />
{/* A screen that changed only for assistive technology has nothing else to title. */}
{props.facts.length > 0 || props.notes.length > 0 || props.layoutShift
? <strong className="compare-what-changed-popover-title">What changed</strong> : null}
<WhatChangedContent facts={props.facts} {...(props.assistive ? { assistive: props.assistive } : {})}
accessibilityOnly={props.accessibilityOnly} layoutShift={props.layoutShift} measurable={props.measurable} notes={props.notes} />
</div>
) : null}
</div>
@@ -196,6 +196,58 @@
}
.what-changed-content-list > li::marker { color: var(--tertiary); }
.what-changed-content-notes { display: flex; flex-direction: column; gap: 6px; }
/* What changed for assistive technology: its own heading, led by Accessibility only's blue square. */
.what-changed-assistive { display: flex; flex-direction: column; gap: 6px; }
.what-changed-content-list + .what-changed-assistive { padding-top: 12px; border-top: 1px solid var(--panel-line); }
.what-changed-assistive-title { display: flex; align-items: center; gap: 8px; margin: 0; color: var(--text); font-size: 13px; font-weight: 600; line-height: 18px; }
.what-changed-assistive-title > .status-glyph-dot { width: 8px; height: 8px; border-radius: 2px; background: var(--diff); }
.what-changed-assistive-context { margin: 0; color: var(--secondary); font-size: 12px; line-height: 17px; }
.what-changed-assistive + .what-changed-content-notes { padding-top: 12px; border-top: 1px solid var(--panel-line); }
/* A screen whose changed areas only moved: the verdict, then how far, per direction. */
.what-changed-shift { display: flex; flex-direction: column; gap: 8px; }
.what-changed-shift > p { margin: 0; color: var(--text); font-size: 13px; line-height: 18px; }
/* Show measurements: a row with a switch, under a hairline, like the hand-off's scope switch. */
.what-changed-measurements {
display: flex;
align-items: center;
justify-content: space-between;
gap: 12px;
padding-top: 12px;
border-top: 1px solid var(--panel-line);
cursor: pointer;
}
.what-changed-measurements-text { display: flex; min-width: 0; flex-direction: column; gap: 2px; font-size: 13px; font-weight: 500; line-height: 18px; }
.what-changed-measurements-text > small { color: var(--secondary); font-size: 12px; font-weight: 400; line-height: 16px; }
.what-changed-switch {
position: relative;
width: 36px;
height: 22px;
flex: none;
margin: 0;
border-radius: 11px;
background: var(--border);
cursor: pointer;
appearance: none;
transition: background 160ms ease;
}
.what-changed-switch::after {
position: absolute;
top: 2px;
left: 2px;
width: 18px;
height: 18px;
border-radius: 9px;
background: #fff;
box-shadow: 0 1px 2px rgb(0 0 0 / 0.25);
content: "";
transition: transform 160ms ease;
}
.what-changed-switch:checked { background: var(--text); }
.what-changed-switch:checked::after { transform: translateX(14px); }
.what-changed-switch:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
@media (prefers-reduced-motion: reduce) {
.what-changed-switch, .what-changed-switch::after { transition: none; }
}
.what-changed-content-list + .what-changed-content-notes { padding-top: 12px; border-top: 1px solid var(--panel-line); }
.what-changed-content-notes > p { margin: 0; color: var(--secondary); font-size: 12px; line-height: 17px; }
@@ -1,10 +1,10 @@
import { useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
import { ImageOff, ScanSearch } from "lucide-react";
import type { ChangesMenuData } from "../panels/changes-menu";
import { diffLabel, NOT_VISIBLE_HIGHLIGHT, type BuildDiff, type ScreenDiff } from "../../utils/build-diff";
import { diffLabel, ACCESSIBILITY_ONLY_HIGHLIGHT, type BuildDiff, type ScreenDiff } from "../../utils/build-diff";
import type { MapIndex } from "../../utils/model";
import type { ChangedScreen } from "../../utils/changed-screens";
import { groupVisualRegions, type VisualChange } from "../../utils/visual-diff";
import { groupVisualRegions, layoutShiftSummary, type VisualChange } from "../../utils/visual-diff";
import { formatShortcut, matchesShortcut, SHORTCUTS, shortcutsLive } from "../../utils/shortcuts";
import { HOLD_INITIAL_DELAY_MS, holdIntervalMs } from "../../utils/key-hold";
import { optionalStorage } from "../../utils/embedded-report";
@@ -13,7 +13,7 @@ import { ToggleGroup } from "../shared/toggle-group";
import { Tooltip } from "../shared/tooltip";
import { DEFAULT_SCREENSHOT_RATIO, ScreenshotImage, ScreenshotPlaceholder } from "../shared/screenshot-image";
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand, SwipeCompare, SWIPE_STEP } from "../panels/visual-diff";
import { placeholderFor, presentedChanges } from "../../utils/presented-changes";
import { placeholderFor, presentedChanges, splitForAssistiveTechnology } from "../../utils/presented-changes";
import { CompareNav, WhatChangedPopover } from "./compare-header";
import "./compare-section.css";
@@ -51,11 +51,14 @@ export function compareModeOptions() {
// Highlight changes (the outlines) is one remembered choice, on unless turned off, shared by
// every view that draws them: Compare, the Inspector's review and its header button, and the O key.
const outlinesListeners = new Set<() => void>();
/** The choice made this visit, so the button works where storage is denied (a private window). */
let outlinesChosen: boolean | undefined;
function storedOutlines(): boolean {
return optionalStorage.getItem(OUTLINES_STORAGE_KEY) !== "false";
return outlinesChosen ?? optionalStorage.getItem(OUTLINES_STORAGE_KEY) !== "false";
}
/** Sets the outlines choice everywhere at once and remembers it. */
/** Sets the outlines choice everywhere at once and remembers it where it can. */
export function setOutlinesShown(shown: boolean) {
outlinesChosen = shown;
optionalStorage.setItem(OUTLINES_STORAGE_KEY, String(shown));
for (const listener of outlinesListeners) listener();
}
@@ -101,10 +104,25 @@ export function useCompareController(options: CompareControllerOptions) {
);
// Only what CI found on this screen. The generic summary ("Shared app source changed.") is
// not a finding about this screen, so it leaves the list empty and the button disabled.
const facts = useMemo(
() => presentedChanges(screenDiff).filter((change) => change.id !== "legacy-summary"),
[screenDiff],
// Every changed area only moved, CI's own count included (it publishes the largest regions only): say how far,
// in place of its generic pixel finding ("Updated visual styling in the main content area").
const shiftLines = useMemo(
() => (screenDiff?.visual?.allRegionsMoved ? layoutShiftSummary(areas) : undefined),
[areas, screenDiff?.visual?.allRegionsMoved],
);
const measurable = areas.some((area) => area.move);
const facts = useMemo(
() => presentedChanges(screenDiff).filter((change) => change.id !== "legacy-summary"
&& !(shiftLines && change.fact?.templateId === "visual.main-content-changed")),
[screenDiff, shiftLines],
);
// "Nothing on this screen changed content" only when no other finding says otherwise.
const layoutShift = useMemo(
() => (shiftLines ? { lines: shiftLines, nothingElse: facts.length === 0 } : undefined),
[shiftLines, facts.length],
);
// What changed for assistive technology is listed under its own heading.
const split = useMemo(() => splitForAssistiveTechnology(facts, screenDiff), [facts, screenDiff]);
const phone = usePhoneLayout();
const [desktopMode, setDesktopMode] = useState<CompareMode>(() => storedMode(MODE_STORAGE_KEY, "split"));
@@ -239,7 +257,7 @@ export function useCompareController(options: CompareControllerOptions) {
const chosenMode: CompareMode = phone ? phoneMode : desktopMode;
const modesDisabled = !comparable;
return {
screen, screenDiff, route, position, previous, next, comparable, areas, facts,
screen, screenDiff, route, position, previous, next, comparable, areas, facts, split, layoutShift, measurable,
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, toggleOutlines,
activeArea, setActiveArea, stepArea, flipSide, flip, swipePosition, setSwipePosition,
aspect, setAspect, factsOpen, setFactsOpen,
@@ -318,8 +336,9 @@ export function CompareSection(props: CompareSectionProps) {
</>
) : null;
const factCopies = facts.map((fact) => fact.copy);
const notes = compareNotes(screenDiff, factCopies.length, statusBarIgnored, homeIndicatorIgnored);
const factCopies = compare.split.visible.map((fact) => fact.copy);
const assistive = compare.split.assistive.map((fact) => fact.copy);
const notes = compareNotes(screenDiff, facts.length, statusBarIgnored, homeIndicatorIgnored);
return (
<section ref={sectionRef} className="compare-section" aria-label={`Compare ${route}`}
@@ -328,7 +347,7 @@ export function CompareSection(props: CompareSectionProps) {
how to look at it, and what to look for. The bottom toolbar stays the same on every section. */}
<header className="compare-top">
<div className="compare-bar">
<CompareNav variant="desktop" status={screenDiff.status} statusLabel={diffLabel(screenDiff)} route={route} title={title}
<CompareNav variant="desktop" status={screenDiff.status} accessibilityOnly={screenDiff.accessibilityOnly} statusLabel={diffLabel(screenDiff)} route={route} title={title}
position={compare.position} count={props.order.length} picker={props.picker}
onPrevious={compare.previous ? () => props.onSelectScreen(compare.previous!.id) : undefined}
onNext={compare.next ? () => props.onSelectScreen(compare.next!.id) : undefined} />
@@ -345,13 +364,14 @@ export function CompareSection(props: CompareSectionProps) {
/>
</div>
<span className="toolbar-divider" aria-hidden="true" />
<Tooltip label={screenDiff.notVisible ? NOT_VISIBLE_HIGHLIGHT : "Highlight changes"} shortcut={formatShortcut(SHORTCUTS.compare.outlines)} placement="bottom">
<Tooltip label={screenDiff.accessibilityOnly ? ACCESSIBILITY_ONLY_HIGHLIGHT : "Highlight changes"} shortcut={formatShortcut(SHORTCUTS.compare.outlines)} placement="bottom">
<button type="button" className="toolbar-button compare-outlines" aria-label="Highlight changes"
aria-pressed={outlines} disabled={areas.length === 0} onClick={toggleOutlines}>
<ScanSearch aria-hidden="true" />
</button>
</Tooltip>
<WhatChangedPopover facts={factCopies} notes={notes} open={factsOpen} onOpenChange={setFactsOpen} />
<WhatChangedPopover facts={factCopies} assistive={assistive} accessibilityOnly={screenDiff.accessibilityOnly}
layoutShift={compare.layoutShift} measurable={compare.measurable} notes={notes} open={factsOpen} onOpenChange={setFactsOpen} />
</div>
</header>
@@ -486,7 +506,7 @@ export function CompareStage(props: StageProps) {
))}
</figcaption>
<div className="compare-frame-wrap">
<button type="button" className="compare-frame compare-flip-frame"
<button type="button" className="compare-frame compare-flip-frame" data-side={showing}
aria-label={`Show ${showing === "after" ? "Before" : "After"}`} onClick={props.onFlip}>
<CompareImage src={showing === "after" ? after : before} alt={`${props.title}, ${showing}`}
placeholder="No screenshot" onAspect={props.onAspect} />
@@ -2,7 +2,7 @@ import { type CSSProperties, type ReactNode } from "react";
import { ChevronDown } from "lucide-react";
import { ToggleGroup } from "../shared/toggle-group";
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand } from "../panels/visual-diff";
import { WhatChangedContent } from "./compare-header";
import { WhatChangedContent, type LayoutShift } from "./compare-header";
import {
CompareStage,
compareModeOptions,
@@ -44,11 +44,16 @@ function ReviewModes(props: {
*/
function WhatChangedAccordion(props: {
facts: string[];
assistive?: string[];
accessibilityOnly?: boolean | undefined;
layoutShift?: LayoutShift | undefined;
measurable?: boolean | undefined;
notes: string[];
open: boolean;
onOpenChange?: (open: boolean) => void;
}) {
const empty = !props.onOpenChange || (props.facts.length === 0 && props.notes.length === 0);
const count = props.facts.length + (props.assistive?.length ?? 0) + (props.layoutShift?.lines.length ?? 0);
const empty = !props.onOpenChange || (count === 0 && props.notes.length === 0);
const open = props.open && !empty;
return (
<section className="what-changed-accordion">
@@ -60,7 +65,7 @@ function WhatChangedAccordion(props: {
onClick={() => props.onOpenChange?.(!props.open)}>
<span className="what-changed-toggle-title">
What changed
{props.facts.length > 0 ? <span className="what-changed-toggle-count">{props.facts.length}</span> : null}
{count > 0 ? <span className="what-changed-toggle-count">{count}</span> : null}
</span>
<ChevronDown aria-hidden="true" />
</button>
@@ -68,7 +73,8 @@ function WhatChangedAccordion(props: {
</div>
{open ? (
<div className="what-changed-accordion-content" id="what-changed-accordion-content">
<WhatChangedContent facts={props.facts} notes={props.notes} />
<WhatChangedContent facts={props.facts} {...(props.assistive ? { assistive: props.assistive } : {})}
accessibilityOnly={props.accessibilityOnly} layoutShift={props.layoutShift} measurable={props.measurable} notes={props.notes} />
</div>
) : null}
</section>
@@ -109,7 +115,8 @@ export function SidebarReview(props: CompareControllerOptions) {
</>
)
: null;
const facts = compare.facts.map((fact) => fact.copy);
const facts = compare.split.visible.map((fact) => fact.copy);
const assistive = compare.split.assistive.map((fact) => fact.copy);
const notes = compareNotes(screenDiff, compare.facts.length, compare.statusBarIgnored, compare.homeIndicatorIgnored);
return (
@@ -140,7 +147,9 @@ export function SidebarReview(props: CompareControllerOptions) {
/>
</div>
<WhatChangedAccordion facts={facts} notes={notes} open={compare.factsOpen} onOpenChange={compare.setFactsOpen} />
<WhatChangedAccordion facts={facts} assistive={assistive} accessibilityOnly={screenDiff.accessibilityOnly}
layoutShift={compare.layoutShift} measurable={compare.measurable} notes={notes}
open={compare.factsOpen} onOpenChange={compare.setFactsOpen} />
</section>
);
}
+3 -3
View File
@@ -17,7 +17,7 @@ import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
import { changedScreens, compareText } from "../../utils/changed-screens";
import "./changes.css";
const STATUSES: FocusStatus[] = ["added", "modified", "removed", "needs-review", "source-affected"];
const STATUSES: FocusStatus[] = ["added", "modified", "accessibility-only", "removed", "needs-review", "source-affected"];
export type ChangesPanelProps = {
diff: BuildDiff;
@@ -176,10 +176,10 @@ export function ChangesPanel(props: ChangesPanelProps) {
<button
type="button"
className={`changes-screen-row diff-${screen.status}`}
aria-label={`Open ${screen.title}, ${DIFF_LABELS[screen.status]}, ${screen.route}`}
aria-label={`Open ${screen.title}, ${FOCUS_LABELS[screen.status]}, ${screen.route}`}
aria-current={screen.id === props.selectedScreenId ? "true" : undefined}
onClick={() => props.onOpenScreen(screen.id)}>
<StatusGlyph status={screen.status} />
<StatusGlyph status={screen.status === "accessibility-only" ? "modified" : screen.status} accessibilityOnly={screen.status === "accessibility-only"} />
<code className="changes-screen-path" title={screen.title}>{screen.route}</code>
</button>
</li>
+6 -4
View File
@@ -23,7 +23,8 @@ import { copyImageToClipboard } from "../../utils/copy-image";
import type { NavigationEdge } from "../../../../src/contracts/navigation-graph";
import { navigationEdgeKey } from "../../utils/source-navigation";
import {
DIFF_LABELS,
diffClass,
diffLabel,
type BuildDiff,
type ScreenDiff,
} from "../../utils/build-diff";
@@ -111,7 +112,8 @@ function TransitionRow(props: {
const { screen, sources, observed } = props.item;
const targetId = screen.id;
const screenshot = artifactUrl(screenshotForScreen(screen, props.index));
const status = props.diff?.screens.get(targetId)?.status ?? "unchanged";
const targetDiff = props.diff?.screens.get(targetId);
const status = targetDiff?.status ?? "unchanged";
const kinds = [...new Set(sources.length
? sources.map(({ edge }) => edge.kind)
: observed.map(transition => transition.actionKind))].sort();
@@ -141,7 +143,7 @@ function TransitionRow(props: {
<span className="transition-copy">
<strong className="transition-path">{screenLabel(screen, props.index)}</strong>
</span>
<span className={`diff-dot diff-${status}`} title={DIFF_LABELS[status]} />
<span className={`diff-dot ${diffClass(targetDiff ?? { status })}`} title={diffLabel(targetDiff ?? { status })} />
<ChevronRight size={13} aria-hidden="true" />
</button>
</Tooltip>
@@ -347,7 +349,7 @@ function ScreenDiffSection(props: {
: { ...current, [screenshot]: aspectRatio }
));
};
// CI compares the two images pixel for pixel, so the same areas are outlined on both sides.
// The same areas are outlined on both sides; an area that only moved sits where its content is on each.
const outlines = visualChanges.length > 0 ? <ChangeOutlines changes={visualChanges} /> : null;
return (
+3 -3
View File
@@ -4,7 +4,7 @@ import { Tooltip } from "../shared/tooltip";
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
import { InspectorPanel } from "./inspector";
import type { ChangedScreen } from "../../utils/changed-screens";
import { diffLabel, NOT_VISIBLE_HIGHLIGHT, type BuildDiff } from "../../utils/build-diff";
import { diffLabel, ACCESSIBILITY_ONLY_HIGHLIGHT, type BuildDiff } from "../../utils/build-diff";
import type { MapIndex, Screen } from "../../utils/model";
import type { TransitionDirection } from "../../utils/navigation";
import { displayPathForScreen } from "../../utils/screen-path";
@@ -93,7 +93,7 @@ export function RightPanel(props: RightPanelProps) {
{/* The screen's status as Compare's header and the Changes list mark it: a dot (+ or −
for added or removed) in the status colour, named for screen readers. */}
{screenDiff ? (
<StatusGlyph status={screenDiff.status} label={diffLabel(screenDiff)}
<StatusGlyph status={screenDiff.status} accessibilityOnly={screenDiff.accessibilityOnly} label={diffLabel(screenDiff)}
className="inspector-diff-status" />
) : null}
{props.index.plainTitles ? (
@@ -114,7 +114,7 @@ export function RightPanel(props: RightPanelProps) {
both in place, off. */}
{props.screen && props.diff && props.onOpenCompare ? (
<>
<Tooltip label={screenDiff?.notVisible ? NOT_VISIBLE_HIGHLIGHT : "Highlight changes"} shortcut={formatShortcut(SHORTCUTS.compare.outlines)} placement="bottom-end">
<Tooltip label={screenDiff?.accessibilityOnly ? ACCESSIBILITY_ONLY_HIGHLIGHT : "Highlight changes"} shortcut={formatShortcut(SHORTCUTS.compare.outlines)} placement="bottom-end">
<button type="button" className="icon-button inspector-highlight" aria-label="Highlight changes"
aria-pressed={outlinable ? outlines : false} disabled={!outlinable}
onClick={() => setOutlinesShown(!outlines)}>
@@ -19,6 +19,35 @@
box-shadow: 0 0 0 3px color-mix(in srgb, var(--modified) 35%, transparent);
}
.visual-change-outlines.has-active .visual-change-outline:not(.active) { opacity: 0.35; }
/* An area that only moved: dashed and quiet, in the slate of a measurement rather than the orange of a change. */
.visual-change-outline.moved {
border: 1.5px dashed var(--moved);
background: transparent;
}
.visual-change-outline.moved.active {
background: color-mix(in srgb, var(--moved) 14%, transparent);
box-shadow: 0 0 0 3px color-mix(in srgb, var(--moved) 30%, transparent);
}
/* How far it moved, riding the outline's top right corner. */
.visual-change-measure {
position: absolute;
top: 0;
right: 0;
padding: 0 5px;
border-radius: 5px;
color: #fff;
background: var(--moved);
font-family: "JetBrains Mono", ui-monospace, SFMono-Regular, Menlo, monospace;
font-size: 10px;
font-weight: 600;
line-height: 15px;
white-space: nowrap;
transform: translate(4px, -60%);
}
:root[data-theme="dark"] .visual-change-measure { color: #0b0c0e; }
/* The Before side draws moved areas where their content was (see ChangeOutlines): Compare's sides and the
Inspector's side-by-side pair. */
.compare-side[data-side="before"], .compare-flip-frame[data-side="before"], [data-diff-side="before"] { --outline-before: 1; }
/* The status-bar band CI does not compare: blurred out, explained by its tooltip on hover. */
.visual-status-bar-band {
+15 -9
View File
@@ -1,36 +1,42 @@
import { useRef, useState, type CSSProperties, type KeyboardEvent, type PointerEvent } from "react";
import { ChevronsLeftRight } from "lucide-react";
import { outlineRect, type VisualChange } from "../../utils/visual-diff";
import { formatMove, outlineRect, type VisualChange } from "../../utils/visual-diff";
import { useMeasurementsShown } from "../../utils/measurements-setting";
import { HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM, STATUS_BAR_BAND_PERCENT } from "../../../../src/contracts/capture";
import { ScreenshotImage } from "../shared/screenshot-image";
import "./visual-diff.css";
/**
* Outlines over a screenshot, one per changed area. The same rectangles go on Before and After:
* CI compares the two images pixel for pixel, so an area has one position, not one per side.
* The parent must be positioned.
* Outlines over a screenshot, one per changed area. An area whose content changed has one position, the same
* on Before and After. An area that only moved is dashed and drawn where its content is on each side, labelled
* with how far it moved while measurements are shown. The parent must be positioned.
*/
export function ChangeOutlines(props: {
changes: readonly VisualChange[];
activeIndex?: number | undefined;
}) {
const measurements = useMeasurementsShown();
return (
<span
className={`visual-change-outlines${props.activeIndex !== undefined ? " has-active" : ""}`}
aria-hidden="true">
{props.changes.map((change, index) => {
const rect = outlineRect(change);
// A moved area sits where its content is on each side: the Before side (--outline-before: 1) draws it
// back by the move, so the outline jumps by the amount on its label when the sides flip.
const back = (offset: number, move: number | undefined) => (move ? `calc(${offset}% - var(--outline-before, 0) * ${move}%)` : `${offset}%`);
return (
<span
key={index}
className={`visual-change-outline${props.activeIndex === index ? " active" : ""}`}
className={`visual-change-outline${change.move ? " moved" : ""}${props.activeIndex === index ? " active" : ""}`}
style={{
left: `${rect.x}%`,
top: `${rect.y}%`,
left: back(rect.x, change.move?.x),
top: back(rect.y, change.move?.y),
width: `${rect.width}%`,
height: `${rect.height}%`,
}}
/>
}}>
{change.move && measurements ? <span className="visual-change-measure">{formatMove(change)}</span> : null}
</span>
);
})}
</span>
@@ -45,8 +45,9 @@ export function PhoneCompare(props: CompareControllerOptions & {
{compare.homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
</>
) : null;
const facts = compare.facts.map((fact) => fact.copy);
const notes = compareNotes(screenDiff, facts.length, compare.statusBarIgnored, compare.homeIndicatorIgnored);
const facts = compare.split.visible.map((fact) => fact.copy);
const assistive = compare.split.assistive.map((fact) => fact.copy);
const notes = compareNotes(screenDiff, compare.facts.length, compare.statusBarIgnored, compare.homeIndicatorIgnored);
const previous = compare.previous ? () => props.onSelectScreen(compare.previous!.id) : undefined;
const next = compare.next ? () => props.onSelectScreen(compare.next!.id) : undefined;
// A tap near either side of the stage steps through the screens, like the stepper in the header. It runs
@@ -67,14 +68,14 @@ export function PhoneCompare(props: CompareControllerOptions & {
return (
<section className="phone-compare" aria-label={`Compare ${route}`}>
<header className="phone-compare-head">
<CompareNav variant="phone" status={screenDiff.status} statusLabel={diffLabel(screenDiff)} route={route} title={screen.title}
<CompareNav variant="phone" status={screenDiff.status} accessibilityOnly={screenDiff.accessibilityOnly} statusLabel={diffLabel(screenDiff)} route={route} title={screen.title}
position={compare.position} count={props.order.length} picker={props.picker} stepsApart />
<button type="button" className="phone-icon-button" aria-label="Outlines" aria-pressed={compare.outlines}
disabled={areas.length === 0} onClick={compare.toggleOutlines}>
<ScanSearch aria-hidden="true" />
</button>
<button type="button" className="phone-icon-button" aria-label="What changed" aria-haspopup="dialog"
disabled={facts.length === 0 && notes.length === 0} onClick={() => compare.setFactsOpen(true)}>
disabled={compare.facts.length === 0 && !compare.layoutShift && notes.length === 0} onClick={() => compare.setFactsOpen(true)}>
<List aria-hidden="true" />
</button>
{props.headerAction}
@@ -121,7 +122,8 @@ export function PhoneCompare(props: CompareControllerOptions & {
</div>
<PhoneSheet title="What changed" open={compare.factsOpen} onClose={() => compare.setFactsOpen(false)}>
<WhatChangedContent facts={facts} notes={notes} />
<WhatChangedContent facts={facts} assistive={assistive} accessibilityOnly={screenDiff.accessibilityOnly}
layoutShift={compare.layoutShift} measurable={compare.measurable} notes={notes} />
</PhoneSheet>
</section>
);
+4 -3
View File
@@ -1,17 +1,18 @@
import { Minus, Plus } from "lucide-react";
import type { DiffStatus } from "../../utils/build-diff";
import { diffClass, type DiffStatus } from "../../utils/build-diff";
/**
* A screen's diff status as a bare glyph in the status colour: + added, − removed, a dot for the
* rest. The Changes list marks its rows with it; a header that names the same screen uses it too.
* With a label it is an image of that name; without one it is decoration beside text that says it.
* An accessibility-only change is a square in its own colour, so it does not rest on colour alone.
*/
export function StatusGlyph(props: { status: DiffStatus; label?: string; className?: string }) {
export function StatusGlyph(props: { status: DiffStatus; accessibilityOnly?: boolean | undefined; label?: string; className?: string }) {
const glyph = props.status === "added" ? <Plus />
: props.status === "removed" ? <Minus />
: <span className="status-glyph-dot" />;
return (
<span className={`status-glyph diff-${props.status}${props.className ? ` ${props.className}` : ""}`}
<span className={`status-glyph ${diffClass({ status: props.status, ...(props.accessibilityOnly ? { accessibilityOnly: true as const } : {}) })}${props.className ? ` ${props.className}` : ""}`}
{...(props.label ? { role: "img", "aria-label": props.label } : { "aria-hidden": true })}>
{glyph}
</span>
+1
View File
@@ -136,6 +136,7 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
cursor: pointer;
}
.screens-tree-dot[class*="diff-"] { background: var(--diff); }
.screens-tree-dot.diff-accessibility-only { border-radius: 2px; }
.screens-tree-dot.elsewhere { background: color-mix(in srgb, var(--modified) 50%, transparent); }
.screens-tree-legend {
display: flex;
+10 -9
View File
@@ -2,8 +2,8 @@ import { useEffect, useMemo, useRef, useState, type CSSProperties, type Keyboard
import { ChevronRight, ChevronsDownUp, ChevronsUpDown, ListTree } from "lucide-react";
import { artifactUrl, isLaunchScreen, type ExploreMap, type MapIndex, type Screen } from "../../utils/model";
import { primaryScreenshotForScreen, screenshotSize } from "../../utils/screen-images";
import type { BuildDiff, DiffStatus } from "../../utils/build-diff";
import { isVisibleChange } from "../../utils/changed-screens";
import { diffClass, type BuildDiff, type DiffStatus } from "../../utils/build-diff";
import { focusStatusOf, isCapturedChange } from "../../utils/changed-screens";
import { displayPathForScreen, screenLabel } from "../../utils/screen-path";
import { screenTree, treeIndex, treeNodeKey, type ScreenTree, type ScreenTreeNode } from "../../utils/screen-tree";
import type { Appearance } from "../../utils/appearance";
@@ -13,7 +13,7 @@ import { useCanvasVisibleFrame } from "../canvas/visible-frame-provider";
import { PhoneSheet } from "../phone/phone-chrome";
import "./screens.css";
/** The statuses a tree dot marks. The Changed filter keeps only the screens that look different (isVisibleChange). */
/** The statuses a tree dot marks. The Changed filter keeps only the screens whose captures differ (isCapturedChange). */
const CHANGED_STATUSES = new Set<DiffStatus>(["modified", "added", "removed", "needs-review", "source-affected"]);
type Filter = "changed" | "all";
@@ -45,13 +45,13 @@ function statusOf(diff: BuildDiff | undefined, id: string): DiffStatus | undefin
}
function isChanged(diff: BuildDiff | undefined, id: string): boolean {
return isVisibleChange(diff?.screens.get(id));
return isCapturedChange(diff?.screens.get(id));
}
/** The dot beside a tree row: changed here, changed only in another appearance, or nothing. */
function dotClass(diff: BuildDiff | undefined, elsewhere: ReadonlyMap<string, Appearance[]> | undefined, id: string): string | undefined {
const status = statusOf(diff, id);
if (status && CHANGED_STATUSES.has(status)) return `diff-${status}`;
const screen = diff?.screens.get(id);
if (screen && CHANGED_STATUSES.has(screen.status)) return diffClass(screen);
if (elsewhere?.get(id)?.length) return "elsewhere";
return undefined;
}
@@ -109,7 +109,7 @@ function ScreenCell(props: {
{...(url ? { screenshot: url } : {})}
{...(size ? size : {})}
{...(status ? { diff: status } : {})}
{...(props.diff?.screens.get(props.screen.id)?.notVisible ? { notVisible: true } : {})}
{...(props.diff?.screens.get(props.screen.id)?.accessibilityOnly ? { accessibilityOnly: true } : {})}
selected={props.selected}
ariaPressed={props.selected}
loading="lazy"
@@ -188,14 +188,15 @@ function TreeRows(props: {
});
}
/** Changed and Accessibility only always: a reader learns the kinds even on a report without one. */
function Legend(props: { others: Appearance[] }) {
return (
<div className="screens-tree-legend">
<span><span className="screens-tree-dot diff-modified" aria-hidden="true" />Changed</span>
<span><span className="screens-tree-dot diff-modified diff-accessibility-only" aria-hidden="true" />Accessibility only</span>
{props.others.length ? (
<span><span className="screens-tree-dot elsewhere" aria-hidden="true" />Changed in {props.others.join(" and ")} only</span>
) : null}
<span><span className="screens-tree-dot diff-source-affected" aria-hidden="true" />Source-affected</span>
</div>
);
}
@@ -392,7 +393,7 @@ export function ScreensView(props: ScreensViewProps) {
elsewhere={isChanged(props.diff, id) ? undefined : props.changedElsewhere?.get(id)}
via={tree.via.get(id)}
selected={props.selectedScreenId === id}
dimmed={Boolean(props.focus?.length) && !props.focus!.some((state) => state === statusOf(props.diff, id))}
dimmed={Boolean(props.focus?.length) && !props.focus!.some((state) => state === focusStatusOf(props.diff?.screens.get(id)))}
onSelect={() => props.onSelectScreen(id)} />
) : null;
})}
+6 -4
View File
@@ -23,6 +23,7 @@ import type { BuildDiff, DiffStatus } from "../../utils/build-diff";
import { CANVAS_MAX_ZOOM } from "../../utils/canvas-zoom";
import { usePhoneLayout } from "../../utils/phone-layout";
import type { FocusBehavior, FocusRequest, FocusStatus, MapDirection } from "../../utils/navigation";
import { focusStatusOf } from "../../utils/changed-screens";
import { displayPathForScreen } from "../../utils/screen-path";
import { shortcutsLive } from "../../utils/shortcuts";
import { mapKeyDirection, mapKeyTarget } from "../../utils/map-keyboard";
@@ -58,7 +59,7 @@ type ScreenNodeData = {
highlighted: boolean;
direction: MapDirection;
diff?: DiffStatus;
notVisible?: boolean;
accessibilityOnly?: boolean;
projectionDelayMs?: number;
projectionScreenScale?: number;
projectionMotion: ProjectionMotionMetadata;
@@ -93,7 +94,7 @@ function ScreenNodeCard({ data, selected }: NodeProps<ScreenGraphNode>) {
{...(data.screenshot ? { screenshot: data.screenshot } : {})}
{...(data.missingReason ? { missingReason: data.missingReason } : {})}
{...(data.diff ? { diff: data.diff } : {})}
{...(data.notVisible ? { notVisible: true } : {})}
{...(data.accessibilityOnly ? { accessibilityOnly: true } : {})}
selected={selected}
highlighted={data.highlighted}
style={{
@@ -287,7 +288,8 @@ function projectionElements(
const screenshot = structure.screenshots.get(screen.id);
const highlighted = false;
const status = diff?.screens.get(screen.id)?.status;
const muted = focus.length > 0 && !focus.some((state) => state === status);
const focusStatus = focusStatusOf(diff?.screens.get(screen.id));
const muted = focus.length > 0 && !focus.some((state) => state === focusStatus);
const projectionMotion: ProjectionMotionMetadata = {
motionKey: `screen:${screen.id}`,
role: "screen",
@@ -318,7 +320,7 @@ function projectionElements(
highlighted,
direction: structure.horizontal ? "LR" : "TB",
...(status ? { diff: status } : {}),
...(diff?.screens.get(screen.id)?.notVisible ? { notVisible: true } : {}),
...(diff?.screens.get(screen.id)?.accessibilityOnly ? { accessibilityOnly: true } : {}),
projectionMotion,
onSelect: onSelectScreen,
onHover: onHoverScreen,
+21 -5
View File
@@ -10,6 +10,7 @@ import type {
import {
captureNotes,
visualDiff,
type RegionMove,
type ReviewerChangeCategory,
type ReviewRuntimeEvidence,
type ViewerReviewProjection,
@@ -50,7 +51,21 @@ function comparisonStatus(surface: Surface): BuildComparisonEntry["status"] {
if (captureUnavailable(surface, "base") || unattributed("base")) return "unavailable";
}
if (surface.status === "added" || surface.status === "removed") return surface.status;
return comparisonReview(surface)?.status ?? (surface.status === "modified" ? "source-affected" : "not-compared");
// A source change with no comparison is not a change the captures show: not compared, whatever the source did.
return comparisonReview(surface)?.status ?? "not-compared";
}
/**
* A region's move in percent of the image, from its pixel shift and the image size its rect implies. iOS
* screenshots are one pixel per point; Android's are in the screenshot's own pixels, since the report does not
* know the screen's density.
*/
function regionMove(region: NonNullable<NonNullable<Surface["visual"]>["regions"]>[number], platform: "ios" | "android" | undefined): RegionMove | undefined {
const { shift, rect, normalizedRect } = region;
if (!shift || !(normalizedRect.width > 0) || !(normalizedRect.height > 0)) return undefined;
const imageWidth = (rect.width * 100) / normalizedRect.width;
const imageHeight = (rect.height * 100) / normalizedRect.height;
return { x: (shift.x * 100) / imageWidth, y: (shift.y * 100) / imageHeight, amount: { x: shift.x, y: shift.y }, unit: platform === "android" ? "px" : "pt" };
}
/** The side's route exists and was planned, but its capture ended without a screenshot. */
@@ -571,10 +586,11 @@ export function publicReviewProjection(review: PublicReview): ViewerReviewProjec
...(surface.visual?.mismatchPercentage !== undefined ? { mismatchPercentage: surface.visual.mismatchPercentage } : {}),
...(surface.visual?.ignoredStatusBarRegions ? { ignoredStatusBarRegions: surface.visual.ignoredStatusBarRegions } : {}),
...(surface.visual?.ignoredHomeIndicatorRegions ? { ignoredHomeIndicatorRegions: surface.visual.ignoredHomeIndicatorRegions } : {}),
regions: (surface.visual?.regions ?? []).map((region) => ({
...region.normalizedRect,
share: region.shareOfDiffPercentage,
})),
...(surface.visual?.allRegionsMoved ? { allRegionsMoved: true } : {}),
regions: (surface.visual?.regions ?? []).map((region) => {
const move = regionMove(region, review.runtime.platform);
return { ...region.normalizedRect, share: region.shareOfDiffPercentage, ...(move ? { move } : {}) };
}),
})
: undefined;
// A side that exists in its revision but has no screenshot says why, in the report's words.
+13
View File
@@ -64,6 +64,11 @@
/* Modified is orange in both themes, as in the PR comment (🟧). Yellow means "needs review". */
--modified: #ea580c;
--modified-soft: #ffefd6;
/* Accessibility only is blue, as in the PR comment (🟦), deeper than the accent a screen variant uses. */
--accessibility: #2f6feb;
--accessibility-soft: #e8f0fe;
/* A measurement: slate, quieter than any change colour. */
--moved: #5b6b85;
--graph-dot: #d9d9e0;
--graph-line: #8b8d98;
--graph-line-soft: #c5c7ce;
@@ -181,6 +186,9 @@
--purple-soft: #301c3b;
--modified: #ff9a3c;
--modified-soft: #331e0b;
--accessibility: #8fa8ff;
--accessibility-soft: #17224a;
--moved: #9fb0cc;
--graph-dot: #212225;
--graph-line: #696e77;
--graph-line-soft: #3f4349;
@@ -1665,6 +1673,11 @@ code {
/* Modified reads orange everywhere: the Changes list, the canvas chip and border, the Inspector badge. */
.diff-modified { --diff: var(--modified); --diff-soft: var(--modified-soft); }
.diff-removed { --diff: var(--danger); --diff-soft: var(--danger-soft); }
/* Accessibility only: modified for assistive technology, with matching screenshots. It keeps Modified's frame
(it carries diff-modified too) in blue, and its marks are squares, so it does not rest on colour alone. */
.diff-accessibility-only { --diff: var(--accessibility); --diff-soft: var(--accessibility-soft); }
.diff-accessibility-only.diff-dot,
.diff-accessibility-only .status-glyph-dot { border-radius: 2px; }
.diff-unchanged { --diff: var(--tertiary); --diff-soft: var(--element); }
.diff-needs-review { --diff: var(--tertiary); --diff-soft: var(--element); }
.diff-source-affected { --diff: var(--purple); --diff-soft: var(--purple-soft); }
+20 -8
View File
@@ -67,16 +67,28 @@ export type ScreenDiff = {
reviewerChanges: ReviewerChangeFact[];
runtimeEvidenceRefs: string[];
noVisibleChange: boolean;
/** Modified in what the review read (the accessibility tree, text), with no pixel difference: nothing to outline. */
notVisible?: true;
/**
* Modified only in what assistive technology reads (the accessibility tree): the screenshots match, so there is
* nothing to outline. Screen readers and voice control still see the change, so it is reviewed like any other.
*/
accessibilityOnly?: true;
};
/** Why Highlight changes is off for a change that is not visible. */
export const NOT_VISIBLE_HIGHLIGHT = "Nothing to highlight: the screenshots match";
/** Why Highlight changes is off for an accessibility-only change. */
export const ACCESSIBILITY_ONLY_HIGHLIGHT = "Nothing to highlight: only what assistive technology reads changed";
/** A screen's status as the Viewer names it: a modified screen whose screenshots match says the change is not visible. */
export function diffLabel(diff: Pick<ScreenDiff, "status" | "notVisible">): string {
return diff.notVisible && diff.status === "modified" ? "Changed (not visible)" : DIFF_LABELS[diff.status];
/** A screen's status as the Viewer names it: a modified screen whose screenshots match changed for assistive technology only. */
export function diffLabel(diff: Pick<ScreenDiff, "status" | "accessibilityOnly">): string {
return isAccessibilityOnly(diff) ? "Accessibility only" : DIFF_LABELS[diff.status];
}
export function isAccessibilityOnly(diff: Pick<ScreenDiff, "status" | "accessibilityOnly"> | undefined): boolean {
return diff?.status === "modified" && Boolean(diff.accessibilityOnly);
}
/** The class that colours a screen's status: an accessibility-only change keeps Modified's frame in its own colour. */
export function diffClass(diff: Pick<ScreenDiff, "status" | "accessibilityOnly">): string {
return isAccessibilityOnly(diff) ? "diff-modified diff-accessibility-only" : `diff-${diff.status}`;
}
export type BuildDiff = {
@@ -355,7 +367,7 @@ export function buildDiff(options: {
reviewerChanges: reviewSurface?.reviewerChanges ?? [],
runtimeEvidenceRefs: reviewSurface?.runtimeEvidenceRefs ?? [],
noVisibleChange: screen.status === "unchanged" && (reviewSurface?.noVisibleChange ?? false),
...(screen.status === "modified" && reviewSurface?.pixelsUnchanged ? { notVisible: true as const } : {}),
...(screen.status === "modified" && reviewSurface?.pixelsUnchanged ? { accessibilityOnly: true as const } : {}),
...(before ?? borrowed.before ? { beforeScreenshot: (before ?? borrowed.before)! } : {}),
...(after ?? borrowed.after ? { afterScreenshot: (after ?? borrowed.after)! } : {}),
...(redirectTo && (borrowed.before || borrowed.after) ? { redirectTo } : {}),
+28 -10
View File
@@ -1,15 +1,17 @@
import type { BuildDiff, DiffStatus, ScreenDiff } from "./build-diff";
import { isAccessibilityOnly, type BuildDiff, type DiffStatus, type ScreenDiff } from "./build-diff";
import type { MapIndex } from "./model";
import { isLaunchScreen } from "./model";
import type { FocusStatus } from "./navigation";
import { displayPathForScreen } from "./screen-path";
/** Review order: the visible changes first, then what changed only for assistive technology. */
const STATUS_ORDER: Record<FocusStatus, number> = {
added: 0,
modified: 1,
removed: 2,
"needs-review": 3,
"source-affected": 4,
"accessibility-only": 3,
"needs-review": 4,
"source-affected": 5,
};
export type ChangedScreen = {
@@ -19,17 +21,33 @@ export type ChangedScreen = {
route: string;
};
export function isChangedStatus(status: DiffStatus): status is FocusStatus {
/** The status the Changes filter and focus match a screen on: Accessibility only apart from Modified. */
export function focusStatusOf(diff: Pick<ScreenDiff, "status" | "accessibilityOnly"> | undefined): DiffStatus | "accessibility-only" | undefined {
return isAccessibilityOnly(diff) ? "accessibility-only" : diff?.status;
}
/** Each focus status's count: Modified counts only the visible changes, Accessibility only the rest. */
export function focusCounts(diff: BuildDiff | undefined): Record<FocusStatus, number> {
const counts: Record<FocusStatus, number> = { added: 0, modified: 0, "accessibility-only": 0, removed: 0, "needs-review": 0, "source-affected": 0 };
for (const screen of diff?.screens.values() ?? []) {
const status = focusStatusOf(screen);
if (status && status in counts) counts[status as FocusStatus] += 1;
}
return counts;
}
export function isChangedStatus(status: DiffStatus): status is Exclude<FocusStatus, "accessibility-only"> {
return status !== "unchanged" && status !== "not-compared" && status !== "unavailable" && status !== "variant";
}
/**
* A change the captures show: an added or removed screen, or a modified one whose pixels differ. A screen whose
* source changed but whose captures look the same ("No visible change", source-affected, or modified with
* unchanged pixels) stays in the Changes list, but Compare does not step through it and Screens' Changed hides it.
* A change the captures show: an added, removed or modified screen, including one modified only in what assistive
* technology reads (its screenshots match, its accessibility tree does not). A screen whose source changed but whose
* captures show nothing different ("No visible change") stays in the Changes list, but Compare does
* not step through it and Screens' Changed hides it.
*/
export function isVisibleChange(diff: Pick<ScreenDiff, "status" | "notVisible"> | undefined): boolean {
return diff !== undefined && (diff.status === "added" || diff.status === "removed" || (diff.status === "modified" && !diff.notVisible));
export function isCapturedChange(diff: Pick<ScreenDiff, "status"> | undefined): boolean {
return diff !== undefined && (diff.status === "added" || diff.status === "removed" || diff.status === "modified");
}
export function compareText(left: string, right: string): number {
@@ -58,7 +76,7 @@ export function changedScreens(diff: BuildDiff, index: MapIndex): ChangedScreen[
if (!isChangedStatus(screenDiff.status)) continue;
const screen = index.screens.get(id);
if (!screen) continue;
result.push({ id, status: screenDiff.status, title: screen.title, route: displayPathForScreen(screen) });
result.push({ id, status: isAccessibilityOnly(screenDiff) ? "accessibility-only" : screenDiff.status, title: screen.title, route: displayPathForScreen(screen) });
}
return result.sort(compareChangedScreens);
}
+30
View File
@@ -0,0 +1,30 @@
import { useSyncExternalStore } from "react";
import { optionalStorage } from "./embedded-report";
const MEASUREMENTS_STORAGE_KEY = "expo-explore:compare-measurements";
const listeners = new Set<() => void>();
/** The choice made this visit: storage can be denied (a private window), and the switch must still work. */
let chosen: boolean | undefined;
function stored(): boolean {
return chosen ?? optionalStorage.getItem(MEASUREMENTS_STORAGE_KEY) !== "false";
}
/** Shows or hides how far each moved area moved, everywhere at once, and remembers the choice where it can. */
export function setMeasurementsShown(shown: boolean) {
chosen = shown;
optionalStorage.setItem(MEASUREMENTS_STORAGE_KEY, String(shown));
for (const listener of listeners) listener();
}
/** Whether outlines label how far each moved area moved: on until a reader turns it off in What changed. */
export function useMeasurementsShown(): boolean {
return useSyncExternalStore(
(onChange) => {
listeners.add(onChange);
return () => listeners.delete(onChange);
},
stored,
() => true,
);
}
+4 -2
View File
@@ -8,7 +8,8 @@ export type ThemePreference = "light" | "dark" | "system";
export type MapDirection = "TB" | "LR";
/** The explicitly selected amount of Map hierarchy, independent from camera zoom. */
/** The diff states the canvas can single out. An empty selection is "All": nothing drops back. */
export type FocusStatus = "added" | "modified" | "removed" | "needs-review" | "source-affected";
/** `accessibility-only`: a modified screen whose screenshots match, filtered apart from the visible changes. */
export type FocusStatus = "added" | "modified" | "accessibility-only" | "removed" | "needs-review" | "source-affected";
/** The right panel shows Session and Diff. */
export type InspectView = "session" | "diff";
/** Which way the inspector's transition list reads: into the screen, or out of it. */
@@ -83,7 +84,7 @@ export type FocusRequest = {
const CANVASES: CanvasView[] = ["map", "screens", "compare"];
const INSPECTS: InspectView[] = ["session", "diff"];
const DIRECTIONS: TransitionDirection[] = ["in", "out"];
const FOCUSES: FocusStatus[] = ["added", "modified", "removed", "needs-review", "source-affected"];
const FOCUSES: FocusStatus[] = ["added", "modified", "accessibility-only", "removed", "needs-review", "source-affected"];
function isCanvas(value: string | null | undefined): value is CanvasView {
return CANVASES.includes(value as CanvasView);
@@ -326,6 +327,7 @@ export const CANVAS_DESCRIPTIONS: Record<CanvasView, string> = {
export const FOCUS_LABELS: Record<FocusStatus, string> = {
added: "Added",
modified: "Modified",
"accessibility-only": "Accessibility only",
removed: "Removed",
"needs-review": "No visible change",
"source-affected": "Source-affected",
+14 -1
View File
@@ -1,4 +1,4 @@
import type { DiffStatus, ScreenDiff } from "./build-diff";
import { isAccessibilityOnly, type DiffStatus, type ScreenDiff } from "./build-diff";
import { formatReviewerChange, sortReviewerChanges, type CaptureNotes, type ReviewerChangeFact } from "./review-model";
/** One line of "What changed": a reviewer note, a CI finding, or the legacy summary. */
@@ -25,6 +25,19 @@ export function presentedChanges(diff: ScreenDiff | undefined): PresentedChange[
return legacy ? [{ id: "legacy-summary", copy: legacy }] : [];
}
/**
* What changed, split by who sees it. On a screen whose screenshots match, every finding is for assistive technology:
* nothing on it looks different. Elsewhere only the accessibility findings (labels, roles) are, since an added
* element or new text may well be visible.
*/
export function splitForAssistiveTechnology(changes: PresentedChange[], diff: Pick<ScreenDiff, "status" | "accessibilityOnly"> | undefined): {
visible: PresentedChange[];
assistive: PresentedChange[];
} {
const assistive = (change: PresentedChange) => Boolean(change.fact) && (isAccessibilityOnly(diff) || change.fact?.category === "accessibility");
return { visible: changes.filter((change) => !assistive(change)), assistive: changes.filter(assistive) };
}
/** What a missing side of a comparison shows instead of a screenshot. */
export function placeholderFor(side: "before" | "after", status: DiffStatus, notes?: CaptureNotes): string {
if (side === "before" && status === "added") return "Not in baseline";
+23 -2
View File
@@ -67,6 +67,12 @@ export type ReviewRuntimeEvidenceComparison = {
current?: ReviewRuntimeEvidence;
};
/**
* How far an area's content moved from Before to After when it is otherwise the same: in percent of the image
* (to place the Before outline) and in the screenshot's own units (to label it). Right and down are positive.
*/
export type RegionMove = { x: number; y: number; amount: { x: number; y: number }; unit: "pt" | "px" };
/** One area of the screenshot that differs, in percent of the image width and height (0–100). */
export type VisualDiffRegion = {
x: number;
@@ -75,12 +81,16 @@ export type VisualDiffRegion = {
height: number;
/** This region's share of all differing pixels, in percent. */
share: number;
/** Set when the area only moved; absent when its content changed. */
move?: RegionMove;
};
/** The CI pixel comparison of the before and after screenshots. */
export type ReviewVisualDiff = {
mismatchPercentage?: number;
regions: VisualDiffRegion[];
/** Every region CI found only moved, including ones the report leaves out: nothing on the screen changed content. */
allRegionsMoved?: true;
/** Diff regions inside the status-bar band that CI left out of the verdict. */
ignoredStatusBarRegions?: number;
/** Diff regions inside the home-indicator band (iOS, bottom) that CI left out of the verdict. */
@@ -98,7 +108,7 @@ export type ReviewSurface = {
reviewerChanges: ReviewerChangeFact[];
runtimeEvidenceRefs: string[];
noVisibleChange: boolean;
/** CI compared both verified screenshots and found no pixel difference: whatever changed is not visible. */
/** CI compared both verified screenshots and found no pixel difference: anything that changed is in the accessibility tree. */
pixelsUnchanged?: true;
/** Route this surface declares instead of rendering a screen of its own. */
redirectTo?: string;
@@ -260,7 +270,17 @@ function visualDiffRegion(value: unknown): VisualDiffRegion | undefined {
const [x, y, width, height, share] = ["x", "y", "width", "height", "share"].map((key) => percent(candidate?.[key]));
if (x === undefined || y === undefined || width === undefined || height === undefined || share === undefined) return undefined;
if (width <= 0 || height <= 0 || x + width > 100.01 || y + height > 100.01) return undefined;
return { x, y, width, height, share };
const move = regionMove(candidate?.move);
return { x, y, width, height, share, ...(move ? { move } : {}) };
}
function regionMove(value: unknown): RegionMove | undefined {
const candidate = record(value);
const amount = record(candidate?.amount);
const finite = (entry: unknown): entry is number => typeof entry === "number" && Number.isFinite(entry) && Math.abs(entry) <= 100;
if (!candidate || !amount || !finite(candidate.x) || !finite(candidate.y) || !finite(amount.x) || !finite(amount.y)
|| (candidate.unit !== "pt" && candidate.unit !== "px")) return undefined;
return { x: candidate.x, y: candidate.y, amount: { x: amount.x, y: amount.y }, unit: candidate.unit };
}
export function visualDiff(value: unknown): ReviewVisualDiff | undefined {
@@ -276,6 +296,7 @@ export function visualDiff(value: unknown): ReviewVisualDiff | undefined {
const ignoredHomeIndicatorRegions = count(candidate.ignoredHomeIndicatorRegions);
return {
regions,
...(candidate.allRegionsMoved === true && regions.length > 0 && regions.every((region) => region.move) ? { allRegionsMoved: true as const } : {}),
...(mismatchPercentage !== undefined ? { mismatchPercentage } : {}),
...(ignoredStatusBarRegions !== undefined ? { ignoredStatusBarRegions } : {}),
...(ignoredHomeIndicatorRegions !== undefined ? { ignoredHomeIndicatorRegions } : {}),
+8 -4
View File
@@ -218,6 +218,11 @@ function aggregateStatus(statuses: readonly DiffStatus[]): DiffStatus {
return "modified";
}
function accessibilityOnlyFamily(diffs: readonly ScreenDiff[]): boolean {
const changed = diffs.filter((diff) => diff.status === "added" || diff.status === "removed" || diff.status === "modified");
return changed.length > 0 && changed.every((diff) => diff.status === "modified" && diff.accessibilityOnly);
}
function firstDiffWithScreenshot(
diffs: readonly ScreenDiff[],
side: "beforeScreenshot" | "afterScreenshot",
@@ -241,7 +246,7 @@ function familyEvidence(diffs: readonly ScreenDiff[]): {
reviewerChanges: ScreenDiff["reviewerChanges"];
runtimeEvidenceRefs: string[];
noVisibleChange: boolean;
notVisible?: true;
accessibilityOnly?: true;
} {
const first = diffs[0];
if (!first) throw new Error("Cannot present an empty diff family");
@@ -251,7 +256,6 @@ function familyEvidence(diffs: readonly ScreenDiff[]): {
const beforeDiff = firstDiffWithScreenshot(diffs, "beforeScreenshot");
const afterDiff = firstDiffWithScreenshot(diffs, "afterScreenshot");
const primary = paired ?? afterDiff ?? beforeDiff ?? first;
const modified = diffs.filter((diff) => diff.status === "modified");
const reviewerChanges = [...new Map(diffs
.flatMap((diff) => diff.reviewerChanges ?? [])
.map((change) => [change.id, change])).values()];
@@ -263,8 +267,8 @@ function familyEvidence(diffs: readonly ScreenDiff[]): {
reviewerChanges,
runtimeEvidenceRefs,
noVisibleChange: diffs.some((diff) => diff.noVisibleChange),
// Not visible only when no modified member of the family shows a difference.
...(modified.length > 0 && modified.every((diff) => diff.notVisible) ? { notVisible: true as const } : {}),
// Accessibility only when every changed member is: an added, removed or visibly modified member is a visible change.
...(accessibilityOnlyFamily(diffs) ? { accessibilityOnly: true as const } : {}),
...(primary.captureNotes ? { captureNotes: primary.captureNotes } : {}),
// A redirect's screenshots belong to the route it declares; the panel must keep saying so.
...(primary.redirectTo ? { redirectTo: primary.redirectTo } : {}),
+109 -8
View File
@@ -1,4 +1,4 @@
import type { VisualDiffRegion } from "./review-model";
import type { RegionMove, VisualDiffRegion } from "./review-model";
/** A rectangle in percent of the image width and height (0–100). */
export type PercentRect = { x: number; y: number; width: number; height: number };
@@ -8,18 +8,69 @@ export type VisualChange = PercentRect & {
/** This change's share of all differing pixels, in percent. */
share: number;
regionCount: number;
/** Set when every region in it only moved, by the same amount: their average, which places and labels the outline. */
move?: RegionMove;
/** The least and most its regions moved, in the screenshot's units, which keeps a merged outline to one amount. */
moveRange?: { x: [number, number]; y: [number, number] };
};
/**
* Areas moved by the same amount when their moves are within this of each other, in the screenshot's units. Parts of
* one rigid sheet measure up to a third apart (re-rasterized text), so a third is the same move; rows that drifted by
* half a point or more (1, 1.5, 2pt down a list) keep their own outlines.
*/
const SAME_MOVE = 0.34;
/**
* The most the regions in one outline may differ, together. Measuring a move from re-rasterized text is good to
* about this: a sheet that moved 4.17pt as a whole measures 3.8–4.3pt across its parts (brentvatne/euxy#161).
*/
const MAX_MOVE_SPREAD = 0.5;
function sameMove(a: VisualChange, b: VisualChange): boolean {
if (!a.move || !b.move) return !a.move && !b.move;
const first = rangeOf(a), second = rangeOf(b);
const same = (axis: "x" | "y") => {
const low = Math.min(first[axis][0], second[axis][0]), high = Math.max(first[axis][1], second[axis][1]);
// One direction only: content that moved up and content that moved down did not move together.
return Math.abs(a.move!.amount[axis] - b.move!.amount[axis]) <= SAME_MOVE + 1e-6
&& high - low <= MAX_MOVE_SPREAD + 1e-6 && (low >= -0.25 || high <= 0.25);
};
return same("x") && same("y");
}
function overlaps(a: PercentRect, b: PercentRect): boolean {
return a.x < b.x + b.width && b.x < a.x + a.width && a.y < b.y + b.height && b.y < a.y + a.height;
}
/** Two moves as one, weighted by each change's share of the difference. */
function mergedMove(a: VisualChange, b: VisualChange): RegionMove | undefined {
if (!a.move || !b.move) return undefined;
const total = a.share + b.share || 1;
const mix = (first: number, second: number) => (first * a.share + second * b.share) / total;
return { x: mix(a.move.x, b.move.x), y: mix(a.move.y, b.move.y), unit: a.move.unit,
amount: { x: mix(a.move.amount.x, b.move.amount.x), y: mix(a.move.amount.y, b.move.amount.y) } };
}
/** Regions closer than this, in percent of the image height, read as one change. */
const VERTICAL_GAP = 1.5;
/** Regions closer than this, in percent of the image width, read as one change. */
const HORIZONTAL_GAP = 3;
function near(a: PercentRect, b: PercentRect): boolean {
return a.x <= b.x + b.width + HORIZONTAL_GAP
&& b.x <= a.x + a.width + HORIZONTAL_GAP
&& a.y <= b.y + b.height + VERTICAL_GAP
&& b.y <= a.y + a.height + VERTICAL_GAP;
/**
* Areas that moved by the same amount moved together (a sheet, a card and the rows under it), so they read as one
* across a wider gap: the content between them moved too, it just has no edges for CI to see.
*/
const MOVED_VERTICAL_GAP = 8;
const MOVED_HORIZONTAL_GAP = 10;
function near(a: VisualChange, b: VisualChange): boolean {
const moved = Boolean(a.move && b.move);
const horizontal = moved ? MOVED_HORIZONTAL_GAP : HORIZONTAL_GAP;
const vertical = moved ? MOVED_VERTICAL_GAP : VERTICAL_GAP;
return a.x <= b.x + b.width + horizontal
&& b.x <= a.x + a.width + horizontal
&& a.y <= b.y + b.height + vertical
&& b.y <= a.y + a.height + vertical;
}
function union(a: VisualChange, b: VisualChange): VisualChange {
@@ -32,9 +83,19 @@ function union(a: VisualChange, b: VisualChange): VisualChange {
height: Math.max(a.y + a.height, b.y + b.height) - y,
share: a.share + b.share,
regionCount: a.regionCount + b.regionCount,
...(mergedMove(a, b) ? { move: mergedMove(a, b)!, moveRange: {
x: [Math.min(rangeOf(a).x[0], rangeOf(b).x[0]), Math.max(rangeOf(a).x[1], rangeOf(b).x[1])],
y: [Math.min(rangeOf(a).y[0], rangeOf(b).y[0]), Math.max(rangeOf(a).y[1], rangeOf(b).y[1])],
} } : {}),
};
}
/** A change's move range: its own, or its single move's amount. */
function rangeOf(change: VisualChange): { x: [number, number]; y: [number, number] } {
const amount = change.move?.amount ?? { x: 0, y: 0 };
return change.moveRange ?? { x: [amount.x, amount.x], y: [amount.y, amount.y] };
}
/**
* CI reports many small regions for one visible change (a card that grew reports its text rows,
* its badge and its border). Merge regions that touch or nearly touch until none do, then order
@@ -50,9 +111,13 @@ export function groupVisualRegions(regions: readonly VisualDiffRegion[]): Visual
merged = false;
outer: for (let i = 0; i < changes.length; i += 1) {
for (let j = i + 1; j < changes.length; j += 1) {
if (!near(changes[i]!, changes[j]!)) continue;
// A moved area and a changed one stay apart, as do areas that moved by different amounts.
if (!near(changes[i]!, changes[j]!) || !sameMove(changes[i]!, changes[j]!)) continue;
const combined = union(changes[i]!, changes[j]!);
// Nor does one moved outline grow around a changed area: that content did not move, it changed.
if (combined.move && changes.some((change, index) => index !== i && index !== j && !change.move && overlaps(combined, change))) continue;
const next = changes.filter((_, index) => index !== i && index !== j);
next.push(union(changes[i]!, changes[j]!));
next.push(combined);
changes = next;
merged = true;
break outer;
@@ -64,6 +129,42 @@ export function groupVisualRegions(regions: readonly VisualDiffRegion[]): Visual
return changes.sort((a, b) => a.y - b.y || a.x - b.x);
}
/** "1.3" for 1.33, "4" for 4.04: a move to a tenth, about as fine as measuring it from pixels gets. */
function amount(value: number): string {
return (Math.round(Math.abs(value) * 10) / 10).toString();
}
/** A change's move as its outline labels it: "↑4.1pt", "↓1.3pt", "→2 ↓1pt". A part under a quarter is left out. */
export function formatMove(change: Pick<VisualChange, "move">): string {
const move = change.move;
if (!move) return "";
const { x, y } = move.amount;
const horizontal = `${x < 0 ? "←" : "→"}${amount(x)}`, vertical = `${y < 0 ? "↑" : "↓"}${amount(y)}`;
const parts = [...(Math.abs(x) >= 0.25 ? [horizontal] : []), ...(Math.abs(y) >= 0.25 ? [vertical] : [])];
// Merged diagonal nudges can average under a quarter on both axes; the larger still says which way.
return `${parts.length ? parts.join(" ") : Math.abs(y) >= Math.abs(x) ? vertical : horizontal}${move.unit}`;
}
/**
* How far the areas of a screen whose every changed area only moved went, a line per direction: "2 areas moved up
* 4pt", "3 areas moved down 1–2pt". Undefined when any area's content changed.
*/
export function layoutShiftSummary(changes: readonly VisualChange[]): string[] | undefined {
if (changes.length === 0 || changes.some((change) => !change.move)) return undefined;
const groups = new Map<string, number[]>();
for (const change of changes) {
const { x, y } = change.move!.amount;
const vertical = Math.abs(y) >= Math.abs(x);
const direction = vertical ? (y < 0 ? "up" : "down") : (x < 0 ? "left" : "right");
groups.set(direction, [...(groups.get(direction) ?? []), Math.abs(vertical ? y : x)]);
}
const unit = changes[0]!.move!.unit;
return [...groups].map(([direction, amounts]) => {
const low = amount(Math.min(...amounts)), high = amount(Math.max(...amounts));
return `${amounts.length === 1 ? "1 area" : `${amounts.length} areas`} moved ${direction} ${low === high ? low : `${low}–${high}`}${unit}.`;
});
}
/** Room around a change's outline, in percent of the image width and height, so it frames text. */
const OUTLINE_PAD_X = 1.5;
const OUTLINE_PAD_Y = 0.7;