mirror of
https://github.com/expo/explore.git
synced 2026-11-15 13:18:16 -10:00
Compare commits
19
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2eb266159a | ||
|
|
362d5f2c4d | ||
|
|
29f1f0721f | ||
|
|
f620577e30 | ||
|
|
6c927b1f22 | ||
|
|
b72a70f7d8 | ||
|
|
fecf040ce5 | ||
|
|
e47399440f | ||
|
|
46b46bb184 | ||
|
|
942bdaad40 | ||
|
|
ed31b0c767 | ||
|
|
b1edd7ea81 | ||
|
|
50230b7f93 | ||
|
|
33f31da08e | ||
|
|
7fc0f34c9b | ||
|
|
6daf0a4391 | ||
|
|
1796a9b810 | ||
|
|
87aec5b820 | ||
|
|
89f18cad05 |
No files matched your search
@@ -67,9 +67,12 @@ jobs:
|
||||
shell: bash
|
||||
env:
|
||||
COMMENT_ID: ${{ steps.comment.outputs.id }}
|
||||
# How long an alias can keep serving the previous push: an EAS Hosting edge that served it keeps it for about
|
||||
# five minutes (FIXTURE_ALIAS_WAIT_MS in src/report/preview-deploy.ts).
|
||||
ALIAS_CATCH_UP: 5 minutes
|
||||
run: |
|
||||
set -euo pipefail
|
||||
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" '
|
||||
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" --arg catchup "$ALIAS_CATCH_UP" '
|
||||
.previewUrl as $url
|
||||
| ([.reports[] | select(.platform == "android")] + [.reports[] | select(.platform != "android")]) as $reports
|
||||
| ($reports[0].source // "") as $source
|
||||
@@ -85,6 +88,8 @@ jobs:
|
||||
| ((.label // (if .platform == "ios" then "iOS" else "Android" end)) | gsub("\\|"; "\\\\|")) as $name
|
||||
| "| \($name)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?\($query)) · [Screens](\($url)?\($query)#/screens) · [Compare](\($url)?\($query)&view=compare) |"),
|
||||
"",
|
||||
# The alias still served the previous push when the deploy stopped waiting for it: say so, and link the new deployment.
|
||||
(if .aliasBehind then "> **Going live:** this link can take up to \($catchup) to show \($sha); until then it shows the previous push, or nothing on a new pull request. [This push'"'"'s deployment](\(.deploymentUrl)/p/\($url | split("/p/")[1])) is live now.\n" else empty end),
|
||||
"The link stays the same on every push. [Deploy run](\($run))"]
|
||||
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
|
||||
if [[ -n "$COMMENT_ID" ]]; then
|
||||
|
||||
+82
-9
@@ -14,7 +14,7 @@ Source of truth: `templates/explore-review.yml`, `templates/explore-baseline.yml
|
||||
| Pipeline | `capture:review` → `runCiReview` | The same `runCiReview`, called directly |
|
||||
| EAS credentials | `EXPO_TOKEN` secret | Local `eas login` session or `EXPO_TOKEN` |
|
||||
| Model credentials (agent mode) | `ANTHROPIC_API_KEY` / `OPENAI_API_KEY` | Claude Code or Codex subscription login; API keys are removed from the subprocess |
|
||||
| Base cache | A baseline workflow artifact for the exact base SHA, when one exists | None; both sides are captured |
|
||||
| Base cache | A baseline workflow artifact for the exact base SHA, when one exists, or the baseline run still capturing it, waited for alongside head | None; both sides are captured |
|
||||
| Output | Report artifact + sticky PR comment with **Open** / **zip** | `runs/<id>/artifacts/report.zip` + `PR-comment.md`, opened with `ci:local:view` |
|
||||
|
||||
## 1. Installing Explore in an app repository
|
||||
@@ -49,16 +49,16 @@ Each workflow starts with a `targets` job: it installs the pinned CLI and runs `
|
||||
| | checkout `app-base`, `app-head` | Checks out the exact base and head SHAs with full history and without persisted credentials. |
|
||||
| | Verify deterministic source planning | `source:verify` builds the capture plan from source alone in two fresh processes and compares the bytes. Runs before any build or simulator work and needs no credentials. |
|
||||
| | Install app dependencies | `npm ci --ignore-scripts` in both checkouts (`APP_INSTALL_DIR` for monorepos). |
|
||||
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<target>` artifact (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
|
||||
| | Capture review | `capture:review` (§3). `EXPO_TOKEN`, the provider key and the app's `{{secret:NAME}}` values reach only this step. The sticky PR comment is updated while it runs. It writes `preview=<hosting>` to the step outputs, which decides whether the deploy job runs. |
|
||||
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a finished run's `explore-baseline-<base sha>-<target>` artifact (a run another target's baseline failed in counts: a baseline job uploads its artifact only after its own steps passed) (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. With none, it names a baseline run of the base commit still queued or capturing (`pending`), held to the same checks: the baseline workflow, the default branch of this repository, a `push` or `workflow_dispatch`, exactly the base SHA; nothing from the PR head selects it. Missing evidence and a failed lookup are not errors. |
|
||||
| | Capture review | `capture:review` (§3). With `EXPLORE_BASELINE_RUN` (the find step's `pending`) it waits for that run's baseline of this target (§3.1). `EXPO_TOKEN`, the provider key and the app's `{{secret:NAME}}` values reach only this step. The sticky PR comment is updated while it runs. It writes `preview=<hosting>` to the step outputs, which decides whether the deploy job runs. |
|
||||
| | Stop capture sessions and check the checkouts | `ci:after-capture`, whenever the PR was resolved, success or not: stops the EAS Simulator sessions named in `head-session` / `base-session`, nothing else, then fails with `CHECKOUT_MODIFIED` if capture modified an app checkout. |
|
||||
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<target>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<target>` keeps plans, exports and agent diagnostics for 7 days. |
|
||||
| report (matrix: target) | Install Explore, download the capture | Runs without Expo or model credentials. |
|
||||
| report (matrix: target) | Download the capture, install Explore | Runs without Expo or model credentials, after every capture job, whether or not each succeeded (`!cancelled()`). Each leg downloads its own target's capture by an exact-name pattern: a target whose capture failed uploaded none, so its leg packages and publishes nothing, and the other targets' reports still reach the comment. |
|
||||
| | Package hosted review bundle | `ci:report` writes the report directory. |
|
||||
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
|
||||
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
|
||||
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
|
||||
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
|
||||
| `deploy` (only when `report.preview` is set; after every report job, once any of them published) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every capture and report artifact the run has (a target whose capture or report job failed has none and is left out), writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
|
||||
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only each failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with (or, when download-artifact extracted a lone artifact without its directory, the `target` its `error.json` records), and its label comes from the record the capture job already posted. Once the other targets published, the comment shows their reports and this failure, with no new-run line. |
|
||||
|
||||
A reviewer downloads the report ZIP and drops it on the hosted Viewer; downloading needs read access to the repository.
|
||||
|
||||
@@ -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` 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.
|
||||
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`; its only GitHub requests are the wait for a baseline run still capturing the base (§3.1), with the job's `actions: read` token. 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`)
|
||||
|
||||
@@ -77,7 +77,7 @@ The same jobs as a PR review, for any `base` and `head` without a pull request.
|
||||
| 1 | `plan` | `buildVerifiedPlan`: snapshot both sources, compute the two-dot diff, run `plan-worker` twice with reversed input order and compare the canonical plans byte for byte. Summarises `sourceChange` per surface into `execution-plan.json`; the PR comment shows the planned capture count and warnings. | `SOURCE_ANALYSIS_FAILED`, inconsistent plan |
|
||||
| 2 | `preflight` | Checks `EXPO_TOKEN`. `prepareCiExploration`: nothing for deterministic mode; for agent mode, confirms the instructions file is committed, creates the provider session and makes one short tool-free model request. | `AGENT_API_KEY_MISSING`, `AGENT_INSTRUCTIONS_UNCOMMITTED`, `AGENT_MODEL_NOT_FOUND` |
|
||||
| 3 | `capture-head` | `runCiMap(head)` (§4). Records head's runtime profile and build. | `CAPTURE_*`, `SETUP_*`, `EAS_*` |
|
||||
| 4 | `capture-base` | Tries the cache first: a baseline is reused only when its recipe matches (tools, config, instructions, device, profile, observer hash, runtime profile). Only routes missing from the cache run through `runCiMap(base)`. | same |
|
||||
| 4 | `capture-base` | Tries the cache first: a baseline is reused only when its recipe matches (tools, config, instructions, device, profile, observer hash, runtime profile). Only routes missing from the cache run through `runCiMap(base)`. With no cache but a baseline run still capturing the base, base starts only once the wait for it ends (§3.1). | same |
|
||||
| 5 | `compare` | `assessPublicEvidence` compares pixels and accessibility for route pairs verified on both sides; `prepareCaptureReview` assigns verdicts (§6). | |
|
||||
| 6 | `capture-validation` | Every selected route was captured on both sides. | `CAPTURE_INCOMPLETE` |
|
||||
| 7 | `comparison-validation` | Every pair was compared visually and for accessibility. | `COMPARISON_INCOMPLETE` |
|
||||
@@ -86,6 +86,17 @@ The same jobs as a PR review, for any `base` and `head` without a pull request.
|
||||
|
||||
A failure at any stage is recorded in `state.failure`, a partial report is written when a plan exists, and the PR comment switches to the failed state.
|
||||
|
||||
### 3.1 Waiting for a baseline still being captured
|
||||
|
||||
Right after a merge, the next pull request's review starts while the baseline workflow is still capturing the new base: in brentvatne/euxy's review run 39348956443 it had started 15 s before, and every target captured its base too (10–14 minutes per target instead of about 6, on twice the EAS Simulator sessions). A baseline job takes 6–8 minutes and head capture 5–8, so `capture:review` waits for the baseline beside head instead of before it (`src/ci/baseline-wait.ts`):
|
||||
|
||||
1. The wait starts after preflight, only when `EXPLORE_BASELINE_RUN` names a run, no downloaded baseline matches, base has routes to capture, and `capture.baselineWaitMinutes` (default 15, 0 never waits) is not 0. Head starts capturing at once.
|
||||
2. Every 20 s it reads the run (checked again by the same trust rules as `ci:find-baseline`), this target's artifact (`explore-baseline-<sha>-<target>`) in that run, and the run's jobs, logging `waiting for main's baseline run <id> of <sha> (<target>: in progress, 3 min)` once a minute or when the state changes. Each read retries GitHub's 5xx and network failures (`retryGitHubLookup`).
|
||||
3. When the artifact is listed, it is downloaded in-process (the token goes to GitHub, never to the storage URL it redirects to), unpacked into `<output>/baseline-download` within the cache's size limits, and restored as a downloaded baseline once head has its runtime profile. Another target's failed job does not matter; each target's job uploads its own artifact.
|
||||
4. The wait ends without a baseline when this target's job fails, is cancelled or is skipped, the run ends without listing the artifact for a minute, the time runs out, GitHub refuses the token (`actions: read` missing) or keeps failing, or head fails. Base then captures at once, beside head when the sides capture concurrently. The wait never fails the review.
|
||||
|
||||
Head capture is never delayed. When the baseline arrives while head captures, base costs only its restore; when it does not, base starts the moment the wait gives up, so a failed baseline delays base only by the time it took to fail. Sessions are planned as without a wait: with a share of two or more, head keeps its half while base waits, so base can start in the rest; with one session, base follows head as before, and the wait may go on past head, up to its limit.
|
||||
|
||||
## 4. Capturing one side (`runCiMap`)
|
||||
|
||||
| # | Stage | Work |
|
||||
@@ -93,11 +104,73 @@ A failure at any stage is recorded in `state.failure`, a partial report is writt
|
||||
| 1 | cache | If a reuse directory exists, its bundle and map are validated and copied. With no routes left, skip straight to export. |
|
||||
| 2 | `configuration` | `eas config --profile` confirms the app identity and scheme, `ios.simulator: true` and the bundle ID; `eas simulator:availability`. |
|
||||
| 3 | `build` | `eas fingerprint:generate`; a finished simulator build with the same fingerprint is reused, otherwise `eas build --wait` (up to 45 minutes). |
|
||||
| 4 | `instrumentation` | A hosted EAS `repack` workflow job (`eas workflow:run --wait --json` from a staged copy of the checkout) rebundles the current JavaScript with a read-only navigation observer (the same observer on both sides), and the repacked app is downloaded and installed into the session; `capture.repack: local` (the default with `capture.simulator: local`) runs `@expo/repack-app` on the runner, and its app is installed without an upload. Generated files stay outside the checkout. |
|
||||
| 4 | `instrumentation` | A hosted EAS `repack` workflow job (`eas workflow:run --json` from a staged copy of the checkout, then its run read until it ends) rebundles the current JavaScript with a read-only navigation observer (the same observer on both sides), and the repacked app is downloaded and installed into the session; `capture.repack: local` (the default with `capture.simulator: local`) runs `@expo/repack-app` on the runner, and its app is installed without an upload. Generated files stay outside the checkout. Preparing the app has one 30-minute budget, a failed hosted repack starts again, and a run attempt's matrix jobs make one repack of each commit between them (§4.1). |
|
||||
| 5 | `session` | `eas simulator:start`; the session ID is written to `<side>-session`; the app is installed. |
|
||||
| 6 | route capture | Mode-specific (§5). `agent-device` drives the simulator and records a screenshot plus the accessibility tree. A capture is accepted only when the observer's reported destination matches the requested route. |
|
||||
| 7 | `export` / `cleanup` | Validate the map, write `<side>-export/` (`bundle.json`, `execution.json`, PNGs, `capture-diagnostics/`), stop the session. |
|
||||
|
||||
### 4.1 The hosted repack: one budget, retries, and one repack per commit for a run's jobs
|
||||
|
||||
`prepareHostedRepack` (`src/capture/eas-build.ts`) runs the repack job. Three things keep it from failing a target, running long, or repeating work.
|
||||
|
||||
**One budget.** Preparing the app gets 30 minutes (`HOSTED_REPACK_BUDGET_MS`), counted from the moment the EAS session starts beside the repack. That covers waiting for another job's repack, following it, and every repack this job starts, including each run's wait. Before this, each run had a 30-minute wait of its own, so a share wait plus retries could prepare for over an hour. The rules:
|
||||
|
||||
- A repack starts only when at least 5 minutes of the budget are left.
|
||||
- A run still going at the end of the budget is cancelled, and the target fails with `EAS_REPACK_FAILED` (`failure: timeout`).
|
||||
- The session was asked for the capture's minutes plus a 20-minute allowance (`SESSION_PREPARATION_MINUTES`). If the app took longer than the allowance, the session is stopped and a fresh one started before the install, so the capture keeps all its minutes. This counts as one of the session's replacements.
|
||||
|
||||
**Explore waits on the run itself.** `workflow:run` runs without `--wait`. Explore reads the run's id from the JSON, or from the "See logs:" link if the JSON is missing, then reads `eas workflow:view <id> --json` every 20 s. It does not use `--wait` because eas-cli 25.2.0's `--wait` exits with code 13 after six failed status reads and leaves the run going, and Explore then started another one beside it. Now:
|
||||
|
||||
- A run whose state stays unreadable six times in a row is cancelled (`eas workflow:cancel`). So is a run that outlasts the budget, or whose capture is stopped. None of them is replaced.
|
||||
- If the start times out, `defaultRunner` keeps what it printed. When that names the run, Explore waits on it. When it doesn't, Explore starts no other, because one may be running.
|
||||
- `capture:review` and `capture:baseline` turn the runner's SIGINT and SIGTERM, which GitHub sends to a cancelled job, into an abort. The capture then stops its session and cancels the run it waits on. A second signal quits at once.
|
||||
|
||||
**A failed repack starts again.** In brentvatne/euxy#176 (review run 39506405687), EAS ended a repack's build while its "Upload artifact" step was saving the app ("Turtle build is not in progress", reported as `Failed to upload application archive.`), and the target failed with `EAS_REPACK_FAILED`. Only a run EAS reports finished can be followed by another. `hostedRepackFailure` reads the build's error, the job's errors, the failed step's logs (`eas workflow:logs <job> --json`) and the CLI's output, in this order:
|
||||
|
||||
| Failure | Read from | Fresh repacks |
|
||||
| --- | --- | --- |
|
||||
| `canceled` | a run someone cancelled | 0 |
|
||||
| `configuration` | `Not logged in`, `Unauthorized`, `not authorized`, `E401`/`E403`, `401 Unauthorized`/`403 Forbidden` (a private registry's included) | 0 |
|
||||
| `infrastructure` | a file of EAS's worker missing (`'/opt/eas/…'`) | 2 |
|
||||
| `app` | the `Repack` / `Repack app` step failed, or Metro, Babel or Expo named the app's code or files: `Unable to resolve`, `SyntaxError`, `TransformError`, `Cannot find module`, `could not read ./…` | 0 |
|
||||
| `timeout` | `EAS_BUILD_TIMEOUT_ERROR`: a rerun would run out its time again (a bundling hang, say) | 0 |
|
||||
| `infrastructure` | a failed `Spin up…`, `Set up…`, `Download…` or `Upload…` step; EAS's or eas-cli's exact words (`Turtle build is not in progress`, `Failed to upload application archive`, `SERVER_ERROR`, `Failed to upload project sources`, `Failed to start the workflow with the API`, `Unexpected response from server (5xx)`, `ECONNRESET`, `ETIMEDOUT`, `ENOTFOUND`, `EAI_AGAIN`, `socket hang up`, `fetch failed`) | 2 |
|
||||
| `unknown` | nothing above | 1 |
|
||||
|
||||
Each new start logs the failed run's link and reason, for example `the hosted EAS repack https://expo.dev/…/workflows/<id> failed (…); starting another repack (1/2)`. The session is started once, beside the first repack, and installs whichever repack succeeds.
|
||||
|
||||
**One repack per commit for a run attempt's matrix jobs.** Captures that run in one process already share a build in a directory (`src/capture/shared-build.ts`): the appearance passes of one side, which run in worker threads, and the targets of a local review. The first to claim a key builds and repacks, and the others wait for its `result.json` ("using the build another capture of this run is preparing for this commit"). A GitHub matrix job is a runner of its own, with no directory in common, so in #176 the four iOS jobs each logged `reusing EAS build a81d5d80 … repacking it with this commit's JavaScript` and made four identical repacks. The jobs of one run attempt meet on EAS instead:
|
||||
|
||||
1. `hostedRepackPeers` lists, in config order, the targets that repack the same app on EAS: one platform, EAS profile and bundle id. `capture:review`, `capture:review --compare` and `capture:baseline` pass them on.
|
||||
- A capture gets a `RepackShare` when it has two or more peers and `GITHUB_RUN_ID`, `GITHUB_RUN_ATTEMPT` and `GITHUB_REPOSITORY` are set. Its scope is the run attempt, its leader is the first peer, and its rank is its place among the peers.
|
||||
- A single target, a local review, `capture.repack: local`, and a native build this job made itself behave as before. Nobody else's key can match a native build this job made.
|
||||
2. The build to repack is the newest finished build with the fingerprint that Explore did not repack itself (`existingBuild`, from 20 builds). If repacks carry their source's fingerprint, every job still picks the same build.
|
||||
3. Once the copy is staged, the capture takes a key (`hostedRepackShareKey`) from:
|
||||
- the run attempt, the platform and the native build id;
|
||||
- the EAS profile and environment name;
|
||||
- a snapshot of the environment's variables: `eas env:list --format long` for the project and the account, which names each variable with its value (masked when sensitive or secret) and when it was last updated;
|
||||
- the Explore release;
|
||||
- a digest of every staged file with its path, executable bit and content (`stagedProjectDigest`), which covers the commit's JavaScript and the generated observer.
|
||||
|
||||
If either variable list fails, the capture repacks without sharing. Its own repack's message ends with `[explore share <key>]`.
|
||||
4. It reads the platform's 50 most recent builds (`eas build:list --limit 50 --json`, a single page) for one whose message ends with that marker, and joins any it finds, whichever job started it. A finished one is downloaded instead of repacking. A queued or running one is then read by its id (`eas build:view <id> --json`) every 30 s, so newer builds on a busy project cannot push it off the list.
|
||||
5. How long a capture looks is staggered (`sharedRepackWaitMs`). The leader looks once and repacks if it finds nothing. The next target looks every 15 s for 3 minutes, and each target after it a minute longer. When the leader makes no repack (its baseline covered every route, or `max-parallel` kept it out of the first jobs), the next target's repack appears before the one after it would start another, so they all join one. In a re-run attempt, which runs only the jobs it re-runs, the stagger starts at once (1, 2, 3 minutes).
|
||||
6. When the repack it follows fails, is cancelled or loses the key, the capture looks for another with the same key for 60 s, staggered the same way, before it repacks itself. That catches the leader's retry, which starts at once (#176).
|
||||
7. It also repacks itself, with the retries above, when nothing appears in its wait, or when EAS fails to answer three times in a row. Looking stops while the budget still has 5 minutes for a repack of its own. A followed repack that does not finish within the budget fails the target. No capture waits on a job that cannot answer, and none waits past its budget.
|
||||
|
||||
Only a build whose marker is this capture's own key is used, and every input to the key is what this capture would itself have uploaded and built with. So two jobs share a repack only when their uploads, native build, profile, environment variables and Explore release are the same, in the same run attempt. The run attempt is in the scope, and a review's or a first attempt's repacks are never used by another run or attempt. That covers the baseline workflow, whose artifacts later reviews reuse, and "Re-run failed jobs" after an `EXPO_PUBLIC_*` value was fixed, which rebundles with the new value.
|
||||
|
||||
What the key does not protect against: every input to it is public or predictable, and the pull request's head code runs in the capture job with `EXPO_TOKEN` (`app.config.*` under `eas config` and `eas fingerprint:generate`, and the app's build code on EAS). Head code could therefore make a build whose message carries the base side's marker, and base captures of the same run attempt in other matrix jobs would install it. That is within the trust the capture already gives EAS: the same credentials could publish a simulator build with a reused fingerprint, which every capture already reuses by fingerprint (the `build` stage above), and head code in one job can already tamper with that job's own base side on the runner. The run attempt in the scope keeps such a build out of every other run, including the baseline. Requiring the build's `initiatingActor` to be this job's own credentials would not exclude head code, which runs with the same token. Explore cannot tell offline which actor EAS records for a workflow's repack build, so it does not check it.
|
||||
|
||||
Cost, per side and job:
|
||||
|
||||
- The leader makes 1 `build:list` and 2 `env:list`.
|
||||
- A follower makes up to 13 `build:list` while the next target waits, plus 4 more per target after it.
|
||||
- About 2 `build:view` a minute while it follows a repack: about 10 for a 5-minute repack.
|
||||
- Each repack this job runs reads its run every 20 s: about 15 `workflow:view` for 5 minutes, and one `workflow:logs` if it fails.
|
||||
|
||||
In #176's run that is about 20 calls per side for each of the three iOS targets that would otherwise have repacked, in place of three repacks. A follower whose leader and earlier peers make no repack of this side loses its wait, 3 to 5 minutes, before it repacks itself. Native builds are not shared across jobs: a fingerprint EAS has no build for is built by every job that needs it.
|
||||
|
||||
## 5. Deterministic and agent modes
|
||||
|
||||
| | Deterministic | Agent |
|
||||
|
||||
@@ -19,17 +19,21 @@ Explore maps your app: a screenshot of every screen, connected by the taps betwe
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%" valign="top">
|
||||
<a href="docs/screenshots/readme-screens-light.png">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-screens-dark.png">
|
||||
<img width="100%" alt="The Screens view of a euxy review showing Changed 7 of All 19: the app/ route tree on the left, and beside it a grid of the changed screens in the same order, each with its route below the screenshot: a red dot for the removed /lane-editor, orange for the modified /new-pattern and /channel-surf, green for the new /lane-editor/0, and Changed in dark under /p and /patterns" src="docs/screenshots/readme-screens-light.png">
|
||||
</picture>
|
||||
</a>
|
||||
<strong>Screens</strong>: every capture in one grid, or only the changed ones, beside the route tree, with a dot for what changed.
|
||||
</td>
|
||||
<td width="50%" valign="top">
|
||||
<a href="docs/screenshots/readme-pr-comment-light.png">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-pr-comment-dark.png">
|
||||
<img width="100%" alt="Explore's GitHub PR comment on a euxy PR: the heading 2 screens changed with a Review in Explore link; a line of links to each device's report (iPhone 17, three iPhone Duo poses and Android) and to the two commits compared; then the changed screens as a list, /tempo with the text it added and the devices it is on, fading out below" src="docs/screenshots/readme-pr-comment-light.png">
|
||||
</picture>
|
||||
</a>
|
||||
<strong>A comment on every PR</strong>: with <a href="#set-up-ci">CI</a>, the report links and the added, removed and modified screens.
|
||||
</td>
|
||||
</tr>
|
||||
@@ -194,6 +198,41 @@ npx @expo/explore explore:session <session-id> --env-file path/.env.eas-simulato
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Take the same steps on every run and device</strong></summary>
|
||||
|
||||
A model picks its own path, so two runs (or an iPhone and an Android phone) can reach different screens. To get the same screens every time, write the steps down once, for example after a model run showed you the app, and pass them with `--replay`. No model login or API key is needed.
|
||||
|
||||
```sh
|
||||
npx @expo/explore explore:binary ./my-app.app --replay steps.json
|
||||
npx @expo/explore explore:session --replay steps.json # an iPhone Duo pose, or any session you set up by hand
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"steps": [
|
||||
{ "capture": "Home" },
|
||||
{ "action": "tap", "label": "Settings" },
|
||||
{ "capture": "Settings" },
|
||||
{ "action": "tap", "label": "Dark" },
|
||||
{ "capture": "Settings", "state": "dark" },
|
||||
{ "action": "tap", "label": "Learn", "platforms": ["ios"] },
|
||||
{ "capture": "Learn", "platforms": ["ios"] },
|
||||
{ "action": "tap", "label": "Got it", "optional": true }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- An action is one of `tap` or `fill` (with `label` or `identifier`), `type`, `scroll` (`direction`), `wait` (`milliseconds`), `open` (`url`), `back`, and `dismiss-keyboard`, as in the model's own tools. The same safety rules apply: destructive or app-leaving taps are refused. A step takes only the fields listed here; any other field (a typo such as `platform`) is an error.
|
||||
- `{ "capture": "Title" }` photographs the current screen under that title; add `"state"` for another state of a screen already captured. A capture of a screen the plan already captured under another title is reported as looking the same, and the screen keeps its first title.
|
||||
- `"platforms": ["ios"]` limits a step to those platforms, for screens one platform does not have. `"optional": true` skips an action that fails (a one-time dialog) instead of stopping; the summary lists the steps it skipped.
|
||||
- A `fill` or `type` text can be a `{{secret:NAME}}`, as in `--hints`: Explore types the value of the environment variable `NAME`, and a variable that is not set fails before a device starts.
|
||||
- If a required action fails, the run stops there and the report still shows what was captured, with a gap naming the step and the screens it did not reach.
|
||||
- The screen and action budgets still apply. A plan with more captures or actions than they allow is refused before a device starts, as is one with no steps for the platform; raise `--max-screens` and `--max-actions` for a long plan. If a budget still runs out (each screen the plan reaches also counts), the gap names the planned screens not reached.
|
||||
- `--provider`, `--model` and `--hints` only steer a model, so they cannot be combined with `--replay`.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>What a run without source shows</strong></summary>
|
||||
|
||||
@@ -453,7 +492,7 @@ jobs:
|
||||
- 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; a hosted link lasts as long as its EAS Hosting deployment (an aliased one until the alias moves).
|
||||
- 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. When it is still capturing `base` (right after a merge), the review waits for it while `head` captures, up to `capture.baselineWaitMinutes` (15 by default). 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>
|
||||
|
||||
|
||||
@@ -105,6 +105,7 @@ capture:
|
||||
maxActions: 500
|
||||
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
|
||||
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
|
||||
# baselineWaitMinutes: 15 # a review that starts while the default branch's baseline run of its base commit is still capturing (right after a merge) waits up to this long for that target's baseline instead of capturing the base too (default 15; 0 never waits). Head captures meanwhile; base waits only where it would start, and captures itself if the baseline job fails or is cancelled, or the time runs out.
|
||||
repack: eas # eas (hosted workflow job; the default on EAS Simulator) | local (repack-app on the runner; the default with simulator: local)
|
||||
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
|
||||
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
|
||||
|
||||
@@ -111,6 +111,7 @@ capture:
|
||||
maxActions: 500
|
||||
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
|
||||
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
|
||||
# baselineWaitMinutes: 15 # a review that starts while the default branch's baseline run of its base commit is still capturing (right after a merge) waits up to this long for that target's baseline instead of capturing the base too (default 15; 0 never waits). Head captures meanwhile; base waits only where it would start, and captures itself if the baseline job fails or is cancelled, or the time runs out.
|
||||
repack: eas # eas (hosted EAS workflow job, the default on EAS Simulator) | local (repack-app on the runner, the default with simulator: local; --repack overrides it for one run)
|
||||
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
|
||||
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
|
||||
@@ -217,7 +218,7 @@ exploration:
|
||||
- /c/[channel]
|
||||
```
|
||||
|
||||
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the map and the screen counts, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
|
||||
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the report (the Map, Screens, search and the screen counts), and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
|
||||
|
||||
Capture handles iOS's confirmation to open a link in the expected app. After a form submits a password, iOS may offer to save or update it depending on the simulator's AutoFill state; capture declines that prompt with Not Now in both modes, never stores the credential, and records each decision in `capture-diagnostics/system-prompts.jsonl`. Do not script that tap in setup. Include required system-alert handling in setup or app instructions; Explore does not automatically grant application permissions.
|
||||
|
||||
@@ -391,7 +392,7 @@ The review workflow resolves the current PR through GitHub, checks out its exact
|
||||
| Review packaging | The bundle contains metadata and assets, not a standalone HTML page |
|
||||
| Publication | The artifact is uploaded before current-PR identity is checked again and the **Open** and **zip** links are posted |
|
||||
|
||||
The baseline workflow runs on default-branch pushes or manual default-branch dispatch. It captures one complete commit without needing a PR. Reports and baselines are retained for 30 days; intermediate evidence and diagnostics for 7 days.
|
||||
The baseline workflow runs on default-branch pushes or manual default-branch dispatch. It captures one complete commit without needing a PR. A review that starts while the baseline of its base commit is still being captured, as the next pull request's review does right after a merge, waits for it (`capture.baselineWaitMinutes`, 15 minutes by default) while head captures, instead of capturing the base too. Reports and baselines are retained for 30 days; intermediate evidence and diagnostics for 7 days.
|
||||
|
||||
`exploration.scope: changes` includes source-affected routes and the routes one navigation step before or after them, so a reviewer sees how each change is reached and where it leads. The context is not transitive: in most apps tabs, guards and Home connect every screen, so all ancestors and descendants would be the whole app. A layout or screen guard that sends every signed-out screen to sign-in is not a step. Forwarding routes have no screenshot of their own, so their redirect chains are followed to the first screen. Unresolved navigation still selects every route. `all` captures the full inventory.
|
||||
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.20.0",
|
||||
"version": "0.20.5",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@expo/explore",
|
||||
"version": "0.20.0",
|
||||
"version": "0.20.5",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/repack-app": "0.10.1",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.20.0",
|
||||
"version": "0.20.5",
|
||||
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
|
||||
@@ -202,6 +202,15 @@
|
||||
"mimeType": { "type": "string", "minLength": 1 },
|
||||
"width": { "type": "integer", "minimum": 0 },
|
||||
"height": { "type": "integer", "minimum": 0 },
|
||||
"turned": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["width", "height"],
|
||||
"properties": {
|
||||
"width": { "type": "number", "exclusiveMinimum": 0 },
|
||||
"height": { "type": "number", "exclusiveMinimum": 0 }
|
||||
}
|
||||
},
|
||||
"createdAt": { "$ref": "#/$defs/timestamp" }
|
||||
}
|
||||
},
|
||||
|
||||
@@ -33,6 +33,10 @@ Platform, bundle id, app name and version are read from the archive; do not pass
|
||||
|
||||
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"`.
|
||||
|
||||
## The same steps on every run: `--replay`
|
||||
|
||||
To compare runs, or an iPhone with an Android phone, screen for screen, pass `--replay steps.json` to `explore:binary` or `explore:session`: Explore takes the steps in the file instead of a model's, and no model access is needed. The format is in the README ("Take the same steps on every run and device"): `{ "steps": [{ "capture": "Home" }, { "action": "tap", "label": "Settings" }, { "capture": "Settings" }] }`, with `platforms` to limit a step and `optional` for an action that may fail. The plan is checked before a device starts: unknown fields, a plan with no steps for the platform, more captures or actions than `--max-screens` / `--max-actions`, and a `{{secret:NAME}}` in a `fill` or `type` whose variable is not set are all refused (`REPLAY_PLAN_INVALID`, `REPLAY_PLAN_EMPTY`, `REPLAY_PLAN_OVER_BUDGET`, `EXPLORATION_SECRET_MISSING`). `--provider`, `--model` and `--hints` cannot be combined with it (`REPLAY_OPTIONS_IGNORED`).
|
||||
|
||||
## Sign-in and other app state
|
||||
|
||||
Without help, the model treats a sign-in wall as the end of the road: it captures it and stops (`blocked`). Before running, read what you can about the app (its source if you have it, its first screens otherwise) and decide what it needs.
|
||||
|
||||
@@ -34,7 +34,7 @@ node scripts/readme-screenshots.mjs --report ~/euxy-report/iphone.zip --select /
|
||||
- `--select` is the route the hero's pointer clicks on the Map (the Inspector opens on it): choose an added or clearly modified screen. The script zooms in around it, so it must be a screen the Map shows.
|
||||
- `--compare` is the key in the Viewer's `#/compare/<key>` URL for a **modified** screen with outlined regions (open the report, click the screen in Compare, copy the key): the route without its slash. The script fails if the report has no visually modified screen at that route.
|
||||
- `--pr` screenshots the Explore comment on that PR: the fixtures' `source`, or a newer euxy PR when that comment predates the current layout. `--only pr-comment --pr <url>` rewrites only the comment pictures (it needs no `--report`); `--only` takes any of `hero`, `compare`, `screens` and `pr-comment`. Headless Chromium needs a colour emoji font for the result glyphs (`sudo apt-get install fonts-noto-color-emoji` on Debian/Ubuntu); a comment with hollow boxes where 🟩 should be is not acceptable.
|
||||
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` file for every picture (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right.
|
||||
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` file for every picture (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right. The Screens and PR comment pictures, shown at half the column, are each wrapped in an `<a>` to their light PNG so a reader can open them full size; GitHub links a plain Markdown image itself, but not a `<picture>`.
|
||||
|
||||
Two of the pictures are animated SVGs, built by `scripts/readme-animations.mjs` in the same run; there is nothing else to run when the screenshots change:
|
||||
|
||||
|
||||
+59
-27
@@ -7,6 +7,7 @@ import type { CaptureSetupAction } from "../config/explore-config.js";
|
||||
import { createExplorationInputs, explorationSecretNames } from "../config/exploration-inputs.js";
|
||||
import type { ExploreStore, PreparedArtifact } from "../map/store.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { turnedClockwise } from "../shared/png-evidence.js";
|
||||
import type { ActionKind, ActionRisk, Artifact, Controller, ElementRole, ExploreMap, ObservedElement, Observation, Screen } from "../types.js";
|
||||
|
||||
/** One look at the device: accessibility always, a PNG when the host could take a safe one. */
|
||||
@@ -21,13 +22,15 @@ export type BlackBoxFrame = {
|
||||
imageUnavailable?: { code: string; message: string };
|
||||
/** The foreground app differed from the explored one; the host already brought it back. */
|
||||
leftApp?: boolean;
|
||||
/** The image is on a portrait panel's axes under a landscape UI (an opened iPhone Duo), as the tree is; the report stores it turned upright. */
|
||||
landscape?: boolean;
|
||||
};
|
||||
|
||||
export type BlackBoxAction = CaptureSetupAction | { action: "back" } | { action: "dismiss-keyboard" } | { action: "type"; text: string }
|
||||
| { action: "tap"; frameId: string; x: number; y: number };
|
||||
|
||||
export type BlackBoxExplorerOptions = {
|
||||
session: CiAgentSession;
|
||||
session: Pick<CiAgentSession, "run">;
|
||||
store: ExploreStore;
|
||||
map: ExploreMap;
|
||||
app: { name: string; bundleId: string; platform: "ios" | "android"; version?: string };
|
||||
@@ -49,6 +52,8 @@ export type BlackBoxExplorerOptions = {
|
||||
appIcon?: Buffer;
|
||||
/** App-test inputs the operator hints reference as {{secret:NAME}}: the model and the map only ever hold the reference. */
|
||||
inputs?: ReturnType<typeof createExplorationInputs>;
|
||||
/** A sentence a budget stop's gap adds to its own, read once the session has stopped: a replay names the planned screens it did not reach. */
|
||||
budgetNote?: () => string | undefined;
|
||||
};
|
||||
|
||||
export type BlackBoxExplorerResult = {
|
||||
@@ -67,6 +72,12 @@ const EXTERNAL = /\b(open in|safari|chrome|browser|app store|play store|share|ma
|
||||
const VOLATILE = /\d|[:%$€£]|\b(am|pm)\b/gi;
|
||||
const INTERACTIVE = new Set(["button", "link", "cell", "switch", "tab", "menuitem", "textfield", "securetextfield", "searchfield", "textview", "edittext", "slider", "checkbox", "radiobutton", "segmentedcontrol", "toggle"]);
|
||||
|
||||
/** What the tools accept: their schemas, the checks on each call, and a replay plan checked before any device starts share these. */
|
||||
export const TOOL_LIMITS = { selector: 512, text: 2000, url: 2000, waitMs: 15_000, title: 80, state: 80, description: 500, summary: 4000, reason: 1000 } as const;
|
||||
|
||||
/** A screen seen after an action but never named keeps this title until the run ends and names it after the path to it. */
|
||||
export const isPlaceholderTitle = (title: string): boolean => /^Screen \d+$/.test(title);
|
||||
|
||||
const selectorProperties = {
|
||||
label: { type: "string", description: "Exact visible label of the target node, copied from the latest observation." },
|
||||
identifier: { type: "string", description: "Exact accessibility identifier of the target node, when it has one." },
|
||||
@@ -81,22 +92,22 @@ const tools: CiAgentTool[] = [
|
||||
inputSchema: { type: "object", properties: {
|
||||
action: { type: "string", enum: ["tap", "fill", "type", "scroll", "wait", "back", "dismiss-keyboard", "open"] },
|
||||
...selectorProperties,
|
||||
text: { type: "string", maxLength: 2000 }, url: { type: "string", maxLength: 2000 },
|
||||
text: { type: "string", maxLength: TOOL_LIMITS.text }, url: { type: "string", maxLength: TOOL_LIMITS.url },
|
||||
direction: { type: "string", enum: ["up", "down", "left", "right", "top", "bottom"] },
|
||||
milliseconds: { type: "integer", minimum: 1, maximum: 15_000 },
|
||||
milliseconds: { type: "integer", minimum: 1, maximum: TOOL_LIMITS.waitMs },
|
||||
frameId: { type: "string", description: "For a coordinate tap only: the latest observed frame." },
|
||||
x: { type: "number", minimum: 0, exclusiveMaximum: 1 }, y: { type: "number", minimum: 0, exclusiveMaximum: 1 },
|
||||
target: { type: "string", minLength: 1, maxLength: 80, description: "For a coordinate tap: what is being tapped, as a user would name it (\"search icon in the header\", \"first manga cover\")." },
|
||||
}, required: ["action"], additionalProperties: false } },
|
||||
{ name: "capture", description: "Name the latest observed frame (observe with includeImage) as a screen of the map, with a short human title. A screen is photographed the moment it first appears; capture gives it its title, and with state records another notable state of it.",
|
||||
inputSchema: { type: "object", properties: {
|
||||
frameId: { type: "string" }, title: { type: "string", minLength: 1, maxLength: 80 },
|
||||
description: { type: "string", maxLength: 500 }, state: { type: "string", maxLength: 80, description: "A variant of an already captured screen, such as 'empty' or 'menu open'." },
|
||||
frameId: { type: "string" }, title: { type: "string", minLength: 1, maxLength: TOOL_LIMITS.title },
|
||||
description: { type: "string", maxLength: TOOL_LIMITS.description }, state: { type: "string", maxLength: TOOL_LIMITS.state, description: "A variant of an already captured screen, such as 'empty' or 'menu open'." },
|
||||
}, required: ["frameId", "title"], additionalProperties: false } },
|
||||
{ name: "finish", description: "End the exploration when every reachable screen has been captured or the budget is nearly used. Include a summary of what the app does and what was not reached.",
|
||||
inputSchema: { type: "object", properties: { summary: { type: "string", minLength: 1, maxLength: 4000 } }, required: ["summary"], additionalProperties: false } },
|
||||
inputSchema: { type: "object", properties: { summary: { type: "string", minLength: 1, maxLength: TOOL_LIMITS.summary } }, required: ["summary"], additionalProperties: false } },
|
||||
{ name: "stop_blocked", description: "Stop because the app cannot be explored further (login wall without credentials, crash loop, permission prompt that cannot be dismissed). Keeps the evidence so far.",
|
||||
inputSchema: { type: "object", properties: { reason: { type: "string", minLength: 1, maxLength: 1000 } }, required: ["reason"], additionalProperties: false } },
|
||||
inputSchema: { type: "object", properties: { reason: { type: "string", minLength: 1, maxLength: TOOL_LIMITS.reason } }, required: ["reason"], additionalProperties: false } },
|
||||
];
|
||||
|
||||
const INSTRUCTIONS = `You are exploring a prebuilt mobile app on a remote simulator through accessibility and screenshots. Nobody gave you its source. Your job is to produce a map of its screens: visit every reachable screen, capture each one once with a clear title, and try each distinct kind of control so transitions are recorded.
|
||||
@@ -412,7 +423,7 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
}
|
||||
|
||||
/** Seen after an action but never named by the model (its screenshot was taken on arrival). */
|
||||
const isPlaceholder = (screen: Screen): boolean => /^Screen \d+$/.test(screen.title);
|
||||
const isPlaceholder = (screen: Screen): boolean => isPlaceholderTitle(screen.title);
|
||||
/** Fold an uncaptured placeholder into the screen the model says it is. */
|
||||
const mergeScreens = (from: Screen, into: Screen): void => {
|
||||
for (const item of map.actionAttempts) {
|
||||
@@ -437,8 +448,22 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
if (currentScreenId === from.id) currentScreenId = into.id;
|
||||
};
|
||||
|
||||
const screenWithImage = (png: Buffer, except: Screen): Screen | undefined => {
|
||||
const sha = createHash("sha256").update(png).digest("hex");
|
||||
/**
|
||||
* The bytes a frame's screenshot is stored as, and their digest: an opened Duo's frame is turned upright once, however
|
||||
* often the frame is looked up or recorded. Keyed by the image, which every copy of the frame shares.
|
||||
*/
|
||||
const storedImages = new WeakMap<Buffer, { png: Buffer; sha256: string }>();
|
||||
const storedImage = (image: Buffer, landscape: boolean): { png: Buffer; sha256: string } => {
|
||||
let stored = storedImages.get(image);
|
||||
if (!stored) {
|
||||
const png = landscape ? turnedClockwise(image) : image;
|
||||
stored = { png, sha256: createHash("sha256").update(png).digest("hex") };
|
||||
storedImages.set(image, stored);
|
||||
}
|
||||
return stored;
|
||||
};
|
||||
|
||||
const screenWithImage = (sha: string, except: Screen): Screen | undefined => {
|
||||
const artifact = map.artifacts.find(item => item.kind === "screenshot" && item.sha256 === sha);
|
||||
if (!artifact) return undefined;
|
||||
const controls = structural(evidence.get(except.id)?.parts ?? new Set());
|
||||
@@ -491,7 +516,7 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
screen = { id: `scr_${key.slice(0, 16)}`, title: title ?? systemDialogTitle(frame.nodes) ?? `Screen ${map.screens.length + 1}`, start: map.screens.length === 0, terminal: false,
|
||||
depth, firstSeenAt: frame.capturedAt, lastSeenAt: frame.capturedAt, visits: 0, variantIds: [], observationIds: [], elementIds: [] };
|
||||
map.screens.push(screen); screensByKey.set(key, screen);
|
||||
} else if (title && /^Screen \d+$/.test(screen.title)) screen.title = title;
|
||||
} else if (title && isPlaceholderTitle(screen.title)) screen.title = title;
|
||||
screen.visits += 1; screen.lastSeenAt = frame.capturedAt;
|
||||
const seen = evidence.get(screen.id) ?? { parts: new Set<string>(), loadingOnly: true };
|
||||
for (const part of loose) seen.parts.add(part);
|
||||
@@ -529,11 +554,13 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
let screenshotArtifactId: string | undefined;
|
||||
if (withImage && frame.png) {
|
||||
// Hashed here rather than trusting the daemon's digest: the report validates artifacts against their bytes.
|
||||
const png = frame.png, sha = createHash("sha256").update(png).digest("hex");
|
||||
const { png, sha256: sha } = storedImage(frame.png, frame.landscape === true);
|
||||
const extent = frame.landscape ? frameExtent(frame.nodes) : undefined;
|
||||
let artifact = map.artifacts.find(item => item.kind === "screenshot" && item.sha256 === sha);
|
||||
if (!artifact) {
|
||||
artifact = { id: `art_${randomUUID().slice(0, 12)}`, kind: "screenshot" as const, path: `artifacts/screenshots/${sha}.png`, sha256: sha,
|
||||
bytes: png.length, mimeType: "image/png", ...(frame.width ? { width: frame.width } : {}), ...(frame.height ? { height: frame.height } : {}), createdAt: frame.capturedAt };
|
||||
bytes: png.length, mimeType: "image/png", ...(frame.width && frame.height ? frame.landscape ? { width: frame.height, height: frame.width } : { width: frame.width, height: frame.height } : {}),
|
||||
...(extent ? { turned: extent } : {}), createdAt: frame.capturedAt };
|
||||
map.artifacts.push(artifact); prepared.push({ artifact, bytes: png, destination: join(store.root, artifact.path) });
|
||||
}
|
||||
screenshotArtifactId = artifact.id;
|
||||
@@ -599,7 +626,7 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
// The same pixels as a screen already seen, with the same controls, is that screen: a tree read while Android was
|
||||
// still exposing a text node (AudioScape's playlist title missing from one read of two identical frames) is not new.
|
||||
if (created && latest.png) {
|
||||
const twin = screenWithImage(latest.png, screen);
|
||||
const twin = screenWithImage(storedImage(latest.png, latest.landscape === true).sha256, screen);
|
||||
if (twin) { mergeScreens(screen, twin); screen = twin; created = false; }
|
||||
}
|
||||
// Every screen gets an observation the moment it is seen, so elements and action attempts always point at a
|
||||
@@ -625,7 +652,7 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
|
||||
const actionFor = (input: Record<string, unknown>): { action: BlackBoxAction; kind: ActionKind; label: string; risk: ActionRisk } => {
|
||||
const action = String(input.action);
|
||||
const selector = input.identifier !== undefined ? { identifier: text(input.identifier, "identifier", 512) } : input.label !== undefined ? { label: text(input.label, "label", 512) } : undefined;
|
||||
const selector = input.identifier !== undefined ? { identifier: text(input.identifier, "identifier", TOOL_LIMITS.selector) } : input.label !== undefined ? { label: text(input.label, "label", TOOL_LIMITS.selector) } : undefined;
|
||||
const label = selector ? ("identifier" in selector ? selector.identifier : selector.label) : action;
|
||||
const risk = selector ? riskOf(label, allow) : "safe";
|
||||
switch (action) {
|
||||
@@ -637,13 +664,13 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
}
|
||||
if (!selector) throw failure("AGENT_ACTION_INVALID", "tap needs a label, an identifier, or frame coordinates.");
|
||||
return { action: { action: "tap", ...selector } as BlackBoxAction, kind: "press", label, risk };
|
||||
case "fill": if (!selector) throw failure("AGENT_ACTION_INVALID", "fill needs a label or identifier."); return { action: { action: "fill", text: text(input.text, "text", 2000), ...selector } as BlackBoxAction, kind: "fill", label, risk };
|
||||
case "type": return { action: { action: "type", text: text(input.text, "text", 2000) }, kind: "fill", label: "type", risk: "safe" };
|
||||
case "fill": if (!selector) throw failure("AGENT_ACTION_INVALID", "fill needs a label or identifier."); return { action: { action: "fill", text: text(input.text, "text", TOOL_LIMITS.text), ...selector } as BlackBoxAction, kind: "fill", label, risk };
|
||||
case "type": return { action: { action: "type", text: text(input.text, "text", TOOL_LIMITS.text) }, kind: "fill", label: "type", risk: "safe" };
|
||||
case "scroll": return { action: { action: "scroll", direction: input.direction as "up" }, kind: "swipe", label: `scroll ${String(input.direction)}`, risk: "safe" };
|
||||
case "wait": return { action: { action: "wait", milliseconds: Number(input.milliseconds) || 1000 }, kind: "other", label: "wait", risk: "safe" };
|
||||
case "back": return { action: { action: "back" }, kind: "back", label: "back", risk: "safe" };
|
||||
case "dismiss-keyboard": return { action: { action: "dismiss-keyboard" }, kind: "dismiss", label: "dismiss keyboard", risk: "safe" };
|
||||
case "open": return { action: { action: "open", url: text(input.url, "url", 2000) }, kind: "deep-link", label: text(input.url, "url", 2000), risk: "unknown" };
|
||||
case "open": return { action: { action: "open", url: text(input.url, "url", TOOL_LIMITS.url) }, kind: "deep-link", label: text(input.url, "url", TOOL_LIMITS.url), risk: "unknown" };
|
||||
default: throw failure("AGENT_ACTION_INVALID", `Unknown action ${action}.`);
|
||||
}
|
||||
};
|
||||
@@ -707,8 +734,12 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
const role = roleOf(under);
|
||||
const label = str(under.label) ?? "";
|
||||
const what = role === "field" ? "field" : role === "button" || role === "tab" || role === "link" ? (cleanLabel(label) ? role : `icon ${role}`) : /\p{L}/u.test(cleanLabel(label)) ? "item" : "icon";
|
||||
const row = point.y < 1 / 3 ? "top" : point.y < 2 / 3 ? "" : "bottom";
|
||||
const column = point.x < 1 / 3 ? "left" : point.x < 2 / 3 ? "" : "right";
|
||||
// The place is read off the screen's stored screenshot, which an opened Duo's frames are turned upright for: there the
|
||||
// portrait point (x, y) shows at (1 - y, x). A frame read without an image says nothing, so the screen's screenshot is asked.
|
||||
const turned = latest!.landscape || map.observations.some(item => item.screenId === currentScreenId && map.artifacts.find(artifact => artifact.id === item.screenshotArtifactId)?.turned);
|
||||
const shown = turned ? { x: 1 - point.y, y: point.x } : point;
|
||||
const row = shown.y < 1 / 3 ? "top" : shown.y < 2 / 3 ? "" : "bottom";
|
||||
const column = shown.x < 1 / 3 ? "left" : shown.x < 2 / 3 ? "" : "right";
|
||||
const where = [row, column].filter(Boolean).join(" ") || "centre";
|
||||
return `${what}, ${where}`;
|
||||
};
|
||||
@@ -749,10 +780,10 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
const frameId = text(input.frameId, "frameId", 256);
|
||||
if (!latest?.png && latest?.imageUnavailable?.code === "CAPTURE_SENSITIVE_INPUT") throw failure("CAPTURE_SENSITIVE_INPUT", latest.imageUnavailable.message, true);
|
||||
if (!latest?.png || latest.frameId !== frameId) throw failure("AGENT_FRAME_STALE", "Observe with an image first; capture must name the latest frame.", true);
|
||||
const title = text(input.title, "title", 80).trim();
|
||||
const title = text(input.title, "title", TOOL_LIMITS.title).trim();
|
||||
if (captures >= options.maxScreens) { stop("budget-screens"); abort.abort(failure("EXPLORATION_BUDGET_EXHAUSTED", "Screen budget exhausted.")); throw abort.signal.reason; }
|
||||
const { screen } = locate(latest, title);
|
||||
const state = str(input.state, 80);
|
||||
const state = str(input.state, TOOL_LIMITS.state);
|
||||
if (!state && map.observations.some(item => item.screenId === screen.id && item.screenshotArtifactId)) {
|
||||
if (title) screen.title = title;
|
||||
return toolResult({ ok: true, duplicate: true, screenId: screen.id, title: screen.title, message: "This screen is already captured (its title is updated); pass state to record a variant." });
|
||||
@@ -832,9 +863,9 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
await persist();
|
||||
return toolResult({ ok: !error, outcome, ...(error ? { error } : {}), ...view, ...progress().budget });
|
||||
}
|
||||
if (name === "finish") { stop("finished", text(input.summary, "summary", 4000)); abort.abort(new Error("finished")); return toolResult({ ok: true }); }
|
||||
if (name === "finish") { stop("finished", text(input.summary, "summary", TOOL_LIMITS.summary)); abort.abort(new Error("finished")); return toolResult({ ok: true }); }
|
||||
if (name === "stop_blocked") {
|
||||
const reason = text(input.reason, "reason", 1000);
|
||||
const reason = text(input.reason, "reason", TOOL_LIMITS.reason);
|
||||
map.gaps.push({ id: `gap_${randomUUID().slice(0, 8)}`, kind: "coverage", status: "open", message: reason, ...(currentScreenId ? { screenId: currentScreenId } : {}), createdAt: timestamp() });
|
||||
await persist();
|
||||
stop("blocked", reason); abort.abort(new Error("blocked")); return toolResult({ ok: true });
|
||||
@@ -856,8 +887,9 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
if (!result) stop(budget ? "budget-time" : "model-error", undefined, budget ? undefined : fatal ?? error);
|
||||
}
|
||||
if (result!.stopReason !== "finished" && result!.stopReason !== "blocked") {
|
||||
const note = result!.stopReason === "model-error" ? undefined : options.budgetNote?.();
|
||||
map.gaps.push({ id: `gap_${randomUUID().slice(0, 8)}`, kind: result!.stopReason === "model-error" ? "other" : "coverage", status: "open",
|
||||
message: result!.stopReason === "model-error" ? `The exploration stopped on an error: ${result!.error instanceof Error ? result!.error.message.slice(0, 300) : "unknown"}` : `The exploration stopped at its ${result!.stopReason.replace("budget-", "")} budget with ${map.frontier.filter(item => item.status === "pending").length} controls unexplored.`,
|
||||
message: result!.stopReason === "model-error" ? `The exploration stopped on an error: ${result!.error instanceof Error ? result!.error.message.slice(0, 300) : "unknown"}` : `The exploration stopped at its ${result!.stopReason.replace("budget-", "")} budget with ${map.frontier.filter(item => item.status === "pending").length} controls unexplored.${note ? ` ${note}` : ""}`,
|
||||
createdAt: timestamp() });
|
||||
}
|
||||
for (const item of map.frontier) if (item.status === "claimed") item.status = "pending";
|
||||
@@ -870,10 +902,10 @@ export async function runBlackBoxExploration(options: BlackBoxExplorerOptions):
|
||||
function nameUncapturedScreens(map: ExploreMap): void {
|
||||
const titles = new Map(map.screens.map(screen => [screen.id, screen.title]));
|
||||
for (const screen of map.screens) {
|
||||
if (!/^Screen \d+$/.test(screen.title)) continue;
|
||||
if (!isPlaceholderTitle(screen.title)) continue;
|
||||
const arrival = map.actionAttempts.find(attempt => attempt.targetScreenId === screen.id && attempt.outcome === "transition" && attempt.sourceScreenId !== screen.id);
|
||||
const from = arrival ? titles.get(arrival.sourceScreenId) : undefined;
|
||||
if (!arrival || !from || /^Screen \d+$/.test(from)) continue;
|
||||
if (!arrival || !from || isPlaceholderTitle(from)) continue;
|
||||
const step = arrival.action.input ? "typing" : arrival.action.label;
|
||||
screen.title = `${from} → ${step}`.slice(0, 80);
|
||||
titles.set(screen.id, screen.title);
|
||||
|
||||
@@ -0,0 +1,300 @@
|
||||
import { readFile } from "node:fs/promises";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import type { CiAgentSessionRunRequest, CiAgentSessionRunResult } from "../capture/agent/session.js";
|
||||
import { SETUP_SELECTOR_MAX, isSetupInput, isSetupSelector } from "../capture/setup-actions.js";
|
||||
import type { CaptureSetupAction } from "../config/explore-config.js";
|
||||
import { explorationSecretNames } from "../config/exploration-inputs.js";
|
||||
import { TOOL_LIMITS, isPlaceholderTitle } from "./explorer.js";
|
||||
|
||||
export type ReplayPlatform = "ios" | "android";
|
||||
type Selector = { label: string; identifier?: never } | { identifier: string; label?: never };
|
||||
type ReplayAction =
|
||||
| ({ action: "tap" } & Selector)
|
||||
| ({ action: "fill"; text: string } & Selector)
|
||||
| { action: "type"; text: string }
|
||||
| { action: "scroll"; direction: "up" | "down" | "left" | "right" | "top" | "bottom" }
|
||||
| { action: "wait"; milliseconds: number }
|
||||
| { action: "open"; url: string }
|
||||
| { action: "back" }
|
||||
| { action: "dismiss-keyboard" };
|
||||
type ReplayCapture = { capture: string; state?: string; description?: string };
|
||||
/** `platforms` limits a step to those platforms; an `optional` action that fails is skipped instead of ending the replay. */
|
||||
export type ReplayStep = (ReplayCapture & { platforms?: ReplayPlatform[] }) | (ReplayAction & { platforms?: ReplayPlatform[]; optional?: boolean });
|
||||
export type ReplayPlan = { steps: ReplayStep[] };
|
||||
|
||||
export type ReplaySession = {
|
||||
readonly provider: "replay";
|
||||
readonly model: string;
|
||||
preflight(): Promise<void>;
|
||||
run(request: CiAgentSessionRunRequest): Promise<CiAgentSessionRunResult>;
|
||||
/** After a budget stop, the planned screens the run did not reach, for the explorer's gap. */
|
||||
budgetNote(): string | undefined;
|
||||
};
|
||||
|
||||
const DIRECTIONS = new Set(["up", "down", "left", "right", "top", "bottom"]);
|
||||
/**
|
||||
* The fields each kind of step takes. Anything else is refused: a typo (`platform`, `optinal`) would otherwise do nothing,
|
||||
* and a field `act` reads another way (a coordinate tap's `frameId`, `x`, `y` and `target`) would change what is tapped.
|
||||
*/
|
||||
const FIELDS = new Map<string, readonly string[]>([
|
||||
["capture", ["capture", "state", "description", "platforms"]],
|
||||
["tap", ["action", "label", "identifier", "platforms", "optional"]],
|
||||
["fill", ["action", "label", "identifier", "text", "platforms", "optional"]],
|
||||
["type", ["action", "text", "platforms", "optional"]],
|
||||
["scroll", ["action", "direction", "platforms", "optional"]],
|
||||
["wait", ["action", "milliseconds", "platforms", "optional"]],
|
||||
["open", ["action", "url", "platforms", "optional"]],
|
||||
["back", ["action", "platforms", "optional"]],
|
||||
["dismiss-keyboard", ["action", "platforms", "optional"]],
|
||||
]);
|
||||
const ACTIONS = [...FIELDS.keys()].filter(kind => kind !== "capture");
|
||||
|
||||
function invalid(message: string): CiError {
|
||||
return new CiError({ code: "REPLAY_PLAN_INVALID", stage: "exploration", message, retryable: false,
|
||||
nextAction: "Fix the replay plan: a JSON object with a steps array of actions ({\"action\":\"tap\",\"label\":\"Settings\"}) and captures ({\"capture\":\"Settings\"})." });
|
||||
}
|
||||
|
||||
const nonEmpty = (value: unknown, max: number): value is string => typeof value === "string" && value.trim().length > 0 && value.length <= max;
|
||||
|
||||
function parseStep(step: unknown, at: string): ReplayStep {
|
||||
if (!step || typeof step !== "object" || Array.isArray(step)) throw invalid(`${at} is not an object.`);
|
||||
const entry = step as Record<string, unknown>;
|
||||
const kind = "capture" in entry ? "capture" : typeof entry.action === "string" && FIELDS.has(entry.action) ? entry.action : undefined;
|
||||
if (!kind) throw invalid(`${at} needs a capture title or an action (${ACTIONS.join(", ")}).`);
|
||||
const fields = FIELDS.get(kind)!;
|
||||
const unknown = Object.keys(entry).find(key => !fields.includes(key));
|
||||
if (unknown !== undefined) throw invalid(`${at} (${kind}) has a field ${JSON.stringify(unknown.slice(0, 40))} it does not take; a ${kind} step takes ${fields.join(", ")}.`);
|
||||
if (entry.platforms !== undefined && (!Array.isArray(entry.platforms) || !entry.platforms.length || entry.platforms.some(item => item !== "ios" && item !== "android"))) {
|
||||
throw invalid(`${at}: platforms must list ios and/or android.`);
|
||||
}
|
||||
if (entry.optional !== undefined && typeof entry.optional !== "boolean") throw invalid(`${at}: optional must be true or false.`);
|
||||
const extra = { ...(entry.platforms ? { platforms: [...entry.platforms] as ReplayPlatform[] } : {}), ...(entry.optional !== undefined ? { optional: entry.optional as boolean } : {}) };
|
||||
if (kind === "capture") {
|
||||
if (!nonEmpty(entry.capture, TOOL_LIMITS.title)) throw invalid(`${at}: capture must be a screen title of at most ${TOOL_LIMITS.title} characters.`);
|
||||
if (entry.state !== undefined && !nonEmpty(entry.state, TOOL_LIMITS.state)) throw invalid(`${at}: state must be a string of at most ${TOOL_LIMITS.state} characters.`);
|
||||
if (entry.description !== undefined && !nonEmpty(entry.description, TOOL_LIMITS.description)) throw invalid(`${at}: description must be a string of at most ${TOOL_LIMITS.description} characters.`);
|
||||
return { capture: entry.capture.trim(), ...(entry.state !== undefined ? { state: entry.state as string } : {}),
|
||||
...(entry.description !== undefined ? { description: entry.description as string } : {}), ...extra };
|
||||
}
|
||||
// The device selects by the setup executor's rules, which are stricter than what `act` itself accepts.
|
||||
const selector = (): Selector => {
|
||||
const keys = (["label", "identifier"] as const).filter(key => entry[key] !== undefined);
|
||||
if (keys.length !== 1) throw invalid(`${at}: ${kind} needs exactly one of label or identifier.`);
|
||||
const key = keys[0]!, value = entry[key];
|
||||
if (!isSetupSelector(value) || value.length > TOOL_LIMITS.selector) throw invalid(`${at}: ${key} must be 1–${SETUP_SELECTOR_MAX} characters without control characters.`);
|
||||
return key === "label" ? { label: value } : { identifier: value };
|
||||
};
|
||||
const input = (): string => {
|
||||
if (!nonEmpty(entry.text, TOOL_LIMITS.text) || !isSetupInput(entry.text)) throw invalid(`${at}: ${kind} needs text: one line of at most ${TOOL_LIMITS.text} characters.`);
|
||||
try { explorationSecretNames(entry.text); }
|
||||
catch (error) { throw invalid(`${at}: ${error instanceof Error ? error.message : String(error)} Write each input as {{secret:NAME}} with an uppercase environment variable name that is not a provider, Expo, or CI credential.`); }
|
||||
return entry.text;
|
||||
};
|
||||
switch (kind) {
|
||||
case "tap": return { action: "tap", ...selector(), ...extra };
|
||||
case "fill": return { action: "fill", ...selector(), text: input(), ...extra };
|
||||
case "type": return { action: "type", text: input(), ...extra };
|
||||
case "scroll":
|
||||
if (typeof entry.direction !== "string" || !DIRECTIONS.has(entry.direction)) throw invalid(`${at}: scroll needs a direction (${[...DIRECTIONS].join(", ")}).`);
|
||||
return { action: "scroll", direction: entry.direction as "up", ...extra };
|
||||
case "wait":
|
||||
if (!(Number.isInteger(entry.milliseconds) && Number(entry.milliseconds) >= 1 && Number(entry.milliseconds) <= TOOL_LIMITS.waitMs)) {
|
||||
throw invalid(`${at}: wait needs milliseconds between 1 and ${TOOL_LIMITS.waitMs}.`);
|
||||
}
|
||||
return { action: "wait", milliseconds: entry.milliseconds as number, ...extra };
|
||||
case "open":
|
||||
if (!nonEmpty(entry.url, TOOL_LIMITS.url)) throw invalid(`${at}: open needs a url of at most ${TOOL_LIMITS.url} characters.`);
|
||||
return { action: "open", url: entry.url, ...extra };
|
||||
default: return { action: kind as "back" | "dismiss-keyboard", ...extra };
|
||||
}
|
||||
}
|
||||
|
||||
/** Checks a plan and keeps only the fields each step takes, so what reaches `act` is what the plan documents. */
|
||||
export function parseReplayPlan(value: unknown): ReplayPlan {
|
||||
if (!value || typeof value !== "object" || !Array.isArray((value as { steps?: unknown }).steps)) throw invalid("The replay plan has no steps array.");
|
||||
const unknown = Object.keys(value).find(key => key !== "steps");
|
||||
if (unknown !== undefined) throw invalid(`The replay plan has a field ${JSON.stringify(unknown.slice(0, 40))} it does not take; it takes only steps.`);
|
||||
const steps = (value as { steps: unknown[] }).steps;
|
||||
if (!steps.length) throw invalid("The replay plan has no steps.");
|
||||
return { steps: steps.map((step, index) => parseStep(step, `Step ${index + 1}`)) };
|
||||
}
|
||||
|
||||
export async function readReplayPlan(path: string): Promise<ReplayPlan> {
|
||||
let text: string;
|
||||
try { text = await readFile(path, "utf8"); }
|
||||
catch (error) { throw invalid(`The replay plan ${path} could not be read: ${error instanceof Error ? error.message : String(error)}`); }
|
||||
let value: unknown;
|
||||
try { value = JSON.parse(text); }
|
||||
catch (error) { throw invalid(`The replay plan ${path} is not JSON: ${error instanceof Error ? error.message : String(error)}`); }
|
||||
return parseReplayPlan(value);
|
||||
}
|
||||
|
||||
/** The plan's fill and type steps, whose {{secret:NAME}} inputs must be set before any device starts, as the hints' are. */
|
||||
export function replaySetup(plan: ReplayPlan): CaptureSetupAction[] {
|
||||
return plan.steps.flatMap(step => "action" in step && (step.action === "fill" || step.action === "type") ? [step as CaptureSetupAction] : []);
|
||||
}
|
||||
|
||||
const stepsFor = (plan: ReplayPlan, platform: ReplayPlatform) => plan.steps.map((step, index) => ({ step, number: index + 1 }))
|
||||
.filter(({ step }) => !step.platforms || step.platforms.includes(platform));
|
||||
|
||||
/**
|
||||
* Refuses, before any device starts, a plan with nothing to do on this platform or one the budgets cannot hold: a run that
|
||||
* would stop at its budget partway through the plan is better raised or shortened up front.
|
||||
*/
|
||||
export function assertReplayFits(plan: ReplayPlan, platform: ReplayPlatform, limits: { maxScreens: number; maxActions: number; maxTurns: number }): void {
|
||||
const steps = stepsFor(plan, platform);
|
||||
if (!steps.length) {
|
||||
throw new CiError({ code: "REPLAY_PLAN_EMPTY", stage: "exploration", message: `No step of the replay plan runs on ${platform}: each one is limited to ${platform === "ios" ? "android" : "ios"} by its platforms.`,
|
||||
nextAction: `Add steps for ${platform} to the plan, or run it on the platform it was written for.` });
|
||||
}
|
||||
const captures = steps.filter(({ step }) => "capture" in step).length;
|
||||
const actions = steps.filter(({ step }) => "action" in step && step.action !== "wait").length;
|
||||
// A screen counts against the budget when it is first photographed, on arrival, and a capture is refused once the budget
|
||||
// is used up, so the last capture needs one screen to spare.
|
||||
const over = [
|
||||
...(captures >= limits.maxScreens ? [{ text: `${captures} captures, which need a screen budget of at least ${captures + 1} (it is ${limits.maxScreens})`, flag: `--max-screens ${captures + 1}` }] : []),
|
||||
...(actions > limits.maxActions ? [{ text: `${actions} actions, more than the action budget of ${limits.maxActions}`, flag: `--max-actions ${actions}` }] : []),
|
||||
];
|
||||
if (over.length) {
|
||||
throw new CiError({ code: "REPLAY_PLAN_OVER_BUDGET", stage: "exploration", message: `On ${platform} the replay plan takes ${over.map(item => item.text).join(" and ")}.`,
|
||||
nextAction: `Pass ${over.map(item => item.flag).join(" ")} (or more: each screen the plan reaches without capturing it also counts), or shorten the plan.` });
|
||||
}
|
||||
// Each capture is an observe and a capture call, each action one act call, and the run ends with get_progress and finish.
|
||||
const turns = steps.length + captures + 2;
|
||||
if (turns > limits.maxTurns) {
|
||||
throw new CiError({ code: "REPLAY_PLAN_OVER_BUDGET", stage: "exploration", message: `On ${platform} the replay plan takes ${turns} tool calls, more than the ${limits.maxTurns} that the screen and action budgets allow.`,
|
||||
nextAction: "Raise --max-actions, or use fewer wait steps." });
|
||||
}
|
||||
}
|
||||
|
||||
function describeAction(step: ReplayAction): string {
|
||||
if ("label" in step && step.label) return `${step.action} "${step.label}"`;
|
||||
if ("identifier" in step && step.identifier) return `${step.action} #${step.identifier}`;
|
||||
if (step.action === "scroll") return `scroll ${step.direction}`;
|
||||
return step.action;
|
||||
}
|
||||
|
||||
/** Only the fields `act` documents for that action, whatever else the step object carries. */
|
||||
function actInput(step: ReplayAction): Record<string, unknown> {
|
||||
const selector = "label" in step && step.label !== undefined ? { label: step.label } : "identifier" in step && step.identifier !== undefined ? { identifier: step.identifier } : {};
|
||||
switch (step.action) {
|
||||
case "tap": return { action: "tap", ...selector };
|
||||
case "fill": return { action: "fill", ...selector, text: step.text };
|
||||
case "type": return { action: "type", text: step.text };
|
||||
case "scroll": return { action: "scroll", direction: step.direction };
|
||||
case "wait": return { action: "wait", milliseconds: step.milliseconds };
|
||||
case "open": return { action: "open", url: step.url };
|
||||
default: return { action: step.action };
|
||||
}
|
||||
}
|
||||
|
||||
/** As many names as fit in `room` characters, then "and N more"; a count of them when not even the first fits. */
|
||||
function listed(names: readonly string[], room: number, noun: string): string {
|
||||
let text = "";
|
||||
for (const [index, name] of names.entries()) {
|
||||
const next = text ? `${text}, ${name}` : name;
|
||||
const left = names.length - index - 1;
|
||||
if (next.length + (left ? ` and ${left} more`.length : 0) > room) return text ? `${text} and ${names.length - index} more` : `${names.length} ${noun}`;
|
||||
text = next;
|
||||
}
|
||||
return text;
|
||||
}
|
||||
|
||||
const sameTitle = (left: string, right: string): boolean => left.toLowerCase() === right.toLowerCase();
|
||||
|
||||
/**
|
||||
* Runs a fixed plan through the explorer's own tools in place of a model: the same observe, act, and capture calls,
|
||||
* so the map and report are those of a model run, but every run takes the same steps. A step that fails does not
|
||||
* fail the run: the report keeps what was captured and names the screens that were not.
|
||||
*/
|
||||
export function createReplaySession(plan: ReplayPlan, platform: ReplayPlatform): ReplaySession {
|
||||
const steps = stepsFor(plan, platform);
|
||||
const title = (step: ReplayCapture) => step.state ? `${step.capture} (${step.state})` : step.capture;
|
||||
const missed: string[] = [];
|
||||
let position = 0;
|
||||
/** What the plan meant to capture and has not: the screens still ahead first, then the ones earlier steps missed. */
|
||||
const notCaptured = () => [...steps.slice(position).flatMap(({ step }) => "capture" in step ? [title(step)] : []), ...missed];
|
||||
return {
|
||||
provider: "replay",
|
||||
model: "replay plan",
|
||||
async preflight() {},
|
||||
budgetNote() {
|
||||
const names = notCaptured();
|
||||
return names.length ? `Not captured: ${listed(names, TOOL_LIMITS.reason, "planned screens")}.` : undefined;
|
||||
},
|
||||
async run(request) {
|
||||
const signal = request.signal ?? new AbortController().signal;
|
||||
const call = async (name: string, input: Record<string, unknown>) => {
|
||||
const result = await request.callTool(name, input, signal);
|
||||
const text = result.content.find(block => block.type === "text");
|
||||
const value = text && "text" in text ? JSON.parse(text.text) as Record<string, unknown> : {};
|
||||
return { failed: Boolean(result.isError) || value.ok === false, value };
|
||||
};
|
||||
const why = (value: Record<string, unknown>) => String(value.error ?? value.reason ?? value.message ?? "it failed");
|
||||
// A refused finish or stop_blocked would otherwise end the session with no result, which the explorer reports as a turn budget stop.
|
||||
const end = async (name: "finish" | "stop_blocked", input: Record<string, unknown>) => {
|
||||
const ended = await call(name, input);
|
||||
if (!ended.failed) return;
|
||||
if (name === "finish") return end("stop_blocked", { reason: `The replay could not finish (${why(ended.value)}). ${String(input.summary)}`.slice(0, TOOL_LIMITS.reason) });
|
||||
throw new CiError({ code: "REPLAY_STOP_REFUSED", stage: "exploration", message: `The explorer refused the replay's ${name}: ${why(ended.value)}`.slice(0, 600),
|
||||
nextAction: "Report this with the replay plan; the screens captured so far are in the map." });
|
||||
};
|
||||
/** Screen id to the title the plan captured it under. */
|
||||
const planned = new Map<string, string>();
|
||||
const skipped: string[] = [];
|
||||
missed.length = 0;
|
||||
try {
|
||||
for (const [index, { step, number }] of steps.entries()) {
|
||||
position = index;
|
||||
if ("capture" in step) {
|
||||
const seen = await call("observe", { includeImage: true });
|
||||
const frameId = typeof seen.value.frameId === "string" ? seen.value.frameId : undefined;
|
||||
const known = typeof seen.value.screenId === "string" && !step.state ? planned.get(seen.value.screenId) : undefined;
|
||||
// The plan already captured this screen: a second capture would only rename it, so it is not made.
|
||||
if (known !== undefined) {
|
||||
if (!sameTitle(known, step.capture)) missed.push(`${title(step)} (looked the same as ${known})`);
|
||||
continue;
|
||||
}
|
||||
const captured = frameId && !seen.failed ? await call("capture", { frameId, title: step.capture,
|
||||
...(step.state ? { state: step.state } : {}), ...(step.description ? { description: step.description } : {}) }) : undefined;
|
||||
const screenId = typeof captured?.value.screenId === "string" ? captured.value.screenId : undefined;
|
||||
if (!captured || captured.failed || !screenId) missed.push(title(step));
|
||||
else if (!planned.has(screenId)) planned.set(screenId, step.capture);
|
||||
continue;
|
||||
}
|
||||
const acted = await call("act", actInput(step));
|
||||
if (!acted.failed) continue;
|
||||
if (step.optional) { skipped.push(`step ${number} (${describeAction(step)})`); continue; }
|
||||
const head = `Replay step ${number} (${describeAction(step)}) failed: ${why(acted.value)}`.slice(0, 600);
|
||||
const names = notCaptured();
|
||||
const lead = ". Not captured: ";
|
||||
await end("stop_blocked", { reason: head + (names.length ? `${lead}${listed(names, TOOL_LIMITS.reason - head.length - lead.length, "planned screens")}` : "") });
|
||||
return { inputTokens: 0, outputTokens: 0 };
|
||||
}
|
||||
position = steps.length;
|
||||
// The map as it stands: screens merged into others are gone, and each keeps its latest title. One reached but never
|
||||
// captured is still "Screen N" here and is named after the path to it only once the run ends, so it is counted.
|
||||
const progress = await call("get_progress", {});
|
||||
const screens = Array.isArray(progress.value.captured) ? progress.value.captured as Array<{ id?: unknown; title?: unknown }> : [];
|
||||
const unplanned = screens.filter(screen => typeof screen.id === "string" && !planned.has(screen.id)).map(screen => typeof screen.title === "string" ? screen.title : "");
|
||||
const named = unplanned.filter(name => name && !isPlaceholderTitle(name));
|
||||
const unnamed = unplanned.length - named.length;
|
||||
const reached = [...named, ...(unnamed ? [`${unnamed} unnamed screen${unnamed === 1 ? "" : "s"}`] : [])];
|
||||
const sections = ([["Not captured", missed, "planned screens"], ["Optional steps skipped because they failed", skipped, "steps"],
|
||||
["Also reached, not in the plan", reached, "screens"]] as const).filter(([, names]) => names.length);
|
||||
let summary = `Replayed ${steps.length} planned steps on ${platform}.${missed.length ? "" : " Every planned screen was captured."}`;
|
||||
for (const [index, [label, names, noun]] of sections.entries()) {
|
||||
// Each later section keeps room for its label and a count, so a long list of misses does not crowd out the rest.
|
||||
const reserve = sections.slice(index + 1).reduce((sum, [later]) => sum + later.length + 32, 0);
|
||||
const lead = ` ${label}: `;
|
||||
summary += `${lead}${listed(names, TOOL_LIMITS.summary - summary.length - lead.length - 1 - reserve, noun)}.`;
|
||||
}
|
||||
await end("finish", { summary });
|
||||
} catch (error) {
|
||||
if (signal.aborted) return { inputTokens: 0, outputTokens: 0 };
|
||||
throw error;
|
||||
}
|
||||
return { inputTokens: 0, outputTokens: 0 };
|
||||
},
|
||||
};
|
||||
}
|
||||
+83
-10
@@ -5,6 +5,7 @@ import { join } from "node:path";
|
||||
import { createCiAgentSession, type CiAgentSession, type CiAgentSessionConfig } from "../capture/agent/session.js";
|
||||
import { createLocalCiAgentSession } from "../capture/agent/session-local.js";
|
||||
import type { CiAgentProviderName } from "../capture/agent/provider.js";
|
||||
import { assertReplayFits, createReplaySession, parseReplayPlan, replaySetup, type ReplayPlan } from "./replay.js";
|
||||
import { CONTROLLER_SESSION, baseEnvironment, isRecord } from "../capture/common.js";
|
||||
import { controllerData, defaultRunner, openedSimulatorDevice } from "../capture/controller.js";
|
||||
import type { CommandRequest, CommandResult } from "../capture/run.js";
|
||||
@@ -16,8 +17,10 @@ import { agentDeviceLauncher, ensureArgentToolServer, ensureController } from ".
|
||||
import { agentDeviceClaims, approveLinkScheme, createLocalSimulator, deleteLocalEmulator, deleteLocalSimulator, hostEmulatorAbi, installOnLocalEmulator, installOnLocalSimulator, startLocalArgentServer,
|
||||
startLocalEmulator, stopLocalAgentDevice, stopLocalArgentServer, waitForLocalEmulator, waitForLocalSimulator, type LocalArgentServer } from "../capture/local-simulator.js";
|
||||
import { openLocalCaptureRecord, sweepLocalCaptures } from "../capture/local-registry.js";
|
||||
import { screenSpace } from "../capture/route-capture.js";
|
||||
import { approveSessionUrlSchemes, simulatorControlActions, type EasCommand } from "../capture/simulator-control.js";
|
||||
import { DEFAULT_ANDROID_DEVICE } from "../config/explore-config.js";
|
||||
import { DUO_PANELS } from "../contracts/capture.js";
|
||||
import { createExplorationInputs } from "../config/exploration-inputs.js";
|
||||
import { ExploreStore, getCoverage } from "../map/store.js";
|
||||
import { whoamiAccounts } from "../report/preview-deploy.js";
|
||||
@@ -57,6 +60,8 @@ export type BinaryExploreOptions = {
|
||||
simulator?: "eas" | "local";
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
runner?: typeof defaultRunner;
|
||||
/** Fixed steps to take instead of a model's; no model access is needed. */
|
||||
replay?: ReplayPlan;
|
||||
createSession?: (config: CiAgentSessionConfig, options: { env: NodeJS.ProcessEnv; auth: ModelAuth }) => CiAgentSession;
|
||||
progress?: (message: string) => void;
|
||||
now?: () => number;
|
||||
@@ -68,7 +73,7 @@ export type BinaryExploreResult = {
|
||||
archive: Omit<InspectedArchive, "path"> & { path: string };
|
||||
session: { id: string; platform: Platform; device: string; owner: string; project: string };
|
||||
runtime: ActiveSimulatorRuntime;
|
||||
model: { provider: CiAgentProviderName; model: string; auth: "local-login" | "api-key" };
|
||||
model: { provider: CiAgentProviderName | "replay"; model: string; auth: "local-login" | "api-key" | "none" };
|
||||
exploration: BlackBoxExplorerResult;
|
||||
durationMs: number;
|
||||
};
|
||||
@@ -162,8 +167,8 @@ export function resolveSessionApp(runner: typeof defaultRunner, connection: Simu
|
||||
* App-test inputs: each {{secret:NAME}} in the hints names an environment variable whose value Explore types for the
|
||||
* model. Read before any session starts, so a missing one costs nothing.
|
||||
*/
|
||||
export function hintInputs(hints: string | undefined, environment: NodeJS.ProcessEnv): ReturnType<typeof createExplorationInputs> {
|
||||
try { return createExplorationInputs({ instructions: hints ?? "", environment }); }
|
||||
export function hintInputs(hints: string | undefined, environment: NodeJS.ProcessEnv, replay?: ReplayPlan): ReturnType<typeof createExplorationInputs> {
|
||||
try { return createExplorationInputs({ instructions: hints ?? "", ...(replay ? { setup: replaySetup(replay) } : {}), environment }); }
|
||||
catch (error) {
|
||||
if (!(error instanceof CiError) || !error.code.startsWith("EXPLORATION_SECRET_")) throw error;
|
||||
const name = typeof error.details?.secretName === "string" ? error.details.secretName : "NAME";
|
||||
@@ -194,6 +199,36 @@ function modelSession(provider: CiAgentProviderName, auth: ModelAuth, options: M
|
||||
return { session, provider, model: config.model, auth };
|
||||
}
|
||||
|
||||
/** The turns the model gets: three for each action and two for each screen, plus a few to look around and finish. */
|
||||
const turnBudget = (limits: { maxScreens: number; maxActions: number }): number => limits.maxActions * 3 + limits.maxScreens * 2 + 20;
|
||||
|
||||
/**
|
||||
* A replay plan is checked here as well as by the CLI, for callers that pass one directly. It takes the model's place, so
|
||||
* the options that only steer a model would do nothing; the plan's own fill and type steps name the secrets it types.
|
||||
*/
|
||||
function replayPlan(options: Pick<BinaryExploreOptions, "replay" | "provider" | "model" | "hints">): ReplayPlan | undefined {
|
||||
if (!options.replay) return undefined;
|
||||
const ignored = (["provider", "model", "hints"] as const).filter(name => options[name] !== undefined);
|
||||
if (ignored.length) {
|
||||
throw binaryError("REPLAY_OPTIONS_IGNORED", `--replay takes the model's place, so ${ignored.map(name => `--${name}`).join(" and ")} would do nothing.`,
|
||||
`Drop ${ignored.map(name => `--${name}`).join(" and ")}. A {{secret:NAME}} in the plan's fill and type steps is read from the environment, as one in --hints is.`);
|
||||
}
|
||||
const plan = parseReplayPlan(options.replay);
|
||||
for (const [index, step] of plan.steps.entries()) {
|
||||
if (!("action" in step) || step.action !== "open") continue;
|
||||
try { assertAppUrl(step.url); }
|
||||
catch (error) { throw new CiError({ code: "REPLAY_PLAN_INVALID", stage: "exploration", message: `Step ${index + 1}: ${error instanceof Error ? error.message : String(error)}`, nextAction: "Open only the app's own URLs in the replay plan." }); }
|
||||
}
|
||||
return plan;
|
||||
}
|
||||
|
||||
/** A replay plan takes the model's place: no model access is checked or used. */
|
||||
function replayModel(plan: ReplayPlan, platform: Platform, limits: { maxScreens: number; maxActions: number }) {
|
||||
assertReplayFits(plan, platform, { ...limits, maxTurns: turnBudget(limits) });
|
||||
const session = createReplaySession(plan, platform);
|
||||
return { session, budgetNote: session.budgetNote, provider: "replay" as const, model: "replay plan", auth: "none" as const };
|
||||
}
|
||||
|
||||
/** Local `claude`/`codex` login unless an API key is present; preflight proves access before a simulator is paid for. */
|
||||
export function selectModelSession(options: ModelSessionOptions, environment: NodeJS.ProcessEnv) {
|
||||
const provider: CiAgentProviderName = options.provider ?? (environment.OPENAI_API_KEY?.trim() && !environment.ANTHROPIC_API_KEY?.trim() ? "openai" : "anthropic");
|
||||
@@ -260,7 +295,7 @@ export type ConnectedSessionExploration = {
|
||||
limits: { maxDurationMinutes: number; maxScreens: number; maxActions: number };
|
||||
store: ExploreStore;
|
||||
map: ExploreMap;
|
||||
model: { session: CiAgentSession };
|
||||
model: { session: Pick<CiAgentSession, "run">; budgetNote?: () => string | undefined };
|
||||
/** `eas simulator:get --json` for the attached session; descriptive (OS version) only. */
|
||||
sessionJson: () => string;
|
||||
/** agent-device session name on the daemon; explore:session reuses the caller's session so the device is not "in use" by another. */
|
||||
@@ -374,6 +409,20 @@ export async function exploreConnectedSession(ctx: ConnectedSessionExploration):
|
||||
catch { return undefined; }
|
||||
};
|
||||
const foregroundElsewhere = (): boolean => { const state = foregroundState(); return state ? leftForeground(state, bundleId) : false; };
|
||||
let unmatchedPanel = false;
|
||||
/** Whether the frame is an opened Duo's, to be stored turned upright; the run then records the landscape it shows. */
|
||||
const landscapeOnPortrait = (nodes: readonly Record<string, unknown>[], png: Buffer): boolean => {
|
||||
const width = png.readUInt32BE(16), height = png.readUInt32BE(20);
|
||||
const turn = duoScreenshotTurn({ platform, deviceModel: runtime.deviceModel, nodes, width, height });
|
||||
if (turn === "unmatched" && !unmatchedPanel) {
|
||||
unmatchedPanel = true;
|
||||
const root = nodes.find(node => node.type === "Application")?.rect as { width?: unknown; height?: unknown } | undefined;
|
||||
say(`an iPhone Duo frame (${width}×${height} px, root ${root ? `${String(root.width)}×${String(root.height)} pt` : "missing"}) shows neither of its panels; its screenshot is stored as taken, which may be sideways`);
|
||||
}
|
||||
if (turn !== "turn") return false;
|
||||
if (runtime.orientation !== "landscape") { runtime.orientation = "landscape"; if (map.run.environment) map.run.environment.orientation = "landscape"; }
|
||||
return true;
|
||||
};
|
||||
const observe = async (includeImage: boolean): Promise<BlackBoxFrame> => {
|
||||
let nodes: Record<string, unknown>[];
|
||||
let leftApp = false;
|
||||
@@ -411,7 +460,7 @@ export async function exploreConnectedSession(ctx: ConnectedSessionExploration):
|
||||
assertDecodedPng(png, "Exploration screenshot");
|
||||
if (png.length > 10 * 1024 * 1024) return { nodes, capturedAt, imageUnavailable: { code: "SCREENSHOT_TOO_LARGE", message: "The screenshot exceeded 10 MB." } };
|
||||
if (solidColour(png)) return { nodes, capturedAt, imageUnavailable: { code: "SCREENSHOT_BLANK", message: BLANK_SCREENSHOT_MESSAGE }, ...(leftApp ? { leftApp } : {}) };
|
||||
return { nodes, capturedAt, frameId: randomUUID(), png, imageSha256: createHash("sha256").update(png).digest("hex"), width: png.readUInt32BE(16), height: png.readUInt32BE(20), ...(leftApp ? { leftApp } : {}) };
|
||||
return { nodes, capturedAt, frameId: randomUUID(), png, imageSha256: createHash("sha256").update(png).digest("hex"), width: png.readUInt32BE(16), height: png.readUInt32BE(20), ...(landscapeOnPortrait(nodes, png) ? { landscape: true } : {}), ...(leftApp ? { leftApp } : {}) };
|
||||
} finally { await rm(path, { force: true }); }
|
||||
};
|
||||
const setupOptions = { command: async (args: string[]) => { const result = controller(guardPositionals([...args, "--json"]), 120_000); return controllerData(result.stdout, args[0] ?? "command"); },
|
||||
@@ -444,7 +493,8 @@ export async function exploreConnectedSession(ctx: ConnectedSessionExploration):
|
||||
}
|
||||
const exploration = blockedAtLaunch ?? await runBlackBoxExploration({ session: model.session, store, map, app: { name: app.name, bundleId, platform, ...(app.version ? { version: app.version } : {}) },
|
||||
inputs, ...(hints ? { hints: hints } : {}), ...(launchUrl ? { launchUrl: launchUrl } : {}), ...(allowDestructive ? { allowDestructive: allowDestructive } : {}), ...(ctx.appIcon ? { appIcon: ctx.appIcon } : {}),
|
||||
deadlineMs, maxScreens: limits.maxScreens, maxActions: limits.maxActions, maxTurns: limits.maxActions * 3 + limits.maxScreens * 2 + 20, now, observe, progress: say,
|
||||
...(model.budgetNote ? { budgetNote: model.budgetNote } : {}),
|
||||
deadlineMs, maxScreens: limits.maxScreens, maxActions: limits.maxActions, maxTurns: turnBudget(limits), now, observe, progress: say,
|
||||
act: async action => {
|
||||
const perform = async () => {
|
||||
if (action.action === "tap" && "frameId" in action) {
|
||||
@@ -508,7 +558,8 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
|
||||
const environment = options.environment ?? process.env;
|
||||
const runner = options.runner ?? defaultRunner;
|
||||
const limits = validatedLimits(options);
|
||||
const inputs = hintInputs(options.hints, environment);
|
||||
const replay = replayPlan(options);
|
||||
const inputs = hintInputs(options.hints, environment, replay);
|
||||
if (options.bundleId !== undefined && !appIdPattern.test(options.bundleId)) throw binaryError("BUNDLE_ID_INVALID", `${options.bundleId} is not a bundle or package id.`, "Pass --bundle-id with the app's bundle identifier (iOS) or package name (Android).");
|
||||
let connection: SimulatorConnection;
|
||||
try { connection = await resolveAttachedSimulatorSession(environment, options.envFile, options.session); }
|
||||
@@ -572,7 +623,7 @@ export async function runSessionExploration(options: SessionExploreOptions): Pro
|
||||
map.run.environment = { deviceModel: device };
|
||||
session = { id: connection.sessionId, platform, device, name: info.name, ...(info.deviceRunSessionUrl ? { url: info.deviceRunSessionUrl } : {}) };
|
||||
|
||||
const model = await preflightModelSession(options, environment, say);
|
||||
const model = replay ? replayModel(replay, platform, limits) : await preflightModelSession(options, environment, say);
|
||||
const outputDirectory = await realpath(await mkdir(options.output, { recursive: true }).then(() => options.output));
|
||||
const store = new ExploreStore(outputDirectory);
|
||||
if (await store.exists()) throw binaryError("OUTPUT_NOT_EMPTY", `${outputDirectory} already holds an Explore map.`, "Pass an empty --output directory.");
|
||||
@@ -665,7 +716,8 @@ export async function runBinaryExploration(options: BinaryExploreOptions): Promi
|
||||
const environment = options.environment ?? process.env;
|
||||
const runner = options.runner ?? defaultRunner;
|
||||
const limits = validatedLimits(options);
|
||||
const inputs = hintInputs(options.hints, environment);
|
||||
const replay = replayPlan(options);
|
||||
const inputs = hintInputs(options.hints, environment, replay);
|
||||
const local = options.simulator === "local";
|
||||
// A local emulator runs this Mac's ABI (arm64-v8a on Apple silicon); EAS's runs x86_64.
|
||||
const emulatorAbi = local ? hostEmulatorAbi() : "x86_64";
|
||||
@@ -682,7 +734,7 @@ export async function runBinaryExploration(options: BinaryExploreOptions): Promi
|
||||
say(`${archive.appName} ${archive.version ?? ""} (${bundleId}, ${platform}, ${(archive.bytes / 1048576).toFixed(0)} MB, sha256 ${archive.sha256.slice(0, 12)})`);
|
||||
if (archive.missingLibs?.length && emulatorAbi === "x86_64") say(`warning: lib/x86_64 lacks ${archive.missingLibs.slice(0, 4).join(", ")}${archive.missingLibs.length > 4 ? ` and ${archive.missingLibs.length - 4} more` : ""} that another ABI ships; the app may stop with UnsatisfiedLinkError on the emulator`);
|
||||
|
||||
const model = await preflightModelSession(options, environment, say);
|
||||
const model = replay ? replayModel(replay, platform, limits) : await preflightModelSession(options, environment, say);
|
||||
|
||||
const outputDirectory = await realpath(await mkdir(options.output, { recursive: true }).then(() => options.output));
|
||||
const store = new ExploreStore(outputDirectory);
|
||||
@@ -871,6 +923,27 @@ export function guardPositionals(args: readonly string[]): string[] {
|
||||
|
||||
const KEYBOARD_RETURN_KEY = /^(return|next|done|go|continue|join)$/i;
|
||||
|
||||
/**
|
||||
* How a frame's screenshot is stored. An opened (or half-open) iPhone Duo lights its inner panel, whose native axes are
|
||||
* portrait, and shows a landscape UI on it: the tree and taps stay on the portrait axes (a 669×951 pt root, the transpose
|
||||
* of `DUO_PANELS.inner`), and a screenshot on those axes is sideways to a person, so it is turned ("turn"). Local
|
||||
* agent-device runs returned exactly that (2007×2853 px). Capture's Argent screenshots on EAS, taken with Argent's
|
||||
* LandscapeRight rotation, came back upright (2853×2007); an image that is already the root's transpose is left as it is.
|
||||
* The root is the full-screen Application node capture takes its coordinate space from, matched to within a pixel and a
|
||||
* point. A Duo frame on neither panel is "unmatched": it is stored as taken, and the caller says so. An empty tree, read
|
||||
* mid-draw, has nothing to judge.
|
||||
*/
|
||||
export function duoScreenshotTurn(frame: { platform: Platform; deviceModel: string; nodes: readonly Record<string, unknown>[]; width: number; height: number }): "turn" | "keep" | "unmatched" {
|
||||
if (frame.platform !== "ios" || !/\bduo\b/i.test(frame.deviceModel) || !frame.nodes.length) return "keep";
|
||||
const space = screenSpace(frame.nodes, frame, 1);
|
||||
if (!space) return "unmatched";
|
||||
const near = (value: number, points: number) => Math.abs(value - points) < 1;
|
||||
const portraitAxes = near(space.width, DUO_PANELS.inner.height) && near(space.height, DUO_PANELS.inner.width);
|
||||
if (portraitAxes && !space.transposed && frame.width < frame.height) return "turn";
|
||||
const panel = Object.values(DUO_PANELS).some(({ width, height }) => (near(space.width, width) && near(space.height, height)) || (near(space.width, height) && near(space.height, width)));
|
||||
return panel ? "keep" : "unmatched";
|
||||
}
|
||||
|
||||
/** A node that is not the app's UI: another package drew it (Android's system UI over the app), or it is Explore's own route marker, which an app
|
||||
* instrumented for PR runs renders as a 2x2 hidden text. */
|
||||
export function foreignNode(node: Record<string, unknown>, bundleId: string): boolean {
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
* injected, so the translation is tested against recorded Argent output.
|
||||
*/
|
||||
import { CONTROLLER_SESSION } from "./common.js";
|
||||
import { INPUT_METHOD_PACKAGES, KEYBOARD_WINDOW_IDENTIFIERS } from "./keyboard.js";
|
||||
import type { DecodedFrame } from "../shared/png-evidence.js";
|
||||
|
||||
export type ArgentPlatform = "ios" | "android";
|
||||
@@ -88,7 +89,7 @@ export function parseCommand(argv: readonly string[]): { positional: string[]; f
|
||||
}
|
||||
|
||||
type ArgentNode = { role?: string; type?: string; label?: string; identifier?: string; value?: string; contentDescription?: string; disabled?: boolean;
|
||||
frame?: Rect; traits?: string[]; hidden?: boolean; selected?: boolean; password?: boolean; bundleId?: string; children?: ArgentNode[] };
|
||||
frame?: Rect; traits?: string[]; hidden?: boolean; selected?: boolean; focused?: boolean; password?: boolean; bundleId?: string; children?: ArgentNode[] };
|
||||
export type ArgentTree = { schemaVersion?: number; source?: string; screen?: { width: number; height: number }; roots?: ArgentNode[];
|
||||
truncated?: boolean; alertVisible?: boolean; keyboardVisible?: boolean; foregroundApp?: string };
|
||||
|
||||
@@ -137,7 +138,11 @@ export function snapshotFromTree(tree: ArgentTree, platform: ArgentPlatform, gen
|
||||
if (root || !node.frame || ![node.frame.x, node.frame.y, node.frame.width, node.frame.height].every(finite)) return clip;
|
||||
return clip && intersect(node.frame, clip);
|
||||
};
|
||||
const visit = (node: ArgentNode, depth: number, parentIndex: number | undefined, appRoot: boolean, clip: Rect | undefined, root: boolean) => {
|
||||
const keyboard = platform === "ios" ? keyboardWindows(roots) : new Set<ArgentNode>();
|
||||
/** `owner` marks every node of a window that is the system keyboard's, as agent-device marks an input method's nodes. */
|
||||
type Owner = { bundleId?: string; systemKeyboard?: true };
|
||||
const visit = (node: ArgentNode, depth: number, parentIndex: number | undefined, appRoot: boolean, clip: Rect | undefined, root: boolean, owner: Owner) => {
|
||||
if (keyboard.has(node)) owner = { ...owner, systemKeyboard: true };
|
||||
const frame = node.frame;
|
||||
const inner = clipOf(node, clip, root);
|
||||
const rect = frame && [frame.x, frame.y, frame.width, frame.height].every(finite) ? toPoints(frame) : undefined;
|
||||
@@ -159,19 +164,42 @@ export function snapshotFromTree(tree: ArgentTree, platform: ArgentPlatform, gen
|
||||
rect: appRoot ? { x: 0, y: 0, width: screen.width, height: screen.height } : rect,
|
||||
...(label ? { label } : {}), ...(node.identifier ? { identifier: node.identifier } : {}),
|
||||
...(node.value !== undefined ? { value: node.value } : {}), enabled, hittable: enabled && visible && !appRoot,
|
||||
...(visible ? {} : { visible: false }), ...(node.selected || traits.includes("selected") ? { selected: true } : {}) });
|
||||
...(visible ? {} : { visible: false }), ...(node.selected || traits.includes("selected") ? { selected: true } : {}),
|
||||
// The field with the keyboard focus, as agent-device marks it, so capture can wait for the keyboard it raises.
|
||||
...(node.focused === true || traits.includes("isEditing") ? { focused: true } : {}),
|
||||
...owner });
|
||||
refs[ref] = { rect: appRoot ? { x: 0, y: 0, width: screen.width, height: screen.height } : rect, type,
|
||||
...(node.value !== undefined ? { value: node.value } : {}), ...(type === "SecureTextField" ? { secure: true } : {}) };
|
||||
}
|
||||
for (const child of node.children ?? []) visit(child, depth + 1, index, false, inner, false);
|
||||
for (const child of node.children ?? []) visit(child, depth + 1, index, false, inner, false, owner);
|
||||
};
|
||||
for (const root of roots) {
|
||||
const isAppRoot = platform === "ios" ? root.type === "Application" || nodes.length === 0 : root.bundleId === app;
|
||||
visit(root, 0, undefined, isAppRoot, { x: 0, y: 0, width: 1, height: 1 }, true);
|
||||
// An Android input method's window names its package on each node, as agent-device's do, which marks the keyboard.
|
||||
const inputMethod = platform === "android" && root.bundleId && INPUT_METHOD_PACKAGES.has(root.bundleId) ? root.bundleId : undefined;
|
||||
visit(root, 0, undefined, isAppRoot, { x: 0, y: 0, width: 1, height: 1 }, true, inputMethod ? { bundleId: inputMethod } : {});
|
||||
}
|
||||
return { nodes, refs, screen: { width: screen.width, height: screen.height } };
|
||||
}
|
||||
|
||||
/**
|
||||
* The windows iOS draws the software keyboard in. Argent lists each window as a child of its root, the app's first. A
|
||||
* later window is the keyboard's when it holds XCTest's `Keyboard` element, which no app can give itself; an identifier
|
||||
* never decides it alone, since an app can set any identifier on its own views (a second window of the app's with a
|
||||
* `testID="inputView"` stays the app's). While such a window is up, UIKit also hosts the keyboard's input view
|
||||
* placeholder in a window of its own: a later window whose only named node is an `inputView` belongs to it too.
|
||||
*/
|
||||
function keyboardWindows(roots: readonly ArgentNode[]): Set<ArgentNode> {
|
||||
const holds = (node: ArgentNode, test: (node: ArgentNode) => boolean): boolean => test(node) || (node.children ?? []).some(child => holds(child, test));
|
||||
const later = roots.flatMap(root => (root.children ?? []).slice(1));
|
||||
const keyboard = later.filter(window => holds(window, node => node.type === "Keyboard"));
|
||||
if (!keyboard.length) return new Set();
|
||||
const named = (node: ArgentNode) => Boolean(node.label?.trim() || node.contentDescription?.trim() || node.value !== undefined
|
||||
|| (node.identifier && !KEYBOARD_WINDOW_IDENTIFIERS.has(node.identifier)));
|
||||
const placeholders = later.filter(window => !keyboard.includes(window) && holds(window, node => node.identifier === "inputView") && !holds(window, named));
|
||||
return new Set([...keyboard, ...placeholders]);
|
||||
}
|
||||
|
||||
function intersect(a: Rect, b: Rect): Rect | undefined {
|
||||
const x = Math.max(a.x, b.x), y = Math.max(a.y, b.y);
|
||||
const right = Math.min(a.x + a.width, b.x + b.width), bottom = Math.min(a.y + a.height, b.y + b.height);
|
||||
@@ -216,6 +244,21 @@ const KEYBOARD_DISMISS_LABELS = ["Hide keyboard", "Dismiss keyboard", "Done"];
|
||||
const KEYBOARD_TOP = 0.4;
|
||||
const ALERT_PREFERRED_BUTTONS = ["Open", "OK", "Allow", "Allow While Using App", "Continue"];
|
||||
const READ_TOOLS = new Set(["ui-tree", "list-devices", "screenshot", "foreground-app", "await-screen-idle", "describe"]);
|
||||
/**
|
||||
* Argent 0.29's answer when a service a tool depends on (the device's simulator-server, its accessibility service) did
|
||||
* not start: the registry resolves a tool's services before it calls the tool, and wraps a start failure as
|
||||
* "[Tool:<id>] Service dependency failed: …", so the tool itself never ran and resending it is safe, a UI action too.
|
||||
* The tools the bridge sends that resolve a service while they run (keyboard, fill, restart-app, screen-recording-start)
|
||||
* resolve it before they act, and run-sequence answers a step's failure in its result rather than raising it. A failed
|
||||
* start leaves the service in the registry's ERROR state, so the next call starts it afresh.
|
||||
*/
|
||||
const SERVICE_DEPENDENCY_FAILED = "Service dependency failed:";
|
||||
/**
|
||||
* In brentvatne/euxy#172 (review run 39348956443) capture restarted SpringBoard and folded the iPhone Duo open again 8 s
|
||||
* later; that fold's simulator-server did not become ready within Argent's 30 s, and the whole target failed. The resend
|
||||
* comes after a pause, so a device still coming back from the restart has the time it needs.
|
||||
*/
|
||||
const DEPENDENCY_RETRY_DELAYS_MS = [3_000, 6_000] as const;
|
||||
const SPRINGBOARD = "com.apple.springboard";
|
||||
const ANDROID_SYSTEM_UI = "com.android.systemui";
|
||||
const OPEN_IN_APP_PROMPT = /^Open in “.+”\?$/;
|
||||
@@ -299,14 +342,23 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
|
||||
const { positional, flags } = parseCommand(rest);
|
||||
const bundleFlag = typeof flags["bundle-id"] === "string" ? flags["bundle-id"] : context.bundleId;
|
||||
|
||||
/** Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check. */
|
||||
/**
|
||||
* Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check.
|
||||
* Any tool, a UI action too, is resent when Argent could not start a service it depends on, which it raises before
|
||||
* the tool runs (see SERVICE_DEPENDENCY_FAILED).
|
||||
*/
|
||||
const call = async (tool: string, args: Record<string, unknown> = {}, options?: { out?: string }): Promise<Record<string, unknown>> => {
|
||||
// Tools that name devices their own way (or none) take no udid.
|
||||
const withDevice = tool === "list-devices" || tool === "stop-all-simulator-servers" ? args : { udid: state.udid, ...args };
|
||||
for (let attempt = 0; ; attempt++) {
|
||||
for (let readRetry = 0, dependencyRetry = 0; ;) {
|
||||
try { return record(await context.call(tool, withDevice, options)); }
|
||||
catch (error) {
|
||||
if (READ_TOOLS.has(tool) && attempt < 2) { await context.sleep(1_000 * (attempt + 1)); continue; }
|
||||
if (error instanceof ArgentCallError && error.message.includes(`[Tool:${tool}] ${SERVICE_DEPENDENCY_FAILED}`)
|
||||
&& dependencyRetry < DEPENDENCY_RETRY_DELAYS_MS.length) {
|
||||
await context.sleep(DEPENDENCY_RETRY_DELAYS_MS[dependencyRetry++]!);
|
||||
continue;
|
||||
}
|
||||
if (READ_TOOLS.has(tool) && readRetry < 2) { await context.sleep(1_000 * ++readRetry); continue; }
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
@@ -414,7 +466,9 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
|
||||
converted.nodes.push({ depth: 1, index: converted.nodes.length, parentIndex: 0, type: "Alert", ref: `e${converted.nodes.length + 1}`,
|
||||
rect: { x: 0, y: 0, width: converted.screen.width, height: converted.screen.height }, label: "System alert", enabled: true, hittable: false });
|
||||
}
|
||||
// Whether a keyboard shows, which Argent's Android tree does not hold: the input method's window is not in it.
|
||||
return success({ nodes: converted.nodes, truncated: current.truncated === true, refsGeneration: state.generation,
|
||||
...(typeof current.keyboardVisible === "boolean" ? { keyboardVisible: current.keyboardVisible } : {}),
|
||||
...(current.foregroundApp ? { appBundleId: current.foregroundApp, appName: current.foregroundApp } : {}),
|
||||
snapshotQuality: { state: "healthy", backend: "argent" } });
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import type {
|
||||
ElementRole,
|
||||
InputElement,
|
||||
} from "../types.js";
|
||||
import { INPUT_METHOD_PACKAGES, keyboardNodes } from "./keyboard.js";
|
||||
|
||||
export type ControllerParseResult = {
|
||||
controller: Controller;
|
||||
@@ -221,10 +222,7 @@ function nodeToElement(node: Record<string, unknown>): InputElement | undefined
|
||||
const SYSTEM_UI_PACKAGES = new Set([
|
||||
"android",
|
||||
"com.android.systemui",
|
||||
"com.google.android.inputmethod.latin",
|
||||
"com.samsung.android.honeyboard",
|
||||
"com.touchtype.swiftkey",
|
||||
"com.microsoft.swiftkey",
|
||||
...INPUT_METHOD_PACKAGES,
|
||||
]);
|
||||
|
||||
export function isSystemUiNode(node: Record<string, unknown>): boolean {
|
||||
@@ -240,6 +238,12 @@ function collectJsonElements(value: unknown, output: InputElement[], seen: Set<u
|
||||
return;
|
||||
}
|
||||
const record = value as Record<string, unknown>;
|
||||
// iOS's software keyboard is system UI too, like Android's: its keys and its Emoji and Dictate buttons are not the
|
||||
// app's elements. A keyboard that rose on one side only made "Added button “Dictate”" lead a review whose real
|
||||
// change was a field's label (brentvatne/euxy#172, review run 39362642343).
|
||||
if (Array.isArray(record.nodes)) {
|
||||
for (const node of keyboardNodes(record.nodes.filter((node): node is Record<string, unknown> => !!node && typeof node === "object" && !Array.isArray(node)))) seen.add(node);
|
||||
}
|
||||
const element = isSystemUiNode(record) ? undefined : nodeToElement(record);
|
||||
if (element) output.push(element);
|
||||
for (const [key, child] of Object.entries(record)) {
|
||||
|
||||
@@ -13,7 +13,8 @@ export function defaultRunner(request: CommandRequest): CommandResult {
|
||||
maxBuffer: 50 * 1024 * 1024,
|
||||
...(request.timeoutMs ? { timeout: request.timeoutMs } : {}),
|
||||
});
|
||||
if (result.error) throw result.error;
|
||||
// A command that timed out or could not run keeps what it printed on its error: a hosted repack's start names its run there.
|
||||
if (result.error) throw Object.assign(result.error, { stdout: result.stdout ?? "", stderr: result.stderr ?? "" });
|
||||
return commandOutcome(request, { status: result.status, stdout: result.stdout ?? "", stderr: result.stderr ?? "" });
|
||||
}
|
||||
|
||||
|
||||
+474
-24
@@ -1,8 +1,11 @@
|
||||
import { cp, lstat, realpath, mkdtemp, mkdir, writeFile, readFile, rename, rm } from "node:fs/promises";
|
||||
import { createHash } from "node:crypto";
|
||||
import { cp, lstat, realpath, mkdtemp, mkdir, writeFile, readFile, readdir, readlink, rename, rm } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { isAbsolute, basename, dirname, resolve, join } from "node:path";
|
||||
import { isAbsolute, basename, dirname, resolve, join, relative, sep } from "node:path";
|
||||
import { setTimeout as delay } from "node:timers/promises";
|
||||
import type { SourceRoute } from "../contracts/source-route.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { EXPLORE_VERSION } from "../shared/package-paths.js";
|
||||
import { prepareCaptureObserver, captureObserverParameterKeys } from "./observer.js";
|
||||
import { isRecord, parseJson, nonEmpty } from "./common.js";
|
||||
import { isWithin } from "./fs-safety.js";
|
||||
@@ -110,12 +113,22 @@ export function nativeBuildFrom(stdout: string): EasBuildDescriptor & { fingerpr
|
||||
};
|
||||
}
|
||||
|
||||
/** The message Explore's hosted repacks give their builds (hostedRepackWorkflow), with or without a share marker. */
|
||||
const EXPLORE_REPACK_MESSAGE = /^expo-explore (?:ios|android) capture: route observer repack\b/;
|
||||
|
||||
/**
|
||||
* The finished build to repack from `eas build:list --fingerprint-hash`: the newest one Explore did not repack itself,
|
||||
* else the newest. A repack keeps its source build's native code, and may carry its fingerprint; preferring the build
|
||||
* it came from has every job of a run pick the same one, which a shared repack's key needs (RepackShare), instead of a
|
||||
* repack another job finished a minute earlier.
|
||||
*/
|
||||
export function existingBuild(stdout: string): EasBuildDescriptor | undefined {
|
||||
const value = parseJson(stdout, "eas build:list");
|
||||
if (!Array.isArray(value)) throw new Error("eas build:list did not return a build list");
|
||||
if (value.length === 0) return undefined;
|
||||
const id = buildIdFrom(value, "eas build:list");
|
||||
const candidate = value[0];
|
||||
const index = Math.max(0, value.findIndex(build => !(isRecord(build) && typeof build.message === "string" && EXPLORE_REPACK_MESSAGE.test(build.message))));
|
||||
const candidate = value[index];
|
||||
const id = buildIdFrom([candidate], "eas build:list");
|
||||
return isRecord(candidate) ? easBuildDescriptor(candidate, id, "eas build:list") : { id };
|
||||
}
|
||||
|
||||
@@ -395,48 +408,438 @@ export function hostedRepackWorkflow(input: {
|
||||
].join("\n");
|
||||
}
|
||||
|
||||
/** The repacked build id from `eas workflow:run --json`, or the job's failure as a readable error. */
|
||||
export function hostedRepackBuildId(stdout: string, stderr: string, platform: "ios" | "android"): string {
|
||||
const logs = /See logs: (https:\/\/expo\.dev\/\S+)/.exec(stderr)?.[1];
|
||||
const where = logs ? ` Logs: ${logs}` : "";
|
||||
/**
|
||||
* Why a hosted repack failed, as far as its run tells:
|
||||
* - `app`: the app's own code broke it: the "Repack" step failed, or the logs show a bundling error. A rerun repeats it.
|
||||
* - `configuration`: EAS or a package registry refused a credential (not logged in, unauthorized, a 401 or 403).
|
||||
* - `canceled`: someone cancelled the run.
|
||||
* - `timeout`: the build ran out its EAS build time, which a rerun would wait out again, or Explore's time for the repack ran out.
|
||||
* - `unconfirmed`: Explore could not learn whether the run ended; it asked EAS to cancel it and starts no other beside it.
|
||||
* - `infrastructure`: EAS failed around the app's code: a step that sets up the job, downloads or uploads failed, or EAS
|
||||
* ended the build (brentvatne/euxy#176).
|
||||
* - `unknown`: nothing says why.
|
||||
*/
|
||||
export type HostedRepackFailure = "app" | "configuration" | "canceled" | "timeout" | "unconfirmed" | "infrastructure" | "unknown";
|
||||
|
||||
const APP_REPACK_STEP = /^Repack(?: app)?$/i;
|
||||
// Metro's, Babel's and Expo's words for the app's own code or files: `Unable to resolve "react-native-reanimated" from
|
||||
// "index.js"`, a missing module, a file an asset step could not read.
|
||||
const APP_REPACK_FAILURE = /Unable to resolve\b|SyntaxError|TransformError|Error while bundling|Bundling failed|Cannot find module|could not read \.{0,2}\/|no such file or directory, open '\.{0,2}\//i;
|
||||
// A file of EAS's own worker missing (`Cannot find module '/opt/eas/...'`) is EAS's failure, whatever the step.
|
||||
const WORKER_REPACK_FAILURE = /['"]\/opt\/eas\//;
|
||||
const CONFIGURATION_REPACK_FAILURE = /Not logged in|\bunauthori[sz]ed\b|\bnot authorized\b|\bE40[13]\b|\b40[13] (?:Unauthorized|Forbidden)\b|authentication (?:failed|required)/i;
|
||||
const TIMEOUT_REPACK_FAILURE = /\bEAS_BUILD_TIMEOUT_ERROR\b/;
|
||||
// The steps EAS runs around the app's own: setting up the job, fetching the build to repack, saving the result.
|
||||
const INFRASTRUCTURE_REPACK_STEP = /^(?:Spin up|Set up|Download|Upload)\b/i;
|
||||
// EAS's and eas-cli's own words for a failure on their side. In brentvatne/euxy#176 (review run 39506405687) EAS refused
|
||||
// the "Upload artifact" step with "Turtle build is not in progress", and the build reported "Failed to upload application archive.".
|
||||
const INFRASTRUCTURE_REPACK_FAILURE = /Turtle build is not in progress|Failed to upload application archive|\bSERVER_ERROR\b|Failed to upload project sources|Failed to start the workflow with the API|Unexpected response from server \(5\d\d\)|\b(?:ECONNRESET|ECONNREFUSED|ETIMEDOUT|ENOTFOUND|EAI_AGAIN)\b|socket hang up|fetch failed/;
|
||||
|
||||
/** How a failure reads: from the build's error, the job's errors, the failed job's logs and the CLI's output. */
|
||||
export function hostedRepackFailure(evidence: string, status?: unknown): HostedRepackFailure {
|
||||
if (status === "CANCELED") return "canceled";
|
||||
if (CONFIGURATION_REPACK_FAILURE.test(evidence)) return "configuration";
|
||||
if (WORKER_REPACK_FAILURE.test(evidence)) return "infrastructure";
|
||||
const step = [...evidence.matchAll(/Build step "([^"]+)" failed/g)].at(-1)?.[1];
|
||||
if ((step && APP_REPACK_STEP.test(step)) || APP_REPACK_FAILURE.test(evidence)) return "app";
|
||||
if (TIMEOUT_REPACK_FAILURE.test(evidence)) return "timeout";
|
||||
if ((step && INFRASTRUCTURE_REPACK_STEP.test(step)) || INFRASTRUCTURE_REPACK_FAILURE.test(evidence)) return "infrastructure";
|
||||
return "unknown";
|
||||
}
|
||||
|
||||
/** How many fresh repacks a failure earns: two after EAS's own failure, one after one nothing explains, none otherwise. */
|
||||
export function hostedRepackRetries(error: unknown): number {
|
||||
const failure = error instanceof CiError && error.code === "EAS_REPACK_FAILED" ? error.details?.failure : undefined;
|
||||
return failure === "infrastructure" ? 2 : failure === "unknown" ? 1 : 0;
|
||||
}
|
||||
|
||||
const EXPO_URL = /^https:\/\/expo\.dev\/\S+$/;
|
||||
const EAS_ID = /^[A-Za-z0-9-]{1,128}$/;
|
||||
|
||||
/**
|
||||
* The repacked build id from a finished run's JSON (`eas workflow:view --json`), or the job's failure as a readable
|
||||
* error. `evidence` is the rest of what the run said: the CLI's stderr and the failed job's logs.
|
||||
*/
|
||||
export function hostedRepackBuildId(stdout: string, evidence: string, platform: "ios" | "android"): string {
|
||||
let logs = /See logs: (https:\/\/expo\.dev\/\S+)/.exec(evidence)?.[1];
|
||||
let value: unknown;
|
||||
try {
|
||||
value = parseJson(stdout, "eas workflow:run");
|
||||
} catch (error) {
|
||||
const tail = evidence.trim().split("\n").slice(-3).join(" | ").slice(0, 600);
|
||||
throw new CiError({
|
||||
code: "EAS_REPACK_FAILED",
|
||||
stage: "instrumentation",
|
||||
message: `eas workflow:run did not report the hosted ${platform} repack: ${stderr.trim().split("\n").slice(-3).join(" | ").slice(0, 600) || (error instanceof Error ? error.message : String(error))}`,
|
||||
nextAction: `Check that EXPO_TOKEN can run workflows for this EAS project and retry.${where}`,
|
||||
message: `eas workflow:run did not report the hosted ${platform} repack: ${tail || (error instanceof Error ? error.message : String(error))}`,
|
||||
nextAction: `Check that EXPO_TOKEN can run workflows for this EAS project and retry.${logs ? ` Logs: ${logs}` : ""}`,
|
||||
details: { failure: hostedRepackFailure(evidence), ...(logs ? { logs } : {}) },
|
||||
cause: error,
|
||||
});
|
||||
}
|
||||
for (const field of ["url", "logURL"]) {
|
||||
const link = isRecord(value) ? value[field] : undefined;
|
||||
if (typeof link === "string" && EXPO_URL.test(link)) logs = link;
|
||||
}
|
||||
const where = logs ? ` Logs: ${logs}` : "";
|
||||
const jobs = isRecord(value) && Array.isArray(value.jobs) ? value.jobs.filter(isRecord) : [];
|
||||
const job = jobs.find(entry => entry.key === "repack") ?? jobs[0];
|
||||
if (!job || job.status !== "SUCCESS") {
|
||||
const build = job && isRecord(job.turtleBuild) ? job.turtleBuild : undefined;
|
||||
const detail = build && isRecord(build.error) && typeof build.error.message === "string" ? build.error.message.trim() : undefined;
|
||||
const planLimit = easPlanLimitError(new Error(`${detail ?? ""}\n${stderr}`), platform);
|
||||
const buildError = build && isRecord(build.error) ? build.error : undefined;
|
||||
const detail = typeof buildError?.message === "string" ? buildError.message.trim() : undefined;
|
||||
const planLimit = easPlanLimitError(new Error(`${detail ?? ""}\n${evidence}`), platform);
|
||||
if (planLimit) throw planLimit;
|
||||
const jobErrors = Array.isArray(job?.errors) ? job.errors.filter(isRecord).map(entry => `${String(entry.title ?? "")} ${String(entry.message ?? "")}`) : [];
|
||||
const failure = hostedRepackFailure([detail ?? "", typeof buildError?.errorCode === "string" ? buildError.errorCode : "", ...jobErrors, evidence].join("\n"),
|
||||
job?.status ?? (isRecord(value) ? value.status : undefined));
|
||||
throw new CiError({
|
||||
code: "EAS_REPACK_FAILED",
|
||||
stage: "instrumentation",
|
||||
message: `The hosted EAS repack of the ${platform} build ${job ? `finished with status ${String(job.status)}` : "did not run"}${detail ? `: ${detail.slice(0, 600)}` : "."}`,
|
||||
nextAction: `Open the EAS workflow run and fix the repack job; a broken app build environment usually surfaces in its "Repack" step.${where}`,
|
||||
details: { failure, ...(logs ? { logs } : {}) },
|
||||
});
|
||||
}
|
||||
const outputs = isRecord(job.outputs) ? job.outputs : {};
|
||||
const buildId = outputs.build_id;
|
||||
if (typeof buildId !== "string" || !/^[A-Za-z0-9-]{1,128}$/.test(buildId)) {
|
||||
if (typeof buildId !== "string" || !EAS_ID.test(buildId)) {
|
||||
throw new Error("eas workflow:run did not return the repacked build id");
|
||||
}
|
||||
return buildId;
|
||||
}
|
||||
|
||||
/**
|
||||
* The run `eas workflow:run --json` (without `--wait`) started: its id and link, from its JSON or, when the JSON is
|
||||
* missing, from the "See logs:" link it printed once the run existed. With neither, no run started, and the failure
|
||||
* says why.
|
||||
*/
|
||||
export function hostedRepackRunStart(stdout: string, stderr: string, platform: "ios" | "android"): { id: string; url?: string } {
|
||||
const printed = /See logs: (https:\/\/expo\.dev\/\S+)/.exec(stderr)?.[1];
|
||||
let value: unknown;
|
||||
try { value = JSON.parse(stdout); } catch { value = undefined; }
|
||||
const url = isRecord(value) && typeof value.url === "string" && EXPO_URL.test(value.url) ? value.url : printed;
|
||||
const id = isRecord(value) && typeof value.id === "string" ? value.id : url ? /\/workflows\/([^/?#\s]+)$/.exec(url)?.[1] : undefined;
|
||||
if (id && EAS_ID.test(id)) return { id, ...(url ? { url } : {}) };
|
||||
const tail = stderr.trim().split("\n").slice(-3).join(" | ").slice(0, 600);
|
||||
throw new CiError({ code: "EAS_REPACK_FAILED", stage: "instrumentation",
|
||||
message: `eas workflow:run did not start the hosted ${platform} repack: ${tail || "it printed no run"}`,
|
||||
nextAction: "Check that EXPO_TOKEN can run workflows for this EAS project and retry.",
|
||||
details: { failure: hostedRepackFailure(stderr) } });
|
||||
}
|
||||
|
||||
/**
|
||||
* The most time preparing the app may take once the build to repack is known: waiting for another job's repack,
|
||||
* following it, and every repack this job starts, each run's wait included. It replaces a 30-minute wait per run, which
|
||||
* with a share wait and two retries let one capture prepare for over an hour; a capture whose app takes longer than
|
||||
* the session's allowance (SESSION_PREPARATION_MINUTES in run.ts) gets a fresh session.
|
||||
*/
|
||||
export const HOSTED_REPACK_BUDGET_MS = 30 * 60_000;
|
||||
/** A repack starts only with this much of the budget left: a typical one takes about five minutes. */
|
||||
const HOSTED_REPACK_MIN_ATTEMPT_MS = 5 * 60_000;
|
||||
/** How often a running repack's state is read, and how many unreadable reads in a row mean Explore cannot tell. */
|
||||
const HOSTED_REPACK_POLL_MS = 20_000;
|
||||
const HOSTED_REPACK_UNREADABLE_READS = 6;
|
||||
const TERMINAL_RUN_STATUSES = new Set(["SUCCESS", "FAILURE", "CANCELED"]);
|
||||
|
||||
/** What the hosted repack waits and reports with: the end of its budget, the clock and pause (tests replace both), and an abort. */
|
||||
type RepackClock = { deadline: number; now: () => number; sleep?: ((milliseconds: number) => void) | undefined; signal?: AbortSignal | undefined };
|
||||
|
||||
async function pause(milliseconds: number, clock: RepackClock): Promise<void> {
|
||||
if (clock.sleep) clock.sleep(milliseconds);
|
||||
else {
|
||||
try { await delay(milliseconds, undefined, clock.signal ? { signal: clock.signal } : {}); }
|
||||
catch (error) { clock.signal?.throwIfAborted(); throw error; }
|
||||
}
|
||||
clock.signal?.throwIfAborted();
|
||||
}
|
||||
|
||||
function timeoutError(platform: "ios" | "android", detail: string, logs?: string): CiError {
|
||||
return new CiError({ code: "EAS_REPACK_FAILED", stage: "instrumentation",
|
||||
message: `The hosted EAS repack of the ${platform} build did not finish within the ${HOSTED_REPACK_BUDGET_MS / 60_000} minutes a capture has to prepare its app: ${detail}.`,
|
||||
nextAction: `Check the EAS workflow run for a long queue or a stuck step, then rerun Explore.${logs ? ` Logs: ${logs}` : ""}`,
|
||||
details: { failure: "timeout", ...(logs ? { logs } : {}) } });
|
||||
}
|
||||
|
||||
/**
|
||||
* The failed step's logs from `eas workflow:logs --json` (the step that logged `Build step "…" failed`, else the last
|
||||
* with any lines), so that a warning another step printed does not decide the failure; nothing when unreadable.
|
||||
*/
|
||||
function workflowLogText(stdout: string): string {
|
||||
try {
|
||||
const value: unknown = JSON.parse(stdout);
|
||||
if (!isRecord(value)) return "";
|
||||
const steps = Object.values(value).map(lines => Array.isArray(lines) ? lines.filter(isRecord).map(line => String(line.msg ?? "")) : []).filter(lines => lines.length);
|
||||
const failed = [...steps].reverse().find(lines => lines.some(line => /Build step "[^"]+" failed/.test(line))) ?? steps.at(-1) ?? [];
|
||||
return failed.slice(-400).join("\n");
|
||||
} catch { return ""; }
|
||||
}
|
||||
|
||||
type EasCall = (args: string[], timeoutMs: number, options?: { cwd?: string; strict?: boolean }) => { stdout: string; stderr: string };
|
||||
|
||||
/** What a command that threw still printed: defaultRunner keeps a timed-out or signalled command's output on its error. */
|
||||
function printedBy(error: unknown): { stdout: string; stderr: string } {
|
||||
const value = error as { stdout?: unknown; stderr?: unknown } | undefined;
|
||||
return { stdout: typeof value?.stdout === "string" ? value.stdout : "", stderr: typeof value?.stderr === "string" ? value.stderr : "" };
|
||||
}
|
||||
|
||||
/**
|
||||
* One hosted repack run: started without `--wait`, so Explore always knows the run and waits on it within its own
|
||||
* budget. eas-cli's `--wait` gives up after six failed status reads with exit code 13 and leaves the run going, and
|
||||
* Explore then started another beside it. A run whose state stays unreadable, that outlasts the budget, or whose
|
||||
* capture is stopped is cancelled (`eas workflow:cancel`) and not replaced: only a run EAS reports finished is
|
||||
* followed by another. A start that timed out or was stopped is waited on when it printed its run, and otherwise
|
||||
* not replaced, since it may have started one.
|
||||
*/
|
||||
async function hostedRepackRun(options: { eas: EasCall; staged: string; platform: "ios" | "android"; clock: RepackClock }): Promise<string> {
|
||||
const { clock, platform } = options;
|
||||
let started: { stdout: string; stderr: string };
|
||||
let startFailure: unknown;
|
||||
try { started = options.eas(["workflow:run", HOSTED_REPACK_WORKFLOW, "--json", "--non-interactive"], Math.min(10 * 60_000, clock.deadline - clock.now()), { cwd: options.staged }); }
|
||||
catch (error) { started = printedBy(error); startFailure = error; }
|
||||
let run: { id: string; url?: string };
|
||||
try { run = hostedRepackRunStart(started.stdout, started.stderr, platform); }
|
||||
catch (error) {
|
||||
if (startFailure === undefined) throw error;
|
||||
throw new CiError({ code: "EAS_REPACK_FAILED", stage: "instrumentation",
|
||||
message: `eas workflow:run did not finish starting the hosted ${platform} repack (${startFailure instanceof Error ? startFailure.message : String(startFailure)}), and printed no run: one may have started, so Explore does not start another.`,
|
||||
nextAction: "Check the project's workflow runs on expo.dev, cancel a repack still running, and rerun Explore.",
|
||||
details: { failure: "unconfirmed" }, cause: startFailure });
|
||||
}
|
||||
const cancel = (): boolean => {
|
||||
try { options.eas(["workflow:cancel", run.id, "--non-interactive"], 2 * 60_000, { strict: true }); return true; } catch { return false; }
|
||||
};
|
||||
try {
|
||||
let unreadable = 0;
|
||||
for (;;) {
|
||||
clock.signal?.throwIfAborted();
|
||||
let view = { stdout: "", stderr: "" };
|
||||
try { view = options.eas(["workflow:view", run.id, "--json", "--non-interactive"], 2 * 60_000); } catch { /* Counted as an unreadable read below. */ }
|
||||
let value: unknown;
|
||||
try { value = JSON.parse(view.stdout); } catch { value = undefined; }
|
||||
const status = isRecord(value) && typeof value.status === "string" ? value.status : undefined;
|
||||
if (status && TERMINAL_RUN_STATUSES.has(status)) {
|
||||
const jobs = isRecord(value) && Array.isArray(value.jobs) ? value.jobs.filter(isRecord) : [];
|
||||
const job = jobs.find(entry => entry.key === "repack") ?? jobs[0];
|
||||
let logs = "";
|
||||
if (status === "FAILURE" && typeof job?.id === "string" && EAS_ID.test(job.id)) {
|
||||
try { logs = workflowLogText(options.eas(["workflow:logs", job.id, "--json", "--non-interactive"], 2 * 60_000).stdout); } catch { /* The build's error still classifies it. */ }
|
||||
}
|
||||
return hostedRepackBuildId(view.stdout, `${started.stderr}\n${logs}`, platform);
|
||||
}
|
||||
unreadable = status ? 0 : unreadable + 1;
|
||||
if (unreadable >= HOSTED_REPACK_UNREADABLE_READS) {
|
||||
const cancelled = cancel();
|
||||
throw new CiError({ code: "EAS_REPACK_FAILED", stage: "instrumentation",
|
||||
message: `EAS did not report the state of the hosted ${platform} repack ${HOSTED_REPACK_UNREADABLE_READS} times in a row; ${cancelled ? "Explore cancelled the run" : "Explore could not cancel the run"} and did not start another beside it.`,
|
||||
nextAction: `Check the EAS status and the run${cancelled ? "" : ", and cancel it if it is still going"}, then rerun Explore.${run.url ? ` Logs: ${run.url}` : ""}`,
|
||||
details: { failure: "unconfirmed", ...(run.url ? { logs: run.url } : {}) } });
|
||||
}
|
||||
const left = clock.deadline - clock.now();
|
||||
if (left <= 0) {
|
||||
const cancelled = cancel();
|
||||
throw timeoutError(platform, `run ${run.id} was still ${status ?? "unreadable"}; ${cancelled ? "it was cancelled" : "it could not be cancelled"}`, run.url);
|
||||
}
|
||||
await pause(Math.min(HOSTED_REPACK_POLL_MS, left), clock);
|
||||
}
|
||||
} catch (error) {
|
||||
// A capture stopped while its repack runs (a cancelled job, Ctrl+C) leaves no run behind it.
|
||||
if (clock.signal?.aborted) cancel();
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Where the matrix jobs of one GitHub run attempt meet to make one hosted repack of an app instead of one each: `scope`
|
||||
* names the run attempt (repository, run id and attempt), `leader` the first target in config order that repacks this
|
||||
* app, `target` this one, `rank` its place among them (the leader's is 0), and `rerun` an attempt after the first, which
|
||||
* runs only the jobs it re-runs. In brentvatne/euxy#176 (review run 39506405687) four iOS targets each repacked EAS
|
||||
* build a81d5d80 with the same commit's JavaScript at the same time, and one of the four failed.
|
||||
*/
|
||||
export type RepackShare = { scope: string; leader: string; target: string; rank: number; rerun?: boolean };
|
||||
|
||||
/** How long the target after the leader waits for a repack to appear on EAS before it repacks itself. */
|
||||
const SHARED_REPACK_APPEAR_MS = 3 * 60_000;
|
||||
/**
|
||||
* Each later target waits this much longer, so that when the leader makes no repack (its baseline covered every route,
|
||||
* or `max-parallel` kept it out of the first jobs) the next target's repack has appeared before the one after it would
|
||||
* start another: the targets join one repack instead of all starting their own at the same moment.
|
||||
*/
|
||||
const SHARED_REPACK_STAGGER_MS = 60_000;
|
||||
/** How long a target whose followed repack failed looks for the repack that replaces it (the leader's retry) before repacking itself. */
|
||||
const SHARED_REPACK_GRACE_MS = 60_000;
|
||||
/** Polls while no repack is followed, and while one is. */
|
||||
const SHARED_REPACK_APPEAR_POLL_MS = 15_000;
|
||||
const SHARED_REPACK_FOLLOW_POLL_MS = 30_000;
|
||||
/** The recent builds of the platform a look reads (eas-cli's most): one this run made minutes ago is among them. */
|
||||
const SHARED_REPACK_LIST_LIMIT = 50;
|
||||
|
||||
/**
|
||||
* Every byte the hosted repack would upload, as one digest: the staged checkout's tracked files and the generated
|
||||
* observer, path by path, with their kind, executable bit and content (a symlink by its target).
|
||||
*/
|
||||
export async function stagedProjectDigest(root: string): Promise<string> {
|
||||
const hash = createHash("sha256");
|
||||
const entries = (await readdir(root, { recursive: true, withFileTypes: true }))
|
||||
.map(entry => ({ entry, path: relative(root, join(entry.parentPath, entry.name)).split(sep).join("/") }))
|
||||
.sort((a, b) => a.path < b.path ? -1 : a.path > b.path ? 1 : 0);
|
||||
for (const { entry, path } of entries) {
|
||||
const full = join(root, path);
|
||||
if (entry.isSymbolicLink()) hash.update(`link\0${path}\0${await readlink(full)}\0`);
|
||||
else if (entry.isDirectory()) hash.update(`directory\0${path}\0`);
|
||||
else if (entry.isFile()) {
|
||||
const executable = ((await lstat(full)).mode & 0o111) !== 0;
|
||||
hash.update(`file\0${path}\0${executable ? "x" : "-"}\0${createHash("sha256").update(await readFile(full)).digest("hex")}\0`);
|
||||
} else throw new Error(`The staged copy holds ${path}, which is neither a file, a directory nor a symlink`);
|
||||
}
|
||||
return hash.digest("hex");
|
||||
}
|
||||
|
||||
/**
|
||||
* The key a shared repack's build carries in its message: everything the repack is made from, so two jobs share one only
|
||||
* when each would have uploaded the same bytes for the same native build, profile, EAS environment (by name and by a
|
||||
* snapshot of its variables) and Explore release, in the same run attempt.
|
||||
*/
|
||||
export function hostedRepackShareKey(input: { scope: string; platform: "ios" | "android"; nativeBuildId: string; easProfile: string;
|
||||
environment: string; environmentVariables: string; project: string }): string {
|
||||
return createHash("sha256").update(JSON.stringify({ contract: "expo-explore.repack-share.v2", explore: EXPLORE_VERSION, scope: input.scope,
|
||||
platform: input.platform, nativeBuildId: input.nativeBuildId, easProfile: input.easProfile, environment: input.environment,
|
||||
environmentVariables: input.environmentVariables, project: input.project })).digest("hex").slice(0, 32);
|
||||
}
|
||||
|
||||
/** The marker a shared repack's build message ends with. */
|
||||
export function hostedRepackShareMarker(key: string): string {
|
||||
return `[explore share ${key}]`;
|
||||
}
|
||||
|
||||
type ListedBuild = { id: string; status: string };
|
||||
|
||||
function sharedRepackBuild(build: unknown, marker: string, platform: "ios" | "android"): ListedBuild | undefined {
|
||||
return isRecord(build) && typeof build.id === "string" && EAS_ID.test(build.id) && typeof build.status === "string"
|
||||
&& typeof build.message === "string" && build.message.endsWith(marker) && String(build.platform).toLowerCase() === platform
|
||||
? { id: build.id, status: build.status } : undefined;
|
||||
}
|
||||
|
||||
/** The builds `eas build:list --json` lists that carry `marker` for `platform`, or undefined when the list is unreadable. */
|
||||
export function sharedRepackBuilds(stdout: string, marker: string, platform: "ios" | "android"): ListedBuild[] | undefined {
|
||||
let value: unknown;
|
||||
try { value = JSON.parse(stdout); } catch { return undefined; }
|
||||
if (!Array.isArray(value)) return undefined;
|
||||
return value.flatMap(build => sharedRepackBuild(build, marker, platform) ?? []);
|
||||
}
|
||||
|
||||
/** One build from `eas build:view --json`: null when it no longer carries `marker` for `platform`, undefined when unreadable. */
|
||||
export function sharedRepackBuildView(stdout: string, marker: string, platform: "ios" | "android"): ListedBuild | null | undefined {
|
||||
let value: unknown;
|
||||
try { value = JSON.parse(stdout); } catch { return undefined; }
|
||||
return isRecord(value) ? sharedRepackBuild(value, marker, platform) ?? null : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* A snapshot of the EAS environment's variables the repack job reads: `eas env:list --format long` of the project's
|
||||
* and the account's variables, which names each with its value (masked when sensitive or secret) and when it was last
|
||||
* updated, so an edited value changes it. Undefined when either list fails.
|
||||
*/
|
||||
function easEnvironmentSnapshot(list: (scope: "project" | "account") => string | undefined): string | undefined {
|
||||
const project = list("project"), account = list("account");
|
||||
if (project === undefined || account === undefined) return undefined;
|
||||
return createHash("sha256").update(JSON.stringify([project, account])).digest("hex");
|
||||
}
|
||||
|
||||
const LIVE_BUILD_STATUSES = new Set(["NEW", "IN_QUEUE", "IN_PROGRESS"]);
|
||||
|
||||
/**
|
||||
* How long a target looks for another's repack before it repacks itself: the leader not at all, and each target after it
|
||||
* SHARED_REPACK_STAGGER_MS longer than the one before, from SHARED_REPACK_APPEAR_MS. A re-run attempt's leader may not
|
||||
* run again, so there the stagger starts at once. After a followed repack failed, the wait is SHARED_REPACK_GRACE_MS,
|
||||
* staggered the same way.
|
||||
*/
|
||||
export function sharedRepackWaitMs(share: Pick<RepackShare, "rank" | "rerun">, afterFailure = false): number {
|
||||
const later = Math.max(0, share.rank - 1) * SHARED_REPACK_STAGGER_MS;
|
||||
if (afterFailure) return SHARED_REPACK_GRACE_MS + later;
|
||||
if (share.rank === 0) return 0;
|
||||
return share.rerun ? share.rank * SHARED_REPACK_STAGGER_MS : SHARED_REPACK_APPEAR_MS + later;
|
||||
}
|
||||
|
||||
/**
|
||||
* A repack another job of this run attempt made, or is making, of exactly this app: its EAS build id once it finished,
|
||||
* or undefined when this job should repack itself.
|
||||
* - The leader looks once. Another target looks every 15 s for as long as sharedRepackWaitMs gives it, and joins any
|
||||
* repack with the key it finds, whichever job started it.
|
||||
* - A repack it finds is then read by its id every 30 s (a list of recent builds can lose it on a busy project).
|
||||
* - One that fails, or no longer carries the key, is set aside, and for SHARED_REPACK_GRACE_MS the target looks for
|
||||
* another with the key (the leader's retry, at once in brentvatne/euxy#176) before it repacks itself.
|
||||
* - Looking stops while the budget still has time for a repack of this job's own, and following stops at the end of
|
||||
* the budget. Three unreadable reads in a row also end the wait: it never waits on a job that cannot answer.
|
||||
*/
|
||||
async function sharedHostedRepack(options: { share: RepackShare; marker: string; platform: "ios" | "android"; list: () => string;
|
||||
view: (id: string) => string; say: (message: string) => void; clock: RepackClock }): Promise<string | undefined> {
|
||||
const { clock, say } = options;
|
||||
const start = clock.now();
|
||||
const lookLatest = clock.deadline - HOSTED_REPACK_MIN_ATTEMPT_MS;
|
||||
const firstWait = sharedRepackWaitMs(options.share);
|
||||
let lookUntil = Math.min(start + firstWait, lookLatest);
|
||||
let followed: string | undefined;
|
||||
const setAside = new Set<string>();
|
||||
let unreadable = 0;
|
||||
let announced = false;
|
||||
for (;;) {
|
||||
clock.signal?.throwIfAborted();
|
||||
let read: ListedBuild[] | null | undefined;
|
||||
try {
|
||||
if (followed) {
|
||||
const build = sharedRepackBuildView(options.view(followed), options.marker, options.platform);
|
||||
read = build === undefined ? undefined : build === null ? [] : [build];
|
||||
} else read = sharedRepackBuilds(options.list(), options.marker, options.platform);
|
||||
} catch { read = undefined; }
|
||||
if (!read) {
|
||||
unreadable += 1;
|
||||
if (unreadable >= 3) { say("EAS did not answer three times in a row; repacking here instead of waiting for another target's repack"); return undefined; }
|
||||
} else {
|
||||
unreadable = 0;
|
||||
const builds = read.filter(build => !setAside.has(build.id));
|
||||
const finished = builds.find(build => build.status === "FINISHED");
|
||||
if (finished) {
|
||||
say(`using EAS build ${finished.id}, the hosted repack of this commit another target of this run made, instead of repacking it again`);
|
||||
return finished.id;
|
||||
}
|
||||
const live = builds.find(build => LIVE_BUILD_STATUSES.has(build.status));
|
||||
if (followed && !live) {
|
||||
say(`the shared repack (EAS build ${followed}) ${read[0] ? `ended ${read[0].status}` : "no longer carries this commit's key"}; looking for another for up to ${sharedRepackWaitMs(options.share, true) / 1000} s before repacking here`);
|
||||
setAside.add(followed);
|
||||
followed = undefined;
|
||||
lookUntil = Math.min(clock.now() + sharedRepackWaitMs(options.share, true), lookLatest);
|
||||
} else if (!followed && live) {
|
||||
followed = live.id;
|
||||
say(`waiting for EAS build ${live.id}, the hosted repack of this commit another target of this run started, instead of repacking it again`);
|
||||
}
|
||||
}
|
||||
const now = clock.now();
|
||||
if (followed && now >= clock.deadline) {
|
||||
say(`the shared repack (EAS build ${followed}) did not finish in the time this capture has to prepare its app`);
|
||||
return undefined;
|
||||
}
|
||||
if (!followed && now >= lookUntil) {
|
||||
if (setAside.size) say("no other repack of this commit appeared; repacking here");
|
||||
else if (firstWait) say(`no repack of this commit from ${options.share.leader} or another target appeared within ${Math.round((now - start) / 60_000)} minutes; repacking here`);
|
||||
return undefined;
|
||||
}
|
||||
if (!followed && !announced && firstWait) {
|
||||
announced = true;
|
||||
say(`waiting up to ${Math.round(firstWait / 60_000)} minutes for the hosted repack ${options.share.leader} or another target makes of this commit, instead of repacking it again`);
|
||||
}
|
||||
const until = followed ? clock.deadline : lookUntil;
|
||||
await pause(Math.max(0, Math.min(followed ? SHARED_REPACK_FOLLOW_POLL_MS : SHARED_REPACK_APPEAR_POLL_MS, until - now)), clock);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Repack on EAS instead of the runner: the tracked files of the clean checkout are staged beside the
|
||||
* observer and a one-job workflow, uploaded with `eas workflow:run`, and the job's `build_id` comes back.
|
||||
* No build tools, no `eas upload`, and the profile's EAS environment applies as it does for any build.
|
||||
* With a `share`, a repack another job of this run attempt makes of the same staged bytes is used instead
|
||||
* (sharedHostedRepack), and this job's own repack carries the key that lets the others use it. A repack that fails
|
||||
* for a reason a rerun can fix starts again (hostedRepackRetries): in brentvatne/euxy#176 EAS ended a build that had
|
||||
* repacked before it could save the app. All of it stays within the capture's budget (`clock.deadline`).
|
||||
*/
|
||||
async function prepareHostedRepack(options: {
|
||||
platform: "ios" | "android";
|
||||
@@ -451,7 +854,11 @@ async function prepareHostedRepack(options: {
|
||||
provider: SourceRoute["provider"];
|
||||
parameterKeys: readonly string[];
|
||||
root: string;
|
||||
share?: RepackShare | undefined;
|
||||
say: (message: string) => void;
|
||||
clock: RepackClock;
|
||||
}): Promise<string> {
|
||||
const { clock, platform } = options;
|
||||
const staged = join(options.root, "project");
|
||||
await mkdir(staged, { mode: 0o700 });
|
||||
// Paths relative to the app directory, which is what is staged. With --full-name they were relative to the
|
||||
@@ -481,19 +888,51 @@ async function prepareHostedRepack(options: {
|
||||
message: error instanceof Error ? error.message : "The route observer could not be prepared.",
|
||||
nextAction: "Check the installed Expo and navigation package compatibility for automatic capture instrumentation.", cause: error });
|
||||
}
|
||||
const privateEnvironment = { ...options.easEnvironment, TMPDIR: options.root, TMP: options.root, TEMP: options.root };
|
||||
// Reads may fail and say so in their output; `strict` makes a failed command throw (a cancel that did not happen).
|
||||
const eas: EasCall = (args, timeoutMs, { cwd = options.project, strict = false } = {}) => options.runner({ command: options.easCommand, args, cwd,
|
||||
environment: cwd === staged ? { ...privateEnvironment, EAS_NO_VCS: "1" } : privateEnvironment, timeoutMs, ...(strict ? {} : { allowFailure: true }) });
|
||||
let message = `expo-explore ${platform} capture: route observer repack`;
|
||||
if (options.share) {
|
||||
const environment = options.repackProfile.easEnvironment;
|
||||
const variables = easEnvironmentSnapshot(scope => {
|
||||
try {
|
||||
const listedVariables = options.runner({ command: options.easCommand, args: ["env:list", "--environment", environment, "--scope", scope, "--format", "long", "--non-interactive"],
|
||||
cwd: options.project, environment: privateEnvironment, timeoutMs: 2 * 60_000 });
|
||||
return listedVariables.stdout;
|
||||
} catch { return undefined; }
|
||||
});
|
||||
if (variables === undefined) options.say(`EAS did not list the ${environment} environment's variables; repacking here without sharing the repack`);
|
||||
else {
|
||||
// The digest is taken before the workflow file is written: the file's message carries the key made from it.
|
||||
const marker = hostedRepackShareMarker(hostedRepackShareKey({ scope: options.share.scope, platform, nativeBuildId: options.nativeBuildId,
|
||||
easProfile: options.easProfile, environment, environmentVariables: variables, project: await stagedProjectDigest(staged) }));
|
||||
const shared = await sharedHostedRepack({ share: options.share, marker, platform, say: options.say, clock,
|
||||
list: () => eas(["build:list", "--platform", platform, "--limit", String(SHARED_REPACK_LIST_LIMIT), "--json", "--non-interactive"], 2 * 60_000).stdout,
|
||||
view: id => eas(["build:view", id, "--json"], 2 * 60_000).stdout });
|
||||
if (shared) return shared;
|
||||
message = `${message} ${marker}`;
|
||||
}
|
||||
}
|
||||
const workflowPath = join(staged, HOSTED_REPACK_WORKFLOW);
|
||||
await mkdir(dirname(workflowPath), { recursive: true });
|
||||
await writeFile(workflowPath, hostedRepackWorkflow({ buildId: options.nativeBuildId, profile: options.easProfile,
|
||||
environment: options.repackProfile.easEnvironment, message: `expo-explore ${options.platform} capture: route observer repack` }), { flag: "wx", mode: 0o600 });
|
||||
const run = options.runner({
|
||||
command: options.easCommand,
|
||||
args: ["workflow:run", HOSTED_REPACK_WORKFLOW, "--wait", "--json", "--non-interactive"],
|
||||
cwd: staged,
|
||||
environment: { ...options.easEnvironment, EAS_NO_VCS: "1", TMPDIR: options.root, TMP: options.root, TEMP: options.root },
|
||||
timeoutMs: 30 * 60_000,
|
||||
allowFailure: true,
|
||||
});
|
||||
return hostedRepackBuildId(run.stdout, run.stderr, options.platform);
|
||||
environment: options.repackProfile.easEnvironment, message }), { flag: "wx", mode: 0o600 });
|
||||
let retries = 0;
|
||||
for (;;) {
|
||||
if (clock.deadline - clock.now() < HOSTED_REPACK_MIN_ATTEMPT_MS) throw timeoutError(platform, retries ? "too little time was left for another repack" : "too little time was left for a repack of its own");
|
||||
try {
|
||||
return await hostedRepackRun({ eas, staged, platform, clock });
|
||||
} catch (error) {
|
||||
// Only a run EAS reported finished gets here with a failure that earns another (hostedRepackRun), so none is left beside it.
|
||||
const allowed = hostedRepackRetries(error);
|
||||
if (retries >= allowed || clock.deadline - clock.now() < HOSTED_REPACK_MIN_ATTEMPT_MS) throw error;
|
||||
retries += 1;
|
||||
const logs = error instanceof CiError && typeof error.details?.logs === "string" ? error.details.logs : undefined;
|
||||
options.say(`the hosted EAS repack${logs ? ` ${logs}` : ""} failed (${error instanceof Error ? error.message : String(error)}); starting another repack (${retries}/${allowed})`);
|
||||
clock.signal?.throwIfAborted();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -520,6 +959,16 @@ export async function prepareExactSourceBuild(options: {
|
||||
easProfile?: string | undefined;
|
||||
/** Where to leave the instrumented app on this machine, for the capture to install; it must not exist yet. */
|
||||
keepApp: string;
|
||||
/** The other matrix jobs of this run that repack the same app, to make one hosted repack with (RepackShare). */
|
||||
share?: RepackShare | undefined;
|
||||
/** Says what the hosted repack is doing when it waits for another job's repack or starts another one. */
|
||||
progress?: ((message: string) => void) | undefined;
|
||||
/** When preparing the app must be done by (HOSTED_REPACK_BUDGET_MS after the session started beside it), on `now`'s clock. */
|
||||
deadline?: number | undefined;
|
||||
/** The clock and pause the waits and retries use; tests replace them so that minutes are not real time. */
|
||||
now?: (() => number) | undefined;
|
||||
sleep?: ((milliseconds: number) => void) | undefined;
|
||||
signal?: AbortSignal | undefined;
|
||||
}): Promise<PreparedBuild | undefined> {
|
||||
const platform = options.platform ?? "ios";
|
||||
const root = await mkdtemp(join(tmpdir(), "expo-explore-repack-"));
|
||||
@@ -535,7 +984,8 @@ export async function prepareExactSourceBuild(options: {
|
||||
const hosted = await prepareHostedRepack({ platform, runner: options.runner, easCommand: options.easCommand, project: options.project,
|
||||
nativeBuildId: options.nativeBuildId, easProfile: options.easProfile, repackProfile: options.repackProfile,
|
||||
easEnvironment: options.easEnvironment, restrictedEnvironment: options.repackEnvironment, provider: providers[0]!,
|
||||
parameterKeys: captureObserverParameterKeys(options.routes), root });
|
||||
parameterKeys: captureObserverParameterKeys(options.routes), root, share: options.share, say: options.progress ?? (() => undefined),
|
||||
clock: { deadline: options.deadline ?? (options.now ?? Date.now)() + HOSTED_REPACK_BUDGET_MS, now: options.now ?? Date.now, sleep: options.sleep, signal: options.signal } });
|
||||
{
|
||||
// The hosted job leaves its app on EAS; the capture installs a copy downloaded here.
|
||||
const downloaded = await downloadedAppPath(options.runner({ command: options.easCommand,
|
||||
|
||||
@@ -0,0 +1,146 @@
|
||||
/**
|
||||
* The system software keyboard in a controller snapshot (agent-device's flat `nodes`, which the Argent bridge also
|
||||
* returns), and how long capture waits for it. Recognition is deliberately narrow: dropping one of the app's own elements
|
||||
* hides a real change, which is worse than the keyboard noise this removes. A node is the keyboard's only when it, or a
|
||||
* node above it, provably belongs to the system keyboard; nothing is inferred from where an element sits on the screen,
|
||||
* and a `Key` alone proves nothing (React Native's `accessibilityRole="keyboardkey"` gives an app's PIN pad that type).
|
||||
*/
|
||||
|
||||
type Rect = { x: number; y: number; width: number; height: number };
|
||||
type SnapshotNode = Record<string, unknown>;
|
||||
|
||||
/** Android input methods: their windows name the IME's package, not the app's. */
|
||||
export const INPUT_METHOD_PACKAGES: ReadonlySet<string> = new Set([
|
||||
"com.google.android.inputmethod.latin",
|
||||
"com.android.inputmethod.latin",
|
||||
"com.samsung.android.honeyboard",
|
||||
"com.touchtype.swiftkey",
|
||||
"com.microsoft.swiftkey",
|
||||
]);
|
||||
|
||||
/**
|
||||
* UIKit's identifiers for the input view placeholder and the prediction bar. They mark a window as the keyboard's (see
|
||||
* the Argent bridge's `keyboardWindows`); inside the app's own window an element with one of them is the app's.
|
||||
*/
|
||||
export const KEYBOARD_WINDOW_IDENTIFIERS: ReadonlySet<string> = new Set(["inputView", "SystemInputAssistantView"]);
|
||||
|
||||
/**
|
||||
* The keyboard's native view classes, which agent-device's host accessibility bridge reports as `role`. The dock's Emoji
|
||||
* and Dictate buttons (UIKeyboardDockItemButton) can sit outside the key plane's bounds, so they are named here.
|
||||
*/
|
||||
const KEYBOARD_VIEW_CLASSES = new Set(["UIKeyboardDockItemButton", "UIAccessibilityElementKBKey", "UIKeyboardLayoutStar",
|
||||
"TUIPredictionView", "TUIPredictionViewCell", "_UIRemoteKeyboardPlaceholderView", "TUISystemInputAssistantView",
|
||||
"TUISystemInputAssistantPageView"]);
|
||||
|
||||
const EDITABLE_TYPES = new Set(["textfield", "securetextfield", "searchfield", "textview"]);
|
||||
|
||||
const text = (value: unknown) => typeof value === "string" ? value : "";
|
||||
|
||||
function rectOf(node: SnapshotNode): Rect | undefined {
|
||||
const rect = node.rect as Partial<Rect> | undefined;
|
||||
return rect && [rect.x, rect.y, rect.width, rect.height].every(Number.isFinite) && rect.width! > 0 && rect.height! > 0 ? rect as Rect : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* A node that belongs to the system keyboard by what it is, not where it is: XCTest's `Keyboard` element (both
|
||||
* controllers), a node of a window the Argent bridge found to be the keyboard's (`systemKeyboard`), one of the keyboard's
|
||||
* native view classes, or a node of an Android input method's window.
|
||||
*/
|
||||
function keyboardRoot(node: SnapshotNode): boolean {
|
||||
return node.systemKeyboard === true || text(node.type).toLowerCase() === "keyboard" || KEYBOARD_VIEW_CLASSES.has(text(node.role))
|
||||
|| INPUT_METHOD_PACKAGES.has(text(node.bundleId ?? node.packageName ?? node.package));
|
||||
}
|
||||
|
||||
/** Every node that belongs to the system keyboard: those `keyboardRoot` names and the nodes beneath them. */
|
||||
export function keyboardNodes(nodes: readonly SnapshotNode[]): Set<SnapshotNode> {
|
||||
const owned = new Set<SnapshotNode>();
|
||||
if (!nodes.some(keyboardRoot)) return owned;
|
||||
// Only an explicit parent links a node to a keyboard above it: a node without one is no node's descendant.
|
||||
const byIndex = new Map(nodes.filter(node => typeof node.index === "number").map(node => [node.index as number, node]));
|
||||
for (const node of nodes) {
|
||||
const seen = new Set<SnapshotNode>();
|
||||
for (let current: SnapshotNode | undefined = node; current && !seen.has(current);
|
||||
current = typeof current.parentIndex === "number" ? byIndex.get(current.parentIndex) : undefined) {
|
||||
seen.add(current);
|
||||
if (keyboardRoot(current)) { owned.add(node); break; }
|
||||
}
|
||||
}
|
||||
return owned;
|
||||
}
|
||||
|
||||
function union(rects: readonly Rect[]): Rect | undefined {
|
||||
if (!rects.length) return undefined;
|
||||
const x = Math.min(...rects.map(rect => rect.x)), y = Math.min(...rects.map(rect => rect.y));
|
||||
return { x, y, width: Math.max(...rects.map(rect => rect.x + rect.width)) - x, height: Math.max(...rects.map(rect => rect.y + rect.height)) - y };
|
||||
}
|
||||
|
||||
/**
|
||||
* Where the visible keyboard is, from the nodes that span it (the `Keyboard` element, the keyboard window's input view and
|
||||
* prediction bar, the native views, an input method's window), or undefined when none shows. Containers inside the
|
||||
* keyboard can report a scroll extent past the screen, so not every node it owns counts.
|
||||
*/
|
||||
export function keyboardBounds(nodes: readonly SnapshotNode[]): Rect | undefined {
|
||||
return union(nodes.filter(node => node.visible !== false && keyboardRoot(node) && (node.systemKeyboard !== true
|
||||
|| text(node.type).toLowerCase() === "keyboard" || KEYBOARD_WINDOW_IDENTIFIERS.has(text(node.identifier)))).flatMap(node => rectOf(node) ?? []));
|
||||
}
|
||||
|
||||
/**
|
||||
* A text input that has the keyboard focus: agent-device reports `focused` from XCTest's keyboard focus and Android's
|
||||
* focused flag; the Argent bridge passes on Argent's own.
|
||||
*/
|
||||
export function focusedTextInput(nodes: readonly SnapshotNode[]): boolean {
|
||||
return nodes.some(node => node.focused === true && node.visible !== false
|
||||
&& (EDITABLE_TYPES.has(text(node.type).toLowerCase()) || /EditText$/.test(text(node.type)) || node.editable === true));
|
||||
}
|
||||
|
||||
/** A snapshot as the wait reads it: Argent also says whether a keyboard shows, which its Android tree cannot. */
|
||||
export type KeyboardRead = { nodes: readonly SnapshotNode[]; keyboardVisible?: boolean };
|
||||
|
||||
/** Where the keyboard is in one read: its bounds, or only that one shows when the controller cannot place it. */
|
||||
function keyboardPosition(read: KeyboardRead): string | undefined {
|
||||
const bounds = keyboardBounds(read.nodes);
|
||||
return bounds ? JSON.stringify(bounds) : read.keyboardVisible === true ? "visible" : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* How capture waits for a focused field's keyboard. Reads are 250 ms apart at most, and at least two follow the first,
|
||||
* so a controller whose snapshot takes a second or more still sees the keyboard rise. Waiting for a keyboard that has not
|
||||
* appeared ends after a second; one that has appeared but has not yet held still is read until it does, up to six reads
|
||||
* or four seconds, so a slow controller cannot keep the capture waiting.
|
||||
*/
|
||||
export const KEYBOARD_POLL_MS = 250;
|
||||
const KEYBOARD_WAIT_MS = 1_000;
|
||||
const KEYBOARD_CAP_MS = 4_000;
|
||||
const KEYBOARD_MIN_READS = 2;
|
||||
const KEYBOARD_MAX_READS = 6;
|
||||
|
||||
export type KeyboardSettle = {
|
||||
/** `shown`: in the same place in two reads running. `unfocused`: the field let go and no keyboard shows. */
|
||||
readonly outcome: "shown" | "moving" | "absent" | "unfocused";
|
||||
readonly reads: number;
|
||||
/** Whether to read the screen again, `elapsedMs` after the first read. */
|
||||
more(elapsedMs: number): boolean;
|
||||
read(next: KeyboardRead): void;
|
||||
};
|
||||
|
||||
/**
|
||||
* The wait for a screen whose text field has the focus, or undefined when none has it. A keyboard already up counts only
|
||||
* once a later read finds it in the same place: one caught rising or going down is still moving.
|
||||
*/
|
||||
export function keyboardSettle(first: KeyboardRead): KeyboardSettle | undefined {
|
||||
if (!focusedTextInput(first.nodes)) return undefined;
|
||||
let previous = keyboardPosition(first), reads = 0;
|
||||
let outcome: KeyboardSettle["outcome"] = previous ? "moving" : "absent";
|
||||
return {
|
||||
get outcome() { return outcome; },
|
||||
get reads() { return reads; },
|
||||
more: elapsedMs => (outcome === "moving" || outcome === "absent") && reads < KEYBOARD_MAX_READS
|
||||
&& (reads < KEYBOARD_MIN_READS || (elapsedMs < KEYBOARD_CAP_MS && (outcome === "moving" || elapsedMs < KEYBOARD_WAIT_MS))),
|
||||
read: next => {
|
||||
reads += 1;
|
||||
const position = keyboardPosition(next);
|
||||
outcome = position && position === previous ? "shown" : position ? "moving" : focusedTextInput(next.nodes) ? "absent" : "unfocused";
|
||||
previous = position;
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -17,6 +17,7 @@ import { type CaptureSetupSnapshot, credentialSavePromptDecline, describeSetupAc
|
||||
import { silentProgress } from "../shared/progress.js";
|
||||
import type { CaptureSetupReady } from "../config/explore-config.js";
|
||||
import { READINESS_POLL_MS, defaultReadinessSeconds } from "./readiness.js";
|
||||
import { KEYBOARD_POLL_MS, keyboardSettle, type KeyboardRead, type KeyboardSettle } from "./keyboard.js";
|
||||
import { CAPTURE_OBSERVER_IDENTIFIER, captureObserverMarkers, parseCaptureDestination, captureDestinationMatches } from "./observer.js";
|
||||
import { type CiAgentRuntimeOptions, runCiAgentNavigation, assertAgentCaptureContext } from "./agent/runtime.js";
|
||||
import { createExplorationInputs } from "../config/exploration-inputs.js";
|
||||
@@ -92,6 +93,11 @@ function snapshotNodes(raw: string): Record<string, unknown>[] {
|
||||
return data.nodes;
|
||||
}
|
||||
|
||||
/** Whether the controller says a keyboard shows: Argent does, and its Android tree has no input method window to show it. */
|
||||
function keyboardVisibility(data: Record<string, unknown>): { keyboardVisible?: boolean } {
|
||||
return typeof data.keyboardVisible === "boolean" ? { keyboardVisible: data.keyboardVisible } : {};
|
||||
}
|
||||
|
||||
/** The visible element each required label matched, so an image assessor can find icon-only controls. */
|
||||
export function verifiedCaptureLabels(nodes: readonly Record<string, unknown>[], requiredLabels: readonly string[],
|
||||
/** The screen's portrait height, when the screenshot is that screen turned a quarter clockwise (an opened iPhone Duo). */
|
||||
@@ -106,6 +112,24 @@ export function verifiedCaptureLabels(nodes: readonly Record<string, unknown>[],
|
||||
}));
|
||||
}
|
||||
|
||||
/**
|
||||
* The full-screen logical space a screenshot shows: the one Application node at the origin whose aspect is the image's,
|
||||
* at any pixel density. Failing that, the one whose aspect is the image's transpose (`transposed`): the image is then the
|
||||
* screen turned a quarter. A square screen matches both ways and is read upright. `slack` is how many image pixels the
|
||||
* root, scaled to the image, may miss it by; capture asks for an exact match.
|
||||
*/
|
||||
export function screenSpace(nodes: readonly Record<string, unknown>[], image: { width: number; height: number }, slack = 0): { width: number; height: number; transposed: boolean } | undefined {
|
||||
const roots = (transposed: boolean) => nodes.filter(node => node.type === "Application" && isRecord(node.rect)
|
||||
&& node.rect.x === 0 && node.rect.y === 0 && typeof node.rect.width === "number" && typeof node.rect.height === "number"
|
||||
&& Number.isFinite(node.rect.width) && Number.isFinite(node.rect.height) && node.rect.width > 0 && node.rect.height > 0
|
||||
&& Math.abs(transposed ? node.rect.width * image.width - node.rect.height * image.height : node.rect.width * image.height - node.rect.height * image.width) <= slack * node.rect.height);
|
||||
const upright = roots(false), turned = upright.length ? [] : roots(true);
|
||||
const matched = upright.length ? upright : turned;
|
||||
if (matched.length !== 1) return undefined;
|
||||
const rect = matched[0]!.rect as { width: number; height: number };
|
||||
return { width: rect.width, height: rect.height, transposed: turned.length === 1 };
|
||||
}
|
||||
|
||||
/**
|
||||
* A swipe that closes a presented sheet, or undefined when the snapshot does not prove a sheet.
|
||||
* The route observer is drawn at the focused scene's top-left corner. A sheet's scene starts below
|
||||
@@ -377,7 +401,7 @@ export async function capturePlannedRoutes(options: {
|
||||
lastSnapshot = raw;
|
||||
const generation = typeof data.refsGeneration === "number" ? data.refsGeneration : undefined;
|
||||
const decline = declined < 2 && generation ? credentialSavePromptDecline(nodes) : undefined;
|
||||
if (!decline) return { nodes, truncated: false, ...(generation ? { refsGeneration: generation } : {}) };
|
||||
if (!decline) return { nodes, truncated: false, ...(generation ? { refsGeneration: generation } : {}), ...keyboardVisibility(data) };
|
||||
controller(["press", `@${String(decline.ref).replace(/^@/, "")}~s${generation}`, "--level", "full", "--json"]);
|
||||
recordDeclinedPrompt("deterministic");
|
||||
controller(["wait", "500", "--level", "full", "--json"]);
|
||||
@@ -507,6 +531,35 @@ export async function capturePlannedRoutes(options: {
|
||||
.sort());
|
||||
/** The controller's own quiescence gate; a timeout is reported by the snapshot comparison below. */
|
||||
const settle = () => { controller(["wait", "stable", "500", "8000", "--level", "full", "--json"], true); };
|
||||
/**
|
||||
* A screen that focused a text field shows the keyboard that field raises, as its users see it. The keyboard rises
|
||||
* after the screen has settled, so the controller's quiescence gate can pass in between: in brentvatne/euxy#172
|
||||
* (review run 39362642343) the rename sheet's base was captured with its cursor showing and no keyboard, its head with
|
||||
* the keyboard up, and the 48% mismatch was the keyboard. The screen is read again until the keyboard is in the same
|
||||
* place twice running (see keyboardSettle); a keyboard that never comes is not waited for long, and none is dismissed.
|
||||
*/
|
||||
const awaitKeyboard = (route: SourceRoute, first: KeyboardRead): readonly Record<string, unknown>[] => {
|
||||
const settle = keyboardSettle(first);
|
||||
if (!settle) return first.nodes;
|
||||
const startedAt = clock();
|
||||
let current = first, pollStartedAt = startedAt;
|
||||
// A read counts for at least one poll interval, so a clock that stands still (a fake controller) still expires.
|
||||
const elapsed = () => Math.max(clock() - startedAt, settle.reads * KEYBOARD_POLL_MS);
|
||||
while (settle.more(elapsed())) {
|
||||
(capture.sleep ?? pause)(KEYBOARD_POLL_MS - (clock() - pollStartedAt));
|
||||
pollStartedAt = clock();
|
||||
current = snapshot();
|
||||
settle.read(current);
|
||||
}
|
||||
recordKeyboardWait(route.id, settle, elapsed());
|
||||
return current.nodes;
|
||||
};
|
||||
const recordKeyboardWait = (route: string | undefined, settle: KeyboardSettle, elapsedMs: number) => {
|
||||
const diagnostics = join(store.root, "capture-diagnostics");
|
||||
mkdirSync(diagnostics, { recursive: true, mode: 0o700 });
|
||||
appendFileSync(join(diagnostics, "keyboard.jsonl"), `${JSON.stringify({ ...(route ? { route } : { phase: "agent-observe" }), outcome: settle.outcome,
|
||||
reads: settle.reads, elapsedMs, at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
|
||||
};
|
||||
const attempted = new Set<string>();
|
||||
const captureCurrent = async (route: SourceRoute, attempt: number, before?: readonly Record<string, unknown>[],
|
||||
unattributed?: NonNullable<CaptureBundle["outcomes"][string]["observed"]> & { message: string }) => {
|
||||
@@ -514,9 +567,11 @@ export async function capturePlannedRoutes(options: {
|
||||
attempted.add(route.id);
|
||||
const temporary = await mkdtemp(join(store.root, ".capture-"));
|
||||
try {
|
||||
const accepted = before ?? waitForDestination(route, () => resolveDeepLinkConfirmation());
|
||||
if (unattributed) assertNoAlert({ route, nodes: accepted });
|
||||
else landing(accepted, route, inventory);
|
||||
const arrived = before ?? waitForDestination(route, () => resolveDeepLinkConfirmation());
|
||||
if (unattributed) assertNoAlert({ route, nodes: arrived });
|
||||
else landing(arrived, route, inventory);
|
||||
const accepted = unattributed ? arrived : awaitKeyboard(route, { nodes: arrived });
|
||||
if (accepted !== arrived) landing(accepted, route, inventory);
|
||||
assertSafeScreenshot(accepted);
|
||||
const screenshot = join(temporary, "screen.png");
|
||||
await writeFile(screenshot, "", { flag: "wx", mode: 0o600 });
|
||||
@@ -663,7 +718,7 @@ export async function capturePlannedRoutes(options: {
|
||||
const generation = typeof data.refsGeneration === "number" ? data.refsGeneration : undefined;
|
||||
const decline = declined < 2 && generation ? credentialSavePromptDecline(nodes) : undefined;
|
||||
if (!decline) {
|
||||
const snapshot: CaptureSetupSnapshot = { nodes, truncated: false, ...(generation ? { refsGeneration: generation } : {}) };
|
||||
const snapshot: CaptureSetupSnapshot = { nodes, truncated: false, ...(generation ? { refsGeneration: generation } : {}), ...keyboardVisibility(data) };
|
||||
return { snapshot, raw };
|
||||
}
|
||||
await command(["press", `@${String(decline.ref).replace(/^@/, "")}~s${generation}`, "--level", "full", "--json"], signal);
|
||||
@@ -693,18 +748,11 @@ export async function capturePlannedRoutes(options: {
|
||||
* then the transpose of the frame, and a tap is turned back (see `toLogical`).
|
||||
*/
|
||||
const bounds = (frame: Candidate) => {
|
||||
const roots = (transposed: boolean) => frame.snapshot.nodes.filter(node => node.type === "Application" && isRecord(node.rect)
|
||||
&& node.rect.x === 0 && node.rect.y === 0 && typeof node.rect.width === "number" && typeof node.rect.height === "number"
|
||||
&& Number.isFinite(node.rect.width) && Number.isFinite(node.rect.height) && node.rect.width > 0 && node.rect.height > 0
|
||||
&& (transposed ? node.rect.width * frame.width === node.rect.height * frame.height : node.rect.width * frame.height === node.rect.height * frame.width));
|
||||
// A square screen matches both ways; it is read upright, as before rotated frames existed.
|
||||
const upright = roots(false), turned = upright.length ? [] : roots(true);
|
||||
const matched = upright.length ? upright : turned;
|
||||
if (matched.length !== 1) throw captureError("AGENT_COORDINATE_BOUNDS_UNVERIFIED", "The screenshot does not identify one matching full-screen logical coordinate space.");
|
||||
// The official iOS screenshot is full-screen. Its default is 1x, but a proven
|
||||
// uniform pixel density must still map to XCTest points rather than raw pixels.
|
||||
const rect = matched[0]!.rect as { width: number; height: number };
|
||||
return { width: rect.width, height: rect.height, transposed: turned.length === 1 };
|
||||
const space = screenSpace(frame.snapshot.nodes, frame);
|
||||
if (!space) throw captureError("AGENT_COORDINATE_BOUNDS_UNVERIFIED", "The screenshot does not identify one matching full-screen logical coordinate space.");
|
||||
return space;
|
||||
};
|
||||
/**
|
||||
* A normalized point (x, y) in the screenshot, in the tree's logical points. Upright, it scales by the root. Turned:
|
||||
@@ -769,16 +817,32 @@ export async function capturePlannedRoutes(options: {
|
||||
}
|
||||
}
|
||||
};
|
||||
/** The same wait for a focused field's keyboard as a route link's capture, before an observation's screenshot. */
|
||||
const awaitKeyboardAsync = async (first: CaptureSetupSnapshot, signal: AbortSignal): Promise<CaptureSetupSnapshot> => {
|
||||
const settle = keyboardSettle(first);
|
||||
if (!settle) return first;
|
||||
const startedAt = clock();
|
||||
let current = first;
|
||||
const elapsed = () => Math.max(clock() - startedAt, settle.reads * KEYBOARD_POLL_MS);
|
||||
while (settle.more(elapsed())) {
|
||||
await sleep(KEYBOARD_POLL_MS, undefined, { signal: liveSignal(signal) });
|
||||
current = (await readSnapshot(signal)).snapshot;
|
||||
settle.read(current);
|
||||
}
|
||||
recordKeyboardWait(undefined, settle, elapsed());
|
||||
return current;
|
||||
};
|
||||
const observe = async (signal: AbortSignal, options?: { includeImage: boolean }) => {
|
||||
await discard();
|
||||
await appIdentity(signal);
|
||||
const first = await readSnapshotThroughDeferral(signal);
|
||||
const before = first.snapshot;
|
||||
let before = first.snapshot;
|
||||
if (first.retries > 0) {
|
||||
await appendFile(join(dirname(tracePath), "accessibility-deferral.jsonl"), `${JSON.stringify({ retries: first.retries, waitedMs: first.deferredMs,
|
||||
at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
|
||||
}
|
||||
if (options?.includeImage === false) return { snapshot: before };
|
||||
before = await awaitKeyboardAsync(before, signal);
|
||||
try { assertSafeScreenshot(before.nodes); }
|
||||
catch (error) {
|
||||
if (error instanceof CiError && error.code === "CAPTURE_SENSITIVE_INPUT") return { snapshot: before, imageUnavailable: { code: error.code, message: error.message } };
|
||||
|
||||
+68
-14
@@ -21,7 +21,7 @@ import { lstatIfExists, isWithin, temporaryCaptureDirectory, absoluteContractFil
|
||||
import { loadAppIcon, loadCachedAppIcon, storeAppIcon } from "./app-icon.js";
|
||||
import { defaultRunner, runAgentControllerCommand } from "./controller.js";
|
||||
import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
import { assertCaptureEasProfile, assertSimulatorAvailable, fingerprintFrom, hasEasEnvironmentFetchFailure, nativeBuildFrom, existingBuild, repackProfileFrom, prepareExactSourceBuild, type RepackMode } from "./eas-build.js";
|
||||
import { assertCaptureEasProfile, assertSimulatorAvailable, fingerprintFrom, hasEasEnvironmentFetchFailure, nativeBuildFrom, existingBuild, repackProfileFrom, prepareExactSourceBuild, HOSTED_REPACK_BUDGET_MS, type RepackMode, type RepackShare } from "./eas-build.js";
|
||||
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, endedOwnSimulatorSession, liveSimulatorSessionsNamed, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, controllerVersion, simulatorOsVersion, type ActiveSimulatorRuntime, type SimulatorConnection } from "./simulator.js";
|
||||
import { argentControllerInvocation } from "./controller-invocation.js";
|
||||
import { startArgentBridgeRunner, type ArgentBridgeRunner } from "./argent-bridge-host.js";
|
||||
@@ -71,6 +71,8 @@ export type CiMapOptions = {
|
||||
repack?: RepackMode;
|
||||
/** A folder the review's captures share builds through: targets of one platform, profile and commit build and repack once. */
|
||||
buildShare?: string;
|
||||
/** The matrix jobs of this GitHub run that repack the same app: they make one hosted repack per commit between them. */
|
||||
repackShare?: RepackShare;
|
||||
/** Which appearances to capture; `auto` (default) follows the app's `userInterfaceStyle`. */
|
||||
appearance?: AppearanceSetting;
|
||||
/**
|
||||
@@ -360,9 +362,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
let captureFailure: unknown;
|
||||
const finish = async (): Promise<CiMapResult> => {
|
||||
if (!(await store.exists())) await store.initialize(map, false);
|
||||
// A session making only secondary passes owns the `<id>@<scheme>` frames of those passes, not the primary ones.
|
||||
// A session making only secondary passes owns the `<id>@<scheme>` frames of those passes, not the primary ones, even
|
||||
// when it could not switch to them and so captured none.
|
||||
const ownFrameIds = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
|
||||
? selectedIds.flatMap(id => colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)).map(scheme => schemeScreenId(id, scheme)))
|
||||
? selectedIds.flatMap(id => options.appearancePass!.capture.filter(scheme => scheme !== colorSchemes[0]).map(scheme => schemeScreenId(id, scheme)))
|
||||
: selectedIds;
|
||||
const incomplete = captureFailure !== undefined || ownFrameIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
|
||||
|| map.gaps.some(gap => gap.status === "open");
|
||||
@@ -454,6 +457,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
// `eas simulator:control` names the session by id, from the session's own project directory.
|
||||
const sessionEas: EasCommand = (args, commandOptions) => runner({ command: options.easCommand, args, cwd: simulatorProject, environment: easEnvironment,
|
||||
timeoutMs: commandOptions?.timeoutMs ?? 5 * 60_000, ...(commandOptions?.allowFailure ? { allowFailure: true } : {}) });
|
||||
// A failed simulator:control action is sent again after a pause, which a test's clock replaces.
|
||||
const controlOptions = { sleep: options.sleep };
|
||||
// What the EAS session's host can do through simulator:control (iOS sessions on serve-sim 0.10.0 or later).
|
||||
let controlActions = new Set<string>();
|
||||
const configResult = eas(["config", "--platform", options.platform, "--profile", options.easProfile, "--json", "--non-interactive"]);
|
||||
@@ -501,6 +506,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const localName = `Explore ${options.device} (${side} ${options.gitCommit.slice(0, 8)})`;
|
||||
// An EAS session's start, once begun (startSession): it resolves with the start command's failure, if any.
|
||||
let sessionStart: Promise<unknown> | undefined;
|
||||
// When the current session was asked for, so a session whose app took longer than its allowance can be replaced.
|
||||
let sessionStartedAt: number | undefined;
|
||||
const stopEarlyDevice = async () => {
|
||||
// An EAS session started beside a repack that then failed: stop the exact session its handoff names.
|
||||
if (sessionStart) {
|
||||
@@ -554,6 +561,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const startSession = (retry?: { timeoutMs: number }) => {
|
||||
if (local || sessionStart) return;
|
||||
if (!retry) say(`starting an EAS Simulator session (${options.device}) while the app is repacked`);
|
||||
sessionStartedAt = (options.now ?? Date.now)();
|
||||
const request = (minutes: number) => ({ command: options.easCommand, args: ["simulator:start", "--name", sessionName, "--platform", options.platform, "--device", options.device,
|
||||
"--type", controller, "--package-version", controllerVersion(controller), "--public-link",
|
||||
"--max-duration-minutes", String(minutes), "--out-config-type", "dotenv", "--non-interactive"], cwd: simulatorProject, environment: easEnvironment,
|
||||
@@ -577,6 +585,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const appDirectory = !options.buildShare ? await realpath(await mkdtemp(join(tmpdir(), "expo-explore-app-"))) : undefined;
|
||||
let localApp: string | undefined;
|
||||
type BuiltApp = { fingerprint: string; nativeEasBuildId: string | null; easBuildId: string | null; app?: string; reused: boolean; version?: string; buildNumber?: string };
|
||||
// What a hosted repack waits with and reports through: one deadline from the moment the session starts beside it, for
|
||||
// the wait for another job's repack and every repack of its own. The repack is shared with this run's other matrix
|
||||
// jobs only when it repacks a build EAS already had: a native build this job made is its own, so nobody else's key matches it.
|
||||
const repackWaits = (shared: boolean) => ({ ...(shared ? { share: options.repackShare } : {}), progress: say, now: options.now, sleep: options.sleep,
|
||||
signal: options.signal, deadline: (options.now ?? Date.now)() + HOSTED_REPACK_BUDGET_MS });
|
||||
// `repacking` tells the captures sharing this build that their sessions can start too (sharedBuild).
|
||||
const buildApp = async (keepApp: string, repacking?: () => Promise<void>): Promise<BuiltApp> => {
|
||||
options.signal?.throwIfAborted();
|
||||
@@ -585,12 +598,12 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const sourceFingerprint = fingerprintFrom(fingerprintResult.stdout);
|
||||
const reusable = options.forceFreshBuild || hasEasEnvironmentFetchFailure(configResult.stderr) || hasEasEnvironmentFetchFailure(fingerprintResult.stderr)
|
||||
? undefined : existingBuild(eas(["build:list", "--platform", options.platform, "--status", "finished", "--build-profile", options.easProfile,
|
||||
"--fingerprint-hash", sourceFingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
|
||||
"--fingerprint-hash", sourceFingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "20", "--json", "--non-interactive"]).stdout);
|
||||
if (reusable) {
|
||||
say(`reusing EAS build ${reusable.id} (fingerprint ${sourceFingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
|
||||
startSession(); await repacking?.();
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: reusable.id, fingerprint: sourceFingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
|
||||
project, nativeBuildId: reusable.id, fingerprint: sourceFingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp, ...repackWaits(true) });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
message: "The build environment cannot be reproduced for automatic capture instrumentation.",
|
||||
nextAction: "Use a simulator build profile whose required bundle environment can be pulled for local repacking; an uninstrumented build cannot verify captures." });
|
||||
@@ -604,7 +617,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
say(`EAS build ${built.id} finished; repacking it with the route observer`);
|
||||
startSession(); await repacking?.();
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: built.id, fingerprint: built.fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
|
||||
project, nativeBuildId: built.id, fingerprint: built.fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp, ...repackWaits(false) });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
message: "The fresh native build cannot be instrumented with the required route observer.",
|
||||
nextAction: "Use a simulator profile with a reproducible bundle environment so both revisions can be repacked with the same observer." });
|
||||
@@ -618,12 +631,28 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
? await sharedBuild({ directory: options.buildShare, appName, ...(options.signal ? { signal: options.signal } : {}), build: buildApp, owner: options.outputDirectory,
|
||||
key: { platform: options.platform, easProfile: options.easProfile, bundleId: options.bundleId, gitCommit: options.gitCommit, repack: options.repack ?? "eas", local,
|
||||
routes: inventory.map(route => route.id) },
|
||||
waiting: () => say("using the build another target of this review is preparing for this commit"),
|
||||
waiting: () => say("using the build another capture of this run is preparing for this commit"),
|
||||
// The session is named before its app exists, so a waiter's session boots while the other capture repacks.
|
||||
repacking: () => startSession() })
|
||||
: await buildApp(join(appDirectory!, appName));
|
||||
// A capture that used another capture's build has its session started above; this starts the rest.
|
||||
startSession();
|
||||
// A session started beside an app that took longer to prepare than its allowance has less than the capture's minutes
|
||||
// left, so it is replaced. One that named no session is left to the session block below, which finds out why.
|
||||
const clock = options.now ?? Date.now;
|
||||
if (!local && sessionStart && sessionStartedAt !== undefined && clock() - sessionStartedAt > SESSION_PREPARATION_MINUTES * 60_000) {
|
||||
await sessionStart;
|
||||
const handoff = await readSimulatorDotenvHandoff(dotenvPath).catch(() => undefined);
|
||||
if (handoff?.sessionId) {
|
||||
say(`the app took ${Math.round((clock() - sessionStartedAt) / 60_000)} minutes to prepare, more than the ${SESSION_PREPARATION_MINUTES} session ${handoff.sessionId} was started with for it; replacing it so the capture keeps its ${options.maxDurationMinutes} minutes`);
|
||||
assertSimulatorStopped(eas(["simulator:stop", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000, simulatorProject).stdout, handoff.sessionId);
|
||||
await rm(dotenvPath, { force: true });
|
||||
sessionRetries += 1;
|
||||
sessionName = sessionNameFor(sessionRetries);
|
||||
sessionStart = undefined;
|
||||
startSession({ timeoutMs: SESSION_START_TIMEOUT_MS });
|
||||
}
|
||||
}
|
||||
fingerprint = built.fingerprint; nativeEasBuildId = built.nativeEasBuildId; easBuildId = built.easBuildId; localApp = built.app; reusedEasBuild = built.reused;
|
||||
if (!app.version && built.version) app.version = built.version;
|
||||
if (!app.buildNumber && built.buildNumber) app.buildNumber = built.buildNumber;
|
||||
@@ -749,8 +778,28 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
|
||||
connection = handoff.connection;
|
||||
await rm(dotenvPath, { force: true });
|
||||
if (options.platform === "ios") controlActions = simulatorControlActions(sessionEas, sessionId);
|
||||
if (options.platform === "ios") controlActions = simulatorControlActions(sessionEas, sessionId, controlOptions);
|
||||
if (!controlActions.has("appearance.set")) narrowToArgentScheme();
|
||||
// A side split over sessions gives this one only some of its appearances (captureSideInSessions). One that cannot
|
||||
// switch to any of them has nothing to capture, so it stops here, before the app is installed or the device folded:
|
||||
// in brentvatne/euxy's main baseline run 39487618529, the dark session folded the device for frames it would never
|
||||
// take, and its failed fold failed the target that the light session had captured.
|
||||
const pass = options.appearancePass;
|
||||
if (pass && !colorSchemes.some(scheme => pass.capture.includes(scheme))) {
|
||||
const skipped = pass.capture.join(", ");
|
||||
// The export merge needs the primary appearance's frames; a session that cannot take them fails the side.
|
||||
if (pass.capture.includes(pass.all[0]!)) throw new CiError({ code: "SESSION_APPEARANCE_UNAVAILABLE", stage: "session", retryable: true,
|
||||
message: `Simulator session ${sessionId} cannot switch to ${skipped}, the primary appearance it was given to capture.`,
|
||||
nextAction: "Rerun the capture on a new session, or set capture.appearance to the appearance this controller renders." });
|
||||
say(`session ${sessionId} cannot switch to ${skipped}, the appearance it was given; it stops without capturing, and the report has no ${skipped} frames`);
|
||||
const error = { code: "SESSION_APPEARANCE_UNAVAILABLE", stage: "session", retryable: true,
|
||||
message: `Simulator session ${sessionId} could not switch to ${skipped}.`, nextAction: "Rerun the capture on a new session." };
|
||||
for (const id of selectedIds) for (const scheme of pass.capture) {
|
||||
outcomes[schemeScreenId(id, scheme)] = { status: "failed", attempts: 0, landing: "unverified", reason: error.message, error };
|
||||
}
|
||||
// The finally block below stops the session after the export.
|
||||
return await finish();
|
||||
}
|
||||
}
|
||||
const controllerConfig = join(simulatorProject, "agent-device.json");
|
||||
await writeFile(controllerConfig, "{}\n", { flag: "wx", mode: 0o400 });
|
||||
@@ -785,7 +834,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
"--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
|
||||
// Before any link opens, as a local capture does with simctl: the app's own links then open without the prompt.
|
||||
if (sessionId && scheme) {
|
||||
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme]);
|
||||
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme], controlOptions);
|
||||
if (approved.length) say(`approved ${approved.map(item => `${item}://`).join(", ")} links on session ${sessionId}`);
|
||||
}
|
||||
}
|
||||
@@ -796,8 +845,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const target = deviceArgs({ platform: options.platform, deviceModel: options.device, ...(localDevice() ? { provider: "local-simulator" as const, controllerDeviceId: localDevice()! } : {}) });
|
||||
// agent-device reads the hinge back after folding and fails to (locally and on EAS); its display is checked instead.
|
||||
const easAgentDevice = !!sessionId && controller === "agent-device";
|
||||
// Argent's bridge sends a fold again, twice, when the simulator-server it needs did not start within Argent's 30 s,
|
||||
// so a fold can take three of those waits and the panel checks after it: 4 minutes covers that.
|
||||
const fold = () => runner({ command: controllerCommand, args: ["fold", options.devicePose!, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
|
||||
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
|
||||
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 4 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
|
||||
const pause = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
|
||||
if (localSimulator && controller === "argent") {
|
||||
// Argent folds without a session and checks the fold against its own reader; this machine also checks the display.
|
||||
@@ -821,6 +872,9 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
// can leave the panel it lights black, as it does for Argent: the controller then reads the old panel and a
|
||||
// relaunch draws nothing. The display is the check, through the controller's own screenshot: in the pose's shape
|
||||
// and drawn. If it is not, SpringBoard is restarted, the app reopened and the device folded again, once.
|
||||
// The open pose's shape is taken to be landscape. That is unverified for agent-device on EAS: local agent-device
|
||||
// runs returned the opened inner panel on its portrait axes (2007×2853), as explore:binary turns it from; the
|
||||
// landscape shots seen on EAS (2853×2007) were Argent's, taken with its LandscapeRight rotation.
|
||||
const open = (relaunch: boolean) => runner({ command: controllerCommand, args: ["open", options.bundleId, ...(relaunch ? ["--relaunch"] : []), "--session", CONTROLLER_SESSION,
|
||||
...target, "--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
|
||||
const shown = async () => {
|
||||
@@ -844,7 +898,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
if (!controlActions.has("springboard.restart")) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
|
||||
message: `${options.device} did not show the ${options.devicePose} display after folding.`, nextAction: "Rerun the capture on a new session." });
|
||||
say(`${options.device} did not draw the ${options.devicePose} display after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
|
||||
simulatorControl(sessionEas, sessionId, "springboard.restart");
|
||||
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
|
||||
pause(8_000);
|
||||
open(true);
|
||||
fold();
|
||||
@@ -859,7 +913,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
catch (error) {
|
||||
if (toCiError(error).code !== "CONTROLLER_FOLD_UNVERIFIED") throw error;
|
||||
say(`Argent kept reading the other panel after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
|
||||
simulatorControl(sessionEas, sessionId, "springboard.restart");
|
||||
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
|
||||
pause(8_000);
|
||||
try { fold(); }
|
||||
catch (retry) {
|
||||
@@ -892,7 +946,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
nextAction: "Rerun the capture; if it keeps happening, report it to Explore: this session's Argent tool-server needs a restart that EAS cannot do yet.", cause: error });
|
||||
if (recovery === 1) {
|
||||
say("Argent still did not read the app; restarting SpringBoard, then resetting Argent's device helpers and opening the app again");
|
||||
simulatorControl(sessionEas, sessionId, "springboard.restart");
|
||||
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
|
||||
// SpringBoard takes a moment to come back, and sends the app to the background; the next open brings it back.
|
||||
(options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); }))(8_000);
|
||||
} else say("Argent did not read the app after starting it; resetting Argent's device helpers and opening the app again");
|
||||
@@ -944,7 +998,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
// machine and serve-sim on an EAS iOS session; elsewhere its single pass runs as the device starts.
|
||||
if (controller !== "argent") runner({ command: controllerCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(runtime), "--platform", options.platform],
|
||||
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
|
||||
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme]);
|
||||
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme], controlOptions);
|
||||
else if (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
|
||||
|
||||
@@ -6,6 +6,8 @@ export type CaptureSetupSnapshot = {
|
||||
nodes: readonly Record<string, unknown>[];
|
||||
refsGeneration?: number;
|
||||
truncated?: boolean;
|
||||
/** Whether the controller says a software keyboard shows, when it says (Argent does). */
|
||||
keyboardVisible?: boolean;
|
||||
};
|
||||
|
||||
type Awaitable<T> = T | Promise<T>;
|
||||
@@ -98,13 +100,24 @@ function failure(code: string, message: string, details?: Record<string, unknown
|
||||
...(details ? { details } : {}) });
|
||||
}
|
||||
|
||||
export const SETUP_SELECTOR_MAX = 256;
|
||||
|
||||
/** A label or identifier the executor can select by; a replay plan's selectors are checked against it before any device starts. */
|
||||
export function isSetupSelector(value: unknown): value is string {
|
||||
return typeof value === "string" && value.trim().length > 0 && value.length <= SETUP_SELECTOR_MAX && !/[\u0000-\u001f\u007f]/.test(value);
|
||||
}
|
||||
|
||||
/** Text the executor can fill or type: one line of at most 4,096 characters. */
|
||||
export function isSetupInput(value: unknown): value is string {
|
||||
return typeof value === "string" && value.length <= 4_096 && !/[\u0000\r\n]/.test(value);
|
||||
}
|
||||
|
||||
function selectorValue(selector: CaptureSetupSelector): { key: "label" | "identifier"; value: string } {
|
||||
const hasLabel = typeof selector.label === "string";
|
||||
const hasIdentifier = typeof selector.identifier === "string";
|
||||
const key = hasLabel ? "label" : "identifier";
|
||||
const value = selector[key];
|
||||
if (hasLabel === hasIdentifier || typeof value !== "string" || !value.trim()
|
||||
|| value.length > 256 || /[\u0000-\u001f\u007f]/.test(value)) {
|
||||
if (hasLabel === hasIdentifier || !isSetupSelector(value)) {
|
||||
throw failure("SETUP_SELECTOR_INVALID", "A UI selector must contain exactly one nonempty label or identifier.");
|
||||
}
|
||||
return { key, value };
|
||||
@@ -274,8 +287,7 @@ export async function executeCaptureSetup(actions: readonly CaptureSetupAction[]
|
||||
case "tap":
|
||||
case "fill": {
|
||||
selectorValue(action);
|
||||
if (action.action === "fill" && (typeof action.text !== "string" || action.text.length > 4_096
|
||||
|| /[\u0000\r\n]/.test(action.text))) {
|
||||
if (action.action === "fill" && !isSetupInput(action.text)) {
|
||||
throw failure("SETUP_INPUT_INVALID", "A UI fill input must be a single line of at most 4,096 characters.");
|
||||
}
|
||||
let resolved = false;
|
||||
@@ -330,7 +342,7 @@ export async function executeCaptureSetup(actions: readonly CaptureSetupAction[]
|
||||
break;
|
||||
}
|
||||
case "type": {
|
||||
if (typeof action.text !== "string" || !action.text || action.text.length > 4_096 || /[\u0000\r\n]/.test(action.text)) {
|
||||
if (!isSetupInput(action.text) || !action.text) {
|
||||
throw failure("SETUP_INPUT_INVALID", "A UI type input must be a nonempty single line of at most 4,096 characters.");
|
||||
}
|
||||
let ready = false;
|
||||
|
||||
@@ -1,42 +1,111 @@
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { isRecord } from "./common.js";
|
||||
|
||||
/** Runs the pinned EAS CLI with these arguments; throws when it exits non-zero unless `allowFailure` is set. */
|
||||
export type EasCommand = (args: string[], options?: { timeoutMs?: number; allowFailure?: boolean }) => { stdout: string; stderr?: string };
|
||||
/**
|
||||
* Runs the pinned EAS CLI with these arguments; throws when it exits non-zero unless `allowFailure` is set. A runner that
|
||||
* knows the exit status reports it as `status`.
|
||||
*/
|
||||
export type EasCommand = (args: string[], options?: { timeoutMs?: number; allowFailure?: boolean }) => { stdout: string; stderr?: string; status?: number | null };
|
||||
|
||||
/**
|
||||
* Pauses before each resend of a failed action. Every action Explore runs is idempotent, and the session's host can fail
|
||||
* one once: in brentvatne/euxy's baseline run 39348933440, `app.approveUrlScheme` failed in its `simctl spawn … defaults
|
||||
* write`, which failed the dark-appearance session and with it the target's whole baseline.
|
||||
*/
|
||||
const SIMULATOR_CONTROL_RETRY_DELAYS_MS = [3_000, 6_000] as const;
|
||||
|
||||
/**
|
||||
* What eas-cli 25.2.0 says when the session's serve-sim predates the action list (it refuses `actions.describe`, or
|
||||
* answers it without a catalog), and what an EAS CLI without `simulator:control` says. Those sessions offer no actions,
|
||||
* and asking again would not change that.
|
||||
*/
|
||||
const NO_ACTION_LIST = /serve-sim version that does not support this action|did not return its list of actions|command simulator:control not found/;
|
||||
|
||||
/**
|
||||
* The host actions an EAS Simulator iOS session offers through `eas simulator:control` (serve-sim's actions, 0.10.0 and
|
||||
* later for the ones Explore uses): an empty set when the session or the EAS CLI offers none, so a caller falls back to
|
||||
* what it did before them. The session is always named by id, never taken from a `.env.eas-simulator` beside it.
|
||||
* later for the ones Explore uses): an empty set when the session's serve-sim or the EAS CLI predates the list, so a
|
||||
* caller falls back to what it did before them. The session is always named by id, never taken from a
|
||||
* `.env.eas-simulator` beside it.
|
||||
*
|
||||
* These are a fallback: what the session's controller can do itself (agent-device or Argent: fold, appearance, a
|
||||
* reader reset) goes through the controller. Explore uses an action here only for what neither controller offers —
|
||||
* approving a link scheme, restarting SpringBoard, and Argent's appearance (software-mansion/argent#1509).
|
||||
*
|
||||
* eas-cli prints the list as JSON on stdout only when it succeeds; a failure prints its reason on stderr. A list that
|
||||
* fails is asked for again after a pause, and one that still fails throws a retryable error rather than reading as "no
|
||||
* actions": in brentvatne/euxy's main baseline run 39487618529, one failed list made the dark-appearance session look as
|
||||
* if it offered none, so it dropped dark, approved no link scheme, and skipped the SpringBoard restart its fold needed,
|
||||
* which failed the target. A session whose host cannot answer three times in a row would fail those actions too, and
|
||||
* capturing on without them publishes a report that silently lacks an appearance; a new session is the way out.
|
||||
*/
|
||||
export function simulatorControlActions(eas: EasCommand, sessionId: string): Set<string> {
|
||||
try {
|
||||
const listed = eas(["simulator:control", "--list", "--id", sessionId, "--json", "--non-interactive"], { timeoutMs: 2 * 60_000, allowFailure: true });
|
||||
const actions = JSON.parse(listed.stdout) as unknown;
|
||||
return new Set(isRecord(actions) ? Object.keys(actions) : []);
|
||||
} catch { return new Set(); }
|
||||
export function simulatorControlActions(eas: EasCommand, sessionId: string, options: SimulatorControlOptions = {}): Set<string> {
|
||||
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
|
||||
const args = ["simulator:control", "--list", "--id", sessionId, "--json", "--non-interactive"];
|
||||
for (let retry = 0; ; retry += 1) {
|
||||
let failure: string;
|
||||
try {
|
||||
const listed = eas(args, { timeoutMs: 2 * 60_000, allowFailure: true });
|
||||
const actions = (() => { try { return JSON.parse(listed.stdout) as unknown; } catch { return undefined; } })();
|
||||
if ((listed.status ?? 0) === 0 && isRecord(actions)) return new Set(Object.keys(actions));
|
||||
const output = `${listed.stderr ?? ""}\n${listed.stdout}`;
|
||||
if (NO_ACTION_LIST.test(output)) return new Set();
|
||||
// eas-cli ends a failure with "simulator:control command failed."; the line before it says why.
|
||||
failure = output.split("\n").map(line => line.trim()).filter(line => line && !/command failed\.?$/.test(line)).at(-1)?.slice(0, 300) || "it printed no list";
|
||||
} catch (error) {
|
||||
if (NO_ACTION_LIST.test(error instanceof Error ? error.message : String(error))) return new Set();
|
||||
failure = firstLine(error);
|
||||
}
|
||||
const delayMs = SIMULATOR_CONTROL_RETRY_DELAYS_MS[retry];
|
||||
if (delayMs === undefined) throw new CiError({ code: "SIMULATOR_CONTROL_UNAVAILABLE", stage: "session", retryable: true,
|
||||
message: `EAS could not list the simulator:control actions of session ${sessionId} after ${retry + 1} attempts: ${failure}`,
|
||||
nextAction: "Rerun the capture on a new session. Without the list, Explore cannot tell whether the session can switch appearance, approve the app's links, or restart SpringBoard.",
|
||||
details: { sessionId, attempts: retry + 1 } });
|
||||
// A list that succeeds on a later attempt would otherwise leave no trace of the failure in the job log.
|
||||
process.stderr.write(`simulator:control --list failed for session ${sessionId} (${failure}); asking again in ${delayMs / 1000} s\n`);
|
||||
sleep(delayMs);
|
||||
}
|
||||
}
|
||||
|
||||
/** Runs one `eas simulator:control` action on the session; eas-cli fills in the device. Throws with EAS's reason. */
|
||||
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = []): void {
|
||||
/** Lets a test replace the pause between resends of a failed action. */
|
||||
export type SimulatorControlOptions = { sleep?: ((milliseconds: number) => void) | undefined };
|
||||
|
||||
/**
|
||||
* Runs one `eas simulator:control` action on the session; eas-cli fills in the device. A failed action is sent again
|
||||
* after a pause; one that still fails throws with EAS's reason.
|
||||
*/
|
||||
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = [], options: SimulatorControlOptions = {}): void {
|
||||
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
|
||||
// Values follow `--` so one that starts with a dash is never read as a flag.
|
||||
eas(["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values], { timeoutMs: 2 * 60_000 });
|
||||
const args = ["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values];
|
||||
for (let retry = 0; ; retry += 1) {
|
||||
try { eas(args, { timeoutMs: 2 * 60_000 }); return; }
|
||||
catch (error) {
|
||||
const delayMs = SIMULATOR_CONTROL_RETRY_DELAYS_MS[retry];
|
||||
if (delayMs === undefined) throw error;
|
||||
// A resend that succeeds would otherwise leave no trace of the failure in the job log.
|
||||
process.stderr.write(`simulator:control ${action} failed (${firstLine(error)}); sending it again in ${delayMs / 1000} s\n`);
|
||||
sleep(delayMs);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Lets the app open its own links without iOS asking "Open in “App”?" first, like local captures do with simctl. A
|
||||
* session without the action keeps the controllers' prompt handling; http and https never prompt and are skipped.
|
||||
*/
|
||||
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[]): string[] {
|
||||
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[],
|
||||
options: SimulatorControlOptions = {}): string[] {
|
||||
if (!actions.has("app.approveUrlScheme")) return [];
|
||||
const approved: string[] = [];
|
||||
for (const scheme of new Set(schemes.map(value => value.toLowerCase()))) {
|
||||
if (scheme === "http" || scheme === "https" || !/^[a-z][a-z0-9+.-]*$/.test(scheme)) continue;
|
||||
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme]);
|
||||
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme], options);
|
||||
approved.push(scheme);
|
||||
}
|
||||
return approved;
|
||||
}
|
||||
|
||||
/** The first line of a failure, for a log line. */
|
||||
function firstLine(error: unknown): string {
|
||||
return (error instanceof Error ? error.message : String(error)).split("\n", 1)[0]!.slice(0, 300);
|
||||
}
|
||||
@@ -15,7 +15,10 @@ import { ARGENT_VERSION } from "../shared/argent-version.js";
|
||||
|
||||
const METADATA = "cache-metadata.json";
|
||||
const CONTRACT = "explore.capture-cache";
|
||||
const MAX_BYTES = 250 * 1024 * 1024;
|
||||
/** The most evidence a capture cache holds; a downloaded baseline is refused past it before it is unpacked. */
|
||||
export const CAPTURE_CACHE_MAX_BYTES = 250 * 1024 * 1024;
|
||||
/** The most files a capture cache holds, besides its metadata. */
|
||||
export const CAPTURE_CACHE_MAX_FILES = 10_000;
|
||||
type Recipe = { inventory: unknown; profile: string; config: string; toolsCommit: string };
|
||||
type FileRecord = { path: string; bytes: number; sha256: string };
|
||||
type CacheMetadata = { contract: typeof CONTRACT; recipe: string; commit: string; files: FileRecord[] };
|
||||
@@ -28,9 +31,9 @@ const recipeKey = ({ inventory, profile, config, toolsCommit }: Recipe) => {
|
||||
|
||||
/** Only settings that can change captured runtime evidence belong in the recipe. */
|
||||
export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?: string): string {
|
||||
// How many sessions capture the evidence (capture.maxSessions) does not change it.
|
||||
const { maxSessions: _maxSessions, ...capture } = config.capture;
|
||||
void _maxSessions;
|
||||
// How many sessions capture the evidence (capture.maxSessions), and how long a review waits for a baseline, do not change it.
|
||||
const { maxSessions: _maxSessions, baselineWaitMinutes: _baselineWaitMinutes, ...capture } = config.capture;
|
||||
void _maxSessions; void _baselineWaitMinutes;
|
||||
return canonicalJson({
|
||||
observer: CAPTURE_OBSERVER_HASH,
|
||||
mode: config.mode,
|
||||
@@ -104,7 +107,7 @@ async function fileInventory(directory: string, path = ""): Promise<FileRecord[]
|
||||
else if (info.isFile()) files.push({ path: child, bytes: info.size, sha256: hash(await readFile(join(directory, child))) });
|
||||
else throw new Error("Capture cache contains an unsupported file");
|
||||
}
|
||||
if (files.length > 10_000 || files.reduce((sum, file) => sum + file.bytes, 0) > MAX_BYTES) {
|
||||
if (files.length > CAPTURE_CACHE_MAX_FILES || files.reduce((sum, file) => sum + file.bytes, 0) > CAPTURE_CACHE_MAX_BYTES) {
|
||||
throw new Error("Capture cache exceeds the evidence size limit");
|
||||
}
|
||||
return files;
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
import { openAsBlob } from "node:fs";
|
||||
import { mkdir, mkdtemp, open, rm, writeFile } from "node:fs/promises";
|
||||
import { dirname, join, relative, resolve } from "node:path";
|
||||
import { setTimeout as delay } from "node:timers/promises";
|
||||
import { BlobReader, Uint8ArrayWriter, ZipReader, configure } from "@zip.js/zip.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
import { retryGitHubLookup } from "../report/github-lookup.js";
|
||||
import { safeRelativePath } from "../binary/archive.js";
|
||||
import { CAPTURE_CACHE_MAX_BYTES, CAPTURE_CACHE_MAX_FILES } from "./artifact-cache.js";
|
||||
import { baselineLookup, githubContext, trustedBaselineRun, type GithubArtifact, type GithubRun } from "./workflow-steps.js";
|
||||
|
||||
/**
|
||||
* A review that waits for main's baseline of its base commit instead of capturing the base itself. Right after a
|
||||
* merge, the next pull request's review starts while the baseline workflow is still capturing the new base: in
|
||||
* brentvatne/euxy's review run 39348956443 it had started 15 s before, so every target captured its base too, about
|
||||
* 10–14 minutes per target instead of 6, on twice the EAS Simulator sessions. A baseline job takes 6–8 minutes and
|
||||
* head capture 5–8, so `runCiReview` starts head at once and waits here only where base would start.
|
||||
*/
|
||||
|
||||
/** `capture.baselineWaitMinutes` when the config sets none: two baseline jobs' worth, so one queued behind another still counts. */
|
||||
export const DEFAULT_BASELINE_WAIT_MINUTES = 15;
|
||||
const POLL_MS = 20_000;
|
||||
/** GitHub's Actions API lists an artifact a little after its upload (#47); a finished job gets this long for its artifact to appear. */
|
||||
const ARTIFACT_LISTING_GRACE_MS = 60_000;
|
||||
/** A zip of the largest capture cache, stored rather than deflated, plus its headers. */
|
||||
const MAX_ARTIFACT_ZIP_BYTES = CAPTURE_CACHE_MAX_BYTES + 16 * 1024 * 1024;
|
||||
|
||||
type GithubJob = { name: string; status?: string; conclusion?: string | null };
|
||||
|
||||
export type BaselineWaitOptions = {
|
||||
/** The baseline run `ci:find-baseline` named; it is checked again here, by the same trust rules. */
|
||||
run: number; sha: string; target: string;
|
||||
/** The longest the review waits, from its first poll (`capture.baselineWaitMinutes`). */
|
||||
timeoutMs: number; pollMs?: number;
|
||||
environment?: NodeJS.ProcessEnv; transport?: typeof fetch; progress?: Progress; signal?: AbortSignal;
|
||||
now?: () => number; sleep?: (milliseconds: number, signal?: AbortSignal) => Promise<void>;
|
||||
};
|
||||
|
||||
/** A failed GitHub read that may succeed later: no answer or a 5xx. A bad token or a missing permission is not. */
|
||||
const transientGitHubFailure = (error: unknown) => error instanceof CiError && error.retryable;
|
||||
const describe = (error: unknown) => error instanceof CiError ? `${error.code}: ${error.message}` : error instanceof Error ? error.message : String(error);
|
||||
const statusText = (status: string | undefined) => (status ?? "queued").replaceAll("_", " ");
|
||||
|
||||
/**
|
||||
* Polls one baseline run until this target's baseline artifact is listed, and answers with it. The run must pass the
|
||||
* trust check a finished baseline passes. Each target's job uploads its own artifact when it finishes, so a target is
|
||||
* reused even when another target's job fails (#48); this target's job failing or being cancelled ends the wait, as do
|
||||
* the time limit, a missing permission and GitHub failures that outlast their retries. The reason says which.
|
||||
*/
|
||||
export async function waitForBaselineArtifact(options: BaselineWaitOptions): Promise<{ artifact: { id: number; run: number } } | { reason: string }> {
|
||||
const now = options.now ?? Date.now;
|
||||
const sleep = options.sleep ?? ((milliseconds: number, signal?: AbortSignal) => delay(milliseconds, undefined, signal ? { signal } : {}));
|
||||
const progress = options.progress ?? silentProgress;
|
||||
const started = now();
|
||||
const short = options.sha.slice(0, 8);
|
||||
try {
|
||||
const lookup = await baselineLookup({ sha: options.sha, target: options.target, ...(options.environment ? { environment: options.environment } : {}),
|
||||
...(options.transport ? { transport: options.transport } : {}),
|
||||
retry: read => retryGitHubLookup(read, transientGitHubFailure, milliseconds => sleep(milliseconds, options.signal)) });
|
||||
if (!lookup) return { reason: "the repository has no baseline workflow" };
|
||||
const { context, get, target } = lookup;
|
||||
// The matrix names each baseline job after its target; an older single-platform workflow's one job is `baseline`.
|
||||
const jobNames = [`baseline (${target})`, ...(target === "ios" ? ["baseline"] : [])];
|
||||
let finishedAt: number | undefined;
|
||||
let logged = "";
|
||||
for (;;) {
|
||||
const run = await get<GithubRun>(`repos/${context.repository}/actions/runs/${options.run}`);
|
||||
if (!trustedBaselineRun(run, lookup)) return { reason: `run ${options.run} is not a baseline run of ${short} on ${lookup.defaultBranch}` };
|
||||
for (const name of lookup.names) {
|
||||
const listed = await get<{ artifacts?: GithubArtifact[] }>(`repos/${context.repository}/actions/runs/${run.id}/artifacts?name=${encodeURIComponent(name)}&per_page=100`);
|
||||
const artifact = (listed?.artifacts ?? []).filter(candidate => !candidate.expired && (candidate.name ?? name) === name
|
||||
&& Number.isSafeInteger(candidate.id) && candidate.id > 0).sort((a, b) => b.id - a.id)[0];
|
||||
if (artifact) return { artifact: { id: artifact.id, run: run.id } };
|
||||
}
|
||||
const jobs = await get<{ jobs?: GithubJob[] }>(`repos/${context.repository}/actions/runs/${run.id}/jobs?per_page=100`);
|
||||
const job = jobs?.jobs?.find(candidate => jobNames.includes(candidate.name));
|
||||
if (job?.status === "completed" && job.conclusion !== "success") {
|
||||
return { reason: `its ${target} job ${job.conclusion === "cancelled" ? "was cancelled" : job.conclusion === "failure" ? "failed" : `ended (${job.conclusion ?? "no conclusion"})`}` };
|
||||
}
|
||||
if (job?.status === "completed" || run.status === "completed") {
|
||||
finishedAt ??= now();
|
||||
if (now() - finishedAt >= ARTIFACT_LISTING_GRACE_MS) return { reason: job ? `its ${target} job finished, but GitHub lists no ${lookup.names[0]} artifact`
|
||||
: `the run ended (${run.conclusion ?? "no conclusion"}) without a ${target} baseline job` };
|
||||
}
|
||||
const waited = now() - started;
|
||||
const state = job ? statusText(job.status) : run.status === "completed" ? "finished" : "not started";
|
||||
if (waited >= options.timeoutMs) return { reason: `its ${target} job is still ${state} after ${Math.round(waited / 60_000)} min` };
|
||||
// A line when the state changes and once a minute, not on every poll.
|
||||
const line = `waiting for ${lookup.defaultBranch}'s baseline run ${run.id} of ${short} (${target}: ${state}, ${Math.floor(waited / 60_000)} min)`;
|
||||
if (line !== logged) { progress(line); logged = line; }
|
||||
await sleep(Math.min(options.pollMs ?? POLL_MS, options.timeoutMs - waited), options.signal);
|
||||
}
|
||||
} catch (error) {
|
||||
return { reason: options.signal?.aborted ? "the review stopped waiting" : describe(error) };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads a baseline artifact and unpacks it into `directory`, which must not exist yet: what
|
||||
* actions/download-artifact would have put in EXPLORE_CAPTURE_CACHE. The token goes to GitHub only, never to the
|
||||
* storage URL GitHub redirects to. Paths are confined to the directory and the cache's size limits apply before
|
||||
* anything is written; restoreCaptureArtifactCache then checks the evidence as it checks a downloaded one.
|
||||
*/
|
||||
export async function downloadBaselineArtifact(options: { artifact: number; directory: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
|
||||
signal?: AbortSignal; sleep?: (milliseconds: number, signal?: AbortSignal) => Promise<void> }): Promise<void> {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const context = githubContext(environment);
|
||||
const sleep = options.sleep ?? ((milliseconds: number, signal?: AbortSignal) => delay(milliseconds, undefined, signal ? { signal } : {}));
|
||||
const signal = (milliseconds: number) => options.signal ? AbortSignal.any([options.signal, AbortSignal.timeout(milliseconds)]) : AbortSignal.timeout(milliseconds);
|
||||
const path = `repos/${context.repository}/actions/artifacts/${options.artifact}/zip`;
|
||||
// A 404 just after the artifact was listed is the Actions API catching up (#47), as a 5xx or no answer may be.
|
||||
const located = await retryGitHubLookup(async () => {
|
||||
let response: Response;
|
||||
try {
|
||||
response = await transport(`https://api.github.com/${path}`, { redirect: "manual", signal: signal(60_000),
|
||||
headers: { authorization: `Bearer ${context.token}`, accept: "application/vnd.github+json", "x-github-api-version": "2022-11-28" } });
|
||||
} catch (error) {
|
||||
throw new CiError({ code: "GITHUB_REQUEST_FAILED", stage: "capture-base", message: `GitHub could not be reached (${path}).`,
|
||||
nextAction: "Check GitHub availability.", retryable: true, cause: error });
|
||||
}
|
||||
if (response.status >= 300 && response.status < 400) {
|
||||
await response.body?.cancel().catch(() => {});
|
||||
return { location: response.headers.get("location") ?? "" };
|
||||
}
|
||||
if (response.ok) return { response };
|
||||
await response.body?.cancel().catch(() => {});
|
||||
throw new CiError({ code: response.status === 403 ? "GITHUB_PERMISSION_DENIED" : "GITHUB_REQUEST_FAILED", stage: "capture-base",
|
||||
message: `GitHub answered HTTP ${response.status} for ${path}.`, retryable: response.status === 404 || response.status >= 500,
|
||||
nextAction: response.status === 403 ? "Grant the capture job actions: read." : "Rerun the workflow; check GitHub's status if it keeps failing." });
|
||||
}, transientGitHubFailure, milliseconds => sleep(milliseconds, options.signal));
|
||||
let response = located.response;
|
||||
if (!response) {
|
||||
const location = URL.canParse(located.location ?? "") ? new URL(located.location!) : undefined;
|
||||
if (location?.protocol !== "https:") throw new Error("GitHub redirected the artifact download to no HTTPS address");
|
||||
response = await transport(location.href, { signal: signal(10 * 60_000) });
|
||||
if (!response.ok || !response.body) throw new Error(`The artifact download answered HTTP ${response.status}`);
|
||||
}
|
||||
await mkdir(dirname(resolve(options.directory)), { recursive: true });
|
||||
const stage = await mkdtemp(`${resolve(options.directory)}.download-`);
|
||||
try {
|
||||
const archive = join(stage, "artifact.zip");
|
||||
const file = await open(archive, "wx", 0o600);
|
||||
try {
|
||||
let bytes = 0;
|
||||
for await (const chunk of response.body as unknown as AsyncIterable<Uint8Array>) {
|
||||
bytes += chunk.byteLength;
|
||||
if (bytes > MAX_ARTIFACT_ZIP_BYTES) throw new Error("The baseline artifact is larger than a capture cache can be");
|
||||
await file.write(chunk);
|
||||
}
|
||||
} finally { await file.close(); }
|
||||
await unpackArtifact(archive, options.directory);
|
||||
} finally {
|
||||
await rm(stage, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
async function unpackArtifact(archive: string, directory: string): Promise<void> {
|
||||
configure({ useWebWorkers: false });
|
||||
const zip = new ZipReader(new BlobReader(await openAsBlob(archive)), { useWebWorkers: false });
|
||||
try {
|
||||
const entries = await zip.getEntries();
|
||||
const files = entries.filter(entry => !entry.directory);
|
||||
// The cache's own metadata file is the one file beyond its evidence.
|
||||
if (files.length > CAPTURE_CACHE_MAX_FILES + 1 || files.reduce((sum, entry) => sum + entry.uncompressedSize, 0) > CAPTURE_CACHE_MAX_BYTES + 2 * 1024 * 1024) {
|
||||
throw new Error("The baseline artifact exceeds the capture cache's limits");
|
||||
}
|
||||
const root = resolve(directory);
|
||||
await mkdir(root);
|
||||
for (const entry of files) {
|
||||
const path = safeRelativePath(entry.filename);
|
||||
const target = path ? resolve(root, path) : undefined;
|
||||
if (!target || relative(root, target).startsWith("..") || !entry.getData) throw new Error(`The baseline artifact holds an unsafe path: ${entry.filename}`);
|
||||
await mkdir(dirname(target), { recursive: true });
|
||||
await writeFile(target, await entry.getData(new Uint8ArrayWriter(), { checkSignature: true, useWebWorkers: false }), { flag: "wx", mode: 0o600 });
|
||||
}
|
||||
} finally {
|
||||
await zip.close();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The wait as `capture:review` runs it: the downloaded baseline's directory, or undefined, and then base captures as it
|
||||
* would have. It never fails the review; each outcome is one progress line.
|
||||
*/
|
||||
export async function awaitPendingBaseline(options: BaselineWaitOptions & { directory: string }): Promise<string | undefined> {
|
||||
const progress = options.progress ?? silentProgress;
|
||||
const short = options.sha.slice(0, 8);
|
||||
const outcome = await waitForBaselineArtifact(options);
|
||||
if ("reason" in outcome) {
|
||||
progress(`base: stopped waiting for the baseline of ${short} (${outcome.reason}); capturing the base too`);
|
||||
return undefined;
|
||||
}
|
||||
try {
|
||||
await downloadBaselineArtifact({ ...options, artifact: outcome.artifact.id });
|
||||
progress(`base: downloaded the baseline of ${short} that run ${outcome.artifact.run} captured`);
|
||||
return options.directory;
|
||||
} catch (error) {
|
||||
await rm(options.directory, { recursive: true, force: true }).catch(() => {});
|
||||
progress(`base: the baseline of ${short} from run ${outcome.artifact.run} could not be downloaded (${options.signal?.aborted ? "the review stopped waiting" : describe(error)}); capturing the base too`);
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
+100
-12
@@ -8,6 +8,7 @@ import { setTimeout as delay } from "node:timers/promises";
|
||||
import { promisify } from "node:util";
|
||||
import { buildVerifiedPlan } from "./verified-plan.js";
|
||||
import { runCiMap, type CiMapOptions, type CommandRunner } from "../capture/run.js";
|
||||
import type { RepackShare } from "../capture/eas-build.js";
|
||||
import { resolveColorSchemes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
|
||||
import { baseEnvironment } from "../capture/common.js";
|
||||
import { DEFAULT_MAX_SESSIONS, planSideSessions, sessionShare } from "./session-plan.js";
|
||||
@@ -18,6 +19,7 @@ import { quarantineReviewContract } from "../contracts/review-validation.js";
|
||||
import { agentCaptureConstraints } from "../capture/agent/source-context.js";
|
||||
import { captureArtifactCacheMayMatch, captureRecipeConfig, restoreCaptureArtifactCache, writeCaptureArtifactCache } from "./artifact-cache.js";
|
||||
import { runCiMapOnWorker } from "./capture-worker.js";
|
||||
import { DEFAULT_BASELINE_WAIT_MINUTES, awaitPendingBaseline } from "./baseline-wait.js";
|
||||
import { writeCiReportInput, readAppDirectory } from "../report/artifact.js";
|
||||
import { assessPublicEvidence, readExportedMap, type PublicEvidenceSide } from "../review/evidence-assessment.js";
|
||||
import { parseRuntimeExecutionContext } from "../review/runtime-adapter.js";
|
||||
@@ -80,6 +82,21 @@ function captureOptions(config: ExploreConfig, environment: NodeJS.ProcessEnv, r
|
||||
...(config.capture.simulator ? { simulator: config.capture.simulator } : {}),
|
||||
environment, ...(runner ? { runner } : {}), easCommand: packageBin("eas-cli", "eas"), agentDeviceCommand: agentDeviceLauncher(environment), repackCommand: packageBin("@expo/repack-app", "repack-app") };
|
||||
}
|
||||
/**
|
||||
* The hosted repack this capture shares with the other matrix jobs of its GitHub run attempt (RepackShare): only inside
|
||||
* a GitHub Actions run, whose jobs are the only ones that meet, and only when another target repacks the same app
|
||||
* (`peers`, in config order, from hostedRepackPeers). A run attempt's repacks are never used by another attempt or run,
|
||||
* such as the baseline workflow's: "Re-run failed jobs" after an EAS environment value was fixed rebundles with it.
|
||||
* Each target's `rank` (its place among the peers) staggers how long it waits for another's repack (sharedRepackWaitMs);
|
||||
* a re-run attempt runs only the jobs it re-runs, so its leader may not be one of them, and its stagger starts at once.
|
||||
*/
|
||||
export function repackShareOption(config: ExploreConfig, environment: NodeJS.ProcessEnv, peers: readonly string[] | undefined): { repackShare?: RepackShare } {
|
||||
const target = config.target?.id;
|
||||
if (!peers || peers.length < 2 || !target || !peers.includes(target) || captureRepack(config) !== "eas") return {};
|
||||
const run = environment.GITHUB_RUN_ID ?? "", attempt = environment.GITHUB_RUN_ATTEMPT ?? "1", repository = environment.GITHUB_REPOSITORY ?? "";
|
||||
if (!/^[1-9][0-9]*$/.test(run) || !/^[1-9][0-9]*$/.test(attempt) || !/^[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+$/.test(repository)) return {};
|
||||
return { repackShare: { scope: `${repository}#${run}.${attempt}`, leader: peers[0]!, target, rank: peers.indexOf(target), ...(attempt === "1" ? {} : { rerun: true }) } };
|
||||
}
|
||||
/**
|
||||
* Head and base run in parallel worker threads when nothing ties them together: an agent session is
|
||||
* shared, an injected runner belongs to this thread, and a plausible baseline needs head's runtime profile.
|
||||
@@ -173,6 +190,24 @@ export async function sideAppearancePasses(config: ExploreConfig, environment: N
|
||||
return passes.length > 1 ? passes.map(pass => [...pass]) : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base's start in a review that waits for a baseline still being captured; head has already started. Base captures as
|
||||
* soon as the wait gives up, beside head when the sides capture concurrently, and a downloaded baseline is restored
|
||||
* once head finishes, since restoring checks it against head's runtime profile. A head that fails ends the wait, and
|
||||
* base is never started for a review that has already failed.
|
||||
*/
|
||||
export async function captureBaseAfterWait(input: { waited: Promise<string | undefined> | undefined; head: Promise<void>; stopWaiting: () => void;
|
||||
captureBase: (cacheDirectory?: string) => Promise<void> }): Promise<void> {
|
||||
if (!input.waited) return input.captureBase();
|
||||
let headFailed = false;
|
||||
input.head.catch(() => { headFailed = true; input.stopWaiting(); });
|
||||
const waited = await input.waited;
|
||||
if (headFailed) return;
|
||||
if (!waited) return input.captureBase();
|
||||
await input.head;
|
||||
return input.captureBase(waited);
|
||||
}
|
||||
|
||||
export function captureSidesConcurrently(input: { plan: SourceCapturePlan; agent: boolean; injectedRunner: boolean; baselineMayExist: boolean }): boolean {
|
||||
return !input.agent && !input.injectedRunner && !input.baselineMayExist
|
||||
&& input.plan.headCaptureSurfaceIds.length > 0 && input.plan.baseCaptureSurfaceIds.length > 0;
|
||||
@@ -202,15 +237,40 @@ export type PublicCiOptions = {
|
||||
targets?: RunTarget[];
|
||||
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
|
||||
posedTargets?: readonly string[];
|
||||
/** The targets whose jobs repack the same app as this one, in config order (hostedRepackPeers): they share one hosted repack per commit. */
|
||||
repackPeers?: readonly string[];
|
||||
baseProject: string; headProject: string; pullRequestPath: string; output: string;
|
||||
config: ExploreConfig; configPath?: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
|
||||
now?: () => number; sleep?: (milliseconds: number) => void; onComment?: (state: PublicCommentState, body: string) => void;
|
||||
runner?: CommandRunner;
|
||||
/** Internal dependency injection; configuration cannot replace the authenticated CLI session. */
|
||||
agentSessionFactory?: PrepareCiExplorationOptions["createSession"];
|
||||
/** Internal dependency injection for tests: replaces the wait for a baseline run that EXPLORE_BASELINE_RUN names. */
|
||||
awaitBaseline?: BaselineWait;
|
||||
progress?: Progress;
|
||||
/** Stops the captures between steps (a cancelled job): a session is still stopped, and a hosted repack run cancelled. */
|
||||
signal?: AbortSignal;
|
||||
};
|
||||
|
||||
/** Waits for a baseline of the base commit still being captured: its downloaded export's directory, or undefined. */
|
||||
type BaselineWait = (signal: AbortSignal) => Promise<string | undefined>;
|
||||
|
||||
/**
|
||||
* The wait for a baseline still capturing the base commit: for the run `ci:find-baseline` named in
|
||||
* EXPLORE_BASELINE_RUN, which the wait checks again by the same trust rules, for up to capture.baselineWaitMinutes. A
|
||||
* workflow that names no run, or a config that sets 0, captures the base as before.
|
||||
*/
|
||||
function pendingBaselineWait(options: Pick<PublicCiOptions, "awaitBaseline" | "config" | "target" | "platform" | "output" | "progress">,
|
||||
environment: NodeJS.ProcessEnv, transport: typeof fetch, baseSha: string): BaselineWait | undefined {
|
||||
if (options.awaitBaseline) return options.awaitBaseline;
|
||||
const run = Number(environment.EXPLORE_BASELINE_RUN);
|
||||
const minutes = options.config.capture.baselineWaitMinutes ?? DEFAULT_BASELINE_WAIT_MINUTES;
|
||||
if (!Number.isSafeInteger(run) || run <= 0 || minutes === 0) return undefined;
|
||||
const target = options.target ?? options.platform ?? options.config.target?.id ?? "ios";
|
||||
return signal => awaitPendingBaseline({ run, sha: baseSha, target, timeoutMs: minutes * 60_000, directory: join(resolve(options.output), "baseline-download"),
|
||||
environment, transport, signal, ...(options.progress ? { progress: options.progress } : {}) });
|
||||
}
|
||||
|
||||
function assertRunIdentity(environment: NodeJS.ProcessEnv): void {
|
||||
if (!/^[1-9][0-9]*$/.test(environment.GITHUB_RUN_ID ?? "") || !/^[1-9][0-9]*$/.test(environment.GITHUB_RUN_ATTEMPT ?? "")) {
|
||||
throw new CiError({ code: "CI_RUN_IDENTITY_MISSING", stage: "preflight", message: "The GitHub run ID or attempt is missing.",
|
||||
@@ -247,13 +307,14 @@ async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "head
|
||||
}
|
||||
|
||||
/** A review of any two commits (`capture:review --compare FILE`): the same capture as a PR's, with no PR to verify or comment on. */
|
||||
export async function runCompareCi(options: Omit<PublicCiOptions, "pullRequestPath" | "transport" | "onComment"> & { comparePath: string }) {
|
||||
export async function runCompareCi(options: Omit<PublicCiOptions, "pullRequestPath" | "onComment"> & { comparePath: string }) {
|
||||
const environment = options.environment ?? process.env;
|
||||
assertRunIdentity(environment);
|
||||
const comparison = projectComparePresentation(JSON.parse(await readFile(options.comparePath, "utf8")));
|
||||
const { projects, output, state } = await prepareCiRun(options, environment, comparison);
|
||||
const assertCurrentHead = async () => { for (const side of ["base", "head"] as const) assertCheckout(projects[side], comparison[side].sha); };
|
||||
return runCiReview({ ...options, projects, output, state, presentation: comparison,
|
||||
const awaitBaseline = pendingBaselineWait(options, environment, options.transport ?? fetch, comparison.base.sha);
|
||||
return runCiReview({ ...options, projects, output, state, presentation: comparison, ...(awaitBaseline ? { awaitBaseline } : {}),
|
||||
environment, runId: environment.GITHUB_RUN_ID!, runAttempt: environment.GITHUB_RUN_ATTEMPT!,
|
||||
assertCurrentHead, postComment: async () => {} });
|
||||
}
|
||||
@@ -324,7 +385,8 @@ export async function runPublicCi(options: PublicCiOptions) {
|
||||
for (const side of ["base", "head"] as const) assertCheckout(projects[side], pr[side].sha);
|
||||
await assertCurrentPr();
|
||||
};
|
||||
return runCiReview({ ...options, projects, output, state, presentation: pr,
|
||||
const awaitBaseline = pendingBaselineWait(options, environment, transport, pr.base.sha);
|
||||
return runCiReview({ ...options, projects, output, state, presentation: pr, ...(awaitBaseline ? { awaitBaseline } : {}),
|
||||
environment, runId: environment.GITHUB_RUN_ID!, runAttempt: environment.GITHUB_RUN_ATTEMPT!,
|
||||
assertCurrentHead, postComment, canPublish: () => !prVerificationFailed });
|
||||
}
|
||||
@@ -348,12 +410,19 @@ export async function runCiReview(options: {
|
||||
posedTargets?: readonly string[];
|
||||
/** A folder shared with the other targets' reviews, so the targets of one platform build each commit once. */
|
||||
buildShare?: string;
|
||||
/** The targets whose matrix jobs repack the same app as this one, in config order: they share one hosted repack per commit. */
|
||||
repackPeers?: readonly string[];
|
||||
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
|
||||
state: PublicCommentState; environment: NodeJS.ProcessEnv;
|
||||
assertCurrentHead: () => Promise<void>; postComment: () => Promise<void>; canPublish?: () => boolean;
|
||||
now?: () => number; sleep?: (milliseconds: number) => void; runner?: CommandRunner; subscription?: boolean; useLocalEasSession?: boolean;
|
||||
agentSessionFactory?: PrepareCiExplorationOptions["createSession"];
|
||||
prepareCapture?: () => Promise<void>;
|
||||
/**
|
||||
* Waits for a baseline of the base commit that is still being captured, when no downloaded baseline matches. It runs
|
||||
* alongside head, and base waits for it only where base would start capturing.
|
||||
*/
|
||||
awaitBaseline?: BaselineWait;
|
||||
progress?: Progress;
|
||||
/** Stops the captures between steps; model requests take it through agentSessionFactory. */
|
||||
signal?: AbortSignal;
|
||||
@@ -371,6 +440,8 @@ export async function runCiReview(options: {
|
||||
let usagePhase: AgentUsagePhase = "preflight";
|
||||
let preserveReport: (() => Promise<void>) | undefined;
|
||||
let reportWritten = false;
|
||||
// Stops a baseline wait still polling once the review no longer needs it: done, failed, or stopped.
|
||||
const stopWaiting = new AbortController();
|
||||
try {
|
||||
progress(`planning the review of ${pr.head.sha.slice(0, 8)} against base ${pr.base.sha.slice(0, 8)} (scope ${config.exploration.scope})`);
|
||||
const plan = await buildVerifiedPlan({ baseProject: projects.base, headProject: projects.head,
|
||||
@@ -401,6 +472,10 @@ export async function runCiReview(options: {
|
||||
// A baseline that may be restored needs the head runtime profile first; otherwise both sides capture at once.
|
||||
const baselineMayExist = plan.baseCaptureSurfaceIds.length > 0 && await captureArtifactCacheMayMatch({ ...cacheRecipes.base,
|
||||
...(environment.EXPLORE_CAPTURE_CACHE ? { sourceDirectory: environment.EXPLORE_CAPTURE_CACHE } : {}), commit: pr.base.sha });
|
||||
// With no finished baseline to reuse, one still being captured is waited for: from now, alongside head, and base
|
||||
// waits for it only where it would start. Head is never delayed by it (brentvatne/euxy's review run 39348956443).
|
||||
const waitedBaseline = !baselineMayExist && plan.baseCaptureSurfaceIds.length > 0 && options.awaitBaseline
|
||||
? options.awaitBaseline(options.signal ? AbortSignal.any([stopWaiting.signal, options.signal]) : stopWaiting.signal).catch(() => undefined) : undefined;
|
||||
const share = targetSessionShare(config, options.targets, options.posedTargets);
|
||||
// A share of one session captures the sides in turn.
|
||||
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist }) && share >= 2;
|
||||
@@ -415,13 +490,13 @@ export async function runCiReview(options: {
|
||||
progress(`sessions: ${share} of ${config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
|
||||
+ (split.length ? `${split.join(" and ")} ${split.length === 1 ? "captures its" : "capture their"} appearances in separate sessions`
|
||||
: concurrent ? "one session per side" : "the sides in turn"));
|
||||
const captureSide = async (side: "head" | "base") => {
|
||||
const captureSide = async (side: "head" | "base", cacheDirectory = environment.EXPLORE_CAPTURE_CACHE) => {
|
||||
const directory = join(output, `${side}-export`);
|
||||
const selectedIds = plan[`${side}CaptureSurfaceIds`];
|
||||
const cacheRecipe = cacheRecipes[side];
|
||||
let reuseDirectory: string | undefined;
|
||||
if (side === "base" && selectedIds.length && runtimeProfile && environment.EXPLORE_CAPTURE_CACHE) {
|
||||
const restored = await restoreCaptureArtifactCache({ ...cacheRecipe, sourceDirectory: environment.EXPLORE_CAPTURE_CACHE,
|
||||
if (side === "base" && selectedIds.length && runtimeProfile && cacheDirectory) {
|
||||
const restored = await restoreCaptureArtifactCache({ ...cacheRecipe, sourceDirectory: cacheDirectory,
|
||||
commit: pr.base.sha, selectedIds, directory: join(output, "base-cache"), runtimeProfile,
|
||||
...(exploration.agent ? { captureContexts: exploration.agent.contexts } : {}) });
|
||||
if (restored) reuseDirectory = join(output, "base-cache");
|
||||
@@ -433,6 +508,7 @@ export async function runCiReview(options: {
|
||||
mapDirectory: join(output, `${side}-map`), outputDirectory: directory,
|
||||
name: config.app.name ?? pr.repository, buildId: pr.origin === "local" ? `local-${pr.runId}-${side}` : pr.origin === "compare" ? `compare-${options.runId}-${side}` : `pr-${pr.number}-${side}`, buildVersion: pr[side].sha.slice(0, 8), gitCommit: pr[side].sha,
|
||||
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`), ...(options.buildShare ? { buildShare: options.buildShare } : {}),
|
||||
...repackShareOption(config, environment, options.repackPeers),
|
||||
...(reuseDirectory ? { reuseDirectory } : {}), ...(options.signal ? { signal: options.signal } : {}) };
|
||||
// A restored baseline already holds every appearance pass, so it never splits.
|
||||
const captured = await captureSideInSessions(mapOptions, reuseDirectory ? undefined : sidePasses[side], progress, options.signal, concurrent);
|
||||
@@ -453,12 +529,17 @@ export async function runCiReview(options: {
|
||||
}
|
||||
await writeCaptureArtifactCache(directory, cacheRecipe);
|
||||
};
|
||||
const captureBase = (head: Promise<void>) => captureBaseAfterWait({ waited: waitedBaseline, head, stopWaiting: () => stopWaiting.abort(),
|
||||
captureBase: cacheDirectory => captureSide("base", cacheDirectory) });
|
||||
if (waitedBaseline) progress(`base waits for the baseline run of ${pr.base.sha.slice(0, 8)} still being captured; head captures meanwhile`);
|
||||
if (concurrent) {
|
||||
stage = "capture-head"; state.phase = "capturing"; state.capture.current = "head"; usagePhase = "capture-head";
|
||||
progress("capturing head and base at the same time in two simulator sessions");
|
||||
progress(waitedBaseline ? "capturing head; base captures in a second simulator session if the baseline cannot be reused"
|
||||
: "capturing head and base at the same time in two simulator sessions");
|
||||
await postComment();
|
||||
// Let both sides finish or fail on their own so every started session is stopped by its owner.
|
||||
const settled = await Promise.allSettled([captureSide("head"), captureSide("base")]);
|
||||
const head = captureSide("head");
|
||||
const settled = await Promise.allSettled([head, captureBase(head)]);
|
||||
for (const [index, outcome] of settled.entries()) {
|
||||
if (outcome.status === "rejected") { stage = index === 0 ? "capture-head" : "capture-base"; throw outcome.reason; }
|
||||
}
|
||||
@@ -467,7 +548,7 @@ export async function runCiReview(options: {
|
||||
stage = `capture-${side}`; state.phase = "capturing"; state.capture.current = side;
|
||||
usagePhase = `capture-${side}`;
|
||||
await postComment();
|
||||
await captureSide(side);
|
||||
await (side === "head" ? captureSide("head") : captureBase(Promise.resolve()));
|
||||
}
|
||||
}
|
||||
delete state.capture.current;
|
||||
@@ -564,6 +645,8 @@ export async function runCiReview(options: {
|
||||
try { await postComment(); } catch { /* A stale PR or inaccessible GitHub must not replace the original failure. */ }
|
||||
}
|
||||
throw error;
|
||||
} finally {
|
||||
stopWaiting.abort();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -572,12 +655,16 @@ export async function runBaselineCi(options: { platform?: ExplorePlatform; proje
|
||||
targets?: RunTarget[];
|
||||
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
|
||||
posedTargets?: readonly string[];
|
||||
/** The targets whose baseline jobs repack the same app as this one, in config order: they share one hosted repack. */
|
||||
repackPeers?: readonly string[];
|
||||
now?: () => number; sleep?: (milliseconds: number) => void;
|
||||
agentSessionFactory?: PrepareCiExplorationOptions["createSession"]; progress?: Progress;
|
||||
/** Use the local `eas login` session instead of EXPO_TOKEN (expo-explore doctor --capture). */
|
||||
useLocalEasSession?: boolean;
|
||||
/** Agent mode with the local claude or codex login instead of the provider's API key. */
|
||||
subscription?: boolean }) {
|
||||
subscription?: boolean;
|
||||
/** Stops the capture between steps (a cancelled job): its session is still stopped, and a hosted repack run cancelled. */
|
||||
signal?: AbortSignal }) {
|
||||
const environment = options.environment ?? process.env;
|
||||
assertCheckout(options.project, options.sha);
|
||||
if (!options.runner) await prefetchControllers(options.config, environment, options.progress ?? silentProgress);
|
||||
@@ -602,14 +689,15 @@ export async function runBaselineCi(options: { platform?: ExplorePlatform; proje
|
||||
...(exploration.agent ? { agent: exploration.agent } : {}), project: options.project,
|
||||
mapDirectory: join(output, "baseline-map"), outputDirectory: directory, name: options.config.app.name ?? options.config.app.bundleId,
|
||||
buildId: `baseline-${options.sha.slice(0, 12)}`, buildVersion: options.sha.slice(0, 8), gitCommit: options.sha,
|
||||
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") };
|
||||
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session"),
|
||||
...repackShareOption(options.config, environment, options.repackPeers), ...(options.signal ? { signal: options.signal } : {}) };
|
||||
const share = targetSessionShare(options.config, options.targets, options.posedTargets);
|
||||
// Passes on worker threads cannot take an injected runner or an agent session.
|
||||
const passes = !options.runner && !exploration.agent
|
||||
? await sideAppearancePasses(options.config, environment, { share, sides: 1, routes: plan.headCaptureSurfaceIds.length, project: options.project }) : undefined;
|
||||
progress(`sessions: ${share} of ${options.config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
|
||||
+ (passes ? `capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions` : "one session"));
|
||||
const result = await captureSideInSessions(baselineOptions, passes, progress, undefined, passes !== undefined);
|
||||
const result = await captureSideInSessions(baselineOptions, passes, progress, options.signal, passes !== undefined);
|
||||
const cacheRecipe = await recipe(options.config, plan, "head", environment, exploration.instructionsSha256);
|
||||
if (options.subscription) cacheRecipe.toolsCommit += ":local-subscription";
|
||||
const bundle = await readCaptureBundle(directory); bundle.profile = cacheRecipe.profile;
|
||||
|
||||
+70
-18
@@ -30,7 +30,7 @@ export async function writeCaptureOutputs(inputPath: string, environment: Enviro
|
||||
await writeStepOutputs(environment, { preview: (await readCiReportInput(inputPath)).preview?.hosting ?? "" });
|
||||
}
|
||||
|
||||
function githubContext(environment: Environment) {
|
||||
export function githubContext(environment: Environment) {
|
||||
const repository = environment.GITHUB_REPOSITORY ?? "";
|
||||
const token = environment.GITHUB_TOKEN?.trim();
|
||||
if (!/^[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+$/.test(repository)) throw new CiError({ code: "CI_RUN_IDENTITY_MISSING", stage: "preflight",
|
||||
@@ -41,7 +41,7 @@ function githubContext(environment: Environment) {
|
||||
}
|
||||
|
||||
/** One GitHub REST read; 404 is an answer (undefined), every other failure stops the step with what to do. */
|
||||
async function githubGet<T>(path: string, context: { token: string }, transport: typeof fetch): Promise<T | undefined> {
|
||||
export async function githubGet<T>(path: string, context: { token: string }, transport: typeof fetch): Promise<T | undefined> {
|
||||
let response: Response;
|
||||
try {
|
||||
response = await transport(`https://api.github.com/${path}`, { redirect: "error", signal: AbortSignal.timeout(30_000),
|
||||
@@ -102,57 +102,109 @@ async function trustedAuthors(context: { repository: string; token: string }, tr
|
||||
catch (error) { return { logins: [], invalid: error instanceof Error ? error.message : String(error) }; }
|
||||
}
|
||||
|
||||
type GithubArtifact = { id: number; expired: boolean; workflow_run?: { id?: number } };
|
||||
type GithubRun = { conclusion: string | null; workflow_id: number; head_sha: string; head_branch: string; event: string; head_repository?: { full_name?: string } };
|
||||
export type GithubArtifact = { id: number; name?: string; expired: boolean; workflow_run?: { id?: number } };
|
||||
export type GithubRun = { id: number; status?: string; conclusion: string | null; workflow_id: number; head_sha: string; head_branch: string; event: string;
|
||||
head_repository?: { full_name?: string } };
|
||||
|
||||
/**
|
||||
* `ci:find-baseline`: the newest successful baseline-workflow artifact of exactly this commit, uploaded from the
|
||||
* default branch of this repository. Its id and run go to the step outputs for actions/download-artifact.
|
||||
* What every baseline lookup starts from: the GitHub context, a checked commit and target, the default branch and the
|
||||
* baseline workflow's id, and the artifact names a baseline of this target may carry. Undefined when the repository
|
||||
* has no baseline workflow.
|
||||
*/
|
||||
export async function findBaselineArtifact(options: { sha: string; target?: string;
|
||||
/** What callers from before targets pass: a platform is the id of its default target. */ platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
|
||||
export async function baselineLookup(options: { sha: string; target?: string; platform?: string; environment?: Environment; transport?: typeof fetch;
|
||||
/** Wraps each read, as a wait that polls for minutes retries GitHub's transient failures. */ retry?: <T>(read: () => Promise<T>) => Promise<T> }) {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const context = githubContext(environment);
|
||||
if (!SHA.test(options.sha)) throw new CiError({ code: "SHA_INVALID", stage: "preflight", message: "The base commit must be a full SHA.", nextAction: "Pass --sha with a 40-character commit SHA." });
|
||||
const target = options.target ?? options.platform ?? "ios";
|
||||
if (!isTargetId(target)) throw new CiError({ code: "TARGET_INVALID", stage: "preflight", message: `${target} is not a target id.`,
|
||||
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
|
||||
const repository = await githubGet<{ default_branch: string }>(`repos/${context.repository}`, context, transport);
|
||||
const workflow = await githubGet<{ id: number }>(`repos/${context.repository}/actions/workflows/explore-baseline.yml`, context, transport);
|
||||
const read = <T>(path: string) => githubGet<T>(path, context, transport);
|
||||
const get = <T>(path: string) => options.retry ? options.retry(() => read<T>(path)) : read<T>(path);
|
||||
const repository = await get<{ default_branch: string }>(`repos/${context.repository}`);
|
||||
const workflow = await get<{ id: number }>(`repos/${context.repository}/actions/workflows/explore-baseline.yml`);
|
||||
if (!repository || !workflow) return undefined;
|
||||
// Baselines carry the target suffix; target ios also accepts the unsuffixed name older single-platform baseline workflows uploaded.
|
||||
const names = [`explore-baseline-${options.sha}-${target}`, ...(target === "ios" ? [`explore-baseline-${options.sha}`] : [])];
|
||||
return { context, get, target, sha: options.sha, defaultBranch: repository.default_branch, workflow: workflow.id, names };
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a run may supply this commit's baseline: a run of the baseline workflow for exactly this commit, on the
|
||||
* default branch of this repository, started by a push or a manual dispatch. A finished run's artifact is reused, and
|
||||
* a run still capturing is waited for, only when it passes this check; nothing from a pull request's head selects it.
|
||||
*/
|
||||
export function trustedBaselineRun(run: GithubRun | undefined, lookup: { workflow: number; sha: string; defaultBranch: string; context: { repository: string } }): run is GithubRun {
|
||||
return !!run && run.workflow_id === lookup.workflow && run.head_sha === lookup.sha && run.head_branch === lookup.defaultBranch
|
||||
&& ["push", "workflow_dispatch"].includes(run.event) && run.head_repository?.full_name === lookup.context.repository;
|
||||
}
|
||||
|
||||
/**
|
||||
* `ci:find-baseline`: the newest baseline-workflow artifact of exactly this commit, uploaded from the default branch of
|
||||
* this repository by a finished run. Its id and run go to the step outputs for actions/download-artifact. A run that
|
||||
* failed counts: a target's baseline job uploads its artifact only after every step before it passed, so another
|
||||
* target's failure (one flaky simulator session, as in brentvatne/euxy#172) does not make this target's baseline
|
||||
* unusable. A run still in progress or cancelled does not; findPendingBaselineRun finds one still capturing.
|
||||
*/
|
||||
export async function findBaselineArtifact(options: { sha: string; target?: string;
|
||||
/** What callers from before targets pass: a platform is the id of its default target. */ platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
|
||||
const lookup = await baselineLookup(options);
|
||||
if (!lookup) return undefined;
|
||||
const { context, get } = lookup;
|
||||
const artifacts: GithubArtifact[] = [];
|
||||
for (const name of names) for (let page = 1; page <= 10; page++) {
|
||||
const listed = await githubGet<{ artifacts: GithubArtifact[] }>(`repos/${context.repository}/actions/artifacts?name=${encodeURIComponent(name)}&per_page=100&page=${page}`, context, transport);
|
||||
for (const name of lookup.names) for (let page = 1; page <= 10; page++) {
|
||||
const listed = await get<{ artifacts: GithubArtifact[] }>(`repos/${context.repository}/actions/artifacts?name=${encodeURIComponent(name)}&per_page=100&page=${page}`);
|
||||
artifacts.push(...listed?.artifacts ?? []);
|
||||
if ((listed?.artifacts.length ?? 0) < 100) break;
|
||||
}
|
||||
for (const artifact of artifacts.filter(candidate => !candidate.expired).sort((a, b) => b.id - a.id)) {
|
||||
if (!artifact.workflow_run?.id) continue;
|
||||
const run = await githubGet<GithubRun>(`repos/${context.repository}/actions/runs/${artifact.workflow_run.id}`, context, transport);
|
||||
if (!run || run.conclusion !== "success" || run.workflow_id !== workflow.id || run.head_sha !== options.sha
|
||||
|| run.head_branch !== repository.default_branch || !["push", "workflow_dispatch"].includes(run.event)
|
||||
|| run.head_repository?.full_name !== context.repository) continue;
|
||||
const run = await get<GithubRun>(`repos/${context.repository}/actions/runs/${artifact.workflow_run.id}`);
|
||||
if (!trustedBaselineRun(run, lookup) || (run.conclusion !== "success" && run.conclusion !== "failure")) continue;
|
||||
return { id: artifact.id, run: artifact.workflow_run.id };
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* A baseline run of exactly this commit that has not finished yet (queued, waiting or in progress), passing the same
|
||||
* trust check as a finished one. In brentvatne/euxy's review run 39348956443 main's baseline of the base commit had
|
||||
* started 15 s before the review, so no artifact existed yet. A run already capturing is preferred to one queued
|
||||
* behind it in the baseline's concurrency group, since it finishes first; then the newest.
|
||||
*/
|
||||
export async function findPendingBaselineRun(options: Parameters<typeof baselineLookup>[0]): Promise<{ run: number } | undefined> {
|
||||
const lookup = await baselineLookup(options);
|
||||
if (!lookup) return undefined;
|
||||
const listed = await lookup.get<{ workflow_runs?: GithubRun[] }>(`repos/${lookup.context.repository}/actions/workflows/${lookup.workflow}/runs?head_sha=${lookup.sha}`
|
||||
+ `&branch=${encodeURIComponent(lookup.defaultBranch)}&per_page=100`);
|
||||
const pending = (listed?.workflow_runs ?? []).filter(run => run.status !== "completed" && Number.isSafeInteger(run.id) && run.id > 0 && trustedBaselineRun(run, lookup))
|
||||
.sort((a, b) => Number(b.status === "in_progress") - Number(a.status === "in_progress") || b.id - a.id);
|
||||
return pending[0] ? { run: pending[0].id } : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* `ci:find-baseline` as the workflow runs it: a baseline is optional, so a lookup that fails (a GitHub 5xx, a rate
|
||||
* limit) is a warning and no baseline, never an error. A `ci:*` error would write explore-diagnostics/error.json,
|
||||
* which the failure comment would then report as the cause of an unrelated failure, possibly on another target.
|
||||
* With no finished baseline, it names a trusted baseline run still capturing the commit as `pending`, which
|
||||
* `capture:review` waits for alongside head.
|
||||
*/
|
||||
export async function findOptionalBaseline(options: Parameters<typeof findBaselineArtifact>[0]):
|
||||
Promise<{ baseline?: { id: number; run: number }; warning?: { code: string; message: string } }> {
|
||||
Promise<{ baseline?: { id: number; run: number }; pending?: { run: number }; warning?: { code: string; message: string } }> {
|
||||
try {
|
||||
const baseline = await findBaselineArtifact(options);
|
||||
return baseline ? { baseline } : {};
|
||||
if (baseline) return { baseline };
|
||||
} catch (error) {
|
||||
return { warning: { code: error instanceof CiError ? error.code : "BASELINE_LOOKUP_FAILED",
|
||||
message: `No baseline is reused, so capture captures the base too: ${error instanceof Error ? error.message : String(error)}` } };
|
||||
}
|
||||
try {
|
||||
const pending = await findPendingBaselineRun(options);
|
||||
return pending ? { pending } : {};
|
||||
} catch (error) {
|
||||
return { warning: { code: error instanceof CiError ? error.code : "BASELINE_LOOKUP_FAILED",
|
||||
message: `No baseline run in progress is waited for, so capture captures the base too: ${error instanceof Error ? error.message : String(error)}` } };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -5,6 +5,7 @@ import { resolve } from "node:path";
|
||||
import { ExploreStore } from "./map/store.js";
|
||||
import { QUERY_CONTRACT } from "./types.js";
|
||||
import { EXPLORE_VERSION } from "./shared/package-paths.js";
|
||||
import { isTargetId } from "./config/explore-config.js";
|
||||
import { command, resultContract, argumentError, validateCommandArguments, flag, has, setStore } from "./cli/args.js";
|
||||
import { help } from "./cli/help.js";
|
||||
import { listScreens, getScreen, listElements, listObservations, getObservation, nextFrontier, listAttempts, getAttempt, listTransitions, getTransition, neighbors, pathQuery, listJourneys, getJourney, listFrontier, listGaps, summary, search, status, validate, exportArtifacts } from "./cli/map-commands.js";
|
||||
@@ -81,8 +82,11 @@ try {
|
||||
await handler();
|
||||
} catch (error) {
|
||||
if (command.startsWith("capture:") || command.startsWith("source:") || command.startsWith("ci:") || command.startsWith("config:")) {
|
||||
// The failure comment names the target from this: a capture, report or publication of one matrix target.
|
||||
const target = (() => { try { return flag("target"); } catch { return undefined; } })();
|
||||
const diagnostic = await reportCiError(ciErrorForCommand(error, command), {
|
||||
...(process.env.RUNNER_TEMP ? { diagnosticsPath: resolve(process.env.RUNNER_TEMP, "explore-diagnostics", "error.json") } : {}),
|
||||
...(isTargetId(target) ? { target } : {}),
|
||||
...(has("json") ? { write: (line: string) => { if (process.env.GITHUB_ACTIONS === "true") console.log(line); } } : {}),
|
||||
});
|
||||
if (has("json")) console.error(JSON.stringify({ contract: resultContract, command, ok: false, error: diagnostic.message, diagnostic }));
|
||||
|
||||
+2
-2
@@ -90,10 +90,10 @@ const flagKinds: Record<string, Record<string, "value" | "boolean">> = {
|
||||
|
||||
|
||||
|
||||
"explore:binary": { archive:"value", output:"value", platform:"value", controller:"value", simulator:"value", device:"value", "bundle-id":"value", "launch-url":"value", hints:"value", "allow-destructive":"value",
|
||||
"explore:binary": { replay:"value", archive:"value", output:"value", platform:"value", controller:"value", simulator:"value", device:"value", "bundle-id":"value", "launch-url":"value", hints:"value", "allow-destructive":"value",
|
||||
"max-duration-minutes":"value", "max-screens":"value", "max-actions":"value", provider:"value", model:"value", owner:"value", project:"value",
|
||||
upload:"boolean", "no-upload":"boolean", "expires-in":"value", alias:"value", "no-open":"boolean", port:"value" },
|
||||
"explore:session": { session:"value", "env-file":"value", "bundle-id":"value", "app-name":"value", "app-version":"value", output:"value", platform:"value", controller:"value", device:"value", "launch-url":"value", hints:"value",
|
||||
"explore:session": { replay:"value", session:"value", "env-file":"value", "bundle-id":"value", "app-name":"value", "app-version":"value", output:"value", platform:"value", controller:"value", device:"value", "launch-url":"value", hints:"value",
|
||||
"allow-destructive":"value", "max-duration-minutes":"value", "max-screens":"value", "max-actions":"value", provider:"value", model:"value", owner:"value", project:"value",
|
||||
upload:"boolean", "expires-in":"value", alias:"value", "no-open":"boolean", port:"value" },
|
||||
"ci:report": { input:"value", output:"value", target:"value", platform:"value" },
|
||||
|
||||
@@ -7,6 +7,7 @@ import { assertHostingExport, deployExplorationReport, zipReportDirectory } from
|
||||
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";
|
||||
import { readReplayPlan } from "../binary/replay.js";
|
||||
|
||||
|
||||
/** `--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). */
|
||||
@@ -49,6 +50,7 @@ export async function exploreBinary(): Promise<void> {
|
||||
...(flag("max-duration-minutes") ? { maxDurationMinutes: positiveInteger("max-duration-minutes") } : {}),
|
||||
...(flag("max-screens") ? { maxScreens: positiveInteger("max-screens") } : {}),
|
||||
...(flag("max-actions") ? { maxActions: positiveInteger("max-actions") } : {}),
|
||||
...(flag("replay") ? { replay: await readReplayPlan(resolve(process.cwd(), flag("replay")!)) } : {}),
|
||||
});
|
||||
say(`exploration ${result.exploration.stopReason}: ${result.exploration.screens} screens, ${result.exploration.observations} captures, ${result.exploration.actions} actions`);
|
||||
const report = await writeExplorationReport(result, join(outputDirectory, "report"));
|
||||
@@ -113,6 +115,7 @@ export async function exploreSession(): Promise<void> {
|
||||
...(flag("max-duration-minutes") ? { maxDurationMinutes: positiveInteger("max-duration-minutes") } : {}),
|
||||
...(flag("max-screens") ? { maxScreens: positiveInteger("max-screens") } : {}),
|
||||
...(flag("max-actions") ? { maxActions: positiveInteger("max-actions") } : {}),
|
||||
...(flag("replay") ? { replay: await readReplayPlan(resolve(process.cwd(), flag("replay")!)) } : {}),
|
||||
});
|
||||
say(`exploration ${result.exploration.stopReason}: ${result.exploration.screens} screens, ${result.exploration.observations} captures, ${result.exploration.actions} actions`);
|
||||
const report = await writeExplorationReport(result, join(outputDirectory, "report"));
|
||||
|
||||
+37
-9
@@ -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, posedTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, posedTargets, hostedRepackPeers, 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";
|
||||
@@ -110,13 +110,20 @@ export async function ciPullRequest(): Promise<void> {
|
||||
output({ ok: true, pullRequest: presentation, author });
|
||||
}
|
||||
|
||||
/** `ci:find-baseline --sha SHA [--platform P]`: a reusable baseline artifact of the base commit, if one exists. */
|
||||
/**
|
||||
* `ci:find-baseline --sha SHA [--platform P]`: a reusable baseline artifact of the base commit, if one exists, or else
|
||||
* the baseline run still capturing it (`pending`), which `capture:review` waits for alongside head.
|
||||
*/
|
||||
export async function ciFindBaseline(): Promise<void> {
|
||||
const platform = platformFlag(), target = targetFlag();
|
||||
const { baseline, warning } = await findOptionalBaseline({ sha: required("sha"), ...(platform ? { platform } : {}), ...(target ? { target } : {}) });
|
||||
const { baseline, pending, warning } = await findOptionalBaseline({ sha: required("sha"), ...(platform ? { platform } : {}), ...(target ? { target } : {}) });
|
||||
if (baseline) await writeStepOutputs(process.env, { id: String(baseline.id), run: String(baseline.run) });
|
||||
if (pending) {
|
||||
await writeStepOutputs(process.env, { pending: String(pending.run) });
|
||||
console.error(`No finished baseline of ${required("sha").slice(0, 8)} yet; baseline run ${pending.run} is still capturing it; capture:review waits for it while head captures, up to capture.baselineWaitMinutes.`);
|
||||
}
|
||||
if (warning && process.env.GITHUB_ACTIONS) console.log(`::warning title=${warning.code}::${warning.message.replace(/[\r\n]+/g, " ")}`);
|
||||
output({ ok: true, baseline: baseline ?? null, ...(warning ? { warning } : {}) });
|
||||
output({ ok: true, baseline: baseline ?? null, ...(pending ? { pending } : {}), ...(warning ? { warning } : {}) });
|
||||
}
|
||||
|
||||
/** `ci:compare-refs --project DIR --base REF --head REF [--output FILE]`: the two commits a comparison captures. */
|
||||
@@ -220,6 +227,23 @@ export async function sourceVerify(): Promise<void> {
|
||||
output({ ok: true, deterministic: true, routes: plan.inventorySurfaceIds.length });
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops a CI capture GitHub cancels: the runner sends SIGINT, then SIGTERM. The first stops the captures between steps,
|
||||
* so each stops its session and cancels a hosted repack run it waits on (a blocked eas-cli command gets the signal too
|
||||
* and returns); the second quits at once. Without it a cancelled job left its EAS workflow run repacking.
|
||||
*/
|
||||
function ciInterrupt(): AbortSignal {
|
||||
const controller = new AbortController();
|
||||
const interrupt = (signal: NodeJS.Signals) => {
|
||||
if (controller.signal.aborted) process.exit(130);
|
||||
process.stderr.write(`\nStopping the capture (${signal}): its sessions are stopped and its hosted repack cancelled. A second signal quits now.\n`);
|
||||
controller.abort(new CiError({ code: "CAPTURE_CANCELLED", stage: "capture", message: `The capture was stopped (${signal}).`, nextAction: "Rerun the workflow when you are ready." }));
|
||||
};
|
||||
process.on("SIGINT", interrupt);
|
||||
process.on("SIGTERM", interrupt);
|
||||
return controller.signal;
|
||||
}
|
||||
|
||||
export async function captureReview(): Promise<void> {
|
||||
// Refs without the CI flags: a review on this machine, with your own logins (see runLocalReview).
|
||||
if (!has("base-project") && !has("head-project") && !has("pull-request") && !has("compare")) return localReview();
|
||||
@@ -229,13 +253,15 @@ export async function captureReview(): Promise<void> {
|
||||
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") });
|
||||
const overrides = { scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") };
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, selection), overrides);
|
||||
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.
|
||||
const named = selection.target !== undefined || selection.platform !== undefined;
|
||||
const common = { ...(named ? { target: config.target!.id } : {}), ...(selection.platform ? { platform: selection.platform } : {}),
|
||||
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), baseProject: required("base-project"), headProject,
|
||||
output: required("output"), config, configPath, progress: stderrProgress() };
|
||||
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), repackPeers: hostedRepackPeers(rawConfig, config, overrides),
|
||||
baseProject: required("base-project"), headProject,
|
||||
output: required("output"), config, configPath, progress: stderrProgress(), signal: ciInterrupt() };
|
||||
const result = has("compare") ? await runCompareCi({ ...common, comparePath: required("compare") })
|
||||
: await runPublicCi({ ...common, pullRequestPath: required("pull-request") });
|
||||
// The deploy job runs only when the reviewed config asks for a hosted report.
|
||||
@@ -246,8 +272,10 @@ export async function captureReview(): Promise<void> {
|
||||
export async function captureBaseline(): Promise<void> {
|
||||
const project = required("project");
|
||||
const rawConfig = await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, targetSelection()), { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
|
||||
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), progress: stderrProgress() }) });
|
||||
const overrides = { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") };
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, targetSelection()), overrides);
|
||||
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig),
|
||||
repackPeers: hostedRepackPeers(rawConfig, config, overrides), progress: stderrProgress(), signal: ciInterrupt() }) });
|
||||
}
|
||||
|
||||
/** `capture` (or `capture:review`) `[--base REF] [--head REF | --committed]`: a local review, opened in the Viewer or hosted with --upload. */
|
||||
|
||||
@@ -56,6 +56,7 @@ const BINARY = `Prebuilt apps (no source needed; runs with your local claude or
|
||||
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 --allow-destructive "Label,Other label"
|
||||
--replay FILE (takes the steps in FILE instead of a model's, so every run and device takes the same path; no model access needed, and not with --provider, --model or --hints)
|
||||
--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)
|
||||
@@ -94,6 +95,7 @@ const CI = `CI (the installed workflows run these; they manage remote EAS Simula
|
||||
(resolves the live PR and refuses it unless it is open, from this repository, and by a trusted author)
|
||||
ci:compare-refs --project DIRECTORY --base REF --head REF [--output FILE]
|
||||
ci:find-baseline --sha COMMIT [--target ID | --platform ios|android]
|
||||
(a finished baseline's artifact of the commit, or else the default branch's baseline run still capturing it)
|
||||
ci:after-capture --output TEMP_DIRECTORY --checkout DIRECTORY...
|
||||
(stops the capture's EAS Simulator sessions and checks capture left each checkout unchanged)
|
||||
(the ci:* commands write their results to $GITHUB_OUTPUT for the next steps)`;
|
||||
|
||||
@@ -99,6 +99,11 @@ export type ExploreConfig = {
|
||||
* DEFAULT_MAX_SESSIONS (5). Below the number of targets, that many target jobs run at once, one session each.
|
||||
*/
|
||||
maxSessions?: number;
|
||||
/**
|
||||
* How many minutes a review waits for the default branch's baseline run of its base commit, still capturing when
|
||||
* the review starts, before it captures the base itself; 0 never waits. Absent: DEFAULT_BASELINE_WAIT_MINUTES (15).
|
||||
*/
|
||||
baselineWaitMinutes?: number;
|
||||
/** Where the route observer is bundled into the app, when the config chooses; captureRepack gives the default. */
|
||||
repack?: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number;
|
||||
/** The device controller; absent means agent-device, so configs that never chose one keep their cache recipes. */
|
||||
@@ -194,6 +199,11 @@ function positiveInteger(value: unknown, label: string, fallback?: number): numb
|
||||
return value;
|
||||
}
|
||||
|
||||
function boundedInteger(value: unknown, label: string, minimum: number, maximum: number): number {
|
||||
if (typeof value !== "number" || !Number.isSafeInteger(value) || value < minimum || value > maximum) fail(`${label} must be a whole number from ${minimum} to ${maximum}`, label);
|
||||
return value;
|
||||
}
|
||||
|
||||
function customScheme(value: unknown, label: string): string {
|
||||
const result = text(value, label, 128).toLowerCase();
|
||||
if (!/^[a-z][a-z0-9+.-]*$/.test(result) || RESERVED_SCHEMES.has(result)) {
|
||||
@@ -300,7 +310,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
const exploration = optionalRecord(root.exploration, "exploration");
|
||||
exactKeys(exploration, ["scope", "exclude"], "exploration");
|
||||
const capture = optionalRecord(root.capture, "capture");
|
||||
exactKeys(capture, ["maxMinutes", "maxActions", "maxSessions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
|
||||
exactKeys(capture, ["maxMinutes", "maxActions", "maxSessions", "baselineWaitMinutes", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
|
||||
const controller = literal(capture.controller, ["agent-device", "argent"] as const, "capture.controller", "agent-device");
|
||||
const simulator = literal(capture.simulator, ["eas", "local"] as const, "capture.simulator", "eas");
|
||||
const mode = literal(root.mode, ["deterministic", "agent"] as const, "mode", "deterministic");
|
||||
@@ -348,6 +358,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
maxMinutes: positiveInteger(capture.maxMinutes, "capture.maxMinutes", 30),
|
||||
maxActions: positiveInteger(capture.maxActions, "capture.maxActions", 500),
|
||||
...(capture.maxSessions === undefined ? {} : { maxSessions: positiveInteger(capture.maxSessions, "capture.maxSessions", 2) }),
|
||||
...(capture.baselineWaitMinutes === undefined ? {} : { baselineWaitMinutes: boundedInteger(capture.baselineWaitMinutes, "capture.baselineWaitMinutes", 0, 60) }),
|
||||
...(capture.repack === undefined ? {} : { repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack") }),
|
||||
appearance: parseAppearance(capture.appearance, "capture.appearance"),
|
||||
launch: parseLaunchSetting(capture.launch, "capture.launch"),
|
||||
@@ -560,6 +571,19 @@ export function captureRepack(config: ExploreConfig): "eas" | "local" {
|
||||
return config.capture.repack ?? (config.capture.simulator === "local" ? "local" : "eas");
|
||||
}
|
||||
|
||||
/**
|
||||
* The targets, in config order, whose captures repack the same app as `selected` on EAS: one platform, EAS profile and
|
||||
* bundle id. Their matrix jobs make one hosted repack per commit between them, led by the first (RepackShare); a target
|
||||
* no other one shares an app with gets just itself.
|
||||
*/
|
||||
export function hostedRepackPeers(config: ExploreConfig, selected: ExploreConfig, overrides: Parameters<typeof withRunOverrides>[1] = {}): string[] {
|
||||
if (captureRepack(selected) !== "eas" || !selected.target) return [];
|
||||
const sameApp = (other: ExploreConfig) => other.app.platform === selected.app.platform && other.app.easProfile === selected.app.easProfile
|
||||
&& other.app.bundleId === selected.app.bundleId && captureRepack(other) === "eas";
|
||||
return configTargets(config).filter(target => target.id === selected.target!.id || sameApp(withRunOverrides(resolveTargetConfig(config, { target: target.id }), overrides)))
|
||||
.map(target => target.id);
|
||||
}
|
||||
|
||||
const GITHUB_LOGIN = /^[A-Za-z0-9](?:[A-Za-z0-9]|-(?=[A-Za-z0-9])){0,38}(?:\[bot\])?$/;
|
||||
export const TRUSTED_AUTHORS_MAX = 20;
|
||||
|
||||
|
||||
@@ -178,7 +178,7 @@ export type SystemRegion = { kind: "status-bar" | "home-indicator"; x: number; y
|
||||
* EAS Simulator captures of both panels; the pill is the same 40×64 points on each, only its top differs. The app's own
|
||||
* rail controls start about 3% of the height below it on the outer panel, so the padding stays small.
|
||||
*/
|
||||
const DUO_PANELS = {
|
||||
export const DUO_PANELS = {
|
||||
outer: { width: 466, height: 678, statusBar: { x: 398, y: 87, width: 40, height: 64 } },
|
||||
inner: { width: 951, height: 669, statusBar: { x: 883, y: 34, width: 40, height: 64 } },
|
||||
} as const;
|
||||
@@ -251,6 +251,11 @@ export type PublicSurfaceReview = {
|
||||
description: string;
|
||||
/** Every deterministic accessibility fact for this surface, in reviewer priority order. */
|
||||
facts?: Array<{ category: string; templateId: string; bullet: string }>;
|
||||
/**
|
||||
* The screenshots match because the change is past the edge of the screen: every element its facts name reaches
|
||||
* beyond the captured screen. Only on a `modified` verdict whose screenshots match.
|
||||
*/
|
||||
offScreen?: true;
|
||||
};
|
||||
/** An evidence-bound explanation. It never changes a deterministic comparison verdict. */
|
||||
export type PublicChangeNote = {
|
||||
|
||||
@@ -57,6 +57,7 @@ function assertReviewFields(surface: Surface, enforceComparisonEvidence: boolean
|
||||
|| (["modified", "unchanged", "variant"].includes(review.status) && (!surface.base || !surface.head))
|
||||
|| (surface.sourceScope !== undefined && !["added", "removed"].includes(review.status)
|
||||
&& !SCOPE_VERDICTS[surface.sourceScope]?.includes(review.status))
|
||||
|| (review.offScreen !== undefined && (review.offScreen !== true || review.status !== "modified" || surface.visual?.verdict !== "unchanged"))
|
||||
|| (review.facts !== undefined && (!Array.isArray(review.facts) || review.facts.length > 100
|
||||
|| review.facts.some((fact) => !fact || typeof fact.category !== "string" || typeof fact.templateId !== "string"
|
||||
|| typeof fact.bullet !== "string" || !fact.bullet.trim() || fact.bullet.length > MAX_REVIEW_DESCRIPTION)))) {
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
import type { PublicReview } from "./capture.js";
|
||||
import { navigationCaptureContext } from "./navigation-graph.js";
|
||||
|
||||
type Surface = PublicReview["surfaces"][number];
|
||||
type Side = "base" | "head";
|
||||
|
||||
/** Navigation is route-level: a secondary-appearance surface (`<id>@<scheme>`) rides on its route's entry. */
|
||||
const SCHEME_SUFFIX = /@(light|dark)$/;
|
||||
const routeOf = (id: string): string => id.replace(SCHEME_SUFFIX, "");
|
||||
|
||||
/**
|
||||
* The surfaces a side planned to capture: every route in `all` mode, the changed routes and their navigation context in
|
||||
* `changes` mode. Undefined without navigation, which leaves no route outside the context.
|
||||
*/
|
||||
export function captureContext(review: PublicReview, side: Side): ReadonlySet<string> | undefined {
|
||||
const navigation = review.navigation?.[side];
|
||||
if (!navigation) return undefined;
|
||||
const inventory = review.surfaces.filter((surface) => surface[side]);
|
||||
const routes = new Map<string, NonNullable<Surface[Side]>>();
|
||||
for (const surface of inventory) {
|
||||
const id = routeOf(surface.id);
|
||||
if (!routes.has(id)) routes.set(id, { ...surface[side]!, id });
|
||||
}
|
||||
const selected = new Set(review.mode === "all" ? [...routes.keys()] : navigationCaptureContext(navigation,
|
||||
inventory.filter((surface) => surface.status !== "unchanged").map((surface) => routeOf(surface.id)),
|
||||
[...routes.values()]));
|
||||
return new Set(inventory.filter((surface) => selected.has(routeOf(surface.id))).map((surface) => surface.id));
|
||||
}
|
||||
|
||||
/** Both a screenshot of the planned route and a verified landing on it. */
|
||||
export function verifiedCapture(surface: Surface, side: Side): boolean {
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
return Boolean(surface[side]?.kind === "screen" && (side === "base" ? surface.baseImage : surface.headImage)
|
||||
&& outcome?.status === "captured" && outcome.landing === "verified");
|
||||
}
|
||||
|
||||
/**
|
||||
* Why a side that exists in its revision has no verified capture, as the report's capture gap: `accepted` when the run
|
||||
* left it uncaptured on purpose (a redirect declaration, a route named in `exploration.exclude`, or a route outside the
|
||||
* capture context), `open` for anything else, such as a capture that failed. Undefined for a verified capture or an
|
||||
* absent side. `context` is the side's `captureContext`.
|
||||
*/
|
||||
export function captureGap(review: PublicReview, surface: Surface, side: Side,
|
||||
context: ReadonlySet<string> | undefined): "accepted" | "open" | undefined {
|
||||
const entry = surface[side];
|
||||
if (!entry || verifiedCapture(surface, side)) return undefined;
|
||||
const image = side === "base" ? surface.baseImage : surface.headImage;
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
const outsideCaptureContext = review.mode === "changes" && context !== undefined && !context.has(surface.id);
|
||||
const deliberate = !image && !outcome && (entry.kind === "redirect" || surface.excluded === true || outsideCaptureContext
|
||||
|| (!review.navigation?.[side] && review.mode === "changes" && surface.status === "unchanged"));
|
||||
return deliberate ? "accepted" : "open";
|
||||
}
|
||||
|
||||
/**
|
||||
* The surfaces the run never captured on purpose: no screenshot of their own on either side, and every side that exists
|
||||
* left uncaptured deliberately (`captureGap` is `accepted`). None is one of the report's screens. The Viewer leaves them
|
||||
* out (viewer/src/utils/omitted-screens.ts reaches the same set from the map's gaps), and the PR comment skips them.
|
||||
* A side with an open gap, such as a failed capture, keeps the surface: its failure is part of the report.
|
||||
*/
|
||||
export function neverCapturedSurfaceIds(review: PublicReview): ReadonlySet<string> {
|
||||
// The Viewer refuses a review whose navigation names a route its inventory lacks; the comment still renders one,
|
||||
// without a capture context, so no route counts as outside it.
|
||||
const contextOf = (side: Side) => { try { return captureContext(review, side); } catch { return undefined; } };
|
||||
const contexts = { base: contextOf("base"), head: contextOf("head") };
|
||||
const omitted = new Set<string>();
|
||||
for (const surface of review.surfaces) {
|
||||
if (surface.baseImage || surface.headImage) continue;
|
||||
const gaps = (["base", "head"] as const).map((side) => captureGap(review, surface, side, contexts[side]));
|
||||
if (gaps.includes("accepted") && !gaps.includes("open")) omitted.add(surface.id);
|
||||
}
|
||||
return omitted;
|
||||
}
|
||||
+6
-2
@@ -6,6 +6,7 @@ import {
|
||||
type Observation,
|
||||
type Screen,
|
||||
} from "../types.js";
|
||||
import { accessibilityFingerprintsComparable } from "./store.js";
|
||||
|
||||
/**
|
||||
* Cross-run screen matching for PR-style comparisons (baseline = base branch map,
|
||||
@@ -253,7 +254,8 @@ function matchEntry(match: Match): { entry: BuildComparisonEntry; review: Compar
|
||||
// captured on both sides) hide a real change to the primary content.
|
||||
const baselineHash = match.baseline.representative.fingerprints.accessibility;
|
||||
const currentHash = match.current.representative.fingerprints.accessibility;
|
||||
const verdict = baselineHash && currentHash
|
||||
// Hashes from different fingerprint versions (an older Explore's map) say nothing about whether the trees differ.
|
||||
const verdict = baselineHash && currentHash && accessibilityFingerprintsComparable(baselineHash, currentHash)
|
||||
? (baselineHash === currentHash ? "unchanged" : "modified")
|
||||
: "unknown";
|
||||
const unchanged = verdict === "unchanged";
|
||||
@@ -262,7 +264,9 @@ function matchEntry(match: Match): { entry: BuildComparisonEntry; review: Compar
|
||||
? `Matched by ${signals}; the representative captures share an accessibility fingerprint, so the rendered tree is unchanged.`
|
||||
: verdict === "modified"
|
||||
? `Matched by ${signals}; the representative captures have different accessibility fingerprints, so the rendered tree changed.`
|
||||
: `Matched by ${signals}; accessibility fingerprints are unavailable on at least one side, so the change state could not be verified from fingerprints.`;
|
||||
: baselineHash && currentHash
|
||||
? `Matched by ${signals}; the representative captures were fingerprinted by different Explore versions, so the change state could not be verified from fingerprints.`
|
||||
: `Matched by ${signals}; accessibility fingerprints are unavailable on at least one side, so the change state could not be verified from fingerprints.`;
|
||||
const entry: BuildComparisonEntry = {
|
||||
id: `match-${match.current.screen.id}`,
|
||||
relationship: "one-to-one",
|
||||
|
||||
+23
-5
@@ -14,6 +14,7 @@ import { dirname, extname, isAbsolute, join, relative, resolve, sep } from "node
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { Ajv2020, type ErrorObject, type ValidateFunction } from "ajv/dist/2020.js";
|
||||
import { isSystemUiNode } from "../capture/controller-output.js";
|
||||
import { keyboardNodes } from "../capture/keyboard.js";
|
||||
import { validateNavigationGraph } from "../contracts/navigation-graph.js";
|
||||
import {
|
||||
CONTRACT,
|
||||
@@ -67,11 +68,26 @@ export const normalizeSelector = (input?: string): string | undefined => {
|
||||
return input.replace(/\s+/g, " ").trim() || undefined;
|
||||
};
|
||||
|
||||
const VOLATILE_SNAPSHOT_NODE_KEYS = new Set(["ref"]);
|
||||
/** A ref names a node within one read; which field has the focus can change between two reads of one screen. */
|
||||
const VOLATILE_SNAPSHOT_NODE_KEYS = new Set(["ref", "focused"]);
|
||||
|
||||
/**
|
||||
* The accessibility fingerprint's algorithm, written as its prefix. Version 2 leaves the system keyboard and the focus out
|
||||
* of the tree; a hash from before carries no prefix. Two fingerprints of different versions say nothing about whether the
|
||||
* trees differ, so a comparison treats them as not comparable rather than changed (see accessibilityFingerprintsComparable).
|
||||
*/
|
||||
const ACCESSIBILITY_FINGERPRINT_VERSION = "a2";
|
||||
|
||||
export function accessibilityFingerprintsComparable(left: string, right: string): boolean {
|
||||
const version = (hash: string) => /^(a\d+):/.exec(hash)?.[1] ?? "a1";
|
||||
return version(left) === version(right);
|
||||
}
|
||||
|
||||
/** Canonical JSON of the node tree only: controller wrappers carry per-session diagnostics and
|
||||
* ref generations that would otherwise make identical screens fingerprint differently, and Android
|
||||
* system UI nodes (status bar clock and signal, keyboard) change between emulator sessions. */
|
||||
* system UI nodes (status bar clock and signal, keyboard) change between emulator sessions. The
|
||||
* system keyboard on either platform is left out as the elements leave it out, so a keyboard up on
|
||||
* one side only does not make two captures of one screen differ. */
|
||||
function normalizeJsonSnapshotNodes(input: string): string | undefined {
|
||||
if (!/^\s*\{/.test(input)) return undefined;
|
||||
let value: unknown;
|
||||
@@ -86,10 +102,12 @@ function normalizeJsonSnapshotNodes(input: string): string | undefined {
|
||||
if (!data || typeof data !== "object" || !Array.isArray((data as { nodes?: unknown }).nodes)) {
|
||||
return undefined;
|
||||
}
|
||||
const nodes = (data as { nodes: unknown[] }).nodes;
|
||||
const keyboard: Set<unknown> = keyboardNodes(nodes.filter((entry): entry is Record<string, unknown> => !!entry && typeof entry === "object" && !Array.isArray(entry)));
|
||||
const canonical = (node: unknown): unknown => {
|
||||
if (Array.isArray(node)) {
|
||||
return node
|
||||
.filter((entry) => !(entry && typeof entry === "object" && isSystemUiNode(entry as Record<string, unknown>)))
|
||||
.filter((entry) => !(entry && typeof entry === "object" && (isSystemUiNode(entry as Record<string, unknown>) || keyboard.has(entry))))
|
||||
.map(canonical);
|
||||
}
|
||||
if (!node || typeof node !== "object") return node;
|
||||
@@ -100,7 +118,7 @@ function normalizeJsonSnapshotNodes(input: string): string | undefined {
|
||||
.map(([key, entry]) => [key, canonical(entry)]),
|
||||
);
|
||||
};
|
||||
return `nodes\0${JSON.stringify(canonical((data as { nodes: unknown[] }).nodes))}`;
|
||||
return `nodes\0${JSON.stringify(canonical(nodes))}`;
|
||||
}
|
||||
|
||||
export const normalizeSnapshot = (input: string): string =>
|
||||
@@ -118,7 +136,7 @@ export async function fingerprintState(options: {
|
||||
snapshotText?: string;
|
||||
}): Promise<ObservationFingerprints> {
|
||||
const accessibility = options.snapshotText
|
||||
? sha256(`snapshot\0${normalizeSnapshot(options.snapshotText)}`)
|
||||
? `${ACCESSIBILITY_FINGERPRINT_VERSION}:${sha256(`snapshot\0${normalizeSnapshot(options.snapshotText)}`)}`
|
||||
: undefined;
|
||||
const screenshot = options.screenshotPath ? await readFile(options.screenshotPath) : undefined;
|
||||
const visual = screenshot ? sha256(Buffer.concat([Buffer.from("visual\0"), screenshot])) : undefined;
|
||||
|
||||
+23
-8
@@ -254,24 +254,39 @@ function explorationScreenItem(context: AgentContext, map: Json, screen: Json):
|
||||
viewerUrl: ID.test(id) ? viewerUrl(context, { screen: id }) : undefined,
|
||||
});
|
||||
}
|
||||
function screenshotUrl(context: AgentContext, map: Json, screen: Json): string | undefined {
|
||||
/** The screenshot a screen is shown by: its latest observation's. */
|
||||
function screenshotArtifact(map: Json, screen: Json): Json | undefined {
|
||||
const observationId = strings(screen.observationIds).at(-1);
|
||||
const observation = arr(map.observations).map(rec).find(o => o.id === observationId);
|
||||
const artifact = arr(map.artifacts).map(rec).find(a => a.id === observation?.screenshotArtifactId);
|
||||
const sha = str(artifact?.sha256);
|
||||
return arr(map.artifacts).map(rec).find(a => a.id === observation?.screenshotArtifactId);
|
||||
}
|
||||
function screenshotUrl(context: AgentContext, map: Json, screen: Json): string | undefined {
|
||||
const sha = str(screenshotArtifact(map, screen)?.sha256);
|
||||
return sha && SHA256.test(sha) ? withPlatform(context, apiUrl(context, `/assets/${sha}`)) : undefined;
|
||||
}
|
||||
const elementItem = (element: Json): Json => defined({
|
||||
id: str(element.id ?? element.elementId), label: str(element.label), role: str(element.role), value: str(element.value), identifier: str(element.identifier),
|
||||
bounds: element.bounds === undefined ? undefined : rec(element.bounds), actions: strings(element.actions), risk: str(element.risk), actionable: bool(element.actionable), enabled: bool(element.enabled), visible: bool(element.visible),
|
||||
});
|
||||
/**
|
||||
* One element, its bounds on the axes of the screenshot it is listed beside. A screenshot stored turned a quarter
|
||||
* clockwise (an opened iPhone Duo's) is `turnedHeight` points tall on the tree's axes, where the map keeps the bounds:
|
||||
* there the portrait point (x, y) shows at (H - y, x).
|
||||
*/
|
||||
const elementItem = (element: Json, turnedHeight?: number): Json => {
|
||||
const bounds = element.bounds === undefined ? undefined : rec(element.bounds);
|
||||
const [x, y, width, height] = [num(bounds?.x), num(bounds?.y), num(bounds?.width), num(bounds?.height)];
|
||||
const shown = bounds && turnedHeight !== undefined && bounds.unit === "points" && x !== undefined && y !== undefined && width !== undefined && height !== undefined
|
||||
? { x: turnedHeight - y - height, y: x, width: height, height: width, unit: "points" } : bounds;
|
||||
return defined({
|
||||
id: str(element.id ?? element.elementId), label: str(element.label), role: str(element.role), value: str(element.value), identifier: str(element.identifier),
|
||||
bounds: shown, actions: strings(element.actions), risk: str(element.risk), actionable: bool(element.actionable), enabled: bool(element.enabled), visible: bool(element.visible),
|
||||
});
|
||||
};
|
||||
const transitionItem = (transition: Json): Json => defined({
|
||||
id: str(transition.id), from: str(transition.fromScreenId), to: str(transition.toScreenId), actionKind: str(transition.actionKind), elementId: str(transition.elementId), attempts: strings(transition.attemptIds).length,
|
||||
});
|
||||
function explorationScreenDetail(context: AgentContext, map: Json, screen: Json): Json {
|
||||
const id = str(screen.id);
|
||||
const transitions = arr(map.transitions).map(rec);
|
||||
const elements = arr(map.elements).map(rec).filter(element => element.screenId === id).map(elementItem);
|
||||
const turnedHeight = num(rec(screenshotArtifact(map, screen)?.turned).height);
|
||||
const elements = arr(map.elements).map(rec).filter(element => element.screenId === id).map(element => elementItem(element, turnedHeight));
|
||||
const variants = arr(map.variants).map(rec).filter(variant => variant.screenId === id).map(variant => defined({ id: str(variant.id), key: str(variant.key), name: str(variant.name), observations: strings(variant.observationIds).length }));
|
||||
const gaps = arr(map.gaps).map(rec).filter(gap => gap.screenId === id).map(gapItem);
|
||||
return defined({
|
||||
|
||||
+11
-3
@@ -8,6 +8,7 @@ import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPres
|
||||
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { upsertStickyComment } from "./pr-comment.js";
|
||||
import { retryGitHubLookup } from "./github-lookup.js";
|
||||
import { previewLinks, viewerLinks } from "./viewer-links.js";
|
||||
import type { PublicReview } from "../contracts/capture.js";
|
||||
import { CiError, toCiError } from "../shared/ci-errors.js";
|
||||
@@ -136,6 +137,8 @@ export async function publishCiReportComment(options: {
|
||||
preview?: { url: string; expiresAt: number | null };
|
||||
/** Set by `ci:deploy` when the hosted preview failed: the comment falls back to the central Viewer and the ZIP. */
|
||||
previewFailed?: boolean;
|
||||
/** Pause between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
|
||||
sleep?: (milliseconds: number) => Promise<void>;
|
||||
}) {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const input = await readInput(options.inputPath); const review = input.publicReview; const pr = review.pullRequest;
|
||||
@@ -186,16 +189,21 @@ export async function publishCiReportComment(options: {
|
||||
catch (error) { throw new CiError({ code: "GITHUB_RESPONSE_INVALID", stage: "publication",
|
||||
message: "GitHub returned invalid report metadata.", nextAction: "Rerun publication; if the response remains invalid, inspect the GitHub metadata request.", cause: error }); }
|
||||
};
|
||||
const artifact = await api(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
|
||||
// A lookup is made again when GitHub may answer it later: no answer, a 5xx, or a 404 from the Actions API, which may
|
||||
// not list a just-uploaded artifact yet. A bad token, a missing permission or a rate limit fails at once, as before.
|
||||
const lookup = (path: string) => retryGitHubLookup(() => api(path), error => error instanceof CiError
|
||||
&& (error.code === "GITHUB_NETWORK_FAILED" || error.code === "GITHUB_REQUEST_FAILED" && error.retryable
|
||||
|| error.code === "GITHUB_RESOURCE_NOT_FOUND" && path.startsWith("actions/")), options.sleep);
|
||||
const artifact = await lookup(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
|
||||
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${target ? `-${target}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
|
||||
throw new CiError({ code: artifact.expired ? "REPORT_ARTIFACT_EXPIRED" : "REPORT_ARTIFACT_MISMATCH", stage: "publication",
|
||||
message: "The uploaded report artifact is unavailable or belongs to another run",
|
||||
nextAction: artifact.expired ? "Rerun Explore to upload a fresh report artifact." : "Pass the final report artifact from this workflow run and attempt." });
|
||||
}
|
||||
const attempt = await api(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
|
||||
const attempt = await lookup(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
|
||||
if (String(attempt.id) !== review.runId || String(attempt.run_attempt) !== review.runAttempt) throw new CiError({ code: "REPORT_RUN_MISMATCH", stage: "publication",
|
||||
message: "Report run attempt mismatch", nextAction: "Publish the artifact and report input from the same current workflow attempt." });
|
||||
const current = await api(`pulls/${pr.number}`);
|
||||
const current = await lookup(`pulls/${pr.number}`);
|
||||
if (current.state !== "open" || current.head?.repo?.full_name !== pr.repository || current.head?.ref !== pr.head.ref) {
|
||||
throw new CiError({ code: "PR_CHANGED", stage: "publication", message: "PR closed or changed branches before the report artifact was ready",
|
||||
nextAction: "Run Explore for the current PR head and base before publishing a ready report." });
|
||||
|
||||
@@ -15,7 +15,7 @@ export type FailureCommentOptions = {
|
||||
runAttempt: string;
|
||||
/** The directory the failure job downloaded diagnostics artifacts into (`<stage>/<artifact>/…/error.json`). */
|
||||
diagnosticsPath?: string;
|
||||
/** The failed target's id; otherwise the one the first diagnostics artifact's name carries. */
|
||||
/** The failed target's id; otherwise every target the diagnostics artifacts name. */
|
||||
target?: string;
|
||||
/** What callers from before targets pass: a platform is the id of its default target. */
|
||||
platform?: ExplorePlatform;
|
||||
@@ -25,6 +25,8 @@ export type FailureCommentOptions = {
|
||||
};
|
||||
|
||||
type Diagnostic = { code: string; stage: string; message: string; nextAction: string };
|
||||
/** A failed target's diagnostic. `target` is absent when neither the artifact's name nor the file names one. */
|
||||
export type LocatedFailure = { diagnostic?: Diagnostic; target?: string; platform?: ExplorePlatform };
|
||||
const SHA = /^[0-9a-f]{40}$/;
|
||||
// `explore-<kind>-<run>-<attempt>-<target>`: the kind has no digits, so the first number is the run and the rest is the target id.
|
||||
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
|
||||
@@ -34,11 +36,14 @@ const MAX_DIAGNOSTIC_BYTES = 32_768;
|
||||
const CODE = /^[A-Z][A-Z0-9_]{1,63}$/;
|
||||
const STAGE = /^[a-z][a-z0-9-]{0,63}$/;
|
||||
|
||||
function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
|
||||
function parseJson(text: string): Record<string, unknown> | undefined {
|
||||
let parsed: unknown;
|
||||
try { parsed = JSON.parse(text); } catch { return undefined; }
|
||||
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return undefined;
|
||||
const value = parsed as Record<string, unknown>;
|
||||
return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed as Record<string, unknown> : undefined;
|
||||
}
|
||||
|
||||
function parseDiagnostic(value: Record<string, unknown> | undefined, stage: string): Diagnostic | undefined {
|
||||
if (!value) return undefined;
|
||||
const field = (name: string, max: number) => typeof value[name] === "string" && (value[name] as string).trim() && (value[name] as string).length <= max ? value[name] as string : undefined;
|
||||
const code = field("code", 64), message = field("message", 4000), nextAction = field("nextAction", 4000), stageName = field("stage", 64) ?? stage;
|
||||
if (!code || !CODE.test(code) || !message || !nextAction || !STAGE.test(stageName)) return undefined;
|
||||
@@ -46,32 +51,51 @@ function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
|
||||
return { code, stage: stageName, message, nextAction };
|
||||
}
|
||||
|
||||
/** Reads one error.json; `named` is the target its artifact directory names, else the one the file records. */
|
||||
async function readFailure(path: string, stage: string, named: string | undefined): Promise<LocatedFailure | undefined> {
|
||||
const info = await lstat(path).catch(() => undefined);
|
||||
if (!info) return undefined;
|
||||
const located = (target: string | undefined): LocatedFailure => ({ ...(target ? { target } : {}), ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) });
|
||||
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located(named);
|
||||
const value = parseJson(await readFile(path, "utf8"));
|
||||
const target = named ?? (isTargetId(value?.target) ? value.target : undefined);
|
||||
const diagnostic = parseDiagnostic(value, stage);
|
||||
return diagnostic ? { diagnostic, ...located(target) } : located(target);
|
||||
}
|
||||
|
||||
/**
|
||||
* The error.json a failed job left behind and the target its artifact name carries (`ios` or `android` for a config
|
||||
* without targets, and for artifacts of versions before targets). A report failure's diagnostic takes precedence over
|
||||
* capture's; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
|
||||
* Every failed target's error.json and the target it belongs to (`ios` or `android` for a config without targets, and
|
||||
* for artifacts of versions before targets). actions/download-artifact puts each artifact a pattern matches in a
|
||||
* directory named after it, except when the pattern matches exactly one: that one lands in the stage's directory
|
||||
* itself, and the file names its target. A report failure's diagnostic takes precedence over its target's capture
|
||||
* diagnostic; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
|
||||
* regular files count (never symlinks out of the artifact). `platform` is set when the target id is a platform's.
|
||||
*/
|
||||
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; target: string; platform?: ExplorePlatform } | undefined> {
|
||||
export async function locateFailureDiagnostics(root: string): Promise<LocatedFailure[]> {
|
||||
const failures: LocatedFailure[] = [];
|
||||
const seen = new Set<string>();
|
||||
for (const [stage, file] of [["report", "error.json"], ["capture", join("explore-diagnostics", "error.json")]] as const) {
|
||||
const entries = await readdir(join(root, stage), { withFileTypes: true }).catch(() => []);
|
||||
for (const entry of entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
|
||||
const path = join(root, stage, entry.name, file);
|
||||
const info = await lstat(path).catch(() => undefined);
|
||||
if (!info) continue;
|
||||
const target = artifactTarget(entry.name)!;
|
||||
const located: { target: string; platform?: ExplorePlatform } = { target, ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) };
|
||||
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located;
|
||||
const diagnostic = parseDiagnostic(await readFile(path, "utf8"), stage);
|
||||
return diagnostic ? { diagnostic, ...located } : located;
|
||||
const candidates = [...entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))
|
||||
.map(entry => ({ path: join(root, stage, entry.name, file), named: artifactTarget(entry.name) })), { path: join(root, stage, file), named: undefined }];
|
||||
for (const { path, named } of candidates) {
|
||||
const located = await readFailure(path, stage, named);
|
||||
if (!located || seen.has(located.target ?? "")) continue;
|
||||
seen.add(located.target ?? "");
|
||||
failures.push(located);
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
return failures;
|
||||
}
|
||||
|
||||
/** The first failure locateFailureDiagnostics finds: a report failure before a capture failure. */
|
||||
export async function locateFailureDiagnostic(root: string): Promise<LocatedFailure | undefined> {
|
||||
return (await locateFailureDiagnostics(root))[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* The failure job's comment: a job died outside Explore's own progress comments (install, checkout, a crash
|
||||
* before the pipeline posted), so the sticky comment gets a failed record for that target from the same
|
||||
* before the pipeline posted), so the sticky comment gets a failed record for each failed target from the same
|
||||
* renderer every other writer uses. Nothing is posted when the PR is closed; a PR that moved on is marked
|
||||
* superseded so the failure lands under previous runs.
|
||||
*/
|
||||
@@ -94,27 +118,31 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
|
||||
return { posted: false, reason: "The PR is no longer an open same-repository PR." };
|
||||
}
|
||||
const superseded = pr.head?.sha !== options.headSha || pr.base?.sha !== options.baseSha;
|
||||
const located = options.diagnosticsPath ? await locateFailureDiagnostic(options.diagnosticsPath) : undefined;
|
||||
const target = requested ?? located?.target;
|
||||
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
|
||||
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
|
||||
const configPath = options.configPath ?? ".expo-explore/config.yaml";
|
||||
const now = Date.now();
|
||||
const diagnostic = located?.diagnostic;
|
||||
const state: PublicCommentState = {
|
||||
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
|
||||
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
|
||||
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
|
||||
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
|
||||
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
|
||||
startedAt: now, updatedAt: now, artifactOnly: true,
|
||||
...(platform ? { build: { platform, easProfile: "" } } : {}),
|
||||
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
|
||||
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
|
||||
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
|
||||
...(superseded ? { superseded: true } : {}),
|
||||
};
|
||||
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
|
||||
...platformSectionMerge(state, target), token, fetchImpl: transport });
|
||||
const located = options.diagnosticsPath ? await locateFailureDiagnostics(options.diagnosticsPath) : [];
|
||||
// Each failed target gets its own failed record: since one target's failed capture no longer stops the others'
|
||||
// reports (brentvatne/euxy#172), several targets of one run can fail in different jobs.
|
||||
const failures: LocatedFailure[] = requested !== undefined ? [{ ...(located.find(failure => failure.target === requested) ?? located[0]), target: requested }]
|
||||
: located.length ? located : [{}];
|
||||
for (const { target, diagnostic } of failures) {
|
||||
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
|
||||
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
|
||||
const configPath = options.configPath ?? ".expo-explore/config.yaml";
|
||||
const now = Date.now();
|
||||
const state: PublicCommentState = {
|
||||
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
|
||||
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
|
||||
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
|
||||
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
|
||||
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
|
||||
startedAt: now, updatedAt: now, artifactOnly: true,
|
||||
...(platform ? { build: { platform, easProfile: "" } } : {}),
|
||||
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
|
||||
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
|
||||
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
|
||||
...(superseded ? { superseded: true } : {}),
|
||||
};
|
||||
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
|
||||
...platformSectionMerge(state, target), token, fetchImpl: transport });
|
||||
}
|
||||
return { posted: true, ...(superseded ? { superseded: true } : {}) };
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* Pauses between attempts of a GitHub lookup that may succeed later, 45 seconds in all. GitHub's Actions API is
|
||||
* eventually consistent just after an upload: in brentvatne/euxy's review run 39348956443, the duo-closed report job's
|
||||
* `actions/artifacts/<id>` answered 404 for the artifact that job had just uploaded, while the other four targets'
|
||||
* jobs found theirs.
|
||||
*/
|
||||
const GITHUB_LOOKUP_RETRY_DELAYS_MS = [3_000, 6_000, 12_000, 24_000] as const;
|
||||
|
||||
/**
|
||||
* Runs a read-only GitHub lookup again after each pause while `transient` says its failure may clear on its own. The
|
||||
* caller decides what is transient; any other failure, or the last one, is thrown as it is.
|
||||
*/
|
||||
export async function retryGitHubLookup<T>(lookup: () => Promise<T>, transient: (error: unknown) => boolean,
|
||||
sleep: (milliseconds: number) => Promise<void> = milliseconds => new Promise<void>(done => setTimeout(done, milliseconds))): Promise<T> {
|
||||
for (let retry = 0; ; retry += 1) {
|
||||
try { return await lookup(); }
|
||||
catch (error) {
|
||||
const delayMs = GITHUB_LOOKUP_RETRY_DELAYS_MS[retry];
|
||||
if (delayMs === undefined || !transient(error)) throw error;
|
||||
// A lookup that succeeds later would otherwise leave no trace of the failure in the job log.
|
||||
process.stderr.write(`GitHub lookup failed (${(error instanceof Error ? error.message : String(error)).split("\n", 1)[0]}); trying again in ${delayMs / 1000} s\n`);
|
||||
await sleep(delayMs);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import { CI_COMMENT_MARKER } from "./pr-comment.js";
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedPrevious, orderedRecords, previousLine, readCommentRecords, recordLabel, recordLine, recordSummary,
|
||||
type ChangeGroup, type CommentNavigation, type CommentTarget, type CommentRecords, type HistoryEntry, type NavigationGroup, type NavigationKind, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
|
||||
import { neverCapturedSurfaceIds } from "../contracts/surface-capture.js";
|
||||
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
|
||||
import type { ReviewPresentation } from "../contracts/review.js";
|
||||
import type { ViewerLinks } from "./viewer-links.js";
|
||||
@@ -142,6 +143,16 @@ function notComparedChange(surface: Surface): boolean {
|
||||
return verified && (!surface.review || surface.visual?.reason === "diff-failed");
|
||||
}
|
||||
|
||||
/**
|
||||
* An accessibility-only change whose elements lie past the edge of the screen (the review's `offScreen`), so another
|
||||
* target's row can say the change is there, off-screen, rather than missing. Like notComparedChange, a comparison that
|
||||
* failed or a redirect is not one.
|
||||
*/
|
||||
function offScreenChange(surface: Surface): boolean {
|
||||
return surface.review?.offScreen === true && isAccessibilityOnlyChange(surface) && surface.visual?.reason !== "diff-failed"
|
||||
&& (surface.head ?? surface.base)?.kind !== "redirect";
|
||||
}
|
||||
|
||||
function routeOf(surface: Surface): string {
|
||||
return plainText(surface.head?.route || surface.base?.route || surface.id, MAX_ROUTE_LENGTH);
|
||||
}
|
||||
@@ -294,12 +305,15 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
|
||||
if (state.review) {
|
||||
const evidenceBased = state.review.surfaces.some(surface => surface.review);
|
||||
record.changes = [];
|
||||
// A route the run never captured on purpose is not one of the report's screens, here as in the Viewer.
|
||||
const omitted = neverCapturedSurfaceIds(state.review);
|
||||
for (const surface of state.review.surfaces) {
|
||||
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
|
||||
if (omitted.has(surface.id)) continue;
|
||||
const group = groupOf(surface, evidenceBased);
|
||||
if (group === "unlisted") continue;
|
||||
const scheme = schemeOf(surface.id);
|
||||
record.changes.push({ id: surface.id, route: routeOf(surface), group, description: descriptionOf(surface, group), ...(scheme ? { scheme } : {}) });
|
||||
record.changes.push({ id: surface.id, route: routeOf(surface), group, description: descriptionOf(surface, group), ...(scheme ? { scheme } : {}),
|
||||
...(group === "accessibility-only" && offScreenChange(surface) ? { offScreen: true as const } : {}) });
|
||||
}
|
||||
const navigation = state.map ? navigationOf(state.review, new Map(record.changes.map(change => [change.id, change.group]))) : undefined;
|
||||
if (navigation) record.navigation = navigation;
|
||||
@@ -348,9 +362,10 @@ function navigationOf(review: PublicReview, groups: Map<string, ChangeGroup>): C
|
||||
if (!review.navigation) return undefined;
|
||||
const keyOf = new Map<string, string>();
|
||||
const groupOf = new Map<string, NavigationGroup>();
|
||||
const omitted = neverCapturedSurfaceIds(review);
|
||||
for (const surface of review.surfaces) {
|
||||
const route = surface.head ?? surface.base;
|
||||
if (!route || route.kind === "redirect") continue;
|
||||
if (!route || omitted.has(surface.id)) continue;
|
||||
const key = routePattern(route);
|
||||
keyOf.set(surface.id.replace(/@(light|dark)$/, ""), key);
|
||||
const group = groups.get(surface.id);
|
||||
@@ -558,10 +573,24 @@ function renderChangeRow(row: ChangeRow, ready: PlatformRecord[]): string {
|
||||
text = `${route} · ${description}`;
|
||||
}
|
||||
const tag = row.group === "accessibility-only" ? "accessibility only" : row.group === "needs-review" ? "needs review" : undefined;
|
||||
return `- ${[text, tag, ...whereNote(row, ready)].filter(Boolean).join(" · ")}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Where a screen's change shows. A target whose screenshots match because the changed elements lie past the edge of the
|
||||
* screen has the change, off-screen, so it is named apart: "iPhone 17, Android only · off-screen on iPhone Duo (closed)"
|
||||
* for Tempo's footnote below the fold of its sheet in brentvatne/euxy#172 (review run 39362642343). The targets that show
|
||||
* it are still named the shorter way among the others (none when all of them do); without such a target the note is what
|
||||
* it always was.
|
||||
*/
|
||||
function whereNote(row: ChangeRow, ready: PlatformRecord[]): string[] {
|
||||
const offScreen = row.group === "modified"
|
||||
? row.targets.filter(record => record.changes?.some(change => change.id === row.id && change.offScreen === true)) : [];
|
||||
const shown = row.targets.filter(record => !offScreen.includes(record));
|
||||
// A target with screens it has no verdict on may have changed this one too: name where it changed, not where it did not.
|
||||
const where = ready.some(record => !row.targets.includes(record) && gaps(record).length)
|
||||
? `on ${row.targets.map(labelOf).join(", ")}` : targetsNote(row.targets, ready);
|
||||
return `- ${[text, tag, where].filter(Boolean).join(" · ")}`;
|
||||
const unsure = ready.some(record => !row.targets.includes(record) && gaps(record).length);
|
||||
const visible = unsure ? `on ${shown.map(labelOf).join(", ")}` : targetsNote(shown, ready.filter(record => !offScreen.includes(record)));
|
||||
return [visible, offScreen.length ? `off-screen on ${offScreen.map(labelOf).join(", ")}` : undefined].filter((part): part is string => Boolean(part));
|
||||
}
|
||||
|
||||
/** "Android only" / "not on Android": the targets a screen changed on, when not all of them, named the shorter way. */
|
||||
@@ -718,8 +747,9 @@ export function reviewDevice(state: { runtime?: Pick<SimulatorRuntimeMetadata, "
|
||||
export function reviewChanges(review: PublicReview): Map<string, ChangeGroup> {
|
||||
const evidenceBased = review.surfaces.some(surface => surface.review);
|
||||
const changes = new Map<string, ChangeGroup>();
|
||||
const omitted = neverCapturedSurfaceIds(review);
|
||||
for (const surface of review.surfaces) {
|
||||
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
|
||||
if (omitted.has(surface.id)) continue;
|
||||
const group = groupOf(surface, evidenceBased);
|
||||
if (group !== "unlisted") changes.set(surface.id, group);
|
||||
}
|
||||
|
||||
@@ -103,8 +103,11 @@ export type PlatformRecord = {
|
||||
accessibility?: { compared: number; described: number; failed: number };
|
||||
routes?: number;
|
||||
};
|
||||
/** The review's changed surfaces, one per surface; `scheme` for a secondary appearance (`<route>@<scheme>`). */
|
||||
changes?: { id: string; route: string; group: ChangeGroup; description: string; scheme?: string }[];
|
||||
/**
|
||||
* The review's changed surfaces, one per surface; `scheme` for a secondary appearance (`<route>@<scheme>`). `offScreen`
|
||||
* marks an accessibility-only change whose elements lie past the edge of the screen.
|
||||
*/
|
||||
changes?: { id: string; route: string; group: ChangeGroup; description: string; scheme?: string; offScreen?: true }[];
|
||||
/** Screens whose source changed and whose captures were verified, but that got no verdict: the comparison did not run or failed. */
|
||||
notCompared?: number;
|
||||
/** Differences stated once rather than per screen (variants, app-wide source changes). */
|
||||
@@ -270,7 +273,8 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
|
||||
if (Array.isArray(value.changes)) {
|
||||
const changes = value.changes.flatMap((entry): NonNullable<PlatformRecord["changes"]> => isRecord(entry) && isString(entry.id, 220) && isString(entry.route, 2000)
|
||||
&& CHANGE_GROUPS.includes(entry.group as ChangeGroup) && isString(entry.description, 2000)
|
||||
? [{ id: entry.id, route: entry.route, group: entry.group as ChangeGroup, description: entry.description, ...(isString(entry.scheme, 20) ? { scheme: entry.scheme } : {}) }] : []);
|
||||
? [{ id: entry.id, route: entry.route, group: entry.group as ChangeGroup, description: entry.description, ...(isString(entry.scheme, 20) ? { scheme: entry.scheme } : {}),
|
||||
...(entry.offScreen === true && entry.group === "accessibility-only" ? { offScreen: true as const } : {}) }] : []);
|
||||
if (changes.length <= 2000) record.changes = changes;
|
||||
}
|
||||
const navigation = parseNavigation(value.navigation);
|
||||
|
||||
@@ -7,6 +7,7 @@ import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from "@zip.j
|
||||
import { loadReport, MAX_METADATA_BYTES } from "./agent-api.js";
|
||||
import { MAX_ASSET_BYTES, manifestBody, PREVIEW_ASSET } from "./preview-manifest.js";
|
||||
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
|
||||
import { retryGitHubLookup } from "./github-lookup.js";
|
||||
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
|
||||
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
|
||||
import { isTargetId, warnIgnoredExpiry, type ExplorePlatform } from "../config/explore-config.js";
|
||||
@@ -54,7 +55,7 @@ export type PreviewDeployOptions = (PreviewReportInput | {
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
transport?: typeof fetch;
|
||||
run?: CommandRunner;
|
||||
/** Pause between `eas deploy` attempts; tests replace it so retries take no real time. */
|
||||
/** Pause between `eas deploy` attempts and between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
|
||||
sleep?: (milliseconds: number) => Promise<void>;
|
||||
/** The preview export (client/ and server/); defaults to the one shipped in this package. */
|
||||
exportPath?: string;
|
||||
@@ -386,7 +387,7 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
if (pr.origin !== "compare") for (const report of reports) {
|
||||
try {
|
||||
await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
|
||||
...commentTarget(report), previewFailed: true });
|
||||
...commentTarget(report), previewFailed: true, ...(options.sleep ? { sleep: options.sleep } : {}) });
|
||||
} catch { /* the deployment failure is the one to report */ }
|
||||
}
|
||||
throw error;
|
||||
@@ -398,7 +399,7 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
let headSha = pr.head.sha;
|
||||
if (pr.origin !== "compare") for (const report of reports) {
|
||||
const published = await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
|
||||
...commentTarget(report), preview: { url: previewUrl, expiresAt: null } });
|
||||
...commentTarget(report), preview: { url: previewUrl, expiresAt: null }, ...(options.sleep ? { sleep: options.sleep } : {}) });
|
||||
headSha = published.headSha;
|
||||
}
|
||||
return { previewUrl, expiresAt: null, deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
|
||||
@@ -435,7 +436,9 @@ async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: C
|
||||
}
|
||||
|
||||
type HostedReportInput = { zip: Uint8Array; sha256: string; file: string; query: string };
|
||||
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string; project: string; owner: string };
|
||||
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string;
|
||||
/** The link is the alias, which still served an earlier deployment when the wait for it ran out. */
|
||||
aliasBehind?: true; project: string; owner: string };
|
||||
|
||||
/** EAS Hosting alias names: lowercase slugs, as `eas deploy --alias` normalises them. */
|
||||
export const HOSTING_ALIAS = /^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$/;
|
||||
@@ -495,6 +498,13 @@ async function deployReports(options: {
|
||||
alias?: string;
|
||||
/** A caller-chosen `/p/<token>`; with `alias`, the hosted link is identical from one run to the next. */
|
||||
token?: string;
|
||||
/** How long the alias has to serve this deployment once the deployment does; `verifyTimeoutMs` by default. */
|
||||
aliasWaitMs?: number;
|
||||
/**
|
||||
* Link the alias even when it still serves an earlier deployment after `aliasWaitMs`, for a link whose readers are
|
||||
* told it can lag, rather than the deployment's own host.
|
||||
*/
|
||||
linkBehindAlias?: boolean;
|
||||
sleep?: (milliseconds: number) => Promise<void>;
|
||||
}): Promise<HostedDeployment> {
|
||||
const { reports, project, environment, run, transport, now, random } = options;
|
||||
@@ -571,7 +581,8 @@ async function deployReports(options: {
|
||||
throw deployError("PREVIEW_DEPLOY_FAILED", `EAS Hosting deployed ${deploymentUrl.origin} but did not report the alias ${options.alias}.`,
|
||||
"Check the deployment's aliases in the EAS Hosting dashboard and rerun.", { retryable: true, details: { project, owner, alias: options.alias } });
|
||||
}
|
||||
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, timeoutMs: options.verifyTimeoutMs, alias,
|
||||
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, alias,
|
||||
timeoutMs: alias ? options.aliasWaitMs ?? options.verifyTimeoutMs : options.verifyTimeoutMs,
|
||||
reports: reports.map((report, index) => ({ query: report.query, ...written[index]! })),
|
||||
...(listing ? { listing: JSON.stringify(listing.map(({ path: _path, ...rest }) => rest)) } : {}) });
|
||||
const seconds = (milliseconds: number) => `${Math.round(milliseconds / 1000)} s after eas deploy returned`;
|
||||
@@ -581,7 +592,9 @@ async function deployReports(options: {
|
||||
// taken longer than the whole budget (every verification failure of 2026-10-14 was the alias, with the deployment
|
||||
// serving in 1 s). The deployment is verified and immutable, so when the alias is still behind the pull request
|
||||
// links the deployment instead of failing the job; the alias catches up on its own and the next push relinks it.
|
||||
// With `linkBehindAlias` it links the alias anyway, and its readers are told the link can lag.
|
||||
let linkOrigin = deploymentUrl.origin;
|
||||
let aliasBehind = false;
|
||||
if (aliasUrl) {
|
||||
try {
|
||||
const alias = await verify(aliasUrl.origin, true);
|
||||
@@ -589,12 +602,16 @@ async function deployReports(options: {
|
||||
linkOrigin = aliasUrl.origin;
|
||||
} catch (error) {
|
||||
if ((error as { code?: string }).code !== "PREVIEW_ALIAS_BEHIND") throw error;
|
||||
process.stderr.write(`::warning::${(error as Error).message} The pull request links the deployment ${deploymentUrl.origin} instead.\n`);
|
||||
aliasBehind = Boolean(options.linkBehindAlias);
|
||||
if (aliasBehind) linkOrigin = aliasUrl.origin;
|
||||
process.stderr.write(`::warning::${(error as Error).message} ${aliasBehind
|
||||
? `The pull request links it anyway, until it catches up, beside the deployment ${deploymentUrl.origin}.`
|
||||
: `The pull request links the deployment ${deploymentUrl.origin} instead.`}\n`);
|
||||
}
|
||||
}
|
||||
const previewUrl = `${linkOrigin}/p/${token}`;
|
||||
return { previewUrl, expiresAt: null, deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
|
||||
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), project, owner };
|
||||
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), ...(aliasBehind ? { aliasBehind: true as const } : {}), project, owner };
|
||||
} finally {
|
||||
await rm(work, { recursive: true, force: true });
|
||||
}
|
||||
@@ -668,8 +685,20 @@ export type FixturePreviewOptions = {
|
||||
random?: (bytes: number) => Uint8Array;
|
||||
onSecret?: (secret: string) => void;
|
||||
verifyTimeoutMs?: number;
|
||||
/** How long the alias has to serve the new deployment before the link is the alias anyway; FIXTURE_ALIAS_WAIT_MS by default. */
|
||||
aliasWaitMs?: number;
|
||||
};
|
||||
|
||||
/**
|
||||
* How long a fixture preview waits for its alias. An edge of EAS Hosting that served an alias keeps serving the
|
||||
* deployment it named for about five minutes (307–314 s, measured 2026-10-19 redeploying back to back from one machine),
|
||||
* so a deploy whose check reaches an edge that served the alias in the last five minutes, to the previous deploy's check
|
||||
* or to a reviewer, finds it behind; otherwise it has moved within seconds. Waiting the whole verification budget for
|
||||
* that held a third of the pull requests' deploy jobs for three minutes, only to link the deployment instead. The pull
|
||||
* request's comment says when the alias is behind.
|
||||
*/
|
||||
export const FIXTURE_ALIAS_WAIT_MS = 20_000;
|
||||
|
||||
/**
|
||||
* Host fixed reports behind a fixed alias with this checkout's Viewer: the Explore repository's own pull requests
|
||||
* preview their Viewer changes on real data. No GitHub token, no expiry; each run replaces what the alias serves.
|
||||
@@ -697,6 +726,7 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
|
||||
projectHint: "Give EXPO_TOKEN's account permission to create projects, or pass --project with an existing slug.",
|
||||
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
|
||||
...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000, alias: options.alias,
|
||||
aliasWaitMs: options.aliasWaitMs ?? FIXTURE_ALIAS_WAIT_MS, linkBehindAlias: true,
|
||||
...(options.token ? { token: options.token } : {}) });
|
||||
}
|
||||
|
||||
@@ -760,23 +790,43 @@ export async function deployLocalReports(options: {
|
||||
/** explore-(capture|review)-<run>-<attempt>-<target id>; the id starts with a letter, so the run and attempt end unambiguously. */
|
||||
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
|
||||
|
||||
/**
|
||||
* The target a lone artifact holds. actions/download-artifact puts each artifact a pattern matches in a directory named
|
||||
* after it, except when the pattern matches exactly one, which it extracts into the download path itself: then only the
|
||||
* report names its target (its platform for configs without targets).
|
||||
*/
|
||||
async function unnamedArtifactTarget(root: string, kind: "capture" | "review"): Promise<string | undefined> {
|
||||
const file = join(root, kind === "capture" ? "report-input.json" : "review.json");
|
||||
if (!(await lstat(file).catch(() => undefined))?.isFile()) return undefined;
|
||||
const runtime = kind === "capture" ? (await readCiReportInput(file)).publicReview.runtime
|
||||
: (JSON.parse(await readFile(file, "utf8")) as Partial<ArtifactReport>).review?.runtime;
|
||||
const id = readTarget(runtime?.target)?.id ?? runtime?.platform;
|
||||
return isTargetId(id) ? id : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<target>
|
||||
* directory under --inputs and each explore-review-… directory under --reports (the target is the platform for
|
||||
* configs without targets). Pairs them by target, in the order the run's review lists its targets, and looks up each
|
||||
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
|
||||
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward. A target whose capture
|
||||
* failed uploaded no capture artifact, and one whose report job failed no report artifact: the preview serves the
|
||||
* targets that have both, and the review workflow's failure job names the others on the comment.
|
||||
*/
|
||||
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch }): Promise<PreviewReportInput[]> {
|
||||
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
|
||||
/** Pause between artifact lookups that may succeed later; tests replace it so retries take no real time. */
|
||||
sleep?: (milliseconds: number) => Promise<void> }): Promise<PreviewReportInput[]> {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const directories = async (root: string, kind: "capture" | "review") => {
|
||||
const found = new Map<string, string>();
|
||||
for (const name of (await readdir(root)).sort()) {
|
||||
// A pattern that matched nothing leaves no directory behind.
|
||||
for (const name of (await readdir(root).catch(() => [] as string[])).sort()) {
|
||||
const match = ARTIFACT_DIRECTORY.exec(name);
|
||||
if (!match || match[1] !== kind || !isTargetId(match[2])) continue;
|
||||
if (found.has(match[2]!)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
|
||||
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
|
||||
found.set(match[2]!, join(root, name));
|
||||
}
|
||||
if (!found.size) { const id = await unnamedArtifactTarget(root, kind); if (id) found.set(id, root); }
|
||||
return found;
|
||||
};
|
||||
const inputs = await directories(options.inputsPath, "capture"); const reports = await directories(options.reportsPath, "review");
|
||||
@@ -787,8 +837,9 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
|
||||
const entries: PreviewReportInput[] = [];
|
||||
for (const [id, inputDirectory] of inputs) {
|
||||
const reportPath = reports.get(id);
|
||||
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${id} capture has no report artifact to deploy`,
|
||||
"Rerun the workflow; the report job for that target did not upload its explore-review artifact.");
|
||||
// In brentvatne/euxy#172 (review run 39348956443) one target's failed job kept every other target's report off the
|
||||
// PR; a target without a report is left out of the preview instead.
|
||||
if (!reportPath) { process.stderr.write(`The ${id} capture has no report artifact (its report job failed), so the preview leaves it out.\n`); continue; }
|
||||
const inputPath = join(inputDirectory, "report-input.json");
|
||||
const runtime = (await readCiReportInput(inputPath)).publicReview.runtime;
|
||||
// A report from before targets names only its platform, and its artifact is named after it.
|
||||
@@ -798,6 +849,8 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
|
||||
const target = named ?? (id === "ios" || id === "android" ? platformTarget(id) : { id, platform: runtime.platform ?? "ios", label: id });
|
||||
entries.push({ ...(id === target.platform ? { platform: target.platform } : {}), target, inputPath, reportPath, artifactUrl: "" });
|
||||
}
|
||||
if (!entries.length) throw previewError("PREVIEW_REPORTS_INCOMPLETE", "No target's capture has a report artifact to deploy",
|
||||
"Rerun the workflow; the report jobs did not upload their explore-review artifacts.");
|
||||
// Config order, as the review lists its targets (or, before targets, its platforms); directory order otherwise.
|
||||
const listed = (await readCiReportInput(entries[0]!.inputPath)).publicReview.runtime;
|
||||
const order: string[] = listed.targets?.map(target => target.id) ?? listed.platforms ?? [];
|
||||
@@ -812,14 +865,22 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
|
||||
for (const entry of entries) {
|
||||
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.target!.id}`;
|
||||
const url = `https://api.github.com/repos/${repository}/actions/runs/${review.runId}/artifacts?per_page=100&name=${encodeURIComponent(name)}`;
|
||||
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
|
||||
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
|
||||
const body = response.ok ? await response.json() as { artifacts?: Array<{ id?: unknown; name?: unknown; expired?: unknown }> } : undefined;
|
||||
const artifact = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
|
||||
if (!artifact || typeof artifact.id !== "number" || !Number.isSafeInteger(artifact.id) || artifact.id <= 0) {
|
||||
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
|
||||
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true });
|
||||
}
|
||||
// The run's artifact list can lag an upload, as the artifact lookup of a report job's publication does, so an
|
||||
// empty list, a 404, a 5xx or no answer is looked up again; a bad token or a missing permission fails at once.
|
||||
const artifact = await retryGitHubLookup(async () => {
|
||||
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
|
||||
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
|
||||
const body = response.ok ? await response.json() as { artifacts?: Array<{ id?: unknown; name?: unknown; expired?: unknown }> } : undefined;
|
||||
const found = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
|
||||
if (!found || typeof found.id !== "number" || !Number.isSafeInteger(found.id) || found.id <= 0) {
|
||||
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
|
||||
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true, details: { status: response.status } });
|
||||
}
|
||||
return found;
|
||||
}, error => {
|
||||
const status = error instanceof CiError ? error.details?.status : undefined;
|
||||
return !(error instanceof CiError) || typeof status === "number" && (status === 200 || status === 404 || status >= 500);
|
||||
}, options.sleep);
|
||||
entry.artifactUrl = `https://github.com/${repository}/actions/runs/${review.runId}/artifacts/${artifact.id}`;
|
||||
}
|
||||
return entries;
|
||||
|
||||
@@ -716,6 +716,7 @@ export async function assessPublicEvidence(options: {
|
||||
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
|
||||
accessibilityCounts.compared += 1;
|
||||
review = decideReview(scope, visual, summary);
|
||||
if (result.offScreen && review.status === "modified" && visual.verdict === "unchanged") review = { ...review, offScreen: true };
|
||||
if (review.facts?.length) accessibilityCounts.described += 1;
|
||||
} catch (error) {
|
||||
accessibilityCounts.failed += 1;
|
||||
|
||||
@@ -93,6 +93,8 @@ export type EvidenceComparatorResult = {
|
||||
visualAssessment?: VisualEvidenceAssessment;
|
||||
/** Feed directly to summarizeReviewerChanges. */
|
||||
reviewerChanges: ReviewerChangeInput[];
|
||||
/** The screenshots match, and every element the changes name lies at least partly past the edge of the screen. */
|
||||
offScreen?: true;
|
||||
};
|
||||
|
||||
type SupportedInput = Extract<ReviewerChangeInput, { assessment: "supported" }>;
|
||||
@@ -617,6 +619,54 @@ function outermost(elements: readonly ObservedElement[]): ObservedElement[] {
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* The screen in its accessibility tree's units: the element at the origin with the screenshot's shape (either way round,
|
||||
* since a frame turned to show an opened iPhone Duo upright keeps the tree on the panel's portrait axes), the largest if
|
||||
* several. Both controllers report the app's root that way. Without the screenshot's size there is no telling which
|
||||
* element is the screen.
|
||||
*/
|
||||
function viewportOf(side: ResolvedSide): ElementBounds | undefined {
|
||||
const image = side.map.artifacts.find(artifact => artifact.id === side.observation.screenshotArtifactId);
|
||||
if (!image?.width || !image.height) return undefined;
|
||||
const { width, height } = image;
|
||||
const shaped = (bounds: ElementBounds) => Math.abs(bounds.width * height - bounds.height * width) <= 0.01 * width * height
|
||||
|| Math.abs(bounds.width * width - bounds.height * height) <= 0.01 * width * height;
|
||||
return side.observation.elements.flatMap(element => boundsOf(element) ?? [])
|
||||
.filter(bounds => Math.abs(bounds.x) < 1 && Math.abs(bounds.y) < 1 && bounds.width > 0 && bounds.height > 0 && shaped(bounds))
|
||||
.sort((a, b) => b.width * b.height - a.width * a.height)[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether the screenshots cannot show the changes because the elements they name lie past the edge of the screen: each
|
||||
* change names at least one element, and more than half of each named element's area is beyond the screen on its side.
|
||||
* Both controllers leave an element wholly outside the screen out of the tree (the Argent bridge as agent-device does),
|
||||
* so a change past the edge can only show as an element straddling it, as Tempo's footnote below the fold of its sheet
|
||||
* on the closed iPhone Duo in brentvatne/euxy#172 (review run 39362642343) would. Mostly outside, not merely crossing
|
||||
* an edge: a control nudged a point or two past the edge is still on the screen, and its change stays "accessibility
|
||||
* only". A change whose elements have no bounds never qualifies.
|
||||
*/
|
||||
function changesOffScreen(facts: readonly SupportedInput[], base: ResolvedSide, head: ResolvedSide): boolean {
|
||||
const changes = facts.filter(fact => !["unstable-text", "no-visible-change", "visual-changed"].includes(fact.change.kind));
|
||||
if (!changes.length) return false;
|
||||
const viewports = { base: viewportOf(base), head: viewportOf(head) };
|
||||
const outside = (reference: string) => {
|
||||
const [, side, id] = /^(base|head):element:(.+)$/.exec(reference) ?? [];
|
||||
if (side !== "base" && side !== "head") return undefined;
|
||||
const viewport = viewports[side];
|
||||
const element = (side === "base" ? base : head).observation.elements.find(candidate => candidate.elementId === id);
|
||||
const bounds = element && boundsOf(element);
|
||||
if (!viewport || !bounds) return false;
|
||||
const visibleWidth = Math.max(0, Math.min(bounds.x + bounds.width, viewport.x + viewport.width) - Math.max(bounds.x, viewport.x));
|
||||
const visibleHeight = Math.max(0, Math.min(bounds.y + bounds.height, viewport.y + viewport.height) - Math.max(bounds.y, viewport.y));
|
||||
const area = bounds.width * bounds.height;
|
||||
return area > 0 && visibleWidth * visibleHeight < area / 2;
|
||||
};
|
||||
return changes.every(fact => {
|
||||
const named = fact.evidenceRefs.map(outside).filter((value): value is boolean => value !== undefined);
|
||||
return named.length > 0 && named.every(Boolean);
|
||||
});
|
||||
}
|
||||
|
||||
function specificByLabel(elements: readonly ObservedElement[]): ObservedElement[] {
|
||||
const byLabel = new Map<string, ObservedElement>();
|
||||
const unlabelled: ObservedElement[] = [];
|
||||
@@ -1276,6 +1326,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
const status: "modified" | "unchanged" = hasRuntimeDelta || reasons.length > 0
|
||||
? "modified"
|
||||
: "unchanged";
|
||||
const offScreen = input.visualAssessment.status === "unchanged" && changesOffScreen(facts, base, head);
|
||||
return {
|
||||
surfaceId: input.impact.id,
|
||||
status,
|
||||
@@ -1288,6 +1339,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
),
|
||||
visualAssessment: input.visualAssessment,
|
||||
reviewerChanges,
|
||||
...(offScreen ? { offScreen: true as const } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -148,6 +148,12 @@ export async function reportCiError(error: unknown, options: {
|
||||
env?: NodeJS.ProcessEnv;
|
||||
secrets?: readonly string[];
|
||||
diagnosticsPath?: string;
|
||||
/**
|
||||
* The matrix target the failed command ran for, written into the diagnostics file. actions/download-artifact puts an
|
||||
* artifact in a directory named after it only when a pattern matches several, so the failure job cannot always read
|
||||
* the target from where the file lands.
|
||||
*/
|
||||
target?: string;
|
||||
write?: (value: string) => void;
|
||||
} = {}): Promise<CiErrorData> {
|
||||
const env = options.env ?? process.env;
|
||||
@@ -166,7 +172,7 @@ export async function reportCiError(error: unknown, options: {
|
||||
if (env.GITHUB_STEP_SUMMARY) outputs.push({ label: "job summary", operation: appendFile(env.GITHUB_STEP_SUMMARY, `${renderCiErrorSummary(error, renderOptions)}\n`) });
|
||||
if (options.diagnosticsPath) outputs.push({ label: "diagnostics file", operation: (async () => {
|
||||
await mkdir(dirname(options.diagnosticsPath!), { recursive: true });
|
||||
await writeFile(options.diagnosticsPath!, `${JSON.stringify(diagnostic, null, 2)}\n`);
|
||||
await writeFile(options.diagnosticsPath!, `${JSON.stringify(options.target ? { ...diagnostic, target: options.target } : diagnostic, null, 2)}\n`);
|
||||
})() });
|
||||
const results = await Promise.allSettled(outputs.map(output => output.operation));
|
||||
for (const [index, result] of results.entries()) {
|
||||
|
||||
@@ -144,3 +144,39 @@ export function assertDecodedPng(contents: Buffer, label: string): void {
|
||||
if (decoded[row * (rowBytes + 1)]! > 4) throw new Error(`${label} has an invalid PNG row filter`);
|
||||
}
|
||||
}
|
||||
|
||||
/** The chunks that say how a PNG's samples map to colour; pngjs reads past them and writes none of its own. */
|
||||
const COLOUR_CHUNKS = new Set(["iCCP", "sRGB", "gAMA", "cHRM"]);
|
||||
|
||||
/**
|
||||
* The image turned a quarter clockwise. An opened iPhone Duo shows a landscape UI on a panel whose native axes are
|
||||
* portrait, and its screenshot comes back on those axes; turned, it is what a person sees. The source's colour chunks
|
||||
* are carried over unchanged. pngjs reads every PNG as 8-bit RGBA, so a 16-bit image comes out 8-bit; simulator
|
||||
* screenshots are 8-bit already.
|
||||
*/
|
||||
export function turnedClockwise(png: Buffer): Buffer {
|
||||
const { PNG } = createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs") as { PNG: { new(size: { width: number; height: number }): DecodedFrame; sync: {
|
||||
read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame; write(frame: DecodedFrame): Buffer } } };
|
||||
const source = PNG.sync.read(png, { checkCRC: false });
|
||||
const { width, height } = source;
|
||||
const turned = new PNG({ width: height, height: width });
|
||||
for (let y = 0; y < height; y += 1) {
|
||||
for (let x = 0; x < width; x += 1) {
|
||||
const from = (y * width + x) * 4;
|
||||
source.data.copy(turned.data, (x * height + (height - 1 - y)) * 4, from, from + 4);
|
||||
}
|
||||
}
|
||||
const written = PNG.sync.write(turned);
|
||||
// Each chunk is copied whole, CRC included: its data does not depend on the pixels or their size. They belong before
|
||||
// the image data, so they go right after the header (8 bytes of signature, then IHDR's 25). The output is RGBA, so a
|
||||
// grey source's ICC profile, which describes grey samples only, is left out.
|
||||
const grey = png[25] === 0 || png[25] === 4;
|
||||
const colour: Buffer[] = [];
|
||||
for (let offset = 8; offset + 12 <= png.length;) {
|
||||
const length = png.readUInt32BE(offset), type = png.toString("latin1", offset + 4, offset + 8), next = offset + 12 + length;
|
||||
if (type === "IDAT" || type === "IEND" || next > png.length) break;
|
||||
if (COLOUR_CHUNKS.has(type) && !(grey && type === "iCCP")) colour.push(png.subarray(offset, next));
|
||||
offset = next;
|
||||
}
|
||||
return colour.length ? Buffer.concat([written.subarray(0, 33), ...colour, written.subarray(33)]) : written;
|
||||
}
|
||||
@@ -121,6 +121,12 @@ export type Artifact = {
|
||||
mimeType: string;
|
||||
width?: number;
|
||||
height?: number;
|
||||
/**
|
||||
* A screenshot stored turned a quarter clockwise from its accessibility tree's axes (an opened iPhone Duo's landscape UI
|
||||
* on its inner panel's portrait axes): the tree's screen, `width` × `height` points. Element bounds stay on the tree's
|
||||
* axes, where the portrait point (x, y) shows at (height - y, x).
|
||||
*/
|
||||
turned?: { width: number; height: number };
|
||||
createdAt: string;
|
||||
};
|
||||
|
||||
|
||||
@@ -143,6 +143,10 @@ jobs:
|
||||
set -euo pipefail
|
||||
npm ci --ignore-scripts --prefix "app-base/$APP_INSTALL_DIR"
|
||||
npm ci --ignore-scripts --prefix "app-head/$APP_INSTALL_DIR"
|
||||
# A finished baseline of the base commit is downloaded here. With none, ci:find-baseline names a baseline run still
|
||||
# capturing it (pending): right after a merge the next review starts while main's baseline runs. Capture review
|
||||
# checks that run again (this repository's baseline workflow, the default branch, a push or manual dispatch, exactly
|
||||
# the base commit) and waits for its artifact while head captures, for up to capture.baselineWaitMinutes.
|
||||
- name: Find optional exact-base evidence
|
||||
id: cache
|
||||
continue-on-error: true
|
||||
@@ -164,6 +168,8 @@ jobs:
|
||||
id: capture
|
||||
env:
|
||||
COMPARE: ${{ needs.targets.outputs.compare }}
|
||||
# Reads the pending baseline run's jobs and artifact (actions: read); a comparison makes no other GitHub request.
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
SCOPE: ${{ inputs.scope }}
|
||||
EXPIRES_IN: ${{ inputs.expires-in }}
|
||||
EXPO_TOKEN: ${{ secrets.EXPO_TOKEN }}
|
||||
@@ -172,6 +178,7 @@ jobs:
|
||||
ANTHROPIC_WORKSPACE_ID: ${{ vars.ANTHROPIC_WORKSPACE_ID }}
|
||||
# App-test secrets: one NAME: line per {{secret:NAME}} input in .expo-explore (expo-explore setup adds them).
|
||||
EXPLORE_CAPTURE_CACHE: ${{ runner.temp }}/explore-cache
|
||||
EXPLORE_BASELINE_RUN: ${{ steps.cache.outputs.pending }}
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
@@ -219,8 +226,12 @@ jobs:
|
||||
${{ runner.temp }}/explore-review/agent-usage.jsonl
|
||||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
# Each target's report runs once its own capture uploaded one, whatever the other targets' captures did, as in the
|
||||
# review workflow (brentvatne/euxy#172): needs.capture.result is the whole matrix's, so each leg looks for its own
|
||||
# artifact, and a target whose capture failed packages and links nothing. !cancelled() keeps a cancelled run stopped.
|
||||
report:
|
||||
needs: [targets, capture]
|
||||
if: needs.targets.result == 'success' && !cancelled()
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
@@ -229,19 +240,34 @@ jobs:
|
||||
timeout-minutes: 20
|
||||
permissions:
|
||||
contents: read
|
||||
outputs:
|
||||
# "true" from every leg that linked its report, so "true" once any did: the deploy job runs only then.
|
||||
published: ${{ steps.publish.outputs.published }}
|
||||
env:
|
||||
TARGET: ${{ matrix.target }}
|
||||
steps:
|
||||
# Downloading by name fails when the artifact is missing. A pattern that matches nothing downloads nothing and
|
||||
# succeeds, so only a download that went wrong fails this step; its one match is extracted into the path itself.
|
||||
- name: Download this target's captured review
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-review
|
||||
- name: Check that this target's capture succeeded
|
||||
id: captured
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [[ -f "$RUNNER_TEMP/explore-review/report-input.json" ]]; then echo "found=true" >> "$GITHUB_OUTPUT"
|
||||
else echo "The $TARGET capture uploaded no review: its capture job failed."; fi
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-review
|
||||
- name: Package the report
|
||||
if: steps.captured.outputs.found == 'true'
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --target "$TARGET"
|
||||
- name: Upload the report
|
||||
if: steps.captured.outputs.found == 'true'
|
||||
id: report
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
@@ -250,10 +276,15 @@ jobs:
|
||||
retention-days: 30
|
||||
if-no-files-found: error
|
||||
- name: Link the report from the run summary
|
||||
if: steps.captured.outputs.found == 'true'
|
||||
id: publish
|
||||
env:
|
||||
ARTIFACT_URL: ${{ steps.report.outputs.artifact-url }}
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
|
||||
echo "published=true" >> "$GITHUB_OUTPUT"
|
||||
- name: Upload report failure diagnostics
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
@@ -264,9 +295,10 @@ jobs:
|
||||
if-no-files-found: ignore
|
||||
# Hosted report (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment serving every target's report.
|
||||
# This is the only job after capture that holds EXPO_TOKEN; it writes the link to the run summary.
|
||||
# It runs once any target linked its report, and serves the targets that did; a failed target has no report to wait for.
|
||||
deploy:
|
||||
needs: [targets, capture, report]
|
||||
if: needs.capture.outputs.preview == 'eas'
|
||||
if: needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 20
|
||||
permissions:
|
||||
@@ -275,7 +307,8 @@ jobs:
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
|
||||
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>),
|
||||
# or a lone artifact's files in the path itself; ci:deploy reads both.
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
|
||||
|
||||
@@ -133,6 +133,10 @@ jobs:
|
||||
set -euo pipefail
|
||||
npm ci --ignore-scripts --prefix "app-base/$APP_INSTALL_DIR"
|
||||
npm ci --ignore-scripts --prefix "app-head/$APP_INSTALL_DIR"
|
||||
# A finished baseline of the base commit is downloaded here. With none, ci:find-baseline names a baseline run still
|
||||
# capturing it (pending): right after a merge the next review starts while main's baseline runs. Capture review
|
||||
# checks that run again (this repository's baseline workflow, the default branch, a push or manual dispatch, exactly
|
||||
# the base commit) and waits for its artifact while head captures, for up to capture.baselineWaitMinutes.
|
||||
- name: Find optional exact-base evidence
|
||||
id: cache
|
||||
continue-on-error: true
|
||||
@@ -161,6 +165,7 @@ jobs:
|
||||
ANTHROPIC_WORKSPACE_ID: ${{ vars.ANTHROPIC_WORKSPACE_ID }}
|
||||
# App-test secrets: one NAME: line per {{secret:NAME}} input in .expo-explore (expo-explore setup adds them).
|
||||
EXPLORE_CAPTURE_CACHE: ${{ runner.temp }}/explore-cache
|
||||
EXPLORE_BASELINE_RUN: ${{ steps.cache.outputs.pending }}
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
@@ -207,8 +212,14 @@ jobs:
|
||||
${{ runner.temp }}/explore-review/agent-usage.jsonl
|
||||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
# Each target's report runs once its own capture uploaded one, whatever the other targets' captures did: in
|
||||
# brentvatne/euxy#172 (run 39348956443) one flaky simulator session failed one of five captures, and with the report
|
||||
# waiting on every capture the PR got no report at all. needs.capture.result is the whole matrix's, so each leg looks
|
||||
# for its own artifact instead; a target whose capture failed uploaded none, packages and publishes nothing here, and
|
||||
# is named by the failure job. !cancelled() lets the legs run after a failed capture leg, but not in a cancelled run.
|
||||
report:
|
||||
needs: [targets, capture]
|
||||
if: needs.targets.result == 'success' && !cancelled()
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
@@ -219,19 +230,34 @@ jobs:
|
||||
contents: read
|
||||
actions: read
|
||||
pull-requests: write
|
||||
outputs:
|
||||
# "true" from every leg that published, so "true" once any did: the deploy job runs only then.
|
||||
published: ${{ steps.publish.outputs.published }}
|
||||
env:
|
||||
TARGET: ${{ matrix.target }}
|
||||
steps:
|
||||
# Downloading by name fails when the artifact is missing. A pattern that matches nothing downloads nothing and
|
||||
# succeeds, so only a download that went wrong fails this step; its one match is extracted into the path itself.
|
||||
- name: Download this target's captured review
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-review
|
||||
- name: Check that this target's capture succeeded
|
||||
id: captured
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [[ -f "$RUNNER_TEMP/explore-review/report-input.json" ]]; then echo "found=true" >> "$GITHUB_OUTPUT"
|
||||
else echo "The $TARGET capture uploaded no review: its capture job failed, and the failure job reports it."; fi
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-review
|
||||
- name: Package hosted review bundle
|
||||
if: steps.captured.outputs.found == 'true'
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --target "$TARGET"
|
||||
- name: Upload hosted review bundle
|
||||
if: steps.captured.outputs.found == 'true'
|
||||
id: viewer
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
@@ -240,11 +266,16 @@ jobs:
|
||||
retention-days: 30
|
||||
if-no-files-found: error
|
||||
- name: Publish current PR hosted links
|
||||
if: steps.captured.outputs.found == 'true'
|
||||
id: publish
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
ARTIFACT_URL: ${{ steps.viewer.outputs.artifact-url }}
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
|
||||
run: |
|
||||
set -euo pipefail
|
||||
node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
|
||||
echo "published=true" >> "$GITHUB_OUTPUT"
|
||||
- name: Upload report failure diagnostics
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
@@ -256,9 +287,10 @@ jobs:
|
||||
# Hosted preview (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment per review, serving every target's report.
|
||||
# This is the only job after capture that holds EXPO_TOKEN; the report job stays credential-free and has already
|
||||
# published the Download report link, so a failed deployment leaves the comment on the download-and-drop flow.
|
||||
# It runs once any target published its report, and serves the targets that did; a failed target has no report to wait for.
|
||||
deploy:
|
||||
needs: [targets, capture, report]
|
||||
if: needs.capture.outputs.preview == 'eas'
|
||||
if: needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 20
|
||||
permissions:
|
||||
@@ -268,7 +300,8 @@ jobs:
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
|
||||
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>),
|
||||
# or a lone artifact's files in the path itself; ci:deploy reads both.
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
|
||||
@@ -317,6 +350,6 @@ jobs:
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# The diagnostics artifacts are data files from this run and attempt, never executable report code;
|
||||
# the first error.json names the failed target, and the comment keeps every other target's result.
|
||||
# The diagnostics artifacts are data files from this run and attempt, never executable report code; each
|
||||
# error.json names its failed target, which gets a failed record, and the comment keeps every other target's result.
|
||||
node "$TOOLS/dist/cli.js" ci:failure --pr "${PR_NUMBER:-0}" --head "${HEAD_SHA:-}" --base "${BASE_SHA:-}" --diagnostics "$RUNNER_TEMP/explore-failure"
|
||||
@@ -196,7 +196,7 @@ test("the pill shows the app's own icon when the report has one, and the Expo ma
|
||||
report.review.runtime.appIcon = { url: `https://artifact.expo-explore.invalid/${iconSha}.png`, sha256: iconSha, width: 4, height: 4 };
|
||||
report.assets.push({ sha256: iconSha, path: iconPath });
|
||||
const withIcon = await harness(t, await archive(report, [{ name: iconPath, bytes: iconBytes }]), { app: true });
|
||||
const logo = withIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true });
|
||||
const logo = withIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map of Fixture", exact: true });
|
||||
await expect(logo.locator("img.panel-app-icon")).toHaveJSProperty("naturalWidth", 4);
|
||||
await expect(logo.locator(".expo-mark")).toHaveCount(0);
|
||||
// The tab shows it too, from a Blob URL: the ZIP's own reference is not one the browser can load.
|
||||
@@ -206,7 +206,7 @@ test("the pill shows the app's own icon when the report has one, and the Expo ma
|
||||
assert.deepEqual(withIcon.errors, []);
|
||||
|
||||
const withoutIcon = await harness(t, await archive(), { app: true });
|
||||
const mark = withoutIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true });
|
||||
const mark = withoutIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map of Fixture", exact: true });
|
||||
await expect(mark.locator(".expo-mark")).toHaveCount(1);
|
||||
await expect(mark.locator("img")).toHaveCount(0);
|
||||
assert.deepEqual(withoutIcon.errors, []);
|
||||
@@ -647,6 +647,259 @@ test("a switch to a target whose screenshots have another shape lays the map out
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/**
|
||||
* The phone header as drawn, once a resize's fit has run. Its shown controls, each of the row's clipped at the row's
|
||||
* edges: how many pairs overlap, how many run past the row's end (past the window on a desktop, whose row does not
|
||||
* clip), and the page's overflow; the target label's parts cut without a fade or faded though whole; the room around
|
||||
* the row's first and last controls for a focus ring; and the name's width against its text's and its minimum.
|
||||
*/
|
||||
function phoneHeader(page) {
|
||||
return page.locator(".left-panel-collapsed-pill").evaluate(async pill => {
|
||||
await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)));
|
||||
const row = pill.querySelector(".collapsed-app-identity");
|
||||
const clip = row.getBoundingClientRect();
|
||||
const end = getComputedStyle(row).overflowX === "clip" ? clip.right - parseFloat(getComputedStyle(row).paddingRight) : innerWidth;
|
||||
const shown = [...pill.querySelectorAll(".panel-logo-button, .collapsed-app-identity > strong, .collapsed-platform, .collapsed-pr, .collapsed-search")]
|
||||
.filter(node => node.checkVisibility({ visibilityProperty: true }));
|
||||
const boxes = shown.map(node => {
|
||||
const box = node.getBoundingClientRect();
|
||||
return row.contains(node) ? { left: Math.max(box.left, clip.left), right: Math.min(box.right, clip.right) } : box;
|
||||
});
|
||||
let overlaps = 0;
|
||||
for (const [index, a] of boxes.entries()) for (const b of boxes.slice(index + 1)) if (a.left < b.right - 1 && b.left < a.right - 1) overlaps += 1;
|
||||
const items = shown.filter(node => row.contains(node));
|
||||
const past = items.filter(node => node.getBoundingClientRect().right > end + 1).length;
|
||||
const parts = [...row.querySelectorAll(".collapsed-target .collapsed-platform-label, .collapsed-target .collapsed-platform-label-text, .collapsed-target .collapsed-platform-label-suffix")];
|
||||
const cut = node => node.scrollWidth > node.offsetWidth;
|
||||
const faded = node => getComputedStyle(node).maskImage !== "none";
|
||||
const controls = items.filter(node => node.matches(".collapsed-platform, .collapsed-pr"));
|
||||
const ring = controls.length ? Math.floor(Math.min(controls[0].getBoundingClientRect().left - clip.left, clip.right - controls.at(-1).getBoundingClientRect().right)) : 4;
|
||||
const name = row.querySelector(":scope > strong");
|
||||
const minimum = parseFloat(getComputedStyle(row).getPropertyValue("--collapsed-name-min")) || 64;
|
||||
return {
|
||||
overlaps, past, overflow: document.documentElement.scrollWidth - innerWidth,
|
||||
unfaded: parts.filter(node => cut(node) && !faded(node)).length, fadedWhole: parts.filter(node => faded(node) && !cut(node)).length,
|
||||
ring, targetCut: parts.some(cut),
|
||||
name: name.checkVisibility({ visibilityProperty: true }) ? { width: name.getBoundingClientRect().width, text: name.scrollWidth, minimum: Math.min(minimum, name.scrollWidth) } : undefined,
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
/** What a header that fits shows: nothing overlaps or runs past the row, and a label fades exactly where it is cut. */
|
||||
const FITS = { overlaps: 0, past: 0, overflow: 0, unfaded: 0, fadedWhole: 0 };
|
||||
const fitOf = ({ overlaps, past, overflow, unfaded, fadedWhole }) => ({ overlaps, past, overflow, unfaded, fadedWhole });
|
||||
|
||||
/**
|
||||
* A report of two targets, `label` the shown one's, for the phone header: `icon` adds the app's icon (`"broken"`, one
|
||||
* whose bytes are no image), `appearances` a second chip, and the pull request is #1234.
|
||||
*/
|
||||
async function phoneReport({ label, appName = "Acme Super Long Application Name", icon = false, appearances = false }) {
|
||||
const targets = [{ id: "shown", platform: "ios", label }, { id: "other", platform: "ios", label: "iPhone 17" }];
|
||||
const report = reportFixture();
|
||||
report.review.runtime = { ...report.review.runtime, appName, platform: "ios", platforms: ["ios"], target: targets[0], targets,
|
||||
...(appearances ? { colorSchemes: ["light", "dark"] } : {}) };
|
||||
report.review.pullRequest.number = 1234;
|
||||
const extra = [];
|
||||
if (icon) {
|
||||
const image = new PNG({ width: 4, height: 4 });
|
||||
image.data.fill(180);
|
||||
const bytes = icon === "broken" ? new TextEncoder().encode("not an image") : PNG.sync.write(image);
|
||||
const sha = createHash("sha256").update(bytes).digest("hex");
|
||||
report.review.runtime.appIcon = { url: `https://artifact.expo-explore.invalid/${sha}.png`, sha256: sha, width: 4, height: 4 };
|
||||
report.assets.push({ sha256: sha, path: `assets/${sha}.png` });
|
||||
extra.push({ name: `assets/${sha}.png`, bytes });
|
||||
}
|
||||
return archive(report, extra);
|
||||
}
|
||||
|
||||
test("at a phone's width the header leaves out the app's name, then the pull request link, then fades the target's device; nothing overlaps", { timeout: 60_000 }, async t => {
|
||||
const targets = [{ id: "iphone", platform: "ios", label: "iPhone 17" }, { id: "duo-half", platform: "ios", label: "iPhone 17 Pro Max Duo (half-open, outer)" }];
|
||||
const icon = new PNG({ width: 4, height: 4 });
|
||||
icon.data.fill(180);
|
||||
const iconBytes = PNG.sync.write(icon);
|
||||
const iconSha = createHash("sha256").update(iconBytes).digest("hex");
|
||||
const report = reportFixture();
|
||||
// An icon to name the app once its name is left out; two appearances for the second chip; the longest target.
|
||||
report.review.runtime = {
|
||||
...report.review.runtime, platform: "ios", platforms: ["ios"], target: targets[1], targets, colorSchemes: ["light", "dark"],
|
||||
appIcon: { url: `https://artifact.expo-explore.invalid/${iconSha}.png`, sha256: iconSha, width: 4, height: 4 },
|
||||
};
|
||||
report.assets.push({ sha256: iconSha, path: `assets/${iconSha}.png` });
|
||||
report.review.pullRequest.number = 1234;
|
||||
const { page, errors } = await harness(t, await archive(report, [{ name: `assets/${iconSha}.png`, bytes: iconBytes }]), { app: true });
|
||||
const pill = page.locator(".left-panel-collapsed-pill");
|
||||
const name = pill.locator(".collapsed-app-identity > strong");
|
||||
const target = pill.locator(".collapsed-target");
|
||||
const device = target.locator(".collapsed-platform-label-text");
|
||||
const pose = target.locator(".collapsed-platform-label-suffix");
|
||||
const pr = pill.locator(".collapsed-pr");
|
||||
const layout = async () => fitOf(await phoneHeader(page));
|
||||
const clipped = locator => locator.evaluate(node => node.scrollWidth - node.offsetWidth > 1);
|
||||
const whole = async () => ({ device: !await clipped(device), pose: !await clipped(pose) });
|
||||
const dropped = () => pill.locator(".collapsed-app-identity").evaluate(node => node.dataset.drop ?? "");
|
||||
// The fit measures text: the Viewer's font must be in before the row's widths mean anything.
|
||||
await page.evaluate(() => document.fonts.ready);
|
||||
|
||||
// A desktop window's pill is sized by its content and shows the whole row.
|
||||
await page.setViewportSize({ width: 1180, height: 820 });
|
||||
await expect(name).toBeVisible();
|
||||
await expect(target).toHaveText("iPhone 17 Pro Max Duo (half-open, outer)");
|
||||
await expect(pr).toHaveText("PR #1234");
|
||||
await expect(pr).toBeVisible();
|
||||
expect(await whole()).toEqual({ device: true, pose: true });
|
||||
expect(await dropped()).toBe("");
|
||||
await expect.poll(layout).toEqual(FITS);
|
||||
|
||||
// A small tablet has no room for the name beside Search: the row leaves it out (the icon still names the app) and
|
||||
// keeps the whole target and a shorter link.
|
||||
await page.setViewportSize({ width: 560, height: 932 });
|
||||
await expect(name).toBeHidden();
|
||||
await expect(pr).toHaveText("#1234");
|
||||
await expect(pr).toBeVisible();
|
||||
await expect(target).toHaveText("iPhone 17 Pro Max Duo (half-open, outer)");
|
||||
expect(await whole()).toEqual({ device: true, pose: true });
|
||||
await expect.poll(layout).toEqual(FITS);
|
||||
const search = pill.getByRole("button", { name: "Search", exact: true });
|
||||
const finger = await search.boundingBox();
|
||||
assert.ok(finger.width >= 44 && finger.height >= 44, `Search is ${finger.width}×${finger.height}`);
|
||||
|
||||
// A large phone's width leaves out the link too (Search keeps "Open pull request") before it touches the target.
|
||||
await page.setViewportSize({ width: 500, height: 844 });
|
||||
await expect(pr).toBeHidden();
|
||||
await expect(target).toHaveText("iPhone 17 Pro Max Duo (half-open, outer)");
|
||||
expect(await whole()).toEqual({ device: true, pose: true });
|
||||
await expect.poll(layout).toEqual(FITS);
|
||||
await page.keyboard.press("ControlOrMeta+KeyK");
|
||||
const palette = page.getByRole("dialog", { name: "Search Explore" });
|
||||
await palette.getByRole("combobox", { name: "Search screens and commands" }).fill("pull request");
|
||||
await expect(palette.getByRole("option", { name: /^Open pull request #1234 on GitHub/ })).toBeVisible();
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(palette).toBeHidden();
|
||||
|
||||
// An iPhone's width fades the device's name; the pose stays whole and nothing overlaps.
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await expect(pill.locator(".collapsed-app-identity")).toHaveAttribute("data-drop", /squeeze/);
|
||||
await expect(pill.locator(".collapsed-app-identity")).not.toHaveAttribute("data-drop", /pose/);
|
||||
expect(await whole()).toEqual({ device: false, pose: true });
|
||||
await expect.poll(layout).toEqual(FITS);
|
||||
|
||||
// Narrower than the pose beside two chips: the pose fades too, inside its chip, never over the appearance chip.
|
||||
await page.setViewportSize({ width: 320, height: 568 });
|
||||
await expect(pill.locator(".collapsed-app-identity")).toHaveAttribute("data-drop", /pose/);
|
||||
await expect(pill.locator(".collapsed-platform").nth(1)).toHaveText("Light");
|
||||
await expect.poll(layout).toEqual(FITS);
|
||||
|
||||
// Widened again, the row takes everything back: the desktop's pill is sized by its content and leaves nothing out
|
||||
// (its own width rule ellipsizes the name beside so long a target; the fit does not touch it).
|
||||
await page.setViewportSize({ width: 1180, height: 820 });
|
||||
await expect(name).toHaveCSS("visibility", "visible");
|
||||
await expect(name).toHaveCSS("position", "static");
|
||||
await expect(pr).toHaveText("PR #1234");
|
||||
await expect(pr).toBeVisible();
|
||||
expect(await whole()).toEqual({ device: true, pose: true });
|
||||
expect(await dropped()).toBe("");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a phone's row without the app's icon cuts the name down to its minimum before it squeezes the target, and fades a label only where it is cut", { timeout: 90_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await phoneReport({ label: "iPhone 16 Pro (open)" }), { app: true });
|
||||
const row = page.locator(".left-panel-collapsed-pill .collapsed-app-identity");
|
||||
await expect(row.locator(".collapsed-target")).toHaveText("iPhone 16 Pro (open)");
|
||||
await page.evaluate(() => document.fonts.ready);
|
||||
|
||||
// An iPhone's width has room for the whole target beside a cut name: the name gives way, the target keeps its label.
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await expect(row).not.toHaveAttribute("data-drop", /squeeze/);
|
||||
const iphone = await phoneHeader(page);
|
||||
assert.equal(iphone.targetCut, false);
|
||||
assert.ok(iphone.name && iphone.name.width > iphone.name.minimum + 1 && iphone.name.width < iphone.name.text, `the name is ${JSON.stringify(iphone.name)}`);
|
||||
|
||||
// At every phone width, the target is cut only once the name is at its minimum, and only what is cut fades.
|
||||
for (const width of [320, 340, 360, 375, 390, 414, 430, 460, 480, 560, 700]) {
|
||||
await page.setViewportSize({ width, height: 844 });
|
||||
const header = await phoneHeader(page);
|
||||
assert.deepEqual(fitOf(header), FITS, `at ${width}px`);
|
||||
if (header.name) assert.ok(header.name.width >= header.name.minimum - 1, `at ${width}px the name is ${JSON.stringify(header.name)}`);
|
||||
if (header.targetCut && header.name) assert.ok(header.name.width <= header.name.minimum + 1, `at ${width}px the target is cut beside ${JSON.stringify(header.name)}`);
|
||||
}
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a phone's header with Hand off fits its row at an iPhone's widths, with or without the app's icon", { timeout: 120_000 }, async t => {
|
||||
// The hosted preview's header: Hand off sits before Search, so the row has less room than at /r.
|
||||
const reports = [
|
||||
{ label: "iPhone 16 Pro (open)", icon: false, appearances: true },
|
||||
{ label: "iPhone 16 Pro (open)", icon: true, appearances: true },
|
||||
{ label: "iOS", icon: false, appearances: true },
|
||||
];
|
||||
for (const [index, options] of reports.entries()) {
|
||||
const preview = { token: `${"qrstuvwxyz234567234567234567".slice(0, 28)}${"abcd".slice(index, index + 1)}bcd` };
|
||||
const { page, errors } = await harness(t, await phoneReport(options), { app: true, reportIdentity: null, preview, query: "" });
|
||||
const pill = page.locator(".left-panel-collapsed-pill");
|
||||
await expect(pill.locator(".collapsed-target")).toHaveText(options.label);
|
||||
await page.evaluate(() => document.fonts.ready);
|
||||
for (const width of [320, 360, 390, 430, 460]) {
|
||||
await page.setViewportSize({ width, height: 844 });
|
||||
await expect(pill.getByRole("button", { name: "Hand off to AI" })).toBeVisible();
|
||||
const header = await phoneHeader(page);
|
||||
const where = `${JSON.stringify(options)} at ${width}px`;
|
||||
assert.deepEqual(fitOf(header), FITS, where);
|
||||
// The row's end chip has room for its focus ring (2px, 2px out) and its key hint.
|
||||
assert.ok(header.ring >= 4, `${where}: ${header.ring}px around the row's controls`);
|
||||
// A name the row keeps is readable; one it leaves out is still the Map button's.
|
||||
if (header.name) assert.ok(header.name.width >= header.name.minimum - 1, `${where}: the name is ${JSON.stringify(header.name)}`);
|
||||
else await expect(pill.getByRole("button", { name: "Map of Acme Super Long Application Name", exact: true })).toBeVisible();
|
||||
// A short label is no squeeze's to give: it shows whole.
|
||||
if (options.label === "iOS") assert.equal(header.targetCut, false, where);
|
||||
}
|
||||
assert.deepEqual(errors, []);
|
||||
await page.close();
|
||||
}
|
||||
});
|
||||
|
||||
test("a phone's row keeps the app's name when its icon cannot be read and the Expo mark stands in", { timeout: 60_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await phoneReport({ label: "iPhone 17 Pro Max Duo (half-open, outer)", icon: "broken", appearances: true }), { app: true });
|
||||
const pill = page.locator(".left-panel-collapsed-pill");
|
||||
await expect(pill.locator(".panel-logo-button .expo-mark")).toHaveCount(1);
|
||||
await expect(pill.locator(".panel-logo-button img")).toHaveCount(0);
|
||||
await page.evaluate(() => document.fonts.ready);
|
||||
// With the icon, this width leaves the name out; the Expo mark does not name the app, so the name stays, cut.
|
||||
await page.setViewportSize({ width: 560, height: 932 });
|
||||
await expect(pill.locator(".collapsed-app-identity > strong")).toBeVisible();
|
||||
const header = await phoneHeader(page);
|
||||
assert.deepEqual(fitOf(header), FITS);
|
||||
assert.ok(header.name && header.name.width >= header.name.minimum - 1, `the name is ${JSON.stringify(header.name)}`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a phone's fit that waits on the fonts does nothing once the window is a desktop's", { timeout: 60_000 }, async t => {
|
||||
// The fonts arrive only when the test says, after the window has crossed to the desktop layout.
|
||||
const fault = () => {
|
||||
let release;
|
||||
const ready = new Promise(resolve => { release = () => resolve(document.fonts); });
|
||||
Object.defineProperty(document.fonts, "ready", { configurable: true, get: () => ready });
|
||||
window.releaseFonts = release;
|
||||
};
|
||||
const bytes = await phoneReport({ label: "iPhone 16 Pro (open)", icon: true, appearances: true });
|
||||
const { page, errors } = await harness(t, bytes, { app: true, open: false, fault });
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await chooseFile(page, bytes);
|
||||
const pill = page.locator(".left-panel-collapsed-pill");
|
||||
const row = pill.locator(".collapsed-app-identity");
|
||||
await expect(row).toHaveAttribute("data-drop", /name/);
|
||||
|
||||
await page.setViewportSize({ width: 1180, height: 820 });
|
||||
await expect(pill.locator(".collapsed-pr")).toHaveText("PR #1234");
|
||||
await page.evaluate(async () => {
|
||||
window.releaseFonts();
|
||||
await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)));
|
||||
});
|
||||
await expect(row).not.toHaveAttribute("data-drop");
|
||||
await expect(pill.locator(".collapsed-pr")).toBeVisible();
|
||||
await expect(pill.locator(".collapsed-app-identity > strong")).toBeVisible();
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a hosted manifest larger than the Viewer reads is refused before it is parsed", { timeout: 60_000 }, async t => {
|
||||
const preview = { token: "klmnopqrstuvwxyz2345672345672345", padding: 11 * 1024 * 1024 };
|
||||
const { page, errors } = await harness(t, await archive(), { app: true, reportIdentity: null, preview, query: "" });
|
||||
@@ -1346,7 +1599,7 @@ test("transition thumbnails without a readable screenshot show the variant thumb
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a docs-only report with zero images and no EAS build opens Screens without a visual verdict", async t => {
|
||||
test("a docs-only report with zero images and no EAS build has no screens to show, and its link to a route says why", async t => {
|
||||
const report = reportFixture();
|
||||
report.review.mode = "changes";
|
||||
report.review.runtime.projectId = "";
|
||||
@@ -1359,12 +1612,11 @@ test("a docs-only report with zero images and no EAS build opens Screens without
|
||||
report.assets = [];
|
||||
const { page, errors } = await harness(t, await archive(report), { app: true });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(1);
|
||||
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(1);
|
||||
// The Inspector's missing screenshot matches the canvas node: the icon above a short label and
|
||||
// the report's reason for the gap, centred in a phone-shaped preview frame.
|
||||
await page.locator(".screens-page .screen-screenshot-target").click();
|
||||
// The change reaches no screen, so the one route was never captured: the Map and Screens say so instead of an empty page.
|
||||
const empty = page.locator(".map-empty");
|
||||
await expect(empty.getByRole("heading")).toHaveText("No screens were captured");
|
||||
// The link names /home, and the Inspector says why it has no screenshot: the icon above a short label and the report's
|
||||
// reason for the gap, centred in a phone-shaped preview frame.
|
||||
const placeholder = page.locator(".inspector .inspector-preview .screenshot-placeholder");
|
||||
await expect(placeholder.locator("span")).toHaveText("No screenshot");
|
||||
await expect(placeholder.locator(".screenshot-placeholder-detail")).toHaveText("Not compared; no capture was recorded");
|
||||
@@ -1390,10 +1642,98 @@ test("a docs-only report with zero images and no EAS build opens Screens without
|
||||
await expect(page.locator(".collapsed-change-count")).toHaveCount(0);
|
||||
await expect(page.locator(".changes-screen-row")).toHaveCount(0);
|
||||
await expect(page.locator(".diff-frame.diff-modified, .diff-frame.diff-unchanged")).toHaveCount(0);
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
await expect(empty.getByRole("heading")).toHaveText("No screens were captured");
|
||||
await expect(page.locator(".screens-cell, .screens-tree-row")).toHaveCount(0);
|
||||
assert.equal(await page.evaluate(() => window.createdUrls.length), 0);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/** A report with Home (modified) and Profile (not compared) captured, a new route named in exploration.exclude, and a redirect. */
|
||||
function omittedRoutesReport() {
|
||||
const report = reportFixture();
|
||||
const home = report.review.surfaces[0];
|
||||
const route = (id, path, extra = {}) => ({ ...home.head, id, route: path, path, routeFile: `app/${id}.tsx`, logicalPath: `app/${id}.tsx`, ...extra });
|
||||
const redirect = route("start", "/start", { kind: "redirect", redirectTo: "/home" });
|
||||
report.review.surfaces.push(
|
||||
{ id: "profile", status: "unchanged", base: route("profile", "/profile"), head: route("profile", "/profile"),
|
||||
baseImage: { ...home.baseImage }, headImage: { ...home.headImage }, baseOutcome: { ...home.baseOutcome }, headOutcome: { ...home.headOutcome } },
|
||||
{ id: "channel", status: "added", excluded: true, base: null, head: route("channel", "/c/[channel]") },
|
||||
{ id: "start", status: "unchanged", base: { ...redirect }, head: redirect });
|
||||
return report;
|
||||
}
|
||||
|
||||
test("a public report's excluded route and redirect are not among its screens: Screens, its counts, find, search and the changes leave them out", { timeout: 60_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await archive(omittedRoutesReport()), { app: true, query: "&screen=home" });
|
||||
await expect(page.locator(".map-canvas .react-flow__node")).toHaveCount(2);
|
||||
// The excluded route is new in this change, but it was never captured: it is not a change to review.
|
||||
const menu = await openChangesMenu(page);
|
||||
await expect(menu.getByRole("group", { name: "Filter changes" }).getByRole("button")).toHaveText(["Modified 1"]);
|
||||
await expect(menu.getByText("/c/[channel]")).toHaveCount(0);
|
||||
await page.keyboard.press("Escape");
|
||||
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
const cells = page.locator(".screens-page .screens-cell");
|
||||
await expect(cells).toHaveCount(2);
|
||||
await expect(page.locator(".screens-tree-row[data-screen-id]")).toHaveCount(2);
|
||||
for (const id of ["channel", "start"]) await expect(page.locator(`[data-screen-id="${id}"]`)).toHaveCount(0);
|
||||
await expect(page.locator(".screens-filter .screens-chip")).toHaveText(["Changed1", "All2"]);
|
||||
// ← and → step through the two screens and no others.
|
||||
await page.locator(".screens-page").click({ position: { x: 4, y: 4 } });
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(page.locator(".screens-cell .screen-screenshot-card.selected")).toHaveCount(1);
|
||||
const picked = async () => page.locator(".screens-cell:has(.screen-screenshot-card.selected)").getAttribute("data-screen-id");
|
||||
const first = await picked();
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect.poll(picked).not.toBe(first);
|
||||
const second = await picked();
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect.poll(picked).toBe(second);
|
||||
assert.deepEqual([first, second].sort(), ["home", "profile"]);
|
||||
|
||||
// `/` finds the report's screens only.
|
||||
await page.keyboard.press("/");
|
||||
const find = page.getByRole("searchbox", { name: "Find screens" });
|
||||
await expect(find).toBeFocused();
|
||||
for (const query of ["channel", "start"]) {
|
||||
await find.fill(query);
|
||||
await expect(page.locator(".screens-find-empty")).toHaveText(`No screens match “${query}”`);
|
||||
await expect(cells).toHaveCount(0);
|
||||
}
|
||||
await find.fill("profile");
|
||||
await expect(cells).toHaveCount(1);
|
||||
await page.keyboard.press("Escape");
|
||||
await page.keyboard.press("Escape");
|
||||
|
||||
// So does the command palette's screen search.
|
||||
await page.keyboard.press("ControlOrMeta+KeyK");
|
||||
const palette = page.getByRole("dialog", { name: "Search Explore" });
|
||||
const box = palette.getByRole("combobox", { name: "Search screens and commands" });
|
||||
await expect(box).toBeFocused();
|
||||
await box.fill("/c/");
|
||||
await expect(palette.getByRole("option")).toHaveCount(0);
|
||||
await box.fill("/st");
|
||||
await expect(palette.getByRole("option")).toHaveCount(0);
|
||||
await box.fill("/pro");
|
||||
await expect(palette.getByRole("option")).toHaveText([/\/profile/]);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a link to an excluded route opens it in the Inspector, which says why it has no screenshot, on the Map and on Screens", { timeout: 60_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await archive(omittedRoutesReport()), { app: true, query: "&screen=channel" });
|
||||
const detail = page.locator(".inspector .inspector-preview .screenshot-placeholder-detail");
|
||||
await expect(detail).toHaveText("Excluded by exploration.exclude; never captured");
|
||||
await expect(page.locator(".map-canvas .react-flow__node")).toHaveCount(2);
|
||||
await expect(page.locator(".map-canvas .react-flow__node.selected")).toHaveCount(0);
|
||||
// The same link on Screens, opened afresh: no card is picked, and the Inspector explains the route.
|
||||
await page.goto(page.url().replace("#/map/", "#/screens/"));
|
||||
await page.reload();
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(2);
|
||||
await expect(page.locator(".screens-cell .screen-screenshot-card.selected")).toHaveCount(0);
|
||||
await expect(detail).toHaveText("Excluded by exploration.exclude; never captured");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("unverified capture diagnostics stay separate from verified Needs review, and source changes nobody compared are not changes", async t => {
|
||||
const report = reportFixture();
|
||||
const home = report.review.surfaces[0];
|
||||
@@ -1507,10 +1847,11 @@ test("a recorded pull-request artifact opens its verified verdicts and every scr
|
||||
await expect(menu.getByText(route, { exact: true })).toBeVisible();
|
||||
}
|
||||
|
||||
// Its two redirect declarations (/ and /scan/select-photo) were never captured: they are not among its screens.
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
const frames = page.locator(".screens-page .diff-frame");
|
||||
await expect(frames).toHaveCount(35);
|
||||
for (const [status, count] of [["modified", 3], ["added", 1], ["removed", 1], ["unchanged", 28], ["not-compared", 2]]) {
|
||||
await expect(frames).toHaveCount(33);
|
||||
for (const [status, count] of [["modified", 3], ["added", 1], ["removed", 1], ["unchanged", 28], ["not-compared", 0]]) {
|
||||
await expect(page.locator(`.screens-page .diff-frame.diff-${status}`)).toHaveCount(count);
|
||||
}
|
||||
const screenshots = page.locator(".screens-page img[data-screenshot-src]");
|
||||
@@ -1686,3 +2027,502 @@ test("a near-square landscape pair in a short window keeps both halves on screen
|
||||
}
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/** A capture in a colour of its own, so every side of every screen is a screenshot of its own. */
|
||||
function tintedCapture(seed) {
|
||||
const picture = new PNG({ width: 32, height: 64 });
|
||||
for (let offset = 0; offset < picture.data.length; offset += 4) picture.data.set([(seed * 53) % 256, (seed * 101 + 40) % 256, (seed * 151 + 90) % 256, 255], offset);
|
||||
const bytes = PNG.sync.write(picture);
|
||||
const digest = createHash("sha256").update(bytes).digest("hex");
|
||||
return { bytes, sha256: digest, path: `assets/${digest}.png`, reference: `expo-explore-asset:${digest}.png`,
|
||||
record: { url: `https://artifact.expo-explore.invalid/${digest}.png`, sha256: digest, width: 32, height: 64 } };
|
||||
}
|
||||
|
||||
/**
|
||||
* `count` modified screens, screen-1 to screen-<count>, each with a Before and an After of its own. `seed` gives
|
||||
* another target its own captures. `screens[i]` holds screen-(i + 1)'s `before` and `after`. `sameAfter: { i: j }`
|
||||
* gives the screen at index i the After of the one at index j.
|
||||
*/
|
||||
async function changedScreensArchive(count, { seed = 1, runtime, sameAfter = {} } = {}) {
|
||||
const report = reportFixture();
|
||||
const home = report.review.surfaces[0];
|
||||
const route = id => ({ ...home.head, id, route: `/${id}`, path: `/${id}`, routeFile: `app/${id}.tsx`, logicalPath: `app/${id}.tsx` });
|
||||
const extra = [];
|
||||
const screens = [];
|
||||
report.assets = [];
|
||||
report.review.surfaces = Array.from({ length: count }, (_, index) => {
|
||||
const id = `screen-${index + 1}`;
|
||||
const before = tintedCapture(seed * 100 + index * 2);
|
||||
const after = sameAfter[index] !== undefined ? screens[sameAfter[index]].after : tintedCapture(seed * 100 + index * 2 + 1);
|
||||
screens.push({ id, before, after });
|
||||
for (const capture of [before, after]) {
|
||||
if (report.assets.some(asset => asset.sha256 === capture.sha256)) continue;
|
||||
report.assets.push({ sha256: capture.sha256, path: capture.path });
|
||||
extra.push({ name: capture.path, bytes: capture.bytes });
|
||||
}
|
||||
return { ...structuredClone(home), id, base: route(id), head: route(id),
|
||||
baseImage: { ...home.baseImage, ...before.record }, headImage: { ...home.headImage, ...after.record } };
|
||||
});
|
||||
const empty = { contract: "explore.navigation", edges: [], modalSurfaceIds: [], unresolved: [] };
|
||||
report.review.navigation = { base: structuredClone(empty), head: empty };
|
||||
if (runtime) report.review.runtime = { ...report.review.runtime, ...runtime };
|
||||
return { bytes: await archive(report, extra), screens };
|
||||
}
|
||||
|
||||
/** Records each screenshot request (reference, priority, when) and release on the page's report archives. */
|
||||
async function recordScreenshotReads(page) {
|
||||
await page.evaluate(async () => {
|
||||
const { ArtifactReportArchive } = await import("/src/utils/artifact-report.ts");
|
||||
window.reads = [];
|
||||
window.releases = [];
|
||||
const { resolve, release } = ArtifactReportArchive.prototype;
|
||||
ArtifactReportArchive.prototype.resolve = function (reference, priority) {
|
||||
window.reads.push({ reference, priority: priority ?? "lazy", at: performance.now() });
|
||||
return resolve.call(this, reference, priority);
|
||||
};
|
||||
ArtifactReportArchive.prototype.release = function (reference) {
|
||||
window.releases.push({ reference, at: performance.now() });
|
||||
return release.call(this, reference);
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
/** How many uses of each screenshot the shown report counts, by reference. */
|
||||
const screenshotUses = page => page.evaluate(async () => {
|
||||
const { activeArtifactReport } = await import("/src/utils/artifact-report.ts");
|
||||
return Object.fromEntries([...activeArtifactReport.loads.values()].map(load => [`expo-explore-asset:${load.sha256}.png`, load.users]));
|
||||
});
|
||||
|
||||
/** How many mounted images show each screenshot, by reference. */
|
||||
const mountedScreenshots = page => page.evaluate(() => {
|
||||
const counts = {};
|
||||
for (const image of document.querySelectorAll("img[data-screenshot-src]")) counts[image.dataset.screenshotSrc] = (counts[image.dataset.screenshotSrc] ?? 0) + 1;
|
||||
return counts;
|
||||
});
|
||||
|
||||
/** Every use the report counts belongs to an image on the page; nothing else holds a screenshot. */
|
||||
async function expectBalancedUses(page, message) {
|
||||
await expect.poll(async () => {
|
||||
const uses = await screenshotUses(page);
|
||||
const mounted = await mountedScreenshots(page);
|
||||
return Object.entries(uses).filter(([reference, users]) => users > (mounted[reference] ?? 0));
|
||||
}, { message }).toEqual([]);
|
||||
}
|
||||
|
||||
test("Compare reads the next screen's screenshots once it rests on a screen, never while an arrow is held, and they are released when it moves on", { timeout: 90_000 }, async t => {
|
||||
const { bytes, screens } = await changedScreensArchive(9);
|
||||
const { page, errors } = await harness(t, bytes, { app: true, open: false, query: "&view=compare&screen=screen-1" });
|
||||
await recordScreenshotReads(page);
|
||||
await chooseFile(page, bytes);
|
||||
const compare = page.locator(".compare-section");
|
||||
await expect(compare.locator(".compare-frame img")).toHaveCount(2);
|
||||
for (const image of await compare.locator(".compare-frame img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const position = compare.locator(".compare-nav-position");
|
||||
await expect(position).toHaveText(/^1 of 9$/);
|
||||
const shownAt = await page.evaluate(() => Math.min(...window.reads.filter(read => read.priority === "eager").map(read => read.at)));
|
||||
|
||||
// Resting on screen-1, its neighbour in the direction of travel (screen-2) is read, after the settle delay, as a
|
||||
// prefetch that leaves the next step's slots free.
|
||||
const prefetchesOf = screen => page.evaluate(references => window.reads.filter(read => read.priority === "prefetch" && references.includes(read.reference)),
|
||||
[screen.before.reference, screen.after.reference]);
|
||||
await expect.poll(async () => (await prefetchesOf(screens[1])).length).toBe(2);
|
||||
assert.ok((await prefetchesOf(screens[1]))[0].at - shownAt >= 240, "Nothing is read before Compare rests on the screen");
|
||||
assert.equal((await page.evaluate(() => window.reads.filter(read => read.priority === "prefetch"))).length, 2, "Only the neighbour is read");
|
||||
await expect.poll(() => screenshotUses(page)).toMatchObject({ [screens[1].before.reference]: 1, [screens[1].after.reference]: 1 });
|
||||
|
||||
// The step finds its pictures decoded: nothing new is decoded for them.
|
||||
await expect.poll(() => page.evaluate(() => window.createdUrls.length)).toBe(4);
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(position).toHaveText(/^2 of 9$/);
|
||||
for (const image of await compare.locator(".compare-frame img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
assert.equal(await page.evaluate(() => window.createdUrls.length), 4, "The prefetched screenshots were shown without a new decode");
|
||||
|
||||
// A held arrow steps past several screens; nothing is read for a neighbour until it is released.
|
||||
await expect.poll(async () => (await prefetchesOf(screens[2])).length).toBe(2);
|
||||
const downAt = await page.evaluate(() => performance.now());
|
||||
await page.keyboard.down("ArrowRight");
|
||||
await expect.poll(async () => Number((await position.textContent()).split(" ")[0]), { timeout: 4000 }).toBeGreaterThanOrEqual(6);
|
||||
// The stage is marked while the key repeats, so the screenshots it passes appear without a fade.
|
||||
await expect(compare.locator(".compare-stage")).toHaveAttribute("data-screenshot-instant", "");
|
||||
await page.waitForTimeout(150);
|
||||
const upAt = await page.evaluate(() => performance.now());
|
||||
await page.keyboard.up("ArrowRight");
|
||||
await expect(compare.locator(".compare-stage")).not.toHaveAttribute("data-screenshot-instant", /.*/);
|
||||
const heldPrefetches = await page.evaluate(({ downAt, upAt }) => window.reads.filter(read => read.priority === "prefetch" && read.at > downAt && read.at <= upAt), { downAt, upAt });
|
||||
assert.deepEqual(heldPrefetches, [], "No neighbour was read while the arrow was held");
|
||||
const landed = Number((await position.textContent()).split(" ")[0]);
|
||||
const next = screens[landed];
|
||||
if (next) await expect.poll(async () => (await prefetchesOf(next)).length).toBe(2);
|
||||
|
||||
// Leaving Compare lets go of every screenshot it, and its prefetch, held.
|
||||
await page.getByRole("group", { name: "Canvas view" }).getByRole("button", { name: "Screens", exact: true }).click();
|
||||
await expect(page.locator(".screens-page")).toBeVisible();
|
||||
await expect(compare).toHaveCount(0);
|
||||
await expectBalancedUses(page, "Every use left after Compare belongs to an image on Screens");
|
||||
const uses = await screenshotUses(page);
|
||||
for (const screen of screens) assert.equal(uses[screen.before.reference] ?? 0, 0, `${screen.id}'s Before is no longer in use`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a prefetch never holds a slot the screen the reviewer steps to needs, whichever way the step goes", { timeout: 20_000 }, async t => {
|
||||
const { page, errors } = await harness(t);
|
||||
const { bytes, shas } = await multiImageArchive(8);
|
||||
const result = await page.evaluate(async ({ bytes, identity, shas, probe }) => {
|
||||
const archive = await window.openReport(bytes, identity);
|
||||
const decodes = new Function(`return (${probe})()`)();
|
||||
const [shown, shownToo, ahead, aheadToo, behind, behindToo, later, laterToo] = shas.map(sha => archive.reference(sha));
|
||||
const settle = () => new Promise(resolve => setTimeout(resolve, 30));
|
||||
// The screen on show is still being read when Compare rests on it: its neighbour's prefetches wait.
|
||||
const visible = [archive.resolve(shown, "eager"), archive.resolve(shownToo, "eager")];
|
||||
await decodes.until(() => decodes.held() === 2);
|
||||
const waited = [archive.resolve(ahead, "prefetch"), archive.resolve(aheadToo, "prefetch")].map(read => read.then(() => "read", error => error.message));
|
||||
await settle();
|
||||
const heldWhileShownReads = decodes.held();
|
||||
// The reviewer steps the other way before they start: they are dropped, unread.
|
||||
archive.release(ahead);
|
||||
archive.release(aheadToo);
|
||||
const stepped = [archive.resolve(behind, "eager"), archive.resolve(behindToo, "eager")];
|
||||
await decodes.until(() => decodes.held() === 4);
|
||||
decodes.all();
|
||||
await Promise.all([...visible, ...stepped]);
|
||||
const dropped = await Promise.all(waited);
|
||||
|
||||
// Resting on that screen, its own neighbour's prefetches start, in the slots its reads have finished with.
|
||||
const running = [archive.resolve(later, "prefetch"), archive.resolve(laterToo, "prefetch")];
|
||||
await decodes.until(() => decodes.held() === 2);
|
||||
// The reviewer steps the other way while they run: they keep their slots, and the screen stepped to starts at once.
|
||||
archive.release(later);
|
||||
archive.release(laterToo);
|
||||
archive.release(shown);
|
||||
archive.release(shownToo);
|
||||
const back = [archive.resolve(shown, "eager"), archive.resolve(shownToo, "eager")];
|
||||
await settle();
|
||||
const heldAfterStep = decodes.held();
|
||||
decodes.all();
|
||||
await Promise.all([...running, ...back]);
|
||||
return { heldWhileShownReads, dropped, heldAfterStep, hashed: decodes.hashed() };
|
||||
}, { bytes, identity, shas, probe: decodeProbe.toString() });
|
||||
assert.equal(result.heldWhileShownReads, 2, "The prefetches waited while the shown screen was still being read");
|
||||
assert.deepEqual(result.dropped, ["This screenshot is no longer in use.", "This screenshot is no longer in use."]);
|
||||
assert.ok(!result.hashed.includes(shas[2]) && !result.hashed.includes(shas[3]), "A prefetch let go before it started was never read");
|
||||
assert.equal(result.heldAfterStep, 2, "The screen stepped to was read at once, beside the running prefetches");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("Flip reads a screen's Before only once its After has loaded, and flipping reads nothing new", { timeout: 90_000 }, async t => {
|
||||
const { bytes, screens } = await changedScreensArchive(4);
|
||||
const { page, errors } = await harness(t, bytes, { app: true, open: false, query: "&view=compare&screen=screen-1" });
|
||||
await page.addInitScript(() => localStorage.setItem("expo-explore:compare-mode", "flip"));
|
||||
await page.reload();
|
||||
await recordScreenshotReads(page);
|
||||
await chooseFile(page, bytes);
|
||||
const frame = page.locator(".compare-section .compare-flip-frame");
|
||||
await expect(frame.locator(".compare-flip-layer")).toHaveCount(2);
|
||||
for (const image of await frame.locator("img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
// The side off screen is hidden, its spinner with it.
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='before']")).toHaveAttribute("aria-hidden", "true");
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='before']")).toHaveCSS("visibility", "hidden");
|
||||
|
||||
// The next screen's After is held back: its Before is not read meanwhile, and only After's layer is mounted.
|
||||
await page.evaluate(after => {
|
||||
const digest = crypto.subtle.digest.bind(crypto.subtle);
|
||||
const hex = buffer => Array.from(new Uint8Array(buffer), byte => byte.toString(16).padStart(2, "0")).join("");
|
||||
window.heldAfter = [];
|
||||
crypto.subtle.digest = async (algorithm, data) => {
|
||||
const value = await digest(algorithm, data);
|
||||
if (hex(value) === after) await new Promise(resolve => window.heldAfter.push(resolve));
|
||||
return value;
|
||||
};
|
||||
}, screens[1].after.sha256);
|
||||
const readsOf = reference => page.evaluate(reference => window.reads.filter(read => read.reference === reference && read.priority !== "prefetch").length, reference);
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(page.locator(".compare-section .compare-nav-position")).toHaveText(/^2 of 4$/);
|
||||
await expect(frame.locator(".compare-flip-layer")).toHaveCount(1);
|
||||
await page.waitForTimeout(150);
|
||||
assert.equal(await readsOf(screens[1].before.reference), 0, "Before is not read while After loads");
|
||||
await page.evaluate(() => window.heldAfter.splice(0).forEach(release => release()));
|
||||
await expect(frame.locator(".compare-flip-layer")).toHaveCount(2);
|
||||
for (const image of await frame.locator("img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
// StrictMode mounts each image's lease twice in development.
|
||||
assert.ok(await readsOf(screens[1].before.reference) > 0, "Before is read once After has loaded");
|
||||
|
||||
// Flipping swaps the two decoded sides at once.
|
||||
const reads = await page.evaluate(() => window.reads.length);
|
||||
await page.keyboard.press("KeyX");
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='before']")).not.toHaveAttribute("aria-hidden", /.*/);
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='after']")).toHaveCSS("visibility", "hidden");
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='before'] img")).toHaveCSS("opacity", "1");
|
||||
await page.keyboard.press("KeyX");
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='after']")).not.toHaveAttribute("aria-hidden", /.*/);
|
||||
assert.equal(await page.evaluate(() => window.reads.length), reads, "A flip reads nothing");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a Map card's backing draws the frame its screenshot waits and fades in over, and steps aside for No screenshot", { timeout: 60_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await archive(), { app: true, fault: holdScreenshotHashes() });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const slot = page.locator(".map-canvas .screen-node-image").first();
|
||||
const image = slot.locator("img[data-screenshot-src]");
|
||||
const backing = slot.locator(".screenshot-backing");
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await expect(image).toHaveCSS("opacity", "0");
|
||||
await expect(backing).toHaveCSS("visibility", "visible");
|
||||
const frames = () => slot.evaluate(element => {
|
||||
const box = node => { const { left, top, width, height } = node.getBoundingClientRect(); return [left, top, width, height].map(value => Math.round(value * 10) / 10); };
|
||||
const style = node => { const { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow } = getComputedStyle(node); return { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow }; };
|
||||
const [img, backing] = [element.querySelector("img"), element.querySelector(".screenshot-backing")];
|
||||
return { image: box(img), backing: box(backing), imageStyle: style(img), backingStyle: style(backing) };
|
||||
});
|
||||
// The link selects Home, so the frame carries the selection ring past the Modified status.
|
||||
await expect(page.locator(".map-canvas .react-flow__node-screen.selected")).toHaveCount(1);
|
||||
// The ring follows the canvas zoom, and the backing's ring eases to it as the opening camera settles.
|
||||
await expect.poll(async () => { const { backingStyle, imageStyle } = await frames(); return backingStyle.boxShadow === imageStyle.boxShadow; }).toBe(true);
|
||||
const waiting = await frames();
|
||||
assert.deepEqual(waiting.backing, waiting.image, "The backing sits exactly where the image does");
|
||||
assert.deepEqual(waiting.backingStyle, waiting.imageStyle, "and draws the same frame: fill, border, radius, status and ring");
|
||||
assert.match(waiting.backingStyle.boxShadow, /rgb\(5, 136, 240\)/);
|
||||
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
|
||||
assert.deepEqual((await frames()).image, waiting.image, "Loading moved nothing");
|
||||
// Once the picture has faded in, the backing hides.
|
||||
await expect(backing).toHaveCSS("visibility", "hidden");
|
||||
await expect(image).toHaveCSS("opacity", "1");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a Map card whose screenshot cannot be read shows No screenshot in one frame, its backing hidden", async t => {
|
||||
const damaged = Buffer.from(png);
|
||||
damaged[damaged.length - 1] ^= 1;
|
||||
const { page, errors } = await harness(t, await archive(reportFixture(), [], damaged), { app: true });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const slot = page.locator(".map-canvas .screen-node-image").first();
|
||||
await expect(slot.locator(".image-placeholder")).toHaveText("No screenshot");
|
||||
await expect(slot.locator(".screenshot-backing")).toHaveCSS("visibility", "hidden");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("on a phone, a Screens card's screenshot keeps its height while it loads and once it has", { timeout: 60_000 }, async t => {
|
||||
const { bytes } = await changedScreensArchive(2);
|
||||
const { page, errors } = await harness(t, bytes, { app: true, open: false, fault: holdScreenshotHashes(tintedCapture(100).bytes.length) });
|
||||
await page.setViewportSize({ width: 390, height: 844 });
|
||||
await chooseFile(page, bytes);
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
await page.goto(`${page.url().split("#")[0]}#/screens`);
|
||||
const slot = page.locator(".screens-cell .screen-node-image.has-screenshot").first();
|
||||
await expect(slot).toBeVisible();
|
||||
const height = () => slot.evaluate(element => [element.getBoundingClientRect().height, element.querySelector("img").getBoundingClientRect().height]);
|
||||
const [waiting, waitingImage] = await height();
|
||||
assert.ok(waiting > 100 && Math.abs(waiting - waitingImage) < 1, `The waiting screenshot holds the slot open: ${waiting}, ${waitingImage}`);
|
||||
// The image is the frame here, and hidden while it loads: its backing draws the same frame in its place.
|
||||
await expect(slot.locator("img")).toHaveCSS("opacity", "0");
|
||||
const backing = slot.locator(".screenshot-backing");
|
||||
await expect(backing).toHaveCSS("visibility", "visible");
|
||||
const frames = await slot.evaluate(element => {
|
||||
const box = node => { const { left, top, width, height } = node.getBoundingClientRect(); return [left, top, width, height].map(value => Math.round(value)); };
|
||||
const style = node => { const { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow } = getComputedStyle(node); return { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow }; };
|
||||
const [img, backing] = [element.querySelector("img"), element.querySelector(".screenshot-backing")];
|
||||
return { image: box(img), backing: box(backing), imageStyle: style(img), backingStyle: style(backing) };
|
||||
});
|
||||
assert.deepEqual(frames.backing, frames.image);
|
||||
assert.deepEqual(frames.backingStyle, frames.imageStyle, "The backing draws the image's frame: border, fill, radius, status and ring");
|
||||
assert.notEqual(frames.backingStyle.backgroundColor, "rgba(0, 0, 0, 0)");
|
||||
// Selected, the backing carries the image's ring while the screenshot still loads (a changed screen's is its status).
|
||||
await page.goto(`${page.url().split("#")[0]}#/screens?screen=screen-1`);
|
||||
const selected = page.locator(".screens-cell .screen-screenshot-card.selected .screen-node-image");
|
||||
await expect(selected.locator("img")).toHaveAttribute("data-screenshot-state", "loading");
|
||||
const rings = await selected.evaluate(element => [element.querySelector("img"), element.querySelector(".screenshot-backing")]
|
||||
.map(node => getComputedStyle(node).boxShadow));
|
||||
assert.equal(rings[1], rings[0]);
|
||||
assert.notEqual(rings[1], "none");
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(slot.locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
assert.deepEqual(await height(), [waiting, waitingImage]);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a target switch blanks every card whose screenshot differs, never showing the other target's picture, and switching back reuses the kept pictures", { timeout: 90_000 }, async t => {
|
||||
const runtime = { platform: "android", platforms: ["ios", "android"] };
|
||||
const android = await changedScreensArchive(3, { seed: 1, runtime });
|
||||
const ios = await changedScreensArchive(3, { seed: 2, runtime: { ...runtime, platform: "ios" } });
|
||||
const preview = { token: "pqrstuvwxyz234567234567234567234", listing: [{ platform: "ios" }, { platform: "android" }],
|
||||
archives: { "?platform=ios": ios.bytes } };
|
||||
const { page, errors } = await harness(t, android.bytes, { app: true, reportIdentity: null, preview, query: "&platform=android" });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const cards = page.locator(".map-canvas img[data-screenshot-src]");
|
||||
await expect(cards).toHaveCount(3);
|
||||
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const shown = await cards.evaluateAll(images => Object.fromEntries(images.map(image => [image.getAttribute("src"), image.dataset.screenshotSrc])));
|
||||
// Hold iOS's screenshots back so the switch is caught while they load.
|
||||
await page.evaluate(sizes => {
|
||||
const digest = crypto.subtle.digest.bind(crypto.subtle);
|
||||
window.heldIos = [];
|
||||
window.releaseIos = () => window.heldIos.splice(0).forEach(release => release());
|
||||
window.holdIos = true;
|
||||
crypto.subtle.digest = (algorithm, data) => window.holdIos && sizes.includes(data.byteLength)
|
||||
? new Promise(resolve => window.heldIos.push(() => resolve(digest(algorithm, data)))) : digest(algorithm, data);
|
||||
}, ios.screens.flatMap(screen => [screen.before.bytes.length, screen.after.bytes.length]));
|
||||
// Every frame from the switch on: no card shows a picture under another screenshot's name, and a waiting one is hidden.
|
||||
await page.evaluate(shown => {
|
||||
window.staleFrames = [];
|
||||
window.sampling = true;
|
||||
const sample = () => {
|
||||
for (const image of document.querySelectorAll(".map-canvas img[data-screenshot-src]")) {
|
||||
const source = shown[image.getAttribute("src")];
|
||||
const opacity = Number(getComputedStyle(image).opacity);
|
||||
if (source && source !== image.dataset.screenshotSrc && opacity > 0) window.staleFrames.push({ source, named: image.dataset.screenshotSrc, opacity });
|
||||
if (image.dataset.screenshotState === "loading" && opacity > 0) window.staleFrames.push({ waiting: image.dataset.screenshotSrc, opacity });
|
||||
}
|
||||
if (window.sampling) requestAnimationFrame(sample);
|
||||
};
|
||||
requestAnimationFrame(sample);
|
||||
}, shown);
|
||||
await page.getByRole("button", { name: "Platform: Android. Open another platform's report" }).click();
|
||||
await page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio").nth(0).click();
|
||||
await page.waitForURL(url => new URL(url).searchParams.get("platform") === "ios");
|
||||
await expect(cards.first()).toHaveAttribute("data-screenshot-src", ios.screens[0].after.reference);
|
||||
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await page.waitForTimeout(200);
|
||||
await page.evaluate(() => { window.holdIos = false; window.releaseIos(); });
|
||||
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await page.evaluate(() => { window.sampling = false; });
|
||||
assert.deepEqual(await page.evaluate(() => window.staleFrames), [], "No frame showed Android's picture on iOS's cards, or a waiting picture");
|
||||
await expectBalancedUses(page, "After the switch, the iOS report counts only the cards' uses");
|
||||
|
||||
// Back to Android: its kept pictures come back without a new decode.
|
||||
const created = await page.evaluate(() => window.createdUrls.length);
|
||||
await page.goBack();
|
||||
await page.waitForURL(url => new URL(url).searchParams.get("platform") === "android");
|
||||
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const back = await cards.evaluateAll(images => Object.fromEntries(images.map(image => [image.getAttribute("src"), image.dataset.screenshotSrc])));
|
||||
assert.deepEqual(back, shown, "Android's cards show the Blob URLs they showed before");
|
||||
assert.equal(await page.evaluate(() => window.createdUrls.length), created, "nothing was decoded again");
|
||||
await expectBalancedUses(page, "After switching back, the Android report counts only the cards' uses");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a prefetch the reviewer steps onto starts at once when a slot is free, instead of waiting for a running read", { timeout: 20_000 }, async t => {
|
||||
const { page, errors } = await harness(t);
|
||||
const { bytes, shas } = await multiImageArchive(4);
|
||||
const result = await page.evaluate(async ({ bytes, identity, shas, probe }) => {
|
||||
const archive = await window.openReport(bytes, identity);
|
||||
const decodes = new Function(`return (${probe})()`)();
|
||||
const [shown, shownToo, next, nextToo] = shas.map(sha => archive.reference(sha));
|
||||
// The screen on show is still being read after the rest: the next screen's prefetches wait behind the reserve.
|
||||
const visible = [archive.resolve(shown, "eager"), archive.resolve(shownToo, "eager")];
|
||||
await decodes.until(() => decodes.held() === 2);
|
||||
const prefetched = [archive.resolve(next, "prefetch"), archive.resolve(nextToo, "prefetch")];
|
||||
await new Promise(resolve => setTimeout(resolve, 30));
|
||||
const heldBeforeStep = decodes.held();
|
||||
// The reviewer steps onto that screen: its reads start in the two free slots, beside the running ones.
|
||||
const stepped = [archive.resolve(next, "eager"), archive.resolve(nextToo, "eager")];
|
||||
await new Promise(resolve => setTimeout(resolve, 30));
|
||||
const heldAfterStep = decodes.held();
|
||||
decodes.all();
|
||||
await Promise.all([...visible, ...prefetched, ...stepped]);
|
||||
return { heldBeforeStep, heldAfterStep, shared: await prefetched[0] === await stepped[0] };
|
||||
}, { bytes, identity, shas, probe: decodeProbe.toString() });
|
||||
assert.equal(result.heldBeforeStep, 2, "The prefetches waited behind the reserve");
|
||||
assert.equal(result.heldAfterStep, 4, "Stepped onto, they started at once");
|
||||
assert.equal(result.shared, true);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a prefetch read that never finishes does not stop Compare reading the next screens ahead", { timeout: 90_000 }, async t => {
|
||||
const { bytes, screens } = await changedScreensArchive(5);
|
||||
const { page, errors } = await harness(t, bytes, { app: true, open: false, query: "&view=compare&screen=screen-1" });
|
||||
await recordScreenshotReads(page);
|
||||
// Screen-2's Before never finishes verifying.
|
||||
await page.evaluate(stuck => {
|
||||
const digest = crypto.subtle.digest.bind(crypto.subtle);
|
||||
const hex = buffer => Array.from(new Uint8Array(buffer), byte => byte.toString(16).padStart(2, "0")).join("");
|
||||
crypto.subtle.digest = async (algorithm, data) => {
|
||||
const value = await digest(algorithm, data);
|
||||
if (hex(value) === stuck) await new Promise(() => {});
|
||||
return value;
|
||||
};
|
||||
}, screens[1].before.sha256);
|
||||
await chooseFile(page, bytes);
|
||||
const compare = page.locator(".compare-section");
|
||||
await expect(compare.locator(".compare-frame img[data-screenshot-state='ready']")).toHaveCount(2);
|
||||
const prefetchesOf = screen => page.evaluate(references => window.reads.filter(read => read.priority === "prefetch" && references.includes(read.reference)).length,
|
||||
[screen.before.reference, screen.after.reference]);
|
||||
await expect.poll(() => prefetchesOf(screens[1])).toBe(2);
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(compare.locator(".compare-nav-position")).toHaveText(/^2 of 5$/);
|
||||
await expect.poll(() => prefetchesOf(screens[2])).toBe(2);
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(compare.locator(".compare-nav-position")).toHaveText(/^3 of 5$/);
|
||||
await expect.poll(() => prefetchesOf(screens[3])).toBe(2);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/** Opens Compare in Flip at `screen`, recording screenshot reads. */
|
||||
async function openFlip(t, bytes, screen) {
|
||||
const opened = await harness(t, bytes, { app: true, open: false, query: `&view=compare&screen=${screen}` });
|
||||
await opened.page.addInitScript(() => localStorage.setItem("expo-explore:compare-mode", "flip"));
|
||||
await opened.page.reload();
|
||||
await recordScreenshotReads(opened.page);
|
||||
return opened;
|
||||
}
|
||||
|
||||
/** Holds back verifying the screenshot with this hash until `window.releaseHeld()`. */
|
||||
const holdScreenshot = (page, sha256) => page.evaluate(held => {
|
||||
const digest = crypto.subtle.digest.bind(crypto.subtle);
|
||||
const hex = buffer => Array.from(new Uint8Array(buffer), byte => byte.toString(16).padStart(2, "0")).join("");
|
||||
const waiting = [];
|
||||
window.releaseHeld = () => waiting.splice(0).forEach(release => release());
|
||||
crypto.subtle.digest = async (algorithm, data) => {
|
||||
const value = await digest(algorithm, data);
|
||||
if (hex(value) === held) await new Promise(resolve => waiting.push(resolve));
|
||||
return value;
|
||||
};
|
||||
}, sha256);
|
||||
|
||||
test("Flip reads the next screen's Before when a step keeps the After it shows, which fires no load", { timeout: 90_000 }, async t => {
|
||||
// Screen-2 keeps screen-1's After beside a Before of its own.
|
||||
const { bytes, screens } = await changedScreensArchive(3, { sameAfter: { 1: 0 } });
|
||||
const { page, errors } = await openFlip(t, bytes, "screen-1");
|
||||
await chooseFile(page, bytes);
|
||||
const frame = page.locator(".compare-section .compare-flip-frame");
|
||||
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(page.locator(".compare-section .compare-nav-position")).toHaveText(/^2 of 3$/);
|
||||
await expect(frame.locator(".compare-flip-layer[data-side='before'] img")).toHaveAttribute("data-screenshot-src", screens[1].before.reference);
|
||||
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("Flip stepped from Before shows the next screen's After from its first frame and reads its Before only once After is ready", { timeout: 90_000 }, async t => {
|
||||
const { bytes, screens } = await changedScreensArchive(3);
|
||||
const { page, errors } = await openFlip(t, bytes, "screen-1");
|
||||
await chooseFile(page, bytes);
|
||||
const frame = page.locator(".compare-section .compare-flip-frame");
|
||||
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
|
||||
await page.keyboard.press("KeyX");
|
||||
await expect(frame).toHaveAttribute("data-side", "before");
|
||||
await holdScreenshot(page, screens[1].after.sha256);
|
||||
// Every frame from the step: which side the frame shows, and which layers are mounted.
|
||||
await page.evaluate(() => {
|
||||
window.flipFrames = [];
|
||||
const sample = () => {
|
||||
const element = document.querySelector(".compare-flip-frame");
|
||||
window.flipFrames.push({ route: document.querySelector(".compare-nav-route")?.textContent, side: element?.dataset.side,
|
||||
layers: [...(element?.querySelectorAll(".compare-flip-layer") ?? [])].map(layer => layer.dataset.side).join(",") });
|
||||
if (window.flipFrames.length < 20) requestAnimationFrame(sample);
|
||||
};
|
||||
requestAnimationFrame(sample);
|
||||
});
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect.poll(() => page.evaluate(() => window.flipFrames.length)).toBe(20);
|
||||
const stepped = (await page.evaluate(() => window.flipFrames)).filter(sample => sample.route === "/screen-2");
|
||||
assert.ok(stepped.length > 0);
|
||||
assert.deepEqual([...new Set(stepped.map(sample => `${sample.side}:${sample.layers}`))], ["after:after"],
|
||||
"From its first frame screen-2 shows After alone");
|
||||
const readsOf = reference => page.evaluate(reference => window.reads.filter(read => read.reference === reference && read.priority !== "prefetch").length, reference);
|
||||
assert.equal(await readsOf(screens[1].before.reference), 0, "Before waits for After");
|
||||
await page.evaluate(() => window.releaseHeld());
|
||||
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
@@ -318,7 +318,7 @@ test("Compare steps through changed screens and their changed areas", { timeout:
|
||||
/** The Inspector's one frame for a screen outside the review, and its Swipe frame for a changed one, in this viewport. */
|
||||
async function inspectorFrames(page, url) {
|
||||
const games = "expo-tabs-games-index-2c6605360b11";
|
||||
const index = "expo-index-02872ff9f2ca";
|
||||
const unchanged = "expo-tabs-scan-index-2bbf42237cc6";
|
||||
const open = async id => {
|
||||
await page.goto(`${url}#/screens`);
|
||||
const all = page.getByRole("button", { name: /^All/ }).first();
|
||||
@@ -333,14 +333,14 @@ async function inspectorFrames(page, url) {
|
||||
const swipeImage = page.locator(".sidebar-review-stage img").first();
|
||||
await expect(swipeImage).toBeVisible();
|
||||
const changed = await swipeImage.boundingBox();
|
||||
await open(index);
|
||||
await open(unchanged);
|
||||
const single = page.locator(".sidebar-review-off .variant-preview");
|
||||
await expect(single).toBeVisible();
|
||||
return { changed, single: await single.boundingBox() };
|
||||
}
|
||||
|
||||
test("the Inspector frames an unchanged screen at the size of a changed screen's Swipe frame", { timeout: 90_000 }, async t => {
|
||||
// / is unchanged (not compared); /games is modified. The single frame used to take at most half the panel, the
|
||||
// /scan is unchanged; /games is modified. The single frame used to take at most half the panel, the
|
||||
// width of one frame of a Before/After pair, while Swipe and Flip fill the panel up to 70 % (phone: 52 %) of the window.
|
||||
for (const viewport of [{ width: 1024, height: 820 }, { width: 390, height: 844 }]) {
|
||||
const { page, url, errors } = await openReport(t, viewport);
|
||||
|
||||
@@ -48,6 +48,8 @@ const entry = `
|
||||
import { useEffect, useState } from "react";
|
||||
import { createRoot } from "react-dom/client";
|
||||
import { ScreenshotImage } from "/src/components/shared/screenshot-image.tsx";
|
||||
// The Viewer's own rules hide a waiting screenshot and fade a ready one in.
|
||||
if (window.fixture.styles) await import("/src/styles.css");
|
||||
|
||||
function Harness() {
|
||||
const [state, setState] = useState(window.fixture);
|
||||
@@ -66,10 +68,13 @@ function Harness() {
|
||||
return <main style={{ position: "relative", height: state.layout === "scroll" ? 3300 : 300,
|
||||
width: 600, overflow: state.layout === "pan" ? "hidden" : undefined }}>
|
||||
{state.normalSource && <ScreenshotImage src={state.normalSource} alt="Hosted screenshot"
|
||||
width={24} height={18} decoding="async" onLoad={loaded} />}
|
||||
width={24} height={18} decoding="async" onLoad={loaded} {...(state.holdPrevious ? { holdPrevious: true } : {})}
|
||||
{...(state.fallback ? { fallback: <span data-testid="hosted-fallback">No hosted screenshot</span> } : {})} />}
|
||||
<div data-testid="positioner" style={{ position: "absolute", left: 20,
|
||||
top: state.layout === "scroll" ? 3000 : 30,
|
||||
transform: state.layout === "pan" ? "translateX(2500px)" : undefined }}>
|
||||
transform: state.layout === "pan" ? "translateX(2500px)" : undefined }}
|
||||
{...(state.instant ? { "data-screenshot-instant": "" } : {})}
|
||||
{...(state.thumbnail ? { className: "variant-thumbnail", "aria-selected": "false" } : {})}>
|
||||
{state.mounted !== false && <ScreenshotImage src={state.source} alt="Captured checkout"
|
||||
width={120} height={80} loading={state.loading} decoding="async" className="captured-image"
|
||||
data-screen="checkout" onLoad={loaded} onError={failed}
|
||||
@@ -106,6 +111,18 @@ async function fixture(t, options = {}) {
|
||||
response.end(firstImage);
|
||||
return;
|
||||
}
|
||||
// A hosted screenshot that is not there.
|
||||
if (request.url === "/__missing.png") {
|
||||
response.statusCode = 404;
|
||||
response.end("Not found");
|
||||
return;
|
||||
}
|
||||
// A hosted screenshot that takes a while to arrive.
|
||||
if (request.url === "/__slow.png") {
|
||||
response.setHeader("Content-Type", "image/png");
|
||||
setTimeout(() => response.end(secondImage), 600);
|
||||
return;
|
||||
}
|
||||
if (request.url !== "/") return next();
|
||||
response.setHeader("Content-Type", "text/html");
|
||||
response.end('<!doctype html><html><head><style>body{margin:0}</style></head><body><div id="root"></div><script type="module" src="/__screenshot_image.tsx"></script></body></html>');
|
||||
@@ -163,7 +180,15 @@ async function fixture(t, options = {}) {
|
||||
window.pendingScreenshots.delete(source);
|
||||
for (const { reject } of pending) reject(new Error("Screenshot resolution failed"));
|
||||
};
|
||||
if (fixture.decode === "manual") {
|
||||
// The test settles each decode; one it never settles stands in for a decode that hangs.
|
||||
window.pendingDecodes = [];
|
||||
HTMLImageElement.prototype.decode = function () {
|
||||
return new Promise((resolve, reject) => window.pendingDecodes.push({ image: this, resolve, reject }));
|
||||
};
|
||||
}
|
||||
}, { source: firstSource, layout: "visible", ...options });
|
||||
if (options.reducedMotion) await page.emulateMedia({ reducedMotion: "reduce" });
|
||||
await page.goto(`http://127.0.0.1:${address.port}/`);
|
||||
await page.waitForFunction(() => window.harnessReady);
|
||||
return { page, image: page.getByRole("img", { name: "Captured checkout", exact: true }) };
|
||||
@@ -505,3 +530,187 @@ test("an image that leaves and re-enters the viewport within one render is ready
|
||||
await expect(image).not.toHaveAttribute("aria-busy", /.*/);
|
||||
assert.equal(await page.evaluate(() => window.imageLoads.length), 1, "No second load event fired");
|
||||
});
|
||||
|
||||
/** The image's opacity and state in each of the next `frames` frames, from the frame after `change` runs. */
|
||||
async function framesAfter(page, change, frames = 4, selector = "img[alt='Captured checkout']") {
|
||||
return page.evaluate(({ change, frames, selector }) => new Promise(resolve => {
|
||||
const samples = [];
|
||||
new Function(change)();
|
||||
const sample = () => {
|
||||
const image = document.querySelector(selector);
|
||||
samples.push(image ? { source: image.dataset.screenshotSrc ?? image.getAttribute("src"),
|
||||
state: image.dataset.screenshotState, opacity: getComputedStyle(image).opacity } : undefined);
|
||||
if (samples.length < frames) requestAnimationFrame(sample);
|
||||
else resolve(samples);
|
||||
};
|
||||
requestAnimationFrame(sample);
|
||||
}), { change, frames, selector });
|
||||
}
|
||||
|
||||
/** The reveal animation on the image, paused and sought to `at` milliseconds: its opacity there. */
|
||||
async function revealOpacityAt(image, at) {
|
||||
return image.evaluate((element, at) => {
|
||||
const [animation] = element.getAnimations().filter(animation => animation.animationName === "screenshot-reveal");
|
||||
if (!animation) return undefined;
|
||||
animation.pause();
|
||||
animation.currentTime = at;
|
||||
return Number(getComputedStyle(element).opacity);
|
||||
}, at);
|
||||
}
|
||||
|
||||
test("a waiting screenshot is hidden from its first frame, and one that fills its empty frame fades in", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true });
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
|
||||
await expect(image).toHaveCSS("opacity", "0");
|
||||
await resolveImage(page, firstSource);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
|
||||
assert.equal(await revealOpacityAt(image, 0), 0, "The fade starts from nothing");
|
||||
const midway = await revealOpacityAt(image, 80);
|
||||
assert.ok(midway > 0 && midway < 1, `Halfway through the fade the picture is partly shown (${midway})`);
|
||||
await image.evaluate(element => element.getAnimations().forEach(animation => animation.finish()));
|
||||
await expect(image).toHaveCSS("opacity", "1");
|
||||
|
||||
// Another source: the picture before is hidden in the very frame the new source lands, never faded out.
|
||||
const samples = await framesAfter(page, `window.updateScreenshot({ source: ${JSON.stringify(secondSource)} })`);
|
||||
const landed = samples.filter(sample => sample?.source === secondSource);
|
||||
assert.ok(landed.length > 0, "The new source landed within a few frames");
|
||||
assert.deepEqual(landed.map(sample => sample.opacity), landed.map(() => "0"));
|
||||
assert.deepEqual(samples.filter(sample => sample?.source !== secondSource).map(sample => sample.opacity),
|
||||
samples.filter(sample => sample?.source !== secondSource).map(() => "1"), "Until then, the shown picture is the one it names");
|
||||
assert.deepEqual(await image.evaluate(element => element.getAnimations().map(animation => animation.constructor.name)), [],
|
||||
"Nothing animates the hiding");
|
||||
});
|
||||
|
||||
test("a loaded screenshot is shown only once it has decoded, or after a short wait for a decode that hangs", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true, decode: "manual" });
|
||||
await resolveImage(page, firstSource);
|
||||
// The caller hears the load at once (Compare takes its shape from it); the picture waits for its pixels.
|
||||
await expect.poll(() => page.evaluate(() => window.imageLoads.length)).toBe(1);
|
||||
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
|
||||
await page.waitForTimeout(100);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await expect(image).toHaveCSS("opacity", "0");
|
||||
await page.evaluate(() => window.pendingDecodes.shift().resolve());
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
|
||||
|
||||
// A decode that never settles: shown anyway, with its fade.
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
|
||||
await resolveImage(page, secondSource, secondImage);
|
||||
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
|
||||
const loadedAt = await page.evaluate(() => performance.now());
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const waited = await page.evaluate(() => performance.now()) - loadedAt;
|
||||
assert.ok(waited >= 200, `The hung decode was waited for before the picture was shown (${Math.round(waited)}ms)`);
|
||||
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
|
||||
assert.equal(await image.evaluate(element => element.naturalWidth), 4);
|
||||
});
|
||||
|
||||
test("a screenshot the report still holds decoded fades in when it is shown again", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true });
|
||||
const url = await blobUrl(page, firstImage);
|
||||
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
|
||||
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url });
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
|
||||
// Shown again (Compare stepping back to it, a view mounting again) while the report still holds its decoded URL.
|
||||
await page.evaluate(() => window.updateScreenshot({ mounted: false }));
|
||||
await expect(image).toHaveCount(0);
|
||||
await page.evaluate(({ source, url }) => {
|
||||
window.immediateScreenshots.set(source, url);
|
||||
window.updateScreenshot({ mounted: true });
|
||||
}, { source: firstSource, url });
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
|
||||
assert.equal(await revealOpacityAt(image, 0), 0);
|
||||
});
|
||||
|
||||
test("an ordinary URL is a new image for each source and never shows the one before while it loads", { timeout: 30_000 }, async t => {
|
||||
const { page } = await fixture(t, { loading: "eager", styles: true, normalSource: "/__normal.png" });
|
||||
const hosted = page.getByRole("img", { name: "Hosted screenshot", exact: true });
|
||||
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(hosted).toHaveAttribute("data-screenshot-reveal", "");
|
||||
await hosted.evaluate(element => { element.dataset.first = "true"; });
|
||||
|
||||
const samples = await framesAfter(page, "window.updateScreenshot({ normalSource: '/__slow.png' })", 6, "img[alt='Hosted screenshot']");
|
||||
const landed = samples.filter(sample => sample?.source === "/__slow.png");
|
||||
assert.ok(landed.length > 0);
|
||||
assert.deepEqual(landed.map(sample => [sample.state, sample.opacity]), landed.map(() => ["loading", "0"]));
|
||||
await expect(hosted).not.toHaveAttribute("data-first", /.*/);
|
||||
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(hosted).toHaveAttribute("data-screenshot-reveal", "");
|
||||
await expectDecoded(hosted, 4, 5);
|
||||
});
|
||||
|
||||
test("a held picture stays shown while its replacement loads, and the replacement appears without a fade", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true, holdPrevious: true, fallback: true });
|
||||
await resolveImage(page, firstSource);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
|
||||
await expect(image).toHaveAttribute("data-screenshot-held", "");
|
||||
await expect(image).toHaveCSS("opacity", "1");
|
||||
await resolveImage(page, secondSource, secondImage);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expectDecoded(image, 4, 5);
|
||||
await expect(image).not.toHaveAttribute("data-screenshot-reveal", /.*/);
|
||||
await expect(image).not.toHaveAttribute("data-screenshot-held", /.*/);
|
||||
assert.deepEqual(await image.evaluate(element => element.getAnimations().length), 0);
|
||||
});
|
||||
|
||||
test("inside an instant stage a picture appears at once", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true, instant: true });
|
||||
await resolveImage(page, firstSource);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(image).not.toHaveAttribute("data-screenshot-reveal", /.*/);
|
||||
await expect(image).toHaveCSS("opacity", "1");
|
||||
});
|
||||
|
||||
test("with reduced motion a screenshot appears without a fade", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true, reducedMotion: true });
|
||||
await resolveImage(page, firstSource);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
// The Viewer's reduced-motion rule leaves every transition a hundredth of a millisecond long; the fade is gone.
|
||||
assert.deepEqual(await image.evaluate(element => element.getAnimations().map(animation => animation.animationName).filter(Boolean)), []);
|
||||
await expect(image).toHaveCSS("opacity", "1");
|
||||
});
|
||||
|
||||
test("an unselected variant thumbnail that changes source hides at once, despite its own dimmed opacity and its transition", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true, thumbnail: true });
|
||||
await resolveImage(page, firstSource);
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await image.evaluate(element => element.getAnimations().forEach(animation => animation.finish()));
|
||||
await expect(image).toHaveCSS("opacity", "0.35");
|
||||
const samples = await framesAfter(page, `window.updateScreenshot({ source: ${JSON.stringify(secondSource)} })`);
|
||||
const landed = samples.filter(sample => sample?.source === secondSource);
|
||||
assert.ok(landed.length > 0);
|
||||
assert.deepEqual(landed.map(sample => sample.opacity), landed.map(() => "0"));
|
||||
});
|
||||
|
||||
test("an ordinary URL that cannot be loaded shows the fallback, and a held one gives way to it", { timeout: 30_000 }, async t => {
|
||||
const { page } = await fixture(t, { loading: "eager", styles: true, fallback: true, holdPrevious: true, normalSource: "/__normal.png" });
|
||||
const hosted = page.getByRole("img", { name: "Hosted screenshot", exact: true });
|
||||
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
|
||||
// The app icon's case: a held picture whose replacement is missing ends on the fallback, not on the picture before.
|
||||
await page.evaluate(() => window.updateScreenshot({ normalSource: "/__missing.png" }));
|
||||
await expect(page.getByTestId("hosted-fallback")).toHaveText("No hosted screenshot");
|
||||
await expect(hosted).toHaveCount(0);
|
||||
// A new source tries again.
|
||||
await page.evaluate(() => window.updateScreenshot({ normalSource: "/__normal.png" }));
|
||||
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(page.getByTestId("hosted-fallback")).toHaveCount(0);
|
||||
});
|
||||
|
||||
test("re-rendering an image that waits for its decode starts no second wait", { timeout: 30_000 }, async t => {
|
||||
const { page, image } = await fixture(t, { loading: "eager", styles: true, decode: "manual" });
|
||||
await resolveImage(page, firstSource);
|
||||
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
|
||||
// Renders while the decode is pending find the image loaded but not shown yet.
|
||||
for (let render = 0; render < 5; render++) {
|
||||
await page.evaluate(render => window.updateScreenshot({ render }), render);
|
||||
await page.evaluate(() => new Promise(resolve => requestAnimationFrame(resolve)));
|
||||
}
|
||||
assert.equal(await page.evaluate(() => window.pendingDecodes.length), 1, "One decode wait for the one picture");
|
||||
await page.evaluate(() => window.pendingDecodes.shift().resolve());
|
||||
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
|
||||
});
|
||||
@@ -5,11 +5,13 @@ import { chromium, expect } from "@playwright/test";
|
||||
import { PNG } from "pngjs";
|
||||
import { createBrowserVite } from "../helpers/browser-vite.mjs";
|
||||
|
||||
function png(width, height, color) {
|
||||
function pngBytes(width, height, color) {
|
||||
const image = new PNG({ width, height });
|
||||
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
|
||||
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
|
||||
return PNG.sync.write(image);
|
||||
}
|
||||
const png = (width, height, color) => `data:image/png;base64,${pngBytes(width, height, color).toString("base64")}`;
|
||||
const GREEN = [40, 200, 40];
|
||||
|
||||
// Split over one screen with two changed areas and a card that moved 40% of the width right (at 60% in After, so
|
||||
// at 20% in Before), and a second screen with one changed area elsewhere. The status bar CI left out is a foldable's
|
||||
@@ -45,7 +47,9 @@ function Harness() {
|
||||
window.addEventListener("keydown", onKey);
|
||||
return () => window.removeEventListener("keydown", onKey);
|
||||
}, []);
|
||||
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: window.before, afterScreenshot: window.after };
|
||||
// The second screen has screenshots of its own when the test gives it some.
|
||||
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: screen && window.nextBefore || window.before,
|
||||
afterScreenshot: screen && window.nextAfter || window.after };
|
||||
return (
|
||||
<div className={"compare-stage mode-" + mode} style={{ width: 800, height: 500, display: "flex" }}>
|
||||
<CompareStage key="stage" mode={mode} diff={diff} title="Share" areas={screens[screen]} activeArea={active}
|
||||
@@ -57,7 +61,7 @@ function Harness() {
|
||||
createRoot(document.getElementById("root")).render(<Harness />);
|
||||
`;
|
||||
|
||||
async function openSplit(t, contextOptions = {}) {
|
||||
async function openSplit(t, contextOptions = {}, images = {}) {
|
||||
const vite = await createBrowserVite(t, {
|
||||
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
|
||||
logLevel: "error", esbuild: { jsx: "automatic" },
|
||||
@@ -67,6 +71,12 @@ async function openSplit(t, contextOptions = {}) {
|
||||
load: id => id === "/__split-outlines.tsx" ? entry : undefined,
|
||||
configureServer(server) {
|
||||
server.middlewares.use((request, response, next) => {
|
||||
// The next screen's Before, which takes a while to arrive.
|
||||
if (request.url === "/__slow-before.png") {
|
||||
response.setHeader("Content-Type", "image/png");
|
||||
setTimeout(() => response.end(pngBytes(100, 100, GREEN)), 1000);
|
||||
return;
|
||||
}
|
||||
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
|
||||
response.setHeader("Content-Type", "text/html");
|
||||
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__split-outlines.tsx"></script></body></html>');
|
||||
@@ -82,7 +92,7 @@ async function openSplit(t, contextOptions = {}) {
|
||||
const errors = [];
|
||||
page.on("pageerror", error => errors.push(error.message));
|
||||
t.after(() => assert.deepEqual(errors, []));
|
||||
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
|
||||
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]), ...images });
|
||||
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
|
||||
const outline = (side, index) => page.locator(`[data-side="${side}"] .visual-change-outline`).nth(index);
|
||||
await expect(outline("after", 0)).toBeVisible();
|
||||
@@ -143,3 +153,34 @@ test("A screen without hover keeps Before's outlines, as it cannot reveal one",
|
||||
await expect.poll(() => opacity(outline("before", 0))).toBe(1);
|
||||
await expect.poll(() => opacity(outline("before", 2))).toBe(1);
|
||||
});
|
||||
|
||||
test("Stepping never shows the screen before's pictures under the next one's outlines: a side still loading is an empty frame", { timeout: 30_000 }, async t => {
|
||||
const images = { before: png(100, 100, [200, 40, 40]), after: png(100, 100, [40, 40, 200]),
|
||||
nextBefore: "/__slow-before.png", nextAfter: png(100, 100, [200, 200, 40]) };
|
||||
const { page } = await openSplit(t, {}, images);
|
||||
for (const side of ["before", "after"]) await expect(page.locator(`[data-side="${side}"] img`)).toHaveAttribute("data-screenshot-state", "ready");
|
||||
// Every frame from the step on: the screen the outlines belong to, and any picture of the screen before still showing.
|
||||
await page.evaluate(previous => {
|
||||
window.stepFrames = [];
|
||||
const sample = () => {
|
||||
const outlines = document.querySelectorAll('[data-side="after"] .visual-change-outline').length;
|
||||
const stale = [...document.querySelectorAll(".compare-frame img")].filter(image => previous.includes(image.getAttribute("src"))
|
||||
&& Number(getComputedStyle(image).opacity) > 0).length;
|
||||
window.stepFrames.push({ outlines, stale });
|
||||
if (window.stepFrames.length < 30) requestAnimationFrame(sample);
|
||||
};
|
||||
requestAnimationFrame(sample);
|
||||
}, [images.before, images.after]);
|
||||
await page.keyboard.press("n");
|
||||
await expect.poll(() => page.evaluate(() => window.stepFrames.length)).toBe(30);
|
||||
const frames = await page.evaluate(() => window.stepFrames);
|
||||
assert.ok(frames.some(frame => frame.outlines === 1), "The step landed while the frames were sampled");
|
||||
assert.deepEqual(frames.filter(frame => frame.outlines === 1 && frame.stale > 0), [], "No frame showed a picture of the screen before under the next one's outlines");
|
||||
|
||||
// Before is still loading: its frame is empty, After's shows the new screen.
|
||||
const before = page.locator('[data-side="before"] img');
|
||||
await expect(before).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await expect(before).toHaveCSS("opacity", "0");
|
||||
await expect(page.locator('[data-side="after"] img')).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(before).toHaveAttribute("data-screenshot-state", "ready", { timeout: 5000 });
|
||||
});
|
||||
@@ -5,11 +5,15 @@ import { chromium, expect } from "@playwright/test";
|
||||
import { PNG } from "pngjs";
|
||||
import { createBrowserVite } from "../helpers/browser-vite.mjs";
|
||||
|
||||
function png(width, height, color) {
|
||||
function pngBytes(width, height, color) {
|
||||
const image = new PNG({ width, height });
|
||||
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
|
||||
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
|
||||
return PNG.sync.write(image);
|
||||
}
|
||||
const png = (width, height, color) => `data:image/png;base64,${pngBytes(width, height, color).toString("base64")}`;
|
||||
|
||||
const RED = [200, 40, 40];
|
||||
const BLUE = [40, 40, 200];
|
||||
|
||||
// A card that moved 40% of the width right: it is at 60% in After, so it was at 20% in Before.
|
||||
const entry = `
|
||||
@@ -19,11 +23,11 @@ import "/src/styles.css";
|
||||
const changes = [{ x: 60, y: 30, width: 30, height: 30, share: 100, regionCount: 1,
|
||||
move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } }];
|
||||
createRoot(document.getElementById("root")).render(<div style={{ width: 400, display: "flex" }}>
|
||||
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={50} />
|
||||
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={window.position ?? 50} />
|
||||
</div>);
|
||||
`;
|
||||
|
||||
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
|
||||
async function openSwipe(t, images) {
|
||||
const vite = await createBrowserVite(t, {
|
||||
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
|
||||
logLevel: "error", esbuild: { jsx: "automatic" },
|
||||
@@ -33,6 +37,12 @@ test("Swipe draws a moved area where its content was on Before's half and where
|
||||
load: id => id === "/__swipe-outlines.tsx" ? entry : undefined,
|
||||
configureServer(server) {
|
||||
server.middlewares.use((request, response, next) => {
|
||||
// A Before that takes a while to arrive.
|
||||
if (request.url === "/__slow-before.png") {
|
||||
response.setHeader("Content-Type", "image/png");
|
||||
setTimeout(() => response.end(pngBytes(100, 100, RED)), 1000);
|
||||
return;
|
||||
}
|
||||
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
|
||||
response.setHeader("Content-Type", "text/html");
|
||||
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__swipe-outlines.tsx"></script></body></html>');
|
||||
@@ -47,9 +57,23 @@ test("Swipe draws a moved area where its content was on Before's half and where
|
||||
const page = await browser.newPage({ viewport: { width: 600, height: 600 } });
|
||||
const errors = [];
|
||||
page.on("pageerror", error => errors.push(error.message));
|
||||
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
|
||||
t.after(() => assert.deepEqual(errors, []));
|
||||
await page.addInitScript(images => Object.assign(window, images), images);
|
||||
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
|
||||
return page;
|
||||
}
|
||||
|
||||
/** The colour on screen at `x` (a share of the frame's width), a fifth of the way down the Swipe frame, clear of the divider's handle. */
|
||||
async function colourAt(page, x) {
|
||||
const box = await page.locator(".visual-swipe").boundingBox();
|
||||
const shot = PNG.sync.read(await page.screenshot({ clip: { x: box.x + box.width * x, y: box.y + box.height / 5, width: 1, height: 1 } }));
|
||||
return [...shot.data.subarray(0, 3)];
|
||||
}
|
||||
|
||||
const near = (colour, expected) => colour.every((value, index) => Math.abs(value - expected[index]) <= 6);
|
||||
|
||||
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
|
||||
const page = await openSwipe(t, { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
|
||||
const frame = page.locator(".visual-swipe");
|
||||
const before = page.locator(".visual-swipe-outlines.before .visual-change-outline.moved");
|
||||
const after = page.locator(".visual-swipe-outlines.after .visual-change-outline.moved");
|
||||
@@ -60,5 +84,28 @@ test("Swipe draws a moved area where its content was on Before's half and where
|
||||
// Each side's outlines show only over its own half of the frame.
|
||||
const clips = await page.locator(".visual-swipe-outlines").evaluateAll(spans => spans.map(span => getComputedStyle(span).clipPath));
|
||||
assert.deepEqual(clips.map(clip => clip.startsWith("inset(")), [true, true]);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("Swipe never shows After on Before's half: while Before loads, its half is the empty frame", { timeout: 30_000 }, async t => {
|
||||
const page = await openSwipe(t, { before: "/__slow-before.png", after: png(100, 100, BLUE) });
|
||||
const before = page.locator("img.visual-swipe-before");
|
||||
await expect(page.locator("img.visual-swipe-after")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(before).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
|
||||
assert.ok(near(await colourAt(page, 0.75), BLUE), "After shows on its own half");
|
||||
const waiting = await colourAt(page, 0.25);
|
||||
assert.ok(!near(waiting, BLUE) && !near(waiting, RED), `Before's half is the empty frame while Before loads: ${waiting}`);
|
||||
await expect(before).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
|
||||
assert.ok(near(await colourAt(page, 0.25), RED));
|
||||
assert.ok(near(await colourAt(page, 0.75), BLUE));
|
||||
});
|
||||
|
||||
for (const [position, shown] of [[0, BLUE], [100, RED]]) {
|
||||
test(`Swipe at ${position}% shows only ${position ? "Before" : "After"}, across the whole frame`, { timeout: 30_000 }, async t => {
|
||||
const page = await openSwipe(t, { before: png(100, 100, RED), after: png(100, 100, BLUE), position });
|
||||
for (const side of ["before", "after"]) await expect(page.locator(`img.visual-swipe-${side}`)).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
|
||||
for (const x of [0.03, 0.5, 0.97]) assert.ok(near(await colourAt(page, x), shown), `${position}%: ${x} of the way across`);
|
||||
});
|
||||
}
|
||||
+134
-3
@@ -1254,7 +1254,7 @@ test("does not send viewer cookies to a cross-origin static workspace", async ({
|
||||
|
||||
test("the logo returns to the Map root", async ({ page }) => {
|
||||
await page.goto("/screens?screen=settings-root");
|
||||
await page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true }).click();
|
||||
await page.locator(".left-panel-collapsed-pill").getByRole("button", { name: /^Map of / }).click();
|
||||
await expect(page).toHaveURL(/\/map$/);
|
||||
await expect(page.locator(".map-canvas")).toBeVisible();
|
||||
});
|
||||
@@ -2811,7 +2811,7 @@ test("floats the pill over the canvas and remembers the Inspector across a reloa
|
||||
expect(expandedCameraShadow).not.toBe("none");
|
||||
const collapsedPanel = page.locator(".left-panel.collapsed");
|
||||
await expect(collapsedPanel).toBeVisible();
|
||||
await expect(collapsedPanel.getByRole("button", { name: "Map", exact: true })).toBeVisible();
|
||||
await expect(collapsedPanel.getByRole("button", { name: /^Map of / })).toBeVisible();
|
||||
await expect(collapsedPanel.locator(".collapsed-app-identity strong")).toBeVisible();
|
||||
// There is no sidebar to open: the pill is the only left chrome.
|
||||
await expect(page.getByRole("button", { name: /^(Expand|Collapse) panel$/ })).toHaveCount(0);
|
||||
@@ -3076,7 +3076,7 @@ test("keeps fixed objects and canvas pan after a reload", async ({ page }) => {
|
||||
|
||||
test("delays the first tooltip, then shows subsequent tooltips instantly", async ({ page }) => {
|
||||
await page.goto("/map");
|
||||
const menu = page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true });
|
||||
const menu = page.locator(".left-panel-collapsed-pill").getByRole("button", { name: /^Map of / });
|
||||
const changes = page.getByRole("button", { name: "Fit canvas", exact: true });
|
||||
const tooltip = page.locator(".tooltip");
|
||||
|
||||
@@ -3147,6 +3147,25 @@ test("Screens adds the screens a live map gains", async ({ page }) => {
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(30, { timeout: 7_000 });
|
||||
});
|
||||
|
||||
test("a local map keeps a screen whose capture gap was accepted on its Map, in Screens and in find", async ({ page }) => {
|
||||
// A public report leaves such a route out (omitted-screens.ts); a local run's screens are all its own.
|
||||
const payload = await liveMapPayload(3, 100);
|
||||
payload.map.gaps.push({ id: "accepted", screenId: "live-screen-2", kind: "coverage", status: "accepted",
|
||||
message: "Redirect declaration; no screenshot selected", createdAt: payload.map.run.createdAt });
|
||||
await serveMap(page, payload);
|
||||
await page.goto("/map");
|
||||
await expect(page.locator(".react-flow__node-screen")).toHaveCount(3);
|
||||
await page.goto("/screens");
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(3);
|
||||
await expect(page.locator('.screens-page .screens-tree-row[data-screen-id="live-screen-2"]')).toHaveCount(1);
|
||||
await page.keyboard.press("/");
|
||||
const field = page.getByRole("main", { name: "Screens" }).getByRole("searchbox", { name: "Find screens" });
|
||||
await expect(field).toBeFocused();
|
||||
await field.fill("screen 2");
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(1);
|
||||
await expect(page.locator('.screens-page .screens-cell[data-screen-id="live-screen-2"]')).toHaveCount(1);
|
||||
});
|
||||
|
||||
test("zooms Map inspection up to 25600% without exceeding the ceiling", async ({ page }) => {
|
||||
test.setTimeout(30_000);
|
||||
await page.goto("/map");
|
||||
@@ -3557,6 +3576,13 @@ test("the Map's top right holds only fit, center and zoom; theme and full screen
|
||||
await expect.poll(() => viewport.getAttribute("style")).not.toBe(panned);
|
||||
await expect.poll(async () => scaleFromTransform(await viewport.getAttribute("style")))
|
||||
.toBeCloseTo(pannedScale, 6);
|
||||
// The flight to the centre dips the scale on its way, and a drag interrupts it where it is: let it
|
||||
// land first, the camera unchanged across two frames. The check above can pass on the flight's
|
||||
// first frame, before the dip shows.
|
||||
await expect.poll(() => viewport.evaluate((element) => new Promise<boolean>((resolve) => {
|
||||
const before = element.getAttribute("style");
|
||||
requestAnimationFrame(() => requestAnimationFrame(() => resolve(element.getAttribute("style") === before)));
|
||||
}))).toBe(true);
|
||||
|
||||
// The keyboard shortcut performs the same scale-preserving camera action.
|
||||
await page.mouse.move(panPoint.x, panPoint.y);
|
||||
@@ -4413,6 +4439,93 @@ test("pull-request comment deep links open the Changes filter and a surface's Di
|
||||
expect(new URL(page.url()).searchParams.get("workspace")).toBe(workspaceUrl);
|
||||
});
|
||||
|
||||
/**
|
||||
* Records, every frame, the route Compare names and the screenshots it shows: those at any opacity above nothing,
|
||||
* not on a hidden Flip side. An image still loading counts as the source it had before, which the browser keeps
|
||||
* painting until the new one is there. `staleCompareFrames` then checks each frame showed only its own screen's.
|
||||
*/
|
||||
async function sampleCompareFrames(page: Page, root: string) {
|
||||
await page.evaluate((root) => {
|
||||
const record = window as unknown as { compareFrames: { route: string; shown: string[] }[]; sampling: boolean };
|
||||
record.compareFrames = [];
|
||||
record.sampling = true;
|
||||
const sample = () => {
|
||||
const scope = document.querySelector(root);
|
||||
const route = scope?.querySelector(".compare-nav-route")?.textContent ?? "";
|
||||
const shown = [...(scope?.querySelectorAll<HTMLImageElement>(".compare-stage img") ?? [])]
|
||||
.filter((image) => Number(getComputedStyle(image).opacity) > 0 && getComputedStyle(image).visibility !== "hidden")
|
||||
.map((image) => image.complete && image.naturalWidth > 0 ? image.getAttribute("src") ?? "" : "(still loading)");
|
||||
record.compareFrames.push({ route, shown });
|
||||
if (record.sampling) requestAnimationFrame(sample);
|
||||
};
|
||||
requestAnimationFrame(sample);
|
||||
}, root);
|
||||
}
|
||||
|
||||
/** Every screenshot the stage holds for the route on show, once its pictures have loaded. */
|
||||
async function settledCompareScreen(page: Page, root: string) {
|
||||
const stage = page.locator(`${root} .compare-stage`);
|
||||
await expect(stage.locator("img[data-screenshot-state='loading']")).toHaveCount(0);
|
||||
return stage.evaluate((element, root) => ({
|
||||
route: document.querySelector(root)?.querySelector(".compare-nav-route")?.textContent ?? "",
|
||||
sources: [...element.querySelectorAll("img")].map((image) => image.getAttribute("src") ?? ""),
|
||||
}), root);
|
||||
}
|
||||
|
||||
/** The sampled frames in which a picture showed under a route it does not belong to. */
|
||||
async function staleCompareFrames(page: Page, screens: { route: string; sources: string[] }[]) {
|
||||
const frames = await page.evaluate(() => {
|
||||
const record = window as unknown as { compareFrames: { route: string; shown: string[] }[]; sampling: boolean };
|
||||
record.sampling = false;
|
||||
return record.compareFrames;
|
||||
});
|
||||
const sources = new Map<string, Set<string>>();
|
||||
for (const screen of screens) sources.set(screen.route, new Set([...(sources.get(screen.route) ?? []), ...screen.sources]));
|
||||
expect(new Set(frames.map((frame) => frame.route)).size, "The steps were sampled").toBeGreaterThan(1);
|
||||
return frames.filter((frame) => frame.shown.some((source) => !sources.get(frame.route)?.has(source)));
|
||||
}
|
||||
|
||||
test("a screenshot whose URL cannot be loaded shows No screenshot in its frame on the Map and in the Inspector", async ({ page }) => {
|
||||
await page.route((url) => url.pathname === "/api/artifacts/artifacts/area-0-screen-1-0.svg", (route) => route.fulfill({ status: 404, body: "" }));
|
||||
await page.goto("/map");
|
||||
const card = (title: string) => page.locator(".map-canvas .react-flow__node").filter({ hasText: title }).locator(".screen-node-image");
|
||||
const missing = card("/onboarding-step-2").locator(".image-placeholder");
|
||||
await expect(missing).toContainText("No screenshot");
|
||||
await expect(card("/onboarding-step-2").locator("img")).toHaveCount(0);
|
||||
// The placeholder takes the frame the screenshot would have had, like the screenshot beside it.
|
||||
const neighbour = card("/onboarding-step-1").locator("img");
|
||||
await expect(neighbour).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const size = (locator: Locator) => locator.evaluate((element) => [element.offsetWidth, element.offsetHeight]);
|
||||
expect(await size(missing)).toEqual(await size(neighbour));
|
||||
await expect(card("/onboarding-step-2").locator(".screenshot-backing")).toHaveCSS("visibility", "hidden");
|
||||
|
||||
await page.locator(".map-canvas .react-flow__node").filter({ hasText: "/onboarding-step-2" }).locator(".screen-screenshot-target").click();
|
||||
await expect(page.locator(".right-panel .inspector-preview .screenshot-placeholder")).toContainText("No screenshot");
|
||||
});
|
||||
|
||||
test("stepping Compare by key or by its buttons never shows the screen before's pictures under the next one's name", async ({ page }) => {
|
||||
await page.setViewportSize({ width: 1440, height: 860 });
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/compare?screen=current-profile");
|
||||
const root = ".compare-section";
|
||||
const bar = page.locator(`${root} .compare-bar`);
|
||||
await expect(bar).toBeVisible();
|
||||
for (const mode of ["1", "2", "3"]) {
|
||||
await page.keyboard.press(mode);
|
||||
const screens = [await settledCompareScreen(page, root)];
|
||||
await sampleCompareFrames(page, root);
|
||||
await page.keyboard.press("ArrowRight");
|
||||
screens.push(await settledCompareScreen(page, root));
|
||||
await bar.getByRole("button", { name: "Previous changed screen" }).click();
|
||||
screens.push(await settledCompareScreen(page, root));
|
||||
await bar.getByRole("button", { name: "Next changed screen" }).click();
|
||||
screens.push(await settledCompareScreen(page, root));
|
||||
await page.keyboard.press("ArrowLeft");
|
||||
screens.push(await settledCompareScreen(page, root));
|
||||
expect(await staleCompareFrames(page, screens), `Mode ${mode}`).toEqual([]);
|
||||
}
|
||||
});
|
||||
|
||||
test("desktop Compare: one command bar with the modes in it, even gaps to both bars", async ({ page }) => {
|
||||
await page.setViewportSize({ width: 1440, height: 860 });
|
||||
await serveWorkspace(page);
|
||||
@@ -4887,6 +5000,24 @@ test.describe("phone layout", () => {
|
||||
}
|
||||
});
|
||||
|
||||
test("stepping Compare from the header never shows the screen before's pictures under the next one's name", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/map");
|
||||
await page.getByRole("navigation", { name: "Views" }).getByRole("button", { name: /Compare/ }).tap();
|
||||
const root = ".phone-compare";
|
||||
const compare = page.locator(root);
|
||||
await expect(compare).toBeVisible();
|
||||
const next = compare.getByRole("button", { name: "Next changed screen" });
|
||||
const previous = compare.getByRole("button", { name: "Previous changed screen" });
|
||||
const screens = [await settledCompareScreen(page, root)];
|
||||
await sampleCompareFrames(page, root);
|
||||
for (const step of [next, next, previous]) {
|
||||
await step.tap();
|
||||
screens.push(await settledCompareScreen(page, root));
|
||||
}
|
||||
expect(await staleCompareFrames(page, screens)).toEqual([]);
|
||||
});
|
||||
|
||||
test("Compare is full screen, opens in Flip and steps from the header", async ({ page }) => {
|
||||
await serveWorkspace(page);
|
||||
await page.goto("/map");
|
||||
|
||||
@@ -159,7 +159,12 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
assert.ok(existsSync(join(request.cwd, '.expo-explore-observer/metro.config.cjs')), 'the staged copy carries the observer');
|
||||
assert.ok(!existsSync(join(request.cwd, '.git')), 'the staged copy has no repository');
|
||||
repackedSha = /build_id: "build-([0-9a-f]+)"/.exec(workflow)[1];
|
||||
return json({ jobs: [{ key: 'repack', status: 'SUCCESS', outputs: { build_id: `repacked-${repackedSha}`, platform } }] });
|
||||
// Explore waits on the run itself; the run's id carries the commit its repack is of.
|
||||
return json({ id: `run-${repackedSha}`, url: `https://expo.dev/accounts/acme/projects/example/workflows/run-${repackedSha}` });
|
||||
}
|
||||
if (command === 'workflow:view') {
|
||||
const sha = /^run-([0-9a-f]+)$/.exec(request.args[1])[1];
|
||||
return json({ id: request.args[1], status: 'SUCCESS', jobs: [{ id: `job-${sha}`, key: 'repack', status: 'SUCCESS', outputs: { build_id: `repacked-${sha}`, platform } }] });
|
||||
}
|
||||
if (command === 'simulator:start') {
|
||||
const id = `session-${++sessionCounter}`; currentSession = id; openFailed = false;
|
||||
@@ -169,6 +174,8 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
}
|
||||
if (command === 'simulator:get') { const session = sessions.get(value(request, '--id')); return json({ id: session.id, name: session.name, type: 'agent-device', platform: platform.toUpperCase(), status: 'IN_PROGRESS', app: { id: PROJECT_ID, slug: 'example', ownerAccount: { name: 'acme' } }, remoteConfig: { agentDeviceRemoteSessionUrl: `https://controller.example/${session.id}`, agentDeviceRemoteSessionToken: 'controller-private-token' } }); }
|
||||
if (command === 'simulator:stop') return json({ id: value(request, '--id'), status: 'STOPPED' });
|
||||
// The session's serve-sim offers no simulator:control actions, so the capture falls back to the controller's own.
|
||||
if (command === 'simulator:control' && request.args.includes('--list')) return json({});
|
||||
}
|
||||
if (basename(request.command) === 'repack-app') {
|
||||
repackedSha = git(request.cwd, 'rev-parse', 'HEAD');
|
||||
|
||||
@@ -293,7 +293,7 @@ test("action rejects unsupported Node versions before installing tools", async t
|
||||
test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it runs only for a requested hosted preview", () => {
|
||||
const deploy = review.jobs.deploy;
|
||||
assert.deepEqual(deploy.needs, ["targets", "capture", "report"]);
|
||||
assert.equal(deploy.if, "needs.capture.outputs.preview == 'eas'");
|
||||
assert.equal(deploy.if, "needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()");
|
||||
assert.deepEqual(deploy.permissions, { contents: "read", actions: "read", "pull-requests": "write" });
|
||||
const step = deploy.steps.find(step => step.name === "Deploy the hosted preview and publish its Explore report links");
|
||||
assert.equal(step.env.EXPO_TOKEN, "${{ secrets.EXPO_TOKEN }}");
|
||||
@@ -305,7 +305,8 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
|
||||
assert.deepEqual(downloads.map(step => step.with.pattern), ["explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*", "explore-review-${{ github.run_id }}-${{ github.run_attempt }}-*"]);
|
||||
assert.ok(downloads.every(step => step.with.name === undefined && step.with["merge-multiple"] === undefined));
|
||||
assert.doesNotMatch(JSON.stringify(deploy), /OPENAI_API_KEY|ANTHROPIC_API_KEY/);
|
||||
assert.equal(review.jobs.report.outputs, undefined);
|
||||
// A report job hands forward only whether it published; its artifact URL is looked up again (matrix outputs keep one leg's value).
|
||||
assert.deepEqual(review.jobs.report.outputs, { published: "${{ steps.publish.outputs.published }}" });
|
||||
// capture:review writes preview=<hosting> to the step outputs from the reviewed config.
|
||||
assert.equal(review.jobs.capture.outputs.preview, "${{ steps.capture.outputs.preview }}");
|
||||
assert.match(review.jobs.capture.steps.find(step => step.id === "capture").run, /capture:review/);
|
||||
@@ -314,6 +315,48 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
|
||||
assert.match(review.jobs.failure.if, /needs\.deploy\.result == 'failure'/);
|
||||
});
|
||||
|
||||
test("one target's failed capture keeps neither the other targets' reports nor the preview off the PR (brentvatne/euxy#172)", async t => {
|
||||
for (const workflow of [review, compare]) {
|
||||
const report = workflow.jobs.report;
|
||||
// A plain needs: [capture] skips every report once one capture leg fails; !cancelled() runs them, except in a cancelled run.
|
||||
assert.equal(report.if, "needs.targets.result == 'success' && !cancelled()");
|
||||
assert.deepEqual(report.needs, ["targets", "capture"]);
|
||||
const [download, check] = report.steps;
|
||||
assert.ok(download.uses.startsWith("actions/download-artifact@"));
|
||||
// A pattern without a wildcard names this leg's artifact alone, and matching nothing is not a failure, as a name is.
|
||||
assert.deepEqual(download.with, { pattern: "explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}", path: "${{ runner.temp }}/explore-review" });
|
||||
assert.equal(download["continue-on-error"], undefined, "a download that went wrong still fails the leg");
|
||||
assert.equal(check.id, "captured");
|
||||
const explore = report.steps.filter(step => /cli\.js" ci:(report|publish)/.test(step.run ?? "") || step.uses?.startsWith("actions/upload-artifact@") && step.if !== "always()");
|
||||
assert.equal(explore.length, 3);
|
||||
for (const step of explore) assert.equal(step.if, "steps.captured.outputs.found == 'true'", step.name);
|
||||
const publish = report.steps.find(step => step.id === "publish");
|
||||
assert.match(publish.run, /ci:publish[^\n]*\n\s*echo "published=true" >> "\$GITHUB_OUTPUT"/, "published only once ci:publish succeeded");
|
||||
assert.deepEqual(report.outputs, { published: "${{ steps.publish.outputs.published }}" });
|
||||
assert.equal(workflow.jobs.deploy.if, "needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()");
|
||||
assert.deepEqual(workflow.jobs.deploy.needs, ["targets", "capture", "report"]);
|
||||
// The check reads what the download left: this target's report input, or nothing.
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-report-check-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const runCheck = async () => {
|
||||
const output = join(root, "output"); await writeFile(output, "");
|
||||
const result = spawnSync("bash", ["-c", check.run], { encoding: "utf8", env: { ...process.env, RUNNER_TEMP: root, GITHUB_OUTPUT: output, TARGET: "duo-open" } });
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
return { output: await readFile(output, "utf8"), stdout: result.stdout };
|
||||
};
|
||||
const failed = await runCheck();
|
||||
assert.equal(failed.output, "");
|
||||
assert.match(failed.stdout, /The duo-open capture uploaded no review: its capture job failed/);
|
||||
await mkdir(join(root, "explore-review"), { recursive: true });
|
||||
await writeFile(join(root, "explore-review", "report-input.json"), "{}");
|
||||
assert.equal((await runCheck()).output, "found=true\n");
|
||||
}
|
||||
// The failure job still runs when a capture leg failed, and names that target from its diagnostics.
|
||||
const failure = review.jobs.failure;
|
||||
assert.match(failure.if, /^always\(\) && \(.*needs\.capture\.result == 'failure'.*needs\.report\.result == 'failure'/);
|
||||
for (const step of failure.steps.filter(step => step.uses?.startsWith("actions/download-artifact@"))) assert.equal(step["continue-on-error"], true, step.name);
|
||||
});
|
||||
|
||||
test("closing a pull request runs nothing: hosted previews stay until a developer deletes them", () => {
|
||||
assert.ok(!review.on.pull_request_target.types.includes("closed"));
|
||||
assert.doesNotMatch(review.jobs.targets.if, /closed/);
|
||||
@@ -360,6 +403,24 @@ test("review captures and reports each configured target in its own matrix job,
|
||||
}
|
||||
});
|
||||
|
||||
test("a review waits for the baseline run ci:find-baseline names, with the token's Actions read and nothing the PR head chooses", () => {
|
||||
for (const workflow of [review, compare]) {
|
||||
const steps = workflow.jobs.capture.steps;
|
||||
const find = steps.find(step => step.name === "Find optional exact-base evidence");
|
||||
const capture = steps.find(step => step.name === "Capture review");
|
||||
assert.equal(find["continue-on-error"], true, "a failed lookup never fails the review");
|
||||
assert.ok(steps.indexOf(find) < steps.indexOf(capture));
|
||||
// The run is the find step's output, chosen by the base commit and the default branch's baseline workflow; capture
|
||||
// checks it again before it waits.
|
||||
assert.equal(capture.env.EXPLORE_BASELINE_RUN, "${{ steps.cache.outputs.pending }}");
|
||||
assert.equal(capture.env.GITHUB_TOKEN, "${{ github.token }}", "the wait reads the run, its jobs and its artifact");
|
||||
assert.equal(workflow.jobs.capture.permissions.actions, "read");
|
||||
assert.equal(workflow.jobs.capture.permissions.contents, "read");
|
||||
}
|
||||
assert.deepEqual(compare.jobs.capture.permissions, { contents: "read", actions: "read" }, "the wait needs no permission a comparison did not have");
|
||||
assert.deepEqual(review.jobs.capture.permissions, { contents: "read", actions: "read", "pull-requests": "write" });
|
||||
});
|
||||
|
||||
test("compare reviews any two refs from a manual run or another workflow, with no pull request access", () => {
|
||||
for (const trigger of ["workflow_dispatch", "workflow_call"]) {
|
||||
assert.deepEqual(Object.keys(compare.on[trigger].inputs).sort(), ["base", "expires-in", "head", "scope"]);
|
||||
|
||||
@@ -201,6 +201,8 @@ test("Android fill uses Argent's fill and requires it to verify the text", async
|
||||
const snapshot = await run(["snapshot", ...flags("android")]);
|
||||
const node = snapshot.json.data.nodes.find(item => item.type === "TextField");
|
||||
assert.ok(node, "the rename fixture has an EditText");
|
||||
assert.equal(node.focused, true, "the focused field is marked, as agent-device marks it");
|
||||
assert.equal(snapshot.json.data.keyboardVisible, false, "whether a keyboard shows, which the Android tree cannot say, is passed on");
|
||||
assert.equal((await run(["fill", node.ref, ...flags("android"), "--", "Groove"])).exitCode, 0);
|
||||
assert.deepEqual(calls.find(call => call.tool === "fill").args, { udid: "emulator-5554", text: "Groove" });
|
||||
const unverified = await run(["fill", node.ref, ...flags("android"), "--", "Groove"]);
|
||||
@@ -439,6 +441,42 @@ test("a reader stuck on the dark panel after a fold is reset once more before th
|
||||
assert.equal(stuck.calls.filter(call => call.tool === "stop-all-simulator-servers").length, 2, "before the fold and once after, not in a loop");
|
||||
});
|
||||
|
||||
// brentvatne/euxy#172, review run 39348956443: the fold after capture restarted SpringBoard failed with this, before it ran.
|
||||
const DEPENDENCY_FAILED = "argent run fold failed: [Tool:fold] Service dependency failed: [SimulatorServer:74195B53-4DBC-4EAA-9991-F98E5BB86BA8] Timed out waiting for simulator-server to become ready";
|
||||
|
||||
test("a fold whose simulator-server did not start is sent again after a pause, and then folds", async () => {
|
||||
const lit = { activeScreen: 3, screen: { id: 3, panel: "inner panel", width: 2007, height: 2853 }, posture: "open", hingeAngle: 180 };
|
||||
const { run, calls, context } = harness("ios", { "list-devices": DUO_DEVICES, "ui-tree": DUO_OPEN_EDIT_LANE, "stop-all-simulator-servers": { stopped: [] },
|
||||
fold: [new ArgentCallError(DEPENDENCY_FAILED, true), lit] });
|
||||
const pauses = [];
|
||||
context.sleep = async milliseconds => { pauses.push(milliseconds); };
|
||||
assert.deepEqual((await run(["fold", "open", ...flags("ios")])).json.data, { action: "fold", pose: "open" });
|
||||
assert.equal(calls.filter(call => call.tool === "fold").length, 2);
|
||||
assert.deepEqual(pauses, [3_000], "one pause before the fold is sent again");
|
||||
});
|
||||
|
||||
test("a fold whose simulator-server never starts fails as it did before, after two more tries", async () => {
|
||||
const { run, calls, context } = harness("ios", { "list-devices": DUO_DEVICES, "ui-tree": DUO_OPEN_EDIT_LANE, "stop-all-simulator-servers": { stopped: [] },
|
||||
fold: new ArgentCallError(DEPENDENCY_FAILED, true) });
|
||||
const pauses = [];
|
||||
context.sleep = async milliseconds => { pauses.push(milliseconds); };
|
||||
const failed = await run(["fold", "open", ...flags("ios")]);
|
||||
assert.deepEqual(failed.json.error, { code: "ARGENT_TOOL_FAILED", message: DEPENDENCY_FAILED });
|
||||
assert.equal(calls.filter(call => call.tool === "fold").length, 3);
|
||||
assert.deepEqual(pauses, [3_000, 6_000]);
|
||||
});
|
||||
|
||||
test("a UI action that failed for another reason is still sent once, even when its message mentions a dependency", async () => {
|
||||
// Only the tool's own wrap counts: a nested tool's dependency failure is not this tool failing to start.
|
||||
for (const message of ["argent run gesture-tap failed: [Tool:gesture-tap] simulator-server answered 500",
|
||||
"argent run gesture-tap failed: [Tool:gesture-tap] [Tool:keyboard] Service dependency failed: [SimulatorServer:x] Timed out"]) {
|
||||
const { run, calls } = harness("ios", { "list-devices": IOS_DEVICES, "ui-tree": IOS_HOME, "gesture-tap": new ArgentCallError(message, true) });
|
||||
const pressed = await run(["press", "10", "10", ...flags("ios")]);
|
||||
assert.deepEqual(pressed.json.error, { code: "ARGENT_TOOL_FAILED", message });
|
||||
assert.equal(calls.filter(call => call.tool === "gesture-tap").length, 1, message);
|
||||
}
|
||||
});
|
||||
|
||||
test("an alert that is not the link prompt is left for capture to answer", async () => {
|
||||
const other = { ...IOS_HOME, alertVisible: true, foregroundApp: "com.apple.springboard",
|
||||
roots: [{ type: "Alert", label: "Delete all data?", frame: { x: 0.1, y: 0.4, width: 0.8, height: 0.2 }, children: [
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import test from 'node:test';
|
||||
import { readFile, readdir } from 'node:fs/promises';
|
||||
import { join } from 'node:path';
|
||||
import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from '@zip.js/zip.js';
|
||||
import { runPublicCi, runBaselineCi, captureBaseAfterWait } from '../../dist/ci/pipeline.js';
|
||||
import { readCaptureBundle } from '../../dist/review/capture-review.js';
|
||||
import { fixture } from '../helpers/public-ci-fixture.mjs';
|
||||
|
||||
const deferred = () => { let resolve, reject; const promise = new Promise((done, fail) => { resolve = done; reject = fail; }); return { promise, resolve, reject }; };
|
||||
const tick = () => new Promise(done => setImmediate(done));
|
||||
|
||||
/** The files of a baseline export, zipped as actions/upload-artifact uploads them. */
|
||||
async function zipDirectory(directory) {
|
||||
configure({ useWebWorkers: false });
|
||||
const writer = new ZipWriter(new Uint8ArrayWriter(), { useWebWorkers: false });
|
||||
for (const entry of await readdir(directory, { recursive: true, withFileTypes: true })) {
|
||||
if (!entry.isFile()) continue;
|
||||
const path = join(entry.parentPath, entry.name);
|
||||
await writer.add(path.slice(directory.length + 1), new Uint8ArrayReader(await readFile(path)));
|
||||
}
|
||||
return writer.close();
|
||||
}
|
||||
|
||||
test('base starts the moment the wait gives up, beside head, and a waited baseline is restored only once head has finished', async () => {
|
||||
const events = [];
|
||||
const run = ({ head, waited }) => captureBaseAfterWait({ waited: waited?.promise, head: head.promise, stopWaiting: () => events.push('stop waiting'),
|
||||
captureBase: async cache => { events.push(cache ? `base from ${cache}` : 'base captures'); } });
|
||||
// The baseline job failed while head was still capturing: base captures at once, in its own session.
|
||||
let head = deferred(), waited = deferred();
|
||||
let base = run({ head, waited });
|
||||
waited.resolve(undefined); await tick();
|
||||
assert.deepEqual(events, ['base captures'], 'base did not wait for head');
|
||||
head.resolve(); await base;
|
||||
// The baseline arrived first: restoring it needs head's runtime profile, so base starts after head.
|
||||
events.length = 0; head = deferred(); waited = deferred();
|
||||
base = run({ head, waited });
|
||||
waited.resolve('/runner/baseline-download'); await tick();
|
||||
assert.deepEqual(events, []);
|
||||
head.resolve(); await base;
|
||||
assert.deepEqual(events, ['base from /runner/baseline-download']);
|
||||
// Head failed while base still waited: the wait stops, and base never starts for a failed review.
|
||||
events.length = 0; head = deferred(); waited = deferred();
|
||||
base = run({ head, waited });
|
||||
head.reject(new Error('head capture failed')); await tick();
|
||||
assert.deepEqual(events, ['stop waiting']);
|
||||
waited.resolve(undefined); await base;
|
||||
assert.deepEqual(events, ['stop waiting'], 'base was not captured');
|
||||
// Without a wait, base starts as before.
|
||||
events.length = 0;
|
||||
await captureBaseAfterWait({ waited: undefined, head: new Promise(() => {}), stopWaiting: () => events.push('stop waiting'), captureBase: async () => { events.push('base captures'); } });
|
||||
assert.deepEqual(events, ['base captures']);
|
||||
});
|
||||
|
||||
test('head capture starts while the review waits for the baseline, and the waited baseline is restored for base', async t => {
|
||||
const f = await fixture(t, 'expo-router');
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const baseline = await runBaselineCi({ project: f.baseProject, sha: f.baseSha, output: join(f.root, 'baseline'), config: f.config, environment: f.environment, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
const before = f.requests.length;
|
||||
// The baseline finishes only once head capture has started a simulator session; were head held back by the wait,
|
||||
// the fallback would end it with no baseline after 20 s, and base would capture.
|
||||
const finished = deferred();
|
||||
let finishedBy;
|
||||
const fallback = setTimeout(() => { finishedBy ??= 'timeout'; finished.resolve(undefined); }, 20_000);
|
||||
t.after(() => clearTimeout(fallback));
|
||||
const runner = request => {
|
||||
if (request.args[0] === 'simulator:start' && !finishedBy) { finishedBy = 'head started'; setImmediate(() => finished.resolve(baseline.directory)); }
|
||||
return f.runner(request);
|
||||
};
|
||||
let waitSignal;
|
||||
const progress = [];
|
||||
const output = join(f.root, 'review');
|
||||
await runPublicCi({ baseProject: f.baseProject, headProject: f.headProject, pullRequestPath: f.pullRequestPath, output, config: f.config,
|
||||
environment: f.environment, transport: f.transport, runner, now: f.now, sleep: f.sleep, progress: line => progress.push(line),
|
||||
awaitBaseline: signal => { waitSignal = signal; return finished.promise; } });
|
||||
assert.equal(finishedBy, 'head started');
|
||||
assert.equal(f.requests.slice(before).filter(request => request.args[0] === 'simulator:start').length, 1, 'base reused the baseline instead of a second session');
|
||||
assert.ok(progress.includes(`base waits for the baseline run of ${f.baseSha.slice(0, 8)} still being captured; head captures meanwhile`));
|
||||
assert.ok(progress.includes(`base: found the baseline captures of ${f.baseSha.slice(0, 8)}`));
|
||||
const baselineBundle = await readCaptureBundle(baseline.directory);
|
||||
for (const [id, image] of Object.entries((await readCaptureBundle(join(output, 'base-export'))).images)) assert.deepEqual(image, baselineBundle.images[id]);
|
||||
assert.equal(JSON.parse(await readFile(join(output, 'execution.json'), 'utf8')).capture.baseFromCache, true);
|
||||
assert.equal(waitSignal.aborted, true, 'the wait is told to stop once the review is done');
|
||||
});
|
||||
|
||||
test('capture:review waits for the baseline run ci:find-baseline named, downloads its artifact, and restores base from it', async t => {
|
||||
const f = await fixture(t, 'expo-router');
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const baseline = await runBaselineCi({ project: f.baseProject, sha: f.baseSha, output: join(f.root, 'baseline'), config: f.config, environment: f.environment, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
const zip = await zipDirectory(baseline.directory);
|
||||
const actions = [];
|
||||
const transport = async (input, init = {}) => {
|
||||
const url = new URL(input);
|
||||
if (url.origin === 'https://blob.example') { actions.push('download'); assert.equal(init.headers?.authorization, undefined); return new Response(zip); }
|
||||
const path = url.pathname.replace('/repos/acme/example', '');
|
||||
if (path === '' || path.startsWith('/actions/runs/40') || path.startsWith('/actions/workflows/') || path.startsWith('/actions/artifacts/77')) actions.push(path);
|
||||
if (path === '') return Response.json({ default_branch: 'main' });
|
||||
if (path === '/actions/workflows/explore-baseline.yml') return Response.json({ id: 5 });
|
||||
if (path === '/actions/runs/40') return Response.json({ id: 40, status: 'in_progress', conclusion: null, workflow_id: 5, head_sha: f.baseSha, head_branch: 'main', event: 'push', head_repository: { full_name: 'acme/example' } });
|
||||
if (path === '/actions/runs/40/artifacts') return Response.json({ artifacts: [{ id: 77, name: url.searchParams.get('name'), expired: false, workflow_run: { id: 40 } }] });
|
||||
if (path === '/actions/artifacts/77/zip') return new Response(null, { status: 302, headers: { location: 'https://blob.example/77.zip' } });
|
||||
return f.transport(input, init);
|
||||
};
|
||||
const review = async (name, config) => {
|
||||
const before = f.requests.length; actions.length = 0;
|
||||
const output = join(f.root, name);
|
||||
const progress = [];
|
||||
await runPublicCi({ baseProject: f.baseProject, headProject: f.headProject, pullRequestPath: f.pullRequestPath, output, config,
|
||||
environment: { ...f.environment, EXPLORE_BASELINE_RUN: '40' }, transport, runner: f.runner, now: f.now, sleep: f.sleep, progress: line => progress.push(line) });
|
||||
return { output, progress, sessions: f.requests.slice(before).filter(request => request.args[0] === 'simulator:start').length };
|
||||
};
|
||||
const waited = await review('review', f.config);
|
||||
assert.deepEqual(actions, ['', '/actions/workflows/explore-baseline.yml', '/actions/runs/40', '/actions/runs/40/artifacts', '/actions/artifacts/77/zip', 'download']);
|
||||
assert.ok(waited.progress.includes(`base: downloaded the baseline of ${f.baseSha.slice(0, 8)} that run 40 captured`));
|
||||
assert.equal(waited.sessions, 1, 'base was restored from the downloaded baseline');
|
||||
assert.equal(JSON.parse(await readFile(join(waited.output, 'execution.json'), 'utf8')).capture.baseFromCache, true);
|
||||
const off = await review('review-no-wait', { ...f.config, capture: { ...f.config.capture, baselineWaitMinutes: 0 } });
|
||||
assert.deepEqual(actions, [], 'capture.baselineWaitMinutes: 0 never waits');
|
||||
assert.equal(off.sessions, 2, 'base captured itself');
|
||||
});
|
||||
@@ -0,0 +1,203 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtemp, readFile, readdir, rm, stat } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from "@zip.js/zip.js";
|
||||
|
||||
const { waitForBaselineArtifact, awaitPendingBaseline } = await import("../../dist/ci/baseline-wait.js");
|
||||
const { findPendingBaselineRun, findOptionalBaseline } = await import("../../dist/ci/workflow-steps.js");
|
||||
|
||||
const sha = "a".repeat(40);
|
||||
const environment = { GITHUB_REPOSITORY: "acme/app", GITHUB_TOKEN: "test-token" };
|
||||
const trustedRun = { id: 20, workflow_id: 77, head_sha: sha, head_branch: "main", event: "push", head_repository: { full_name: "acme/app" } };
|
||||
const job = (status, conclusion = null, target = "iphone") => ({ name: `baseline (${target})`, status, conclusion });
|
||||
|
||||
async function zipFiles(files) {
|
||||
configure({ useWebWorkers: false });
|
||||
const writer = new ZipWriter(new Uint8ArrayWriter(), { useWebWorkers: false });
|
||||
for (const [name, content] of Object.entries(files)) await writer.add(name, new Uint8ArrayReader(new TextEncoder().encode(content)));
|
||||
return writer.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* GitHub as a review's wait sees it: baseline run 20 of `sha`, whose state moves to the next of `states` each time the
|
||||
* run is read (the last one stays), and artifact 500 of the iphone target, served from a storage URL GitHub redirects to.
|
||||
*/
|
||||
function fakeGitHub({ states = [{}], run = {}, zip, runFailures = [], runs } = {}) {
|
||||
let poll = -1;
|
||||
const requests = [];
|
||||
const state = () => states[Math.min(Math.max(poll, 0), states.length - 1)];
|
||||
const transport = async (input, init = {}) => {
|
||||
const url = new URL(input);
|
||||
requests.push(`${url.pathname}${url.search}`);
|
||||
if (url.origin === "https://blob.example") {
|
||||
assert.equal(init.headers?.authorization, undefined, "the token never reaches the storage URL GitHub redirects to");
|
||||
return new Response(zip);
|
||||
}
|
||||
assert.equal(url.origin, "https://api.github.com");
|
||||
assert.equal(init.headers?.authorization, "Bearer test-token");
|
||||
const path = url.pathname;
|
||||
if (path === "/repos/acme/app") return Response.json({ default_branch: "main" });
|
||||
if (path === "/repos/acme/app/actions/workflows/explore-baseline.yml") return Response.json({ id: 77 });
|
||||
if (path === "/repos/acme/app/actions/artifacts") return Response.json({ artifacts: [] });
|
||||
if (path === "/repos/acme/app/actions/workflows/77/runs") {
|
||||
assert.equal(url.searchParams.get("head_sha"), sha);
|
||||
assert.equal(url.searchParams.get("branch"), "main");
|
||||
return Response.json({ workflow_runs: runs ?? [] });
|
||||
}
|
||||
if (path === "/repos/acme/app/actions/runs/20") {
|
||||
poll += 1;
|
||||
const failure = runFailures.shift();
|
||||
if (failure) return new Response("unavailable", { status: failure });
|
||||
return Response.json({ ...trustedRun, status: state().runStatus ?? "in_progress", conclusion: state().conclusion ?? null, ...run });
|
||||
}
|
||||
if (path === "/repos/acme/app/actions/runs/20/artifacts") {
|
||||
const name = url.searchParams.get("name");
|
||||
return Response.json({ artifacts: state().artifact && name === `explore-baseline-${sha}-iphone` ? [{ id: 500, name, expired: false, workflow_run: { id: 20 } }] : [] });
|
||||
}
|
||||
if (path === "/repos/acme/app/actions/runs/20/jobs") return Response.json({ jobs: [{ name: "targets", status: "completed", conclusion: "success" }, ...state().jobs ?? []] });
|
||||
if (path === "/repos/acme/app/actions/artifacts/500/zip") {
|
||||
assert.equal(init.redirect, "manual", "the redirect is followed by hand, without the token");
|
||||
return new Response(null, { status: 302, headers: { location: "https://blob.example/artifact.zip?sig=1" } });
|
||||
}
|
||||
throw new Error(`unexpected request ${url}`);
|
||||
};
|
||||
return { transport, requests, polls: () => poll + 1 };
|
||||
}
|
||||
|
||||
/** A clock the wait's pauses advance, so fifteen minutes of polling take no real time. */
|
||||
function clock() {
|
||||
let milliseconds = 0;
|
||||
return { now: () => milliseconds, sleep: async pause => { milliseconds += pause; }, elapsed: () => milliseconds };
|
||||
}
|
||||
|
||||
const waitOptions = (github, time, extra = {}) => ({ run: 20, sha, target: "iphone", timeoutMs: 15 * 60_000, environment, transport: github.transport,
|
||||
now: time.now, sleep: time.sleep, ...extra });
|
||||
|
||||
test("a baseline job in progress, then finished: the review reuses its artifact, downloaded and unpacked as download-artifact would", async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-baseline-wait-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const zip = await zipFiles({ "bundle.json": "{\"side\":\"head\"}", "cache-metadata.json": "{}", "screenshots/home.png": "png" });
|
||||
const github = fakeGitHub({ zip, states: [{ jobs: [] }, { jobs: [job("queued")] }, { jobs: [job("in_progress")] }, { jobs: [job("in_progress")] },
|
||||
{ jobs: [job("completed", "success")], artifact: true }] });
|
||||
const time = clock(); const lines = [];
|
||||
const directory = join(root, "review", "baseline-download");
|
||||
assert.equal(await awaitPendingBaseline({ ...waitOptions(github, time, { progress: line => lines.push(line) }), directory }), directory);
|
||||
assert.deepEqual((await readdir(directory, { recursive: true })).sort(), ["bundle.json", "cache-metadata.json", "screenshots", "screenshots/home.png"]);
|
||||
assert.equal(await readFile(join(directory, "screenshots/home.png"), "utf8"), "png");
|
||||
assert.equal(github.polls(), 5);
|
||||
assert.deepEqual(lines, [
|
||||
"waiting for main's baseline run 20 of aaaaaaaa (iphone: not started, 0 min)",
|
||||
"waiting for main's baseline run 20 of aaaaaaaa (iphone: queued, 0 min)",
|
||||
"waiting for main's baseline run 20 of aaaaaaaa (iphone: in progress, 0 min)",
|
||||
"waiting for main's baseline run 20 of aaaaaaaa (iphone: in progress, 1 min)",
|
||||
"base: downloaded the baseline of aaaaaaaa that run 20 captured",
|
||||
]);
|
||||
assert.ok(github.requests.every(request => !request.startsWith("/repos/acme/app/actions/runs/") || request.startsWith("/repos/acme/app/actions/runs/20")),
|
||||
"only the run ci:find-baseline named is read");
|
||||
assert.deepEqual((await readdir(join(root, "review"))).sort(), ["baseline-download"], "the downloaded zip is removed once unpacked");
|
||||
});
|
||||
|
||||
test("this target's artifact is reused although another target's baseline job failed (#48)", async () => {
|
||||
const github = fakeGitHub({ states: [{ jobs: [job("completed", "failure", "duo-open"), job("in_progress")] },
|
||||
{ runStatus: "completed", conclusion: "failure", jobs: [job("completed", "failure", "duo-open"), job("completed", "success")], artifact: true }] });
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(github, clock())), { artifact: { id: 500, run: 20 } });
|
||||
});
|
||||
|
||||
test("a baseline job that fails or is cancelled ends the wait, and the review captures the base itself", async t => {
|
||||
for (const [conclusion, reason] of [["failure", "its iphone job failed"], ["cancelled", "its iphone job was cancelled"], ["skipped", "its iphone job ended (skipped)"]]) {
|
||||
const github = fakeGitHub({ states: [{ jobs: [job("in_progress")] }, { jobs: [job("completed", conclusion)] }] });
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(github, clock())), { reason }, conclusion);
|
||||
}
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-baseline-wait-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const github = fakeGitHub({ states: [{ jobs: [job("in_progress")] }, { jobs: [job("completed", "failure")] }] });
|
||||
const lines = [];
|
||||
assert.equal(await awaitPendingBaseline({ ...waitOptions(github, clock(), { progress: line => lines.push(line) }), directory: join(root, "baseline-download") }), undefined);
|
||||
assert.equal(lines.at(-1), "base: stopped waiting for the baseline of aaaaaaaa (its iphone job failed); capturing the base too");
|
||||
assert.ok(!github.requests.some(request => request.includes("/zip")), "nothing is downloaded");
|
||||
await assert.rejects(stat(join(root, "baseline-download")), { code: "ENOENT" });
|
||||
});
|
||||
|
||||
test("a run that ends without this target's job, or a job whose artifact is never listed, ends the wait after a minute's grace", async () => {
|
||||
const ended = fakeGitHub({ states: [{ runStatus: "completed", conclusion: "failure", jobs: [] }] });
|
||||
const time = clock();
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(ended, time)), { reason: "the run ended (failure) without a iphone baseline job" });
|
||||
assert.equal(time.elapsed(), 60_000);
|
||||
const unlisted = fakeGitHub({ states: [{ jobs: [job("completed", "success")] }] });
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(unlisted, clock())), { reason: `its iphone job finished, but GitHub lists no explore-baseline-${sha}-iphone artifact` });
|
||||
});
|
||||
|
||||
test("the wait gives up at its time limit, polling every 20 s", async () => {
|
||||
const github = fakeGitHub({ states: [{ jobs: [job("in_progress")] }] });
|
||||
const time = clock(); const lines = [];
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(github, time, { progress: line => lines.push(line) })), { reason: "its iphone job is still in progress after 15 min" });
|
||||
assert.equal(time.elapsed(), 15 * 60_000);
|
||||
assert.equal(github.polls(), 15 * 3 + 1);
|
||||
assert.equal(lines.length, 15, "one line a minute, not one a poll");
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(fakeGitHub({ states: [{ jobs: [job("in_progress")] }] }), clock(), { timeoutMs: 50_000, pollMs: 30_000 })),
|
||||
{ reason: "its iphone job is still in progress after 1 min" }, "the last pause ends at the limit");
|
||||
});
|
||||
|
||||
test("only a baseline run of exactly the base commit, on the default branch of this repository, from a push or dispatch, is waited for", async () => {
|
||||
for (const mutation of [{ head_branch: "feature" }, { event: "pull_request_target" }, { event: "pull_request" }, { workflow_id: 99 },
|
||||
{ head_sha: "b".repeat(40) }, { head_repository: { full_name: "fork/app" } }]) {
|
||||
const github = fakeGitHub({ run: mutation, states: [{ jobs: [job("completed", "success")], artifact: true }] });
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(github, clock())), { reason: "run 20 is not a baseline run of aaaaaaaa on main" }, JSON.stringify(mutation));
|
||||
assert.ok(!github.requests.some(request => request.startsWith("/repos/acme/app/actions/runs/20/")), "nothing of an untrusted run is read");
|
||||
}
|
||||
const dispatched = fakeGitHub({ run: { event: "workflow_dispatch" }, states: [{ artifact: true }] });
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(dispatched, clock())), { artifact: { id: 500, run: 20 } });
|
||||
});
|
||||
|
||||
test("ci:find-baseline names a trusted baseline run still capturing the base commit, preferring the one already capturing", async () => {
|
||||
const run = (id, status, mutation = {}) => ({ ...trustedRun, id, status, conclusion: status === "completed" ? "success" : null, ...mutation });
|
||||
const lookup = runs => findPendingBaselineRun({ sha, target: "iphone", environment, transport: fakeGitHub({ runs }).transport });
|
||||
assert.deepEqual(await lookup([run(30, "completed"), run(31, "in_progress", { event: "pull_request_target" }), run(33, "queued"), run(32, "in_progress"),
|
||||
run(34, "in_progress", { head_branch: "feature" }), run(35, "in_progress", { head_repository: { full_name: "fork/app" } })]), { run: 32 });
|
||||
assert.deepEqual(await lookup([run(33, "queued"), run(36, "waiting")]), { run: 36 }, "otherwise the newest");
|
||||
assert.equal(await lookup([run(30, "completed"), run(31, "in_progress", { workflow_id: 99 })]), undefined);
|
||||
assert.deepEqual(await findOptionalBaseline({ sha, target: "iphone", environment, transport: fakeGitHub({ runs: [run(32, "in_progress")] }).transport }), { pending: { run: 32 } },
|
||||
"with no finished baseline to download");
|
||||
const outage = async input => new URL(input).pathname.endsWith("/77/runs") ? new Response("bad gateway", { status: 502 }) : fakeGitHub().transport(input, { headers: { authorization: "Bearer test-token" } });
|
||||
const failed = await findOptionalBaseline({ sha, target: "iphone", environment, transport: outage });
|
||||
assert.equal(failed.pending, undefined);
|
||||
assert.match(failed.warning.message, /^No baseline run in progress is waited for, so capture captures the base too: GitHub answered HTTP 502/);
|
||||
});
|
||||
|
||||
test("a GitHub 5xx while polling is retried, and a missing permission ends the wait without failing the review", async t => {
|
||||
const github = fakeGitHub({ runFailures: [0, 502, 503], states: [{ jobs: [job("in_progress")] }, { jobs: [job("in_progress")] }, { jobs: [job("in_progress")] }, { artifact: true }] });
|
||||
t.mock.method(process.stderr, "write", () => true);
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(github, clock())), { artifact: { id: 500, run: 20 } });
|
||||
const outage = fakeGitHub({ runFailures: [502, 502, 502, 502, 502] });
|
||||
assert.match((await waitForBaselineArtifact(waitOptions(outage, clock()))).reason, /^GITHUB_REQUEST_FAILED: GitHub answered HTTP 502/, "an outage that outlasts its retries ends the wait");
|
||||
const denied = fakeGitHub({ runFailures: [403] });
|
||||
assert.deepEqual(await waitForBaselineArtifact(waitOptions(denied, clock())),
|
||||
{ reason: "GITHUB_PERMISSION_DENIED: GitHub answered HTTP 403 for repos/acme/app/actions/runs/20." });
|
||||
assert.equal(denied.polls(), 1, "a missing permission is not retried");
|
||||
const tokenless = await waitForBaselineArtifact(waitOptions(fakeGitHub(), clock(), { environment: { GITHUB_REPOSITORY: "acme/app" } }));
|
||||
assert.match(tokenless.reason, /^GITHUB_TOKEN_MISSING/);
|
||||
});
|
||||
|
||||
test("an artifact with a path outside its directory is refused before anything is written, and base captures as before", async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-baseline-wait-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const github = fakeGitHub({ zip: await zipFiles({ "bundle.json": "{}", "../escape.txt": "outside" }), states: [{ artifact: true }] });
|
||||
const lines = [];
|
||||
assert.equal(await awaitPendingBaseline({ ...waitOptions(github, clock(), { progress: line => lines.push(line) }), directory: join(root, "review", "baseline-download") }), undefined);
|
||||
// zip.js refuses the entry as it reads the archive's directory, before the unpacking's own path check would.
|
||||
assert.equal(lines.at(-1), "base: the baseline of aaaaaaaa from run 20 could not be downloaded (Unsafe filename); capturing the base too");
|
||||
assert.deepEqual(await readdir(join(root, "review")), [], "neither the download nor a partial directory is left");
|
||||
await assert.rejects(stat(join(root, "escape.txt")), { code: "ENOENT" });
|
||||
});
|
||||
|
||||
test("a review that no longer needs the baseline stops waiting at once", async () => {
|
||||
const github = fakeGitHub({ states: [{ jobs: [job("in_progress")] }] });
|
||||
const controller = new AbortController();
|
||||
const waiting = waitForBaselineArtifact({ run: 20, sha, target: "iphone", timeoutMs: 15 * 60_000, environment, transport: github.transport, signal: controller.signal });
|
||||
setTimeout(() => controller.abort(), 50);
|
||||
const started = Date.now();
|
||||
assert.deepEqual(await waiting, { reason: "the review stopped waiting" });
|
||||
assert.ok(Date.now() - started < 5_000);
|
||||
});
|
||||
@@ -8,7 +8,8 @@ import { tsImport } from "tsx/esm/api";
|
||||
const { runBlackBoxExploration, screenEvidenceKey, elementsOf, fieldName, systemDialogTitle } = await tsImport("../../src/binary/explorer.ts", import.meta.url);
|
||||
const { ExploreStore, validateMap } = await tsImport("../../src/map/store.ts", import.meta.url);
|
||||
const { CONTRACT } = await tsImport("../../src/types.ts", import.meta.url);
|
||||
const { assertAppUrl, describeForeground, foreignNode, guardPositionals, leftForeground, retryWhileBusy } = await tsImport("../../src/binary/run.ts", import.meta.url);
|
||||
const tsRun = await tsImport("../../src/binary/run.ts", import.meta.url);
|
||||
const { assertAppUrl, describeForeground, foreignNode, guardPositionals, leftForeground, retryWhileBusy } = tsRun;
|
||||
|
||||
const PNG = Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==", "base64");
|
||||
const SCREENS = {
|
||||
@@ -881,3 +882,328 @@ test("when nothing passes preflight, the first failure is reported", async () =>
|
||||
const createSession = (config, { auth }) => ({ async preflight() { throw new Error(`${config.provider} ${auth} refused`); } });
|
||||
await assert.rejects(preflightModelSession({ createSession }, {}, () => {}), /anthropic local-login refused/);
|
||||
});
|
||||
|
||||
test("a landscape frame on a portrait panel (an opened iPhone Duo) is stored upright", async () => {
|
||||
const { createRequire } = await import("node:module");
|
||||
const { PNG: Png } = createRequire(import.meta.url)("pngjs");
|
||||
const raw = new Png({ width: 1, height: 2 });
|
||||
raw.data.set([255, 0, 0, 255, 0, 0, 255, 255]);
|
||||
const png = Png.sync.write(raw);
|
||||
const { map, root } = await harness([["observe", { includeImage: true }], ["capture", { frameId: "frame-0", title: "Home" }], ["finish", { summary: "One." }]], {
|
||||
observe: async includeImage => ({ nodes: SCREENS.home, capturedAt: new Date().toISOString(), ...(includeImage ? { frameId: "frame-0", png, width: 1, height: 2, landscape: true } : {}) }) });
|
||||
const artifact = map.artifacts.find(item => item.kind === "screenshot");
|
||||
assert.deepEqual([artifact.width, artifact.height], [2, 1]);
|
||||
const { readFile } = await import("node:fs/promises");
|
||||
const stored = Png.sync.read(await readFile(join(root, artifact.path)));
|
||||
// The panel's top (red) is the UI's right-hand side once turned a quarter clockwise.
|
||||
assert.deepEqual([...stored.data], [0, 0, 255, 255, 255, 0, 0, 255]);
|
||||
});
|
||||
|
||||
/** A PNG of `width` × `height` RGBA pixels, each given as [r, g, b, a] row by row. */
|
||||
async function pngOf(width, height, pixels) {
|
||||
const { createRequire } = await import("node:module");
|
||||
const { PNG: Png } = createRequire(import.meta.url)("pngjs");
|
||||
const image = new Png({ width, height });
|
||||
image.data.set(pixels.flat());
|
||||
return Png.sync.write(image);
|
||||
}
|
||||
|
||||
test("an opened Duo's frame shows the same pixels as a screen already seen once turned, so it is that screen (AudioScape's playlist title, rotated)", async () => {
|
||||
const tabs = [{ type: "Button", label: "Home", hittable: true }, { type: "Button", label: "Library", hittable: true }];
|
||||
const library = [{ type: "StaticText", label: "Library" }, { type: "Button", label: "My Playlist", hittable: true }, ...tabs];
|
||||
const trees = { library, titled: [{ type: "StaticText", label: "My Playlist" }, ...tabs], untitled: [...tabs] };
|
||||
const images = { library: await pngOf(1, 2, [[255, 0, 0, 255], [0, 0, 255, 255]]), playlist: await pngOf(1, 2, [[0, 255, 0, 255], [0, 0, 255, 255]]) };
|
||||
let visits = 0; let frames = 0; let where = "library";
|
||||
const { map } = await harness([
|
||||
["observe", { includeImage: true }], ["capture", { frameId: "frame-0", title: "Library" }],
|
||||
["act", { action: "tap", label: "My Playlist" }], ["observe", { includeImage: true }],
|
||||
["act", { action: "back" }], ["observe", { includeImage: true }],
|
||||
["act", { action: "tap", label: "My Playlist" }], ["observe", { includeImage: true }],
|
||||
["finish", { summary: "Done." }],
|
||||
], { observe: async includeImage => ({ nodes: trees[where], capturedAt: new Date().toISOString(),
|
||||
...(includeImage ? { frameId: `frame-${frames++}`, png: Buffer.from(images[where === "library" ? "library" : "playlist"]), width: 1, height: 2, landscape: true } : {}) }),
|
||||
act: async action => { if (action.action === "back") where = "library"; else where = visits++ === 0 ? "titled" : "untitled"; } });
|
||||
assert.equal(map.screens.length, 2, "the second read of the playlist did not mint a screen");
|
||||
assert.equal(map.observations.filter(item => item.screenId === map.screens[1].id).length, 2, "both reads are observations of the one playlist screen");
|
||||
assert.equal(map.artifacts.filter(item => item.kind === "screenshot").length, 2);
|
||||
});
|
||||
|
||||
test("a coordinate tap on an opened Duo is named by where it shows in the upright screenshot", async () => {
|
||||
// The inner panel's portrait axes: a button near the portrait top right is at the upright bottom right.
|
||||
const home = [
|
||||
{ type: "Application", label: "", rect: { x: 0, y: 0, width: 669, height: 951 } },
|
||||
{ type: "Button", label: "", hittable: true, rect: { x: 600, y: 40, width: 44, height: 44 } },
|
||||
];
|
||||
let frames = 0; let tapped = false;
|
||||
// The look without an image carries no landscape flag; the screen's stored screenshot still says it was turned.
|
||||
const { map } = await harness([
|
||||
["observe", { includeImage: true }], ["capture", { frameId: "frame-0", title: "Home" }], ["observe", { includeImage: false }],
|
||||
["act", { action: "tap", frameId: "frame-0", x: 622 / 669, y: 62 / 951 }],
|
||||
["finish", { summary: "Done." }],
|
||||
], { observe: async includeImage => ({ nodes: tapped ? SCREENS.settings : home, capturedAt: new Date().toISOString(),
|
||||
...(includeImage ? { frameId: `frame-${frames++}`, png: await pngOf(1, 2, [[255, 0, 0, 255], [0, 0, 255, 255]]), width: 1, height: 2, landscape: true } : {}) }),
|
||||
act: async () => { tapped = true; } });
|
||||
assert.equal(map.actionAttempts.find(item => item.action.kind === "press").action.label, "icon button, bottom right");
|
||||
assert.deepEqual(map.artifacts.find(item => item.kind === "screenshot").turned, { width: 669, height: 951 });
|
||||
});
|
||||
|
||||
test("turnedClockwise puts the portrait top on the right and keeps the colour chunks", async () => {
|
||||
const { turnedClockwise, assertDecodedPng } = await tsImport("../../src/shared/png-evidence.ts", import.meta.url);
|
||||
const { createRequire } = await import("node:module");
|
||||
const { PNG: Png } = createRequire(import.meta.url)("pngjs");
|
||||
const { crc32 } = await import("node:zlib");
|
||||
// 3 wide and 2 tall; each pixel's red is its index, so where it lands says where it came from.
|
||||
const plain = await pngOf(3, 2, [0, 1, 2, 3, 4, 5].map(index => [index * 40, 0, 0, 255]));
|
||||
const chunk = (type, data) => {
|
||||
const body = Buffer.concat([Buffer.from(type, "latin1"), data]), out = Buffer.alloc(body.length + 8);
|
||||
out.writeUInt32BE(data.length, 0); body.copy(out, 4); out.writeUInt32BE(crc32(body), body.length + 4);
|
||||
return out;
|
||||
};
|
||||
const gamma = Buffer.alloc(4); gamma.writeUInt32BE(45455);
|
||||
const source = Buffer.concat([plain.subarray(0, 33), chunk("sRGB", Buffer.from([0])), chunk("gAMA", gamma), plain.subarray(33)]);
|
||||
const turned = turnedClockwise(source);
|
||||
assertDecodedPng(turned, "Turned");
|
||||
const decoded = Png.sync.read(turned);
|
||||
assert.deepEqual([decoded.width, decoded.height], [2, 3]);
|
||||
// Source (x, y) lands at (height - 1 - y, x): the top row (0, 1, 2) runs down the right-hand column.
|
||||
const red = [...Array(6).keys()].map(index => decoded.data[index * 4] / 40);
|
||||
assert.deepEqual(red, [3, 0, 4, 1, 5, 2]);
|
||||
const types = [];
|
||||
for (let offset = 8; offset < turned.length; offset += 12 + turned.readUInt32BE(offset)) types.push(turned.toString("latin1", offset + 4, offset + 8));
|
||||
assert.deepEqual(types.slice(0, 3), ["IHDR", "sRGB", "gAMA"]);
|
||||
assert.ok(turned.includes(gamma), "the gamma is the source's");
|
||||
});
|
||||
|
||||
test("only an opened Duo's frame on its inner panel's portrait axes is turned upright", () => {
|
||||
const { duoScreenshotTurn } = tsRun;
|
||||
const root = (width, height) => ({ type: "Application", label: "Expo Go", rect: { x: 0, y: 0, width, height } });
|
||||
const frame = (deviceModel, nodes, width, height, platform = "ios") => duoScreenshotTurn({ platform, deviceModel, nodes, width, height });
|
||||
const cases = [
|
||||
["Duo open", frame("iPhone Duo", [root(669, 951)], 2007, 2853), "turn"],
|
||||
["Duo half-open", frame("iPhone Duo", [root(669, 951), { type: "Button", label: "Home", rect: { x: 20, y: 40, width: 44, height: 44 } }], 2007, 2853), "turn"],
|
||||
["Duo closed", frame("iPhone Duo", [root(466, 678)], 1398, 2034), "keep"],
|
||||
["iPhone 17 Pro", frame("iPhone 17 Pro", [root(402, 874)], 1206, 2622), "keep"],
|
||||
["an iPhone in landscape", frame("iPhone 17 Pro", [root(874, 402)], 2622, 1206), "keep"],
|
||||
["iPad", frame("iPad Pro 13-inch (M5)", [root(1032, 1376)], 2064, 2752), "keep"],
|
||||
["Android", frame("Pixel 9", [root(669, 951)], 2007, 2853, "android"), "keep"],
|
||||
["an empty tree", frame("iPhone Duo", [], 2007, 2853), "keep"],
|
||||
["a first node that isn't the Application", frame("iPhone Duo", [{ type: "Window", rect: { x: 0, y: 0, width: 300, height: 200 } }, root(669, 951)], 2007, 2853), "turn"],
|
||||
["a root off by a fraction of a point", frame("iPhone Duo", [root(669.33, 951)], 2008, 2853), "turn"],
|
||||
["an already-landscape image", frame("iPhone Duo", [root(669, 951)], 2853, 2007), "keep"],
|
||||
["the inner panel on its own axes", frame("iPhone Duo", [root(951, 669)], 2853, 2007), "keep"],
|
||||
["a Duo root on neither panel", frame("iPhone Duo", [root(700, 1000)], 2100, 3000), "unmatched"],
|
||||
["a Duo root the image does not show", frame("iPhone Duo", [root(669, 951)], 2000, 2000), "unmatched"],
|
||||
];
|
||||
for (const [name, actual, expected] of cases) assert.equal(actual, expected, name);
|
||||
});
|
||||
|
||||
test("the agent API lists a turned screenshot's element bounds on its upright axes", async () => {
|
||||
const { agentApiReply } = await tsImport("../../src/report/agent-api.ts", import.meta.url);
|
||||
const sha = "a".repeat(64);
|
||||
const map = { screens: [{ id: "scr_home", title: "Home", observationIds: ["obs_1"] }], observations: [{ id: "obs_1", screenshotArtifactId: "art_1" }],
|
||||
artifacts: [{ id: "art_1", kind: "screenshot", sha256: sha, width: 2853, height: 2007, turned: { width: 669, height: 951 } }],
|
||||
elements: [{ id: "el_1", screenId: "scr_home", label: "Settings", role: "button", bounds: { x: 600, y: 40, width: 44, height: 30, unit: "points" } }], transitions: [], variants: [], gaps: [] };
|
||||
const loaded = { kind: "exploration", file: "exploration.json", raw: new Uint8Array(), json: { map }, entries: new Map(), read: async () => undefined };
|
||||
const reply = await agentApiReply({ pageUrl: "https://example.test/p/token", platforms: ["ios"], expiresAt: null }, loaded, "/screens/scr_home", new URLSearchParams(), "application/json");
|
||||
const body = JSON.parse(await new Response(reply.body).text());
|
||||
// Portrait (600, 40) on a 951-point-tall screen shows at (951 - 40 - 30, 600) upright, near the bottom right.
|
||||
assert.deepEqual(body.elements[0].bounds, { x: 881, y: 600, width: 30, height: 44, unit: "points" });
|
||||
});
|
||||
|
||||
const { assertReplayFits, createReplaySession, parseReplayPlan, replaySetup } = await tsImport("../../src/binary/replay.ts", import.meta.url);
|
||||
|
||||
function replayDevice(screens = SCREENS) {
|
||||
let screen = "home", frames = 0;
|
||||
const acted = [];
|
||||
return { acted, options: {
|
||||
observe: async includeImage => ({ nodes: screens[screen], capturedAt: new Date().toISOString(),
|
||||
...(includeImage ? { frameId: `replay-${++frames}`, png: PNG, imageSha256: `${frames}`.padStart(64, "b") } : {}) }),
|
||||
act: async action => {
|
||||
acted.push(action);
|
||||
if (action.label === "Missing" || action.label === "Nowhere") throw new Error(`No element labelled ${action.label}`);
|
||||
if (action.action === "tap" && action.label === "Settings") screen = "settings";
|
||||
if (action.action === "tap" && action.label === "Dark mode" && screens.settingsDark) screen = "settingsDark";
|
||||
if (action.action === "back") screen = "home";
|
||||
},
|
||||
} };
|
||||
}
|
||||
|
||||
test("a replay plan takes the same steps on each run: platform-only steps are skipped, optional failures are passed over and listed", async () => {
|
||||
const plan = parseReplayPlan({ steps: [
|
||||
{ capture: "Home" },
|
||||
{ action: "tap", label: "Missing", optional: true },
|
||||
{ action: "tap", label: "Android only", platforms: ["android"] },
|
||||
{ action: "tap", label: "Settings" }, { capture: "Settings" },
|
||||
{ action: "tap", label: "Dark mode" }, { capture: "Settings", state: "dark" },
|
||||
{ action: "back" },
|
||||
] });
|
||||
const device = replayDevice();
|
||||
const { result, map } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options });
|
||||
assert.equal(result.stopReason, "finished");
|
||||
assert.match(result.summary, /Every planned screen was captured\. Optional steps skipped because they failed: step 2 \(tap "Missing"\)\.$/);
|
||||
assert.deepEqual(map.screens.map(screen => screen.title), ["Home", "Settings"]);
|
||||
assert.ok(!device.acted.some(action => action.label === "Android only"));
|
||||
assert.ok(map.variants.some(variant => variant.name === "dark"), "the dark state is recorded as a variant");
|
||||
});
|
||||
|
||||
test("a failed replay step stops the run, keeps what was captured, and names the screens it did not reach", async () => {
|
||||
const plan = parseReplayPlan({ steps: [
|
||||
{ capture: "Home" }, { action: "tap", label: "Settings" }, { capture: "Settings" }, { action: "back" },
|
||||
{ action: "tap", label: "Nowhere" }, { capture: "Never" }, { capture: "Android screen", platforms: ["android"] },
|
||||
] });
|
||||
const device = replayDevice();
|
||||
const { result, map } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options });
|
||||
assert.equal(result.stopReason, "blocked");
|
||||
assert.deepEqual(map.screens.map(screen => screen.title), ["Home", "Settings"]);
|
||||
assert.match(result.summary, /Replay step 5 \(tap "Nowhere"\) failed: .*No element labelled Nowhere.*Not captured: Never$/);
|
||||
});
|
||||
|
||||
test("a blocked step names the screens still ahead before earlier misses, within stop_blocked's limit", async () => {
|
||||
const plan = parseReplayPlan({ steps: [
|
||||
{ capture: "Home" },
|
||||
...Array.from({ length: 20 }, (_, index) => ({ capture: `Earlier miss ${index} ${"x".repeat(60)}` })),
|
||||
{ action: "tap", label: "Nowhere" },
|
||||
{ capture: "Ahead" },
|
||||
] });
|
||||
const device = replayDevice();
|
||||
const { result } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options, maxTurns: 100 });
|
||||
assert.equal(result.stopReason, "blocked");
|
||||
assert.ok(result.summary.length <= 1000, `${result.summary.length} characters`);
|
||||
assert.match(result.summary, /Not captured: Ahead, Earlier miss 0 .* and \d+ more$/);
|
||||
});
|
||||
|
||||
test("a destructive or app-leaving tap in a replay plan is refused, as a model's would be", async () => {
|
||||
const plan = parseReplayPlan({ steps: [
|
||||
{ capture: "Home" }, { action: "tap", label: "Share", optional: true }, { action: "tap", label: "Delete account" }, { capture: "Gone" },
|
||||
] });
|
||||
const device = replayDevice();
|
||||
const { result, map } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options });
|
||||
assert.equal(result.stopReason, "blocked");
|
||||
assert.match(result.summary, /^Replay step 3 \(tap "Delete account"\) failed: "Delete account" looks destructive.*Not captured: Gone$/);
|
||||
assert.deepEqual(device.acted, [], "neither tap reaches the device");
|
||||
assert.deepEqual(map.actionAttempts.map(attempt => [attempt.action.label, attempt.outcome]), [["Share", "blocked"], ["Delete account", "blocked"]]);
|
||||
});
|
||||
|
||||
test("a replay plan is checked before any device starts: unknown, hostile and malformed fields are refused", () => {
|
||||
const refused = (step, pattern) => assert.throws(() => parseReplayPlan({ steps: [step] }), error => error.code === "REPLAY_PLAN_INVALID" && pattern.test(error.message), JSON.stringify(step));
|
||||
assert.throws(() => parseReplayPlan({ steps: [] }), /no steps/);
|
||||
assert.throws(() => parseReplayPlan({ steps: [{ capture: "Home" }], step: [] }), /field "step" it does not take/);
|
||||
refused({ action: "tap" }, /exactly one of label or identifier/);
|
||||
refused({ action: "swipe" }, /needs a capture title or an action/);
|
||||
refused({ action: "constructor" }, /needs a capture title or an action/);
|
||||
refused({ capture: "Home", platforms: ["web"] }, /platforms must list ios and\/or android/);
|
||||
// A coordinate tap's fields would turn a label tap into a tap whose risk comes from `target`.
|
||||
refused({ action: "tap", label: "Delete account", frameId: "frame-1", x: 0.2, y: 0.15, target: "Next" }, /^Step 1 \(tap\) has a field "frameId" it does not take; a tap step takes action, label, identifier, platforms, optional\.$/);
|
||||
refused({ action: "tap", label: "Next", platform: ["ios"] }, /field "platform"/);
|
||||
refused({ action: "tap", label: "Next", optinal: true }, /field "optinal"/);
|
||||
refused({ capture: "Home", optional: true }, /\(capture\) has a field "optional"/);
|
||||
refused({ capture: "Home", action: "tap", label: "Next" }, /\(capture\) has a field "action"/);
|
||||
refused({ action: "back", label: "Back" }, /\(back\) has a field "label"/);
|
||||
refused({ action: "scroll", direction: ["up"] }, /scroll needs a direction/);
|
||||
refused({ action: "scroll", direction: "sideways" }, /scroll needs a direction/);
|
||||
refused({ action: "tap", label: "x".repeat(257) }, /label must be 1–256 characters without control characters/);
|
||||
refused({ action: "tap", identifier: "row\nnext" }, /identifier must be 1–256 characters/);
|
||||
refused({ action: "fill", label: "Name", text: "two\nlines" }, /fill needs text: one line/);
|
||||
refused({ action: "type", text: "x".repeat(2001) }, /type needs text/);
|
||||
refused({ action: "type", text: "{{secret:lowercase}}" }, /invalid secret reference/);
|
||||
refused({ action: "type", text: "{{secret:OPENAI_API_KEY}}" }, /cannot reference provider/);
|
||||
refused({ action: "wait", milliseconds: 15_001 }, /between 1 and 15000/);
|
||||
assert.deepEqual(parseReplayPlan({ steps: [{ capture: "Home" }] }).steps, [{ capture: "Home" }]);
|
||||
assert.deepEqual(parseReplayPlan({ steps: [{ action: "scroll", direction: "down", optional: true, platforms: ["ios"] }] }).steps,
|
||||
[{ action: "scroll", direction: "down", platforms: ["ios"], optional: true }]);
|
||||
});
|
||||
|
||||
test("a replay plan with no steps for the platform, or more than the budgets hold, is refused before any device starts", () => {
|
||||
const limits = { maxScreens: 40, maxActions: 150, maxTurns: 400 };
|
||||
assert.throws(() => assertReplayFits(parseReplayPlan({ steps: [{ capture: "Home", platforms: ["android"] }, { action: "back", platforms: ["android"] }] }), "ios", limits),
|
||||
error => error.code === "REPLAY_PLAN_EMPTY" && /No step of the replay plan runs on ios/.test(error.message));
|
||||
const plan = parseReplayPlan({ steps: [{ capture: "Home" }, { action: "tap", label: "Settings" }, { capture: "Settings" }, { action: "back" }, { action: "wait", milliseconds: 100 }] });
|
||||
assert.doesNotThrow(() => assertReplayFits(plan, "ios", limits));
|
||||
assert.throws(() => assertReplayFits(plan, "ios", { ...limits, maxScreens: 2, maxActions: 1 }),
|
||||
error => error.code === "REPLAY_PLAN_OVER_BUDGET" && /2 captures, which need a screen budget of at least 3 \(it is 2\) and 2 actions, more than the action budget of 1/.test(error.message)
|
||||
&& /--max-screens 3 --max-actions 2/.test(error.nextAction));
|
||||
assert.throws(() => assertReplayFits(plan, "ios", { ...limits, maxTurns: 8 }), /takes 9 tool calls, more than the 8/);
|
||||
});
|
||||
|
||||
test("a replay that runs out of budget names the planned screens it did not reach in the gap", async () => {
|
||||
const plan = parseReplayPlan({ steps: [{ capture: "Home" }, { action: "tap", label: "Settings" }, { capture: "Settings" }, { action: "back" }, { capture: "Later" }] });
|
||||
const device = replayDevice();
|
||||
const session = createReplaySession(plan, "ios");
|
||||
const { result, map } = await harness([], { session, budgetNote: session.budgetNote, ...device.options, maxScreens: 2 });
|
||||
assert.equal(result.stopReason, "budget-screens");
|
||||
assert.match(map.gaps.at(-1).message, /^The exploration stopped at its screens budget with \d+ controls unexplored\. Not captured: Settings, Later\.$/);
|
||||
});
|
||||
|
||||
test("a capture of a screen the plan already captured under another title is reported and does not rename it", async () => {
|
||||
const plan = parseReplayPlan({ steps: [
|
||||
{ capture: "Home" }, { capture: "Start" }, { capture: "home" }, { action: "tap", label: "Settings" }, { action: "back" },
|
||||
] });
|
||||
const device = replayDevice();
|
||||
const { result, map } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options });
|
||||
assert.equal(result.stopReason, "finished");
|
||||
assert.deepEqual(map.screens.map(screen => screen.title), ["Home", "Home → Settings"]);
|
||||
assert.match(result.summary, /Not captured: Start \(looked the same as Home\)\. Also reached, not in the plan: 1 unnamed screen\.$/);
|
||||
});
|
||||
|
||||
test("a planned state that the explorer merges into an earlier screen is neither reported as unplanned nor left in the map", async () => {
|
||||
// The README's own example: Dark mode changes the tree, and the capture titled Settings folds that new screen into Settings.
|
||||
const screens = { ...SCREENS, settingsDark: [...SCREENS.settings, { type: "Button", label: "Theme options" }] };
|
||||
const plan = parseReplayPlan({ steps: [
|
||||
{ capture: "Home" }, { action: "tap", label: "Settings" }, { capture: "Settings" },
|
||||
{ action: "tap", label: "Dark mode" }, { capture: "Settings", state: "dark" },
|
||||
] });
|
||||
const device = replayDevice(screens);
|
||||
const { result, map } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options });
|
||||
assert.equal(result.stopReason, "finished");
|
||||
assert.deepEqual(map.screens.map(screen => screen.title), ["Home", "Settings"]);
|
||||
const settings = map.screens.find(screen => screen.title === "Settings");
|
||||
assert.ok(map.variants.some(variant => variant.screenId === settings.id && variant.name === "dark"));
|
||||
assert.equal(result.summary, "Replayed 5 planned steps on ios. Every planned screen was captured.");
|
||||
});
|
||||
|
||||
test("a long replay summary is kept within finish's limit, the most useful names first", async () => {
|
||||
const titles = Array.from({ length: 60 }, (_, index) => `Planned screen ${String(index).padStart(2, "0")} ${"y".repeat(60)}`);
|
||||
const plan = parseReplayPlan({ steps: [{ capture: "Home" }, ...titles.map(title => ({ capture: title }))] });
|
||||
const device = replayDevice();
|
||||
const { result } = await harness([], { session: createReplaySession(plan, "ios"), ...device.options, maxTurns: 200 });
|
||||
assert.equal(result.stopReason, "finished");
|
||||
assert.ok(result.summary.length <= 4000, `${result.summary.length} characters`);
|
||||
assert.match(result.summary, /^Replayed 61 planned steps on ios\. Not captured: Planned screen 00 y+ \(looked the same as Home\), .* and \d+ more\.$/);
|
||||
});
|
||||
|
||||
test("a refused finish ends the replay with stop_blocked instead of a turn budget, and a refused stop is an error", async () => {
|
||||
const plan = parseReplayPlan({ steps: [{ action: "back" }] });
|
||||
const calls = [];
|
||||
const request = refuse => ({ signal: new AbortController().signal, callTool: async (name, input) => {
|
||||
calls.push({ name, input });
|
||||
const value = name === "get_progress" ? { captured: [] } : refuse.includes(name) ? { ok: false, code: "AGENT_ACTION_INVALID", message: `${name} refused` } : { ok: true };
|
||||
return { content: [{ type: "text", text: JSON.stringify(value) }], ...(refuse.includes(name) ? { isError: true } : {}) };
|
||||
} });
|
||||
await createReplaySession(plan, "ios").run(request(["finish"]));
|
||||
assert.deepEqual(calls.map(call => call.name), ["act", "get_progress", "finish", "stop_blocked"]);
|
||||
assert.match(calls.at(-1).input.reason, /^The replay could not finish \(finish refused\)\. Replayed 1 planned steps on ios\./);
|
||||
await assert.rejects(createReplaySession(plan, "ios").run(request(["finish", "stop_blocked"])), { code: "REPLAY_STOP_REFUSED" });
|
||||
});
|
||||
|
||||
test("a replay plan's {{secret:NAME}} inputs are read before any device starts and typed for the plan", async () => {
|
||||
const { runBinaryExploration, runSessionExploration } = await tsImport("../../src/binary/run.ts", import.meta.url);
|
||||
const { createExplorationInputs } = await tsImport("../../src/config/exploration-inputs.ts", import.meta.url);
|
||||
const plan = parseReplayPlan({ steps: [{ capture: "Home" }, { action: "fill", label: "Password", text: "{{secret:APP_TEST_PASSWORD}}" }] });
|
||||
const output = await mkdtemp(join(tmpdir(), "explore-replay-"));
|
||||
for (const run of [runBinaryExploration, runSessionExploration]) {
|
||||
await assert.rejects(run({ archive: join(output, "missing.apk"), output, replay: plan, environment: {} }),
|
||||
error => error.code === "EXPLORATION_SECRET_MISSING" && /APP_TEST_PASSWORD/.test(error.message));
|
||||
await assert.rejects(run({ archive: join(output, "missing.apk"), output, replay: plan, environment: {}, provider: "openai", hints: "Look around" }),
|
||||
error => error.code === "REPLAY_OPTIONS_IGNORED" && /--provider and --hints would do nothing/.test(error.message));
|
||||
await assert.rejects(run({ archive: join(output, "missing.apk"), output, replay: { steps: [{ action: "tap", label: "Next", optinal: true }] }, environment: {} }), { code: "REPLAY_PLAN_INVALID" });
|
||||
await assert.rejects(run({ archive: join(output, "missing.apk"), output, replay: parseReplayPlan({ steps: [{ action: "open", url: "https://example.com" }] }), environment: {} }),
|
||||
error => error.code === "REPLAY_PLAN_INVALID" && /^Step 1: https: URLs leave the app/.test(error.message));
|
||||
}
|
||||
const device = replayDevice();
|
||||
const inputs = createExplorationInputs({ setup: replaySetup(plan), environment: { APP_TEST_PASSWORD: "hunter2-test" } });
|
||||
const { result, map } = await harness([], { session: createReplaySession(plan, "ios"), inputs, ...device.options });
|
||||
assert.equal(result.stopReason, "finished");
|
||||
assert.deepEqual(device.acted, [{ action: "fill", label: "Password", text: "hunter2-test" }]);
|
||||
assert.equal(map.actionAttempts[0].action.input.value, "{{secret:APP_TEST_PASSWORD}}");
|
||||
assert.ok(!JSON.stringify(map).includes("hunter2-test"));
|
||||
});
|
||||
@@ -29,25 +29,25 @@ async function simulatorApp(root) {
|
||||
}
|
||||
|
||||
/** simctl and agent-device on a Mac with one iPhone 17 Pro runtime; the app shows a single screen. */
|
||||
function localRunner() {
|
||||
function localRunner(device = { name: "iPhone 17 Pro", identifier: DEVICE_TYPE }, screen = { nodes: [{ type: "StaticText", label: "Welcome" }, { type: "Button", label: "Settings" }], png: PNG }) {
|
||||
const requests = [];
|
||||
const ok = data => ({ stdout: JSON.stringify({ success: true, data }), stderr: "" });
|
||||
const runner = request => {
|
||||
requests.push(request);
|
||||
const [first, second, third] = request.args;
|
||||
if (request.command === "xcrun") {
|
||||
if (second === "list" && third === "devicetypes") return { stdout: JSON.stringify({ devicetypes: [{ name: "iPhone 17 Pro", identifier: DEVICE_TYPE }] }), stderr: "" };
|
||||
if (second === "list" && third === "devicetypes") return { stdout: JSON.stringify({ devicetypes: [device] }), stderr: "" };
|
||||
if (second === "list" && third === "runtimes") return { stdout: JSON.stringify({ runtimes: [{ isAvailable: true, platform: "iOS", identifier: "com.apple.CoreSimulator.SimRuntime.iOS-27-0",
|
||||
version: "27.0", supportedDeviceTypes: [{ identifier: DEVICE_TYPE }] }] }), stderr: "" };
|
||||
version: "27.0", supportedDeviceTypes: [{ identifier: device.identifier }] }] }), stderr: "" };
|
||||
if (second === "create") return { stdout: `${UDID}\n`, stderr: "" };
|
||||
return { stdout: "", stderr: "" };
|
||||
}
|
||||
if (first === "--version") return { stdout: `${controllerVersion("agent-device")}\n`, stderr: "" };
|
||||
if (first === "open") return ok({ session: CONTROLLER_SESSION, appBundleId: "dev.example.app", device: { platform: "ios", target: "mobile", name: "Explore iPhone 17 Pro", id: UDID },
|
||||
identifiers: { session: CONTROLLER_SESSION, appBundleId: "dev.example.app", deviceName: "Explore iPhone 17 Pro", deviceId: UDID } });
|
||||
if (first === "snapshot") return ok({ nodes: [{ type: "StaticText", label: "Welcome" }, { type: "Button", label: "Settings" }] });
|
||||
if (first === "snapshot") return ok({ nodes: screen.nodes });
|
||||
if (first === "appstate") return ok({ platform: "ios", appBundleId: "dev.example.app", state: "runningForeground", surface: "app" });
|
||||
if (first === "screenshot") { writeFileSync(request.args[1], PNG); return ok({}); }
|
||||
if (first === "screenshot") { writeFileSync(request.args[1], screen.png); return ok({}); }
|
||||
return ok({});
|
||||
};
|
||||
return { requests, runner };
|
||||
@@ -85,3 +85,34 @@ test("explore:binary --simulator local runs on a simulator it creates, with no E
|
||||
assert.equal(result.session.id, `local-${UDID}`);
|
||||
assert.deepEqual(await readdir(join(root, ".cache", "expo-explore", "local-captures")), [], "nothing is left for a sweep");
|
||||
});
|
||||
|
||||
test("an opened iPhone Duo's screenshots are stored upright, and the run records the landscape they show", async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-binary-duo-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const { createRequire } = await import("node:module");
|
||||
const { PNG: Png } = createRequire(import.meta.url)("pngjs");
|
||||
// The inner panel on its portrait axes at 1x, as local agent-device returns it: the tree's root is 669×951 points.
|
||||
const raw = new Png({ width: 669, height: 951 });
|
||||
for (let offset = 0; offset < raw.data.length; offset += 4) raw.data.set(offset < 669 * 4 ? [255, 0, 0, 255] : [255, 255, 255, 255], offset);
|
||||
const nodes = [{ type: "Application", label: "Example", rect: { x: 0, y: 0, width: 669, height: 951 } }, { type: "Button", label: "Settings", rect: { x: 20, y: 40, width: 80, height: 44 } }];
|
||||
const { runner } = localRunner({ name: "iPhone Duo", identifier: "com.apple.CoreSimulator.SimDeviceType.iPhone-Duo" }, { nodes, png: Png.sync.write(raw) });
|
||||
const session = { provider: "anthropic", model: "test", async preflight() {}, async run(request) {
|
||||
const observed = JSON.parse((await request.callTool("observe", { includeImage: true }, request.signal)).content[0].text);
|
||||
await request.callTool("capture", { frameId: observed.frameId, title: "Home" }, request.signal);
|
||||
await request.callTool("finish", { summary: "One." }, request.signal).catch(() => {});
|
||||
return { stopReason: "done" };
|
||||
} };
|
||||
const result = await runBinaryExploration({ archive: await simulatorApp(root), output: join(root, "out"), simulator: "local", device: "iPhone Duo", provider: "anthropic", runner,
|
||||
createSession: () => session, environment: { PATH: process.env.PATH, HOME: root, ANTHROPIC_API_KEY: "key" } });
|
||||
const { readFile } = await import("node:fs/promises");
|
||||
const map = JSON.parse(await readFile(result.mapPath, "utf8"));
|
||||
const artifact = map.artifacts.find(item => item.kind === "screenshot");
|
||||
assert.deepEqual([artifact.width, artifact.height, artifact.turned], [951, 669, { width: 669, height: 951 }]);
|
||||
const stored = Png.sync.read(await readFile(join(result.outputDirectory, artifact.path)));
|
||||
assert.deepEqual([stored.width, stored.height], [951, 669]);
|
||||
// The panel's top row (red) is the right-hand column once turned.
|
||||
assert.deepEqual([...stored.data.subarray((951 - 1) * 4, 951 * 4)], [255, 0, 0, 255]);
|
||||
assert.deepEqual([...stored.data.subarray(0, 4)], [255, 255, 255, 255]);
|
||||
assert.equal(map.run.environment.orientation, "landscape");
|
||||
assert.equal(result.runtime.orientation, "landscape");
|
||||
});
|
||||
@@ -138,6 +138,8 @@ test("capture recipes exclude display settings but bind agent instructions and c
|
||||
// How many sessions capture it does not change the evidence: a baseline captured under any ceiling serves the review.
|
||||
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,maxSessions:16}}));
|
||||
assert.equal(captureRecipeConfig({...config,capture:{...config.capture,maxSessions:4}}),captureRecipeConfig({...config,capture:{...config.capture,maxSessions:16}}));
|
||||
// Nor does how long a review waits for a baseline still being captured.
|
||||
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,baselineWaitMinutes:0}}));
|
||||
// An unset repack is keyed as it resolves, so configs that never chose one keep the recipe of the old written-out default.
|
||||
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,repack:"eas"}}));
|
||||
assert.equal(JSON.parse(key).capture.repack, "eas");
|
||||
|
||||
@@ -173,6 +173,22 @@ test("CI argument failures preserve JSON output, annotation, summary, and diagno
|
||||
assert.match(await readFile(summary, "utf8"), /Next action/);
|
||||
});
|
||||
|
||||
test("a failed command's diagnostics file names the matrix target it ran for, so the failure comment can", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-cli-target-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const cli = new URL("../../src/cli.ts", import.meta.url);
|
||||
const run = target => {
|
||||
const result = spawnSync(process.execPath, ["--import", "tsx", cli.pathname, "ci:report", "--input", join(root, "missing.json"), "--output", join(root, "out"), "--target", target],
|
||||
{ encoding: "utf8", env: { ...process.env, GITHUB_ACTIONS: "true", RUNNER_TEMP: root } });
|
||||
assert.equal(result.status, 1, result.stderr);
|
||||
return readFile(join(root, "explore-diagnostics/error.json"), "utf8").then(JSON.parse);
|
||||
};
|
||||
const written = await run("duo-closed");
|
||||
assert.equal(written.target, "duo-closed");
|
||||
assert.equal(written.code, "REPORT_INPUT_INVALID");
|
||||
assert.equal((await run("../ios")).target, undefined, "only a valid target id is written");
|
||||
});
|
||||
|
||||
test("source worker failures emit a structured diagnostic without a raw stack", () => {
|
||||
const worker = new URL("../../src/source/plan-worker.ts", import.meta.url);
|
||||
const result = spawnSync(process.execPath, ["--import", "tsx", worker.pathname], { input: "{", encoding: "utf8" });
|
||||
|
||||
+501
-6
@@ -69,6 +69,18 @@ const unreadableSurface = () => json({ success: false, error: { code: 'COMMAND_F
|
||||
details: { hint: 'com.apple.SafariViewService hosts the surface presented over the app, and this capture targeted that surface. No snapshot backend could read this screen (XCTest-backed snapshot tiers were deferred after recent slow accessibility work on this screen).' } } });
|
||||
|
||||
|
||||
/**
|
||||
* The iOS 26 keyboard as agent-device reports it: the Keyboard element with its keys beneath it, and the dock's Emoji and
|
||||
* Dictate buttons, which its host bridge names by their view class (brentvatne/euxy#172, review run 39362642343).
|
||||
*/
|
||||
const softKeyboard = [
|
||||
{ index: 900, type: 'Application', rect: { x: 0, y: 0, width: 402, height: 874 }, visible: true },
|
||||
{ index: 902, parentIndex: 900, type: 'Keyboard', rect: { x: 0, y: 583, width: 402, height: 233 }, visible: true },
|
||||
{ index: 903, parentIndex: 902, type: 'Key', label: 'Q', rect: { x: 5, y: 590, width: 39, height: 54 }, visible: true },
|
||||
{ index: 905, parentIndex: 900, type: 'Button', role: 'UIKeyboardDockItemButton', label: 'Emoji', rect: { x: 8, y: 806, width: 68, height: 68 }, visible: true },
|
||||
{ index: 906, parentIndex: 900, type: 'Button', role: 'UIKeyboardDockItemButton', label: 'Dictate', identifier: 'dictation', rect: { x: 325, y: 806, width: 68, height: 68 }, visible: true },
|
||||
];
|
||||
|
||||
function agentFixture(actions, observedRequests = []) {
|
||||
return { instructions: 'Capture each selected route in its normal loaded state.', contexts: {},
|
||||
provider: { provider: 'anthropic', model: 'test-model', preflight: async () => {}, run: async request => {
|
||||
@@ -116,7 +128,11 @@ async function fixture(t, settings = {}) {
|
||||
let current = '/'; let snapshots = 0; let sessionName; let screenshotAttempts = 0; let splashLeft = 0; let recordingPath = ''; let alert = null; let appearance = 'light'; let alertReads = 0;
|
||||
let enteredName = false; let scrolledToContinue = false; let finishHidden = false; let wedgeCleared = false; let deviceLost = false; let relaunchedAfterForeign = false; let serverStarts = 0; let unreadableLeft = settings.unreadableAfterFold ?? 0;
|
||||
// startsErrored / startsUnnamed: how many session starts EAS fails, after naming the session (it ERRORS) or before.
|
||||
let starts = 0; let currentSession = 'session-1'; const erroredSessions = new Set(); let foldUnverifiedLeft = settings.foldUnverified ?? 0;
|
||||
let starts = 0; let currentSession = 'session-1'; let workflowRuns = 0; const workflowRunRecords = new Map(); const cancelledRuns = []; const erroredSessions = new Set(); let foldUnverifiedLeft = settings.foldUnverified ?? 0;
|
||||
// listFailures: the first so many `simulator:control --list` calls fail, as a host that drops the connection does.
|
||||
let listFailuresLeft = settings.listFailures ?? 0;
|
||||
// focusedField: the screen at `path` focuses its text field, and the keyboard is up from the `keyboardFrom`th read of it.
|
||||
let focusedReads = 0;
|
||||
// blackAfterFold: the first so many folds of an EAS agent-device session light the panel but draw nothing.
|
||||
let folds = 0;
|
||||
const deviceName = settings.android ? 'Pixel 7' : 'iPhone 17 Pro';
|
||||
@@ -193,13 +209,40 @@ async function fixture(t, settings = {}) {
|
||||
// controlActions: what the session's serve-sim offers through simulator:control (none unless a test names them).
|
||||
if (command === 'simulator:control') {
|
||||
assert.equal(value(request, '--id'), currentSession, 'simulator:control names the session');
|
||||
if (request.args.includes('--list')) return json(Object.fromEntries((settings.controlActions ?? []).map(action => [action, { type: 'object' }])));
|
||||
if (request.args.includes('--list')) {
|
||||
if (listFailuresLeft > 0) { listFailuresLeft -= 1; return { stdout: '', stderr: 'The simulator preview server closed the connection before it answered.\nError: simulator:control command failed.\n' }; }
|
||||
return json(Object.fromEntries((settings.controlActions ?? []).map(action => [action, { type: 'object' }])));
|
||||
}
|
||||
assert.ok((settings.controlActions ?? []).includes(request.args[1]), `${request.args[1]} is offered by the session`);
|
||||
if (request.args[1] === 'appearance.set') appearance = request.args.at(-1);
|
||||
return json({ id: currentSession, action: request.args[1], output: '' });
|
||||
}
|
||||
if (command === 'fingerprint:generate') return json({ hash: 'source-fingerprint' });
|
||||
const buildMetadata = settings.buildMetadata ? { appVersion: '2.1.0', appBuildVersion: '42' } : {};
|
||||
// eas: the project's builds on EAS, shared by the fixtures of one test as the matrix jobs of one run share EAS.
|
||||
// A list without a fingerprint is a target looking for a repack another job of its run made (onList moves it on).
|
||||
if (command === 'build:list' && !request.args.includes('--fingerprint-hash')) {
|
||||
assert.ok(settings.eas, 'only a shared repack lists builds without a fingerprint');
|
||||
const limit = Number(value(request, '--limit'));
|
||||
assert.ok(Number.isInteger(limit) && limit >= 1 && limit <= 50, 'eas-cli lists at most 50 builds');
|
||||
settings.eas.lists += 1; settings.eas.onList?.(settings.eas);
|
||||
if (settings.eas.unreadableLists && settings.eas.lists <= settings.eas.unreadableLists) return { stdout: '', stderr: 'Error: GraphQL request failed.\n' };
|
||||
return json(settings.eas.builds.slice(0, limit));
|
||||
}
|
||||
// A target following another job's repack reads it by its id (onView moves it on).
|
||||
if (command === 'build:view') {
|
||||
assert.ok(settings.eas, 'only a shared repack views a build');
|
||||
settings.eas.views += 1; settings.eas.onView?.(settings.eas, request.args[1]);
|
||||
const build = settings.eas.builds.find(candidate => candidate.id === request.args[1]);
|
||||
return build ? json(build) : { stdout: '', stderr: `Error: build ${request.args[1]} not found\n` };
|
||||
}
|
||||
// envList: what eas env:list prints for each scope, the snapshot a shared repack's key includes.
|
||||
if (command === 'env:list') {
|
||||
assert.deepEqual([value(request, '--environment'), value(request, '--format')], ['preview', 'long']);
|
||||
const listed = settings.envList?.[value(request, '--scope')];
|
||||
if (listed === null) throw new Error('eas env:list exited with status 1: GraphQL request failed.');
|
||||
return { stdout: listed ?? 'Environment: preview\nNo variables found for this environment.\n', stderr: '' };
|
||||
}
|
||||
if (command === 'build:list') return json(settings.reuse ? [{ id: 'native-build', ...buildMetadata }] : []);
|
||||
if (command === 'build') return json([{ id: 'built-app', fingerprint: { hash: 'source-fingerprint' }, ...buildMetadata }]);
|
||||
if (command === 'env:pull') { writeFileSync(value(request, '--path'), '# Environment: preview\nEXPO_PUBLIC_ENDPOINT=sample\n'); return { stdout: '', stderr: '' }; }
|
||||
@@ -218,9 +261,52 @@ async function fixture(t, settings = {}) {
|
||||
assert.match(readFileSync(join(request.cwd, '.expo-explore-observer/metro.config.cjs'), 'utf8'), /PROJECT_RELATIVE = "\.\."/);
|
||||
assert.ok(existsSync(join(request.cwd, 'package.json')), 'tracked files are staged');
|
||||
assert.ok(!existsSync(join(request.cwd, 'node_modules')), 'untracked files are not staged');
|
||||
if (settings.workflowPlanLimit) return json({ jobs: [{ key: 'repack', status: 'FAILURE', turtleBuild: { status: 'ERRORED', error: { message: 'This account has used its local builds from the production_plus plan this month, which will reset in 13 days (on Sat Oct 24 2026). | Request ID: 1234 | Error: GraphQL request failed.' } }, outputs: {} }] });
|
||||
if (settings.workflowFailure) return { stdout: json({ jobs: [{ key: 'repack', status: 'FAILURE', turtleBuild: { status: 'ERRORED', error: { errorCode: 'UNKNOWN_CUSTOM_BUILD_ERROR', message: 'Build step "Repack" failed.' } }, outputs: {} }] }).stdout, stderr: 'See logs: https://expo.dev/accounts/acme/projects/example/workflows/run-1\n' };
|
||||
return json({ jobs: [{ key: 'repack', status: 'SUCCESS', outputs: { build_id: 'repacked-app', platform: settings.android ? 'android' : 'ios' } }] });
|
||||
assert.equal(request.args.includes('--wait'), false, 'Explore waits on the run itself');
|
||||
// repackFailures: how EAS ends the first runs, as { status, message, logs } of the repack job, its build and its logs.
|
||||
// repackStart: what workflow:run prints instead of the run's JSON (a start that failed, or a run with no JSON).
|
||||
workflowRuns += 1;
|
||||
const id = `run-${workflowRuns}`, url = `https://expo.dev/accounts/acme/projects/example/workflows/${id}`;
|
||||
const start = settings.repackStart?.[workflowRuns - 1];
|
||||
if (start?.noRun) return { stdout: '', stderr: start.stderr };
|
||||
const failure = settings.repackFailures?.[workflowRuns - 1];
|
||||
const buildId = failure || settings.workflowFailure || settings.workflowPlanLimit ? `repack-build-${workflowRuns}` : 'repacked-app';
|
||||
const build = { id: buildId, status: 'IN_PROGRESS', platform: settings.android ? 'ANDROID' : 'IOS', message: JSON.parse(/^ {6}message: (.*)$/m.exec(workflow)[1]) };
|
||||
if (settings.eas) settings.eas.builds.unshift(build);
|
||||
const finalJob = settings.workflowPlanLimit ? { key: 'repack', status: 'FAILURE', turtleBuild: { status: 'ERRORED', error: { message: 'This account has used its local builds from the production_plus plan this month, which will reset in 13 days (on Sat Oct 24 2026). | Request ID: 1234 | Error: GraphQL request failed.' } }, outputs: {} }
|
||||
: settings.workflowFailure ? { key: 'repack', status: 'FAILURE', turtleBuild: { status: 'ERRORED', error: { errorCode: 'UNKNOWN_CUSTOM_BUILD_ERROR', message: 'Build step "Repack" failed.' } }, outputs: {} }
|
||||
: failure ? { key: 'repack', status: failure.status, turtleBuild: { status: 'ERRORED', ...(failure.message ? { error: { errorCode: failure.errorCode ?? 'UNKNOWN_CUSTOM_BUILD_ERROR', message: failure.message } } : {}) }, outputs: {} }
|
||||
: { key: 'repack', status: 'SUCCESS', outputs: { build_id: 'repacked-app', platform: settings.android ? 'android' : 'ios' } };
|
||||
workflowRunRecords.set(id, { id, url, views: 0, build, failure, job: { id: `job-${workflowRuns}`, ...finalJob } });
|
||||
// A start that ran out its time throws, keeping what it printed (defaultRunner); `printed` says whether that named the run.
|
||||
if (start?.throws) throw Object.assign(new Error('spawnSync fake-eas ETIMEDOUT'), { stdout: '', stderr: start.printed ? `See logs: ${url}\n` : 'Uploading project sources...\n' });
|
||||
if (start) return { stdout: '', stderr: `${start.stderr}See logs: ${url}\n` };
|
||||
return { stdout: JSON.stringify({ id, url }), stderr: `See logs: ${url}\n` };
|
||||
}
|
||||
// A run is read until it ends: repackViews reads of IN_PROGRESS first (repackMs pass on the first), unreadableViews
|
||||
// reads that print no JSON, and then the end repackFailures and the other settings chose.
|
||||
if (command === 'workflow:view') {
|
||||
const run = workflowRunRecords.get(request.args[1]);
|
||||
assert.ok(run, 'only a run Explore started is viewed');
|
||||
run.views += 1;
|
||||
if (run.views === 1) clockMs += settings.repackMs ?? 0;
|
||||
if (run.views <= (settings.unreadableViews ?? 0)) return { stdout: '', stderr: 'Failed to fetch the workflow run.\n' };
|
||||
if (run.views <= (settings.unreadableViews ?? 0) + (settings.repackViews ?? 0) && !run.cancelled) return json({ id: run.id, status: 'IN_PROGRESS', logURL: run.url, jobs: [{ ...run.job, status: 'IN_PROGRESS', outputs: {} }] });
|
||||
const status = run.cancelled ? 'CANCELED' : run.job.status === 'SUCCESS' ? 'SUCCESS' : run.job.status === 'CANCELED' ? 'CANCELED' : 'FAILURE';
|
||||
run.build.status = status === 'SUCCESS' ? 'FINISHED' : status === 'CANCELED' ? 'CANCELED' : 'ERRORED';
|
||||
return json({ id: run.id, status, logURL: run.url, jobs: [run.cancelled ? { ...run.job, status: 'CANCELED' } : run.job] });
|
||||
}
|
||||
if (command === 'workflow:logs') {
|
||||
const run = [...workflowRunRecords.values()].find(candidate => candidate.job.id === request.args[1]);
|
||||
assert.ok(run, 'only a job of a run Explore started has its logs read');
|
||||
return json({ [run.failure?.step ?? 'Repack app']: (run.failure?.logs ?? []).map(msg => ({ time: '2026-10-20T00:00:00.000Z', msg })) });
|
||||
}
|
||||
if (command === 'workflow:cancel') {
|
||||
const run = workflowRunRecords.get(request.args[1]);
|
||||
assert.ok(run, 'only a run Explore started is cancelled');
|
||||
cancelledRuns.push(run.id);
|
||||
if (settings.cancelFails) throw new Error('eas workflow:cancel exited with status 1');
|
||||
run.cancelled = true;
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
if (command === 'upload') {
|
||||
return json({ url: 'https://expo.dev/accounts/acme/projects/example/builds/repacked-app' });
|
||||
@@ -369,6 +455,8 @@ async function fixture(t, settings = {}) {
|
||||
] : []),
|
||||
...(settings.statefulSetup && current === '/transient' ? [{ type: 'Button', label: 'Finish', ref: 'e103', enabled: true, visible: !finishHidden }] : []),
|
||||
...(alert ? [{ type: 'Alert', label: alert.message }, ...alert.items.map((label, index) => ({ type: 'Button', label, ref: `e${index + 1}`, enabled: true, visible: true }))] : []),
|
||||
...(settings.focusedField?.path === current ? [{ type: 'TextField', label: 'Pattern name', focused: true, visible: true, rect: { x: 23, y: 386, width: 355, height: 50 } },
|
||||
...(++focusedReads >= (settings.focusedField.keyboardFrom ?? Infinity) ? softKeyboard : [])] : []),
|
||||
...(settings.missingObserver || settings.missingObserverAt === current ? [] : [observer]),
|
||||
// A second active destination is ambiguous; the host AX bridge's identical copy is not.
|
||||
...(settings.duplicateObserver ? [{ ...observer, label: JSON.stringify({ provider: 'expo-router', pathname: '/other', segments: ['other'], parameters: {} }) }] : []),
|
||||
@@ -421,7 +509,7 @@ async function fixture(t, settings = {}) {
|
||||
environment: { PATH: process.env.PATH, HOME: root, ...(settings.local && settings.android ? { ANDROID_HOME: sdk, TMPDIR: root } : {}), GITHUB_TOKEN: 'github-private', ANTHROPIC_API_KEY: 'must-not-be-used', AGENT_DEVICE_DAEMON_AUTH_TOKEN: 'wrong-token', ...settings.environment },
|
||||
// Every controller round trip advances the fixture clock by one poll interval, as a device snapshot would.
|
||||
runner: request => { clockMs += 600; return runner(request); }, now: () => clockMs, sleep: milliseconds => { clockMs += milliseconds; }, fetch: catalog };
|
||||
return { root, options, requests, catalogRequests, routes, ids, plan, operations: () => requests.map(request => request.args[0]) };
|
||||
return { root, options, requests, catalogRequests, routes, ids, plan, cancelledRuns, operations: () => requests.map(request => request.args[0]) };
|
||||
}
|
||||
|
||||
test('source plan captures the configured device without app fixtures or model execution', async t => {
|
||||
@@ -576,6 +664,61 @@ test('when a fold on EAS leaves Argent reading the dark panel, the capture resta
|
||||
}
|
||||
});
|
||||
|
||||
// In brentvatne/euxy's main baseline run 39487618529, one failed --list made the dark session look as if it offered no
|
||||
// actions: it dropped dark, approved no link scheme, skipped the SpringBoard restart its fold needed, and failed the target.
|
||||
test('a --list that fails once still gives an Argent dark session its appearance, its link approval and its fold recovery', async t => {
|
||||
const f = await fixture(t, { argent: true, userInterfaceStyle: 'automatic', devicePose: 'open', foldUnverified: 1, listFailures: 1,
|
||||
controlActions: ['appearance.set', 'app.approveUrlScheme', 'springboard.restart'] });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, progress: line => lines.push(line), appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
const control = f.requests.filter(request => request.args[0] === 'simulator:control');
|
||||
assert.equal(control.filter(request => request.args.includes('--list')).length, 2);
|
||||
assert.equal(lines.some(line => /Argent cannot switch appearance/.test(line)), false, lines.join('\n'));
|
||||
assert.deepEqual(control.filter(request => request.args[1] === 'appearance.set').map(request => request.args.at(-1)), ['dark']);
|
||||
assert.equal(control.filter(request => request.args[1] === 'app.approveUrlScheme').length, 1);
|
||||
assert.equal(control.filter(request => request.args[1] === 'springboard.restart').length, 1);
|
||||
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
assert.deepEqual(Object.keys(bundle.images).sort(), [`${f.ids.home}@dark`, `${f.ids.settings}@dark`]);
|
||||
});
|
||||
|
||||
test('a --list that keeps failing fails the session with a retryable error before the app is installed, and stops the session', async t => {
|
||||
const f = await fixture(t, { argent: true, devicePose: 'open', listFailures: Infinity, controlActions: ['springboard.restart'] });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'SIMULATOR_CONTROL_UNAVAILABLE' && error.retryable === true);
|
||||
assert.equal(f.requests.filter(request => request.args[0] === 'simulator:control' && request.args.includes('--list')).length, 3);
|
||||
assert.equal(f.requests.some(request => request.command.endsWith('/argent-controller') && ['install', 'fold'].includes(request.args[0])), false);
|
||||
assert.equal(f.operations().filter(operation => operation === 'simulator:stop').length, 1);
|
||||
});
|
||||
|
||||
test('a session given only dark that cannot switch to it stops before installing or folding, and the merge keeps the light session\'s capture', async t => {
|
||||
const dark = await fixture(t, { argent: true, userInterfaceStyle: 'automatic', devicePose: 'open' });
|
||||
const lines = [];
|
||||
await runCiMap({ ...dark.options, progress: line => lines.push(line), appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
|
||||
assert.equal(dark.requests.some(request => request.command.endsWith('/argent-controller') && ['install', 'fold'].includes(request.args[0])), false);
|
||||
assert.equal(dark.operations().filter(operation => operation === 'simulator:stop').length, 1);
|
||||
assert.ok(lines.some(line => /session session-1 cannot switch to dark, the appearance it was given; it stops without capturing/.test(line)), lines.join('\n'));
|
||||
const idle = JSON.parse(await readFile(join(dark.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
assert.deepEqual(Object.keys(idle.images), []);
|
||||
assert.equal(idle.outcomes[`${dark.ids.home}@dark`].error.code, 'SESSION_APPEARANCE_UNAVAILABLE');
|
||||
// A light session that switched appearance expects dark: each route's dark frame is reported as not captured.
|
||||
// One that could not switch either captured light alone, as one session would have: the dark session adds nothing.
|
||||
for (const [actions, expected] of [[['appearance.set'], 'failed'], [[], undefined]]) {
|
||||
const light = await fixture(t, { argent: true, userInterfaceStyle: 'automatic', devicePose: 'open', controlActions: actions });
|
||||
await runCiMap({ ...light.options, appearancePass: { all: ['light', 'dark'], capture: ['light'] } });
|
||||
await mergeCaptureExports(light.options.outputDirectory, [{ directory: dark.options.outputDirectory, scheme: 'dark' }]);
|
||||
const merged = JSON.parse(await readFile(join(light.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
for (const id of Object.values(light.ids)) {
|
||||
assert.equal(merged.outcomes[id].status, 'captured', id);
|
||||
assert.equal(merged.outcomes[`${id}@dark`]?.status, expected, `${id}@dark with ${actions.join(', ') || 'no actions'}`);
|
||||
}
|
||||
}
|
||||
// A session that cannot take the side's primary appearance fails it: the merge has nothing to add the others to.
|
||||
const primary = await fixture(t, { argent: true, devicePose: 'open' });
|
||||
await assert.rejects(runCiMap({ ...primary.options, appearance: ['dark', 'light'], appearancePass: { all: ['dark', 'light'], capture: ['dark'] } }),
|
||||
error => error.code === 'SESSION_APPEARANCE_UNAVAILABLE');
|
||||
assert.equal(primary.requests.some(request => request.command.endsWith('/argent-controller') && request.args[0] === 'fold'), false);
|
||||
});
|
||||
|
||||
test('a session EAS ends while starting is replaced by a new one, under a name of its own, up to five times with a growing wait', async t => {
|
||||
const f = await fixture(t, { startsErrored: 1 });
|
||||
const lines = []; const waits = [];
|
||||
@@ -1181,6 +1324,46 @@ test('every app link settles before the screen is read', async t => {
|
||||
assert.ok(opened >= 0 && settled > opened && settled < read, 'the settle runs between the link and the first read');
|
||||
});
|
||||
|
||||
const keyboardLog = async f => (await readFile(join(f.options.mapDirectory, 'capture-diagnostics', 'keyboard.jsonl'), 'utf8'))
|
||||
.trim().split('\n').map(line => JSON.parse(line));
|
||||
|
||||
test('a screen whose text field has the focus is captured once its keyboard is up and still, and the keyboard is not one of its elements', async t => {
|
||||
// euxy#172 (review run 39362642343): the rename sheet focuses its field, and the keyboard rises after the sheet settles.
|
||||
const f = await fixture(t, { routes: [route('rename')], focusedField: { path: '/rename', keyboardFrom: 2 } });
|
||||
const result = await runCiMap(f.options);
|
||||
assert.equal(result.outcomes[f.ids.rename].status, 'captured');
|
||||
assert.equal(result.outcomes[f.ids.rename].attempts, 1);
|
||||
assert.deepEqual((await keyboardLog(f)).map(line => [line.route, line.outcome, line.reads]), [[f.ids.rename, 'shown', 2]],
|
||||
'read until the keyboard was up in the same place twice');
|
||||
const calls = f.requests.filter(request => request.command === 'fake-controller').map(request => request.args[0]);
|
||||
const shot = calls.lastIndexOf('screenshot');
|
||||
assert.deepEqual(calls.slice(shot - 3, shot), ['snapshot', 'snapshot', 'snapshot'], 'the destination read, then the keyboard reads, then the screenshot');
|
||||
const map = await readExportedMap(f.options.outputDirectory);
|
||||
const labels = map.observations.flatMap(observation => observation.elements.map(element => element.label));
|
||||
assert.ok(labels.includes('Pattern name'));
|
||||
for (const label of ['Q', 'Emoji', 'Dictate']) assert.equal(labels.includes(label), false, `${label} is the keyboard's, not the app's`);
|
||||
});
|
||||
|
||||
test('a focused field whose keyboard never rises is captured after about a second and at least two reads, without it', async t => {
|
||||
const f = await fixture(t, { routes: [route('rename')], focusedField: { path: '/rename' } });
|
||||
const result = await runCiMap(f.options);
|
||||
assert.equal(result.outcomes[f.ids.rename].status, 'captured');
|
||||
const [line] = await keyboardLog(f);
|
||||
assert.equal(line.outcome, 'absent');
|
||||
assert.ok(line.reads >= 2 && line.reads <= 6 && line.elapsedMs >= 1000, `gave up after ${line.reads} reads in ${line.elapsedMs} ms`);
|
||||
assert.equal(f.operations().includes('keyboard'), false, 'the keyboard is never dismissed or summoned');
|
||||
// A screen without a focused field is not read again.
|
||||
const plain = await fixture(t, { routes: [route('home')] });
|
||||
await runCiMap(plain.options);
|
||||
assert.equal(existsSync(join(plain.options.mapDirectory, 'capture-diagnostics', 'keyboard.jsonl')), false);
|
||||
});
|
||||
|
||||
test('a keyboard already up when the screen is read is captured once a later read finds it in the same place', async t => {
|
||||
const f = await fixture(t, { routes: [route('rename')], focusedField: { path: '/rename', keyboardFrom: 1 } });
|
||||
assert.equal((await runCiMap(f.options)).outcomes[f.ids.rename].status, 'captured');
|
||||
assert.deepEqual((await keyboardLog(f)).map(line => [line.outcome, line.reads]), [['shown', 1]]);
|
||||
});
|
||||
|
||||
test('an application Open button is never an implicit confirmation action', async t => {
|
||||
const f = await fixture(t, { routes: [route('home')], appOpenButton: true });
|
||||
const result = await runCiMap(f.options);
|
||||
@@ -1760,6 +1943,318 @@ test('a failed hosted repack job stops the capture as EAS_REPACK_FAILED with the
|
||||
assert.deepEqual(f.operations().filter(operation => operation.startsWith('simulator:')).filter(operation => operation !== 'simulator:availability'), ['simulator:start', 'simulator:stop']);
|
||||
});
|
||||
|
||||
const runs = f => f.operations().filter(operation => operation === 'workflow:run').length;
|
||||
const sessionOperations = f => f.operations().filter(operation => /^simulator:(start|stop)$/.test(operation));
|
||||
// The upload step of brentvatne/euxy#176 (review run 39506405687), refused once the build had repacked.
|
||||
const uploadRefused = { status: 'FAILURE', message: 'Failed to upload application archive.', step: 'Upload artifact',
|
||||
logs: ['Unexpected response from server (400): {"errors":[{"code":"VALIDATION_ERROR","type":"USER","message":"Turtle build is not in progress, it cannot save artifacts.","isTransient":false}]}',
|
||||
'Failed to upload application archive.', 'Build step "Upload artifact" failed'] };
|
||||
|
||||
test('a repack the app broke, a refused credential, a build timeout or a cancelled run is not started again', async t => {
|
||||
const cases = {
|
||||
'the Repack app step': { status: 'FAILURE', message: 'Build step "Repack app" failed.' },
|
||||
'a bundling error in the logs': { status: 'FAILURE', message: 'Unknown custom build error. See logs for more information.',
|
||||
logs: ['SyntaxError: app/home.tsx: Unexpected token (4:2)', 'Build step "Repack app" failed'] },
|
||||
"a private registry's 401": { status: 'FAILURE', message: 'Unknown custom build error. See logs for more information.', step: 'Install dependencies',
|
||||
logs: ['npm error code E401', 'npm error 401 Unauthorized - GET https://npm.example.com/download/@acme/ui-1.0.0.tgz', 'Build step "Install dependencies" failed'] },
|
||||
'a bundling hang that ran out the build time': { status: 'FAILURE', message: 'Build timed out.', errorCode: 'EAS_BUILD_TIMEOUT_ERROR' },
|
||||
'a cancelled run': { status: 'CANCELED' },
|
||||
};
|
||||
for (const [name, failure] of Object.entries(cases)) {
|
||||
const f = await fixture(t, { repackFailures: [failure] });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'EAS_REPACK_FAILED', name);
|
||||
assert.equal(runs(f), 1, name);
|
||||
}
|
||||
});
|
||||
|
||||
test('a hosted repack EAS ended before it saved the app starts again, and the capture goes on (brentvatne/euxy#176)', async t => {
|
||||
const f = await fixture(t, { repackFailures: [uploadRefused] });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, progress: line => lines.push(line) });
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
assert.equal(result.easBuildId, 'repacked-app');
|
||||
assert.equal(runs(f), 2);
|
||||
assert.ok(lines.some(line => /the hosted EAS repack https:\/\/expo\.dev\/accounts\/acme\/projects\/example\/workflows\/run-1 failed \(The hosted EAS repack of the ios build finished with status FAILURE: Failed to upload application archive\.\); starting another repack \(1\/2\)/.test(line)), lines.join('\n'));
|
||||
// Explore waits on each run itself, and reads the failed job's logs once.
|
||||
assert.equal(f.requests.some(request => request.args[0] === 'workflow:run' && request.args.includes('--wait')), false);
|
||||
assert.equal(f.operations().filter(operation => operation === 'workflow:logs').length, 1);
|
||||
// One session, started beside the first repack, installs the second one's app.
|
||||
assert.deepEqual(sessionOperations(f), ['simulator:start', 'simulator:stop']);
|
||||
});
|
||||
|
||||
test('a repack EAS keeps failing is started twice more, one nothing explains once more, and one near the end of the budget not again', async t => {
|
||||
const cases = [{ failures: [uploadRefused, uploadRefused, uploadRefused], runs: 3 }, { failures: [{ status: 'ERRORED' }, { status: 'ERRORED' }], runs: 2 },
|
||||
// A failure 26 minutes in leaves less of the 30-minute budget than another repack needs.
|
||||
{ failures: [uploadRefused], runs: 1, repackMs: 26 * 60_000 }];
|
||||
for (const { failures, runs: expected, repackMs } of cases) {
|
||||
const f = await fixture(t, { repackFailures: failures, ...(repackMs ? { repackMs } : {}) });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'EAS_REPACK_FAILED' && new RegExp(`workflows/run-${expected}`).test(error.nextAction));
|
||||
assert.equal(runs(f), expected);
|
||||
assert.deepEqual(sessionOperations(f), ['simulator:start', 'simulator:stop']);
|
||||
}
|
||||
});
|
||||
|
||||
test('a run whose state EAS keeps failing to report is cancelled, and no other is started beside it', async t => {
|
||||
const f = await fixture(t, { unreadableViews: 6 });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'EAS_REPACK_FAILED' && error.details.failure === 'unconfirmed'
|
||||
&& /did not report the state of the hosted ios repack 6 times in a row; Explore cancelled the run/.test(error.message));
|
||||
assert.equal(runs(f), 1);
|
||||
assert.deepEqual(f.cancelledRuns, ['run-1']);
|
||||
// Five unreadable reads are waited out.
|
||||
const recovered = await fixture(t, { unreadableViews: 5 });
|
||||
assert.equal((await runCiMap(recovered.options)).easBuildId, 'repacked-app');
|
||||
assert.deepEqual(recovered.cancelledRuns, []);
|
||||
});
|
||||
|
||||
test('a start that printed its run but no JSON is waited on, and one that started no run is started again', async t => {
|
||||
const printed = await fixture(t, { repackStart: [{ stderr: 'Uploading project sources...\n' }] });
|
||||
assert.equal((await runCiMap(printed.options)).easBuildId, 'repacked-app');
|
||||
assert.equal(runs(printed), 1, 'the run it printed is followed, not replaced');
|
||||
assert.ok(printed.requests.some(request => request.args[0] === 'workflow:view' && request.args[1] === 'run-1'));
|
||||
const none = await fixture(t, { repackStart: [{ noRun: true, stderr: 'Failed to upload project sources.\nError: socket hang up\n' }] });
|
||||
assert.equal((await runCiMap(none.options)).easBuildId, 'repacked-app');
|
||||
assert.equal(runs(none), 2);
|
||||
});
|
||||
|
||||
test('a run that outlasts the 30 minutes a capture has to prepare its app is cancelled and fails the target', async t => {
|
||||
const f = await fixture(t, { repackViews: 10_000 });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'EAS_REPACK_FAILED' && error.details.failure === 'timeout'
|
||||
&& /did not finish within the 30 minutes a capture has to prepare its app: run run-1 was still IN_PROGRESS; it was cancelled/.test(error.message));
|
||||
assert.equal(runs(f), 1);
|
||||
assert.deepEqual(f.cancelledRuns, ['run-1']);
|
||||
const views = f.operations().filter(operation => operation === 'workflow:view').length;
|
||||
assert.ok(views >= 85 && views <= 92, `one read every 20 s: ${views}`);
|
||||
});
|
||||
|
||||
test('a capture stopped while its repack runs cancels the run, and a start that timed out is waited on only when it named its run', async t => {
|
||||
const stop = new AbortController();
|
||||
const f = await fixture(t, { repackViews: 10 });
|
||||
const sleep = milliseconds => { clockMs += milliseconds;
|
||||
if (f.operations().filter(operation => operation === 'workflow:view').length >= 2) stop.abort(new CiError({ code: 'CAPTURE_CANCELLED', stage: 'capture', message: 'Stopped.', nextAction: 'Rerun.' })); };
|
||||
await assert.rejects(runCiMap({ ...f.options, signal: stop.signal, sleep }), error => error.code === 'CAPTURE_CANCELLED');
|
||||
assert.deepEqual(f.cancelledRuns, ['run-1']);
|
||||
assert.deepEqual(sessionOperations(f), ['simulator:start', 'simulator:stop']);
|
||||
const named = await fixture(t, { repackStart: [{ throws: true, printed: true }] });
|
||||
assert.equal((await runCiMap(named.options)).easBuildId, 'repacked-app');
|
||||
assert.equal(runs(named), 1);
|
||||
const unnamed = await fixture(t, { repackStart: [{ throws: true }] });
|
||||
await assert.rejects(runCiMap(unnamed.options), error => error.code === 'EAS_REPACK_FAILED' && error.details.failure === 'unconfirmed' && /one may have started, so Explore does not start another/.test(error.message));
|
||||
assert.equal(runs(unnamed), 1);
|
||||
// A run whose cancel EAS refuses says so.
|
||||
const refused = await fixture(t, { repackViews: 10_000, cancelFails: true });
|
||||
await assert.rejects(runCiMap(refused.options), error => /it could not be cancelled/.test(error.message));
|
||||
});
|
||||
|
||||
test('a session whose app took longer than its allowance is replaced, so the capture keeps its minutes', async t => {
|
||||
const f = await fixture(t, { repackMs: 25 * 60_000 });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, progress: line => lines.push(line) });
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
assert.equal(result.simulatorSessionId, 'session-2');
|
||||
assert.deepEqual(sessionOperations(f), ['simulator:start', 'simulator:stop', 'simulator:start', 'simulator:stop']);
|
||||
const stop = f.requests.find(request => request.args[0] === 'simulator:stop');
|
||||
assert.equal(value(stop, '--id'), 'session-1');
|
||||
assert.ok(lines.some(line => /the app took 25 minutes to prepare, more than the 20 session session-1 was started with for it; replacing it/.test(line)), lines.join('\n'));
|
||||
// Twenty minutes or less keeps the session.
|
||||
const quick = await fixture(t, { repackMs: 19 * 60_000 });
|
||||
assert.equal((await runCiMap(quick.options)).simulatorSessionId, 'session-1');
|
||||
});
|
||||
|
||||
// Two matrix jobs of one GitHub run attempt: iphone leads, duo-open follows, as hostedRepackPeers and repackShareOption give them.
|
||||
const SCOPE = 'acme/example#39506405687.1';
|
||||
const share = (target, scope = SCOPE) => ({ repackShare: { scope, leader: 'iphone', target, rank: target === 'iphone' ? 0 : 1 } });
|
||||
const shareLists = f => f.requests.filter(request => request.args[0] === 'build:list' && !request.args.includes('--fingerprint-hash')).length;
|
||||
const downloaded = f => f.requests.filter(request => request.args[0] === 'build:download').map(request => value(request, '--build-id'));
|
||||
const easBuilds = (builds = []) => ({ builds, lists: 0, views: 0 });
|
||||
const shared = message => message.match(/\[explore share [0-9a-f]{32}\]$/)?.[0];
|
||||
/** The message the leader's repack of this fixture's app gives its build, with the key the others look for. */
|
||||
async function leaderMessage(t, scope, settings = {}) {
|
||||
const eas = easBuilds();
|
||||
const leader = await fixture(t, { reuse: true, eas, ...settings });
|
||||
await runCiMap({ ...leader.options, ...share('iphone', scope) });
|
||||
return eas.builds[0].message;
|
||||
}
|
||||
async function follow(t, eas, settings = {}, options = {}) {
|
||||
const f = await fixture(t, { reuse: true, eas, ...settings });
|
||||
const lines = [];
|
||||
const run = runCiMap({ ...f.options, ...share('duo-open'), progress: line => lines.push(line), ...options });
|
||||
return { f, lines, run };
|
||||
}
|
||||
|
||||
test('two jobs of one run attempt that repack the same app share one hosted repack', async t => {
|
||||
const eas = easBuilds();
|
||||
const leader = await fixture(t, { reuse: true, eas });
|
||||
await runCiMap({ ...leader.options, ...share('iphone') });
|
||||
// The leader looks once, finds nothing, and repacks with the key in its build's message.
|
||||
assert.equal(shareLists(leader), 1);
|
||||
assert.equal(runs(leader), 1);
|
||||
assert.deepEqual(leader.requests.filter(request => request.args[0] === 'env:list').map(request => value(request, '--scope')), ['project', 'account']);
|
||||
assert.match(eas.builds[0].message, /^expo-explore ios capture: route observer repack \[explore share [0-9a-f]{32}\]$/);
|
||||
const { f, lines, run } = await follow(t, eas);
|
||||
const result = await run;
|
||||
assert.equal(runs(f), 0, 'the follower does not repack');
|
||||
assert.deepEqual(downloaded(f), ['repacked-app']);
|
||||
assert.equal(result.easBuildId, 'repacked-app');
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
assert.ok(lines.some(line => /using EAS build repacked-app, the hosted repack of this commit another target of this run made/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test("a target follows the leader's repack by its id while it runs, even once newer builds push it off the list", async t => {
|
||||
const message = await leaderMessage(t);
|
||||
const eas = easBuilds([{ id: 'leader-repack', status: 'IN_QUEUE', platform: 'IOS', message }]);
|
||||
eas.onView = state => {
|
||||
const build = state.builds.find(candidate => candidate.id === 'leader-repack');
|
||||
if (state.views === 1) state.builds.unshift(...Array.from({ length: 60 }, (_, index) => ({ id: `other-${index}`, status: 'FINISHED', platform: 'IOS', message: 'eas build' })));
|
||||
build.status = state.views >= 3 ? 'FINISHED' : 'IN_PROGRESS';
|
||||
};
|
||||
const { f, lines, run } = await follow(t, eas);
|
||||
const result = await run;
|
||||
assert.equal(runs(f), 0);
|
||||
assert.deepEqual(downloaded(f), ['leader-repack']);
|
||||
assert.equal(result.easBuildId, 'leader-repack');
|
||||
assert.deepEqual([eas.lists, eas.views], [1, 3]);
|
||||
assert.ok(lines.some(line => /waiting for EAS build leader-repack, the hosted repack of this commit another target of this run started/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test("a target whose leader's repack failed follows the leader's retry", async t => {
|
||||
const message = await leaderMessage(t);
|
||||
const eas = easBuilds([{ id: 'leader-repack', status: 'IN_PROGRESS', platform: 'IOS', message }]);
|
||||
eas.onView = (state, id) => {
|
||||
const build = state.builds.find(candidate => candidate.id === id);
|
||||
if (id === 'leader-repack') build.status = 'ERRORED';
|
||||
else if (state.views >= 3) build.status = 'FINISHED';
|
||||
};
|
||||
// The leader starts its retry while the follower looks again.
|
||||
eas.onList = state => { if (state.lists === 2) state.builds.unshift({ id: 'leader-retry', status: 'IN_QUEUE', platform: 'IOS', message }); };
|
||||
const { f, lines, run } = await follow(t, eas);
|
||||
const result = await run;
|
||||
assert.equal(runs(f), 0, 'no fourth repack beside the retry');
|
||||
assert.deepEqual(downloaded(f), ['leader-retry']);
|
||||
assert.equal(result.easBuildId, 'leader-retry');
|
||||
assert.ok(lines.some(line => /the shared repack \(EAS build leader-repack\) ended ERRORED; looking for another for up to 60 s before repacking here/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test("a target whose leader's repack failed and was not retried repacks itself, with the same key for the others", async t => {
|
||||
const message = await leaderMessage(t);
|
||||
const eas = easBuilds([{ id: 'leader-repack', status: 'IN_PROGRESS', platform: 'IOS', message }]);
|
||||
eas.onView = state => { if (state.views === 2) state.builds[0].status = 'ERRORED'; };
|
||||
const { f, lines, run } = await follow(t, eas);
|
||||
const result = await run;
|
||||
assert.equal(runs(f), 1);
|
||||
assert.equal(result.easBuildId, 'repacked-app');
|
||||
// One look at once, then one every 15 s for the minute after the failure.
|
||||
assert.ok(eas.lists >= 5 && eas.lists <= 6, `${eas.lists} lists`);
|
||||
assert.equal(eas.builds[0].message, message, "the follower's own repack carries the same key");
|
||||
assert.ok(lines.some(line => /no other repack of this commit appeared; repacking here/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test('a repack of other inputs is never used, and the wait for one ends after three minutes of modest polling', async t => {
|
||||
const message = await leaderMessage(t);
|
||||
const otherAttempt = await leaderMessage(t, 'acme/example#39506405687.2');
|
||||
// Another value in the EAS environment, and another commit of the app.
|
||||
const otherVariables = await leaderMessage(t, SCOPE, { envList: { project: 'Environment: preview\nVariables for this project:\nName EXPO_PUBLIC_API\nValue https://api.example.com\nUpdated at Oct 20 10:00:00\n' } });
|
||||
const changedEas = easBuilds();
|
||||
const changedLeader = await fixture(t, { reuse: true, eas: changedEas });
|
||||
writeFileSync(join(changedLeader.options.project, 'app.json'), JSON.stringify({ expo: { name: 'Example', slug: 'example', version: '2' } }));
|
||||
await runCiMap({ ...changedLeader.options, ...share('iphone') });
|
||||
const otherJavaScript = changedEas.builds[0].message;
|
||||
assert.equal(new Set([message, otherAttempt, otherVariables, otherJavaScript].map(shared)).size, 4, 'each input has its own key');
|
||||
const eas = easBuilds([
|
||||
{ id: 'other-attempt', status: 'FINISHED', platform: 'IOS', message: otherAttempt },
|
||||
{ id: 'other-variables', status: 'FINISHED', platform: 'IOS', message: otherVariables },
|
||||
{ id: 'other-javascript', status: 'FINISHED', platform: 'IOS', message: otherJavaScript },
|
||||
{ id: 'other-platform', status: 'FINISHED', platform: 'ANDROID', message },
|
||||
{ id: 'not-the-key', status: 'FINISHED', platform: 'IOS', message: `${message} (edited)` },
|
||||
]);
|
||||
const { f, lines, run } = await follow(t, eas);
|
||||
const result = await run;
|
||||
assert.equal(result.easBuildId, 'repacked-app', 'the follower repacked its own app');
|
||||
assert.equal(runs(f), 1);
|
||||
// One list every 15 s for three minutes, and the first at once.
|
||||
assert.ok(eas.lists >= 12 && eas.lists <= 13, `${eas.lists} lists`);
|
||||
assert.ok(lines.some(line => /no repack of this commit from iphone or another target appeared within 3 minutes; repacking here/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test('three unreadable lists in a row end the wait, and so does an abort', async t => {
|
||||
const unreadable = easBuilds(); unreadable.unreadableLists = 3;
|
||||
const { f, lines, run } = await follow(t, unreadable);
|
||||
assert.equal((await run).easBuildId, 'repacked-app');
|
||||
assert.deepEqual([unreadable.lists, runs(f)], [3, 1]);
|
||||
assert.ok(lines.some(line => /EAS did not answer three times in a row; repacking here/.test(line)), lines.join('\n'));
|
||||
const stop = new AbortController();
|
||||
const waiting = easBuilds(); waiting.onList = state => { if (state.lists === 2) stop.abort(new CiError({ code: 'CAPTURE_CANCELLED', stage: 'build', message: 'Stopped.', nextAction: 'Rerun.' })); };
|
||||
const aborted = await follow(t, waiting, {}, { signal: stop.signal });
|
||||
await assert.rejects(aborted.run, error => error.code === 'CAPTURE_CANCELLED');
|
||||
assert.equal(runs(aborted.f), 0);
|
||||
assert.deepEqual(sessionOperations(aborted.f), ['simulator:start', 'simulator:stop'], 'the session started beside the wait is stopped');
|
||||
});
|
||||
|
||||
test("a followed repack that outlasts the budget fails the target, and a wait that leaves too little for a retry does not retry", async t => {
|
||||
const message = await leaderMessage(t);
|
||||
const stuck = easBuilds([{ id: 'leader-repack', status: 'IN_PROGRESS', platform: 'IOS', message }]);
|
||||
const { f, run } = await follow(t, stuck);
|
||||
await assert.rejects(run, error => error.code === 'EAS_REPACK_FAILED' && error.details.failure === 'timeout' && /too little time was left for a repack of its own/.test(error.message));
|
||||
assert.equal(runs(f), 0);
|
||||
assert.ok(stuck.views >= 55 && stuck.views <= 61, `one read every 30 s: ${stuck.views}`);
|
||||
// The leader's repack fails 21 minutes in: this target looks for a minute, repacks, and its own refused upload 4
|
||||
// minutes later leaves too little of the budget for another.
|
||||
const late = easBuilds([{ id: 'leader-repack', status: 'IN_PROGRESS', platform: 'IOS', message }]);
|
||||
late.onView = state => { clockMs += 21 * 60_000; state.builds[0].status = 'ERRORED'; };
|
||||
const budget = await follow(t, late, { repackFailures: [uploadRefused], repackMs: 4 * 60_000 });
|
||||
const started = clockMs;
|
||||
await assert.rejects(budget.run, error => error.code === 'EAS_REPACK_FAILED' && /Failed to upload application archive/.test(error.message));
|
||||
assert.equal(runs(budget.f), 1);
|
||||
assert.ok(clockMs - started < 30 * 60_000, 'everything stayed in one 30-minute budget');
|
||||
});
|
||||
|
||||
test("a re-run attempt's target does not wait 3 minutes for a leader that may not run again, nor use the first attempt's repack", async t => {
|
||||
const eas = easBuilds();
|
||||
const first = await fixture(t, { reuse: true, eas });
|
||||
await runCiMap({ ...first.options, ...share('iphone') });
|
||||
// In a re-run the second target waits one stagger (60 s) instead of three minutes.
|
||||
const rerun = await fixture(t, { reuse: true, eas });
|
||||
await runCiMap({ ...rerun.options, repackShare: { scope: 'acme/example#39506405687.2', leader: 'iphone', target: 'duo-open', rank: 1, rerun: true } });
|
||||
assert.ok(shareLists(rerun) >= 4 && shareLists(rerun) <= 5, `${shareLists(rerun)} lists`);
|
||||
assert.equal(runs(rerun), 1);
|
||||
assert.notEqual(shared(eas.builds[0].message), shared(eas.builds[1].message));
|
||||
});
|
||||
|
||||
test('targets whose leader makes no repack join the first of them to start one instead of all repacking at once', async t => {
|
||||
const message = await leaderMessage(t);
|
||||
// duo-closed (second after the leader) waits a minute longer than duo-half-open; the latter's repack appears meanwhile.
|
||||
const eas = easBuilds();
|
||||
eas.onList = state => { if (state.lists === 14) state.builds.unshift({ id: 'half-open-repack', status: 'IN_QUEUE', platform: 'IOS', message }); };
|
||||
eas.onView = state => { if (state.views >= 2) state.builds[0].status = 'FINISHED'; };
|
||||
const f = await fixture(t, { reuse: true, eas });
|
||||
const result = await runCiMap({ ...f.options, repackShare: { scope: SCOPE, leader: 'iphone', target: 'duo-closed', rank: 2 } });
|
||||
assert.equal(runs(f), 0);
|
||||
assert.equal(result.easBuildId, 'half-open-repack');
|
||||
});
|
||||
|
||||
test('a native build this job made, or an environment EAS cannot list, is repacked here without sharing', async t => {
|
||||
const fresh = await fixture(t, { eas: easBuilds() });
|
||||
await runCiMap({ ...fresh.options, ...share('duo-open') });
|
||||
assert.equal(fresh.operations().includes('build'), true);
|
||||
assert.deepEqual([shareLists(fresh), runs(fresh)], [0, 1], 'no 3-minute wait for a key nobody else can have');
|
||||
assert.equal(fresh.operations().includes('env:list'), false);
|
||||
const eas = easBuilds();
|
||||
const unlisted = await fixture(t, { reuse: true, eas, envList: { account: null } });
|
||||
const lines = [];
|
||||
await runCiMap({ ...unlisted.options, ...share('duo-open'), progress: line => lines.push(line) });
|
||||
assert.deepEqual([shareLists(unlisted), runs(unlisted)], [0, 1]);
|
||||
assert.equal(shared(eas.builds[0].message), undefined, 'a repack without a snapshot carries no key');
|
||||
assert.ok(lines.some(line => /EAS did not list the preview environment's variables; repacking here without sharing the repack/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test("the build to repack is the newest one Explore did not repack itself", async () => {
|
||||
const { existingBuild } = await import('../../dist/capture/eas-build.js');
|
||||
const listed = JSON.stringify([{ id: 'repack-1', message: 'expo-explore ios capture: route observer repack [explore share 0123456789abcdef0123456789abcdef]' },
|
||||
{ id: 'repack-2', message: 'expo-explore ios capture: route observer repack' }, { id: 'native', message: 'Release 2.1' }, { id: 'older' }]);
|
||||
assert.equal(existingBuild(listed).id, 'native');
|
||||
assert.equal(existingBuild(JSON.stringify([{ id: 'repack-1', message: 'expo-explore ios capture: route observer repack' }])).id, 'repack-1', 'a repack when nothing else has the fingerprint');
|
||||
assert.equal(existingBuild('[]'), undefined);
|
||||
});
|
||||
|
||||
test('capture.repack: local repacks on the runner and installs the app from it, with no upload', async t => {
|
||||
for (const reuse of [false, true]) {
|
||||
const f = await fixture(t, { repack: 'local', reuse, buildMetadata: true });
|
||||
|
||||
@@ -331,3 +331,15 @@ test("compare CLI emits a comparison, review, and catalog that reload as a works
|
||||
));
|
||||
assert.deepEqual(shared.baselineScreenIds, ["shared-home"]);
|
||||
});
|
||||
|
||||
test("fingerprints from different Explore versions are not comparable: the match needs review instead of reading as changed", async () => {
|
||||
// A map saved by Explore 0.20.x hashes the tree with the keyboard and the focus in it, unprefixed; a2 hashes leave them out.
|
||||
const baseline = makeMap("main-eeeeeee", [{ id: "home", route: "/", acc: "0".repeat(64) }]);
|
||||
const current = makeMap("pr-3-fffffff", [{ id: "home", route: "/", acc: `a2:${"1".repeat(64)}` }]);
|
||||
const { comparison, review } = generateComparison(baseline, current);
|
||||
await validateComparisonDocument(comparison, baseline, current);
|
||||
const home = review.entries.find((entry) => entry.entryId === "match-home");
|
||||
assert.equal(home.needsReview, true);
|
||||
assert.match(entryById(comparison, "match-home").rationale, /different Explore versions/);
|
||||
assert.ok(home.notes.some((note) => /compare the screenshots/.test(note)));
|
||||
});
|
||||
@@ -823,3 +823,48 @@ test("a capture's snapshot backend is read from its saved controller response",
|
||||
assert.equal(snapshotBackend(directory, map("artifacts/accessibility/missing.json"), "o"), undefined);
|
||||
assert.equal(snapshotBackend(directory, map("../outside.json"), "o"), undefined);
|
||||
});
|
||||
|
||||
/**
|
||||
* Tempo on the closed iPhone Duo in brentvatne/euxy#172 (review run 39362642343): a 1398 × 2034 screenshot of a
|
||||
* 466 × 678 pt screen, and a footnote whose text changed below the fold of its scrolling sheet, so the screenshots match.
|
||||
* The published review carries no accessibility tree, so the footnote's real bounds are unknown: these tests pin the
|
||||
* rule (more than half of the changed element past the screen's edge), not where euxy's footnote was.
|
||||
*/
|
||||
function tempoSide(sideName, footnote, footnoteBounds, image = { width: 1398, height: 2034 }) {
|
||||
const evidence = side(sideName, [
|
||||
element({ elementId: "app", role: "other", label: "euxy", actions: [], actionable: false, bounds: { x: 0, y: 0, width: 466, height: 678, unit: "points" } }),
|
||||
element({ elementId: "title", role: "text", label: "Base Resolution", actions: [], actionable: false, bounds: { x: 26, y: 560, width: 300, height: 24, unit: "points" } }),
|
||||
element({ elementId: `${sideName}-footnote`, role: "text", label: footnote, actions: [], actionable: false, bounds: footnoteBounds }),
|
||||
]);
|
||||
if (image) {
|
||||
evidence.map.artifacts.push({ id: `${sideName}-shot`, kind: "screenshot", path: `${sideName}.png`, sha256: "0".repeat(64), mimeType: "image/png", ...image, createdAt: "2026-09-01T01:00:00.000Z" });
|
||||
evidence.map.observations[0].screenshotArtifactId = `${sideName}-shot`;
|
||||
}
|
||||
return evidence;
|
||||
}
|
||||
const NEW_LANES = "Changes apply live while playing. Base resolution sets the step grid for new lanes.";
|
||||
const ADD_NEXT = "Changes apply live while playing. Base resolution sets the step grid for lanes you add next.";
|
||||
// Its top 12 pt on the screen, 28 pt below the bottom edge: 70% past it.
|
||||
const mostlyBelow = { x: 26, y: 666, width: 414, height: 40, unit: "points" };
|
||||
const offScreenOf = (bounds, assessment = visual("unchanged"), image) => compareSurfaceEvidence({ impact: impact(),
|
||||
base: tempoSide("base", NEW_LANES, bounds, image), head: tempoSide("head", ADD_NEXT, bounds, image), visualAssessment: assessment }).offScreen;
|
||||
|
||||
test("matching screenshots of a change whose elements lie mostly past the screen's edge are off-screen", () => {
|
||||
assert.equal(offScreenOf(mostlyBelow), true);
|
||||
// A turned frame (an opened iPhone Duo shown upright) keeps the tree on the portrait axes: the screen is still found.
|
||||
assert.equal(offScreenOf(mostlyBelow, visual("unchanged"), { width: 2034, height: 1398 }), true);
|
||||
});
|
||||
|
||||
test("a change on the screen, partly on it, with differing screenshots, or with no screen to measure against is never off-screen", () => {
|
||||
const cases = {
|
||||
"an on-screen text change": [{ x: 26, y: 600, width: 414, height: 40, unit: "points" }],
|
||||
// Its top 28 pt on the screen, 12 pt below: mostly visible, so matching pixels prove nothing about it.
|
||||
"a footnote mostly on the screen": [{ x: 26, y: 650, width: 414, height: 40, unit: "points" }],
|
||||
// A control nudged 2 pt past the left edge, otherwise wholly visible.
|
||||
"a control just crossing an edge": [{ x: -2, y: 600, width: 300, height: 40, unit: "points" }],
|
||||
"screenshots that differ": [mostlyBelow, visual("modified")],
|
||||
"no screenshot size": [mostlyBelow, visual("unchanged"), null],
|
||||
"a changed element without bounds": [undefined],
|
||||
};
|
||||
for (const [name, args] of Object.entries(cases)) assert.equal(offScreenOf(...args), undefined, name);
|
||||
});
|
||||
@@ -5,7 +5,7 @@ import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
import { tsImport } from "tsx/esm/api";
|
||||
|
||||
const { DEFAULT_EXPLORE_CONFIG_PATH, assertExecutionMode, parseExploreConfig, readExploreConfig, validateExploreConfig, configPlatforms, configTargets, resolvePlatformConfig, resolveTargetConfig, withRunOverrides, captureRepack } =
|
||||
const { DEFAULT_EXPLORE_CONFIG_PATH, assertExecutionMode, parseExploreConfig, readExploreConfig, validateExploreConfig, configPlatforms, configTargets, resolvePlatformConfig, resolveTargetConfig, withRunOverrides, captureRepack, hostedRepackPeers } =
|
||||
await tsImport("../../src/config/explore-config.ts", import.meta.url);
|
||||
|
||||
const SOURCE = `app:
|
||||
@@ -47,6 +47,12 @@ test("rejects obsolete configuration and gives the exact next action", () => {
|
||||
assert.equal(validateExploreConfig({ ...base(), capture: { readinessSeconds: 12 } }).capture.readinessSeconds, 12);
|
||||
assert.equal("readinessSeconds" in validateExploreConfig(base()).capture, false);
|
||||
assert.throws(() => validateExploreConfig({ ...base(), capture: { readinessSeconds: 0 } }), /capture.readinessSeconds must be a positive integer/);
|
||||
// 0 never waits for a baseline still being captured; absent, the review waits DEFAULT_BASELINE_WAIT_MINUTES.
|
||||
for (const minutes of [0, 15, 60]) assert.equal(validateExploreConfig({ ...base(), capture: { baselineWaitMinutes: minutes } }).capture.baselineWaitMinutes, minutes);
|
||||
assert.equal("baselineWaitMinutes" in validateExploreConfig(base()).capture, false);
|
||||
for (const minutes of [-1, 61, 1.5, "15"]) {
|
||||
assert.throws(() => validateExploreConfig({ ...base(), capture: { baselineWaitMinutes: minutes } }), /capture.baselineWaitMinutes must be a whole number from 0 to 60/, String(minutes));
|
||||
}
|
||||
});
|
||||
|
||||
test("validates device, capture limits, providers, paths, and custom app schemes", () => {
|
||||
@@ -357,6 +363,33 @@ test("target ids and entries are validated", () => {
|
||||
assert.equal(validateExploreConfig({ ...base(), platforms, capture: { maxSessions: 1 } }).capture.maxSessions, 1);
|
||||
});
|
||||
|
||||
test("the targets that repack one app on EAS are its repack peers, led by the first in config order", () => {
|
||||
const config = validateExploreConfig({ ...base(), targets: {
|
||||
iphone: { platform: "ios" },
|
||||
"duo-closed": { platform: "ios", device: "iPhone Duo", pose: "closed" },
|
||||
"duo-open": { platform: "ios", device: "iPhone Duo", pose: "open" },
|
||||
local: { platform: "ios", simulator: "local" },
|
||||
android: { platform: "android", bundleId: "com.example.app", easProfile: "explore-apk" },
|
||||
} });
|
||||
const peers = (id, overrides) => hostedRepackPeers(config, withRunOverrides(resolveTargetConfig(config, { target: id }), overrides ?? {}), overrides);
|
||||
assert.deepEqual(peers("duo-open"), ["iphone", "duo-closed", "duo-open"]);
|
||||
assert.deepEqual(peers("android"), ["android"], "a target no other one shares an app with has only itself");
|
||||
assert.deepEqual(peers("local"), [], "a repack on this machine is shared with nobody");
|
||||
// A run that repacks on the runner (--repack local) shares nothing; one that repacks on EAS includes the local-simulator target.
|
||||
assert.deepEqual(peers("iphone", { repack: "local" }), []);
|
||||
assert.deepEqual(peers("iphone", { repack: "eas" }), ["iphone", "duo-closed", "duo-open", "local"]);
|
||||
// An override that makes every target run on a local simulator repacks each on its runner, unless it also asks for EAS.
|
||||
assert.deepEqual(peers("iphone", { simulator: "local" }), []);
|
||||
assert.deepEqual(peers("iphone", { simulator: "local", repack: "eas" }), ["iphone", "duo-closed", "duo-open", "local"]);
|
||||
// A config whose own repack setting makes one target local leaves it out of the others' peers under the same override.
|
||||
const mixed = validateExploreConfig({ ...base(), targets: { iphone: { platform: "ios" }, duo: { platform: "ios", device: "iPhone Duo" }, desk: { platform: "ios", simulator: "local" } } });
|
||||
const mixedPeers = (id, overrides) => hostedRepackPeers(mixed, withRunOverrides(resolveTargetConfig(mixed, { target: id }), overrides), overrides);
|
||||
assert.deepEqual(mixedPeers("duo", { controller: "argent" }), ["iphone", "duo"]);
|
||||
assert.deepEqual(mixedPeers("desk", { controller: "argent" }), []);
|
||||
const flat = validateExploreConfig(base());
|
||||
assert.deepEqual(hostedRepackPeers(flat, resolveTargetConfig(flat)), ["ios"]);
|
||||
});
|
||||
|
||||
test("a target can choose its own controller and simulator over capture's", () => {
|
||||
const config = validateExploreConfig({ ...base(), capture: { controller: "argent", simulator: "local" }, targets: {
|
||||
duo: { platform: "ios", device: "iPhone Duo" },
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import test from 'node:test';
|
||||
import { hostedRepackBuildId, hostedRepackWorkflow } from '../../dist/capture/eas-build.js';
|
||||
import { chmod, mkdir, mkdtemp, rm, symlink, writeFile } from 'node:fs/promises';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { join } from 'node:path';
|
||||
import { hostedRepackBuildId, hostedRepackFailure, hostedRepackRetries, hostedRepackRunStart, hostedRepackShareKey, hostedRepackShareMarker, hostedRepackWorkflow, sharedRepackBuildView, sharedRepackWaitMs, sharedRepackBuilds, stagedProjectDigest } from '../../dist/capture/eas-build.js';
|
||||
import { repackShareOption } from '../../dist/ci/pipeline.js';
|
||||
import { CiError } from '../../dist/shared/ci-errors.js';
|
||||
|
||||
test('the generated repack workflow pins the source build, skips VCS and points Metro at the staged observer', () => {
|
||||
@@ -42,3 +46,121 @@ test('an exhausted build plan surfaces as EAS_PLAN_LIMIT_REACHED even from the h
|
||||
test('non-JSON output from eas workflow:run is reported with the CLI tail', () => {
|
||||
assert.throws(() => hostedRepackBuildId('', 'Error: Not logged in\n', 'ios'), error => error instanceof CiError && error.code === 'EAS_REPACK_FAILED' && /Not logged in/.test(error.message));
|
||||
});
|
||||
|
||||
const failed = (job, stderr = '') => { try { hostedRepackBuildId(run(job), stderr, 'ios'); } catch (error) { return error; } assert.fail('the repack did not fail'); };
|
||||
|
||||
test('a repack EAS failed around is repacked twice more, an unexplained one once, and one the app, a credential, a timeout or a person ended never', () => {
|
||||
// brentvatne/euxy#176 (review run 39506405687): the upload step's report of "Turtle build is not in progress".
|
||||
const upload = failed({ key: 'repack', status: 'FAILURE', turtleBuild: { status: 'ERRORED', error: { errorCode: 'UNKNOWN_CUSTOM_BUILD_ERROR', message: 'Failed to upload application archive.' } } });
|
||||
assert.equal(upload.details.failure, 'infrastructure'); assert.equal(hostedRepackRetries(upload), 2);
|
||||
assert.equal(hostedRepackRetries(failed({ key: 'repack', status: 'FAILURE', turtleBuild: { error: { errorCode: 'SERVER_ERROR', message: 'Internal error.' } } })), 2);
|
||||
assert.equal(hostedRepackRetries(failed({ key: 'repack', status: 'ERRORED' })), 1, 'a run that says nothing is tried once more');
|
||||
const unexplained = { key: 'repack', status: 'FAILURE', turtleBuild: { error: { errorCode: 'UNKNOWN_CUSTOM_BUILD_ERROR', message: 'Unknown custom build error. See logs for more information.' } } };
|
||||
assert.equal(hostedRepackRetries(failed(unexplained)), 1);
|
||||
// What the CLI printed and the failed job's logs count too: a bundling error there is the app's.
|
||||
assert.equal(failed(unexplained, 'SyntaxError: app/home.tsx: Unexpected token (4:2)\n').details.failure, 'app');
|
||||
assert.equal(failed(unexplained, 'Build step "Repack app" failed\n').details.failure, 'app');
|
||||
assert.equal(failed(unexplained, 'Build step "Spin up build environment" failed\n').details.failure, 'infrastructure');
|
||||
for (const message of ['Build step "Repack app" failed', 'Unable to resolve module ./missing from app/index.tsx', 'SyntaxError: app/home.tsx: Unexpected token (4:2)']) {
|
||||
const error = failed({ key: 'repack', status: 'FAILURE', turtleBuild: { error: { errorCode: 'UNKNOWN_CUSTOM_BUILD_ERROR', message } } });
|
||||
assert.equal(error.details.failure, 'app', message); assert.equal(hostedRepackRetries(error), 0, message);
|
||||
}
|
||||
assert.equal(hostedRepackRetries(failed({ key: 'repack', status: 'CANCELED' })), 0, 'a run someone cancelled is not started again');
|
||||
// A build that ran out its time (a bundling hang, say) would run it out again.
|
||||
assert.equal(failed({ key: 'repack', status: 'FAILURE', turtleBuild: { error: { errorCode: 'EAS_BUILD_TIMEOUT_ERROR', message: 'Build timed out.' } } }).details.failure, 'timeout');
|
||||
// Before a run starts: a refused token is not retried, a failed upload of the staged copy is.
|
||||
assert.throws(() => hostedRepackBuildId('', 'Error: Not logged in\n', 'ios'), error => hostedRepackRetries(error) === 0);
|
||||
assert.throws(() => hostedRepackBuildId('', 'Failed to upload project sources.\nError: socket hang up\n', 'ios'), error => hostedRepackRetries(error) === 2);
|
||||
assert.equal(hostedRepackRetries(new Error('spawnSync eas ETIMEDOUT')), 0, 'a command that ran out its time is not repeated');
|
||||
// The run's own link names it, as eas workflow:view --json reports it.
|
||||
assert.equal(failed({ key: 'repack', status: 'ERRORED' }).details.logs, undefined);
|
||||
assert.throws(() => hostedRepackBuildId(JSON.stringify({ id: 'run-2', logURL: 'https://expo.dev/accounts/acme/projects/example/workflows/run-2', jobs: [{ key: 'repack', status: 'ERRORED' }] }), '', 'ios'),
|
||||
error => error.details.logs === 'https://expo.dev/accounts/acme/projects/example/workflows/run-2');
|
||||
});
|
||||
|
||||
test('only exact EAS words make a failure infrastructure, and a refused credential is never retried', () => {
|
||||
const cases = {
|
||||
infrastructure: ["Error: Cannot find module '/opt/eas/node_modules/@expo/build-tools/dist/index.js'", 'Turtle build is not in progress, it cannot save artifacts.', 'Unexpected response from server (503): Service Unavailable', 'Error: socket hang up',
|
||||
'getaddrinfo EAI_AGAIN api.expo.dev', 'Failed to start the workflow with the API.', 'Build step "Upload artifact" failed', 'Build step "Download build" failed'],
|
||||
app: ['Unable to resolve "react-native-reanimated" from "index.js"', 'Asset upload failed: could not read ./assets/icon.png', "Cannot find module './missing'",
|
||||
'Build step "Upload artifact" failed\nAsset upload failed: could not read ./assets/icon.png'],
|
||||
configuration: ['npm error code E401\nnpm error 401 Unauthorized - GET https://npm.example.com/download/@acme/ui-1.0.0.tgz', 'Error: Not logged in',
|
||||
'Entity not authorized: AppEntity[1234]', 'Request failed: 403 Forbidden'],
|
||||
timeout: ['EAS_BUILD_TIMEOUT_ERROR Build timed out.'],
|
||||
unknown: ['Unexpected response from server (400): bad request', 'a download of 500 files', 'Build step "Install dependencies" failed', 'the request has a timeout of 10 s',
|
||||
'Permission check finished', ''],
|
||||
};
|
||||
for (const [failure, texts] of Object.entries(cases)) for (const text of texts) assert.equal(hostedRepackFailure(text), failure, text);
|
||||
assert.equal(hostedRepackFailure('Turtle build is not in progress', 'CANCELED'), 'canceled');
|
||||
});
|
||||
|
||||
test('later targets wait a minute longer each, so a missing leader is replaced by one repack and not one per target', () => {
|
||||
assert.deepEqual([0, 1, 2, 3].map(rank => sharedRepackWaitMs({ rank })), [0, 180_000, 240_000, 300_000]);
|
||||
assert.deepEqual([0, 1, 2, 3].map(rank => sharedRepackWaitMs({ rank, rerun: true })), [0, 60_000, 120_000, 180_000]);
|
||||
assert.deepEqual([0, 1, 2, 3].map(rank => sharedRepackWaitMs({ rank }, true)), [60_000, 60_000, 120_000, 180_000]);
|
||||
});
|
||||
|
||||
test('a started run is known by its JSON or by the link it printed, and a start that printed neither started none', () => {
|
||||
const url = 'https://expo.dev/accounts/acme/projects/example/workflows/01a15b61-c4a2-7c7b-b950-9f280edea954';
|
||||
assert.deepEqual(hostedRepackRunStart(JSON.stringify({ id: '01a15b61-c4a2-7c7b-b950-9f280edea954', url }), '', 'ios'), { id: '01a15b61-c4a2-7c7b-b950-9f280edea954', url });
|
||||
assert.deepEqual(hostedRepackRunStart('', `Using workflow file from .eas/workflows/expo-explore-repack.yml\nSee logs: ${url}\n`, 'ios'), { id: '01a15b61-c4a2-7c7b-b950-9f280edea954', url });
|
||||
assert.throws(() => hostedRepackRunStart('', 'Failed to upload project sources.\nError: socket hang up\n', 'ios'),
|
||||
error => error.code === 'EAS_REPACK_FAILED' && hostedRepackRetries(error) === 2 && /did not start the hosted ios repack/.test(error.message));
|
||||
assert.throws(() => hostedRepackRunStart('', 'Error: Not logged in\n', 'ios'), error => hostedRepackRetries(error) === 0);
|
||||
});
|
||||
|
||||
test('the staged digest changes with any file, mode or link, and the share key with every input', async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), 'explore-staged-digest-'));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
await mkdir(join(root, 'app'));
|
||||
await writeFile(join(root, 'app', 'index.js'), 'export default 1;\n');
|
||||
await writeFile(join(root, 'package.json'), '{}\n');
|
||||
await symlink('app/index.js', join(root, 'entry.js'));
|
||||
const digests = [await stagedProjectDigest(root)];
|
||||
assert.equal(await stagedProjectDigest(root), digests[0], 'the digest is stable');
|
||||
await writeFile(join(root, 'app', 'index.js'), 'export default 2;\n'); digests.push(await stagedProjectDigest(root));
|
||||
await chmod(join(root, 'package.json'), 0o755); digests.push(await stagedProjectDigest(root));
|
||||
await rm(join(root, 'entry.js')); await symlink('package.json', join(root, 'entry.js')); digests.push(await stagedProjectDigest(root));
|
||||
await mkdir(join(root, 'empty')); digests.push(await stagedProjectDigest(root));
|
||||
assert.equal(new Set(digests).size, digests.length);
|
||||
const input = { scope: 'acme/example#39506405687.1', platform: 'ios', nativeBuildId: 'a81d5d80', easProfile: 'explore', environment: 'preview', environmentVariables: 'a'.repeat(64), project: digests[0] };
|
||||
const key = hostedRepackShareKey(input);
|
||||
assert.match(key, /^[0-9a-f]{32}$/);
|
||||
for (const [name, other] of Object.entries({ scope: 'acme/example#39506405687.2', platform: 'android', nativeBuildId: 'b0000000', easProfile: 'other', environment: 'production',
|
||||
environmentVariables: 'b'.repeat(64), project: digests[1] })) {
|
||||
assert.notEqual(hostedRepackShareKey({ ...input, [name]: other }), key, name);
|
||||
}
|
||||
});
|
||||
|
||||
test("only a build whose message ends with this key, for this platform, is another job's repack", () => {
|
||||
const marker = hostedRepackShareMarker('0'.repeat(32));
|
||||
const message = `expo-explore ios capture: route observer repack ${marker}`;
|
||||
const listed = JSON.stringify([
|
||||
{ id: 'shared', status: 'IN_PROGRESS', platform: 'IOS', message },
|
||||
{ id: 'android', status: 'FINISHED', platform: 'ANDROID', message },
|
||||
{ id: 'other-key', status: 'FINISHED', platform: 'IOS', message: `expo-explore ios capture: route observer repack ${hostedRepackShareMarker('1'.repeat(32))}` },
|
||||
{ id: 'suffixed', status: 'FINISHED', platform: 'IOS', message: `${message} and more` },
|
||||
{ id: '../escape', status: 'FINISHED', platform: 'IOS', message },
|
||||
{ id: 'no-message', status: 'FINISHED', platform: 'IOS' },
|
||||
]);
|
||||
assert.deepEqual(sharedRepackBuilds(listed, marker, 'ios'), [{ id: 'shared', status: 'IN_PROGRESS' }]);
|
||||
assert.equal(sharedRepackBuilds('Error: GraphQL request failed', marker, 'ios'), undefined);
|
||||
// A followed build is read by its id: null once it no longer carries the key, undefined when unreadable.
|
||||
assert.deepEqual(sharedRepackBuildView(JSON.stringify({ id: 'shared', status: 'FINISHED', platform: 'IOS', message }), marker, 'ios'), { id: 'shared', status: 'FINISHED' });
|
||||
assert.equal(sharedRepackBuildView(JSON.stringify({ id: 'shared', status: 'FINISHED', platform: 'IOS', message: 'edited' }), marker, 'ios'), null);
|
||||
assert.equal(sharedRepackBuildView('', marker, 'ios'), undefined);
|
||||
});
|
||||
|
||||
test("a target shares its repacks only with its own GitHub run's jobs, and only when another target repacks the same app", () => {
|
||||
const config = { target: { id: 'duo-open', platform: 'ios', label: 'Duo open' }, capture: {} };
|
||||
const environment = { GITHUB_RUN_ID: '39506405687', GITHUB_REPOSITORY: 'brentvatne/euxy' };
|
||||
assert.deepEqual(repackShareOption(config, environment, ['iphone', 'duo-open']), { repackShare: { scope: 'brentvatne/euxy#39506405687.1', leader: 'iphone', target: 'duo-open', rank: 1 } });
|
||||
// "Re-run failed jobs" is an attempt of its own, whose stagger starts at once: the first attempt's leader may not run again.
|
||||
assert.deepEqual(repackShareOption(config, { ...environment, GITHUB_RUN_ATTEMPT: '2' }, ['iphone', 'duo-open']),
|
||||
{ repackShare: { scope: 'brentvatne/euxy#39506405687.2', leader: 'iphone', target: 'duo-open', rank: 1, rerun: true } });
|
||||
assert.deepEqual(repackShareOption(config, { ...environment, GITHUB_RUN_ATTEMPT: 'x' }, ['iphone', 'duo-open']), {});
|
||||
assert.deepEqual(repackShareOption(config, environment, ['duo-open']), {}, 'a single target behaves as before');
|
||||
assert.deepEqual(repackShareOption(config, environment, undefined), {});
|
||||
assert.deepEqual(repackShareOption(config, {}, ['iphone', 'duo-open']), {}, 'outside GitHub Actions there is no run to share with');
|
||||
assert.deepEqual(repackShareOption({ ...config, capture: { repack: 'local' } }, environment, ['iphone', 'duo-open']), {});
|
||||
});
|
||||
@@ -60,6 +60,29 @@ test("ending a hold, or beginning another key, stops the first", (t) => {
|
||||
assert.equal(left, 2);
|
||||
});
|
||||
|
||||
test("a hold says when it ends, however it ends, and whether any key is held", (t) => {
|
||||
t.mock.timers.enable({ apis: ["setTimeout"] });
|
||||
const hold = createKeyHold();
|
||||
const ended = [];
|
||||
assert.ok(!hold.holding());
|
||||
hold.begin("ArrowRight", () => true, () => ended.push("released"));
|
||||
assert.ok(hold.holding());
|
||||
hold.release("ArrowLeft");
|
||||
assert.deepEqual(ended, [], "another key going up leaves it held");
|
||||
hold.release("ArrowRight");
|
||||
hold.begin("ArrowLeft", () => true, () => ended.push("replaced"));
|
||||
hold.begin("ArrowRight", () => true, () => ended.push("ended"));
|
||||
hold.end();
|
||||
let steps = 0;
|
||||
hold.begin("ArrowDown", () => (steps += 1) < 2, () => ended.push("at the end"));
|
||||
t.mock.timers.tick(HOLD_INITIAL_DELAY_MS);
|
||||
t.mock.timers.tick(holdIntervalMs(1));
|
||||
assert.deepEqual(ended, ["released", "replaced", "ended", "at the end"]);
|
||||
assert.ok(!hold.holding());
|
||||
hold.end();
|
||||
assert.equal(ended.length, 4, "an ended hold does not end again");
|
||||
});
|
||||
|
||||
test("another key ends a hold, as the OS's own repeat stops; its own repeats and a modifier do not", () => {
|
||||
const key = (code, key = code, repeat = false) => ({ code, key, repeat });
|
||||
const hold = createKeyHold();
|
||||
|
||||
@@ -0,0 +1,201 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { readFileSync } from "node:fs";
|
||||
import test from "node:test";
|
||||
import { tsImport } from "tsx/esm/api";
|
||||
|
||||
const { snapshotFromTree } = await tsImport("../../src/capture/argent-driver.ts", import.meta.url);
|
||||
const { focusedTextInput, keyboardBounds, keyboardNodes, keyboardSettle } = await tsImport("../../src/capture/keyboard.ts", import.meta.url);
|
||||
const { parseControllerOutput } = await tsImport("../../src/capture/controller-output.ts", import.meta.url);
|
||||
const { normalizeSnapshot } = await tsImport("../../src/map/store.ts", import.meta.url);
|
||||
|
||||
const fixture = name => JSON.parse(readFileSync(new URL(`../fixtures/argent-0.29/${name}`, import.meta.url), "utf8"));
|
||||
// euxy's rename sheet on iOS 26 under Argent 0.29, its field focused and the keyboard up: the head of brentvatne/euxy#172
|
||||
// (review run 39362642343). Its root holds three windows: the app's, the input view placeholder's, and the keyboard's.
|
||||
const RENAME_KEYBOARD_UP = fixture("fixture-ios-ui-tree-rename.json");
|
||||
// The same sheet a moment earlier, as the base was captured: the field focused and its cursor showing, no keyboard yet.
|
||||
const RENAME_KEYBOARD_DOWN = { ...RENAME_KEYBOARD_UP, keyboardVisible: false,
|
||||
roots: [{ ...RENAME_KEYBOARD_UP.roots[0], children: RENAME_KEYBOARD_UP.roots[0].children.slice(0, 1) }] };
|
||||
const ANDROID_RENAME = fixture("fixture-android-ui-tree-rename.json");
|
||||
|
||||
const nodesOf = tree => snapshotFromTree(tree, "ios", 1).nodes;
|
||||
const labelsOf = nodes => parseControllerOutput("agent-device", JSON.stringify({ success: true, data: { nodes } })).elements.map(element => element.label);
|
||||
const nameOf = node => node.label ?? node.identifier;
|
||||
const rect = (x, y, width, height) => ({ x, y, width, height });
|
||||
|
||||
test("the iOS keyboard Argent reports is its own windows: the input view placeholder's and the keyboard's, Emoji and Dictate included", () => {
|
||||
const nodes = nodesOf(RENAME_KEYBOARD_UP);
|
||||
assert.deepEqual(keyboardBounds(nodes), rect(0, 539, 402, 335), "the input view and prediction bar down to the bottom edge");
|
||||
const owned = [...keyboardNodes(nodes)];
|
||||
const names = owned.map(nameOf).filter(Boolean);
|
||||
for (const name of ["inputView", "SystemInputAssistantView", "Typing Predictions", "Q", "shift", "Emoji", "Dictate"]) assert.ok(names.includes(name), name);
|
||||
assert.ok(owned.every(node => node.systemKeyboard === true), "only nodes of the keyboard's windows");
|
||||
// Every element of the app's window stays, those behind the keyboard's band among them.
|
||||
const app = nodesOf(RENAME_KEYBOARD_DOWN).map(nameOf).filter(Boolean);
|
||||
for (const name of app) assert.ok(nodes.some(node => nameOf(node) === name && !keyboardNodes(nodes).has(node)), name);
|
||||
assert.ok(app.includes("AdditionalDimmingOverlay") && app.includes("Tab Bar") && app.includes("Clear name"));
|
||||
});
|
||||
|
||||
test("a keyboard up on one side only leaves the elements and the accessibility fingerprint unchanged", () => {
|
||||
// In euxy#172 the review led with "Added button “Dictate”", “Emoji” and “inputView” over the label change.
|
||||
const up = nodesOf(RENAME_KEYBOARD_UP), down = nodesOf(RENAME_KEYBOARD_DOWN);
|
||||
assert.deepEqual(labelsOf(up), labelsOf(down));
|
||||
for (const name of ["Dictate", "Emoji", "inputView", "Q"]) assert.equal(labelsOf(up).includes(name), false, name);
|
||||
// The bridge numbers nodes in order, so the app's own nodes keep their indices when the keyboard's windows follow them.
|
||||
const snapshot = nodes => JSON.stringify({ success: true, data: { nodes: nodes.map(({ ref: _ref, ...node }) => node) } });
|
||||
assert.equal(normalizeSnapshot(snapshot(up)), normalizeSnapshot(snapshot(down)));
|
||||
});
|
||||
|
||||
test("the text field with the focus is passed on from Argent", () => {
|
||||
const up = nodesOf(RENAME_KEYBOARD_UP), down = nodesOf(RENAME_KEYBOARD_DOWN);
|
||||
assert.equal(up.filter(node => node.focused === true).map(node => node.type).join(), "TextField");
|
||||
assert.equal(focusedTextInput(up), true);
|
||||
assert.equal(focusedTextInput(down), true);
|
||||
assert.equal(keyboardBounds(down), undefined);
|
||||
assert.equal(focusedTextInput(nodesOf(fixture("fixture-ios-ui-tree-home.json"))), false);
|
||||
});
|
||||
|
||||
test("an element the app identifies as inputView in its own window is the app's", () => {
|
||||
// A chat composer with testID="inputView", no keyboard up.
|
||||
const app = RENAME_KEYBOARD_DOWN.roots[0].children[0];
|
||||
const composer = { role: "AXGroup", type: "Other", identifier: "inputView", frame: rect(0, 0.8, 1, 0.1),
|
||||
children: [{ role: "AXButton", type: "Button", label: "Send", frame: rect(0.8, 0.82, 0.15, 0.05), children: [] }] };
|
||||
const tree = { ...RENAME_KEYBOARD_DOWN, roots: [{ ...RENAME_KEYBOARD_DOWN.roots[0], children: [{ ...app, children: [...app.children, composer] }] }] };
|
||||
const nodes = nodesOf(tree);
|
||||
assert.equal(keyboardNodes(nodes).size, 0);
|
||||
assert.equal(keyboardBounds(nodes), undefined);
|
||||
assert.ok(labelsOf(nodes).includes("inputView") && labelsOf(nodes).includes("Send"));
|
||||
});
|
||||
|
||||
test("a second window of the app's own, its testID inputView included, is the app's; the keyboard's windows need a Keyboard", () => {
|
||||
// The app's second UIWindow (a toast or a floating composer) with a view identified as inputView and a Save button.
|
||||
const window = { role: "AXGroup", type: "Application", frame: rect(0, 0, 1, 1), children: [
|
||||
{ role: "AXGroup", type: "Other", identifier: "inputView", frame: rect(0, 0.8, 1, 0.1),
|
||||
children: [{ role: "AXButton", type: "Button", label: "Save", frame: rect(0.8, 0.82, 0.15, 0.05), children: [] }] }] };
|
||||
const [app, placeholder, keyboard] = RENAME_KEYBOARD_UP.roots[0].children;
|
||||
const withWindows = windows => nodesOf({ ...RENAME_KEYBOARD_UP, roots: [{ ...RENAME_KEYBOARD_UP.roots[0], children: [app, ...windows] }] });
|
||||
for (const windows of [[window], [window, keyboard], [window, placeholder, keyboard]]) {
|
||||
const labels = labelsOf(withWindows(windows));
|
||||
assert.ok(labels.includes("Save") && labels.includes("inputView"), `kept beside ${windows.length - 1} keyboard windows`);
|
||||
}
|
||||
// Without the keyboard's own window, an input view placeholder window proves nothing.
|
||||
assert.ok(labelsOf(withWindows([placeholder])).includes("inputView"));
|
||||
assert.equal(keyboardNodes(withWindows([placeholder])).size, 0);
|
||||
// With it, the placeholder is the keyboard's too, as in the real tree.
|
||||
assert.equal(labelsOf(withWindows([placeholder, keyboard])).includes("inputView"), false);
|
||||
});
|
||||
|
||||
test("agent-device's keyboard is its Keyboard element and what is under it, and its host bridge's keyboard view classes", () => {
|
||||
// XCTest: the Keyboard directly under the Application, beside the app's own controls in the same band.
|
||||
const xctest = [
|
||||
{ index: 0, type: "Application", label: "Example", rect: rect(0, 0, 402, 874) },
|
||||
{ index: 1, parentIndex: 0, type: "TextField", label: "Pattern name", focused: true, rect: rect(23, 386, 355, 50) },
|
||||
{ index: 2, parentIndex: 0, type: "Keyboard", rect: rect(0, 583, 402, 233) },
|
||||
{ index: 3, parentIndex: 2, type: "Key", label: "Q", rect: rect(5, 590, 39, 54) },
|
||||
{ index: 4, parentIndex: 0, type: "Button", label: "Home tab", rect: rect(0, 800, 134, 74) },
|
||||
{ index: 5, parentIndex: 0, type: "Other", label: "Formatting toolbar", rect: rect(0, 540, 402, 43) },
|
||||
{ index: 6, parentIndex: 0, type: "Button", label: "Emoji", rect: rect(8, 300, 68, 40) },
|
||||
];
|
||||
assert.deepEqual(keyboardBounds(xctest), rect(0, 583, 402, 233));
|
||||
assert.deepEqual(labelsOf(xctest), ["Example", "Pattern name", "Home tab", "Formatting toolbar", "Emoji"]);
|
||||
// The host bridge names the dock's buttons by class, wherever they sit.
|
||||
const hostBridge = [
|
||||
{ type: "TextField", role: "RCTUITextField", label: "Pattern name", focused: true, rect: rect(23, 386, 355, 50) },
|
||||
{ type: "Button", role: "UIKeyboardDockItemButton", label: "Dictate", rect: rect(325, 806, 68, 68) },
|
||||
{ type: "Other", role: "UIAccessibilityElementKBKey", label: "Q", rect: rect(5, 590, 39, 54) },
|
||||
{ type: "Button", role: "RCTViewComponentView", label: "Profile tab", rect: rect(268, 800, 134, 74) },
|
||||
];
|
||||
assert.ok(keyboardBounds(hostBridge));
|
||||
assert.deepEqual(labelsOf(hostBridge), ["Pattern name", "Profile tab"]);
|
||||
});
|
||||
|
||||
test("nothing without a parent link is taken for the keyboard's, and keys alone are no keyboard", () => {
|
||||
// agent-device's flat shape: no parentIndex. The Keyboard element goes; nothing can be proven to be under it.
|
||||
const flat = [
|
||||
{ type: "Keyboard", rect: rect(0, 583, 402, 233) },
|
||||
{ type: "Key", label: "Q", rect: rect(5, 590, 39, 54) },
|
||||
{ type: "Button", label: "Profile tab", rect: rect(268, 800, 134, 74) },
|
||||
];
|
||||
assert.deepEqual(labelsOf(flat), ["Q", "Profile tab"]);
|
||||
// An app's own PIN pad (accessibilityRole="keyboardkey") and its footer action, with no system keyboard up.
|
||||
const pinPad = [
|
||||
{ index: 0, type: "Application", label: "Example", rect: rect(0, 0, 402, 874) },
|
||||
{ index: 1, parentIndex: 0, type: "SecureTextField", label: "PIN", focused: true, rect: rect(23, 200, 355, 50) },
|
||||
...["1", "2", "3"].map((digit, offset) => ({ index: 2 + offset, parentIndex: 0, type: "Key", label: digit, rect: rect(offset * 134, 600, 134, 70) })),
|
||||
{ index: 5, parentIndex: 0, type: "Button", label: "App footer action", rect: rect(0, 800, 402, 74) },
|
||||
];
|
||||
assert.equal(keyboardNodes(pinPad).size, 0);
|
||||
assert.equal(keyboardBounds(pinPad), undefined);
|
||||
assert.deepEqual(labelsOf(pinPad), ["Example", "PIN", "1", "2", "3", "App footer action"]);
|
||||
});
|
||||
|
||||
test("in landscape the keyboard is told apart the same way, the app's bottom bar kept", () => {
|
||||
const landscape = [
|
||||
{ index: 0, type: "Application", label: "Example", rect: rect(0, 0, 874, 402) },
|
||||
{ index: 1, parentIndex: 0, type: "TextField", label: "Search", focused: true, rect: rect(100, 60, 674, 40) },
|
||||
{ index: 2, parentIndex: 0, type: "Keyboard", rect: rect(0, 230, 874, 172) },
|
||||
{ index: 3, parentIndex: 2, type: "Key", label: "Q", rect: rect(60, 236, 70, 38) },
|
||||
{ index: 4, parentIndex: 0, type: "TabBar", label: "Tab Bar", rect: rect(0, 352, 874, 50) },
|
||||
];
|
||||
assert.deepEqual(keyboardBounds(landscape), rect(0, 230, 874, 172));
|
||||
assert.deepEqual(labelsOf(landscape), ["Example", "Search", "Tab Bar"]);
|
||||
});
|
||||
|
||||
test("an Android input method's window is the keyboard under Argent, AOSP's included, and Argent says when one shows", () => {
|
||||
const ime = pkg => ({ role: "FrameLayout", type: "android.widget.FrameLayout", bundleId: pkg, frame: rect(0, 0.6, 1, 0.4),
|
||||
children: [{ role: "Button", type: "android.widget.Button", contentDescription: "q", frame: rect(0.01, 0.65, 0.09, 0.06), children: [] }] });
|
||||
const before = snapshotFromTree(ANDROID_RENAME, "android", 1, "dev.brent.euxy").nodes;
|
||||
assert.equal(focusedTextInput(before), true, "Argent marks the focused EditText");
|
||||
assert.equal(keyboardBounds(before), undefined);
|
||||
for (const pkg of ["com.google.android.inputmethod.latin", "com.android.inputmethod.latin"]) {
|
||||
const after = snapshotFromTree({ ...ANDROID_RENAME, keyboardVisible: true, roots: [...ANDROID_RENAME.roots, ime(pkg)] }, "android", 1, "dev.brent.euxy").nodes;
|
||||
assert.deepEqual(keyboardBounds(after), rect(0, 960, 720, 640), pkg);
|
||||
assert.deepEqual(labelsOf(after), labelsOf(before), pkg);
|
||||
}
|
||||
});
|
||||
|
||||
test("the wait reads until the keyboard is in one place twice, at least twice, at most six times", () => {
|
||||
const field = { type: "TextField", label: "Pattern name", focused: true, rect: rect(23, 386, 355, 50) };
|
||||
const keyboardAt = y => [field, { index: 9, type: "Keyboard", rect: rect(0, y, 402, 874 - y) }];
|
||||
// Already up when the screen was read: one more read must find it in the same place.
|
||||
const up = keyboardSettle({ nodes: keyboardAt(583) });
|
||||
assert.equal(up.more(0), true, "a keyboard already up may still be rising");
|
||||
up.read({ nodes: keyboardAt(583) });
|
||||
assert.deepEqual([up.outcome, up.reads, up.more(250)], ["shown", 1, false]);
|
||||
// Caught rising: it moves between reads, then holds.
|
||||
const rising = keyboardSettle({ nodes: [field] });
|
||||
for (const y of [700, 583, 583]) rising.read({ nodes: keyboardAt(y) });
|
||||
assert.deepEqual([rising.outcome, rising.reads], ["shown", 3]);
|
||||
// A slow controller: the second read is owed even after a second has passed.
|
||||
const slow = keyboardSettle({ nodes: [field] });
|
||||
slow.read({ nodes: [field] });
|
||||
assert.equal(slow.more(2_500), true);
|
||||
slow.read({ nodes: [field] });
|
||||
assert.deepEqual([slow.outcome, slow.more(5_000)], ["absent", false], "no keyboard came: captured without one");
|
||||
// A slow first read without a keyboard, then the keyboard first seen still moving: read on until it holds.
|
||||
const late = keyboardSettle({ nodes: [field] });
|
||||
late.read({ nodes: [field] });
|
||||
late.read({ nodes: keyboardAt(700) });
|
||||
assert.deepEqual([late.outcome, late.more(2_500)], ["moving", true], "a moving keyboard is not given up on after a second");
|
||||
late.read({ nodes: keyboardAt(583) });
|
||||
late.read({ nodes: keyboardAt(583) });
|
||||
assert.deepEqual([late.outcome, late.reads], ["shown", 4]);
|
||||
// But not past four seconds, however few reads that was.
|
||||
const stalled = keyboardSettle({ nodes: [field] });
|
||||
stalled.read({ nodes: [field] });
|
||||
stalled.read({ nodes: keyboardAt(700) });
|
||||
assert.equal(stalled.more(4_000), false);
|
||||
// Six reads at most, however fast they come.
|
||||
const busy = keyboardSettle({ nodes: [field] });
|
||||
for (let read = 0; busy.more(0); read++) busy.read({ nodes: keyboardAt(read % 2 ? 583 : 700) });
|
||||
assert.deepEqual([busy.outcome, busy.reads], ["moving", 6]);
|
||||
// The field let go and no keyboard shows: nothing more to wait for.
|
||||
const released = keyboardSettle({ nodes: [field] });
|
||||
released.read({ nodes: [{ ...field, focused: false }] });
|
||||
assert.deepEqual([released.outcome, released.more(0)], ["unfocused", false]);
|
||||
// Argent on Android says a keyboard shows without placing it: it shows twice running.
|
||||
const android = keyboardSettle({ nodes: [field] });
|
||||
android.read({ nodes: [field], keyboardVisible: true });
|
||||
android.read({ nodes: [field], keyboardVisible: true });
|
||||
assert.equal(android.outcome, "shown");
|
||||
assert.equal(keyboardSettle({ nodes: [{ ...field, focused: false }] }), undefined, "a screen without a focused field is not waited on");
|
||||
});
|
||||
@@ -7,7 +7,7 @@ import test from "node:test";
|
||||
import { prepareCaptureReview } from "../../dist/review/capture-review.js";
|
||||
import { createSourceCapturePlan } from "../../dist/source/capture-plan.js";
|
||||
import { writeCiReportInput, exportCiReport } from "../../dist/report/artifact.js";
|
||||
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
|
||||
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, FIXTURE_ALIAS_WAIT_MS, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { ZipReader, Uint8ArrayReader, TextWriter, configure } from "@zip.js/zip.js";
|
||||
import { viewerLinks } from "../../dist/report/viewer-links.js";
|
||||
@@ -387,11 +387,76 @@ test("collectPlatformReports pairs downloaded artifact directories by platform a
|
||||
const lookups = eas.requests.filter(request => request.url.pathname.endsWith("/actions/runs/10/artifacts"));
|
||||
assert.deepEqual(lookups.map(request => request.url.searchParams.get("name")), ["explore-review-10-1-android", "explore-review-10-1-ios"]);
|
||||
assert.ok(lookups.every(request => request.options.headers.authorization === "Bearer test-token"));
|
||||
// A target whose report job failed (brentvatne/euxy#172) is left out; the others still deploy, without waiting for it.
|
||||
await rm(join(root, "reports", "explore-review-10-1-android"), { recursive: true });
|
||||
const before = eas.requests.length;
|
||||
const remaining = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport });
|
||||
assert.deepEqual(remaining.map(entry => entry.target.id), ["ios"]);
|
||||
assert.deepEqual(eas.requests.slice(before).map(request => request.url.searchParams.get("name")), ["explore-review-10-1-ios"], "no lookup for the target without a report");
|
||||
await rm(join(root, "reports", "explore-review-10-1-ios"), { recursive: true });
|
||||
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport }),
|
||||
error => error.code === "PREVIEW_REPORTS_INCOMPLETE");
|
||||
});
|
||||
|
||||
test("collectPlatformReports reads a lone target's artifacts, which download-artifact extracts into the path itself", async t => {
|
||||
const fixture = await asTarget(await exportFixture(t), TARGETS[2]);
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-fanin-lone-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
// Four of five captures failed, so each pattern matched one artifact: its files sit in --inputs and --reports themselves.
|
||||
await mkdir(join(root, "inputs"), { recursive: true }); await cp(fixture.inputPath, join(root, "inputs", "report-input.json"));
|
||||
await cp(fixture.reportPath, join(root, "reports"), { recursive: true });
|
||||
const eas = easFixture();
|
||||
const transport = async (input, options) => {
|
||||
const url = new URL(input);
|
||||
if (url.pathname.endsWith("/actions/runs/10/artifacts") && url.searchParams.get("name") === "explore-review-10-1-duo-open") {
|
||||
return new Response(JSON.stringify({ artifacts: [{ id: 33, name: "explore-review-10-1-duo-open" }] }), { status: 200 });
|
||||
}
|
||||
return eas.transport(input, options);
|
||||
};
|
||||
const [entry, ...rest] = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport });
|
||||
assert.deepEqual(rest, []);
|
||||
assert.deepEqual([entry.target.id, entry.inputPath, entry.reportPath, entry.artifactUrl.split("/").at(-1)],
|
||||
["duo-open", join(root, "inputs", "report-input.json"), join(root, "reports"), "33"]);
|
||||
// A pattern that matched nothing left no directory: there is nothing to deploy, and that is said plainly.
|
||||
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "missing"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport }),
|
||||
error => error.code === "PREVIEW_REPORTS_MISSING");
|
||||
});
|
||||
|
||||
test("collectPlatformReports looks up a report artifact the run does not list yet again, but not one its token cannot read", async t => {
|
||||
const ios = await exportFixture(t);
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-fanin-late-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const { cp } = await import("node:fs/promises");
|
||||
await mkdir(join(root, "inputs", "explore-capture-10-1-ios"), { recursive: true }); await cp(ios.inputPath, join(root, "inputs", "explore-capture-10-1-ios", "report-input.json"));
|
||||
await cp(ios.reportPath, join(root, "reports", "explore-review-10-1-ios"), { recursive: true });
|
||||
const eas = easFixture();
|
||||
const listing = answers => {
|
||||
const lookups = [];
|
||||
const transport = async (input, options) => {
|
||||
const url = new URL(input);
|
||||
if (!url.pathname.endsWith("/actions/runs/10/artifacts")) return eas.transport(input, options);
|
||||
lookups.push(url);
|
||||
const answer = answers[Math.min(lookups.length, answers.length) - 1];
|
||||
return answer ? new Response(JSON.stringify(answer.body ?? {}), { status: answer.status }) : eas.transport(input, options);
|
||||
};
|
||||
return { lookups, transport };
|
||||
};
|
||||
const pauses = [];
|
||||
const sleep = async milliseconds => { pauses.push(milliseconds); };
|
||||
// The list lags the report job's upload: empty, then a 404, then the artifact.
|
||||
const late = listing([{ status: 200, body: { artifacts: [] } }, { status: 404 }, undefined]);
|
||||
const [entry] = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: late.transport, sleep });
|
||||
assert.equal(entry.artifactUrl, artifactUrl.replace(/20$/, "21"));
|
||||
assert.equal(late.lookups.length, 3);
|
||||
assert.equal(pauses.length, 2);
|
||||
const denied = listing([{ status: 403 }]);
|
||||
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: denied.transport, sleep }),
|
||||
error => error.code === "REPORT_ARTIFACT_MISSING" && /HTTP 403/.test(error.message));
|
||||
assert.equal(denied.lookups.length, 1);
|
||||
const never = listing([{ status: 200, body: { artifacts: [] } }]);
|
||||
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: never.transport, sleep }),
|
||||
error => error.code === "REPORT_ARTIFACT_MISSING");
|
||||
assert.equal(never.lookups.length, 5);
|
||||
});
|
||||
|
||||
const now = Date.UTC(2026, 8, 11, 3, 7);
|
||||
const STALE_COMMENT = `<!-- expo-explore-ci -->
|
||||
Explore review for abc · Managed via config
|
||||
@@ -456,6 +521,20 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
|
||||
assert.match(plain.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
|
||||
assert.notEqual(plain.previewUrl, result.previewUrl, "without a fixed token the link is random");
|
||||
|
||||
// A standalone report's alias that is still behind after the whole budget: its link is the deployment, which
|
||||
// serves this run, and nothing says the alias is behind (only a fixture preview's comment explains a lagging link).
|
||||
const behind = easFixture({ aliasServes: false });
|
||||
let clock = now;
|
||||
const quiet = process.stderr.write.bind(process.stderr);
|
||||
process.stderr.write = () => true;
|
||||
let fallback;
|
||||
try {
|
||||
fallback = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky", token,
|
||||
environment: deployEnvironment, transport: behind.transport, run: behind.run, now: () => (clock += 31_000), verifyTimeoutMs: 60_000 });
|
||||
} finally { process.stderr.write = quiet; }
|
||||
assert.equal(fallback.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
|
||||
assert.equal(fallback.aliasBehind, undefined);
|
||||
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "Blue Sky",
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_ALIAS_INVALID");
|
||||
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, token: "short",
|
||||
@@ -487,21 +566,28 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/manifest.json`).map(request => request.url.searchParams.get("platform"));
|
||||
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' manifests are verified");
|
||||
|
||||
// The alias lagging the deployment past the budget is not a failed deployment: the deployment is verified, so the
|
||||
// link is the deployment's own origin and the job log carries a warning (every 2026-10-14 "HTTP 404" failure was this).
|
||||
// The alias lagging the deployment is not a failed deployment (every 2026-10-14 "HTTP 404" failure was this): the
|
||||
// deployment is verified, so after FIXTURE_ALIAS_WAIT_MS, not the whole verification budget, the pull request links
|
||||
// the alias anyway, says it is behind, and the job log carries a warning.
|
||||
const behind = easFixture({ aliasOrigin: "https://explore-viewer-pr--pr-12.expo.app", aliasServes: false });
|
||||
let clock = now; const ticking = () => (clock += 31_000);
|
||||
// Each poll really waits 3 s, so the clock moves 7 s a reading: the 20 s wait is three polls, not twenty.
|
||||
let clock = now; const ticking = () => (clock += 7_000);
|
||||
const quiet = process.stderr.write.bind(process.stderr); const logged = [];
|
||||
process.stderr.write = chunk => { logged.push(String(chunk)); return true; };
|
||||
let linked;
|
||||
try {
|
||||
linked = await deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }], project: "explore-viewer-pr", owner: "brent-org", alias: "pr-12", token,
|
||||
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 60_000 });
|
||||
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 180_000 });
|
||||
} finally { process.stderr.write = quiet; }
|
||||
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
|
||||
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
|
||||
assert.equal(linked.aliasUrl, "https://explore-viewer-pr--pr-12.expo.app");
|
||||
assert.equal(linked.aliasBehind, true);
|
||||
assert.equal(linked.deploymentUrl, "https://acme-explore--1lcbdcpwn3.expo.app", "the comment links the verified deployment beside the alias");
|
||||
assert.equal(logged.filter(line => /^Deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app serves this run's report \(\d+ s after eas deploy returned\)\./.test(line)).length, 1);
|
||||
assert.equal(logged.filter(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still answers HTTP 404 \d+ s after eas deploy returned\. The pull request links the deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app instead\./.test(line)).length, 1);
|
||||
const warning = logged.find(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still answers HTTP 404 \d+ s after eas deploy returned\. The pull request links it anyway, until it catches up, beside the deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\./.test(line));
|
||||
assert.ok(warning, logged.join(""));
|
||||
const waited = Number(/HTTP 404 (\d+) s/.exec(warning)[1]);
|
||||
assert.ok(waited >= FIXTURE_ALIAS_WAIT_MS / 1000 && waited < FIXTURE_ALIAS_WAIT_MS / 1000 + 15, `gave up on the alias after ${waited} s, not the 180 s budget`);
|
||||
assert.ok(behind.requests.some(request => request.url.origin === "https://explore-viewer-pr--pr-12.expo.app"), "the alias was polled");
|
||||
|
||||
// The example report keeps one token and the same fixtures, so an alias still on the previous deployment serves the
|
||||
@@ -513,7 +599,8 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
|
||||
linked = await deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }], project: "explore-viewer-pr", owner: "brent-org", alias: "pr-12", token,
|
||||
exportPath, environment: deployEnvironment, transport: stale.transport, run: stale.run, now: ticking, verifyTimeoutMs: 60_000 });
|
||||
} finally { process.stderr.write = quiet; }
|
||||
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
|
||||
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
|
||||
assert.equal(linked.aliasBehind, true);
|
||||
assert.equal(logged.filter(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still serves an earlier deployment \d+ s after eas deploy returned\./.test(line)).length, 1);
|
||||
|
||||
await assert.rejects(deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }, { platform: "ios", zipPath: join(root, "ios.zip") }],
|
||||
@@ -789,7 +876,9 @@ test("ci:deploy pairs target-named artifacts, deploys them in config order, and
|
||||
const entries = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport });
|
||||
assert.deepEqual(entries.map(entry => [entry.target.id, entry.platform, entry.artifactUrl.split("/").at(-1)]),
|
||||
[["iphone", undefined, "31"], ["duo-closed", undefined, "32"], ["duo-open", undefined, "33"], ["android", "android", "34"]], "config order, not directory order");
|
||||
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 })
|
||||
// The fixture serves none of these artifacts by id, so each comment's artifact lookup answers 404 through all its retries.
|
||||
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1,
|
||||
sleep: async () => {} })
|
||||
.catch(error => error);
|
||||
// Publishing each target's comment section after the deployment is the comment code's (publishCiReportComment, which needs
|
||||
// the target to name the artifact); the deployment itself must have been written per target either way.
|
||||
|
||||
@@ -679,6 +679,80 @@ test('a config without targets writes the same records and comment as before tar
|
||||
assert.deepEqual(Object.keys(readCommentRecords(after).current), ['ios', 'android']);
|
||||
});
|
||||
|
||||
/**
|
||||
* brentvatne/euxy#172, review run 39362642343: five targets, two strings changed. Tempo's footnote sits low in a
|
||||
* scrolling sheet. On the closed iPhone Duo the accessibility tree has the new text but the screenshots match: the
|
||||
* footnote runs past the bottom of the screen (`offScreen`, from the elements' bounds). On the half-open and opened Duo
|
||||
* neither the tree nor the pixels have it. Android captures no dark appearance.
|
||||
*/
|
||||
const euxyTargets = [{ id: 'iphone', platform: 'ios', label: 'iPhone 17' }, { id: 'duo-closed', platform: 'ios', label: 'iPhone Duo (closed)' },
|
||||
{ id: 'duo-half-open', platform: 'ios', label: 'iPhone Duo (half-open)' }, { id: 'duo-open', platform: 'ios', label: 'iPhone Duo (open)' },
|
||||
{ id: 'android', platform: 'android', label: 'Android' }];
|
||||
const footnote = 'Added text “Changes apply live while playing. Base resolution sets the step grid for lanes you add next.”.';
|
||||
const footnoteText = 'Added text “Changes apply live while playing\\. Base resolution sets the step grid for lanes you add next\\.”';
|
||||
function euxyReview(target, options = {}) {
|
||||
const own = { sourceImpact: ['own'], sourceScope: 'screen' };
|
||||
const matched = { verdict: 'unchanged', reason: 'matched', mismatchPercentage: 0, threshold: 0.1, tool: '[email protected]' };
|
||||
const changed = (description, mismatchPercentage) => ({ ...own,
|
||||
review: { status: 'modified', description, facts: [{ category: 'element', templateId: 'element.added', bullet: description }] },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage, threshold: 0.1, tool: '[email protected]' } });
|
||||
const inTreeOnly = { ...changed(footnote, 0), visual: matched };
|
||||
if (options.offScreen !== false) inTreeOnly.review.offScreen = true;
|
||||
if (options.diffFailed) inTreeOnly.visual = { ...matched, reason: 'diff-failed' };
|
||||
const unseen = { ...own, review: { status: 'unchanged', description: 'No visible change' }, visual: matched };
|
||||
const tempo = target === 'duo-closed' ? inTreeOnly : ['duo-half-open', 'duo-open'].includes(target) ? unseen : changed(footnote, 0.11);
|
||||
const rename = changed('Added text “Pattern name”.', 0.16);
|
||||
const schemes = target === 'android' ? [''] : ['', '@dark'];
|
||||
return review(schemes.flatMap(scheme => [
|
||||
surface(`tempo${scheme}`, 'modified', { route: '/tempo', extra: structuredClone(tempo) }),
|
||||
surface(`rename-pattern${scheme}`, 'modified', { route: '/rename-pattern', extra: structuredClone(rename) }),
|
||||
]));
|
||||
}
|
||||
async function euxyRows(reviewOf = euxyReview) {
|
||||
const { platformSectionMerge } = await import('../../dist/report/pr-comment-body.js');
|
||||
let body;
|
||||
for (const target of euxyTargets) body = platformSectionMerge(state({ artifactOnly: true, target, targets: euxyTargets, review: reviewOf(target.id),
|
||||
build: { ...state().build, platform: target.platform }, runtime: { ...state().runtime, platform: target.platform, deviceModel: target.label } }), target.id).merge(body);
|
||||
return { body, rows: listOf(body).map(line => line.replace(/\(<[^>]+>\)/, '')) };
|
||||
}
|
||||
|
||||
test('a change whose elements run past the screen on a device is named off-screen there, beside the devices that show it (euxy#172)', async () => {
|
||||
const { body, rows } = await euxyRows();
|
||||
assert.deepEqual(rows, [
|
||||
`- [\`/tempo\`] · ${footnoteText} · iPhone 17, Android only · off-screen on iPhone Duo \\(closed\\)`,
|
||||
`- [\`/rename-pattern\`] · Added text “Pattern name”`,
|
||||
`- [\`/tempo\`] (dark) · ${footnoteText} · iPhone 17 only · off-screen on iPhone Duo \\(closed\\)`,
|
||||
`- [\`/rename-pattern\`] (dark) · Added text “Pattern name” · not on Android`,
|
||||
], 'the half-open and opened Duo have no trace of it, so they stay among the devices it is not on');
|
||||
const { readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
assert.deepEqual(readCommentRecords(body).current['duo-closed'].changes.filter(change => change.offScreen).map(change => change.id), ['tempo', 'tempo@dark'],
|
||||
'the mark survives the comment round trip');
|
||||
});
|
||||
|
||||
test('without geometry that puts it past the screen, or with a failed comparison, a device keeps today\'s wording', async () => {
|
||||
// The review euxy#172 published: the closed Duo's change is accessibility-only, with nothing saying where its elements are.
|
||||
const { rows } = await euxyRows(target => euxyReview(target, { offScreen: false }));
|
||||
assert.equal(rows[0], `- [\`/tempo\`] · ${footnoteText} · not on iPhone Duo \\(half\\-open\\), iPhone Duo \\(open\\)`);
|
||||
assert.equal(rows[2], `- [\`/tempo\`] (dark) · ${footnoteText} · iPhone 17, iPhone Duo \\(closed\\) only`);
|
||||
// A comparison that failed is no verdict at all: the closed Duo is not counted among the devices with the change.
|
||||
const failed = await euxyRows(target => euxyReview(target, { diffFailed: true }));
|
||||
assert.match(failed.rows[0], / · on iPhone 17, Android$/);
|
||||
assert.doesNotMatch(failed.rows.join('\n'), /off-screen/);
|
||||
});
|
||||
|
||||
test('a change one platform has and another lacks keeps "only" and "not on"', async () => {
|
||||
// An iOS-only branch in a shared screen file: Android's capture of the screen shows no change, and says nothing off-screen.
|
||||
const iosOnly = target => {
|
||||
const reviewed = euxyReview(target);
|
||||
if (target === 'android') for (const entry of reviewed.surfaces) Object.assign(entry, { review: { status: 'unchanged', description: 'No visible change' },
|
||||
visual: { verdict: 'unchanged', reason: 'matched', mismatchPercentage: 0, threshold: 0.1, tool: '[email protected]' } });
|
||||
return reviewed;
|
||||
};
|
||||
const { rows } = await euxyRows(iosOnly);
|
||||
assert.equal(rows[0], `- [\`/tempo\`] · ${footnoteText} · iPhone 17 only · off-screen on iPhone Duo \\(closed\\)`);
|
||||
assert.match(rows.find(row => row.startsWith('- [`/rename-pattern`] ·')), / · not on Android$/);
|
||||
});
|
||||
|
||||
test('several targets share a comment: named in config order in the subtitle, each linking its report, keyed by id in the records and history', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const [iphone, closed, open, android] = duoTargets;
|
||||
@@ -710,6 +784,53 @@ test('several targets share a comment: named in config order in the subtitle, ea
|
||||
assert.match(next, /\n- \[bbbbbbbb\]\(<[^>]+>\) · iPhone 17 🟩 3 changes \(.*?\) · iPhone Duo \\\(closed\\\) ⏳ did not finish \(.*?\) · iPhone Duo \\\(open\\\) 🟩 3 changes \(.*?\) · Pixel 7 🟩 3 changes /);
|
||||
});
|
||||
|
||||
test('one of five targets failed: the comment shows the four reports and that failure, and no new-run banner (brentvatne/euxy#172)', async t => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const { publishFailureComment } = await import('../../dist/report/failure-comment.js');
|
||||
const { mkdir, mkdtemp, rm, writeFile } = await import('node:fs/promises');
|
||||
const { tmpdir } = await import('node:os');
|
||||
const { join } = await import('node:path');
|
||||
const targets = [...duoTargets, { id: 'pixel-dark', platform: 'android', label: 'Pixel 7 (dark)' }];
|
||||
const configPath = '.expo-explore/config.yaml';
|
||||
const firstAttempt = viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/42/artifacts/7650', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '1', configPath });
|
||||
const working = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath });
|
||||
// Attempt 1 published every target; attempt 2 captured them all at once, and the iPhone Duo (open) session failed.
|
||||
let body;
|
||||
for (const target of targets) body = platformSectionMerge(targetState(target, { targets, links: firstAttempt }), target.id).merge(body);
|
||||
for (const target of targets) body = platformSectionMerge(targetState(target, { targets, links: working, phase: 'capturing', review: undefined, evidence: undefined,
|
||||
capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 1 }, baseFromCache: false, current: 'head' } }), target.id).merge(body);
|
||||
assert.match(visible(body), /New run in progress/);
|
||||
for (const target of targets.filter(target => target.id !== 'duo-open')) body = platformSectionMerge(targetState(target, { targets }), target.id).merge(body);
|
||||
|
||||
const root = await mkdtemp(join(tmpdir(), 'explore-one-failed-')); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
for (const target of targets) await mkdir(join(root, 'capture', `explore-diagnostics-42-2-${target.id}`, 'explore-diagnostics'), { recursive: true });
|
||||
await writeFile(join(root, 'capture', 'explore-diagnostics-42-2-duo-open', 'explore-diagnostics', 'error.json'), JSON.stringify({ code: 'ARGENT_TOOL_FAILED', stage: 'session',
|
||||
message: 'fold: argent run fold failed: [Tool:fold] Service dependency failed', nextAction: 'Rerun the capture.', retryable: false, target: 'duo-open' }));
|
||||
let comments = [{ id: 5, user: { login: 'github-actions[bot]' }, body }];
|
||||
const transport = async (input, init = {}) => {
|
||||
const url = new URL(input);
|
||||
if (url.pathname === '/repos/expo/explore-playground/pulls/1') return Response.json({ state: 'open', draft: false, title: pullRequest.title, html_url: pullRequest.url,
|
||||
base: { ref: 'main', sha: baseSha, repo: { id: 1, full_name: pullRequest.repository } }, head: { ref: pullRequest.head.ref, sha: headSha, repo: { full_name: pullRequest.repository } } });
|
||||
if (url.pathname === '/repos/expo/explore-playground/issues/1/comments') return Response.json(comments);
|
||||
if (url.pathname === '/repos/expo/explore-playground/issues/comments/5' && init.method === 'PATCH') {
|
||||
comments = [{ ...comments[0], body: JSON.parse(init.body).body }]; return Response.json({ id: 5 });
|
||||
}
|
||||
throw new Error(`unexpected request ${init.method ?? 'GET'} ${url}`);
|
||||
};
|
||||
assert.deepEqual(await publishFailureComment({ repository: pullRequest.repository, pullNumber: 1, headSha, baseSha, runId: '42', runAttempt: '2', diagnosticsPath: root,
|
||||
environment: { GITHUB_TOKEN: 'test-token' }, transport }), { posted: true });
|
||||
const final = comments[0].body;
|
||||
assert.doesNotMatch(visible(final), /New run in progress|New run failed/);
|
||||
assert.equal(readCommentRecords(final).previous, undefined, "attempt 1's records go once every target of attempt 2 finished");
|
||||
const records = readCommentRecords(final).current;
|
||||
assert.deepEqual(targets.map(target => [records[target.id].runAttempt, records[target.id].phase]),
|
||||
[['2', 'ready'], ['2', 'ready'], ['2', 'failed'], ['2', 'ready'], ['2', 'ready']]);
|
||||
assert.match(statusOf(final, 'iPhone Duo \\(open\\)'), /^\*\*iPhone Duo \\\(open\\\) failed\*\* · session · ARGENT\\_TOOL\\_FAILED\\: fold\\: argent run fold failed/);
|
||||
// Each published target links its report; the failure's record is the newest, so it sets the updated time.
|
||||
assert.ok(subtitleOf(final).startsWith(`<sub>[iPhone 17](<${reportUrl}>) · [iPhone Duo \\(closed\\)](<${reportUrl}>) · iPhone Duo \\(open\\) · [Pixel 7](<${reportUrl}>) · [Pixel 7 \\(dark\\)](<${reportUrl}>) · ${commits} · updated `), subtitleOf(final));
|
||||
assert.equal(titleOf(final), `### 3 screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
});
|
||||
|
||||
test('a comment written by a per-platform version keeps parsing, and malformed target records are dropped', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const { encodeRecordPayload } = await import('../../dist/report/pr-comment-record.js');
|
||||
@@ -796,3 +917,16 @@ test('an excluded route is neither listed nor counted as an app-wide screen', ()
|
||||
const body = renderPublicComment(state({ review: review([...evidenceReview().surfaces, excluded]) }));
|
||||
assert.doesNotMatch(body, /\/channel|App-wide source changes|not compared/);
|
||||
});
|
||||
|
||||
test('an excluded route that is new is not one of the changed screens, nor of the ones the list links to', () => {
|
||||
const screens = Array.from({ length: 11 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
|
||||
review: { status: 'modified', description: `Changed ${index}` },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' },
|
||||
} }));
|
||||
const excluded = surface('channel', 'added', { route: '/c/[channel]', extra: { excluded: true } });
|
||||
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete excluded[key];
|
||||
const body = renderPublicComment(state({ review: review([...screens, excluded]) }));
|
||||
assert.equal(titleOf(body), `### 11 screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
assert.equal(listOf(body).at(-1), `- [1 more screen in the report](<${reportUrl}>)`);
|
||||
assert.doesNotMatch(body, /\/c\/\[channel\]/);
|
||||
});
|
||||
@@ -320,3 +320,15 @@ test("an excluded surface carries no capture evidence", () => {
|
||||
excluded.surfaces[1].excluded = false;
|
||||
assert.throws(() => assertPublicReview(excluded), /excluded surface carries capture evidence/);
|
||||
});
|
||||
|
||||
test("a review says its change is off-screen only on a modified verdict whose screenshots match", () => {
|
||||
const offScreen = (status, verdict) => {
|
||||
const input = review();
|
||||
input.surfaces[0].review = { status, description: status === "modified" ? "Added text “lanes you add next”." : "No visible change", offScreen: true };
|
||||
input.surfaces[0].visual = { verdict, reason: verdict === "unchanged" ? "matched" : "repeated-cross-build-delta", mismatchPercentage: verdict === "unchanged" ? 0 : 3, threshold: 0.1, tool: "[email protected]" };
|
||||
return input;
|
||||
};
|
||||
assert.doesNotThrow(() => assertPublicReview(offScreen("modified", "unchanged")));
|
||||
assert.throws(() => assertPublicReview(offScreen("modified", "modified")), /inconsistent/);
|
||||
assert.throws(() => assertPublicReview(offScreen("unchanged", "unchanged")), /inconsistent/);
|
||||
});
|
||||
@@ -13,6 +13,13 @@ const { presentScreensByPath, presentBuildDiff } = await tsImport(
|
||||
const { artifactUrl, indexMap } = await tsImport("../../viewer/src/utils/model.ts", import.meta.url);
|
||||
const { primaryScreenshotForScreen } = await tsImport("../../viewer/src/utils/screen-images.ts", import.meta.url);
|
||||
const { buildObservedGraph, buildViewerGraph, projectFullGraph } = await tsImport("../../viewer/src/utils/graph-model.ts", import.meta.url);
|
||||
const { omittedScreenIds, omittedSourceScreenIds, reportScreens, withoutOmittedScreens } = await tsImport("../../viewer/src/utils/omitted-screens.ts", import.meta.url);
|
||||
const { reviewChanges } = await import("../../dist/report/pr-comment-body.js");
|
||||
const { neverCapturedSurfaceIds } = await tsImport("../../src/contracts/surface-capture.ts", import.meta.url);
|
||||
const { buildSearchItems } = await tsImport("../../viewer/src/utils/search.ts", import.meta.url);
|
||||
|
||||
/** The Map as the Viewer draws a map without a comparison: its own screens, less the ones it never captured. */
|
||||
const viewerGraph = (map, index = indexMap(map)) => buildViewerGraph(map, index, omittedScreenIds(map));
|
||||
|
||||
function entry(id, route, variant = "default", extra = {}) {
|
||||
return {
|
||||
@@ -124,10 +131,10 @@ test("source navigation projects directional context and route variants without
|
||||
assert.equal(payload.coverage.transitions, 0);
|
||||
for (const collection of ["transitions", "actionAttempts", "journeys"]) assert.deepEqual(payload.map[collection], []);
|
||||
assert.equal(buildObservedGraph(payload.map, indexMap(payload.map)).groups.length, 0);
|
||||
const viewerGraph = buildViewerGraph(payload.map, indexMap(payload.map));
|
||||
assert.deepEqual(viewerGraph.screens.map(screen => screen.id).sort(), ["camera-alias", "games-free", "games-pro", "scan-breed", "scan-mood"]);
|
||||
assert.equal(viewerGraph.groups.length, 2);
|
||||
assert.ok(viewerGraph.groups.every(group => group.transitionIds.length === 0 && group.sourceEdges.length > 0));
|
||||
const graph = viewerGraph(payload.map);
|
||||
assert.deepEqual(graph.screens.map(screen => screen.id).sort(), ["camera-alias", "games-free", "games-pro", "scan-breed", "scan-mood"]);
|
||||
assert.equal(graph.groups.length, 2);
|
||||
assert.ok(graph.groups.every(group => group.transitionIds.length === 0 && group.sourceEdges.length > 0));
|
||||
const presentation = presentScreensByPath(payload.map);
|
||||
const scan = presentation.map.screens.find(screen => screen.route === "/scan/instruction");
|
||||
assert.equal(scan.variantIds.length, 2);
|
||||
@@ -139,7 +146,7 @@ test("source navigation projects directional context and route variants without
|
||||
test("public map omits redirects and unselected changes routes while retaining selected failures", () => {
|
||||
const review = verifyImages(fixture("changes"));
|
||||
const current = workspaceSides(publicReviewToWorkspace(review)).current;
|
||||
const graph = buildViewerGraph(current.map, indexMap(current.map));
|
||||
const graph = viewerGraph(current.map);
|
||||
assert.deepEqual(graph.screens.map(screen => screen.id).sort(), ["care-guide", "games-free"]);
|
||||
assert.equal(current.map.screens.length, 7, "the published source inventory remains available");
|
||||
|
||||
@@ -149,7 +156,7 @@ test("public map omits redirects and unselected changes routes while retaining s
|
||||
status: "failed", attempts: 1, landing: "unverified", reason: "Capture failed",
|
||||
};
|
||||
const failedMap = workspaceSides(publicReviewToWorkspace(failed)).current.map;
|
||||
const failedGraph = buildViewerGraph(failedMap, indexMap(failedMap));
|
||||
const failedGraph = viewerGraph(failedMap);
|
||||
assert.equal(failedGraph.screens.some(screen => screen.id === "scan-mood"), true);
|
||||
assert.equal(failedGraph.screens.some(screen => screen.id === "home"), false);
|
||||
});
|
||||
@@ -833,7 +840,7 @@ test("an excluded route leaves the map with an accepted gap, like a redirect", (
|
||||
excluded.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete excluded[`${side}Image`]; delete excluded[`${side}Outcome`]; }
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(review));
|
||||
const graph = buildViewerGraph(current.map, indexMap(current.map));
|
||||
const graph = viewerGraph(current.map);
|
||||
assert.equal(graph.screens.some(screen => screen.id === "games-pro"), false, "never captured, so not a card on the map");
|
||||
assert.ok(current.map.screens.some(screen => screen.id === "games-pro"), "the inventory still knows the route");
|
||||
const gap = current.map.gaps.find(gap => gap.screenId === "games-pro");
|
||||
@@ -885,3 +892,151 @@ test("a screen's note is its first open gap of any kind, and an accepted gap onl
|
||||
assert.equal(indexMap({ ...current.map, gaps: [resolved, accepted] }).screenNotes.get("games-free"), accepted.message);
|
||||
assert.equal(indexMap({ ...current.map, gaps: [resolved] }).screenNotes.has("games-free"), false);
|
||||
});
|
||||
|
||||
/** What the Viewer leaves out of a review and the comparison it then shows, computed as app.tsx does. */
|
||||
function viewerOmission(review) {
|
||||
const workspace = publicReviewToWorkspace(review);
|
||||
const diff = diffFor(review);
|
||||
const presentation = presentScreensByPath(diff.map);
|
||||
const omitted = omittedScreenIds(diff.map, { diff, presentation });
|
||||
const presented = presentBuildDiff(diff, presentation);
|
||||
// The surfaces the Viewer leaves out, before path grouping: a removed screen goes back to its surface id.
|
||||
const removed = new Map(review.surfaces.map(surface => [removedScreenId(workspace.catalog.defaultBaselineBuildId, surface.id), surface.id]));
|
||||
const surfaces = new Set([...omittedSourceScreenIds(diff.map, diff)].map(id => removed.get(id) ?? id));
|
||||
return { diff, presentation, omitted, presented, shown: withoutOmittedScreens(presented, omitted), surfaces,
|
||||
graph: buildViewerGraph(presentation.map, presentation.index, omitted) };
|
||||
}
|
||||
|
||||
test("a public report's never-captured routes are not its screens anywhere; a captured screen and a local map keep theirs", () => {
|
||||
const review = verifyImages(fixture());
|
||||
// A new route named in exploration.exclude, and a route that was a redirect and is now a captured screen.
|
||||
review.surfaces.push({ id: "channel", status: "added", excluded: true, base: null, head: entry("channel", "/c/[channel]") });
|
||||
const nowCaptured = review.surfaces.find(surface => surface.id === "games-pro");
|
||||
nowCaptured.status = "modified";
|
||||
nowCaptured.base = entry("games-pro", "/games", "pro", { kind: "redirect", redirectTo: "/games" });
|
||||
delete nowCaptured.baseImage; delete nowCaptured.baseOutcome;
|
||||
const { presentation, presented, omitted, shown, graph } = viewerOmission(review);
|
||||
assert.equal(presented.screens.get("channel").status, "added", "the comparison alone would count it as a change");
|
||||
|
||||
assert.deepEqual([...omitted].sort(), ["channel", "home"], "the excluded route and the redirect; the route captured now stays");
|
||||
assert.deepEqual(reportScreens(presentation.map.screens, omitted).map(screen => screen.id).sort(),
|
||||
graph.screens.map(screen => screen.id).sort(), "Screens lists what the Map draws");
|
||||
assert.deepEqual(buildSearchItems({ screens: reportScreens(presentation.map.screens, omitted) }).filter(item => omitted.has(item.screenId)), []);
|
||||
|
||||
assert.deepEqual([...shown.screens.keys()].filter(id => omitted.has(id)), []);
|
||||
assert.equal(shown.counts.added, presented.counts.added - 1);
|
||||
assert.equal(shown.counts["not-compared"], presented.counts["not-compared"] - 1);
|
||||
assert.equal(Object.values(shown.counts).reduce((sum, count) => sum + count, 0), shown.screens.size);
|
||||
assert.ok(shown.index.screens.has("channel"), "a link to it still opens it");
|
||||
assert.equal(shown.index.screenNotes.get("channel"), "Excluded by exploration.exclude; never captured");
|
||||
|
||||
// A captured route whose excluded variant joins it on one card stays on the Map and in Screens.
|
||||
const variants = navigationReview();
|
||||
const pro = variants.surfaces.find(surface => surface.id === "games-pro");
|
||||
pro.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete pro[`${side}Image`]; delete pro[`${side}Outcome`]; }
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(variants));
|
||||
const family = presentScreensByPath(current.map);
|
||||
const familyOmitted = omittedScreenIds(current.map, { presentation: family });
|
||||
const games = family.map.screens.find(screen => screen.route === "/games");
|
||||
assert.equal(games.variantIds.length, 2);
|
||||
assert.ok(reportScreens(family.map.screens, familyOmitted).includes(games));
|
||||
assert.ok(buildViewerGraph(family.map, family.index, familyOmitted).screens.includes(games));
|
||||
|
||||
// A local map with the same gaps lists every screen.
|
||||
const diff = diffFor(review);
|
||||
const local = { ...diff.map, run: { ...diff.map.run, id: "local-run" } };
|
||||
assert.equal(omittedScreenIds(local, { diff, presentation: presentScreensByPath(local) }).size, 0);
|
||||
});
|
||||
|
||||
test("an open capture gap keeps a screen that also has an accepted one, from the baseline or from a sibling", () => {
|
||||
// `/scan/camera` was a redirect and is now a screen whose capture failed: the comparison retargets the baseline's
|
||||
// accepted redirect gap onto it, beside the head's open failure.
|
||||
const redirected = verifyImages(fixture());
|
||||
const camera = redirected.surfaces.find(surface => surface.id === "camera-alias");
|
||||
camera.status = "modified";
|
||||
camera.base = entry("camera-alias", "/scan/camera?action=mood", "mood", { kind: "redirect", redirectTo: "/games" });
|
||||
delete camera.baseImage; delete camera.baseOutcome; delete camera.headImage;
|
||||
camera.headOutcome = { status: "failed", attempts: 2, landing: "unverified", reason: "timeout" };
|
||||
const baseline = viewerOmission(redirected);
|
||||
assert.deepEqual(baseline.diff.map.gaps.filter(gap => gap.screenId === "camera-alias").map(gap => gap.status).sort(), ["accepted", "open"]);
|
||||
assert.equal(baseline.omitted.has("camera-alias"), false);
|
||||
assert.equal(baseline.shown.screens.get("camera-alias").status, "unavailable");
|
||||
assert.equal(baseline.shown.counts.unavailable, 1, "the failed capture is still counted");
|
||||
assert.ok(baseline.graph.screens.some(screen => screen.id === "camera-alias"));
|
||||
assert.equal(neverCapturedSurfaceIds(redirected).has("camera-alias"), false);
|
||||
|
||||
// `/games` free's capture failed and `/games` pro is excluded: both gaps land on the one `/games` card.
|
||||
const sibling = verifyImages(fixture());
|
||||
const pro = sibling.surfaces.find(surface => surface.id === "games-pro");
|
||||
pro.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete pro[`${side}Image`]; delete pro[`${side}Outcome`]; }
|
||||
const free = sibling.surfaces.find(surface => surface.id === "games-free");
|
||||
delete free.headImage;
|
||||
free.headOutcome = { status: "failed", attempts: 2, landing: "unverified", reason: "timeout" };
|
||||
const merged = viewerOmission(sibling);
|
||||
assert.equal(merged.omitted.has("games-free"), false);
|
||||
assert.equal(merged.shown.screens.get("games-free").status, "unavailable");
|
||||
assert.equal(merged.shown.counts.unavailable, 1);
|
||||
assert.ok(merged.surfaces.has("games-pro"), "the excluded variant itself is still never captured");
|
||||
assert.equal(merged.surfaces.has("games-free"), false);
|
||||
});
|
||||
|
||||
test("a removed screen keeps its card when the route that replaces it on the same path is a redirect or excluded", () => {
|
||||
for (const replacement of [
|
||||
{ kind: "redirect", entry: entry("sweet-bee-new", "/games/sweet-bee", "default", { kind: "redirect", redirectTo: "/games" }) },
|
||||
{ kind: "excluded", entry: entry("sweet-bee-new", "/games/sweet-bee"), excluded: true },
|
||||
]) {
|
||||
const review = verifyImages(fixture());
|
||||
review.surfaces.push({ id: "sweet-bee-new", status: "added", base: null, head: replacement.entry,
|
||||
...(replacement.excluded ? { excluded: true } : {}) });
|
||||
const { omitted, shown, graph, surfaces, presentation } = viewerOmission(review);
|
||||
const card = presentation.representativeIdByScreenId.get("sweet-bee-new");
|
||||
assert.equal(omitted.has(card), false, `${replacement.kind}: the removed screen's capture keeps the card`);
|
||||
assert.ok(shown.screens.get(card)?.beforeScreenshot, `${replacement.kind}: Compare and Changes keep the removed screenshot`);
|
||||
assert.ok(graph.screens.some(screen => screen.id === card));
|
||||
assert.ok(surfaces.has("sweet-bee-new"), `${replacement.kind}: the replacement on its own is never captured`);
|
||||
assert.equal(surfaces.has("sweet-bee"), false);
|
||||
assert.equal(reviewChanges(review).get("sweet-bee"), "removed", "the comment lists the removal the Viewer shows");
|
||||
}
|
||||
});
|
||||
|
||||
test("a captured screen that becomes a redirect keeps its card and its screenshot from before", () => {
|
||||
const review = verifyImages(fixture());
|
||||
const camera = review.surfaces.find(surface => surface.id === "camera-alias");
|
||||
camera.status = "modified";
|
||||
camera.head = entry("camera-alias", "/scan/camera?action=mood", "mood", { kind: "redirect", redirectTo: "/games" });
|
||||
delete camera.headImage; delete camera.headOutcome;
|
||||
const { omitted, shown, graph, surfaces } = viewerOmission(review);
|
||||
assert.equal(omitted.has("camera-alias"), false);
|
||||
assert.ok(shown.screens.get("camera-alias").beforeScreenshot);
|
||||
assert.ok(graph.screens.some(screen => screen.id === "camera-alias"));
|
||||
assert.equal(surfaces.has("camera-alias"), false);
|
||||
assert.equal(neverCapturedSurfaceIds(review).has("camera-alias"), false);
|
||||
});
|
||||
|
||||
test("the Viewer leaves out exactly the surfaces the PR comment skips", () => {
|
||||
const review = verifyImages(fixture());
|
||||
review.surfaces.push(
|
||||
{ id: "channel", status: "added", excluded: true, base: null, head: entry("channel", "/c/[channel]") },
|
||||
{ id: "old-start", status: "removed", base: entry("old-start", "/start", "default", { kind: "redirect", redirectTo: "/games" }), head: null },
|
||||
{ id: "sweet-bee-new", status: "added", base: null, head: entry("sweet-bee-new", "/games/sweet-bee", "default", { kind: "redirect", redirectTo: "/games" }) },
|
||||
);
|
||||
const camera = review.surfaces.find(surface => surface.id === "camera-alias");
|
||||
camera.head = entry("camera-alias", "/scan/camera?action=mood", "mood", { kind: "redirect", redirectTo: "/games" });
|
||||
camera.status = "modified";
|
||||
delete camera.headImage; delete camera.headOutcome;
|
||||
const skipped = neverCapturedSurfaceIds(review);
|
||||
assert.deepEqual([...skipped].sort(), ["channel", "home", "old-start", "sweet-bee-new"]);
|
||||
assert.deepEqual([...viewerOmission(review).surfaces].sort(), [...skipped].sort());
|
||||
const listed = reviewChanges(review);
|
||||
for (const id of skipped) assert.equal(listed.has(id), false, `${id} is not a listed change`);
|
||||
assert.equal(listed.get("care-guide"), "added");
|
||||
assert.equal(listed.get("sweet-bee"), "removed");
|
||||
|
||||
const changes = verifyImages(fixture("changes"));
|
||||
assert.deepEqual([...viewerOmission(changes).surfaces].sort(), [...neverCapturedSurfaceIds(changes)].sort());
|
||||
const navigated = navigationReview();
|
||||
assert.deepEqual([...viewerOmission(navigated).surfaces].sort(), [...neverCapturedSurfaceIds(navigated)].sort());
|
||||
assert.ok(neverCapturedSurfaceIds(navigated).size > 0);
|
||||
});
|
||||
@@ -14,13 +14,62 @@ function easFake(listed) {
|
||||
return { calls, eas };
|
||||
}
|
||||
|
||||
test("a session's control actions come from --list, by session id; an older session or CLI has none", () => {
|
||||
test("a session's control actions come from --list, by session id", () => {
|
||||
const { calls, eas } = easFake(JSON.stringify({ "appearance.set": {}, "springboard.restart": {} }));
|
||||
assert.deepEqual([...simulatorControlActions(eas, "session-1")], ["appearance.set", "springboard.restart"]);
|
||||
assert.deepEqual(calls[0].args, ["simulator:control", "--list", "--id", "session-1", "--json", "--non-interactive"]);
|
||||
assert.equal(calls[0].options.allowFailure, true);
|
||||
assert.equal(simulatorControlActions(easFake("Unknown command simulator:control").eas, "session-1").size, 0);
|
||||
assert.equal(simulatorControlActions(easFake(new Error("eas exited 1")).eas, "session-1").size, 0);
|
||||
});
|
||||
|
||||
test("a session that lists no actions, or whose serve-sim or EAS CLI predates the list, has none, and is asked once", () => {
|
||||
const pauses = [];
|
||||
const options = { sleep: milliseconds => pauses.push(milliseconds) };
|
||||
const empty = easFake("{}");
|
||||
assert.equal(simulatorControlActions(empty.eas, "session-1", options).size, 0);
|
||||
assert.equal(empty.calls.length, 1);
|
||||
// eas-cli 25.2.0 on a session whose serve-sim refuses `actions.describe`, and an EAS CLI without simulator:control.
|
||||
for (const reason of ["This simulator session runs a serve-sim version that does not support this action. Start a new session with `eas simulator:start` to get a newer version.",
|
||||
"The simulator did not return its list of actions. Start a new session with `eas simulator:start` to get a newer serve-sim version."]) {
|
||||
const calls = [];
|
||||
const eas = args => { calls.push(args); return { stdout: "", stderr: `${reason}\nError: simulator:control command failed.\n`, status: 1 }; };
|
||||
assert.equal(simulatorControlActions(eas, "session-1", options).size, 0);
|
||||
assert.equal(calls.length, 1);
|
||||
}
|
||||
assert.equal(simulatorControlActions(easFake(new Error("eas exited with status 2: command simulator:control not found")).eas, "session-1", options).size, 0);
|
||||
assert.deepEqual(pauses, []);
|
||||
});
|
||||
|
||||
// One failed list made the dark session of euxy's main baseline run 39487618529 look as if it offered no actions.
|
||||
function flakyList(failures, failure = () => ({ stdout: "", stderr: "The simulator preview server closed the connection before it answered.\nError: simulator:control command failed.\n", status: 1 })) {
|
||||
const calls = [];
|
||||
const eas = args => {
|
||||
calls.push(args);
|
||||
if (calls.length <= failures) return failure(calls.length);
|
||||
return { stdout: JSON.stringify({ "appearance.set": {}, "app.approveUrlScheme": {}, "springboard.restart": {} }), stderr: "", status: 0 };
|
||||
};
|
||||
return { calls, eas };
|
||||
}
|
||||
|
||||
test("a list that fails once is asked for again after a pause, and its actions are kept", () => {
|
||||
for (const failure of [undefined, () => { throw new Error("eas simulator:control exited with status 1"); }, () => ({ stdout: "Connecting", stderr: "" })]) {
|
||||
const { calls, eas } = flakyList(1, failure);
|
||||
const pauses = [];
|
||||
assert.deepEqual([...simulatorControlActions(eas, "session-1", { sleep: milliseconds => pauses.push(milliseconds) })], ["appearance.set", "app.approveUrlScheme", "springboard.restart"]);
|
||||
assert.equal(calls.length, 2);
|
||||
assert.deepEqual(calls[1], calls[0]);
|
||||
assert.equal(pauses.length, 1);
|
||||
}
|
||||
});
|
||||
|
||||
test("a list that keeps failing throws a retryable error naming the session and EAS's reason, never an empty set", () => {
|
||||
const { calls, eas } = flakyList(Infinity);
|
||||
const pauses = [];
|
||||
assert.throws(() => simulatorControlActions(eas, "session-1", { sleep: milliseconds => pauses.push(milliseconds) }), error =>
|
||||
error.code === "SIMULATOR_CONTROL_UNAVAILABLE" && error.retryable === true && error.stage === "session"
|
||||
&& /session-1/.test(error.message) && /closed the connection before it answered/.test(error.message) && !/command failed/.test(error.message));
|
||||
assert.equal(calls.length, 3);
|
||||
assert.equal(pauses.length, calls.length - 1);
|
||||
assert.ok(pauses.every(milliseconds => milliseconds > 0 && milliseconds <= 10_000));
|
||||
});
|
||||
|
||||
test("an action's values follow --, so one that starts with a dash is never read as a flag", () => {
|
||||
@@ -38,3 +87,40 @@ test("link schemes are approved once each, lowercased, never http or https, and
|
||||
assert.deepEqual(approveSessionUrlSchemes(none.eas, "session-1", new Set(), "dev.example.app", ["example"]), []);
|
||||
assert.equal(none.calls.length, 0);
|
||||
});
|
||||
|
||||
// The host can fail an action once, as `app.approveUrlScheme` did in its `simctl spawn … defaults write` (euxy run 39348933440).
|
||||
function flakyEas(failures) {
|
||||
const calls = [];
|
||||
const eas = args => {
|
||||
calls.push(args);
|
||||
if (calls.length <= failures) throw new Error("eas simulator:control exited with status 1: The simulator could not run app.approveUrlScheme");
|
||||
return { stdout: "{}" };
|
||||
};
|
||||
return { calls, eas };
|
||||
}
|
||||
|
||||
test("an action that fails once is sent again after a pause", () => {
|
||||
const { calls, eas } = flakyEas(1);
|
||||
const pauses = [];
|
||||
simulatorControl(eas, "session-1", "app.approveUrlScheme", ["dev.example.app", "example"], { sleep: milliseconds => pauses.push(milliseconds) });
|
||||
assert.equal(calls.length, 2);
|
||||
assert.deepEqual(calls[1], calls[0]);
|
||||
assert.equal(pauses.length, 1);
|
||||
});
|
||||
|
||||
test("an action that keeps failing throws EAS's reason after its last attempt, with no pause after it", () => {
|
||||
const { calls, eas } = flakyEas(Infinity);
|
||||
const pauses = [];
|
||||
assert.throws(() => simulatorControl(eas, "session-1", "app.approveUrlScheme", ["dev.example.app", "example"], { sleep: milliseconds => pauses.push(milliseconds) }),
|
||||
/could not run app\.approveUrlScheme/);
|
||||
assert.equal(calls.length, 3);
|
||||
assert.equal(pauses.length, calls.length - 1);
|
||||
assert.ok(pauses.every(milliseconds => milliseconds > 0 && milliseconds <= 10_000));
|
||||
});
|
||||
|
||||
test("a link scheme the host fails to approve once is approved on the next attempt", () => {
|
||||
const { calls, eas } = flakyEas(1);
|
||||
const approved = approveSessionUrlSchemes(eas, "session-1", new Set(["app.approveUrlScheme"]), "dev.example.app", ["example"], { sleep: () => {} });
|
||||
assert.deepEqual(approved, ["example"]);
|
||||
assert.equal(calls.length, 2);
|
||||
});
|
||||
@@ -133,11 +133,14 @@ test("report export rejects path traversal and symlink images from downloaded ev
|
||||
});
|
||||
|
||||
function transportFixture({ stale = false, expired = false, artifactName = "explore-review-10-1", artifactRun = 10, attempt = 1,
|
||||
status, headers } = {}) {
|
||||
status, headers, artifactNotFound = 0 } = {}) {
|
||||
const calls = [];
|
||||
let artifactLookups = 0;
|
||||
const transport = async (input, options = {}) => {
|
||||
const url = new URL(input); calls.push({ url, options });
|
||||
if (status) return new Response("private-upstream-error", { status, headers });
|
||||
// GitHub can answer 404 for an artifact its run uploaded moments ago (euxy run 39348956443).
|
||||
if (url.pathname.endsWith("/actions/artifacts/20") && (artifactLookups += 1) <= artifactNotFound) return new Response("Not Found", { status: 404 });
|
||||
if (url.pathname.endsWith("/actions/artifacts/20")) return Response.json({ id: 20, name: artifactName, expired, workflow_run: { id: artifactRun } });
|
||||
if (url.pathname.endsWith("/actions/runs/10/attempts/1")) return Response.json({ id: 10, run_attempt: attempt, status: "in_progress", conclusion: null });
|
||||
if (url.pathname.endsWith("/pulls/1")) return Response.json({ state: "open", base: pr.base,
|
||||
@@ -191,7 +194,8 @@ test("report publication separates credential, permission, rate limit, and servi
|
||||
[503, {}, "GITHUB_REQUEST_FAILED", true, /service status/],
|
||||
]) {
|
||||
const { transport, calls } = transportFixture({ status, headers });
|
||||
await assert.rejects(publishCiReportComment({ inputPath, artifactUrl, environment, transport }), error => {
|
||||
const pauses = [];
|
||||
await assert.rejects(publishCiReportComment({ inputPath, artifactUrl, environment, transport, sleep: async milliseconds => { pauses.push(milliseconds); } }), error => {
|
||||
assert.equal(error.code, code);
|
||||
assert.equal(error.stage, "publication");
|
||||
assert.equal(error.retryable, retryable);
|
||||
@@ -200,9 +204,36 @@ test("report publication separates credential, permission, rate limit, and servi
|
||||
return true;
|
||||
});
|
||||
assert.equal(calls.some(call => call.options.method === "POST"), false);
|
||||
// Only a 5xx is looked up again; a bad token, a missing permission and a rate limit fail on the first answer.
|
||||
assert.equal(calls.length, status >= 500 ? 5 : 1, `${status} ${JSON.stringify(headers)}`);
|
||||
assert.equal(pauses.length, calls.length - 1);
|
||||
}
|
||||
});
|
||||
|
||||
test("an artifact GitHub does not list yet is looked up again, and one it never lists keeps the not-found failure", async t => {
|
||||
const { inputPath } = await fixture(t);
|
||||
const late = transportFixture({ artifactNotFound: 1 });
|
||||
const pauses = [];
|
||||
await publishCiReportComment({ inputPath, artifactUrl, environment, transport: late.transport, sleep: async milliseconds => { pauses.push(milliseconds); } });
|
||||
assert.equal(late.calls.filter(call => call.url.pathname.endsWith("/actions/artifacts/20")).length, 2);
|
||||
assert.equal(pauses.length, 1);
|
||||
assert.ok(late.calls.some(call => call.options.method === "POST"), "the comment is published once the artifact is found");
|
||||
|
||||
const missing = transportFixture({ artifactNotFound: Infinity });
|
||||
const waited = [];
|
||||
await assert.rejects(publishCiReportComment({ inputPath, artifactUrl, environment, transport: missing.transport, sleep: async milliseconds => { waited.push(milliseconds); } }), error => {
|
||||
assert.equal(error.code, "GITHUB_RESOURCE_NOT_FOUND");
|
||||
assert.equal(error.message, "Report publication GitHub check failed (404)");
|
||||
assert.match(error.nextAction, /artifact ID/);
|
||||
return true;
|
||||
});
|
||||
assert.equal(missing.calls.length, 5);
|
||||
assert.equal(waited.length, 4, "no pause after the last lookup");
|
||||
const total = waited.reduce((sum, milliseconds) => sum + milliseconds, 0);
|
||||
assert.ok(total >= 30_000 && total <= 60_000, `${total} ms of pauses`);
|
||||
assert.equal(missing.calls.some(call => call.options.method === "POST"), false);
|
||||
});
|
||||
|
||||
test("stale PRs, expired artifacts, foreign artifacts, and replayed attempts cannot announce Ready", async t => {
|
||||
const { inputPath } = await fixture(t);
|
||||
const moved = transportFixture({ stale: true });
|
||||
|
||||
@@ -97,3 +97,16 @@ test("accessibility fingerprints ignore Android system UI nodes", async () => {
|
||||
assert.equal(sameApp.accessibility, base.accessibility);
|
||||
assert.notEqual(changedApp.accessibility, base.accessibility);
|
||||
});
|
||||
|
||||
test("accessibility fingerprints are versioned, and leave out the system keyboard and which field has the focus", async () => {
|
||||
const snapshot = (focused, keyboard) => JSON.stringify({ success: true, data: { nodes: [
|
||||
{ index: 0, type: "Application", label: "euxy", rect: { x: 0, y: 0, width: 402, height: 874 } },
|
||||
{ index: 1, parentIndex: 0, type: "TextField", label: "Pattern name", ...(focused ? { focused: true } : {}), rect: { x: 23, y: 386, width: 355, height: 50 } },
|
||||
...(keyboard ? [{ index: 2, parentIndex: 0, type: "Keyboard", rect: { x: 0, y: 583, width: 402, height: 233 } },
|
||||
{ index: 3, parentIndex: 2, type: "Key", label: "Q", rect: { x: 5, y: 590, width: 39, height: 54 } }] : []),
|
||||
] } });
|
||||
const resting = await fingerprintState({ snapshotText: snapshot(false, false) });
|
||||
assert.match(resting.accessibility, /^a2:[0-9a-f]{64}$/);
|
||||
assert.equal((await fingerprintState({ snapshotText: snapshot(true, false) })).accessibility, resting.accessibility, "focus alone does not change the tree");
|
||||
assert.equal((await fingerprintState({ snapshotText: snapshot(true, true) })).accessibility, resting.accessibility, "nor does the keyboard");
|
||||
});
|
||||
@@ -67,7 +67,7 @@ test("baseline restore rejects foreign workflows, revisions, branches, and unfin
|
||||
event: "push", head_repository: { full_name: "acme/app" } };
|
||||
const mutations = [
|
||||
{ workflow_id: 99 }, { head_sha: "b".repeat(40) }, { head_branch: "feature" },
|
||||
{ conclusion: null }, { head_repository: { full_name: "fork/app" } }, { event: "pull_request_target" },
|
||||
{ conclusion: null }, { conclusion: "cancelled" }, { head_repository: { full_name: "fork/app" } }, { event: "pull_request_target" },
|
||||
];
|
||||
const runs = Object.fromEntries(mutations.map((mutation, i) => [i + 30, { ...valid, ...mutation, id: i + 30 }]));
|
||||
runs[20] = valid;
|
||||
@@ -90,6 +90,20 @@ test("baseline restore rejects foreign workflows, revisions, branches, and unfin
|
||||
assert.deepEqual(names, [`explore-baseline-${"a".repeat(40)}-ios`, `explore-baseline-${"a".repeat(40)}`], "iOS also accepts the unsuffixed name older baselines used");
|
||||
});
|
||||
|
||||
test("a target's baseline from a run another target's baseline failed in is still reused (brentvatne/euxy#172)", async () => {
|
||||
// The baseline job uploads its artifact only after its own steps passed, so the run's failure is another target's.
|
||||
const run = { id: 20, workflow_id: 77, conclusion: "failure", head_sha: "a".repeat(40), head_branch: "main", event: "push", head_repository: { full_name: "acme/app" } };
|
||||
const transport = async input => {
|
||||
const url = new URL(input);
|
||||
if (url.pathname === "/repos/acme/app") return Response.json({ default_branch: "main" });
|
||||
if (url.pathname === "/repos/acme/app/actions/workflows/explore-baseline.yml") return Response.json({ id: 77 });
|
||||
if (url.pathname === "/repos/acme/app/actions/artifacts") return Response.json({ artifacts: [{ id: 20, workflow_run: { id: 20 }, expired: false }] });
|
||||
if (url.pathname === "/repos/acme/app/actions/runs/20") return Response.json(run);
|
||||
throw new Error(`unexpected request ${url}`);
|
||||
};
|
||||
assert.deepEqual(await findBaselineArtifact({ sha: "a".repeat(40), target: "iphone", environment, transport }), { id: 20, run: 20 });
|
||||
});
|
||||
|
||||
test("a target's baseline is named after its id; only target ios also reuses the unsuffixed name", async () => {
|
||||
const lookups = async target => {
|
||||
const names = [];
|
||||
@@ -145,10 +159,19 @@ async function reportFailure(t, { capture, report, comments = [], pr = samplePr(
|
||||
const url = new URL(input);
|
||||
assert.equal(init.headers?.authorization, "Bearer test-token");
|
||||
if (url.pathname === "/repos/acme/app/pulls/91") return Response.json(pr);
|
||||
// The comments as GitHub holds them, so a second write merges into the first.
|
||||
if (url.pathname === "/repos/acme/app/issues/91/comments" && (init.method ?? "GET") === "GET") return Response.json(comments);
|
||||
if (url.pathname === "/repos/acme/app/issues/91/comments" && init.method === "POST") { writes.push({ action: "create", body: JSON.parse(init.body).body }); return Response.json({ id: 100 }); }
|
||||
if (url.pathname === "/repos/acme/app/issues/91/comments" && init.method === "POST") {
|
||||
const body = JSON.parse(init.body).body;
|
||||
writes.push({ action: "create", body }); comments = [...comments, { id: 100, user: { login: "github-actions[bot]" }, body }];
|
||||
return Response.json({ id: 100 });
|
||||
}
|
||||
const update = /^\/repos\/acme\/app\/issues\/comments\/(\d+)$/.exec(url.pathname);
|
||||
if (update && init.method === "PATCH") { writes.push({ action: "update", comment_id: Number(update[1]), body: JSON.parse(init.body).body }); return Response.json({ id: Number(update[1]) }); }
|
||||
if (update && init.method === "PATCH") {
|
||||
const body = JSON.parse(init.body).body;
|
||||
writes.push({ action: "update", comment_id: Number(update[1]), body }); comments = comments.map(comment => comment.id === Number(update[1]) ? { ...comment, body } : comment);
|
||||
return Response.json({ id: Number(update[1]) });
|
||||
}
|
||||
throw new Error(`unexpected request ${init.method ?? "GET"} ${url}`);
|
||||
};
|
||||
const result = await publishFailureComment({ repository: "acme/app", pullNumber: 91, headSha: head, baseSha: base, runId: "1234", runAttempt: "1",
|
||||
@@ -296,6 +319,51 @@ test("a failed target is named by its artifact and keeps the label and config or
|
||||
assert.equal(located.diagnostic.code, "APP_INPUT_MISSING");
|
||||
});
|
||||
|
||||
test("a lone failed job's diagnostics, which download-artifact extracts without its artifact's directory, still name the target (euxy#172 attempt 1)", async t => {
|
||||
// Run 39348956443 attempt 1: only duo-closed's report job failed (ci:publish's artifact lookup answered 404), so the
|
||||
// failure job's pattern matched one artifact, extracted into report/ itself, and the comment said "iOS failed".
|
||||
const report = { ...sampleDiagnostic(), code: "GITHUB_RESOURCE_NOT_FOUND", stage: "publication", message: "Report publication GitHub check failed (404)", target: "duo-closed" };
|
||||
const [write] = await reportFailure(t, { mutateFiles: async directory => {
|
||||
await mkdir(join(directory, "explore-failure", "report"), { recursive: true });
|
||||
await writeFile(join(directory, "explore-failure", "report", "error.json"), JSON.stringify(report));
|
||||
} });
|
||||
assert.match(write.body, /^<!-- expo-explore-record:duo-closed:/m);
|
||||
assert.match(write.body, /^\*\*duo\\-closed failed\*\* · publication · GITHUB\\_RESOURCE\\_NOT\\_FOUND/m);
|
||||
assert.doesNotMatch(write.body, /iOS failed/);
|
||||
// A capture diagnostics artifact on its own keeps its explore-diagnostics directory; a target id the file names is checked.
|
||||
const [capture] = await reportFailure(t, { mutateFiles: async directory => {
|
||||
await mkdir(join(directory, "explore-failure", "capture", "explore-diagnostics"), { recursive: true });
|
||||
await writeFile(join(directory, "explore-failure", "capture", "explore-diagnostics", "error.json"), JSON.stringify({ ...sampleDiagnostic(), target: "duo-open" }));
|
||||
} });
|
||||
assert.match(capture.body, /^\*\*duo\\-open failed\*\* · capture\\-head · APP\\_INPUT\\_MISSING/m);
|
||||
const [invalid] = await reportFailure(t, { mutateFiles: async directory => {
|
||||
await mkdir(join(directory, "explore-failure", "report"), { recursive: true });
|
||||
await writeFile(join(directory, "explore-failure", "report", "error.json"), JSON.stringify({ ...report, target: "../ios" }));
|
||||
} });
|
||||
assert.match(invalid.body, /^<!-- expo-explore-record:ios:/m, "an invalid target id is no target: the record falls back to ios, as before targets");
|
||||
});
|
||||
|
||||
test("every failed target of a run gets its own failed record, and a target's report failure outranks its capture's", async t => {
|
||||
const { locateFailureDiagnostics } = await import("../../dist/report/failure-comment.js");
|
||||
const writes = await reportFailure(t, { mutateFiles: async directory => {
|
||||
const root = join(directory, "explore-failure");
|
||||
// Every capture leg uploads diagnostics; only the failed ones hold an error.json.
|
||||
for (const target of ["iphone", "duo-closed", "duo-open", "android"]) await mkdir(join(root, "capture", `explore-diagnostics-1234-1-${target}`, "explore-diagnostics"), { recursive: true });
|
||||
await writeFile(join(root, "capture", "explore-diagnostics-1234-1-duo-open", "explore-diagnostics", "error.json"), JSON.stringify({ ...sampleDiagnostic(), code: "CONTROLLER_READER_STUCK", stage: "session" }));
|
||||
await writeFile(join(root, "capture", "explore-diagnostics-1234-1-android", "explore-diagnostics", "error.json"), JSON.stringify(sampleDiagnostic()));
|
||||
await mkdir(join(root, "report", "explore-report-diagnostics-1234-1-android"), { recursive: true });
|
||||
await writeFile(join(root, "report", "explore-report-diagnostics-1234-1-android", "error.json"), JSON.stringify({ ...sampleDiagnostic(), code: "REPORT_EXPORT_FAILED", stage: "export" }));
|
||||
const located = await locateFailureDiagnostics(root);
|
||||
assert.deepEqual(located.map(failure => [failure.target, failure.diagnostic.code]), [["android", "REPORT_EXPORT_FAILED"], ["duo-open", "CONTROLLER_READER_STUCK"]]);
|
||||
} });
|
||||
assert.equal(writes.length, 2);
|
||||
assert.equal(writes[1].action, "update", "the second failure merges into the comment the first created");
|
||||
assert.match(writes[1].body, /^\*\*Android failed\*\* · export · REPORT\\_EXPORT\\_FAILED/m);
|
||||
assert.match(writes[1].body, /^\*\*duo\\-open failed\*\* · session · CONTROLLER\\_READER\\_STUCK/m);
|
||||
assert.doesNotMatch(writes[1].body, /APP\\_INPUT\\_MISSING/);
|
||||
assert.deepEqual(writes.result, { posted: true });
|
||||
});
|
||||
|
||||
test("ci.trustedAuthors on the default branch admits listed authors without write access, nobody else", async t => {
|
||||
const block = "app:\n bundleId: com.acme.app\nci:\n trustedAuthors:\n - devin-ai-integration[bot] # reviews\n - 'Renovate[bot]'\nreport:\n preview:\n hosting: eas\n";
|
||||
const flow = "ci: # bots\n trustedAuthors: [\"devin-ai-integration[bot]\", 'renovate[bot]'] # quoted: plain scalars cannot hold [ ] in flow style\n";
|
||||
|
||||
+18
-5
@@ -73,6 +73,7 @@ import {
|
||||
isBlackBoxMap,
|
||||
} from "./utils/graph-model";
|
||||
import { buildSearchItems, suggestedSearchItems } from "./utils/search";
|
||||
import { omittedScreenIds, reportScreens, withoutOmittedScreens } from "./utils/omitted-screens";
|
||||
import {
|
||||
presentBuildDiff,
|
||||
presentScreensByPath,
|
||||
@@ -1198,11 +1199,18 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
() => (reviewedMap ? presentScreensByPath(reviewedMap) : undefined),
|
||||
[reviewedMap],
|
||||
);
|
||||
// A route the report never captured is not one of its screens, so the comparison names it nowhere (omitted-screens.ts).
|
||||
const omittedIds = useMemo(
|
||||
() => (reviewedMap && screenPresentation
|
||||
? omittedScreenIds(reviewedMap, { diff: sourceDiff, presentation: screenPresentation })
|
||||
: new Set<string>()),
|
||||
[reviewedMap, screenPresentation, sourceDiff],
|
||||
);
|
||||
const diff = useMemo(
|
||||
() => (sourceDiff && screenPresentation
|
||||
? presentBuildDiff(sourceDiff, screenPresentation)
|
||||
? withoutOmittedScreens(presentBuildDiff(sourceDiff, screenPresentation), omittedIds)
|
||||
: undefined),
|
||||
[screenPresentation, sourceDiff],
|
||||
[omittedIds, screenPresentation, sourceDiff],
|
||||
);
|
||||
// The Screens page says which screens changed in an appearance other than the one shown.
|
||||
const changedElsewhere = useMemo(() => {
|
||||
@@ -1222,7 +1230,9 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
comparison: filterComparisonAppearance(wholeComparison, otherScope),
|
||||
...(wholeReview ? { review: filterReviewAppearance(wholeReview, otherScope) } : {}),
|
||||
});
|
||||
const presented = presentBuildDiff(otherDiff, presentScreensByPath(otherDiff.map));
|
||||
const otherPresentation = presentScreensByPath(otherDiff.map);
|
||||
const presented = withoutOmittedScreens(presentBuildDiff(otherDiff, otherPresentation),
|
||||
omittedScreenIds(otherDiff.map, { diff: otherDiff, presentation: otherPresentation }));
|
||||
for (const [id, entry] of presented.screens) {
|
||||
if (["modified", "added", "removed"].includes(entry.status)) changed.set(id, [...(changed.get(id) ?? []), option]);
|
||||
}
|
||||
@@ -1260,9 +1270,10 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
: !baseline ? "This report has no baseline build to compare against."
|
||||
: !diff ? "The baseline is still loading."
|
||||
: "No screen looks different from the baseline.";
|
||||
// Search finds the report's screens, as Screens lists them; a link to one it never captured still opens it.
|
||||
const searchIndex = useMemo(
|
||||
() => map ? buildSearchItems({ screens: map.screens }) : [],
|
||||
[map],
|
||||
() => map ? buildSearchItems({ screens: reportScreens(map.screens, omittedIds) }) : [],
|
||||
[map, omittedIds],
|
||||
);
|
||||
const openChangedScreen = useCallback((screenId: string) => {
|
||||
const current = routeRef.current;
|
||||
@@ -1634,6 +1645,7 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
index={index}
|
||||
diff={diff}
|
||||
routeFiles={routeFiles}
|
||||
omittedScreenIds={omittedIds}
|
||||
changedElsewhere={changedElsewhere}
|
||||
selectedScreenId={selectedScreenId}
|
||||
{...(focusRequest ? { focusRequest } : {})}
|
||||
@@ -1686,6 +1698,7 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
direction="TB"
|
||||
focus={focusFilter}
|
||||
projectionFitKey={mapProjectionFitKey}
|
||||
omittedScreenIds={omittedIds}
|
||||
{...(diff ? { diff } : {})}
|
||||
{...(selectedScreenId ? { selectedScreenId } : {})}
|
||||
{...(focusRequest ? { focusRequest } : {})}
|
||||
|
||||
@@ -29,6 +29,12 @@ export type ScreenScreenshotCardProps = {
|
||||
/** The frame of a screen without a screenshot: its run's screenshots, so it lines up beside them. */
|
||||
placeholderSize?: { width: number; height: number };
|
||||
loading?: "eager" | "lazy";
|
||||
/**
|
||||
* Frame the screenshot from behind while it loads and fades in, where the frame and its rings are drawn on the image
|
||||
* itself: the Map, and Screens on a phone. Screens' wells frame their own screenshots on wider windows. Only a
|
||||
* screenshot of recorded size has one.
|
||||
*/
|
||||
backing?: boolean;
|
||||
leading?: ReactNode;
|
||||
trailing?: ReactNode;
|
||||
/** Say "Open in Inspector" in a tooltip over the screenshot (Screens). The Map's cards go without. */
|
||||
@@ -47,13 +53,13 @@ export type ScreenScreenshotCardProps = {
|
||||
export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
// The placeholder takes the frame of the image it stands in for: a failed screenshot keeps the
|
||||
// frame it waited in, and a screen without one is framed like a phone screenshot beside it.
|
||||
const frame = props.screenshot && props.imageWidth && props.imageHeight
|
||||
? { width: props.imageWidth, height: props.imageHeight }
|
||||
const sized = Boolean(props.screenshot && props.imageWidth && props.imageHeight);
|
||||
const frame = sized
|
||||
? { width: props.imageWidth!, height: props.imageHeight! }
|
||||
: props.placeholderSize ?? DEFAULT_SCREENSHOT_SIZE;
|
||||
const frameStyle = { "--screenshot-width": frame.width, "--screenshot-height": frame.height } as CSSProperties;
|
||||
const missing = (
|
||||
<span
|
||||
className="image-placeholder"
|
||||
style={{ "--screenshot-width": frame.width, "--screenshot-height": frame.height } as CSSProperties}>
|
||||
<span className="image-placeholder" style={frameStyle}>
|
||||
<ImageOff aria-hidden="true" size={20} />
|
||||
No screenshot
|
||||
{props.missingReason ? <small className="image-placeholder-reason">{props.missingReason}</small> : null}
|
||||
@@ -104,6 +110,7 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
onClick={props.onClick}>
|
||||
<DiffFrame status={props.diff} accessibilityOnly={props.accessibilityOnly}>
|
||||
<span className={`screen-node-image${props.screenshot ? " has-screenshot" : " is-missing"}`}>
|
||||
{props.backing && sized ? <span className="screenshot-backing" style={frameStyle} aria-hidden="true" /> : null}
|
||||
{props.screenshot ? (
|
||||
<ScreenshotImage
|
||||
src={props.screenshot}
|
||||
@@ -114,7 +121,6 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
decoding="async"
|
||||
loading={props.loading ?? "lazy"}
|
||||
fallback={missing}
|
||||
holdPrevious
|
||||
/>
|
||||
) : missing}
|
||||
{/* On a phone's map, says what the second tap on the selected screen does. */}
|
||||
|
||||
@@ -327,13 +327,24 @@
|
||||
border-radius: 14px;
|
||||
background: var(--subtle);
|
||||
}
|
||||
.compare-frame > img {
|
||||
.compare-frame > img,
|
||||
.compare-flip-layer > img {
|
||||
display: block;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
object-fit: contain;
|
||||
}
|
||||
.compare-flip-frame { cursor: pointer; }
|
||||
/* Flip's two sides fill the frame, one over the other; the frame takes its size from its aspect ratio, not from them.
|
||||
The side off screen is hidden, spinner and all, and a flip shows it at once. */
|
||||
.compare-flip-layer {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
.compare-flip-layer[aria-hidden="true"] { visibility: hidden; }
|
||||
.compare-flip-frame:focus-visible { outline: 2px solid var(--accent); outline-offset: 3px; }
|
||||
.compare-swipe .visual-swipe { width: auto; height: var(--compare-frame-height); }
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ import { formatShortcut, matchesShortcut, SHORTCUTS, shortcutsLive } from "../..
|
||||
import { createKeyHold, DIVIDER_GLIDE, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
|
||||
import { optionalStorage } from "../../utils/embedded-report";
|
||||
import { usePhoneLayout } from "../../utils/phone-layout";
|
||||
import { useNeighborScreenshots } from "../../hooks/use-neighbor-screenshots";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { DEFAULT_SCREENSHOT_RATIO, ScreenshotImage, ScreenshotPlaceholder } from "../shared/screenshot-image";
|
||||
@@ -133,7 +134,10 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const mode: CompareMode = comparable ? (phone ? phoneMode : desktopMode) : "flip";
|
||||
const outlines = useOutlinesShown();
|
||||
const [activeArea, setActiveArea] = useState<number>();
|
||||
const [flipSide, setFlipSide] = useState<"before" | "after">("after");
|
||||
// Flip's side belongs to the screen it was chosen on: each screen starts on After, from its very
|
||||
// first render, so a step never shows the next screen's Before for a frame.
|
||||
const [flipped, setFlipped] = useState<{ screenId: string; side: "before" | "after" }>();
|
||||
const flipSide = flipped?.screenId === options.screenId ? flipped.side : "after";
|
||||
const [swipePosition, setSwipePosition] = useState(50);
|
||||
const [factsOpen, setFactsOpen] = useState(false);
|
||||
// The frame takes the recorded screenshot's shape at once, then the loaded image's (they agree
|
||||
@@ -150,10 +154,11 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
setLoadedAspect({ screenId: options.screenId, aspect: value });
|
||||
}, [options.screenId, hasAfter]);
|
||||
|
||||
// Each screen starts whole: no area selected, After showing, the facts closed.
|
||||
// Each screen starts whole: no area selected, After showing, the facts closed. A side flipped to on
|
||||
// another screen is already not this one's (above); it is dropped, so coming back starts on After.
|
||||
useEffect(() => {
|
||||
setActiveArea(undefined);
|
||||
setFlipSide("after");
|
||||
setFlipped(undefined);
|
||||
setFactsOpen(false);
|
||||
}, [options.screenId]);
|
||||
|
||||
@@ -171,7 +176,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
return Math.min(areas.length - 1, Math.max(0, current + step));
|
||||
});
|
||||
};
|
||||
const flip = () => setFlipSide((side) => (side === "after" ? "before" : "after"));
|
||||
const flip = () => setFlipped({ screenId: options.screenId, side: flipSide === "after" ? "before" : "after" });
|
||||
|
||||
const keyState = useRef({ previous, next, mode, activeArea, options, swipePosition });
|
||||
keyState.current = { previous, next, mode, activeArea, options, swipePosition };
|
||||
@@ -199,6 +204,17 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
holdRef.current ??= createKeyHold();
|
||||
const hold = holdRef.current;
|
||||
useEffect(() => hold.end, [hold]);
|
||||
// A held key steps faster than a screenshot fades in, so while it repeats each screen's pictures appear at once:
|
||||
// the stage is marked for ScreenshotImage directly, without a render of its own.
|
||||
const stageRef = useRef<HTMLDivElement>(null);
|
||||
const stepHeld = (direction: 1 | -1): boolean => {
|
||||
const stepped = stepScreen(direction);
|
||||
if (stepped) stageRef.current?.setAttribute("data-screenshot-instant", "");
|
||||
return stepped;
|
||||
};
|
||||
const endHeldSteps = () => stageRef.current?.removeAttribute("data-screenshot-instant");
|
||||
useNeighborScreenshots({ diff: options.diff, order: options.order, screenId: options.screenId,
|
||||
enabled: options.stepScreens !== false, hold });
|
||||
// A tap of [ or ] moves the divider one step; held, it keeps going from the same motion. The hold only
|
||||
// tracks the key; the glide reads it every frame and stops with it.
|
||||
const glideDivider = (code: string, direction: 1 | -1) => {
|
||||
@@ -215,9 +231,9 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const keys = SHORTCUTS.compare;
|
||||
const stepScreens = state.options.stepScreens !== false;
|
||||
if (stepScreens && matchesShortcut(event, keys.previousScreen)) {
|
||||
if (stepScreen(-1)) hold.begin(event.code, () => stepScreen(-1));
|
||||
if (stepScreen(-1)) hold.begin(event.code, () => stepHeld(-1), endHeldSteps);
|
||||
} else if (stepScreens && matchesShortcut(event, keys.nextScreen)) {
|
||||
if (stepScreen(1)) hold.begin(event.code, () => stepScreen(1));
|
||||
if (stepScreen(1)) hold.begin(event.code, () => stepHeld(1), endHeldSteps);
|
||||
} else if (matchesShortcut(event, keys.nextArea)) {
|
||||
stepArea(1);
|
||||
} else if (matchesShortcut(event, keys.previousArea)) {
|
||||
@@ -279,7 +295,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
screen, screenDiff, route, position, previous, next, comparable, areas, facts, split, layoutShift, measurable,
|
||||
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines,
|
||||
activeArea, setActiveArea, stepArea, flipSide, flip, swipePosition, setSwipePosition,
|
||||
aspect, setAspect, factsOpen, setFactsOpen,
|
||||
aspect, setAspect, factsOpen, setFactsOpen, stageRef,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -393,7 +409,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<div className={`compare-stage mode-${mode}`}>
|
||||
<div ref={compare.stageRef} className={`compare-stage mode-${mode}`}>
|
||||
{/* Every mode names Before and After in a row above the screenshots. */}
|
||||
<CompareStage
|
||||
mode={mode}
|
||||
@@ -472,6 +488,21 @@ export function CompareStage(props: StageProps) {
|
||||
// An outline taken out from under the pointer reports no leave, so another screen, mode or outline
|
||||
// toggle drops the hover rather than lighting an area the pointer is not on.
|
||||
useLayoutEffect(() => setHoverIndex(undefined), [props.areas, props.mode, props.showOutlines]);
|
||||
// Flip keeps both sides mounted, so flipping is an instant swap of two decoded pictures. The side off screen mounts
|
||||
// once the side on screen is ready for this pair of screenshots, or on the first flip to it, so a held key stepping
|
||||
// through Flip reads one side of each screen it passes, not two.
|
||||
const pair = `${before ?? ""} ${after ?? ""}`;
|
||||
const [flipPair, setFlipPair] = useState<string>();
|
||||
const flipBoth = flipPair === pair;
|
||||
if (props.mode === "flip" && props.flipSide === "before" && flipPair !== pair) setFlipPair(pair);
|
||||
// The side on screen loads (CompareImage reports it), or a step kept its screenshot (the same After beside another
|
||||
// Before), which fires no load: it is ready as it is.
|
||||
const flipFrameRef = useRef<HTMLButtonElement>(null);
|
||||
useLayoutEffect(() => {
|
||||
if (props.mode !== "flip" || flipPair === pair) return;
|
||||
const shown = flipFrameRef.current?.querySelector(`.compare-flip-layer[data-side="${props.flipSide}"] img`);
|
||||
if (shown?.getAttribute("data-screenshot-state") === "ready") setFlipPair(pair);
|
||||
}, [props.mode, props.flipSide, flipPair, pair]);
|
||||
if (!before && !after) {
|
||||
const reason = diff.captureNotes?.after ?? diff.captureNotes?.before;
|
||||
return (
|
||||
@@ -515,6 +546,7 @@ export function CompareStage(props: StageProps) {
|
||||
}
|
||||
if (props.mode === "flip" && before && after) {
|
||||
const showing = props.flipSide;
|
||||
const sides = (["before", "after"] as const).filter((side) => side === showing || flipBoth);
|
||||
return (
|
||||
<figure className="compare-side">
|
||||
{/* Both names, with the one on screen lit; the other one flips to it. */}
|
||||
@@ -527,10 +559,21 @@ export function CompareStage(props: StageProps) {
|
||||
))}
|
||||
</figcaption>
|
||||
<div className="compare-frame-wrap">
|
||||
<button type="button" className="compare-frame compare-flip-frame" data-side={showing}
|
||||
<button ref={flipFrameRef} type="button" className="compare-frame compare-flip-frame" data-side={showing}
|
||||
aria-label={`Show ${showing === "after" ? "Before" : "After"}`} onClick={props.onFlip}>
|
||||
<CompareImage src={showing === "after" ? after : before} alt={`${props.title}, ${showing}`}
|
||||
placeholder="No screenshot" side={showing} onAspect={props.onAspect} />
|
||||
{/* Each side is a layer of its own, with its spinner and its no-screenshot state; the one off screen
|
||||
is hidden, and its pictures land without a fade, so a flip shows the other side at once. */}
|
||||
{sides.map((side) => (
|
||||
<span key={side} className="compare-flip-layer" data-side={side}
|
||||
{...(side === showing ? {} : { "aria-hidden": true, "data-screenshot-instant": "" })}>
|
||||
<CompareImage src={side === "after" ? after : before} alt={`${props.title}, ${side}`}
|
||||
placeholder="No screenshot" side={side}
|
||||
onAspect={(aspect, loaded) => {
|
||||
if (loaded === showing) setFlipPair(pair);
|
||||
props.onAspect(aspect, loaded);
|
||||
}} />
|
||||
</span>
|
||||
))}
|
||||
{props.overlay}
|
||||
</button>
|
||||
</div>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { appearanceLabel, type Appearance } from "../../utils/appearance";
|
||||
import { useEffect, useRef, useState, useSyncExternalStore, type ReactNode } from "react";
|
||||
import { useEffect, useLayoutEffect, useRef, useState, useSyncExternalStore, type ReactNode } from "react";
|
||||
import { LoaderCircle, Search } from "lucide-react";
|
||||
import { toast } from "sonner";
|
||||
import { ExpoLogo } from "../shared/expo-logo";
|
||||
@@ -13,6 +13,7 @@ import { KeyHint } from "../shared/key-hint";
|
||||
import { formatShortcut, matchesShortcut, shortcutsLive, SHORTCUTS, TARGET_NUMBER_KEYS } from "../../utils/shortcuts";
|
||||
import { ChangesMenu } from "./changes-menu";
|
||||
import { placeForAnotherTarget, type FocusStatus } from "../../utils/navigation";
|
||||
import { usePhoneLayout } from "../../utils/phone-layout";
|
||||
import type { ExploreMap, MapIndex } from "../../utils/model";
|
||||
import type { BuildDiff } from "../../utils/build-diff";
|
||||
import type { PullRequestPresentation } from "../../utils/review-model";
|
||||
@@ -103,6 +104,25 @@ function useSiblingReports(page: URL | undefined): SiblingReport[] | undefined {
|
||||
return reports;
|
||||
}
|
||||
|
||||
/**
|
||||
* A chip's label, truncating from its end when the chip is squeezed, except a trailing parenthetical: a target's
|
||||
* pose, "iPhone Duo (open)", keeps "(open)" and loses letters of the device.
|
||||
*/
|
||||
function ChipLabel({ text }: { text: string }) {
|
||||
const suffix = /^(.*\S) (\(.+\))$/.exec(text);
|
||||
return (
|
||||
<span className="collapsed-platform-label">
|
||||
<span className="collapsed-platform-label-text">{suffix ? suffix[1] : text}</span>
|
||||
{suffix ? <span className="collapsed-platform-label-suffix">{` ${suffix[2]}`}</span> : null}
|
||||
</span>
|
||||
);
|
||||
}
|
||||
|
||||
/** Whether an element's text runs past its box: scrollWidth is an integer, so a sub-pixel overrun is no cut. */
|
||||
function cut(element: HTMLElement | null): boolean {
|
||||
return Boolean(element && element.scrollWidth > element.offsetWidth);
|
||||
}
|
||||
|
||||
type AppPillProps = {
|
||||
/** The phone layout puts Search in the pill, at its trailing edge. */
|
||||
onOpenSearch?: (() => void) | undefined;
|
||||
@@ -136,6 +156,8 @@ type AppPillProps = {
|
||||
export function AppPill(props: AppPillProps) {
|
||||
const pillRef = useRef<HTMLDivElement>(null);
|
||||
const platformRef = useRef<HTMLButtonElement>(null);
|
||||
const phone = usePhoneLayout();
|
||||
const identityRef = useRef<HTMLDivElement>(null);
|
||||
const [platformOpen, setPlatformOpen] = useState(false);
|
||||
// A target still downloading: this report stays up, the trigger and the menu row say so. One that failed says why.
|
||||
const { switching, switchError } = useSyncExternalStore(REPORT_SOURCE.subscribe, REPORT_SOURCE.getSnapshot, REPORT_SOURCE.getSnapshot);
|
||||
@@ -150,6 +172,9 @@ export function AppPill(props: AppPillProps) {
|
||||
const applicationName = props.map.run.name;
|
||||
// The app's own icon when the report carries one; the Expo mark otherwise.
|
||||
const appIcon = artifactUrl(props.map.run.appIcon);
|
||||
// An icon that cannot be read shows the Expo mark instead, which does not name the app: the icon it was for.
|
||||
const [failedIcon, setFailedIcon] = useState<string>();
|
||||
const iconShown = Boolean(appIcon) && failedIcon !== appIcon;
|
||||
const platform = props.map.run.platform;
|
||||
const environment = props.map.run.environment ?? {};
|
||||
const device = [
|
||||
@@ -170,6 +195,72 @@ export function AppPill(props: AppPillProps) {
|
||||
const run = runTargets(props.map.run);
|
||||
const currentTarget = run.targets.find(target => target.id === run.current);
|
||||
const targetLabel = currentTarget?.label ?? PLATFORM_NAMES[platform] ?? platform;
|
||||
|
||||
// The phone's header is the window's width. When the row cannot fit, it gives way in order: the app's name (left
|
||||
// out while the app's own icon names it, or else cut down to its minimum), then the pull request link (Search keeps
|
||||
// "Open pull request"); only then does the target's chip shrink, holding the name at its minimum: its device first,
|
||||
// its pose only once the device is gone, so the label never runs out of its chip over the next. A name without its
|
||||
// icon is left out last, when even the shrunk chip leaves it no room. Each step is laid out and measured in turn
|
||||
// from the first, so the result is a function of the row's width alone, never of the last result. A label fades at
|
||||
// its end only where it is cut. The desktop's pill is sized by its content, so it leaves nothing out.
|
||||
const appearanceCurrent = props.appearance?.current;
|
||||
useLayoutEffect(() => {
|
||||
const row = identityRef.current;
|
||||
if (!row) return;
|
||||
if (!phone) {
|
||||
delete row.dataset.drop;
|
||||
delete row.dataset.fade;
|
||||
return;
|
||||
}
|
||||
let disposed = false;
|
||||
const fit = () => {
|
||||
if (disposed) return;
|
||||
const name = row.querySelector<HTMLElement>(":scope > strong");
|
||||
const target = row.querySelector<HTMLElement>(".collapsed-target");
|
||||
const label = target?.querySelector<HTMLElement>(".collapsed-platform-label") ?? null;
|
||||
const device = target?.querySelector<HTMLElement>(".collapsed-platform-label-text") ?? null;
|
||||
const pose = target?.querySelector<HTMLElement>(".collapsed-platform-label-suffix") ?? null;
|
||||
const style = getComputedStyle(row);
|
||||
const minimum = parseFloat(style.getPropertyValue("--collapsed-name-min")) || 0;
|
||||
// A chip no wider than its squeezed minimum has nothing to give: squeezing it would only widen it.
|
||||
row.dataset.drop = "";
|
||||
const squeezable = Boolean(target && target.getBoundingClientRect().width > (parseFloat(style.getPropertyValue("--collapsed-target-min")) || 0));
|
||||
const steps = [
|
||||
...(name && iconShown ? ["name"] : []),
|
||||
...(row.querySelector(".collapsed-pr") ? ["pr"] : []),
|
||||
...(squeezable ? ["squeeze"] : []),
|
||||
...(squeezable && pose ? ["pose"] : []),
|
||||
...(name && !iconShown ? ["name"] : []),
|
||||
];
|
||||
// With `drops` left out, nothing runs past the row's end, a name that stays shows whole beside its icon and at
|
||||
// least its minimum without, and a squeezed label still shows its whole pose.
|
||||
const fits = (drops: string[]) => {
|
||||
row.dataset.drop = drops.join(" ");
|
||||
const end = row.getBoundingClientRect().right - parseFloat(style.paddingRight);
|
||||
if (Array.from(row.children).some(item => item.getBoundingClientRect().right > end + 0.5)) return false;
|
||||
if (name && !drops.includes("name") && !drops.includes("squeeze")) {
|
||||
if (iconShown ? cut(name) : name.getBoundingClientRect().width < Math.min(minimum, name.scrollWidth) - 0.5) return false;
|
||||
}
|
||||
return !drops.includes("squeeze") || drops.includes("pose") || !cut(label);
|
||||
};
|
||||
let count = 0;
|
||||
while (count < steps.length && !fits(steps.slice(0, count))) count += 1;
|
||||
if (count === steps.length) row.dataset.drop = steps.join(" ");
|
||||
if (!row.dataset.drop) delete row.dataset.drop;
|
||||
const fade = [...(cut(device) ? ["device"] : []), ...(cut(pose) ? ["pose"] : [])];
|
||||
if (fade.length) row.dataset.fade = fade.join(" ");
|
||||
else delete row.dataset.fade;
|
||||
};
|
||||
fit();
|
||||
// The row's room, and its items' widths: a font arriving after the first paint changes the latter alone.
|
||||
const observer = new ResizeObserver(fit);
|
||||
for (const node of [row, ...row.children]) observer.observe(node);
|
||||
void document.fonts.ready.then(fit);
|
||||
return () => {
|
||||
disposed = true;
|
||||
observer.disconnect();
|
||||
};
|
||||
}, [targetLabel, appearanceCurrent, pullRequest, phone, iconShown]);
|
||||
// Platform-named targets (every report from before targets) switch platforms; named targets switch devices.
|
||||
const noun = run.targets.every(target => target.id === target.platform) ? "platform" : "device";
|
||||
const siblings = run.targets
|
||||
@@ -241,15 +332,17 @@ export function AppPill(props: AppPillProps) {
|
||||
<div className="left-panel collapsed">
|
||||
<div ref={pillRef} className="left-panel-collapsed-pill">
|
||||
<Tooltip label="Map">
|
||||
<button type="button" className="panel-logo-button" aria-label="Map" onClick={props.onOpenMap}>
|
||||
{/* The button names the app as well: the icon has no text of its own, and a phone's row can leave the name out. */}
|
||||
<button type="button" className="panel-logo-button" aria-label={`Map of ${applicationName}`} onClick={props.onOpenMap}>
|
||||
{appIcon ? (
|
||||
<ScreenshotImage className="panel-app-icon" src={appIcon} alt="" loading="eager" draggable={false}
|
||||
fallback={<ExpoLogo mark />} holdPrevious />
|
||||
fallback={<ExpoLogo mark />} holdPrevious onError={() => setFailedIcon(appIcon)} />
|
||||
) : <ExpoLogo mark />}
|
||||
</button>
|
||||
</Tooltip>
|
||||
<span className="panel-logo-divider" aria-hidden="true" />
|
||||
<div className="collapsed-app-identity">
|
||||
{/* The phone's fit (above) sets data-drop and data-fade on the row itself. */}
|
||||
<div ref={identityRef} className="collapsed-app-identity">
|
||||
<strong title={appTitle}>
|
||||
{repositoryUrl ? (
|
||||
<a className="collapsed-app-name" href={repositoryUrl} target="_blank" rel="noreferrer noopener"
|
||||
@@ -261,11 +354,11 @@ export function AppPill(props: AppPillProps) {
|
||||
{siblings.length ? (
|
||||
<>
|
||||
<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}
|
||||
<button ref={platformRef} type="button" className="collapsed-platform collapsed-target" aria-haspopup="menu" aria-expanded={platformOpen}
|
||||
aria-label={`${noun === "device" ? "Device" : "Platform"}: ${targetLabel}. Open another ${noun}'s report`}
|
||||
aria-busy={switching ? true : undefined}
|
||||
onClick={() => setPlatformOpen(open => !open)}>
|
||||
{targetLabel}
|
||||
<ChipLabel text={targetLabel} />
|
||||
{switching
|
||||
? <LoaderCircle aria-hidden="true" className="collapsed-platform-busy" />
|
||||
: <svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>}
|
||||
@@ -280,7 +373,7 @@ export function AppPill(props: AppPillProps) {
|
||||
<button ref={appearanceRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={appearanceOpen}
|
||||
aria-label={`Appearance: ${appearanceLabel(props.appearance.current)}. Show the other appearance`}
|
||||
onClick={() => setAppearanceOpen(open => !open)}>
|
||||
{appearanceLabel(props.appearance.current)}
|
||||
<ChipLabel text={appearanceLabel(props.appearance.current)} />
|
||||
<svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>
|
||||
<KeyHint shortcut={SHORTCUTS.appearance.app} />
|
||||
</button>
|
||||
@@ -307,7 +400,7 @@ export function AppPill(props: AppPillProps) {
|
||||
target="_blank"
|
||||
rel="noreferrer noopener"
|
||||
aria-label={`PR #${pullRequest.number} on GitHub`}>
|
||||
PR #{pullRequest.number}
|
||||
{phone ? `#${pullRequest.number}` : `PR #${pullRequest.number}`}
|
||||
</a>
|
||||
</Tooltip>
|
||||
) : pullRequest ? (
|
||||
|
||||
@@ -109,7 +109,10 @@
|
||||
object-fit: cover;
|
||||
pointer-events: none;
|
||||
}
|
||||
/* Each side shows only its own half of the frame, so a side still loading leaves its half empty
|
||||
instead of showing the other side's picture there. */
|
||||
.visual-swipe-before { clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
|
||||
.visual-swipe-after { clip-path: inset(0 0 0 var(--swipe-position)); }
|
||||
/* With a moved area, each side's outlines over its own half (see ChangeOutlines). */
|
||||
.visual-swipe-outlines { position: absolute; z-index: 1; inset: 0; pointer-events: none; }
|
||||
.visual-swipe-outlines.before { --outline-before: 1; clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
|
||||
|
||||
@@ -94,7 +94,7 @@ export function PhoneCompare(props: CompareControllerOptions & {
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className={`compare-stage phone-compare-stage mode-${mode}`}
|
||||
<div ref={compare.stageRef} className={`compare-stage phone-compare-stage mode-${mode}`}
|
||||
style={{ "--compare-aspect": compare.aspect } as CSSProperties}
|
||||
onPointerDownCapture={(event) => { pressed.current = { x: event.clientX, y: event.clientY }; }}
|
||||
onClickCapture={stepFromEdge}>
|
||||
|
||||
@@ -375,6 +375,14 @@
|
||||
}
|
||||
.collapsed-search > svg { width: 20px; height: 20px; }
|
||||
.collapsed-search:active { background: var(--panel-hover); }
|
||||
/* Hand off sits before Search: only Search fills the pill's trailing padding. */
|
||||
.phone-layout .handoff-icon-button.collapsed-search { margin-right: -6px; }
|
||||
/* Whatever the row cannot fit is clipped at its end, never drawn under Hand off and Search. The clip edge sits 6px
|
||||
out from its items, where Search's box (and Hand off's) begins, so an end chip's focus ring and key hint show. */
|
||||
.phone-layout .collapsed-app-identity { overflow-x: clip; overflow-y: visible; margin-inline: -6px; padding-inline: 6px; }
|
||||
/* The 24px chips keep their size; their hit area is the pill's height. */
|
||||
.phone-layout .collapsed-platform { position: relative; }
|
||||
.phone-layout .collapsed-platform::before { content: ""; position: absolute; inset: -10px 0; }
|
||||
/* Text links and titles keep their size; their hit area grows into the space around them. */
|
||||
.phone-layout .collapsed-app-name,
|
||||
.phone-layout .collapsed-pr,
|
||||
@@ -562,7 +570,7 @@
|
||||
/* A screen without a screenshot: on the Map the placeholder is sized by its slot's height, which a
|
||||
Screens grid cell does not have. Here it takes the cell's width and a screenshot's proportions,
|
||||
so it lines up with the screenshots beside it. */
|
||||
.screens-cell .screen-node-image:has(> .image-placeholder) { container-type: normal; }
|
||||
.screens-cell .screen-node-image:has(> :is(.image-placeholder, .screenshot-backing)) { container-type: normal; }
|
||||
.screens-cell .screen-node-image > .image-placeholder {
|
||||
/* Like the image beside it: the screenshot's proportions inside the frame's 1px border. */
|
||||
box-sizing: content-box;
|
||||
@@ -571,6 +579,13 @@
|
||||
aspect-ratio: var(--screenshot-width) / var(--screenshot-height);
|
||||
font-size: var(--phone-caption-size, 12px);
|
||||
}
|
||||
/* A screenshot's backing fills the image box exactly: the image sets the cell's height from its own
|
||||
proportions, and the backing draws its frame there while it loads. */
|
||||
.screens-cell .screen-node-image > .screenshot-backing {
|
||||
box-sizing: border-box;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
/* Pinch and double-tap zoom the page on a phone; only the map canvas zooms, and it handles that itself. */
|
||||
.phone-layout { touch-action: pan-x pan-y; }
|
||||
|
||||
@@ -64,7 +64,10 @@
|
||||
.image-lightbox-step:disabled { opacity: 0.3; cursor: default; }
|
||||
.image-lightbox-close:focus-visible,
|
||||
.image-lightbox-step:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
|
||||
/* The image is all the stage shows, and it is hidden while it loads: the spinner centres in the
|
||||
stage meanwhile, in the bar's light text colour. */
|
||||
.image-lightbox-stage {
|
||||
position: relative;
|
||||
display: flex;
|
||||
min-height: 0;
|
||||
flex: 1;
|
||||
@@ -82,3 +85,4 @@
|
||||
object-fit: contain;
|
||||
box-shadow: 0 20px 60px rgb(0 0 0 / 0.5);
|
||||
}
|
||||
.image-lightbox-stage > .screenshot-loading { color: rgb(237 238 240 / 0.6); }
|
||||
@@ -58,7 +58,7 @@ export function ImageLightbox(props: { images: readonly LightboxImage[]; initial
|
||||
<ChevronLeft aria-hidden="true" />
|
||||
</button>
|
||||
) : null}
|
||||
<ScreenshotImage key={image.src} src={image.src} alt={image.alt} loading="eager" draggable={false} />
|
||||
<ScreenshotImage key={image.src} src={image.src} alt={image.alt} loading="eager" indicator="spinner" draggable={false} />
|
||||
{multiple ? (
|
||||
<button type="button" className="image-lightbox-step" aria-label="Next image"
|
||||
disabled={index === props.images.length - 1} onClick={() => move(1)}>
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
import type { ExploreMap } from "../../utils/model";
|
||||
|
||||
/**
|
||||
* The Map and Screens with no screen to show. A run that observed none says what stopped it; a public report whose routes
|
||||
* were all deliberately left uncaptured (omitted-screens.ts) says so, rather than showing an empty page.
|
||||
*/
|
||||
export function NoScreens(props: { map: ExploreMap }) {
|
||||
const recorded = props.map.screens.length > 0;
|
||||
const blockers = props.map.gaps.filter((gap) => gap.status === "open" && !gap.screenId).map((gap) => gap.message);
|
||||
return (
|
||||
<div className="graph-canvas canvas-empty">
|
||||
<div className="page-empty compact-empty map-empty" role="status">
|
||||
<h2>{recorded ? "No screens were captured" : "No screens were recorded"}</h2>
|
||||
{recorded
|
||||
? <p>Every route in this report is a redirect, is named in exploration.exclude, or is outside what the change reaches.</p>
|
||||
: blockers.length > 0
|
||||
? blockers.map((message) => <p key={message}>{message}</p>)
|
||||
: <p>The run ended before any screen of the app was observed.</p>}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -10,16 +10,21 @@ export const DEFAULT_SCREENSHOT_SIZE = { width: 390, height: Math.round(390 / DE
|
||||
type ScreenshotImageProps = ImgHTMLAttributes<HTMLImageElement> & {
|
||||
/** Large previews centre a spinner while an embedded screenshot resolves; small images wait as a quiet empty frame. */
|
||||
indicator?: "spinner";
|
||||
/** Stands in for an embedded screenshot that cannot be read: the caller's own no-screenshot state. */
|
||||
/** Stands in for a screenshot that cannot be read or loaded: the caller's own no-screenshot state. */
|
||||
fallback?: ReactNode;
|
||||
/**
|
||||
* Keeps the picture of the source before on screen until the new one has decoded: for a map card, whose source
|
||||
* changes only when the report's other appearance or target swaps every screenshot at once. Never for a view that
|
||||
* steps between screens or draws changes over the picture, where it would show the screen before under the new one.
|
||||
* Keeps the picture of the source before on screen until the new one has decoded, and shows the new one without a
|
||||
* fade: for the app icon, which changes only when another target's report is shown and should not blink. Never for a
|
||||
* screenshot. A view that steps between screens or draws changes over the picture would show the screen before under
|
||||
* the new one, and a card would show the other target's or appearance's capture as this one's: a screenshot goes
|
||||
* blank while its replacement loads.
|
||||
*/
|
||||
holdPrevious?: boolean;
|
||||
};
|
||||
|
||||
/** How long a loaded screenshot waits for its decode before it is shown anyway. */
|
||||
const DECODE_WAIT_MS = 300;
|
||||
|
||||
type ScreenshotState = "loading" | "ready" | "failed";
|
||||
|
||||
function dimension(value: number | string | undefined): number | undefined {
|
||||
@@ -38,16 +43,45 @@ function waitingSource(width: number | string | undefined, height: number | stri
|
||||
return `data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='${w}' height='${h}'/%3E`;
|
||||
}
|
||||
|
||||
/** The picture each image is waiting to decode, so a load and a re-render waiting for the same one share a wait. */
|
||||
const decodeWaits = new WeakMap<HTMLImageElement, string>();
|
||||
|
||||
/**
|
||||
* Decode embedded evidence near the viewport; ordinary image URLs keep native loading. While an
|
||||
* embedded screenshot resolves, the image shows an empty frame (and, with `indicator`, a spinner)
|
||||
* and never its alt text; a screenshot that cannot be read shows `fallback`.
|
||||
* Calls `show` once `image` has decoded `picture`, so the picture fades in on its own pixels rather than on an empty
|
||||
* box its decode fills in partway; one whose decode does not settle soon is shown anyway. A rejected decode is a
|
||||
* broken image, whose error event follows, or a source replaced meanwhile, which is shown on its own load. One wait
|
||||
* runs per image and picture: a second call while it runs adds nothing.
|
||||
*/
|
||||
function whenDecoded(image: HTMLImageElement, picture: string, show: () => void) {
|
||||
if (decodeWaits.get(image) === picture) return;
|
||||
decodeWaits.set(image, picture);
|
||||
let settled = false;
|
||||
const settle = (shown: boolean) => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
if (decodeWaits.get(image) === picture) decodeWaits.delete(image);
|
||||
if (shown && image.isConnected && image.getAttribute("src") === picture) show();
|
||||
};
|
||||
const timer = setTimeout(() => settle(true), DECODE_WAIT_MS);
|
||||
image.decode().then(() => settle(true), () => settle(image.complete && image.naturalWidth > 0));
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode embedded evidence near the viewport; ordinary image URLs keep native loading. While a
|
||||
* screenshot loads, the image is hidden over its frame (an embedded one keeps its size and, with
|
||||
* `indicator`, shows a spinner) and never shows its alt text or the picture of the source before;
|
||||
* a screenshot that cannot be read or loaded shows `fallback`. A picture that fills an empty frame
|
||||
* fades in, unless it lands inside `[data-screenshot-instant]` (Compare stepping under a held key,
|
||||
* Flip's hidden side), where it appears at once.
|
||||
*/
|
||||
export function ScreenshotImage({ src, loading, indicator, fallback, holdPrevious, onLoad, onError, ...props }: ScreenshotImageProps) {
|
||||
const imageRef = useRef<HTMLImageElement>(null);
|
||||
const [resolved, setResolved] = useState<{ source: string; url: string }>();
|
||||
const [failed, setFailed] = useState<string>();
|
||||
const [shown, setShown] = useState<string>();
|
||||
// The picture shown, when it fades in: it filled an empty frame outside an instant stage.
|
||||
const [revealed, setRevealed] = useState<string>();
|
||||
const [lastSource, setLastSource] = useState(src);
|
||||
// With `holdPrevious`, the picture of the source before, kept on screen until the new one has decoded.
|
||||
const [held, setHeld] = useState<string>();
|
||||
@@ -60,6 +94,7 @@ export function ScreenshotImage({ src, loading, indicator, fallback, holdPreviou
|
||||
setHeld(holdPrevious && failed !== lastSource ? shown ?? held : undefined);
|
||||
setResolved(undefined);
|
||||
setShown(undefined);
|
||||
setRevealed(undefined);
|
||||
setFailed(undefined);
|
||||
}
|
||||
|
||||
@@ -122,39 +157,56 @@ export function ScreenshotImage({ src, loading, indicator, fallback, holdPreviou
|
||||
};
|
||||
}, [embedded, src, loading]);
|
||||
|
||||
const url = embedded && resolved?.source === src ? resolved.url : undefined;
|
||||
// An ordinary URL is its own picture; an embedded one is the URL its report resolved it to.
|
||||
const url = !embedded ? src : resolved?.source === src ? resolved.url : undefined;
|
||||
const state: ScreenshotState = failed === src ? "failed" : url && shown === url ? "ready" : "loading";
|
||||
const displayed = state !== "failed" ? url ?? held : undefined;
|
||||
// Shown once decoded. Replacing a held picture is no reveal: it stays up until the new one is there.
|
||||
const show = (image: HTMLImageElement, picture: string) => whenDecoded(image, picture, () => {
|
||||
setShown(picture);
|
||||
setRevealed(held || image.closest("[data-screenshot-instant]") ? undefined : picture);
|
||||
setHeld(undefined);
|
||||
});
|
||||
|
||||
// Re-committing the URL the image already shows (it left the viewport and came back before a
|
||||
// render, and the report still held the URL) fires no load event: the decoded image is ready.
|
||||
// render, and the report still held the URL) fires no load event: the loaded image is shown once
|
||||
// its decode settles, as a load would show it.
|
||||
useLayoutEffect(() => {
|
||||
const image = imageRef.current;
|
||||
if (!displayed || displayed !== url || shown === displayed || !image || image.getAttribute("src") !== displayed) return;
|
||||
if (image.complete && image.naturalWidth > 0) {
|
||||
setShown(displayed);
|
||||
setHeld(undefined);
|
||||
}
|
||||
}, [displayed, url, shown]);
|
||||
if (image.complete && image.naturalWidth > 0) show(image, displayed);
|
||||
});
|
||||
|
||||
if (!embedded) return <img {...props} ref={imageRef} loading={loading} src={src} onLoad={onLoad} onError={onError} />;
|
||||
if (state === "failed" && fallback !== undefined) return <>{fallback}</>;
|
||||
// The caller hears the screenshot's own load and error events and a failed resolve (dispatched
|
||||
// above, so untrusted), never the stand-in's.
|
||||
const isScreenshot = (event: SyntheticEvent<HTMLImageElement>) => Boolean(url) && event.currentTarget.getAttribute("src") === url;
|
||||
const status = {
|
||||
"data-screenshot-state": state,
|
||||
// A held picture stays shown while the new one loads; every other waiting image is hidden at once.
|
||||
"data-screenshot-held": state === "loading" && held ? "" : undefined,
|
||||
"data-screenshot-reveal": state === "ready" && revealed === url ? "" : undefined,
|
||||
onLoad: (event: SyntheticEvent<HTMLImageElement>) => {
|
||||
if (!isScreenshot(event)) return;
|
||||
show(event.currentTarget, url!);
|
||||
onLoad?.(event);
|
||||
},
|
||||
};
|
||||
// An ordinary URL loads natively. Each source is an image of its own, so the browser never paints the picture of
|
||||
// the source before while the new one loads; a held one keeps its element, which keeps painting it.
|
||||
if (!embedded) {
|
||||
return <img key={holdPrevious ? undefined : src} {...props} {...status} ref={imageRef} loading={loading} src={src}
|
||||
onError={event => {
|
||||
if (event.currentTarget.getAttribute("src") === src) { setFailed(src); setHeld(undefined); }
|
||||
onError?.(event);
|
||||
}} />;
|
||||
}
|
||||
return (
|
||||
<>
|
||||
<img {...props} ref={imageRef} loading={loading}
|
||||
<img {...props} {...status} ref={imageRef} loading={loading}
|
||||
src={displayed ?? waitingSource(props.width, props.height)}
|
||||
data-screenshot-src={src}
|
||||
data-screenshot-state={state}
|
||||
aria-busy={state === "loading" || undefined}
|
||||
onLoad={event => {
|
||||
if (!isScreenshot(event)) return;
|
||||
setShown(url);
|
||||
setHeld(undefined);
|
||||
onLoad?.(event);
|
||||
}}
|
||||
onError={event => {
|
||||
if (event.nativeEvent.isTrusted) {
|
||||
// The held picture's URL was revoked since (the report let it go): nothing to show until the new one.
|
||||
|
||||
@@ -12,7 +12,9 @@ import { shortcutsLive } from "../../utils/shortcuts";
|
||||
import { normalizeSearchText } from "../../utils/search";
|
||||
import { createKeyHold } from "../../utils/key-hold";
|
||||
import { placeholderScreen } from "../../utils/map-frame";
|
||||
import { reportScreens } from "../../utils/omitted-screens";
|
||||
import { ScreenScreenshotCard } from "../canvas/screen-screenshot-card";
|
||||
import { NoScreens } from "../shared/no-screens";
|
||||
import { useCanvasVisibleFrame } from "../canvas/visible-frame-provider";
|
||||
import { PhoneSheet } from "../phone/phone-chrome";
|
||||
import { PanelSearch } from "../shared/panel-search";
|
||||
@@ -33,6 +35,8 @@ export type ScreensViewProps = {
|
||||
/** The other appearances each screen changed in, when the report captured several. */
|
||||
changedElsewhere?: ReadonlyMap<string, Appearance[]> | undefined;
|
||||
selectedScreenId?: string | undefined;
|
||||
/** The routes a public report never captured: not listed, counted or found, as on the Map (omitted-screens.ts). */
|
||||
omittedScreenIds?: ReadonlySet<string> | undefined;
|
||||
/** A request (search, the Changes menu) to bring a screen into view; a new key asks again for the same screen. */
|
||||
focusRequest?: FocusRequest | undefined;
|
||||
/** The Changes menu's status filter: screens outside it are dimmed, as on the Map. */
|
||||
@@ -153,6 +157,8 @@ function ScreenCell(props: {
|
||||
dimmed: boolean;
|
||||
/** The run's screenshot shape, which a screen without a screenshot is framed in. */
|
||||
typicalSize?: ScreenshotSize | undefined;
|
||||
/** A phone's cell, whose screenshot is its own frame: no well frames it while it loads. */
|
||||
phone?: boolean | undefined;
|
||||
onSelect: () => void;
|
||||
}) {
|
||||
const artifact = primaryScreenshotForScreen(props.screen, props.index);
|
||||
@@ -175,6 +181,7 @@ function ScreenCell(props: {
|
||||
selected={props.selected}
|
||||
ariaPressed={props.selected}
|
||||
loading="lazy"
|
||||
backing={props.phone === true}
|
||||
onClick={props.onSelect}
|
||||
{...(props.via || props.elsewhere?.length ? { note: <>
|
||||
{props.via ? <span className="screens-cell-via">via “{props.via}”</span> : null}
|
||||
@@ -269,19 +276,21 @@ function Legend(props: { others: Appearance[] }) {
|
||||
* phone, a section per route folder (or per tab, when there are no route files), with the tree behind a Tree button.
|
||||
*/
|
||||
export function ScreensView(props: ScreensViewProps) {
|
||||
// The report's screens, as the Map draws them: a public report's routes it never captured are not among them.
|
||||
const screens = useMemo(() => reportScreens(props.map.screens, props.omittedScreenIds ?? new Set()), [props.map.screens, props.omittedScreenIds]);
|
||||
const tree: ScreenTree = useMemo(
|
||||
() => screenTree(props.map.screens, props.index, props.routeFiles),
|
||||
[props.index, props.map.screens, props.routeFiles],
|
||||
() => screenTree(screens, props.index, props.routeFiles),
|
||||
[props.index, screens, props.routeFiles],
|
||||
);
|
||||
const typicalSize = useMemo(
|
||||
() => typicalScreenshotSize(props.map.screens.map(screen => screenshotSize(primaryScreenshotForScreen(screen, props.index)))),
|
||||
[props.index, props.map.screens],
|
||||
() => typicalScreenshotSize(screens.map(screen => screenshotSize(primaryScreenshotForScreen(screen, props.index)))),
|
||||
[props.index, screens],
|
||||
);
|
||||
const changedIds = useMemo(
|
||||
() => new Set(props.map.screens
|
||||
() => new Set(screens
|
||||
.filter(screen => isChanged(props.diff, screen.id) || (props.changedElsewhere?.get(screen.id)?.length ?? 0) > 0)
|
||||
.map(screen => screen.id)),
|
||||
[props.changedElsewhere, props.diff, props.map.screens],
|
||||
[props.changedElsewhere, props.diff, screens],
|
||||
);
|
||||
const [filter, setFilter] = useState<Filter>(props.phone && changedIds.size > 0 ? "changed" : "all");
|
||||
const [treeOpen, setTreeOpen] = useState(false);
|
||||
@@ -290,9 +299,9 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
const [query, setQuery] = useState("");
|
||||
// The phone layout has no field to show or clear a query, so a query typed on desktop does not narrow it.
|
||||
const findQuery = findOpen && !props.phone ? query : "";
|
||||
const matches = useMemo(() => findMatches(props.map.screens, props.index, findQuery), [props.index, props.map.screens, findQuery]);
|
||||
const matches = useMemo(() => findMatches(screens, props.index, findQuery), [props.index, screens, findQuery]);
|
||||
const inChanged = filter === "changed" && changedIds.size > 0;
|
||||
const inFilter = inChanged ? changedIds : new Set(props.map.screens.map(screen => screen.id));
|
||||
const inFilter = inChanged ? changedIds : new Set(screens.map(screen => screen.id));
|
||||
const shown = matches ? new Set([...inFilter].filter(id => matches.has(id))) : inFilter;
|
||||
const sections = tree.sections
|
||||
.map(section => ({ ...section, screenIds: section.screenIds.filter(id => shown.has(id)) }))
|
||||
@@ -406,7 +415,7 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
setFilter(value);
|
||||
}}>
|
||||
{value === "changed" ? "Changed" : "All"}
|
||||
<span className="screens-chip-count">{value === "changed" ? changedIds.size : props.map.screens.length}</span>
|
||||
<span className="screens-chip-count">{value === "changed" ? changedIds.size : screens.length}</span>
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
@@ -563,6 +572,8 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
? ({ "--screens-right-inset": `calc(100% - ${visibleFrame.x + visibleFrame.width}px)` } as CSSProperties)
|
||||
: undefined;
|
||||
|
||||
if (screens.length === 0) return <NoScreens map={props.map} />;
|
||||
|
||||
const cell = (id: string) => {
|
||||
const screen = props.index.screens.get(id);
|
||||
return screen ? (
|
||||
@@ -570,6 +581,7 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
elsewhere={isChanged(props.diff, id) ? undefined : props.changedElsewhere?.get(id)}
|
||||
via={tree.via.get(id)}
|
||||
typicalSize={typicalSize}
|
||||
phone={props.phone}
|
||||
selected={props.selectedScreenId === id}
|
||||
dimmed={Boolean(props.focus?.length) && !props.focus!.some((state) => state === focusStatusOf(props.diff?.screens.get(id)))}
|
||||
onSelect={() => props.onSelectScreen(id)} />
|
||||
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
} from "../canvas/stage";
|
||||
import type { ProjectionMotionMetadata } from "../canvas/projection-motion";
|
||||
import { ScreenScreenshotCard } from "../canvas/screen-screenshot-card";
|
||||
import { NoScreens } from "../shared/no-screens";
|
||||
import { TransitionEdge, type TransitionGraphEdge } from "../canvas/transition-edge";
|
||||
import {
|
||||
buildViewerGraph,
|
||||
@@ -116,6 +117,7 @@ function ScreenNodeCard({ data, selected }: NodeProps<ScreenGraphNode>) {
|
||||
imageHeight={data.screenshotSize?.imageHeight ?? data.frame.screen.height}
|
||||
placeholderSize={data.frame.screen}
|
||||
loading="lazy"
|
||||
backing
|
||||
// The ring says which screen is which; a click opening it in the Inspector needs no tooltip.
|
||||
inspectorTooltip={false}
|
||||
leading={<Handle type="target" position={horizontal ? Position.Left : Position.Top} className="graph-handle" />}
|
||||
@@ -480,7 +482,11 @@ type BaseCanvasProps = {
|
||||
onSelectScreen: (id: string, options?: { replace?: boolean }) => void;
|
||||
onClearSelection?: () => void;
|
||||
};
|
||||
export type MapViewProps = BaseCanvasProps & { projectionFitKey?: number };
|
||||
export type MapViewProps = BaseCanvasProps & {
|
||||
projectionFitKey?: number;
|
||||
/** The routes a public report never captured: not drawn (omitted-screens.ts). */
|
||||
omittedScreenIds?: ReadonlySet<string> | undefined;
|
||||
};
|
||||
|
||||
function ConnectionCanvas(props: MapViewProps) {
|
||||
const surfaceRef = useRef<HTMLDivElement>(null);
|
||||
@@ -493,7 +499,10 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
});
|
||||
const previousLayout = useRef<{ nodes: CanvasGraphNode[]; edges: TransitionGraphEdge[] } | undefined>(undefined);
|
||||
|
||||
const observedGraph = useMemo(() => buildViewerGraph(props.map, props.index), [props.index, props.map]);
|
||||
const observedGraph = useMemo(
|
||||
() => buildViewerGraph(props.map, props.index, props.omittedScreenIds),
|
||||
[props.index, props.map, props.omittedScreenIds],
|
||||
);
|
||||
const projection = useMemo(() => projectFullGraph(observedGraph), [observedGraph]);
|
||||
const structure = useMemo(
|
||||
() => projectedStructure(projection, props.index, isBlackBoxMap(props.map)),
|
||||
@@ -657,19 +666,7 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
.sort((left, right) => left.depth - right.depth || left.y - right.y || left.x - right.x || left.index - right.index)
|
||||
.map(({ id }) => id), [layout.nodes]);
|
||||
const phone = usePhoneLayout();
|
||||
if (props.map.screens.length === 0) {
|
||||
const blockers = props.map.gaps.filter((gap) => gap.status === "open" && !gap.screenId).map((gap) => gap.message);
|
||||
return (
|
||||
<div className="graph-canvas canvas-empty">
|
||||
<div className="page-empty compact-empty map-empty">
|
||||
<h2>No screens were recorded</h2>
|
||||
{blockers.length > 0
|
||||
? blockers.map((message) => <p key={message}>{message}</p>)
|
||||
: <p>The run ended before any screen of the app was observed.</p>}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
if (observedGraph.screens.length === 0) return <NoScreens map={props.map} />;
|
||||
return (
|
||||
<div ref={surfaceRef} className="connection-canvas-surface map-surface">
|
||||
<CanvasStage
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
import { useEffect, useRef } from "react";
|
||||
import type { BuildDiff } from "../utils/build-diff";
|
||||
import type { ChangedScreen } from "../utils/changed-screens";
|
||||
import { isEmbeddedArtifactUrl, leaseEmbeddedArtifactUrl } from "../utils/embedded-report";
|
||||
import type { KeyHold } from "../utils/key-hold";
|
||||
|
||||
/** How long Compare rests on a screen before it reads the next one's screenshots. */
|
||||
export const NEIGHBOR_SETTLE_MS = 250;
|
||||
|
||||
export type NeighborScreenshotsOptions = {
|
||||
diff: BuildDiff;
|
||||
order: readonly ChangedScreen[];
|
||||
screenId: string;
|
||||
/** Compare steps between screens; the Inspector, which stays on its screen, reads no neighbour. */
|
||||
enabled: boolean;
|
||||
/** The keys that step: no neighbour is read while one is held. */
|
||||
hold: KeyHold;
|
||||
};
|
||||
|
||||
/**
|
||||
* Reads the screenshots of the screen Compare would step to next, in the direction it last stepped (by key, the
|
||||
* header's buttons, a tap or the picker), once it has rested on a screen. The next step usually finds them decoded,
|
||||
* so its pictures fade in within a frame of the step. Each is one use of the report's screenshot until Compare moves
|
||||
* on, then released; nothing is decoded outside the page's own images.
|
||||
*
|
||||
* A held key steps past screens faster than they could be read, so nothing is read until it is released. The reads
|
||||
* are the report's prefetches: one starts only while two slots stay free for the step the reviewer takes, so
|
||||
* speculative work never holds more than two, whatever earlier prefetches are still reading, and one that has not
|
||||
* started when Compare moves on is dropped unread.
|
||||
*/
|
||||
export function useNeighborScreenshots({ diff, order, screenId, enabled, hold }: NeighborScreenshotsOptions) {
|
||||
const position = order.findIndex((entry) => entry.id === screenId);
|
||||
const last = useRef<{ position: number; direction: 1 | -1 }>({ position, direction: 1 });
|
||||
useEffect(() => {
|
||||
if (!enabled || position < 0) return;
|
||||
const previous = last.current;
|
||||
const direction = position === previous.position ? previous.direction : position > previous.position ? 1 : -1;
|
||||
last.current = { position, direction };
|
||||
const neighbor = order[position + direction];
|
||||
const screen = neighbor ? diff.screens.get(neighbor.id) : undefined;
|
||||
const sources = new Set([screen?.beforeScreenshot, screen?.afterScreenshot]
|
||||
.filter((source): source is string => Boolean(source && isEmbeddedArtifactUrl(source))));
|
||||
if (sources.size === 0) return;
|
||||
const leases: { release: () => boolean; held: boolean }[] = [];
|
||||
let timer: ReturnType<typeof setTimeout>;
|
||||
const read = () => {
|
||||
if (hold.holding()) {
|
||||
timer = setTimeout(read, NEIGHBOR_SETTLE_MS);
|
||||
return;
|
||||
}
|
||||
for (const source of sources) {
|
||||
const leased = leaseEmbeddedArtifactUrl(source, "prefetch");
|
||||
const lease = { release: leased.release, held: true };
|
||||
leases.push(lease);
|
||||
// A read that failed (a report switched away from, or a prefetch dropped) holds nothing to release.
|
||||
void leased.url.catch(() => { lease.held = false; });
|
||||
}
|
||||
};
|
||||
timer = setTimeout(read, NEIGHBOR_SETTLE_MS);
|
||||
return () => {
|
||||
clearTimeout(timer);
|
||||
for (const lease of leases) if (lease.held) lease.release();
|
||||
};
|
||||
}, [enabled, position, order, diff, hold]);
|
||||
}
|
||||
@@ -24,7 +24,7 @@ export function reportContractGap(gap: ReviewContractGap): void {
|
||||
console.warn(`Explore report: ${where} failed the review contract (${gap.message}); ${gap.dropped} omitted.`);
|
||||
}
|
||||
import { sourceImpactSentences } from "../../../src/contracts/source-change";
|
||||
import { navigationCaptureContext } from "../../../src/contracts/navigation-graph";
|
||||
import { captureContext, captureGap, verifiedCapture } from "../../../src/contracts/surface-capture";
|
||||
import { projectSourceNavigation } from "../utils/source-navigation";
|
||||
|
||||
type Side = "base" | "head";
|
||||
@@ -89,12 +89,6 @@ function unattributedSummary(surface: Surface, side: Side): string {
|
||||
return "destination unverified";
|
||||
}
|
||||
|
||||
function verifiedCapture(surface: Surface, side: Side): boolean {
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
return Boolean(surface[side]?.kind === "screen" && imageFor(surface, side)
|
||||
&& outcome?.status === "captured" && outcome.landing === "verified");
|
||||
}
|
||||
|
||||
function comparisonReview(surface: Surface): Surface["review"] {
|
||||
if (surface.status === "added" || surface.status === "removed") {
|
||||
return surface.review?.status === surface.status ? surface.review : undefined;
|
||||
@@ -217,10 +211,7 @@ function sidePayload(review: PublicReview, side: Side): { map: ExploreMap; cover
|
||||
const id = routeOf(surface.id);
|
||||
if (!routes.has(id)) routes.set(id, { ...surface[side]!, id });
|
||||
}
|
||||
const selectedRoutes = navigation ? new Set(review.mode === "all" ? [...routes.keys()] : navigationCaptureContext(navigation,
|
||||
inventory.filter(surface => surface.status !== "unchanged").map(surface => routeOf(surface.id)),
|
||||
[...routes.values()])) : undefined;
|
||||
const selected = selectedRoutes ? new Set(inventory.filter(surface => selectedRoutes.has(routeOf(surface.id))).map(surface => surface.id)) : undefined;
|
||||
const selected = captureContext(review, side);
|
||||
// Planned structural groups describe the full inventory, including routes outside the
|
||||
// capture budget. Keep their placeholders available in every canvas.
|
||||
const declared = inventory;
|
||||
@@ -356,11 +347,11 @@ function sidePayload(review: PublicReview, side: Side): { map: ExploreMap; cover
|
||||
screenshotArtifactId: artifact.id,
|
||||
});
|
||||
}
|
||||
if (!verifiedCapture(surface, side)) {
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
// The gap's status is the one the PR comment reads too (surface-capture.ts), so both leave out the same routes.
|
||||
const gap = captureGap(review, surface, side, selected);
|
||||
if (gap) {
|
||||
const outsideCaptureContext = review.mode === "changes" && selected !== undefined && !selected.has(surface.id);
|
||||
const deliberatelyOmitted = !image && !outcome && (entry.kind === "redirect" || surface.excluded === true || outsideCaptureContext
|
||||
|| (!navigation && review.mode === "changes" && surface.status === "unchanged"));
|
||||
const deliberatelyOmitted = gap === "accepted";
|
||||
map.gaps.push({
|
||||
id: `capture:${side}:${surface.id}`,
|
||||
screenId: surface.id,
|
||||
|
||||
+79
-12
@@ -154,6 +154,8 @@
|
||||
/* The bottom bar resizes with the same timing as the canvas it switches. */
|
||||
--toolbar-motion: 220ms;
|
||||
--toolbar-easing: ease-in-out;
|
||||
/* A screenshot fades in over its empty frame once its pixels are decoded. */
|
||||
--screenshot-reveal: 160ms;
|
||||
}
|
||||
|
||||
:root[data-theme="dark"] {
|
||||
@@ -634,9 +636,10 @@ code {
|
||||
/* A screen without a screenshot, or whose screenshot could not be read, frames its placeholder
|
||||
where an image of --screenshot-width x --screenshot-height would sit under the rules above:
|
||||
contained in the slot inside its border, never enlarged. It lines up with the screenshots
|
||||
beside it, and a failed screenshot keeps the frame it waited in. */
|
||||
.screen-node-image:has(> .image-placeholder) { container-type: size; }
|
||||
.screen-node-image > .image-placeholder {
|
||||
beside it, and a failed screenshot keeps the frame it waited in. A Map card's screenshot waits
|
||||
over a backing of the same frame (below; a phone's Screens cell sizes it in phone.css). */
|
||||
.screen-node-image:has(> :is(.image-placeholder, .screenshot-backing)) { container-type: size; }
|
||||
.screen-node-image > :is(.image-placeholder, .screenshot-backing) {
|
||||
--frame-border: 1px;
|
||||
display: flex;
|
||||
box-sizing: content-box;
|
||||
@@ -670,8 +673,28 @@ code {
|
||||
specificity. The Map leaves the border to the status and rings the card from outside instead. */
|
||||
.screen-node-image:hover img,
|
||||
.screen-screenshot-card.selected .screen-node-image img { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
|
||||
.screen-node-image:hover > .image-placeholder,
|
||||
.screen-screenshot-card.selected .screen-node-image > .image-placeholder { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
|
||||
.screen-node-image:hover > :is(.image-placeholder, .screenshot-backing),
|
||||
.screen-screenshot-card.selected .screen-node-image > :is(.image-placeholder, .screenshot-backing) { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
|
||||
/* A Map card, and a Screens card on a phone, draws its frame (fill, border, status and rings) on
|
||||
the image itself, which is hidden while it loads. The backing draws the same frame under it, in
|
||||
the image's geometry, while the image waits and while it fades in, so the frame and its rings
|
||||
hold steady; then it hides. The fading image leaves its rings to the backing, so their soft lift
|
||||
is not drawn twice, and takes them back in the frame the backing hides. */
|
||||
.screen-node-image > .screenshot-backing {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
margin: auto;
|
||||
pointer-events: none;
|
||||
visibility: hidden;
|
||||
}
|
||||
.screen-node-image:has(> .screenshot-backing) > img { position: relative; }
|
||||
.screen-node-image:has(> img[data-screenshot-state="loading"]) > .screenshot-backing { visibility: visible; }
|
||||
.screen-node-image:has(> img[data-screenshot-reveal]) > .screenshot-backing { animation: screenshot-backing var(--screenshot-reveal) step-end; }
|
||||
.screen-node-image:has(> .screenshot-backing) > img[data-screenshot-reveal] {
|
||||
animation: screenshot-reveal var(--screenshot-reveal) ease-out, screenshot-backed var(--screenshot-reveal) step-end;
|
||||
}
|
||||
@keyframes screenshot-backing { from, to { visibility: visible; } }
|
||||
@keyframes screenshot-backed { from, to { box-shadow: none; } }
|
||||
.canvas-active-frame {
|
||||
position: relative;
|
||||
display: block;
|
||||
@@ -726,11 +749,11 @@ code {
|
||||
--ring-status: 0px;
|
||||
}
|
||||
.map-surface .screen-screenshot-card:is(.diff-added, .diff-modified, .diff-removed) { --ring-status: 2px; }
|
||||
.map-surface .screen-screenshot-card .screen-node-image :is(img, .image-placeholder) {
|
||||
.map-surface .screen-screenshot-card .screen-node-image :is(img, .image-placeholder, .screenshot-backing) {
|
||||
border-color: var(--border-subtle);
|
||||
box-shadow: none;
|
||||
}
|
||||
.map-surface .react-flow__node-screen:is(.selected, .graph-node-hover-subject) .screen-screenshot-card .screen-node-image :is(img, .image-placeholder) {
|
||||
.map-surface .react-flow__node-screen:is(.selected, .graph-node-hover-subject) .screen-screenshot-card .screen-node-image :is(img, .image-placeholder, .screenshot-backing) {
|
||||
box-shadow:
|
||||
0 0 0 var(--ring-status) var(--diff, transparent),
|
||||
0 0 0 calc(var(--ring-status) + 4 * var(--ring-unit)) var(--screen),
|
||||
@@ -1348,12 +1371,17 @@ code {
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
/* The frame holds the fill, so a screenshot that is hidden while it loads leaves its frame in place.
|
||||
Nothing clips to it: an outline's ring and measurement may cross the frame's edge. */
|
||||
.inspector-diff-preview:has(> img) {
|
||||
border-radius: 9px;
|
||||
background: var(--subtle);
|
||||
}
|
||||
.inspector-diff-preview img {
|
||||
display: block;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
border-radius: 9px;
|
||||
background: var(--subtle);
|
||||
object-fit: cover;
|
||||
}
|
||||
/* The frame line is drawn over the screenshot's edge, not inside its box, so the image fills
|
||||
@@ -1700,9 +1728,9 @@ code {
|
||||
border-color: var(--diff);
|
||||
box-shadow: 0 0 0 2px var(--diff);
|
||||
}
|
||||
.screen-screenshot-card .diff-frame.diff-added .screen-node-image > .image-placeholder,
|
||||
.screen-screenshot-card .diff-frame.diff-modified .screen-node-image > .image-placeholder,
|
||||
.screen-screenshot-card .diff-frame.diff-removed .screen-node-image > .image-placeholder {
|
||||
.screen-screenshot-card .diff-frame.diff-added .screen-node-image > :is(.image-placeholder, .screenshot-backing),
|
||||
.screen-screenshot-card .diff-frame.diff-modified .screen-node-image > :is(.image-placeholder, .screenshot-backing),
|
||||
.screen-screenshot-card .diff-frame.diff-removed .screen-node-image > :is(.image-placeholder, .screenshot-backing) {
|
||||
border-color: var(--diff);
|
||||
box-shadow: 0 0 0 2px var(--diff);
|
||||
}
|
||||
@@ -1779,6 +1807,24 @@ code {
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
.screenshot-loading > svg { animation: none; }
|
||||
}
|
||||
/* A screenshot that is loading or could not be read is hidden at once, in the same frame as its
|
||||
new source, so no view paints the picture of the source before (the browser keeps painting it
|
||||
until the new one loads) under a new screen's name or outlines; its frame stays. Hiding never
|
||||
fades, and outranks a view's own image opacity, such as a dimmed variant thumbnail's. A held
|
||||
picture (the app icon) stays shown until the new one is there. */
|
||||
:root img:is([data-screenshot-state="loading"]:not([data-screenshot-held]), [data-screenshot-state="failed"]) {
|
||||
opacity: 0;
|
||||
transition: none;
|
||||
}
|
||||
/* A picture that fills an empty frame fades in. An animation, not a transition: the image can be
|
||||
ready before its first paint, and it keeps a view's own resting opacity. */
|
||||
img[data-screenshot-reveal] { animation: screenshot-reveal var(--screenshot-reveal) ease-out; }
|
||||
@keyframes screenshot-reveal { from { opacity: 0; } }
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
img[data-screenshot-reveal],
|
||||
.screen-node-image:has(> .screenshot-backing) > img[data-screenshot-reveal],
|
||||
.screen-node-image:has(> img[data-screenshot-reveal]) > .screenshot-backing { animation: none; }
|
||||
}
|
||||
.status-badge { display: inline-flex; align-items: center; width: fit-content; padding: 4px 7px; border-radius: 6px; color: var(--secondary); background: var(--element); font-size: 10px; font-weight: 500; line-height: 1.2; text-transform: capitalize; }
|
||||
.status-badge.info { color: var(--accent-strong); background: var(--accent-soft); }
|
||||
.status-badge.success { color: var(--success); background: var(--success-soft); }
|
||||
@@ -2402,7 +2448,28 @@ html [data-sonner-toaster][data-sonner-theme] {
|
||||
flex: none; display: inline-flex; height: 24px; align-items: center; gap: 6px; margin: 0; padding: 0 8px 0 10px; border: 0; border-radius: 7px;
|
||||
background: var(--element); color: var(--secondary); font: inherit; font-size: 12.5px; font-weight: 500; line-height: 16px; white-space: nowrap; cursor: pointer;
|
||||
}
|
||||
.collapsed-platform > svg { width: 9px; height: 9px; }
|
||||
.collapsed-platform > svg { flex: none; width: 9px; height: 9px; }
|
||||
/* What the phone's fit leaves out (AppPill's data-drop) is not drawn. */
|
||||
.phone-layout .collapsed-app-identity[data-drop~="name"] > strong { display: none; }
|
||||
.phone-layout .collapsed-app-identity[data-drop~="pr"] > .tooltip-anchor:has(> .collapsed-pr) { display: none; }
|
||||
.collapsed-platform-label { display: flex; min-width: 0; overflow: hidden; }
|
||||
.collapsed-platform-label-text { min-width: 0; overflow: hidden; }
|
||||
.collapsed-platform-label-suffix { flex: none; white-space: pre; }
|
||||
/* The name a phone's row keeps gives way first, cut to its end down to its minimum, and the target's chip after it,
|
||||
down to its own; the fit reads both. */
|
||||
.phone-layout .collapsed-app-identity { --collapsed-name-min: 64px; --collapsed-target-min: 72px; }
|
||||
/* The target's label is the pill's one long configured text: once the phone's row has left out all it can, the name
|
||||
holds at its minimum and the target's chip shrinks instead. */
|
||||
.phone-layout .collapsed-app-identity[data-drop~="squeeze"] > strong { flex: none; max-width: var(--collapsed-name-min); }
|
||||
.phone-layout .collapsed-app-identity[data-drop~="squeeze"] .collapsed-target { flex: 0 1 auto; min-width: var(--collapsed-target-min); }
|
||||
.phone-layout .collapsed-app-identity[data-drop~="squeeze"] > .tooltip-anchor:has(> .collapsed-target) { flex: 0 1 auto; min-width: var(--collapsed-target-min); }
|
||||
.phone-layout .collapsed-app-identity[data-drop~="pose"] .collapsed-target .collapsed-platform-label-suffix { flex: 0 1 auto; min-width: 0; overflow: hidden; }
|
||||
/* The device's text gives way before the pose: it takes what the pose leaves, if anything. */
|
||||
.phone-layout .collapsed-app-identity[data-drop~="pose"] .collapsed-target .collapsed-platform-label-text { flex: 1 1 0; }
|
||||
/* A cut device or pose (AppPill's data-fade) fades out at its end rather than ending in "…" and the slack an ellipsis
|
||||
leaves; the full name is a tap away in its menu. */
|
||||
.phone-layout .collapsed-app-identity[data-fade~="device"] .collapsed-target .collapsed-platform-label-text,
|
||||
.phone-layout .collapsed-app-identity[data-fade~="pose"] .collapsed-target .collapsed-platform-label-suffix { mask-image: linear-gradient(to right, #000 calc(100% - 16px), transparent); }
|
||||
.collapsed-platform > .collapsed-platform-busy { width: 11px; height: 11px; animation: spin 1s linear infinite; }
|
||||
.collapsed-platform:hover, .collapsed-platform[aria-expanded="true"] { color: var(--text); background: var(--hover); }
|
||||
.collapsed-platform:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
|
||||
|
||||
@@ -266,8 +266,12 @@ function validateManifest(value: unknown): PreviewManifest {
|
||||
}
|
||||
return manifest;
|
||||
}
|
||||
/** Eager screenshots (the Inspector's) are decoded before lazy ones (canvas nodes and thumbnails). */
|
||||
export type ScreenshotPriority = "eager" | "lazy";
|
||||
/**
|
||||
* Eager screenshots (the Inspector's) are decoded before lazy ones (canvas nodes and thumbnails), and both before a
|
||||
* prefetch (the screen Compare would step to next), which only takes a slot while PREFETCH_RESERVE others stay free.
|
||||
*/
|
||||
export type ScreenshotPriority = "eager" | "lazy" | "prefetch";
|
||||
const PRIORITY_RANK: Record<ScreenshotPriority, number> = { eager: 0, lazy: 1, prefetch: 2 };
|
||||
type ImageLoad = {
|
||||
sha256: string;
|
||||
users: number;
|
||||
@@ -279,6 +283,12 @@ type ImageLoad = {
|
||||
};
|
||||
|
||||
const DECODE_SLOTS = 4;
|
||||
/**
|
||||
* The slots a prefetch leaves free: a running read keeps its slot after it is let go, so these are what the two
|
||||
* screenshots of the screen the reviewer does step to start in, whichever way that is. A prefetch waiting for a slot
|
||||
* is dropped, unread, when it is let go first.
|
||||
*/
|
||||
const PREFETCH_RESERVE = 2;
|
||||
/**
|
||||
* Released screenshots keep their Blob URL, up to this many and this many bytes in all, so panning
|
||||
* back needs no new decode.
|
||||
@@ -299,7 +309,7 @@ export class ArtifactReportArchive {
|
||||
/** Decoded screenshots nobody uses, least recently released first, and their total size. */
|
||||
private readonly retained = new Map<string, { url: string; bytes: number }>();
|
||||
private retainedBytes = 0;
|
||||
private readonly queues: Record<ScreenshotPriority, ImageLoad[]> = { eager: [], lazy: [] };
|
||||
private readonly queues: Record<ScreenshotPriority, ImageLoad[]> = { eager: [], lazy: [], prefetch: [] };
|
||||
private disposed = false;
|
||||
private running = 0;
|
||||
private retainedLimit = RETAINED_SCREENSHOTS;
|
||||
@@ -418,7 +428,8 @@ export class ArtifactReportArchive {
|
||||
|
||||
/**
|
||||
* A verified Blob URL for an embedded screenshot. Each call is one use until `release`. At most
|
||||
* four screenshots are read and hashed at once; eager requests wait ahead of lazy ones.
|
||||
* four screenshots are read and hashed at once; eager requests wait ahead of lazy ones, and both
|
||||
* ahead of a prefetch.
|
||||
*/
|
||||
async resolve(reference: string, priority: ScreenshotPriority = "lazy"): Promise<string> {
|
||||
const sha256 = IMAGE_REFERENCE.exec(reference)?.[1];
|
||||
@@ -429,7 +440,7 @@ export class ArtifactReportArchive {
|
||||
const existing = this.loads.get(sha256);
|
||||
if (existing) {
|
||||
existing.users++;
|
||||
if (priority === "eager" && existing.priority === "lazy") this.promote(existing);
|
||||
if (PRIORITY_RANK[priority] < PRIORITY_RANK[existing.priority]) this.promote(existing, priority);
|
||||
return existing.pending;
|
||||
}
|
||||
const kept = this.retained.get(sha256);
|
||||
@@ -460,7 +471,7 @@ export class ArtifactReportArchive {
|
||||
|
||||
dispose(): void {
|
||||
this.disposed = true;
|
||||
for (const load of this.queues.eager.splice(0).concat(this.queues.lazy.splice(0))) {
|
||||
for (const load of this.waitingLoads()) {
|
||||
load.waiting?.drop(new Error("This report was closed."));
|
||||
}
|
||||
for (const load of this.loads.values()) if (load.url) URL.revokeObjectURL(load.url);
|
||||
@@ -476,7 +487,7 @@ export class ArtifactReportArchive {
|
||||
* used them releases them against the report shown next, so the ones still in use are dropped here instead.
|
||||
*/
|
||||
trim(): void {
|
||||
for (const load of this.queues.eager.splice(0).concat(this.queues.lazy.splice(0))) {
|
||||
for (const load of this.waitingLoads()) {
|
||||
load.waiting?.drop(new Error("This screenshot is no longer in use."));
|
||||
}
|
||||
// What the Viewer was showing is kept as released, most recent last, so switching back shows it at once.
|
||||
@@ -523,7 +534,7 @@ export class ArtifactReportArchive {
|
||||
}
|
||||
|
||||
private acquireSlot(load: ImageLoad): Promise<void> {
|
||||
if (this.running < DECODE_SLOTS) {
|
||||
if (this.running < this.slotsFor(load)) {
|
||||
this.running++;
|
||||
return Promise.resolve();
|
||||
}
|
||||
@@ -533,6 +544,11 @@ export class ArtifactReportArchive {
|
||||
});
|
||||
}
|
||||
|
||||
/** How many slots may be running when `load` starts: all of them, or for a prefetch all but the reserve. */
|
||||
private slotsFor(load: ImageLoad): number {
|
||||
return load.priority === "prefetch" ? DECODE_SLOTS - PREFETCH_RESERVE : DECODE_SLOTS;
|
||||
}
|
||||
|
||||
/** Hand a finished decode's slot to the next waiting load that someone still uses. */
|
||||
private releaseSlot(): void {
|
||||
for (let load = this.nextWaiting(); load; load = this.nextWaiting()) {
|
||||
@@ -549,16 +565,38 @@ export class ArtifactReportArchive {
|
||||
this.running--;
|
||||
}
|
||||
|
||||
/**
|
||||
* The next waiting load the slot being handed on may start. A prefetch waits while the other running loads would
|
||||
* leave less than the reserve free, unless it was let go, which drops it.
|
||||
*/
|
||||
private nextWaiting(): ImageLoad | undefined {
|
||||
return this.queues.eager.shift() ?? this.queues.lazy.shift();
|
||||
const load = this.queues.eager[0] ?? this.queues.lazy[0] ?? this.queues.prefetch[0];
|
||||
if (load && load.users > 0 && this.running > this.slotsFor(load)) return undefined;
|
||||
return load ? this.queues[load.priority].shift() : undefined;
|
||||
}
|
||||
|
||||
private promote(load: ImageLoad): void {
|
||||
load.priority = "eager";
|
||||
const index = this.queues.lazy.indexOf(load);
|
||||
private waitingLoads(): ImageLoad[] {
|
||||
return this.queues.eager.splice(0).concat(this.queues.lazy.splice(0), this.queues.prefetch.splice(0));
|
||||
}
|
||||
|
||||
/**
|
||||
* Move a load up to `priority`. A prefetch waiting for its reserve that the reviewer has stepped to starts at once
|
||||
* when a slot is free, rather than waiting for a running read to finish.
|
||||
*/
|
||||
private promote(load: ImageLoad, priority: ScreenshotPriority): void {
|
||||
const queue = this.queues[load.priority];
|
||||
load.priority = priority;
|
||||
const index = queue.indexOf(load);
|
||||
if (index < 0) return;
|
||||
this.queues.lazy.splice(index, 1);
|
||||
this.queues.eager.push(load);
|
||||
queue.splice(index, 1);
|
||||
if (load.waiting && this.running < this.slotsFor(load)) {
|
||||
const waiting = load.waiting;
|
||||
delete load.waiting;
|
||||
this.running++;
|
||||
waiting.start();
|
||||
return;
|
||||
}
|
||||
this.queues[priority].push(load);
|
||||
}
|
||||
|
||||
/** Keep a released URL; beyond either limit the least recently released ones are revoked. */
|
||||
|
||||
@@ -123,15 +123,16 @@ export function buildObservedGraph(map: ExploreMap, index: MapIndex): ObservedGr
|
||||
};
|
||||
}
|
||||
|
||||
/** The Viewer can overlay declarations; the observed graph and event indexes stay intact. */
|
||||
export function buildViewerGraph(map: ExploreMap, index: MapIndex): ObservedGraph {
|
||||
const NONE: ReadonlySet<string> = new Set();
|
||||
|
||||
/**
|
||||
* The Viewer can overlay declarations; the observed graph and event indexes stay intact. A public report preserves its
|
||||
* complete source inventory, but the routes it never captured are not its screens: `omitted` names them, the one set
|
||||
* every view of the report takes (omitted-screens.ts). The launch is never among them: it is where the app starts,
|
||||
* drawn above the start screens with a synthetic edge into each of them.
|
||||
*/
|
||||
export function buildViewerGraph(map: ExploreMap, index: MapIndex, omitted: ReadonlySet<string> = NONE): ObservedGraph {
|
||||
const observed = buildObservedGraph(map, index);
|
||||
// A public report preserves its complete source inventory, but an accepted capture gap
|
||||
// marks a redirect or a route outside changes-mode selection. Neither is a screen image. The app
|
||||
// launch is not a route, so its accepted "no splash observed" gap keeps it on the map: it is where
|
||||
// the app starts, drawn above the start screens with a synthetic edge into each of them.
|
||||
const omitted = new Set<string>();
|
||||
if (map.run.id.startsWith("public:")) for (const gap of map.gaps) if (gap.status === "accepted" && gap.screenId && !isLaunchScreen({ id: gap.screenId })) omitted.add(gap.screenId);
|
||||
const screens = observed.screens.filter(screen => !omitted.has(screen.id));
|
||||
const visibleIds = new Set(screens.map(screen => screen.id));
|
||||
const launchEdges = launchGroups(screens);
|
||||
|
||||
Loaded 100 of 102 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user