Compare commits

...
Author SHA1 Message Date
Brent Vatne 9d87420735 Release 0.20.0 2026-10-19 09:28:34 -07:00
Brent Vatne 6539b5c002 Source planning: follow every single-directory tsconfig paths alias (#38) 2026-10-19 09:28:17 -07:00
Brent Vatne 422cf8caf4 Viewer: theme, full screen and shortcuts in a "…" menu; the top right keeps only the Map's camera (#37) 2026-10-19 09:24:13 -07:00
devin-ai-integration[bot]andbrent b281c734f4 Viewer: make the Inspector resizable from its left edge (#34)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 22:39:36 -07:00
Brent Vatne c99c26f9bb Release 0.20.0-next.0; prereleases publish under the next tag (#36) 2026-10-18 22:09:03 -07:00
Brent Vatne 9150a24cd9 Map: ring the selected screen instead of fading the rest; Return opens the screen the arrows reached (#35) 2026-10-18 22:05:21 -07:00
devin-ai-integration[bot]andbrent 2c5f8f85a3 Compare: outline changed areas on After only, linked to Before on hover (#33)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 21:52:45 -07:00
devin-ai-integration[bot]andBrent Vatne 23227ca55c capture.maxSessions: a review-wide session ceiling, spent on separate light/dark sessions when that pays (#32)
Co-authored-by: Brent Vatne <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 21:42:28 -07:00
devin-ai-integration[bot]andBrent Vatne ed1bf34434 Faster capture: parallel compare with early-abort region search, one Argent bridge thread per capture (#29)
Co-authored-by: Brent Vatne <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 21:29:58 -07:00
Brent Vatne bdf9e597d3 Large moves read as one moved region instead of fragments (#18) 2026-10-18 17:03:07 -07:00
devin-ai-integration[bot]andbrent 9063de5c52 Inspector: stack Before over After for landscape screenshots (#24)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:55:35 -07:00
devin-ai-integration[bot]andbrent 21ed8c06f6 Text that differs between a build's own light and dark captures is runtime state, not a change (#28)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:49:03 -07:00
devin-ai-integration[bot]andbrent 6795f19d04 Viewer: ⌘K is a command palette (#22)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:47:31 -07:00
devin-ai-integration[bot]andbrent 990e2ecc8d Ignore a foldable's rail status-bar pill like a phone's status bar (#23)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:44:10 -07:00
devin-ai-integration[bot]andbrent 95be8b5248 Viewer: calmer Map hover — no screen fading, Open in Inspector as a tooltip (#30)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:40:12 -07:00
devin-ai-integration[bot]andbrent 6fa7cba087 Viewer: switch targets in place, glide [ ] and +/- from the key down, keep screenshots up while they swap (#20)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:38:35 -07:00
devin-ai-integration[bot]andbrent f728eb187b Quiet PR comment: count + report link heading, per-device subtitle, changed screens as a list, previous run kept while a new run works (#19)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:36:23 -07:00
devin-ai-integration[bot]andbrent d069a892dc Clip diff regions that cross a system band; Android status-bar band 7 % (#25)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:33:21 -07:00
devin-ai-integration[bot]andbrent 4499a999d1 Viewer: / finds screens on the Screens page (#21)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:32:31 -07:00
devin-ai-integration[bot]andbrent 929ac82765 A comment or whitespace-only edit to a source file changes no screen (#26)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:31:59 -07:00
devin-ai-integration[bot]andbrent d5d6a5ff72 Inspector says why an excluded or redirect route has no screenshot (#31)
Co-authored-by: brent <[email protected]>
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-18 16:31:26 -07:00
devin-ai-integration[bot] 5c19061b0f Excluded routes leave the public map instead of showing as "Not compared" (#27) 2026-10-18 14:45:06 -07:00
Brent Vatne ec75e37e45 Release 0.19.8 2026-10-18 10:00:42 -07:00
Brent Vatne 1254a99841 Viewer preview fixtures: one report per target (#16) 2026-10-18 10:00:26 -07:00
Brent Vatne c2bae00f31 Fix flaky CI: stray SIGTERMs, port-lock race, fixture colour collisions, mid-review downloads, cold-Vite reloads (#17) 2026-10-18 09:56:13 -07:00
Brent Vatne 65b79684f3 Hosted previews serve the report as static files under the token, with no encryption and no Explore expiry (#14) 2026-10-18 09:45:24 -07:00
Brent Vatne b8b43ee2c8 Hosted previews open from a manifest, load screenshots on demand, and switch targets in place (#11) 2026-10-18 09:45:23 -07:00
Brent Vatne c59ccce32b PR comment map: opt in with report.comment.map; README: Compare at full width; release 0.19.7 (#13) 2026-10-17 21:54:20 -07:00
Brent Vatne c24049c443 README: animated hero and Compare, a map of changed screens in the PR comment (#12) 2026-10-17 21:31:58 -07:00
Brent Vatne cefeb8059a Release 0.19.6 2026-10-17 20:44:52 -07:00
Brent Vatne 078902710b Capture iPhone Duo on EAS Simulator with eas simulator:control, for both controllers (#9)
Capture iPhone Duo on EAS Simulator with eas simulator:control, for both controllers

- eas-cli 25.2.0: app.approveUrlScheme after install, appearance.set for Argent on
  iOS EAS sessions, and springboard.restart as the last fold recovery step. The
  controller's own tools come first; these only fill what neither controller has.
- iPhone Duo on EAS: both controllers' folds are verified (Argent by its tree,
  agent-device by its screenshot) and recovered by restarting SpringBoard and
  folding again, once; never by stopping the session's tool-server.
- agent-device opens the app before folding on EAS, as it does locally.
- agent-device pinned to 0.21.29-nightly.20261018.74 for callstack/agent-device#3776,
  which stops @expo/ui sliders on a regular-width display from wedging its runner.
- A session EAS fails to start is replaced, up to five times within 30 minutes,
  with a growing wait, only when the failure is provably EAS's.
- doctor warns about Argent's single appearance only for Android EAS sessions.
2026-10-17 20:44:41 -07:00
Brent Vatne 46ff99aad1 Viewer: held keys repeat and glide, arrows enter the map, held modifiers show their keys, T and ⇧T (#10) 2026-10-17 18:52:55 -07:00
Brent Vatne a75cbf84ea Link the deployment when the example alias still serves an earlier one
The example report reuses one token and the same fixture reports, so an alias
still pointing at the previous deployment serves the token page and the same
report bytes; only its reports.json (an older Viewer's listing) differed, and
that mismatch failed the job as PREVIEW_VERIFY_FAILED. The alias now counts as
moved only once it serves this deployment's listing and reports, and an alias
that never does is PREVIEW_ALIAS_BEHIND: the verified deployment is linked
with a warning. The deployment's own origin is still checked strictly.

The README's "Run it yourself" now opens with the two ways to use Explore and
which one needs an Expo account.
2026-10-17 16:26:40 -07:00
Brent Vatne 6c10477c5b Run explore:binary on a local simulator, and bring the README up to date (#8)
explore:binary --simulator local explores a build on a simulator or emulator
it creates on this Mac, with no EAS login: the same devices capture uses,
recorded for the startup sweep, driven by agent-device with its own daemon or
by a local Argent tool-server. The report opens in the local Viewer; --upload
hosts it.

The README now covers local repack and local simulators, a single-path quick
start that reviews a change or explores a build, targets, and requirements
split by what each path needs. The explore-binary, explore-setup and
readme-refresh skills follow.
2026-10-17 15:53:21 -07:00
Brent Vatne 284ae6a780 Local simulators and emulators, capture targets, faster and sturdier runs (#7)
Capture on this machine (local iOS simulators and Android emulators, with agent-device or Argent) as well as on EAS Simulator; name several capture targets per config (a phone, a foldable closed and open, Android) and review them in parallel with shared builds; repack locally with a local simulator; and make captures faster and harder to break: controller fault containment, an Argent fold recovery, upright captures of an opened iPhone Duo, a settle after each root reset, a route retry after an adb drop, emulator port reservation, a startup sweep of what interrupted captures leave running, and agent-device 0.21.28.
2026-10-17 14:55:21 -07:00
Brent VatneandClaude Opus 5.5 88a73dd2a9 Drive EAS Simulator with Argent as an alternative to agent-device (#6)
Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-16 19:24:56 -07:00
Brent Vatne 6a8dbfb5a3 Pin eas-cli 25.0.0, and start Explore's sessions with a public preview link (#5) 2026-10-16 14:26:45 -07:00
Brent Vatne e3afc2a00c README: one place for local reviews, a framed hero, and a table of what you get
- Merge "Review a change before you push it" into the Quick start: the reports
  picker and the details of a local review now live there.
- Replace "What you get" with a row of three pictures under the hero (Compare,
  Screens, the PR comment), with the agent prompt collapsed beneath; Terms and
  How agents read a report move to Additional information.
- The hero is the Map zoomed in on the selected screen and framed as a window on
  a soft stage (readme-screenshots.mjs: stagedWindow, --zoom).
- Regenerate every screenshot from the euxy #157 fixtures, with the new Screens
  grid, and update the readme-refresh skill to this layout.
2026-10-16 13:08:35 -07:00
Brent Vatne a60ae5c6d8 Release 0.19.5 2026-10-16 12:39:06 -07:00
Brent Vatne d26e65db47 Add a README quick start, and run local reviews with no setup
- README: a Quick start of two steps (make the app buildable on EAS, then
  `npx @expo/explore capture`), with a prompt to paste into Claude Code or Codex.
- `capture` is a one-word name for `capture:review`.
- A local review reviews the working tree by default, untracked files included,
  as `eas build` uploads it. `--committed` reviews HEAD alone, and an eas.json
  with `cli.requireCommit: true` leaves uncommitted changes out, as eas build does.
- Without `.expo-explore/config.yaml`, a local review uses the config `setup`
  would write (or an uncommitted one in the checkout), so it works before setup.
- setup prefers a simulator profile named `explore` when there are several.
2026-10-16 12:36:38 -07:00
Brent Vatne 47f37988a5 Release 0.19.4 2026-10-15 23:06:16 -07:00
Brent Vatne 1a5a95af63 Show Screens as one grid of screen cards, with arrow-key stepping and ⌃1/2/3 (#4) 2026-10-15 23:06:09 -07:00
Brent Vatne fc5b465513 Release 0.19.3 2026-10-15 20:42:49 -07:00
Brent Vatne 09b9f34e33 Label outlines with how far moved areas moved (#3) 2026-10-15 20:42:38 -07:00
253 changed files with 45988 additions and 3446 deletions

No files matched your search

+7 -1
View File
@@ -61,7 +61,13 @@ jobs:
env:
# npm cannot generate provenance for a private repository.
NPM_CONFIG_PROVENANCE: "false"
run: npm publish --access public
VERSION: ${{ steps.version.outputs.version }}
shell: bash
# A prerelease (0.20.0-next.0) goes to the next tag, so latest keeps the last release.
run: |
set -euo pipefail
if [[ "$VERSION" == *-* ]]; then tag=next; else tag=latest; fi
npm publish --access public --tag "$tag"
- name: Tag the release
if: steps.version.outputs.publish == 'true'
env:
+7 -2
View File
@@ -76,9 +76,14 @@ jobs:
| [$marker,
"**Viewer preview** of \($sha)\(if $source != "" then " · reports from \($source)" else "" end)",
"",
"| Platform | Changes | Open |",
"| Report | Changes | Open |",
"| --- | --- | --- |",
($reports[] | "| \(if .platform == "ios" then "iOS" else "Android" end)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?platform=\(.platform)) · [Screens](\($url)?platform=\(.platform)#/screens) · [Compare](\($url)?platform=\(.platform)&view=compare) |"),
# One row per target, named by its label; a target named after its platform keeps ?platform= links.
($reports[]
| (.target // .platform) as $id
| "\(if $id == "ios" or $id == "android" then "platform" else "target" end)=\($id)" as $query
| ((.label // (if .platform == "ios" then "iOS" else "Android" end)) | gsub("\\|"; "\\\\|")) as $name
| "| \($name)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?\($query)) · [Screens](\($url)?\($query)#/screens) · [Compare](\($url)?\($query)&view=compare) |"),
"",
"The link stays the same on every push. [Deploy run](\($run))"]
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
+30 -13
View File
@@ -34,31 +34,31 @@ Older setups vendored the tools into `.github/vendor/expo-explore` and pinned th
| Workflow | Trigger | Condition | Result |
| --- | --- | --- | --- |
| `explore-review.yml` | `pull_request_target` (opened, synchronize, reopened, ready_for_review), `workflow_dispatch` with `pr=N` | Open, non-draft, same-repository PR whose author has write access or is listed in `ci.trustedAuthors` | Captures base and head, compares, packages a report, comments on the PR |
| `explore-baseline.yml` | `push` to the default branch, `workflow_dispatch` | Default branch only | Captures every route of one commit per configured platform and uploads `explore-baseline-<sha>-<platform>` for later PRs to reuse |
| `explore-baseline.yml` | `push` to the default branch, `workflow_dispatch` | Default branch only | Captures every route of one commit per configured target and uploads `explore-baseline-<sha>-<target>` for later PRs to reuse |
| `explore-compare.yml` | `workflow_dispatch` or `workflow_call` with `base` and `head` (branch, tag or SHA) | Whoever can run or call workflows (write access) | Captures base and head, compares, packages a report like a PR review (`capture:review --compare`), and links it from the run summary; no PR comment |
Each workflow starts with a `platforms` job: it installs the pinned CLI and runs `expo-explore config:platforms`, whose JSON list (`["ios"]`, `["ios","android"]`) becomes the matrix of the capture, report, and baseline jobs (`fail-fast: false`). Every matrix job passes `--platform ${{ matrix.platform }}`, so one platform's failure neither cancels nor hides the other's report.
Each workflow starts with a `targets` job: it installs the pinned CLI and runs `expo-explore config:targets`, whose target ids (`jq -c '[.targets[].id]'`) become the matrix of the capture, report, and baseline jobs (`fail-fast: false`). A config without `targets:` has one target per platform named after it (`["ios"]`, `["ios","android"]`), so its artifact names, baselines and comment records are the ones per-platform versions wrote; a config with `targets:` lists its own (`["iphone","duo-closed","duo-open","android"]`), and several may share a platform. Every matrix job passes `--target "$TARGET"` (`TARGET: ${{ matrix.target }}`), and GitHub names each job after its target (`capture (duo-open)`), so one target's failure neither cancels nor hides another's report.
### 2.2 `explore-review.yml`
| Job | Step | What it does |
| --- | --- | --- |
| platforms | Install Explore, resolve and authorize the live pull request | As in the capture job below; it exports the PR's number and commits so the failure job can comment even when a capture job fails before resolving the PR itself. Then checks out head and lists the platforms. |
| capture (matrix: platform) | Install Explore | Validates `EXPLORE_VERSION`, `npm pack`s that release into `$TOOLS_PREFIX`, then `npm ci --omit=dev --include=optional --ignore-scripts` against the release's shrinkwrap. The agent runtimes and `eas-cli` are optional dependencies, so `--include=optional` is what makes capture possible. The step is defined once per workflow file (a YAML anchor) and reused in every job. |
| targets | Install Explore, resolve and authorize the live pull request | As in the capture job below; it exports the PR's number and commits so the failure job can comment even when a capture job fails before resolving the PR itself. Then checks out head and lists the targets. |
| capture (matrix: target) | Install Explore | Validates `EXPLORE_VERSION`, `npm pack`s that release into `$TOOLS_PREFIX`, then `npm ci --omit=dev --include=optional --ignore-scripts` against the release's shrinkwrap. The agent runtimes and `eas-cli` are optional dependencies, so `--include=optional` is what makes capture possible. The step is defined once per workflow file (a YAML anchor) and reused in every job. |
| | Resolve and authorize the live pull request | `ci:pr` reads the PR through the API. Forks, drafts and authors without write access (unless listed in `ci.trustedAuthors` of the default branch's `config.yaml`, read through the API) fail with `SOURCE_NOT_TRUSTED`. Writes `explore-pr.json` (repository, number, base/head ref and SHA) and the step outputs. Runs before any PR code is checked out. |
| | checkout `app-base`, `app-head` | Checks out the exact base and head SHAs with full history and without persisted credentials. |
| | Verify deterministic source planning | `source:verify` builds the capture plan from source alone in two fresh processes and compares the bytes. Runs before any build or simulator work and needs no credentials. |
| | Install app dependencies | `npm ci --ignore-scripts` in both checkouts (`APP_INSTALL_DIR` for monorepos). |
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<platform>` artifact (iOS also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<target>` artifact (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
| | Capture review | `capture:review` (§3). `EXPO_TOKEN`, the provider key and the app's `{{secret:NAME}}` values reach only this step. The sticky PR comment is updated while it runs. It writes `preview=<hosting>` to the step outputs, which decides whether the deploy job runs. |
| | Stop capture sessions and check the checkouts | `ci:after-capture`, whenever the PR was resolved, success or not: stops the EAS Simulator sessions named in `head-session` / `base-session`, nothing else, then fails with `CHECKOUT_MODIFIED` if capture modified an app checkout. |
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<platform>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<platform>` keeps plans, exports and agent diagnostics for 7 days. |
| report (matrix: platform) | Install Explore, download the capture | Runs without Expo or model credentials. |
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<target>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<target>` keeps plans, exports and agent diagnostics for 7 days. |
| report (matrix: target) | Install Explore, download the capture | Runs without Expo or model credentials. |
| | Package hosted review bundle | `ci:report` writes the report directory. |
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<platform>`, 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 has one section per platform between `<!-- expo-explore-platform:<platform> -->` markers; each job replaces only its own section, so parallel platforms do not overwrite each other. |
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every platform'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. |
| 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 platform's section when the run has several. |
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
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 `platforms` 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 platform'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`)
@@ -93,7 +93,7 @@ A failure at any stage is recorded in `state.failure`, a partial report is writt
| 1 | cache | If a reuse directory exists, its bundle and map are validated and copied. With no routes left, skip straight to export. |
| 2 | `configuration` | `eas config --profile` confirms the app identity and scheme, `ios.simulator: true` and the bundle ID; `eas simulator:availability`. |
| 3 | `build` | `eas fingerprint:generate`; a finished simulator build with the same fingerprint is reused, otherwise `eas build --wait` (up to 45 minutes). |
| 4 | `instrumentation` | A hosted EAS `repack` workflow job (`eas workflow:run --wait --json` from a staged copy of the checkout) rebundles the current JavaScript with a read-only navigation observer (the same observer on both sides) and returns the repacked build ID; `capture.repack: local` runs `@expo/repack-app` on the runner and `eas upload`s the result. Generated files stay outside the checkout. |
| 4 | `instrumentation` | A hosted EAS `repack` workflow job (`eas workflow:run --wait --json` from a staged copy of the checkout) rebundles the current JavaScript with a read-only navigation observer (the same observer on both sides), and the repacked app is downloaded and installed into the session; `capture.repack: local` (the default with `capture.simulator: local`) runs `@expo/repack-app` on the runner, and its app is installed without an upload. Generated files stay outside the checkout. |
| 5 | `session` | `eas simulator:start`; the session ID is written to `<side>-session`; the app is installed. |
| 6 | route capture | Mode-specific (§5). `agent-device` drives the simulator and records a screenshot plus the accessibility tree. A capture is accepted only when the observer's reported destination matches the requested route. |
| 7 | `export` / `cleanup` | Validate the map, write `<side>-export/` (`bundle.json`, `execution.json`, PNGs, `capture-diagnostics/`), stop the session. |
@@ -159,6 +159,23 @@ invisible on a device.
A pixel mismatch that rounds to 0.00% is noise and counts as "same". Diff regions inside the status-bar band are excluded from the verdict and reported as `ignoredStatusBarRegions`; the Viewer marks that band in Compare.
Each changed region also records whether its content only moved. CI searches for the shift (up to 20 screenshot
pixels vertically and 4 horizontally, whole pixels and then sixths of one) that best lines Before up with After inside
the region; near-ties go to the smallest move, and a second fit nearly as good two or more pixels away (repeating
content) or a best fit at the edge of the search leaves the region unmeasured. When the shift explains most of the
region's difference (a quarter for a move of half a pixel or less, where text re-rasterizes rather than moves; 60%
above that) and, aligned by it, no more than two pixels still differ by over 140 in any channel, the region gets
`shift: { x, y }` in screenshot pixels (right and down positive). New text, another colour or a caret is not a move.
Every region the comparison found is measured, not only the eight it publishes, and `allRegionsMoved: true` says all
of them moved. Moves are measured while the comparison's time budget lasts.
The Viewer draws moved areas dashed, at each side's own position, labelled with how far they moved to a tenth
("↑4.1pt"); areas whose moves are within a third of each other merge into one outline, never around a changed area.
When every region moved, What changed says how far per direction in place of the generic visual finding, and adds
"Nothing on this screen changed content" when no other finding remains. A switch there turns the labels off. iOS
screenshots are one pixel per point, so labels read in points; Android's are labelled in screenshot pixels, since the
report does not know the screen's density.
## 7. Local CI test
`test/ci/run.mjs` runs the production pipeline against an app folder in this repository (`test/ci/apps/wallet`) and a scenario (`test/ci/scenarios/<app>/<name>/`: `scenario.json`, `overlay/`, `expected.json`, optional `setup.yaml`). The [local CI test harness README](test/ci/README.md) covers prerequisites, scenarios, expectations, the matrix runner and how to revisit a result. In outline:
+270 -137
View File
@@ -1,72 +1,186 @@
# Expo Explore
Explore maps your app: a screenshot of every screen, connected by the taps between them. On each pull request it captures the screens the PR changes, before and after, on EAS Simulator, and posts a visual review.
Explore maps your app: a screenshot of every screen, connected by the taps between them. On each pull request it captures the screens the PR changes, before and after, on EAS Simulator, and posts a visual review. On your Mac it can also run on a local simulator.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-hero-dark.png">
<img alt="Explore's Map of the euxy app with the new About screen selected: every screen as a card laid out by distance from the launch screen, and the Inspector on the right showing the About capture as an added screen with its transitions" src="docs/screenshots/readme-hero-light.png">
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-hero-dark.svg">
<img alt="Explore's Map of a euxy pull request, animated: the screen cards appear row by row, the new About screen marked Added among the modified Patterns screens, the transitions between them wipe in, then a click selects About, its transitions light up and the Inspector slides in on it, shown as a window on a soft stage" src="docs/screenshots/readme-hero-light.svg">
</picture>
**See a real report:** [euxy](https://explore-example--euxy.expo.app/p/rfcoic27ccgnrmzgijubxkmuzmptcrva?platform=ios), a MIDI sequencer, reviewed by Explore. It is redeployed with the current Viewer on every merge to main.
<details>
<summary><strong>Requirements</strong></summary>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-compare-dark.svg">
<img alt="The euxy Patterns screen wiping from its capture before the pull request to its capture after it: each pattern row's tempo moves out of the subtitle into its own column on the right, then the changed subtitles are outlined" src="docs/screenshots/readme-compare-light.svg">
</picture>
- An iOS app, an Android app, or both. Explore is in v0; Android capture is newer than iOS.
- Expo SDK 57 or newer, with Expo Router (57 or newer) or React Navigation (6 or newer).
- An EAS build profile per platform: `ios.simulator: true` for iOS, `android.buildType: apk` for Android. Its EAS environment cannot have secret-visibility variables.
- EAS Simulator access (in preview, [join the waitlist](https://expo.dev/services/simulators)).
- Node.js 24.12 or newer, and admin access to the GitHub repository.
**Compare**: each changed screen before and after, with the changed regions outlined.
<table>
<tr>
<td width="50%" valign="top">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-screens-dark.png">
<img width="100%" alt="The Screens view of a euxy review: the app/ route tree on the left under Changed 9 and All 19, and a grid of screen cards beside it in the same order, each with its route below the screenshot and a dot before it: green for the new /about, orange for modified screens such as /activity-log, /settings and /patterns, red for the removed /channel-surf" src="docs/screenshots/readme-screens-light.png">
</picture>
<strong>Screens</strong>: every capture in one grid, beside the route tree, with a dot for what changed.
</td>
<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: 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>
</tr>
</table>
<details>
<summary><strong>Ask an agent about a report</strong></summary>
Paste this into Claude Code, Codex, Cursor, or any tool that can fetch a URL. In the Viewer, **Hand off to AI** fills it in for you:
```text
Review the visual changes in this PR. Expo Explore report: <report link>
Fetch the link first. It explains the report's JSON API. Go through the changed screens,
compare the before and after screenshots, and tell me which changes look intended and
which look like regressions. For each regression, name the source file to fix.
```
</details>
## Try it on your app
<details>
<summary><strong>Requirements</strong></summary>
Paste this into Claude Code or Codex from your app's directory. It explores a build you point to, or an Expo project straight from its source:
- To review a change: Expo SDK 57 or newer, with Expo Router (57 or newer) or React Navigation (6 or newer), and an Expo account, since Explore builds the app on EAS. An EAS build profile per platform: `ios.simulator: true` for iOS, `android.buildType: apk` (not a development build) for Android. Its EAS environment cannot have secret-visibility or file variables.
- To explore a build: a simulator build of any app, and a Claude Code or Codex login (or an API key). On a local simulator it needs no Expo account.
- Somewhere to run the app: EAS Simulator (in preview, [join the waitlist](https://expo.dev/services/simulators)), which CI uses; or a [local simulator](#simulator) on your Mac: Xcode 26 or newer for iOS (the default devices are iPhone 17 models) and, for Android, the Android SDK with `ANDROID_HOME` set (emulator, platform-tools, cmdline-tools and a system image; to review a change, also build-tools and a JDK 17).
- Node.js 24.12 or newer. For CI, admin access to the GitHub repository.
</details>
## Quick start
Paste this into Claude Code or Codex from your app's directory. It reviews a change to your app, before and after, or, if you point it to a build, maps every screen of that build:
```text
Show me Expo Explore working on this app. Follow
https://unpkg.com/@expo/explore/skills/explore-binary/SKILL.md and run Explore with
npx @expo/explore. If I point you to a build, explore that. Otherwise, if this is an
Expo project, run it from source without making a new build; if it is not, get a
simulator build of it. If the app needs a sign-in, ask me for a test account the way
the skill describes, never for a password in chat. Give me the report link, and if I
need to log in to something first, tell me the command.
Show me Expo Explore working on this app, with npx @expo/explore. If I point you to a
build (.app, .tar.gz, simulator .ipa, or .apk), explore it: follow
https://unpkg.com/@expo/explore/skills/explore-binary/SKILL.md. If this is not an Expo
project, ask me for a simulator build and explore that. Otherwise review a change to
this app: follow the "Review a change on this machine" section of
https://unpkg.com/@expo/explore/skills/explore-setup/SKILL.md. If the app cannot build
for the iOS Simulator on EAS yet, set that up (an EAS project, ios.bundleIdentifier, an
"explore" profile with ios.simulator: true) and ask me before you commit it. If I have
no EAS Simulator access, pass --simulator local (it needs Xcode; exploring an .apk needs
the Android SDK instead). If I have no uncommitted changes, change some text near the
top of a screen. If the app needs a sign-in, ask me for a test account the way the skill
describes, never for a password in chat. Open the report, and if I need to log in to
something first, tell me the command.
```
For apps behind a sign-in, see [Sign-in and other app state](#sign-in-and-other-app-state).
You need Node.js 24.12+. Reviewing a change needs an Expo account and an Expo SDK 57+ app with Expo Router or React Navigation: it is built on EAS and captured on EAS Simulator or, with Xcode, on a simulator on your Mac. Exploring a build needs a Claude Code or Codex login, and EAS Simulator or a simulator on your Mac; on your Mac, no Expo account. No API keys, no CI.
> [!NOTE]
> EAS Simulator is in preview. [Join the waitlist](https://expo.dev/services/simulators), or pass `--simulator local` to capture on a simulator on your Mac.
<details>
<summary><strong>Run it yourself</strong></summary>
There are two ways to use Explore: review a change to your Expo app, which needs an Expo account, or explore an iOS or Android build of any app directly, which needs no Expo account when it runs on your Mac.
**Review a change**, from your app's directory:
1. Make the app buildable on EAS, if it is not yet:
```sh
npx eas-cli@latest login
npx eas-cli@latest init
```
Then set `ios.bundleIdentifier` in your app config, add a simulator profile to `eas.json`, and commit. The "before" is where your branch left the default branch: on the default branch, your last commit.
```json
{ "build": { "explore": { "ios": { "simulator": true } } } }
```
2. Edit some text near the top of a screen (Explore captures the first screenful) and run:
```sh
npx @expo/explore capture # on EAS Simulator
npx @expo/explore capture --simulator local # or on a simulator on your Mac
```
Explore builds your last commit and your uncommitted changes on EAS, captures the screens the changes can affect, before and after, and opens the report in your browser. The first run waits for an EAS build; later runs reuse it while your native code is unchanged. A [local simulator](#simulator) is one Explore creates on your Mac and removes afterwards.
**Explore a build:**
```sh
npx @expo/explore explore:binary ./my-app.apk # Android APK
npx @expo/explore explore:binary ./my-app.app # iOS simulator build (.app, .tar.gz, or simulator .ipa)
npx @expo/explore explore:binary ./my-app.apk # Android APK
npx @expo/explore explore:binary ./my-app.app # iOS simulator build (.app, .tar.gz, or simulator .ipa)
npx @expo/explore explore:binary ./my-app.app --simulator local # on a simulator on your Mac
```
Explore starts an EAS Simulator, installs the build, taps through the app with your Claude Code or Codex login, and prints a link to the hosted report.
Explore starts an EAS Simulator, installs the build, taps through the app with your Claude Code or Codex login, and prints a link to the hosted report. With `--simulator local` it runs on a simulator or emulator it creates on your Mac, needs no Expo account, and opens the report in your browser. Its [options](#options) are below.
</details>
> [!WARNING]
> A review runs both commits' code on your machine, as you: it installs their dependencies, evaluates the app config and bundles the JavaScript. Review only commits you would run yourself, and someone else's branch only if you trust it.
Every run is kept on your machine for 30 days. `npx @expo/explore reports` lists your local reviews, explorations and uploaded reports with their commits, and reopens or hosts one without capturing again:
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-reports-dark.png">
<img alt="npx @expo/explore reports in a terminal: the Expo Explore wordmark, then one line per saved run (a local review of HEAD vs main selected, an exploration of an app, and PR #1), and below them the selected run's head and base commits with their messages and its 13 modified, 2 added, 2 removed and 17 need-review screens" src="docs/screenshots/readme-reports-light.png">
</picture>
<details>
<summary><strong>Other commits, and what a review does</strong></summary>
```sh
npx @expo/explore capture # HEAD and your uncommitted changes, against where HEAD left the default branch
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 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.
- Like a CI review, it builds on EAS (reusing a matching build) and, unless it captures on a local simulator, runs EAS Simulator sessions: expect several minutes and EAS usage.
- Saved runs take up to 2 GB in all, the oldest going first. `reports add <report.zip>` keeps a report you downloaded, such as a PR's `explore-review` artifact.
</details>
Explore uses its defaults until you run `npx @expo/explore setup`, which writes `.expo-explore/config.yaml` for you to change. Next: [review every pull request](#set-up-ci).
## Map every screen of any app
Pointed to a build, the [quick start](#quick-start) maps every screen of it, with no source and no config: one card per screen it reached, connected by the taps between them. For apps behind a sign-in, see [Sign-in and other app state](#sign-in-and-other-app-state).
<details>
<summary id="options"><strong>What it needs, and its options</strong></summary>
- An EAS login (`eas whoami`) and a `claude` or `codex` login, or `ANTHROPIC_API_KEY` / `OPENAI_API_KEY`.
- A simulator build. A device `.ipa` or an `.aab` is rejected before a session starts.
- A `claude` or `codex` login, or `ANTHROPIC_API_KEY` / `OPENAI_API_KEY`.
- EAS Simulator access and an EAS login (`eas whoami`), or `--simulator local` to run on a [local simulator](#simulator) with no EAS login.
- A simulator build. A device `.ipa`, an `.aab`, an unsigned APK, or an APK without native libraries for the emulator (x86_64 on EAS Simulator, `arm64-v8a` locally on Apple silicon; a universal APK has both) is rejected before a device starts.
- Platform, bundle id, name, and version are read from the build; you pass nothing else.
- 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 "Clear cache"` allows one by label.
- 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)).
- The hosted link lasts 7 days (`--expires-in 30d|never`). `--no-upload` keeps the report local, and `--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 32-character token.
- Read a local result with `expo-explore view --dir <folder>`, `screen:list`, or `gap:list`.
- 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`.
</details>
<details>
<summary><strong>Explore a simulator session you already started</strong></summary>
If the app is already running on an `agent-device` EAS Simulator session, Explore can start from there. It leaves your session running.
If the app is already running on an EAS Simulator session (`--type agent-device` or `--type argent`), Explore can start from there, with the session's controller. It leaves your session running.
```sh
eas simulator:start --type agent-device --out-config-type dotenv # then agent-device install / open
@@ -81,55 +195,19 @@ npx @expo/explore explore:session <session-id> --env-file path/.env.eas-simulato
<details>
<summary><strong>What a run without source shows</strong></summary>
One card per screen the run reached, laid out by how many taps it took, with the tapped control on each edge. There is no before and after; that needs [CI](#set-up-ci).
One card per screen the run reached, laid out by how many taps it took, with the tapped control on each edge. There is no before and after; that needs the app's source: [`capture`](#quick-start) on your machine, or [CI](#set-up-ci).
![The Map of an exploration report for the euxy app: one card per screen the run reached, laid out by taps from the launch screen, each edge labelled with the control that was tapped](docs/screenshots/readme-exploration-light.png)
</details>
### Review a change before you push it
Once Explore is [set up](#set-up-ci) (`.expo-explore/config.yaml` committed), the review a PR gets also runs on your machine, between any two commits. No tokens or keys to set: it uses your `eas login` and your Claude Code or Codex login.
```text
Review my current changes with Expo Explore. Follow the "Review a change on this machine"
section of https://unpkg.com/@expo/explore/skills/explore-setup/SKILL.md, compare my
branch (with my uncommitted changes) against main, and open the report.
```
Every run is kept on your machine for 30 days. `npx @expo/explore reports` lists your local reviews, explorations and uploaded reports with their commits, and reopens or hosts one without capturing again:
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-reports-dark.png">
<img alt="npx @expo/explore reports in a terminal: the Expo Explore wordmark, then one line per saved run (a local review of HEAD vs main selected, an exploration of an app, and PR #1), and below them the selected run's head and base commits with their messages and its 13 modified, 2 added, 2 removed and 17 need-review screens" src="docs/screenshots/readme-reports-light.png">
</picture>
<details>
<summary><strong>Run it yourself</strong></summary>
```sh
npx @expo/explore capture:review # HEAD against where it left the default branch
npx @expo/explore capture:review --uncommitted # your uncommitted changes too
npx @expo/explore capture:review --base v1.3.0 --head v1.4.0 --scope all --upload
```
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform on EAS Simulator (`--platform` picks one), and opens the report in a local Viewer. `--upload` hosts it and prints the link; `report:upload <report.zip>` hosts one you already have.
- Your checkout, index and branches are never touched. `--uncommitted` takes tracked changes only; `--include-untracked` adds untracked files, which are uploaded with the EAS build.
- It runs both commits' code on your machine, as you: installing their dependencies, evaluating the app config, and bundling the JavaScript. That is what checking them out and running them would do, so review only commits you would run, and someone else's branch only if you trust it.
- Installs run without credential environment variables, which keeps tokens out of reach of a registry a commit's `.npmrc` names; that is not a sandbox. A registry that needs `${NPM_TOKEN}` in the project's `.npmrc` must be authenticated in your own `~/.npmrc`.
- Captures are cached in `~/.cache/expo-explore`, so the same base is not captured twice (`--no-cache` skips it); a capture unused for 30 days goes, and the cache stays under 2 GB. Ctrl+C stops the run's simulator sessions.
- Like a CI review, it builds on EAS (reusing a matching build) and runs simulator sessions: expect several minutes and EAS usage.
- Saved runs take up to 2 GB in all, the oldest going first. `reports add <report.zip>` keeps a report you downloaded, such as a PR's `explore-review` artifact.
</details>
## Set up CI
Explore runs in your repository's GitHub Actions in two ways, both from the same setup: a review on every pull request, and a comparison of any two commits, such as a release against the last one.
### Review on every PR
Each pull request gets a comment linking its report: the screens it added, removed or changed, before and after, on each platform you capture. Paste this into Claude Code or Codex from your app's repository:
Each pull request gets a comment linking its report: the screens it added, removed or changed, before and after, on each platform or device ([target](#targets)) you capture. Paste this into Claude Code or Codex from your app's repository:
```text
Set up this app for Expo Explore CI reviews. Follow
@@ -149,15 +227,14 @@ 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
```
- Run `expo-explore setup --workflows` after enabling it to add the `deploy` job.
- A [comparison of two commits](#compare-any-two-commits) links its hosted report from the run's summary instead of a PR comment. `capture:review --upload` on your machine deploys to the same project with your `eas login`.
- `expo-explore report:upload <report.zip>...` hosts reports already on your machine the same way: a review's reports (one per platform, from `capture:review --output` or a downloaded `explore-review` artifact) or an `explore:binary` report.
- The generated workflows already have the `deploy` job; it runs once `hosting: eas` is set.
- 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>
@@ -167,12 +244,12 @@ report:
The prompt above walks through these steps with you. To do them yourself:
1. Run `npx @expo/explore setup` in your app's directory (in a monorepo, add `--project apps/mobile`). It writes `.expo-explore/config.yaml` and the workflows.
2. Run `npx @expo/explore doctor` and fix each problem it reports, until it exits 0. `doctor --capture` captures the committed app on EAS once, to check every screen before your first PR.
2. Run `npx @expo/explore doctor` and fix each problem it reports, until it exits 0. `doctor --capture` captures the committed app once, to check every screen before your first PR (with several targets, pass `--target`).
3. Set the repository secrets `doctor` lists:
- `EXPO_TOKEN`: create it in [Expo access tokens](https://expo.dev/settings/access-tokens). For [hosted previews](#hosted-previews), use a [robot user](https://docs.expo.dev/accounts/programmatic-access/) that can create projects.
- A secret for each `{{secret:NAME}}` in your setup steps. Run `npx @expo/explore setup --workflows` after you add one.
4. Commit, merge to the default branch, and run **Expo Explore baseline** from GitHub Actions.
5. Open a PR. **Expo Explore review** runs and posts a comment with the report. To see a whole review of your branch first, run `npx @expo/explore capture:review` on your machine.
4. Commit and merge to the default branch. **Expo Explore baseline** runs on that push (or run it from GitHub Actions).
5. Open a PR. **Expo Explore review** runs and posts a comment with the report. To see a whole review of your branch first, run `npx @expo/explore capture` on your machine.
A failed run shows an error code and a next action in the PR comment; see [CI troubleshooting](docs/quickstart-ci.md#diagnose-a-failed-run).
@@ -193,7 +270,7 @@ Both modes use the same comparison rules and report. You can change modes later.
**To use agent mode:**
1. Create an [Anthropic](https://platform.claude.com/settings/keys) or [OpenAI](https://platform.openai.com/api-keys) API key.
2. Set `mode: agent` and an `agent.model` your account can use.
2. Set `mode: agent`, `agent.provider` (`anthropic` or `openai`), an `agent.model` your account can use, and `agent.instructions`: the path of a file in the repository that tells the agent how to use the app.
3. Store the key as the repository secret `ANTHROPIC_API_KEY` or `OPENAI_API_KEY`. A key that is not workspace-scoped also needs the `ANTHROPIC_WORKSPACE_ID` variable.
4. Export the key and run `expo-explore doctor --check-model`.
@@ -227,6 +304,84 @@ platforms:
</details>
<details>
<summary id="targets"><strong>Several devices: targets</strong></summary>
To capture more than one device of a platform, such as a phone and a foldable, or a foldable both closed and open, name each one under `targets` instead of `platforms`. Each target is captured and reported on its own, in this order:
```yaml
targets:
iphone: { platform: ios, device: iPhone 17 }
duo-closed: { platform: ios, device: iPhone Duo, pose: closed }
duo-open: { platform: ios, device: iPhone Duo, pose: open }
android: { platform: android, device: pixel_7, bundleId: com.example.myapp, easProfile: explore-android }
```
- A target takes the `app` fields it does not set, and `device.name` when it is of `app.platform`; a target of another platform sets its own `bundleId` and `easProfile` (an Android one's device defaults to `pixel_7`). `pose` is `closed`, `half-open` or `open`. `label` names it in reports (by default its device and pose).
- Ids are up to 32 lowercase letters, digits and dashes, start with a letter, and are not `base`, `head` or `report`. A config names at most 8 targets. A config with `platforms` has one target per platform, named `ios` and `android`.
- The workflows run one capture job per target, the PR comment has a section per target, and each report links its sibling targets' reports.
- A target can also set its own `controller` and `simulator` over `capture`'s, such as Android on agent-device beside iOS targets on Argent. `--controller` and `--simulator` override every target's for one run.
- `capture --target duo-open` reviews one target on this machine; `--platform ios` the iOS ones. On your machine a review's targets run at once (at most `--parallel N`), and targets of one platform and EAS profile share each commit's build; in CI each target is its own job. A target that fails outright costs only its own report.
- A device controller that stops answering on one screen costs that route, up to three times per capture: Explore restarts the app, goes on with the next route, and records what happened in `capture-diagnostics/controller-recoveries.jsonl`.
</details>
<details>
<summary id="controller"><strong>Device controller: agent-device or Argent</strong></summary>
Explore drives the simulator with [agent-device](https://github.com/callstackincubator/agent-device) by default. To use [Argent](https://github.com/software-mansion/argent) instead, set it in the config or pass it for one run:
```yaml
capture:
controller: argent # agent-device (default) | argent
```
```sh
npx @expo/explore capture --controller argent
npx @expo/explore explore:binary ./app.apk --controller argent
```
Explore pins each controller's version and starts the EAS session with it. Reports and baselines record the controller, and a review compares captures made with the same one.
Neither controller is installed with Explore. The first run that needs one downloads its pinned npm release (agent-device 1.6 MB, Argent 27 MB), checks it against the integrity hash Explore pins, and keeps it in `~/.cache/expo-explore/controllers` (`EXPLORE_CONTROLLER_CACHE` moves it). Behind a private registry, set `EXPLORE_NPM_REGISTRY` to a mirror of it.
Argent cannot switch the simulator's appearance yet ([software-mansion/argent#1509](https://github.com/software-mansion/argent/pull/1509)), so the host switches it: on an iOS EAS Simulator session (`eas simulator:control appearance.set`) and on a [local simulator](#simulator), every appearance the config asks for is captured. An Argent capture on an Android EAS Simulator session records one appearance: the one the app forces, else light. Explore warns when it skips one.
</details>
<details>
<summary id="simulator"><strong>Local simulator instead of EAS Simulator</strong></summary>
To capture on your Mac instead of EAS Simulator, pass it for one run, or set it in a config you use only on your Mac:
```yaml
capture:
simulator: local # eas (default) | local
```
```sh
npx @expo/explore capture --simulator local
```
CI runs on GitHub's Ubuntu runners and captures on EAS Simulator, so keep `simulator: local` out of the config you commit.
For each commit, Explore starts a device of its own and removes it afterwards; head and base each get one:
- **iOS:** a simulator of the configured device with Xcode's newest runtime that runs it. `DEVELOPER_DIR` picks another Xcode, such as one that adds iPhone Duo. Explore approves the app's URL scheme on it, so links open without iOS asking "Open in …?", and checks a foldable's pose by the shape of its lit display.
- **Android:** an emulator of the configured device profile (such as `pixel_7`), from the newest Google APIs system image installed for this machine (`arm64-v8a` on Apple silicon), in a private AVD folder. The APK must ship native libraries for that ABI; a universal build does. It needs the SDK's emulator, platform-tools and cmdline-tools, with `ANDROID_HOME` set.
`explore:binary --simulator local` starts one the same way for the build it explores, needs no EAS login, and opens the report in the local Viewer (`--upload` hosts it).
For a review, builds still run on EAS. The app is repacked with the route observer on your machine as well, so it is never uploaded; on Android that needs the SDK's build-tools and a JDK. `capture.repack: eas` (or `--repack eas`) keeps the repack in a hosted EAS job. `doctor --simulator local` checks that Xcode and the Android SDK can start each device, and that Android can be repacked locally.
With `--controller argent`, Explore installs Argent's tool-server on first use with `npm ci` from a lockfile Explore ships, so every dependency is pinned (about 160 MB, in the controller cache), and starts one per device. The host switches the appearance, so a local Argent capture records every appearance the config asks for. Reports record where they were captured, and a baseline is reused only by a review captured the same way.
A foldable folds before the app first opens (`pose` on a [target](#targets)); with agent-device on a local simulator it folds just after, since agent-device folds only inside a session. With Argent, an opened iPhone Duo is captured upright, in landscape. After a fold, Argent's reader can stay on the panel that went dark, so Explore checks that the lit panel is read. If it isn't, Explore restarts the tool-server on a local simulator. On EAS Simulator, where the tool-server is the session's, it resets Argent's device helpers, then restarts SpringBoard and folds again. On EAS Simulator, an opened iPhone Duo usually needs that SpringBoard restart, which adds about a minute.
Each capture records what it starts on your Mac (simulators, emulators, controller daemons, tool-servers) and removes it when it ends. If a review or a local `explore:binary` run is stopped hard, the next local one stops what it left running; nothing Explore did not record is touched.
</details>
<details>
<summary><strong>Keep your setup current</strong></summary>
@@ -250,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:review --base v1.3.0 --head v1.4.0 --scope all --upload`, with your `eas login`. `npx @expo/explore reports` lists the runs you have kept.
- **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>
@@ -287,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.
- The run summary links each platform's report (**Open** and **zip**, like a PR comment) and, with hosting, the hosted report.
- `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, 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>
@@ -324,51 +478,12 @@ If the sign-in can't be typed (one-time codes, email links, Sign in with Apple o
| Needs data to show a screen | A test account that has it, and a hint saying where ("open the first project") |
| Asks for a permission | Explore denies it. Allow it by hand on a session, then run `explore:session` |
| Has a paywall | An account that already has the entitlement; purchase buttons are never tapped |
| Has a safe button that looks destructive | `--allow-destructive "Clear cache"` |
| Has a safe button that looks destructive | `--allow-destructive "Reset filters"` |
| Is large | [Raise the budgets](#options) (15 minutes, 40 screens, 150 actions by default) and use `--hints` to set priorities |
When a run stops early, `gap:list --dir <output>` says what blocked it.
## What you get
### A comment on every PR
The report links, a row per platform, and the added, removed and modified screens.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-pr-comment-dark.png">
<img 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">
</picture>
### Compare
Each changed screen before and after, with the changed regions outlined.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-compare-dark.png">
<img alt="The Compare view with the euxy Patterns screen's before and after captures side by side: each pattern row's tempo moved out of the subtitle into its own column on the right, the changed subtitles outlined in both" src="docs/screenshots/readme-compare-light.png">
</picture>
### Screens
Every capture, in a section per route folder, with a route tree whose folders fold away and a **Changed** / **All** filter.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-screens-dark.png">
<img alt="The Screens view of a euxy review: a foldable route tree on the left with Changed and All above it, and the screens in sections named after their app/ folder (Launch, Sequencer, Settings, Patterns) with each folder path beneath, the new About screen marked Added, Activity Log and Settings marked Modified, and the Sequencer marked No visible change" src="docs/screenshots/readme-screens-light.png">
</picture>
### Ask an agent about it
Paste this into Claude Code, Codex, Cursor, or any tool that can fetch a URL. In the Viewer, **Hand off to AI** fills it in for you:
```text
Review the visual changes in this PR. Expo Explore report: <report link>
Fetch the link first. It explains the report's JSON API. Go through the changed screens,
compare the before and after screenshots, and tell me which changes look intended and
which look like regressions. For each regression, name the source file to fix.
```
## Additional information
<details>
<summary><strong>Terms in the report</strong></summary>
@@ -389,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`.
- Multi-platform reports take `?platform=ios|android`. Expired links 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}'
@@ -397,18 +512,33 @@ curl -s "$LINK/api/v1/screens?status=modified" | jq '.items[] | {route, status,
</details>
## Additional information
<details>
<summary><strong>How it works</strong></summary>
1. The review workflow runs on open, non-draft PRs from the repository whose author has write access. Bots such as Devin go under `ci.trustedAuthors` in `.expo-explore/config.yaml`.
2. Explore reads the diff and your router source to pick the affected screens.
3. It builds both revisions and captures each screen on EAS Simulator, reusing a baseline of the base commit when one exists.
4. It compares the captures. A screen with a source change is **Modified** if its captures differ.
5. It uploads the report to GitHub Actions and posts a PR comment.
```mermaid
sequenceDiagram
autonumber
participant PR as Pull request
participant GA as GitHub Actions
participant B as EAS Build
participant S as EAS Simulator
PR->>GA: opened or updated
GA->>GA: read the diff and router source, pick the affected screens
GA->>B: build base and head
Note over B: reuses a build with the same native fingerprint
B-->>GA: simulator builds
GA->>S: capture each affected screen, in each appearance
Note over S: the base reuses its baseline when one exists
S-->>GA: screenshots
GA->>GA: compare the captures, outline the changed regions
GA->>PR: upload the report, comment with its links
```
The same review runs for any two commits without a PR ([`explore-compare.yml`](#compare-any-two-commits), linking the report from the run summary) and on your machine (`capture:review`, [above](#review-a-change-before-you-push-it)). The workflows' logic lives in `expo-explore ci:*` commands, so a fix reaches CI with the `@expo/explore` version the workflows pin.
- The review workflow runs on open, non-draft PRs from the repository whose author has write access. Bots such as Devin go under `ci.trustedAuthors` in `.expo-explore/config.yaml`.
- A screen with a source change is **Modified** if its captures differ.
- If EAS fails to start a session, Explore starts a new one, up to five times within 30 minutes. On your machine, a local simulator can stand in for EAS Simulator.
The same review runs for any two commits without a PR ([`explore-compare.yml`](#compare-any-two-commits), linking the report from the run summary) and on your machine (`capture`, [above](#quick-start)). The workflows' logic lives in `expo-explore ci:*` commands, so a fix reaches CI with the `@expo/explore` version the workflows pin.
Reports and baselines are kept for 30 days and diagnostics for 7. Hosted deployments are never deleted automatically; see [report access](docs/private-review.md).
@@ -417,12 +547,15 @@ Reports and baselines are kept for 30 days and diagnostics for 7. Hosted deploym
<details>
<summary><strong>Known limitations</strong></summary>
- Android capture has had less use than iOS. The first Android device is `pixel_7`.
- Android capture has had less use than iOS. The default Android device is `pixel_7`.
- PRs from forks are not reviewed.
- Each route gets one capture per appearance (light and dark with `capture.appearance: auto`). Other states, such as modals, are planned.
- Each route gets one capture per appearance (`capture.appearance: auto`, the default, captures light and dark when the app's `userInterfaceStyle` is `automatic`). Other states, such as modals, are planned.
- The launch is captured once per appearance and compared like any screen. The comment says how long the splash stayed as it first appeared, when it first changed (a native launch screen handing over to an app-drawn one, an animation starting on it), and when the first screen settled. `capture.launch: video` adds a recording; a launch too fast to observe is reported as "no splash observed".
- On Android the splash usually shows only in the recording, which needs `ffmpeg`. The generated workflows install it.
- Hosted acceptance of agent mode with an API key is incomplete.
- With `capture.controller: argent` on an Android EAS Simulator session, each capture records one appearance (see [device controller](#controller)).
- A local simulator runs only on your machine; the CI workflows capture on EAS Simulator.
- `explore:session` explores EAS Simulator sessions only.
</details>
@@ -447,7 +580,7 @@ npm test
- `npm test` rebuilds the CLI and the Viewer first, because the node tests run the compiled `dist/`. After one `npm run build`, `npm run test:node` skips the rebuild.
- The agent runtimes and `eas-cli` are optional dependencies that only capture needs. Do not install with `--omit=optional`, which also drops esbuild's platform package.
- To release, bump `version` in `package.json` and merge to main. The [publish workflow](.github/workflows/publish.yml) publishes any version npm does not have yet.
- To release, bump `version` in `package.json` and merge to main. The [publish workflow](.github/workflows/publish.yml) publishes any version npm does not have yet. A prerelease version such as `0.20.0-next.0` goes to the `next` tag, so `latest` stays on the last release.
```sh
npx playwright install chromium
+7 -3
View File
@@ -157,6 +157,10 @@ runs:
EXPO_TOKEN: ${{ inputs.expo_token }}
run: |
set -euo pipefail
if [[ ! -e "$OUTPUT/head-session" && ! -L "$OUTPUT/head-session" && ! -e "$OUTPUT/base-session" && ! -L "$OUTPUT/base-session" ]]; then exit 0; fi
node "$TOOLS/scripts/cleanup-ci-sessions.mjs" --eas "$TOOLS/node_modules/.bin/eas" \
--session-file "$OUTPUT/head-session" --session-file "$OUTPUT/base-session"
# A side that captures an appearance in a session of its own records it as <side>-session-<scheme>.
files=()
for name in head-session base-session head-session-light head-session-dark base-session-light base-session-dark; do
if [[ -e "$OUTPUT/$name" || -L "$OUTPUT/$name" ]]; then files+=(--session-file "$OUTPUT/$name"); fi
done
if (( ${#files[@]} == 0 )); then exit 0; fi
node "$TOOLS/scripts/cleanup-ci-sessions.mjs" --eas "$TOOLS/node_modules/.bin/eas" "${files[@]}"
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,8 @@
{
"name": "expo-explore-argent-tool-server",
"private": true,
"description": "Argent's tool-server at the release Explore pins, with every dependency locked: installed with npm ci for local simulators.",
"dependencies": {
"@swmansion/argent": "0.29.0"
}
}
+8 -8
View File
@@ -12,22 +12,22 @@ The Viewer reads the ZIP supplied by the reviewer; it has no hosted artifact dow
## Hosted previews
Hosted previews are off by default. When `report.preview.hosting: eas` is set, the review workflow's `deploy` job uploads each run's reports (one per captured platform) to an [EAS Hosting](https://docs.expo.dev/eas/hosting/introduction/) deployment in your Expo account, and the comment shows an **Explore report** link that opens it directly, in place of the **Open** drop page. The GitHub artifact and **zip** stay as they are.
Hosted previews are off by default. When `report.preview.hosting: eas` is set, the review workflow's `deploy` job uploads each run's reports (one per captured platform or target) to an [EAS Hosting](https://docs.expo.dev/eas/hosting/introduction/) deployment in your Expo account, and the comment shows an **Explore report** link that opens it directly, in place of the **Open** drop page. The GitHub artifact and **zip** stay as they are.
**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.** One deployment holds every platform's report. The link opens the primary platform's report (`?platform=ios` or `?platform=android` selects one); the Viewer's platform menu lists the others from `/p/<token>/reports.json`, which names each platform, its device, and its 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 streams it to the browser. 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.
- *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.
+9 -3
View File
@@ -8,7 +8,7 @@ The same workflow supports Expo Router and React Navigation applications on iOS.
Expo Router inventory comes from route files and layouts. React Navigation inventory comes from statically readable JSX or object screen registrations and navigator hierarchies. Linking determines entry paths independently of route discovery. Unsupported computed declarations and unresolved paths remain diagnostics; analysis does not execute the app to guess their values.
`changes` starts with the exact two-dot Git diff and dependency impact, then adds, independently on each revision, the routes one navigation step before or after an affected route. Layout or screen guards do not count as steps. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. `all` selects the full inventory. Source context does not imply a visible modification.
`changes` starts with the exact two-dot Git diff and dependency impact (a JavaScript or TypeScript file whose two revisions parse to the same syntax tree, differing only in comments or in whitespace the compiler and JSX transform drop, reaches no screen; a comment a compiler reads, such as `@jsx` or `#__PURE__`, still counts), then adds, independently on each revision, the routes one navigation step before or after an affected route. Layout or screen guards do not count as steps. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. `all` selects the full inventory. Source context does not imply a visible modification.
Before app build or simulator allocation, CI regenerates the canonical plan in fresh processes and compares bytes. A mismatch fails with diagnostic plans and their diff. Run identities, timestamps, absolute checkout paths, screenshots, and cache hits are excluded from planning data. Tests also vary enumeration order and checkout location.
@@ -73,7 +73,7 @@ Every selected target on both revisions must have a screenshot of its verified d
### Automatic destination verification
CI repacks both Base and Head with the same read-only navigation observer, including when EAS creates a fresh native build. By default the repack is a hosted EAS `repack` workflow job: the tracked files of the clean checkout are staged in a temporary copy together with the generated observer, Metro override and a one-job workflow, uploaded with `eas workflow:run --wait`, and the job's build ID starts the simulator session. `capture.repack: local` runs `@expo/repack-app` on the runner and uploads the result with `eas upload` instead. Generated files never land in the source checkout. The application does not need to import a marker or maintain a screen manifest.
CI repacks both Base and Head with the same read-only navigation observer, including when EAS creates a fresh native build. By default the repack is a hosted EAS `repack` workflow job: the tracked files of the clean checkout are staged in a temporary copy together with the generated observer, Metro override and a one-job workflow, and run with `eas workflow:run --wait`; the repacked app is downloaded and installed into the simulator session, which started while the job ran. `capture.repack: local` runs `@expo/repack-app` on the runner instead, and its app is installed without being uploaded. With `capture.simulator: local` the repack runs on that machine unless `capture.repack: eas` says otherwise. Generated files never land in the source checkout. The application does not need to import a marker or maintain a screen manifest.
The observer adapter requires **Expo SDK 57 or newer** and an installed Expo CLI with Metro configuration override support. It accepts **Expo Router 57 or newer**, or **React Navigation core 6 or newer**. Older packages fail instrumentation explicitly.
@@ -103,7 +103,9 @@ exploration:
capture:
maxMinutes: 30
maxActions: 500
repack: eas # eas (hosted workflow job) | local (repack-app on the runner)
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
repack: eas # eas (hosted workflow job; the default on EAS Simulator) | local (repack-app on the runner; the default with simulator: local)
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
reset: root-link # root-link (open the app's root link and let it settle before every route link, default) | none (each link opens from whatever the previous route left on screen)
@@ -179,6 +181,10 @@ imported source changed), `app-wide` (only app-wide inputs such as dependencies,
| Not compared | No comparison was performed, including for a screen whose source changed. Not counted as a change: Explore reports what the captures show, not what the code might do. Earlier versions listed these as Source-affected |
A difference that rounds to 0.00% of pixels is rendering noise and counts as no difference.
A changed region whose content only moved (a layout that grew by a device pixel, a sheet that is taller) carries
`shift`, how far it moved in screenshot pixels, and `allRegionsMoved: true` says every region CI found moved (it
publishes the largest eight); the Viewer labels each outline with its move. A shift does not change the verdict: a
moved screen is still Modified.
Accessibility only is how readers present a `modified` verdict whose visual verdict is `unchanged`; the contract has no
separate status for it, so reports from earlier versions show it too. The accessibility tree can include content outside
the screenshot (rows below the fold, elements under a sheet), so such a change may still be visible on a device.
+34 -5
View File
@@ -101,12 +101,17 @@ navigation:
# entry: src/navigation/RootNavigator.tsx
device:
name: iPhone 17 # Android: an AVD profile id such as pixel_7
# pose: open # a foldable (iPhone Duo): closed (the outer display, how a session starts) | half-open | open (the inner display)
exploration:
scope: changes # changes | all
capture:
# controller: agent-device # agent-device (default) | argent (one appearance per capture on Android EAS Simulator until Argent can switch it; --controller overrides it for one run)
# simulator: eas # eas (EAS Simulator, default) | local (a simulator or emulator Explore starts on this machine with Xcode or the Android SDK; --simulator overrides it for one run)
maxMinutes: 30
maxActions: 500
repack: eas # eas (hosted EAS workflow job, default) | local (repack-app + eas upload on the runner)
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
repack: eas # eas (hosted EAS workflow job, the default on EAS Simulator) | local (repack-app on the runner, the default with simulator: local; --repack overrides it for one run)
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
reset: root-link # root-link (open the app's root link and let it settle before every route link, default) | none (each link opens from whatever the previous route left on screen)
@@ -129,6 +134,20 @@ platforms:
Commands that capture or publish (`source:verify`, `capture:review`, `capture:baseline`, `ci:report`, `ci:publish`) take `--platform ios|android`; with one configured platform it is optional, with two it is required (`PLATFORM_REQUIRED`). `expo-explore config:platforms` prints the configured list as JSON, which the workflows use as their matrix. Artifacts carry the platform (`explore-capture-<run>-<attempt>-android`, `explore-baseline-<sha>-ios`); an iOS job still reuses an older unsuffixed baseline. The PR comment has one section per platform, and a hosted preview serves both reports from one link.
### Several devices (targets)
`targets` names each capture instead of `platforms`, so one platform can have several devices or poses. Each target is captured, published and commented on as its own report, in config order:
```yaml
targets:
iphone: { platform: ios, device: iPhone 17 }
duo-closed: { platform: ios, device: iPhone Duo, pose: closed }
duo-open: { platform: ios, device: iPhone Duo, pose: open, label: "iPhone Duo (open)" }
android: { platform: android, device: pixel_7, bundleId: com.example.myapp, easProfile: explore-android }
```
A target's id (up to 32 lowercase letters, digits and dashes, starting with a letter; not `base`, `head`, `report` or `install-…`; at most 8 per config) takes the place of the platform everywhere a capture is named: `--target duo-open`, `explore-capture-<run>-<attempt>-duo-open`, `explore-baseline-<sha>-duo-open`. `expo-explore config:targets` prints the list the workflows use as their matrix. Fields a target leaves out come from `app` and `device`; a target of another platform than `app.platform` sets its own `bundleId` and `easProfile`. A config with `platforms` has one target per platform, named `ios` and `android`, so its names do not change. `--platform` still selects a target when only one has that platform.
Use the actual bundle identifier, scheme, profile, and available simulator device name. `scheme` is optional when static app configuration supplies it. `navigation.entry` resolves ambiguous entry modules; it does not list screens.
Do not add a surface inventory, required fixture routes, runtime probe, configuration version, or Viewer URL. The analyzer discovers screens from source. Application data, time, and network remain live.
@@ -198,13 +217,13 @@ exploration:
- /c/[channel]
```
An excluded route stays in the map and in its neighbors' navigation context, but neither revision captures it, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the map and the screen counts, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
Capture handles iOS's confirmation to open a link in the expected app. After a form submits a password, iOS may offer to save or update it depending on the simulator's AutoFill state; capture declines that prompt with Not Now in both modes, never stores the credential, and records each decision in `capture-diagnostics/system-prompts.jsonl`. Do not script that tap in setup. Include required system-alert handling in setup or app instructions; Explore does not automatically grant application permissions.
### Stable captures (optional)
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. When both builds capture light and dark, text that differs between each build's own two captures (a clock, a relative date, a random name) is reported as runtime state, never as the change that makes a screen Modified; text that only follows the appearance, or a word beside it that changed, is still a change. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
### Agent usage and reuse
@@ -269,7 +288,7 @@ The provider selects the runtime that owns the navigation loop:
| `anthropic` | Claude Code through `@anthropic-ai/claude-agent-sdk` 0.3.285 and its platform-native package | `ANTHROPIC_API_KEY` |
| `openai` | Codex app-server from `@openai/codex` 0.159.2 and its platform-native package | `OPENAI_API_KEY` |
Both runtimes use Explore's device tools to operate the existing EAS Simulator through official `agent-device` 0.21.15. The runtime and native binaries come from the pinned tools installation. CI does not use the development-only `node_modules/.bin/claude` executable or an interactive subscription login.
Both runtimes use Explore's device tools to operate the existing EAS Simulator through official `agent-device` 0.21.29-nightly.20261018.74. The runtime and native binaries come from the pinned tools installation. CI does not use the development-only `node_modules/.bin/claude` executable or an interactive subscription login.
Create and commit the nonempty English prose file named by `agent.instructions`. The shared setup skill authors it from source and asks for missing test data or environment inputs. Describe how to reach the app's screens, necessary prerequisites, the representative state to use on both revisions, readiness signals, and actions to avoid. This file guides the runtime agent; it is not a list of mandatory YAML steps or a second screen inventory.
@@ -343,7 +362,17 @@ 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:
```yaml
report:
comment:
map: true # default false
```
The map leaves out screens whose source changed but whose captures match, and it is skipped when more than 30 routes changed or when the comment would be over GitHub's size limit.
PR review links always use [explore-preview.expo.app](https://explore-preview.expo.app/); no viewer-origin variable is needed or accepted by the CI publisher. Reports stay in GitHub Actions: the comment's **zip** link fetches the `explore-review-<run>-<attempt>.zip` artifact (GitHub asks for sign-in and repository read access), and the page that **Open** opens takes that ZIP by drag-and-drop or **Choose file**. Nothing is enabled per repository on Expo's side. See [report access](private-review.md).
Binary file not shown.

Before

Width:  |  Height:  |  Size: 452 KiB

+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /patterns screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(1,4,9,0.6)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#151B23"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#151B23" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCANqAZIDASIAAhEBAxEB/8QAHAABAAICAwEAAAAAAAAAAAAAAAMFBAYBAgcI/8QAWBAAAQMDAQQECwQHBAUKBQQDAQACAwQFERIGEyExFEFR0QcVIjJSU2GBkZKTNFRxsQgjM2OhouEWQmLBJHJ1gtIYNkNVVrKz1OLwFzdzlJUmNThEg8Px/8QAGAEBAQEBAQAAAAAAAAAAAAAAAAEDAgT/xAAdEQEBAAMBAAMBAAAAAAAAAAAAEQECAwQSMUFR/9oADAMBAAIRAxEAPwD5UREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBFs2wdn2aut0kftXeZrbbaZgkdHTRa6ircXACKIHgHHOdTuAAXptz8CuzVB4X9sLRPUXCHZPZS3suVSWva6olbuI37priManOecHHIY9qDwxF6dtdsfspd/B5Dt9sZT19sp4Lj4suNurZxPuXFupkrHhoJaRwII5nhy449DsjsFs/tZc6faXa2K8Wm3UQqIDZ8g3KcgEQNeQQzBJy49nUeQecovVdtdiNjpdktlNsrGa/Z2gvVdJQ1NLXvNTuGscA6eNzWhz2AZyMZzwCu6fYTwZbVWvaaLZ2j2lo4rHbpa2n2jrZR0atdHgBroyxujWT5IB1ezIwg8PREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEReh+C3YDZbaenr7xthtdDZLXb3sjdSwDXW1TneaImYPPB4gO4jl1oPPEX0xUeDTwVMt5kqvB34VrbQacm7vpc7tvrHMy4hvXnR7l414T9iLNsXdaQbP7U0O0druEHSaeaA4ljZnGmVv913A+3gcgckGmIvQPA/4M5PCZtDFao5IY3SF+XzaiyJjG5c4hpBceLQACOJ4ngve/wDkWUn/AGlt3/4qf/ziD5ERfXf/ACLKT/tJbv8A8VP/AOcXgHhU8GtT4P8AaOstGGSvpHfrHQajG5hYx7ZAHZLQQ8Agk4IPEhBoaIiAiIgIiICIiAiIgIiIJaRwZVQucQAHtJJ6uK+jL54QNlLp4afCLQTXyljsW1tqit8F2YdcMM7aeIMc4j+4HBwJ6j2DJXzciD17aipsuwXgiOwlNtBar/d7rdm3GsltMxmp6eBjNLGCTABeSM+zjnqzjbJbPeC7a3wkSOddp9ntkKWGObc3ioa2eqeAAYg9uQ0F2SSMkDlgnh5UiD2HwsNprxe7Vc7xtlsxWWKKojoIbTs1O6R1so+JJjY6NoOA3ieZcR1YxttnqLBsfZ7xS3vwmWLarYQ0M8dssYeZqt0jsmI7osG4e0k+UCME9XV84ogIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgszQ2/pMEfTsxvYS93onsURpaPo1TJ0r9ZHIWxtx57e1YKIMuvp6aDddGqN9qbl3+ErI2a2iuGyV+ob7aZWRV1DKJYXPYHgEdoPAjGQqxEH0HV+HF9u2Lt+1Nr8I21VXttUTaaq01W7dQMx553OjS1mCNJack9mDjwKsq5q+rnq6l+ueeR0sjsAanOOScDgOJ6lCiD1DwD+Eel8HG1ENzqoRPGzeMki3jY3Pje0AlrnEN1AtacOIBGeIX0t/yuNiP+rLz9eg/80vhlEH3N/wArjYj/AKsvP16D/wA0vmbwzeEwbb7WXC7UDRTMrf1Zia9shZCGRsDXOHAuOgk6SQMgZPFeZIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIilhpZ6jO6ie/HMgcB+JQRIsw2qrAzu2fUb3rHlp5YDiSNzOzI5oI0REBERARSw0s9RndRPfjmQOA/Eqc2qLine truncated

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 452 KiB

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

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 870 KiB

+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /about and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.33%{opacity:0;transform:scale(.92)}8.08%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}4.00%{opacity:0;transform:scale(.92)}7.75%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}4.67%{opacity:0;transform:scale(.92)}8.42%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}6.08%{opacity:0;transform:scale(.92)}9.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}6.41%{opacity:0;transform:scale(.92)}10.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}6.75%{opacity:0;transform:scale(.92)}10.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}7.08%{opacity:0;transform:scale(.92)}10.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}3.66%{opacity:0;transform:scale(.92)}7.41%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}7.41%{opacity:0;transform:scale(.92)}11.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}7.75%{opacity:0;transform:scale(.92)}11.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}8.08%{opacity:0;transform:scale(.92)}11.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}8.42%{opacity:0;transform:scale(.92)}12.17%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}10.83%{clip-path:inset(0 0 100% 0)}21.67%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(978.5px,714.0px)}25.83%{opacity:0;transform:translate(978.5px,714.0px)}27.50%{opacity:1;transform:translate(978.5px,714.0px)}35.83%{opacity:1;transform:translate(718.5px,505.2px)}36.67%{opacity:1;transform:translate(718.5px,505.2px) scale(.82)}37.92%{opacity:1;transform:translate(718.5px,505.2px)}45.83%{opacity:0;transform:translate(718.5px,505.2px)}100.00%{opacity:0;transform:translate(718.5px,505.2px)}}.sel{animation:sel 12s ease-out infinite}@keyframes sel{0.00%{opacity:0}36.67%{opacity:0}39.17%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}37.08%{opacity:0;transform:translateX(48px)}42.08%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{opacity:0;animation:cover 12s linear infinite}@keyframes cover{0.00%{opacity:1}1.67%{opacity:0}94.17%{opacity:0}100.00%{opacity:1}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><image id="empty" width="1376" height="774" href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAALine truncated

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 832 KiB

+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /about and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.33%{opacity:0;transform:scale(.92)}8.08%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}4.00%{opacity:0;transform:scale(.92)}7.75%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}4.67%{opacity:0;transform:scale(.92)}8.42%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}6.08%{opacity:0;transform:scale(.92)}9.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}6.41%{opacity:0;transform:scale(.92)}10.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}6.75%{opacity:0;transform:scale(.92)}10.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}7.08%{opacity:0;transform:scale(.92)}10.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}3.66%{opacity:0;transform:scale(.92)}7.41%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}7.41%{opacity:0;transform:scale(.92)}11.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}7.75%{opacity:0;transform:scale(.92)}11.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}8.08%{opacity:0;transform:scale(.92)}11.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}8.42%{opacity:0;transform:scale(.92)}12.17%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}10.83%{clip-path:inset(0 0 100% 0)}21.67%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(978.5px,714.0px)}25.83%{opacity:0;transform:translate(978.5px,714.0px)}27.50%{opacity:1;transform:translate(978.5px,714.0px)}35.83%{opacity:1;transform:translate(718.5px,505.2px)}36.67%{opacity:1;transform:translate(718.5px,505.2px) scale(.82)}37.92%{opacity:1;transform:translate(718.5px,505.2px)}45.83%{opacity:0;transform:translate(718.5px,505.2px)}100.00%{opacity:0;transform:translate(718.5px,505.2px)}}.sel{animation:sel 12s ease-out infinite}@keyframes sel{0.00%{opacity:0}36.67%{opacity:0}39.17%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}37.08%{opacity:0;transform:translateX(48px)}42.08%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{opacity:0;animation:cover 12s linear infinite}@keyframes cover{0.00%{opacity:1}1.67%{opacity:0}94.17%{opacity:0}100.00%{opacity:1}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><image id="empty" width="1376" height="774" href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAALine truncated

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 151 KiB

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 KiB

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 610 KiB

After

Width:  |  Height:  |  Size: 640 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 606 KiB

After

Width:  |  Height:  |  Size: 642 KiB

+79 -67
View File
@@ -1,18 +1,17 @@
{
"name": "@expo/explore",
"version": "0.19.2",
"version": "0.20.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.19.2",
"version": "0.20.0",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
"@types/node": "^22.19.19",
"@zip.js/zip.js": "2.16.0",
"agent-device": "0.21.15",
"ajv": "^8.17.1",
"pngjs": "7.0.0",
"typescript": "^5.9.3",
@@ -30,6 +29,7 @@
"@types/react-dom": "^19.2.4",
"@vitejs/plugin-react": "^4.7.0",
"@xyflow/react": "^12.11.3",
"agent-device": "0.21.29-nightly.20261018.74",
"babel-plugin-react-compiler": "^1.0.0",
"eslint": "^10.12.0",
"eslint-plugin-react-hooks": "^7.1.1",
@@ -48,7 +48,7 @@
"optionalDependencies": {
"@anthropic-ai/claude-agent-sdk": "0.3.285",
"@openai/codex": "0.159.2",
"eas-cli": "24.4.2"
"eas-cli": "25.2.0"
}
},
"node_modules/@0no-co/graphql.web": {
@@ -1600,15 +1600,15 @@
}
},
"node_modules/@expo/eas-build-job": {
"version": "24.3.0",
"resolved": "https://registry.npmjs.org/@expo/eas-build-job/-/eas-build-job-24.3.0.tgz",
"integrity": "sha512-CyDUm8B8pSH38XZg8QzdPaxukThspSWfJ4ccUBCzBLs/qL6SknaLVswD3OTxNQmirrZUyo72DfzupSxHDZOeyw==",
"version": "25.2.0",
"resolved": "https://registry.npmjs.org/@expo/eas-build-job/-/eas-build-job-25.2.0.tgz",
"integrity": "sha512-RUp8sZniYWCiLQLGJrnMeAx8094BoejS6lm7EdSUs4nKkm6TtxyydRutGtoHlvBpvXOw3+OgimemqXUpmU5R8Q==",
"license": "MIT",
"optional": true,
"dependencies": {
"@expo/logger": "24.0.0",
"@expo/logger": "25.2.0",
"@expo/results": "1.0.0",
"@expo/turtle-spawn": "24.0.0",
"@expo/turtle-spawn": "25.2.0",
"joi": "^17.13.1",
"semver": "^7.6.2",
"zod": "^4.3.5"
@@ -1642,14 +1642,14 @@
}
},
"node_modules/@expo/eas-json": {
"version": "24.3.0",
"resolved": "https://registry.npmjs.org/@expo/eas-json/-/eas-json-24.3.0.tgz",
"integrity": "sha512-FIdvHmGeRFB0BoA4+aicn/tnpUUTSre4cCrN/hk6xkHOlpbjDVyl2tFaEe0RpiI1itrQ2ze/KTUYqdyecfHv0Q==",
"version": "25.2.0",
"resolved": "https://registry.npmjs.org/@expo/eas-json/-/eas-json-25.2.0.tgz",
"integrity": "sha512-ZikfZLZHadl5gzq5UZ7qWMTWFZNAO4K6NJC6iF8JmVh3kR1Blv+Zo2AolC0CYzSYOCyaRCZx+v2ZlJZeiVCf8w==",
"license": "MIT",
"optional": true,
"dependencies": {
"@babel/code-frame": "7.23.5",
"@expo/eas-build-job": "24.3.0",
"@expo/eas-build-job": "25.2.0",
"chalk": "4.1.2",
"env-string": "1.0.1",
"fs-extra": "11.2.0",
@@ -1836,6 +1836,19 @@
"node": ">=6"
}
},
"node_modules/@expo/experimentation": {
"version": "0.0.5",
"resolved": "https://registry.npmjs.org/@expo/experimentation/-/experimentation-0.0.5.tgz",
"integrity": "sha512-eQtx5f7tUDZLeq2EXYOkBX+KivYa73CjUMkrEFh5sNMOpCWynisbdSiaSdSLHALWzYKz3uc0QlgWTz3V/6JESQ==",
"license": "MIT",
"optional": true,
"dependencies": {
"nullthrows": "^1.1.1"
},
"engines": {
"node": ">=16"
}
},
"node_modules/@expo/image-utils": {
"version": "0.7.6",
"resolved": "https://registry.npmjs.org/@expo/image-utils/-/image-utils-0.7.6.tgz",
@@ -1900,9 +1913,9 @@
}
},
"node_modules/@expo/logger": {
"version": "24.0.0",
"resolved": "https://registry.npmjs.org/@expo/logger/-/logger-24.0.0.tgz",
"integrity": "sha512-LezHQbZbqa7papq2ciCmwEjz4gUxe3b4oIdl3IU/wp3WGy+zQ4s+xKdDuUCbDLVkbqABBgVNqFav4ucXo1Gh/w==",
"version": "25.2.0",
"resolved": "https://registry.npmjs.org/@expo/logger/-/logger-25.2.0.tgz",
"integrity": "sha512-gtf/Lk9zE3k2wfEalAwioxDwvse69A2e/OhoDT7IRjlorRgcNJghr6V4FvDAZckQUkFR1IEHz2+FXvLKf9kjgg==",
"license": "BUSL-1.1",
"optional": true,
"dependencies": {
@@ -2592,14 +2605,14 @@
}
},
"node_modules/@expo/steps": {
"version": "24.3.0",
"resolved": "https://registry.npmjs.org/@expo/steps/-/steps-24.3.0.tgz",
"integrity": "sha512-y0zuyUaivXiq1l7D0x9xosUbhtknDwQ4v669smGslshEYXZAuxYQJo0L6H0MRuRsaZn6N8zvfICBM+4n/n4Xeg==",
"version": "25.2.0",
"resolved": "https://registry.npmjs.org/@expo/steps/-/steps-25.2.0.tgz",
"integrity": "sha512-KKM8STsb0dAdI6lyN7WHfczvDdQlCx+vF4unq/qFk6PZgZMvE9+IT8mh25fqgwxNcpR7Ti+xFCip2hhvpK2yng==",
"license": "BUSL-1.1",
"optional": true,
"dependencies": {
"@expo/eas-build-job": "24.3.0",
"@expo/logger": "24.0.0",
"@expo/eas-build-job": "25.2.0",
"@expo/logger": "25.2.0",
"@expo/spawn-async": "^1.7.2",
"arg": "^5.0.2",
"fast-glob": "^3.3.2",
@@ -2637,13 +2650,13 @@
"optional": true
},
"node_modules/@expo/turtle-spawn": {
"version": "24.0.0",
"resolved": "https://registry.npmjs.org/@expo/turtle-spawn/-/turtle-spawn-24.0.0.tgz",
"integrity": "sha512-HtumnPY7iVCc6vDmSmjsUEvhIPnmwVzpQ2aNPxAX+G0M2Zst88DAlItOd7mZUPSNNO8qp3izDPtqmI0fdLYPng==",
"version": "25.2.0",
"resolved": "https://registry.npmjs.org/@expo/turtle-spawn/-/turtle-spawn-25.2.0.tgz",
"integrity": "sha512-1Lor7/+4T1JEb6kqu0dHstD+xOWTGbwA7QqWTBKYx4qtgtJ4Wbor17bzlp87KENAYDeWuX+7VHKxT66170m9wg==",
"license": "BUSL-1.1",
"optional": true,
"dependencies": {
"@expo/logger": "24.0.0",
"@expo/logger": "25.2.0",
"@expo/spawn-async": "^1.7.2"
}
},
@@ -4556,6 +4569,16 @@
"node": ">=0.4.0"
}
},
"node_modules/agent-base": {
"version": "7.1.4",
"resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz",
"integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==",
"license": "MIT",
"optional": true,
"engines": {
"node": ">= 14"
}
},
"node_modules/agent-cli-detector": {
"version": "0.1.7",
"resolved": "https://registry.npmjs.org/agent-cli-detector/-/agent-cli-detector-0.1.7.tgz",
@@ -4570,9 +4593,10 @@
}
},
"node_modules/agent-device": {
"version": "0.21.15",
"resolved": "https://registry.npmjs.org/agent-device/-/agent-device-0.21.15.tgz",
"integrity": "sha512-Om1j6oNJkeKlkk8lBM+0V9bKwpxUXLMf/PDDSvAt3RFquBRqAiM58J81E0rvPQNxs6GCjhABYpwVvIAXptxjjA==",
"version": "0.21.29-nightly.20261018.74",
"resolved": "https://registry.npmjs.org/agent-device/-/agent-device-0.21.29-nightly.20261018.74.tgz",
"integrity": "sha512-7+ajWLr0J+8iLZ9q11ERbj6U14mC20umBK5BQQdw5aERA79yeXc3Ze6KmtvnILnWjEtoVkYQsXQasL8RL6Uatw==",
"dev": true,
"license": "MIT",
"bin": {
"agent-device": "bin/agent-device.mjs"
@@ -5711,9 +5735,9 @@
}
},
"node_modules/eas-cli": {
"version": "24.4.2",
"resolved": "https://registry.npmjs.org/eas-cli/-/eas-cli-24.4.2.tgz",
"integrity": "sha512-7tXqvzZ+4hRBS9p8Voo0PB2Ruapvqc9LLn99ZSw5m2VOQITAxdNhj8PcF+RAV3by7lMGT0oFotP7+/v3FDjpyg==",
"version": "25.2.0",
"resolved": "https://registry.npmjs.org/eas-cli/-/eas-cli-25.2.0.tgz",
"integrity": "sha512-FFA6fSl2bPet9D3Eslupig3icXjyBzAbrsLE5r67wbEbh/CPDZQ+Q4W5TrpRui0uqfF16w58EGsFUQoQ0te0KQ==",
"license": "MIT",
"optional": true,
"dependencies": {
@@ -5721,11 +5745,12 @@
"@expo/code-signing-certificates": "0.0.5",
"@expo/config": "55.0.10",
"@expo/config-plugins": "55.0.7",
"@expo/eas-build-job": "24.3.0",
"@expo/eas-json": "24.3.0",
"@expo/eas-build-job": "25.2.0",
"@expo/eas-json": "25.2.0",
"@expo/env": "^1.0.0",
"@expo/experimentation": "0.0.5",
"@expo/json-file": "8.3.3",
"@expo/logger": "24.0.0",
"@expo/logger": "25.2.0",
"@expo/multipart-body-parser": "2.0.0",
"@expo/osascript": "2.1.4",
"@expo/package-manager": "1.9.10",
@@ -5737,7 +5762,7 @@
"@expo/results": "1.0.0",
"@expo/rudder-sdk-node": "1.1.1",
"@expo/spawn-async": "1.7.2",
"@expo/steps": "24.3.0",
"@expo/steps": "25.2.0",
"@expo/timeago.js": "1.0.0",
"@oclif/core": "^4.8.3",
"@oclif/plugin-autocomplete": "^3.2.40",
@@ -5768,7 +5793,7 @@
"gradle-to-js": "2.0.1",
"graphql": "16.8.1",
"graphql-tag": "2.12.6",
"https-proxy-agent": "5.0.1",
"https-proxy-agent": "7.0.6",
"ignore": "5.3.0",
"indent-string": "4.0.0",
"invariant": "^2.2.2",
@@ -5817,19 +5842,6 @@
"node": "^20.18.3 || >=22.0.0"
}
},
"node_modules/eas-cli/node_modules/agent-base": {
"version": "6.0.2",
"resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz",
"integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==",
"license": "MIT",
"optional": true,
"dependencies": {
"debug": "4"
},
"engines": {
"node": ">= 6.0.0"
}
},
"node_modules/eas-cli/node_modules/ajv": {
"version": "8.11.0",
"resolved": "https://registry.npmjs.org/ajv/-/ajv-8.11.0.tgz",
@@ -5847,20 +5859,6 @@
"url": "https://github.com/sponsors/epoberezkin"
}
},
"node_modules/eas-cli/node_modules/https-proxy-agent": {
"version": "5.0.1",
"resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz",
"integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==",
"license": "MIT",
"optional": true,
"dependencies": {
"agent-base": "6",
"debug": "4"
},
"engines": {
"node": ">= 6"
}
},
"node_modules/eas-cli/node_modules/ignore": {
"version": "5.3.0",
"resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.0.tgz",
@@ -7399,6 +7397,20 @@
"url": "https://opencollective.com/express"
}
},
"node_modules/https-proxy-agent": {
"version": "7.0.6",
"resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz",
"integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==",
"license": "MIT",
"optional": true,
"dependencies": {
"agent-base": "^7.1.2",
"debug": "4"
},
"engines": {
"node": ">= 14"
}
},
"node_modules/hyperlinker": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/hyperlinker/-/hyperlinker-1.0.0.tgz",
@@ -7808,13 +7820,13 @@
}
},
"node_modules/jsep": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/jsep/-/jsep-1.4.0.tgz",
"integrity": "sha512-B7qPcEVE3NVkmSJbaYxvv4cHkVW7DQsZz13pUMrfS8z8Q/BuShN+gcTXrUlPiGqM2/t/EEaI030bpxMqY8gMlw==",
"version": "1.6.0",
"resolved": "https://registry.npmjs.org/jsep/-/jsep-1.6.0.tgz",
"integrity": "sha512-Y8Tr54CX7B5YGAwo7/n8eumidEX3Opx98RyyQVnlHqUaZcPA8uUzL2v1rshr9ypW9Q6hNjfJtg3sL+8kaNE7TA==",
"license": "MIT",
"optional": true,
"engines": {
"node": ">= 10.16.0"
"node": ">= 20.16.0"
}
},
"node_modules/jsesc": {
+5 -4
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.19.2",
"version": "0.20.0",
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
"license": "MIT",
"type": "module",
@@ -9,6 +9,7 @@
},
"files": [
"action.yml",
"controllers/argent-tool-server",
"npm-shrinkwrap.json",
"dist",
"docs",
@@ -49,7 +50,7 @@
"test:node": "node --test test/node/*.test.mjs",
"test:hosting": "npm --prefix viewer-host run typecheck && npm --prefix viewer-host test",
"test:viewer:artifacts": "node --test test/browser/artifact-report.browser.mjs test/browser/artifact-cache.browser.mjs",
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/swipe-outlines.browser.mjs test/browser/split-outlines.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
"test:viewer:e2e": "npm run test:viewer:browser && playwright test",
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p viewer/tsconfig.json --noEmit",
"lint": "eslint .",
@@ -63,7 +64,6 @@
"@expo/repack-app": "0.10.1",
"@types/node": "^22.19.19",
"@zip.js/zip.js": "2.16.0",
"agent-device": "0.21.15",
"ajv": "^8.17.1",
"pngjs": "7.0.0",
"typescript": "^5.9.3",
@@ -73,7 +73,7 @@
"optionalDependencies": {
"@anthropic-ai/claude-agent-sdk": "0.3.285",
"@openai/codex": "0.159.2",
"eas-cli": "24.4.2"
"eas-cli": "25.2.0"
},
"devDependencies": {
"@anthropic-ai/claude-code": "2.1.285",
@@ -83,6 +83,7 @@
"@types/react-dom": "^19.2.4",
"@vitejs/plugin-react": "^4.7.0",
"@xyflow/react": "^12.11.3",
"agent-device": "0.21.29-nightly.20261018.74",
"babel-plugin-react-compiler": "^1.0.0",
"eslint": "^10.12.0",
"eslint-plugin-react-hooks": "^7.1.1",
+12
View File
@@ -68,6 +68,16 @@
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z$"
},
"platform": { "enum": ["ios", "android"] },
"runTarget": {
"type": "object",
"additionalProperties": false,
"required": ["id", "platform", "label"],
"properties": {
"id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,31}$" },
"platform": { "$ref": "#/$defs/platform" },
"label": { "type": "string", "minLength": 1 }
}
},
"controller": { "enum": ["agent-device", "argent"] },
"actionKind": {
"enum": ["press", "fill", "swipe", "back", "dismiss", "deep-link", "key", "other"]
@@ -162,6 +172,8 @@
"name": { "type": "string", "minLength": 1 },
"platform": { "$ref": "#/$defs/platform" },
"platforms": { "type": "array", "items": { "$ref": "#/$defs/platform" }, "minItems": 2, "uniqueItems": true },
"target": { "$ref": "#/$defs/runTarget" },
"targets": { "type": "array", "items": { "$ref": "#/$defs/runTarget" }, "minItems": 2, "maxItems": 8 },
"controller": { "$ref": "#/$defs/controller" },
"bundleId": { "type": "string" },
"deviceId": { "type": "string" },
+2 -1
View File
@@ -10,7 +10,8 @@ const SESSION_ID = /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/;
/** Stop only exact sessions whose ownership the capture coordinator already verified. */
export async function cleanupCiSessions({ sessionFiles, easCommand, environment = process.env, runCommand = spawnSync }) {
if (!Array.isArray(sessionFiles) || sessionFiles.length > 3) throw new Error('Provide at most three explicit session handoff files.');
// head, base and baseline, each with a session per appearance pass (light, dark) beside its own.
if (!Array.isArray(sessionFiles) || sessionFiles.length > 9) throw new Error('Provide at most nine explicit session handoff files.');
const temporary = await realpath(environment.RUNNER_TEMP || tmpdir());
const result = { stopped: [], failures: [] };
let project;
+6 -5
View File
@@ -3,13 +3,14 @@
//
// node scripts/deploy-viewer-preview.mjs --fixtures DIR --alias pr-123 --project explore-viewer-pr [--owner expo-public]
//
// DIR holds reports.json ([{ platform, changes?, device? }], as a hosted preview's /reports.json lists them) and one
// <platform>.zip per entry (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an
// earlier link's /p/<token>; without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
// DIR holds reports.json ([{ target?, platform, label?, changes?, device? }], as a hosted preview's /reports.json lists
// them) and one <target>.zip per entry, or <platform>.zip for an entry without a target
// (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an earlier link's /p/<token>;
// without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
import { readFile } from "node:fs/promises";
import { join } from "node:path";
import { parseArgs } from "node:util";
import { deployFixturePreview } from "../dist/report/preview-deploy.js";
import { deployFixturePreview, fixtureReports } from "../dist/report/preview-deploy.js";
const { values } = parseArgs({ options: { fixtures: { type: "string" }, alias: { type: "string" }, project: { type: "string" }, owner: { type: "string" } } });
if (!values.fixtures || !values.alias || !values.project) {
@@ -19,7 +20,7 @@ if (!values.fixtures || !values.alias || !values.project) {
const listing = JSON.parse(await readFile(join(values.fixtures, "reports.json"), "utf8"));
const token = process.env.EXPLORE_PREVIEW_TOKEN?.trim() || undefined;
const result = await deployFixturePreview({
reports: listing.map(({ platform, changes, device }) => ({ platform, zipPath: join(values.fixtures, `${platform}.zip`), changes, device })),
reports: fixtureReports(listing, values.fixtures),
project: values.project, alias: values.alias, ...(values.owner ? { owner: values.owner } : {}), ...(token ? { token } : {}),
});
console.log(JSON.stringify({ ...result, reports: listing }));
+243
View File
@@ -0,0 +1,243 @@
// The README's two animated SVGs, written by readme-screenshots.mjs. Each is a plain image: CSS keyframes on one loop,
// every picture inlined as a JPEG data URI (an SVG shown with <img> loads nothing), and with prefers-reduced-motion
// it shows its last frame, which is also what a viewer that does not animate SVG shows.
//
// readme-hero the Viewer's Map, built from real Viewer frames: the screens appear row by row, the transitions
// wipe in from the top, then a click selects a screen and the Inspector slides in
// readme-compare one modified screen wiping from its base capture to its head capture, the changed regions pulsing
import { ZipReader, Uint8ArrayReader, Uint8ArrayWriter } from "@zip.js/zip.js";
/** The soft stage the PR comment picture sits on too (stagedComment in readme-screenshots.mjs), and its accents. */
const STAGE = {
light: { stage: "#F6F8FA", border: "#D1D9E0", shadow: "rgba(17,17,17,0.14)", text: "#1F2328", muted: "#59636E", accent: "#0969DA", region: "#D4520F" },
dark: { stage: "#151B23", border: "#3D444D", shadow: "rgba(1,4,9,0.6)", text: "#F0F6FC", muted: "#9198A1", accent: "#4493F8", region: "#F0883E" },
};
const FONT = "-apple-system, BlinkMacSystemFont, &apos;Segoe UI&apos;, &apos;Noto Sans&apos;, Helvetica, Arial, sans-serif";
const MONO = "ui-monospace, SFMono-Regular, &apos;SF Mono&apos;, Menlo, Consolas, monospace";
const JPEG_QUALITY = 82;
const dataUri = jpeg => `data:image/jpeg;base64,${jpeg.toString("base64")}`;
const escapeXml = text => text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
const box = ({ x, y, width, height }) => `x="${x}" y="${y}" width="${width}" height="${height}"`;
/** Keyframes given in seconds on a shared loop, so every element stays in step. */
function keyframes(name, loop, frames) {
return `@keyframes ${name}{${frames.map(([at, css]) => `${((at / loop) * 100).toFixed(2)}%{${css}}`).join("")}}`;
}
/**
* Photographs the hero's states from a Viewer page whose Map has its camera set and nothing selected: the Map without
* its screens, without its edges, and whole; then it clicks `select`, which opens the Inspector without moving the
* camera, and photographs that. Returns the frames and where each screen card, the Inspector and the selected card are.
*/
export async function captureHeroFrames(page, { select, viewport }) {
const shoot = () => page.screenshot({ type: "jpeg", quality: JPEG_QUALITY });
const neutral = () => page.mouse.move(viewport.width - 4, viewport.height - 4);
const rect = locator => locator.boundingBox().then(b => b && { x: Math.round(b.x), y: Math.round(b.y), width: Math.round(b.width), height: Math.round(b.height) });
const camera = () => page.locator(".react-flow__viewport").evaluate(el => el.style.transform);
const target = page.locator(`.screen-screenshot-target[title="${select}"]`);
// A card under the pointer dims the others and highlights its edges; let that fade before the first frame.
await neutral();
await page.waitForTimeout(1000);
const at = await camera();
const selected = await rect(target);
if (!selected) throw new Error(`The hero needs ${select} on the Map.`);
const cards = [];
for (const node of await page.locator(".react-flow__node").all()) {
const b = await rect(node);
if (b && b.x < viewport.width && b.y < viewport.height && b.x + b.width > 0 && b.y + b.height > 0) cards.push(b);
}
const full = await shoot();
const hide = async css => {
const style = await page.addStyleTag({ content: `${css} { visibility: hidden !important; }` });
await page.waitForTimeout(300);
return style;
};
const edges = await hide(".react-flow__edges, .react-flow__edge, .react-flow__edgelabel-renderer");
const screensOnly = await shoot();
const nodes = await hide(".react-flow__node");
const empty = await shoot();
for (const style of [edges, nodes]) await style.evaluate(el => el.remove());
await target.click();
await neutral();
await page.waitForTimeout(1500);
const inspector = await rect(page.locator("aside.right-panel"));
if (!inspector) throw new Error(`Selecting ${select} did not open the Inspector.`);
if ((await camera()) !== at) throw new Error(`The Map's camera moved when ${select} was selected: ${at} → ${await camera()}.`);
const inspecting = await shoot();
return { viewport, empty, screensOnly, full, inspecting, cards, selected, inspector };
}
/**
* The hero: the frames from captureHeroFrames as a window on a rounded 1600×900 stage. Each screen
* card is a clip of the screens-only frame, so what appears is exactly what the Viewer draws.
*/
export function heroSvg(frames, theme, alt) {
const t = STAGE[theme];
const LOOP = 12;
const W = 1600, H = 900;
const { viewport: v } = frames;
const wx = (W - v.width) / 2, wy = (H - v.height) / 2;
const css = [];
const defs = [];
const layers = [];
const image = (id, jpeg) => defs.push(`<image id="${id}" width="${v.width}" height="${v.height}" href="${dataUri(jpeg)}"/>`);
image("empty", frames.empty);
image("screens", frames.screensOnly);
image("full", frames.full);
image("inspecting", frames.inspecting);
// Cards appear a row at a time, top to bottom, as the Map lays out taps from launch; a row's cards left to right.
const PAD = 18;
const rows = [...new Set(frames.cards.map(c => c.y))].sort((a, b) => a - b);
frames.cards.forEach((card, i) => {
const appear = 0.4 + rows.indexOf(card.y) * 0.35 + (card.x / v.width) * 0.3;
const clip = { x: card.x - PAD, y: card.y - PAD, width: card.width + PAD * 2, height: card.height + PAD * 2 };
defs.push(`<clipPath id="c${i}"><rect ${box(clip)}/></clipPath>`);
css.push(`.c${i}{transform-origin:0 0;animation:c${i} ${LOOP}s cubic-bezier(.2,.8,.2,1) infinite}`);
css.push(keyframes(`c${i}`, LOOP, [[0, "opacity:0;transform:scale(.92)"], [appear, "opacity:0;transform:scale(.92)"], [appear + 0.45, "opacity:1;transform:scale(1)"], [LOOP, "opacity:1;transform:scale(1)"]]));
// Scaled about the card's centre: the class sits on a group whose origin is there.
const cx = card.x + card.width / 2, cy = card.y + card.height / 2;
layers.push(`<g transform="translate(${cx} ${cy})"><g class="c${i}"><g transform="translate(${-cx} ${-cy})" clip-path="url(#c${i})"><use href="#screens"/></g></g></g>`);
});
const settled = 0.4 + (rows.length - 1) * 0.35 + 0.75;
// The transitions wipe in from the top: the full frame over the cards, which it draws in the same places.
const EDGES = settled - 0.2, EDGES_END = EDGES + 1.3;
css.push(`.full{animation:full ${LOOP}s cubic-bezier(.45,0,.25,1) infinite}`);
css.push(keyframes("full", LOOP, [[0, "clip-path:inset(0 0 100% 0)"], [EDGES, "clip-path:inset(0 0 100% 0)"], [EDGES_END, "clip-path:inset(0 0 0 0)"], [LOOP, "clip-path:inset(0 0 0 0)"]]));
layers.push(`<use class="full" href="#full"/>`);
// A pointer glides to the selected card and clicks; the selection lands and the Inspector slides in.
const { selected: s, inspector: p } = frames;
const target = { x: s.x + s.width * 0.55, y: s.y + s.height * 0.45 };
const start = { x: Math.min(v.width - 120, target.x + 260), y: Math.min(v.height - 60, target.y + 220) };
const MOVE = EDGES_END + 0.5, CLICK = MOVE + 1.2;
const pointer = (x, y, extra = "") => `transform:translate(${x.toFixed(1)}px,${y.toFixed(1)}px)${extra}`;
css.push(`.ptr{opacity:0;animation:ptr ${LOOP}s cubic-bezier(.4,0,.2,1) infinite}`);
css.push(keyframes("ptr", LOOP, [
[0, `opacity:0;${pointer(start.x, start.y)}`], [MOVE, `opacity:0;${pointer(start.x, start.y)}`], [MOVE + 0.2, `opacity:1;${pointer(start.x, start.y)}`],
[CLICK, `opacity:1;${pointer(target.x, target.y)}`], [CLICK + 0.1, `opacity:1;${pointer(target.x, target.y, " scale(.82)")}`],
[CLICK + 0.25, `opacity:1;${pointer(target.x, target.y)}`], [CLICK + 1.2, `opacity:0;${pointer(target.x, target.y)}`], [LOOP, `opacity:0;${pointer(target.x, target.y)}`],
]));
defs.push(`<clipPath id="canvas"><rect x="0" y="0" width="${p.x}" height="${v.height}"/></clipPath>`);
defs.push(`<clipPath id="panel"><rect ${box(p)}/></clipPath>`);
css.push(`.sel{animation:sel ${LOOP}s ease-out infinite}`);
css.push(keyframes("sel", LOOP, [[0, "opacity:0"], [CLICK + 0.1, "opacity:0"], [CLICK + 0.4, "opacity:1"], [LOOP, "opacity:1"]]));
css.push(`.insp{animation:insp ${LOOP}s cubic-bezier(.2,.8,.2,1) infinite}`);
css.push(keyframes("insp", LOOP, [[0, "opacity:0;transform:translateX(48px)"], [CLICK + 0.15, "opacity:0;transform:translateX(48px)"], [CLICK + 0.75, "opacity:1;transform:translateX(0)"], [LOOP, "opacity:1;transform:translateX(0)"]]));
layers.push(`<use class="sel" href="#inspecting" clip-path="url(#canvas)"/>`);
layers.push(`<g class="insp"><use href="#inspecting" clip-path="url(#panel)"/></g>`);
layers.push(`<g class="ptr"><path d="M0 0L0 22L6 16.5L10.5 26L14 24.5L9.8 15.2L18 15.2Z" fill="#111" stroke="#fff" stroke-width="1.6" stroke-linejoin="round"/></g>`);
// The empty Map covers the reset: it fades in over the last frame, and the loop starts again beneath it.
css.push(`.cover{opacity:0;animation:cover ${LOOP}s linear infinite}`);
css.push(keyframes("cover", LOOP, [[0, "opacity:1"], [0.2, "opacity:0"], [LOOP - 0.7, "opacity:0"], [LOOP, "opacity:1"]]));
layers.push(`<use class="cover" href="#empty"/>`);
css.push("@media (prefers-reduced-motion: reduce){*{animation:none!important}}");
defs.push(`<clipPath id="window"><rect width="${v.width}" height="${v.height}" rx="14"/></clipPath>`);
defs.push(`<filter id="shadow" x="-10%" y="-10%" width="120%" height="125%"><feDropShadow dx="0" dy="2" stdDeviation="2" flood-color="${t.shadow}" flood-opacity=".3"/><feDropShadow dx="0" dy="30" stdDeviation="35" flood-color="${t.shadow}"/></filter>`);
defs.push(`<clipPath id="stage"><rect width="${W}" height="${H}" rx="22"/></clipPath>`);
return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${W} ${H}" width="${W}" height="${H}" role="img" aria-label="${escapeXml(alt)}">`
+ `<style>${css.join("")}</style><defs>${defs.join("")}</defs>`
+ `<g clip-path="url(#stage)"><rect width="${W}" height="${H}" fill="${t.stage}"/>`
+ `<rect x="${wx}" y="${wy}" width="${v.width}" height="${v.height}" rx="14" fill="${t.stage}" filter="url(#shadow)"/>`
+ `<g transform="translate(${wx} ${wy})"><g clip-path="url(#window)"><use href="#empty"/>${layers.join("")}</g>`
+ `<rect x=".5" y=".5" width="${v.width - 1}" height="${v.height - 1}" rx="14" fill="none" stroke="${t.border}"/></g></g></svg>`;
}
/** review.json and an asset reader from a sealed review report's bytes. */
export async function openReport(bytes) {
const reader = new ZipReader(new Uint8ArrayReader(new Uint8Array(bytes)));
const entries = new Map((await reader.getEntries()).map(entry => [entry.filename, entry]));
const read = async name => {
const entry = entries.get(name);
if (!entry) throw new Error(`The report has no ${name}.`);
return Buffer.from(await entry.getData(new Uint8ArrayWriter()));
};
const review = JSON.parse((await read("review.json")).toString("utf8")).review;
return { review, asset: sha => read(`assets/${sha}.png`) };
}
/** A PNG as a JPEG at most `maxHeight` tall, drawn by the browser so the script needs no image library. */
async function toJpeg(browser, png, maxHeight) {
const page = await browser.newPage();
try {
const base64 = await page.evaluate(async ({ png, maxHeight, quality }) => {
const bitmap = await createImageBitmap(await (await fetch(`data:image/png;base64,${png}`)).blob());
const scale = Math.min(1, maxHeight / bitmap.height);
const canvas = document.createElement("canvas");
canvas.width = Math.round(bitmap.width * scale);
canvas.height = Math.round(bitmap.height * scale);
const context = canvas.getContext("2d");
context.imageSmoothingQuality = "high";
context.drawImage(bitmap, 0, 0, canvas.width, canvas.height);
return canvas.toDataURL("image/jpeg", quality).split(",")[1];
}, { png: png.toString("base64"), maxHeight, quality: JPEG_QUALITY / 100 });
return Buffer.from(base64, "base64");
} finally {
await page.close();
}
}
/**
* The surface of the Compare key `key` (the slug of the Viewer's #/compare/<key>, which is the route without its
* slash) in `theme`, among the report's visually modified screens.
*/
export function compareSurface(review, key, theme) {
const route = `/${key}`;
const surface = review.surfaces.find(s => (s.head ?? s.base)?.route === route && s.colorScheme === theme && s.visual?.verdict === "modified");
if (!surface) throw new Error(`No visually modified ${route} in ${theme} in this report; pass --compare <key> from a #/compare/<key> URL.`);
return surface;
}
/** The Compare picture: `surface`'s base capture wiping to its head capture, its changed regions outlined. */
export async function compareSvg(browser, report, surface, theme, alt) {
const t = STAGE[theme];
const LOOP = 7;
const W = 1000, H = 600;
const { baseImage, headImage } = surface;
const PH = 540, PW = Math.round(PH * headImage.width / headImage.height);
const x = (W - PW) / 2, y = (H - PH) / 2;
const k = PW / headImage.width;
const before = dataUri(await toJpeg(browser, await report.asset(baseImage.sha256), PH * 2));
const after = dataUri(await toJpeg(browser, await report.asset(headImage.sha256), PH * 2));
const { pullRequest } = report.review;
const css = [];
// The After capture is revealed left to right, and the divider rides the edge of the reveal.
css.push(`.after{animation:wipe ${LOOP}s cubic-bezier(.65,0,.35,1) infinite}`);
css.push(keyframes("wipe", LOOP, [[0, "clip-path:inset(0 100% 0 0)"], [1.0, "clip-path:inset(0 100% 0 0)"], [2.6, "clip-path:inset(0 0 0 0)"], [5.8, "clip-path:inset(0 0 0 0)"], [6.8, "clip-path:inset(0 100% 0 0)"], [LOOP, "clip-path:inset(0 100% 0 0)"]]));
css.push(`.divider{opacity:0;animation:divider ${LOOP}s cubic-bezier(.65,0,.35,1) infinite}`);
css.push(keyframes("divider", LOOP, [[0, "transform:translateX(0);opacity:0"], [0.8, "transform:translateX(0);opacity:1"], [1.0, "transform:translateX(0);opacity:1"], [2.6, `transform:translateX(${PW}px);opacity:1`], [2.9, `transform:translateX(${PW}px);opacity:0`], [5.8, `transform:translateX(${PW}px);opacity:0`], [6.0, `transform:translateX(${PW}px);opacity:1`], [6.8, "transform:translateX(0);opacity:1"], [LOOP, "transform:translateX(0);opacity:0"]]));
css.push(`.regions{animation:regions ${LOOP}s ease-in-out infinite}`);
css.push(keyframes("regions", LOOP, [[0, "opacity:0"], [2.7, "opacity:0"], [3.1, "opacity:1"], [3.6, "opacity:.3"], [4.1, "opacity:1"], [5.7, "opacity:1"], [6.0, "opacity:0"], [LOOP, "opacity:0"]]));
css.push(`.before-label{opacity:.3;animation:before-label ${LOOP}s linear infinite}.after-label{animation:after-label ${LOOP}s linear infinite}`);
css.push(keyframes("before-label", LOOP, [[0, "opacity:1"], [1.8, "opacity:1"], [2.0, "opacity:.3"], [6.2, "opacity:.3"], [6.4, "opacity:1"], [LOOP, "opacity:1"]]));
css.push(keyframes("after-label", LOOP, [[0, "opacity:.3"], [1.8, "opacity:.3"], [2.0, "opacity:1"], [6.2, "opacity:1"], [6.4, "opacity:.3"], [LOOP, "opacity:.3"]]));
css.push("@media (prefers-reduced-motion: reduce){*{animation:none!important}}");
const regions = surface.visual.regions.map(({ rect: r }) =>
`<rect x="${(x + r.x * k - 3).toFixed(1)}" y="${(y + r.y * k - 3).toFixed(1)}" width="${(r.width * k + 6).toFixed(1)}" height="${(r.height * k + 6).toFixed(1)}" rx="3" fill="none" stroke="${t.region}" stroke-width="2"/>`).join("");
const label = (cls, anchor, lx, title, sub, note) => `<g class="${cls}" font-family="${FONT}" text-anchor="${anchor}">`
+ `<text x="${lx}" y="${y + PH / 2 - 14}" font-size="26" font-weight="700" fill="${t.text}">${title}</text>`
+ `<text x="${lx}" y="${y + PH / 2 + 12}" font-family="${MONO}" font-size="13" fill="${t.muted}">${escapeXml(sub)}</text>`
+ (note ? `<text x="${lx}" y="${y + PH / 2 + 36}" font-size="13" font-weight="600" fill="${t.region}">${note}</text>` : "") + "</g>";
const count = surface.visual.regions.length;
return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${W} ${H}" width="${W}" height="${H}" role="img" aria-label="${escapeXml(alt)}">`
+ `<style>${css.join("")}</style>`
+ `<defs><clipPath id="stage"><rect width="${W}" height="${H}" rx="16"/></clipPath><clipPath id="phone"><rect x="${x}" y="${y}" width="${PW}" height="${PH}" rx="40"/></clipPath>`
+ `<filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="${t.shadow}"/></filter></defs>`
+ `<g clip-path="url(#stage)"><rect width="${W}" height="${H}" fill="${t.stage}"/>`
+ `<rect x="${x}" y="${y}" width="${PW}" height="${PH}" rx="40" fill="${t.stage}" filter="url(#shadow)"/>`
+ `<g clip-path="url(#phone)"><image href="${before}" x="${x}" y="${y}" width="${PW}" height="${PH}"/>`
+ `<image class="after" href="${after}" x="${x}" y="${y}" width="${PW}" height="${PH}"/></g>`
+ `<rect x="${x}" y="${y}" width="${PW}" height="${PH}" rx="40" fill="none" stroke="${t.border}"/>`
+ `<g class="divider"><rect x="${x - 1.5}" y="${y}" width="3" height="${PH}" fill="${t.accent}"/><circle cx="${x}" cy="${y + PH / 2}" r="13" fill="${t.accent}"/>`
+ `<path d="M${x - 5} ${y + PH / 2 - 4}l-3 4l3 4M${x + 5} ${y + PH / 2 - 4}l3 4l-3 4" stroke="#fff" stroke-width="1.8" fill="none" stroke-linecap="round" stroke-linejoin="round"/></g>`
+ `<g class="regions">${regions}</g>`
+ label("before-label", "end", x - 44, "Before", `${pullRequest.base.ref} ·${pullRequest.base.sha.slice(0, 7)}`)
+ label("after-label", "start", x + PW + 44, "After", `PR #${pullRequest.number} · ${pullRequest.head.sha.slice(0, 7)}`, `${count} changed region${count === 1 ? "" : "s"}`)
+ "</g></svg>";
}
+45 -15
View File
@@ -1,4 +1,4 @@
// Regenerates the Viewer screenshots in docs/screenshots from a review report, in light and dark
// Regenerates the README's pictures in docs/screenshots from a review report, in light and dark
// (the README shows them with <picture>; GitHub Mobile ignores the dark source and shows light). The reference app is euxy
// (github.com/brentvatne/euxy): skills/readme-refresh/SKILL.md says which report to pass and how.
//
@@ -6,8 +6,11 @@
// [--pr https://github.com/brentvatne/euxy/pull/148]
//
// --report a sealed review report (the hosted link's report.zip?platform=ios, or the PR's zip artifact)
// --select the route selected on the hero Map (opens the Inspector); default /settings
// --compare the Compare key of a modified screen: the slug in the Viewer's #/compare/<key> URL; default patterns
// --select the route selected on the hero Map (opens the Inspector); default /settings. The hero zooms in around it
// (--zoom, default 73%) and is an animated SVG of a window on a soft stage (readme-animations.mjs): the
// Map's cards appear, its transitions wipe in, and a click on this screen opens the Inspector
// --compare the Compare key of a modified screen: the slug in the Viewer's #/compare/<key> URL; default patterns.
// It becomes readme-compare-*.svg, its before capture wiping to its after capture
// --pr a GitHub PR URL whose Explore comment becomes readme-pr-comment-light.png (public repository): the comment
// at its own size on a soft stage, cut off with a fade after the list of changed screens
import { chromium } from "@playwright/test";
@@ -15,6 +18,7 @@ import { readFile, writeFile } from "node:fs/promises";
import { parseArgs } from "node:util";
import { fileURLToPath } from "node:url";
import { startReportViewer } from "../test/ci/lib/report-viewer.mjs";
import { captureHeroFrames, compareSurface, compareSvg, heroSvg, openReport } from "./readme-animations.mjs";
const { values: args } = parseArgs({
options: {
@@ -22,6 +26,7 @@ const { values: args } = parseArgs({
select: { type: "string", default: "/settings" },
compare: { type: "string", default: "patterns" },
pr: { type: "string" },
zoom: { type: "string", default: "73" },
},
});
if (!args.report) {
@@ -31,15 +36,22 @@ if (!args.report) {
const out = fileURLToPath(new URL("../docs/screenshots/", import.meta.url));
const SHOTS = [
{ file: "readme-hero", hash: "#/map", viewport: { width: 2200, height: 1240 }, click: "Fit canvas", select: args.select },
{ file: "readme-compare", hash: `#/compare/${args.compare}`, viewport: { width: 1760, height: 1000 } },
{ file: "readme-hero", hash: "#/map", viewport: { width: 1376, height: 774 }, click: "Fit canvas", select: args.select, zoom: Number(args.zoom), animated: true },
{ file: "readme-screens", hash: "#/screens", viewport: { width: 1760, height: 1000 } },
];
const bytes = await readFile(args.report);
const report = await openReport(bytes);
const { server, url } = await startReportViewer({ bytes, watch: false });
const browser = await chromium.launch();
try {
for (const theme of ["light", "dark"]) {
const surface = compareSurface(report.review, args.compare, theme);
const path = `${out}readme-compare-${theme}.svg`;
await writeFile(path, await compareSvg(browser, report, surface, theme,
`The ${surface.head.route} screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined`));
console.log(path);
}
for (const theme of ["light", "dark"]) for (const shot of SHOTS) {
const context = await browser.newContext({ viewport: shot.viewport, deviceScaleFactor: 2, colorScheme: theme });
await context.addInitScript(value => localStorage.setItem("expo-explore:theme", value), theme);
@@ -52,17 +64,34 @@ try {
await page.mouse.move(400, shot.viewport.height - 30);
await page.waitForTimeout(1500);
}
if (shot.select) {
// Selecting a screen opens the Inspector without moving the fitted camera.
if (shot.select && !shot.animated) {
// Selecting a screen opens the Inspector without moving the fitted camera. The animated hero selects it last.
await page.locator(`.screen-screenshot-target[title="${shot.select}"]`).click();
await page.mouse.move(400, shot.viewport.height - 30);
await page.waitForTimeout(1500);
}
if (shot.hash.startsWith("#/compare/") && !page.url().includes(shot.hash)) {
throw new Error(`Compare key ${args.compare} is not a screen of this report (the Viewer went to ${page.url()}); pass --compare <key> from a #/compare/<key> URL.`);
if (shot.zoom) {
// Zoom around the selected screen with the wheel, which keeps it under the pointer, then pan it left and up, clear
// of the minimap and the bottom bar. The camera stops at the first wheel step past the zoom asked for.
const box = await page.locator(`.screen-screenshot-target[title="${shot.select}"]`).boundingBox();
await page.mouse.move(box.x + box.width / 2, box.y + box.height / 2);
for (let step = 0; step < 60; step++) {
if (Number((await page.locator(".zoom-button span").first().textContent()).replace("%", "")) >= shot.zoom) break;
await page.keyboard.down("Control");
await page.mouse.wheel(0, -12);
await page.keyboard.up("Control");
await page.waitForTimeout(150);
}
await page.mouse.wheel(160, 90);
await page.mouse.move(shot.viewport.width - 60, shot.viewport.height / 2);
await page.waitForTimeout(1200);
}
const path = `${out}${shot.file}-${theme}.png`;
await page.screenshot({ path });
const path = `${out}${shot.file}-${theme}.${shot.animated ? "svg" : "png"}`;
if (shot.animated) {
const frames = await captureHeroFrames(page, { select: shot.select, viewport: shot.viewport });
await writeFile(path, heroSvg(frames, theme,
`Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects ${shot.select} and the Inspector opens on it`));
} else await page.screenshot({ path });
console.log(path);
await context.close();
}
@@ -71,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 });
+28 -4
View File
@@ -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."
+10 -10
View File
@@ -1,6 +1,6 @@
---
name: explore-binary
description: Explore a prebuilt mobile app archive (Android .apk, iOS simulator .app, .tar.gz, or simulator .ipa) with Expo Explore. Runs `expo-explore explore:binary`, which installs the archive in a fresh EAS Simulator session, drives it with the local claude or codex login, writes an exploration map and report, hosts the report on EAS Hosting, and prints the link. Use when asked to "run @expo/explore for some.app/.apk", to map or smoke-test an app you only have as a build, or to get screenshots of every screen of a binary. `expo-explore explore:session` does the exploration half alone against an EAS Simulator session you already started (app already installed; result opens in the local Viewer). Also explores an Expo project from its source with no new build: its development build (or Expo Go) on an EAS Simulator, loading JavaScript from a tunneled local dev server. Not for device .ipa files.
description: Explore a prebuilt mobile app archive (Android .apk, iOS simulator .app, .tar.gz, or simulator .ipa) with Expo Explore. Runs `expo-explore explore:binary`, which installs the archive in a fresh EAS Simulator session (or, with `--simulator local`, on a simulator or emulator it starts on this Mac, with no EAS login), drives it with the local claude or codex login, writes an exploration map and report, and hosts the report on EAS Hosting or opens it in the local Viewer. Use when asked to "run @expo/explore for some.app/.apk", to map or smoke-test an app you only have as a build, or to get screenshots of every screen of a binary. `expo-explore explore:session` does the exploration half alone against an EAS Simulator session you already started (app already installed; result opens in the local Viewer). Also explores an Expo project from its source with no new build: its development build (or Expo Go) on an EAS Simulator, loading JavaScript from a tunneled local dev server. Not for device .ipa files.
---
# Explore a prebuilt app
@@ -11,25 +11,25 @@ One command, run from any directory:
npx @expo/explore explore:binary ./path/to/app.apk --json
```
Accepted inputs: Android `.apk`; iOS simulator builds as a `.app` directory, a `.tar.gz`/`.tgz` of one, or an `.ipa` that contains a simulator build. An iOS device `.ipa` and an Android `.aab` are rejected before any session starts (`ARCHIVE_NOT_SIMULATOR`, `ARCHIVE_AAB_UNSUPPORTED`); ask for a simulator build or a universal/x86_64 APK instead.
Accepted inputs: Android `.apk`; iOS simulator builds as a `.app` directory, a `.tar.gz`/`.tgz` of one, or an `.ipa` that contains a simulator build. An iOS device `.ipa` and an Android `.aab` are rejected before any device starts (`ARCHIVE_NOT_SIMULATOR`, `ARCHIVE_AAB_UNSUPPORTED`); ask for a simulator build or a universal APK instead.
Platform, bundle id, app name and version are read from the archive; do not pass them unless Explore asks.
## Before running
- EAS login: `eas whoami` succeeds, or `EXPO_TOKEN` is set. The session and the hosted report live under that account (`--owner` picks one when the login has several, `--project` renames the default `expo-explore` project).
- Where it runs. By default on EAS Simulator, which needs an EAS login: `eas whoami` succeeds, or `EXPO_TOKEN` is set. The session and the hosted report live under that account (`--owner` picks one when the login has several, `--project` renames the default `expo-explore` project). Without EAS Simulator access, or without an Expo account, pass `--simulator local`: Explore creates a simulator (iOS, needs Xcode) or an emulator (Android, needs the Android SDK with platform-tools, cmdline-tools, the emulator and a system image for this Mac, and `ANDROID_HOME`) and removes it afterwards. An APK must then ship native libraries for this Mac's ABI (`arm64-v8a` on Apple silicon); a universal one does.
- A model: Explore tries `ANTHROPIC_API_KEY` / `OPENAI_API_KEY` when set, then the local `claude` login (Claude Code), then the local `codex` login, and uses the first that passes a preflight request. `--provider` or `--model` limits it to that one choice. If none passes, the run stops before a simulator is started.
- Node 24.12 or newer.
## What happens
1. Archive inspection and compatibility checks (size, simulator build, emulator ABI, sha256).
2. `eas simulator:start` of an empty agent-device session, verified by exact session id before use.
3. `agent-device install` of the archive straight into the session, then `open <bundle id>`.
2. `eas simulator:start` of an empty agent-device session (an `argent` one with `--controller argent`), verified by exact session id before use. With `--simulator local`: a new simulator or emulator on this Mac instead, with the app's URL schemes approved so its links open without a prompt.
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`).
7. The exact session is stopped; a failure to stop reports `SESSION_CLEANUP_FAILED` with the id to stop by hand.
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"`.
@@ -65,14 +65,14 @@ The model only ever sees the reference; Explore types the value into the field.
## Already have a session? `explore:session`
When the app is already installed on an agent-device EAS Simulator session you started (for example after `eas simulator:start --type agent-device --out-config-type dotenv`, `agent-device install ...`, `agent-device open ...`), skip intake and install:
When the app is already installed on an EAS Simulator session you started (for example after `eas simulator:start --type agent-device --out-config-type dotenv`, `agent-device install ...`, `agent-device open ...`; an `--type argent` session works the same way, with Argent's tools), skip intake and install:
```sh
npx @expo/explore explore:session # session from ./.env.eas-simulator or EAS_SIMULATOR_SESSION_ID; explores the app in the foreground
npx @expo/explore explore:session <session-id> --env-file path/.env.eas-simulator --bundle-id dev.brent.euxy --json
```
The app is whatever is in the foreground, else the only user-installed app; pass `--bundle-id` when neither is clear (`BUNDLE_ID_REQUIRED` lists what is installed); `--app-name`/`--app-version` label the report. The session is checked with `eas simulator:get` (must be agent-device, in progress, and the same daemon as the connection you passed), your existing `agent-device` session on the device is reused, and the same model, budgets, hints and destructive-action flags apply. The map and `report/` are written under `--output` and opened in the local Viewer (`--port N`); `--no-open` skips that and `--upload` hosts the report instead. The session is never stopped: the output ends with the `eas simulator:stop --id ...` command for when you are done.
The app is whatever is in the foreground, else the only user-installed app; pass `--bundle-id` when neither is clear (`BUNDLE_ID_REQUIRED` lists what is installed); `--app-name`/`--app-version` label the report. The session is checked with `eas simulator:get` (must be the controller type its connection names, agent-device or argent, in progress, and the same endpoint as the connection you passed; `--controller` must agree with it), your existing `agent-device` session on the device is reused, and the same model, budgets, hints and destructive-action flags apply. The map and `report/` are written under `--output` and opened in the local Viewer (`--port N`); `--no-open` skips that and `--upload` hosts the report instead. The session is never stopped: the output ends with the `eas simulator:stop --id ...` command for when you are done.
## An Expo project and no build: run it from source
@@ -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:
+15 -14
View File
@@ -5,7 +5,7 @@ description: Set up Expo Explore CI reviews in deterministic or agent mode. Star
# Set up Expo Explore
Make the app ready for CI capture in the user's chosen mode, using its real configuration and source. This is the shared **local authoring skill** for both modes. Android capture is not available yet.
Make the app ready for CI capture in the user's chosen mode, using its real configuration and source. This is the shared **local authoring skill** for both modes.
Explore's tools are app-agnostic: `expo-explore setup` and `expo-explore doctor` know routes, parameters, links and source redirects, but not what the app means by them. **Your job is the app-specific part**: read this app's source to learn which flows (sign-in, onboarding, a subscription, a feature flag, a permission, a record that must exist, …) each screen needs, and write that into this app's `config.yaml` or instructions. Look for what the app actually has; do not assume the flows of another app, and do not impose an account or persona schema.
@@ -152,31 +152,32 @@ Repeat `expo-explore doctor --json` and fix each `fail` until none remain, colle
## Review a change on this machine
Once `.expo-explore/config.yaml` is committed, the same review CI runs works locally, between any two commits:
The same review CI runs works locally, between any two commits. It reads `.expo-explore/config.yaml` from the head commit, else from the checkout when setup wrote it but it is not committed, else uses the defaults `setup --non-interactive` would write (with several simulator profiles, the one named `explore`), so it works before setup:
```sh
npx @expo/explore capture:review # HEAD against where it left the default branch
npx @expo/explore capture:review --uncommitted # your uncommitted changes to tracked files against HEAD's base
npx @expo/explore capture:review --base v1.3.0 --head v1.4.0 --scope all
npx @expo/explore capture # HEAD and the uncommitted changes, against where HEAD left the default branch
npx @expo/explore capture --committed # HEAD alone
npx @expo/explore capture --base v1.3.0 --head v1.4.0 --scope all
```
- It prints which commits it compares. Each is checked out as a detached worktree in a temporary directory, its dependencies installed (frozen lockfile, no scripts, no Explore credentials in the environment), and removed afterwards; the user's checkout, index and branches are never touched.
- It runs both commits' code as the user (dependency installs, the app config, bundling). Before reviewing a branch the user did not write, say so and ask; credential-free installs are not a sandbox.
- Logins: `EXPO_TOKEN` and the provider's API key when they are set; otherwise the user's `eas login` and their local `claude` or `codex` login for the configured provider. If `eas whoami` fails, tell them to run `eas login`.
- `--uncommitted` includes tracked files only. `--include-untracked` adds untracked, non-ignored files, which are uploaded with the EAS build, so check the listed files first and never include secrets.
- Every configured platform is reviewed unless `--platform` picks one. It opens the report in a local Viewer; `--upload` hosts it instead and prints the link, `--no-open` or `--json` only prints the report paths.
- Without `--head`, the head is HEAD plus the working tree's changes, untracked non-ignored files included, which is what `eas build` uploads. It lists them; check that list for secrets the user would not want built. `--committed` reviews HEAD alone, and an `eas.json` with `cli.requireCommit: true` leaves the changes out unless `--uncommitted` is passed.
- Every configured platform or target is reviewed, at once, unless `--target` or `--platform` picks some (`--parallel N` caps how many run together). It opens the report in a local Viewer; `--upload` hosts it instead and prints the link, `--no-open` or `--json` only prints the report paths.
- Without EAS Simulator access, add `--simulator local` (or `capture.simulator: local`): each commit is captured on a simulator Explore creates on this Mac (Xcode) or an emulator (Android SDK), and the app is repacked there too. The native build still comes from EAS. `npx @expo/explore doctor --simulator local` checks that this machine can start each device.
- Every run is kept on this machine for 30 days: `npx @expo/explore reports list` (or `--json`) shows them, `reports open <id|latest>` reopens one in the local Viewer, and `reports upload <id>` hosts it without capturing again. Run bare in a terminal, `reports` is an arrow-key picker for the user.
- To host a report after the fact, run `npx @expo/explore report:upload <report.zip>...` with the paths it printed (or the `--output` directory's `<platform>/report.zip`), one per platform. It uses the same project as `--upload` and does not capture again.
- Captures are cached in `~/.cache/expo-explore`, so a second review of the same base does not capture it again (`--no-cache` skips the cache). Ctrl+C stops the EAS Simulator sessions the review started.
- It builds on EAS and runs simulator sessions, like a CI review: expect several minutes and EAS usage per run.
- To host a report after the fact, run `npx @expo/explore report:upload <report.zip>...` with the paths it printed (or the `--output` directory's `<target>/report.zip`), one per platform or target. It uses the same project as `--upload` and does not capture again.
- Captures are cached in `~/.cache/expo-explore`, so a second review of the same base does not capture it again (`--no-cache` skips the cache). Ctrl+C stops the simulator sessions and local devices the review started; after a harder stop, the next local review stops what was left running.
- It builds on EAS and, unless it captures locally, runs EAS Simulator sessions, like a CI review: expect several minutes and EAS usage per run.
## Compare any two commits
`explore-compare.yml` (installed by `setup --workflows` from 0.19.0; run `npx @expo/explore@latest setup --workflows` to add it to an existing setup) reviews a `head` against a `base`, each a branch, tag or commit SHA, with no pull request. It captures, compares and reports like a PR review and links the report from the run's summary. Its inputs are `base`, `head`, and the optional `scope` (`changes` or `all`) and `expires-in` (such as `30d`, or `never`).
`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.
- **Without CI.** `npx @expo/explore capture:review --base <ref> --head <ref> --scope all --upload` runs the same comparison on this machine (see the previous section).
- **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.
+20 -12
View File
@@ -1,6 +1,6 @@
---
name: readme-refresh
description: Refresh Expo Explore's README.md with euxy (github.com/brentvatne/euxy) as the reference app. Regenerate every screenshot in docs/screenshots from a current euxy review report and PR comment, then re-read the README as a first-time user: the top level only says what Explore does, links the live euxy example, and gives a prompt to copy for trying it on your app and one for setting up CI; everything else lives in collapsibles. Use after a Viewer or PR-comment change that the README shows, a new command or setting, or a release that made a README claim stale. Not for the docs/ guides or the shipped skills.
description: Refresh Expo Explore's README.md with euxy (github.com/brentvatne/euxy) as the reference app. Regenerate every screenshot and animated SVG in docs/screenshots from a current euxy review report and PR comment, then re-read the README as a first-time user: the top level only says what Explore does, links the live euxy example, gives one quick-start prompt to copy that reviews a change to your own app or explores a build you point it to, and one for setting up CI; everything else lives in collapsibles. Use after a Viewer or PR-comment change that the README shows, a new command or setting, or a release that made a README claim stale. Not for the docs/ guides or the shipped skills.
---
# Refresh the README
@@ -24,17 +24,25 @@ scripts/refresh-viewer-preview-fixtures.sh '<hosted link>' brentvatne/euxy#<n>
Do not pick a same-tree demo PR, where every change is noise. The refreshed fixtures reach the live example on the next push to main, or when you run **Example report** from GitHub Actions. `curl -s "<hosted link>/api/v1/screens?status=added,removed,modified&platform=ios"` lists what changed, which tells you which screen to select and compare.
## 2. Regenerate every screenshot
## 2. Regenerate every screenshot and animation
```sh
npm ci
node scripts/readme-screenshots.mjs --report ~/euxy-report/ios.zip --select /settings --compare patterns --pr https://github.com/brentvatne/euxy/pull/<n>
node scripts/readme-screenshots.mjs --report ~/euxy-report/ios.zip --select /about --compare patterns --pr https://github.com/brentvatne/euxy/pull/<n>
```
- `--select` is the route selected on the hero Map (the Inspector opens on it): choose an added or clearly modified screen.
- `--compare` is the key in the Viewer's `#/compare/<key>` URL for a **modified** screen with outlined regions (open the report, click the screen in Compare, copy the key). The script fails if the key is not in the report.
- `--select` is the route the hero's pointer clicks on the Map (the Inspector opens on it): choose an added or clearly modified screen. The script zooms in around it, so it must be a screen the Map shows.
- `--compare` is the key in the Viewer's `#/compare/<key>` URL for a **modified** screen with outlined regions (open the report, click the screen in Compare, copy the key): the route without its slash. The script fails if the report has no visually modified screen at that route.
- `--pr` screenshots the Explore comment on that PR: the fixtures' `source`. Headless Chromium needs a colour emoji font for the result glyphs (`sudo apt-get install fonts-noto-color-emoji` on Debian/Ubuntu); a comment with hollow boxes where 🟩 should be is not acceptable.
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` PNG for every shot (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right.
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` file for every picture (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right.
Two of the pictures are animated SVGs, built by `scripts/readme-animations.mjs` in the same run; there is nothing else to run when the screenshots change:
- `readme-hero-*.svg` is made of real Viewer frames at the zoomed Map camera: the Map without screens, the screens without edges, the whole Map, and the Map after the pointer clicks `--select`. The cards appear row by row, the edges wipe in from the top, then the pointer clicks and the Inspector slides in. Each is about 1.4 MB: four 2x JPEG frames inlined, since an SVG shown with `<img>` can load nothing. Anything the Viewer draws on the Map or in the Inspector shows up here on the next run, so regenerate it after a Viewer change the hero shows.
- `readme-compare-*.svg` is the `--compare` screen's base capture wiping to its head capture, with the report's changed regions pulsing. It is drawn from `review.json` and the report's assets, not from a Viewer screenshot, so a Viewer change does not stale it, but a new report does.
- Both loop on CSS keyframes, and with `prefers-reduced-motion` they hold the last frame: Inspector open, regions outlined. That frame is also what a viewer that does not animate SVG shows, so it must read on its own.
Open each SVG in a browser before committing, light and dark, and watch a full loop: every card should appear once and land where the whole Map has it, with no hover highlight in the frames before the click; the pointer should click the `--select` card; the Inspector should open on that screen; Compare's outlines should sit on the changed text, not beside it. To look at one moment, pause the animations in the console: `document.getAnimations().forEach(a => { a.pause(); a.currentTime = 5000; })`. Keep the README's `<img>` and `<source>` pointing at the `.svg` files.
`docs/screenshots/readme-exploration-light.png` is the black-box map and comes from a euxy `explore:binary` run (`npx @expo/explore explore:binary <euxy simulator build> --no-upload`, then `expo-explore view --dir <output>` at 1760×1000, Map, Fit canvas). It has no dark variant and is a plain Markdown image. Regenerate it when the Map's rendering of edges or labels changed; otherwise keep it, and say so in the PR.
@@ -53,18 +61,18 @@ cd - && npm run build:cli && node scripts/readme-reports-rows.mjs > /tmp/reports
- The script renders the picker as the CLI draws it (96 columns, the newest run selected) and writes the terminal body as HTML: each coloured piece is exactly its characters wide, so columns line up, and the wordmark is drawn as cell rectangles, since a design tool's font does not draw `█▀▄` cell for cell.
- In Paper, replace the frame named "Terminal" inside each artboard's window with that HTML, check both artboards in a screenshot (crisp wordmark, aligned columns, the selected row highlighted to the end, coloured counts), and export both at 2x as `readme-reports-light.png` and `readme-reports-dark.png`. The window's title bar reads `npx @expo/explore reports`, as people run it.
Look at every PNG you produced before committing, light and dark: the selected screen should be the one you asked for, the Compare view must show Before and After with outlines, the Screens grid must show the Added/Removed/Modified badges, the PR comment must show the heading links and result glyphs. Describe each in its Markdown alt text as what the picture shows, not what the feature is.
Look at every PNG you produced before committing, light and dark: the Screens grid must show the added, removed and modified status dots, the PR comment must show the heading links and result glyphs. Describe each in its Markdown alt text as what the picture shows, not what the feature is.
## 3. Pass over the content as a first-time user
Read the README top to bottom once without opening a collapsible. At that level it may only answer, in this order:
1. What Explore is (one short paragraph), the hero image, and the link to the live euxy example (`explore-example--euxy.expo.app`, redeployed on every merge to main by `.github/workflows/example-report.yml`).
2. **Try it on your app**: one sentence and a prompt to paste into Claude Code or Codex that gets a simulator build of any app (Expo or not, or just a build) and runs `explore:binary` on it. After its collapsibles, **Review a change before you push it**: one sentence, a prompt that runs `capture:review` locally (the explore-setup skill's "Review a change on this machine" section) on a set-up app, and the `reports` picker image (`readme-reports-*.png`) with one sentence on saved runs, at the top level, not inside a collapsible. Each section keeps its own "Run it yourself"; never put one section between another's prompt and its collapsibles.
3. **Set up CI**: one sentence, then two subsections, each a sentence on what it gives and a prompt to paste: **Review on every PR** (the setup prompt, then a few grouped collapsibles: Hosted previews first, then Manual setup (the setup prompt's steps done by hand, in order: setup, doctor, secrets, baseline, first PR), Capture modes: deterministic or agent, iOS, Android, or both, Keep your setup current) and **Compare any two commits** (a prompt that follows the explore-setup skill's "Compare any two commits" section, the ways to snapshot a release as bullets, then the comparison workflow collapsed).
4. **What you get**: the PR comment, Compare, and Screens, each a heading, one line, and its picture, then a prompt for asking an agent about a report.
1. What Explore is (one short paragraph), the hero image, and the link to the live euxy example (`explore-example--euxy.expo.app`, redeployed on every merge to main by `.github/workflows/example-report.yml`). Under it, Compare at full width with a one-line caption, then one table row of two pictures with a one-line caption each: Screens and the PR comment (which says it needs CI), then the agent prompt collapsed as **Ask an agent about a report**. The hero is the animated zoomed Map, framed as a window on a stage, and Compare is the animated wipe (both from `readme-animations.mjs`); the Screens and PR comment pictures are PNGs. Compare gets its own row because a phone wiping from before to after is unreadable at a third of the column.
2. **Quick start**: one path. A single prompt to paste into Claude Code or Codex that reviews a change to the reader's own Expo app through the explore-setup skill's "Review a change on this machine" section, or, when they point it to a build (or the app is not an Expo project), explores a simulator build through the explore-binary skill. Then one sentence on what each case needs (a review needs an Expo account, is built on EAS, and is captured on EAS Simulator or a local simulator; exploring a build needs a Claude Code or Codex login and EAS Simulator or a local simulator, and no Expo account locally), and under it one `> [!NOTE]` alert: EAS Simulator is in preview, with the waitlist link and `--simulator local` as the alternative. Then one **Run it yourself** collapsible with both by hand: the numbered steps for a review, with nothing optional in them (make the app buildable on EAS: login, init, bundle identifier, a simulator profile named `explore`, and commit, since the before build is the last commit; then edit a screen near its top and run `capture`, or `capture --simulator local`), and the `explore:binary` commands, including `--simulator local`. Right after **Run it yourself**, one `> [!WARNING]` alert: a review runs both commits' code on the reader's machine, so review only commits they would run. These are the README's only two alerts; do not add more, or they stop standing out. Then the `reports` picker image (`readme-reports-*.png`) with one sentence on saved runs, at the top level, and one collapsible for other commits (`--committed`, `--base`/`--head`) and what a review does on the machine. Run the steps on a fresh `create-expo-app` before changing them.
3. **Map every screen of any app**: one sentence on what exploring a build shows (pointing back to the quick start, which runs it), then its collapsibles: its options, exploring a session already started, and what a run without source shows.
4. **Set up CI**: one sentence, then two subsections, each a sentence on what it gives and a prompt to paste: **Review on every PR** (the setup prompt, then a few grouped collapsibles: Hosted previews first, then Manual setup (the setup prompt's steps done by hand, in order: setup, doctor, secrets, baseline, first PR), Capture modes: deterministic or agent, iOS, Android, or both, Keep your setup current) and **Compare any two commits** (a prompt that follows the explore-setup skill's "Compare any two commits" section, the ways to snapshot a release as bullets, then the comparison workflow collapsed).
Lead with prompts, not explanations: a reader should be able to copy something and see Explore work. Everything else, the manual commands, requirements, options, the manual setup, capture modes, hosted previews, iOS and Android, agent mode, repository settings, how agents read a report, how it works, limitations, contributing, goes into a `<details>` block under the section it belongs to, with a `<summary>` that says what the reader will find. Keep bullets to one or two sentences. Group related collapsibles rather than adding one per topic, so a section shows a handful, not nine. Requirements sit collapsed right under the example report link. Keep the collapsibles' `id` attributes that other docs link to (`#hosted-previews`, `#platforms`, `#compare`, `#agents`), and keep the Inspiration section (screenmap and Revyl's Atlas).
Lead with prompts, not explanations: a reader should be able to copy something and see Explore work. Everything else, the manual commands, requirements, options, the manual setup, capture modes, hosted previews, iOS and Android, agent mode, repository settings, how agents read a report, how it works, limitations, contributing, goes into a `<details>` block under the section it belongs to, with a `<summary>` that says what the reader will find. Keep bullets to one or two sentences. Group related collapsibles rather than adding one per topic, so a section shows a handful, not nine. Requirements sit collapsed right under the example report link. The **How it works** collapsible opens with a Mermaid `sequenceDiagram` of a PR review (pull request, GitHub Actions, EAS Build, EAS Simulator), followed by the facts it cannot show as bullets: who triggers a review, what Modified means, session retries. Check its steps against `CI-FLOW.md` and the `ci:*` commands, and edit the diagram's text, not a picture: GitHub draws it. Keep the collapsibles' `id` attributes that other docs link to (`#hosted-previews`, `#platforms`, `#compare`, `#agents`); the Terms and How agents read a report collapsibles live under Additional information, and keep the Inspiration section (screenmap and Revyl's Atlas).
Check that each prompt still works as written:
- the skill links it names (`https://unpkg.com/@expo/explore/skills/...`) are files the package ships (`files` in `package.json`), and they open from the published release;
+13 -5
View File
@@ -164,10 +164,13 @@ export async function readArchiveIcon(archive: InspectedArchive): Promise<Buffer
}
}
/** Explore's EAS Android emulator is x86_64 with no 32-bit support; an APK that ships only ARM or x86 libraries fails to install there. */
/**
* Explore's EAS Android emulator is x86_64 with no 32-bit support, and a local one runs this Mac's ABI; an APK that
* ships native libraries only for other ABIs fails to install there.
*/
export function assertEmulatorCompatible(archive: InspectedArchive, emulatorAbis: readonly string[] = ["x86_64"]): void {
if (archive.platform === "ios") {
if (!archive.simulator) throw archiveError("ARCHIVE_NOT_SIMULATOR", `${basename(archive.path)} is an iOS device build; it cannot run on the EAS Simulator.`,
if (!archive.simulator) throw archiveError("ARCHIVE_NOT_SIMULATOR", `${basename(archive.path)} is an iOS device build; it cannot run on a simulator.`,
"Build for the simulator (an EAS profile with ios.simulator: true) and pass that .app, .tar.gz, or simulator .ipa.");
return;
}
@@ -177,7 +180,7 @@ export function assertEmulatorCompatible(archive: InspectedArchive, emulatorAbis
}
if (archive.abis.length && !archive.abis.some(abi => emulatorAbis.includes(abi))) {
throw archiveError("ARCHIVE_ABI_UNSUPPORTED", `The APK ships native libraries only for ${archive.abis.join(", ")}; the emulator needs ${emulatorAbis.join(" or ")}.`,
"Build a universal APK or one that includes x86_64 native libraries.", { abis: archive.abis, emulatorAbis: [...emulatorAbis] });
`Build a universal APK or one that includes ${emulatorAbis[0]} native libraries.`, { abis: archive.abis, emulatorAbis: [...emulatorAbis] });
}
}
@@ -233,7 +236,7 @@ async function hashDirectory(root: string, maxBytes: number): Promise<{ sha256:
type TarVisitor = (entry: { name: string; type: string; size: number; mode: number }, contents: () => Promise<Buffer>, skip: () => Promise<void>) => Promise<boolean | void>;
/** Walk a gzip tarball once; `visit` returns true to stop. Long GNU names are honoured; nothing is written. */
async function walkTar(path: string, visit: TarVisitor): Promise<void> {
export async function walkTar(path: string, visit: TarVisitor): Promise<void> {
const stream = createReadStream(path).pipe(createGunzip());
const iterator = stream[Symbol.asyncIterator]();
let buffer = Buffer.alloc(0);
@@ -296,7 +299,7 @@ async function tarEntry(path: string, match: (name: string) => boolean): Promise
return found;
}
function safeRelativePath(name: string): string | undefined {
export function safeRelativePath(name: string): string | undefined {
const parts = name.replace(/^\.\//, "").split("/").filter(part => part.length);
if (!parts.length || parts.some(part => part === "." || part === ".." || part.includes("\\") || part.includes("\0"))) return undefined;
return parts.join("/");
@@ -372,6 +375,11 @@ class FileRangeReader extends Reader<unknown> {
const readers = new WeakMap<object, FileRangeReader>();
/** The ABIs an APK ships native libraries for (`lib/<abi>/`), without reading its manifest. */
export async function apkAbis(path: string): Promise<string[]> {
return [...new Set((await zipEntries(path)).map(entry => /^lib\/([^/]+)\//.exec(entry.filename)?.[1]).filter((abi): abi is string => !!abi))].sort();
}
async function zipEntries(path: string): Promise<ZipEntry[]> {
configure({ useWebWorkers: false });
const reader = new FileRangeReader(path);
+5 -5
View File
@@ -7,7 +7,7 @@ import type { CaptureSetupAction } from "../config/explore-config.js";
import { createExplorationInputs, explorationSecretNames } from "../config/exploration-inputs.js";
import type { ExploreStore, PreparedArtifact } from "../map/store.js";
import { CiError } from "../shared/ci-errors.js";
import type { ActionKind, ActionRisk, Artifact, ElementRole, ExploreMap, ObservedElement, Observation, Screen } from "../types.js";
import type { ActionKind, ActionRisk, Artifact, Controller, ElementRole, ExploreMap, ObservedElement, Observation, Screen } from "../types.js";
/** One look at the device: accessibility always, a PNG when the host could take a safe one. */
export type BlackBoxFrame = {
@@ -278,7 +278,7 @@ function markPressableGroups(nodes: readonly Record<string, unknown>[]): void {
}
}
export function elementsOf(nodes: readonly Record<string, unknown>[], allow: readonly string[]): Array<Omit<ObservedElement, "elementId">> {
export function elementsOf(nodes: readonly Record<string, unknown>[], allow: readonly string[], controller: Controller = "agent-device"): Array<Omit<ObservedElement, "elementId">> {
markPressableGroups(nodes);
const occurrences = new Map<string, number>();
const out: Array<Omit<ObservedElement, "elementId">> = [];
@@ -306,7 +306,7 @@ export function elementsOf(nodes: readonly Record<string, unknown>[], allow: rea
const occurrence = (occurrences.get(key) ?? 0) + 1;
occurrences.set(key, occurrence);
const rect = node.rect && typeof node.rect === "object" ? node.rect as Record<string, unknown> : undefined;
out.push({ role, label, ...(identifier ? { identifier } : {}), occurrence, controller: "agent-device",
out.push({ role, label, ...(identifier ? { identifier } : {}), occurrence, controller,
actions: role === "field" ? ["fill"] : role === "toggle" ? ["press"] : ["press"],
risk: riskOf(label, allow), actionable: true, enabled: node.enabled !== false, visible: true,
...(rect && typeof rect.x === "number" && typeof rect.y === "number" && typeof rect.width === "number" && typeof rect.height === "number"
@@ -497,7 +497,7 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
for (const part of loose) seen.parts.add(part);
seen.loadingOnly &&= loading;
evidence.set(screen.id, seen);
for (const element of elementsOf(frame.nodes, allow)) {
for (const element of elementsOf(frame.nodes, allow, map.run.controller)) {
const id = elementId(screen.id, element);
if (!screen.elementIds.includes(id)) {
screen.elementIds.push(id);
@@ -538,7 +538,7 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
}
screenshotArtifactId = artifact.id;
}
const elements = elementsOf(frame.nodes, allow).map(element => ({ elementId: elementId(screen.id, element), ...element }));
const elements = elementsOf(frame.nodes, allow, map.run.controller).map(element => ({ elementId: elementId(screen.id, element), ...element }));
const observation: Observation = { id: observationId, screenId: screen.id, variantId: variant.id, capturedAt: frame.capturedAt, surfaceScope: "app",
fingerprints: { combined: screenEvidenceKey(frame.nodes), accessibility: accessibilitySha, ...(screenshotArtifactId ? { visual: map.artifacts.find(item => item.id === screenshotArtifactId)!.sha256 } : {}) },
elementIds: elements.map(element => element.elementId), elements, accessibilityArtifactId: accessibilityArtifact.id, ...(screenshotArtifactId ? { screenshotArtifactId } : {}) };
+231 -89
View File
@@ -1,24 +1,29 @@
import { createHash, randomUUID } from "node:crypto";
import { createRequire } from "node:module";
import { lstat, mkdir, mkdtemp, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { createCiAgentSession, type CiAgentSession, type CiAgentSessionConfig } from "../capture/agent/session.js";
import { createLocalCiAgentSession } from "../capture/agent/session-local.js";
import type { CiAgentProviderName } from "../capture/agent/provider.js";
import { AGENT_DEVICE_VERSION, CONTROLLER_SESSION, baseEnvironment, isRecord } from "../capture/common.js";
import { CONTROLLER_SESSION, baseEnvironment, isRecord } from "../capture/common.js";
import { controllerData, defaultRunner, openedSimulatorDevice } from "../capture/controller.js";
import type { CommandRequest, CommandResult } from "../capture/run.js";
import { executeCaptureSetup } from "../capture/setup-actions.js";
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, assertSimulatorSessionIdentity, assertSimulatorStopped, readSimulatorDotenvHandoff,
assertAttachedSimulatorSession, resolveAttachedSimulatorSession, simulatorOsVersion, simulatorStartFailure, type ActiveSimulatorRuntime, type SimulatorConnection } from "../capture/simulator.js";
assertAttachedSimulatorSession, connectionController, controllerVersion, resolveAttachedSimulatorSession, simulatorOsVersion, simulatorStartFailure, type ActiveSimulatorRuntime, type SimulatorConnection } from "../capture/simulator.js";
import { argentControllerInvocation } from "../capture/controller-invocation.js";
import { agentDeviceLauncher, ensureArgentToolServer, ensureController } from "../shared/controller-cache.js";
import { agentDeviceClaims, approveLinkScheme, createLocalSimulator, deleteLocalEmulator, deleteLocalSimulator, hostEmulatorAbi, installOnLocalEmulator, installOnLocalSimulator, startLocalArgentServer,
startLocalEmulator, stopLocalAgentDevice, stopLocalArgentServer, waitForLocalEmulator, waitForLocalSimulator, type LocalArgentServer } from "../capture/local-simulator.js";
import { openLocalCaptureRecord, sweepLocalCaptures } from "../capture/local-registry.js";
import { approveSessionUrlSchemes, simulatorControlActions, type EasCommand } from "../capture/simulator-control.js";
import { DEFAULT_ANDROID_DEVICE } from "../config/explore-config.js";
import { createExplorationInputs } from "../config/exploration-inputs.js";
import { ExploreStore, getCoverage } from "../map/store.js";
import { whoamiAccounts } from "../report/preview-deploy.js";
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
import { packageBin } from "../shared/package-paths.js";
import { assertDecodedPng, type DecodedFrame } from "../shared/png-evidence.js";
import { assertDecodedPng, solidColour } from "../shared/png-evidence.js";
import { CONTRACT, type ExploreMap, type Platform } from "../types.js";
import { assertEmulatorCompatible, extractIosBundle, inspectArchive, type ArchiveKind, type InspectedArchive, readArchiveIcon } from "./archive.js";
import { runBlackBoxExploration, type BlackBoxExplorerResult, type BlackBoxFrame, SYSTEM_DIALOG_PACKAGES } from "./explorer.js";
@@ -46,6 +51,10 @@ export type BinaryExploreOptions = {
owner?: string;
/** EAS project slug the sessions run under; created on first use. */
project?: string;
/** The session's device controller; agent-device unless Argent is chosen. explore:session takes it from the session. */
controller?: "agent-device" | "argent";
/** Where the app runs: an EAS Simulator session (the default), or a simulator or emulator this run starts on this machine, with no EAS login. */
simulator?: "eas" | "local";
environment?: NodeJS.ProcessEnv;
runner?: typeof defaultRunner;
createSession?: (config: CiAgentSessionConfig, options: { env: NodeJS.ProcessEnv; auth: ModelAuth }) => CiAgentSession;
@@ -64,10 +73,19 @@ export type BinaryExploreResult = {
durationMs: number;
};
/** The command and environment that reach a session's controller: agent-device's CLI with its daemon, or the Argent bridge. */
type ControllerInvocation = { command: string; environment: NodeJS.ProcessEnv };
async function argentInvocation(connection: SimulatorConnection, work: string, platform: Platform, environment: NodeJS.ProcessEnv, bundleId?: string, device?: string): Promise<ControllerInvocation> {
return argentControllerInvocation({ directory: work, connection, platform, environment: baseEnvironment(environment), sourceEnvironment: environment, ...(bundleId ? { bundleId } : {}), ...(device ? { device } : {}) });
}
/** The daemon refuses a second session on a busy device; the caller's own `agent-device` session (from install/open) is reused instead. */
function daemonSessions(runner: typeof defaultRunner, connection: SimulatorConnection, work: string, platform: Platform, environment: NodeJS.ProcessEnv): { name: string; device: string }[] {
// Argent has no named sessions to share; its tool-server serves every caller.
if (connectionController(connection) === "argent") return [];
try {
const result = runner({ command: packageBin("agent-device", "agent-device"), args: ["session", "list", "--json"], cwd: work, timeoutMs: 60_000,
const result = runner({ command: agentDeviceLauncher(environment), args: ["session", "list", "--json"], cwd: work, timeoutMs: 60_000,
environment: { ...baseEnvironment(environment), AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken } });
const data = controllerData(result.stdout, "session list");
const sessions = Array.isArray(data.sessions) ? data.sessions : [];
@@ -119,11 +137,11 @@ const named = (apps: { bundleId: string | undefined; name: string | undefined }[
};
/** Finds the app to explore when the caller named none: the one the session has in the foreground, else the only user-installed app. */
export function resolveSessionApp(runner: typeof defaultRunner, connection: SimulatorConnection, work: string, platform: Platform, device: string, controllerSession: string | undefined, environment: NodeJS.ProcessEnv): { bundleId: string; name?: string } {
export function resolveSessionApp(runner: typeof defaultRunner, connection: SimulatorConnection, work: string, platform: Platform, device: string, controllerSession: string | undefined, environment: NodeJS.ProcessEnv, invocation?: ControllerInvocation): { bundleId: string; name?: string } {
const run = (args: string[]): Record<string, unknown> | undefined => {
try {
const result = runner({ command: packageBin("agent-device", "agent-device"), args: [...args, ...(platform === "ios" ? ["--device", device] : []), "--platform", platform, "--json"], cwd: work, timeoutMs: 60_000,
environment: { ...baseEnvironment(environment), AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken } });
const result = runner({ command: invocation?.command ?? agentDeviceLauncher(environment), args: [...args, ...(platform === "ios" ? ["--device", device] : []), "--platform", platform, "--json"], cwd: work, timeoutMs: 60_000,
environment: invocation?.environment ?? { ...baseEnvironment(environment), AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken } });
return controllerData(result.stdout, args[0]!);
} catch { return undefined; }
};
@@ -254,18 +272,37 @@ export type ConnectedSessionExploration = {
urlSchemes?: readonly string[];
/** The app's icon from the archive for the Viewer header. */
appIcon?: Buffer;
/**
* A simulator or emulator on this machine instead of an EAS session: the controller drives it by its UDID or adb
* serial (agent-device with a daemon of its own in `stateDirectory`, or a local Argent tool-server pinned to it).
*/
local?: { deviceId: string; osVersion: string; stateDirectory: string };
/** Runs once the app is installed and before anything opens it, as an EAS session's link approval must. */
afterInstall?: () => void;
};
/** Drives an agent-device daemon we already hold a connection to: optional install, open, then the model-led exploration. */
export async function exploreConnectedSession(ctx: ConnectedSessionExploration): Promise<{ runtime: ActiveSimulatorRuntime; exploration: BlackBoxExplorerResult }> {
const { connection, platform, device, bundleId, app, install, work, runner, environment, secrets, inputs, say, now, limits, store, map, model, sessionJson, launchUrl, hints, allowDestructive } = ctx;
const { connection, platform, device, bundleId, app, install, work, runner, environment, secrets, inputs, say, now, limits, store, map, model, sessionJson, launchUrl, hints, allowDestructive, local } = ctx;
const controllerSession = ctx.controllerSession ?? CONTROLLER_SESSION;
const controllerConfig = join(work, "agent-device.json");
await writeFile(controllerConfig, "{}\n", { flag: "wx", mode: 0o400 });
const controllerEnvironment = { ...baseEnvironment(environment), AGENT_DEVICE_CONFIG: controllerConfig, AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl,
AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken, AGENT_DEVICE_SESSION: controllerSession, AGENT_DEVICE_SESSION_LOCK: "reject", AGENT_DEVICE_PLATFORM: platform };
const agentDevice = packageBin("agent-device", "agent-device");
const deviceArgs = platform === "ios" ? ["--device", device] : [];
const controllerKind = connectionController(connection);
const controllerName = controllerKind === "argent" ? "Argent" : "agent-device";
if (controllerKind === "argent") await ensureController("argent", { environment, progress: say });
let agentDevice: string;
let controllerEnvironment: NodeJS.ProcessEnv;
if (controllerKind === "argent") {
({ command: agentDevice, environment: controllerEnvironment } = await argentInvocation(connection, work, platform, environment, bundleId, local?.deviceId));
} else {
const controllerConfig = join(work, "agent-device.json");
await writeFile(controllerConfig, "{}\n", { flag: "wx", mode: 0o400 });
// A local device has no EAS daemon: agent-device runs its own, in a state directory of this run's.
controllerEnvironment = { ...baseEnvironment(environment), AGENT_DEVICE_CONFIG: controllerConfig,
...(local ? { AGENT_DEVICE_STATE_DIR: local.stateDirectory } : { AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken }),
AGENT_DEVICE_SESSION: controllerSession, AGENT_DEVICE_SESSION_LOCK: "reject", AGENT_DEVICE_PLATFORM: platform };
agentDevice = agentDeviceLauncher(environment);
}
// A local device is named for Explore, so it is picked by its UDID or serial rather than its model name.
const deviceArgs = local ? [platform === "ios" ? "--udid" : "--serial", local.deviceId] : platform === "ios" ? ["--device", device] : [];
const controller = (args: string[], timeoutMs = 90_000): CommandResult => {
// Session flags go before a `--` separator so model-chosen text (`type -h`, a URL, a label) is never read as a flag.
const separator = args.indexOf("--");
@@ -275,22 +312,25 @@ export async function exploreConnectedSession(ctx: ConnectedSessionExploration):
};
const failureText = (error: unknown): string => lastLine(redactSecrets(error instanceof Error ? error.message : String(error), secrets)).slice(0, 400);
const version = runner({ command: agentDevice, args: ["--version"], cwd: work, environment: controllerEnvironment, timeoutMs: 30_000 }).stdout.trim();
if (version !== AGENT_DEVICE_VERSION) throw binaryError("EXPLORE_TOOLS_MISSING", `agent-device ${AGENT_DEVICE_VERSION} is required (found ${version || "none"}).`, "Reinstall @expo/explore.");
if (version !== controllerVersion(controllerKind)) throw binaryError("EXPLORE_TOOLS_MISSING", `${controllerName} ${controllerVersion(controllerKind)} is required (found ${version || "none"}).`, "Reinstall @expo/explore.");
if (install) {
say(`installing ${install.kind === "android-apk" ? "the APK" : "the app"} on session ${connection.sessionId}`);
try { controller(["install", install.path, "--json"], 15 * 60_000); }
catch (error) { throw binaryError("APP_INSTALL_FAILED", `agent-device could not install the app: ${failureText(error)}`, "Check that the archive is a simulator build for this platform and under the size limit, then rerun.", { sessionId: connection.sessionId }); }
catch (error) { throw binaryError("APP_INSTALL_FAILED", `${controllerName} could not install the app: ${failureText(error)}`, "Check that the archive is a simulator build for this platform and under the size limit, then rerun.", { sessionId: connection.sessionId }); }
}
const opened = controller(["open", bundleId, "--level", "full", "--json"], 2 * 60_000);
ctx.afterInstall?.();
// On a local device, the first open also builds agent-device's iOS runner.
const opened = controller(["open", bundleId, "--level", "full", "--json"], local ? 15 * 60_000 : 2 * 60_000);
const openedDevice = openedSimulatorDevice(opened.stdout, bundleId, "initial app open", platform, controllerSession);
const data = controllerData(opened.stdout, "initial app open");
const deviceData = data.device && typeof data.device === "object" ? data.device as Record<string, unknown> : {};
const observed = (key: string): string => { const value = deviceData[key] ?? data[key]; return typeof value === "string" && value.trim() ? value : "unknown"; };
const runtime = { provider: "eas-simulator", controller: "agent-device", controllerPackageVersion: AGENT_DEVICE_VERSION, easCliVersion: "unknown", platform, controllerDeviceId: openedDevice.deviceId,
deviceModel: openedDevice.deviceModel, osVersion: observed("osVersion"), locale: observed("locale"), orientation: observed("orientation") === "landscape" ? "landscape" : "portrait",
const runtime = { provider: local ? "local-simulator" : "eas-simulator", controller: controllerKind, controllerPackageVersion: controllerVersion(controllerKind), easCliVersion: "unknown", platform, controllerDeviceId: openedDevice.deviceId,
deviceModel: local ? device : openedDevice.deviceModel, osVersion: local ? local.osVersion : observed("osVersion"), locale: observed("locale"), orientation: observed("orientation") === "landscape" ? "landscape" : "portrait",
colorScheme: observed("colorScheme") === "dark" ? "dark" : "light" } as ActiveSimulatorRuntime;
try { runtime.osVersion = await simulatorOsVersion(sessionJson(), runtime.controllerDeviceId, fetch, platform); } catch { /* descriptive only */ }
// Argent's `open` reports the OS version itself (list-devices); agent-device's comes from the session's preview.
if (!local && (runtime.osVersion === "unknown" || controllerKind !== "argent")) try { runtime.osVersion = await simulatorOsVersion(sessionJson(), runtime.controllerDeviceId, fetch, platform); } catch { /* descriptive only */ }
map.run.deviceId = runtime.controllerDeviceId;
map.run.environment = { deviceModel: runtime.deviceModel, osVersion: runtime.osVersion, locale: runtime.locale, orientation: runtime.orientation, colorScheme: runtime.colorScheme };
map.run.status = "exploring";
@@ -474,7 +514,13 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
try { connection = await resolveAttachedSimulatorSession(environment, options.envFile, options.session); }
catch (error) {
throw binaryError("SESSION_NOT_PROVIDED", `No EAS Simulator session connection was found: ${error instanceof Error ? error.message : String(error)}`,
"Start one with `eas simulator:start --type agent-device --out-config-type dotenv` and run explore:session in that directory (or pass --env-file / set EAS_SIMULATOR_SESSION_ID, AGENT_DEVICE_DAEMON_BASE_URL and AGENT_DEVICE_DAEMON_AUTH_TOKEN).");
"Start one with `eas simulator:start --type agent-device --out-config-type dotenv` (or `--type argent`) and run explore:session in that directory (or pass --env-file / set EAS_SIMULATOR_SESSION_ID with AGENT_DEVICE_DAEMON_BASE_URL and AGENT_DEVICE_DAEMON_AUTH_TOKEN, or ARGENT_TOOLS_URL).");
}
const sessionController = connectionController(connection);
if (!options.runner) await ensureController(sessionController, { environment, progress: say });
if (options.controller && options.controller !== sessionController) {
throw binaryError("CONTROLLER_MISMATCH", `--controller ${options.controller} was passed, but the session is driven by ${sessionController}.`,
`Drop --controller, or start a session with \`eas simulator:start --type ${options.controller}\`.`, { sessionId: connection.sessionId });
}
if (!environment.EXPO_TOKEN?.trim() && !environment.EXPO_SESSION_SECRET?.trim() && !(await easLoggedIn(runner, environment))) {
throw binaryError("EXPO_LOGIN_REQUIRED", "No EAS login was found.", "Run `eas login` or set EXPO_TOKEN, then rerun explore:session.");
@@ -495,7 +541,7 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
let device = options.device ?? "";
const app = { name: options.appName ?? options.bundleId ?? "app", bundleId: options.bundleId ?? "app", ...(options.version ? { version: options.version } : {}) };
const secrets = [environment.EXPO_TOKEN ?? "", connection.daemonAuthToken, ...inputs.values].filter(Boolean);
const map: ExploreMap = { contract: CONTRACT, revision: 0, run: { id: randomUUID(), name: app.name, platform, controller: "agent-device", exploration: "black-box", bundleId: app.bundleId, status: "draft",
const map: ExploreMap = { contract: CONTRACT, revision: 0, run: { id: randomUUID(), name: app.name, platform, controller: sessionController, exploration: "black-box", bundleId: app.bundleId, status: "draft",
createdAt: new Date(now()).toISOString(), updatedAt: new Date(now()).toISOString(), build: { ...(app.version ? { version: app.version } : {}), source: "unknown" }, environment: {}, limits },
artifacts: [], screens: [], variants: [], observations: [], elements: [], actionAttempts: [], transitions: [], journeys: [], frontier: [], gaps: [] };
try {
@@ -504,7 +550,7 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
try { info = assertAttachedSimulatorSession(sessionJson(), connection, options.platform); }
catch (error) {
throw binaryError("SESSION_UNAVAILABLE", `EAS Simulator session ${connection.sessionId} cannot be explored: ${lastLine(redactSecrets(error instanceof Error ? error.message : String(error), secrets))}`,
"Check `eas simulator:list`; the session must be in progress, of type agent-device, and match the connection you passed.", { sessionId: connection.sessionId });
`Check \`eas simulator:list\`; the session must be in progress, of type ${sessionController}, and match the connection you passed.`, { sessionId: connection.sessionId });
}
platform = info.platform;
const candidates = daemonSessions(runner, connection, work, platform, environment).filter(item => !device || item.device === device);
@@ -514,7 +560,8 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
if (existing) say(`reusing agent-device session "${existing.name}" on ${existing.device}`);
device = device || existing?.device || (platform === "ios" ? DEFAULT_IOS_DEVICE : DEFAULT_ANDROID_DEVICE);
if (!options.bundleId) {
const resolved = resolveSessionApp(runner, connection, work, platform, device, existing?.name, environment);
const resolved = resolveSessionApp(runner, connection, work, platform, device, existing?.name, environment,
sessionController === "argent" ? await argentInvocation(connection, work, platform, environment) : undefined);
app.bundleId = resolved.bundleId;
if (!options.appName) app.name = resolved.name ?? app.bundleId;
map.run.bundleId = app.bundleId;
@@ -542,6 +589,75 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
}
}
type LocalDevice = NonNullable<ConnectedSessionExploration["local"]>;
/**
* Starts a simulator or emulator on this machine for one run, installs the app, and hands the explorer a connection
* to it; everything is stopped afterwards. They are the devices `capture --simulator local` starts, recorded the same
* way, so the next local run stops what a run stopped hard left behind.
*/
async function withLocalDevice(options: { archive: InspectedArchive; installPath: string; platform: Platform; device: string; bundleId: string;
controller: "agent-device" | "argent"; tag: string; work: string; runner: typeof defaultRunner; environment: NodeJS.ProcessEnv; secrets: readonly string[]; say: (message: string) => void; now?: () => number },
explore: (connection: SimulatorConnection, local: LocalDevice) => Promise<void>): Promise<void> {
const { archive, installPath, platform, device, bundleId, controller, tag, work, runner, say } = options;
const environment = baseEnvironment(options.environment);
const agentDevice = agentDeviceLauncher(options.environment);
const stateDirectory = join(work, "agent-device-state");
const record = await openLocalCaptureRecord(options.environment, work);
let udid: string | undefined, serial: string | undefined, argent: LocalArgentServer | undefined;
let primaryError: unknown;
try {
let osVersion: string;
if (platform === "ios") {
say(`starting a local ${device} simulator`);
const created = await createLocalSimulator({ runner, device, name: `Explore ${device} (binary ${tag})`, cwd: work, environment,
created: async id => { udid = id; await record.update({ udid: id }); } });
osVersion = created.osVersion;
waitForLocalSimulator({ runner, udid: created.udid, cwd: work, environment });
// Links in the app's own schemes open without iOS asking first.
for (const scheme of archive.urlSchemes) approveLinkScheme({ runner, udid: created.udid, scheme, bundleId, cwd: work, environment });
say("installing the app");
installOnLocalSimulator({ runner, udid: created.udid, app: installPath, cwd: work, environment });
} else {
say(`starting a local ${device} emulator`);
const name = `explore-binary-${tag}`;
const started = await startLocalEmulator({ runner, device, name, directory: work, cwd: work, environment,
...(controller === "agent-device" ? { claimed: (candidate: string) => agentDeviceClaims({ runner, agentDevice, serial: candidate, cwd: work, environment }) } : {}),
started: async id => { serial = id; await record.update({ serial: id, avd: name }); } });
osVersion = waitForLocalEmulator({ runner, serial: started.serial, device, apiLevel: started.apiLevel, directory: work, cwd: work, environment, ...(options.now ? { now: options.now } : {}) });
say("installing the APK");
installOnLocalEmulator({ runner, serial: started.serial, apk: installPath, cwd: work, environment });
}
const deviceId = (udid ?? serial)!;
let connection: SimulatorConnection = { sessionId: `local-${deviceId}`, daemonBaseUrl: "", daemonAuthToken: "" };
if (controller === "argent") {
// Argent drives the device through a tool-server of this run's own.
const cli = await ensureArgentToolServer({ environment: options.environment, progress: say });
argent = await startLocalArgentServer({ runner, cli, directory: work, cwd: work, environment, ...(options.now ? { now: options.now } : {}) });
await record.update({ argent: { pid: argent.pid, cli: argent.cli, home: argent.home } });
connection = { ...connection, daemonBaseUrl: argent.url, daemonAuthToken: argent.token, controller: "argent" };
}
await explore(connection, { deviceId, osVersion, stateDirectory });
} catch (error) { primaryError = error; throw error; }
finally {
try {
if (argent) stopLocalArgentServer(argent);
// Its own agent-device daemon lets go of the device before it goes.
if (controller === "agent-device") runner({ command: agentDevice, args: ["close", "--session", CONTROLLER_SESSION, "--json"], cwd: work,
environment: { ...environment, AGENT_DEVICE_STATE_DIR: stateDirectory }, timeoutMs: 60_000, allowFailure: true });
await stopLocalAgentDevice(stateDirectory);
if (serial) { say(`stopping the local emulator ${serial}`); await deleteLocalEmulator({ runner, serial, cwd: work, environment }); }
if (udid) { say(`deleting the local simulator ${udid}`); deleteLocalSimulator({ runner, udid, cwd: work, environment }); }
// Everything is stopped; a cleanup that threw leaves the record for the next run's sweep.
await record.close();
} catch (error) {
throw new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup", message: `The local ${serial ? "emulator" : "simulator"} Explore started could not be stopped.`,
nextAction: serial ? `Stop it with: adb -s ${serial} emu kill` : udid ? `Delete it with: xcrun simctl delete ${udid}` : "Rerun explore:binary --simulator local; it stops what this run left.",
details: { ...(serial ? { serial } : {}), ...(udid ? { udid } : {}), ...(primaryError ? { originalFailure: serializeCiError(primaryError, { secrets: options.secrets }) } : {}) }, cause: error });
}
}
}
export async function runBinaryExploration(options: BinaryExploreOptions): Promise<BinaryExploreResult> {
const startedAt = Date.now();
const now = options.now ?? Date.now;
@@ -550,18 +666,21 @@ export async function runBinaryExploration(options: BinaryExploreOptions): Promi
const runner = options.runner ?? defaultRunner;
const limits = validatedLimits(options);
const inputs = hintInputs(options.hints, environment);
const local = options.simulator === "local";
// A local emulator runs this Mac's ABI (arm64-v8a on Apple silicon); EAS's runs x86_64.
const emulatorAbi = local ? hostEmulatorAbi() : "x86_64";
say("inspecting the archive");
const archive = await inspectArchive(options.archive);
assertEmulatorCompatible(archive);
assertEmulatorCompatible(archive, [emulatorAbi]);
if (options.platform && options.platform !== archive.platform) throw binaryError("ARCHIVE_PLATFORM_MISMATCH", `The archive is an ${archive.platform} build but --platform ${options.platform} was requested.`, "Drop --platform or pass a matching archive.");
if (!environment.EXPO_TOKEN?.trim() && !environment.EXPO_SESSION_SECRET?.trim() && !(await easLoggedIn(runner, environment))) {
if (!local && !environment.EXPO_TOKEN?.trim() && !environment.EXPO_SESSION_SECRET?.trim() && !(await easLoggedIn(runner, environment))) {
throw binaryError("EXPO_LOGIN_REQUIRED", "No EAS login was found.", "Run `eas login` or set EXPO_TOKEN, then rerun explore:binary.");
}
const platform = archive.platform;
const bundleId = options.bundleId ?? archive.bundleId;
const device = options.device ?? (platform === "ios" ? DEFAULT_IOS_DEVICE : DEFAULT_ANDROID_DEVICE);
say(`${archive.appName} ${archive.version ?? ""} (${bundleId}, ${platform}, ${(archive.bytes / 1048576).toFixed(0)} MB, sha256 ${archive.sha256.slice(0, 12)})`);
if (archive.missingLibs?.length) say(`warning: lib/x86_64 lacks ${archive.missingLibs.slice(0, 4).join(", ")}${archive.missingLibs.length > 4 ? ` and ${archive.missingLibs.length - 4} more` : ""} that another ABI ships; the app may stop with UnsatisfiedLinkError on the emulator`);
if (archive.missingLibs?.length && emulatorAbi === "x86_64") say(`warning: lib/x86_64 lacks ${archive.missingLibs.slice(0, 4).join(", ")}${archive.missingLibs.length > 4 ? ` and ${archive.missingLibs.length - 4} more` : ""} that another ABI ships; the app may stop with UnsatisfiedLinkError on the emulator`);
const model = await preflightModelSession(options, environment, say);
@@ -571,7 +690,7 @@ export async function runBinaryExploration(options: BinaryExploreOptions): Promi
const work = await realpath(await mkdtemp(join(tmpdir(), "expo-explore-binary-")));
const easEnvironment = { ...baseEnvironment(environment), ...(environment.EXPO_TOKEN ? { EXPO_TOKEN: environment.EXPO_TOKEN } : {}), ...(environment.HOME ? { HOME: environment.HOME } : {}), CI: "1", EXPO_NO_TELEMETRY: "1" };
const easBin = packageBin("eas-cli", "eas");
await lstat(easBin).catch(() => { throw binaryError("EXPLORE_TOOLS_MISSING", "The EAS CLI that Explore pins is not installed.", "Reinstall @expo/explore with optional dependencies."); });
if (!local) await lstat(easBin).catch(() => { throw binaryError("EXPLORE_TOOLS_MISSING", "The EAS CLI that Explore pins is not installed.", "Reinstall @expo/explore with optional dependencies."); });
const eas = (args: string[], timeoutMs = 5 * 60_000): CommandResult & { status: number } => {
try { return { ...runner({ command: process.execPath, args: [easBin, ...args], cwd: work, environment: easEnvironment, timeoutMs }), status: 0 }; }
catch (error) { return { stdout: "", stderr: error instanceof Error ? error.message : String(error), status: 1 }; }
@@ -582,64 +701,98 @@ export async function runBinaryExploration(options: BinaryExploreOptions): Promi
let exploration: BlackBoxExplorerResult | undefined;
let owner = options.owner ?? "";
const project = options.project ?? DEFAULT_BINARY_PROJECT;
const map: ExploreMap = { contract: CONTRACT, revision: 0, run: { id: randomUUID(), name: archive.appName, platform, controller: "agent-device", exploration: "black-box", bundleId, status: "draft",
const controller = options.controller ?? "agent-device";
// Fetched before the paid session starts, so a blocked download costs nothing.
if (!options.runner) await ensureController(controller, { environment, progress: say });
if (local) {
// What an earlier local run stopped hard left running (a simulator, an emulator, a daemon) goes first.
const swept = await sweepLocalCaptures({ environment, runner, cwd: work }).catch(() => [] as string[]);
if (swept.length) say(`stopped what an interrupted local run left running: ${swept.join(", ")}`);
}
const map: ExploreMap = { contract: CONTRACT, revision: 0, run: { id: randomUUID(), name: archive.appName, platform, controller, exploration: "black-box", bundleId, status: "draft",
createdAt: new Date(now()).toISOString(), updatedAt: new Date(now()).toISOString(),
build: { ...(archive.version ? { version: archive.version } : {}), ...(archive.buildNumber ? { number: archive.buildNumber } : {}), hash: archive.sha256, source: "local" },
environment: { deviceModel: device }, limits }, artifacts: [], screens: [], variants: [], observations: [], elements: [], actionAttempts: [], transitions: [], journeys: [], frontier: [], gaps: [] };
try {
let installPath = archive.path;
if (archive.kind === "ios-tgz" || archive.kind === "ios-ipa") { say("unpacking the iOS bundle"); installPath = await extractIosBundle(archive, join(work, "bundle")); }
if (!owner) {
const who = eas(["whoami"], 60_000);
owner = who.status === 0 ? whoamiAccounts(who.stdout)[0] ?? "" : "";
if (!owner) throw binaryError("EXPO_LOGIN_REQUIRED", "EAS did not report an account for this login.", "Run `eas login` (or set EXPO_TOKEN) and rerun, or pass --owner.");
}
await writeFile(join(work, "package.json"), JSON.stringify({ name: project, version: "0.0.0", private: true }), { mode: 0o600 });
await writeFile(join(work, "app.json"), JSON.stringify({ expo: { name: project, slug: project, owner, web: { output: "server" } } }), { mode: 0o600 });
const init = eas(["init", "--force", "--non-interactive", "--json"], 2 * 60_000);
const appJson = JSON.parse(await readFile(join(work, "app.json"), "utf8")) as { expo?: { extra?: { eas?: { projectId?: string } } } };
const projectId = appJson.expo?.extra?.eas?.projectId;
if (init.status !== 0 || !projectId) throw binaryError("EXPLORE_PROJECT_FAILED", `EAS could not create or link @${owner}/${project}: ${lastLine(init.stderr || init.stdout)}`,
"Give this login permission to create projects under the owner, or pass --project with an existing slug.", { owner, project });
const projectIdentity = { name: project, slug: project, owner, projectId };
say(`starting an EAS Simulator session (${device}, ${limits.maxDurationMinutes} min)`);
const sessionName = `explore-binary-${createHash("sha256").update(`${archive.sha256}:${map.run.id}`).digest("hex").slice(0, 16)}`;
const dotenvPath = join(work, SIMULATOR_DOTENV_FILE_NAME);
await writeFile(dotenvPath, SIMULATOR_DOTENV_HEADER, { flag: "wx", mode: 0o600 });
let startError: unknown;
try {
const started = eas(["simulator:start", "--name", sessionName, "--platform", platform, "--device", device, "--type", "agent-device", "--package-version", AGENT_DEVICE_VERSION,
"--max-duration-minutes", String(limits.maxDurationMinutes + 5), "--out-config-type", "dotenv", "--non-interactive"], 20 * 60_000);
if (started.status !== 0) throw new Error(started.stderr || started.stdout || "eas simulator:start failed");
} catch (error) { startError = error; }
const handoff = await readSimulatorDotenvHandoff(dotenvPath);
const secrets = [environment.EXPO_TOKEN ?? "", ...(handoff.connection ? [handoff.connection.daemonAuthToken] : []), ...inputs.values].filter(Boolean);
const startFailure = startError ? simulatorStartFailure(startError, secrets) : undefined;
if (handoff.sessionId) {
try { assertSimulatorSessionIdentity(eas(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout, handoff.sessionId, sessionName, projectIdentity, handoff.connection, platform); }
catch (error) { throw new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session", message: "The EAS handoff could not prove ownership of the exact simulator session. The private handoff was preserved.",
nextAction: "Inspect the EAS session list; confirm ownership before stopping the reported session.", details: { handoffDirectory: work, reportedSessionId: handoff.sessionId, ...(startFailure ? { startFailure } : {}) }, cause: error }); }
sessionId = handoff.sessionId;
}
if (!sessionId) throw new CiError({ code: startFailure ? "SIMULATOR_START_FAILED" : "SESSION_HANDOFF_UNVERIFIED", stage: "session",
message: startFailure ? `EAS simulator:start failed: ${startFailure.message}` : "EAS did not provide a verifiable simulator session.",
nextAction: "Inspect the EAS start failure and session list; verify a session's exact ID and ownership before cleanup.", details: { handoffDirectory: work, ...(startFailure ? { startFailure } : {}) }, cause: startError });
if (startFailure) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session", message: `EAS simulator:start failed after the session was verified: ${startFailure.message}`,
nextAction: "Inspect the start failure; Explore stops the verified session before returning.", details: { sessionId, startFailure }, cause: startError });
if (handoff.validationError) throw handoff.validationError;
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
await rm(dotenvPath, { force: true });
const appIcon = await readArchiveIcon(archive);
({ runtime, exploration } = await exploreConnectedSession({ connection: handoff.connection, platform, device, bundleId, ...(appIcon ? { appIcon } : {}), app: { name: archive.appName, ...(archive.version ? { version: archive.version } : {}) },
install: { path: installPath, kind: archive.kind }, work, runner, environment, secrets, inputs, say, now, limits, store, map, model, urlSchemes: archive.urlSchemes,
sessionJson: () => eas(["simulator:get", "--id", handoff.connection!.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
...(options.launchUrl ? { launchUrl: options.launchUrl } : {}), ...(options.hints ? { hints: options.hints } : {}), ...(options.allowDestructive ? { allowDestructive: options.allowDestructive } : {}) }));
const exploreOn = (connection: SimulatorConnection, sessionJson: () => string, localDevice?: LocalDevice, afterInstall?: () => void) => exploreConnectedSession({ connection, platform, device, bundleId,
...(afterInstall ? { afterInstall } : {}),
...(appIcon ? { appIcon } : {}), app: { name: archive.appName, ...(archive.version ? { version: archive.version } : {}) },
// A local device has the app installed by simctl or adb before the controller starts.
...(localDevice ? { local: localDevice } : { install: { path: installPath, kind: archive.kind } }),
work, runner, environment, secrets: [environment.EXPO_TOKEN ?? "", connection.daemonAuthToken, ...inputs.values].filter(Boolean), inputs, say, now, limits, store, map, model,
urlSchemes: archive.urlSchemes, sessionJson,
...(options.launchUrl ? { launchUrl: options.launchUrl } : {}), ...(options.hints ? { hints: options.hints } : {}), ...(options.allowDestructive ? { allowDestructive: options.allowDestructive } : {}) });
if (local) {
const tag = map.run.id.replace(/-/g, "").slice(0, 8);
await withLocalDevice({ archive, installPath, platform, device, bundleId, controller, tag, work, runner, environment, say, secrets: inputs.values, ...(options.now ? { now: options.now } : {}) },
async (connection, localDevice) => {
sessionId = connection.sessionId;
({ runtime, exploration } = await exploreOn(connection, () => "", localDevice));
});
} else {
if (!owner) {
const who = eas(["whoami"], 60_000);
owner = who.status === 0 ? whoamiAccounts(who.stdout)[0] ?? "" : "";
if (!owner) throw binaryError("EXPO_LOGIN_REQUIRED", "EAS did not report an account for this login.", "Run `eas login` (or set EXPO_TOKEN) and rerun, or pass --owner.");
}
await writeFile(join(work, "package.json"), JSON.stringify({ name: project, version: "0.0.0", private: true }), { mode: 0o600 });
await writeFile(join(work, "app.json"), JSON.stringify({ expo: { name: project, slug: project, owner, web: { output: "server" } } }), { mode: 0o600 });
const init = eas(["init", "--force", "--non-interactive", "--json"], 2 * 60_000);
const appJson = JSON.parse(await readFile(join(work, "app.json"), "utf8")) as { expo?: { extra?: { eas?: { projectId?: string } } } };
const projectId = appJson.expo?.extra?.eas?.projectId;
if (init.status !== 0 || !projectId) throw binaryError("EXPLORE_PROJECT_FAILED", `EAS could not create or link @${owner}/${project}: ${lastLine(init.stderr || init.stdout)}`,
"Give this login permission to create projects under the owner, or pass --project with an existing slug.", { owner, project });
const projectIdentity = { name: project, slug: project, owner, projectId };
say(`starting an EAS Simulator session (${device}, ${limits.maxDurationMinutes} min)`);
const sessionName = `explore-binary-${createHash("sha256").update(`${archive.sha256}:${map.run.id}`).digest("hex").slice(0, 16)}`;
const dotenvPath = join(work, SIMULATOR_DOTENV_FILE_NAME);
await writeFile(dotenvPath, SIMULATOR_DOTENV_HEADER, { flag: "wx", mode: 0o600 });
let startError: unknown;
try {
const started = eas(["simulator:start", "--name", sessionName, "--platform", platform, "--device", device, "--type", controller, "--package-version", controllerVersion(controller), "--public-link",
"--max-duration-minutes", String(limits.maxDurationMinutes + 5), "--out-config-type", "dotenv", "--non-interactive"], 20 * 60_000);
if (started.status !== 0) throw new Error(started.stderr || started.stdout || "eas simulator:start failed");
} catch (error) { startError = error; }
const handoff = await readSimulatorDotenvHandoff(dotenvPath);
const secrets = [environment.EXPO_TOKEN ?? "", ...(handoff.connection ? [handoff.connection.daemonAuthToken] : []), ...inputs.values].filter(Boolean);
const startFailure = startError ? simulatorStartFailure(startError, secrets) : undefined;
if (handoff.sessionId) {
try { assertSimulatorSessionIdentity(eas(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout, handoff.sessionId, sessionName, projectIdentity, handoff.connection, platform); }
catch (error) { throw new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session", message: "The EAS handoff could not prove ownership of the exact simulator session. The private handoff was preserved.",
nextAction: "Inspect the EAS session list; confirm ownership before stopping the reported session.", details: { handoffDirectory: work, reportedSessionId: handoff.sessionId, ...(startFailure ? { startFailure } : {}) }, cause: error }); }
sessionId = handoff.sessionId;
}
if (!sessionId) throw new CiError({ code: startFailure ? "SIMULATOR_START_FAILED" : "SESSION_HANDOFF_UNVERIFIED", stage: "session",
message: startFailure ? `EAS simulator:start failed: ${startFailure.message}` : "EAS did not provide a verifiable simulator session.",
nextAction: "Inspect the EAS start failure and session list; verify a session's exact ID and ownership before cleanup.", details: { handoffDirectory: work, ...(startFailure ? { startFailure } : {}) }, cause: startError });
if (startFailure) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session", message: `EAS simulator:start failed after the session was verified: ${startFailure.message}`,
nextAction: "Inspect the start failure; Explore stops the verified session before returning.", details: { sessionId, startFailure }, cause: startError });
if (handoff.validationError) throw handoff.validationError;
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
await rm(dotenvPath, { force: true });
// The app's own links open without iOS asking first, when the session's host can approve them (serve-sim 0.10.0).
const verifiedSession = sessionId;
const sessionEas: EasCommand = (args, commandOptions) => {
const result = eas(args, commandOptions?.timeoutMs);
if (result.status !== 0 && !commandOptions?.allowFailure) throw new Error(lastLine(result.stderr || result.stdout) || `eas ${args[0]} failed`);
return result;
};
const afterInstall = platform === "ios" && archive.urlSchemes.length ? () => {
const approved = approveSessionUrlSchemes(sessionEas, verifiedSession, simulatorControlActions(sessionEas, verifiedSession), bundleId, archive.urlSchemes);
if (approved.length) say(`approved ${approved.map(item => `${item}://`).join(", ")} links on the session`);
} : undefined;
({ runtime, exploration } = await exploreOn(handoff.connection, () => eas(["simulator:get", "--id", handoff.connection!.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout, undefined, afterInstall));
}
} catch (error) {
primaryError = toCiError(error, { code: "EXPLORE_BINARY_FAILED", stage: "exploration", nextAction: "Inspect the diagnostic, correct the failing prerequisite, and rerun explore:binary." });
} finally {
if (sessionId) {
// A local device is stopped by withLocalDevice; only the work directory is left.
if (local) await rm(work, { recursive: true, force: true });
else if (sessionId) {
try {
say(`stopping simulator session ${sessionId}`);
assertSimulatorStopped(eas(["simulator:stop", "--id", sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout, sessionId);
@@ -701,18 +854,7 @@ export function assertAppUrl(url: string, appSchemes: readonly string[] = []): v
export const BLANK_SCREENSHOT_MESSAGE = "The app blocks screen capture on this screen (Android FLAG_SECURE), so its screenshot came back blank.";
/** A capture-protected screen comes back as a single flat colour (black on Android); every 97th pixel is enough to tell. */
export function solidColour(png: Buffer): boolean {
let frame: DecodedFrame;
try { frame = createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs").PNG.sync.read(png, { checkCRC: false }) as DecodedFrame; }
catch { return false; }
const { data } = frame;
if (data.length < 4) return false;
for (let offset = 0; offset + 3 < data.length; offset += 4 * 97) {
if (data[offset] !== data[0] || data[offset + 1] !== data[1] || data[offset + 2] !== data[2]) return false;
}
return true;
}
export { solidColour };
/** Setup commands whose last positional is free text (`fill <ref> <text>`, `type <text>`): move the flags ahead of a `--` separator. */
export function guardPositionals(args: readonly string[]): string[] {
+15
View File
@@ -18,6 +18,19 @@ export function resolveColorSchemes(appearance: AppearanceSetting, appConfig: Re
return ["light"];
}
/**
* What an Argent capture renders: one pass, since Argent cannot switch the device's appearance yet
* (software-mansion/argent#1509). An app that forces a style renders it on any device; any other app renders as the
* fresh simulator starts, light. Requested schemes that pass cannot show are reported as skipped.
*/
export function argentColorSchemes(requested: readonly ColorScheme[], appConfig: Record<string, unknown> | undefined, platform: string): { schemes: ColorScheme[]; skipped: ColorScheme[] } {
const platformConfig = appConfig?.[platform];
const declared = (platformConfig && typeof platformConfig === "object" ? (platformConfig as Record<string, unknown>).userInterfaceStyle : undefined)
?? appConfig?.userInterfaceStyle;
const scheme: ColorScheme = declared === "dark" ? "dark" : "light";
return { schemes: [scheme], skipped: requested.filter(item => item !== scheme) };
}
export function parseAppearance(value: unknown, path: string): AppearanceSetting {
if (value === undefined || value === "auto") return "auto";
const list = Array.isArray(value) ? value : [value];
@@ -69,6 +82,8 @@ export function mergeSchemeOutcomes(passes: readonly Record<string, CaptureOutco
// frame too: the review then shows that appearance and marks the primary one unavailable, instead of nothing.
if (verified(outcome)) {
if (scheme && !(primary && primary.status === "captured")) merged[schemeScreenId(id, scheme)] = outcome;
// Its note (setup that did not complete in that appearance) stays with the route the frame is published under.
else if (outcome.reason && merged[id]) merged[id] = { ...merged[id], reason: [merged[id].reason, scheme ? `In ${scheme}: ${outcome.reason}` : outcome.reason].filter(Boolean).join(" ") };
continue;
}
if (scheme && primary && primary.status === "captured") merged[schemeScreenId(id, scheme)] = outcome;
+99
View File
@@ -0,0 +1,99 @@
/**
* Runs the Argent bridge's commands on a worker thread of this process, through a synchronous runner, so the
* capture's command-at-a-time control flow keeps one bridge and one tool-server connection for the whole run
* instead of starting a process per command. Commands for any other executable go to the fallback runner.
*/
import { Worker } from "node:worker_threads";
import { commandOutcome } from "./controller.js";
import type { CommandRequest, CommandResult, CommandRunner } from "./run.js";
import { BRIDGE_HEADER_BYTES, BRIDGE_KIND_UNAVAILABLE, BRIDGE_SLOT_KIND, BRIDGE_SLOT_LENGTH, BRIDGE_SLOT_READY, type BridgeRequest, type BridgeWorkerData } from "./argent-bridge-worker.js";
/** Room for one answer: an accessibility tree of a large screen is a few megabytes. */
const BRIDGE_BUFFER_BYTES = 64 * 1024 * 1024;
/** How long a command gets when its request names no timeout. */
const DEFAULT_COMMAND_TIMEOUT_MS = 10 * 60_000;
/** After a timeout, how long the thread gets to confirm it dropped the command. */
const ABORT_GRACE_MS = 15_000;
export type ArgentBridgeRunner = {
runner: CommandRunner;
/** Whether commands still go to the thread (false after it proved unavailable or stopped answering). */
readonly active: boolean;
close(): void;
};
export function startArgentBridgeRunner(options: {
/** The bridge executable the callers name; its commands run on the thread. */
command: string;
/** The bridge's environment, as argentControllerInvocation builds it. */
environment: NodeJS.ProcessEnv;
fallback: CommandRunner;
/** Tests: a module exporting `createArgentClient` in place of the pinned Argent release's client. */
clientModule?: string;
progress?: (message: string) => void;
}): ArgentBridgeRunner {
const shared = new SharedArrayBuffer(BRIDGE_HEADER_BYTES + BRIDGE_BUFFER_BYTES);
const header = new Int32Array(shared, 0, BRIDGE_HEADER_BYTES / 4);
const bytes = new Uint8Array(shared, BRIDGE_HEADER_BYTES);
const workerData: BridgeWorkerData = { shared, ...(options.clientModule ? { clientModule: options.clientModule } : {}) };
let worker: Worker | undefined;
// The environment the thread runs with: a copy, so a caller that changes the session's (a restarted local
// tool-server's URL and token) is seen by the next command, which starts a thread with the new one.
let environment: NodeJS.ProcessEnv = {};
const start = (from: NodeJS.ProcessEnv) => {
environment = { ...from };
try {
const started = new Worker(new URL("./argent-bridge-worker.js", import.meta.url), { workerData, env: environment });
// A thread that crashes stops serving; the commands after it run per command.
started.on("error", error => { if (worker === started) stop(`the Argent bridge thread failed (${error.message}); running the bridge per command`); });
worker = started;
} catch (error) { options.progress?.(`the Argent bridge thread could not start (${(error as Error).message}); running the bridge per command`); }
};
let sequence = 0;
const stop = (reason: string) => {
if (!worker) return;
options.progress?.(reason);
void worker.terminate();
worker = undefined;
};
const changed = (next: NodeJS.ProcessEnv) => {
const keys = new Set([...Object.keys(environment), ...Object.keys(next)]);
return [...keys].some(key => environment[key] !== next[key]);
};
const waitFor = (id: number, timeoutMs: number): boolean => {
const deadline = Date.now() + timeoutMs;
for (;;) {
// The value waited on is the one just compared: an answer stored after the comparison wakes the wait at once.
const ready = Atomics.load(header, BRIDGE_SLOT_READY);
if (ready === id) return true;
const remaining = deadline - Date.now();
if (remaining <= 0) return false;
Atomics.wait(header, BRIDGE_SLOT_READY, ready, remaining);
}
};
start(options.environment);
const runner: CommandRunner = (request: CommandRequest): CommandResult => {
// A recording runs per command, in the session's own directory: Argent's client saves one under the project its
// working directory is in, and this thread's is the caller's checkout. The state file carries it between hosts.
if (!worker || request.command !== options.command || request.args[0] === "record") return options.fallback(request);
if (changed(request.environment)) { void worker.terminate(); worker = undefined; start(request.environment); }
if (!worker) return options.fallback(request);
const id = ++sequence;
Atomics.store(header, BRIDGE_SLOT_READY, 0);
worker.postMessage({ id, argv: request.args, ...(request.timeoutMs !== undefined ? { timeoutMs: request.timeoutMs } : {}) } satisfies BridgeRequest);
const timeoutMs = request.timeoutMs ?? DEFAULT_COMMAND_TIMEOUT_MS;
if (!waitFor(id, timeoutMs)) {
worker.postMessage({ abort: id } satisfies BridgeRequest);
if (!waitFor(id, ABORT_GRACE_MS)) stop("the Argent bridge thread stopped answering; running the bridge per command");
throw Object.assign(new Error(`${request.command} ${request.args[0] ?? ""} timed out after ${timeoutMs} ms`), { code: "ETIMEDOUT" });
}
const text = Buffer.from(bytes.subarray(0, Atomics.load(header, BRIDGE_SLOT_LENGTH))).toString("utf8");
if (Atomics.load(header, BRIDGE_SLOT_KIND) === BRIDGE_KIND_UNAVAILABLE) {
stop(`the Argent bridge thread is unavailable (${text}); running the bridge per command`);
return options.fallback(request);
}
const result = JSON.parse(text) as { exitCode: number; stdout: string };
return commandOutcome(request, { status: result.exitCode, stdout: result.stdout, stderr: "" });
};
return { runner, get active() { return worker !== undefined; }, close: () => { if (worker) { void worker.terminate(); worker = undefined; } } };
}
+144
View File
@@ -0,0 +1,144 @@
/**
* The Argent bridge on a worker thread: one bridge and one tool-server connection for a whole capture, instead of a
* process (and a TLS handshake) per command. The capture thread posts a command and blocks on the shared buffer;
* this thread runs it through Argent's own client library (the code `argent run` uses) and writes the answer back.
*/
import { isMainThread, parentPort, workerData } from "node:worker_threads";
import { copyFile, mkdir, open, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path";
import { pathToFileURL } from "node:url";
import { ArgentCallError, type ArgentCall } from "./argent-driver.js";
import { argentBridgeSettings, createArgentBridge, type ArgentBridge } from "./argent-bridge.js";
import { ensureController } from "../shared/controller-cache.js";
/** The shared buffer: four Int32 header slots, then the UTF-8 answer. */
export const BRIDGE_HEADER_BYTES = 16;
export const BRIDGE_SLOT_READY = 0;
export const BRIDGE_SLOT_LENGTH = 1;
export const BRIDGE_SLOT_KIND = 2;
export const BRIDGE_KIND_RESULT = 0;
/** The bridge cannot run on this thread (Argent's client did not load); the host falls back to the process bridge. */
export const BRIDGE_KIND_UNAVAILABLE = 1;
export type BridgeWorkerData = { shared: SharedArrayBuffer; clientModule?: string };
export type BridgeRequest = { id: number; argv: readonly string[]; timeoutMs?: number } | { abort: number };
const ARGENT_CALL_TIMEOUT_MS = 180_000;
/** Argent's programmatic client, as `dist/client.js` of the pinned release exports it. */
type ArgentClient = { callTool(name: string, args: Record<string, unknown>, options?: { signal?: AbortSignal }): Promise<{ data: unknown; note?: string }> };
/** Whether some bytes begin as a PNG or a JPEG does: `--out` is a screenshot, and nothing else is taken for one. */
function isImage(head: Uint8Array): boolean {
const png = [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a], jpeg = [0xff, 0xd8, 0xff];
return [png, jpeg].some(signature => signature.every((byte, index) => head[index] === byte));
}
/** Whether a path names a file that is an image by its content. */
async function imageFile(path: string): Promise<boolean> {
const file = await open(path, "r").catch(() => undefined);
if (!file) return false;
try {
if (!(await file.stat()).isFile()) return false;
const head = new Uint8Array(8);
const { bytesRead } = await file.read(head, 0, head.length, 0);
return isImage(head.subarray(0, bytesRead));
} finally { await file.close(); }
}
/** The first string in a tool's answer that names an image file: the materialized screenshot (`path` first). */
async function materializedFile(data: unknown): Promise<string | undefined> {
const candidates: string[] = [];
const walk = (value: unknown, key?: string) => {
if (typeof value === "string") { if (key === "path") candidates.unshift(value); else candidates.push(value); }
else if (Array.isArray(value)) value.forEach(item => walk(item));
else if (value && typeof value === "object") Object.entries(value).forEach(([k, v]) => walk(v, k));
};
walk(data);
for (const candidate of candidates) {
if (candidate.startsWith("/") && await imageFile(candidate)) return candidate;
}
return undefined;
}
async function loadClient(environment: NodeJS.ProcessEnv, clientModule?: string): Promise<ArgentClient> {
const module = clientModule ?? join(dirname(await ensureController("argent", { environment })), "client.js");
const loaded = await import(pathToFileURL(module).href) as { createArgentClient?: () => ArgentClient };
if (typeof loaded.createArgentClient !== "function") throw new Error(`${module} does not export createArgentClient`);
return loaded.createArgentClient();
}
/** The in-thread Argent call: the client's `callTool`, with `--out` served from the artifact it materialized. */
export function argentClientCall(client: ArgentClient, signal: () => AbortSignal): ArgentCall {
return async (tool, args, options) => {
const active = signal();
if (active.aborted) throw new ArgentCallError(`argent run ${tool} was not sent: the command was given up.`, false);
let answer: { data: unknown };
try { answer = await client.callTool(tool, args, { signal: AbortSignal.any([active, AbortSignal.timeout(ARGENT_CALL_TIMEOUT_MS)]) }); }
catch (error) { throw new ArgentCallError(`argent run ${tool} failed: ${(error instanceof Error ? error.message : String(error)).slice(0, 800)}`, true); }
if (!options?.out) return answer.data;
const file = await materializedFile(answer.data);
if (!file) {
const url = (answer.data as { url?: unknown } | null)?.url;
if (typeof url !== "string") throw new ArgentCallError(`argent run ${tool} did not write ${options.out}`, true);
const response = await fetch(url, { signal: signal() });
if (!response.ok) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}: ${response.status}`, true);
const body = Buffer.from(await response.arrayBuffer());
if (!isImage(body)) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}: the answer is not an image`, true);
await mkdir(dirname(options.out), { recursive: true });
await writeFile(options.out, body);
return { path: options.out };
}
await mkdir(dirname(options.out), { recursive: true });
if (file !== options.out) await copyFile(file, options.out);
return { path: options.out };
};
}
if (!isMainThread && parentPort && (workerData as Partial<BridgeWorkerData> | null)?.shared instanceof SharedArrayBuffer) {
const port = parentPort;
const { shared, clientModule } = workerData as BridgeWorkerData;
const header = new Int32Array(shared, 0, BRIDGE_HEADER_BYTES / 4);
const bytes = new Uint8Array(shared, BRIDGE_HEADER_BYTES);
const answer = (id: number, kind: number, text: string) => {
let encoded = Buffer.from(text, "utf8");
if (encoded.length > bytes.length) {
encoded = Buffer.from(JSON.stringify({ exitCode: 1, stdout: JSON.stringify({ success: false,
error: { code: "COMMAND_FAILED", message: `The controller's answer (${encoded.length} bytes) exceeds the bridge buffer.` } }) }));
}
bytes.set(encoded);
Atomics.store(header, BRIDGE_SLOT_LENGTH, encoded.length);
Atomics.store(header, BRIDGE_SLOT_KIND, kind);
Atomics.store(header, BRIDGE_SLOT_READY, id);
Atomics.notify(header, BRIDGE_SLOT_READY);
};
const controllers = new Map<number, AbortController>();
let current: AbortController | undefined;
const settings = argentBridgeSettings(process.env);
const bridge: Promise<ArgentBridge> = settings && settings.toolsUrl
? loadClient(process.env, clientModule).then(client => createArgentBridge(settings, argentClientCall(client, () => current?.signal ?? new AbortController().signal), "thread"))
: Promise.reject(new Error("The Argent bridge needs EXPLORE_ARGENT_STATE, EXPLORE_ARGENT_PLATFORM and ARGENT_TOOLS_URL."));
bridge.catch(() => undefined);
let queue: Promise<unknown> = Promise.resolve();
port.on("message", (request: BridgeRequest) => {
if ("abort" in request) { controllers.get(request.abort)?.abort(new Error("The capture gave up waiting for this command.")); return; }
const controller = new AbortController();
controllers.set(request.id, controller);
queue = queue.then(async () => {
current = controller;
try {
const ready = await bridge.catch(error => { throw Object.assign(error as Error, { unavailable: true }); });
if (controller.signal.aborted) throw controller.signal.reason;
const result = await ready.run(request.argv);
answer(request.id, BRIDGE_KIND_RESULT, JSON.stringify(result));
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
if ((error as { unavailable?: boolean }).unavailable) answer(request.id, BRIDGE_KIND_UNAVAILABLE, message);
else answer(request.id, BRIDGE_KIND_RESULT, JSON.stringify({ exitCode: 1, stdout: JSON.stringify({ success: false, error: { code: "COMMAND_FAILED", message } }) }));
} finally {
controllers.delete(request.id);
current = undefined;
}
});
});
}
+137
View File
@@ -0,0 +1,137 @@
/**
* The Argent bridge behind both of its hosts: the command-line worker Explore spawns per command, and the
* in-process worker thread that keeps one bridge (and one tool-server connection) for a whole capture. Each command
* reads the shared state file, runs through `runBridgeCommand`, and writes the state back, so the two hosts can
* take turns on one session.
*/
import { spawnSync } from "node:child_process";
import { appendFile, copyFile, mkdir, readFile, realpath, rename, rm, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path";
import { createRequire } from "node:module";
import type { DecodedFrame } from "../shared/png-evidence.js";
import { runBridgeCommand, type ArgentBridgeState, type ArgentCall, type ArgentPlatform, type ArgentTree, type BridgeResult } from "./argent-driver.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
export type ArgentBridgeSettings = {
environment: NodeJS.ProcessEnv;
statePath: string;
platform: ArgentPlatform;
toolsUrl: string | undefined;
};
/** Reads the settings the bridge takes from its environment; absent when they are incomplete. */
export function argentBridgeSettings(environment: NodeJS.ProcessEnv): ArgentBridgeSettings | undefined {
const statePath = environment.EXPLORE_ARGENT_STATE;
const platform = environment.EXPLORE_ARGENT_PLATFORM;
if (!statePath || (platform !== "ios" && platform !== "android")) return undefined;
return { environment, statePath, platform, toolsUrl: environment.ARGENT_TOOLS_URL };
}
async function readState(path: string): Promise<ArgentBridgeState> {
try { return JSON.parse(await readFile(path, "utf8")) as ArgentBridgeState; }
catch { return { generation: 0 }; }
}
/** Written whole and renamed into place, so a command stopped mid-write never leaves a torn state. */
async function writeState(path: string, state: ArgentBridgeState): Promise<void> {
const temporary = `${path}.${process.pid}.tmp`;
await writeFile(temporary, JSON.stringify(state), { mode: 0o600 });
await rename(temporary, path);
}
/** A call's arguments for the debug log: text that could be typed into a field is logged by length only. */
function loggedArgs(args: Record<string, unknown>): Record<string, unknown> {
return Object.fromEntries(Object.entries(args).map(([key, value]) => key === "text" && typeof value === "string" ? [key, `<${value.length} characters>`]
: key === "steps" && Array.isArray(value) ? [key, `<${value.length} steps>`] : [key, value]));
}
/** What a call answered, for the debug log: a tree's shape, not its contents. */
function summarize(tool: string, value: unknown): unknown {
if (!value || typeof value !== "object") return value;
if (tool !== "ui-tree") return Object.keys(value);
const tree = value as ArgentTree;
let nodes = 0;
const walk = (node: { children?: unknown[] }) => { nodes++; (node.children ?? []).forEach(child => walk(child as { children?: unknown[] })); };
(tree.roots ?? []).forEach(walk);
return { foregroundApp: tree.foregroundApp, alertVisible: tree.alertVisible, keyboardVisible: tree.keyboardVisible, truncated: tree.truncated,
screen: tree.screen, nodes, roots: (tree.roots ?? []).map(root => [root.type ?? null, root.bundleId ?? null, (root.children ?? []).length]) };
}
export type ArgentBridge = {
/** Runs one agent-device-shaped command against the session. */
run(argv: readonly string[]): Promise<BridgeResult>;
};
/**
* One bridge over the given Argent call. `host` names the process running it in the debug log.
*/
export function createArgentBridge(settings: ArgentBridgeSettings, call: ArgentCall, host: "process" | "thread"): ArgentBridge {
const { environment, statePath, platform, toolsUrl } = settings;
const logPath = environment.EXPLORE_ARGENT_LOG_DIR
? join(environment.EXPLORE_ARGENT_LOG_DIR, `argent-${platform}-${environment.EXPLORE_ARGENT_LOG_NAME ?? "bridge"}.jsonl`) : undefined;
return {
async run(argv) {
// EXPLORE_ARGENT_LOG_DIR (opt-in): every Argent call this bridge makes, how long it took, and the shape of what it read.
const log = async (entry: Record<string, unknown>) => {
if (!logPath) return;
await appendFile(logPath, `${JSON.stringify({ at: new Date().toISOString(), host, command: argv[0], ...entry })}\n`, { mode: 0o600 }).catch(() => undefined);
};
const state = await readState(statePath);
const result = await runBridgeCommand(argv, {
state, platform, version: ARGENT_VERSION,
...(environment.EXPLORE_ARGENT_BUNDLE_ID ? { bundleId: environment.EXPLORE_ARGENT_BUNDLE_ID } : {}),
...(environment.EXPLORE_ARGENT_DEVICE ? { device: environment.EXPLORE_ARGENT_DEVICE } : {}),
// An opened foldable's inner panel shows its UI in landscape (Argent's fold: "Unfolded, the UI is landscape").
...(platform === "ios" && ["open", "half-open"].includes(environment.EXPLORE_ARGENT_POSE ?? "") ? { landscape: true } : {}),
call: async (tool, args, options) => {
const started = Date.now();
try {
const value = await call(tool, args, options);
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, summary: summarize(tool, value) });
return value;
} catch (error) {
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, error: (error instanceof Error ? error.message : String(error)).slice(0, 400) });
throw error;
}
},
reachable: async () => {
let ok = false;
try {
const token = environment.ARGENT_AUTH_TOKEN;
// The same URL Argent's own client checks: ARGENT_TOOLS_URL may carry a path, which /tools is appended to.
const response = await fetch(`${(toolsUrl ?? "").replace(/\/+$/, "")}/tools`, { headers: token ? { authorization: `Bearer ${token}` } : {}, signal: AbortSignal.timeout(5_000) });
await response.body?.cancel();
ok = response.status < 500;
} catch { ok = false; }
if (!ok) await log({ tool: "reachable", ok });
return ok;
},
sleep: milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds)),
orientVideo: async path => {
const probed = spawnSync("ffprobe", ["-v", "error", "-select_streams", "v:0", "-show_entries", "stream=width,height", "-of", "csv=p=0:s=x", path], { encoding: "utf8", timeout: 30_000 });
const [width, height] = (probed.stdout ?? "").trim().split("x").map(Number);
if (probed.status !== 0 || !width || !height || width >= height) return;
const turned = `${path}.upright.mp4`;
const ffmpeg = spawnSync("ffmpeg", ["-nostdin", "-y", "-loglevel", "error", "-i", path, "-vf", "transpose=clock", "-an", turned], { encoding: "utf8", timeout: 120_000 });
if (ffmpeg.status === 0) await rename(turned, path);
else await rm(turned, { force: true });
},
scratchImage: { path: join(dirname(statePath), "argent-scratch.png"), read: async path => {
const { PNG } = createRequire(import.meta.url)("pngjs") as { PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
return PNG.sync.read(await readFile(path), { checkCRC: false });
} },
moveFile: async (from, to) => {
const source = await realpath(from);
const roots = await Promise.all([environment.HOME, process.cwd()].filter((root): root is string => !!root).map(root => realpath(root).catch(() => root)));
if (!roots.some(root => source.startsWith(`${root}/`))) throw new Error(`Argent returned a recording outside its own directories: ${from}`);
await mkdir(dirname(to), { recursive: true });
try { await rename(from, to); }
catch { await copyFile(from, to); await rm(from, { force: true }); }
},
});
await writeState(statePath, state);
await log({ result: result.exitCode === 0 ? "ok" : result.stdout.slice(0, 300) });
return result;
},
};
}
+60
View File
@@ -0,0 +1,60 @@
/**
* The Argent controller's command line: Explore runs it where it would run agent-device, with the same
* arguments. Each command becomes `argent run <tool> --args <json>` calls, as EAS Simulator recommends
* driving an `argent` session, with the session's ARGENT_TOOLS_URL and ARGENT_AUTH_TOKEN in the environment.
* A capture keeps the same bridge on a worker thread instead (argent-bridge-host); this entry serves the callers
* that run one command at a time.
*/
import { spawnSync } from "node:child_process";
import { stat } from "node:fs/promises";
import { ArgentCallError } from "./argent-driver.js";
import { argentBridgeSettings, createArgentBridge } from "./argent-bridge.js";
import { ensureController } from "../shared/controller-cache.js";
const ARGENT_CALL_TIMEOUT_MS = 180_000;
async function main(): Promise<number> {
const environment = process.env;
const settings = argentBridgeSettings(environment);
if (!settings) {
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: "The Argent controller needs EXPLORE_ARGENT_STATE and EXPLORE_ARGENT_PLATFORM." } }));
return 1;
}
const argv = process.argv.slice(2);
if (argv[0] !== "--version" && !settings.toolsUrl) {
// Without a URL the Argent client would start a local tool-server; Explore only drives the session's own.
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: "ARGENT_TOOLS_URL is not set for the Argent controller." } }));
return 1;
}
let cli: string;
try { cli = argv[0] === "--version" ? "" : await ensureController("argent", { environment, progress: message => process.stderr.write(`[explore] ${message}\n`) }); }
catch (error) {
const failure = error as { code?: string; message?: string };
process.stdout.write(JSON.stringify({ success: false, error: { code: failure.code ?? "CONTROLLER_DOWNLOAD_FAILED", message: failure.message ?? String(error) } }));
return 1;
}
const callArgent = async (tool: string, args: Record<string, unknown>, options?: { out?: string }): Promise<unknown> => {
const run = spawnSync(process.execPath, [cli, "run", tool, "--args", JSON.stringify(args), ...(options?.out ? ["--out", options.out] : [])],
{ env: environment, encoding: "utf8", maxBuffer: 64 * 1024 * 1024, timeout: ARGENT_CALL_TIMEOUT_MS });
if (run.error) throw new ArgentCallError(`argent run ${tool}: ${run.error.message}`, true);
if (run.status !== 0) {
const detail = `${run.stderr ?? ""}\n${run.stdout ?? ""}`.trim().split("\n").filter(Boolean).slice(-4).join(" | ").slice(0, 800);
throw new ArgentCallError(`argent run ${tool} failed: ${detail}`, true);
}
// With --out the client saves the tool's file and prints where ("Wrote: <path>"), not the tool's JSON.
if (options?.out) {
const written = await stat(options.out).catch(() => undefined);
if (!written?.isFile() || written.size === 0) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}`, true);
return { path: options.out };
}
try { return JSON.parse(run.stdout); }
catch { throw new ArgentCallError(`argent run ${tool} did not answer with JSON`, true); }
};
const result = await createArgentBridge(settings, callArgent, "process").run(argv);
process.stdout.write(result.stdout);
return result.exitCode;
}
process.exitCode = await main();
+758
View File
@@ -0,0 +1,758 @@
/**
* Translates the agent-device commands Explore sends into Argent tool calls, and Argent's answers into
* agent-device's JSON envelopes, so capture, setup, the agent tool host and black-box exploration drive
* either controller without knowing which one runs. Pure: the Argent call, the clock and file moves are
* injected, so the translation is tested against recorded Argent output.
*/
import { CONTROLLER_SESSION } from "./common.js";
import type { DecodedFrame } from "../shared/png-evidence.js";
export type ArgentPlatform = "ios" | "android";
/** One `argent run <tool>` call. `sent: false` means the request provably never reached the tool-server. */
export class ArgentCallError extends Error {
constructor(message: string, readonly sent: boolean) { super(message); }
}
export type ArgentCall = (tool: string, args: Record<string, unknown>, options?: { out?: string }) => Promise<unknown>;
type Rect = { x: number; y: number; width: number; height: number };
/** What the bridge keeps between commands, in the per-run state file. */
export type ArgentBridgeState = {
udid?: string;
model?: string;
osVersion?: string;
/** The coordinate space of the last tree: points on iOS, pixels on Android, as agent-device reports them. */
screen?: { width: number; height: number };
generation: number;
refs?: Record<string, { rect: Rect; type?: string; value?: string; secure?: boolean }>;
/** iOS asks "Open in “<app>”?" for the first custom-scheme link of a session; later links open directly. */
deepLinkPromptAccepted?: boolean;
recording?: string;
};
export type ArgentBridgeContext = {
call: ArgentCall;
state: ArgentBridgeState;
platform: ArgentPlatform;
/** The app under test when the caller names it outside the command (explore:binary's `install`). */
bundleId?: string;
/** The device to drive (UDID or adb serial) when the tool-server sees several: a local one serves this machine's. */
device?: string;
version: string;
sleep: (milliseconds: number) => Promise<void>;
/** Moves a file the Argent client downloaded (a screen recording) to where Explore asked for it. */
moveFile: (from: string, to: string) => Promise<void>;
/** Whether the tool-server answers, checked before a UI action is sent (see `remoteUnavailable`). */
reachable: () => Promise<boolean>;
/** A file the bridge may overwrite with a screenshot, and a reader for it (the link-prompt fallback). */
scratchImage?: { path: string; read: (path: string) => Promise<DecodedFrame> };
/**
* The UI is landscape on a panel whose native axes are portrait, as on an opened iPhone Duo. Argent reads such a panel
* on its portrait axes (screen, tree and taps all agree), so only what a person sees is turned: screenshots are
* captured upright, and recordings, which Argent cannot turn, go to orientVideo.
*/
landscape?: boolean;
/** Turns a portrait screen recording a quarter clockwise, to the landscape UI it shows. */
orientVideo?: (path: string) => Promise<void>;
};
export type BridgeResult = { exitCode: number; stdout: string };
const success = (data: Record<string, unknown>): BridgeResult => ({ exitCode: 0, stdout: JSON.stringify({ success: true, data }) });
const failure = (code: string, message: string, details?: Record<string, unknown>): BridgeResult =>
({ exitCode: 1, stdout: JSON.stringify({ success: false, error: { code, message, ...(details ? { details } : {}) } }) });
/**
* agent-device's answer when its pre-flight health check fails, which Explore resends because the command was
* provably never sent (controller.ts remoteDaemonUnavailable). The bridge gives it only on the same proof.
*/
const remoteUnavailable = () => failure("COMMAND_FAILED", "Remote daemon is unavailable");
/** Flags agent-device takes after a command; the bridge needs the platform only from its own context. */
const VALUE_FLAGS = new Set(["--session", "--device", "--platform", "--level", "--udid", "--scope", "--bundle-id", "--serial", "--timeout"]);
const BOOLEAN_FLAGS = new Set(["--json", "--relaunch", "--normalize-status-bar", "--force-full", "--in-app", "--system"]);
export function parseCommand(argv: readonly string[]): { positional: string[]; flags: Record<string, string | true> } {
const positional: string[] = [];
const flags: Record<string, string | true> = {};
for (let index = 0; index < argv.length; index++) {
const value = argv[index]!;
if (value === "--") { positional.push(...argv.slice(index + 1)); break; }
if (VALUE_FLAGS.has(value)) { flags[value.slice(2)] = argv[index + 1] ?? ""; index++; continue; }
if (BOOLEAN_FLAGS.has(value)) { flags[value.slice(2)] = true; continue; }
positional.push(value);
}
return { positional, flags };
}
type ArgentNode = { role?: string; type?: string; label?: string; identifier?: string; value?: string; contentDescription?: string; disabled?: boolean;
frame?: Rect; traits?: string[]; hidden?: boolean; selected?: boolean; password?: boolean; bundleId?: string; children?: ArgentNode[] };
export type ArgentTree = { schemaVersion?: number; source?: string; screen?: { width: number; height: number }; roots?: ArgentNode[];
truncated?: boolean; alertVisible?: boolean; keyboardVisible?: boolean; foregroundApp?: string };
const record = (value: unknown): Record<string, unknown> => (value && typeof value === "object" && !Array.isArray(value) ? value as Record<string, unknown> : {});
const finite = (value: unknown): value is number => typeof value === "number" && Number.isFinite(value);
/** Android widget classes as agent-device names their element types. */
function agentDeviceType(node: ArgentNode, platform: ArgentPlatform): string {
const type = node.type ?? node.role ?? "Other";
if (node.password) return "SecureTextField";
if (platform === "ios") return type;
const simple = type.split(".").pop() ?? type;
if (/EditText|TextInput/.test(simple)) return "TextField";
if (/Button$|ImageButton|CheckBox|Switch|RadioButton/.test(simple)) return simple.endsWith("Button") ? "Button" : simple;
if (/TextView/.test(simple)) return "StaticText";
if (/ImageView/.test(simple)) return "Image";
if (/ScrollView|RecyclerView|ListView/.test(simple)) return "ScrollView";
return simple || "Other";
}
/**
* The tree as agent-device's snapshot: the app's root (an `Application` node sized to the screen) and every
* element on or near the screen, in the units agent-device uses (points on iOS, pixels on Android), with
* refs pinned to this snapshot's generation. Elements Argent lists twice (iOS AX does) appear once.
*/
export function snapshotFromTree(tree: ArgentTree, platform: ArgentPlatform, generation: number, bundleId?: string) {
const screen = tree.screen;
if (!screen || !finite(screen.width) || !finite(screen.height) || screen.width <= 0 || screen.height <= 0) {
throw new Error("ui-tree did not report the screen size");
}
const app = bundleId ?? tree.foregroundApp;
// Android's status bar and navigation (com.android.systemui) are not part of the app; a dialog another package draws
// over it (a runtime permission prompt) is, because it covers the app and setup has to answer it.
const roots = (tree.roots ?? []).filter(root => platform === "ios" || root.bundleId !== ANDROID_SYSTEM_UI);
const nodes: Record<string, unknown>[] = [];
const refs: NonNullable<ArgentBridgeState["refs"]> = {};
const seen = new Set<string>();
const toPoints = (frame: Rect): Rect => ({ x: frame.x * screen.width, y: frame.y * screen.height, width: frame.width * screen.width, height: frame.height * screen.height });
/**
* iOS visibility, as Argent computes it (a node is hidden when its frame misses every ancestor's frame), except that a
* root clips to the whole screen. On iPhone Duo's inner display Argent 0.29 reports the app root as the top-left third
* of the screen ([0, 0, 0.333, 0.333], its 3x scale applied twice), which hid everything outside that third: a sheet's
* title and its Cancel button among them. Android's `hidden` is the system's own visible-to-user flag and is kept.
*/
const clipOf = (node: ArgentNode, clip: Rect | undefined, root: boolean): Rect | undefined => {
if (root || !node.frame || ![node.frame.x, node.frame.y, node.frame.width, node.frame.height].every(finite)) return clip;
return clip && intersect(node.frame, clip);
};
const visit = (node: ArgentNode, depth: number, parentIndex: number | undefined, appRoot: boolean, clip: Rect | undefined, root: boolean) => {
const frame = node.frame;
const inner = clipOf(node, clip, root);
const rect = frame && [frame.x, frame.y, frame.width, frame.height].every(finite) ? toPoints(frame) : undefined;
const onScreen = !!rect && rect.x < screen.width && rect.y < screen.height && rect.x + rect.width > 0 && rect.y + rect.height > 0;
const type = appRoot ? "Application" : agentDeviceType(node, platform);
const label = node.label ?? node.contentDescription;
const key = JSON.stringify([type, label, node.identifier, node.value, rect && [Math.round(rect.x), Math.round(rect.y), Math.round(rect.width), Math.round(rect.height)]]);
let index = parentIndex;
// Off-screen content stays out, as agent-device leaves it out; its parents still come through for depth.
if (rect && (onScreen || appRoot) && !seen.has(key)) {
seen.add(key);
index = nodes.length;
const ref = `e${index + 1}`;
const traits = node.traits ?? [];
// iOS marks a disabled element with the notEnabled trait, Android with disabled.
const enabled = !traits.includes("notEnabled") && node.disabled !== true;
const visible = platform === "ios" ? !!inner : node.hidden !== true;
nodes.push({ depth, index, ...(parentIndex === undefined ? {} : { parentIndex }), type, ref,
rect: appRoot ? { x: 0, y: 0, width: screen.width, height: screen.height } : rect,
...(label ? { label } : {}), ...(node.identifier ? { identifier: node.identifier } : {}),
...(node.value !== undefined ? { value: node.value } : {}), enabled, hittable: enabled && visible && !appRoot,
...(visible ? {} : { visible: false }), ...(node.selected || traits.includes("selected") ? { selected: true } : {}) });
refs[ref] = { rect: appRoot ? { x: 0, y: 0, width: screen.width, height: screen.height } : rect, type,
...(node.value !== undefined ? { value: node.value } : {}), ...(type === "SecureTextField" ? { secure: true } : {}) };
}
for (const child of node.children ?? []) visit(child, depth + 1, index, false, inner, false);
};
for (const root of roots) {
const isAppRoot = platform === "ios" ? root.type === "Application" || nodes.length === 0 : root.bundleId === app;
visit(root, 0, undefined, isAppRoot, { x: 0, y: 0, width: 1, height: 1 }, true);
}
return { nodes, refs, screen: { width: screen.width, height: screen.height } };
}
function intersect(a: Rect, b: Rect): Rect | undefined {
const x = Math.max(a.x, b.x), y = Math.max(a.y, b.y);
const right = Math.min(a.x + a.width, b.x + b.width), bottom = Math.min(a.y + a.height, b.y + b.height);
return right > x && bottom > y ? { x, y, width: right - x, height: bottom - y } : undefined;
}
const centre = (rect: Rect, screen: { width: number; height: number }) =>
({ x: (rect.x + rect.width / 2) / screen.width, y: (rect.y + rect.height / 2) / screen.height });
/**
* Argent read nothing: exactly one bare root and no foreground app, which is what iOS 27.1 gives while the link prompt
* is up. A read that returned no roots at all is a failed read, not this state.
*/
function blindTree(tree: ArgentTree): boolean {
const roots = tree.roots ?? [];
return !tree.foregroundApp && roots.length === 1 && (roots[0]!.children ?? []).length === 0 && !roots[0]!.label && !roots[0]!.type;
}
/** A tree with the app's root and something in it: what a relaunch must reach before the app is usable. */
function appReady(tree: ArgentTree, bundleId: string): boolean {
if (tree.foregroundApp !== bundleId) return false;
const count = (node: ArgentNode): number => 1 + (node.children ?? []).reduce((sum, child) => sum + count(child), 0);
return (tree.roots ?? []).some(root => count(root) > 1);
}
function flatten(tree: ArgentTree): ArgentNode[] {
const nodes: ArgentNode[] = [];
const walk = (node: ArgentNode) => { nodes.push(node); (node.children ?? []).forEach(walk); };
(tree.roots ?? []).forEach(walk);
return nodes;
}
/** iOS: `com.apple.CoreSimulator.SimRuntime.iOS-26-5` → `26.5`. */
export function iosRuntimeVersion(runtime: unknown): string | undefined {
const match = typeof runtime === "string" ? /iOS-(\d+)-(\d+)(?:-(\d+))?$/.exec(runtime) : null;
return match ? [match[1], match[2], match[3]].filter(Boolean).join(".") : undefined;
}
const DEEP_LINK_PROMPT_CONFIRM = { dxPoints: 74, dyPoints: 37 };
const KEYBOARD_DISMISS_LABELS = ["Hide keyboard", "Dismiss keyboard", "Done"];
// A keyboard covers the lower part of the screen; its keys start below this share of the height.
const KEYBOARD_TOP = 0.4;
const ALERT_PREFERRED_BUTTONS = ["Open", "OK", "Allow", "Allow While Using App", "Continue"];
const READ_TOOLS = new Set(["ui-tree", "list-devices", "screenshot", "foreground-app", "await-screen-idle", "describe"]);
const SPRINGBOARD = "com.apple.springboard";
const ANDROID_SYSTEM_UI = "com.android.systemui";
const OPEN_IN_APP_PROMPT = /^Open in “.+”\?$/;
/**
* iOS's "Open in “<app>”?" link prompt, recognized by its own text. Argent 0.29 does not always flag it as an alert
* (on iOS 27.1, iPhone Duo, `alertVisible` stays false while SpringBoard shows it), and another alert must never be
* taken for it: the bridge presses this prompt's Open on its own.
*/
export function openInAppPromptShowing(tree: ArgentTree): boolean {
return flatten(tree).some(node => OPEN_IN_APP_PROMPT.test(node.label ?? ""));
}
/** Any system alert in front of the app: one Argent flags, or the link prompt it does not. */
function alertShowing(tree: ArgentTree): boolean {
return tree.alertVisible === true || (tree.foregroundApp === SPRINGBOARD && openInAppPromptShowing(tree));
}
/**
* The link prompt's Open button found in a screenshot: the largest wide, filled system-blue shape in the middle of the
* screen, as iOS 26 and 27 draw it. Used only when Argent cannot read the screen at all while the prompt is up.
*/
export function findOpenButton(frame: DecodedFrame): { x: number; y: number } | undefined {
const step = Math.max(1, Math.round(frame.width / 200));
const columns = Math.floor(frame.width / step), rows = Math.floor(frame.height / step);
const top = Math.floor(rows * 0.2), bottom = Math.ceil(rows * 0.8);
const blue = new Uint8Array(columns * rows);
for (let row = top; row < bottom; row++) for (let column = 0; column < columns; column++) {
const offset = (row * step * frame.width + column * step) * 4;
const [red, green, blueValue] = [frame.data[offset]!, frame.data[offset + 1]!, frame.data[offset + 2]!];
if (red < 70 && green > 90 && green < 170 && blueValue > 200) blue[row * columns + column] = 1;
}
let best: { cells: number; left: number; right: number; top: number; bottom: number } | undefined;
const seen = new Uint8Array(columns * rows);
for (let start = 0; start < blue.length; start++) {
if (!blue[start] || seen[start]) continue;
const shape = { cells: 0, left: columns, right: 0, top: rows, bottom: 0 };
const queue = [start];
seen[start] = 1;
while (queue.length) {
const cell = queue.pop()!;
const row = Math.floor(cell / columns), column = cell % columns;
shape.cells++;
shape.left = Math.min(shape.left, column); shape.right = Math.max(shape.right, column);
shape.top = Math.min(shape.top, row); shape.bottom = Math.max(shape.bottom, row);
for (const next of [cell - 1, cell + 1, cell - columns, cell + columns]) {
if (next < 0 || next >= blue.length || seen[next] || !blue[next]) continue;
if (Math.abs((next % columns) - column) > 1) continue;
seen[next] = 1;
queue.push(next);
}
}
const width = shape.right - shape.left + 1, height = shape.bottom - shape.top + 1;
// A dialog button: wide, a few percent of the screen tall, and well under its full width.
if (width < columns * 0.15 || width > columns * 0.6 || width < height * 1.5 || height < rows * 0.03 || height > rows * 0.12) continue;
if (!best || shape.cells > best.cells) best = shape;
}
if (!best) return undefined;
return { x: ((best.left + best.right + 1) / 2) / columns, y: ((best.top + best.bottom + 1) / 2) / rows };
}
/**
* The prompt's Open button from `describe`. On iOS 27.1 (iPhone Duo) `ui-tree` reports SpringBoard's frames with
* x and y swapped, while `describe` reads them correctly, so the button is located there.
*/
export function describedButton(description: unknown, label: string): Rect | undefined {
if (typeof description !== "string") return undefined;
const escaped = label.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
// Only a whole line Argent printed counts, so an app label that spells out a button line cannot be picked.
const match = new RegExp(`^\\s*AXButton "${escaped}"\\s+\\(([\\d.]+), ([\\d.]+), ([\\d.]+), ([\\d.]+)\\)\\s*$`, "m").exec(description);
if (!match) return undefined;
const [x, y, width, height] = match.slice(1).map(Number) as [number, number, number, number];
return [x, y, width, height].every(finite) && width > 0 && height > 0 ? { x, y, width, height } : undefined;
}
/** Runs one agent-device command against Argent and answers as agent-device would. */
export async function runBridgeCommand(argv: readonly string[], context: ArgentBridgeContext): Promise<BridgeResult> {
const { state, platform } = context;
if (argv[0] === "--version") return { exitCode: 0, stdout: `${context.version}\n` };
const [command, ...rest] = argv;
const { positional, flags } = parseCommand(rest);
const bundleFlag = typeof flags["bundle-id"] === "string" ? flags["bundle-id"] : context.bundleId;
/** Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check. */
const call = async (tool: string, args: Record<string, unknown> = {}, options?: { out?: string }): Promise<Record<string, unknown>> => {
// Tools that name devices their own way (or none) take no udid.
const withDevice = tool === "list-devices" || tool === "stop-all-simulator-servers" ? args : { udid: state.udid, ...args };
for (let attempt = 0; ; attempt++) {
try { return record(await context.call(tool, withDevice, options)); }
catch (error) {
if (READ_TOOLS.has(tool) && attempt < 2) { await context.sleep(1_000 * (attempt + 1)); continue; }
throw error;
}
}
};
const tree = async (): Promise<ArgentTree> => (await call("ui-tree")) as ArgentTree;
const ensureDevice = async () => {
if (state.udid) return;
let devices: Record<string, unknown>[] = [];
// A tool-server that has just started can list no devices at all for its first call; that is not an answer.
for (let attempt = 0; attempt < 3; attempt++) {
const listed = await call("list-devices");
const all = Array.isArray(listed.devices) ? listed.devices : [];
devices = all.map(record).filter(device => device.platform === platform
&& (platform === "ios" ? device.state === "Booted" && device.runtimeKind !== "tv" : device.state === "device" && device.runtimeKind !== "tv")
&& (!context.device || (platform === "ios" ? device.udid : device.serial) === context.device));
if (all.length) break;
await context.sleep(2_000);
}
if (devices.length !== 1) throw new BridgeFailure("DEVICE_UNAVAILABLE", context.device
? `Argent does not list ${context.device} among the booted ${platform} devices.`
: `Argent lists ${devices.length} booted ${platform} devices on this session; Explore drives exactly one.`);
const device = devices[0]!;
const udid = platform === "ios" ? device.udid : device.serial;
if (typeof udid !== "string" || !udid) throw new BridgeFailure("DEVICE_UNAVAILABLE", "Argent did not name the booted device.");
state.udid = udid;
state.model = String(platform === "ios" ? device.name : device.model ?? device.avdName ?? udid);
const version = platform === "ios" ? iosRuntimeVersion(device.runtime) : undefined;
if (version) state.osVersion = version;
};
/** Relaunches until the app's tree is readable: an EAS simulator Argent did not boot needs a relaunch first. */
const relaunch = async (bundleId: string) => {
for (let restart = 0; restart < 2; restart++) {
await call("restart-app", { bundleId });
for (let poll = 0; poll < 12; poll++) {
await context.sleep(1_000);
if (appReady(await tree(), bundleId)) return;
}
}
throw new BridgeFailure("APP_NOT_READY", `${bundleId} did not come up with a readable accessibility tree after relaunching.`);
};
const deviceEnvelope = (bundleId: string) => ({ session: CONTROLLER_SESSION, appBundleId: bundleId, platform, target: "mobile",
device: { platform, target: "mobile", name: state.model, id: state.udid, ...(state.osVersion ? { osVersion: state.osVersion } : {}) },
identifiers: { session: CONTROLLER_SESSION, appBundleId: bundleId, deviceName: state.model, deviceId: state.udid } });
const screen = async () => {
if (!state.screen) { const current = await tree(); if (current.screen) state.screen = { ...current.screen }; }
if (!state.screen) throw new BridgeFailure("COMMAND_FAILED", "The screen size is not known yet.");
return state.screen;
};
const tap = async (x: number, y: number) => { await call("gesture-tap", { x, y }); };
const resolveRef = (value: string) => {
const match = /^@?(e\d+)(?:~s(\d+))?$/.exec(value);
if (!match) throw new BridgeFailure("INVALID_ARGS", `Not an element reference: ${value}`);
if (match[2] && Number(match[2]) !== state.generation) throw new BridgeFailure("COMMAND_FAILED", `Element reference ${value} is stale; take a new snapshot.`);
const target = state.refs?.[match[1]!];
if (!target) throw new BridgeFailure("COMMAND_FAILED", `Element reference ${value} is not in the last snapshot.`);
return target;
};
/**
* A UI action is only sent when the tool-server answers first, so a failure after this point is never resent. A
* session's tool-server can still be starting when EAS reports the session ready, so it is given about 25 s to answer.
*/
const beforeAction = async () => {
for (const delay of [1_000, 2_000, 3_000, 4_000, 5_000, 5_000, 5_000]) {
if (await context.reachable()) return;
await context.sleep(delay);
}
if (!await context.reachable()) throw new UnsentFailure();
};
try {
switch (command) {
case "open": {
await ensureDevice();
const target = positional.length === 2 ? { bundleId: positional[0]!, url: positional[1]! }
: positional.length === 1 && /^[A-Za-z][A-Za-z0-9+.-]*:/.test(positional[0]!) ? { url: positional[0]! } : { bundleId: positional[0] };
if (target.url) {
await beforeAction();
await call("open-url", { url: target.url });
if (platform === "ios" && !state.deepLinkPromptAccepted) await acceptDeepLinkPrompt(target.bundleId ?? bundleFlag);
return success({ ...(target.bundleId ? deviceEnvelope(target.bundleId) : { session: CONTROLLER_SESSION }), url: target.url });
}
const bundleId = target.bundleId ?? bundleFlag;
if (!bundleId) throw new BridgeFailure("INVALID_ARGS", "open needs a bundle identifier or a URL.");
// agent-device's plain open brings a running app forward and keeps its state; only --relaunch restarts it.
if (flags.relaunch !== true && appReady(await tree(), bundleId)) return success({ ...deviceEnvelope(bundleId), appName: bundleId });
await beforeAction();
await relaunch(bundleId);
return success({ ...deviceEnvelope(bundleId), appName: bundleId });
}
case "snapshot": {
await ensureDevice();
const current = await tree();
state.generation += 1;
const converted = snapshotFromTree(current, platform, state.generation, bundleFlag);
state.refs = converted.refs;
state.screen = converted.screen;
const dialog = platform === "android" ? readAlert(current) : undefined;
if (dialog && !converted.nodes.some(node => node.type === "Alert")) {
// An Android dialog from another package covers the app: report it as agent-device does, as an Alert.
converted.nodes.push({ depth: 1, index: converted.nodes.length, parentIndex: 0, type: "Alert", ref: `e${converted.nodes.length + 1}`,
rect: { x: 0, y: 0, width: converted.screen.width, height: converted.screen.height }, label: dialog.message || "System dialog", enabled: true, hittable: false });
} else if (platform === "ios" && alertShowing(current) && !converted.nodes.some(node => node.type === "Alert")
&& !(bundleFlag && appReady(current, bundleFlag))) {
// A system alert (SpringBoard's) hides the app's tree; report it the way agent-device does, as an Alert node.
converted.nodes.push({ depth: 1, index: converted.nodes.length, parentIndex: 0, type: "Alert", ref: `e${converted.nodes.length + 1}`,
rect: { x: 0, y: 0, width: converted.screen.width, height: converted.screen.height }, label: "System alert", enabled: true, hittable: false });
}
return success({ nodes: converted.nodes, truncated: current.truncated === true, refsGeneration: state.generation,
...(current.foregroundApp ? { appBundleId: current.foregroundApp, appName: current.foregroundApp } : {}),
snapshotQuality: { state: "healthy", backend: "argent" } });
}
case "appstate": {
await ensureDevice();
const current = await tree();
const foreground = current.foregroundApp;
return success({ ...(foreground ? { appBundleId: foreground, ...(platform === "android" ? { package: foreground } : {}) } : {}),
session: CONTROLLER_SESSION, state: foreground ? "runningForeground" : "unknown", surface: foreground ? "app" : "home",
device: { id: state.udid, name: state.model } });
}
case "alert": {
await ensureDevice();
const current = await tree();
const alert = readAlert(current);
if (positional[0] === "get") {
if (!alert) return platform === "android" ? success({ platform: "android", alert: null }) : failure("COMMAND_FAILED", "alert not found");
return platform === "android" ? success({ platform: "android", alert: { title: alert.message, buttons: alert.items } })
: success({ message: alert.message, items: alert.items });
}
if (positional[0] === "accept" || positional[0] === "dismiss") {
if (!alert) return failure("COMMAND_FAILED", "alert not found");
const preferred = positional[0] === "dismiss"
? alert.buttons.find(button => /^(Cancel|Not Now|Don.t Allow|Dismiss)$/.test(button.label)) ?? alert.buttons[0]
: ALERT_PREFERRED_BUTTONS.map(label => alert.buttons.find(button => button.label === label)).find(Boolean) ?? alert.buttons.at(-1);
if (!preferred) return failure("COMMAND_FAILED", "The alert has no button to press.");
await beforeAction();
const size = current.screen ?? await screen();
// describe places SpringBoard's buttons correctly where ui-tree may not (iOS 27.1); the tree is the fallback.
const described = describedButton(await call("describe").then(value => value.description, () => undefined), preferred.label);
await tap(...Object.values(described ? centre(described, { width: 1, height: 1 }) : centre(preferred.rect, size)) as [number, number]);
await context.sleep(800);
if (readAlert(await tree())) return failure("COMMAND_FAILED", "The alert is still showing after its button was pressed.");
return success({ action: positional[0], button: preferred.label });
}
return failure("INVALID_ARGS", `Unsupported alert command: ${positional[0] ?? ""}`);
}
case "press": {
await ensureDevice();
const size = await screen();
let point: { x: number; y: number };
if (positional[0]?.startsWith("@") || /^e\d+/.test(positional[0] ?? "")) point = centre(resolveRef(positional[0]!).rect, size);
else {
const x = Number(positional[0]), y = Number(positional[1]);
if (!finite(x) || !finite(y)) throw new BridgeFailure("INVALID_ARGS", "press needs an element reference or x and y.");
point = { x: x / size.width, y: y / size.height };
}
await beforeAction();
await tap(point.x, point.y);
return success({ action: "press", x: point.x, y: point.y });
}
case "fill": {
await ensureDevice();
const target = resolveRef(positional[0] ?? "");
const text = positional.slice(1).join(" ");
rejectSecretPlaceholder(text);
const size = await screen();
await beforeAction();
await tap(...Object.values(centre(target.rect, size)) as [number, number]);
await context.sleep(400);
if (platform === "android") {
const filled = await call("fill", { text });
if (filled.verified !== true) return failure("COMMAND_FAILED", "Argent could not verify the field's new text.");
return success({ action: "fill" });
}
// Argent's iOS `fill` cannot see React Native's focused field, so the old text is erased and the new one typed.
const erase = target.secure ? 64 : (target.value ?? "").length;
if (erase > 0) {
const erased = await call("run-sequence", { steps: Array.from({ length: erase }, () => ({ tool: "keyboard", args: { udid: state.udid, key: "backspace" } })) });
// run-sequence answers normally when it stops partway; typing over half-erased text would leave a wrong value.
if (erased.completed !== erased.total) return failure("COMMAND_FAILED", `Erasing the field stopped after ${String(erased.completed)} of ${String(erased.total)} keys; nothing was typed.`);
}
if (text) await call("keyboard", { text });
if (!target.secure) {
const after = flatten(await tree()).find(node => node.frame && Math.abs(node.frame.x * size.width - target.rect.x) < 2
&& Math.abs(node.frame.y * size.height - target.rect.y) < 2 && /TextField|EditText/.test(node.type ?? ""));
if (after && (after.value ?? "") !== text) return failure("COMMAND_FAILED", "The field does not hold the requested text after typing it.");
}
return success({ action: "fill" });
}
case "type": {
await ensureDevice();
const text = positional.join(" ");
rejectSecretPlaceholder(text);
await beforeAction();
await call("keyboard", { text });
return success({ action: "type" });
}
case "keyboard": {
if (positional[0] !== "dismiss") return failure("INVALID_ARGS", `Unsupported keyboard command: ${positional[0] ?? ""}`);
await ensureDevice();
const current = await tree();
if (!current.keyboardVisible) return success({ platform, action: "dismiss", wasVisible: false, dismissed: false, visible: false });
await beforeAction();
if (platform === "android") await call("button", { button: "back" });
else {
// agent-device taps the keyboard's own dismiss control, and fails with this message when there is none, which
// callers answer with the return key. Only a key in the keyboard's area counts: an app's "Done" above it is not one.
const key = flatten(current).find(node => KEYBOARD_DISMISS_LABELS.includes(node.label ?? "") && node.frame && node.frame.y >= KEYBOARD_TOP);
if (!key) return failure("COMMAND_FAILED", "Unable to dismiss the iOS keyboard: the keyboard exposes no dismiss control.");
const size = current.screen ?? await screen();
await tap(...Object.values(centre({ x: key.frame!.x * size.width, y: key.frame!.y * size.height,
width: key.frame!.width * size.width, height: key.frame!.height * size.height }, size)) as [number, number]);
}
await context.sleep(500);
const visible = (await tree()).keyboardVisible === true;
if (visible && platform === "ios") return failure("COMMAND_FAILED", "Unable to dismiss the iOS keyboard: it is still showing after its dismiss key was pressed.");
return success({ platform, action: "dismiss", wasVisible: true, dismissed: !visible, visible });
}
case "scroll": {
await ensureDevice();
const direction = positional[0] ?? "down";
const vertical = direction === "down" || direction === "up";
const [from, to] = direction === "down" || direction === "right" ? [0.7, 0.3] : [0.3, 0.7];
await beforeAction();
await call("gesture-swipe", vertical ? { fromX: 0.5, fromY: from, toX: 0.5, toY: to, momentum: false } : { fromX: from, fromY: 0.5, toX: to, toY: 0.5, momentum: false });
return success({ action: "scroll", direction });
}
case "swipe": {
await ensureDevice();
const [x1, y1, x2, y2] = positional.slice(0, 4).map(Number);
if (![x1, y1, x2, y2].every(finite)) throw new BridgeFailure("INVALID_ARGS", "swipe needs x1 y1 x2 y2.");
const size = await screen();
await beforeAction();
await call("gesture-swipe", { fromX: x1! / size.width, fromY: y1! / size.height, toX: x2! / size.width, toY: y2! / size.height, momentum: false });
return success({ action: "swipe" });
}
case "back": {
await ensureDevice();
await beforeAction();
if (flags.system === true) {
// agent-device's system back: the hardware button on Android, the edge swipe on iOS.
if (platform === "android") await call("button", { button: "back" });
else await call("gesture-swipe", { fromX: 0.05, fromY: 0.5, toX: 0.8, toY: 0.5, momentum: false });
return success({ action: "back", mode: "system" });
}
const current = await tree();
const nodes = flatten(current);
const button = platform === "android"
? nodes.find(node => /^(Navigate up|Back)$/i.test(node.contentDescription ?? node.label ?? "") && node.frame)
: (() => {
const bar = nodes.find(node => node.type === "NavigationBar" && node.frame);
return bar && (bar.children ?? []).flatMap(function all(node: ArgentNode): ArgentNode[] { return [node, ...(node.children ?? []).flatMap(all)]; })
.find(node => node.type === "Button" && node.frame && node.frame.x < 1 / 3);
})();
if (button?.frame) {
await tap(button.frame.x + button.frame.width / 2, button.frame.y + button.frame.height / 2);
return success({ action: "back", mode: "in-app" });
}
if (flags["in-app"] === true || platform === "ios") return failure("COMMAND_FAILED", "in-app back control is not available");
await call("button", { button: "back" });
return success({ action: "back", mode: "system" });
}
case "wait": {
if (positional[0] === "stable") {
await ensureDevice();
const minStableMs = Number(positional[1] ?? 500), timeoutMs = Number(positional[2] ?? 8000);
const idle = await call("await-screen-idle", { minStableMs: finite(minStableMs) ? minStableMs : 500, timeoutMs: finite(timeoutMs) ? timeoutMs : 8000 });
return success({ stable: idle.settled === true });
}
const milliseconds = Number(positional[0]);
if (!finite(milliseconds) || milliseconds < 0) throw new BridgeFailure("INVALID_ARGS", "wait needs a number of milliseconds or `stable`.");
await context.sleep(milliseconds);
return success({ waitedMs: milliseconds });
}
case "screenshot": {
await ensureDevice();
const path = positional[0];
if (!path) throw new BridgeFailure("INVALID_ARGS", "screenshot needs a path.");
// Upright on a portrait panel showing a landscape UI; on the opened iPhone Duo that is LandscapeRight (seen on iOS 27.1).
await call("screenshot", { scale: 1, ...(context.landscape ? { rotation: "LandscapeRight" } : {}) }, { out: path });
return success({ path });
}
case "record": {
await ensureDevice();
if (positional[0] === "start") {
if (!positional[1]) throw new BridgeFailure("INVALID_ARGS", "record start needs a path.");
await call("screen-recording-start", { timeLimitSeconds: 300, trimStatic: false, showTouches: false });
state.recording = positional[1];
return success({ recording: true, outPath: positional[1] });
}
if (positional[0] === "stop") {
const stopped = await call("screen-recording-stop");
const target = state.recording;
delete state.recording;
if (typeof stopped.video !== "string") return failure("COMMAND_FAILED", "Argent did not return the recording.");
if (target) await context.moveFile(stopped.video, target);
if (target && context.landscape && context.orientVideo) await context.orientVideo(target);
return success({ outPath: target ?? stopped.video, ...(finite(stopped.durationMs) ? { durationMs: stopped.durationMs } : {}) });
}
return failure("INVALID_ARGS", `Unsupported record command: ${positional[0] ?? ""}`);
}
case "install": {
await ensureDevice();
const path = positional[0];
if (!path || !bundleFlag) throw new BridgeFailure("INVALID_ARGS", "install needs an archive path and the app's bundle identifier.");
await beforeAction();
await call("reinstall-app", { bundleId: bundleFlag, appPath: path });
return success({ installed: true, appBundleId: bundleFlag });
}
case "fold": {
await ensureDevice();
const posture = positional[0];
if (posture !== "closed" && posture !== "half-open" && posture !== "open") throw new BridgeFailure("INVALID_ARGS", "fold needs closed, half-open or open.");
await beforeAction();
// Helpers the tool-server started before a fold can leave the panel it lights black and unread: on a fresh EAS
// session, whose tool-server started them at boot, the first fold opened to a black inner panel every time
// without this, and read the panel at once with it. A local tool-server is Explore's own and starts clean.
await call("stop-all-simulator-servers", { devices: [state.udid] });
const folded = await call("fold", { posture });
// The other panel lights at another size: every stored coordinate and element reference is stale.
delete state.screen;
delete state.refs;
state.generation += 1;
// Argent's accessibility reader can keep reading the panel that went dark (seen on iPhone Duo when it had read
// the outer panel before the fold): its tree keeps the old panel's shape and comes back bare. Nothing is read
// before the fold, and the tree must take the shape of the panel the fold lit before the bridge answers.
const lit = record(folded.screen);
if (finite(lit.width) && finite(lit.height) && lit.height > 0) {
const litRatio = lit.width / lit.height;
const follows = async () => {
for (let poll = 0; poll < 10; poll++) {
const shape = (await tree()).screen;
if (shape && shape.height > 0 && Math.abs(shape.width / shape.height - litRatio) < 0.004) return true;
await context.sleep(1_000);
}
return false;
};
// A reader still stuck on the dark panel is reset once more (the device's helpers, as reset-reader does): it is
// cheap and leaves the app alone. If that is not enough, capture restarts SpringBoard and folds again.
if (!await follows() && !await call("stop-all-simulator-servers", { devices: [state.udid] }).then(follows, () => false)) {
throw new BridgeFailure("CONTROLLER_FOLD_UNVERIFIED", `Argent kept reading the other panel after folding the device ${posture}, and after its device helpers were reset.`);
}
}
return success({ action: "fold", pose: posture, ...(folded.panel !== undefined ? { panel: folded.panel } : {}) });
}
case "reset-reader": {
// Stops the device's Argent helpers, among them the accessibility service describe reads through; the
// tool-server starts fresh ones on the next call. It is how a reader stuck on the panel a fold turned off is
// reset where the tool-server itself cannot be restarted, as on EAS (it started it; never stop it there).
await ensureDevice();
const stopped = await call("stop-all-simulator-servers", { devices: [state.udid] });
delete state.screen;
delete state.refs;
state.generation += 1;
return success({ action: "reset-reader", stopped: Array.isArray(stopped.stopped) ? stopped.stopped.filter(item => typeof item === "string") : [] });
}
case "apps": return success({ apps: [] });
case "session": return success({ sessions: [] });
// TODO(argent#1509): map `settings appearance <scheme>` to Argent's `set-appearance` once a release with it is pinned.
case "settings": return failure("CONTROLLER_UNSUPPORTED", "Argent cannot change the device's appearance yet.");
case "logs": return failure("CONTROLLER_UNSUPPORTED", "Argent does not provide device logs to Explore.");
default: return failure("INVALID_ARGS", `Unsupported command for the Argent controller: ${command ?? ""}`);
}
} catch (error) {
if (error instanceof UnsentFailure) return remoteUnavailable();
if (error instanceof BridgeFailure) return failure(error.code, error.message);
if (error instanceof ArgentCallError) {
// Never "Remote daemon is unavailable" here: the request may have run, so Explore must not resend it.
return failure(error.sent ? "ARGENT_TOOL_FAILED" : "COMMAND_FAILED", error.sent ? error.message : "Remote daemon is unavailable");
}
return failure("ARGENT_BRIDGE_FAILED", error instanceof Error ? error.message : String(error));
}
/** Accepts iOS's "Open in “<app>”?" once per session; later links in the same session open without it. */
async function acceptDeepLinkPrompt(bundleId: string | undefined) {
for (let poll = 0; poll < 6; poll++) {
await context.sleep(700);
const current = await tree();
// Argent can read nothing while iOS 27.1 shows the prompt; find Open in a screenshot instead.
if (blindTree(current) && poll >= 1 && context.scratchImage) {
if (await pressOpenFromScreenshot(context.scratchImage)) { state.deepLinkPromptAccepted = true; return; }
continue;
}
if (!openInAppPromptShowing(current)) {
if (bundleId && appReady(current, bundleId)) { state.deepLinkPromptAccepted = true; return; }
// Another alert is the app's or the system's own business; capture answers it, the bridge does not.
if (current.alertVisible) return;
continue;
}
const size = current.screen;
if (!size) break;
const open = describedButton(await call("describe").then(described => described.description, () => undefined), "Open");
// Without a described button, the prompt's Open button sits at a fixed offset from the centre on iPhone 17.
await tap(...(open ? Object.values(centre(open, { width: 1, height: 1 })) as [number, number]
: [0.5 + DEEP_LINK_PROMPT_CONFIRM.dxPoints / size.width, 0.5 + DEEP_LINK_PROMPT_CONFIRM.dyPoints / size.height] as [number, number]));
if (await promptCleared()) { state.deepLinkPromptAccepted = true; return; }
throw new BridgeFailure("CONTROLLER_DEEP_LINK_PROMPT", "iOS kept asking to open the link in the app after Open was pressed.");
}
}
/**
* After Open is pressed, the prompt can stay in the tree for a second or two while the app comes forward (observed on
* iPhone Duo's inner display), so the bridge reads again for a few seconds before it calls the press a failure.
*/
async function promptCleared(): Promise<boolean> {
for (let poll = 0; poll < 6; poll++) {
await context.sleep(1_000);
if (!openInAppPromptShowing(await tree())) return true;
}
return false;
}
/** Taps the Open button found in a screenshot, then confirms it is gone. */
async function pressOpenFromScreenshot(scratch: NonNullable<ArgentBridgeContext["scratchImage"]>): Promise<boolean> {
await call("screenshot", { scale: 1 }, { out: scratch.path });
const open = findOpenButton(await scratch.read(scratch.path));
if (!open) return false;
await tap(open.x, open.y);
await context.sleep(1_000);
const after = await tree();
if (!blindTree(after)) return !openInAppPromptShowing(after);
await call("screenshot", { scale: 1 }, { out: scratch.path });
return !findOpenButton(await scratch.read(scratch.path));
}
function readAlert(current: ArgentTree) {
const androidDialog = platform === "android"
? (current.roots ?? []).find(root => root.bundleId && root.bundleId !== ANDROID_SYSTEM_UI && root.bundleId !== (bundleFlag ?? current.foregroundApp))
: undefined;
if (!androidDialog && !alertShowing(current)) return undefined;
const size = current.screen ?? state.screen ?? { width: 1, height: 1 };
const nodes = flatten(current);
const container = nodes.find(node => node.type === "Alert")
?? nodes.find(node => (node.children ?? []).length > 0 && OPEN_IN_APP_PROMPT.test(node.label ?? "")) ?? androidDialog;
if (!container) return undefined;
const inside = flatten({ roots: [container] });
const buttons = inside.filter(node => /Button/.test(node.type ?? node.role ?? "") && node.label && node.frame)
.map(node => ({ label: node.label!, rect: { x: node.frame!.x * size.width, y: node.frame!.y * size.height, width: node.frame!.width * size.width, height: node.frame!.height * size.height } }));
const text = inside.filter(node => /StaticText|TextView/.test(node.type ?? node.role ?? "") && node.label).map(node => node.label!);
return buttons.length ? { message: text.join(" ") || container.label || "", items: buttons.map(button => button.label), buttons } : undefined;
}
}
class BridgeFailure extends Error { constructor(readonly code: string, message: string) { super(message); } }
class UnsentFailure extends Error {}
/** Argent's `fill` and `keyboard` would expand `{{secret:NAME}}` from Argent's own secret store; Explore resolves its own. */
function rejectSecretPlaceholder(text: string) {
if (/\{\{\s*secret\s*:/i.test(text)) throw new BridgeFailure("INVALID_ARGS", "Text for the device must not contain a {{secret:…}} placeholder.");
}
+3 -1
View File
@@ -1,6 +1,6 @@
import { CiError } from "../shared/ci-errors.js";
export const EAS_CLI_VERSION = "24.4.2";
export const EAS_CLI_VERSION = "25.2.0";
export { AGENT_DEVICE_VERSION } from "../shared/agent-device-version.js";
export const CONTROLLER_SESSION = "expo-explore-runtime";
@@ -42,6 +42,8 @@ export function baseEnvironment(environment: NodeJS.ProcessEnv): NodeJS.ProcessE
"ANDROID_SDK_ROOT",
"ANDROID_HOME",
"JAVA_HOME",
// A local simulator runs with this Xcode instead of xcode-select's, e.g. one that adds iPhone Duo.
"DEVELOPER_DIR",
]) {
if (environment[name] !== undefined) result[name] = environment[name];
}
+49
View File
@@ -0,0 +1,49 @@
import { mkdir, writeFile } from "node:fs/promises";
import { join } from "node:path";
import { fileURLToPath } from "node:url";
import type { SimulatorConnection } from "./simulator.js";
import { controllerCacheRoot } from "../shared/controller-cache.js";
/** The Argent bridge's entry, run where agent-device's CLI would be. */
export const ARGENT_CONTROLLER_WORKER = fileURLToPath(new URL("./argent-controller-worker.js", import.meta.url));
const shellQuote = (value: string) => `'${value.replace(/'/g, `'\\''`)}'`;
/**
* The command and environment that drive an Argent session the way agent-device's are run: a small executable in
* the run's private directory runs the bridge with this Node, so every caller keeps passing one command and its
* arguments. The bridge gets only the session's tool-server variables, telemetry off, and a HOME of its own, so
* Argent's state (links, downloaded recordings) is never shared between runs or sides of a review.
*/
export async function argentControllerInvocation(options: {
directory: string; connection: SimulatorConnection; platform: "ios" | "android"; environment: NodeJS.ProcessEnv; bundleId?: string;
/** The device to drive (UDID or adb serial) when the tool-server sees several, as a local one does. */
device?: string;
/** A foldable's pose (device.pose): opened, its UI is landscape on a portrait panel, which the bridge turns upright. */
pose?: string;
/** The caller's full environment, which names the controller cache and npm registry the narrowed one drops. */
sourceEnvironment?: NodeJS.ProcessEnv;
}): Promise<{ command: string; environment: NodeJS.ProcessEnv }> {
const source = options.sourceEnvironment ?? options.environment;
const home = join(options.directory, "argent-home");
await mkdir(home, { recursive: true, mode: 0o700 });
const command = join(options.directory, "argent-controller");
await writeFile(command, `#!/bin/sh\nexec ${shellQuote(process.execPath)} ${shellQuote(ARGENT_CONTROLLER_WORKER)} "$@"\n`, { mode: 0o700 });
// agent-device's variables never reach Argent's bridge, and Argent's never reach agent-device.
const environment = Object.fromEntries(Object.entries(options.environment).filter(([name]) => !/^(AGENT_DEVICE_|ARGENT_)/.test(name)));
return {
command,
environment: { ...environment, HOME: home, DO_NOT_TRACK: "1",
ARGENT_TOOLS_URL: options.connection.daemonBaseUrl,
...(options.connection.daemonAuthToken ? { ARGENT_AUTH_TOKEN: options.connection.daemonAuthToken } : {}),
EXPLORE_ARGENT_STATE: join(options.directory, "argent-state.json"), EXPLORE_ARGENT_PLATFORM: options.platform,
// The bridge runs with a HOME of its own, so it is told where the fetched Argent release is cached.
EXPLORE_CONTROLLER_CACHE: controllerCacheRoot(source),
...(source.EXPLORE_NPM_REGISTRY ? { EXPLORE_NPM_REGISTRY: source.EXPLORE_NPM_REGISTRY } : {}),
// Opt-in: each Argent call to a JSON-lines log, one file per session, for debugging a controller run.
...(source.EXPLORE_ARGENT_LOG_DIR ? { EXPLORE_ARGENT_LOG_DIR: source.EXPLORE_ARGENT_LOG_DIR, EXPLORE_ARGENT_LOG_NAME: options.connection.sessionId } : {}),
...(options.bundleId ? { EXPLORE_ARGENT_BUNDLE_ID: options.bundleId } : {}),
...(options.device ? { EXPLORE_ARGENT_DEVICE: options.device } : {}),
...(options.pose ? { EXPLORE_ARGENT_POSE: options.pose } : {}) },
};
}
+32
View File
@@ -0,0 +1,32 @@
/**
* Runs a device controller Explore fetches on first use: `controller-launcher.js <controller> <args...>` makes sure
* the pinned release is in the cache, then runs it with the arguments, passing its output and exit code through.
* A failed fetch answers in agent-device's JSON envelope, so callers report it like any controller failure.
*/
import { spawn } from "node:child_process";
import { ensureController, type ControllerName } from "../shared/controller-cache.js";
async function main(): Promise<number> {
const [controller, ...args] = process.argv.slice(2);
if (controller !== "agent-device") {
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: `Unknown controller: ${controller ?? ""}` } }));
return 1;
}
let bin: string;
try { bin = await ensureController(controller as ControllerName, { progress: message => process.stderr.write(`[explore] ${message}\n`) }); }
catch (error) {
const failure = error as { code?: string; message?: string; nextAction?: string };
process.stdout.write(JSON.stringify({ success: false, error: { code: failure.code ?? "CONTROLLER_DOWNLOAD_FAILED",
message: failure.message ?? String(error), ...(failure.nextAction ? { hint: failure.nextAction } : {}) } }));
return 1;
}
return new Promise(resolve => {
const child = spawn(process.execPath, [bin, ...args], { stdio: "inherit" });
// A capture that stops the launcher stops the controller with it.
for (const signal of ["SIGINT", "SIGTERM"] as const) process.on(signal, () => child.kill(signal));
child.on("exit", (code, signal) => resolve(code ?? (signal ? 1 : 0)));
child.on("error", () => resolve(1));
});
}
process.exitCode = await main();
+8 -3
View File
@@ -14,20 +14,25 @@ export function defaultRunner(request: CommandRequest): CommandResult {
...(request.timeoutMs ? { timeout: request.timeoutMs } : {}),
});
if (result.error) throw result.error;
return commandOutcome(request, { status: result.status, stdout: result.stdout ?? "", stderr: result.stderr ?? "" });
}
/** A finished command's output, or the error its exit status and output describe. */
export function commandOutcome(request: CommandRequest, result: { status: number | null; stdout: string; stderr: string }): CommandResult {
if (result.status !== 0 && !request.allowFailure) {
const sessionIndex = request.args.indexOf("--session");
// Our own session or a caller's session attached by explore:session: both answer --json failures with a structured error.
const structuredFailure = (sessionIndex >= 0 && request.args[sessionIndex + 1] === CONTROLLER_SESSION) || request.args.includes("--json")
? controllerCommandFailure(result.stdout ?? "", request.args[0] ?? "command") : undefined;
? controllerCommandFailure(result.stdout, request.args[0] ?? "command") : undefined;
if (structuredFailure) throw structuredFailure;
const subcommand = typeof request.args[0] === "string" ? ` ${request.args[0]}` : "";
const detail = failureDetail(`${result.stderr ?? ""}\n${result.stdout ?? ""}`);
const detail = failureDetail(`${result.stderr}\n${result.stdout}`);
throw new Error(
`${request.command}${subcommand} exited with status ${result.status ?? "unknown"}`
+ (detail ? `: ${detail}` : ""),
);
}
return { stdout: result.stdout ?? "", stderr: result.stderr ?? "" };
return { stdout: result.stdout, stderr: result.stderr };
}
/** Keep the CLI tool host responsive while a remote controller request is in flight. */
+25 -54
View File
@@ -1,4 +1,4 @@
import { cp, lstat, realpath, mkdtemp, mkdir, writeFile, readFile, rm } from "node:fs/promises";
import { cp, lstat, realpath, mkdtemp, mkdir, writeFile, readFile, rename, rm } from "node:fs/promises";
import { tmpdir } from "node:os";
import { isAbsolute, basename, dirname, resolve, join } from "node:path";
import type { SourceRoute } from "../contracts/source-route.js";
@@ -146,35 +146,6 @@ async function downloadedAppPath(stdout: string, privateRoot: string, platform:
return canonical;
}
function uploadedBuildId(stdout: string): string {
const value = parseJson(stdout, "eas upload");
if (!isRecord(value) || typeof value.url !== "string") {
throw new Error("eas upload did not return a build URL");
}
let url: URL;
try {
url = new URL(value.url);
} catch {
throw new Error("eas upload returned an invalid build URL");
}
if (
url.protocol !== "https:"
|| url.hostname !== "expo.dev"
|| url.port
|| url.username
|| url.password
|| url.search
|| url.hash
) {
throw new Error("eas upload returned an untrusted build URL");
}
const segments = url.pathname.split("/").filter(Boolean);
if (segments.at(-2) !== "builds") {
throw new Error("eas upload returned an unexpected build URL");
}
return buildIdFrom({ id: segments.at(-1) }, "eas upload");
}
export type RepackProfile = {
easEnvironment: string;
profileEnvironment: Record<string, string>;
@@ -525,6 +496,12 @@ async function prepareHostedRepack(options: {
return hostedRepackBuildId(run.stdout, run.stderr, options.platform);
}
/**
* The instrumented app a capture runs, on this machine, and the EAS build it came from when a hosted job repacked it.
* A local repack is never uploaded, so it has no build id.
*/
export type PreparedBuild = { buildId: string | null; app: string };
export async function prepareExactSourceBuild(options: {
platform?: "ios" | "android";
runner: CommandRunner;
@@ -537,14 +514,16 @@ export async function prepareExactSourceBuild(options: {
easEnvironment: NodeJS.ProcessEnv;
repackEnvironment: NodeJS.ProcessEnv;
routes: readonly SourceRoute[];
/** `eas` (default) repacks in a hosted EAS workflow job; `local` runs repack-app on this machine and `eas upload`s the result. */
/** `eas` (default) repacks in a hosted EAS workflow job; `local` runs repack-app on this machine. */
repack?: RepackMode | undefined;
/** The capture build profile name; the hosted repack job builds against it. */
easProfile?: string | undefined;
}): Promise<string | undefined> {
/** Where to leave the instrumented app on this machine, for the capture to install; it must not exist yet. */
keepApp: string;
}): Promise<PreparedBuild | undefined> {
const platform = options.platform ?? "ios";
const root = await mkdtemp(join(tmpdir(), "expo-explore-repack-"));
let outcome: string | null | undefined;
let outcome: PreparedBuild | null | undefined;
let primaryError: unknown;
try {
const providers = [...new Set(options.routes.map(route => route.provider))];
@@ -553,10 +532,18 @@ export async function prepareExactSourceBuild(options: {
nextAction: "Select the application's navigation provider in config.yaml and rerun source planning." });
if ((options.repack ?? "eas") === "eas") {
if (!options.easProfile) throw new Error("The hosted repack needs the capture build profile name.");
outcome = await prepareHostedRepack({ platform, runner: options.runner, easCommand: options.easCommand, project: options.project,
const hosted = await prepareHostedRepack({ platform, runner: options.runner, easCommand: options.easCommand, project: options.project,
nativeBuildId: options.nativeBuildId, easProfile: options.easProfile, repackProfile: options.repackProfile,
easEnvironment: options.easEnvironment, restrictedEnvironment: options.repackEnvironment, provider: providers[0]!,
parameterKeys: captureObserverParameterKeys(options.routes), root });
{
// The hosted job leaves its app on EAS; the capture installs a copy downloaded here.
const downloaded = await downloadedAppPath(options.runner({ command: options.easCommand,
args: ["build:download", "--build-id", hosted, "--json", "--non-interactive"], cwd: options.project,
environment: { ...options.easEnvironment, TMPDIR: root, TMP: root, TEMP: root }, timeoutMs: 10 * 60_000 }).stdout, root, platform);
await rename(downloaded, options.keepApp);
outcome = { buildId: hosted, app: options.keepApp };
}
} else {
const shadowProject = join(root, "eas-project");
const pulledEnvironmentPath = join(root, "server.env");
@@ -671,26 +658,10 @@ export async function prepareExactSourceBuild(options: {
if (repackedInfo.isSymbolicLink() || (platform === "android" ? !repackedInfo.isFile() : !repackedInfo.isDirectory())) {
throw new Error(platform === "android" ? "repack-app did not produce a non-symlink Android .apk file" : "repack-app did not produce a non-symlink iOS .app directory");
}
let uploaded;
try {
uploaded = options.runner({
command: options.easCommand,
args: [
"upload",
"--platform", platform,
"--build-path", repackedApp,
"--fingerprint", options.fingerprint,
"--json",
"--non-interactive",
],
cwd: options.project,
environment: privateEasEnvironment,
timeoutMs: 10 * 60_000,
});
} catch (error) {
throw easPlanLimitError(error, platform) ?? error;
}
outcome = uploadedBuildId(uploaded.stdout);
// The capture installs the repacked app from here (a local device directly, an EAS session through its
// controller), so it is never uploaded.
await rename(repackedApp, options.keepApp);
outcome = { buildId: null, app: options.keepApp };
}
}
} catch (error) {
+74
View File
@@ -0,0 +1,74 @@
import { randomUUID } from "node:crypto";
import { mkdir, readdir, readFile, rename, rm, writeFile } from "node:fs/promises";
import { join } from "node:path";
import { exploreCacheRoot } from "../shared/cache-root.js";
import { deleteLocalEmulator, deleteLocalSimulator, emulatorPortsDirectory, stopLocalAgentDevice, stopLocalArgentServer } from "./local-simulator.js";
import type { CommandRunner } from "./run.js";
/**
* What one capture side started on this machine: its simulator or emulator, its agent-device daemon (under `directory`)
* and its Argent tool-server, with the process that owns them. A capture that stops cleanly removes its record; one
* stopped hard (a second Ctrl+C, a killed terminal) leaves it, and the next local review cleans up after it.
*/
export type LocalCaptureRecord = { owner: number; startedAt: string; directory: string; udid?: string; serial?: string; avd?: string;
argent?: { pid: number; cli: string; home: string } };
function registryDirectory(environment: NodeJS.ProcessEnv): string {
return join(exploreCacheRoot(environment), "local-captures");
}
/** Records what a capture side starts, as it starts it; `close` forgets it once everything is stopped. */
export async function openLocalCaptureRecord(environment: NodeJS.ProcessEnv, directory: string): Promise<{
update: (patch: Partial<Omit<LocalCaptureRecord, "owner" | "startedAt" | "directory">>) => Promise<void>; close: () => Promise<void> }> {
const registry = registryDirectory(environment);
await mkdir(registry, { recursive: true, mode: 0o700 });
const path = join(registry, `${randomUUID()}.json`);
let record: LocalCaptureRecord = { owner: process.pid, startedAt: new Date().toISOString(), directory };
const write = async () => {
// Written whole and renamed, so a sweep never reads half a record.
await writeFile(`${path}.tmp`, JSON.stringify(record), { mode: 0o600 });
await rename(`${path}.tmp`, path);
};
await write();
return { update: async patch => { record = { ...record, ...patch }; await write(); }, close: () => rm(path, { force: true }) };
}
function alive(pid: number): boolean {
if (!Number.isInteger(pid) || pid <= 0) return false;
try { process.kill(pid, 0); return true; } catch (error) { return (error as NodeJS.ErrnoException).code === "EPERM"; }
}
/**
* Stops what captures whose process has exited left running, and says what it stopped. Only what Explore recorded is
* touched, never other simulators or emulators on this machine. An emulator's console port may have been taken by a
* live capture since; then that emulator is left alone rather than risk stopping the live one.
*/
export async function sweepLocalCaptures(options: { environment: NodeJS.ProcessEnv; runner: CommandRunner; cwd: string }): Promise<string[]> {
const registry = registryDirectory(options.environment);
const swept: string[] = [];
for (const name of await readdir(registry).catch(() => [] as string[])) {
if (!name.endsWith(".json")) continue;
const path = join(registry, name);
const record = await readFile(path, "utf8").then(text => JSON.parse(text) as LocalCaptureRecord, () => undefined);
if (!record || typeof record.owner !== "number" || alive(record.owner)) continue;
const { runner, cwd, environment } = options;
let complete = true;
const attempt = async (what: string, stop: () => unknown) => {
try { await stop(); swept.push(what); } catch { complete = false; }
};
if (record.argent && Number.isInteger(record.argent.pid)) {
const argent = record.argent;
await attempt(`Argent tool-server (pid ${argent.pid})`, () => stopLocalArgentServer({ ...argent, environment: { PATH: environment.PATH, HOME: argent.home } }));
}
if (typeof record.directory === "string") await attempt("agent-device daemon", () => stopLocalAgentDevice(join(record.directory, "agent-device-state")));
if (typeof record.udid === "string") await attempt(`simulator ${record.udid}`, () => deleteLocalSimulator({ runner, udid: record.udid!, cwd, environment }));
if (typeof record.serial === "string") {
const holder = Number(await readFile(join(emulatorPortsDirectory(environment), `${record.serial.slice("emulator-".length)}.lock`), "utf8").catch(() => ""));
if (!alive(holder) || holder === record.owner) await attempt(`emulator ${record.serial}`, () => deleteLocalEmulator({ runner, serial: record.serial!, cwd, environment }));
}
if (!complete) continue;
if (typeof record.directory === "string") await rm(record.directory, { recursive: true, force: true });
await rm(path, { force: true });
}
return swept;
}
+430
View File
@@ -0,0 +1,430 @@
import { spawnSync } from "node:child_process";
import { existsSync } from "node:fs";
import { mkdir, readdir, readFile, rm, stat, symlink, writeFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
import { apkAbis } from "../binary/archive.js";
import { exploreCacheRoot } from "../shared/cache-root.js";
import { CiError } from "../shared/ci-errors.js";
import { isRecord, parseJson } from "./common.js";
import type { CommandRunner } from "./run.js";
/**
* A simulator Explore creates on this Mac for one capture (`capture.simulator: local`), in place of an EAS Simulator
* session. Each capture gets its own device, so head and base run side by side without sharing app state, and the
* device is deleted when the capture ends.
*/
export type LocalSimulator = { udid: string; name: string; deviceType: string; runtime: string; osVersion: string };
/** A session state file names a local simulator with this prefix, so an interrupted review deletes it rather than calling EAS. */
export const LOCAL_SIMULATOR_STATE_PREFIX = "simctl-";
const UDID = /^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/;
function simctl(runner: CommandRunner, args: string[], cwd: string, environment: NodeJS.ProcessEnv, timeoutMs = 60_000, allowFailure = false) {
return runner({ command: "xcrun", args: ["simctl", ...args], cwd, environment, timeoutMs, ...(allowFailure ? { allowFailure } : {}) });
}
function versionKey(version: string): number[] {
return version.split(".").map(part => Number.parseInt(part, 10) || 0);
}
function newer(left: string, right: string): boolean {
const a = versionKey(left), b = versionKey(right);
for (let index = 0; index < Math.max(a.length, b.length); index += 1) {
if ((a[index] ?? 0) !== (b[index] ?? 0)) return (a[index] ?? 0) > (b[index] ?? 0);
}
return false;
}
/** The device type named like the configured device, and the newest installed iOS runtime that runs it. */
export function localSimulatorTarget(devicetypes: string, runtimes: string, device: string): { deviceType: string; runtime: string; osVersion: string } {
const types = parseJson(devicetypes, "simctl list devicetypes");
const type = (isRecord(types) && Array.isArray(types.devicetypes) ? types.devicetypes : [])
.find(entry => isRecord(entry) && entry.name === device);
if (!isRecord(type) || typeof type.identifier !== "string") throw new CiError({ code: "LOCAL_SIMULATOR_DEVICE_UNAVAILABLE", stage: "session",
message: `This Mac's Xcode has no ${device} simulator.`,
nextAction: `Set device.name in config.yaml to a simulator listed by xcrun simctl list devicetypes, or install the Xcode that adds ${device} and select it with xcode-select.` });
const listed = parseJson(runtimes, "simctl list runtimes");
let best: { runtime: string; osVersion: string } | undefined;
for (const entry of isRecord(listed) && Array.isArray(listed.runtimes) ? listed.runtimes : []) {
if (!isRecord(entry) || entry.isAvailable !== true || entry.platform !== "iOS" || typeof entry.identifier !== "string" || typeof entry.version !== "string") continue;
const supported = Array.isArray(entry.supportedDeviceTypes) && entry.supportedDeviceTypes.some(supportedType => isRecord(supportedType) && supportedType.identifier === type.identifier);
if (supported && (!best || newer(entry.version, best.osVersion))) best = { runtime: entry.identifier, osVersion: entry.version };
}
if (!best) throw new CiError({ code: "LOCAL_SIMULATOR_RUNTIME_UNAVAILABLE", stage: "session",
message: `No installed iOS simulator runtime runs ${device}.`,
nextAction: "Install an iOS simulator runtime in Xcode (Settings > Components) that supports this device, then rerun." });
return { deviceType: type.identifier, ...best };
}
/**
* Creates a fresh simulator of the configured device and starts it booting. `simctl boot` returns while the device is
* still starting, so a capture boots it before repacking the app and waits for it (waitForLocalSimulator) afterwards.
*/
export async function createLocalSimulator(options: { runner: CommandRunner; device: string; name: string; cwd: string; environment: NodeJS.ProcessEnv;
/** Called with the new device's UDID before it boots, so a caller can record it for cleanup. */
created?: (udid: string) => void | Promise<void> }): Promise<LocalSimulator> {
const { runner, cwd, environment } = options;
const target = localSimulatorTarget(simctl(runner, ["list", "devicetypes", "-j"], cwd, environment).stdout,
simctl(runner, ["list", "runtimes", "-j"], cwd, environment).stdout, options.device);
const udid = simctl(runner, ["create", options.name, target.deviceType, target.runtime], cwd, environment).stdout.trim();
if (!UDID.test(udid)) throw new Error("simctl create did not return a simulator UDID");
await options.created?.(udid);
simctl(runner, ["boot", udid], cwd, environment, 5 * 60_000);
return { udid, name: options.name, ...target };
}
/** Waits until a simulator createLocalSimulator started has finished booting. */
export function waitForLocalSimulator(options: { runner: CommandRunner; udid: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
simctl(options.runner, ["bootstatus", options.udid, "-b"], options.cwd, options.environment, 5 * 60_000);
}
/**
* Lets the app open its own links without iOS asking "Open in “App”?" first, as a person would have approved it once.
* EAS Simulator gives no access to the device, so its captures still answer the prompt (route-capture.ts); a local
* simulator never shows it.
*/
export function approveLinkScheme(options: { runner: CommandRunner; udid: string; scheme: string; bundleId: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
if (!/^[A-Za-z][A-Za-z0-9+.-]*$/.test(options.scheme)) throw new Error("Not a URL scheme");
simctl(options.runner, ["spawn", options.udid, "defaults", "write", "com.apple.launchservices.schemeapproval",
`com.apple.CoreSimulator.CoreSimulatorBridge-->${options.scheme}`, "-string", options.bundleId], options.cwd, options.environment);
}
/** The pixel size of a PNG, from its header. */
export function pngSize(bytes: Buffer): { width: number; height: number } | undefined {
if (bytes.length < 24 || bytes.toString("latin1", 12, 16) !== "IHDR") return undefined;
return { width: bytes.readUInt32BE(16), height: bytes.readUInt32BE(20) };
}
/**
* Whether a local foldable shows the pose it was folded to, by the shape of its lit display: the inner one is landscape
* when open, the outer one portrait when closed. A half-open hinge shows either, so it is not checked.
*/
export async function localPoseShown(options: { runner: CommandRunner; udid: string; pose: string; directory: string; cwd: string; environment: NodeJS.ProcessEnv;
sleep?: (milliseconds: number) => void }): Promise<boolean> {
if (options.pose !== "open" && options.pose !== "closed") return true;
const file = join(options.directory, "pose.png");
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
// The display relights and resizes over a moment after the hinge moves.
for (let attempt = 0; attempt < 10; attempt += 1) {
if (attempt) sleep(1_000);
simctl(options.runner, ["io", options.udid, "screenshot", file], options.cwd, options.environment, 60_000, true);
const size = pngSize(await readFile(file).catch(() => Buffer.alloc(0)));
await rm(file, { force: true });
if (size && (options.pose === "open" ? size.width > size.height : size.height > size.width)) return true;
}
return false;
}
export function installOnLocalSimulator(options: { runner: CommandRunner; udid: string; app: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
simctl(options.runner, ["install", options.udid, options.app], options.cwd, options.environment, 5 * 60_000);
}
/** Shuts the simulator down and deletes it. Shutting down a device that is not booted fails harmlessly; only the delete counts. */
export function deleteLocalSimulator(options: { runner: CommandRunner; udid: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
if (!UDID.test(options.udid)) throw new Error("Not a simulator UDID");
simctl(options.runner, ["shutdown", options.udid], options.cwd, options.environment, 2 * 60_000, true);
simctl(options.runner, ["delete", options.udid], options.cwd, options.environment, 2 * 60_000);
}
/** The UDID a session state file records for a local simulator, or undefined when it names an EAS session. */
export function localSimulatorFromState(state: string): string | undefined {
if (!state.startsWith(LOCAL_SIMULATOR_STATE_PREFIX)) return undefined;
const udid = state.slice(LOCAL_SIMULATOR_STATE_PREFIX.length);
return UDID.test(udid) ? udid : undefined;
}
/**
* An Android emulator Explore creates on this machine for one capture. Its AVD lives in the capture's own
* `ANDROID_AVD_HOME`, so it never appears among the user's emulators and goes with the capture's directory.
*/
export type LocalEmulator = { serial: string; avd: string; avdHome: string; image: string; osVersion: string };
/** A session state file names a local emulator by its adb serial with this prefix. */
export const LOCAL_EMULATOR_STATE_PREFIX = "adb-";
const SERIAL = /^emulator-[0-9]{4}$/;
/** The SDK's own tools, so a different adb or avdmanager earlier on PATH does not answer for this SDK. */
export function androidTools(environment: NodeJS.ProcessEnv): { sdk: string; adb: string; emulator: string; avdmanager: string } {
const sdk = environment.ANDROID_HOME || environment.ANDROID_SDK_ROOT;
if (!sdk) throw new CiError({ code: "ANDROID_SDK_MISSING", stage: "session",
message: "A local Android emulator needs the Android SDK, and neither ANDROID_HOME nor ANDROID_SDK_ROOT is set.",
nextAction: "Install the SDK's platform-tools, emulator, cmdline-tools and a system image with sdkmanager, export ANDROID_HOME, and rerun." });
return { sdk, adb: join(sdk, "platform-tools", "adb"), emulator: join(sdk, "emulator", "emulator"), avdmanager: join(sdk, "cmdline-tools", "latest", "bin", "avdmanager") };
}
/** The ABI an emulator runs natively on this machine: Apple silicon runs arm64 images; x86_64 images need an Intel host. */
export function hostEmulatorAbi(arch: string = process.arch): string {
return arch === "arm64" ? "arm64-v8a" : "x86_64";
}
/** The newest installed Google APIs system image for this machine's ABI, as `system-images;android-35;google_apis;arm64-v8a`. */
export async function localSystemImage(sdk: string, abi: string): Promise<{ image: string; apiLevel: number }> {
let best: { image: string; apiLevel: number } | undefined;
const platforms = await readdir(join(sdk, "system-images")).catch(() => [] as string[]);
for (const platform of platforms) {
const apiLevel = Number(/^android-(\d+)$/.exec(platform)?.[1]);
if (!Number.isInteger(apiLevel)) continue;
for (const tag of ["google_apis_playstore", "google_apis"]) {
if (!existsSync(join(sdk, "system-images", platform, tag, abi, "system.img"))) continue;
if (!best || apiLevel > best.apiLevel) best = { image: `system-images;${platform};${tag};${abi}`, apiLevel };
}
}
if (!best) throw new CiError({ code: "LOCAL_EMULATOR_IMAGE_UNAVAILABLE", stage: "session",
message: `The Android SDK at ${sdk} has no Google APIs system image for ${abi}.`,
nextAction: `Install one, for example: sdkmanager "system-images;android-35;google_apis;${abi}", then rerun.` });
return best;
}
/** Refuses an APK whose native libraries cannot load on this machine's emulator, before an emulator is started for it. */
export async function assertLocalEmulatorCompatible(apk: string, abi: string): Promise<void> {
const abis = await apkAbis(apk);
if (abis.length && !abis.includes(abi)) throw new CiError({ code: "LOCAL_EMULATOR_ABI_UNSUPPORTED", stage: "session",
message: `The APK ships native libraries only for ${abis.join(", ")}; this machine's emulator runs ${abi}.`,
nextAction: `Build an APK that includes ${abi} (a universal build does), or capture Android on EAS Simulator with --simulator eas.` });
}
/**
* Whether agent-device still holds a claim on an emulator serial, one an interrupted run left behind: it refuses
* such a serial even when it reports the claim as stale, so startLocalEmulator skips that port.
*/
export function agentDeviceClaims(options: { runner: CommandRunner; agentDevice: string; serial: string; cwd: string; environment: NodeJS.ProcessEnv }): boolean {
const status = options.runner({ command: options.agentDevice, args: ["device", "status", "--platform", "android", "--serial", options.serial, "--json"],
cwd: options.cwd, environment: options.environment, timeoutMs: 30_000, allowFailure: true });
let data: { claims?: unknown[]; hiddenStaleClaims?: number } | undefined;
try { data = (JSON.parse(status.stdout) as { data?: typeof data }).data; } catch { return false; }
return (data?.claims?.length ?? 0) + (data?.hiddenStaleClaims ?? 0) > 0;
}
/**
* Creates an AVD of the configured device profile (such as pixel_7) and starts it without a window. It boots in the
* background while a capture repacks the app; waitForLocalEmulator waits for it afterwards.
*/
export async function startLocalEmulator(options: { runner: CommandRunner; device: string; name: string; directory: string; cwd: string; environment: NodeJS.ProcessEnv;
/** Called with the emulator's adb serial once it is starting, so a caller can record it for cleanup. */
started?: (serial: string) => void | Promise<void>;
/** Whether the controller still holds a serial (a claim an interrupted run left behind); such a port is skipped. */
claimed?: (serial: string) => boolean }): Promise<Omit<LocalEmulator, "osVersion"> & { apiLevel: number }> {
const { runner, cwd } = options;
const tools = androidTools(options.environment);
const avdHome = join(options.directory, "avd");
await mkdir(avdHome, { recursive: true });
const environment = { ...options.environment, ANDROID_AVD_HOME: avdHome };
const { image, apiLevel } = await localSystemImage(tools.sdk, hostEmulatorAbi());
const created = runner({ command: tools.avdmanager, args: ["create", "avd", "--name", options.name, "--package", image, "--device", options.device, "--force"],
cwd, environment: { ...environment, ANDROID_SDK_ROOT: tools.sdk }, timeoutMs: 2 * 60_000, allowFailure: true });
if (!existsSync(join(avdHome, `${options.name}.avd`))) throw new CiError({ code: "LOCAL_EMULATOR_DEVICE_UNAVAILABLE", stage: "session",
message: `avdmanager could not create an ${options.device} emulator: ${(created.stderr || created.stdout).trim().split("\n").at(-1) ?? "no output"}`,
nextAction: "Set device.name to a device profile listed by avdmanager list device -c (such as pixel_7), then rerun." });
// Emulators listen on even console ports from 5554; this one takes the first that adb does not list and no other capture
// has reserved, since several start at once.
const listed = runner({ command: tools.adb, args: ["devices"], cwd, environment, timeoutMs: 30_000 }).stdout;
let port = 5554;
while (listed.includes(`emulator-${port}`) || listed.includes(`emulator-${port + 1}`) || options.claimed?.(`emulator-${port}`) || !await reservePort(port, options.environment)) {
port += 2;
if (port > 5682) throw new CiError({ code: "LOCAL_EMULATOR_PORT_UNAVAILABLE", stage: "session", message: "Every emulator console port (5554-5682) is in use.",
nextAction: "Stop some running emulators (adb devices lists them), then rerun." });
}
const serial = `emulator-${port}`;
// The emulator runs until the capture kills it; the shell returns as soon as it is started.
// gRPC (with a token) makes the emulator publish itself in avd/running, where Argent's device server finds it.
runner({ command: "/bin/sh", args: ["-c", 'nohup "$0" "$@" > "$EXPLORE_EMULATOR_LOG" 2>&1 &', tools.emulator, "-avd", options.name, "-port", String(port),
"-grpc", String(port + 3000), "-grpc-use-token", "-no-window", "-no-audio", "-no-boot-anim", "-no-snapshot", "-gpu", "swiftshader_indirect"],
cwd, environment: { ...environment, EXPLORE_EMULATOR_LOG: join(options.directory, "emulator.log") }, timeoutMs: 30_000 });
await options.started?.(serial);
return { serial, avd: options.name, avdHome, image, apiLevel };
}
/** Waits until an emulator startLocalEmulator started has booted, and reads its Android version. */
export function waitForLocalEmulator(options: { runner: CommandRunner; serial: string; device: string; apiLevel: number; directory: string; cwd: string;
environment: NodeJS.ProcessEnv; now?: () => number; sleep?: (milliseconds: number) => void }): string {
const { runner, serial, cwd } = options;
const tools = androidTools(options.environment);
const environment = { ...options.environment, ANDROID_AVD_HOME: join(options.directory, "avd") };
const now = options.now ?? Date.now;
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
runner({ command: tools.adb, args: ["-s", serial, "wait-for-device"], cwd, environment, timeoutMs: 5 * 60_000 });
const deadline = now() + 5 * 60_000;
while (runner({ command: tools.adb, args: ["-s", serial, "shell", "getprop", "sys.boot_completed"], cwd, environment, timeoutMs: 30_000, allowFailure: true }).stdout.trim() !== "1") {
if (now() > deadline) throw new CiError({ code: "LOCAL_EMULATOR_BOOT_TIMEOUT", stage: "session",
message: `The ${options.device} emulator did not finish booting in 5 minutes.`, nextAction: `Inspect ${join(options.directory, "emulator.log")} and rerun.` });
sleep(2_000);
}
return runner({ command: tools.adb, args: ["-s", serial, "shell", "getprop", "ro.build.version.release"], cwd, environment, timeoutMs: 30_000 }).stdout.trim() || String(options.apiLevel);
}
export function installOnLocalEmulator(options: { runner: CommandRunner; serial: string; apk: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
const { adb } = androidTools(options.environment);
options.runner({ command: adb, args: ["-s", options.serial, "install", "-r", options.apk], cwd: options.cwd, environment: options.environment, timeoutMs: 5 * 60_000 });
}
/**
* Where captures reserve emulator console ports: a directory of this user's Explore cache, not the machine's temporary
* directory, which on Linux is shared with other users who could plant a lock (or a symlink in its place).
*/
export function emulatorPortsDirectory(environment: NodeJS.ProcessEnv): string {
return join(exploreCacheRoot(environment), "emulator-ports");
}
/** The reservation of one console port; it names the process holding it. */
function portLock(port: number, environment: NodeJS.ProcessEnv): string {
return join(emulatorPortsDirectory(environment), `${port}.lock`);
}
/** Whether a process this user can see is running; a pid that is not a positive integer names none. */
function processAlive(pid: number): boolean {
if (!Number.isInteger(pid) || pid <= 0) return false;
try { process.kill(pid, 0); return true; } catch (error) { return (error as NodeJS.ErrnoException).code === "EPERM"; }
}
/**
* Reserves a console port for this process; a reservation whose process has exited is taken over. Head and base start
* their emulators at once on worker threads of one process, and other reviews may too: each reservation runs alone,
* under a mutex directory, since taking over a stale lock is a read, a removal and a write that two captures would
* otherwise both complete. The mutex names its holder; one left by a process that died holding it is broken by a
* single capture at a time (a breaker directory), which checks again that it is still the dead holder's.
*/
export async function reservePort(port: number, environment: NodeJS.ProcessEnv): Promise<boolean> {
const directory = emulatorPortsDirectory(environment);
await mkdir(directory, { recursive: true, mode: 0o700 });
const mutex = join(directory, "mutex"), breaker = join(directory, "mutex-breaker");
// A holder writes its pid right after creating the mutex; a mutex without one is a holder between the two, unless old.
const abandoned = async (path: string) => {
const info = await stat(path).catch(() => undefined);
if (!info) return false;
// 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; }
catch (error) {
if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error;
if (await abandoned(mutex)) {
let breaking = false;
try { await mkdir(breaker); breaking = true; }
catch (failure) { if ((failure as NodeJS.ErrnoException).code !== "EEXIST") throw failure; if (await abandoned(breaker)) await rm(breaker, { recursive: true, force: true }); }
if (breaking) {
try { await writeFile(join(breaker, "owner"), String(process.pid)); if (await abandoned(mutex)) await rm(mutex, { recursive: true, force: true }); }
finally { await rm(breaker, { recursive: true, force: true }); }
continue;
}
}
await new Promise(resolve => setTimeout(resolve, 20));
}
}
try {
const lock = portLock(port, environment);
if (processAlive(Number(await readFile(lock, "utf8").catch(() => "")))) return false;
await writeFile(lock, String(process.pid));
return true;
} finally {
await rm(mutex, { recursive: true, force: true });
}
}
/** Stops the emulator and frees its console port; its AVD goes with the capture's directory. */
export async function deleteLocalEmulator(options: { runner: CommandRunner; serial: string; cwd: string; environment: NodeJS.ProcessEnv }): Promise<void> {
if (!SERIAL.test(options.serial)) throw new Error("Not an emulator serial");
const { adb } = androidTools(options.environment);
// An emulator that already exited (or crashed) is stopped too; only one adb still lists is not.
options.runner({ command: adb, args: ["-s", options.serial, "emu", "kill"], cwd: options.cwd, environment: options.environment, timeoutMs: 60_000, allowFailure: true });
const listed = (serial: string) => options.runner({ command: adb, args: ["devices"], cwd: options.cwd, environment: options.environment, timeoutMs: 30_000, allowFailure: true })
.stdout.split("\n").some(line => line.split("\t")[0] === serial && line.includes("device"));
for (let attempt = 0; listed(options.serial); attempt += 1) {
if (attempt === 10) throw new Error(`${options.serial} is still running after emu kill`);
await new Promise(resolve => setTimeout(resolve, 1_000));
}
// An emulator adb has lost (its console port closed, a child defunct) is not listed and ignores emu kill, yet runs on
// with its AVD open; its process, by the AVD name and port this capture started it with, is stopped instead.
const port = Number(options.serial.slice("emulator-".length));
const running = () => options.runner({ command: "pgrep", args: ["-f", `qemu-system.* -avd explore-[a-z]+-[0-9a-f]{8} -port ${port} `], cwd: options.cwd,
environment: options.environment, timeoutMs: 30_000, allowFailure: true }).stdout.split("\n").map(Number).filter(pid => Number.isInteger(pid) && pid > 0);
for (let attempt = 0, pids = running(); pids.length > 0; attempt += 1, pids = running()) {
if (attempt === 10) throw new Error(`${options.serial} is still running after it was signalled`);
for (const pid of pids) try { process.kill(pid, attempt < 5 ? "SIGTERM" : "SIGKILL"); } catch { /* it has already exited */ }
await new Promise(resolve => setTimeout(resolve, 1_000));
}
await rm(portLock(port, options.environment), { force: true });
}
/** The adb serial a session state file records for a local emulator, or undefined when it names something else. */
export function localEmulatorFromState(state: string): string | undefined {
if (!state.startsWith(LOCAL_EMULATOR_STATE_PREFIX)) return undefined;
const serial = state.slice(LOCAL_EMULATOR_STATE_PREFIX.length);
return SERIAL.test(serial) ? serial : undefined;
}
/** Argent's tool-server for one capture on this machine: where it listens, its token, and its process. */
/** A capture's own tool-server; `environment` is the narrowed one it was started with, which stopping it uses too. */
export type LocalArgentServer = { url: string; token: string; pid: number; cli: string; home: string; environment: NodeJS.ProcessEnv };
/**
* Starts Argent's tool-server for one capture, on a free port, with a HOME of its own so captures running side by
* side do not share its state, and waits for it to say where it listens. Its simulator server looks for devices
* under $HOME, so that HOME links to this machine's simulators and Android settings.
*/
export async function startLocalArgentServer(options: { runner: CommandRunner; cli: string; directory: string; cwd: string; environment: NodeJS.ProcessEnv;
now?: () => number; sleep?: (milliseconds: number) => void }): Promise<LocalArgentServer> {
const home = join(options.directory, "argent-server-home"), log = join(options.directory, "argent-server.log");
await mkdir(join(home, "Library", "Developer"), { recursive: true, mode: 0o700 });
const realHome = options.environment.HOME || homedir();
// Running emulators publish themselves (gRPC port and token) in TemporaryItems/avd/running.
const running = join("Library", "Caches", "TemporaryItems", "avd");
await mkdir(join(realHome, running), { recursive: true });
await mkdir(join(home, "Library", "Caches", "TemporaryItems"), { recursive: true, mode: 0o700 });
for (const path of [join("Library", "Developer", "CoreSimulator"), ".android", running]) {
if (existsSync(join(realHome, path))) await symlink(join(realHome, path), join(home, path)).catch(error => { if (error.code !== "EEXIST") throw error; });
}
const environment = { ...options.environment, HOME: home, DO_NOT_TRACK: "1" };
const started = options.runner({ command: "/bin/sh", args: ["-c", 'nohup "$0" "$1" server start --port 0 > "$EXPLORE_ARGENT_SERVER_LOG" 2>&1 & echo $!', process.execPath, options.cli],
cwd: options.cwd, environment: { ...environment, EXPLORE_ARGENT_SERVER_LOG: log }, timeoutMs: 30_000 });
const pid = Number(started.stdout.trim());
const now = options.now ?? Date.now;
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
const deadline = now() + 60_000;
for (;;) {
const text = await readFile(log, "utf8").catch(() => "");
const url = /Tools server listening on (http:\/\/127\.0\.0\.1:\d+)/.exec(text)?.[1];
const token = /--token ([0-9a-f]+)/.exec(text)?.[1];
if (url && token && Number.isInteger(pid) && pid > 0) return { url, token, pid, cli: options.cli, home, environment };
if (now() > deadline) {
if (Number.isInteger(pid) && pid > 0) stopLocalArgentServer({ pid, cli: options.cli, home, environment });
throw new CiError({ code: "LOCAL_ARGENT_UNAVAILABLE", stage: "session", message: `Argent's tool-server did not start: ${text.trim().split("\n").at(-1) ?? "no output"}`,
nextAction: `Inspect ${log}, then rerun.` });
}
sleep(500);
}
}
/** Stops the tool-server the way Argent does (its own `server stop`, which ends the server it spawned), then its process. */
export function stopLocalArgentServer(server: Pick<LocalArgentServer, "pid" | "cli" | "home" | "environment">): void {
// The capture's narrowed environment, as at start: never the tokens and keys in this process's own.
spawnSync(process.execPath, [server.cli, "server", "stop"], { env: { ...server.environment, HOME: server.home }, timeout: 30_000, stdio: "ignore" });
try { process.kill(server.pid, "SIGTERM"); } catch { /* it has already exited */ }
}
/** Switches a local simulator's appearance from the host, for a controller that cannot (Argent). */
export function setLocalSimulatorAppearance(options: { runner: CommandRunner; udid: string; scheme: "light" | "dark"; cwd: string; environment: NodeJS.ProcessEnv }): void {
simctl(options.runner, ["ui", options.udid, "appearance", options.scheme], options.cwd, options.environment);
}
/** Switches a local emulator's night mode from the host, for a controller that cannot (Argent). */
export function setLocalEmulatorAppearance(options: { runner: CommandRunner; serial: string; scheme: "light" | "dark"; cwd: string; environment: NodeJS.ProcessEnv }): void {
const { adb } = androidTools(options.environment);
options.runner({ command: adb, args: ["-s", options.serial, "shell", "cmd", "uimode", "night", options.scheme === "dark" ? "yes" : "no"],
cwd: options.cwd, environment: options.environment, timeoutMs: 60_000 });
}
/**
* Stops the agent-device daemon a local capture ran in its own state directory. `close` ends the session, but the
* daemon outlives a directory removed under it; the pid it records (daemon.json) is the one to stop.
*/
export async function stopLocalAgentDevice(stateDirectory: string): Promise<void> {
const info = await readFile(join(stateDirectory, "daemon.json"), "utf8").then(text => JSON.parse(text) as { pid?: unknown }, () => undefined);
if (typeof info?.pid === "number" && Number.isInteger(info.pid) && info.pid > 0 && info.pid !== process.pid) {
try { process.kill(info.pid, "SIGTERM"); } catch { /* it has already exited */ }
}
}
+150 -21
View File
@@ -23,10 +23,13 @@ import { createExplorationInputs } from "../config/exploration-inputs.js";
import { isRecord, captureError, CONTROLLER_SESSION, parseJson } from "./common.js";
import { MAX_ACCESSIBILITY_EVIDENCE_BYTES, adbDeviceOffline, remoteDaemonUnavailable, controllerData, defaultRunner, type ControllerReadRecovery, type RemoteDaemonRetry, runControllerRead, controllerCommandFailure, runControllerReadAsync, runAgentControllerCommand, wedgedControllerReadFailure, openedSimulatorDevice, alertWatchdogFailure } from "./controller.js";
import type { ActiveSimulatorRuntime, SimulatorConnection } from "./simulator.js";
import { androidTools } from "./local-simulator.js";
import type { CiMapOptions, CommandResult } from "./run.js";
/** iOS commands name the simulator; an EAS Android session has exactly one emulator, selected by the session. */
export function deviceArgs(runtime: Pick<ActiveSimulatorRuntime, "platform" | "deviceModel">): string[] {
export function deviceArgs(runtime: Pick<ActiveSimulatorRuntime, "platform" | "deviceModel"> & Partial<Pick<ActiveSimulatorRuntime, "provider" | "controllerDeviceId">>): string[] {
// A local simulator is picked by its UDID, a local emulator by its adb serial: this machine may run others of the same model.
if (runtime.provider === "local-simulator" && runtime.controllerDeviceId) return [runtime.platform === "android" ? "--serial" : "--udid", runtime.controllerDeviceId];
return runtime.platform === "android" ? [] : ["--device", runtime.deviceModel];
}
@@ -90,12 +93,16 @@ function snapshotNodes(raw: string): Record<string, unknown>[] {
}
/** The visible element each required label matched, so an image assessor can find icon-only controls. */
export function verifiedCaptureLabels(nodes: readonly Record<string, unknown>[], requiredLabels: readonly string[]) {
export function verifiedCaptureLabels(nodes: readonly Record<string, unknown>[], requiredLabels: readonly string[],
/** The screen's portrait height, when the screenshot is that screen turned a quarter clockwise (an opened iPhone Duo). */
turned?: { height: number }) {
return requiredLabels.flatMap(value => nodes.filter(node => node.visible !== false && (node.label === value || node.identifier === value)).slice(0, 3).map(node => {
const rect = isRecord(node.rect) && ["x", "y", "width", "height"].every(key => Number.isFinite((node.rect as Record<string, unknown>)[key]))
? node.rect as { x: number; y: number; width: number; height: number } : undefined;
// The bounds are given on the image's axes: turned a quarter clockwise, the portrait point (x, y) is at (H - y, x).
const shown = rect && turned ? { x: turned.height - rect.y - rect.height, y: rect.x, width: rect.height, height: rect.width } : rect;
return { value, matchedField: node.label === value ? "label" as const : "identifier" as const,
...(typeof node.type === "string" ? { type: node.type } : {}), ...(rect ? { rect: { x: rect.x, y: rect.y, width: rect.width, height: rect.height } } : {}) };
...(typeof node.type === "string" ? { type: node.type } : {}), ...(shown ? { rect: { x: shown.x, y: shown.y, width: shown.width, height: shown.height } } : {}) };
}));
}
@@ -136,7 +143,9 @@ function landing(nodes: readonly Record<string, unknown>[], route: SourceRoute,
/** Execute source-owned targets in order. Live content never changes the source inventory. */
export async function capturePlannedRoutes(options: {
capture: CiMapOptions; routes: readonly SourceRoute[]; scheme: string | undefined; appName: string;
runtime: ActiveSimulatorRuntime; connection: SimulatorConnection; environment: NodeJS.ProcessEnv;
runtime: ActiveSimulatorRuntime;
/** The EAS session's controller connection; a local simulator has none. */
connection?: SimulatorConnection | undefined; environment: NodeJS.ProcessEnv;
store: ExploreStore; map: ExploreMap;
inventory?: readonly SourceRoute[];
acceptedFrames?: Record<string, AgentAcceptedFrame>;
@@ -328,7 +337,7 @@ export async function capturePlannedRoutes(options: {
message: "The Open confirmation did not complete within its capture budget.",
nextAction: "Inspect the controller diagnostic and verify that the pinned controller can dismiss the configured app's Open confirmation.",
details: { controller: serializeCiError(toCiError(error, { code: "CONTROLLER_ALERT_FAILED", stage: "capture" }),
{ secrets: [capture.expoToken, options.connection.daemonAuthToken] }) } });
{ secrets: [capture.expoToken, ...(options.connection ? [options.connection.daemonAuthToken] : [])] }) } });
}
const remainingAlert = alertInspection("deep-link-confirmed");
if (remainingAlert && (!allowExplicitSetupAlert || expectedTitles.includes(remainingAlert.message.normalize("NFC").trim()))) {
@@ -337,7 +346,7 @@ export async function capturePlannedRoutes(options: {
controllerApp();
controller(["wait", "500", "--level", "full", "--json"]);
};
const secrets = [capture.expoToken, options.connection.daemonAuthToken, ...inputs.values, ...(capture.agent?.secretValues ?? [])];
const secrets = [capture.expoToken, ...(options.connection ? [options.connection.daemonAuthToken] : []), ...inputs.values, ...(capture.agent?.secretValues ?? [])];
const redact = (text: string): string => secrets.filter(Boolean).flatMap(value => [value, JSON.stringify(value).slice(1, -1), encodeURIComponent(value)])
.sort((a, b) => b.length - a.length).reduce((result, value) => result.split(value).join("[REDACTED]"), inputs.redact(text));
const redactValue = <T>(value: T): T => {
@@ -521,9 +530,13 @@ export async function capturePlannedRoutes(options: {
const height = png.readUInt32BE(20);
runtime.orientation = width > height ? "landscape" : "portrait";
map.run.environment.orientation = runtime.orientation;
controllerApp();
const raw = controller(["snapshot", "--force-full", "--level", "full", "--json"]).stdout;
const confirmed = snapshotNodes(raw);
// The snapshot after the screenshot names the app in front, which saves an `appstate` call per route; a
// controller whose snapshot does not name it is asked.
const read = controllerData(raw, "snapshot");
if (read.appBundleId !== undefined || isRecord(read.identifiers)) assertIdentity(read, capture.bundleId, runtime.controllerDeviceId);
else controllerApp();
assertNoAlert({ route, nodes: confirmed });
const verifiedLanding: "verified" | "unverified" = unattributed ? "unverified" : landing(confirmed, route, inventory);
assertSafeScreenshot(confirmed);
@@ -673,17 +686,39 @@ export async function capturePlannedRoutes(options: {
rect: isRecord(node.rect) ? Object.fromEntries(Object.entries(node.rect).sort(([left], [right]) => left.localeCompare(right))) : node.rect,
parentIndex: node.parentIndex,
})));
/**
* The logical coordinate space a frame's normalized taps map into. On a panel whose native axes are portrait but
* whose UI is landscape (an opened iPhone Duo under Argent), the screenshot is taken upright: the portrait screen
* turned a quarter clockwise, while the accessibility tree and taps stay on the panel's portrait axes. Its root is
* then the transpose of the frame, and a tap is turned back (see `toLogical`).
*/
const bounds = (frame: Candidate) => {
const roots = frame.snapshot.nodes.filter(node => node.type === "Application" && isRecord(node.rect)
const roots = (transposed: boolean) => frame.snapshot.nodes.filter(node => node.type === "Application" && isRecord(node.rect)
&& node.rect.x === 0 && node.rect.y === 0 && typeof node.rect.width === "number" && typeof node.rect.height === "number"
&& Number.isFinite(node.rect.width) && Number.isFinite(node.rect.height) && node.rect.width > 0 && node.rect.height > 0
&& node.rect.width * frame.height === node.rect.height * frame.width);
if (roots.length !== 1) throw captureError("AGENT_COORDINATE_BOUNDS_UNVERIFIED", "The screenshot does not identify one matching full-screen logical coordinate space.");
&& (transposed ? node.rect.width * frame.width === node.rect.height * frame.height : node.rect.width * frame.height === node.rect.height * frame.width));
// A square screen matches both ways; it is read upright, as before rotated frames existed.
const upright = roots(false), turned = upright.length ? [] : roots(true);
const matched = upright.length ? upright : turned;
if (matched.length !== 1) throw captureError("AGENT_COORDINATE_BOUNDS_UNVERIFIED", "The screenshot does not identify one matching full-screen logical coordinate space.");
// The official iOS screenshot is full-screen. Its default is 1x, but a proven
// uniform pixel density must still map to XCTest points rather than raw pixels.
const rect = roots[0]!.rect as { width: number; height: number };
return { width: rect.width, height: rect.height };
const rect = matched[0]!.rect as { width: number; height: number };
return { width: rect.width, height: rect.height, transposed: turned.length === 1 };
};
/**
* A normalized point (x, y) in the screenshot, in the tree's logical points. Upright, it scales by the root. Turned:
* a portrait screen W wide and H tall, turned a quarter clockwise, is an image H wide and W tall in which the portrait
* point (px, py) lands at (u, v) = (H - py, px); so the image point (u, v) is the portrait point (v, H - u). With
* u = x * H and v = y * W, that is (y * W, (1 - x) * H). (A 2x3 portrait pixel at (0, 0), centre (0.5, 0.5), sits at
* column 2 of the turned 3x2 image, centre (2.5, 0.5), which maps back to (0.5, 3 - 2.5).)
*/
/** The portrait screen a turned (upright landscape) frame shows, or undefined for a frame on the screen's own axes. */
const turnedSpace = (frame: Candidate): { height: number } | undefined => {
try { const space = bounds(frame); return space.transposed ? { height: space.height } : undefined; } catch { return undefined; }
};
const toLogical = (space: { width: number; height: number; transposed: boolean }, x: number, y: number): [number, number] =>
space.transposed ? [y * space.width, (1 - x) * space.height] : [x * space.width, y * space.height];
/**
* agent-device's in-app back taps a navigation control and cannot leave a sheet without one.
* Swipe such a sheet down, then require the observed destination to change.
@@ -826,7 +861,7 @@ export async function capturePlannedRoutes(options: {
retryable: true, details: changes });
}
await discard();
await command(["press", String(action.x * oldBounds.width), String(action.y * oldBounds.height), "--level", "full", "--json"], signal);
await command(["press", ...toLogical(oldBounds, action.x, action.y).map(String), "--level", "full", "--json"], signal);
} finally { await discard(); await rm(previous.directory, { recursive: true, force: true }); }
return;
}
@@ -862,7 +897,7 @@ export async function capturePlannedRoutes(options: {
let assessment;
try {
assessment = rejectedReadiness.get(key) ?? await agent.assessCapture({ image: frame.png, route: route.route, context,
instructions: agent.instructions, verifiedLabels: verifiedCaptureLabels(frame.snapshot.nodes, context.requiredLabels),
instructions: agent.instructions, verifiedLabels: verifiedCaptureLabels(frame.snapshot.nodes, context.requiredLabels, turnedSpace(frame)),
deadlineMs: deadline, signal: liveSignal(signal) });
if (assessment.imageSha256 !== frame.imageSha256) throw new Error("Readiness assessment belongs to another frame");
await writeFile(join(diagnostics, `${stem}.json`), JSON.stringify(redactValue({ route: route.route, context, ...assessment })), { mode: 0o600 });
@@ -949,6 +984,52 @@ export async function capturePlannedRoutes(options: {
* reported as the failure it is. Only steps up to the fault have run, so no later state exists.
*/
const transientControllerFault = (error: unknown) => adbDeviceOffline(error) || remoteDaemonUnavailable(error);
/**
* A controller that stopped answering on one screen (its runner wedged on an accessibility capture or a covered
* control, or its reads stayed busy past their recovery window) fails every later read the same way. That costs the
* step or route it happened on, not the capture: the app is stopped (from the host on a local device, which a wedged
* runner cannot block) and started again, the read recovery starts over, and the controller must answer before the
* next route. Each recovery is recorded in capture-diagnostics/controller-recoveries.jsonl.
*/
const controllerWedged = (error: unknown): boolean => {
if (wedgedControllerReadFailure(error)) return true;
const failure = toCiError(error);
// An accessibility read that never completes (or never returns a whole tree) is the controller's failure, not the app's.
return ["CONTROLLER_READ_BUSY", "RUNNER_WEDGED", "CONTROLLER_RUNNER_WEDGED", "INVALID_ACCESSIBILITY_EVIDENCE", "SETUP_SYSTEM_SURFACE_BLOCKING"].includes(failure.code)
|| /execution watchdog|accessibility responsiveness|requires a valid viewport/.test(failure.message);
};
/**
* A setup step that left another app in front (a tap that landed on a system control drawn over the app, as iPhone
* Duo's status pill over a sheet's Done button) is recovered the same way: the app is started again.
*/
const appLeft = (error: unknown): boolean => toCiError(error).code === "CONTROLLER_IDENTITY_MISMATCH";
let recoveries = 0;
/** `next` records what the capture did once the app restarted: `setup-rerun` or `setup-incomplete` after a setup step. */
const recoverController = (where: string, error: unknown, next?: "setup-rerun" | "setup-incomplete"): boolean => {
const reported = serializeCiError(toCiError(error), { secrets });
const record = (recovered: boolean) => {
const diagnostics = join(store.root, "capture-diagnostics");
mkdirSync(diagnostics, { recursive: true, mode: 0o700 });
appendFileSync(join(diagnostics, "controller-recoveries.jsonl"), `${JSON.stringify({ where, code: reported.code, message: reported.message, recovered,
...(recovered && next ? { next } : {}), at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
};
if (recoveries >= 3 || deadline - clock() < 60_000) { record(false); return false; }
recoveries += 1;
say(`${appLeft(error) ? "the app was no longer in front" : "the device controller stopped answering"} on ${where} (${reported.code}); restarting the app before going on`);
try {
if (runtime.provider === "local-simulator") runner(runtime.platform === "ios"
? { command: "xcrun", args: ["simctl", "terminate", runtime.controllerDeviceId, capture.bundleId], cwd: store.root, environment: options.environment, timeoutMs: 60_000, allowFailure: true }
: { command: androidTools(options.environment).adb, args: ["-s", runtime.controllerDeviceId, "shell", "am", "force-stop", capture.bundleId],
cwd: store.root, environment: options.environment, timeoutMs: 60_000, allowFailure: true });
for (const key of Object.keys(readRecovery)) delete (readRecovery as Record<string, unknown>)[key];
readRecovery.busyAttempts = 0;
controller(["open", capture.bundleId, "--relaunch", "--level", "full", "--json"]);
settle();
snapshot();
} catch { record(false); return false; }
record(true);
return true;
};
const recoverFromControllerFault = (error: unknown): boolean => {
if (!transientControllerFault(error) || deadline - clock() < 30_000) return false;
const reported = serializeCiError(toCiError(error), { secrets });
@@ -965,6 +1046,14 @@ export async function capturePlannedRoutes(options: {
fault: reported.message, at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
return true;
};
/**
* A setup step that wedged the controller or left the app has not run, nor have the steps after it (a login, seeded
* data, a permission), so routes opened by app link may show the wrong state. Once the app is restarted, setup runs
* again from the start, once. When it stops the same way again, the routes go on by app link (so one covered control
* does not fail the whole capture), and each route captured afterwards says in its outcome that setup did not complete.
*/
let setupRerunAfterRecovery = false;
let setupIncomplete: string | undefined;
for (let setupAttempt = 0; ; setupAttempt += 1) try {
await executeCaptureSetup((capture.setup ?? []).map(action => action.action === "fill" || action.action === "type" ? { ...action, text: inputs.resolve(action.text) } : action), {
command: args => { controllerApp(); return controller(args); },
@@ -996,6 +1085,19 @@ export async function capturePlannedRoutes(options: {
break;
} catch (error) {
if (setupAttempt === 0 && recoverFromControllerFault(error)) continue;
// A wedged controller says nothing about the app's state: the routes the steps before it prepared are captured or
// failed on their own. Once the controller answers again, setup runs again from the start, once.
if ((controllerWedged(error) || appLeft(error)) && recoverController("a setup step", error, setupRerunAfterRecovery ? "setup-incomplete" : "setup-rerun")) {
const reported = serializeCiError(toCiError(error), { secrets });
if (!setupRerunAfterRecovery) {
setupRerunAfterRecovery = true;
say(`setup stopped (${reported.code}); running setup again from the start`);
continue;
}
setupIncomplete = `Setup did not complete: a setup step stopped twice (${reported.code}), so this route was opened by app link without the state the remaining setup steps prepare.`;
say(`setup stopped again (${reported.code}); setup did not complete, and the routes it had not reached go on by app link marked as such`);
break;
}
const failure = toCiError(error, { code: "SETUP_FAILED", stage: "setup" });
const diagnostics: Record<string, string> = {};
const directory = join(store.root, "capture-diagnostics");
@@ -1051,14 +1153,18 @@ export async function capturePlannedRoutes(options: {
const linked = options.routes.filter(route => !(outcomes[route.id]?.status === "captured" && !setupFailure) && !(prepared.has(route.id) && outcomes[route.id]?.status !== "captured"));
let opened = 0;
/**
* Opens the app's root link and lets it settle, so the route link that follows starts from the
* app's home rather than from the sheet, modal or list the previous link left on screen. The
* OS may ask to confirm the root link too; that confirmation is answered here so the route's
* own poll never mistakes it for its own.
* Opens the app's root link, so the route link that follows starts from the app's home rather than from the sheet,
* modal or list the previous link left on screen. The first attempt only opens it: the route's own readiness poll
* checks where its link landed and answers a confirmation the OS asks for. A route that landed wrong is retried
* after a full reset, which lets the root settle and answers the root link's own confirmation first.
*/
const resetToRoot = () => {
const resetToRoot = (full: boolean) => {
controller(["open", capture.bundleId, rootLink!, "--level", "full", "--json"]);
// The root link closes what the last route presented; the next link waits until that has finished. A link that lands
// while a sheet is still being dismissed can leave the app unable to present another sheet until it is relaunched
// (seen on iOS: euxy's share link, opened right after its share sheet, never showed its own).
settle();
if (!full) return;
if (snapshot().nodes.some(node => node.type === "Alert")) {
resolveDeepLinkConfirmation();
settle();
@@ -1093,10 +1199,12 @@ export async function capturePlannedRoutes(options: {
try {
// Every route link starts from the app's home, not from what the previous link left on
// screen; the app keeps running, since relaunching invalidates photo and translation prerequisites.
if (rootLink && deepLink !== rootLink) resetToRoot();
if (rootLink && deepLink !== rootLink) resetToRoot(attempt > 1);
const opened = controller(["open", capture.bundleId, deepLink, "--level", "full", "--json"]);
const device = openedSimulatorDevice(opened.stdout, capture.bundleId, "capture open", runtime.platform);
if (device.deviceId !== runtime.controllerDeviceId || device.deviceModel !== runtime.deviceModel) throw captureError("CONTROLLER_IDENTITY_MISMATCH", "The controller changed the selected device.");
// A local simulator is named for Explore and recorded as the model it was created as; its UDID identifies it.
if (device.deviceId !== runtime.controllerDeviceId
|| (runtime.provider !== "local-simulator" && device.deviceModel !== runtime.deviceModel)) throw captureError("CONTROLLER_IDENTITY_MISMATCH", "The controller changed the selected device.");
// The open response already proved the controller's device and app; the capture asserts the
// session again after its screenshot, and resolves a link confirmation only if the snapshot calls for it.
readiness = { startedAt: clock(), budgetMs: readinessBudgetMs(attempt), attempt };
@@ -1104,7 +1212,26 @@ export async function capturePlannedRoutes(options: {
await captureCurrent(route, attempt);
break;
} catch (error) {
// The emulator's adb connection dropped (a local one does once, early, under load) or the daemon was unreachable:
// that says nothing about this route. Once the device answers again, the route opens again from the app's root.
if (attempt === 1 && transientControllerFault(error) && deadline - clock() > 30_000) {
let answered = true;
try { controllerApp(); } catch { answered = false; }
if (answered) {
const diagnostics = join(store.root, "capture-diagnostics");
mkdirSync(diagnostics, { recursive: true, mode: 0o700 });
appendFileSync(join(diagnostics, "controller-retries.jsonl"), `${JSON.stringify({ command: "open", route: route.route, reason: "route-reopened-after-device-lost",
fault: serializeCiError(toCiError(error), { secrets }).message, at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
continue;
}
}
const failure = failedOutcome(error, attempt);
// A wedged controller costs this route only: once its retries are spent, the next route starts on a restarted app.
if (controllerWedged(error) && (attempt === 2 || !failure.error?.retryable)) {
outcomes[route.id] = { ...failure, reason: "The device controller stopped answering on this screen; Explore restarted the app and went on with the next route." };
recoverController(route.route, error);
break;
}
if (failure.status === "budget-exhausted" || !failure.error?.retryable || attempt === 2) {
outcomes[route.id] = failure;
if (attempt === 2) await captureUnattributed(route, attempt, error);
@@ -1112,6 +1239,8 @@ export async function capturePlannedRoutes(options: {
}
}
}
const outcome = outcomes[route.id];
if (setupIncomplete && outcome?.status === "captured") outcomes[route.id] = { ...outcome, reason: outcome.reason ? `${outcome.reason} ${setupIncomplete}` : setupIncomplete };
reportOutcome(route, "by app link");
}
return outcomes;
+590 -106
View File
@@ -1,4 +1,4 @@
import { appearanceArgs, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, type AppearanceSetting, type ColorScheme } from "./appearance.js";
import { appearanceArgs, argentColorSchemes, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, schemeScreenId, type AppearanceSetting, type ColorScheme } from "./appearance.js";
import { assertNoCaptureHealthIssues, captureHealthIssues, partitionCaptureHealthIssues } from "./health.js";
import { type RouteResetSetting } from "./route-reset.js";
import { defaultReadinessSeconds } from "./readiness.js";
@@ -14,15 +14,25 @@ import type { SourceCapturePlan } from "../source/capture-plan.js";
import { CONTRACT, type ExploreMap, type Platform, type RunStatus } from "../types.js";
import { ExploreStore, validateMap } from "../map/store.js";
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
import type { CaptureSetupAction } from "../config/explore-config.js";
import type { CaptureSetupAction, DevicePose } from "../config/explore-config.js";
import { type CiAgentRuntimeOptions } from "./agent/runtime.js";
import { EAS_CLI_VERSION, AGENT_DEVICE_VERSION, CONTROLLER_SESSION, isRecord, parseJson, baseEnvironment, nonEmpty } from "./common.js";
import { EAS_CLI_VERSION, CONTROLLER_SESSION, isRecord, parseJson, baseEnvironment, nonEmpty } from "./common.js";
import { lstatIfExists, isWithin, temporaryCaptureDirectory, absoluteContractFile, readContractJson, assertNoSymlinkAncestors } from "./fs-safety.js";
import { loadAppIcon, loadCachedAppIcon, storeAppIcon } from "./app-icon.js";
import { defaultRunner } from "./controller.js";
import { defaultRunner, runAgentControllerCommand } from "./controller.js";
import { silentProgress, type Progress } from "../shared/progress.js";
import { assertCaptureEasProfile, assertSimulatorAvailable, fingerprintFrom, hasEasEnvironmentFetchFailure, nativeBuildFrom, existingBuild, repackProfileFrom, prepareExactSourceBuild, type RepackMode } from "./eas-build.js";
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, simulatorOsVersion, type ActiveSimulatorRuntime } from "./simulator.js";
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, endedOwnSimulatorSession, liveSimulatorSessionsNamed, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, controllerVersion, simulatorOsVersion, type ActiveSimulatorRuntime, type SimulatorConnection } from "./simulator.js";
import { argentControllerInvocation } from "./controller-invocation.js";
import { startArgentBridgeRunner, type ArgentBridgeRunner } from "./argent-bridge-host.js";
import { sharedBuild } from "./shared-build.js";
import { LOCAL_EMULATOR_STATE_PREFIX, LOCAL_SIMULATOR_STATE_PREFIX, agentDeviceClaims, assertLocalEmulatorCompatible, createLocalSimulator, startLocalEmulator, waitForLocalEmulator, waitForLocalSimulator, deleteLocalEmulator,
deleteLocalSimulator, hostEmulatorAbi, installOnLocalEmulator, installOnLocalSimulator, approveLinkScheme, localPoseShown,
pngSize, setLocalEmulatorAppearance, setLocalSimulatorAppearance, startLocalArgentServer, stopLocalAgentDevice, stopLocalArgentServer, type LocalArgentServer } from "./local-simulator.js";
import { ensureArgentToolServer } from "../shared/controller-cache.js";
import { openLocalCaptureRecord } from "./local-registry.js";
import { approveSessionUrlSchemes, simulatorControl, simulatorControlActions, type EasCommand } from "./simulator-control.js";
import { solidColour } from "../shared/png-evidence.js";
import { type UnattributedSetting } from "./unattributed.js";
import { appScheme, hasConcreteRoutePath, unavailableRoute, capturePlannedRoutes, deviceArgs } from "./route-capture.js";
@@ -51,10 +61,24 @@ export type CiMapOptions = {
/** Host-side pause used while a controller read is resent; tests pair it with `now` so recovery waits are not real time. */
sleep?: (milliseconds: number) => void;
easCommand: string; repackCommand: string; agentDeviceCommand: string;
/** The device controller EAS starts on the session; agent-device unless the config chose Argent. */
controller?: "agent-device" | "argent";
/** A foldable's pose (device.pose), set with the controller's `fold` before anything is captured. */
devicePose?: DevicePose;
/** Where the app runs: an EAS Simulator session (default), or a simulator created on this Mac for the capture. */
simulator?: "eas" | "local";
/** Where the route observer is bundled into the app: a hosted EAS repack job (default) or repack-app on this machine. */
repack?: RepackMode;
/** A folder the review's captures share builds through: targets of one platform, profile and commit build and repack once. */
buildShare?: string;
/** Which appearances to capture; `auto` (default) follows the app's `userInterfaceStyle`. */
appearance?: AppearanceSetting;
/**
* One session's share of the appearance passes when a side splits them across sessions: `capture` names the passes
* this run makes, out of the `all` it would make alone, so frames keep the ids of a single run (`<id>@dark`) and the
* exports merge. Absent: every resolved appearance.
*/
appearancePass?: { all: readonly ColorScheme[]; capture: readonly ColorScheme[] };
/** Whether to observe the app launch (splash screen) per appearance; `video` also keeps the recording. Defaults to `off`. */
launch?: LaunchSetting;
/** Decodes launch recordings; defaults to ffmpeg when installed. */
@@ -69,7 +93,7 @@ export type CiMapOptions = {
signal?: AbortSignal;
};
export type SimulatorRuntimeMetadata = {
provider: "eas-simulator"; controller: "agent-device"; controllerPackageVersion: string;
provider: "eas-simulator" | "local-simulator"; controller: "agent-device" | "argent"; controllerPackageVersion: string;
easCliVersion: string; platform: Platform; deviceModel: string; osVersion: string; locale: string;
orientation: "portrait" | "landscape"; colorScheme: "light" | "dark" | "system"; colorSchemes?: ColorScheme[];
sessionLifecycle: "stopped";
@@ -83,6 +107,46 @@ export type CiMapResult = {
};
/** New EAS sessions a capture starts in place of one EAS failed to start (ERRORED while booting, or never named). */
const SESSION_START_RETRIES = 5;
/**
* The most time, from the first failed start, that replacement sessions may take, waits included. It keeps a review
* inside its CI job (90 minutes for a baseline) with a native build, a repack and both captures still to run.
*/
const SESSION_RETRY_BUDGET_MS = 30 * 60_000;
/** How long one `eas simulator:start` may take: eas-cli waits up to 15 minutes for a session, not counting the queue. */
const SESSION_START_TIMEOUT_MS = 20 * 60_000;
/** The wait before each of them: 10 s, doubling, at most 2 minutes. */
export function sessionRetryDelayMs(retry: number): number {
return Math.min(10_000 * 2 ** (retry - 1), 120_000);
}
/**
* Minutes an EAS session is asked for beyond the capture's own budget. The session starts beside the repack, and the
* capture deadline only starts once the app is installed, so the session also has to outlast a slow or queued hosted
* repack, the app's upload and its install; 20 minutes covers a typical repack with room for a queue.
*/
const SESSION_PREPARATION_MINUTES = 20;
/**
* EAS refuses (before allocating anything) a session longer than the plan allows, naming that maximum. Only that exact
* rejection is recognized; any other start failure is kept as it is.
*/
function sessionDurationLimit(error: unknown): number | undefined {
const match = /max duration must not exceed (\d+(?:\.\d+)?) minutes/i.exec(error instanceof Error ? error.message : String(error));
return match ? Math.floor(Number(match[1])) : undefined;
}
/**
* A start failure EAS may not repeat on the next try: a failed request, a dropped connection, a timeout, or no capacity
* right now. An account's quota, plan or permissions are not, and fail at once rather than after every retry.
*/
function transientSessionStartFailure(error: unknown): boolean {
if (error instanceof CiError && error.code === "CONTROLLER_REQUEST_TIMEOUT") return true;
const message = error instanceof Error ? error.message : String(error);
if (/not authori[sz]ed|unauthori[sz]ed|forbidden|permission|quota|billing|max duration/i.test(message)) return false;
return /GraphQL request failed|ECONNRESET|ETIMEDOUT|EAI_AGAIN|socket hang up|timed out|\b50[234]\b|capacity/i.test(message);
}
function positiveInteger(value: number, name: string): number {
if (!Number.isInteger(value) || value <= 0) {
throw new Error(`${name} must be a positive integer`);
@@ -94,7 +158,7 @@ function newCaptureMap(options: CiMapOptions, runtime?: ActiveSimulatorRuntime,
const timestamp = new Date((options.now ?? Date.now)()).toISOString();
return {
contract: CONTRACT, revision: 0,
run: { id: options.buildId, name: options.name, platform: options.platform, controller: "agent-device", status: "draft",
run: { id: options.buildId, name: options.name, platform: options.platform, controller: options.controller ?? "agent-device", status: "draft",
bundleId: options.bundleId, ...(runtime ? { deviceId: runtime.controllerDeviceId } : {}),
createdAt: timestamp, updatedAt: timestamp,
build: { id: options.buildId, version: options.buildVersion, gitCommit: options.gitCommit, source: "eas", ...(fingerprint ? { hash: fingerprint } : {}) },
@@ -161,8 +225,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
});
const routes = inventory.filter(route => selected.has(route.id));
const setup = revisionSetup(options.setup ?? [], plan, side);
const runner = options.runner ?? defaultRunner;
let runner = options.runner ?? defaultRunner;
const sourceEnvironment = options.environment ?? process.env;
const controller = options.controller ?? "agent-device";
const local = options.simulator === "local";
const restrictedEnvironment = baseEnvironment(sourceEnvironment);
const easEnvironment = { ...restrictedEnvironment, ...(options.expoToken ? { EXPO_TOKEN: options.expoToken } : {}) };
const assertCheckout = () => {
@@ -279,7 +345,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
app = { name: cachedBundle.appName ?? options.name };
appIcon = await loadCachedAppIcon(cacheRoot, cachedBundle.appIcon);
const cachedProfile = cachedBundle.runtimeProfile!;
runtime = { provider: "eas-simulator", controller: "agent-device", controllerPackageVersion: AGENT_DEVICE_VERSION,
runtime = { provider: local ? "local-simulator" : "eas-simulator", controller, controllerPackageVersion: controllerVersion(controller),
easCliVersion: EAS_CLI_VERSION, platform: options.platform, controllerDeviceId: cachedDeviceId ?? "cached",
deviceModel: cachedProfile.deviceModel, osVersion: cachedProfile.osVersion, locale: cachedProfile.locale,
orientation: cachedProfile.orientation === "landscape" ? "landscape" : "portrait",
@@ -294,7 +360,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
let captureFailure: unknown;
const finish = async (): Promise<CiMapResult> => {
if (!(await store.exists())) await store.initialize(map, false);
const incomplete = captureFailure !== undefined || selectedIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
// A session making only secondary passes owns the `<id>@<scheme>` frames of those passes, not the primary ones.
const ownFrameIds = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
? selectedIds.flatMap(id => colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)).map(scheme => schemeScreenId(id, scheme)))
: selectedIds;
const incomplete = captureFailure !== undefined || ownFrameIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
|| map.gaps.some(gap => gap.status === "open");
map.run.status = incomplete || map.screens.length === 0 ? "partial" : "complete";
if (routes.length === 0) map.run.stopReason = "No source targets require capture.";
@@ -305,7 +375,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const errors = await validateMap(map, store);
if (errors.length) throw new Error(`Captured map failed validation: ${errors.join("; ")}`);
await store.exportTo(outputDirectory, map);
for (const name of ["setup-accessibility.json", "setup-screen.png", "agent-navigation.jsonl", "alert-inspection.jsonl", "accessibility-deferral.jsonl", "system-prompts.jsonl", "controller-retries.jsonl"]) {
for (const name of ["setup-accessibility.json", "setup-screen.png", "agent-navigation.jsonl", "alert-inspection.jsonl", "accessibility-deferral.jsonl", "system-prompts.jsonl", "controller-retries.jsonl", "controller-recoveries.jsonl"]) {
const source = join(mapDirectory, "capture-diagnostics", name);
if (!(await lstatIfExists(source))) continue;
await assertNoSymlinkAncestors(mapDirectory, source, "setup diagnostic");
@@ -313,6 +383,9 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
await copyFile(source, join(outputDirectory, "capture-diagnostics", name));
}
const images: CaptureBundle["images"] = {};
// The build a frame came from: the repacked app's EAS build, or for a repack on this machine, which is never
// uploaded, the native EAS build it repacked. The bundle names it too, as the review's build.
const frameBuildId = easBuildId ?? nativeEasBuildId;
for (const observation of map.observations) {
// A secondary-appearance screen (`<route>@<scheme>`) exports under its route's outcome, with its own frame, or
// under its own outcome when the primary pass lost the route and this pass captured it.
@@ -320,13 +393,13 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const owner = (scheme && outcomes[observation.screenId]) || outcomes[routeId];
if (!selected.has(routeId) || owner?.status !== "captured") continue;
const artifact = map.artifacts.find(value => value.id === observation.screenshotArtifactId);
if (!artifact || (!easBuildId && !cachedImages[observation.screenId])) continue;
if (!artifact || (!frameBuildId && !cachedImages[observation.screenId])) continue;
const png = await readFile(join(outputDirectory, artifact.path));
assertDecodedPng(png, "Exported capture image");
const expectedSha256 = scheme ? artifact.sha256 : outcomes[routeId]?.screenshotSha256;
if (createHash("sha256").update(png).digest("hex") !== expectedSha256) throw new Error("Exported screenshot does not match the captured frame");
images[observation.screenId] = cachedImages[observation.screenId] ?? { path: artifact.path, sha256: artifact.sha256, width: png.readUInt32BE(16), height: png.readUInt32BE(20),
capturedAt: observation.capturedAt, sourceCommit: options.gitCommit, buildId: easBuildId! };
capturedAt: observation.capturedAt, sourceCommit: options.gitCommit, buildId: frameBuildId! };
}
const metadata: SimulatorRuntimeMetadata | null = runtime ? { provider: runtime.provider, controller: runtime.controller,
controllerPackageVersion: runtime.controllerPackageVersion, easCliVersion: runtime.easCliVersion, platform: runtime.platform,
@@ -348,8 +421,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
}
await rm(launchWorkDirectory, { recursive: true, force: true });
const storedIcon = appIcon ? await storeAppIcon(outputDirectory, appIcon) : undefined;
const bundle: CaptureBundle = { contract: "explore.bundle", side, gitCommit: options.gitCommit, easBuildId, completedAt: map.run.completedAt,
easProjectId: projectId, platform: options.platform, profile: options.easProfile, appName: app.name, ...(storedIcon ? { appIcon: storedIcon } : {}),
const bundle: CaptureBundle = { contract: "explore.bundle", side, gitCommit: options.gitCommit, easBuildId: frameBuildId, completedAt: map.run.completedAt,
easProjectId: projectId, platform: options.platform, profile: options.easProfile, appName: app.name, ...(controller === "argent" ? { controller } : {}), ...(storedIcon ? { appIcon: storedIcon } : {}),
selectedSurfaceIds: selectedIds,
runtimeProfile: metadata ? { deviceModel: metadata.deviceModel, osVersion: metadata.osVersion, locale: metadata.locale,
orientation: metadata.orientation, colorScheme: metadata.colorScheme, ...(metadata.colorSchemes ? { colorSchemes: metadata.colorSchemes.join(",") } : {}) } : null, images, outcomes, procedure: { reset: options.reset ?? "root-link", readinessSeconds: options.readinessSeconds ?? defaultReadinessSeconds(options.platform) },
@@ -360,7 +433,9 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
if (options.agent) assertAgentAcceptance(bundle, map, { required: true });
// The side that produces the evidence checks it the way the review will: an integrity defect fails here, naming
// its codes, instead of on the consuming side after both captures. Unavailable screens are not defects.
assertNoCaptureHealthIssues(partitionCaptureHealthIssues(captureHealthIssues(bundle, selectedIds)).integrity);
// A session capturing only a secondary appearance has no primary frames by design; the merged export is checked instead.
const partialPass = options.appearancePass !== undefined && !options.appearancePass.capture.includes(colorSchemes[0]!);
if (!partialPass) assertNoCaptureHealthIssues(partitionCaptureHealthIssues(captureHealthIssues(bundle, selectedIds)).integrity);
await writeFile(join(outputDirectory, "bundle.json"), `${JSON.stringify(bundle, null, 2)}\n`, { flag: "wx" });
if (metadata) await writeFile(join(outputDirectory, "execution.json"), `${JSON.stringify(metadata, null, 2)}\n`, { flag: "wx" });
assertCheckout();
@@ -376,11 +451,26 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
say(`reading EAS build profile ${options.easProfile}`);
const eas = (args: string[], timeoutMs = 5 * 60_000, cwd = project) => runner({ command: options.easCommand, args,
cwd, environment: easEnvironment, timeoutMs });
// `eas simulator:control` names the session by id, from the session's own project directory.
const sessionEas: EasCommand = (args, commandOptions) => runner({ command: options.easCommand, args, cwd: simulatorProject, environment: easEnvironment,
timeoutMs: commandOptions?.timeoutMs ?? 5 * 60_000, ...(commandOptions?.allowFailure ? { allowFailure: true } : {}) });
// What the EAS session's host can do through simulator:control (iOS sessions on serve-sim 0.10.0 or later).
let controlActions = new Set<string>();
const configResult = eas(["config", "--platform", options.platform, "--profile", options.easProfile, "--json", "--non-interactive"]);
const profile = repackProfileFrom(configResult.stdout);
const configValue = parseJson(configResult.stdout, "eas config") as { appConfig: Record<string, unknown>; buildProfile: Record<string, unknown> };
scheme ??= appScheme(configValue.appConfig.scheme);
colorSchemes = resolveColorSchemes(options.appearance ?? "auto", configValue.appConfig, options.platform);
// Argent cannot switch the appearance itself. On a local device the host switches it (simctl, adb); on an EAS iOS
// session serve-sim does (appearance.set), which is known once the session starts; otherwise one appearance is captured.
let argentSchemes = controller === "argent" && !local ? argentColorSchemes(colorSchemes, configValue.appConfig, options.platform) : undefined;
const narrowToArgentScheme = () => {
if (!argentSchemes) return;
if (argentSchemes.skipped.length) say(`Argent cannot switch appearance on this session; capturing ${argentSchemes.schemes[0]} only, skipped ${argentSchemes.skipped.join(", ")}`);
colorSchemes = argentSchemes.schemes;
argentSchemes = undefined;
};
if (options.platform !== "ios") narrowToArgentScheme();
app = { name: profile.projectIdentity.name, ...(profile.projectIdentity.version ? { version: profile.projectIdentity.version } : {}),
...(profile.projectIdentity.buildNumber ? { buildNumber: profile.projectIdentity.buildNumber } : {}) };
projectId = profile.projectIdentity.projectId;
@@ -390,45 +480,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
return finish();
}
assertCaptureEasProfile(configValue, options.bundleId, options.platform, { side, commit: options.gitCommit });
assertSimulatorAvailable(eas(["simulator:availability", "--json", "--non-interactive"]).stdout);
setStage("build");
// Historical frames do not replace the fresh build needed for missing targets.
easBuildId = null;
options.signal?.throwIfAborted();
say("computing the native fingerprint");
const fingerprintResult = eas(["fingerprint:generate", "--platform", options.platform, "--build-profile", options.easProfile, "--json", "--non-interactive"]);
fingerprint = fingerprintFrom(fingerprintResult.stdout);
const reusable = options.forceFreshBuild || hasEasEnvironmentFetchFailure(configResult.stderr) || hasEasEnvironmentFetchFailure(fingerprintResult.stderr)
? undefined : existingBuild(eas(["build:list", "--platform", options.platform, "--status", "finished", "--build-profile", options.easProfile,
"--fingerprint-hash", fingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
if (reusable) {
say(`reusing EAS build ${reusable.id} (fingerprint ${fingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
project, nativeBuildId: reusable.id, fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile });
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
message: "The build environment cannot be reproduced for automatic capture instrumentation.",
nextAction: "Use a simulator build profile whose required bundle environment can be pulled for local repacking; an uninstrumented build cannot verify captures." });
if (repacked) { nativeEasBuildId = reusable.id; easBuildId = repacked; reusedEasBuild = true; }
if (!app.version && reusable.appVersion) app.version = reusable.appVersion;
if (!app.buildNumber && reusable.appBuildVersion) app.buildNumber = reusable.appBuildVersion;
}
options.signal?.throwIfAborted();
if (!easBuildId) {
say(options.forceFreshBuild ? "building on EAS (a fresh build was requested); waiting for it to finish"
: `no finished simulator build has fingerprint ${fingerprint.slice(0, 12)}; building on EAS and waiting for it to finish`);
const built = nativeBuildFrom(eas(["build", "--platform", options.platform, "--profile", options.easProfile, "--wait", "--json", "--non-interactive"], 45 * 60_000).stdout);
nativeEasBuildId = built.id; fingerprint = built.fingerprint;
say(`EAS build ${built.id} finished; repacking it with the route observer`);
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
project, nativeBuildId: built.id, fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile });
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
message: "The fresh native build cannot be instrumented with the required route observer.",
nextAction: "Use a simulator profile with a reproducible bundle environment so both revisions can be repacked with the same observer." });
easBuildId = repacked;
if (!app.version && built.appVersion) app.version = built.appVersion;
if (!app.buildNumber && built.appBuildVersion) app.buildNumber = built.appBuildVersion;
}
options.signal?.throwIfAborted();
if (!local) assertSimulatorAvailable(eas(["simulator:availability", "--json", "--non-interactive"]).stdout);
const simulatorProject = await realpath(await mkdtemp(join(tmpdir(), "expo-explore-session-")));
const dotenvPath = join(simulatorProject, SIMULATOR_DOTENV_FILE_NAME);
const statePath = options.sessionStatePath ? absoluteContractFile(options.sessionStatePath, "sessionStatePath") : undefined;
@@ -436,59 +488,440 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
await writeFile(join(simulatorProject, "app.json"), JSON.stringify({ expo: { name: profile.projectIdentity.name, slug: profile.projectIdentity.slug,
owner: profile.projectIdentity.owner, extra: { eas: { projectId } } } }), { mode: 0o600 });
await writeFile(join(simulatorProject, "package.json"), "{}\n", { mode: 0o600 });
const sessionName = simulatorSessionName({ mapName: options.name, mapId: options.buildId, gitCommit: options.gitCommit, easBuildId,
runIdentity: JSON.stringify({ mapDirectory, outputDirectory, run: sourceEnvironment.GITHUB_RUN_ID, attempt: sourceEnvironment.GITHUB_RUN_ATTEMPT }) });
// The local simulator's UDID (iOS) or emulator's adb serial (Android): what agent-device is pointed at.
let localSimulator: string | undefined;
let localEmulator: string | undefined;
let localOsVersion: string | undefined;
// Argent's tool-server on this machine, when Argent drives a local device.
let localArgent: LocalArgentServer | undefined;
let argentBridge: ArgentBridgeRunner | undefined;
const localDevice = () => localSimulator ?? localEmulator;
// A local device starts booting now and finishes while the app is built and repacked; the session waits for it.
let localEmulatorStart: Awaited<ReturnType<typeof startLocalEmulator>> | undefined;
const localName = `Explore ${options.device} (${side} ${options.gitCommit.slice(0, 8)})`;
// An EAS session's start, once begun (startSession): it resolves with the start command's failure, if any.
let sessionStart: Promise<unknown> | undefined;
const stopEarlyDevice = async () => {
// An EAS session started beside a repack that then failed: stop the exact session its handoff names.
if (sessionStart) {
await sessionStart;
const handoff = await readSimulatorDotenvHandoff(dotenvPath).catch(() => undefined);
if (handoff?.sessionId) assertSimulatorStopped(eas(["simulator:stop", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000, simulatorProject).stdout, handoff.sessionId);
}
if (localSimulator) deleteLocalSimulator({ runner, udid: localSimulator, cwd: simulatorProject, environment: restrictedEnvironment });
if (localEmulator) await deleteLocalEmulator({ runner, serial: localEmulator, cwd: simulatorProject, environment: restrictedEnvironment });
if (statePath) await rm(statePath, { force: true });
await rm(simulatorProject, { recursive: true, force: true });
await localRecord?.close();
};
// What this side starts on this machine, so a later review cleans up after it if this process is stopped hard.
const localRecord = local ? await openLocalCaptureRecord(sourceEnvironment, simulatorProject) : undefined;
if (local) try {
if (options.platform === "android") {
say(`starting a local ${options.device} emulator`);
localEmulatorStart = await startLocalEmulator({ runner, device: options.device, name: `explore-${side}-${options.gitCommit.slice(0, 8)}`, directory: simulatorProject,
cwd: simulatorProject, environment: restrictedEnvironment,
...(controller === "agent-device" ? { claimed: (serial: string) => agentDeviceClaims({ runner, agentDevice: options.agentDeviceCommand, serial, cwd: simulatorProject, environment: restrictedEnvironment }) } : {}),
// Recorded as soon as it starts, so an interrupted review stops it too.
started: async serial => {
localEmulator = serial;
await localRecord?.update({ serial, avd: `explore-${side}-${options.gitCommit.slice(0, 8)}` });
if (statePath) await writeFile(statePath, `${LOCAL_EMULATOR_STATE_PREFIX}${serial}\n`, { flag: "wx", mode: 0o600 });
} });
} else {
say(`starting a local ${options.device} simulator`);
const created = await createLocalSimulator({ runner, device: options.device, name: localName, cwd: simulatorProject, environment: restrictedEnvironment,
// Recorded before it boots, so an interrupted review deletes it too.
created: async udid => {
localSimulator = udid;
await localRecord?.update({ udid });
if (statePath) await writeFile(statePath, `${LOCAL_SIMULATOR_STATE_PREFIX}${udid}\n`, { flag: "wx", mode: 0o600 });
} });
localOsVersion = created.osVersion;
}
} catch (error) { await stopEarlyDevice().catch(() => undefined); throw error; }
// The session is named before its app exists: an EAS session starts while the app is repacked (startSession).
// A session EAS failed to start is replaced once (see the session block), under a name of its own.
const sessionNameFor = (retry: number) => simulatorSessionName({ mapName: options.name, mapId: options.buildId, gitCommit: options.gitCommit, easBuildId: local ? "local" : "installed",
runIdentity: JSON.stringify({ mapDirectory, outputDirectory, run: sourceEnvironment.GITHUB_RUN_ID, attempt: sourceEnvironment.GITHUB_RUN_ATTEMPT, ...(retry ? { sessionRetry: retry } : {}) }) });
let sessionRetries = 0;
let sessionName = sessionNameFor(0);
/**
* Starts the EAS Simulator session in the background, empty, once the build to repack is known (not while a native
* build runs, which can take most of an hour of session time). The app is installed through the controller when both
* are ready. Resolves with the start command's failure, if any; the session block verifies what EAS handed over.
*/
const startSession = (retry?: { timeoutMs: number }) => {
if (local || sessionStart) return;
if (!retry) say(`starting an EAS Simulator session (${options.device}) while the app is repacked`);
const request = (minutes: number) => ({ command: options.easCommand, args: ["simulator:start", "--name", sessionName, "--platform", options.platform, "--device", options.device,
"--type", controller, "--package-version", controllerVersion(controller), "--public-link",
"--max-duration-minutes", String(minutes), "--out-config-type", "dotenv", "--non-interactive"], cwd: simulatorProject, environment: easEnvironment,
timeoutMs: retry?.timeoutMs ?? SESSION_START_TIMEOUT_MS });
// An injected runner (tests) answers synchronously; a real start runs beside the repack.
const start = async (minutes: number) => options.runner ? options.runner(request(minutes)) : runAgentControllerCommand(request(minutes), options.signal ?? new AbortController().signal);
sessionStart = writeFile(dotenvPath, SIMULATOR_DOTENV_HEADER, { flag: "wx", mode: 0o600 })
.then(() => start(options.maxDurationMinutes + SESSION_PREPARATION_MINUTES).catch(async (error: unknown) => {
// A plan that cannot give the allowance gets as much of it as the plan allows, and never less than the capture's own minutes.
const limit = sessionDurationLimit(error);
if (limit === undefined) throw error;
say(`EAS allows ${limit}-minute sessions on this plan; starting the session again without the full repack allowance`);
return start(Math.max(options.maxDurationMinutes, limit));
}))
.then(() => undefined, (error: unknown) => error);
};
setStage("build");
// The instrumented app stays on this machine: a local device installs it, and an EAS session gets it through the
// controller. It goes in this capture's own directory, or in the review's shared build folder when other targets use it.
const appName = options.platform === "android" ? "app.apk" : "app.app";
const appDirectory = !options.buildShare ? await realpath(await mkdtemp(join(tmpdir(), "expo-explore-app-"))) : undefined;
let localApp: string | undefined;
type BuiltApp = { fingerprint: string; nativeEasBuildId: string | null; easBuildId: string | null; app?: string; reused: boolean; version?: string; buildNumber?: string };
// `repacking` tells the captures sharing this build that their sessions can start too (sharedBuild).
const buildApp = async (keepApp: string, repacking?: () => Promise<void>): Promise<BuiltApp> => {
options.signal?.throwIfAborted();
say("computing the native fingerprint");
const fingerprintResult = eas(["fingerprint:generate", "--platform", options.platform, "--build-profile", options.easProfile, "--json", "--non-interactive"]);
const sourceFingerprint = fingerprintFrom(fingerprintResult.stdout);
const reusable = options.forceFreshBuild || hasEasEnvironmentFetchFailure(configResult.stderr) || hasEasEnvironmentFetchFailure(fingerprintResult.stderr)
? undefined : existingBuild(eas(["build:list", "--platform", options.platform, "--status", "finished", "--build-profile", options.easProfile,
"--fingerprint-hash", sourceFingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
if (reusable) {
say(`reusing EAS build ${reusable.id} (fingerprint ${sourceFingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
startSession(); await repacking?.();
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
project, nativeBuildId: reusable.id, fingerprint: sourceFingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
message: "The build environment cannot be reproduced for automatic capture instrumentation.",
nextAction: "Use a simulator build profile whose required bundle environment can be pulled for local repacking; an uninstrumented build cannot verify captures." });
return { fingerprint: sourceFingerprint, nativeEasBuildId: reusable.id, easBuildId: repacked.buildId, ...(repacked.app ? { app: repacked.app } : {}), reused: true,
...(reusable.appVersion ? { version: reusable.appVersion } : {}), ...(reusable.appBuildVersion ? { buildNumber: reusable.appBuildVersion } : {}) };
}
options.signal?.throwIfAborted();
say(options.forceFreshBuild ? "building on EAS (a fresh build was requested); waiting for it to finish"
: `no finished simulator build has fingerprint ${sourceFingerprint.slice(0, 12)}; building on EAS and waiting for it to finish`);
const built = nativeBuildFrom(eas(["build", "--platform", options.platform, "--profile", options.easProfile, "--wait", "--json", "--non-interactive"], 45 * 60_000).stdout);
say(`EAS build ${built.id} finished; repacking it with the route observer`);
startSession(); await repacking?.();
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
project, nativeBuildId: built.id, fingerprint: built.fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
message: "The fresh native build cannot be instrumented with the required route observer.",
nextAction: "Use a simulator profile with a reproducible bundle environment so both revisions can be repacked with the same observer." });
return { fingerprint: built.fingerprint, nativeEasBuildId: built.id, easBuildId: repacked.buildId, ...(repacked.app ? { app: repacked.app } : {}), reused: false,
...(built.appVersion ? { version: built.appVersion } : {}), ...(built.appBuildVersion ? { buildNumber: built.appBuildVersion } : {}) };
};
try {
// Historical frames do not replace the fresh build needed for missing targets.
easBuildId = null;
const built = options.buildShare
? await sharedBuild({ directory: options.buildShare, appName, ...(options.signal ? { signal: options.signal } : {}), build: buildApp, owner: options.outputDirectory,
key: { platform: options.platform, easProfile: options.easProfile, bundleId: options.bundleId, gitCommit: options.gitCommit, repack: options.repack ?? "eas", local,
routes: inventory.map(route => route.id) },
waiting: () => say("using the build another target of this review is preparing for this commit"),
// The session is named before its app exists, so a waiter's session boots while the other capture repacks.
repacking: () => startSession() })
: await buildApp(join(appDirectory!, appName));
// A capture that used another capture's build has its session started above; this starts the rest.
startSession();
fingerprint = built.fingerprint; nativeEasBuildId = built.nativeEasBuildId; easBuildId = built.easBuildId; localApp = built.app; reusedEasBuild = built.reused;
if (!app.version && built.version) app.version = built.version;
if (!app.buildNumber && built.buildNumber) app.buildNumber = built.buildNumber;
options.signal?.throwIfAborted();
} catch (error) {
// A build or repack that fails leaves nothing running: a device started for it goes, with the session's files and the app.
await stopEarlyDevice().catch(() => undefined);
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
throw error;
}
let primaryError: unknown;
let runtimeStage = "session";
try {
setStage(runtimeStage);
say(`starting an EAS Simulator session (${options.device}) with build ${easBuildId}`);
await writeFile(dotenvPath, SIMULATOR_DOTENV_HEADER, { flag: "wx", mode: 0o600 });
let startError: unknown;
try { eas(["simulator:start", "--name", sessionName, "--platform", options.platform, "--device", options.device,
"--type", "agent-device", "--package-version", AGENT_DEVICE_VERSION, "--build-id", easBuildId,
"--max-duration-minutes", String(options.maxDurationMinutes), "--out-config-type", "dotenv", "--non-interactive"], 20 * 60_000, simulatorProject); }
catch (error) { startError = error; }
const handoff = await readSimulatorDotenvHandoff(dotenvPath);
const startSecrets = [options.expoToken, ...(handoff.connection ? [handoff.connection.daemonAuthToken] : [])];
const startFailure = startError ? simulatorStartFailure(startError, startSecrets) : undefined;
if (handoff.sessionId) {
try { assertSimulatorSessionIdentity(eas(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
handoff.sessionId, sessionName, profile.projectIdentity, handoff.connection, options.platform); }
catch (error) { throw new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session",
message: "The EAS handoff could not prove ownership of the exact simulator session. The private handoff was preserved.",
nextAction: "Inspect the EAS session logs and preserved handoff; confirm ownership before cleaning up the reported session.",
details: { handoffDirectory: simulatorProject, reportedSessionId: handoff.sessionId,
...(startFailure ? { startFailure } : {}), verificationFailure: simulatorStartFailure(error, startSecrets) }, cause: error }); }
sessionId = handoff.sessionId;
if (statePath) await writeFile(statePath, `${sessionId}\n`, { flag: "wx", mode: 0o600 });
let connection: SimulatorConnection | undefined;
if (localApp && localEmulator && localEmulatorStart) {
await assertLocalEmulatorCompatible(localApp, hostEmulatorAbi());
localOsVersion = waitForLocalEmulator({ runner, serial: localEmulator, device: options.device, apiLevel: localEmulatorStart.apiLevel, directory: simulatorProject,
cwd: simulatorProject, environment: restrictedEnvironment, ...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}) });
say(`installing the app on ${localEmulator}`);
installOnLocalEmulator({ runner, serial: localEmulator, apk: localApp, cwd: simulatorProject, environment: restrictedEnvironment });
} else if (localApp && localSimulator) {
waitForLocalSimulator({ runner, udid: localSimulator, cwd: simulatorProject, environment: restrictedEnvironment });
if (scheme) approveLinkScheme({ runner, udid: localSimulator, scheme, bundleId: options.bundleId, cwd: simulatorProject, environment: restrictedEnvironment });
say(`installing the app on ${localName}`);
installOnLocalSimulator({ runner, udid: localSimulator, app: localApp, cwd: simulatorProject, environment: restrictedEnvironment });
} else if (local) {
throw new Error("The local device did not start before capture");
} else {
if (!localApp || !sessionStart) throw new Error("An EAS Simulator session needs the instrumented app on this machine");
let startError = await sessionStart;
let handoff = await readSimulatorDotenvHandoff(dotenvPath);
// EAS sometimes fails to start a session: it errors while booting, or the start request fails before a session is
// named. After every failed start, whatever it may have left running is accounted for; then, when the failure is
// provably EAS's, a new session replaces it, up to SESSION_START_RETRIES times within SESSION_RETRY_BUDGET_MS, with
// a growing wait. A session Explore cannot prove is its own is never replaced or stopped: that stays a handoff
// failure below, as does a lookup that fails.
const clock = options.now ?? Date.now;
const endedSessions: string[] = [];
let ended: { sessionId: string; status: string } | undefined;
let retryDeadline: number | undefined;
for (;;) {
const easRead = (args: string[]) => {
try { return runner({ command: options.easCommand, args, cwd: project, environment: easEnvironment, timeoutMs: 2 * 60_000, allowFailure: true }).stdout; }
catch { return ""; }
};
let reason: string | undefined;
ended = undefined;
if (handoff.sessionId) {
const status = endedOwnSimulatorSession(easRead(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"]),
{ sessionId: handoff.sessionId, sessionName, project: profile.projectIdentity, type: controller, platform: options.platform });
if (status) {
ended = { sessionId: handoff.sessionId, status };
endedSessions.push(handoff.sessionId);
reason = `EAS ended simulator session ${handoff.sessionId} (${status}) before it was ready`;
}
} else if (startError && transientSessionStartFailure(startError)) {
// The failed request may still have created a session: any by this exact name is stopped, so none is left running.
const live = liveSimulatorSessionsNamed(easRead(["simulator:list", "--name", sessionName, "--status", "new", "--status", "queued", "--status", "starting",
"--status", "in-progress", "--limit", "100", "--json", "--non-interactive"]), sessionName, profile.projectIdentity);
if (live) {
for (const id of live) assertSimulatorStopped(eas(["simulator:stop", "--id", id, "--json", "--non-interactive"], 2 * 60_000).stdout, id);
reason = `EAS could not start the simulator session (${simulatorStartFailure(startError, [options.expoToken]).message})`;
}
}
if (!reason || sessionRetries >= SESSION_START_RETRIES) break;
retryDeadline ??= clock() + SESSION_RETRY_BUDGET_MS;
const delayMs = sessionRetryDelayMs(sessionRetries + 1);
// A new start needs at least a minute of the budget after its wait; one started later could not finish in it.
const startTimeoutMs = Math.min(SESSION_START_TIMEOUT_MS, retryDeadline - clock() - delayMs);
if (startTimeoutMs < 60_000) break;
sessionRetries += 1;
say(`${reason}; starting a new EAS Simulator session in ${Math.round(delayMs / 1000)} s (${sessionRetries}/${SESSION_START_RETRIES})`);
options.signal?.throwIfAborted();
// Asynchronous and cancellable, so targets capturing beside this one keep running and Ctrl+C stops the wait.
if (options.sleep) options.sleep(delayMs);
else await new Promise<void>((resolve, reject) => {
const timer = setTimeout(() => { options.signal?.removeEventListener("abort", abort); resolve(); }, delayMs);
const abort = () => { clearTimeout(timer); reject(options.signal!.reason); };
options.signal?.addEventListener("abort", abort, { once: true });
});
options.signal?.throwIfAborted();
await rm(dotenvPath, { force: true });
sessionName = sessionNameFor(sessionRetries);
sessionStart = undefined;
startSession({ timeoutMs: startTimeoutMs });
startError = await sessionStart;
handoff = await readSimulatorDotenvHandoff(dotenvPath);
}
// Every session EAS ended is its own failure to start, never a question of ownership.
if (ended) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session",
message: `EAS could not start a simulator session: ${endedSessions.length === 1 ? `session ${ended.sessionId} ended (${ended.status}) before it was ready`
: `${endedSessions.length} sessions ended before they were ready (the last, ${ended.sessionId}, ${ended.status})`}.`,
nextAction: "Rerun Explore. If sessions keep failing to start, check the EAS Simulator status and the sessions' logs on expo.dev.",
retryable: true, details: { attempts: sessionRetries + 1, endedSessions, ...(startError ? { startFailure: simulatorStartFailure(startError, [options.expoToken]) } : {}) },
...(startError ? { cause: startError } : {}) });
const startSecrets = [options.expoToken, ...(handoff.connection ? [handoff.connection.daemonAuthToken] : [])];
const startFailure = startError ? simulatorStartFailure(startError, startSecrets) : undefined;
if (handoff.sessionId) {
try { assertSimulatorSessionIdentity(eas(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
handoff.sessionId, sessionName, profile.projectIdentity, handoff.connection, options.platform); }
catch (error) { throw new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session",
message: "The EAS handoff could not prove ownership of the exact simulator session. The private handoff was preserved.",
nextAction: "Inspect the EAS session logs and preserved handoff; confirm ownership before cleaning up the reported session.",
details: { handoffDirectory: simulatorProject, reportedSessionId: handoff.sessionId,
...(startFailure ? { startFailure } : {}), verificationFailure: simulatorStartFailure(error, startSecrets) }, cause: error }); }
sessionId = handoff.sessionId;
if (statePath) await writeFile(statePath, `${sessionId}\n`, { flag: "wx", mode: 0o600 });
}
if (!sessionId) throw new CiError({ code: startFailure ? "SIMULATOR_START_FAILED" : "SESSION_HANDOFF_UNVERIFIED", stage: "session",
message: startFailure ? `EAS simulator:start failed before a session identity could be verified: ${startFailure.message}`
: "EAS did not provide an exact verifiable simulator session. The private handoff was preserved.",
nextAction: "Inspect the recorded start failure and EAS session list. Allocation status is unknown; verify a session's exact ID and ownership before cleanup.",
details: { handoffDirectory: simulatorProject, command: "eas simulator:start", startCommandStatus: startFailure ? "failed" : "completed", allocation: "unknown",
...(startFailure ? { startFailure } : {}),
...(handoff.validationError ? { handoffFailure: simulatorStartFailure(handoff.validationError, startSecrets) } : {}) },
cause: startError ?? handoff.validationError });
if (startFailure) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session",
message: `EAS simulator:start failed after the session identity was verified: ${startFailure.message}`,
nextAction: "Inspect the recorded start failure; Explore will stop the exact verified session before returning this error.",
details: { reportedSessionId: sessionId, command: "eas simulator:start", startCommandStatus: "failed", allocation: "verified", startFailure }, cause: startError });
if (handoff.validationError) throw handoff.validationError;
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
connection = handoff.connection;
await rm(dotenvPath, { force: true });
if (options.platform === "ios") controlActions = simulatorControlActions(sessionEas, sessionId);
if (!controlActions.has("appearance.set")) narrowToArgentScheme();
}
if (!sessionId) throw new CiError({ code: startFailure ? "SIMULATOR_START_FAILED" : "SESSION_HANDOFF_UNVERIFIED", stage: "session",
message: startFailure ? `EAS simulator:start failed before a session identity could be verified: ${startFailure.message}`
: "EAS did not provide an exact verifiable simulator session. The private handoff was preserved.",
nextAction: "Inspect the recorded start failure and EAS session list. Allocation status is unknown; verify a session's exact ID and ownership before cleanup.",
details: { handoffDirectory: simulatorProject, command: "eas simulator:start", startCommandStatus: startFailure ? "failed" : "completed", allocation: "unknown",
...(startFailure ? { startFailure } : {}),
...(handoff.validationError ? { handoffFailure: simulatorStartFailure(handoff.validationError, startSecrets) } : {}) },
cause: startError ?? handoff.validationError });
if (startFailure) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session",
message: `EAS simulator:start failed after the session identity was verified: ${startFailure.message}`,
nextAction: "Inspect the recorded start failure; Explore will stop the exact verified session before returning this error.",
details: { reportedSessionId: sessionId, command: "eas simulator:start", startCommandStatus: "failed", allocation: "verified", startFailure }, cause: startError });
if (handoff.validationError) throw handoff.validationError;
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
await rm(dotenvPath, { force: true });
const controllerConfig = join(simulatorProject, "agent-device.json");
await writeFile(controllerConfig, "{}\n", { flag: "wx", mode: 0o400 });
const controllerEnvironment = { ...restrictedEnvironment, AGENT_DEVICE_CONFIG: controllerConfig,
AGENT_DEVICE_DAEMON_BASE_URL: handoff.connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: handoff.connection.daemonAuthToken,
if (local && controller === "argent") {
// Argent drives a local device through a tool-server of this capture's own, pointed at that device.
const cli = await ensureArgentToolServer({ environment: sourceEnvironment, progress: say });
localArgent = await startLocalArgentServer({ runner, cli, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}) });
await localRecord?.update({ argent: { pid: localArgent.pid, cli: localArgent.cli, home: localArgent.home } });
connection = { sessionId: `local-${localDevice()}`, daemonBaseUrl: localArgent.url, daemonAuthToken: localArgent.token, controller: "argent" };
}
const argent = controller === "argent" && connection
? await argentControllerInvocation({ directory: simulatorProject, connection, platform: options.platform, environment: restrictedEnvironment, sourceEnvironment, bundleId: options.bundleId,
...(localDevice() ? { device: localDevice()! } : {}), ...(options.devicePose ? { pose: options.devicePose } : {}) })
: undefined;
const controllerEnvironment = argent?.environment ?? { ...restrictedEnvironment, AGENT_DEVICE_CONFIG: controllerConfig,
// Locally, agent-device runs its own daemon, one per capture, so head and base do not share sessions.
...(connection ? { AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken }
: { AGENT_DEVICE_STATE_DIR: join(simulatorProject, "agent-device-state") }),
AGENT_DEVICE_SESSION: CONTROLLER_SESSION, AGENT_DEVICE_SESSION_LOCK: "reject", AGENT_DEVICE_PLATFORM: options.platform };
// Every controller call below goes to the session's controller; for Argent that is the bridge.
const controllerCommand = argent?.command ?? options.agentDeviceCommand;
// The capture's commands keep one bridge on a worker thread (EXPLORE_ARGENT_BRIDGE=process: one process per command, as before).
if (argent && !options.runner && sourceEnvironment.EXPLORE_ARGENT_BRIDGE !== "process") {
argentBridge = startArgentBridgeRunner({ command: argent.command, environment: argent.environment, fallback: defaultRunner, progress: say });
runner = argentBridge.runner;
}
if (!local && localApp) {
// The session started empty while the app was repacked; the controller installs it now.
say(`installing the app on session ${sessionId}`);
runner({ command: controllerCommand, args: ["install", localApp, "--session", CONTROLLER_SESSION, ...deviceArgs({ platform: options.platform, deviceModel: options.device }),
"--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
// Before any link opens, as a local capture does with simctl: the app's own links then open without the prompt.
if (sessionId && scheme) {
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme]);
if (approved.length) say(`approved ${approved.map(item => `${item}://`).join(", ")} links on session ${sessionId}`);
}
}
if (options.devicePose) {
// A fold relights the other panel and resizes the window. It comes before the app is first opened or read, so the
// controller's accessibility reader starts on the lit panel: Argent's, started on the outer panel, can stay there.
say(`folding ${options.device} ${options.devicePose}`);
const target = deviceArgs({ platform: options.platform, deviceModel: options.device, ...(localDevice() ? { provider: "local-simulator" as const, controllerDeviceId: localDevice()! } : {}) });
// agent-device reads the hinge back after folding and fails to (locally and on EAS); its display is checked instead.
const easAgentDevice = !!sessionId && controller === "agent-device";
const fold = () => runner({ command: controllerCommand, args: ["fold", options.devicePose!, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
const pause = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
if (localSimulator && controller === "argent") {
// Argent folds without a session and checks the fold against its own reader; this machine also checks the display.
fold();
if (!await localPoseShown({ runner, udid: localSimulator, pose: options.devicePose, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
...(options.sleep ? { sleep: options.sleep } : {}) })) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
message: `${options.device} did not show the ${options.devicePose} display after folding.`, nextAction: "Rerun; if it persists, check that this Xcode's simulator supports folding the device." });
} else if (localSimulator) {
// A local agent-device folds only inside a session, so the app opens first (its first open also builds the
// runner). agent-device then reads the hinge back with a devicectl option Xcode 27.1 no longer has, so on this
// machine the pose is checked by the lit display's shape instead of its answer.
runner({ command: controllerCommand, args: ["open", options.bundleId, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
const folded = fold();
if (!await localPoseShown({ runner, udid: localSimulator, pose: options.devicePose, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
...(options.sleep ? { sleep: options.sleep } : {}) })) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
message: `${options.device} did not show the ${options.devicePose} display after folding: ${(folded.stderr || folded.stdout).trim().split("\n").at(-1) ?? ""}`.trim(),
nextAction: "Rerun; if it persists, check that this Xcode's simulator supports folding the device." });
} else if (easAgentDevice && sessionId) {
// On EAS, agent-device also folds only inside a session, so the app opens first. The first fold of a fresh session
// can leave the panel it lights black, as it does for Argent: the controller then reads the old panel and a
// relaunch draws nothing. The display is the check, through the controller's own screenshot: in the pose's shape
// and drawn. If it is not, SpringBoard is restarted, the app reopened and the device folded again, once.
const open = (relaunch: boolean) => runner({ command: controllerCommand, args: ["open", options.bundleId, ...(relaunch ? ["--relaunch"] : []), "--session", CONTROLLER_SESSION,
...target, "--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
const shown = async () => {
if (options.devicePose !== "open" && options.devicePose !== "closed") return true;
const file = join(simulatorProject, "pose.png");
// The display relights and resizes over a moment after the hinge moves.
for (let attempt = 0; attempt < 10; attempt += 1) {
if (attempt) pause(1_000);
runner({ command: controllerCommand, args: ["screenshot", file, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000, allowFailure: true });
const png = await readFile(file).catch(() => Buffer.alloc(0));
await rm(file, { force: true });
const size = pngSize(png);
if (size && (options.devicePose === "open" ? size.width > size.height : size.height > size.width) && !solidColour(png)) return true;
}
return false;
};
open(false);
fold();
if (!await shown()) {
if (!controlActions.has("springboard.restart")) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
message: `${options.device} did not show the ${options.devicePose} display after folding.`, nextAction: "Rerun the capture on a new session." });
say(`${options.device} did not draw the ${options.devicePose} display after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
simulatorControl(sessionEas, sessionId, "springboard.restart");
pause(8_000);
open(true);
fold();
if (!await shown()) throw new CiError({ code: "CONTROLLER_READER_STUCK", stage: "session",
message: `${options.device} did not draw the ${options.devicePose} display after folding, nor after SpringBoard was restarted and it was folded again.`,
nextAction: "Rerun the capture; if it keeps happening, report it to Explore with the session's link." });
}
} else if (controller === "argent" && sessionId && controlActions.has("springboard.restart")) {
// The bridge has already reset Argent's device helpers once when its reader stayed on the dark panel. On EAS the
// tool-server cannot be restarted, so the next step is SpringBoard, then the same fold and check again.
try { fold(); }
catch (error) {
if (toCiError(error).code !== "CONTROLLER_FOLD_UNVERIFIED") throw error;
say(`Argent kept reading the other panel after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
simulatorControl(sessionEas, sessionId, "springboard.restart");
pause(8_000);
try { fold(); }
catch (retry) {
if (toCiError(retry).code !== "CONTROLLER_FOLD_UNVERIFIED") throw retry;
throw new CiError({ code: "CONTROLLER_READER_STUCK", stage: "session",
message: `Argent's accessibility reader kept reading the panel the fold turned off, after its device helpers were reset and SpringBoard was restarted.`,
nextAction: "Rerun the capture; if it keeps happening, report it to Explore: this session's Argent tool-server needs a restart that EAS cannot do yet.", cause: retry });
}
}
} else fold();
}
runtimeStage = "runtime";
setStage(runtimeStage);
runtime = collectRuntime(options, controllerEnvironment);
const localId = localDevice();
const collect = () => collectRuntime({ ...options, agentDeviceCommand: controllerCommand }, controllerEnvironment, localId ? { id: localId } : undefined);
// Argent's accessibility reader can stay on a foldable's dark outer panel after a fold and never read the app
// (APP_NOT_READY). On this machine the capture runs that reader, so it recovers in two steps, each followed by one more
// open: a fresh tool-server, whose reader starts on the lit panel; then, as XcodeBuildMCP#537 found for this panel,
// SpringBoard restarted as well. The bridge's cached view of the device goes with the old server.
// On EAS the tool-server is the session's and must never be stopped, so the recovery there resets Argent's device
// helpers (reset-reader), then restarts SpringBoard as well, and then gives up with a reason rather than retrying.
const easArgentRecovery = !local && controller === "argent" && !!sessionId && options.platform === "ios";
for (let recovery = 0; ; recovery += 1) try { runtime = collect(); break; }
catch (error) {
if (toCiError(error).code !== "APP_NOT_READY") throw error;
if (easArgentRecovery && sessionId) {
if (recovery === 2 || recovery === 1 && !controlActions.has("springboard.restart")) throw new CiError({ code: "CONTROLLER_READER_STUCK", stage: "session",
message: "Argent's accessibility reader kept reading the panel the fold turned off, after its device helpers were reset"
+ `${recovery === 2 ? " and SpringBoard was restarted" : ""}.`,
nextAction: "Rerun the capture; if it keeps happening, report it to Explore: this session's Argent tool-server needs a restart that EAS cannot do yet.", cause: error });
if (recovery === 1) {
say("Argent still did not read the app; restarting SpringBoard, then resetting Argent's device helpers and opening the app again");
simulatorControl(sessionEas, sessionId, "springboard.restart");
// SpringBoard takes a moment to come back, and sends the app to the background; the next open brings it back.
(options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); }))(8_000);
} else say("Argent did not read the app after starting it; resetting Argent's device helpers and opening the app again");
runner({ command: controllerCommand, args: ["reset-reader", "--session", CONTROLLER_SESSION, "--platform", options.platform, "--json"],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000 });
continue;
}
if (!localArgent || recovery === 2) throw error;
say(recovery === 0 ? "Argent did not read the app after starting it; restarting Argent's tool-server and opening the app again"
: "Argent still did not read the app; restarting SpringBoard and Argent's tool-server and opening the app again");
stopLocalArgentServer(localArgent);
if (recovery === 1 && localSimulator) {
runner({ command: "xcrun", args: ["simctl", "spawn", localSimulator, "launchctl", "kickstart", "-k", "system/com.apple.SpringBoard"],
cwd: simulatorProject, environment: restrictedEnvironment, timeoutMs: 60_000, allowFailure: true });
// SpringBoard takes a moment to come back before an app can be opened over it.
(options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); }))(5_000);
}
localArgent = await startLocalArgentServer({ runner, cli: localArgent.cli, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}) });
await localRecord?.update({ argent: { pid: localArgent.pid, cli: localArgent.cli, home: localArgent.home } });
Object.assign(controllerEnvironment, { ARGENT_TOOLS_URL: localArgent.url, ARGENT_AUTH_TOKEN: localArgent.token });
if (connection) Object.assign(connection, { daemonBaseUrl: localArgent.url, daemonAuthToken: localArgent.token });
await rm(join(simulatorProject, "argent-state.json"), { force: true });
}
runtime.colorScheme = colorSchemes[0]!;
// The version is descriptive; a capture proceeds without it and records "unknown".
try {
// The version is descriptive; a capture proceeds without it and records "unknown". Argent names it with the device;
// agent-device's is always taken from the session, as before.
if (localOsVersion) runtime.osVersion = localOsVersion;
else if (sessionId && (runtime.osVersion === "unknown" || controller !== "argent")) try {
runtime.osVersion = await simulatorOsVersion(eas(["simulator:get", "--id", sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
runtime.controllerDeviceId, options.fetch ?? fetch, options.platform);
} catch (error) {
@@ -499,13 +932,21 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
if (colorSchemes.length > 1) { map.run.environment.colorSchemes = [...colorSchemes]; await store.write(map); }
runtimeStage = "capture";
setStage(runtimeStage);
say(`simulator session ${sessionId} is ready (${runtime.deviceModel}, ${options.platform === "ios" ? "iOS" : "Android"} ${runtime.osVersion})`);
say(`${localSimulator ? "local simulator" : localEmulator ? "local emulator" : "simulator session"} ${localDevice() ?? sessionId} is ready (${runtime.deviceModel}, ${options.platform === "ios" ? "iOS" : "Android"} ${runtime.osVersion})`);
// Every pass sets the appearance explicitly, so a capture does not inherit whatever the simulator last used.
const passes: CaptureBundle["outcomes"][] = [];
const recordingTools = launchSetting === "off" ? undefined : options.recordingTools === undefined ? ffmpegRecordingTools() : options.recordingTools ?? undefined;
const capturedSchemes = options.appearancePass ? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : colorSchemes;
for (const [index, colorScheme] of colorSchemes.entries()) {
runner({ command: options.agentDeviceCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(runtime), "--platform", options.platform],
// A pass another session makes leaves its slot empty, so the passes stay aligned with the appearances they merge by.
if (!capturedSchemes.includes(colorScheme)) { passes.push({}); continue; }
// Argent cannot switch the appearance yet (software-mansion/argent#1509): the host does, simctl or adb on this
// machine and serve-sim on an EAS iOS session; elsewhere its single pass runs as the device starts.
if (controller !== "argent") runner({ command: controllerCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(runtime), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme]);
else if (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
// relaunch starts the app in the new scheme, the same way the first pass did.
if (launchSetting !== "off") {
@@ -516,7 +957,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const record = await captureLaunch({ bundleId: options.bundleId, keepVideo: launchSetting === "video", platform: options.platform,
directory: join(launchWorkDirectory, launchDirectory(colorScheme)), relativeDirectory: launchDirectory(colorScheme), ...(options.now ? { now: options.now } : {}),
...(recordingTools ? { recordingTools } : {}),
controller: (args, controllerOptions) => runner({ command: options.agentDeviceCommand, args: [...args, "--session", CONTROLLER_SESSION, ...deviceArgs(runtime!), "--platform", options.platform],
controller: (args, controllerOptions) => runner({ command: controllerCommand, args: [...args, "--session", CONTROLLER_SESSION, ...deviceArgs(runtime!), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: controllerOptions?.timeoutMs ?? 60_000, ...(controllerOptions?.allowFailure ? { allowFailure: true } : {}) }) });
launch[colorScheme] = { root: launchWorkDirectory, record };
} catch (error) {
@@ -524,19 +965,59 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
say(`the app launch could not be observed (${(error as Error).message}); the report has no launch evidence for ${colorScheme}`);
await rm(join(launchWorkDirectory, launchDirectory(colorScheme)), { recursive: true, force: true });
}
} else if (index > 0) runner({ command: options.agentDeviceCommand, args: ["open", options.bundleId, "--relaunch", "--session", CONTROLLER_SESSION,
} else if (index > 0) runner({ command: controllerCommand, args: ["open", options.bundleId, "--relaunch", "--session", CONTROLLER_SESSION,
...deviceArgs(runtime), "--platform", options.platform, "--level", "full", "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
runtime.colorScheme = colorScheme;
if (colorSchemes.length > 1) say(`appearance ${colorScheme} (${index + 1}/${colorSchemes.length})`);
passes.push(await capturePlannedRoutes({ capture: { ...options, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
connection: handoff.connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
passes.push(await capturePlannedRoutes({ capture: { ...options, ...(argentBridge && !options.agent ? { runner: argentBridge.runner } : {}), agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
...(colorSchemes.length > 1 ? { appearance: { scheme: colorScheme, primary: index === 0 } } : {}) }));
}
runtime.colorScheme = colorSchemes[0]!;
Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
// A session without the primary pass keeps each outcome as its pass recorded it, under `<id>@<scheme>`: the export
// merge recombines them with the primary pass's (mergeSchemeOutcomes), which only then can tell an unattributed
// frame beside a primary one from a lost route.
if (options.appearancePass && !capturedSchemes.includes(colorSchemes[0]!)) {
for (const [index, pass] of passes.entries()) for (const [id, outcome] of Object.entries(pass)) outcomes[schemeScreenId(id, colorSchemes[index])] = outcome;
} else Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
} catch (error) { primaryError = toCiError(error, { code: `CAPTURE_${runtimeStage.toUpperCase()}_FAILED`, stage: runtimeStage,
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." }); }
finally {
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
argentBridge?.close();
if (localArgent) stopLocalArgentServer(localArgent);
if (localEmulator) {
try {
setStage("cleanup");
say(`stopping the local emulator ${localEmulator}`);
runner({ command: options.agentDeviceCommand, args: ["close", "--session", CONTROLLER_SESSION, "--json"], cwd: simulatorProject,
environment: { ...restrictedEnvironment, AGENT_DEVICE_STATE_DIR: join(simulatorProject, "agent-device-state") }, timeoutMs: 60_000, allowFailure: true });
await stopLocalAgentDevice(join(simulatorProject, "agent-device-state"));
await deleteLocalEmulator({ runner, serial: localEmulator, cwd: simulatorProject, environment: restrictedEnvironment });
if (statePath) await rm(statePath, { force: true });
// The AVD lives in the capture's directory, so it goes with it.
await rm(simulatorProject, { recursive: true, force: true });
} catch (error) { throw new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup",
message: "The local emulator Explore started could not be stopped.", nextAction: `Stop it with: adb -s ${localEmulator} emu kill`,
details: { serial: localEmulator, ...(primaryError ? { originalFailure: serializeCiError(primaryError, { secrets: [options.expoToken] }) } : {}) }, cause: error }); }
}
if (localSimulator) {
try {
setStage("cleanup");
say(`deleting the local simulator ${localSimulator}`);
// Its own agent-device daemon lets go of the device before it goes.
runner({ command: options.agentDeviceCommand, args: ["close", "--session", CONTROLLER_SESSION, "--json"], cwd: simulatorProject,
environment: { ...restrictedEnvironment, AGENT_DEVICE_STATE_DIR: join(simulatorProject, "agent-device-state") }, timeoutMs: 60_000, allowFailure: true });
await stopLocalAgentDevice(join(simulatorProject, "agent-device-state"));
deleteLocalSimulator({ runner, udid: localSimulator, cwd: simulatorProject, environment: restrictedEnvironment });
if (statePath) await rm(statePath, { force: true });
await rm(simulatorProject, { recursive: true, force: true });
} catch (error) { throw new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup",
message: "The local simulator Explore created could not be deleted.", nextAction: `Delete it with: xcrun simctl delete ${localSimulator}`,
details: { udid: localSimulator, ...(primaryError ? { originalFailure: serializeCiError(primaryError, { secrets: [options.expoToken] }) } : {}) }, cause: error }); }
}
// Everything this side started on this machine is stopped; a cleanup that threw above leaves the record for a sweep.
await localRecord?.close();
if (sessionId) {
try {
setStage("cleanup");
@@ -567,7 +1048,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
throw primaryError;
}
setStage("export");
const captured = selectedIds.filter(id => outcomes[id]?.status === "captured").length;
say(`${captured} of ${selectedIds.length} ${selectedIds.length === 1 ? "route" : "routes"} captured`);
const ownSchemes = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : undefined;
const captured = selectedIds.filter(id => ownSchemes
? ownSchemes.every(scheme => outcomes[schemeScreenId(id, scheme)]?.status === "captured") : outcomes[id]?.status === "captured").length;
say(`${captured} of ${selectedIds.length} ${selectedIds.length === 1 ? "route" : "routes"} captured${ownSchemes ? ` in ${ownSchemes.join(", ")}` : ""}`);
return finish();
}
+76
View File
@@ -0,0 +1,76 @@
import { createHash } from "node:crypto";
import { existsSync } from "node:fs";
import { mkdir, readdir, readFile, rename, writeFile } from "node:fs/promises";
import { join } from "node:path";
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
/**
* Several targets of one review run the same commit of one platform and EAS profile: they need one build and one
* repack, not one each. The captures run in parallel, in worker threads, so they meet in a directory: the first to
* claim a build's folder builds it and writes the result there, and the others wait for that result (or its failure).
*/
export type SharedBuildKey = { platform: string; easProfile: string; bundleId: string; gitCommit: string; repack: string; local: boolean; routes: readonly string[] };
export function sharedBuildId(key: SharedBuildKey): string {
return createHash("sha256").update(JSON.stringify({ ...key, routes: [...key.routes].sort() })).digest("hex").slice(0, 24);
}
const POLL_MS = 2_000;
/**
* Runs `build` once per key across every capture sharing `directory`; the app it leaves goes in the build's folder
* (`keepApp`), which outlives each capture. A waiter is told so it can say whose build it uses, and told again
* (`repacking`) once the builder calls its `repacking` (the native build is known and is being repacked), or the
* build is done: a waiter starts its session then, not while a native build may run for most of an hour.
*/
export async function sharedBuild<T extends object>(options: { directory: string; key: SharedBuildKey; appName: string; signal?: AbortSignal;
build: (keepApp: string, repacking: () => Promise<void>) => Promise<T>; waiting?: () => void; repacking?: () => void;
/** Who builds it (the capture's output directory), so a review can fail its waiters if that capture dies (abandonSharedBuilds). */
owner?: string }): Promise<T> {
const folder = join(options.directory, sharedBuildId(options.key));
const result = join(folder, "result.json"), failure = join(folder, "failure.json"), repack = join(folder, "repacking");
await mkdir(options.directory, { recursive: true });
let owner = true;
try { await mkdir(folder); } catch (error) { if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error; owner = false; }
if (owner) {
if (options.owner) await writeFile(join(folder, "owner"), options.owner);
try {
const built = await options.build(join(folder, options.appName), () => writeFile(repack, "").catch(() => undefined));
await writeFile(`${result}.tmp`, JSON.stringify(built));
await rename(`${result}.tmp`, result);
return built;
} catch (error) {
await writeFile(failure, JSON.stringify(serializeCiError(toCiError(error, { code: "CAPTURE_BUILD_FAILED", stage: "build",
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." })))).catch(() => undefined);
throw error;
}
}
options.waiting?.();
let repackSeen = false;
for (;;) {
options.signal?.throwIfAborted();
const done = await readFile(result, "utf8").catch(() => undefined);
if (!repackSeen && (done !== undefined || existsSync(repack))) { repackSeen = true; options.repacking?.(); }
if (done !== undefined) return JSON.parse(done) as T;
const failed = await readFile(failure, "utf8").catch(() => undefined);
if (failed !== undefined) {
const error = JSON.parse(failed) as { code: string; stage: string; message: string; nextAction: string };
throw new CiError({ code: error.code, stage: error.stage, message: `The shared build failed: ${error.message}`, nextAction: error.nextAction });
}
await new Promise(resolve => setTimeout(resolve, POLL_MS));
}
}
/**
* Fails the unfinished builds a capture owned, for one that ended without saying (a worker thread that exited before
* its build wrote failure.json): the captures waiting on them stop instead of polling until the review is stopped.
*/
export async function abandonSharedBuilds(directory: string, ownedBy: (owner: string) => boolean, reason: string): Promise<void> {
for (const folder of await readdir(directory).catch(() => [] as string[])) {
const path = join(directory, folder);
const owner = await readFile(join(path, "owner"), "utf8").catch(() => undefined);
if (owner === undefined || !ownedBy(owner) || existsSync(join(path, "result.json")) || existsSync(join(path, "failure.json"))) continue;
await writeFile(join(path, "failure.json"), JSON.stringify(serializeCiError(new CiError({ code: "CAPTURE_BUILD_FAILED", stage: "build",
message: `the capture building it stopped (${reason})`, nextAction: "Inspect that target's failure above, correct it, and rerun Explore." }))));
}
}
+42
View File
@@ -0,0 +1,42 @@
import { isRecord } from "./common.js";
/** Runs the pinned EAS CLI with these arguments; throws when it exits non-zero unless `allowFailure` is set. */
export type EasCommand = (args: string[], options?: { timeoutMs?: number; allowFailure?: boolean }) => { stdout: string; stderr?: string };
/**
* The host actions an EAS Simulator iOS session offers through `eas simulator:control` (serve-sim's actions, 0.10.0 and
* later for the ones Explore uses): an empty set when the session or the EAS CLI offers none, so a caller falls back to
* what it did before them. The session is always named by id, never taken from a `.env.eas-simulator` beside it.
*
* These are a fallback: what the session's controller can do itself (agent-device or Argent: fold, appearance, a
* reader reset) goes through the controller. Explore uses an action here only for what neither controller offers —
* approving a link scheme, restarting SpringBoard, and Argent's appearance (software-mansion/argent#1509).
*/
export function simulatorControlActions(eas: EasCommand, sessionId: string): Set<string> {
try {
const listed = eas(["simulator:control", "--list", "--id", sessionId, "--json", "--non-interactive"], { timeoutMs: 2 * 60_000, allowFailure: true });
const actions = JSON.parse(listed.stdout) as unknown;
return new Set(isRecord(actions) ? Object.keys(actions) : []);
} catch { return new Set(); }
}
/** Runs one `eas simulator:control` action on the session; eas-cli fills in the device. Throws with EAS's reason. */
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = []): void {
// Values follow `--` so one that starts with a dash is never read as a flag.
eas(["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values], { timeoutMs: 2 * 60_000 });
}
/**
* Lets the app open its own links without iOS asking "Open in “App”?" first, like local captures do with simctl. A
* session without the action keeps the controllers' prompt handling; http and https never prompt and are skipped.
*/
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[]): string[] {
if (!actions.has("app.approveUrlScheme")) return [];
const approved: string[] = [];
for (const scheme of new Set(schemes.map(value => value.toLowerCase()))) {
if (scheme === "http" || scheme === "https" || !/^[a-z][a-z0-9+.-]*$/.test(scheme)) continue;
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme]);
approved.push(scheme);
}
return approved;
}
+123 -54
View File
@@ -2,6 +2,7 @@ import { createHash } from "node:crypto";
import { readFile } from "node:fs/promises";
import { toCiError, serializeCiError, CiError } from "../shared/ci-errors.js";
import { isRecord, parseJson, baseEnvironment, AGENT_DEVICE_VERSION, CONTROLLER_SESSION, EAS_CLI_VERSION } from "./common.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
import { SIMULATOR_PREVIEW_HOST, framedSimulatorPreviewServer } from "../shared/simulator-preview.js";
import { lstatIfExists } from "./fs-safety.js";
import { defaultRunner, openedSimulatorDevice, controllerData } from "./controller.js";
@@ -9,7 +10,21 @@ import type { RepackProfile } from "./eas-build.js";
import type { SimulatorRuntimeMetadata, CiMapOptions } from "./run.js";
import type { Platform } from "../types.js";
export type SimulatorConnection = { sessionId: string; daemonBaseUrl: string; daemonAuthToken: string };
/**
* How Explore reaches a session's device controller. For agent-device (no `controller`) these are the daemon's URL and
* token; for Argent they are the tool-server's `ARGENT_TOOLS_URL` and `ARGENT_AUTH_TOKEN`, whose token may be empty.
*/
export type SimulatorConnection = { sessionId: string; daemonBaseUrl: string; daemonAuthToken: string; controller?: "argent" };
/** The controller a connection reaches: the session `--type` EAS started. */
export function connectionController(connection: Pick<SimulatorConnection, "controller">): "agent-device" | "argent" {
return connection.controller ?? "agent-device";
}
/** The controller's pinned version: what EAS installs on the session (`--package-version`) and what runs here. */
export function controllerVersion(controller: "agent-device" | "argent"): string {
return controller === "argent" ? ARGENT_VERSION : AGENT_DEVICE_VERSION;
}
export type ActiveSimulatorRuntime = Omit<SimulatorRuntimeMetadata, "sessionLifecycle"> & { controllerDeviceId: string };
const SIMULATOR_SESSION_NAME_MAX_CHARACTERS = 50;
const SIMULATOR_SESSION_DIGEST_CHARACTERS = 20;
@@ -64,24 +79,28 @@ function simulatorConnection(
sessionId: string,
daemonBaseUrl: unknown,
daemonAuthToken: unknown,
controller: "agent-device" | "argent" = "agent-device",
): SimulatorConnection {
// An Argent tool-server may run without a token (ARGENT_AUTH_TOKEN is only set when it needs one).
if (controller === "argent" && daemonAuthToken === undefined) daemonAuthToken = "";
if (
typeof daemonBaseUrl !== "string"
|| typeof daemonAuthToken !== "string"
|| !daemonBaseUrl
|| !daemonAuthToken
|| (!daemonAuthToken && controller !== "argent")
|| daemonBaseUrl.length > 2_048
|| daemonAuthToken.length > 8_192
|| /[\u0000-\u001f\u007f]/.test(daemonBaseUrl)
|| /[\u0000-\u001f\u007f]/.test(daemonAuthToken)
) {
throw new Error("eas simulator:start returned an unsafe agent-device connection");
throw new Error(`eas simulator:start returned an unsafe ${controller} connection`);
}
remoteDaemonDomain(daemonBaseUrl);
remoteDaemonDomain(daemonBaseUrl, controller);
return {
sessionId,
daemonBaseUrl,
daemonAuthToken,
...(controller === "argent" ? { controller } : {}),
};
}
@@ -100,7 +119,7 @@ export function simulatorStartFailure(error: unknown, secrets: readonly string[]
message: source.message.replace(/\\+(["'/])/g, "$1"),
nextAction: "Inspect the EAS simulator start failure." }), { secrets });
const message = failure.message
.replace(/\b(?:AGENT_DEVICE_[A-Z_]+|EAS_SIMULATOR_[A-Z_]+|EXPO_TOKEN|agentDeviceRemoteSession(?:Token|Url)|webPreviewUrl)["']?\s*[:=][^\r\n]*/g, "[REDACTED_HANDOFF]")
.replace(/\b(?:AGENT_DEVICE_[A-Z_]+|ARGENT_[A-Z_]+|EAS_SIMULATOR_[A-Z_]+|EXPO_TOKEN|agentDeviceRemoteSession(?:Token|Url)|toolsUrl|toolsAuthToken|webPreviewUrl|previewApiUrl)["']?\s*[:=][^\r\n]*/g, "[REDACTED_HANDOFF]")
.replace(/\b[A-Za-z][A-Za-z0-9+.-]*:\/\/[^\s<>"']+/g, "[REDACTED_URL]")
.slice(0, 1600);
return { code: failure.code, stage: "session", message,
@@ -149,6 +168,8 @@ export async function readSimulatorDotenvHandoff(path: string): Promise<Simulato
"EAS_SIMULATOR_SESSION_ID",
"AGENT_DEVICE_DAEMON_BASE_URL",
"AGENT_DEVICE_DAEMON_AUTH_TOKEN",
"ARGENT_TOOLS_URL",
"ARGENT_AUTH_TOKEN",
].includes(name)) {
validationError ??= new Error("EAS Simulator dotenv handoff contains an unexpected assignment");
continue;
@@ -177,11 +198,14 @@ export async function readSimulatorDotenvHandoff(path: string): Promise<Simulato
let connection: SimulatorConnection | undefined;
if (sessionId) {
try {
connection = simulatorConnection(
sessionId,
assignments.AGENT_DEVICE_DAEMON_BASE_URL,
assignments.AGENT_DEVICE_DAEMON_AUTH_TOKEN,
);
// An `argent` session writes the Argent tool-server's variables instead of agent-device's.
connection = assignments.ARGENT_TOOLS_URL !== undefined
? simulatorConnection(sessionId, assignments.ARGENT_TOOLS_URL, assignments.ARGENT_AUTH_TOKEN, "argent")
: simulatorConnection(
sessionId,
assignments.AGENT_DEVICE_DAEMON_BASE_URL,
assignments.AGENT_DEVICE_DAEMON_AUTH_TOKEN,
);
} catch (error) {
validationError ??= error instanceof Error ? error : new Error(String(error));
}
@@ -207,36 +231,68 @@ export function assertSimulatorSessionIdentity(
sessionId !== expectedSessionId
|| !isRecord(value)
|| value.name !== expectedSessionName
|| value.type !== "agent-device"
|| value.type !== (expectedConnection ? connectionController(expectedConnection) : "agent-device")
|| value.platform !== expectedPlatform.toUpperCase()
|| value.status !== "IN_PROGRESS"
) {
throw new Error("eas simulator:get did not prove the exact expected simulator session");
}
// eas-cli 22.4.0 omits the `app` record; its `deviceRunSessionUrl` still binds the session
// to one exact owner and slug, so accept either proof but never neither.
const expectedSessionUrl = `https://expo.dev/accounts/${expectedProject.owner}`
+ `/projects/${expectedProject.slug}/simulator-sessions/${expectedSessionId}`;
const projectProven = isRecord(value.app)
? value.app.id === expectedProject.projectId
&& value.app.slug === expectedProject.slug
&& isRecord(value.app.ownerAccount)
&& value.app.ownerAccount.name === expectedProject.owner
: value.deviceRunSessionUrl === expectedSessionUrl;
if (!projectProven) {
if (!sessionProjectProven(value, expectedSessionId, expectedProject)) {
throw new Error("eas simulator:get did not prove the exact expected simulator session");
}
if (expectedConnection) {
if (
!isRecord(value.remoteConfig)
|| value.remoteConfig.agentDeviceRemoteSessionUrl !== expectedConnection.daemonBaseUrl
|| value.remoteConfig.agentDeviceRemoteSessionToken !== expectedConnection.daemonAuthToken
) {
throw new Error("eas simulator:get returned a different agent-device connection");
}
if (expectedConnection && !remoteConfigMatches(value.remoteConfig, expectedConnection)) {
throw new Error(`eas simulator:get returned a different ${connectionController(expectedConnection)} connection`);
}
}
/**
* eas-cli 22.4.0 omits the `app` record; its `deviceRunSessionUrl` still binds the session to one exact owner and
* slug, so either proof is accepted but never neither.
*/
function sessionProjectProven(value: Record<string, unknown>, sessionId: string, project: RepackProfile["projectIdentity"]): boolean {
const expectedSessionUrl = `https://expo.dev/accounts/${project.owner}/projects/${project.slug}/simulator-sessions/${sessionId}`;
return isRecord(value.app)
? value.app.id === project.projectId && value.app.slug === project.slug && isRecord(value.app.ownerAccount) && value.app.ownerAccount.name === project.owner
: value.deviceRunSessionUrl === expectedSessionUrl;
}
/**
* The status (ERRORED or STOPPED) of a session `eas simulator:get` shows EAS ended before Explore could use it, when it
* is provably this capture's own: the exact id, name, type, platform and project. Only such a session is replaced by a
* new one; anything less certain (undefined here) stays a handoff failure.
*/
export function endedOwnSimulatorSession(stdout: string, expected: { sessionId: string; sessionName: string; project: RepackProfile["projectIdentity"];
type: "agent-device" | "argent"; platform: Platform }): "ERRORED" | "STOPPED" | undefined {
let value: unknown;
try { value = JSON.parse(stdout); } catch { return undefined; }
return isRecord(value) && value.id === expected.sessionId && value.name === expected.sessionName && value.type === expected.type
&& value.platform === expected.platform.toUpperCase() && (value.status === "ERRORED" || value.status === "STOPPED")
&& sessionProjectProven(value, expected.sessionId, expected.project) ? value.status : undefined;
}
/**
* This project's sessions with exactly this name that EAS may still be starting or running, from
* `eas simulator:list --json`: their ids when every one is provably this project's, or undefined when the listing
* cannot be read or a session by that name cannot be proven Explore's, so a caller never assumes none exist.
*/
export function liveSimulatorSessionsNamed(stdout: string, sessionName: string, project: RepackProfile["projectIdentity"]): string[] | undefined {
let value: unknown;
try { value = JSON.parse(stdout); } catch { return undefined; }
if (!isRecord(value) || !Array.isArray(value.sessions)) return undefined;
const live = new Set(["NEW", "QUEUED", "STARTING", "IN_PROGRESS"]);
const named = value.sessions.filter((session): session is Record<string, unknown> => isRecord(session) && session.name === sessionName && live.has(String(session.status)));
if (named.some(session => typeof session.id !== "string" || !/^[A-Za-z0-9._-]{1,256}$/.test(session.id) || !sessionProjectProven(session, session.id, project))) return undefined;
return named.map(session => session.id as string);
}
/** The session's published controller endpoint is the one Explore holds: agent-device's daemon, or Argent's tool-server. */
function remoteConfigMatches(remoteConfig: unknown, connection: SimulatorConnection): boolean {
if (!isRecord(remoteConfig)) return false;
return connectionController(connection) === "argent"
? remoteConfig.toolsUrl === connection.daemonBaseUrl && (remoteConfig.toolsAuthToken ?? "") === connection.daemonAuthToken
: remoteConfig.agentDeviceRemoteSessionUrl === connection.daemonBaseUrl && remoteConfig.agentDeviceRemoteSessionToken === connection.daemonAuthToken;
}
/**
* A session Explore did not start: the connection comes from `eas simulator:start --out-config-type dotenv`
* (`.env.eas-simulator`) or from the `EAS_SIMULATOR_SESSION_ID` / `AGENT_DEVICE_DAEMON_*` variables that
@@ -263,7 +319,9 @@ export async function resolveAttachedSimulatorSession(
if (requestedSessionId && environment.EAS_SIMULATOR_SESSION_ID && environment.EAS_SIMULATOR_SESSION_ID !== requestedSessionId) {
throw new Error(`EAS_SIMULATOR_SESSION_ID is ${environment.EAS_SIMULATOR_SESSION_ID}, not ${requestedSessionId}`);
}
return simulatorConnection(sessionId, environment.AGENT_DEVICE_DAEMON_BASE_URL, environment.AGENT_DEVICE_DAEMON_AUTH_TOKEN);
return environment.ARGENT_TOOLS_URL !== undefined && environment.AGENT_DEVICE_DAEMON_BASE_URL === undefined
? simulatorConnection(sessionId, environment.ARGENT_TOOLS_URL, environment.ARGENT_AUTH_TOKEN, "argent")
: simulatorConnection(sessionId, environment.AGENT_DEVICE_DAEMON_BASE_URL, environment.AGENT_DEVICE_DAEMON_AUTH_TOKEN);
}
/** Proves an attached session is live, agent-device typed, and served by the connection we hold; returns its platform. */
@@ -274,8 +332,8 @@ export function assertAttachedSimulatorSession(
): { platform: Platform; name: string; deviceRunSessionUrl?: string } {
const value = parseJson(stdout, "eas simulator:get");
const sessionId = simulatorSessionId(value, "eas simulator:get");
if (sessionId !== connection.sessionId || !isRecord(value) || value.type !== "agent-device") {
throw new Error("eas simulator:get did not describe the attached agent-device session");
if (sessionId !== connection.sessionId || !isRecord(value) || value.type !== connectionController(connection)) {
throw new Error(`eas simulator:get did not describe the attached ${connectionController(connection)} session`);
}
if (value.status !== "IN_PROGRESS") {
throw new Error(`EAS Simulator session ${sessionId} is ${String(value.status).toLowerCase()}, not in progress`);
@@ -284,12 +342,8 @@ export function assertAttachedSimulatorSession(
if (!platform || (expectedPlatform && platform !== expectedPlatform)) {
throw new Error(`EAS Simulator session ${sessionId} is ${String(value.platform).toLowerCase()}${expectedPlatform ? `, not ${expectedPlatform}` : ""}`);
}
if (
!isRecord(value.remoteConfig)
|| value.remoteConfig.agentDeviceRemoteSessionUrl !== connection.daemonBaseUrl
|| value.remoteConfig.agentDeviceRemoteSessionToken !== connection.daemonAuthToken
) {
throw new Error("eas simulator:get returned a different agent-device connection than the one provided");
if (!remoteConfigMatches(value.remoteConfig, connection)) {
throw new Error(`eas simulator:get returned a different ${connectionController(connection)} connection than the one provided`);
}
return {
platform,
@@ -309,12 +363,12 @@ export function assertSimulatorStopped(stdout: string, expectedSessionId: string
}
}
function remoteDaemonDomain(value: string): string {
function remoteDaemonDomain(value: string, controller: "agent-device" | "argent" = "agent-device"): string {
let url: URL;
try {
url = new URL(value);
} catch {
throw new Error("eas simulator returned an invalid agent-device URL");
throw new Error(`eas simulator returned an invalid ${controller} URL`);
}
if (
url.protocol !== "https:"
@@ -322,21 +376,32 @@ function remoteDaemonDomain(value: string): string {
|| url.password
|| !url.hostname
) {
throw new Error("eas simulator returned an unsafe agent-device URL");
throw new Error(`eas simulator returned an unsafe ${controller} URL`);
}
return url.hostname;
}
export function collectRuntime(options: CiMapOptions & { platform: NonNullable<CiMapOptions["platform"]> }, environment: NodeJS.ProcessEnv): ActiveSimulatorRuntime {
export function collectRuntime(options: CiMapOptions & { platform: NonNullable<CiMapOptions["platform"]> }, environment: NodeJS.ProcessEnv,
/** The local simulator (UDID) or emulator (adb serial) Explore started; absent for an EAS session. */
local?: { id: string }): ActiveSimulatorRuntime {
const runner = options.runner ?? defaultRunner;
const controller = options.controller ?? "agent-device";
const version = runner({ command: options.agentDeviceCommand, args: ["--version"], cwd: options.project,
environment: baseEnvironment(options.environment ?? process.env), timeoutMs: 30_000 }).stdout.trim();
if (version !== AGENT_DEVICE_VERSION) throw new Error(`agent-device version must be ${AGENT_DEVICE_VERSION}`);
environment: controller === "argent" ? environment : baseEnvironment(options.environment ?? process.env), timeoutMs: 30_000 }).stdout.trim();
if (version !== controllerVersion(controller)) throw new Error(`${controller} version must be ${controllerVersion(controller)}`);
const opened = runner({ command: options.agentDeviceCommand,
args: ["open", options.bundleId, "--session", CONTROLLER_SESSION, ...(options.platform === "ios" ? ["--device", options.device] : []),
"--platform", options.platform, "--level", "full", "--json"], cwd: options.project, environment, timeoutMs: 60_000 });
args: ["open", options.bundleId, "--session", CONTROLLER_SESSION,
...(local ? [options.platform === "ios" ? "--udid" : "--serial", local.id] : options.platform === "ios" ? ["--device", options.device] : []),
"--platform", options.platform, "--level", "full", "--json"], cwd: options.project, environment,
// Argent's first call can wait for a tool-server that is still starting, then relaunch the app until it is readable.
// A local simulator's first open also builds agent-device's XCTest runner, once per agent-device release.
timeoutMs: controller === "argent" ? 180_000 : local ? 15 * 60_000 : 60_000 });
const device = openedSimulatorDevice(opened.stdout, options.bundleId, "initial app open", options.platform);
if (options.platform === "ios" && device.deviceModel !== options.device) throw new CiError({ code: "DEVICE_MISMATCH", stage: "runtime",
if (local && device.deviceId !== local.id) throw new CiError({ code: "DEVICE_MISMATCH", stage: "runtime",
message: `agent-device opened ${device.deviceId} instead of the device Explore started (${local.id}).`,
nextAction: "Rerun capture; if it happens again, check xcrun simctl list devices for leftover Explore simulators." });
// A local simulator is named for Explore; its model is the configured device it was created as.
if (!local && options.platform === "ios" && device.deviceModel !== options.device) throw new CiError({ code: "DEVICE_MISMATCH", stage: "runtime",
message: `EAS opened ${device.deviceModel} instead of the configured ${options.device}.`,
nextAction: "Select an available exact device name in config.yaml and rerun capture." });
const data = controllerData(opened.stdout, "initial app open");
@@ -345,8 +410,8 @@ export function collectRuntime(options: CiMapOptions & { platform: NonNullable<C
const value = deviceData[key] ?? data[key];
return typeof value === "string" && value.trim() ? value : "unknown";
};
return { provider: "eas-simulator", controller: "agent-device", controllerPackageVersion: AGENT_DEVICE_VERSION,
easCliVersion: EAS_CLI_VERSION, platform: options.platform, controllerDeviceId: device.deviceId, deviceModel: device.deviceModel,
return { provider: local ? "local-simulator" : "eas-simulator", controller, controllerPackageVersion: controllerVersion(controller),
easCliVersion: EAS_CLI_VERSION, platform: options.platform, controllerDeviceId: device.deviceId, deviceModel: local ? options.device : device.deviceModel,
osVersion: observed("osVersion"), locale: observed("locale"),
orientation: observed("orientation") === "landscape" ? "landscape" : "portrait",
colorScheme: observed("colorScheme") === "light" ? "light" : observed("colorScheme") === "dark" ? "dark" : "system" };
@@ -361,11 +426,15 @@ export function collectRuntime(options: CiMapOptions & { platform: NonNullable<C
export async function simulatorOsVersion(session: string, deviceId: string, transport: typeof fetch, platform: "ios" | "android" = "ios"): Promise<string> {
const value = parseJson(session, "eas simulator:get");
const remote = isRecord(value) && isRecord(value.remoteConfig) ? value.remoteConfig : {};
if (typeof remote.webPreviewUrl !== "string") throw new Error("EAS did not publish the simulator preview URL");
const preview = new URL(remote.webPreviewUrl);
// eas-cli 25 publishes the preview server itself as previewApiUrl, with the token in its query, but only for a
// session started with --public-link; its webPreviewUrl is then an expo.dev page with the token in the fragment.
// Earlier versions folded the token into webPreviewUrl's query. A private session's output has no token at all.
const published = typeof remote.previewApiUrl === "string" ? remote.previewApiUrl : remote.webPreviewUrl;
if (typeof published !== "string") throw new Error("EAS did not publish the simulator preview URL");
const preview = new URL(published);
if (preview.protocol !== "https:" || preview.username || preview.password) throw new Error("The simulator preview URL is not HTTPS");
// eas-cli --json folds the preview token into the URL; the catalog takes it as a bearer credential.
const token = preview.searchParams.get("token");
// The catalog takes the preview token as a bearer credential.
const token = preview.searchParams.get("token") ?? new URLSearchParams(preview.hash.slice(1)).get("token");
const catalog = new URL(framedSimulatorPreviewServer(preview) ?? preview.origin);
if (!SIMULATOR_PREVIEW_HOST.test(catalog.hostname)) throw new Error(`The simulator preview URL names no preview server: ${preview.origin}${preview.pathname}`);
// The iOS preview server lists simulators at /grid/api; the Android one has no grid and lists
+10 -2
View File
@@ -8,9 +8,10 @@ import { parseRuntimeExecutionContext } from "../review/runtime-adapter.js";
import { AGENT_ACCEPTANCE_POLICY, assertAgentAcceptance, type CaptureBundle } from "../contracts/capture.js";
import { assertDecodedPng } from "../shared/png-evidence.js";
import { canonicalJson } from "../shared/canonical-json.js";
import type { ExploreConfig } from "../config/explore-config.js";
import { captureRepack, type ExploreConfig } from "../config/explore-config.js";
import { hasVerifiedCapture } from "../capture/health.js";
import { CAPTURE_OBSERVER_HASH } from "../capture/observer.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
const METADATA = "cache-metadata.json";
const CONTRACT = "explore.capture-cache";
@@ -27,13 +28,20 @@ const recipeKey = ({ inventory, profile, config, toolsCommit }: Recipe) => {
/** Only settings that can change captured runtime evidence belong in the recipe. */
export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?: string): string {
// How many sessions capture the evidence (capture.maxSessions) does not change it.
const { maxSessions: _maxSessions, ...capture } = config.capture;
void _maxSessions;
return canonicalJson({
observer: CAPTURE_OBSERVER_HASH,
mode: config.mode,
...(config.mode === "agent" ? { agent: { ...config.agent, instructionsSha256, acceptancePolicy: AGENT_ACCEPTANCE_POLICY } } : {}),
app: { platform: config.app.platform, bundleId: config.app.bundleId, easProfile: config.app.easProfile,
...(config.app.scheme === undefined ? {} : { scheme: config.app.scheme }) },
device: config.device, parameters: config.parameters, setup: config.setup ?? [], capture: config.capture,
device: config.device, parameters: config.parameters, setup: config.setup ?? [],
// The repack as it resolves, so a config that leaves it to the default keeps the recipe it had when the default was written out.
capture: { ...capture, repack: captureRepack(config) },
// agent-device recipes stay as they were; an Argent capture is keyed to the Argent release that drove it.
...(config.capture.controller === "argent" ? { controllerVersion: ARGENT_VERSION } : {}),
});
}
+121 -21
View File
@@ -1,6 +1,6 @@
import { spawnSync } from "node:child_process";
import { readFileSync } from "node:fs";
import { lstat, mkdir, readFile, realpath } from "node:fs/promises";
import { lstat, mkdir, readdir, readFile, realpath } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join, sep } from "node:path";
import { CiError, toCiError } from "../shared/ci-errors.js";
@@ -8,8 +8,11 @@ import type { CaptureBundle } from "../contracts/capture.js";
import type { SourceCapturePlan } from "../source/capture-plan.js";
import type { CommandRunner } from "../capture/run.js";
import { runBaselineCi } from "./pipeline.js";
import { DEFAULT_EXPLORE_CONFIG_PATH, configPlatforms, readExploreConfig, readExploreInstructions, resolvePlatformConfig, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { DEFAULT_EXPLORE_CONFIG_PATH, captureRepack, configTargets, readExploreConfig, readExploreInstructions, resolveTargetConfig, withRunOverrides, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { explorationSecretNames } from "../config/exploration-inputs.js";
import { controllerCached } from "../shared/controller-cache.js";
import { androidTools, hostEmulatorAbi, localSimulatorTarget, localSystemImage } from "../capture/local-simulator.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
import { AGENT_PROVIDERS as PROVIDERS, DRAFT_INSTRUCTIONS_MARKER, EXPO_TOKENS_URL as TOKENS, appConfig, simulatorProfiles } from "../config/setup.js";
import { captureCompatibility } from "../capture/observer.js";
import { assertCaptureEasProfile, assertSimulatorAvailable, repackProfileFrom, unreproducibleEasVariables } from "../capture/eas-build.js";
@@ -46,6 +49,12 @@ export type DoctorOptions = {
github?: boolean;
/** One small model request with the local provider key. */
checkModel?: boolean;
/** `--controller`: the device controller to check, over the config's `capture.controller`. */
controller?: string | undefined;
/** `--simulator`: where the app runs, over the config's `capture.simulator`. */
simulator?: string | undefined;
/** `--repack`: where the app is repacked, over the config's `capture.repack`. */
repack?: string | undefined;
run?: DoctorRun;
environment?: NodeJS.ProcessEnv;
nodeVersion?: string;
@@ -149,7 +158,71 @@ function routeChecks(config: ExploreConfig, report: RouteEntryReport): DoctorChe
return checks;
}
async function easChecks(project: string, config: ExploreConfig, run: DoctorRun): Promise<DoctorCheck[]> {
/** Every target, resolved, once per platform, EAS profile and app: targets that differ only by device or pose share these checks. */
function resolvedTargets(config: ExploreConfig, by: (target: ExploreConfig) => string = target => `${target.app.platform}:${target.app.easProfile}:${target.app.bundleId}`): ExploreConfig[] {
const seen = new Set<string>();
return configTargets(config).map(target => resolveTargetConfig(config, { target: target.id })).filter(target => !seen.has(by(target)) && !!seen.add(by(target)));
}
/**
* Every target as a capture of it runs: its own controller and simulator (else the config's), with the run's
* --controller and --simulator over both.
*/
function runTargets(config: ExploreConfig, overrides: { controller?: string | undefined; simulator?: string | undefined }): ExploreConfig[] {
return configTargets(config).map(target => withRunOverrides(resolveTargetConfig(config, { target: target.id }), overrides));
}
/**
* The targets that run on a local simulator, in place of EAS Simulator access: this Mac's Xcode can create each iOS
* target's device, and the Android SDK can start each Android target's device profile with a system image this machine runs.
*/
async function localSimulatorChecks(project: string, targets: readonly ExploreConfig[], run: DoctorRun, environment: NodeJS.ProcessEnv): Promise<DoctorCheck[]> {
const checks: DoctorCheck[] = [];
const seen = new Set<string>();
for (const target of targets.filter(each => !seen.has(`${each.app.platform}:${each.device.name}`) && !!seen.add(`${each.app.platform}:${each.device.name}`))) {
const device = target.device.name;
if (target.app.platform === "ios") {
const types = run("xcrun", ["simctl", "list", "devicetypes", "-j"], project);
const runtimes = run("xcrun", ["simctl", "list", "runtimes", "-j"], project);
try {
if (types.status !== 0 || runtimes.status !== 0) throw new Error(lastLine(types.stderr || runtimes.stderr || "xcrun simctl failed"));
const local = localSimulatorTarget(types.stdout, runtimes.stdout, device);
checks.push({ step: 1, id: "local-simulator", status: "pass", message: `This Mac can create an ${device} simulator (iOS ${local.osVersion}).` });
} catch (error) {
checks.push(fromError(1, "local-simulator", error, { code: "LOCAL_SIMULATOR_UNAVAILABLE",
nextAction: "Install Xcode and an iOS simulator runtime for the configured device, select it with xcode-select (or DEVELOPER_DIR), then rerun doctor." }));
}
continue;
}
try {
const tools = androidTools(environment);
const image = await localSystemImage(tools.sdk, hostEmulatorAbi());
const devices = run(tools.avdmanager, ["list", "device", "-c"], project);
if (devices.status !== 0) throw new Error(lastLine(devices.stderr || devices.stdout || "avdmanager failed"));
if (!devices.stdout.split("\n").map(line => line.trim()).includes(device)) throw new CiError({ code: "LOCAL_EMULATOR_DEVICE_UNAVAILABLE", stage: "preflight",
message: `The Android SDK has no ${device} device profile.`, nextAction: "Set the target's device to a profile listed by avdmanager list device -c, such as pixel_7." });
checks.push({ step: 1, id: "local-emulator", status: "pass", message: `This machine can start a ${device} emulator (${image.image.split(";").slice(1).join(" ")}).` });
} catch (error) {
checks.push(fromError(1, "local-emulator", error, { code: "LOCAL_EMULATOR_UNAVAILABLE",
nextAction: "Install the Android SDK's emulator, platform-tools, cmdline-tools and a system image with sdkmanager, export ANDROID_HOME, then rerun doctor." }));
}
// A local simulator repacks on this machine too, unless capture.repack says eas: repack-app signs the APK with the
// SDK's build-tools and runs apktool and apksigner with Java.
if (captureRepack(target) === "local") {
const java = run("java", ["-version"], project);
let buildTools: string[] = [];
try { buildTools = await readdir(join(androidTools(environment).sdk, "build-tools")); } catch { /* no SDK or no build-tools */ }
checks.push(buildTools.length && java.status === 0
? { step: 1, id: "local-repack", status: "pass", message: `This machine can repack the APK (build-tools ${buildTools.sort().at(-1)}, ${(java.stderr || java.stdout).trim().split("\n")[0] || "Java"}).` }
: { step: 1, id: "local-repack", status: "fail", code: "LOCAL_REPACK_UNAVAILABLE",
message: buildTools.length ? "Repacking the APK on this machine needs Java, and java -version did not run." : "Repacking the APK on this machine needs the Android SDK build-tools, and none are installed.",
nextAction: "Install the build-tools (sdkmanager \"build-tools;35.0.0\") and a JDK 17, or set capture.repack: eas to repack in a hosted EAS job, then rerun doctor." });
}
}
return checks;
}
async function easChecks(project: string, config: ExploreConfig, run: DoctorRun, environment: NodeJS.ProcessEnv, simulator?: string): Promise<DoctorCheck[]> {
let eas: string;
try { eas = packageBin("eas-cli", "eas"); if (!await exists(eas)) throw new Error(); }
catch { return [{ step: 1, id: "eas-cli", status: "fail", code: "EXPLORE_TOOLS_MISSING",
@@ -168,17 +241,23 @@ async function easChecks(project: string, config: ExploreConfig, run: DoctorRun)
? { step: 1, id: "eas-project", status: "pass", message: "The app is linked to an EAS project this account can access." }
: { step: 1, id: "eas-project", status: "fail", code: "EAS_PROJECT_UNAVAILABLE", message: `EAS project check failed: ${lastLine(info.stderr || info.stdout)}`,
nextAction: "Run eas init in the app directory to link it, or ask the project's owner for access. The CI EXPO_TOKEN must belong to an account with the same access." });
const availability = run(eas, ["simulator:availability", "--json", "--non-interactive"], project);
try {
if (availability.status !== 0) throw new Error(lastLine(availability.stderr || availability.stdout));
assertSimulatorAvailable(availability.stdout);
checks.push({ step: 1, id: "eas-simulator", status: "pass", message: "EAS Simulator is available for this account." });
} catch (error) {
checks.push({ ...fromError(1, "eas-simulator", error, { code: "SIMULATOR_UNAVAILABLE", nextAction: "" }),
code: "SIMULATOR_UNAVAILABLE", nextAction: `Join the EAS Simulator waitlist at ${WAITLIST} with ${account}, the account the CI EXPO_TOKEN must use. Capture cannot run until access is granted.` });
// The targets on a local simulator need this machine's tools, and EAS Simulator access is checked when any target uses it.
const targets = runTargets(config, { simulator });
const local = targets.filter(target => target.capture.simulator === "local");
if (local.length) checks.push(...await localSimulatorChecks(project, local, run, environment));
if (local.length < targets.length) {
const availability = run(eas, ["simulator:availability", "--json", "--non-interactive"], project);
try {
if (availability.status !== 0) throw new Error(lastLine(availability.stderr || availability.stdout));
assertSimulatorAvailable(availability.stdout);
checks.push({ step: 1, id: "eas-simulator", status: "pass", message: "EAS Simulator is available for this account." });
} catch (error) {
checks.push({ ...fromError(1, "eas-simulator", error, { code: "SIMULATOR_UNAVAILABLE", nextAction: "" }),
code: "SIMULATOR_UNAVAILABLE", nextAction: `Join the EAS Simulator waitlist at ${WAITLIST} with ${account}, the account the CI EXPO_TOKEN must use. Capture cannot run until access is granted.` });
}
}
const checkedEnvironments = new Set<string>();
for (const target of configPlatforms(config).map(platform => resolvePlatformConfig(config, platform))) {
for (const target of resolvedTargets(config)) {
const { platform, easProfile, bundleId } = target.app;
const resolved = run(eas, ["config", "--platform", platform, "--profile", easProfile, "--json", "--non-interactive"], project);
if (resolved.status !== 0) {
@@ -227,7 +306,8 @@ async function easChecks(project: string, config: ExploreConfig, run: DoctorRun)
return checks;
}
async function ciFileChecks(project: string, secretNames: readonly string[], run: DoctorRun, online: boolean, platformCount = 1): Promise<{ checks: DoctorCheck[]; root?: string }> {
/** `named`: the config names its own targets, so only a workflow with a target matrix captures each one. */
async function ciFileChecks(project: string, secretNames: readonly string[], run: DoctorRun, online: boolean, platformCount = 1, named = false): Promise<{ checks: DoctorCheck[]; root?: string }> {
let layout: Awaited<ReturnType<typeof ciLayout>>;
try { layout = await ciLayout(project); }
catch (error) { return { checks: [fromError(6, "repository", error, { code: "NOT_A_GIT_REPOSITORY", nextAction: "Put the app in a Git repository, commit it, and rerun doctor." })] }; }
@@ -262,8 +342,10 @@ async function ciFileChecks(project: string, secretNames: readonly string[], run
if (drift) checks.push({ step: 6, id: `workflow-template-${name}`, status: "warn", code: "WORKFLOW_TEMPLATE_DRIFT",
message: `${file} ${drift === "stale" ? "was generated by an older @expo/explore template" : "differs from the @expo/explore template (edited after setup, or generated by an older version)"}; steps the ${EXPLORE_VERSION} template adds (such as installing ffmpeg for launch recordings) are missing from CI.`,
nextAction: drift === "stale" ? "Run expo-explore setup --workflows, then commit the workflows." : "Run expo-explore setup --workflows --force to regenerate it (reapply your edits), then commit the workflows." });
if (platformCount > 1 && !text.includes("matrix.platform")) checks.push({ step: 6, id: `workflow-platforms-${name}`, status: "warn", code: "WORKFLOW_PLATFORM_MATRIX_MISSING",
message: `${DEFAULT_EXPLORE_CONFIG_PATH} configures ${platformCount} platforms, but ${file} captures one platform (no matrix.platform).`,
// Workflows installed before targets run one job per platform, which covers a config whose targets are its platforms.
const matrix = text.includes("matrix.target") || (text.includes("matrix.platform") && !named);
if (platformCount > 1 && !matrix) checks.push({ step: 6, id: `workflow-platforms-${name}`, status: "warn", code: "WORKFLOW_PLATFORM_MATRIX_MISSING",
message: `${DEFAULT_EXPLORE_CONFIG_PATH} configures ${platformCount} targets, but ${file} does not capture each one (no matrix.target).`,
nextAction: "Run expo-explore setup --workflows to install the matrix workflows, then commit them." });
}
if (online) for (const version of versions) {
@@ -383,7 +465,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
return { ok: false, mode: null, checks, ...(routes ? { routes } : {}) };
}
let config: ExploreConfig;
try { config = await readExploreConfig(project); }
try { config = withRunOverrides(await readExploreConfig(project), { controller: options.controller, simulator: options.simulator, repack: options.repack }); }
catch (error) {
checks.push(fromError(4, "config", error, { code: "CONFIG_INVALID", nextAction: `Correct ${DEFAULT_EXPLORE_CONFIG_PATH} and rerun doctor.` }));
return { ok: false, mode: null, checks };
@@ -392,6 +474,8 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
checks.push(config.mode === "agent"
? { step: 3, id: "mode", status: "pass", message: `Agent mode with ${config.agent!.provider} ${config.agent!.model}. Capture navigation uses the model and is billed to your ${config.agent!.provider} account.` }
: { step: 3, id: "mode", status: "pass", message: "Deterministic mode: capture replays config.yaml without a model, so it needs no API key and has no AI charges." });
const argentTargets = runTargets(config, { controller: options.controller }).filter(target => target.capture.controller === "argent");
if (argentTargets.length) checks.push(argentCheck(environment, argentTargets.some(target => target.app.platform === "android" && target.capture.simulator !== "local")));
if (config.capture.launch !== "off") {
const ffmpeg = run("ffmpeg", ["-version"], project);
checks.push(ffmpeg.status === 0
@@ -402,7 +486,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
}
try {
const eas = JSON.parse(await readFile(join(project, "eas.json"), "utf8")) as Record<string, unknown>;
for (const target of configPlatforms(config).map(platform => resolvePlatformConfig(config, platform))) {
for (const target of resolvedTargets(config)) {
const { platform, easProfile } = target.app;
const requirement = platform === "ios" ? "ios.simulator: true" : "android.buildType: apk";
if (!simulatorProfiles(eas, platform).includes(easProfile)) throw new CiError({ code: platform === "ios" ? "EAS_PROFILE_NOT_SIMULATOR" : "EAS_PROFILE_NOT_APK", stage: "preflight",
@@ -465,7 +549,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
}
}
const secretNames = referencedSecretNames(config, instructions);
const files = await ciFileChecks(project, secretNames, run, options.online !== false, configPlatforms(config).length);
const files = await ciFileChecks(project, secretNames, run, options.online !== false, configTargets(config).length, !!config.targets);
checks.push(...files.checks);
if (files.root) {
const pending = run("git", ["status", "--porcelain", "--untracked-files=all", "--", DEFAULT_EXPLORE_CONFIG_PATH, ...(config.agent?.instructions ? [config.agent.instructions] : [])], project).stdout
@@ -475,7 +559,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
message: `Setup files are not committed: ${list(paths)}. CI reads them from the pushed repository.`,
nextAction: "Commit them, push, and merge them into the default branch." });
}
if (options.online !== false) checks.push(...await easChecks(project, config, run));
if (options.online !== false) checks.push(...await easChecks(project, config, run, environment, options.simulator));
else checks.push({ step: 1, id: "eas", status: "skip", message: "EAS login, project, simulator access and build profile were not checked (--offline)." });
if (options.github !== false && files.root) checks.push(...githubChecks(files.root, config, secretNames, run));
else if (files.root) checks.push({ step: 7, id: "github", status: "skip", message: `Repository settings were not checked (${options.online === false ? "--offline" : "--no-github"}).` });
@@ -547,7 +631,23 @@ export function summarizeCaptureCheck(plan: SourceCapturePlan, bundle: CaptureBu
* Capture the committed HEAD the way the baseline workflow does, with the local EAS login. This is
* the only doctor step that starts an EAS build and a simulator session.
*/
export async function runCaptureCheck(options: { project: string; output: string; platform?: ExplorePlatform; environment?: NodeJS.ProcessEnv; runner?: CommandRunner; progress?: Progress }): Promise<CaptureCheckResult> {
/**
* Argent fetches its pinned release on first use, and cannot switch the appearance itself (software-mansion/argent#1509):
* the host does, through `simulator:control` on an iOS EAS session or simctl and adb on this Mac. Only an Android EAS
* session has no host to ask, so its captures record one appearance. agent-device, the default, is not reported.
*/
function argentCheck(environment: NodeJS.ProcessEnv, androidOnEas: boolean): DoctorCheck {
const cached = controllerCached("argent", environment);
const release = `Device controller: Argent ${ARGENT_VERSION} (${cached ? "cached on this machine" : "fetched from npm on the first capture, about 27 MB"}). `;
return androidOnEas
? { step: 3, id: "controller", status: "warn", code: "CONTROLLER_APPEARANCE_FIXED",
message: `${release}Argent cannot switch the appearance on an Android EAS Simulator session yet (software-mansion/argent#1509), so those captures record one appearance: the app's forced one, else light.`,
nextAction: "Nothing to do unless you need dark-mode screenshots on Android; use agent-device (the default) for those." }
: { step: 3, id: "controller", status: "pass",
message: `${release}The simulator's host switches the appearance, so every appearance the config asks for is captured.` };
}
export async function runCaptureCheck(options: { project: string; output: string; platform?: ExplorePlatform; controller?: string | undefined; simulator?: string | undefined; repack?: string | undefined; target?: string | undefined; environment?: NodeJS.ProcessEnv; runner?: CommandRunner; progress?: Progress }): Promise<CaptureCheckResult> {
const project = await realpath(options.project);
const git = (...args: string[]) => spawnSync("git", ["-C", project, ...args], { encoding: "utf8", timeout: 10_000 });
const head = git("rev-parse", "HEAD");
@@ -559,7 +659,7 @@ export async function runCaptureCheck(options: { project: string; output: string
nextAction: "Commit your changes, including .expo-explore (a local commit is enough; nothing is pushed), then rerun. "
+ "To keep unrelated files, run it from a clean checkout instead: git worktree add --detach ../app-capture HEAD, install the app's dependencies there, and run doctor --capture in it." });
const commit = head.stdout.trim();
const config = resolvePlatformConfig(await readExploreConfig(project), options.platform);
const config = withRunOverrides(resolveTargetConfig(await readExploreConfig(project), { platform: options.platform, target: options.target }), { controller: options.controller, simulator: options.simulator, repack: options.repack });
// Capture keeps its working directories in the system temporary directory, outside the app.
await mkdir(options.output, { recursive: true });
const output = await realpath(options.output);
+83
View File
@@ -0,0 +1,83 @@
import { copyFile, mkdir, readdir, readFile, writeFile, appendFile, lstat } from "node:fs/promises";
import { dirname, join, relative } from "node:path";
import { bundleColorSchemes, mergeSchemeOutcomes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
import type { CaptureOutcome } from "../contracts/capture.js";
import type { CaptureBundle } from "../contracts/capture.js";
import type { ExploreMap } from "../types.js";
const LIST_FIELDS = ["artifacts", "screens", "variants", "observations", "elements", "actionAttempts", "transitions", "journeys", "frontier", "gaps"] as const;
async function readJson<T>(path: string): Promise<T> { return JSON.parse(await readFile(path, "utf8")) as T; }
async function copyTree(source: string, destination: string, skip: (relativePath: string) => boolean, root = source): Promise<void> {
for (const entry of await readdir(source, { withFileTypes: true })) {
const from = join(source, entry.name), to = join(destination, entry.name), rel = relative(root, from);
if (skip(rel)) continue;
if (entry.isDirectory()) { await mkdir(to, { recursive: true }); await copyTree(from, to, skip, root); continue; }
if (!entry.isFile()) continue;
if ((await lstat(to).catch(() => undefined))) continue;
await mkdir(dirname(to), { recursive: true });
await copyFile(from, to);
}
}
/**
* Fold the exports of a side's secondary appearance sessions into its primary export, in place: the frames, outcomes,
* launch evidence and map records of each `<id>@<scheme>` screen, and their files. Each session captured its passes as
* one run would (`appearancePass`), so records only append; a secondary export never replaces a primary record.
*/
export async function mergeCaptureExports(primary: string, secondaries: readonly { directory: string; scheme: ColorScheme }[]): Promise<void> {
if (secondaries.length === 0) return;
const bundle = await readJson<CaptureBundle>(join(primary, "bundle.json"));
const map = await readJson<ExploreMap>(join(primary, "screen-map.json"));
const known = { screens: new Set(map.screens.map(screen => screen.id)), artifacts: new Set(map.artifacts.map(artifact => artifact.id)) };
// The outcomes recombine as one run's passes do (mergeSchemeOutcomes): a secondary pass records a verified frame under
// `<id>@<scheme>` and a lost route under `<id>`, which the merge folds into the primary record the same way.
const schemes = bundleColorSchemes(bundle);
const passes: Record<string, CaptureOutcome>[] = schemes.map(() => ({}));
for (const [id, outcome] of Object.entries(bundle.outcomes)) if (!routeIdOfScreen(id).scheme) passes[0]![id] = outcome;
for (const { directory: secondary, scheme } of secondaries) {
const other = await readJson<CaptureBundle>(join(secondary, "bundle.json"));
const pass = passes[schemes.indexOf(scheme)];
// A session that could not show its appearance (Argent without appearance.set captures one) has nothing to add, as
// one run would have no pass for it.
if (!pass && !bundleColorSchemes(other).includes(scheme)) continue;
if (!pass) throw new Error(`The ${scheme} session's export is not an appearance of the primary export (${schemes.join(", ")})`);
for (const [id, outcome] of Object.entries(other.outcomes)) pass[routeIdOfScreen(id).routeId] = outcome;
const otherMap = await readJson<ExploreMap>(join(secondary, "screen-map.json"));
for (const [id, image] of Object.entries(other.images)) if (routeIdOfScreen(id).scheme && !bundle.images[id]) bundle.images[id] = image;
for (const [scheme, record] of Object.entries(other.launch ?? {})) { bundle.launch ??= {}; bundle.launch[scheme] ??= record; }
for (const [id, context] of Object.entries(other.captureContexts ?? {})) { bundle.captureContexts ??= {}; bundle.captureContexts[id] ??= context; }
for (const field of LIST_FIELDS) {
const records = (otherMap[field] ?? []) as Array<Record<string, unknown>>;
const target = ((map as unknown as Record<string, unknown[]>)[field] ??= []);
for (const record of records) {
if (field === "screens" && known.screens.has(record.id as string)) continue;
if (field === "artifacts" && known.artifacts.has(record.id as string)) continue;
if (field === "screens") known.screens.add(record.id as string);
if (field === "artifacts") known.artifacts.add(record.id as string);
target.push(record);
}
}
// Files: artifacts and launch evidence are new paths; diagnostics append to the primary's lines.
await copyTree(secondary, primary, rel => rel === "bundle.json" || rel === "screen-map.json" || rel === "screen-map.schema.json" || rel === "manifest.json"
|| rel === "execution.json" || rel.startsWith("capture-diagnostics"));
const diagnostics = join(secondary, "capture-diagnostics");
for (const entry of await readdir(diagnostics, { withFileTypes: true }).catch(() => [])) {
if (!entry.isFile()) continue;
const to = join(primary, "capture-diagnostics", entry.name);
await mkdir(dirname(to), { recursive: true });
if (entry.name.endsWith(".jsonl")) await appendFile(to, await readFile(join(diagnostics, entry.name)));
else if (!(await lstat(to).catch(() => undefined))) await copyFile(join(diagnostics, entry.name), to);
}
}
// An open gap a secondary pass left makes the run partial, as it does one run's (a complete run has none).
if (map.gaps.some(gap => gap.status === "open")) map.run.status = "partial";
const manifest = await readJson<{ files: unknown[] }>(join(primary, "manifest.json"));
manifest.files = map.artifacts.map(artifact => ({ path: artifact.path, sha256: artifact.sha256, bytes: artifact.bytes, mimeType: artifact.mimeType }));
await writeFile(join(primary, "screen-map.json"), JSON.stringify(map));
bundle.outcomes = mergeSchemeOutcomes(passes, schemes);
await writeFile(join(primary, "bundle.json"), JSON.stringify(bundle));
await writeFile(join(primary, "manifest.json"), `${JSON.stringify(manifest, null, 2)}\n`);
}
+190 -49
View File
@@ -1,26 +1,32 @@
import type { RunTarget } from "../types.js";
import { spawnSync } from "node:child_process";
import { randomBytes } from "node:crypto";
import { readFileSync } from "node:fs";
import { readFileSync, readdirSync } from "node:fs";
import { copyFile, cp, lstat, mkdir, mkdtemp, readdir, readFile, realpath, rename, rm, stat, utimes, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join, relative, resolve } from "node:path";
import { runCiReview } from "./pipeline.js";
import { resolveCommit } from "./workflow-steps.js";
import { ciLayout, installCommand, type PackageManager } from "./workflow-install.js";
import { configPlatforms, readExploreConfig, resolvePlatformConfig, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { AGENT_PROVIDERS } from "../config/setup.js";
import { configPlatforms, readExploreConfig, resolveTargetConfig, configTargets, posedTargets, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { AGENT_PROVIDERS, defaultExploreConfig } from "../config/setup.js";
import type { PrepareCiExplorationOptions } from "../capture/agent/exploration.js";
import { createCiAgentSession } from "../capture/agent/session.js";
import { createLocalCiAgentSession } from "../capture/agent/session-local.js";
import { androidTools, localEmulatorFromState, localSimulatorFromState } from "../capture/local-simulator.js";
import type { CommandRunner } from "../capture/run.js";
import { isSafeBranchRef, type LocalReviewPresentation, type PullRequestSidePresentation } from "../contracts/review.js";
import { exportCiReport, readCiReportInput } from "../report/artifact.js";
import { reviewChangeCount, reviewDevice, type PublicCommentState } from "../report/pr-comment-body.js";
import { zipReportDirectory } from "../report/preview-deploy.js";
import { CiError } from "../shared/ci-errors.js";
import { CiError, serializeCiError, toCiError, type CiErrorData } from "../shared/ci-errors.js";
import { defaultRunner } from "../capture/controller.js";
import { sweepLocalCaptures } from "../capture/local-registry.js";
import { abandonSharedBuilds } from "../capture/shared-build.js";
import { exploreCacheRoot } from "../shared/cache-root.js";
import { packageBin } from "../shared/package-paths.js";
import { silentProgress, type Progress } from "../shared/progress.js";
import { maxParallelTargets } from "./session-plan.js";
/**
* `capture:review --base REF [--head REF]` on a laptop: the same review CI runs (`runCiReview`), on two commits of the
@@ -32,13 +38,23 @@ export type LocalReviewOptions = {
project: string;
base?: string | undefined;
head?: string | undefined;
/** Review uncommitted changes to tracked files as the head (the working tree, not a commit). */
/** Review HEAD alone, leaving out the working tree's changes. */
committed?: boolean | undefined;
/** Review the working tree even when eas.json sets cli.requireCommit. Without --head this is the default. */
uncommitted?: boolean | undefined;
/** With `uncommitted`: also include untracked files that are not ignored. */
untracked?: boolean | undefined;
platform?: ExplorePlatform | undefined;
/** `--target`: capture this config.yaml target alone; with `platform`, the targets of that platform. */
target?: string | undefined;
/** `--parallel`: how many targets capture at once (each runs a simulator or emulator per side); by default all of them, up to capture.maxSessions. */
parallel?: number | undefined;
scope?: string | undefined;
expiresIn?: string | undefined;
/** `--controller`: the device controller for both sides, over the config's `capture.controller`. */
controller?: string | undefined;
/** `--simulator`: `local` runs both sides on simulators this Mac creates, over the config's `capture.simulator`. */
simulator?: string | undefined;
/** `--repack`: where the app is repacked with the route observer, over the config's `capture.repack`. */
repack?: string | undefined;
/** Reuse and keep captures in the local capture cache (default true). */
cache?: boolean | undefined;
configPath?: string | undefined;
@@ -52,10 +68,12 @@ export type LocalReviewOptions = {
agentSessionFactory?: PrepareCiExplorationOptions["createSession"];
};
export type LocalReviewReport = { platform: ExplorePlatform; directory: string; zip: string; changes?: number; device?: string };
export type LocalReviewReport = { platform: ExplorePlatform; target: RunTarget; directory: string; zip: string; changes?: number; device?: string };
export type LocalReviewResult = {
runId: string; base: PullRequestSidePresentation; head: PullRequestSidePresentation & { uncommitted?: string[] };
work: string; reports: LocalReviewReport[]; config: ExploreConfig; repository: string;
/** Targets whose review failed outright; the others' reports are kept and opened all the same. */
failures: { target: RunTarget; error: CiErrorData }[];
};
/** Git, without the user's hooks or fsmonitor, and never with a terminal prompt. */
@@ -89,7 +107,7 @@ export async function snapshotWorkingTree(root: string, options: { untracked?: b
for (const file of untracked) bytes += (await stat(join(root, file)).catch(() => ({ size: 0 }))).size;
if (bytes > UNTRACKED_LIMIT_BYTES) throw new CiError({ code: "LOCAL_REVIEW_UNTRACKED_TOO_LARGE", stage: "preflight",
message: `The untracked files add up to ${Math.round(bytes / 1024 / 1024)} MB; they would be uploaded with the EAS build.`,
nextAction: "Ignore or commit the large files, or leave out --include-untracked." });
nextAction: "Ignore or commit the large files, or pass --committed to review HEAD alone." });
must(git(root, ["add", options.untracked ? "-A" : "-u", "--", "."], environment), "Cannot stage the working tree", "Check the repository's state.");
const tree = must(git(root, ["write-tree"], environment), "Cannot write the working tree", "Check the repository's state.");
await rm(index, { force: true });
@@ -173,9 +191,27 @@ export async function installDependencies(project: string, logFile: string, envi
+ "Installs run without credential environment variables: a registry that needs ${NPM_TOKEN} in the project's .npmrc must be authenticated in your own ~/.npmrc instead." });
}
/** `~/.cache/expo-explore/captures/<platform>/<sha>`: one capture per commit and platform, reused while its recipe matches. */
export function captureCacheDirectory(environment: NodeJS.ProcessEnv, platform: ExplorePlatform, sha: string): string {
return join(exploreCacheRoot(environment), "captures", platform, sha);
/** Runs `task` on every item, at most `limit` at once, in order; every task settles, as Promise.allSettled does. */
export async function settleLimited<T, R>(items: readonly T[], limit: number, task: (item: T) => Promise<R>): Promise<PromiseSettledResult<R>[]> {
const results: PromiseSettledResult<R>[] = new Array(items.length);
let next = 0;
const worker = async () => {
while (next < items.length) {
const index = next++;
try { results[index] = { status: "fulfilled", value: await task(items[index]!) }; }
catch (reason) { results[index] = { status: "rejected", reason }; }
}
};
await Promise.all(Array.from({ length: Math.max(1, Math.min(limit, items.length)) }, worker));
return results;
}
/**
* `~/.cache/expo-explore/captures/<target>/<sha>`: one capture per commit and target, reused while its recipe matches.
* A config without targets names them for their platforms, so its captures stay where they were.
*/
export function captureCacheDirectory(environment: NodeJS.ProcessEnv, target: string, sha: string): string {
return join(exploreCacheRoot(environment), "captures", target, sha);
}
async function exists(path: string): Promise<boolean> { try { await lstat(path); return true; } catch { return false; } }
@@ -250,27 +286,93 @@ export async function keepCapture(exported: string, target: string): Promise<boo
}
}
/** The session state files a review writes: `<side>-session`, and `<side>-session-<scheme>` for appearance passes in their own sessions. */
function sessionStateFiles(output: string): string[] {
const rank = (name: string) => ["head", "base", "baseline"].indexOf(name.split("-")[0]!);
try { return readdirSync(output).filter(name => /^(head|base|baseline)-session(-[a-z]+)?$/.test(name)).sort((a, b) => rank(a) - rank(b) || a.localeCompare(b)); }
catch { return []; }
}
function recordedSessionIds(outputs: string[]): string[] {
return outputs.flatMap(output => ["head-session", "base-session"].flatMap(name => {
return outputs.flatMap(output => sessionStateFiles(output).flatMap(name => {
try { const id = readFileSync(join(output, name), "utf8").trim(); return /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id) ? [id] : []; } catch { return []; }
}));
}
/** Stop the EAS Simulator sessions a capture recorded and did not stop itself (an interrupted run), with the local login. */
/** How to stop a recorded session by hand: an EAS Simulator session, or a local simulator or emulator the capture started. */
function stopHint(id: string): string {
const udid = localSimulatorFromState(id);
const serial = localEmulatorFromState(id);
return udid ? `xcrun simctl delete ${udid}` : serial ? `adb -s ${serial} emu kill` : `eas simulator:stop --id ${id}`;
}
/**
* Stop the simulators a capture recorded and did not stop itself (an interrupted run): EAS Simulator sessions with the
* local login, local simulators by deleting them, and local emulators by killing them.
*/
export async function stopRecordedSessions(outputs: string[], environment: NodeJS.ProcessEnv, runner: (args: string[]) => { status: number | null } =
args => spawnSync(packageBin("eas-cli", "eas"), args, { env: environment, encoding: "utf8", timeout: 120_000 }), quiet = false): Promise<string[]> {
args => spawnSync(packageBin("eas-cli", "eas"), args, { env: environment, encoding: "utf8", timeout: 120_000 }), quiet = false,
simctl: (args: string[]) => { status: number | null } = args => spawnSync("xcrun", ["simctl", ...args], { env: environment, encoding: "utf8", timeout: 120_000 }),
adb: (args: string[]) => { status: number | null } = args => spawnSync(androidTools(environment).adb, args, { env: environment, encoding: "utf8", timeout: 60_000 })): Promise<string[]> {
const stopped: string[] = [];
for (const output of outputs) for (const name of ["head-session", "base-session"]) {
for (const output of outputs) for (const name of sessionStateFiles(output)) {
const file = join(output, name);
const id = (await readFile(file, "utf8").catch(() => "")).trim();
if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id)) continue;
if (runner(["simulator:stop", "--id", id, "--json", "--non-interactive"]).status === 0) { stopped.push(id); await rm(file, { force: true }); }
const udid = localSimulatorFromState(id);
const serial = localEmulatorFromState(id);
if (udid) simctl(["shutdown", udid]);
const stop = udid ? simctl(["delete", udid]) : serial ? adb(["-s", serial, "emu", "kill"]) : runner(["simulator:stop", "--id", id, "--json", "--non-interactive"]);
if (stop.status === 0) { stopped.push(id); await rm(file, { force: true }); }
// During an interrupt the capture may stop the same session first; only the final pass reports a failure.
else if (!quiet) process.stderr.write(`Could not stop EAS Simulator session ${id}; stop it with: eas simulator:stop --id ${id}\n`);
else if (!quiet) process.stderr.write(`Could not stop simulator ${id}; stop it with: ${stopHint(id)}\n`);
}
return stopped;
}
/**
* What the head of a review without --head is: the working tree, as `eas build` uploads it (tracked and untracked
* files, not ignored ones), unless the app's eas.json sets cli.requireCommit, which makes eas build refuse uncommitted
* changes, or --committed asks for HEAD alone. --head names a commit, so the working tree is never part of it.
*/
export async function reviewHeadSource(options: Pick<LocalReviewOptions, "head" | "committed" | "uncommitted">, project: string):
Promise<"working-tree" | "commit" | "require-commit"> {
const namedHead = options.head !== undefined && options.head !== "HEAD";
if (options.uncommitted && (namedHead || options.committed)) throw new CiError({ code: "LOCAL_REVIEW_UNCOMMITTED_HEAD", stage: "preflight",
message: "--uncommitted reviews the working tree, which is on top of HEAD.", nextAction: `Leave out ${namedHead ? "--head" : "--committed"}, or leave out --uncommitted.` });
if (namedHead || options.committed) return "commit";
if (options.uncommitted) return "working-tree";
let eas: unknown;
try { eas = JSON.parse(await readFile(join(project, "eas.json"), "utf8")); } catch { return "working-tree"; }
const cli = eas !== null && typeof eas === "object" ? (eas as { cli?: unknown }).cli : undefined;
return cli !== null && typeof cli === "object" && (cli as { requireCommit?: unknown }).requireCommit === true ? "require-commit" : "working-tree";
}
/**
* The config a local review runs with: the head commit's; else the one in your checkout, when setup has written it but
* it is not committed yet; else the defaults setup would write, so an app can be reviewed before it is set up. A
* config path passed with --config must be in the head commit.
*/
export async function localReviewConfig(options: { project: string; head: string; configPath: string; explicit: boolean;
platform?: ExplorePlatform | undefined; progress?: Progress }): Promise<ExploreConfig> {
const progress = options.progress ?? silentProgress;
if (options.explicit || await exists(join(options.head, options.configPath))) return readExploreConfig(options.head, options.configPath);
if (await exists(join(options.project, options.configPath))) {
progress(`config: ${options.configPath} from your checkout (it is not in the head commit)`);
return readExploreConfig(options.project, options.configPath);
}
let config: ExploreConfig;
try { config = await defaultExploreConfig(options.project, options.platform); }
catch (error) {
throw new CiError({ code: "LOCAL_REVIEW_CONFIG_DEFAULTS", stage: "preflight",
message: `There is no ${options.configPath}, so this review uses setup's defaults, which need this: ${(error as Error).message}`,
nextAction: "Fix that and rerun (with several simulator profiles, the one named explore is used), or run expo-explore setup to write a config." });
}
progress(`config: none yet, so setup's defaults (${config.app.bundleId}, EAS profile ${config.app.easProfile}, ${config.device.name}); `
+ "expo-explore setup writes one you can change");
return config;
}
export async function runLocalReview(options: LocalReviewOptions): Promise<LocalReviewResult> {
const environment = { ...(options.environment ?? process.env) };
const progress = options.progress ?? silentProgress;
@@ -288,13 +390,13 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
const interrupt = () => {
interrupts += 1;
if (interrupts === 1) {
process.stderr.write("\nStopping the review and its EAS Simulator sessions… (Ctrl+C again to quit now)\n");
process.stderr.write("\nStopping the review and its simulators… (Ctrl+C again to quit now)\n");
abort.abort(new CiError({ code: "LOCAL_REVIEW_INTERRUPTED", stage: "capture", message: "The review was interrupted.", nextAction: "Rerun it when you are ready." }));
if (!options.runner) void stopRecordedSessions(outputs, environment, undefined, true);
return;
}
for (const tree of worktrees) git(root, ["worktree", "remove", "--force", tree]);
for (const id of recordedSessionIds(outputs)) process.stderr.write(`Still running: stop it with eas simulator:stop --id ${id}\n`);
for (const id of recordedSessionIds(outputs)) process.stderr.write(`Still running: stop it with ${stopHint(id)}\n`);
process.exit(130);
};
process.on("SIGINT", interrupt);
@@ -306,14 +408,14 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
// The commits.
const headRef = options.head ?? "HEAD";
let head: LocalReviewResult["head"];
if (options.uncommitted) {
if (options.head && options.head !== "HEAD") throw new CiError({ code: "LOCAL_REVIEW_UNCOMMITTED_HEAD", stage: "preflight",
message: "--uncommitted reviews the working tree, which is on top of HEAD.", nextAction: "Leave out --head, or leave out --uncommitted." });
const snapshot = await snapshotWorkingTree(root, { untracked: options.untracked, work });
const source = await reviewHeadSource(options, project);
if (source === "require-commit") progress("head: HEAD; eas.json sets cli.requireCommit, so uncommitted changes are left out as eas build leaves them out (--uncommitted includes them)");
if (source === "working-tree") {
const snapshot = await snapshotWorkingTree(root, { untracked: true, work });
head = snapshot ? { ref: "uncommitted changes", sha: snapshot.sha, uncommitted: snapshot.changed } : { ref: "HEAD", sha: resolveCommit(root, "HEAD", "head") };
if (snapshot) progress(`head: your uncommitted changes to ${snapshot.changed.length} file${snapshot.changed.length === 1 ? "" : "s"}`
+ (snapshot.untracked.length ? ` (untracked, uploaded with the build and kept in .git/objects until git gc: ${snapshot.untracked.join(", ")})` : ""));
else progress("head: no uncommitted changes, reviewing HEAD");
if (snapshot) progress(`head: HEAD with your uncommitted changes to ${snapshot.changed.length} file${snapshot.changed.length === 1 ? "" : "s"}, as eas build would upload them`
+ (snapshot.untracked.length ? ` (untracked, kept in .git/objects until git gc: ${snapshot.untracked.join(", ")})` : "") + "; --committed leaves them out");
else progress("head: HEAD (no uncommitted changes)");
} else {
const sha = resolveCommit(root, headRef, "head");
head = { ref: reportRef(root, headRef, sha), sha };
@@ -321,7 +423,7 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
const baseSha = options.base ? resolveCommit(root, options.base, "base") : undefined;
const base = options.base && baseSha ? { ref: reportRef(root, options.base, baseSha), sha: baseSha } : defaultBase(root, head.sha);
if (base.sha === head.sha) throw new CiError({ code: "COMPARE_SAME_COMMIT", stage: "preflight", message: `${base.ref} and ${head.ref} are the same commit (${head.sha.slice(0, 8)}).`,
nextAction: "Pass --base with an earlier commit, or --uncommitted to review your uncommitted changes." });
nextAction: "Change something to review it, or pass --base with an earlier commit." });
progress(`comparing ${head.ref} (${head.sha.slice(0, 8)}) with ${base.ref} (${base.sha.slice(0, 8)})`);
// The checkouts, and the config at head.
@@ -333,8 +435,17 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
}
const projects = { base: join(checkouts.base, appDirectory), head: join(checkouts.head, appDirectory) };
const configPath = options.configPath ?? DEFAULT_EXPLORE_CONFIG_PATH;
const rawConfig = await readExploreConfig(projects.head, configPath);
const platforms = options.platform ? [options.platform] : configPlatforms(rawConfig);
const rawConfig = await localReviewConfig({ project, head: projects.head, configPath, explicit: options.configPath !== undefined,
platform: options.platform, progress });
const allTargets = configTargets(rawConfig);
if (options.target !== undefined && !allTargets.some(target => target.id === options.target)) throw new CiError({ code: "TARGET_NOT_CONFIGURED", stage: "preflight",
message: `The config has no target ${options.target}.`, nextAction: `Pass one of: ${allTargets.map(target => target.id).join(", ")}.` });
const targets = allTargets.filter(target => (options.target === undefined || target.id === options.target) && (options.platform === undefined || target.platform === options.platform));
if (!targets.length) throw new CiError({ code: "PLATFORM_NOT_CONFIGURED", stage: "preflight", message: `The config has no ${options.platform} target.`,
nextAction: `Pass one of: ${allTargets.map(target => target.id).join(", ")}.` });
// The reports link to each other's targets (the Viewer's target switch), so they name only the targets this review
// captures: `--target phone` or `--platform ios` makes no report for the others, and a link to one would find nothing.
const platforms = configPlatforms(rawConfig).filter(platform => targets.some(target => target.platform === platform));
const repository = repositoryName(root, rawConfig);
// Credentials: tokens and keys when set, otherwise your own logins.
@@ -347,19 +458,21 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
const subscription = rawConfig.mode === "agent" && rawConfig.agent !== undefined && !environment[AGENT_PROVIDERS[rawConfig.agent.provider].secret]?.trim();
if (subscription) progress(`model: your local ${rawConfig.agent!.provider === "anthropic" ? "claude" : "codex"} login (no ${AGENT_PROVIDERS[rawConfig.agent!.provider].secret} set)`);
let installed = false;
// Every target's capture waits on one install of both commits' dependencies.
let installed: Promise<void> | undefined;
const install = options.install ?? (async (project: string, side: "base" | "head") => {
progress(`installing the ${side} commit's dependencies`);
await installDependencies(project, join(work, `install-${side}.log`), environment);
});
const reports: LocalReviewReport[] = [];
for (const platform of platforms) {
const config = withRunOverrides(resolvePlatformConfig(rawConfig, platform), { scope: options.scope, expiresIn: options.expiresIn });
const output = join(work, platform); await mkdir(output);
// The targets run at once, as CI runs them in parallel jobs: each on its own simulators, with its own output.
const captureTarget = async (target: RunTarget): Promise<LocalReviewReport> => {
const config = withRunOverrides(resolveTargetConfig(rawConfig, { target: target.id }), { scope: options.scope, expiresIn: options.expiresIn, controller: options.controller, simulator: options.simulator, repack: options.repack });
const platform = target.platform;
const output = join(work, target.id); await mkdir(output);
outputs.push(output);
const platformEnvironment = { ...environment };
delete platformEnvironment.EXPLORE_CAPTURE_CACHE;
const cachedBase = captureCacheDirectory(environment, platform, base.sha);
const cachedBase = captureCacheDirectory(environment, target.id, base.sha);
if (options.cache !== false && await exists(join(cachedBase, CACHE_METADATA))) {
platformEnvironment.EXPLORE_CAPTURE_CACHE = cachedBase;
// Reusing a capture counts as using it, so pruning keeps the bases reviews come back to.
@@ -370,10 +483,14 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
const state: PublicCommentState = { phase: "pending", pullRequest: presentation, mode: config.exploration.scope, executionMode: config.mode,
configPath: appDirectory === "." ? configPath : `${appDirectory}/${configPath}`,
links: { viewer: null, download: null, run: "", config: "", artifacts: "" }, startedAt: Date.now(), updatedAt: Date.now(),
build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true };
progress(`${platform}: reviewing`);
build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true,
target, ...(targets.length > 1 ? { targets } : {}) };
progress(`${target.id}: reviewing${target.id === platform ? "" : ` (${target.label})`}`);
const result = await runCiReview({ projects, output, config, presentation, runId, runAttempt: "1", state, environment: platformEnvironment,
...(platforms.length > 1 ? { platforms } : {}), subscription, useLocalEasSession, progress: message => progress(`${platform}: ${message}`),
...(platforms.length > 1 ? { platforms } : {}), ...(targets.length > 1 ? { targets } : {}), posedTargets: posedTargets(rawConfig),
// Targets of one platform capture the same commits from the same build; it is built and repacked once.
...(targets.length > 1 ? { buildShare: join(work, ".builds") } : {}),
subscription, useLocalEasSession, progress: message => progress(`${target.id}: ${message}`),
...(options.runner ? { runner: options.runner } : {}), ...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}),
signal: abort.signal,
// Model requests end on Ctrl+C: the session kills its own process group and restores any login it changed.
@@ -383,11 +500,9 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
preflight: preflightOptions => session.preflight({ ...preflightOptions, signal: preflightOptions?.signal ? AbortSignal.any([preflightOptions.signal, abort.signal]) : abort.signal }),
run: request => session.run({ ...request, signal: request.signal ? AbortSignal.any([request.signal, abort.signal]) : abort.signal }) };
},
prepareCapture: async () => {
if (installed) return;
prepareCapture: () => installed ??= (async () => {
for (const side of ["head", "base"] as const) await install(projects[side], side);
installed = true;
},
})(),
assertCurrentHead: async () => {
abort.signal.throwIfAborted();
for (const side of ["base", "head"] as const) {
@@ -405,20 +520,46 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
await writeFile(zip, await zipReportDirectory(directory));
const input = await readCiReportInput(result.inputPath);
const changes = reviewChangeCount(input.commentState); const device = reviewDevice(input.commentState);
reports.push({ platform, directory, zip, ...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) });
const report: LocalReviewReport = { platform, target, directory, zip, ...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) };
// Keep both sides' captures for later reviews of these commits; a working-tree snapshot is never reviewed again.
if (options.cache !== false) for (const side of ["base", "head"] as const) {
if (side === "head" && head.uncommitted) continue;
await keepCapture(join(output, `${side}-export`), captureCacheDirectory(environment, platform, side === "base" ? base.sha : head.sha));
await keepCapture(join(output, `${side}-export`), captureCacheDirectory(environment, target.id, side === "base" ? base.sha : head.sha));
}
if (options.cache !== false) await pruneCaptureCache(environment).catch(() => []);
// The report is all that is kept; the captures, maps and checkouts are the bulk of the run.
for (const entry of await readdir(output)) if (entry !== "report" && entry !== "report.zip") await rm(join(output, entry), { recursive: true, force: true });
abort.signal.throwIfAborted();
}
return report;
};
// Every target finishes or fails on its own, so each stops the simulators it started; then the first failure is the review's.
// Whatever an earlier review stopped hard left running on this machine (simulators, emulators, daemons,
// tool-servers) is stopped first; only what Explore recorded is touched.
const swept = await sweepLocalCaptures({ environment, runner: options.runner ?? defaultRunner, cwd: work }).catch(() => [] as string[]);
if (swept.length) progress(`stopped what an interrupted review left running: ${swept.join(", ")}`);
// A capture worker that exited before its shared build said how it ended would leave the targets waiting on that build
// polling until the review is stopped: its builds are failed instead.
const releaseBuilds = async (target: RunTarget, error: unknown) => {
const failure = toCiError(error);
const side = /^capture-(head|base)$/.exec(failure.stage)?.[1];
if (targets.length > 1 && failure.code === "CAPTURE_WORKER_EXITED" && side) {
await abandonSharedBuilds(join(work, ".builds"), owner => owner === join(work, target.id, `${side}-export`), failure.code);
}
};
// Each target needs a simulator session: no more run at once than capture.maxSessions, unless --parallel says.
const settled = await settleLimited(targets, options.parallel ?? maxParallelTargets(rawConfig.capture.maxSessions, targets.length),
target => captureTarget(target).catch(async (error: unknown) => { await releaseBuilds(target, error).catch(() => undefined); throw error; }));
// One target that fails costs that target's report, not the others': they are kept, and the failure is named.
// Only an interrupted review, or one where every target failed, fails as a whole.
const reports = settled.flatMap(outcome => outcome.status === "fulfilled" ? [outcome.value] : []);
const failed = settled.flatMap((outcome, index) => outcome.status === "rejected" ? [{ target: targets[index]!, reason: outcome.reason as unknown }] : []);
abort.signal.throwIfAborted();
if (!reports.length && failed.length) throw failed[0]!.reason;
const failures = failed.map(({ target, reason }) => ({ target, error: serializeCiError(reason) }));
for (const { target, error } of failures) progress(`${target.id}: no report (${error.code}: ${error.message})`);
if (options.cache !== false) await pruneCaptureCache(environment).catch(() => []);
// The install logs and snapshot index go too; the checkouts are removed with git below.
for (const entry of await readdir(work)) if (![...platforms, "base", "head"].includes(entry)) await rm(join(work, entry), { recursive: true, force: true });
return { runId, base, head, work, reports, config: rawConfig, repository };
for (const entry of await readdir(work)) if (![...targets.map(target => target.id), "base", "head"].includes(entry)) await rm(join(work, entry), { recursive: true, force: true });
return { runId, base, head, work, reports, config: rawConfig, repository, failures };
} catch (error) {
failed = true;
// A capture interrupted mid-session reports its cleanup; the interruption is what happened.
+164 -20
View File
@@ -1,11 +1,18 @@
import { spawnSync } from "node:child_process";
import { mkdir, open, readFile, realpath, writeFile } from "node:fs/promises";
import { systemRegions } from "../contracts/capture.js";
import type { RunTarget } from "../types.js";
import { execFile, spawnSync } from "node:child_process";
import { mkdir, mkdtemp, open, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { join, relative, resolve, isAbsolute } from "node:path";
import { tmpdir } from "node:os";
import { setTimeout as delay } from "node:timers/promises";
import { promisify } from "node:util";
import { buildVerifiedPlan } from "./verified-plan.js";
import { runCiMap, type CommandRunner } from "../capture/run.js";
import { routeIdOfScreen } from "../capture/appearance.js";
import { runCiMap, type CiMapOptions, type CommandRunner } from "../capture/run.js";
import { resolveColorSchemes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
import { baseEnvironment } from "../capture/common.js";
import { DEFAULT_MAX_SESSIONS, planSideSessions, sessionShare } from "./session-plan.js";
import { mergeCaptureExports } from "./export-merge.js";
import { abandonSharedBuilds } from "../capture/shared-build.js";
import { prepareCaptureReview, readCaptureBundle } from "../review/capture-review.js";
import { quarantineReviewContract } from "../contracts/review-validation.js";
import { agentCaptureConstraints } from "../capture/agent/source-context.js";
@@ -18,7 +25,7 @@ import { projectComparePresentation, projectPullRequestPresentation, type Review
import { renderPublicComment, platformSectionMerge, type PublicCommentState } from "../report/pr-comment-body.js";
import { upsertStickyComment } from "../report/pr-comment.js";
import { viewerLinks } from "../report/viewer-links.js";
import { DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { DEFAULT_EXPLORE_CONFIG_PATH, captureRepack, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
import { prepareCiExploration, type PrepareCiExplorationOptions } from "../capture/agent/exploration.js";
import { generateAgentChangeNotes } from "../capture/agent/change-notes.js";
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
@@ -26,6 +33,7 @@ import type { SourceCapturePlan } from "../source/capture-plan.js";
import { createSourceChangeSummaries } from "../source/change-summary.js";
import { assertNoCaptureHealthIssues, partitionCaptureHealthIssues, renderCaptureIssueAnnotation, renderComparisonDiagnosticAnnotation, renderNotesUnavailableAnnotation, renderReviewGapAnnotation, sortedCaptureHealthIssues } from "../capture/health.js";
import { EXPLORE_PACKAGE, packageBin } from "../shared/package-paths.js";
import { agentDeviceLauncher, ensureArgentToolServer, ensureController } from "../shared/controller-cache.js";
import { silentProgress, type Progress } from "../shared/progress.js";
@@ -61,18 +69,110 @@ async function recipe(config: ExploreConfig, plan: SourceCapturePlan, side: "bas
/** The capture's clock and host-side pause; tests pair them with an injected runner so readiness budgets are not real time. */
type CaptureClock = { now?: (() => number) | undefined; sleep?: ((milliseconds: number) => void) | undefined };
const execFileAsync = promisify(execFile);
function captureOptions(config: ExploreConfig, environment: NodeJS.ProcessEnv, runner?: CommandRunner, clock: CaptureClock = {}) {
return { ...(runner && clock.now ? { now: clock.now } : {}), ...(runner && clock.sleep ? { sleep: clock.sleep } : {}), platform: config.app.platform, bundleId: config.app.bundleId,
...(config.app.scheme ? { scheme: config.app.scheme } : {}), device: config.device.name,
...(config.app.scheme ? { scheme: config.app.scheme } : {}), device: config.device.name, ...(config.device.pose ? { devicePose: config.device.pose } : {}),
easProfile: config.app.easProfile, expoToken: environment.EXPO_TOKEN ?? "",
maxScreens: 5000, maxActions: config.capture.maxActions, maxDurationMinutes: config.capture.maxMinutes,
setup: config.setup ?? [], forceFreshBuild: false, confirmExternalRun: true, confirmTrustedSource: true, repack: config.capture.repack, appearance: config.capture.appearance, launch: config.capture.launch, reset: config.capture.reset, unattributed: config.capture.unattributed, ...(config.capture.readinessSeconds !== undefined ? { readinessSeconds: config.capture.readinessSeconds } : {}),
environment, ...(runner ? { runner } : {}), easCommand: packageBin("eas-cli", "eas"), agentDeviceCommand: packageBin("agent-device", "agent-device"), repackCommand: packageBin("@expo/repack-app", "repack-app") };
setup: config.setup ?? [], forceFreshBuild: false, confirmExternalRun: true, confirmTrustedSource: true, repack: captureRepack(config), appearance: config.capture.appearance, launch: config.capture.launch, reset: config.capture.reset, unattributed: config.capture.unattributed, ...(config.capture.readinessSeconds !== undefined ? { readinessSeconds: config.capture.readinessSeconds } : {}), ...(config.capture.controller ? { controller: config.capture.controller } : {}),
...(config.capture.simulator ? { simulator: config.capture.simulator } : {}),
environment, ...(runner ? { runner } : {}), easCommand: packageBin("eas-cli", "eas"), agentDeviceCommand: agentDeviceLauncher(environment), repackCommand: packageBin("@expo/repack-app", "repack-app") };
}
/**
* Head and base run in parallel worker threads when nothing ties them together: an agent session is
* shared, an injected runner belongs to this thread, and a plausible baseline needs head's runtime profile.
*/
/** The controllers a capture of this config runs: agent-device always (it also compares screenshots), Argent when chosen. */
async function prefetchControllers(config: ExploreConfig, environment: NodeJS.ProcessEnv, progress: Progress): Promise<void> {
await ensureController("agent-device", { environment, progress });
if (config.capture.controller === "argent") await ensureController("argent", { environment, progress });
// Argent on a local device also needs its tool-server, installed once before the targets capture side by side.
if (config.capture.controller === "argent" && config.capture.simulator === "local") await ensureArgentToolServer({ environment, progress });
}
/**
* The appearances a capture of this side renders, read before any session starts so the sessions can divide them. The
* app config comes from `eas config` in a child process, as the capture reads it, with the capture's restricted
* environment: never evaluated in this process, which holds the review's secrets. Unknown: undefined.
*/
async function expectedColorSchemes(config: ExploreConfig, project: string, environment: NodeJS.ProcessEnv, easCommand: string): Promise<ColorScheme[] | undefined> {
// Argent switches the appearance only through serve-sim on an EAS iOS session; elsewhere it captures one.
if (config.capture.controller === "argent" && config.capture.simulator !== "local" && config.app.platform !== "ios") return undefined;
if (config.capture.appearance !== "auto") return resolveColorSchemes(config.capture.appearance, undefined, config.app.platform);
const easEnvironment = { ...baseEnvironment(environment), ...(environment.EXPO_TOKEN ? { EXPO_TOKEN: environment.EXPO_TOKEN } : {}) };
try {
const { stdout } = await execFileAsync(easCommand, ["config", "--platform", config.app.platform, "--profile", config.app.easProfile, "--json", "--non-interactive"],
{ cwd: project, env: easEnvironment, timeout: 5 * 60_000, maxBuffer: 16 * 1024 * 1024 });
const app = (JSON.parse(stdout) as { appConfig?: Record<string, unknown> }).appConfig;
return app && typeof app === "object" ? resolveColorSchemes("auto", app, config.app.platform) : undefined;
} catch {
// The capture reads the same config and reports why it cannot; until then the side keeps one session.
return undefined;
}
}
/**
* Run one side's capture: in one session, or when `passes` splits its appearances, one worker session per pass. The
* primary pass exports to `mapOptions.outputDirectory`; the others beside it, named by their appearances, then merge.
*/
async function captureSideInSessions(mapOptions: CiMapOptions, passes: readonly (readonly ColorScheme[])[] | undefined,
progress: Progress, signal: AbortSignal | undefined, worker: boolean): Promise<Awaited<ReturnType<typeof runCiMap>>> {
const runOnWorker = (passOptions: CiMapOptions) =>
runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(passOptions), progress, signal);
if (!passes || passes.length <= 1) return worker ? runOnWorker(mapOptions) : runCiMap(mapOptions);
const schemes = passes.flat();
progress(`${mapOptions.side}: capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions`);
// The passes install the same app: they share one build and repack, as the targets of a local review do.
const ownBuildShare = mapOptions.buildShare ? undefined : await mkdtemp(join(tmpdir(), "expo-explore-builds-"));
const buildShare = mapOptions.buildShare ?? ownBuildShare!;
const settled = await Promise.allSettled(passes.map(async (pass, index) => {
const suffix = index === 0 ? "" : `-${pass.join("-")}`;
const outputDirectory = `${mapOptions.outputDirectory}${suffix}`;
try {
return await runOnWorker({ ...mapOptions, mapDirectory: `${mapOptions.mapDirectory}${suffix}`, outputDirectory, buildShare,
...(mapOptions.sessionStatePath ? { sessionStatePath: `${mapOptions.sessionStatePath}${suffix}` } : {}), appearancePass: { all: schemes, capture: pass } });
} catch (error) {
// A pass that dies mid-build must not leave the others polling for its result.
await abandonSharedBuilds(buildShare, owner => owner === outputDirectory, toCiError(error).code).catch(() => undefined);
throw error;
}
}));
// The build folder holds the repacked app, which the sessions have installed.
if (ownBuildShare) await rm(ownBuildShare, { recursive: true, force: true });
for (const outcome of settled) if (outcome.status === "rejected") throw outcome.reason;
await mergeCaptureExports(mapOptions.outputDirectory, passes.slice(1).map(pass => ({ directory: `${mapOptions.outputDirectory}-${pass.join("-")}`, scheme: pass[0]! })));
return (settled[0] as PromiseFulfilledResult<Awaited<ReturnType<typeof runCiMap>>>).value;
}
/**
* This target's share of `capture.maxSessions`: the targets are this review's (`targets`), or the config's one, and
* `posedTargets` (foldables) take the sessions that do not divide evenly.
*/
function targetSessionShare(config: ExploreConfig, targets: readonly RunTarget[] | undefined, posedTargets: readonly string[] | undefined): number {
const targetIds: string[] = (targets ?? []).map(target => target.id);
if (targetIds.length === 0) targetIds.push(...(config.targets ? Object.keys(config.targets) : [config.target?.id ?? "default"]));
return sessionShare({ maxSessions: config.capture.maxSessions, targets: targetIds, target: config.target?.id ?? targetIds[0]!,
prefer: id => posedTargets?.includes(id) ? 1 : 0 });
}
/**
* The appearance passes one side spreads over sessions of its own, out of its target's share of `capture.maxSessions`;
* undefined keeps the side in one session. The side's app config is read only when its share and routes could pay for
* a split.
*/
export async function sideAppearancePasses(config: ExploreConfig, environment: NodeJS.ProcessEnv,
input: { share: number; sides: 1 | 2; routes: number; project: string; easCommand?: string }): Promise<ColorScheme[][] | undefined> {
// A pass observes its launch only when capture.launch asks for it.
const plan = (schemes: readonly ColorScheme[]) => planSideSessions({ share: input.share, sides: input.sides, routes: input.routes, schemes,
...(config.capture.launch === "off" ? { launchSeconds: 0 } : {}) }).passes;
if (plan(["light", "dark"]).length < 2) return undefined;
const schemes = await expectedColorSchemes(config, input.project, environment, input.easCommand ?? packageBin("eas-cli", "eas"));
const passes = schemes ? plan(schemes) : [];
return passes.length > 1 ? passes.map(pass => [...pass]) : undefined;
}
export function captureSidesConcurrently(input: { plan: SourceCapturePlan; agent: boolean; injectedRunner: boolean; baselineMayExist: boolean }): boolean {
return !input.agent && !input.injectedRunner && !input.baselineMayExist
&& input.plan.headCaptureSurfaceIds.length > 0 && input.plan.baseCaptureSurfaceIds.length > 0;
@@ -94,8 +194,14 @@ export type PublicCiOptions = {
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
/** Set when the workflow passes --platform; artifact and report names then carry the platform suffix. */
platform?: ExplorePlatform;
/** The target id a matrix job captures (--target, or --platform from older workflows): its comment section and names. */
target?: string;
/** Every platform config.yaml captures; recorded in the report so the Viewer links the sibling platform's report. */
platforms?: ExplorePlatform[];
/** Every target config.yaml captures, in config order; recorded in the report so the Viewer links the sibling targets' reports. */
targets?: RunTarget[];
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
posedTargets?: readonly string[];
baseProject: string; headProject: string; pullRequestPath: string; output: string;
config: ExploreConfig; configPath?: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
now?: () => number; sleep?: (milliseconds: number) => void; onComment?: (state: PublicCommentState, body: string) => void;
@@ -113,7 +219,7 @@ function assertRunIdentity(environment: NodeJS.ProcessEnv): void {
}
/** What both CI adapters check before capture: exact checkouts of both sides and an output outside them. */
async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "headProject" | "output" | "config" | "configPath" | "now">,
async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "headProject" | "output" | "config" | "configPath" | "now" | "targets">,
environment: NodeJS.ProcessEnv, presentation: ReviewPresentation) {
const now = options.now ?? Date.now;
const config = options.config;
@@ -134,7 +240,9 @@ async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "head
executionMode: config.mode, configPath: repositoryConfigPath,
links: viewerLinks({ repository: presentation.repository, headSha: presentation.head.sha, runId: environment.GITHUB_RUN_ID!,
runAttempt: environment.GITHUB_RUN_ATTEMPT!, configPath: repositoryConfigPath }),
startedAt: now(), updatedAt: now(), build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true };
startedAt: now(), updatedAt: now(), build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true,
...(config.target ? { target: config.target } : {}), ...(options.targets && options.targets.length > 1 ? { targets: options.targets } : {}),
...(config.report?.comment?.map ? { map: true } : {}) };
return { projects, output, state };
}
@@ -161,7 +269,7 @@ export async function runPublicCi(options: PublicCiOptions) {
const postComment = async () => {
await assertCurrentPr();
state.updatedAt = now(); const body = renderPublicComment(state); options.onComment?.(state, body);
try { await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, options.platform), token: githubToken, fetchImpl: transport }); }
try { await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, options.target ?? options.platform), token: githubToken, fetchImpl: transport }); }
catch (error) { process.stderr.write(`Progress comment unavailable: ${serializeCiError(error).message}\n`); }
};
let prVerificationFailed = false;
@@ -234,6 +342,12 @@ export async function runCiReview(options: {
projects: { base: string; head: string }; output: string; config: ExploreConfig;
presentation: ReviewPresentation; runId: string; runAttempt: string;
platforms?: ExplorePlatform[];
/** Every target config.yaml captures; `config.target` is the one this review captures. */
targets?: RunTarget[];
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
posedTargets?: readonly string[];
/** A folder shared with the other targets' reviews, so the targets of one platform build each commit once. */
buildShare?: string;
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
state: PublicCommentState; environment: NodeJS.ProcessEnv;
assertCurrentHead: () => Promise<void>; postComment: () => Promise<void>; canPublish?: () => boolean;
@@ -246,6 +360,10 @@ 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) 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;
const secretValues = Object.entries(environment).filter(([key]) => /(?:TOKEN|SECRET|PASSWORD|API_KEY)/i.test(key)).flatMap(([, value]) => value ? [value] : []);
@@ -283,7 +401,20 @@ export async function runCiReview(options: {
// A baseline that may be restored needs the head runtime profile first; otherwise both sides capture at once.
const baselineMayExist = plan.baseCaptureSurfaceIds.length > 0 && await captureArtifactCacheMayMatch({ ...cacheRecipes.base,
...(environment.EXPLORE_CAPTURE_CACHE ? { sourceDirectory: environment.EXPLORE_CAPTURE_CACHE } : {}), commit: pr.base.sha });
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist });
const share = targetSessionShare(config, options.targets, options.posedTargets);
// A share of one session captures the sides in turn.
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist }) && share >= 2;
// Each side's appearances split by its own app config: a pull request can change userInterfaceStyle. Sides taken in
// turn (a baseline may be restored) each have the whole share. Passes run on worker threads, which cannot take an
// injected runner or an agent session.
const sidePasses = { head: undefined as ColorScheme[][] | undefined, base: undefined as ColorScheme[][] | undefined };
if (!exploration.agent && !options.runner) await Promise.all((["head", "base"] as const).map(async side => {
sidePasses[side] = await sideAppearancePasses(config, environment, { share, sides: concurrent ? 2 : 1, routes: plan[`${side}CaptureSurfaceIds`].length, project: projects[side] });
}));
const split = (["head", "base"] as const).filter(side => sidePasses[side]);
progress(`sessions: ${share} of ${config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
+ (split.length ? `${split.join(" and ")} ${split.length === 1 ? "captures its" : "capture their"} appearances in separate sessions`
: concurrent ? "one session per side" : "the sides in turn"));
const captureSide = async (side: "head" | "base") => {
const directory = join(output, `${side}-export`);
const selectedIds = plan[`${side}CaptureSurfaceIds`];
@@ -301,11 +432,10 @@ export async function runCiReview(options: {
...(exploration.agent ? { agent: exploration.agent } : {}), project: projects[side],
mapDirectory: join(output, `${side}-map`), outputDirectory: directory,
name: config.app.name ?? pr.repository, buildId: pr.origin === "local" ? `local-${pr.runId}-${side}` : pr.origin === "compare" ? `compare-${options.runId}-${side}` : `pr-${pr.number}-${side}`, buildVersion: pr[side].sha.slice(0, 8), gitCommit: pr[side].sha,
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`),
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`), ...(options.buildShare ? { buildShare: options.buildShare } : {}),
...(reuseDirectory ? { reuseDirectory } : {}), ...(options.signal ? { signal: options.signal } : {}) };
const captured = concurrent
? await runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(mapOptions), progress, options.signal)
: await runCiMap(mapOptions);
// A restored baseline already holds every appearance pass, so it never splits.
const captured = await captureSideInSessions(mapOptions, reuseDirectory ? undefined : sidePasses[side], progress, options.signal, concurrent);
const bundle = await readCaptureBundle(directory);
bundle.profile = cacheRecipe.profile;
await writeFile(join(directory, "bundle.json"), JSON.stringify(bundle));
@@ -344,10 +474,12 @@ 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: packageBin("agent-device", "agent-device") });
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 } : {}),
app: { ...(state.build?.appVersion ? { version: state.build.appVersion } : {}),
...(state.build?.appBuildNumber ? { buildNumber: state.build.appBuildNumber } : {}) } });
const contract = quarantineReviewContract(result.review);
@@ -436,6 +568,10 @@ export async function runCiReview(options: {
}
export async function runBaselineCi(options: { platform?: ExplorePlatform; project: string; sha: string; output: string; config: ExploreConfig; environment?: NodeJS.ProcessEnv; runner?: CommandRunner;
/** Every target config.yaml captures, so this baseline takes its target's share of `capture.maxSessions`. */
targets?: RunTarget[];
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
posedTargets?: readonly string[];
now?: () => number; sleep?: (milliseconds: number) => void;
agentSessionFactory?: PrepareCiExplorationOptions["createSession"]; progress?: Progress;
/** Use the local `eas login` session instead of EXPO_TOKEN (expo-explore doctor --capture). */
@@ -444,6 +580,7 @@ export async function runBaselineCi(options: { platform?: ExplorePlatform; proje
subscription?: boolean }) {
const environment = options.environment ?? process.env;
assertCheckout(options.project, options.sha);
if (!options.runner) await prefetchControllers(options.config, environment, options.progress ?? silentProgress);
const output = resolve(options.output);
const relativeOutput = relative(await realpath(options.project), output);
if (!relativeOutput.startsWith("..") || isAbsolute(relativeOutput)) throw new Error("Baseline output must be outside the source checkout");
@@ -460,12 +597,19 @@ export async function runBaselineCi(options: { platform?: ExplorePlatform; proje
onUsage: recordAgentUsage(output, () => usagePhase), ...(options.subscription ? { subscription: true } : {}) });
const directory = join(output, "baseline-export");
usagePhase = "capture-baseline";
const result = await runCiMap({ ...captureOptions(options.config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
const baselineOptions: CiMapOptions = { ...captureOptions(options.config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
...(options.useLocalEasSession ? { useLocalEasSession: true } : {}),
...(exploration.agent ? { agent: exploration.agent } : {}), project: options.project,
mapDirectory: join(output, "baseline-map"), outputDirectory: directory, name: options.config.app.name ?? options.config.app.bundleId,
buildId: `baseline-${options.sha.slice(0, 12)}`, buildVersion: options.sha.slice(0, 8), gitCommit: options.sha,
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") });
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") };
const share = targetSessionShare(options.config, options.targets, options.posedTargets);
// Passes on worker threads cannot take an injected runner or an agent session.
const passes = !options.runner && !exploration.agent
? await sideAppearancePasses(options.config, environment, { share, sides: 1, routes: plan.headCaptureSurfaceIds.length, project: options.project }) : undefined;
progress(`sessions: ${share} of ${options.config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
+ (passes ? `capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions` : "one session"));
const result = await captureSideInSessions(baselineOptions, passes, progress, undefined, passes !== undefined);
const cacheRecipe = await recipe(options.config, plan, "head", environment, exploration.instructionsSha256);
if (options.subscription) cacheRecipe.toolsCommit += ":local-subscription";
const bundle = await readCaptureBundle(directory); bundle.profile = cacheRecipe.profile;
+70
View File
@@ -0,0 +1,70 @@
import type { ColorScheme } from "../capture/appearance.js";
/** One route capture on a remote session, with the bridge thread (observed ~5 s; 9.4 s before it). */
export const ROUTE_SECONDS = 5;
/** Observing the app launch once per appearance. */
export const LAUNCH_SECONDS = 28;
/** A pass moves to its own session only when that shortens the side by at least this much. */
export const SPLIT_MIN_SAVING_SECONDS = 60;
/**
* `capture.maxSessions` when the config sets none: the simulators a typical EAS plan runs at once. A starter plan runs
* one per platform, so its config sets the ceiling lower (2 for an iOS and an Android target).
*/
export const DEFAULT_MAX_SESSIONS = 5;
export type SessionShareInput = {
/** `capture.maxSessions`: the review-wide ceiling; absent means DEFAULT_MAX_SESSIONS. */
maxSessions: number | undefined;
/** The review's target ids in config order, and the one this job captures. */
targets: readonly string[];
target: string;
/** Targets a split pays off most for take the sessions that do not divide evenly: foldables and large screens first. */
prefer?: (target: string) => number;
};
/**
* This job's share of the review's session ceiling: the ceiling divided over the targets, the remainder going to the
* preferred targets (foldables) in config order, and unused when there are none. Never below 1 (a side then captures after the other): under a ceiling below the
* number of targets, at most that many target jobs run at once (maxParallelTargets).
*/
export function sessionShare(input: SessionShareInput): number {
const count = Math.max(1, input.targets.length);
const ceiling = input.maxSessions ?? DEFAULT_MAX_SESSIONS;
const base = Math.floor(ceiling / count);
let remainder = ceiling - base * count;
// A session left over goes to a preferred target only; without one it stays unused (two targets of five: two each).
const ranked = input.targets.filter(id => (input.prefer?.(id) ?? 0) > 0)
.sort((a, b) => input.prefer!(b) - input.prefer!(a) || input.targets.indexOf(a) - input.targets.indexOf(b));
const extra = new Set<string>();
for (const id of ranked) { if (remainder <= 0) break; extra.add(id); remainder -= 1; }
return Math.max(1, base + (extra.has(input.target) ? 1 : 0));
}
/** How many target jobs one review runs at once: each needs a session, so never more than the ceiling. */
export function maxParallelTargets(maxSessions: number | undefined, targets: number): number {
return Math.max(1, Math.min(targets, maxSessions ?? DEFAULT_MAX_SESSIONS));
}
export type SidePlan = {
/** Whether head and base capture at the same time. */
concurrentSides: boolean;
/** The appearance passes of one side, each on its own session; one entry means the side keeps a single session. */
passes: readonly (readonly ColorScheme[])[];
};
/**
* How one target's job spends its share of sessions: both sides at once when it has two, and a side's appearance passes
* in separate sessions only when the pass moved out shortens the side by at least a minute (a session costs its fixed
* boot and install time, so a few routes are not worth one). Sessions the work cannot fill stay unused: the ceiling is
* a limit, not a target.
*/
export function planSideSessions(input: { share: number; sides: 1 | 2; routes: number; schemes: readonly ColorScheme[];
minSavingSeconds?: number; routeSeconds?: number; launchSeconds?: number }): SidePlan {
const minSaving = input.minSavingSeconds ?? SPLIT_MIN_SAVING_SECONDS, perRoute = input.routeSeconds ?? ROUTE_SECONDS, launch = input.launchSeconds ?? LAUNCH_SECONDS;
const concurrentSides = input.sides === 1 || input.share >= 2;
const perSide = Math.floor(input.share / (concurrentSides ? input.sides : 1));
const schemes = [...input.schemes];
const passSeconds = input.routes * perRoute + launch;
const splitAppearances = schemes.length > 1 && perSide >= schemes.length && passSeconds >= minSaving;
return { concurrentSides, passes: splitAppearances ? schemes.map(scheme => [scheme]) : [schemes] };
}
+11 -6
View File
@@ -3,7 +3,7 @@ import { appendFile, lstat, mkdir, writeFile } from "node:fs/promises";
import { join, resolve } from "node:path";
import { tmpdir } from "node:os";
import { pathToFileURL } from "node:url";
import { parseTrustedAuthors, DEFAULT_EXPLORE_CONFIG_PATH } from "../config/explore-config.js";
import { isTargetId, parseTrustedAuthors, DEFAULT_EXPLORE_CONFIG_PATH } from "../config/explore-config.js";
import { compareTitle, compareUrl, projectComparePresentation, projectPullRequestPresentation,
type CompareReviewPresentation, type PullRequestPresentation } from "../contracts/review.js";
import { CiError } from "../shared/ci-errors.js";
@@ -109,15 +109,19 @@ type GithubRun = { conclusion: string | null; workflow_id: number; head_sha: str
* `ci:find-baseline`: the newest successful baseline-workflow artifact of exactly this commit, uploaded from the
* default branch of this repository. Its id and run go to the step outputs for actions/download-artifact.
*/
export async function findBaselineArtifact(options: { sha: string; platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
export async function findBaselineArtifact(options: { sha: string; target?: string;
/** What callers from before targets pass: a platform is the id of its default target. */ platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
const context = githubContext(environment);
if (!SHA.test(options.sha)) throw new CiError({ code: "SHA_INVALID", stage: "preflight", message: "The base commit must be a full SHA.", nextAction: "Pass --sha with a 40-character commit SHA." });
const target = options.target ?? options.platform ?? "ios";
if (!isTargetId(target)) throw new CiError({ code: "TARGET_INVALID", stage: "preflight", message: `${target} is not a target id.`,
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
const repository = await githubGet<{ default_branch: string }>(`repos/${context.repository}`, context, transport);
const workflow = await githubGet<{ id: number }>(`repos/${context.repository}/actions/workflows/explore-baseline.yml`, context, transport);
if (!repository || !workflow) return undefined;
// Baselines carry the platform suffix; iOS also accepts the unsuffixed name older baseline workflows uploaded.
const names = [`explore-baseline-${options.sha}-${options.platform ?? "ios"}`, ...(options.platform === "android" ? [] : [`explore-baseline-${options.sha}`])];
// Baselines carry the target suffix; target ios also accepts the unsuffixed name older single-platform baseline workflows uploaded.
const names = [`explore-baseline-${options.sha}-${target}`, ...(target === "ios" ? [`explore-baseline-${options.sha}`] : [])];
const artifacts: GithubArtifact[] = [];
for (const name of names) for (let page = 1; page <= 10; page++) {
const listed = await githubGet<{ artifacts: GithubArtifact[] }>(`repos/${context.repository}/actions/artifacts?name=${encodeURIComponent(name)}&per_page=100&page=${page}`, context, transport);
@@ -138,7 +142,7 @@ export async function findBaselineArtifact(options: { sha: string; platform?: st
/**
* `ci:find-baseline` as the workflow runs it: a baseline is optional, so a lookup that fails (a GitHub 5xx, a rate
* limit) is a warning and no baseline, never an error. A `ci:*` error would write explore-diagnostics/error.json,
* which the failure comment would then report as the cause of an unrelated failure, possibly on another platform.
* which the failure comment would then report as the cause of an unrelated failure, possibly on another target.
*/
export async function findOptionalBaseline(options: Parameters<typeof findBaselineArtifact>[0]):
Promise<{ baseline?: { id: number; run: number }; warning?: { code: string; message: string } }> {
@@ -192,7 +196,8 @@ export async function cleanupAfterCapture(options: { output: string; checkouts:
const environment = options.environment ?? process.env;
const result: { stopped: string[]; failures: Array<{ code: string; message: string; nextAction: string }> } = { stopped: [], failures: [] };
const sessionFiles: string[] = [];
for (const name of ["head-session", "base-session", "baseline-session"]) {
// A side that captures an appearance in a session of its own (capture.maxSessions) records it as `<side>-session-<scheme>`.
for (const name of ["head", "base", "baseline"].flatMap(side => ["", "-light", "-dark"].map(scheme => `${side}-session${scheme}`))) {
const path = resolve(options.output, name);
try { await lstat(path); sessionFiles.push(path); } catch { /* That side never started a session. */ }
}
+2 -1
View File
@@ -9,7 +9,7 @@ import { command, resultContract, argumentError, validateCommandArguments, flag,
import { help } from "./cli/help.js";
import { listScreens, getScreen, listElements, listObservations, getObservation, nextFrontier, listAttempts, getAttempt, listTransitions, getTransition, neighbors, pathQuery, listJourneys, getJourney, listFrontier, listGaps, summary, search, status, validate, exportArtifacts } from "./cli/map-commands.js";
import { compareCommand, exportWeb, view } from "./cli/catalog-commands.js";
import { ciReport, ciPublish, ciFailure, ciDeploy, ciPullRequest, ciFindBaseline, ciCompareRefs, ciAfterCapture, setup, doctor, sourceVerify, captureReview, captureBaseline, configPlatforms } from "./cli/ci-commands.js";
import { ciReport, ciPublish, ciFailure, ciDeploy, ciPullRequest, ciFindBaseline, ciCompareRefs, ciAfterCapture, setup, doctor, sourceVerify, captureReview, captureBaseline, configPlatforms, configTargetList } from "./cli/ci-commands.js";
import { exploreBinary, exploreSession } from "./cli/binary-commands.js";
import { reports, reportUpload } from "./cli/report-commands.js";
@@ -53,6 +53,7 @@ const handlers: Record<string, () => Promise<void> | void> = {
"capture:baseline": captureBaseline,
"source:verify": sourceVerify,
"config:platforms": configPlatforms,
"config:targets": configTargetList,
doctor,
compare: compareCommand,
view,
+20 -15
View File
@@ -24,12 +24,16 @@ const aliases: Record<string, string> = {
"ci failure": "ci:failure",
"ci deploy": "ci:deploy",
"config platforms": "config:platforms",
"config targets": "config:targets",
};
/** One-word names for commands people type: `capture` is the local review, `capture:review` without its CI flags. */
const shortNames: Record<string, string> = { capture: "capture:review" };
const first = argv[0] ?? "help";
const pair = `${first} ${argv[1] ?? ""}`.trim();
export const command = aliases[pair] ?? first;
export const resultContract = ["source:verify", "capture:review", "capture:baseline", "ci:report", "ci:publish", "ci:failure", "ci:deploy", "ci:pr", "ci:find-baseline", "ci:compare-refs", "ci:after-capture", "config:platforms", "explore:binary", "explore:session", "report:upload", "reports"].includes(command)
export const command = aliases[pair] ?? shortNames[first] ?? first;
export const resultContract = ["source:verify", "capture:review", "capture:baseline", "ci:report", "ci:publish", "ci:failure", "ci:deploy", "ci:pr", "ci:find-baseline", "ci:compare-refs", "ci:after-capture", "config:platforms", "config:targets", "explore:binary", "explore:session", "report:upload", "reports"].includes(command)
? "explore.result" : QUERY_CONTRACT;
const commandArgCount = aliases[pair] ? 2 : 1;
const args = argv.slice(commandArgCount);
@@ -47,10 +51,11 @@ const flagKinds: Record<string, Record<string, "value" | "boolean">> = {
setup: { project: "value", platform: "value", device: "value", scope: "value", profile: "value", "bundle-id": "value", scheme: "value", navigation: "value",
mode: "value", provider: "value", model: "value", param: "value", "app-state": "value", workflows: "boolean", "no-workflows": "boolean",
"non-interactive": "boolean", check: "boolean", force: "boolean", help: "boolean" },
doctor: { project: "value", offline: "boolean", "no-github": "boolean", "check-model": "boolean", capture: "boolean", output: "value", platform: "value", yes: "boolean", help: "boolean" },
"capture:baseline": { project:"value", sha:"value", output:"value", config:"value", platform:"value" },
"source:verify": { "base-project":"value", "head-project":"value", "base-sha":"value", "head-sha":"value", output:"value", config:"value", scope:"value", platform:"value" },
doctor: { project: "value", offline: "boolean", "no-github": "boolean", "check-model": "boolean", capture: "boolean", output: "value", target: "value", platform: "value", controller: "value", simulator: "value", repack: "value", yes: "boolean", help: "boolean" },
"capture:baseline": { project:"value", sha:"value", output:"value", config:"value", target:"value", platform:"value", controller:"value", simulator:"value", repack:"value" },
"source:verify": { "base-project":"value", "head-project":"value", "base-sha":"value", "head-sha":"value", output:"value", config:"value", scope:"value", target:"value", platform:"value" },
"config:platforms": { project:"value", config:"value" },
"config:targets": { project:"value", config:"value" },
"screen:list": { limit: "value", cursor: "value", unexplored: "boolean" },
"screen:get": { id: "value" },
"element:list": {
@@ -80,23 +85,23 @@ const flagKinds: Record<string, Record<string, "value" | "boolean">> = {
validate: {},
export: { output: "value" },
"export:web": {catalog:"value",output:"value"},
"capture:review": { "base-project":"value", "head-project":"value", "pull-request":"value", compare:"value", output:"value", config:"value", platform:"value", scope:"value", "expires-in":"value",
base:"value", head:"value", project:"value", uncommitted:"boolean", "include-untracked":"boolean", upload:"boolean", "no-open":"boolean", "no-cache":"boolean", port:"value" },
"capture:review": { "base-project":"value", "head-project":"value", "pull-request":"value", compare:"value", output:"value", config:"value", parallel:"value", target:"value", platform:"value", controller:"value", simulator:"value", repack:"value", scope:"value", "expires-in":"value",
base:"value", head:"value", project:"value", committed:"boolean", uncommitted:"boolean", "include-untracked":"boolean", upload:"boolean", "no-open":"boolean", "no-cache":"boolean", port:"value" },
"explore:binary": { archive:"value", output:"value", platform:"value", device:"value", "bundle-id":"value", "launch-url":"value", hints:"value", "allow-destructive":"value",
"explore:binary": { archive:"value", output:"value", platform:"value", controller:"value", simulator:"value", device:"value", "bundle-id":"value", "launch-url":"value", hints:"value", "allow-destructive":"value",
"max-duration-minutes":"value", "max-screens":"value", "max-actions":"value", provider:"value", model:"value", owner:"value", project:"value",
upload:"boolean", "no-upload":"boolean", "expires-in":"value", alias:"value" },
"explore:session": { session:"value", "env-file":"value", "bundle-id":"value", "app-name":"value", "app-version":"value", output:"value", platform:"value", device:"value", "launch-url":"value", hints:"value",
upload:"boolean", "no-upload":"boolean", "expires-in":"value", alias:"value", "no-open":"boolean", port:"value" },
"explore:session": { session:"value", "env-file":"value", "bundle-id":"value", "app-name":"value", "app-version":"value", output:"value", platform:"value", controller:"value", device:"value", "launch-url":"value", hints:"value",
"allow-destructive":"value", "max-duration-minutes":"value", "max-screens":"value", "max-actions":"value", provider:"value", model:"value", owner:"value", project:"value",
upload:"boolean", "expires-in":"value", alias:"value", "no-open":"boolean", port:"value" },
"ci:report": { input:"value", output:"value", platform:"value" },
"ci:publish": { input:"value", "artifact-url":"value", platform:"value", inputs:"value" },
"ci:failure": { pr:"value", head:"value", base:"value", diagnostics:"value", platform:"value" },
"ci:deploy": { input:"value", report:"value", "artifact-url":"value", platform:"value", inputs:"value", reports:"value" },
"ci:report": { input:"value", output:"value", target:"value", platform:"value" },
"ci:publish": { input:"value", "artifact-url":"value", target:"value", platform:"value", inputs:"value" },
"ci:failure": { pr:"value", head:"value", base:"value", diagnostics:"value", target:"value", platform:"value" },
"ci:deploy": { input:"value", report:"value", "artifact-url":"value", target:"value", platform:"value", inputs:"value", reports:"value" },
"ci:pr": { pr:"value", output:"value", "app-dir":"value", config:"value" },
"ci:find-baseline": { sha:"value", platform:"value" },
"ci:find-baseline": { sha:"value", target:"value", platform:"value" },
"ci:compare-refs": { project:"value", base:"value", head:"value", title:"value", output:"value" },
"ci:after-capture": { output:"value", checkout:"value" },
compare: {
+24 -21
View File
@@ -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,16 +26,22 @@ 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);
const simulator = flag("simulator") === undefined ? "eas" : oneOf("simulator", ["eas", "local"] as const);
// On EAS Simulator the report is hosted unless --no-upload; locally it opens in the Viewer unless --upload, so a
// local run needs no Expo account at all.
const upload = simulator === "local" ? has("upload") : !has("no-upload");
const port = flag("port") === undefined ? undefined : nonNegativeInteger("port");
const started = Date.now();
const say = (message: string) => { process.stderr.write(`[explore ${Math.round((Date.now() - started) / 1000)}s] ${message}\n`); };
const allowDestructive = flags("allow-destructive").flatMap(value => value.split(",")).map(value => value.trim()).filter(Boolean);
if (!has("no-upload")) await assertHostingExport();
if (upload) await assertHostingExport();
const result = await runBinaryExploration({
archive: resolve(process.cwd(), archive), output: outputDirectory, progress: say,
...(platform ? { platform } : {}), ...(provider ? { provider } : {}),
archive: resolve(process.cwd(), archive), output: outputDirectory, progress: say, simulator,
...(platform ? { platform } : {}), ...(provider ? { provider } : {}), ...(controller ? { controller } : {}),
...(flag("device") ? { device: flag("device")! } : {}), ...(flag("bundle-id") ? { bundleId: flag("bundle-id")! } : {}),
...(flag("launch-url") ? { launchUrl: flag("launch-url")! } : {}), ...(flag("hints") ? { hints: flag("hints")! } : {}),
...(allowDestructive.length ? { allowDestructive } : {}), ...(flag("model") ? { model: flag("model")! } : {}),
@@ -57,15 +54,16 @@ export async function exploreBinary(): Promise<void> {
const report = await writeExplorationReport(result, join(outputDirectory, "report"));
await keepReports(async () => [{ platform: result.archive.platform, zip: await zipReportDirectory(report.reportPath) }]);
let hosted: Awaited<ReturnType<typeof deployExplorationReport>> | undefined;
if (!has("no-upload")) {
if (upload) {
say("hosting the report on EAS Hosting");
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.archive.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, owner: result.session.owner, expiresAfterDays, ...stableLinkOptions() });
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 } : {}), ...stableLinkOptions() });
say(`report: ${hosted.previewUrl}${hosted.expiresAt ? ` (expires ${hosted.expiresAt})` : ""}`);
}
const summary = { ok: true,
app: { name: result.archive.appName, bundleId: result.archive.bundleId, platform: result.archive.platform, ...(result.archive.version ? { version: result.archive.version } : {}) },
archive: { path: result.archive.path, kind: result.archive.kind, sha256: result.archive.sha256, bytes: result.archive.bytes },
device: { model: result.runtime.deviceModel, osVersion: result.runtime.osVersion }, session: { id: result.session.id, owner: result.session.owner, project: result.session.project },
device: { model: result.runtime.deviceModel, osVersion: result.runtime.osVersion }, session: { id: result.session.id, simulator, ...(simulator === "eas" ? { owner: result.session.owner, project: result.session.project } : {}) },
model: result.model, exploration: { stopReason: result.exploration.stopReason, ...(result.exploration.summary ? { summary: result.exploration.summary } : {}),
screens: result.exploration.screens, observations: result.exploration.observations, actions: result.exploration.actions, durationMs: result.durationMs },
map: result.mapPath, report: report.reportPath, ...(hosted ? { url: hosted.previewUrl, expiresAt: hosted.expiresAt, deploymentUrl: hosted.deploymentUrl, ...(hosted.aliasUrl ? { aliasUrl: hosted.aliasUrl } : {}) } : {}),
@@ -74,7 +72,11 @@ export async function exploreBinary(): Promise<void> {
console.log(`${summary.app.name} (${summary.app.bundleId}, ${summary.app.platform}) explored on ${summary.device.model} ${summary.device.osVersion}: ${summary.exploration.screens} screens, ${summary.exploration.actions} actions, stopped because ${summary.exploration.stopReason}.`);
if (hosted) console.log(`Hosted report: ${hosted.previewUrl}${hosted.expiresAt ? ` (expires ${hosted.expiresAt})` : ""}`);
console.log(`Local report: ${report.reportPath}`);
console.log(`Next: ${summary.next.join(" | ")}`);
if (simulator === "eas" || hosted || has("no-open")) { console.log(`Next: ${summary.next.join(" | ")}`); return; }
const viewer = await startViewerServer({ root: outputDirectory, ...(port === undefined ? {} : { port }) });
console.log(`Viewer: ${viewer.url} (Ctrl+C to stop)`);
openViewerInBrowser(viewer.url);
await waitForViewerShutdown(viewer);
}
/** `--env-file` wins; otherwise the `.env.eas-simulator` that `eas simulator:start --out-config-type dotenv` wrote in the current directory, unless the environment already carries a session. */
@@ -90,9 +92,10 @@ 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);
const port = flag("port") === undefined ? undefined : nonNegativeInteger("port");
const started = Date.now();
const say = (message: string) => { process.stderr.write(`[explore ${Math.round((Date.now() - started) / 1000)}s] ${message}\n`); };
@@ -103,7 +106,7 @@ export async function exploreSession(): Promise<void> {
output: outputDirectory, progress: say,
...(bundleId ? { bundleId } : {}), ...(session ? { session } : {}), ...(envFile ? { envFile } : {}),
...(flag("app-name") ? { appName: flag("app-name")! } : {}), ...(flag("app-version") ? { version: flag("app-version")! } : {}),
...(platform ? { platform } : {}), ...(provider ? { provider } : {}),
...(platform ? { platform } : {}), ...(provider ? { provider } : {}), ...(controller ? { controller } : {}),
...(flag("device") ? { device: flag("device")! } : {}),
...(flag("launch-url") ? { launchUrl: flag("launch-url")! } : {}), ...(flag("hints") ? { hints: flag("hints")! } : {}),
...(allowDestructive.length ? { allowDestructive } : {}), ...(flag("model") ? { model: flag("model")! } : {}),
@@ -117,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 },
+72 -36
View File
@@ -15,18 +15,19 @@ 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, resolvePlatformConfig, withRunOverrides, previewDays, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExplorePlatform } from "../config/explore-config.js";
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf } from "./args.js";
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, posedTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf, positiveInteger } from "./args.js";
import { help } from "./help.js";
import { CiError } from "../shared/ci-errors.js";
import { cleanupAfterCapture, findOptionalBaseline, resolveCompareRefs, resolvePullRequest, writeCaptureOutputs, writeStepOutputs } from "../ci/workflow-steps.js";
import { stderrProgress } from "../shared/progress.js";
import { maxParallelTargets } from "../ci/session-plan.js";
export async function doctor(): Promise<void> {
if (has("help")) return help();
const project = flag("project") ?? process.cwd();
const report = await runDoctor({ project, online: !has("offline"), github: !has("no-github") && !has("offline"),
checkModel: has("check-model") });
checkModel: has("check-model"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
if (!has("capture")) {
if (has("json")) output({ ...report });
else console.log(formatDoctorReport(report));
@@ -53,7 +54,7 @@ Fix the problems in steps 1–5 before a capture check.`);
let result: Awaited<ReturnType<typeof runCaptureCheck>>;
try {
const platform = platformFlag();
result = await runCaptureCheck({ project, ...(platform ? { platform } : {}), output: resolve(flag("output") ?? await mkdtemp(join(tmpdir(), "expo-explore-capture-"))), progress: stderrProgress() });
result = await runCaptureCheck({ project, ...(platform ? { platform } : {}), target: targetFlag(), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack"), output: resolve(flag("output") ?? await mkdtemp(join(tmpdir(), "expo-explore-capture-"))), progress: stderrProgress() });
} catch (error) {
// A refusal before any EAS work: show it with its next action next to the static report.
if (!(error instanceof CiError)) throw error;
@@ -84,20 +85,20 @@ export async function ciDeploy(): Promise<void> {
}
export async function ciPublish(): Promise<void> {
const platform = platformFlag();
output({ ok: true, ...await publishCiReportComment({ inputPath: required("input"), artifactUrl: required("artifact-url"), ...(platform ? { platform } : {}) }) });
const platform = platformFlag(), target = targetFlag();
output({ ok: true, ...await publishCiReportComment({ inputPath: required("input"), artifactUrl: required("artifact-url"), ...(platform ? { platform } : {}), ...(target ? { target } : {}) }) });
}
/** The failure job's comment for a job that died before Explore could post its own: `ci:failure --pr N --head SHA --base SHA [--diagnostics DIR] [--platform P]`. */
export async function ciFailure(): Promise<void> {
const platform = platformFlag();
const platform = platformFlag(), target = targetFlag();
const repository = process.env.GITHUB_REPOSITORY, runId = process.env.GITHUB_RUN_ID, runAttempt = process.env.GITHUB_RUN_ATTEMPT;
if (!repository || !runId || !runAttempt) throw new CiError({ code: "CONFIG_MISSING", stage: "preflight", message: "GITHUB_REPOSITORY, GITHUB_RUN_ID and GITHUB_RUN_ATTEMPT are required",
nextAction: "Run ci:failure inside the GitHub Actions failure job." });
const pullNumber = Number(required("pr"));
if (!Number.isSafeInteger(pullNumber) || pullNumber <= 0) { output({ ok: true, posted: false, reason: "No PR number: the capture job never started." }); return; }
output({ ok: true, ...await publishFailureComment({ repository, pullNumber, headSha: required("head"), baseSha: required("base"), runId, runAttempt,
...(has("diagnostics") ? { diagnosticsPath: required("diagnostics") } : {}), ...(platform ? { platform } : {}) }) });
...(has("diagnostics") ? { diagnosticsPath: required("diagnostics") } : {}), ...(platform ? { platform } : {}), ...(target ? { target } : {}) }) });
}
/** `ci:pr --pr N [--output FILE]`: the live, authorized pull request; its commits go to the step outputs. */
@@ -111,8 +112,8 @@ export async function ciPullRequest(): Promise<void> {
/** `ci:find-baseline --sha SHA [--platform P]`: a reusable baseline artifact of the base commit, if one exists. */
export async function ciFindBaseline(): Promise<void> {
const platform = platformFlag();
const { baseline, warning } = await findOptionalBaseline({ sha: required("sha"), ...(platform ? { platform } : {}) });
const platform = platformFlag(), target = targetFlag();
const { baseline, warning } = await findOptionalBaseline({ sha: required("sha"), ...(platform ? { platform } : {}), ...(target ? { target } : {}) });
if (baseline) await writeStepOutputs(process.env, { id: String(baseline.id), run: String(baseline.run) });
if (warning && process.env.GITHUB_ACTIONS) console.log(`::warning title=${warning.code}::${warning.message.replace(/[\r\n]+/g, " ")}`);
output({ ok: true, baseline: baseline ?? null, ...(warning ? { warning } : {}) });
@@ -140,10 +141,33 @@ export function platformFlag(): ExplorePlatform | undefined {
return has("platform") ? oneOf("platform", EXPLORE_PLATFORMS) : undefined;
}
/** The platforms config.yaml captures, for the review workflow's matrix. */
/** The `--target` flag, when given: the config.yaml target to capture. */
export function targetFlag(): string | undefined {
const value = flag("target");
if (value !== undefined && !isTargetId(value)) argumentError("--target must be a target id from config.yaml: lowercase letters, digits and dashes.", "target");
return value;
}
/** The target `--target` (or `--platform`, from workflows installed before targets) selects. */
function targetSelection(): { target?: string; platform?: ExplorePlatform } {
const target = targetFlag(), platform = platformFlag();
return { ...(target ? { target } : {}), ...(platform ? { platform } : {}) };
}
/** The targets config.yaml captures, as ids (the review workflow's matrix); workflows installed before targets read them as platforms. */
export async function configPlatforms(): Promise<void> {
const config = await readExploreConfig(flag("project") ?? process.cwd(), flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
output({ ok: true, platforms: listPlatforms(config) });
output({ ok: true, platforms: configTargets(config).map(target => target.id) });
}
/**
* The targets config.yaml captures, in order, with their platforms and labels: the review workflow's matrix, and how
* many of its jobs run at once (`maxParallel`), since each needs a session of capture.maxSessions.
*/
export async function configTargetList(): Promise<void> {
const config = await readExploreConfig(flag("project") ?? process.cwd(), flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
const targets = configTargets(config);
output({ ok: true, targets, maxParallel: maxParallelTargets(config.capture.maxSessions, targets.length) });
}
async function exists(path: string): Promise<boolean> {
@@ -189,7 +213,7 @@ export async function setup(): Promise<void> {
export async function sourceVerify(): Promise<void> {
const headProject = required("head-project");
const config = resolvePlatformConfig(await readExploreConfig(headProject, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), platformFlag());
const config = resolveTargetConfig(await readExploreConfig(headProject, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), targetSelection());
const scope = oneOf("scope", ["all", "changes"] as const, config.exploration.scope);
const plan = await buildVerifiedPlan({ baseProject: required("base-project"), headProject,
baseSha: required("base-sha"), headSha: required("head-sha"), config, scope, output: required("output") });
@@ -201,11 +225,16 @@ export async function captureReview(): Promise<void> {
if (!has("base-project") && !has("head-project") && !has("pull-request") && !has("compare")) return localReview();
const headProject = required("head-project");
const configPath = flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH;
const platform = platformFlag();
const selection = targetSelection();
const rawConfig = await readExploreConfig(headProject, configPath);
const config = withRunOverrides(resolvePlatformConfig(rawConfig, platform), { scope: flag("scope"), expiresIn: flag("expires-in") });
// 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");
const common = { ...(platform ? { platform } : {}), platforms: listPlatforms(rawConfig), baseProject: required("base-project"), headProject,
// A matrix job names its target; its artifacts, report and comment section carry the target's id.
const named = selection.target !== undefined || selection.platform !== undefined;
const common = { ...(named ? { target: config.target!.id } : {}), ...(selection.platform ? { platform: selection.platform } : {}),
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), baseProject: required("base-project"), headProject,
output: required("output"), config, configPath, progress: stderrProgress() };
const result = has("compare") ? await runCompareCi({ ...common, comparePath: required("compare") })
: await runPublicCi({ ...common, pullRequestPath: required("pull-request") });
@@ -216,41 +245,48 @@ export async function captureReview(): Promise<void> {
export async function captureBaseline(): Promise<void> {
const project = required("project");
const platform = platformFlag();
const config = resolvePlatformConfig(await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), platform);
output({ ok: true, ...await runBaselineCi({ ...(platform ? { platform } : {}), project, sha: required("sha"), output: required("output"), config, progress: stderrProgress() }) });
const rawConfig = await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
const config = withRunOverrides(resolveTargetConfig(rawConfig, targetSelection()), { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), progress: stderrProgress() }) });
}
/** `capture:review [--base REF] [--head REF | --uncommitted]`: a local review, opened in the Viewer or hosted with --upload. */
/** `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();
const result = await runLocalReview({ project: flag("project") ?? process.cwd(), base: flag("base"), head: flag("head"),
uncommitted: has("uncommitted"), untracked: has("include-untracked"), ...(platform ? { platform } : {}),
scope: flag("scope"), expiresIn: flag("expires-in"), cache: !has("no-cache"), configPath: flag("config"), progress: stderrProgress() });
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 } : {}),
// --include-untracked is accepted from before untracked files were included by default.
committed: has("committed"), uncommitted: has("uncommitted"), ...(platform ? { platform } : {}),
scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack"), cache: !has("no-cache"), configPath: flag("config"), progress: stderrProgress() });
if (has("output")) {
for (const report of result.reports) {
const target = resolve(required("output"), report.platform);
await cp(report.directory, join(target, "report"), { recursive: true });
await cp(report.zip, join(target, "report.zip"));
report.directory = join(target, "report"); report.zip = join(target, "report.zip");
const destination = resolve(required("output"), report.target.id);
await cp(report.directory, join(destination, "report"), { recursive: true });
await cp(report.zip, join(destination, "report.zip"));
report.directory = join(destination, "report"); report.zip = join(destination, "report.zip");
}
// The reports now live under --output; the temporary copies are not needed.
await rm(result.work, { recursive: true, force: true });
}
const summary = { ok: true, runId: result.runId, base: result.base, head: result.head,
reports: result.reports.map(({ platform, directory, zip, changes, device }) => ({ platform, directory, zip, ...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) })) };
const zips = await Promise.all(result.reports.map(async report => ({ platform: report.platform, zip: new Uint8Array(await readFile(report.zip)),
// A target that failed outright has no report; the others still open, save and upload, and the command exits 1.
if (result.failures.length) process.exitCode = 1;
const summary = { ok: result.failures.length === 0, runId: result.runId, base: result.base, head: result.head,
...(result.failures.length ? { failures: result.failures.map(({ target, error }) => ({ target: target.id, code: error.code, message: error.message })) } : {}),
reports: result.reports.map(({ platform, target, directory, zip, changes, device }) => ({ platform, target: target.id, label: target.label, directory, zip,
...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) })) };
const zips = await Promise.all(result.reports.map(async report => ({ platform: report.platform, target: report.target, zip: new Uint8Array(await readFile(report.zip)),
...(report.changes === undefined ? {} : { changes: report.changes }), ...(report.device ? { device: report.device } : {}) })));
// Kept among the saved runs, with the commits' subjects (an uncommitted head is named by the commit under it).
const project = resolve(flag("project") ?? process.cwd());
const headSubject = commitSubject(project, result.head.uncommitted ? `${result.head.sha}^` : result.head.sha), baseSubject = commitSubject(project, result.base.sha);
const saved = await keepReports(zips.map(({ platform, zip }) => ({ platform, zip })), { subjects: { ...(headSubject ? { head: headSubject } : {}), ...(baseSubject ? { base: baseSubject } : {}) },
const saved = await keepReports(zips.map(({ platform, target, zip }) => ({ platform, target, zip })), { subjects: { ...(headSubject ? { head: headSubject } : {}), ...(baseSubject ? { base: baseSubject } : {}) },
...(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 });
@@ -261,7 +297,7 @@ async function localReview(): Promise<void> {
}
if (has("json") || has("no-open")) {
if (has("json")) output(summary);
else for (const report of result.reports) console.log(`${report.platform}: ${report.zip}`);
else for (const report of result.reports) console.log(`${report.target.id}: ${report.zip}`);
return;
}
const server = await startLocalReportServer({ reports: zips, ...(has("port") ? { port: nonNegativeInteger("port") } : {}) });
+40 -22
View File
@@ -15,67 +15,85 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
doctor [--project DIRECTORY] [--offline] [--no-github] [--check-model] [--json]
(checks every setup step and prints the next action for each problem; exits 1 until ready)
(--offline skips EAS and GitHub; --check-model sends one small request with the local provider key)
doctor --capture [--project DIRECTORY] [--output DIRECTORY] [--platform ios|android] [--yes]
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:review [--base REF] [--head REF | --uncommitted [--include-untracked]] [--platform ios|android] [--scope all|changes]
[--upload [--expires-in 7d|30d|never]] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
(on this machine: checks out both commits in temporary worktrees, captures them with your eas login and your
local claude or codex login, and opens the report; the base defaults to where HEAD left the default branch;
it runs both commits' code as you, so review only commits you would run)
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] [--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
left the default branch;
without .expo-explore/config.yaml it uses the defaults setup would write;
it runs both commits' code as you, so review only commits you would run; capture:review is the same command;
--controller argent drives the simulator with Argent instead of agent-device, the default (or set
capture.controller in config.yaml); on EAS Simulator Argent captures one appearance, since it cannot switch it yet;
--simulator local runs each commit on a simulator (Xcode) or emulator (Android SDK) Explore starts on this
machine, instead of EAS Simulator, and removes it afterwards (or set capture.simulator in config.yaml); builds
still run on EAS, and the host switches appearance for either controller; the app is repacked with the route
observer on this machine too (--repack eas, or capture.repack, keeps the hosted EAS job);
with targets in config.yaml it reviews them at once, up to capture.maxSessions (--parallel N at most N at a time; the targets of a platform
share each commit's build), --target ID one of them, --platform those of a platform)
view [--catalog FILE] [--port N] [--no-open]
(opens a report in the Viewer)
reports [list | open ID | add REPORT... | upload ID | rm ID | prune] [--all] [--json]
(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)`;
const BINARY = `Prebuilt apps (no source needed; runs on EAS Simulator with your local claude or codex login):
explore:binary <app.apk | app.app | app.tar.gz | simulator .ipa> [--output DIRECTORY] [--no-upload] [--json]
const BINARY = `Prebuilt apps (no source needed; runs with your local claude or codex login):
explore:binary <app.apk | app.app | app.tar.gz | simulator .ipa> [--output DIRECTORY] [--simulator eas|local] [--no-upload] [--json]
(installs the archive in a fresh EAS Simulator session, lets the model explore it, writes a map
and report under --output, hosts the report on EAS Hosting, and prints the link)
--simulator local runs it on a simulator or emulator it starts on this machine instead, with no EAS login,
and opens the report in the local Viewer (--upload hosts it instead, --no-open skips the Viewer, --port N);
iOS needs Xcode, Android the SDK (ANDROID_HOME) with platform-tools, cmdline-tools, the emulator and a system image for this Mac
Flags, all optional: --device NAME --bundle-id ID --launch-url URL --hints "what to focus on"
--controller agent-device|argent (the device controller; agent-device by default)
(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 session starts)
(iOS needs a simulator build; a device .ipa and Android .aab are rejected before any device starts)
explore:session [SESSION_ID] [--bundle-id ID] [--output DIRECTORY] [--upload] [--json]
(explores an app that is already installed on an EAS Simulator session you started — run it where
"eas simulator:start --type agent-device --out-config-type dotenv" wrote .env.eas-simulator, or pass
--env-file FILE, or export EAS_SIMULATOR_SESSION_ID, AGENT_DEVICE_DAEMON_BASE_URL and
AGENT_DEVICE_DAEMON_AUTH_TOKEN; writes the map and report, then opens them in the local Viewer;
"eas simulator:start --type agent-device --out-config-type dotenv" (or --type argent) wrote .env.eas-simulator,
or pass --env-file FILE, or export EAS_SIMULATOR_SESSION_ID with AGENT_DEVICE_DAEMON_BASE_URL and
AGENT_DEVICE_DAEMON_AUTH_TOKEN, or with ARGENT_TOOLS_URL and ARGENT_AUTH_TOKEN; writes the map and report, then opens them in the local Viewer;
--upload hosts the report instead, --no-open skips the Viewer; the session is left running;
the app is the one in the foreground, else the only installed one; --bundle-id picks it otherwise)
the app is the one in the foreground, else the only installed one; --bundle-id picks it otherwise;
the controller follows the session's type, and --controller must match it)
Extra flags: --app-name NAME --app-version X.Y --port N, plus the explore:binary budget/model flags
Afterwards: view --dir DIRECTORY, screen:list --dir DIRECTORY, gap:list --dir DIRECTORY`;
const CI = `CI (the installed workflows run these; they manage remote EAS Simulator sessions):
config:targets [--project DIRECTORY] [--config FILE]
(lists the targets config.yaml captures, with their platforms and labels; the review workflow's matrix)
config:platforms [--project DIRECTORY] [--config FILE]
(lists the platforms config.yaml captures; the review workflow's matrix)
capture:review --base-project DIRECTORY --head-project DIRECTORY (--pull-request FILE | --compare FILE)
--output TEMP_DIRECTORY [--config .expo-explore/config.yaml] [--platform ios|android]
--output TEMP_DIRECTORY [--config .expo-explore/config.yaml] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local]
(--compare reviews any two commits without a PR: {"origin":"compare","repositoryId","repository","base":{ref,sha},"head":{ref,sha}})
capture:baseline --project DIRECTORY --sha COMMIT --output TEMP_DIRECTORY [--config FILE] [--platform ios|android]
capture:baseline --project DIRECTORY --sha COMMIT --output TEMP_DIRECTORY [--config FILE] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local]
source:verify --base-project DIRECTORY --head-project DIRECTORY
--base-sha COMMIT --head-sha COMMIT --output DIRECTORY [--config FILE] [--scope all|changes] [--platform ios|android]
--base-sha COMMIT --head-sha COMMIT --output DIRECTORY [--config FILE] [--scope all|changes] [--target ID | --platform ios|android]
compare --baseline DIRECTORY --current DIRECTORY --output FILE
[--review-output FILE] [--catalog-output FILE] [--catalog-name NAME]
[--base-surface-coverage FILE] [--head-surface-coverage FILE]
export:web --catalog FILE --output DIRECTORY
ci:report --input REPORT_INPUT --output DIRECTORY [--platform ios|android]
ci:publish --input REPORT_INPUT --artifact-url GITHUB_ARTIFACT_URL [--platform ios|android]
ci:report --input REPORT_INPUT --output DIRECTORY [--target ID | --platform ios|android]
ci:publish --input REPORT_INPUT --artifact-url GITHUB_ARTIFACT_URL [--target ID | --platform ios|android]
ci:publish --inputs DIRECTORY (one <platform>/ subdirectory per captured platform)
ci:deploy --input REPORT_INPUT --report REPORT_DIR --artifact-url GITHUB_ARTIFACT_URL [--platform ios|android]
ci:deploy --input REPORT_INPUT --report REPORT_DIR --artifact-url GITHUB_ARTIFACT_URL [--target ID | --platform ios|android]
ci:deploy --inputs DIRECTORY --reports DIRECTORY
ci:pr --pr N [--output FILE] [--app-dir DIRECTORY]
(resolves the live PR and refuses it unless it is open, from this repository, and by a trusted author)
ci:compare-refs --project DIRECTORY --base REF --head REF [--output FILE]
ci:find-baseline --sha COMMIT [--platform ios|android]
ci:find-baseline --sha COMMIT [--target ID | --platform ios|android]
ci:after-capture --output TEMP_DIRECTORY --checkout DIRECTORY...
(stops the capture's EAS Simulator sessions and checks capture left each checkout unchanged)
(the ci:* commands write their results to $GITHUB_OUTPUT for the next steps)`;
+21 -22
View File
@@ -3,18 +3,17 @@ 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, type ExplorePlatform } 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, saveRun, savedRunsDirectory, SAVED_RUN_LIMITS, type SavedReport, type SavedRun } from "../report/saved-runs.js";
import { findSavedRun, listSavedRuns, pruneSavedRuns, readSavedReports, removeSavedRun, reportTarget, saveRun, savedRunsDirectory, SAVED_RUN_LIMITS, type SavedReport, type SavedRun } from "../report/saved-runs.js";
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 }> {
@@ -70,18 +69,18 @@ async function repositoryPreview(repository: string): Promise<{ preview: Preview
type ReadReport = Awaited<ReturnType<typeof readReport>>;
/** Several reports share one link only as one review's platforms; an exploration goes up on its own. */
/** Several reports share one link only as one review's targets; an exploration goes up on its own. */
function assertOneReview(reports: ReadReport[]): void {
const [first, ...others] = reports as [ReadReport, ...ReadReport[]];
const platforms = new Set<ExplorePlatform>([first.summary.platform]);
const targets = new Set<string>([first.summary.target.id]);
for (const report of others) {
if (platforms.has(report.summary.platform)) throw new CiError({ code: "PREVIEW_REPORTS_INVALID", stage: "preflight",
message: `More than one ${report.summary.platform} report: one link holds one report per platform.`, nextAction: "Upload each platform's report once." });
platforms.add(report.summary.platform);
if (targets.has(report.summary.target.id)) throw new CiError({ code: "PREVIEW_REPORTS_INVALID", stage: "preflight",
message: `More than one ${report.summary.target.id} report: one link holds one report per target.`, nextAction: "Upload each target's report once." });
targets.add(report.summary.target.id);
const a = first.summary, b = report.summary;
if (a.kind !== "review" || b.kind !== "review" || a.repository !== b.repository || a.runId !== b.runId || a.base !== b.base || a.head !== b.head) {
throw new CiError({ code: "PREVIEW_REPORTS_MISMATCH", stage: "preflight", message: `${first.path} and ${report.path} are not the same review's platforms.`,
nextAction: "Upload the reports of one review together (one per platform), and anything else on its own." });
throw new CiError({ code: "PREVIEW_REPORTS_MISMATCH", stage: "preflight", message: `${first.path} and ${report.path} are not the same review's targets.`,
nextAction: "Upload the reports of one review together (one per target), and anything else on its own." });
}
}
}
@@ -94,19 +93,19 @@ 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,
reports: reports.map(report => ({ platform: report.summary.platform, zip: report.zip,
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.",
projectHint: "Give this EAS login permission to create projects under the owner, or pass --project with an existing project slug." });
if (has("json")) {
output({ ok: true, url: hosted.previewUrl, expiresAt: hosted.expiresAt, project: hosted.project, owner: hosted.owner,
reports: reports.map(report => ({ path: report.path, platform: report.summary.platform, kind: report.summary.kind })) });
reports: reports.map(report => ({ path: report.path, platform: report.summary.platform, target: report.summary.target.id, kind: report.summary.kind })) });
return;
}
console.log(`Report: ${hosted.previewUrl}${hosted.expiresAt ? ` (until ${hosted.expiresAt.slice(0, 10)})` : ""}`);
@@ -141,7 +140,7 @@ export async function reportUpload(): Promise<void> {
assertOneReview(reports);
const review = reports[0]!.summary.kind === "review" ? reports[0]!.summary : undefined;
const head = review && commitSubject(process.cwd(), review.head), base = review && commitSubject(process.cwd(), review.base);
await keepReports(reports.map(report => ({ platform: report.summary.platform, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
await keepReports(reports.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
await hostReports(reports);
}
@@ -171,14 +170,14 @@ async function savedRun(id: string | undefined): Promise<SavedRun> {
async function uploadSavedRun(run: SavedRun): Promise<void> {
const reports: ReadReport[] = [];
for (const report of await readSavedReports(run)) reports.push({ path: `${run.id}/${report.platform}.zip`, zip: report.zip, summary: await readReportZip(report.zip) });
for (const report of await readSavedReports(run)) reports.push({ path: `${run.id}/${reportTarget(report).id}.zip`, zip: report.zip, summary: await readReportZip(report.zip) });
await hostReports(reports);
}
function listLines(runs: SavedRun[], now = Date.now()): string[] {
if (!runs.length) return ["No saved runs yet. expo-explore capture:review reviews your branch on this machine, and its report is kept here."];
if (!runs.length) return ["No saved runs yet. expo-explore capture reviews your branch on this machine, and its report is kept here."];
const idWidth = Math.max(...runs.map(run => run.id.length));
return [...runs.map(run => `${run.id.padEnd(idWidth)} ${kindLabel(run).padEnd(9)}${runTitle(run)} (${run.platforms.join(", ")}, ${friendlyTime(run.createdAt, now)})`),
return [...runs.map(run => `${run.id.padEnd(idWidth)} ${kindLabel(run).padEnd(9)}${runTitle(run)} (${(run.targets?.map(target => target.id) ?? run.platforms).join(", ")}, ${friendlyTime(run.createdAt, now)})`),
"", "Open one with: expo-explore reports open <id>"];
}
@@ -204,7 +203,7 @@ export async function reports(): Promise<void> {
assertOneReview(read);
const review = read[0]!.summary.kind === "review" ? read[0]!.summary : undefined;
const head = review && commitSubject(process.cwd(), review.head), base = review && commitSubject(process.cwd(), review.base);
const run = await saveRun(read.map(report => ({ platform: report.summary.platform, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
const run = await saveRun(read.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
if (has("json")) output({ ok: true, run }); else console.log(`Kept ${runTitle(run)} as ${run.id}.`);
return;
}
+3 -2
View File
@@ -76,7 +76,8 @@ export function runTitle(run: SavedRun): string {
}
const PLATFORM_NAMES: Record<string, string> = { ios: "iOS", android: "Android" };
const platforms = (run: SavedRun) => run.platforms.map(platform => PLATFORM_NAMES[platform] ?? platform).join(" ");
// A run's targets by label, else its platforms by name, as runs saved before targets list them.
const platforms = (run: SavedRun) => run.targets?.map(target => target.label).join(", ") ?? run.platforms.map(platform => PLATFORM_NAMES[platform] ?? platform).join(" ");
/** The runs the list shows: this repository's (or all) that match the filter, across title, refs, subjects, SHAs and PR number. */
export function visibleRuns(state: PickerState): SavedRun[] {
@@ -129,7 +130,7 @@ export function renderPicker(state: PickerState, options: { width: number; heigh
if (!runs.length) {
const empty = state.runs.length
? [` ${paint.dim(state.filter ? `Nothing matches "${state.filter}".` : `No saved runs of ${state.repository}. Press tab for every repository.`)}`]
: [` ${paint.text("No saved runs yet.")}`, ` ${paint.dim("expo-explore capture:review reviews your branch on this machine, and its report is kept here.")}`];
: [` ${paint.text("No saved runs yet.")}`, ` ${paint.dim("expo-explore capture reviews your branch on this machine, and its report is kept here.")}`];
return [...header, ...empty, "", ...footer].map(line => fit(line, width));
}
const selected = runs[Math.min(state.selected, runs.length - 1)]!;
+1 -1
View File
@@ -2,7 +2,7 @@ import { CiError } from "../shared/ci-errors.js";
import type { CaptureSetupAction } from "./explore-config.js";
const TOKEN = /\{\{secret:([A-Z][A-Z0-9_]{0,127})\}\}/g;
const RESERVED = /^(?:GITHUB_|RUNNER_|ACTIONS_|AGENT_DEVICE_|OPENAI_|ANTHROPIC_|EXPO_TOKEN$)/;
const RESERVED = /^(?:GITHUB_|RUNNER_|ACTIONS_|AGENT_DEVICE_|ARGENT_|OPENAI_|ANTHROPIC_|EXPO_TOKEN$)/;
/** References are data, never shell expressions or arbitrary environment access. */
export function explorationSecretNames(text: string): string[] {
+214 -35
View File
@@ -1,3 +1,4 @@
import type { RunTarget } from "../types.js";
import { parseUnattributedSetting, type UnattributedSetting } from "../capture/unattributed.js";
import { parseAppearance, type AppearanceSetting } from "../capture/appearance.js";
import { parseLaunchSetting, type LaunchSetting } from "../capture/launch-capture.js";
@@ -43,27 +44,74 @@ export const DEFAULT_ANDROID_DEVICE = "pixel_7";
* One platform's capture target. `platforms.ios` fields default to the flat `app`/`device` fields;
* `platforms.android` needs its own package and EAS profile (an `android.buildType: apk` profile).
*/
/** The poses a foldable device can be captured in (`fold` in agent-device and Argent). */
export const DEVICE_POSES = ["closed", "half-open", "open"] as const;
export type DevicePose = typeof DEVICE_POSES[number];
export type PlatformConfig = { device?: string; bundleId?: string; easProfile?: string };
/**
* One named capture target (`targets.<id>`): a platform's device, optionally in a pose, captured as its own report.
* Several may share a platform, such as a phone and a foldable, or one foldable closed and open.
*/
export type TargetConfig = { platform: ExplorePlatform; device?: string; pose?: DevicePose; bundleId?: string; easProfile?: string; label?: string;
/** This target's device controller and simulator, over `capture.controller` and `capture.simulator`. */
controller?: "agent-device" | "argent"; simulator?: "eas" | "local" };
/**
* A target id names directories, report files, CI artifacts and URL parameters, so it is short and plain. `base` and
* `head` name a review's own directories.
*/
export const TARGET_ID_PATTERN = /^[a-z][a-z0-9-]{0,31}$/;
const RESERVED_TARGET_IDS = new Set(["base", "head", "report"]);
export function isTargetId(value: unknown): value is string {
return typeof value === "string" && TARGET_ID_PATTERN.test(value) && !RESERVED_TARGET_IDS.has(value) && !value.startsWith("install-");
}
/** Source discovery never consumes a user-authored screen inventory. */
export type ExploreConfig = {
mode: "deterministic" | "agent";
app: { name?: string; platform: ExplorePlatform; bundleId: string; easProfile: string; scheme?: string };
navigation: { provider: "auto" | "expo-router" | "react-navigation"; entry?: string };
device: { name: string };
/**
* `pose` folds a foldable (iPhone Duo) before capture: closed lights the outer display, open the inner one.
* Absent leaves the device as it starts (closed). It applies to the primary platform's device.
*/
device: { name: string; pose?: DevicePose };
/**
* Each platform Explore captures, in CI as one matrix job each. Absent: the single platform the
* flat fields describe. Capture code never reads this map; resolvePlatformConfig flattens it.
*/
platforms?: Partial<Record<ExplorePlatform, PlatformConfig>>;
/**
* Named capture targets, each captured and reported on its own, in this order. Instead of `platforms`, which is the
* same as one target per platform, named after it. Capture code never reads this map; resolveTargetConfig flattens it.
*/
targets?: Record<string, TargetConfig>;
/** Set on a config resolved for one target: the target it captures. */
target?: RunTarget;
/** `exclude` names routes, as `requiresRoute` does, that stay in the map but are never captured. */
exploration: { scope: "changes" | "all"; exclude?: string[] };
capture: { maxMinutes: number; maxActions: number; repack: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number };
capture: { maxMinutes: number; maxActions: number;
/**
* The most EAS Simulator sessions one review may run at once, across its targets and sides; absent:
* DEFAULT_MAX_SESSIONS (5). Below the number of targets, that many target jobs run at once, one session each.
*/
maxSessions?: number;
/** Where the route observer is bundled into the app, when the config chooses; captureRepack gives the default. */
repack?: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number;
/** The device controller; absent means agent-device, so configs that never chose one keep their cache recipes. */
controller?: "argent";
/** Where the app runs: EAS Simulator when absent, or `local`, a simulator Explore creates on this Mac for the run. */
simulator?: "local" };
parameters?: Record<string, Record<string, string>>;
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 } };
/**
* `trustedAuthors`: GitHub logins (e.g. `devin-ai-integration[bot]`) whose same-repository pull
* requests the review workflow captures although they lack write access. The workflow reads this
@@ -72,8 +120,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]/;
@@ -233,17 +289,20 @@ function parameters(value: unknown): Record<string, Record<string, string>> {
/** Validate and normalize plain data; credential validation is a separate execution gate. */
export function validateExploreConfig(value: unknown): ExploreConfig {
const root = record(value, "config");
exactKeys(root, ["mode", "app", "navigation", "device", "platforms", "exploration", "capture", "parameters", "setup", "agent", "report", "ci"], "config");
exactKeys(root, ["mode", "app", "navigation", "device", "platforms", "targets", "exploration", "capture", "parameters", "setup", "agent", "report", "ci"], "config");
const app = record(root.app, "app");
exactKeys(app, ["name", "platform", "bundleId", "easProfile", "scheme"], "app");
const device = record(root.device, "device");
exactKeys(device, ["name"], "device");
exactKeys(device, ["name", "pose"], "device");
const pose = device.pose === undefined ? undefined : literal(device.pose, DEVICE_POSES, "device.pose", "closed");
const navigation = optionalRecord(root.navigation, "navigation");
exactKeys(navigation, ["provider", "entry"], "navigation");
const exploration = optionalRecord(root.exploration, "exploration");
exactKeys(exploration, ["scope", "exclude"], "exploration");
const capture = optionalRecord(root.capture, "capture");
exactKeys(capture, ["maxMinutes", "maxActions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds"], "capture");
exactKeys(capture, ["maxMinutes", "maxActions", "maxSessions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
const controller = literal(capture.controller, ["agent-device", "argent"] as const, "capture.controller", "agent-device");
const simulator = literal(capture.simulator, ["eas", "local"] as const, "capture.simulator", "eas");
const mode = literal(root.mode, ["deterministic", "agent"] as const, "mode", "deterministic");
const name = optionalText(app.name, "app.name", 128);
const scheme = app.scheme === undefined ? undefined : customScheme(app.scheme, "app.scheme");
@@ -251,6 +310,8 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
const bundleId = applicationId(app.bundleId, "app.bundleId");
const easProfile = profileName(app.easProfile, "app.easProfile");
const platforms = platformsConfig(root.platforms, platform);
const targets = targetsConfig(root.targets, platform);
if (platforms && targets) fail("Use targets or platforms, not both", "targets", "Move each platforms entry into targets, with its platform.");
let agent: ExploreConfig["agent"];
if (root.agent !== undefined || mode === "agent") {
const input = record(root.agent, "agent");
@@ -276,8 +337,9 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
provider: literal(navigation.provider, ["auto", "expo-router", "react-navigation"] as const, "navigation.provider", "auto"),
...(navigation.entry === undefined ? {} : { entry: repoPath(navigation.entry, "navigation.entry") }),
},
device: { name: text(device.name, "device.name", 128) },
device: { name: text(device.name, "device.name", 128), ...(pose === undefined ? {} : { pose }) },
...(platforms === undefined ? {} : { platforms }),
...(targets === undefined ? {} : { targets }),
exploration: {
scope: literal(exploration.scope, ["changes", "all"] as const, "exploration.scope", "changes"),
...(exploration.exclude === undefined ? {} : { exclude: excludedRoutes(exploration.exclude) }),
@@ -285,12 +347,15 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
capture: {
maxMinutes: positiveInteger(capture.maxMinutes, "capture.maxMinutes", 30),
maxActions: positiveInteger(capture.maxActions, "capture.maxActions", 500),
repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack", "eas"),
...(capture.maxSessions === undefined ? {} : { maxSessions: positiveInteger(capture.maxSessions, "capture.maxSessions", 2) }),
...(capture.repack === undefined ? {} : { repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack") }),
appearance: parseAppearance(capture.appearance, "capture.appearance"),
launch: parseLaunchSetting(capture.launch, "capture.launch"),
reset: parseRouteResetSetting(capture.reset, "capture.reset"),
unattributed: parseUnattributedSetting(capture.unattributed, "capture.unattributed"),
...(capture.readinessSeconds !== undefined ? { readinessSeconds: positiveInteger(capture.readinessSeconds, "capture.readinessSeconds") } : {}),
...(controller === "argent" ? { controller } : {}),
...(simulator === "local" ? { simulator } : {}),
},
...(root.parameters === undefined ? {} : { parameters: parameters(root.parameters) }),
...(root.setup === undefined ? {} : { setup: setupActions(root.setup, scheme) }),
@@ -335,16 +400,108 @@ function platformsConfig(value: unknown, primary: ExplorePlatform): ExploreConfi
return result;
}
function targetsConfig(value: unknown, primary: ExplorePlatform): ExploreConfig["targets"] {
if (value === undefined) return undefined;
const mapping = record(value, "targets");
const ids = Object.keys(mapping);
if (!ids.length) fail("targets must name at least one target", "targets");
if (ids.length > 8) fail("targets can name at most 8 targets", "targets");
const result: NonNullable<ExploreConfig["targets"]> = {};
for (const id of ids) {
const label = `targets.${id}`;
if (!isTargetId(id)) fail(`${label}: a target id is lowercase letters, digits and dashes, starts with a letter, and is not base, head or report`, label);
const entry = record(mapping[id], label);
exactKeys(entry, ["platform", "device", "pose", "bundleId", "easProfile", "label", "controller", "simulator"], label);
const platform = literal(entry.platform, EXPLORE_PLATFORMS, `${label}.platform`);
const device = optionalText(entry.device, `${label}.device`, 128);
const pose = entry.pose === undefined ? undefined : literal(entry.pose, DEVICE_POSES, `${label}.pose`);
const bundleId = entry.bundleId === undefined ? undefined : applicationId(entry.bundleId, `${label}.bundleId`);
const easProfile = entry.easProfile === undefined ? undefined : profileName(entry.easProfile, `${label}.easProfile`);
const name = optionalText(entry.label, `${label}.label`, 64);
const controller = entry.controller === undefined ? undefined : literal(entry.controller, ["agent-device", "argent"] as const, `${label}.controller`);
const simulator = entry.simulator === undefined ? undefined : literal(entry.simulator, ["eas", "local"] as const, `${label}.simulator`);
if (platform !== primary && (bundleId === undefined || easProfile === undefined)) {
fail(`${label} needs bundleId and easProfile`, label,
`Set ${label}.bundleId to the app's ${platform === "android" ? "android.package" : "ios.bundleIdentifier"} and ${label}.easProfile to an eas.json profile that builds a ${platform === "android" ? "signed APK (android.buildType: apk)" : "simulator app (ios.simulator: true)"}.`);
}
result[id] = { platform, ...(device === undefined ? {} : { device }), ...(pose === undefined ? {} : { pose }), ...(bundleId === undefined ? {} : { bundleId }),
...(easProfile === undefined ? {} : { easProfile }), ...(name === undefined ? {} : { label: name }),
...(controller === undefined ? {} : { controller }), ...(simulator === undefined ? {} : { simulator }) };
}
return result;
}
/** The platforms a configuration captures, iOS first; the flat fields alone describe one. */
export function configPlatforms(config: ExploreConfig): ExplorePlatform[] {
if (config.targets) return EXPLORE_PLATFORMS.filter(platform => Object.values(config.targets!).some(target => target.platform === platform));
return config.platforms ? EXPLORE_PLATFORMS.filter(platform => config.platforms![platform] !== undefined) : [config.app.platform];
}
const PLATFORM_LABELS: Record<ExplorePlatform, string> = { ios: "iOS", android: "Android" };
/** The targets a configuration captures, in order: its `targets`, else one per platform, named after it. */
export function configTargets(config: ExploreConfig): RunTarget[] {
if (!config.targets) return configPlatforms(config).map(platform => ({ id: platform, platform, label: PLATFORM_LABELS[platform] }));
return Object.entries(config.targets).map(([id, target]) => ({ id, platform: target.platform,
label: target.label ?? `${target.device ?? (target.platform === config.app.platform ? config.device.name : DEFAULT_ANDROID_DEVICE)}${target.pose ? ` (${target.pose})` : ""}` }));
}
/** The targets with a device pose (foldables): they take the sessions `capture.maxSessions` does not divide evenly. */
export function posedTargets(config: ExploreConfig): string[] {
return Object.entries(config.targets ?? {}).filter(([, target]) => target.pose).map(([id]) => id);
}
/**
* The flat configuration capture consumes for one target, with `target` naming it. `--target` names one; `--platform`
* names the target of that platform, when only one has it; with neither, the config must have a single target.
*/
export function resolveTargetConfig(config: ExploreConfig, selection: { target?: string | undefined; platform?: ExplorePlatform | undefined } = {}): ExploreConfig {
const targets = configTargets(config);
if (!config.targets) {
if (selection.target !== undefined && !targets.some(target => target.id === selection.target)) throw targetNotConfigured(selection.target, targets);
const resolved = resolvePlatformConfig(config, (selection.target as ExplorePlatform | undefined) ?? selection.platform);
return { ...resolved, target: targets.find(target => target.platform === resolved.app.platform)! };
}
let chosen: RunTarget | undefined;
if (selection.target !== undefined) {
chosen = targets.find(target => target.id === selection.target);
if (!chosen) throw targetNotConfigured(selection.target, targets);
} else {
const candidates = selection.platform ? targets.filter(target => target.platform === selection.platform) : targets;
if (candidates.length !== 1) throw new CiError({ code: candidates.length ? "TARGET_REQUIRED" : "PLATFORM_NOT_CONFIGURED", stage: "preflight",
message: candidates.length ? `${DEFAULT_EXPLORE_CONFIG_PATH} lists ${candidates.map(target => target.id).join(", ")}; pass --target to select one.`
: `${DEFAULT_EXPLORE_CONFIG_PATH} has no ${selection.platform} target.`,
nextAction: "Run expo-explore setup --workflows to install the matrix workflows, which pass --target per job." });
chosen = candidates[0]!;
}
const entry = config.targets[chosen.id]!;
const primary = entry.platform === config.app.platform;
const { targets: _targets, platforms: _platforms, ...rest } = config;
void _targets; void _platforms;
// A target's own controller and simulator; agent-device and EAS Simulator are the defaults, which leave the config as it was.
const { controller: _controller, simulator: _simulator, ...capture } = config.capture;
void _controller; void _simulator;
const controller = entry.controller ?? config.capture.controller ?? "agent-device";
const simulator = entry.simulator ?? config.capture.simulator ?? "eas";
return { ...rest, target: chosen,
capture: { ...capture, ...(controller === "argent" ? { controller } : {}), ...(simulator === "local" ? { simulator } : {}) },
app: { ...config.app, platform: entry.platform, bundleId: entry.bundleId ?? config.app.bundleId, easProfile: entry.easProfile ?? config.app.easProfile },
device: { name: entry.device ?? (primary ? config.device.name : DEFAULT_ANDROID_DEVICE),
// A target's own pose; else the top-level one, which belongs to the primary platform's device.
...(entry.pose ? { pose: entry.pose } : primary && !entry.device && config.device.pose ? { pose: config.device.pose } : {}) } };
}
function targetNotConfigured(id: string, targets: RunTarget[]): CiError {
return new CiError({ code: "TARGET_NOT_CONFIGURED", stage: "preflight", message: `${DEFAULT_EXPLORE_CONFIG_PATH} has no target ${id}.`,
nextAction: `Capture one of: ${targets.map(target => target.id).join(", ")}.` });
}
/**
* The flat configuration capture consumes for one platform: `app.platform`, `app.bundleId`,
* `app.easProfile`, and `device.name` describe that platform; everything else is shared.
*/
export function resolvePlatformConfig(config: ExploreConfig, platform: ExplorePlatform | undefined): ExploreConfig {
if (config.targets) return resolveTargetConfig(config, { platform });
const platforms = configPlatforms(config);
if (platform === undefined) {
if (platforms.length > 1) throw new CiError({ code: "PLATFORM_REQUIRED", stage: "preflight",
@@ -362,38 +519,45 @@ export function resolvePlatformConfig(config: ExploreConfig, platform: ExplorePl
return { ...rest,
app: { ...config.app, platform, bundleId: entry.bundleId ?? (primary ? config.app.bundleId : fail(`platforms.${platform}.bundleId is required`)),
easProfile: entry.easProfile ?? (primary ? config.app.easProfile : fail(`platforms.${platform}.easProfile is required`)) },
device: { name: entry.device ?? (primary ? config.device.name : platform === "android" ? DEFAULT_ANDROID_DEVICE : config.device.name) } };
device: { name: entry.device ?? (primary ? config.device.name : platform === "android" ? DEFAULT_ANDROID_DEVICE : config.device.name),
// A pose belongs to the primary platform's device; the other platform's device starts as it is.
...(primary && config.device.pose ? { pose: config.device.pose } : {}) } };
}
/**
* 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 }): ExploreConfig {
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;
if (overrides.repack !== undefined) {
if (overrides.repack !== "eas" && overrides.repack !== "local") fail("--repack must be eas or local", "--repack");
result = { ...result, capture: { ...result.capture, repack: overrides.repack } };
}
if (overrides.controller !== undefined) {
if (overrides.controller !== "agent-device" && overrides.controller !== "argent") fail("--controller must be agent-device or argent", "--controller");
const { controller: _previous, ...capture } = result.capture;
result = { ...result, capture: { ...capture, ...(overrides.controller === "argent" ? { controller: "argent" as const } : {}) } };
}
if (overrides.simulator !== undefined) {
if (overrides.simulator !== "eas" && overrides.simulator !== "local") fail("--simulator must be eas or local", "--simulator");
const { simulator: _previous, ...capture } = result.capture;
result = { ...result, capture: { ...capture, ...(overrides.simulator === "local" ? { simulator: "local" as const } : {}) } };
}
if (overrides.scope !== undefined) {
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;
}
/** `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;
/**
* Where a capture repacks the app with the route observer: the config's choice, else on this machine when the app runs on
* a local simulator (which already needs Xcode or the Android SDK), and in a hosted EAS job otherwise.
*/
export function captureRepack(config: ExploreConfig): "eas" | "local" {
return config.capture.repack ?? (config.capture.simulator === "local" ? "local" : "eas");
}
const GITHUB_LOGIN = /^[A-Za-z0-9](?:[A-Za-z0-9]|-(?=[A-Za-z0-9])){0,38}(?:\[bot\])?$/;
@@ -428,9 +592,23 @@ function trustedAuthorList(value: unknown): string[] {
function reportConfig(value: unknown): ExploreConfig["report"] {
if (value === undefined) return undefined;
const report = record(value, "report");
exactKeys(report, ["preview"], "report");
if (report.preview === undefined) return {};
const preview = record(report.preview, "report.preview");
exactKeys(report, ["preview", "comment"], "report");
const comment = commentConfig(report.comment);
const preview = previewConfig(report.preview);
return { ...(preview ? { preview } : {}), ...(comment ? { comment } : {}) };
}
function commentConfig(value: unknown): NonNullable<ExploreConfig["report"]>["comment"] {
if (value === undefined) return undefined;
const comment = record(value, "report.comment");
exactKeys(comment, ["map"], "report.comment");
if (typeof comment.map !== "boolean") fail("report.comment.map must be true or false", "report.comment.map");
return { map: comment.map };
}
function previewConfig(value: unknown): NonNullable<ExploreConfig["report"]>["preview"] {
if (value === undefined) return undefined;
const preview = record(value, "report.preview");
exactKeys(preview, ["hosting", "expiresAfter", "owner", "project"], "report.preview");
const owner = optionalText(preview.owner, "report.preview.owner", 64);
if (owner !== undefined && !/^[a-z0-9][a-z0-9_-]*$/.test(owner)) {
@@ -440,12 +618,13 @@ function reportConfig(value: unknown): ExploreConfig["report"] {
if (project !== undefined && !/^[a-z0-9][a-z0-9-]*[a-z0-9]$/.test(project)) {
fail("report.preview.project must be a lowercase EAS project slug", "report.preview.project");
}
return { preview: {
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 }),
} };
};
}
/**
+15 -2
View File
@@ -4,7 +4,7 @@ import { dirname, join, resolve } from "node:path";
import { createInterface } from "node:readline/promises";
import { fileURLToPath } from "node:url";
import { stringify } from "yaml";
import { DEFAULT_EXPLORE_CONFIG_PATH, readExploreConfig, validateExploreConfig, type ExploreConfig } from "./explore-config.js";
import { DEFAULT_EXPLORE_CONFIG_PATH, readExploreConfig, validateExploreConfig, type ExploreConfig, type ExplorePlatform } from "./explore-config.js";
import { explorationSecretNames } from "./exploration-inputs.js";
import type { RouteEntryReport } from "../ci/route-entry.js";
import type { CiInstallResult } from "../ci/workflow-install.js";
@@ -60,6 +60,8 @@ type SetupOptions = {
appState?: string | undefined;
workflows?: boolean | undefined;
nonInteractive?: boolean;
/** Return the config without writing anything. */
dryRun?: boolean;
check?: boolean;
};
type Interaction = {
@@ -234,6 +236,14 @@ export type SetupResult = {
nextSteps?: string[];
};
/**
* The config `setup --non-interactive` would write, without writing it: what a local review runs with in an app that
* has no config yet. Throws setup's errors when the app cannot be built for capture.
*/
export async function defaultExploreConfig(project: string, platform?: ExplorePlatform): Promise<ExploreConfig> {
return (await runExploreSetup({ project, platform, nonInteractive: true, dryRun: true })).config;
}
/**
* The guided setup. It writes what it can derive (app identity, mode, route parameters it was given,
* an agent-instructions draft, CI files) and hands the app-specific flows to the user's coding agent.
@@ -290,7 +300,9 @@ export async function runExploreSetup(options: SetupOptions = {}, interaction?:
}
const schemes = Array.isArray(app.scheme) ? app.scheme.filter((value): value is string => typeof value === "string") : undefined;
const scheme = await choose("URL scheme (optional)", options.scheme, schemes?.[0] ?? string(app.scheme), schemes);
const profile = await choose(platform === "android" ? "EAS emulator (APK) build profile" : "EAS simulator build profile", options.profile, profiles.length === 1 ? profiles[0]! : "", profiles);
const profile = await choose(platform === "android" ? "EAS emulator (APK) build profile" : "EAS simulator build profile", options.profile,
// With several, the one named explore, the name the README and the explore-setup skill give it.
profiles.length === 1 ? profiles[0]! : profiles.includes("explore") ? "explore" : "", profiles);
if (!profiles.includes(profile)) throw new Error(`Choose ${platform === "android" ? "an Android APK" : "a simulator"} profile from eas.json with --profile: ${profiles.join(", ")}.`);
const inferredProvider = dependencies["expo-router"] ? "expo-router" : dependencies["@react-navigation/native"] ? "react-navigation" : "auto";
const provider = await choose("Navigation provider", options.navigation, inferredProvider, ["auto", "expo-router", "react-navigation"]);
@@ -390,6 +402,7 @@ export async function runExploreSetup(options: SetupOptions = {}, interaction?:
const answer = await ui!.ask("Write this config? (yes/no)", "yes");
if (!/^(y|yes)$/i.test(answer.trim())) throw new Error("Setup canceled; no config was written.");
}
if (options.dryRun) return { path, config, created: false };
await mkdir(parent, { recursive: true });
await writeFile(path, yaml, { flag: "wx" });
if (instructions) await writeFile(instructionsPath, instructions, { flag: "wx" });
+72 -4
View File
@@ -1,3 +1,4 @@
import type { RunTarget } from "../types.js";
import { validateSourceRoutes, type SourceRoute } from "./source-route.js";
import type { SourceCapturePlan, SurfaceSourceScope } from "../source/capture-plan.js";
import type { ReviewPresentation } from "./review.js";
@@ -73,6 +74,8 @@ export type CaptureBundle = {
/** Execution completion time, recorded even when no routes require screenshots. */
completedAt?: string;
appName?: string;
/** The device controller that drove the capture; absent for agent-device, the default. */
controller?: "argent";
/** The icon the app config declares, shrunk to at most 128 pixels; absent when unavailable. */
appIcon?: Omit<AppIconImage, "url"> & { path: string };
profile: string; selectedSurfaceIds: string[];
@@ -141,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"];
}
@@ -161,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";
@@ -172,12 +218,24 @@ export type PublicVisualVerdict = {
rect: { x: number; y: number; width: number; height: number };
normalizedRect: { x: number; y: number; width: number; height: number };
differentPixels: number; shareOfDiffPercentage: number; dominantChange: string; location: string;
/**
* Set when the region's content is the same in both screenshots, only moved: how far, in screenshot pixels
* (right and down are positive). Absent when the content itself changed.
*/
shift?: { x: number; y: number };
}>;
tool: string;
/** Diff regions inside the iOS status-bar band that were excluded from the verdict. */
/**
* Every region the comparison found (not only the published ones) only moved: nothing on the screen changed
* content. Absent when any region changed, or moves were not measured.
*/
allRegionsMoved?: true;
/** Diff regions inside the 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
@@ -228,13 +286,21 @@ export type PublicReview = {
appIcon?: AppIconImage;
/** Absent in reports published before Android support: iOS. */
platform?: "ios" | "android";
/** The device controller that drove the head capture; absent for agent-device, the default. */
controller?: "argent";
device?: { model: string; osVersion: string };
/** The share of each screenshot's height the verdict ignored as the status bar. */
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. */
target?: RunTarget;
/** Every target the config captures, in config order, when more than one: the sibling reports of the same run. */
targets?: RunTarget[];
/** Every appearance the capture rendered, primary first, when it rendered several; surfaces then carry their `colorScheme`. */
colorSchemes?: Array<"light" | "dark">;
};
@@ -258,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 {
+21 -1
View File
@@ -75,13 +75,29 @@ function assertReviewFields(surface: Surface, enforceComparisonEvidence: boolean
}
}
/**
* 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) <= MAX_SHIFT && Math.abs(y) <= MAX_SHIFT;
}
function assertVisualVerdict(visual: PublicVisualVerdict, enforceComparisonEvidence: boolean, paired: boolean): void {
if (!visual || typeof visual !== "object" || !VISUAL_VERDICTS.has(visual.verdict)
|| typeof visual.reason !== "string" || (enforceComparisonEvidence && visual.reason === "diff-failed") || typeof visual.tool !== "string"
|| typeof visual.threshold !== "number" || !Number.isFinite(visual.threshold)
|| (visual.mismatchPercentage !== undefined
&& (typeof visual.mismatchPercentage !== "number" || !Number.isFinite(visual.mismatchPercentage) || visual.mismatchPercentage < 0))
|| (visual.regions !== undefined && (!Array.isArray(visual.regions) || visual.regions.length > 64))
|| (visual.regions !== undefined && (!Array.isArray(visual.regions) || visual.regions.length > 64
|| visual.regions.some(region => region?.shift !== undefined && !validShift(region.shift))))
|| (visual.allRegionsMoved !== undefined && (visual.allRegionsMoved !== true || !visual.regions?.length
|| visual.regions.some(region => region.shift === undefined)))
|| !paired) {
throw new Error("Public visual verdict is inconsistent");
}
@@ -335,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) {
+85 -24
View File
@@ -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 = {
@@ -60,18 +77,51 @@ export type AgentContext = {
pageUrl: string;
/** This report's platform when the deployment serves several, so links keep `?platform=`. */
platform?: string | undefined;
/** The distinct platforms the deployment serves. */
platforms: string[];
/** This report's target id when the deployment serves several targets, so links keep selecting it. */
target?: string | undefined;
/** Every target the deployment serves, in config order; absent from contexts that predate targets. */
targets?: AgentTarget[] | undefined;
expiresAt: string | null;
};
export type AgentTarget = { id: string; platform: string; label?: string | undefined };
/**
* The query parameter that keeps a link on this report: `target=<id>`, or `platform=<id>` for a target named after its
* platform (as links were before targets), or the platform alone in contexts that predate targets.
*/
function selection(context: AgentContext): [string, string] | undefined {
if (context.target && (context.targets?.length ?? 0) > 1) return [context.target === "ios" || context.target === "android" ? "platform" : "target", context.target];
return context.platform && context.platforms.length > 1 ? ["platform", context.platform] : undefined;
}
/** The same page for another target of the deployment. */
function targetPageUrl(context: AgentContext, id: string): string {
return viewerUrl({ ...context, target: id }, {});
}
const apiUrl = (context: AgentContext, path = "") => `${context.pageUrl}/api/${AGENT_API_VERSION}${path}`;
function viewerUrl(context: AgentContext, params: Record<string, string> = {}): string {
const url = new URL(context.pageUrl);
if (context.platform && context.platforms.length > 1) url.searchParams.set("platform", context.platform);
const selected = selection(context);
if (selected) url.searchParams.set(...selected);
for (const [key, value] of Object.entries(params)) url.searchParams.set(key, value);
return url.href;
}
const withPlatform = (context: AgentContext, url: string) => (context.platform && context.platforms.length > 1 ? `${url}${url.includes("?") ? "&" : "?"}platform=${context.platform}` : url);
const withPlatform = (context: AgentContext, url: string) => {
const selected = selection(context);
return selected ? `${url}${url.includes("?") ? "&" : "?"}${selected[0]}=${selected[1]}` : url;
};
/** The targets as the summary lists them: each with its label and Viewer link, this one marked. */
function targetList(context: AgentContext): Json[] | undefined {
if (!context.targets || context.targets.length < 2) return undefined;
return context.targets.map(target => defined({ id: target.id, platform: target.platform, label: target.label, current: target.id === context.target ? true : undefined,
viewer: targetPageUrl(context, target.id), summary: `${apiUrl(context)}?${new URLSearchParams([selection({ ...context, target: target.id })!]).toString()}` }));
}
/** What the index title names this report by: the target's label when the deployment serves several. */
function targetLabel(context: AgentContext): string | undefined {
return (context.targets?.length ?? 0) > 1 ? context.targets!.find(target => target.id === context.target)?.label ?? context.target : undefined;
}
type Page<T> = { items: T[]; total: number; count: number; hasMore: boolean; nextCursor?: string };
function page<T>(items: T[], params: URLSearchParams): Page<T> | undefined {
@@ -126,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 {
@@ -144,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";
@@ -156,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 {
@@ -177,7 +230,7 @@ function reviewSummary(context: AgentContext, review: Json): Json {
kind: "pr-review", api: AGENT_API_VERSION, contract: str(review.contract),
pullRequest: defined({ origin: str(pr.origin), repository: str(pr.repository), number: num(pr.number), title: str(pr.title), url: str(pr.url), head: str(rec(pr.head).sha), base: str(rec(pr.base).sha) }),
app: defined({ name: str(runtime.appName), version: str(runtime.appVersion), build: str(runtime.appBuildNumber), platform: str(runtime.platform) ?? context.platform, device: rec(runtime.device).model === undefined ? undefined : `${str(rec(runtime.device).model)} ${str(rec(runtime.device).osVersion) ?? ""}`.trim() }),
createdAt: str(review.createdAt), mode: str(review.mode), platforms: context.platforms, expiresAt: context.expiresAt,
createdAt: str(review.createdAt), mode: str(review.mode), platforms: context.platforms, target: context.target, targets: targetList(context), expiresAt: context.expiresAt,
screens: { total: surfaces.length, ...counts },
links: {
screens: withPlatform(context, apiUrl(context, "/screens")), changed: withPlatform(context, apiUrl(context, "/screens?status=modified,accessibility-only,added,removed")),
@@ -237,7 +290,7 @@ function explorationSummary(context: AgentContext, report: Json): Json {
kind: "exploration", api: AGENT_API_VERSION, contract: str(map.contract),
app: defined({ name: str(app.name), bundleId: str(app.bundleId), platform: str(app.platform) ?? context.platform, version: str(app.version), build: str(app.buildNumber), device: device.model === undefined ? undefined : `${str(device.model)} ${str(device.osVersion) ?? ""}`.trim() }),
startedAt: str(exploration.startedAt), completedAt: str(exploration.completedAt), stopReason: str(exploration.stopReason), summary: str(exploration.summary),
model: str(rec(exploration.model).model), platforms: context.platforms, expiresAt: context.expiresAt,
model: str(rec(exploration.model).model), platforms: context.platforms, target: context.target, targets: targetList(context), expiresAt: context.expiresAt,
screens: { total: screens.length, coverage: Object.keys(coverage).length ? coverage : undefined },
counts: { transitions: arr(map.transitions).length, elements: arr(map.elements).length, journeys: arr(map.journeys).length, gaps: arr(map.gaps).length, frontier: arr(map.frontier).length },
links: {
@@ -258,12 +311,14 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
const links = rec(summary.links) as Record<string, string>;
const app = rec(summary.app), screens = rec(summary.screens);
const lines: string[] = [];
const label = targetLabel(context);
const titled = (platform: unknown) => (label ? ` (${escapeMd(label)})` : platform ? ` (${escapeMd(platform)})` : "");
if (loaded.kind === "pr-review") {
const pr = rec(summary.pullRequest);
// A comparison of two commits has a title ("v1.4.0 vs v1.3.0") where a pull request has a number.
// A comparison of two commits, or a local review on someone's machine, has no pull request: its title names both refs.
const compared = pr.origin === "compare" || pr.origin === "local";
lines.push(`# Expo Explore report: ${escapeMd(app.name ?? pr.repository)} ${compared ? escapeMd(pr.title) : `PR #${escapeMd(pr.number)}`}${app.platform ? ` (${escapeMd(app.platform)})` : ""}`, "",
lines.push(`# Expo Explore report: ${escapeMd(app.name ?? pr.repository)} ${compared ? escapeMd(pr.title) : `PR #${escapeMd(pr.number)}`}${titled(app.platform)}`, "",
`> Visual review of ${compared ? `${escapeMd(pr.repository)} ${escapeMd(pr.title)}` : `pull request ${escapeMd(pr.repository)}#${escapeMd(pr.number)}`} by Expo Explore. ${screens.total} screens: ${screenCounts(screens)}.${context.expiresAt ? ` This link stops serving the report after ${context.expiresAt}.` : ""}`, "",
"This URL is the human Viewer. The same report is available as read-only JSON (no credentials beyond this URL):", "",
`- [Summary](${links.summary ?? withPlatform(context, apiUrl(context))}): kind, counts by status, app and PR identity, links`,
@@ -275,7 +330,7 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
`Start with the changed screens. Every item carries a \`viewerUrl\` that opens that screen in the Viewer for a human; [${escapeMd(links.viewerChanges)}](${links.viewerChanges}) opens the list of changes.`);
} else {
const counts = rec(summary.counts);
lines.push(`# Expo Explore exploration: ${escapeMd(app.name)}${app.platform ? ` (${escapeMd(app.platform)})` : ""}`, "",
lines.push(`# Expo Explore exploration: ${escapeMd(app.name)}${titled(app.platform)}`, "",
`> An agent explored ${escapeMd(app.name)} ${escapeMd(app.version ?? "")} on ${escapeMd(app.device ?? app.platform)} and mapped ${screens.total} screens, ${counts.transitions} transitions, ${counts.elements} elements; ${counts.gaps} coverage gaps. Stopped: ${escapeMd(summary.stopReason)}.${summary.summary ? ` ${escapeMd(summary.summary)}` : ""}${context.expiresAt ? ` This link stops serving the report after ${context.expiresAt}.` : ""}`, "",
"This URL is the human Viewer. The same map is available as read-only JSON (no credentials beyond this URL):", "",
`- [Summary](${withPlatform(context, apiUrl(context))}): app, device, model, stop reason, counts, links`,
@@ -287,6 +342,11 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
`- [Raw exploration.json](${links.raw}): the full map contract`, "",
"Start with the screens list, then open the screens you care about. Every item carries a `viewerUrl` that opens it in the Viewer for a human.");
}
const others = (context.targets ?? []).filter(target => target.id !== context.target);
if (label && others.length) {
lines.push("", `This link also serves the same run's other targets; each has its own index and JSON API:`, "",
...others.map(target => `- [${escapeMd(target.label ?? target.id).replace(/[[\]]/g, "")}](${targetPageUrl(context, target.id)}) (${escapeMd(target.platform)})`));
}
return lines.join("\n") + "\n";
}
@@ -425,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) } };
}
+37 -14
View File
@@ -6,7 +6,7 @@ import { createHash } from "node:crypto";
import type { ArtifactReport } from "../contracts/artifact-report.js";
import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPresentation } from "../contracts/review.js";
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
import type { ExplorePlatform } from "../config/explore-config.js";
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
import { upsertStickyComment } from "./pr-comment.js";
import { previewLinks, viewerLinks } from "./viewer-links.js";
import type { PublicReview } from "../contracts/capture.js";
@@ -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");
@@ -112,10 +114,23 @@ async function exportCiReportUnchecked(options: { inputPath: string; outputPath:
}
/**
* The suffix of this matrix job's artifacts: `--target`, else for a `--platform` caller the captured target when it
* has that platform (its id is the platform for a config without targets), else nothing (a workflow without a matrix).
*/
function reportTarget(options: { target?: string; platform?: ExplorePlatform }, state: PublicCommentState): string | undefined {
const target = options.target ?? (options.platform && state.target?.platform === options.platform ? state.target.id : options.platform);
if (target !== undefined && !isTargetId(target)) throw new CiError({ code: "TARGET_INVALID", stage: "preflight", message: `${target} is not a target id.`,
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
return target;
}
/** Finalize only an uploaded artifact from this run while the captured PR is still current. */
export async function publishCiReportComment(options: {
inputPath: string; artifactUrl: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
/** Set by the matrix workflows: the artifact carries the platform suffix and the comment gets one section per platform. */
/** Set by the matrix workflows: the artifact carries the target suffix and the comment gets one section per target. */
target?: string;
/** What callers from before targets pass: the platform of the captured target, whose id then names the artifact. */
platform?: ExplorePlatform;
/** A verified hosted preview from `ci:deploy`; the comment then links to it as Explore report. */
preview?: { url: string; expiresAt: number | null };
@@ -135,10 +150,11 @@ export async function publishCiReportComment(options: {
nextAction: "Publish the report-input.json produced by this repository's current workflow run and attempt." });
}
if (pr.origin === "local") throw new Error("Local reports cannot be published as GitHub PR comments");
const target = reportTarget(options, input.commentState);
const links = viewerLinks({ repository: pr.repository, headSha: pr.head.sha, runId: review.runId,
runAttempt: review.runAttempt, configPath: input.commentState.configPath, artifactUrl: options.artifactUrl,
...(options.platform ? { platform: options.platform } : {}) });
if (options.preview) links.preview = previewLinks(options.preview.url, options.preview.expiresAt, options.platform);
...(target ? { target } : {}) });
if (options.preview) links.preview = previewLinks(options.preview.url, options.preview.expiresAt, target);
else if (input.preview && !options.previewFailed) links.deploying = true;
const api = async (path: string) => {
let response: Response;
@@ -171,7 +187,7 @@ export async function publishCiReportComment(options: {
message: "GitHub returned invalid report metadata.", nextAction: "Rerun publication; if the response remains invalid, inspect the GitHub metadata request.", cause: error }); }
};
const artifact = await api(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${options.platform ? `-${options.platform}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${target ? `-${target}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
throw new CiError({ code: artifact.expired ? "REPORT_ARTIFACT_EXPIRED" : "REPORT_ARTIFACT_MISMATCH", stage: "publication",
message: "The uploaded report artifact is unavailable or belongs to another run",
nextAction: artifact.expired ? "Rerun Explore to upload a fresh report artifact." : "Pass the final report artifact from this workflow run and attempt." });
@@ -188,9 +204,9 @@ export async function publishCiReportComment(options: {
const superseded = current.head?.sha !== pr.head.sha || current.base?.sha !== pr.base.sha;
const state: PublicCommentState = { ...input.commentState, phase: "ready", updatedAt: Date.now(),
review, links, artifactOnly: true, ...(superseded ? { superseded: true } : {}) };
const body = renderPublicComment(state);
const body = renderPublicComment(state, undefined, target);
let previousBody: string | undefined;
try { previousBody = (await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, options.platform),
try { previousBody = (await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, target),
token: environment.GITHUB_TOKEN, fetchImpl: transport })).previousBody; }
catch (error) { throw toCiError(error, { code: "COMMENT_PUBLICATION_FAILED", stage: "publication",
nextAction: "Grant the GitHub token PR comment write permission and retry publication for the current PR head." }); }
@@ -200,9 +216,9 @@ export async function publishCiReportComment(options: {
/**
* A comparison has no pull request to comment on: `ci:publish` links its report from the run summary instead,
* with the same Open (central Viewer) and zip links a PR comment carries for this platform.
* with the same Open (central Viewer) and zip links a PR comment carries for this target, labelled as the comment labels it.
*/
async function publishCompareSummary(input: CiReportInput, options: { artifactUrl: string; platform?: ExplorePlatform }, environment: NodeJS.ProcessEnv) {
async function publishCompareSummary(input: CiReportInput, options: { artifactUrl: string; target?: string; platform?: ExplorePlatform }, environment: NodeJS.ProcessEnv) {
const review = input.publicReview; const comparison = review.pullRequest as CompareReviewPresentation;
if (review.runId !== environment.GITHUB_RUN_ID || review.runAttempt !== environment.GITHUB_RUN_ATTEMPT
|| (environment.GITHUB_REPOSITORY && environment.GITHUB_REPOSITORY !== comparison.repository)) {
@@ -210,14 +226,21 @@ async function publishCompareSummary(input: CiReportInput, options: { artifactUr
message: "Report input is not from the current repository run and attempt",
nextAction: "Publish the report-input.json produced by this repository's current workflow run and attempt." });
}
const target = reportTarget(options, input.commentState);
const links = viewerLinks({ repository: comparison.repository, headSha: comparison.head.sha, runId: review.runId,
runAttempt: review.runAttempt, configPath: input.commentState.configPath, artifactUrl: options.artifactUrl,
...(options.platform ? { platform: options.platform } : {}) });
...(target ? { target } : {}) });
const changes = input.commentState.review ?? review;
const count = reviewChangeCount({ review: changes }) ?? 0;
const platform = (options.platform ?? review.runtime.platform) === "android" ? "Android" : "iOS";
const label = summaryText(input.commentState.target?.label ?? review.runtime.target?.label
?? ((options.platform ?? review.runtime.platform) === "android" ? "Android" : "iOS"));
if (environment.GITHUB_STEP_SUMMARY) {
await appendFile(environment.GITHUB_STEP_SUMMARY, `- ${platform} report of ${compareTitleMarkdown(comparison)}: [Open](${links.viewer!.open}) · [zip](${links.download!}) · ${count} ${count === 1 ? "change" : "changes"}\n`);
await appendFile(environment.GITHUB_STEP_SUMMARY, `- ${label} report of ${compareTitleMarkdown(comparison)}: [Open](${links.viewer!.open}) · [zip](${links.download!}) · ${count} ${count === 1 ? "change" : "changes"}\n`);
}
return { artifactUrl: links.viewer!.open, headSha: comparison.head.sha };
}
/** A config-authored label as plain Markdown text on one line. */
function summaryText(value: string): string {
return value.replace(/[\u0000-\u001f\u007f]+/g, " ").replace(/[\\`*_{}[\]()#+!|<>~]/g, "\\$&").trim().slice(0, 80);
}
+28 -15
View File
@@ -4,7 +4,7 @@ import { CiError } from "../shared/ci-errors.js";
import { renderPublicComment, platformSectionMerge, type PublicCommentState } from "./pr-comment-body.js";
import { upsertStickyComment } from "./pr-comment.js";
import { viewerLinks } from "./viewer-links.js";
import type { ExplorePlatform } from "../config/explore-config.js";
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
export type FailureCommentOptions = {
repository: string;
@@ -15,6 +15,9 @@ export type FailureCommentOptions = {
runAttempt: string;
/** The directory the failure job downloaded diagnostics artifacts into (`<stage>/<artifact>/…/error.json`). */
diagnosticsPath?: string;
/** The failed target's id; otherwise the one the first diagnostics artifact's name carries. */
target?: string;
/** What callers from before targets pass: a platform is the id of its default target. */
platform?: ExplorePlatform;
configPath?: string;
environment?: NodeJS.ProcessEnv;
@@ -23,7 +26,9 @@ export type FailureCommentOptions = {
type Diagnostic = { code: string; stage: string; message: string; nextAction: string };
const SHA = /^[0-9a-f]{40}$/;
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-(ios|android)$/;
// `explore-<kind>-<run>-<attempt>-<target>`: the kind has no digits, so the first number is the run and the rest is the target id.
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
const artifactTarget = (name: string): string | undefined => { const id = ARTIFACT_DIR.exec(name)?.[1]; return isTargetId(id) ? id : undefined; };
const MAX_DIAGNOSTIC_BYTES = 32_768;
const CODE = /^[A-Z][A-Z0-9_]{1,63}$/;
@@ -42,21 +47,23 @@ function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
}
/**
* The error.json a failed job left behind and the platform its artifact name carries. A report failure's
* diagnostic takes precedence over capture's; a present but unreadable file yields the generic failure
* rather than an earlier stage's error, and only regular files count (never symlinks out of the artifact).
* The error.json a failed job left behind and the target its artifact name carries (`ios` or `android` for a config
* without targets, and for artifacts of versions before targets). A report failure's diagnostic takes precedence over
* capture's; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
* regular files count (never symlinks out of the artifact). `platform` is set when the target id is a platform's.
*/
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; platform: ExplorePlatform } | undefined> {
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; target: string; platform?: ExplorePlatform } | undefined> {
for (const [stage, file] of [["report", "error.json"], ["capture", join("explore-diagnostics", "error.json")]] as const) {
const entries = await readdir(join(root, stage), { withFileTypes: true }).catch(() => []);
for (const entry of entries.filter(entry => entry.isDirectory() && ARTIFACT_DIR.test(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
for (const entry of entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
const path = join(root, stage, entry.name, file);
const info = await lstat(path).catch(() => undefined);
if (!info) continue;
const platform = ARTIFACT_DIR.exec(entry.name)![1] as ExplorePlatform;
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return { platform };
const target = artifactTarget(entry.name)!;
const located: { target: string; platform?: ExplorePlatform } = { target, ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) };
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located;
const diagnostic = parseDiagnostic(await readFile(path, "utf8"), stage);
return diagnostic ? { diagnostic, platform } : { platform };
return diagnostic ? { diagnostic, ...located } : located;
}
}
return undefined;
@@ -64,7 +71,7 @@ export async function locateFailureDiagnostic(root: string): Promise<{ diagnosti
/**
* The failure job's comment: a job died outside Explore's own progress comments (install, checkout, a crash
* before the pipeline posted), so the sticky comment gets a failed record for that platform from the same
* before the pipeline posted), so the sticky comment gets a failed record for that target from the same
* renderer every other writer uses. Nothing is posted when the PR is closed; a PR that moved on is marked
* superseded so the failure lands under previous runs.
*/
@@ -75,6 +82,9 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
if (!token) throw new CiError({ code: "GITHUB_TOKEN_MISSING", stage: "publication", message: "GITHUB_TOKEN is required to post the failure comment",
nextAction: "Pass GITHUB_TOKEN to the failure job with PR comment write permission." });
if (!SHA.test(options.headSha) || !SHA.test(options.baseSha)) return { posted: false, reason: "The capture job did not record the PR head and base." };
const requested = options.target ?? options.platform;
if (requested !== undefined && !isTargetId(requested)) throw new CiError({ code: "TARGET_INVALID", stage: "publication", message: `${requested} is not a target id.`,
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
const response = await transport(`https://api.github.com/repos/${options.repository}/pulls/${options.pullNumber}`, {
headers: { authorization: `Bearer ${token}`, accept: "application/vnd.github+json" }, redirect: "error", signal: AbortSignal.timeout(15_000) });
if (!response.ok) throw new CiError({ code: "GITHUB_REQUEST_FAILED", stage: "publication", message: `GitHub PR lookup failed (${response.status})`,
@@ -85,7 +95,9 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
}
const superseded = pr.head?.sha !== options.headSha || pr.base?.sha !== options.baseSha;
const located = options.diagnosticsPath ? await locateFailureDiagnostic(options.diagnosticsPath) : undefined;
const platform = options.platform ?? located?.platform;
const target = requested ?? located?.target;
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
const configPath = options.configPath ?? ".expo-explore/config.yaml";
const now = Date.now();
const diagnostic = located?.diagnostic;
@@ -93,7 +105,8 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath, ...(platform ? { platform } : {}) }),
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
startedAt: now, updatedAt: now, artifactOnly: true,
...(platform ? { build: { platform, easProfile: "" } } : {}),
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
@@ -101,7 +114,7 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
...(superseded ? { superseded: true } : {}),
};
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state),
...platformSectionMerge(state, platform), token, fetchImpl: transport });
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
...platformSectionMerge(state, target), token, fetchImpl: transport });
return { posted: true, ...(superseded ? { superseded: true } : {}) };
}
+38 -8
View File
@@ -4,16 +4,21 @@ import { createServer, type Server } from "node:http";
import { extname, resolve, sep } from "node:path";
import { fileURLToPath } from "node:url";
import type { ExplorePlatform } from "../config/explore-config.js";
import type { RunTarget } from "../types.js";
import { reportTarget } from "./saved-runs.js";
import { AGENT_API_VERSION, agentApiReply, agentIndexMarkdown, loadReport, prefersHtml, type AgentContext, type LoadedReport } from "./agent-api.js";
import { manifestBody, previewAsset } from "./preview-manifest.js";
/**
* Serve review reports on this machine the way a hosted report serves them: the built Viewer at `/p/<token>`, each
* platform's report at `/p/<token>/report.zip?platform=…`, and the platform list at `/p/<token>/reports.json`. The
* Viewer already knows this layout, so nothing in it changes. An agent on this machine gets what it gets from a hosted
* target's manifest at `/p/<token>/manifest.json?target=…` (or `?platform=…`) and its assets at
* `/p/<token>/assets/<sha256>.<ext>`, the whole ZIP at `/p/<token>/report.zip`, and the list at `/p/<token>/reports.json`.
* The Viewer already knows this layout, so nothing in it changes. An agent on this machine gets what it gets from a hosted
* link: the Markdown index when it fetches `/p/<token>` without asking for HTML, `/p/<token>/llms.txt`, and the JSON
* API at `/p/<token>/api/v1/...` (agent-api.ts, shared with the hosted Worker). Loopback only; anything else answers 404.
*/
export type LocalReport = { platform: ExplorePlatform; zip: Uint8Array; changes?: number; device?: string };
/** A report to serve; without a target, it is the one named for its platform. */
export type LocalReport = { platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string };
export type LocalReportServer = { server: Server; url: string; close: () => Promise<void> };
const TYPES: Record<string, string> = { ".html": "text/html; charset=utf-8", ".js": "text/javascript; charset=utf-8", ".css": "text/css; charset=utf-8",
@@ -27,7 +32,8 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
await stat(resolve(viewerRoot, "index.html"));
const token = options.token ?? [...randomBytes(32)].map(byte => BASE32[byte % 32]).join("");
const page = `/p/${token}`;
const listing = JSON.stringify(options.reports.map(report => ({ platform: report.platform,
// The hosted listing's shape and key order (preview-deploy.ts), without the hosted file paths.
const listing = JSON.stringify(options.reports.map(report => ({ target: reportTarget(report).id, platform: report.platform, label: reportTarget(report).label,
...(report.changes === undefined ? {} : { changes: report.changes }), ...(report.device ? { device: report.device } : {}) })));
const loaded = new Map<LocalReport, Promise<LoadedReport | undefined>>();
let pageUrl = "";
@@ -39,9 +45,13 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
response.end(body);
};
if (request.method !== "GET" && request.method !== "HEAD") return send(405, "Method not allowed");
// `?platform=` picks one of several reports, the first otherwise; an unknown platform matches nothing.
const platforms = url.searchParams.getAll("platform");
const report = platforms.length > 1 ? undefined : platforms.length ? options.reports.find(candidate => candidate.platform === platforms[0]) : options.reports[0];
// `?target=` picks one of several reports; `?platform=`, from links made before targets, the target named for it, else
// the first of that platform; neither, the first. An unknown one matches nothing.
const targets = url.searchParams.getAll("target"), platforms = url.searchParams.getAll("platform");
const report = targets.length + platforms.length > 1 ? undefined
: targets.length ? options.reports.find(candidate => reportTarget(candidate).id === targets[0])
: platforms.length ? options.reports.find(candidate => reportTarget(candidate).id === platforms[0]) ?? options.reports.find(candidate => candidate.platform === platforms[0])
: options.reports[0];
const accept = request.headers.accept ?? null;
const isPage = url.pathname === page || url.pathname === `${page}/`;
const agentPath = url.pathname.startsWith(`${page}/`) ? url.pathname.slice(page.length) : "";
@@ -50,7 +60,8 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
if (!loaded.has(report)) loaded.set(report, loadReport(report.zip));
const content = await loaded.get(report);
if (!content) return send(404, "Not found");
const context: AgentContext = { pageUrl, platform: report.platform, platforms: options.reports.map(entry => entry.platform), expiresAt: null };
const context: AgentContext = { pageUrl, platform: report.platform, platforms: [...new Set(options.reports.map(entry => entry.platform))], expiresAt: null,
target: reportTarget(report).id, targets: options.reports.map(entry => { const { id, platform, label } = reportTarget(entry); return { id, platform, label }; }) };
const link = { link: `<${pageUrl}/api/${AGENT_API_VERSION}>; rel="alternate"; type="application/json", <${pageUrl}/llms.txt>; rel="alternate"; type="text/markdown"`, vary: "Accept" };
if (isPage || agentPath === "/llms.txt") return send(200, agentIndexMarkdown(context, content), "text/markdown; charset=utf-8", link);
const reply = await agentApiReply(context, content, agentPath.slice("/api/v1".length).replace(/\/$/, ""), url.searchParams, accept);
@@ -58,6 +69,25 @@ 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, 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"]);
// The Viewer's own assets, at the absolute paths its index.html names; never anything outside the build.
+348 -252
View File
@@ -1,7 +1,9 @@
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, changeCountText, foldRecord, strongerGroup, historyLine, readCommentRecords, recordLine, recordSummary, type ChangeGroup, type CommentPlatform, type CommentRecords, type HistoryEntry, type PlatformRecord } from "./pr-comment-record.js";
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";
import type { ReviewPresentation } from "../contracts/review.js";
@@ -34,6 +36,10 @@ export type PublicCommentState = {
easBuildId?: string;
reusedEasBuild?: boolean;
};
/** The target this run captures; absent in states from before targets (then the target is build.platform). */
target?: RunTarget;
/** Every target the config captures, in config order, when more than one. */
targets?: RunTarget[];
runtime?: SimulatorRuntimeMetadata;
capture?: {
planned: { base: number; head: number };
@@ -51,18 +57,13 @@ export type PublicCommentState = {
artifactOnly?: boolean;
/** The PR moved while this run worked; the comment keeps its report under previous runs. */
superseded?: boolean;
/** report.comment.map: draw the map of the changed screens. */
map?: true;
};
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[] {
@@ -107,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"}`;
}
@@ -183,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;
@@ -212,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);
@@ -227,10 +225,7 @@ function contextLines(review: PublicReview): string[] {
return lines.length ? [...lines, ""] : [];
}
const PLATFORM_LABELS: Record<CommentPlatform, string> = { ios: "iOS", android: "Android" };
const PLATFORM_ORDER: CommentPlatform[] = ["ios", "android"];
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 } {
@@ -242,9 +237,28 @@ function schemeOf(id: string): string | undefined {
return /@(light|dark)$/.exec(id)?.[1];
}
/** This writer's state as the compact record the comment is rendered from. */
export function platformRecordOf(state: PublicCommentState, platform?: CommentPlatform): PlatformRecord {
/**
* The position of a target in config.yaml, recorded only when the run's targets are not the per-platform ios and
* android (in that order, with their default labels): those render in the order and with the labels they always had.
*/
function targetOrder(targets: PublicCommentState["targets"], id: CommentTarget): number | undefined {
if (!targets?.length) return undefined;
const ids = targets.map(target => target.id).join(",");
const perPlatform = ["ios", "android", "ios,android"].includes(ids) && targets.every(target => target.id === target.platform && target.label === defaultTargetLabel(target.id));
const index = targets.findIndex(target => target.id === id);
return perPlatform || index < 0 || index >= MAX_COMMENT_TARGETS ? undefined : index;
}
/**
* This writer's state as the compact record the comment is rendered from, keyed by its target: the state's own, else
* `target` (a writer that knows only the id, such as the failure job), else the build's platform (states from before targets).
*/
export function platformRecordOf(state: PublicCommentState, target?: CommentTarget): PlatformRecord {
const pr = state.pullRequest;
const id = state.target?.id ?? target ?? state.build?.platform ?? "ios";
const platform = state.target?.platform ?? state.build?.platform ?? (id === "android" ? "android" : "ios");
const label = state.target?.label && state.target.label !== defaultTargetLabel(id) ? state.target.label : undefined;
const order = targetOrder(state.targets, id);
const { runId, runAttempt } = runIdentity(state.links.run);
// While the hosted preview is deploying the central Viewer's download-and-drop page would read as the report, so no link.
const deploying = state.phase === "ready" && !state.links.preview && state.links.deploying === true;
@@ -252,7 +266,7 @@ export function platformRecordOf(state: PublicCommentState, platform?: CommentPl
// A republished review keeps the duration of the run that produced it.
const reviewedAt = state.phase === "ready" && state.review ? Date.parse(state.review.createdAt) : NaN;
const record: PlatformRecord = {
v: 1, platform: platform ?? state.build?.platform ?? "ios", runId, runAttempt, headSha: pr.head.sha, baseSha: pr.base.sha,
v: 1, platform, ...(id !== platform ? { target: id } : {}), ...(label ? { label } : {}), ...(order !== undefined ? { order } : {}), runId, runAttempt, headSha: pr.head.sha, baseSha: pr.base.sha,
startedAt: state.startedAt, updatedAt: Number.isFinite(reviewedAt) ? reviewedAt : state.updatedAt, phase: state.phase,
links: { run: state.links.run, artifacts: state.links.artifacts, config: state.links.config, ...(report ? { report } : {}),
...(state.phase === "ready" && state.links.download ? { download: state.links.download } : {}),
@@ -287,9 +301,11 @@ export function platformRecordOf(state: PublicCommentState, platform?: CommentPl
const scheme = schemeOf(surface.id);
record.changes.push({ id: surface.id, route: routeOf(surface), group, description: descriptionOf(surface, group), ...(scheme ? { scheme } : {}) });
}
const navigation = state.map ? navigationOf(state.review, new Map(record.changes.map(change => [change.id, change.group]))) : undefined;
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) {
@@ -313,6 +329,104 @@ export function platformRecordOf(state: PublicCommentState, platform?: CommentPl
return record;
}
const NAVIGATION_GROUPS: NavigationGroup[] = ["added", "removed", "modified"];
const NAVIGATION_KINDS: NavigationKind[] = ["push", "replace", "navigate", "dismissTo", "redirect"];
/** "/p/[d]" for the route file app/(tabs)/(patterns)/p/[d].tsx: the route without its groups, which a dynamic route's variants share. */
function routePattern(route: NonNullable<Surface["head"]>): string {
const path = `/${route.logicalPath.replace(/^\/+/, "")}`.split("/").filter(segment => !/^\(.*\)$/.test(segment)).join("/");
return plainText(path.replace(/\/index$/, ""), MAX_ROUTE_LENGTH) || "/";
}
/**
* The map the comment draws: every route added, removed or changed visually (a screen whose source changed but looks
* the same is not one), the routes one step before them, and the transitions among those. A route's appearances and
* variants are one node. Switching tabs reaches every tab from every other, so tab transitions are not edges: the
* routes a tab switch shows are grouped instead. Removed routes and the transitions into them come from the base.
*/
function navigationOf(review: PublicReview, groups: Map<string, ChangeGroup>): CommentNavigation | undefined {
if (!review.navigation) return undefined;
const keyOf = new Map<string, string>();
const groupOf = new Map<string, NavigationGroup>();
for (const surface of review.surfaces) {
const route = surface.head ?? surface.base;
if (!route || route.kind === "redirect") continue;
const key = routePattern(route);
keyOf.set(surface.id.replace(/@(light|dark)$/, ""), key);
const group = groups.get(surface.id);
if (group !== "added" && group !== "removed" && group !== "modified") continue;
const current = groupOf.get(key);
if (!current || NAVIGATION_GROUPS.indexOf(group) < NAVIGATION_GROUPS.indexOf(current)) groupOf.set(key, group);
}
if (!groupOf.size || groupOf.size > MAX_NAVIGATION_NODES) return undefined;
const tabs = new Set<string>();
const links = new Map<string, { from: string; to: string; kinds: Set<NavigationKind>; base: boolean }>();
const add = (edge: NonNullable<PublicReview["navigation"]>["head"]["edges"][number], base: boolean) => {
const from = keyOf.get(edge.from), to = keyOf.get(edge.to);
if (!from || !to || from === to) return;
if (edge.kind === "tab") { tabs.add(to); return; }
const link = links.get(`${from}\n${to}`) ?? { from, to, kinds: new Set(), base };
link.kinds.add(edge.kind);
links.set(`${from}\n${to}`, link);
};
for (const edge of review.navigation.head.edges) add(edge, false);
for (const edge of review.navigation.base.edges) if (groupOf.get(keyOf.get(edge.to) ?? "") === "removed") add(edge, true);
// The routes that lead to the most changed ones first, while the map has room.
const leads = new Map<string, number>();
for (const link of links.values()) if (groupOf.has(link.to) && !groupOf.has(link.from)) leads.set(link.from, (leads.get(link.from) ?? 0) + 1);
const before = [...leads].sort(([a, m], [b, n]) => n - m || (a < b ? -1 : 1)).slice(0, MAX_NAVIGATION_NODES - groupOf.size).map(([key]) => key);
const keys = [...groupOf.keys(), ...before].sort();
const index = new Map(keys.map((key, position) => [key, position]));
const edges = [...links.values()].filter(link => index.has(link.from) && index.has(link.to))
.sort((a, b) => Number(groupOf.has(b.to)) - Number(groupOf.has(a.to)) || index.get(a.from)! - index.get(b.from)! || index.get(a.to)! - index.get(b.to)!)
.slice(0, MAX_NAVIGATION_EDGES)
.sort((a, b) => index.get(a.from)! - index.get(b.from)! || index.get(a.to)! - index.get(b.to)!)
.map(link => ({ from: index.get(link.from)!, to: index.get(link.to)!, kinds: NAVIGATION_KINDS.filter(kind => link.kinds.has(kind)), ...(link.base ? { base: true as const } : {}) }));
if (!edges.length) return undefined;
return { nodes: keys.map(key => ({ route: key, ...(groupOf.has(key) ? { group: groupOf.get(key)! } : {}), ...(tabs.has(key) ? { tab: true as const } : {}) })), edges };
}
/** A route as a quoted Mermaid label, with Mermaid's entity codes for what would end the label, the line or the fence. */
function mermaidLabel(route: string): string {
return `"${plainText(route, MAX_ROUTE_LENGTH).replace(/#/g, "#35;").replace(/"/g, "#quot;").replace(/</g, "#lt;").replace(/>/g, "#gt;").replace(/`/g, "#96;")}"`;
}
/** Outlines, not fills: GitHub draws Mermaid in the reader's theme, and a fixed fill is wrong in one of them. */
const MAP_CLASSES: Record<NavigationGroup, string> = {
added: "stroke:#1a7f37,stroke-width:3px",
modified: "stroke:#bc4c00,stroke-width:3px",
removed: "stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 4",
};
function mermaidMap(navigation: CommentNavigation): string[] {
const node = (index: number) => `n${index}[${mermaidLabel(navigation.nodes[index]!.route)}]`;
const tabs = navigation.nodes.flatMap((entry, index) => entry.tab ? [index] : []);
const lines = ["```mermaid", "flowchart LR"];
if (tabs.length) lines.push(` subgraph tabs["Tabs"]`, ...tabs.map(index => ` ${node(index)}`), " end");
lines.push(...navigation.nodes.flatMap((entry, index) => entry.tab ? [] : [` ${node(index)}`]));
lines.push(...navigation.edges.map(edge => ` n${edge.from} ${edge.base ? "-.->" : "-->"}|${edge.kinds.join(", ")}| n${edge.to}`));
for (const group of ["added", "modified", "removed"] as const) {
const members = navigation.nodes.flatMap((entry, index) => entry.group === group ? [`n${index}`] : []);
if (members.length) lines.push(` classDef ${group} ${MAP_CLASSES[group]}`, ` class ${members.join(",")} ${group}`);
}
return [...lines, "```"];
}
/** One collapsed map per distinct navigation: targets with the same routes share one, named when the targets' maps differ. */
function mapSection(ready: PlatformRecord[]): string[] {
const maps = new Map<string, { navigation: CommentNavigation; records: PlatformRecord[] }>();
for (const record of ready) {
if (!record.navigation) continue;
const key = JSON.stringify(record.navigation);
maps.set(key, { navigation: record.navigation, records: [...(maps.get(key)?.records ?? []), record] });
}
return [...maps.values()].flatMap(({ navigation, records }) => {
const named = maps.size > 1 || records.length < ready.length ? `${records.map(labelOf).join(" · ")} · ` : "";
return details(`${named}Map (${plural(navigation.nodes.length, "screen")})`, ["", ...mermaidMap(navigation), "",
"Outlined: green added, orange changed, red dashed removed; the others lead to them. Tabs groups the screens a tab switch shows.", ""]);
});
}
const commitLink = (repository: string, sha: string) => link(inlineText(sha.slice(0, 8), 8), `https://github.com/${repository.split("/").map(encodeURIComponent).join("/")}/commit/${encodeURIComponent(sha)}`);
function surfaceLink(report: string, id: string): string | undefined {
@@ -322,217 +436,196 @@ function surfaceLink(report: string, id: string): string | undefined {
return url.href;
}
function resultCell(record: PlatformRecord): string {
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";
}
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) {
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))}` : ""}`;
}
// 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}` : ""}`;
}
/** 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>`;
}
/** 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 "pending": return "⏳ starting";
case "pending": return `${label} · starting · ${run}`;
case "capturing": {
const capture = record.capture;
if (!capture) return "⏳ capturing";
if (!capture) return `${label} · capturing · ${run}`;
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" : ""}`;
return `${label} · capturing ${side} ${capture.done[side]}/${capture.planned[side]}${capture.baseFromCache && side === "head" ? " · base reused" : ""} · ${run}`;
}
case "failed": return `🟥 failed · ${inlineText(record.failure?.step ?? "capture", 48)}`;
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 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(" · ");
const parts = gaps(record);
return parts.length ? `${label} · ${parts.join(" · ")} · ${run}` : undefined;
}
}
}
/** 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;
/** 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));
}
/** "Workflow iOS run · zip; Android run · zip" for the ready platforms, with the platform named only when there are several. */
function artifactLinks(records: PlatformRecord[]): string | undefined {
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 ? `${PLATFORM_LABELS[record.platform]} ${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; perPlatform: Partial<Record<CommentPlatform, { 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, perPlatform: {}, ...(change.scheme ? { scheme: change.scheme } : {}) };
// A screen accessibility-only on one platform and visibly changed on another is listed as the visible change.
if (strongerGroup(row.group, change.group) !== row.group) Object.assign(row, { group: change.group, description: change.description });
row.perPlatform[record.platform] = { group: change.group, ...(href ? { href } : {}) };
rows.set(change.id, row);
}
}
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, platforms: CommentPlatform[]): string {
const where = platforms.flatMap(platform => {
const entry = row.perPlatform[platform];
if (!entry) return [];
const label = PLATFORM_LABELS[platform] + (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[], platforms: CommentPlatform[], rowCap: number): string[] {
const ready = records.filter(record => record.phase === "ready");
if (!ready.length) return [];
const groups = changeRows(ready);
const lines: string[] = [];
const total = [...groups.values()].reduce((sum, rows) => sum + rows.length, 0);
lines.push(`**Changes** · ${plural(total, "screen")}${platforms.length > 1 && ready.length > 1 ? " · a screen is listed once, with a link per platform" : ""}`, "");
// With screens left uncompared, nothing changed only among the ones compared.
if (total === 0) lines.push(ready.some(record => record.notCompared) ? "No compared screen changed on the reviewed platforms." : "No screen changed on the reviewed platforms.", "");
for (const group of GROUP_ORDER) {
const rows = groups.get(group) ?? [];
if (!rows.length) continue;
const shown = rows.slice(0, rowCap);
const content = ["", ...(group === "accessibility-only" ? ["Before and After look the same. What screen readers and voice control read changed.", ""] : []),
...shown.map(row => renderChangeRow(row, platforms))];
if (rows.length > shown.length) {
const report = ready.find(record => record.links.report)?.links.report;
content.push(`- ${rows.length - shown.length} more${report ? ` — ${link("Explore report", report)}` : ""}`);
}
content.push("");
lines.push(...details(`${GROUP_LABEL[group]} (${rows.length})`, content));
}
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 : `${PLATFORM_LABELS[record.platform]} · ${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 platform 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";
}
const links = ready.length === 1 ? [link("Open report", ready[0]!.links.report!)]
: ready.map(record => link(`${PLATFORM_LABELS[record.platform]} report`, record.links.report!));
return `### Explore review · ${links.join(" · ")}`;
}
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";
}
}
function validationSummary(record: PlatformRecord): string {
switch (record.phase) {
case "failed": return "🟥 failed";
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`;
}
default: return "⏳ in progress";
}
}
function validationSection(records: PlatformRecord[], platforms: CommentPlatform[]): string[] {
if (!records.some(record => record.phase === "ready" || record.phase === "failed")) return [];
const byPlatform = platforms.map(platform => records.find(record => record.platform === platform)!);
const summary = `Validation · ${byPlatform.map(record => `${PLATFORM_LABELS[record.platform]} ${validationSummary(record)}`).join(" · ")}`;
const header = platforms.length > 1 ? `| Check | ${byPlatform.map(record => PLATFORM_LABELS[record.platform]).join(" | ")} |` : `| Check | ${PLATFORM_LABELS[byPlatform[0]!.platform]} |`;
const checks: [string, Parameters<typeof validationCell>[1]][] = [["Capture", "capture"], ["Route verification", "routes"], ["Visual comparison", "visual"], ["Accessibility comparison", "accessibility"], ["Source inventory", "inventory"]];
const content = ["", header, `|---|${byPlatform.map(() => "---").join("|")}|`,
...checks.map(([label, check]) => `| ${label} | ${byPlatform.map(record => validationCell(record, check)).join(" | ")} |`), ""];
for (const record of byPlatform) {
if (record.phase === "failed" && record.failure) {
content.push(`**${PLATFORM_LABELS[record.platform]} 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 ? `**${PLATFORM_LABELS[record.platform]}** · ${sideLine("base")} · ${sideLine("head")}` : `**${PLATFORM_LABELS[record.platform]}**`, "");
/** 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[] {
if (!history.length) return [];
const content = ["", ...history.map(entry => {
const platforms = PLATFORM_ORDER.flatMap(platform => {
const item = entry.platforms[platform];
if (!item) return [];
const links = [item.report ? link("report", item.report) : undefined, link("run", item.run)].filter(Boolean).join(" · ");
return [`${PLATFORM_LABELS[platform]} ${inlineText(item.summary, 120)} (${links})`];
});
return `- ${commitLink(repository, entry.headSha)} · ${platforms.join(" · ")}`;
const targets = Object.keys(entry.platforms).map(id => ({ id, item: entry.platforms[id]! })).filter(({ item }) => Boolean(item))
.sort((a, b) => compareTargets({ id: a.id, order: a.item.order }, { id: b.id, order: b.item.order })).map(({ id, item }) => {
const links = [item.report ? link("report", item.report) : undefined, link("run", item.run)].filter(Boolean).join(" · ");
return `${inlineText(item.label ?? defaultTargetLabel(id), 80)} ${inlineText(item.summary, 120)} (${links})`;
});
return `- ${commitLink(repository, entry.headSha)} · ${targets.join(" · ")}`;
}), ""];
return details(`Previous runs (${history.length})`, content);
}
@@ -550,43 +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 platform of the current run. */
/**
* 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 = PLATFORM_ORDER.flatMap(platform => records.current[platform] ? [records.current[platform]!] : []);
const platforms = current.map(record => record.platform);
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 render = (rowCap: number): string => {
const lines: string[] = [...hidden, heading(current), "",
`<sub>base ${commitLink(repository, first.baseSha)} → ${commitLink(repository, first.headSha)}</sub>`, ""];
const ready = shown.filter(record => record.phase === "ready");
const rows = changeRows(ready);
const render = (rowCap: number, withMap: boolean): string => {
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 => `| ${PLATFORM_LABELS[record.platform]} | ${deviceCell(record)} | ${resultCell(record)} | ${reportCell(record)} |`), "");
lines.push(...changesSection(current, platforms, rowCap));
lines.push(...validationSection(current, platforms));
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");
};
let rowCap = MAX_ROWS_PER_GROUP;
let body = render(rowCap);
while (body.length > budget && rowCap > 1) { rowCap = Math.max(1, Math.floor(rowCap / 2)); body = render(rowCap); }
// 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;
}
@@ -594,21 +691,20 @@ 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 comment's records. */
export function renderPublicComment(state: PublicCommentState, existing?: string, platform?: CommentPlatform): string {
/**
* Render the sticky pull-request comment for any phase of a public review run, folding this writer into the existing
* comment's records. `target` keys the record when the state names no target of its own (see platformRecordOf).
*/
export function renderPublicComment(state: PublicCommentState, existing?: string, target?: CommentTarget): string {
const pr = state.pullRequest;
if (pr.origin === "local") return renderLocalText(state);
return renderCommentRecords(foldRecord(readCommentRecords(existing), platformRecordOf(state, platform)), existing);
return renderCommentRecords(foldRecord(readCommentRecords(existing), platformRecordOf(state, target)), existing);
}
/** The sticky-comment merge for a writer: every writer re-renders the whole comment from the records it carries plus its own. */
export function platformSectionMerge(state: PublicCommentState, platform: CommentPlatform | undefined): { merge: (existing: string | undefined) => string } {
return { merge: existing => renderPublicComment(state, existing, platform) };
export function platformSectionMerge(state: PublicCommentState, target: CommentTarget | undefined): { merge: (existing: string | undefined) => string } {
return { merge: existing => renderPublicComment(state, existing, target) };
}
/** "iPhone 17 Pro 26.0 · light + dark": the device model and OS version the report's head capture ran on, and its appearances when it captured several. */
+191 -30
View File
@@ -1,17 +1,33 @@
import { deflateRawSync, inflateRawSync } from "node:zlib";
import { isTargetId } from "../config/explore-config.js";
/**
* The sticky PR comment is rendered from compact per-platform records that every writer embeds as hidden
* The sticky PR comment is rendered from compact per-target records that every writer embeds as hidden
* HTML comment lines, so the capture, report, deploy and failure jobs of one run (and the runs that follow
* it) each rewrite the whole comment from the same data without needing the other jobs' files:
*
* <!-- expo-explore-record:<platform>:<base64url(deflate(json))> --> one per platform of the current run
* <!-- expo-explore-history:<base64url(deflate(json))> --> earlier runs on this PR
* <!-- expo-explore-record:<target>:<base64url(deflate(json))> --> one per target of the current run
* <!-- expo-explore-history:<base64url(deflate(json))> --> earlier runs on this PR
*
* A config without targets has one target per platform whose id is the platform (`ios`, `android`); its records
* carry neither `target` nor `label` nor `order`, so they are byte-identical to the per-platform records of
* versions before targets, and those still parse.
*
* Records read back from GitHub are untrusted: anything that does not match the schema is dropped and the
* comment renders without it.
*/
export type CommentPlatform = "ios" | "android";
/** A target id (`ios`, `android`, or an id from config.yaml's targets); it keys records and history entries. */
export type CommentTarget = string;
/** A config has at most 8 targets; a comment never holds more records than that. */
export const MAX_COMMENT_TARGETS = 8;
const PLATFORM_LABELS: Record<CommentPlatform, string> = { ios: "iOS", android: "Android" };
const LEGACY_ORDER: CommentPlatform[] = ["ios", "android"];
/** The label a target shows without a `label` of its own: iOS and Android for the per-platform ids, else the id. */
export function defaultTargetLabel(id: CommentTarget): string {
return id === "ios" || id === "android" ? PLATFORM_LABELS[id] : id;
}
export type RecordPhase = "pending" | "capturing" | "ready" | "failed";
/**
* `accessibility-only`: modified, but the screenshots match; only what assistive technology reads changed. A screen
@@ -26,8 +42,8 @@ export const CHANGE_GROUPS: ChangeGroup[] = ["added", "removed", "modified", "ac
* are changes too (screen readers and voice control see them), but not ones a screenshot shows.
*/
/**
* The group of a screen that changed on several platforms. Accessibility only says the screenshots match, so it
* yields to any other group; otherwise the first platform's group stands, as it always has.
* The group of a screen that changed on several targets. Accessibility only says the screenshots match, so it
* yields to any other group; otherwise the first target's group stands, as it always has.
*/
export function strongerGroup(first: ChangeGroup, other: ChangeGroup): ChangeGroup {
return first === "accessibility-only" ? other : first;
@@ -40,11 +56,35 @@ export function changeCountText(groups: readonly ChangeGroup[]): string {
return [visual ? `${visual} visual change${visual === 1 ? "" : "s"}` : undefined, `${accessibility} accessibility only`].filter(Boolean).join(" · ");
}
export type NavigationGroup = "added" | "modified" | "removed";
export type NavigationKind = "push" | "replace" | "navigate" | "redirect" | "tab" | "dismissTo";
const NAVIGATION_GROUPS: NavigationGroup[] = ["added", "modified", "removed"];
const NAVIGATION_KINDS: NavigationKind[] = ["push", "replace", "navigate", "redirect", "tab", "dismissTo"];
export const MAX_NAVIGATION_NODES = 30;
export const MAX_NAVIGATION_EDGES = 80;
/**
* The comment's map: one node per route that was added, removed or changed visually, and per route one step before
* one of them; edges index `nodes`. `tab` marks a route a tab switch shows, `base` an edge into a removed route, which
* only the base revision's navigation has.
*/
export type CommentNavigation = {
nodes: { route: string; group?: NavigationGroup; tab?: true }[];
edges: { from: number; to: number; kinds: NavigationKind[]; base?: true }[];
};
export type SideHealth = { planned: number; captured: number; verified: number; unverified: number; unavailable: number };
export type PlatformRecord = {
v: 1;
/** The target's platform. A failure record of a target it never saw before guesses ios; nothing renders it. */
platform: CommentPlatform;
/** The target id, when it is not the platform. */
target?: CommentTarget;
/** What the comment calls the target, when that is not defaultTargetLabel(id). */
label?: string;
/** The target's position in config.yaml, when the run's targets are not the per-platform ios, android. */
order?: number;
runId: string;
runAttempt: string;
headSha: string;
@@ -69,6 +109,7 @@ export type PlatformRecord = {
notCompared?: number;
/** Differences stated once rather than per screen (variants, app-wide source changes). */
context?: string[];
navigation?: CommentNavigation;
diagnostics?: { side?: "base" | "head"; route: string; code: string; message: string; nextAction: string }[];
diagnosticCount?: number;
failure?: { step: string; message: string };
@@ -81,13 +122,51 @@ export type HistoryEntry = {
baseSha: string;
runId: string;
startedAt: number;
platforms: Partial<Record<CommentPlatform, { phase: RecordPhase; summary: string; run: string; report?: string; download?: string; superseded?: boolean }>>;
/** Keyed by target id (the platform for configs without targets; the key keeps its old name so old entries parse). */
platforms: Partial<Record<CommentTarget, HistoryItem>>;
};
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>>;
/** 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[];
};
export type CommentRecords = { current: Partial<Record<CommentPlatform, PlatformRecord>>; history: HistoryEntry[] };
/** The id a record is keyed by. */
export function recordTarget(record: Pick<PlatformRecord, "platform" | "target">): CommentTarget {
return record.target ?? record.platform;
}
export function recordLabel(record: Pick<PlatformRecord, "platform" | "target" | "label">): string {
return record.label ?? defaultTargetLabel(recordTarget(record));
}
/** Config order where the run recorded one, else iOS before Android, then by id. */
export function compareTargets(a: { id: CommentTarget; order?: number | undefined }, b: { id: CommentTarget; order?: number | undefined }): number {
const rank = (item: { id: CommentTarget; order?: number | undefined }) => item.order ?? (LEGACY_ORDER.includes(item.id as CommentPlatform) ? LEGACY_ORDER.indexOf(item.id as CommentPlatform) : MAX_COMMENT_TARGETS);
return rank(a) - rank(b) || (a.id < b.id ? -1 : a.id > b.id ? 1 : 0);
}
/** The current records in display order. */
export function orderedRecords(records: CommentRecords): PlatformRecord[] {
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:(ios|android):([A-Za-z0-9_-]+) -->$/gm;
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;
@@ -109,7 +188,11 @@ function decodePayload(encoded: string): unknown {
}
export function recordLine(record: PlatformRecord): string {
return `<!-- expo-explore-record:${record.platform}:${encodeRecordPayload(record)} -->`;
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 {
@@ -122,6 +205,8 @@ const isCount = (value: unknown): value is number => typeof value === "number" &
const isTime = (value: unknown): value is number => typeof value === "number" && Number.isFinite(value) && value > 0;
const isPhase = (value: unknown): value is RecordPhase => value === "pending" || value === "capturing" || value === "ready" || value === "failed";
const isPlatform = (value: unknown): value is CommentPlatform => value === "ios" || value === "android";
const isLabel = (value: unknown): value is string => isString(value, 80) && value.trim().length > 0;
const isOrder = (value: unknown): value is number => isCount(value) && value < MAX_COMMENT_TARGETS;
const isSide = (value: unknown): value is "base" | "head" => value === "base" || value === "head";
const isUrl = (value: unknown): value is string => {
if (!isString(value, 4000)) return false;
@@ -143,9 +228,11 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
|| !isRecord(value.links) || !isUrl(value.links.run) || !isUrl(value.links.artifacts) || !isUrl(value.links.config)
|| !optional(value.links.report, isUrl) || !optional(value.links.download, isUrl)
|| !(value.links.expiresAt === undefined || value.links.expiresAt === null || isTime(value.links.expiresAt))
|| !(value.links.deploying === undefined || value.links.deploying === true)) return undefined;
|| !(value.links.deploying === undefined || value.links.deploying === true)
|| !optional(value.target, isTargetId) || !optional(value.label, isLabel) || !optional(value.order, isOrder)) return undefined;
const record: PlatformRecord = {
v: 1, platform: value.platform, runId: value.runId, runAttempt: value.runAttempt, headSha: value.headSha, baseSha: value.baseSha,
v: 1, platform: value.platform, ...(value.target !== undefined && value.target !== value.platform ? { target: value.target } : {}),
...(value.label !== undefined ? { label: value.label } : {}), ...(value.order !== undefined ? { order: value.order } : {}), runId: value.runId, runAttempt: value.runAttempt, headSha: value.headSha, baseSha: value.baseSha,
startedAt: value.startedAt, updatedAt: value.updatedAt, phase: value.phase,
links: { run: value.links.run, artifacts: value.links.artifacts, config: value.links.config,
...(value.links.report ? { report: value.links.report } : {}), ...(value.links.download ? { download: value.links.download } : {}),
@@ -186,6 +273,8 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
? [{ id: entry.id, route: entry.route, group: entry.group as ChangeGroup, description: entry.description, ...(isString(entry.scheme, 20) ? { scheme: entry.scheme } : {}) }] : []);
if (changes.length <= 2000) record.changes = changes;
}
const navigation = parseNavigation(value.navigation);
if (navigation) record.navigation = navigation;
if (Array.isArray(value.context)) record.context = value.context.filter((entry): entry is string => isString(entry, 2000)).slice(0, 10);
if (Array.isArray(value.diagnostics)) {
record.diagnostics = value.diagnostics.flatMap((entry): NonNullable<PlatformRecord["diagnostics"]> => isRecord(entry) && isString(entry.route, 2000) && isString(entry.code, 200)
@@ -199,6 +288,25 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
return record;
}
function parseNavigation(value: unknown): CommentNavigation | undefined {
if (!isRecord(value) || !Array.isArray(value.nodes) || !Array.isArray(value.edges) || value.nodes.length > MAX_NAVIGATION_NODES
|| value.edges.length > MAX_NAVIGATION_EDGES) return undefined;
const nodes: CommentNavigation["nodes"] = [];
for (const node of value.nodes) {
if (!isRecord(node) || !isString(node.route, 200) || !optional(node.group, (group): group is NavigationGroup => NAVIGATION_GROUPS.includes(group as NavigationGroup))
|| !(node.tab === undefined || node.tab === true)) return undefined;
nodes.push({ route: node.route, ...(node.group ? { group: node.group } : {}), ...(node.tab ? { tab: true } : {}) });
}
const edges: CommentNavigation["edges"] = [];
const isNode = (index: unknown): index is number => isCount(index) && index < nodes.length;
for (const edge of value.edges) {
if (!isRecord(edge) || !isNode(edge.from) || !isNode(edge.to) || !Array.isArray(edge.kinds) || !edge.kinds.length
|| !edge.kinds.every(kind => NAVIGATION_KINDS.includes(kind as NavigationKind)) || !(edge.base === undefined || edge.base === true)) return undefined;
edges.push({ from: edge.from, to: edge.to, kinds: [...new Set(edge.kinds as NavigationKind[])], ...(edge.base ? { base: true } : {}) });
}
return nodes.length && edges.length ? { nodes, edges } : undefined;
}
export function parseHistory(value: unknown): HistoryEntry[] {
if (!Array.isArray(value)) return [];
const entries: HistoryEntry[] = [];
@@ -206,12 +314,12 @@ export function parseHistory(value: unknown): HistoryEntry[] {
if (!isRecord(entry) || !isString(entry.headSha) || !SHA.test(entry.headSha) || !isString(entry.baseSha) || !SHA.test(entry.baseSha)
|| !isString(entry.runId, 200) || !SAFE_ID.test(entry.runId) || !isTime(entry.startedAt) || !isRecord(entry.platforms)) continue;
const platforms: HistoryEntry["platforms"] = {};
for (const platform of ["ios", "android"] as const) {
const item = entry.platforms[platform];
for (const target of Object.keys(entry.platforms).filter(isTargetId).slice(0, MAX_COMMENT_TARGETS)) {
const item = entry.platforms[target];
if (!isRecord(item) || !isPhase(item.phase) || !isString(item.summary, 400) || !isUrl(item.run)
|| !optional(item.report, isUrl) || !optional(item.download, isUrl)) continue;
platforms[platform] = { phase: item.phase, summary: item.summary, run: item.run, ...(item.report ? { report: item.report } : {}), ...(item.download ? { download: item.download } : {}),
...(item.superseded === true ? { superseded: true } : {}) };
|| !optional(item.report, isUrl) || !optional(item.download, isUrl) || !optional(item.label, isLabel) || !optional(item.order, isOrder)) continue;
platforms[target] = { phase: item.phase, summary: item.summary, run: item.run, ...(item.report ? { report: item.report } : {}), ...(item.download ? { download: item.download } : {}),
...(item.superseded === true ? { superseded: true } : {}), ...(item.label !== undefined ? { label: item.label } : {}), ...(item.order !== undefined ? { order: item.order } : {}) };
}
if (Object.keys(platforms).length) entries.push({ headSha: entry.headSha, baseSha: entry.baseSha, runId: entry.runId, startedAt: entry.startedAt, platforms });
if (entries.length === HISTORY_LIMIT) break;
@@ -223,10 +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]!));
if (record && record.platform === match[1]) records.current[record.platform] = 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;
@@ -250,9 +366,10 @@ function historyEntryOf(records: PlatformRecord[]): HistoryEntry | undefined {
if (!first) return undefined;
const entry: HistoryEntry = { headSha: first.headSha, baseSha: first.baseSha, runId: first.runId, startedAt: Math.min(...records.map(record => record.startedAt)), platforms: {} };
for (const record of records) {
entry.platforms[record.platform] = { phase: record.phase, summary: recordSummary(record), run: record.links.run,
entry.platforms[recordTarget(record)] = { phase: record.phase, summary: recordSummary(record), run: record.links.run,
...(record.links.report ? { report: record.links.report } : {}), ...(record.links.download ? { download: record.links.download } : {}),
...(record.superseded ? { superseded: true } : {}) };
...(record.superseded ? { superseded: true } : {}), ...(record.label !== undefined ? { label: record.label } : {}),
...(record.order !== undefined ? { order: record.order } : {}) };
}
return entry;
}
@@ -262,27 +379,71 @@ const runOrder = (runId: string): number => Number.parseInt(runId, 10) || 0;
function pushHistory(history: HistoryEntry[], entry: HistoryEntry | undefined): HistoryEntry[] {
if (!entry) return history;
const merged = [entry, ...history.filter(item => item.runId !== entry.runId)];
// One entry per run: a platform that reaches history later joins the entry its sibling made.
// One entry per run: a target that reaches history later joins the entry its sibling made.
const existing = history.find(item => item.runId === entry.runId);
if (existing) merged[0] = { ...existing, platforms: { ...existing.platforms, ...entry.platforms } };
return merged.sort((a, b) => runOrder(b.runId) - runOrder(a.runId) || b.startedAt - a.startedAt).slice(0, HISTORY_LIMIT);
}
/**
* Fold one writer's record into the comment's records. The same run replaces its own platform; a newer run
* Fold one writer's record into the comment's records. The same run replaces its own target; a newer run
* moves the previous run into history; a run that finds a newer run already current (the PR moved while it
* worked) is superseded and only adds itself to history, so its report stays linked without displacing the
* current review.
*/
export function foldRecord(existing: CommentRecords, record: PlatformRecord): CommentRecords {
const current = Object.values(existing.current).filter((item): item is PlatformRecord => Boolean(item));
export function foldRecord(existing: CommentRecords, incoming: PlatformRecord): CommentRecords {
const current = orderedRecords(existing);
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, [record.platform]: 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: { [record.platform]: 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;
}
/**
* The failure job knows a target only by the id in an artifact name: its record takes the label, order and platform
* the comment already holds for that id (from the capture job's progress record, or the newest run that had it).
*/
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] ?? 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;
}
+323 -155
View File
@@ -1,14 +1,17 @@
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 { MAX_METADATA_BYTES } from "./agent-api.js";
import { loadReport, MAX_METADATA_BYTES } from "./agent-api.js";
import { MAX_ASSET_BYTES, manifestBody, PREVIEW_ASSET } from "./preview-manifest.js";
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
import 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";
import { normalizePublicReviewForReading } from "../contracts/review-validation.js";
import { EXPLORATION_REPORT_KIND, type ExplorationReport } from "../contracts/standalone-report.js";
@@ -19,18 +22,25 @@ 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
* `targets/<target id>.json`, selected by manifest.json?target=<id> (?platform=<id> for a target named after its platform).
*/
target?: RunTarget;
inputPath: string;
/** The `ci:report` output directory: review.json and assets/. */
reportPath: string;
@@ -38,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;
@@ -67,18 +77,44 @@ export type PreviewDeployResult = {
/** The first (or only) report's archive, as before; `reports` lists every platform's. */
reportSha256: string;
reportBytes: number;
reports: Array<{ platform?: ExplorePlatform; artifactUrl: string; reportSha256: string; reportBytes: number }>;
reports: Array<{ platform?: ExplorePlatform; target?: RunTarget; artifactUrl: string; reportSha256: string; reportBytes: number }>;
headSha: string;
/** A comparison's link is in the run summary only: callers must not print previewUrl, which is unmasked for it. */
linkedFromRunSummary?: true;
};
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;
const ZIP_DATE = new Date("2000-01-01T00:00:00Z");
const PLATFORM_LABELS: Record<ExplorePlatform, string> = { ios: "iOS", android: "Android" };
/** The target of a report from before targets, or of a config without them: its platform, under the platform's name. */
export function platformTarget(platform: ExplorePlatform): RunTarget {
return { id: platform, platform, label: PLATFORM_LABELS[platform] };
}
/** 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}`;
}
/** A target as untrusted JSON names it (a report's review.runtime.target): its id, platform and a plain label, or undefined. */
function readTarget(value: unknown): RunTarget | undefined {
if (typeof value !== "object" || value === null) return undefined;
const { id, platform, label } = value as Record<string, unknown>;
if (!isTargetId(id) || (platform !== "ios" && platform !== "android")) return undefined;
const shown = typeof label === "string" ? listingLabel(label) : "";
return { id, platform, label: shown || PLATFORM_LABELS[platform] };
}
function assertTargets(targets: RunTarget[], message: string, nextAction: string): void {
// At most 8, as a config names: the Worker refuses a longer listing.
if (!targets.length || targets.length > 8 || targets.some(target => !isTargetId(target.id) || (target.platform !== "ios" && target.platform !== "android"))
|| new Set(targets.map(target => target.id)).size !== targets.length) throw previewError("PREVIEW_REPORTS_INVALID", message, nextAction);
}
function base32(bytes: Uint8Array): string {
let bits = 0; let value = 0; let out = "";
@@ -107,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. */
@@ -163,8 +209,11 @@ export async function zipReportDirectory(reportPath: string): Promise<Uint8Array
return writer.close();
}
/** What a report ZIP holds, from its review.json or exploration.json: where to host it and how the platform switch labels it. */
export type ReportZipSummary = { platform: ExplorePlatform; changes?: number; device?: string }
/**
* What a report ZIP holds, from its review.json or exploration.json: where to host it and how the target switch labels it.
* `target` is review.runtime.target, or for reports from before targets (and explorations) the platform's own target.
*/
export type ReportZipSummary = { platform: ExplorePlatform; target: RunTarget; changes?: number; device?: string }
& ({ kind: "review"; repository: string; runId: string; base: string; head: string } | { kind: "exploration" });
/**
@@ -189,7 +238,7 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
if (report?.kind !== EXPLORATION_REPORT_KIND || !exploration || (exploration.app?.platform !== "ios" && exploration.app?.platform !== "android")) {
throw new Error("exploration.json is not an Explore exploration report");
}
return { kind: "exploration", platform: exploration.app.platform, device: `${exploration.device.model} ${exploration.device.osVersion}`.trim() };
return { kind: "exploration", platform: exploration.app.platform, target: platformTarget(exploration.app.platform), device: `${exploration.device.model} ${exploration.device.osVersion}`.trim() };
}
const review = (report as Partial<ArtifactReport>).review;
const pr = review?.pullRequest;
@@ -207,18 +256,14 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
const changes = reviewChangeCount({ review: normalizePublicReviewForReading(review) });
const device = reviewDevice({ runtime: { deviceModel: review.runtime?.device?.model ?? "", osVersion: review.runtime?.device?.osVersion ?? "",
...(review.runtime?.colorSchemes ? { colorSchemes: review.runtime.colorSchemes } : {}) } });
return { kind: "review", platform, repository: pr.repository, runId: review.runId, base: pr.base.sha, head: pr.head.sha,
// A target whose platform is not the report's own is not this report's target.
const named = readTarget(review.runtime?.target);
const target = named?.platform === platform ? named : platformTarget(platform);
return { kind: "review", platform, target, repository: pr.repository, runId: review.runId, base: pr.base.sha, head: pr.head.sha,
...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) };
}
/** 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));
@@ -232,28 +277,45 @@ async function assertExport(exportPath: string): Promise<void> {
}
}
type SealedReport = { entry: PreviewReportInput; input: CiReportInput; 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: no `#` (a dotenv comment), markup or control characters, and short. */
/**
* 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.
*/
function listingDevice(device: string): string {
return device.replace(/[^\p{L}\p{N} .,()+·_:/-]/gu, "").replace(/\s+/g, " ").trim().slice(0, 120);
}
/** A target's label for the switch, as safe as a device label and shorter. */
function listingLabel(label: string): string {
return listingDevice(label).slice(0, 80).trim();
}
/** The worker's EXPLORE_PREVIEW_REPORTS entries, in the order the workflow lists platforms; also what reports.json must echo. */
export function previewReportListing(reports: ReadonlyArray<Pick<SealedReport, "entry" | "input" | "file">>, reportDirectory: string) {
return reports.map(report => {
const changes = reviewChangeCount(report.input.commentState);
const device = listingDevice(reviewDevice(report.input.commentState));
return { platform: report.entry.platform!, path: `/_report/${reportDirectory}/${report.file}`,
...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) };
});
/** 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 };
/** 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 } : {}), ...(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 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> {
@@ -263,15 +325,24 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
: [{ inputPath: options.inputPath, reportPath: options.reportPath, artifactUrl: options.artifactUrl }];
if (!entries.length) throw previewError("PREVIEW_REPORTS_MISSING", "There is no platform report to deploy",
"Pass --inputs and --reports directories holding one explore-capture and one explore-review artifact per platform.");
const multi = entries.some(entry => entry.platform !== undefined);
if (multi && (entries.some(entry => !entry.platform) || new Set(entries.map(entry => entry.platform)).size !== entries.length)) {
throw previewError("PREVIEW_REPORTS_INVALID", "Each report of a multi-platform preview must name a distinct platform", "Deploy one report per platform of the same run.");
const multi = entries.some(entry => entry.platform !== undefined || entry.target !== undefined);
if (multi) {
if (entries.some(entry => !entry.platform && !entry.target)) throw previewError("PREVIEW_REPORTS_INVALID", "Each report of a multi-target preview must name its target", "Deploy one report per target of the same run.");
assertTargets(entries.map(entry => entry.target ?? platformTarget(entry.platform!)), "Each report of a multi-target preview must name a distinct target", "Deploy one report per target of the same run.");
}
const inputs: Array<{ entry: PreviewReportInput; input: CiReportInput; target?: RunTarget }> = [];
for (const entry of entries) {
const input = await readCiReportInput(entry.inputPath);
// A platform-named entry takes the report's own label when the report names that target.
const named = readTarget(input.publicReview.runtime.target);
const target = entry.target ?? (entry.platform ? (named?.id === entry.platform ? named : platformTarget(entry.platform)) : undefined);
inputs.push({ entry, input, ...(target ? { target } : {}) });
}
const inputs: Array<{ entry: PreviewReportInput; input: CiReportInput }> = [];
for (const entry of entries) inputs.push({ entry, input: await readCiReportInput(entry.inputPath) });
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",
@@ -281,33 +352,31 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
const other = input.publicReview;
if (!input.preview || other.pullRequest.origin !== pr.origin || other.pullRequest.repository !== pr.repository || other.pullRequest.number !== pr.number
|| other.pullRequest.head.sha !== pr.head.sha || other.pullRequest.base.sha !== pr.base.sha || other.runId !== review.runId || other.runAttempt !== review.runAttempt) {
throw previewError("PREVIEW_REPORTS_MISMATCH", "The platform reports do not come from the same review run", "Deploy only the reports this workflow run produced for the same PR head.");
throw previewError("PREVIEW_REPORTS_MISMATCH", "The target reports do not come from the same review run", "Deploy only the reports this workflow run produced for the same PR head.");
}
}
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
await assertExport(exportPath);
const reports: SealedReport[] = [];
for (const { entry, input } of inputs) {
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, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi ? `${entry.platform}.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, 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({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: multi ? `?platform=${report.entry.platform}` : "" })),
reportDirectory, ...(listing ? { listing } : {}), project, ...(first.preview.owner ? { owner: first.preview.owner } : {}),
hosted = await deployReports({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: multi && report.target ? targetQuery(report.target) : "" })),
...(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 } : {}),
@@ -317,46 +386,52 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
if (pr.origin !== "compare") for (const report of reports) {
try {
await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
...(report.entry.platform ? { platform: report.entry.platform } : {}), previewFailed: true });
...commentTarget(report), previewFailed: true });
} catch { /* the deployment failure is the one to report */ }
}
throw error;
}
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,
...(report.entry.platform ? { platform: report.entry.platform } : {}), 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 } : {}), artifactUrl: report.entry.artifactUrl,
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,
...(pr.origin === "compare" ? { linkedFromRunSummary: true as const } : {}) };
}
}
/** The comparison's job summary: what was compared, the hosted link, and each platform's change count. */
export function renderCompareSummary(comparison: CompareReviewPresentation, previewUrl: string, expiresAt: number | null, inputs: CiReportInput[]): string {
/** Which comment section and artifact a report is: its target, or (single-report runs) none. */
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, inputs: CiReportInput[]): string {
const platforms = inputs.map(input => {
const changes = reviewChangeCount(input.commentState);
const device = reviewDevice(input.commentState);
return `- ${input.publicReview.runtime.platform === "android" ? "Android" : "iOS"}${device ? ` (${device})` : ""}: ${changes === undefined ? "no review" : `${changes} ${changes === 1 ? "change" : "changes"}`}`;
const label = readTarget(input.publicReview.runtime.target)?.label ?? (input.publicReview.runtime.platform === "android" ? "Android" : "iOS");
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 };
@@ -368,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;
@@ -381,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.
@@ -395,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 });
@@ -443,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) {
@@ -459,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);
@@ -480,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 });
@@ -495,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;
@@ -518,7 +630,7 @@ export async function deployExplorationReport(options: ExplorationDeployOptions)
message: "An EAS login is required to host the report", nextAction: "Run `eas login` or set EXPO_TOKEN, then rerun with --upload." });
if (!/^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$/.test(options.project)) throw previewError("PREVIEW_PROJECT_INVALID", `Invalid EAS project slug: ${options.project}`, "Pass --project as a lowercase slug such as expo-explore.");
if (options.alias !== undefined && !HOSTING_ALIAS.test(options.alias)) throw previewError("PREVIEW_ALIAS_INVALID", `Invalid EAS Hosting alias: ${options.alias}`, "Pass --alias as a lowercase slug such as bluesky.");
if (options.token !== undefined && !HOSTED_TOKEN.test(options.token)) throw previewError("PREVIEW_TOKEN_INVALID", "EXPLORE_PREVIEW_TOKEN must be 32 characters of a-z and 2-7.", "Generate one with `openssl rand 20 | base32 | tr A-Z a-z` and set EXPLORE_PREVIEW_TOKEN, or unset it for a random token.");
if (options.token !== undefined && !HOSTED_TOKEN.test(options.token)) throw previewError("PREVIEW_TOKEN_INVALID", "EXPLORE_PREVIEW_TOKEN must be 32 characters of a-z and 2-7.", "Generate one with `LC_ALL=C tr -dc a-z2-7 </dev/urandom | head -c 32` and set EXPLORE_PREVIEW_TOKEN, or unset it for a random token.");
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
await assertExport(exportPath);
let zip: Uint8Array;
@@ -527,21 +639,21 @@ 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 file = options.platform ? `${options.platform}.zip.enc` : "report.zip.enc";
const hosted = await deploySealedReports({ reports: [{ zip, sha256, file, query: options.platform ? `?platform=${options.platform}` : "" }], reportDirectory,
...(options.platform ? { listing: [{ platform: options.platform, path: `/_report/${reportDirectory}/${file}` }] } : {}), project: options.project,
const target = options.platform ? platformTarget(options.platform) : undefined;
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 platform, with what the platform switch says of each. */
reports: Array<{ platform: ExplorePlatform; zipPath: string; changes?: number; device?: string }>;
/** 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;
alias: string;
@@ -568,96 +680,129 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
message: "An EAS login is required to deploy the Viewer preview", nextAction: "Run `eas login` or set EXPO_TOKEN." });
if (!HOSTING_ALIAS.test(options.alias)) throw previewError("PREVIEW_ALIAS_INVALID", `Invalid EAS Hosting alias: ${options.alias}`, "Pass --alias as a lowercase slug such as pr-123.");
if (options.token !== undefined && !HOSTED_TOKEN.test(options.token)) throw previewError("PREVIEW_TOKEN_INVALID", "The preview token must be 32 characters of a-z and 2-7.", "Pass the /p/<token> segment of the previous preview link, or none for a new one.");
if (!options.reports.length || new Set(options.reports.map(report => report.platform)).size !== options.reports.length) {
throw previewError("PREVIEW_REPORTS_INVALID", "A fixture preview needs one report per platform", "Pass each platform's report ZIP once.");
}
assertTargets(options.reports.map(report => report.target ?? platformTarget(report.platform)), "A fixture preview needs one report per target", "Pass each target's report ZIP once.");
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));
return { ...report, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: `${report.platform}.zip.enc` };
const target = report.target ?? platformTarget(report.platform);
return { ...report, target, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: target.id };
}));
const listing = reports.map(report => ({ platform: report.platform, path: `/_report/${reportDirectory}/${report.file}`,
...(report.changes === undefined ? {} : { changes: report.changes }), ...(report.device ? { device: report.device } : {}) }));
return deploySealedReports({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: `?platform=${report.platform}` })),
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
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) })),
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 } : {}) });
}
/**
* Report ZIPs on this machine behind one token (`capture:review --upload`, `report:upload`), one per platform: the same
* 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.
*/
export async function deployLocalReports(options: {
reports: Array<{ platform: ExplorePlatform; zip: Uint8Array; changes?: number; device?: string }>;
project: string; owner?: string; expiresAfterDays: number | null;
/** 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;
/** 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>;
transport?: typeof fetch; now?: () => number; random?: (bytes: number) => Uint8Array; verifyTimeoutMs?: number;
}): Promise<HostedDeployment> {
const environment = options.environment ?? process.env;
if (!options.reports.length || new Set(options.reports.map(report => report.platform)).size !== options.reports.length) {
throw previewError("PREVIEW_REPORTS_INVALID", "A local upload needs one report per platform", "Capture each platform once, then upload.");
}
assertTargets(options.reports.map(report => report.target ?? platformTarget(report.platform)), "A local upload needs one report per target", "Capture each target once, then upload.");
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
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 => ({ ...report, sha256: createHash("sha256").update(report.zip).digest("hex"), file: `${report.platform}.zip.enc` }));
const listing = reports.map(report => {
const device = report.device ? listingDevice(report.device) : "";
return { platform: report.platform, path: `/_report/${reportDirectory}/${report.file}`, ...(report.changes === undefined ? {} : { changes: report.changes }), ...(device ? { device } : {}) };
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 };
});
return deploySealedReports({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: `?platform=${report.platform}` })),
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
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) })),
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 });
}
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-(ios|android)$/;
/** explore-(capture|review)-<run>-<attempt>-<target id>; the id starts with a letter, so the run and attempt end unambiguously. */
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
/**
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<platform>
* directory under --inputs and each explore-review-… directory under --reports. Pairs them by platform and
* looks up each report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<target>
* directory under --inputs and each explore-review-… directory under --reports (the target is the platform for
* configs without targets). Pairs them by target, in the order the run's review lists its targets, and looks up each
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
*/
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch }): Promise<PreviewReportInput[]> {
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
const directories = async (root: string, kind: "capture" | "review") => {
const found = new Map<ExplorePlatform, string>();
const found = new Map<string, string>();
for (const name of (await readdir(root)).sort()) {
const match = ARTIFACT_DIRECTORY.exec(name);
if (!match || match[1] !== kind) continue;
if (found.has(match[2] as ExplorePlatform)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
if (!match || match[1] !== kind || !isTargetId(match[2])) continue;
if (found.has(match[2]!)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
found.set(match[2] as ExplorePlatform, join(root, name));
found.set(match[2]!, join(root, name));
}
return found;
};
const inputs = await directories(options.inputsPath, "capture"); const reports = await directories(options.reportsPath, "review");
if (!inputs.size) throw previewError("PREVIEW_REPORTS_MISSING", "No explore-capture-<run>-<attempt>-<platform> artifact was downloaded",
if (!inputs.size) throw previewError("PREVIEW_REPORTS_MISSING", "No explore-capture-<run>-<attempt>-<target> artifact was downloaded",
"Download this run's explore-capture artifacts into the --inputs directory before ci:deploy.");
if (inputs.size > 8) throw previewError("PREVIEW_REPORTS_INVALID", `${inputs.size} capture artifacts were downloaded; a run has at most 8 targets`,
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
const entries: PreviewReportInput[] = [];
for (const [platform, inputDirectory] of inputs) {
const reportPath = reports.get(platform);
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${platform} capture has no report artifact to deploy`,
"Rerun the workflow; the report job for that platform did not upload its explore-review artifact.");
entries.push({ platform, inputPath: join(inputDirectory, "report-input.json"), reportPath, artifactUrl: "" });
for (const [id, inputDirectory] of inputs) {
const reportPath = reports.get(id);
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${id} capture has no report artifact to deploy`,
"Rerun the workflow; the report job for that target did not upload its explore-review artifact.");
const inputPath = join(inputDirectory, "report-input.json");
const runtime = (await readCiReportInput(inputPath)).publicReview.runtime;
// A report from before targets names only its platform, and its artifact is named after it.
const named = readTarget(runtime.target);
if (named && named.id !== id) throw previewError("PREVIEW_REPORTS_INVALID", `The ${id} capture artifact holds the report of ${named.id}`,
"Download only this run attempt's artifacts, as the capture jobs named them.");
const target = named ?? (id === "ios" || id === "android" ? platformTarget(id) : { id, platform: runtime.platform ?? "ios", label: id });
entries.push({ ...(id === target.platform ? { platform: target.platform } : {}), target, inputPath, reportPath, artifactUrl: "" });
}
// Config order, as the review lists its targets (or, before targets, its platforms); directory order otherwise.
const listed = (await readCiReportInput(entries[0]!.inputPath)).publicReview.runtime;
const order: string[] = listed.targets?.map(target => target.id) ?? listed.platforms ?? [];
const rank = (entry: PreviewReportInput) => { const index = order.indexOf(entry.target!.id); return index === -1 ? order.length : index; };
entries.sort((a, b) => rank(a) - rank(b));
const review = (await readCiReportInput(entries[0]!.inputPath)).publicReview;
if (review.pullRequest.origin === "local") throw new Error("Local reports cannot be deployed as hosted previews");
const repository = review.pullRequest.repository;
@@ -665,7 +810,7 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
throw previewError("REPORT_INPUT_INVALID", "The report input does not name a GitHub run", "Use the report-input.json produced by this run's capture job.");
}
for (const entry of entries) {
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.platform}`;
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.target!.id}`;
const url = `https://api.github.com/repos/${repository}/actions/runs/${review.runId}/artifacts?per_page=100&name=${encodeURIComponent(name)}`;
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
@@ -673,7 +818,7 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
const artifact = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
if (!artifact || typeof artifact.id !== "number" || !Number.isSafeInteger(artifact.id) || artifact.id <= 0) {
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
"Rerun the workflow so every platform's report job uploads its artifact before the deploy job runs.", { retryable: true });
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true });
}
entry.artifactUrl = `https://github.com/${repository}/actions/runs/${review.runId}/artifacts/${artifact.id}`;
}
@@ -681,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 {
@@ -692,16 +837,46 @@ async function verifyDeployment(check: { origin: string; token: string; reports:
"Check EAS Hosting availability and rerun the deploy job.", { retryable: true, cause: error });
}
};
// 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 manifest = await get(`/p/${check.token}/manifest.json${expected.query}`);
const body = manifest.status === 200 ? await manifest.text() : "";
const served = expected.asset ? await get(`/p/${check.token}/${expected.asset}`) : undefined;
const assetBytes = served?.status === 200 ? new Uint8Array(await served.arrayBuffer()) : new Uint8Array();
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 } });
}
}
if (check.listing !== undefined) {
const list = await get(`/p/${check.token}/reports.json`);
const body = list.status === 200 ? await list.text() : "";
if (list.status !== 200 || body !== check.listing) return deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not list the targets that were deployed.",
"Rerun the deploy job; the deployment's report listing did not match.", { details: { status: list.status } });
}
return undefined;
};
const started = check.now();
let liveAfterMs = 0;
for (;;) {
// A browser's request: the token page negotiates, and anything that does not ask for HTML gets the Markdown index.
const shell = await get(`/p/${check.token}`, "text/html");
if (shell.status === 200 && (shell.headers.get("content-type") ?? "").startsWith("text/html")) { liveAfterMs = check.now() - started; break; }
const serving = shell.status === 200 && (shell.headers.get("content-type") ?? "").startsWith("text/html");
// An alias with a fixed token (the example report) serves the token page from the deployment it still points at, so
// it has moved only once it serves this deployment's listing and reports as well.
const stale = serving && check.alias ? await mismatch() : undefined;
if (serving && !stale) { liveAfterMs = check.now() - started; break; }
const waitedMs = check.now() - started;
if (waitedMs > check.timeoutMs) {
// An alias that does not serve the token page yet still points at an earlier deployment; the deployment itself not serving is a failed deployment.
if (check.alias) throw deployError("PREVIEW_ALIAS_BEHIND", `The alias ${check.origin} still answers HTTP ${shell.status} ${Math.round(waitedMs / 1000)} s after eas deploy returned.`,
if (check.alias) throw deployError("PREVIEW_ALIAS_BEHIND", stale
? `The alias ${check.origin} still serves an earlier deployment ${Math.round(waitedMs / 1000)} s after eas deploy returned.`
: `The alias ${check.origin} still answers HTTP ${shell.status} ${Math.round(waitedMs / 1000)} s after eas deploy returned.`,
"Nothing to do: the alias catches up on its own, and the next push verifies it again.", { retryable: true, details: { origin: check.origin, status: shell.status, waitedMs } });
throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview did not become available (HTTP ${shell.status}).`,
"Rerun the deploy job; if the deployment keeps failing verification, inspect it in the EAS Hosting dashboard.", { retryable: true, details: { origin: check.origin, status: shell.status, waitedMs } });
@@ -712,23 +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 });
}
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) {
throw 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 } });
}
}
if (check.listing !== undefined) {
const list = await get(`/p/${check.token}/reports.json`);
const body = list.status === 200 ? await list.text() : "";
if (list.status !== 200 || body !== check.listing) throw deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not list the platforms that were deployed.",
"Rerun the deploy job; the deployment's report listing did not match.", { details: { status: list.status } });
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}.`,
+75
View File
@@ -0,0 +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. `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 { 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)$/;
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. `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;
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)}}`;
}
/** 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);
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;
}
+34 -13
View File
@@ -1,7 +1,8 @@
import { createHash, randomBytes } from "node:crypto";
import { lstat, mkdir, readdir, readFile, rename, rm, writeFile } from "node:fs/promises";
import { join } from "node:path";
import type { ExplorePlatform } from "../config/explore-config.js";
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
import type { RunTarget } from "../types.js";
import type { ArtifactReport } from "../contracts/artifact-report.js";
import { EXPLORATION_REPORT_KIND, type ExplorationReport } from "../contracts/standalone-report.js";
import { exploreCacheRoot } from "../shared/cache-root.js";
@@ -12,7 +13,7 @@ import { strongerGroup, type ChangeGroup } from "./pr-comment-record.js";
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
/**
* Every report a run produces on this machine is kept under `<cache>/reports/<id>/`: one `<platform>.zip` per platform
* Every report a run produces on this machine is kept under `<cache>/reports/<id>/`: one `<target>.zip` per target
* (the same ZIP a hosted or local Viewer serves) and `run.json`, what `expo-explore reports` lists. Local reviews,
* explorations and uploaded reports land here, so a past run can be reopened or hosted without capturing it again.
* Runs older than 30 days, and the oldest beyond 2 GB, are pruned whenever a run is saved.
@@ -30,6 +31,8 @@ export type SavedRun = {
/** A local review of uncommitted changes: how many files differed from HEAD. */
uncommittedFiles?: number;
platforms: ExplorePlatform[];
/** The run's targets, in order; their ids name its ZIPs. Absent in runs saved before targets, whose ZIPs are named for `platforms`. */
targets?: RunTarget[];
device?: string;
/** Changed surfaces by group across the platforms, as the PR comment counts them. */
changes?: Partial<Record<ChangeGroup, number>>;
@@ -40,7 +43,15 @@ export type SavedRun = {
savedAt: string;
bytes: number;
};
export type SavedReport = { platform: ExplorePlatform; zip: Uint8Array; changes?: number; device?: string };
/** One report of a run. Without a target, it is the target named for its platform, as runs saved before targets were. */
export type SavedReport = { platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string };
const PLATFORM_LABELS: Record<ExplorePlatform, string> = { ios: "iOS", android: "Android" };
/** A report's target: its own, else the one named for its platform. */
export function reportTarget(report: Pick<SavedReport, "platform" | "target">): RunTarget {
return report.target ?? { id: report.platform, platform: report.platform, label: PLATFORM_LABELS[report.platform] };
}
export const SAVED_RUN_LIMITS = { maxAgeDays: 30, maxBytes: 2 * 1024 * 1024 * 1024 } as const;
const ID = /^[a-z0-9][a-z0-9._-]{0,119}$/;
@@ -84,14 +95,17 @@ export async function describeReports(reports: SavedReport[], extra: { subjects?
const first = parsed[0]?.content;
if (!first) throw new Error("Not an Explore report ZIP");
const createdAt = extra.createdAt ?? new Date().toISOString();
const platforms = parsed.map(entry => entry.report.platform);
const platforms = [...new Set(parsed.map(entry => entry.report.platform))];
// Targets named for their platforms describe a run saved the old way, which older versions can still read.
const targets = reports.map(reportTarget);
const named = targets.some(target => target.id !== target.platform) ? { targets } : {};
if (first.file === "exploration.json") {
const report = first.json as Partial<ExplorationReport>;
if (report.kind !== EXPLORATION_REPORT_KIND || !report.exploration || !report.map) throw new Error("Not an Explore exploration report");
const { app, device } = report.exploration;
const zipHash = createHash("sha256").update(reports[0]!.zip).digest("hex").slice(0, 10);
return { id: `explore-${slug(app.name, 40)}-${zipHash}`, kind: "exploration", title: `${app.name}${app.version ? ` ${app.version}` : ""}${app.buildNumber ? ` (${app.buildNumber})` : ""} on ${device.model}`,
platforms, device: `${device.model} ${device.osVersion}`.trim(),
platforms, ...named, device: `${device.model} ${device.osVersion}`.trim(),
explored: { app: app.name, ...(app.version ? { version: app.version } : {}), ...(app.buildNumber ? { buildNumber: app.buildNumber } : {}),
screens: report.map.screens.length, unexplored: report.coverage?.frontier.pending ?? 0 },
createdAt: report.exploration.completedAt ?? createdAt };
@@ -117,7 +131,7 @@ export async function describeReports(reports: SavedReport[], extra: { subjects?
: `${kind === "compare" ? "compare" : `pr-${number}`}-${slug(pr.repository.split("/").at(-1) ?? "", 40)}-${slug(review.runId, 40)}-${slug(String(review.runAttempt), 8)}`;
const commit = (side: "head" | "base"): SavedCommit => ({ ref: pr[side].ref, sha: pr[side].sha, ...(extra.subjects?.[side] ? { subject: extra.subjects[side] } : {}) });
return { id, kind, title: pr.title, repository: pr.repository, ...(number === undefined ? {} : { number }), head: commit("head"), base: commit("base"),
...(extra.uncommittedFiles ? { uncommittedFiles: extra.uncommittedFiles } : {}), platforms, ...(devices.length ? { device: devices.join(", ") } : {}),
...(extra.uncommittedFiles ? { uncommittedFiles: extra.uncommittedFiles } : {}), platforms, ...named, ...(devices.length ? { device: devices.join(", ") } : {}),
changes, createdAt: review.createdAt ?? createdAt };
}
@@ -135,10 +149,13 @@ export async function saveRun(reports: SavedReport[], extra: Parameters<typeof d
const kept = await findSavedRun(described.id, environment);
if (kept && described.kind !== "exploration" && kept.kind === described.kind && kept.repository === described.repository
&& kept.head?.sha === described.head?.sha && kept.base?.sha === described.base?.sha) {
const others = (await readSavedReports(kept, environment).catch(() => [] as SavedReport[])).filter(report => !reports.some(each => each.platform === report.platform));
const others = (await readSavedReports(kept, environment).catch(() => [] as SavedReport[])).filter(report => !reports.some(each => reportTarget(each).id === reportTarget(report).id));
if (others.length) {
const order: ExplorePlatform[] = ["ios", "android"];
reports = [...reports, ...others].sort((a, b) => order.indexOf(a.platform) - order.indexOf(b.platform));
// The targets' own order when the reports name it; iOS before Android for reports from before targets.
const order = (await Promise.all([...reports, ...others].map(async report => ((await reportJson(report.zip))?.json as Partial<ArtifactReport> | undefined)?.review?.runtime?.targets)))
.find(list => Array.isArray(list))?.map(target => target.id) ?? ["ios", "android"];
const rank = (report: SavedReport) => { const index = order.indexOf(reportTarget(report).id); return index < 0 ? order.length : index; };
reports = [...reports, ...others].sort((a, b) => rank(a) - rank(b));
const subjects = { ...(kept.head?.subject ? { head: kept.head.subject } : {}), ...(kept.base?.subject ? { base: kept.base.subject } : {}), ...extra.subjects };
described = await describeReports(reports, { ...extra, subjects, ...(kept.uncommittedFiles && !extra.uncommittedFiles ? { uncommittedFiles: kept.uncommittedFiles } : {}) });
}
@@ -147,7 +164,7 @@ export async function saveRun(reports: SavedReport[], extra: Parameters<typeof d
const run = cleanRun({ version: 1, ...described, savedAt: new Date(now).toISOString(), bytes: reports.reduce((total, report) => total + report.zip.byteLength, 0) });
try {
await mkdir(staged);
for (const report of reports) await writeFile(join(staged, `${report.platform}.zip`), report.zip);
for (const report of reports) await writeFile(join(staged, `${reportTarget(report).id}.zip`), report.zip);
await writeFile(join(staged, "run.json"), `${JSON.stringify(run, null, 2)}\n`);
await rm(target, { recursive: true, force: true });
await rename(staged, target);
@@ -161,8 +178,11 @@ export async function saveRun(reports: SavedReport[], extra: Parameters<typeof d
function validRun(value: unknown, id: string): SavedRun | undefined {
const run = value as Partial<SavedRun> | undefined;
if (!run || run.version !== 1 || run.id !== id || typeof run.title !== "string" || typeof run.bytes !== "number") return undefined;
// Platforms name the ZIP files read back, so only the two there are.
// Targets (else platforms) name the ZIP files read back, so only valid ids.
if (!Array.isArray(run.platforms) || !run.platforms.length || run.platforms.some(platform => platform !== "ios" && platform !== "android")) return undefined;
if (run.targets !== undefined && (!Array.isArray(run.targets) || !run.targets.length || run.targets.some(target => !target || !isTargetId(target.id)
|| (target.platform !== "ios" && target.platform !== "android") || typeof target.label !== "string")
|| new Set(run.targets.map(target => target.id)).size !== run.targets.length)) return undefined;
if (!["local", "pull-request", "compare", "exploration"].includes(run.kind ?? "") || Number.isNaN(Date.parse(run.createdAt ?? "")) || Number.isNaN(Date.parse(run.savedAt ?? ""))) return undefined;
return run as SavedRun;
}
@@ -188,10 +208,11 @@ export async function findSavedRun(idOrLatest: string, environment: NodeJS.Proce
return idOrLatest === "latest" ? runs[0] : runs.find(run => run.id === idOrLatest);
}
/** A saved run's reports, in the order the run lists its platforms, labelled for a Viewer's platform switch. */
/** A saved run's reports, in the order the run lists its targets, labelled for a Viewer's target switch. */
export async function readSavedReports(run: SavedRun, environment: NodeJS.ProcessEnv = process.env): Promise<SavedReport[]> {
const root = join(savedRunsDirectory(environment), run.id);
return Promise.all(run.platforms.map(async platform => ({ platform, zip: new Uint8Array(await readFile(join(root, `${platform}.zip`))) })));
const targets = run.targets ?? run.platforms.map(platform => reportTarget({ platform }));
return Promise.all(targets.map(async target => ({ platform: target.platform, target, zip: new Uint8Array(await readFile(join(root, `${target.id}.zip`))) })));
}
export async function removeSavedRun(id: string, environment: NodeJS.ProcessEnv = process.env): Promise<boolean> {
+22 -5
View File
@@ -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;
@@ -50,9 +50,23 @@ export type ViewerLinkInput = {
runAttempt: string;
/** Set by the matrix workflows; the Viewer then downloads the platform-suffixed report artifact. */
platform?: "ios" | "android";
/** The capture target's id when the run captures several (wins over `platform`); the artifact is suffixed with it. */
target?: string;
configPath: string;
};
/** The target id grammar (TARGET_ID_PATTERN, minus the names isTargetId reserves). */
const TARGET_ID = /^[a-z][a-z0-9-]{0,31}$/;
/**
* The query parameter that selects a target's report: `platform=<id>` for a target named after its platform, so links for
* configs without targets stay byte-identical and old Workers and Viewers still read them; `target=<id>` for any other.
*/
export function targetParameter(id: string): ["platform" | "target", string] {
if (!TARGET_ID.test(id) || ["base", "head", "report"].includes(id) || id.startsWith("install-")) throw new Error("target id is invalid");
return [id === "ios" || id === "android" ? "platform" : "target", id];
}
const SAFE_ID = /^[A-Za-z0-9._-]{1,200}$/;
// A secondary appearance surface is `<route>@<scheme>` (see schemeScreenId).
const SURFACE_ID = /^[A-Za-z0-9._-]{1,200}(@(light|dark))?$/;
@@ -77,16 +91,17 @@ function repositoryPath(repository: string): string {
const PREVIEW_PATH = /^\/p\/[a-z2-7]{32}$/;
/** Deep links on a verified preview URL (`https://<project>--<id>.expo.app/p/<token>`), same grammar as the central Viewer. */
export function previewLinks(previewUrl: string, expiresAt: number | null, platform?: "ios" | "android"): PreviewLinks {
export function previewLinks(previewUrl: string, expiresAt: number | null, target?: string): PreviewLinks {
const url = safeHttpUrl(previewUrl, "preview URL");
if (url.protocol !== "https:" || url.search || url.hash || !PREVIEW_PATH.test(url.pathname)) {
throw new Error("preview URL must be an https token page without a query or fragment");
}
if (expiresAt !== null && (!Number.isFinite(expiresAt) || expiresAt <= 0)) throw new Error("preview expiry must be a timestamp or null");
const selection = target ? targetParameter(target) : undefined;
const make = (params: Record<string, string> = {}) => {
const link = new URL(url.href);
// Several platforms share one token page; `platform` picks this report's archive.
if (platform) link.searchParams.set("platform", platform);
// Several targets share one token page; `platform` or `target` picks this report's archive.
if (selection) link.searchParams.set(...selection);
for (const [key, value] of Object.entries(params)) link.searchParams.set(key, value);
return link.href;
};
@@ -107,6 +122,8 @@ export function viewerLinks(input: ViewerLinkInput): ViewerLinks {
throw new Error("configPath must be a relative repository path");
}
const repository = `https://github.com/${repositoryPath(input.repository)}`;
const targetId = input.target ?? input.platform;
const selection = targetId ? targetParameter(targetId) : undefined;
const artifact = input.artifactUrl ? safeHttpUrl(input.artifactUrl, "artifact URL") : undefined;
if (artifact && (artifact.origin !== "https://github.com" || artifact.search || artifact.hash
|| !new RegExp(`^/${repositoryPath(input.repository).replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}/actions/runs/${input.runId}/artifacts/[1-9][0-9]*$`).test(artifact.pathname))) {
@@ -119,7 +136,7 @@ export function viewerLinks(input: ViewerLinkInput): ViewerLinks {
url.searchParams.set("repo", input.repository);
url.searchParams.set("run", input.runId);
url.searchParams.set("attempt", input.runAttempt);
if (input.platform) url.searchParams.set("platform", input.platform);
if (selection) url.searchParams.set(...selection);
url.searchParams.set("artifact", artifact.pathname.split("/").at(-1)!);
for (const [key, value] of Object.entries(params)) url.searchParams.set(key, value);
return url.href;
+1 -1
View File
@@ -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.
*/
+20 -2
View File
@@ -1,9 +1,10 @@
import type { RunTarget } from "../types.js";
import { appearancePairs, bundleColorSchemes, routeIdOfScreen } from "../capture/appearance.js";
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";
@@ -259,11 +260,20 @@ export type CaptureReviewOptions = {
app?: { version?: string; buildNumber?: string };
/** The platforms config.yaml captures (this report's platform among them), when more than one. */
platforms?: Array<"ios" | "android">;
/** 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)}`;
@@ -284,6 +294,10 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
? sourceImpactKinds(surface.sourceChange.files.map((file) => file.relation))
: []
);
// Each controller reads and drives the device its own way; a review compares captures made the same way.
if ((head.bundle.controller ?? "agent-device") !== (base.bundle.controller ?? "agent-device")) {
throw new Error(`The base was captured with ${base.bundle.controller ?? "agent-device"} and the head with ${head.bundle.controller ?? "agent-device"}; capture both sides with the same controller.`);
}
const colorSchemes = bundleColorSchemes(head.bundle);
const baseColorSchemes = bundleColorSchemes(base.bundle);
const review: PublicReview = {
@@ -291,9 +305,12 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
runId: options.runId, runAttempt: options.runAttempt,
...(plan.navigation ? { navigation: plan.navigation } : {}),
runtime: { projectId: head.bundle.easProjectId ?? "", buildId: head.bundle.easBuildId ?? "", gitCommit: plan.headSha,
platform: head.bundle.platform ?? "ios", statusBarBandPercent: statusBarBandPercent(head.bundle.platform),
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 })) } : {}),
...(colorSchemes.length > 1 ? { colorSchemes: [...colorSchemes] } : {}),
...(head.bundle.runtimeProfile ? { device: { model: head.bundle.runtimeProfile.deviceModel, osVersion: head.bundle.runtimeProfile.osVersion } } : {}),
...(head.bundle.appName?.trim() ? { appName: head.bundle.appName.trim() } : {}),
@@ -331,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 } : {}),
+284 -57
View File
@@ -1,6 +1,6 @@
import { unattributedIssue } from "../capture/health.js";
import { appearancePairs, bundleColorSchemes } from "../capture/appearance.js";
import { homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
import { appearancePairs, bundleColorSchemes, type ColorScheme } from "../capture/appearance.js";
import { launchSurfaceId, systemRegions as defaultSystemRegions, type SystemRegion } from "../contracts/capture.js";
import { readFileSync, statSync } from "node:fs";
import { stat } from "node:fs/promises";
import { isAbsolute, resolve } from "node:path";
@@ -26,7 +26,10 @@ import {
type VisualEvidenceAssessment,
} from "./visual-evidence.js";
import { AGENT_DEVICE_VERSION } from "../shared/agent-device-version.js";
import { STATUS_BAR_BAND_PERCENT } from "../shared/png-evidence.js";
import { STATUS_BAR_BAND_PERCENT, decodePng, differentPixelsInRect, maxColorDistance, type DecodedFrame } from "../shared/png-evidence.js";
import type { RegionMove, RegionShift } from "./region-shift.js";
import { measureRegionMovesInWorker } from "./region-shift-worker.js";
import { availableParallelism } from "node:os";
export const DEFAULT_VISUAL_THRESHOLD = 0.1;
export const DEFAULT_EVIDENCE_TIME_BUDGET_MS = 10 * 60_000;
@@ -141,37 +144,177 @@ 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, 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, moves, width, height } = await measureRegionMovesInWorker(basePath, headPath,
all.map(region => ({ ...region.rect, dominantChange: region.dominantChange })));
if (moves.length) return publishMeasuredRegions(all, shifts, moves, width, height);
const shiftOf = new Map(all.map((region, index) => [region.rect, shifts[index]] as const));
return {
regions: published.map(region => {
const shift = shiftOf.get(region.rect);
return shift ? { ...region, shift } : region;
}),
...(all.length > 0 && shifts.every(Boolean) ? { allRegionsMoved: true as const } : {}),
};
} catch {
return { regions: published };
}
}
/** Remove status-bar-only diff regions from a measurement and recompute its verdict inputs. */
export function ignoreStatusBar(measurement: ScreenshotDiffMeasurement, bandPercent: number = STATUS_BAR_BAND_PERCENT): { measurement: ScreenshotDiffMeasurement; ignored: number } {
const bands = ignoreSystemBands(measurement, { top: bandPercent, bottom: 0 });
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,
},
};
}
@@ -265,6 +408,40 @@ function impactFor(surface: PlanSurface, presence: ComparatorSurfaceImpact["pres
};
}
/** The screenshot pairs `assessPublicEvidence` compares: both sides captured and landed, in the loop's order. */
function comparablePairs(options: { plan: SourceCapturePlan; base: PublicEvidenceSide; head: PublicEvidenceSide }, colorSchemes: readonly ColorScheme[],
baseColorSchemes: readonly ColorScheme[]): Array<{ id: string; basePath: string; headPath: string }> {
const pairs: Array<{ id: string; basePath: string; headPath: string }> = [];
for (const surface of options.plan.surfaces) {
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen" || (!surface.baseCapture && !surface.headCapture)) continue;
for (const { id, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
if (baseId === null) continue;
const basePath = localImagePath(options.base, baseId);
const headPath = localImagePath(options.head, id);
if (!basePath || !headPath || captureDiagnostic(surface, "base", options.base, baseId) || captureDiagnostic(surface, "head", options.head, id)) continue;
pairs.push({ id, basePath, headPath });
}
}
return pairs;
}
/** Runs tasks at most `size` at a time, each started in the order it was queued. */
function concurrencyLimit(size: number): <T>(task: () => Promise<T>) => Promise<T> {
let active = 0;
const queue: Array<() => void> = [];
const next = () => { if (active < size) queue.shift()?.(); };
return task => new Promise((resolve, reject) => {
queue.push(() => {
active += 1;
task().then(resolve, reject).finally(() => { active -= 1; next(); });
});
next();
});
}
/** The limit the reviews in this process share when none is given: a local review compares its targets at once. */
let processLimit: ReturnType<typeof concurrencyLimit> | undefined;
function localImagePath(side: PublicEvidenceSide, id: string): string | undefined {
const frame = side.bundle.images[id];
return frame ? localEvidencePath(side, frame.path) : undefined;
@@ -285,19 +462,21 @@ function localEvidencePath(side: PublicEvidenceSide, relativePath: string): stri
*/
export function decideReview(scope: SurfaceSourceScope, visual: PublicVisualVerdict, summary?: WhatChangedSummary): PublicSurfaceReview {
const facts = summary?.facts.map((fact) => ({ category: fact.category, templateId: fact.templateId, bullet: truncate(fact.bullet) })) ?? [];
const differs = visual.verdict === "modified" || facts.length > 0;
// Text that also differs between two captures of the same build is runtime state: listed, never what makes a change.
const changes = facts.filter((fact) => fact.templateId !== "visible-text.unstable-within-build");
const differs = visual.verdict === "modified" || changes.length > 0;
const inconclusive = !differs && (visual.verdict === "needs-review" || Boolean(summary?.needsReview));
const issue = summary?.reviewIssues[0]?.reason;
const evidenceText = facts[0]?.bullet ?? visualDescription(visual);
const evidenceText = changes[0]?.bullet ?? visualDescription(visual);
if (scope === "none") {
if (!differs) return { status: "unchanged", description: "No visible change" };
// The comparator's generic visual fact reads as a styling change; a variant names what differs.
const state = facts.find((fact) => fact.category !== "visual")?.bullet
const state = [...changes, ...facts].find((fact) => fact.category !== "visual")?.bullet
?? `${percentage(visual.mismatchPercentage)}${visual.regions?.[0]?.location ? ` · ${visual.regions[0].location}` : ""}`;
return { status: "variant", description: truncate(`Runtime state differs: ${state}`), ...(facts.length ? { facts } : {}) };
}
if (differs) {
const description = !facts.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
const description = !changes.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
return { status: "modified", description: truncate(description), ...(facts.length ? { facts } : {}) };
}
if (inconclusive) {
@@ -345,6 +524,8 @@ function captureDiagnostic(surface: PlanSurface, side: "base" | "head", evidence
export async function assessPublicEvidence(options: {
/** The captured platform; its status bar band is left out of the visual verdict. Absent: iOS. */
platform?: "ios" | "android";
/** The system-drawn areas left out of the visual verdict; absent, the platform's bands. */
systemRegions?: SystemRegion[];
plan: SourceCapturePlan;
base: PublicEvidenceSide;
head: PublicEvidenceSide;
@@ -354,8 +535,11 @@ export async function assessPublicEvidence(options: {
timeBudgetMs?: number;
now?: () => number;
measure?: (baselinePath: string, currentPath: string) => Promise<ScreenshotDiffMeasurement>;
/** How many screenshot pairs compare at once. Absent: one per available CPU, shared by every review in this process. */
concurrency?: number;
}): Promise<PublicEvidenceResult> {
const threshold = options.threshold ?? DEFAULT_VISUAL_THRESHOLD;
const system = options.systemRegions ?? defaultSystemRegions({ platform: options.platform });
const now = options.now ?? Date.now;
const deadline = now() + (options.timeBudgetMs ?? DEFAULT_EVIDENCE_TIME_BUDGET_MS);
const surfaces: Record<string, PublicSurfaceAssessment> = {};
@@ -371,6 +555,34 @@ export async function assessPublicEvidence(options: {
const measure = options.measure ?? (async (baselinePath: string, currentPath: string) => (
await diffScreenshots({ baselinePath, currentPath, command: options.agentDeviceCommand, threshold })
));
type ComparedPair = { visual: PublicVisualVerdict; assessment: VisualEvidenceAssessment };
/** One pair's measurement, verdict and region moves: the work that runs ahead of the surface loop. */
const comparePair = async (basePath: string, headPath: string): Promise<ComparedPair> => {
const raw = await measure(basePath, headPath);
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
const assessment = assessVisualMeasurements({
baselineSamples: 1,
currentSamples: 1,
requiredSamples: 1,
baselineWithin: [],
currentWithin: [],
crossBuild: [measurement],
representative: measurement,
});
const visual = visualVerdict(assessment, threshold);
// Measuring moves is extra: once the comparison budget is spent, regions go out unmeasured.
if (visual.verdict === "modified" && visual.regions?.length && now() <= deadline) {
Object.assign(visual, await withRegionShifts(basePath, headPath, measurement.regions, visual.regions));
}
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
return { visual, assessment };
};
/** A pair compared if the budget has not expired when its turn to start comes; undefined when it has. */
const compareInBudget = async (basePath: string, headPath: string): Promise<ComparedPair | undefined> => (
now() > deadline ? undefined : await comparePair(basePath, headPath)
);
const visualCounts = { compared: 0, modified: 0, unchanged: 0, needsReview: 0, failed: 0, errors: [] as string[] };
const accessibilityCounts = { compared: 0, described: 0, failed: 0, skipped: 0, errors: [] as string[] };
const reviewCounts = { modified: 0, needsReview: 0, variants: 0, unchanged: 0 };
@@ -387,6 +599,20 @@ export async function assessPublicEvidence(options: {
const colorSchemes = bundleColorSchemes(options.head.bundle);
const baseColorSchemes = bundleColorSchemes(options.base.bundle);
// The pairs the loop below compares start now, a few at a time: each is a comparator process and a pixel search
// that take seconds on a large screenshot, so they overlap instead of queueing behind one another. The loop reads
// them in its own order, so the result does not depend on which finishes first. A pair whose turn comes after the
// budget expired is not started; one started in time is waited for and used.
const ahead = new Map<string, Promise<ComparedPair | undefined>>();
if (visualAvailable) {
const limit = options.concurrency !== undefined ? concurrencyLimit(Math.max(1, Math.floor(options.concurrency)))
: processLimit ??= concurrencyLimit(availableParallelism());
for (const { id, basePath, headPath } of comparablePairs(options, colorSchemes, baseColorSchemes)) {
const started = limit(() => compareInBudget(basePath, headPath));
started.catch(() => undefined);
ahead.set(id, started);
}
}
for (const surface of options.plan.surfaces) {
for (const side of ["base", "head"] as const) {
if (!surface[`${side}Capture`] || surface[`${side}Surface`]?.kind !== "screen") continue;
@@ -415,7 +641,19 @@ export async function assessPublicEvidence(options: {
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen"
|| (!surface.baseCapture && !surface.headCapture)) continue;
// Every appearance the capture rendered is compared like-for-like: `<id>@<scheme>` frames against each other.
for (const { id, scheme, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
const pairs = appearancePairs(surface.id, colorSchemes, baseColorSchemes);
// The screen's other appearances, rendered by both builds and verified on both: a label that varies between a
// build's own appearances is runtime state. An unverified capture may show another screen, so it is no evidence.
const baseRoute = surface.baseSurface, headRoute = surface.headSurface;
const siblings = (current: string) => pairs.flatMap((pair) => {
if (pair.id === current || pair.baseId === null || captureDiagnostic(surface, "base", options.base, pair.baseId)
|| captureDiagnostic(surface, "head", options.head, pair.id)) return [];
try {
return [{ base: matchedSide("base", options.base, { ...baseRoute, id: pair.baseId }, options.profile),
head: matchedSide("head", options.head, { ...headRoute, id: pair.id }, options.profile) }];
} catch { return []; }
});
for (const { id, scheme, baseId } of pairs) {
// An appearance the base never rendered has nothing to compare against: the head frame is new evidence.
if (baseId === null) {
if (localImagePath(options.head, id)) {
@@ -440,43 +678,29 @@ export async function assessPublicEvidence(options: {
continue;
}
let visual: PublicVisualVerdict;
let assessment: VisualEvidenceAssessment | undefined;
if (now() > deadline) {
let compared: ComparedPair | undefined;
try {
compared = await (ahead.get(id) ?? compareInBudget(basePath, headPath));
} catch (error) {
visualCounts.failed += 1;
const diagnostic = comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
message: "Screenshot comparison failed.", nextAction: "Check the screenshot files and the agent-device comparison diagnostics, then rerun comparison.", retryable: true });
recordError(visualCounts.errors, id, diagnostic.message);
continue;
}
if (!compared) {
visualCounts.failed += 1;
const diagnostic = comparisonError(id, undefined, { code: "VISUAL_COMPARISON_BUDGET_EXHAUSTED", stage: "compare",
message: "The time budget expired before screenshot comparison.",
nextAction: "Increase the evidence comparison time budget or reduce the number of selected routes, then rerun comparison.", retryable: true });
recordError(visualCounts.errors, id, diagnostic.message);
continue;
} else {
try {
const raw = await measure(basePath, headPath);
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
assessment = assessVisualMeasurements({
baselineSamples: 1,
currentSamples: 1,
requiredSamples: 1,
baselineWithin: [],
currentWithin: [],
crossBuild: [measurement],
representative: measurement,
});
visual = visualVerdict(assessment, threshold);
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
visualCounts.compared += 1;
if (visual.verdict === "modified") visualCounts.modified += 1;
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
else visualCounts.needsReview += 1;
} catch (error) {
visualCounts.failed += 1;
const diagnostic = comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
message: "Screenshot comparison failed.", nextAction: "Check the screenshot files and the agent-device comparison diagnostics, then rerun comparison.", retryable: true });
recordError(visualCounts.errors, id, diagnostic.message);
continue;
}
}
const { visual, assessment } = compared;
visualCounts.compared += 1;
if (visual.verdict === "modified") visualCounts.modified += 1;
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
else visualCounts.needsReview += 1;
const scope = surfaceSourceScope(surface) ?? "none";
let review: PublicSurfaceReview | undefined;
@@ -487,6 +711,7 @@ export async function assessPublicEvidence(options: {
base: matchedSide("base", options.base, { ...surface.baseSurface, id: baseId }, options.profile),
head: matchedSide("head", options.head, { ...surface.headSurface, id }, options.profile),
visualAssessment: assessment,
siblings: siblings(id),
});
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
accessibilityCounts.compared += 1;
@@ -516,11 +741,13 @@ export async function assessPublicEvidence(options: {
const basePath = localEvidencePath(options.base, baseLaunch.splash.path); const headPath = localEvidencePath(options.head, headLaunch.splash.path);
if (!basePath || !headPath) continue;
try {
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(await measure(basePath, headPath), { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) });
const raw = await measure(basePath, headPath);
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
const visual = visualVerdict(assessVisualMeasurements({ baselineSamples: 1, currentSamples: 1, requiredSamples: 1,
baselineWithin: [], currentWithin: [], crossBuild: [measurement], representative: measurement }), threshold);
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
surfaces[id] = { visual };
} catch (error) {
comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
+114 -8
View File
@@ -17,7 +17,7 @@ import type {
ObservedElement,
Screen,
} from "../types.js";
import type { VisualEvidenceAssessment } from "./visual-evidence.js";
import type { VisualDiffRegion, VisualEvidenceAssessment } from "./visual-evidence.js";
import { CAPTURE_OBSERVER_IDENTIFIER, parseCaptureDestination } from "../capture/observer.js";
export type StableReviewerElementAnnotation = {
@@ -70,6 +70,11 @@ export type CommonSurfaceComparatorInput = {
visualAssessment: VisualEvidenceAssessment;
/** Explicit stable runtime scope; semantic meaning is never inferred from diff pixels. */
visualScope?: VisualReviewerChange["scope"];
/**
* The screen's other appearances, captured and verified on both builds. A label that varies between each build's own
* captures, in the words that differ between the builds, is runtime state, and its difference is reported as such.
*/
siblings?: readonly { base: MatchedSurfaceSide; head: MatchedSurfaceSide }[];
};
export type EvidenceComparatorInput =
@@ -139,6 +144,7 @@ const CHANGE_PRIORITY: Record<SupportedReviewerChange["kind"], number> = {
"element-added": 20,
"element-removed": 20,
"visible-text-changed": 30,
"unstable-text": 35,
"action-target-changed": 40,
"accessibility-label-changed": 50,
"accessibility-role-changed": 50,
@@ -772,10 +778,76 @@ function actionTarget(side: ResolvedSide, element: ObservedElement): ActionTarge
return target ? { kind: "target", target } : { kind: "none", evidenceRefs: [] };
}
type ResolvedSibling = { base: ResolvedSide; head: ResolvedSide };
function resolveSiblings(input: CommonSurfaceComparatorInput, requiredSamples: 1 | 3): ResolvedSibling[] {
const resolve = (side: "base" | "head", sibling: MatchedSurfaceSide) => {
const screenId = sibling.map.observations.find((candidate) => candidate.id === sibling.observationId)?.screenId;
const resolution = screenId === undefined ? undefined : resolveSide(side, sibling, { ...input.impact, id: screenId }, requiredSamples);
// A sibling is evidence only when it resolves as cleanly as a comparison would.
return resolution?.kind === "resolved" && resolution.side.issues.length === 0 ? resolution.side : undefined;
};
return (input.siblings ?? []).flatMap((sibling) => {
const base = resolve("base", sibling.base);
const head = resolve("head", sibling.head);
return base && head ? [{ base, head }] : [];
});
}
function sameBounds(left: ElementBounds | undefined, right: ElementBounds | undefined): boolean {
return !!left && !!right && left.x === right.x && left.y === right.y && left.width === right.width && left.height === right.height;
}
/** The element at the same place in another capture: the one of its role with its identifier or, without one, its bounds. */
function counterpart(element: ObservedElement, other: ResolvedSide): ObservedElement | undefined {
const identifier = compact(element.identifier ?? "");
const bounds = boundsOf(element);
const candidates = other.elements.filter((candidate) => candidate.role === element.role && (identifier
? compact(candidate.identifier ?? "") === identifier
: !compact(candidate.identifier ?? "") && sameBounds(bounds, boundsOf(candidate))));
return candidates.length === 1 ? candidates[0] : undefined;
}
/** The word positions at which two labels differ, or undefined when they have different numbers of words. */
function changedWords(left: string, right: string): number[] | undefined {
const leftWords = left.split(" ");
const rightWords = right.split(" ");
return leftWords.length === rightWords.length
? leftWords.flatMap((word, index) => word === rightWords[index] ? [] : [index])
: undefined;
}
/**
* What the head showed in its other appearance, when a label's difference between the builds is runtime state: each
* build shows the label differently in its own two appearances, the other appearance differs between the builds too,
* and every word that differs between the builds is one that varies within a build. A label that follows the
* appearance ("Switch to dark mode") does not vary within a build that broke it, or keeps a word that changed, so
* its change is still a change.
*/
function unstableWithin(base: ObservedElement, head: ObservedElement, siblings: readonly ResolvedSibling[]): string | undefined {
const baseLabel = compact(base.label);
const headLabel = compact(head.label);
for (const sibling of siblings) {
const baseOther = compact(counterpart(base, sibling.base)?.label ?? "");
const headOther = compact(counterpart(head, sibling.head)?.label ?? "");
if (!baseLabel || !headLabel || !baseOther || !headOther) continue;
const withinBase = changedWords(baseLabel, baseOther);
const withinHead = changedWords(headLabel, headOther);
const across = changedWords(baseLabel, headLabel);
const acrossOther = changedWords(baseOther, headOther);
if (!withinBase?.length || !withinHead?.length || !across?.length || !acrossOther?.length) continue;
const varying = new Set([...withinBase, ...withinHead]);
if ([...across, ...acrossOther].every((index) => varying.has(index))) return headOther;
}
return undefined;
}
function comparePair(
pair: ElementPair,
base: ResolvedSide,
head: ResolvedSide,
/** What the head showed in its other appearance when this element's label is runtime state. */
within?: string,
): { facts: SupportedInput[]; issues: IssueInput[] } {
const facts: SupportedInput[] = [];
const issues: IssueInput[] = [];
@@ -784,6 +856,10 @@ function comparePair(
const headLabel = compact(pair.head.label);
const baseAnnotation = base.annotationsByElementId.get(pair.base.elementId);
const headAnnotation = head.annotationsByElementId.get(pair.head.elementId);
// Runtime state replaces a label change only where the label comparison itself holds: provenance still decides first.
const labelChange = (change: SupportedReviewerChange): SupportedReviewerChange => within
? { kind: "unstable-text", subjectRole: reviewerRole(pair.head.role), before: baseLabel, after: headLabel, within }
: change;
if (baseLabel !== headLabel) {
if (baseAnnotation && headAnnotation) {
@@ -793,14 +869,14 @@ function comparePair(
} else if (!baseLabel || !headLabel) {
issues.push(inconclusive("Visible-title comparison is missing before or after text.", refs));
} else {
facts.push(supported({
facts.push(supported(labelChange({
kind: "visible-text-changed",
subjectRole: subject.subjectRole,
subjectLabel: subject.subjectLabel,
textKind: pair.head.role === "button" ? "title" : "label",
before: baseLabel,
after: headLabel,
}, refs));
}), refs));
}
} else if (baseAnnotation || headAnnotation) {
issues.push(inconclusive(
@@ -810,12 +886,12 @@ function comparePair(
} else if (!baseLabel || !headLabel) {
issues.push(inconclusive("Accessibility label comparison is missing before or after text.", refs));
} else {
facts.push(supported({
facts.push(supported(labelChange({
kind: "accessibility-label-changed",
subjectRole: reviewerRole(pair.head.role),
before: baseLabel,
after: headLabel,
}, refs));
}), refs));
}
}
if (pair.base.role !== pair.head.role) {
@@ -925,11 +1001,20 @@ function visualFact(
fact: supported({ kind: "visual-changed", scope: { kind: "landmark", label } }, refs),
};
}
const near = nearEdge(input.visualAssessment.representative?.regions ?? []);
return {
fact: supported({ kind: "visual-changed", scope: { kind: "main-content" } }, refs),
fact: supported({ kind: "visual-changed", scope: { kind: "main-content", ...(near ? { near } : {}) } }, refs),
};
}
/** Which edge every diff region hugs, when all of them sit in the outer 12 % of the frame: not "the main content". */
function nearEdge(regions: readonly VisualDiffRegion[]): "top" | "bottom" | undefined {
if (regions.length === 0) return undefined;
if (regions.every((region) => region.normalizedRect.y + region.normalizedRect.height <= 12)) return "top";
if (regions.every((region) => region.normalizedRect.y >= 88)) return "bottom";
return undefined;
}
function comparisonForAdded(head: RuntimeEvidence): RuntimeEvidenceComparison {
return {
contract: RUNTIME_EVIDENCE_COMPARISON_CONTRACT,
@@ -1101,6 +1186,27 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
gone = base.elements.filter(element => content(element, headWords));
arrived = head.elements.filter(element => content(element, baseWords));
}
// Text without an identifier is matched by its label, so a label that changed on its own leaves as one element and
// arrives as another: the one of its role at the same place on both sides is runtime state when its label is.
const siblings = mixedBackends ? [] : resolveSiblings(input, input.impact.baseSamples);
const runtimeText = { base: new Set<string>(), head: new Set<string>() };
for (const removed of siblings.length ? specificByLabel(gone) : []) {
const added = counterpart(removed, head);
if (!added || !arrived.includes(added) || counterpart(added, base) !== removed) continue;
const within = unstableWithin(removed, added, siblings);
if (!within) continue;
runtimeText.base.add(compact(removed.label));
runtimeText.head.add(compact(added.label));
facts.push(supported({
kind: "unstable-text",
subjectRole: reviewerRole(added.role),
before: compact(removed.label),
after: compact(added.label),
within,
}, [elementRef("base", removed), elementRef("head", added)]));
}
gone = gone.filter((element) => !runtimeText.base.has(compact(element.label)));
arrived = arrived.filter((element) => !runtimeText.head.has(compact(element.label)));
for (const element of outermost(specificByLabel(gone))) {
const label = compact(element.label);
if (!label) {
@@ -1132,7 +1238,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
}
}
for (const pair of pairing.pairs) {
const comparison = comparePair(pair, base, head);
const comparison = comparePair(pair, base, head, unstableWithin(pair.base, pair.head, siblings));
facts.push(...comparison.facts);
issues.push(...comparison.issues);
}
@@ -1145,7 +1251,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
const visual = visualFact(input, base, head);
// Pixels always move when an element appears or its text changes. The generic styling line
// only informs when nothing in the accessibility tree accounts for the difference.
const explained = facts.length > 0 && input.visualScope?.kind !== "landmark";
const explained = facts.some((fact) => fact.change.kind !== "unstable-text") && input.visualScope?.kind !== "landmark";
if (visual.fact && !explained) facts.push(visual.fact);
if (visual.issue) issues.push(visual.issue);
+33
View File
@@ -0,0 +1,33 @@
import { Worker, isMainThread, parentPort, workerData } from "node:worker_threads";
import { measureRegionMoves, type Rect } from "./region-shift.js";
type MeasuredRegions = Awaited<ReturnType<typeof measureRegionMoves>>;
type RegionMoveWork = { regionMoveWork: true; basePath: string; headPath: string; regions: ReadonlyArray<Rect & { dominantChange?: string }> };
type RegionMoveReply = { measured: MeasuredRegions } | { error: string };
/**
* Measures region shifts and large moves on a worker thread, so several screenshot pairs search at once while the
* main thread stays free: the search is CPU-bound and takes seconds on a tablet-sized screenshot. Falls back to the
* calling thread when no worker can start.
*/
export async function measureRegionMovesInWorker(basePath: string, headPath: string, regions: RegionMoveWork["regions"]): Promise<MeasuredRegions> {
const work: RegionMoveWork = { regionMoveWork: true, basePath, headPath, regions };
let worker: Worker;
try { worker = new Worker(new URL("./region-shift-worker.js", import.meta.url), { workerData: work }); }
catch { return measureRegionMoves(basePath, headPath, regions); }
return new Promise((resolve, reject) => {
let settled = false;
const finish = (outcome: () => void) => { if (!settled) { settled = true; outcome(); } };
worker.once("message", (reply: RegionMoveReply) => finish(() => "error" in reply ? reject(new Error(reply.error)) : resolve(reply.measured)));
// A worker that fails to load or dies before answering is a worker that did not start: the calling thread measures.
worker.once("error", () => finish(() => resolve(measureRegionMoves(basePath, headPath, regions))));
worker.once("exit", () => finish(() => resolve(measureRegionMoves(basePath, headPath, regions))));
});
}
if (!isMainThread && parentPort && (workerData as Partial<RegionMoveWork> | null)?.regionMoveWork === true) {
const port = parentPort;
const work = workerData as RegionMoveWork;
measureRegionMoves(work.basePath, work.headPath, work.regions)
.then(measured => port.postMessage({ measured } satisfies RegionMoveReply), (error: unknown) => port.postMessage({ error: (error as Error).message } satisfies RegionMoveReply));
}
+446
View File
@@ -0,0 +1,446 @@
import { createRequire } from "node:module";
import { readFile } from "node:fs/promises";
import type { DecodedFrame } from "../shared/png-evidence.js";
/** How far a region's content moved from Before to After, in screenshot pixels (right and down are positive). */
export type RegionShift = { x: number; y: number };
export type Rect = { x: number; y: number; width: number; height: number };
/**
* The farthest a region is searched for, in screenshot pixels: layout drift, not a different screen. Drift adds up
* down a long screen (a device pixel per text element above), so the vertical reach is the larger.
*/
const MAX_SHIFT_X = 4;
const MAX_SHIFT_Y = 20;
/** How close to the edge of the search a best fit may land and still count: the real one may lie beyond it. */
const EDGE = 1.5;
/**
* The share of a region's difference one shift must explain for the region to have moved rather than changed.
* A move of half a pixel or less re-rasterizes text rather than shifting it, so a pure shift explains only a
* quarter to a half of it; content that changed (new text, a caret) explains under a quarter at that size, and
* anything larger has to be explained mostly by the shift. Measured on euxy's SDK 58 upgrade (brentvatne/euxy#161).
*/
const MIN_EXPLAINED = 0.6;
const MIN_EXPLAINED_SUBPIXEL = 0.25;
const SUBPIXEL = 0.5;
/** A smaller shift is rendering noise, not a move. */
const MIN_SHIFT = 0.25;
/** Sixths of a pixel in the refining search: a third of a 1x pixel is one device pixel on a 3x screen. */
const STEPS_PER_PIXEL = 6;
/** Fits this close to the best are ties, which go to the smallest move (content that is the same all along one axis). */
const TIE = 1.005;
/** Another fit this close at a vertical offset two or more pixels away makes the move ambiguous (repeating content). */
const AMBIGUOUS = 1.05;
/**
* After aligning by the move, content is the same only where every channel is within this: re-rasterized text
* differs by at most about 125 (brentvatne/euxy#161), new content by about 200. A few pixels over it are noise; more are a change.
*/
const CHANGED_CHANNEL = 140;
const CHANGED_PIXELS = 3;
type Image = { width: number; height: number; frame: DecodedFrame; luminance: Float32Array };
type Fit = { sx: number; sy: number; error: number };
function image(frame: DecodedFrame): Image {
const luminance = new Float32Array(frame.width * frame.height);
for (let index = 0; index < luminance.length; index += 1) {
const offset = index * 4;
luminance[index] = 0.299 * frame.data[offset]! + 0.587 * frame.data[offset + 1]! + 0.114 * frame.data[offset + 2]!;
}
return { width: frame.width, height: frame.height, frame, luminance };
}
/** Bilinear sample of one plane: `channel` 0–2 of the frame, or luminance when undefined. */
function at(source: Image, x: number, y: number, channel?: number): number {
const cx = Math.min(source.width - 1, Math.max(0, x));
const cy = Math.min(source.height - 1, Math.max(0, y));
const x0 = Math.floor(cx), y0 = Math.floor(cy);
const x1 = Math.min(source.width - 1, x0 + 1), y1 = Math.min(source.height - 1, y0 + 1);
const fx = cx - x0, fy = cy - y0;
const value = channel === undefined
? (px: number, py: number) => source.luminance[py * source.width + px]!
: (px: number, py: number) => source.frame.data[(py * source.width + px) * 4 + channel]!;
return value(x0, y0) * (1 - fx) * (1 - fy) + value(x1, y0) * fx * (1 - fy) + value(x0, y1) * (1 - fx) * fy + value(x1, y1) * fx * fy;
}
/**
* How badly After's region matches Before shifted by (sx, sy): the summed luminance difference, row by row. A sum
* that passes `limit` stops early and returns a value above it: such a fit is neither the best, nor a tie, nor an
* ambiguity, so its exact error is never read. Whole-pixel shifts read the pixel directly (the bilinear weights are
* exactly 1 and 0 there); fractional ones interpolate like `at`.
*/
function mismatch(base: Image, head: Image, rect: Rect, sx: number, sy: number, limit = Infinity): number {
const { width, height, luminance } = base;
const maxX = width - 1, maxY = height - 1;
const headLuminance = head.luminance, headWidth = head.width;
const whole = Number.isInteger(sx) && Number.isInteger(sy);
let error = 0;
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
const headRow = y * headWidth;
if (whole) {
const row = Math.min(maxY, Math.max(0, y - sy)) * width;
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
error += Math.abs(luminance[row + Math.min(maxX, Math.max(0, x - sx))]! - headLuminance[headRow + x]!);
}
} else {
const cy = Math.min(maxY, Math.max(0, y - sy));
const y0 = Math.floor(cy), y1 = Math.min(maxY, y0 + 1), fy = cy - y0;
const row0 = y0 * width, row1 = y1 * width;
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
const cx = Math.min(maxX, Math.max(0, x - sx));
const x0 = Math.floor(cx), x1 = Math.min(maxX, x0 + 1), fx = cx - x0;
const sample = luminance[row0 + x0]! * (1 - fx) * (1 - fy) + luminance[row0 + x1]! * fx * (1 - fy)
+ luminance[row1 + x0]! * (1 - fx) * fy + luminance[row1 + x1]! * fx * fy;
error += Math.abs(sample - headLuminance[headRow + x]!);
}
}
if (error > limit) return error;
}
return error;
}
/** The best of some fits, with near-ties going to the smallest move. */
function bestOf(fits: readonly Fit[]): Fit {
const least = Math.min(...fits.map(fit => fit.error));
return fits.filter(fit => fit.error <= least * TIE + 1e-6)
.sort((a, b) => Math.hypot(a.sx, a.sy) - Math.hypot(b.sx, b.sy))[0]!;
}
/** Whether, aligned by the move, some of the region still differs strongly in any channel: content that changed. */
function changedAfterMove(base: Image, head: Image, rect: Rect, sx: number, sy: number): boolean {
let strong = 0;
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
for (let channel = 0; channel < 3; channel += 1) {
if (Math.abs(at(base, x - sx, y - sy, channel) - head.frame.data[(y * head.width + x) * 4 + channel]!) > CHANGED_CHANNEL) {
strong += 1;
if (strong >= CHANGED_PIXELS) return true;
break;
}
}
}
}
return false;
}
/**
* The shift that explains one region's difference, if one does: the region's content is the same in both
* screenshots, only moved. A region whose content changed (new text, another colour) has no shift, and neither has
* one whose content repeats so that several shifts fit.
*/
function regionShift(base: Image, head: Image, region: Rect): RegionShift | undefined {
const x = Math.max(0, Math.floor(region.x)), y = Math.max(0, Math.floor(region.y));
const rect = { x, y, width: Math.min(head.width - x, Math.ceil(region.width)), height: Math.min(head.height - y, Math.ceil(region.height)) };
if (rect.width <= 0 || rect.height <= 0) return undefined;
const unshifted = mismatch(base, head, rect, 0, 0);
if (unshifted === 0) return undefined;
// Whole pixels first, every pixel counting: sampling every other row aliases on thin shapes (text, hairlines).
// A fit worse than the best so far by more than the ambiguity margin cannot become the best, tie with it, or make
// it ambiguous; its measurement stops as soon as that is known. The margin is taken from the worst fit the tie
// could choose, since a tie goes to the smallest move, not the least error.
const whole: Fit[] = [];
let least = unshifted;
for (let sy = -MAX_SHIFT_Y; sy <= MAX_SHIFT_Y; sy += 1) {
for (let sx = -MAX_SHIFT_X; sx <= MAX_SHIFT_X; sx += 1) {
const error = sx === 0 && sy === 0 ? unshifted : mismatch(base, head, rect, sx, sy, (least * TIE + 1e-6) * AMBIGUOUS + 1e-6);
least = Math.min(least, error);
whole.push({ sx, sy, error });
}
}
const coarse = bestOf(whole);
if (whole.some(fit => Math.abs(fit.sy - coarse.sy) >= 2 && fit.error <= coarse.error * AMBIGUOUS + 1e-6)) return undefined;
// Then sixths of a pixel around it, from whole-number steps so a move up and a move down round alike.
const fine: Fit[] = [];
least = coarse.error;
for (let iy = -STEPS_PER_PIXEL; iy <= STEPS_PER_PIXEL; iy += 1) {
for (let ix = -STEPS_PER_PIXEL; ix <= STEPS_PER_PIXEL; ix += 1) {
const sx = coarse.sx + ix / STEPS_PER_PIXEL, sy = coarse.sy + iy / STEPS_PER_PIXEL;
const error = ix === 0 && iy === 0 ? coarse.error : mismatch(base, head, rect, sx, sy, least * TIE + 1e-6);
least = Math.min(least, error);
fine.push({ sx, sy, error });
}
}
const best = bestOf(fine);
if (Math.abs(best.sx) > MAX_SHIFT_X - EDGE || Math.abs(best.sy) > MAX_SHIFT_Y - EDGE) return undefined;
const distance = Math.hypot(best.sx, best.sy);
const needed = distance <= SUBPIXEL + 1e-6 ? MIN_EXPLAINED_SUBPIXEL : MIN_EXPLAINED;
if (distance < MIN_SHIFT - 1e-6 || 1 - best.error / unshifted < needed) return undefined;
if (changedAfterMove(base, head, rect, best.sx, best.sy)) return undefined;
const round = (value: number) => Math.round(value * 100) / 100 || 0;
return { x: round(best.sx), y: round(best.sy) };
}
/** Each region's shift between two screenshots of the same size; undefined where a region's content changed. */
export function regionShifts(baseFrame: DecodedFrame, headFrame: DecodedFrame, regions: readonly Rect[]): Array<RegionShift | undefined> {
if (baseFrame.width !== headFrame.width || baseFrame.height !== headFrame.height) return regions.map(() => undefined);
const base = image(baseFrame), head = image(headFrame);
return regions.map(region => regionShift(base, head, region));
}
/**
* 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 [PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false })];
}
+39 -2
View File
@@ -28,6 +28,7 @@ export type ReviewerChangeTemplateId =
| "element.removed"
| "visible-text.changed-short"
| "visible-text.changed-long"
| "visible-text.unstable-within-build"
| "interaction.target-changed"
| "accessibility.label-changed"
| "accessibility.role-changed"
@@ -95,6 +96,19 @@ export type VisibleTextReviewerChange = {
after: string;
};
/**
* A label that differs between the two builds but also between two captures of the same build (its light and dark
* appearances): a clock, a relative time, a random name. Runtime state, not a change.
*/
export type UnstableTextReviewerChange = {
kind: "unstable-text";
subjectRole: ReviewerSubjectRole;
before: string;
after: string;
/** What the same build showed in its other capture. */
within: string;
};
export type InteractionReviewerChange = {
kind: "action-target-changed";
subjectRole: ReviewerSubjectRole;
@@ -121,7 +135,7 @@ export type VisualReviewerChange = {
kind: "visual-changed";
scope:
| { kind: "landmark"; label: string }
| { kind: "main-content" };
| { kind: "main-content"; near?: "top" | "bottom" };
};
/**
@@ -134,6 +148,7 @@ export type SupportedReviewerChange =
| ScreenReviewerChange
| ElementReviewerChange
| VisibleTextReviewerChange
| UnstableTextReviewerChange
| InteractionReviewerChange
| AccessibilityReviewerChange
| VisualReviewerChange
@@ -387,6 +402,28 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
},
};
}
case "unstable-text": {
const before = compact(change.before);
const after = compact(change.after);
const within = compact(change.within);
if (!before || !after || !within) return invalidChange("An unstable-text change requires all three labels.", evidenceRefs);
if (before === after) return invalidChange("An unstable-text change has identical labels.", evidenceRefs);
const seen = [...new Set([before, within, after])];
return {
kind: "fact",
fact: {
category: "visible-text",
templateId: "visible-text.unstable-within-build",
bullet: `Text varies between captures of the same build: ${seen.map(quote).join(" / ")}.`,
subjectRole: change.subjectRole,
subjectLabel: after,
before,
after,
priority: PRIORITY["visible-text"],
evidenceRefs,
},
};
}
case "accessibility-label-changed": {
const before = compact(change.before);
const after = compact(change.after);
@@ -466,7 +503,7 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
fact: {
category: "visual",
templateId: "visual.main-content-changed",
bullet: "Updated visual styling in the main content area.",
bullet: change.scope.near ? `Updated visual styling near the ${change.scope.near} of the screen.` : "Updated visual styling in the main content area.",
subjectRole: "content",
subjectLabel: "Main content",
priority: PRIORITY.visual,
+11 -7
View File
@@ -11,12 +11,15 @@ import type {
} from "./runtime-evidence.js";
import type { ExploreMap, Observation, Screen } from "../types.js";
import { CAPTURE_OBSERVER_IDENTIFIER } from "../capture/observer.js";
import { ARGENT_VERSION } from "../shared/argent-version.js";
/** Strict, non-secret subset written after a successful EAS Simulator cleanup. */
/** Strict, non-secret subset written after a successful simulator cleanup. */
export type RuntimeExecutionContext = {
provider: "eas-simulator";
controller: "agent-device";
controllerPackageVersion: typeof AGENT_DEVICE_VERSION;
/** EAS Simulator, or a simulator Explore created on the capturing Mac (`capture.simulator: local`). */
provider: "eas-simulator" | "local-simulator";
controller: "agent-device" | "argent";
/** The pinned package of the controller that drove the session. */
controllerPackageVersion: typeof AGENT_DEVICE_VERSION | typeof ARGENT_VERSION;
easCliVersion: typeof EAS_CLI_VERSION;
platform: "ios" | "android";
deviceModel: string;
@@ -107,12 +110,13 @@ export function parseRuntimeExecutionContext(value: unknown): RuntimeExecutionCo
}
return context.colorSchemes.map((entry) => literal(entry, ["light", "dark"], "Runtime color schemes"));
})();
const controller = literal(context.controller, ["agent-device", "argent"], "Runtime controller");
return {
provider: literal(context.provider, ["eas-simulator"], "Runtime provider"),
controller: literal(context.controller, ["agent-device"], "Runtime controller"),
provider: literal(context.provider, ["eas-simulator", "local-simulator"], "Runtime provider"),
controller,
controllerPackageVersion: literal(
context.controllerPackageVersion,
[AGENT_DEVICE_VERSION],
[controller === "argent" ? ARGENT_VERSION : AGENT_DEVICE_VERSION],
"Controller package version",
),
easCliVersion: literal(context.easCliVersion, [EAS_CLI_VERSION], "EAS CLI version"),
+6 -6
View File
@@ -92,8 +92,8 @@ export type RawCaptureSample = {
};
export type RawSimulatorEnvironment = {
provider: "eas-simulator";
controller: "agent-device";
provider: "eas-simulator" | "local-simulator";
controller: "agent-device" | "argent";
platform: Platform;
deviceModel: string;
osVersion: string;
@@ -246,8 +246,8 @@ export type RuntimeEnvironmentEvidence = {
id: "environment";
profile: EvidenceField<"capture-context", string>;
fixturePersona?: EvidenceField<"capture-context", string>;
provider: EvidenceField<"eas-agent-device", "eas-simulator">;
controller: EvidenceField<"eas-agent-device", "agent-device">;
provider: EvidenceField<"eas-agent-device", "eas-simulator" | "local-simulator">;
controller: EvidenceField<"eas-agent-device", "agent-device" | "argent">;
controllerPackageVersion?: EvidenceField<"capture-context", string>;
easCliVersion?: EvidenceField<"capture-context", string>;
platform: EvidenceField<"eas-agent-device", Platform>;
@@ -784,8 +784,8 @@ function parseEnvironment(value: unknown): RawSimulatorEnvironment {
"Runtime environment",
);
return {
provider: literal(environment.provider, ["eas-simulator"], "Runtime provider"),
controller: literal(environment.controller, ["agent-device"], "Runtime controller"),
provider: literal(environment.provider, ["eas-simulator", "local-simulator"], "Runtime provider"),
controller: literal(environment.controller, ["agent-device", "argent"], "Runtime controller"),
platform: literal(environment.platform, PLATFORMS, "Runtime platform"),
deviceModel: safeString(environment.deviceModel, "Device model", 256),
osVersion: safeString(environment.osVersion, "OS version", 256),
+28 -24
View File
@@ -1,4 +1,4 @@
import { spawnSync } from "node:child_process";
import { execFile } from "node:child_process";
import { lstat, readFile, realpath } from "node:fs/promises";
import { isAbsolute } from "node:path";
@@ -133,30 +133,34 @@ export async function diffScreenshots(options: {
|| !isAbsolute(options.command)
|| /[\u0000-\u001f\u007f]/.test(options.command)
) throw new Error("agent-device command must be an absolute path");
const result = spawnSync(
options.command,
[
"--json",
"diff",
"screenshot",
"--baseline",
baselinePath,
currentPath,
"--threshold",
String(threshold),
],
{
encoding: "utf8",
shell: false,
timeout: options.timeoutMs ?? 60_000,
env: {
PATH: process.env.PATH,
const result = await new Promise<{ error: (Error & { code?: unknown }) | null; stdout: string; stderr: string }>(resolve => {
execFile(
options.command,
[
"--json",
"diff",
"screenshot",
"--baseline",
baselinePath,
currentPath,
"--threshold",
String(threshold),
],
{
encoding: "utf8",
shell: false,
timeout: options.timeoutMs ?? 60_000,
env: {
PATH: process.env.PATH,
},
maxBuffer: 4 * 1024 * 1024,
},
maxBuffer: 4 * 1024 * 1024,
},
);
if (result.error) throw new Error(`Could not run screenshot diff: ${result.error.message}`);
if (result.status !== 0) {
(error, stdout, stderr) => resolve({ error, stdout, stderr }),
);
});
// execFile reports a non-zero exit as an error carrying the exit status; a spawn failure or timeout carries none.
if (result.error && typeof result.error.code !== "number") throw new Error(`Could not run screenshot diff: ${result.error.message}`);
if (result.error) {
const detail = (result.stderr || result.stdout || "unknown error").trim().slice(0, 500);
throw new Error(`Screenshot diff failed: ${detail}`);
}
+1 -1
View File
@@ -3,4 +3,4 @@
* controller (`--package-version`), the daemon health check, and the screenshot diff tool must
* all be this version; each caller checks it by exact equality.
*/
export const AGENT_DEVICE_VERSION = "0.21.15";
export const AGENT_DEVICE_VERSION = "0.21.29-nightly.20261018.74";
+5
View File
@@ -0,0 +1,5 @@
/**
* The one Argent version Explore runs. The local CLI (`package.json`) and the EAS Simulator controller
* (`--package-version` for an `argent` session) must both be this version.
*/
export const ARGENT_VERSION = "0.29.0";
+235
View File
@@ -0,0 +1,235 @@
/**
* The device controllers Explore drives, fetched on first use instead of installed with Explore. Each is pinned to
* an exact npm release and its sha512 integrity; the tarball is checked before anything in it is written, nothing in
* it runs at install time, and neither controller needs other packages at run time. Argent's tool-server, which a
* local simulator needs, is the exception: ensureArgentToolServer installs it with its dependencies.
*/
import { spawnSync } from "node:child_process";
import { createHash, randomUUID } from "node:crypto";
import { existsSync, mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
import { chmod, mkdir, open, readdir, rename, rm, stat, writeFile } from "node:fs/promises";
import { homedir } from "node:os";
import { dirname, join, resolve, sep } from "node:path";
import { fileURLToPath } from "node:url";
import { safeRelativePath, walkTar } from "../binary/archive.js";
import { CiError } from "./ci-errors.js";
import { AGENT_DEVICE_VERSION } from "./agent-device-version.js";
import { ARGENT_VERSION } from "./argent-version.js";
export type ControllerName = "agent-device" | "argent";
/** Each controller's npm release, the file Explore runs from it, and the integrity npm publishes for it. */
export const CONTROLLER_PACKAGES: Record<ControllerName, { name: string; version: string; bin: string; integrity: string }> = {
"agent-device": { name: "agent-device", version: AGENT_DEVICE_VERSION, bin: "bin/agent-device.mjs",
integrity: "sha512-7+ajWLr0J+8iLZ9q11ERbj6U14mC20umBK5BQQdw5aERA79yeXc3Ze6KmtvnILnWjEtoVkYQsXQasL8RL6Uatw==" },
argent: { name: "@swmansion/argent", version: ARGENT_VERSION, bin: "dist/cli.js",
integrity: "sha512-XXWlWZJlHKqnAvNx3RDhuiVFQOPqh5EDB76+mFAyqC2mutC6irzw03+M/6S/WQ+Dzz2IYOkEfOzQnOOdhrGgJg==" },
};
const COMPLETE = ".explore-controller.json";
const MAX_CONTROLLER_BYTES = 256 * 1024 * 1024;
const LAUNCHER = fileURLToPath(new URL("../capture/controller-launcher.js", import.meta.url));
/** Where fetched controllers live: EXPLORE_CONTROLLER_CACHE, else the user's cache directory. */
export function controllerCacheRoot(environment: NodeJS.ProcessEnv = process.env): string {
if (environment.EXPLORE_CONTROLLER_CACHE) return resolve(environment.EXPLORE_CONTROLLER_CACHE);
const base = environment.XDG_CACHE_HOME || join(environment.HOME || homedir(), ".cache");
return join(base, "expo-explore", "controllers");
}
export function controllerDirectory(controller: ControllerName, environment: NodeJS.ProcessEnv = process.env): string {
const { name, version } = CONTROLLER_PACKAGES[controller];
return join(controllerCacheRoot(environment), `${name.replace("/", "+")}@${version}`);
}
/** The controller's entry file in the cache; it exists once `ensureController` has run. */
export function controllerBin(controller: ControllerName, environment: NodeJS.ProcessEnv = process.env): string {
return join(controllerDirectory(controller, environment), CONTROLLER_PACKAGES[controller].bin);
}
export function controllerCached(controller: ControllerName, environment: NodeJS.ProcessEnv = process.env): boolean {
return existsSync(join(controllerDirectory(controller, environment), COMPLETE));
}
/** The registry tarball for a release, from EXPLORE_NPM_REGISTRY (a mirror) or the public npm registry. */
export function controllerTarballUrl(controller: ControllerName, environment: NodeJS.ProcessEnv = process.env): string {
const { name, version } = CONTROLLER_PACKAGES[controller];
const registry = (environment.EXPLORE_NPM_REGISTRY || "https://registry.npmjs.org").replace(/\/+$/, "");
return `${registry}/${name}/-/${name.split("/").pop()}-${version}.tgz`;
}
/**
* The command that runs agent-device: a small script in the cache that fetches the pinned release on first use and
* then runs it with the same arguments. It names the cache, so a caller that narrows the environment (no HOME) still
* finds it. Written synchronously, so capture options can name it before any controller call.
*/
export function agentDeviceLauncher(environment: NodeJS.ProcessEnv = process.env): string {
const root = controllerCacheRoot(environment);
const quote = (value: string) => `'${value.replace(/'/g, `'\\''`)}'`;
// The registry is part of the command too: controller calls run with a narrowed environment that drops it.
const registry = environment.EXPLORE_NPM_REGISTRY ? ` EXPLORE_NPM_REGISTRY=${quote(environment.EXPLORE_NPM_REGISTRY)}` : "";
const script = `#!/bin/sh\nEXPLORE_CONTROLLER_CACHE=${quote(root)}${registry} exec ${quote(process.execPath)} ${quote(LAUNCHER)} agent-device "$@"\n`;
// One command per pinned release and installation, so two Explore installs on a machine never swap each other's
// controller in the middle of a capture.
const digest = createHash("sha256").update(script).digest("hex").slice(0, 12);
const command = join(root, "bin", `agent-device-${CONTROLLER_PACKAGES["agent-device"].version}-${digest}`);
if (existsSync(command) && readFileSync(command, "utf8") === script) return command;
mkdirSync(dirname(command), { recursive: true, mode: 0o700 });
const temporary = `${command}.${process.pid}.${randomUUID()}`;
writeFileSync(temporary, script, { mode: 0o755 });
renameSync(temporary, command);
return command;
}
/** A fetch killed mid-download (a timed-out controller call) leaves its staging files; clear any over an hour old. */
async function removeAbandonedStaging(root: string): Promise<void> {
const cutoff = Date.now() - 60 * 60_000;
for (const name of await readdir(root).catch(() => [] as string[])) {
if (!name.startsWith(".staging-")) continue;
const path = join(root, name);
const info = await stat(path).catch(() => undefined);
if (info && info.mtimeMs < cutoff) await rm(path, { recursive: true, force: true });
}
}
function downloadFailed(controller: ControllerName, message: string): CiError {
const { name, version } = CONTROLLER_PACKAGES[controller];
return new CiError({ code: "CONTROLLER_DOWNLOAD_FAILED", stage: "preflight", message: `${name}@${version} could not be fetched: ${message}`,
nextAction: "Check that this machine can reach the npm registry (or set EXPLORE_NPM_REGISTRY to a mirror that serves it), then rerun." });
}
/**
* Fetches the pinned controller into the cache once and returns its entry file. The download is hashed while it
* streams and must match the pinned integrity before it is unpacked; only regular files and directories inside the
* package are written, and the finished directory is renamed into place, so concurrent runs never see half of it.
*/
export async function ensureController(controller: ControllerName, options: {
environment?: NodeJS.ProcessEnv; fetch?: typeof fetch; progress?: (message: string) => void;
/** Tests: releases built on the spot instead of the pinned npm ones. */
packages?: typeof CONTROLLER_PACKAGES;
} = {}): Promise<string> {
const environment = options.environment ?? process.env;
const pinned = (options.packages ?? CONTROLLER_PACKAGES)[controller];
const directory = controllerDirectory(controller, environment);
const bin = join(directory, pinned.bin);
if (controllerCached(controller, environment)) return bin;
const root = controllerCacheRoot(environment);
await mkdir(root, { recursive: true, mode: 0o700 });
await removeAbandonedStaging(root);
const staging = join(root, `.staging-${process.pid}-${randomUUID()}`);
const tarball = `${staging}.tgz`;
try {
options.progress?.(`fetching ${pinned.name}@${pinned.version}`);
let response: Response;
try { response = await (options.fetch ?? fetch)(controllerTarballUrl(controller, environment)); }
catch (error) { throw downloadFailed(controller, error instanceof Error ? error.message : String(error)); }
if (!response.ok || !response.body) throw downloadFailed(controller, `the registry answered ${response.status}`);
const hash = createHash("sha512");
const file = await open(tarball, "wx", 0o600);
let bytes = 0;
try {
for await (const chunk of response.body as unknown as AsyncIterable<Uint8Array>) {
bytes += chunk.length;
if (bytes > MAX_CONTROLLER_BYTES) throw downloadFailed(controller, "the tarball is larger than expected");
hash.update(chunk);
await file.write(chunk);
}
} finally { await file.close(); }
const integrity = `sha512-${hash.digest("base64")}`;
if (integrity !== pinned.integrity) {
throw new CiError({ code: "CONTROLLER_INTEGRITY_MISMATCH", stage: "preflight",
message: `${pinned.name}@${pinned.version} from the registry does not match the release Explore pins (${integrity}).`,
nextAction: "Do not use this registry for Explore's controllers; unset EXPLORE_NPM_REGISTRY or point it at a faithful mirror." });
}
await mkdir(staging, { mode: 0o700 });
let written = 0;
await walkTar(tarball, async (entry, contents) => {
const relative = safeRelativePath(entry.name);
if (relative === "package" && entry.type === "5") return;
if (!relative || !relative.startsWith("package/")) throw downloadFailed(controller, `the tarball has an entry outside the package (${entry.name})`);
const target = join(staging, relative.slice("package/".length));
if (!target.startsWith(`${staging}${sep}`)) throw downloadFailed(controller, `the tarball has an unsafe entry (${entry.name})`);
if (entry.type === "5") { await mkdir(target, { recursive: true }); return; }
if (entry.type !== "0") throw downloadFailed(controller, `the tarball has a link or special file (${entry.name})`);
written += entry.size;
if (written > MAX_CONTROLLER_BYTES) throw downloadFailed(controller, "the package is larger than expected");
await mkdir(dirname(target), { recursive: true });
await writeFile(target, await contents(), { mode: entry.mode & 0o111 ? 0o755 : 0o644 });
});
if (!existsSync(join(staging, pinned.bin))) throw downloadFailed(controller, `the package has no ${pinned.bin}`);
await chmod(join(staging, pinned.bin), 0o755);
await writeFile(join(staging, COMPLETE), `${JSON.stringify({ name: pinned.name, version: pinned.version, integrity })}\n`);
try { await rename(staging, directory); }
catch (error) {
// Another run finished first; its copy is the same verified release.
if (!controllerCached(controller, environment)) throw error;
}
return bin;
} finally {
await rm(tarball, { force: true });
await rm(staging, { recursive: true, force: true });
}
}
/** The tool-server's package and its lockfile, shipped with Explore: every dependency is the version and tarball locked there. */
const ARGENT_TOOL_SERVER_LOCK = fileURLToPath(new URL("../../controllers/argent-tool-server/", import.meta.url));
/**
* Where the tool-server is installed in the controller cache: by Argent's version and the lockfile's hash, so a changed
* lock (or an install from before there was one) is installed afresh.
*/
export function argentToolServerDirectory(root: string): string {
const lock = createHash("sha256").update(readFileSync(join(ARGENT_TOOL_SERVER_LOCK, "package-lock.json"))).digest("hex").slice(0, 12);
return join(root, `argent-tool-server@${CONTROLLER_PACKAGES.argent.version}-${lock}`);
}
/** npm gets what it needs to reach the registry, never the tokens and keys a capture's environment carries. */
export function npmEnvironment(environment: NodeJS.ProcessEnv): NodeJS.ProcessEnv {
return Object.fromEntries(Object.entries(environment).filter(([name]) => /^(PATH|HOME|USER|LOGNAME|SHELL|TMPDIR|TEMP|TMP|LANG|LC_ALL|LC_CTYPE|SystemRoot|WINDIR|APPDATA|LOCALAPPDATA|NODE_EXTRA_CA_CERTS|(HTTPS?|NO|ALL)_PROXY|(https?|no|all)_proxy|npm_config_\w+|NPM_CONFIG_\w+)$/.test(name)));
}
/**
* Argent's tool-server, for driving simulators on this machine (`capture.simulator: local`): unlike the client, it
* needs Argent's dependencies, some with native prebuilds (tree-sitter). They are installed once, on first use, with
* `npm ci` from the lockfile Explore ships, so each package is the exact tarball locked there, and without running any
* package's install scripts. Returns its CLI.
*/
export async function ensureArgentToolServer(options: { environment?: NodeJS.ProcessEnv; progress?: (message: string) => void;
/** Tests: stands in for `npm ci`, given the folder to install into (its package.json and lockfile are there). */
install?: (directory: string) => Promise<void> } = {}): Promise<string> {
const environment = options.environment ?? process.env;
const pinned = CONTROLLER_PACKAGES.argent;
const root = controllerCacheRoot(environment);
const directory = argentToolServerDirectory(root);
const cli = join(directory, "node_modules", "@swmansion", "argent", pinned.bin);
if (existsSync(join(directory, COMPLETE))) return cli;
await mkdir(root, { recursive: true, mode: 0o700 });
await removeAbandonedStaging(root);
const staging = join(root, `.staging-${process.pid}-${randomUUID()}`);
try {
options.progress?.(`installing Argent's tool-server (${pinned.name}@${pinned.version} and its locked dependencies)`);
await mkdir(staging, { mode: 0o700 });
for (const file of ["package.json", "package-lock.json"]) await writeFile(join(staging, file), readFileSync(join(ARGENT_TOOL_SERVER_LOCK, file)));
await (options.install ?? (async target => {
const registry = environment.EXPLORE_NPM_REGISTRY ? ["--registry", environment.EXPLORE_NPM_REGISTRY] : [];
const npm = spawnSync("npm", ["ci", "--omit=optional", "--ignore-scripts", "--no-audit", "--no-fund", ...registry],
{ cwd: target, env: npmEnvironment(environment), encoding: "utf8", timeout: 10 * 60_000 });
if (npm.error || npm.status !== 0) throw new CiError({ code: "CONTROLLER_DOWNLOAD_FAILED", stage: "preflight",
message: `Argent's tool-server could not be installed: ${(npm.error?.message ?? npm.stderr ?? "").trim().split("\n").at(-1) ?? "npm failed"}`,
nextAction: "Check that npm is on PATH and can reach the registry (or set EXPLORE_NPM_REGISTRY), then rerun." });
}))(staging);
// npm ci checked every package against the lockfile; Argent itself must also be the exact release Explore pins.
const lock = JSON.parse(readFileSync(join(staging, "package-lock.json"), "utf8")) as { packages?: Record<string, { version?: string; integrity?: string }> };
const installed = lock.packages?.[`node_modules/${pinned.name}`];
if (installed?.version !== pinned.version || installed.integrity !== pinned.integrity) throw new CiError({ code: "CONTROLLER_INTEGRITY_MISMATCH", stage: "preflight",
message: `The ${pinned.name} npm installed (${installed?.version ?? "none"}, ${installed?.integrity ?? "no integrity"}) is not the release Explore pins.`,
nextAction: "Do not use this registry for Explore's controllers; unset EXPLORE_NPM_REGISTRY or point it at a faithful mirror." });
await writeFile(join(staging, COMPLETE), `${JSON.stringify({ name: pinned.name, version: pinned.version, integrity: pinned.integrity })}\n`);
// Several captures may install at once; the first to finish keeps its copy.
try { await rename(staging, directory); }
catch (error) { if (!existsSync(join(directory, COMPLETE))) throw error; }
return cli;
} finally {
await rm(staging, { recursive: true, force: true });
}
}
+51
View File
@@ -1,4 +1,5 @@
import { Buffer } from "node:buffer";
import { createRequire } from "node:module";
import { inflateSync } from "node:zlib";
import { STATUS_BAR_BAND_PERCENT } from "../contracts/capture.js";
@@ -7,6 +8,22 @@ export { STATUS_BAR_BAND_PERCENT };
/** Decoded RGBA pixels of one frame, as pngjs returns them (four bytes per pixel, row by row). */
export type DecodedFrame = { width: number; height: number; data: Buffer };
/**
* Whether a screenshot is a single flat colour: a capture-protected screen (black on Android), or a display that is lit
* but not drawn (an iPhone Duo's inner panel after its first fold on EAS). Every 97th pixel is enough to tell.
*/
export function solidColour(png: Buffer): boolean {
let frame: DecodedFrame;
try { frame = createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs").PNG.sync.read(png, { checkCRC: false }) as DecodedFrame; }
catch { return false; }
const { data } = frame;
if (data.length < 4) return false;
for (let offset = 0; offset + 3 < data.length; offset += 4 * 97) {
if (data[offset] !== data[0] || data[offset + 1] !== data[1] || data[offset + 2] !== data[2]) return false;
}
return true;
}
/**
* Whether a coordinate tap at normalized height `y` would act on a changed frame. Differences inside
* the status-bar band are ignored only when the tap lands below the band: a tap inside it acts on
@@ -21,6 +38,40 @@ export function frameChangedForTap(first: DecodedFrame, second: DecodedFrame, y:
return !first.data.subarray(start).equals(second.data.subarray(start));
}
/** The decoded frame, or undefined when the bytes are not a PNG pngjs can read. */
export function decodePng(png: Buffer): DecodedFrame | undefined {
try { return createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs").PNG.sync.read(png, { checkCRC: false }) as DecodedFrame; }
catch { return undefined; }
}
/** agent-device's rule for a changed pixel: an RGB distance above `threshold` of the longest diagonal. */
export function maxColorDistance(threshold: number): number {
return threshold * Math.sqrt(3 * 255 ** 2);
}
/** How many pixels of `rect` (clipped to the frames) differ between two same-sized frames by agent-device's rule. */
export function differentPixelsInRect(
first: DecodedFrame,
second: DecodedFrame,
rect: { x: number; y: number; width: number; height: number },
distance: number,
): number {
if (first.width !== second.width || first.height !== second.height) return 0;
const left = Math.max(0, rect.x); const right = Math.min(first.width, rect.x + rect.width);
const top = Math.max(0, rect.y); const bottom = Math.min(first.height, rect.y + rect.height);
let count = 0;
for (let y = top; y < bottom; y += 1) {
for (let x = left; x < right; x += 1) {
const offset = (y * first.width + x) * 4;
const r = first.data[offset]! - second.data[offset]!;
const g = first.data[offset + 1]! - second.data[offset + 1]!;
const b = first.data[offset + 2]! - second.data[offset + 2]!;
if (Math.sqrt(r * r + g * g + b * b) > distance) count += 1;
}
}
return count;
}
export function assertDecodedPng(contents: Buffer, label: string): void {
const signature = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
if (contents.length < 45 || !contents.subarray(0, 8).equals(signature)) {
+38 -14
View File
@@ -1,33 +1,57 @@
import { posix } from "node:path";
import ts from "typescript";
/** The `@/*` import alias a tsconfig maps to one project directory, such as `src/` or the root. */
/** The import aliases a tsconfig maps to project directories, such as `@/*` to `src/` and `@/assets/*` to `assets/`. */
export type TsconfigAlias = {
/** Directory prefix that replaces `@/`, with a trailing slash or empty for the project root. */
target: string;
/** Each alias prefix (`@/`, `@/assets/`) and the directory prefix that replaces it, longest prefix first. */
prefixes: readonly { prefix: string; target: string }[];
/** `baseUrl` is the project root: a bare specifier no alias matches is looked up there before it is taken for a package. */
baseUrl?: true;
/** Set when the tsconfig asks for module resolution the static analysis cannot follow. */
unsupported?: string;
};
const SINGLE_DIRECTORY_TARGET = /^(?:\.\/)?((?:[\w.-]+\/)*)\*$/;
// A relative-looking key (`./*`, `/*`) is never applied: TypeScript and Metro resolve relative specifiers directly.
const PREFIX_KEY = /^([^*./][^*]*\/)\*$/;
const DEFAULT: TsconfigAlias = { prefixes: [{ prefix: "@/", target: "src/" }] };
/**
* Static analysis follows one alias, `@/*`, pointing at a single directory (`./*`, `src/*`, `./src/*`),
* which is what create-expo-app and the Expo docs set up. Anything else is reported, not guessed.
* Static analysis follows `paths` entries of the form `prefix/*` that each point at a single directory (`./*`, `src/*`,
* `./assets/*`), which covers create-expo-app's `@/*` and the extra entries apps add beside it. Anything else is
* reported, not guessed.
*/
export function readTsconfigAlias(configText: string | undefined): TsconfigAlias {
if (configText === undefined) return { target: "src/" };
if (configText === undefined) return DEFAULT;
const parsed = ts.parseConfigFileTextToJson("tsconfig.json", configText);
const options = parsed.config?.compilerOptions ?? {};
const unsupported = { target: "src/", unsupported: "custom module resolution is not statically supported" };
const unsupported = { ...DEFAULT, unsupported: "custom module resolution is not statically supported" };
if (parsed.error) return unsupported;
if (options.baseUrl && ![".", "./"].includes(options.baseUrl)) return unsupported;
if (parsed.config?.extends && parsed.config.extends !== "expo/tsconfig.base") return unsupported;
const baseUrl = options.baseUrl ? { baseUrl: true as const } : {};
const entries = Object.entries(options.paths ?? {}) as [string, unknown][];
if (entries.length === 0) return { target: "src/" };
if (entries.length > 1 || entries[0]![0] !== "@/*") return unsupported;
const targets = entries[0]![1];
if (!Array.isArray(targets) || targets.length !== 1 || typeof targets[0] !== "string") return unsupported;
const match = SINGLE_DIRECTORY_TARGET.exec(targets[0]);
if (!match || match[1]!.split("/").includes("..")) return unsupported;
return { target: match[1]! };
if (entries.length === 0) return { ...DEFAULT, ...baseUrl };
const prefixes: { prefix: string; target: string }[] = [];
for (const [key, targets] of entries) {
const prefix = PREFIX_KEY.exec(key)?.[1];
if (!prefix || !Array.isArray(targets) || targets.length !== 1 || typeof targets[0] !== "string") return unsupported;
const match = SINGLE_DIRECTORY_TARGET.exec(targets[0]);
if (!match || match[1]!.split("/").some(segment => segment === "." || segment === "..")) return unsupported;
prefixes.push({ prefix, target: match[1]! });
}
// TypeScript picks the pattern with the longest prefix, so `@/assets/x` goes to `assets/`, not `src/assets/`.
return { prefixes: prefixes.sort((a, b) => b.prefix.length - a.prefix.length), ...baseUrl };
}
/** The project path an aliased specifier names, before extensions, or undefined when no alias matches it. */
export function resolveTsconfigAlias(alias: TsconfigAlias, specifier: string): string | undefined {
const entry = alias.prefixes.find(({ prefix }) => specifier.startsWith(prefix));
// Normalized as Metro joins it: `@app/a/../b` is `src/b`, and a trailing slash still finds `index`.
return entry ? posix.normalize(`${entry.target}${specifier.slice(entry.prefix.length)}`).replace(/\/$/, "") : undefined;
}
/** The project path a bare specifier names under a root `baseUrl`, or undefined; a miss there is a package, not a gap. */
export function resolveTsconfigBaseUrl(alias: TsconfigAlias, specifier: string): string | undefined {
return alias.baseUrl && !/^[./]/.test(specifier) ? specifier : undefined;
}
+11 -2
View File
@@ -2,6 +2,7 @@ import { createHash } from "node:crypto";
import { canonicalizeSourceChanges, type SourceChange } from "./git-diff.js";
import type { SourceChangeSummary } from "./change-summary.js";
import { hasRuntimeChange, readSourceSnapshot, surfaceDependencies, type SourceSnapshot } from "./dependency-graph.js";
import { sameCodeIgnoringTrivia } from "./trivia.js";
import { discoverRoutes, type DiscoverRouteOptions } from "./route-inventory.js";
import { sourceRouteNames, validateSourceRoutes, type SourceRoute } from "../contracts/source-route.js";
import { navigationCaptureContext, type NavigationGraph } from "../contracts/navigation-graph.js";
@@ -120,7 +121,15 @@ export function createSourceCapturePlan(options: CapturePlanOptions): SourceCapt
const headRoutes = checkedRoutes(options.headRoutes, headInventory.routes, "head");
const base = surfaceDependencies(baseRoutes, options.baseFiles, options.platform);
const head = surfaceDependencies(headRoutes, options.headFiles, options.platform);
const changes = canonicalizeSourceChanges(options.changedFiles).filter(change => !/(?:^|\/)surfaces?\.json$/.test(change.path));
// A file whose two versions differ only in comments or whitespace compiles to the same program, so it changes no screen.
// Parsed once per path: every surface that imports a shared file asks about it.
const trivia = new Map<string, boolean>();
const triviaOnly = (path: string) => {
if (!trivia.has(path)) trivia.set(path, sameCodeIgnoringTrivia(path, options.baseFiles.get(path), options.headFiles.get(path)));
return trivia.get(path)!;
};
const changes = canonicalizeSourceChanges(options.changedFiles).filter(change => !/(?:^|\/)surfaces?\.json$/.test(change.path)
&& !(change.status === "modified" && triviaOnly(change.path)));
const changedPaths = new Set(changes.flatMap(change => [change.path, ...("previousPath" in change ? [change.previousPath] : [])]));
const externalRuntimeChange = hasRuntimeChange(options.externalChanges ?? []);
const unresolved = [...new Set([...base.unresolved, ...head.unresolved,
@@ -138,7 +147,7 @@ export function createSourceCapturePlan(options: CapturePlanOptions): SourceCapt
const headSurface = headById.get(id) ?? null;
const dependencies = new Set([...(baseSurface?.sourceFiles ?? []), ...(headSurface?.sourceFiles ?? [])]);
const touched = [...changedPaths].filter(path => dependencies.has(path)).sort();
const sourceChanged = baseSurface && headSurface && [...dependencies].some(path => options.baseFiles.get(path) !== options.headFiles.get(path));
const sourceChanged = baseSurface && headSurface && [...dependencies].some(path => options.baseFiles.get(path) !== options.headFiles.get(path) && !triviaOnly(path));
const definitionChanged = baseSurface && headSurface && canonicalJSON(baseSurface) !== canonicalJSON(headSurface);
// A redirect renders no interface: only its own declaration can change what it does, so
// imported or app-wide edits cannot make it a reviewable difference.
+18 -8
View File
@@ -3,6 +3,7 @@ import ts from "typescript";
import { parseTwoDotNameStatus, type SourceChange } from "./git-diff.js";
import type { SourceCapturePlan } from "./capture-plan.js";
import { DEFAULT_GLOBAL_IMPACT_PATHS } from "./impact.js";
import { sameCodeIgnoringTrivia } from "./trivia.js";
import { sourceImpactKinds, sourceImpactSentences } from "../contracts/source-change.js";
export type SourceLineRange = { start: number; end: number };
@@ -376,10 +377,13 @@ function changedPaths(change: SourceChange): string[] {
return [change.path, ...("previousPath" in change ? [change.previousPath] : [])];
}
/** A modified file whose program did not change (comments or whitespace only) leaves no evidence: it changes no screen. */
type FileEvidence = Omit<SourceFileChangeSummary, "relation"> | { triviaOnly: true };
function fileEvidence(options: {
baseProject: string; headProject: string; baseSha: string; headSha: string;
change: SourceChange; budget: { remaining: number };
}): Omit<SourceFileChangeSummary, "relation"> {
}): FileEvidence {
const { change } = options;
const previousPath = "previousPath" in change ? change.previousPath : undefined;
const base = readBlob(options.baseProject, options.baseSha, previousPath ?? change.path, options.budget);
@@ -392,6 +396,7 @@ function fileEvidence(options: {
baseStart: Number(match[1]), baseLines: Number(match[2] ?? 1),
headStart: Number(match[3]), headLines: Number(match[4] ?? 1),
}));
if (change.status === "modified" && !base.truncated && !head.truncated && sameCodeIgnoringTrivia(change.path, base.source, head.source)) return { triviaOnly: true };
const extracted = base.truncated || head.truncated ? undefined : codeFacts(change.path, base.source ?? "", head.source ?? "");
const facts = extracted?.length ? extracted : [{
kind: "code" as const,
@@ -461,7 +466,7 @@ export function createSourceChangeSummaries(options: {
], 4 * 1024 * 1024).stdout));
if (changes.length > SOURCE_CHANGE_SUMMARY_LIMITS.changedFiles) throw new Error("Source summary exceeds changed-file limit");
const globals = new Set<string>([...DEFAULT_GLOBAL_IMPACT_PATHS.filter((path) => !path.endsWith("/")), "tsconfig.json"]);
const cache = new Map<string, Omit<SourceFileChangeSummary, "relation">>();
const cache = new Map<string, FileEvidence>();
const budget = { remaining: SOURCE_CHANGE_SUMMARY_LIMITS.totalSourceBytes };
const summaries: Record<string, SourceChangeSummary> = {};
for (const surface of plan.surfaces) {
@@ -480,18 +485,23 @@ export function createSourceChangeSummaries(options: {
!/^(?:\.github\/|docs\/|tests?\/|scripts\/)|(?:\.md$|\.(?:test|spec)\.[jt]sx?$)/.test(path)
))));
}
const selected = relevant.sort((left, right) => {
const ranked = relevant.sort((left, right) => {
const rank = { route: 0, "declared-source": 1, dependency: 2, global: 3 };
return rank[relation(surface, left)] - rank[relation(surface, right)] || left.path.localeCompare(right.path);
}).slice(0, SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface);
const files = selected.map((change): SourceFileChangeSummary => {
});
// A comment-only file leaves no evidence, so it does not take one of the surface's file slots either.
const files: SourceFileChangeSummary[] = [];
let considered = 0;
for (const change of ranked) {
if (files.length === SOURCE_CHANGE_SUMMARY_LIMITS.filesPerSurface) break;
considered += 1;
let evidence = cache.get(change.path);
if (!evidence) {
evidence = fileEvidence({ ...options, baseSha: plan.baseSha, headSha: plan.headSha, change, budget });
cache.set(change.path, evidence);
}
return { ...evidence, relation: relation(surface, change) };
});
if (!("triviaOnly" in evidence)) files.push({ ...evidence, relation: relation(surface, change) });
}
const impact: SourceChangeSummary["impact"] = files.some((file) => file.relation === "route" || file.relation === "declared-source")
? "direct" : files.some((file) => file.relation === "dependency") ? "dependency"
: globalImpact || (surface.status === "modified" && plan.conservative) ? "global"
@@ -501,7 +511,7 @@ export function createSourceChangeSummaries(options: {
baseSha: plan.baseSha, headSha: plan.headSha, impact,
summary: summaryText(surface, impact, files),
files,
truncated: relevant.length > selected.length || files.some((file) => file.truncated),
truncated: ranked.length > considered || files.some((file) => file.truncated),
};
}
return summaries;
Loaded 100 of 253 files, more files were not shown because too many files have changed in this diff. Show more