Compare commits

..
Author SHA1 Message Date
Brent Vatne 6cc2008236 Merge remote-tracking branch 'origin/main' into @brent/flaky-ci-fixes 2026-10-18 09:48:09 -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 32518833f6 Fix flaky CI: stray SIGTERMs, port-lock race, fixture colour collisions, mid-review downloads, cold-Vite reloads
- ci-map test: the fake Argent server reported pids 4243+, and stopping it sent a real SIGTERM to whatever held them.
- reservePort: an owner file read between its creation and the pid write was taken as pid 0, a dead holder, so a
  live mutex or breaker could be removed. An empty owner now gets the same grace as a missing one.
- public CI fixture: /home's hashed screenshot colours could fall within agent-device's diff threshold (~3.5% of
  commit times); the red channel now keeps the base build apart. The real agent-device that compares screenshots is
  fetched once, with retries, into a shared cache instead of on first use inside each review.
- Browser tests: include react/jsx-dev-runtime in the cold Vite's optimizeDeps, so a late discovery doesn't reload the
  page; wait for the screenshot's ready state, since the placeholder has the same width.
2026-10-18 09:20:42 -07:00
46 changed files with 1190 additions and 911 deletions

No files matched your search

+2 -2
View File
@@ -57,7 +57,7 @@ Each workflow starts with a `targets` job: it installs the pinned CLI and runs `
| | Package hosted review bundle | `ci:report` writes the report directory. |
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, zips and encrypts each report, deploys it with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report** and the link's expiry. |
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
A reviewer downloads the report ZIP and drops it on the hosted Viewer; downloading needs read access to the repository.
@@ -68,7 +68,7 @@ Validate baseline source → Install Explore → Verify deterministic source pla
### 2.4 `explore-compare.yml`
The same jobs as a PR review, for any `base` and `head` without a pull request. The `targets` job resolves both refs once with `ci:compare-refs` (a tag wins over a branch of the same name; the same commit twice fails with `COMPARE_SAME_COMMIT`) and passes the comparison to the capture jobs, which run `capture:review --compare` with no GitHub requests. The optional `scope` and `expires-in` inputs override `exploration.scope` and `report.preview.expiresAfter` for that run. The report job's `ci:publish` writes each target's **Open** and **zip** links to the run summary, and the deploy job adds the hosted link there; nothing comments on a pull request.
The same jobs as a PR review, for any `base` and `head` without a pull request. The `targets` job resolves both refs once with `ci:compare-refs` (a tag wins over a branch of the same name; the same commit twice fails with `COMPARE_SAME_COMMIT`) and passes the comparison to the capture jobs, which run `capture:review --compare` with no GitHub requests. The optional `scope` input overrides `exploration.scope` for that run; `expires-in` is accepted and ignored. The report job's `ci:publish` writes each target's **Open** and **zip** links to the run summary, and the deploy job adds the hosted link there; nothing comments on a pull request.
## 3. Inside `capture:review` (`runCiReview`)
+8 -10
View File
@@ -145,7 +145,7 @@ npx @expo/explore capture --committed # HEAD alone
npx @expo/explore capture --base v1.3.0 --head v1.4.0 --scope all --upload
```
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform or [target](#targets) on EAS Simulator or a [local simulator](#simulator), and opens the report in a local Viewer. `--target` or `--platform` picks some; they run at once, at most `--parallel N` at a time. `--upload` hosts it for 30 days (`--expires-in` changes that) and prints the link; `report:upload <report.zip>` hosts one you already have.
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform or [target](#targets) on EAS Simulator or a [local simulator](#simulator), and opens the report in a local Viewer. `--target` or `--platform` picks some; they run at once, at most `--parallel N` at a time. `--upload` hosts it and prints the link; `report:upload <report.zip>` hosts one you already have.
- Your checkout, index and branches are never touched. Your uncommitted changes, untracked files included, are reviewed as `eas build` would upload them; `--committed`, or `cli.requireCommit: true` in `eas.json`, leaves them out.
- Installs run without credential environment variables, which keeps tokens out of reach of a registry a commit's `.npmrc` names; that is not a sandbox. A registry that needs `${NPM_TOKEN}` in the project's `.npmrc` must be authenticated in your own `~/.npmrc`.
- Captures are cached in `~/.cache/expo-explore`, so the same base is not captured twice (`--no-cache` skips it); a capture unused for 30 days goes, and the cache stays under 2 GB. Ctrl+C stops the run's simulator sessions and local devices; when a run is stopped harder than that, the next local run stops what it left running.
@@ -170,7 +170,7 @@ Pointed to a build, the [quick start](#quick-start) maps every screen of it, wit
- A run stops after 15 minutes, 40 screens, or 150 actions (`--max-duration-minutes`, `--max-screens`, `--max-actions`).
- Buttons that delete, pay, sign out, send, or leave the app are never tapped. `--allow-destructive "Reset filters"` allows one by its exact label.
- `--hints "…"` tells the model what to focus on or how to sign in ([details](#sign-in-and-other-app-state)).
- On EAS Simulator the report is hosted, and the link lasts 7 days (`--expires-in` takes 1d to 90d, or never); `--no-upload` keeps it local. On a local simulator it opens in the local Viewer (`--no-open` or `--json` skips that; `view --dir <folder>` opens it later), and `--upload` hosts it, which needs an EAS login. `--json` prints the result for scripts.
- On EAS Simulator the report is hosted, and the link lasts as long as its EAS Hosting deployment (see [report access](docs/private-review.md#hosted-previews)); `--no-upload` keeps it local. On a local simulator it opens in the local Viewer (`--no-open` or `--json` skips that; `view --dir <folder>` opens it later), and `--upload` hosts it, which needs an EAS login. `--json` prints the result for scripts.
- For a link that stays the same from run to run, pass `--alias NAME` and set `EXPLORE_PREVIEW_TOKEN` to a fixed token of 32 characters from a–z and 2–7 (`LC_ALL=C tr -dc a-z2-7 </dev/urandom | head -c 32`).
- EAS Simulator sessions and hosted reports run under an EAS project named `expo-explore` in your account, created on first use (`--owner` and `--project` pick another).
- Read a local result with `npx @expo/explore view --dir <folder>`, `screen:list`, or `gap:list`.
@@ -227,7 +227,6 @@ By default reviewers download the report from GitHub. With hosted previews, the
report:
preview:
hosting: eas # default: off
expiresAfter: 30d # default 30d, max 365d, or never
# project: acme-explore # default <repository name>-explore, created on first run
```
@@ -235,7 +234,7 @@ report:
- A [comparison of two commits](#compare-any-two-commits) links its hosted report from the run's summary instead of a PR comment. `capture --upload` on your machine deploys to the same project with your `eas login`.
- `expo-explore report:upload <report.zip>...` hosts reports already on your machine the same way: a review's reports (one per platform or target, from `capture --output` or a downloaded `explore-review` artifact) or an `explore:binary` report.
- `EXPO_TOKEN` must be able to create the EAS project, so use a [robot user's](https://docs.expo.dev/accounts/programmatic-access/) token.
- The report is encrypted, and only a request carrying the link's token can open it. Treat the link like a shared file link; see [report access](docs/private-review.md#hosted-previews).
- Every file of the report sits under the link's 160-bit token, so only someone with the link can open it. Treat the link like a shared file link. It works as long as its EAS Hosting deployment does: EAS deletes one without an alias after 30 days on the Free plan and 90 on paid plans, and you can delete it sooner (`eas deploy:delete`) or on your own schedule. Explore sets no expiry of its own; see [report access](docs/private-review.md#hosted-previews).
</details>
@@ -406,11 +405,11 @@ give me the report link.
There are a few ways to snapshot a release:
- **On demand:** in your repository's Actions tab, open **Expo Explore compare**, choose **Run workflow**, and set `base` to the last release's tag (`v1.3.0`), `head` to the new tag or release candidate (`v1.4.0-rc.1`), `scope` to `all` and `expires-in` to `never`. The run's summary links the report.
- **On demand:** in your repository's Actions tab, open **Expo Explore compare**, choose **Run workflow**, and set `base` to the last release's tag (`v1.3.0`), `head` to the new tag or release candidate (`v1.4.0-rc.1`), and `scope` to `all`. The run's summary links the report.
- **Automatically, on every tag:** add the `release-review.yml` in [The comparison workflow](#compare) below. It compares each tag, release candidates included, with the last stable tag, so a release candidate is reviewed against what people have now.
- **On your machine, without CI:** `npx @expo/explore capture --base v1.3.0 --head v1.4.0 --scope all --upload`, with your `eas login`. `npx @expo/explore reports` lists the runs you have kept.
`scope: all` captures every screen, not only those whose source changed, so the report shows the whole release with what changed since the last one marked; `expires-in: never` keeps its link.
`scope: all` captures every screen, not only those whose source changed, so the report shows the whole release with what changed since the last one marked.
<details>
<summary id="compare"><strong>The comparison workflow</strong></summary>
@@ -443,16 +442,15 @@ jobs:
base: '${{ needs.previous.outputs.tag }}'
head: '${{ github.ref_name }}'
scope: all # every screen, not only those whose source changed
expires-in: never # keep the hosted link (with report.preview.hosting: eas)
secrets: inherit
```
- Pick whatever `base` the event calls for: `main` for a release branch, yesterday's tag for a nightly, the last stable tag for a release candidate.
- `scope` and `expires-in` are optional and override `exploration.scope` and `report.preview.expiresAfter` for that run. Without them a comparison captures what a PR review would (`scope: changes` captures only screens whose source changed), and the hosted link expires like a PR's.
- `scope` is optional and overrides `exploration.scope` for that run. Without it a comparison captures what a PR review would (`scope: changes` captures only screens whose source changed). The hosted link lasts as long as its deployment, like a PR's; `expires-in` from earlier versions of this workflow is accepted and ignored.
- The run summary links each target's report (**Open** and **zip**, like a PR comment) and, with hosting, the hosted report.
- `setup --workflows` installs it from 0.19.0; `npx @expo/explore@latest setup --workflows` adds it to an existing setup. The caller grants `contents: read` and `actions: read`; `secrets: inherit` passes `EXPO_TOKEN` and any app-test secrets.
- Call it once per workflow run. A called workflow runs inside its caller's run, so a second call in the same run would reuse the first one's artifact names; use separate workflows instead.
- When the baseline workflow captured `base` in the last 30 days, with the same config and Explore version, that capture is reused and only `head` is captured. The report artifact is kept 30 days; only a hosted link with `expires-in: never` lasts longer.
- When the baseline workflow captured `base` in the last 30 days, with the same config and Explore version, that capture is reused and only `head` is captured. The report artifact is kept 30 days; a hosted link lasts as long as its EAS Hosting deployment (an aliased one until the alias moves).
</details>
@@ -506,7 +504,7 @@ The same link answers differently depending on who asks. It already carries the
- Anything that does not ask for HTML (`curl`, `fetch`, agents' URL tools) gets a Markdown index of the report, also at `/llms.txt`.
- The index links to a read-only JSON API under `/api/v1`: `/screens?status=modified,accessibility-only,added,removed`, `/screens/<id>`, `/transitions`, and `/raw` for the report file.
- Reports without source also expose `/journeys`, `/gaps`, and `/frontier`.
- A link to several targets takes `?target=<id>` and serves the first without it; `/reports.json` lists them (`?platform=ios|android` from older links still works). Expired links' report and API routes answer `410`.
- A link to several targets takes `?target=<id>` and serves the first without it; `/reports.json` lists them (`?platform=ios|android` from older links still works).
```sh
curl -s "$LINK/api/v1/screens?status=modified" | jq '.items[] | {route, status, review}'
+7 -7
View File
@@ -16,18 +16,18 @@ Hosted previews are off by default. When `report.preview.hosting: eas` is set, t
**What a reviewer needs.** Only the link. It looks like `https://acme-explore--k7f3z0d1q8.expo.app/p/f6r2…` and carries a 160-bit token generated for that run. It opens the Viewer and the report for one PR revision; it does not show the repository, other runs, or anything else in the Expo account.
**Several platforms or targets.** One deployment holds every target's report (a config without `targets` has one per platform). The link opens the first one (`?target=<id>` selects another, and `?platform=ios` or `?platform=android` from older links still works); the Viewer's menu lists the others from `/p/<token>/reports.json`, which names each target, its platform, label, device, and change count and nothing else. Every report and the listing sit behind the same token and expiry.
**Several platforms or targets.** One deployment holds every target's report (a config without `targets` has one per platform). The link opens the first one (`?target=<id>` selects another, and `?platform=ios` or `?platform=android` from older links still works); the Viewer's menu lists the others from `/p/<token>/reports.json`, which names each target, its platform, label, device, and change count and nothing else. Every report and the listing sit behind the same token.
**What is protected, and how.**
- *The report bytes.* `ci:deploy` zips the report and encrypts it (AES-256-GCM) before upload. The key is stored only in that deployment's server environment; it never appears in a URL, a log line, or a comment. The files on the CDN are ciphertext.
- *Access to the decrypted report.* A server route in the deployment checks the token and the expiry, fetches the ciphertext from its own deployment, decrypts it, and serves the browser the report's metadata first and each screenshot as it is shown (the browser may keep those screenshots in its own cache for up to a week, never past the link's expiry; shared caches never do). Without the exact token every path under the deployment answers `404`, including the Viewer itself; `ci:deploy` verifies this before it publishes the link.
- *Expiry.* The expiry (`report.preview.expiresAfter`, 30 days by default, `never` to disable) is sealed into the deployment when it is created and enforced by the route, not by the browser. After it passes, the exact token still opens the Viewer for a browser, but the report routes, the Markdown index, and the agent API answer `410` and the Viewer says the link expired on that date; every other path still answers `404`. To revoke a link earlier, delete the deployment in the EAS Hosting dashboard; the CDN stops serving it within seconds and the route within a few minutes. Deleting it does not reach into a browser that already opened the link: the screenshots that browser fetched stay in its cache until they age out.
- *Deletion.* Nothing is deleted automatically. Each review of a pull request deploys a new preview and the comment links the newest one (recorded in a hidden `<!-- expo-explore-deployments:… -->` line under the comment marker); earlier deployments and the deployments of closed pull requests stay until someone deletes them in the EAS Hosting dashboard or with `eas deploy:delete`, so a link keeps opening for as long as its expiry allows.
- *The token.* Every path of a preview carries the link's 160-bit token: the page at `/p/<token>`, each target's manifest at `/p/<token>/targets/<target>.json`, and every screenshot at `/p/<token>/assets/<sha256>.<ext>`. Nobody can find a path without the token. With any other token, every path under the deployment answers `404`, including the Viewer itself; `ci:deploy` verifies this before it publishes the link.
- *The report's files.* `ci:deploy` uploads the report as plain static files of the deployment, under the token. They are not encrypted: the token in their paths is what keeps them private, the same way it keeps the link private. EAS Hosting serves them directly, with its own default headers (the browser may cache a screenshot for an hour), and it cannot add `noindex` to them, so the deployment's `robots.txt` keeps crawlers away from them instead. The deployment's server route serves the page, the manifest the Viewer asks for, the target listing and the agent API, with `private, no-store` and `noindex`.
- *How long a link works.* A link works as long as its EAS Hosting deployment exists. Explore sets no expiry of its own. EAS Hosting deletes a deployment after 30 days on the Free plan and 90 days on paid plans, **unless an alias points at it**: an aliased deployment (such as `--alias` uploads of `explore:binary`) is kept until the alias moves or is deleted. To end a link sooner, delete the deployment in the EAS Hosting dashboard or with `eas deploy:delete` (delete its alias first if it has one); the CDN stops serving its files within about five minutes. To expire links on your own schedule, delete deployments from a scheduled job. Deleting a deployment does not reach into a browser that already opened the link: what that browser cached stays until it ages out. `report.preview.expiresAfter` and `--expires-in` from earlier versions are accepted and ignored, with a warning.
- *Deletion.* Explore deletes nothing. Each review of a pull request deploys a new preview and the comment links the newest one (recorded in a hidden `<!-- expo-explore-deployments:… -->` line under the comment marker); earlier deployments and the deployments of closed pull requests stay until EAS Hosting deletes them as above, or someone deletes them in the dashboard or with `eas deploy:delete`.
- *The Viewer itself.* The Viewer's JavaScript is public and the same for every deployment; it holds no report data.
- *Agent access.* The same link also answers as Markdown and as a JSON API (`/llms.txt`, `/api/v1/...`, see [the agent guide](../README.md#agents)) so a coding agent can read the report without a download. Those routes are served by the same server route from the same decrypted bytes, behind the same token, expiry, `private, no-store`, and `noindex`; they add no second credential and no new place where the report is stored.
- *Agent access.* The same link also answers as Markdown and as a JSON API (`/llms.txt`, `/api/v1/...`, see [the agent guide](../README.md#agents)) so a coding agent can read the report without a download. Those routes read the same static files, behind the same token, with `private, no-store` and `noindex`; they add no second credential and no new place where the report is stored.
**What is not protected.** The link is a bearer credential. Anyone who receives it, by forwarding the comment, a notification email, or a chat message, can open the report until it expires. Members of the Expo account who can inspect the preview project's deployments can read the key. Expo's request logs record URL paths, so they record the token; they do not record the report. Keep the default drop flow when a leaked link would be a problem.
**What is not protected.** The link is a bearer credential. Anyone who receives it, by forwarding the comment, a notification email, or a chat message, can open the report until the deployment is deleted. A screenshot's URL contains the token, so it is the link too: anyone who copies a screenshot's address can open the whole report. Members of the Expo account who can inspect the preview project's deployments can read its files. Expo's request logs record URL paths, so they record the token. Keep the default drop flow when a leaked link would be a problem.
**Comparison with the default.** The default flow uses GitHub's own permissions: a reviewer must be signed in to GitHub with read access to the repository to download the report. Hosted previews trade that check for one-click opening. Choose them when the review audience is the people who already see the PR.
+20 -1
View File
@@ -18,8 +18,27 @@ trap 'rm -rf "$work"' EXIT
if ! curl -fsS "$base/reports.json" -o "$work/listing.json"; then
echo '[{"platform":"ios"}]' > "$work/listing.json"
fi
# A preview deployed before Explore wrote static files serves each target's ZIP; a newer one serves its manifest and
# screenshots, so the ZIP is put back together here. Screenshot requests keep ?platform=, which deployments that
# answered them from the ZIP need and static files ignore.
for platform in $(jq -r '.[].platform' "$work/listing.json"); do
curl -fsS "$base/report.zip?platform=$platform" -o "$work/$platform.zip"
if curl -fsS "$base/report.zip?platform=$platform" -o "$work/$platform.zip" 2> /dev/null; then
unzip -tq "$work/$platform.zip" > /dev/null
continue
fi
report="$work/$platform"
mkdir -p "$report/assets"
curl -fsS "$base/manifest.json?platform=$platform" -o "$work/$platform.manifest.json"
file="$(jq -r .file "$work/$platform.manifest.json")"
[[ "$file" == review.json || "$file" == exploration.json ]] || { echo "Not a report manifest: $platform" >&2; exit 1; }
jq -c .report "$work/$platform.manifest.json" > "$report/$file"
for asset in $(jq -r '.entries | keys[]' "$work/$platform.manifest.json"); do
[[ "$asset" =~ ^assets/[a-f0-9]{64}\.(png|jpg|mp4)$ ]] || { echo "Unexpected asset name: $asset" >&2; exit 1; }
curl -fsS "$base/$asset?platform=$platform" -o "$report/$asset"
[[ "$(shasum -a 256 "$report/$asset" | cut -c1-64)" == "${asset:7:64}" ]] || { echo "Checksum mismatch: $asset" >&2; exit 1; }
done
rm -f "$work/$platform.zip"
(cd "$report" && zip -qrX "$work/$platform.zip" "$file" assets)
unzip -tq "$work/$platform.zip" > /dev/null
done
jq --arg source "$source_name" '[.[] | {platform, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
+2 -2
View File
@@ -28,7 +28,7 @@ Platform, bundle id, app name and version are read from the archive; do not pass
3. `agent-device install` of the archive straight into the session (Argent: `reinstall-app`; locally `simctl install` or `adb install`), then `open <bundle id>`.
4. The model explores through a small tool set (observe, act, capture, finish); app text is treated as untrusted and destructive controls (delete, reset, sign out, purchase, send, share) are blocked outside the model.
5. The map and screenshots are written under `--output` (default `./explore-<archive>-<timestamp>`), plus `report/` for the Viewer.
6. The report is sealed and deployed to EAS Hosting (`--no-upload` skips this; `--expires-in 7d|30d|never`). With `--simulator local` it opens in the local Viewer instead, which keeps running until stopped; `--json` and `--no-open` skip it, so with `--json` open it afterwards with `view --dir <output>` (in the background, since it serves until stopped). `--upload` hosts it, and that needs an EAS login.
6. The report is deployed to EAS Hosting as files under the link's token (`--no-upload` skips this); the link lasts as long as the deployment. With `--simulator local` it opens in the local Viewer instead, which keeps running until stopped; `--json` and `--no-open` skip it, so with `--json` open it afterwards with `view --dir <output>` (in the background, since it serves until stopped). `--upload` hosts it, and that needs an EAS login.
7. The exact session is stopped, or the local device deleted; a failure to stop reports `SESSION_CLEANUP_FAILED` with the command to stop it by hand. A local device a hard-stopped run left behind is removed by the next local run.
Budgets default to 15 minutes, 40 screens, 150 actions (`--max-duration-minutes`, `--max-screens`, `--max-actions`). Steer the model with `--hints "focus on the onboarding and settings"`, skip onboarding with `--launch-url myapp://home`, and allow a specific risky control with `--allow-destructive "Clear cache"`.
@@ -111,7 +111,7 @@ With `--json` the last stdout line is the result:
```json
{ "ok": true, "app": { "name": "euxy", "bundleId": "dev.brent.euxy", "platform": "ios", "version": "1.2.0" },
"exploration": { "stopReason": "finished", "screens": 9, "observations": 11, "actions": 23, "summary": "..." },
"map": ".../explore-euxy-.../map.json", "report": ".../explore-euxy-.../report", "url": "https://....expo.app/p/<token>", "expiresAt": "..." }
"map": ".../explore-euxy-.../map.json", "report": ".../explore-euxy-.../report", "url": "https://....expo.app/p/<token>", "expiresAt": null }
```
Share `url` (it is the only copy of the access token; it is not written to disk). Then query the map locally without a model or device:
+3 -3
View File
@@ -173,10 +173,10 @@ npx @expo/explore capture --base v1.3.0 --head v1.4.0 --scope all
## Compare any two commits
`explore-compare.yml` (installed by `setup --workflows` from 0.19.0; run `npx @expo/explore@latest setup --workflows` to add it to an existing setup) reviews a `head` against a `base`, each a branch, tag or commit SHA, with no pull request. It captures, compares and reports like a PR review and links the report from the run's summary. Its inputs are `base`, `head`, and the optional `scope` (`changes` or `all`) and `expires-in` (such as `30d`, or `never`).
`explore-compare.yml` (installed by `setup --workflows` from 0.19.0; run `npx @expo/explore@latest setup --workflows` to add it to an existing setup) reviews a `head` against a `base`, each a branch, tag or commit SHA, with no pull request. It captures, compares and reports like a PR review and links the report from the run's summary. Its inputs are `base`, `head`, and the optional `scope` (`changes` or `all`); `expires-in` from earlier versions is accepted and ignored, since a hosted link lasts as long as its EAS Hosting deployment.
- **Releases.** Unless the user asks otherwise, compare each release with the last stable release, with `scope: all` (every screen, so the report shows the whole release with what changed marked) and, when hosted previews are on, `expires-in: never` (the link outlives the 30-day artifact). For every tag as it is pushed, add the `release-review.yml` from the README's "Compare any two commits" section: it finds the newest earlier tag without a `-` (so a release candidate is compared with the last stable release) and calls `explore-compare.yml` with `secrets: inherit` and `permissions: { contents: read, actions: read }`. A nightly compares with yesterday's tag; a release branch with `main`.
- **Once, on demand.** The workflow must be on the default branch to be dispatched: `gh workflow run explore-compare.yml -f base=<ref> -f head=<ref> -f scope=all -f expires-in=never`, or **Run workflow** under Actions → Expo Explore compare.
- **Releases.** Unless the user asks otherwise, compare each release with the last stable release, with `scope: all` (every screen, so the report shows the whole release with what changed marked). A hosted link lasts as long as its EAS Hosting deployment (30 days on Free, 90 on paid plans, longer with an alias), which can outlive the 30-day artifact. For every tag as it is pushed, add the `release-review.yml` from the README's "Compare any two commits" section: it finds the newest earlier tag without a `-` (so a release candidate is compared with the last stable release) and calls `explore-compare.yml` with `secrets: inherit` and `permissions: { contents: read, actions: read }`. A nightly compares with yesterday's tag; a release branch with `main`.
- **Once, on demand.** The workflow must be on the default branch to be dispatched: `gh workflow run explore-compare.yml -f base=<ref> -f head=<ref> -f scope=all`, or **Run workflow** under Actions → Expo Explore compare.
- **Without CI.** `npx @expo/explore capture --base <ref> --head <ref> --scope all --upload` runs the same comparison on this machine (see the previous section).
- Call the workflow once per workflow run (a second call in the same run reuses the first one's artifact names). A `base` the baseline workflow captured in the last 30 days is reused, so only `head` is captured.
- To verify, run it once on the latest tag and open the run's summary: it lists each platform's result and links the report.
+3 -2
View File
@@ -294,8 +294,9 @@ export async function reservePort(port: number, environment: NodeJS.ProcessEnv):
const abandoned = async (path: string) => {
const info = await stat(path).catch(() => undefined);
if (!info) return false;
const owner = await readFile(join(path, "owner"), "utf8").catch(() => undefined);
return owner === undefined ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
// writeFile creates the owner file before it writes the pid, so an empty one is a holder mid-write too.
const owner = await readFile(join(path, "owner"), "utf8").catch(() => "");
return owner === "" ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
};
for (;;) {
try { await mkdir(mutex); await writeFile(join(mutex, "owner"), String(process.pid)); break; }
+2 -1
View File
@@ -268,7 +268,8 @@ export async function runCiReview(options: {
const { projects, output, config, environment, state, assertCurrentHead, postComment } = options;
const progress = options.progress ?? silentProgress;
// The controllers are fetched before any EAS work, so a blocked download fails before a session is paid for. agent-device
// also compares the screenshots. An injected runner (tests) runs no real controller.
// also compares the screenshots. An injected runner (tests) stands in for the controllers' calls, but not for that
// comparison: it still runs the real agent-device, which fetches itself on first use.
if (!options.runner) await prefetchControllers(config, environment, progress);
const pr = options.presentation;
const now = options.now ?? Date.now;
+5 -14
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,7 +26,7 @@ export async function exploreBinary(): Promise<void> {
"Run expo-explore explore:binary <path to .apk, .app, .tar.gz, or simulator .ipa>.");
if (has("upload") && has("no-upload")) argumentError("Pass either --upload or --no-upload", "no-upload");
const outputDirectory = resolve(process.cwd(), flag("output") ?? defaultOutputDirectory(archive));
const expiresAfterDays = expiresInDays(flag("expires-in") ?? "7d");
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
const platform = flag("platform") === undefined ? undefined : oneOf("platform", ["ios", "android"] as const);
const provider = flag("provider") === undefined ? undefined : oneOf("provider", ["anthropic", "openai"] as const);
const controller = flag("controller") === undefined ? undefined : oneOf("controller", ["agent-device", "argent"] as const);
@@ -66,7 +57,7 @@ export async function exploreBinary(): Promise<void> {
if (upload) {
say("hosting the report on EAS Hosting");
const owner = result.session.owner || flag("owner");
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.archive.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(owner ? { owner } : {}), expiresAfterDays, ...stableLinkOptions() });
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.archive.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(owner ? { owner } : {}), ...stableLinkOptions() });
say(`report: ${hosted.previewUrl}${hosted.expiresAt ? ` (expires ${hosted.expiresAt})` : ""}`);
}
const summary = { ok: true,
@@ -101,7 +92,7 @@ export async function exploreSession(): Promise<void> {
const session = positional() ?? flag("session");
const bundleId = flag("bundle-id");
const outputDirectory = resolve(process.cwd(), flag("output") ?? defaultOutputDirectory(bundleId ?? "session"));
const expiresAfterDays = expiresInDays(flag("expires-in") ?? "7d");
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
const platform = flag("platform") === undefined ? undefined : oneOf("platform", ["ios", "android"] as const);
const provider = flag("provider") === undefined ? undefined : oneOf("provider", ["anthropic", "openai"] as const);
const controller = flag("controller") === undefined ? undefined : oneOf("controller", ["agent-device", "argent"] as const);
@@ -129,7 +120,7 @@ export async function exploreSession(): Promise<void> {
let hosted: Awaited<ReturnType<typeof deployExplorationReport>> | undefined;
if (has("upload")) {
say("hosting the report on EAS Hosting");
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.app.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(flag("owner") ? { owner: flag("owner")! } : {}), expiresAfterDays, ...stableLinkOptions() });
hosted = await deployExplorationReport({ reportPath: report.reportPath, platform: result.app.platform, project: flag("project") ?? DEFAULT_BINARY_PROJECT, ...(flag("owner") ? { owner: flag("owner")! } : {}), ...stableLinkOptions() });
say(`report: ${hosted.previewUrl}${hosted.expiresAt ? ` (expires ${hosted.expiresAt})` : ""}`);
}
const summary = { ok: true, app: result.app, device: { model: result.runtime.deviceModel, osVersion: result.runtime.osVersion },
+6 -4
View File
@@ -15,7 +15,7 @@ import { installCiFiles } from "../ci/workflow-install.js";
import { readRouteEntry } from "../ci/route-entry.js";
import { buildVerifiedPlan } from "../ci/verified-plan.js";
import { formatCaptureCheck, formatDoctorReport, referencedSecretNames, runCaptureCheck, runDoctor } from "../ci/doctor.js";
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, previewDays, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExplorePlatform } from "../config/explore-config.js";
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf, positiveInteger } from "./args.js";
import { help } from "./help.js";
import { CiError } from "../shared/ci-errors.js";
@@ -222,6 +222,8 @@ export async function captureReview(): Promise<void> {
const configPath = flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH;
const selection = targetSelection();
const rawConfig = await readExploreConfig(headProject, configPath);
// A release comparison's workflow may still pass --expires-in; ci:deploy says once that report.preview.expiresAfter is ignored.
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
const config = withRunOverrides(resolveTargetConfig(rawConfig, selection), { scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
if (has("pull-request") === has("compare")) argumentError("Pass --pull-request FILE for a pull request, or --compare FILE for any two commits.", has("compare") ? "compare" : "pull-request");
// A matrix job names its target; its artifacts, report and comment section carry the target's id.
@@ -245,6 +247,7 @@ export async function captureBaseline(): Promise<void> {
/** `capture` (or `capture:review`) `[--base REF] [--head REF | --committed]`: a local review, opened in the Viewer or hosted with --upload. */
async function localReview(): Promise<void> {
const platform = platformFlag(), target = targetFlag();
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
const parallel = has("parallel") ? positiveInteger("parallel") : undefined;
const result = await runLocalReview({ project: flag("project") ?? process.cwd(), base: flag("base"), head: flag("head"), ...(target ? { target } : {}),
...(parallel ? { parallel } : {}),
@@ -276,9 +279,8 @@ async function localReview(): Promise<void> {
...(result.head.uncommitted?.length ? { uncommittedFiles: result.head.uncommitted.length } : {}) });
if (has("upload")) {
const preview = result.config.report?.preview;
const hosted = await deployLocalReports({ reports: zips, project: previewProjectSlug(result.repository, preview?.project), ...(preview?.owner ? { owner: preview.owner } : {}),
// null is expiresAfter: never, which must not fall back to the default.
expiresAfterDays: has("expires-in") ? previewDays(required("expires-in"), "--expires-in") : preview ? preview.expiresAfterDays : PREVIEW_DEFAULT_DAYS });
if (preview?.expiresAfterIgnored) warnIgnoredExpiry("report.preview.expiresAfter");
const hosted = await deployLocalReports({ reports: zips, project: previewProjectSlug(result.repository, preview?.project), ...(preview?.owner ? { owner: preview.owner } : {}) });
// Hosted, the temporary copies are not needed (a failed upload keeps them for report:upload); --output keeps its own.
const copied = has("output");
if (!copied) await rm(result.work, { recursive: true, force: true });
+3 -3
View File
@@ -18,7 +18,7 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
doctor --capture [--project DIRECTORY] [--output DIRECTORY] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--yes]
(captures the committed HEAD like the baseline workflow, with your eas login, and reports each route)
capture [--base REF] [--head REF | --committed] [--target ID | --platform ios|android] [--parallel N] [--scope all|changes]
[--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--upload [--expires-in 7d|30d|never]] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
[--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--upload] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
(on this machine: checks out both commits in temporary worktrees, captures them with your eas login (in agent
mode, also your local claude or codex login), and opens the report; the head is HEAD with your uncommitted changes, as eas build
uploads them (--committed, or cli.requireCommit in eas.json, leaves them out); the base defaults to where HEAD
@@ -39,7 +39,7 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
(the runs kept on this machine: local reviews, explorations and uploaded reports, for 30 days or up to 2 GB;
in a terminal, an arrow-key picker: Enter opens a run in the local Viewer, u hosts it, d deletes it;
ID is a run's id from reports list, or latest; EXPLORE_INTRO=off skips the title animation)
report:upload <report.zip | report directory>... [--owner ACCOUNT] [--project SLUG] [--expires-in 7d|30d|never] [--config FILE] [--json]
report:upload <report.zip | report directory>... [--owner ACCOUNT] [--project SLUG] [--config FILE] [--json]
(hosts reports already on this machine on EAS Hosting behind one link, with your eas login: one per platform
of the same review, from capture:review --output or a downloaded explore-review artifact, or one explore:binary report)`;
@@ -55,7 +55,7 @@ const BINARY = `Prebuilt apps (no source needed; runs with your local claude or
(a sign-in in --hints is written as {{secret:NAME}}: Explore types the value of the environment variable NAME,
and the model and the report only see the reference)
--max-duration-minutes N --max-screens N --max-actions N --provider anthropic|openai --model ID
--owner ACCOUNT --project SLUG --expires-in 7d|30d|never --allow-destructive "Label,Other label"
--owner ACCOUNT --project SLUG --allow-destructive "Label,Other label"
--alias NAME (one EAS Hosting host per app that always serves the newest run; with EXPLORE_PREVIEW_TOKEN
set to a fixed 32-character token, the hosted link is the same every run)
(iOS needs a simulator build; a device .ipa and Android .aab are rejected before any device starts)
+6 -7
View File
@@ -3,7 +3,7 @@ import { readFile, stat } from "node:fs/promises";
import { basename, dirname, join, relative, resolve, sep } from "node:path";
import { DEFAULT_BINARY_PROJECT } from "../binary/run.js";
import { pruneCaptureCache, repositoryName } from "../ci/local-review.js";
import { readExploreConfig, previewDays, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExploreConfig } from "../config/explore-config.js";
import { readExploreConfig, warnIgnoredExpiry, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig } from "../config/explore-config.js";
import { assertHostingExport, deployLocalReports, previewProjectSlug, readReportZip, zipReportDirectory, MAX_REPORT_BYTES, type ReportZipSummary } from "../report/preview-deploy.js";
import { startLocalReportServer } from "../report/local-report-server.js";
import { findSavedRun, listSavedRuns, pruneSavedRuns, readSavedReports, removeSavedRun, reportTarget, saveRun, savedRunsDirectory, SAVED_RUN_LIMITS, type SavedReport, type SavedRun } from "../report/saved-runs.js";
@@ -11,10 +11,9 @@ import { openViewerInBrowser } from "../map/viewer-server.js";
import { formatBytes, friendlyTime, kindLabel, runPicker, runTitle } from "./reports-picker.js";
import { pickIntro } from "./title-intros.js";
import { CiError, toCiError } from "../shared/ci-errors.js";
import { argumentError, flag, has, nonNegativeInteger, output, positionals, required } from "./args.js";
import { argumentError, flag, has, nonNegativeInteger, output, positionals } from "./args.js";
/** explore:binary's default: an exploration link is for a quick look. */
const EXPLORATION_DEFAULT_DAYS = 7;
/** A report directory (review.json or exploration.json and assets/), its parent holding report.zip, or a report ZIP. */
async function readReport(path: string): Promise<{ path: string; zip: Uint8Array; summary: ReportZipSummary }> {
@@ -94,12 +93,12 @@ async function hostReports(reports: ReadReport[]): Promise<void> {
const found = review ? await repositoryPreview(review.repository) : undefined;
const preview = found?.preview;
if (review) process.stderr.write(found ? `report.preview from ${found.source}\n`
: `no config of ${review.repository} here: hosting with the defaults (pass --config, or --owner, --project and --expires-in)\n`);
: `no config of ${review.repository} here: hosting with the defaults (pass --config, or --owner and --project)\n`);
const project = flag("project") ?? (review ? previewProjectSlug(review.repository, preview?.project) : DEFAULT_BINARY_PROJECT);
const owner = flag("owner") ?? preview?.owner;
const expiresAfterDays = has("expires-in") ? previewDays(required("expires-in"), "--expires-in")
: preview ? preview.expiresAfterDays : review ? PREVIEW_DEFAULT_DAYS : EXPLORATION_DEFAULT_DAYS;
const hosted = await deployLocalReports({ project, ...(owner ? { owner } : {}), expiresAfterDays,
if (has("expires-in")) warnIgnoredExpiry("--expires-in");
else if (preview?.expiresAfterIgnored) warnIgnoredExpiry("report.preview.expiresAfter");
const hosted = await deployLocalReports({ project, ...(owner ? { owner } : {}),
reports: reports.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip,
...(report.summary.changes === undefined ? {} : { changes: report.summary.changes }), ...(report.summary.device ? { device: report.summary.device } : {}) })),
ownerHint: "Pass --owner with the Expo account that should host the report.",
+15 -23
View File
@@ -104,7 +104,7 @@ export type ExploreConfig = {
setup?: ExploreSetupAction[];
agent?: { provider: "openai" | "anthropic"; model: string; instructions?: string };
/** Hosted previews: one token-gated EAS Hosting deployment per review, see docs/private-review.md. */
report?: { preview?: { hosting: "eas"; /** null: the link never expires; the deployment lives until someone deletes it. */ expiresAfterDays: number | null; owner?: string; project?: string };
report?: { preview?: { hosting: "eas"; /** `expiresAfter` was set; it no longer applies (see IGNORED_EXPIRY). */ expiresAfterIgnored?: true; owner?: string; project?: string };
/** `map`: the PR comment draws a Mermaid map of the changed screens and the screens that lead to them. Off by default. */
comment?: { map: boolean } };
/**
@@ -115,8 +115,16 @@ export type ExploreConfig = {
ci?: { trustedAuthors?: string[] };
};
export const PREVIEW_MAX_DAYS = 365;
export const PREVIEW_DEFAULT_DAYS = 30;
/**
* What `report.preview.expiresAfter` and `--expires-in` say now that Explore sets no expiry: a hosted preview lasts as long
* as its EAS Hosting deployment. Both are still accepted, so configs and copied workflows keep working.
*/
export const IGNORED_EXPIRY = "no longer applies: a hosted preview lasts as long as its EAS Hosting deployment, which EAS deletes after 30 days on Free and 90 on paid plans unless an alias points at it. Delete the deployment (eas deploy:delete) to remove it sooner.";
/** Says once, on stderr (a warning annotation in GitHub Actions), that an expiry setting is ignored. */
export function warnIgnoredExpiry(setting: string, environment: NodeJS.ProcessEnv = process.env): void {
process.stderr.write(`${environment.GITHUB_ACTIONS === "true" ? "::warning::" : ""}${setting} ${IGNORED_EXPIRY}\n`);
}
const MAX_CONFIG_BYTES = 64 * 1024;
const UNSAFE_CHARACTERS = /[\u0000-\u001f\u007f]/;
@@ -507,8 +515,8 @@ export function resolvePlatformConfig(config: ExploreConfig, platform: ExplorePl
/**
* One run's choices over the reviewed config, from the workflow that started it: a release comparison can capture
* every screen (`scope: all`) and keep its hosted link (`expiresIn: never`). `expiresIn` changes nothing when the
* config hosts no report.
* every screen (`scope: all`). `expiresIn` (`--expires-in`) is accepted from workflows written before Explore stopped
* setting an expiry, and changes nothing.
*/
export function withRunOverrides(config: ExploreConfig, overrides: { scope?: string | undefined; expiresIn?: string | undefined; controller?: string | undefined; simulator?: string | undefined; repack?: string | undefined }): ExploreConfig {
let result = config;
@@ -530,11 +538,6 @@ export function withRunOverrides(config: ExploreConfig, overrides: { scope?: str
if (overrides.scope !== "changes" && overrides.scope !== "all") fail("--scope must be changes or all", "--scope");
result = { ...result, exploration: { ...result.exploration, scope: overrides.scope } };
}
if (overrides.expiresIn !== undefined) {
// Validated even without hosting, so a typo in a release workflow surfaces before hosting is turned on.
const expiresAfterDays = previewDays(overrides.expiresIn, "--expires-in");
if (result.report?.preview) result = { ...result, report: { ...result.report, preview: { ...result.report.preview, expiresAfterDays } } };
}
return result;
}
@@ -546,18 +549,6 @@ export function captureRepack(config: ExploreConfig): "eas" | "local" {
return config.capture.repack ?? (config.capture.simulator === "local" ? "local" : "eas");
}
/** `expiresAfter` is a whole number of days (`30d`, `30 days`, or `30`), at most PREVIEW_MAX_DAYS, or `never` (null). */
export function previewDays(value: unknown, field: string): number | null {
if (value === undefined) return PREVIEW_DEFAULT_DAYS;
if (typeof value === "string" && /^\s*never\s*$/i.test(value)) return null;
const match = typeof value === "number" ? [null, String(value)] : typeof value === "string" ? /^\s*(\d{1,3})\s*(?:d|days?)?\s*$/i.exec(value) : null;
const days = match ? Number(match[1]) : Number.NaN;
if (!Number.isInteger(days) || days < 1 || days > PREVIEW_MAX_DAYS) {
fail(`${field} must be between 1 and ${PREVIEW_MAX_DAYS} days, such as 30d, or never`, field);
}
return days;
}
const GITHUB_LOGIN = /^[A-Za-z0-9](?:[A-Za-z0-9]|-(?=[A-Za-z0-9])){0,38}(?:\[bot\])?$/;
export const TRUSTED_AUTHORS_MAX = 20;
@@ -618,7 +609,8 @@ function previewConfig(value: unknown): NonNullable<ExploreConfig["report"]>["pr
}
return {
hosting: literal(preview.hosting, ["eas"] as const, "report.preview.hosting"),
expiresAfterDays: previewDays(preview.expiresAfter, "report.preview.expiresAfter"),
// Accepted from configs written before Explore stopped setting an expiry; the commands that host say it is ignored.
...(preview.expiresAfter === undefined ? {} : { expiresAfterIgnored: true as const }),
...(owner === undefined ? {} : { owner }),
...(project === undefined ? {} : { project }),
};
+33 -15
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 = {
@@ -465,9 +482,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) } };
}
+4 -2
View File
@@ -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");
+18 -9
View File
@@ -69,15 +69,24 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
return send(reply.status, body, reply.contentType, { vary: "Accept", ...reply.headers });
}
if (isPage) return send(200, await readFile(resolve(viewerRoot, "index.html")), TYPES[".html"]);
// What the Viewer opens (preview-manifest.ts, shared with the hosted Worker): the manifest, then each asset as it is shown.
if (url.pathname === `${page}/manifest.json` || url.pathname.startsWith(`${page}/assets/`)) {
if (!report) return send(404, "Not found");
if (!loaded.has(report)) loaded.set(report, loadReport(report.zip));
const content = await loaded.get(report);
if (!content) return send(404, "Not found");
if (url.pathname === `${page}/manifest.json`) return send(200, manifestBody(content), TYPES[".json"]);
const asset = await previewAsset(content, url.pathname.slice(page.length + 1));
return asset ? send(200, asset.bytes, asset.type) : send(404, "Not found");
// What the Viewer opens (preview-manifest.ts, as a hosted preview serves it): the manifest, then each asset as it is
// shown. An asset is named by its SHA-256 and carries no target, so it comes from whichever report holds it.
const read = (entry: LocalReport) => {
if (!loaded.has(entry)) loaded.set(entry, loadReport(entry.zip));
return loaded.get(entry)!;
};
if (url.pathname === `${page}/manifest.json`) {
const content = report ? await read(report) : undefined;
return content ? send(200, manifestBody(content), TYPES[".json"]) : send(404, "Not found");
}
if (url.pathname.startsWith(`${page}/assets/`)) {
const path = url.pathname.slice(page.length + 1);
for (const entry of options.reports) {
const content = await read(entry);
const asset = content ? await previewAsset(content, path) : undefined;
if (asset) return send(200, asset.bytes, asset.type);
}
return send(404, "Not found");
}
if (url.pathname === `${page}/report.zip`) return report ? send(200, report.zip, "application/zip") : send(404, "Not found");
if (url.pathname === `${page}/reports.json` && options.reports.length > 1) return send(200, listing, TYPES[".json"]);
+150 -103
View File
@@ -1,15 +1,15 @@
import { createCipheriv, createHash, randomBytes } from "node:crypto";
import { createHash, randomBytes } from "node:crypto";
import { spawnSync } from "node:child_process";
import { appendFile, cp, lstat, mkdir, mkdtemp, readdir, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join, relative, resolve, sep } from "node:path";
import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from "@zip.js/zip.js";
import { loadReport, MAX_METADATA_BYTES } from "./agent-api.js";
import { manifestBody } from "./preview-manifest.js";
import { MAX_ASSET_BYTES, manifestBody, PREVIEW_ASSET } from "./preview-manifest.js";
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
import { isTargetId, warnIgnoredExpiry, type ExplorePlatform } from "../config/explore-config.js";
import type { RunTarget } from "../types.js";
import { targetParameter } from "./viewer-links.js";
import type { ArtifactReport } from "../contracts/artifact-report.js";
@@ -22,21 +22,23 @@ import { TOOL_ROOT, packageBin } from "../shared/package-paths.js";
/**
* `ci:deploy`: publish one token-gated EAS Hosting deployment for a packaged review.
*
* The deployment is the prebuilt preview export of viewer-host (routes `/p/[token]`, see viewer-host/README.md)
* plus the report ZIP encrypted with a key that only the deployment's Worker environment holds. The Worker
* serves the Viewer and the decrypted report at `/p/<token>` and answers 404 to everything else; after
* `expiresAt` (if any) the token page says the link expired. Deployments are never deleted automatically. The report job already published the GitHub artifact links, so a failed deployment leaves
* the comment on the download-and-drop flow.
* The deployment is the prebuilt preview export of viewer-host (routes `/p/[token]`, see viewer-host/README.md) plus
* the report as static files under the link's token: each target's manifest at `p/<token>/targets/<target>.json` and
* every screenshot at `p/<token>/assets/<sha256>.<ext>`. Nothing is encrypted; the 160-bit token in every path is what
* keeps them private. The Worker serves the Viewer at `/p/<token>` and answers 404 to everything else. A deployment
* lasts as long as EAS Hosting keeps it (it deletes deployments without an alias after 30 days on Free, 90 on paid
* plans); Explore sets no expiry of its own. The report job already published the GitHub artifact links, so a failed
* deployment leaves the comment on the download-and-drop flow.
*/
export type CommandRunner = (command: string, args: readonly string[], options: { cwd: string; env: NodeJS.ProcessEnv })
=> { status: number | null; stdout: string; stderr: string };
export type PreviewReportInput = {
/** Set by the matrix workflows; the preview then serves this report at report.zip?platform=<platform>. */
/** Set by the matrix workflows; the preview then serves this report at manifest.json?platform=<platform>. */
platform?: ExplorePlatform;
/**
* The capture target, set by the matrix workflows (wins over `platform`): the preview serves the report as
* `<target id>.zip.enc` at report.zip?target=<id> (?platform=<id> for a target named after its platform).
* `targets/<target id>.json`, selected by manifest.json?target=<id> (?platform=<id> for a target named after its platform).
*/
target?: RunTarget;
inputPath: string;
@@ -46,7 +48,7 @@ export type PreviewReportInput = {
};
export type PreviewDeployOptions = (PreviewReportInput | {
/** One report per platform from the same run, sealed into one deployment behind one token. */
/** One report per platform from the same run, deployed together behind one token. */
reports: PreviewReportInput[];
}) & {
environment?: NodeJS.ProcessEnv;
@@ -82,7 +84,6 @@ export type PreviewDeployResult = {
};
export const PREVIEW_EXPORT_PATH = join(TOOL_ROOT, "dist", "hosting-preview");
const CIPHER_AAD = "expo-explore-preview/1";
const BASE32 = "abcdefghijklmnopqrstuvwxyz234567";
/** The largest report ZIP a hosted preview serves. */
export const MAX_REPORT_BYTES = 256 * 1024 * 1024;
@@ -94,7 +95,7 @@ export function platformTarget(platform: ExplorePlatform): RunTarget {
return { id: platform, platform, label: PLATFORM_LABELS[platform] };
}
/** The report.zip query that selects a target (see targetParameter): `?platform=ios` for configs without targets, as before. */
/** The manifest.json query that selects a target (see targetParameter): `?platform=ios` for configs without targets, as before. */
function targetQuery(target: RunTarget): string {
const [key, value] = targetParameter(target.id);
return `?${key}=${value}`;
@@ -142,11 +143,21 @@ const DEPLOY_ATTEMPTS = 3;
const ALIAS_LIMIT = /reached the limit of \d+ aliases[^\n]*/;
const DEPLOY_RETRY_DELAYS_MS = [5_000, 15_000] as const;
/** The tail of what a command printed, stderr first, without the EXPO_TOKEN should eas ever echo it. */
function commandOutput(result: ReturnType<CommandRunner>, token: string | undefined): string {
/**
* EAS Hosting serves static files with its own headers, so the screenshots and manifests cannot carry the Worker's
* `noindex`; this keeps crawlers from fetching them. The page and API stay crawlable, so a crawler still sees their `noindex`.
*/
export const PREVIEW_ROBOTS = "User-agent: *\nDisallow: /p/*/assets/\nDisallow: /p/*/targets/\n";
/**
* The tail of what a command printed, stderr first, without the secrets: the EXPO_TOKEN should eas ever echo it, and the
* link's token, which every static file's path carries (eas names the file whose upload failed).
*/
function commandOutput(result: ReturnType<CommandRunner>, secrets: Array<string | undefined>): string {
const lines = `${result.stderr}\n${result.stdout}`.split("\n").map(line => line.trimEnd()).filter(Boolean);
const tail = lines.slice(-30).join("\n");
return token ? tail.split(token).join("***") : tail;
let tail = lines.slice(-30).join("\n");
for (const secret of secrets) if (secret) tail = tail.split(secret).join("***");
return tail;
}
/** `eas whoami` has no JSON output; its account list is one `• name (Role: …)` line per account. */
@@ -253,13 +264,6 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
}
/** iv (12 bytes) || AES-256-GCM ciphertext || tag, authenticated with the preview AAD; what the Worker decrypts. */
export function sealReport(plain: Uint8Array, key: Uint8Array, iv: Uint8Array): Uint8Array {
const cipher = createCipheriv("aes-256-gcm", key, iv);
cipher.setAAD(Buffer.from(CIPHER_AAD));
const body = Buffer.concat([cipher.update(plain), cipher.final(), cipher.getAuthTag()]);
return new Uint8Array(Buffer.concat([iv, body]));
}
/** Fails fast when the Viewer export that hosted reports need is not installed, so a run does not explore for minutes before learning it cannot upload. */
export async function assertHostingExport(exportPath: string = PREVIEW_EXPORT_PATH): Promise<void> {
await assertExport(resolve(exportPath));
@@ -273,12 +277,13 @@ async function assertExport(exportPath: string): Promise<void> {
}
}
type SealedReport = { entry: PreviewReportInput; input: CiReportInput; target?: RunTarget; zip: Uint8Array; sha256: string; file: string };
/** A report to deploy; `file` names its manifest, `targets/<file>.json`: the target id, or `report` for a single unlisted one. */
type DeployedReport = { entry: PreviewReportInput; input: CiReportInput; target?: RunTarget; zip: Uint8Array; sha256: string; file: string };
function previewError(code: string, message: string, nextAction: string): CiError { return new CiError({ code, stage: "preflight", message, nextAction }); }
/**
* A device label for the platform switch, safe in the sealed .env: letters, digits and a few separators only. `eas
* A device label for the platform switch, safe in the deployment's .env: letters, digits and a few separators only. `eas
* deploy` reads that file with variable expansion, so a `$` (even single-quoted) would pull the deploying process's
* environment into the label, and a `#` or a backslash would cut or corrupt the JSON around it.
*/
@@ -292,14 +297,25 @@ function listingLabel(label: string): string {
/** One EXPLORE_PREVIEW_REPORTS entry, keys in the order the Worker echoes them in reports.json. */
export type PreviewListingEntry = { target: string; platform: ExplorePlatform; label?: string; path: string; changes?: number; device?: string };
function listingEntry(target: RunTarget, path: string, changes?: number, device?: string): PreviewListingEntry {
/** A listing entry before the deployment's token, and so its manifest's path, is known. */
type ListingTarget = Omit<PreviewListingEntry, "path">;
function listingEntry(target: RunTarget, changes?: number, device?: string): ListingTarget {
const label = listingLabel(target.label), shown = device ? listingDevice(device) : "";
return { target: target.id, platform: target.platform, ...(label ? { label } : {}), path, ...(changes === undefined ? {} : { changes }), ...(shown ? { device: shown } : {}) };
return { target: target.id, platform: target.platform, ...(label ? { label } : {}), ...(changes === undefined ? {} : { changes }), ...(shown ? { device: shown } : {}) };
}
/** The entry with its manifest's path, where the Worker reads it from (`path` after `label`, as reports.json leaves it out). */
function listedAt(entry: ListingTarget, path: string): PreviewListingEntry {
const { changes, device, ...head } = entry;
return { ...head, path, ...(changes === undefined ? {} : { changes }), ...(device === undefined ? {} : { device }) };
}
/** Where a deployment serves a target's manifest. */
export function manifestPath(token: string, file: string): string {
return `/p/${token}/targets/${file}.json`;
}
/** The worker's EXPLORE_PREVIEW_REPORTS entries, in the order the workflow lists targets; also what reports.json must echo. */
export function previewReportListing(reports: ReadonlyArray<Pick<SealedReport, "input" | "file"> & { target: RunTarget }>, reportDirectory: string): PreviewListingEntry[] {
return reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, reviewChangeCount(report.input.commentState), reviewDevice(report.input.commentState)));
/** The worker's EXPLORE_PREVIEW_REPORTS entries without their paths, in the order the workflow lists targets. */
export function previewReportListing(reports: ReadonlyArray<Pick<DeployedReport, "input"> & { target: RunTarget }>): ListingTarget[] {
return reports.map(report => listingEntry(report.target, reviewChangeCount(report.input.commentState), reviewDevice(report.input.commentState)));
}
export async function deployPreview(options: PreviewDeployOptions): Promise<PreviewDeployResult> {
@@ -325,6 +341,8 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
const first = inputs[0]!.input; const review = first.publicReview; const pr = review.pullRequest;
if (!first.preview) throw new CiError({ code: "PREVIEW_NOT_CONFIGURED", stage: "preflight",
message: "This review did not request a hosted preview", nextAction: "Set report.preview.hosting: eas in .expo-explore/config.yaml, or remove the deploy job." });
// `expiresAfterDays` is what a capture from before Explore stopped setting an expiry recorded.
if (first.preview.expiresAfterIgnored || "expiresAfterDays" in first.preview) warnIgnoredExpiry("report.preview.expiresAfter", environment);
if (!environment.EXPO_TOKEN?.trim()) throw new CiError({ code: "EXPO_TOKEN_MISSING", stage: "preflight",
message: "EXPO_TOKEN is required to deploy a hosted preview", nextAction: "Pass the EXPO_TOKEN secret to the deploy job; it must be able to create projects in the app's Expo account." });
if (!environment.GITHUB_TOKEN?.trim()) throw new CiError({ code: "GITHUB_TOKEN_MISSING", stage: "preflight",
@@ -340,27 +358,25 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
await assertExport(exportPath);
const reports: SealedReport[] = [];
const reports: DeployedReport[] = [];
for (const { entry, input, target } of inputs) {
let zip: Uint8Array;
try { zip = await zipReportDirectory(entry.reportPath); }
catch (error) { throw toCiError(error, { code: "REPORT_ZIP_FAILED", stage: "export",
nextAction: "Pass the ci:report output directory downloaded from this run's explore-review artifact." }); }
reports.push({ entry, input, ...(target ? { target } : {}), zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi && target ? `${target.id}.zip.enc` : "report.zip.enc" });
reports.push({ entry, input, ...(target ? { target } : {}), zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi && target ? target.id : "report" });
}
const reportDirectory = base32(random(10));
const expiresAt = first.preview.expiresAfterDays === null ? null : now() + first.preview.expiresAfterDays * 86_400_000;
const project = previewProjectSlug(pr.repository, first.preview.project);
const listing = multi ? previewReportListing(reports.map(report => ({ ...report, target: report.target! })), reportDirectory) : undefined;
let hosted: Awaited<ReturnType<typeof deploySealedReports>>;
const listing = multi ? previewReportListing(reports.map(report => ({ ...report, target: report.target! }))) : undefined;
let hosted: Awaited<ReturnType<typeof deployReports>>;
try {
hosted = await deploySealedReports({
hosted = await deployReports({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: multi && report.target ? targetQuery(report.target) : "" })),
reportDirectory, ...(listing ? { listing } : {}), project, ...(first.preview.owner ? { owner: first.preview.owner } : {}),
...(listing ? { listing } : {}), project, ...(first.preview.owner ? { owner: first.preview.owner } : {}),
ownerHint: "Set report.preview.owner in .expo-explore/config.yaml to the account that should hold the preview project.",
projectHint: "Give EXPO_TOKEN's account permission to create projects, or set report.preview.project to an existing project it can deploy to.",
expiresAt, exportPath, environment, run, transport, now, random, ...(options.sleep ? { sleep: options.sleep } : {}),
exportPath, environment, run, transport, now, random, ...(options.sleep ? { sleep: options.sleep } : {}),
// The runner masks secrets in job summaries too, so a masked token would reach a comparison's summary as ***.
// Its link appears nowhere else (not in the log), as a PR's appears only in its comment, for the same readers.
...(options.onSecret && pr.origin !== "compare" ? { onSecret: options.onSecret } : {}),
@@ -377,15 +393,15 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
}
const previewUrl = hosted.previewUrl;
// A comparison has no pull request: its link goes to the run's summary, which the same repository readers see.
if (pr.origin === "compare") await writeCompareSummary(environment, pr, previewUrl, expiresAt, reports.map(report => report.input));
if (pr.origin === "compare") await writeCompareSummary(environment, pr, previewUrl, reports.map(report => report.input));
{
let headSha = pr.head.sha;
if (pr.origin !== "compare") for (const report of reports) {
const published = await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
...commentTarget(report), preview: { url: previewUrl, expiresAt } });
...commentTarget(report), preview: { url: previewUrl, expiresAt: null } });
headSha = published.headSha;
}
return { previewUrl, expiresAt: expiresAt === null ? null : new Date(expiresAt).toISOString(), deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
return { previewUrl, expiresAt: null, deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
project, owner: hosted.owner, reportSha256: reports[0]!.sha256, reportBytes: reports[0]!.zip.byteLength,
reports: reports.map(report => ({ ...(report.entry.platform ? { platform: report.entry.platform } : {}), ...(report.target ? { target: report.target } : {}), artifactUrl: report.entry.artifactUrl,
reportSha256: report.sha256, reportBytes: report.zip.byteLength })), headSha,
@@ -394,13 +410,13 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
}
/** Which comment section and artifact a report is: its target, or (single-report runs) none. */
function commentTarget(report: SealedReport): { target?: string; platform?: ExplorePlatform } {
function commentTarget(report: DeployedReport): { target?: string; platform?: ExplorePlatform } {
if (report.target) return { target: report.target.id, platform: report.target.platform };
return report.entry.platform ? { platform: report.entry.platform } : {};
}
/** The comparison's job summary: what was compared, the hosted link, and each target's change count. */
export function renderCompareSummary(comparison: CompareReviewPresentation, previewUrl: string, expiresAt: number | null, inputs: CiReportInput[]): string {
export function renderCompareSummary(comparison: CompareReviewPresentation, previewUrl: string, inputs: CiReportInput[]): string {
const platforms = inputs.map(input => {
const changes = reviewChangeCount(input.commentState);
const device = reviewDevice(input.commentState);
@@ -408,15 +424,14 @@ export function renderCompareSummary(comparison: CompareReviewPresentation, prev
return `- ${label}${device ? ` (${device})` : ""}: ${changes === undefined ? "no review" : `${changes} ${changes === 1 ? "change" : "changes"}`}`;
});
return [`### Explore: ${compareTitleMarkdown(comparison)}`, "",
`[Open the report](${previewUrl}) · [${comparison.base.sha.slice(0, 8)}..${comparison.head.sha.slice(0, 8)}](${comparison.url})`
+ (expiresAt === null ? "" : ` · link expires ${new Date(expiresAt).toISOString().slice(0, 10)}`), "",
`[Open the report](${previewUrl}) · [${comparison.base.sha.slice(0, 8)}..${comparison.head.sha.slice(0, 8)}](${comparison.url})`, "",
...platforms, ""].join("\n");
}
async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: CompareReviewPresentation, previewUrl: string, expiresAt: number | null, inputs: CiReportInput[]) {
async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: CompareReviewPresentation, previewUrl: string, inputs: CiReportInput[]) {
const path = environment.GITHUB_STEP_SUMMARY;
if (!path) return;
await appendFile(path, renderCompareSummary(comparison, previewUrl, expiresAt, inputs));
await appendFile(path, renderCompareSummary(comparison, previewUrl, inputs));
}
type HostedReportInput = { zip: Uint8Array; sha256: string; file: string; query: string };
@@ -428,12 +443,53 @@ export const HOSTING_ALIAS = /^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$/;
export const HOSTED_TOKEN = /^[a-z2-7]{32}$/;
/**
* Seal the report ZIPs, deploy the exported Viewer around them to EAS Hosting, and verify the live bytes.
* Shared by the PR preview (`ci:deploy`) and standalone exploration reports; it knows nothing about GitHub.
* Each report's manifest at `p/<token>/targets/<file>.json` and every asset once at `p/<token>/assets/<sha256>.<ext>`
* (targets that share a screenshot share its file), under the export's client directory. Every asset's bytes must hash
* to its name. `deployment` stamps every manifest, so a check can tell this deployment from one an alias still serves.
* Returns, per report, the manifest written and one asset to fetch back.
*/
async function deploySealedReports(options: {
reports: HostedReportInput[]; reportDirectory: string; listing?: ReturnType<typeof previewReportListing>; project: string; owner?: string;
ownerHint: string; projectHint: string; expiresAt: number | null; exportPath: string; environment: NodeJS.ProcessEnv; run: typeof defaultRun;
async function writeReportFiles(client: string, token: string, reports: HostedReportInput[], deployment: string): Promise<Array<{ manifest: string; asset?: string }>> {
await writeFile(join(client, "robots.txt"), PREVIEW_ROBOTS);
const root = join(client, "p", token);
await mkdir(join(root, "targets"), { recursive: true });
await mkdir(join(root, "assets"), { recursive: true });
// Each asset's size as written: a target that shares the file must list the same size in its manifest.
const assets = new Map<string, number>();
const written: Array<{ manifest: string; asset?: string }> = [];
for (const report of reports) {
const loaded = await loadReport(report.zip);
if (!loaded) throw deployError("REPORT_ZIP_FAILED", "The report ZIP is not a report the hosted Viewer can open.", "Pass the report directory or ZIP that Explore wrote.");
const manifest = manifestBody(loaded, deployment);
await writeFile(join(root, "targets", `${report.file}.json`), manifest);
let first: string | undefined;
for (const [name, entry] of loaded.entries) {
const sha = PREVIEW_ASSET.exec(name)?.[1];
if (!sha) continue;
first ??= name;
const bad = () => deployError("REPORT_ZIP_FAILED", `The report's ${name} is unreadable, larger than ${MAX_ASSET_BYTES / 1024 / 1024} MiB, or does not match its name.`,
"Capture the report again; its screenshots are named by their SHA-256.");
if (assets.has(name)) {
if (assets.get(name) !== entry.size) throw bad();
continue;
}
const bytes = await loaded.read(name, MAX_ASSET_BYTES);
if (!bytes || bytes.byteLength !== entry.size || createHash("sha256").update(bytes).digest("hex") !== sha) throw bad();
await writeFile(join(root, name), bytes);
assets.set(name, bytes.byteLength);
}
written.push({ manifest, ...(first ? { asset: first } : {}) });
}
return written;
}
/**
* Write the report ZIPs as static files under the token, deploy the exported Viewer around them to EAS Hosting, and
* verify what the Viewer opens. Shared by the PR preview (`ci:deploy`) and standalone reports; it knows nothing about GitHub.
*/
async function deployReports(options: {
/** With `listing`, one entry per report in the same order. */
reports: HostedReportInput[]; listing?: ListingTarget[]; project: string; owner?: string;
ownerHint: string; projectHint: string; exportPath: string; environment: NodeJS.ProcessEnv; run: typeof defaultRun;
transport: typeof fetch; now: () => number; random: (bytes: number) => Uint8Array; onSecret?: (secret: string) => void; verifyTimeoutMs: number;
/** `eas deploy --alias`: a fixed host that always serves the newest deployment, for links that must not change between runs. */
alias?: string;
@@ -441,11 +497,12 @@ async function deploySealedReports(options: {
token?: string;
sleep?: (milliseconds: number) => Promise<void>;
}): Promise<HostedDeployment> {
const { reports, reportDirectory, listing, project, environment, run, transport, now, random, expiresAt } = options;
const token = options.token ?? base32(random(20)); const key = random(32);
const { reports, project, environment, run, transport, now, random } = options;
const token = options.token ?? base32(random(20));
options.onSecret?.(token);
// `eas deploy` reads the sealed .env through @expo/env, where any variable already in its own environment wins,
// even an empty one: an inherited EXPLORE_PREVIEW_* would replace the sealed value and every route would 404.
const listing = options.listing?.map((entry, index) => listedAt(entry, manifestPath(token, reports[index]!.file)));
// `eas deploy` reads the deployment's .env through @expo/env, where any variable already in its own environment wins,
// even an empty one: an inherited EXPLORE_PREVIEW_* would replace the deployment's value and every route would 404.
const easEnvironment = { ...Object.fromEntries(Object.entries(environment).filter(([name]) => !name.startsWith("EXPLORE_PREVIEW_"))),
CI: "1", EXPO_NO_TELEMETRY: "1" };
// Run the pinned CLI through this Node binary: the deploy job has no node on PATH for spawned shebang scripts to rely on.
@@ -455,14 +512,10 @@ async function deploySealedReports(options: {
const work = await mkdtemp(join(tmpdir(), "explore-preview-"));
try {
await cp(options.exportPath, join(work, "dist"), { recursive: true });
const sealedDirectory = join(work, "dist", "client", "_report", reportDirectory);
await mkdir(sealedDirectory, { recursive: true });
for (const report of reports) await writeFile(join(sealedDirectory, report.file), sealReport(report.zip, key, random(12)));
const written = await writeReportFiles(join(work, "dist", "client"), token, reports, base32(random(10)));
await writeFile(join(work, ".env"), [
`EXPLORE_PREVIEW_TOKEN=${token}`,
`EXPLORE_PREVIEW_KEY=${Buffer.from(key).toString("base64")}`,
...(expiresAt === null ? [] : [`EXPLORE_PREVIEW_EXPIRES_AT=${new Date(expiresAt).toISOString()}`]),
listing ? `EXPLORE_PREVIEW_REPORTS=${JSON.stringify(listing)}` : `EXPLORE_PREVIEW_REPORT=/_report/${reportDirectory}/${reports[0]!.file}`,
listing ? `EXPLORE_PREVIEW_REPORTS=${JSON.stringify(listing)}` : `EXPLORE_PREVIEW_REPORT=${manifestPath(token, reports[0]!.file)}`,
"",
].join("\n"), { mode: 0o600 });
@@ -503,15 +556,15 @@ async function deploySealedReports(options: {
if (aliasLimit) {
throw deployError("PREVIEW_ALIAS_LIMIT", `EAS Hosting could not assign the alias ${options.alias}: ${aliasLimit[0]}`,
`Delete the aliases of closed pull requests on @${owner}/${project} (eas deploy:alias:delete pr-<n> --non-interactive) or raise the account's plan, then rerun the deploy job.`,
{ retryable: false, details: { project, owner, alias: options.alias, output: commandOutput(deploy, environment.EXPO_TOKEN) } });
{ retryable: false, details: { project, owner, alias: options.alias, output: commandOutput(deploy, [environment.EXPO_TOKEN, token]) } });
}
process.stderr.write(`eas deploy attempt ${attempt} of ${DEPLOY_ATTEMPTS} failed (exit ${deploy.status}):\n${commandOutput(deploy, environment.EXPO_TOKEN)}\n`);
process.stderr.write(`eas deploy attempt ${attempt} of ${DEPLOY_ATTEMPTS} failed (exit ${deploy.status}):\n${commandOutput(deploy, [environment.EXPO_TOKEN, token])}\n`);
if (attempt < DEPLOY_ATTEMPTS) await sleep(DEPLOY_RETRY_DELAYS_MS[attempt - 1] ?? DEPLOY_RETRY_DELAYS_MS.at(-1)!);
}
if (!deploymentUrl) {
throw deployError("PREVIEW_DEPLOY_FAILED", `EAS Hosting deployment failed ${DEPLOY_ATTEMPTS} times: ${lastLine(deploy.stderr || deploy.stdout)}`,
"Check the EAS Hosting status for the preview project and rerun the deploy job; the eas output of every attempt is in the job log.",
{ retryable: true, details: { project, owner, attempts: DEPLOY_ATTEMPTS, output: commandOutput(deploy, environment.EXPO_TOKEN) } });
{ retryable: true, details: { project, owner, attempts: DEPLOY_ATTEMPTS, output: commandOutput(deploy, [environment.EXPO_TOKEN, token]) } });
}
const aliasUrl = options.alias ? hostedOrigin(deployment.aliases?.find(candidate => candidate.name === options.alias)?.url) : undefined;
if (options.alias && !aliasUrl) {
@@ -519,7 +572,7 @@ async function deploySealedReports(options: {
"Check the deployment's aliases in the EAS Hosting dashboard and rerun.", { retryable: true, details: { project, owner, alias: options.alias } });
}
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, timeoutMs: options.verifyTimeoutMs, alias,
reports: reports.map(report => ({ query: report.query, sha256: report.sha256, bytes: report.zip.byteLength })),
reports: reports.map((report, index) => ({ query: report.query, ...written[index]! })),
...(listing ? { listing: JSON.stringify(listing.map(({ path: _path, ...rest }) => rest)) } : {}) });
const seconds = (milliseconds: number) => `${Math.round(milliseconds / 1000)} s after eas deploy returned`;
const served = await verify(deploymentUrl.origin);
@@ -540,7 +593,7 @@ async function deploySealedReports(options: {
}
}
const previewUrl = `${linkOrigin}/p/${token}`;
return { previewUrl, expiresAt: expiresAt === null ? null : new Date(expiresAt).toISOString(), deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
return { previewUrl, expiresAt: null, deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), project, owner };
} finally {
await rm(work, { recursive: true, force: true });
@@ -555,7 +608,6 @@ export type ExplorationDeployOptions = {
project: string;
owner?: string;
/** Days until the hosted link stops serving the report; null never expires. */
expiresAfterDays: number | null;
exportPath?: string;
environment?: NodeJS.ProcessEnv;
run?: typeof defaultRun;
@@ -587,21 +639,20 @@ export async function deployExplorationReport(options: ExplorationDeployOptions)
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
const now = options.now ?? Date.now;
const sha256 = createHash("sha256").update(zip).digest("hex");
const reportDirectory = base32(random(10));
const target = options.platform ? platformTarget(options.platform) : undefined;
const file = target ? `${target.id}.zip.enc` : "report.zip.enc";
const hosted = await deploySealedReports({ reports: [{ zip, sha256, file, query: target ? targetQuery(target) : "" }], reportDirectory,
...(target ? { listing: [listingEntry(target, `/_report/${reportDirectory}/${file}`)] } : {}), project: options.project,
const file = target ? target.id : "report";
const hosted = await deployReports({ reports: [{ zip, sha256, file, query: target ? targetQuery(target) : "" }],
...(target ? { listing: [listingEntry(target)] } : {}), project: options.project,
...(options.owner ? { owner: options.owner } : {}), ownerHint: "Pass --owner with the Expo account that should host the report.",
projectHint: "Give this EAS login permission to create projects under the owner, or pass --project with an existing slug.",
expiresAt: options.expiresAfterDays === null ? null : now() + options.expiresAfterDays * 86_400_000, exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}),
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}),
transport: options.transport ?? fetch, now, random, ...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000,
...(options.alias ? { alias: options.alias } : {}), ...(options.token ? { token: options.token } : {}) });
return { ...hosted, reportSha256: sha256, reportBytes: zip.byteLength };
}
export type FixturePreviewOptions = {
/** Report ZIPs as a hosted preview serves them from report.zip, one per target (`platform` alone: the platform's target), with what the switch says of each. */
/** Report ZIPs as Explore writes them, one per target (`platform` alone: the platform's target), with what the switch says of each. */
reports: Array<{ platform: ExplorePlatform; target?: RunTarget; zipPath: string; changes?: number; device?: string }>;
project: string;
owner?: string;
@@ -633,19 +684,18 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
await assertExport(exportPath);
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
const reportDirectory = base32(random(10));
const reports = await Promise.all(options.reports.map(async report => {
const zip = new Uint8Array(await readFile(report.zipPath));
const target = report.target ?? platformTarget(report.platform);
return { ...report, target, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: `${target.id}.zip.enc` };
return { ...report, target, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: target.id };
}));
const listing = reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, report.changes, report.device));
return deploySealedReports({
const listing = reports.map(report => listingEntry(report.target, report.changes, report.device));
return deployReports({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: targetQuery(report.target) })),
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
ownerHint: "Pass --owner with the Expo account that holds the preview project.",
projectHint: "Give EXPO_TOKEN's account permission to create projects, or pass --project with an existing slug.",
expiresAt: null, exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000, alias: options.alias,
...(options.token ? { token: options.token } : {}) });
}
@@ -657,7 +707,7 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
export async function deployLocalReports(options: {
/** One per target; an entry without `target` is its platform's target, as before targets. */
reports: Array<{ platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string }>;
project: string; owner?: string; expiresAfterDays: number | null;
project: string; owner?: string;
/** What to change when the owner or project is not usable; defaults name report.preview in config.yaml. */
ownerHint?: string; projectHint?: string;
exportPath?: string; environment?: NodeJS.ProcessEnv; run?: CommandRunner; sleep?: (milliseconds: number) => Promise<void>;
@@ -669,19 +719,18 @@ export async function deployLocalReports(options: {
await assertExport(exportPath);
const now = options.now ?? Date.now;
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
const reportDirectory = base32(random(10));
// Always listed, even alone: the Worker takes an unlisted report for iOS, so an Android one would be mislabelled.
const reports = options.reports.map(report => {
const target = report.target ?? platformTarget(report.platform);
return { ...report, target, sha256: createHash("sha256").update(report.zip).digest("hex"), file: `${target.id}.zip.enc` };
return { ...report, target, sha256: createHash("sha256").update(report.zip).digest("hex"), file: target.id };
});
const listing = reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, report.changes, report.device));
return deploySealedReports({
const listing = reports.map(report => listingEntry(report.target, report.changes, report.device));
return deployReports({
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: targetQuery(report.target) })),
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
ownerHint: options.ownerHint ?? "Set report.preview.owner in .expo-explore/config.yaml to the account that should hold the hosted reports.",
projectHint: options.projectHint ?? "Make sure your Expo account can create projects, or set report.preview.project to an existing project you can deploy to.",
expiresAt: options.expiresAfterDays === null ? null : now() + options.expiresAfterDays * 86_400_000, exportPath, environment,
exportPath, environment,
run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now, random,
verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000 });
}
@@ -755,7 +804,7 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
}
/** The deployment must serve the Viewer and the exact reports at the token, and nothing anywhere else. */
async function verifyDeployment(check: { origin: string; token: string; reports: Array<{ query: string; sha256: string; bytes: number }>; listing?: string;
async function verifyDeployment(check: { origin: string; token: string; reports: Array<{ query: string; manifest: string; asset?: string }>; listing?: string;
transport: typeof fetch; now: () => number; timeoutMs: number; alias?: boolean }): Promise<{ liveAfterMs: number }> {
const get = async (path: string, accept = "*/*") => {
try {
@@ -768,22 +817,15 @@ async function verifyDeployment(check: { origin: string; token: string; reports:
};
// What the token serves differs from what was deployed: a listing or report that does not match, or undefined.
const mismatch = async (): Promise<CiError | undefined> => {
// What the Viewer opens: each target's manifest, exactly as written (its deployment stamp tells this deployment from
// the one an alias still points at, even for an unchanged report), and one of its screenshots, a static file.
for (const expected of check.reports) {
const report = await get(`/p/${check.token}/report.zip${expected.query}`);
const bytes = report.status === 200 ? new Uint8Array(await report.arrayBuffer()) : new Uint8Array();
if (report.status !== 200 || bytes.byteLength !== expected.bytes || createHash("sha256").update(bytes).digest("hex") !== expected.sha256) {
return deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not serve the exact report that was deployed.",
"Rerun the deploy job; the deployment's sealed key or ciphertext did not match.", { details: { status: report.status, report: expected.query } });
}
// What the Viewer opens: the manifest the deployed ZIP makes, and one of its assets byte for byte.
const loaded = await loadReport(bytes);
const manifest = await get(`/p/${check.token}/manifest.json${expected.query}`);
const body = manifest.status === 200 ? await manifest.text() : "";
const asset = loaded ? Object.keys(JSON.parse(manifestBody(loaded)).entries as Record<string, number>)[0] : undefined;
const served = asset ? await get(`/p/${check.token}/${asset}${expected.query}`) : undefined;
const served = expected.asset ? await get(`/p/${check.token}/${expected.asset}`) : undefined;
const assetBytes = served?.status === 200 ? new Uint8Array(await served.arrayBuffer()) : new Uint8Array();
if (!loaded || body !== manifestBody(loaded)
|| (asset && createHash("sha256").update(assetBytes).digest("hex") !== asset.slice("assets/".length, "assets/".length + 64))) {
const sha = expected.asset ? PREVIEW_ASSET.exec(expected.asset)?.[1] : undefined;
if (body !== expected.manifest || (sha && createHash("sha256").update(assetBytes).digest("hex") !== sha)) {
return deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not serve the report's manifest and screenshots, which the Viewer opens.",
"Rerun the deploy job; if it keeps failing, inspect the deployment in the EAS Hosting dashboard.",
{ details: { status: manifest.status, ...(served ? { assetStatus: served.status } : {}), report: expected.query } });
@@ -823,11 +865,16 @@ async function verifyDeployment(check: { origin: string; token: string; reports:
if (api.status !== 200 || !(api.headers.get("content-type") ?? "").startsWith("application/json")) {
throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview did not answer the agent API (HTTP ${api.status}).`, "Rerun the deploy job; if the deployment keeps failing verification, inspect it in the EAS Hosting dashboard.", { retryable: true });
}
const robots = await get("/robots.txt");
if (robots.status !== 200 || await robots.text() !== PREVIEW_ROBOTS) {
throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview did not serve its robots.txt (HTTP ${robots.status}), which keeps crawlers away from the screenshots.`,
"Rerun the deploy job; if it keeps failing, inspect the deployment in the EAS Hosting dashboard.", { retryable: true });
}
// The deployment itself serves exactly what was deployed or it failed; the alias was checked while it was polled.
if (!check.alias) { const failure = await mismatch(); if (failure) throw failure; }
const other = check.token.endsWith("a") ? `${check.token.slice(0, -1)}b` : `${check.token.slice(0, -1)}a`;
// Errors name each probe by its shape: the near-miss token differs from the real one in its last character only.
for (const [path, shape] of [["/", "/"], [`/p/${other}`, "/p/<wrong token>"], [`/p/${other}/report.zip`, "/p/<wrong token>/report.zip"],
for (const [path, shape] of [["/", "/"], [`/p/${other}`, "/p/<wrong token>"], [`/p/${other}/manifest.json`, "/p/<wrong token>/manifest.json"],
[`/p/${check.token}/viewer/index.html`, "/p/<token>/viewer/index.html"]] as const) {
const response = await get(path);
if (response.status !== 404) throw deployError("PREVIEW_VERIFY_FAILED", `The hosted preview answered HTTP ${response.status} without a valid token at ${shape}.`,
+58 -13
View File
@@ -1,30 +1,75 @@
/**
* What a hosted or local report page serves the Viewer instead of the whole ZIP: the manifest (the report's metadata
* file verbatim plus every asset's size) and each asset on request. The preview Worker, the local report server and
* the deploy check share these, so all three agree byte for byte.
* file verbatim plus every asset's size) and each asset on request. `ci:deploy` writes them as a hosted preview's
* static files, the local report server answers them from the ZIP, and the preview Worker reads the manifest back.
*/
import type { LoadedReport } from "./agent-api.js";
import { readZipEntry } from "./zip-reader.js";
import { reportFromJson, type LoadedReport } from "./agent-api.js";
/** The manifest format the Viewer accepts (viewer/src/utils/artifact-report.ts). */
export const PREVIEW_MANIFEST_FORMAT = "explore.preview-manifest/1";
/** `assets/<sha256>.<ext>`, the only asset names a report page serves. */
export const PREVIEW_ASSET = /^assets\/([a-f0-9]{64})\.(png|jpg|mp4)$/;
const ASSET_TYPES: Record<string, string> = { png: "image/png", jpg: "image/jpeg", mp4: "video/mp4" };
const MAX_ASSET_BYTES = 32 * 1024 * 1024;
export const ASSET_TYPES: Record<string, string> = { png: "image/png", jpg: "image/jpeg", mp4: "video/mp4" };
export const MAX_ASSET_BYTES = 32 * 1024 * 1024;
/** The metadata file verbatim plus the size of every asset, so the Viewer opens the report before any screenshot. Directory records are not assets. */
export function manifestBody(loaded: LoadedReport): string {
/**
* The metadata file verbatim plus the size of every asset, so the Viewer opens the report before any screenshot.
* Directory records are not assets. `deployment` names the hosted deployment that wrote it, so a check can tell a new
* deployment of an unchanged report from the one an alias still points at.
*/
export function manifestBody(loaded: LoadedReport, deployment?: string): string {
const entries: Record<string, number> = {};
for (const [name, entry] of loaded.entries) if (name.startsWith("assets/") && !name.endsWith("/")) entries[name] = entry.size;
return `{"format":"${PREVIEW_MANIFEST_FORMAT}","file":"${loaded.file}","entries":${JSON.stringify(entries)},"report":${new TextDecoder().decode(loaded.raw)}}`;
const stamp = deployment ? `"deployment":${JSON.stringify(deployment)},` : "";
return `{"format":"${PREVIEW_MANIFEST_FORMAT}",${stamp}"file":"${loaded.file}","entries":${JSON.stringify(entries)},"report":${new TextDecoder().decode(loaded.raw)}}`;
}
/** One asset of the report, inflated from the decrypted ZIP, with its content type; undefined when the report has no such asset. */
/** The largest metadata file the Viewer opens (`ARTIFACT_LIMITS.metadata` in viewer/src/utils/artifact-report.ts). */
export const MAX_PREVIEW_METADATA_BYTES = 8 * 1024 * 1024;
/** A manifest is the metadata file plus one size per asset; the Viewer refuses a larger one. */
export const MAX_MANIFEST_BYTES = MAX_PREVIEW_METADATA_BYTES + 2 * 1024 * 1024;
const REPORT_KEY = ',"report":';
/**
* The report a manifest describes, reading its assets through `readAsset`; undefined when it is not a manifest of a report.
* The metadata is parsed once and kept as the manifest's own bytes. `manifestBody` writes `report` last, so its bytes are
* the text between `,"report":` and the closing brace; any other layout is parsed whole and re-serialized.
*/
export function reportFromManifest(bytes: Uint8Array, readAsset: LoadedReport["read"]): LoadedReport | undefined {
if (bytes.byteLength > MAX_MANIFEST_BYTES) return undefined;
const text = new TextDecoder().decode(bytes);
let header: unknown, report: unknown, raw: Uint8Array | undefined;
const at = text.indexOf(REPORT_KEY);
// A string cannot hold `,"report":` (its quotes are escaped); a nested key can, and then the header before it is not JSON on its own.
if (at !== -1 && text.endsWith("}") && /^[\x20-\x7e]*$/.test(text.slice(0, at))) {
try {
header = JSON.parse(`${text.slice(0, at)}}`);
report = JSON.parse(text.slice(at + REPORT_KEY.length, -1));
raw = bytes.subarray(at + REPORT_KEY.length, bytes.byteLength - 1);
} catch { header = undefined; }
}
if (raw === undefined) {
try { header = JSON.parse(text); } catch { return undefined; }
report = (header as { report?: unknown } | null)?.report;
raw = new TextEncoder().encode(JSON.stringify(report));
}
if (!header || typeof header !== "object") return undefined;
const { format, file, entries } = header as { format?: unknown; file?: unknown; entries?: unknown };
if (format !== PREVIEW_MANIFEST_FORMAT || (file !== "review.json" && file !== "exploration.json")) return undefined;
if (!entries || typeof entries !== "object" || Array.isArray(entries) || !report || typeof report !== "object") return undefined;
const sizes = new Map<string, { size: number }>();
for (const [name, size] of Object.entries(entries)) {
if (!PREVIEW_ASSET.test(name) || !Number.isSafeInteger(size) || (size as number) < 0) return undefined;
sizes.set(name, { size: size as number });
}
if (raw.byteLength > MAX_PREVIEW_METADATA_BYTES) return undefined;
return reportFromJson(file, raw, report, sizes, (name, limit) => (sizes.has(name) ? readAsset(name, limit) : Promise.resolve(undefined)));
}
/** One asset of the report with its content type; undefined when the report has no such asset. */
export async function previewAsset(loaded: LoadedReport, path: string): Promise<{ bytes: Uint8Array; type: string } | undefined> {
const match = PREVIEW_ASSET.exec(path);
const entry = match ? loaded.entries.get(path) : undefined;
if (!match || !entry) return undefined;
const bytes = await readZipEntry(loaded.zip, entry, MAX_ASSET_BYTES);
if (!match || !loaded.entries.has(path)) return undefined;
const bytes = await loaded.read(path, MAX_ASSET_BYTES);
return bytes ? { bytes, type: ASSET_TYPES[match[2]!]! } : undefined;
}
+1 -1
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;
+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.
*/
+4 -4
View File
@@ -11,8 +11,8 @@
# secrets: inherit
#
# Call it once per workflow run: a called workflow shares its caller's run, and its artifact names come from the run.
# The report links are written to the run's summary. For a release, pass scope: all to capture every screen,
# and expires-in: never to keep the hosted link (report.preview.hosting: eas) working.
# The report links are written to the run's summary. For a release, pass scope: all to capture every screen. A hosted
# link (report.preview.hosting: eas) lasts as long as its EAS Hosting deployment; expires-in is accepted and ignored.
name: Expo Explore compare
on:
workflow_dispatch:
@@ -20,13 +20,13 @@ on:
base: { description: 'Base: a branch, tag or commit SHA', required: true }
head: { description: 'Head: a branch, tag or commit SHA', required: true }
scope: { description: 'changes (screens whose source changed) or all; default: exploration.scope in config.yaml', required: false, default: '' }
expires-in: { description: 'Hosted link lifetime such as 30d, or never; default: report.preview.expiresAfter', required: false, default: '' }
expires-in: { description: 'Ignored: kept for workflows that pass it. A hosted preview lasts as long as its EAS Hosting deployment.', required: false, default: '' }
workflow_call:
inputs:
base: { description: 'Base: a branch, tag or commit SHA', required: true, type: string }
head: { description: 'Head: a branch, tag or commit SHA', required: true, type: string }
scope: { description: 'changes (screens whose source changed) or all; default: exploration.scope in config.yaml', required: false, type: string, default: '' }
expires-in: { description: 'Hosted link lifetime such as 30d, or never; default: report.preview.expiresAfter', required: false, type: string, default: '' }
expires-in: { description: 'Ignored: kept for workflows that pass it. A hosted preview lasts as long as its EAS Hosting deployment.', required: false, type: string, default: '' }
permissions: {}
env:
# The exact @expo/explore release CI installs. expo-explore setup --workflows sets it.
+108 -17
View File
@@ -75,6 +75,9 @@ async function harness(t, bytes, { app = false, open = true, name = fileName, re
const pagePath = preview ? `/p/${preview.token}` : "/r";
// What the preview Worker serves from the decrypted ZIP: the manifest the Viewer opens, and each asset on request.
const served = preview && bytes ? await unzipped(bytes) : undefined;
// `archives` by query gives a target its own report; every other query gets `bytes`.
const servedBy = Object.fromEntries(await Promise.all(Object.entries(preview?.archives ?? {}).map(async ([search, zip]) => [search, await unzipped(zip)])));
const servedFor = search => servedBy[search] ?? served;
const vite = await createBrowserVite(t, { configFile: false,
root: fileURLToPath(new URL("../../viewer", import.meta.url)), logLevel: "error", esbuild: { jsx: "automatic" },
server: { host: "127.0.0.1", port: 0 }, plugins: [{ name: "report-page-fixture", configureServer(server) {
@@ -88,11 +91,14 @@ async function harness(t, bytes, { app = false, open = true, name = fileName, re
response.setHeader("content-type", "application/json");
// A slow target (`delays` by query) keeps its manifest in flight while the reviewer moves on.
// `padding` makes the manifest larger than the Viewer reads.
const body = preview.padding ? " ".repeat(preview.padding) + served.manifest : served.manifest;
const manifest = servedFor(url.search).manifest;
const body = preview.padding ? " ".repeat(preview.padding) + manifest : manifest;
return void setTimeout(() => response.end(body), preview.delays?.[url.search] ?? 0);
}
if (preview && url.pathname.startsWith(`${pagePath}/assets/`)) {
const asset = served.files.get(url.pathname.slice(pagePath.length + 1));
// Screenshot URLs name no target: any report of the deployment may hold one.
const name = url.pathname.slice(pagePath.length + 1);
const asset = [served, ...Object.values(servedBy)].map(report => report.files.get(name)).find(Boolean);
if (!asset) { response.statusCode = 404; return response.end("Not found"); }
response.setHeader("content-type", "application/octet-stream");
response.setHeader("content-length", String(asset.length));
@@ -266,6 +272,8 @@ test("choosing the report file opens it with the link's selection and keeps Modi
await expect(page.locator("html")).toHaveAttribute("data-theme", "light");
await page.getByRole("button", { name: "Screens", exact: true }).click();
const screenshot = page.locator(".screens-page img[data-screenshot-src]").first();
// The placeholder is the screenshot's size too, so wait for the screenshot itself.
await expect(screenshot).toHaveAttribute("data-screenshot-state", "ready");
await expect.poll(() => screenshot.evaluate(image => image.naturalWidth)).toBe(32);
const screenshotUrl = await screenshot.getAttribute("src");
assert.match(page.url(), /#\/screens/);
@@ -322,6 +330,8 @@ test("a reload and a later per-screen link reopen the dropped report from the br
await expect(page.getByText("Greeting changed from Hello to Welcome", { exact: true })).toBeVisible();
await page.getByRole("button", { name: "Screens", exact: true }).click();
const screenshot = page.locator(".screens-page img[data-screenshot-src]").first();
// The placeholder is the screenshot's size too, so wait for the screenshot itself.
await expect(screenshot).toHaveAttribute("data-screenshot-state", "ready");
await expect.poll(() => screenshot.evaluate(image => image.naturalWidth)).toBe(32);
// Comment links to one screen carry the same run identity, so they open without a new drop.
await page.goto(`${origin}/r?${new URLSearchParams(identity)}&screen=home&inspect=diff`);
@@ -425,15 +435,6 @@ test("a hosted preview link downloads the report from its own token route, opens
await expect(shell).toContainText("This preview link is not valid, or its deployment was deleted");
await expect(expired.page.locator(".report-drop-input")).toHaveCount(0);
assert.deepEqual(expired.errors, []);
// A deployment past its sealed expiry still opens and says when the link expired.
const gone = await harness(t, await archive(), { app: true, reportIdentity: null,
preview: { ...preview, token: "cdefghijklmnopqrstuvwxyz23456723", status: 410, body: JSON.stringify({ error: "expired", expiredAt: "2030-01-01T00:00:00.000Z" }) } });
const goneShell = gone.page.locator(".report-loading-shell");
await expect(goneShell).toHaveAttribute("data-loading-status", "failed");
await expect(goneShell).toContainText("This preview link expired on Jan 1, 2030. Download the report from the pull request or workflow run instead");
await expect(gone.page.locator(".report-drop-input")).toHaveCount(0);
assert.deepEqual(gone.errors, []);
});
test("a hosted run of several targets opens the linked target and switches between all of them in config order", { timeout: 60_000 }, async t => {
@@ -575,6 +576,92 @@ test("a hosted manifest larger than the Viewer reads is refused before it is par
assert.deepEqual(errors, []);
});
test("D, ⌥1–⌥8 and ` switch targets from the keyboard, and the other report opens at the same place", { timeout: 60_000 }, async t => {
const report = reportFixture();
report.review.runtime = { ...report.review.runtime, platform: "android", platforms: ["ios", "android"] };
const ios = reportFixture();
ios.review.runtime = { ...ios.review.runtime, platform: "ios", platforms: ["ios", "android"] };
const preview = { token: "ijklmnopqrstuvwxyz23456723456723", listing: [{ platform: "ios" }, { platform: "android" }],
archives: { "?platform=ios": await archive(ios) } };
// An Apple keyboard, where ⌥ digits reach the page (Linux browsers keep Alt+1–8 for their tabs).
const { page, errors } = await harness(t, await archive(report), { app: true, reportIdentity: null, preview,
query: "&platform=android&focus=modified&screen=home&inspect=diff",
fault: () => { Object.defineProperty(Navigator.prototype, "platform", { get: () => "MacIntel" }); } });
await expect(page.locator(".app-shell")).toBeVisible();
await expect.poll(() => new URL(page.url()).hash).toMatch(/^#\/map\/home\?/);
const place = new URL(page.url()).hash;
await page.evaluate(() => { window.__samePage = true; });
const target = () => new URL(page.url()).searchParams.get("platform");
// ` returns to the last target; before there is one, it opens the next in the menu.
await page.keyboard.press("Backquote");
await expect.poll(target).toBe("ios");
await expect(page.locator(".app-shell")).toBeVisible();
const carried = new URL(page.url()).hash;
assert.equal(carried.split("?")[0], place.split("?")[0], "the other report opens at the same canvas and route");
assert.equal(new URLSearchParams(carried.split("?")[1]).get("inspect"), "diff");
assert.equal(new URLSearchParams(carried.split("?")[1]).get("screen"), null, "a screen id belongs to one report");
await expect(page.locator(".map-canvas .is-selected")).toHaveCount(1);
await page.keyboard.press("Backquote");
await expect.poll(target).toBe("android");
// D opens the menu, which prints each target's ⌥ key.
await expect(page.locator(".app-shell")).toBeVisible();
await page.keyboard.press("KeyD");
const items = page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio");
await expect(items).toHaveCount(2);
assert.deepEqual(await items.evaluateAll(rows => rows.map(row => row.querySelector(".menu-row-shortcut")?.textContent)), ["⌥1", "⌥2"]);
await page.keyboard.press("Escape");
await expect(items).toHaveCount(0);
await page.keyboard.press("Alt+Digit1");
await expect.poll(target).toBe("ios");
await expect(page.locator(".app-shell")).toBeVisible();
// The shown target's own key does nothing.
await page.keyboard.press("Alt+Digit1");
await page.keyboard.press("Alt+Digit2");
await expect.poll(target).toBe("android");
assert.equal(await page.evaluate(() => window.__samePage), true, "every switch stays on the page");
await page.keyboard.press("Shift+Slash");
const dialog = page.getByRole("dialog", { name: "Keyboard shortcuts" });
await expect(dialog).toContainText("Another platform's report");
await expect(dialog).toContainText("⌥1–⌥2");
await expect(dialog).toContainText("Back to the last platform");
assert.deepEqual(errors, []);
});
test("a target switch keeps the chosen appearance when the other report was captured in it, and its own otherwise", { timeout: 60_000 }, async t => {
/** A report of `platform`, with every surface also captured in dark when `dark`. */
const report = (platform, dark) => {
const fixture = reportFixture();
fixture.review.runtime = { ...fixture.review.runtime, platform, platforms: ["ios", "android"], ...(dark ? { colorSchemes: ["light", "dark"] } : {}) };
if (dark) fixture.review.surfaces.push({ ...structuredClone(fixture.review.surfaces[0]), id: "home@dark", colorScheme: "dark" });
return fixture;
};
const preview = { token: "klmnopqrstuvwxyz2345672345672345", listing: [{ platform: "ios" }, { platform: "android" }],
archives: { "?platform=ios": await archive(report("ios", false)), "?platform=android": await archive(report("android", true)) } };
const { page, errors } = await harness(t, await archive(report("android", true)), { app: true, reportIdentity: null, preview, query: "&platform=android" });
const target = () => new URL(page.url()).searchParams.get("platform");
const appearance = page.getByRole("button", { name: /^Appearance: / });
await expect(appearance).toHaveText(/Light/);
await page.keyboard.press("Shift+KeyT");
await expect(appearance).toHaveText(/Dark/);
// iOS was captured in light only: it shows light and offers no switch.
await page.keyboard.press("Backquote");
await expect.poll(target).toBe("ios");
await expect(page.locator(".app-shell")).toBeVisible();
await expect(appearance).toHaveCount(0);
// Back on Android, the choice still holds.
await page.keyboard.press("Backquote");
await expect.poll(target).toBe("android");
await expect(appearance).toHaveText(/Dark/);
// A reload of the tab keeps it as well.
await page.reload();
await expect(appearance).toHaveText(/Dark/);
assert.deepEqual(errors, []);
});
test("going back during a switch shows the report the page was on, and the slow one does not replace it", { timeout: 60_000 }, async t => {
const { page, errors, switchToIos } = await slowSwitchHarness(t, "ghijklmnopqrstuvwxyz234567234567", 3000);
await switchToIos();
@@ -594,10 +681,12 @@ test("report links name their target: ?target=, ?platform= from before targets,
const api = window.archiveApi;
const attempt = fn => { try { return fn(); } catch (error) { return `error: ${error.message}`; } };
const preview = "http://x/p/abcdefghijklmnopqrstuvwxyz234567";
const manifest = page => api.previewManifestUrl(api.previewToken(page), api.reportTarget(page));
return {
target: api.previewReportUrl(new URL(`${preview}?target=duo-open`)),
platform: api.previewReportUrl(new URL(`${preview}?platform=android`)),
none: api.previewReportUrl(new URL(preview)),
target: manifest(new URL(`${preview}?target=duo-open`)),
platform: manifest(new URL(`${preview}?platform=android`)),
none: manifest(new URL(preview)),
asset: api.previewAssetUrl("abcdefghijklmnopqrstuvwxyz234567", `assets/${"a".repeat(64)}.png`),
both: attempt(() => api.reportTarget(new URL(`${preview}?target=duo-open&platform=ios`))),
invalid: attempt(() => api.reportTarget(new URL(`${preview}?target=Duo`))),
reserved: attempt(() => api.reportTarget(new URL(`${preview}?target=report`))),
@@ -608,9 +697,11 @@ test("report links name their target: ?target=, ?platform= from before targets,
};
});
assert.deepEqual(result, {
target: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip?target=duo-open",
platform: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip?platform=android",
none: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip",
target: "/p/abcdefghijklmnopqrstuvwxyz234567/manifest.json?target=duo-open",
platform: "/p/abcdefghijklmnopqrstuvwxyz234567/manifest.json?platform=android",
none: "/p/abcdefghijklmnopqrstuvwxyz234567/manifest.json",
// A screenshot is a static file named by its content, the same for every target.
asset: `/p/abcdefghijklmnopqrstuvwxyz234567/assets/${"a".repeat(64)}.png`,
both: "error: This report link needs one target, such as ios or android.",
invalid: "error: This report link needs one target, such as ios or android.",
reserved: "error: This report link needs one target, such as ios or android.",
+4 -1
View File
@@ -27,7 +27,10 @@ export async function createBrowserVite(test, options) {
});
const requested = options.server;
const port = requested?.port === 0 ? await freePort(requested.host ?? "127.0.0.1") : requested?.port;
server = await createServer({ ...options, cacheDir,
// A cold cacheDir optimizes dependencies as the page asks for them; one found late (the JSX dev runtime, which
// esbuild's JSX imports) makes Vite reload the page, dropping whatever the test has done in it.
const optimizeDeps = { ...options.optimizeDeps, include: [...(options.optimizeDeps?.include ?? []), "react/jsx-dev-runtime"] };
server = await createServer({ ...options, cacheDir, optimizeDeps,
...(requested ? { server: { ...requested, port, ...(requested.port === 0 ? { strictPort: true } : {}) } } : {}) });
return server;
}
+16 -3
View File
@@ -8,11 +8,13 @@ import { createHash } from 'node:crypto';
import { PNG } from 'pngjs';
import { AGENT_DEVICE_VERSION } from '../../dist/capture/run.js';
import { CAPTURE_OBSERVER_IDENTIFIER } from '../../dist/capture/observer.js';
import { controllerCacheRoot, ensureController } from '../../dist/shared/controller-cache.js';
import { writeCaptureObserverPackages } from './capture-observer-fixture.mjs';
/**
* In-process public CI fixture: a git project with base/head commits plus mocked `eas`, `repack-app`,
* `agent-device` and GitHub transports, so a review runs end to end without network or a simulator.
* `agent-device` and GitHub transports, so a review runs end to end without a simulator, and without network once the
* real agent-device that compares screenshots is cached.
*/
export const PROJECT_ID = '00000000-0000-4000-8000-000000000001';
@@ -27,6 +29,17 @@ export const usageReceipt = (overrides = {}) => ({ provider: 'anthropic', model:
totals: { inputTokens: 100, outputTokens: 20, cacheReadInputTokens: 40, estimatedCostUsd: 0.012 },
models: [{ model: 'fixture-model', inputTokens: 100, outputTokens: 20, cacheReadInputTokens: 40, estimatedCostUsd: 0.012, costBasis: 'list' }],
...overrides });
/**
* The review's screenshot comparison runs the real agent-device, which fetches itself on first use. The fixture fetches
* it once, with retries, into the machine's controller cache, so a review never downloads it mid-run.
*/
const CONTROLLER_CACHE = controllerCacheRoot(process.env);
for (let attempt = 1; ; attempt++) {
try { await ensureController('agent-device', { environment: { ...process.env, EXPLORE_CONTROLLER_CACHE: CONTROLLER_CACHE } }); break; }
catch (error) { if (attempt === 3) throw error; await new Promise(resolve => setTimeout(resolve, attempt * 2_000)); }
}
export async function readUsage(output) {
const path = join(output, 'agent-usage.jsonl');
assert.equal((await stat(path)).mode & 0o777, 0o600, 'usage receipts are private artifacts');
@@ -103,7 +116,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
const pr = { repositoryId: '123', repository: 'acme/example', number: 7, title: 'Source capture integration', url: 'https://github.com/acme/example/pull/7',
base: { ref: 'main', sha: baseSha }, head: { ref: 'feature', sha: headSha } };
const pullRequestPath = join(root, 'pull-request.json'); await writeFile(pullRequestPath, JSON.stringify(pr));
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPLORE_CONTROLLER_CACHE: CONTROLLER_CACHE, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
GITHUB_RUN_ID: '1234', GITHUB_RUN_ATTEMPT: '1', GITHUB_REPOSITORY: pr.repository, TOOLS_COMMIT: 'c'.repeat(40), EXPLORE_VIEWER_ORIGIN: 'https://viewer.example' };
const requests = []; const comments = []; const sessions = new Map(); let currentSession; const idleDevice = { path: '/', scheme: 'light' }; let sessionCounter = 0; let repackedSha; let openFailed = false;
const identity = (session) => ({ session: 'expo-explore-runtime', appBundleId: config.app.bundleId,
@@ -206,7 +219,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
] });
}
if (command === 'settings') { if (request.args[1] === 'appearance') device.scheme = request.args[2]; return ok({ setting: request.args[1], value: request.args[2] }); }
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
if (command === 'screenshot') { const color = createHash('sha256').update(`${device.path}:${device.scheme}:${device.path === '/home' ? device.build : 'unchanged-source'}`).digest(); /* Hashed colours can land within the diff threshold, so /home's red channel keeps the base build apart from any other. */ if (device.path === '/home') color[0] = device.build?.endsWith(baseSha) ? 0 : 255; const data = Buffer.alloc(16 * 24 * 4); for (let i = 0; i < data.length; i += 4) { data[i] = color[0]; data[i + 1] = color[1]; data[i + 2] = color[2]; data[i + 3] = 255; } writeFileSync(request.args[1], PNG.sync.write({ width: 16, height: 24, data })); return ok({ path: request.args[1] }); }
}
throw new Error(`Unexpected mocked command: ${request.command} ${request.args.join(' ')}`);
};
+5 -5
View File
@@ -7,7 +7,7 @@ import test from "node:test";
const root = resolve(import.meta.dirname, "../..");
const cli = join(root, "dist", "cli.js");
const { defaultOutputDirectory, expiresInDays } = await import(join(root, "dist", "cli", "binary-commands.js"));
const { defaultOutputDirectory } = await import(join(root, "dist", "cli", "binary-commands.js"));
function fail(args) {
// Without an EAS login (as on CI) argument and archive errors must still come first.
@@ -28,7 +28,6 @@ test("explore:binary is in the short help with its archive kinds and --no-upload
test("explore:binary validates its arguments before touching EAS or a model", () => {
assert.match(fail([]), /Pass the app archive/);
assert.match(fail(["./app.apk", "--upload", "--no-upload"]), /either --upload or --no-upload/);
assert.match(fail(["./app.apk", "--expires-in", "400d"]), /--expires-in must be 1d to 90d, or never/);
assert.match(fail(["./app.apk", "--platform", "web"]), /platform/);
assert.match(fail(["./app.apk", "--simulator", "cloud"]), /simulator/);
// A local run needs no EAS login, so the archive is the first thing it checks.
@@ -40,9 +39,10 @@ test("explore:binary validates its arguments before touching EAS or a model", ()
assert.match(human.stderr, /Archive not found: .*does-not-exist\.apk\n→ Check the path/);
});
test("expiry and output directory defaults", () => {
assert.equal(expiresInDays("7d"), 7); assert.equal(expiresInDays("90d"), 90); assert.equal(expiresInDays("never"), null);
assert.throws(() => expiresInDays("0d")); assert.throws(() => expiresInDays("7")); assert.throws(() => expiresInDays("91d"));
test("--expires-in is accepted from older scripts and says it no longer applies; output directory defaults", () => {
const ignored = spawnSync(process.execPath, [cli, "explore:binary", "./does-not-exist.apk", "--no-upload", "--expires-in", "400d"], { cwd: root, encoding: "utf8", env: { ...process.env, EXPO_TOKEN: "", EXPO_SESSION_SECRET: "", GITHUB_ACTIONS: "" } });
assert.match(ignored.stderr, /^--expires-in no longer applies: a hosted preview lasts as long as its EAS Hosting deployment/m);
assert.match(ignored.stderr, /Archive not found/, "and the run goes on");
const now = new Date("2026-10-11T16:28:48.123Z");
assert.equal(defaultOutputDirectory("/builds/euxy-ios.tar.gz", now), "explore-euxy-ios-20261011-1628");
assert.equal(defaultOutputDirectory("My App (1).app", now), "explore-My-App-1-20261011-1628");
+2 -1
View File
@@ -145,7 +145,8 @@ async function fixture(t, settings = {}) {
if (request.args[1]?.includes('server start')) {
const port = 4100 + serverStarts++;
writeFileSync(request.environment.EXPLORE_ARGENT_SERVER_LOG, ` (or: argent link --host 127.0.0.1 --port ${port} --token abc123)\n[t] Tools server listening on http://127.0.0.1:${port}\n`);
return { stdout: `${4242 + serverStarts}\n`, stderr: '' };
// A pid no process can have: stopping the server signals it for real.
return { stdout: `${999_999_000 + serverStarts}\n`, stderr: '' };
}
return { stdout: '', stderr: '' };
}
+3 -3
View File
@@ -48,12 +48,12 @@ test('any two commits: a capture and report like a pull request\'s, with no pull
environment: { ...f.environment, GITHUB_TOKEN: '', GITHUB_STEP_SUMMARY: targetSummary }, transport: async input => assert.fail(`no GitHub request: ${input}`) });
assert.match(await readFile(targetSummary, 'utf8'), /^- iPhone Duo \\\[open\\\] report of `v1\.1\.0` vs `v1\.0\.0`: \[Open\]\(https:\/\/explore-preview\.expo\.app\/\?repo=acme%2Fexample&run=1234&attempt=1&target=duo-open&artifact=900\) · /);
const summary = renderCompareSummary(result.review.pullRequest, 'https://example.expo.app/p/token', null, [await readCiReportInput(result.inputPath)]);
const summary = renderCompareSummary(result.review.pullRequest, 'https://example.expo.app/p/token', [await readCiReportInput(result.inputPath)]);
assert.match(summary, /^### Explore: `v1\.1\.0` vs `v1\.0\.0`$/m);
// Refs are code spans: one with ] ( ) would otherwise break the line's links. A caller's own title is one span.
const odd = { ...result.review.pullRequest, base: { ...result.review.pullRequest.base, ref: 'x](evil)' }, title: 'v1.1.0 vs x](evil)' };
assert.match(renderCompareSummary(odd, 'https://example.expo.app/p/token', null, []), /^### Explore: `v1\.1\.0` vs `x\]\(evil\)`$/m);
assert.match(renderCompareSummary({ ...odd, title: 'Nightly `build`' }, 'https://example.expo.app/p/token', null, []), /^### Explore: `Nightly 'build'`$/m);
assert.match(renderCompareSummary(odd, 'https://example.expo.app/p/token', []), /^### Explore: `v1\.1\.0` vs `x\]\(evil\)`$/m);
assert.match(renderCompareSummary({ ...odd, title: 'Nightly `build`' }, 'https://example.expo.app/p/token', []), /^### Explore: `Nightly 'build'`$/m);
// capture:review's preview output starts the deploy job only when the reviewed config hosts the report.
const outputs = join(f.root, 'outputs');
+10 -11
View File
@@ -173,18 +173,17 @@ test("agent instruction files must exist inside the repository", async (t) => {
assert.equal((await readExploreConfig(project)).agent.instructions, ".expo-explore/instructions.md");
});
test("report.preview opts into hosted previews with a bounded expiry and an optional project slug", () => {
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas" } } }).report,
{ preview: { hosting: "eas", expiresAfterDays: 30 } });
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: "14 days", owner: "acme", project: "acme-explore" } } }).report,
{ preview: { hosting: "eas", expiresAfterDays: 14, owner: "acme", project: "acme-explore" } });
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: 3 } } }).report?.preview?.expiresAfterDays, 3);
assert.equal(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: "365d" } } }).report?.preview?.expiresAfterDays, 365);
assert.equal(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter: "never" } } }).report?.preview?.expiresAfterDays, null);
test("report.preview opts into hosted previews with an optional owner and project slug; an expiry from older configs is ignored", () => {
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas" } } }).report, { preview: { hosting: "eas" } });
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", owner: "acme", project: "acme-explore" } } }).report,
{ preview: { hosting: "eas", owner: "acme", project: "acme-explore" } });
// A hosted preview lasts as long as its EAS Hosting deployment: an old config's expiresAfter still validates, and is only noted.
for (const expiresAfter of ["14 days", 3, "never", "forever"]) {
assert.deepEqual(validateExploreConfig({ ...base(), report: { preview: { hosting: "eas", expiresAfter } } }).report, { preview: { hosting: "eas", expiresAfterIgnored: true } });
}
assert.deepEqual(validateExploreConfig({ ...base(), report: {} }).report, {});
assert.equal(validateExploreConfig(base()).report, undefined);
for (const preview of [{ hosting: "vercel" }, { hosting: "eas", expiresAfter: "366d" }, { hosting: "eas", expiresAfter: "0d" }, { hosting: "eas", expiresAfter: "forever" },
{ hosting: "eas", expiresAfter: "2 weeks" }, { hosting: "eas", project: "Acme" },
for (const preview of [{ hosting: "vercel" }, { hosting: "eas", project: "Acme" },
{ hosting: "eas", owner: "Acme Org" }, { hosting: "eas", token: "x" }, {}]) {
assert.throws(() => validateExploreConfig({ ...base(), report: { preview } }), /Invalid .expo-explore\/config.yaml: report.preview/);
}
@@ -194,7 +193,7 @@ test("report.preview opts into hosted previews with a bounded expiry and an opti
test("report.comment.map opts the PR comment into its map of changed screens, beside or without a hosted preview", () => {
assert.deepEqual(validateExploreConfig({ ...base(), report: { comment: { map: true } } }).report, { comment: { map: true } });
assert.deepEqual(validateExploreConfig({ ...base(), report: { comment: { map: false }, preview: { hosting: "eas" } } }).report,
{ comment: { map: false }, preview: { hosting: "eas", expiresAfterDays: 30 } });
{ comment: { map: false }, preview: { hosting: "eas" } });
for (const comment of [{}, { map: "yes" }, { map: true, graph: true }, true]) {
assert.throws(() => validateExploreConfig({ ...base(), report: { comment } }), /Invalid .expo-explore\/config.yaml: report.comment/);
}
+4 -2
View File
@@ -245,11 +245,13 @@ test('the local Viewer serves the manifest and assets the Viewer opens, the same
assert.match(manifest.headers.get('content-type') ?? '', /^application\/json/);
assert.equal(await manifest.text(), manifestBody(loaded));
const [asset] = Object.keys(JSON.parse(manifestBody(loaded)).entries);
const served = await fetch(`${server.url}/${asset}?platform=ios`);
// An asset is named by its SHA-256, as a hosted preview's static files are, so it carries no target and comes from whichever report holds it.
const served = await fetch(`${server.url}/${asset}`);
assert.equal(served.status, 200);
assert.equal(served.headers.get('content-type'), 'image/png');
assert.equal(createHash('sha256').update(new Uint8Array(await served.arrayBuffer())).digest('hex'), asset.slice('assets/'.length, 'assets/'.length + 64));
for (const path of [`/${asset}?platform=android`, `/assets/${'0'.repeat(64)}.png`, '/assets/review.json', '/manifest.json?platform=android', '/manifest.json?target=tablet']) {
assert.equal((await fetch(`${server.url}/${asset}?platform=android`)).status, 200, 'a target query changes nothing');
for (const path of [`/assets/${'0'.repeat(64)}.png`, '/assets/review.json', '/manifest.json?platform=android', '/manifest.json?target=tablet']) {
assert.equal((await fetch(`${server.url}${path}`)).status, 404, path);
}
});
+10
View File
@@ -268,3 +268,13 @@ test("unknown values fall back without disturbing the rest", () => {
{ ...base, canvas: "screens" },
);
});
test("another target's report opens at the same canvas and route, keeping only what means the same there", () => {
assert.equal(nav.placeForAnotherTarget("#/compare/settings/profile?screen=s-12&variant=v2&baseline=build-0.9&inspect=diff&focus=modified,added&dir=in&expand=g1&evidence=logs"),
"#/compare/settings/profile?inspect=diff&dir=in&focus=modified,added");
assert.equal(nav.placeForAnotherTarget("#/map/home"), "#/map/home");
assert.equal(nav.placeForAnotherTarget("#/screens?screen=s-3"), "#/screens");
// No place, or a hash from before routes: the other report opens where a link to it would.
assert.equal(nav.placeForAnotherTarget(""), "");
assert.equal(nav.placeForAnotherTarget("#map"), "");
});
+121 -80
View File
@@ -7,13 +7,12 @@ import test from "node:test";
import { prepareCaptureReview } from "../../dist/review/capture-review.js";
import { createSourceCapturePlan } from "../../dist/source/capture-plan.js";
import { writeCiReportInput, exportCiReport } from "../../dist/report/artifact.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, deployPreview, previewProjectSlug, readReportZip, sealReport, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { spawnSync } from "node:child_process";
import { createDecipheriv } from "node:crypto";
import { ZipReader, Uint8ArrayReader, TextWriter, configure } from "@zip.js/zip.js";
import { viewerLinks } from "../../dist/report/viewer-links.js";
import { loadReport } from "../../dist/report/agent-api.js";
import { manifestBody, previewAsset } from "../../dist/report/preview-manifest.js";
import { manifestBody } from "../../dist/report/preview-manifest.js";
const png = Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "base64");
const sha256 = createHash("sha256").update(png).digest("hex");
@@ -23,7 +22,7 @@ const pr = { repositoryId: "123", repository: "expo/explore-playground", number:
const artifactUrl = "https://github.com/expo/explore-playground/actions/runs/10/artifacts/20";
const environment = { GITHUB_TOKEN: "test-token", GITHUB_RUN_ID: "10", GITHUB_RUN_ATTEMPT: "1", GITHUB_REPOSITORY: pr.repository };
async function fixture(t, { verified = true, preview = { hosting: "eas", expiresAfterDays: 7 }, presentation = pr } = {}) {
async function fixture(t, { verified = true, preview = { hosting: "eas" }, presentation = pr } = {}) {
const root = await mkdtemp(join(tmpdir(), "explore-artifact-ci-"));
t.after(() => rm(root, { recursive: true, force: true }));
const files = new Map([["app/index.tsx", "export default function Home() { return null; }"]]);
@@ -74,7 +73,7 @@ async function exportFixture(t, options) {
}
/** A fake EAS CLI plus a fake deployment: `deploy` captures the sealed report and .env, then serves them like the Worker would. */
function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", aliasOrigin = "https://acme-explore--bluesky.expo.app", accounts = ["brent-org"], failDeploy = false, aliasServes = true, aliasListing, existingComment, manifestServes = true } = {}) {
function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", aliasOrigin = "https://acme-explore--bluesky.expo.app", accounts = ["brent-org"], failDeploy = false, aliasServes = true, aliasListing, existingComment, manifestServes = true, robotsServes = true } = {}) {
let deploys = 0;
let latestComment = existingComment;
const calls = []; const captured = {};
@@ -89,12 +88,19 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
if (args[0] === "deploy") {
deploys += 1;
if (failDeploy === "alias-limit") return { status: 1, stdout: "", stderr: "✔ Created deployment\n✖ Failed to assign pr-7 alias to deployment\nThis account has reached the limit of 5 aliases from the Free plan. Upgrade your plan to raise the limit on the amount of aliases you can create for your deployments. https://expo.dev/accounts/acme/settings/billing\nRequest ID: 341b47a1\n Error: GraphQL request failed." };
// eas names the file whose upload failed, and every static file's path carries the link's token.
if (failDeploy === "upload-path") {
const token = /EXPLORE_PREVIEW_TOKEN=(\S+)/.exec(readFileSyncUtf8(join(options.cwd, ".env")))[1];
return { status: 1, stdout: "", stderr: `Upload of "client/p/${token}/assets/${sha256}.png" failed: 502\n Upload failed` };
}
if (failDeploy === true || deploys <= failDeploy) return { status: 1, stdout: "", stderr: "Error: GraphQL request failed.\n Upload failed" };
captured.env = Object.fromEntries(readFileSyncUtf8(join(options.cwd, ".env")).trim().split("\n").map(line => line.split(/=(.*)/s).slice(0, 2)));
captured.listing = captured.env.EXPLORE_PREVIEW_REPORTS ? JSON.parse(captured.env.EXPLORE_PREVIEW_REPORTS) : [{ platform: "ios", path: captured.env.EXPLORE_PREVIEW_REPORT }];
captured.sealedFiles = Object.fromEntries(captured.listing.map(entry => [entry.path, readFileSyncBytes(join(options.cwd, "dist", "client", entry.path))]));
captured.sealed = captured.sealedFiles[captured.listing[0].path];
// The report's static files, by the path EAS Hosting serves each at.
const tokenDirectory = join(options.cwd, "dist", "client", "p", captured.env.EXPLORE_PREVIEW_TOKEN);
captured.files = Object.fromEntries(readdirTree(tokenDirectory).map(file => [`/p/${captured.env.EXPLORE_PREVIEW_TOKEN}/${file}`, readFileSyncBytes(join(tokenDirectory, file))]));
captured.hasViewer = existsSyncLocal(join(options.cwd, "dist", "client", "viewer", "index.html"));
captured.robots = existsSyncLocal(join(options.cwd, "dist", "client", "robots.txt")) ? readFileSyncUtf8(join(options.cwd, "dist", "client", "robots.txt")) : undefined;
const alias = args.includes("--alias") ? args[args.indexOf("--alias") + 1] : undefined;
captured.alias = alias;
const aliases = alias ? [{ id: "al1", url: aliasOrigin, name: alias }] : undefined;
@@ -108,7 +114,10 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
// An alias that has not moved to the new deployment yet: it answers for an earlier token, so this one is 404.
if (!aliasServes && url.origin === aliasOrigin) return new Response("Not found", { status: 404 });
if (url.origin === origin || (captured.alias && url.origin === aliasOrigin)) {
const match = /^\/p\/([a-z2-7]{32})(?:\/(report\.zip|reports\.json|manifest\.json|api\/v1|assets\/[a-f0-9]{64}\.(?:png|jpg|mp4)))?$/.exec(url.pathname);
// EAS Hosting serves a deployment's static file before the Worker sees the request.
if (captured.files?.[url.pathname]) return new Response(captured.files[url.pathname], { status: 200 });
if (url.pathname === "/robots.txt" && captured.robots !== undefined && robotsServes) return new Response(captured.robots, { status: 200, headers: { "content-type": "text/plain" } });
const match = /^\/p\/([a-z2-7]{32})(?:\/(reports\.json|manifest\.json|api\/v1))?$/.exec(url.pathname);
if (!captured.env || !match || match[1] !== captured.env.EXPLORE_PREVIEW_TOKEN) return new Response("Not found", { status: 404 });
// The token page negotiates like the real Worker: only a request that asks for HTML gets the shell.
if (!match[2]) return (options.headers?.accept ?? "").includes("text/html")
@@ -122,20 +131,9 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
const target = url.searchParams.get("target"), platform = url.searchParams.get("platform");
const entry = target ? captured.listing.find(candidate => candidate.target === target)
: platform ? captured.listing.find(candidate => candidate.target === platform) ?? captured.listing.find(candidate => candidate.platform === platform) : captured.listing[0];
if (!entry) return new Response("Not found", { status: 404 });
const key = Buffer.from(captured.env.EXPLORE_PREVIEW_KEY, "base64"); const sealed = Buffer.from(captured.sealedFiles[entry.path]);
const decipher = createDecipheriv("aes-256-gcm", key, sealed.subarray(0, 12));
decipher.setAAD(Buffer.from("expo-explore-preview/1")); decipher.setAuthTag(sealed.subarray(-16));
const plain = Buffer.concat([decipher.update(sealed.subarray(12, -16)), decipher.final()]);
// The manifest and assets the Viewer opens, as the Worker builds them; manifestServes: false is a Worker that cannot.
if (match[2] === "manifest.json" || match[2].startsWith("assets/")) {
const loaded = manifestServes ? await loadReport(new Uint8Array(plain)) : undefined;
if (!loaded) return new Response("Not found", { status: 404 });
if (match[2] === "manifest.json") return new Response(manifestBody(loaded), { status: 200, headers: { "content-type": "application/json; charset=utf-8" } });
const asset = await previewAsset(loaded, match[2]);
return asset ? new Response(asset.bytes, { status: 200, headers: { "content-type": asset.type } }) : new Response("Not found", { status: 404 });
}
return new Response(plain, { status: 200, headers: { "content-type": "application/zip" } });
// The manifest the Viewer opens, from the target's static file; manifestServes: false is a Worker that cannot read it.
const manifest = entry && manifestServes ? captured.files[entry.path] : undefined;
return manifest ? new Response(manifest, { status: 200, headers: { "content-type": "application/json; charset=utf-8" } }) : new Response("Not found", { status: 404 });
}
const artifactNames = { 20: "explore-review-10-1", 21: "explore-review-10-1-ios", 22: "explore-review-10-1-android" };
const byId = /\/actions\/artifacts\/(\d+)$/.exec(url.pathname);
@@ -154,10 +152,13 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
return { run, transport, calls, requests, captured };
}
import { readFileSync, existsSync } from "node:fs";
import { readFileSync, existsSync, readdirSync } from "node:fs";
const readFileSyncUtf8 = path => readFileSync(path, "utf8");
const readFileSyncBytes = path => new Uint8Array(readFileSync(path));
const existsSyncLocal = path => existsSync(path);
/** Every file under a directory, as paths relative to it. */
const readdirTree = (directory, prefix = "") => readdirSync(join(directory, prefix), { withFileTypes: true })
.flatMap(entry => entry.isDirectory() ? readdirTree(directory, join(prefix, entry.name)) : [join(prefix, entry.name)]);
const deployEnvironment = { ...environment, EXPO_TOKEN: "expo-test-token" };
test("ci:deploy seals the exact report, deploys it with the preview export, verifies the gate, and links Explore report", async t => {
@@ -175,28 +176,35 @@ test("ci:deploy seals the exact report, deploys it with the preview export, veri
assert.ok(eas.captured.hasViewer, "the preview export ships with the deployment");
const token = eas.captured.env.EXPLORE_PREVIEW_TOKEN;
assert.match(token, TOKEN_RE); assert.deepEqual(secrets, [token]);
assert.equal(Buffer.from(eas.captured.env.EXPLORE_PREVIEW_KEY, "base64").length, 32);
assert.equal(eas.captured.env.EXPLORE_PREVIEW_EXPIRES_AT, "2026-09-18T03:07:00.000Z");
assert.match(eas.captured.env.EXPLORE_PREVIEW_REPORT, /^\/_report\/[a-z2-7]{16}\/report\.zip\.enc$/);
// Nothing is sealed and nothing expires: the token in every path is what keeps the report private.
assert.deepEqual(Object.keys(eas.captured.env).sort(), ["EXPLORE_PREVIEW_REPORT", "EXPLORE_PREVIEW_TOKEN"]);
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, `/p/${token}/targets/report.json`);
assert.equal(result.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.deepEqual([result.project, result.owner, result.deploymentId, result.expiresAt], ["explore-playground-explore", "brent-org", "1lcbdcpwn3", "2026-09-18T03:07:00.000Z"]);
assert.deepEqual([result.project, result.owner, result.deploymentId, result.expiresAt], ["explore-playground-explore", "brent-org", "1lcbdcpwn3", null]);
const zip = await zipReportDirectory(reportPath);
assert.equal(result.reportSha256, createHash("sha256").update(zip).digest("hex"));
assert.equal(result.reportBytes, zip.byteLength);
const sealed = eas.captured.sealed;
assert.equal(sealed.byteLength, zip.byteLength + 12 + 16, "iv || ciphertext || tag, nothing else");
assert.ok(!Buffer.from(sealed).includes(Buffer.from("review.json")), "the static file is ciphertext");
// The static files: the manifest as the Viewer opens it, stamped with this deployment, and every screenshot under its SHA-256.
const loaded = await loadReport(zip);
const manifest = JSON.parse(new TextDecoder().decode(eas.captured.files[`/p/${token}/targets/report.json`]));
assert.match(manifest.deployment, /^[a-z2-7]{16}$/);
assert.equal(new TextDecoder().decode(eas.captured.files[`/p/${token}/targets/report.json`]), manifestBody(loaded, manifest.deployment));
const assets = Object.keys(eas.captured.files).filter(path => path.includes("/assets/"));
assert.deepEqual(assets.map(path => path.slice(`/p/${token}/`.length)).sort(), Object.keys(manifest.entries).sort());
for (const path of assets) assert.equal(createHash("sha256").update(eas.captured.files[path]).digest("hex"), /([a-f0-9]{64})\./.exec(path)[1]);
// EAS Hosting cannot put noindex on static files, so robots.txt keeps crawlers off the screenshots and manifests, not the page.
assert.equal(eas.captured.robots, "User-agent: *\nDisallow: /p/*/assets/\nDisallow: /p/*/targets/\n");
// Verification hit the gate and its negatives before the comment was published.
const previewPaths = eas.requests.filter(request => request.url.origin === "https://acme-explore--1lcbdcpwn3.expo.app").map(request => request.url.pathname.replace(/[a-f0-9]{64}/, "<sha256>"));
const wrong = token.endsWith("a") ? `${token.slice(0, -1)}b` : `${token.slice(0, -1)}a`;
// The ZIP, then what the Viewer opens from it: the manifest and one asset.
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`, `/p/${token}/report.zip`, `/p/${token}/manifest.json`, `/p/${token}/assets/<sha256>.png`,
"/", `/p/${wrong}`, `/p/${wrong}/report.zip`, `/p/${token}/viewer/index.html`]);
// What the Viewer opens: the manifest, then one screenshot, a static file.
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`, "/robots.txt", `/p/${token}/manifest.json`, `/p/${token}/assets/<sha256>.png`,
"/", `/p/${wrong}`, `/p/${wrong}/manifest.json`, `/p/${token}/viewer/index.html`]);
assert.ok(eas.requests.every(request => request.url.origin !== "https://acme-explore--1lcbdcpwn3.expo.app" || request.options.cache === "no-store"));
const posted = eas.requests.find(request => request.options.method === "POST");
const body = JSON.parse(posted.options.body).body;
assert.match(body, new RegExp(`\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}>\\) \\|`));
assert.match(body, /Preview links work until Sep 18, 2026 \(UTC\) for anyone who has them\./);
assert.match(body, /Preview links work for anyone who has them until the deployment is deleted\./);
assert.doesNotMatch(body, /explore-preview\.expo\.app\/\?/);
assert.ok(eas.requests.indexOf(posted) > eas.requests.findIndex(request => request.url.pathname === `/p/${token}/viewer/index.html`), "publish after verification");
});
@@ -225,16 +233,6 @@ test("the report ZIP is deterministic and mirrors the GitHub artifact layout", a
await assert.rejects(zipReportDirectory(reportPath), /review\.json \(or exploration\.json\) and assets/, "a report carries exactly one root file");
});
test("sealReport produces iv || AES-256-GCM ciphertext || tag bound to the preview AAD", () => {
const key = new Uint8Array(32).fill(7); const iv = new Uint8Array(12).fill(9); const plain = Buffer.from("PK\u0003\u0004report");
const sealed = Buffer.from(sealReport(plain, key, iv));
assert.deepEqual(sealed.subarray(0, 12), Buffer.from(iv));
const decipher = createDecipheriv("aes-256-gcm", key, iv); decipher.setAAD(Buffer.from("expo-explore-preview/1")); decipher.setAuthTag(sealed.subarray(-16));
assert.deepEqual(Buffer.concat([decipher.update(sealed.subarray(12, -16)), decipher.final()]), plain);
const wrongAad = createDecipheriv("aes-256-gcm", key, iv); wrongAad.setAAD(Buffer.from("other")); wrongAad.setAuthTag(sealed.subarray(-16));
wrongAad.update(sealed.subarray(12, -16)); assert.throws(() => wrongAad.final());
});
test("ci:deploy refuses to run without a preview request, EXPO_TOKEN, or the preview export, and reports EAS failures", async t => {
const plain = await exportFixture(t, { preview: null });
const eas = easFixture();
@@ -320,12 +318,12 @@ test("the preview owner comes from config or the token's single account; several
await assert.rejects(deployPreview({ inputPath, reportPath, artifactUrl, exportPath, environment: deployEnvironment, transport: several.transport, run: several.run, verifyTimeoutMs: 1 }),
error => error.code === "PREVIEW_OWNER_AMBIGUOUS" && /brent-org, acme/.test(error.message) && /report\.preview\.owner/.test(error.nextAction));
assert.deepEqual(several.calls.map(call => call.args[0]), ["whoami"]);
const configured = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: 7, owner: "acme", project: "wallet-explore" } });
const configured = await exportFixture(t, { preview: { hosting: "eas", owner: "acme", project: "wallet-explore" } });
const eas = easFixture({ accounts: ["brent-org", "acme"] });
const result = await deployPreview({ inputPath: configured.inputPath, reportPath: configured.reportPath, artifactUrl, exportPath: configured.exportPath,
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 });
assert.deepEqual([result.owner, result.project, eas.captured.appJson.expo.owner, eas.captured.appJson.expo.slug], ["acme", "wallet-explore", "acme", "wallet-explore"]);
const wrong = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: 7, owner: "nobody" } });
const wrong = await exportFixture(t, { preview: { hosting: "eas", owner: "nobody" } });
const other = easFixture();
await assert.rejects(deployPreview({ inputPath: wrong.inputPath, reportPath: wrong.reportPath, artifactUrl, exportPath: wrong.exportPath,
environment: deployEnvironment, transport: other.transport, run: other.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_OWNER_AMBIGUOUS" && /no access to the Expo account nobody/.test(error.message));
@@ -347,7 +345,7 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
const token = eas.captured.env.EXPLORE_PREVIEW_TOKEN;
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, undefined, "multi-platform deployments use the listing only");
assert.deepEqual(captureListing(eas.captured.listing), [
{ target: "ios", platform: "ios", label: "iOS", path: "ios.zip.enc" }, { target: "android", platform: "android", label: "Android", path: "android.zip.enc" }], "the capturing-phase fixture has no review yet, so no change count");
{ target: "ios", platform: "ios", label: "iOS", path: "ios.json" }, { target: "android", platform: "android", label: "Android", path: "android.json" }], "the capturing-phase fixture has no review yet, so no change count");
assert.ok(!eas.captured.env.EXPLORE_PREVIEW_REPORTS.includes("#"), "dotenv treats # as a comment");
const zips = [await zipReportDirectory(ios.reportPath), await zipReportDirectory(android.reportPath)];
assert.deepEqual(result.reports.map(report => [report.platform, report.reportSha256, report.reportBytes, report.artifactUrl]),
@@ -355,10 +353,10 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
assert.equal(result.reportSha256, result.reports[0].reportSha256);
const previewPaths = eas.requests.filter(request => request.url.origin === "https://acme-explore--1lcbdcpwn3.expo.app").map(request => (request.url.pathname + request.url.search).replace(/[a-f0-9]{64}/, "<sha256>"));
const wrong = token.endsWith("a") ? `${token.slice(0, -1)}b` : `${token.slice(0, -1)}a`;
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`,
...["ios", "android"].flatMap(platform => [`/p/${token}/report.zip?platform=${platform}`, `/p/${token}/manifest.json?platform=${platform}`, `/p/${token}/assets/<sha256>.png?platform=${platform}`]),
assert.deepEqual(previewPaths, [`/p/${token}`, `/p/${token}/api/v1`, "/robots.txt",
...["ios", "android"].flatMap(platform => [`/p/${token}/manifest.json?platform=${platform}`, `/p/${token}/assets/<sha256>.png`]),
`/p/${token}/reports.json`,
"/", `/p/${wrong}`, `/p/${wrong}/report.zip`, `/p/${token}/viewer/index.html`]);
"/", `/p/${wrong}`, `/p/${wrong}/manifest.json`, `/p/${token}/viewer/index.html`]);
const posted = eas.requests.filter(request => request.options.method === "POST" || request.options.method === "PATCH").map(request => JSON.parse(request.options.body).body);
assert.equal(posted.length, 2, "the second platform updates the comment the first created");
assert.match(posted[0], new RegExp(`\\| iOS \\| [^|]+\\| 🟩 [^|]+\\| \\[Open\\]\\(<https://acme-explore--1lcbdcpwn3\\.expo\\.app/p/${token}\\?platform=ios>\\)`));
@@ -369,7 +367,7 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
});
function captureListing(listing) {
return listing.map(({ path, ...rest }) => ({ ...rest, path: path.replace(/^\/_report\/[a-z2-7]{16}\//, "") }));
return listing.map(({ path, ...rest }) => ({ ...rest, path: path.replace(/^\/p\/[a-z2-7]{32}\/targets\//, "") }));
}
test("collectPlatformReports pairs downloaded artifact directories by platform and looks up each report artifact's URL", async t => {
@@ -415,8 +413,10 @@ test("ci:deploy leaves the deployments the previous comment linked alone; develo
assert.ok(eas.requests.find(request => request.options.method === "PATCH"), "the comment was updated to link the new deployment");
});
test("a never-expiring preview seals no EXPLORE_PREVIEW_EXPIRES_AT and the comment says the link lasts until the deployment is deleted", async t => {
const { inputPath, reportPath, exportPath } = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: null } });
test("a preview sets no expiry of its own: an old config's expiresAfter is noted and ignored, and the comment says the link lasts until the deployment is deleted", async t => {
const { inputPath, reportPath, exportPath } = await exportFixture(t, { preview: { hosting: "eas", expiresAfterIgnored: true } });
const warnings = [];
t.mock.method(process.stderr, "write", chunk => { warnings.push(String(chunk)); return true; });
const eas = easFixture();
const result = await deployPreview({ inputPath, reportPath, artifactUrl, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.equal("EXPLORE_PREVIEW_EXPIRES_AT" in eas.captured.env, false);
@@ -424,6 +424,15 @@ test("a never-expiring preview seals no EXPLORE_PREVIEW_EXPIRES_AT and the comme
const body = JSON.parse(eas.requests.find(request => request.options.method === "PATCH" || request.options.method === "POST").options.body).body;
assert.match(body, /^Preview links work for anyone who has them until the deployment is deleted\. · Managed via /m);
assert.doesNotMatch(body, /works until/);
assert.ok(warnings.some(line => line.includes("report.preview.expiresAfter no longer applies: a hosted preview lasts as long as its EAS Hosting deployment")), warnings.join(""));
// A capture from an earlier version recorded the expiry as expiresAfterDays: still accepted, and noted the same way.
const legacy = await exportFixture(t, { preview: { hosting: "eas", expiresAfterDays: 7 } });
warnings.length = 0;
const again = easFixture();
assert.equal((await deployPreview({ inputPath: legacy.inputPath, reportPath: legacy.reportPath, artifactUrl, exportPath: legacy.exportPath, environment: deployEnvironment,
transport: again.transport, run: again.run, now: () => now, verifyTimeoutMs: 1 })).expiresAt, null);
assert.ok(warnings.some(line => line.includes("report.preview.expiresAfter no longer applies")), warnings.join(""));
});
test("a standalone report deploys to a fixed alias with a fixed token, verifies both hosts, and prints the alias link", async t => {
@@ -431,7 +440,7 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
await asExploration(reportPath);
const eas = easFixture();
const token = "b".repeat(32);
const result = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, alias: "bluesky", token,
const result = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky", token,
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.deepEqual(eas.calls[2].args, ["deploy", "--json", "--non-interactive", "--export-dir", "dist", "--alias", "bluesky"]);
assert.equal(eas.captured.env.EXPLORE_PREVIEW_TOKEN, token, "the caller's token is sealed into the deployment");
@@ -441,16 +450,16 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
const origins = new Set(eas.requests.filter(request => request.url.pathname.startsWith("/p/")).map(request => request.url.origin));
assert.deepEqual([...origins].sort(), ["https://acme-explore--1lcbdcpwn3.expo.app", "https://acme-explore--bluesky.expo.app"], "the report is verified on the deployment and on the alias");
const plain = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: 7, exportPath,
const plain = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath,
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.equal(eas.captured.alias, undefined);
assert.equal(plain.aliasUrl, undefined);
assert.match(plain.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
assert.notEqual(plain.previewUrl, result.previewUrl, "without a fixed token the link is random");
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, alias: "Blue Sky",
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "Blue Sky",
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_ALIAS_INVALID");
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, token: "short",
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, token: "short",
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_TOKEN_INVALID");
});
@@ -473,11 +482,11 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
assert.equal(eas.captured.alias, "pr-12");
assert.equal("EXPLORE_PREVIEW_EXPIRES_AT" in eas.captured.env, false, "a fixture preview does not expire");
assert.deepEqual(captureListing(eas.captured.listing), [
{ target: "android", platform: "android", label: "Android", changes: 12, device: "Pixel · light + dark", path: "android.zip.enc" },
{ target: "ios", platform: "ios", label: "iOS", path: "ios.zip.enc" },
{ target: "android", platform: "android", label: "Android", changes: 12, device: "Pixel · light + dark", path: "android.json" },
{ target: "ios", platform: "ios", label: "iOS", path: "ios.json" },
]);
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/report.zip`).map(request => request.url.searchParams.get("platform"));
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' bytes are verified");
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/manifest.json`).map(request => request.url.searchParams.get("platform"));
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' manifests are verified");
// The alias lagging the deployment past the budget is not a failed deployment: the deployment is verified, so the
// link is the deployment's own origin and the job log carries a warning (every 2026-10-14 "HTTP 404" failure was this).
@@ -526,7 +535,7 @@ test("a deployment that does not report the requested alias is a retryable deplo
const { aliases: _aliases, ...rest } = JSON.parse(result.stdout);
return { ...result, stdout: `${JSON.stringify(rest)}\n` };
};
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", expiresAfterDays: null, exportPath, alias: "bluesky",
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky",
environment: deployEnvironment, transport: eas.transport, run, now: () => now, verifyTimeoutMs: 1 }),
error => error.code === "PREVIEW_DEPLOY_FAILED" && error.retryable === true && /did not report the alias bluesky/.test(error.message));
});
@@ -565,7 +574,7 @@ test("a comparison of two commits deploys the same way and links its report from
assert.match(summary, /^### Explore: `v1\.4\.0` vs `v1\.3\.0`$/m);
assert.ok(summary.includes(`[Open the report](${result.previewUrl})`));
assert.ok(summary.includes(`(https://github.com/${pr.repository}/compare/${pr.base.sha}..${pr.head.sha})`));
assert.match(summary, /link expires 2026-09-18/);
assert.doesNotMatch(summary, /expires/, "a hosted preview lasts as long as its deployment");
});
test("readReportZip reads a review ZIP's platform, run and labels, and rejects anything that is not a report", async t => {
@@ -613,35 +622,35 @@ test("deployLocalReports hosts one review's platforms behind one link, labelled
const zip = await zipReportDirectory(reportPath);
const eas = easFixture();
const result = await deployLocalReports({ reports: [{ platform: "ios", zip, changes: 3, device: "iPhone 17 26.5" }, { platform: "android", zip }],
project: "acme-explore", expiresAfterDays: null, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
project: "acme-explore", exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.match(result.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
assert.equal(result.owner, "brent-org", "the only account of the login holds the project");
assert.equal(result.expiresAt, null);
assert.deepEqual(captureListing(eas.captured.listing), [
{ target: "ios", platform: "ios", label: "iOS", changes: 3, device: "iPhone 17 26.5", path: "ios.zip.enc" },
{ target: "android", platform: "android", label: "Android", path: "android.zip.enc" },
{ target: "ios", platform: "ios", label: "iOS", changes: 3, device: "iPhone 17 26.5", path: "ios.json" },
{ target: "android", platform: "android", label: "Android", path: "android.json" },
]);
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "ios", zip }], project: "acme-explore", expiresAfterDays: 7, exportPath,
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "ios", zip }], project: "acme-explore", exportPath,
environment: deployEnvironment, transport: eas.transport, run: eas.run }), error => error.code === "PREVIEW_REPORTS_INVALID");
// One Android report is still listed, so the Worker does not take it for iOS; a label with `#` cannot cut the sealed .env short.
await deployLocalReports({ reports: [{ platform: "android", zip, changes: 1, device: "Pixel #9 <Pro>\n" }], project: "acme-explore", expiresAfterDays: 7, exportPath,
await deployLocalReports({ reports: [{ platform: "android", zip, changes: 1, device: "Pixel #9 <Pro>\n" }], project: "acme-explore", exportPath,
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, undefined);
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", changes: 1, device: "Pixel 9 Pro", path: "android.zip.enc" }]);
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", changes: 1, device: "Pixel 9 Pro", path: "android.json" }]);
// eas deploy expands $VARIABLES in that .env, even single-quoted: a label never carries one in, nor a backslash.
await deployLocalReports({ reports: [{ platform: "ios", zip, device: "iPhone ${EXPO_TOKEN} $EXPLORE_PREVIEW_KEY \\$ · light + dark" }], project: "acme-explore",
expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "ios", platform: "ios", label: "iOS", device: "iPhone EXPO_TOKEN EXPLORE_PREVIEW_KEY · light + dark", path: "ios.zip.enc" }]);
exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "ios", platform: "ios", label: "iOS", device: "iPhone EXPO_TOKEN EXPLORE_PREVIEW_KEY · light + dark", path: "ios.json" }]);
});
test("an explore:binary report names its platform, so an Android exploration is not served as iOS", async t => {
const { reportPath, exportPath } = await exportFixture(t);
await asExploration(reportPath);
const eas = easFixture();
await deployExplorationReport({ reportPath, platform: "android", project: "acme-explore", owner: "brent-org", expiresAfterDays: 7, exportPath,
await deployExplorationReport({ reportPath, platform: "android", project: "acme-explore", owner: "brent-org", exportPath,
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", path: "android.zip.enc" }]);
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", path: "android.json" }]);
});
test("readReportZip stops inflating a report file once it passes the size its header declares", async () => {
@@ -722,20 +731,20 @@ test("readReportZip names the report's target from review.runtime.target, and ig
assert.equal((await readReportZip(await zipReportDirectory(reportPath))).target.label, "Duo HOME open 1", "a label is plain text, safe in the sealed .env");
});
test("deployLocalReports hosts four targets, three of them iOS, as <target>.zip.enc selected by ?target=", async t => {
test("deployLocalReports hosts four targets, three of them iOS, as targets/<target>.json selected by ?target=", async t => {
const { reportPath, exportPath } = await exportFixture(t);
const zip = await zipReportDirectory(reportPath);
const eas = easFixture();
await deployLocalReports({ reports: TARGETS.map((target, index) => ({ platform: target.platform, target, zip: new Uint8Array([...zip, ...new Array(index).fill(0)]), changes: index })),
project: "acme-explore", expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.deepEqual(captureListing(eas.captured.listing), TARGETS.map((target, index) => ({ target: target.id, platform: target.platform, label: target.label, path: `${target.id}.zip.enc`, changes: index })));
const served = eas.requests.filter(request => request.url.pathname === `/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}/report.zip`).map(request => request.url.search);
project: "acme-explore", exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
assert.deepEqual(captureListing(eas.captured.listing), TARGETS.map((target, index) => ({ target: target.id, platform: target.platform, label: target.label, path: `${target.id}.json`, changes: index })));
const served = eas.requests.filter(request => request.url.pathname === `/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}/manifest.json`).map(request => request.url.search);
assert.deepEqual([...new Set(served)], ["?target=iphone", "?target=duo-closed", "?target=duo-open", "?platform=android"],
"a target named after its platform keeps the ?platform= link it always had");
for (const reports of [[{ platform: "ios", target: TARGETS[0], zip }, { platform: "ios", target: TARGETS[0], zip }],
[{ platform: "ios", target: { id: "Bad", platform: "ios", label: "x" }, zip }],
Array.from({ length: 9 }, (_, index) => ({ platform: "ios", target: { id: `t${index}`, platform: "ios", label: "x" }, zip }))]) {
await assert.rejects(deployLocalReports({ reports, project: "acme-explore", expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run }),
await assert.rejects(deployLocalReports({ reports, project: "acme-explore", exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run }),
error => error.code === "PREVIEW_REPORTS_INVALID");
}
});
@@ -763,9 +772,9 @@ test("ci:deploy pairs target-named artifacts, deploys them in config order, and
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 })
.catch(error => error);
// Publishing each target's comment section after the deployment is the comment code's (publishCiReportComment, which needs
// the target to name the artifact); the deployment itself must have been sealed per target either way.
// the target to name the artifact); the deployment itself must have been written per target either way.
assert.deepEqual(captureListing(eas.captured.listing).map(entry => [entry.target, entry.platform, entry.label, entry.path]),
TARGETS.map(target => [target.id, target.platform, target.label, `${target.id}.zip.enc`]), String(sealed?.message ?? ""));
TARGETS.map(target => [target.id, target.platform, target.label, `${target.id}.json`]), String(sealed?.message ?? ""));
// An artifact named for one target that holds another's report is refused.
await rm(join(root, "inputs", "explore-capture-10-1-duo-open"), { recursive: true });
@@ -783,3 +792,35 @@ test("ci:deploy fails a deployment whose Worker serves the ZIP but not the manif
const posted = eas.requests.filter(request => request.options.method === "POST" || request.options.method === "PATCH").map(request => JSON.parse(request.options.body).body);
assert.ok(posted.every(body => !body.includes(`/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}`)), posted.join("\n---\n"));
});
test("a deployment that does not serve its robots.txt fails verification", async t => {
const { inputPath, reportPath, exportPath } = await exportFixture(t);
const eas = easFixture({ robotsServes: false });
await assert.rejects(deployPreview({ inputPath, reportPath, exportPath, artifactUrl, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 }),
error => error.code === "PREVIEW_VERIFY_FAILED" && /robots\.txt/.test(error.message));
});
test("eas output that names an upload's path keeps the link's token out of the log and the error", async t => {
const { inputPath, reportPath, exportPath } = await exportFixture(t);
const eas = easFixture({ failDeploy: "upload-path" });
const logged = [];
t.mock.method(process.stderr, "write", chunk => { logged.push(String(chunk)); return true; });
const error = await deployPreview({ inputPath, reportPath, artifactUrl, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run,
now: () => now, verifyTimeoutMs: 1, sleep: async () => {} }).catch(caught => caught);
assert.equal(error.code, "PREVIEW_DEPLOY_FAILED");
assert.ok(logged.some(line => line.includes('Upload of "client/p/***/assets/')), logged.join(""));
for (const text of [...logged, error.details.output, error.message]) assert.doesNotMatch(text, /p\/[a-z2-7]{32}\//, text);
});
test("targets that share a screenshot must agree on its size, or the deploy refuses the report", async t => {
const { reportPath, exportPath } = await exportFixture(t);
const zip = await zipReportDirectory(reportPath);
const broken = await mkdtemp(join(tmpdir(), "explore-broken-")); t.after(() => rm(broken, { recursive: true, force: true }));
await cp(reportPath, broken, { recursive: true });
await writeFile(join(broken, "assets", `${sha256}.png`), png.subarray(0, 10));
const eas = easFixture();
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "android", zip: await zipReportDirectory(broken) }], project: "acme-explore", exportPath,
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 }),
error => error.code === "REPORT_ZIP_FAILED" && error.message.includes(`assets/${sha256}.png`));
assert.equal(eas.calls.filter(call => call.args[0] === "deploy").length, 0, "nothing is deployed");
});
+5 -8
View File
@@ -54,17 +54,14 @@ test("rejects comparisons that name another URL, a PR number, or one commit twic
assert.throws(() => projectReviewPresentation({ ...comparison, repositoryId: "x" }), /decimal GitHub id/);
});
test("a run's scope and link lifetime override the reviewed config only where the workflow set them", async () => {
test("a run's scope overrides the reviewed config only where the workflow set it; a link lifetime from older workflows changes nothing", async () => {
const { withRunOverrides } = await import("../../dist/config/explore-config.js");
const config = { exploration: { scope: "changes" }, report: { preview: { hosting: "eas", expiresAfterDays: 30 } } };
const config = { exploration: { scope: "changes" }, report: { preview: { hosting: "eas" } } };
assert.deepEqual(withRunOverrides(config, {}), config);
assert.deepEqual(withRunOverrides(config, { scope: "all", expiresIn: "never" }),
{ exploration: { scope: "all" }, report: { preview: { hosting: "eas", expiresAfterDays: null } } });
assert.equal(withRunOverrides(config, { expiresIn: "90d" }).report.preview.expiresAfterDays, 90);
assert.deepEqual(withRunOverrides({ exploration: { scope: "changes" } }, { expiresIn: "never" }), { exploration: { scope: "changes" } }, "no hosting, nothing to expire");
assert.deepEqual(withRunOverrides(config, { scope: "all", expiresIn: "never" }), { exploration: { scope: "all" }, report: { preview: { hosting: "eas" } } });
// A hosted preview lasts as long as its EAS Hosting deployment, so --expires-in is accepted from older workflows and ignored, whatever it says.
assert.deepEqual(withRunOverrides(config, { expiresIn: "forever" }), config);
assert.throws(() => withRunOverrides(config, { scope: "everything" }), /--scope must be changes or all/);
assert.throws(() => withRunOverrides(config, { expiresIn: "forever" }), /--expires-in/);
assert.throws(() => withRunOverrides({ exploration: { scope: "changes" } }, { expiresIn: "forevr" }), /--expires-in/, "a typo fails even before hosting is on");
});
test("a comparison links GitHub's direct two-dot diff, which matches what capture compares, also for a rollback", () => {
+12
View File
@@ -58,3 +58,15 @@ test("no two shortcuts share a chord", () => {
}
}
});
test("⌥1–⌥8 open a target by its place, with ⌥ alone; D and ` are plain keys", () => {
assert.equal(SHORTCUTS.targetByNumber.length, 8);
assert.ok(matchesShortcut(key("Digit2", { altKey: true }), SHORTCUTS.targetByNumber[1]));
assert.ok(!matchesShortcut(key("Digit2"), SHORTCUTS.targetByNumber[1]), "a plain 2 is Compare's Swipe");
assert.ok(!matchesShortcut(key("Digit2", { altKey: true, shiftKey: true }), SHORTCUTS.targetByNumber[1]));
assert.ok(!matchesShortcut(key("Digit2", { altKey: true, ctrlKey: true }), SHORTCUTS.targetByNumber[1]));
assert.equal(formatShortcut(SHORTCUTS.targetByNumber[0], true), "⌥1");
assert.equal(formatShortcut(SHORTCUTS.targetByNumber[0], false), "Alt+1");
assert.ok(matchesShortcut(key("KeyD"), SHORTCUTS.target.menu));
assert.ok(matchesShortcut(key("Backquote"), SHORTCUTS.target.last));
});
+16 -10
View File
@@ -14,7 +14,7 @@ The Viewer verifies that a dropped ZIP is the report for the linked run attempt
## Environment
The central host reads no environment variables and holds no secrets. A preview deployment reads only the four `EXPLORE_PREVIEW_*` values sealed into it at deploy time (below).
The central host reads no environment variables and holds no secrets. A preview deployment reads only the `EXPLORE_PREVIEW_*` values written into it at deploy time (below).
## Routes
@@ -25,22 +25,28 @@ The central host reads no environment variables and holds no secrets. A preview
A hosted preview is one immutable EAS Hosting deployment per review, in the reviewed application's own EAS account, that opens the report without a download. Its export (`npm run export:preview`, written to `dist-preview/`) holds the identical staged Viewer under `/viewer/` and three API routes:
- `/p/<token>` serves the Viewer shell for exactly one 160-bit token (32 lowercase base32 characters) to requests that accept HTML; the shell's `#root` holds a text index of the report (title, counts, API links) until the Viewer renders, and a `Link` header names the JSON and Markdown alternates. Requests that do not prefer HTML (`Accept: */*`, `text/markdown`, `application/json`) get the same index as Markdown, so an agent handed the link finds the API by itself.
- `/p/<token>/manifest.json` is what the Viewer opens: the report's metadata file (`review.json` or `exploration.json`) verbatim plus the size of every asset, decrypted from this deployment's own static files and ~12 KB over the wire; the shell preloads it so it downloads alongside the Viewer bundle. `/p/<token>/assets/<sha256>.<png|jpg|mp4>` serves one asset when the Viewer first shows it, `private, immutable` with a `max-age` of a week at most and never past the link's expiry, so this browser keeps it while shared caches never see it. Both answer `503` when the Worker cannot read the report at that moment, which the Viewer retries; `ci:deploy` checks that the manifest matches the deployed ZIP and that an asset serves its exact bytes. `/p/<token>/report.zip` still streams the whole decrypted ZIP (downloads, older Viewers). `/p/<token>/reports.json` lists the capture targets (up to 8, each with its platform and label) a multi-target deployment serves; `?target=<id>` selects one on every other route, and `?platform=<p>`, from links before targets, selects the target named `<p>`, else the first of that platform.
- `/p/<token>/llms.txt` is the Markdown index at a fixed path, and `/p/<token>/api/v1/...` is the read-only agent API (`src/server/agent-api.ts`): summary, `/screens[?status=]`, `/screens/<id>`, `/transitions`, and for exploration reports `/journeys`, `/gaps`, `/frontier`, `/assets/<sha256>`, `/raw`, with `?limit=`/`?cursor=` paging (50 default, 200 max). The Worker decrypts and parses an archive when a request first needs it (`src/server/report-zip.ts` reads the stored PNGs and the deflated report JSON) and keeps the two most recently used in memory, plus every target's manifest; a manifest built for a report it is not keeping (the Viewer prefetches every target's) decrypts that report once and lets it go. The manifest and asset helpers live in `src/report/preview-manifest.ts`, shared with the local report server.
- `/` and every other path, token, or method answer the same `404 Not found`, so a response never confirms that a deployment or token exists. After the sealed expiry the exact token still opens the Viewer shell for browsers, and every report route, including the Markdown index and the API, answers `410` with the expiry instant so the Viewer and agents can say the link expired.
- `/p/<token>/manifest.json` is what the Viewer opens: the report's metadata file (`review.json` or `exploration.json`) verbatim plus the size of every asset, about 12 KB over the wire; the shell preloads it so it downloads alongside the Viewer bundle. The Worker answers it from its target's static manifest, passed through unparsed unless the isolate already holds it. `/p/<token>/reports.json` lists the capture targets (up to 8, each with its platform and label) a multi-target deployment serves; `?target=<id>` selects one on every other route, and `?platform=<p>`, from links before targets, selects the target named `<p>`, else the first of that platform.
- `/p/<token>/llms.txt` is the Markdown index at a fixed path, and `/p/<token>/api/v1/...` is the read-only agent API (`src/server/agent-api.ts`): summary, `/screens[?status=]`, `/screens/<id>`, `/transitions`, and for exploration reports `/journeys`, `/gaps`, `/frontier`, `/assets/<sha256>`, `/raw`, with `?limit=`/`?cursor=` paging (50 default, 200 max). The Worker reads the target's static manifest when a request first needs it and keeps parsed manifests in memory within 32 MB; requests that arrive together share one fetch. `/api/v1/assets/<sha256>` reads the screenshot's static file.
- `/` and every other path, token, or method answer the same `404 Not found`, so a response never confirms that a deployment or token exists. A static file the Worker cannot fetch this time answers `503`, which the Viewer retries.
`ci:deploy` seals the deployment by writing a deploy-time `.env` next to the export; EAS Hosting delivers it to the Worker and to nothing else:
`ci:deploy` writes the report as static files of the deployment, under the token, and EAS Hosting serves them directly, before the Worker:
| Path | Content |
| --- | --- |
| `/p/<token>/targets/<target>.json` | one target's manifest (`report.json` for a single unlisted report), stamped with the deployment so `ci:deploy` can tell it from the one an alias still serves |
| `/p/<token>/assets/<sha256>.<png\|jpg\|mp4>` | every screenshot and recording, once, shared by the targets that show it |
It also writes a deploy-time `.env` next to the export; EAS Hosting delivers it to the Worker and to nothing else:
| Variable | Value |
| --- | --- |
| `EXPLORE_PREVIEW_TOKEN` | the path token in the review comment's **Explore report** link |
| `EXPLORE_PREVIEW_KEY` | base64 AES-256-GCM key, generated per deployment |
| `EXPLORE_PREVIEW_EXPIRES_AT` | ISO 8601 instant; the report routes answer 410 from then on (unset: the link does not expire) |
| `EXPLORE_PREVIEW_REPORT` | `/_report/<id>/report.zip.enc`, the ciphertext's static path |
| `EXPLORE_PREVIEW_REPORT` | `/p/<token>/targets/report.json` (a single iOS report), or |
| `EXPLORE_PREVIEW_REPORTS` | JSON listing each target, its platform, label, change count and device, and its manifest's path |
The report is encrypted before upload (12-byte IV, then AES-GCM ciphertext and tag, additional data `expo-explore-preview/1`) and the key never leaves the deployment environment, so the CDN serves only ciphertext and a token that leaks into a request log does not leak the report. A preview link is still a bearer link: anyone who has it can open the report until it expires. Expo account members who can read the project's deployments are inside that trust boundary. Report bytes are never embedded in the Worker bundle, because a deleted deployment's static files disappear within seconds while its Worker can keep answering for a few minutes.
Nothing is encrypted: what keeps a report private is the 160-bit token in every path, the same as for the link itself. A preview link is a bearer link: anyone who has it can open the report until the deployment is deleted (EAS Hosting deletes one without an alias after 30 days on Free and 90 on paid plans), and Expo account members who can read the project's deployments are inside that trust boundary. Explore sets no expiry; `EXPLORE_PREVIEW_KEY` and `EXPLORE_PREVIEW_EXPIRES_AT` from earlier deployments belong to those deployments' own Workers.
`npm run verify:export:preview` loads the exported route bundles and checks the token, expiry, decryption, content negotiation, agent API, and 404 behavior against the sealed example report.
`npm run verify:export:preview` loads the exported route bundles and checks the token, the manifest route, content negotiation, the agent API (including a screenshot read from its static file), and 404 behavior against the example report laid out as `ci:deploy` writes it.
## Validation and deployment
+29 -33
View File
@@ -79,32 +79,29 @@ if (!preview) {
}
}
} else {
// A preview deployment answers only its own token and serves the report decrypted from its own
// static ciphertext until it expires (then the report route says 410); everything else is the same 404.
// A preview deployment answers only its own token. ci:deploy writes the report as static files under it, which EAS
// Hosting serves without the Worker; the Worker reads the manifest back for the shell's index and the agent API, and
// everything else is the same 404.
const token = "abcdefghijklmnopqrstuvwxyz234567";
const keyBytes = webcrypto.getRandomValues(new Uint8Array(32));
const reportPath = "/_report/abcdefghijklmnop/report.zip.enc";
// A recorded PR review, so the exported Worker is seen to inflate the archive and answer the agent API.
const plain = new Uint8Array(await readFile(new URL("../../test/fixtures/example-review-artifact.zip", import.meta.url)));
const key = await webcrypto.subtle.importKey("raw", keyBytes, "AES-GCM", false, ["encrypt"]);
const iv = webcrypto.getRandomValues(new Uint8Array(12));
const cipher = new Uint8Array(await webcrypto.subtle.encrypt({ name: "AES-GCM", iv, additionalData: new TextEncoder().encode("expo-explore-preview/1") }, key, plain));
const sealed = new Uint8Array(iv.byteLength + cipher.byteLength);
sealed.set(iv); sealed.set(cipher, iv.byteLength);
const env = {
EXPLORE_PREVIEW_TOKEN: token,
EXPLORE_PREVIEW_KEY: Buffer.from(keyBytes).toString("base64"),
EXPLORE_PREVIEW_EXPIRES_AT: new Date(Date.now() + 60_000).toISOString(),
EXPLORE_PREVIEW_REPORT: reportPath,
};
const reportPath = `/p/${token}/targets/report.json`;
// A recorded PR review, laid out as ci:deploy writes it, so the exported Worker is seen to read it and answer the agent API.
const { tsImport } = await import("tsx/esm/api");
const { loadReport } = await tsImport("../../src/report/agent-api.ts", import.meta.url);
const { manifestBody, PREVIEW_ASSET } = await tsImport("../../src/report/preview-manifest.ts", import.meta.url);
const loaded = await loadReport(new Uint8Array(await readFile(new URL("../../test/fixtures/example-review-artifact.zip", import.meta.url))));
const manifest = manifestBody(loaded, "verifyexport");
const files = new Map([[reportPath, new TextEncoder().encode(manifest)]]);
for (const name of loaded.entries.keys()) if (PREVIEW_ASSET.test(name)) files.set(`/p/${token}/${name}`, await loaded.read(name, 64 * 1024 * 1024));
const env = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_REPORT: reportPath };
const origin = "https://acme-explore--deploy.expo.app";
const fetched = [];
const fetchStub = async (input) => {
const url = new URL(typeof input === "string" ? input : input.url);
fetched.push(url.href);
return url.pathname === reportPath ? new Response(sealed) : new Response("missing", { status: 404 });
fetched.push(url.pathname);
const body = files.get(url.pathname);
return body ? new Response(body, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
};
const globals = { fetch: fetchStub, crypto: webcrypto, TextDecoder, Blob, DecompressionStream };
const globals = { fetch: fetchStub, crypto: webcrypto, TextDecoder, TextEncoder, Blob, DecompressionStream };
const index = loadRoute("/index", env, globals);
for (const method of ["GET", "HEAD", "POST", "OPTIONS"]) {
@@ -125,31 +122,30 @@ if (!preview) {
throw new Error(`Preview page ${path} must serve the Markdown index when HTML is not requested`);
}
}
const served = await handlers.GET(new Request(`${origin}/p/${token}/manifest.json`));
if (served.status !== 200 || await served.text() !== manifest) throw new Error(`Preview route ${page} must answer the static manifest the Viewer opens`);
const summary = await handlers.GET(new Request(`${origin}/p/${token}/api/v1`));
if (summary.status !== 200 || (await summary.json()).kind !== "pr-review") throw new Error(`Preview route ${page} must answer the agent API summary`);
const changed = await handlers.GET(new Request(`${origin}/p/${token}/api/v1/screens?status=modified`));
if (changed.status !== 200 || !((await changed.json()).total > 0)) throw new Error(`Preview route ${page} must list modified screens`);
if (!(await (await handlers.GET(new Request(`${origin}/p/${token}/llms.txt`))).text()).startsWith("# Expo Explore report")) throw new Error(`Preview route ${page} must serve llms.txt`);
const zip = await handlers.GET(new Request(`${origin}/p/${token}/report.zip`));
if (zip.status !== 200 || zip.headers.get("content-type") !== "application/zip"
|| Buffer.compare(Buffer.from(await zip.arrayBuffer()), Buffer.from(plain)) !== 0) {
throw new Error(`Preview report route ${page} must stream the decrypted report`);
const sha = [...loaded.entries.keys()].map(name => /^assets\/([a-f0-9]{64})\.png$/.exec(name)?.[1]).find(Boolean);
const image = await handlers.GET(new Request(`${origin}/p/${token}/api/v1/assets/${sha}`));
if (image.status !== 200 || Buffer.compare(Buffer.from(await image.arrayBuffer()), Buffer.from(files.get(`/p/${token}/assets/${sha}.png`))) !== 0) {
throw new Error(`Preview route ${page} must serve a screenshot to the agent API from the static file`);
}
for (const path of [`/p/${token.replace("a", "b")}`, `/p/${token.replace("a", "b")}/report.zip`, `/p/${token.replace("a", "b")}/api/v1`, `/p/${token}/viewer/index.html`, `/p/${token}/other`, `/p/${token}/api/v1/other`, `/p/${token}/api/v2`, "/p/", `/P/${token}`]) {
// Screenshots and manifests are static files EAS Hosting serves itself; the Worker answers none of their paths.
for (const path of [`/p/${token.replace("a", "b")}`, `/p/${token.replace("a", "b")}/manifest.json`, `/p/${token.replace("a", "b")}/api/v1`, `/p/${token}/report.zip`,
`/p/${token}/targets/report.json`, `/p/${token}/assets/${sha}.png`, `/p/${token}/viewer/index.html`, `/p/${token}/other`, `/p/${token}/api/v1/other`, `/p/${token}/api/v2`, "/p/", `/P/${token}`]) {
if ((await handlers.GET(new Request(origin + path))).status !== 404) throw new Error(`Preview route ${page} incorrectly accepts ${path}`);
}
for (const method of ["HEAD", "POST", "PUT", "DELETE", "OPTIONS"]) {
if ((await handlers[method](new Request(`${origin}/p/${token}`, { method }))).status !== 404) throw new Error(`Preview route ${page} must answer 404 to ${method}`);
}
const expired = loadRoute(page, { ...env, EXPLORE_PREVIEW_EXPIRES_AT: new Date(Date.now() - 1000).toISOString() }, globals);
if ((await expired.GET(new Request(`${origin}/p/${token}`, { headers: { accept: "text/html" } }))).status !== 200) throw new Error(`Preview route ${page} must keep opening the Viewer after expiry`);
for (const path of [`/p/${token}`, `/p/${token}/report.zip`, `/p/${token}/api/v1`, `/p/${token}/llms.txt`]) {
if ((await expired.GET(new Request(origin + path))).status !== 410) throw new Error(`Preview route ${page} must answer 410 for ${path} after expiry`);
}
const unsealed = loadRoute(page, {}, globals);
if ((await unsealed.GET(new Request(`${origin}/p/${token}`))).status !== 404) throw new Error(`Preview route ${page} must refuse to serve without a sealed configuration`);
const unconfigured = loadRoute(page, {}, globals);
if ((await unconfigured.GET(new Request(`${origin}/p/${token}`))).status !== 404) throw new Error(`Preview route ${page} must refuse to serve without a configuration`);
}
if (fetched.some(href => !href.endsWith(reportPath))) throw new Error("Preview routes fetched something other than the sealed report path");
if (fetched.some(path => !path.startsWith(`/p/${token}/`))) throw new Error("Preview routes fetched something other than the deployment's own report files");
}
process.stdout.write(
+130 -233
View File
@@ -1,35 +1,32 @@
/**
* One hosted preview deployment per review: the Worker gates everything under `/p/<token>` with
* a token and an expiry sealed into the deployment's environment at deploy time, fetches the
* AES-256-GCM encrypted report from its own static files, decrypts it with a key that exists
* only in that environment, and streams it. Static files on the CDN are ciphertext; the Viewer
* bundle under /viewer/ is public and identical to the central host's.
* One hosted preview deployment per review. `ci:deploy` writes the report as static files of the deployment under the
* link's token: each target's manifest at `/p/<token>/targets/<target>.json` and every screenshot at
* `/p/<token>/assets/<sha256>.<ext>`. EAS Hosting serves those files directly; nothing encrypts them, and what keeps
* them private is the 160-bit token in their path. This Worker answers the rest of `/p/<token>`: the Viewer shell,
* the manifest the Viewer asks for by target, the target list, and the agent API. The Viewer bundle under /viewer/ is
* public and identical to the central host's.
*/
import { AGENT_API_VERSION, agentApiReply, agentIndexHtml, agentIndexMarkdown, loadReport, prefersHtml, type AgentContext, type LoadedReport } from "../../../src/report/agent-api";
import { manifestBody, previewAsset } from "../../../src/report/preview-manifest";
import { AGENT_API_VERSION, agentApiReply, agentIndexHtml, agentIndexMarkdown, prefersHtml, type AgentContext, type LoadedReport } from "../../../src/report/agent-api";
import { MAX_ASSET_BYTES, MAX_MANIFEST_BYTES, reportFromManifest } from "../../../src/report/preview-manifest";
export type PreviewEnvironment = {
/** Lowercase base32 path token the review comment links to. */
EXPLORE_PREVIEW_TOKEN?: string | undefined;
/** Base64 32-byte AES-GCM key. */
EXPLORE_PREVIEW_KEY?: string | undefined;
/** ISO 8601 instant after which the report routes answer 410 and the token page says the link expired; unset: never. */
EXPLORE_PREVIEW_EXPIRES_AT?: string | undefined;
/** Absolute path of the encrypted report inside this deployment, e.g. /_report/<id>/report.zip.enc (single-report deployments). */
/** Path of the report's manifest inside this deployment, `/p/<token>/targets/report.json` (single-report deployments). */
EXPLORE_PREVIEW_REPORT?: string | undefined;
/**
* JSON, one entry per capture target in config order:
* `[{"target":"duo-open","platform":"ios","label":"iPhone Duo (open)","path":"/_report/<id>/duo-open.zip.enc","changes":3,"device":"iPhone Duo 26.0"}]`.
* Deployments from before targets list `{"platform":"ios","path":"/_report/<id>/ios.zip.enc",…}`: the target is the platform.
* `[{"target":"duo-open","platform":"ios","label":"iPhone Duo (open)","path":"/p/<token>/targets/duo-open.json","changes":3,"device":"iPhone Duo 26.0"}]`.
* Deployments from before targets list `{"platform":"ios","path":"/p/<token>/targets/ios.json",…}`: the target is the platform.
* Set instead of EXPLORE_PREVIEW_REPORT by deployments that serve several reports (or one that is not iOS).
*/
EXPLORE_PREVIEW_REPORTS?: string | undefined;
};
export type PreviewPlatform = "ios" | "android";
/** `target` names the report (and its file, `<target>.zip.enc`); `platform` is the device's. */
/** `target` names the report (and its manifest, `targets/<target>.json`); `platform` is the device's. */
export type PreviewReport = { target: string; platform: PreviewPlatform; label?: string; path: string; changes?: number; device?: string };
export type PreviewConfig = { token: string; key: Uint8Array<ArrayBuffer>; expiresAt: number | null; reports: PreviewReport[] };
export type PreviewConfig = { token: string; reports: PreviewReport[] };
export const PREVIEW_TOKEN = /^[a-z2-7]{32}$/;
/** A capture target id, as the CLI's isTargetId accepts it: the Worker does not bundle the config reader. */
@@ -37,20 +34,26 @@ const TARGET_ID = /^[a-z][a-z0-9-]{0,31}$/;
export function isPreviewTargetId(value: unknown): value is string {
return typeof value === "string" && TARGET_ID.test(value) && !["base", "head", "report"].includes(value) && !value.startsWith("install-");
}
const REPORT_PATH = /^\/_report\/[a-z2-7]{16,64}\/(report|[a-z][a-z0-9-]{0,31})\.zip\.enc$/;
const REPORT_PATH = /^\/p\/([a-z2-7]{32})\/targets\/(report|[a-z][a-z0-9-]{0,31})\.json$/;
const PLATFORMS: readonly PreviewPlatform[] = ["ios", "android"];
/** As many targets as a config may name. */
export const MAX_PREVIEW_REPORTS = 8;
const PLAIN_TEXT = /[\u0000-\u001f\u007f<>[\]]/;
/** The target a manifest path names, when it is a manifest of this token's deployment. */
function pathTarget(path: unknown, token: string): string | undefined {
const match = typeof path === "string" ? REPORT_PATH.exec(path) : null;
return match && match[1] === token ? match[2] : undefined;
}
/**
* The report list, strictly shaped: an unknown platform, an invalid or repeated target, a path that is not
* `<target>.zip.enc`, an odd label or device, or extra keys reject the whole configuration.
* The report list, strictly shaped: an unknown platform, an invalid or repeated target, a path that is not this token's
* `targets/<target>.json`, an odd label or device, or extra keys reject the whole configuration.
*/
function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
function parseReports(env: PreviewEnvironment, token: string): PreviewReport[] | undefined {
if (env.EXPLORE_PREVIEW_REPORTS === undefined) {
const reportPath = env.EXPLORE_PREVIEW_REPORT ?? "";
return REPORT_PATH.test(reportPath) ? [{ target: "ios", platform: "ios", path: reportPath }] : undefined;
return pathTarget(reportPath, token) === "report" ? [{ target: "ios", platform: "ios", path: reportPath }] : undefined;
}
if (env.EXPLORE_PREVIEW_REPORT !== undefined || env.EXPLORE_PREVIEW_REPORTS.length > 8192) return undefined;
let parsed: unknown;
@@ -63,7 +66,7 @@ function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
// Listings from before targets name each report by its platform.
const { target = platform, ...extra } = rest;
if (Object.keys(extra).length || !PLATFORMS.includes(platform as PreviewPlatform) || !isPreviewTargetId(target)) return undefined;
if (typeof path !== "string" || REPORT_PATH.exec(path)?.[1] !== target) return undefined;
if (typeof path !== "string" || pathTarget(path, token) !== target) return undefined;
if (changes !== undefined && (typeof changes !== "number" || !Number.isInteger(changes) || changes < 0 || changes > 100_000)) return undefined;
if (device !== undefined && (typeof device !== "string" || device.length > 120 || PLAIN_TEXT.test(device))) return undefined;
if (label !== undefined && (typeof label !== "string" || !label.trim() || label.length > 80 || PLAIN_TEXT.test(label))) return undefined;
@@ -73,28 +76,13 @@ function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
}
return reports;
}
/** 12-byte IV followed by the AES-GCM ciphertext and tag; `aad` binds the bytes to this format. */
export const PREVIEW_CIPHER = { ivBytes: 12, aad: "expo-explore-preview/1" } as const;
const MAX_REPORT_BYTES = 256 * 1024 * 1024;
function decodeBase64(value: string): Uint8Array<ArrayBuffer> | undefined {
if (!/^[A-Za-z0-9+/]+={0,2}$/.test(value)) return undefined;
try {
const binary = atob(value);
const bytes = new Uint8Array(binary.length);
for (let index = 0; index < binary.length; index += 1) bytes[index] = binary.charCodeAt(index);
return bytes;
} catch { return undefined; }
}
/** The deployment's sealed configuration, or undefined when any value is missing or malformed. */
/** The deployment's configuration, or undefined when any value is missing or malformed. */
export function previewConfig(env: PreviewEnvironment): PreviewConfig | undefined {
const token = env.EXPLORE_PREVIEW_TOKEN ?? "";
const key = decodeBase64(env.EXPLORE_PREVIEW_KEY ?? "");
const expiresAt = env.EXPLORE_PREVIEW_EXPIRES_AT === undefined ? null : Date.parse(env.EXPLORE_PREVIEW_EXPIRES_AT);
const reports = parseReports(env);
if (!PREVIEW_TOKEN.test(token) || !key || key.byteLength !== 32 || (expiresAt !== null && !Number.isFinite(expiresAt)) || !reports) return undefined;
return { token, key, expiresAt, reports };
if (!PREVIEW_TOKEN.test(token)) return undefined;
const reports = parseReports(env, token);
return reports ? { token, reports } : undefined;
}
function baseHeaders(contentType: string): Headers {
@@ -113,9 +101,11 @@ export function previewNotFound(): Response {
return new Response("Not found", { status: 404, headers: baseHeaders("text/plain; charset=utf-8") });
}
/** After the sealed expiry the token page still opens, and the report routes say so instead of serving. */
export function previewExpired(expiredAt: number): Response {
return new Response(JSON.stringify({ error: "expired", expiredAt: new Date(expiredAt).toISOString() }), { status: 410, headers: baseHeaders("application/json; charset=utf-8") });
/** A route whose static file could not be fetched this time; the same request works once it can, and the Viewer retries. */
function previewUnavailable(): Response {
const headers = baseHeaders("text/plain; charset=utf-8");
headers.set("Retry-After", "1");
return new Response("Unavailable", { status: 503, headers });
}
/** Constant-time comparison of two equal-length ASCII tokens. */
@@ -126,63 +116,38 @@ function sameToken(a: string, b: string): boolean {
return difference === 0;
}
/** A parsed manifest, kept so the shell and the agent API do not fetch and parse it on every request. */
type ParsedManifest = { bytes: Uint8Array; loaded: LoadedReport };
type ManifestResult = ParsedManifest | "unavailable" | undefined;
export type PreviewRequestOptions = {
env: PreviewEnvironment;
indexHtml: string;
now?: () => number;
/** Same-deployment fetch of static files; defaults to the global fetch. */
fetchImpl?: typeof fetch;
subtle?: SubtleCrypto;
/** Decrypted and parsed reports by path, least recently used first, within HELD_REPORT_BYTES; defaults to a module-level cache. */
cache?: Map<string, LoadedReport>;
/** Decrypts in flight by path, shared by the requests that wait for them; defaults to a module-level map. */
loading?: Map<string, Promise<LoadResult>>;
/** Reports too large to decrypt in this isolate, by path; defaults to a module-level set. */
oversized?: Set<string>;
/** Bytes of decrypted reports kept, and of kept reports plus one decrypt; default to HELD_REPORT_BYTES and DECRYPT_PEAK_BYTES. */
budget?: { held: number; peak: number };
/** Manifest bodies by path, kept for the life of the isolate; defaults to a module-level cache. */
manifests?: Map<string, string>;
/** Parsed manifests by path, least recently used first, within MANIFEST_CACHE_BYTES; defaults to a module-level cache. */
cache?: Map<string, ParsedManifest>;
/** Manifest fetches in flight by path, shared by the requests waiting for them; defaults to a module-level map. */
loading?: Map<string, Promise<ManifestResult>>;
};
const ROUTE = /^\/p\/([a-z2-7]{32})(?:\/|\/(report\.zip|reports\.json|manifest\.json|llms\.txt)|(\/api\/v1(?:\/[A-Za-z0-9._:@-]{1,200}){0,2}\/?)|\/assets\/([a-f0-9]{64}\.(?:png|jpg|mp4)))?$/;
/**
* Content-addressed and token-gated: this browser may keep an asset until the link expires, and for a week at most (as
* long as the Viewer kept a whole report in Cache Storage before assets were served one by one); shared caches may not.
*/
const MAX_ASSET_AGE_SECONDS = 7 * 24 * 60 * 60;
function assetCacheControl(expiresAt: number | null, now: number): string {
const untilExpiry = expiresAt === null ? MAX_ASSET_AGE_SECONDS : Math.floor((expiresAt - now) / 1000);
return `private, max-age=${Math.max(0, Math.min(MAX_ASSET_AGE_SECONDS, untilExpiry))}, immutable`;
}
/**
* An isolate has 128 MB. It keeps decrypted reports, least recently used first, within HELD_REPORT_BYTES, and every
* target's manifest (a few MB each at most). Decrypting needs the ciphertext and the plaintext at once, so decrypts run
* one at a time, and before each one older reports go until the two fit in DECRYPT_PEAK_BYTES with what is kept. A
* report too large to keep is decrypted for each request; one too large to decrypt (about 45 MB) answers 413, and the
* isolate remembers it so it does not fetch it again.
*/
const HELD_REPORT_BYTES = 60 * 1024 * 1024;
const DECRYPT_PEAK_BYTES = 90 * 1024 * 1024;
/** A decrypted report, or why there is none: "unavailable" this time (the Viewer retries), "too-large" for this isolate, undefined never. */
type LoadResult = LoadedReport | "unavailable" | "too-large" | undefined;
const reportCache = new Map<string, LoadedReport>();
const reportLoading = new Map<string, Promise<LoadResult>>();
const manifestCache = new Map<string, string>();
const oversizedReports = new Set<string>();
let decrypting: Promise<unknown> = Promise.resolve();
const ROUTE = /^\/p\/([a-z2-7]{32})(?:\/|\/(reports\.json|manifest\.json|llms\.txt)|(\/api\/v1(?:\/[A-Za-z0-9._:@-]{1,200}){0,2}\/?))?$/;
/** Parsed manifests are kept within this much of the isolate's 128 MB. */
const MANIFEST_CACHE_BYTES = 32 * 1024 * 1024;
/** What a kept manifest holds: its bytes, and its parsed metadata at about 1.6 times their size. */
const heldBytes = (manifest: ParsedManifest) => 3 * manifest.bytes.byteLength;
const manifestCache = new Map<string, ParsedManifest>();
const manifestLoading = new Map<string, Promise<ManifestResult>>();
/**
* `GET /p/<token>` serves the Viewer shell to browsers and the report's Markdown index to anything
* that does not ask for HTML (agents fetch with `Accept: text/markdown` or `*​/*`); the shell itself
* carries that index as text inside `#root` until the Viewer hydrates, and a `Link` header names the
* JSON API. `GET /p/<token>/report.zip` streams the decrypted report (`?target=`, or `?platform=` in older
* JSON API. `GET /p/<token>/manifest.json` answers one target's manifest (`?target=`, or `?platform=` in older
* links, selects one of several; the first listed otherwise), `GET /p/<token>/reports.json` lists the targets the
* deployment serves, `GET /p/<token>/llms.txt` is the Markdown index, and `GET /p/<token>/api/v1/...`
* answers the agent API (see agent-api.ts). Every other method, path, or token is an identical 404,
* so the response never confirms that a deployment or token exists. After the sealed expiry the exact
* token still opens the Viewer shell, and the report routes answer 410 with the expiry instant, so the
* Viewer can say the link expired rather than guess.
* answers the agent API (see agent-api.ts). Screenshots are static files the Worker never sees. Every other method,
* path, or token is an identical 404, so the response never confirms that a deployment or token exists.
*/
export async function previewResponse(request: Request, options: PreviewRequestOptions): Promise<Response> {
const config = previewConfig(options.env);
@@ -191,8 +156,7 @@ export async function previewResponse(request: Request, options: PreviewRequestO
const url = new URL(request.url);
const match = ROUTE.exec(url.pathname);
if (!match || !sameToken(match[1]!, config.token)) return previewNotFound();
const route = match[2] ?? (match[3] ? "api" : match[4] ? "asset" : undefined);
const expired = config.expiresAt !== null && (options.now ?? Date.now)() >= config.expiresAt;
const route = match[2] ?? (match[3] ? "api" : undefined);
const pageUrl = `${url.origin}/p/${config.token}`;
const linkHeader = `<${pageUrl}/api/${AGENT_API_VERSION}>; rel="alternate"; type="application/json", <${pageUrl}/llms.txt>; rel="alternate"; type="text/markdown"`;
const accept = request.headers.get("accept");
@@ -200,50 +164,37 @@ export async function previewResponse(request: Request, options: PreviewRequestO
const headers = baseHeaders("text/html; charset=utf-8");
headers.set("Link", linkHeader);
headers.set("Vary", "Accept");
if (expired) return new Response(options.indexHtml, { headers });
const selected = selectReport(config, url);
const loaded = await loadedReport(url.origin, selected, config, options);
if (!loaded || typeof loaded === "string") return new Response(options.indexHtml, { headers });
const shell = shellWithIndex(options.indexHtml, agentIndexHtml(agentContext(pageUrl, config, loaded.report), loaded.loaded));
const manifest = selected ? await parsedManifest(url.origin, selected, options) : undefined;
if (!selected || !manifest || manifest === "unavailable") return new Response(options.indexHtml, { headers });
const shell = shellWithIndex(options.indexHtml, agentIndexHtml(agentContext(pageUrl, config, selected), manifest.loaded));
// The same URL the Viewer will fetch for this page: its target's query when the link names one, none otherwise.
const requested = url.searchParams.get("target") ?? url.searchParams.get("platform");
return new Response(shellWithPreload(shell, `/p/${config.token}/manifest.json${requested ? `?${targetQuery(requested)}` : ""}`), { headers });
}
if (expired) return previewExpired(config.expiresAt!);
if (route === "reports.json") {
const body = JSON.stringify(config.reports.map(({ path: _path, ...report }) => report));
return new Response(body, { headers: baseHeaders("application/json; charset=utf-8") });
}
const report = selectReport(config, url);
if (!report) return previewNotFound();
if (route === "report.zip") return decryptedReport(url.origin, report.path, config, options);
if (route === "manifest.json") {
const body = await manifestFor(url.origin, report, config, options);
if (body === "unavailable") return previewUnavailable();
if (body === "too-large") return previewTooLarge();
return body === undefined ? previewNotFound() : new Response(body, { headers: baseHeaders("application/json; charset=utf-8") });
}
const found = await loadedReport(url.origin, report, config, options);
// The token and the target are right, so a report that cannot be read this time is the Worker's failure, and the Viewer retries.
if (found === "unavailable" && route === "asset") return previewUnavailable();
if (found === "too-large" && route === "asset") return previewTooLarge();
const loaded = typeof found === "string" ? undefined : found;
if (!loaded) {
if (route !== undefined) return previewNotFound();
if (route === "manifest.json") return manifestResponse(url.origin, report, options);
const manifest = await parsedManifest(url.origin, report, options);
if (!manifest || manifest === "unavailable") {
if (route !== undefined) return manifest === "unavailable" ? previewUnavailable() : previewNotFound();
const headers = baseHeaders("text/html; charset=utf-8");
headers.set("Link", linkHeader);
headers.set("Vary", "Accept");
return new Response(options.indexHtml, { headers });
}
if (route === "asset") return assetResponse(loaded.loaded, match[4]!, assetCacheControl(config.expiresAt, (options.now ?? Date.now)()));
const context = agentContext(pageUrl, config, report);
if (route === undefined || route === "llms.txt") {
const headers = baseHeaders("text/markdown; charset=utf-8");
headers.set("Link", linkHeader);
headers.set("Vary", "Accept");
return new Response(agentIndexMarkdown(context, loaded.loaded), { headers });
return new Response(agentIndexMarkdown(context, manifest.loaded), { headers });
}
const reply = await agentApiReply(context, loaded.loaded, match[3]!.slice("/api/v1".length).replace(/\/$/, ""), url.searchParams, accept);
const reply = await agentApiReply(context, manifest.loaded, match[3]!.slice("/api/v1".length).replace(/\/$/, ""), url.searchParams, accept);
const headers = baseHeaders(reply.contentType);
headers.set("Vary", "Accept");
for (const [key, value] of Object.entries(reply.headers ?? {})) headers.set(key, value);
@@ -265,7 +216,8 @@ export function selectReport(config: PreviewConfig, url: URL): PreviewReport | u
function agentContext(pageUrl: string, config: PreviewConfig, report: PreviewReport): AgentContext {
return { pageUrl, platform: report.platform, platforms: [...new Set(config.reports.map(entry => entry.platform))], target: report.target,
targets: config.reports.map(entry => ({ id: entry.target, platform: entry.platform, label: entry.label ?? (entry.target === entry.platform ? PLATFORM_LABELS[entry.platform] : entry.target) })),
expiresAt: config.expiresAt === null ? null : new Date(config.expiresAt).toISOString() };
// A hosted preview lasts as long as its EAS Hosting deployment; Explore sets no expiry of its own.
expiresAt: null };
}
const PLATFORM_LABELS: Record<PreviewPlatform, string> = { ios: "iOS", android: "Android" };
@@ -284,42 +236,6 @@ export function shellWithPreload(indexHtml: string, manifestPath: string): strin
return at === -1 ? indexHtml : `${indexHtml.slice(0, at)}${link}${indexHtml.slice(at)}`;
}
/** The manifest of one target: kept once built, from the isolate's copy of the report or from one it decrypts and lets go. */
async function manifestFor(origin: string, report: PreviewReport, config: PreviewConfig, options: PreviewRequestOptions): Promise<string | "unavailable" | "too-large" | undefined> {
const manifests = options.manifests ?? manifestCache;
const key = `${origin}${report.path}`;
const known = manifests.get(key);
if (known !== undefined) return known;
const loaded = await loadedReport(origin, report, config, options, { keep: false });
if (!loaded || typeof loaded === "string") return loaded;
const body = manifestBody(loaded.loaded);
manifests.set(key, body);
return body;
}
/** A report route that could not read the report this time; the same token and target work once it can. */
function previewUnavailable(): Response {
const headers = baseHeaders("text/plain; charset=utf-8");
headers.set("Retry-After", "1");
return new Response("Unavailable", { status: 503, headers });
}
/** A report this Worker cannot decrypt in an isolate's memory; it never will, so the Viewer says so instead of retrying. */
function previewTooLarge(): Response {
return new Response(JSON.stringify({ error: "too-large" }), { status: 413, headers: baseHeaders("application/json; charset=utf-8") });
}
/** One asset of the report, inflated from the decrypted ZIP the isolate holds. */
async function assetResponse(loaded: LoadedReport, file: string, cacheControl: string): Promise<Response> {
const asset = await previewAsset(loaded, `assets/${file}`);
if (!asset) return previewNotFound();
const headers = baseHeaders(asset.type);
headers.set("Cache-Control", cacheControl);
headers.set("Content-Length", String(asset.bytes.byteLength));
headers.set("ETag", `"${file.slice(0, 64)}"`);
return new Response(asset.bytes as BodyInit, { headers });
}
/** The agent index as the shell's initial `#root` content; the Viewer replaces it when it renders. */
export function shellWithIndex(indexHtml: string, indexBlock: string): string {
const root = '<div id="root"></div>';
@@ -329,107 +245,88 @@ export function shellWithIndex(indexHtml: string, indexBlock: string): string {
}
/**
* A report decrypted and parsed, from the isolate's cache or decrypted now; requests for one that is decrypting wait for
* that decrypt. `keep: false` (a manifest) does not keep a report that is not cached already.
* One target's manifest for the Viewer. A kept one is answered from memory; otherwise the static file streams through
* unparsed, so a prefetch of every target costs the isolate almost no CPU.
*/
async function loadedReport(origin: string, report: PreviewReport | undefined, config: PreviewConfig, options: PreviewRequestOptions,
{ keep = true }: { keep?: boolean } = {}): Promise<{ report: PreviewReport; loaded: LoadedReport } | "unavailable" | "too-large" | undefined> {
if (!report) return undefined;
const cache = options.cache ?? reportCache;
const loading = options.loading ?? reportLoading;
async function manifestResponse(origin: string, report: PreviewReport, options: PreviewRequestOptions): Promise<Response> {
const headers = baseHeaders("application/json; charset=utf-8");
const kept = (options.cache ?? manifestCache).get(`${origin}${report.path}`);
if (kept) return new Response(kept.bytes as BodyInit, { headers });
const upstream = await staticFile(origin, report.path, options);
if (upstream === "unavailable") return previewUnavailable();
if (!upstream) return previewNotFound();
return new Response(upstream.body, { headers });
}
/** A static file of this deployment: "unavailable" when it cannot be fetched now, undefined when it is not there. */
async function staticFile(origin: string, path: string, options: PreviewRequestOptions): Promise<Response | "unavailable" | undefined> {
let upstream: Response;
try { upstream = await (options.fetchImpl ?? fetch)(new URL(path, origin).href); }
catch { return "unavailable"; }
if (upstream.status >= 500) return "unavailable";
if (upstream.status !== 200 || !upstream.body) {
await upstream.body?.cancel();
return undefined;
}
return upstream;
}
/** At most `limit` bytes of a response, or undefined when it has more. */
async function bodyBytes(response: Response, limit: number): Promise<Uint8Array | undefined> {
const declared = Number(response.headers.get("content-length") ?? "0");
if (declared > limit) {
await response.body?.cancel();
return undefined;
}
const bytes = new Uint8Array(await response.arrayBuffer());
return bytes.byteLength > limit ? undefined : bytes;
}
/** One target's manifest, parsed: from the isolate's cache, or fetched now (requests that arrive together share one fetch). */
async function parsedManifest(origin: string, report: PreviewReport, options: PreviewRequestOptions): Promise<ManifestResult> {
const cache = options.cache ?? manifestCache;
const loading = options.loading ?? manifestLoading;
const key = `${origin}${report.path}`;
const oversized = options.oversized ?? oversizedReports;
if (oversized.has(key)) return "too-large";
const cached = cache.get(key);
if (cached) {
// Most recently used last, so the oldest is the first to go.
cache.delete(key);
cache.set(key, cached);
return { report, loaded: cached };
return cached;
}
let pending = loading.get(key);
if (!pending) {
pending = oneAtATime(() => decryptedBytes(origin, report.path, config, options, sealed => makeRoom(cache, 2 * sealed, peak(options))))
.then<LoadResult, LoadResult>(bytes => (bytes instanceof Uint8Array ? loadReport(bytes) : bytes), () => "unavailable");
pending = fetchManifest(origin, report, options).catch(() => "unavailable" as const);
loading.set(key, pending);
void pending.finally(() => { if (loading.get(key) === pending) loading.delete(key); });
}
const loaded = await pending;
if (loaded === "too-large") oversized.add(key);
if (!loaded || typeof loaded === "string") return loaded;
const held = options.budget?.held ?? HELD_REPORT_BYTES;
if (keep && !cache.has(key) && loaded.zip.byteLength <= held) {
makeRoom(cache, loaded.zip.byteLength, held);
cache.set(key, loaded);
const parsed = await pending;
if (parsed && parsed !== "unavailable" && !cache.has(key) && heldBytes(parsed) <= MANIFEST_CACHE_BYTES) {
let held = heldBytes(parsed);
for (const kept of cache.values()) held += heldBytes(kept);
for (const [oldest, kept] of cache) {
if (held <= MANIFEST_CACHE_BYTES) break;
cache.delete(oldest);
held -= heldBytes(kept);
}
cache.set(key, parsed);
}
return { report, loaded };
return parsed;
}
/** Lets the oldest kept reports go until `bytes` more fit beside the rest within `budget`; false when they never can. */
function makeRoom(cache: Map<string, LoadedReport>, bytes: number, budget: number): boolean {
if (bytes > budget) return false;
let held = 0;
for (const loaded of cache.values()) held += loaded.zip.byteLength;
for (const [oldest, loaded] of cache) {
if (held + bytes <= budget) break;
cache.delete(oldest);
held -= loaded.zip.byteLength;
}
return true;
}
function peak(options: PreviewRequestOptions): number {
return options.budget?.peak ?? DECRYPT_PEAK_BYTES;
}
/** Decrypts run one after another, so two of them never need their ciphertext and plaintext at once. */
function oneAtATime<T>(task: () => Promise<T>): Promise<T> {
const run = decrypting.then(task, task);
decrypting = run.catch(() => undefined);
return run;
}
/**
* The report's ZIP, decrypted: "unavailable" when its file cannot be fetched now, "too-large" when `reserve` cannot make
* room to decrypt it, undefined when the file is missing or does not decrypt.
*/
async function decryptedBytes(origin: string, reportPath: string, config: PreviewConfig, options: PreviewRequestOptions,
reserve: (sealedBytes: number) => boolean = () => true): Promise<Uint8Array | "unavailable" | "too-large" | undefined> {
const fetchImpl = options.fetchImpl ?? fetch;
const subtle = options.subtle ?? crypto.subtle;
let upstream: Response;
try { upstream = await fetchImpl(new URL(reportPath, origin).href, { headers: { accept: "application/octet-stream" } }); }
catch { return "unavailable"; }
if (upstream.status >= 500) return "unavailable";
if (upstream.status !== 200 || !upstream.body) return undefined;
const declared = Number(upstream.headers.get("content-length") ?? "0");
if (declared > MAX_REPORT_BYTES + PREVIEW_CIPHER.ivBytes + 16) return undefined;
if (declared && !reserve(declared)) {
await upstream.body.cancel();
return "too-large";
}
const sealed = new Uint8Array(await upstream.arrayBuffer());
if (sealed.byteLength <= PREVIEW_CIPHER.ivBytes + 16 || sealed.byteLength > MAX_REPORT_BYTES + PREVIEW_CIPHER.ivBytes + 16) return undefined;
if (!declared && !reserve(sealed.byteLength)) return "too-large";
try {
const key = await subtle.importKey("raw", config.key, "AES-GCM", false, ["decrypt"]);
return new Uint8Array(await subtle.decrypt(
{ name: "AES-GCM", iv: sealed.subarray(0, PREVIEW_CIPHER.ivBytes), additionalData: new TextEncoder().encode(PREVIEW_CIPHER.aad) },
key, sealed.subarray(PREVIEW_CIPHER.ivBytes)));
} catch { return undefined; }
}
/** The whole decrypted ZIP (downloads, older Viewers), decrypted in turn and within the same budget as every other decrypt. */
async function decryptedReport(origin: string, reportPath: string, config: PreviewConfig, options: PreviewRequestOptions): Promise<Response> {
const cache = options.cache ?? reportCache;
const plain = await oneAtATime(() => decryptedBytes(origin, reportPath, config, options, sealed => makeRoom(cache, 2 * sealed, peak(options))));
if (plain === "unavailable") return previewUnavailable();
if (plain === "too-large") return previewTooLarge();
if (!plain) return previewNotFound();
const headers = baseHeaders("application/zip");
headers.set("Content-Length", String(plain.byteLength));
headers.set("Content-Disposition", 'inline; filename="report.zip"');
return new Response(plain as BodyInit, { headers });
async function fetchManifest(origin: string, report: PreviewReport, options: PreviewRequestOptions): Promise<ManifestResult> {
const upstream = await staticFile(origin, report.path, options);
if (!upstream || upstream === "unavailable") return upstream;
const bytes = await bodyBytes(upstream, MAX_MANIFEST_BYTES);
if (!bytes) return undefined;
// The agent API reads screenshots from the same static files the Viewer does, next to the manifest's target directory.
const base = new URL(report.path.replace(/\/targets\/[^/]+$/, "/"), origin);
const loaded = reportFromManifest(bytes, async (name, limit) => {
const asset = await staticFile(origin, new URL(name, base).pathname, options);
if (asset === "unavailable") throw new Error(`${name} is unavailable`);
return asset ? bodyBytes(asset, Math.min(limit, MAX_ASSET_BYTES)) : undefined;
});
return loaded ? { bytes, loaded } : undefined;
}
/** Requests the Viewer shell never issues; identical to the token-less answer. */
+116 -126
View File
@@ -1,27 +1,18 @@
import assert from "node:assert/strict";
import test from "node:test";
import { webcrypto, createHash } from "node:crypto";
import { createHash } from "node:crypto";
import { deflateRawSync } from "node:zlib";
import { readFileSync } from "node:fs";
import { PREVIEW_CIPHER, previewResponse, type PreviewEnvironment } from "../src/server/preview";
import { previewResponse, type PreviewEnvironment } from "../src/server/preview";
import { agentApiReply, agentIndexMarkdown, loadReport, prefersHtml, prefersMarkdown } from "../../src/report/agent-api";
import { manifestBody, MAX_MANIFEST_BYTES, reportFromManifest } from "../../src/report/preview-manifest";
import { readZipDirectory } from "../../src/report/zip-reader";
const subtle = webcrypto.subtle as SubtleCrypto;
const token = "abcdefghijklmnopqrstuvwxyz234567";
const origin = "https://acme-explore--k7f3z0d1q8.expo.app";
const html = '<!doctype html><html><body><div id="root"></div><script type="module" src="/viewer/assets/main.js"></script></body></html>';
const keyBytes: Uint8Array<ArrayBuffer> = webcrypto.getRandomValues(new Uint8Array(32));
const review = new Uint8Array(readFileSync(new URL("../../test/fixtures/example-review-artifact.zip", import.meta.url))) as Uint8Array<ArrayBuffer>;
async function sealed(plain: Uint8Array<ArrayBuffer>): Promise<Uint8Array<ArrayBuffer>> {
const key = await subtle.importKey("raw", keyBytes, "AES-GCM", false, ["encrypt"]);
const iv = webcrypto.getRandomValues(new Uint8Array(PREVIEW_CIPHER.ivBytes));
const cipher = new Uint8Array(await subtle.encrypt({ name: "AES-GCM", iv, additionalData: new TextEncoder().encode(PREVIEW_CIPHER.aad) }, key, plain));
const out = new Uint8Array(iv.byteLength + cipher.byteLength);
out.set(iv); out.set(cipher, iv.byteLength);
return out;
}
/** A ZIP the way zipReportDirectory writes one: the JSON deflated, PNGs stored. */
function zip(files: Record<string, Uint8Array>): Uint8Array<ArrayBuffer> {
@@ -74,19 +65,26 @@ const explorationReport = {
};
const explorationZip = zip({ "exploration.json": new TextEncoder().encode(JSON.stringify(explorationReport)), [`assets/${pngSha}.png`]: png });
function deployment(files: Record<string, Uint8Array<ArrayBuffer>>, env: PreviewEnvironment, now?: () => number, budget?: { held: number; peak: number }) {
/** A hosted preview as ci:deploy writes it: each target's manifest at its path, and every asset once under the token. */
async function deployment(reports: Record<string, Uint8Array>, env: PreviewEnvironment) {
const files: Record<string, Uint8Array> = {};
for (const [path, archive] of Object.entries(reports)) {
const loaded = (await loadReport(archive))!;
files[path] = new TextEncoder().encode(manifestBody(loaded));
for (const name of loaded.entries.keys()) if (name.startsWith("assets/") && !name.endsWith("/")) files[`/p/${token}/${name}`] = (await loaded.read(name, 64 * 1024 * 1024))!;
}
const calls: string[] = [];
const fetchImpl = (async (input: RequestInfo | URL) => {
const url = new URL(typeof input === "string" ? input : input instanceof URL ? input.href : input.url);
calls.push(url.href);
const body = files[url.pathname];
return body ? new Response(body, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
return body ? new Response(body as BodyInit, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
}) as typeof fetch;
const options = { env, indexHtml: html, fetchImpl, subtle, cache: new Map(), loading: new Map(), manifests: new Map(), oversized: new Set<string>(), ...(now ? { now } : {}), ...(budget ? { budget } : {}) };
return { calls, get: (path: string, accept?: string) => previewResponse(new Request(`${origin}/p/${token}${path}`, accept === undefined ? {} : { headers: { accept } }), options) };
const options = { env, indexHtml: html, fetchImpl, cache: new Map(), loading: new Map() };
return { calls, files, cache: options.cache, get: (path: string, accept?: string) => previewResponse(new Request(`${origin}/p/${token}${path}`, accept === undefined ? {} : { headers: { accept } }), options) };
}
const reviewEnv: PreviewEnvironment = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_KEY: Buffer.from(keyBytes).toString("base64"), EXPLORE_PREVIEW_EXPIRES_AT: "2030-01-01T00:00:00Z", EXPLORE_PREVIEW_REPORT: "/_report/abcdefghijklmnop/report.zip.enc" };
const reviewEnv: PreviewEnvironment = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/report.json` };
test("the archive reader accepts the deployed layout and rejects everything else", async () => {
assert.ok(readZipDirectory(review)?.has("review.json"));
@@ -98,7 +96,7 @@ test("the archive reader accepts the deployed layout and rejects everything else
});
test("the token page negotiates: browsers get the shell carrying the agent index, everything else gets Markdown", async () => {
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
const browser = await site.get("?view=compare&screen=home", "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8");
assert.equal(browser.status, 200);
assert.match(browser.headers.get("content-type") ?? "", /^text\/html/);
@@ -118,19 +116,19 @@ test("the token page negotiates: browsers get the shell carrying the agent index
assert.match(response.headers.get("content-type") ?? "", /^text\/markdown/, String(accept));
const body = await response.text();
assert.match(body, /^# Expo Explore report: /, String(accept));
assert.match(body, /This link stops serving the report after 2030-01-01T00:00:00.000Z/);
assert.ok(!body.includes("stops serving"), "a hosted preview lasts as long as its deployment; the index names no expiry");
assert.ok(body.includes(`(${origin}/p/${token}/api/v1/screens?status=modified,accessibility-only,added,removed)`), body);
assert.equal(response.headers.get("content-security-policy"), browser.headers.get("content-security-policy"));
}
const llms = await site.get("/llms.txt", "text/html");
assert.match(llms.headers.get("content-type") ?? "", /^text\/markdown/);
assert.equal(await llms.text(), await (await site.get("")).text());
// The sealed file is decrypted and parsed once per isolate, not once per request.
// The static manifest is fetched and parsed once per isolate, not once per request.
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`]);
});
test("the API serves a PR review: summary, filtered and paged screens, detail, transitions, assets, raw", async () => {
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
const summary = await (await site.get("/api/v1")).json();
assert.equal(summary.kind, "pr-review");
assert.equal(summary.contract, "explore.review");
@@ -198,12 +196,15 @@ test("the API serves a PR review: summary, filtered and paged screens, detail, t
const raw = await site.get("/api/v1/raw");
assert.equal(raw.status, 200);
assert.equal((await raw.json()).review.contract, "explore.review", "raw is the file as written, review nested under `review`");
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`]);
const rawBytes = new Uint8Array(await raw.arrayBuffer());
assert.deepEqual(rawBytes, (await loadReport(review))!.raw, "raw is review.json byte for byte, as the ZIP held it");
assert.equal(JSON.parse(new TextDecoder().decode(rawBytes)).review.contract, "explore.review");
// The manifest once, and the one screenshot asked for, read from the same static file the Viewer loads.
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`, `${origin}/p/${token}/assets/${sha}.png`]);
});
test("the API serves an exploration: screens with elements and transitions, journeys, gaps, frontier", async () => {
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(explorationZip) }, reviewEnv);
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: explorationZip }, reviewEnv);
const index = await (await site.get("")).text();
assert.match(index, /^# Expo Explore exploration: Euxy \(ios\)/);
assert.ok(index.includes("mapped 2 screens, 1 transitions, 1 elements; 1 coverage gaps. Stopped: budget. Mapped the sequencer."), index);
@@ -229,22 +230,9 @@ test("the API serves an exploration: screens with elements and transitions, jour
assert.deepEqual(await (await site.get("/api/v1/raw")).json(), explorationReport);
});
test("expiry, platforms and wrong tokens behave like the report routes", async () => {
const after = () => Date.parse("2030-01-01T00:00:00Z");
const expired = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv, after);
const shell = await expired.get("", "text/html");
assert.equal(shell.status, 200);
assert.equal(await shell.text(), html, "the expired shell carries no report data");
assert.equal((await expired.get("/api/v1/screens/", "text/html")).status, 410);
for (const path of ["", "/llms.txt", "/api/v1", "/api/v1/screens", `/api/v1/assets/${"a".repeat(64)}`]) {
const response = await expired.get(path);
assert.equal(response.status, 410, path);
assert.deepEqual(await response.json(), { error: "expired", expiredAt: "2030-01-01T00:00:00.000Z" });
}
assert.deepEqual(expired.calls, []);
const multiEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "ios", path: "/_report/abcdefghijklmnop/ios.zip.enc" }, { platform: "android", path: "/_report/abcdefghijklmnop/android.zip.enc" }]) };
const multi = deployment({ "/_report/abcdefghijklmnop/ios.zip.enc": await sealed(review), "/_report/abcdefghijklmnop/android.zip.enc": await sealed(explorationZip) }, multiEnv);
test("platforms and wrong tokens behave like the report routes", async () => {
const multiEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "ios", path: `/p/${token}/targets/ios.json` }, { platform: "android", path: `/p/${token}/targets/android.json` }]) };
const multi = await deployment({ [`/p/${token}/targets/ios.json`]: review, [`/p/${token}/targets/android.json`]: explorationZip }, multiEnv);
const ios = await (await multi.get("/api/v1")).json();
assert.equal(ios.kind, "pr-review");
assert.deepEqual(ios.platforms, ["ios", "android"]);
@@ -257,12 +245,12 @@ test("expiry, platforms and wrong tokens behave like the report routes", async (
assert.match(await (await multi.get("?platform=android")).text(), /^# Expo Explore exploration/);
assert.equal((await multi.get("/api/v1?platform=web")).status, 404);
assert.equal((await multi.get("/api/v1?platform=ios&platform=android")).status, 404);
assert.equal(multi.calls.length, 2, "each platform's report is decrypted once");
assert.equal(multi.calls.length, 2, "each platform's manifest is fetched once");
const wrongToken = token.replace(/a/, "b");
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
for (const path of [`/p/${wrongToken}/api/v1`, `/p/${wrongToken}/llms.txt`, `/p/${token}/API/v1`, `/p/${token}/api/v1//screens`]) {
const response = await previewResponse(new Request(`${origin}${path}`), { env: reviewEnv, indexHtml: html, fetchImpl: fetch, subtle, cache: new Map() });
const response = await previewResponse(new Request(`${origin}${path}`), { env: reviewEnv, indexHtml: html, fetchImpl: fetch, cache: new Map() });
assert.equal(response.status, 404, path);
}
assert.equal((await site.get("/api/v1", undefined)).status, 200);
@@ -337,12 +325,12 @@ test("statuses follow the Viewer: accessibility-only, unavailable for a failed o
test("a deployment of several targets keeps each target in its links and names the others in the index", async () => {
const listing = [
{ target: "iphone", platform: "ios", label: "iPhone 17", path: "/_report/abcdefghijklmnop/iphone.zip.enc" },
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: "/_report/abcdefghijklmnop/duo-open.zip.enc" },
{ target: "android", platform: "android", label: "Android", path: "/_report/abcdefghijklmnop/android.zip.enc" },
{ target: "iphone", platform: "ios", label: "iPhone 17", path: `/p/${token}/targets/iphone.json` },
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: `/p/${token}/targets/duo-open.json` },
{ target: "android", platform: "android", label: "Android", path: `/p/${token}/targets/android.json` },
];
const targetsEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
const site = deployment({ [listing[0]!.path]: await sealed(review), [listing[1]!.path]: await sealed(review), [listing[2]!.path]: await sealed(explorationZip) }, targetsEnv);
const site = await deployment({ [listing[0]!.path]: review, [listing[1]!.path]: review, [listing[2]!.path]: explorationZip }, targetsEnv);
const duo = await (await site.get("/api/v1?target=duo-open")).json();
assert.equal(duo.kind, "pr-review");
assert.deepEqual(duo.platforms, ["ios", "android"], "distinct platforms, as before targets");
@@ -364,9 +352,8 @@ test("a deployment of several targets keeps each target in its links and names t
assert.equal((await site.get("/api/v1?target=pixel")).status, 404);
});
test("the manifest and asset routes let the Viewer open a report before any screenshot, and the shell preloads the manifest", async () => {
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv);
const loaded = (await loadReport(review))!;
test("the manifest route answers each target's static manifest, the shell preloads it, and screenshots are not the Worker's", async () => {
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
const shell = await (await site.get("", "text/html")).text();
assert.ok(shell.includes(`<link rel="preload" href="/p/${token}/manifest.json" as="fetch" crossorigin><script type="module"`), shell.slice(0, 400));
const linked = await (await site.get("?target=ios&view=compare", "text/html")).text();
@@ -376,98 +363,101 @@ test("the manifest and asset routes let the Viewer open a report before any scre
assert.equal(manifest.status, 200);
assert.match(manifest.headers.get("content-type") ?? "", /^application\/json/);
assert.equal(manifest.headers.get("cache-control"), "private, no-store");
const body = await manifest.json() as { format: string; file: string; entries: Record<string, number>; report: { review: unknown } };
assert.equal(body.format, "explore.preview-manifest/1");
assert.equal(body.file, "review.json");
assert.deepEqual(body.report, JSON.parse(new TextDecoder().decode(loaded.raw)));
const assets = [...loaded.entries].filter(([name]) => name.startsWith("assets/"));
assert.ok(assets.length > 0);
assert.deepEqual(body.entries, Object.fromEntries(assets.map(([name, entry]) => [name, entry.size])));
assert.ok(!("review.json" in body.entries));
const [name, entry] = assets.find(([file]) => file.endsWith(".png"))!;
const asset = await site.get(`/${name}`);
assert.equal(asset.status, 200);
assert.equal(asset.headers.get("content-type"), "image/png");
// Kept by this browser for a week, and never past the link's expiry; never by a shared cache.
assert.equal(asset.headers.get("cache-control"), "private, max-age=604800, immutable");
const nearExpiry = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, reviewEnv, () => Date.parse("2029-12-31T23:59:00Z"));
assert.equal((await nearExpiry.get(`/${name}`)).headers.get("cache-control"), "private, max-age=60, immutable");
const never = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(review) }, { ...reviewEnv, EXPLORE_PREVIEW_EXPIRES_AT: undefined });
assert.equal((await never.get(`/${name}`)).headers.get("cache-control"), "private, max-age=604800, immutable");
assert.equal(asset.headers.get("content-length"), String(entry.size));
assert.equal(asset.headers.get("etag"), `"${name.slice("assets/".length, "assets/".length + 64)}"`);
const bytes = new Uint8Array(await asset.arrayBuffer());
assert.equal(bytes.byteLength, entry.size);
assert.equal(createHash("sha256").update(bytes).digest("hex"), name.slice("assets/".length, "assets/".length + 64));
for (const path of ["/assets/" + "0".repeat(64) + ".png", "/assets/" + name.slice("assets/".length, -4) + ".gif", "/assets/review.json", `/${name}/`, `/${name}?platform=android`]) {
assert.equal(await manifest.text(), new TextDecoder().decode(site.files[reviewEnv.EXPLORE_PREVIEW_REPORT!]), "the static manifest, byte for byte");
// Screenshots are static files EAS Hosting serves itself; a path the deployment does not hold is the Worker's 404.
for (const path of ["/assets/" + "0".repeat(64) + ".png", "/report.zip", "/targets/report.json"]) {
assert.equal((await site.get(path)).status, 404, path);
}
// The sealed file is still decrypted once per isolate.
assert.deepEqual(site.calls, [`${origin}${reviewEnv.EXPLORE_PREVIEW_REPORT}`]);
});
test("a ZIP's directory records are not assets: the manifest the Viewer validates names files only", async () => {
const withDirectory = zip({ "exploration.json": new TextEncoder().encode(JSON.stringify(explorationReport)), "assets/": new Uint8Array(), [`assets/${pngSha}.png`]: png });
assert.ok(readZipDirectory(withDirectory)!.has("assets/"));
const site = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: await sealed(withDirectory) }, reviewEnv);
const body = await (await site.get("/manifest.json")).json() as { entries: Record<string, number> };
assert.deepEqual(body.entries, { [`assets/${pngSha}.png`]: png.byteLength });
assert.deepEqual(JSON.parse(manifestBody((await loadReport(withDirectory))!)).entries, { [`assets/${pngSha}.png`]: png.byteLength });
assert.equal(JSON.parse(manifestBody((await loadReport(withDirectory))!, "abc")).deployment, "abc", "a deployment stamps the manifests it writes");
});
test("a report the Worker cannot fetch this time answers 503, which the Viewer retries; one that never decrypts is a 404", async () => {
const flaky = { get: (path: string) => previewResponse(new Request(`${origin}/p/${token}${path}`), {
env: reviewEnv, indexHtml: html, subtle, cache: new Map(), loading: new Map(), manifests: new Map(),
fetchImpl: (async () => new Response("upstream", { status: 502 })) as typeof fetch }) };
for (const path of ["/manifest.json", `/assets/${pngSha}.png`, "/report.zip"]) {
const response = await flaky.get(path);
test("a static file the Worker cannot fetch this time answers 503, which the Viewer retries; one that is not there is a 404", async () => {
const flaky = (status: number) => (path: string) => previewResponse(new Request(`${origin}/p/${token}${path}`), {
env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(), fetchImpl: (async () => new Response("upstream", { status })) as typeof fetch });
for (const path of ["/manifest.json", "/api/v1", "/llms.txt"]) {
const response = await flaky(502)(path);
assert.equal(response.status, 503, path);
assert.equal(response.headers.get("retry-after"), "1");
assert.equal(response.headers.get("cache-control"), "private, no-store");
assert.equal((await flaky(404)(path)).status, 404, path);
}
const garbage = deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: new Uint8Array(64) as Uint8Array<ArrayBuffer> }, reviewEnv);
for (const path of ["/manifest.json", `/assets/${pngSha}.png`, "/report.zip"]) assert.equal((await garbage.get(path)).status, 404, path);
// A wrong token or an unknown target is still the same 404 as any other path.
assert.equal((await garbage.get("/manifest.json?target=pixel")).status, 404);
// The shell still opens; the Viewer then asks for the manifest and shows why it cannot.
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { headers: { accept: "text/html" } }), {
env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(), fetchImpl: (async () => new Response("upstream", { status: 502 })) as typeof fetch })).status, 200);
const garbage = { env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(),
fetchImpl: (async () => new Response("not a manifest", { status: 200 })) as typeof fetch };
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/api/v1`), garbage)).status, 404, "a file that is not a manifest of a report");
});
test("an isolate keeps decrypted reports within its byte budget, decrypts one at a time, and shares a decrypt between requests", async () => {
const listing = ["iphone", "duo-open", "duo-closed"].map(target => ({ target, platform: "ios", label: target, path: `/_report/abcdefghijklmnop/${target}.zip.enc` }));
test("the shell and the agent API share one fetch of a manifest, kept within the cache's bytes; the manifest route only passes it through", async () => {
const listing = ["iphone", "duo-open"].map(target => ({ target, platform: "ios", label: target, path: `/p/${token}/targets/${target}.json` }));
const env: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
const size = explorationZip.byteLength;
// Room to keep two reports, and to decrypt one beside them.
const site = deployment(Object.fromEntries(await Promise.all(listing.map(async entry => [entry.path, await sealed(explorationZip)] as const))), env,
undefined, { held: 2 * size, peak: 4 * size + 64 });
const decrypts = () => site.calls.length;
// The prefetch: every target's manifest, each report decrypted once and let go.
for (const { target } of listing) assert.equal((await site.get(`/manifest.json?target=${target}`)).status, 200);
assert.equal(decrypts(), 3);
for (const { target } of listing) await site.get(`/manifest.json?target=${target}`);
assert.equal(decrypts(), 3, "manifests are kept");
const asset = (target: string) => site.get(`/assets/${pngSha}.png?target=${target}`).then(response => response.status);
// Requests that arrive together wait for one decrypt.
assert.deepEqual(await Promise.all([asset("iphone"), asset("iphone"), asset("iphone")]), [200, 200, 200]);
assert.equal(decrypts(), 4, "the report a reviewer looks at is kept");
assert.equal(await asset("duo-open"), 200);
assert.equal(await asset("iphone"), 200);
assert.equal(decrypts(), 5);
assert.equal(await asset("duo-closed"), 200);
assert.equal(decrypts(), 6, "a third report evicts the least recently used, duo-open");
assert.equal(await asset("iphone"), 200);
assert.equal(decrypts(), 6);
assert.equal(await asset("duo-open"), 200);
assert.equal(decrypts(), 7);
const site = await deployment(Object.fromEntries(listing.map(entry => [entry.path, explorationZip])), env);
// Requests that arrive together wait for one fetch.
assert.deepEqual((await Promise.all([site.get("/api/v1?target=iphone"), site.get("/llms.txt?target=iphone"), site.get("?target=iphone", "text/html")])).map(response => response.status), [200, 200, 200]);
assert.equal(site.calls.length, 1);
// Kept now, so the Viewer's manifest request is answered from memory.
assert.equal((await site.get("/manifest.json?target=iphone")).status, 200);
assert.equal(site.calls.length, 1);
// Not kept (a prefetch of another target): streamed through each time, never parsed.
assert.equal((await site.get("/manifest.json?target=duo-open")).status, 200);
assert.equal((await site.get("/manifest.json?target=duo-open")).status, 200);
assert.equal(site.calls.length, 3);
});
// A report larger than the budget keeps is decrypted for each request; one too large to decrypt is unavailable.
const perRequest = deployment({ [listing[0]!.path]: await sealed(explorationZip) }, env, undefined, { held: size - 1, peak: 4 * size });
for (let request = 1; request <= 3; request++) {
assert.equal(await perRequest.get(`/assets/${pngSha}.png?target=iphone`).then(response => response.status), 200);
assert.equal(perRequest.calls.length, request);
test("a manifest is parsed once and keeps the report's own bytes; another key order still opens; one the Viewer would refuse does not", async () => {
const loaded = (await loadReport(review))!;
const read = async () => undefined;
const written = new TextEncoder().encode(manifestBody(loaded, "stamp"));
const parsed = reportFromManifest(written, read)!;
assert.equal(parsed.kind, "pr-review");
assert.deepEqual(parsed.raw, loaded.raw);
assert.equal(parsed.raw.buffer, written.buffer, "the report's bytes are a view of the manifest, not a copy");
assert.equal(parsed.entries.size, [...loaded.entries.keys()].filter(name => name.startsWith("assets/")).length);
// Another writer's layout: parsed whole, the report re-serialized.
const reordered = JSON.parse(new TextDecoder().decode(written));
const other = reportFromManifest(new TextEncoder().encode(JSON.stringify({ report: reordered.report, format: reordered.format, file: reordered.file, entries: reordered.entries })), read)!;
assert.equal(other.kind, "pr-review");
assert.deepEqual(other.json, parsed.json);
// A nested `"report"` key before the report's own is not where the report starts.
const nested = `{"format":"explore.preview-manifest/1","extra":{"a":1,"report":2},"file":"review.json","entries":{},"report":${new TextDecoder().decode(loaded.raw)}}`;
const fromNested = reportFromManifest(new TextEncoder().encode(nested), read)!;
assert.equal(fromNested.kind, "pr-review");
assert.deepEqual(fromNested.json, parsed.json);
for (const bad of ['{"format":"explore.preview-manifest/1","file":"review.json","entries":{"../x":1},"report":{}}', '{"format":"other","file":"review.json","entries":{},"report":{}}', "not json"]) {
assert.equal(reportFromManifest(new TextEncoder().encode(bad), read), undefined, bad);
}
const tooLarge = deployment({ [listing[0]!.path]: await sealed(explorationZip) }, env, undefined, { held: size, peak: size });
for (const path of [`/assets/${pngSha}.png?target=iphone`, "/manifest.json?target=iphone", "/report.zip?target=iphone"]) {
assert.equal((await tooLarge.get(path)).status, 413, path);
}
assert.equal(tooLarge.calls.length, 2, "the isolate remembers a report it cannot decrypt (report.zip is not cached)");
assert.equal(reportFromManifest(new Uint8Array(MAX_MANIFEST_BYTES + 1), read), undefined, "larger than the Viewer opens");
});
test("an agent's screenshot the Worker cannot fetch this time is a 503; one the report does not hold is a 404", async () => {
const site = await deployment({ [reviewEnv.EXPLORE_PREVIEW_REPORT!]: review }, reviewEnv);
const loaded = (await loadReport(review))!;
const name = [...loaded.entries.keys()].find(entry => /^assets\/[a-f0-9]{64}\.png$/.test(entry))!;
const sha = name.slice(7, 71);
const manifest = site.files[reviewEnv.EXPLORE_PREVIEW_REPORT!]!;
const failing = (status: number) => previewResponse(new Request(`${origin}/p/${token}/api/v1/assets/${sha}`), { env: reviewEnv, indexHtml: html, cache: new Map(), loading: new Map(),
fetchImpl: (async (input: RequestInfo | URL) => String(input).endsWith(".json") ? new Response(manifest as BodyInit) : new Response("upstream", { status })) as typeof fetch });
const unavailable = await failing(502);
assert.equal(unavailable.status, 503);
assert.equal((await unavailable.json()).error, "unavailable");
assert.equal((await failing(404)).status, 404);
});
test("kept manifests count their parsed size against the cache: the oldest goes when the next would not fit", async () => {
const big = (label: string) => zip({ "exploration.json": new TextEncoder().encode(JSON.stringify({ ...explorationReport, padding: label.repeat(6 * 1024 * 1024) })), [`assets/${pngSha}.png`]: png });
const listing = ["first", "second"].map(target => ({ target, platform: "ios", label: target, path: `/p/${token}/targets/${target}.json` }));
const env: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
const site = await deployment({ [listing[0]!.path]: big("a"), [listing[1]!.path]: big("b") }, env);
assert.equal((await site.get("/api/v1?target=first")).status, 200);
assert.deepEqual([...site.cache.keys()], [`${origin}${listing[0]!.path}`]);
// Two 6 MB manifests are about 36 MB once parsed, over the 32 MB the isolate keeps.
assert.equal((await site.get("/api/v1?target=second")).status, 200);
assert.deepEqual([...site.cache.keys()], [`${origin}${listing[1]!.path}`]);
});
+69 -111
View File
@@ -1,150 +1,110 @@
import assert from "node:assert/strict";
import test from "node:test";
import { webcrypto } from "node:crypto";
import { PREVIEW_CIPHER, previewConfig, previewResponse, type PreviewEnvironment } from "../src/server/preview";
import { previewConfig, previewResponse, type PreviewEnvironment } from "../src/server/preview";
const subtle = webcrypto.subtle as SubtleCrypto;
const token = "abcdefghijklmnopqrstuvwxyz234567";
const html = '<!doctype html><script type="module" src="/viewer/assets/main.js"></script>';
const report: Uint8Array<ArrayBuffer> = new TextEncoder().encode("PK\u0003\u0004 a small report archive stand-in");
async function sealed(keyBytes: Uint8Array<ArrayBuffer>, plain: Uint8Array<ArrayBuffer> = report): Promise<Uint8Array<ArrayBuffer>> {
const key = await subtle.importKey("raw", keyBytes, "AES-GCM", false, ["encrypt"]);
const iv = webcrypto.getRandomValues(new Uint8Array(PREVIEW_CIPHER.ivBytes));
const cipher = new Uint8Array(await subtle.encrypt({ name: "AES-GCM", iv, additionalData: new TextEncoder().encode(PREVIEW_CIPHER.aad) }, key, plain));
const out = new Uint8Array(iv.byteLength + cipher.byteLength);
out.set(iv); out.set(cipher, iv.byteLength);
return out;
}
const keyBytes: Uint8Array<ArrayBuffer> = webcrypto.getRandomValues(new Uint8Array(32));
const env: PreviewEnvironment = {
EXPLORE_PREVIEW_TOKEN: token,
EXPLORE_PREVIEW_KEY: Buffer.from(keyBytes).toString("base64"),
EXPLORE_PREVIEW_EXPIRES_AT: "2030-01-01T00:00:00Z",
EXPLORE_PREVIEW_REPORT: "/_report/abcdefghijklmnop/report.zip.enc",
};
const env: PreviewEnvironment = { EXPLORE_PREVIEW_TOKEN: token, EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/report.json` };
const origin = "https://acme-explore--k7f3z0d1q8.expo.app";
/** The manifest route streams the static file through unparsed, so a stand-in names the report it is. */
const standIn = (name: string) => new TextEncoder().encode(`manifest of ${name}`);
test("after the sealed expiry the exact token still opens the Viewer and the report routes answer 410 with the instant; no expiry means never", async () => {
const options = { env, indexHtml: html, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) }), subtle };
const before = { ...options, now: () => Date.parse("2029-12-31T23:59:59Z") };
const after = { ...options, now: () => Date.parse("2030-01-01T00:00:00Z") };
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), before)).status, 200);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), before)).status, 200);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { headers: { accept: "text/html" } }), after)).status, 200, "a browser still gets the shell, which explains the expiry");
for (const path of ["", "/report.zip", "/reports.json", "/report.zip?platform=ios"]) {
const response = await previewResponse(new Request(`${origin}/p/${token}${path}`), after);
assert.equal(response.status, 410, path);
assert.equal(response.headers.get("cache-control"), "private, no-store", path);
assert.deepEqual(await response.json(), { error: "expired", expiredAt: "2030-01-01T00:00:00.000Z" }, path);
}
const wrongToken = token.replace(/a/, "b");
assert.equal((await previewResponse(new Request(`${origin}/p/${wrongToken}/report.zip`), after)).status, 404, "a wrong token never learns about the expiry");
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { method: "POST" }), after)).status, 404);
const never = { ...after, env: { ...env, EXPLORE_PREVIEW_EXPIRES_AT: undefined } };
assert.equal(previewConfig(never.env)?.expiresAt, null);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), never)).status, 200);
});
function staticFiles(files: Record<string, Uint8Array<ArrayBuffer>>): typeof fetch {
function staticFiles(files: Record<string, Uint8Array>): typeof fetch {
const calls: string[] = [];
const impl = (async (input: RequestInfo | URL) => {
const url = new URL(typeof input === "string" ? input : input instanceof URL ? input.href : input.url);
calls.push(url.href);
const body = files[url.pathname];
return body ? new Response(body, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
return body ? new Response(body as BodyInit, { headers: { "content-length": String(body.byteLength) } }) : new Response("missing", { status: 404 });
}) as typeof fetch;
(impl as typeof fetch & { calls: string[] }).calls = calls;
return impl;
}
const options = (environment: PreviewEnvironment, files: Record<string, Uint8Array>) =>
({ env: environment, indexHtml: html, fetchImpl: staticFiles(files), cache: new Map(), loading: new Map() });
test("the sealed configuration is read strictly", () => {
assert.ok(previewConfig(env));
test("the configuration is read strictly, and a report's manifest must sit under the deployment's own token", () => {
assert.deepEqual(previewConfig(env), { token, reports: [{ target: "ios", platform: "ios", path: env.EXPLORE_PREVIEW_REPORT }] });
const otherToken = token.replace(/a/, "b");
for (const broken of [
{ EXPLORE_PREVIEW_TOKEN: "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" }, { EXPLORE_PREVIEW_TOKEN: token.slice(1) }, { EXPLORE_PREVIEW_TOKEN: undefined },
{ EXPLORE_PREVIEW_KEY: Buffer.alloc(16).toString("base64") }, { EXPLORE_PREVIEW_KEY: "not base64!" },
{ EXPLORE_PREVIEW_EXPIRES_AT: "soon" }, { EXPLORE_PREVIEW_REPORT: "/report.zip.enc" }, { EXPLORE_PREVIEW_REPORT: "/_report/../x/report.zip.enc" },
{ EXPLORE_PREVIEW_REPORT: "/report.json" }, { EXPLORE_PREVIEW_REPORT: `/p/${otherToken}/targets/report.json` },
{ EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/../report.json` }, { EXPLORE_PREVIEW_REPORT: `/p/${token}/targets/ios.json` },
{ EXPLORE_PREVIEW_REPORT: "/_report/abcdefghijklmnop/report.zip.enc" },
]) assert.equal(previewConfig({ ...env, ...broken }), undefined, JSON.stringify(broken));
});
test("the token page serves the Viewer shell and the report route streams the decrypted report", async () => {
const fetchImpl = staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) });
const page = await previewResponse(new Request(`${origin}/p/${token}?view=compare&screen=home#/map`), { env, indexHtml: html, fetchImpl, subtle });
test("the token page serves the Viewer shell, and the manifest route answers the target's static manifest", async () => {
const files = { [env.EXPLORE_PREVIEW_REPORT!]: standIn("report") };
const page = await previewResponse(new Request(`${origin}/p/${token}?view=compare&screen=home#/map`), options(env, files));
assert.equal(page.status, 200);
// A stand-in is not a manifest the index can read, so the shell is the plain Viewer.
assert.equal(await page.text(), html);
assert.equal(page.headers.get("cache-control"), "private, no-store");
assert.equal(page.headers.get("referrer-policy"), "no-referrer");
assert.match(page.headers.get("content-security-policy") ?? "", /frame-ancestors 'none'/);
const slash = await previewResponse(new Request(`${origin}/p/${token}/`), { env, indexHtml: html, fetchImpl, subtle });
assert.equal(slash.status, 200);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/`), options(env, files))).status, 200);
const zip = await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { env, indexHtml: html, fetchImpl, subtle });
assert.equal(zip.status, 200);
assert.equal(zip.headers.get("content-type"), "application/zip");
assert.equal(zip.headers.get("content-length"), String(report.byteLength));
assert.deepEqual(new Uint8Array(await zip.arrayBuffer()), report);
// Only the sealed report file is ever fetched, whether for the shell's inline index or the zip route.
const calls = (fetchImpl as typeof fetch & { calls: string[] }).calls;
assert.ok(calls.length >= 1 && calls.every(call => call === `${origin}${env.EXPLORE_PREVIEW_REPORT}`), calls.join());
const manifest = await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), options(env, files));
assert.equal(manifest.status, 200);
assert.equal(manifest.headers.get("content-type"), "application/json; charset=utf-8");
assert.equal(manifest.headers.get("cache-control"), "private, no-store");
assert.equal(await manifest.text(), "manifest of report");
});
test("everything else is the same 404: wrong token, other paths, other methods, bad ciphertext, missing file", async () => {
const good = await sealed(keyBytes);
const files = { [env.EXPLORE_PREVIEW_REPORT!]: good };
const options = { env, indexHtml: html, fetchImpl: staticFiles(files), subtle };
test("everything else is the same 404: wrong token, other paths, other methods, a missing manifest; a failing fetch is a 503", async () => {
const files = { [env.EXPLORE_PREVIEW_REPORT!]: standIn("report") };
const wrongToken = token.replace(/a/, "b");
for (const path of [`/p/${wrongToken}`, `/p/${wrongToken}/report.zip`, `/p/${token.toUpperCase()}`, `/p/${token}/viewer/assets/main.js`,
`/p/${token}/other.zip`, `/p/${token}/report.zip/`, `/p/${token}x`, "/p", "/p/", "/", "/_report/abcdefghijklmnop/report.zip.enc", `/P/${token}`]) {
const response = await previewResponse(new Request(origin + path), options);
for (const path of [`/p/${wrongToken}`, `/p/${wrongToken}/manifest.json`, `/p/${token.toUpperCase()}`, `/p/${token}/viewer/assets/main.js`,
`/p/${token}/report.zip`, `/p/${token}/assets/${"0".repeat(64)}.png`, `/p/${token}/targets/report.json`, `/p/${token}/manifest.json/`,
`/p/${token}x`, "/p", "/p/", "/", `/P/${token}`]) {
const response = await previewResponse(new Request(origin + path), options(env, files));
assert.equal(response.status, 404, path);
assert.equal(await response.text(), "Not found", path);
assert.equal(response.headers.get("cache-control"), "private, no-store", path);
}
for (const method of ["HEAD", "POST", "PUT", "DELETE", "OPTIONS"]) {
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { method }), options)).status, 404, method);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`, { method }), options(env, files))).status, 404, method);
}
const otherKey: Uint8Array<ArrayBuffer> = webcrypto.getRandomValues(new Uint8Array(32));
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(otherKey) }) })).status, 404);
const tampered = Uint8Array.from(good); tampered[tampered.length - 1] = (tampered[tampered.length - 1] ?? 0) ^ 1;
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: tampered }) })).status, 404);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, fetchImpl: staticFiles({}) })).status, 404);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip`), { ...options, env: { ...env, EXPLORE_PREVIEW_KEY: undefined } })).status, 404);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), options(env, {}))).status, 404, "a deployment missing its manifest");
const failing = { ...options(env, files), fetchImpl: (async () => new Response("upstream", { status: 502 })) as typeof fetch };
const unavailable = await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), failing);
assert.equal(unavailable.status, 503);
assert.equal(unavailable.headers.get("retry-after"), "1");
const throwing = { ...options(env, files), fetchImpl: (async () => { throw new TypeError("network"); }) as typeof fetch };
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/manifest.json`), throwing)).status, 503);
});
test("a multi-platform deployment serves reports.json, one report per platform, and rejects loose configuration", async () => {
const android: Uint8Array<ArrayBuffer> = new TextEncoder().encode("PK\u0003\u0004 android report stand-in");
test("a multi-platform deployment serves reports.json, one manifest per platform, and rejects loose configuration", async () => {
const reports = [
{ platform: "ios", path: "/_report/abcdefghijklmnop/ios.zip.enc", changes: 3, device: "iPhone 17 Pro 26.0" },
{ platform: "android", path: "/_report/abcdefghijklmnop/android.zip.enc", changes: 0, device: "Pixel 7 15" },
{ platform: "ios", path: `/p/${token}/targets/ios.json`, changes: 3, device: "iPhone 17 Pro 26.0" },
{ platform: "android", path: `/p/${token}/targets/android.json`, changes: 0, device: "Pixel 7 15" },
];
const { EXPLORE_PREVIEW_REPORT: _single, ...rest } = env;
const multi: PreviewEnvironment = { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(reports) };
const fetchImpl = staticFiles({ [reports[0]!.path]: await sealed(keyBytes), [reports[1]!.path]: await sealed(keyBytes, android) });
const options = { env: multi, indexHtml: html, fetchImpl, subtle };
const files = { [reports[0]!.path]: standIn("ios"), [reports[1]!.path]: standIn("android") };
// A listing from before targets names each report by its platform, which is then its target.
assert.deepEqual(previewConfig(multi)?.reports, reports.map(entry => ({ target: entry.platform, ...entry })));
const list = await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options);
const list = await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options(multi, files));
assert.equal(list.status, 200);
assert.equal(list.headers.get("content-type"), "application/json; charset=utf-8");
assert.equal(list.headers.get("cache-control"), "private, no-store");
assert.deepEqual(await list.json(), [{ target: "ios", platform: "ios", changes: 3, device: "iPhone 17 Pro 26.0" }, { target: "android", platform: "android", changes: 0, device: "Pixel 7 15" }]);
const first = await previewResponse(new Request(`${origin}/p/${token}/report.zip`), options);
assert.deepEqual(new Uint8Array(await first.arrayBuffer()), report);
const ios = await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=ios`), options);
assert.deepEqual(new Uint8Array(await ios.arrayBuffer()), report);
const second = await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=android`), options);
assert.deepEqual(new Uint8Array(await second.arrayBuffer()), android);
for (const path of ["/report.zip?platform=web", "/report.zip?platform=ios&platform=android", "/reports.json/", "/report.zip?platform="]) {
assert.equal((await previewResponse(new Request(`${origin}/p/${token}${path}`), options)).status, 404, path);
}
const manifest = async (query: string) => {
const response = await previewResponse(new Request(`${origin}/p/${token}/manifest.json${query}`), options(multi, files));
return response.status === 200 ? await response.text() : response.status;
};
assert.equal(await manifest(""), "manifest of ios");
assert.equal(await manifest("?platform=ios"), "manifest of ios");
assert.equal(await manifest("?platform=android"), "manifest of android");
for (const query of ["?platform=web", "?platform=ios&platform=android", "?platform="]) assert.equal(await manifest(query), 404, query);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/reports.json/`), options(multi, files))).status, 404);
// Single-report deployments still answer reports.json (one iOS entry) and ignore an unknown platform.
const single = { env, indexHtml: html, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) }), subtle };
const single = options(env, { [env.EXPLORE_PREVIEW_REPORT!]: standIn("report") });
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), single)).json(), [{ target: "ios", platform: "ios" }]);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=android`), single)).status, 404);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/manifest.json?platform=android`), single)).status, 404);
const loose: Array<[string, unknown]> = [
["both variables", { ...multi, EXPLORE_PREVIEW_REPORT: env.EXPLORE_PREVIEW_REPORT }],
@@ -153,34 +113,32 @@ test("a multi-platform deployment serves reports.json, one report per platform,
["duplicate platform", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([reports[0], reports[0]]) }],
["unknown platform", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "web", path: reports[0]!.path }]) }],
["foreign path", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ platform: "ios", path: "https://example.invalid/x" }]) }],
["another token's path", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], path: `/p/${token.replace(/a/, "b")}/targets/ios.json` }]) }],
["extra key", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], url: "x" }]) }],
["bad changes", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], changes: -1 }]) }],
["markup device", { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify([{ ...reports[0], device: "<b>x</b>" }]) }],
];
for (const [name, value] of loose) {
assert.equal(previewConfig(value as PreviewEnvironment), undefined, name);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), { ...options, env: value as PreviewEnvironment })).status, 404, name);
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), options(value as PreviewEnvironment, files))).status, 404, name);
}
});
test("a deployment of several targets, three of them iOS, selects by ?target= and still by ?platform=", async () => {
const targets = [
{ target: "iphone", platform: "ios", label: "iPhone 17", path: "/_report/abcdefghijklmnop/iphone.zip.enc", changes: 1 },
{ target: "duo-closed", platform: "ios", label: "iPhone Duo (closed)", path: "/_report/abcdefghijklmnop/duo-closed.zip.enc" },
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: "/_report/abcdefghijklmnop/duo-open.zip.enc", device: "iPhone Duo 26.0" },
{ target: "android", platform: "android", label: "Android", path: "/_report/abcdefghijklmnop/android.zip.enc" },
{ target: "iphone", platform: "ios", label: "iPhone 17", path: `/p/${token}/targets/iphone.json`, changes: 1 },
{ target: "duo-closed", platform: "ios", label: "iPhone Duo (closed)", path: `/p/${token}/targets/duo-closed.json` },
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: `/p/${token}/targets/duo-open.json`, device: "iPhone Duo 26.0" },
{ target: "android", platform: "android", label: "Android", path: `/p/${token}/targets/android.json` },
];
const bodies = targets.map(entry => new TextEncoder().encode(`PK\u0003\u0004 ${entry.target} report stand-in`));
const { EXPLORE_PREVIEW_REPORT: _single, ...rest } = env;
const multi: PreviewEnvironment = { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(targets) };
const files: Record<string, Uint8Array<ArrayBuffer>> = {};
for (const [index, entry] of targets.entries()) files[entry.path] = await sealed(keyBytes, bodies[index]!);
const options = { env: multi, indexHtml: html, fetchImpl: staticFiles(files), subtle };
const files = Object.fromEntries(targets.map(entry => [entry.path, standIn(entry.target)]));
assert.deepEqual(previewConfig(multi)?.reports, targets);
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options)).json(), targets.map(({ path: _path, ...entry }) => entry));
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options(multi, files))).json(), targets.map(({ path: _path, ...entry }) => entry));
const served = async (query: string) => {
const response = await previewResponse(new Request(`${origin}/p/${token}/report.zip${query}`), options);
return response.status === 200 ? new TextDecoder().decode(await response.arrayBuffer()).split(" ")[1] : response.status;
const response = await previewResponse(new Request(`${origin}/p/${token}/manifest.json${query}`), options(multi, files));
return response.status === 200 ? (await response.text()).replace("manifest of ", "") : response.status;
};
assert.equal(await served(""), "iphone", "the first listed");
assert.equal(await served("?target=duo-open"), "duo-open");
@@ -191,14 +149,14 @@ test("a deployment of several targets, three of them iOS, selects by ?target= an
assert.equal(await served(query), 404, query);
}
const eight = Array.from({ length: 8 }, (_, index) => ({ target: `t${index}`, platform: "ios", path: `/_report/abcdefghijklmnop/t${index}.zip.enc` }));
const eight = Array.from({ length: 8 }, (_, index) => ({ target: `t${index}`, platform: "ios", path: `/p/${token}/targets/t${index}.json` }));
assert.equal(previewConfig({ ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(eight) })?.reports.length, 8);
const loose: Array<[string, unknown]> = [
["nine targets", [...eight, { target: "t8", platform: "ios", path: "/_report/abcdefghijklmnop/t8.zip.enc" }]],
["nine targets", [...eight, { target: "t8", platform: "ios", path: `/p/${token}/targets/t8.json` }]],
["duplicate target", [targets[0], { ...targets[1], target: "iphone", path: targets[0]!.path }]],
["invalid id", [{ ...targets[0], target: "iPhone", path: "/_report/abcdefghijklmnop/iPhone.zip.enc" }]],
["reserved id", [{ ...targets[0], target: "report", path: "/_report/abcdefghijklmnop/report.zip.enc" }]],
["install id", [{ ...targets[0], target: "install-x", path: "/_report/abcdefghijklmnop/install-x.zip.enc" }]],
["invalid id", [{ ...targets[0], target: "iPhone", path: `/p/${token}/targets/iPhone.json` }]],
["reserved id", [{ ...targets[0], target: "report", path: `/p/${token}/targets/report.json` }]],
["install id", [{ ...targets[0], target: "install-x", path: `/p/${token}/targets/install-x.json` }]],
["path of another target", [{ ...targets[0], path: targets[1]!.path }]],
["null target", [{ ...targets[0], target: null }]],
["markup label", [{ ...targets[0], label: "<b>x</b>" }]],
+16 -8
View File
@@ -1,4 +1,4 @@
import { appearanceLabel, appearanceOptions, appearanceScope, filterComparisonAppearance, filterMapAppearance, filterReviewAppearance, type Appearance } from "./utils/appearance";
import { appearanceLabel, appearanceOptions, appearanceScope, filterComparisonAppearance, filterMapAppearance, filterReviewAppearance, rememberAppearance, rememberedAppearance, type Appearance } from "./utils/appearance";
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
import { createPortal, flushSync } from "react-dom";
import { AlertCircle, RefreshCw } from "lucide-react";
@@ -11,7 +11,7 @@ import { CanvasVisibleFrameProvider } from "./components/canvas/visible-frame-pr
import { AppLoading } from "./components/shared/app-loading";
import { ReportLoadingShell } from "./components/shared/report-loading-shell";
import { screenLabel } from "./utils/screen-path";
import { AppPill, PLATFORM_NAMES } from "./components/panels/app-pill";
import { AppPill, PLATFORM_NAMES, targetSwitch } from "./components/panels/app-pill";
import { changedScreens, focusCounts as countFocusStatuses, isCapturedChange, type ChangedScreen } from "./utils/changed-screens";
import { MapView } from "./components/views/semantic-map";
import { RightPanel } from "./components/panels/right";
@@ -305,8 +305,13 @@ function ViewerApp() {
const routeRef = useRef(route);
const contextRef = useRef(EMPTY_ROUTE_CONTEXT);
const [mapProjectionFitKey, setMapProjectionFitKey] = useState(0);
// A report captured in several appearances shows one at a time; the primary (first captured) is the default.
const [appearanceChoice, setAppearanceChoice] = useState<Appearance | undefined>();
// A report captured in several appearances shows one at a time: the one this tab chose for the review (so a target
// switch keeps it) when this report has it, the primary (first captured) otherwise.
const [appearanceChoice, setAppearanceChoice] = useState<Appearance | undefined>(rememberedAppearance);
const chooseAppearance = useCallback((appearance: Appearance) => {
rememberAppearance(appearance);
setAppearanceChoice(appearance);
}, []);
// For the ⇧T shortcut, which steps to the next captured appearance; set once they are known.
const appearanceRef = useRef<{ options: readonly Appearance[]; current: Appearance | undefined }>({ options: [], current: undefined });
const [handoffOpen, setHandoffOpen] = useState(false);
@@ -1008,7 +1013,7 @@ function ViewerApp() {
const { options, current } = appearanceRef.current;
if (options.length < 2) return;
const index = current ? options.indexOf(current) : -1;
setAppearanceChoice(options[(index + 1) % options.length]);
chooseAppearance(options[(index + 1) % options.length]!);
} else if (matchesShortcut(event, SHORTCUTS.app.changes)) {
setChangesOpen((open) => !open);
} else if (matchesShortcut(event, SHORTCUTS.panel.right)) {
@@ -1024,7 +1029,7 @@ function ViewerApp() {
return () => {
window.removeEventListener("keydown", onKeyDown);
};
}, [clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleRightPanel]);
}, [chooseAppearance, clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleRightPanel]);
// A side-panel row or a deep link is a "go to": the camera fits that screen and the step is
// kept. Screens inventory clicks only select in place; Map clicks also focus the chosen screen. Repeating a selected target refits it without adding history.
@@ -1199,6 +1204,8 @@ function ViewerApp() {
? { ...presentedMap, run: { ...presentedMap.run, name: workspace.catalog.name } }
: presentedMap
), [presentedMap, workspace]);
// The shortcuts list names the target keys only where the pill can switch.
const switchTargets = map ? targetSwitch(map.run, new URL(window.location.href)) : undefined;
// Focus singles out diff states, so it means nothing without a baseline to diff against.
const focusFilter = diff ? route.focus : [];
const focusCounts = useMemo(() => countFocusStatuses(diff), [diff]);
@@ -1531,7 +1538,7 @@ function ViewerApp() {
index={index}
{...(selectedScreenId ? { selectedScreenId } : {})}
{...(review?.pullRequest ? { pullRequest: review.pullRequest } : {})}
{...(appearances.length > 1 && appearance ? { appearance: { current: appearance, options: appearances, onChange: setAppearanceChoice } } : {})}
{...(appearances.length > 1 && appearance ? { appearance: { current: appearance, options: appearances, onChange: chooseAppearance } } : {})}
focus={focusFilter}
focusCounts={focusCounts}
{...(diff ? { diff } : {})}
@@ -1631,7 +1638,8 @@ function ViewerApp() {
</CanvasVisibleFrameProvider>
{shortcutsOpen ? (
<ShortcutsDialog
context={{ canvas: route.canvas, review: reviewingInSidebar, hasChanges: compareOrder.length > 0, handoff: Boolean(handoffInput), appearances: appearances.length > 1 }}
context={{ canvas: route.canvas, review: reviewingInSidebar, hasChanges: compareOrder.length > 0, handoff: Boolean(handoffInput), appearances: appearances.length > 1,
...(switchTargets ? { targets: switchTargets } : {}) }}
onClose={() => setShortcutsOpen(false)}
/>
) : null}
@@ -1,7 +1,7 @@
import { useEffect } from "react";
import { createPortal } from "react-dom";
import { X } from "lucide-react";
import { CANVAS_NUMBER_KEYS, formatShortcut, SHORTCUTS, type Shortcut } from "../../utils/shortcuts";
import { CANVAS_NUMBER_KEYS, formatShortcut, SHORTCUTS, TARGET_NUMBER_KEYS, type Shortcut } from "../../utils/shortcuts";
import type { CanvasView } from "../../utils/navigation";
import { useModalDialog } from "../../hooks/use-modal-dialog";
@@ -19,8 +19,21 @@ export type ShortcutContext = {
handoff?: boolean;
/** The report was captured in both light and dark, so the app's appearance can be switched. */
appearances?: boolean;
/** The run's other targets are one switch away; the pill calls them devices, or platforms in reports from before targets. */
targets?: { noun: "device" | "platform"; count: number };
};
function targetRows(targets: NonNullable<ShortcutContext["targets"]>): Row[] {
const numbers = SHORTCUTS.targetByNumber.slice(0, Math.min(targets.count, SHORTCUTS.targetByNumber.length));
return [
{ label: `Another ${targets.noun}'s report`, keys: [SHORTCUTS.target.menu] },
...(TARGET_NUMBER_KEYS && numbers.length > 1
? [{ label: `A ${targets.noun} by its place in that menu`, keys: [`${formatShortcut(numbers[0]!)}–${formatShortcut(numbers.at(-1)!)}`] }]
: []),
{ label: `Back to the last ${targets.noun}`, keys: [SHORTCUTS.target.last] },
];
}
const COMPARE = SHORTCUTS.compare;
function reviewGroup(context: ShortcutContext): Group {
@@ -71,6 +84,7 @@ export function shortcutGroups(context: ShortcutContext): Group[][] {
{ label: "Search screens", keys: [SHORTCUTS.app.search] },
...(context.handoff ? [{ label: "Hand off to AI", keys: [SHORTCUTS.app.handoff] }] : []),
...(context.hasChanges ? [{ label: "Changed screens menu", keys: [SHORTCUTS.app.changes] }] : []),
...(context.targets ? targetRows(context.targets) : []),
],
};
const view: Group = {
+77 -7
View File
@@ -9,9 +9,9 @@ import { artifactUrl } from "../../utils/model";
import { REPORT_SOURCE } from "../../utils/report-source";
import { Tooltip } from "../shared/tooltip";
import { KeyHint } from "../shared/key-hint";
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
import { formatShortcut, matchesShortcut, shortcutsLive, SHORTCUTS, TARGET_NUMBER_KEYS } from "../../utils/shortcuts";
import { ChangesMenu } from "./changes-menu";
import type { FocusStatus } from "../../utils/navigation";
import { placeForAnotherTarget, type FocusStatus } from "../../utils/navigation";
import type { ExploreMap, MapIndex } from "../../utils/model";
import type { BuildDiff } from "../../utils/build-diff";
import type { PullRequestPresentation } from "../../utils/review-model";
@@ -23,7 +23,10 @@ type SiblingReport = { target: string; changes?: number; device?: string };
/** One report of the run, as the switch offers it. */
export type SwitchTarget = { id: string; platform: string; label: string };
/** The same review's report for another target: this page's URL with the target swapped (and the artifact id dropped). */
/**
* The same review's report for another target: this page's URL with the target swapped (and the artifact id dropped),
* open at the same place where the other report has it.
*/
export function siblingReportUrl(page: URL, target: string): string | undefined {
const preview = isPreviewPath(page.pathname);
if (!preview && page.searchParams.get("origin") === "local") return undefined;
@@ -36,10 +39,27 @@ export function siblingReportUrl(page: URL, target: string): string | undefined
url.searchParams.set(key, value);
url.searchParams.delete("artifact");
url.searchParams.delete("screen");
url.hash = "";
url.hash = placeForAnotherTarget(page.hash);
return url.href;
}
/**
* The target this tab showed before the current one, for `. Kept in session storage, since a report page that is not a
* hosted preview loads again to switch; a Back or Forward between targets counts as a switch too.
*/
function useLastTarget(current: string): string | undefined {
const [last, setLast] = useState<string>();
useEffect(() => {
const key = `explore.targets:${window.location.pathname}:${new URLSearchParams(window.location.search).get("run") ?? ""}`;
let stored: { shown?: unknown; last?: unknown } = {};
try { stored = JSON.parse(window.sessionStorage.getItem(key) ?? "{}") as typeof stored; } catch { /* Optional storage. */ }
const previous = [stored.shown, stored.last].find((id): id is string => isReportTargetId(id) && id !== current);
try { window.sessionStorage.setItem(key, JSON.stringify({ shown: current, ...(previous ? { last: previous } : {}) })); } catch { /* Optional storage. */ }
setLast(previous);
}, [current]);
return last;
}
/**
* Every report of this report's run, in config order, and which one this is: `run.targets` with their labels, or for
* reports from before targets one per platform of `run.platforms` (iOS first, as they list it). One report: none.
@@ -54,6 +74,13 @@ export function runTargets(run: ExploreMap["run"]): { current: string; targets:
return { current, targets: platforms.length > 1 ? platforms.map(platform => ({ id: platform, platform, label: PLATFORM_NAMES[platform]! })) : [] };
}
/** What the shortcuts list says about switching: nothing when this page cannot open another target's report. */
export function targetSwitch(run: ExploreMap["run"], page: URL): { noun: "device" | "platform"; count: number } | undefined {
const { current, targets } = runTargets(run);
if (!targets.some(target => target.id !== current && siblingReportUrl(page, target.id))) return undefined;
return { noun: targets.every(target => target.id === target.platform) ? "platform" : "device", count: targets.length };
}
/** On a hosted preview, the deployment lists what it serves per target; elsewhere only the targets' names are known. */
function useSiblingReports(page: URL | undefined): SiblingReport[] | undefined {
const [reports, setReports] = useState<SiblingReport[]>();
@@ -146,19 +173,62 @@ export function AppPill(props: AppPillProps) {
.filter(target => target.id !== run.current)
.map(target => ({ target, url: page ? siblingReportUrl(page, target.id) : undefined, report: siblingReports?.find(report => report.target === target.id) }))
.filter((entry): entry is { target: SwitchTarget; url: string; report: SiblingReport | undefined } => Boolean(entry.url));
// The URL is read when the switch happens, so the other report opens where the reader is now.
const openTarget = (id: string) => {
setPlatformOpen(false);
const url = siblingReportUrl(new URL(window.location.href), id);
if (url && !REPORT_SOURCE.switchTarget(id, url)) window.location.assign(url);
};
// ⌥1–⌥8 follow the menu's order, the run's config order.
const numberHint = (target: SwitchTarget) => {
const shortcut = TARGET_NUMBER_KEYS ? SHORTCUTS.targetByNumber[run.targets.indexOf(target)] : undefined;
return shortcut ? { shortcut: formatShortcut(shortcut) } : {};
};
const platformItems = siblings.length ? run.targets.flatMap(target => {
if (target.id === run.current) return [{ kind: "item" as const, label: target.label, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) }];
if (target.id === run.current) return [{ kind: "item" as const, label: target.label, description: device || undefined, checked: true, ...numberHint(target), onSelect: () => setPlatformOpen(false) }];
const sibling = siblings.find(entry => entry.target.id === target.id);
return sibling ? [{
kind: "item" as const, label: target.label,
description: [sibling.report?.changes === undefined ? undefined : `${sibling.report.changes} ${sibling.report.changes === 1 ? "change" : "changes"}`, sibling.report?.device]
.filter(Boolean).join(" · ") || (target.platform === platform ? "Same review, other device" : "Same review, other platform"),
checked: false, onSelect: () => { setPlatformOpen(false); if (!REPORT_SOURCE.switchTarget(target.id, sibling.url)) window.location.assign(sibling.url); },
checked: false, ...numberHint(target), onSelect: () => openTarget(target.id),
}] : [];
}) : [];
// A report whose target is not among the run's (a hand-edited one) still lists itself first, checked.
if (siblings.length && !currentTarget) platformItems.unshift({ kind: "item" as const, label: targetLabel, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) });
// D opens the menu, ⌥1–⌥8 open a target by its place in it, and ` returns to the last target shown (the next one in
// the menu's order before there is one). The handler reads the current targets from a ref.
const last = useLastTarget(run.current);
const targetKeys = { siblings: siblings.map(entry => entry.target.id), order: run.targets.map(target => target.id), current: run.current, last, openTarget };
const targetKeysRef = useRef(targetKeys);
targetKeysRef.current = targetKeys;
useEffect(() => {
const onKeyDown = (event: KeyboardEvent) => {
const { siblings, order, current, last, openTarget } = targetKeysRef.current;
if (!siblings.length || !shortcutsLive(event)) return;
if (matchesShortcut(event, SHORTCUTS.target.menu)) {
event.preventDefault();
setPlatformOpen(open => !open);
return;
}
let id: string | undefined;
if (matchesShortcut(event, SHORTCUTS.target.last)) {
const start = order.indexOf(current);
id = last && siblings.includes(last) ? last
: order.map((_, step) => order[(start + 1 + step) % order.length]!).find(candidate => siblings.includes(candidate));
} else if (TARGET_NUMBER_KEYS) {
const place = SHORTCUTS.targetByNumber.findIndex(shortcut => matchesShortcut(event, shortcut));
if (place === -1) return;
id = order[place];
} else return;
event.preventDefault();
if (id && siblings.includes(id)) openTarget(id);
};
window.addEventListener("keydown", onKeyDown);
return () => window.removeEventListener("keydown", onKeyDown);
}, []);
return (
<div className="left-panel collapsed">
<div ref={pillRef} className="left-panel-collapsed-pill">
@@ -182,7 +252,7 @@ export function AppPill(props: AppPillProps) {
</strong>
{siblings.length ? (
<>
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} placement="bottom">
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} shortcut={formatShortcut(SHORTCUTS.target.menu)} placement="bottom">
<button ref={platformRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={platformOpen}
aria-label={`${noun === "device" ? "Device" : "Platform"}: ${targetLabel}. Open another ${noun}'s report`}
onClick={() => setPlatformOpen(open => !open)}>
+19
View File
@@ -10,6 +10,25 @@ export function appearanceLabel(appearance: Appearance): string {
return APPEARANCE_LABELS[appearance];
}
/** The review a tab's choice belongs to: every target of one review shares the page path (and a report page's run). */
function chosenAppearanceKey(): string {
return `explore.appearance:${window.location.pathname}:${new URLSearchParams(window.location.search).get("run") ?? ""}`;
}
/**
* The appearance this tab last chose for this review, so another target's report opens in it too when it was captured
* in it (a switch in place remounts the Viewer, and a report page loads again). Kept in session storage, which may be off.
*/
export function rememberedAppearance(): Appearance | undefined {
let stored: string | null = null;
try { stored = window.sessionStorage.getItem(chosenAppearanceKey()); } catch { /* Optional storage. */ }
return stored === "light" || stored === "dark" ? stored : undefined;
}
export function rememberAppearance(appearance: Appearance): void {
try { window.sessionStorage.setItem(chosenAppearanceKey(), appearance); } catch { /* Optional storage. */ }
}
/** The appearances a report captured, primary first; one or none means the report has no appearance switch. */
export function appearanceOptions(map: ExploreMap | undefined): Appearance[] {
if (!map) return [];
+8 -13
View File
@@ -56,17 +56,9 @@ export function isPreviewPath(pathname: string): boolean {
}
/**
* A hosted preview: one EAS Hosting deployment per review whose Worker serves this Viewer at
* `/p/<token>` and the decrypted report at `/p/<token>/report.zip`, for as long as the link is valid.
* The token of a hosted preview page, `/p/<token>`: one EAS Hosting deployment per review, whose Worker serves this
* Viewer there, each target's manifest at `/p/<token>/manifest.json`, and every screenshot as a static file.
*/
export function previewReportUrl(page: URL): string | undefined {
const match = PREVIEW_PATH.exec(page.pathname);
if (!match) return undefined;
const target = reportTarget(page);
return `/p/${match[1]}/report.zip${target ? `?${targetQuery(target)}` : ""}`;
}
/** The token of a hosted preview page, `/p/<token>`. */
export function previewToken(page: URL): string | undefined {
return PREVIEW_PATH.exec(page.pathname)?.[1];
}
@@ -76,9 +68,12 @@ export function previewManifestUrl(token: string, target?: string): string {
return `/p/${token}/manifest.json${target ? `?${targetQuery(target)}` : ""}`;
}
/** One asset of a hosted preview's report, `assets/<sha256>.<ext>` under `/p/<token>/`. */
export function previewAssetUrl(token: string, path: string, target?: string): string {
return `/p/${token}/${path}${target ? `?${targetQuery(target)}` : ""}`;
/**
* One asset of a hosted preview's report, a static file at `/p/<token>/assets/<sha256>.<ext>`. Named by its content, it
* is the same file for every target that shows it, so it carries no target.
*/
export function previewAssetUrl(token: string, path: string): string {
return `/p/${token}/${path}`;
}
/** The hosted preview's list of the targets it serves (`/p/<token>/reports.json`). */
+22
View File
@@ -221,6 +221,28 @@ export function canonicalRoute(route: Route, ctx: RouteContext): Route {
};
}
/** The query parameters that mean the same in another target's report of the run. */
const PLACE_PARAMS = ["inspect", "dir", "focus"] as const;
/**
* Where the reader is, as another target's report reads it: the canvas and the screen's route (which resolves to that
* target's screen recorded under it), the Inspector tab, the transition direction and the change filter. Screen ids,
* variants, baselines, evidence tabs and expanded groups belong to one report and are left behind.
*/
export function placeForAnotherTarget(hash: string): string {
if (!hash.startsWith("#/")) return "";
const at = hash.indexOf("?");
const path = at === -1 ? hash.slice(1) : hash.slice(1, at);
const params = new URLSearchParams(at === -1 ? "" : hash.slice(at + 1));
const kept = new URLSearchParams();
for (const key of PLACE_PARAMS) {
const value = params.get(key);
if (value) kept.set(key, value);
}
const search = kept.toString().replace(/%2C/gi, ",");
return `#${path}${search ? `?${search}` : ""}`;
}
/** Normalizes a route at the app boundary: Diff needs a baseline. */
export function sanitizeViewerRoute(route: Route): Route {
const requestedInspect = parseInspect(route.inspect) ?? "session";
+1 -11
View File
@@ -204,7 +204,7 @@ export class ReportSource {
let manifest: unknown;
try { manifest = JSON.parse(await new Blob(chunks).text()); }
catch { throw new ReportFileError("invalid", "The hosted report manifest is not valid JSON."); }
return ArtifactReportArchive.openManifest(manifest, path => previewAssetUrl(token, path, target));
return ArtifactReportArchive.openManifest(manifest, path => previewAssetUrl(token, path));
}
/** The Worker's answer for this link: the bytes, or why there are none. */
@@ -212,8 +212,6 @@ export class ReportSource {
let response = await fetch(url, { credentials: "same-origin" });
// A 503 is the Worker not reading the report this time; the next request usually does.
if (response.status >= 500) response = await fetch(url, { credentials: "same-origin" });
if (response.status === 410) throw new ReportFileError("invalid", `This preview link expired${await expiredOn(response)}. Download the report from the pull request or workflow run instead, or rerun Explore for a fresh link.`);
if (response.status === 413) throw new ReportFileError("too-large", "This report is too large to open from a hosted link. Download it from the pull request or workflow run instead, and drop it on the Viewer.");
if (response.status === 404) throw new ReportFileError("invalid", "This preview link is not valid, or its deployment was deleted. Ask for a new review, or download the report from the pull request or workflow run.");
if (!response.ok || !response.body) throw new ReportFileError("invalid", `The report could not be downloaded (HTTP ${response.status}).`);
const total = Number(response.headers.get("content-length")) || undefined;
@@ -302,11 +300,3 @@ function archiveTarget(archive: ArtifactReportArchive): string | undefined {
export const REPORT_SOURCE = new ReportSource(typeof window === "undefined" ? undefined : new URL(window.location.href));
/** " on Oct 10, 2026" from the 410 body's `expiredAt`, or "" when it is missing or malformed. */
async function expiredOn(response: Response): Promise<string> {
try {
const body = await response.json() as { expiredAt?: unknown };
const at = typeof body.expiredAt === "string" ? Date.parse(body.expiredAt) : Number.NaN;
return Number.isFinite(at) ? ` on ${new Date(at).toLocaleDateString("en-US", { month: "short", day: "numeric", year: "numeric", timeZone: "UTC" })}` : "";
} catch { return ""; }
}
+21
View File
@@ -25,6 +25,13 @@ export const APPLE = typeof navigator !== "undefined"
*/
export const CANVAS_NUMBER_KEYS = APPLE;
/**
* Whether Alt+1–8 reach the page. Browsers on Linux and ChromeOS keep them for their tabs; on Apple keyboards ⌥ only
* types a symbol (matching is on `event.code`, so that does not matter) and Windows browsers leave Alt+digits alone.
*/
export const TARGET_NUMBER_KEYS = APPLE
|| !(typeof navigator !== "undefined" && /Linux|X11|CrOS/.test(navigator.platform || navigator.userAgent));
function mod(code: string, key: string): Shortcut {
return { code, key, mod: true };
}
@@ -45,6 +52,10 @@ function plain(code: string, key: string): Shortcut {
return { code, key };
}
function alt(code: string, key: string): Shortcut {
return { code, key, alt: true };
}
// Keys follow what the reader already knows from other apps: ⌘B is VS Code's sidebar key (here the
// Changes menu), I is Figma's and Finder's info panel (here the inspector), and ⇧0/⇧1 are Figma's
// camera presets.
@@ -79,6 +90,16 @@ export const SHORTCUTS = {
fit: shift("Digit1", "1"),
center: shift("Digit2", "2"),
},
/**
* The run's other targets (devices, or platforms in reports from before targets). D opens their menu as ⌘B opens
* Changes, and ` returns to the last one shown, as ⌘` and Alt-Tab return to the last window.
*/
target: {
menu: plain("KeyD", "D"),
last: plain("Backquote", "`"),
},
/** A target by its place in the menu, as the canvases are numbered; the only digits left are ⌥'s. TARGET_NUMBER_KEYS only. */
targetByNumber: ["1", "2", "3", "4", "5", "6", "7", "8"].map(digit => alt(`Digit${digit}`, digit)),
/** Initials for the canvases; the shifted digits already belong to persistent canvas actions. */
canvas: {
map: plain("KeyM", "M"),