mirror of
https://github.com/expo/explore.git
synced 2026-11-15 17:32:23 -10:00
Compare commits
24
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cfaae410a3 | ||
|
|
5321352264 | ||
|
|
9063de5c52 | ||
|
|
21ed8c06f6 | ||
|
|
6795f19d04 | ||
|
|
990e2ecc8d | ||
|
|
95be8b5248 | ||
|
|
6fa7cba087 | ||
|
|
f728eb187b | ||
|
|
d069a892dc | ||
|
|
4499a999d1 | ||
|
|
929ac82765 | ||
|
|
d5d6a5ff72 | ||
|
|
6a505a2d44 | ||
|
|
f30e9cc87b | ||
|
|
8cf8ec0f7f | ||
|
|
5c19061b0f | ||
|
|
53af3d4b8d | ||
|
|
6e134b8f05 | ||
|
|
ec75e37e45 | ||
|
|
1254a99841 | ||
|
|
c2bae00f31 | ||
|
|
65b79684f3 | ||
|
|
b8b43ee2c8 |
No files matched your search
@@ -76,9 +76,14 @@ jobs:
|
||||
| [$marker,
|
||||
"**Viewer preview** of \($sha)\(if $source != "" then " · reports from \($source)" else "" end)",
|
||||
"",
|
||||
"| Platform | Changes | Open |",
|
||||
"| Report | Changes | Open |",
|
||||
"| --- | --- | --- |",
|
||||
($reports[] | "| \(if .platform == "ios" then "iOS" else "Android" end)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?platform=\(.platform)) · [Screens](\($url)?platform=\(.platform)#/screens) · [Compare](\($url)?platform=\(.platform)&view=compare) |"),
|
||||
# One row per target, named by its label; a target named after its platform keeps ?platform= links.
|
||||
($reports[]
|
||||
| (.target // .platform) as $id
|
||||
| "\(if $id == "ios" or $id == "android" then "platform" else "target" end)=\($id)" as $query
|
||||
| ((.label // (if .platform == "ios" then "iOS" else "Android" end)) | gsub("\\|"; "\\\\|")) as $name
|
||||
| "| \($name)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?\($query)) · [Screens](\($url)?\($query)#/screens) · [Compare](\($url)?\($query)&view=compare) |"),
|
||||
"",
|
||||
"The link stays the same on every push. [Deploy run](\($run))"]
|
||||
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
|
||||
|
||||
+2
-2
@@ -57,7 +57,7 @@ Each workflow starts with a `targets` job: it installs the pinned CLI and runs `
|
||||
| | Package hosted review bundle | `ci:report` writes the report directory. |
|
||||
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
|
||||
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
|
||||
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, zips and encrypts each report, deploys it with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report** and the link's expiry. |
|
||||
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
|
||||
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
|
||||
|
||||
A reviewer downloads the report ZIP and drops it on the hosted Viewer; downloading needs read access to the repository.
|
||||
@@ -68,7 +68,7 @@ Validate baseline source → Install Explore → Verify deterministic source pla
|
||||
|
||||
### 2.4 `explore-compare.yml`
|
||||
|
||||
The same jobs as a PR review, for any `base` and `head` without a pull request. The `targets` job resolves both refs once with `ci:compare-refs` (a tag wins over a branch of the same name; the same commit twice fails with `COMPARE_SAME_COMMIT`) and passes the comparison to the capture jobs, which run `capture:review --compare` with no GitHub requests. The optional `scope` and `expires-in` inputs override `exploration.scope` and `report.preview.expiresAfter` for that run. The report job's `ci:publish` writes each target's **Open** and **zip** links to the run summary, and the deploy job adds the hosted link there; nothing comments on a pull request.
|
||||
The same jobs as a PR review, for any `base` and `head` without a pull request. The `targets` job resolves both refs once with `ci:compare-refs` (a tag wins over a branch of the same name; the same commit twice fails with `COMPARE_SAME_COMMIT`) and passes the comparison to the capture jobs, which run `capture:review --compare` with no GitHub requests. The optional `scope` input overrides `exploration.scope` for that run; `expires-in` is accepted and ignored. The report job's `ci:publish` writes each target's **Open** and **zip** links to the run summary, and the deploy job adds the hosted link there; nothing comments on a pull request.
|
||||
|
||||
## 3. Inside `capture:review` (`runCiReview`)
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ Explore maps your app: a screenshot of every screen, connected by the taps betwe
|
||||
<td width="50%" valign="top">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-pr-comment-dark.png">
|
||||
<img width="100%" alt="Explore's GitHub PR comment on a euxy PR: the heading links to the iOS and Android reports, a table with one row per platform giving device, result and an Open link, the Added, Removed, Modified, Needs review and Source-affected screens as collapsed lists, fading out below them" src="docs/screenshots/readme-pr-comment-light.png">
|
||||
<img width="100%" alt="Explore's GitHub PR comment on a euxy PR: a heading with how many screens changed and a Review in Explore link, a line naming each device with a link to its report, and the changed screens as a short list, fading out below them" src="docs/screenshots/readme-pr-comment-light.png">
|
||||
</picture>
|
||||
<strong>A comment on every PR</strong>: with <a href="#set-up-ci">CI</a>, the report links and the added, removed and modified screens.
|
||||
</td>
|
||||
@@ -145,7 +145,7 @@ npx @expo/explore capture --committed # HEAD alone
|
||||
npx @expo/explore capture --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 or [target](#targets) on EAS Simulator or a [local simulator](#simulator), and opens the report in a local Viewer. `--target` or `--platform` picks some; they run at once, at most `--parallel N` at a time. `--upload` hosts it for 30 days (`--expires-in` changes that) and prints the link; `report:upload <report.zip>` hosts one you already have.
|
||||
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform or [target](#targets) on EAS Simulator or a [local simulator](#simulator), and opens the report in a local Viewer. `--target` or `--platform` picks some; they run at once, at most `--parallel N` at a time. `--upload` hosts it and prints the link; `report:upload <report.zip>` hosts one you already have.
|
||||
- Your checkout, index and branches are never touched. Your uncommitted changes, untracked files included, are reviewed as `eas build` would upload them; `--committed`, or `cli.requireCommit: true` in `eas.json`, leaves them out.
|
||||
- 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 and local devices; when a run is stopped harder than that, the next local run stops what it left running.
|
||||
@@ -170,7 +170,7 @@ Pointed to a build, the [quick start](#quick-start) maps every screen of it, wit
|
||||
- A run stops after 15 minutes, 40 screens, or 150 actions (`--max-duration-minutes`, `--max-screens`, `--max-actions`).
|
||||
- Buttons that delete, pay, sign out, send, or leave the app are never tapped. `--allow-destructive "Reset filters"` allows one by its exact label.
|
||||
- `--hints "…"` tells the model what to focus on or how to sign in ([details](#sign-in-and-other-app-state)).
|
||||
- On EAS Simulator the report is hosted, and the link lasts 7 days (`--expires-in` takes 1d to 90d, or never); `--no-upload` keeps it local. On a local simulator it opens in the local Viewer (`--no-open` or `--json` skips that; `view --dir <folder>` opens it later), and `--upload` hosts it, which needs an EAS login. `--json` prints the result for scripts.
|
||||
- On EAS Simulator the report is hosted, and the link lasts as long as its EAS Hosting deployment (see [report access](docs/private-review.md#hosted-previews)); `--no-upload` keeps it local. On a local simulator it opens in the local Viewer (`--no-open` or `--json` skips that; `view --dir <folder>` opens it later), and `--upload` hosts it, which needs an EAS login. `--json` prints the result for scripts.
|
||||
- For a link that stays the same from run to run, pass `--alias NAME` and set `EXPLORE_PREVIEW_TOKEN` to a fixed token of 32 characters from a–z and 2–7 (`LC_ALL=C tr -dc a-z2-7 </dev/urandom | head -c 32`).
|
||||
- EAS Simulator sessions and hosted reports run under an EAS project named `expo-explore` in your account, created on first use (`--owner` and `--project` pick another).
|
||||
- Read a local result with `npx @expo/explore view --dir <folder>`, `screen:list`, or `gap:list`.
|
||||
@@ -227,7 +227,6 @@ By default reviewers download the report from GitHub. With hosted previews, the
|
||||
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
|
||||
```
|
||||
|
||||
@@ -235,7 +234,7 @@ report:
|
||||
- A [comparison of two commits](#compare-any-two-commits) links its hosted report from the run's summary instead of a PR comment. `capture --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 or target, from `capture --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).
|
||||
- Every file of the report sits under the link's 160-bit token, so only someone with the link can open it. Treat the link like a shared file link. It works as long as its EAS Hosting deployment does: EAS deletes one without an alias after 30 days on the Free plan and 90 on paid plans, and you can delete it sooner (`eas deploy:delete`) or on your own schedule. Explore sets no expiry of its own; see [report access](docs/private-review.md#hosted-previews).
|
||||
|
||||
</details>
|
||||
|
||||
@@ -406,11 +405,11 @@ 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.
|
||||
- **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`), and `scope` to `all`. 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 --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.
|
||||
`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.
|
||||
|
||||
<details>
|
||||
<summary id="compare"><strong>The comparison workflow</strong></summary>
|
||||
@@ -443,16 +442,15 @@ jobs:
|
||||
base: '${{ needs.previous.outputs.tag }}'
|
||||
head: '${{ github.ref_name }}'
|
||||
scope: all # every screen, not only those whose source changed
|
||||
expires-in: never # keep the hosted link (with report.preview.hosting: eas)
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
- 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.
|
||||
- `scope` is optional and overrides `exploration.scope` for that run. Without it a comparison captures what a PR review would (`scope: changes` captures only screens whose source changed). The hosted link lasts as long as its deployment, like a PR's; `expires-in` from earlier versions of this workflow is accepted and ignored.
|
||||
- The run summary links each target's report (**Open** and **zip**, like a PR comment) and, with hosting, the hosted report.
|
||||
- `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, with the same config and Explore version, 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.
|
||||
- When the baseline workflow captured `base` in the last 30 days, with the same config and Explore version, that capture is reused and only `head` is captured. The report artifact is kept 30 days; a hosted link lasts as long as its EAS Hosting deployment (an aliased one until the alias moves).
|
||||
|
||||
</details>
|
||||
|
||||
@@ -506,7 +504,7 @@ The same link answers differently depending on who asks. It already carries the
|
||||
- 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,accessibility-only,added,removed`, `/screens/<id>`, `/transitions`, and `/raw` for the report file.
|
||||
- Reports without source also expose `/journeys`, `/gaps`, and `/frontier`.
|
||||
- A link to several targets takes `?target=<id>` and serves the first without it; `/reports.json` lists them (`?platform=ios|android` from older links still works). Expired links' report and API routes answer `410`.
|
||||
- A link to several targets takes `?target=<id>` and serves the first without it; `/reports.json` lists them (`?platform=ios|android` from older links still works).
|
||||
|
||||
```sh
|
||||
curl -s "$LINK/api/v1/screens?status=modified" | jq '.items[] | {route, status, review}'
|
||||
|
||||
@@ -16,18 +16,18 @@ Hosted previews are off by default. When `report.preview.hosting: eas` is set, t
|
||||
|
||||
**What a reviewer needs.** Only the link. It looks like `https://acme-explore--k7f3z0d1q8.expo.app/p/f6r2…` and carries a 160-bit token generated for that run. It opens the Viewer and the report for one PR revision; it does not show the repository, other runs, or anything else in the Expo account.
|
||||
|
||||
**Several platforms or targets.** One deployment holds every target's report (a config without `targets` has one per platform). The link opens the first one (`?target=<id>` selects another, and `?platform=ios` or `?platform=android` from older links still works); the Viewer's menu lists the others from `/p/<token>/reports.json`, which names each target, its platform, label, device, and change count and nothing else. Every report and the listing sit behind the same token and expiry.
|
||||
**Several platforms or targets.** One deployment holds every target's report (a config without `targets` has one per platform). The link opens the first one (`?target=<id>` selects another, and `?platform=ios` or `?platform=android` from older links still works); the Viewer's menu lists the others from `/p/<token>/reports.json`, which names each target, its platform, label, device, and change count and nothing else. Every report and the listing sit behind the same token.
|
||||
|
||||
**What is protected, and how.**
|
||||
|
||||
- *The report bytes.* `ci:deploy` zips the report and encrypts it (AES-256-GCM) before upload. The key is stored only in that deployment's server environment; it never appears in a URL, a log line, or a comment. The files on the CDN are ciphertext.
|
||||
- *Access to the decrypted report.* A server route in the deployment checks the token and the expiry, fetches the ciphertext from its own deployment, decrypts it, and serves the browser the report's metadata first and each screenshot as it is shown (the browser may keep those screenshots in its own cache for up to a week, never past the link's expiry; shared caches never do). Without the exact token every path under the deployment answers `404`, including the Viewer itself; `ci:deploy` verifies this before it publishes the link.
|
||||
- *Expiry.* The expiry (`report.preview.expiresAfter`, 30 days by default, `never` to disable) is sealed into the deployment when it is created and enforced by the route, not by the browser. After it passes, the exact token still opens the Viewer for a browser, but the report routes, the Markdown index, and the agent API answer `410` and the Viewer says the link expired on that date; every other path still answers `404`. To revoke a link earlier, delete the deployment in the EAS Hosting dashboard; the CDN stops serving it within seconds and the route within a few minutes. Deleting it does not reach into a browser that already opened the link: the screenshots that browser fetched stay in its cache until they age out.
|
||||
- *Deletion.* Nothing is deleted automatically. Each review of a pull request deploys a new preview and the comment links the newest one (recorded in a hidden `<!-- expo-explore-deployments:… -->` line under the comment marker); earlier deployments and the deployments of closed pull requests stay until someone deletes them in the EAS Hosting dashboard or with `eas deploy:delete`, so a link keeps opening for as long as its expiry allows.
|
||||
- *The token.* Every path of a preview carries the link's 160-bit token: the page at `/p/<token>`, each target's manifest at `/p/<token>/targets/<target>.json`, and every screenshot at `/p/<token>/assets/<sha256>.<ext>`. Nobody can find a path without the token. With any other token, every path under the deployment answers `404`, including the Viewer itself; `ci:deploy` verifies this before it publishes the link.
|
||||
- *The report's files.* `ci:deploy` uploads the report as plain static files of the deployment, under the token. They are not encrypted: the token in their paths is what keeps them private, the same way it keeps the link private. EAS Hosting serves them directly, with its own default headers (the browser may cache a screenshot for an hour), and it cannot add `noindex` to them, so the deployment's `robots.txt` keeps crawlers away from them instead. The deployment's server route serves the page, the manifest the Viewer asks for, the target listing and the agent API, with `private, no-store` and `noindex`.
|
||||
- *How long a link works.* A link works as long as its EAS Hosting deployment exists. Explore sets no expiry of its own. EAS Hosting deletes a deployment after 30 days on the Free plan and 90 days on paid plans, **unless an alias points at it**: an aliased deployment (such as `--alias` uploads of `explore:binary`) is kept until the alias moves or is deleted. To end a link sooner, delete the deployment in the EAS Hosting dashboard or with `eas deploy:delete` (delete its alias first if it has one); the CDN stops serving its files within about five minutes. To expire links on your own schedule, delete deployments from a scheduled job. Deleting a deployment does not reach into a browser that already opened the link: what that browser cached stays until it ages out. `report.preview.expiresAfter` and `--expires-in` from earlier versions are accepted and ignored, with a warning.
|
||||
- *Deletion.* Explore deletes nothing. Each review of a pull request deploys a new preview and the comment links the newest one (recorded in a hidden `<!-- expo-explore-deployments:… -->` line under the comment marker); earlier deployments and the deployments of closed pull requests stay until EAS Hosting deletes them as above, or someone deletes them in the dashboard or with `eas deploy:delete`.
|
||||
- *The Viewer itself.* The Viewer's JavaScript is public and the same for every deployment; it holds no report data.
|
||||
- *Agent access.* The same link also answers as Markdown and as a JSON API (`/llms.txt`, `/api/v1/...`, see [the agent guide](../README.md#agents)) so a coding agent can read the report without a download. Those routes are served by the same server route from the same decrypted bytes, behind the same token, expiry, `private, no-store`, and `noindex`; they add no second credential and no new place where the report is stored.
|
||||
- *Agent access.* The same link also answers as Markdown and as a JSON API (`/llms.txt`, `/api/v1/...`, see [the agent guide](../README.md#agents)) so a coding agent can read the report without a download. Those routes read the same static files, behind the same token, with `private, no-store` and `noindex`; they add no second credential and no new place where the report is stored.
|
||||
|
||||
**What is not protected.** The link is a bearer credential. Anyone who receives it, by forwarding the comment, a notification email, or a chat message, can open the report until it expires. Members of the Expo account who can inspect the preview project's deployments can read the key. Expo's request logs record URL paths, so they record the token; they do not record the report. Keep the default drop flow when a leaked link would be a problem.
|
||||
**What is not protected.** The link is a bearer credential. Anyone who receives it, by forwarding the comment, a notification email, or a chat message, can open the report until the deployment is deleted. A screenshot's URL contains the token, so it is the link too: anyone who copies a screenshot's address can open the whole report. Members of the Expo account who can inspect the preview project's deployments can read its files. Expo's request logs record URL paths, so they record the token. Keep the default drop flow when a leaked link would be a problem.
|
||||
|
||||
**Comparison with the default.** The default flow uses GitHub's own permissions: a reviewer must be signed in to GitHub with read access to the repository to download the report. Hosted previews trade that check for one-click opening. Choose them when the review audience is the people who already see the PR.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ The same workflow supports Expo Router and React Navigation applications on iOS.
|
||||
|
||||
Expo Router inventory comes from route files and layouts. React Navigation inventory comes from statically readable JSX or object screen registrations and navigator hierarchies. Linking determines entry paths independently of route discovery. Unsupported computed declarations and unresolved paths remain diagnostics; analysis does not execute the app to guess their values.
|
||||
|
||||
`changes` starts with the exact two-dot Git diff and dependency impact, then adds, independently on each revision, the routes one navigation step before or after an affected route. Layout or screen guards do not count as steps. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. `all` selects the full inventory. Source context does not imply a visible modification.
|
||||
`changes` starts with the exact two-dot Git diff and dependency impact (a JavaScript or TypeScript file whose two revisions parse to the same syntax tree, differing only in comments or in whitespace the compiler and JSX transform drop, reaches no screen; a comment a compiler reads, such as `@jsx` or `#__PURE__`, still counts), then adds, independently on each revision, the routes one navigation step before or after an affected route. Layout or screen guards do not count as steps. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. `all` selects the full inventory. Source context does not imply a visible modification.
|
||||
|
||||
Before app build or simulator allocation, CI regenerates the canonical plan in fresh processes and compares bytes. A mismatch fails with diagnostic plans and their diff. Run identities, timestamps, absolute checkout paths, screenshots, and cache hits are excluded from planning data. Tests also vary enumeration order and checkout location.
|
||||
|
||||
|
||||
@@ -215,13 +215,13 @@ exploration:
|
||||
- /c/[channel]
|
||||
```
|
||||
|
||||
An excluded route stays in the map and in its neighbors' navigation context, but neither revision captures it, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
|
||||
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the map and the screen counts, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
|
||||
|
||||
Capture handles iOS's confirmation to open a link in the expected app. After a form submits a password, iOS may offer to save or update it depending on the simulator's AutoFill state; capture declines that prompt with Not Now in both modes, never stores the credential, and records each decision in `capture-diagnostics/system-prompts.jsonl`. Do not script that tap in setup. Include required system-alert handling in setup or app instructions; Explore does not automatically grant application permissions.
|
||||
|
||||
### Stable captures (optional)
|
||||
|
||||
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
|
||||
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. When both builds capture light and dark, text that differs between each build's own two captures (a clock, a relative date, a random name) is reported as runtime state, never as the change that makes a screen Modified; text that only follows the appearance, or a word beside it that changed, is still a change. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
|
||||
|
||||
### Agent usage and reuse
|
||||
|
||||
@@ -360,7 +360,7 @@ Create an Expo access token for an account with access to the app's EAS project.
|
||||
|
||||
Capture uses the automatic GitHub token with `pull-requests: write`, so it can keep the sticky comment current while the run works; publication rewrites that comment from a separate job. `GITHUB_TOKEN_MISSING` means the workflow environment is missing the automatic token mapping.
|
||||
|
||||
The sticky comment is one comment for the whole run: a header with the base and head commits, one row per captured platform (device, result, **Open** / **zip** / **run** links), every changed screen listed once with a link per platform, and a collapsed validation table with one column per platform. Each platform's job updates only its own hidden record in the comment, so iOS and Android jobs never overwrite each other. When a new run starts (a push, a rerun), the earlier run moves to a collapsed **Previous runs** list that keeps its head commit, result, report and run links; the last five runs are kept. A run that finishes after the PR moved on is still published, under previous runs, instead of failing. The failure job posts through the same renderer (`ci:failure`), so a crash before the pipeline's own comment still lands in that platform's row.
|
||||
The sticky comment is one comment for the whole run: a heading with what changed (**17 screens changed · Review in Explore**), a line naming every target with a link to its report plus the compared commits and when the comment was last updated, one line for any target that is still working, failed, or finished with captures missing, then the changed screens as a short list (the first ten, each linking its Before/After in the report, with a link to the rest). Capture problems, when there are any, sit in a collapsed **Capture issues** block; the footer links the workflow run and the config. Each target's job updates only its own hidden record in the comment, so iOS and Android jobs never overwrite each other. When a new run starts (a push, or a rerun's new attempt), the comment keeps the last review under a **New run in progress** line until the new run has a ready target of its own; a target of the new run that fails is named on that line, which reads **New run failed** once nothing is still working. A push also moves the earlier run to a collapsed **Previous runs** list that keeps its head commit, result, report and run links; the last five runs are kept. A run that finishes after the PR moved on is still published, under previous runs, instead of failing. The failure job posts through the same renderer (`ci:failure`), so a crash before the pipeline's own comment still lands in that target's line.
|
||||
|
||||
The comment can also draw a map of the change: the added, removed and visually changed screens, the screens one step before them, and the transitions among them, as a collapsed Mermaid flowchart that GitHub draws in place. It is off by default; turn it on with:
|
||||
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.19.7",
|
||||
"version": "0.19.8",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@expo/explore",
|
||||
"version": "0.19.7",
|
||||
"version": "0.19.8",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/repack-app": "0.10.1",
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.19.7",
|
||||
"version": "0.19.8",
|
||||
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
@@ -50,7 +50,7 @@
|
||||
"test:node": "node --test test/node/*.test.mjs",
|
||||
"test:hosting": "npm --prefix viewer-host run typecheck && npm --prefix viewer-host test",
|
||||
"test:viewer:artifacts": "node --test test/browser/artifact-report.browser.mjs test/browser/artifact-cache.browser.mjs",
|
||||
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
|
||||
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/swipe-outlines.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
|
||||
"test:viewer:e2e": "npm run test:viewer:browser && playwright test",
|
||||
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p viewer/tsconfig.json --noEmit",
|
||||
"lint": "eslint .",
|
||||
|
||||
@@ -3,13 +3,14 @@
|
||||
//
|
||||
// node scripts/deploy-viewer-preview.mjs --fixtures DIR --alias pr-123 --project explore-viewer-pr [--owner expo-public]
|
||||
//
|
||||
// DIR holds reports.json ([{ platform, changes?, device? }], as a hosted preview's /reports.json lists them) and one
|
||||
// <platform>.zip per entry (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an
|
||||
// earlier link's /p/<token>; without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
|
||||
// DIR holds reports.json ([{ target?, platform, label?, changes?, device? }], as a hosted preview's /reports.json lists
|
||||
// them) and one <target>.zip per entry, or <platform>.zip for an entry without a target
|
||||
// (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an earlier link's /p/<token>;
|
||||
// without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
|
||||
import { readFile } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import { parseArgs } from "node:util";
|
||||
import { deployFixturePreview } from "../dist/report/preview-deploy.js";
|
||||
import { deployFixturePreview, fixtureReports } from "../dist/report/preview-deploy.js";
|
||||
|
||||
const { values } = parseArgs({ options: { fixtures: { type: "string" }, alias: { type: "string" }, project: { type: "string" }, owner: { type: "string" } } });
|
||||
if (!values.fixtures || !values.alias || !values.project) {
|
||||
@@ -19,7 +20,7 @@ if (!values.fixtures || !values.alias || !values.project) {
|
||||
const listing = JSON.parse(await readFile(join(values.fixtures, "reports.json"), "utf8"));
|
||||
const token = process.env.EXPLORE_PREVIEW_TOKEN?.trim() || undefined;
|
||||
const result = await deployFixturePreview({
|
||||
reports: listing.map(({ platform, changes, device }) => ({ platform, zipPath: join(values.fixtures, `${platform}.zip`), changes, device })),
|
||||
reports: fixtureReports(listing, values.fixtures),
|
||||
project: values.project, alias: values.alias, ...(values.owner ? { owner: values.owner } : {}), ...(token ? { token } : {}),
|
||||
});
|
||||
console.log(JSON.stringify({ ...result, reports: listing }));
|
||||
@@ -100,17 +100,18 @@ try {
|
||||
const context = await browser.newContext({ viewport: { width: 1000, height: 1400 }, deviceScaleFactor: 2, colorScheme: theme });
|
||||
const page = await context.newPage();
|
||||
await page.goto(args.pr, { waitUntil: "domcontentloaded" });
|
||||
const comment = page.locator(".timeline-comment").filter({ has: page.locator("h3", { hasText: /Explore review/ }) }).first();
|
||||
const comment = page.locator(".timeline-comment").filter({ has: page.locator("h3", { hasText: /Review in Explore|Explore review/ }) }).first();
|
||||
await comment.waitFor({ timeout: 30_000 });
|
||||
await comment.scrollIntoViewIfNeeded();
|
||||
// The comment's pointer toward the avatar would show as a stray tick above the card.
|
||||
await page.addStyleTag({ content: ".timeline-comment::before, .timeline-comment::after { display: none !important; }" });
|
||||
await page.waitForTimeout(1000);
|
||||
// Cut after the list of changed screens: the launch timings, validation, and footer below it are detail.
|
||||
// Cut after the list of changed screens: the collapsed blocks and footer below it are detail.
|
||||
const clip = await comment.evaluate((card) => {
|
||||
const box = card.getBoundingClientRect();
|
||||
const after = [...card.querySelectorAll("p")].find(p => /Launch:/.test(p.textContent ?? ""));
|
||||
const bottom = after ? after.getBoundingClientRect().top : box.bottom;
|
||||
const list = [...card.querySelectorAll("ul")].find(ul => ul.querySelector(":scope > li code"));
|
||||
const after = list?.nextElementSibling;
|
||||
const bottom = after ? after.getBoundingClientRect().top : list ? list.getBoundingClientRect().bottom : box.bottom;
|
||||
return { x: box.left + window.scrollX, y: box.top + window.scrollY, width: box.width, height: Math.round(bottom - box.top) };
|
||||
});
|
||||
const shot = await page.screenshot({ clip, fullPage: true });
|
||||
|
||||
@@ -18,11 +18,35 @@ trap 'rm -rf "$work"' EXIT
|
||||
if ! curl -fsS "$base/reports.json" -o "$work/listing.json"; then
|
||||
echo '[{"platform":"ios"}]' > "$work/listing.json"
|
||||
fi
|
||||
for platform in $(jq -r '.[].platform' "$work/listing.json"); do
|
||||
curl -fsS "$base/report.zip?platform=$platform" -o "$work/$platform.zip"
|
||||
unzip -tq "$work/$platform.zip" > /dev/null
|
||||
# One ZIP per target, named for it: <target>.zip, or <platform>.zip for a report from before targets. A target named
|
||||
# after its platform is selected with ?platform=, any other with ?target= (as viewer-links.ts targetParameter does).
|
||||
# A preview deployed before Explore wrote static files serves each target's ZIP; a newer one serves its manifest and
|
||||
# screenshots, so the ZIP is put back together here. Screenshot requests keep the target's query, which deployments
|
||||
# that answered them from the ZIP need and static files ignore.
|
||||
for key in $(jq -r '.[] | .target // .platform' "$work/listing.json"); do
|
||||
# The listing comes from the hosted preview: a key names files here, so it must be a target id.
|
||||
[[ "$key" =~ ^[a-z][a-z0-9-]{0,31}$ ]] || { echo "Not a target id in reports.json: $key" >&2; exit 2; }
|
||||
case "$key" in ios|android) query="platform=$key" ;; *) query="target=$key" ;; esac
|
||||
if curl -fsS "$base/report.zip?$query" -o "$work/$key.zip" 2> /dev/null; then
|
||||
unzip -tq "$work/$key.zip" > /dev/null
|
||||
continue
|
||||
fi
|
||||
report="$work/$key"
|
||||
mkdir -p "$report/assets"
|
||||
curl -fsS "$base/manifest.json?$query" -o "$work/$key.manifest.json"
|
||||
file="$(jq -r .file "$work/$key.manifest.json")"
|
||||
[[ "$file" == review.json || "$file" == exploration.json ]] || { echo "Not a report manifest: $key" >&2; exit 1; }
|
||||
jq -c .report "$work/$key.manifest.json" > "$report/$file"
|
||||
for asset in $(jq -r '.entries | keys[]' "$work/$key.manifest.json"); do
|
||||
[[ "$asset" =~ ^assets/[a-f0-9]{64}\.(png|jpg|mp4)$ ]] || { echo "Unexpected asset name: $asset" >&2; exit 1; }
|
||||
curl -fsS "$base/$asset?$query" -o "$report/$asset"
|
||||
[[ "$(shasum -a 256 "$report/$asset" | cut -c1-64)" == "${asset:7:64}" ]] || { echo "Checksum mismatch: $asset" >&2; exit 1; }
|
||||
done
|
||||
rm -f "$work/$key.zip"
|
||||
(cd "$report" && zip -qrX "$work/$key.zip" "$file" assets)
|
||||
unzip -tq "$work/$key.zip" > /dev/null
|
||||
done
|
||||
jq --arg source "$source_name" '[.[] | {platform, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
|
||||
jq --arg source "$source_name" '[.[] | {target, platform, label, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
|
||||
|
||||
gh release view "$tag" > /dev/null 2>&1 || gh release create "$tag" --prerelease --latest=false --title "Viewer preview fixtures" \
|
||||
--notes "Reports the Viewer preview workflow serves on every pull request. Refresh with scripts/refresh-viewer-preview-fixtures.sh."
|
||||
|
||||
@@ -28,7 +28,7 @@ Platform, bundle id, app name and version are read from the archive; do not pass
|
||||
3. `agent-device install` of the archive straight into the session (Argent: `reinstall-app`; locally `simctl install` or `adb install`), then `open <bundle id>`.
|
||||
4. The model explores through a small tool set (observe, act, capture, finish); app text is treated as untrusted and destructive controls (delete, reset, sign out, purchase, send, share) are blocked outside the model.
|
||||
5. The map and screenshots are written under `--output` (default `./explore-<archive>-<timestamp>`), plus `report/` for the Viewer.
|
||||
6. The report is sealed and deployed to EAS Hosting (`--no-upload` skips this; `--expires-in 7d|30d|never`). With `--simulator local` it opens in the local Viewer instead, which keeps running until stopped; `--json` and `--no-open` skip it, so with `--json` open it afterwards with `view --dir <output>` (in the background, since it serves until stopped). `--upload` hosts it, and that needs an EAS login.
|
||||
6. The report is deployed to EAS Hosting as files under the link's token (`--no-upload` skips this); the link lasts as long as the deployment. With `--simulator local` it opens in the local Viewer instead, which keeps running until stopped; `--json` and `--no-open` skip it, so with `--json` open it afterwards with `view --dir <output>` (in the background, since it serves until stopped). `--upload` hosts it, and that needs an EAS login.
|
||||
7. The exact session is stopped, or the local device deleted; a failure to stop reports `SESSION_CLEANUP_FAILED` with the command to stop it by hand. A local device a hard-stopped run left behind is removed by the next local run.
|
||||
|
||||
Budgets default to 15 minutes, 40 screens, 150 actions (`--max-duration-minutes`, `--max-screens`, `--max-actions`). Steer the model with `--hints "focus on the onboarding and settings"`, skip onboarding with `--launch-url myapp://home`, and allow a specific risky control with `--allow-destructive "Clear cache"`.
|
||||
@@ -111,7 +111,7 @@ With `--json` the last stdout line is the result:
|
||||
```json
|
||||
{ "ok": true, "app": { "name": "euxy", "bundleId": "dev.brent.euxy", "platform": "ios", "version": "1.2.0" },
|
||||
"exploration": { "stopReason": "finished", "screens": 9, "observations": 11, "actions": 23, "summary": "..." },
|
||||
"map": ".../explore-euxy-.../map.json", "report": ".../explore-euxy-.../report", "url": "https://....expo.app/p/<token>", "expiresAt": "..." }
|
||||
"map": ".../explore-euxy-.../map.json", "report": ".../explore-euxy-.../report", "url": "https://....expo.app/p/<token>", "expiresAt": null }
|
||||
```
|
||||
|
||||
Share `url` (it is the only copy of the access token; it is not written to disk). Then query the map locally without a model or device:
|
||||
|
||||
@@ -173,10 +173,10 @@ npx @expo/explore capture --base v1.3.0 --head v1.4.0 --scope all
|
||||
|
||||
## 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`).
|
||||
`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`); `expires-in` from earlier versions is accepted and ignored, since a hosted link lasts as long as its EAS Hosting deployment.
|
||||
|
||||
- **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.
|
||||
- **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). A hosted link lasts as long as its EAS Hosting deployment (30 days on Free, 90 on paid plans, longer with an alias), which can outlive 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`, or **Run workflow** under Actions → Expo Explore compare.
|
||||
- **Without CI.** `npx @expo/explore capture --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.
|
||||
|
||||
@@ -294,8 +294,9 @@ export async function reservePort(port: number, environment: NodeJS.ProcessEnv):
|
||||
const abandoned = async (path: string) => {
|
||||
const info = await stat(path).catch(() => undefined);
|
||||
if (!info) return false;
|
||||
const owner = await readFile(join(path, "owner"), "utf8").catch(() => undefined);
|
||||
return owner === undefined ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
|
||||
// writeFile creates the owner file before it writes the pid, so an empty one is a holder mid-write too.
|
||||
const owner = await readFile(join(path, "owner"), "utf8").catch(() => "");
|
||||
return owner === "" ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
|
||||
};
|
||||
for (;;) {
|
||||
try { await mkdir(mutex); await writeFile(join(mutex, "owner"), String(process.pid)); break; }
|
||||
|
||||
+6
-3
@@ -1,3 +1,4 @@
|
||||
import { systemRegions } from "../contracts/capture.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { mkdir, open, readFile, realpath, writeFile } from "node:fs/promises";
|
||||
@@ -268,7 +269,8 @@ export async function runCiReview(options: {
|
||||
const { projects, output, config, environment, state, assertCurrentHead, postComment } = options;
|
||||
const progress = options.progress ?? silentProgress;
|
||||
// The controllers are fetched before any EAS work, so a blocked download fails before a session is paid for. agent-device
|
||||
// also compares the screenshots. An injected runner (tests) runs no real controller.
|
||||
// also compares the screenshots. An injected runner (tests) stands in for the controllers' calls, but not for that
|
||||
// comparison: it still runs the real agent-device, which fetches itself on first use.
|
||||
if (!options.runner) await prefetchControllers(config, environment, progress);
|
||||
const pr = options.presentation;
|
||||
const now = options.now ?? Date.now;
|
||||
@@ -368,8 +370,9 @@ export async function runCiReview(options: {
|
||||
stage = "compare";
|
||||
progress("comparing base and head captures");
|
||||
const sides = { base: await evidenceSide(join(output, "base-export")), head: await evidenceSide(join(output, "head-export")) };
|
||||
const evidence = await assessPublicEvidence({ platform: config.app.platform, plan, ...sides, ...(options.measure ? { measure: options.measure } : {}), profile: `${config.app.easProfile}:${config.app.bundleId}`, agentDeviceCommand: agentDeviceLauncher(options.environment) });
|
||||
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory,
|
||||
const system = systemRegions({ platform: config.app.platform, device: config.device.name, pose: config.device.pose });
|
||||
const evidence = await assessPublicEvidence({ platform: config.app.platform, systemRegions: system, plan, ...sides, ...(options.measure ? { measure: options.measure } : {}), profile: `${config.app.easProfile}:${config.app.bundleId}`, agentDeviceCommand: agentDeviceLauncher(options.environment) });
|
||||
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory, systemRegions: system,
|
||||
runId: options.runId, runAttempt: options.runAttempt, assertCurrentHead, assessments: evidence.surfaces,
|
||||
...(options.platforms ? { platforms: options.platforms } : {}),
|
||||
...(config.target ? { target: config.target } : {}), ...(options.targets ? { targets: options.targets } : {}),
|
||||
|
||||
@@ -5,18 +5,9 @@ import { openViewerInBrowser, startViewerServer, waitForViewerShutdown } from ".
|
||||
import { writeExplorationReport } from "../binary/report.js";
|
||||
import { assertHostingExport, deployExplorationReport, zipReportDirectory } from "../report/preview-deploy.js";
|
||||
import { keepReports } from "./report-commands.js";
|
||||
import { warnIgnoredExpiry } from "../config/explore-config.js";
|
||||
import { argumentError, flag, flags, has, nonNegativeInteger, oneOf, output, positional, positiveInteger } from "./args.js";
|
||||
|
||||
const MAX_EXPIRY_DAYS = 90;
|
||||
|
||||
/** `7d`, `30d`, `never`: how long the hosted link serves the report. */
|
||||
export function expiresInDays(value: string): number | null {
|
||||
if (value === "never") return null;
|
||||
const match = /^(\d{1,3})d$/.exec(value);
|
||||
const days = match ? Number(match[1]) : NaN;
|
||||
if (!Number.isSafeInteger(days) || days < 1 || days > MAX_EXPIRY_DAYS) argumentError(`--expires-in must be 1d to ${MAX_EXPIRY_DAYS}d, or never (got ${value})`, "expires-in");
|
||||
return days;
|
||||
}
|
||||
|
||||
/** `--alias NAME` plus a fixed token from EXPLORE_PREVIEW_TOKEN: the hosted link stays the same from one run to the next (validated by the deploy). */
|
||||
function stableLinkOptions(): { alias?: string; token?: string } {
|
||||
@@ -35,7 +26,7 @@ export async function exploreBinary(): Promise<void> {
|
||||
"Run expo-explore explore:binary <path to .apk, .app, .tar.gz, or simulator .ipa>.");
|
||||
if (has("upload") && has("no-upload")) argumentError("Pass either --upload or --no-upload", "no-upload");
|
||||
const outputDirectory = resolve(process.cwd(), flag("output") ?? defaultOutputDirectory(archive));
|
||||
const expiresAfterDays = expiresInDays(flag("expires-in") ?? "7d");
|
||||
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
|
||||
const platform = flag("platform") === undefined ? undefined : oneOf("platform", ["ios", "android"] as const);
|
||||
const provider = flag("provider") === undefined ? undefined : oneOf("provider", ["anthropic", "openai"] as const);
|
||||
const controller = flag("controller") === undefined ? undefined : oneOf("controller", ["agent-device", "argent"] as const);
|
||||
@@ -66,7 +57,7 @@ export async function exploreBinary(): Promise<void> {
|
||||
if (upload) {
|
||||
say("hosting the report on EAS Hosting");
|
||||
const owner = result.session.owner || flag("owner");
|
||||
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.archive.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(owner ? { owner } : {}), expiresAfterDays, ...stableLinkOptions() });
|
||||
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.archive.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(owner ? { owner } : {}), ...stableLinkOptions() });
|
||||
say(`report: ${hosted.previewUrl}${hosted.expiresAt ? ` (expires ${hosted.expiresAt})` : ""}`);
|
||||
}
|
||||
const summary = { ok: true,
|
||||
@@ -101,7 +92,7 @@ export async function exploreSession(): Promise<void> {
|
||||
const session = positional() ?? flag("session");
|
||||
const bundleId = flag("bundle-id");
|
||||
const outputDirectory = resolve(process.cwd(), flag("output") ?? defaultOutputDirectory(bundleId ?? "session"));
|
||||
const expiresAfterDays = expiresInDays(flag("expires-in") ?? "7d");
|
||||
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
|
||||
const platform = flag("platform") === undefined ? undefined : oneOf("platform", ["ios", "android"] as const);
|
||||
const provider = flag("provider") === undefined ? undefined : oneOf("provider", ["anthropic", "openai"] as const);
|
||||
const controller = flag("controller") === undefined ? undefined : oneOf("controller", ["agent-device", "argent"] as const);
|
||||
@@ -129,7 +120,7 @@ export async function exploreSession(): Promise<void> {
|
||||
let hosted: Awaited<ReturnType<typeof deployExplorationReport>> | undefined;
|
||||
if (has("upload")) {
|
||||
say("hosting the report on EAS Hosting");
|
||||
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.app.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(flag("owner") ? { owner: flag("owner")! } : {}), expiresAfterDays, ...stableLinkOptions() });
|
||||
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.app.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(flag("owner") ? { owner: flag("owner")! } : {}), ...stableLinkOptions() });
|
||||
say(`report: ${hosted.previewUrl}${hosted.expiresAt ? ` (expires ${hosted.expiresAt})` : ""}`);
|
||||
}
|
||||
const summary = { ok: true, app: result.app, device: { model: result.runtime.deviceModel, osVersion: result.runtime.osVersion },
|
||||
|
||||
@@ -15,7 +15,7 @@ import { installCiFiles } from "../ci/workflow-install.js";
|
||||
import { readRouteEntry } from "../ci/route-entry.js";
|
||||
import { buildVerifiedPlan } from "../ci/verified-plan.js";
|
||||
import { formatCaptureCheck, formatDoctorReport, referencedSecretNames, runCaptureCheck, runDoctor } from "../ci/doctor.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, previewDays, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf, positiveInteger } from "./args.js";
|
||||
import { help } from "./help.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
@@ -222,6 +222,8 @@ export async function captureReview(): Promise<void> {
|
||||
const configPath = flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH;
|
||||
const selection = targetSelection();
|
||||
const rawConfig = await readExploreConfig(headProject, configPath);
|
||||
// A release comparison's workflow may still pass --expires-in; ci:deploy says once that report.preview.expiresAfter is ignored.
|
||||
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, selection), { scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
|
||||
if (has("pull-request") === has("compare")) argumentError("Pass --pull-request FILE for a pull request, or --compare FILE for any two commits.", has("compare") ? "compare" : "pull-request");
|
||||
// A matrix job names its target; its artifacts, report and comment section carry the target's id.
|
||||
@@ -245,6 +247,7 @@ export async function captureBaseline(): Promise<void> {
|
||||
/** `capture` (or `capture:review`) `[--base REF] [--head REF | --committed]`: a local review, opened in the Viewer or hosted with --upload. */
|
||||
async function localReview(): Promise<void> {
|
||||
const platform = platformFlag(), target = targetFlag();
|
||||
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
|
||||
const parallel = has("parallel") ? positiveInteger("parallel") : undefined;
|
||||
const result = await runLocalReview({ project: flag("project") ?? process.cwd(), base: flag("base"), head: flag("head"), ...(target ? { target } : {}),
|
||||
...(parallel ? { parallel } : {}),
|
||||
@@ -276,9 +279,8 @@ async function localReview(): Promise<void> {
|
||||
...(result.head.uncommitted?.length ? { uncommittedFiles: result.head.uncommitted.length } : {}) });
|
||||
if (has("upload")) {
|
||||
const preview = result.config.report?.preview;
|
||||
const hosted = await deployLocalReports({ reports: zips, project: previewProjectSlug(result.repository, preview?.project), ...(preview?.owner ? { owner: preview.owner } : {}),
|
||||
// null is expiresAfter: never, which must not fall back to the default.
|
||||
expiresAfterDays: has("expires-in") ? previewDays(required("expires-in"), "--expires-in") : preview ? preview.expiresAfterDays : PREVIEW_DEFAULT_DAYS });
|
||||
if (preview?.expiresAfterIgnored) warnIgnoredExpiry("report.preview.expiresAfter");
|
||||
const hosted = await deployLocalReports({ reports: zips, project: previewProjectSlug(result.repository, preview?.project), ...(preview?.owner ? { owner: preview.owner } : {}) });
|
||||
// Hosted, the temporary copies are not needed (a failed upload keeps them for report:upload); --output keeps its own.
|
||||
const copied = has("output");
|
||||
if (!copied) await rm(result.work, { recursive: true, force: true });
|
||||
|
||||
+3
-3
@@ -18,7 +18,7 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
|
||||
doctor --capture [--project DIRECTORY] [--output DIRECTORY] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--yes]
|
||||
(captures the committed HEAD like the baseline workflow, with your eas login, and reports each route)
|
||||
capture [--base REF] [--head REF | --committed] [--target ID | --platform ios|android] [--parallel N] [--scope all|changes]
|
||||
[--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--upload [--expires-in 7d|30d|never]] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
|
||||
[--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--upload] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
|
||||
(on this machine: checks out both commits in temporary worktrees, captures them with your eas login (in agent
|
||||
mode, also your local claude or codex login), and opens the report; the head is HEAD with your uncommitted changes, as eas build
|
||||
uploads them (--committed, or cli.requireCommit in eas.json, leaves them out); the base defaults to where HEAD
|
||||
@@ -39,7 +39,7 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
|
||||
(the runs kept on this machine: local reviews, explorations and uploaded reports, for 30 days or up to 2 GB;
|
||||
in a terminal, an arrow-key picker: Enter opens a run in the local Viewer, u hosts it, d deletes it;
|
||||
ID is a run's id from reports list, or latest; EXPLORE_INTRO=off skips the title animation)
|
||||
report:upload <report.zip | report directory>... [--owner ACCOUNT] [--project SLUG] [--expires-in 7d|30d|never] [--config FILE] [--json]
|
||||
report:upload <report.zip | report directory>... [--owner ACCOUNT] [--project SLUG] [--config FILE] [--json]
|
||||
(hosts reports already on this machine on EAS Hosting behind one link, with your eas login: one per platform
|
||||
of the same review, from capture:review --output or a downloaded explore-review artifact, or one explore:binary report)`;
|
||||
|
||||
@@ -55,7 +55,7 @@ const BINARY = `Prebuilt apps (no source needed; runs with your local claude or
|
||||
(a sign-in in --hints is written as {{secret:NAME}}: Explore types the value of the environment variable NAME,
|
||||
and the model and the report only see the reference)
|
||||
--max-duration-minutes N --max-screens N --max-actions N --provider anthropic|openai --model ID
|
||||
--owner ACCOUNT --project SLUG --expires-in 7d|30d|never --allow-destructive "Label,Other label"
|
||||
--owner ACCOUNT --project SLUG --allow-destructive "Label,Other label"
|
||||
--alias NAME (one EAS Hosting host per app that always serves the newest run; with EXPLORE_PREVIEW_TOKEN
|
||||
set to a fixed 32-character token, the hosted link is the same every run)
|
||||
(iOS needs a simulator build; a device .ipa and Android .aab are rejected before any device starts)
|
||||
|
||||
@@ -3,7 +3,7 @@ import { readFile, stat } from "node:fs/promises";
|
||||
import { basename, dirname, join, relative, resolve, sep } from "node:path";
|
||||
import { DEFAULT_BINARY_PROJECT } from "../binary/run.js";
|
||||
import { pruneCaptureCache, repositoryName } from "../ci/local-review.js";
|
||||
import { readExploreConfig, previewDays, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExploreConfig } from "../config/explore-config.js";
|
||||
import { readExploreConfig, warnIgnoredExpiry, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig } from "../config/explore-config.js";
|
||||
import { assertHostingExport, deployLocalReports, previewProjectSlug, readReportZip, zipReportDirectory, MAX_REPORT_BYTES, type ReportZipSummary } from "../report/preview-deploy.js";
|
||||
import { startLocalReportServer } from "../report/local-report-server.js";
|
||||
import { findSavedRun, listSavedRuns, pruneSavedRuns, readSavedReports, removeSavedRun, reportTarget, saveRun, savedRunsDirectory, SAVED_RUN_LIMITS, type SavedReport, type SavedRun } from "../report/saved-runs.js";
|
||||
@@ -11,10 +11,9 @@ import { openViewerInBrowser } from "../map/viewer-server.js";
|
||||
import { formatBytes, friendlyTime, kindLabel, runPicker, runTitle } from "./reports-picker.js";
|
||||
import { pickIntro } from "./title-intros.js";
|
||||
import { CiError, toCiError } from "../shared/ci-errors.js";
|
||||
import { argumentError, flag, has, nonNegativeInteger, output, positionals, required } from "./args.js";
|
||||
import { argumentError, flag, has, nonNegativeInteger, output, positionals } from "./args.js";
|
||||
|
||||
/** explore:binary's default: an exploration link is for a quick look. */
|
||||
const EXPLORATION_DEFAULT_DAYS = 7;
|
||||
|
||||
/** A report directory (review.json or exploration.json and assets/), its parent holding report.zip, or a report ZIP. */
|
||||
async function readReport(path: string): Promise<{ path: string; zip: Uint8Array; summary: ReportZipSummary }> {
|
||||
@@ -94,12 +93,12 @@ async function hostReports(reports: ReadReport[]): Promise<void> {
|
||||
const found = review ? await repositoryPreview(review.repository) : undefined;
|
||||
const preview = found?.preview;
|
||||
if (review) process.stderr.write(found ? `report.preview from ${found.source}\n`
|
||||
: `no config of ${review.repository} here: hosting with the defaults (pass --config, or --owner, --project and --expires-in)\n`);
|
||||
: `no config of ${review.repository} here: hosting with the defaults (pass --config, or --owner and --project)\n`);
|
||||
const project = flag("project") ?? (review ? previewProjectSlug(review.repository, preview?.project) : DEFAULT_BINARY_PROJECT);
|
||||
const owner = flag("owner") ?? preview?.owner;
|
||||
const expiresAfterDays = has("expires-in") ? previewDays(required("expires-in"), "--expires-in")
|
||||
: preview ? preview.expiresAfterDays : review ? PREVIEW_DEFAULT_DAYS : EXPLORATION_DEFAULT_DAYS;
|
||||
const hosted = await deployLocalReports({ project, ...(owner ? { owner } : {}), expiresAfterDays,
|
||||
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
|
||||
else if (preview?.expiresAfterIgnored) warnIgnoredExpiry("report.preview.expiresAfter");
|
||||
const hosted = await deployLocalReports({ project, ...(owner ? { owner } : {}),
|
||||
reports: reports.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip,
|
||||
...(report.summary.changes === undefined ? {} : { changes: report.summary.changes }), ...(report.summary.device ? { device: report.summary.device } : {}) })),
|
||||
ownerHint: "Pass --owner with the Expo account that should host the report.",
|
||||
|
||||
@@ -104,7 +104,7 @@ export type ExploreConfig = {
|
||||
setup?: ExploreSetupAction[];
|
||||
agent?: { provider: "openai" | "anthropic"; model: string; instructions?: string };
|
||||
/** Hosted previews: one token-gated EAS Hosting deployment per review, see docs/private-review.md. */
|
||||
report?: { preview?: { hosting: "eas"; /** null: the link never expires; the deployment lives until someone deletes it. */ expiresAfterDays: number | null; owner?: string; project?: string };
|
||||
report?: { preview?: { hosting: "eas"; /** `expiresAfter` was set; it no longer applies (see IGNORED_EXPIRY). */ expiresAfterIgnored?: true; owner?: string; project?: string };
|
||||
/** `map`: the PR comment draws a Mermaid map of the changed screens and the screens that lead to them. Off by default. */
|
||||
comment?: { map: boolean } };
|
||||
/**
|
||||
@@ -115,8 +115,16 @@ export type ExploreConfig = {
|
||||
ci?: { trustedAuthors?: string[] };
|
||||
};
|
||||
|
||||
export const PREVIEW_MAX_DAYS = 365;
|
||||
export const PREVIEW_DEFAULT_DAYS = 30;
|
||||
/**
|
||||
* What `report.preview.expiresAfter` and `--expires-in` say now that Explore sets no expiry: a hosted preview lasts as long
|
||||
* as its EAS Hosting deployment. Both are still accepted, so configs and copied workflows keep working.
|
||||
*/
|
||||
export const IGNORED_EXPIRY = "no longer applies: a hosted preview lasts as long as its EAS Hosting deployment, which EAS deletes after 30 days on Free and 90 on paid plans unless an alias points at it. Delete the deployment (eas deploy:delete) to remove it sooner.";
|
||||
|
||||
/** Says once, on stderr (a warning annotation in GitHub Actions), that an expiry setting is ignored. */
|
||||
export function warnIgnoredExpiry(setting: string, environment: NodeJS.ProcessEnv = process.env): void {
|
||||
process.stderr.write(`${environment.GITHUB_ACTIONS === "true" ? "::warning::" : ""}${setting} ${IGNORED_EXPIRY}\n`);
|
||||
}
|
||||
|
||||
const MAX_CONFIG_BYTES = 64 * 1024;
|
||||
const UNSAFE_CHARACTERS = /[\u0000-\u001f\u007f]/;
|
||||
@@ -507,8 +515,8 @@ export function resolvePlatformConfig(config: ExploreConfig, platform: ExplorePl
|
||||
|
||||
/**
|
||||
* One run's choices over the reviewed config, from the workflow that started it: a release comparison can capture
|
||||
* every screen (`scope: all`) and keep its hosted link (`expiresIn: never`). `expiresIn` changes nothing when the
|
||||
* config hosts no report.
|
||||
* every screen (`scope: all`). `expiresIn` (`--expires-in`) is accepted from workflows written before Explore stopped
|
||||
* setting an expiry, and changes nothing.
|
||||
*/
|
||||
export function withRunOverrides(config: ExploreConfig, overrides: { scope?: string | undefined; expiresIn?: string | undefined; controller?: string | undefined; simulator?: string | undefined; repack?: string | undefined }): ExploreConfig {
|
||||
let result = config;
|
||||
@@ -530,11 +538,6 @@ export function withRunOverrides(config: ExploreConfig, overrides: { scope?: str
|
||||
if (overrides.scope !== "changes" && overrides.scope !== "all") fail("--scope must be changes or all", "--scope");
|
||||
result = { ...result, exploration: { ...result.exploration, scope: overrides.scope } };
|
||||
}
|
||||
if (overrides.expiresIn !== undefined) {
|
||||
// Validated even without hosting, so a typo in a release workflow surfaces before hosting is turned on.
|
||||
const expiresAfterDays = previewDays(overrides.expiresIn, "--expires-in");
|
||||
if (result.report?.preview) result = { ...result, report: { ...result.report, preview: { ...result.report.preview, expiresAfterDays } } };
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
@@ -546,18 +549,6 @@ export function captureRepack(config: ExploreConfig): "eas" | "local" {
|
||||
return config.capture.repack ?? (config.capture.simulator === "local" ? "local" : "eas");
|
||||
}
|
||||
|
||||
/** `expiresAfter` is a whole number of days (`30d`, `30 days`, or `30`), at most PREVIEW_MAX_DAYS, or `never` (null). */
|
||||
export function previewDays(value: unknown, field: string): number | null {
|
||||
if (value === undefined) return PREVIEW_DEFAULT_DAYS;
|
||||
if (typeof value === "string" && /^\s*never\s*$/i.test(value)) return null;
|
||||
const match = typeof value === "number" ? [null, String(value)] : typeof value === "string" ? /^\s*(\d{1,3})\s*(?:d|days?)?\s*$/i.exec(value) : null;
|
||||
const days = match ? Number(match[1]) : Number.NaN;
|
||||
if (!Number.isInteger(days) || days < 1 || days > PREVIEW_MAX_DAYS) {
|
||||
fail(`${field} must be between 1 and ${PREVIEW_MAX_DAYS} days, such as 30d, or never`, field);
|
||||
}
|
||||
return days;
|
||||
}
|
||||
|
||||
const GITHUB_LOGIN = /^[A-Za-z0-9](?:[A-Za-z0-9]|-(?=[A-Za-z0-9])){0,38}(?:\[bot\])?$/;
|
||||
export const TRUSTED_AUTHORS_MAX = 20;
|
||||
|
||||
@@ -618,7 +609,8 @@ function previewConfig(value: unknown): NonNullable<ExploreConfig["report"]>["pr
|
||||
}
|
||||
return {
|
||||
hosting: literal(preview.hosting, ["eas"] as const, "report.preview.hosting"),
|
||||
expiresAfterDays: previewDays(preview.expiresAfter, "report.preview.expiresAfter"),
|
||||
// Accepted from configs written before Explore stopped setting an expiry; the commands that host say it is ignored.
|
||||
...(preview.expiresAfter === undefined ? {} : { expiresAfterIgnored: true as const }),
|
||||
...(owner === undefined ? {} : { owner }),
|
||||
...(project === undefined ? {} : { project }),
|
||||
};
|
||||
|
||||
@@ -144,11 +144,13 @@ export function assertAgentAcceptance(bundle: CaptureBundle,
|
||||
* capture, and the Android emulator's clock and indicators sit inside the same fraction of a
|
||||
* Pixel frame. Its glyphs differ between sessions even after `--normalize-status-bar`, and within one
|
||||
* session whenever the clock or an indicator redraws, so evidence never treats a difference that
|
||||
* lies entirely inside this band as an app change. The Viewer marks the same band.
|
||||
* lies entirely inside this band as an app change; a difference that crosses its edge counts only for
|
||||
* its pixels below it. The Viewer marks the same band. Android: the glyphs of `sdk_gphone64` on Android 15
|
||||
* (720x1600) reach 6.4 % of the frame, measured on euxy #164, so its band is 7.
|
||||
*/
|
||||
export const STATUS_BAR_BAND_PERCENT = 6.5;
|
||||
/** The top band of a portrait screenshot that holds the system status bar, per platform. */
|
||||
export const STATUS_BAR_BAND_PERCENT_BY_PLATFORM: Record<"ios" | "android", number> = { ios: STATUS_BAR_BAND_PERCENT, android: 5 };
|
||||
export const STATUS_BAR_BAND_PERCENT_BY_PLATFORM: Record<"ios" | "android", number> = { ios: STATUS_BAR_BAND_PERCENT, android: 7 };
|
||||
export function statusBarBandPercent(platform: "ios" | "android" | undefined): number {
|
||||
return STATUS_BAR_BAND_PERCENT_BY_PLATFORM[platform ?? "ios"];
|
||||
}
|
||||
@@ -164,6 +166,47 @@ export function homeIndicatorBandPercent(platform: "ios" | "android" | undefined
|
||||
return HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM[platform ?? "ios"];
|
||||
}
|
||||
|
||||
/**
|
||||
* An area of a screenshot the system draws, in percent of the screenshot's width and height. A difference that
|
||||
* lies entirely inside one is never an app change; the verdict leaves it out and the Viewer blurs it.
|
||||
*/
|
||||
export type SystemRegion = { kind: "status-bar" | "home-indicator"; x: number; y: number; width: number; height: number };
|
||||
|
||||
/**
|
||||
* iPhone Duo (iOS 27) has no status bar across the top: its clock and Wi-Fi indicator stack in one pill in the
|
||||
* right-hand rail, 28 points from the edge, lower on the outer (closed) panel than on the inner one. Measured on
|
||||
* EAS Simulator captures of both panels; the pill is the same 40×64 points on each, only its top differs. The app's own
|
||||
* rail controls start about 3% of the height below it on the outer panel, so the padding stays small.
|
||||
*/
|
||||
const DUO_PANELS = {
|
||||
outer: { width: 466, height: 678, statusBar: { x: 398, y: 87, width: 40, height: 64 } },
|
||||
inner: { width: 951, height: 669, statusBar: { x: 883, y: 34, width: 40, height: 64 } },
|
||||
} as const;
|
||||
const DUO_STATUS_BAR_PADDING_POINTS = 4;
|
||||
const isFoldable = (platform: "ios" | "android" | undefined, device: string | undefined) => platform !== "android" && /\bduo\b/i.test(device ?? "");
|
||||
|
||||
/**
|
||||
* The areas the verdict leaves out for a capture: the platform's status-bar band and, on iOS, its home-indicator
|
||||
* band; on an iPhone foldable, the lit panel's status-bar pill instead of a top band. `pose` is the capture's device pose
|
||||
* (closed lights the outer panel; open and half-open the inner one); a foldable with none boots closed.
|
||||
*/
|
||||
export function systemRegions(options: { platform?: "ios" | "android" | undefined; device?: string | undefined; pose?: string | undefined }): SystemRegion[] {
|
||||
const regions: SystemRegion[] = [];
|
||||
if (isFoldable(options.platform, options.device)) {
|
||||
const panel = options.pose === "open" || options.pose === "half-open" ? DUO_PANELS.inner : DUO_PANELS.outer;
|
||||
const pad = DUO_STATUS_BAR_PADDING_POINTS;
|
||||
const percent = (value: number, of: number) => Math.round((value / of) * 10000) / 100;
|
||||
regions.push({ kind: "status-bar",
|
||||
x: percent(panel.statusBar.x - pad, panel.width), y: percent(panel.statusBar.y - pad, panel.height),
|
||||
width: percent(panel.statusBar.width + 2 * pad, panel.width), height: percent(panel.statusBar.height + 2 * pad, panel.height) });
|
||||
} else {
|
||||
regions.push({ kind: "status-bar", x: 0, y: 0, width: 100, height: statusBarBandPercent(options.platform) });
|
||||
}
|
||||
const home = homeIndicatorBandPercent(options.platform);
|
||||
if (home > 0) regions.push({ kind: "home-indicator", x: 0, y: 100 - home, width: 100, height: home });
|
||||
return regions;
|
||||
}
|
||||
|
||||
/** Deterministic pixel comparison of one surface's base and head screenshots. */
|
||||
export type PublicVisualVerdict = {
|
||||
verdict: "unchanged" | "modified" | "needs-review";
|
||||
@@ -187,10 +230,12 @@ export type PublicVisualVerdict = {
|
||||
* content. Absent when any region changed, or moves were not measured.
|
||||
*/
|
||||
allRegionsMoved?: true;
|
||||
/** Diff regions inside the iOS status-bar band that were excluded from the verdict. */
|
||||
/** Diff regions inside the status-bar band that were excluded from the verdict, or clipped to their part below it. */
|
||||
ignoredStatusBarRegions?: number;
|
||||
/** Diff regions that lay entirely inside the home-indicator band and were left out of the verdict. */
|
||||
/** Diff regions that lay inside the home-indicator band and were left out of the verdict, or clipped to their part above it. */
|
||||
ignoredHomeIndicatorRegions?: number;
|
||||
/** The system-drawn areas the verdict left out, present when a difference inside one was ignored. */
|
||||
systemRegions?: SystemRegion[];
|
||||
};
|
||||
/**
|
||||
* Evidence-based reviewer status. `status` on the surface stays source-derived because capture
|
||||
@@ -248,6 +293,8 @@ export type PublicReview = {
|
||||
statusBarBandPercent?: number;
|
||||
/** The share of each screenshot's height, from the bottom, the verdict ignored as the home indicator. */
|
||||
homeIndicatorBandPercent?: number;
|
||||
/** Every system-drawn area the verdict leaves out of each screenshot; the bands above, or a foldable's rail pill. */
|
||||
systemRegions?: SystemRegion[];
|
||||
/** Every platform the config captures, so the Viewer can offer the sibling platform's report of the same run. */
|
||||
platforms?: Array<"ios" | "android">;
|
||||
/** The target this report captured; absent in reports from before targets, whose target is their platform. */
|
||||
@@ -277,6 +324,8 @@ export type PublicReview = {
|
||||
note?: PublicChangeNote;
|
||||
/** The appearance this surface rendered in; a secondary appearance is its own surface, `<id>@<scheme>`. */
|
||||
colorScheme?: "light" | "dark";
|
||||
/** Named in `exploration.exclude`: kept for its neighbors' navigation context, never captured on either side. */
|
||||
excluded?: true;
|
||||
}>;
|
||||
};
|
||||
export function validateCapturePlan(value: unknown): SourceCapturePlan {
|
||||
|
||||
@@ -75,11 +75,17 @@ function assertReviewFields(surface: Surface, enforceComparisonEvidence: boolean
|
||||
}
|
||||
}
|
||||
|
||||
/** A region's move between the screenshots: finite, and small enough to be layout drift rather than another screen. */
|
||||
/**
|
||||
* The farthest a region may move between the screenshots, in screenshot pixels: within the largest screenshot a
|
||||
* device takes (an element recentred on a wide display moves hundreds of pixels), not an unbounded number.
|
||||
*/
|
||||
const MAX_SHIFT = 8192;
|
||||
|
||||
/** A region's move between the screenshots: finite, and within a screenshot. */
|
||||
function validShift(shift: unknown): boolean {
|
||||
if (!shift || typeof shift !== "object") return false;
|
||||
const { x, y } = shift as { x?: unknown; y?: unknown };
|
||||
return typeof x === "number" && typeof y === "number" && Number.isFinite(x) && Number.isFinite(y) && Math.abs(x) <= 64 && Math.abs(y) <= 64;
|
||||
return typeof x === "number" && typeof y === "number" && Number.isFinite(x) && Number.isFinite(y) && Math.abs(x) <= MAX_SHIFT && Math.abs(y) <= MAX_SHIFT;
|
||||
}
|
||||
|
||||
function assertVisualVerdict(visual: PublicVisualVerdict, enforceComparisonEvidence: boolean, paired: boolean): void {
|
||||
@@ -345,6 +351,10 @@ function validatePublicReview(review: PublicReview, enforceComparisonEvidence: b
|
||||
throw new Error("Public review source presence or status is inconsistent");
|
||||
}
|
||||
ids.add(surface.id);
|
||||
if (surface.excluded !== undefined && (surface.excluded !== true
|
||||
|| surface.baseImage || surface.headImage || surface.baseOutcome || surface.headOutcome || surface.visual)) {
|
||||
throw new Error("Public review excluded surface carries capture evidence");
|
||||
}
|
||||
assertReviewFields(surface, enforceComparisonEvidence);
|
||||
assertChangeNote(surface, review);
|
||||
if (surface.sourceChange) {
|
||||
|
||||
+39
-18
@@ -1,10 +1,10 @@
|
||||
/**
|
||||
* The agent-facing view of one hosted report: `/p/<token>/api/v1/...` JSON resources, the Markdown
|
||||
* index agents get when they fetch the token page without asking for HTML, and the block the Viewer
|
||||
* shell carries for fetchers that convert HTML to text. It reads the decrypted archive directly, so
|
||||
* it only picks the fields it publishes from the report JSON and treats everything else as untrusted.
|
||||
* shell carries for fetchers that convert HTML to text. It reads the report's own JSON (from a ZIP, or from the static
|
||||
* manifest a hosted preview serves), so it only picks the fields it publishes and treats everything else as untrusted.
|
||||
*/
|
||||
import { readZipDirectory, readZipEntry, type ZipEntry } from "./zip-reader.js";
|
||||
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
|
||||
|
||||
export const AGENT_API_VERSION = "v1";
|
||||
/** The largest review.json or exploration.json a hosted report reads. */
|
||||
@@ -22,8 +22,10 @@ export type LoadedReport = {
|
||||
file: "review.json" | "exploration.json";
|
||||
raw: Uint8Array;
|
||||
json: Json;
|
||||
zip: Uint8Array;
|
||||
entries: Map<string, ZipEntry>;
|
||||
/** Every file of the report by name (`assets/<sha256>.png`), with its size. */
|
||||
entries: Map<string, { size: number }>;
|
||||
/** One file's bytes, at most `limit` of them; undefined when there is no such file or it is larger. Rejects when it cannot be read now. */
|
||||
read: (name: string, limit: number) => Promise<Uint8Array | undefined>;
|
||||
};
|
||||
|
||||
const rec = (value: unknown): Json => (typeof value === "object" && value !== null && !Array.isArray(value) ? value as Json : {});
|
||||
@@ -34,25 +36,40 @@ const bool = (value: unknown): boolean | undefined => (typeof value === "boolean
|
||||
const strings = (value: unknown): string[] => arr(value).filter((item): item is string => typeof item === "string");
|
||||
const defined = <T extends Json>(object: T): T => Object.fromEntries(Object.entries(object).filter(([, value]) => value !== undefined)) as T;
|
||||
|
||||
/** Parses the decrypted archive; undefined when it is not a report this API knows how to read. */
|
||||
/** Parses a report ZIP; undefined when it is not a report this API knows how to read. */
|
||||
export async function loadReport(zip: Uint8Array): Promise<LoadedReport | undefined> {
|
||||
const entries = readZipDirectory(zip);
|
||||
if (!entries) return undefined;
|
||||
const file = entries.has("review.json") ? "review.json" : entries.has("exploration.json") ? "exploration.json" : undefined;
|
||||
const directory = readZipDirectory(zip);
|
||||
if (!directory) return undefined;
|
||||
const file = directory.has("review.json") ? "review.json" : directory.has("exploration.json") ? "exploration.json" : undefined;
|
||||
if (!file) return undefined;
|
||||
const raw = await readZipEntry(zip, entries.get(file)!, MAX_METADATA_BYTES);
|
||||
const raw = await readZipEntry(zip, directory.get(file)!, MAX_METADATA_BYTES);
|
||||
if (!raw) return undefined;
|
||||
const read = async (name: string, limit: number) => {
|
||||
const entry = directory.get(name);
|
||||
return entry ? await readZipEntry(zip, entry, limit) : undefined;
|
||||
};
|
||||
return reportFrom(file, raw, directory, read);
|
||||
}
|
||||
|
||||
/** The report a metadata file describes, with its files and a way to read them; undefined when it is not a report this API reads. */
|
||||
export function reportFrom(file: string, raw: Uint8Array, entries: Map<string, { size: number }>, read: LoadedReport["read"]): LoadedReport | undefined {
|
||||
let parsed: unknown;
|
||||
try { parsed = JSON.parse(new TextDecoder().decode(raw)); } catch { return undefined; }
|
||||
return reportFromJson(file, raw, parsed, entries, read);
|
||||
}
|
||||
|
||||
/** `reportFrom` for a metadata file already parsed: `parsed` is `raw` as JSON. */
|
||||
export function reportFromJson(file: string, raw: Uint8Array, parsed: unknown, entries: Map<string, { size: number }>, read: LoadedReport["read"]): LoadedReport | undefined {
|
||||
if (file !== "review.json" && file !== "exploration.json") return undefined;
|
||||
const root = rec(parsed);
|
||||
if (file === "review.json") {
|
||||
const review = rec(root.review);
|
||||
if (review.contract !== "explore.review" || !Array.isArray(review.surfaces)) return undefined;
|
||||
return { kind: "pr-review", file, raw, json: review, zip, entries };
|
||||
return { kind: "pr-review", file, raw, json: review, entries, read };
|
||||
}
|
||||
const report = root.kind === "explore.exploration-report" ? root : rec(root.report);
|
||||
if (report.kind !== "explore.exploration-report" || typeof report.map !== "object") return undefined;
|
||||
return { kind: "exploration", file, raw, json: report, zip, entries };
|
||||
return { kind: "exploration", file, raw, json: report, entries, read };
|
||||
}
|
||||
|
||||
export type AgentContext = {
|
||||
@@ -159,7 +176,8 @@ const edgeItem = (edge: Json): Json => defined({ from: str(edge.from), to: str(e
|
||||
* means a visible change. A screen whose source changed but whose captures match is unchanged, including in reports
|
||||
* from before 0.19.1, which called it "needs review". A modified screen whose screenshots match changed only in what
|
||||
* assistive technology reads: `accessibility-only`. A screen whose capture failed is `unavailable`, and one whose
|
||||
* source changed but that has no verdict was not compared: `not-compared`.
|
||||
* source changed but that has no verdict was not compared: `not-compared`. A route named in `exploration.exclude` is
|
||||
* `excluded`: never captured on either side.
|
||||
*/
|
||||
/** Both sides captured at their verified destination route, as a verdict requires (isAccessibilityOnlyChange in the contract). */
|
||||
function verifiedPair(surface: Json): boolean {
|
||||
@@ -177,6 +195,8 @@ function captureUnavailable(surface: Json, side: "base" | "head"): boolean {
|
||||
}
|
||||
|
||||
function verdictOf(surface: Json): string | undefined {
|
||||
// Named in exploration.exclude: never captured, so there is nothing to compare or to miss.
|
||||
if (surface.excluded === true) return "excluded";
|
||||
// A capture that failed is unavailable, as the Viewer says, whatever the source or an older verdict claims.
|
||||
if (str(surface.status) !== "removed" && captureUnavailable(surface, "head")) return "unavailable";
|
||||
if (["modified", "unchanged"].includes(str(surface.status) ?? "") && captureUnavailable(surface, "base")) return "unavailable";
|
||||
@@ -189,9 +209,9 @@ function verdictOf(surface: Json): string | undefined {
|
||||
return status ?? str(surface.status);
|
||||
}
|
||||
|
||||
const STATUS_ORDER = ["modified", "accessibility-only", "added", "removed", "needs-review", "unavailable", "not-compared", "unchanged", "variant"];
|
||||
const STATUS_ORDER = ["modified", "accessibility-only", "added", "removed", "needs-review", "unavailable", "not-compared", "excluded", "unchanged", "variant"];
|
||||
const STATUS_WORDS: Record<string, string> = { "accessibility-only": "accessibility only (screenshots match, the accessibility tree does not)",
|
||||
"needs-review": "need review", "not-compared": "not compared", variant: "screen variants" };
|
||||
"needs-review": "need review", "not-compared": "not compared", excluded: "excluded by config (exploration.exclude), never captured", variant: "screen variants" };
|
||||
|
||||
/** "3 modified, 1 added, 1 removed, 30 unchanged": every status counted, so the parts add up to the total. */
|
||||
function screenCounts(screens: Json): string {
|
||||
@@ -465,9 +485,10 @@ export async function agentApiReply(context: AgentContext, loaded: LoadedReport,
|
||||
}
|
||||
case "assets": {
|
||||
if (id === undefined) return notFound();
|
||||
const entry = loaded.entries.get(`assets/${id}.png`);
|
||||
if (!entry) return notFound();
|
||||
const bytes = await readZipEntry(loaded.zip, entry, MAX_ASSET_BYTES);
|
||||
if (!loaded.entries.has(`assets/${id}.png`)) return notFound();
|
||||
let bytes: Uint8Array | undefined;
|
||||
try { bytes = await loaded.read(`assets/${id}.png`, MAX_ASSET_BYTES); }
|
||||
catch { return json({ error: "unavailable", message: "The screenshot could not be read; retry shortly" }, 503); }
|
||||
if (!bytes) return notFound();
|
||||
return { status: 200, contentType: "image/png", body: bytes as BodyInit, headers: { ETag: `"${id}"`, "Content-Length": String(bytes.byteLength) } };
|
||||
}
|
||||
|
||||
@@ -14,7 +14,8 @@ import { CiError, toCiError } from "../shared/ci-errors.js";
|
||||
|
||||
const CONTRACT = "explore.report-input";
|
||||
/** The reviewed config's hosted-preview request, carried to the credentialed deploy job. */
|
||||
export type CiPreviewRequest = { hosting: "eas"; expiresAfterDays: number | null; owner?: string; project?: string };
|
||||
/** The config's report.preview, handed from the capture job to the deploy job. */
|
||||
export type CiPreviewRequest = { hosting: "eas"; expiresAfterIgnored?: true; owner?: string; project?: string };
|
||||
export type CiReportInput = {
|
||||
contract: typeof CONTRACT;
|
||||
publicReview: PublicReview;
|
||||
@@ -64,7 +65,8 @@ async function readInputUnchecked(inputPath: string): Promise<CiReportInput> {
|
||||
}
|
||||
if (input.preview !== undefined) {
|
||||
const preview = input.preview;
|
||||
if (preview.hosting !== "eas" || (preview.expiresAfterDays !== null && (!Number.isInteger(preview.expiresAfterDays) || preview.expiresAfterDays < 1 || preview.expiresAfterDays > 365))
|
||||
// An `expiresAfterDays` from before Explore stopped setting an expiry is ignored.
|
||||
if (preview.hosting !== "eas"
|
||||
|| (preview.project !== undefined && !/^[a-z0-9][a-z0-9-]{0,62}[a-z0-9]$/.test(preview.project))
|
||||
|| (preview.owner !== undefined && !/^[a-z0-9][a-z0-9_-]{0,63}$/.test(preview.owner))) {
|
||||
throw new Error("Invalid hosted preview request");
|
||||
|
||||
@@ -69,15 +69,24 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
|
||||
return send(reply.status, body, reply.contentType, { vary: "Accept", ...reply.headers });
|
||||
}
|
||||
if (isPage) return send(200, await readFile(resolve(viewerRoot, "index.html")), TYPES[".html"]);
|
||||
// What the Viewer opens (preview-manifest.ts, shared with the hosted Worker): the manifest, then each asset as it is shown.
|
||||
if (url.pathname === `${page}/manifest.json` || url.pathname.startsWith(`${page}/assets/`)) {
|
||||
if (!report) return send(404, "Not found");
|
||||
if (!loaded.has(report)) loaded.set(report, loadReport(report.zip));
|
||||
const content = await loaded.get(report);
|
||||
if (!content) return send(404, "Not found");
|
||||
if (url.pathname === `${page}/manifest.json`) return send(200, manifestBody(content), TYPES[".json"]);
|
||||
const asset = await previewAsset(content, url.pathname.slice(page.length + 1));
|
||||
return asset ? send(200, asset.bytes, asset.type) : send(404, "Not found");
|
||||
// What the Viewer opens (preview-manifest.ts, as a hosted preview serves it): the manifest, then each asset as it is
|
||||
// shown. An asset is named by its SHA-256 and carries no target, so it comes from whichever report holds it.
|
||||
const read = (entry: LocalReport) => {
|
||||
if (!loaded.has(entry)) loaded.set(entry, loadReport(entry.zip));
|
||||
return loaded.get(entry)!;
|
||||
};
|
||||
if (url.pathname === `${page}/manifest.json`) {
|
||||
const content = report ? await read(report) : undefined;
|
||||
return content ? send(200, manifestBody(content), TYPES[".json"]) : send(404, "Not found");
|
||||
}
|
||||
if (url.pathname.startsWith(`${page}/assets/`)) {
|
||||
const path = url.pathname.slice(page.length + 1);
|
||||
for (const entry of options.reports) {
|
||||
const content = await read(entry);
|
||||
const asset = content ? await previewAsset(content, path) : undefined;
|
||||
if (asset) return send(200, asset.bytes, asset.type);
|
||||
}
|
||||
return send(404, "Not found");
|
||||
}
|
||||
if (url.pathname === `${page}/report.zip`) return report ? send(200, report.zip, "application/zip") : send(404, "Not found");
|
||||
if (url.pathname === `${page}/reports.json` && options.reports.length > 1) return send(200, listing, TYPES[".json"]);
|
||||
|
||||
+189
-230
@@ -2,7 +2,7 @@ import type { PublicReview } from "../contracts/capture.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import type { SimulatorRuntimeMetadata } from "../capture/run.js";
|
||||
import { CI_COMMENT_MARKER } from "./pr-comment.js";
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, changeCountText, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedRecords, readCommentRecords, recordLabel, recordLine, recordSummary, recordTarget,
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedPrevious, orderedRecords, previousLine, readCommentRecords, recordLabel, recordLine, recordSummary,
|
||||
type ChangeGroup, type CommentNavigation, type CommentTarget, type CommentRecords, type HistoryEntry, type NavigationGroup, type NavigationKind, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
|
||||
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
|
||||
@@ -64,13 +64,6 @@ export type PublicCommentState = {
|
||||
type ReviewGroup = ChangeGroup;
|
||||
|
||||
const GROUP_ORDER: ReviewGroup[] = CHANGE_GROUPS;
|
||||
const GROUP_LABEL: Record<ReviewGroup, string> = {
|
||||
added: "🟩 Added",
|
||||
modified: "🟧 Modified",
|
||||
removed: "🟥 Removed",
|
||||
"accessibility-only": "🟦 Accessibility only",
|
||||
"needs-review": "🟨 Needs review",
|
||||
};
|
||||
|
||||
/** The body is HTML, so no blank lines are needed and the block keeps its natural spacing. */
|
||||
function details(summary: string, content: string[]): string[] {
|
||||
@@ -115,14 +108,6 @@ function link(label: string, destination: string): string {
|
||||
|
||||
const SUPERSEDED_NOTE = "The pull request moved while this run worked; its report is kept here until the current run replaces it.";
|
||||
|
||||
function duration(startedAt: number, updatedAt: number): string {
|
||||
const total = Math.max(0, Math.round((updatedAt - startedAt) / 1000));
|
||||
if (startedAt <= 0 || total > 24 * 3600) return "";
|
||||
const minutes = Math.floor(total / 60);
|
||||
const seconds = total % 60;
|
||||
return minutes > 0 ? `${minutes}m ${String(seconds).padStart(2, "0")}s` : `${seconds}s`;
|
||||
}
|
||||
|
||||
function plural(count: number, noun: string): string {
|
||||
return `${count} ${noun}${count === 1 ? "" : "s"}`;
|
||||
}
|
||||
@@ -191,12 +176,7 @@ function previewExpiry(expiresAt: number): string {
|
||||
return new Date(expiresAt).toLocaleDateString("en-US", { month: "short", day: "numeric", year: "numeric", timeZone: "UTC" }) + " (UTC)";
|
||||
}
|
||||
|
||||
/**
|
||||
* Differences that are not review targets, stated once instead of per screen: screen variants
|
||||
* (source-unchanged screens captured in another runtime state) and app-wide source changes that
|
||||
* left some screens without a visible difference.
|
||||
*/
|
||||
/** "Launch: splash unchanged for 3.1 s" — the app launch per appearance, kept apart from the screen rows. */
|
||||
/** "Launch: splash unchanged for 3.1 s" — the app launch per appearance, for the local text summary. */
|
||||
function launchLine(review: PublicReview): string | undefined {
|
||||
const launch = review.launch ?? [];
|
||||
if (!launch.length) return undefined;
|
||||
@@ -220,9 +200,19 @@ function launchLine(review: PublicReview): string | undefined {
|
||||
return `Launch: ${parts.join("; ")}.`;
|
||||
}
|
||||
|
||||
/** "Splash screen changed": the launch comparison when it found a difference; a steady splash is not news for the comment. */
|
||||
function splashLines(review: PublicReview): string[] {
|
||||
const launch = review.launch ?? [];
|
||||
const changed = launch.filter(entry => entry.visual && entry.visual.verdict !== "unchanged");
|
||||
if (!changed.length) return [];
|
||||
const verdict = changed.every(entry => entry.visual!.verdict === "needs-review") ? "needs review" : "changed";
|
||||
const schemes = changed.map(entry => entry.colorScheme).filter((scheme): scheme is NonNullable<typeof scheme> => Boolean(scheme));
|
||||
return [`Splash screen ${verdict}${schemes.length && changed.length < launch.length ? ` in ${schemes.join(" and ")} mode` : ""}`];
|
||||
}
|
||||
|
||||
function contextLines(review: PublicReview): string[] {
|
||||
const variants = review.surfaces.filter(surface => surface.review?.status === "variant").length;
|
||||
const appWide = review.surfaces.filter(surface => surface.sourceScope === "app-wide");
|
||||
const appWide = review.surfaces.filter(surface => surface.sourceScope === "app-wide" && !surface.excluded);
|
||||
const files = [...new Set(appWide.flatMap(surface => surface.sourceChange?.files.filter(file => file.relation === "global").map(file => file.path) ?? []))].sort();
|
||||
const lines: string[] = [];
|
||||
const launch = launchLine(review);
|
||||
@@ -236,7 +226,6 @@ function contextLines(review: PublicReview): string[] {
|
||||
}
|
||||
|
||||
const SURFACE_ID = /^[A-Za-z0-9._-]{1,200}(@(light|dark))?$/;
|
||||
const MAX_ROWS_PER_GROUP = 200;
|
||||
|
||||
/** The run id and attempt the run link names (`…/actions/runs/<id>/attempts/<n>`). */
|
||||
function runIdentity(run: string): { runId: string; runAttempt: string } {
|
||||
@@ -316,7 +305,7 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
|
||||
if (navigation) record.navigation = navigation;
|
||||
const notCompared = state.review.surfaces.filter(notComparedChange).length;
|
||||
if (notCompared) record.notCompared = notCompared;
|
||||
record.context = contextLines(state.review).filter(line => line.length);
|
||||
record.context = splashLines(state.review);
|
||||
const diagnostics = [...(state.evidence?.diagnostics ?? [])];
|
||||
for (const surface of state.review.surfaces) {
|
||||
for (const side of ["base", "head"] as const) {
|
||||
@@ -447,214 +436,185 @@ function surfaceLink(report: string, id: string): string | undefined {
|
||||
return url.href;
|
||||
}
|
||||
|
||||
function resultCell(record: PlatformRecord): string {
|
||||
switch (record.phase) {
|
||||
case "pending": return "⏳ starting";
|
||||
case "capturing": {
|
||||
const capture = record.capture;
|
||||
if (!capture) return "⏳ capturing";
|
||||
const side = capture.current ?? (capture.done.head > 0 || capture.baseFromCache ? "head" : "base");
|
||||
return `⏳ capturing ${side} ${capture.done[side]}/${capture.planned[side]}${capture.baseFromCache && side === "head" ? " · base reused" : ""}`;
|
||||
}
|
||||
case "failed": return `🟥 failed · ${inlineText(record.failure?.step ?? "capture", 48)}`;
|
||||
case "ready": {
|
||||
const unavailable = record.health ? record.health.base.unavailable + record.health.head.unavailable : 0;
|
||||
const unverified = record.health ? record.health.base.unverified + record.health.head.unverified : 0;
|
||||
const failed = (record.validation?.visual?.failed ?? 0) + (record.validation?.accessibility?.failed ?? 0);
|
||||
const notCompared = record.notCompared ?? 0;
|
||||
const icon = unavailable || unverified || failed || notCompared ? "🟨" : "🟩";
|
||||
return [`${icon} ${changeCountText(record.changes?.map(change => change.group) ?? [])}`, notCompared ? `${notCompared} not compared` : undefined, unavailable ? `${unavailable} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
|
||||
failed ? `${failed} comparison${failed === 1 ? "" : "s"} failed` : undefined, duration(record.startedAt, record.updatedAt)].filter(Boolean).join(" · ");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** The report link alone; the workflow run and the report zip sit in the footer, where someone debugging looks for them. */
|
||||
function reportCell(record: PlatformRecord): string {
|
||||
const run = link("run", record.links.run);
|
||||
if (record.phase === "failed") return `${run} · ${link("evidence", record.links.artifacts)}`;
|
||||
if (record.phase !== "ready") return run;
|
||||
return record.links.report ? link(record.links.report.includes(".expo.app/") ? "Open" : "Viewer", record.links.report) : record.links.deploying ? "deploying…" : run;
|
||||
}
|
||||
const ROW_LIMIT = 10;
|
||||
const MAX_FAILURE_MESSAGE = 600;
|
||||
|
||||
/** A target's label as Markdown text. */
|
||||
const labelOf = (record: PlatformRecord) => inlineText(recordLabel(record), 80);
|
||||
const finished = (record: PlatformRecord) => record.phase === "ready" || record.phase === "failed";
|
||||
const firstReport = (records: PlatformRecord[]) => records.find(record => record.phase === "ready" && record.links.report)?.links.report;
|
||||
|
||||
/** "platform" for the per-platform targets of a config without targets, "device" once a config names its own. */
|
||||
function targetNoun(records: PlatformRecord[]): "platform" | "device" {
|
||||
return records.every(record => !record.target && record.label === undefined) ? "platform" : "device";
|
||||
}
|
||||
|
||||
/** "Workflow iOS run · zip; Android run · zip" for the ready targets, with the target named only when there are several. */
|
||||
function artifactLinks(records: PlatformRecord[]): string | undefined {
|
||||
function updatedText(records: PlatformRecord[]): string {
|
||||
const at = Math.max(...records.map(record => record.updatedAt));
|
||||
return `${new Date(at).toLocaleString("en-US", { month: "short", day: "numeric", hour: "numeric", minute: "2-digit", timeZone: "UTC" })} UTC`;
|
||||
}
|
||||
|
||||
/** "17 screens changed · Review in Explore": what the run found, with the report as the heading's link; until a target finished, what it is doing. */
|
||||
function title(records: PlatformRecord[], rows: ChangeRow[]): string {
|
||||
const ready = records.filter(record => record.phase === "ready");
|
||||
if (!ready.length) return undefined;
|
||||
const parts = ready.map(record => {
|
||||
const links = [link("run", record.links.run), record.links.download ? link("zip", record.links.download) : undefined].filter(Boolean).join(" · ");
|
||||
return ready.length > 1 ? `${labelOf(record)} ${links}` : links;
|
||||
});
|
||||
return `Workflow ${parts.join("; ")}`;
|
||||
}
|
||||
|
||||
function deviceCell(record: PlatformRecord): string {
|
||||
const parts = [record.device ? inlineText(record.device, 80) : undefined,
|
||||
record.app?.version ? inlineText(`${record.app.name ? `${record.app.name} ` : ""}${record.app.version}${record.app.build ? ` (${record.app.build})` : ""}`, 80) : undefined].filter(Boolean);
|
||||
return parts.length ? parts.join(" · ") : "—";
|
||||
}
|
||||
|
||||
type ChangeRow = { id: string; route: string; scheme?: string; group: ReviewGroup; description: string; perTarget: Partial<Record<CommentTarget, { group: ReviewGroup; href?: string }>> };
|
||||
|
||||
function changeRows(records: PlatformRecord[]): Map<ReviewGroup, ChangeRow[]> {
|
||||
const rows = new Map<string, ChangeRow>();
|
||||
for (const record of records) {
|
||||
if (record.phase !== "ready") continue;
|
||||
for (const change of record.changes ?? []) {
|
||||
const href = record.links.report ? surfaceLink(record.links.report, change.id) : undefined;
|
||||
const row = rows.get(change.id) ?? { id: change.id, route: change.route, group: change.group, description: change.description, perTarget: {}, ...(change.scheme ? { scheme: change.scheme } : {}) };
|
||||
// A screen accessibility-only on one target and visibly changed on another is listed as the visible change.
|
||||
if (strongerGroup(row.group, change.group) !== row.group) Object.assign(row, { group: change.group, description: change.description });
|
||||
row.perTarget[recordTarget(record)] = { group: change.group, ...(href ? { href } : {}) };
|
||||
rows.set(change.id, row);
|
||||
}
|
||||
}
|
||||
const groups = new Map<ReviewGroup, ChangeRow[]>();
|
||||
for (const row of rows.values()) groups.set(row.group, [...(groups.get(row.group) ?? []), row]);
|
||||
return groups;
|
||||
}
|
||||
|
||||
function renderChangeRow(row: ChangeRow, records: PlatformRecord[]): string {
|
||||
const where = records.flatMap(record => {
|
||||
const entry = row.perTarget[recordTarget(record)];
|
||||
if (!entry) return [];
|
||||
const label = labelOf(record) + (entry.group !== row.group ? ` (${GROUP_LABEL[entry.group].replace(/^\S+ /, "").toLowerCase()})` : "");
|
||||
return [entry.href ? link(label, entry.href) : label];
|
||||
});
|
||||
const route = `\`${plainText(row.route, MAX_ROUTE_LENGTH).replace(/`/g, "")}\`${row.scheme ? ` (${inlineText(row.scheme, 20)})` : ""}`;
|
||||
return `- ${route} — ${inlineText(row.description, MAX_DESCRIPTION_LENGTH)}${where.length ? ` · ${where.join(" · ")}` : ""}`;
|
||||
}
|
||||
|
||||
function changesSection(records: PlatformRecord[], rowCap: number, withMap: boolean): string[] {
|
||||
const ready = records.filter(record => record.phase === "ready");
|
||||
if (!ready.length) return [];
|
||||
const groups = changeRows(ready);
|
||||
const lines: string[] = [];
|
||||
const noun = targetNoun(records);
|
||||
const total = [...groups.values()].reduce((sum, rows) => sum + rows.length, 0);
|
||||
lines.push(`**Changes** · ${plural(total, "screen")}${records.length > 1 && ready.length > 1 ? ` · a screen is listed once, with a link per ${noun}` : ""}`, "");
|
||||
// With screens left uncompared, nothing changed only among the ones compared.
|
||||
if (total === 0) lines.push(ready.some(record => record.notCompared) ? `No compared screen changed on the reviewed ${noun}s.` : `No screen changed on the reviewed ${noun}s.`, "");
|
||||
for (const group of GROUP_ORDER) {
|
||||
const rows = groups.get(group) ?? [];
|
||||
if (!rows.length) continue;
|
||||
const shown = rows.slice(0, rowCap);
|
||||
const content = ["", ...(group === "accessibility-only" ? ["Before and After look the same. What screen readers and voice control read changed.", ""] : []),
|
||||
...shown.map(row => renderChangeRow(row, records))];
|
||||
if (rows.length > shown.length) {
|
||||
const report = ready.find(record => record.links.report)?.links.report;
|
||||
content.push(`- ${rows.length - shown.length} more${report ? ` — ${link("Explore report", report)}` : ""}`);
|
||||
}
|
||||
content.push("");
|
||||
lines.push(...details(`${GROUP_LABEL[group]} (${rows.length})`, content));
|
||||
}
|
||||
if (withMap) lines.push(...mapSection(ready));
|
||||
const seen = new Set<string>();
|
||||
for (const record of ready) for (const line of record.context ?? []) {
|
||||
if (seen.has(line)) continue;
|
||||
seen.add(line);
|
||||
const everywhere = ready.every(other => other.context?.includes(line));
|
||||
lines.push(everywhere ? line : `${labelOf(record)} · ${line}`, "");
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
/**
|
||||
* The heading carries the report links: on a phone the table's last column is clipped, and the
|
||||
* commits it reviews are a subtitle under it. A target still capturing adds its link when it is ready.
|
||||
*/
|
||||
function heading(records: PlatformRecord[]): string {
|
||||
const ready = records.filter(record => record.phase === "ready" && record.links.report);
|
||||
if (!ready.length) {
|
||||
return records.some(record => record.phase === "ready" && record.links.deploying) ? "### Explore review · report deploying, not ready yet" : "### Explore review";
|
||||
if (records.every(record => record.phase === "failed")) return "### Explore review · capture failed";
|
||||
const active = records.filter(record => !finished(record));
|
||||
const verb = active.some(record => record.phase === "capturing") ? "capturing" : "starting";
|
||||
return `### Explore review · ${verb}${records.length > 1 ? ` on ${plural(active.length, targetNoun(records))}` : ""}`;
|
||||
}
|
||||
const links = ready.length === 1 ? [link("Open report", ready[0]!.links.report!)]
|
||||
: ready.map(record => link(`${labelOf(record)} report`, record.links.report!));
|
||||
return `### Explore review · ${links.join(" · ")}`;
|
||||
// With screens left uncompared, nothing changed only among the ones compared.
|
||||
const summary = rows.length ? `${plural(rows.length, "screen")} changed` : ready.some(record => gaps(record).length) ? "No compared screens changed" : "No screens changed";
|
||||
const report = firstReport(ready);
|
||||
const open = report ? link("Review in Explore", report) : ready.some(record => record.links.deploying) ? "report deploying…" : undefined;
|
||||
return `### ${summary}${open ? ` · ${open}` : ""}`;
|
||||
}
|
||||
|
||||
function validationCell(record: PlatformRecord, check: "capture" | "routes" | "visual" | "accessibility" | "inventory"): string {
|
||||
if (record.phase === "pending" || record.phase === "capturing") return "⏳";
|
||||
if (record.phase === "failed") {
|
||||
if (check !== "capture") return "—";
|
||||
const capture = record.capture;
|
||||
return capture ? `🟥 ${capture.done.base + capture.done.head}/${capture.planned.base + capture.planned.head} surfaces` : "🟥 not started";
|
||||
}
|
||||
const health = record.health;
|
||||
switch (check) {
|
||||
case "capture": {
|
||||
const planned = health ? health.base.planned + health.head.planned : (record.capture?.planned.base ?? 0) + (record.capture?.planned.head ?? 0);
|
||||
const done = health ? health.base.captured + health.head.captured : (record.capture?.done.base ?? 0) + (record.capture?.done.head ?? 0);
|
||||
const cache = record.capture?.baseFromCache ? " · base cache reused" : "";
|
||||
return done < planned ? `🟨 ${done}/${planned} surfaces · ${planned - done} unavailable${cache}` : `🟩 ${done}/${planned} surfaces${cache}`;
|
||||
}
|
||||
case "routes": {
|
||||
if (!health) return "—";
|
||||
const verified = health.base.verified + health.head.verified, planned = health.base.planned + health.head.planned;
|
||||
const unverified = health.base.unverified + health.head.unverified, unavailable = health.base.unavailable + health.head.unavailable;
|
||||
return `${verified === planned ? "🟩" : "🟨"} ${verified}/${planned} verified${unverified ? ` · ${unverified} unattributed` : ""}${unavailable ? ` · ${unavailable} unavailable` : ""}`;
|
||||
}
|
||||
case "visual": {
|
||||
const v = record.validation?.visual;
|
||||
if (!v) return "🟨 not run";
|
||||
const mark = v.compared === 0 || v.failed > 0 || v.skipped ? "🟨" : "🟩";
|
||||
return `${mark} ${v.compared} compared · threshold ${v.threshold}${v.failed ? ` · ${v.failed} failed` : ""}${v.skipped ? ` · ${v.skipped} skipped` : ""}`;
|
||||
}
|
||||
case "accessibility": {
|
||||
const a = record.validation?.accessibility;
|
||||
if (!a) return "🟨 not run";
|
||||
return `${a.compared === 0 || a.failed > 0 ? "🟨" : "🟩"} ${a.compared} compared · ${plural(a.described, "description")}${a.failed ? ` · ${a.failed} failed` : ""}`;
|
||||
}
|
||||
case "inventory": return record.validation?.routes !== undefined ? `🟩 ${plural(record.validation.routes, "route")}` : "🟩 analyzed";
|
||||
}
|
||||
/** Every target by name, each linking its own report, then the commits and when the comment last changed. */
|
||||
function subtitle(records: PlatformRecord[], repository: string): string {
|
||||
const first = records[0]!;
|
||||
const targets = records.map(record => record.phase === "ready" && record.links.report ? link(labelOf(record), record.links.report) : labelOf(record));
|
||||
return `<sub>${[...targets, `${commitLink(repository, first.headSha)} vs ${commitLink(repository, first.baseSha)}`, `updated ${updatedText(records)}`].join(" · ")}</sub>`;
|
||||
}
|
||||
|
||||
function validationSummary(record: PlatformRecord): string {
|
||||
/** One line for a target that is not simply done: still working, failed, or finished with captures missing. */
|
||||
function statusLine(record: PlatformRecord): string | undefined {
|
||||
const label = labelOf(record), run = link("run", record.links.run);
|
||||
switch (record.phase) {
|
||||
case "failed": return "🟥 failed";
|
||||
case "pending": return `${label} · starting · ${run}`;
|
||||
case "capturing": {
|
||||
const capture = record.capture;
|
||||
if (!capture) return `${label} · capturing · ${run}`;
|
||||
const side = capture.current ?? (capture.done.head > 0 || capture.baseFromCache ? "head" : "base");
|
||||
return `${label} · capturing ${side} ${capture.done[side]}/${capture.planned[side]}${capture.baseFromCache && side === "head" ? " · base reused" : ""} · ${run}`;
|
||||
}
|
||||
case "failed": return [`**${label} failed**`, inlineText(record.failure?.step ?? "capture", 48), record.failure?.message ? inlineText(record.failure.message, MAX_FAILURE_MESSAGE) : undefined,
|
||||
run, link("evidence", record.links.artifacts)].filter(Boolean).join(" · ");
|
||||
case "ready": {
|
||||
const health = record.health;
|
||||
if (!health) return "🟩 reviewed";
|
||||
const captured = health.base.captured + health.head.captured, planned = health.base.planned + health.head.planned;
|
||||
return `${captured < planned ? "🟨" : "🟩"} ${captured}/${planned} captured`;
|
||||
const parts = gaps(record);
|
||||
return parts.length ? `${label} · ${parts.join(" · ")} · ${run}` : undefined;
|
||||
}
|
||||
default: return "⏳ in progress";
|
||||
}
|
||||
}
|
||||
|
||||
function validationSection(byTarget: PlatformRecord[]): string[] {
|
||||
if (!byTarget.some(record => record.phase === "ready" || record.phase === "failed")) return [];
|
||||
const summary = `Validation · ${byTarget.map(record => `${labelOf(record)} ${validationSummary(record)}`).join(" · ")}`;
|
||||
const header = `| Check | ${byTarget.map(labelOf).join(" | ")} |`;
|
||||
const checks: [string, Parameters<typeof validationCell>[1]][] = [["Capture", "capture"], ["Route verification", "routes"], ["Visual comparison", "visual"], ["Accessibility comparison", "accessibility"], ["Source inventory", "inventory"]];
|
||||
const content = ["", header, `|---|${byTarget.map(() => "---").join("|")}|`,
|
||||
...checks.map(([label, check]) => `| ${label} | ${byTarget.map(record => validationCell(record, check)).join(" | ")} |`), ""];
|
||||
for (const record of byTarget) {
|
||||
if (record.phase === "failed" && record.failure) {
|
||||
content.push(`**${labelOf(record)} failed** — ${inlineText(record.failure.message, 1200)} ${link("Open the failed run", record.links.run)} · ${link("Evidence artifact", record.links.artifacts)}`, "");
|
||||
}
|
||||
if (record.phase !== "ready") continue;
|
||||
const health = record.health;
|
||||
const gaps = health ? health.base.unavailable + health.base.unverified + health.head.unavailable + health.head.unverified : 0;
|
||||
if (!gaps && !record.diagnostics?.length) continue;
|
||||
const sideLine = (side: "base" | "head") => { const h = health![side]; return `${side} ${h.verified}/${h.planned} verified${h.unverified ? ` · ${h.unverified} unattributed` : ""}${h.unavailable ? ` · ${h.unavailable} unavailable` : ""}`; };
|
||||
content.push(health ? `**${labelOf(record)}** · ${sideLine("base")} · ${sideLine("head")}` : `**${labelOf(record)}**`, "");
|
||||
/** What a finished target has no verdict on: captures missing or unattributed, comparisons that did not run or failed. */
|
||||
function gaps(record: PlatformRecord): string[] {
|
||||
const unavailable = record.health ? record.health.base.unavailable + record.health.head.unavailable : 0;
|
||||
const unverified = record.health ? record.health.base.unverified + record.health.head.unverified : 0;
|
||||
const failed = (record.validation?.visual?.failed ?? 0) + (record.validation?.accessibility?.failed ?? 0);
|
||||
return [unavailable ? `${plural(unavailable, "capture")} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
|
||||
record.notCompared ? `${record.notCompared} not compared` : undefined, failed ? `${plural(failed, "comparison")} failed` : undefined]
|
||||
.filter((part): part is string => Boolean(part));
|
||||
}
|
||||
|
||||
/** The per-screen capture problems, collapsed: the status line already counts them. */
|
||||
function diagnosticsSection(records: PlatformRecord[]): string[] {
|
||||
const flagged = records.filter(record => record.phase === "ready" && ((record.diagnostics?.length ?? 0) > 0 || (record.diagnosticCount ?? 0) > 0));
|
||||
if (!flagged.length) return [];
|
||||
const content: string[] = [""];
|
||||
for (const record of flagged) {
|
||||
if (records.length > 1) content.push(`**${labelOf(record)}**`, "");
|
||||
for (const diagnostic of record.diagnostics ?? []) {
|
||||
content.push(`- ${diagnostic.side ? `${diagnostic.side === "base" ? "Base" : "Head"} · ` : ""}${inlineText(diagnostic.route, MAX_ROUTE_LENGTH)} · ${inlineText(diagnostic.code, 80)}: ${inlineText(diagnostic.message, 160)} Next action: ${inlineText(diagnostic.nextAction, 240)}`);
|
||||
}
|
||||
const more = (record.diagnosticCount ?? 0) - (record.diagnostics?.length ?? 0);
|
||||
if (more > 0) content.push(`- ${more} more — ${link("View run", record.links.run)}`);
|
||||
if (record.diagnostics?.length) content.push("");
|
||||
if (more > 0) content.push(`- ${more} more — ${link("run", record.links.run)}`);
|
||||
content.push("");
|
||||
}
|
||||
return details(summary, content);
|
||||
const total = flagged.reduce((sum, record) => sum + Math.max(record.diagnosticCount ?? 0, record.diagnostics?.length ?? 0), 0);
|
||||
return details(`Capture issues (${total})`, content);
|
||||
}
|
||||
|
||||
type ChangeRow = { id: string; route: string; scheme?: string; group: ReviewGroup; description: string; href?: string; targets: PlatformRecord[] };
|
||||
|
||||
/** Every changed screen once, in group order (added, removed, modified, …), linking the first target in config order that shows its group. */
|
||||
function changeRows(ready: PlatformRecord[]): ChangeRow[] {
|
||||
const rows = new Map<string, ChangeRow>();
|
||||
for (const record of ready) {
|
||||
for (const change of record.changes ?? []) {
|
||||
const href = record.links.report ? surfaceLink(record.links.report, change.id) : undefined;
|
||||
const row = rows.get(change.id) ?? { id: change.id, route: change.route, group: change.group, description: change.description, targets: [], ...(change.scheme ? { scheme: change.scheme } : {}) };
|
||||
// A screen accessibility-only on one target and visibly changed on another is listed as the visible change.
|
||||
// The link opens the target the row describes.
|
||||
if (strongerGroup(row.group, change.group) !== row.group) Object.assign(row, { group: change.group, description: change.description, href });
|
||||
else if (!row.href && href && change.group === row.group) row.href = href;
|
||||
row.targets.push(record);
|
||||
rows.set(change.id, row);
|
||||
}
|
||||
}
|
||||
return [...rows.values()].sort((a, b) => GROUP_ORDER.indexOf(a.group) - GROUP_ORDER.indexOf(b.group));
|
||||
}
|
||||
|
||||
function renderChangeRow(row: ChangeRow, ready: PlatformRecord[]): string {
|
||||
const code = `\`${plainText(row.route, MAX_ROUTE_LENGTH).replace(/`/g, "")}\``;
|
||||
const route = `${row.href ? link(code, row.href) : code}${row.scheme ? ` (${inlineText(row.scheme, 20)})` : ""}`;
|
||||
const description = inlineText(row.description.replace(/\.$/, ""), MAX_DESCRIPTION_LENGTH);
|
||||
let text: string;
|
||||
if (row.group === "added" || row.group === "removed") {
|
||||
const verb = row.group === "added" ? "Added" : "Removed";
|
||||
// The default description repeats the verb and route; an agent's note does not.
|
||||
text = row.description === `${verb} ${row.route} screen` ? `${verb} ${route}` : `${verb} ${route} · ${description}`;
|
||||
} else {
|
||||
text = `${route} · ${description}`;
|
||||
}
|
||||
const tag = row.group === "accessibility-only" ? "accessibility only" : row.group === "needs-review" ? "needs review" : undefined;
|
||||
// A target with screens it has no verdict on may have changed this one too: name where it changed, not where it did not.
|
||||
const where = ready.some(record => !row.targets.includes(record) && gaps(record).length)
|
||||
? `on ${row.targets.map(labelOf).join(", ")}` : targetsNote(row.targets, ready);
|
||||
return `- ${[text, tag, where].filter(Boolean).join(" · ")}`;
|
||||
}
|
||||
|
||||
/** "Android only" / "not on Android": the targets a screen changed on, when not all of them, named the shorter way. */
|
||||
function targetsNote(on: PlatformRecord[], ready: PlatformRecord[]): string | undefined {
|
||||
if (ready.length < 2 || on.length >= ready.length) return undefined;
|
||||
const missing = ready.filter(record => !on.includes(record));
|
||||
return missing.length < on.length ? `not on ${missing.map(labelOf).join(", ")}` : `${on.map(labelOf).join(", ")} only`;
|
||||
}
|
||||
|
||||
function changesSection(ready: PlatformRecord[], rows: ChangeRow[], rowCap: number, withMap: boolean): string[] {
|
||||
if (!ready.length) return [];
|
||||
const lines: string[] = [];
|
||||
const shown = rows.slice(0, rowCap);
|
||||
lines.push(...shown.map(row => renderChangeRow(row, ready)));
|
||||
if (rows.length > shown.length) {
|
||||
const report = firstReport(ready);
|
||||
const more = `${plural(rows.length - shown.length, "more screen")} in the report`;
|
||||
lines.push(`- ${report ? link(more, report) : more}`);
|
||||
}
|
||||
if (lines.length) lines.push("");
|
||||
if (withMap) lines.push(...mapSection(ready));
|
||||
const byLine = new Map<string, PlatformRecord[]>();
|
||||
for (const record of ready) for (const line of record.context ?? []) byLine.set(line, [...(byLine.get(line) ?? []), record]);
|
||||
for (const [line, records] of byLine) lines.push(records.length === ready.length ? line : `${line} · ${targetsNote(records, ready)}`, "");
|
||||
return lines;
|
||||
}
|
||||
|
||||
/**
|
||||
* The previous run stays on the comment while a new one works or has only failed; this line, above it, says which,
|
||||
* with each failure's step and message.
|
||||
*/
|
||||
function newRunLine(current: PlatformRecord[], shown: PlatformRecord[], repository: string): string {
|
||||
const first = current[0]!;
|
||||
const active = current.filter(record => !finished(record));
|
||||
const failed = current.filter(record => record.phase === "failed");
|
||||
const named = current.length > 1 || shown.length > 1 || Boolean(first.target) || first.label !== undefined;
|
||||
const verb = active.some(record => record.phase === "capturing") ? "capturing" : "starting";
|
||||
const working = active.length ? [`${verb}${named ? ` on ${active.map(labelOf).join(", ")}` : ""}`] : [];
|
||||
const failures = failed.map(record => [named ? `**${labelOf(record)} failed**` : undefined, inlineText(record.failure?.step ?? "capture", 48),
|
||||
record.failure?.message ? inlineText(record.failure.message, MAX_FAILURE_MESSAGE) : undefined].filter(Boolean).join(" · "));
|
||||
const links = [link("run", first.links.run), ...(failed.length ? [link("evidence", failed[0]!.links.artifacts)] : [])];
|
||||
return `> **${active.length ? "New run in progress" : "New run failed"}** for ${commitLink(repository, first.headSha)} · ${[...working, ...failures, ...links].join(" · ")}`;
|
||||
}
|
||||
|
||||
function footer(records: PlatformRecord[]): string {
|
||||
const parts: string[] = [];
|
||||
const expiries = records.filter(record => record.phase === "ready" && record.links.expiresAt !== undefined).map(record => record.links.expiresAt);
|
||||
if (expiries.length) parts.push(expiries.some(at => at === null) ? "Preview links work for anyone who has them until the deployment is deleted"
|
||||
: `Preview links work for anyone who has them until ${previewExpiry(Math.min(...expiries.filter((at): at is number => at !== null)))}`);
|
||||
const runs = records.filter((record, index, all) => all.findIndex(other => other.links.run === record.links.run) === index);
|
||||
parts.push(runs.length === 1 ? link("Workflow run", runs[0]!.links.run) : runs.map(record => link(`${labelOf(record)} run`, record.links.run)).join(" · "));
|
||||
parts.push(link("Config", records[0]!.links.config));
|
||||
return `<sub>${parts.join(" · ")}</sub>`;
|
||||
}
|
||||
|
||||
function historySection(repository: string, history: HistoryEntry[]): string[] {
|
||||
@@ -683,44 +643,47 @@ function deploymentOf(url: string | undefined): string | undefined {
|
||||
}
|
||||
function deploymentMarkerOf(records: CommentRecords): string | undefined {
|
||||
const names = new Set<string>();
|
||||
for (const record of Object.values(records.current)) { const name = deploymentOf(record?.links.report); if (name) names.add(name); }
|
||||
for (const record of [...Object.values(records.current), ...Object.values(records.previous ?? {})]) { const name = deploymentOf(record?.links.report); if (name) names.add(name); }
|
||||
for (const entry of records.history) for (const item of Object.values(entry.platforms)) { const name = deploymentOf(item?.report); if (name) names.add(name); }
|
||||
return names.size ? `<!-- expo-explore-deployments:${[...names].sort().join(",")} -->` : undefined;
|
||||
}
|
||||
|
||||
/** The whole comment from its records: hidden lines first, then one review for every target of the current run, in config order. */
|
||||
/**
|
||||
* The whole comment from its records: hidden lines first, then the review. Until a target of the current run is ready,
|
||||
* the previous run's review stays up under a line that says a new run is working or failed.
|
||||
*/
|
||||
export function renderCommentRecords(records: CommentRecords, existing?: string, budget = PUBLIC_COMMENT_BODY_BUDGET): string {
|
||||
const current = orderedRecords(records);
|
||||
const previous = orderedPrevious(records);
|
||||
const hidden = [CI_COMMENT_MARKER, ...[deploymentMarkerOf(records)].filter((line): line is string => Boolean(line)),
|
||||
...current.map(recordLine), ...[historyLine(records.history)].filter((line): line is string => Boolean(line))];
|
||||
...current.map(recordLine), ...previous.map(previousLine), ...[historyLine(records.history)].filter((line): line is string => Boolean(line))];
|
||||
if (!current.length) return [...hidden, "### Explore review", "", ...(records.history.some(entry => Object.values(entry.platforms).some(item => item?.superseded)) ? [SUPERSEDED_NOTE, ""] : []),
|
||||
...historySection("", records.history)].join("\n");
|
||||
const first = current[0]!;
|
||||
const shown = current.some(record => record.phase === "ready") || !previous.length ? current : previous;
|
||||
const first = shown[0]!;
|
||||
const repository = repositoryOf(first.links.run);
|
||||
const ready = shown.filter(record => record.phase === "ready");
|
||||
const rows = changeRows(ready);
|
||||
const render = (rowCap: number, withMap: boolean): string => {
|
||||
const lines: string[] = [...hidden, heading(current), "",
|
||||
`<sub>base ${commitLink(repository, first.baseSha)} → ${commitLink(repository, first.headSha)}</sub>`, ""];
|
||||
const lines: string[] = [...hidden];
|
||||
if (shown !== current) lines.push(newRunLine(current, shown, repository), "");
|
||||
lines.push(title(shown, rows), "", subtitle(shown, repository), "");
|
||||
if (first.superseded) lines.push(SUPERSEDED_NOTE, "");
|
||||
lines.push(`| | Device | Result | Report |`, `|---|---|---|---|`,
|
||||
...current.map(record => `| ${labelOf(record)} | ${deviceCell(record)} | ${resultCell(record)} | ${reportCell(record)} |`), "");
|
||||
lines.push(...changesSection(current, rowCap, withMap));
|
||||
lines.push(...validationSection(current));
|
||||
for (const line of shown.map(statusLine)) if (line) lines.push(line, "");
|
||||
lines.push(...changesSection(ready, rows, rowCap, withMap));
|
||||
lines.push(...diagnosticsSection(shown));
|
||||
lines.push(...historySection(repository, records.history));
|
||||
const expiries = current.filter(record => record.phase === "ready" && record.links.expiresAt !== undefined).map(record => record.links.expiresAt);
|
||||
const footer: string[] = [];
|
||||
if (expiries.length) footer.push(expiries.some(at => at === null) ? "Preview links work for anyone who has them until the deployment is deleted."
|
||||
: `Preview links work until ${previewExpiry(Math.min(...expiries.filter((at): at is number => at !== null)))} for anyone who has them.`);
|
||||
footer.push(`Managed via ${link("`" + plainText(configPathOf(first.links.config), 120).replace(/`/g, "") + "`", first.links.config)}`);
|
||||
const artifacts = artifactLinks(current);
|
||||
if (artifacts) footer.push(artifacts);
|
||||
lines.push(footer.join(" · "));
|
||||
lines.push(footer(shown));
|
||||
return lines.join("\n");
|
||||
};
|
||||
// The map goes first when the body is over budget, then the change lists shrink.
|
||||
let rowCap = MAX_ROWS_PER_GROUP;
|
||||
// The map goes first when the body is over budget, then the list shrinks, then the previous run's records go; once the
|
||||
// current run shows, nothing renders them, so they go first.
|
||||
let rowCap = ROW_LIMIT;
|
||||
let body = render(rowCap, true);
|
||||
if (body.length > budget && shown === current && previous.length) return renderCommentRecords({ ...records, previous: {} }, existing, budget);
|
||||
if (body.length > budget) body = render(rowCap, false);
|
||||
while (body.length > budget && rowCap > 1) { rowCap = Math.max(1, Math.floor(rowCap / 2)); body = render(rowCap, false); }
|
||||
if (body.length > budget && previous.length) return renderCommentRecords({ ...records, previous: {} }, existing, budget);
|
||||
return body;
|
||||
}
|
||||
|
||||
@@ -728,10 +691,6 @@ function repositoryOf(run: string): string {
|
||||
const match = /^https:\/\/github\.com\/([^/]+)\/([^/]+)\/actions\//.exec(run);
|
||||
return match ? `${decodeURIComponent(match[1]!)}/${decodeURIComponent(match[2]!)}` : "";
|
||||
}
|
||||
function configPathOf(config: string): string {
|
||||
const match = /\/blob\/[0-9a-f]{40}\/(.+)$/.exec(config);
|
||||
return match ? decodeURIComponent(match[1]!) : "config";
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the sticky pull-request comment for any phase of a public review run, folding this writer into the existing
|
||||
|
||||
@@ -127,7 +127,12 @@ export type HistoryEntry = {
|
||||
};
|
||||
export type HistoryItem = { phase: RecordPhase; summary: string; run: string; report?: string; download?: string; superseded?: boolean; label?: string; order?: number };
|
||||
|
||||
export type CommentRecords = { current: Partial<Record<CommentTarget, PlatformRecord>>; history: HistoryEntry[] };
|
||||
export type CommentRecords = {
|
||||
current: Partial<Record<CommentTarget, PlatformRecord>>;
|
||||
/** The last finished run's records, shown while the current run has no finished record of its own. */
|
||||
previous?: Partial<Record<CommentTarget, PlatformRecord>>;
|
||||
history: HistoryEntry[];
|
||||
};
|
||||
|
||||
/** The id a record is keyed by. */
|
||||
export function recordTarget(record: Pick<PlatformRecord, "platform" | "target">): CommentTarget {
|
||||
@@ -146,12 +151,22 @@ export function compareTargets(a: { id: CommentTarget; order?: number | undefine
|
||||
|
||||
/** The current records in display order. */
|
||||
export function orderedRecords(records: CommentRecords): PlatformRecord[] {
|
||||
return Object.values(records.current).filter((record): record is PlatformRecord => Boolean(record))
|
||||
return ordered(records.current);
|
||||
}
|
||||
|
||||
/** The previous run's records in display order. */
|
||||
export function orderedPrevious(records: CommentRecords): PlatformRecord[] {
|
||||
return ordered(records.previous ?? {});
|
||||
}
|
||||
|
||||
function ordered(records: Partial<Record<CommentTarget, PlatformRecord>>): PlatformRecord[] {
|
||||
return Object.values(records).filter((record): record is PlatformRecord => Boolean(record))
|
||||
.sort((a, b) => compareTargets({ id: recordTarget(a), order: a.order }, { id: recordTarget(b), order: b.order }));
|
||||
}
|
||||
|
||||
export const HISTORY_LIMIT = 5;
|
||||
const RECORD_LINE = /^<!-- expo-explore-record:([a-z][a-z0-9-]{0,31}):([A-Za-z0-9_-]+) -->$/gm;
|
||||
const PREVIOUS_LINE = /^<!-- expo-explore-previous:([a-z][a-z0-9-]{0,31}):([A-Za-z0-9_-]+) -->$/gm;
|
||||
const HISTORY_LINE = /^<!-- expo-explore-history:([A-Za-z0-9_-]+) -->$/m;
|
||||
const MAX_ENCODED = 24_000;
|
||||
const MAX_DECODED = 256_000;
|
||||
@@ -176,6 +191,10 @@ export function recordLine(record: PlatformRecord): string {
|
||||
return `<!-- expo-explore-record:${recordTarget(record)}:${encodeRecordPayload(record)} -->`;
|
||||
}
|
||||
|
||||
export function previousLine(record: PlatformRecord): string {
|
||||
return `<!-- expo-explore-previous:${recordTarget(record)}:${encodeRecordPayload(record)} -->`;
|
||||
}
|
||||
|
||||
export function historyLine(history: HistoryEntry[]): string | undefined {
|
||||
return history.length ? `<!-- expo-explore-history:${encodeRecordPayload(history)} -->` : undefined;
|
||||
}
|
||||
@@ -312,12 +331,18 @@ export function parseHistory(value: unknown): HistoryEntry[] {
|
||||
export function readCommentRecords(body: string | undefined): CommentRecords {
|
||||
const records: CommentRecords = { current: {}, history: [] };
|
||||
if (!body) return records;
|
||||
for (const match of body.matchAll(RECORD_LINE)) {
|
||||
const record = parsePlatformRecord(decodePayload(match[2]!));
|
||||
const target = record && recordTarget(record);
|
||||
if (!record || target !== match[1] || !isTargetId(target)) continue;
|
||||
if (records.current[target] || Object.keys(records.current).length < MAX_COMMENT_TARGETS) records.current[target] = record;
|
||||
}
|
||||
const read = (pattern: RegExp, into: Partial<Record<CommentTarget, PlatformRecord>>) => {
|
||||
for (const match of body.matchAll(pattern)) {
|
||||
const record = parsePlatformRecord(decodePayload(match[2]!));
|
||||
const target = record && recordTarget(record);
|
||||
if (!record || target !== match[1] || !isTargetId(target)) continue;
|
||||
if (into[target] || Object.keys(into).length < MAX_COMMENT_TARGETS) into[target] = record;
|
||||
}
|
||||
};
|
||||
read(RECORD_LINE, records.current);
|
||||
const previous: Partial<Record<CommentTarget, PlatformRecord>> = {};
|
||||
read(PREVIOUS_LINE, previous);
|
||||
if (Object.keys(previous).length) records.previous = previous;
|
||||
const history = body.match(HISTORY_LINE);
|
||||
if (history) records.history = parseHistory(decodePayload(history[1]!));
|
||||
return records;
|
||||
@@ -371,14 +396,43 @@ export function foldRecord(existing: CommentRecords, incoming: PlatformRecord):
|
||||
const record = withKnownTarget(incoming, existing);
|
||||
const target = recordTarget(record);
|
||||
const currentRun = current[0];
|
||||
if (!currentRun && record.superseded) return { current: {}, history: pushHistory(existing.history, historyEntryOf([record])) };
|
||||
const previous = existing.previous ?? {};
|
||||
if (!currentRun && record.superseded) return { current: {}, previous, history: pushHistory(existing.history, historyEntryOf([record])) };
|
||||
if (!currentRun || currentRun.runId === record.runId) {
|
||||
return { current: { ...existing.current, [target]: record }, history: existing.history };
|
||||
const next = { ...existing.current, [target]: record };
|
||||
// A rerun's new attempt replaces a ready record with one that is not; the ready one stays readable meanwhile.
|
||||
const replaced = existing.current[target];
|
||||
const rerun = replaced && isReady(replaced) && !isReady(record) && Number(record.runAttempt) > Number(replaced.runAttempt);
|
||||
return { current: next, previous: trimPrevious(rerun ? { ...ofRun(previous, record.runId), [target]: replaced } : previous, next), history: existing.history };
|
||||
}
|
||||
if (runOrder(currentRun.runId) > runOrder(record.runId) || record.superseded) {
|
||||
return { current: existing.current, history: pushHistory(existing.history, historyEntryOf([{ ...record, superseded: true }])) };
|
||||
return { current: existing.current, previous, history: pushHistory(existing.history, historyEntryOf([{ ...record, superseded: true }])) };
|
||||
}
|
||||
return { current: { [target]: record }, history: pushHistory(existing.history, historyEntryOf(current)) };
|
||||
// The review of the run being replaced stays readable until the new run has a ready target. It replaces older
|
||||
// previous records rather than joining them: what the comment shows as one review comes from one run. A run without a
|
||||
// ready target has no review, so the one before it stays.
|
||||
const kept = current.some(isReady) ? Object.fromEntries(current.filter(isFinished).map(item => [recordTarget(item), item])) : previous;
|
||||
const next = { [target]: record };
|
||||
return { current: next, previous: trimPrevious(kept, next), history: pushHistory(existing.history, historyEntryOf(current)) };
|
||||
}
|
||||
|
||||
const isFinished = (record: PlatformRecord) => record.phase === "ready" || record.phase === "failed";
|
||||
const isReady = (record: PlatformRecord) => record.phase === "ready";
|
||||
|
||||
function ofRun(records: Partial<Record<CommentTarget, PlatformRecord>>, runId: string): Partial<Record<CommentTarget, PlatformRecord>> {
|
||||
return Object.fromEntries(Object.entries(records).filter(([, record]) => record?.runId === runId));
|
||||
}
|
||||
|
||||
/**
|
||||
* A target's previous record goes once its current one is ready; all of them go once every current record finished
|
||||
* and one is ready. A failure is no review: the previous one stays up beside it.
|
||||
*/
|
||||
function trimPrevious(previous: Partial<Record<CommentTarget, PlatformRecord>>, current: Partial<Record<CommentTarget, PlatformRecord>>): Partial<Record<CommentTarget, PlatformRecord>> {
|
||||
const records = Object.values(current).filter((record): record is PlatformRecord => Boolean(record));
|
||||
if (records.every(isFinished) && records.some(isReady)) return {};
|
||||
const trimmed = { ...previous };
|
||||
for (const record of records) if (isReady(record)) delete trimmed[recordTarget(record)];
|
||||
return trimmed;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -388,7 +442,7 @@ export function foldRecord(existing: CommentRecords, incoming: PlatformRecord):
|
||||
function withKnownTarget(record: PlatformRecord, existing: CommentRecords): PlatformRecord {
|
||||
const target = recordTarget(record);
|
||||
if (!record.target || record.label !== undefined || record.order !== undefined) return record;
|
||||
const known = existing.current[target];
|
||||
const known = existing.current[target] ?? existing.previous?.[target];
|
||||
if (known) return { ...record, platform: known.platform, ...(known.label !== undefined ? { label: known.label } : {}), ...(known.order !== undefined ? { order: known.order } : {}) };
|
||||
const item = existing.history.find(entry => entry.platforms[target])?.platforms[target];
|
||||
return item ? { ...record, ...(item.label !== undefined ? { label: item.label } : {}), ...(item.order !== undefined ? { order: item.order } : {}) } : record;
|
||||
|
||||
+172
-103
@@ -1,15 +1,15 @@
|
||||
import { createCipheriv, createHash, randomBytes } from "node:crypto";
|
||||
import { createHash, randomBytes } from "node:crypto";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { appendFile, cp, lstat, mkdir, mkdtemp, readdir, readFile, realpath, rm, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join, relative, resolve, sep } from "node:path";
|
||||
import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from "@zip.js/zip.js";
|
||||
import { loadReport, MAX_METADATA_BYTES } from "./agent-api.js";
|
||||
import { manifestBody } from "./preview-manifest.js";
|
||||
import { MAX_ASSET_BYTES, manifestBody, PREVIEW_ASSET } from "./preview-manifest.js";
|
||||
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
|
||||
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
|
||||
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { isTargetId, warnIgnoredExpiry, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { targetParameter } from "./viewer-links.js";
|
||||
import type { ArtifactReport } from "../contracts/artifact-report.js";
|
||||
@@ -22,21 +22,23 @@ import { TOOL_ROOT, packageBin } from "../shared/package-paths.js";
|
||||
/**
|
||||
* `ci:deploy`: publish one token-gated EAS Hosting deployment for a packaged review.
|
||||
*
|
||||
* The deployment is the prebuilt preview export of viewer-host (routes `/p/[token]`, see viewer-host/README.md)
|
||||
* plus the report ZIP encrypted with a key that only the deployment's Worker environment holds. The Worker
|
||||
* serves the Viewer and the decrypted report at `/p/<token>` and answers 404 to everything else; after
|
||||
* `expiresAt` (if any) the token page says the link expired. Deployments are never deleted automatically. The report job already published the GitHub artifact links, so a failed deployment leaves
|
||||
* the comment on the download-and-drop flow.
|
||||
* The deployment is the prebuilt preview export of viewer-host (routes `/p/[token]`, see viewer-host/README.md) plus
|
||||
* the report as static files under the link's token: each target's manifest at `p/<token>/targets/<target>.json` and
|
||||
* every screenshot at `p/<token>/assets/<sha256>.<ext>`. Nothing is encrypted; the 160-bit token in every path is what
|
||||
* keeps them private. The Worker serves the Viewer at `/p/<token>` and answers 404 to everything else. A deployment
|
||||
* lasts as long as EAS Hosting keeps it (it deletes deployments without an alias after 30 days on Free, 90 on paid
|
||||
* plans); Explore sets no expiry of its own. The report job already published the GitHub artifact links, so a failed
|
||||
* deployment leaves the comment on the download-and-drop flow.
|
||||
*/
|
||||
export type CommandRunner = (command: string, args: readonly string[], options: { cwd: string; env: NodeJS.ProcessEnv })
|
||||
=> { status: number | null; stdout: string; stderr: string };
|
||||
|
||||
export type PreviewReportInput = {
|
||||
/** Set by the matrix workflows; the preview then serves this report at report.zip?platform=<platform>. */
|
||||
/** Set by the matrix workflows; the preview then serves this report at manifest.json?platform=<platform>. */
|
||||
platform?: ExplorePlatform;
|
||||
/**
|
||||
* The capture target, set by the matrix workflows (wins over `platform`): the preview serves the report as
|
||||
* `<target id>.zip.enc` at report.zip?target=<id> (?platform=<id> for a target named after its platform).
|
||||
* `targets/<target id>.json`, selected by manifest.json?target=<id> (?platform=<id> for a target named after its platform).
|
||||
*/
|
||||
target?: RunTarget;
|
||||
inputPath: string;
|
||||
@@ -46,7 +48,7 @@ export type PreviewReportInput = {
|
||||
};
|
||||
|
||||
export type PreviewDeployOptions = (PreviewReportInput | {
|
||||
/** One report per platform from the same run, sealed into one deployment behind one token. */
|
||||
/** One report per platform from the same run, deployed together behind one token. */
|
||||
reports: PreviewReportInput[];
|
||||
}) & {
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
@@ -82,7 +84,6 @@ export type PreviewDeployResult = {
|
||||
};
|
||||
|
||||
export const PREVIEW_EXPORT_PATH = join(TOOL_ROOT, "dist", "hosting-preview");
|
||||
const CIPHER_AAD = "expo-explore-preview/1";
|
||||
const BASE32 = "abcdefghijklmnopqrstuvwxyz234567";
|
||||
/** The largest report ZIP a hosted preview serves. */
|
||||
export const MAX_REPORT_BYTES = 256 * 1024 * 1024;
|
||||
@@ -94,7 +95,7 @@ export function platformTarget(platform: ExplorePlatform): RunTarget {
|
||||
return { id: platform, platform, label: PLATFORM_LABELS[platform] };
|
||||
}
|
||||
|
||||
/** The report.zip query that selects a target (see targetParameter): `?platform=ios` for configs without targets, as before. */
|
||||
/** The manifest.json query that selects a target (see targetParameter): `?platform=ios` for configs without targets, as before. */
|
||||
function targetQuery(target: RunTarget): string {
|
||||
const [key, value] = targetParameter(target.id);
|
||||
return `?${key}=${value}`;
|
||||
@@ -142,11 +143,21 @@ const DEPLOY_ATTEMPTS = 3;
|
||||
const ALIAS_LIMIT = /reached the limit of \d+ aliases[^\n]*/;
|
||||
const DEPLOY_RETRY_DELAYS_MS = [5_000, 15_000] as const;
|
||||
|
||||
/** The tail of what a command printed, stderr first, without the EXPO_TOKEN should eas ever echo it. */
|
||||
function commandOutput(result: ReturnType<CommandRunner>, token: string | undefined): string {
|
||||
/**
|
||||
* EAS Hosting serves static files with its own headers, so the screenshots and manifests cannot carry the Worker's
|
||||
* `noindex`; this keeps crawlers from fetching them. The page and API stay crawlable, so a crawler still sees their `noindex`.
|
||||
*/
|
||||
export const PREVIEW_ROBOTS = "User-agent: *\nDisallow: /p/*/assets/\nDisallow: /p/*/targets/\n";
|
||||
|
||||
/**
|
||||
* The tail of what a command printed, stderr first, without the secrets: the EXPO_TOKEN should eas ever echo it, and the
|
||||
* link's token, which every static file's path carries (eas names the file whose upload failed).
|
||||
*/
|
||||
function commandOutput(result: ReturnType<CommandRunner>, secrets: Array<string | undefined>): string {
|
||||
const lines = `${result.stderr}\n${result.stdout}`.split("\n").map(line => line.trimEnd()).filter(Boolean);
|
||||
const tail = lines.slice(-30).join("\n");
|
||||
return token ? tail.split(token).join("***") : tail;
|
||||
let tail = lines.slice(-30).join("\n");
|
||||
for (const secret of secrets) if (secret) tail = tail.split(secret).join("***");
|
||||
return tail;
|
||||
}
|
||||
|
||||
/** `eas whoami` has no JSON output; its account list is one `• name (Role: …)` line per account. */
|
||||
@@ -253,13 +264,6 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
|
||||
}
|
||||
|
||||
/** iv (12 bytes) || AES-256-GCM ciphertext || tag, authenticated with the preview AAD; what the Worker decrypts. */
|
||||
export function sealReport(plain: Uint8Array, key: Uint8Array, iv: Uint8Array): Uint8Array {
|
||||
const cipher = createCipheriv("aes-256-gcm", key, iv);
|
||||
cipher.setAAD(Buffer.from(CIPHER_AAD));
|
||||
const body = Buffer.concat([cipher.update(plain), cipher.final(), cipher.getAuthTag()]);
|
||||
return new Uint8Array(Buffer.concat([iv, body]));
|
||||
}
|
||||
|
||||
/** Fails fast when the Viewer export that hosted reports need is not installed, so a run does not explore for minutes before learning it cannot upload. */
|
||||
export async function assertHostingExport(exportPath: string = PREVIEW_EXPORT_PATH): Promise<void> {
|
||||
await assertExport(resolve(exportPath));
|
||||
@@ -273,12 +277,13 @@ async function assertExport(exportPath: string): Promise<void> {
|
||||
}
|
||||
}
|
||||
|
||||
type SealedReport = { entry: PreviewReportInput; input: CiReportInput; target?: RunTarget; zip: Uint8Array; sha256: string; file: string };
|
||||
/** A report to deploy; `file` names its manifest, `targets/<file>.json`: the target id, or `report` for a single unlisted one. */
|
||||
type DeployedReport = { entry: PreviewReportInput; input: CiReportInput; target?: RunTarget; zip: Uint8Array; sha256: string; file: string };
|
||||
|
||||
function previewError(code: string, message: string, nextAction: string): CiError { return new CiError({ code, stage: "preflight", message, nextAction }); }
|
||||
|
||||
/**
|
||||
* A device label for the platform switch, safe in the sealed .env: letters, digits and a few separators only. `eas
|
||||
* A device label for the platform switch, safe in the deployment's .env: letters, digits and a few separators only. `eas
|
||||
* deploy` reads that file with variable expansion, so a `$` (even single-quoted) would pull the deploying process's
|
||||
* environment into the label, and a `#` or a backslash would cut or corrupt the JSON around it.
|
||||
*/
|
||||
@@ -292,14 +297,25 @@ function listingLabel(label: string): string {
|
||||
|
||||
/** One EXPLORE_PREVIEW_REPORTS entry, keys in the order the Worker echoes them in reports.json. */
|
||||
export type PreviewListingEntry = { target: string; platform: ExplorePlatform; label?: string; path: string; changes?: number; device?: string };
|
||||
function listingEntry(target: RunTarget, path: string, changes?: number, device?: string): PreviewListingEntry {
|
||||
/** A listing entry before the deployment's token, and so its manifest's path, is known. */
|
||||
type ListingTarget = Omit<PreviewListingEntry, "path">;
|
||||
function listingEntry(target: RunTarget, changes?: number, device?: string): ListingTarget {
|
||||
const label = listingLabel(target.label), shown = device ? listingDevice(device) : "";
|
||||
return { target: target.id, platform: target.platform, ...(label ? { label } : {}), path, ...(changes === undefined ? {} : { changes }), ...(shown ? { device: shown } : {}) };
|
||||
return { target: target.id, platform: target.platform, ...(label ? { label } : {}), ...(changes === undefined ? {} : { changes }), ...(shown ? { device: shown } : {}) };
|
||||
}
|
||||
/** The entry with its manifest's path, where the Worker reads it from (`path` after `label`, as reports.json leaves it out). */
|
||||
function listedAt(entry: ListingTarget, path: string): PreviewListingEntry {
|
||||
const { changes, device, ...head } = entry;
|
||||
return { ...head, path, ...(changes === undefined ? {} : { changes }), ...(device === undefined ? {} : { device }) };
|
||||
}
|
||||
/** Where a deployment serves a target's manifest. */
|
||||
export function manifestPath(token: string, file: string): string {
|
||||
return `/p/${token}/targets/${file}.json`;
|
||||
}
|
||||
|
||||
/** The worker's EXPLORE_PREVIEW_REPORTS entries, in the order the workflow lists targets; also what reports.json must echo. */
|
||||
export function previewReportListing(reports: ReadonlyArray<Pick<SealedReport, "input" | "file"> & { target: RunTarget }>, reportDirectory: string): PreviewListingEntry[] {
|
||||
return reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, reviewChangeCount(report.input.commentState), reviewDevice(report.input.commentState)));
|
||||
/** The worker's EXPLORE_PREVIEW_REPORTS entries without their paths, in the order the workflow lists targets. */
|
||||
export function previewReportListing(reports: ReadonlyArray<Pick<DeployedReport, "input"> & { target: RunTarget }>): ListingTarget[] {
|
||||
return reports.map(report => listingEntry(report.target, reviewChangeCount(report.input.commentState), reviewDevice(report.input.commentState)));
|
||||
}
|
||||
|
||||
export async function deployPreview(options: PreviewDeployOptions): Promise<PreviewDeployResult> {
|
||||
@@ -325,6 +341,8 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
const first = inputs[0]!.input; const review = first.publicReview; const pr = review.pullRequest;
|
||||
if (!first.preview) throw new CiError({ code: "PREVIEW_NOT_CONFIGURED", stage: "preflight",
|
||||
message: "This review did not request a hosted preview", nextAction: "Set report.preview.hosting: eas in .expo-explore/config.yaml, or remove the deploy job." });
|
||||
// `expiresAfterDays` is what a capture from before Explore stopped setting an expiry recorded.
|
||||
if (first.preview.expiresAfterIgnored || "expiresAfterDays" in first.preview) warnIgnoredExpiry("report.preview.expiresAfter", environment);
|
||||
if (!environment.EXPO_TOKEN?.trim()) throw new CiError({ code: "EXPO_TOKEN_MISSING", stage: "preflight",
|
||||
message: "EXPO_TOKEN is required to deploy a hosted preview", nextAction: "Pass the EXPO_TOKEN secret to the deploy job; it must be able to create projects in the app's Expo account." });
|
||||
if (!environment.GITHUB_TOKEN?.trim()) throw new CiError({ code: "GITHUB_TOKEN_MISSING", stage: "preflight",
|
||||
@@ -340,27 +358,25 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
|
||||
await assertExport(exportPath);
|
||||
|
||||
const reports: SealedReport[] = [];
|
||||
const reports: DeployedReport[] = [];
|
||||
for (const { entry, input, target } of inputs) {
|
||||
let zip: Uint8Array;
|
||||
try { zip = await zipReportDirectory(entry.reportPath); }
|
||||
catch (error) { throw toCiError(error, { code: "REPORT_ZIP_FAILED", stage: "export",
|
||||
nextAction: "Pass the ci:report output directory downloaded from this run's explore-review artifact." }); }
|
||||
reports.push({ entry, input, ...(target ? { target } : {}), zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi && target ? `${target.id}.zip.enc` : "report.zip.enc" });
|
||||
reports.push({ entry, input, ...(target ? { target } : {}), zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi && target ? target.id : "report" });
|
||||
}
|
||||
|
||||
const reportDirectory = base32(random(10));
|
||||
const expiresAt = first.preview.expiresAfterDays === null ? null : now() + first.preview.expiresAfterDays * 86_400_000;
|
||||
const project = previewProjectSlug(pr.repository, first.preview.project);
|
||||
const listing = multi ? previewReportListing(reports.map(report => ({ ...report, target: report.target! })), reportDirectory) : undefined;
|
||||
let hosted: Awaited<ReturnType<typeof deploySealedReports>>;
|
||||
const listing = multi ? previewReportListing(reports.map(report => ({ ...report, target: report.target! }))) : undefined;
|
||||
let hosted: Awaited<ReturnType<typeof deployReports>>;
|
||||
try {
|
||||
hosted = await deploySealedReports({
|
||||
hosted = await deployReports({
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: multi && report.target ? targetQuery(report.target) : "" })),
|
||||
reportDirectory, ...(listing ? { listing } : {}), project, ...(first.preview.owner ? { owner: first.preview.owner } : {}),
|
||||
...(listing ? { listing } : {}), project, ...(first.preview.owner ? { owner: first.preview.owner } : {}),
|
||||
ownerHint: "Set report.preview.owner in .expo-explore/config.yaml to the account that should hold the preview project.",
|
||||
projectHint: "Give EXPO_TOKEN's account permission to create projects, or set report.preview.project to an existing project it can deploy to.",
|
||||
expiresAt, exportPath, environment, run, transport, now, random, ...(options.sleep ? { sleep: options.sleep } : {}),
|
||||
exportPath, environment, run, transport, now, random, ...(options.sleep ? { sleep: options.sleep } : {}),
|
||||
// The runner masks secrets in job summaries too, so a masked token would reach a comparison's summary as ***.
|
||||
// Its link appears nowhere else (not in the log), as a PR's appears only in its comment, for the same readers.
|
||||
...(options.onSecret && pr.origin !== "compare" ? { onSecret: options.onSecret } : {}),
|
||||
@@ -377,15 +393,15 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
}
|
||||
const previewUrl = hosted.previewUrl;
|
||||
// A comparison has no pull request: its link goes to the run's summary, which the same repository readers see.
|
||||
if (pr.origin === "compare") await writeCompareSummary(environment, pr, previewUrl, expiresAt, reports.map(report => report.input));
|
||||
if (pr.origin === "compare") await writeCompareSummary(environment, pr, previewUrl, reports.map(report => report.input));
|
||||
{
|
||||
let headSha = pr.head.sha;
|
||||
if (pr.origin !== "compare") for (const report of reports) {
|
||||
const published = await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
|
||||
...commentTarget(report), preview: { url: previewUrl, expiresAt } });
|
||||
...commentTarget(report), preview: { url: previewUrl, expiresAt: null } });
|
||||
headSha = published.headSha;
|
||||
}
|
||||
return { previewUrl, expiresAt: expiresAt === null ? null : new Date(expiresAt).toISOString(), deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
|
||||
return { previewUrl, expiresAt: null, deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
|
||||
project, owner: hosted.owner, reportSha256: reports[0]!.sha256, reportBytes: reports[0]!.zip.byteLength,
|
||||
reports: reports.map(report => ({ ...(report.entry.platform ? { platform: report.entry.platform } : {}), ...(report.target ? { target: report.target } : {}), artifactUrl: report.entry.artifactUrl,
|
||||
reportSha256: report.sha256, reportBytes: report.zip.byteLength })), headSha,
|
||||
@@ -394,13 +410,13 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
}
|
||||
|
||||
/** Which comment section and artifact a report is: its target, or (single-report runs) none. */
|
||||
function commentTarget(report: SealedReport): { target?: string; platform?: ExplorePlatform } {
|
||||
function commentTarget(report: DeployedReport): { target?: string; platform?: ExplorePlatform } {
|
||||
if (report.target) return { target: report.target.id, platform: report.target.platform };
|
||||
return report.entry.platform ? { platform: report.entry.platform } : {};
|
||||
}
|
||||
|
||||
/** The comparison's job summary: what was compared, the hosted link, and each target's change count. */
|
||||
export function renderCompareSummary(comparison: CompareReviewPresentation, previewUrl: string, expiresAt: number | null, inputs: CiReportInput[]): string {
|
||||
export function renderCompareSummary(comparison: CompareReviewPresentation, previewUrl: string, inputs: CiReportInput[]): string {
|
||||
const platforms = inputs.map(input => {
|
||||
const changes = reviewChangeCount(input.commentState);
|
||||
const device = reviewDevice(input.commentState);
|
||||
@@ -408,15 +424,14 @@ export function renderCompareSummary(comparison: CompareReviewPresentation, prev
|
||||
return `- ${label}${device ? ` (${device})` : ""}: ${changes === undefined ? "no review" : `${changes} ${changes === 1 ? "change" : "changes"}`}`;
|
||||
});
|
||||
return [`### Explore: ${compareTitleMarkdown(comparison)}`, "",
|
||||
`[Open the report](${previewUrl}) · [${comparison.base.sha.slice(0, 8)}..${comparison.head.sha.slice(0, 8)}](${comparison.url})`
|
||||
+ (expiresAt === null ? "" : ` · link expires ${new Date(expiresAt).toISOString().slice(0, 10)}`), "",
|
||||
`[Open the report](${previewUrl}) · [${comparison.base.sha.slice(0, 8)}..${comparison.head.sha.slice(0, 8)}](${comparison.url})`, "",
|
||||
...platforms, ""].join("\n");
|
||||
}
|
||||
|
||||
async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: CompareReviewPresentation, previewUrl: string, expiresAt: number | null, inputs: CiReportInput[]) {
|
||||
async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: CompareReviewPresentation, previewUrl: string, inputs: CiReportInput[]) {
|
||||
const path = environment.GITHUB_STEP_SUMMARY;
|
||||
if (!path) return;
|
||||
await appendFile(path, renderCompareSummary(comparison, previewUrl, expiresAt, inputs));
|
||||
await appendFile(path, renderCompareSummary(comparison, previewUrl, inputs));
|
||||
}
|
||||
|
||||
type HostedReportInput = { zip: Uint8Array; sha256: string; file: string; query: string };
|
||||
@@ -428,12 +443,53 @@ export const HOSTING_ALIAS = /^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$/;
|
||||
export const HOSTED_TOKEN = /^[a-z2-7]{32}$/;
|
||||
|
||||
/**
|
||||
* Seal the report ZIPs, deploy the exported Viewer around them to EAS Hosting, and verify the live bytes.
|
||||
* Shared by the PR preview (`ci:deploy`) and standalone exploration reports; it knows nothing about GitHub.
|
||||
* Each report's manifest at `p/<token>/targets/<file>.json` and every asset once at `p/<token>/assets/<sha256>.<ext>`
|
||||
* (targets that share a screenshot share its file), under the export's client directory. Every asset's bytes must hash
|
||||
* to its name. `deployment` stamps every manifest, so a check can tell this deployment from one an alias still serves.
|
||||
* Returns, per report, the manifest written and one asset to fetch back.
|
||||
*/
|
||||
async function deploySealedReports(options: {
|
||||
reports: HostedReportInput[]; reportDirectory: string; listing?: ReturnType<typeof previewReportListing>; project: string; owner?: string;
|
||||
ownerHint: string; projectHint: string; expiresAt: number | null; exportPath: string; environment: NodeJS.ProcessEnv; run: typeof defaultRun;
|
||||
async function writeReportFiles(client: string, token: string, reports: HostedReportInput[], deployment: string): Promise<Array<{ manifest: string; asset?: string }>> {
|
||||
await writeFile(join(client, "robots.txt"), PREVIEW_ROBOTS);
|
||||
const root = join(client, "p", token);
|
||||
await mkdir(join(root, "targets"), { recursive: true });
|
||||
await mkdir(join(root, "assets"), { recursive: true });
|
||||
// Each asset's size as written: a target that shares the file must list the same size in its manifest.
|
||||
const assets = new Map<string, number>();
|
||||
const written: Array<{ manifest: string; asset?: string }> = [];
|
||||
for (const report of reports) {
|
||||
const loaded = await loadReport(report.zip);
|
||||
if (!loaded) throw deployError("REPORT_ZIP_FAILED", "The report ZIP is not a report the hosted Viewer can open.", "Pass the report directory or ZIP that Explore wrote.");
|
||||
const manifest = manifestBody(loaded, deployment);
|
||||
await writeFile(join(root, "targets", `${report.file}.json`), manifest);
|
||||
let first: string | undefined;
|
||||
for (const [name, entry] of loaded.entries) {
|
||||
const sha = PREVIEW_ASSET.exec(name)?.[1];
|
||||
if (!sha) continue;
|
||||
first ??= name;
|
||||
const bad = () => deployError("REPORT_ZIP_FAILED", `The report's ${name} is unreadable, larger than ${MAX_ASSET_BYTES / 1024 / 1024} MiB, or does not match its name.`,
|
||||
"Capture the report again; its screenshots are named by their SHA-256.");
|
||||
if (assets.has(name)) {
|
||||
if (assets.get(name) !== entry.size) throw bad();
|
||||
continue;
|
||||
}
|
||||
const bytes = await loaded.read(name, MAX_ASSET_BYTES);
|
||||
if (!bytes || bytes.byteLength !== entry.size || createHash("sha256").update(bytes).digest("hex") !== sha) throw bad();
|
||||
await writeFile(join(root, name), bytes);
|
||||
assets.set(name, bytes.byteLength);
|
||||
}
|
||||
written.push({ manifest, ...(first ? { asset: first } : {}) });
|
||||
}
|
||||
return written;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write the report ZIPs as static files under the token, deploy the exported Viewer around them to EAS Hosting, and
|
||||
* verify what the Viewer opens. Shared by the PR preview (`ci:deploy`) and standalone reports; it knows nothing about GitHub.
|
||||
*/
|
||||
async function deployReports(options: {
|
||||
/** With `listing`, one entry per report in the same order. */
|
||||
reports: HostedReportInput[]; listing?: ListingTarget[]; project: string; owner?: string;
|
||||
ownerHint: string; projectHint: string; exportPath: string; environment: NodeJS.ProcessEnv; run: typeof defaultRun;
|
||||
transport: typeof fetch; now: () => number; random: (bytes: number) => Uint8Array; onSecret?: (secret: string) => void; verifyTimeoutMs: number;
|
||||
/** `eas deploy --alias`: a fixed host that always serves the newest deployment, for links that must not change between runs. */
|
||||
alias?: string;
|
||||
@@ -441,11 +497,12 @@ async function deploySealedReports(options: {
|
||||
token?: string;
|
||||
sleep?: (milliseconds: number) => Promise<void>;
|
||||
}): Promise<HostedDeployment> {
|
||||
const { reports, reportDirectory, listing, project, environment, run, transport, now, random, expiresAt } = options;
|
||||
const token = options.token ?? base32(random(20)); const key = random(32);
|
||||
const { reports, project, environment, run, transport, now, random } = options;
|
||||
const token = options.token ?? base32(random(20));
|
||||
options.onSecret?.(token);
|
||||
// `eas deploy` reads the sealed .env through @expo/env, where any variable already in its own environment wins,
|
||||
// even an empty one: an inherited EXPLORE_PREVIEW_* would replace the sealed value and every route would 404.
|
||||
const listing = options.listing?.map((entry, index) => listedAt(entry, manifestPath(token, reports[index]!.file)));
|
||||
// `eas deploy` reads the deployment's .env through @expo/env, where any variable already in its own environment wins,
|
||||
// even an empty one: an inherited EXPLORE_PREVIEW_* would replace the deployment's value and every route would 404.
|
||||
const easEnvironment = { ...Object.fromEntries(Object.entries(environment).filter(([name]) => !name.startsWith("EXPLORE_PREVIEW_"))),
|
||||
CI: "1", EXPO_NO_TELEMETRY: "1" };
|
||||
// Run the pinned CLI through this Node binary: the deploy job has no node on PATH for spawned shebang scripts to rely on.
|
||||
@@ -455,14 +512,10 @@ async function deploySealedReports(options: {
|
||||
const work = await mkdtemp(join(tmpdir(), "explore-preview-"));
|
||||
try {
|
||||
await cp(options.exportPath, join(work, "dist"), { recursive: true });
|
||||
const sealedDirectory = join(work, "dist", "client", "_report", reportDirectory);
|
||||
await mkdir(sealedDirectory, { recursive: true });
|
||||
for (const report of reports) await writeFile(join(sealedDirectory, report.file), sealReport(report.zip, key, random(12)));
|
||||
const written = await writeReportFiles(join(work, "dist", "client"), token, reports, base32(random(10)));
|
||||
await writeFile(join(work, ".env"), [
|
||||
`EXPLORE_PREVIEW_TOKEN=${token}`,
|
||||
`EXPLORE_PREVIEW_KEY=${Buffer.from(key).toString("base64")}`,
|
||||
...(expiresAt === null ? [] : [`EXPLORE_PREVIEW_EXPIRES_AT=${new Date(expiresAt).toISOString()}`]),
|
||||
listing ? `EXPLORE_PREVIEW_REPORTS=${JSON.stringify(listing)}` : `EXPLORE_PREVIEW_REPORT=/_report/${reportDirectory}/${reports[0]!.file}`,
|
||||
listing ? `EXPLORE_PREVIEW_REPORTS=${JSON.stringify(listing)}` : `EXPLORE_PREVIEW_REPORT=${manifestPath(token, reports[0]!.file)}`,
|
||||
"",
|
||||
].join("\n"), { mode: 0o600 });
|
||||
|
||||
@@ -503,15 +556,15 @@ async function deploySealedReports(options: {
|
||||
if (aliasLimit) {
|
||||
throw deployError("PREVIEW_ALIAS_LIMIT", `EAS Hosting could not assign the alias ${options.alias}: ${aliasLimit[0]}`,
|
||||
`Delete the aliases of closed pull requests on @${owner}/${project} (eas deploy:alias:delete pr-<n> --non-interactive) or raise the account's plan, then rerun the deploy job.`,
|
||||
{ retryable: false, details: { project, owner, alias: options.alias, output: commandOutput(deploy, environment.EXPO_TOKEN) } });
|
||||
{ retryable: false, details: { project, owner, alias: options.alias, output: commandOutput(deploy, [environment.EXPO_TOKEN, token]) } });
|
||||
}
|
||||
process.stderr.write(`eas deploy attempt ${attempt} of ${DEPLOY_ATTEMPTS} failed (exit ${deploy.status}):\n${commandOutput(deploy, environment.EXPO_TOKEN)}\n`);
|
||||
process.stderr.write(`eas deploy attempt ${attempt} of ${DEPLOY_ATTEMPTS} failed (exit ${deploy.status}):\n${commandOutput(deploy, [environment.EXPO_TOKEN, token])}\n`);
|
||||
if (attempt < DEPLOY_ATTEMPTS) await sleep(DEPLOY_RETRY_DELAYS_MS[attempt - 1] ?? DEPLOY_RETRY_DELAYS_MS.at(-1)!);
|
||||
}
|
||||
if (!deploymentUrl) {
|
||||
throw deployError("PREVIEW_DEPLOY_FAILED", `EAS Hosting deployment failed ${DEPLOY_ATTEMPTS} times: ${lastLine(deploy.stderr || deploy.stdout)}`,
|
||||
"Check the EAS Hosting status for the preview project and rerun the deploy job; the eas output of every attempt is in the job log.",
|
||||
{ retryable: true, details: { project, owner, attempts: DEPLOY_ATTEMPTS, output: commandOutput(deploy, environment.EXPO_TOKEN) } });
|
||||
{ retryable: true, details: { project, owner, attempts: DEPLOY_ATTEMPTS, output: commandOutput(deploy, [environment.EXPO_TOKEN, token]) } });
|
||||
}
|
||||
const aliasUrl = options.alias ? hostedOrigin(deployment.aliases?.find(candidate => candidate.name === options.alias)?.url) : undefined;
|
||||
if (options.alias && !aliasUrl) {
|
||||
@@ -519,7 +572,7 @@ async function deploySealedReports(options: {
|
||||
"Check the deployment's aliases in the EAS Hosting dashboard and rerun.", { retryable: true, details: { project, owner, alias: options.alias } });
|
||||
}
|
||||
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, timeoutMs: options.verifyTimeoutMs, alias,
|
||||
reports: reports.map(report => ({ query: report.query, sha256: report.sha256, bytes: report.zip.byteLength })),
|
||||
reports: reports.map((report, index) => ({ query: report.query, ...written[index]! })),
|
||||
...(listing ? { listing: JSON.stringify(listing.map(({ path: _path, ...rest }) => rest)) } : {}) });
|
||||
const seconds = (milliseconds: number) => `${Math.round(milliseconds / 1000)} s after eas deploy returned`;
|
||||
const served = await verify(deploymentUrl.origin);
|
||||
@@ -540,7 +593,7 @@ async function deploySealedReports(options: {
|
||||
}
|
||||
}
|
||||
const previewUrl = `${linkOrigin}/p/${token}`;
|
||||
return { previewUrl, expiresAt: expiresAt === null ? null : new Date(expiresAt).toISOString(), deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
|
||||
return { previewUrl, expiresAt: null, deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
|
||||
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), project, owner };
|
||||
} finally {
|
||||
await rm(work, { recursive: true, force: true });
|
||||
@@ -555,7 +608,6 @@ export type ExplorationDeployOptions = {
|
||||
project: string;
|
||||
owner?: string;
|
||||
/** Days until the hosted link stops serving the report; null never expires. */
|
||||
expiresAfterDays: number | null;
|
||||
exportPath?: string;
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
run?: typeof defaultRun;
|
||||
@@ -587,21 +639,20 @@ export async function deployExplorationReport(options: ExplorationDeployOptions)
|
||||
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
|
||||
const now = options.now ?? Date.now;
|
||||
const sha256 = createHash("sha256").update(zip).digest("hex");
|
||||
const reportDirectory = base32(random(10));
|
||||
const target = options.platform ? platformTarget(options.platform) : undefined;
|
||||
const file = target ? `${target.id}.zip.enc` : "report.zip.enc";
|
||||
const hosted = await deploySealedReports({ reports: [{ zip, sha256, file, query: target ? targetQuery(target) : "" }], reportDirectory,
|
||||
...(target ? { listing: [listingEntry(target, `/_report/${reportDirectory}/${file}`)] } : {}), project: options.project,
|
||||
const file = target ? target.id : "report";
|
||||
const hosted = await deployReports({ reports: [{ zip, sha256, file, query: target ? targetQuery(target) : "" }],
|
||||
...(target ? { listing: [listingEntry(target)] } : {}), project: options.project,
|
||||
...(options.owner ? { owner: options.owner } : {}), ownerHint: "Pass --owner with the Expo account that should host the report.",
|
||||
projectHint: "Give this EAS login permission to create projects under the owner, or pass --project with an existing slug.",
|
||||
expiresAt: options.expiresAfterDays === null ? null : now() + options.expiresAfterDays * 86_400_000, exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}),
|
||||
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}),
|
||||
transport: options.transport ?? fetch, now, random, ...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000,
|
||||
...(options.alias ? { alias: options.alias } : {}), ...(options.token ? { token: options.token } : {}) });
|
||||
return { ...hosted, reportSha256: sha256, reportBytes: zip.byteLength };
|
||||
}
|
||||
|
||||
export type FixturePreviewOptions = {
|
||||
/** Report ZIPs as a hosted preview serves them from report.zip, one per target (`platform` alone: the platform's target), with what the switch says of each. */
|
||||
/** Report ZIPs as Explore writes them, one per target (`platform` alone: the platform's target), with what the switch says of each. */
|
||||
reports: Array<{ platform: ExplorePlatform; target?: RunTarget; zipPath: string; changes?: number; device?: string }>;
|
||||
project: string;
|
||||
owner?: string;
|
||||
@@ -633,23 +684,44 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
|
||||
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
|
||||
await assertExport(exportPath);
|
||||
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
|
||||
const reportDirectory = base32(random(10));
|
||||
const reports = await Promise.all(options.reports.map(async report => {
|
||||
const zip = new Uint8Array(await readFile(report.zipPath));
|
||||
const target = report.target ?? platformTarget(report.platform);
|
||||
return { ...report, target, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: `${target.id}.zip.enc` };
|
||||
return { ...report, target, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: target.id };
|
||||
}));
|
||||
const listing = reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, report.changes, report.device));
|
||||
return deploySealedReports({
|
||||
const listing = reports.map(report => listingEntry(report.target, report.changes, report.device));
|
||||
return deployReports({
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: targetQuery(report.target) })),
|
||||
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
|
||||
listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
|
||||
ownerHint: "Pass --owner with the Expo account that holds the preview project.",
|
||||
projectHint: "Give EXPO_TOKEN's account permission to create projects, or pass --project with an existing slug.",
|
||||
expiresAt: null, exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
|
||||
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
|
||||
...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000, alias: options.alias,
|
||||
...(options.token ? { token: options.token } : {}) });
|
||||
}
|
||||
|
||||
/**
|
||||
* The reports a fixture directory holds (scripts/refresh-viewer-preview-fixtures.sh writes it): its reports.json, as a
|
||||
* hosted preview's /reports.json lists them, with `<target>.zip` beside it for each entry. An entry without a target,
|
||||
* from fixtures refreshed before targets, is its platform's target with `<platform>.zip`.
|
||||
*/
|
||||
export function fixtureReports(listing: unknown, directory: string): FixturePreviewOptions["reports"] {
|
||||
const invalid = () => previewError("PREVIEW_REPORTS_INVALID", "The fixtures' reports.json does not list valid reports",
|
||||
"Refresh the fixtures with scripts/refresh-viewer-preview-fixtures.sh.");
|
||||
if (!Array.isArray(listing)) throw invalid();
|
||||
return listing.map((entry: unknown) => {
|
||||
if (typeof entry !== "object" || entry === null) throw invalid();
|
||||
const { platform, target: id, label, changes, device } = entry as Record<string, unknown>;
|
||||
if (platform !== "ios" && platform !== "android") throw invalid();
|
||||
const target = id === undefined ? undefined : readTarget({ id, platform, label });
|
||||
if (id !== undefined && !target) throw invalid();
|
||||
return {
|
||||
platform, ...(target ? { target } : {}), zipPath: join(directory, `${target?.id ?? platform}.zip`),
|
||||
...(typeof changes === "number" ? { changes } : {}), ...(typeof device === "string" ? { device } : {}),
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Report ZIPs on this machine behind one token (`capture:review --upload`, `report:upload`), one per target: the same
|
||||
* sealed deployment as a PR preview, from ZIPs instead of GitHub artifacts, with the local EAS login or EXPO_TOKEN.
|
||||
@@ -657,7 +729,7 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
|
||||
export async function deployLocalReports(options: {
|
||||
/** One per target; an entry without `target` is its platform's target, as before targets. */
|
||||
reports: Array<{ platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string }>;
|
||||
project: string; owner?: string; expiresAfterDays: number | null;
|
||||
project: string; owner?: string;
|
||||
/** What to change when the owner or project is not usable; defaults name report.preview in config.yaml. */
|
||||
ownerHint?: string; projectHint?: string;
|
||||
exportPath?: string; environment?: NodeJS.ProcessEnv; run?: CommandRunner; sleep?: (milliseconds: number) => Promise<void>;
|
||||
@@ -669,19 +741,18 @@ export async function deployLocalReports(options: {
|
||||
await assertExport(exportPath);
|
||||
const now = options.now ?? Date.now;
|
||||
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
|
||||
const reportDirectory = base32(random(10));
|
||||
// Always listed, even alone: the Worker takes an unlisted report for iOS, so an Android one would be mislabelled.
|
||||
const reports = options.reports.map(report => {
|
||||
const target = report.target ?? platformTarget(report.platform);
|
||||
return { ...report, target, sha256: createHash("sha256").update(report.zip).digest("hex"), file: `${target.id}.zip.enc` };
|
||||
return { ...report, target, sha256: createHash("sha256").update(report.zip).digest("hex"), file: target.id };
|
||||
});
|
||||
const listing = reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, report.changes, report.device));
|
||||
return deploySealedReports({
|
||||
const listing = reports.map(report => listingEntry(report.target, report.changes, report.device));
|
||||
return deployReports({
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: targetQuery(report.target) })),
|
||||
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
|
||||
listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
|
||||
ownerHint: options.ownerHint ?? "Set report.preview.owner in .expo-explore/config.yaml to the account that should hold the hosted reports.",
|
||||
projectHint: options.projectHint ?? "Make sure your Expo account can create projects, or set report.preview.project to an existing project you can deploy to.",
|
||||
expiresAt: options.expiresAfterDays === null ? null : now() + options.expiresAfterDays * 86_400_000, exportPath, environment,
|
||||
exportPath, environment,
|
||||
run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now, random,
|
||||
verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000 });
|
||||
}
|
||||
@@ -755,7 +826,7 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
|
||||
}
|
||||
|
||||
/** The deployment must serve the Viewer and the exact reports at the token, and nothing anywhere else. */
|
||||
async function verifyDeployment(check: { origin: string; token: string; reports: Array<{ query: string; sha256: string; bytes: number }>; listing?: string;
|
||||
async function verifyDeployment(check: { origin: string; token: string; reports: Array<{ query: string; manifest: string; asset?: string }>; listing?: string;
|
||||
transport: typeof fetch; now: () => number; timeoutMs: number; alias?: boolean }): Promise<{ liveAfterMs: number }> {
|
||||
const get = async (path: string, accept = "*/*") => {
|
||||
try {
|
||||
@@ -768,22 +839,15 @@ async function verifyDeployment(check: { origin: string; token: string; reports:
|
||||
};
|
||||
// What the token serves differs from what was deployed: a listing or report that does not match, or undefined.
|
||||
const mismatch = async (): Promise<CiError | undefined> => {
|
||||
// What the Viewer opens: each target's manifest, exactly as written (its deployment stamp tells this deployment from
|
||||
// the one an alias still points at, even for an unchanged report), and one of its screenshots, a static file.
|
||||
for (const expected of check.reports) {
|
||||
const report = await get(`/p/${check.token}/report.zip${expected.query}`);
|
||||
const bytes = report.status === 200 ? new Uint8Array(await report.arrayBuffer()) : new Uint8Array();
|
||||
if (report.status !== 200 || bytes.byteLength !== expected.bytes || createHash("sha256").update(bytes).digest("hex") !== expected.sha256) {
|
||||
return deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not serve the exact report that was deployed.",
|
||||
"Rerun the deploy job; the deployment's sealed key or ciphertext did not match.", { details: { status: report.status, report: expected.query } });
|
||||
}
|
||||
// What the Viewer opens: the manifest the deployed ZIP makes, and one of its assets byte for byte.
|
||||
const loaded = await loadReport(bytes);
|
||||
const manifest = await get(`/p/${check.token}/manifest.json${expected.query}`);
|
||||
const body = manifest.status === 200 ? await manifest.text() : "";
|
||||
const asset = loaded ? Object.keys(JSON.parse(manifestBody(loaded)).entries as Record<string, number>)[0] : undefined;
|
||||
const served = asset ? await get(`/p/${check.token}/${asset}${expected.query}`) : undefined;
|
||||
const served = expected.asset ? await get(`/p/${check.token}/${expected.asset}`) : undefined;
|
||||
const assetBytes = served?.status === 200 ? new Uint8Array(await served.arrayBuffer()) : new Uint8Array();
|
||||
if (!loaded || body !== manifestBody(loaded)
|
||||
|| (asset && createHash("sha256").update(assetBytes).digest("hex") !== asset.slice("assets/".length, "assets/".length + 64))) {
|
||||
const sha = expected.asset ? PREVIEW_ASSET.exec(expected.asset)?.[1] : undefined;
|
||||
if (body !== expected.manifest || (sha && createHash("sha256").update(assetBytes).digest("hex") !== sha)) {
|
||||
return deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not serve the report's manifest and screenshots, which the Viewer opens.",
|
||||
"Rerun the deploy job; if it keeps failing, inspect the deployment in the EAS Hosting dashboard.",
|
||||
{ details: { status: manifest.status, ...(served ? { assetStatus: served.status } : {}), report: expected.query } });
|
||||
@@ -823,11 +887,16 @@ async function verifyDeployment(check: { origin: string; token: string; reports:
|
||||
if (api.status !== 200 || !(api.headers.get("content-type") ?? "").startsWith("application/json")) {
|
||||
throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview did not answer the agent API (HTTP ${api.status}).`, "Rerun the deploy job; if the deployment keeps failing verification, inspect it in the EAS Hosting dashboard.", { retryable: true });
|
||||
}
|
||||
const robots = await get("/robots.txt");
|
||||
if (robots.status !== 200 || await robots.text() !== PREVIEW_ROBOTS) {
|
||||
throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview did not serve its robots.txt (HTTP ${robots.status}), which keeps crawlers away from the screenshots.`,
|
||||
"Rerun the deploy job; if it keeps failing, inspect the deployment in the EAS Hosting dashboard.", { retryable: true });
|
||||
}
|
||||
// The deployment itself serves exactly what was deployed or it failed; the alias was checked while it was polled.
|
||||
if (!check.alias) { const failure = await mismatch(); if (failure) throw failure; }
|
||||
const other = check.token.endsWith("a") ? `${check.token.slice(0, -1)}b` : `${check.token.slice(0, -1)}a`;
|
||||
// Errors name each probe by its shape: the near-miss token differs from the real one in its last character only.
|
||||
for (const [path, shape] of [["/", "/"], [`/p/${other}`, "/p/<wrong token>"], [`/p/${other}/report.zip`, "/p/<wrong token>/report.zip"],
|
||||
for (const [path, shape] of [["/", "/"], [`/p/${other}`, "/p/<wrong token>"], [`/p/${other}/manifest.json`, "/p/<wrong token>/manifest.json"],
|
||||
[`/p/${check.token}/viewer/index.html`, "/p/<token>/viewer/index.html"]] as const) {
|
||||
const response = await get(path);
|
||||
if (response.status !== 404) throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview answered HTTP ${response.status} without a valid token at ${shape}.`,
|
||||
|
||||
@@ -1,30 +1,75 @@
|
||||
/**
|
||||
* What a hosted or local report page serves the Viewer instead of the whole ZIP: the manifest (the report's metadata
|
||||
* file verbatim plus every asset's size) and each asset on request. The preview Worker, the local report server and
|
||||
* the deploy check share these, so all three agree byte for byte.
|
||||
* file verbatim plus every asset's size) and each asset on request. `ci:deploy` writes them as a hosted preview's
|
||||
* static files, the local report server answers them from the ZIP, and the preview Worker reads the manifest back.
|
||||
*/
|
||||
import type { LoadedReport } from "./agent-api.js";
|
||||
import { readZipEntry } from "./zip-reader.js";
|
||||
import { reportFromJson, type LoadedReport } from "./agent-api.js";
|
||||
|
||||
/** The manifest format the Viewer accepts (viewer/src/utils/artifact-report.ts). */
|
||||
export const PREVIEW_MANIFEST_FORMAT = "explore.preview-manifest/1";
|
||||
/** `assets/<sha256>.<ext>`, the only asset names a report page serves. */
|
||||
export const PREVIEW_ASSET = /^assets\/([a-f0-9]{64})\.(png|jpg|mp4)$/;
|
||||
const ASSET_TYPES: Record<string, string> = { png: "image/png", jpg: "image/jpeg", mp4: "video/mp4" };
|
||||
const MAX_ASSET_BYTES = 32 * 1024 * 1024;
|
||||
export const ASSET_TYPES: Record<string, string> = { png: "image/png", jpg: "image/jpeg", mp4: "video/mp4" };
|
||||
export const MAX_ASSET_BYTES = 32 * 1024 * 1024;
|
||||
|
||||
/** The metadata file verbatim plus the size of every asset, so the Viewer opens the report before any screenshot. Directory records are not assets. */
|
||||
export function manifestBody(loaded: LoadedReport): string {
|
||||
/**
|
||||
* The metadata file verbatim plus the size of every asset, so the Viewer opens the report before any screenshot.
|
||||
* Directory records are not assets. `deployment` names the hosted deployment that wrote it, so a check can tell a new
|
||||
* deployment of an unchanged report from the one an alias still points at.
|
||||
*/
|
||||
export function manifestBody(loaded: LoadedReport, deployment?: string): string {
|
||||
const entries: Record<string, number> = {};
|
||||
for (const [name, entry] of loaded.entries) if (name.startsWith("assets/") && !name.endsWith("/")) entries[name] = entry.size;
|
||||
return `{"format":"${PREVIEW_MANIFEST_FORMAT}","file":"${loaded.file}","entries":${JSON.stringify(entries)},"report":${new TextDecoder().decode(loaded.raw)}}`;
|
||||
const stamp = deployment ? `"deployment":${JSON.stringify(deployment)},` : "";
|
||||
return `{"format":"${PREVIEW_MANIFEST_FORMAT}",${stamp}"file":"${loaded.file}","entries":${JSON.stringify(entries)},"report":${new TextDecoder().decode(loaded.raw)}}`;
|
||||
}
|
||||
|
||||
/** One asset of the report, inflated from the decrypted ZIP, with its content type; undefined when the report has no such asset. */
|
||||
/** The largest metadata file the Viewer opens (`ARTIFACT_LIMITS.metadata` in viewer/src/utils/artifact-report.ts). */
|
||||
export const MAX_PREVIEW_METADATA_BYTES = 8 * 1024 * 1024;
|
||||
/** A manifest is the metadata file plus one size per asset; the Viewer refuses a larger one. */
|
||||
export const MAX_MANIFEST_BYTES = MAX_PREVIEW_METADATA_BYTES + 2 * 1024 * 1024;
|
||||
const REPORT_KEY = ',"report":';
|
||||
|
||||
/**
|
||||
* The report a manifest describes, reading its assets through `readAsset`; undefined when it is not a manifest of a report.
|
||||
* The metadata is parsed once and kept as the manifest's own bytes. `manifestBody` writes `report` last, so its bytes are
|
||||
* the text between `,"report":` and the closing brace; any other layout is parsed whole and re-serialized.
|
||||
*/
|
||||
export function reportFromManifest(bytes: Uint8Array, readAsset: LoadedReport["read"]): LoadedReport | undefined {
|
||||
if (bytes.byteLength > MAX_MANIFEST_BYTES) return undefined;
|
||||
const text = new TextDecoder().decode(bytes);
|
||||
let header: unknown, report: unknown, raw: Uint8Array | undefined;
|
||||
const at = text.indexOf(REPORT_KEY);
|
||||
// A string cannot hold `,"report":` (its quotes are escaped); a nested key can, and then the header before it is not JSON on its own.
|
||||
if (at !== -1 && text.endsWith("}") && /^[\x20-\x7e]*$/.test(text.slice(0, at))) {
|
||||
try {
|
||||
header = JSON.parse(`${text.slice(0, at)}}`);
|
||||
report = JSON.parse(text.slice(at + REPORT_KEY.length, -1));
|
||||
raw = bytes.subarray(at + REPORT_KEY.length, bytes.byteLength - 1);
|
||||
} catch { header = undefined; }
|
||||
}
|
||||
if (raw === undefined) {
|
||||
try { header = JSON.parse(text); } catch { return undefined; }
|
||||
report = (header as { report?: unknown } | null)?.report;
|
||||
raw = new TextEncoder().encode(JSON.stringify(report));
|
||||
}
|
||||
if (!header || typeof header !== "object") return undefined;
|
||||
const { format, file, entries } = header as { format?: unknown; file?: unknown; entries?: unknown };
|
||||
if (format !== PREVIEW_MANIFEST_FORMAT || (file !== "review.json" && file !== "exploration.json")) return undefined;
|
||||
if (!entries || typeof entries !== "object" || Array.isArray(entries) || !report || typeof report !== "object") return undefined;
|
||||
const sizes = new Map<string, { size: number }>();
|
||||
for (const [name, size] of Object.entries(entries)) {
|
||||
if (!PREVIEW_ASSET.test(name) || !Number.isSafeInteger(size) || (size as number) < 0) return undefined;
|
||||
sizes.set(name, { size: size as number });
|
||||
}
|
||||
if (raw.byteLength > MAX_PREVIEW_METADATA_BYTES) return undefined;
|
||||
return reportFromJson(file, raw, report, sizes, (name, limit) => (sizes.has(name) ? readAsset(name, limit) : Promise.resolve(undefined)));
|
||||
}
|
||||
|
||||
/** One asset of the report with its content type; undefined when the report has no such asset. */
|
||||
export async function previewAsset(loaded: LoadedReport, path: string): Promise<{ bytes: Uint8Array; type: string } | undefined> {
|
||||
const match = PREVIEW_ASSET.exec(path);
|
||||
const entry = match ? loaded.entries.get(path) : undefined;
|
||||
if (!match || !entry) return undefined;
|
||||
const bytes = await readZipEntry(loaded.zip, entry, MAX_ASSET_BYTES);
|
||||
if (!match || !loaded.entries.has(path)) return undefined;
|
||||
const bytes = await loaded.read(path, MAX_ASSET_BYTES);
|
||||
return bytes ? { bytes, type: ASSET_TYPES[match[2]!]! } : undefined;
|
||||
}
|
||||
@@ -15,7 +15,7 @@ export type ViewerDeepLinks = {
|
||||
surface: (surfaceId: string) => string;
|
||||
};
|
||||
|
||||
/** A hosted preview: the Viewer and its decrypted report served from one token-gated EAS Hosting deployment. */
|
||||
/** A hosted preview: the Viewer and its report served from one token-gated EAS Hosting deployment. */
|
||||
export type PreviewLinks = ViewerDeepLinks & {
|
||||
/** Epoch milliseconds after which the deployment's Worker stops serving the report; null when the link does not expire. */
|
||||
expiresAt: number | null;
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* Reads the sealed report archive once it is decrypted: a ZIP written by `zipReportDirectory`
|
||||
* Reads a report ZIP (deploy, the local report server, the agent API): a ZIP written by `zipReportDirectory`
|
||||
* (review.json or exploration.json deflated, assets/<sha256>.png stored). Only the central directory
|
||||
* is trusted for sizes and offsets, every offset is bounds-checked, and entries are inflated on demand.
|
||||
*/
|
||||
|
||||
@@ -4,7 +4,7 @@ import { createHash } from "node:crypto";
|
||||
import { lstat, readFile, realpath } from "node:fs/promises";
|
||||
import { isAbsolute, relative, resolve, sep } from "node:path";
|
||||
import { assertDecodedPng } from "../shared/png-evidence.js";
|
||||
import { assertAgentAcceptance, validateCapturePlan, type AppIconImage, type BundleLaunchCapture, type CaptureBundle, type CaptureOutcome, type CapturedImage, type LaunchFilmstrip, type LaunchFrame, type PublicLaunchSide, type PublicReview, homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
|
||||
import { assertAgentAcceptance, validateCapturePlan, type AppIconImage, type BundleLaunchCapture, type CaptureBundle, type CaptureOutcome, type CapturedImage, type LaunchFilmstrip, type LaunchFrame, type PublicLaunchSide, type PublicReview, homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent, systemRegions, type SystemRegion } from "../contracts/capture.js";
|
||||
import { COLOR_SCHEMES } from "../capture/appearance.js";
|
||||
import { launchDirectory } from "../capture/launch-capture.js";
|
||||
import { APP_ICON_FILE, APP_ICON_MAX_SIZE } from "../capture/app-icon.js";
|
||||
@@ -263,11 +263,17 @@ export type CaptureReviewOptions = {
|
||||
/** The target this report captures, and every target config.yaml captures (this one among them), when more than one. */
|
||||
target?: RunTarget;
|
||||
targets?: RunTarget[];
|
||||
/**
|
||||
* The system-drawn areas the verdict left out of each screenshot; absent, the platform's bands, as the assessment's
|
||||
* default. A bundle does not record a foldable's pose, so its panel is not guessed here.
|
||||
*/
|
||||
systemRegions?: SystemRegion[];
|
||||
};
|
||||
|
||||
/** Build the validated review independently of where its metadata and images will be stored. */
|
||||
async function constructCaptureReview(options: CaptureReviewOptions, store: ScreenshotStore) {
|
||||
const plan = validateCapturePlan(options.plan);
|
||||
const excluded = new Set(plan.excludedSurfaceIds ?? []);
|
||||
const pr = projectReviewPresentation(options.pullRequest);
|
||||
if (pr.head.sha !== plan.headSha || pr.base.sha !== plan.baseSha) throw new Error("PR identity differs from capture plan");
|
||||
const run = `${identifier(options.runId)}-${identifier(options.runAttempt)}`;
|
||||
@@ -301,6 +307,7 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
|
||||
runtime: { projectId: head.bundle.easProjectId ?? "", buildId: head.bundle.easBuildId ?? "", gitCommit: plan.headSha,
|
||||
platform: head.bundle.platform ?? "ios", ...(head.bundle.controller === "argent" ? { controller: "argent" as const } : {}), statusBarBandPercent: statusBarBandPercent(head.bundle.platform),
|
||||
...(homeIndicatorBandPercent(head.bundle.platform) > 0 ? { homeIndicatorBandPercent: homeIndicatorBandPercent(head.bundle.platform) } : {}),
|
||||
systemRegions: (options.systemRegions ?? systemRegions({ platform: head.bundle.platform })).map((area) => ({ ...area })),
|
||||
...(options.platforms && options.platforms.length > 1 ? { platforms: [...options.platforms] } : {}),
|
||||
...(options.target ? { target: { ...options.target } } : {}),
|
||||
...(options.targets && options.targets.length > 1 ? { targets: options.targets.map(target => ({ ...target })) } : {}),
|
||||
@@ -341,6 +348,7 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
|
||||
return { id, status, base: headOnly ? null : withId(s.baseSurface), head: withId(s.headSurface),
|
||||
...(colorSchemes.length > 1 ? { colorScheme: scheme } : {}),
|
||||
...(s.sourceChange ? { sourceChange: s.sourceChange } : {}),
|
||||
...(excluded.has(s.id) ? { excluded: true as const } : {}),
|
||||
...(impactKinds(s).length ? { sourceImpact: impactKinds(s) } : {}),
|
||||
...(!headOnly && surfaceSourceScope(s) ? { sourceScope: surfaceSourceScope(s)! } : {}),
|
||||
...(baseOutcome ? { baseOutcome } : {}),
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { unattributedIssue } from "../capture/health.js";
|
||||
import { appearancePairs, bundleColorSchemes } from "../capture/appearance.js";
|
||||
import { homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
|
||||
import { launchSurfaceId, systemRegions as defaultSystemRegions, type SystemRegion } from "../contracts/capture.js";
|
||||
import { readFileSync, statSync } from "node:fs";
|
||||
import { stat } from "node:fs/promises";
|
||||
import { isAbsolute, resolve } from "node:path";
|
||||
@@ -26,8 +26,8 @@ import {
|
||||
type VisualEvidenceAssessment,
|
||||
} from "./visual-evidence.js";
|
||||
import { AGENT_DEVICE_VERSION } from "../shared/agent-device-version.js";
|
||||
import { STATUS_BAR_BAND_PERCENT } from "../shared/png-evidence.js";
|
||||
import { measureRegionShifts } from "./region-shift.js";
|
||||
import { STATUS_BAR_BAND_PERCENT, decodePng, differentPixelsInRect, maxColorDistance, type DecodedFrame } from "../shared/png-evidence.js";
|
||||
import { measureRegionMoves, type RegionMove, type RegionShift } from "./region-shift.js";
|
||||
|
||||
export const DEFAULT_VISUAL_THRESHOLD = 0.1;
|
||||
export const DEFAULT_EVIDENCE_TIME_BUDGET_MS = 10 * 60_000;
|
||||
@@ -142,16 +142,61 @@ function visualVerdict(assessment: VisualEvidenceAssessment, threshold: number):
|
||||
};
|
||||
}
|
||||
|
||||
type PublishedRegion = NonNullable<PublicVisualVerdict["regions"]>[number];
|
||||
|
||||
/** A region as published: the fields a review carries, without the comparison's own bookkeeping. */
|
||||
function publishedRegion(region: VisualDiffRegion): PublishedRegion {
|
||||
return { rect: region.rect, normalizedRect: region.normalizedRect, differentPixels: region.differentPixels,
|
||||
shareOfDiffPercentage: region.shareOfDiffPercentage, dominantChange: region.dominantChange, location: region.location };
|
||||
}
|
||||
|
||||
/**
|
||||
* The regions to publish from every region the comparison found, given what moved: each region with its small
|
||||
* shift, if one explains it, and each large move as one region in place of the regions it explains (where the
|
||||
* content is now, their pixels and share, its location the region the content arrived in), largest share first.
|
||||
* `allRegionsMoved` when every region, before any are left out, moved.
|
||||
*/
|
||||
export function publishMeasuredRegions(all: readonly VisualDiffRegion[], shifts: ReadonlyArray<RegionShift | undefined>,
|
||||
moves: readonly RegionMove[], width: number, height: number): Pick<PublicVisualVerdict, "regions" | "allRegionsMoved"> {
|
||||
const merged = new Set(moves.flatMap(move => move.members));
|
||||
const percent = (value: number, total: number) => Math.round((value / total) * 10_000) / 100;
|
||||
const regions: PublishedRegion[] = [
|
||||
...all.flatMap((region, index) => {
|
||||
if (merged.has(index)) return [];
|
||||
const shift = shifts[index];
|
||||
return [{ ...publishedRegion(region), ...(shift ? { shift } : {}) }];
|
||||
}),
|
||||
...moves.map(move => {
|
||||
const members = move.members.map(index => all[index]!);
|
||||
return {
|
||||
rect: move.rect,
|
||||
normalizedRect: { x: percent(move.rect.x, width), y: percent(move.rect.y, height), width: percent(move.rect.width, width), height: percent(move.rect.height, height) },
|
||||
differentPixels: members.reduce((sum, region) => sum + region.differentPixels, 0),
|
||||
// Each member's share is rounded, so their sum can pass 100; a share is at most the whole difference.
|
||||
shareOfDiffPercentage: Math.min(100, Math.round(members.reduce((sum, region) => sum + region.shareOfDiffPercentage, 0) * 100) / 100),
|
||||
dominantChange: "mixed", location: members[0]!.location, shift: move.shift,
|
||||
};
|
||||
}),
|
||||
];
|
||||
return {
|
||||
regions: regions.sort((left, right) => right.shareOfDiffPercentage - left.shareOfDiffPercentage).slice(0, MAX_REGIONS),
|
||||
...(regions.length > 0 && regions.every(region => region.shift) ? { allRegionsMoved: true as const } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The published regions with how far their content moved, where a move explains it: a layout that shifted by a
|
||||
* device pixel reads as moved, not as changed. Every region the comparison found is measured, not only the ones
|
||||
* published, so `allRegionsMoved` can say nothing else on the screen changed. A measurement that fails leaves the
|
||||
* regions as they were.
|
||||
* device pixel reads as moved, not as changed, and an element that moved further (a card recentred on a wider
|
||||
* screen) reads as one moved region instead of the fragments the comparison split it into. Every region the
|
||||
* comparison found is measured, not only the ones published, so `allRegionsMoved` can say nothing else on the
|
||||
* screen changed. A measurement that fails leaves the regions as they were.
|
||||
*/
|
||||
async function withRegionShifts(basePath: string, headPath: string, all: readonly VisualDiffRegion[], published: NonNullable<PublicVisualVerdict["regions"]>):
|
||||
Promise<Pick<PublicVisualVerdict, "regions" | "allRegionsMoved">> {
|
||||
try {
|
||||
const shifts = await measureRegionShifts(basePath, headPath, all.map(region => region.rect));
|
||||
const { shifts, moves, width, height } = await measureRegionMoves(basePath, headPath,
|
||||
all.map(region => ({ ...region.rect, dominantChange: region.dominantChange })));
|
||||
if (moves.length) return publishMeasuredRegions(all, shifts, moves, width, height);
|
||||
const shiftOf = new Map(all.map((region, index) => [region.rect, shifts[index]] as const));
|
||||
return {
|
||||
regions: published.map(region => {
|
||||
@@ -171,31 +216,103 @@ export function ignoreStatusBar(measurement: ScreenshotDiffMeasurement, bandPerc
|
||||
return { measurement: bands.measurement, ignored: bands.ignoredTop };
|
||||
}
|
||||
|
||||
/**
|
||||
* Leaves out of a measurement every diff region that lies entirely inside the system's bands: the status bar at the
|
||||
* top and, on iOS, the home indicator at the bottom. Both are drawn by the OS and differ between captures without
|
||||
* the app having changed. A region that crosses into the app's area is kept whole.
|
||||
*/
|
||||
export function ignoreSystemBands(measurement: ScreenshotDiffMeasurement, bands: { top: number; bottom: number }):
|
||||
/** Both frames a measurement compared, decoded on demand: only a region that crosses a band's edge needs them. */
|
||||
export type SystemBandFrames = { baseline: DecodedFrame; current: DecodedFrame; distance: number };
|
||||
export type SystemBandFrameLoader = () => SystemBandFrames | undefined;
|
||||
|
||||
/** Reads the measurement's two screenshots when a band's edge has to be resolved pixel by pixel. */
|
||||
export function systemBandFrameLoader(measurement: ScreenshotDiffMeasurement, threshold: number): SystemBandFrameLoader {
|
||||
return () => {
|
||||
try {
|
||||
const baseline = decodePng(readFileSync(measurement.baselinePath)); const current = decodePng(readFileSync(measurement.currentPath));
|
||||
if (!baseline || !current || baseline.width !== current.width || baseline.height !== current.height) return undefined;
|
||||
return { baseline, current, distance: maxColorDistance(threshold) };
|
||||
} catch { return undefined; }
|
||||
};
|
||||
}
|
||||
|
||||
/** `ignoreSystemRegions` for the plain case: a status-bar band across the top and a home-indicator band along the bottom. */
|
||||
export function ignoreSystemBands(measurement: ScreenshotDiffMeasurement, bands: { top: number; bottom: number }, frames?: SystemBandFrameLoader):
|
||||
{ measurement: ScreenshotDiffMeasurement; ignoredTop: number; ignoredBottom: number } {
|
||||
if (measurement.match || measurement.regions.length === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
|
||||
const inTop = (region: VisualDiffRegion) => bands.top > 0 && region.normalizedRect.y + region.normalizedRect.height <= bands.top;
|
||||
const inBottom = (region: VisualDiffRegion) => bands.bottom > 0 && region.normalizedRect.y >= 100 - bands.bottom;
|
||||
const inBand = (region: VisualDiffRegion) => inTop(region) || inBottom(region);
|
||||
const ignoredRegions = measurement.regions.filter(inBand);
|
||||
if (ignoredRegions.length === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
|
||||
const ignoredPixels = ignoredRegions.reduce((total, region) => total + region.differentPixels, 0);
|
||||
const regions: SystemRegion[] = [
|
||||
...(bands.top > 0 ? [{ kind: "status-bar" as const, x: 0, y: 0, width: 100, height: bands.top }] : []),
|
||||
...(bands.bottom > 0 ? [{ kind: "home-indicator" as const, x: 0, y: 100 - bands.bottom, width: 100, height: bands.bottom }] : []),
|
||||
];
|
||||
const result = ignoreSystemRegions(measurement, regions, frames);
|
||||
return { measurement: result.measurement, ignoredTop: result.ignoredStatusBar, ignoredBottom: result.ignoredHomeIndicator };
|
||||
}
|
||||
|
||||
/**
|
||||
* Leaves out of a measurement every diff region that lies inside a system-drawn area: the status bar (a band across
|
||||
* the top of a phone, a pill in the rail of a foldable) and, on iOS, the home indicator at the bottom. Both differ
|
||||
* between captures without the app having changed. A region that crosses the edge of a band across the whole width
|
||||
* is clipped to the part outside it when the frames can be read: its pixels inside the band are dropped, and it stays
|
||||
* only for what differs in the app's area. Without frames, and across a pill's edge, such a region is kept whole.
|
||||
* (A region's pixel count is its own cluster's, while its rect can overlap other regions, so what it keeps is counted
|
||||
* outside the band and clamped to its own count.)
|
||||
*/
|
||||
export function ignoreSystemRegions(measurement: ScreenshotDiffMeasurement, system: readonly SystemRegion[], frames?: SystemBandFrameLoader):
|
||||
{ measurement: ScreenshotDiffMeasurement; ignoredStatusBar: number; ignoredHomeIndicator: number } {
|
||||
if (measurement.match || measurement.regions.length === 0 || system.length === 0) return { measurement, ignoredStatusBar: 0, ignoredHomeIndicator: 0 };
|
||||
// agent-device rounds each of x, y, width and height to 0.01%, so an edge it reports can be up to 0.01% past the real one.
|
||||
const slack = 0.015;
|
||||
const inside = (region: VisualDiffRegion, area: SystemRegion) => {
|
||||
const rect = region.normalizedRect;
|
||||
return rect.x >= area.x - slack && rect.y >= area.y - slack
|
||||
&& rect.x + rect.width <= area.x + area.width + slack && rect.y + rect.height <= area.y + area.height + slack;
|
||||
};
|
||||
const across = system.filter((area) => area.x <= slack && area.x + area.width >= 100 - slack);
|
||||
const topBand = across.find((area) => area.y <= slack);
|
||||
const bottomBand = across.find((area) => area !== topBand && area.y + area.height >= 100 - slack);
|
||||
const crossesTop = (region: VisualDiffRegion) => topBand !== undefined && region.normalizedRect.y < topBand.y + topBand.height - slack;
|
||||
const crossesBottom = (region: VisualDiffRegion) => bottomBand !== undefined && region.normalizedRect.y + region.normalizedRect.height > bottomBand.y + slack;
|
||||
let loaded: SystemBandFrames | undefined | null = null;
|
||||
const load = () => { if (loaded === null) loaded = frames?.() ?? undefined; return loaded; };
|
||||
const ignored: Record<SystemRegion["kind"], number> = { "status-bar": 0, "home-indicator": 0 };
|
||||
let ignoredPixels = 0;
|
||||
const remaining: VisualDiffRegion[] = [];
|
||||
for (const region of measurement.regions) {
|
||||
const area = system.find((candidate) => inside(region, candidate));
|
||||
if (area) { ignored[area.kind] += 1; ignoredPixels += region.differentPixels; continue; }
|
||||
const top = crossesTop(region) ? topBand : undefined; const bottom = crossesBottom(region) ? bottomBand : undefined;
|
||||
const decoded = top || bottom ? load() : undefined;
|
||||
if (!decoded) { remaining.push(region); continue; }
|
||||
const { height, width } = decoded.baseline;
|
||||
const rect = { ...region.rect };
|
||||
if (top) {
|
||||
const bandRows = Math.floor((height * (top.y + top.height)) / 100);
|
||||
const rows = Math.max(0, Math.min(rect.y + rect.height, bandRows) - rect.y); rect.y += rows; rect.height -= rows;
|
||||
}
|
||||
if (bottom) rect.height = Math.min(rect.y + rect.height, height - Math.floor((height * bottom.height) / 100)) - rect.y;
|
||||
// Counted in what is left of the rect, not in what the band takes: the rect can enclose another region's pixels,
|
||||
// which can only add to what is kept (up to the region's own count), never take from it.
|
||||
const differentPixels = rect.height > 0 ? Math.min(region.differentPixels, differentPixelsInRect(decoded.baseline, decoded.current, rect, decoded.distance)) : 0;
|
||||
const inBand = region.differentPixels - differentPixels;
|
||||
if (differentPixels === 0) {
|
||||
ignored[(top ?? bottom)!.kind] += 1;
|
||||
ignoredPixels += region.differentPixels;
|
||||
continue;
|
||||
}
|
||||
// Its pixels inside the band were left out too, so the band is marked as not compared, as for a dropped region.
|
||||
if (inBand > 0) { if (top) ignored[top.kind] += 1; if (bottom) ignored[bottom.kind] += 1; }
|
||||
ignoredPixels += inBand;
|
||||
const round = (value: number) => Math.round(value * 100) / 100;
|
||||
remaining.push({ ...region, rect, differentPixels,
|
||||
normalizedRect: { x: round((rect.x / width) * 100), y: round((rect.y / height) * 100), width: round((rect.width / width) * 100), height: round((rect.height / height) * 100) } });
|
||||
}
|
||||
if (ignoredPixels === 0) return { measurement, ignoredStatusBar: 0, ignoredHomeIndicator: 0 };
|
||||
const differentPixels = Math.max(0, measurement.differentPixels - ignoredPixels);
|
||||
const remaining = measurement.regions.filter((region) => !inBand(region));
|
||||
const regions = remaining.map((region) => ({ ...region,
|
||||
shareOfDiffPercentage: differentPixels > 0 ? Math.round((region.differentPixels / differentPixels) * 10000) / 100 : 0 }));
|
||||
return {
|
||||
ignoredTop: ignoredRegions.filter(inTop).length,
|
||||
ignoredBottom: ignoredRegions.filter((region) => !inTop(region)).length,
|
||||
ignoredStatusBar: ignored["status-bar"],
|
||||
ignoredHomeIndicator: ignored["home-indicator"],
|
||||
measurement: {
|
||||
...measurement,
|
||||
differentPixels,
|
||||
mismatchPercentage: measurement.totalPixels > 0 ? Math.round((differentPixels / measurement.totalPixels) * 10000) / 100 : 0,
|
||||
match: differentPixels === 0 || remaining.length === 0,
|
||||
regions: remaining,
|
||||
match: differentPixels === 0 || regions.length === 0,
|
||||
regions,
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -309,19 +426,21 @@ function localEvidencePath(side: PublicEvidenceSide, relativePath: string): stri
|
||||
*/
|
||||
export function decideReview(scope: SurfaceSourceScope, visual: PublicVisualVerdict, summary?: WhatChangedSummary): PublicSurfaceReview {
|
||||
const facts = summary?.facts.map((fact) => ({ category: fact.category, templateId: fact.templateId, bullet: truncate(fact.bullet) })) ?? [];
|
||||
const differs = visual.verdict === "modified" || facts.length > 0;
|
||||
// Text that also differs between two captures of the same build is runtime state: listed, never what makes a change.
|
||||
const changes = facts.filter((fact) => fact.templateId !== "visible-text.unstable-within-build");
|
||||
const differs = visual.verdict === "modified" || changes.length > 0;
|
||||
const inconclusive = !differs && (visual.verdict === "needs-review" || Boolean(summary?.needsReview));
|
||||
const issue = summary?.reviewIssues[0]?.reason;
|
||||
const evidenceText = facts[0]?.bullet ?? visualDescription(visual);
|
||||
const evidenceText = changes[0]?.bullet ?? visualDescription(visual);
|
||||
if (scope === "none") {
|
||||
if (!differs) return { status: "unchanged", description: "No visible change" };
|
||||
// The comparator's generic visual fact reads as a styling change; a variant names what differs.
|
||||
const state = facts.find((fact) => fact.category !== "visual")?.bullet
|
||||
const state = [...changes, ...facts].find((fact) => fact.category !== "visual")?.bullet
|
||||
?? `${percentage(visual.mismatchPercentage)}${visual.regions?.[0]?.location ? ` · ${visual.regions[0].location}` : ""}`;
|
||||
return { status: "variant", description: truncate(`Runtime state differs: ${state}`), ...(facts.length ? { facts } : {}) };
|
||||
}
|
||||
if (differs) {
|
||||
const description = !facts.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
|
||||
const description = !changes.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
|
||||
return { status: "modified", description: truncate(description), ...(facts.length ? { facts } : {}) };
|
||||
}
|
||||
if (inconclusive) {
|
||||
@@ -369,6 +488,8 @@ function captureDiagnostic(surface: PlanSurface, side: "base" | "head", evidence
|
||||
export async function assessPublicEvidence(options: {
|
||||
/** The captured platform; its status bar band is left out of the visual verdict. Absent: iOS. */
|
||||
platform?: "ios" | "android";
|
||||
/** The system-drawn areas left out of the visual verdict; absent, the platform's bands. */
|
||||
systemRegions?: SystemRegion[];
|
||||
plan: SourceCapturePlan;
|
||||
base: PublicEvidenceSide;
|
||||
head: PublicEvidenceSide;
|
||||
@@ -380,6 +501,7 @@ export async function assessPublicEvidence(options: {
|
||||
measure?: (baselinePath: string, currentPath: string) => Promise<ScreenshotDiffMeasurement>;
|
||||
}): Promise<PublicEvidenceResult> {
|
||||
const threshold = options.threshold ?? DEFAULT_VISUAL_THRESHOLD;
|
||||
const system = options.systemRegions ?? defaultSystemRegions({ platform: options.platform });
|
||||
const now = options.now ?? Date.now;
|
||||
const deadline = now() + (options.timeBudgetMs ?? DEFAULT_EVIDENCE_TIME_BUDGET_MS);
|
||||
const surfaces: Record<string, PublicSurfaceAssessment> = {};
|
||||
@@ -439,7 +561,19 @@ export async function assessPublicEvidence(options: {
|
||||
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen"
|
||||
|| (!surface.baseCapture && !surface.headCapture)) continue;
|
||||
// Every appearance the capture rendered is compared like-for-like: `<id>@<scheme>` frames against each other.
|
||||
for (const { id, scheme, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
|
||||
const pairs = appearancePairs(surface.id, colorSchemes, baseColorSchemes);
|
||||
// The screen's other appearances, rendered by both builds and verified on both: a label that varies between a
|
||||
// build's own appearances is runtime state. An unverified capture may show another screen, so it is no evidence.
|
||||
const baseRoute = surface.baseSurface, headRoute = surface.headSurface;
|
||||
const siblings = (current: string) => pairs.flatMap((pair) => {
|
||||
if (pair.id === current || pair.baseId === null || captureDiagnostic(surface, "base", options.base, pair.baseId)
|
||||
|| captureDiagnostic(surface, "head", options.head, pair.id)) return [];
|
||||
try {
|
||||
return [{ base: matchedSide("base", options.base, { ...baseRoute, id: pair.baseId }, options.profile),
|
||||
head: matchedSide("head", options.head, { ...headRoute, id: pair.id }, options.profile) }];
|
||||
} catch { return []; }
|
||||
});
|
||||
for (const { id, scheme, baseId } of pairs) {
|
||||
// An appearance the base never rendered has nothing to compare against: the head frame is new evidence.
|
||||
if (baseId === null) {
|
||||
if (localImagePath(options.head, id)) {
|
||||
@@ -476,7 +610,7 @@ export async function assessPublicEvidence(options: {
|
||||
} else {
|
||||
try {
|
||||
const raw = await measure(basePath, headPath);
|
||||
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
|
||||
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
|
||||
assessment = assessVisualMeasurements({
|
||||
baselineSamples: 1,
|
||||
currentSamples: 1,
|
||||
@@ -493,6 +627,7 @@ export async function assessPublicEvidence(options: {
|
||||
}
|
||||
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
|
||||
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
|
||||
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
|
||||
visualCounts.compared += 1;
|
||||
if (visual.verdict === "modified") visualCounts.modified += 1;
|
||||
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
|
||||
@@ -515,6 +650,7 @@ export async function assessPublicEvidence(options: {
|
||||
base: matchedSide("base", options.base, { ...surface.baseSurface, id: baseId }, options.profile),
|
||||
head: matchedSide("head", options.head, { ...surface.headSurface, id }, options.profile),
|
||||
visualAssessment: assessment,
|
||||
siblings: siblings(id),
|
||||
});
|
||||
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
|
||||
accessibilityCounts.compared += 1;
|
||||
@@ -544,11 +680,13 @@ export async function assessPublicEvidence(options: {
|
||||
const basePath = localEvidencePath(options.base, baseLaunch.splash.path); const headPath = localEvidencePath(options.head, headLaunch.splash.path);
|
||||
if (!basePath || !headPath) continue;
|
||||
try {
|
||||
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(await measure(basePath, headPath), { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
|
||||
const raw = await measure(basePath, headPath);
|
||||
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
|
||||
const visual = visualVerdict(assessVisualMeasurements({ baselineSamples: 1, currentSamples: 1, requiredSamples: 1,
|
||||
baselineWithin: [], currentWithin: [], crossBuild: [measurement], representative: measurement }), threshold);
|
||||
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
|
||||
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
|
||||
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
|
||||
surfaces[id] = { visual };
|
||||
} catch (error) {
|
||||
comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
|
||||
|
||||
@@ -17,7 +17,7 @@ import type {
|
||||
ObservedElement,
|
||||
Screen,
|
||||
} from "../types.js";
|
||||
import type { VisualEvidenceAssessment } from "./visual-evidence.js";
|
||||
import type { VisualDiffRegion, VisualEvidenceAssessment } from "./visual-evidence.js";
|
||||
import { CAPTURE_OBSERVER_IDENTIFIER, parseCaptureDestination } from "../capture/observer.js";
|
||||
|
||||
export type StableReviewerElementAnnotation = {
|
||||
@@ -70,6 +70,11 @@ export type CommonSurfaceComparatorInput = {
|
||||
visualAssessment: VisualEvidenceAssessment;
|
||||
/** Explicit stable runtime scope; semantic meaning is never inferred from diff pixels. */
|
||||
visualScope?: VisualReviewerChange["scope"];
|
||||
/**
|
||||
* The screen's other appearances, captured and verified on both builds. A label that varies between each build's own
|
||||
* captures, in the words that differ between the builds, is runtime state, and its difference is reported as such.
|
||||
*/
|
||||
siblings?: readonly { base: MatchedSurfaceSide; head: MatchedSurfaceSide }[];
|
||||
};
|
||||
|
||||
export type EvidenceComparatorInput =
|
||||
@@ -139,6 +144,7 @@ const CHANGE_PRIORITY: Record<SupportedReviewerChange["kind"], number> = {
|
||||
"element-added": 20,
|
||||
"element-removed": 20,
|
||||
"visible-text-changed": 30,
|
||||
"unstable-text": 35,
|
||||
"action-target-changed": 40,
|
||||
"accessibility-label-changed": 50,
|
||||
"accessibility-role-changed": 50,
|
||||
@@ -772,10 +778,76 @@ function actionTarget(side: ResolvedSide, element: ObservedElement): ActionTarge
|
||||
return target ? { kind: "target", target } : { kind: "none", evidenceRefs: [] };
|
||||
}
|
||||
|
||||
type ResolvedSibling = { base: ResolvedSide; head: ResolvedSide };
|
||||
|
||||
function resolveSiblings(input: CommonSurfaceComparatorInput, requiredSamples: 1 | 3): ResolvedSibling[] {
|
||||
const resolve = (side: "base" | "head", sibling: MatchedSurfaceSide) => {
|
||||
const screenId = sibling.map.observations.find((candidate) => candidate.id === sibling.observationId)?.screenId;
|
||||
const resolution = screenId === undefined ? undefined : resolveSide(side, sibling, { ...input.impact, id: screenId }, requiredSamples);
|
||||
// A sibling is evidence only when it resolves as cleanly as a comparison would.
|
||||
return resolution?.kind === "resolved" && resolution.side.issues.length === 0 ? resolution.side : undefined;
|
||||
};
|
||||
return (input.siblings ?? []).flatMap((sibling) => {
|
||||
const base = resolve("base", sibling.base);
|
||||
const head = resolve("head", sibling.head);
|
||||
return base && head ? [{ base, head }] : [];
|
||||
});
|
||||
}
|
||||
|
||||
function sameBounds(left: ElementBounds | undefined, right: ElementBounds | undefined): boolean {
|
||||
return !!left && !!right && left.x === right.x && left.y === right.y && left.width === right.width && left.height === right.height;
|
||||
}
|
||||
|
||||
/** The element at the same place in another capture: the one of its role with its identifier or, without one, its bounds. */
|
||||
function counterpart(element: ObservedElement, other: ResolvedSide): ObservedElement | undefined {
|
||||
const identifier = compact(element.identifier ?? "");
|
||||
const bounds = boundsOf(element);
|
||||
const candidates = other.elements.filter((candidate) => candidate.role === element.role && (identifier
|
||||
? compact(candidate.identifier ?? "") === identifier
|
||||
: !compact(candidate.identifier ?? "") && sameBounds(bounds, boundsOf(candidate))));
|
||||
return candidates.length === 1 ? candidates[0] : undefined;
|
||||
}
|
||||
|
||||
/** The word positions at which two labels differ, or undefined when they have different numbers of words. */
|
||||
function changedWords(left: string, right: string): number[] | undefined {
|
||||
const leftWords = left.split(" ");
|
||||
const rightWords = right.split(" ");
|
||||
return leftWords.length === rightWords.length
|
||||
? leftWords.flatMap((word, index) => word === rightWords[index] ? [] : [index])
|
||||
: undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* What the head showed in its other appearance, when a label's difference between the builds is runtime state: each
|
||||
* build shows the label differently in its own two appearances, the other appearance differs between the builds too,
|
||||
* and every word that differs between the builds is one that varies within a build. A label that follows the
|
||||
* appearance ("Switch to dark mode") does not vary within a build that broke it, or keeps a word that changed, so
|
||||
* its change is still a change.
|
||||
*/
|
||||
function unstableWithin(base: ObservedElement, head: ObservedElement, siblings: readonly ResolvedSibling[]): string | undefined {
|
||||
const baseLabel = compact(base.label);
|
||||
const headLabel = compact(head.label);
|
||||
for (const sibling of siblings) {
|
||||
const baseOther = compact(counterpart(base, sibling.base)?.label ?? "");
|
||||
const headOther = compact(counterpart(head, sibling.head)?.label ?? "");
|
||||
if (!baseLabel || !headLabel || !baseOther || !headOther) continue;
|
||||
const withinBase = changedWords(baseLabel, baseOther);
|
||||
const withinHead = changedWords(headLabel, headOther);
|
||||
const across = changedWords(baseLabel, headLabel);
|
||||
const acrossOther = changedWords(baseOther, headOther);
|
||||
if (!withinBase?.length || !withinHead?.length || !across?.length || !acrossOther?.length) continue;
|
||||
const varying = new Set([...withinBase, ...withinHead]);
|
||||
if ([...across, ...acrossOther].every((index) => varying.has(index))) return headOther;
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function comparePair(
|
||||
pair: ElementPair,
|
||||
base: ResolvedSide,
|
||||
head: ResolvedSide,
|
||||
/** What the head showed in its other appearance when this element's label is runtime state. */
|
||||
within?: string,
|
||||
): { facts: SupportedInput[]; issues: IssueInput[] } {
|
||||
const facts: SupportedInput[] = [];
|
||||
const issues: IssueInput[] = [];
|
||||
@@ -784,6 +856,10 @@ function comparePair(
|
||||
const headLabel = compact(pair.head.label);
|
||||
const baseAnnotation = base.annotationsByElementId.get(pair.base.elementId);
|
||||
const headAnnotation = head.annotationsByElementId.get(pair.head.elementId);
|
||||
// Runtime state replaces a label change only where the label comparison itself holds: provenance still decides first.
|
||||
const labelChange = (change: SupportedReviewerChange): SupportedReviewerChange => within
|
||||
? { kind: "unstable-text", subjectRole: reviewerRole(pair.head.role), before: baseLabel, after: headLabel, within }
|
||||
: change;
|
||||
|
||||
if (baseLabel !== headLabel) {
|
||||
if (baseAnnotation && headAnnotation) {
|
||||
@@ -793,14 +869,14 @@ function comparePair(
|
||||
} else if (!baseLabel || !headLabel) {
|
||||
issues.push(inconclusive("Visible-title comparison is missing before or after text.", refs));
|
||||
} else {
|
||||
facts.push(supported({
|
||||
facts.push(supported(labelChange({
|
||||
kind: "visible-text-changed",
|
||||
subjectRole: subject.subjectRole,
|
||||
subjectLabel: subject.subjectLabel,
|
||||
textKind: pair.head.role === "button" ? "title" : "label",
|
||||
before: baseLabel,
|
||||
after: headLabel,
|
||||
}, refs));
|
||||
}), refs));
|
||||
}
|
||||
} else if (baseAnnotation || headAnnotation) {
|
||||
issues.push(inconclusive(
|
||||
@@ -810,12 +886,12 @@ function comparePair(
|
||||
} else if (!baseLabel || !headLabel) {
|
||||
issues.push(inconclusive("Accessibility label comparison is missing before or after text.", refs));
|
||||
} else {
|
||||
facts.push(supported({
|
||||
facts.push(supported(labelChange({
|
||||
kind: "accessibility-label-changed",
|
||||
subjectRole: reviewerRole(pair.head.role),
|
||||
before: baseLabel,
|
||||
after: headLabel,
|
||||
}, refs));
|
||||
}), refs));
|
||||
}
|
||||
}
|
||||
if (pair.base.role !== pair.head.role) {
|
||||
@@ -925,11 +1001,20 @@ function visualFact(
|
||||
fact: supported({ kind: "visual-changed", scope: { kind: "landmark", label } }, refs),
|
||||
};
|
||||
}
|
||||
const near = nearEdge(input.visualAssessment.representative?.regions ?? []);
|
||||
return {
|
||||
fact: supported({ kind: "visual-changed", scope: { kind: "main-content" } }, refs),
|
||||
fact: supported({ kind: "visual-changed", scope: { kind: "main-content", ...(near ? { near } : {}) } }, refs),
|
||||
};
|
||||
}
|
||||
|
||||
/** Which edge every diff region hugs, when all of them sit in the outer 12 % of the frame: not "the main content". */
|
||||
function nearEdge(regions: readonly VisualDiffRegion[]): "top" | "bottom" | undefined {
|
||||
if (regions.length === 0) return undefined;
|
||||
if (regions.every((region) => region.normalizedRect.y + region.normalizedRect.height <= 12)) return "top";
|
||||
if (regions.every((region) => region.normalizedRect.y >= 88)) return "bottom";
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function comparisonForAdded(head: RuntimeEvidence): RuntimeEvidenceComparison {
|
||||
return {
|
||||
contract: RUNTIME_EVIDENCE_COMPARISON_CONTRACT,
|
||||
@@ -1101,6 +1186,27 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
gone = base.elements.filter(element => content(element, headWords));
|
||||
arrived = head.elements.filter(element => content(element, baseWords));
|
||||
}
|
||||
// Text without an identifier is matched by its label, so a label that changed on its own leaves as one element and
|
||||
// arrives as another: the one of its role at the same place on both sides is runtime state when its label is.
|
||||
const siblings = mixedBackends ? [] : resolveSiblings(input, input.impact.baseSamples);
|
||||
const runtimeText = { base: new Set<string>(), head: new Set<string>() };
|
||||
for (const removed of siblings.length ? specificByLabel(gone) : []) {
|
||||
const added = counterpart(removed, head);
|
||||
if (!added || !arrived.includes(added) || counterpart(added, base) !== removed) continue;
|
||||
const within = unstableWithin(removed, added, siblings);
|
||||
if (!within) continue;
|
||||
runtimeText.base.add(compact(removed.label));
|
||||
runtimeText.head.add(compact(added.label));
|
||||
facts.push(supported({
|
||||
kind: "unstable-text",
|
||||
subjectRole: reviewerRole(added.role),
|
||||
before: compact(removed.label),
|
||||
after: compact(added.label),
|
||||
within,
|
||||
}, [elementRef("base", removed), elementRef("head", added)]));
|
||||
}
|
||||
gone = gone.filter((element) => !runtimeText.base.has(compact(element.label)));
|
||||
arrived = arrived.filter((element) => !runtimeText.head.has(compact(element.label)));
|
||||
for (const element of outermost(specificByLabel(gone))) {
|
||||
const label = compact(element.label);
|
||||
if (!label) {
|
||||
@@ -1132,7 +1238,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
}
|
||||
}
|
||||
for (const pair of pairing.pairs) {
|
||||
const comparison = comparePair(pair, base, head);
|
||||
const comparison = comparePair(pair, base, head, unstableWithin(pair.base, pair.head, siblings));
|
||||
facts.push(...comparison.facts);
|
||||
issues.push(...comparison.issues);
|
||||
}
|
||||
@@ -1145,7 +1251,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
const visual = visualFact(input, base, head);
|
||||
// Pixels always move when an element appears or its text changes. The generic styling line
|
||||
// only informs when nothing in the accessibility tree accounts for the difference.
|
||||
const explained = facts.length > 0 && input.visualScope?.kind !== "landmark";
|
||||
const explained = facts.some((fact) => fact.change.kind !== "unstable-text") && input.visualScope?.kind !== "landmark";
|
||||
if (visual.fact && !explained) facts.push(visual.fact);
|
||||
if (visual.issue) issues.push(visual.issue);
|
||||
|
||||
|
||||
+266
-3
@@ -63,12 +63,15 @@ function at(source: Image, x: number, y: number, channel?: number): number {
|
||||
return value(x0, y0) * (1 - fx) * (1 - fy) + value(x1, y0) * fx * (1 - fy) + value(x0, y1) * (1 - fx) * fy + value(x1, y1) * fx * fy;
|
||||
}
|
||||
|
||||
/** How badly After's region matches Before shifted by (sx, sy). */
|
||||
/** How badly After's region matches Before shifted by (sx, sy). A whole-pixel shift reads Before's pixels directly. */
|
||||
function mismatch(base: Image, head: Image, rect: Rect, sx: number, sy: number): number {
|
||||
const whole = Number.isInteger(sx) && Number.isInteger(sy);
|
||||
let error = 0;
|
||||
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
|
||||
const by = Math.min(base.height - 1, Math.max(0, y - sy));
|
||||
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
|
||||
error += Math.abs(at(base, x - sx, y - sy) - head.luminance[y * head.width + x]!);
|
||||
const before = whole ? base.luminance[by * base.width + Math.min(base.width - 1, Math.max(0, x - sx))]! : at(base, x - sx, y - sy);
|
||||
error += Math.abs(before - head.luminance[y * head.width + x]!);
|
||||
}
|
||||
}
|
||||
return error;
|
||||
@@ -141,10 +144,270 @@ export function regionShifts(baseFrame: DecodedFrame, headFrame: DecodedFrame, r
|
||||
return regions.map(region => regionShift(base, head, region));
|
||||
}
|
||||
|
||||
/**
|
||||
* A move too large for the drift search: content that left one area and arrived in another, such as a card that
|
||||
* went from the left of a wide sheet to its centre. `rect` is where the moved content is in After, `shift` how far it
|
||||
* went, and `members` the regions it explains (indices into the regions measured), the region it arrived in first.
|
||||
*/
|
||||
export type RegionMove = { rect: Rect; shift: RegionShift; members: number[] };
|
||||
|
||||
type Axis = "x" | "y";
|
||||
/** How alike two regions' extents across the move must be to be one element's two ends: overlap and size. */
|
||||
const PAIR_OVERLAP = 0.8;
|
||||
const PAIR_SIZE = 0.25;
|
||||
/** Rows (or columns) sampled for the brightness profiles that estimate a large move: every second one is plenty. */
|
||||
const PROFILE_STEP = 2;
|
||||
/** Another local best this close to the best makes a large move ambiguous: repeating content (a grid, a list). */
|
||||
const AMBIGUOUS_LARGE = 1.05;
|
||||
/** The share of the arrived region the move must explain, as for a small move. */
|
||||
const MIN_EXPLAINED_LARGE = MIN_EXPLAINED;
|
||||
/** After aligning by the move, at most this share of a region may still differ strongly (antialiased edges). */
|
||||
const CHANGED_SHARE = 0.001;
|
||||
/** How far across the move a large one may also drift, as layout below a moved element does; ties keep it in line. */
|
||||
const ACROSS_OFFSETS = [0, -1, 1, -2, 2, -3, 3];
|
||||
/**
|
||||
* Blocks that give something drawn away, where every pixel differs by more than `channel` in some channel: a 2×2
|
||||
* block of strongly different pixels (an icon, a badge, a mark), or a 4×4 block of moderately different ones (a
|
||||
* tint, a low-contrast label, a grey badge). Antialiased edges and hairlines against another backdrop are thinner:
|
||||
* the chevrons in euxy's Patterns rows (brentvatne/euxy#163) cross a curve that differs by up to 69 in 3×3 blocks
|
||||
* but only 26 in 4×4 ones, while a grey "Off" label the move did not bring differs by 55 in 4×4 blocks.
|
||||
*/
|
||||
const SOLID_BLOCKS = [{ size: 2, channel: CHANGED_CHANNEL }, { size: 4, channel: 40 }];
|
||||
|
||||
const extent = (rect: Rect, axis: Axis) => axis === "x" ? { start: rect.x, size: rect.width } : { start: rect.y, size: rect.height };
|
||||
const across = (axis: Axis): Axis => axis === "x" ? "y" : "x";
|
||||
const shiftAlong = (axis: Axis, along: number, other = 0): RegionShift => axis === "x" ? { x: along, y: other } : { x: other, y: along };
|
||||
|
||||
/** Whether two regions could be one element's two ends of a move along `axis`: side by side, alike across it. */
|
||||
function pairAlong(a: Rect, b: Rect, axis: Axis): boolean {
|
||||
const ea = extent(a, axis), eb = extent(b, axis), ca = extent(a, across(axis)), cb = extent(b, across(axis));
|
||||
const separate = ea.start + ea.size <= eb.start || eb.start + eb.size <= ea.start;
|
||||
const overlap = Math.min(ca.start + ca.size, cb.start + cb.size) - Math.max(ca.start, cb.start);
|
||||
const alike = Math.abs(ea.size - eb.size) <= PAIR_SIZE * Math.max(ea.size, eb.size);
|
||||
return separate && alike && overlap >= PAIR_OVERLAP * Math.min(ca.size, cb.size);
|
||||
}
|
||||
|
||||
/** Mean luminance along `axis` of a band across it: one value per column (axis x) or row (axis y). */
|
||||
function profile(source: Image, axis: Axis, bandStart: number, bandEnd: number): Float32Array {
|
||||
const length = axis === "x" ? source.width : source.height;
|
||||
const values = new Float32Array(length);
|
||||
for (let position = 0; position < length; position += 1) {
|
||||
let sum = 0, count = 0;
|
||||
for (let other = bandStart; other < bandEnd; other += PROFILE_STEP) {
|
||||
sum += axis === "x" ? source.luminance[other * source.width + position]! : source.luminance[position * source.width + other]!;
|
||||
count += 1;
|
||||
}
|
||||
values[position] = count ? sum / count : 0;
|
||||
}
|
||||
return values;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a region holds something drawn: a solid block (SOLID_BLOCKS), or more than `allowed` strongly different
|
||||
* pixels anywhere. `difference` is how much the pixel at (x, y) differs, in its most different channel.
|
||||
*/
|
||||
function drawnIn(rect: Rect, difference: (x: number, y: number) => number, allowed = Infinity): boolean {
|
||||
// Per block: how many pixels differ in a row up to here, and for each column, how many rows have such a run.
|
||||
const blocks = SOLID_BLOCKS.map(block => ({ ...block, run: 0, rows: new Uint32Array(rect.width) }));
|
||||
let strong = 0;
|
||||
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
|
||||
for (const block of blocks) block.run = 0;
|
||||
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
|
||||
const value = difference(x, y), column = x - rect.x;
|
||||
if (value > CHANGED_CHANNEL && ++strong > allowed) return true;
|
||||
for (const block of blocks) {
|
||||
block.run = value > block.channel ? block.run + 1 : 0;
|
||||
block.rows[column] = block.run >= block.size ? block.rows[column]! + 1 : 0;
|
||||
if (block.rows[column]! >= block.size) return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether, aligned by an integer move, some of the region still differs: content that changed, not only moved. A
|
||||
* whole-pixel move copies the pixels, so only a sliver may differ strongly (antialiased edges against another
|
||||
* backdrop, never more than CHANGED_SHARE of the region), and never a solid block. Pixels the move brings in from
|
||||
* off screen differ.
|
||||
*/
|
||||
function changedAfterLargeMove(base: Image, head: Image, rect: Rect, sx: number, sy: number): boolean {
|
||||
return drawnIn(rect, (x, y) => {
|
||||
const bx = x - sx, by = y - sy;
|
||||
if (bx < 0 || by < 0 || bx >= base.width || by >= base.height) return 255;
|
||||
const h = (y * head.width + x) * 4, b = (by * base.width + bx) * 4;
|
||||
return Math.max(Math.abs(base.frame.data[b]! - head.frame.data[h]!), Math.abs(base.frame.data[b + 1]! - head.frame.data[h + 1]!),
|
||||
Math.abs(base.frame.data[b + 2]! - head.frame.data[h + 2]!));
|
||||
}, Math.max(CHANGED_PIXELS, rect.width * rect.height * CHANGED_SHARE));
|
||||
}
|
||||
|
||||
/** How much of a region's difference an integer move explains: 1 is all of it, 0 none. `unshifted` is the region's own. */
|
||||
function explained(base: Image, head: Image, rect: Rect, shift: RegionShift, unshifted = mismatch(base, head, rect, 0, 0)): number {
|
||||
return unshifted === 0 ? 0 : 1 - mismatch(base, head, rect, shift.x, shift.y) / unshifted;
|
||||
}
|
||||
|
||||
/** Whether a region's content, moved by `shift`, is the same in After: explained, and nothing changed in it. */
|
||||
function movedIntact(base: Image, head: Image, rect: Rect, shift: RegionShift): boolean {
|
||||
return rect.width > 0 && rect.height > 0 && explained(base, head, rect, shift) >= MIN_EXPLAINED_LARGE
|
||||
&& !changedAfterLargeMove(base, head, rect, shift.x, shift.y);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a part of After where content left is plain backdrop: the colour around it (the median of the pixels just
|
||||
* outside it, not in the moved content's `outline`), with nothing drawn on it. A part with nothing around it is not.
|
||||
*/
|
||||
function plain(head: Image, rect: Rect, outline: Rect): boolean {
|
||||
if (rect.width <= 0 || rect.height <= 0) return true;
|
||||
const around: number[][] = [[], [], []];
|
||||
const add = (x: number, y: number) => {
|
||||
if (x < 0 || y < 0 || x >= head.width || y >= head.height) return;
|
||||
if (x >= outline.x && y >= outline.y && x < outline.x + outline.width && y < outline.y + outline.height) return;
|
||||
for (let channel = 0; channel < 3; channel += 1) around[channel]!.push(head.frame.data[(y * head.width + x) * 4 + channel]!);
|
||||
};
|
||||
for (let x = rect.x - 1; x <= rect.x + rect.width; x += 1) { add(x, rect.y - 1); add(x, rect.y + rect.height); }
|
||||
for (let y = rect.y; y < rect.y + rect.height; y += 1) { add(rect.x - 1, y); add(rect.x + rect.width, y); }
|
||||
if (!around[0]!.length) return false;
|
||||
const backdrop = around.map(values => values.sort((a, b) => a - b)[values.length >> 1]!);
|
||||
return !drawnIn(rect, (x, y) => {
|
||||
const offset = (y * head.width + x) * 4;
|
||||
return Math.max(Math.abs(head.frame.data[offset]! - backdrop[0]!), Math.abs(head.frame.data[offset + 1]! - backdrop[1]!),
|
||||
Math.abs(head.frame.data[offset + 2]! - backdrop[2]!));
|
||||
});
|
||||
}
|
||||
|
||||
/** The parts of `rect` before and after `outline` along `axis`: what is left of it outside the outline. */
|
||||
function outside(rect: Rect, outline: Rect, axis: Axis): Rect[] {
|
||||
const r = extent(rect, axis), o = extent(outline, axis);
|
||||
const parts: Array<[number, number]> = [[r.start, Math.min(r.start + r.size, o.start)], [Math.max(r.start, o.start + o.size), r.start + r.size]];
|
||||
return parts.filter(([from, to]) => to > from)
|
||||
.map(([from, to]) => (axis === "x" ? { ...rect, x: from, width: to - from } : { ...rect, y: from, height: to - from }));
|
||||
}
|
||||
|
||||
function clip(rect: Rect, width: number, height: number): Rect {
|
||||
const x = Math.max(0, Math.floor(rect.x)), y = Math.max(0, Math.floor(rect.y));
|
||||
return { x, y, width: Math.max(0, Math.min(width, Math.ceil(rect.x + rect.width)) - x), height: Math.max(0, Math.min(height, Math.ceil(rect.y + rect.height)) - y) };
|
||||
}
|
||||
|
||||
function union(a: Rect, b: Rect): Rect {
|
||||
const x = Math.min(a.x, b.x), y = Math.min(a.y, b.y);
|
||||
return { x, y, width: Math.max(a.x + a.width, b.x + b.width) - x, height: Math.max(a.y + a.height, b.y + b.height) - y };
|
||||
}
|
||||
|
||||
/**
|
||||
* The large move a pair of regions shows, if one does: `left` is where content was (it differs because the content
|
||||
* left), `arrived` where it is now, both already clipped to the screenshot. The pair only names the axis and how far
|
||||
* to look; the distance is where After's brightness profile across the arrived region best matches Before's, and
|
||||
* the pixels must agree once aligned, both where the content arrived and where the content that left went.
|
||||
*/
|
||||
function pairMove(base: Image, head: Image, left: Rect, arrived: Rect, axis: Axis): RegionShift | undefined {
|
||||
const a = extent(arrived, axis), l = extent(left, axis), band = extent(arrived, across(axis)), lb = extent(left, across(axis));
|
||||
const bandStart = Math.max(band.start, lb.start), bandEnd = Math.min(band.start + band.size, lb.start + lb.size);
|
||||
if (bandEnd <= bandStart || a.size <= 0) return undefined;
|
||||
const baseProfile = profile(base, axis, bandStart, bandEnd), headProfile = profile(head, axis, bandStart, bandEnd);
|
||||
const length = baseProfile.length;
|
||||
// Content moving toward the arrived region: the distance is positive when it lies after the region it left.
|
||||
const sign = a.start > l.start ? 1 : -1;
|
||||
const farthest = Math.abs(a.start + a.size - l.start) + Math.abs(l.start + l.size - a.start);
|
||||
const errors: Array<{ distance: number; error: number }> = [];
|
||||
for (let distance = (axis === "x" ? MAX_SHIFT_X : MAX_SHIFT_Y) + 1; distance <= farthest; distance += 1) {
|
||||
const move = sign * distance;
|
||||
let sum = 0, count = 0;
|
||||
for (let position = a.start; position < a.start + a.size; position += 1) {
|
||||
const from = position - move;
|
||||
if (from < 0 || from >= length) continue;
|
||||
sum += Math.abs(headProfile[position]! - baseProfile[from]!);
|
||||
count += 1;
|
||||
}
|
||||
if (count >= a.size / 2) errors.push({ distance: move, error: sum / count });
|
||||
}
|
||||
if (errors.length < 3) return undefined;
|
||||
const minima = errors.filter((fit, index) => index > 0 && index < errors.length - 1
|
||||
&& fit.error <= errors[index - 1]!.error && fit.error <= errors[index + 1]!.error);
|
||||
if (!minima.length) return undefined;
|
||||
const best = minima.reduce((least, fit) => (fit.error < least.error ? fit : least));
|
||||
if (minima.some(fit => fit !== best && Math.abs(fit.distance - best.distance) > 2 && fit.error <= best.error * AMBIGUOUS_LARGE + 1e-6)) return undefined;
|
||||
// The pixels decide: across the move it may also drift a little, as content below a moved element does. A tie
|
||||
// keeps the move in line (content the same all across it fits every drift equally).
|
||||
let chosen: RegionShift | undefined, fit = -Infinity;
|
||||
const unshifted = mismatch(base, head, arrived, 0, 0);
|
||||
for (const other of ACROSS_OFFSETS) {
|
||||
const shift = shiftAlong(axis, best.distance, other);
|
||||
const share = explained(base, head, arrived, shift, unshifted);
|
||||
if (share > fit) { fit = share; chosen = shift; }
|
||||
}
|
||||
if (!chosen || fit < MIN_EXPLAINED_LARGE || changedAfterLargeMove(base, head, arrived, chosen.x, chosen.y)) return undefined;
|
||||
// The content that left must be intact where the move takes it: a deletion is not a move.
|
||||
const landed = clip({ ...left, x: left.x + chosen.x, y: left.y + chosen.y }, head.width, head.height);
|
||||
return movedIntact(base, head, landed, chosen) ? chosen : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves too large for the drift search, among the regions it left unexplained: two regions alike across an axis
|
||||
* and side by side along it, one darker and one brighter, are the two ends of something that moved. Where the
|
||||
* content left must be plain backdrop in After for that region to be part of the move; anything drawn there is a
|
||||
* change of its own and stays one. A move that checks out also takes in any other unexplained region it explains
|
||||
* (fragments of the same element where its old and new places overlap), and its outline is the moved content in After.
|
||||
*/
|
||||
export function regionMoves(baseFrame: DecodedFrame, headFrame: DecodedFrame,
|
||||
regions: ReadonlyArray<Rect & { dominantChange?: string }>, shifts: ReadonlyArray<RegionShift | undefined>): RegionMove[] {
|
||||
if (baseFrame.width !== headFrame.width || baseFrame.height !== headFrame.height) return [];
|
||||
const base = image(baseFrame), head = image(headFrame);
|
||||
const clipped = regions.map(region => clip(region, head.width, head.height));
|
||||
const open = new Set(regions.map((_, index) => index).filter(index => !shifts[index] && clipped[index]!.width > 0 && clipped[index]!.height > 0));
|
||||
const moves: RegionMove[] = [];
|
||||
// Largest first: the element that moved the most content is the one a reader is looking at.
|
||||
const order = [...open].sort((left, right) => clipped[right]!.width * clipped[right]!.height - clipped[left]!.width * clipped[left]!.height);
|
||||
for (let first = 0; first < order.length; first += 1) {
|
||||
for (let second = first + 1; second < order.length; second += 1) {
|
||||
const i = order[first]!, j = order[second]!;
|
||||
if (!open.has(i) || !open.has(j)) continue;
|
||||
const opposite = new Set([regions[i]!.dominantChange, regions[j]!.dominantChange]);
|
||||
if (!(opposite.has("brighter") && opposite.has("darker"))) continue;
|
||||
const a = clipped[i]!, b = clipped[j]!;
|
||||
for (const axis of ["x", "y"] as const) {
|
||||
if (!pairAlong(a, b, axis)) continue;
|
||||
// Either could be where the content arrived; the pixels decide which.
|
||||
const forward = pairMove(base, head, a, b, axis);
|
||||
const shift = forward ?? pairMove(base, head, b, a, axis);
|
||||
if (!shift) continue;
|
||||
const [leftIndex, arrivedIndex] = forward ? [i, j] : [j, i];
|
||||
const left = clipped[leftIndex]!, arrived = clipped[arrivedIndex]!;
|
||||
let rect = clip(union(arrived, { ...left, x: left.x + shift.x, y: left.y + shift.y }), head.width, head.height);
|
||||
open.delete(i); open.delete(j);
|
||||
// Where the content left: plain backdrop belongs to the move, anything drawn there is a change of its own.
|
||||
const members = outside(left, rect, axis).every(part => plain(head, part, rect)) ? [arrivedIndex, leftIndex] : [arrivedIndex];
|
||||
// Fragments of the same element inside its new place, where the old and new overlap.
|
||||
for (const k of [...open]) {
|
||||
const fragment = clipped[k]!;
|
||||
const inside = fragment.x >= rect.x && fragment.y >= rect.y && fragment.x + fragment.width <= rect.x + rect.width && fragment.y + fragment.height <= rect.y + rect.height;
|
||||
if (!inside || !movedIntact(base, head, fragment, shift)) continue;
|
||||
members.push(k); open.delete(k); rect = union(rect, fragment);
|
||||
}
|
||||
moves.push({ rect, shift, members });
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
return moves;
|
||||
}
|
||||
|
||||
/** Reads both PNG screenshots and measures each region's shift. */
|
||||
export async function measureRegionShifts(basePath: string, headPath: string, regions: readonly Rect[]): Promise<Array<RegionShift | undefined>> {
|
||||
const [base, head] = await readFrames(basePath, headPath);
|
||||
return regionShifts(base, head, regions);
|
||||
}
|
||||
|
||||
/** Reads both PNG screenshots once and measures each region's shift, then the large moves the rest show. */
|
||||
export async function measureRegionMoves(basePath: string, headPath: string, regions: ReadonlyArray<Rect & { dominantChange?: string }>):
|
||||
Promise<{ shifts: Array<RegionShift | undefined>; moves: RegionMove[]; width: number; height: number }> {
|
||||
const [base, head] = await readFrames(basePath, headPath);
|
||||
const shifts = regionShifts(base, head, regions);
|
||||
return { shifts, moves: regionMoves(base, head, regions, shifts), width: head.width, height: head.height };
|
||||
}
|
||||
|
||||
async function readFrames(basePath: string, headPath: string): Promise<[DecodedFrame, DecodedFrame]> {
|
||||
const { PNG } = createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs") as
|
||||
{ PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
|
||||
const [base, head] = await Promise.all([readFile(basePath), readFile(headPath)]);
|
||||
return regionShifts(PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false }), regions);
|
||||
return [PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false })];
|
||||
}
|
||||
@@ -28,6 +28,7 @@ export type ReviewerChangeTemplateId =
|
||||
| "element.removed"
|
||||
| "visible-text.changed-short"
|
||||
| "visible-text.changed-long"
|
||||
| "visible-text.unstable-within-build"
|
||||
| "interaction.target-changed"
|
||||
| "accessibility.label-changed"
|
||||
| "accessibility.role-changed"
|
||||
@@ -95,6 +96,19 @@ export type VisibleTextReviewerChange = {
|
||||
after: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* A label that differs between the two builds but also between two captures of the same build (its light and dark
|
||||
* appearances): a clock, a relative time, a random name. Runtime state, not a change.
|
||||
*/
|
||||
export type UnstableTextReviewerChange = {
|
||||
kind: "unstable-text";
|
||||
subjectRole: ReviewerSubjectRole;
|
||||
before: string;
|
||||
after: string;
|
||||
/** What the same build showed in its other capture. */
|
||||
within: string;
|
||||
};
|
||||
|
||||
export type InteractionReviewerChange = {
|
||||
kind: "action-target-changed";
|
||||
subjectRole: ReviewerSubjectRole;
|
||||
@@ -121,7 +135,7 @@ export type VisualReviewerChange = {
|
||||
kind: "visual-changed";
|
||||
scope:
|
||||
| { kind: "landmark"; label: string }
|
||||
| { kind: "main-content" };
|
||||
| { kind: "main-content"; near?: "top" | "bottom" };
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -134,6 +148,7 @@ export type SupportedReviewerChange =
|
||||
| ScreenReviewerChange
|
||||
| ElementReviewerChange
|
||||
| VisibleTextReviewerChange
|
||||
| UnstableTextReviewerChange
|
||||
| InteractionReviewerChange
|
||||
| AccessibilityReviewerChange
|
||||
| VisualReviewerChange
|
||||
@@ -387,6 +402,28 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
|
||||
},
|
||||
};
|
||||
}
|
||||
case "unstable-text": {
|
||||
const before = compact(change.before);
|
||||
const after = compact(change.after);
|
||||
const within = compact(change.within);
|
||||
if (!before || !after || !within) return invalidChange("An unstable-text change requires all three labels.", evidenceRefs);
|
||||
if (before === after) return invalidChange("An unstable-text change has identical labels.", evidenceRefs);
|
||||
const seen = [...new Set([before, within, after])];
|
||||
return {
|
||||
kind: "fact",
|
||||
fact: {
|
||||
category: "visible-text",
|
||||
templateId: "visible-text.unstable-within-build",
|
||||
bullet: `Text varies between captures of the same build: ${seen.map(quote).join(" / ")}.`,
|
||||
subjectRole: change.subjectRole,
|
||||
subjectLabel: after,
|
||||
before,
|
||||
after,
|
||||
priority: PRIORITY["visible-text"],
|
||||
evidenceRefs,
|
||||
},
|
||||
};
|
||||
}
|
||||
case "accessibility-label-changed": {
|
||||
const before = compact(change.before);
|
||||
const after = compact(change.after);
|
||||
@@ -466,7 +503,7 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
|
||||
fact: {
|
||||
category: "visual",
|
||||
templateId: "visual.main-content-changed",
|
||||
bullet: "Updated visual styling in the main content area.",
|
||||
bullet: change.scope.near ? `Updated visual styling near the ${change.scope.near} of the screen.` : "Updated visual styling in the main content area.",
|
||||
subjectRole: "content",
|
||||
subjectLabel: "Main content",
|
||||
priority: PRIORITY.visual,
|
||||
|
||||
@@ -38,6 +38,40 @@ export function frameChangedForTap(first: DecodedFrame, second: DecodedFrame, y:
|
||||
return !first.data.subarray(start).equals(second.data.subarray(start));
|
||||
}
|
||||
|
||||
/** The decoded frame, or undefined when the bytes are not a PNG pngjs can read. */
|
||||
export function decodePng(png: Buffer): DecodedFrame | undefined {
|
||||
try { return createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs").PNG.sync.read(png, { checkCRC: false }) as DecodedFrame; }
|
||||
catch { return undefined; }
|
||||
}
|
||||
|
||||
/** agent-device's rule for a changed pixel: an RGB distance above `threshold` of the longest diagonal. */
|
||||
export function maxColorDistance(threshold: number): number {
|
||||
return threshold * Math.sqrt(3 * 255 ** 2);
|
||||
}
|
||||
|
||||
/** How many pixels of `rect` (clipped to the frames) differ between two same-sized frames by agent-device's rule. */
|
||||
export function differentPixelsInRect(
|
||||
first: DecodedFrame,
|
||||
second: DecodedFrame,
|
||||
rect: { x: number; y: number; width: number; height: number },
|
||||
distance: number,
|
||||
): number {
|
||||
if (first.width !== second.width || first.height !== second.height) return 0;
|
||||
const left = Math.max(0, rect.x); const right = Math.min(first.width, rect.x + rect.width);
|
||||
const top = Math.max(0, rect.y); const bottom = Math.min(first.height, rect.y + rect.height);
|
||||
let count = 0;
|
||||
for (let y = top; y < bottom; y += 1) {
|
||||
for (let x = left; x < right; x += 1) {
|
||||
const offset = (y * first.width + x) * 4;
|
||||
const r = first.data[offset]! - second.data[offset]!;
|
||||
const g = first.data[offset + 1]! - second.data[offset + 1]!;
|
||||
const b = first.data[offset + 2]! - second.data[offset + 2]!;
|
||||
if (Math.sqrt(r * r + g * g + b * b) > distance) count += 1;
|
||||
}
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
export function assertDecodedPng(contents: Buffer, label: string): void {
|
||||
const signature = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
|
||||
if (contents.length < 45 || !contents.subarray(0, 8).equals(signature)) {
|
||||
|
||||
@@ -2,6 +2,7 @@ import { createHash } from "node:crypto";
|
||||
import { canonicalizeSourceChanges, type SourceChange } from "./git-diff.js";
|
||||
import type { SourceChangeSummary } from "./change-summary.js";
|
||||
import { hasRuntimeChange, readSourceSnapshot, surfaceDependencies, type SourceSnapshot } from "./dependency-graph.js";
|
||||
import { sameCodeIgnoringTrivia } from "./trivia.js";
|
||||
import { discoverRoutes, type DiscoverRouteOptions } from "./route-inventory.js";
|
||||
import { sourceRouteNames, validateSourceRoutes, type SourceRoute } from "../contracts/source-route.js";
|
||||
import { navigationCaptureContext, type NavigationGraph } from "../contracts/navigation-graph.js";
|
||||
@@ -120,7 +121,15 @@ export function createSourceCapturePlan(options: CapturePlanOptions): SourceCapt
|
||||
const headRoutes = checkedRoutes(options.headRoutes, headInventory.routes, "head");
|
||||
const base = surfaceDependencies(baseRoutes, options.baseFiles, options.platform);
|
||||
const head = surfaceDependencies(headRoutes, options.headFiles, options.platform);
|
||||
const changes = canonicalizeSourceChanges(options.changedFiles).filter(change => !/(?:^|\/)surfaces?\.json$/.test(change.path));
|
||||
// A file whose two versions differ only in comments or whitespace compiles to the same program, so it changes no screen.
|
||||
// Parsed once per path: every surface that imports a shared file asks about it.
|
||||
const trivia = new Map<string, boolean>();
|
||||
const triviaOnly = (path: string) => {
|
||||
if (!trivia.has(path)) trivia.set(path, sameCodeIgnoringTrivia(path, options.baseFiles.get(path), options.headFiles.get(path)));
|
||||
return trivia.get(path)!;
|
||||
};
|
||||
const changes = canonicalizeSourceChanges(options.changedFiles).filter(change => !/(?:^|\/)surfaces?\.json$/.test(change.path)
|
||||
&& !(change.status === "modified" && triviaOnly(change.path)));
|
||||
const changedPaths = new Set(changes.flatMap(change => [change.path, ...("previousPath" in change ? [change.previousPath] : [])]));
|
||||
const externalRuntimeChange = hasRuntimeChange(options.externalChanges ?? []);
|
||||
const unresolved = [...new Set([...base.unresolved, ...head.unresolved,
|
||||
@@ -138,7 +147,7 @@ export function createSourceCapturePlan(options: CapturePlanOptions): SourceCapt
|
||||
const headSurface = headById.get(id) ?? null;
|
||||
const dependencies = new Set([...(baseSurface?.sourceFiles ?? []), ...(headSurface?.sourceFiles ?? [])]);
|
||||
const touched = [...changedPaths].filter(path => dependencies.has(path)).sort();
|
||||
const sourceChanged = baseSurface && headSurface && [...dependencies].some(path => options.baseFiles.get(path) !== options.headFiles.get(path));
|
||||
const sourceChanged = baseSurface && headSurface && [...dependencies].some(path => options.baseFiles.get(path) !== options.headFiles.get(path) && !triviaOnly(path));
|
||||
const definitionChanged = baseSurface && headSurface && canonicalJSON(baseSurface) !== canonicalJSON(headSurface);
|
||||
// A redirect renders no interface: only its own declaration can change what it does, so
|
||||
// imported or app-wide edits cannot make it a reviewable difference.
|
||||
|
||||
@@ -3,6 +3,7 @@ import ts from "typescript";
|
||||
import { parseTwoDotNameStatus, type SourceChange } from "./git-diff.js";
|
||||
import type { SourceCapturePlan } from "./capture-plan.js";
|
||||
import { DEFAULT_GLOBAL_IMPACT_PATHS } from "./impact.js";
|
||||
import { sameCodeIgnoringTrivia } from "./trivia.js";
|
||||
import { sourceImpactKinds, sourceImpactSentences } from "../contracts/source-change.js";
|
||||
|
||||
export type SourceLineRange = { start: number; end: number };
|
||||
@@ -376,10 +377,13 @@ function changedPaths(change: SourceChange): string[] {
|
||||
return [change.path, ...("previousPath" in change ? [change.previousPath] : [])];
|
||||
}
|
||||
|
||||
/** A modified file whose program did not change (comments or whitespace only) leaves no evidence: it changes no screen. */
|
||||
type FileEvidence = Omit<SourceFileChangeSummary, "relation"> | { triviaOnly: true };
|
||||
|
||||
function fileEvidence(options: {
|
||||
baseProject: string; headProject: string; baseSha: string; headSha: string;
|
||||
change: SourceChange; budget: { remaining: number };
|
||||
}): Omit<SourceFileChangeSummary, "relation"> {
|
||||
}): FileEvidence {
|
||||
const { change } = options;
|
||||
const previousPath = "previousPath" in change ? change.previousPath : undefined;
|
||||
const base = readBlob(options.baseProject, options.baseSha, previousPath ?? change.path, options.budget);
|
||||
@@ -392,6 +396,7 @@ function fileEvidence(options: {
|
||||
baseStart: Number(match[1]), baseLines: Number(match[2] ?? 1),
|
||||
headStart: Number(match[3]), headLines: Number(match[4] ?? 1),
|
||||
}));
|
||||
if (change.status === "modified" && !base.truncated && !head.truncated && sameCodeIgnoringTrivia(change.path, base.source, head.source)) return { triviaOnly: true };
|
||||
const extracted = base.truncated || head.truncated ? undefined : codeFacts(change.path, base.source ?? "", head.source ?? "");
|
||||
const facts = extracted?.length ? extracted : [{
|
||||
kind: "code" as const,
|
||||
@@ -461,7 +466,7 @@ export function createSourceChangeSummaries(options: {
|
||||
], 4 * 1024 * 1024).stdout));
|
||||
if (changes.length > SOURCE_CHANGE_SUMMARY_LIMITS.changedFiles) throw new Error("Source summary exceeds changed-file limit");
|
||||
const globals = new Set<string>([...DEFAULT_GLOBAL_IMPACT_PATHS.filter((path) => !path.endsWith("/")), "tsconfig.json"]);
|
||||
const cache = new Map<string, Omit<SourceFileChangeSummary, "relation">>();
|
||||
const cache = new Map<string, FileEvidence>();
|
||||
const budget = { remaining: SOURCE_CHANGE_SUMMARY_LIMITS.totalSourceBytes };
|
||||
const summaries: Record<string, SourceChangeSummary> = {};
|
||||
for (const surface of plan.surfaces) {
|
||||
@@ -480,18 +485,23 @@ export function createSourceChangeSummaries(options: {
|
||||
!/^(?:\.github\/|docs\/|tests?\/|scripts\/)|(?:\.md$|\.(?:test|spec)\.[jt]sx?$)/.test(path)
|
||||
))));
|
||||
}
|
||||
const selected = relevant.sort((left, right) => {
|
||||
const ranked = relevant.sort((left, right) => {
|
||||
const rank = { route: 0, "declared-source": 1, dependency: 2, global: 3 };
|
||||
return rank[relation(surface, left)] - rank[relation(surface, right)] || left.path.localeCompare(right.path);
|
||||
}).slice(0, SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface);
|
||||
const files = selected.map((change): SourceFileChangeSummary => {
|
||||
});
|
||||
// A comment-only file leaves no evidence, so it does not take one of the surface's file slots either.
|
||||
const files: SourceFileChangeSummary[] = [];
|
||||
let considered = 0;
|
||||
for (const change of ranked) {
|
||||
if (files.length === SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface) break;
|
||||
considered += 1;
|
||||
let evidence = cache.get(change.path);
|
||||
if (!evidence) {
|
||||
evidence = fileEvidence({ ...options, baseSha: plan.baseSha, headSha: plan.headSha, change, budget });
|
||||
cache.set(change.path, evidence);
|
||||
}
|
||||
return { ...evidence, relation: relation(surface, change) };
|
||||
});
|
||||
if (!("triviaOnly" in evidence)) files.push({ ...evidence, relation: relation(surface, change) });
|
||||
}
|
||||
const impact: SourceChangeSummary["impact"] = files.some((file) => file.relation === "route" || file.relation === "declared-source")
|
||||
? "direct" : files.some((file) => file.relation === "dependency") ? "dependency"
|
||||
: globalImpact || (surface.status === "modified" && plan.conservative) ? "global"
|
||||
@@ -501,7 +511,7 @@ export function createSourceChangeSummaries(options: {
|
||||
baseSha: plan.baseSha, headSha: plan.headSha, impact,
|
||||
summary: summaryText(surface, impact, files),
|
||||
files,
|
||||
truncated: relevant.length > selected.length || files.some((file) => file.truncated),
|
||||
truncated: ranked.length > considered || files.some((file) => file.truncated),
|
||||
};
|
||||
}
|
||||
return summaries;
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
import ts from "typescript";
|
||||
|
||||
const code = /\.([cm]?[jt]sx?)$/;
|
||||
/** Comments a compiler or bundler reads: JSX pragmas, Flow, pure annotations, Fast Refresh, Haste names and import hints. */
|
||||
const directive = /[@#]\s*(?:jsx\w*|flow|noflow|__[A-Z_]+__|refresh|providesModule)\b[^\r\n*]*|webpack[A-Z]\w*\s*:[^\r\n*]*|@vite-ignore/g;
|
||||
|
||||
function scriptKind(path: string): ts.ScriptKind {
|
||||
const extension = code.exec(path)?.[1] ?? "";
|
||||
if (extension === "tsx") return ts.ScriptKind.TSX;
|
||||
if (extension.endsWith("ts")) return ts.ScriptKind.TS;
|
||||
if (extension === "jsx") return ts.ScriptKind.JSX;
|
||||
return ts.ScriptKind.JS;
|
||||
}
|
||||
|
||||
/**
|
||||
* JSX text as the JSX transform keeps it (Babel's `cleanJSXElementLiteralChild`): each line is trimmed where it meets a
|
||||
* line break, blank lines are dropped and the rest are joined by a space. Space within a line is kept, and so is a tab.
|
||||
*/
|
||||
function jsxText(raw: string): string {
|
||||
const lines = raw.split(/\r\n|\n|\r/);
|
||||
let last = 0;
|
||||
lines.forEach((line, index) => { if (/[^ \t]/.test(line)) last = index; });
|
||||
let text = "";
|
||||
lines.forEach((line, index) => {
|
||||
let trimmed = index > 0 ? line.replace(/^[ \t]+/, "") : line;
|
||||
if (index < lines.length - 1) trimmed = trimmed.replace(/[ \t]+$/, "");
|
||||
if (trimmed) text += index === last ? trimmed : `${trimmed} `;
|
||||
});
|
||||
return text;
|
||||
}
|
||||
|
||||
/**
|
||||
* The program a file compiles to, in order: its syntax tree's nodes and tokens, JSX text as the transform keeps it, and
|
||||
* any directive comment. Other comments and the whitespace between tokens are not part of it. The tree keeps a line
|
||||
* break that changes the program (`return` then a value on the next line), and drops one that does not.
|
||||
*/
|
||||
function tokens(path: string, text: string): string[] | undefined {
|
||||
const file = ts.createSourceFile(path, text, ts.ScriptTarget.Latest, false, scriptKind(path));
|
||||
const { parseDiagnostics } = file as unknown as { parseDiagnostics?: unknown[] };
|
||||
if (!parseDiagnostics || parseDiagnostics.length > 0) return undefined;
|
||||
const out: string[] = [];
|
||||
const directives = (trivia: string): void => {
|
||||
for (const [match] of trivia.matchAll(directive)) out.push(`directive:${match.replace(/\s+/g, " ").trim()}`);
|
||||
};
|
||||
const visit = (node: ts.Node): void => {
|
||||
if (ts.isJsxExpression(node) && !node.expression) return directives(text.slice(node.pos, node.end)); // `{/* a comment */}` compiles to nothing
|
||||
if (node.kind >= ts.SyntaxKind.FirstJSDocNode && node.kind <= ts.SyntaxKind.LastJSDocNode) return; // a comment the parser attaches, read below as trivia
|
||||
if (node.kind === ts.SyntaxKind.JsxText) {
|
||||
const value = jsxText(text.slice(node.pos, node.end));
|
||||
if (value) out.push(`${node.kind}:${value}`);
|
||||
return;
|
||||
}
|
||||
if (node.getChildCount(file) === 0) {
|
||||
directives(text.slice(node.pos, node.getStart(file)));
|
||||
if (node.kind !== ts.SyntaxKind.EndOfFileToken) out.push(`${node.kind}:${node.getText(file)}`);
|
||||
return;
|
||||
}
|
||||
out.push(`${node.kind}(`);
|
||||
node.getChildren(file).forEach(visit);
|
||||
out.push(")");
|
||||
};
|
||||
visit(file);
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether two versions of a JavaScript or TypeScript file compile to the same program: the same syntax tree with the
|
||||
* same tokens, so only comments, blank lines, indentation or line endings differ. Such an edit cannot change what a
|
||||
* screen renders, so the planner does not treat it as a change to the files that import it. JSX text keeps the
|
||||
* whitespace the transform keeps (a space inside a `<Text>` renders), a comment a compiler reads (`@jsx`, `#__PURE__`)
|
||||
* counts, a file that does not parse is never called the same, and neither are two identical texts: a diff entry a
|
||||
* caller supplies for them is theirs to explain (a mode change, a fixture).
|
||||
*/
|
||||
export function sameCodeIgnoringTrivia(path: string, base: string | undefined, head: string | undefined): boolean {
|
||||
if (base === undefined || head === undefined || !code.test(path)) return false;
|
||||
if (base === head) return false;
|
||||
const before = tokens(path, base);
|
||||
const after = before && tokens(path, head);
|
||||
return Boolean(before && after && before.length === after.length && before.every((token, index) => token === after[index]));
|
||||
}
|
||||
@@ -11,8 +11,8 @@
|
||||
# secrets: inherit
|
||||
#
|
||||
# Call it once per workflow run: a called workflow shares its caller's run, and its artifact names come from the run.
|
||||
# The report links are written to the run's summary. For a release, pass scope: all to capture every screen,
|
||||
# and expires-in: never to keep the hosted link (report.preview.hosting: eas) working.
|
||||
# The report links are written to the run's summary. For a release, pass scope: all to capture every screen. A hosted
|
||||
# link (report.preview.hosting: eas) lasts as long as its EAS Hosting deployment; expires-in is accepted and ignored.
|
||||
name: Expo Explore compare
|
||||
on:
|
||||
workflow_dispatch:
|
||||
@@ -20,13 +20,13 @@ on:
|
||||
base: { description: 'Base: a branch, tag or commit SHA', required: true }
|
||||
head: { description: 'Head: a branch, tag or commit SHA', required: true }
|
||||
scope: { description: 'changes (screens whose source changed) or all; default: exploration.scope in config.yaml', required: false, default: '' }
|
||||
expires-in: { description: 'Hosted link lifetime such as 30d, or never; default: report.preview.expiresAfter', required: false, default: '' }
|
||||
expires-in: { description: 'Ignored: kept for workflows that pass it. A hosted preview lasts as long as its EAS Hosting deployment.', required: false, default: '' }
|
||||
workflow_call:
|
||||
inputs:
|
||||
base: { description: 'Base: a branch, tag or commit SHA', required: true, type: string }
|
||||
head: { description: 'Head: a branch, tag or commit SHA', required: true, type: string }
|
||||
scope: { description: 'changes (screens whose source changed) or all; default: exploration.scope in config.yaml', required: false, type: string, default: '' }
|
||||
expires-in: { description: 'Hosted link lifetime such as 30d, or never; default: report.preview.expiresAfter', required: false, type: string, default: '' }
|
||||
expires-in: { description: 'Ignored: kept for workflows that pass it. A hosted preview lasts as long as its EAS Hosting deployment.', required: false, type: string, default: '' }
|
||||
permissions: {}
|
||||
env:
|
||||
# The exact @expo/explore release CI installs. expo-explore setup --workflows sets it.
|
||||
|
||||
@@ -75,6 +75,9 @@ async function harness(t, bytes, { app = false, open = true, name = fileName, re
|
||||
const pagePath = preview ? `/p/${preview.token}` : "/r";
|
||||
// What the preview Worker serves from the decrypted ZIP: the manifest the Viewer opens, and each asset on request.
|
||||
const served = preview && bytes ? await unzipped(bytes) : undefined;
|
||||
// `archives` by query gives a target its own report; every other query gets `bytes`.
|
||||
const servedBy = Object.fromEntries(await Promise.all(Object.entries(preview?.archives ?? {}).map(async ([search, zip]) => [search, await unzipped(zip)])));
|
||||
const servedFor = search => servedBy[search] ?? served;
|
||||
const vite = await createBrowserVite(t, { configFile: false,
|
||||
root: fileURLToPath(new URL("../../viewer", import.meta.url)), logLevel: "error", esbuild: { jsx: "automatic" },
|
||||
server: { host: "127.0.0.1", port: 0 }, plugins: [{ name: "report-page-fixture", configureServer(server) {
|
||||
@@ -85,14 +88,19 @@ async function harness(t, bytes, { app = false, open = true, name = fileName, re
|
||||
preview.requests = (preview.requests ?? 0) + 1;
|
||||
preview.queries = [...(preview.queries ?? []), url.search];
|
||||
if (preview.status && preview.status !== 200) { response.statusCode = preview.status; return response.end(preview.body ?? "Not found"); }
|
||||
// A target the Worker cannot read (`failures` by query) answers with that status.
|
||||
if (preview.failures?.[url.search]) { response.statusCode = preview.failures[url.search]; return response.end("Unavailable"); }
|
||||
response.setHeader("content-type", "application/json");
|
||||
// A slow target (`delays` by query) keeps its manifest in flight while the reviewer moves on.
|
||||
// `padding` makes the manifest larger than the Viewer reads.
|
||||
const body = preview.padding ? " ".repeat(preview.padding) + served.manifest : served.manifest;
|
||||
const manifest = servedFor(url.search).manifest;
|
||||
const body = preview.padding ? " ".repeat(preview.padding) + manifest : manifest;
|
||||
return void setTimeout(() => response.end(body), preview.delays?.[url.search] ?? 0);
|
||||
}
|
||||
if (preview && url.pathname.startsWith(`${pagePath}/assets/`)) {
|
||||
const asset = served.files.get(url.pathname.slice(pagePath.length + 1));
|
||||
// Screenshot URLs name no target: any report of the deployment may hold one.
|
||||
const name = url.pathname.slice(pagePath.length + 1);
|
||||
const asset = [served, ...Object.values(servedBy)].map(report => report.files.get(name)).find(Boolean);
|
||||
if (!asset) { response.statusCode = 404; return response.end("Not found"); }
|
||||
response.setHeader("content-type", "application/octet-stream");
|
||||
response.setHeader("content-length", String(asset.length));
|
||||
@@ -266,6 +274,8 @@ test("choosing the report file opens it with the link's selection and keeps Modi
|
||||
await expect(page.locator("html")).toHaveAttribute("data-theme", "light");
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
const screenshot = page.locator(".screens-page img[data-screenshot-src]").first();
|
||||
// The placeholder is the screenshot's size too, so wait for the screenshot itself.
|
||||
await expect(screenshot).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect.poll(() => screenshot.evaluate(image => image.naturalWidth)).toBe(32);
|
||||
const screenshotUrl = await screenshot.getAttribute("src");
|
||||
assert.match(page.url(), /#\/screens/);
|
||||
@@ -322,6 +332,8 @@ test("a reload and a later per-screen link reopen the dropped report from the br
|
||||
await expect(page.getByText("Greeting changed from Hello to Welcome", { exact: true })).toBeVisible();
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
const screenshot = page.locator(".screens-page img[data-screenshot-src]").first();
|
||||
// The placeholder is the screenshot's size too, so wait for the screenshot itself.
|
||||
await expect(screenshot).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect.poll(() => screenshot.evaluate(image => image.naturalWidth)).toBe(32);
|
||||
// Comment links to one screen carry the same run identity, so they open without a new drop.
|
||||
await page.goto(`${origin}/r?${new URLSearchParams(identity)}&screen=home&inspect=diff`);
|
||||
@@ -425,15 +437,6 @@ test("a hosted preview link downloads the report from its own token route, opens
|
||||
await expect(shell).toContainText("This preview link is not valid, or its deployment was deleted");
|
||||
await expect(expired.page.locator(".report-drop-input")).toHaveCount(0);
|
||||
assert.deepEqual(expired.errors, []);
|
||||
|
||||
// A deployment past its sealed expiry still opens and says when the link expired.
|
||||
const gone = await harness(t, await archive(), { app: true, reportIdentity: null,
|
||||
preview: { ...preview, token: "cdefghijklmnopqrstuvwxyz23456723", status: 410, body: JSON.stringify({ error: "expired", expiredAt: "2030-01-01T00:00:00.000Z" }) } });
|
||||
const goneShell = gone.page.locator(".report-loading-shell");
|
||||
await expect(goneShell).toHaveAttribute("data-loading-status", "failed");
|
||||
await expect(goneShell).toContainText("This preview link expired on Jan 1, 2030. Download the report from the pull request or workflow run instead");
|
||||
await expect(gone.page.locator(".report-drop-input")).toHaveCount(0);
|
||||
assert.deepEqual(gone.errors, []);
|
||||
});
|
||||
|
||||
test("a hosted run of several targets opens the linked target and switches between all of them in config order", { timeout: 60_000 }, async t => {
|
||||
@@ -544,6 +547,30 @@ test("switching back to a prefetched target shows the screenshots it showed befo
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a target whose download fails leaves the report on screen and its link, and a toast says why", { timeout: 60_000 }, async t => {
|
||||
const report = reportFixture();
|
||||
report.review.runtime = { ...report.review.runtime, platform: "android", platforms: ["ios", "android"] };
|
||||
const preview = { token: "mnopqrstuvwxyz234567234567234567", listing: [{ platform: "ios" }, { platform: "android" }],
|
||||
failures: { "?platform=ios": 500 } };
|
||||
const { page, errors } = await harness(t, await archive(report), { app: true, reportIdentity: null, preview, query: "&platform=android" });
|
||||
const trigger = page.getByRole("button", { name: "Platform: Android. Open another platform's report" });
|
||||
await expect(trigger).toBeVisible();
|
||||
await page.evaluate(() => { window.__samePage = true; });
|
||||
const place = new URL(page.url()).hash;
|
||||
await trigger.click();
|
||||
await page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio").nth(0).click();
|
||||
await expect(page.locator(".app-toast")).toContainText("Couldn’t open iOS");
|
||||
await expect(page.locator(".app-toast")).toContainText("The report could not be downloaded (HTTP 500).");
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
await expect(page.locator(".report-loading-shell")).toHaveCount(0);
|
||||
await expect(trigger).not.toHaveAttribute("aria-busy", /.*/);
|
||||
// The link is the Android report's again, at the place it was.
|
||||
await expect.poll(() => new URL(page.url()).searchParams.get("platform")).toBe("android");
|
||||
assert.equal(new URL(page.url()).hash, place);
|
||||
assert.equal(await page.evaluate(() => window.__samePage), true, "the failed switch stays on the page");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("Forward onto a target still downloading keeps the preview link and its place in history", { timeout: 60_000 }, async t => {
|
||||
const { page, errors, switchToIos } = await slowSwitchHarness(t, "jklmnopqrstuvwxyz234567234567234", 3000);
|
||||
await page.evaluate(() => { window.location.hash = "#/map?inspect=diff"; });
|
||||
@@ -566,6 +593,60 @@ test("Forward onto a target still downloading keeps the preview link and its pla
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a switch to a target whose screenshots have another shape lays the map out again for its cards, so none overlap", { timeout: 60_000 }, async t => {
|
||||
const targets = [
|
||||
{ id: "iphone", platform: "ios", label: "iPhone 17" },
|
||||
{ id: "duo-open", platform: "ios", label: "iPhone Duo (open)" },
|
||||
];
|
||||
// Home leads to Settings and About, Settings on to Profile: three layers, so the map runs left to right with
|
||||
// Settings and About stacked, a card's height plus a gap apart. A Duo card is shorter than a phone's.
|
||||
const shaped = async (target, width, height) => {
|
||||
const picture = new PNG({ width, height });
|
||||
picture.data.fill(255);
|
||||
const capture = PNG.sync.write(picture);
|
||||
const report = reportFixture();
|
||||
const home = report.review.surfaces[0];
|
||||
for (const side of ["baseImage", "headImage"]) {
|
||||
Object.assign(home[side], { width, height, sha256: createHash("sha256").update(capture).digest("hex") });
|
||||
}
|
||||
const route = id => {
|
||||
const side = { ...home.head, id, route: `/${id}`, path: `/${id}`, routeFile: `app/${id}.tsx`, logicalPath: `app/${id}.tsx` };
|
||||
return { id, status: "unchanged", base: { ...side }, head: side, baseImage: { ...home.baseImage }, headImage: { ...home.headImage },
|
||||
baseOutcome: { ...home.baseOutcome }, headOutcome: { ...home.headOutcome } };
|
||||
};
|
||||
report.review.surfaces.push(route("settings"), route("about"), route("profile"));
|
||||
const edge = (from, to) => ({ from, to, kind: "push", provenance: "source", sourceFile: `app/${from}.tsx` });
|
||||
const graph = { contract: "explore.navigation", edges: [edge("home", "settings"), edge("home", "about"), edge("settings", "profile")],
|
||||
modalSurfaceIds: [], unresolved: [] };
|
||||
report.review.navigation = { base: structuredClone(graph), head: graph };
|
||||
report.review.runtime = { ...report.review.runtime, platform: "ios", platforms: ["ios"], target: targets.find(entry => entry.id === target), targets };
|
||||
return Buffer.from((await imageArchive([capture], 0, report)).bytes);
|
||||
};
|
||||
const preview = { token: "klmnopqrstuvwxyz2345672345672345",
|
||||
listing: targets.map(({ id, platform, label }) => ({ target: id, platform, label })),
|
||||
archives: { "?target=iphone": await shaped("iphone", 130, 282) } };
|
||||
const { page, errors } = await harness(t, await shaped("duo-open", 233, 339), { app: true, reportIdentity: null, preview,
|
||||
query: "&target=duo-open" });
|
||||
const nodes = page.locator(".map-canvas .react-flow__node");
|
||||
await expect(nodes).toHaveCount(4);
|
||||
/** Overlaps between the cards' boxes on screen, and how tall the cards stand against their width. */
|
||||
const layout = () => nodes.evaluateAll(elements => {
|
||||
const boxes = elements.map(element => element.getBoundingClientRect());
|
||||
let overlaps = 0;
|
||||
for (const [index, a] of boxes.entries()) for (const b of boxes.slice(index + 1)) {
|
||||
if (a.left < b.right - 1 && b.left < a.right - 1 && a.top < b.bottom - 1 && b.top < a.bottom - 1) overlaps += 1;
|
||||
}
|
||||
return { overlaps, shape: Math.round(boxes[0].height / boxes[0].width * 10) / 10 };
|
||||
});
|
||||
await expect.poll(layout).toEqual({ overlaps: 0, shape: 1.6 });
|
||||
|
||||
await page.getByRole("button", { name: "Device: iPhone Duo (open). Open another device's report" }).click();
|
||||
await page.getByRole("menu", { name: "Device" }).getByRole("menuitemradio").nth(0).click();
|
||||
await expect(page.locator(".collapsed-platform").first()).toHaveText("iPhone 17");
|
||||
await expect.poll(layout, { timeout: 10_000 }).toEqual({ overlaps: 0, shape: 2.3 });
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a hosted manifest larger than the Viewer reads is refused before it is parsed", { timeout: 60_000 }, async t => {
|
||||
const preview = { token: "klmnopqrstuvwxyz2345672345672345", padding: 11 * 1024 * 1024 };
|
||||
const { page, errors } = await harness(t, await archive(), { app: true, reportIdentity: null, preview, query: "" });
|
||||
@@ -575,6 +656,95 @@ test("a hosted manifest larger than the Viewer reads is refused before it is par
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("D, ⌥1–⌥8 and ` switch targets from the keyboard, and the other report opens at the same place", { timeout: 60_000 }, async t => {
|
||||
const report = reportFixture();
|
||||
report.review.runtime = { ...report.review.runtime, platform: "android", platforms: ["ios", "android"] };
|
||||
const ios = reportFixture();
|
||||
ios.review.runtime = { ...ios.review.runtime, platform: "ios", platforms: ["ios", "android"] };
|
||||
const preview = { token: "ijklmnopqrstuvwxyz23456723456723", listing: [{ platform: "ios" }, { platform: "android" }],
|
||||
archives: { "?platform=ios": await archive(ios) } };
|
||||
// An Apple keyboard, where ⌥ digits reach the page (Linux browsers keep Alt+1–8 for their tabs).
|
||||
const { page, errors } = await harness(t, await archive(report), { app: true, reportIdentity: null, preview,
|
||||
query: "&platform=android&focus=modified&screen=home&inspect=diff",
|
||||
fault: () => { Object.defineProperty(Navigator.prototype, "platform", { get: () => "MacIntel" }); } });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
await expect.poll(() => new URL(page.url()).hash).toMatch(/^#\/map\/home\?/);
|
||||
const place = new URL(page.url()).hash;
|
||||
await page.evaluate(() => { window.__samePage = true; });
|
||||
const target = () => new URL(page.url()).searchParams.get("platform");
|
||||
// The other report swaps into the running Viewer (no loading screen between): the pill names it once it is up.
|
||||
const shown = async (label) => expect(page.locator(".collapsed-platform").first()).toHaveText(label);
|
||||
|
||||
// ` returns to the last target; before there is one, it opens the next in the menu.
|
||||
await page.keyboard.press("Backquote");
|
||||
await expect.poll(target).toBe("ios");
|
||||
await shown("iOS");
|
||||
const carried = new URL(page.url()).hash;
|
||||
assert.equal(carried.split("?")[0], place.split("?")[0], "the other report opens at the same canvas and route");
|
||||
assert.equal(new URLSearchParams(carried.split("?")[1]).get("inspect"), "diff");
|
||||
assert.equal(new URLSearchParams(carried.split("?")[1]).get("screen"), null, "a screen id belongs to one report");
|
||||
await expect(page.locator(".map-canvas .is-selected")).toHaveCount(1);
|
||||
await page.keyboard.press("Backquote");
|
||||
await expect.poll(target).toBe("android");
|
||||
await shown("Android");
|
||||
|
||||
// D opens the menu, which prints each target's ⌥ key.
|
||||
await page.keyboard.press("KeyD");
|
||||
const items = page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio");
|
||||
await expect(items).toHaveCount(2);
|
||||
assert.deepEqual(await items.evaluateAll(rows => rows.map(row => row.querySelector(".menu-row-shortcut")?.textContent)), ["⌥1", "⌥2"]);
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(items).toHaveCount(0);
|
||||
|
||||
await page.keyboard.press("Alt+Digit1");
|
||||
await expect.poll(target).toBe("ios");
|
||||
await shown("iOS");
|
||||
// The shown target's own key does nothing.
|
||||
await page.keyboard.press("Alt+Digit1");
|
||||
await page.keyboard.press("Alt+Digit2");
|
||||
await expect.poll(target).toBe("android");
|
||||
await shown("Android");
|
||||
assert.equal(await page.evaluate(() => window.__samePage), true, "every switch stays on the page");
|
||||
|
||||
await page.keyboard.press("Shift+Slash");
|
||||
const dialog = page.getByRole("dialog", { name: "Keyboard shortcuts" });
|
||||
await expect(dialog).toContainText("Another platform's report");
|
||||
await expect(dialog).toContainText("⌥1–⌥2");
|
||||
await expect(dialog).toContainText("Back to the last platform");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a target switch keeps the chosen appearance when the other report was captured in it, and its own otherwise", { timeout: 60_000 }, async t => {
|
||||
/** A report of `platform`, with every surface also captured in dark when `dark`. */
|
||||
const report = (platform, dark) => {
|
||||
const fixture = reportFixture();
|
||||
fixture.review.runtime = { ...fixture.review.runtime, platform, platforms: ["ios", "android"], ...(dark ? { colorSchemes: ["light", "dark"] } : {}) };
|
||||
if (dark) fixture.review.surfaces.push({ ...structuredClone(fixture.review.surfaces[0]), id: "home@dark", colorScheme: "dark" });
|
||||
return fixture;
|
||||
};
|
||||
const preview = { token: "klmnopqrstuvwxyz2345672345672345", listing: [{ platform: "ios" }, { platform: "android" }],
|
||||
archives: { "?platform=ios": await archive(report("ios", false)), "?platform=android": await archive(report("android", true)) } };
|
||||
const { page, errors } = await harness(t, await archive(report("android", true)), { app: true, reportIdentity: null, preview, query: "&platform=android" });
|
||||
const target = () => new URL(page.url()).searchParams.get("platform");
|
||||
const appearance = page.getByRole("button", { name: /^Appearance: / });
|
||||
await expect(appearance).toHaveText(/Light/);
|
||||
await page.keyboard.press("Shift+KeyT");
|
||||
await expect(appearance).toHaveText(/Dark/);
|
||||
// iOS was captured in light only: it shows light and offers no switch.
|
||||
await page.keyboard.press("Backquote");
|
||||
await expect.poll(target).toBe("ios");
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
await expect(appearance).toHaveCount(0);
|
||||
// Back on Android, the choice still holds.
|
||||
await page.keyboard.press("Backquote");
|
||||
await expect.poll(target).toBe("android");
|
||||
await expect(appearance).toHaveText(/Dark/);
|
||||
// A reload of the tab keeps it as well.
|
||||
await page.reload();
|
||||
await expect(appearance).toHaveText(/Dark/);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("going back during a switch shows the report the page was on, and the slow one does not replace it", { timeout: 60_000 }, async t => {
|
||||
const { page, errors, switchToIos } = await slowSwitchHarness(t, "ghijklmnopqrstuvwxyz234567234567", 3000);
|
||||
await switchToIos();
|
||||
@@ -594,10 +764,12 @@ test("report links name their target: ?target=, ?platform= from before targets,
|
||||
const api = window.archiveApi;
|
||||
const attempt = fn => { try { return fn(); } catch (error) { return `error: ${error.message}`; } };
|
||||
const preview = "http://x/p/abcdefghijklmnopqrstuvwxyz234567";
|
||||
const manifest = page => api.previewManifestUrl(api.previewToken(page), api.reportTarget(page));
|
||||
return {
|
||||
target: api.previewReportUrl(new URL(`${preview}?target=duo-open`)),
|
||||
platform: api.previewReportUrl(new URL(`${preview}?platform=android`)),
|
||||
none: api.previewReportUrl(new URL(preview)),
|
||||
target: manifest(new URL(`${preview}?target=duo-open`)),
|
||||
platform: manifest(new URL(`${preview}?platform=android`)),
|
||||
none: manifest(new URL(preview)),
|
||||
asset: api.previewAssetUrl("abcdefghijklmnopqrstuvwxyz234567", `assets/${"a".repeat(64)}.png`),
|
||||
both: attempt(() => api.reportTarget(new URL(`${preview}?target=duo-open&platform=ios`))),
|
||||
invalid: attempt(() => api.reportTarget(new URL(`${preview}?target=Duo`))),
|
||||
reserved: attempt(() => api.reportTarget(new URL(`${preview}?target=report`))),
|
||||
@@ -608,9 +780,11 @@ test("report links name their target: ?target=, ?platform= from before targets,
|
||||
};
|
||||
});
|
||||
assert.deepEqual(result, {
|
||||
target: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip?target=duo-open",
|
||||
platform: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip?platform=android",
|
||||
none: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip",
|
||||
target: "/p/abcdefghijklmnopqrstuvwxyz234567/manifest.json?target=duo-open",
|
||||
platform: "/p/abcdefghijklmnopqrstuvwxyz234567/manifest.json?platform=android",
|
||||
none: "/p/abcdefghijklmnopqrstuvwxyz234567/manifest.json",
|
||||
// A screenshot is a static file named by its content, the same for every target.
|
||||
asset: `/p/abcdefghijklmnopqrstuvwxyz234567/assets/${"a".repeat(64)}.png`,
|
||||
both: "error: This report link needs one target, such as ios or android.",
|
||||
invalid: "error: This report link needs one target, such as ios or android.",
|
||||
reserved: "error: This report link needs one target, such as ios or android.",
|
||||
@@ -1188,20 +1362,22 @@ test("a docs-only report with zero images and no EAS build opens Screens without
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(1);
|
||||
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(1);
|
||||
// The Inspector's missing screenshot matches the canvas node: the icon above a short label,
|
||||
// centred in a phone-shaped preview frame.
|
||||
// The Inspector's missing screenshot matches the canvas node: the icon above a short label and
|
||||
// the report's reason for the gap, centred in a phone-shaped preview frame.
|
||||
await page.locator(".screens-page .screen-screenshot-target").click();
|
||||
const placeholder = page.locator(".inspector .inspector-preview .screenshot-placeholder");
|
||||
await expect(placeholder).toHaveText("No screenshot");
|
||||
await expect(placeholder.locator("span")).toHaveText("No screenshot");
|
||||
await expect(placeholder.locator(".screenshot-placeholder-detail")).toHaveText("Not compared; no capture was recorded");
|
||||
const layout = await placeholder.evaluate(node => {
|
||||
const box = element => element.getBoundingClientRect();
|
||||
const frame = box(node.closest(".inspector-preview"));
|
||||
const icon = box(node.querySelector("svg"));
|
||||
const label = box(node.querySelector("span"));
|
||||
const detail = box(node.querySelector(".screenshot-placeholder-detail"));
|
||||
return { frameRatio: frame.width / frame.height, iconSize: [icon.width, icon.height], iconAboveLabel: icon.bottom <= label.top,
|
||||
iconOffset: Math.abs(icon.left + icon.width / 2 - (frame.left + frame.width / 2)),
|
||||
labelOffset: Math.abs(label.left + label.width / 2 - (frame.left + frame.width / 2)),
|
||||
verticalOffset: Math.abs((icon.top + label.bottom) / 2 - (frame.top + frame.height / 2)),
|
||||
verticalOffset: Math.abs((icon.top + detail.bottom) / 2 - (frame.top + frame.height / 2)),
|
||||
labelSize: getComputedStyle(node.querySelector("span")).fontSize };
|
||||
});
|
||||
assert.deepEqual(layout.iconSize, [20, 20]);
|
||||
@@ -1367,3 +1543,146 @@ test("local run ZIP opens and reloads without a fabricated GitHub identity", asy
|
||||
await expect(localRun).toHaveText("Local");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("the Inspector stacks Before over After for a landscape screenshot; Swipe and Flip keep one frame", async t => {
|
||||
// An opened iPhone Duo's inner display, as a screenshot: wider than tall.
|
||||
const picture = new PNG({ width: 951, height: 669 });
|
||||
picture.data.fill(255);
|
||||
const capture = PNG.sync.write(picture);
|
||||
const report = reportFixture();
|
||||
for (const side of ["baseImage", "headImage"]) Object.assign(report.review.surfaces[0][side], { width: 951, height: 669 });
|
||||
const { bytes } = await imageArchive([capture], 0, report);
|
||||
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true, fault: holdScreenshotHashes(capture.length) });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const stage = page.locator(".sidebar-review-stage");
|
||||
const box = locator => locator.evaluate(element => {
|
||||
const { left, top, width, height } = element.getBoundingClientRect();
|
||||
return { left, top, width, height };
|
||||
});
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
// The report's recorded size shapes the pair before the screenshots load: no side-by-side flash.
|
||||
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const waiting = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const [before, after] = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
|
||||
assert.deepEqual([before, after], waiting, "The frames do not move or resize when the screenshots load");
|
||||
const panel = await box(stage);
|
||||
// Each frame takes the review's width; After sits under Before, not beside it.
|
||||
assert.ok(Math.abs(before.width - panel.width) <= 2, `Before spans the panel: ${JSON.stringify({ before, panel })}`);
|
||||
assert.ok(Math.abs(after.width - panel.width) <= 2, `After spans the panel: ${JSON.stringify({ after, panel })}`);
|
||||
assert.ok(after.top >= before.top + before.height, `After is under Before: ${JSON.stringify({ before, after })}`);
|
||||
assert.ok(Math.abs(before.width / before.height - 951 / 669) < 0.02, `The frame keeps the screenshot's shape: ${JSON.stringify(before)}`);
|
||||
// Swipe and Flip show one frame the panel's width, as before.
|
||||
for (const mode of ["Swipe", "Flip"]) {
|
||||
await page.locator(".sidebar-review-modes").getByRole("button", { name: mode, exact: true }).click();
|
||||
const frame = await box(page.locator(".sidebar-review :is(.visual-swipe, .compare-frame)").first());
|
||||
assert.ok(Math.abs(frame.width - panel.width) <= 2, `${mode} spans the panel: ${JSON.stringify({ frame, panel })}`);
|
||||
}
|
||||
await page.locator(".sidebar-review-modes").getByRole("button", { name: "Split", exact: true }).click();
|
||||
await expect(frames).toHaveCount(2);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("the Inspector keeps a portrait pair side by side", async t => {
|
||||
const { page, errors } = await harness(t, await archive(), { app: true });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(page.locator(".sidebar-review-stage")).not.toHaveClass(/landscape/);
|
||||
const box = locator => locator.evaluate(element => {
|
||||
const { left, top, width } = element.getBoundingClientRect();
|
||||
return { left, top, width };
|
||||
});
|
||||
const [before, after] = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
|
||||
assert.equal(after.top, before.top, `Before and After share a row: ${JSON.stringify({ before, after })}`);
|
||||
assert.ok(after.left >= before.left + before.width, `After is beside Before: ${JSON.stringify({ before, after })}`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/** A white PNG of `width` × `height`, and the asset entry and record fields a report gives it. */
|
||||
function sizedCapture(width, height) {
|
||||
const picture = new PNG({ width, height });
|
||||
picture.data.fill(255);
|
||||
const bytes = PNG.sync.write(picture);
|
||||
const digest = createHash("sha256").update(bytes).digest("hex");
|
||||
return { bytes, sha256: digest, path: `assets/${digest}.png`,
|
||||
record: { url: `https://artifact.expo-explore.invalid/${digest}.png`, sha256: digest, width, height } };
|
||||
}
|
||||
|
||||
test("the Inspector takes a pair's shape from After, whichever side loads last", async t => {
|
||||
// A screen that turned landscape: Before is the 32×64 portrait fixture, After is landscape.
|
||||
const landscape = sizedCapture(951, 669);
|
||||
const report = reportFixture();
|
||||
Object.assign(report.review.surfaces[0].headImage, landscape.record);
|
||||
report.assets.push({ sha256: landscape.sha256, path: landscape.path });
|
||||
// Before's screenshot is held until After's has loaded, so it loads last.
|
||||
const { page, errors } = await harness(t, await archive(report, [{ name: landscape.path, bytes: landscape.bytes }]),
|
||||
{ app: true, fault: holdScreenshotHashes(png.length) });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const stage = page.locator(".sidebar-review-stage");
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
await expect(frames.nth(1).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(frames.nth(0).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const ratio = await frames.nth(0).evaluate(element => element.getBoundingClientRect().width / element.getBoundingClientRect().height);
|
||||
assert.ok(Math.abs(ratio - 951 / 669) < 0.02, `Both frames keep After's shape: ${ratio}`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("Swipe takes the loaded screenshot's shape when it differs from the recorded one", async t => {
|
||||
// The record says portrait; the screenshot is landscape. Swipe's frame follows the image, as
|
||||
// Split's and Flip's do, so a capture whose size the report does not hold is not cropped.
|
||||
const landscape = sizedCapture(951, 669);
|
||||
const { bytes } = await imageArchive([landscape.bytes]);
|
||||
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true, fault: holdScreenshotHashes(landscape.bytes.length) });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
// Swipe is chosen before any screenshot loads, so only Swipe's images report a size.
|
||||
await page.locator(".sidebar-review-modes").getByRole("button", { name: "Swipe", exact: true }).click();
|
||||
const swipe = page.locator(".sidebar-review .visual-swipe");
|
||||
await expect(swipe).toBeVisible();
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(swipe.locator("img.visual-swipe-after")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect.poll(() => swipe.evaluate(element => {
|
||||
const { width, height } = element.getBoundingClientRect();
|
||||
return Math.abs(width / height - 951 / 669) < 0.02;
|
||||
})).toBe(true);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a near-square landscape pair in a short window keeps both halves on screen, centred", async t => {
|
||||
// An unfolded foldable's inner display on its side: barely wider than tall.
|
||||
const foldable = sizedCapture(960, 800);
|
||||
const report = reportFixture();
|
||||
for (const side of ["baseImage", "headImage"]) Object.assign(report.review.surfaces[0][side], { width: 960, height: 800 });
|
||||
const { bytes } = await imageArchive([foldable.bytes], 0, report);
|
||||
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true });
|
||||
await page.setViewportSize({ width: 1440, height: 760 });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const stage = page.locator(".sidebar-review-stage");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
await expect(frames.nth(1).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const box = locator => locator.evaluate(element => {
|
||||
const { left, top, width, height, bottom } = element.getBoundingClientRect();
|
||||
return { left, top, width, height, bottom };
|
||||
});
|
||||
const [before, after, panel] = await Promise.all([box(frames.nth(0)), box(frames.nth(1)), box(stage)]);
|
||||
const viewport = page.viewportSize();
|
||||
assert.ok(after.top >= before.top + before.height, `After is under Before: ${JSON.stringify({ before, after })}`);
|
||||
assert.ok(before.top >= 0 && after.bottom <= viewport.height, `Both halves are on screen: ${JSON.stringify({ before, after, viewport })}`);
|
||||
for (const frame of [before, after]) {
|
||||
assert.ok(frame.width < panel.width - 2, `The frame is held under the panel's width: ${JSON.stringify({ frame, panel })}`);
|
||||
assert.ok(Math.abs(frame.left + frame.width / 2 - (panel.left + panel.width / 2)) <= 1, `The frame is centred: ${JSON.stringify({ frame, panel })}`);
|
||||
assert.ok(Math.abs(frame.width / frame.height - 960 / 800) < 0.02, `The frame keeps the screenshot's shape: ${JSON.stringify(frame)}`);
|
||||
}
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
@@ -102,7 +102,7 @@ test("a recorded review opens on the real map and before/after evidence and surv
|
||||
await expect(page.locator(".collapsed-pr")).toContainText("PR #1");
|
||||
// The map is one card per screen; changed screens carry their diff status on the card.
|
||||
await expect(page.locator(".map-canvas .react-flow__node-screen")).toHaveCount(33);
|
||||
await expect(page.locator('.map-canvas .screen-screenshot-target[title="/games"]')).toBeVisible();
|
||||
await expect(page.locator('.map-canvas .screen-node-title[aria-label="Copy deep link /games"]')).toBeVisible();
|
||||
await expect(page.getByText("No report open")).toHaveCount(0);
|
||||
const menu = await openChangesMenu(page);
|
||||
// Changes lists the screens with something to see: the three with pixel changes, the added and the removed one.
|
||||
@@ -416,6 +416,38 @@ test("the Screens tree folds by row, by keyboard, and all at once, and remembers
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a fold tried during a find changes nothing: the tree's own folds come back, and are what a reload remembers", { timeout: 60_000 }, async t => {
|
||||
const { page, url, errors } = await openReport(t, { width: 1440, height: 900 });
|
||||
await page.goto(`${url}#/screens`);
|
||||
const tree = page.locator(".screens-tree");
|
||||
await tree.getByRole("button", { name: /^All/ }).click();
|
||||
const folder = tree.locator(".screens-tree-row.folder", { hasText: "onboarding/" });
|
||||
const other = tree.locator(".screens-tree-row.folder").filter({ hasNotText: "onboarding/" }).first();
|
||||
await expect(other).toHaveAttribute("aria-expanded", "true");
|
||||
await folder.click();
|
||||
await expect(folder).toHaveAttribute("aria-expanded", "false");
|
||||
|
||||
// While a find is on every row stays open; folding one there neither shows nor sticks.
|
||||
await page.keyboard.press("/");
|
||||
const field = page.getByRole("searchbox", { name: "Find screens" });
|
||||
await field.fill("/");
|
||||
await expect(folder).toHaveAttribute("aria-expanded", "true");
|
||||
await other.click();
|
||||
await page.keyboard.press("ArrowLeft");
|
||||
await expect(other).toHaveAttribute("aria-expanded", "true");
|
||||
await field.press("Escape");
|
||||
await field.press("Escape");
|
||||
await expect(field).toHaveCount(0);
|
||||
await expect(folder).toHaveAttribute("aria-expanded", "false");
|
||||
await expect(other).toHaveAttribute("aria-expanded", "true");
|
||||
|
||||
await page.reload();
|
||||
await tree.getByRole("button", { name: /^All/ }).click();
|
||||
await expect(folder).toHaveAttribute("aria-expanded", "false");
|
||||
await expect(other).toHaveAttribute("aria-expanded", "true");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("dev opens the report ZIP named by EXPLORE_REPORT and preserves the explicit map API proxy", { timeout: 90_000 }, async t => {
|
||||
const reportDev = await launcher(t, "scripts/dev-viewer.mjs", [], {
|
||||
EXPLORE_DIR: "", EXPLORE_REPORT: fileURLToPath(REPORT), EXPLORE_DEV_PORT: String(await freePort()),
|
||||
|
||||
@@ -35,6 +35,13 @@ export function resolveEmbeddedArtifactUrl(source, priority) {
|
||||
window.pendingScreenshots.set(source, pending);
|
||||
});
|
||||
}
|
||||
// \`window.shownReport\` stands in for the report the page shows; a hosted preview's target switch changes it.
|
||||
export function leaseEmbeddedArtifactUrl(source, priority) {
|
||||
const report = window.shownReport;
|
||||
return { url: resolveEmbeddedArtifactUrl(source, priority),
|
||||
release: () => { window.releasedFrom.push(report); return releaseEmbeddedArtifactUrl(source); },
|
||||
current: () => window.shownReport === report };
|
||||
}
|
||||
`;
|
||||
|
||||
const entry = `
|
||||
@@ -67,6 +74,7 @@ function Harness() {
|
||||
width={120} height={80} loading={state.loading} decoding="async" className="captured-image"
|
||||
data-screen="checkout" onLoad={loaded} onError={failed}
|
||||
{...(state.indicator ? { indicator: state.indicator } : {})}
|
||||
{...(state.holdPrevious ? { holdPrevious: true } : {})}
|
||||
{...(state.fallback ? { fallback: <span data-testid="fallback">No screenshot</span> } : {})} />}
|
||||
</div>
|
||||
</main>;
|
||||
@@ -121,6 +129,8 @@ async function fixture(t, options = {}) {
|
||||
window.resolverCalls = [];
|
||||
window.resolverPriorities = [];
|
||||
window.releaseCalls = [];
|
||||
window.shownReport = "android";
|
||||
window.releasedFrom = [];
|
||||
window.immediateScreenshots = new Map();
|
||||
if (fixture.observer === "manual") {
|
||||
// The test decides when the image enters or leaves the viewport, down to one task.
|
||||
@@ -351,17 +361,19 @@ async function blobUrl(page, bytes) {
|
||||
}
|
||||
|
||||
test("returning to a screenshot before the next one resolves waits for a fresh URL, never the released one", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", fallback: true });
|
||||
const { page, image } = await fixture(t, { loading: "eager", fallback: true, indicator: "spinner" });
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
|
||||
const released = await blobUrl(page, firstImage);
|
||||
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: released });
|
||||
await expectDecoded(image, 2, 3);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
|
||||
// A to B releases A's URL; while B still resolves, the report evicts and revokes it.
|
||||
// A to B releases A's URL; while B still resolves, the report evicts and revokes it. Without `holdPrevious` (Compare,
|
||||
// the Inspector) nothing of A stays up under B's name and outlines: B waits with its spinner.
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(secondSource);
|
||||
await expectWaiting(image);
|
||||
await expect(page.getByRole("status", { name: "Loading screenshot" })).toBeVisible();
|
||||
await expect.poll(() => page.evaluate(() => window.releaseCalls)).toEqual([firstSource]);
|
||||
await page.evaluate(url => URL.revokeObjectURL(url), released);
|
||||
|
||||
@@ -375,10 +387,80 @@ test("returning to a screenshot before the next one resolves waits for a fresh U
|
||||
await expectDecoded(image, 2, 3);
|
||||
await expect(image).toHaveAttribute("src", fresh);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
assert.deepEqual(await page.evaluate(() => window.imageErrors), []);
|
||||
});
|
||||
|
||||
test("a new source keeps the picture before it on screen until it decodes; returning to the first waits for a fresh URL, never reloading the released one", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", fallback: true, holdPrevious: true });
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
|
||||
const released = await blobUrl(page, firstImage);
|
||||
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: released });
|
||||
await expectDecoded(image, 2, 3);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
|
||||
// A to B releases A's URL, but A's picture stays up (nothing blanks while every screenshot of a report swaps at once);
|
||||
// while B still resolves, the report evicts and revokes the URL behind it, which the decoded picture survives.
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(secondSource);
|
||||
await expect(image).toHaveAttribute("src", released);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await expect(image).toHaveAttribute("aria-busy", "true");
|
||||
await expect.poll(() => page.evaluate(() => window.releaseCalls)).toEqual([firstSource]);
|
||||
await page.evaluate(url => URL.revokeObjectURL(url), released);
|
||||
|
||||
// Back to A before B resolves: A keeps the picture and waits for its new resolution instead of reloading the revoked URL.
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), firstSource);
|
||||
await expect.poll(() => page.evaluate(source => window.resolverCalls.filter(value => value === source).length, firstSource)).toBe(2);
|
||||
await expect(image).toHaveAttribute("src", released);
|
||||
await expect(image).toHaveAttribute("aria-busy", "true");
|
||||
const fresh = await blobUrl(page, firstImage);
|
||||
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: fresh });
|
||||
await expectDecoded(image, 2, 3);
|
||||
await expect(image).toHaveAttribute("src", fresh);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(page.getByTestId("fallback")).toHaveCount(0);
|
||||
assert.deepEqual(await page.evaluate(() => window.imageErrors), []);
|
||||
});
|
||||
|
||||
test("a held picture is not handed on past a source that failed: the next source waits on its own stand-in", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", fallback: true, holdPrevious: true });
|
||||
const first = await blobUrl(page, firstImage);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
|
||||
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url: first });
|
||||
await expectDecoded(image, 2, 3);
|
||||
|
||||
// A to B, which cannot be read: B's fallback, with A's picture gone with it.
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(secondSource);
|
||||
await expect(image).toHaveAttribute("src", first);
|
||||
await page.evaluate(source => window.rejectScreenshot(source), secondSource);
|
||||
await expect(page.getByTestId("fallback")).toHaveText("No screenshot");
|
||||
|
||||
// On to C: A's picture does not come back under C while C resolves.
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), thirdSource);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toContain(thirdSource);
|
||||
await expectWaiting(image);
|
||||
});
|
||||
|
||||
test("a target switch that drops a screenshot still waiting asks the report shown next, which holds the same one", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", fallback: true });
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
|
||||
|
||||
// The Viewer swaps in the other target's report; the same screenshot keeps its source, so this image stays mounted.
|
||||
// Trimming the report it waited on rejects the wait.
|
||||
await page.evaluate(source => { window.shownReport = "ios"; window.rejectScreenshot(source); }, firstSource);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource, firstSource]);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await resolveImage(page, firstSource);
|
||||
await expectDecoded(image, 2, 3);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
assert.deepEqual(await page.evaluate(() => window.imageErrors), []);
|
||||
|
||||
// Let go after switching back, it releases to the report that resolved it, not the one shown.
|
||||
await page.evaluate(() => { window.shownReport = "android"; window.updateScreenshot({ mounted: false }); });
|
||||
await expect.poll(() => page.evaluate(() => window.releasedFrom)).toEqual(["ios"]);
|
||||
});
|
||||
|
||||
test("a fresh URL for a screenshot that failed to decode gives it another try", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { layout: "pan", loading: "lazy" });
|
||||
const positioner = page.getByTestId("positioner");
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { chromium, expect } from "@playwright/test";
|
||||
import { PNG } from "pngjs";
|
||||
import { createBrowserVite } from "../helpers/browser-vite.mjs";
|
||||
|
||||
function png(width, height, color) {
|
||||
const image = new PNG({ width, height });
|
||||
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
|
||||
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
|
||||
}
|
||||
|
||||
// A card that moved 40% of the width right: it is at 60% in After, so it was at 20% in Before.
|
||||
const entry = `
|
||||
import { createRoot } from "react-dom/client";
|
||||
import { SwipeCompare } from "/src/components/panels/visual-diff.tsx";
|
||||
import "/src/styles.css";
|
||||
const changes = [{ x: 60, y: 30, width: 30, height: 30, share: 100, regionCount: 1,
|
||||
move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } }];
|
||||
createRoot(document.getElementById("root")).render(<div style={{ width: 400, display: "flex" }}>
|
||||
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={50} />
|
||||
</div>);
|
||||
`;
|
||||
|
||||
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
|
||||
const vite = await createBrowserVite(t, {
|
||||
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
|
||||
logLevel: "error", esbuild: { jsx: "automatic" },
|
||||
plugins: [{
|
||||
name: "swipe-outlines-fixture",
|
||||
resolveId: id => id === "/__swipe-outlines.tsx" ? id : undefined,
|
||||
load: id => id === "/__swipe-outlines.tsx" ? entry : undefined,
|
||||
configureServer(server) {
|
||||
server.middlewares.use((request, response, next) => {
|
||||
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
|
||||
response.setHeader("Content-Type", "text/html");
|
||||
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__swipe-outlines.tsx"></script></body></html>');
|
||||
});
|
||||
},
|
||||
}],
|
||||
server: { host: "127.0.0.1", port: 0 },
|
||||
});
|
||||
await vite.listen();
|
||||
const browser = await chromium.launch({ headless: true });
|
||||
t.after(() => browser.close());
|
||||
const page = await browser.newPage({ viewport: { width: 600, height: 600 } });
|
||||
const errors = [];
|
||||
page.on("pageerror", error => errors.push(error.message));
|
||||
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
|
||||
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
|
||||
|
||||
const frame = page.locator(".visual-swipe");
|
||||
const before = page.locator(".visual-swipe-outlines.before .visual-change-outline.moved");
|
||||
const after = page.locator(".visual-swipe-outlines.after .visual-change-outline.moved");
|
||||
await expect(before).toHaveCount(1);
|
||||
await expect(after).toHaveCount(1);
|
||||
const [box, beforeBox, afterBox] = await Promise.all([frame.boundingBox(), before.boundingBox(), after.boundingBox()]);
|
||||
assert.ok(Math.abs((afterBox.x - beforeBox.x) - 0.4 * box.width) < 1, "Before's outline is back by the move");
|
||||
// Each side's outlines show only over its own half of the frame.
|
||||
const clips = await page.locator(".visual-swipe-outlines").evaluateAll(spans => spans.map(span => getComputedStyle(span).clipPath));
|
||||
assert.deepEqual(clips.map(clip => clip.startsWith("inset(")), [true, true]);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
@@ -6,6 +6,7 @@ import { join, resolve } from 'node:path';
|
||||
import { parseArgs } from 'node:util';
|
||||
import { parse } from 'yaml';
|
||||
import { assessPublicEvidence, readExportedMap } from '../../dist/review/evidence-assessment.js';
|
||||
import { systemRegions } from '../../dist/contracts/capture.js';
|
||||
import { prepareCaptureReview, readCaptureBundle } from '../../dist/review/capture-review.js';
|
||||
import { parseRuntimeExecutionContext } from '../../dist/review/runtime-adapter.js';
|
||||
import { generateAgentChangeNotes } from '../../dist/capture/agent/change-notes.js';
|
||||
@@ -28,11 +29,13 @@ export async function recompare(runDirectory) {
|
||||
const existing = (await readdir(join(run, 'artifacts'))).filter(name => /^recompare-\d+$/.test(name)).length;
|
||||
const label = `recompare-${existing + 1}`;
|
||||
const sides = { base: await side(join(capture, 'base-export')), head: await side(join(capture, 'head-export')) };
|
||||
const evidence = await assessPublicEvidence({ plan, ...sides, profile: `${config.app.easProfile}:${config.app.bundleId}`,
|
||||
// The run's own device and pose, as its comparison had them: a foldable's rail pill, or the platform's bands.
|
||||
const system = systemRegions({ platform: config.app.platform, device: config.device.name, pose: config.device.pose });
|
||||
const evidence = await assessPublicEvidence({ platform: config.app.platform, systemRegions: system, plan, ...sides, profile: `${config.app.easProfile}:${config.app.bundleId}`,
|
||||
agentDeviceCommand: join(repository, 'node_modules/.bin/agent-device') });
|
||||
const state = { ...previous.commentState };
|
||||
let { review, assets } = await prepareCaptureReview({ plan, pullRequest: state.pullRequest,
|
||||
baseDirectory: sides.base.directory, headDirectory: sides.head.directory, runId: previous.publicReview.runId,
|
||||
baseDirectory: sides.base.directory, headDirectory: sides.head.directory, systemRegions: system, runId: previous.publicReview.runId,
|
||||
runAttempt: previous.publicReview.runAttempt, assertCurrentHead: async () => {}, assessments: evidence.surfaces,
|
||||
app: { ...(state.build?.appVersion ? { version: state.build.appVersion } : {}),
|
||||
...(state.build?.appBuildNumber ? { buildNumber: state.build.appBuildNumber } : {}) } });
|
||||
|
||||
+371
-10
@@ -127,6 +127,13 @@ async function expectMapScreenSelectionDimming(
|
||||
}));
|
||||
const hoverTargetCount = options.hoverTargetCount ?? 1;
|
||||
expect(hoverableDimmedIndexes.length).toBeGreaterThanOrEqual(hoverTargetCount);
|
||||
// A card fades through its frame's --map-card-opacity (the node itself stays opaque over the
|
||||
// connectors). The property is not animated, so it reads what hover asks for at once.
|
||||
const cardOpacities = () => screens.evaluateAll((nodes) => Object.fromEntries(nodes.map((node) => [
|
||||
node.getAttribute("data-id") ?? "",
|
||||
getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim(),
|
||||
])));
|
||||
const restingOpacities = await cardOpacities();
|
||||
let lastHoverTarget = dimmed.nth(hoverableDimmedIndexes[0]!);
|
||||
|
||||
for (const index of hoverableDimmedIndexes.slice(0, hoverTargetCount)) {
|
||||
@@ -149,7 +156,9 @@ async function expectMapScreenSelectionDimming(
|
||||
return label.startsWith(`Edge from ${nodeId} to `) || label.endsWith(` to ${nodeId}`);
|
||||
}).length, hoverTargetId!);
|
||||
expect(directEdgeCount).toBeGreaterThan(0);
|
||||
// The hovered screen and every screen it shares an edge with stay bright; the rest recede.
|
||||
// The hovered screen and every screen it shares an edge with are marked related; nothing on
|
||||
// the map recedes while hovering, so the only changes are the subject ring, the incident
|
||||
// edges and the neighbours' frames.
|
||||
const neighbourIds = await allEdges.evaluateAll((edges, nodeId) => {
|
||||
const ids = new Set<string>([nodeId]);
|
||||
for (const edge of edges) {
|
||||
@@ -166,14 +175,15 @@ async function expectMapScreenSelectionDimming(
|
||||
await expect.poll(() => brightNodes.evaluateAll((nodes) => (
|
||||
nodes.map((node) => node.getAttribute("data-id") ?? "").sort()
|
||||
))).toEqual(neighbourIds);
|
||||
const receded = page.locator(
|
||||
".map-canvas .react-flow__node-screen:not(.graph-node-hover-related)",
|
||||
const unrelated = page.locator(
|
||||
".map-canvas .react-flow__node-screen:not(.graph-node-hover-related):not(.canvas-node-exit)",
|
||||
);
|
||||
if (await receded.count() > 0) {
|
||||
await expect.poll(() => receded.first().evaluate(
|
||||
(node) => Number.parseFloat(getComputedStyle(node).opacity),
|
||||
)).toBeGreaterThan(0.5);
|
||||
}
|
||||
const unrelatedIds = await unrelated.evaluateAll((nodes) => nodes.map((node) => node.getAttribute("data-id") ?? ""));
|
||||
expect(unrelatedIds.length).toBeGreaterThan(0);
|
||||
const hoverOpacities = await cardOpacities();
|
||||
expect(unrelatedIds.map((id) => hoverOpacities[id])).toEqual(unrelatedIds.map((id) => restingOpacities[id]));
|
||||
expect(await unrelated.evaluateAll((nodes) => nodes.every((node) => getComputedStyle(node).filter === "none"))).toBe(true);
|
||||
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
|
||||
const activeEdges = page.locator(
|
||||
".map-canvas .react-flow__edge.graph-edge-hover-related",
|
||||
);
|
||||
@@ -1998,6 +2008,148 @@ test("fits the visible Map screenshot frame to the capture's intrinsic ratio", a
|
||||
expect(metrics.slotBackground).toBe("rgba(0, 0, 0, 0)");
|
||||
});
|
||||
|
||||
/** Each Map card's --map-card-opacity by id: what fades its frame. The property is not animated. */
|
||||
function mapCardOpacities(page: Page) {
|
||||
return page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)").evaluateAll((nodes) => (
|
||||
Object.fromEntries(nodes.map((node) => [
|
||||
node.getAttribute("data-id") ?? "",
|
||||
getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim(),
|
||||
]))
|
||||
));
|
||||
}
|
||||
|
||||
/** Waits until the Map camera stops moving. */
|
||||
async function expectMapCameraAtRest(page: Page) {
|
||||
await expect(page.locator(".map-canvas.canvas-focus-animating")).toHaveCount(0);
|
||||
const viewport = page.locator(".map-canvas .react-flow__viewport");
|
||||
let transform = "";
|
||||
await expect.poll(async () => {
|
||||
const next = await viewport.evaluate((element) => getComputedStyle(element).transform);
|
||||
const resting = next === transform;
|
||||
transform = next;
|
||||
return resting;
|
||||
}).toBe(true);
|
||||
}
|
||||
|
||||
/** The first `candidates` card whose screenshot is under the pointer near its top, with `room` above and below. */
|
||||
async function hoverableMapScreen(candidates: Locator, room = 80) {
|
||||
const index = await candidates.evaluateAll((nodes, room) => nodes.findIndex((node) => {
|
||||
const target = node.querySelector(".screen-screenshot-target")!.getBoundingClientRect();
|
||||
const hit = document.elementFromPoint(target.left + target.width / 2, target.top + target.height / 4);
|
||||
return hit !== null && node.contains(hit) && target.top > room && target.bottom < window.innerHeight - room;
|
||||
}), room);
|
||||
expect(index).toBeGreaterThanOrEqual(0);
|
||||
return candidates.nth(index);
|
||||
}
|
||||
|
||||
test("hovering a Map screen fades nothing and says Open in Inspector in a tooltip below the card that keeps to it", async ({ page }) => {
|
||||
await serveSyntheticWorkspace(page);
|
||||
await page.goto("/map");
|
||||
const screens = page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)");
|
||||
await expect(screens.first()).toBeVisible();
|
||||
await expectMapCameraAtRest(page);
|
||||
const resting = await mapCardOpacities(page);
|
||||
// A screen at one end of a secondary transition, which rests a little faded.
|
||||
const secondaryEnds = await page.locator(".map-canvas .react-flow__edge.graph-edge-secondary").evaluateAll((edges) => (
|
||||
[...new Set(edges.flatMap((edge) => /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "")?.slice(1) ?? []))]
|
||||
));
|
||||
expect(secondaryEnds.length).toBeGreaterThan(0);
|
||||
const node = await hoverableMapScreen(page.locator(
|
||||
secondaryEnds.map((id) => `.map-canvas .react-flow__node-screen[data-id="${id}"]`).join(", "),
|
||||
));
|
||||
const target = node.locator(".screen-screenshot-target");
|
||||
const heading = node.locator(".screen-node-heading");
|
||||
// The tooltip says what a click does; no native title tooltip joins it.
|
||||
await expect(target).not.toHaveAttribute("title");
|
||||
// Near the card's top, so the pan below keeps the pointer on it.
|
||||
const box = (await target.boundingBox())!;
|
||||
await target.hover({ position: { x: box.width / 2, y: box.height / 4 } });
|
||||
await expect(page.locator(".connection-canvas-surface.canvas-hovering")).toHaveCount(1);
|
||||
const tooltip = page.locator(".tooltip", { hasText: "Open in Inspector" });
|
||||
await expect(tooltip).toBeVisible();
|
||||
const related = await page.locator(".map-canvas .react-flow__node-screen.graph-node-hover-related")
|
||||
.evaluateAll((nodes) => nodes.map((element) => element.getAttribute("data-id") ?? ""));
|
||||
const unrelated = Object.keys(resting).filter((id) => !related.includes(id));
|
||||
expect(unrelated.length).toBeGreaterThan(0);
|
||||
const hovering = await mapCardOpacities(page);
|
||||
expect(unrelated.map((id) => hovering[id])).toEqual(unrelated.map((id) => resting[id]));
|
||||
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
|
||||
// The transitions into and out of it come fully up, the secondary one too.
|
||||
const incident = page.locator(".map-canvas .react-flow__edge.graph-edge-hover-related");
|
||||
await expect(incident.and(page.locator(".graph-edge-secondary"))).not.toHaveCount(0);
|
||||
await expect.poll(() => incident.evaluateAll((edges) => edges.every((edge) => getComputedStyle(edge).opacity === "1"))).toBe(true);
|
||||
// The route heads a Map card, so the bubble sits below the screenshot, clear of both.
|
||||
const clearance = async () => {
|
||||
const [bubble, card, title] = await Promise.all([tooltip.boundingBox(), target.boundingBox(), heading.boundingBox()]);
|
||||
if (!bubble || !card || !title) return Number.NaN;
|
||||
const headingOverlap = bubble.y < title.y + title.height && title.y < bubble.y + bubble.height
|
||||
&& bubble.x < title.x + title.width && title.x < bubble.x + bubble.width;
|
||||
return headingOverlap ? -1 : bubble.y - (card.y + card.height);
|
||||
};
|
||||
expect(await clearance()).toBeGreaterThan(0);
|
||||
// Panning with the pointer still on the card moves the card by transform; the bubble follows it
|
||||
// rather than staying behind over the screenshot.
|
||||
const before = await target.boundingBox();
|
||||
await page.mouse.wheel(0, 40);
|
||||
await expect.poll(async () => (await target.boundingBox())!.y).toBeLessThan(before!.y - 10);
|
||||
await expect.poll(clearance).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
test("hovering a Map screen the Changes filter muted brings it and its neighbours back up, and nothing else", async ({ page }) => {
|
||||
await serveSyntheticWorkspace(page);
|
||||
await page.goto("/map?focus=modified");
|
||||
const muted = page.locator(".map-canvas .react-flow__node-screen.graph-node-muted:not(.canvas-node-exit)");
|
||||
await expect.poll(() => muted.count()).toBeGreaterThan(0);
|
||||
await expectMapCameraAtRest(page);
|
||||
const resting = await mapCardOpacities(page);
|
||||
const node = await hoverableMapScreen(muted, 0);
|
||||
const id = (await node.getAttribute("data-id"))!;
|
||||
expect(Number.parseFloat(resting[id]!)).toBeLessThan(1);
|
||||
await node.locator(".screen-screenshot-target").hover();
|
||||
await expect(node).toHaveClass(/graph-node-hover-subject/);
|
||||
const related = await page.locator(".map-canvas .react-flow__node-screen.graph-node-hover-related")
|
||||
.evaluateAll((nodes) => nodes.map((element) => element.getAttribute("data-id") ?? ""));
|
||||
expect(related).toContain(id);
|
||||
expect(related.length).toBeGreaterThan(1);
|
||||
const hovering = await mapCardOpacities(page);
|
||||
expect(related.map((relatedId) => hovering[relatedId])).toEqual(related.map(() => "1"));
|
||||
const unrelated = Object.keys(resting).filter((otherId) => !related.includes(otherId));
|
||||
expect(unrelated.length).toBeGreaterThan(0);
|
||||
expect(unrelated.map((otherId) => hovering[otherId])).toEqual(unrelated.map((otherId) => resting[otherId]));
|
||||
// The transitions between them come up with them.
|
||||
const edges = page.locator(".map-canvas .react-flow__edge.graph-edge-hover-related");
|
||||
await expect.poll(() => edges.count()).toBeGreaterThan(0);
|
||||
await expect.poll(() => edges.evaluateAll((elements) => elements.every((edge) => getComputedStyle(edge).opacity === "1"))).toBe(true);
|
||||
});
|
||||
|
||||
test("on Screens the Open in Inspector tooltip sits above the screenshot, clear of the route under it", async ({ page }) => {
|
||||
await serveSyntheticWorkspace(page);
|
||||
await page.goto("/screens");
|
||||
const card = page.locator(".screens-page .screen-screenshot-card:not(.selected)").nth(1);
|
||||
const target = card.locator(".screen-screenshot-target");
|
||||
await target.scrollIntoViewIfNeeded();
|
||||
await target.hover();
|
||||
const tooltip = page.locator(".tooltip", { hasText: "Open in Inspector" });
|
||||
await expect(tooltip).toBeVisible();
|
||||
const [bubble, screenshot, title] = await Promise.all([
|
||||
tooltip.boundingBox(), target.boundingBox(), card.locator(".screen-node-heading").boundingBox(),
|
||||
]);
|
||||
expect(bubble!.y + bubble!.height).toBeLessThanOrEqual(screenshot!.y);
|
||||
expect(title!.y).toBeGreaterThanOrEqual(screenshot!.y + screenshot!.height - 1);
|
||||
});
|
||||
|
||||
test("a narrow window with a mouse gets the phone map's Open pill on the selected screen, as it has no tooltips", async ({ page }) => {
|
||||
// The phone layout is a width, not a device: the first click there only selects, as a tap does.
|
||||
await page.setViewportSize({ width: 800, height: 820 });
|
||||
await serveSyntheticWorkspace(page);
|
||||
await page.goto("/map?screen=area-0-screen-1");
|
||||
expect(await page.evaluate(() => matchMedia("(hover: hover)").matches)).toBe(true);
|
||||
await expect(page.locator(".app-shell.phone-layout")).toHaveCount(1);
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
|
||||
await expect(selected.locator(".screen-open-hint")).toBeVisible();
|
||||
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(1);
|
||||
});
|
||||
|
||||
test("fits a landscape Map capture at render time without app-specific dimensions", async ({ page }) => {
|
||||
const source = viewerMapFixture() as ExploreMap;
|
||||
await serveMap(page, {
|
||||
@@ -4312,7 +4464,6 @@ test("desktop Compare: one command bar with the modes in it, even gaps to both b
|
||||
await expect(divider).toHaveAttribute("aria-valuenow", "45");
|
||||
const dividerAt = async () => Number(await divider.getAttribute("aria-valuenow"));
|
||||
await page.keyboard.down("BracketRight");
|
||||
await expect(divider).toHaveAttribute("aria-valuenow", "50");
|
||||
await expect.poll(dividerAt, { timeout: 4000 }).toBeGreaterThanOrEqual(65);
|
||||
await page.keyboard.up("BracketRight");
|
||||
const dividerHeld = await dividerAt();
|
||||
@@ -4488,7 +4639,7 @@ test.describe("phone layout", () => {
|
||||
await page.goto("/map");
|
||||
await page.getByRole("button", { name: "Search", exact: true }).tap();
|
||||
await page.keyboard.type("c");
|
||||
await expect(page.locator(".search-command-section-label")).toBeVisible();
|
||||
await expect(page.locator(".search-command-section-label").first()).toBeVisible();
|
||||
expect(await offScaleText(page, ".search-command")).toEqual([]);
|
||||
// iOS zooms into any field under 16px.
|
||||
expect(await page.locator(".search-command-input-row input").evaluate((element) => getComputedStyle(element).fontSize))
|
||||
@@ -5053,3 +5204,213 @@ test("the theme is Auto until the toggle picks one: it follows the system, then
|
||||
await expect(html).toHaveAttribute("data-theme", "light");
|
||||
await expect(page.getByRole("button", { name: "Toggle theme" })).toHaveAttribute("data-theme-preference", "light");
|
||||
});
|
||||
|
||||
test("/ finds screens on the Screens page: the tree and the grid narrow to the query, Enter picks the first match, Esc clears then closes", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/screens");
|
||||
const grid = page.getByRole("main", { name: "Screens" });
|
||||
const cells = grid.locator(".screens-grid .screens-cell");
|
||||
const treeRows = grid.locator(".screens-tree-row[data-screen-id]");
|
||||
await expect(cells.first()).toBeVisible();
|
||||
const all = await cells.count();
|
||||
const titles = await cells.locator(".screen-node-title").allTextContents();
|
||||
// A query that keeps some screens and drops others: the last path segment of a route only some routes share.
|
||||
const query = titles.map(title => title.split("/").filter(Boolean).at(-1) ?? "")
|
||||
.find(segment => segment && titles.filter(title => title.includes(segment)).length < titles.length)!;
|
||||
expect(query).toBeTruthy();
|
||||
|
||||
// Opening the field does not move the tree under it: the head keeps one height in every state.
|
||||
const heading = grid.locator(".screens-tree h2");
|
||||
const headingTop = (await heading.boundingBox())!.y;
|
||||
await page.keyboard.press("/");
|
||||
const field = grid.getByRole("searchbox", { name: "Find screens" });
|
||||
await expect(field).toBeFocused();
|
||||
expect((await heading.boundingBox())!.y).toBe(headingTop);
|
||||
await field.fill(query);
|
||||
const matching = titles.filter(title => title.toLowerCase().includes(query.toLowerCase()));
|
||||
await expect(cells).toHaveCount(matching.length);
|
||||
for (const title of await cells.locator(".screen-node-title").allTextContents()) expect(title.toLowerCase()).toContain(query.toLowerCase());
|
||||
await expect(treeRows).toHaveCount(matching.length);
|
||||
// Every row stays open while finding, so the fold-all control steps aside.
|
||||
await expect(grid.locator(".screens-tree-fold-all")).toHaveCount(0);
|
||||
|
||||
// The results are the field's: ↓ and ↑ step the pick through them while typing can go on; Return opens the pick.
|
||||
await field.press("ArrowDown");
|
||||
await expect(cells.nth(0).locator(".screen-screenshot-card")).toHaveClass(/selected/);
|
||||
await expect(field).toBeFocused();
|
||||
if (matching.length > 1) {
|
||||
await field.press("ArrowDown");
|
||||
await expect(cells.nth(1).locator(".screen-screenshot-card")).toHaveClass(/selected/);
|
||||
await field.press("ArrowUp");
|
||||
await expect(cells.nth(0).locator(".screen-screenshot-card")).toHaveClass(/selected/);
|
||||
}
|
||||
await expect(page.getByRole("complementary", { name: "Inspector panel" })).toBeHidden();
|
||||
await field.press("Enter");
|
||||
await expect(page.getByRole("complementary", { name: "Inspector panel" })).toBeVisible();
|
||||
await expect(cells.first().locator(".screen-screenshot-card")).toHaveClass(/selected/);
|
||||
await expect(cells).toHaveCount(matching.length);
|
||||
await expect(field).toBeFocused();
|
||||
|
||||
await field.fill("no-such-route-anywhere");
|
||||
await expect(grid.getByRole("status").filter({ hasText: "No screens match" }).first()).toBeVisible();
|
||||
await field.press("Escape");
|
||||
await expect(field).toHaveValue("");
|
||||
await expect(cells).toHaveCount(all);
|
||||
await field.press("Escape");
|
||||
await expect(field).toHaveCount(0);
|
||||
await expect(grid.getByRole("button", { name: "Find a screen" })).toBeVisible();
|
||||
|
||||
// From the Map, "/" opens Screens with the field focused.
|
||||
await chooseCanvasView(page, "Map");
|
||||
await expect(page.getByRole("main", { name: "Screens" })).toHaveCount(0);
|
||||
await page.keyboard.press("/");
|
||||
await expect(page.getByRole("main", { name: "Screens" }).getByRole("searchbox", { name: "Find screens" })).toBeFocused();
|
||||
});
|
||||
|
||||
test("⌘K is a command palette: suggested commands lead, word queries rank commands first and run on Enter, route queries rank screens first", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/map");
|
||||
const mod = process.platform === "darwin" ? "Meta" : "Control";
|
||||
await page.keyboard.press(`${mod}+KeyK`);
|
||||
const palette = page.getByRole("dialog", { name: "Search Explore" });
|
||||
await expect(palette).toBeVisible();
|
||||
const box = palette.getByRole("combobox", { name: "Search screens and commands" });
|
||||
await expect(box).toBeFocused();
|
||||
|
||||
// The empty palette suggests what to do next on this canvas, not the screen inventory.
|
||||
const suggested = palette.getByRole("group", { name: "Suggested" });
|
||||
await expect(suggested.getByRole("option").filter({ hasText: "Next changed screen" })).toBeVisible();
|
||||
expect(await palette.getByRole("option").count()).toBeLessThanOrEqual(7);
|
||||
|
||||
// A word query ranks commands first; each prints the key that also runs it.
|
||||
await box.fill("dark");
|
||||
await expect(palette.getByRole("option").first()).toContainText("Theme: Dark");
|
||||
await box.fill("fit");
|
||||
const fit = palette.getByRole("option").filter({ hasText: "Fit the canvas" });
|
||||
await expect(fit).toBeVisible();
|
||||
await expect(fit.locator("kbd")).toBeVisible();
|
||||
|
||||
// Enter runs the command.
|
||||
await box.fill("dark");
|
||||
await box.press("Enter");
|
||||
await expect(palette).toHaveCount(0);
|
||||
await expect(page.locator("html")).toHaveAttribute("data-theme", "dark");
|
||||
|
||||
// A route-shaped query ranks screens first, with the commands after them.
|
||||
await page.keyboard.press(`${mod}+KeyK`);
|
||||
await box.fill("/");
|
||||
await expect(palette.getByRole("option").first().locator("code")).toBeVisible();
|
||||
await expect(palette.getByRole("group", { name: "Screens" })).toBeVisible();
|
||||
|
||||
// A navigation command.
|
||||
await box.fill("screens");
|
||||
await expect(palette.getByRole("option").first()).toHaveText(/^Screens/);
|
||||
await box.press("Enter");
|
||||
await expect(page.getByRole("main", { name: "Screens" })).toBeVisible();
|
||||
});
|
||||
|
||||
test("⌘K steps through its results in the order it shows them, and a command that opens a menu keeps it open", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/map");
|
||||
await page.getByRole("button", { name: "Search", exact: true }).click();
|
||||
const palette = page.getByRole("dialog", { name: "Search Explore" });
|
||||
const box = palette.getByRole("combobox", { name: "Search screens and commands" });
|
||||
// "c" matches commands and screens alike: ↓ walks the rows top to bottom, across the sections.
|
||||
await box.fill("c");
|
||||
const options = palette.getByRole("option");
|
||||
const count = await options.count();
|
||||
expect(await palette.getByRole("group").count()).toBe(2);
|
||||
for (let step = 0; step < count; step += 1) {
|
||||
await expect(options.nth(step)).toHaveAttribute("aria-selected", "true");
|
||||
await expect(box).toHaveAttribute("aria-activedescendant", (await options.nth(step).getAttribute("id"))!);
|
||||
await box.press("ArrowDown");
|
||||
}
|
||||
await expect(options.first()).toHaveAttribute("aria-selected", "true");
|
||||
|
||||
// The palette hands focus to the menu it opens instead of taking it back.
|
||||
await box.fill("Changed screens menu");
|
||||
await box.press("Enter");
|
||||
await expect(palette).toHaveCount(0);
|
||||
await expect(page.locator(".changes-menu")).toBeVisible();
|
||||
await expect(page.locator(".changes-menu-body")).toBeFocused();
|
||||
});
|
||||
|
||||
test("a / from the Map opens the find once: Screens opened again from the toolbar comes up without it", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/map");
|
||||
await page.keyboard.press("/");
|
||||
const grid = page.getByRole("main", { name: "Screens" });
|
||||
const field = grid.getByRole("searchbox", { name: "Find screens" });
|
||||
await expect(field).toBeFocused();
|
||||
await field.press("Escape");
|
||||
await expect(field).toHaveCount(0);
|
||||
|
||||
await chooseCanvasView(page, "Map");
|
||||
await chooseCanvasView(page, "Screens");
|
||||
await expect(grid.locator(".screens-grid .screens-cell").first()).toBeVisible();
|
||||
await expect(grid.getByRole("button", { name: "Find a screen" })).toBeVisible();
|
||||
await expect(field).toHaveCount(0);
|
||||
});
|
||||
|
||||
test("the find's keys stay in its field: Return on the clear button clears, and Return while composing text opens nothing", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/screens");
|
||||
const grid = page.getByRole("main", { name: "Screens" });
|
||||
const inspector = page.getByRole("complementary", { name: "Inspector panel" });
|
||||
await expect(grid.locator(".screens-grid .screens-cell").first()).toBeVisible();
|
||||
await page.keyboard.press("/");
|
||||
const field = grid.getByRole("searchbox", { name: "Find screens" });
|
||||
await field.fill("/");
|
||||
await field.press("Tab");
|
||||
await expect(grid.getByRole("button", { name: "Clear find query" })).toBeFocused();
|
||||
await page.keyboard.press("Enter");
|
||||
await expect(field).toHaveValue("");
|
||||
await expect(inspector).toBeHidden();
|
||||
|
||||
await field.fill("/");
|
||||
// An input method's Return confirms the composed text; it is not the find's Return.
|
||||
await field.evaluate((input) => input.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", code: "Enter", isComposing: true, bubbles: true, cancelable: true })));
|
||||
await page.waitForTimeout(200);
|
||||
await expect(inspector).toBeHidden();
|
||||
});
|
||||
|
||||
test("a find inside Changed that only matches other screens says so and offers All", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/screens");
|
||||
const grid = page.getByRole("main", { name: "Screens" });
|
||||
const cells = grid.locator(".screens-grid .screens-cell");
|
||||
const titles = () => cells.locator(".screen-node-title").allTextContents();
|
||||
await expect(cells.first()).toBeVisible();
|
||||
const all = await titles();
|
||||
await grid.getByRole("button", { name: /^Changed/ }).click();
|
||||
await expect.poll(async () => (await titles()).length).toBeLessThan(all.length);
|
||||
const changed = (await titles()).map(title => title.toLowerCase());
|
||||
const query = all.find(title => !changed.some(other => other.includes(title.toLowerCase())));
|
||||
test.skip(!query, "every unchanged screen's title is part of a changed one's");
|
||||
|
||||
await page.keyboard.press("/");
|
||||
const field = grid.getByRole("searchbox", { name: "Find screens" });
|
||||
await field.fill(query!);
|
||||
await expect(grid.getByRole("status").filter({ hasText: `No changed screens match “${query}”` }).first()).toBeVisible();
|
||||
await grid.getByRole("button", { name: /^Show all/ }).click();
|
||||
await expect(cells.filter({ hasText: query! }).first()).toBeVisible();
|
||||
await expect(field).toBeFocused();
|
||||
await field.press("Escape");
|
||||
await field.press("Escape");
|
||||
await expect(grid.getByRole("button", { name: /^All/ })).toHaveAttribute("aria-pressed", "true");
|
||||
});
|
||||
|
||||
test("a find left on when the window narrows to the phone layout does not filter the phone's screens", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/screens");
|
||||
const grid = page.getByRole("main", { name: "Screens" });
|
||||
const cells = grid.locator(".screens-grid .screens-cell");
|
||||
await expect(cells.first()).toBeVisible();
|
||||
await grid.getByRole("button", { name: /^All/ }).click();
|
||||
const all = await cells.count();
|
||||
await page.keyboard.press("/");
|
||||
await grid.getByRole("searchbox", { name: "Find screens" }).fill("no-such-route-anywhere");
|
||||
await expect(cells).toHaveCount(0);
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await expect(cells).toHaveCount(all);
|
||||
});
|
||||
@@ -27,7 +27,10 @@ export async function createBrowserVite(test, options) {
|
||||
});
|
||||
const requested = options.server;
|
||||
const port = requested?.port === 0 ? await freePort(requested.host ?? "127.0.0.1") : requested?.port;
|
||||
server = await createServer({ ...options, cacheDir,
|
||||
// A cold cacheDir optimizes dependencies as the page asks for them; one found late (the JSX dev runtime, which
|
||||
// esbuild's JSX imports) makes Vite reload the page, dropping whatever the test has done in it.
|
||||
const optimizeDeps = { ...options.optimizeDeps, include: [...(options.optimizeDeps?.include ?? []), "react/jsx-dev-runtime"] };
|
||||
server = await createServer({ ...options, cacheDir, optimizeDeps,
|
||||
...(requested ? { server: { ...requested, port, ...(requested.port === 0 ? { strictPort: true } : {}) } } : {}) });
|
||||
return server;
|
||||
}
|
||||
@@ -8,11 +8,13 @@ import { createHash } from 'node:crypto';
|
||||
import { PNG } from 'pngjs';
|
||||
import { AGENT_DEVICE_VERSION } from '../../dist/capture/run.js';
|
||||
import { CAPTURE_OBSERVER_IDENTIFIER } from '../../dist/capture/observer.js';
|
||||
import { controllerCacheRoot, ensureController } from '../../dist/shared/controller-cache.js';
|
||||
import { writeCaptureObserverPackages } from './capture-observer-fixture.mjs';
|
||||
|
||||
/**
|
||||
* In-process public CI fixture: a git project with base/head commits plus mocked `eas`, `repack-app`,
|
||||
* `agent-device` and GitHub transports, so a review runs end to end without network or a simulator.
|
||||
* `agent-device` and GitHub transports, so a review runs end to end without a simulator, and without network once the
|
||||
* real agent-device that compares screenshots is cached.
|
||||
*/
|
||||
|
||||
export const PROJECT_ID = '00000000-0000-4000-8000-000000000001';
|
||||
@@ -27,6 +29,17 @@ export const usageReceipt = (overrides = {}) => ({ provider: 'anthropic', model:
|
||||
totals: { inputTokens: 100, outputTokens: 20, cacheReadInputTokens: 40, estimatedCostUsd: 0.012 },
|
||||
models: [{ model: 'fixture-model', inputTokens: 100, outputTokens: 20, cacheReadInputTokens: 40, estimatedCostUsd: 0.012, costBasis: 'list' }],
|
||||
...overrides });
|
||||
|
||||
/**
|
||||
* The review's screenshot comparison runs the real agent-device, which fetches itself on first use. The fixture fetches
|
||||
* it once, with retries, into the machine's controller cache, so a review never downloads it mid-run.
|
||||
*/
|
||||
const CONTROLLER_CACHE = controllerCacheRoot(process.env);
|
||||
for (let attempt = 1; ; attempt++) {
|
||||
try { await ensureController('agent-device', { environment: { ...process.env, EXPLORE_CONTROLLER_CACHE: CONTROLLER_CACHE } }); break; }
|
||||
catch (error) { if (attempt === 3) throw error; await new Promise(resolve => setTimeout(resolve, attempt * 2_000)); }
|
||||
}
|
||||
|
||||
export async function readUsage(output) {
|
||||
const path = join(output, 'agent-usage.jsonl');
|
||||
assert.equal((await stat(path)).mode & 0o777, 0o600, 'usage receipts are private artifacts');
|
||||
@@ -103,7 +116,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
const pr = { repositoryId: '123', repository: 'acme/example', number: 7, title: 'Source capture integration', url: 'https://github.com/acme/example/pull/7',
|
||||
base: { ref: 'main', sha: baseSha }, head: { ref: 'feature', sha: headSha } };
|
||||
const pullRequestPath = join(root, 'pull-request.json'); await writeFile(pullRequestPath, JSON.stringify(pr));
|
||||
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
|
||||
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPLORE_CONTROLLER_CACHE: CONTROLLER_CACHE, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
|
||||
GITHUB_RUN_ID: '1234', GITHUB_RUN_ATTEMPT: '1', GITHUB_REPOSITORY: pr.repository, TOOLS_COMMIT: 'c'.repeat(40), EXPLORE_VIEWER_ORIGIN: 'https://viewer.example' };
|
||||
const requests = []; const comments = []; const sessions = new Map(); let currentSession; const idleDevice = { path: '/', scheme: 'light' }; let sessionCounter = 0; let repackedSha; let openFailed = false;
|
||||
const identity = (session) => ({ session: 'expo-explore-runtime', appBundleId: config.app.bundleId,
|
||||
@@ -206,7 +219,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
] });
|
||||
}
|
||||
if (command === 'settings') { if (request.args[1] === 'appearance') device.scheme = request.args[2]; return ok({ setting: request.args[1], value: request.args[2] }); }
|
||||
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
|
||||
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); /* Hashed colours can land within the diff threshold, so /home's red channel keeps the base build apart from any other. */ if (device.path === '/home') color[0] = device.build?.endsWith(baseSha) ? 0 : 255; const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
|
||||
}
|
||||
throw new Error(`Unexpected mocked command: ${request.command} ${request.args.join(' ')}`);
|
||||
};
|
||||
|
||||
@@ -87,7 +87,7 @@ test("the Android controller open response is accepted only for the Android plat
|
||||
assert.throws(() => openedSimulatorDevice(response, "dev.brent.euxy", "open", "ios"), /full ios device shape/);
|
||||
});
|
||||
|
||||
test("the PR comment names Android builds and runtimes", () => {
|
||||
test("the PR comment names the Android target while it captures", () => {
|
||||
const pullRequest = { repositoryId: "1", repository: "expo/explore-playground", number: 1, title: "Android", url: "https://github.com/expo/explore-playground/pull/1",
|
||||
base: { ref: "main", sha: "a".repeat(40) }, head: { ref: "android", sha: "b".repeat(40) } };
|
||||
const body = renderPublicComment({
|
||||
@@ -99,7 +99,8 @@ test("the PR comment names Android builds and runtimes", () => {
|
||||
deviceModel: "EasAndroidDevice01", osVersion: "35", locale: "en-US", orientation: "portrait", colorScheme: "light" },
|
||||
capture: { planned: { base: 3, head: 3 }, done: { base: 0, head: 1 }, baseFromCache: false },
|
||||
});
|
||||
assert.match(body, /\| Android \| EasAndroidDevice01 35 · euxy 1\\\.2\\\.0 \\\(1\\\) \| ⏳ capturing head 1\/3 \|/);
|
||||
assert.match(body, /^### Explore review · capturing$/m);
|
||||
assert.match(body, /^Android · capturing head 1\/3 · \[run\]\(<[^>]+>\)$/m);
|
||||
assert.doesNotMatch(body, /iOS/);
|
||||
});
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import test from "node:test";
|
||||
|
||||
const root = resolve(import.meta.dirname, "../..");
|
||||
const cli = join(root, "dist", "cli.js");
|
||||
const { defaultOutputDirectory, expiresInDays } = await import(join(root, "dist", "cli", "binary-commands.js"));
|
||||
const { defaultOutputDirectory } = await import(join(root, "dist", "cli", "binary-commands.js"));
|
||||
|
||||
function fail(args) {
|
||||
// Without an EAS login (as on CI) argument and archive errors must still come first.
|
||||
@@ -28,7 +28,6 @@ test("explore:binary is in the short help with its archive kinds and --no-upload
|
||||
test("explore:binary validates its arguments before touching EAS or a model", () => {
|
||||
assert.match(fail([]), /Pass the app archive/);
|
||||
assert.match(fail(["./app.apk", "--upload", "--no-upload"]), /either --upload or --no-upload/);
|
||||
assert.match(fail(["./app.apk", "--expires-in", "400d"]), /--expires-in must be 1d to 90d, or never/);
|
||||
assert.match(fail(["./app.apk", "--platform", "web"]), /platform/);
|
||||
assert.match(fail(["./app.apk", "--simulator", "cloud"]), /simulator/);
|
||||
// A local run needs no EAS login, so the archive is the first thing it checks.
|
||||
@@ -40,9 +39,10 @@ test("explore:binary validates its arguments before touching EAS or a model", ()
|
||||
assert.match(human.stderr, /Archive not found: .*does-not-exist\.apk\n→ Check the path/);
|
||||
});
|
||||
|
||||
test("expiry and output directory defaults", () => {
|
||||
assert.equal(expiresInDays("7d"), 7); assert.equal(expiresInDays("90d"), 90); assert.equal(expiresInDays("never"), null);
|
||||
assert.throws(() => expiresInDays("0d")); assert.throws(() => expiresInDays("7")); assert.throws(() => expiresInDays("91d"));
|
||||
test("--expires-in is accepted from older scripts and says it no longer applies; output directory defaults", () => {
|
||||
const ignored = spawnSync(process.execPath, [cli, "explore:binary", "./does-not-exist.apk", "--no-upload", "--expires-in", "400d"], { cwd: root, encoding: "utf8", env: { ...process.env, EXPO_TOKEN: "", EXPO_SESSION_SECRET: "", GITHUB_ACTIONS: "" } });
|
||||
assert.match(ignored.stderr, /^--expires-in no longer applies: a hosted preview lasts as long as its EAS Hosting deployment/m);
|
||||
assert.match(ignored.stderr, /Archive not found/, "and the run goes on");
|
||||
const now = new Date("2026-10-11T16:28:48.123Z");
|
||||
assert.equal(defaultOutputDirectory("/builds/euxy-ios.tar.gz", now), "explore-euxy-ios-20261011-1628");
|
||||
assert.equal(defaultOutputDirectory("My App (1).app", now), "explore-My-App-1-20261011-1628");
|
||||
|
||||
@@ -94,6 +94,31 @@ test("reviewed build diff preserves exact cross-build evidence and split/merge s
|
||||
);
|
||||
});
|
||||
|
||||
test("a screen diff carries the compared screenshot's recorded shape, After's first", async () => {
|
||||
const fixture = await createBuildWorkspaceFixture();
|
||||
const currentBuild = fixture.catalog.builds.find((build) => build.id === "build-2.0.0");
|
||||
const baselineBuild = fixture.catalog.builds.find((build) => build.id === "build-1.0.0");
|
||||
const artifact = (map, id) => map.artifacts.find((entry) => entry.id === `artifact-observation-${id}`);
|
||||
// The reviewed After turned landscape; Before stays portrait.
|
||||
Object.assign(artifact(fixture.currentMap, "build-2.0.0-current-profile-reviewed"), { width: 60, height: 30 });
|
||||
// A capture without a recorded size (not a PNG) gives the frame nothing to take.
|
||||
const added = artifact(fixture.currentMap, "build-2.0.0-current-added-primary");
|
||||
delete added.width;
|
||||
delete added.height;
|
||||
|
||||
const diff = diffModel.buildDiff({
|
||||
currentBuild,
|
||||
currentMap: fixture.currentMap,
|
||||
baselineBuild,
|
||||
baselineMap: fixture.baselineMap,
|
||||
comparison: fixture.comparison,
|
||||
});
|
||||
|
||||
assert.equal(diff.screens.get("current-profile")?.screenshotAspect, 2);
|
||||
assert.equal(diff.screens.get(removedScreenId("build-1.0.0", "baseline-legacy"))?.screenshotAspect, 0.5);
|
||||
assert.equal(diff.screens.get("current-added")?.screenshotAspect, undefined);
|
||||
});
|
||||
|
||||
test("catalog route context contains only the two real builds", async () => {
|
||||
const fixture = await createBuildWorkspaceFixture();
|
||||
assert.deepEqual(diffModel.routeContextForCatalog(fixture.catalog), {
|
||||
|
||||
@@ -145,7 +145,8 @@ async function fixture(t, settings = {}) {
|
||||
if (request.args[1]?.includes('server start')) {
|
||||
const port = 4100 + serverStarts++;
|
||||
writeFileSync(request.environment.EXPLORE_ARGENT_SERVER_LOG, ` (or: argent link --host 127.0.0.1 --port ${port} --token abc123)\n[t] Tools server listening on http://127.0.0.1:${port}\n`);
|
||||
return { stdout: `${4242 + serverStarts}\n`, stderr: '' };
|
||||
// A pid no process can have: stopping the server signals it for real.
|
||||
return { stdout: `${999_999_000 + serverStarts}\n`, stderr: '' };
|
||||
}
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
|
||||
@@ -48,12 +48,12 @@ test('any two commits: a capture and report like a pull request\'s, with no pull
|
||||
environment: { ...f.environment, GITHUB_TOKEN: '', GITHUB_STEP_SUMMARY: targetSummary }, transport: async input => assert.fail(`no GitHub request: ${input}`) });
|
||||
assert.match(await readFile(targetSummary, 'utf8'), /^- iPhone Duo \\\[open\\\] report of `v1\.1\.0` vs `v1\.0\.0`: \[Open\]\(https:\/\/explore-preview\.expo\.app\/\?repo=acme%2Fexample&run=1234&attempt=1&target=duo-open&artifact=900\) · /);
|
||||
|
||||
const summary = renderCompareSummary(result.review.pullRequest, 'https://example.expo.app/p/token', null, [await readCiReportInput(result.inputPath)]);
|
||||
const summary = renderCompareSummary(result.review.pullRequest, 'https://example.expo.app/p/token', [await readCiReportInput(result.inputPath)]);
|
||||
assert.match(summary, /^### Explore: `v1\.1\.0` vs `v1\.0\.0`$/m);
|
||||
// Refs are code spans: one with ] ( ) would otherwise break the line's links. A caller's own title is one span.
|
||||
const odd = { ...result.review.pullRequest, base: { ...result.review.pullRequest.base, ref: 'x](evil)' }, title: 'v1.1.0 vs x](evil)' };
|
||||
assert.match(renderCompareSummary(odd, 'https://example.expo.app/p/token', null, []), /^### Explore: `v1\.1\.0` vs `x\]\(evil\)`$/m);
|
||||
assert.match(renderCompareSummary({ ...odd, title: 'Nightly `build`' }, 'https://example.expo.app/p/token', null, []), /^### Explore: `Nightly 'build'`$/m);
|
||||
assert.match(renderCompareSummary(odd, 'https://example.expo.app/p/token', []), /^### Explore: `v1\.1\.0` vs `x\]\(evil\)`$/m);
|
||||
assert.match(renderCompareSummary({ ...odd, title: 'Nightly `build`' }, 'https://example.expo.app/p/token', []), /^### Explore: `Nightly 'build'`$/m);
|
||||
|
||||
// capture:review's preview output starts the deploy job only when the reviewed config hosts the report.
|
||||
const outputs = join(f.root, 'outputs');
|
||||
|
||||
@@ -17,6 +17,7 @@ function element(options = {}) {
|
||||
label: options.label ?? "Continue",
|
||||
...(options.visible === undefined ? { visible: true } : { visible: options.visible }),
|
||||
...(options.selector === undefined ? {} : { selector: options.selector }),
|
||||
...(options.bounds === undefined ? {} : { bounds: options.bounds }),
|
||||
occurrence: options.occurrence ?? 0,
|
||||
controller: "agent-device",
|
||||
actions: options.actions ?? ["press"],
|
||||
@@ -320,6 +321,104 @@ test("keeps an unannotated label delta in the accessibility category", () => {
|
||||
);
|
||||
});
|
||||
|
||||
test("a label that varies within both builds, in the words that differ between them, is runtime state", () => {
|
||||
const stamp = (label) => [element({ elementId: "stamp", identifier: "stamp", role: "text", label, actions: [], actionable: false })];
|
||||
const sibling = (base, head) => ({ base: side("base", base), head: side("head", head) });
|
||||
const input = {
|
||||
impact: impact(),
|
||||
base: side("base", stamp("edited 2m ago")),
|
||||
head: side("head", stamp("edited 3m ago")),
|
||||
visualAssessment: visual(),
|
||||
};
|
||||
const plain = supportedChanges(compareSurfaceEvidence(input));
|
||||
assert.ok(plain.some((change) => change.kind === "accessibility-label-changed"), "without a sibling capture the label difference is a change");
|
||||
|
||||
const result = compareSurfaceEvidence({ ...input, siblings: [sibling(stamp("edited 1m ago"), stamp("edited 4m ago"))] });
|
||||
const changes = supportedChanges(result);
|
||||
assert.deepEqual(changes.map((change) => change.kind), ["unstable-text"]);
|
||||
assert.deepEqual(changes[0], { kind: "unstable-text", subjectRole: "text", before: "edited 2m ago", after: "edited 3m ago", within: "edited 4m ago" });
|
||||
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
|
||||
assert.deepEqual(summary.facts.map((fact) => [fact.templateId, fact.bullet]),
|
||||
[["visible-text.unstable-within-build", "Text varies between captures of the same build: \u201cedited 2m ago\u201d / \u201cedited 4m ago\u201d / \u201cedited 3m ago\u201d."]]);
|
||||
assert.equal(summary.needsReview, false);
|
||||
|
||||
// A stable label beside it is still a change.
|
||||
const save = (label) => element({ identifier: "save", label });
|
||||
const mixed = compareSurfaceEvidence({
|
||||
...input,
|
||||
base: side("base", [...stamp("edited 2m ago"), save("Submit")]),
|
||||
head: side("head", [...stamp("edited 3m ago"), save("Save")]),
|
||||
siblings: [sibling([...stamp("edited 1m ago"), save("Submit")], [...stamp("edited 4m ago"), save("Save")])],
|
||||
});
|
||||
assert.deepEqual(supportedChanges(mixed).map((change) => change.kind).sort(), ["accessibility-label-changed", "unstable-text"]);
|
||||
// Pixels that only an unstable label explains still get the generic styling line.
|
||||
const pixels = compareSurfaceEvidence({ ...input, visualAssessment: visual("modified"), siblings: [sibling(stamp("edited 1m ago"), stamp("edited 4m ago"))] });
|
||||
assert.deepEqual(supportedChanges(pixels).map((change) => change.kind), ["unstable-text", "visual-changed"]);
|
||||
});
|
||||
|
||||
test("a label that follows the appearance, or changed in a word that does not vary, is still a change", () => {
|
||||
const label = (text) => [element({ identifier: "toggle", label: text })];
|
||||
const compare = ([baseLight, baseDark], [headLight, headDark], options = {}) => supportedChanges(compareSurfaceEvidence({
|
||||
impact: impact(),
|
||||
base: side("base", label(baseLight), options.base),
|
||||
head: side("head", label(headLight), options.head),
|
||||
visualAssessment: visual(),
|
||||
siblings: [{ base: side("base", label(baseDark)), head: side("head", label(headDark), options.headSibling) }],
|
||||
})).map((change) => change.kind);
|
||||
// The theme toggle's label follows the appearance; the head broke it in light only.
|
||||
assert.deepEqual(compare(["Switch to dark mode", "Switch to light mode"], ["Switch to light mode", "Switch to light mode"]), ["accessibility-label-changed"]);
|
||||
assert.deepEqual(compare(["Switch to dark mode", "Switch to light mode"], ["Enable dark mode", "Switch to light mode"]), ["accessibility-label-changed"]);
|
||||
// The base varies, the head does not.
|
||||
assert.deepEqual(compare(["Save", "Save draft"], ["Submit", "Submit"]), ["accessibility-label-changed"]);
|
||||
// The time varies; the name beside it changed.
|
||||
assert.deepEqual(compare(["Posted by Alice · 2m", "Posted by Alice · 3m"], ["Posted by Bob · 4m", "Posted by Bob · 5m"]), ["accessibility-label-changed"]);
|
||||
// A sibling capture that did not resolve cleanly is no evidence.
|
||||
assert.deepEqual(compare(["Saved 2m ago", "Saved 3m ago"], ["Saved 4m ago", "Saved 5m ago"], { headSibling: { capturedSamples: 1 } }), ["accessibility-label-changed"]);
|
||||
assert.deepEqual(compare(["Saved 2m ago", "Saved 3m ago"], ["Saved 4m ago", "Saved 5m ago"]), ["unstable-text"]);
|
||||
|
||||
// Provenance on one side only stays inconclusive.
|
||||
const annotation = [{ identifier: "toggle", role: "button", textSource: "visible-title" }];
|
||||
const result = compareSurfaceEvidence({
|
||||
impact: impact(),
|
||||
base: side("base", label("Saved 2m ago"), { annotations: annotation }),
|
||||
head: side("head", label("Saved 4m ago")),
|
||||
visualAssessment: visual(),
|
||||
siblings: [{ base: side("base", label("Saved 3m ago"), { annotations: annotation }), head: side("head", label("Saved 5m ago")) }],
|
||||
});
|
||||
assert.equal(result.needsReview, true);
|
||||
assert.ok(result.reviewReasons.some((reason) => /provenance.*one side/i.test(reason)));
|
||||
assert.equal(supportedChanges(result).some((change) => change.kind === "unstable-text"), false);
|
||||
});
|
||||
|
||||
test("text without an identifier that varies within both builds is matched by its place, not its label", () => {
|
||||
const bounds = { x: 0, y: 120, width: 390, height: 64 };
|
||||
// A pattern row: a pressable with one accessibility label and no testID, exposed again by its container on iOS.
|
||||
const row = (label) => [
|
||||
element({ elementId: "row", role: "button", label, selector: `label=${label}`, bounds }),
|
||||
element({ elementId: "row-cell", role: "other", label, selector: `label=${label}`, bounds, actions: [], actionable: false }),
|
||||
];
|
||||
const compare = (baseLabels, headLabels) => compareSurfaceEvidence({
|
||||
impact: impact(),
|
||||
base: side("base", row(baseLabels[0])),
|
||||
head: side("head", row(headLabels[0])),
|
||||
visualAssessment: visual(),
|
||||
...(baseLabels[1] ? { siblings: [{ base: side("base", row(baseLabels[1])), head: side("head", row(headLabels[1])) }] } : {}),
|
||||
});
|
||||
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo, 4 lanes, edited 2m ago"], ["Velvet Tresillo, 4 lanes, edited 4m ago"])).map((change) => change.kind).sort(),
|
||||
["element-added", "element-removed"], "without a sibling capture the row left and arrived");
|
||||
|
||||
const result = compare(["Velvet Tresillo, 4 lanes, edited 2m ago", "Velvet Tresillo, 4 lanes, edited 3m ago"],
|
||||
["Velvet Tresillo, 4 lanes, edited 4m ago", "Velvet Tresillo, 4 lanes, edited 5m ago"]);
|
||||
assert.deepEqual(supportedChanges(result), [{ kind: "unstable-text", subjectRole: "button",
|
||||
before: "Velvet Tresillo, 4 lanes, edited 2m ago", after: "Velvet Tresillo, 4 lanes, edited 4m ago", within: "Velvet Tresillo, 4 lanes, edited 5m ago" }]);
|
||||
assert.equal(result.needsReview, false);
|
||||
// A random name is runtime state the same way.
|
||||
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo", "Copper Pulse"], ["Hollow Echo", "Ghost Relay"])).map((change) => change.kind), ["unstable-text"]);
|
||||
// A real change in the same row is still a change.
|
||||
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo, 4 lanes, edited 2m ago", "Velvet Tresillo, 4 lanes, edited 3m ago"],
|
||||
["Velvet Tresillo, 5 lanes, edited 4m ago", "Velvet Tresillo, 5 lanes, edited 5m ago"])).map((change) => change.kind).sort(), ["element-added", "element-removed"]);
|
||||
});
|
||||
|
||||
test("fails closed when visible-title provenance exists on only one side", () => {
|
||||
const annotation = [{
|
||||
identifier: "primary-cta",
|
||||
|
||||
@@ -173,18 +173,17 @@ test("agent instruction files must exist inside the repository", async (t) => {
|
||||
assert.equal((await readExploreConfig(project)).agent.instructions, ".expo-explore/instructions.md");
|
||||
});
|
||||
|
||||
test("report.preview opts into hosted previews with a bounded expiry and an optional project slug", () => {
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas" } } }).report,
|
||||
{ preview: { hosting: "eas", expiresAfterDays: 30 } });
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: "14 days", owner: "acme", project: "acme-explore" } } }).report,
|
||||
{ preview: { hosting: "eas", expiresAfterDays: 14, owner: "acme", project: "acme-explore" } });
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: 3 } } }).report?.preview?.expiresAfterDays, 3);
|
||||
assert.equal(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: "365d" } } }).report?.preview?.expiresAfterDays, 365);
|
||||
assert.equal(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: "never" } } }).report?.preview?.expiresAfterDays, null);
|
||||
test("report.preview opts into hosted previews with an optional owner and project slug; an expiry from older configs is ignored", () => {
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas" } } }).report, { preview: { hosting: "eas" } });
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", owner: "acme", project: "acme-explore" } } }).report,
|
||||
{ preview: { hosting: "eas", owner: "acme", project: "acme-explore" } });
|
||||
// A hosted preview lasts as long as its EAS Hosting deployment: an old config's expiresAfter still validates, and is only noted.
|
||||
for (const expiresAfter of ["14 days", 3, "never", "forever"]) {
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter } } }).report, { preview: { hosting: "eas", expiresAfterIgnored: true } });
|
||||
}
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: {} }).report, {});
|
||||
assert.equal(validateExploreConfig(base()).report, undefined);
|
||||
for (const preview of [{ hosting: "vercel" }, { hosting: "eas", expiresAfter: "366d" }, { hosting: "eas", expiresAfter: "0d" }, { hosting: "eas", expiresAfter: "forever" },
|
||||
{ hosting: "eas", expiresAfter: "2 weeks" }, { hosting: "eas", project: "Acme" },
|
||||
for (const preview of [{ hosting: "vercel" }, { hosting: "eas", project: "Acme" },
|
||||
{ hosting: "eas", owner: "Acme Org" }, { hosting: "eas", token: "x" }, {}]) {
|
||||
assert.throws(() => validateExploreConfig({ ...base(), report: { preview } }), /Invalid .expo-explore\/config.yaml: report.preview/);
|
||||
}
|
||||
@@ -194,7 +193,7 @@ test("report.preview opts into hosted previews with a bounded expiry and an opti
|
||||
test("report.comment.map opts the PR comment into its map of changed screens, beside or without a hosted preview", () => {
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { comment: { map: true } } }).report, { comment: { map: true } });
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { comment: { map: false }, preview: { hosting: "eas" } } }).report,
|
||||
{ comment: { map: false }, preview: { hosting: "eas", expiresAfterDays: 30 } });
|
||||
{ comment: { map: false }, preview: { hosting: "eas" } });
|
||||
for (const comment of [{}, { map: "yes" }, { map: true, graph: true }, true]) {
|
||||
assert.throws(() => validateExploreConfig({ ...base(), report: { comment } }), /Invalid .expo-explore\/config.yaml: report.comment/);
|
||||
}
|
||||
|
||||
+107
-7
@@ -2,7 +2,7 @@ import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
|
||||
const { tsImport } = await import("tsx/esm/api");
|
||||
const { HOLD_INITIAL_DELAY_MS, HOLD_FIRST_INTERVAL_MS, HOLD_FLOOR_INTERVAL_MS, createKeyHold, glideRate, holdIntervalMs, holdSchedule } =
|
||||
const { HOLD_INITIAL_DELAY_MS, HOLD_FIRST_INTERVAL_MS, HOLD_FLOOR_INTERVAL_MS, createKeyHold, glideRate, glideWhileHeld, holdIntervalMs, holdSchedule } =
|
||||
await tsImport("../../viewer/src/utils/key-hold.ts", import.meta.url);
|
||||
|
||||
test("a held paging key waits, then steps sooner and sooner down to a floor", () => {
|
||||
@@ -76,10 +76,110 @@ test("another key ends a hold, as the OS's own repeat stops; its own repeats and
|
||||
hold.end();
|
||||
});
|
||||
|
||||
test("a glide picks up from rest, then eases from the stepped hold's first speed up to its top speed", () => {
|
||||
assert.equal(glideRate(0), 0, "it starts at rest, where the tap's step ended");
|
||||
assert.ok(Math.abs(glideRate(80) - 1000 / HOLD_FIRST_INTERVAL_MS) < 0.2, "within a few frames it moves a step per first interval");
|
||||
for (let at = 10; at <= 1200; at += 10) assert.ok(glideRate(at) >= glideRate(at - 10), `never slows, at ${at}ms`);
|
||||
assert.equal(glideRate(1000), 1000 / HOLD_FLOOR_INTERVAL_MS, "after a second, a step per floor interval");
|
||||
assert.equal(glideRate(5000), glideRate(1000), "and no faster");
|
||||
test("a glide moves at its start speed from the key down, then eases up to its top speed", () => {
|
||||
const profile = { startRate: 8, topRate: 20, rampMs: 700 };
|
||||
assert.equal(glideRate(0, profile), 8, "no pause: it moves at full start speed on the first frame");
|
||||
for (let at = 10; at <= 1200; at += 10) assert.ok(glideRate(at, profile) >= glideRate(at - 10, profile), `never slows, at ${at}ms`);
|
||||
assert.equal(glideRate(700, profile), 20, "at the end of the ramp, the top speed");
|
||||
assert.equal(glideRate(5000, profile), 20, "and no faster");
|
||||
});
|
||||
|
||||
/** Frames on demand: `tick` advances the clock and runs the frame callbacks queued so far. */
|
||||
function fakeFrames(t) {
|
||||
let clock = 0;
|
||||
let queue = [];
|
||||
t.mock.method(performance, "now", () => clock);
|
||||
const previous = globalThis.requestAnimationFrame;
|
||||
globalThis.requestAnimationFrame = (callback) => { queue.push(callback); return queue.length; };
|
||||
t.after(() => { globalThis.requestAnimationFrame = previous; });
|
||||
return {
|
||||
tick(ms) {
|
||||
clock += ms;
|
||||
const due = queue;
|
||||
queue = [];
|
||||
for (const callback of due) callback(clock);
|
||||
},
|
||||
get pending() { return queue.length; },
|
||||
};
|
||||
}
|
||||
|
||||
test("a glide starts on the first frame after key down; a tap completes one step, a hold stops where it is released", (t) => {
|
||||
t.mock.timers.enable({ apis: ["setTimeout"] });
|
||||
const frames = fakeFrames(t);
|
||||
const profile = { startRate: 10, topRate: 10, rampMs: 1 };
|
||||
const hold = createKeyHold();
|
||||
let moved = 0;
|
||||
const move = (steps) => { moved += steps; return true; };
|
||||
|
||||
// A tap: released a third of the way into its step, it goes on to exactly one step at the same speed.
|
||||
glideWhileHeld(hold.begin("BracketRight", () => true), move, profile);
|
||||
frames.tick(0);
|
||||
frames.tick(16);
|
||||
assert.ok(Math.abs(moved - 0.16) < 1e-9, `moves on the first frame, with no initial delay (${moved})`);
|
||||
frames.tick(16);
|
||||
hold.release("BracketRight");
|
||||
for (let frame = 0; frame < 20 && frames.pending; frame += 1) frames.tick(16);
|
||||
assert.ok(Math.abs(moved - 1) < 1e-9, `a tap covers one step (${moved})`);
|
||||
assert.equal(frames.pending, 0, "and the glide is over");
|
||||
|
||||
// A hold: a second in it is well past one step, and it stops on the frame the key is released.
|
||||
moved = 0;
|
||||
glideWhileHeld(hold.begin("BracketRight", () => true), move, profile);
|
||||
for (let frame = 0; frame < 61; frame += 1) frames.tick(16);
|
||||
assert.ok(moved > 9 && moved < 11, `ten steps a second (${moved})`);
|
||||
hold.release("BracketRight");
|
||||
const released = moved;
|
||||
for (let frame = 0; frame < 10 && frames.pending; frame += 1) frames.tick(16);
|
||||
assert.equal(moved, released, "nothing after release");
|
||||
assert.equal(frames.pending, 0);
|
||||
|
||||
// A limit ends the hold.
|
||||
glideWhileHeld(hold.begin("BracketLeft", () => true), () => false, profile);
|
||||
frames.tick(16);
|
||||
assert.ok(!hold.holding("BracketLeft"), "a move that finds nothing ends the hold");
|
||||
assert.equal(frames.pending, 0);
|
||||
});
|
||||
|
||||
test("each press glides on its own: a tap still finishing is not taken over by the next press, and an interruption stops it at once", (t) => {
|
||||
t.mock.timers.enable({ apis: ["setTimeout"] });
|
||||
const frames = fakeFrames(t);
|
||||
const profile = { startRate: 10, topRate: 10, rampMs: 1 };
|
||||
const hold = createKeyHold();
|
||||
const moved = { first: 0, second: 0 };
|
||||
const mover = (name) => (steps) => { moved[name] += steps; return true; };
|
||||
|
||||
// Tap ], then hold ] again before the tap's step is done: the tap still ends at one step.
|
||||
glideWhileHeld(hold.begin("BracketRight", () => true), mover("first"), profile);
|
||||
frames.tick(0);
|
||||
frames.tick(16);
|
||||
hold.release("BracketRight");
|
||||
frames.tick(16);
|
||||
glideWhileHeld(hold.begin("BracketRight", () => true), mover("second"), profile);
|
||||
for (let frame = 0; frame < 61; frame += 1) frames.tick(16);
|
||||
assert.ok(Math.abs(moved.first - 1) < 1e-9, `the tap covers one step, not the hold after it (${moved.first})`);
|
||||
assert.ok(moved.second > 9 && moved.second < 11, `the hold glides on its own (${moved.second})`);
|
||||
hold.release("BracketRight");
|
||||
for (let frame = 0; frame < 10 && frames.pending; frame += 1) frames.tick(16);
|
||||
assert.equal(frames.pending, 0, "both glides are over");
|
||||
|
||||
// An interruption (Esc, blur, a dialog) stops a glide on its next frame, short of a step.
|
||||
moved.first = 0;
|
||||
glideWhileHeld(hold.begin("Equal", () => true), mover("first"), profile);
|
||||
frames.tick(0);
|
||||
frames.tick(16);
|
||||
hold.interrupt({ code: "Escape", key: "Escape", repeat: false });
|
||||
for (let frame = 0; frame < 10 && frames.pending; frame += 1) frames.tick(16);
|
||||
assert.ok(Math.abs(moved.first - 0.16) < 1e-9, `no motion after the interruption (${moved.first})`);
|
||||
assert.equal(frames.pending, 0);
|
||||
|
||||
// A finishing tap that reaches a limit leaves the newer hold alone.
|
||||
let calls = 0;
|
||||
glideWhileHeld(hold.begin("BracketRight", () => true), () => (calls += 1) < 2, profile);
|
||||
frames.tick(0);
|
||||
frames.tick(16);
|
||||
hold.release("BracketRight");
|
||||
glideWhileHeld(hold.begin("BracketLeft", () => true), () => true, profile);
|
||||
frames.tick(16);
|
||||
assert.ok(hold.holding("BracketLeft"), "[ is still held after ]'s tap hit 100%");
|
||||
hold.end();
|
||||
});
|
||||
@@ -245,11 +245,13 @@ test('the local Viewer serves the manifest and assets the Viewer opens, the same
|
||||
assert.match(manifest.headers.get('content-type') ?? '', /^application\/json/);
|
||||
assert.equal(await manifest.text(), manifestBody(loaded));
|
||||
const [asset] = Object.keys(JSON.parse(manifestBody(loaded)).entries);
|
||||
const served = await fetch(`${server.url}/${asset}?platform=ios`);
|
||||
// An asset is named by its SHA-256, as a hosted preview's static files are, so it carries no target and comes from whichever report holds it.
|
||||
const served = await fetch(`${server.url}/${asset}`);
|
||||
assert.equal(served.status, 200);
|
||||
assert.equal(served.headers.get('content-type'), 'image/png');
|
||||
assert.equal(createHash('sha256').update(new Uint8Array(await served.arrayBuffer())).digest('hex'), asset.slice('assets/'.length, 'assets/'.length + 64));
|
||||
for (const path of [`/${asset}?platform=android`, `/assets/${'0'.repeat(64)}.png`, '/assets/review.json', '/manifest.json?platform=android', '/manifest.json?target=tablet']) {
|
||||
assert.equal((await fetch(`${server.url}/${asset}?platform=android`)).status, 200, 'a target query changes nothing');
|
||||
for (const path of [`/assets/${'0'.repeat(64)}.png`, '/assets/review.json', '/manifest.json?platform=android', '/manifest.json?target=tablet']) {
|
||||
assert.equal((await fetch(`${server.url}${path}`)).status, 404, path);
|
||||
}
|
||||
});
|
||||
|
||||
@@ -268,3 +268,13 @@ test("unknown values fall back without disturbing the rest", () => {
|
||||
{ ...base, canvas: "screens" },
|
||||
);
|
||||
});
|
||||
|
||||
test("another target's report opens at the same canvas and route, keeping only what means the same there", () => {
|
||||
assert.equal(nav.placeForAnotherTarget("#/compare/settings/profile?screen=s-12&variant=v2&baseline=build-0.9&inspect=diff&focus=modified,added&dir=in&expand=g1&evidence=logs"),
|
||||
"#/compare/settings/profile?inspect=diff&dir=in&focus=modified,added");
|
||||
assert.equal(nav.placeForAnotherTarget("#/map/home"), "#/map/home");
|
||||
assert.equal(nav.placeForAnotherTarget("#/screens?screen=s-3"), "#/screens");
|
||||
// No place, or a hash from before routes: the other report opens where a link to it would.
|
||||
assert.equal(nav.placeForAnotherTarget(""), "");
|
||||
assert.equal(nav.placeForAnotherTarget("#map"), "");
|
||||
});
|
||||
@@ -7,13 +7,12 @@ import test from "node:test";
|
||||
import { prepareCaptureReview } from "../../dist/review/capture-review.js";
|
||||
import { createSourceCapturePlan } from "../../dist/source/capture-plan.js";
|
||||
import { writeCiReportInput, exportCiReport } from "../../dist/report/artifact.js";
|
||||
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, deployPreview, previewProjectSlug, readReportZip, sealReport, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
|
||||
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { createDecipheriv } from "node:crypto";
|
||||
import { ZipReader, Uint8ArrayReader, TextWriter, configure } from "@zip.js/zip.js";
|
||||
import { viewerLinks } from "../../dist/report/viewer-links.js";
|
||||
import { loadReport } from "../../dist/report/agent-api.js";
|
||||
import { manifestBody, previewAsset } from "../../dist/report/preview-manifest.js";
|
||||
import { manifestBody } from "../../dist/report/preview-manifest.js";
|
||||
|
||||
const png = Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "base64");
|
||||
const sha256 = createHash("sha256").update(png).digest("hex");
|
||||
@@ -23,7 +22,7 @@ const pr = { repositoryId: "123", repository: "expo/explore-playground", number:
|
||||
const artifactUrl = "https://github.com/expo/explore-playground/actions/runs/10/artifacts/20";
|
||||
const environment = { GITHUB_TOKEN: "test-token", GITHUB_RUN_ID: "10", GITHUB_RUN_ATTEMPT: "1", GITHUB_REPOSITORY: pr.repository };
|
||||
|
||||
async function fixture(t, { verified = true, preview = { hosting: "eas", expiresAfterDays: 7 }, presentation = pr } = {}) {
|
||||
async function fixture(t, { verified = true, preview = { hosting: "eas" }, presentation = pr } = {}) {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-artifact-ci-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const files = new Map([["app/index.tsx", "export default function Home() { return null; }"]]);
|
||||
@@ -74,7 +73,7 @@ async function exportFixture(t, options) {
|
||||
}
|
||||
|
||||
/** A fake EAS CLI plus a fake deployment: `deploy` captures the sealed report and .env, then serves them like the Worker would. */
|
||||
function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", aliasOrigin = "https://acme-explore--bluesky.expo.app", accounts = ["brent-org"], failDeploy = false, aliasServes = true, aliasListing, existingComment, manifestServes = true } = {}) {
|
||||
function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", aliasOrigin = "https://acme-explore--bluesky.expo.app", accounts = ["brent-org"], failDeploy = false, aliasServes = true, aliasListing, existingComment, manifestServes = true, robotsServes = true } = {}) {
|
||||
let deploys = 0;
|
||||
let latestComment = existingComment;
|
||||
const calls = []; const captured = {};
|
||||
@@ -89,12 +88,19 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
|
||||
if (args[0] === "deploy") {
|
||||
deploys += 1;
|
||||
if (failDeploy === "alias-limit") return { status: 1, stdout: "", stderr: "✔ Created deployment\n✖ Failed to assign pr-7 alias to deployment\nThis account has reached the limit of 5 aliases from the Free plan. Upgrade your plan to raise the limit on the amount of aliases you can create for your deployments. https://expo.dev/accounts/acme/settings/billing\nRequest ID: 341b47a1\n Error: GraphQL request failed." };
|
||||
// eas names the file whose upload failed, and every static file's path carries the link's token.
|
||||
if (failDeploy === "upload-path") {
|
||||
const token = /EXPLORE_PREVIEW_TOKEN=(\S+)/.exec(readFileSyncUtf8(join(options.cwd, ".env")))[1];
|
||||
return { status: 1, stdout: "", stderr: `Upload of "client/p/${token}/assets/${sha256}.png" failed: 502\n Upload failed` };
|
||||
}
|
||||
if (failDeploy === true || deploys <= failDeploy) return { status: 1, stdout: "", stderr: "Error: GraphQL request failed.\n Upload failed" };
|
||||
captured.env = Object.fromEntries(readFileSyncUtf8(join(options.cwd, ".env")).trim().split("\n").map(line => line.split(/=(.*)/s).slice(0, 2)));
|
||||
captured.listing = captured.env.EXPLORE_PREVIEW_REPORTS ? JSON.parse(captured.env.EXPLORE_PREVIEW_REPORTS) : [{ platform: "ios", path: captured.env.EXPLORE_PREVIEW_REPORT }];
|
||||
captured.sealedFiles = Object.fromEntries(captured.listing.map(entry => [entry.path, readFileSyncBytes(join(options.cwd, "dist", "client", entry.path))]));
|
||||
captured.sealed = captured.sealedFiles[captured.listing[0].path];
|
||||
// The report's static files, by the path EAS Hosting serves each at.
|
||||
const tokenDirectory = join(options.cwd, "dist", "client", "p", captured.env.EXPLORE_PREVIEW_TOKEN);
|
||||
captured.files = Object.fromEntries(readdirTree(tokenDirectory).map(file => [`/p/${captured.env.EXPLORE_PREVIEW_TOKEN}/${file}`, readFileSyncBytes(join(tokenDirectory, file))]));
|
||||
captured.hasViewer = existsSyncLocal(join(options.cwd, "dist", "client", "viewer", "index.html"));
|
||||
captured.robots = existsSyncLocal(join(options.cwd, "dist", "client", "robots.txt")) ? readFileSyncUtf8(join(options.cwd, "dist", "client", "robots.txt")) : undefined;
|
||||
const alias = args.includes("--alias") ? args[args.indexOf("--alias") + 1] : undefined;
|
||||
captured.alias = alias;
|
||||
const aliases = alias ? [{ id: "al1", url: aliasOrigin, name: alias }] : undefined;
|
||||
@@ -108,7 +114,10 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
|
||||
// An alias that has not moved to the new deployment yet: it answers for an earlier token, so this one is 404.
|
||||
if (!aliasServes && url.origin === aliasOrigin) return new Response("Not found", { status: 404 });
|
||||
if (url.origin === origin || (captured.alias && url.origin === aliasOrigin)) {
|
||||
const match = /^\/p\/([a-z2-7]{32})(?:\/(report\.zip|reports\.json|manifest\.json|api\/v1|assets\/[a-f0-9]{64}\.(?:png|jpg|mp4)))?$/.exec(url.pathname);
|
||||
// EAS Hosting serves a deployment's static file before the Worker sees the request.
|
||||
if (captured.files?.[url.pathname]) return new Response(captured.files[url.pathname], { status: 200 });
|
||||
if (url.pathname === "/robots.txt" && captured.robots !== undefined && robotsServes) return new Response(captured.robots, { status: 200, headers: { "content-type": "text/plain" } });
|
||||
const match = /^\/p\/([a-z2-7]{32})(?:\/(reports\.json|manifest\.json|api\/v1))?$/.exec(url.pathname);
|
||||
if (!captured.env || !match || match[1] !== captured.env.EXPLORE_PREVIEW_TOKEN) return new Response("Not found", { status: 404 });
|
||||
// The token page negotiates like the real Worker: only a request that asks for HTML gets the shell.
|
||||
if (!match[2]) return (options.headers?.accept ?? "").includes("text/html")
|
||||
@@ -122,20 +131,9 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
|
||||
const target = url.searchParams.get("target"), platform = url.searchParams.get("platform");
|
||||
const entry = target ? captured.listing.find(candidate => candidate.target === target)
|
||||
: platform ? captured.listing.find(candidate => candidate.target === platform) ?? captured.listing.find(candidate => candidate.platform === platform) : captured.listing[0];
|
||||
if (!entry) return new Response("Not found", { status: 404 });
|
||||
const key = Buffer.from(captured.env.EXPLORE_PREVIEW_KEY, "base64"); const sealed = Buffer.from(captured.sealedFiles[entry.path]);
|
||||
const decipher = createDecipheriv("aes-256-gcm", key, sealed.subarray(0, 12));
|
||||
decipher.setAAD(Buffer.from("expo-explore-preview/1")); decipher.setAuthTag(sealed.subarray(-16));
|
||||
const plain = Buffer.concat([decipher.update(sealed.subarray(12, -16)), decipher.final()]);
|
||||
// The manifest and assets the Viewer opens, as the Worker builds them; manifestServes: false is a Worker that cannot.
|
||||
if (match[2] === "manifest.json" || match[2].startsWith("assets/")) {
|
||||
const loaded = manifestServes ? await loadReport(new Uint8Array(plain)) : undefined;
|
||||
if (!loaded) return new Response("Not found", { status: 404 });
|
||||
if (match[2] === "manifest.json") return new Response(manifestBody(loaded), { status: 200, headers: { "content-type": "application/json; charset=utf-8" } });
|
||||
const asset = await previewAsset(loaded, match[2]);
|
||||
return asset ? new Response(asset.bytes, { status: 200, headers: { "content-type": asset.type } }) : new Response("Not found", { status: 404 });
|
||||
}
|
||||
return new Response(plain, { status: 200, headers: { "content-type": "application/zip" } });
|
||||
// The manifest the Viewer opens, from the target's static file; manifestServes: false is a Worker that cannot read it.
|
||||
const manifest = entry && manifestServes ? captured.files[entry.path] : undefined;
|
||||
return manifest ? new Response(manifest, { status: 200, headers: { "content-type": "application/json; charset=utf-8" } }) : new Response("Not found", { status: 404 });
|
||||
}
|
||||
const artifactNames = { 20: "explore-review-10-1", 21: "explore-review-10-1-ios", 22: "explore-review-10-1-android" };
|
||||
const byId = /\/actions\/artifacts\/(\d+)$/.exec(url.pathname);
|
||||
@@ -154,10 +152,13 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
|
||||
return { run, transport, calls, requests, captured };
|
||||
}
|
||||
|
||||
import { readFileSync, existsSync } from "node:fs";
|
||||
import { readFileSync, existsSync, readdirSync } from "node:fs";
|
||||
const readFileSyncUtf8 = path => readFileSync(path, "utf8");
|
||||
const readFileSyncBytes = path => new Uint8Array(readFileSync(path));
|
||||
const existsSyncLocal = path => existsSync(path);
|
||||
/** Every file under a directory, as paths relative to it. */
|
||||
const readdirTree = (directory, prefix = "") => readdirSync(join(directory, prefix), { withFileTypes: true })
|
||||
.flatMap(entry => entry.isDirectory() ? readdirTree(directory, join(prefix, entry.name)) : [join(prefix, entry.name)]);
|
||||
const deployEnvironment = { ...environment, EXPO_TOKEN: "expo-test-token" };
|
||||
|
||||
test("ci:deploy seals the exact report, deploys it with the preview export, verifies the gate, and links Explore report", async t => {
|
||||
@@ -175,28 +176,35 @@ test("ci:deploy seals the exact report, deploys it with the preview export, veri
|
||||
assert.ok(eas.captured.hasViewer, "the preview export ships with the deployment");
|
||||
const token = eas.captured.env.EXPLORE_PREVIEW_TOKEN;
|
||||
assert.match(token, TOKEN_RE); assert.deepEqual(secrets, [token]);
|
||||
assert.equal(Buffer.from(eas.captured.env.EXPLORE_PREVIEW_KEY, "base64").length, 32);
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_EXPIRES_AT, "2026-09-18T03:07:00.000Z");
|
||||
assert.match(eas.captured.env.EXPLORE_PREVIEW_REPORT, /^\/_report\/[a-z2-7]{16}\/report\.zip\.enc$/);
|
||||
// Nothing is sealed and nothing expires: the token in every path is what keeps the report private.
|
||||
assert.deepEqual(Object.keys(eas.captured.env).sort(), ["EXPLORE_PREVIEW_REPORT", "EXPLORE_PREVIEW_TOKEN"]);
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, `/p/${token}/targets/report.json`);
|
||||
assert.equal(result.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
|
||||
assert.deepEqual([result.project, result.owner, result.deploymentId, result.expiresAt], ["explore-playground-explore", "brent-org", "1lcbdcpwn3", "2026-09-18T03:07:00.000Z"]);
|
||||
assert.deepEqual([result.project, result.owner, result.deploymentId, result.expiresAt], ["explore-playground-explore", "brent-org", "1lcbdcpwn3", null]);
|
||||
const zip = await zipReportDirectory(reportPath);
|
||||
assert.equal(result.reportSha256, createHash("sha256").update(zip).digest("hex"));
|
||||
assert.equal(result.reportBytes, zip.byteLength);
|
||||
const sealed = eas.captured.sealed;
|
||||
assert.equal(sealed.byteLength, zip.byteLength + 12 + 16, "iv || ciphertext || tag, nothing else");
|
||||
assert.ok(!Buffer.from(sealed).includes(Buffer.from("review.json")), "the static file is ciphertext");
|
||||
// The static files: the manifest as the Viewer opens it, stamped with this deployment, and every screenshot under its SHA-256.
|
||||
const loaded = await loadReport(zip);
|
||||
const manifest = JSON.parse(new TextDecoder().decode(eas.captured.files[`/p/${token}/targets/report.json`]));
|
||||
assert.match(manifest.deployment, /^[a-z2-7]{16}$/);
|
||||
assert.equal(new TextDecoder().decode(eas.captured.files[`/p/${token}/targets/report.json`]), manifestBody(loaded, manifest.deployment));
|
||||
const assets = Object.keys(eas.captured.files).filter(path => path.includes("/assets/"));
|
||||
assert.deepEqual(assets.map(path => path.slice(`/p/${token}/`.length)).sort(), Object.keys(manifest.entries).sort());
|
||||
for (const path of assets) assert.equal(createHash("sha256").update(eas.captured.files[path]).digest("hex"), /([a-f0-9]{64})\./.exec(path)[1]);
|
||||
// EAS Hosting cannot put noindex on static files, so robots.txt keeps crawlers off the screenshots and manifests, not the page.
|
||||
assert.equal(eas.captured.robots, "User-agent: *\nDisallow: /p/*/assets/\nDisallow: /p/*/targets/\n");
|
||||
// Verification hit the gate and its negatives before the comment was published.
|
||||
const previewPaths = eas.requests.filter(request => request.url.origin === "https://acme-explore--1lcbdcpwn3.expo.app").map(request => request.url.pathname.replace(/[a-f0-9]{64}/, "<sha256>"));
|
||||
const wrong = token.endsWith("a") ? `${token.slice(0, -1)}b` : `${token.slice(0, -1)}a`;
|
||||
// The ZIP, then what the Viewer opens from it: the manifest and one asset.
|
||||
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`, `/p/${token}/report.zip`, `/p/${token}/manifest.json`, `/p/${token}/assets/<sha256>.png`,
|
||||
"/", `/p/${wrong}`, `/p/${wrong}/report.zip`, `/p/${token}/viewer/index.html`]);
|
||||
// What the Viewer opens: the manifest, then one screenshot, a static file.
|
||||
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`, "/robots.txt", `/p/${token}/manifest.json`, `/p/${token}/assets/<sha256>.png`,
|
||||
"/", `/p/${wrong}`, `/p/${wrong}/manifest.json`, `/p/${token}/viewer/index.html`]);
|
||||
assert.ok(eas.requests.every(request => request.url.origin !== "https://acme-explore--1lcbdcpwn3.expo.app" || request.options.cache === "no-store"));
|
||||
const posted = eas.requests.find(request => request.options.method === "POST");
|
||||
const body = JSON.parse(posted.options.body).body;
|
||||
assert.match(body, new RegExp(`\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\) \\|`));
|
||||
assert.match(body, /Preview links work until Sep 18, 2026 \(UTC\) for anyone who has them\./);
|
||||
assert.match(body, new RegExp(`^### [^\\n]*\\[Review in Explore\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\)$`, 'm'));
|
||||
assert.match(body, /Preview links work for anyone who has them until the deployment is deleted · /);
|
||||
assert.doesNotMatch(body, /explore-preview\.expo\.app\/\?/);
|
||||
assert.ok(eas.requests.indexOf(posted) > eas.requests.findIndex(request => request.url.pathname === `/p/${token}/viewer/index.html`), "publish after verification");
|
||||
});
|
||||
@@ -225,16 +233,6 @@ test("the report ZIP is deterministic and mirrors the GitHub artifact layout", a
|
||||
await assert.rejects(zipReportDirectory(reportPath), /review\.json \(or exploration\.json\) and assets/, "a report carries exactly one root file");
|
||||
});
|
||||
|
||||
test("sealReport produces iv || AES-256-GCM ciphertext || tag bound to the preview AAD", () => {
|
||||
const key = new Uint8Array(32).fill(7); const iv = new Uint8Array(12).fill(9); const plain = Buffer.from("PK\u0003\u0004report");
|
||||
const sealed = Buffer.from(sealReport(plain, key, iv));
|
||||
assert.deepEqual(sealed.subarray(0, 12), Buffer.from(iv));
|
||||
const decipher = createDecipheriv("aes-256-gcm", key, iv); decipher.setAAD(Buffer.from("expo-explore-preview/1")); decipher.setAuthTag(sealed.subarray(-16));
|
||||
assert.deepEqual(Buffer.concat([decipher.update(sealed.subarray(12, -16)), decipher.final()]), plain);
|
||||
const wrongAad = createDecipheriv("aes-256-gcm", key, iv); wrongAad.setAAD(Buffer.from("other")); wrongAad.setAuthTag(sealed.subarray(-16));
|
||||
wrongAad.update(sealed.subarray(12, -16)); assert.throws(() => wrongAad.final());
|
||||
});
|
||||
|
||||
test("ci:deploy refuses to run without a preview request, EXPO_TOKEN, or the preview export, and reports EAS failures", async t => {
|
||||
const plain = await exportFixture(t, { preview: null });
|
||||
const eas = easFixture();
|
||||
@@ -320,12 +318,12 @@ test("the preview owner comes from config or the token's single account; several
|
||||
await assert.rejects(deployPreview({ inputPath, reportPath, artifactUrl, exportPath, environment: deployEnvironment, transport: several.transport, run: several.run, verifyTimeoutMs: 1 }),
|
||||
error => error.code === "PREVIEW_OWNER_AMBIGUOUS" && /brent-org, acme/.test(error.message) && /report\.preview\.owner/.test(error.nextAction));
|
||||
assert.deepEqual(several.calls.map(call => call.args[0]), ["whoami"]);
|
||||
const configured = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: 7, owner: "acme", project: "wallet-explore" } });
|
||||
const configured = await exportFixture(t, { preview: { hosting: "eas", owner: "acme", project: "wallet-explore" } });
|
||||
const eas = easFixture({ accounts: ["brent-org", "acme"] });
|
||||
const result = await deployPreview({ inputPath: configured.inputPath, reportPath: configured.reportPath, artifactUrl, exportPath: configured.exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual([result.owner, result.project, eas.captured.appJson.expo.owner, eas.captured.appJson.expo.slug], ["acme", "wallet-explore", "acme", "wallet-explore"]);
|
||||
const wrong = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: 7, owner: "nobody" } });
|
||||
const wrong = await exportFixture(t, { preview: { hosting: "eas", owner: "nobody" } });
|
||||
const other = easFixture();
|
||||
await assert.rejects(deployPreview({ inputPath: wrong.inputPath, reportPath: wrong.reportPath, artifactUrl, exportPath: wrong.exportPath,
|
||||
environment: deployEnvironment, transport: other.transport, run: other.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_OWNER_AMBIGUOUS" && /no access to the Expo account nobody/.test(error.message));
|
||||
@@ -347,7 +345,7 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
|
||||
const token = eas.captured.env.EXPLORE_PREVIEW_TOKEN;
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, undefined, "multi-platform deployments use the listing only");
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [
|
||||
{ target: "ios", platform: "ios", label: "iOS", path: "ios.zip.enc" }, { target: "android", platform: "android", label: "Android", path: "android.zip.enc" }], "the capturing-phase fixture has no review yet, so no change count");
|
||||
{ target: "ios", platform: "ios", label: "iOS", path: "ios.json" }, { target: "android", platform: "android", label: "Android", path: "android.json" }], "the capturing-phase fixture has no review yet, so no change count");
|
||||
assert.ok(!eas.captured.env.EXPLORE_PREVIEW_REPORTS.includes("#"), "dotenv treats # as a comment");
|
||||
const zips = [await zipReportDirectory(ios.reportPath), await zipReportDirectory(android.reportPath)];
|
||||
assert.deepEqual(result.reports.map(report => [report.platform, report.reportSha256, report.reportBytes, report.artifactUrl]),
|
||||
@@ -355,21 +353,20 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
|
||||
assert.equal(result.reportSha256, result.reports[0].reportSha256);
|
||||
const previewPaths = eas.requests.filter(request => request.url.origin === "https://acme-explore--1lcbdcpwn3.expo.app").map(request => (request.url.pathname + request.url.search).replace(/[a-f0-9]{64}/, "<sha256>"));
|
||||
const wrong = token.endsWith("a") ? `${token.slice(0, -1)}b` : `${token.slice(0, -1)}a`;
|
||||
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`,
|
||||
...["ios", "android"].flatMap(platform => [`/p/${token}/report.zip?platform=${platform}`, `/p/${token}/manifest.json?platform=${platform}`, `/p/${token}/assets/<sha256>.png?platform=${platform}`]),
|
||||
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`, "/robots.txt",
|
||||
...["ios", "android"].flatMap(platform => [`/p/${token}/manifest.json?platform=${platform}`, `/p/${token}/assets/<sha256>.png`]),
|
||||
`/p/${token}/reports.json`,
|
||||
"/", `/p/${wrong}`, `/p/${wrong}/report.zip`, `/p/${token}/viewer/index.html`]);
|
||||
"/", `/p/${wrong}`, `/p/${wrong}/manifest.json`, `/p/${token}/viewer/index.html`]);
|
||||
const posted = eas.requests.filter(request => request.options.method === "POST" || request.options.method === "PATCH").map(request => JSON.parse(request.options.body).body);
|
||||
assert.equal(posted.length, 2, "the second platform updates the comment the first created");
|
||||
assert.match(posted[0], new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?platform=ios>\\)`));
|
||||
assert.doesNotMatch(posted[0], /\| Android \|/);
|
||||
assert.match(posted[1], new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<[^>]+/p/${token}\\?platform=ios>\\)`), 'the Android writer keeps the iOS row');
|
||||
assert.match(posted[1], new RegExp(`\\| Android \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<[^>]+/p/${token}\\?platform=android>\\)`));
|
||||
assert.equal(posted[1].split("<summary>Validation").length, 2, 'one validation block for both platforms');
|
||||
assert.match(posted[0], new RegExp(`^<sub>\\[iOS\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?platform=ios>\\) · \\[`, 'm'));
|
||||
assert.doesNotMatch(posted[0], /Android/);
|
||||
assert.match(posted[1], new RegExp(`^<sub>\\[iOS\\]\\(<[^>]+/p/${token}\\?platform=ios>\\) · \\[Android\\]\\(<[^>]+/p/${token}\\?platform=android>\\) · \\[`, 'm'), 'the Android writer keeps the iOS link');
|
||||
assert.equal(posted[1].split("### ").length, 2, 'one heading for both platforms');
|
||||
});
|
||||
|
||||
function captureListing(listing) {
|
||||
return listing.map(({ path, ...rest }) => ({ ...rest, path: path.replace(/^\/_report\/[a-z2-7]{16}\//, "") }));
|
||||
return listing.map(({ path, ...rest }) => ({ ...rest, path: path.replace(/^\/p\/[a-z2-7]{32}\/targets\//, "") }));
|
||||
}
|
||||
|
||||
test("collectPlatformReports pairs downloaded artifact directories by platform and looks up each report artifact's URL", async t => {
|
||||
@@ -415,15 +412,26 @@ test("ci:deploy leaves the deployments the previous comment linked alone; develo
|
||||
assert.ok(eas.requests.find(request => request.options.method === "PATCH"), "the comment was updated to link the new deployment");
|
||||
});
|
||||
|
||||
test("a never-expiring preview seals no EXPLORE_PREVIEW_EXPIRES_AT and the comment says the link lasts until the deployment is deleted", async t => {
|
||||
const { inputPath, reportPath, exportPath } = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: null } });
|
||||
test("a preview sets no expiry of its own: an old config's expiresAfter is noted and ignored, and the comment says the link lasts until the deployment is deleted", async t => {
|
||||
const { inputPath, reportPath, exportPath } = await exportFixture(t, { preview: { hosting: "eas", expiresAfterIgnored: true } });
|
||||
const warnings = [];
|
||||
t.mock.method(process.stderr, "write", chunk => { warnings.push(String(chunk)); return true; });
|
||||
const eas = easFixture();
|
||||
const result = await deployPreview({ inputPath, reportPath, artifactUrl, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.equal("EXPLORE_PREVIEW_EXPIRES_AT" in eas.captured.env, false);
|
||||
assert.equal(result.expiresAt, null);
|
||||
const body = JSON.parse(eas.requests.find(request => request.options.method === "PATCH" || request.options.method === "POST").options.body).body;
|
||||
assert.match(body, /^Preview links work for anyone who has them until the deployment is deleted\. · Managed via /m);
|
||||
assert.match(body, /^<sub>Preview links work for anyone who has them until the deployment is deleted · \[Workflow run\]/m);
|
||||
assert.doesNotMatch(body, /works until/);
|
||||
assert.ok(warnings.some(line => line.includes("report.preview.expiresAfter no longer applies: a hosted preview lasts as long as its EAS Hosting deployment")), warnings.join(""));
|
||||
|
||||
// A capture from an earlier version recorded the expiry as expiresAfterDays: still accepted, and noted the same way.
|
||||
const legacy = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: 7 } });
|
||||
warnings.length = 0;
|
||||
const again = easFixture();
|
||||
assert.equal((await deployPreview({ inputPath: legacy.inputPath, reportPath: legacy.reportPath, artifactUrl, exportPath: legacy.exportPath, environment: deployEnvironment,
|
||||
transport: again.transport, run: again.run, now: () => now, verifyTimeoutMs: 1 })).expiresAt, null);
|
||||
assert.ok(warnings.some(line => line.includes("report.preview.expiresAfter no longer applies")), warnings.join(""));
|
||||
});
|
||||
|
||||
test("a standalone report deploys to a fixed alias with a fixed token, verifies both hosts, and prints the alias link", async t => {
|
||||
@@ -431,7 +439,7 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
|
||||
await asExploration(reportPath);
|
||||
const eas = easFixture();
|
||||
const token = "b".repeat(32);
|
||||
const result = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, alias: "bluesky", token,
|
||||
const result = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky", token,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(eas.calls[2].args, ["deploy", "--json", "--non-interactive", "--export-dir", "dist", "--alias", "bluesky"]);
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_TOKEN, token, "the caller's token is sealed into the deployment");
|
||||
@@ -441,16 +449,16 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
|
||||
const origins = new Set(eas.requests.filter(request => request.url.pathname.startsWith("/p/")).map(request => request.url.origin));
|
||||
assert.deepEqual([...origins].sort(), ["https://acme-explore--1lcbdcpwn3.expo.app", "https://acme-explore--bluesky.expo.app"], "the report is verified on the deployment and on the alias");
|
||||
|
||||
const plain = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: 7, exportPath,
|
||||
const plain = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.equal(eas.captured.alias, undefined);
|
||||
assert.equal(plain.aliasUrl, undefined);
|
||||
assert.match(plain.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
|
||||
assert.notEqual(plain.previewUrl, result.previewUrl, "without a fixed token the link is random");
|
||||
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, alias: "Blue Sky",
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "Blue Sky",
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_ALIAS_INVALID");
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, token: "short",
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, token: "short",
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_TOKEN_INVALID");
|
||||
});
|
||||
|
||||
@@ -473,11 +481,11 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
|
||||
assert.equal(eas.captured.alias, "pr-12");
|
||||
assert.equal("EXPLORE_PREVIEW_EXPIRES_AT" in eas.captured.env, false, "a fixture preview does not expire");
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [
|
||||
{ target: "android", platform: "android", label: "Android", changes: 12, device: "Pixel · light + dark", path: "android.zip.enc" },
|
||||
{ target: "ios", platform: "ios", label: "iOS", path: "ios.zip.enc" },
|
||||
{ target: "android", platform: "android", label: "Android", changes: 12, device: "Pixel · light + dark", path: "android.json" },
|
||||
{ target: "ios", platform: "ios", label: "iOS", path: "ios.json" },
|
||||
]);
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/report.zip`).map(request => request.url.searchParams.get("platform"));
|
||||
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' bytes are verified");
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/manifest.json`).map(request => request.url.searchParams.get("platform"));
|
||||
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' manifests are verified");
|
||||
|
||||
// The alias lagging the deployment past the budget is not a failed deployment: the deployment is verified, so the
|
||||
// link is the deployment's own origin and the job log carries a warning (every 2026-10-14 "HTTP 404" failure was this).
|
||||
@@ -516,6 +524,27 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
|
||||
error => error.code === "PREVIEW_ALIAS_INVALID");
|
||||
});
|
||||
|
||||
test("fixture reports name each target's ZIP, and a listing from before targets its platform's", () => {
|
||||
const listing = [
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", changes: 11, device: "iPhone 17 26.5 · light + dark", source: "brentvatne/euxy#163" },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", changes: 34 },
|
||||
{ target: "android", platform: "android", label: "Android", changes: 5 },
|
||||
];
|
||||
assert.deepEqual(fixtureReports(listing, "/fixtures"), [
|
||||
{ platform: "ios", target: { id: "iphone", platform: "ios", label: "iPhone 17" }, zipPath: "/fixtures/iphone.zip", changes: 11, device: "iPhone 17 26.5 · light + dark" },
|
||||
{ platform: "ios", target: { id: "duo-open", platform: "ios", label: "iPhone Duo (open)" }, zipPath: "/fixtures/duo-open.zip", changes: 34 },
|
||||
{ platform: "android", target: { id: "android", platform: "android", label: "Android" }, zipPath: "/fixtures/android.zip", changes: 5 },
|
||||
]);
|
||||
assert.deepEqual(fixtureReports([{ platform: "ios", changes: 3 }, { platform: "android" }], "/fixtures"), [
|
||||
{ platform: "ios", zipPath: "/fixtures/ios.zip", changes: 3 },
|
||||
{ platform: "android", zipPath: "/fixtures/android.zip" },
|
||||
]);
|
||||
// reports.json comes from a hosted preview: a target that is not an id never names a file.
|
||||
for (const bad of [[{ target: "../escape", platform: "ios" }], [{ platform: "web" }], [null], { platform: "ios" }]) {
|
||||
assert.throws(() => fixtureReports(bad, "/fixtures"), error => error.code === "PREVIEW_REPORTS_INVALID", JSON.stringify(bad));
|
||||
}
|
||||
});
|
||||
|
||||
test("a deployment that does not report the requested alias is a retryable deploy failure", async t => {
|
||||
const { reportPath, exportPath } = await exportFixture(t);
|
||||
await asExploration(reportPath);
|
||||
@@ -526,7 +555,7 @@ test("a deployment that does not report the requested alias is a retryable deplo
|
||||
const { aliases: _aliases, ...rest } = JSON.parse(result.stdout);
|
||||
return { ...result, stdout: `${JSON.stringify(rest)}\n` };
|
||||
};
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, alias: "bluesky",
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky",
|
||||
environment: deployEnvironment, transport: eas.transport, run, now: () => now, verifyTimeoutMs: 1 }),
|
||||
error => error.code === "PREVIEW_DEPLOY_FAILED" && error.retryable === true && /did not report the alias bluesky/.test(error.message));
|
||||
});
|
||||
@@ -565,7 +594,7 @@ test("a comparison of two commits deploys the same way and links its report from
|
||||
assert.match(summary, /^### Explore: `v1\.4\.0` vs `v1\.3\.0`$/m);
|
||||
assert.ok(summary.includes(`[Open the report](${result.previewUrl})`));
|
||||
assert.ok(summary.includes(`(https://github.com/${pr.repository}/compare/${pr.base.sha}..${pr.head.sha})`));
|
||||
assert.match(summary, /link expires 2026-09-18/);
|
||||
assert.doesNotMatch(summary, /expires/, "a hosted preview lasts as long as its deployment");
|
||||
});
|
||||
|
||||
test("readReportZip reads a review ZIP's platform, run and labels, and rejects anything that is not a report", async t => {
|
||||
@@ -613,35 +642,35 @@ test("deployLocalReports hosts one review's platforms behind one link, labelled
|
||||
const zip = await zipReportDirectory(reportPath);
|
||||
const eas = easFixture();
|
||||
const result = await deployLocalReports({ reports: [{ platform: "ios", zip, changes: 3, device: "iPhone 17 26.5" }, { platform: "android", zip }],
|
||||
project: "acme-explore", expiresAfterDays: null, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
project: "acme-explore", exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.match(result.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
|
||||
assert.equal(result.owner, "brent-org", "the only account of the login holds the project");
|
||||
assert.equal(result.expiresAt, null);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [
|
||||
{ target: "ios", platform: "ios", label: "iOS", changes: 3, device: "iPhone 17 26.5", path: "ios.zip.enc" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "android.zip.enc" },
|
||||
{ target: "ios", platform: "ios", label: "iOS", changes: 3, device: "iPhone 17 26.5", path: "ios.json" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "android.json" },
|
||||
]);
|
||||
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "ios", zip }], project: "acme-explore", expiresAfterDays: 7, exportPath,
|
||||
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "ios", zip }], project: "acme-explore", exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run }), error => error.code === "PREVIEW_REPORTS_INVALID");
|
||||
|
||||
// One Android report is still listed, so the Worker does not take it for iOS; a label with `#` cannot cut the sealed .env short.
|
||||
await deployLocalReports({ reports: [{ platform: "android", zip, changes: 1, device: "Pixel #9 <Pro>\n" }], project: "acme-explore", expiresAfterDays: 7, exportPath,
|
||||
await deployLocalReports({ reports: [{ platform: "android", zip, changes: 1, device: "Pixel #9 <Pro>\n" }], project: "acme-explore", exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, undefined);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", changes: 1, device: "Pixel 9 Pro", path: "android.zip.enc" }]);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", changes: 1, device: "Pixel 9 Pro", path: "android.json" }]);
|
||||
// eas deploy expands $VARIABLES in that .env, even single-quoted: a label never carries one in, nor a backslash.
|
||||
await deployLocalReports({ reports: [{ platform: "ios", zip, device: "iPhone ${EXPO_TOKEN} $EXPLORE_PREVIEW_KEY \\$ · light + dark" }], project: "acme-explore",
|
||||
expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "ios", platform: "ios", label: "iOS", device: "iPhone EXPO_TOKEN EXPLORE_PREVIEW_KEY · light + dark", path: "ios.zip.enc" }]);
|
||||
exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "ios", platform: "ios", label: "iOS", device: "iPhone EXPO_TOKEN EXPLORE_PREVIEW_KEY · light + dark", path: "ios.json" }]);
|
||||
});
|
||||
|
||||
test("an explore:binary report names its platform, so an Android exploration is not served as iOS", async t => {
|
||||
const { reportPath, exportPath } = await exportFixture(t);
|
||||
await asExploration(reportPath);
|
||||
const eas = easFixture();
|
||||
await deployExplorationReport({ reportPath, platform: "android", project: "acme-explore", owner: "brent-org", expiresAfterDays: 7, exportPath,
|
||||
await deployExplorationReport({ reportPath, platform: "android", project: "acme-explore", owner: "brent-org", exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", path: "android.zip.enc" }]);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", path: "android.json" }]);
|
||||
});
|
||||
|
||||
test("readReportZip stops inflating a report file once it passes the size its header declares", async () => {
|
||||
@@ -722,20 +751,20 @@ test("readReportZip names the report's target from review.runtime.target, and ig
|
||||
assert.equal((await readReportZip(await zipReportDirectory(reportPath))).target.label, "Duo HOME open 1", "a label is plain text, safe in the sealed .env");
|
||||
});
|
||||
|
||||
test("deployLocalReports hosts four targets, three of them iOS, as <target>.zip.enc selected by ?target=", async t => {
|
||||
test("deployLocalReports hosts four targets, three of them iOS, as targets/<target>.json selected by ?target=", async t => {
|
||||
const { reportPath, exportPath } = await exportFixture(t);
|
||||
const zip = await zipReportDirectory(reportPath);
|
||||
const eas = easFixture();
|
||||
await deployLocalReports({ reports: TARGETS.map((target, index) => ({ platform: target.platform, target, zip: new Uint8Array([...zip, ...new Array(index).fill(0)]), changes: index })),
|
||||
project: "acme-explore", expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), TARGETS.map((target, index) => ({ target: target.id, platform: target.platform, label: target.label, path: `${target.id}.zip.enc`, changes: index })));
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}/report.zip`).map(request => request.url.search);
|
||||
project: "acme-explore", exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), TARGETS.map((target, index) => ({ target: target.id, platform: target.platform, label: target.label, path: `${target.id}.json`, changes: index })));
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}/manifest.json`).map(request => request.url.search);
|
||||
assert.deepEqual([...new Set(served)], ["?target=iphone", "?target=duo-closed", "?target=duo-open", "?platform=android"],
|
||||
"a target named after its platform keeps the ?platform= link it always had");
|
||||
for (const reports of [[{ platform: "ios", target: TARGETS[0], zip }, { platform: "ios", target: TARGETS[0], zip }],
|
||||
[{ platform: "ios", target: { id: "Bad", platform: "ios", label: "x" }, zip }],
|
||||
Array.from({ length: 9 }, (_, index) => ({ platform: "ios", target: { id: `t${index}`, platform: "ios", label: "x" }, zip }))]) {
|
||||
await assert.rejects(deployLocalReports({ reports, project: "acme-explore", expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run }),
|
||||
await assert.rejects(deployLocalReports({ reports, project: "acme-explore", exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run }),
|
||||
error => error.code === "PREVIEW_REPORTS_INVALID");
|
||||
}
|
||||
});
|
||||
@@ -763,9 +792,9 @@ test("ci:deploy pairs target-named artifacts, deploys them in config order, and
|
||||
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 })
|
||||
.catch(error => error);
|
||||
// Publishing each target's comment section after the deployment is the comment code's (publishCiReportComment, which needs
|
||||
// the target to name the artifact); the deployment itself must have been sealed per target either way.
|
||||
// the target to name the artifact); the deployment itself must have been written per target either way.
|
||||
assert.deepEqual(captureListing(eas.captured.listing).map(entry => [entry.target, entry.platform, entry.label, entry.path]),
|
||||
TARGETS.map(target => [target.id, target.platform, target.label, `${target.id}.zip.enc`]), String(sealed?.message ?? ""));
|
||||
TARGETS.map(target => [target.id, target.platform, target.label, `${target.id}.json`]), String(sealed?.message ?? ""));
|
||||
|
||||
// An artifact named for one target that holds another's report is refused.
|
||||
await rm(join(root, "inputs", "explore-capture-10-1-duo-open"), { recursive: true });
|
||||
@@ -783,3 +812,35 @@ test("ci:deploy fails a deployment whose Worker serves the ZIP but not the manif
|
||||
const posted = eas.requests.filter(request => request.options.method === "POST" || request.options.method === "PATCH").map(request => JSON.parse(request.options.body).body);
|
||||
assert.ok(posted.every(body => !body.includes(`/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}`)), posted.join("\n---\n"));
|
||||
});
|
||||
|
||||
test("a deployment that does not serve its robots.txt fails verification", async t => {
|
||||
const { inputPath, reportPath, exportPath } = await exportFixture(t);
|
||||
const eas = easFixture({ robotsServes: false });
|
||||
await assert.rejects(deployPreview({ inputPath, reportPath, exportPath, artifactUrl, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 }),
|
||||
error => error.code === "PREVIEW_VERIFY_FAILED" && /robots\.txt/.test(error.message));
|
||||
});
|
||||
|
||||
test("eas output that names an upload's path keeps the link's token out of the log and the error", async t => {
|
||||
const { inputPath, reportPath, exportPath } = await exportFixture(t);
|
||||
const eas = easFixture({ failDeploy: "upload-path" });
|
||||
const logged = [];
|
||||
t.mock.method(process.stderr, "write", chunk => { logged.push(String(chunk)); return true; });
|
||||
const error = await deployPreview({ inputPath, reportPath, artifactUrl, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run,
|
||||
now: () => now, verifyTimeoutMs: 1, sleep: async () => {} }).catch(caught => caught);
|
||||
assert.equal(error.code, "PREVIEW_DEPLOY_FAILED");
|
||||
assert.ok(logged.some(line => line.includes('Upload of "client/p/***/assets/')), logged.join(""));
|
||||
for (const text of [...logged, error.details.output, error.message]) assert.doesNotMatch(text, /p\/[a-z2-7]{32}\//, text);
|
||||
});
|
||||
|
||||
test("targets that share a screenshot must agree on its size, or the deploy refuses the report", async t => {
|
||||
const { reportPath, exportPath } = await exportFixture(t);
|
||||
const zip = await zipReportDirectory(reportPath);
|
||||
const broken = await mkdtemp(join(tmpdir(), "explore-broken-")); t.after(() => rm(broken, { recursive: true, force: true }));
|
||||
await cp(reportPath, broken, { recursive: true });
|
||||
await writeFile(join(broken, "assets", `${sha256}.png`), png.subarray(0, 10));
|
||||
const eas = easFixture();
|
||||
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "android", zip: await zipReportDirectory(broken) }], project: "acme-explore", exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 }),
|
||||
error => error.code === "REPORT_ZIP_FAILED" && error.message.includes(`assets/${sha256}.png`));
|
||||
assert.equal(eas.calls.filter(call => call.args[0] === "deploy").length, 0, "nothing is deployed");
|
||||
});
|
||||
@@ -127,6 +127,17 @@ test('local review preparation preserves metadata and verified evidence without
|
||||
await assert.rejects(readCaptureBundle(join(f.root, 'bad')), /explore\.bundle/);
|
||||
});
|
||||
|
||||
test('a review names the system areas its verdict left out, the platform\'s bands unless told otherwise', async t => {
|
||||
const f = await captureFixture(t);
|
||||
// The bundle names the device but not its pose, so preparation does not guess a foldable's panel from it.
|
||||
const duo = { ...runtimeProfile, deviceModel: 'iPhone Duo' };
|
||||
for (const side of ['base', 'head']) await writeFile(join(f.options[`${side}Directory`], 'bundle.json'), JSON.stringify({ ...f.bundles[side], runtimeProfile: duo }));
|
||||
const bands = [{ kind: 'status-bar', x: 0, y: 0, width: 100, height: 6.5 }, { kind: 'home-indicator', x: 0, y: 97, width: 100, height: 3 }];
|
||||
assert.deepEqual((await prepareCaptureReview(f.options)).review.runtime.systemRegions, bands);
|
||||
const pill = [{ kind: 'status-bar', x: 92.43, y: 4.48, width: 5.05, height: 10.76 }, bands[1]];
|
||||
assert.deepEqual((await prepareCaptureReview({ ...f.options, systemRegions: pill })).review.runtime.systemRegions, pill);
|
||||
});
|
||||
|
||||
test('review preparation rejects altered image hashes, metadata and paths outside the capture directory', async t => {
|
||||
for (const mutation of ['hash', 'dimensions', 'source-commit', 'parent-path', 'absolute-path', 'symlink']) {
|
||||
await t.test(mutation, async t => {
|
||||
|
||||
@@ -78,8 +78,7 @@ for (const provider of ['expo-router', 'react-navigation']) {
|
||||
const published = await publishCiReportComment({ inputPath: result.inputPath,
|
||||
artifactUrl: 'https://github.com/acme/example/actions/runs/1234/artifacts/900', environment: f.environment, transport: f.transport });
|
||||
assert.equal(new URL(published.artifactUrl).origin, 'https://explore-preview.expo.app', 'CI always uses the hosted viewer, even with a legacy origin override');
|
||||
assert.match(f.comments.at(-1), /\[Open\]\(<https:\/\/explore-preview\.expo\.app\/\?[^>]+>\)/);
|
||||
assert.match(f.comments.at(-1), /\[zip\]\(<https:\/\/github\.com\/acme\/example\/actions\/runs\/1234\/artifacts\/900>\)/);
|
||||
assert.match(f.comments.at(-1), /\[Review in Explore\]\(<https:\/\/explore-preview\.expo\.app\/\?[^>]+artifact=900>\)/);
|
||||
assert.match(f.comments.at(-1), /explore-preview\.expo\.app/);
|
||||
assert.doesNotMatch(f.comments.at(-1), /viewer\.example/);
|
||||
// A matrix job's report artifact carries its target id: an unsuffixed artifact is not target duo-open's.
|
||||
@@ -132,12 +131,12 @@ test('unreachable screens do not fail CI: both revisions, the report and an Inco
|
||||
await publishCiReportComment({ inputPath: result.inputPath,
|
||||
artifactUrl: 'https://github.com/acme/example/actions/runs/1234/artifacts/900', environment: f.environment, transport: f.transport });
|
||||
const comment = f.comments.at(-1).replaceAll('\\', '');
|
||||
assert.match(comment, /\| iOS \| [^|]+\| 🟨 [^|]*unavailable[^|]*\| \[Open\]\(<https:\/\/explore-preview\.expo\.app/, 'the report link is published even though a screen is unavailable');
|
||||
assert.match(comment, /^### \d+ screens? changed · \[Review in Explore\]\(<https:\/\/explore-preview\.expo\.app/m, 'the report link is published even though a screen is unavailable');
|
||||
assert.match(comment, /^iOS · 1 capture unavailable · 1 unattributed · \[run\]/m);
|
||||
assert.doesNotMatch(comment, /🟥 failed/);
|
||||
assert.match(comment, /Head · \/home · CAPTURE_OBSERVER_NOT_READY/);
|
||||
assert.match(comment, /Base · \/home · CAPTURE_OBSERVER_MISSING/);
|
||||
assert.match(comment, /1 unavailable/);
|
||||
assert.match(comment, /1 unattributed/);
|
||||
assert.match(comment, /<summary>Capture issues \(2\)<\/summary>/);
|
||||
assert.equal(f.requests.filter(request => request.args[0] === 'simulator:stop').length, 2);
|
||||
assert.equal(git(f.baseProject, 'status', '--porcelain'), '');
|
||||
assert.equal(git(f.headProject, 'status', '--porcelain'), '');
|
||||
@@ -290,7 +289,7 @@ test('a PR that moved during a verification retry still publishes, as a previous
|
||||
assert.ok(f.comments.length > 0, 'the run keeps posting; its report is kept under previous runs');
|
||||
assert.match(f.comments.at(-1), /Previous runs \(1\)/);
|
||||
assert.match(f.comments.at(-1), /The pull request moved while this run worked/);
|
||||
assert.doesNotMatch(f.comments.at(-1), /^<sub>base \[/m, 'nothing is presented as the current review');
|
||||
assert.match(f.comments.at(-1), /^### Explore review$/m, 'nothing is presented as the current review');
|
||||
});
|
||||
|
||||
test('authorization and other non-server PR verification failures are never retried', async t => {
|
||||
@@ -520,3 +519,28 @@ for (const failedPhase of ['preflight', 'capture-head']) {
|
||||
assert.doesNotMatch(f.comments.join('\n'), /agent-usage|estimatedCostUsd|cacheReadInputTokens|query-pipeline/);
|
||||
});
|
||||
}
|
||||
|
||||
test('an excluded route is flagged in the published review and never captured on either side', async t => {
|
||||
const f = await fixture(t, 'expo-router');
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const output = join(f.root, 'review');
|
||||
const result = await runPublicCi({ baseProject: f.baseProject, headProject: f.headProject, pullRequestPath: f.pullRequestPath, output,
|
||||
config: { ...f.config, exploration: { scope: 'changes', exclude: ['/settings'] } }, environment: f.environment,
|
||||
transport: f.transport, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
const plan = JSON.parse(await readFile(join(output, 'execution-plan.json'), 'utf8'));
|
||||
const settings = plan.surfaces.find(surface => surface.headSurface?.route === '/settings');
|
||||
assert.deepEqual(plan.excludedSurfaceIds, [settings.id]);
|
||||
for (const side of ['base', 'head']) {
|
||||
const bundle = await readCaptureBundle(join(output, `${side}-export`));
|
||||
assert.equal(settings.id in bundle.outcomes, false, `${side}: an excluded route is not captured`);
|
||||
}
|
||||
const packaged = await exportCiReport({ inputPath: result.inputPath, outputPath: join(f.root, 'artifact') });
|
||||
const report = JSON.parse(await readFile(join(packaged.outputPath, 'review.json'), 'utf8'));
|
||||
const published = report.review.surfaces.find(surface => surface.id === settings.id);
|
||||
assert.equal(published.excluded, true);
|
||||
assert.equal(published.headImage ?? published.baseImage ?? published.headOutcome ?? published.baseOutcome, undefined);
|
||||
assert.ok(report.review.surfaces.filter(surface => surface.id !== settings.id).every(surface => surface.excluded === undefined));
|
||||
// /home changed and links to /settings: the neighbor is still captured, the excluded route is not a missing screen.
|
||||
const home = report.review.surfaces.find(surface => surface.head?.route === '/home');
|
||||
assert.ok(home.headImage && home.baseImage);
|
||||
});
|
||||
+337
-183
@@ -88,60 +88,61 @@ function reviewOnlyState(review) {
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
const visible = body => body.split('\n').filter(line => !line.startsWith('<!-- expo-explore-record') && !line.startsWith('<!-- expo-explore-history')).join('\n');
|
||||
const visible = body => body.split('\n').filter(line => !line.startsWith('<!-- expo-explore-record') && !line.startsWith('<!-- expo-explore-previous') && !line.startsWith('<!-- expo-explore-history')).join('\n');
|
||||
const summaries = body => [...body.matchAll(/<summary>([^<]+)<\/summary>/g)].map(match => match[1]);
|
||||
const platformRow = (body, platform) => body.split('\n').find(line => line.startsWith(`| ${platform} |`));
|
||||
const checkRow = (body, check) => body.split('\n').find(line => line.startsWith(`| ${check} |`));
|
||||
const titleOf = body => body.split('\n').find(line => line.startsWith('### '));
|
||||
/** The `<sub>` two lines under the heading; the footer is the last line. */
|
||||
const subtitleOf = body => { const lines = body.split('\n'); return lines[lines.findIndex(line => line.startsWith('### ')) + 2]; };
|
||||
const statusOf = (body, label) => body.split('\n').find(line => line.startsWith(`${label} · `) || line.startsWith(`**${label} failed**`));
|
||||
/** The changed-screen rows: the list before any collapsed block. */
|
||||
const listOf = body => visible(body).split('\n<details>')[0].split('\n').filter(line => line.startsWith('- '));
|
||||
const runLink = '[run](<https://github.com/expo/explore-playground/actions/runs/42/attempts/2>)';
|
||||
const workflowRun = '[Workflow run](<https://github.com/expo/explore-playground/actions/runs/42/attempts/2>)';
|
||||
const evidenceLink = '[evidence](<https://github.com/expo/explore-playground/actions/runs/42#artifacts>)';
|
||||
const reportUrl = 'https://explore-preview.expo.app/?repo=expo%2Fexplore-playground&run=42&attempt=2&artifact=7654';
|
||||
const commits = `[bbbbbbbb](<https://github.com/expo/explore-playground/commit/${headSha}>) vs [aaaaaaaa](<https://github.com/expo/explore-playground/commit/${baseSha}>)`;
|
||||
const configLink = `[Config](<https://github.com/expo/explore-playground/blob/${headSha}/.expo-explore/config.yaml>)`;
|
||||
|
||||
test('the ready comment is one header, a platform table, the changes listed once, and a collapsed validation block', () => {
|
||||
test('the ready comment is a heading with the count and the report, a subtitle, the changed screens, and a footer', () => {
|
||||
const body = renderPublicComment(state({ artifactOnly: true }));
|
||||
const lines = body.split('\n');
|
||||
assert.equal(lines[0], CI_COMMENT_MARKER);
|
||||
assert.match(lines[1], /^<!-- expo-explore-record:ios:[A-Za-z0-9_-]+ -->$/);
|
||||
assert.match(lines[2], /^### Explore review · \[Open report\]\(<https:\/\/explore-preview\.expo\.app\/\?repo=expo%2Fexplore-playground&run=42&attempt=2[^>]*>\)$/, 'the report link is the heading, where a phone shows it first');
|
||||
assert.equal(lines[4], '<sub>base [aaaaaaaa](<https://github.com/expo/explore-playground/commit/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>) → [bbbbbbbb](<https://github.com/expo/explore-playground/commit/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb>)</sub>');
|
||||
assert.deepEqual([lines[3], ...lines.slice(5, 8)], ['', '', '| | Device | Result | Report |', '|---|---|---|---|']);
|
||||
assert.equal(lines[8], `| iOS | iPhone 17 26\\.5 · Example 1\\.4\\.0 \\(27\\) | 🟩 3 changes · 6m 12s | [Open](<https://explore-preview.expo.app/?repo=expo%2Fexplore-playground&run=42&attempt=2&artifact=7654>) |`, 'the Report cell is the report link alone');
|
||||
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', 'Validation · iOS 🟩 6/6 captured']);
|
||||
assert.match(body, /\n\*\*Changes\*\* · 3 screens\n/);
|
||||
assert.match(body, /\n- `\/settings` — Changed button title from “Share” to “Share Example”\\\. · \[iOS\]\(<https:\/\/explore-preview\.expo\.app\/\?repo=expo%2Fexplore-playground&run=42&attempt=2&artifact=7654&view=compare&screen=settings>\)\n/);
|
||||
assert.match(body, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iOS\]\(<[^>]+screen=care-guide>\)\n/);
|
||||
assert.match(body, /\n- `\/cats\/sweet-bee` — Removed \/cats\/sweet\\-bee screen · \[iOS\]\(<[^>]+screen=sweet-bee>\)\n/);
|
||||
assert.equal(checkRow(body, 'Capture'), '| Capture | 🟩 6/6 surfaces · base cache reused |');
|
||||
assert.equal(checkRow(body, 'Route verification'), '| Route verification | 🟩 6/6 verified |');
|
||||
assert.equal(checkRow(body, 'Visual comparison'), '| Visual comparison | 🟩 2 compared · threshold 0.1 |');
|
||||
assert.equal(checkRow(body, 'Accessibility comparison'), '| Accessibility comparison | 🟩 2 compared · 1 description |');
|
||||
assert.equal(checkRow(body, 'Source inventory'), '| Source inventory | 🟩 54 routes |');
|
||||
assert.equal(lines.at(-1), `Managed via [\`.expo-explore/config.yaml\`](<https://github.com/expo/explore-playground/blob/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/.expo-explore/config.yaml>) · Workflow ${runLink} · [zip](<https://github.com/expo/explore-playground/actions/runs/42/artifacts/7654>)`, 'the run and the report zip sit in the footer');
|
||||
assert.doesNotMatch(body, /<img|### Review target|### What changed|### Validation|Unchanged|screen=cats|\/home|Reviewed at|Open Explore|Download report|View run/);
|
||||
assert.ok(body.indexOf('**Changes**') < body.indexOf('<summary>Validation'));
|
||||
assert.equal(lines[2], `### 3 screens changed · [Review in Explore](<${reportUrl}>)`, 'the report link is the heading, where a phone shows it first');
|
||||
assert.equal(lines[4], `<sub>[iOS](<${reportUrl}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
|
||||
assert.deepEqual(lines.slice(5, 10), ['',
|
||||
`- Added [\`/cats/care-guide\`](<${reportUrl}&view=compare&screen=care-guide>)`,
|
||||
`- Removed [\`/cats/sweet-bee\`](<${reportUrl}&view=compare&screen=sweet-bee>)`,
|
||||
`- [\`/settings\`](<${reportUrl}&view=compare&screen=settings>) · Changed button title from “Share” to “Share Example”`, '']);
|
||||
assert.equal(lines.at(-1), `<sub>${workflowRun} · ${configLink}</sub>`, 'the run and the config sit in the footer');
|
||||
assert.equal(lines.length, 11);
|
||||
assert.deepEqual(summaries(body), []);
|
||||
assert.doesNotMatch(body, /<img|\*\*Changes\*\*|Validation|Capture issues|🟩|🟧|🟨|Managed via|zip|6m 12s|iPhone 17|Example 1|Unchanged|screen=cats|\/home|Reviewed at|Open Explore|Download report|View run|^\|/m);
|
||||
// Hidden state is the only thing the comment carries besides markdown.
|
||||
assert.equal(lines.filter(line => line.startsWith('<!--')).length, 2);
|
||||
});
|
||||
|
||||
test('report links appear only once a report exists; a failed run links the run and its evidence', () => {
|
||||
test('report links appear only once a report exists; a failed target says so with its run and evidence', () => {
|
||||
const beforeUpload = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
|
||||
const ready = renderPublicComment(state({ links: beforeUpload }));
|
||||
assert.match(platformRow(ready, 'iOS'), /\| 🟩 3 changes · 6m 12s \| \[run\]\(<[^>]+>\) \|$/, 'before the artifact exists there is nothing to open');
|
||||
assert.doesNotMatch(ready, /\[zip\]|\[Open\]/);
|
||||
assert.equal(titleOf(ready), '### 3 screens changed', 'before the artifact exists there is nothing to open');
|
||||
assert.match(subtitleOf(ready), /^<sub>iOS · \[bbbbbbbb\]/);
|
||||
assert.match(ready, /\n- Added `\/cats\/care-guide`\n/);
|
||||
assert.doesNotMatch(ready, /\[zip\]|\[Open\]|Review in Explore|explore-preview/);
|
||||
const failed = renderPublicComment(state({ phase: 'failed', review: undefined, evidence: undefined, failure: { step: 'capture-head', message: 'head capture did not complete; token=abc123 leaked' } }));
|
||||
assert.equal(platformRow(failed, 'iOS'), `| iOS | iPhone 17 26\\.5 · Example 1\\.4\\.0 \\(27\\) | 🟥 failed · capture\\-head | ${runLink} · [evidence](<https://github.com/expo/explore-playground/actions/runs/42#artifacts>) |`);
|
||||
assert.deepEqual(summaries(failed), ['Validation · iOS 🟥 failed']);
|
||||
assert.match(failed, /\*\*iOS failed\*\* — head capture did not complete; token=\\\[redacted\\\] leaked \[Open the failed run\]\(<[^>]+>\) · \[Evidence artifact\]\(<[^>]+>\)/);
|
||||
assert.equal(checkRow(failed, 'Capture'), '| Capture | 🟥 6/6 surfaces |');
|
||||
assert.equal(checkRow(failed, 'Visual comparison'), '| Visual comparison | — |');
|
||||
assert.doesNotMatch(failed, /\*\*Changes\*\*|\[Open\]|\[zip\]|abc123/);
|
||||
assert.equal(titleOf(failed), '### Explore review · capture failed');
|
||||
assert.equal(statusOf(failed, 'iOS'), `**iOS failed** · capture\\-head · head capture did not complete; token=\\[redacted\\] leaked · ${runLink} · ${evidenceLink}`);
|
||||
assert.deepEqual(listOf(failed), []);
|
||||
assert.doesNotMatch(failed, /\[Open\]|\[zip\]|abc123|Review in Explore|Validation/);
|
||||
});
|
||||
|
||||
test('a secondary appearance surface (<route>@<scheme>) is listed with its scheme and deep-linked like any other route', () => {
|
||||
const dark = surface('settings@dark', 'added', { route: '/settings', extra: { colorScheme: 'dark', review: { status: 'added', description: 'Added the dark appearance of /settings.' } } });
|
||||
const body = renderPublicComment(state({ review: review([dark]) }));
|
||||
assert.match(body, /\n- `\/settings` \(dark\) — Added [^·]+ · \[iOS\]\(<[^>]+&view=compare&screen=settings%40dark>\)\n/);
|
||||
assert.match(body, /\n- Added \[`\/settings`\]\(<[^>]+&view=compare&screen=settings%40dark>\) \(dark\)\n/, 'an added screen needs no description beyond its route');
|
||||
});
|
||||
|
||||
test('agent notes replace descriptions without changing groups, counts, or the rest of the comment', () => {
|
||||
test('agent notes replace descriptions without changing counts or the rest of the comment', () => {
|
||||
const original = evidenceReview();
|
||||
const annotated = structuredClone(original);
|
||||
for (const [index, text] of [[0, 'Added care guidance and a daily reminder action.'], [1, 'Removed the Sweet Bee activity screen.'], [2, 'The settings share action now reads “Share Example”.']]) {
|
||||
@@ -149,83 +150,78 @@ test('agent notes replace descriptions without changing groups, counts, or the r
|
||||
}
|
||||
const before = visible(renderPublicComment(state({ review: original })));
|
||||
const after = visible(renderPublicComment(state({ review: annotated })));
|
||||
assert.deepEqual(summaries(after), summaries(before));
|
||||
assert.equal(after.slice(after.indexOf('<summary>Validation')), before.slice(before.indexOf('<summary>Validation')));
|
||||
assert.equal(after.slice(0, after.indexOf('**Changes**')), before.slice(0, before.indexOf('**Changes**')));
|
||||
assert.match(after, /Added care guidance and a daily reminder action/);
|
||||
assert.match(after, /The settings share action now reads “Share Example”/);
|
||||
assert.equal(titleOf(after), titleOf(before));
|
||||
assert.equal(subtitleOf(after), subtitleOf(before));
|
||||
assert.equal(after.split('\n').at(-1), before.split('\n').at(-1));
|
||||
assert.equal(listOf(after).length, listOf(before).length);
|
||||
assert.match(after, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · Added care guidance and a daily reminder action\n/, 'a note on an added screen follows the route');
|
||||
assert.match(after, /\n- \[`\/settings`\]\(<[^>]+>\) · The settings share action now reads “Share Example”\n/);
|
||||
assert.doesNotMatch(after, /Changed button title from|evidenceDigest|Model|Tokens/);
|
||||
});
|
||||
|
||||
test('a long group is capped before the body budget and the comment stays under GitHub\'s limit', () => {
|
||||
const many = review(Array.from({ length: 40 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
|
||||
review: { status: 'modified', description: `Changed ${index}` },
|
||||
test('the list shows ten screens and links the rest; the comment stays under GitHub\'s limit', () => {
|
||||
const screens = (count, description) => review(Array.from({ length: count }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
|
||||
review: { status: 'modified', description: description(index) },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' },
|
||||
} })));
|
||||
const body = renderPublicComment(state({ review: many, capture: { planned: { base: 40, head: 40 }, done: { base: 40, head: 40 }, baseFromCache: false } }));
|
||||
assert.match(body, /<summary>🟧 Modified \(40\)<\/summary>/);
|
||||
assert.equal((body.match(/\n- `\/screen-\d+`/g) ?? []).length, 40);
|
||||
const body = renderPublicComment(state({ review: screens(40, index => `Changed ${index}`), capture: { planned: { base: 40, head: 40 }, done: { base: 40, head: 40 }, baseFromCache: false } }));
|
||||
assert.equal(titleOf(body), `### 40 screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
assert.equal((body.match(/\n- \[`\/screen-\d+`\]/g) ?? []).length, 10);
|
||||
assert.equal(listOf(body).at(-1), `- [30 more screens in the report](<${reportUrl}>)`);
|
||||
assert.ok(body.length < PUBLIC_COMMENT_BODY_BUDGET);
|
||||
const huge = review(Array.from({ length: 900 }, (_, index) => surface(`s${index}`, 'modified', { extra: { review: { status: 'modified', description: `Changed ${index} in a way that takes a sentence to describe for the budget check.` } } })));
|
||||
const long = renderPublicComment(state({ review: huge }));
|
||||
assert.equal(listOf(renderPublicComment(state({ review: screens(11, () => 'Changed') }))).at(-1), `- [1 more screen in the report](<${reportUrl}>)`);
|
||||
assert.equal(listOf(renderPublicComment(state({ review: screens(10, () => 'Changed') }))).length, 10, 'ten screens need no link to the rest');
|
||||
const long = renderPublicComment(state({ review: screens(900, index => `Changed ${index} in a way that takes a sentence to describe for the budget check.`) }));
|
||||
assert.ok(long.length < PUBLIC_COMMENT_BODY_BUDGET, String(long.length));
|
||||
assert.match(long, /<summary>🟧 Modified \(900\)<\/summary>/);
|
||||
assert.match(long, /\n- \d+ more — \[Explore report\]\(<[^>]+>\)\n/);
|
||||
assert.match(titleOf(long), /^### 900 screens changed · /);
|
||||
assert.match(long, /\n- \[890 more screens in the report\]\(<[^>]+>\)\n/);
|
||||
});
|
||||
|
||||
test('pending and capturing runs show progress in the platform table and no change lists', () => {
|
||||
const links = viewerLinks({ viewerUrl: 'https://explore-preview.expo.app/map', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
|
||||
test('pending and capturing runs say what they are doing in the heading and a line per target, with no list', () => {
|
||||
const links = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
|
||||
const pending = renderPublicComment(state({ phase: 'pending', links, review: undefined, evidence: undefined, runtime: undefined, capture: { planned: { base: 3, head: 3 }, done: { base: 0, head: 0 }, baseFromCache: false } }));
|
||||
assert.equal(platformRow(pending, 'iOS'), `| iOS | Example 1\\.4\\.0 \\(27\\) | ⏳ starting | ${runLink} |`);
|
||||
assert.equal(titleOf(pending), '### Explore review · starting');
|
||||
assert.equal(subtitleOf(pending), `<sub>iOS · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
|
||||
assert.equal(statusOf(pending, 'iOS'), `iOS · starting · ${runLink}`);
|
||||
assert.deepEqual(listOf(pending), []);
|
||||
assert.deepEqual(summaries(pending), []);
|
||||
assert.doesNotMatch(pending, /\*\*Changes\*\*|Validation|Waiting|Open|zip/);
|
||||
const progress = (current, baseFromCache) => platformRow(renderPublicComment(state({ phase: 'capturing', links, review: undefined, evidence: undefined,
|
||||
assert.doesNotMatch(pending, /changed|Review in Explore|Validation|Waiting|Open|zip/);
|
||||
const progress = (current, baseFromCache) => statusOf(renderPublicComment(state({ phase: 'capturing', links, review: undefined, evidence: undefined,
|
||||
capture: { planned: { base: 3, head: 3 }, done: { base: 2, head: 1 }, baseFromCache, current } })), 'iOS');
|
||||
assert.match(progress('base', false), /\| ⏳ capturing base 2\/3 \| /);
|
||||
assert.match(progress('head', false), /\| ⏳ capturing head 1\/3 \| /);
|
||||
assert.match(progress('head', true), /\| ⏳ capturing head 1\/3 · base reused \| /);
|
||||
assert.match(progress(undefined, false), /\| ⏳ capturing head 1\/3 \| /);
|
||||
assert.equal(progress('base', false), `iOS · capturing base 2/3 · ${runLink}`);
|
||||
assert.equal(progress('head', false), `iOS · capturing head 1/3 · ${runLink}`);
|
||||
assert.equal(progress('head', true), `iOS · capturing head 1/3 · base reused · ${runLink}`);
|
||||
assert.equal(progress(undefined, false), `iOS · capturing head 1/3 · ${runLink}`);
|
||||
assert.equal(titleOf(renderPublicComment(state({ phase: 'capturing', links, review: undefined, evidence: undefined }))), '### Explore review · capturing');
|
||||
const none = renderPublicComment(state({ review: review([surface('cats', 'modified', { extra: { review: { status: 'unchanged', description: 'No visible change' } } })]) }));
|
||||
assert.deepEqual(summaries(none), ['Validation · iOS 🟩 6/6 captured'], 'unchanged surfaces produce no group');
|
||||
assert.match(none, /\*\*Changes\*\* · 0 screens\n\nNo screen changed on the reviewed platforms\./);
|
||||
assert.equal(titleOf(none), `### No screens changed · [Review in Explore](<${reportUrl}>)`, 'unchanged surfaces are no change');
|
||||
assert.deepEqual(listOf(none), []);
|
||||
});
|
||||
|
||||
test('an OS version the simulator did not report is omitted, not shown as unknown', () => {
|
||||
const body = renderPublicComment(state({ runtime: { ...state().runtime, osVersion: 'unknown' } }));
|
||||
assert.match(platformRow(body, 'iOS'), /^\| iOS \| iPhone 17 · Example 1\\\.4\\\.0 \\\(27\\\) \|/);
|
||||
assert.doesNotMatch(body, /unknown/i);
|
||||
});
|
||||
|
||||
test('without evidence the comment lists only added and removed screens and says comparisons did not run', () => {
|
||||
test('without evidence the comment lists only added and removed screens and counts the uncompared one', () => {
|
||||
const plain = review([surface('care-guide', 'added'), surface('sweet-bee', 'removed'), surface('settings', 'modified'), surface('cats', 'unchanged')]);
|
||||
const body = renderPublicComment(reviewOnlyState(plain));
|
||||
// A source change nobody compared is not a change the captures show.
|
||||
assert.deepEqual(summaries(body).slice(0, 2), ['🟩 Added (1)', '🟥 Removed (1)']);
|
||||
assert.doesNotMatch(body, /Source-affected|screen=settings/);
|
||||
assert.equal(checkRow(body, 'Visual comparison'), '| Visual comparison | 🟨 not run |');
|
||||
assert.equal(checkRow(body, 'Accessibility comparison'), '| Accessibility comparison | 🟨 not run |');
|
||||
assert.match(platformRow(body, 'iOS'), /^\| iOS \| Example 1\\\.4\\\.0 \\\(27\\\) \| 🟨 2 changes · 1 not compared · 0s \|/, 'the uncompared /settings is counted, not hidden');
|
||||
assert.doesNotMatch(body, /Needs review|Unchanged|screen=cats/);
|
||||
assert.match(titleOf(body), /^### 2 screens changed · /);
|
||||
assert.deepEqual(listOf(body).map(line => /^- (Added|Removed) /.exec(line)?.[1]), ['Added', 'Removed']);
|
||||
assert.equal(statusOf(body, 'iOS'), `iOS · 1 not compared · ${runLink}`, 'the uncompared /settings is counted, not hidden');
|
||||
assert.doesNotMatch(body, /Source-affected|screen=settings|Needs review|Unchanged|screen=cats|not run/);
|
||||
});
|
||||
|
||||
test('the completed duration stays tied to the captured review when the comment is republished', () => {
|
||||
const original = platformRow(renderPublicComment(state()), 'iOS');
|
||||
assert.equal(platformRow(renderPublicComment(state({ updatedAt: Date.parse('2026-09-12T09:42:00Z') })), 'iOS'), original);
|
||||
assert.match(original, /🟩 3 changes · 6m 12s/);
|
||||
assert.doesNotMatch(renderPublicComment(state({ phase: 'capturing', review: undefined })), /6m 12s/);
|
||||
test('the subtitle says when the comment last changed: the review\'s time once ready, the writer\'s before', () => {
|
||||
assert.match(subtitleOf(renderPublicComment(state({ updatedAt: Date.parse('2026-09-12T09:42:00Z') }))), /· updated Sep 11, 3:07 AM UTC<\/sub>$/, 'a republished review keeps its time');
|
||||
assert.match(subtitleOf(renderPublicComment(state({ phase: 'capturing', review: undefined, updatedAt: Date.parse('2026-09-12T09:42:00Z') }))), /· updated Sep 12, 9:42 AM UTC<\/sub>$/);
|
||||
});
|
||||
|
||||
test('needs-review surfaces keep their group and validation status without capture warnings', () => {
|
||||
test('needs-review surfaces are tagged on their row; screen variants and capture warnings stay out', () => {
|
||||
const flagged = evidenceReview();
|
||||
flagged.surfaces[2].review = { status: 'needs-review', description: 'Screenshots differ (2.1%) without a source change' };
|
||||
flagged.surfaces.push(surface('coins', 'unchanged', { extra: { sourceScope: 'none', review: { status: 'variant', description: 'Runtime state differs: Removed text “84”.' },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 0.2, threshold: 0.1, tool: '[email protected]' } } }));
|
||||
const body = renderPublicComment(state({ review: flagged, warnings: ['src/app/orphan.tsx has unresolved navigation'], inventory: { routes: 54 } }));
|
||||
assert.match(body, /<summary>🟨 Needs review \(1\)<\/summary>/);
|
||||
assert.doesNotMatch(body, /<summary>🟧 Modified/);
|
||||
assert.match(body, /\n- `\/settings` — Screenshots differ \\\(2\\\.1%\\\) without a source change · \[iOS\]/);
|
||||
assert.equal(checkRow(body, 'Source inventory'), '| Source inventory | 🟩 54 routes |');
|
||||
assert.doesNotMatch(body, /Capture warnings|orphan/);
|
||||
assert.match(titleOf(body), /^### 3 screens changed · /);
|
||||
assert.match(body, /\n- \[`\/settings`\]\(<[^>]+>\) · Screenshots differ \\\(2\\\.1%\\\) without a source change · needs review\n/);
|
||||
assert.doesNotMatch(body, /coins|Capture warnings|orphan|Needs review \(|54 routes/);
|
||||
});
|
||||
|
||||
test('text is redacted and escaped before it reaches the comment, and credentialed links are refused', () => {
|
||||
@@ -236,19 +232,18 @@ test('text is redacted and escaped before it reaches the comment, and credential
|
||||
assert.throws(() => renderPublicComment(state({ links: { ...state().links, run: 'https://user:[email protected]/x' } })), /credentials/);
|
||||
});
|
||||
|
||||
test('completed partial capture shows unavailable targets rather than ongoing work', () => {
|
||||
test('a completed partial capture gets one line with the count of missing captures, not ongoing work', () => {
|
||||
const capture = { planned: { base: 34, head: 34 }, done: { base: 21, head: 34 }, baseFromCache: false };
|
||||
const ready = renderPublicComment(state({ capture }));
|
||||
assert.equal(checkRow(ready, 'Capture'), '| Capture | 🟨 55/68 surfaces · 13 unavailable |');
|
||||
assert.match(platformRow(ready, 'iOS'), /\| 🟨 3 changes · 13 unavailable · 6m 12s \|/);
|
||||
assert.doesNotMatch(ready, /⏳/);
|
||||
assert.equal(checkRow(renderPublicComment(state({ phase: 'failed', capture, failure: { step: 'capture-base', message: 'failed' } })), 'Capture'), '| Capture | 🟥 55/68 surfaces |');
|
||||
assert.equal(checkRow(renderPublicComment(state({ capture: { ...capture, done: { base: 34, head: 34 } } })), 'Capture'), '| Capture | 🟩 68/68 surfaces |');
|
||||
assert.equal(checkRow(renderPublicComment(state({ capture: { ...capture, done: { base: 0, head: 0 } } })), 'Capture'), '| Capture | 🟨 6/68 surfaces · 62 unavailable |', 'the review’s own frames count as captured');
|
||||
assert.equal(checkRow(renderPublicComment(state({ capture: { ...capture, baseFromCache: true } })), 'Capture'), '| Capture | 🟨 55/68 surfaces · 13 unavailable · base cache reused |');
|
||||
assert.equal(statusOf(ready, 'iOS'), `iOS · 13 captures unavailable · ${runLink}`);
|
||||
assert.match(titleOf(ready), /^### 3 screens changed · /);
|
||||
assert.doesNotMatch(ready, /⏳|Capture issues|surfaces/);
|
||||
assert.equal(statusOf(renderPublicComment(state({ phase: 'failed', capture, failure: { step: 'capture-base', message: 'failed' } })), 'iOS'), `**iOS failed** · capture\\-base · failed · ${runLink} · ${evidenceLink}`);
|
||||
assert.equal(statusOf(renderPublicComment(state({ capture: { ...capture, done: { base: 34, head: 34 } } })), 'iOS'), undefined, 'a complete capture needs no line');
|
||||
assert.equal(statusOf(renderPublicComment(state({ capture: { ...capture, done: { base: 0, head: 0 } } })), 'iOS'), `iOS · 62 captures unavailable · ${runLink}`, 'the review’s own frames count as captured');
|
||||
});
|
||||
|
||||
test('capture problems are listed as diagnostics inside the validation block with both sides', () => {
|
||||
test('capture problems are counted on the target\'s line and listed, collapsed, with both sides', () => {
|
||||
const flagged = evidenceReview();
|
||||
const failure = side => ({ status: 'failed', attempts: 1, landing: 'unverified', error: {
|
||||
code: `${side.toUpperCase()}_SESSION_FAILED`, stage: 'capture', message: `${side} simulator disconnected; token=private`,
|
||||
@@ -262,17 +257,18 @@ test('capture problems are listed as diagnostics inside the validation block wit
|
||||
flagged.surfaces[2].headOutcome.landing = 'unverified';
|
||||
flagged.surfaces[2].review = { status: 'needs-review', description: 'old destination failure' };
|
||||
const body = renderPublicComment(state({ review: flagged, capture: { planned: { base: 3, head: 3 }, done: { base: 1, head: 2 }, baseFromCache: false } }));
|
||||
// /settings could not be compared, so it is no change: its failures are named under Validation.
|
||||
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', 'Validation · iOS 🟨 3/6 captured']);
|
||||
assert.match(platformRow(body, 'iOS'), /\| 🟨 2 changes · 3 unavailable · 1 unattributed · 6m 12s \|/);
|
||||
// /settings could not be compared, so it is no change: its failures are named under Capture issues.
|
||||
assert.match(titleOf(body), /^### 2 screens changed · /);
|
||||
assert.equal(statusOf(body, 'iOS'), `iOS · 3 captures unavailable · 1 unattributed · ${runLink}`);
|
||||
assert.deepEqual(summaries(body), ['Capture issues (4)']);
|
||||
assert.ok(body.indexOf('<summary>Capture issues') > body.indexOf('\n- Removed '), 'the list comes first');
|
||||
assert.match(body, /\n- Base · \/settings · /);
|
||||
assert.match(body, /\*\*iOS\*\* · base 1\/3 verified · 2 unavailable · head 1\/3 verified · 1 unattributed · 1 unavailable/);
|
||||
assert.match(body, /\n- Base · \/cats\/sweet\\-bee · BASE\\_SESSION\\_FAILED: base simulator disconnected; token=\\\[redacted\\\] Next action: Restart the base simulator session and rerun capture\\\./);
|
||||
assert.match(body, /\n- Head · \/cats\/care\\-guide · HEAD\\_SESSION\\_FAILED/);
|
||||
assert.doesNotMatch(body, /Needs review|Modified|old capture|old destination|token=private/);
|
||||
assert.doesNotMatch(body, /needs review|Modified|old capture|old destination|token=private|\*\*iOS\*\*|Validation/);
|
||||
});
|
||||
|
||||
test('zero eligible pairs are visibly skipped instead of successful comparisons', () => {
|
||||
test('zero eligible pairs are counted as unattributed instead of successful comparisons', () => {
|
||||
const flagged = evidenceReview();
|
||||
for (const surface of flagged.surfaces) {
|
||||
for (const side of ['base', 'head']) if (surface[`${side}Outcome`]) surface[`${side}Outcome`].landing = 'unverified';
|
||||
@@ -284,30 +280,29 @@ test('zero eligible pairs are visibly skipped instead of successful comparisons'
|
||||
visual: { compared: 0, modified: 0, unchanged: 0, needsReview: 0, failed: 0, errors: [], threshold: 0.1, tool: '[email protected]' },
|
||||
accessibility: { compared: 0, described: 0, failed: 0, skipped: 0, errors: [] },
|
||||
} }));
|
||||
assert.equal(checkRow(body, 'Route verification'), '| Route verification | 🟨 0/6 verified · 6 unattributed |');
|
||||
assert.equal(checkRow(body, 'Visual comparison'), '| Visual comparison | 🟨 0 compared · threshold 0.1 · 2 skipped |');
|
||||
assert.equal(checkRow(body, 'Accessibility comparison'), '| Accessibility comparison | 🟨 0 compared · 0 descriptions |');
|
||||
assert.match(platformRow(body, 'iOS'), /\| 🟨 2 changes · 6 unattributed · 6m 12s \|/, 'the uncompared modified screens are not changes');
|
||||
assert.match(titleOf(body), /^### 2 screens changed · /, 'the uncompared modified screens are not changes');
|
||||
assert.equal(statusOf(body, 'iOS'), `iOS · 6 unattributed · ${runLink}`);
|
||||
});
|
||||
|
||||
test('the review-only comment counts failed outcomes in planned coverage and lists the reason', () => {
|
||||
test('the review-only comment counts failed outcomes as unavailable and lists the reason', () => {
|
||||
const added = surface('added', 'added');
|
||||
delete added.headImage;
|
||||
added.headOutcome = { status: 'missing-params', attempts: 0, landing: 'unverified', reason: 'Provide the item ID.' };
|
||||
const body = renderPublicComment(reviewOnlyState(review([added])));
|
||||
assert.equal(checkRow(body, 'Capture'), '| Capture | 🟨 0/1 surfaces · 1 unavailable |');
|
||||
assert.match(body, /<summary>🟩 Added \(1\)<\/summary>/);
|
||||
assert.equal(statusOf(body, 'iOS'), `iOS · 1 capture unavailable · ${runLink}`);
|
||||
assert.match(body, /\n- Added \[`\/added`\]\(<[^>]+screen=added>\)\n/);
|
||||
assert.deepEqual(summaries(body), ['Capture issues (1)']);
|
||||
assert.match(body, /CAPTURE\\_UNAVAILABLE: Provide the item ID\\\./);
|
||||
});
|
||||
|
||||
test('a failed run keeps the source additions and removals of its partial report', () => {
|
||||
test('a failed run keeps its message on the target\'s line and lists nothing', () => {
|
||||
const body = renderPublicComment(state({ phase: 'failed', failure: { step: 'capture', message: 'Capture coverage is incomplete.' } }));
|
||||
assert.match(platformRow(body, 'iOS'), /\| 🟥 failed · capture \|/);
|
||||
assert.match(body, /\*\*iOS failed\*\* — Capture coverage is incomplete\\\./);
|
||||
assert.doesNotMatch(body, /\*\*Changes\*\*|🟩 Added/, 'a failed run has no review to list');
|
||||
assert.equal(titleOf(body), '### Explore review · capture failed');
|
||||
assert.equal(statusOf(body, 'iOS'), `**iOS failed** · capture · Capture coverage is incomplete\\. · ${runLink} · ${evidenceLink}`);
|
||||
assert.deepEqual(listOf(body), [], 'a failed run has no review to list');
|
||||
});
|
||||
|
||||
test('screen variants and app-wide changes are stated once, not listed as review targets', () => {
|
||||
test('screen variants and app-wide source changes are left to the report', () => {
|
||||
const variant = surface('coins', 'unchanged', { extra: { sourceScope: 'none',
|
||||
review: { status: 'variant', description: 'Runtime state differs: Removed text “84”.' },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 0.2, threshold: 0.1, tool: '[email protected]' } } });
|
||||
@@ -315,29 +310,40 @@ test('screen variants and app-wide changes are stated once, not listed as review
|
||||
review: { status: 'unchanged', description: 'No visible change' },
|
||||
sourceChange: { ...sourceChange('Dependency update.', 'global'), files: [{ path: 'package.json', status: 'modified', relation: 'global', hunks: [], facts: [], truncated: false }] } } });
|
||||
const body = renderPublicComment(state({ review: review([...evidenceReview().surfaces, variant, appWide]) }));
|
||||
assert.doesNotMatch(body, /\/coins|\/profile|Needs review \(/);
|
||||
assert.match(body, /1 screen differs only in runtime state \(screen variants\); no source change reaches it\./);
|
||||
assert.match(body, /App-wide source changes \(`package\.json`\) reach every screen; screens without a visible difference are not listed\./);
|
||||
assert.match(titleOf(body), /^### 3 screens changed · /);
|
||||
assert.doesNotMatch(body, /\/coins|\/profile|runtime state|App-wide|package\.json/);
|
||||
});
|
||||
|
||||
test('a hosted preview is the Open link, the footer keeps the zip and run and says how long the link works', () => {
|
||||
test('a changed splash screen is one line after the list; an unchanged one is not mentioned', () => {
|
||||
const launch = verdict => ({ ...evidenceReview(), launch: [
|
||||
{ colorScheme: 'light', head: { status: 'observed', source: 'recording', splashVisibleMs: 900, firstScreenMs: 1900 }, base: { status: 'observed' }, visual: { verdict } },
|
||||
{ colorScheme: 'dark', head: { status: 'observed', source: 'recording', splashVisibleMs: 900, firstScreenMs: 1900 }, base: { status: 'observed' }, visual: { verdict: 'unchanged' } }] });
|
||||
const changed = renderPublicComment(state({ review: launch('modified'), artifactOnly: true }));
|
||||
assert.match(changed, /\n- \[`\/settings`\][^\n]+\n\nSplash screen changed in light mode\n\n<sub>/);
|
||||
assert.match(renderPublicComment(state({ review: launch('needs-review'), artifactOnly: true })), /\nSplash screen needs review in light mode\n/);
|
||||
assert.doesNotMatch(renderPublicComment(state({ review: launch('unchanged'), artifactOnly: true })), /Splash|Launch|first screen/);
|
||||
const both = { ...evidenceReview(), launch: [{ head: { status: 'observed', source: 'recording' }, base: { status: 'observed' }, visual: { verdict: 'modified' } }] };
|
||||
assert.match(renderPublicComment(state({ review: both, artifactOnly: true })), /\nSplash screen changed\n/);
|
||||
});
|
||||
|
||||
test('a hosted preview is the report link, and the footer says how long the links work', () => {
|
||||
const token = 'abcdefghijklmnopqrstuvwxyz234567';
|
||||
const preview = previewLinks(`https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`, Date.parse('2026-09-18T03:07:00Z'));
|
||||
const links = { ...viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml', artifactUrl }), preview };
|
||||
const body = renderPublicComment(state({ links, artifactOnly: true }));
|
||||
const lines = body.split('\n');
|
||||
assert.equal(lines[1], '<!-- expo-explore-deployments:acme-explore--1lcbdcpwn3 -->');
|
||||
assert.match(platformRow(body, 'iOS'), new RegExp(`\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\) \\|$`));
|
||||
assert.match(lines.at(-1), /· Workflow \[run\]\(<[^>]+>\) · \[zip\]\(<[^>]+>\)$/);
|
||||
assert.match(body, new RegExp(`\\[iOS\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?view=compare&screen=settings>\\)`));
|
||||
assert.match(lines.at(-1), /^Preview links work until Sep 18, 2026 \(UTC\) for anyone who has them\. · Managed via /);
|
||||
assert.doesNotMatch(body, /Open Explore|explore-viewer\.expo\.app|explore-preview\.expo\.app/);
|
||||
assert.equal(titleOf(body), `### 3 screens changed · [Review in Explore](<https://acme-explore--1lcbdcpwn3.expo.app/p/${token}>)`);
|
||||
assert.equal(subtitleOf(body), `<sub>[iOS](<https://acme-explore--1lcbdcpwn3.expo.app/p/${token}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
|
||||
assert.match(body, new RegExp(`\\n- \\[\`/settings\`\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?view=compare&screen=settings>\\) · `));
|
||||
assert.equal(lines.at(-1), `<sub>Preview links work for anyone who has them until Sep 18, 2026 (UTC) · ${workflowRun} · ${configLink}</sub>`);
|
||||
assert.doesNotMatch(body, /Open Explore|explore-viewer\.expo\.app|explore-preview\.expo\.app|zip/);
|
||||
assert.doesNotMatch(renderPublicComment(state({ links, phase: 'failed', review: undefined, failure: { step: 'capture-head', message: 'boom' } })), /acme-explore--1lcbdcpwn3\.expo\.app\/p|for anyone who has/);
|
||||
const forever = renderPublicComment(state({ links: { ...links, preview: previewLinks(`https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`, null) }, artifactOnly: true }));
|
||||
assert.match(forever, /\nPreview links work for anyone who has them until the deployment is deleted\. · Managed via /);
|
||||
assert.match(forever, /\n<sub>Preview links work for anyone who has them until the deployment is deleted · \[Workflow run\]/);
|
||||
});
|
||||
|
||||
test('two platforms share one comment: one table row each, every changed screen listed once with a link per platform, one validation table', async () => {
|
||||
test('two platforms share one comment: both named in the subtitle, every changed screen listed once, a line only for the one still working', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const ready = state({ artifactOnly: true });
|
||||
const single = renderPublicComment(ready);
|
||||
@@ -347,29 +353,24 @@ test('two platforms share one comment: one table row each, every changed screen
|
||||
runtime: { ...state().runtime, platform: 'android', deviceModel: 'EasAndroidDevice01', osVersion: '15.0' }, ...overrides });
|
||||
const capturing = platformSectionMerge(androidState({ phase: 'capturing', review: undefined, evidence: undefined, capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 1 }, baseFromCache: false, current: 'head' } }), 'android').merge(single);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(capturing).current), ['ios', 'android']);
|
||||
assert.equal(platformRow(capturing, 'iOS'), platformRow(single, 'iOS'));
|
||||
assert.equal(platformRow(capturing, 'Android'), `| Android | EasAndroidDevice01 15\\.0 · Example 1\\.4\\.0 \\(27\\) | ⏳ capturing head 1/3 | ${runLink} |`);
|
||||
assert.deepEqual(summaries(capturing), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', 'Validation · iOS 🟩 6/6 captured · Android ⏳ in progress']);
|
||||
assert.match(capturing, /\| Check \| iOS \| Android \|\n\|---\|---\|---\|\n\| Capture \| 🟩 6\/6 surfaces · base cache reused \| ⏳ \|/);
|
||||
assert.match(capturing, /\n- `\/settings` — Changed button title from “Share” to “Share Example”\\\. · \[iOS\]\(<[^>]+>\)\n/, 'a platform still capturing adds no link');
|
||||
assert.equal(titleOf(capturing), titleOf(single), 'a platform still capturing has no report to link yet');
|
||||
assert.equal(subtitleOf(capturing), `<sub>[iOS](<${reportUrl}>) · Android · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
|
||||
assert.equal(statusOf(capturing, 'Android'), `Android · capturing head 1/3 · ${runLink}`);
|
||||
assert.equal(statusOf(capturing, 'iOS'), undefined);
|
||||
assert.deepEqual(listOf(capturing), listOf(single), 'a platform still capturing adds nothing to the list');
|
||||
const flagged = evidenceReview();
|
||||
flagged.surfaces[2].review = { status: 'needs-review', description: 'Screenshots differ (2.1%) without a source change' };
|
||||
flagged.surfaces.push(surface('coins', 'unchanged', { extra: { sourceScope: 'none', review: { status: 'variant', description: 'Runtime state differs: Removed text “84”.' },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 0.2, threshold: 0.1, tool: '[email protected]' } } }));
|
||||
const both = platformSectionMerge(androidState({ review: flagged }), 'android').merge(capturing);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(both).current), ['ios', 'android']);
|
||||
assert.equal(platformRow(both, 'iOS'), platformRow(single, 'iOS'));
|
||||
assert.match(platformRow(both, 'Android'), /^\| Android \| EasAndroidDevice01 15\\\.0 · Example 1\\\.4\\\.0 \\\(27\\\) \| 🟩 3 changes · 6m 12s \| \[Open\]/);
|
||||
assert.match(both, /\*\*Changes\*\* · 3 screens · a screen is listed once, with a link per platform\n/);
|
||||
assert.match(capturing, /^### Explore review · \[Open report\]\(<[^>]+>\)$/m, 'a platform still capturing has no report to link yet');
|
||||
assert.match(both, /^### Explore review · \[iOS report\]\(<[^>]+>\) · \[Android report\]\(<[^>]+>\)$/m, 'with two platforms the heading links each report');
|
||||
assert.match(both, /\nAndroid · 1 screen differs only in runtime state \(screen variants\); no source change reaches it\.\n/, 'a context line from one platform names it');
|
||||
assert.doesNotMatch(both, /iOS · /);
|
||||
assert.match(both, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iOS\]\(<[^>]+screen=care-guide>\) · \[Android\]\(<[^>]+screen=care-guide>\)\n/);
|
||||
assert.match(both, /\n- `\/settings` — Changed button title from “Share” to “Share Example”\\\. · \[iOS\]\(<[^>]+>\) · \[Android \(needs review\)\]\(<[^>]+>\)\n/, 'a platform whose verdict differs says so on the row');
|
||||
assert.deepEqual(summaries(both), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', 'Validation · iOS 🟩 6/6 captured · Android 🟩 8/8 captured']);
|
||||
assert.equal((both.match(/\n- `/g) ?? []).length, 3, 'no screen is listed twice');
|
||||
assert.equal((both.match(/\| Capture \|/g) ?? []).length, 1);
|
||||
assert.equal(titleOf(both), titleOf(single), 'the heading links the first platform’s report');
|
||||
assert.match(subtitleOf(both), /^<sub>\[iOS\]\(<[^>]+artifact=7654>\) · \[Android\]\(<[^>]+artifact=7654>\) · \[bbbbbbbb\]/);
|
||||
assert.equal(statusOf(both, 'Android'), undefined);
|
||||
assert.equal(listOf(both).length, 3, 'no screen is listed twice');
|
||||
assert.match(both, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+screen=care-guide>\)\n/);
|
||||
assert.match(both, /\n- \[`\/settings`\]\(<[^>]+>\) · Changed button title from “Share” to “Share Example”\n/, 'a platform whose verdict differs does not change the row');
|
||||
assert.doesNotMatch(both, / only\n|not on |coins|runtime state|iOS · /);
|
||||
assert.ok(both.length < 8_000, String(both.length));
|
||||
// A writer that finds no records (a legacy or hand-edited comment) starts over rather than failing.
|
||||
const legacy = `${CI_COMMENT_MARKER}\nExplore review for x\n<!-- expo-explore-platform:ios -->\n## iOS · 3 changes\n<!-- /expo-explore-platform:ios -->`;
|
||||
@@ -378,32 +379,68 @@ test('two platforms share one comment: one table row each, every changed screen
|
||||
assert.equal(platformSectionMerge(ready, 'ios').merge(tampered), single);
|
||||
});
|
||||
|
||||
test('a newer run moves the current run into Previous runs; a run the PR moved past joins history without displacing the current review', async () => {
|
||||
test('a screen that changed on some devices only says which, the shorter way', async () => {
|
||||
const { platformSectionMerge } = await import('../../dist/report/pr-comment-body.js');
|
||||
const [iphone, closed, open, android] = duoTargets;
|
||||
const settingsOnly = review([evidenceReview().surfaces[2]]);
|
||||
let body;
|
||||
for (const target of [iphone, closed, open]) body = platformSectionMerge(targetState(target), target.id).merge(body);
|
||||
body = platformSectionMerge(targetState(android, { review: settingsOnly }), 'android').merge(body);
|
||||
assert.match(body, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · not on Pixel 7\n/);
|
||||
assert.match(body, /\n- \[`\/settings`\]\(<[^>]+>\) · Changed button title from “Share” to “Share Example”\n/, 'a screen changed everywhere names no device');
|
||||
const two = platformSectionMerge(targetState(android, { review: settingsOnly }), 'android').merge(platformSectionMerge(targetState(iphone), 'iphone').merge(undefined));
|
||||
assert.match(two, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · iPhone 17 only\n/);
|
||||
// A device missing a capture may have changed the screen too: the row says where it changed, not where it did not.
|
||||
const missing = platformSectionMerge(targetState(android, { review: settingsOnly, capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 2 }, baseFromCache: false } }), 'android')
|
||||
.merge(platformSectionMerge(targetState(iphone), 'iphone').merge(undefined));
|
||||
assert.match(missing, /\nPixel 7 · 1 capture unavailable · /);
|
||||
assert.match(missing, /\n- Added \[`\/cats\/care-guide`\]\(<[^>]+>\) · on iPhone 17\n/);
|
||||
assert.doesNotMatch(missing, / only\n|not on /);
|
||||
});
|
||||
|
||||
test('a new run keeps the last finished review up, under a line saying it is working, until it has a finished target; the old run joins Previous runs', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const first = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
|
||||
const androidReady = state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' } });
|
||||
const both = platformSectionMerge(androidReady, 'android').merge(first);
|
||||
const nextHead = 'd'.repeat(40);
|
||||
const nextLinks = runId => viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId, runAttempt: '1', configPath: '.expo-explore/config.yaml' });
|
||||
const nextLinks = (runId, artifact) => viewerLinks({ ...(artifact ? { artifactUrl: `https://github.com/expo/explore-playground/actions/runs/${runId}/artifacts/${artifact}` } : {}),
|
||||
repository: pullRequest.repository, headSha: nextHead, runId, runAttempt: '1', configPath: '.expo-explore/config.yaml' });
|
||||
const nextState = overrides => state({ phase: 'capturing', review: undefined, evidence: undefined, links: nextLinks('43'), pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
startedAt: Date.parse('2026-09-11T04:00:00Z'), updatedAt: Date.parse('2026-09-11T04:01:00Z'), capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 0 }, baseFromCache: true, current: 'head' }, ...overrides });
|
||||
const next = platformSectionMerge(nextState(), 'ios').merge(both);
|
||||
assert.match(next.split('\n').find(line => line.startsWith('<sub>')), /^<sub>base \[aaaaaaaa\]\(<[^>]+>\) → \[dddddddd\]/);
|
||||
assert.equal(visible(next).split('\n')[1], `> **New run in progress** for [dddddddd](<https://github.com/expo/explore-playground/commit/${nextHead}>) · capturing on iOS · [run](<https://github.com/expo/explore-playground/actions/runs/43/attempts/1>)`);
|
||||
assert.equal(titleOf(next), titleOf(both), 'the previous review stays up');
|
||||
assert.equal(subtitleOf(next), subtitleOf(both));
|
||||
assert.deepEqual(listOf(next), listOf(both));
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).current), ['ios']);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).previous), ['ios', 'android']);
|
||||
assert.deepEqual(summaries(next), ['Previous runs (1)']);
|
||||
assert.match(next, /\n- \[bbbbbbbb\]\(<https:\/\/github\.com\/expo\/explore-playground\/commit\/b{40}>\) · iOS 🟩 3 changes \(\[report\]\(<https:\/\/explore-preview\.expo\.app\/\?repo=[^>]+&artifact=7654>\) · \[run\]\(<[^>]+runs\/42\/attempts\/2>\)\) · Android 🟩 3 changes \(\[report\]\(<[^>]+>\) · \[run\]\(<[^>]+>\)\)\n/);
|
||||
assert.doesNotMatch(next, /\*\*Changes\*\*|screen=settings/);
|
||||
// The previous run's Android report job finishes after the new run started: it is superseded and lands in history.
|
||||
const late = platformSectionMerge(androidReady, 'android').merge(next);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(late).current), ['ios']);
|
||||
assert.equal(readCommentRecords(late).history.length, 1);
|
||||
assert.match(late, /^<sub>base \[aaaaaaaa\]\(<[^>]+>\) → \[dddddddd\]/m);
|
||||
// The new run's Android writer joins the current run, and the previous run stays listed.
|
||||
assert.equal(titleOf(late), titleOf(both));
|
||||
// The new run's Android writer joins; nothing finished yet, so the previous review stays.
|
||||
const joined = platformSectionMerge(nextState({ build: { ...state().build, platform: 'android' } }), 'android').merge(late);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(joined).current), ['ios', 'android']);
|
||||
assert.match(visible(joined).split('\n')[1], /^> \*\*New run in progress\*\* for \[dddddddd\]\(<[^>]+>\) · capturing on iOS, Android · \[run\]/);
|
||||
assert.deepEqual(listOf(joined), listOf(both));
|
||||
assert.deepEqual(summaries(joined), ['Previous runs (1)']);
|
||||
// The new run's iOS finishes: its review takes over; the previous Android record waits for the new one.
|
||||
const iosDone = platformSectionMerge(nextState({ phase: 'ready', review: evidenceReview(), links: nextLinks('43', '7700') }), 'ios').merge(joined);
|
||||
assert.doesNotMatch(iosDone, /New run in progress/);
|
||||
assert.match(titleOf(iosDone), /^### 3 screens changed · \[Review in Explore\]\(<[^>]+artifact=7700>\)$/);
|
||||
assert.match(subtitleOf(iosDone), /^<sub>\[iOS\]\(<[^>]+artifact=7700>\) · Android · \[dddddddd\]/);
|
||||
assert.equal(statusOf(iosDone, 'Android'), 'Android · capturing head 0/3 · base reused · [run](<https://github.com/expo/explore-playground/actions/runs/43/attempts/1>)');
|
||||
assert.deepEqual(Object.keys(readCommentRecords(iosDone).previous), ['android']);
|
||||
const androidDone = platformSectionMerge(nextState({ phase: 'ready', review: evidenceReview(), links: nextLinks('43', '7700'), build: { ...state().build, platform: 'android' } }), 'android').merge(iosDone);
|
||||
assert.equal(readCommentRecords(androidDone).previous, undefined, 'once every target finished nothing previous is kept');
|
||||
assert.doesNotMatch(androidDone, /expo-explore-previous/);
|
||||
assert.equal(statusOf(androidDone, 'Android'), undefined);
|
||||
// Each later run pushes one more entry; history is capped.
|
||||
let body = joined;
|
||||
let body = androidDone;
|
||||
for (let run = 44; run < 52; run += 1) {
|
||||
const sha = run.toString(16).padStart(40, '0');
|
||||
body = platformSectionMerge(state({ links: viewerLinks({ repository: pullRequest.repository, headSha: sha, runId: String(run), runAttempt: '1', configPath: '.expo-explore/config.yaml' }),
|
||||
@@ -414,13 +451,112 @@ test('a newer run moves the current run into Previous runs; a run the PR moved p
|
||||
assert.deepEqual(history.map(entry => entry.runId), ['50', '49', '48', '47', '46']);
|
||||
assert.match(body, /<summary>Previous runs \(5\)<\/summary>/);
|
||||
assert.ok(body.length < PUBLIC_COMMENT_BODY_BUDGET);
|
||||
assert.doesNotMatch(body, /expo-explore-previous|New run in progress/);
|
||||
// A state marked superseded by its own writer goes straight to history even when the comment has nothing newer yet.
|
||||
const superseded = platformSectionMerge(state({ artifactOnly: true, superseded: true }), 'ios').merge(undefined);
|
||||
assert.match(superseded, /The pull request moved while this run worked; its report is kept here until the current run replaces it\./);
|
||||
assert.match(superseded, /^### Explore review\n\nThe pull request moved while this run worked; its report is kept here until the current run replaces it\./m);
|
||||
const replaced = platformSectionMerge(nextState(), 'ios').merge(superseded);
|
||||
assert.equal(titleOf(replaced), '### Explore review · capturing');
|
||||
assert.match(replaced, /Previous runs \(1\)/);
|
||||
});
|
||||
|
||||
test('the review a new run keeps up comes from one run: a target the last run never finished does not bring back an older run', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const androidOf = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' }, ...overrides });
|
||||
const run = (runId, head, artifact) => ({ pullRequest: { ...pullRequest, head: { ref: 'feature', sha: head } },
|
||||
links: viewerLinks({ ...(artifact ? { artifactUrl: `https://github.com/expo/explore-playground/actions/runs/${runId}/artifacts/${artifact}` } : {}),
|
||||
repository: pullRequest.repository, headSha: head, runId, runAttempt: '1', configPath: '.expo-explore/config.yaml' }) });
|
||||
const working = { phase: 'capturing', review: undefined, evidence: undefined };
|
||||
const [c, d] = ['c'.repeat(40), 'd'.repeat(40)];
|
||||
let body = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
|
||||
body = platformSectionMerge(androidOf({}), 'android').merge(body);
|
||||
// Run 43 finishes Android only; its iOS job never reports (cancelled).
|
||||
body = platformSectionMerge(state({ ...working, ...run('43', c) }), 'ios').merge(body);
|
||||
body = platformSectionMerge(androidOf({ ...run('43', c, '7800'), review: review([evidenceReview().surfaces[2]]) }), 'android').merge(body);
|
||||
body = platformSectionMerge(state({ ...working, ...run('44', d) }), 'ios').merge(body);
|
||||
const previous = readCommentRecords(body).previous;
|
||||
assert.deepEqual(Object.keys(previous), ['android']);
|
||||
assert.equal(previous.android.runId, '43');
|
||||
assert.match(subtitleOf(body), /^<sub>\[Android\]\(<[^>]+artifact=7800>\) · \[cccccccc\]/);
|
||||
assert.equal(titleOf(body), '### 1 screen changed · [Review in Explore](<https://explore-preview.expo.app/?repo=expo%2Fexplore-playground&run=43&attempt=1&artifact=7800>)');
|
||||
assert.doesNotMatch(visible(body).split('<details>')[0], /artifact=7654/, 'run 42 is only under Previous runs');
|
||||
});
|
||||
|
||||
test('a new run\'s failure does not replace the previous review: it is named on the new-run line until a target is ready', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const androidOf = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' }, ...overrides });
|
||||
const both = platformSectionMerge(androidOf({}), 'android').merge(platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined));
|
||||
const nextHead = 'd'.repeat(40);
|
||||
const next = { pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) };
|
||||
const commit = `[dddddddd](<https://github.com/expo/explore-playground/commit/${nextHead}>)`;
|
||||
const run43 = '[run](<https://github.com/expo/explore-playground/actions/runs/43/attempts/1>) · [evidence](<https://github.com/expo/explore-playground/actions/runs/43#artifacts>)';
|
||||
const failure = { phase: 'failed', review: undefined, evidence: undefined, failure: { step: 'capture-head', message: 'boom' } };
|
||||
// Android fails before iOS posts anything.
|
||||
const failed = platformSectionMerge(androidOf({ ...next, ...failure }), 'android').merge(both);
|
||||
assert.equal(visible(failed).split('\n')[1], `> **New run failed** for ${commit} · **Android failed** · capture\\-head · boom · ${run43}`);
|
||||
assert.equal(titleOf(failed), titleOf(both));
|
||||
assert.deepEqual(listOf(failed), listOf(both));
|
||||
assert.deepEqual(Object.keys(readCommentRecords(failed).previous), ['ios', 'android']);
|
||||
const working = platformSectionMerge(state({ ...next, phase: 'capturing', review: undefined, evidence: undefined, capture: undefined }), 'ios').merge(failed);
|
||||
assert.equal(visible(working).split('\n')[1], `> **New run in progress** for ${commit} · capturing on iOS · **Android failed** · capture\\-head · boom · ${run43}`);
|
||||
assert.deepEqual(listOf(working), listOf(both));
|
||||
// iOS is ready: its review takes over, and Android's failure is its own line.
|
||||
const ready = platformSectionMerge(state({ ...next, artifactOnly: true }), 'ios').merge(working);
|
||||
assert.doesNotMatch(ready, /New run|expo-explore-previous/);
|
||||
assert.match(statusOf(ready, 'Android'), /^\*\*Android failed\*\* · capture\\-head · boom · /);
|
||||
// A single target that failed keeps the review before it, and the run after it still has that review to keep.
|
||||
const single = platformSectionMerge(state({ ...next, ...failure }), 'ios').merge(platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined));
|
||||
assert.equal(visible(single).split('\n')[1], `> **New run failed** for ${commit} · capture\\-head · boom · ${run43}`);
|
||||
assert.match(titleOf(single), /^### 3 screens changed · /);
|
||||
const later = platformSectionMerge(state({ phase: 'capturing', review: undefined, evidence: undefined, capture: undefined,
|
||||
links: viewerLinks({ repository: pullRequest.repository, headSha: 'e'.repeat(40), runId: '44', runAttempt: '1', configPath: '.expo-explore/config.yaml' }),
|
||||
pullRequest: { ...pullRequest, head: { ref: 'feature', sha: 'e'.repeat(40) } } }), 'ios').merge(single);
|
||||
assert.equal(readCommentRecords(later).previous.ios.runId, '42');
|
||||
assert.match(titleOf(later), /^### 3 screens changed · /);
|
||||
});
|
||||
|
||||
test('a rerun keeps the attempt it replaces up until the new attempt finishes', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const ready = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
|
||||
const attempt3 = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '3', configPath: '.expo-explore/config.yaml' });
|
||||
const rerun = platformSectionMerge(state({ phase: 'capturing', review: undefined, evidence: undefined, links: attempt3 }), 'ios').merge(ready);
|
||||
assert.equal(visible(rerun).split('\n')[1], `> **New run in progress** for [bbbbbbbb](<https://github.com/expo/explore-playground/commit/${headSha}>) · capturing · [run](<https://github.com/expo/explore-playground/actions/runs/42/attempts/3>)`);
|
||||
assert.equal(titleOf(rerun), titleOf(ready));
|
||||
assert.deepEqual(listOf(rerun), listOf(ready));
|
||||
assert.equal(readCommentRecords(rerun).previous.ios.runAttempt, '2');
|
||||
// The same attempt writing again (capture progress, a republish) keeps nothing.
|
||||
assert.equal(readCommentRecords(platformSectionMerge(state({ phase: 'capturing', review: undefined, evidence: undefined }), 'ios').merge(ready)).previous, undefined);
|
||||
const done = platformSectionMerge(state({ artifactOnly: true, links: { ...attempt3, viewer: state().links.viewer } }), 'ios').merge(rerun);
|
||||
assert.equal(readCommentRecords(done).previous, undefined);
|
||||
assert.doesNotMatch(done, /New run in progress/);
|
||||
});
|
||||
|
||||
test('over budget, the previous run\'s records go before the hidden state is cut', async () => {
|
||||
const { readCommentRecords, renderCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const previous = platformRecordOf(state({ artifactOnly: true }));
|
||||
const nextHead = 'd'.repeat(40);
|
||||
const current = platformRecordOf(state({ phase: 'capturing', review: undefined, evidence: undefined, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }));
|
||||
const records = { current: { ios: current }, previous: { ios: previous }, history: [] };
|
||||
const full = renderCommentRecords(records);
|
||||
assert.match(full, /New run in progress/);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(full).previous), ['ios']);
|
||||
const without = renderCommentRecords({ current: { ios: current }, history: [] });
|
||||
assert.equal(renderCommentRecords(records, undefined, without.length + 10), without);
|
||||
// Once the new run shows a finished target, the previous records it still carries are hidden: they go before the list shrinks.
|
||||
const twelve = review(Array.from({ length: 12 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
|
||||
review: { status: 'modified', description: `Changed ${index} in a way that takes a sentence to describe for the budget check.` },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' } } })));
|
||||
const finished = platformRecordOf(state({ artifactOnly: true, review: twelve, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
links: viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/43/artifacts/7700', repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }));
|
||||
const android = { ...current, platform: 'android' };
|
||||
const hidden = { current: { ios: finished, android }, previous: { android: { ...previous, platform: 'android' } }, history: [] };
|
||||
const lean = renderCommentRecords({ ...hidden, previous: {} });
|
||||
assert.equal(renderCommentRecords(hidden, undefined, lean.length + 10), lean);
|
||||
assert.equal(listOf(lean).length, 11, 'ten screens and the link to the rest');
|
||||
});
|
||||
|
||||
test('the deployments line names every hosted preview the comment links right now, current and previous', async () => {
|
||||
const { platformSectionMerge, existingDeploymentMarker } = await import('../../dist/report/pr-comment-body.js');
|
||||
const marker = '<!-- expo-explore-deployments:acme-explore--abc123 -->';
|
||||
@@ -437,24 +573,28 @@ test('the deployments line names every hosted preview the comment links right no
|
||||
const next = state({ links: { ...viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }),
|
||||
preview: previewLinks('https://acme-explore--def456.expo.app/p/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', Date.now() + 86_400_000) }, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } } });
|
||||
assert.equal(platformSectionMerge(next, 'ios').merge(single).split('\n')[1], '<!-- expo-explore-deployments:acme-explore--abc123,acme-explore--def456 -->');
|
||||
// While the new run works the previous run's preview is still the one on show.
|
||||
const working = platformSectionMerge({ ...next, phase: 'capturing', review: undefined, evidence: undefined, links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }, 'ios').merge(single);
|
||||
assert.equal(working.split('\n')[1], marker);
|
||||
assert.equal(existingDeploymentMarker(`${CI_COMMENT_MARKER}\n<!-- expo-explore-deployments:Bad Host -->\nx`), undefined);
|
||||
});
|
||||
|
||||
test('a report whose hosted preview is still deploying says so instead of linking the central Viewer', () => {
|
||||
const deploying = renderPublicComment(state({ links: { ...state().links, deploying: true }, artifactOnly: true }));
|
||||
assert.match(deploying, /^### Explore review · report deploying, not ready yet$/m, 'the heading says the report is not ready');
|
||||
assert.equal(titleOf(deploying), '### 3 screens changed · report deploying…', 'the heading says the report is not ready');
|
||||
assert.ok(!deploying.includes('explore-preview.expo.app'), 'no download-and-drop Viewer link while the hosted report is on its way');
|
||||
assert.match(deploying, /\| deploying… \|/, 'the Report cell says so');
|
||||
assert.match(deploying, /· Workflow \[run\]\(<[^>]+>\) · \[zip\]\(<[^>]+>\)$/, 'the footer keeps the zip and run');
|
||||
assert.match(subtitleOf(deploying), /^<sub>iOS · \[bbbbbbbb\]/, 'nothing to link the platform to yet');
|
||||
assert.match(deploying, /\n- Added `\/cats\/care-guide`\n/);
|
||||
assert.equal(deploying.split('\n').at(-1), `<sub>${workflowRun} · ${configLink}</sub>`);
|
||||
const deployed = renderPublicComment(state({ links: { ...state().links, deploying: true,
|
||||
preview: previewLinks('https://acme-explore--1lcbdcpwn3.expo.app/p/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', null) } }));
|
||||
assert.match(deployed, /^### Explore review · \[Open report\]\(<https:\/\/acme-explore--1lcbdcpwn3\.expo\.app[^>]*>\)$/m, 'once deployed the hosted report is the heading');
|
||||
assert.match(titleOf(deployed), /^### 3 screens changed · \[Review in Explore\]\(<https:\/\/acme-explore--1lcbdcpwn3\.expo\.app[^>]*>\)$/, 'once deployed the hosted report is the heading');
|
||||
const record = JSON.parse(JSON.stringify(platformRecordOf(state({ links: { ...state().links, deploying: true }, artifactOnly: true }))));
|
||||
assert.equal(record.links.report, undefined, 'the record carries no report link while deploying');
|
||||
assert.equal(parsePlatformRecord(record).links.deploying, true, 'the deploying flag survives the comment round trip');
|
||||
});
|
||||
|
||||
test('a screen whose screenshots match but whose accessibility tree changed is listed as accessibility only, apart from the visual changes', () => {
|
||||
test('a screen whose screenshots match but whose accessibility tree changed is listed after the visual changes, tagged accessibility only', () => {
|
||||
const accessibilityOnly = (id) => surface(id, 'modified', { extra: {
|
||||
review: { status: 'modified', description: 'Added button “Edit tempo”.', facts: [
|
||||
{ category: 'element', templateId: 'element.added', bullet: 'Added button “Edit tempo”.' },
|
||||
@@ -465,27 +605,28 @@ test('a screen whose screenshots match but whose accessibility tree changed is l
|
||||
} });
|
||||
const withAccessibility = review([...evidenceReview().surfaces, accessibilityOnly('device-picker'), accessibilityOnly('enable-midi')]);
|
||||
const body = renderPublicComment(state({ review: withAccessibility, artifactOnly: true }));
|
||||
assert.match(platformRow(body, 'iOS'), /\| 🟩 3 visual changes · 2 accessibility only · 6m 12s \|/);
|
||||
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)', '🟦 Accessibility only (2)', 'Validation · iOS 🟩 10/10 captured']);
|
||||
assert.match(body, /\n\*\*Changes\*\* · 5 screens\n/);
|
||||
assert.match(body, /<summary>🟦 Accessibility only \(2\)<\/summary>\n\nBefore and After look the same\. What screen readers and voice control read changed\.\n\n- `\/device-picker` — Added button “Edit tempo”\\\. · \[iOS\]/);
|
||||
assert.match(titleOf(body), /^### 5 screens changed · /);
|
||||
assert.deepEqual(listOf(body).slice(3), [
|
||||
`- [\`/device-picker\`](<${reportUrl}&view=compare&screen=device-picker>) · Added button “Edit tempo” · accessibility only`,
|
||||
`- [\`/enable-midi\`](<${reportUrl}&view=compare&screen=enable-midi>) · Added button “Edit tempo” · accessibility only`]);
|
||||
assert.doesNotMatch(body, /Before and After look the same/);
|
||||
const record = parsePlatformRecord(JSON.parse(JSON.stringify(platformRecordOf(state({ review: withAccessibility, artifactOnly: true })))));
|
||||
assert.deepEqual(record.changes.filter(change => change.group === 'accessibility-only').map(change => change.id), ['device-picker', 'enable-midi'],
|
||||
'the group survives the comment round trip');
|
||||
// A comment with no accessibility-only screen keeps its plain count.
|
||||
assert.match(platformRow(renderPublicComment(state({ artifactOnly: true })), 'iOS'), /\| 🟩 3 changes · 6m 12s \|/);
|
||||
});
|
||||
|
||||
test('a comment whose only changes are for assistive technology counts just those', () => {
|
||||
test('a comment whose only change is for assistive technology counts it like any other', () => {
|
||||
const only = review([surface('device-picker', 'modified', { extra: {
|
||||
review: { status: 'modified', description: 'Changed “Play” from a text to a button.', facts: [{ category: 'accessibility', templateId: 'accessibility.role-changed', bullet: 'Changed “Play” from a text to a button.' }] },
|
||||
visual: { verdict: 'unchanged', reason: 'matched', mismatchPercentage: 0, threshold: 0.1, tool: '[email protected]' },
|
||||
sourceChange: sourceChange('Made Play a button.'),
|
||||
} })]);
|
||||
assert.match(platformRow(renderPublicComment(state({ review: only, artifactOnly: true })), 'iOS'), /\| 🟩 1 accessibility only · 6m 12s \|/);
|
||||
const body = renderPublicComment(state({ review: only, artifactOnly: true }));
|
||||
assert.match(titleOf(body), /^### 1 screen changed · /);
|
||||
assert.deepEqual(listOf(body), [`- [\`/device-picker\`](<${reportUrl}&view=compare&screen=device-picker>) · Changed “Play” from a text to a button · accessibility only`]);
|
||||
});
|
||||
|
||||
test('a screen accessibility-only on iOS and visibly modified on Android is listed as Modified, whichever platform comes first', async () => {
|
||||
test('a screen accessibility-only on iOS and visibly modified on Android is listed as the visible change, whichever platform comes first', async () => {
|
||||
const { platformSectionMerge } = await import('../../dist/report/pr-comment-body.js');
|
||||
const settings = (verdict) => {
|
||||
const changed = evidenceReview();
|
||||
@@ -494,25 +635,28 @@ test('a screen accessibility-only on iOS and visibly modified on Android is list
|
||||
};
|
||||
const androidState = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' },
|
||||
runtime: { ...state().runtime, platform: 'android', deviceModel: 'EasAndroidDevice01', osVersion: '15.0' }, ...overrides });
|
||||
const androidLinks = viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/42/artifacts/7700', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath: '.expo-explore/config.yaml' });
|
||||
const ios = renderPublicComment(state({ review: settings('unchanged'), artifactOnly: true }));
|
||||
assert.ok(summaries(ios).includes('🟦 Accessibility only (1)'), 'iOS alone: the screenshots match');
|
||||
const both = platformSectionMerge(androidState({ review: settings('modified') }), 'android').merge(ios);
|
||||
assert.deepEqual(summaries(both).slice(0, 3), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (1)']);
|
||||
assert.doesNotMatch(both, /Accessibility only \(|Before and After look the same/);
|
||||
assert.match(both, /\n- `\/settings` — [^\n]+ · \[iOS \(accessibility only\)\]\(<[^>]+>\) · \[Android\]\(<[^>]+>\)\n/);
|
||||
assert.match(ios, /\n- \[`\/settings`\]\(<[^>]+>\) · [^\n]+ · accessibility only\n/, 'iOS alone: the screenshots match');
|
||||
const both = platformSectionMerge(androidState({ review: settings('modified'), links: androidLinks }), 'android').merge(ios);
|
||||
assert.match(both, /\n- \[`\/settings`\]\(<[^>]+artifact=7700&view=compare&screen=settings>\) · Changed button title from “Share” to “Share Example”\n/, 'the link opens Android, where it changed visibly');
|
||||
assert.doesNotMatch(both, /accessibility only/);
|
||||
const androidFirst = platformSectionMerge(state({ review: settings('unchanged'), artifactOnly: true }), 'ios')
|
||||
.merge(platformSectionMerge(androidState({ review: settings('modified'), links: androidLinks }), 'android').merge(undefined));
|
||||
assert.match(androidFirst, /\n- \[`\/settings`\]\(<[^>]+artifact=7700&view=compare&screen=settings>\) · Changed button title from “Share” to “Share Example”\n/);
|
||||
});
|
||||
|
||||
test('screens whose comparison did not run are counted as not compared, never as a green "no change"', () => {
|
||||
const uncompared = review([surface('settings', 'modified'), surface('tempo', 'modified')]);
|
||||
const body = renderPublicComment(state({ review: uncompared, artifactOnly: true }));
|
||||
assert.match(platformRow(body, 'iOS'), /\| 🟨 0 changes · 2 not compared · 6m 12s \|/);
|
||||
assert.match(body, /\nNo compared screen changed on the reviewed platforms\.\n/);
|
||||
assert.equal(titleOf(body), `### No compared screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
assert.equal(statusOf(body, 'iOS'), `iOS · 2 not compared · ${runLink}`);
|
||||
// A screen that was never captured (outside the capture scope) stays out of the count.
|
||||
const outOfScope = surface('channel', 'modified');
|
||||
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete outOfScope[key];
|
||||
const quiet = renderPublicComment(state({ review: review([outOfScope]), artifactOnly: true, evidence: undefined, capture: { planned: { base: 0, head: 0 }, done: { base: 0, head: 0 }, baseFromCache: false } }));
|
||||
assert.match(platformRow(quiet, 'iOS'), /\| 🟩 0 changes · 6m 12s \|/);
|
||||
assert.match(quiet, /\nNo screen changed on the reviewed platforms\.\n/);
|
||||
assert.equal(titleOf(quiet), `### No screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
assert.equal(statusOf(quiet, 'iOS'), undefined);
|
||||
});
|
||||
|
||||
const duoTargets = [{ id: 'iphone', platform: 'ios', label: 'iPhone 17' }, { id: 'duo-closed', platform: 'ios', label: 'iPhone Duo (closed)' },
|
||||
@@ -535,7 +679,7 @@ test('a config without targets writes the same records and comment as before tar
|
||||
assert.deepEqual(Object.keys(readCommentRecords(after).current), ['ios', 'android']);
|
||||
});
|
||||
|
||||
test('several targets share a comment: one row each in config order, labelled by target, keyed by id in the records and history', async () => {
|
||||
test('several targets share a comment: named in config order in the subtitle, each linking its report, keyed by id in the records and history', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const [iphone, closed, open, android] = duoTargets;
|
||||
// Report jobs finish in any order; the comment follows config order.
|
||||
@@ -548,19 +692,19 @@ test('several targets share a comment: one row each in config order, labelled by
|
||||
assert.deepEqual(Object.keys(records).sort(), ['android', 'duo-closed', 'duo-open', 'iphone']);
|
||||
assert.deepEqual([records['duo-open'].platform, records['duo-open'].target, records['duo-open'].label, records['duo-open'].order], ['ios', 'duo-open', 'iPhone Duo (open)', 2]);
|
||||
assert.deepEqual([records.android.platform, records.android.target, records.android.label, records.android.order], ['android', undefined, 'Pixel 7', 3]);
|
||||
const lines = body.split('\n'), header = lines.indexOf('| | Device | Result | Report |');
|
||||
assert.deepEqual(lines.slice(header + 2, lines.indexOf('', header)).map(line => line.split(' | ')[0]),
|
||||
['| iPhone 17', '| iPhone Duo \\(closed\\)', '| iPhone Duo \\(open\\)', '| Pixel 7']);
|
||||
assert.match(body, /^### Explore review · \[iPhone 17 report\]\(<[^>]+>\) · \[iPhone Duo \\\(open\\\) report\]\(<[^>]+>\) · \[Pixel 7 report\]\(<[^>]+>\)$/m);
|
||||
assert.match(body, /\*\*Changes\*\* · 3 screens · a screen is listed once, with a link per device\n/);
|
||||
assert.match(body, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iPhone 17\]\(<[^>]+>\) · \[iPhone Duo \\\(open\\\)\]\(<[^>]+>\) · \[Pixel 7\]\(<[^>]+>\)\n/);
|
||||
assert.match(body, /\| Check \| iPhone 17 \| iPhone Duo \\\(closed\\\) \| iPhone Duo \\\(open\\\) \| Pixel 7 \|\n\|---\|---\|---\|---\|---\|/);
|
||||
assert.deepEqual(summaries(body).at(-1), 'Validation · iPhone 17 🟩 6/6 captured · iPhone Duo \\(closed\\) ⏳ in progress · iPhone Duo \\(open\\) 🟩 6/6 captured · Pixel 7 🟩 6/6 captured');
|
||||
// A newer run moves them all into history, still labelled and ordered by target.
|
||||
assert.equal(titleOf(body), `### 3 screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
assert.equal(subtitleOf(body), `<sub>[iPhone 17](<${reportUrl}>) · iPhone Duo \\(closed\\) · [iPhone Duo \\(open\\)](<${reportUrl}>) · [Pixel 7](<${reportUrl}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
|
||||
assert.equal(statusOf(body, 'iPhone Duo \\(closed\\)'), `iPhone Duo \\(closed\\) · capturing head 1/3 · ${runLink}`);
|
||||
assert.equal(listOf(body).length, 3);
|
||||
assert.doesNotMatch(body, / only\n|not on /);
|
||||
// A newer run moves them all into history, still labelled and ordered by target, and keeps their review up while it works.
|
||||
const nextHead = 'd'.repeat(40);
|
||||
const next = platformSectionMerge(targetState(open, { phase: 'capturing', review: undefined, evidence: undefined, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }), 'duo-open').merge(body);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).current), ['duo-open']);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).previous).sort(), ['android', 'duo-open', 'iphone'], 'the target still capturing had nothing to keep');
|
||||
assert.match(visible(next).split('\n')[1], /^> \*\*New run in progress\*\* for \[dddddddd\]\(<[^>]+>\) · capturing on iPhone Duo \\\(open\\\) · \[run\]/);
|
||||
assert.equal(subtitleOf(next), `<sub>[iPhone 17](<${reportUrl}>) · [iPhone Duo \\(open\\)](<${reportUrl}>) · [Pixel 7](<${reportUrl}>) · ${commits} · updated Sep 11, 3:07 AM UTC</sub>`);
|
||||
const history = readCommentRecords(next).history;
|
||||
assert.deepEqual(Object.keys(history[0].platforms).sort(), ['android', 'duo-closed', 'duo-open', 'iphone']);
|
||||
assert.match(next, /\n- \[bbbbbbbb\]\(<[^>]+>\) · iPhone 17 🟩 3 changes \(.*?\) · iPhone Duo \\\(closed\\\) ⏳ did not finish \(.*?\) · iPhone Duo \\\(open\\\) 🟩 3 changes \(.*?\) · Pixel 7 🟩 3 changes /);
|
||||
@@ -587,6 +731,8 @@ test('a comment written by a per-platform version keeps parsing, and malformed t
|
||||
assert.deepEqual(parse(line('duo-open', { ...valid, order: 8 })), []);
|
||||
const many = Array.from({ length: 10 }, (_, index) => line(`t${index}`, { ...valid, target: `t${index}` }));
|
||||
assert.equal(parse(...many).length, 8, 'a comment holds at most one record per configurable target');
|
||||
const previous = readCommentRecords([CI_COMMENT_MARKER, line('duo-open', valid), `<!-- expo-explore-previous:iphone:${encodeRecordPayload({ ...valid, target: 'iphone' })} -->`, '<!-- expo-explore-previous:iphone:AAAA -->'].join('\n')).previous;
|
||||
assert.deepEqual(Object.keys(previous), ['iphone'], 'previous records parse the same way');
|
||||
});
|
||||
|
||||
test('with report.comment.map, the map draws the added, removed and visually changed screens, the screens one step before them, and tabs as a group', async () => {
|
||||
@@ -604,13 +750,13 @@ test('with report.comment.map, the map draws the added, removed and visually cha
|
||||
assert.ok(!/<summary>Map/.test(renderPublicComment(state({ artifactOnly: true, review: withNavigation }))));
|
||||
assert.equal(platformRecordOf(state({ review: withNavigation })).navigation, undefined);
|
||||
const body = renderPublicComment(state({ artifactOnly: true, map: true, review: withNavigation }));
|
||||
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (2)', 'Map (4 screens)', 'Validation · iOS 🟩 8/8 captured']);
|
||||
assert.deepEqual(summaries(body), ['Map (4 screens)']);
|
||||
const map = body.slice(body.indexOf('```mermaid'), body.indexOf('```\n', body.indexOf('```mermaid')) + 3);
|
||||
assert.equal(map, ['```mermaid', 'flowchart LR', ' subgraph tabs["Tabs"]', ' n0["/cats"]', ' n3["/settings"]', ' end',
|
||||
' n1["/cats/care-guide"]', ' n2["/cats/sweet-bee"]', ' n0 -->|push| n1', ' n0 -.->|push| n2',
|
||||
' classDef added stroke:#1a7f37,stroke-width:3px', ' class n1 added', ' classDef modified stroke:#bc4c00,stroke-width:3px', ' class n3 modified',
|
||||
' classDef removed stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 4', ' class n2 removed', '```'].join('\n'));
|
||||
assert.ok(body.indexOf('<summary>🟧 Modified') < body.indexOf('<summary>Map') && body.indexOf('<summary>Map') < body.indexOf('<summary>Validation'));
|
||||
assert.ok(body.indexOf('\n- [`/settings`]') < body.indexOf('<summary>Map'), 'the map follows the list');
|
||||
assert.match(body, /<summary>Map \(4 screens\)<\/summary>\n\n```mermaid\n/, 'a blank line opens the fence inside the collapsible');
|
||||
assert.deepEqual(readCommentRecords(body).current.ios.navigation, platformRecordOf(state({ map: true, review: withNavigation })).navigation, 'the map is carried in the record');
|
||||
|
||||
@@ -624,7 +770,7 @@ test('with report.comment.map, the map draws the added, removed and visually cha
|
||||
assert.ok(!/<summary>Map/.test(renderPublicComment(state({ map: true, review: unchanged }))));
|
||||
});
|
||||
|
||||
test('the map is dropped before the change lists shrink, and a malformed map is dropped from the record', async () => {
|
||||
test('the map is dropped before the list shrinks, and a malformed map is dropped from the record', async () => {
|
||||
const { encodeRecordPayload } = await import('../../dist/report/pr-comment-record.js');
|
||||
const { readCommentRecords, renderCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const record = { ...platformRecordOf(state()), navigation: { nodes: [{ route: '/a', group: 'modified' }, { route: '/b' }], edges: [{ from: 1, to: 0, kinds: ['push'] }] } };
|
||||
@@ -632,7 +778,7 @@ test('the map is dropped before the change lists shrink, and a malformed map is
|
||||
assert.match(renderCommentRecords(records), /<summary>Map \(2 screens\)<\/summary>/);
|
||||
const tight = renderCommentRecords(records, undefined, renderCommentRecords(records).length - 1);
|
||||
assert.ok(!tight.includes('```mermaid'));
|
||||
assert.match(tight, /<summary>🟧 Modified \(1\)<\/summary>/);
|
||||
assert.equal(listOf(tight).length, 3, 'the list is intact');
|
||||
const parse = navigation => readCommentRecords(`<!-- expo-explore-record:ios:${encodeRecordPayload({ ...record, navigation })} -->`).current.ios;
|
||||
assert.deepEqual(parse(record.navigation).navigation, record.navigation);
|
||||
for (const navigation of [{ ...record.navigation, edges: [{ from: 0, to: 2, kinds: ['push'] }] }, { ...record.navigation, edges: [{ from: 0, to: 1, kinds: ['teleport'] }] },
|
||||
@@ -642,3 +788,11 @@ test('the map is dropped before the change lists shrink, and a malformed map is
|
||||
assert.equal(parsed.navigation, undefined);
|
||||
}
|
||||
});
|
||||
|
||||
test('an excluded route is neither listed nor counted as an app-wide screen', () => {
|
||||
const excluded = surface('channel', 'modified', { extra: { sourceScope: 'app-wide', excluded: true,
|
||||
sourceChange: { ...sourceChange('Dependency update.', 'global'), files: [{ path: 'package.json', status: 'modified', relation: 'global', hunks: [], facts: [], truncated: false }] } } });
|
||||
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete excluded[key];
|
||||
const body = renderPublicComment(state({ review: review([...evidenceReview().surfaces, excluded]) }));
|
||||
assert.doesNotMatch(body, /\/channel|App-wide source changes|not compared/);
|
||||
});
|
||||
@@ -3,10 +3,11 @@ import { chmod, mkdtemp, mkdir, rm, symlink, writeFile } from "node:fs/promises"
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
import { PNG as PngImage } from "pngjs";
|
||||
|
||||
import { assessPublicEvidence, presenceDescription, ignoreStatusBar, ignoreSystemBands, readExportedMap } from "../../dist/review/evidence-assessment.js";
|
||||
import { assessPublicEvidence, decideReview, presenceDescription, ignoreStatusBar, ignoreSystemBands, ignoreSystemRegions, readExportedMap } from "../../dist/review/evidence-assessment.js";
|
||||
import { STATUS_BAR_BAND_PERCENT } from "../../dist/shared/png-evidence.js";
|
||||
import { homeIndicatorBandPercent, statusBarBandPercent } from "../../dist/contracts/capture.js";
|
||||
import { homeIndicatorBandPercent, statusBarBandPercent, systemRegions } from "../../dist/contracts/capture.js";
|
||||
import { AGENT_DEVICE_VERSION } from "../../dist/capture/run.js";
|
||||
|
||||
const BASE_SHA = "a".repeat(40);
|
||||
@@ -419,6 +420,33 @@ test("status-bar glyph differences never count as an app change", async (t) => {
|
||||
const android = ignoreSystemBands({ ...statusBarOnly, differentPixels: 140, regions: [indicator] }, { top: statusBarBandPercent("android"), bottom: homeIndicatorBandPercent("android") });
|
||||
assert.deepEqual([android.ignoredTop, android.ignoredBottom, android.measurement.match], [0, 0, false]);
|
||||
|
||||
// A region that crosses the band's edge is clipped to its pixels below the band, read from the frames themselves:
|
||||
// in a 100x874 frame the iOS band is 56 rows, so a glyph drawn over rows 50-59 keeps only its 4 rows below. The
|
||||
// band still counts as ignored, so the Viewer marks the pixels left out of the comparison.
|
||||
const frame = (paint) => { const png = new PngImage({ width: 100, height: 874 }); png.data.fill(255); paint?.(png); return png; };
|
||||
const paintRows = (from, to) => (png) => { for (let y = from; y < to; y += 1) for (let x = 10; x < 20; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
|
||||
const frames = (to) => () => ({ baseline: frame(), current: frame(paintRows(50, to)), distance: 0.1 * Math.sqrt(3 * 255 ** 2) });
|
||||
const straddling = (height, pixels) => ({ index: 0, rect: { x: 10, y: 50, width: 10, height }, normalizedRect: { x: 10, y: 5.72, width: 10, height: (height / 874) * 100 }, differentPixels: pixels, shareOfDiffPercentage: 100, densityPercentage: 100, shape: "block", size: "small", location: "top-left", dominantChange: "darker" });
|
||||
const whole = { ...statusBarOnly, totalPixels: 87400, differentPixels: 100, mismatchPercentage: 0.11, regions: [straddling(10, 100)] };
|
||||
const clipped = ignoreSystemBands(whole, { top: statusBarBandPercent("ios"), bottom: 0 }, frames(60));
|
||||
assert.deepEqual([clipped.ignoredTop, clipped.measurement.match, clipped.measurement.differentPixels, clipped.measurement.mismatchPercentage], [1, false, 40, 0.05]);
|
||||
assert.deepEqual(clipped.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels, entry.shareOfDiffPercentage]), [[56, 4, 40, 100]]);
|
||||
assert.equal(clipped.measurement.regions[0].normalizedRect.y, 6.41);
|
||||
const glyph = ignoreSystemBands({ ...whole, differentPixels: 60, regions: [straddling(7, 60)] }, { top: statusBarBandPercent("ios"), bottom: 0 }, frames(56));
|
||||
assert.deepEqual([glyph.ignoredTop, glyph.measurement.match, glyph.measurement.regions], [1, true, []]);
|
||||
// agent-device's regions can overlap: a clock merged with a header line below the band has a rect that also holds the
|
||||
// battery, a region of its own. The header line is still what the merged region keeps, not cancelled by the battery.
|
||||
const paintRects = (...rects) => (png) => { for (const [x0, y0, w, h] of rects) for (let y = y0; y < y0 + h; y += 1) for (let x = x0; x < x0 + w; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
|
||||
const overlapFrames = () => ({ baseline: frame(), current: frame(paintRects([10, 40, 10, 10], [70, 40, 20, 10], [0, 60, 100, 1])), distance: 0.1 * Math.sqrt(3 * 255 ** 2) });
|
||||
const merged = { ...straddling(21, 200), rect: { x: 0, y: 40, width: 100, height: 21 }, normalizedRect: { x: 0, y: 4.58, width: 100, height: 2.4 } };
|
||||
const battery = { ...straddling(10, 200), index: 1, rect: { x: 70, y: 40, width: 20, height: 10 }, normalizedRect: { x: 70, y: 4.58, width: 20, height: 1.14 } };
|
||||
const overlapping = ignoreSystemBands({ ...whole, differentPixels: 400, regions: [merged, battery] }, { top: statusBarBandPercent("ios"), bottom: 0 }, overlapFrames);
|
||||
assert.deepEqual([overlapping.ignoredTop, overlapping.measurement.match, overlapping.measurement.differentPixels], [2, false, 100]);
|
||||
assert.deepEqual(overlapping.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels]), [[56, 5, 100]]);
|
||||
const unreadable = ignoreSystemBands(whole, { top: statusBarBandPercent("ios"), bottom: 0 }, () => undefined);
|
||||
assert.deepEqual([unreadable.ignoredTop, unreadable.measurement.differentPixels], [0, 100]);
|
||||
assert.equal(statusBarBandPercent("android"), 7, "Android 15 status glyphs on a 720x1600 emulator reach 6.4 %");
|
||||
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-public-evidence-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const base = await side(root, "base", manifests.base);
|
||||
const head = await side(root, "head", manifests.head);
|
||||
@@ -497,3 +525,119 @@ test("a presence verdict for a long route (an encoded share link) stays within t
|
||||
}
|
||||
assert.equal(presenceDescription("Added ", "/home", " screen."), "Added /home screen.");
|
||||
});
|
||||
|
||||
test("unstable text never makes a screen Modified, and names a variant's runtime state", () => {
|
||||
const unstable = { category: "visible-text", templateId: "visible-text.unstable-within-build", bullet: 'Text varies between captures of the same build: "2m" / "4m" / "3m".' };
|
||||
const summary = (facts) => ({ facts, needsReview: false, reviewIssues: [] });
|
||||
const unchanged = { verdict: "unchanged", reason: "matched", mismatchPercentage: 0, threshold: 0.1, tool: "t" };
|
||||
const modified = { ...unchanged, verdict: "modified", reason: "repeated-cross-build-delta", mismatchPercentage: 0.4, regions: [{ location: "center" }] };
|
||||
assert.deepEqual(decideReview("screen", unchanged, summary([unstable])), { status: "unchanged", description: "No visible change" });
|
||||
const pixels = decideReview("screen", modified, summary([unstable]));
|
||||
assert.deepEqual([pixels.status, pixels.description, pixels.facts.length], ["modified", "Visual change · 0.4% · center", 1]);
|
||||
const real = decideReview("screen", modified, summary([{ category: "accessibility", templateId: "accessibility.label-changed", bullet: 'Changed accessibility label from "Submit" to "Save".' }, unstable]));
|
||||
assert.equal(real.description, 'Changed accessibility label from "Submit" to "Save".');
|
||||
assert.equal(decideReview("none", modified, summary([unstable])).description, 'Runtime state differs: Text varies between captures of the same build: "2m" / "4m" / "3m".');
|
||||
// A variant is named by what else differs, ahead of the runtime text.
|
||||
const target = { category: "interaction", templateId: "interaction.target-changed", bullet: "Changed where “Open” leads." };
|
||||
assert.equal(decideReview("none", modified, summary([unstable, target])).description, "Runtime state differs: Changed where “Open” leads.");
|
||||
});
|
||||
|
||||
test("text that varies between both builds' own verified appearances is runtime state; an unverified one is no evidence", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-public-evidence-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const capture = async (unverifiedHeadDark) => {
|
||||
const base = await side(join(root, `${unverifiedHeadDark}`), "base", manifests.base);
|
||||
const head = await side(join(root, `${unverifiedHeadDark}`), "head", manifests.head);
|
||||
const labels = { base: ["edited 2m ago", "edited 3m ago"], head: ["edited 4m ago", "edited 5m ago"] };
|
||||
for (const [name, current] of [["base", base], ["head", head]]) {
|
||||
current.bundle.runtimeProfile = { deviceModel: "iPhone 17", osVersion: "26.0", locale: "en-US", orientation: "portrait", colorScheme: "light", colorSchemes: "light,dark" };
|
||||
await addDarkAppearance(current, manifests[name]);
|
||||
for (const [index, suffix] of ["", "@dark"].entries()) {
|
||||
const observation = current.map.observations.find((entry) => entry.id === `${name}-changed-observation${suffix}`);
|
||||
observation.elements[0].label = labels[name][index];
|
||||
}
|
||||
}
|
||||
if (unverifiedHeadDark) head.bundle.outcomes["changed@dark"] = { status: "captured", attempts: 1, landing: "unverified" };
|
||||
return assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure: measurer({}) });
|
||||
};
|
||||
const verified = await capture(false);
|
||||
assert.deepEqual(verified.surfaces.changed.review, { status: "unchanged", description: "No visible change" });
|
||||
assert.deepEqual(verified.surfaces["changed@dark"].review, { status: "unchanged", description: "No visible change" });
|
||||
// The head's dark capture may show another screen: the light label difference stays a change.
|
||||
const unverified = await capture(true);
|
||||
assert.equal(unverified.surfaces.changed.review.status, "modified");
|
||||
assert.deepEqual(unverified.surfaces.changed.review.facts.map((fact) => fact.templateId), ["accessibility.label-changed"]);
|
||||
});
|
||||
|
||||
test("a foldable's rail clock pill is left out of the verdict like a phone's status bar", () => {
|
||||
// Measured on EAS Simulator captures of an iPhone Duo (iOS 27.1): a 40×64 pt clock + Wi-Fi pill 28 pt from the right edge.
|
||||
const closed = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "closed" });
|
||||
const open = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "open" });
|
||||
assert.deepEqual(closed, [{ kind: "status-bar", x: 84.55, y: 12.24, width: 10.3, height: 10.62 }, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }]);
|
||||
assert.deepEqual(open[0], { kind: "status-bar", x: 92.43, y: 4.48, width: 5.05, height: 10.76 });
|
||||
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone Duo", pose: "half-open" })[0], open[0]);
|
||||
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone Duo" })[0], closed[0], "a foldable boots closed");
|
||||
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone 17" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 6.5 }, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }]);
|
||||
assert.deepEqual(systemRegions({ platform: "android" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 7 }]);
|
||||
|
||||
// Diff regions from a comment-only PR's report: the ticking clock on each panel, in that report's normalized rects.
|
||||
const region = (rect, location) => ({ index: 0, rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: rect, differentPixels: 400, shareOfDiffPercentage: 100, densityPercentage: 50, shape: "wide", size: "small", location, dominantChange: "brighter" });
|
||||
const closedClock = region({ x: 85.12, y: 12.78, width: 9.08, height: 1.77 }, "middle-right");
|
||||
const openClock = region({ x: 92.71, y: 5.08, width: 4.45, height: 1.79 }, "top-right");
|
||||
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 2843532, differentPixels: 400 * regions.length, mismatchPercentage: 0.01, match: false, regions });
|
||||
|
||||
const closedOnly = ignoreSystemRegions(measurement([closedClock]), closed);
|
||||
assert.equal(closedOnly.ignoredStatusBar, 1);
|
||||
assert.equal(closedOnly.measurement.match, true);
|
||||
assert.deepEqual(closedOnly.measurement.regions, []);
|
||||
assert.equal(ignoreSystemRegions(measurement([openClock]), open).measurement.match, true);
|
||||
// Each panel's pill is only ignored on that panel: the other pose's clock is app content there.
|
||||
assert.equal(ignoreSystemRegions(measurement([openClock]), closed).ignoredStatusBar, 0);
|
||||
assert.equal(ignoreSystemRegions(measurement([closedClock]), open).ignoredStatusBar, 0);
|
||||
// The phone's top band never reached the closed panel's pill, and the open clock's bottom edge (6.9%) crossed it.
|
||||
assert.equal(ignoreSystemBands(measurement([closedClock, openClock]), { top: 6.5, bottom: 0 }).ignoredTop, 0);
|
||||
// The app's own rail control just below the pill is kept whole, as is a region that straddles the pill's edge.
|
||||
const railButton = region({ x: 85.4, y: 25.2, width: 8.6, height: 7.4 }, "middle-right");
|
||||
const straddling = region({ x: 83, y: 12.78, width: 11.2, height: 1.77 }, "middle-right");
|
||||
const mixed = ignoreSystemRegions(measurement([closedClock, railButton, straddling]), closed);
|
||||
assert.equal(mixed.ignoredStatusBar, 1);
|
||||
// What is kept shares the remaining difference between them.
|
||||
assert.deepEqual(mixed.measurement.regions, [railButton, straddling].map((kept) => ({ ...kept, shareOfDiffPercentage: 50 })));
|
||||
assert.equal(mixed.measurement.differentPixels, 800);
|
||||
assert.equal(mixed.measurement.match, false);
|
||||
// A region inside the home indicator counts under its own kind.
|
||||
const indicator = region({ x: 40, y: 97.5, width: 20, height: 1 }, "bottom-center");
|
||||
const both = ignoreSystemRegions(measurement([closedClock, indicator]), closed);
|
||||
assert.deepEqual([both.ignoredStatusBar, both.ignoredHomeIndicator, both.measurement.match], [1, 1, true]);
|
||||
});
|
||||
|
||||
test("only an iPhone foldable gets the rail pill, and a region reaching the right edge stays inside a band", () => {
|
||||
// An Android device whose name matches keeps its own top band; the iPhone Duo's rail is not on its screen.
|
||||
assert.deepEqual(systemRegions({ platform: "android", device: "Surface Duo", pose: "open" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 7 }]);
|
||||
|
||||
// agent-device rounds x and width to 0.01% each, so a region that ends at the right edge can read as ending at 100.01%.
|
||||
const region = (rect) => ({ index: 0, rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: rect, differentPixels: 400, shareOfDiffPercentage: 100, densityPercentage: 50, shape: "wide", size: "small", location: "top-right", dominantChange: "brighter" });
|
||||
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 2843532, differentPixels: 400 * regions.length, mismatchPercentage: 0.01, match: false, regions });
|
||||
const battery = region({ x: 0.63, y: 2, width: 99.38, height: 2 }); // minX 9 of 1440 px
|
||||
assert.equal(ignoreSystemBands(measurement([battery]), { top: 6.5, bottom: 0 }).ignoredTop, 1);
|
||||
const indicator = region({ x: 0.63, y: 97.5, width: 99.38, height: 1 });
|
||||
assert.equal(ignoreSystemRegions(measurement([indicator]), systemRegions({ platform: "ios", device: "iPhone 17" })).ignoredHomeIndicator, 1);
|
||||
// The slack is the rounding, no more: a region a tenth of a percent past the band is still kept.
|
||||
assert.equal(ignoreSystemBands(measurement([region({ x: 10, y: 2, width: 20, height: 4.6 })]), { top: 6.5, bottom: 0 }).ignoredTop, 0);
|
||||
});
|
||||
|
||||
test("on a foldable a region across the pill's edge is kept whole, and one across the home indicator's edge is clipped", () => {
|
||||
const duo = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "closed" });
|
||||
const region = (rect, normalizedRect, differentPixels) => ({ index: 0, rect, normalizedRect, differentPixels, shareOfDiffPercentage: 100, densityPercentage: 100, shape: "block", size: "small", location: "middle-right", dominantChange: "darker" });
|
||||
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 87400, differentPixels: regions.reduce((total, entry) => total + entry.differentPixels, 0), mismatchPercentage: 0.11, match: false, regions });
|
||||
// A pill is not a band: what crosses its edge is the app's own rail, so the frames are never read for it.
|
||||
const belowPill = region({ x: 85, y: 190, width: 10, height: 20 }, { x: 85, y: 21.74, width: 10, height: 2.29 }, 200);
|
||||
const kept = ignoreSystemRegions(measurement([belowPill]), duo, () => assert.fail("a pill's edge needs no frames"));
|
||||
assert.deepEqual([kept.ignoredStatusBar, kept.measurement.match, kept.measurement.regions], [0, false, [belowPill]]);
|
||||
// The home indicator is a band across the width, as on a phone: in a 100x874 frame its 3% is the last 26 rows, from 848.
|
||||
const frame = (paint) => { const png = new PngImage({ width: 100, height: 874 }); png.data.fill(255); paint?.(png); return png; };
|
||||
const painted = (png) => { for (let y = 840; y < 850; y += 1) for (let x = 10; x < 20; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
|
||||
const crossing = region({ x: 10, y: 840, width: 10, height: 10 }, { x: 10, y: 96.11, width: 10, height: 1.14 }, 100);
|
||||
const clipped = ignoreSystemRegions(measurement([crossing]), duo, () => ({ baseline: frame(), current: frame(painted), distance: 0.1 * Math.sqrt(3 * 255 ** 2) }));
|
||||
assert.deepEqual([clipped.ignoredStatusBar, clipped.ignoredHomeIndicator, clipped.measurement.match, clipped.measurement.differentPixels], [0, 1, false, 80]);
|
||||
assert.deepEqual(clipped.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels, entry.shareOfDiffPercentage]), [[840, 8, 80, 100]]);
|
||||
});
|
||||
@@ -258,7 +258,9 @@ test('a visual region may carry the shift its content moved by, and a malformed
|
||||
const { assertPublicReview } = await import('../../dist/contracts/review-validation.js');
|
||||
const valid = JSON.parse(JSON.stringify(reviewWithRegion({ x: 0, y: -4.17 })));
|
||||
assert.doesNotThrow(() => assertPublicReview(valid));
|
||||
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 500 }, 'up']) {
|
||||
// A card recentred on iPhone Duo's inner display moved 395 pixels: a large move is still a move.
|
||||
assert.doesNotThrow(() => assertPublicReview(JSON.parse(JSON.stringify(reviewWithRegion({ x: 395, y: 0 })))));
|
||||
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 9000 }, 'up']) {
|
||||
assert.throws(() => assertPublicReview(reviewWithRegion(shift)), /visual verdict is inconsistent/, JSON.stringify(shift));
|
||||
}
|
||||
});
|
||||
@@ -286,3 +288,35 @@ test('allRegionsMoved is only true, and only where every published region carrie
|
||||
assert.throws(() => assertPublicReview(input), /visual verdict is inconsistent/, label);
|
||||
}
|
||||
});
|
||||
|
||||
test('a large move publishes as one region where the content is now, with its members\' pixels and the arrived region\'s location', async () => {
|
||||
const { publishMeasuredRegions } = await import('../../dist/review/evidence-assessment.js');
|
||||
const region = (x, share, location, dominantChange) => ({ index: 0, rect: { x, y: 100, width: 100, height: 200 },
|
||||
normalizedRect: { x: x / 10, y: 10, width: 10, height: 20 }, differentPixels: share * 100, shareOfDiffPercentage: share,
|
||||
densityPercentage: 50, shape: 'block', size: 'large', location, dominantChange });
|
||||
// Arrived first: the card is centred now, so the region says center whichever member has more pixels.
|
||||
const all = [region(100, 50.01, 'middle-left', 'brighter'), region(450, 50.01, 'center', 'darker')];
|
||||
const moves = [{ rect: { x: 450, y: 100, width: 100, height: 200 }, shift: { x: 350, y: 0 }, members: [1, 0] }];
|
||||
const published = publishMeasuredRegions(all, [undefined, undefined], moves, 1000, 1000);
|
||||
assert.deepEqual(published.regions, [{ rect: { x: 450, y: 100, width: 100, height: 200 }, normalizedRect: { x: 45, y: 10, width: 10, height: 20 },
|
||||
differentPixels: 10002, shareOfDiffPercentage: 100, dominantChange: 'mixed', location: 'center', shift: { x: 350, y: 0 } }],
|
||||
'two shares of 50.01 cap at 100, the Viewer\'s bound');
|
||||
assert.equal(published.allRegionsMoved, true, 'nothing else on the screen changed');
|
||||
// A change that is not part of the move keeps the screen from reading as only moved, and more regions than the
|
||||
// published limit keep the largest.
|
||||
const crowded = [...all, ...Array.from({ length: 9 }, (_, index) => region(index, 0.5, 'top-left', 'mixed'))];
|
||||
const withChanges = publishMeasuredRegions(crowded, crowded.map(() => undefined), moves, 1000, 1000);
|
||||
assert.equal(withChanges.allRegionsMoved, undefined);
|
||||
assert.equal(withChanges.regions.length, 8);
|
||||
assert.deepEqual(withChanges.regions[0].shift, { x: 350, y: 0 });
|
||||
});
|
||||
|
||||
test("an excluded surface carries no capture evidence", () => {
|
||||
const excluded = review();
|
||||
excluded.surfaces[1].excluded = true;
|
||||
assert.throws(() => assertPublicReview(excluded), /excluded surface carries capture evidence/);
|
||||
for (const key of ["baseImage", "headImage", "baseOutcome", "headOutcome", "review"]) delete excluded.surfaces[1][key];
|
||||
assert.doesNotThrow(() => assertPublicReview(excluded));
|
||||
excluded.surfaces[1].excluded = false;
|
||||
assert.throws(() => assertPublicReview(excluded), /excluded surface carries capture evidence/);
|
||||
});
|
||||
@@ -825,3 +825,63 @@ test("a target's review carries its target and the run's targets into the map; a
|
||||
assert.equal(oddRun.target, undefined, "a malformed target is dropped, and the report reads as its platform's");
|
||||
assert.equal(oddRun.targets, undefined);
|
||||
});
|
||||
|
||||
test("an excluded route leaves the map with an accepted gap, like a redirect", () => {
|
||||
const review = navigationReview();
|
||||
const excluded = review.surfaces.find(surface => surface.id === "games-pro");
|
||||
excluded.status = "modified";
|
||||
excluded.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete excluded[`${side}Image`]; delete excluded[`${side}Outcome`]; }
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(review));
|
||||
const graph = buildViewerGraph(current.map, indexMap(current.map));
|
||||
assert.equal(graph.screens.some(screen => screen.id === "games-pro"), false, "never captured, so not a card on the map");
|
||||
assert.ok(current.map.screens.some(screen => screen.id === "games-pro"), "the inventory still knows the route");
|
||||
const gap = current.map.gaps.find(gap => gap.screenId === "games-pro");
|
||||
assert.equal(gap.status, "accepted");
|
||||
assert.equal(gap.message, "Excluded by exploration.exclude; never captured");
|
||||
assert.equal(
|
||||
indexMap(current.map).screenNotes.get("games-pro"),
|
||||
"Excluded by exploration.exclude; never captured",
|
||||
"the inspector's placeholder says why there is no screenshot",
|
||||
);
|
||||
const projection = publicReviewProjection(review);
|
||||
assert.equal(projection.runtimeEvidence["public:games-pro"].current.groups.capture.find((row) => row.label === "Capture").value,
|
||||
"Excluded by exploration.exclude; never captured");
|
||||
});
|
||||
|
||||
test("an unchanged excluded route outside the capture context still says it was excluded", () => {
|
||||
const review = navigationReview();
|
||||
const excluded = review.surfaces.find(surface => surface.id === "games-pro");
|
||||
excluded.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete excluded[`${side}Image`]; delete excluded[`${side}Outcome`]; }
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(review));
|
||||
const gap = current.map.gaps.find(gap => gap.screenId === "games-pro");
|
||||
assert.equal(gap.status, "accepted");
|
||||
assert.equal(gap.message, "Excluded by exploration.exclude; never captured");
|
||||
assert.equal(diffFor(review).index.screenNotes.get("games-pro"), "Excluded by exploration.exclude; never captured");
|
||||
});
|
||||
|
||||
test("a screen's note is its first open gap of any kind, and an accepted gap only when nothing is open", () => {
|
||||
// A redirect on base that became a screen whose head capture failed: the comparison carries both sides' gaps.
|
||||
const review = verifyImages(fixture());
|
||||
const home = review.surfaces.find(surface => surface.id === "home");
|
||||
home.status = "modified";
|
||||
home.head = entry("home", "/", "fresh");
|
||||
home.headOutcome = { status: "failed", attempts: 1, landing: "unverified", reason: "Configured UI prerequisites did not complete." };
|
||||
const diff = diffFor(review);
|
||||
const messages = diff.map.gaps.filter(gap => gap.screenId === "home").map(gap => [gap.status, gap.message]);
|
||||
assert.deepEqual(messages.map(([status]) => status), ["open", "accepted"]);
|
||||
assert.equal(indexMap(diff.map).screenNotes.get("home"), messages[0][1], "the head's failure, not the baseline's redirect");
|
||||
assert.equal(presentScreensByPath(diff.map).index.screenNotes.get("home"), messages[0][1]);
|
||||
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(verifyImages(fixture())));
|
||||
const gap = (id, kind, status, message) => ({ id, kind, status, message, screenId: "games-free", createdAt: review.createdAt });
|
||||
const open = [gap("parse-1", "controller-parse", "open", "Unreadable element tree"), gap("parse-2", "controller-parse", "open", "Second warning")];
|
||||
const accepted = gap("accepted", "coverage", "accepted", "Not compared; no capture was recorded");
|
||||
const resolved = gap("resolved", "coverage", "resolved", "Captured on retry");
|
||||
for (const gaps of [[...open, accepted, resolved], [resolved, accepted, ...open]]) {
|
||||
assert.equal(indexMap({ ...current.map, gaps }).screenNotes.get("games-free"), "Unreadable element tree");
|
||||
}
|
||||
assert.equal(indexMap({ ...current.map, gaps: [resolved, accepted] }).screenNotes.get("games-free"), accepted.message);
|
||||
assert.equal(indexMap({ ...current.map, gaps: [resolved] }).screenNotes.has("games-free"), false);
|
||||
});
|
||||
@@ -1,7 +1,7 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { Buffer } from "node:buffer";
|
||||
import { regionShifts } from "../../dist/review/region-shift.js";
|
||||
import { regionMoves, 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 } = {}) {
|
||||
@@ -101,3 +101,167 @@ 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]);
|
||||
});
|
||||
|
||||
/**
|
||||
* A light frame with a dark card of irregular blocks at (x, y): the blocks make every offset look different, as a
|
||||
* real card's text and icons do. `tile` repeats one such block pattern every `tile` pixels across the whole row
|
||||
* instead, as a grid of identical cells does, starting `x` pixels in.
|
||||
*/
|
||||
function cardFrame({ width = 600, height = 300, x = 60, y = 80, cardWidth = 150, cardHeight = 120, seed = 7, tile } = {}) {
|
||||
const data = Buffer.alloc(width * height * 4, 240);
|
||||
for (let index = 3; index < data.length; index += 4) data[index] = 255;
|
||||
const paint = (px, py, value) => data.fill(value, (py * width + px) * 4, (py * width + px) * 4 + 3);
|
||||
let state = seed;
|
||||
const random = () => (state = (state * 1103515245 + 12345) % 2147483648) / 2147483648;
|
||||
const blocks = Array.from({ length: tile ? 6 : 40 }, () => {
|
||||
const span = tile ?? cardWidth;
|
||||
return [Math.floor(random() * (span - 12)), Math.floor(random() * (cardHeight - 8)), 4 + Math.floor(random() * 8), 3 + Math.floor(random() * 5), 80 + Math.floor(random() * 160)];
|
||||
});
|
||||
for (let py = y; py < y + cardHeight; py += 1) {
|
||||
for (let px = tile ? 0 : x; px < (tile ? width : x + cardWidth); px += 1) {
|
||||
const local = tile ? (((px - x) % tile) + tile) % tile : px - x;
|
||||
const block = blocks.find(([bx, by, bw, bh]) => local >= bx && local < bx + bw && py - y >= by && py - y < by + bh);
|
||||
paint(px, py, block ? block[4] : 12);
|
||||
}
|
||||
}
|
||||
return { width, height, data };
|
||||
}
|
||||
|
||||
test("a card that moved far along a row is one move, from the regions where it left and where it arrived", () => {
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
const shifts = regionShifts(cardFrame(), cardFrame({ x: 330 }), regions);
|
||||
assert.deepEqual(shifts, [undefined, undefined], "too far for the drift search");
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, shifts),
|
||||
[{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1, 0] }], "the region it arrived in first");
|
||||
});
|
||||
|
||||
test("a move whose old and new places overlap takes in the fragments of it the comparison found in between", () => {
|
||||
// A 300-wide card moved 120 right: the comparison sees where it only was, where it only is, and a fragment of the
|
||||
// overlap whose pixels differ because the card's own content moved over itself.
|
||||
const base = cardFrame({ width: 700, cardWidth: 300 }), head = cardFrame({ width: 700, cardWidth: 300, x: 180 });
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 120, height: 120, dominantChange: "brighter" },
|
||||
{ x: 360, y: 80, width: 120, height: 120, dominantChange: "darker" },
|
||||
{ x: 200, y: 100, width: 120, height: 40, dominantChange: "mixed" },
|
||||
];
|
||||
const [move] = regionMoves(base, head, regions, regions.map(() => undefined));
|
||||
assert.deepEqual(move, { rect: { x: 180, y: 80, width: 300, height: 120 }, shift: { x: 120, y: 0 }, members: [1, 0, 2] });
|
||||
});
|
||||
|
||||
test("a card that moved far down a column is a vertical move", () => {
|
||||
const regions = [
|
||||
{ x: 100, y: 20, width: 150, height: 100, dominantChange: "brighter" },
|
||||
{ x: 100, y: 330, width: 150, height: 100, dominantChange: "darker" },
|
||||
];
|
||||
const base = cardFrame({ height: 480, x: 100, y: 20, cardHeight: 100 }), head = cardFrame({ height: 480, x: 100, y: 330, cardHeight: 100 });
|
||||
assert.deepEqual(regionMoves(base, head, regions, [undefined, undefined]),
|
||||
[{ rect: { x: 100, y: 330, width: 150, height: 100 }, shift: { x: 0, y: 310 }, members: [1, 0] }]);
|
||||
});
|
||||
|
||||
test("content that left one place while other content arrived elsewhere is not a move", () => {
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330, seed: 99 }), regions, [undefined, undefined]), [], "another card arrived");
|
||||
// The pair must be opposite: two regions that both got darker are two changes.
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions.map(region => ({ ...region, dominantChange: "darker" })), [undefined, undefined]), []);
|
||||
// Regions already explained by a small move are not reconsidered.
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, [{ x: 0, y: 1 }, undefined]), []);
|
||||
});
|
||||
|
||||
test("repeating content that lines up at several distances is not a move: the distance would be a guess", () => {
|
||||
// A row of identical cells every 40 pixels, all moved 260 right: 220, 260 and 300 fit about as well.
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 100, height: 120, dominantChange: "brighter" },
|
||||
{ x: 300, y: 80, width: 100, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
assert.deepEqual(regionMoves(cardFrame({ tile: 40 }), cardFrame({ tile: 40, x: 320 }), regions, [undefined, undefined]), []);
|
||||
});
|
||||
|
||||
/** Two frames laid over each other: the darker pixel of each wins, so a dark card in either shows. */
|
||||
function overlay(first, second) {
|
||||
const data = Buffer.from(first.data);
|
||||
for (let index = 0; index < data.length; index += 1) data[index] = Math.min(first.data[index], second.data[index]);
|
||||
return { ...first, data };
|
||||
}
|
||||
|
||||
/** Paints a block of one colour into a frame, as a badge or icon drawn on top. */
|
||||
function withBlock(frame, { x, y, width, height, value }) {
|
||||
const data = Buffer.from(frame.data);
|
||||
for (let py = y; py < y + height; py += 1) for (let px = x; px < x + width; px += 1) data.fill(value, (py * frame.width + px) * 4, (py * frame.width + px) * 4 + 3);
|
||||
return { ...frame, data };
|
||||
}
|
||||
|
||||
const farMove = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
|
||||
test("something new where the card was stays a change: the move takes only the place it arrived", () => {
|
||||
// The card moved right, and another card took its old place.
|
||||
const head = overlay(cardFrame({ x: 330 }), cardFrame({ x: 60, seed: 99 }));
|
||||
assert.deepEqual(regionMoves(cardFrame(), head, farMove, [undefined, undefined]),
|
||||
[{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1] }]);
|
||||
// A flat panel in another colour than the backdrop around it: nothing spreads, but it is not the backdrop.
|
||||
const panel = withBlock(cardFrame({ x: 330 }), { x: 60, y: 80, width: 150, height: 120, value: 180 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), panel, farMove, [undefined, undefined])[0]?.members, [1]);
|
||||
// An 8×8 badge where a large card was: a small mark in a large plain area is still something drawn.
|
||||
const large = [
|
||||
{ x: 60, y: 80, width: 300, height: 400, dominantChange: "brighter" },
|
||||
{ x: 600, y: 80, width: 300, height: 400, dominantChange: "darker" },
|
||||
];
|
||||
const card = x => cardFrame({ width: 960, height: 560, x, cardWidth: 300, cardHeight: 400 });
|
||||
assert.deepEqual(regionMoves(card(60), card(600), large, [undefined, undefined])[0]?.members, [1, 0], "plain backdrop joins the move");
|
||||
const badge = withBlock(card(600), { x: 200, y: 250, width: 8, height: 8, value: 0 });
|
||||
assert.deepEqual(regionMoves(card(60), badge, large, [undefined, undefined])[0]?.members, [1]);
|
||||
});
|
||||
|
||||
test("content that did not arrive intact is not a move: part of it deleted, or something changed inside it", () => {
|
||||
// Only the card's top half arrived; its body was deleted.
|
||||
const deleted = withBlock(cardFrame({ x: 330 }), { x: 330, y: 140, width: 150, height: 60, value: 240 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), deleted, farMove, [undefined, undefined]), []);
|
||||
// The card moved, and an 8×8 white mark appeared inside it: a badge is a change, however small.
|
||||
const marked = withBlock(cardFrame({ x: 330 }), { x: 400, y: 130, width: 8, height: 8, value: 255 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), marked, farMove, [undefined, undefined]), []);
|
||||
// Changes of moderate contrast on the dark card: a grey badge, and a button in another shade.
|
||||
for (const block of [{ x: 400, y: 130, width: 8, height: 8, value: 120 }, { x: 340, y: 160, width: 40, height: 20, value: 60 }]) {
|
||||
assert.deepEqual(regionMoves(cardFrame(), withBlock(cardFrame({ x: 330 }), block), farMove, [undefined, undefined]), [], JSON.stringify(block));
|
||||
}
|
||||
});
|
||||
|
||||
test("a hairline that differs where the content arrived is not a change: antialiased edges against another backdrop", () => {
|
||||
// Two pixels wide and of moderate contrast, as the curve under euxy's Patterns chevrons (brentvatne/euxy#163).
|
||||
const crossed = withBlock(cardFrame({ x: 330 }), { x: 330, y: 150, width: 150, height: 2, value: 90 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), crossed, farMove, [undefined, undefined])[0]?.shift, { x: 270, y: 0 });
|
||||
});
|
||||
|
||||
test("content that is the same all down a move along a row keeps the move in line", () => {
|
||||
// Vertical bars of irregular widths: every small vertical drift fits as well as none.
|
||||
const bars = x => {
|
||||
const frame = cardFrame({ x });
|
||||
const data = Buffer.from(frame.data);
|
||||
const widths = [6, 11, 4, 9, 14, 5, 8, 12, 7, 10, 6, 13, 9, 5, 11, 7, 6, 8];
|
||||
let px = x, dark = true;
|
||||
for (const width of widths) {
|
||||
for (let py = 80; py < 200; py += 1) for (let column = px; column < Math.min(px + width, x + 150); column += 1) data.fill(dark ? 20 : 200, (py * frame.width + column) * 4, (py * frame.width + column) * 4 + 3);
|
||||
px += width; dark = !dark;
|
||||
}
|
||||
return { ...frame, data };
|
||||
};
|
||||
const [move] = regionMoves(bars(60), bars(330), farMove, [undefined, undefined]);
|
||||
assert.deepEqual(move?.shift, { x: 270, y: 0 });
|
||||
assert.deepEqual(move?.rect, { x: 330, y: 80, width: 150, height: 120 });
|
||||
});
|
||||
|
||||
test("regions with fractional edges, or reaching past the screenshot, are measured on the pixels they cover", () => {
|
||||
const regions = [
|
||||
{ x: 60.4, y: 79.6, width: 149.8, height: 120.5, dominantChange: "brighter" },
|
||||
{ x: 330.2, y: 80, width: 150.3, height: 400, dominantChange: "darker" },
|
||||
];
|
||||
const [move] = regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, [undefined, undefined]);
|
||||
assert.deepEqual(move?.shift, { x: 270, y: 0 });
|
||||
});
|
||||
@@ -54,17 +54,14 @@ test("rejects comparisons that name another URL, a PR number, or one commit twic
|
||||
assert.throws(() => projectReviewPresentation({ ...comparison, repositoryId: "x" }), /decimal GitHub id/);
|
||||
});
|
||||
|
||||
test("a run's scope and link lifetime override the reviewed config only where the workflow set them", async () => {
|
||||
test("a run's scope overrides the reviewed config only where the workflow set it; a link lifetime from older workflows changes nothing", async () => {
|
||||
const { withRunOverrides } = await import("../../dist/config/explore-config.js");
|
||||
const config = { exploration: { scope: "changes" }, report: { preview: { hosting: "eas", expiresAfterDays: 30 } } };
|
||||
const config = { exploration: { scope: "changes" }, report: { preview: { hosting: "eas" } } };
|
||||
assert.deepEqual(withRunOverrides(config, {}), config);
|
||||
assert.deepEqual(withRunOverrides(config, { scope: "all", expiresIn: "never" }),
|
||||
{ exploration: { scope: "all" }, report: { preview: { hosting: "eas", expiresAfterDays: null } } });
|
||||
assert.equal(withRunOverrides(config, { expiresIn: "90d" }).report.preview.expiresAfterDays, 90);
|
||||
assert.deepEqual(withRunOverrides({ exploration: { scope: "changes" } }, { expiresIn: "never" }), { exploration: { scope: "changes" } }, "no hosting, nothing to expire");
|
||||
assert.deepEqual(withRunOverrides(config, { scope: "all", expiresIn: "never" }), { exploration: { scope: "all" }, report: { preview: { hosting: "eas" } } });
|
||||
// A hosted preview lasts as long as its EAS Hosting deployment, so --expires-in is accepted from older workflows and ignored, whatever it says.
|
||||
assert.deepEqual(withRunOverrides(config, { expiresIn: "forever" }), config);
|
||||
assert.throws(() => withRunOverrides(config, { scope: "everything" }), /--scope must be changes or all/);
|
||||
assert.throws(() => withRunOverrides(config, { expiresIn: "forever" }), /--expires-in/);
|
||||
assert.throws(() => withRunOverrides({ exploration: { scope: "changes" } }, { expiresIn: "forevr" }), /--expires-in/, "a typo fails even before hosting is on");
|
||||
});
|
||||
|
||||
test("a comparison links GitHub's direct two-dot diff, which matches what capture compares, also for a rollback", () => {
|
||||
|
||||
@@ -16,7 +16,8 @@ test('round trip: light + dark on both sides with a fully reused baseline', asyn
|
||||
const inconclusiveDark = report.review.surfaces.filter(surface => surface.id.endsWith('@dark') && surface.review?.status === 'needs-review');
|
||||
assert.deepEqual(inconclusiveDark.map(surface => `${surface.id}: ${surface.review.description}`), [], 'an unchanged dark pair compares conclusively');
|
||||
assert.ok(!progress.some(line => line.startsWith('::warning')), progress.filter(line => line.startsWith('::warning')).join('\n'));
|
||||
assert.match(comment, /\| iOS \| [^|]*light \+ dark[^|]*\| 🟩 /);
|
||||
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
|
||||
assert.doesNotMatch(comment, /^iOS · /m, 'nothing is missing on iOS');
|
||||
assert.equal(records.current.ios?.phase, 'ready');
|
||||
assert.ok(records.current.ios?.capture, 'the final record keeps the capture counts');
|
||||
assert.deepEqual(records.current.ios.capture.done, records.current.ios.capture.planned, 'progress counts surfaces (routes), not light + dark images');
|
||||
@@ -33,7 +34,8 @@ test('round trip: a dark-only base against a light + dark head (the first PR tha
|
||||
const lightOnly = report.review.surfaces.filter(surface => surface.head && !surface.base && !surface.id.endsWith('@dark') && surface.head.route !== '/added');
|
||||
assert.ok(lightOnly.length > 0, 'the light appearance is an added surface, not a modified one');
|
||||
assert.ok(!progress.some(line => line.startsWith('::warning')), progress.filter(line => line.startsWith('::warning')).join('\n'));
|
||||
assert.match(comment, /\| iOS \| [^|]*light \+ dark[^|]*\| 🟩 /);
|
||||
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
|
||||
assert.doesNotMatch(comment, /^iOS · /m, 'nothing is missing on iOS');
|
||||
assert.equal(records.current.ios?.phase, 'ready');
|
||||
});
|
||||
|
||||
@@ -41,14 +43,16 @@ test('round trip: light + dark with a freshly captured base', async t => {
|
||||
const { result, bundles, comment } = await roundTrip(t, { userInterfaceStyle: 'automatic' }, { cachedBase: false });
|
||||
assert.deepEqual(schemesOf(bundles.base), ['light', 'dark']);
|
||||
assert.equal(result.evidence.summary.visual.failed, 0);
|
||||
assert.match(comment, /\| iOS \| [^|]*light \+ dark[^|]*\| 🟩 /);
|
||||
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
|
||||
assert.doesNotMatch(comment, /^iOS · /m, 'nothing is missing on iOS');
|
||||
});
|
||||
|
||||
test('round trip: Android light + dark', async t => {
|
||||
const { result, bundles, comment, records } = await roundTrip(t, { userInterfaceStyle: 'automatic', platform: 'android' });
|
||||
assert.deepEqual(schemesOf(bundles.head), ['light', 'dark']);
|
||||
assert.equal(result.evidence.summary.visual.failed, 0);
|
||||
assert.match(comment, /\| Android \| [^|]*light \+ dark[^|]*\| 🟩 /);
|
||||
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
|
||||
assert.doesNotMatch(comment, /^Android · /m, 'nothing is missing on Android');
|
||||
assert.equal(records.current.android?.phase, 'ready');
|
||||
});
|
||||
|
||||
@@ -57,7 +61,8 @@ test('round trip: a single-scheme app (no userInterfaceStyle) captures light onl
|
||||
assert.deepEqual(bundleColorSchemes(bundles.head), ['light']);
|
||||
assert.ok(!report.review.surfaces.some(surface => /@(light|dark)$/.test(surface.id)), 'no secondary appearance surfaces');
|
||||
assert.equal(report.review.runtime.colorSchemes, undefined);
|
||||
assert.match(comment, /\| iOS \| [^|]*\| 🟩 /);
|
||||
assert.match(comment, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]/m);
|
||||
assert.doesNotMatch(comment, /^iOS · /m);
|
||||
assert.doesNotMatch(comment, /light \+ dark/);
|
||||
assert.equal(records.current.ios.phase, 'ready');
|
||||
});
|
||||
|
||||
@@ -11,7 +11,7 @@ test('round trip: light + dark with an unavailable screen publishes an incomplet
|
||||
assert.ok(unattributed.length >= 1);
|
||||
assert.ok(unattributed.every(surface => surface.headImage && surface.headOutcome.observed?.reason === 'observer-not-ready'));
|
||||
assert.ok(progress.some(line => line.startsWith('::warning title=Explore head capture unavailable')), progress.filter(line => line.startsWith('::warning')).join('\n'));
|
||||
assert.match(comment, /\| iOS \| [^|]*\| 🟨 [^|]*unattributed/);
|
||||
assert.match(comment, /^iOS · [^\n]*unattributed · \[run\]/m);
|
||||
assert.doesNotMatch(comment, /🟥 failed/);
|
||||
assert.equal(records.current.ios?.phase, 'ready');
|
||||
});
|
||||
@@ -33,7 +33,7 @@ test('round trip: a failed screenshot comparison is a named gap, not a failed ru
|
||||
assert.ok(surface, `${id} stays in the report`);
|
||||
assert.notEqual(surface.review?.status, 'modified', 'a failed comparison is not reported as a change');
|
||||
}
|
||||
assert.match(comment, /\| iOS \| [^|]*\| 🟨 [^|]*2 comparisons failed/);
|
||||
assert.match(comment, /^iOS · [^\n]*2 comparisons failed · \[run\]/m);
|
||||
assert.doesNotMatch(comment, /🟥 failed/);
|
||||
assert.equal(records.current.ios?.phase, 'ready');
|
||||
});
|
||||
@@ -44,7 +44,7 @@ test('round trip: a baseline with an unavailable screen is still cached, and the
|
||||
assert.ok(progress.some(line => line.startsWith('baseline: ::warning title=Explore head capture unavailable')));
|
||||
assert.ok(progress.some(line => !line.startsWith('baseline:') && /reused from the baseline, \d+ to capture/.test(line)), progress.filter(line => line.includes('capture')).join('\n'));
|
||||
assert.ok(result.evidence.summary.visual.compared > 0);
|
||||
assert.match(comment, /\| iOS \| [^|]*\| 🟨 /);
|
||||
assert.match(comment, /^iOS · [^\n]*· \[run\]/m, 'the gap is named on the iOS line');
|
||||
assert.equal(records.current.ios?.phase, 'ready');
|
||||
});
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ test('round trip: a push mid-review publishes the finished run under previous ru
|
||||
assert.equal(records.current.ios.headSha, newHead);
|
||||
assert.equal(records.history.length, 1);
|
||||
assert.equal(records.history[0].headSha, f.headSha);
|
||||
assert.match(comment, new RegExp(`base \\[${f.baseSha.slice(0, 8)}\\][^\\n]*\\[${newHead.slice(0, 8)}\\]`));
|
||||
assert.match(comment, new RegExp(`^<sub>\\[iOS\\]\\(<[^>]+>\\) · \\[${newHead.slice(0, 8)}\\]\\(<[^>]+>\\) vs \\[${f.baseSha.slice(0, 8)}\\]`, 'm'));
|
||||
assert.match(comment, /Previous runs \(1\)/);
|
||||
assert.ok(comment.includes(f.headSha.slice(0, 8)), 'the previous head is named');
|
||||
assert.ok(comment.includes('/actions/runs/1234/'), 'the previous run stays linked');
|
||||
@@ -46,13 +46,12 @@ test('round trip: iOS and Android jobs of one run share a single comment: one ro
|
||||
assert.equal(records.current.ios.phase, 'ready');
|
||||
assert.equal(records.current.android.phase, 'ready');
|
||||
assert.equal(records.current.ios.runId, records.current.android.runId);
|
||||
assert.equal((comment.match(/^\| iOS \|/gm) ?? []).length, 1);
|
||||
assert.equal((comment.match(/^\| Android \|/gm) ?? []).length, 1);
|
||||
assert.equal(comment.match(/^### Explore review/gm).length, 1, 'one header');
|
||||
const routeLines = comment.split('\n').filter(line => /^- `\/(added|removed|home)`/.test(line));
|
||||
assert.equal(comment.match(/^### /gm).length, 1, 'one header');
|
||||
assert.match(comment, /^<sub>\[iOS\]\(<[^>]+>\) · \[Android\]\(<[^>]+>\) · /m, 'the subtitle links each platform\'s report');
|
||||
const routeLines = comment.split('\n').filter(line => /^- (Added |Removed )?\[`\/(added|removed|home)`\]\(</.test(line));
|
||||
assert.ok(routeLines.length >= 1, `the comment lists changed routes once:\n${comment}`);
|
||||
assert.equal(routeLines.length, 6, `each changed screen is listed once:\n${comment}`);
|
||||
for (const line of routeLines) assert.ok(/\[iOS\]\(/.test(line) && /\[Android\]\(/.test(line), `each changed route carries both platforms once: ${line}`);
|
||||
for (const line of routeLines) assert.doesNotMatch(line, / only$|not on /, `a screen changed on both platforms names neither: ${line}`);
|
||||
const projection = publicReviewProjection(android.report.review);
|
||||
for (const surface of android.report.review.surfaces) assert.ok(projection.surfaces[surface.id], `the Viewer projects the Android surface ${surface.id}`);
|
||||
assert.ok(ios.projection.surfaces[ios.report.review.surfaces[0].id], 'the iOS report still opens');
|
||||
@@ -82,5 +81,5 @@ test('round trip: a run on an old head that finishes after the new head\'s run f
|
||||
assert.ok(late.records.history.some(entry => entry.headSha === f.headSha && entry.platforms?.ios?.superseded === true || entry.superseded === true), JSON.stringify(late.records.history));
|
||||
assert.match(late.comment, /Previous runs \(2\)/);
|
||||
assert.ok(late.comment.includes('/actions/runs/1236/'), 'the late report stays reachable');
|
||||
assert.match(late.comment, new RegExp(`base \\[${f.baseSha.slice(0, 8)}\\][^\\n]*\\[${newHead.slice(0, 8)}\\]`));
|
||||
assert.match(late.comment, new RegExp(`^<sub>\\[iOS\\]\\(<[^>]+>\\) · \\[${newHead.slice(0, 8)}\\]\\(<[^>]+>\\) vs \\[${f.baseSha.slice(0, 8)}\\]`, 'm'));
|
||||
});
|
||||
@@ -65,3 +65,78 @@ test("empty queries and non-positive limits do not return an unbounded inventory
|
||||
assert.deepEqual(search.searchItems(items, "money", 0), []);
|
||||
assert.deepEqual(search.suggestedSearchItems(items, {}, 0), []);
|
||||
});
|
||||
|
||||
test("the palette ranks commands first for a word and screens first for a route, matching command keywords", () => {
|
||||
const items = [
|
||||
{ id: "screen:a", kind: "screen", title: "/settings/dark-mode", keywords: ["/settings/dark-mode"], context: "", order: 0, screenId: "a" },
|
||||
{ id: "command:theme", kind: "command", title: "Theme: Dark", keywords: ["theme", "appearance"], context: "View", order: 1, run() {} },
|
||||
{ id: "command:fit", kind: "command", title: "Fit the canvas", keywords: ["zoom"], context: "Canvas", order: 2, run() {} },
|
||||
];
|
||||
assert.deepEqual(search.searchItems(items, "dark").map((item) => item.id), ["command:theme", "screen:a"]);
|
||||
assert.deepEqual(search.searchItems(items, "/settings").map((item) => item.id), ["screen:a"]);
|
||||
const open = { id: "command:open", kind: "command", title: "Open /settings/dark-mode in Compare", keywords: [], context: "Changes", order: 3, run() {} };
|
||||
assert.deepEqual(search.searchItems([...items, open], "settings/dark").map((item) => item.id), ["screen:a", "command:open"]);
|
||||
assert.deepEqual(search.searchItems(items, "appearance").map((item) => item.id), ["command:theme"]);
|
||||
assert.deepEqual(search.searchItems(items, "zoom").map((item) => item.id), ["command:fit"]);
|
||||
|
||||
// A word that is a screen's last segment opens that screen; part of one still leads with the command.
|
||||
const theme = { id: "screen:theme", kind: "screen", title: "/settings/theme", keywords: ["/settings/theme"], context: "", order: 3, screenId: "theme" };
|
||||
assert.deepEqual(search.searchItems([...items, theme], "theme").map((item) => item.id), ["screen:theme", "command:theme"]);
|
||||
assert.deepEqual(search.searchItems([...items, theme], "Theme ").map((item) => item.id), ["screen:theme", "command:theme"]);
|
||||
assert.deepEqual(search.searchItems([...items, theme], "them").map((item) => item.id), ["command:theme", "screen:theme"]);
|
||||
});
|
||||
|
||||
test("the palette's commands follow the canvas: Compare steps changes with the arrows, the Map fits its camera, and suggestions lead with the next change", async () => {
|
||||
const { commandItems, suggestedCommands } = await tsImport("../../viewer/src/utils/commands.ts", import.meta.url);
|
||||
const calls = [];
|
||||
const actions = Object.fromEntries(["selectCanvas", "openFind", "openHandoff", "openShortcuts", "toggleChanges", "openChangedScreen", "setTheme", "chooseAppearance", "toggleInspector", "toggleFullscreen", "switchTarget", "zoom"]
|
||||
.map((name) => [name, (...args) => calls.push([name, ...args])]));
|
||||
const base = {
|
||||
phone: false, changed: [{ id: "a", route: "/a" }, { id: "b", route: "/b" }], selectedScreenId: "a", find: true, handoff: true,
|
||||
pullRequest: { number: 7, url: "https://github.com/expo/explore/pull/7" }, theme: "system", appearances: [], targets: [{ id: "android", label: "Pixel 8", platform: "android", place: 1, noun: "device" }], camera: true,
|
||||
};
|
||||
const map = commandItems({ ...base, canvas: "map", inspector: { open: false } }, actions);
|
||||
const ids = (items) => items.map((item) => item.id.replace(/^command:/, ""));
|
||||
assert.ok(ids(map).includes("camera:fit"));
|
||||
assert.ok(ids(map).includes("changes:open-selected"));
|
||||
assert.ok(ids(map).includes("link:repository"));
|
||||
assert.equal(map.find((item) => item.id === "command:changes:next").shortcut, undefined);
|
||||
assert.deepEqual(ids(suggestedCommands(map, "map")).slice(0, 3), ["changes:next", "changes:open-selected", "go:compare"]);
|
||||
map.find((item) => item.id === "command:changes:next").run();
|
||||
map.find((item) => item.id === "command:target:android").run();
|
||||
assert.deepEqual(calls, [["openChangedScreen", "b"], ["switchTarget", "android"]]);
|
||||
|
||||
const compare = commandItems({ ...base, canvas: "compare", camera: false }, actions);
|
||||
assert.ok(!ids(compare).includes("camera:fit"));
|
||||
assert.ok(!ids(compare).includes("changes:open-selected"));
|
||||
assert.ok(compare.find((item) => item.id === "command:changes:next").shortcut);
|
||||
assert.ok(!ids(compare).includes("go:compare"));
|
||||
assert.ok(ids(compare).includes("go:map"));
|
||||
|
||||
// A phone has no keyboard shortcuts to list.
|
||||
assert.ok(ids(map).includes("go:shortcuts"));
|
||||
assert.ok(!ids(commandItems({ ...base, canvas: "map", phone: true }, actions)).includes("go:shortcuts"));
|
||||
|
||||
// Next and Previous stop at the ends of the review, as Compare's arrows do.
|
||||
const last = commandItems({ ...base, canvas: "compare", camera: false, selectedScreenId: "b" }, actions);
|
||||
assert.ok(!ids(last).includes("changes:next"));
|
||||
assert.ok(ids(last).includes("changes:previous"));
|
||||
assert.ok(!ids(compare).includes("changes:previous"));
|
||||
const none = commandItems({ ...base, canvas: "map", selectedScreenId: undefined }, actions);
|
||||
assert.ok(ids(none).includes("changes:next") && ids(none).includes("changes:previous"));
|
||||
|
||||
// An app appearance is found by its own scheme, not the other one.
|
||||
const schemes = commandItems({ ...base, canvas: "map", appearances: [{ id: "light", label: "Light", current: true }, { id: "dark", label: "Dark", current: false }] }, actions);
|
||||
assert.deepEqual(search.searchItems(schemes, "dark").filter((item) => item.id.includes("appearance")).map((item) => item.id), ["command:view:appearance:dark"]);
|
||||
});
|
||||
|
||||
test("the palette finds a device by its own platform only", async () => {
|
||||
const { commandItems } = await tsImport("../../viewer/src/utils/commands.ts", import.meta.url);
|
||||
const actions = new Proxy({}, { get: () => () => {} });
|
||||
const items = commandItems({
|
||||
canvas: "map", phone: false, changed: [], find: true, handoff: false, theme: "system", appearances: [], camera: false,
|
||||
targets: [{ id: "duo-open", label: "iPhone Duo open", platform: "ios", place: 1, noun: "device" }, { id: "pixel", label: "Pixel 8", platform: "android", place: 2, noun: "device" }],
|
||||
}, actions);
|
||||
assert.deepEqual(search.searchItems(items, "android").map((item) => item.id), ["command:target:pixel"]);
|
||||
assert.deepEqual(search.searchItems(items, "ios").map((item) => item.id), ["command:target:duo-open"]);
|
||||
});
|
||||
@@ -58,3 +58,15 @@ test("no two shortcuts share a chord", () => {
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test("⌥1–⌥8 open a target by its place, with ⌥ alone; D and ` are plain keys", () => {
|
||||
assert.equal(SHORTCUTS.targetByNumber.length, 8);
|
||||
assert.ok(matchesShortcut(key("Digit2", { altKey: true }), SHORTCUTS.targetByNumber[1]));
|
||||
assert.ok(!matchesShortcut(key("Digit2"), SHORTCUTS.targetByNumber[1]), "a plain 2 is Compare's Swipe");
|
||||
assert.ok(!matchesShortcut(key("Digit2", { altKey: true, shiftKey: true }), SHORTCUTS.targetByNumber[1]));
|
||||
assert.ok(!matchesShortcut(key("Digit2", { altKey: true, ctrlKey: true }), SHORTCUTS.targetByNumber[1]));
|
||||
assert.equal(formatShortcut(SHORTCUTS.targetByNumber[0], true), "⌥1");
|
||||
assert.equal(formatShortcut(SHORTCUTS.targetByNumber[0], false), "Alt+1");
|
||||
assert.ok(matchesShortcut(key("KeyD"), SHORTCUTS.target.menu));
|
||||
assert.ok(matchesShortcut(key("Backquote"), SHORTCUTS.target.last));
|
||||
});
|
||||
@@ -36,6 +36,55 @@ test("changed routes include ancestors and descendants without ancestor sibling
|
||||
assert.equal(result.surfaces.find(row=>row.headSurface.route==="/end").status,"unchanged");
|
||||
});
|
||||
|
||||
test("a comment or whitespace-only edit to an imported file changes no surface; an edit to its tokens does", () => {
|
||||
const theme = "export const theme = { tint: 'blue' };\n";
|
||||
const files = [["app/one.tsx", 'import { theme } from "../src/theme"; export default () => theme;'], ["app/two.tsx", page], ["src/theme.ts", theme]];
|
||||
const head = (text) => [files[0], files[1], ["src/theme.ts", text]];
|
||||
const change = [{ status: "modified", path: "src/theme.ts" }];
|
||||
for (const text of ["// Palette.\nexport const theme = { tint: 'blue' };\n", "/** The palette, attached to the declaration as JSDoc. */\nexport const theme = { tint: 'blue' };\n", "export const theme = {\n tint: 'blue' /* default */\n};\r\n", theme + "\n\n"]) {
|
||||
const result = plan({ base: files, head: head(text), changes: change });
|
||||
assert.deepEqual(result.surfaces.map((row) => [row.status, row.reasons]), [["unchanged", []], ["unchanged", []]], text);
|
||||
assert.deepEqual(selectedPaths(result), []);
|
||||
}
|
||||
for (const text of ["export const theme = { tint: 'red' };\n", "export const theme = { tint: 'blue' }\n", "export const theme = { tint: 'blue' };; \n", "export const theme = { tint: 'blue' ;\n"]) {
|
||||
assert.equal(plan({ base: files, head: head(text), changes: change }).surfaces[0].status, "modified", text);
|
||||
}
|
||||
// JSX text keeps its whitespace: a space inside a Text is rendered.
|
||||
const jsx = (text) => [["app/one.tsx", `import {Text} from "react-native"; export default () => <Text>${text}</Text>;`]];
|
||||
assert.equal(plan({ base: jsx("a"), head: jsx(" a "), changes: [{ status: "modified", path: "app/one.tsx" }] }).surfaces[0].status, "modified");
|
||||
assert.equal(plan({ base: jsx("a"), head: jsx("{/* note */}a"), changes: [{ status: "modified", path: "app/one.tsx" }] }).surfaces[0].status, "unchanged");
|
||||
});
|
||||
|
||||
test("a line break, JSX space or compiler comment that changes the program is a change; re-wrapping is not", () => {
|
||||
const status = (path, before, after) => plan({ base: [[path, before]], head: [[path, after]], changes: [{ status: "modified", path }] }).surfaces[0].status;
|
||||
const screen = (body) => `import {Text, View} from "react-native"; export default function Screen({ n, a, b }) { ${body} }`;
|
||||
// Automatic semicolon insertion: the same tokens, a different program.
|
||||
for (const [before, after] of [
|
||||
['return "hello";', 'return\n"hello";'],
|
||||
['return /* x */ "hello";', 'return /*\n*/ "hello";'],
|
||||
["return (\n<View/>);", "return\n(<View/>);"],
|
||||
["a\n++b; return null;", "a++\nb; return null;"],
|
||||
]) assert.equal(status("app/one.tsx", screen(before), screen(after)), "modified", after);
|
||||
// The JSX transform keeps space within a line, and trims it only where a line breaks.
|
||||
for (const [before, after] of [["<Text>a</Text>", "<Text> a</Text>"], ["<Text>{n} items</Text>", "<Text>{n}items</Text>"], ["<Text>{a} {b}</Text>", "<Text>{a} {b}</Text>"]]) {
|
||||
assert.equal(status("app/one.tsx", screen(`return ${before};`), screen(`return ${after};`)), "modified", after);
|
||||
}
|
||||
for (const [before, after] of [
|
||||
["return (<View><Text>hello world</Text></View>);", "return (\n <View>\n <Text>\n hello\n world\n </Text>\n </View>\n);"],
|
||||
["return f(a, b);", "return f(\n a,\n b\n);"],
|
||||
]) assert.equal(status("app/one.tsx", screen(before), screen(after)), "unchanged", after);
|
||||
// A comment a compiler or bundler reads is not trivia.
|
||||
for (const [before, after] of [
|
||||
["/** @jsxImportSource react */\n", "/** @jsxImportSource other */\n"],
|
||||
["/** @jsx h */\n", "/** @jsx g */\n"],
|
||||
["", "// @flow\n"],
|
||||
]) assert.equal(status("app/one.jsx", `${before}export default () => <a/>;`, `${after}export default () => <a/>;`), "modified", after);
|
||||
assert.equal(status("app/one.tsx", screen("return f();"), screen("return /*#__PURE__*/ f();")), "modified");
|
||||
assert.equal(status("app/one.tsx", screen("return <Text>a</Text>;"), screen("return <Text>{/* @jsx h */}a</Text>;")), "modified");
|
||||
// An ordinary JSDoc tag is still a comment.
|
||||
assert.equal(status("app/one.tsx", `/** @param n a count */\n${screen("return null;")}`, `/**\n * @param n the count\n * @returns nothing\n */\n${screen("return null;")}`), "unchanged");
|
||||
});
|
||||
|
||||
test("source snapshots detect modifications even when a caller omits a diff entry", () => {
|
||||
const result=plan({base:[["app/one.tsx",page]],head:[["app/one.tsx",page.replace("null","<View/>")]]});
|
||||
assert.equal(result.surfaces[0].status,"modified");
|
||||
@@ -136,7 +185,7 @@ test("package.json changes are app-wide unless they only touch scripts that inst
|
||||
test("app-wide inputs that no route imports mark every surface modified", () => {
|
||||
const files = [["app/one.tsx", page], ["app/two.tsx", page], ["package.json", JSON.stringify({ main: "index.js" })], ["index.js", "import 'expo-router/entry';"]];
|
||||
for (const path of ["eas.json", ".env", ".env.production", "tailwind.config.js", "postcss.config.cjs", "index.js"]) {
|
||||
const head = files.some(([name]) => name === path) ? files.map(([name, text]) => [name, name === path ? `${text}\n` : text]) : [...files, [path, "{}"]];
|
||||
const head = files.some(([name]) => name === path) ? files.map(([name, text]) => [name, name === path ? `${text};` : text]) : [...files, [path, "{}"]];
|
||||
assert.deepEqual(selectedPaths(plan({ base: files, head, changes: [{ status: files.some(([name]) => name === path) ? "modified" : "added", path }] })), ["/one", "/two"], path);
|
||||
}
|
||||
assert.deepEqual(selectedPaths(plan({ base: files, head: [...files, ["docs/eas.json", "{}"]], changes: [{ status: "added", path: "docs/eas.json" }] })), []);
|
||||
|
||||
@@ -228,6 +228,29 @@ test("summary bounds retain blob identities and explicitly mark omitted source e
|
||||
assert.ok(Object.values(results).every((result) => result.summary.length <= SOURCE_CHANGE_SUMMARY_LIMITS.summaryCharacters));
|
||||
});
|
||||
|
||||
test("a comment-only edit to an imported file leaves no source evidence and no imported impact", (t) => {
|
||||
const repo = repository(t,
|
||||
{ "src/theme.ts": "export const tint = 'blue';\n", "src/label.ts": "export const label = 'Before';\n" },
|
||||
{ "src/theme.ts": "// Palette.\nexport const tint = 'blue';\n", "src/label.ts": "export const label = 'After';\n" });
|
||||
const entry = surface("home", "src/home.tsx", ["src/theme.ts", "src/label.ts"]);
|
||||
const result = summarize(repo, plan(repo, [tracked(entry, ["src/label.ts"])])).home;
|
||||
assert.equal(result.impact, "dependency");
|
||||
assert.deepEqual(result.files.map((file) => file.path), ["src/label.ts"]);
|
||||
assert.equal(result.truncated, false);
|
||||
});
|
||||
|
||||
test("comment-only files do not take the file slots of a real change", (t) => {
|
||||
const comments = Array.from({ length: SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface }, (_, index) => `src/a${index}.ts`);
|
||||
const repo = repository(t,
|
||||
{ ...Object.fromEntries(comments.map((path) => [path, "export const value = 1;\n"])), "src/z-theme.ts": "export const tint = 'blue';\n" },
|
||||
{ ...Object.fromEntries(comments.map((path) => [path, "// Note.\nexport const value = 1;\n"])), "src/z-theme.ts": "export const tint = 'red';\n" });
|
||||
const entry = surface("home", "src/home.tsx", [...comments, "src/z-theme.ts"]);
|
||||
const result = summarize(repo, plan(repo, [tracked(entry, ["src/z-theme.ts"])])).home;
|
||||
assert.equal(result.impact, "dependency");
|
||||
assert.deepEqual(result.files.map((file) => file.path), ["src/z-theme.ts"]);
|
||||
assert.equal(result.truncated, false);
|
||||
});
|
||||
|
||||
test("unrelated surfaces remain unchanged and exact SHA validation rejects an ungrounded comparison", (t) => {
|
||||
const repo = repository(t, { "README.md": "Before\n" }, { "README.md": "After\n" });
|
||||
const entry = surface("unrelated", "src/unrelated.tsx");
|
||||
|
||||
@@ -155,14 +155,14 @@ test("only a live uploaded final artifact becomes Ready with a central Viewer de
|
||||
const posted = calls.find(call => call.options.method === "POST");
|
||||
assert.ok(posted);
|
||||
const body = JSON.parse(posted.options.body).body;
|
||||
assert.match(body, /\| iOS \| [^|]*\| 🟩 /);
|
||||
assert.match(body, /^### (\d+ screens?|No screens) changed · \[Review in Explore\]\(<https:\/\/explore-preview/m);
|
||||
const viewer = new URL(result.artifactUrl);
|
||||
assert.equal(viewer.origin, "https://explore-preview.expo.app");
|
||||
assert.equal(viewer.pathname, "/");
|
||||
assert.deepEqual(Object.fromEntries(viewer.searchParams), { repo: pr.repository, run: "10", attempt: "1", artifact: "20" });
|
||||
assert.ok(body.includes(result.artifactUrl));
|
||||
assert.match(body, new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<${result.artifactUrl.replace(/[.?+*]/g, "\\$&")}>\\) \\|$`, "m"), "the Report cell is the report link alone");
|
||||
assert.match(body, new RegExp(`· Workflow \\[run\\]\\(<https://github\\.com/expo/explore-playground/actions/runs/10/attempts/1>\\) · \\[zip\\]\\(<${artifactUrl.replace(/[.?+*]/g, "\\$&")}>\\)$`, "m"), "the run and zip links sit in the footer");
|
||||
assert.match(body, new RegExp(`^### (\\d+ screens?|No screens) changed · \\[Review in Explore\\]\\(<${result.artifactUrl.replace(/[.?+*]/g, "\\$&")}>\\)$`, "m"), "the report link is the heading");
|
||||
assert.match(body, /^<sub>\[Workflow run\]\(<https:\/\/github\.com\/expo\/explore-playground\/actions\/runs\/10\/attempts\/1>\) · \[Config\]\(<[^>]+>\)<\/sub>$/m, "the run sits in the footer");
|
||||
assert.doesNotMatch(body, /embedded\.expo-explore\.invalid|<img|convex/);
|
||||
assert.ok(calls.some(call => call.url.pathname.endsWith("/actions/runs/10/attempts/1")));
|
||||
});
|
||||
@@ -172,10 +172,10 @@ test("an uploaded diagnostic artifact with unverified landings remains Incomplet
|
||||
const { transport, calls } = transportFixture();
|
||||
await publishCiReportComment({ inputPath, artifactUrl, environment, transport });
|
||||
const body = JSON.parse(calls.find(call => call.options.method === "POST").options.body).body;
|
||||
assert.match(body, /\| iOS \| [^|]+\| 🟨 [^|]*2 unattributed/);
|
||||
assert.match(body, /\| Route verification \| 🟨 0\/2 verified · 2 unattributed \|/);
|
||||
assert.match(body, /\*\*iOS\*\* · base 0\/1 verified · 1 unattributed · head 0\/1 verified · 1 unattributed/);
|
||||
assert.doesNotMatch(body, /\| iOS \| [^|]+\| 🟩|⏳|Needs review/);
|
||||
assert.match(body, /^iOS · 2 unattributed · \[run\]/m);
|
||||
assert.match(body, /<summary>Capture issues \(2\)<\/summary>/);
|
||||
assert.match(body, /\n- Base · [^\n]+ · CAPTURE\\_LANDING\\_UNVERIFIED/);
|
||||
assert.doesNotMatch(body, /⏳|capturing|Needs review/);
|
||||
});
|
||||
|
||||
test("report publication separates credential, permission, rate limit, and service failures", async t => {
|
||||
@@ -209,7 +209,7 @@ test("stale PRs, expired artifacts, foreign artifacts, and replayed attempts can
|
||||
await publishCiReportComment({ inputPath, artifactUrl, environment, transport: moved.transport });
|
||||
const movedBody = JSON.parse(moved.calls.find(call => call.options.method === "POST").options.body).body;
|
||||
assert.match(movedBody, /Previous runs \(1\)/, "a PR that moved on still gets its report, under previous runs");
|
||||
assert.doesNotMatch(movedBody, /^<sub>base \[/m);
|
||||
assert.match(movedBody, /^### Explore review$/m, "nothing is presented as the current review");
|
||||
for (const configuration of [{ expired: true }, { artifactName: "explore-capture-evidence-1" },
|
||||
{ artifactRun: 11 }, { attempt: 2 }]) {
|
||||
const { transport, calls } = transportFixture(configuration);
|
||||
|
||||
@@ -82,6 +82,10 @@ test("visual diff data from a report is validated before the viewer draws it", (
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 2 }), { regions: [], ignoredStatusBarRegions: 2 });
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 0 }), { regions: [] });
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: "2" }), { regions: [] });
|
||||
const pill = { kind: "status-bar", x: 84.55, y: 12.24, width: 10.3, height: 10.62 };
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 1, systemRegions: [pill, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }] }),
|
||||
{ regions: [], ignoredStatusBarRegions: 1, systemRegions: [pill, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }] });
|
||||
assert.deepEqual(visualDiff({ regions: [], systemRegions: [{ kind: "notch", x: 0, y: 0, width: 10, height: 10 }, { ...pill, width: 0 }, { ...pill, x: 101 }, "pill"] }), { regions: [] });
|
||||
assert.equal(visualDiff({ regions: Array.from({ length: 200 }, () => PAYWALL[0]) }).regions.length, 64);
|
||||
});
|
||||
|
||||
|
||||
@@ -45,3 +45,12 @@ test("What changed summarizes a screen whose every area moved, per direction, an
|
||||
assert.equal(layoutShiftSummary([...moved, ...groupVisualRegions([region(90, 3)])]), undefined);
|
||||
assert.equal(layoutShiftSummary([]), undefined);
|
||||
});
|
||||
|
||||
test("the Viewer keeps a move hundreds of pixels long: a card recentred on a wide screen", async () => {
|
||||
const { visualDiff } = await tsImport("../../viewer/src/utils/review-model.ts", import.meta.url);
|
||||
const parsed = visualDiff({ regions: [{ x: 31.2, y: 21.2, width: 37.6, height: 70.3, share: 63, move: { x: 13.8, y: 0, amount: { x: 395, y: 0 }, unit: "pt" } }], allRegionsMoved: true });
|
||||
assert.deepEqual(parsed?.regions[0]?.move, { x: 13.8, y: 0, amount: { x: 395, y: 0 }, unit: "pt" });
|
||||
// An offset is a percent of the image and still bounded by it; the amount only by the review's own limit.
|
||||
assert.equal(visualDiff({ regions: [{ x: 1, y: 1, width: 10, height: 10, share: 50, move: { x: 140, y: 0, amount: { x: 395, y: 0 }, unit: "pt" } }] })?.regions[0]?.move, undefined);
|
||||
assert.equal(visualDiff({ regions: [{ x: 1, y: 1, width: 10, height: 10, share: 50, move: { x: 1, y: 0, amount: { x: 9000, y: 0 }, unit: "pt" } }] })?.regions[0]?.move, undefined);
|
||||
});
|
||||
@@ -175,7 +175,7 @@ test("failure comments use actionable capture diagnostics and update only the bo
|
||||
assert.equal(writes.length, 1);
|
||||
assert.equal(writes[0].action, "update");
|
||||
assert.equal(writes[0].comment_id, 3);
|
||||
assert.match(writes[0].body, /\| iOS \| [^|]*\| 🟥 failed · capture\\-head \|/);
|
||||
assert.match(writes[0].body, /^\*\*iOS failed\*\* · capture\\-head · /m);
|
||||
assert.match(writes[0].body, /APP\\_INPUT\\_MISSING/);
|
||||
assert.match(writes[0].body, /Required app input is missing/);
|
||||
assert.match(writes[0].body, /Next action\\: Set APP\\_REVIEW\\_PASSWORD/);
|
||||
@@ -232,7 +232,7 @@ test("closed, draft, and forked PRs receive no failure comment; a PR that moved
|
||||
const [write] = Object.assign([], await reportFailure(t, { capture: sampleDiagnostic(), pr: moved }));
|
||||
assert.match(write.body, /<summary>Previous runs \(1\)<\/summary>/);
|
||||
assert.match(write.body, /bbbbbbbb.*iOS 🟥 failed · capture\\-head/);
|
||||
assert.doesNotMatch(write.body, /^<sub>base \[/m);
|
||||
assert.match(write.body, /^### Explore review$/m);
|
||||
const invalid = await reportFailure(t, { capture: sampleDiagnostic(), head: "not-a-sha" });
|
||||
assert.deepEqual([...invalid], []);
|
||||
});
|
||||
@@ -249,14 +249,14 @@ test("a failed platform joins the other platform's row in a multi-platform comme
|
||||
const comments = [{ id: 7, user: { login: "github-actions[bot]" }, body: existing }];
|
||||
const [write] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "android", comments });
|
||||
assert.equal(write.comment_id, 7);
|
||||
assert.match(write.body, /\| iOS \| [^|]*\| ⏳ capturing head 1\/2 \|/);
|
||||
assert.match(write.body, /\| Android \| [^|]*\| 🟥 failed · capture\\-head \|/);
|
||||
assert.match(write.body, /^iOS · capturing head 1\/2 · \[run\]/m);
|
||||
assert.match(write.body, /^\*\*Android failed\*\* · capture\\-head · /m);
|
||||
assert.match(write.body, /APP\\_INPUT\\_MISSING/);
|
||||
assert.equal(write.body.split("<!-- expo-explore-ci -->").length, 2);
|
||||
// A comment without records (a legacy layout) is replaced by the failure alone.
|
||||
const [whole] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "android", comments: [{ id: 8, user: { login: "github-actions[bot]" }, body: "<!-- expo-explore-ci -->\nPrevious run" }] });
|
||||
assert.match(whole.body, /^<!-- expo-explore-ci -->\n<!-- expo-explore-record:android:/);
|
||||
assert.doesNotMatch(whole.body, /\| iOS \|/);
|
||||
assert.doesNotMatch(whole.body, /iOS/);
|
||||
});
|
||||
|
||||
test("a failed target is named by its artifact and keeps the label and config order its capture record posted", async t => {
|
||||
@@ -276,14 +276,13 @@ test("a failed target is named by its artifact and keeps the label and config or
|
||||
const [write] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "duo-open", comments: [{ id: 7, user: { login: "github-actions[bot]" }, body: existing }] });
|
||||
assert.equal(write.comment_id, 7);
|
||||
assert.match(write.body, /^<!-- expo-explore-record:duo-open:/m);
|
||||
const lines = write.body.split("\n"), header = lines.indexOf("| | Device | Result | Report |");
|
||||
const rows = lines.slice(header + 2, lines.indexOf("", header));
|
||||
assert.deepEqual(rows.map(line => line.split(" | ")[0].slice(2)), ["iPhone 17", "iPhone Duo \\(open\\)", "Pixel 7"], "config order, each target's own label");
|
||||
assert.match(write.body, /\| iPhone Duo \\\(open\\\) \| [^|]*\| 🟥 failed · capture\\-head \|/);
|
||||
const subtitle = write.body.split("\n").find(line => line.startsWith("<sub>"));
|
||||
assert.deepEqual([...subtitle.matchAll(/(?:^<sub>|· )\[?(iPhone 17|iPhone Duo \\\(open\\\)|Pixel 7)/g)].map(match => match[1]), ["iPhone 17", "iPhone Duo \\(open\\)", "Pixel 7"], "config order, each target's own label");
|
||||
assert.match(write.body, /^\*\*iPhone Duo \\\(open\\\) failed\*\* · capture\\-head · /m);
|
||||
// A target the comment has not seen yet is labelled by its id.
|
||||
const [fresh] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "duo-closed" });
|
||||
assert.match(fresh.body, /^<!-- expo-explore-record:duo-closed:/m);
|
||||
assert.match(fresh.body, /\| duo\\-closed \| [^|]*\| 🟥 failed/);
|
||||
assert.match(fresh.body, /^\*\*duo\\-closed failed\*\* · /m);
|
||||
// Artifact directories: any valid id, never a reserved or malformed one.
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-failure-targets-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
|
||||
+16
-10
@@ -14,7 +14,7 @@ The Viewer verifies that a dropped ZIP is the report for the linked run attempt
|
||||
|
||||
## Environment
|
||||
|
||||
The central host reads no environment variables and holds no secrets. A preview deployment reads only the four `EXPLORE_PREVIEW_*` values sealed into it at deploy time (below).
|
||||
The central host reads no environment variables and holds no secrets. A preview deployment reads only the `EXPLORE_PREVIEW_*` values written into it at deploy time (below).
|
||||
|
||||
## Routes
|
||||
|
||||
@@ -25,22 +25,28 @@ The central host reads no environment variables and holds no secrets. A preview
|
||||
A hosted preview is one immutable EAS Hosting deployment per review, in the reviewed application's own EAS account, that opens the report without a download. Its export (`npm run export:preview`, written to `dist-preview/`) holds the identical staged Viewer under `/viewer/` and three API routes:
|
||||
|
||||
- `/p/<token>` serves the Viewer shell for exactly one 160-bit token (32 lowercase base32 characters) to requests that accept HTML; the shell's `#root` holds a text index of the report (title, counts, API links) until the Viewer renders, and a `Link` header names the JSON and Markdown alternates. Requests that do not prefer HTML (`Accept: */*`, `text/markdown`, `application/json`) get the same index as Markdown, so an agent handed the link finds the API by itself.
|
||||
- `/p/<token>/manifest.json` is what the Viewer opens: the report's metadata file (`review.json` or `exploration.json`) verbatim plus the size of every asset, decrypted from this deployment's own static files and ~12 KB over the wire; the shell preloads it so it downloads alongside the Viewer bundle. `/p/<token>/assets/<sha256>.<png|jpg|mp4>` serves one asset when the Viewer first shows it, `private, immutable` with a `max-age` of a week at most and never past the link's expiry, so this browser keeps it while shared caches never see it. Both answer `503` when the Worker cannot read the report at that moment, which the Viewer retries; `ci:deploy` checks that the manifest matches the deployed ZIP and that an asset serves its exact bytes. `/p/<token>/report.zip` still streams the whole decrypted ZIP (downloads, older Viewers). `/p/<token>/reports.json` lists the capture targets (up to 8, each with its platform and label) a multi-target deployment serves; `?target=<id>` selects one on every other route, and `?platform=<p>`, from links before targets, selects the target named `<p>`, else the first of that platform.
|
||||
- `/p/<token>/llms.txt` is the Markdown index at a fixed path, and `/p/<token>/api/v1/...` is the read-only agent API (`src/server/agent-api.ts`): summary, `/screens[?status=]`, `/screens/<id>`, `/transitions`, and for exploration reports `/journeys`, `/gaps`, `/frontier`, `/assets/<sha256>`, `/raw`, with `?limit=`/`?cursor=` paging (50 default, 200 max). The Worker decrypts and parses an archive when a request first needs it (`src/server/report-zip.ts` reads the stored PNGs and the deflated report JSON) and keeps the two most recently used in memory, plus every target's manifest; a manifest built for a report it is not keeping (the Viewer prefetches every target's) decrypts that report once and lets it go. The manifest and asset helpers live in `src/report/preview-manifest.ts`, shared with the local report server.
|
||||
- `/` and every other path, token, or method answer the same `404 Not found`, so a response never confirms that a deployment or token exists. After the sealed expiry the exact token still opens the Viewer shell for browsers, and every report route, including the Markdown index and the API, answers `410` with the expiry instant so the Viewer and agents can say the link expired.
|
||||
- `/p/<token>/manifest.json` is what the Viewer opens: the report's metadata file (`review.json` or `exploration.json`) verbatim plus the size of every asset, about 12 KB over the wire; the shell preloads it so it downloads alongside the Viewer bundle. The Worker answers it from its target's static manifest, passed through unparsed unless the isolate already holds it. `/p/<token>/reports.json` lists the capture targets (up to 8, each with its platform and label) a multi-target deployment serves; `?target=<id>` selects one on every other route, and `?platform=<p>`, from links before targets, selects the target named `<p>`, else the first of that platform.
|
||||
- `/p/<token>/llms.txt` is the Markdown index at a fixed path, and `/p/<token>/api/v1/...` is the read-only agent API (`src/server/agent-api.ts`): summary, `/screens[?status=]`, `/screens/<id>`, `/transitions`, and for exploration reports `/journeys`, `/gaps`, `/frontier`, `/assets/<sha256>`, `/raw`, with `?limit=`/`?cursor=` paging (50 default, 200 max). The Worker reads the target's static manifest when a request first needs it and keeps parsed manifests in memory within 32 MB; requests that arrive together share one fetch. `/api/v1/assets/<sha256>` reads the screenshot's static file.
|
||||
- `/` and every other path, token, or method answer the same `404 Not found`, so a response never confirms that a deployment or token exists. A static file the Worker cannot fetch this time answers `503`, which the Viewer retries.
|
||||
|
||||
`ci:deploy` seals the deployment by writing a deploy-time `.env` next to the export; EAS Hosting delivers it to the Worker and to nothing else:
|
||||
`ci:deploy` writes the report as static files of the deployment, under the token, and EAS Hosting serves them directly, before the Worker:
|
||||
|
||||
| Path | Content |
|
||||
| --- | --- |
|
||||
| `/p/<token>/targets/<target>.json` | one target's manifest (`report.json` for a single unlisted report), stamped with the deployment so `ci:deploy` can tell it from the one an alias still serves |
|
||||
| `/p/<token>/assets/<sha256>.<png\|jpg\|mp4>` | every screenshot and recording, once, shared by the targets that show it |
|
||||
|
||||
It also writes a deploy-time `.env` next to the export; EAS Hosting delivers it to the Worker and to nothing else:
|
||||
|
||||
| Variable | Value |
|
||||
| --- | --- |
|
||||
| `EXPLORE_PREVIEW_TOKEN` | the path token in the review comment's **Explore report** link |
|
||||
| `EXPLORE_PREVIEW_KEY` | base64 AES-256-GCM key, generated per deployment |
|
||||
| `EXPLORE_PREVIEW_EXPIRES_AT` | ISO 8601 instant; the report routes answer 410 from then on (unset: the link does not expire) |
|
||||
| `EXPLORE_PREVIEW_REPORT` | `/_report/<id>/report.zip.enc`, the ciphertext's static path |
|
||||
| `EXPLORE_PREVIEW_REPORT` | `/p/<token>/targets/report.json` (a single iOS report), or |
|
||||
| `EXPLORE_PREVIEW_REPORTS` | JSON listing each target, its platform, label, change count and device, and its manifest's path |
|
||||
|
||||
The report is encrypted before upload (12-byte IV, then AES-GCM ciphertext and tag, additional data `expo-explore-preview/1`) and the key never leaves the deployment environment, so the CDN serves only ciphertext and a token that leaks into a request log does not leak the report. A preview link is still a bearer link: anyone who has it can open the report until it expires. Expo account members who can read the project's deployments are inside that trust boundary. Report bytes are never embedded in the Worker bundle, because a deleted deployment's static files disappear within seconds while its Worker can keep answering for a few minutes.
|
||||
Nothing is encrypted: what keeps a report private is the 160-bit token in every path, the same as for the link itself. A preview link is a bearer link: anyone who has it can open the report until the deployment is deleted (EAS Hosting deletes one without an alias after 30 days on Free and 90 on paid plans), and Expo account members who can read the project's deployments are inside that trust boundary. Explore sets no expiry; `EXPLORE_PREVIEW_KEY` and `EXPLORE_PREVIEW_EXPIRES_AT` from earlier deployments belong to those deployments' own Workers.
|
||||
|
||||
`npm run verify:export:preview` loads the exported route bundles and checks the token, expiry, decryption, content negotiation, agent API, and 404 behavior against the sealed example report.
|
||||
`npm run verify:export:preview` loads the exported route bundles and checks the token, the manifest route, content negotiation, the agent API (including a screenshot read from its static file), and 404 behavior against the example report laid out as `ci:deploy` writes it.
|
||||
|
||||
## Validation and deployment
|
||||
|
||||
|
||||
@@ -79,32 +79,29 @@ if (!preview) {
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// A preview deployment answers only its own token and serves the report decrypted from its own
|
||||
// static ciphertext until it expires (then the report route says 410); everything else is the same 404.
|
||||
// A preview deployment answers only its own token. ci:deploy writes the report as static files under it, which EAS
|
||||
// Hosting serves without the Worker; the Worker reads the manifest back for the shell's index and the agent API, and
|
||||
// everything else is the same 404.
|
||||
const token = "abcdefghijklmnopqrstuvwxyz234567";
|
||||
const keyBytes = webcrypto.getRandomValues(new Uint8Array(32));
|
||||
const reportPath = "/_report/abcdefghijklmnop/report.zip.enc";
|
||||
// A recorded PR review, so the exported Worker is seen to inflate the archive and answer the agent API.
|
||||
const plain = new Uint8Array(await readFile(new URL("../../test/fixtures/example-review-artifact.zip", import.meta.url)));
|
||||
const key = await webcrypto.subtle.importKey("raw", keyBytes, "AES-GCM", false, ["encrypt"]);
|
||||
const iv = webcrypto.getRandomValues(new Uint8Array(12));
|
||||
const cipher = new Uint8Array(await webcrypto.subtle.encrypt({ name: "AES-GCM", iv, additionalData: new TextEncoder().encode("expo-explore-preview/1") }, key, plain));
|
||||
const sealed = new Uint8Array(iv.byteLength + cipher.byteLength);
|
||||
sealed.set(iv); sealed.set(cipher, iv.byteLength);
|
||||
const env = {
|
||||
EXPLORE_PREVIEW_TOKEN: token,
|
||||
EXPLORE_PREVIEW_KEY: Buffer.from(keyBytes).toString("base64"),
|
||||
EXPLORE_PREVIEW_EXPIRES_AT: new Date(Date.now() + 60_000).toISOString(),
|
||||
EXPLORE_PREVIEW_REPORT: reportPath,
|
||||
};
|
||||
const reportPath = `/p/${token}/targets/report.json`;
|
||||
// A recorded PR review, laid out as ci:deploy writes it, so the exported Worker is seen to read it and answer the agent API.
|
||||
const { tsImport } = await import("tsx/esm/api");
|
||||
const { loadReport } = await tsImport("../../src/report/agent-api.ts", import.meta.url);
|
||||
const { manifestBody, PREVIEW_ASSET } = await tsImport("../../src/report/preview-manifest.ts", import.meta.url);
|
||||
const loaded = await loadReport(new Uint8Array(await readFile(new URL("../../test/fixtures/example-review-artifact.zip", import.meta.url))));
|
||||
const manifest = manifestBody(loaded, "verifyexport");
|
||||
const files = new Map([[reportPath, new TextEncoder().encode(manifest)]]);
|
||||
for (const name of loaded.entries.keys()) if (PREVIEW_ASSET.test(name)) files.set(`/p/${token}/${name}`, await loaded.read(name, 64 * 1024 * 1024));
|
||||
const env = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_REPORT: reportPath };
|
||||
const origin = "https://acme-explore--deploy.expo.app";
|
||||
const fetched = [];
|
||||
const fetchStub = async (input) => {
|
||||
const url = new URL(typeof input === "string" ? input : input.url);
|
||||
fetched.push(url.href);
|
||||
return url.pathname === reportPath ? new Response(sealed) : new Response("missing", { status: 404 });
|
||||
fetched.push(url.pathname);
|
||||
const body = files.get(url.pathname);
|
||||
return body ? new Response(body, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
|
||||
};
|
||||
const globals = { fetch: fetchStub, crypto: webcrypto, TextDecoder, Blob, DecompressionStream };
|
||||
const globals = { fetch: fetchStub, crypto: webcrypto, TextDecoder, TextEncoder, Blob, DecompressionStream };
|
||||
|
||||
const index = loadRoute("/index", env, globals);
|
||||
for (const method of ["GET", "HEAD", "POST", "OPTIONS"]) {
|
||||
@@ -125,31 +122,30 @@ if (!preview) {
|
||||
throw new Error(`Preview page ${path} must serve the Markdown index when HTML is not requested`);
|
||||
}
|
||||
}
|
||||
const served = await handlers.GET(new Request(`${origin}/p/${token}/manifest.json`));
|
||||
if (served.status !== 200 || await served.text() !== manifest) throw new Error(`Preview route ${page} must answer the static manifest the Viewer opens`);
|
||||
const summary = await handlers.GET(new Request(`${origin}/p/${token}/api/v1`));
|
||||
if (summary.status !== 200 || (await summary.json()).kind !== "pr-review") throw new Error(`Preview route ${page} must answer the agent API summary`);
|
||||
const changed = await handlers.GET(new Request(`${origin}/p/${token}/api/v1/screens?status=modified`));
|
||||
if (changed.status !== 200 || !((await changed.json()).total > 0)) throw new Error(`Preview route ${page} must list modified screens`);
|
||||
if (!(await (await handlers.GET(new Request(`${origin}/p/${token}/llms.txt`))).text()).startsWith("# Expo Explore report")) throw new Error(`Preview route ${page} must serve llms.txt`);
|
||||
const zip = await handlers.GET(new Request(`${origin}/p/${token}/report.zip`));
|
||||
if (zip.status !== 200 || zip.headers.get("content-type") !== "application/zip"
|
||||
|| Buffer.compare(Buffer.from(await zip.arrayBuffer()), Buffer.from(plain)) !== 0) {
|
||||
throw new Error(`Preview report route ${page} must stream the decrypted report`);
|
||||
const sha = [...loaded.entries.keys()].map(name => /^assets\/([a-f0-9]{64})\.png$/.exec(name)?.[1]).find(Boolean);
|
||||
const image = await handlers.GET(new Request(`${origin}/p/${token}/api/v1/assets/${sha}`));
|
||||
if (image.status !== 200 || Buffer.compare(Buffer.from(await image.arrayBuffer()), Buffer.from(files.get(`/p/${token}/assets/${sha}.png`))) !== 0) {
|
||||
throw new Error(`Preview route ${page} must serve a screenshot to the agent API from the static file`);
|
||||
}
|
||||
for (const path of [`/p/${token.replace("a", "b")}`, `/p/${token.replace("a", "b")}/report.zip`, `/p/${token.replace("a", "b")}/api/v1`, `/p/${token}/viewer/index.html`, `/p/${token}/other`, `/p/${token}/api/v1/other`, `/p/${token}/api/v2`, "/p/", `/P/${token}`]) {
|
||||
// Screenshots and manifests are static files EAS Hosting serves itself; the Worker answers none of their paths.
|
||||
for (const path of [`/p/${token.replace("a", "b")}`, `/p/${token.replace("a", "b")}/manifest.json`, `/p/${token.replace("a", "b")}/api/v1`, `/p/${token}/report.zip`,
|
||||
`/p/${token}/targets/report.json`, `/p/${token}/assets/${sha}.png`, `/p/${token}/viewer/index.html`, `/p/${token}/other`, `/p/${token}/api/v1/other`, `/p/${token}/api/v2`, "/p/", `/P/${token}`]) {
|
||||
if ((await handlers.GET(new Request(origin + path))).status !== 404) throw new Error(`Preview route ${page} incorrectly accepts ${path}`);
|
||||
}
|
||||
for (const method of ["HEAD", "POST", "PUT", "DELETE", "OPTIONS"]) {
|
||||
if ((await handlers[method](new Request(`${origin}/p/${token}`, { method }))).status !== 404) throw new Error(`Preview route ${page} must answer 404 to ${method}`);
|
||||
}
|
||||
const expired = loadRoute(page, { ...env, EXPLORE_PREVIEW_EXPIRES_AT: new Date(Date.now() - 1000).toISOString() }, globals);
|
||||
if ((await expired.GET(new Request(`${origin}/p/${token}`, { headers: { accept: "text/html" } }))).status !== 200) throw new Error(`Preview route ${page} must keep opening the Viewer after expiry`);
|
||||
for (const path of [`/p/${token}`, `/p/${token}/report.zip`, `/p/${token}/api/v1`, `/p/${token}/llms.txt`]) {
|
||||
if ((await expired.GET(new Request(origin + path))).status !== 410) throw new Error(`Preview route ${page} must answer 410 for ${path} after expiry`);
|
||||
}
|
||||
const unsealed = loadRoute(page, {}, globals);
|
||||
if ((await unsealed.GET(new Request(`${origin}/p/${token}`))).status !== 404) throw new Error(`Preview route ${page} must refuse to serve without a sealed configuration`);
|
||||
const unconfigured = loadRoute(page, {}, globals);
|
||||
if ((await unconfigured.GET(new Request(`${origin}/p/${token}`))).status !== 404) throw new Error(`Preview route ${page} must refuse to serve without a configuration`);
|
||||
}
|
||||
if (fetched.some(href => !href.endsWith(reportPath))) throw new Error("Preview routes fetched something other than the sealed report path");
|
||||
if (fetched.some(path => !path.startsWith(`/p/${token}/`))) throw new Error("Preview routes fetched something other than the deployment's own report files");
|
||||
}
|
||||
|
||||
process.stdout.write(
|
||||
|
||||
+130
-233
@@ -1,35 +1,32 @@
|
||||
/**
|
||||
* One hosted preview deployment per review: the Worker gates everything under `/p/<token>` with
|
||||
* a token and an expiry sealed into the deployment's environment at deploy time, fetches the
|
||||
* AES-256-GCM encrypted report from its own static files, decrypts it with a key that exists
|
||||
* only in that environment, and streams it. Static files on the CDN are ciphertext; the Viewer
|
||||
* bundle under /viewer/ is public and identical to the central host's.
|
||||
* One hosted preview deployment per review. `ci:deploy` writes the report as static files of the deployment under the
|
||||
* link's token: each target's manifest at `/p/<token>/targets/<target>.json` and every screenshot at
|
||||
* `/p/<token>/assets/<sha256>.<ext>`. EAS Hosting serves those files directly; nothing encrypts them, and what keeps
|
||||
* them private is the 160-bit token in their path. This Worker answers the rest of `/p/<token>`: the Viewer shell,
|
||||
* the manifest the Viewer asks for by target, the target list, and the agent API. The Viewer bundle under /viewer/ is
|
||||
* public and identical to the central host's.
|
||||
*/
|
||||
import { AGENT_API_VERSION, agentApiReply, agentIndexHtml, agentIndexMarkdown, loadReport, prefersHtml, type AgentContext, type LoadedReport } from "../../../src/report/agent-api";
|
||||
import { manifestBody, previewAsset } from "../../../src/report/preview-manifest";
|
||||
import { AGENT_API_VERSION, agentApiReply, agentIndexHtml, agentIndexMarkdown, prefersHtml, type AgentContext, type LoadedReport } from "../../../src/report/agent-api";
|
||||
import { MAX_ASSET_BYTES, MAX_MANIFEST_BYTES, reportFromManifest } from "../../../src/report/preview-manifest";
|
||||
|
||||
export type PreviewEnvironment = {
|
||||
/** Lowercase base32 path token the review comment links to. */
|
||||
EXPLORE_PREVIEW_TOKEN?: string | undefined;
|
||||
/** Base64 32-byte AES-GCM key. */
|
||||
EXPLORE_PREVIEW_KEY?: string | undefined;
|
||||
/** ISO 8601 instant after which the report routes answer 410 and the token page says the link expired; unset: never. */
|
||||
EXPLORE_PREVIEW_EXPIRES_AT?: string | undefined;
|
||||
/** Absolute path of the encrypted report inside this deployment, e.g. /_report/<id>/report.zip.enc (single-report deployments). */
|
||||
/** Path of the report's manifest inside this deployment, `/p/<token>/targets/report.json` (single-report deployments). */
|
||||
EXPLORE_PREVIEW_REPORT?: string | undefined;
|
||||
/**
|
||||
* JSON, one entry per capture target in config order:
|
||||
* `[{"target":"duo-open","platform":"ios","label":"iPhone Duo (open)","path":"/_report/<id>/duo-open.zip.enc","changes":3,"device":"iPhone Duo 26.0"}]`.
|
||||
* Deployments from before targets list `{"platform":"ios","path":"/_report/<id>/ios.zip.enc",…}`: the target is the platform.
|
||||
* `[{"target":"duo-open","platform":"ios","label":"iPhone Duo (open)","path":"/p/<token>/targets/duo-open.json","changes":3,"device":"iPhone Duo 26.0"}]`.
|
||||
* Deployments from before targets list `{"platform":"ios","path":"/p/<token>/targets/ios.json",…}`: the target is the platform.
|
||||
* Set instead of EXPLORE_PREVIEW_REPORT by deployments that serve several reports (or one that is not iOS).
|
||||
*/
|
||||
EXPLORE_PREVIEW_REPORTS?: string | undefined;
|
||||
};
|
||||
|
||||
export type PreviewPlatform = "ios" | "android";
|
||||
/** `target` names the report (and its file, `<target>.zip.enc`); `platform` is the device's. */
|
||||
/** `target` names the report (and its manifest, `targets/<target>.json`); `platform` is the device's. */
|
||||
export type PreviewReport = { target: string; platform: PreviewPlatform; label?: string; path: string; changes?: number; device?: string };
|
||||
export type PreviewConfig = { token: string; key: Uint8Array<ArrayBuffer>; expiresAt: number | null; reports: PreviewReport[] };
|
||||
export type PreviewConfig = { token: string; reports: PreviewReport[] };
|
||||
|
||||
export const PREVIEW_TOKEN = /^[a-z2-7]{32}$/;
|
||||
/** A capture target id, as the CLI's isTargetId accepts it: the Worker does not bundle the config reader. */
|
||||
@@ -37,20 +34,26 @@ const TARGET_ID = /^[a-z][a-z0-9-]{0,31}$/;
|
||||
export function isPreviewTargetId(value: unknown): value is string {
|
||||
return typeof value === "string" && TARGET_ID.test(value) && !["base", "head", "report"].includes(value) && !value.startsWith("install-");
|
||||
}
|
||||
const REPORT_PATH = /^\/_report\/[a-z2-7]{16,64}\/(report|[a-z][a-z0-9-]{0,31})\.zip\.enc$/;
|
||||
const REPORT_PATH = /^\/p\/([a-z2-7]{32})\/targets\/(report|[a-z][a-z0-9-]{0,31})\.json$/;
|
||||
const PLATFORMS: readonly PreviewPlatform[] = ["ios", "android"];
|
||||
/** As many targets as a config may name. */
|
||||
export const MAX_PREVIEW_REPORTS = 8;
|
||||
const PLAIN_TEXT = /[\u0000-\u001f\u007f<>[\]]/;
|
||||
|
||||
/** The target a manifest path names, when it is a manifest of this token's deployment. */
|
||||
function pathTarget(path: unknown, token: string): string | undefined {
|
||||
const match = typeof path === "string" ? REPORT_PATH.exec(path) : null;
|
||||
return match && match[1] === token ? match[2] : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* The report list, strictly shaped: an unknown platform, an invalid or repeated target, a path that is not
|
||||
* `<target>.zip.enc`, an odd label or device, or extra keys reject the whole configuration.
|
||||
* The report list, strictly shaped: an unknown platform, an invalid or repeated target, a path that is not this token's
|
||||
* `targets/<target>.json`, an odd label or device, or extra keys reject the whole configuration.
|
||||
*/
|
||||
function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
|
||||
function parseReports(env: PreviewEnvironment, token: string): PreviewReport[] | undefined {
|
||||
if (env.EXPLORE_PREVIEW_REPORTS === undefined) {
|
||||
const reportPath = env.EXPLORE_PREVIEW_REPORT ?? "";
|
||||
return REPORT_PATH.test(reportPath) ? [{ target: "ios", platform: "ios", path: reportPath }] : undefined;
|
||||
return pathTarget(reportPath, token) === "report" ? [{ target: "ios", platform: "ios", path: reportPath }] : undefined;
|
||||
}
|
||||
if (env.EXPLORE_PREVIEW_REPORT !== undefined || env.EXPLORE_PREVIEW_REPORTS.length > 8192) return undefined;
|
||||
let parsed: unknown;
|
||||
@@ -63,7 +66,7 @@ function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
|
||||
// Listings from before targets name each report by its platform.
|
||||
const { target = platform, ...extra } = rest;
|
||||
if (Object.keys(extra).length || !PLATFORMS.includes(platform as PreviewPlatform) || !isPreviewTargetId(target)) return undefined;
|
||||
if (typeof path !== "string" || REPORT_PATH.exec(path)?.[1] !== target) return undefined;
|
||||
if (typeof path !== "string" || pathTarget(path, token) !== target) return undefined;
|
||||
if (changes !== undefined && (typeof changes !== "number" || !Number.isInteger(changes) || changes < 0 || changes > 100_000)) return undefined;
|
||||
if (device !== undefined && (typeof device !== "string" || device.length > 120 || PLAIN_TEXT.test(device))) return undefined;
|
||||
if (label !== undefined && (typeof label !== "string" || !label.trim() || label.length > 80 || PLAIN_TEXT.test(label))) return undefined;
|
||||
@@ -73,28 +76,13 @@ function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
|
||||
}
|
||||
return reports;
|
||||
}
|
||||
/** 12-byte IV followed by the AES-GCM ciphertext and tag; `aad` binds the bytes to this format. */
|
||||
export const PREVIEW_CIPHER = { ivBytes: 12, aad: "expo-explore-preview/1" } as const;
|
||||
const MAX_REPORT_BYTES = 256 * 1024 * 1024;
|
||||
|
||||
function decodeBase64(value: string): Uint8Array<ArrayBuffer> | undefined {
|
||||
if (!/^[A-Za-z0-9+/]+={0,2}$/.test(value)) return undefined;
|
||||
try {
|
||||
const binary = atob(value);
|
||||
const bytes = new Uint8Array(binary.length);
|
||||
for (let index = 0; index < binary.length; index += 1) bytes[index] = binary.charCodeAt(index);
|
||||
return bytes;
|
||||
} catch { return undefined; }
|
||||
}
|
||||
|
||||
/** The deployment's sealed configuration, or undefined when any value is missing or malformed. */
|
||||
/** The deployment's configuration, or undefined when any value is missing or malformed. */
|
||||
export function previewConfig(env: PreviewEnvironment): PreviewConfig | undefined {
|
||||
const token = env.EXPLORE_PREVIEW_TOKEN ?? "";
|
||||
const key = decodeBase64(env.EXPLORE_PREVIEW_KEY ?? "");
|
||||
const expiresAt = env.EXPLORE_PREVIEW_EXPIRES_AT === undefined ? null : Date.parse(env.EXPLORE_PREVIEW_EXPIRES_AT);
|
||||
const reports = parseReports(env);
|
||||
if (!PREVIEW_TOKEN.test(token) || !key || key.byteLength !== 32 || (expiresAt !== null && !Number.isFinite(expiresAt)) || !reports) return undefined;
|
||||
return { token, key, expiresAt, reports };
|
||||
if (!PREVIEW_TOKEN.test(token)) return undefined;
|
||||
const reports = parseReports(env, token);
|
||||
return reports ? { token, reports } : undefined;
|
||||
}
|
||||
|
||||
function baseHeaders(contentType: string): Headers {
|
||||
@@ -113,9 +101,11 @@ export function previewNotFound(): Response {
|
||||
return new Response("Not found", { status: 404, headers: baseHeaders("text/plain; charset=utf-8") });
|
||||
}
|
||||
|
||||
/** After the sealed expiry the token page still opens, and the report routes say so instead of serving. */
|
||||
export function previewExpired(expiredAt: number): Response {
|
||||
return new Response(JSON.stringify({ error: "expired", expiredAt: new Date(expiredAt).toISOString() }), { status: 410, headers: baseHeaders("application/json; charset=utf-8") });
|
||||
/** A route whose static file could not be fetched this time; the same request works once it can, and the Viewer retries. */
|
||||
function previewUnavailable(): Response {
|
||||
const headers = baseHeaders("text/plain; charset=utf-8");
|
||||
headers.set("Retry-After", "1");
|
||||
return new Response("Unavailable", { status: 503, headers });
|
||||
}
|
||||
|
||||
/** Constant-time comparison of two equal-length ASCII tokens. */
|
||||
@@ -126,63 +116,38 @@ function sameToken(a: string, b: string): boolean {
|
||||
return difference === 0;
|
||||
}
|
||||
|
||||
/** A parsed manifest, kept so the shell and the agent API do not fetch and parse it on every request. */
|
||||
type ParsedManifest = { bytes: Uint8Array; loaded: LoadedReport };
|
||||
type ManifestResult = ParsedManifest | "unavailable" | undefined;
|
||||
|
||||
export type PreviewRequestOptions = {
|
||||
env: PreviewEnvironment;
|
||||
indexHtml: string;
|
||||
now?: () => number;
|
||||
/** Same-deployment fetch of static files; defaults to the global fetch. */
|
||||
fetchImpl?: typeof fetch;
|
||||
subtle?: SubtleCrypto;
|
||||
/** Decrypted and parsed reports by path, least recently used first, within HELD_REPORT_BYTES; defaults to a module-level cache. */
|
||||
cache?: Map<string, LoadedReport>;
|
||||
/** Decrypts in flight by path, shared by the requests that wait for them; defaults to a module-level map. */
|
||||
loading?: Map<string, Promise<LoadResult>>;
|
||||
/** Reports too large to decrypt in this isolate, by path; defaults to a module-level set. */
|
||||
oversized?: Set<string>;
|
||||
/** Bytes of decrypted reports kept, and of kept reports plus one decrypt; default to HELD_REPORT_BYTES and DECRYPT_PEAK_BYTES. */
|
||||
budget?: { held: number; peak: number };
|
||||
/** Manifest bodies by path, kept for the life of the isolate; defaults to a module-level cache. */
|
||||
manifests?: Map<string, string>;
|
||||
/** Parsed manifests by path, least recently used first, within MANIFEST_CACHE_BYTES; defaults to a module-level cache. */
|
||||
cache?: Map<string, ParsedManifest>;
|
||||
/** Manifest fetches in flight by path, shared by the requests waiting for them; defaults to a module-level map. */
|
||||
loading?: Map<string, Promise<ManifestResult>>;
|
||||
};
|
||||
|
||||
const ROUTE = /^\/p\/([a-z2-7]{32})(?:\/|\/(report\.zip|reports\.json|manifest\.json|llms\.txt)|(\/api\/v1(?:\/[A-Za-z0-9._:@-]{1,200}){0,2}\/?)|\/assets\/([a-f0-9]{64}\.(?:png|jpg|mp4)))?$/;
|
||||
/**
|
||||
* Content-addressed and token-gated: this browser may keep an asset until the link expires, and for a week at most (as
|
||||
* long as the Viewer kept a whole report in Cache Storage before assets were served one by one); shared caches may not.
|
||||
*/
|
||||
const MAX_ASSET_AGE_SECONDS = 7 * 24 * 60 * 60;
|
||||
function assetCacheControl(expiresAt: number | null, now: number): string {
|
||||
const untilExpiry = expiresAt === null ? MAX_ASSET_AGE_SECONDS : Math.floor((expiresAt - now) / 1000);
|
||||
return `private, max-age=${Math.max(0, Math.min(MAX_ASSET_AGE_SECONDS, untilExpiry))}, immutable`;
|
||||
}
|
||||
/**
|
||||
* An isolate has 128 MB. It keeps decrypted reports, least recently used first, within HELD_REPORT_BYTES, and every
|
||||
* target's manifest (a few MB each at most). Decrypting needs the ciphertext and the plaintext at once, so decrypts run
|
||||
* one at a time, and before each one older reports go until the two fit in DECRYPT_PEAK_BYTES with what is kept. A
|
||||
* report too large to keep is decrypted for each request; one too large to decrypt (about 45 MB) answers 413, and the
|
||||
* isolate remembers it so it does not fetch it again.
|
||||
*/
|
||||
const HELD_REPORT_BYTES = 60 * 1024 * 1024;
|
||||
const DECRYPT_PEAK_BYTES = 90 * 1024 * 1024;
|
||||
/** A decrypted report, or why there is none: "unavailable" this time (the Viewer retries), "too-large" for this isolate, undefined never. */
|
||||
type LoadResult = LoadedReport | "unavailable" | "too-large" | undefined;
|
||||
const reportCache = new Map<string, LoadedReport>();
|
||||
const reportLoading = new Map<string, Promise<LoadResult>>();
|
||||
const manifestCache = new Map<string, string>();
|
||||
const oversizedReports = new Set<string>();
|
||||
let decrypting: Promise<unknown> = Promise.resolve();
|
||||
const ROUTE = /^\/p\/([a-z2-7]{32})(?:\/|\/(reports\.json|manifest\.json|llms\.txt)|(\/api\/v1(?:\/[A-Za-z0-9._:@-]{1,200}){0,2}\/?))?$/;
|
||||
/** Parsed manifests are kept within this much of the isolate's 128 MB. */
|
||||
const MANIFEST_CACHE_BYTES = 32 * 1024 * 1024;
|
||||
/** What a kept manifest holds: its bytes, and its parsed metadata at about 1.6 times their size. */
|
||||
const heldBytes = (manifest: ParsedManifest) => 3 * manifest.bytes.byteLength;
|
||||
const manifestCache = new Map<string, ParsedManifest>();
|
||||
const manifestLoading = new Map<string, Promise<ManifestResult>>();
|
||||
|
||||
/**
|
||||
* `GET /p/<token>` serves the Viewer shell to browsers and the report's Markdown index to anything
|
||||
* that does not ask for HTML (agents fetch with `Accept: text/markdown` or `*/*`); the shell itself
|
||||
* carries that index as text inside `#root` until the Viewer hydrates, and a `Link` header names the
|
||||
* JSON API. `GET /p/<token>/report.zip` streams the decrypted report (`?target=`, or `?platform=` in older
|
||||
* JSON API. `GET /p/<token>/manifest.json` answers one target's manifest (`?target=`, or `?platform=` in older
|
||||
* links, selects one of several; the first listed otherwise), `GET /p/<token>/reports.json` lists the targets the
|
||||
* deployment serves, `GET /p/<token>/llms.txt` is the Markdown index, and `GET /p/<token>/api/v1/...`
|
||||
* answers the agent API (see agent-api.ts). Every other method, path, or token is an identical 404,
|
||||
* so the response never confirms that a deployment or token exists. After the sealed expiry the exact
|
||||
* token still opens the Viewer shell, and the report routes answer 410 with the expiry instant, so the
|
||||
* Viewer can say the link expired rather than guess.
|
||||
* answers the agent API (see agent-api.ts). Screenshots are static files the Worker never sees. Every other method,
|
||||
* path, or token is an identical 404, so the response never confirms that a deployment or token exists.
|
||||
*/
|
||||
export async function previewResponse(request: Request, options: PreviewRequestOptions): Promise<Response> {
|
||||
const config = previewConfig(options.env);
|
||||
@@ -191,8 +156,7 @@ export async function previewResponse(request: Request, options: PreviewRequestO
|
||||
const url = new URL(request.url);
|
||||
const match = ROUTE.exec(url.pathname);
|
||||
if (!match || !sameToken(match[1]!, config.token)) return previewNotFound();
|
||||
const route = match[2] ?? (match[3] ? "api" : match[4] ? "asset" : undefined);
|
||||
const expired = config.expiresAt !== null && (options.now ?? Date.now)() >= config.expiresAt;
|
||||
const route = match[2] ?? (match[3] ? "api" : undefined);
|
||||
const pageUrl = `${url.origin}/p/${config.token}`;
|
||||
const linkHeader = `<${pageUrl}/api/${AGENT_API_VERSION}>; rel="alternate"; type="application/json", <${pageUrl}/llms.txt>; rel="alternate"; type="text/markdown"`;
|
||||
const accept = request.headers.get("accept");
|
||||
@@ -200,50 +164,37 @@ export async function previewResponse(request: Request, options: PreviewRequestO
|
||||
const headers = baseHeaders("text/html; charset=utf-8");
|
||||
headers.set("Link", linkHeader);
|
||||
headers.set("Vary", "Accept");
|
||||
if (expired) return new Response(options.indexHtml, { headers });
|
||||
const selected = selectReport(config, url);
|
||||
const loaded = await loadedReport(url.origin, selected, config, options);
|
||||
if (!loaded || typeof loaded === "string") return new Response(options.indexHtml, { headers });
|
||||
const shell = shellWithIndex(options.indexHtml, agentIndexHtml(agentContext(pageUrl, config, loaded.report), loaded.loaded));
|
||||
const manifest = selected ? await parsedManifest(url.origin, selected, options) : undefined;
|
||||
if (!selected || !manifest || manifest === "unavailable") return new Response(options.indexHtml, { headers });
|
||||
const shell = shellWithIndex(options.indexHtml, agentIndexHtml(agentContext(pageUrl, config, selected), manifest.loaded));
|
||||
// The same URL the Viewer will fetch for this page: its target's query when the link names one, none otherwise.
|
||||
const requested = url.searchParams.get("target") ?? url.searchParams.get("platform");
|
||||
return new Response(shellWithPreload(shell, `/p/${config.token}/manifest.json${requested ? `?${targetQuery(requested)}` : ""}`), { headers });
|
||||
}
|
||||
if (expired) return previewExpired(config.expiresAt!);
|
||||
if (route === "reports.json") {
|
||||
const body = JSON.stringify(config.reports.map(({ path: _path, ...report }) => report));
|
||||
return new Response(body, { headers: baseHeaders("application/json; charset=utf-8") });
|
||||
}
|
||||
const report = selectReport(config, url);
|
||||
if (!report) return previewNotFound();
|
||||
if (route === "report.zip") return decryptedReport(url.origin, report.path, config, options);
|
||||
if (route === "manifest.json") {
|
||||
const body = await manifestFor(url.origin, report, config, options);
|
||||
if (body === "unavailable") return previewUnavailable();
|
||||
if (body === "too-large") return previewTooLarge();
|
||||
return body === undefined ? previewNotFound() : new Response(body, { headers: baseHeaders("application/json; charset=utf-8") });
|
||||
}
|
||||
const found = await loadedReport(url.origin, report, config, options);
|
||||
// The token and the target are right, so a report that cannot be read this time is the Worker's failure, and the Viewer retries.
|
||||
if (found === "unavailable" && route === "asset") return previewUnavailable();
|
||||
if (found === "too-large" && route === "asset") return previewTooLarge();
|
||||
const loaded = typeof found === "string" ? undefined : found;
|
||||
if (!loaded) {
|
||||
if (route !== undefined) return previewNotFound();
|
||||
if (route === "manifest.json") return manifestResponse(url.origin, report, options);
|
||||
const manifest = await parsedManifest(url.origin, report, options);
|
||||
if (!manifest || manifest === "unavailable") {
|
||||
if (route !== undefined) return manifest === "unavailable" ? previewUnavailable() : previewNotFound();
|
||||
const headers = baseHeaders("text/html; charset=utf-8");
|
||||
headers.set("Link", linkHeader);
|
||||
headers.set("Vary", "Accept");
|
||||
return new Response(options.indexHtml, { headers });
|
||||
}
|
||||
if (route === "asset") return assetResponse(loaded.loaded, match[4]!, assetCacheControl(config.expiresAt, (options.now ?? Date.now)()));
|
||||
const context = agentContext(pageUrl, config, report);
|
||||
if (route === undefined || route === "llms.txt") {
|
||||
const headers = baseHeaders("text/markdown; charset=utf-8");
|
||||
headers.set("Link", linkHeader);
|
||||
headers.set("Vary", "Accept");
|
||||
return new Response(agentIndexMarkdown(context, loaded.loaded), { headers });
|
||||
return new Response(agentIndexMarkdown(context, manifest.loaded), { headers });
|
||||
}
|
||||
const reply = await agentApiReply(context, loaded.loaded, match[3]!.slice("/api/v1".length).replace(/\/$/, ""), url.searchParams, accept);
|
||||
const reply = await agentApiReply(context, manifest.loaded, match[3]!.slice("/api/v1".length).replace(/\/$/, ""), url.searchParams, accept);
|
||||
const headers = baseHeaders(reply.contentType);
|
||||
headers.set("Vary", "Accept");
|
||||
for (const [key, value] of Object.entries(reply.headers ?? {})) headers.set(key, value);
|
||||
@@ -265,7 +216,8 @@ export function selectReport(config: PreviewConfig, url: URL): PreviewReport | u
|
||||
function agentContext(pageUrl: string, config: PreviewConfig, report: PreviewReport): AgentContext {
|
||||
return { pageUrl, platform: report.platform, platforms: [...new Set(config.reports.map(entry => entry.platform))], target: report.target,
|
||||
targets: config.reports.map(entry => ({ id: entry.target, platform: entry.platform, label: entry.label ?? (entry.target === entry.platform ? PLATFORM_LABELS[entry.platform] : entry.target) })),
|
||||
expiresAt: config.expiresAt === null ? null : new Date(config.expiresAt).toISOString() };
|
||||
// A hosted preview lasts as long as its EAS Hosting deployment; Explore sets no expiry of its own.
|
||||
expiresAt: null };
|
||||
}
|
||||
const PLATFORM_LABELS: Record<PreviewPlatform, string> = { ios: "iOS", android: "Android" };
|
||||
|
||||
@@ -284,42 +236,6 @@ export function shellWithPreload(indexHtml: string, manifestPath: string): strin
|
||||
return at === -1 ? indexHtml : `${indexHtml.slice(0, at)}${link}${indexHtml.slice(at)}`;
|
||||
}
|
||||
|
||||
/** The manifest of one target: kept once built, from the isolate's copy of the report or from one it decrypts and lets go. */
|
||||
async function manifestFor(origin: string, report: PreviewReport, config: PreviewConfig, options: PreviewRequestOptions): Promise<string | "unavailable" | "too-large" | undefined> {
|
||||
const manifests = options.manifests ?? manifestCache;
|
||||
const key = `${origin}${report.path}`;
|
||||
const known = manifests.get(key);
|
||||
if (known !== undefined) return known;
|
||||
const loaded = await loadedReport(origin, report, config, options, { keep: false });
|
||||
if (!loaded || typeof loaded === "string") return loaded;
|
||||
const body = manifestBody(loaded.loaded);
|
||||
manifests.set(key, body);
|
||||
return body;
|
||||
}
|
||||
|
||||
/** A report route that could not read the report this time; the same token and target work once it can. */
|
||||
function previewUnavailable(): Response {
|
||||
const headers = baseHeaders("text/plain; charset=utf-8");
|
||||
headers.set("Retry-After", "1");
|
||||
return new Response("Unavailable", { status: 503, headers });
|
||||
}
|
||||
|
||||
/** A report this Worker cannot decrypt in an isolate's memory; it never will, so the Viewer says so instead of retrying. */
|
||||
function previewTooLarge(): Response {
|
||||
return new Response(JSON.stringify({ error: "too-large" }), { status: 413, headers: baseHeaders("application/json; charset=utf-8") });
|
||||
}
|
||||
|
||||
/** One asset of the report, inflated from the decrypted ZIP the isolate holds. */
|
||||
async function assetResponse(loaded: LoadedReport, file: string, cacheControl: string): Promise<Response> {
|
||||
const asset = await previewAsset(loaded, `assets/${file}`);
|
||||
if (!asset) return previewNotFound();
|
||||
const headers = baseHeaders(asset.type);
|
||||
headers.set("Cache-Control", cacheControl);
|
||||
headers.set("Content-Length", String(asset.bytes.byteLength));
|
||||
headers.set("ETag", `"${file.slice(0, 64)}"`);
|
||||
return new Response(asset.bytes as BodyInit, { headers });
|
||||
}
|
||||
|
||||
/** The agent index as the shell's initial `#root` content; the Viewer replaces it when it renders. */
|
||||
export function shellWithIndex(indexHtml: string, indexBlock: string): string {
|
||||
const root = '<div id="root"></div>';
|
||||
@@ -329,107 +245,88 @@ export function shellWithIndex(indexHtml: string, indexBlock: string): string {
|
||||
}
|
||||
|
||||
/**
|
||||
* A report decrypted and parsed, from the isolate's cache or decrypted now; requests for one that is decrypting wait for
|
||||
* that decrypt. `keep: false` (a manifest) does not keep a report that is not cached already.
|
||||
* One target's manifest for the Viewer. A kept one is answered from memory; otherwise the static file streams through
|
||||
* unparsed, so a prefetch of every target costs the isolate almost no CPU.
|
||||
*/
|
||||
async function loadedReport(origin: string, report: PreviewReport | undefined, config: PreviewConfig, options: PreviewRequestOptions,
|
||||
{ keep = true }: { keep?: boolean } = {}): Promise<{ report: PreviewReport; loaded: LoadedReport } | "unavailable" | "too-large" | undefined> {
|
||||
if (!report) return undefined;
|
||||
const cache = options.cache ?? reportCache;
|
||||
const loading = options.loading ?? reportLoading;
|
||||
async function manifestResponse(origin: string, report: PreviewReport, options: PreviewRequestOptions): Promise<Response> {
|
||||
const headers = baseHeaders("application/json; charset=utf-8");
|
||||
const kept = (options.cache ?? manifestCache).get(`${origin}${report.path}`);
|
||||
if (kept) return new Response(kept.bytes as BodyInit, { headers });
|
||||
const upstream = await staticFile(origin, report.path, options);
|
||||
if (upstream === "unavailable") return previewUnavailable();
|
||||
if (!upstream) return previewNotFound();
|
||||
return new Response(upstream.body, { headers });
|
||||
}
|
||||
|
||||
/** A static file of this deployment: "unavailable" when it cannot be fetched now, undefined when it is not there. */
|
||||
async function staticFile(origin: string, path: string, options: PreviewRequestOptions): Promise<Response | "unavailable" | undefined> {
|
||||
let upstream: Response;
|
||||
try { upstream = await (options.fetchImpl ?? fetch)(new URL(path, origin).href); }
|
||||
catch { return "unavailable"; }
|
||||
if (upstream.status >= 500) return "unavailable";
|
||||
if (upstream.status !== 200 || !upstream.body) {
|
||||
await upstream.body?.cancel();
|
||||
return undefined;
|
||||
}
|
||||
return upstream;
|
||||
}
|
||||
|
||||
/** At most `limit` bytes of a response, or undefined when it has more. */
|
||||
async function bodyBytes(response: Response, limit: number): Promise<Uint8Array | undefined> {
|
||||
const declared = Number(response.headers.get("content-length") ?? "0");
|
||||
if (declared > limit) {
|
||||
await response.body?.cancel();
|
||||
return undefined;
|
||||
}
|
||||
const bytes = new Uint8Array(await response.arrayBuffer());
|
||||
return bytes.byteLength > limit ? undefined : bytes;
|
||||
}
|
||||
|
||||
/** One target's manifest, parsed: from the isolate's cache, or fetched now (requests that arrive together share one fetch). */
|
||||
async function parsedManifest(origin: string, report: PreviewReport, options: PreviewRequestOptions): Promise<ManifestResult> {
|
||||
const cache = options.cache ?? manifestCache;
|
||||
const loading = options.loading ?? manifestLoading;
|
||||
const key = `${origin}${report.path}`;
|
||||
const oversized = options.oversized ?? oversizedReports;
|
||||
if (oversized.has(key)) return "too-large";
|
||||
const cached = cache.get(key);
|
||||
if (cached) {
|
||||
// Most recently used last, so the oldest is the first to go.
|
||||
cache.delete(key);
|
||||
cache.set(key, cached);
|
||||
return { report, loaded: cached };
|
||||
return cached;
|
||||
}
|
||||
let pending = loading.get(key);
|
||||
if (!pending) {
|
||||
pending = oneAtATime(() => decryptedBytes(origin, report.path, config, options, sealed => makeRoom(cache, 2 * sealed, peak(options))))
|
||||
.then<LoadResult, LoadResult>(bytes => (bytes instanceof Uint8Array ? loadReport(bytes) : bytes), () => "unavailable");
|
||||
pending = fetchManifest(origin, report, options).catch(() => "unavailable" as const);
|
||||
loading.set(key, pending);
|
||||
void pending.finally(() => { if (loading.get(key) === pending) loading.delete(key); });
|
||||
}
|
||||
const loaded = await pending;
|
||||
if (loaded === "too-large") oversized.add(key);
|
||||
if (!loaded || typeof loaded === "string") return loaded;
|
||||
const held = options.budget?.held ?? HELD_REPORT_BYTES;
|
||||
if (keep && !cache.has(key) && loaded.zip.byteLength <= held) {
|
||||
makeRoom(cache, loaded.zip.byteLength, held);
|
||||
cache.set(key, loaded);
|
||||
const parsed = await pending;
|
||||
if (parsed && parsed !== "unavailable" && !cache.has(key) && heldBytes(parsed) <= MANIFEST_CACHE_BYTES) {
|
||||
let held = heldBytes(parsed);
|
||||
for (const kept of cache.values()) held += heldBytes(kept);
|
||||
for (const [oldest, kept] of cache) {
|
||||
if (held <= MANIFEST_CACHE_BYTES) break;
|
||||
cache.delete(oldest);
|
||||
held -= heldBytes(kept);
|
||||
}
|
||||
cache.set(key, parsed);
|
||||
}
|
||||
return { report, loaded };
|
||||
return parsed;
|
||||
}
|
||||
|
||||
/** Lets the oldest kept reports go until `bytes` more fit beside the rest within `budget`; false when they never can. */
|
||||
function makeRoom(cache: Map<string, LoadedReport>, bytes: number, budget: number): boolean {
|
||||
if (bytes > budget) return false;
|
||||
let held = 0;
|
||||
for (const loaded of cache.values()) held += loaded.zip.byteLength;
|
||||
for (const [oldest, loaded] of cache) {
|
||||
if (held + bytes <= budget) break;
|
||||
cache.delete(oldest);
|
||||
held -= loaded.zip.byteLength;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function peak(options: PreviewRequestOptions): number {
|
||||
return options.budget?.peak ?? DECRYPT_PEAK_BYTES;
|
||||
}
|
||||
|
||||
/** Decrypts run one after another, so two of them never need their ciphertext and plaintext at once. */
|
||||
function oneAtATime<T>(task: () => Promise<T>): Promise<T> {
|
||||
const run = decrypting.then(task, task);
|
||||
decrypting = run.catch(() => undefined);
|
||||
return run;
|
||||
}
|
||||
|
||||
/**
|
||||
* The report's ZIP, decrypted: "unavailable" when its file cannot be fetched now, "too-large" when `reserve` cannot make
|
||||
* room to decrypt it, undefined when the file is missing or does not decrypt.
|
||||
*/
|
||||
async function decryptedBytes(origin: string, reportPath: string, config: PreviewConfig, options: PreviewRequestOptions,
|
||||
reserve: (sealedBytes: number) => boolean = () => true): Promise<Uint8Array | "unavailable" | "too-large" | undefined> {
|
||||
const fetchImpl = options.fetchImpl ?? fetch;
|
||||
const subtle = options.subtle ?? crypto.subtle;
|
||||
let upstream: Response;
|
||||
try { upstream = await fetchImpl(new URL(reportPath, origin).href, { headers: { accept: "application/octet-stream" } }); }
|
||||
catch { return "unavailable"; }
|
||||
if (upstream.status >= 500) return "unavailable";
|
||||
if (upstream.status !== 200 || !upstream.body) return undefined;
|
||||
const declared = Number(upstream.headers.get("content-length") ?? "0");
|
||||
if (declared > MAX_REPORT_BYTES + PREVIEW_CIPHER.ivBytes + 16) return undefined;
|
||||
if (declared && !reserve(declared)) {
|
||||
await upstream.body.cancel();
|
||||
return "too-large";
|
||||
}
|
||||
const sealed = new Uint8Array(await upstream.arrayBuffer());
|
||||
if (sealed.byteLength <= PREVIEW_CIPHER.ivBytes + 16 || sealed.byteLength > MAX_REPORT_BYTES + PREVIEW_CIPHER.ivBytes + 16) return undefined;
|
||||
if (!declared && !reserve(sealed.byteLength)) return "too-large";
|
||||
try {
|
||||
const key = await subtle.importKey("raw", config.key, "AES-GCM", false, ["decrypt"]);
|
||||
return new Uint8Array(await subtle.decrypt(
|
||||
{ name: "AES-GCM", iv: sealed.subarray(0, PREVIEW_CIPHER.ivBytes), additionalData: new TextEncoder().encode(PREVIEW_CIPHER.aad) },
|
||||
key, sealed.subarray(PREVIEW_CIPHER.ivBytes)));
|
||||
} catch { return undefined; }
|
||||
}
|
||||
|
||||
/** The whole decrypted ZIP (downloads, older Viewers), decrypted in turn and within the same budget as every other decrypt. */
|
||||
async function decryptedReport(origin: string, reportPath: string, config: PreviewConfig, options: PreviewRequestOptions): Promise<Response> {
|
||||
const cache = options.cache ?? reportCache;
|
||||
const plain = await oneAtATime(() => decryptedBytes(origin, reportPath, config, options, sealed => makeRoom(cache, 2 * sealed, peak(options))));
|
||||
if (plain === "unavailable") return previewUnavailable();
|
||||
if (plain === "too-large") return previewTooLarge();
|
||||
if (!plain) return previewNotFound();
|
||||
const headers = baseHeaders("application/zip");
|
||||
headers.set("Content-Length", String(plain.byteLength));
|
||||
headers.set("Content-Disposition", 'inline; filename="report.zip"');
|
||||
return new Response(plain as BodyInit, { headers });
|
||||
async function fetchManifest(origin: string, report: PreviewReport, options: PreviewRequestOptions): Promise<ManifestResult> {
|
||||
const upstream = await staticFile(origin, report.path, options);
|
||||
if (!upstream || upstream === "unavailable") return upstream;
|
||||
const bytes = await bodyBytes(upstream, MAX_MANIFEST_BYTES);
|
||||
if (!bytes) return undefined;
|
||||
// The agent API reads screenshots from the same static files the Viewer does, next to the manifest's target directory.
|
||||
const base = new URL(report.path.replace(/\/targets\/[^/]+$/, "/"), origin);
|
||||
const loaded = reportFromManifest(bytes, async (name, limit) => {
|
||||
const asset = await staticFile(origin, new URL(name, base).pathname, options);
|
||||
if (asset === "unavailable") throw new Error(`${name} is unavailable`);
|
||||
return asset ? bodyBytes(asset, Math.min(limit, MAX_ASSET_BYTES)) : undefined;
|
||||
});
|
||||
return loaded ? { bytes, loaded } : undefined;
|
||||
}
|
||||
|
||||
/** Requests the Viewer shell never issues; identical to the token-less answer. */
|
||||
|
||||
+116
-126
@@ -1,27 +1,18 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { webcrypto, createHash } from "node:crypto";
|
||||
import { 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 { previewResponse, type PreviewEnvironment } from "../src/server/preview";
|
||||
import { agentApiReply, agentIndexMarkdown, loadReport, prefersHtml, prefersMarkdown } from "../../src/report/agent-api";
|
||||
import { manifestBody, MAX_MANIFEST_BYTES, reportFromManifest } from "../../src/report/preview-manifest";
|
||||
import { readZipDirectory } from "../../src/report/zip-reader";
|
||||
|
||||
const subtle = webcrypto.subtle as SubtleCrypto;
|
||||
const token = "abcdefghijklmnopqrstuvwxyz234567";
|
||||
const origin = "https://acme-explore--k7f3z0d1q8.expo.app";
|
||||
const html = '<!doctype html><html><body><div id="root"></div><script type="module" src="/viewer/assets/main.js"></script></body></html>';
|
||||
const keyBytes: Uint8Array<ArrayBuffer> = webcrypto.getRandomValues(new Uint8Array(32));
|
||||
const review = new Uint8Array(readFileSync(new URL("../../test/fixtures/example-review-artifact.zip", import.meta.url))) as Uint8Array<ArrayBuffer>;
|
||||
|
||||
async function sealed(plain: Uint8Array<ArrayBuffer>): Promise<Uint8Array<ArrayBuffer>> {
|
||||
const key = await subtle.importKey("raw", keyBytes, "AES-GCM", false, ["encrypt"]);
|
||||
const iv = webcrypto.getRandomValues(new Uint8Array(PREVIEW_CIPHER.ivBytes));
|
||||
const cipher = new Uint8Array(await subtle.encrypt({ name: "AES-GCM", iv, additionalData: new TextEncoder().encode(PREVIEW_CIPHER.aad) }, key, plain));
|
||||
const out = new Uint8Array(iv.byteLength + cipher.byteLength);
|
||||
out.set(iv); out.set(cipher, iv.byteLength);
|
||||
return out;
|
||||
}
|
||||
|
||||
/** A ZIP the way zipReportDirectory writes one: the JSON deflated, PNGs stored. */
|
||||
function zip(files: Record<string, Uint8Array>): Uint8Array<ArrayBuffer> {
|
||||
@@ -74,19 +65,26 @@ const explorationReport = {
|
||||
};
|
||||
const explorationZip = zip({ "exploration.json": new TextEncoder().encode(JSON.stringify(explorationReport)), [`assets/${pngSha}.png`]: png });
|
||||
|
||||
function deployment(files: Record<string, Uint8Array<ArrayBuffer>>, env: PreviewEnvironment, now?: () => number, budget?: { held: number; peak: number }) {
|
||||
/** A hosted preview as ci:deploy writes it: each target's manifest at its path, and every asset once under the token. */
|
||||
async function deployment(reports: Record<string, Uint8Array>, env: PreviewEnvironment) {
|
||||
const files: Record<string, Uint8Array> = {};
|
||||
for (const [path, archive] of Object.entries(reports)) {
|
||||
const loaded = (await loadReport(archive))!;
|
||||
files[path] = new TextEncoder().encode(manifestBody(loaded));
|
||||
for (const name of loaded.entries.keys()) if (name.startsWith("assets/") && !name.endsWith("/")) files[`/p/${token}/${name}`] = (await loaded.read(name, 64 * 1024 * 1024))!;
|
||||
}
|
||||
const calls: string[] = [];
|
||||
const fetchImpl = (async (input: RequestInfo | URL) => {
|
||||
const url = new URL(typeof input === "string" ? input : input instanceof URL ? input.href : input.url);
|
||||
calls.push(url.href);
|
||||
const body = files[url.pathname];
|
||||
return body ? new Response(body, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
|
||||
return body ? new Response(body as BodyInit, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
|
||||
}) as typeof fetch;
|
||||
const options = { env, indexHtml: html, fetchImpl, subtle, cache: new Map(), loading: new Map(), manifests: new Map(), oversized: new Set<string>(), ...(now ? { now } : {}), ...(budget ? { budget } : {}) };
|
||||
return { calls, get: (path: string, accept?: string) => previewResponse(new Request(`${origin}/p/${token}${path}`, accept === undefined ? {} : { headers: { accept } }), options) };
|
||||
const options = { env, indexHtml: html, fetchImpl, cache: new Map(), loading: new Map() };
|
||||
return { calls, files, cache: options.cache, get: (path: string, accept?: string) => previewResponse(new Request(`${origin}/p/${token}${path}`, accept === undefined ? {} : { headers: { accept } }), options) };
|
||||
}
|
||||
|
||||
const reviewEnv: PreviewEnvironment = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_KEY: Buffer.from(keyBytes).toString("base64"), EXPLORE_PREVIEW_EXPIRES_AT: "2030-01-01T00:00:00Z", EXPLORE_PREVIEW_REPORT: "/_report/abcdefghijklmnop/report.zip.enc" };
|
||||
const reviewEnv: PreviewEnvironment = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/report.json` };
|
||||
|
||||
test("the archive reader accepts the deployed layout and rejects everything else", async () => {
|
||||
assert.ok(readZipDirectory(review)?.has("review.json"));
|
||||
@@ -98,7 +96,7 @@ test("the archive reader accepts the deployed layout and rejects everything else
|
||||
});
|
||||
|
||||
test("the token page negotiates: browsers get the shell carrying the agent index, everything else gets Markdown", async () => {
|
||||
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
|
||||
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
|
||||
const browser = await site.get("?view=compare&screen=home", "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8");
|
||||
assert.equal(browser.status, 200);
|
||||
assert.match(browser.headers.get("content-type") ?? "", /^text\/html/);
|
||||
@@ -118,19 +116,19 @@ test("the token page negotiates: browsers get the shell carrying the agent index
|
||||
assert.match(response.headers.get("content-type") ?? "", /^text\/markdown/, String(accept));
|
||||
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("stops serving"), "a hosted preview lasts as long as its deployment; the index names no expiry");
|
||||
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");
|
||||
assert.match(llms.headers.get("content-type") ?? "", /^text\/markdown/);
|
||||
assert.equal(await llms.text(), await (await site.get("")).text());
|
||||
// The sealed file is decrypted and parsed once per isolate, not once per request.
|
||||
// The static manifest is fetched and parsed once per isolate, not once per request.
|
||||
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`]);
|
||||
});
|
||||
|
||||
test("the API serves a PR review: summary, filtered and paged screens, detail, transitions, assets, raw", async () => {
|
||||
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
|
||||
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
|
||||
const summary = await (await site.get("/api/v1")).json();
|
||||
assert.equal(summary.kind, "pr-review");
|
||||
assert.equal(summary.contract, "explore.review");
|
||||
@@ -198,12 +196,15 @@ test("the API serves a PR review: summary, filtered and paged screens, detail, t
|
||||
|
||||
const raw = await site.get("/api/v1/raw");
|
||||
assert.equal(raw.status, 200);
|
||||
assert.equal((await raw.json()).review.contract, "explore.review", "raw is the file as written, review nested under `review`");
|
||||
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`]);
|
||||
const rawBytes = new Uint8Array(await raw.arrayBuffer());
|
||||
assert.deepEqual(rawBytes, (await loadReport(review))!.raw, "raw is review.json byte for byte, as the ZIP held it");
|
||||
assert.equal(JSON.parse(new TextDecoder().decode(rawBytes)).review.contract, "explore.review");
|
||||
// The manifest once, and the one screenshot asked for, read from the same static file the Viewer loads.
|
||||
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`, `${origin}/p/${token}/assets/${sha}.png`]);
|
||||
});
|
||||
|
||||
test("the API serves an exploration: screens with elements and transitions, journeys, gaps, frontier", async () => {
|
||||
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(explorationZip) }, reviewEnv);
|
||||
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: explorationZip }, reviewEnv);
|
||||
const index = await (await site.get("")).text();
|
||||
assert.match(index, /^# Expo Explore exploration: Euxy \(ios\)/);
|
||||
assert.ok(index.includes("mapped 2 screens, 1 transitions, 1 elements; 1 coverage gaps. Stopped: budget. Mapped the sequencer."), index);
|
||||
@@ -229,22 +230,9 @@ test("the API serves an exploration: screens with elements and transitions, jour
|
||||
assert.deepEqual(await (await site.get("/api/v1/raw")).json(), explorationReport);
|
||||
});
|
||||
|
||||
test("expiry, platforms and wrong tokens behave like the report routes", async () => {
|
||||
const after = () => Date.parse("2030-01-01T00:00:00Z");
|
||||
const expired = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv, after);
|
||||
const shell = await expired.get("", "text/html");
|
||||
assert.equal(shell.status, 200);
|
||||
assert.equal(await shell.text(), html, "the expired shell carries no report data");
|
||||
assert.equal((await expired.get("/api/v1/screens/", "text/html")).status, 410);
|
||||
for (const path of ["", "/llms.txt", "/api/v1", "/api/v1/screens", `/api/v1/assets/${"a".repeat(64)}`]) {
|
||||
const response = await expired.get(path);
|
||||
assert.equal(response.status, 410, path);
|
||||
assert.deepEqual(await response.json(), { error: "expired", expiredAt: "2030-01-01T00:00:00.000Z" });
|
||||
}
|
||||
assert.deepEqual(expired.calls, []);
|
||||
|
||||
const multiEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "ios", path: "/_report/abcdefghijklmnop/ios.zip.enc" }, { platform: "android", path: "/_report/abcdefghijklmnop/android.zip.enc" }]) };
|
||||
const multi = deployment({ "/_report/abcdefghijklmnop/ios.zip.enc": await sealed(review), "/_report/abcdefghijklmnop/android.zip.enc": await sealed(explorationZip) }, multiEnv);
|
||||
test("platforms and wrong tokens behave like the report routes", async () => {
|
||||
const multiEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "ios", path: `/p/${token}/targets/ios.json` }, { platform: "android", path: `/p/${token}/targets/android.json` }]) };
|
||||
const multi = await deployment({ [`/p/${token}/targets/ios.json`]: review, [`/p/${token}/targets/android.json`]: explorationZip }, multiEnv);
|
||||
const ios = await (await multi.get("/api/v1")).json();
|
||||
assert.equal(ios.kind, "pr-review");
|
||||
assert.deepEqual(ios.platforms, ["ios", "android"]);
|
||||
@@ -257,12 +245,12 @@ test("expiry, platforms and wrong tokens behave like the report routes", async (
|
||||
assert.match(await (await multi.get("?platform=android")).text(), /^# Expo Explore exploration/);
|
||||
assert.equal((await multi.get("/api/v1?platform=web")).status, 404);
|
||||
assert.equal((await multi.get("/api/v1?platform=ios&platform=android")).status, 404);
|
||||
assert.equal(multi.calls.length, 2, "each platform's report is decrypted once");
|
||||
assert.equal(multi.calls.length, 2, "each platform's manifest is fetched once");
|
||||
|
||||
const wrongToken = token.replace(/a/, "b");
|
||||
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
|
||||
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
|
||||
for (const path of [`/p/${wrongToken}/api/v1`, `/p/${wrongToken}/llms.txt`, `/p/${token}/API/v1`, `/p/${token}/api/v1//screens`]) {
|
||||
const response = await previewResponse(new Request(`${origin}${path}`), { env: reviewEnv, indexHtml: html, fetchImpl: fetch, subtle, cache: new Map() });
|
||||
const response = await previewResponse(new Request(`${origin}${path}`), { env: reviewEnv, indexHtml: html, fetchImpl: fetch, cache: new Map() });
|
||||
assert.equal(response.status, 404, path);
|
||||
}
|
||||
assert.equal((await site.get("/api/v1", undefined)).status, 200);
|
||||
@@ -337,12 +325,12 @@ test("statuses follow the Viewer: accessibility-only, unavailable for a failed o
|
||||
|
||||
test("a deployment of several targets keeps each target in its links and names the others in the index", async () => {
|
||||
const listing = [
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", path: "/_report/abcdefghijklmnop/iphone.zip.enc" },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: "/_report/abcdefghijklmnop/duo-open.zip.enc" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "/_report/abcdefghijklmnop/android.zip.enc" },
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", path: `/p/${token}/targets/iphone.json` },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: `/p/${token}/targets/duo-open.json` },
|
||||
{ target: "android", platform: "android", label: "Android", path: `/p/${token}/targets/android.json` },
|
||||
];
|
||||
const targetsEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
|
||||
const site = deployment({ [listing[0]!.path]: await sealed(review), [listing[1]!.path]: await sealed(review), [listing[2]!.path]: await sealed(explorationZip) }, targetsEnv);
|
||||
const site = await deployment({ [listing[0]!.path]: review, [listing[1]!.path]: review, [listing[2]!.path]: explorationZip }, targetsEnv);
|
||||
const duo = await (await site.get("/api/v1?target=duo-open")).json();
|
||||
assert.equal(duo.kind, "pr-review");
|
||||
assert.deepEqual(duo.platforms, ["ios", "android"], "distinct platforms, as before targets");
|
||||
@@ -364,9 +352,8 @@ test("a deployment of several targets keeps each target in its links and names t
|
||||
assert.equal((await site.get("/api/v1?target=pixel")).status, 404);
|
||||
});
|
||||
|
||||
test("the manifest and asset routes let the Viewer open a report before any screenshot, and the shell preloads the manifest", async () => {
|
||||
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
|
||||
const loaded = (await loadReport(review))!;
|
||||
test("the manifest route answers each target's static manifest, the shell preloads it, and screenshots are not the Worker's", async () => {
|
||||
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
|
||||
const shell = await (await site.get("", "text/html")).text();
|
||||
assert.ok(shell.includes(`<link rel="preload" href="/p/${token}/manifest.json" as="fetch" crossorigin><script type="module"`), shell.slice(0, 400));
|
||||
const linked = await (await site.get("?target=ios&view=compare", "text/html")).text();
|
||||
@@ -376,98 +363,101 @@ test("the manifest and asset routes let the Viewer open a report before any scre
|
||||
assert.equal(manifest.status, 200);
|
||||
assert.match(manifest.headers.get("content-type") ?? "", /^application\/json/);
|
||||
assert.equal(manifest.headers.get("cache-control"), "private, no-store");
|
||||
const body = await manifest.json() as { format: string; file: string; entries: Record<string, number>; report: { review: unknown } };
|
||||
assert.equal(body.format, "explore.preview-manifest/1");
|
||||
assert.equal(body.file, "review.json");
|
||||
assert.deepEqual(body.report, JSON.parse(new TextDecoder().decode(loaded.raw)));
|
||||
const assets = [...loaded.entries].filter(([name]) => name.startsWith("assets/"));
|
||||
assert.ok(assets.length > 0);
|
||||
assert.deepEqual(body.entries, Object.fromEntries(assets.map(([name, entry]) => [name, entry.size])));
|
||||
assert.ok(!("review.json" in body.entries));
|
||||
|
||||
const [name, entry] = assets.find(([file]) => file.endsWith(".png"))!;
|
||||
const asset = await site.get(`/${name}`);
|
||||
assert.equal(asset.status, 200);
|
||||
assert.equal(asset.headers.get("content-type"), "image/png");
|
||||
// Kept by this browser for a week, and never past the link's expiry; never by a shared cache.
|
||||
assert.equal(asset.headers.get("cache-control"), "private, max-age=604800, immutable");
|
||||
const nearExpiry = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv, () => Date.parse("2029-12-31T23:59:00Z"));
|
||||
assert.equal((await nearExpiry.get(`/${name}`)).headers.get("cache-control"), "private, max-age=60, immutable");
|
||||
const never = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, { ...reviewEnv, EXPLORE_PREVIEW_EXPIRES_AT: undefined });
|
||||
assert.equal((await never.get(`/${name}`)).headers.get("cache-control"), "private, max-age=604800, immutable");
|
||||
assert.equal(asset.headers.get("content-length"), String(entry.size));
|
||||
assert.equal(asset.headers.get("etag"), `"${name.slice("assets/".length, "assets/".length + 64)}"`);
|
||||
const bytes = new Uint8Array(await asset.arrayBuffer());
|
||||
assert.equal(bytes.byteLength, entry.size);
|
||||
assert.equal(createHash("sha256").update(bytes).digest("hex"), name.slice("assets/".length, "assets/".length + 64));
|
||||
|
||||
for (const path of ["/assets/" + "0".repeat(64) + ".png", "/assets/" + name.slice("assets/".length, -4) + ".gif", "/assets/review.json", `/${name}/`, `/${name}?platform=android`]) {
|
||||
assert.equal(await manifest.text(), new TextDecoder().decode(site.files[reviewEnv.EXPLORE_PREVIEW_REPORT!]), "the static manifest, byte for byte");
|
||||
// Screenshots are static files EAS Hosting serves itself; a path the deployment does not hold is the Worker's 404.
|
||||
for (const path of ["/assets/" + "0".repeat(64) + ".png", "/report.zip", "/targets/report.json"]) {
|
||||
assert.equal((await site.get(path)).status, 404, path);
|
||||
}
|
||||
// The sealed file is still decrypted once per isolate.
|
||||
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`]);
|
||||
});
|
||||
|
||||
test("a ZIP's directory records are not assets: the manifest the Viewer validates names files only", async () => {
|
||||
const withDirectory = zip({ "exploration.json": new TextEncoder().encode(JSON.stringify(explorationReport)), "assets/": new Uint8Array(), [`assets/${pngSha}.png`]: png });
|
||||
assert.ok(readZipDirectory(withDirectory)!.has("assets/"));
|
||||
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(withDirectory) }, reviewEnv);
|
||||
const body = await (await site.get("/manifest.json")).json() as { entries: Record<string, number> };
|
||||
assert.deepEqual(body.entries, { [`assets/${pngSha}.png`]: png.byteLength });
|
||||
assert.deepEqual(JSON.parse(manifestBody((await loadReport(withDirectory))!)).entries, { [`assets/${pngSha}.png`]: png.byteLength });
|
||||
assert.equal(JSON.parse(manifestBody((await loadReport(withDirectory))!, "abc")).deployment, "abc", "a deployment stamps the manifests it writes");
|
||||
});
|
||||
|
||||
test("a report the Worker cannot fetch this time answers 503, which the Viewer retries; one that never decrypts is a 404", async () => {
|
||||
const flaky = { get: (path: string) => previewResponse(new Request(`${origin}/p/${token}${path}`), {
|
||||
env: reviewEnv, indexHtml: html, subtle, cache: new Map(), loading: new Map(), manifests: new Map(),
|
||||
fetchImpl: (async () => new Response("upstream", { status: 502 })) as typeof fetch }) };
|
||||
for (const path of ["/manifest.json", `/assets/${pngSha}.png`, "/report.zip"]) {
|
||||
const response = await flaky.get(path);
|
||||
test("a static file the Worker cannot fetch this time answers 503, which the Viewer retries; one that is not there is a 404", async () => {
|
||||
const flaky = (status: number) => (path: string) => previewResponse(new Request(`${origin}/p/${token}${path}`), {
|
||||
env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(), fetchImpl: (async () => new Response("upstream", { status })) as typeof fetch });
|
||||
for (const path of ["/manifest.json", "/api/v1", "/llms.txt"]) {
|
||||
const response = await flaky(502)(path);
|
||||
assert.equal(response.status, 503, path);
|
||||
assert.equal(response.headers.get("retry-after"), "1");
|
||||
assert.equal(response.headers.get("cache-control"), "private, no-store");
|
||||
assert.equal((await flaky(404)(path)).status, 404, path);
|
||||
}
|
||||
const garbage = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: new Uint8Array(64) as Uint8Array<ArrayBuffer> }, reviewEnv);
|
||||
for (const path of ["/manifest.json", `/assets/${pngSha}.png`, "/report.zip"]) assert.equal((await garbage.get(path)).status, 404, path);
|
||||
// A wrong token or an unknown target is still the same 404 as any other path.
|
||||
assert.equal((await garbage.get("/manifest.json?target=pixel")).status, 404);
|
||||
// The shell still opens; the Viewer then asks for the manifest and shows why it cannot.
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { headers: { accept: "text/html" } }), {
|
||||
env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(), fetchImpl: (async () => new Response("upstream", { status: 502 })) as typeof fetch })).status, 200);
|
||||
const garbage = { env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(),
|
||||
fetchImpl: (async () => new Response("not a manifest", { status: 200 })) as typeof fetch };
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/api/v1`), garbage)).status, 404, "a file that is not a manifest of a report");
|
||||
});
|
||||
|
||||
test("an isolate keeps decrypted reports within its byte budget, decrypts one at a time, and shares a decrypt between requests", async () => {
|
||||
const listing = ["iphone", "duo-open", "duo-closed"].map(target => ({ target, platform: "ios", label: target, path: `/_report/abcdefghijklmnop/${target}.zip.enc` }));
|
||||
test("the shell and the agent API share one fetch of a manifest, kept within the cache's bytes; the manifest route only passes it through", async () => {
|
||||
const listing = ["iphone", "duo-open"].map(target => ({ target, platform: "ios", label: target, path: `/p/${token}/targets/${target}.json` }));
|
||||
const env: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
|
||||
const size = explorationZip.byteLength;
|
||||
// Room to keep two reports, and to decrypt one beside them.
|
||||
const site = deployment(Object.fromEntries(await Promise.all(listing.map(async entry => [entry.path, await sealed(explorationZip)] as const))), env,
|
||||
undefined, { held: 2 * size, peak: 4 * size + 64 });
|
||||
const decrypts = () => site.calls.length;
|
||||
// The prefetch: every target's manifest, each report decrypted once and let go.
|
||||
for (const { target } of listing) assert.equal((await site.get(`/manifest.json?target=${target}`)).status, 200);
|
||||
assert.equal(decrypts(), 3);
|
||||
for (const { target } of listing) await site.get(`/manifest.json?target=${target}`);
|
||||
assert.equal(decrypts(), 3, "manifests are kept");
|
||||
const asset = (target: string) => site.get(`/assets/${pngSha}.png?target=${target}`).then(response => response.status);
|
||||
// Requests that arrive together wait for one decrypt.
|
||||
assert.deepEqual(await Promise.all([asset("iphone"), asset("iphone"), asset("iphone")]), [200, 200, 200]);
|
||||
assert.equal(decrypts(), 4, "the report a reviewer looks at is kept");
|
||||
assert.equal(await asset("duo-open"), 200);
|
||||
assert.equal(await asset("iphone"), 200);
|
||||
assert.equal(decrypts(), 5);
|
||||
assert.equal(await asset("duo-closed"), 200);
|
||||
assert.equal(decrypts(), 6, "a third report evicts the least recently used, duo-open");
|
||||
assert.equal(await asset("iphone"), 200);
|
||||
assert.equal(decrypts(), 6);
|
||||
assert.equal(await asset("duo-open"), 200);
|
||||
assert.equal(decrypts(), 7);
|
||||
const site = await deployment(Object.fromEntries(listing.map(entry => [entry.path, explorationZip])), env);
|
||||
// Requests that arrive together wait for one fetch.
|
||||
assert.deepEqual((await Promise.all([site.get("/api/v1?target=iphone"), site.get("/llms.txt?target=iphone"), site.get("?target=iphone", "text/html")])).map(response => response.status), [200, 200, 200]);
|
||||
assert.equal(site.calls.length, 1);
|
||||
// Kept now, so the Viewer's manifest request is answered from memory.
|
||||
assert.equal((await site.get("/manifest.json?target=iphone")).status, 200);
|
||||
assert.equal(site.calls.length, 1);
|
||||
// Not kept (a prefetch of another target): streamed through each time, never parsed.
|
||||
assert.equal((await site.get("/manifest.json?target=duo-open")).status, 200);
|
||||
assert.equal((await site.get("/manifest.json?target=duo-open")).status, 200);
|
||||
assert.equal(site.calls.length, 3);
|
||||
});
|
||||
|
||||
// A report larger than the budget keeps is decrypted for each request; one too large to decrypt is unavailable.
|
||||
const perRequest = deployment({ [listing[0]!.path]: await sealed(explorationZip) }, env, undefined, { held: size - 1, peak: 4 * size });
|
||||
for (let request = 1; request <= 3; request++) {
|
||||
assert.equal(await perRequest.get(`/assets/${pngSha}.png?target=iphone`).then(response => response.status), 200);
|
||||
assert.equal(perRequest.calls.length, request);
|
||||
test("a manifest is parsed once and keeps the report's own bytes; another key order still opens; one the Viewer would refuse does not", async () => {
|
||||
const loaded = (await loadReport(review))!;
|
||||
const read = async () => undefined;
|
||||
const written = new TextEncoder().encode(manifestBody(loaded, "stamp"));
|
||||
const parsed = reportFromManifest(written, read)!;
|
||||
assert.equal(parsed.kind, "pr-review");
|
||||
assert.deepEqual(parsed.raw, loaded.raw);
|
||||
assert.equal(parsed.raw.buffer, written.buffer, "the report's bytes are a view of the manifest, not a copy");
|
||||
assert.equal(parsed.entries.size, [...loaded.entries.keys()].filter(name => name.startsWith("assets/")).length);
|
||||
// Another writer's layout: parsed whole, the report re-serialized.
|
||||
const reordered = JSON.parse(new TextDecoder().decode(written));
|
||||
const other = reportFromManifest(new TextEncoder().encode(JSON.stringify({ report: reordered.report, format: reordered.format, file: reordered.file, entries: reordered.entries })), read)!;
|
||||
assert.equal(other.kind, "pr-review");
|
||||
assert.deepEqual(other.json, parsed.json);
|
||||
// A nested `"report"` key before the report's own is not where the report starts.
|
||||
const nested = `{"format":"explore.preview-manifest/1","extra":{"a":1,"report":2},"file":"review.json","entries":{},"report":${new TextDecoder().decode(loaded.raw)}}`;
|
||||
const fromNested = reportFromManifest(new TextEncoder().encode(nested), read)!;
|
||||
assert.equal(fromNested.kind, "pr-review");
|
||||
assert.deepEqual(fromNested.json, parsed.json);
|
||||
for (const bad of ['{"format":"explore.preview-manifest/1","file":"review.json","entries":{"../x":1},"report":{}}', '{"format":"other","file":"review.json","entries":{},"report":{}}', "not json"]) {
|
||||
assert.equal(reportFromManifest(new TextEncoder().encode(bad), read), undefined, bad);
|
||||
}
|
||||
const tooLarge = deployment({ [listing[0]!.path]: await sealed(explorationZip) }, env, undefined, { held: size, peak: size });
|
||||
for (const path of [`/assets/${pngSha}.png?target=iphone`, "/manifest.json?target=iphone", "/report.zip?target=iphone"]) {
|
||||
assert.equal((await tooLarge.get(path)).status, 413, path);
|
||||
}
|
||||
assert.equal(tooLarge.calls.length, 2, "the isolate remembers a report it cannot decrypt (report.zip is not cached)");
|
||||
assert.equal(reportFromManifest(new Uint8Array(MAX_MANIFEST_BYTES + 1), read), undefined, "larger than the Viewer opens");
|
||||
});
|
||||
|
||||
test("an agent's screenshot the Worker cannot fetch this time is a 503; one the report does not hold is a 404", async () => {
|
||||
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
|
||||
const loaded = (await loadReport(review))!;
|
||||
const name = [...loaded.entries.keys()].find(entry => /^assets\/[a-f0-9]{64}\.png$/.test(entry))!;
|
||||
const sha = name.slice(7, 71);
|
||||
const manifest = site.files[reviewEnv.EXPLORE_PREVIEW_REPORT!]!;
|
||||
const failing = (status: number) => previewResponse(new Request(`${origin}/p/${token}/api/v1/assets/${sha}`), { env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(),
|
||||
fetchImpl: (async (input: RequestInfo | URL) => String(input).endsWith(".json") ? new Response(manifest as BodyInit) : new Response("upstream", { status })) as typeof fetch });
|
||||
const unavailable = await failing(502);
|
||||
assert.equal(unavailable.status, 503);
|
||||
assert.equal((await unavailable.json()).error, "unavailable");
|
||||
assert.equal((await failing(404)).status, 404);
|
||||
});
|
||||
|
||||
test("kept manifests count their parsed size against the cache: the oldest goes when the next would not fit", async () => {
|
||||
const big = (label: string) => zip({ "exploration.json": new TextEncoder().encode(JSON.stringify({ ...explorationReport, padding: label.repeat(6 * 1024 * 1024) })), [`assets/${pngSha}.png`]: png });
|
||||
const listing = ["first", "second"].map(target => ({ target, platform: "ios", label: target, path: `/p/${token}/targets/${target}.json` }));
|
||||
const env: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
|
||||
const site = await deployment({ [listing[0]!.path]: big("a"), [listing[1]!.path]: big("b") }, env);
|
||||
assert.equal((await site.get("/api/v1?target=first")).status, 200);
|
||||
assert.deepEqual([...site.cache.keys()], [`${origin}${listing[0]!.path}`]);
|
||||
// Two 6 MB manifests are about 36 MB once parsed, over the 32 MB the isolate keeps.
|
||||
assert.equal((await site.get("/api/v1?target=second")).status, 200);
|
||||
assert.deepEqual([...site.cache.keys()], [`${origin}${listing[1]!.path}`]);
|
||||
});
|
||||
@@ -1,150 +1,110 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { webcrypto } from "node:crypto";
|
||||
import { PREVIEW_CIPHER, previewConfig, previewResponse, type PreviewEnvironment } from "../src/server/preview";
|
||||
import { previewConfig, previewResponse, type PreviewEnvironment } from "../src/server/preview";
|
||||
|
||||
const subtle = webcrypto.subtle as SubtleCrypto;
|
||||
const token = "abcdefghijklmnopqrstuvwxyz234567";
|
||||
const html = '<!doctype html><script type="module" src="/viewer/assets/main.js"></script>';
|
||||
const report: Uint8Array<ArrayBuffer> = new TextEncoder().encode("PK\u0003\u0004 a small report archive stand-in");
|
||||
|
||||
async function sealed(keyBytes: Uint8Array<ArrayBuffer>, plain: Uint8Array<ArrayBuffer> = report): Promise<Uint8Array<ArrayBuffer>> {
|
||||
const key = await subtle.importKey("raw", keyBytes, "AES-GCM", false, ["encrypt"]);
|
||||
const iv = webcrypto.getRandomValues(new Uint8Array(PREVIEW_CIPHER.ivBytes));
|
||||
const cipher = new Uint8Array(await subtle.encrypt({ name: "AES-GCM", iv, additionalData: new TextEncoder().encode(PREVIEW_CIPHER.aad) }, key, plain));
|
||||
const out = new Uint8Array(iv.byteLength + cipher.byteLength);
|
||||
out.set(iv); out.set(cipher, iv.byteLength);
|
||||
return out;
|
||||
}
|
||||
|
||||
const keyBytes: Uint8Array<ArrayBuffer> = webcrypto.getRandomValues(new Uint8Array(32));
|
||||
const env: PreviewEnvironment = {
|
||||
EXPLORE_PREVIEW_TOKEN: token,
|
||||
EXPLORE_PREVIEW_KEY: Buffer.from(keyBytes).toString("base64"),
|
||||
EXPLORE_PREVIEW_EXPIRES_AT: "2030-01-01T00:00:00Z",
|
||||
EXPLORE_PREVIEW_REPORT: "/_report/abcdefghijklmnop/report.zip.enc",
|
||||
};
|
||||
const env: PreviewEnvironment = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/report.json` };
|
||||
const origin = "https://acme-explore--k7f3z0d1q8.expo.app";
|
||||
/** The manifest route streams the static file through unparsed, so a stand-in names the report it is. */
|
||||
const standIn = (name: string) => new TextEncoder().encode(`manifest of ${name}`);
|
||||
|
||||
test("after the sealed expiry the exact token still opens the Viewer and the report routes answer 410 with the instant; no expiry means never", async () => {
|
||||
const options = { env, indexHtml: html, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) }), subtle };
|
||||
const before = { ...options, now: () => Date.parse("2029-12-31T23:59:59Z") };
|
||||
const after = { ...options, now: () => Date.parse("2030-01-01T00:00:00Z") };
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), before)).status, 200);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), before)).status, 200);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { headers: { accept: "text/html" } }), after)).status, 200, "a browser still gets the shell, which explains the expiry");
|
||||
for (const path of ["", "/report.zip", "/reports.json", "/report.zip?platform=ios"]) {
|
||||
const response = await previewResponse(new Request(`${origin}/p/${token}${path}`), after);
|
||||
assert.equal(response.status, 410, path);
|
||||
assert.equal(response.headers.get("cache-control"), "private, no-store", path);
|
||||
assert.deepEqual(await response.json(), { error: "expired", expiredAt: "2030-01-01T00:00:00.000Z" }, path);
|
||||
}
|
||||
const wrongToken = token.replace(/a/, "b");
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${wrongToken}/report.zip`), after)).status, 404, "a wrong token never learns about the expiry");
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { method: "POST" }), after)).status, 404);
|
||||
const never = { ...after, env: { ...env, EXPLORE_PREVIEW_EXPIRES_AT: undefined } };
|
||||
assert.equal(previewConfig(never.env)?.expiresAt, null);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), never)).status, 200);
|
||||
});
|
||||
|
||||
function staticFiles(files: Record<string, Uint8Array<ArrayBuffer>>): typeof fetch {
|
||||
function staticFiles(files: Record<string, Uint8Array>): typeof fetch {
|
||||
const calls: string[] = [];
|
||||
const impl = (async (input: RequestInfo | URL) => {
|
||||
const url = new URL(typeof input === "string" ? input : input instanceof URL ? input.href : input.url);
|
||||
calls.push(url.href);
|
||||
const body = files[url.pathname];
|
||||
return body ? new Response(body, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
|
||||
return body ? new Response(body as BodyInit, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
|
||||
}) as typeof fetch;
|
||||
(impl as typeof fetch & { calls: string[] }).calls = calls;
|
||||
return impl;
|
||||
}
|
||||
const options = (environment: PreviewEnvironment, files: Record<string, Uint8Array>) =>
|
||||
({ env: environment, indexHtml: html, fetchImpl: staticFiles(files), cache: new Map(), loading: new Map() });
|
||||
|
||||
test("the sealed configuration is read strictly", () => {
|
||||
assert.ok(previewConfig(env));
|
||||
test("the configuration is read strictly, and a report's manifest must sit under the deployment's own token", () => {
|
||||
assert.deepEqual(previewConfig(env), { token, reports: [{ target: "ios", platform: "ios", path: env.EXPLORE_PREVIEW_REPORT }] });
|
||||
const otherToken = token.replace(/a/, "b");
|
||||
for (const broken of [
|
||||
{ EXPLORE_PREVIEW_TOKEN: "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" }, { EXPLORE_PREVIEW_TOKEN: token.slice(1) }, { EXPLORE_PREVIEW_TOKEN: undefined },
|
||||
{ EXPLORE_PREVIEW_KEY: Buffer.alloc(16).toString("base64") }, { EXPLORE_PREVIEW_KEY: "not base64!" },
|
||||
{ EXPLORE_PREVIEW_EXPIRES_AT: "soon" }, { EXPLORE_PREVIEW_REPORT: "/report.zip.enc" }, { EXPLORE_PREVIEW_REPORT: "/_report/../x/report.zip.enc" },
|
||||
{ EXPLORE_PREVIEW_REPORT: "/report.json" }, { EXPLORE_PREVIEW_REPORT: `/p/${otherToken}/targets/report.json` },
|
||||
{ EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/../report.json` }, { EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/ios.json` },
|
||||
{ EXPLORE_PREVIEW_REPORT: "/_report/abcdefghijklmnop/report.zip.enc" },
|
||||
]) assert.equal(previewConfig({ ...env, ...broken }), undefined, JSON.stringify(broken));
|
||||
});
|
||||
|
||||
test("the token page serves the Viewer shell and the report route streams the decrypted report", async () => {
|
||||
const fetchImpl = staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) });
|
||||
const page = await previewResponse(new Request(`${origin}/p/${token}?view=compare&screen=home#/map`), { env, indexHtml: html, fetchImpl, subtle });
|
||||
test("the token page serves the Viewer shell, and the manifest route answers the target's static manifest", async () => {
|
||||
const files = { [env.EXPLORE_PREVIEW_REPORT!]: standIn("report") };
|
||||
const page = await previewResponse(new Request(`${origin}/p/${token}?view=compare&screen=home#/map`), options(env, files));
|
||||
assert.equal(page.status, 200);
|
||||
// A stand-in is not a manifest the index can read, so the shell is the plain Viewer.
|
||||
assert.equal(await page.text(), html);
|
||||
assert.equal(page.headers.get("cache-control"), "private, no-store");
|
||||
assert.equal(page.headers.get("referrer-policy"), "no-referrer");
|
||||
assert.match(page.headers.get("content-security-policy") ?? "", /frame-ancestors 'none'/);
|
||||
const slash = await previewResponse(new Request(`${origin}/p/${token}/`), { env, indexHtml: html, fetchImpl, subtle });
|
||||
assert.equal(slash.status, 200);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/`), options(env, files))).status, 200);
|
||||
|
||||
const zip = await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { env, indexHtml: html, fetchImpl, subtle });
|
||||
assert.equal(zip.status, 200);
|
||||
assert.equal(zip.headers.get("content-type"), "application/zip");
|
||||
assert.equal(zip.headers.get("content-length"), String(report.byteLength));
|
||||
assert.deepEqual(new Uint8Array(await zip.arrayBuffer()), report);
|
||||
// Only the sealed report file is ever fetched, whether for the shell's inline index or the zip route.
|
||||
const calls = (fetchImpl as typeof fetch & { calls: string[] }).calls;
|
||||
assert.ok(calls.length >= 1 && calls.every(call => call === `${origin}${env.EXPLORE_PREVIEW_REPORT}`), calls.join());
|
||||
const manifest = await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), options(env, files));
|
||||
assert.equal(manifest.status, 200);
|
||||
assert.equal(manifest.headers.get("content-type"), "application/json; charset=utf-8");
|
||||
assert.equal(manifest.headers.get("cache-control"), "private, no-store");
|
||||
assert.equal(await manifest.text(), "manifest of report");
|
||||
});
|
||||
|
||||
test("everything else is the same 404: wrong token, other paths, other methods, bad ciphertext, missing file", async () => {
|
||||
const good = await sealed(keyBytes);
|
||||
const files = { [env.EXPLORE_PREVIEW_REPORT!]: good };
|
||||
const options = { env, indexHtml: html, fetchImpl: staticFiles(files), subtle };
|
||||
test("everything else is the same 404: wrong token, other paths, other methods, a missing manifest; a failing fetch is a 503", async () => {
|
||||
const files = { [env.EXPLORE_PREVIEW_REPORT!]: standIn("report") };
|
||||
const wrongToken = token.replace(/a/, "b");
|
||||
for (const path of [`/p/${wrongToken}`, `/p/${wrongToken}/report.zip`, `/p/${token.toUpperCase()}`, `/p/${token}/viewer/assets/main.js`,
|
||||
`/p/${token}/other.zip`, `/p/${token}/report.zip/`, `/p/${token}x`, "/p", "/p/", "/", "/_report/abcdefghijklmnop/report.zip.enc", `/P/${token}`]) {
|
||||
const response = await previewResponse(new Request(origin + path), options);
|
||||
for (const path of [`/p/${wrongToken}`, `/p/${wrongToken}/manifest.json`, `/p/${token.toUpperCase()}`, `/p/${token}/viewer/assets/main.js`,
|
||||
`/p/${token}/report.zip`, `/p/${token}/assets/${"0".repeat(64)}.png`, `/p/${token}/targets/report.json`, `/p/${token}/manifest.json/`,
|
||||
`/p/${token}x`, "/p", "/p/", "/", `/P/${token}`]) {
|
||||
const response = await previewResponse(new Request(origin + path), options(env, files));
|
||||
assert.equal(response.status, 404, path);
|
||||
assert.equal(await response.text(), "Not found", path);
|
||||
assert.equal(response.headers.get("cache-control"), "private, no-store", path);
|
||||
}
|
||||
for (const method of ["HEAD", "POST", "PUT", "DELETE", "OPTIONS"]) {
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { method }), options)).status, 404, method);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { method }), options(env, files))).status, 404, method);
|
||||
}
|
||||
|
||||
const otherKey: Uint8Array<ArrayBuffer> = webcrypto.getRandomValues(new Uint8Array(32));
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(otherKey) }) })).status, 404);
|
||||
const tampered = Uint8Array.from(good); tampered[tampered.length - 1] = (tampered[tampered.length - 1] ?? 0) ^ 1;
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: tampered }) })).status, 404);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, fetchImpl: staticFiles({}) })).status, 404);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, env: { ...env, EXPLORE_PREVIEW_KEY: undefined } })).status, 404);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), options(env, {}))).status, 404, "a deployment missing its manifest");
|
||||
const failing = { ...options(env, files), fetchImpl: (async () => new Response("upstream", { status: 502 })) as typeof fetch };
|
||||
const unavailable = await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), failing);
|
||||
assert.equal(unavailable.status, 503);
|
||||
assert.equal(unavailable.headers.get("retry-after"), "1");
|
||||
const throwing = { ...options(env, files), fetchImpl: (async () => { throw new TypeError("network"); }) as typeof fetch };
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), throwing)).status, 503);
|
||||
});
|
||||
|
||||
test("a multi-platform deployment serves reports.json, one report per platform, and rejects loose configuration", async () => {
|
||||
const android: Uint8Array<ArrayBuffer> = new TextEncoder().encode("PK\u0003\u0004 android report stand-in");
|
||||
test("a multi-platform deployment serves reports.json, one manifest per platform, and rejects loose configuration", async () => {
|
||||
const reports = [
|
||||
{ platform: "ios", path: "/_report/abcdefghijklmnop/ios.zip.enc", changes: 3, device: "iPhone 17 Pro 26.0" },
|
||||
{ platform: "android", path: "/_report/abcdefghijklmnop/android.zip.enc", changes: 0, device: "Pixel 7 15" },
|
||||
{ platform: "ios", path: `/p/${token}/targets/ios.json`, changes: 3, device: "iPhone 17 Pro 26.0" },
|
||||
{ platform: "android", path: `/p/${token}/targets/android.json`, changes: 0, device: "Pixel 7 15" },
|
||||
];
|
||||
const { EXPLORE_PREVIEW_REPORT: _single, ...rest } = env;
|
||||
const multi: PreviewEnvironment = { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(reports) };
|
||||
const fetchImpl = staticFiles({ [reports[0]!.path]: await sealed(keyBytes), [reports[1]!.path]: await sealed(keyBytes, android) });
|
||||
const options = { env: multi, indexHtml: html, fetchImpl, subtle };
|
||||
const files = { [reports[0]!.path]: standIn("ios"), [reports[1]!.path]: standIn("android") };
|
||||
// A listing from before targets names each report by its platform, which is then its target.
|
||||
assert.deepEqual(previewConfig(multi)?.reports, reports.map(entry => ({ target: entry.platform, ...entry })));
|
||||
|
||||
const list = await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options);
|
||||
const list = await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options(multi, files));
|
||||
assert.equal(list.status, 200);
|
||||
assert.equal(list.headers.get("content-type"), "application/json; charset=utf-8");
|
||||
assert.equal(list.headers.get("cache-control"), "private, no-store");
|
||||
assert.deepEqual(await list.json(), [{ target: "ios", platform: "ios", changes: 3, device: "iPhone 17 Pro 26.0" }, { target: "android", platform: "android", changes: 0, device: "Pixel 7 15" }]);
|
||||
|
||||
const first = await previewResponse(new Request(`${origin}/p/${token}/report.zip`), options);
|
||||
assert.deepEqual(new Uint8Array(await first.arrayBuffer()), report);
|
||||
const ios = await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=ios`), options);
|
||||
assert.deepEqual(new Uint8Array(await ios.arrayBuffer()), report);
|
||||
const second = await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=android`), options);
|
||||
assert.deepEqual(new Uint8Array(await second.arrayBuffer()), android);
|
||||
for (const path of ["/report.zip?platform=web", "/report.zip?platform=ios&platform=android", "/reports.json/", "/report.zip?platform="]) {
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}${path}`), options)).status, 404, path);
|
||||
}
|
||||
const manifest = async (query: string) => {
|
||||
const response = await previewResponse(new Request(`${origin}/p/${token}/manifest.json${query}`), options(multi, files));
|
||||
return response.status === 200 ? await response.text() : response.status;
|
||||
};
|
||||
assert.equal(await manifest(""), "manifest of ios");
|
||||
assert.equal(await manifest("?platform=ios"), "manifest of ios");
|
||||
assert.equal(await manifest("?platform=android"), "manifest of android");
|
||||
for (const query of ["?platform=web", "?platform=ios&platform=android", "?platform="]) assert.equal(await manifest(query), 404, query);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/reports.json/`), options(multi, files))).status, 404);
|
||||
// Single-report deployments still answer reports.json (one iOS entry) and ignore an unknown platform.
|
||||
const single = { env, indexHtml: html, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) }), subtle };
|
||||
const single = options(env, { [env.EXPLORE_PREVIEW_REPORT!]: standIn("report") });
|
||||
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), single)).json(), [{ target: "ios", platform: "ios" }]);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=android`), single)).status, 404);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/manifest.json?platform=android`), single)).status, 404);
|
||||
|
||||
const loose: Array<[string, unknown]> = [
|
||||
["both variables", { ...multi, EXPLORE_PREVIEW_REPORT: env.EXPLORE_PREVIEW_REPORT }],
|
||||
@@ -153,34 +113,32 @@ test("a multi-platform deployment serves reports.json, one report per platform,
|
||||
["duplicate platform", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([reports[0], reports[0]]) }],
|
||||
["unknown platform", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "web", path: reports[0]!.path }]) }],
|
||||
["foreign path", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "ios", path: "https://example.invalid/x" }]) }],
|
||||
["another token's path", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], path: `/p/${token.replace(/a/, "b")}/targets/ios.json` }]) }],
|
||||
["extra key", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], url: "x" }]) }],
|
||||
["bad changes", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], changes: -1 }]) }],
|
||||
["markup device", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], device: "<b>x</b>" }]) }],
|
||||
];
|
||||
for (const [name, value] of loose) {
|
||||
assert.equal(previewConfig(value as PreviewEnvironment), undefined, name);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), { ...options, env: value as PreviewEnvironment })).status, 404, name);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), options(value as PreviewEnvironment, files))).status, 404, name);
|
||||
}
|
||||
});
|
||||
|
||||
test("a deployment of several targets, three of them iOS, selects by ?target= and still by ?platform=", async () => {
|
||||
const targets = [
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", path: "/_report/abcdefghijklmnop/iphone.zip.enc", changes: 1 },
|
||||
{ target: "duo-closed", platform: "ios", label: "iPhone Duo (closed)", path: "/_report/abcdefghijklmnop/duo-closed.zip.enc" },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: "/_report/abcdefghijklmnop/duo-open.zip.enc", device: "iPhone Duo 26.0" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "/_report/abcdefghijklmnop/android.zip.enc" },
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", path: `/p/${token}/targets/iphone.json`, changes: 1 },
|
||||
{ target: "duo-closed", platform: "ios", label: "iPhone Duo (closed)", path: `/p/${token}/targets/duo-closed.json` },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: `/p/${token}/targets/duo-open.json`, device: "iPhone Duo 26.0" },
|
||||
{ target: "android", platform: "android", label: "Android", path: `/p/${token}/targets/android.json` },
|
||||
];
|
||||
const bodies = targets.map(entry => new TextEncoder().encode(`PK\u0003\u0004 ${entry.target} report stand-in`));
|
||||
const { EXPLORE_PREVIEW_REPORT: _single, ...rest } = env;
|
||||
const multi: PreviewEnvironment = { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(targets) };
|
||||
const files: Record<string, Uint8Array<ArrayBuffer>> = {};
|
||||
for (const [index, entry] of targets.entries()) files[entry.path] = await sealed(keyBytes, bodies[index]!);
|
||||
const options = { env: multi, indexHtml: html, fetchImpl: staticFiles(files), subtle };
|
||||
const files = Object.fromEntries(targets.map(entry => [entry.path, standIn(entry.target)]));
|
||||
assert.deepEqual(previewConfig(multi)?.reports, targets);
|
||||
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options)).json(), targets.map(({ path: _path, ...entry }) => entry));
|
||||
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options(multi, files))).json(), targets.map(({ path: _path, ...entry }) => entry));
|
||||
const served = async (query: string) => {
|
||||
const response = await previewResponse(new Request(`${origin}/p/${token}/report.zip${query}`), options);
|
||||
return response.status === 200 ? new TextDecoder().decode(await response.arrayBuffer()).split(" ")[1] : response.status;
|
||||
const response = await previewResponse(new Request(`${origin}/p/${token}/manifest.json${query}`), options(multi, files));
|
||||
return response.status === 200 ? (await response.text()).replace("manifest of ", "") : response.status;
|
||||
};
|
||||
assert.equal(await served(""), "iphone", "the first listed");
|
||||
assert.equal(await served("?target=duo-open"), "duo-open");
|
||||
@@ -191,14 +149,14 @@ test("a deployment of several targets, three of them iOS, selects by ?target= an
|
||||
assert.equal(await served(query), 404, query);
|
||||
}
|
||||
|
||||
const eight = Array.from({ length: 8 }, (_, index) => ({ target: `t${index}`, platform: "ios", path: `/_report/abcdefghijklmnop/t${index}.zip.enc` }));
|
||||
const eight = Array.from({ length: 8 }, (_, index) => ({ target: `t${index}`, platform: "ios", path: `/p/${token}/targets/t${index}.json` }));
|
||||
assert.equal(previewConfig({ ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(eight) })?.reports.length, 8);
|
||||
const loose: Array<[string, unknown]> = [
|
||||
["nine targets", [...eight, { target: "t8", platform: "ios", path: "/_report/abcdefghijklmnop/t8.zip.enc" }]],
|
||||
["nine targets", [...eight, { target: "t8", platform: "ios", path: `/p/${token}/targets/t8.json` }]],
|
||||
["duplicate target", [targets[0], { ...targets[1], target: "iphone", path: targets[0]!.path }]],
|
||||
["invalid id", [{ ...targets[0], target: "iPhone", path: "/_report/abcdefghijklmnop/iPhone.zip.enc" }]],
|
||||
["reserved id", [{ ...targets[0], target: "report", path: "/_report/abcdefghijklmnop/report.zip.enc" }]],
|
||||
["install id", [{ ...targets[0], target: "install-x", path: "/_report/abcdefghijklmnop/install-x.zip.enc" }]],
|
||||
["invalid id", [{ ...targets[0], target: "iPhone", path: `/p/${token}/targets/iPhone.json` }]],
|
||||
["reserved id", [{ ...targets[0], target: "report", path: `/p/${token}/targets/report.json` }]],
|
||||
["install id", [{ ...targets[0], target: "install-x", path: `/p/${token}/targets/install-x.json` }]],
|
||||
["path of another target", [{ ...targets[0], path: targets[1]!.path }]],
|
||||
["null target", [{ ...targets[0], target: null }]],
|
||||
["markup label", [{ ...targets[0], label: "<b>x</b>" }]],
|
||||
|
||||
+132
-49
@@ -1,5 +1,5 @@
|
||||
import { appearanceLabel, appearanceOptions, appearanceScope, filterComparisonAppearance, filterMapAppearance, filterReviewAppearance, type Appearance } from "./utils/appearance";
|
||||
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
|
||||
import { appearanceLabel, appearanceOptions, appearanceScope, filterComparisonAppearance, filterMapAppearance, filterReviewAppearance, rememberAppearance, rememberedAppearance, type Appearance } from "./utils/appearance";
|
||||
import { memo, useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
|
||||
import { createPortal, flushSync } from "react-dom";
|
||||
import { AlertCircle, RefreshCw } from "lucide-react";
|
||||
import { Toaster } from "sonner";
|
||||
@@ -11,12 +11,15 @@ import { CanvasVisibleFrameProvider } from "./components/canvas/visible-frame-pr
|
||||
import { AppLoading } from "./components/shared/app-loading";
|
||||
import { ReportLoadingShell } from "./components/shared/report-loading-shell";
|
||||
import { screenLabel } from "./utils/screen-path";
|
||||
import { AppPill, PLATFORM_NAMES } from "./components/panels/app-pill";
|
||||
import { AppPill, PLATFORM_NAMES, runTargets, siblingReportUrl, targetSwitch } from "./components/panels/app-pill";
|
||||
import { useFullscreen } from "./components/panels/shell-actions";
|
||||
import { getCanvasZoomState, runCanvasZoomCommand } from "./utils/canvas-zoom";
|
||||
import { commandItems, suggestedCommands } from "./utils/commands";
|
||||
import { changedScreens, focusCounts as countFocusStatuses, isCapturedChange, type ChangedScreen } from "./utils/changed-screens";
|
||||
import { MapView } from "./components/views/semantic-map";
|
||||
import { RightPanel } from "./components/panels/right";
|
||||
import { SearchCommand } from "./components/search-command";
|
||||
import { ScreensView } from "./components/views/screens";
|
||||
import { FIND_KEY, ScreensView } from "./components/views/screens";
|
||||
import { publicReviewProjection, publicReviewToWorkspace } from "./public/public-workspace";
|
||||
import type { PublicReview } from "../../src/contracts/capture";
|
||||
import {
|
||||
@@ -287,11 +290,12 @@ export function App() {
|
||||
{...(droppable ? { onOpenFile: openFile } : {})}
|
||||
{...(droppable && source.status === "failed" ? { onRetry: retry } : {})} />;
|
||||
}
|
||||
// A hosted preview switches targets in place; the new report gets a fresh Viewer.
|
||||
return <ViewerApp key={source.reportKey} />;
|
||||
// A hosted preview switches targets in place; the running Viewer swaps in the new report.
|
||||
return <ViewerApp reportKey={source.reportKey} />;
|
||||
}
|
||||
|
||||
function ViewerApp() {
|
||||
// The report source changes on every chunk while another target downloads; the Viewer re-renders only for a new report.
|
||||
const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number }) {
|
||||
const [payload, setPayload] = useState<ViewerPayload>();
|
||||
const [workspace, setWorkspace] = useState<ViewerWorkspace>();
|
||||
const [loadedPublicReview, setLoadedPublicReview] = useState<PublicReview>();
|
||||
@@ -305,8 +309,13 @@ function ViewerApp() {
|
||||
const routeRef = useRef(route);
|
||||
const contextRef = useRef(EMPTY_ROUTE_CONTEXT);
|
||||
const [mapProjectionFitKey, setMapProjectionFitKey] = useState(0);
|
||||
// A report captured in several appearances shows one at a time; the primary (first captured) is the default.
|
||||
const [appearanceChoice, setAppearanceChoice] = useState<Appearance | undefined>();
|
||||
// A report captured in several appearances shows one at a time: the one this tab chose for the review (so a target
|
||||
// switch keeps it) when this report has it, the primary (first captured) otherwise.
|
||||
const [appearanceChoice, setAppearanceChoice] = useState<Appearance | undefined>(rememberedAppearance);
|
||||
const chooseAppearance = useCallback((appearance: Appearance) => {
|
||||
rememberAppearance(appearance);
|
||||
setAppearanceChoice(appearance);
|
||||
}, []);
|
||||
// For the ⇧T shortcut, which steps to the next captured appearance; set once they are known.
|
||||
const appearanceRef = useRef<{ options: readonly Appearance[]; current: Appearance | undefined }>({ options: [], current: undefined });
|
||||
const [handoffOpen, setHandoffOpen] = useState(false);
|
||||
@@ -317,7 +326,11 @@ function ViewerApp() {
|
||||
const focusSeq = useRef(0);
|
||||
const landed = useRef(false);
|
||||
const [searchOpen, setSearchOpen] = useState(false);
|
||||
/** `/` on another canvas: Screens opens with its find field focused; each press is a new request. */
|
||||
const [findRequest, setFindRequest] = useState<number>();
|
||||
const clearFindRequest = useCallback(() => setFindRequest(undefined), []);
|
||||
const [shortcutsOpen, setShortcutsOpen] = useState(false);
|
||||
const [fullscreen, toggleFullscreen] = useFullscreen();
|
||||
// Compare steps through the changed screens in review order. Callbacks read it from a ref,
|
||||
// because they are created before the diff that produces it.
|
||||
const compareOrderRef = useRef<readonly ChangedScreen[]>([]);
|
||||
@@ -379,41 +392,60 @@ function ViewerApp() {
|
||||
setThemePreference(current => (current === "system" ? preferredSystemTheme : current) === "dark" ? "light" : "dark");
|
||||
}, [preferredSystemTheme]);
|
||||
|
||||
/** Takes the report the page holds (an opened file, a hosted preview's target), synchronously; false when there is none. */
|
||||
const adoptEmbeddedReport = useCallback((): boolean => {
|
||||
if (REPORT_SOURCE.data?.exploration) {
|
||||
const { map, coverage } = REPORT_SOURCE.data.exploration;
|
||||
workspaceModeRef.current = false;
|
||||
revisionRef.current = { runId: map.run.id, revision: map.revision };
|
||||
setLoadedPublicReview(undefined);
|
||||
setWorkspace(undefined);
|
||||
setPayload({ map, coverage });
|
||||
const nextContext = routeContextForMap(map);
|
||||
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
|
||||
contextRef.current = nextContext;
|
||||
routeRef.current = nextRoute;
|
||||
setRoute(nextRoute);
|
||||
setError(undefined);
|
||||
return true;
|
||||
}
|
||||
if (REPORT_SOURCE.data) {
|
||||
const publicReview = REPORT_SOURCE.data.publicReview;
|
||||
const body = publicReview ? publicReviewToWorkspace(publicReview) : REPORT_SOURCE.data.workspace!;
|
||||
const current = body.builds[body.catalog.currentBuildId];
|
||||
if (!current) throw new Error(`Current build is missing: ${body.catalog.currentBuildId}`);
|
||||
workspaceModeRef.current = true;
|
||||
setLoadedPublicReview(publicReview);
|
||||
setWorkspace(body);
|
||||
setPayload(current);
|
||||
const nextContext = routeContextForMap(current.map, body.catalog);
|
||||
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
|
||||
contextRef.current = nextContext;
|
||||
routeRef.current = nextRoute;
|
||||
setRoute(nextRoute);
|
||||
setError(undefined);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}, []);
|
||||
|
||||
// Another report took the page (a hosted preview switched targets): adopt it in this very render, so no frame shows
|
||||
// the old report against the new report's assets, and the chrome, the camera and the view stay instead of a fresh
|
||||
// Viewer flashing its loading screen and an empty canvas.
|
||||
const [shownReportKey, setShownReportKey] = useState(reportKey);
|
||||
if (shownReportKey !== reportKey) {
|
||||
setShownReportKey(reportKey);
|
||||
try {
|
||||
adoptEmbeddedReport();
|
||||
} catch (adoptError) {
|
||||
setError(adoptError instanceof Error ? adoptError.message : String(adoptError));
|
||||
}
|
||||
}
|
||||
|
||||
const load = useCallback(async (silent = false) => {
|
||||
void silent;
|
||||
try {
|
||||
if (REPORT_SOURCE.data?.exploration) {
|
||||
const { map, coverage } = REPORT_SOURCE.data.exploration;
|
||||
workspaceModeRef.current = false;
|
||||
revisionRef.current = { runId: map.run.id, revision: map.revision };
|
||||
setLoadedPublicReview(undefined);
|
||||
setWorkspace(undefined);
|
||||
setPayload({ map, coverage });
|
||||
const nextContext = routeContextForMap(map);
|
||||
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
|
||||
contextRef.current = nextContext;
|
||||
routeRef.current = nextRoute;
|
||||
setRoute(nextRoute);
|
||||
setError(undefined);
|
||||
return;
|
||||
}
|
||||
if (REPORT_SOURCE.data) {
|
||||
const publicReview = REPORT_SOURCE.data.publicReview;
|
||||
const body = publicReview ? publicReviewToWorkspace(publicReview) : REPORT_SOURCE.data.workspace!;
|
||||
const current = body.builds[body.catalog.currentBuildId];
|
||||
if (!current) throw new Error(`Current build is missing: ${body.catalog.currentBuildId}`);
|
||||
workspaceModeRef.current = true;
|
||||
setLoadedPublicReview(publicReview);
|
||||
setWorkspace(body);
|
||||
setPayload(current);
|
||||
const nextContext = routeContextForMap(current.map, body.catalog);
|
||||
const nextRoute = viewerRoute(parseLocation(viewerLocation(), nextContext));
|
||||
contextRef.current = nextContext;
|
||||
routeRef.current = nextRoute;
|
||||
setRoute(nextRoute);
|
||||
setError(undefined);
|
||||
return;
|
||||
}
|
||||
if (adoptEmbeddedReport()) return;
|
||||
if (STATIC_VIEWER_SOURCE.mode === "invalid") {
|
||||
throw new Error(STATIC_VIEWER_SOURCE.error);
|
||||
}
|
||||
@@ -519,7 +551,7 @@ function ViewerApp() {
|
||||
} catch (loadError) {
|
||||
setError(loadError instanceof Error ? loadError.message : String(loadError));
|
||||
}
|
||||
}, []);
|
||||
}, [adoptEmbeddedReport]);
|
||||
|
||||
const poll = useCallback(async () => {
|
||||
if (pollingRef.current) return;
|
||||
@@ -998,6 +1030,14 @@ function ViewerApp() {
|
||||
setShortcutsOpen(true);
|
||||
return;
|
||||
}
|
||||
// "/" finds a screen: on Screens the page itself opens its field; elsewhere it goes to Screens with the field open.
|
||||
if (event.key === FIND_KEY && !event.metaKey && !event.ctrlKey && !event.altKey) {
|
||||
if (routeRef.current.canvas === "screens" || phoneRef.current) return;
|
||||
event.preventDefault();
|
||||
selectCanvas("screens");
|
||||
setFindRequest((count) => (count ?? 0) + 1);
|
||||
return;
|
||||
}
|
||||
if (matchesShortcut(event, SHORTCUTS.app.handoff)) {
|
||||
if (!handoffAvailableRef.current) return;
|
||||
setHandoffOpen(true);
|
||||
@@ -1008,7 +1048,7 @@ function ViewerApp() {
|
||||
const { options, current } = appearanceRef.current;
|
||||
if (options.length < 2) return;
|
||||
const index = current ? options.indexOf(current) : -1;
|
||||
setAppearanceChoice(options[(index + 1) % options.length]);
|
||||
chooseAppearance(options[(index + 1) % options.length]!);
|
||||
} else if (matchesShortcut(event, SHORTCUTS.app.changes)) {
|
||||
setChangesOpen((open) => !open);
|
||||
} else if (matchesShortcut(event, SHORTCUTS.panel.right)) {
|
||||
@@ -1024,7 +1064,7 @@ function ViewerApp() {
|
||||
return () => {
|
||||
window.removeEventListener("keydown", onKeyDown);
|
||||
};
|
||||
}, [clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleRightPanel]);
|
||||
}, [chooseAppearance, clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleRightPanel]);
|
||||
|
||||
// A side-panel row or a deep link is a "go to": the camera fits that screen and the step is
|
||||
// kept. Screens inventory clicks only select in place; Map clicks also focus the chosen screen. Repeating a selected target refits it without adding history.
|
||||
@@ -1199,6 +1239,8 @@ function ViewerApp() {
|
||||
? { ...presentedMap, run: { ...presentedMap.run, name: workspace.catalog.name } }
|
||||
: presentedMap
|
||||
), [presentedMap, workspace]);
|
||||
// The shortcuts list names the target keys only where the pill can switch.
|
||||
const switchTargets = map ? targetSwitch(map.run, new URL(window.location.href)) : undefined;
|
||||
// Focus singles out diff states, so it means nothing without a baseline to diff against.
|
||||
const focusFilter = diff ? route.focus : [];
|
||||
const focusCounts = useMemo(() => countFocusStatuses(diff), [diff]);
|
||||
@@ -1520,6 +1562,44 @@ function ViewerApp() {
|
||||
};
|
||||
const openHandoff = () => setHandoffOpen(true);
|
||||
handoffAvailableRef.current = Boolean(handoffInput);
|
||||
// ⌘K: the commands for this canvas, built while the palette is open, ahead of the screens in its search.
|
||||
const paletteCommands = searchOpen ? commandItems({
|
||||
canvas: route.canvas,
|
||||
phone,
|
||||
changed: compareOrder,
|
||||
selectedScreenId,
|
||||
find: !phone,
|
||||
handoff: Boolean(handoffInput),
|
||||
pullRequest: review?.pullRequest,
|
||||
theme: themePreference,
|
||||
appearances: appearances.length > 1 ? appearances.map((option) => ({ id: option, label: appearanceLabel(option), current: option === appearance })) : [],
|
||||
inspector: phone || comparingScreens ? undefined : { open: !rightCollapsed },
|
||||
fullscreen: !phone && typeof document.documentElement.requestFullscreen === "function" ? fullscreen : undefined,
|
||||
targets: (() => {
|
||||
const run = runTargets(map.run);
|
||||
const noun = run.targets.every((target) => target.id === target.platform) ? "platform" as const : "device" as const;
|
||||
const page = new URL(window.location.href);
|
||||
return run.targets.flatMap((target, place) => target.id !== run.current && siblingReportUrl(page, target.id) ? [{ id: target.id, label: target.label, platform: target.platform, place, noun }] : []);
|
||||
})(),
|
||||
camera: !phone && route.canvas === "map" && Boolean(getCanvasZoomState().api),
|
||||
}, {
|
||||
selectCanvas,
|
||||
openFind: () => { selectCanvas("screens"); setFindRequest((count) => (count ?? 0) + 1); },
|
||||
openHandoff,
|
||||
openShortcuts: () => setShortcutsOpen(true),
|
||||
toggleChanges: () => setChangesOpen((open) => !open),
|
||||
openChangedScreen,
|
||||
setTheme: setThemePreference,
|
||||
chooseAppearance,
|
||||
toggleInspector: toggleRightPanel,
|
||||
toggleFullscreen,
|
||||
switchTarget: (id) => {
|
||||
const url = siblingReportUrl(new URL(window.location.href), id);
|
||||
if (url && !REPORT_SOURCE.switchTarget(id, url)) window.location.assign(url);
|
||||
},
|
||||
zoom: (command) => runCanvasZoomCommand(command === "fit" && getCanvasZoomState().api?.hasSelection() ? "selection" : command),
|
||||
}) : [];
|
||||
const paletteSuggestions = [...suggestedCommands(paletteCommands, route.canvas), ...searchSuggestions.filter((item) => item.screenId === selectedScreenId)];
|
||||
const handoffAction = handoffInput ? <HandoffButton {...(phone ? { className: "collapsed-search" } : { tooltip: true })} onOpen={openHandoff} /> : null;
|
||||
|
||||
const viewer = (
|
||||
@@ -1531,7 +1611,7 @@ function ViewerApp() {
|
||||
index={index}
|
||||
{...(selectedScreenId ? { selectedScreenId } : {})}
|
||||
{...(review?.pullRequest ? { pullRequest: review.pullRequest } : {})}
|
||||
{...(appearances.length > 1 && appearance ? { appearance: { current: appearance, options: appearances, onChange: setAppearanceChoice } } : {})}
|
||||
{...(appearances.length > 1 && appearance ? { appearance: { current: appearance, options: appearances, onChange: chooseAppearance } } : {})}
|
||||
focus={focusFilter}
|
||||
focusCounts={focusCounts}
|
||||
{...(diff ? { diff } : {})}
|
||||
@@ -1557,6 +1637,8 @@ function ViewerApp() {
|
||||
{...(focusRequest ? { focusRequest } : {})}
|
||||
focus={focusFilter}
|
||||
phone={phone}
|
||||
findRequest={findRequest}
|
||||
onFindRequestDone={clearFindRequest}
|
||||
onSelectScreen={selectScreenOnCanvas}
|
||||
onPickScreen={pickScreenInPlace}
|
||||
onClearSelection={clearSelectedScreen}
|
||||
@@ -1631,7 +1713,8 @@ function ViewerApp() {
|
||||
</CanvasVisibleFrameProvider>
|
||||
{shortcutsOpen ? (
|
||||
<ShortcutsDialog
|
||||
context={{ canvas: route.canvas, review: reviewingInSidebar, hasChanges: compareOrder.length > 0, handoff: Boolean(handoffInput), appearances: appearances.length > 1 }}
|
||||
context={{ canvas: route.canvas, review: reviewingInSidebar, hasChanges: compareOrder.length > 0, handoff: Boolean(handoffInput), appearances: appearances.length > 1,
|
||||
...(switchTargets ? { targets: switchTargets } : {}) }}
|
||||
onClose={() => setShortcutsOpen(false)}
|
||||
/>
|
||||
) : null}
|
||||
@@ -1641,8 +1724,8 @@ function ViewerApp() {
|
||||
) : null}
|
||||
<SearchCommand
|
||||
open={searchOpen}
|
||||
items={searchIndex}
|
||||
suggestions={searchSuggestions}
|
||||
items={[...paletteCommands, ...searchIndex]}
|
||||
suggestions={paletteSuggestions}
|
||||
onClose={closeSearch}
|
||||
onSelectScreen={selectSearchScreen}
|
||||
/>
|
||||
@@ -1675,4 +1758,4 @@ function ViewerApp() {
|
||||
</>
|
||||
);
|
||||
return viewer;
|
||||
}
|
||||
});
|
||||
@@ -2,6 +2,7 @@ import type { CSSProperties, MouseEventHandler, ReactNode } from "react";
|
||||
import { ImageOff, PanelRight } from "lucide-react";
|
||||
import { diffClass, type DiffStatus } from "../../utils/build-diff";
|
||||
import { ScreenPathText } from "../shared/screen-path-text";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { DEFAULT_SCREENSHOT_SIZE, ScreenshotImage } from "../shared/screenshot-image";
|
||||
import { CanvasActiveFrame } from "./active-frame";
|
||||
import { DiffFrame } from "./diff-frame";
|
||||
@@ -30,6 +31,8 @@ export type ScreenScreenshotCardProps = {
|
||||
loading?: "eager" | "lazy";
|
||||
leading?: ReactNode;
|
||||
trailing?: ReactNode;
|
||||
/** Where the "Open in Inspector" tooltip sits: away from the route heading, which is above the screenshot on the Map. */
|
||||
tooltipPlacement?: "top" | "bottom";
|
||||
/** Short lines about the screen, inside the card after its screenshot (Screens: how it was reached, where else it changed). */
|
||||
note?: ReactNode;
|
||||
onClick: MouseEventHandler<HTMLButtonElement>;
|
||||
@@ -89,10 +92,13 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
free of block children. */}
|
||||
<span className="screen-screenshot-slot">
|
||||
{props.leading}
|
||||
{/* With a pointer, what a click does is said once, zoom-independent, in the shared tooltip
|
||||
after its usual delay; the selected screen is already in the Inspector. The button has
|
||||
no title of its own, so no native tooltip joins it; the heading names the screen. */}
|
||||
<Tooltip label="Open in Inspector" placement={props.tooltipPlacement ?? "top"} disabled={Boolean(props.selected)}>
|
||||
<button
|
||||
type="button"
|
||||
className="screen-screenshot-target"
|
||||
title={props.plainTitle ? props.title : props.path}
|
||||
aria-label={props.ariaLabel ?? `Open ${props.plainTitle ? props.title : props.path}`}
|
||||
{...(props.ariaPressed !== undefined ? { "aria-pressed": props.ariaPressed } : {})}
|
||||
onClick={props.onClick}>
|
||||
@@ -108,18 +114,18 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
decoding="async"
|
||||
loading={props.loading ?? "lazy"}
|
||||
fallback={missing}
|
||||
holdPrevious
|
||||
/>
|
||||
) : missing}
|
||||
{/* On hover, says what a click does; on a phone's map, what the second tap does.
|
||||
See styles.css for when each wording shows. */}
|
||||
{/* On a phone's map, says what the second tap on the selected screen does. */}
|
||||
<span className="screen-open-hint" aria-hidden="true">
|
||||
<PanelRight />
|
||||
<span className="screen-open-hint-long">Open in Inspector</span>
|
||||
<span className="screen-open-hint-short">Open</span>
|
||||
<span>Open</span>
|
||||
</span>
|
||||
</span>
|
||||
</DiffFrame>
|
||||
</button>
|
||||
</Tooltip>
|
||||
{props.trailing}
|
||||
</span>
|
||||
{props.note ? <span className="screen-node-note">{props.note}</span> : null}
|
||||
|
||||
@@ -3,7 +3,7 @@ import { useReactFlow, useStore } from "@xyflow/react";
|
||||
import { publishZoom, registerZoomApi, runCanvasZoomCommand } from "../../utils/canvas-zoom";
|
||||
import { isTyping, matchesShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { useCanvasVisibleFrame } from "./visible-frame-provider";
|
||||
import { createKeyHold, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
|
||||
import { createKeyHold, glideWhileHeld, ZOOM_GLIDE, type KeyHold } from "../../utils/key-hold";
|
||||
import {
|
||||
canvasBoundsViewport,
|
||||
canvasPriorityProjectionBounds,
|
||||
@@ -16,7 +16,7 @@ import {
|
||||
} from "./camera";
|
||||
|
||||
const DURATION = 160;
|
||||
/** React Flow's zoomIn/zoomOut step, which a tap of + or − takes. */
|
||||
/** The step a tap of + or − takes, React Flow's own zoomIn/zoomOut step. */
|
||||
const KEY_ZOOM_STEP = 1.2;
|
||||
const PIXEL_WHEEL_ZOOM_RATE = 0.002;
|
||||
const LINE_WHEEL_ZOOM_RATE = 0.05;
|
||||
@@ -216,18 +216,10 @@ export function ZoomBridge(props: {
|
||||
};
|
||||
registerZoomApi(api);
|
||||
|
||||
// A tap of + or − takes one eased step. Held, the OS key repeat is ignored (each repeat
|
||||
// restarting the easing made holding slower than tapping); once the tap's step has landed the
|
||||
// camera glides instead, frame by frame about the pane's centre, as zoomIn does, until the key
|
||||
// is released, the hold is interrupted, or the zoom reaches its limit.
|
||||
const zoomStep = (direction: 1 | -1): boolean => {
|
||||
const viewport = getViewport();
|
||||
const next = Math.min(maxZoom, Math.max(minZoom, viewport.zoom * KEY_ZOOM_STEP ** direction));
|
||||
if (next === viewport.zoom) return false;
|
||||
if (direction === 1) void zoomIn({ duration: DURATION });
|
||||
else void zoomOut({ duration: DURATION });
|
||||
return true;
|
||||
};
|
||||
// A tap of + or − zooms one step; held, the camera keeps gliding from that same motion, frame
|
||||
// by frame about the pane's centre, as zoomIn does, until the key is released, the hold is
|
||||
// interrupted, or the zoom reaches its limit. The OS key repeat is ignored (each repeat
|
||||
// restarting an eased step made holding slower than tapping).
|
||||
const zoomGlide = (direction: 1 | -1) => (steps: number): boolean => {
|
||||
const viewport = getViewport();
|
||||
const zoom = Math.min(maxZoom, Math.max(minZoom, viewport.zoom * KEY_ZOOM_STEP ** (direction * steps)));
|
||||
@@ -273,14 +265,12 @@ export function ZoomBridge(props: {
|
||||
if (!direction) return;
|
||||
event.preventDefault();
|
||||
onCameraGestureStart.current?.();
|
||||
if (!zoomStep(direction)) return;
|
||||
// The hold only tracks the key (released, interrupted, a field or dialog taking over); the
|
||||
// glide reads it every frame and stops with it.
|
||||
hold.begin(event.code, () => true);
|
||||
glideWhileHeld(hold, event.code, DURATION, zoomGlide(direction));
|
||||
glideWhileHeld(hold.begin(event.code, () => true), zoomGlide(direction), ZOOM_GLIDE);
|
||||
};
|
||||
const onKeyUp = (event: KeyboardEvent) => {
|
||||
if (hold.holding(event.code)) hold.end();
|
||||
hold.release(event.code);
|
||||
};
|
||||
|
||||
const onModifierWheel = (event: WheelEvent) => {
|
||||
|
||||
@@ -308,11 +308,14 @@
|
||||
.compare-frame-wrap { position: relative; }
|
||||
/* Flip: one frame, centred under its Before/After names, in Compare and in the Inspector. The wrap
|
||||
is a flex row because a block sized by height + aspect-ratio does not shrink-wrap in every engine
|
||||
(WebKit left the frame at the left edge). */
|
||||
(WebKit left the frame at the left edge). A stacked landscape pair whose frames are held to part
|
||||
of the window's height centres them the same way. */
|
||||
.compare-stage.mode-flip .compare-side,
|
||||
.sidebar-review-stage.mode-flip .compare-side { width: 100%; align-items: center; }
|
||||
.sidebar-review-stage.mode-flip .compare-side,
|
||||
.sidebar-review-stage.mode-split.landscape .compare-side { width: 100%; align-items: center; }
|
||||
.compare-stage.mode-flip .compare-frame-wrap,
|
||||
.sidebar-review-stage.mode-flip .compare-frame-wrap { display: flex; justify-content: center; }
|
||||
.sidebar-review-stage.mode-flip .compare-frame-wrap,
|
||||
.sidebar-review-stage.mode-split.landscape .compare-frame-wrap { display: flex; justify-content: center; }
|
||||
.compare-frame {
|
||||
position: relative;
|
||||
display: block;
|
||||
@@ -496,6 +499,15 @@
|
||||
.sidebar-review-stage.mode-flip {
|
||||
--compare-frame-height: min(calc(100cqw / var(--compare-aspect)), 70dvh);
|
||||
}
|
||||
/* A landscape screenshot (an opened iPhone Duo, an iPad on its side) is too wide for two frames to
|
||||
share the panel: Before stacks over After, each the panel's width, up to about a third of
|
||||
the window's height (half of Swipe's and Flip's one frame), so a near-square pair (an unfolded
|
||||
foldable) and a short window still show both. */
|
||||
.sidebar-review-stage.mode-split.landscape {
|
||||
flex-direction: column;
|
||||
align-items: stretch;
|
||||
--compare-frame-height: min(calc(100cqw / var(--compare-aspect)), 35dvh);
|
||||
}
|
||||
/* Split's labels sit inside the frames here, as Swipe's do. */
|
||||
.compare-side-tag {
|
||||
position: absolute;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
|
||||
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
|
||||
import { ImageOff, ScanSearch } from "lucide-react";
|
||||
import type { ChangesMenuData } from "../panels/changes-menu";
|
||||
import { diffLabel, ACCESSIBILITY_ONLY_HIGHLIGHT, type BuildDiff, type ScreenDiff } from "../../utils/build-diff";
|
||||
@@ -6,13 +6,14 @@ import type { MapIndex } from "../../utils/model";
|
||||
import type { ChangedScreen } from "../../utils/changed-screens";
|
||||
import { groupVisualRegions, layoutShiftSummary, type VisualChange } from "../../utils/visual-diff";
|
||||
import { formatShortcut, matchesShortcut, SHORTCUTS, shortcutsLive } from "../../utils/shortcuts";
|
||||
import { createKeyHold, glideWhileHeld, HOLD_INITIAL_DELAY_MS, type KeyHold } from "../../utils/key-hold";
|
||||
import { createKeyHold, DIVIDER_GLIDE, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
|
||||
import { optionalStorage } from "../../utils/embedded-report";
|
||||
import { usePhoneLayout } from "../../utils/phone-layout";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { DEFAULT_SCREENSHOT_RATIO, ScreenshotImage, ScreenshotPlaceholder } from "../shared/screenshot-image";
|
||||
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand, SwipeCompare, SWIPE_STEP } from "../panels/visual-diff";
|
||||
import { ChangeOutlines, ignoredSystemRegions, SwipeCompare, SystemRegionBands, SWIPE_STEP } from "../panels/visual-diff";
|
||||
import type { SystemRegion } from "../../utils/review-model";
|
||||
import { placeholderFor, presentedChanges, splitForAssistiveTechnology } from "../../utils/presented-changes";
|
||||
import { CompareNav, WhatChangedPopover } from "./compare-header";
|
||||
import "./compare-section.css";
|
||||
@@ -135,7 +136,19 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const [flipSide, setFlipSide] = useState<"before" | "after">("after");
|
||||
const [swipePosition, setSwipePosition] = useState(50);
|
||||
const [factsOpen, setFactsOpen] = useState(false);
|
||||
const [aspect, setAspect] = useState(DEFAULT_SCREENSHOT_RATIO);
|
||||
// The frame takes the recorded screenshot's shape at once, then the loaded image's (they agree
|
||||
// unless the report's record is off), so a landscape pair stacks before its pixels arrive. A
|
||||
// screen with no recorded size keeps the last screen's shape until its own image loads. After
|
||||
// decides, as it does for the recorded shape: Before's image counts only on a screen without one,
|
||||
// so a pair whose shape changed does not take whichever side loaded last.
|
||||
const [loadedAspect, setLoadedAspect] = useState<{ screenId: string; aspect: number }>();
|
||||
const aspect = (loadedAspect?.screenId === options.screenId ? loadedAspect.aspect : undefined)
|
||||
?? screenDiff?.screenshotAspect ?? loadedAspect?.aspect ?? DEFAULT_SCREENSHOT_RATIO;
|
||||
const hasAfter = Boolean(screenDiff?.afterScreenshot);
|
||||
const setAspect = useCallback((value: number, side: "before" | "after") => {
|
||||
if (side === "before" && hasAfter) return;
|
||||
setLoadedAspect({ screenId: options.screenId, aspect: value });
|
||||
}, [options.screenId, hasAfter]);
|
||||
|
||||
// Each screen starts whole: no area selected, After showing, the facts closed.
|
||||
useEffect(() => {
|
||||
@@ -186,10 +199,10 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
holdRef.current ??= createKeyHold();
|
||||
const hold = holdRef.current;
|
||||
useEffect(() => hold.end, [hold]);
|
||||
// The hold only tracks the key; the glide reads it every frame and stops with it.
|
||||
// A tap of [ or ] moves the divider one step; held, it keeps going from the same motion. The hold only
|
||||
// tracks the key; the glide reads it every frame and stops with it.
|
||||
const glideDivider = (code: string, direction: 1 | -1) => {
|
||||
hold.begin(code, () => true);
|
||||
glideWhileHeld(hold, code, HOLD_INITIAL_DELAY_MS, (steps) => moveDivider(direction, steps));
|
||||
glideWhileHeld(hold.begin(code, () => true), (steps) => moveDivider(direction, steps), DIVIDER_GLIDE);
|
||||
};
|
||||
|
||||
useEffect(() => {
|
||||
@@ -225,10 +238,10 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
flip();
|
||||
} else if (matchesShortcut(event, keys.dividerLeft)) {
|
||||
if (state.mode !== "swipe") return;
|
||||
if (moveDivider(-1)) glideDivider(event.code, -1);
|
||||
glideDivider(event.code, -1);
|
||||
} else if (matchesShortcut(event, keys.dividerRight)) {
|
||||
if (state.mode !== "swipe") return;
|
||||
if (moveDivider(1)) glideDivider(event.code, 1);
|
||||
glideDivider(event.code, 1);
|
||||
} else if (matchesShortcut(event, keys.outlines)) {
|
||||
toggleOutlines();
|
||||
} else if (matchesShortcut(event, keys.whatChanged)) {
|
||||
@@ -239,7 +252,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
event.preventDefault();
|
||||
};
|
||||
const onKeyUp = (event: KeyboardEvent) => {
|
||||
if (hold.holding(event.code)) hold.end();
|
||||
hold.release(event.code);
|
||||
};
|
||||
window.addEventListener("keydown", onKeyDown);
|
||||
window.addEventListener("keyup", onKeyUp);
|
||||
@@ -255,6 +268,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const shownOutlines = outlines && areas.length > 0;
|
||||
const statusBarIgnored = (screenDiff?.visual?.ignoredStatusBarRegions ?? 0) > 0;
|
||||
const homeIndicatorIgnored = (screenDiff?.visual?.ignoredHomeIndicatorRegions ?? 0) > 0;
|
||||
const systemRegions = useMemo(() => ignoredSystemRegions(screenDiff?.visual), [screenDiff]);
|
||||
const modeOptions = compareModeOptions();
|
||||
// The switch shows the mode the reviewer chose, not the one-screenshot view a screen with nothing
|
||||
// to compare falls back to. Such a screen turns the whole switch off, with nothing current, so
|
||||
@@ -263,7 +277,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const modesDisabled = !comparable;
|
||||
return {
|
||||
screen, screenDiff, route, position, previous, next, comparable, areas, facts, split, layoutShift, measurable,
|
||||
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, toggleOutlines,
|
||||
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines,
|
||||
activeArea, setActiveArea, stepArea, flipSide, flip, swipePosition, setSwipePosition,
|
||||
aspect, setAspect, factsOpen, setFactsOpen,
|
||||
};
|
||||
@@ -318,7 +332,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
const compare = useCompareController(props);
|
||||
const {
|
||||
screen, screenDiff, route, areas, facts, mode, chooseMode, modeOptions, outlines, shownOutlines,
|
||||
statusBarIgnored, homeIndicatorIgnored, toggleOutlines, activeArea, flipSide, flip, swipePosition, setSwipePosition, aspect,
|
||||
statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines, activeArea, flipSide, flip, swipePosition, setSwipePosition, aspect,
|
||||
setAspect, factsOpen, setFactsOpen,
|
||||
} = compare;
|
||||
const sectionRef = useRef<HTMLElement>(null);
|
||||
@@ -336,8 +350,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
const overlay = shownOutlines ? (
|
||||
<>
|
||||
<ChangeOutlines changes={areas} activeIndex={activeArea} />
|
||||
{statusBarIgnored ? <StatusBarBand /> : null}
|
||||
{homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
|
||||
<SystemRegionBands regions={systemRegions} />
|
||||
</>
|
||||
) : null;
|
||||
|
||||
@@ -390,8 +403,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
areas={areas}
|
||||
activeArea={activeArea}
|
||||
showOutlines={shownOutlines}
|
||||
statusBarIgnored={statusBarIgnored}
|
||||
homeIndicatorIgnored={homeIndicatorIgnored}
|
||||
systemRegions={systemRegions}
|
||||
overlay={overlay}
|
||||
flipSide={flipSide}
|
||||
onFlip={flip}
|
||||
@@ -441,15 +453,15 @@ type StageProps = {
|
||||
areas: VisualChange[];
|
||||
activeArea: number | undefined;
|
||||
showOutlines: boolean;
|
||||
statusBarIgnored: boolean;
|
||||
homeIndicatorIgnored: boolean;
|
||||
systemRegions: readonly SystemRegion[];
|
||||
overlay: ReactNode;
|
||||
flipSide: "before" | "after";
|
||||
onFlip: () => void;
|
||||
swipePosition: number;
|
||||
onSwipePosition: (position: number) => void;
|
||||
aspect: number;
|
||||
onAspect: (aspect: number) => void;
|
||||
/** A screenshot of the stage loaded: its width over its height, and which side it shows. */
|
||||
onAspect: (aspect: number, side: "before" | "after") => void;
|
||||
};
|
||||
|
||||
export function CompareStage(props: StageProps) {
|
||||
@@ -474,11 +486,11 @@ export function CompareStage(props: StageProps) {
|
||||
before={before}
|
||||
after={after}
|
||||
imageAspect={props.aspect}
|
||||
onAspect={props.onAspect}
|
||||
changes={props.areas}
|
||||
activeIndex={props.activeArea}
|
||||
showOutlines={props.showOutlines}
|
||||
statusBarIgnored={props.statusBarIgnored}
|
||||
homeIndicatorIgnored={props.homeIndicatorIgnored}
|
||||
systemRegions={props.systemRegions}
|
||||
position={props.swipePosition}
|
||||
onPositionChange={props.onSwipePosition}
|
||||
labels={props.swipeLabels !== "above"}
|
||||
@@ -514,7 +526,7 @@ export function CompareStage(props: StageProps) {
|
||||
<button type="button" className="compare-frame compare-flip-frame" data-side={showing}
|
||||
aria-label={`Show ${showing === "after" ? "Before" : "After"}`} onClick={props.onFlip}>
|
||||
<CompareImage src={showing === "after" ? after : before} alt={`${props.title}, ${showing}`}
|
||||
placeholder="No screenshot" onAspect={props.onAspect} />
|
||||
placeholder="No screenshot" side={showing} onAspect={props.onAspect} />
|
||||
{props.overlay}
|
||||
</button>
|
||||
</div>
|
||||
@@ -535,7 +547,7 @@ export function CompareStage(props: StageProps) {
|
||||
<div className="compare-frame-wrap">
|
||||
<div className="compare-frame">
|
||||
<CompareImage src={src} alt={`${props.title}, ${showing}`}
|
||||
placeholder={placeholderFor(showing, diff.status, diff.captureNotes)} onAspect={props.onAspect} />
|
||||
placeholder={placeholderFor(showing, diff.status, diff.captureNotes)} side={showing} onAspect={props.onAspect} />
|
||||
</div>
|
||||
</div>
|
||||
</figure>
|
||||
@@ -558,7 +570,7 @@ export function CompareStage(props: StageProps) {
|
||||
<div className="compare-frame">
|
||||
{src ? (
|
||||
<CompareImage src={src} alt={`${props.title}, ${side}`}
|
||||
placeholder={placeholderFor(side, diff.status, diff.captureNotes)} onAspect={props.onAspect} />
|
||||
placeholder={placeholderFor(side, diff.status, diff.captureNotes)} side={side} onAspect={props.onAspect} />
|
||||
) : (
|
||||
<ScreenshotPlaceholder label={placeholderFor(side, diff.status, diff.captureNotes)} />
|
||||
)}
|
||||
@@ -575,7 +587,10 @@ export function CompareStage(props: StageProps) {
|
||||
);
|
||||
}
|
||||
|
||||
function CompareImage(props: { src: string; alt: string; placeholder: string; onAspect: (aspect: number) => void }) {
|
||||
function CompareImage(props: {
|
||||
src: string; alt: string; placeholder: string; side: "before" | "after";
|
||||
onAspect: (aspect: number, side: "before" | "after") => void;
|
||||
}) {
|
||||
return (
|
||||
<ScreenshotImage
|
||||
src={props.src}
|
||||
@@ -586,7 +601,7 @@ function CompareImage(props: { src: string; alt: string; placeholder: string; on
|
||||
fallback={<ScreenshotPlaceholder label={props.placeholder} />}
|
||||
onLoad={(event) => {
|
||||
const { naturalWidth, naturalHeight } = event.currentTarget;
|
||||
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect(naturalWidth / naturalHeight);
|
||||
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect(naturalWidth / naturalHeight, props.side);
|
||||
}}
|
||||
/>
|
||||
);
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { useEffect } from "react";
|
||||
import { createPortal } from "react-dom";
|
||||
import { X } from "lucide-react";
|
||||
import { CANVAS_NUMBER_KEYS, formatShortcut, SHORTCUTS, type Shortcut } from "../../utils/shortcuts";
|
||||
import { CANVAS_NUMBER_KEYS, formatShortcut, SHORTCUTS, TARGET_NUMBER_KEYS, type Shortcut } from "../../utils/shortcuts";
|
||||
import type { CanvasView } from "../../utils/navigation";
|
||||
import { useModalDialog } from "../../hooks/use-modal-dialog";
|
||||
|
||||
@@ -19,8 +19,21 @@ export type ShortcutContext = {
|
||||
handoff?: boolean;
|
||||
/** The report was captured in both light and dark, so the app's appearance can be switched. */
|
||||
appearances?: boolean;
|
||||
/** The run's other targets are one switch away; the pill calls them devices, or platforms in reports from before targets. */
|
||||
targets?: { noun: "device" | "platform"; count: number };
|
||||
};
|
||||
|
||||
function targetRows(targets: NonNullable<ShortcutContext["targets"]>): Row[] {
|
||||
const numbers = SHORTCUTS.targetByNumber.slice(0, Math.min(targets.count, SHORTCUTS.targetByNumber.length));
|
||||
return [
|
||||
{ label: `Another ${targets.noun}'s report`, keys: [SHORTCUTS.target.menu] },
|
||||
...(TARGET_NUMBER_KEYS && numbers.length > 1
|
||||
? [{ label: `A ${targets.noun} by its place in that menu`, keys: [`${formatShortcut(numbers[0]!)}–${formatShortcut(numbers.at(-1)!)}`] }]
|
||||
: []),
|
||||
{ label: `Back to the last ${targets.noun}`, keys: [SHORTCUTS.target.last] },
|
||||
];
|
||||
}
|
||||
|
||||
const COMPARE = SHORTCUTS.compare;
|
||||
|
||||
function reviewGroup(context: ShortcutContext): Group {
|
||||
@@ -68,9 +81,11 @@ export function shortcutGroups(context: ShortcutContext): Group[][] {
|
||||
...(CANVAS_NUMBER_KEYS
|
||||
? [{ label: "The same, by their place in the toolbar", keys: sections.map((section) => SHORTCUTS.canvasByNumber[section]) }]
|
||||
: []),
|
||||
{ label: "Search screens", keys: [SHORTCUTS.app.search] },
|
||||
{ label: "Search screens and commands", keys: [SHORTCUTS.app.search] },
|
||||
{ label: "Find a screen on the Screens page", keys: ["/"] },
|
||||
...(context.handoff ? [{ label: "Hand off to AI", keys: [SHORTCUTS.app.handoff] }] : []),
|
||||
...(context.hasChanges ? [{ label: "Changed screens menu", keys: [SHORTCUTS.app.changes] }] : []),
|
||||
...(context.targets ? targetRows(context.targets) : []),
|
||||
],
|
||||
};
|
||||
const view: Group = {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { type CSSProperties, type ReactNode } from "react";
|
||||
import { ChevronDown } from "lucide-react";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand } from "../panels/visual-diff";
|
||||
import { ChangeOutlines, SystemRegionBands } from "../panels/visual-diff";
|
||||
import { WhatChangedContent, type LayoutShift } from "./compare-header";
|
||||
import {
|
||||
CompareStage,
|
||||
@@ -110,8 +110,7 @@ export function SidebarReview(props: CompareControllerOptions) {
|
||||
? (
|
||||
<>
|
||||
<ChangeOutlines changes={areas} activeIndex={activeArea} />
|
||||
{compare.statusBarIgnored ? <StatusBarBand /> : null}
|
||||
{compare.homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
|
||||
<SystemRegionBands regions={compare.systemRegions} />
|
||||
</>
|
||||
)
|
||||
: null;
|
||||
@@ -123,7 +122,7 @@ export function SidebarReview(props: CompareControllerOptions) {
|
||||
<section className="sidebar-review" aria-label={`Changes in ${route}`}>
|
||||
<ReviewModes value={compare.chosenMode} disabled={compare.modesDisabled} onChange={compare.chooseMode} />
|
||||
|
||||
<div className={`compare-stage sidebar-review-stage mode-${mode}`}
|
||||
<div className={`compare-stage sidebar-review-stage mode-${mode}${compare.aspect > 1 ? " landscape" : ""}`}
|
||||
style={{ "--compare-aspect": compare.aspect } as CSSProperties}>
|
||||
{/* Before and After are named above the frames in every mode, as in Compare. */}
|
||||
<CompareStage
|
||||
@@ -135,8 +134,7 @@ export function SidebarReview(props: CompareControllerOptions) {
|
||||
areas={areas}
|
||||
activeArea={activeArea}
|
||||
showOutlines={compare.shownOutlines}
|
||||
statusBarIgnored={compare.statusBarIgnored}
|
||||
homeIndicatorIgnored={compare.homeIndicatorIgnored}
|
||||
systemRegions={compare.systemRegions}
|
||||
overlay={overlay}
|
||||
flipSide={compare.flipSide}
|
||||
onFlip={compare.flip}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { appearanceLabel, type Appearance } from "../../utils/appearance";
|
||||
import { useEffect, useRef, useState, type ReactNode } from "react";
|
||||
import { Search } from "lucide-react";
|
||||
import { useEffect, useRef, useState, useSyncExternalStore, type ReactNode } from "react";
|
||||
import { LoaderCircle, Search } from "lucide-react";
|
||||
import { toast } from "sonner";
|
||||
import { ExpoLogo } from "../shared/expo-logo";
|
||||
import { Menu } from "../shared/menu";
|
||||
import { isPreviewPath, isReportTargetId, previewReportsUrl, targetQuery } from "../../utils/artifact-report";
|
||||
@@ -9,9 +10,9 @@ import { artifactUrl } from "../../utils/model";
|
||||
import { REPORT_SOURCE } from "../../utils/report-source";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { KeyHint } from "../shared/key-hint";
|
||||
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { formatShortcut, matchesShortcut, shortcutsLive, SHORTCUTS, TARGET_NUMBER_KEYS } from "../../utils/shortcuts";
|
||||
import { ChangesMenu } from "./changes-menu";
|
||||
import type { FocusStatus } from "../../utils/navigation";
|
||||
import { placeForAnotherTarget, type FocusStatus } from "../../utils/navigation";
|
||||
import type { ExploreMap, MapIndex } from "../../utils/model";
|
||||
import type { BuildDiff } from "../../utils/build-diff";
|
||||
import type { PullRequestPresentation } from "../../utils/review-model";
|
||||
@@ -23,7 +24,10 @@ type SiblingReport = { target: string; changes?: number; device?: string };
|
||||
/** One report of the run, as the switch offers it. */
|
||||
export type SwitchTarget = { id: string; platform: string; label: string };
|
||||
|
||||
/** The same review's report for another target: this page's URL with the target swapped (and the artifact id dropped). */
|
||||
/**
|
||||
* The same review's report for another target: this page's URL with the target swapped (and the artifact id dropped),
|
||||
* open at the same place where the other report has it.
|
||||
*/
|
||||
export function siblingReportUrl(page: URL, target: string): string | undefined {
|
||||
const preview = isPreviewPath(page.pathname);
|
||||
if (!preview && page.searchParams.get("origin") === "local") return undefined;
|
||||
@@ -36,10 +40,27 @@ export function siblingReportUrl(page: URL, target: string): string | undefined
|
||||
url.searchParams.set(key, value);
|
||||
url.searchParams.delete("artifact");
|
||||
url.searchParams.delete("screen");
|
||||
url.hash = "";
|
||||
url.hash = placeForAnotherTarget(page.hash);
|
||||
return url.href;
|
||||
}
|
||||
|
||||
/**
|
||||
* The target this tab showed before the current one, for `. Kept in session storage, since a report page that is not a
|
||||
* hosted preview loads again to switch; a Back or Forward between targets counts as a switch too.
|
||||
*/
|
||||
function useLastTarget(current: string): string | undefined {
|
||||
const [last, setLast] = useState<string>();
|
||||
useEffect(() => {
|
||||
const key = `explore.targets:${window.location.pathname}:${new URLSearchParams(window.location.search).get("run") ?? ""}`;
|
||||
let stored: { shown?: unknown; last?: unknown } = {};
|
||||
try { stored = JSON.parse(window.sessionStorage.getItem(key) ?? "{}") as typeof stored; } catch { /* Optional storage. */ }
|
||||
const previous = [stored.shown, stored.last].find((id): id is string => isReportTargetId(id) && id !== current);
|
||||
try { window.sessionStorage.setItem(key, JSON.stringify({ shown: current, ...(previous ? { last: previous } : {}) })); } catch { /* Optional storage. */ }
|
||||
setLast(previous);
|
||||
}, [current]);
|
||||
return last;
|
||||
}
|
||||
|
||||
/**
|
||||
* Every report of this report's run, in config order, and which one this is: `run.targets` with their labels, or for
|
||||
* reports from before targets one per platform of `run.platforms` (iOS first, as they list it). One report: none.
|
||||
@@ -54,6 +75,13 @@ export function runTargets(run: ExploreMap["run"]): { current: string; targets:
|
||||
return { current, targets: platforms.length > 1 ? platforms.map(platform => ({ id: platform, platform, label: PLATFORM_NAMES[platform]! })) : [] };
|
||||
}
|
||||
|
||||
/** What the shortcuts list says about switching: nothing when this page cannot open another target's report. */
|
||||
export function targetSwitch(run: ExploreMap["run"], page: URL): { noun: "device" | "platform"; count: number } | undefined {
|
||||
const { current, targets } = runTargets(run);
|
||||
if (!targets.some(target => target.id !== current && siblingReportUrl(page, target.id))) return undefined;
|
||||
return { noun: targets.every(target => target.id === target.platform) ? "platform" : "device", count: targets.length };
|
||||
}
|
||||
|
||||
/** On a hosted preview, the deployment lists what it serves per target; elsewhere only the targets' names are known. */
|
||||
function useSiblingReports(page: URL | undefined): SiblingReport[] | undefined {
|
||||
const [reports, setReports] = useState<SiblingReport[]>();
|
||||
@@ -109,6 +137,8 @@ export function AppPill(props: AppPillProps) {
|
||||
const pillRef = useRef<HTMLDivElement>(null);
|
||||
const platformRef = useRef<HTMLButtonElement>(null);
|
||||
const [platformOpen, setPlatformOpen] = useState(false);
|
||||
// A target still downloading: this report stays up, the trigger and the menu row say so. One that failed says why.
|
||||
const { switching, switchError } = useSyncExternalStore(REPORT_SOURCE.subscribe, REPORT_SOURCE.getSnapshot, REPORT_SOURCE.getSnapshot);
|
||||
const appearanceRef = useRef<HTMLButtonElement>(null);
|
||||
const [appearanceOpen, setAppearanceOpen] = useState(false);
|
||||
const appearanceItems = (props.appearance?.options ?? []).map(option => ({
|
||||
@@ -146,19 +176,67 @@ export function AppPill(props: AppPillProps) {
|
||||
.filter(target => target.id !== run.current)
|
||||
.map(target => ({ target, url: page ? siblingReportUrl(page, target.id) : undefined, report: siblingReports?.find(report => report.target === target.id) }))
|
||||
.filter((entry): entry is { target: SwitchTarget; url: string; report: SiblingReport | undefined } => Boolean(entry.url));
|
||||
// The URL is read when the switch happens, so the other report opens where the reader is now.
|
||||
const openTarget = (id: string) => {
|
||||
setPlatformOpen(false);
|
||||
const url = siblingReportUrl(new URL(window.location.href), id);
|
||||
if (url && !REPORT_SOURCE.switchTarget(id, url)) window.location.assign(url);
|
||||
};
|
||||
// ⌥1–⌥8 follow the menu's order, the run's config order.
|
||||
const numberHint = (target: SwitchTarget) => {
|
||||
const shortcut = TARGET_NUMBER_KEYS ? SHORTCUTS.targetByNumber[run.targets.indexOf(target)] : undefined;
|
||||
return shortcut ? { shortcut: formatShortcut(shortcut) } : {};
|
||||
};
|
||||
const platformItems = siblings.length ? run.targets.flatMap(target => {
|
||||
if (target.id === run.current) return [{ kind: "item" as const, label: target.label, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) }];
|
||||
if (target.id === run.current) return [{ kind: "item" as const, label: target.label, description: device || undefined, checked: true, ...numberHint(target), onSelect: () => setPlatformOpen(false) }];
|
||||
const sibling = siblings.find(entry => entry.target.id === target.id);
|
||||
return sibling ? [{
|
||||
kind: "item" as const, label: target.label,
|
||||
description: [sibling.report?.changes === undefined ? undefined : `${sibling.report.changes} ${sibling.report.changes === 1 ? "change" : "changes"}`, sibling.report?.device]
|
||||
.filter(Boolean).join(" · ") || (target.platform === platform ? "Same review, other device" : "Same review, other platform"),
|
||||
checked: false, onSelect: () => { setPlatformOpen(false); if (!REPORT_SOURCE.switchTarget(target.id, sibling.url)) window.location.assign(sibling.url); },
|
||||
description: switching?.target === target.id ? "Downloading…"
|
||||
: [sibling.report?.changes === undefined ? undefined : `${sibling.report.changes} ${sibling.report.changes === 1 ? "change" : "changes"}`, sibling.report?.device]
|
||||
.filter(Boolean).join(" · ") || (target.platform === platform ? "Same review, other device" : "Same review, other platform"),
|
||||
checked: false, ...numberHint(target), onSelect: () => openTarget(target.id),
|
||||
}] : [];
|
||||
}) : [];
|
||||
// A report whose target is not among the run's (a hand-edited one) still lists itself first, checked.
|
||||
if (siblings.length && !currentTarget) platformItems.unshift({ kind: "item" as const, label: targetLabel, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) });
|
||||
|
||||
// D opens the menu, ⌥1–⌥8 open a target by its place in it, and ` returns to the last target shown (the next one in
|
||||
// the menu's order before there is one). The handler reads the current targets from a ref.
|
||||
const last = useLastTarget(run.current);
|
||||
const targetKeys = { siblings: siblings.map(entry => entry.target.id), order: run.targets.map(target => target.id), current: run.current, last, openTarget };
|
||||
const failedLabel = switchError ? run.targets.find(target => target.id === switchError.target)?.label : undefined;
|
||||
useEffect(() => {
|
||||
if (switchError) toast.error(failedLabel ? `Couldn’t open ${failedLabel}` : "Couldn’t open the other report", { description: switchError.error });
|
||||
}, [switchError, failedLabel]);
|
||||
const targetKeysRef = useRef(targetKeys);
|
||||
targetKeysRef.current = targetKeys;
|
||||
useEffect(() => {
|
||||
const onKeyDown = (event: KeyboardEvent) => {
|
||||
const { siblings, order, current, last, openTarget } = targetKeysRef.current;
|
||||
if (!siblings.length || !shortcutsLive(event)) return;
|
||||
if (matchesShortcut(event, SHORTCUTS.target.menu)) {
|
||||
event.preventDefault();
|
||||
setPlatformOpen(open => !open);
|
||||
return;
|
||||
}
|
||||
let id: string | undefined;
|
||||
if (matchesShortcut(event, SHORTCUTS.target.last)) {
|
||||
const start = order.indexOf(current);
|
||||
id = last && siblings.includes(last) ? last
|
||||
: order.map((_, step) => order[(start + 1 + step) % order.length]!).find(candidate => siblings.includes(candidate));
|
||||
} else if (TARGET_NUMBER_KEYS) {
|
||||
const place = SHORTCUTS.targetByNumber.findIndex(shortcut => matchesShortcut(event, shortcut));
|
||||
if (place === -1) return;
|
||||
id = order[place];
|
||||
} else return;
|
||||
event.preventDefault();
|
||||
if (id && siblings.includes(id)) openTarget(id);
|
||||
};
|
||||
window.addEventListener("keydown", onKeyDown);
|
||||
return () => window.removeEventListener("keydown", onKeyDown);
|
||||
}, []);
|
||||
|
||||
return (
|
||||
<div className="left-panel collapsed">
|
||||
<div ref={pillRef} className="left-panel-collapsed-pill">
|
||||
@@ -166,7 +244,7 @@ export function AppPill(props: AppPillProps) {
|
||||
<button type="button" className="panel-logo-button" aria-label="Map" onClick={props.onOpenMap}>
|
||||
{appIcon ? (
|
||||
<ScreenshotImage className="panel-app-icon" src={appIcon} alt="" loading="eager" draggable={false}
|
||||
fallback={<ExpoLogo mark />} />
|
||||
fallback={<ExpoLogo mark />} holdPrevious />
|
||||
) : <ExpoLogo mark />}
|
||||
</button>
|
||||
</Tooltip>
|
||||
@@ -182,12 +260,15 @@ export function AppPill(props: AppPillProps) {
|
||||
</strong>
|
||||
{siblings.length ? (
|
||||
<>
|
||||
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} placement="bottom">
|
||||
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} shortcut={formatShortcut(SHORTCUTS.target.menu)} placement="bottom">
|
||||
<button ref={platformRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={platformOpen}
|
||||
aria-label={`${noun === "device" ? "Device" : "Platform"}: ${targetLabel}. Open another ${noun}'s report`}
|
||||
aria-busy={switching ? true : undefined}
|
||||
onClick={() => setPlatformOpen(open => !open)}>
|
||||
{targetLabel}
|
||||
<svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>
|
||||
{switching
|
||||
? <LoaderCircle aria-hidden="true" className="collapsed-platform-busy" />
|
||||
: <svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>}
|
||||
</button>
|
||||
</Tooltip>
|
||||
<Menu items={platformItems} open={platformOpen} anchorRef={platformRef} ariaLabel={noun === "device" ? "Device" : "Platform"} onDismiss={() => setPlatformOpen(false)} />
|
||||
|
||||
@@ -49,11 +49,11 @@
|
||||
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. */
|
||||
/* The system-drawn areas CI does not compare (status bar, rail clock pill, home indicator): blurred out, each placed
|
||||
by its inline percentages, explained by its tooltip on hover. */
|
||||
.visual-status-bar-band {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
inset: 0 0 auto 0;
|
||||
background: rgba(127, 127, 127, 0.08);
|
||||
cursor: help;
|
||||
pointer-events: auto;
|
||||
@@ -62,7 +62,6 @@
|
||||
transition: background 120ms ease;
|
||||
}
|
||||
.visual-status-bar-band:hover { background: rgba(127, 127, 127, 0.2); }
|
||||
.visual-home-indicator-band { inset: auto 0 0 0; }
|
||||
|
||||
/* ── Swipe: one frame, Before left of the divider and After right of it ─── */
|
||||
|
||||
@@ -98,6 +97,10 @@
|
||||
pointer-events: none;
|
||||
}
|
||||
.visual-swipe-before { clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
|
||||
/* With a moved area, each side's outlines over its own half (see ChangeOutlines). */
|
||||
.visual-swipe-outlines { position: absolute; z-index: 1; inset: 0; pointer-events: none; }
|
||||
.visual-swipe-outlines.before { --outline-before: 1; clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
|
||||
.visual-swipe-outlines.after { clip-path: inset(0 0 0 var(--swipe-position)); }
|
||||
.visual-swipe .visual-change-outline { background: transparent; border-style: dashed; }
|
||||
.visual-swipe-divider {
|
||||
position: absolute;
|
||||
|
||||
@@ -3,6 +3,7 @@ import { ChevronsLeftRight } from "lucide-react";
|
||||
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 type { ReviewVisualDiff, SystemRegion } from "../../utils/review-model";
|
||||
import { ScreenshotImage } from "../shared/screenshot-image";
|
||||
import "./visual-diff.css";
|
||||
|
||||
@@ -43,39 +44,60 @@ export function ChangeOutlines(props: {
|
||||
);
|
||||
}
|
||||
|
||||
const SYSTEM_REGION_COPY: Record<SystemRegion["kind"], { label: string; title: string }> = {
|
||||
"status-bar": { label: "Status bar, not compared",
|
||||
title: "The status bar (clock, signal, battery) differs between the captures. It is not counted as a change." },
|
||||
"home-indicator": { label: "Home indicator, not compared",
|
||||
title: "The home indicator at the bottom differs between the captures. It is not counted as a change." },
|
||||
};
|
||||
|
||||
/**
|
||||
* The band CI leaves out of the verdict, blurred out over the top of a screenshot. Shown only
|
||||
* when CI reports that it ignored differences there; hovering it says why the clocks disagree.
|
||||
* The parent must be positioned.
|
||||
* The system-drawn areas CI left out of the verdict for a screen: the ones the report names, or, for a report
|
||||
* from before it named them, the platform's bands where CI says it ignored something. Empty when nothing was ignored.
|
||||
*/
|
||||
export function StatusBarBand({ percent = STATUS_BAR_BAND_PERCENT }: { percent?: number }) {
|
||||
return (
|
||||
<span
|
||||
className="visual-status-bar-band"
|
||||
style={{ height: `${percent}%` }}
|
||||
role="img"
|
||||
aria-label="Status bar, not compared"
|
||||
title="The status bar (clock, signal, battery) differs between the captures. It is not counted as a change."
|
||||
/>
|
||||
);
|
||||
export function ignoredSystemRegions(visual: ReviewVisualDiff | undefined): SystemRegion[] {
|
||||
if (!visual) return [];
|
||||
const statusBar = (visual.ignoredStatusBarRegions ?? 0) > 0;
|
||||
const homeIndicator = (visual.ignoredHomeIndicatorRegions ?? 0) > 0;
|
||||
if (visual.systemRegions) return visual.systemRegions.filter((area) => (area.kind === "status-bar" ? statusBar : homeIndicator));
|
||||
return [
|
||||
...(statusBar ? [{ kind: "status-bar" as const, x: 0, y: 0, width: 100, height: STATUS_BAR_BAND_PERCENT }] : []),
|
||||
...(homeIndicator ? [{ kind: "home-indicator" as const, x: 0, y: 100 - HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios, width: 100, height: HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios }] : []),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* The same for the iOS home indicator, over the bottom of the screenshot: the system draws it in
|
||||
* whichever shade contrasts with the app underneath, so it changes without the app changing.
|
||||
* The areas CI leaves out of the verdict, blurred out over a screenshot: a status-bar band across the top of a
|
||||
* phone, the clock pill in a foldable's rail, the home indicator along the bottom. Shown only when CI reports
|
||||
* that it ignored differences there; hovering one says why. The parent must be positioned.
|
||||
*/
|
||||
export function HomeIndicatorBand({ percent = HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios }: { percent?: number }) {
|
||||
export function SystemRegionBands({ regions }: { regions: readonly SystemRegion[] }) {
|
||||
return (
|
||||
<span
|
||||
className="visual-status-bar-band visual-home-indicator-band"
|
||||
style={{ height: `${percent}%` }}
|
||||
role="img"
|
||||
aria-label="Home indicator, not compared"
|
||||
title="The home indicator at the bottom differs between the captures. It is not counted as a change."
|
||||
/>
|
||||
<>
|
||||
{regions.map((area, index) => (
|
||||
<span
|
||||
key={`${area.kind}:${index}`}
|
||||
className={`visual-status-bar-band visual-system-region-${area.kind}`}
|
||||
style={{ left: `${area.x}%`, top: `${area.y}%`, width: `${area.width}%`, height: `${area.height}%` }}
|
||||
role="img"
|
||||
aria-label={SYSTEM_REGION_COPY[area.kind].label}
|
||||
title={SYSTEM_REGION_COPY[area.kind].title}
|
||||
/>
|
||||
))}
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
/** The status-bar band of a phone, for callers without a report (fixtures, stories). */
|
||||
export function StatusBarBand({ percent = STATUS_BAR_BAND_PERCENT }: { percent?: number }) {
|
||||
return <SystemRegionBands regions={[{ kind: "status-bar", x: 0, y: 0, width: 100, height: percent }]} />;
|
||||
}
|
||||
|
||||
/** The iOS home indicator's band, for callers without a report. */
|
||||
export function HomeIndicatorBand({ percent = HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios }: { percent?: number }) {
|
||||
return <SystemRegionBands regions={[{ kind: "home-indicator", x: 0, y: 100 - percent, width: 100, height: percent }]} />;
|
||||
}
|
||||
|
||||
export const SWIPE_STEP = 5;
|
||||
|
||||
/**
|
||||
@@ -88,11 +110,13 @@ export function SwipeCompare(props: {
|
||||
before: string;
|
||||
after: string;
|
||||
imageAspect: number;
|
||||
/** After's screenshot loaded: its width over its height, for a frame shaped before it arrived. */
|
||||
onAspect?: (aspect: number, side: "after") => void;
|
||||
changes: readonly VisualChange[];
|
||||
activeIndex?: number | undefined;
|
||||
showOutlines?: boolean;
|
||||
statusBarIgnored?: boolean;
|
||||
homeIndicatorIgnored?: boolean;
|
||||
/** The system-drawn areas CI left out, blurred over both frames with the outlines. */
|
||||
systemRegions?: readonly SystemRegion[];
|
||||
position?: number;
|
||||
onPositionChange?: (position: number) => void;
|
||||
/** Before and After in the frame's bottom corners; off where the caller names them above the frame. */
|
||||
@@ -150,12 +174,21 @@ export function SwipeCompare(props: {
|
||||
onPointerUp={onPointerUp}
|
||||
onPointerCancel={onPointerUp}>
|
||||
<ScreenshotImage className="visual-swipe-after" src={props.after} alt={`${props.title}, after`}
|
||||
loading="eager" draggable={false} />
|
||||
loading="eager" draggable={false}
|
||||
onLoad={(event) => {
|
||||
const { naturalWidth, naturalHeight } = event.currentTarget;
|
||||
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect?.(naturalWidth / naturalHeight, "after");
|
||||
}} />
|
||||
<ScreenshotImage className="visual-swipe-before" src={props.before} alt={`${props.title}, before`}
|
||||
loading="eager" draggable={false} />
|
||||
{props.showOutlines === false ? null : <ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} />}
|
||||
{props.statusBarIgnored && props.showOutlines !== false ? <StatusBarBand /> : null}
|
||||
{props.homeIndicatorIgnored && props.showOutlines !== false ? <HomeIndicatorBand /> : null}
|
||||
{props.showOutlines === false ? null : props.changes.some(change => change.move) ? (
|
||||
// A moved area sits where its content is on each side: Before's outlines left of the divider, After's right.
|
||||
<>
|
||||
<span className="visual-swipe-outlines before"><ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} /></span>
|
||||
<span className="visual-swipe-outlines after"><ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} /></span>
|
||||
</>
|
||||
) : <ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} />}
|
||||
{props.systemRegions && props.showOutlines !== false ? <SystemRegionBands regions={props.systemRegions} /> : null}
|
||||
{props.labels === false ? null : (
|
||||
<>
|
||||
<span className="visual-swipe-label before" aria-hidden="true">Before</span>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { useRef, type CSSProperties, type MouseEvent, type ReactNode } from "react";
|
||||
import { List, ScanSearch } from "lucide-react";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand } from "../panels/visual-diff";
|
||||
import { ChangeOutlines, SystemRegionBands } from "../panels/visual-diff";
|
||||
import { CompareNav, CompareSteps, WhatChangedContent } from "../compare/compare-header";
|
||||
import {
|
||||
CompareStage,
|
||||
@@ -41,8 +41,7 @@ export function PhoneCompare(props: CompareControllerOptions & {
|
||||
const overlay = compare.shownOutlines ? (
|
||||
<>
|
||||
<ChangeOutlines changes={areas} activeIndex={activeArea} />
|
||||
{compare.statusBarIgnored ? <StatusBarBand /> : null}
|
||||
{compare.homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
|
||||
<SystemRegionBands regions={compare.systemRegions} />
|
||||
</>
|
||||
) : null;
|
||||
const facts = compare.split.visible.map((fact) => fact.copy);
|
||||
@@ -109,8 +108,7 @@ export function PhoneCompare(props: CompareControllerOptions & {
|
||||
areas={areas}
|
||||
activeArea={activeArea}
|
||||
showOutlines={compare.shownOutlines}
|
||||
statusBarIgnored={compare.statusBarIgnored}
|
||||
homeIndicatorIgnored={compare.homeIndicatorIgnored}
|
||||
systemRegions={compare.systemRegions}
|
||||
overlay={overlay}
|
||||
flipSide={compare.flipSide}
|
||||
onFlip={compare.flip}
|
||||
|
||||
@@ -1,15 +1,36 @@
|
||||
import { useEffect, useId, useMemo, useRef, useState } from "react";
|
||||
import { CornerDownLeft, Route, Search, X } from "lucide-react";
|
||||
import { searchItems, type SearchItem } from "../utils/search";
|
||||
import { Command, CornerDownLeft, Route, Search, X } from "lucide-react";
|
||||
import { searchItems, type SearchItem, type SearchItemKind } from "../utils/search";
|
||||
import { AutoHideScrollArea } from "./shared/auto-hide-scroll-area";
|
||||
import { useModalDialog } from "../hooks/use-modal-dialog";
|
||||
|
||||
const KIND_LABELS: Record<SearchItem["kind"], string> = {
|
||||
/** Screens are labelled; a command's key, or nothing, sits where the label would. */
|
||||
const KIND_LABELS: Record<SearchItemKind, string> = {
|
||||
screen: "Screen",
|
||||
command: "Command",
|
||||
};
|
||||
|
||||
function ResultIcon() {
|
||||
return <Route strokeWidth={1.75} />;
|
||||
function ResultIcon({ kind }: { kind: SearchItemKind }) {
|
||||
return kind === "screen" ? <Route strokeWidth={1.75} /> : <Command strokeWidth={1.75} />;
|
||||
}
|
||||
|
||||
/** The results grouped by kind, in the order the first result sets, so ↑ and ↓ step through the rows as they read. */
|
||||
function groupedByKind(results: readonly SearchItem[]): SearchItem[] {
|
||||
return [...new Set(results.map((item) => item.kind))].flatMap((kind) => results.filter((item) => item.kind === kind));
|
||||
}
|
||||
|
||||
/** Grouped results in their sections, with each item's place in the flat list. */
|
||||
function sections(results: readonly SearchItem[], suggested: boolean): { label: string; entries: { item: SearchItem; index: number }[] }[] {
|
||||
const byKind = new Map<SearchItemKind, { item: SearchItem; index: number }[]>();
|
||||
results.forEach((item, index) => {
|
||||
const entries = byKind.get(item.kind) ?? [];
|
||||
entries.push({ item, index });
|
||||
byKind.set(item.kind, entries);
|
||||
});
|
||||
return [...byKind].map(([kind, entries]) => ({
|
||||
label: kind === "command" ? (suggested ? "Suggested" : "Commands") : suggested ? "Selected screen" : "Screens",
|
||||
entries,
|
||||
}));
|
||||
}
|
||||
|
||||
type SearchCommandProps = {
|
||||
@@ -27,7 +48,7 @@ export function SearchCommand(props: SearchCommandProps) {
|
||||
const dialogRef = useModalDialog(props.open, props.onClose);
|
||||
const listboxId = useId();
|
||||
const results = useMemo(
|
||||
() => query.trim() ? searchItems(props.items, query) : [...props.suggestions],
|
||||
() => groupedByKind(query.trim() ? searchItems(props.items, query) : props.suggestions),
|
||||
[props.items, props.suggestions, query],
|
||||
);
|
||||
|
||||
@@ -59,8 +80,11 @@ export function SearchCommand(props: SearchCommandProps) {
|
||||
props.onClose();
|
||||
if (item.kind === "screen" && item.screenId) {
|
||||
props.onSelectScreen(item.screenId);
|
||||
} else if (item.kind === "command") {
|
||||
item.run?.();
|
||||
}
|
||||
};
|
||||
const suggested = !query.trim();
|
||||
|
||||
const moveActive = (delta: number) => {
|
||||
if (results.length === 0) return;
|
||||
@@ -85,7 +109,7 @@ export function SearchCommand(props: SearchCommandProps) {
|
||||
<input
|
||||
ref={inputRef}
|
||||
role="combobox"
|
||||
aria-label="Search screens"
|
||||
aria-label="Search screens and commands"
|
||||
aria-autocomplete="list"
|
||||
aria-expanded="true"
|
||||
aria-controls={listboxId}
|
||||
@@ -94,7 +118,7 @@ export function SearchCommand(props: SearchCommandProps) {
|
||||
: {})}
|
||||
autoComplete="off"
|
||||
spellCheck="false"
|
||||
placeholder="Search screens"
|
||||
placeholder="Search screens and commands"
|
||||
value={query}
|
||||
onChange={(event) => setQuery(event.target.value)}
|
||||
onKeyDown={(event) => {
|
||||
@@ -116,42 +140,46 @@ export function SearchCommand(props: SearchCommandProps) {
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div className="search-command-section-label">
|
||||
{query.trim() ? "Results" : "Suggested"}
|
||||
</div>
|
||||
{results.length > 0 ? (
|
||||
<AutoHideScrollArea
|
||||
id={listboxId}
|
||||
shellClassName="search-command-results-shell"
|
||||
className="search-command-results"
|
||||
role="listbox">
|
||||
{results.map((item, index) => (
|
||||
<button
|
||||
key={item.id}
|
||||
id={`${listboxId}-option-${index}`}
|
||||
type="button"
|
||||
role="option"
|
||||
aria-selected={activeIndex === index}
|
||||
className={`search-command-result${activeIndex === index ? " active" : ""}`}
|
||||
onPointerMove={() => setActiveIndex(index)}
|
||||
onClick={() => select(item)}>
|
||||
<span className={`search-command-result-icon result-${item.kind}`} aria-hidden="true">
|
||||
<ResultIcon />
|
||||
</span>
|
||||
<span className="search-command-result-copy">
|
||||
<strong>{item.kind === "screen" ? <code>{item.title}</code> : item.title}</strong>
|
||||
{item.context && <small>{item.context}</small>}
|
||||
</span>
|
||||
<span className="search-command-result-kind">{KIND_LABELS[item.kind]}</span>
|
||||
{activeIndex === index && <CornerDownLeft className="search-command-enter" aria-hidden="true" />}
|
||||
</button>
|
||||
{sections(results, suggested).map((section) => (
|
||||
<div key={section.label} className="search-command-section" role="group" aria-label={section.label}>
|
||||
<div className="search-command-section-label">{section.label}</div>
|
||||
{section.entries.map(({ item, index }) => (
|
||||
<button
|
||||
key={item.id}
|
||||
id={`${listboxId}-option-${index}`}
|
||||
type="button"
|
||||
role="option"
|
||||
aria-selected={activeIndex === index}
|
||||
className={`search-command-result${activeIndex === index ? " active" : ""}`}
|
||||
onPointerMove={() => setActiveIndex(index)}
|
||||
onClick={() => select(item)}>
|
||||
<span className={`search-command-result-icon result-${item.kind}`} aria-hidden="true">
|
||||
<ResultIcon kind={item.kind} />
|
||||
</span>
|
||||
<span className="search-command-result-copy">
|
||||
<strong>{item.kind === "screen" ? <code>{item.title}</code> : item.title}</strong>
|
||||
{item.context && <small>{item.context}</small>}
|
||||
</span>
|
||||
{item.shortcut
|
||||
? <kbd className="search-command-result-key">{item.shortcut}</kbd>
|
||||
: item.kind === "screen" ? <span className="search-command-result-kind">{KIND_LABELS[item.kind]}</span> : null}
|
||||
{activeIndex === index && <CornerDownLeft className="search-command-enter" aria-hidden="true" />}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
))}
|
||||
</AutoHideScrollArea>
|
||||
) : (
|
||||
<div className="search-command-empty" role="status">
|
||||
<Search aria-hidden="true" />
|
||||
<strong>No results</strong>
|
||||
<span>Try another screen.</span>
|
||||
<span>Try a route, or a command such as “dark” or “fit”.</span>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
|
||||
@@ -26,7 +26,14 @@
|
||||
.panel-search input {
|
||||
width: 100%;
|
||||
min-width: 0;
|
||||
height: 100%;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
/* A search field's own look on macOS sets its text low in the box; the flex row centers plain text. */
|
||||
appearance: none;
|
||||
-webkit-appearance: none;
|
||||
line-height: normal;
|
||||
outline: 0;
|
||||
color: var(--text);
|
||||
background: transparent;
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { useEffect, useLayoutEffect, useRef, useState, type ImgHTMLAttributes, type ReactNode, type SyntheticEvent } from "react";
|
||||
import { ImageOff, LoaderCircle } from "lucide-react";
|
||||
import { isEmbeddedArtifactUrl, releaseEmbeddedArtifactUrl, resolveEmbeddedArtifactUrl } from "../../utils/embedded-report";
|
||||
import { isEmbeddedArtifactUrl, leaseEmbeddedArtifactUrl } from "../../utils/embedded-report";
|
||||
|
||||
/** A phone screen's width over height; frames size to it until a screenshot supplies its own. */
|
||||
export const DEFAULT_SCREENSHOT_RATIO = 9 / 19.5;
|
||||
@@ -12,6 +12,12 @@ type ScreenshotImageProps = ImgHTMLAttributes<HTMLImageElement> & {
|
||||
indicator?: "spinner";
|
||||
/** Stands in for an embedded screenshot that cannot be read: the caller's own no-screenshot state. */
|
||||
fallback?: ReactNode;
|
||||
/**
|
||||
* Keeps the picture of the source before on screen until the new one has decoded: for a map card, whose source
|
||||
* changes only when the report's other appearance or target swaps every screenshot at once. Never for a view that
|
||||
* steps between screens or draws changes over the picture, where it would show the screen before under the new one.
|
||||
*/
|
||||
holdPrevious?: boolean;
|
||||
};
|
||||
|
||||
type ScreenshotState = "loading" | "ready" | "failed";
|
||||
@@ -37,17 +43,21 @@ function waitingSource(width: number | string | undefined, height: number | stri
|
||||
* embedded screenshot resolves, the image shows an empty frame (and, with `indicator`, a spinner)
|
||||
* and never its alt text; a screenshot that cannot be read shows `fallback`.
|
||||
*/
|
||||
export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onError, ...props }: ScreenshotImageProps) {
|
||||
export function ScreenshotImage({ src, loading, indicator, fallback, holdPrevious, onLoad, onError, ...props }: ScreenshotImageProps) {
|
||||
const imageRef = useRef<HTMLImageElement>(null);
|
||||
const [resolved, setResolved] = useState<{ source: string; url: string }>();
|
||||
const [failed, setFailed] = useState<string>();
|
||||
const [shown, setShown] = useState<string>();
|
||||
const [lastSource, setLastSource] = useState(src);
|
||||
// With `holdPrevious`, the picture of the source before, kept on screen until the new one has decoded.
|
||||
const [held, setHeld] = useState<string>();
|
||||
const embedded = typeof src === "string" && isEmbeddedArtifactUrl(src);
|
||||
// A new source starts over: a fresh attempt, even for one that failed before, and never a URL
|
||||
// resolved on an earlier visit, which was released on leaving and may since have been revoked.
|
||||
if (lastSource !== src) {
|
||||
setLastSource(src);
|
||||
// A source that failed has no picture of its own to hand on, and drops the one it held.
|
||||
setHeld(holdPrevious && failed !== lastSource ? shown ?? held : undefined);
|
||||
setResolved(undefined);
|
||||
setShown(undefined);
|
||||
setFailed(undefined);
|
||||
@@ -61,13 +71,18 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
|
||||
let requested = false;
|
||||
let generation = 0;
|
||||
let observer: IntersectionObserver | undefined;
|
||||
// Released against the report that resolved it: a hosted preview's other target can hold the same screenshot,
|
||||
// so this image can outlive its report without its source changing.
|
||||
let lease: ReturnType<typeof leaseEmbeddedArtifactUrl> | undefined;
|
||||
const load = () => {
|
||||
if (disposed || requested) return;
|
||||
requested = true;
|
||||
const current = ++generation;
|
||||
const leased = leaseEmbeddedArtifactUrl(src, loading === "eager" ? "eager" : "lazy");
|
||||
lease = leased;
|
||||
void (async () => {
|
||||
try {
|
||||
const url = await resolveEmbeddedArtifactUrl(src, loading === "eager" ? "eager" : "lazy");
|
||||
const url = await leased.url;
|
||||
if (disposed || generation !== current) return;
|
||||
setResolved({ source: src, url });
|
||||
// A fresh URL gets its own chance to decode.
|
||||
@@ -76,6 +91,11 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
|
||||
if (disposed || generation !== current) return;
|
||||
// A failed load holds no reference, so nothing is released for it later.
|
||||
requested = false;
|
||||
// The report it waited on was switched away from and let it go: ask the one shown now, which may hold it too.
|
||||
if (!leased.current()) {
|
||||
load();
|
||||
return;
|
||||
}
|
||||
observer?.disconnect();
|
||||
image.dispatchEvent(new Event("error"));
|
||||
setFailed(src);
|
||||
@@ -86,7 +106,7 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
|
||||
else {
|
||||
observer = new IntersectionObserver(entries => {
|
||||
if (entries.some(entry => entry.isIntersecting)) load();
|
||||
else if (requested && releaseEmbeddedArtifactUrl(src)) {
|
||||
else if (requested && lease?.release()) {
|
||||
requested = false;
|
||||
generation++;
|
||||
setResolved(undefined);
|
||||
@@ -98,21 +118,24 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
|
||||
return () => {
|
||||
disposed = true;
|
||||
observer?.disconnect();
|
||||
if (requested) releaseEmbeddedArtifactUrl(src);
|
||||
if (requested) lease?.release();
|
||||
};
|
||||
}, [embedded, src, loading]);
|
||||
|
||||
const url = embedded && resolved?.source === src ? resolved.url : undefined;
|
||||
const state: ScreenshotState = failed === src ? "failed" : url && shown === url ? "ready" : "loading";
|
||||
const displayed = state !== "failed" ? url : undefined;
|
||||
const displayed = state !== "failed" ? url ?? held : undefined;
|
||||
|
||||
// Re-committing the URL the image already shows (it left the viewport and came back before a
|
||||
// render, and the report still held the URL) fires no load event: the decoded image is ready.
|
||||
useLayoutEffect(() => {
|
||||
const image = imageRef.current;
|
||||
if (!displayed || shown === displayed || !image || image.getAttribute("src") !== displayed) return;
|
||||
if (image.complete && image.naturalWidth > 0) setShown(displayed);
|
||||
}, [displayed, shown]);
|
||||
if (!displayed || displayed !== url || shown === displayed || !image || image.getAttribute("src") !== displayed) return;
|
||||
if (image.complete && image.naturalWidth > 0) {
|
||||
setShown(displayed);
|
||||
setHeld(undefined);
|
||||
}
|
||||
}, [displayed, url, shown]);
|
||||
|
||||
if (!embedded) return <img {...props} ref={imageRef} loading={loading} src={src} onLoad={onLoad} onError={onError} />;
|
||||
if (state === "failed" && fallback !== undefined) return <>{fallback}</>;
|
||||
@@ -129,10 +152,13 @@ export function ScreenshotImage({ src, loading, indicator, fallback, onLoad, onE
|
||||
onLoad={event => {
|
||||
if (!isScreenshot(event)) return;
|
||||
setShown(url);
|
||||
setHeld(undefined);
|
||||
onLoad?.(event);
|
||||
}}
|
||||
onError={event => {
|
||||
if (event.nativeEvent.isTrusted) {
|
||||
// The held picture's URL was revoked since (the report let it go): nothing to show until the new one.
|
||||
if (held && !url && event.currentTarget.getAttribute("src") === held) { setHeld(undefined); return; }
|
||||
if (!isScreenshot(event)) return;
|
||||
setFailed(src);
|
||||
}
|
||||
|
||||
@@ -162,7 +162,18 @@ export function Tooltip({
|
||||
if (bubbleRef.current) observer.observe(bubbleRef.current);
|
||||
window.addEventListener("resize", update);
|
||||
window.addEventListener("scroll", update, true);
|
||||
// A canvas pans and zooms its cards by transform, which neither observer reports: while open,
|
||||
// follow the anchor frame by frame so the bubble never stays behind over what it labels.
|
||||
let followed = "";
|
||||
let frame = requestAnimationFrame(function follow() {
|
||||
const anchor = anchorRef.current?.getBoundingClientRect();
|
||||
const key = anchor ? `${anchor.left} ${anchor.top} ${anchor.width} ${anchor.height}` : "";
|
||||
if (followed && key !== followed) update();
|
||||
followed = key;
|
||||
frame = requestAnimationFrame(follow);
|
||||
});
|
||||
return () => {
|
||||
cancelAnimationFrame(frame);
|
||||
observer.disconnect();
|
||||
window.removeEventListener("resize", update);
|
||||
window.removeEventListener("scroll", update, true);
|
||||
|
||||
@@ -67,7 +67,8 @@
|
||||
.screens-tree ul { margin: 0; padding: 0; list-style: none; }
|
||||
/* Changed / All filter the tree and the grid alike, so they sit in the tree's head as one segmented control,
|
||||
beside the button that folds or unfolds every folder. */
|
||||
.screens-tree-head { display: flex; align-items: center; gap: 6px; margin: 0 0 10px; }
|
||||
/* One height in every state (chips, the find field, or only the icons), so opening the find does not move the tree. */
|
||||
.screens-tree-head { display: flex; height: 34px; flex: none; align-items: center; gap: 6px; margin: 0 0 10px; }
|
||||
.screens-tree-head > .screens-filter {
|
||||
flex: 1;
|
||||
gap: 2px;
|
||||
@@ -337,3 +338,26 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
|
||||
.screens-tree.phone .screens-tree-row { min-height: 34px; font-size: var(--phone-body-size); }
|
||||
.screens-tree.phone .screens-tree-label.path { font-size: var(--phone-body-mono-size); }
|
||||
.screens-tree.phone .screens-tree-kind { font-size: var(--phone-micro-size); }
|
||||
|
||||
/* ── Find: `/` or the magnifier turns the tree's head into a field; the tree and the grid narrow to its matches ── */
|
||||
.screens-tree-head > .tooltip-anchor { display: flex; flex: none; margin-left: auto; }
|
||||
.screens-tree-head > .tooltip-anchor + .screens-tree-fold-all { margin-left: 0; }
|
||||
.screens-tree-find {
|
||||
display: grid;
|
||||
width: 32px;
|
||||
height: 32px;
|
||||
flex: none;
|
||||
place-items: center;
|
||||
border-radius: 8px;
|
||||
color: var(--secondary);
|
||||
background: transparent;
|
||||
}
|
||||
.screens-tree-find:hover { color: var(--text); background: var(--panel-hover); }
|
||||
.screens-tree-find > svg { width: 16px; height: 16px; }
|
||||
.screens-tree-head.searching { gap: 4px; }
|
||||
.screens-find { display: flex; min-width: 0; flex: 1; }
|
||||
.screens-find .panel-search { height: 34px; border-radius: 9px; }
|
||||
.screens-find-empty { margin: 0; padding: 4px 8px; color: var(--tertiary); font-size: 12px; }
|
||||
.screens-empty { min-height: 240px; flex: 1; }
|
||||
.screens-empty-all { padding: 0; color: var(--accent); font: inherit; background: transparent; }
|
||||
.screens-empty-all:hover { text-decoration-line: underline; text-underline-offset: 3px; }
|
||||
Loaded 100 of 118 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user