mirror of
https://github.com/expo/explore.git
synced 2026-11-15 13:18:16 -10:00
Compare commits
13
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0352b3e5fc | ||
|
|
7bf12bcf42 | ||
|
|
f904120f78 | ||
|
|
9a548cf2e8 | ||
|
|
40b581d385 | ||
|
|
c7f7dc800d | ||
|
|
8e576c5f57 | ||
|
|
deed8e9cc1 | ||
|
|
a3f1ad2ffa | ||
|
|
91b2b49d61 | ||
|
|
490123d380 | ||
|
|
87106f6672 | ||
|
|
88a73dd2a9 |
No files matched your search
+13
-13
@@ -34,31 +34,31 @@ Older setups vendored the tools into `.github/vendor/expo-explore` and pinned th
|
||||
| Workflow | Trigger | Condition | Result |
|
||||
| --- | --- | --- | --- |
|
||||
| `explore-review.yml` | `pull_request_target` (opened, synchronize, reopened, ready_for_review), `workflow_dispatch` with `pr=N` | Open, non-draft, same-repository PR whose author has write access or is listed in `ci.trustedAuthors` | Captures base and head, compares, packages a report, comments on the PR |
|
||||
| `explore-baseline.yml` | `push` to the default branch, `workflow_dispatch` | Default branch only | Captures every route of one commit per configured platform and uploads `explore-baseline-<sha>-<platform>` for later PRs to reuse |
|
||||
| `explore-baseline.yml` | `push` to the default branch, `workflow_dispatch` | Default branch only | Captures every route of one commit per configured target and uploads `explore-baseline-<sha>-<target>` for later PRs to reuse |
|
||||
| `explore-compare.yml` | `workflow_dispatch` or `workflow_call` with `base` and `head` (branch, tag or SHA) | Whoever can run or call workflows (write access) | Captures base and head, compares, packages a report like a PR review (`capture:review --compare`), and links it from the run summary; no PR comment |
|
||||
|
||||
Each workflow starts with a `platforms` job: it installs the pinned CLI and runs `expo-explore config:platforms`, whose JSON list (`["ios"]`, `["ios","android"]`) becomes the matrix of the capture, report, and baseline jobs (`fail-fast: false`). Every matrix job passes `--platform ${{ matrix.platform }}`, so one platform's failure neither cancels nor hides the other's report.
|
||||
Each workflow starts with a `targets` job: it installs the pinned CLI and runs `expo-explore config:targets`, whose target ids (`jq -c '[.targets[].id]'`) become the matrix of the capture, report, and baseline jobs (`fail-fast: false`). A config without `targets:` has one target per platform named after it (`["ios"]`, `["ios","android"]`), so its artifact names, baselines and comment records are the ones per-platform versions wrote; a config with `targets:` lists its own (`["iphone","duo-closed","duo-open","android"]`), and several may share a platform. Every matrix job passes `--target "$TARGET"` (`TARGET: ${{ matrix.target }}`), and GitHub names each job after its target (`capture (duo-open)`), so one target's failure neither cancels nor hides another's report.
|
||||
|
||||
### 2.2 `explore-review.yml`
|
||||
|
||||
| Job | Step | What it does |
|
||||
| --- | --- | --- |
|
||||
| platforms | Install Explore, resolve and authorize the live pull request | As in the capture job below; it exports the PR's number and commits so the failure job can comment even when a capture job fails before resolving the PR itself. Then checks out head and lists the platforms. |
|
||||
| capture (matrix: platform) | Install Explore | Validates `EXPLORE_VERSION`, `npm pack`s that release into `$TOOLS_PREFIX`, then `npm ci --omit=dev --include=optional --ignore-scripts` against the release's shrinkwrap. The agent runtimes and `eas-cli` are optional dependencies, so `--include=optional` is what makes capture possible. The step is defined once per workflow file (a YAML anchor) and reused in every job. |
|
||||
| targets | Install Explore, resolve and authorize the live pull request | As in the capture job below; it exports the PR's number and commits so the failure job can comment even when a capture job fails before resolving the PR itself. Then checks out head and lists the targets. |
|
||||
| capture (matrix: target) | Install Explore | Validates `EXPLORE_VERSION`, `npm pack`s that release into `$TOOLS_PREFIX`, then `npm ci --omit=dev --include=optional --ignore-scripts` against the release's shrinkwrap. The agent runtimes and `eas-cli` are optional dependencies, so `--include=optional` is what makes capture possible. The step is defined once per workflow file (a YAML anchor) and reused in every job. |
|
||||
| | Resolve and authorize the live pull request | `ci:pr` reads the PR through the API. Forks, drafts and authors without write access (unless listed in `ci.trustedAuthors` of the default branch's `config.yaml`, read through the API) fail with `SOURCE_NOT_TRUSTED`. Writes `explore-pr.json` (repository, number, base/head ref and SHA) and the step outputs. Runs before any PR code is checked out. |
|
||||
| | checkout `app-base`, `app-head` | Checks out the exact base and head SHAs with full history and without persisted credentials. |
|
||||
| | Verify deterministic source planning | `source:verify` builds the capture plan from source alone in two fresh processes and compares the bytes. Runs before any build or simulator work and needs no credentials. |
|
||||
| | Install app dependencies | `npm ci --ignore-scripts` in both checkouts (`APP_INSTALL_DIR` for monorepos). |
|
||||
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<platform>` artifact (iOS also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
|
||||
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<target>` artifact (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
|
||||
| | Capture review | `capture:review` (§3). `EXPO_TOKEN`, the provider key and the app's `{{secret:NAME}}` values reach only this step. The sticky PR comment is updated while it runs. It writes `preview=<hosting>` to the step outputs, which decides whether the deploy job runs. |
|
||||
| | Stop capture sessions and check the checkouts | `ci:after-capture`, whenever the PR was resolved, success or not: stops the EAS Simulator sessions named in `head-session` / `base-session`, nothing else, then fails with `CHECKOUT_MODIFIED` if capture modified an app checkout. |
|
||||
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<platform>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<platform>` keeps plans, exports and agent diagnostics for 7 days. |
|
||||
| report (matrix: platform) | Install Explore, download the capture | Runs without Expo or model credentials. |
|
||||
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<target>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<target>` keeps plans, exports and agent diagnostics for 7 days. |
|
||||
| report (matrix: target) | Install Explore, download the capture | Runs without Expo or model credentials. |
|
||||
| | Package hosted review bundle | `ci:report` writes the report directory. |
|
||||
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<platform>`, kept 30 days. |
|
||||
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment has one section per platform between `<!-- expo-explore-platform:<platform> -->` markers; each job replaces only its own section, so parallel platforms do not overwrite each other. |
|
||||
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every platform's capture and report artifacts, zips and encrypts each report, deploys it with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report** and the link's expiry. |
|
||||
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed platform's section when the run has several. |
|
||||
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
|
||||
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
|
||||
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, zips and encrypts each report, deploys it with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report** and the link's expiry. |
|
||||
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
|
||||
|
||||
A reviewer downloads the report ZIP and drops it on the hosted Viewer; downloading needs read access to the repository.
|
||||
|
||||
@@ -68,7 +68,7 @@ Validate baseline source → Install Explore → Verify deterministic source pla
|
||||
|
||||
### 2.4 `explore-compare.yml`
|
||||
|
||||
The same jobs as a PR review, for any `base` and `head` without a pull request. The `platforms` job resolves both refs once with `ci:compare-refs` (a tag wins over a branch of the same name; the same commit twice fails with `COMPARE_SAME_COMMIT`) and passes the comparison to the capture jobs, which run `capture:review --compare` with no GitHub requests. The optional `scope` and `expires-in` inputs override `exploration.scope` and `report.preview.expiresAfter` for that run. The report job's `ci:publish` writes each platform's **Open** and **zip** links to the run summary, and the deploy job adds the hosted link there; nothing comments on a pull request.
|
||||
The same jobs as a PR review, for any `base` and `head` without a pull request. The `targets` job resolves both refs once with `ci:compare-refs` (a tag wins over a branch of the same name; the same commit twice fails with `COMPARE_SAME_COMMIT`) and passes the comparison to the capture jobs, which run `capture:review --compare` with no GitHub requests. The optional `scope` and `expires-in` inputs override `exploration.scope` and `report.preview.expiresAfter` for that run. The report job's `ci:publish` writes each target's **Open** and **zip** links to the run summary, and the deploy job adds the hosted link there; nothing comments on a pull request.
|
||||
|
||||
## 3. Inside `capture:review` (`runCiReview`)
|
||||
|
||||
@@ -93,7 +93,7 @@ A failure at any stage is recorded in `state.failure`, a partial report is writt
|
||||
| 1 | cache | If a reuse directory exists, its bundle and map are validated and copied. With no routes left, skip straight to export. |
|
||||
| 2 | `configuration` | `eas config --profile` confirms the app identity and scheme, `ios.simulator: true` and the bundle ID; `eas simulator:availability`. |
|
||||
| 3 | `build` | `eas fingerprint:generate`; a finished simulator build with the same fingerprint is reused, otherwise `eas build --wait` (up to 45 minutes). |
|
||||
| 4 | `instrumentation` | A hosted EAS `repack` workflow job (`eas workflow:run --wait --json` from a staged copy of the checkout) rebundles the current JavaScript with a read-only navigation observer (the same observer on both sides) and returns the repacked build ID; `capture.repack: local` runs `@expo/repack-app` on the runner and `eas upload`s the result. Generated files stay outside the checkout. |
|
||||
| 4 | `instrumentation` | A hosted EAS `repack` workflow job (`eas workflow:run --wait --json` from a staged copy of the checkout) rebundles the current JavaScript with a read-only navigation observer (the same observer on both sides), and the repacked app is downloaded and installed into the session; `capture.repack: local` (the default with `capture.simulator: local`) runs `@expo/repack-app` on the runner, and its app is installed without an upload. Generated files stay outside the checkout. |
|
||||
| 5 | `session` | `eas simulator:start`; the session ID is written to `<side>-session`; the app is installed. |
|
||||
| 6 | route capture | Mode-specific (§5). `agent-device` drives the simulator and records a screenshot plus the accessibility tree. A capture is accepted only when the observer's reported destination matches the requested route. |
|
||||
| 7 | `export` / `cleanup` | Validate the map, write `<side>-export/` (`bundle.json`, `execution.json`, PNGs, `capture-diagnostics/`), stop the session. |
|
||||
|
||||
@@ -298,6 +298,26 @@ platforms:
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary id="targets"><strong>Several devices: targets</strong></summary>
|
||||
|
||||
To capture more than one device of a platform, such as a phone and a foldable, or a foldable both closed and open, name each one under `targets` instead of `platforms`. Each target is captured and reported on its own, in this order:
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
iphone: { platform: ios, device: iPhone 17 }
|
||||
duo-closed: { platform: ios, device: iPhone Duo, pose: closed }
|
||||
duo-open: { platform: ios, device: iPhone Duo, pose: open }
|
||||
android: { platform: android, device: pixel_7, bundleId: com.example.myapp, easProfile: explore-android }
|
||||
```
|
||||
|
||||
- A target takes the flat `app` and `device` fields it does not set; a target of another platform than `app.platform` sets its own `bundleId` and `easProfile`. `label` names it in reports (by default its device and pose).
|
||||
- Ids are lowercase letters, digits and dashes. A config with `platforms` has one target per platform, named `ios` and `android`.
|
||||
- The workflows run one capture job per target, the PR comment has a section per target, and each report links its sibling targets' reports.
|
||||
- `capture --target duo-open` reviews one target on this machine; `--platform ios` the iOS ones.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary id="controller"><strong>Device controller: agent-device or Argent</strong></summary>
|
||||
|
||||
@@ -317,7 +337,34 @@ Explore pins each controller's version and starts the EAS session with it. Repor
|
||||
|
||||
Neither controller is installed with Explore. The first run that needs one downloads its pinned npm release (agent-device 1.4 MB, Argent 27 MB), checks it against the integrity hash Explore pins, and keeps it in `~/.cache/expo-explore/controllers` (`EXPLORE_CONTROLLER_CACHE` moves it). Behind a private registry, set `EXPLORE_NPM_REGISTRY` to a mirror of it.
|
||||
|
||||
Argent cannot switch the simulator's appearance yet ([software-mansion/argent#1509](https://github.com/software-mansion/argent/pull/1509)), so an Argent capture records one appearance: the one the app forces, else light. Explore warns when it skips one.
|
||||
Argent cannot switch the simulator's appearance yet ([software-mansion/argent#1509](https://github.com/software-mansion/argent/pull/1509)), so an Argent capture on EAS Simulator records one appearance: the one the app forces, else light. Explore warns when it skips one. On a [local simulator](#simulator) the host switches it, so both are captured.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary id="simulator"><strong>Local simulator instead of EAS Simulator</strong></summary>
|
||||
|
||||
To capture on your Mac instead of EAS Simulator, set it in the config or pass it for one run:
|
||||
|
||||
```yaml
|
||||
capture:
|
||||
simulator: local # eas (default) | local
|
||||
```
|
||||
|
||||
```sh
|
||||
npx @expo/explore capture --simulator local
|
||||
```
|
||||
|
||||
For each commit, Explore starts a device of its own and removes it afterwards; head and base each get one:
|
||||
|
||||
- **iOS:** a simulator of the configured device with Xcode's newest runtime that runs it. `DEVELOPER_DIR` picks another Xcode, such as one that adds iPhone Duo. Explore approves the app's URL scheme on it, so links open without iOS asking "Open in …?", and checks a foldable's pose by the shape of its lit display.
|
||||
- **Android:** an emulator of the configured device profile (such as `pixel_7`), from the newest Google APIs system image installed for this machine (`arm64-v8a` on Apple silicon), in a private AVD folder. The APK must ship native libraries for that ABI; a universal build does.
|
||||
|
||||
Builds still run on EAS. The app is repacked with the route observer on your machine as well, so it is never uploaded; on Android that needs the SDK's build-tools and a JDK. `capture.repack: eas` (or `--repack eas`) keeps the repack in a hosted EAS job. `doctor --simulator local` checks that Xcode and the Android SDK can start each device, and that Android can be repacked locally.
|
||||
|
||||
With `--controller argent`, Explore installs Argent's tool-server on first use (with its dependencies, about 165 MB, in the controller cache) and starts one per device. The host switches the appearance, so a local Argent capture records light and dark. Reports record where they were captured, and a baseline is reused only by a review captured the same way.
|
||||
|
||||
A review's targets run at once, the targets of a platform sharing each commit's build; `--parallel N` runs at most N at a time. A device controller that stops answering on one screen costs that route: Explore restarts the app, goes on with the next route, and records what happened in `capture-diagnostics/controller-recoveries.jsonl`. A target that fails outright costs its own report; the others still open.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -476,7 +523,7 @@ Reports and baselines are kept for 30 days and diagnostics for 7. Hosted deploym
|
||||
- The launch is captured once per appearance and compared like any screen. The comment says how long the splash stayed as it first appeared, when it first changed (a native launch screen handing over to an app-drawn one, an animation starting on it), and when the first screen settled. `capture.launch: video` adds a recording; a launch too fast to observe is reported as "no splash observed".
|
||||
- On Android the splash usually shows only in the recording, which needs `ffmpeg`. The generated workflows install it.
|
||||
- Hosted acceptance of agent mode with an API key is incomplete.
|
||||
- With `capture.controller: argent`, each capture records one appearance (see [device controller](#controller)).
|
||||
- With `capture.controller: argent` on EAS Simulator, each capture records one appearance (see [device controller](#controller)).
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
+2263
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"name": "expo-explore-argent-tool-server",
|
||||
"private": true,
|
||||
"description": "Argent's tool-server at the release Explore pins, with every dependency locked: installed with npm ci for local simulators.",
|
||||
"dependencies": {
|
||||
"@swmansion/argent": "0.29.0"
|
||||
}
|
||||
}
|
||||
@@ -73,7 +73,7 @@ Every selected target on both revisions must have a screenshot of its verified d
|
||||
|
||||
### Automatic destination verification
|
||||
|
||||
CI repacks both Base and Head with the same read-only navigation observer, including when EAS creates a fresh native build. By default the repack is a hosted EAS `repack` workflow job: the tracked files of the clean checkout are staged in a temporary copy together with the generated observer, Metro override and a one-job workflow, uploaded with `eas workflow:run --wait`, and the job's build ID starts the simulator session. `capture.repack: local` runs `@expo/repack-app` on the runner and uploads the result with `eas upload` instead. Generated files never land in the source checkout. The application does not need to import a marker or maintain a screen manifest.
|
||||
CI repacks both Base and Head with the same read-only navigation observer, including when EAS creates a fresh native build. By default the repack is a hosted EAS `repack` workflow job: the tracked files of the clean checkout are staged in a temporary copy together with the generated observer, Metro override and a one-job workflow, and run with `eas workflow:run --wait`; the repacked app is downloaded and installed into the simulator session, which started while the job ran. `capture.repack: local` runs `@expo/repack-app` on the runner instead, and its app is installed without being uploaded. With `capture.simulator: local` the repack runs on that machine unless `capture.repack: eas` says otherwise. Generated files never land in the source checkout. The application does not need to import a marker or maintain a screen manifest.
|
||||
|
||||
The observer adapter requires **Expo SDK 57 or newer** and an installed Expo CLI with Metro configuration override support. It accepts **Expo Router 57 or newer**, or **React Navigation core 6 or newer**. Older packages fail instrumentation explicitly.
|
||||
|
||||
@@ -103,7 +103,7 @@ exploration:
|
||||
capture:
|
||||
maxMinutes: 30
|
||||
maxActions: 500
|
||||
repack: eas # eas (hosted workflow job) | local (repack-app on the runner)
|
||||
repack: eas # eas (hosted workflow job; the default on EAS Simulator) | local (repack-app on the runner; the default with simulator: local)
|
||||
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
|
||||
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
|
||||
reset: root-link # root-link (open the app's root link and let it settle before every route link, default) | none (each link opens from whatever the previous route left on screen)
|
||||
|
||||
+18
-3
@@ -105,10 +105,11 @@ device:
|
||||
exploration:
|
||||
scope: changes # changes | all
|
||||
capture:
|
||||
# controller: agent-device # agent-device (default) | argent (one appearance per capture until Argent can switch it; --controller overrides it for one run)
|
||||
# controller: agent-device # agent-device (default) | argent (one appearance per capture on EAS Simulator until Argent can switch it; --controller overrides it for one run)
|
||||
# simulator: eas # eas (EAS Simulator, default) | local (a simulator or emulator Explore starts on this machine with Xcode or the Android SDK; --simulator overrides it for one run)
|
||||
maxMinutes: 30
|
||||
maxActions: 500
|
||||
repack: eas # eas (hosted EAS workflow job, default) | local (repack-app + eas upload on the runner)
|
||||
repack: eas # eas (hosted EAS workflow job, the default on EAS Simulator) | local (repack-app on the runner, the default with simulator: local; --repack overrides it for one run)
|
||||
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
|
||||
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
|
||||
reset: root-link # root-link (open the app's root link and let it settle before every route link, default) | none (each link opens from whatever the previous route left on screen)
|
||||
@@ -131,6 +132,20 @@ platforms:
|
||||
|
||||
Commands that capture or publish (`source:verify`, `capture:review`, `capture:baseline`, `ci:report`, `ci:publish`) take `--platform ios|android`; with one configured platform it is optional, with two it is required (`PLATFORM_REQUIRED`). `expo-explore config:platforms` prints the configured list as JSON, which the workflows use as their matrix. Artifacts carry the platform (`explore-capture-<run>-<attempt>-android`, `explore-baseline-<sha>-ios`); an iOS job still reuses an older unsuffixed baseline. The PR comment has one section per platform, and a hosted preview serves both reports from one link.
|
||||
|
||||
### Several devices (targets)
|
||||
|
||||
`targets` names each capture instead of `platforms`, so one platform can have several devices or poses. Each target is captured, published and commented on as its own report, in config order:
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
iphone: { platform: ios, device: iPhone 17 }
|
||||
duo-closed: { platform: ios, device: iPhone Duo, pose: closed }
|
||||
duo-open: { platform: ios, device: iPhone Duo, pose: open, label: "iPhone Duo (open)" }
|
||||
android: { platform: android, device: pixel_7, bundleId: com.example.myapp, easProfile: explore-android }
|
||||
```
|
||||
|
||||
A target's id (lowercase letters, digits and dashes; not `base`, `head` or `report`) takes the place of the platform everywhere a capture is named: `--target duo-open`, `explore-capture-<run>-<attempt>-duo-open`, `explore-baseline-<sha>-duo-open`. `expo-explore config:targets` prints the list the workflows use as their matrix. Fields a target leaves out come from `app` and `device`; a target of another platform than `app.platform` sets its own `bundleId` and `easProfile`. A config with `platforms` has one target per platform, named `ios` and `android`, so its names do not change. `--platform` still selects a target when only one has that platform.
|
||||
|
||||
Use the actual bundle identifier, scheme, profile, and available simulator device name. `scheme` is optional when static app configuration supplies it. `navigation.entry` resolves ambiguous entry modules; it does not list screens.
|
||||
|
||||
Do not add a surface inventory, required fixture routes, runtime probe, configuration version, or Viewer URL. The analyzer discovers screens from source. Application data, time, and network remain live.
|
||||
@@ -271,7 +286,7 @@ The provider selects the runtime that owns the navigation loop:
|
||||
| `anthropic` | Claude Code through `@anthropic-ai/claude-agent-sdk` 0.3.285 and its platform-native package | `ANTHROPIC_API_KEY` |
|
||||
| `openai` | Codex app-server from `@openai/codex` 0.159.2 and its platform-native package | `OPENAI_API_KEY` |
|
||||
|
||||
Both runtimes use Explore's device tools to operate the existing EAS Simulator through official `agent-device` 0.21.15. The runtime and native binaries come from the pinned tools installation. CI does not use the development-only `node_modules/.bin/claude` executable or an interactive subscription login.
|
||||
Both runtimes use Explore's device tools to operate the existing EAS Simulator through official `agent-device` 0.21.28. The runtime and native binaries come from the pinned tools installation. CI does not use the development-only `node_modules/.bin/claude` executable or an interactive subscription login.
|
||||
|
||||
Create and commit the nonempty English prose file named by `agent.instructions`. The shared setup skill authors it from source and asks for missing test data or environment inputs. Describe how to reach the app's screens, necessary prerequisites, the representative state to use on both revisions, readiness signals, and actions to avoid. This file guides the runtime agent; it is not a list of mandatory YAML steps or a second screen inventory.
|
||||
|
||||
|
||||
Generated
+4
-4
@@ -29,7 +29,7 @@
|
||||
"@types/react-dom": "^19.2.4",
|
||||
"@vitejs/plugin-react": "^4.7.0",
|
||||
"@xyflow/react": "^12.11.3",
|
||||
"agent-device": "0.21.15",
|
||||
"agent-device": "0.21.28",
|
||||
"babel-plugin-react-compiler": "^1.0.0",
|
||||
"eslint": "^10.12.0",
|
||||
"eslint-plugin-react-hooks": "^7.1.1",
|
||||
@@ -4580,9 +4580,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/agent-device": {
|
||||
"version": "0.21.15",
|
||||
"resolved": "https://registry.npmjs.org/agent-device/-/agent-device-0.21.15.tgz",
|
||||
"integrity": "sha512-Om1j6oNJkeKlkk8lBM+0V9bKwpxUXLMf/PDDSvAt3RFquBRqAiM58J81E0rvPQNxs6GCjhABYpwVvIAXptxjjA==",
|
||||
"version": "0.21.28",
|
||||
"resolved": "https://registry.npmjs.org/agent-device/-/agent-device-0.21.28.tgz",
|
||||
"integrity": "sha512-uGEENVhPzSpIACrVlt16O1mloODWJyAemTCT0boDb4L006JXN2rG747u1TRoQJudOpdP/Pm2urxNRHeECLMLfg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"bin": {
|
||||
|
||||
+2
-1
@@ -9,6 +9,7 @@
|
||||
},
|
||||
"files": [
|
||||
"action.yml",
|
||||
"controllers/argent-tool-server",
|
||||
"npm-shrinkwrap.json",
|
||||
"dist",
|
||||
"docs",
|
||||
@@ -82,7 +83,7 @@
|
||||
"@types/react-dom": "^19.2.4",
|
||||
"@vitejs/plugin-react": "^4.7.0",
|
||||
"@xyflow/react": "^12.11.3",
|
||||
"agent-device": "0.21.15",
|
||||
"agent-device": "0.21.28",
|
||||
"babel-plugin-react-compiler": "^1.0.0",
|
||||
"eslint": "^10.12.0",
|
||||
"eslint-plugin-react-hooks": "^7.1.1",
|
||||
|
||||
@@ -68,6 +68,16 @@
|
||||
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z$"
|
||||
},
|
||||
"platform": { "enum": ["ios", "android"] },
|
||||
"runTarget": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": ["id", "platform", "label"],
|
||||
"properties": {
|
||||
"id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,31}$" },
|
||||
"platform": { "$ref": "#/$defs/platform" },
|
||||
"label": { "type": "string", "minLength": 1 }
|
||||
}
|
||||
},
|
||||
"controller": { "enum": ["agent-device", "argent"] },
|
||||
"actionKind": {
|
||||
"enum": ["press", "fill", "swipe", "back", "dismiss", "deep-link", "key", "other"]
|
||||
@@ -162,6 +172,8 @@
|
||||
"name": { "type": "string", "minLength": 1 },
|
||||
"platform": { "$ref": "#/$defs/platform" },
|
||||
"platforms": { "type": "array", "items": { "$ref": "#/$defs/platform" }, "minItems": 2, "uniqueItems": true },
|
||||
"target": { "$ref": "#/$defs/runTarget" },
|
||||
"targets": { "type": "array", "items": { "$ref": "#/$defs/runTarget" }, "minItems": 2, "maxItems": 8 },
|
||||
"controller": { "$ref": "#/$defs/controller" },
|
||||
"bundleId": { "type": "string" },
|
||||
"deviceId": { "type": "string" },
|
||||
|
||||
@@ -372,6 +372,11 @@ class FileRangeReader extends Reader<unknown> {
|
||||
|
||||
const readers = new WeakMap<object, FileRangeReader>();
|
||||
|
||||
/** The ABIs an APK ships native libraries for (`lib/<abi>/`), without reading its manifest. */
|
||||
export async function apkAbis(path: string): Promise<string[]> {
|
||||
return [...new Set((await zipEntries(path)).map(entry => /^lib\/([^/]+)\//.exec(entry.filename)?.[1]).filter((abi): abi is string => !!abi))].sort();
|
||||
}
|
||||
|
||||
async function zipEntries(path: string): Promise<ZipEntry[]> {
|
||||
configure({ useWebWorkers: false });
|
||||
const reader = new FileRangeReader(path);
|
||||
|
||||
@@ -82,6 +82,8 @@ export function mergeSchemeOutcomes(passes: readonly Record<string, CaptureOutco
|
||||
// frame too: the review then shows that appearance and marks the primary one unavailable, instead of nothing.
|
||||
if (verified(outcome)) {
|
||||
if (scheme && !(primary && primary.status === "captured")) merged[schemeScreenId(id, scheme)] = outcome;
|
||||
// Its note (setup that did not complete in that appearance) stays with the route the frame is published under.
|
||||
else if (outcome.reason && merged[id]) merged[id] = { ...merged[id], reason: [merged[id].reason, scheme ? `In ${scheme}: ${outcome.reason}` : outcome.reason].filter(Boolean).join(" ") };
|
||||
continue;
|
||||
}
|
||||
if (scheme && primary && primary.status === "captured") merged[schemeScreenId(id, scheme)] = outcome;
|
||||
|
||||
@@ -96,6 +96,9 @@ async function main(): Promise<number> {
|
||||
const result = await runBridgeCommand(argv, {
|
||||
state, platform, version: ARGENT_VERSION,
|
||||
...(environment.EXPLORE_ARGENT_BUNDLE_ID ? { bundleId: environment.EXPLORE_ARGENT_BUNDLE_ID } : {}),
|
||||
...(environment.EXPLORE_ARGENT_DEVICE ? { device: environment.EXPLORE_ARGENT_DEVICE } : {}),
|
||||
// An opened foldable's inner panel shows its UI in landscape (Argent's fold: "Unfolded, the UI is landscape").
|
||||
...(platform === "ios" && ["open", "half-open"].includes(environment.EXPLORE_ARGENT_POSE ?? "") ? { landscape: true } : {}),
|
||||
call: async (tool, args, options) => {
|
||||
const started = Date.now();
|
||||
try {
|
||||
@@ -120,6 +123,16 @@ async function main(): Promise<number> {
|
||||
return ok;
|
||||
},
|
||||
sleep: milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds)),
|
||||
orientVideo: async path => {
|
||||
// Turned with ffmpeg, which observing a launch needs anyway; without it the recording is left as it is.
|
||||
const probed = spawnSync("ffprobe", ["-v", "error", "-select_streams", "v:0", "-show_entries", "stream=width,height", "-of", "csv=p=0:s=x", path], { encoding: "utf8", timeout: 30_000 });
|
||||
const [width, height] = (probed.stdout ?? "").trim().split("x").map(Number);
|
||||
if (probed.status !== 0 || !width || !height || width >= height) return;
|
||||
const turned = `${path}.upright.mp4`;
|
||||
const ffmpeg = spawnSync("ffmpeg", ["-nostdin", "-y", "-loglevel", "error", "-i", path, "-vf", "transpose=clock", "-an", turned], { encoding: "utf8", timeout: 120_000 });
|
||||
if (ffmpeg.status === 0) await rename(turned, path);
|
||||
else await rm(turned, { force: true });
|
||||
},
|
||||
scratchImage: { path: join(dirname(statePath), "argent-scratch.png"), read: async path => {
|
||||
const { PNG } = createRequire(import.meta.url)("pngjs") as { PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
|
||||
return PNG.sync.read(await readFile(path), { checkCRC: false });
|
||||
@@ -141,3 +154,4 @@ async function main(): Promise<number> {
|
||||
}
|
||||
|
||||
process.exitCode = await main();
|
||||
|
||||
@@ -38,6 +38,8 @@ export type ArgentBridgeContext = {
|
||||
platform: ArgentPlatform;
|
||||
/** The app under test when the caller names it outside the command (explore:binary's `install`). */
|
||||
bundleId?: string;
|
||||
/** The device to drive (UDID or adb serial) when the tool-server sees several: a local one serves this machine's. */
|
||||
device?: string;
|
||||
version: string;
|
||||
sleep: (milliseconds: number) => Promise<void>;
|
||||
/** Moves a file the Argent client downloaded (a screen recording) to where Explore asked for it. */
|
||||
@@ -46,6 +48,14 @@ export type ArgentBridgeContext = {
|
||||
reachable: () => Promise<boolean>;
|
||||
/** A file the bridge may overwrite with a screenshot, and a reader for it (the link-prompt fallback). */
|
||||
scratchImage?: { path: string; read: (path: string) => Promise<DecodedFrame> };
|
||||
/**
|
||||
* The UI is landscape on a panel whose native axes are portrait, as on an opened iPhone Duo. Argent reads such a panel
|
||||
* on its portrait axes (screen, tree and taps all agree), so only what a person sees is turned: screenshots are
|
||||
* captured upright, and recordings, which Argent cannot turn, go to orientVideo.
|
||||
*/
|
||||
landscape?: boolean;
|
||||
/** Turns a portrait screen recording a quarter clockwise, to the landscape UI it shows. */
|
||||
orientVideo?: (path: string) => Promise<void>;
|
||||
};
|
||||
|
||||
export type BridgeResult = { exitCode: number; stdout: string };
|
||||
@@ -309,11 +319,14 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
|
||||
const listed = await call("list-devices");
|
||||
const all = Array.isArray(listed.devices) ? listed.devices : [];
|
||||
devices = all.map(record).filter(device => device.platform === platform
|
||||
&& (platform === "ios" ? device.state === "Booted" && device.runtimeKind !== "tv" : device.state === "device" && device.runtimeKind !== "tv"));
|
||||
&& (platform === "ios" ? device.state === "Booted" && device.runtimeKind !== "tv" : device.state === "device" && device.runtimeKind !== "tv")
|
||||
&& (!context.device || (platform === "ios" ? device.udid : device.serial) === context.device));
|
||||
if (all.length) break;
|
||||
await context.sleep(2_000);
|
||||
}
|
||||
if (devices.length !== 1) throw new BridgeFailure("DEVICE_UNAVAILABLE", `Argent lists ${devices.length} booted ${platform} devices on this session; Explore drives exactly one.`);
|
||||
if (devices.length !== 1) throw new BridgeFailure("DEVICE_UNAVAILABLE", context.device
|
||||
? `Argent does not list ${context.device} among the booted ${platform} devices.`
|
||||
: `Argent lists ${devices.length} booted ${platform} devices on this session; Explore drives exactly one.`);
|
||||
const device = devices[0]!;
|
||||
const udid = platform === "ios" ? device.udid : device.serial;
|
||||
if (typeof udid !== "string" || !udid) throw new BridgeFailure("DEVICE_UNAVAILABLE", "Argent did not name the booted device.");
|
||||
@@ -570,7 +583,8 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
|
||||
await ensureDevice();
|
||||
const path = positional[0];
|
||||
if (!path) throw new BridgeFailure("INVALID_ARGS", "screenshot needs a path.");
|
||||
await call("screenshot", { scale: 1 }, { out: path });
|
||||
// Upright on a portrait panel showing a landscape UI; on the opened iPhone Duo that is LandscapeRight (seen on iOS 27.1).
|
||||
await call("screenshot", { scale: 1, ...(context.landscape ? { rotation: "LandscapeRight" } : {}) }, { out: path });
|
||||
return success({ path });
|
||||
}
|
||||
case "record": {
|
||||
@@ -587,6 +601,7 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
|
||||
delete state.recording;
|
||||
if (typeof stopped.video !== "string") return failure("COMMAND_FAILED", "Argent did not return the recording.");
|
||||
if (target) await context.moveFile(stopped.video, target);
|
||||
if (target && context.landscape && context.orientVideo) await context.orientVideo(target);
|
||||
return success({ outPath: target ?? stopped.video, ...(finite(stopped.durationMs) ? { durationMs: stopped.durationMs } : {}) });
|
||||
}
|
||||
return failure("INVALID_ARGS", `Unsupported record command: ${positional[0] ?? ""}`);
|
||||
|
||||
@@ -42,6 +42,8 @@ export function baseEnvironment(environment: NodeJS.ProcessEnv): NodeJS.ProcessE
|
||||
"ANDROID_SDK_ROOT",
|
||||
"ANDROID_HOME",
|
||||
"JAVA_HOME",
|
||||
// A local simulator runs with this Xcode instead of xcode-select's, e.g. one that adds iPhone Duo.
|
||||
"DEVELOPER_DIR",
|
||||
]) {
|
||||
if (environment[name] !== undefined) result[name] = environment[name];
|
||||
}
|
||||
|
||||
@@ -17,6 +17,10 @@ const shellQuote = (value: string) => `'${value.replace(/'/g, `'\\''`)}'`;
|
||||
*/
|
||||
export async function argentControllerInvocation(options: {
|
||||
directory: string; connection: SimulatorConnection; platform: "ios" | "android"; environment: NodeJS.ProcessEnv; bundleId?: string;
|
||||
/** The device to drive (UDID or adb serial) when the tool-server sees several, as a local one does. */
|
||||
device?: string;
|
||||
/** A foldable's pose (device.pose): opened, its UI is landscape on a portrait panel, which the bridge turns upright. */
|
||||
pose?: string;
|
||||
/** The caller's full environment, which names the controller cache and npm registry the narrowed one drops. */
|
||||
sourceEnvironment?: NodeJS.ProcessEnv;
|
||||
}): Promise<{ command: string; environment: NodeJS.ProcessEnv }> {
|
||||
@@ -38,6 +42,8 @@ export async function argentControllerInvocation(options: {
|
||||
...(source.EXPLORE_NPM_REGISTRY ? { EXPLORE_NPM_REGISTRY: source.EXPLORE_NPM_REGISTRY } : {}),
|
||||
// Opt-in: each Argent call to a JSON-lines log, one file per session, for debugging a controller run.
|
||||
...(source.EXPLORE_ARGENT_LOG_DIR ? { EXPLORE_ARGENT_LOG_DIR: source.EXPLORE_ARGENT_LOG_DIR, EXPLORE_ARGENT_LOG_NAME: options.connection.sessionId } : {}),
|
||||
...(options.bundleId ? { EXPLORE_ARGENT_BUNDLE_ID: options.bundleId } : {}) },
|
||||
...(options.bundleId ? { EXPLORE_ARGENT_BUNDLE_ID: options.bundleId } : {}),
|
||||
...(options.device ? { EXPLORE_ARGENT_DEVICE: options.device } : {}),
|
||||
...(options.pose ? { EXPLORE_ARGENT_POSE: options.pose } : {}) },
|
||||
};
|
||||
}
|
||||
+25
-54
@@ -1,4 +1,4 @@
|
||||
import { cp, lstat, realpath, mkdtemp, mkdir, writeFile, readFile, rm } from "node:fs/promises";
|
||||
import { cp, lstat, realpath, mkdtemp, mkdir, writeFile, readFile, rename, rm } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { isAbsolute, basename, dirname, resolve, join } from "node:path";
|
||||
import type { SourceRoute } from "../contracts/source-route.js";
|
||||
@@ -146,35 +146,6 @@ async function downloadedAppPath(stdout: string, privateRoot: string, platform:
|
||||
return canonical;
|
||||
}
|
||||
|
||||
function uploadedBuildId(stdout: string): string {
|
||||
const value = parseJson(stdout, "eas upload");
|
||||
if (!isRecord(value) || typeof value.url !== "string") {
|
||||
throw new Error("eas upload did not return a build URL");
|
||||
}
|
||||
let url: URL;
|
||||
try {
|
||||
url = new URL(value.url);
|
||||
} catch {
|
||||
throw new Error("eas upload returned an invalid build URL");
|
||||
}
|
||||
if (
|
||||
url.protocol !== "https:"
|
||||
|| url.hostname !== "expo.dev"
|
||||
|| url.port
|
||||
|| url.username
|
||||
|| url.password
|
||||
|| url.search
|
||||
|| url.hash
|
||||
) {
|
||||
throw new Error("eas upload returned an untrusted build URL");
|
||||
}
|
||||
const segments = url.pathname.split("/").filter(Boolean);
|
||||
if (segments.at(-2) !== "builds") {
|
||||
throw new Error("eas upload returned an unexpected build URL");
|
||||
}
|
||||
return buildIdFrom({ id: segments.at(-1) }, "eas upload");
|
||||
}
|
||||
|
||||
export type RepackProfile = {
|
||||
easEnvironment: string;
|
||||
profileEnvironment: Record<string, string>;
|
||||
@@ -525,6 +496,12 @@ async function prepareHostedRepack(options: {
|
||||
return hostedRepackBuildId(run.stdout, run.stderr, options.platform);
|
||||
}
|
||||
|
||||
/**
|
||||
* The instrumented app a capture runs, on this machine, and the EAS build it came from when a hosted job repacked it.
|
||||
* A local repack is never uploaded, so it has no build id.
|
||||
*/
|
||||
export type PreparedBuild = { buildId: string | null; app: string };
|
||||
|
||||
export async function prepareExactSourceBuild(options: {
|
||||
platform?: "ios" | "android";
|
||||
runner: CommandRunner;
|
||||
@@ -537,14 +514,16 @@ export async function prepareExactSourceBuild(options: {
|
||||
easEnvironment: NodeJS.ProcessEnv;
|
||||
repackEnvironment: NodeJS.ProcessEnv;
|
||||
routes: readonly SourceRoute[];
|
||||
/** `eas` (default) repacks in a hosted EAS workflow job; `local` runs repack-app on this machine and `eas upload`s the result. */
|
||||
/** `eas` (default) repacks in a hosted EAS workflow job; `local` runs repack-app on this machine. */
|
||||
repack?: RepackMode | undefined;
|
||||
/** The capture build profile name; the hosted repack job builds against it. */
|
||||
easProfile?: string | undefined;
|
||||
}): Promise<string | undefined> {
|
||||
/** Where to leave the instrumented app on this machine, for the capture to install; it must not exist yet. */
|
||||
keepApp: string;
|
||||
}): Promise<PreparedBuild | undefined> {
|
||||
const platform = options.platform ?? "ios";
|
||||
const root = await mkdtemp(join(tmpdir(), "expo-explore-repack-"));
|
||||
let outcome: string | null | undefined;
|
||||
let outcome: PreparedBuild | null | undefined;
|
||||
let primaryError: unknown;
|
||||
try {
|
||||
const providers = [...new Set(options.routes.map(route => route.provider))];
|
||||
@@ -553,10 +532,18 @@ export async function prepareExactSourceBuild(options: {
|
||||
nextAction: "Select the application's navigation provider in config.yaml and rerun source planning." });
|
||||
if ((options.repack ?? "eas") === "eas") {
|
||||
if (!options.easProfile) throw new Error("The hosted repack needs the capture build profile name.");
|
||||
outcome = await prepareHostedRepack({ platform, runner: options.runner, easCommand: options.easCommand, project: options.project,
|
||||
const hosted = await prepareHostedRepack({ platform, runner: options.runner, easCommand: options.easCommand, project: options.project,
|
||||
nativeBuildId: options.nativeBuildId, easProfile: options.easProfile, repackProfile: options.repackProfile,
|
||||
easEnvironment: options.easEnvironment, restrictedEnvironment: options.repackEnvironment, provider: providers[0]!,
|
||||
parameterKeys: captureObserverParameterKeys(options.routes), root });
|
||||
{
|
||||
// The hosted job leaves its app on EAS; the capture installs a copy downloaded here.
|
||||
const downloaded = await downloadedAppPath(options.runner({ command: options.easCommand,
|
||||
args: ["build:download", "--build-id", hosted, "--json", "--non-interactive"], cwd: options.project,
|
||||
environment: { ...options.easEnvironment, TMPDIR: root, TMP: root, TEMP: root }, timeoutMs: 10 * 60_000 }).stdout, root, platform);
|
||||
await rename(downloaded, options.keepApp);
|
||||
outcome = { buildId: hosted, app: options.keepApp };
|
||||
}
|
||||
} else {
|
||||
const shadowProject = join(root, "eas-project");
|
||||
const pulledEnvironmentPath = join(root, "server.env");
|
||||
@@ -671,26 +658,10 @@ export async function prepareExactSourceBuild(options: {
|
||||
if (repackedInfo.isSymbolicLink() || (platform === "android" ? !repackedInfo.isFile() : !repackedInfo.isDirectory())) {
|
||||
throw new Error(platform === "android" ? "repack-app did not produce a non-symlink Android .apk file" : "repack-app did not produce a non-symlink iOS .app directory");
|
||||
}
|
||||
let uploaded;
|
||||
try {
|
||||
uploaded = options.runner({
|
||||
command: options.easCommand,
|
||||
args: [
|
||||
"upload",
|
||||
"--platform", platform,
|
||||
"--build-path", repackedApp,
|
||||
"--fingerprint", options.fingerprint,
|
||||
"--json",
|
||||
"--non-interactive",
|
||||
],
|
||||
cwd: options.project,
|
||||
environment: privateEasEnvironment,
|
||||
timeoutMs: 10 * 60_000,
|
||||
});
|
||||
} catch (error) {
|
||||
throw easPlanLimitError(error, platform) ?? error;
|
||||
}
|
||||
outcome = uploadedBuildId(uploaded.stdout);
|
||||
// The capture installs the repacked app from here (a local device directly, an EAS session through its
|
||||
// controller), so it is never uploaded.
|
||||
await rename(repackedApp, options.keepApp);
|
||||
outcome = { buildId: null, app: options.keepApp };
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
import { randomUUID } from "node:crypto";
|
||||
import { mkdir, readdir, readFile, rename, rm, writeFile } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import { exploreCacheRoot } from "../shared/cache-root.js";
|
||||
import { deleteLocalEmulator, deleteLocalSimulator, emulatorPortsDirectory, stopLocalAgentDevice, stopLocalArgentServer } from "./local-simulator.js";
|
||||
import type { CommandRunner } from "./run.js";
|
||||
|
||||
/**
|
||||
* What one capture side started on this machine: its simulator or emulator, its agent-device daemon (under `directory`)
|
||||
* and its Argent tool-server, with the process that owns them. A capture that stops cleanly removes its record; one
|
||||
* stopped hard (a second Ctrl+C, a killed terminal) leaves it, and the next local review cleans up after it.
|
||||
*/
|
||||
export type LocalCaptureRecord = { owner: number; startedAt: string; directory: string; udid?: string; serial?: string; avd?: string;
|
||||
argent?: { pid: number; cli: string; home: string } };
|
||||
|
||||
function registryDirectory(environment: NodeJS.ProcessEnv): string {
|
||||
return join(exploreCacheRoot(environment), "local-captures");
|
||||
}
|
||||
|
||||
/** Records what a capture side starts, as it starts it; `close` forgets it once everything is stopped. */
|
||||
export async function openLocalCaptureRecord(environment: NodeJS.ProcessEnv, directory: string): Promise<{
|
||||
update: (patch: Partial<Omit<LocalCaptureRecord, "owner" | "startedAt" | "directory">>) => Promise<void>; close: () => Promise<void> }> {
|
||||
const registry = registryDirectory(environment);
|
||||
await mkdir(registry, { recursive: true, mode: 0o700 });
|
||||
const path = join(registry, `${randomUUID()}.json`);
|
||||
let record: LocalCaptureRecord = { owner: process.pid, startedAt: new Date().toISOString(), directory };
|
||||
const write = async () => {
|
||||
// Written whole and renamed, so a sweep never reads half a record.
|
||||
await writeFile(`${path}.tmp`, JSON.stringify(record), { mode: 0o600 });
|
||||
await rename(`${path}.tmp`, path);
|
||||
};
|
||||
await write();
|
||||
return { update: async patch => { record = { ...record, ...patch }; await write(); }, close: () => rm(path, { force: true }) };
|
||||
}
|
||||
|
||||
function alive(pid: number): boolean {
|
||||
if (!Number.isInteger(pid) || pid <= 0) return false;
|
||||
try { process.kill(pid, 0); return true; } catch (error) { return (error as NodeJS.ErrnoException).code === "EPERM"; }
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops what captures whose process has exited left running, and says what it stopped. Only what Explore recorded is
|
||||
* touched, never other simulators or emulators on this machine. An emulator's console port may have been taken by a
|
||||
* live capture since; then that emulator is left alone rather than risk stopping the live one.
|
||||
*/
|
||||
export async function sweepLocalCaptures(options: { environment: NodeJS.ProcessEnv; runner: CommandRunner; cwd: string }): Promise<string[]> {
|
||||
const registry = registryDirectory(options.environment);
|
||||
const swept: string[] = [];
|
||||
for (const name of await readdir(registry).catch(() => [] as string[])) {
|
||||
if (!name.endsWith(".json")) continue;
|
||||
const path = join(registry, name);
|
||||
const record = await readFile(path, "utf8").then(text => JSON.parse(text) as LocalCaptureRecord, () => undefined);
|
||||
if (!record || typeof record.owner !== "number" || alive(record.owner)) continue;
|
||||
const { runner, cwd, environment } = options;
|
||||
let complete = true;
|
||||
const attempt = async (what: string, stop: () => unknown) => {
|
||||
try { await stop(); swept.push(what); } catch { complete = false; }
|
||||
};
|
||||
if (record.argent && Number.isInteger(record.argent.pid)) {
|
||||
const argent = record.argent;
|
||||
await attempt(`Argent tool-server (pid ${argent.pid})`, () => stopLocalArgentServer({ ...argent, environment: { PATH: environment.PATH, HOME: argent.home } }));
|
||||
}
|
||||
if (typeof record.directory === "string") await attempt("agent-device daemon", () => stopLocalAgentDevice(join(record.directory, "agent-device-state")));
|
||||
if (typeof record.udid === "string") await attempt(`simulator ${record.udid}`, () => deleteLocalSimulator({ runner, udid: record.udid!, cwd, environment }));
|
||||
if (typeof record.serial === "string") {
|
||||
const holder = Number(await readFile(join(emulatorPortsDirectory(environment), `${record.serial.slice("emulator-".length)}.lock`), "utf8").catch(() => ""));
|
||||
if (!alive(holder) || holder === record.owner) await attempt(`emulator ${record.serial}`, () => deleteLocalEmulator({ runner, serial: record.serial!, cwd, environment }));
|
||||
}
|
||||
if (!complete) continue;
|
||||
if (typeof record.directory === "string") await rm(record.directory, { recursive: true, force: true });
|
||||
await rm(path, { force: true });
|
||||
}
|
||||
return swept;
|
||||
}
|
||||
@@ -0,0 +1,417 @@
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { existsSync } from "node:fs";
|
||||
import { mkdir, readdir, readFile, rm, stat, symlink, writeFile } from "node:fs/promises";
|
||||
import { homedir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { apkAbis } from "../binary/archive.js";
|
||||
import { exploreCacheRoot } from "../shared/cache-root.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { isRecord, parseJson } from "./common.js";
|
||||
import type { CommandRunner } from "./run.js";
|
||||
|
||||
/**
|
||||
* A simulator Explore creates on this Mac for one capture (`capture.simulator: local`), in place of an EAS Simulator
|
||||
* session. Each capture gets its own device, so head and base run side by side without sharing app state, and the
|
||||
* device is deleted when the capture ends.
|
||||
*/
|
||||
export type LocalSimulator = { udid: string; name: string; deviceType: string; runtime: string; osVersion: string };
|
||||
|
||||
/** A session state file names a local simulator with this prefix, so an interrupted review deletes it rather than calling EAS. */
|
||||
export const LOCAL_SIMULATOR_STATE_PREFIX = "simctl-";
|
||||
|
||||
const UDID = /^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/;
|
||||
|
||||
function simctl(runner: CommandRunner, args: string[], cwd: string, environment: NodeJS.ProcessEnv, timeoutMs = 60_000, allowFailure = false) {
|
||||
return runner({ command: "xcrun", args: ["simctl", ...args], cwd, environment, timeoutMs, ...(allowFailure ? { allowFailure } : {}) });
|
||||
}
|
||||
|
||||
function versionKey(version: string): number[] {
|
||||
return version.split(".").map(part => Number.parseInt(part, 10) || 0);
|
||||
}
|
||||
|
||||
function newer(left: string, right: string): boolean {
|
||||
const a = versionKey(left), b = versionKey(right);
|
||||
for (let index = 0; index < Math.max(a.length, b.length); index += 1) {
|
||||
if ((a[index] ?? 0) !== (b[index] ?? 0)) return (a[index] ?? 0) > (b[index] ?? 0);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/** The device type named like the configured device, and the newest installed iOS runtime that runs it. */
|
||||
export function localSimulatorTarget(devicetypes: string, runtimes: string, device: string): { deviceType: string; runtime: string; osVersion: string } {
|
||||
const types = parseJson(devicetypes, "simctl list devicetypes");
|
||||
const type = (isRecord(types) && Array.isArray(types.devicetypes) ? types.devicetypes : [])
|
||||
.find(entry => isRecord(entry) && entry.name === device);
|
||||
if (!isRecord(type) || typeof type.identifier !== "string") throw new CiError({ code: "LOCAL_SIMULATOR_DEVICE_UNAVAILABLE", stage: "session",
|
||||
message: `This Mac's Xcode has no ${device} simulator.`,
|
||||
nextAction: `Set device.name in config.yaml to a simulator listed by xcrun simctl list devicetypes, or install the Xcode that adds ${device} and select it with xcode-select.` });
|
||||
const listed = parseJson(runtimes, "simctl list runtimes");
|
||||
let best: { runtime: string; osVersion: string } | undefined;
|
||||
for (const entry of isRecord(listed) && Array.isArray(listed.runtimes) ? listed.runtimes : []) {
|
||||
if (!isRecord(entry) || entry.isAvailable !== true || entry.platform !== "iOS" || typeof entry.identifier !== "string" || typeof entry.version !== "string") continue;
|
||||
const supported = Array.isArray(entry.supportedDeviceTypes) && entry.supportedDeviceTypes.some(supportedType => isRecord(supportedType) && supportedType.identifier === type.identifier);
|
||||
if (supported && (!best || newer(entry.version, best.osVersion))) best = { runtime: entry.identifier, osVersion: entry.version };
|
||||
}
|
||||
if (!best) throw new CiError({ code: "LOCAL_SIMULATOR_RUNTIME_UNAVAILABLE", stage: "session",
|
||||
message: `No installed iOS simulator runtime runs ${device}.`,
|
||||
nextAction: "Install an iOS simulator runtime in Xcode (Settings > Components) that supports this device, then rerun." });
|
||||
return { deviceType: type.identifier, ...best };
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a fresh simulator of the configured device and starts it booting. `simctl boot` returns while the device is
|
||||
* still starting, so a capture boots it before repacking the app and waits for it (waitForLocalSimulator) afterwards.
|
||||
*/
|
||||
export async function createLocalSimulator(options: { runner: CommandRunner; device: string; name: string; cwd: string; environment: NodeJS.ProcessEnv;
|
||||
/** Called with the new device's UDID before it boots, so a caller can record it for cleanup. */
|
||||
created?: (udid: string) => void | Promise<void> }): Promise<LocalSimulator> {
|
||||
const { runner, cwd, environment } = options;
|
||||
const target = localSimulatorTarget(simctl(runner, ["list", "devicetypes", "-j"], cwd, environment).stdout,
|
||||
simctl(runner, ["list", "runtimes", "-j"], cwd, environment).stdout, options.device);
|
||||
const udid = simctl(runner, ["create", options.name, target.deviceType, target.runtime], cwd, environment).stdout.trim();
|
||||
if (!UDID.test(udid)) throw new Error("simctl create did not return a simulator UDID");
|
||||
await options.created?.(udid);
|
||||
simctl(runner, ["boot", udid], cwd, environment, 5 * 60_000);
|
||||
return { udid, name: options.name, ...target };
|
||||
}
|
||||
|
||||
/** Waits until a simulator createLocalSimulator started has finished booting. */
|
||||
export function waitForLocalSimulator(options: { runner: CommandRunner; udid: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
simctl(options.runner, ["bootstatus", options.udid, "-b"], options.cwd, options.environment, 5 * 60_000);
|
||||
}
|
||||
|
||||
/**
|
||||
* Lets the app open its own links without iOS asking "Open in “App”?" first, as a person would have approved it once.
|
||||
* EAS Simulator gives no access to the device, so its captures still answer the prompt (route-capture.ts); a local
|
||||
* simulator never shows it.
|
||||
*/
|
||||
export function approveLinkScheme(options: { runner: CommandRunner; udid: string; scheme: string; bundleId: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
if (!/^[A-Za-z][A-Za-z0-9+.-]*$/.test(options.scheme)) throw new Error("Not a URL scheme");
|
||||
simctl(options.runner, ["spawn", options.udid, "defaults", "write", "com.apple.launchservices.schemeapproval",
|
||||
`com.apple.CoreSimulator.CoreSimulatorBridge-->${options.scheme}`, "-string", options.bundleId], options.cwd, options.environment);
|
||||
}
|
||||
|
||||
/** The pixel size of a PNG, from its header. */
|
||||
function pngSize(bytes: Buffer): { width: number; height: number } | undefined {
|
||||
if (bytes.length < 24 || bytes.toString("latin1", 12, 16) !== "IHDR") return undefined;
|
||||
return { width: bytes.readUInt32BE(16), height: bytes.readUInt32BE(20) };
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a local foldable shows the pose it was folded to, by the shape of its lit display: the inner one is landscape
|
||||
* when open, the outer one portrait when closed. A half-open hinge shows either, so it is not checked.
|
||||
*/
|
||||
export async function localPoseShown(options: { runner: CommandRunner; udid: string; pose: string; directory: string; cwd: string; environment: NodeJS.ProcessEnv;
|
||||
sleep?: (milliseconds: number) => void }): Promise<boolean> {
|
||||
if (options.pose !== "open" && options.pose !== "closed") return true;
|
||||
const file = join(options.directory, "pose.png");
|
||||
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
|
||||
// The display relights and resizes over a moment after the hinge moves.
|
||||
for (let attempt = 0; attempt < 10; attempt += 1) {
|
||||
if (attempt) sleep(1_000);
|
||||
simctl(options.runner, ["io", options.udid, "screenshot", file], options.cwd, options.environment, 60_000, true);
|
||||
const size = pngSize(await readFile(file).catch(() => Buffer.alloc(0)));
|
||||
await rm(file, { force: true });
|
||||
if (size && (options.pose === "open" ? size.width > size.height : size.height > size.width)) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
export function installOnLocalSimulator(options: { runner: CommandRunner; udid: string; app: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
simctl(options.runner, ["install", options.udid, options.app], options.cwd, options.environment, 5 * 60_000);
|
||||
}
|
||||
|
||||
/** Shuts the simulator down and deletes it. Shutting down a device that is not booted fails harmlessly; only the delete counts. */
|
||||
export function deleteLocalSimulator(options: { runner: CommandRunner; udid: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
if (!UDID.test(options.udid)) throw new Error("Not a simulator UDID");
|
||||
simctl(options.runner, ["shutdown", options.udid], options.cwd, options.environment, 2 * 60_000, true);
|
||||
simctl(options.runner, ["delete", options.udid], options.cwd, options.environment, 2 * 60_000);
|
||||
}
|
||||
|
||||
/** The UDID a session state file records for a local simulator, or undefined when it names an EAS session. */
|
||||
export function localSimulatorFromState(state: string): string | undefined {
|
||||
if (!state.startsWith(LOCAL_SIMULATOR_STATE_PREFIX)) return undefined;
|
||||
const udid = state.slice(LOCAL_SIMULATOR_STATE_PREFIX.length);
|
||||
return UDID.test(udid) ? udid : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* An Android emulator Explore creates on this machine for one capture. Its AVD lives in the capture's own
|
||||
* `ANDROID_AVD_HOME`, so it never appears among the user's emulators and goes with the capture's directory.
|
||||
*/
|
||||
export type LocalEmulator = { serial: string; avd: string; avdHome: string; image: string; osVersion: string };
|
||||
|
||||
/** A session state file names a local emulator by its adb serial with this prefix. */
|
||||
export const LOCAL_EMULATOR_STATE_PREFIX = "adb-";
|
||||
|
||||
const SERIAL = /^emulator-[0-9]{4}$/;
|
||||
|
||||
/** The SDK's own tools, so a different adb or avdmanager earlier on PATH does not answer for this SDK. */
|
||||
export function androidTools(environment: NodeJS.ProcessEnv): { sdk: string; adb: string; emulator: string; avdmanager: string } {
|
||||
const sdk = environment.ANDROID_HOME || environment.ANDROID_SDK_ROOT;
|
||||
if (!sdk) throw new CiError({ code: "ANDROID_SDK_MISSING", stage: "session",
|
||||
message: "A local Android emulator needs the Android SDK, and neither ANDROID_HOME nor ANDROID_SDK_ROOT is set.",
|
||||
nextAction: "Install the SDK's platform-tools, emulator, cmdline-tools and a system image with sdkmanager, export ANDROID_HOME, and rerun." });
|
||||
return { sdk, adb: join(sdk, "platform-tools", "adb"), emulator: join(sdk, "emulator", "emulator"), avdmanager: join(sdk, "cmdline-tools", "latest", "bin", "avdmanager") };
|
||||
}
|
||||
|
||||
/** The ABI an emulator runs natively on this machine: Apple silicon runs arm64 images; x86_64 images need an Intel host. */
|
||||
export function hostEmulatorAbi(arch: string = process.arch): string {
|
||||
return arch === "arm64" ? "arm64-v8a" : "x86_64";
|
||||
}
|
||||
|
||||
/** The newest installed Google APIs system image for this machine's ABI, as `system-images;android-35;google_apis;arm64-v8a`. */
|
||||
export async function localSystemImage(sdk: string, abi: string): Promise<{ image: string; apiLevel: number }> {
|
||||
let best: { image: string; apiLevel: number } | undefined;
|
||||
const platforms = await readdir(join(sdk, "system-images")).catch(() => [] as string[]);
|
||||
for (const platform of platforms) {
|
||||
const apiLevel = Number(/^android-(\d+)$/.exec(platform)?.[1]);
|
||||
if (!Number.isInteger(apiLevel)) continue;
|
||||
for (const tag of ["google_apis_playstore", "google_apis"]) {
|
||||
if (!existsSync(join(sdk, "system-images", platform, tag, abi, "system.img"))) continue;
|
||||
if (!best || apiLevel > best.apiLevel) best = { image: `system-images;${platform};${tag};${abi}`, apiLevel };
|
||||
}
|
||||
}
|
||||
if (!best) throw new CiError({ code: "LOCAL_EMULATOR_IMAGE_UNAVAILABLE", stage: "session",
|
||||
message: `The Android SDK at ${sdk} has no Google APIs system image for ${abi}.`,
|
||||
nextAction: `Install one, for example: sdkmanager "system-images;android-35;google_apis;${abi}", then rerun.` });
|
||||
return best;
|
||||
}
|
||||
|
||||
/** Refuses an APK whose native libraries cannot load on this machine's emulator, before an emulator is started for it. */
|
||||
export async function assertLocalEmulatorCompatible(apk: string, abi: string): Promise<void> {
|
||||
const abis = await apkAbis(apk);
|
||||
if (abis.length && !abis.includes(abi)) throw new CiError({ code: "LOCAL_EMULATOR_ABI_UNSUPPORTED", stage: "session",
|
||||
message: `The APK ships native libraries only for ${abis.join(", ")}; this machine's emulator runs ${abi}.`,
|
||||
nextAction: `Build an APK that includes ${abi} (a universal build does), or capture Android on EAS Simulator with --simulator eas.` });
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an AVD of the configured device profile (such as pixel_7) and starts it without a window. It boots in the
|
||||
* background while a capture repacks the app; waitForLocalEmulator waits for it afterwards.
|
||||
*/
|
||||
export async function startLocalEmulator(options: { runner: CommandRunner; device: string; name: string; directory: string; cwd: string; environment: NodeJS.ProcessEnv;
|
||||
/** Called with the emulator's adb serial once it is starting, so a caller can record it for cleanup. */
|
||||
started?: (serial: string) => void | Promise<void>;
|
||||
/** Whether the controller still holds a serial (a claim an interrupted run left behind); such a port is skipped. */
|
||||
claimed?: (serial: string) => boolean }): Promise<Omit<LocalEmulator, "osVersion"> & { apiLevel: number }> {
|
||||
const { runner, cwd } = options;
|
||||
const tools = androidTools(options.environment);
|
||||
const avdHome = join(options.directory, "avd");
|
||||
await mkdir(avdHome, { recursive: true });
|
||||
const environment = { ...options.environment, ANDROID_AVD_HOME: avdHome };
|
||||
const { image, apiLevel } = await localSystemImage(tools.sdk, hostEmulatorAbi());
|
||||
const created = runner({ command: tools.avdmanager, args: ["create", "avd", "--name", options.name, "--package", image, "--device", options.device, "--force"],
|
||||
cwd, environment: { ...environment, ANDROID_SDK_ROOT: tools.sdk }, timeoutMs: 2 * 60_000, allowFailure: true });
|
||||
if (!existsSync(join(avdHome, `${options.name}.avd`))) throw new CiError({ code: "LOCAL_EMULATOR_DEVICE_UNAVAILABLE", stage: "session",
|
||||
message: `avdmanager could not create an ${options.device} emulator: ${(created.stderr || created.stdout).trim().split("\n").at(-1) ?? "no output"}`,
|
||||
nextAction: "Set device.name to a device profile listed by avdmanager list device -c (such as pixel_7), then rerun." });
|
||||
// Emulators listen on even console ports from 5554; this one takes the first that adb does not list and no other capture
|
||||
// has reserved, since several start at once.
|
||||
const listed = runner({ command: tools.adb, args: ["devices"], cwd, environment, timeoutMs: 30_000 }).stdout;
|
||||
let port = 5554;
|
||||
while (listed.includes(`emulator-${port}`) || listed.includes(`emulator-${port + 1}`) || options.claimed?.(`emulator-${port}`) || !await reservePort(port, options.environment)) {
|
||||
port += 2;
|
||||
if (port > 5682) throw new CiError({ code: "LOCAL_EMULATOR_PORT_UNAVAILABLE", stage: "session", message: "Every emulator console port (5554-5682) is in use.",
|
||||
nextAction: "Stop some running emulators (adb devices lists them), then rerun." });
|
||||
}
|
||||
const serial = `emulator-${port}`;
|
||||
// The emulator runs until the capture kills it; the shell returns as soon as it is started.
|
||||
// gRPC (with a token) makes the emulator publish itself in avd/running, where Argent's device server finds it.
|
||||
runner({ command: "/bin/sh", args: ["-c", 'nohup "$0" "$@" > "$EXPLORE_EMULATOR_LOG" 2>&1 &', tools.emulator, "-avd", options.name, "-port", String(port),
|
||||
"-grpc", String(port + 3000), "-grpc-use-token", "-no-window", "-no-audio", "-no-boot-anim", "-no-snapshot", "-gpu", "swiftshader_indirect"],
|
||||
cwd, environment: { ...environment, EXPLORE_EMULATOR_LOG: join(options.directory, "emulator.log") }, timeoutMs: 30_000 });
|
||||
await options.started?.(serial);
|
||||
return { serial, avd: options.name, avdHome, image, apiLevel };
|
||||
}
|
||||
|
||||
/** Waits until an emulator startLocalEmulator started has booted, and reads its Android version. */
|
||||
export function waitForLocalEmulator(options: { runner: CommandRunner; serial: string; device: string; apiLevel: number; directory: string; cwd: string;
|
||||
environment: NodeJS.ProcessEnv; now?: () => number; sleep?: (milliseconds: number) => void }): string {
|
||||
const { runner, serial, cwd } = options;
|
||||
const tools = androidTools(options.environment);
|
||||
const environment = { ...options.environment, ANDROID_AVD_HOME: join(options.directory, "avd") };
|
||||
const now = options.now ?? Date.now;
|
||||
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
|
||||
runner({ command: tools.adb, args: ["-s", serial, "wait-for-device"], cwd, environment, timeoutMs: 5 * 60_000 });
|
||||
const deadline = now() + 5 * 60_000;
|
||||
while (runner({ command: tools.adb, args: ["-s", serial, "shell", "getprop", "sys.boot_completed"], cwd, environment, timeoutMs: 30_000, allowFailure: true }).stdout.trim() !== "1") {
|
||||
if (now() > deadline) throw new CiError({ code: "LOCAL_EMULATOR_BOOT_TIMEOUT", stage: "session",
|
||||
message: `The ${options.device} emulator did not finish booting in 5 minutes.`, nextAction: `Inspect ${join(options.directory, "emulator.log")} and rerun.` });
|
||||
sleep(2_000);
|
||||
}
|
||||
return runner({ command: tools.adb, args: ["-s", serial, "shell", "getprop", "ro.build.version.release"], cwd, environment, timeoutMs: 30_000 }).stdout.trim() || String(options.apiLevel);
|
||||
}
|
||||
|
||||
export function installOnLocalEmulator(options: { runner: CommandRunner; serial: string; apk: string; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
const { adb } = androidTools(options.environment);
|
||||
options.runner({ command: adb, args: ["-s", options.serial, "install", "-r", options.apk], cwd: options.cwd, environment: options.environment, timeoutMs: 5 * 60_000 });
|
||||
}
|
||||
|
||||
/**
|
||||
* Where captures reserve emulator console ports: a directory of this user's Explore cache, not the machine's temporary
|
||||
* directory, which on Linux is shared with other users who could plant a lock (or a symlink in its place).
|
||||
*/
|
||||
export function emulatorPortsDirectory(environment: NodeJS.ProcessEnv): string {
|
||||
return join(exploreCacheRoot(environment), "emulator-ports");
|
||||
}
|
||||
|
||||
/** The reservation of one console port; it names the process holding it. */
|
||||
function portLock(port: number, environment: NodeJS.ProcessEnv): string {
|
||||
return join(emulatorPortsDirectory(environment), `${port}.lock`);
|
||||
}
|
||||
|
||||
/** Whether a process this user can see is running; a pid that is not a positive integer names none. */
|
||||
function processAlive(pid: number): boolean {
|
||||
if (!Number.isInteger(pid) || pid <= 0) return false;
|
||||
try { process.kill(pid, 0); return true; } catch (error) { return (error as NodeJS.ErrnoException).code === "EPERM"; }
|
||||
}
|
||||
|
||||
/**
|
||||
* Reserves a console port for this process; a reservation whose process has exited is taken over. Head and base start
|
||||
* their emulators at once on worker threads of one process, and other reviews may too: each reservation runs alone,
|
||||
* under a mutex directory, since taking over a stale lock is a read, a removal and a write that two captures would
|
||||
* otherwise both complete. The mutex names its holder; one left by a process that died holding it is broken by a
|
||||
* single capture at a time (a breaker directory), which checks again that it is still the dead holder's.
|
||||
*/
|
||||
export async function reservePort(port: number, environment: NodeJS.ProcessEnv): Promise<boolean> {
|
||||
const directory = emulatorPortsDirectory(environment);
|
||||
await mkdir(directory, { recursive: true, mode: 0o700 });
|
||||
const mutex = join(directory, "mutex"), breaker = join(directory, "mutex-breaker");
|
||||
// A holder writes its pid right after creating the mutex; a mutex without one is a holder between the two, unless old.
|
||||
const abandoned = async (path: string) => {
|
||||
const info = await stat(path).catch(() => undefined);
|
||||
if (!info) return false;
|
||||
const owner = await readFile(join(path, "owner"), "utf8").catch(() => undefined);
|
||||
return owner === undefined ? Date.now() - info.mtimeMs > 10_000 : !processAlive(Number(owner));
|
||||
};
|
||||
for (;;) {
|
||||
try { await mkdir(mutex); await writeFile(join(mutex, "owner"), String(process.pid)); break; }
|
||||
catch (error) {
|
||||
if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error;
|
||||
if (await abandoned(mutex)) {
|
||||
let breaking = false;
|
||||
try { await mkdir(breaker); breaking = true; }
|
||||
catch (failure) { if ((failure as NodeJS.ErrnoException).code !== "EEXIST") throw failure; if (await abandoned(breaker)) await rm(breaker, { recursive: true, force: true }); }
|
||||
if (breaking) {
|
||||
try { await writeFile(join(breaker, "owner"), String(process.pid)); if (await abandoned(mutex)) await rm(mutex, { recursive: true, force: true }); }
|
||||
finally { await rm(breaker, { recursive: true, force: true }); }
|
||||
continue;
|
||||
}
|
||||
}
|
||||
await new Promise(resolve => setTimeout(resolve, 20));
|
||||
}
|
||||
}
|
||||
try {
|
||||
const lock = portLock(port, environment);
|
||||
if (processAlive(Number(await readFile(lock, "utf8").catch(() => "")))) return false;
|
||||
await writeFile(lock, String(process.pid));
|
||||
return true;
|
||||
} finally {
|
||||
await rm(mutex, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
/** Stops the emulator and frees its console port; its AVD goes with the capture's directory. */
|
||||
export async function deleteLocalEmulator(options: { runner: CommandRunner; serial: string; cwd: string; environment: NodeJS.ProcessEnv }): Promise<void> {
|
||||
if (!SERIAL.test(options.serial)) throw new Error("Not an emulator serial");
|
||||
const { adb } = androidTools(options.environment);
|
||||
// An emulator that already exited (or crashed) is stopped too; only one adb still lists is not.
|
||||
options.runner({ command: adb, args: ["-s", options.serial, "emu", "kill"], cwd: options.cwd, environment: options.environment, timeoutMs: 60_000, allowFailure: true });
|
||||
const listed = (serial: string) => options.runner({ command: adb, args: ["devices"], cwd: options.cwd, environment: options.environment, timeoutMs: 30_000, allowFailure: true })
|
||||
.stdout.split("\n").some(line => line.split("\t")[0] === serial && line.includes("device"));
|
||||
for (let attempt = 0; listed(options.serial); attempt += 1) {
|
||||
if (attempt === 10) throw new Error(`${options.serial} is still running after emu kill`);
|
||||
await new Promise(resolve => setTimeout(resolve, 1_000));
|
||||
}
|
||||
// An emulator adb has lost (its console port closed, a child defunct) is not listed and ignores emu kill, yet runs on
|
||||
// with its AVD open; its process, by the AVD name and port this capture started it with, is stopped instead.
|
||||
const port = Number(options.serial.slice("emulator-".length));
|
||||
const running = () => options.runner({ command: "pgrep", args: ["-f", `qemu-system.* -avd explore-[a-z]+-[0-9a-f]{8} -port ${port} `], cwd: options.cwd,
|
||||
environment: options.environment, timeoutMs: 30_000, allowFailure: true }).stdout.split("\n").map(Number).filter(pid => Number.isInteger(pid) && pid > 0);
|
||||
for (let attempt = 0, pids = running(); pids.length > 0; attempt += 1, pids = running()) {
|
||||
if (attempt === 10) throw new Error(`${options.serial} is still running after it was signalled`);
|
||||
for (const pid of pids) try { process.kill(pid, attempt < 5 ? "SIGTERM" : "SIGKILL"); } catch { /* it has already exited */ }
|
||||
await new Promise(resolve => setTimeout(resolve, 1_000));
|
||||
}
|
||||
await rm(portLock(port, options.environment), { force: true });
|
||||
}
|
||||
|
||||
/** The adb serial a session state file records for a local emulator, or undefined when it names something else. */
|
||||
export function localEmulatorFromState(state: string): string | undefined {
|
||||
if (!state.startsWith(LOCAL_EMULATOR_STATE_PREFIX)) return undefined;
|
||||
const serial = state.slice(LOCAL_EMULATOR_STATE_PREFIX.length);
|
||||
return SERIAL.test(serial) ? serial : undefined;
|
||||
}
|
||||
|
||||
/** Argent's tool-server for one capture on this machine: where it listens, its token, and its process. */
|
||||
/** A capture's own tool-server; `environment` is the narrowed one it was started with, which stopping it uses too. */
|
||||
export type LocalArgentServer = { url: string; token: string; pid: number; cli: string; home: string; environment: NodeJS.ProcessEnv };
|
||||
|
||||
/**
|
||||
* Starts Argent's tool-server for one capture, on a free port, with a HOME of its own so captures running side by
|
||||
* side do not share its state, and waits for it to say where it listens. Its simulator server looks for devices
|
||||
* under $HOME, so that HOME links to this machine's simulators and Android settings.
|
||||
*/
|
||||
export async function startLocalArgentServer(options: { runner: CommandRunner; cli: string; directory: string; cwd: string; environment: NodeJS.ProcessEnv;
|
||||
now?: () => number; sleep?: (milliseconds: number) => void }): Promise<LocalArgentServer> {
|
||||
const home = join(options.directory, "argent-server-home"), log = join(options.directory, "argent-server.log");
|
||||
await mkdir(join(home, "Library", "Developer"), { recursive: true, mode: 0o700 });
|
||||
const realHome = options.environment.HOME || homedir();
|
||||
// Running emulators publish themselves (gRPC port and token) in TemporaryItems/avd/running.
|
||||
const running = join("Library", "Caches", "TemporaryItems", "avd");
|
||||
await mkdir(join(realHome, running), { recursive: true });
|
||||
await mkdir(join(home, "Library", "Caches", "TemporaryItems"), { recursive: true, mode: 0o700 });
|
||||
for (const path of [join("Library", "Developer", "CoreSimulator"), ".android", running]) {
|
||||
if (existsSync(join(realHome, path))) await symlink(join(realHome, path), join(home, path)).catch(error => { if (error.code !== "EEXIST") throw error; });
|
||||
}
|
||||
const environment = { ...options.environment, HOME: home, DO_NOT_TRACK: "1" };
|
||||
const started = options.runner({ command: "/bin/sh", args: ["-c", 'nohup "$0" "$1" server start --port 0 > "$EXPLORE_ARGENT_SERVER_LOG" 2>&1 & echo $!', process.execPath, options.cli],
|
||||
cwd: options.cwd, environment: { ...environment, EXPLORE_ARGENT_SERVER_LOG: log }, timeoutMs: 30_000 });
|
||||
const pid = Number(started.stdout.trim());
|
||||
const now = options.now ?? Date.now;
|
||||
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
|
||||
const deadline = now() + 60_000;
|
||||
for (;;) {
|
||||
const text = await readFile(log, "utf8").catch(() => "");
|
||||
const url = /Tools server listening on (http:\/\/127\.0\.0\.1:\d+)/.exec(text)?.[1];
|
||||
const token = /--token ([0-9a-f]+)/.exec(text)?.[1];
|
||||
if (url && token && Number.isInteger(pid) && pid > 0) return { url, token, pid, cli: options.cli, home, environment };
|
||||
if (now() > deadline) {
|
||||
if (Number.isInteger(pid) && pid > 0) stopLocalArgentServer({ pid, cli: options.cli, home, environment });
|
||||
throw new CiError({ code: "LOCAL_ARGENT_UNAVAILABLE", stage: "session", message: `Argent's tool-server did not start: ${text.trim().split("\n").at(-1) ?? "no output"}`,
|
||||
nextAction: `Inspect ${log}, then rerun.` });
|
||||
}
|
||||
sleep(500);
|
||||
}
|
||||
}
|
||||
|
||||
/** Stops the tool-server the way Argent does (its own `server stop`, which ends the server it spawned), then its process. */
|
||||
export function stopLocalArgentServer(server: Pick<LocalArgentServer, "pid" | "cli" | "home" | "environment">): void {
|
||||
// The capture's narrowed environment, as at start: never the tokens and keys in this process's own.
|
||||
spawnSync(process.execPath, [server.cli, "server", "stop"], { env: { ...server.environment, HOME: server.home }, timeout: 30_000, stdio: "ignore" });
|
||||
try { process.kill(server.pid, "SIGTERM"); } catch { /* it has already exited */ }
|
||||
}
|
||||
|
||||
/** Switches a local simulator's appearance from the host, for a controller that cannot (Argent). */
|
||||
export function setLocalSimulatorAppearance(options: { runner: CommandRunner; udid: string; scheme: "light" | "dark"; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
simctl(options.runner, ["ui", options.udid, "appearance", options.scheme], options.cwd, options.environment);
|
||||
}
|
||||
|
||||
/** Switches a local emulator's night mode from the host, for a controller that cannot (Argent). */
|
||||
export function setLocalEmulatorAppearance(options: { runner: CommandRunner; serial: string; scheme: "light" | "dark"; cwd: string; environment: NodeJS.ProcessEnv }): void {
|
||||
const { adb } = androidTools(options.environment);
|
||||
options.runner({ command: adb, args: ["-s", options.serial, "shell", "cmd", "uimode", "night", options.scheme === "dark" ? "yes" : "no"],
|
||||
cwd: options.cwd, environment: options.environment, timeoutMs: 60_000 });
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the agent-device daemon a local capture ran in its own state directory. `close` ends the session, but the
|
||||
* daemon outlives a directory removed under it; the pid it records (daemon.json) is the one to stop.
|
||||
*/
|
||||
export async function stopLocalAgentDevice(stateDirectory: string): Promise<void> {
|
||||
const info = await readFile(join(stateDirectory, "daemon.json"), "utf8").then(text => JSON.parse(text) as { pid?: unknown }, () => undefined);
|
||||
if (typeof info?.pid === "number" && Number.isInteger(info.pid) && info.pid > 0 && info.pid !== process.pid) {
|
||||
try { process.kill(info.pid, "SIGTERM"); } catch { /* it has already exited */ }
|
||||
}
|
||||
}
|
||||
+150
-21
@@ -23,10 +23,13 @@ import { createExplorationInputs } from "../config/exploration-inputs.js";
|
||||
import { isRecord, captureError, CONTROLLER_SESSION, parseJson } from "./common.js";
|
||||
import { MAX_ACCESSIBILITY_EVIDENCE_BYTES, adbDeviceOffline, remoteDaemonUnavailable, controllerData, defaultRunner, type ControllerReadRecovery, type RemoteDaemonRetry, runControllerRead, controllerCommandFailure, runControllerReadAsync, runAgentControllerCommand, wedgedControllerReadFailure, openedSimulatorDevice, alertWatchdogFailure } from "./controller.js";
|
||||
import type { ActiveSimulatorRuntime, SimulatorConnection } from "./simulator.js";
|
||||
import { androidTools } from "./local-simulator.js";
|
||||
import type { CiMapOptions, CommandResult } from "./run.js";
|
||||
|
||||
/** iOS commands name the simulator; an EAS Android session has exactly one emulator, selected by the session. */
|
||||
export function deviceArgs(runtime: Pick<ActiveSimulatorRuntime, "platform" | "deviceModel">): string[] {
|
||||
export function deviceArgs(runtime: Pick<ActiveSimulatorRuntime, "platform" | "deviceModel"> & Partial<Pick<ActiveSimulatorRuntime, "provider" | "controllerDeviceId">>): string[] {
|
||||
// A local simulator is picked by its UDID, a local emulator by its adb serial: this machine may run others of the same model.
|
||||
if (runtime.provider === "local-simulator" && runtime.controllerDeviceId) return [runtime.platform === "android" ? "--serial" : "--udid", runtime.controllerDeviceId];
|
||||
return runtime.platform === "android" ? [] : ["--device", runtime.deviceModel];
|
||||
}
|
||||
|
||||
@@ -90,12 +93,16 @@ function snapshotNodes(raw: string): Record<string, unknown>[] {
|
||||
}
|
||||
|
||||
/** The visible element each required label matched, so an image assessor can find icon-only controls. */
|
||||
export function verifiedCaptureLabels(nodes: readonly Record<string, unknown>[], requiredLabels: readonly string[]) {
|
||||
export function verifiedCaptureLabels(nodes: readonly Record<string, unknown>[], requiredLabels: readonly string[],
|
||||
/** The screen's portrait height, when the screenshot is that screen turned a quarter clockwise (an opened iPhone Duo). */
|
||||
turned?: { height: number }) {
|
||||
return requiredLabels.flatMap(value => nodes.filter(node => node.visible !== false && (node.label === value || node.identifier === value)).slice(0, 3).map(node => {
|
||||
const rect = isRecord(node.rect) && ["x", "y", "width", "height"].every(key => Number.isFinite((node.rect as Record<string, unknown>)[key]))
|
||||
? node.rect as { x: number; y: number; width: number; height: number } : undefined;
|
||||
// The bounds are given on the image's axes: turned a quarter clockwise, the portrait point (x, y) is at (H - y, x).
|
||||
const shown = rect && turned ? { x: turned.height - rect.y - rect.height, y: rect.x, width: rect.height, height: rect.width } : rect;
|
||||
return { value, matchedField: node.label === value ? "label" as const : "identifier" as const,
|
||||
...(typeof node.type === "string" ? { type: node.type } : {}), ...(rect ? { rect: { x: rect.x, y: rect.y, width: rect.width, height: rect.height } } : {}) };
|
||||
...(typeof node.type === "string" ? { type: node.type } : {}), ...(shown ? { rect: { x: shown.x, y: shown.y, width: shown.width, height: shown.height } } : {}) };
|
||||
}));
|
||||
}
|
||||
|
||||
@@ -136,7 +143,9 @@ function landing(nodes: readonly Record<string, unknown>[], route: SourceRoute,
|
||||
/** Execute source-owned targets in order. Live content never changes the source inventory. */
|
||||
export async function capturePlannedRoutes(options: {
|
||||
capture: CiMapOptions; routes: readonly SourceRoute[]; scheme: string | undefined; appName: string;
|
||||
runtime: ActiveSimulatorRuntime; connection: SimulatorConnection; environment: NodeJS.ProcessEnv;
|
||||
runtime: ActiveSimulatorRuntime;
|
||||
/** The EAS session's controller connection; a local simulator has none. */
|
||||
connection?: SimulatorConnection | undefined; environment: NodeJS.ProcessEnv;
|
||||
store: ExploreStore; map: ExploreMap;
|
||||
inventory?: readonly SourceRoute[];
|
||||
acceptedFrames?: Record<string, AgentAcceptedFrame>;
|
||||
@@ -328,7 +337,7 @@ export async function capturePlannedRoutes(options: {
|
||||
message: "The Open confirmation did not complete within its capture budget.",
|
||||
nextAction: "Inspect the controller diagnostic and verify that the pinned controller can dismiss the configured app's Open confirmation.",
|
||||
details: { controller: serializeCiError(toCiError(error, { code: "CONTROLLER_ALERT_FAILED", stage: "capture" }),
|
||||
{ secrets: [capture.expoToken, options.connection.daemonAuthToken] }) } });
|
||||
{ secrets: [capture.expoToken, ...(options.connection ? [options.connection.daemonAuthToken] : [])] }) } });
|
||||
}
|
||||
const remainingAlert = alertInspection("deep-link-confirmed");
|
||||
if (remainingAlert && (!allowExplicitSetupAlert || expectedTitles.includes(remainingAlert.message.normalize("NFC").trim()))) {
|
||||
@@ -337,7 +346,7 @@ export async function capturePlannedRoutes(options: {
|
||||
controllerApp();
|
||||
controller(["wait", "500", "--level", "full", "--json"]);
|
||||
};
|
||||
const secrets = [capture.expoToken, options.connection.daemonAuthToken, ...inputs.values, ...(capture.agent?.secretValues ?? [])];
|
||||
const secrets = [capture.expoToken, ...(options.connection ? [options.connection.daemonAuthToken] : []), ...inputs.values, ...(capture.agent?.secretValues ?? [])];
|
||||
const redact = (text: string): string => secrets.filter(Boolean).flatMap(value => [value, JSON.stringify(value).slice(1, -1), encodeURIComponent(value)])
|
||||
.sort((a, b) => b.length - a.length).reduce((result, value) => result.split(value).join("[REDACTED]"), inputs.redact(text));
|
||||
const redactValue = <T>(value: T): T => {
|
||||
@@ -521,9 +530,13 @@ export async function capturePlannedRoutes(options: {
|
||||
const height = png.readUInt32BE(20);
|
||||
runtime.orientation = width > height ? "landscape" : "portrait";
|
||||
map.run.environment.orientation = runtime.orientation;
|
||||
controllerApp();
|
||||
const raw = controller(["snapshot", "--force-full", "--level", "full", "--json"]).stdout;
|
||||
const confirmed = snapshotNodes(raw);
|
||||
// The snapshot after the screenshot names the app in front, which saves an `appstate` call per route; a
|
||||
// controller whose snapshot does not name it is asked.
|
||||
const read = controllerData(raw, "snapshot");
|
||||
if (read.appBundleId !== undefined || isRecord(read.identifiers)) assertIdentity(read, capture.bundleId, runtime.controllerDeviceId);
|
||||
else controllerApp();
|
||||
assertNoAlert({ route, nodes: confirmed });
|
||||
const verifiedLanding: "verified" | "unverified" = unattributed ? "unverified" : landing(confirmed, route, inventory);
|
||||
assertSafeScreenshot(confirmed);
|
||||
@@ -673,17 +686,39 @@ export async function capturePlannedRoutes(options: {
|
||||
rect: isRecord(node.rect) ? Object.fromEntries(Object.entries(node.rect).sort(([left], [right]) => left.localeCompare(right))) : node.rect,
|
||||
parentIndex: node.parentIndex,
|
||||
})));
|
||||
/**
|
||||
* The logical coordinate space a frame's normalized taps map into. On a panel whose native axes are portrait but
|
||||
* whose UI is landscape (an opened iPhone Duo under Argent), the screenshot is taken upright: the portrait screen
|
||||
* turned a quarter clockwise, while the accessibility tree and taps stay on the panel's portrait axes. Its root is
|
||||
* then the transpose of the frame, and a tap is turned back (see `toLogical`).
|
||||
*/
|
||||
const bounds = (frame: Candidate) => {
|
||||
const roots = frame.snapshot.nodes.filter(node => node.type === "Application" && isRecord(node.rect)
|
||||
const roots = (transposed: boolean) => frame.snapshot.nodes.filter(node => node.type === "Application" && isRecord(node.rect)
|
||||
&& node.rect.x === 0 && node.rect.y === 0 && typeof node.rect.width === "number" && typeof node.rect.height === "number"
|
||||
&& Number.isFinite(node.rect.width) && Number.isFinite(node.rect.height) && node.rect.width > 0 && node.rect.height > 0
|
||||
&& node.rect.width * frame.height === node.rect.height * frame.width);
|
||||
if (roots.length !== 1) throw captureError("AGENT_COORDINATE_BOUNDS_UNVERIFIED", "The screenshot does not identify one matching full-screen logical coordinate space.");
|
||||
&& (transposed ? node.rect.width * frame.width === node.rect.height * frame.height : node.rect.width * frame.height === node.rect.height * frame.width));
|
||||
// A square screen matches both ways; it is read upright, as before rotated frames existed.
|
||||
const upright = roots(false), turned = upright.length ? [] : roots(true);
|
||||
const matched = upright.length ? upright : turned;
|
||||
if (matched.length !== 1) throw captureError("AGENT_COORDINATE_BOUNDS_UNVERIFIED", "The screenshot does not identify one matching full-screen logical coordinate space.");
|
||||
// The official iOS screenshot is full-screen. Its default is 1x, but a proven
|
||||
// uniform pixel density must still map to XCTest points rather than raw pixels.
|
||||
const rect = roots[0]!.rect as { width: number; height: number };
|
||||
return { width: rect.width, height: rect.height };
|
||||
const rect = matched[0]!.rect as { width: number; height: number };
|
||||
return { width: rect.width, height: rect.height, transposed: turned.length === 1 };
|
||||
};
|
||||
/**
|
||||
* A normalized point (x, y) in the screenshot, in the tree's logical points. Upright, it scales by the root. Turned:
|
||||
* a portrait screen W wide and H tall, turned a quarter clockwise, is an image H wide and W tall in which the portrait
|
||||
* point (px, py) lands at (u, v) = (H - py, px); so the image point (u, v) is the portrait point (v, H - u). With
|
||||
* u = x * H and v = y * W, that is (y * W, (1 - x) * H). (A 2x3 portrait pixel at (0, 0), centre (0.5, 0.5), sits at
|
||||
* column 2 of the turned 3x2 image, centre (2.5, 0.5), which maps back to (0.5, 3 - 2.5).)
|
||||
*/
|
||||
/** The portrait screen a turned (upright landscape) frame shows, or undefined for a frame on the screen's own axes. */
|
||||
const turnedSpace = (frame: Candidate): { height: number } | undefined => {
|
||||
try { const space = bounds(frame); return space.transposed ? { height: space.height } : undefined; } catch { return undefined; }
|
||||
};
|
||||
const toLogical = (space: { width: number; height: number; transposed: boolean }, x: number, y: number): [number, number] =>
|
||||
space.transposed ? [y * space.width, (1 - x) * space.height] : [x * space.width, y * space.height];
|
||||
/**
|
||||
* agent-device's in-app back taps a navigation control and cannot leave a sheet without one.
|
||||
* Swipe such a sheet down, then require the observed destination to change.
|
||||
@@ -826,7 +861,7 @@ export async function capturePlannedRoutes(options: {
|
||||
retryable: true, details: changes });
|
||||
}
|
||||
await discard();
|
||||
await command(["press", String(action.x * oldBounds.width), String(action.y * oldBounds.height), "--level", "full", "--json"], signal);
|
||||
await command(["press", ...toLogical(oldBounds, action.x, action.y).map(String), "--level", "full", "--json"], signal);
|
||||
} finally { await discard(); await rm(previous.directory, { recursive: true, force: true }); }
|
||||
return;
|
||||
}
|
||||
@@ -862,7 +897,7 @@ export async function capturePlannedRoutes(options: {
|
||||
let assessment;
|
||||
try {
|
||||
assessment = rejectedReadiness.get(key) ?? await agent.assessCapture({ image: frame.png, route: route.route, context,
|
||||
instructions: agent.instructions, verifiedLabels: verifiedCaptureLabels(frame.snapshot.nodes, context.requiredLabels),
|
||||
instructions: agent.instructions, verifiedLabels: verifiedCaptureLabels(frame.snapshot.nodes, context.requiredLabels, turnedSpace(frame)),
|
||||
deadlineMs: deadline, signal: liveSignal(signal) });
|
||||
if (assessment.imageSha256 !== frame.imageSha256) throw new Error("Readiness assessment belongs to another frame");
|
||||
await writeFile(join(diagnostics, `${stem}.json`), JSON.stringify(redactValue({ route: route.route, context, ...assessment })), { mode: 0o600 });
|
||||
@@ -949,6 +984,52 @@ export async function capturePlannedRoutes(options: {
|
||||
* reported as the failure it is. Only steps up to the fault have run, so no later state exists.
|
||||
*/
|
||||
const transientControllerFault = (error: unknown) => adbDeviceOffline(error) || remoteDaemonUnavailable(error);
|
||||
/**
|
||||
* A controller that stopped answering on one screen (its runner wedged on an accessibility capture or a covered
|
||||
* control, or its reads stayed busy past their recovery window) fails every later read the same way. That costs the
|
||||
* step or route it happened on, not the capture: the app is stopped (from the host on a local device, which a wedged
|
||||
* runner cannot block) and started again, the read recovery starts over, and the controller must answer before the
|
||||
* next route. Each recovery is recorded in capture-diagnostics/controller-recoveries.jsonl.
|
||||
*/
|
||||
const controllerWedged = (error: unknown): boolean => {
|
||||
if (wedgedControllerReadFailure(error)) return true;
|
||||
const failure = toCiError(error);
|
||||
// An accessibility read that never completes (or never returns a whole tree) is the controller's failure, not the app's.
|
||||
return ["CONTROLLER_READ_BUSY", "RUNNER_WEDGED", "CONTROLLER_RUNNER_WEDGED", "INVALID_ACCESSIBILITY_EVIDENCE", "SETUP_SYSTEM_SURFACE_BLOCKING"].includes(failure.code)
|
||||
|| /execution watchdog|accessibility responsiveness|requires a valid viewport/.test(failure.message);
|
||||
};
|
||||
/**
|
||||
* A setup step that left another app in front (a tap that landed on a system control drawn over the app, as iPhone
|
||||
* Duo's status pill over a sheet's Done button) is recovered the same way: the app is started again.
|
||||
*/
|
||||
const appLeft = (error: unknown): boolean => toCiError(error).code === "CONTROLLER_IDENTITY_MISMATCH";
|
||||
let recoveries = 0;
|
||||
/** `next` records what the capture did once the app restarted: `setup-rerun` or `setup-incomplete` after a setup step. */
|
||||
const recoverController = (where: string, error: unknown, next?: "setup-rerun" | "setup-incomplete"): boolean => {
|
||||
const reported = serializeCiError(toCiError(error), { secrets });
|
||||
const record = (recovered: boolean) => {
|
||||
const diagnostics = join(store.root, "capture-diagnostics");
|
||||
mkdirSync(diagnostics, { recursive: true, mode: 0o700 });
|
||||
appendFileSync(join(diagnostics, "controller-recoveries.jsonl"), `${JSON.stringify({ where, code: reported.code, message: reported.message, recovered,
|
||||
...(recovered && next ? { next } : {}), at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
|
||||
};
|
||||
if (recoveries >= 3 || deadline - clock() < 60_000) { record(false); return false; }
|
||||
recoveries += 1;
|
||||
say(`${appLeft(error) ? "the app was no longer in front" : "the device controller stopped answering"} on ${where} (${reported.code}); restarting the app before going on`);
|
||||
try {
|
||||
if (runtime.provider === "local-simulator") runner(runtime.platform === "ios"
|
||||
? { command: "xcrun", args: ["simctl", "terminate", runtime.controllerDeviceId, capture.bundleId], cwd: store.root, environment: options.environment, timeoutMs: 60_000, allowFailure: true }
|
||||
: { command: androidTools(options.environment).adb, args: ["-s", runtime.controllerDeviceId, "shell", "am", "force-stop", capture.bundleId],
|
||||
cwd: store.root, environment: options.environment, timeoutMs: 60_000, allowFailure: true });
|
||||
for (const key of Object.keys(readRecovery)) delete (readRecovery as Record<string, unknown>)[key];
|
||||
readRecovery.busyAttempts = 0;
|
||||
controller(["open", capture.bundleId, "--relaunch", "--level", "full", "--json"]);
|
||||
settle();
|
||||
snapshot();
|
||||
} catch { record(false); return false; }
|
||||
record(true);
|
||||
return true;
|
||||
};
|
||||
const recoverFromControllerFault = (error: unknown): boolean => {
|
||||
if (!transientControllerFault(error) || deadline - clock() < 30_000) return false;
|
||||
const reported = serializeCiError(toCiError(error), { secrets });
|
||||
@@ -965,6 +1046,14 @@ export async function capturePlannedRoutes(options: {
|
||||
fault: reported.message, at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
|
||||
return true;
|
||||
};
|
||||
/**
|
||||
* A setup step that wedged the controller or left the app has not run, nor have the steps after it (a login, seeded
|
||||
* data, a permission), so routes opened by app link may show the wrong state. Once the app is restarted, setup runs
|
||||
* again from the start, once. When it stops the same way again, the routes go on by app link (so one covered control
|
||||
* does not fail the whole capture), and each route captured afterwards says in its outcome that setup did not complete.
|
||||
*/
|
||||
let setupRerunAfterRecovery = false;
|
||||
let setupIncomplete: string | undefined;
|
||||
for (let setupAttempt = 0; ; setupAttempt += 1) try {
|
||||
await executeCaptureSetup((capture.setup ?? []).map(action => action.action === "fill" || action.action === "type" ? { ...action, text: inputs.resolve(action.text) } : action), {
|
||||
command: args => { controllerApp(); return controller(args); },
|
||||
@@ -996,6 +1085,19 @@ export async function capturePlannedRoutes(options: {
|
||||
break;
|
||||
} catch (error) {
|
||||
if (setupAttempt === 0 && recoverFromControllerFault(error)) continue;
|
||||
// A wedged controller says nothing about the app's state: the routes the steps before it prepared are captured or
|
||||
// failed on their own. Once the controller answers again, setup runs again from the start, once.
|
||||
if ((controllerWedged(error) || appLeft(error)) && recoverController("a setup step", error, setupRerunAfterRecovery ? "setup-incomplete" : "setup-rerun")) {
|
||||
const reported = serializeCiError(toCiError(error), { secrets });
|
||||
if (!setupRerunAfterRecovery) {
|
||||
setupRerunAfterRecovery = true;
|
||||
say(`setup stopped (${reported.code}); running setup again from the start`);
|
||||
continue;
|
||||
}
|
||||
setupIncomplete = `Setup did not complete: a setup step stopped twice (${reported.code}), so this route was opened by app link without the state the remaining setup steps prepare.`;
|
||||
say(`setup stopped again (${reported.code}); setup did not complete, and the routes it had not reached go on by app link marked as such`);
|
||||
break;
|
||||
}
|
||||
const failure = toCiError(error, { code: "SETUP_FAILED", stage: "setup" });
|
||||
const diagnostics: Record<string, string> = {};
|
||||
const directory = join(store.root, "capture-diagnostics");
|
||||
@@ -1051,14 +1153,18 @@ export async function capturePlannedRoutes(options: {
|
||||
const linked = options.routes.filter(route => !(outcomes[route.id]?.status === "captured" && !setupFailure) && !(prepared.has(route.id) && outcomes[route.id]?.status !== "captured"));
|
||||
let opened = 0;
|
||||
/**
|
||||
* Opens the app's root link and lets it settle, so the route link that follows starts from the
|
||||
* app's home rather than from the sheet, modal or list the previous link left on screen. The
|
||||
* OS may ask to confirm the root link too; that confirmation is answered here so the route's
|
||||
* own poll never mistakes it for its own.
|
||||
* Opens the app's root link, so the route link that follows starts from the app's home rather than from the sheet,
|
||||
* modal or list the previous link left on screen. The first attempt only opens it: the route's own readiness poll
|
||||
* checks where its link landed and answers a confirmation the OS asks for. A route that landed wrong is retried
|
||||
* after a full reset, which lets the root settle and answers the root link's own confirmation first.
|
||||
*/
|
||||
const resetToRoot = () => {
|
||||
const resetToRoot = (full: boolean) => {
|
||||
controller(["open", capture.bundleId, rootLink!, "--level", "full", "--json"]);
|
||||
// The root link closes what the last route presented; the next link waits until that has finished. A link that lands
|
||||
// while a sheet is still being dismissed can leave the app unable to present another sheet until it is relaunched
|
||||
// (seen on iOS: euxy's share link, opened right after its share sheet, never showed its own).
|
||||
settle();
|
||||
if (!full) return;
|
||||
if (snapshot().nodes.some(node => node.type === "Alert")) {
|
||||
resolveDeepLinkConfirmation();
|
||||
settle();
|
||||
@@ -1093,10 +1199,12 @@ export async function capturePlannedRoutes(options: {
|
||||
try {
|
||||
// Every route link starts from the app's home, not from what the previous link left on
|
||||
// screen; the app keeps running, since relaunching invalidates photo and translation prerequisites.
|
||||
if (rootLink && deepLink !== rootLink) resetToRoot();
|
||||
if (rootLink && deepLink !== rootLink) resetToRoot(attempt > 1);
|
||||
const opened = controller(["open", capture.bundleId, deepLink, "--level", "full", "--json"]);
|
||||
const device = openedSimulatorDevice(opened.stdout, capture.bundleId, "capture open", runtime.platform);
|
||||
if (device.deviceId !== runtime.controllerDeviceId || device.deviceModel !== runtime.deviceModel) throw captureError("CONTROLLER_IDENTITY_MISMATCH", "The controller changed the selected device.");
|
||||
// A local simulator is named for Explore and recorded as the model it was created as; its UDID identifies it.
|
||||
if (device.deviceId !== runtime.controllerDeviceId
|
||||
|| (runtime.provider !== "local-simulator" && device.deviceModel !== runtime.deviceModel)) throw captureError("CONTROLLER_IDENTITY_MISMATCH", "The controller changed the selected device.");
|
||||
// The open response already proved the controller's device and app; the capture asserts the
|
||||
// session again after its screenshot, and resolves a link confirmation only if the snapshot calls for it.
|
||||
readiness = { startedAt: clock(), budgetMs: readinessBudgetMs(attempt), attempt };
|
||||
@@ -1104,7 +1212,26 @@ export async function capturePlannedRoutes(options: {
|
||||
await captureCurrent(route, attempt);
|
||||
break;
|
||||
} catch (error) {
|
||||
// The emulator's adb connection dropped (a local one does once, early, under load) or the daemon was unreachable:
|
||||
// that says nothing about this route. Once the device answers again, the route opens again from the app's root.
|
||||
if (attempt === 1 && transientControllerFault(error) && deadline - clock() > 30_000) {
|
||||
let answered = true;
|
||||
try { controllerApp(); } catch { answered = false; }
|
||||
if (answered) {
|
||||
const diagnostics = join(store.root, "capture-diagnostics");
|
||||
mkdirSync(diagnostics, { recursive: true, mode: 0o700 });
|
||||
appendFileSync(join(diagnostics, "controller-retries.jsonl"), `${JSON.stringify({ command: "open", route: route.route, reason: "route-reopened-after-device-lost",
|
||||
fault: serializeCiError(toCiError(error), { secrets }).message, at: new Date(clock()).toISOString() })}\n`, { mode: 0o600 });
|
||||
continue;
|
||||
}
|
||||
}
|
||||
const failure = failedOutcome(error, attempt);
|
||||
// A wedged controller costs this route only: once its retries are spent, the next route starts on a restarted app.
|
||||
if (controllerWedged(error) && (attempt === 2 || !failure.error?.retryable)) {
|
||||
outcomes[route.id] = { ...failure, reason: "The device controller stopped answering on this screen; Explore restarted the app and went on with the next route." };
|
||||
recoverController(route.route, error);
|
||||
break;
|
||||
}
|
||||
if (failure.status === "budget-exhausted" || !failure.error?.retryable || attempt === 2) {
|
||||
outcomes[route.id] = failure;
|
||||
if (attempt === 2) await captureUnattributed(route, attempt, error);
|
||||
@@ -1112,6 +1239,8 @@ export async function capturePlannedRoutes(options: {
|
||||
}
|
||||
}
|
||||
}
|
||||
const outcome = outcomes[route.id];
|
||||
if (setupIncomplete && outcome?.status === "captured") outcomes[route.id] = { ...outcome, reason: outcome.reason ? `${outcome.reason} ${setupIncomplete}` : setupIncomplete };
|
||||
reportOutcome(route, "by app link");
|
||||
}
|
||||
return outcomes;
|
||||
|
||||
+342
-95
@@ -19,11 +19,17 @@ import { type CiAgentRuntimeOptions } from "./agent/runtime.js";
|
||||
import { EAS_CLI_VERSION, CONTROLLER_SESSION, isRecord, parseJson, baseEnvironment, nonEmpty } from "./common.js";
|
||||
import { lstatIfExists, isWithin, temporaryCaptureDirectory, absoluteContractFile, readContractJson, assertNoSymlinkAncestors } from "./fs-safety.js";
|
||||
import { loadAppIcon, loadCachedAppIcon, storeAppIcon } from "./app-icon.js";
|
||||
import { defaultRunner } from "./controller.js";
|
||||
import { defaultRunner, runAgentControllerCommand } from "./controller.js";
|
||||
import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
import { assertCaptureEasProfile, assertSimulatorAvailable, fingerprintFrom, hasEasEnvironmentFetchFailure, nativeBuildFrom, existingBuild, repackProfileFrom, prepareExactSourceBuild, type RepackMode } from "./eas-build.js";
|
||||
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, controllerVersion, simulatorOsVersion, type ActiveSimulatorRuntime } from "./simulator.js";
|
||||
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, controllerVersion, simulatorOsVersion, type ActiveSimulatorRuntime, type SimulatorConnection } from "./simulator.js";
|
||||
import { argentControllerInvocation } from "./controller-invocation.js";
|
||||
import { sharedBuild } from "./shared-build.js";
|
||||
import { LOCAL_EMULATOR_STATE_PREFIX, LOCAL_SIMULATOR_STATE_PREFIX, assertLocalEmulatorCompatible, createLocalSimulator, startLocalEmulator, waitForLocalEmulator, waitForLocalSimulator, deleteLocalEmulator,
|
||||
deleteLocalSimulator, hostEmulatorAbi, installOnLocalEmulator, installOnLocalSimulator, approveLinkScheme, localPoseShown,
|
||||
setLocalEmulatorAppearance, setLocalSimulatorAppearance, startLocalArgentServer, stopLocalAgentDevice, stopLocalArgentServer, type LocalArgentServer } from "./local-simulator.js";
|
||||
import { ensureArgentToolServer } from "../shared/controller-cache.js";
|
||||
import { openLocalCaptureRecord } from "./local-registry.js";
|
||||
import { type UnattributedSetting } from "./unattributed.js";
|
||||
import { appScheme, hasConcreteRoutePath, unavailableRoute, capturePlannedRoutes, deviceArgs } from "./route-capture.js";
|
||||
|
||||
@@ -56,8 +62,12 @@ export type CiMapOptions = {
|
||||
controller?: "agent-device" | "argent";
|
||||
/** A foldable's pose (device.pose), set with the controller's `fold` before anything is captured. */
|
||||
devicePose?: DevicePose;
|
||||
/** Where the app runs: an EAS Simulator session (default), or a simulator created on this Mac for the capture. */
|
||||
simulator?: "eas" | "local";
|
||||
/** Where the route observer is bundled into the app: a hosted EAS repack job (default) or repack-app on this machine. */
|
||||
repack?: RepackMode;
|
||||
/** A folder the review's captures share builds through: targets of one platform, profile and commit build and repack once. */
|
||||
buildShare?: string;
|
||||
/** Which appearances to capture; `auto` (default) follows the app's `userInterfaceStyle`. */
|
||||
appearance?: AppearanceSetting;
|
||||
/** Whether to observe the app launch (splash screen) per appearance; `video` also keeps the recording. Defaults to `off`. */
|
||||
@@ -74,7 +84,7 @@ export type CiMapOptions = {
|
||||
signal?: AbortSignal;
|
||||
};
|
||||
export type SimulatorRuntimeMetadata = {
|
||||
provider: "eas-simulator"; controller: "agent-device" | "argent"; controllerPackageVersion: string;
|
||||
provider: "eas-simulator" | "local-simulator"; controller: "agent-device" | "argent"; controllerPackageVersion: string;
|
||||
easCliVersion: string; platform: Platform; deviceModel: string; osVersion: string; locale: string;
|
||||
orientation: "portrait" | "landscape"; colorScheme: "light" | "dark" | "system"; colorSchemes?: ColorScheme[];
|
||||
sessionLifecycle: "stopped";
|
||||
@@ -88,6 +98,25 @@ export type CiMapResult = {
|
||||
};
|
||||
|
||||
|
||||
function parseJsonOrUndefined(text: string): unknown {
|
||||
try { return JSON.parse(text); } catch { return undefined; }
|
||||
}
|
||||
|
||||
/**
|
||||
* Minutes an EAS session is asked for beyond the capture's own budget. The session starts beside the repack, and the
|
||||
* capture deadline only starts once the app is installed, so the session also has to outlast a slow or queued hosted
|
||||
* repack, the app's upload and its install; 20 minutes covers a typical repack with room for a queue.
|
||||
*/
|
||||
const SESSION_PREPARATION_MINUTES = 20;
|
||||
/**
|
||||
* EAS refuses (before allocating anything) a session longer than the plan allows, naming that maximum. Only that exact
|
||||
* rejection is recognized; any other start failure is kept as it is.
|
||||
*/
|
||||
function sessionDurationLimit(error: unknown): number | undefined {
|
||||
const match = /max duration must not exceed (\d+(?:\.\d+)?) minutes/i.exec(error instanceof Error ? error.message : String(error));
|
||||
return match ? Math.floor(Number(match[1])) : undefined;
|
||||
}
|
||||
|
||||
function positiveInteger(value: number, name: string): number {
|
||||
if (!Number.isInteger(value) || value <= 0) {
|
||||
throw new Error(`${name} must be a positive integer`);
|
||||
@@ -169,6 +198,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const runner = options.runner ?? defaultRunner;
|
||||
const sourceEnvironment = options.environment ?? process.env;
|
||||
const controller = options.controller ?? "agent-device";
|
||||
const local = options.simulator === "local";
|
||||
const restrictedEnvironment = baseEnvironment(sourceEnvironment);
|
||||
const easEnvironment = { ...restrictedEnvironment, ...(options.expoToken ? { EXPO_TOKEN: options.expoToken } : {}) };
|
||||
const assertCheckout = () => {
|
||||
@@ -285,7 +315,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
app = { name: cachedBundle.appName ?? options.name };
|
||||
appIcon = await loadCachedAppIcon(cacheRoot, cachedBundle.appIcon);
|
||||
const cachedProfile = cachedBundle.runtimeProfile!;
|
||||
runtime = { provider: "eas-simulator", controller, controllerPackageVersion: controllerVersion(controller),
|
||||
runtime = { provider: local ? "local-simulator" : "eas-simulator", controller, controllerPackageVersion: controllerVersion(controller),
|
||||
easCliVersion: EAS_CLI_VERSION, platform: options.platform, controllerDeviceId: cachedDeviceId ?? "cached",
|
||||
deviceModel: cachedProfile.deviceModel, osVersion: cachedProfile.osVersion, locale: cachedProfile.locale,
|
||||
orientation: cachedProfile.orientation === "landscape" ? "landscape" : "portrait",
|
||||
@@ -311,7 +341,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const errors = await validateMap(map, store);
|
||||
if (errors.length) throw new Error(`Captured map failed validation: ${errors.join("; ")}`);
|
||||
await store.exportTo(outputDirectory, map);
|
||||
for (const name of ["setup-accessibility.json", "setup-screen.png", "agent-navigation.jsonl", "alert-inspection.jsonl", "accessibility-deferral.jsonl", "system-prompts.jsonl", "controller-retries.jsonl"]) {
|
||||
for (const name of ["setup-accessibility.json", "setup-screen.png", "agent-navigation.jsonl", "alert-inspection.jsonl", "accessibility-deferral.jsonl", "system-prompts.jsonl", "controller-retries.jsonl", "controller-recoveries.jsonl"]) {
|
||||
const source = join(mapDirectory, "capture-diagnostics", name);
|
||||
if (!(await lstatIfExists(source))) continue;
|
||||
await assertNoSymlinkAncestors(mapDirectory, source, "setup diagnostic");
|
||||
@@ -319,6 +349,9 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
await copyFile(source, join(outputDirectory, "capture-diagnostics", name));
|
||||
}
|
||||
const images: CaptureBundle["images"] = {};
|
||||
// The build a frame came from: the repacked app's EAS build, or for a repack on this machine, which is never
|
||||
// uploaded, the native EAS build it repacked. The bundle names it too, as the review's build.
|
||||
const frameBuildId = easBuildId ?? nativeEasBuildId;
|
||||
for (const observation of map.observations) {
|
||||
// A secondary-appearance screen (`<route>@<scheme>`) exports under its route's outcome, with its own frame, or
|
||||
// under its own outcome when the primary pass lost the route and this pass captured it.
|
||||
@@ -326,13 +359,13 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const owner = (scheme && outcomes[observation.screenId]) || outcomes[routeId];
|
||||
if (!selected.has(routeId) || owner?.status !== "captured") continue;
|
||||
const artifact = map.artifacts.find(value => value.id === observation.screenshotArtifactId);
|
||||
if (!artifact || (!easBuildId && !cachedImages[observation.screenId])) continue;
|
||||
if (!artifact || (!frameBuildId && !cachedImages[observation.screenId])) continue;
|
||||
const png = await readFile(join(outputDirectory, artifact.path));
|
||||
assertDecodedPng(png, "Exported capture image");
|
||||
const expectedSha256 = scheme ? artifact.sha256 : outcomes[routeId]?.screenshotSha256;
|
||||
if (createHash("sha256").update(png).digest("hex") !== expectedSha256) throw new Error("Exported screenshot does not match the captured frame");
|
||||
images[observation.screenId] = cachedImages[observation.screenId] ?? { path: artifact.path, sha256: artifact.sha256, width: png.readUInt32BE(16), height: png.readUInt32BE(20),
|
||||
capturedAt: observation.capturedAt, sourceCommit: options.gitCommit, buildId: easBuildId! };
|
||||
capturedAt: observation.capturedAt, sourceCommit: options.gitCommit, buildId: frameBuildId! };
|
||||
}
|
||||
const metadata: SimulatorRuntimeMetadata | null = runtime ? { provider: runtime.provider, controller: runtime.controller,
|
||||
controllerPackageVersion: runtime.controllerPackageVersion, easCliVersion: runtime.easCliVersion, platform: runtime.platform,
|
||||
@@ -354,7 +387,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
}
|
||||
await rm(launchWorkDirectory, { recursive: true, force: true });
|
||||
const storedIcon = appIcon ? await storeAppIcon(outputDirectory, appIcon) : undefined;
|
||||
const bundle: CaptureBundle = { contract: "explore.bundle", side, gitCommit: options.gitCommit, easBuildId, completedAt: map.run.completedAt,
|
||||
const bundle: CaptureBundle = { contract: "explore.bundle", side, gitCommit: options.gitCommit, easBuildId: frameBuildId, completedAt: map.run.completedAt,
|
||||
easProjectId: projectId, platform: options.platform, profile: options.easProfile, appName: app.name, ...(controller === "argent" ? { controller } : {}), ...(storedIcon ? { appIcon: storedIcon } : {}),
|
||||
selectedSurfaceIds: selectedIds,
|
||||
runtimeProfile: metadata ? { deviceModel: metadata.deviceModel, osVersion: metadata.osVersion, locale: metadata.locale,
|
||||
@@ -387,7 +420,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const configValue = parseJson(configResult.stdout, "eas config") as { appConfig: Record<string, unknown>; buildProfile: Record<string, unknown> };
|
||||
scheme ??= appScheme(configValue.appConfig.scheme);
|
||||
colorSchemes = resolveColorSchemes(options.appearance ?? "auto", configValue.appConfig, options.platform);
|
||||
if (controller === "argent") {
|
||||
// Argent cannot switch the appearance itself; on a local device the host switches it (simctl, adb), so it is kept.
|
||||
if (controller === "argent" && !local) {
|
||||
const single = argentColorSchemes(colorSchemes, configValue.appConfig, options.platform);
|
||||
if (single.skipped.length) say(`Argent cannot switch appearance yet (software-mansion/argent#1509); capturing ${single.schemes[0]} only, skipped ${single.skipped.join(", ")}`);
|
||||
colorSchemes = single.schemes;
|
||||
@@ -401,45 +435,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
return finish();
|
||||
}
|
||||
assertCaptureEasProfile(configValue, options.bundleId, options.platform, { side, commit: options.gitCommit });
|
||||
assertSimulatorAvailable(eas(["simulator:availability", "--json", "--non-interactive"]).stdout);
|
||||
setStage("build");
|
||||
// Historical frames do not replace the fresh build needed for missing targets.
|
||||
easBuildId = null;
|
||||
options.signal?.throwIfAborted();
|
||||
say("computing the native fingerprint");
|
||||
const fingerprintResult = eas(["fingerprint:generate", "--platform", options.platform, "--build-profile", options.easProfile, "--json", "--non-interactive"]);
|
||||
fingerprint = fingerprintFrom(fingerprintResult.stdout);
|
||||
const reusable = options.forceFreshBuild || hasEasEnvironmentFetchFailure(configResult.stderr) || hasEasEnvironmentFetchFailure(fingerprintResult.stderr)
|
||||
? undefined : existingBuild(eas(["build:list", "--platform", options.platform, "--status", "finished", "--build-profile", options.easProfile,
|
||||
"--fingerprint-hash", fingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
|
||||
if (reusable) {
|
||||
say(`reusing EAS build ${reusable.id} (fingerprint ${fingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: reusable.id, fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
message: "The build environment cannot be reproduced for automatic capture instrumentation.",
|
||||
nextAction: "Use a simulator build profile whose required bundle environment can be pulled for local repacking; an uninstrumented build cannot verify captures." });
|
||||
if (repacked) { nativeEasBuildId = reusable.id; easBuildId = repacked; reusedEasBuild = true; }
|
||||
if (!app.version && reusable.appVersion) app.version = reusable.appVersion;
|
||||
if (!app.buildNumber && reusable.appBuildVersion) app.buildNumber = reusable.appBuildVersion;
|
||||
}
|
||||
options.signal?.throwIfAborted();
|
||||
if (!easBuildId) {
|
||||
say(options.forceFreshBuild ? "building on EAS (a fresh build was requested); waiting for it to finish"
|
||||
: `no finished simulator build has fingerprint ${fingerprint.slice(0, 12)}; building on EAS and waiting for it to finish`);
|
||||
const built = nativeBuildFrom(eas(["build", "--platform", options.platform, "--profile", options.easProfile, "--wait", "--json", "--non-interactive"], 45 * 60_000).stdout);
|
||||
nativeEasBuildId = built.id; fingerprint = built.fingerprint;
|
||||
say(`EAS build ${built.id} finished; repacking it with the route observer`);
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: built.id, fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
message: "The fresh native build cannot be instrumented with the required route observer.",
|
||||
nextAction: "Use a simulator profile with a reproducible bundle environment so both revisions can be repacked with the same observer." });
|
||||
easBuildId = repacked;
|
||||
if (!app.version && built.appVersion) app.version = built.appVersion;
|
||||
if (!app.buildNumber && built.appBuildVersion) app.buildNumber = built.appBuildVersion;
|
||||
}
|
||||
options.signal?.throwIfAborted();
|
||||
if (!local) assertSimulatorAvailable(eas(["simulator:availability", "--json", "--non-interactive"]).stdout);
|
||||
const simulatorProject = await realpath(await mkdtemp(join(tmpdir(), "expo-explore-session-")));
|
||||
const dotenvPath = join(simulatorProject, SIMULATOR_DOTENV_FILE_NAME);
|
||||
const statePath = options.sessionStatePath ? absoluteContractFile(options.sessionStatePath, "sessionStatePath") : undefined;
|
||||
@@ -447,73 +443,287 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
await writeFile(join(simulatorProject, "app.json"), JSON.stringify({ expo: { name: profile.projectIdentity.name, slug: profile.projectIdentity.slug,
|
||||
owner: profile.projectIdentity.owner, extra: { eas: { projectId } } } }), { mode: 0o600 });
|
||||
await writeFile(join(simulatorProject, "package.json"), "{}\n", { mode: 0o600 });
|
||||
const sessionName = simulatorSessionName({ mapName: options.name, mapId: options.buildId, gitCommit: options.gitCommit, easBuildId,
|
||||
// The local simulator's UDID (iOS) or emulator's adb serial (Android): what agent-device is pointed at.
|
||||
let localSimulator: string | undefined;
|
||||
let localEmulator: string | undefined;
|
||||
let localOsVersion: string | undefined;
|
||||
// Argent's tool-server on this machine, when Argent drives a local device.
|
||||
let localArgent: LocalArgentServer | undefined;
|
||||
const localDevice = () => localSimulator ?? localEmulator;
|
||||
// A local device starts booting now and finishes while the app is built and repacked; the session waits for it.
|
||||
let localEmulatorStart: Awaited<ReturnType<typeof startLocalEmulator>> | undefined;
|
||||
const localName = `Explore ${options.device} (${side} ${options.gitCommit.slice(0, 8)})`;
|
||||
// An EAS session's start, once begun (startSession): it resolves with the start command's failure, if any.
|
||||
let sessionStart: Promise<unknown> | undefined;
|
||||
const stopEarlyDevice = async () => {
|
||||
// An EAS session started beside a repack that then failed: stop the exact session its handoff names.
|
||||
if (sessionStart) {
|
||||
await sessionStart;
|
||||
const handoff = await readSimulatorDotenvHandoff(dotenvPath).catch(() => undefined);
|
||||
if (handoff?.sessionId) assertSimulatorStopped(eas(["simulator:stop", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000, simulatorProject).stdout, handoff.sessionId);
|
||||
}
|
||||
if (localSimulator) deleteLocalSimulator({ runner, udid: localSimulator, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
if (localEmulator) await deleteLocalEmulator({ runner, serial: localEmulator, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
if (statePath) await rm(statePath, { force: true });
|
||||
await rm(simulatorProject, { recursive: true, force: true });
|
||||
await localRecord?.close();
|
||||
};
|
||||
// What this side starts on this machine, so a later review cleans up after it if this process is stopped hard.
|
||||
const localRecord = local ? await openLocalCaptureRecord(sourceEnvironment, simulatorProject) : undefined;
|
||||
if (local) try {
|
||||
if (options.platform === "android") {
|
||||
say(`starting a local ${options.device} emulator`);
|
||||
localEmulatorStart = await startLocalEmulator({ runner, device: options.device, name: `explore-${side}-${options.gitCommit.slice(0, 8)}`, directory: simulatorProject,
|
||||
cwd: simulatorProject, environment: restrictedEnvironment,
|
||||
// agent-device refuses a serial an interrupted run still claims, even one it reports as stale, so that port is skipped.
|
||||
...(controller === "agent-device" ? { claimed: (serial: string) => {
|
||||
const status = runner({ command: options.agentDeviceCommand, args: ["device", "status", "--platform", "android", "--serial", serial, "--json"],
|
||||
cwd: simulatorProject, environment: restrictedEnvironment, timeoutMs: 30_000, allowFailure: true });
|
||||
const data = (parseJsonOrUndefined(status.stdout) as { data?: { claims?: unknown[]; hiddenStaleClaims?: number } } | undefined)?.data;
|
||||
return (data?.claims?.length ?? 0) + (data?.hiddenStaleClaims ?? 0) > 0;
|
||||
} } : {}),
|
||||
// Recorded as soon as it starts, so an interrupted review stops it too.
|
||||
started: async serial => {
|
||||
localEmulator = serial;
|
||||
await localRecord?.update({ serial, avd: `explore-${side}-${options.gitCommit.slice(0, 8)}` });
|
||||
if (statePath) await writeFile(statePath, `${LOCAL_EMULATOR_STATE_PREFIX}${serial}\n`, { flag: "wx", mode: 0o600 });
|
||||
} });
|
||||
} else {
|
||||
say(`starting a local ${options.device} simulator`);
|
||||
const created = await createLocalSimulator({ runner, device: options.device, name: localName, cwd: simulatorProject, environment: restrictedEnvironment,
|
||||
// Recorded before it boots, so an interrupted review deletes it too.
|
||||
created: async udid => {
|
||||
localSimulator = udid;
|
||||
await localRecord?.update({ udid });
|
||||
if (statePath) await writeFile(statePath, `${LOCAL_SIMULATOR_STATE_PREFIX}${udid}\n`, { flag: "wx", mode: 0o600 });
|
||||
} });
|
||||
localOsVersion = created.osVersion;
|
||||
}
|
||||
} catch (error) { await stopEarlyDevice().catch(() => undefined); throw error; }
|
||||
// The session is named before its app exists: an EAS session starts while the app is repacked (startSession).
|
||||
const sessionName = simulatorSessionName({ mapName: options.name, mapId: options.buildId, gitCommit: options.gitCommit, easBuildId: local ? "local" : "installed",
|
||||
runIdentity: JSON.stringify({ mapDirectory, outputDirectory, run: sourceEnvironment.GITHUB_RUN_ID, attempt: sourceEnvironment.GITHUB_RUN_ATTEMPT }) });
|
||||
/**
|
||||
* Starts the EAS Simulator session in the background, empty, once the build to repack is known (not while a native
|
||||
* build runs, which can take most of an hour of session time). The app is installed through the controller when both
|
||||
* are ready. Resolves with the start command's failure, if any; the session block verifies what EAS handed over.
|
||||
*/
|
||||
const startSession = () => {
|
||||
if (local || sessionStart) return;
|
||||
say(`starting an EAS Simulator session (${options.device}) while the app is repacked`);
|
||||
const request = (minutes: number) => ({ command: options.easCommand, args: ["simulator:start", "--name", sessionName, "--platform", options.platform, "--device", options.device,
|
||||
"--type", controller, "--package-version", controllerVersion(controller), "--public-link",
|
||||
"--max-duration-minutes", String(minutes), "--out-config-type", "dotenv", "--non-interactive"], cwd: simulatorProject, environment: easEnvironment, timeoutMs: 20 * 60_000 });
|
||||
// An injected runner (tests) answers synchronously; a real start runs beside the repack.
|
||||
const start = async (minutes: number) => options.runner ? options.runner(request(minutes)) : runAgentControllerCommand(request(minutes), options.signal ?? new AbortController().signal);
|
||||
sessionStart = writeFile(dotenvPath, SIMULATOR_DOTENV_HEADER, { flag: "wx", mode: 0o600 })
|
||||
.then(() => start(options.maxDurationMinutes + SESSION_PREPARATION_MINUTES).catch(async (error: unknown) => {
|
||||
// A plan that cannot give the allowance gets as much of it as the plan allows, and never less than the capture's own minutes.
|
||||
const limit = sessionDurationLimit(error);
|
||||
if (limit === undefined) throw error;
|
||||
say(`EAS allows ${limit}-minute sessions on this plan; starting the session again without the full repack allowance`);
|
||||
return start(Math.max(options.maxDurationMinutes, limit));
|
||||
}))
|
||||
.then(() => undefined, (error: unknown) => error);
|
||||
};
|
||||
setStage("build");
|
||||
// The instrumented app stays on this machine: a local device installs it, and an EAS session gets it through the
|
||||
// controller. It goes in this capture's own directory, or in the review's shared build folder when other targets use it.
|
||||
const appName = options.platform === "android" ? "app.apk" : "app.app";
|
||||
const appDirectory = !options.buildShare ? await realpath(await mkdtemp(join(tmpdir(), "expo-explore-app-"))) : undefined;
|
||||
let localApp: string | undefined;
|
||||
type BuiltApp = { fingerprint: string; nativeEasBuildId: string | null; easBuildId: string | null; app?: string; reused: boolean; version?: string; buildNumber?: string };
|
||||
const buildApp = async (keepApp: string): Promise<BuiltApp> => {
|
||||
options.signal?.throwIfAborted();
|
||||
say("computing the native fingerprint");
|
||||
const fingerprintResult = eas(["fingerprint:generate", "--platform", options.platform, "--build-profile", options.easProfile, "--json", "--non-interactive"]);
|
||||
const sourceFingerprint = fingerprintFrom(fingerprintResult.stdout);
|
||||
const reusable = options.forceFreshBuild || hasEasEnvironmentFetchFailure(configResult.stderr) || hasEasEnvironmentFetchFailure(fingerprintResult.stderr)
|
||||
? undefined : existingBuild(eas(["build:list", "--platform", options.platform, "--status", "finished", "--build-profile", options.easProfile,
|
||||
"--fingerprint-hash", sourceFingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
|
||||
if (reusable) {
|
||||
say(`reusing EAS build ${reusable.id} (fingerprint ${sourceFingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
|
||||
startSession();
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: reusable.id, fingerprint: sourceFingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
message: "The build environment cannot be reproduced for automatic capture instrumentation.",
|
||||
nextAction: "Use a simulator build profile whose required bundle environment can be pulled for local repacking; an uninstrumented build cannot verify captures." });
|
||||
return { fingerprint: sourceFingerprint, nativeEasBuildId: reusable.id, easBuildId: repacked.buildId, ...(repacked.app ? { app: repacked.app } : {}), reused: true,
|
||||
...(reusable.appVersion ? { version: reusable.appVersion } : {}), ...(reusable.appBuildVersion ? { buildNumber: reusable.appBuildVersion } : {}) };
|
||||
}
|
||||
options.signal?.throwIfAborted();
|
||||
say(options.forceFreshBuild ? "building on EAS (a fresh build was requested); waiting for it to finish"
|
||||
: `no finished simulator build has fingerprint ${sourceFingerprint.slice(0, 12)}; building on EAS and waiting for it to finish`);
|
||||
const built = nativeBuildFrom(eas(["build", "--platform", options.platform, "--profile", options.easProfile, "--wait", "--json", "--non-interactive"], 45 * 60_000).stdout);
|
||||
say(`EAS build ${built.id} finished; repacking it with the route observer`);
|
||||
startSession();
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: built.id, fingerprint: built.fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
message: "The fresh native build cannot be instrumented with the required route observer.",
|
||||
nextAction: "Use a simulator profile with a reproducible bundle environment so both revisions can be repacked with the same observer." });
|
||||
return { fingerprint: built.fingerprint, nativeEasBuildId: built.id, easBuildId: repacked.buildId, ...(repacked.app ? { app: repacked.app } : {}), reused: false,
|
||||
...(built.appVersion ? { version: built.appVersion } : {}), ...(built.appBuildVersion ? { buildNumber: built.appBuildVersion } : {}) };
|
||||
};
|
||||
try {
|
||||
// Historical frames do not replace the fresh build needed for missing targets.
|
||||
easBuildId = null;
|
||||
const built = options.buildShare
|
||||
? await sharedBuild({ directory: options.buildShare, appName, ...(options.signal ? { signal: options.signal } : {}), build: buildApp, owner: options.outputDirectory,
|
||||
key: { platform: options.platform, easProfile: options.easProfile, bundleId: options.bundleId, gitCommit: options.gitCommit, repack: options.repack ?? "eas", local,
|
||||
routes: inventory.map(route => route.id) },
|
||||
waiting: () => say("using the build another target of this review is preparing for this commit") })
|
||||
: await buildApp(join(appDirectory!, appName));
|
||||
// A capture that used another target's build starts its session now.
|
||||
startSession();
|
||||
fingerprint = built.fingerprint; nativeEasBuildId = built.nativeEasBuildId; easBuildId = built.easBuildId; localApp = built.app; reusedEasBuild = built.reused;
|
||||
if (!app.version && built.version) app.version = built.version;
|
||||
if (!app.buildNumber && built.buildNumber) app.buildNumber = built.buildNumber;
|
||||
options.signal?.throwIfAborted();
|
||||
} catch (error) {
|
||||
// A build or repack that fails leaves nothing running: a device started for it goes, with the session's files and the app.
|
||||
await stopEarlyDevice().catch(() => undefined);
|
||||
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
|
||||
throw error;
|
||||
}
|
||||
let primaryError: unknown;
|
||||
let runtimeStage = "session";
|
||||
try {
|
||||
setStage(runtimeStage);
|
||||
say(`starting an EAS Simulator session (${options.device}) with build ${easBuildId}`);
|
||||
await writeFile(dotenvPath, SIMULATOR_DOTENV_HEADER, { flag: "wx", mode: 0o600 });
|
||||
let startError: unknown;
|
||||
try { eas(["simulator:start", "--name", sessionName, "--platform", options.platform, "--device", options.device,
|
||||
"--type", controller, "--package-version", controllerVersion(controller), "--build-id", easBuildId, "--public-link",
|
||||
"--max-duration-minutes", String(options.maxDurationMinutes), "--out-config-type", "dotenv", "--non-interactive"], 20 * 60_000, simulatorProject); }
|
||||
catch (error) { startError = error; }
|
||||
const handoff = await readSimulatorDotenvHandoff(dotenvPath);
|
||||
const startSecrets = [options.expoToken, ...(handoff.connection ? [handoff.connection.daemonAuthToken] : [])];
|
||||
const startFailure = startError ? simulatorStartFailure(startError, startSecrets) : undefined;
|
||||
if (handoff.sessionId) {
|
||||
try { assertSimulatorSessionIdentity(eas(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
|
||||
handoff.sessionId, sessionName, profile.projectIdentity, handoff.connection, options.platform); }
|
||||
catch (error) { throw new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session",
|
||||
message: "The EAS handoff could not prove ownership of the exact simulator session. The private handoff was preserved.",
|
||||
nextAction: "Inspect the EAS session logs and preserved handoff; confirm ownership before cleaning up the reported session.",
|
||||
details: { handoffDirectory: simulatorProject, reportedSessionId: handoff.sessionId,
|
||||
...(startFailure ? { startFailure } : {}), verificationFailure: simulatorStartFailure(error, startSecrets) }, cause: error }); }
|
||||
sessionId = handoff.sessionId;
|
||||
if (statePath) await writeFile(statePath, `${sessionId}\n`, { flag: "wx", mode: 0o600 });
|
||||
let connection: SimulatorConnection | undefined;
|
||||
if (localApp && localEmulator && localEmulatorStart) {
|
||||
await assertLocalEmulatorCompatible(localApp, hostEmulatorAbi());
|
||||
localOsVersion = waitForLocalEmulator({ runner, serial: localEmulator, device: options.device, apiLevel: localEmulatorStart.apiLevel, directory: simulatorProject,
|
||||
cwd: simulatorProject, environment: restrictedEnvironment, ...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}) });
|
||||
say(`installing the app on ${localEmulator}`);
|
||||
installOnLocalEmulator({ runner, serial: localEmulator, apk: localApp, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
} else if (localApp && localSimulator) {
|
||||
waitForLocalSimulator({ runner, udid: localSimulator, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
if (scheme) approveLinkScheme({ runner, udid: localSimulator, scheme, bundleId: options.bundleId, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
say(`installing the app on ${localName}`);
|
||||
installOnLocalSimulator({ runner, udid: localSimulator, app: localApp, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
} else if (local) {
|
||||
throw new Error("The local device did not start before capture");
|
||||
} else {
|
||||
if (!localApp || !sessionStart) throw new Error("An EAS Simulator session needs the instrumented app on this machine");
|
||||
const startError = await sessionStart;
|
||||
const handoff = await readSimulatorDotenvHandoff(dotenvPath);
|
||||
const startSecrets = [options.expoToken, ...(handoff.connection ? [handoff.connection.daemonAuthToken] : [])];
|
||||
const startFailure = startError ? simulatorStartFailure(startError, startSecrets) : undefined;
|
||||
if (handoff.sessionId) {
|
||||
try { assertSimulatorSessionIdentity(eas(["simulator:get", "--id", handoff.sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
|
||||
handoff.sessionId, sessionName, profile.projectIdentity, handoff.connection, options.platform); }
|
||||
catch (error) { throw new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session",
|
||||
message: "The EAS handoff could not prove ownership of the exact simulator session. The private handoff was preserved.",
|
||||
nextAction: "Inspect the EAS session logs and preserved handoff; confirm ownership before cleaning up the reported session.",
|
||||
details: { handoffDirectory: simulatorProject, reportedSessionId: handoff.sessionId,
|
||||
...(startFailure ? { startFailure } : {}), verificationFailure: simulatorStartFailure(error, startSecrets) }, cause: error }); }
|
||||
sessionId = handoff.sessionId;
|
||||
if (statePath) await writeFile(statePath, `${sessionId}\n`, { flag: "wx", mode: 0o600 });
|
||||
}
|
||||
if (!sessionId) throw new CiError({ code: startFailure ? "SIMULATOR_START_FAILED" : "SESSION_HANDOFF_UNVERIFIED", stage: "session",
|
||||
message: startFailure ? `EAS simulator:start failed before a session identity could be verified: ${startFailure.message}`
|
||||
: "EAS did not provide an exact verifiable simulator session. The private handoff was preserved.",
|
||||
nextAction: "Inspect the recorded start failure and EAS session list. Allocation status is unknown; verify a session's exact ID and ownership before cleanup.",
|
||||
details: { handoffDirectory: simulatorProject, command: "eas simulator:start", startCommandStatus: startFailure ? "failed" : "completed", allocation: "unknown",
|
||||
...(startFailure ? { startFailure } : {}),
|
||||
...(handoff.validationError ? { handoffFailure: simulatorStartFailure(handoff.validationError, startSecrets) } : {}) },
|
||||
cause: startError ?? handoff.validationError });
|
||||
if (startFailure) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session",
|
||||
message: `EAS simulator:start failed after the session identity was verified: ${startFailure.message}`,
|
||||
nextAction: "Inspect the recorded start failure; Explore will stop the exact verified session before returning this error.",
|
||||
details: { reportedSessionId: sessionId, command: "eas simulator:start", startCommandStatus: "failed", allocation: "verified", startFailure }, cause: startError });
|
||||
if (handoff.validationError) throw handoff.validationError;
|
||||
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
|
||||
connection = handoff.connection;
|
||||
await rm(dotenvPath, { force: true });
|
||||
}
|
||||
if (!sessionId) throw new CiError({ code: startFailure ? "SIMULATOR_START_FAILED" : "SESSION_HANDOFF_UNVERIFIED", stage: "session",
|
||||
message: startFailure ? `EAS simulator:start failed before a session identity could be verified: ${startFailure.message}`
|
||||
: "EAS did not provide an exact verifiable simulator session. The private handoff was preserved.",
|
||||
nextAction: "Inspect the recorded start failure and EAS session list. Allocation status is unknown; verify a session's exact ID and ownership before cleanup.",
|
||||
details: { handoffDirectory: simulatorProject, command: "eas simulator:start", startCommandStatus: startFailure ? "failed" : "completed", allocation: "unknown",
|
||||
...(startFailure ? { startFailure } : {}),
|
||||
...(handoff.validationError ? { handoffFailure: simulatorStartFailure(handoff.validationError, startSecrets) } : {}) },
|
||||
cause: startError ?? handoff.validationError });
|
||||
if (startFailure) throw new CiError({ code: "SIMULATOR_START_FAILED", stage: "session",
|
||||
message: `EAS simulator:start failed after the session identity was verified: ${startFailure.message}`,
|
||||
nextAction: "Inspect the recorded start failure; Explore will stop the exact verified session before returning this error.",
|
||||
details: { reportedSessionId: sessionId, command: "eas simulator:start", startCommandStatus: "failed", allocation: "verified", startFailure }, cause: startError });
|
||||
if (handoff.validationError) throw handoff.validationError;
|
||||
if (!handoff.connection) throw new Error("Simulator handoff is missing its controller connection");
|
||||
await rm(dotenvPath, { force: true });
|
||||
const controllerConfig = join(simulatorProject, "agent-device.json");
|
||||
await writeFile(controllerConfig, "{}\n", { flag: "wx", mode: 0o400 });
|
||||
const argent = controller === "argent"
|
||||
? await argentControllerInvocation({ directory: simulatorProject, connection: handoff.connection, platform: options.platform, environment: restrictedEnvironment, sourceEnvironment, bundleId: options.bundleId })
|
||||
if (local && controller === "argent") {
|
||||
// Argent drives a local device through a tool-server of this capture's own, pointed at that device.
|
||||
const cli = await ensureArgentToolServer({ environment: sourceEnvironment, progress: say });
|
||||
localArgent = await startLocalArgentServer({ runner, cli, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
|
||||
...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}) });
|
||||
await localRecord?.update({ argent: { pid: localArgent.pid, cli: localArgent.cli, home: localArgent.home } });
|
||||
connection = { sessionId: `local-${localDevice()}`, daemonBaseUrl: localArgent.url, daemonAuthToken: localArgent.token, controller: "argent" };
|
||||
}
|
||||
const argent = controller === "argent" && connection
|
||||
? await argentControllerInvocation({ directory: simulatorProject, connection, platform: options.platform, environment: restrictedEnvironment, sourceEnvironment, bundleId: options.bundleId,
|
||||
...(localDevice() ? { device: localDevice()! } : {}), ...(options.devicePose ? { pose: options.devicePose } : {}) })
|
||||
: undefined;
|
||||
const controllerEnvironment = argent?.environment ?? { ...restrictedEnvironment, AGENT_DEVICE_CONFIG: controllerConfig,
|
||||
AGENT_DEVICE_DAEMON_BASE_URL: handoff.connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: handoff.connection.daemonAuthToken,
|
||||
// Locally, agent-device runs its own daemon, one per capture, so head and base do not share sessions.
|
||||
...(connection ? { AGENT_DEVICE_DAEMON_BASE_URL: connection.daemonBaseUrl, AGENT_DEVICE_DAEMON_AUTH_TOKEN: connection.daemonAuthToken }
|
||||
: { AGENT_DEVICE_STATE_DIR: join(simulatorProject, "agent-device-state") }),
|
||||
AGENT_DEVICE_SESSION: CONTROLLER_SESSION, AGENT_DEVICE_SESSION_LOCK: "reject", AGENT_DEVICE_PLATFORM: options.platform };
|
||||
// Every controller call below goes to the session's controller; for Argent that is the bridge.
|
||||
const controllerCommand = argent?.command ?? options.agentDeviceCommand;
|
||||
if (!local && localApp) {
|
||||
// The session started empty while the app was repacked; the controller installs it now.
|
||||
say(`installing the app on session ${sessionId}`);
|
||||
runner({ command: controllerCommand, args: ["install", localApp, "--session", CONTROLLER_SESSION, ...deviceArgs({ platform: options.platform, deviceModel: options.device }),
|
||||
"--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
|
||||
}
|
||||
if (options.devicePose) {
|
||||
// A fold relights the other panel and resizes the window. It comes before the app is first opened or read, so the
|
||||
// controller's accessibility reader starts on the lit panel: Argent's, started on the outer panel, can stay there.
|
||||
say(`folding ${options.device} ${options.devicePose}`);
|
||||
runner({ command: controllerCommand, args: ["fold", options.devicePose, "--session", CONTROLLER_SESSION,
|
||||
...deviceArgs({ platform: options.platform, deviceModel: options.device }), "--platform", options.platform, "--json"],
|
||||
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000 });
|
||||
const target = deviceArgs({ platform: options.platform, deviceModel: options.device, ...(localDevice() ? { provider: "local-simulator" as const, controllerDeviceId: localDevice()! } : {}) });
|
||||
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 ? { allowFailure: true } : {}) });
|
||||
if (localSimulator && controller === "argent") {
|
||||
// Argent folds without a session and checks the fold against its own reader; this machine also checks the display.
|
||||
fold();
|
||||
if (!await localPoseShown({ runner, udid: localSimulator, pose: options.devicePose, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
|
||||
...(options.sleep ? { sleep: options.sleep } : {}) })) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
|
||||
message: `${options.device} did not show the ${options.devicePose} display after folding.`, nextAction: "Rerun; if it persists, check that this Xcode's simulator supports folding the device." });
|
||||
} else if (localSimulator) {
|
||||
// A local agent-device folds only inside a session, so the app opens first (its first open also builds the
|
||||
// runner). agent-device then reads the hinge back with a devicectl option Xcode 27.1 no longer has, so on this
|
||||
// machine the pose is checked by the lit display's shape instead of its answer.
|
||||
runner({ command: controllerCommand, args: ["open", options.bundleId, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
|
||||
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
|
||||
const folded = fold();
|
||||
if (!await localPoseShown({ runner, udid: localSimulator, pose: options.devicePose, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
|
||||
...(options.sleep ? { sleep: options.sleep } : {}) })) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
|
||||
message: `${options.device} did not show the ${options.devicePose} display after folding: ${(folded.stderr || folded.stdout).trim().split("\n").at(-1) ?? ""}`.trim(),
|
||||
nextAction: "Rerun; if it persists, check that this Xcode's simulator supports folding the device." });
|
||||
} else fold();
|
||||
}
|
||||
runtimeStage = "runtime";
|
||||
setStage(runtimeStage);
|
||||
runtime = collectRuntime({ ...options, agentDeviceCommand: controllerCommand }, controllerEnvironment);
|
||||
const localId = localDevice();
|
||||
const collect = () => collectRuntime({ ...options, agentDeviceCommand: controllerCommand }, controllerEnvironment, localId ? { id: localId } : undefined);
|
||||
// Argent's accessibility reader can stay on a foldable's dark outer panel after a fold and never read the app
|
||||
// (APP_NOT_READY). On this machine the capture runs that reader, so it recovers in two steps, each followed by one more
|
||||
// open: a fresh tool-server, whose reader starts on the lit panel; then, as XcodeBuildMCP#537 found for this panel,
|
||||
// SpringBoard restarted as well. The bridge's cached view of the device goes with the old server.
|
||||
for (let recovery = 0; ; recovery += 1) try { runtime = collect(); break; }
|
||||
catch (error) {
|
||||
if (!localArgent || recovery === 2 || toCiError(error).code !== "APP_NOT_READY") throw error;
|
||||
say(recovery === 0 ? "Argent did not read the app after starting it; restarting Argent's tool-server and opening the app again"
|
||||
: "Argent still did not read the app; restarting SpringBoard and Argent's tool-server and opening the app again");
|
||||
stopLocalArgentServer(localArgent);
|
||||
if (recovery === 1 && localSimulator) {
|
||||
runner({ command: "xcrun", args: ["simctl", "spawn", localSimulator, "launchctl", "kickstart", "-k", "system/com.apple.SpringBoard"],
|
||||
cwd: simulatorProject, environment: restrictedEnvironment, timeoutMs: 60_000, allowFailure: true });
|
||||
// SpringBoard takes a moment to come back before an app can be opened over it.
|
||||
(options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); }))(5_000);
|
||||
}
|
||||
localArgent = await startLocalArgentServer({ runner, cli: localArgent.cli, directory: simulatorProject, cwd: simulatorProject, environment: restrictedEnvironment,
|
||||
...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}) });
|
||||
await localRecord?.update({ argent: { pid: localArgent.pid, cli: localArgent.cli, home: localArgent.home } });
|
||||
Object.assign(controllerEnvironment, { ARGENT_TOOLS_URL: localArgent.url, ARGENT_AUTH_TOKEN: localArgent.token });
|
||||
if (connection) Object.assign(connection, { daemonBaseUrl: localArgent.url, daemonAuthToken: localArgent.token });
|
||||
await rm(join(simulatorProject, "argent-state.json"), { force: true });
|
||||
}
|
||||
runtime.colorScheme = colorSchemes[0]!;
|
||||
// The version is descriptive; a capture proceeds without it and records "unknown". Argent names it with the device;
|
||||
// agent-device's is always taken from the session, as before.
|
||||
if (runtime.osVersion === "unknown" || controller !== "argent") try {
|
||||
if (localOsVersion) runtime.osVersion = localOsVersion;
|
||||
else if (sessionId && (runtime.osVersion === "unknown" || controller !== "argent")) try {
|
||||
runtime.osVersion = await simulatorOsVersion(eas(["simulator:get", "--id", sessionId, "--json", "--non-interactive"], 2 * 60_000).stdout,
|
||||
runtime.controllerDeviceId, options.fetch ?? fetch, options.platform);
|
||||
} catch (error) {
|
||||
@@ -524,14 +734,17 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
if (colorSchemes.length > 1) { map.run.environment.colorSchemes = [...colorSchemes]; await store.write(map); }
|
||||
runtimeStage = "capture";
|
||||
setStage(runtimeStage);
|
||||
say(`simulator session ${sessionId} is ready (${runtime.deviceModel}, ${options.platform === "ios" ? "iOS" : "Android"} ${runtime.osVersion})`);
|
||||
say(`${localSimulator ? "local simulator" : localEmulator ? "local emulator" : "simulator session"} ${localDevice() ?? sessionId} is ready (${runtime.deviceModel}, ${options.platform === "ios" ? "iOS" : "Android"} ${runtime.osVersion})`);
|
||||
// Every pass sets the appearance explicitly, so a capture does not inherit whatever the simulator last used.
|
||||
const passes: CaptureBundle["outcomes"][] = [];
|
||||
const recordingTools = launchSetting === "off" ? undefined : options.recordingTools === undefined ? ffmpegRecordingTools() : options.recordingTools ?? undefined;
|
||||
for (const [index, colorScheme] of colorSchemes.entries()) {
|
||||
// Argent cannot switch the appearance yet (software-mansion/argent#1509); its single pass runs as the device starts.
|
||||
// Argent cannot switch the appearance yet (software-mansion/argent#1509): on EAS its single pass runs as the device
|
||||
// starts, and on this machine the host switches it.
|
||||
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 (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
|
||||
// relaunch starts the app in the new scheme, the same way the first pass did.
|
||||
if (launchSetting !== "off") {
|
||||
@@ -555,7 +768,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
runtime.colorScheme = colorScheme;
|
||||
if (colorSchemes.length > 1) say(`appearance ${colorScheme} (${index + 1}/${colorSchemes.length})`);
|
||||
passes.push(await capturePlannedRoutes({ capture: { ...options, agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
|
||||
connection: handoff.connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
|
||||
connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
|
||||
...(colorSchemes.length > 1 ? { appearance: { scheme: colorScheme, primary: index === 0 } } : {}) }));
|
||||
}
|
||||
runtime.colorScheme = colorSchemes[0]!;
|
||||
@@ -563,6 +776,40 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
} catch (error) { primaryError = toCiError(error, { code: `CAPTURE_${runtimeStage.toUpperCase()}_FAILED`, stage: runtimeStage,
|
||||
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." }); }
|
||||
finally {
|
||||
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
|
||||
if (localArgent) stopLocalArgentServer(localArgent);
|
||||
if (localEmulator) {
|
||||
try {
|
||||
setStage("cleanup");
|
||||
say(`stopping the local emulator ${localEmulator}`);
|
||||
runner({ command: options.agentDeviceCommand, args: ["close", "--session", CONTROLLER_SESSION, "--json"], cwd: simulatorProject,
|
||||
environment: { ...restrictedEnvironment, AGENT_DEVICE_STATE_DIR: join(simulatorProject, "agent-device-state") }, timeoutMs: 60_000, allowFailure: true });
|
||||
await stopLocalAgentDevice(join(simulatorProject, "agent-device-state"));
|
||||
await deleteLocalEmulator({ runner, serial: localEmulator, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
if (statePath) await rm(statePath, { force: true });
|
||||
// The AVD lives in the capture's directory, so it goes with it.
|
||||
await rm(simulatorProject, { recursive: true, force: true });
|
||||
} catch (error) { throw new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup",
|
||||
message: "The local emulator Explore started could not be stopped.", nextAction: `Stop it with: adb -s ${localEmulator} emu kill`,
|
||||
details: { serial: localEmulator, ...(primaryError ? { originalFailure: serializeCiError(primaryError, { secrets: [options.expoToken] }) } : {}) }, cause: error }); }
|
||||
}
|
||||
if (localSimulator) {
|
||||
try {
|
||||
setStage("cleanup");
|
||||
say(`deleting the local simulator ${localSimulator}`);
|
||||
// Its own agent-device daemon lets go of the device before it goes.
|
||||
runner({ command: options.agentDeviceCommand, args: ["close", "--session", CONTROLLER_SESSION, "--json"], cwd: simulatorProject,
|
||||
environment: { ...restrictedEnvironment, AGENT_DEVICE_STATE_DIR: join(simulatorProject, "agent-device-state") }, timeoutMs: 60_000, allowFailure: true });
|
||||
await stopLocalAgentDevice(join(simulatorProject, "agent-device-state"));
|
||||
deleteLocalSimulator({ runner, udid: localSimulator, cwd: simulatorProject, environment: restrictedEnvironment });
|
||||
if (statePath) await rm(statePath, { force: true });
|
||||
await rm(simulatorProject, { recursive: true, force: true });
|
||||
} catch (error) { throw new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup",
|
||||
message: "The local simulator Explore created could not be deleted.", nextAction: `Delete it with: xcrun simctl delete ${localSimulator}`,
|
||||
details: { udid: localSimulator, ...(primaryError ? { originalFailure: serializeCiError(primaryError, { secrets: [options.expoToken] }) } : {}) }, cause: error }); }
|
||||
}
|
||||
// Everything this side started on this machine is stopped; a cleanup that threw above leaves the record for a sweep.
|
||||
await localRecord?.close();
|
||||
if (sessionId) {
|
||||
try {
|
||||
setStage("cleanup");
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
import { createHash } from "node:crypto";
|
||||
import { existsSync } from "node:fs";
|
||||
import { mkdir, readdir, readFile, rename, writeFile } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
|
||||
|
||||
/**
|
||||
* Several targets of one review run the same commit of one platform and EAS profile: they need one build and one
|
||||
* repack, not one each. The captures run in parallel, in worker threads, so they meet in a directory: the first to
|
||||
* claim a build's folder builds it and writes the result there, and the others wait for that result (or its failure).
|
||||
*/
|
||||
export type SharedBuildKey = { platform: string; easProfile: string; bundleId: string; gitCommit: string; repack: string; local: boolean; routes: readonly string[] };
|
||||
|
||||
export function sharedBuildId(key: SharedBuildKey): string {
|
||||
return createHash("sha256").update(JSON.stringify({ ...key, routes: [...key.routes].sort() })).digest("hex").slice(0, 24);
|
||||
}
|
||||
|
||||
const POLL_MS = 2_000;
|
||||
|
||||
/**
|
||||
* Runs `build` once per key across every capture sharing `directory`; the app it leaves goes in the build's folder
|
||||
* (`keepApp`), which outlives each capture. A waiter is told so it can say whose build it uses.
|
||||
*/
|
||||
export async function sharedBuild<T extends object>(options: { directory: string; key: SharedBuildKey; appName: string; signal?: AbortSignal;
|
||||
build: (keepApp: string) => Promise<T>; waiting?: () => void;
|
||||
/** Who builds it (the capture's output directory), so a review can fail its waiters if that capture dies (abandonSharedBuilds). */
|
||||
owner?: string }): Promise<T> {
|
||||
const folder = join(options.directory, sharedBuildId(options.key));
|
||||
const result = join(folder, "result.json"), failure = join(folder, "failure.json");
|
||||
await mkdir(options.directory, { recursive: true });
|
||||
let owner = true;
|
||||
try { await mkdir(folder); } catch (error) { if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error; owner = false; }
|
||||
if (owner) {
|
||||
if (options.owner) await writeFile(join(folder, "owner"), options.owner);
|
||||
try {
|
||||
const built = await options.build(join(folder, options.appName));
|
||||
await writeFile(`${result}.tmp`, JSON.stringify(built));
|
||||
await rename(`${result}.tmp`, result);
|
||||
return built;
|
||||
} catch (error) {
|
||||
await writeFile(failure, JSON.stringify(serializeCiError(toCiError(error, { code: "CAPTURE_BUILD_FAILED", stage: "build",
|
||||
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." })))).catch(() => undefined);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
options.waiting?.();
|
||||
for (;;) {
|
||||
options.signal?.throwIfAborted();
|
||||
const done = await readFile(result, "utf8").catch(() => undefined);
|
||||
if (done !== undefined) return JSON.parse(done) as T;
|
||||
const failed = await readFile(failure, "utf8").catch(() => undefined);
|
||||
if (failed !== undefined) {
|
||||
const error = JSON.parse(failed) as { code: string; stage: string; message: string; nextAction: string };
|
||||
throw new CiError({ code: error.code, stage: error.stage, message: `The shared build failed: ${error.message}`, nextAction: error.nextAction });
|
||||
}
|
||||
await new Promise(resolve => setTimeout(resolve, POLL_MS));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fails the unfinished builds a capture owned, for one that ended without saying (a worker thread that exited before
|
||||
* its build wrote failure.json): the captures waiting on them stop instead of polling until the review is stopped.
|
||||
*/
|
||||
export async function abandonSharedBuilds(directory: string, ownedBy: (owner: string) => boolean, reason: string): Promise<void> {
|
||||
for (const folder of await readdir(directory).catch(() => [] as string[])) {
|
||||
const path = join(directory, folder);
|
||||
const owner = await readFile(join(path, "owner"), "utf8").catch(() => undefined);
|
||||
if (owner === undefined || !ownedBy(owner) || existsSync(join(path, "result.json")) || existsSync(join(path, "failure.json"))) continue;
|
||||
await writeFile(join(path, "failure.json"), JSON.stringify(serializeCiError(new CiError({ code: "CAPTURE_BUILD_FAILED", stage: "build",
|
||||
message: `the capture building it stopped (${reason})`, nextAction: "Inspect that target's failure above, correct it, and rerun Explore." }))));
|
||||
}
|
||||
}
|
||||
@@ -351,19 +351,27 @@ function remoteDaemonDomain(value: string, controller: "agent-device" | "argent"
|
||||
return url.hostname;
|
||||
}
|
||||
|
||||
export function collectRuntime(options: CiMapOptions & { platform: NonNullable<CiMapOptions["platform"]> }, environment: NodeJS.ProcessEnv): ActiveSimulatorRuntime {
|
||||
export function collectRuntime(options: CiMapOptions & { platform: NonNullable<CiMapOptions["platform"]> }, environment: NodeJS.ProcessEnv,
|
||||
/** The local simulator (UDID) or emulator (adb serial) Explore started; absent for an EAS session. */
|
||||
local?: { id: string }): ActiveSimulatorRuntime {
|
||||
const runner = options.runner ?? defaultRunner;
|
||||
const controller = options.controller ?? "agent-device";
|
||||
const version = runner({ command: options.agentDeviceCommand, args: ["--version"], cwd: options.project,
|
||||
environment: controller === "argent" ? environment : baseEnvironment(options.environment ?? process.env), timeoutMs: 30_000 }).stdout.trim();
|
||||
if (version !== controllerVersion(controller)) throw new Error(`${controller} version must be ${controllerVersion(controller)}`);
|
||||
const opened = runner({ command: options.agentDeviceCommand,
|
||||
args: ["open", options.bundleId, "--session", CONTROLLER_SESSION, ...(options.platform === "ios" ? ["--device", options.device] : []),
|
||||
args: ["open", options.bundleId, "--session", CONTROLLER_SESSION,
|
||||
...(local ? [options.platform === "ios" ? "--udid" : "--serial", local.id] : options.platform === "ios" ? ["--device", options.device] : []),
|
||||
"--platform", options.platform, "--level", "full", "--json"], cwd: options.project, environment,
|
||||
// Argent's first call can wait for a tool-server that is still starting, then relaunch the app until it is readable.
|
||||
timeoutMs: controller === "argent" ? 180_000 : 60_000 });
|
||||
// A local simulator's first open also builds agent-device's XCTest runner, once per agent-device release.
|
||||
timeoutMs: controller === "argent" ? 180_000 : local ? 15 * 60_000 : 60_000 });
|
||||
const device = openedSimulatorDevice(opened.stdout, options.bundleId, "initial app open", options.platform);
|
||||
if (options.platform === "ios" && device.deviceModel !== options.device) throw new CiError({ code: "DEVICE_MISMATCH", stage: "runtime",
|
||||
if (local && device.deviceId !== local.id) throw new CiError({ code: "DEVICE_MISMATCH", stage: "runtime",
|
||||
message: `agent-device opened ${device.deviceId} instead of the device Explore started (${local.id}).`,
|
||||
nextAction: "Rerun capture; if it happens again, check xcrun simctl list devices for leftover Explore simulators." });
|
||||
// A local simulator is named for Explore; its model is the configured device it was created as.
|
||||
if (!local && options.platform === "ios" && device.deviceModel !== options.device) throw new CiError({ code: "DEVICE_MISMATCH", stage: "runtime",
|
||||
message: `EAS opened ${device.deviceModel} instead of the configured ${options.device}.`,
|
||||
nextAction: "Select an available exact device name in config.yaml and rerun capture." });
|
||||
const data = controllerData(opened.stdout, "initial app open");
|
||||
@@ -372,8 +380,8 @@ export function collectRuntime(options: CiMapOptions & { platform: NonNullable<C
|
||||
const value = deviceData[key] ?? data[key];
|
||||
return typeof value === "string" && value.trim() ? value : "unknown";
|
||||
};
|
||||
return { provider: "eas-simulator", controller, controllerPackageVersion: controllerVersion(controller),
|
||||
easCliVersion: EAS_CLI_VERSION, platform: options.platform, controllerDeviceId: device.deviceId, deviceModel: device.deviceModel,
|
||||
return { provider: local ? "local-simulator" : "eas-simulator", controller, controllerPackageVersion: controllerVersion(controller),
|
||||
easCliVersion: EAS_CLI_VERSION, platform: options.platform, controllerDeviceId: device.deviceId, deviceModel: local ? options.device : device.deviceModel,
|
||||
osVersion: observed("osVersion"), locale: observed("locale"),
|
||||
orientation: observed("orientation") === "landscape" ? "landscape" : "portrait",
|
||||
colorScheme: observed("colorScheme") === "light" ? "light" : observed("colorScheme") === "dark" ? "dark" : "system" };
|
||||
|
||||
@@ -8,7 +8,7 @@ import { parseRuntimeExecutionContext } from "../review/runtime-adapter.js";
|
||||
import { AGENT_ACCEPTANCE_POLICY, assertAgentAcceptance, type CaptureBundle } from "../contracts/capture.js";
|
||||
import { assertDecodedPng } from "../shared/png-evidence.js";
|
||||
import { canonicalJson } from "../shared/canonical-json.js";
|
||||
import type { ExploreConfig } from "../config/explore-config.js";
|
||||
import { captureRepack, type ExploreConfig } from "../config/explore-config.js";
|
||||
import { hasVerifiedCapture } from "../capture/health.js";
|
||||
import { CAPTURE_OBSERVER_HASH } from "../capture/observer.js";
|
||||
import { ARGENT_VERSION } from "../shared/argent-version.js";
|
||||
@@ -34,7 +34,9 @@ export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?:
|
||||
...(config.mode === "agent" ? { agent: { ...config.agent, instructionsSha256, acceptancePolicy: AGENT_ACCEPTANCE_POLICY } } : {}),
|
||||
app: { platform: config.app.platform, bundleId: config.app.bundleId, easProfile: config.app.easProfile,
|
||||
...(config.app.scheme === undefined ? {} : { scheme: config.app.scheme }) },
|
||||
device: config.device, parameters: config.parameters, setup: config.setup ?? [], capture: config.capture,
|
||||
device: config.device, parameters: config.parameters, setup: config.setup ?? [],
|
||||
// The repack as it resolves, so a config that leaves it to the default keeps the recipe it had when the default was written out.
|
||||
capture: { ...config.capture, repack: captureRepack(config) },
|
||||
// agent-device recipes stay as they were; an Argent capture is keyed to the Argent release that drove it.
|
||||
...(config.capture.controller === "argent" ? { controllerVersion: ARGENT_VERSION } : {}),
|
||||
});
|
||||
|
||||
+100
-22
@@ -1,6 +1,6 @@
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { lstat, mkdir, readFile, realpath } from "node:fs/promises";
|
||||
import { lstat, mkdir, readdir, readFile, realpath } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join, sep } from "node:path";
|
||||
import { CiError, toCiError } from "../shared/ci-errors.js";
|
||||
@@ -8,9 +8,10 @@ import type { CaptureBundle } from "../contracts/capture.js";
|
||||
import type { SourceCapturePlan } from "../source/capture-plan.js";
|
||||
import type { CommandRunner } from "../capture/run.js";
|
||||
import { runBaselineCi } from "./pipeline.js";
|
||||
import { DEFAULT_EXPLORE_CONFIG_PATH, configPlatforms, readExploreConfig, readExploreInstructions, resolvePlatformConfig, withRunOverrides, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { DEFAULT_EXPLORE_CONFIG_PATH, captureRepack, configTargets, readExploreConfig, readExploreInstructions, resolveTargetConfig, withRunOverrides, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { explorationSecretNames } from "../config/exploration-inputs.js";
|
||||
import { controllerCached } from "../shared/controller-cache.js";
|
||||
import { androidTools, hostEmulatorAbi, localSimulatorTarget, localSystemImage } from "../capture/local-simulator.js";
|
||||
import { ARGENT_VERSION } from "../shared/argent-version.js";
|
||||
import { AGENT_PROVIDERS as PROVIDERS, DRAFT_INSTRUCTIONS_MARKER, EXPO_TOKENS_URL as TOKENS, appConfig, simulatorProfiles } from "../config/setup.js";
|
||||
import { captureCompatibility } from "../capture/observer.js";
|
||||
@@ -50,6 +51,10 @@ export type DoctorOptions = {
|
||||
checkModel?: boolean;
|
||||
/** `--controller`: the device controller to check, over the config's `capture.controller`. */
|
||||
controller?: string | undefined;
|
||||
/** `--simulator`: where the app runs, over the config's `capture.simulator`. */
|
||||
simulator?: string | undefined;
|
||||
/** `--repack`: where the app is repacked, over the config's `capture.repack`. */
|
||||
repack?: string | undefined;
|
||||
run?: DoctorRun;
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
nodeVersion?: string;
|
||||
@@ -153,7 +158,71 @@ function routeChecks(config: ExploreConfig, report: RouteEntryReport): DoctorChe
|
||||
return checks;
|
||||
}
|
||||
|
||||
async function easChecks(project: string, config: ExploreConfig, run: DoctorRun): Promise<DoctorCheck[]> {
|
||||
/** Every target, resolved, once per platform, EAS profile and app: targets that differ only by device or pose share these checks. */
|
||||
function resolvedTargets(config: ExploreConfig, by: (target: ExploreConfig) => string = target => `${target.app.platform}:${target.app.easProfile}:${target.app.bundleId}`): ExploreConfig[] {
|
||||
const seen = new Set<string>();
|
||||
return configTargets(config).map(target => resolveTargetConfig(config, { target: target.id })).filter(target => !seen.has(by(target)) && !!seen.add(by(target)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Every target as a capture of it runs: its own controller and simulator (else the config's), with the run's
|
||||
* --controller and --simulator over both.
|
||||
*/
|
||||
function runTargets(config: ExploreConfig, overrides: { controller?: string | undefined; simulator?: string | undefined }): ExploreConfig[] {
|
||||
return configTargets(config).map(target => withRunOverrides(resolveTargetConfig(config, { target: target.id }), overrides));
|
||||
}
|
||||
|
||||
/**
|
||||
* The targets that run on a local simulator, in place of EAS Simulator access: this Mac's Xcode can create each iOS
|
||||
* target's device, and the Android SDK can start each Android target's device profile with a system image this machine runs.
|
||||
*/
|
||||
async function localSimulatorChecks(project: string, targets: readonly ExploreConfig[], run: DoctorRun, environment: NodeJS.ProcessEnv): Promise<DoctorCheck[]> {
|
||||
const checks: DoctorCheck[] = [];
|
||||
const seen = new Set<string>();
|
||||
for (const target of targets.filter(each => !seen.has(`${each.app.platform}:${each.device.name}`) && !!seen.add(`${each.app.platform}:${each.device.name}`))) {
|
||||
const device = target.device.name;
|
||||
if (target.app.platform === "ios") {
|
||||
const types = run("xcrun", ["simctl", "list", "devicetypes", "-j"], project);
|
||||
const runtimes = run("xcrun", ["simctl", "list", "runtimes", "-j"], project);
|
||||
try {
|
||||
if (types.status !== 0 || runtimes.status !== 0) throw new Error(lastLine(types.stderr || runtimes.stderr || "xcrun simctl failed"));
|
||||
const local = localSimulatorTarget(types.stdout, runtimes.stdout, device);
|
||||
checks.push({ step: 1, id: "local-simulator", status: "pass", message: `This Mac can create an ${device} simulator (iOS ${local.osVersion}).` });
|
||||
} catch (error) {
|
||||
checks.push(fromError(1, "local-simulator", error, { code: "LOCAL_SIMULATOR_UNAVAILABLE",
|
||||
nextAction: "Install Xcode and an iOS simulator runtime for the configured device, select it with xcode-select (or DEVELOPER_DIR), then rerun doctor." }));
|
||||
}
|
||||
continue;
|
||||
}
|
||||
try {
|
||||
const tools = androidTools(environment);
|
||||
const image = await localSystemImage(tools.sdk, hostEmulatorAbi());
|
||||
const devices = run(tools.avdmanager, ["list", "device", "-c"], project);
|
||||
if (devices.status !== 0) throw new Error(lastLine(devices.stderr || devices.stdout || "avdmanager failed"));
|
||||
if (!devices.stdout.split("\n").map(line => line.trim()).includes(device)) throw new CiError({ code: "LOCAL_EMULATOR_DEVICE_UNAVAILABLE", stage: "preflight",
|
||||
message: `The Android SDK has no ${device} device profile.`, nextAction: "Set the target's device to a profile listed by avdmanager list device -c, such as pixel_7." });
|
||||
checks.push({ step: 1, id: "local-emulator", status: "pass", message: `This machine can start a ${device} emulator (${image.image.split(";").slice(1).join(" ")}).` });
|
||||
} catch (error) {
|
||||
checks.push(fromError(1, "local-emulator", error, { code: "LOCAL_EMULATOR_UNAVAILABLE",
|
||||
nextAction: "Install the Android SDK's emulator, platform-tools, cmdline-tools and a system image with sdkmanager, export ANDROID_HOME, then rerun doctor." }));
|
||||
}
|
||||
// A local simulator repacks on this machine too, unless capture.repack says eas: repack-app signs the APK with the
|
||||
// SDK's build-tools and runs apktool and apksigner with Java.
|
||||
if (captureRepack(target) === "local") {
|
||||
const java = run("java", ["-version"], project);
|
||||
let buildTools: string[] = [];
|
||||
try { buildTools = await readdir(join(androidTools(environment).sdk, "build-tools")); } catch { /* no SDK or no build-tools */ }
|
||||
checks.push(buildTools.length && java.status === 0
|
||||
? { step: 1, id: "local-repack", status: "pass", message: `This machine can repack the APK (build-tools ${buildTools.sort().at(-1)}, ${(java.stderr || java.stdout).trim().split("\n")[0] || "Java"}).` }
|
||||
: { step: 1, id: "local-repack", status: "fail", code: "LOCAL_REPACK_UNAVAILABLE",
|
||||
message: buildTools.length ? "Repacking the APK on this machine needs Java, and java -version did not run." : "Repacking the APK on this machine needs the Android SDK build-tools, and none are installed.",
|
||||
nextAction: "Install the build-tools (sdkmanager \"build-tools;35.0.0\") and a JDK 17, or set capture.repack: eas to repack in a hosted EAS job, then rerun doctor." });
|
||||
}
|
||||
}
|
||||
return checks;
|
||||
}
|
||||
|
||||
async function easChecks(project: string, config: ExploreConfig, run: DoctorRun, environment: NodeJS.ProcessEnv, simulator?: string): Promise<DoctorCheck[]> {
|
||||
let eas: string;
|
||||
try { eas = packageBin("eas-cli", "eas"); if (!await exists(eas)) throw new Error(); }
|
||||
catch { return [{ step: 1, id: "eas-cli", status: "fail", code: "EXPLORE_TOOLS_MISSING",
|
||||
@@ -172,17 +241,23 @@ async function easChecks(project: string, config: ExploreConfig, run: DoctorRun)
|
||||
? { step: 1, id: "eas-project", status: "pass", message: "The app is linked to an EAS project this account can access." }
|
||||
: { step: 1, id: "eas-project", status: "fail", code: "EAS_PROJECT_UNAVAILABLE", message: `EAS project check failed: ${lastLine(info.stderr || info.stdout)}`,
|
||||
nextAction: "Run eas init in the app directory to link it, or ask the project's owner for access. The CI EXPO_TOKEN must belong to an account with the same access." });
|
||||
const availability = run(eas, ["simulator:availability", "--json", "--non-interactive"], project);
|
||||
try {
|
||||
if (availability.status !== 0) throw new Error(lastLine(availability.stderr || availability.stdout));
|
||||
assertSimulatorAvailable(availability.stdout);
|
||||
checks.push({ step: 1, id: "eas-simulator", status: "pass", message: "EAS Simulator is available for this account." });
|
||||
} catch (error) {
|
||||
checks.push({ ...fromError(1, "eas-simulator", error, { code: "SIMULATOR_UNAVAILABLE", nextAction: "" }),
|
||||
code: "SIMULATOR_UNAVAILABLE", nextAction: `Join the EAS Simulator waitlist at ${WAITLIST} with ${account}, the account the CI EXPO_TOKEN must use. Capture cannot run until access is granted.` });
|
||||
// The targets on a local simulator need this machine's tools, and EAS Simulator access is checked when any target uses it.
|
||||
const targets = runTargets(config, { simulator });
|
||||
const local = targets.filter(target => target.capture.simulator === "local");
|
||||
if (local.length) checks.push(...await localSimulatorChecks(project, local, run, environment));
|
||||
if (local.length < targets.length) {
|
||||
const availability = run(eas, ["simulator:availability", "--json", "--non-interactive"], project);
|
||||
try {
|
||||
if (availability.status !== 0) throw new Error(lastLine(availability.stderr || availability.stdout));
|
||||
assertSimulatorAvailable(availability.stdout);
|
||||
checks.push({ step: 1, id: "eas-simulator", status: "pass", message: "EAS Simulator is available for this account." });
|
||||
} catch (error) {
|
||||
checks.push({ ...fromError(1, "eas-simulator", error, { code: "SIMULATOR_UNAVAILABLE", nextAction: "" }),
|
||||
code: "SIMULATOR_UNAVAILABLE", nextAction: `Join the EAS Simulator waitlist at ${WAITLIST} with ${account}, the account the CI EXPO_TOKEN must use. Capture cannot run until access is granted.` });
|
||||
}
|
||||
}
|
||||
const checkedEnvironments = new Set<string>();
|
||||
for (const target of configPlatforms(config).map(platform => resolvePlatformConfig(config, platform))) {
|
||||
for (const target of resolvedTargets(config)) {
|
||||
const { platform, easProfile, bundleId } = target.app;
|
||||
const resolved = run(eas, ["config", "--platform", platform, "--profile", easProfile, "--json", "--non-interactive"], project);
|
||||
if (resolved.status !== 0) {
|
||||
@@ -231,7 +306,8 @@ async function easChecks(project: string, config: ExploreConfig, run: DoctorRun)
|
||||
return checks;
|
||||
}
|
||||
|
||||
async function ciFileChecks(project: string, secretNames: readonly string[], run: DoctorRun, online: boolean, platformCount = 1): Promise<{ checks: DoctorCheck[]; root?: string }> {
|
||||
/** `named`: the config names its own targets, so only a workflow with a target matrix captures each one. */
|
||||
async function ciFileChecks(project: string, secretNames: readonly string[], run: DoctorRun, online: boolean, platformCount = 1, named = false): Promise<{ checks: DoctorCheck[]; root?: string }> {
|
||||
let layout: Awaited<ReturnType<typeof ciLayout>>;
|
||||
try { layout = await ciLayout(project); }
|
||||
catch (error) { return { checks: [fromError(6, "repository", error, { code: "NOT_A_GIT_REPOSITORY", nextAction: "Put the app in a Git repository, commit it, and rerun doctor." })] }; }
|
||||
@@ -266,8 +342,10 @@ async function ciFileChecks(project: string, secretNames: readonly string[], run
|
||||
if (drift) checks.push({ step: 6, id: `workflow-template-${name}`, status: "warn", code: "WORKFLOW_TEMPLATE_DRIFT",
|
||||
message: `${file} ${drift === "stale" ? "was generated by an older @expo/explore template" : "differs from the @expo/explore template (edited after setup, or generated by an older version)"}; steps the ${EXPLORE_VERSION} template adds (such as installing ffmpeg for launch recordings) are missing from CI.`,
|
||||
nextAction: drift === "stale" ? "Run expo-explore setup --workflows, then commit the workflows." : "Run expo-explore setup --workflows --force to regenerate it (reapply your edits), then commit the workflows." });
|
||||
if (platformCount > 1 && !text.includes("matrix.platform")) checks.push({ step: 6, id: `workflow-platforms-${name}`, status: "warn", code: "WORKFLOW_PLATFORM_MATRIX_MISSING",
|
||||
message: `${DEFAULT_EXPLORE_CONFIG_PATH} configures ${platformCount} platforms, but ${file} captures one platform (no matrix.platform).`,
|
||||
// Workflows installed before targets run one job per platform, which covers a config whose targets are its platforms.
|
||||
const matrix = text.includes("matrix.target") || (text.includes("matrix.platform") && !named);
|
||||
if (platformCount > 1 && !matrix) checks.push({ step: 6, id: `workflow-platforms-${name}`, status: "warn", code: "WORKFLOW_PLATFORM_MATRIX_MISSING",
|
||||
message: `${DEFAULT_EXPLORE_CONFIG_PATH} configures ${platformCount} targets, but ${file} does not capture each one (no matrix.target).`,
|
||||
nextAction: "Run expo-explore setup --workflows to install the matrix workflows, then commit them." });
|
||||
}
|
||||
if (online) for (const version of versions) {
|
||||
@@ -387,7 +465,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
|
||||
return { ok: false, mode: null, checks, ...(routes ? { routes } : {}) };
|
||||
}
|
||||
let config: ExploreConfig;
|
||||
try { config = withRunOverrides(await readExploreConfig(project), { controller: options.controller }); }
|
||||
try { config = withRunOverrides(await readExploreConfig(project), { controller: options.controller, simulator: options.simulator, repack: options.repack }); }
|
||||
catch (error) {
|
||||
checks.push(fromError(4, "config", error, { code: "CONFIG_INVALID", nextAction: `Correct ${DEFAULT_EXPLORE_CONFIG_PATH} and rerun doctor.` }));
|
||||
return { ok: false, mode: null, checks };
|
||||
@@ -396,7 +474,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
|
||||
checks.push(config.mode === "agent"
|
||||
? { step: 3, id: "mode", status: "pass", message: `Agent mode with ${config.agent!.provider} ${config.agent!.model}. Capture navigation uses the model and is billed to your ${config.agent!.provider} account.` }
|
||||
: { step: 3, id: "mode", status: "pass", message: "Deterministic mode: capture replays config.yaml without a model, so it needs no API key and has no AI charges." });
|
||||
if (config.capture.controller === "argent") checks.push(argentCheck(environment));
|
||||
if (runTargets(config, { controller: options.controller }).some(target => target.capture.controller === "argent")) checks.push(argentCheck(environment));
|
||||
if (config.capture.launch !== "off") {
|
||||
const ffmpeg = run("ffmpeg", ["-version"], project);
|
||||
checks.push(ffmpeg.status === 0
|
||||
@@ -407,7 +485,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
|
||||
}
|
||||
try {
|
||||
const eas = JSON.parse(await readFile(join(project, "eas.json"), "utf8")) as Record<string, unknown>;
|
||||
for (const target of configPlatforms(config).map(platform => resolvePlatformConfig(config, platform))) {
|
||||
for (const target of resolvedTargets(config)) {
|
||||
const { platform, easProfile } = target.app;
|
||||
const requirement = platform === "ios" ? "ios.simulator: true" : "android.buildType: apk";
|
||||
if (!simulatorProfiles(eas, platform).includes(easProfile)) throw new CiError({ code: platform === "ios" ? "EAS_PROFILE_NOT_SIMULATOR" : "EAS_PROFILE_NOT_APK", stage: "preflight",
|
||||
@@ -470,7 +548,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
|
||||
}
|
||||
}
|
||||
const secretNames = referencedSecretNames(config, instructions);
|
||||
const files = await ciFileChecks(project, secretNames, run, options.online !== false, configPlatforms(config).length);
|
||||
const files = await ciFileChecks(project, secretNames, run, options.online !== false, configTargets(config).length, !!config.targets);
|
||||
checks.push(...files.checks);
|
||||
if (files.root) {
|
||||
const pending = run("git", ["status", "--porcelain", "--untracked-files=all", "--", DEFAULT_EXPLORE_CONFIG_PATH, ...(config.agent?.instructions ? [config.agent.instructions] : [])], project).stdout
|
||||
@@ -480,7 +558,7 @@ export async function runDoctor(options: DoctorOptions): Promise<DoctorReport> {
|
||||
message: `Setup files are not committed: ${list(paths)}. CI reads them from the pushed repository.`,
|
||||
nextAction: "Commit them, push, and merge them into the default branch." });
|
||||
}
|
||||
if (options.online !== false) checks.push(...await easChecks(project, config, run));
|
||||
if (options.online !== false) checks.push(...await easChecks(project, config, run, environment, options.simulator));
|
||||
else checks.push({ step: 1, id: "eas", status: "skip", message: "EAS login, project, simulator access and build profile were not checked (--offline)." });
|
||||
if (options.github !== false && files.root) checks.push(...githubChecks(files.root, config, secretNames, run));
|
||||
else if (files.root) checks.push({ step: 7, id: "github", status: "skip", message: `Repository settings were not checked (${options.online === false ? "--offline" : "--no-github"}).` });
|
||||
@@ -561,7 +639,7 @@ function argentCheck(environment: NodeJS.ProcessEnv): DoctorCheck {
|
||||
nextAction: "Nothing to do unless you need dark-mode screenshots; use agent-device (the default) for those." };
|
||||
}
|
||||
|
||||
export async function runCaptureCheck(options: { project: string; output: string; platform?: ExplorePlatform; controller?: string | undefined; environment?: NodeJS.ProcessEnv; runner?: CommandRunner; progress?: Progress }): Promise<CaptureCheckResult> {
|
||||
export async function runCaptureCheck(options: { project: string; output: string; platform?: ExplorePlatform; controller?: string | undefined; simulator?: string | undefined; repack?: string | undefined; target?: string | undefined; environment?: NodeJS.ProcessEnv; runner?: CommandRunner; progress?: Progress }): Promise<CaptureCheckResult> {
|
||||
const project = await realpath(options.project);
|
||||
const git = (...args: string[]) => spawnSync("git", ["-C", project, ...args], { encoding: "utf8", timeout: 10_000 });
|
||||
const head = git("rev-parse", "HEAD");
|
||||
@@ -573,7 +651,7 @@ export async function runCaptureCheck(options: { project: string; output: string
|
||||
nextAction: "Commit your changes, including .expo-explore (a local commit is enough; nothing is pushed), then rerun. "
|
||||
+ "To keep unrelated files, run it from a clean checkout instead: git worktree add --detach ../app-capture HEAD, install the app's dependencies there, and run doctor --capture in it." });
|
||||
const commit = head.stdout.trim();
|
||||
const config = withRunOverrides(resolvePlatformConfig(await readExploreConfig(project), options.platform), { controller: options.controller });
|
||||
const config = withRunOverrides(resolveTargetConfig(await readExploreConfig(project), { platform: options.platform, target: options.target }), { controller: options.controller, simulator: options.simulator, repack: options.repack });
|
||||
// Capture keeps its working directories in the system temporary directory, outside the app.
|
||||
await mkdir(options.output, { recursive: true });
|
||||
const output = await realpath(options.output);
|
||||
|
||||
+118
-32
@@ -1,3 +1,4 @@
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { randomBytes } from "node:crypto";
|
||||
import { readFileSync } from "node:fs";
|
||||
@@ -7,17 +8,21 @@ import { join, relative, resolve } from "node:path";
|
||||
import { runCiReview } from "./pipeline.js";
|
||||
import { resolveCommit } from "./workflow-steps.js";
|
||||
import { ciLayout, installCommand, type PackageManager } from "./workflow-install.js";
|
||||
import { configPlatforms, readExploreConfig, resolvePlatformConfig, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { configPlatforms, readExploreConfig, resolveTargetConfig, configTargets, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { AGENT_PROVIDERS, defaultExploreConfig } from "../config/setup.js";
|
||||
import type { PrepareCiExplorationOptions } from "../capture/agent/exploration.js";
|
||||
import { createCiAgentSession } from "../capture/agent/session.js";
|
||||
import { createLocalCiAgentSession } from "../capture/agent/session-local.js";
|
||||
import { androidTools, localEmulatorFromState, localSimulatorFromState } from "../capture/local-simulator.js";
|
||||
import type { CommandRunner } from "../capture/run.js";
|
||||
import { isSafeBranchRef, type LocalReviewPresentation, type PullRequestSidePresentation } from "../contracts/review.js";
|
||||
import { exportCiReport, readCiReportInput } from "../report/artifact.js";
|
||||
import { reviewChangeCount, reviewDevice, type PublicCommentState } from "../report/pr-comment-body.js";
|
||||
import { zipReportDirectory } from "../report/preview-deploy.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { CiError, serializeCiError, toCiError, type CiErrorData } from "../shared/ci-errors.js";
|
||||
import { defaultRunner } from "../capture/controller.js";
|
||||
import { sweepLocalCaptures } from "../capture/local-registry.js";
|
||||
import { abandonSharedBuilds } from "../capture/shared-build.js";
|
||||
import { exploreCacheRoot } from "../shared/cache-root.js";
|
||||
import { packageBin } from "../shared/package-paths.js";
|
||||
import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
@@ -37,10 +42,18 @@ export type LocalReviewOptions = {
|
||||
/** Review the working tree even when eas.json sets cli.requireCommit. Without --head this is the default. */
|
||||
uncommitted?: boolean | undefined;
|
||||
platform?: ExplorePlatform | undefined;
|
||||
/** `--target`: capture this config.yaml target alone; with `platform`, the targets of that platform. */
|
||||
target?: string | undefined;
|
||||
/** `--parallel`: how many targets capture at once (each runs a simulator or emulator per side); all of them by default. */
|
||||
parallel?: number | undefined;
|
||||
scope?: string | undefined;
|
||||
expiresIn?: string | undefined;
|
||||
/** `--controller`: the device controller for both sides, over the config's `capture.controller`. */
|
||||
controller?: string | undefined;
|
||||
/** `--simulator`: `local` runs both sides on simulators this Mac creates, over the config's `capture.simulator`. */
|
||||
simulator?: string | undefined;
|
||||
/** `--repack`: where the app is repacked with the route observer, over the config's `capture.repack`. */
|
||||
repack?: string | undefined;
|
||||
/** Reuse and keep captures in the local capture cache (default true). */
|
||||
cache?: boolean | undefined;
|
||||
configPath?: string | undefined;
|
||||
@@ -54,10 +67,12 @@ export type LocalReviewOptions = {
|
||||
agentSessionFactory?: PrepareCiExplorationOptions["createSession"];
|
||||
};
|
||||
|
||||
export type LocalReviewReport = { platform: ExplorePlatform; directory: string; zip: string; changes?: number; device?: string };
|
||||
export type LocalReviewReport = { platform: ExplorePlatform; target: RunTarget; directory: string; zip: string; changes?: number; device?: string };
|
||||
export type LocalReviewResult = {
|
||||
runId: string; base: PullRequestSidePresentation; head: PullRequestSidePresentation & { uncommitted?: string[] };
|
||||
work: string; reports: LocalReviewReport[]; config: ExploreConfig; repository: string;
|
||||
/** Targets whose review failed outright; the others' reports are kept and opened all the same. */
|
||||
failures: { target: RunTarget; error: CiErrorData }[];
|
||||
};
|
||||
|
||||
/** Git, without the user's hooks or fsmonitor, and never with a terminal prompt. */
|
||||
@@ -175,9 +190,27 @@ export async function installDependencies(project: string, logFile: string, envi
|
||||
+ "Installs run without credential environment variables: a registry that needs ${NPM_TOKEN} in the project's .npmrc must be authenticated in your own ~/.npmrc instead." });
|
||||
}
|
||||
|
||||
/** `~/.cache/expo-explore/captures/<platform>/<sha>`: one capture per commit and platform, reused while its recipe matches. */
|
||||
export function captureCacheDirectory(environment: NodeJS.ProcessEnv, platform: ExplorePlatform, sha: string): string {
|
||||
return join(exploreCacheRoot(environment), "captures", platform, sha);
|
||||
/** Runs `task` on every item, at most `limit` at once, in order; every task settles, as Promise.allSettled does. */
|
||||
export async function settleLimited<T, R>(items: readonly T[], limit: number, task: (item: T) => Promise<R>): Promise<PromiseSettledResult<R>[]> {
|
||||
const results: PromiseSettledResult<R>[] = new Array(items.length);
|
||||
let next = 0;
|
||||
const worker = async () => {
|
||||
while (next < items.length) {
|
||||
const index = next++;
|
||||
try { results[index] = { status: "fulfilled", value: await task(items[index]!) }; }
|
||||
catch (reason) { results[index] = { status: "rejected", reason }; }
|
||||
}
|
||||
};
|
||||
await Promise.all(Array.from({ length: Math.max(1, Math.min(limit, items.length)) }, worker));
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* `~/.cache/expo-explore/captures/<target>/<sha>`: one capture per commit and target, reused while its recipe matches.
|
||||
* A config without targets names them for their platforms, so its captures stay where they were.
|
||||
*/
|
||||
export function captureCacheDirectory(environment: NodeJS.ProcessEnv, target: string, sha: string): string {
|
||||
return join(exploreCacheRoot(environment), "captures", target, sha);
|
||||
}
|
||||
|
||||
async function exists(path: string): Promise<boolean> { try { await lstat(path); return true; } catch { return false; } }
|
||||
@@ -258,17 +291,33 @@ function recordedSessionIds(outputs: string[]): string[] {
|
||||
}));
|
||||
}
|
||||
|
||||
/** Stop the EAS Simulator sessions a capture recorded and did not stop itself (an interrupted run), with the local login. */
|
||||
/** How to stop a recorded session by hand: an EAS Simulator session, or a local simulator or emulator the capture started. */
|
||||
function stopHint(id: string): string {
|
||||
const udid = localSimulatorFromState(id);
|
||||
const serial = localEmulatorFromState(id);
|
||||
return udid ? `xcrun simctl delete ${udid}` : serial ? `adb -s ${serial} emu kill` : `eas simulator:stop --id ${id}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop the simulators a capture recorded and did not stop itself (an interrupted run): EAS Simulator sessions with the
|
||||
* local login, local simulators by deleting them, and local emulators by killing them.
|
||||
*/
|
||||
export async function stopRecordedSessions(outputs: string[], environment: NodeJS.ProcessEnv, runner: (args: string[]) => { status: number | null } =
|
||||
args => spawnSync(packageBin("eas-cli", "eas"), args, { env: environment, encoding: "utf8", timeout: 120_000 }), quiet = false): Promise<string[]> {
|
||||
args => spawnSync(packageBin("eas-cli", "eas"), args, { env: environment, encoding: "utf8", timeout: 120_000 }), quiet = false,
|
||||
simctl: (args: string[]) => { status: number | null } = args => spawnSync("xcrun", ["simctl", ...args], { env: environment, encoding: "utf8", timeout: 120_000 }),
|
||||
adb: (args: string[]) => { status: number | null } = args => spawnSync(androidTools(environment).adb, args, { env: environment, encoding: "utf8", timeout: 60_000 })): Promise<string[]> {
|
||||
const stopped: string[] = [];
|
||||
for (const output of outputs) for (const name of ["head-session", "base-session"]) {
|
||||
const file = join(output, name);
|
||||
const id = (await readFile(file, "utf8").catch(() => "")).trim();
|
||||
if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id)) continue;
|
||||
if (runner(["simulator:stop", "--id", id, "--json", "--non-interactive"]).status === 0) { stopped.push(id); await rm(file, { force: true }); }
|
||||
const udid = localSimulatorFromState(id);
|
||||
const serial = localEmulatorFromState(id);
|
||||
if (udid) simctl(["shutdown", udid]);
|
||||
const stop = udid ? simctl(["delete", udid]) : serial ? adb(["-s", serial, "emu", "kill"]) : runner(["simulator:stop", "--id", id, "--json", "--non-interactive"]);
|
||||
if (stop.status === 0) { stopped.push(id); await rm(file, { force: true }); }
|
||||
// During an interrupt the capture may stop the same session first; only the final pass reports a failure.
|
||||
else if (!quiet) process.stderr.write(`Could not stop EAS Simulator session ${id}; stop it with: eas simulator:stop --id ${id}\n`);
|
||||
else if (!quiet) process.stderr.write(`Could not stop simulator ${id}; stop it with: ${stopHint(id)}\n`);
|
||||
}
|
||||
return stopped;
|
||||
}
|
||||
@@ -333,13 +382,13 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
const interrupt = () => {
|
||||
interrupts += 1;
|
||||
if (interrupts === 1) {
|
||||
process.stderr.write("\nStopping the review and its EAS Simulator sessions… (Ctrl+C again to quit now)\n");
|
||||
process.stderr.write("\nStopping the review and its simulators… (Ctrl+C again to quit now)\n");
|
||||
abort.abort(new CiError({ code: "LOCAL_REVIEW_INTERRUPTED", stage: "capture", message: "The review was interrupted.", nextAction: "Rerun it when you are ready." }));
|
||||
if (!options.runner) void stopRecordedSessions(outputs, environment, undefined, true);
|
||||
return;
|
||||
}
|
||||
for (const tree of worktrees) git(root, ["worktree", "remove", "--force", tree]);
|
||||
for (const id of recordedSessionIds(outputs)) process.stderr.write(`Still running: stop it with eas simulator:stop --id ${id}\n`);
|
||||
for (const id of recordedSessionIds(outputs)) process.stderr.write(`Still running: stop it with ${stopHint(id)}\n`);
|
||||
process.exit(130);
|
||||
};
|
||||
process.on("SIGINT", interrupt);
|
||||
@@ -380,7 +429,15 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
const configPath = options.configPath ?? DEFAULT_EXPLORE_CONFIG_PATH;
|
||||
const rawConfig = await localReviewConfig({ project, head: projects.head, configPath, explicit: options.configPath !== undefined,
|
||||
platform: options.platform, progress });
|
||||
const platforms = options.platform ? [options.platform] : configPlatforms(rawConfig);
|
||||
const allTargets = configTargets(rawConfig);
|
||||
if (options.target !== undefined && !allTargets.some(target => target.id === options.target)) throw new CiError({ code: "TARGET_NOT_CONFIGURED", stage: "preflight",
|
||||
message: `The config has no target ${options.target}.`, nextAction: `Pass one of: ${allTargets.map(target => target.id).join(", ")}.` });
|
||||
const targets = allTargets.filter(target => (options.target === undefined || target.id === options.target) && (options.platform === undefined || target.platform === options.platform));
|
||||
if (!targets.length) throw new CiError({ code: "PLATFORM_NOT_CONFIGURED", stage: "preflight", message: `The config has no ${options.platform} target.`,
|
||||
nextAction: `Pass one of: ${allTargets.map(target => target.id).join(", ")}.` });
|
||||
// The reports link to each other's targets (the Viewer's target switch), so they name only the targets this review
|
||||
// captures: `--target phone` or `--platform ios` makes no report for the others, and a link to one would find nothing.
|
||||
const platforms = configPlatforms(rawConfig).filter(platform => targets.some(target => target.platform === platform));
|
||||
const repository = repositoryName(root, rawConfig);
|
||||
|
||||
// Credentials: tokens and keys when set, otherwise your own logins.
|
||||
@@ -393,19 +450,21 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
const subscription = rawConfig.mode === "agent" && rawConfig.agent !== undefined && !environment[AGENT_PROVIDERS[rawConfig.agent.provider].secret]?.trim();
|
||||
if (subscription) progress(`model: your local ${rawConfig.agent!.provider === "anthropic" ? "claude" : "codex"} login (no ${AGENT_PROVIDERS[rawConfig.agent!.provider].secret} set)`);
|
||||
|
||||
let installed = false;
|
||||
// Every target's capture waits on one install of both commits' dependencies.
|
||||
let installed: Promise<void> | undefined;
|
||||
const install = options.install ?? (async (project: string, side: "base" | "head") => {
|
||||
progress(`installing the ${side} commit's dependencies`);
|
||||
await installDependencies(project, join(work, `install-${side}.log`), environment);
|
||||
});
|
||||
const reports: LocalReviewReport[] = [];
|
||||
for (const platform of platforms) {
|
||||
const config = withRunOverrides(resolvePlatformConfig(rawConfig, platform), { scope: options.scope, expiresIn: options.expiresIn, controller: options.controller });
|
||||
const output = join(work, platform); await mkdir(output);
|
||||
// The targets run at once, as CI runs them in parallel jobs: each on its own simulators, with its own output.
|
||||
const captureTarget = async (target: RunTarget): Promise<LocalReviewReport> => {
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, { target: target.id }), { scope: options.scope, expiresIn: options.expiresIn, controller: options.controller, simulator: options.simulator, repack: options.repack });
|
||||
const platform = target.platform;
|
||||
const output = join(work, target.id); await mkdir(output);
|
||||
outputs.push(output);
|
||||
const platformEnvironment = { ...environment };
|
||||
delete platformEnvironment.EXPLORE_CAPTURE_CACHE;
|
||||
const cachedBase = captureCacheDirectory(environment, platform, base.sha);
|
||||
const cachedBase = captureCacheDirectory(environment, target.id, base.sha);
|
||||
if (options.cache !== false && await exists(join(cachedBase, CACHE_METADATA))) {
|
||||
platformEnvironment.EXPLORE_CAPTURE_CACHE = cachedBase;
|
||||
// Reusing a capture counts as using it, so pruning keeps the bases reviews come back to.
|
||||
@@ -416,10 +475,14 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
const state: PublicCommentState = { phase: "pending", pullRequest: presentation, mode: config.exploration.scope, executionMode: config.mode,
|
||||
configPath: appDirectory === "." ? configPath : `${appDirectory}/${configPath}`,
|
||||
links: { viewer: null, download: null, run: "", config: "", artifacts: "" }, startedAt: Date.now(), updatedAt: Date.now(),
|
||||
build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true };
|
||||
progress(`${platform}: reviewing`);
|
||||
build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true,
|
||||
target, ...(targets.length > 1 ? { targets } : {}) };
|
||||
progress(`${target.id}: reviewing${target.id === platform ? "" : ` (${target.label})`}`);
|
||||
const result = await runCiReview({ projects, output, config, presentation, runId, runAttempt: "1", state, environment: platformEnvironment,
|
||||
...(platforms.length > 1 ? { platforms } : {}), subscription, useLocalEasSession, progress: message => progress(`${platform}: ${message}`),
|
||||
...(platforms.length > 1 ? { platforms } : {}), ...(targets.length > 1 ? { targets } : {}),
|
||||
// Targets of one platform capture the same commits from the same build; it is built and repacked once.
|
||||
...(targets.length > 1 ? { buildShare: join(work, ".builds") } : {}),
|
||||
subscription, useLocalEasSession, progress: message => progress(`${target.id}: ${message}`),
|
||||
...(options.runner ? { runner: options.runner } : {}), ...(options.now ? { now: options.now } : {}), ...(options.sleep ? { sleep: options.sleep } : {}),
|
||||
signal: abort.signal,
|
||||
// Model requests end on Ctrl+C: the session kills its own process group and restores any login it changed.
|
||||
@@ -429,11 +492,9 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
preflight: preflightOptions => session.preflight({ ...preflightOptions, signal: preflightOptions?.signal ? AbortSignal.any([preflightOptions.signal, abort.signal]) : abort.signal }),
|
||||
run: request => session.run({ ...request, signal: request.signal ? AbortSignal.any([request.signal, abort.signal]) : abort.signal }) };
|
||||
},
|
||||
prepareCapture: async () => {
|
||||
if (installed) return;
|
||||
prepareCapture: () => installed ??= (async () => {
|
||||
for (const side of ["head", "base"] as const) await install(projects[side], side);
|
||||
installed = true;
|
||||
},
|
||||
})(),
|
||||
assertCurrentHead: async () => {
|
||||
abort.signal.throwIfAborted();
|
||||
for (const side of ["base", "head"] as const) {
|
||||
@@ -451,20 +512,45 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
await writeFile(zip, await zipReportDirectory(directory));
|
||||
const input = await readCiReportInput(result.inputPath);
|
||||
const changes = reviewChangeCount(input.commentState); const device = reviewDevice(input.commentState);
|
||||
reports.push({ platform, directory, zip, ...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) });
|
||||
const report: LocalReviewReport = { platform, target, directory, zip, ...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) };
|
||||
// Keep both sides' captures for later reviews of these commits; a working-tree snapshot is never reviewed again.
|
||||
if (options.cache !== false) for (const side of ["base", "head"] as const) {
|
||||
if (side === "head" && head.uncommitted) continue;
|
||||
await keepCapture(join(output, `${side}-export`), captureCacheDirectory(environment, platform, side === "base" ? base.sha : head.sha));
|
||||
await keepCapture(join(output, `${side}-export`), captureCacheDirectory(environment, target.id, side === "base" ? base.sha : head.sha));
|
||||
}
|
||||
if (options.cache !== false) await pruneCaptureCache(environment).catch(() => []);
|
||||
// The report is all that is kept; the captures, maps and checkouts are the bulk of the run.
|
||||
for (const entry of await readdir(output)) if (entry !== "report" && entry !== "report.zip") await rm(join(output, entry), { recursive: true, force: true });
|
||||
abort.signal.throwIfAborted();
|
||||
}
|
||||
return report;
|
||||
};
|
||||
// Every target finishes or fails on its own, so each stops the simulators it started; then the first failure is the review's.
|
||||
// Whatever an earlier review stopped hard left running on this machine (simulators, emulators, daemons,
|
||||
// tool-servers) is stopped first; only what Explore recorded is touched.
|
||||
const swept = await sweepLocalCaptures({ environment, runner: options.runner ?? defaultRunner, cwd: work }).catch(() => [] as string[]);
|
||||
if (swept.length) progress(`stopped what an interrupted review left running: ${swept.join(", ")}`);
|
||||
// A capture worker that exited before its shared build said how it ended would leave the targets waiting on that build
|
||||
// polling until the review is stopped: its builds are failed instead.
|
||||
const releaseBuilds = async (target: RunTarget, error: unknown) => {
|
||||
const failure = toCiError(error);
|
||||
const side = /^capture-(head|base)$/.exec(failure.stage)?.[1];
|
||||
if (targets.length > 1 && failure.code === "CAPTURE_WORKER_EXITED" && side) {
|
||||
await abandonSharedBuilds(join(work, ".builds"), owner => owner === join(work, target.id, `${side}-export`), failure.code);
|
||||
}
|
||||
};
|
||||
const settled = await settleLimited(targets, options.parallel ?? targets.length,
|
||||
target => captureTarget(target).catch(async (error: unknown) => { await releaseBuilds(target, error).catch(() => undefined); throw error; }));
|
||||
// One target that fails costs that target's report, not the others': they are kept, and the failure is named.
|
||||
// Only an interrupted review, or one where every target failed, fails as a whole.
|
||||
const reports = settled.flatMap(outcome => outcome.status === "fulfilled" ? [outcome.value] : []);
|
||||
const failed = settled.flatMap((outcome, index) => outcome.status === "rejected" ? [{ target: targets[index]!, reason: outcome.reason as unknown }] : []);
|
||||
abort.signal.throwIfAborted();
|
||||
if (!reports.length && failed.length) throw failed[0]!.reason;
|
||||
const failures = failed.map(({ target, reason }) => ({ target, error: serializeCiError(reason) }));
|
||||
for (const { target, error } of failures) progress(`${target.id}: no report (${error.code}: ${error.message})`);
|
||||
if (options.cache !== false) await pruneCaptureCache(environment).catch(() => []);
|
||||
// The install logs and snapshot index go too; the checkouts are removed with git below.
|
||||
for (const entry of await readdir(work)) if (![...platforms, "base", "head"].includes(entry)) await rm(join(work, entry), { recursive: true, force: true });
|
||||
return { runId, base, head, work, reports, config: rawConfig, repository };
|
||||
for (const entry of await readdir(work)) if (![...targets.map(target => target.id), "base", "head"].includes(entry)) await rm(join(work, entry), { recursive: true, force: true });
|
||||
return { runId, base, head, work, reports, config: rawConfig, repository, failures };
|
||||
} catch (error) {
|
||||
failed = true;
|
||||
// A capture interrupted mid-session reports its cleanup; the interruption is what happened.
|
||||
|
||||
+21
-7
@@ -1,3 +1,4 @@
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { mkdir, open, readFile, realpath, writeFile } from "node:fs/promises";
|
||||
import { join, relative, resolve, isAbsolute } from "node:path";
|
||||
@@ -18,7 +19,7 @@ import { projectComparePresentation, projectPullRequestPresentation, type Review
|
||||
import { renderPublicComment, platformSectionMerge, type PublicCommentState } from "../report/pr-comment-body.js";
|
||||
import { upsertStickyComment } from "../report/pr-comment.js";
|
||||
import { viewerLinks } from "../report/viewer-links.js";
|
||||
import { DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { DEFAULT_EXPLORE_CONFIG_PATH, captureRepack, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { prepareCiExploration, type PrepareCiExplorationOptions } from "../capture/agent/exploration.js";
|
||||
import { generateAgentChangeNotes } from "../capture/agent/change-notes.js";
|
||||
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
|
||||
@@ -26,7 +27,7 @@ import type { SourceCapturePlan } from "../source/capture-plan.js";
|
||||
import { createSourceChangeSummaries } from "../source/change-summary.js";
|
||||
import { assertNoCaptureHealthIssues, partitionCaptureHealthIssues, renderCaptureIssueAnnotation, renderComparisonDiagnosticAnnotation, renderNotesUnavailableAnnotation, renderReviewGapAnnotation, sortedCaptureHealthIssues } from "../capture/health.js";
|
||||
import { EXPLORE_PACKAGE, packageBin } from "../shared/package-paths.js";
|
||||
import { agentDeviceLauncher, ensureController } from "../shared/controller-cache.js";
|
||||
import { agentDeviceLauncher, ensureArgentToolServer, ensureController } from "../shared/controller-cache.js";
|
||||
import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
|
||||
|
||||
@@ -67,7 +68,8 @@ function captureOptions(config: ExploreConfig, environment: NodeJS.ProcessEnv, r
|
||||
...(config.app.scheme ? { scheme: config.app.scheme } : {}), device: config.device.name, ...(config.device.pose ? { devicePose: config.device.pose } : {}),
|
||||
easProfile: config.app.easProfile, expoToken: environment.EXPO_TOKEN ?? "",
|
||||
maxScreens: 5000, maxActions: config.capture.maxActions, maxDurationMinutes: config.capture.maxMinutes,
|
||||
setup: config.setup ?? [], forceFreshBuild: false, confirmExternalRun: true, confirmTrustedSource: true, repack: config.capture.repack, appearance: config.capture.appearance, launch: config.capture.launch, reset: config.capture.reset, unattributed: config.capture.unattributed, ...(config.capture.readinessSeconds !== undefined ? { readinessSeconds: config.capture.readinessSeconds } : {}), ...(config.capture.controller ? { controller: config.capture.controller } : {}),
|
||||
setup: config.setup ?? [], forceFreshBuild: false, confirmExternalRun: true, confirmTrustedSource: true, repack: captureRepack(config), appearance: config.capture.appearance, launch: config.capture.launch, reset: config.capture.reset, unattributed: config.capture.unattributed, ...(config.capture.readinessSeconds !== undefined ? { readinessSeconds: config.capture.readinessSeconds } : {}), ...(config.capture.controller ? { controller: config.capture.controller } : {}),
|
||||
...(config.capture.simulator ? { simulator: config.capture.simulator } : {}),
|
||||
environment, ...(runner ? { runner } : {}), easCommand: packageBin("eas-cli", "eas"), agentDeviceCommand: agentDeviceLauncher(environment), repackCommand: packageBin("@expo/repack-app", "repack-app") };
|
||||
}
|
||||
/**
|
||||
@@ -78,6 +80,8 @@ function captureOptions(config: ExploreConfig, environment: NodeJS.ProcessEnv, r
|
||||
async function prefetchControllers(config: ExploreConfig, environment: NodeJS.ProcessEnv, progress: Progress): Promise<void> {
|
||||
await ensureController("agent-device", { environment, progress });
|
||||
if (config.capture.controller === "argent") await ensureController("argent", { environment, progress });
|
||||
// Argent on a local device also needs its tool-server, installed once before the targets capture side by side.
|
||||
if (config.capture.controller === "argent" && config.capture.simulator === "local") await ensureArgentToolServer({ environment, progress });
|
||||
}
|
||||
|
||||
export function captureSidesConcurrently(input: { plan: SourceCapturePlan; agent: boolean; injectedRunner: boolean; baselineMayExist: boolean }): boolean {
|
||||
@@ -101,8 +105,12 @@ export type PublicCiOptions = {
|
||||
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
|
||||
/** Set when the workflow passes --platform; artifact and report names then carry the platform suffix. */
|
||||
platform?: ExplorePlatform;
|
||||
/** The target id a matrix job captures (--target, or --platform from older workflows): its comment section and names. */
|
||||
target?: string;
|
||||
/** Every platform config.yaml captures; recorded in the report so the Viewer links the sibling platform's report. */
|
||||
platforms?: ExplorePlatform[];
|
||||
/** Every target config.yaml captures, in config order; recorded in the report so the Viewer links the sibling targets' reports. */
|
||||
targets?: RunTarget[];
|
||||
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;
|
||||
@@ -120,7 +128,7 @@ function assertRunIdentity(environment: NodeJS.ProcessEnv): void {
|
||||
}
|
||||
|
||||
/** What both CI adapters check before capture: exact checkouts of both sides and an output outside them. */
|
||||
async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "headProject" | "output" | "config" | "configPath" | "now">,
|
||||
async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "headProject" | "output" | "config" | "configPath" | "now" | "targets">,
|
||||
environment: NodeJS.ProcessEnv, presentation: ReviewPresentation) {
|
||||
const now = options.now ?? Date.now;
|
||||
const config = options.config;
|
||||
@@ -141,7 +149,8 @@ async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "head
|
||||
executionMode: config.mode, configPath: repositoryConfigPath,
|
||||
links: viewerLinks({ repository: presentation.repository, headSha: presentation.head.sha, runId: environment.GITHUB_RUN_ID!,
|
||||
runAttempt: environment.GITHUB_RUN_ATTEMPT!, configPath: repositoryConfigPath }),
|
||||
startedAt: now(), updatedAt: now(), build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true };
|
||||
startedAt: now(), updatedAt: now(), build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true,
|
||||
...(config.target ? { target: config.target } : {}), ...(options.targets && options.targets.length > 1 ? { targets: options.targets } : {}) };
|
||||
return { projects, output, state };
|
||||
}
|
||||
|
||||
@@ -168,7 +177,7 @@ export async function runPublicCi(options: PublicCiOptions) {
|
||||
const postComment = async () => {
|
||||
await assertCurrentPr();
|
||||
state.updatedAt = now(); const body = renderPublicComment(state); options.onComment?.(state, body);
|
||||
try { await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, options.platform), token: githubToken, fetchImpl: transport }); }
|
||||
try { await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, options.target ?? options.platform), token: githubToken, fetchImpl: transport }); }
|
||||
catch (error) { process.stderr.write(`Progress comment unavailable: ${serializeCiError(error).message}\n`); }
|
||||
};
|
||||
let prVerificationFailed = false;
|
||||
@@ -241,6 +250,10 @@ export async function runCiReview(options: {
|
||||
projects: { base: string; head: string }; output: string; config: ExploreConfig;
|
||||
presentation: ReviewPresentation; runId: string; runAttempt: string;
|
||||
platforms?: ExplorePlatform[];
|
||||
/** Every target config.yaml captures; `config.target` is the one this review captures. */
|
||||
targets?: RunTarget[];
|
||||
/** A folder shared with the other targets' reviews, so the targets of one platform build each commit once. */
|
||||
buildShare?: string;
|
||||
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
|
||||
state: PublicCommentState; environment: NodeJS.ProcessEnv;
|
||||
assertCurrentHead: () => Promise<void>; postComment: () => Promise<void>; canPublish?: () => boolean;
|
||||
@@ -311,7 +324,7 @@ export async function runCiReview(options: {
|
||||
...(exploration.agent ? { agent: exploration.agent } : {}), project: projects[side],
|
||||
mapDirectory: join(output, `${side}-map`), outputDirectory: directory,
|
||||
name: config.app.name ?? pr.repository, buildId: pr.origin === "local" ? `local-${pr.runId}-${side}` : pr.origin === "compare" ? `compare-${options.runId}-${side}` : `pr-${pr.number}-${side}`, buildVersion: pr[side].sha.slice(0, 8), gitCommit: pr[side].sha,
|
||||
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`),
|
||||
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`), ...(options.buildShare ? { buildShare: options.buildShare } : {}),
|
||||
...(reuseDirectory ? { reuseDirectory } : {}), ...(options.signal ? { signal: options.signal } : {}) };
|
||||
const captured = concurrent
|
||||
? await runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(mapOptions), progress, options.signal)
|
||||
@@ -358,6 +371,7 @@ export async function runCiReview(options: {
|
||||
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory,
|
||||
runId: options.runId, runAttempt: options.runAttempt, assertCurrentHead, assessments: evidence.surfaces,
|
||||
...(options.platforms ? { platforms: options.platforms } : {}),
|
||||
...(config.target ? { target: config.target } : {}), ...(options.targets ? { targets: options.targets } : {}),
|
||||
app: { ...(state.build?.appVersion ? { version: state.build.appVersion } : {}),
|
||||
...(state.build?.appBuildNumber ? { buildNumber: state.build.appBuildNumber } : {}) } });
|
||||
const contract = quarantineReviewContract(result.review);
|
||||
|
||||
@@ -3,7 +3,7 @@ import { appendFile, lstat, mkdir, writeFile } from "node:fs/promises";
|
||||
import { join, resolve } from "node:path";
|
||||
import { tmpdir } from "node:os";
|
||||
import { pathToFileURL } from "node:url";
|
||||
import { parseTrustedAuthors, DEFAULT_EXPLORE_CONFIG_PATH } from "../config/explore-config.js";
|
||||
import { isTargetId, parseTrustedAuthors, DEFAULT_EXPLORE_CONFIG_PATH } from "../config/explore-config.js";
|
||||
import { compareTitle, compareUrl, projectComparePresentation, projectPullRequestPresentation,
|
||||
type CompareReviewPresentation, type PullRequestPresentation } from "../contracts/review.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
@@ -109,15 +109,19 @@ type GithubRun = { conclusion: string | null; workflow_id: number; head_sha: str
|
||||
* `ci:find-baseline`: the newest successful baseline-workflow artifact of exactly this commit, uploaded from the
|
||||
* default branch of this repository. Its id and run go to the step outputs for actions/download-artifact.
|
||||
*/
|
||||
export async function findBaselineArtifact(options: { sha: string; platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
|
||||
export async function findBaselineArtifact(options: { sha: string; target?: string;
|
||||
/** What callers from before targets pass: a platform is the id of its default target. */ platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const context = githubContext(environment);
|
||||
if (!SHA.test(options.sha)) throw new CiError({ code: "SHA_INVALID", stage: "preflight", message: "The base commit must be a full SHA.", nextAction: "Pass --sha with a 40-character commit SHA." });
|
||||
const target = options.target ?? options.platform ?? "ios";
|
||||
if (!isTargetId(target)) throw new CiError({ code: "TARGET_INVALID", stage: "preflight", message: `${target} is not a target id.`,
|
||||
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
|
||||
const repository = await githubGet<{ default_branch: string }>(`repos/${context.repository}`, context, transport);
|
||||
const workflow = await githubGet<{ id: number }>(`repos/${context.repository}/actions/workflows/explore-baseline.yml`, context, transport);
|
||||
if (!repository || !workflow) return undefined;
|
||||
// Baselines carry the platform suffix; iOS also accepts the unsuffixed name older baseline workflows uploaded.
|
||||
const names = [`explore-baseline-${options.sha}-${options.platform ?? "ios"}`, ...(options.platform === "android" ? [] : [`explore-baseline-${options.sha}`])];
|
||||
// Baselines carry the target suffix; target ios also accepts the unsuffixed name older single-platform baseline workflows uploaded.
|
||||
const names = [`explore-baseline-${options.sha}-${target}`, ...(target === "ios" ? [`explore-baseline-${options.sha}`] : [])];
|
||||
const artifacts: GithubArtifact[] = [];
|
||||
for (const name of names) for (let page = 1; page <= 10; page++) {
|
||||
const listed = await githubGet<{ artifacts: GithubArtifact[] }>(`repos/${context.repository}/actions/artifacts?name=${encodeURIComponent(name)}&per_page=100&page=${page}`, context, transport);
|
||||
@@ -138,7 +142,7 @@ export async function findBaselineArtifact(options: { sha: string; platform?: st
|
||||
/**
|
||||
* `ci:find-baseline` as the workflow runs it: a baseline is optional, so a lookup that fails (a GitHub 5xx, a rate
|
||||
* limit) is a warning and no baseline, never an error. A `ci:*` error would write explore-diagnostics/error.json,
|
||||
* which the failure comment would then report as the cause of an unrelated failure, possibly on another platform.
|
||||
* which the failure comment would then report as the cause of an unrelated failure, possibly on another target.
|
||||
*/
|
||||
export async function findOptionalBaseline(options: Parameters<typeof findBaselineArtifact>[0]):
|
||||
Promise<{ baseline?: { id: number; run: number }; warning?: { code: string; message: string } }> {
|
||||
|
||||
+2
-1
@@ -9,7 +9,7 @@ import { command, resultContract, argumentError, validateCommandArguments, flag,
|
||||
import { help } from "./cli/help.js";
|
||||
import { listScreens, getScreen, listElements, listObservations, getObservation, nextFrontier, listAttempts, getAttempt, listTransitions, getTransition, neighbors, pathQuery, listJourneys, getJourney, listFrontier, listGaps, summary, search, status, validate, exportArtifacts } from "./cli/map-commands.js";
|
||||
import { compareCommand, exportWeb, view } from "./cli/catalog-commands.js";
|
||||
import { ciReport, ciPublish, ciFailure, ciDeploy, ciPullRequest, ciFindBaseline, ciCompareRefs, ciAfterCapture, setup, doctor, sourceVerify, captureReview, captureBaseline, configPlatforms } from "./cli/ci-commands.js";
|
||||
import { ciReport, ciPublish, ciFailure, ciDeploy, ciPullRequest, ciFindBaseline, ciCompareRefs, ciAfterCapture, setup, doctor, sourceVerify, captureReview, captureBaseline, configPlatforms, configTargetList } from "./cli/ci-commands.js";
|
||||
import { exploreBinary, exploreSession } from "./cli/binary-commands.js";
|
||||
import { reports, reportUpload } from "./cli/report-commands.js";
|
||||
|
||||
@@ -53,6 +53,7 @@ const handlers: Record<string, () => Promise<void> | void> = {
|
||||
"capture:baseline": captureBaseline,
|
||||
"source:verify": sourceVerify,
|
||||
"config:platforms": configPlatforms,
|
||||
"config:targets": configTargetList,
|
||||
doctor,
|
||||
compare: compareCommand,
|
||||
view,
|
||||
|
||||
+12
-10
@@ -24,6 +24,7 @@ const aliases: Record<string, string> = {
|
||||
"ci failure": "ci:failure",
|
||||
"ci deploy": "ci:deploy",
|
||||
"config platforms": "config:platforms",
|
||||
"config targets": "config:targets",
|
||||
};
|
||||
|
||||
/** One-word names for commands people type: `capture` is the local review, `capture:review` without its CI flags. */
|
||||
@@ -32,7 +33,7 @@ const shortNames: Record<string, string> = { capture: "capture:review" };
|
||||
const first = argv[0] ?? "help";
|
||||
const pair = `${first} ${argv[1] ?? ""}`.trim();
|
||||
export const command = aliases[pair] ?? shortNames[first] ?? first;
|
||||
export const resultContract = ["source:verify", "capture:review", "capture:baseline", "ci:report", "ci:publish", "ci:failure", "ci:deploy", "ci:pr", "ci:find-baseline", "ci:compare-refs", "ci:after-capture", "config:platforms", "explore:binary", "explore:session", "report:upload", "reports"].includes(command)
|
||||
export const resultContract = ["source:verify", "capture:review", "capture:baseline", "ci:report", "ci:publish", "ci:failure", "ci:deploy", "ci:pr", "ci:find-baseline", "ci:compare-refs", "ci:after-capture", "config:platforms", "config:targets", "explore:binary", "explore:session", "report:upload", "reports"].includes(command)
|
||||
? "explore.result" : QUERY_CONTRACT;
|
||||
const commandArgCount = aliases[pair] ? 2 : 1;
|
||||
const args = argv.slice(commandArgCount);
|
||||
@@ -50,10 +51,11 @@ const flagKinds: Record<string, Record<string, "value" | "boolean">> = {
|
||||
setup: { project: "value", platform: "value", device: "value", scope: "value", profile: "value", "bundle-id": "value", scheme: "value", navigation: "value",
|
||||
mode: "value", provider: "value", model: "value", param: "value", "app-state": "value", workflows: "boolean", "no-workflows": "boolean",
|
||||
"non-interactive": "boolean", check: "boolean", force: "boolean", help: "boolean" },
|
||||
doctor: { project: "value", offline: "boolean", "no-github": "boolean", "check-model": "boolean", capture: "boolean", output: "value", platform: "value", controller: "value", yes: "boolean", help: "boolean" },
|
||||
"capture:baseline": { project:"value", sha:"value", output:"value", config:"value", platform:"value", controller:"value" },
|
||||
"source:verify": { "base-project":"value", "head-project":"value", "base-sha":"value", "head-sha":"value", output:"value", config:"value", scope:"value", platform:"value" },
|
||||
doctor: { project: "value", offline: "boolean", "no-github": "boolean", "check-model": "boolean", capture: "boolean", output: "value", target: "value", platform: "value", controller: "value", simulator: "value", repack: "value", yes: "boolean", help: "boolean" },
|
||||
"capture:baseline": { project:"value", sha:"value", output:"value", config:"value", target:"value", platform:"value", controller:"value", simulator:"value", repack:"value" },
|
||||
"source:verify": { "base-project":"value", "head-project":"value", "base-sha":"value", "head-sha":"value", output:"value", config:"value", scope:"value", target:"value", platform:"value" },
|
||||
"config:platforms": { project:"value", config:"value" },
|
||||
"config:targets": { project:"value", config:"value" },
|
||||
"screen:list": { limit: "value", cursor: "value", unexplored: "boolean" },
|
||||
"screen:get": { id: "value" },
|
||||
"element:list": {
|
||||
@@ -83,7 +85,7 @@ const flagKinds: Record<string, Record<string, "value" | "boolean">> = {
|
||||
validate: {},
|
||||
export: { output: "value" },
|
||||
"export:web": {catalog:"value",output:"value"},
|
||||
"capture:review": { "base-project":"value", "head-project":"value", "pull-request":"value", compare:"value", output:"value", config:"value", platform:"value", controller:"value", scope:"value", "expires-in":"value",
|
||||
"capture:review": { "base-project":"value", "head-project":"value", "pull-request":"value", compare:"value", output:"value", config:"value", parallel:"value", target:"value", platform:"value", controller:"value", simulator:"value", repack:"value", scope:"value", "expires-in":"value",
|
||||
base:"value", head:"value", project:"value", committed:"boolean", uncommitted:"boolean", "include-untracked":"boolean", upload:"boolean", "no-open":"boolean", "no-cache":"boolean", port:"value" },
|
||||
|
||||
|
||||
@@ -94,12 +96,12 @@ const flagKinds: Record<string, Record<string, "value" | "boolean">> = {
|
||||
"explore:session": { session:"value", "env-file":"value", "bundle-id":"value", "app-name":"value", "app-version":"value", output:"value", platform:"value", controller:"value", device:"value", "launch-url":"value", hints:"value",
|
||||
"allow-destructive":"value", "max-duration-minutes":"value", "max-screens":"value", "max-actions":"value", provider:"value", model:"value", owner:"value", project:"value",
|
||||
upload:"boolean", "expires-in":"value", alias:"value", "no-open":"boolean", port:"value" },
|
||||
"ci:report": { input:"value", output:"value", platform:"value" },
|
||||
"ci:publish": { input:"value", "artifact-url":"value", platform:"value", inputs:"value" },
|
||||
"ci:failure": { pr:"value", head:"value", base:"value", diagnostics:"value", platform:"value" },
|
||||
"ci:deploy": { input:"value", report:"value", "artifact-url":"value", platform:"value", inputs:"value", reports:"value" },
|
||||
"ci:report": { input:"value", output:"value", target:"value", platform:"value" },
|
||||
"ci:publish": { input:"value", "artifact-url":"value", target:"value", platform:"value", inputs:"value" },
|
||||
"ci:failure": { pr:"value", head:"value", base:"value", diagnostics:"value", target:"value", platform:"value" },
|
||||
"ci:deploy": { input:"value", report:"value", "artifact-url":"value", target:"value", platform:"value", inputs:"value", reports:"value" },
|
||||
"ci:pr": { pr:"value", output:"value", "app-dir":"value", config:"value" },
|
||||
"ci:find-baseline": { sha:"value", platform:"value" },
|
||||
"ci:find-baseline": { sha:"value", target:"value", platform:"value" },
|
||||
"ci:compare-refs": { project:"value", base:"value", head:"value", title:"value", output:"value" },
|
||||
"ci:after-capture": { output:"value", checkout:"value" },
|
||||
compare: {
|
||||
|
||||
+58
-31
@@ -15,8 +15,8 @@ import { installCiFiles } from "../ci/workflow-install.js";
|
||||
import { readRouteEntry } from "../ci/route-entry.js";
|
||||
import { buildVerifiedPlan } from "../ci/verified-plan.js";
|
||||
import { formatCaptureCheck, formatDoctorReport, referencedSecretNames, runCaptureCheck, runDoctor } from "../ci/doctor.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolvePlatformConfig, withRunOverrides, previewDays, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf } from "./args.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, previewDays, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf, positiveInteger } from "./args.js";
|
||||
import { help } from "./help.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { cleanupAfterCapture, findOptionalBaseline, resolveCompareRefs, resolvePullRequest, writeCaptureOutputs, writeStepOutputs } from "../ci/workflow-steps.js";
|
||||
@@ -26,7 +26,7 @@ export async function doctor(): Promise<void> {
|
||||
if (has("help")) return help();
|
||||
const project = flag("project") ?? process.cwd();
|
||||
const report = await runDoctor({ project, online: !has("offline"), github: !has("no-github") && !has("offline"),
|
||||
checkModel: has("check-model"), controller: flag("controller") });
|
||||
checkModel: has("check-model"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
|
||||
if (!has("capture")) {
|
||||
if (has("json")) output({ ...report });
|
||||
else console.log(formatDoctorReport(report));
|
||||
@@ -53,7 +53,7 @@ Fix the problems in steps 1–5 before a capture check.`);
|
||||
let result: Awaited<ReturnType<typeof runCaptureCheck>>;
|
||||
try {
|
||||
const platform = platformFlag();
|
||||
result = await runCaptureCheck({ project, ...(platform ? { platform } : {}), controller: flag("controller"), output: resolve(flag("output") ?? await mkdtemp(join(tmpdir(), "expo-explore-capture-"))), progress: stderrProgress() });
|
||||
result = await runCaptureCheck({ project, ...(platform ? { platform } : {}), target: targetFlag(), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack"), output: resolve(flag("output") ?? await mkdtemp(join(tmpdir(), "expo-explore-capture-"))), progress: stderrProgress() });
|
||||
} catch (error) {
|
||||
// A refusal before any EAS work: show it with its next action next to the static report.
|
||||
if (!(error instanceof CiError)) throw error;
|
||||
@@ -84,20 +84,20 @@ export async function ciDeploy(): Promise<void> {
|
||||
}
|
||||
|
||||
export async function ciPublish(): Promise<void> {
|
||||
const platform = platformFlag();
|
||||
output({ ok: true, ...await publishCiReportComment({ inputPath: required("input"), artifactUrl: required("artifact-url"), ...(platform ? { platform } : {}) }) });
|
||||
const platform = platformFlag(), target = targetFlag();
|
||||
output({ ok: true, ...await publishCiReportComment({ inputPath: required("input"), artifactUrl: required("artifact-url"), ...(platform ? { platform } : {}), ...(target ? { target } : {}) }) });
|
||||
}
|
||||
|
||||
/** The failure job's comment for a job that died before Explore could post its own: `ci:failure --pr N --head SHA --base SHA [--diagnostics DIR] [--platform P]`. */
|
||||
export async function ciFailure(): Promise<void> {
|
||||
const platform = platformFlag();
|
||||
const platform = platformFlag(), target = targetFlag();
|
||||
const repository = process.env.GITHUB_REPOSITORY, runId = process.env.GITHUB_RUN_ID, runAttempt = process.env.GITHUB_RUN_ATTEMPT;
|
||||
if (!repository || !runId || !runAttempt) throw new CiError({ code: "CONFIG_MISSING", stage: "preflight", message: "GITHUB_REPOSITORY, GITHUB_RUN_ID and GITHUB_RUN_ATTEMPT are required",
|
||||
nextAction: "Run ci:failure inside the GitHub Actions failure job." });
|
||||
const pullNumber = Number(required("pr"));
|
||||
if (!Number.isSafeInteger(pullNumber) || pullNumber <= 0) { output({ ok: true, posted: false, reason: "No PR number: the capture job never started." }); return; }
|
||||
output({ ok: true, ...await publishFailureComment({ repository, pullNumber, headSha: required("head"), baseSha: required("base"), runId, runAttempt,
|
||||
...(has("diagnostics") ? { diagnosticsPath: required("diagnostics") } : {}), ...(platform ? { platform } : {}) }) });
|
||||
...(has("diagnostics") ? { diagnosticsPath: required("diagnostics") } : {}), ...(platform ? { platform } : {}), ...(target ? { target } : {}) }) });
|
||||
}
|
||||
|
||||
/** `ci:pr --pr N [--output FILE]`: the live, authorized pull request; its commits go to the step outputs. */
|
||||
@@ -111,8 +111,8 @@ export async function ciPullRequest(): Promise<void> {
|
||||
|
||||
/** `ci:find-baseline --sha SHA [--platform P]`: a reusable baseline artifact of the base commit, if one exists. */
|
||||
export async function ciFindBaseline(): Promise<void> {
|
||||
const platform = platformFlag();
|
||||
const { baseline, warning } = await findOptionalBaseline({ sha: required("sha"), ...(platform ? { platform } : {}) });
|
||||
const platform = platformFlag(), target = targetFlag();
|
||||
const { baseline, warning } = await findOptionalBaseline({ sha: required("sha"), ...(platform ? { platform } : {}), ...(target ? { target } : {}) });
|
||||
if (baseline) await writeStepOutputs(process.env, { id: String(baseline.id), run: String(baseline.run) });
|
||||
if (warning && process.env.GITHUB_ACTIONS) console.log(`::warning title=${warning.code}::${warning.message.replace(/[\r\n]+/g, " ")}`);
|
||||
output({ ok: true, baseline: baseline ?? null, ...(warning ? { warning } : {}) });
|
||||
@@ -140,10 +140,29 @@ export function platformFlag(): ExplorePlatform | undefined {
|
||||
return has("platform") ? oneOf("platform", EXPLORE_PLATFORMS) : undefined;
|
||||
}
|
||||
|
||||
/** The platforms config.yaml captures, for the review workflow's matrix. */
|
||||
/** The `--target` flag, when given: the config.yaml target to capture. */
|
||||
export function targetFlag(): string | undefined {
|
||||
const value = flag("target");
|
||||
if (value !== undefined && !isTargetId(value)) argumentError("--target must be a target id from config.yaml: lowercase letters, digits and dashes.", "target");
|
||||
return value;
|
||||
}
|
||||
|
||||
/** The target `--target` (or `--platform`, from workflows installed before targets) selects. */
|
||||
function targetSelection(): { target?: string; platform?: ExplorePlatform } {
|
||||
const target = targetFlag(), platform = platformFlag();
|
||||
return { ...(target ? { target } : {}), ...(platform ? { platform } : {}) };
|
||||
}
|
||||
|
||||
/** The targets config.yaml captures, as ids (the review workflow's matrix); workflows installed before targets read them as platforms. */
|
||||
export async function configPlatforms(): Promise<void> {
|
||||
const config = await readExploreConfig(flag("project") ?? process.cwd(), flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
|
||||
output({ ok: true, platforms: listPlatforms(config) });
|
||||
output({ ok: true, platforms: configTargets(config).map(target => target.id) });
|
||||
}
|
||||
|
||||
/** The targets config.yaml captures, in order, with their platforms and labels: the review workflow's matrix. */
|
||||
export async function configTargetList(): Promise<void> {
|
||||
const config = await readExploreConfig(flag("project") ?? process.cwd(), flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
|
||||
output({ ok: true, targets: configTargets(config) });
|
||||
}
|
||||
|
||||
async function exists(path: string): Promise<boolean> {
|
||||
@@ -189,7 +208,7 @@ export async function setup(): Promise<void> {
|
||||
|
||||
export async function sourceVerify(): Promise<void> {
|
||||
const headProject = required("head-project");
|
||||
const config = resolvePlatformConfig(await readExploreConfig(headProject, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), platformFlag());
|
||||
const config = resolveTargetConfig(await readExploreConfig(headProject, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), targetSelection());
|
||||
const scope = oneOf("scope", ["all", "changes"] as const, config.exploration.scope);
|
||||
const plan = await buildVerifiedPlan({ baseProject: required("base-project"), headProject,
|
||||
baseSha: required("base-sha"), headSha: required("head-sha"), config, scope, output: required("output") });
|
||||
@@ -201,11 +220,14 @@ export async function captureReview(): Promise<void> {
|
||||
if (!has("base-project") && !has("head-project") && !has("pull-request") && !has("compare")) return localReview();
|
||||
const headProject = required("head-project");
|
||||
const configPath = flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH;
|
||||
const platform = platformFlag();
|
||||
const selection = targetSelection();
|
||||
const rawConfig = await readExploreConfig(headProject, configPath);
|
||||
const config = withRunOverrides(resolvePlatformConfig(rawConfig, platform), { scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller") });
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, selection), { scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
|
||||
if (has("pull-request") === has("compare")) argumentError("Pass --pull-request FILE for a pull request, or --compare FILE for any two commits.", has("compare") ? "compare" : "pull-request");
|
||||
const common = { ...(platform ? { platform } : {}), platforms: listPlatforms(rawConfig), baseProject: required("base-project"), headProject,
|
||||
// A matrix job names its target; its artifacts, report and comment section carry the target's id.
|
||||
const named = selection.target !== undefined || selection.platform !== undefined;
|
||||
const common = { ...(named ? { target: config.target!.id } : {}), ...(selection.platform ? { platform: selection.platform } : {}),
|
||||
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), baseProject: required("base-project"), headProject,
|
||||
output: required("output"), config, configPath, progress: stderrProgress() };
|
||||
const result = has("compare") ? await runCompareCi({ ...common, comparePath: required("compare") })
|
||||
: await runPublicCi({ ...common, pullRequestPath: required("pull-request") });
|
||||
@@ -216,36 +238,41 @@ export async function captureReview(): Promise<void> {
|
||||
|
||||
export async function captureBaseline(): Promise<void> {
|
||||
const project = required("project");
|
||||
const platform = platformFlag();
|
||||
const config = withRunOverrides(resolvePlatformConfig(await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), platform), { controller: flag("controller") });
|
||||
output({ ok: true, ...await runBaselineCi({ ...(platform ? { platform } : {}), project, sha: required("sha"), output: required("output"), config, progress: stderrProgress() }) });
|
||||
const config = withRunOverrides(resolveTargetConfig(await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), 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, progress: stderrProgress() }) });
|
||||
}
|
||||
|
||||
/** `capture` (or `capture:review`) `[--base REF] [--head REF | --committed]`: a local review, opened in the Viewer or hosted with --upload. */
|
||||
async function localReview(): Promise<void> {
|
||||
const platform = platformFlag();
|
||||
const result = await runLocalReview({ project: flag("project") ?? process.cwd(), base: flag("base"), head: flag("head"),
|
||||
const platform = platformFlag(), target = targetFlag();
|
||||
const parallel = has("parallel") ? positiveInteger("parallel") : undefined;
|
||||
const result = await runLocalReview({ project: flag("project") ?? process.cwd(), base: flag("base"), head: flag("head"), ...(target ? { target } : {}),
|
||||
...(parallel ? { parallel } : {}),
|
||||
// --include-untracked is accepted from before untracked files were included by default.
|
||||
committed: has("committed"), uncommitted: has("uncommitted"), ...(platform ? { platform } : {}),
|
||||
scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), cache: !has("no-cache"), configPath: flag("config"), progress: stderrProgress() });
|
||||
scope: flag("scope"), expiresIn: flag("expires-in"), controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack"), cache: !has("no-cache"), configPath: flag("config"), progress: stderrProgress() });
|
||||
if (has("output")) {
|
||||
for (const report of result.reports) {
|
||||
const target = resolve(required("output"), report.platform);
|
||||
await cp(report.directory, join(target, "report"), { recursive: true });
|
||||
await cp(report.zip, join(target, "report.zip"));
|
||||
report.directory = join(target, "report"); report.zip = join(target, "report.zip");
|
||||
const destination = resolve(required("output"), report.target.id);
|
||||
await cp(report.directory, join(destination, "report"), { recursive: true });
|
||||
await cp(report.zip, join(destination, "report.zip"));
|
||||
report.directory = join(destination, "report"); report.zip = join(destination, "report.zip");
|
||||
}
|
||||
// The reports now live under --output; the temporary copies are not needed.
|
||||
await rm(result.work, { recursive: true, force: true });
|
||||
}
|
||||
const summary = { ok: true, runId: result.runId, base: result.base, head: result.head,
|
||||
reports: result.reports.map(({ platform, directory, zip, changes, device }) => ({ platform, directory, zip, ...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) })) };
|
||||
const zips = await Promise.all(result.reports.map(async report => ({ platform: report.platform, zip: new Uint8Array(await readFile(report.zip)),
|
||||
// A target that failed outright has no report; the others still open, save and upload, and the command exits 1.
|
||||
if (result.failures.length) process.exitCode = 1;
|
||||
const summary = { ok: result.failures.length === 0, runId: result.runId, base: result.base, head: result.head,
|
||||
...(result.failures.length ? { failures: result.failures.map(({ target, error }) => ({ target: target.id, code: error.code, message: error.message })) } : {}),
|
||||
reports: result.reports.map(({ platform, target, directory, zip, changes, device }) => ({ platform, target: target.id, label: target.label, directory, zip,
|
||||
...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) })) };
|
||||
const zips = await Promise.all(result.reports.map(async report => ({ platform: report.platform, target: report.target, zip: new Uint8Array(await readFile(report.zip)),
|
||||
...(report.changes === undefined ? {} : { changes: report.changes }), ...(report.device ? { device: report.device } : {}) })));
|
||||
// Kept among the saved runs, with the commits' subjects (an uncommitted head is named by the commit under it).
|
||||
const project = resolve(flag("project") ?? process.cwd());
|
||||
const headSubject = commitSubject(project, result.head.uncommitted ? `${result.head.sha}^` : result.head.sha), baseSubject = commitSubject(project, result.base.sha);
|
||||
const saved = await keepReports(zips.map(({ platform, zip }) => ({ platform, zip })), { subjects: { ...(headSubject ? { head: headSubject } : {}), ...(baseSubject ? { base: baseSubject } : {}) },
|
||||
const saved = await keepReports(zips.map(({ platform, target, zip }) => ({ platform, target, zip })), { subjects: { ...(headSubject ? { head: headSubject } : {}), ...(baseSubject ? { base: baseSubject } : {}) },
|
||||
...(result.head.uncommitted?.length ? { uncommittedFiles: result.head.uncommitted.length } : {}) });
|
||||
if (has("upload")) {
|
||||
const preview = result.config.report?.preview;
|
||||
@@ -262,7 +289,7 @@ async function localReview(): Promise<void> {
|
||||
}
|
||||
if (has("json") || has("no-open")) {
|
||||
if (has("json")) output(summary);
|
||||
else for (const report of result.reports) console.log(`${report.platform}: ${report.zip}`);
|
||||
else for (const report of result.reports) console.log(`${report.target.id}: ${report.zip}`);
|
||||
return;
|
||||
}
|
||||
const server = await startLocalReportServer({ reports: zips, ...(has("port") ? { port: nonNegativeInteger("port") } : {}) });
|
||||
|
||||
+19
-11
@@ -15,10 +15,10 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
|
||||
doctor [--project DIRECTORY] [--offline] [--no-github] [--check-model] [--json]
|
||||
(checks every setup step and prints the next action for each problem; exits 1 until ready)
|
||||
(--offline skips EAS and GitHub; --check-model sends one small request with the local provider key)
|
||||
doctor --capture [--project DIRECTORY] [--output DIRECTORY] [--platform ios|android] [--controller agent-device|argent] [--yes]
|
||||
doctor --capture [--project DIRECTORY] [--output DIRECTORY] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--yes]
|
||||
(captures the committed HEAD like the baseline workflow, with your eas login, and reports each route)
|
||||
capture [--base REF] [--head REF | --committed] [--platform ios|android] [--scope all|changes]
|
||||
[--controller agent-device|argent] [--upload [--expires-in 7d|30d|never]] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
|
||||
capture [--base REF] [--head REF | --committed] [--target ID | --platform ios|android] [--parallel N] [--scope all|changes]
|
||||
[--controller agent-device|argent] [--simulator eas|local] [--repack eas|local] [--upload [--expires-in 7d|30d|never]] [--no-open] [--no-cache] [--output DIRECTORY] [--project DIRECTORY]
|
||||
(on this machine: checks out both commits in temporary worktrees, captures them with your eas login and your
|
||||
local claude or codex login, and opens the report; the head is HEAD with your uncommitted changes, as eas build
|
||||
uploads them (--committed, or cli.requireCommit in eas.json, leaves them out); the base defaults to where HEAD
|
||||
@@ -26,7 +26,13 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
|
||||
without .expo-explore/config.yaml it uses the defaults setup would write;
|
||||
it runs both commits' code as you, so review only commits you would run; capture:review is the same command;
|
||||
--controller argent drives the simulator with Argent instead of agent-device, the default (or set
|
||||
capture.controller in config.yaml); Argent cannot switch appearance yet, so it captures one appearance)
|
||||
capture.controller in config.yaml); on EAS Simulator Argent captures one appearance, since it cannot switch it yet;
|
||||
--simulator local runs each commit on a simulator (Xcode) or emulator (Android SDK) Explore starts on this
|
||||
machine, instead of EAS Simulator, and removes it afterwards (or set capture.simulator in config.yaml); builds
|
||||
still run on EAS, and the host switches appearance for either controller; the app is repacked with the route
|
||||
observer on this machine too (--repack eas, or capture.repack, keeps the hosted EAS job);
|
||||
with targets in config.yaml it reviews them at once (--parallel N at most N at a time; the targets of a platform
|
||||
share each commit's build), --target ID one of them, --platform those of a platform)
|
||||
view [--catalog FILE] [--port N] [--no-open]
|
||||
(opens a report in the Viewer)
|
||||
reports [list | open ID | add REPORT... | upload ID | rm ID | prune] [--all] [--json]
|
||||
@@ -62,27 +68,29 @@ const BINARY = `Prebuilt apps (no source needed; runs on EAS Simulator with your
|
||||
Afterwards: view --dir DIRECTORY, screen:list --dir DIRECTORY, gap:list --dir DIRECTORY`;
|
||||
|
||||
const CI = `CI (the installed workflows run these; they manage remote EAS Simulator sessions):
|
||||
config:targets [--project DIRECTORY] [--config FILE]
|
||||
(lists the targets config.yaml captures, with their platforms and labels; the review workflow's matrix)
|
||||
config:platforms [--project DIRECTORY] [--config FILE]
|
||||
(lists the platforms config.yaml captures; the review workflow's matrix)
|
||||
capture:review --base-project DIRECTORY --head-project DIRECTORY (--pull-request FILE | --compare FILE)
|
||||
--output TEMP_DIRECTORY [--config .expo-explore/config.yaml] [--platform ios|android] [--controller agent-device|argent]
|
||||
--output TEMP_DIRECTORY [--config .expo-explore/config.yaml] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local]
|
||||
(--compare reviews any two commits without a PR: {"origin":"compare","repositoryId","repository","base":{ref,sha},"head":{ref,sha}})
|
||||
capture:baseline --project DIRECTORY --sha COMMIT --output TEMP_DIRECTORY [--config FILE] [--platform ios|android] [--controller agent-device|argent]
|
||||
capture:baseline --project DIRECTORY --sha COMMIT --output TEMP_DIRECTORY [--config FILE] [--target ID | --platform ios|android] [--controller agent-device|argent] [--simulator eas|local] [--repack eas|local]
|
||||
source:verify --base-project DIRECTORY --head-project DIRECTORY
|
||||
--base-sha COMMIT --head-sha COMMIT --output DIRECTORY [--config FILE] [--scope all|changes] [--platform ios|android]
|
||||
--base-sha COMMIT --head-sha COMMIT --output DIRECTORY [--config FILE] [--scope all|changes] [--target ID | --platform ios|android]
|
||||
compare --baseline DIRECTORY --current DIRECTORY --output FILE
|
||||
[--review-output FILE] [--catalog-output FILE] [--catalog-name NAME]
|
||||
[--base-surface-coverage FILE] [--head-surface-coverage FILE]
|
||||
export:web --catalog FILE --output DIRECTORY
|
||||
ci:report --input REPORT_INPUT --output DIRECTORY [--platform ios|android]
|
||||
ci:publish --input REPORT_INPUT --artifact-url GITHUB_ARTIFACT_URL [--platform ios|android]
|
||||
ci:report --input REPORT_INPUT --output DIRECTORY [--target ID | --platform ios|android]
|
||||
ci:publish --input REPORT_INPUT --artifact-url GITHUB_ARTIFACT_URL [--target ID | --platform ios|android]
|
||||
ci:publish --inputs DIRECTORY (one <platform>/ subdirectory per captured platform)
|
||||
ci:deploy --input REPORT_INPUT --report REPORT_DIR --artifact-url GITHUB_ARTIFACT_URL [--platform ios|android]
|
||||
ci:deploy --input REPORT_INPUT --report REPORT_DIR --artifact-url GITHUB_ARTIFACT_URL [--target ID | --platform ios|android]
|
||||
ci:deploy --inputs DIRECTORY --reports DIRECTORY
|
||||
ci:pr --pr N [--output FILE] [--app-dir DIRECTORY]
|
||||
(resolves the live PR and refuses it unless it is open, from this repository, and by a trusted author)
|
||||
ci:compare-refs --project DIRECTORY --base REF --head REF [--output FILE]
|
||||
ci:find-baseline --sha COMMIT [--platform ios|android]
|
||||
ci:find-baseline --sha COMMIT [--target ID | --platform ios|android]
|
||||
ci:after-capture --output TEMP_DIRECTORY --checkout DIRECTORY...
|
||||
(stops the capture's EAS Simulator sessions and checks capture left each checkout unchanged)
|
||||
(the ci:* commands write their results to $GITHUB_OUTPUT for the next steps)`;
|
||||
|
||||
+15
-15
@@ -3,10 +3,10 @@ import { readFile, stat } from "node:fs/promises";
|
||||
import { basename, dirname, join, relative, resolve, sep } from "node:path";
|
||||
import { DEFAULT_BINARY_PROJECT } from "../binary/run.js";
|
||||
import { pruneCaptureCache, repositoryName } from "../ci/local-review.js";
|
||||
import { readExploreConfig, previewDays, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { readExploreConfig, previewDays, DEFAULT_EXPLORE_CONFIG_PATH, PREVIEW_DEFAULT_DAYS, type ExploreConfig } from "../config/explore-config.js";
|
||||
import { assertHostingExport, deployLocalReports, previewProjectSlug, readReportZip, zipReportDirectory, MAX_REPORT_BYTES, type ReportZipSummary } from "../report/preview-deploy.js";
|
||||
import { startLocalReportServer } from "../report/local-report-server.js";
|
||||
import { findSavedRun, listSavedRuns, pruneSavedRuns, readSavedReports, removeSavedRun, saveRun, savedRunsDirectory, SAVED_RUN_LIMITS, type SavedReport, type SavedRun } from "../report/saved-runs.js";
|
||||
import { findSavedRun, listSavedRuns, pruneSavedRuns, readSavedReports, removeSavedRun, reportTarget, saveRun, savedRunsDirectory, SAVED_RUN_LIMITS, type SavedReport, type SavedRun } from "../report/saved-runs.js";
|
||||
import { openViewerInBrowser } from "../map/viewer-server.js";
|
||||
import { formatBytes, friendlyTime, kindLabel, runPicker, runTitle } from "./reports-picker.js";
|
||||
import { pickIntro } from "./title-intros.js";
|
||||
@@ -70,18 +70,18 @@ async function repositoryPreview(repository: string): Promise<{ preview: Preview
|
||||
|
||||
type ReadReport = Awaited<ReturnType<typeof readReport>>;
|
||||
|
||||
/** Several reports share one link only as one review's platforms; an exploration goes up on its own. */
|
||||
/** Several reports share one link only as one review's targets; an exploration goes up on its own. */
|
||||
function assertOneReview(reports: ReadReport[]): void {
|
||||
const [first, ...others] = reports as [ReadReport, ...ReadReport[]];
|
||||
const platforms = new Set<ExplorePlatform>([first.summary.platform]);
|
||||
const targets = new Set<string>([first.summary.target.id]);
|
||||
for (const report of others) {
|
||||
if (platforms.has(report.summary.platform)) throw new CiError({ code: "PREVIEW_REPORTS_INVALID", stage: "preflight",
|
||||
message: `More than one ${report.summary.platform} report: one link holds one report per platform.`, nextAction: "Upload each platform's report once." });
|
||||
platforms.add(report.summary.platform);
|
||||
if (targets.has(report.summary.target.id)) throw new CiError({ code: "PREVIEW_REPORTS_INVALID", stage: "preflight",
|
||||
message: `More than one ${report.summary.target.id} report: one link holds one report per target.`, nextAction: "Upload each target's report once." });
|
||||
targets.add(report.summary.target.id);
|
||||
const a = first.summary, b = report.summary;
|
||||
if (a.kind !== "review" || b.kind !== "review" || a.repository !== b.repository || a.runId !== b.runId || a.base !== b.base || a.head !== b.head) {
|
||||
throw new CiError({ code: "PREVIEW_REPORTS_MISMATCH", stage: "preflight", message: `${first.path} and ${report.path} are not the same review's platforms.`,
|
||||
nextAction: "Upload the reports of one review together (one per platform), and anything else on its own." });
|
||||
throw new CiError({ code: "PREVIEW_REPORTS_MISMATCH", stage: "preflight", message: `${first.path} and ${report.path} are not the same review's targets.`,
|
||||
nextAction: "Upload the reports of one review together (one per target), and anything else on its own." });
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -100,13 +100,13 @@ async function hostReports(reports: ReadReport[]): Promise<void> {
|
||||
const expiresAfterDays = has("expires-in") ? previewDays(required("expires-in"), "--expires-in")
|
||||
: preview ? preview.expiresAfterDays : review ? PREVIEW_DEFAULT_DAYS : EXPLORATION_DEFAULT_DAYS;
|
||||
const hosted = await deployLocalReports({ project, ...(owner ? { owner } : {}), expiresAfterDays,
|
||||
reports: reports.map(report => ({ platform: report.summary.platform, zip: report.zip,
|
||||
reports: reports.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip,
|
||||
...(report.summary.changes === undefined ? {} : { changes: report.summary.changes }), ...(report.summary.device ? { device: report.summary.device } : {}) })),
|
||||
ownerHint: "Pass --owner with the Expo account that should host the report.",
|
||||
projectHint: "Give this EAS login permission to create projects under the owner, or pass --project with an existing project slug." });
|
||||
if (has("json")) {
|
||||
output({ ok: true, url: hosted.previewUrl, expiresAt: hosted.expiresAt, project: hosted.project, owner: hosted.owner,
|
||||
reports: reports.map(report => ({ path: report.path, platform: report.summary.platform, kind: report.summary.kind })) });
|
||||
reports: reports.map(report => ({ path: report.path, platform: report.summary.platform, target: report.summary.target.id, kind: report.summary.kind })) });
|
||||
return;
|
||||
}
|
||||
console.log(`Report: ${hosted.previewUrl}${hosted.expiresAt ? ` (until ${hosted.expiresAt.slice(0, 10)})` : ""}`);
|
||||
@@ -141,7 +141,7 @@ export async function reportUpload(): Promise<void> {
|
||||
assertOneReview(reports);
|
||||
const review = reports[0]!.summary.kind === "review" ? reports[0]!.summary : undefined;
|
||||
const head = review && commitSubject(process.cwd(), review.head), base = review && commitSubject(process.cwd(), review.base);
|
||||
await keepReports(reports.map(report => ({ platform: report.summary.platform, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
|
||||
await keepReports(reports.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
|
||||
await hostReports(reports);
|
||||
}
|
||||
|
||||
@@ -171,14 +171,14 @@ async function savedRun(id: string | undefined): Promise<SavedRun> {
|
||||
|
||||
async function uploadSavedRun(run: SavedRun): Promise<void> {
|
||||
const reports: ReadReport[] = [];
|
||||
for (const report of await readSavedReports(run)) reports.push({ path: `${run.id}/${report.platform}.zip`, zip: report.zip, summary: await readReportZip(report.zip) });
|
||||
for (const report of await readSavedReports(run)) reports.push({ path: `${run.id}/${reportTarget(report).id}.zip`, zip: report.zip, summary: await readReportZip(report.zip) });
|
||||
await hostReports(reports);
|
||||
}
|
||||
|
||||
function listLines(runs: SavedRun[], now = Date.now()): string[] {
|
||||
if (!runs.length) return ["No saved runs yet. expo-explore capture reviews your branch on this machine, and its report is kept here."];
|
||||
const idWidth = Math.max(...runs.map(run => run.id.length));
|
||||
return [...runs.map(run => `${run.id.padEnd(idWidth)} ${kindLabel(run).padEnd(9)}${runTitle(run)} (${run.platforms.join(", ")}, ${friendlyTime(run.createdAt, now)})`),
|
||||
return [...runs.map(run => `${run.id.padEnd(idWidth)} ${kindLabel(run).padEnd(9)}${runTitle(run)} (${(run.targets?.map(target => target.id) ?? run.platforms).join(", ")}, ${friendlyTime(run.createdAt, now)})`),
|
||||
"", "Open one with: expo-explore reports open <id>"];
|
||||
}
|
||||
|
||||
@@ -204,7 +204,7 @@ export async function reports(): Promise<void> {
|
||||
assertOneReview(read);
|
||||
const review = read[0]!.summary.kind === "review" ? read[0]!.summary : undefined;
|
||||
const head = review && commitSubject(process.cwd(), review.head), base = review && commitSubject(process.cwd(), review.base);
|
||||
const run = await saveRun(read.map(report => ({ platform: report.summary.platform, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
|
||||
const run = await saveRun(read.map(report => ({ platform: report.summary.platform, target: report.summary.target, zip: report.zip })), { subjects: { ...(head ? { head } : {}), ...(base ? { base } : {}) } });
|
||||
if (has("json")) output({ ok: true, run }); else console.log(`Kept ${runTitle(run)} as ${run.id}.`);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -76,7 +76,8 @@ export function runTitle(run: SavedRun): string {
|
||||
}
|
||||
|
||||
const PLATFORM_NAMES: Record<string, string> = { ios: "iOS", android: "Android" };
|
||||
const platforms = (run: SavedRun) => run.platforms.map(platform => PLATFORM_NAMES[platform] ?? platform).join(" ");
|
||||
// A run's targets by label, else its platforms by name, as runs saved before targets list them.
|
||||
const platforms = (run: SavedRun) => run.targets?.map(target => target.label).join(", ") ?? run.platforms.map(platform => PLATFORM_NAMES[platform] ?? platform).join(" ");
|
||||
|
||||
/** The runs the list shows: this repository's (or all) that match the filter, across title, refs, subjects, SHAs and PR number. */
|
||||
export function visibleRuns(state: PickerState): SavedRun[] {
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { parseUnattributedSetting, type UnattributedSetting } from "../capture/unattributed.js";
|
||||
import { parseAppearance, type AppearanceSetting } from "../capture/appearance.js";
|
||||
import { parseLaunchSetting, type LaunchSetting } from "../capture/launch-capture.js";
|
||||
@@ -49,6 +50,25 @@ export type DevicePose = typeof DEVICE_POSES[number];
|
||||
|
||||
export type PlatformConfig = { device?: string; bundleId?: string; easProfile?: string };
|
||||
|
||||
/**
|
||||
* One named capture target (`targets.<id>`): a platform's device, optionally in a pose, captured as its own report.
|
||||
* Several may share a platform, such as a phone and a foldable, or one foldable closed and open.
|
||||
*/
|
||||
export type TargetConfig = { platform: ExplorePlatform; device?: string; pose?: DevicePose; bundleId?: string; easProfile?: string; label?: string;
|
||||
/** This target's device controller and simulator, over `capture.controller` and `capture.simulator`. */
|
||||
controller?: "agent-device" | "argent"; simulator?: "eas" | "local" };
|
||||
|
||||
/**
|
||||
* A target id names directories, report files, CI artifacts and URL parameters, so it is short and plain. `base` and
|
||||
* `head` name a review's own directories.
|
||||
*/
|
||||
export const TARGET_ID_PATTERN = /^[a-z][a-z0-9-]{0,31}$/;
|
||||
const RESERVED_TARGET_IDS = new Set(["base", "head", "report"]);
|
||||
|
||||
export function isTargetId(value: unknown): value is string {
|
||||
return typeof value === "string" && TARGET_ID_PATTERN.test(value) && !RESERVED_TARGET_IDS.has(value) && !value.startsWith("install-");
|
||||
}
|
||||
|
||||
/** Source discovery never consumes a user-authored screen inventory. */
|
||||
export type ExploreConfig = {
|
||||
mode: "deterministic" | "agent";
|
||||
@@ -64,11 +84,22 @@ export type ExploreConfig = {
|
||||
* flat fields describe. Capture code never reads this map; resolvePlatformConfig flattens it.
|
||||
*/
|
||||
platforms?: Partial<Record<ExplorePlatform, PlatformConfig>>;
|
||||
/**
|
||||
* Named capture targets, each captured and reported on its own, in this order. Instead of `platforms`, which is the
|
||||
* same as one target per platform, named after it. Capture code never reads this map; resolveTargetConfig flattens it.
|
||||
*/
|
||||
targets?: Record<string, TargetConfig>;
|
||||
/** Set on a config resolved for one target: the target it captures. */
|
||||
target?: RunTarget;
|
||||
/** `exclude` names routes, as `requiresRoute` does, that stay in the map but are never captured. */
|
||||
exploration: { scope: "changes" | "all"; exclude?: string[] };
|
||||
capture: { maxMinutes: number; maxActions: number; repack: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number;
|
||||
capture: { maxMinutes: number; maxActions: number;
|
||||
/** Where the route observer is bundled into the app, when the config chooses; captureRepack gives the default. */
|
||||
repack?: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number;
|
||||
/** The device controller; absent means agent-device, so configs that never chose one keep their cache recipes. */
|
||||
controller?: "argent" };
|
||||
controller?: "argent";
|
||||
/** Where the app runs: EAS Simulator when absent, or `local`, a simulator Explore creates on this Mac for the run. */
|
||||
simulator?: "local" };
|
||||
parameters?: Record<string, Record<string, string>>;
|
||||
setup?: ExploreSetupAction[];
|
||||
agent?: { provider: "openai" | "anthropic"; model: string; instructions?: string };
|
||||
@@ -243,7 +274,7 @@ function parameters(value: unknown): Record<string, Record<string, string>> {
|
||||
/** Validate and normalize plain data; credential validation is a separate execution gate. */
|
||||
export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
const root = record(value, "config");
|
||||
exactKeys(root, ["mode", "app", "navigation", "device", "platforms", "exploration", "capture", "parameters", "setup", "agent", "report", "ci"], "config");
|
||||
exactKeys(root, ["mode", "app", "navigation", "device", "platforms", "targets", "exploration", "capture", "parameters", "setup", "agent", "report", "ci"], "config");
|
||||
const app = record(root.app, "app");
|
||||
exactKeys(app, ["name", "platform", "bundleId", "easProfile", "scheme"], "app");
|
||||
const device = record(root.device, "device");
|
||||
@@ -254,8 +285,9 @@ 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", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller"], "capture");
|
||||
exactKeys(capture, ["maxMinutes", "maxActions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
|
||||
const controller = literal(capture.controller, ["agent-device", "argent"] as const, "capture.controller", "agent-device");
|
||||
const simulator = literal(capture.simulator, ["eas", "local"] as const, "capture.simulator", "eas");
|
||||
const mode = literal(root.mode, ["deterministic", "agent"] as const, "mode", "deterministic");
|
||||
const name = optionalText(app.name, "app.name", 128);
|
||||
const scheme = app.scheme === undefined ? undefined : customScheme(app.scheme, "app.scheme");
|
||||
@@ -263,6 +295,8 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
const bundleId = applicationId(app.bundleId, "app.bundleId");
|
||||
const easProfile = profileName(app.easProfile, "app.easProfile");
|
||||
const platforms = platformsConfig(root.platforms, platform);
|
||||
const targets = targetsConfig(root.targets, platform);
|
||||
if (platforms && targets) fail("Use targets or platforms, not both", "targets", "Move each platforms entry into targets, with its platform.");
|
||||
let agent: ExploreConfig["agent"];
|
||||
if (root.agent !== undefined || mode === "agent") {
|
||||
const input = record(root.agent, "agent");
|
||||
@@ -290,6 +324,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
},
|
||||
device: { name: text(device.name, "device.name", 128), ...(pose === undefined ? {} : { pose }) },
|
||||
...(platforms === undefined ? {} : { platforms }),
|
||||
...(targets === undefined ? {} : { targets }),
|
||||
exploration: {
|
||||
scope: literal(exploration.scope, ["changes", "all"] as const, "exploration.scope", "changes"),
|
||||
...(exploration.exclude === undefined ? {} : { exclude: excludedRoutes(exploration.exclude) }),
|
||||
@@ -297,13 +332,14 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
capture: {
|
||||
maxMinutes: positiveInteger(capture.maxMinutes, "capture.maxMinutes", 30),
|
||||
maxActions: positiveInteger(capture.maxActions, "capture.maxActions", 500),
|
||||
repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack", "eas"),
|
||||
...(capture.repack === undefined ? {} : { repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack") }),
|
||||
appearance: parseAppearance(capture.appearance, "capture.appearance"),
|
||||
launch: parseLaunchSetting(capture.launch, "capture.launch"),
|
||||
reset: parseRouteResetSetting(capture.reset, "capture.reset"),
|
||||
unattributed: parseUnattributedSetting(capture.unattributed, "capture.unattributed"),
|
||||
...(capture.readinessSeconds !== undefined ? { readinessSeconds: positiveInteger(capture.readinessSeconds, "capture.readinessSeconds") } : {}),
|
||||
...(controller === "argent" ? { controller } : {}),
|
||||
...(simulator === "local" ? { simulator } : {}),
|
||||
},
|
||||
...(root.parameters === undefined ? {} : { parameters: parameters(root.parameters) }),
|
||||
...(root.setup === undefined ? {} : { setup: setupActions(root.setup, scheme) }),
|
||||
@@ -348,16 +384,103 @@ function platformsConfig(value: unknown, primary: ExplorePlatform): ExploreConfi
|
||||
return result;
|
||||
}
|
||||
|
||||
function targetsConfig(value: unknown, primary: ExplorePlatform): ExploreConfig["targets"] {
|
||||
if (value === undefined) return undefined;
|
||||
const mapping = record(value, "targets");
|
||||
const ids = Object.keys(mapping);
|
||||
if (!ids.length) fail("targets must name at least one target", "targets");
|
||||
if (ids.length > 8) fail("targets can name at most 8 targets", "targets");
|
||||
const result: NonNullable<ExploreConfig["targets"]> = {};
|
||||
for (const id of ids) {
|
||||
const label = `targets.${id}`;
|
||||
if (!isTargetId(id)) fail(`${label}: a target id is lowercase letters, digits and dashes, starts with a letter, and is not base, head or report`, label);
|
||||
const entry = record(mapping[id], label);
|
||||
exactKeys(entry, ["platform", "device", "pose", "bundleId", "easProfile", "label", "controller", "simulator"], label);
|
||||
const platform = literal(entry.platform, EXPLORE_PLATFORMS, `${label}.platform`);
|
||||
const device = optionalText(entry.device, `${label}.device`, 128);
|
||||
const pose = entry.pose === undefined ? undefined : literal(entry.pose, DEVICE_POSES, `${label}.pose`);
|
||||
const bundleId = entry.bundleId === undefined ? undefined : applicationId(entry.bundleId, `${label}.bundleId`);
|
||||
const easProfile = entry.easProfile === undefined ? undefined : profileName(entry.easProfile, `${label}.easProfile`);
|
||||
const name = optionalText(entry.label, `${label}.label`, 64);
|
||||
const controller = entry.controller === undefined ? undefined : literal(entry.controller, ["agent-device", "argent"] as const, `${label}.controller`);
|
||||
const simulator = entry.simulator === undefined ? undefined : literal(entry.simulator, ["eas", "local"] as const, `${label}.simulator`);
|
||||
if (platform !== primary && (bundleId === undefined || easProfile === undefined)) {
|
||||
fail(`${label} needs bundleId and easProfile`, label,
|
||||
`Set ${label}.bundleId to the app's ${platform === "android" ? "android.package" : "ios.bundleIdentifier"} and ${label}.easProfile to an eas.json profile that builds a ${platform === "android" ? "signed APK (android.buildType: apk)" : "simulator app (ios.simulator: true)"}.`);
|
||||
}
|
||||
result[id] = { platform, ...(device === undefined ? {} : { device }), ...(pose === undefined ? {} : { pose }), ...(bundleId === undefined ? {} : { bundleId }),
|
||||
...(easProfile === undefined ? {} : { easProfile }), ...(name === undefined ? {} : { label: name }),
|
||||
...(controller === undefined ? {} : { controller }), ...(simulator === undefined ? {} : { simulator }) };
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/** The platforms a configuration captures, iOS first; the flat fields alone describe one. */
|
||||
export function configPlatforms(config: ExploreConfig): ExplorePlatform[] {
|
||||
if (config.targets) return EXPLORE_PLATFORMS.filter(platform => Object.values(config.targets!).some(target => target.platform === platform));
|
||||
return config.platforms ? EXPLORE_PLATFORMS.filter(platform => config.platforms![platform] !== undefined) : [config.app.platform];
|
||||
}
|
||||
|
||||
const PLATFORM_LABELS: Record<ExplorePlatform, string> = { ios: "iOS", android: "Android" };
|
||||
|
||||
/** The targets a configuration captures, in order: its `targets`, else one per platform, named after it. */
|
||||
export function configTargets(config: ExploreConfig): RunTarget[] {
|
||||
if (!config.targets) return configPlatforms(config).map(platform => ({ id: platform, platform, label: PLATFORM_LABELS[platform] }));
|
||||
return Object.entries(config.targets).map(([id, target]) => ({ id, platform: target.platform,
|
||||
label: target.label ?? `${target.device ?? (target.platform === config.app.platform ? config.device.name : DEFAULT_ANDROID_DEVICE)}${target.pose ? ` (${target.pose})` : ""}` }));
|
||||
}
|
||||
|
||||
/**
|
||||
* The flat configuration capture consumes for one target, with `target` naming it. `--target` names one; `--platform`
|
||||
* names the target of that platform, when only one has it; with neither, the config must have a single target.
|
||||
*/
|
||||
export function resolveTargetConfig(config: ExploreConfig, selection: { target?: string | undefined; platform?: ExplorePlatform | undefined } = {}): ExploreConfig {
|
||||
const targets = configTargets(config);
|
||||
if (!config.targets) {
|
||||
if (selection.target !== undefined && !targets.some(target => target.id === selection.target)) throw targetNotConfigured(selection.target, targets);
|
||||
const resolved = resolvePlatformConfig(config, (selection.target as ExplorePlatform | undefined) ?? selection.platform);
|
||||
return { ...resolved, target: targets.find(target => target.platform === resolved.app.platform)! };
|
||||
}
|
||||
let chosen: RunTarget | undefined;
|
||||
if (selection.target !== undefined) {
|
||||
chosen = targets.find(target => target.id === selection.target);
|
||||
if (!chosen) throw targetNotConfigured(selection.target, targets);
|
||||
} else {
|
||||
const candidates = selection.platform ? targets.filter(target => target.platform === selection.platform) : targets;
|
||||
if (candidates.length !== 1) throw new CiError({ code: candidates.length ? "TARGET_REQUIRED" : "PLATFORM_NOT_CONFIGURED", stage: "preflight",
|
||||
message: candidates.length ? `${DEFAULT_EXPLORE_CONFIG_PATH} lists ${candidates.map(target => target.id).join(", ")}; pass --target to select one.`
|
||||
: `${DEFAULT_EXPLORE_CONFIG_PATH} has no ${selection.platform} target.`,
|
||||
nextAction: "Run expo-explore setup --workflows to install the matrix workflows, which pass --target per job." });
|
||||
chosen = candidates[0]!;
|
||||
}
|
||||
const entry = config.targets[chosen.id]!;
|
||||
const primary = entry.platform === config.app.platform;
|
||||
const { targets: _targets, platforms: _platforms, ...rest } = config;
|
||||
void _targets; void _platforms;
|
||||
// A target's own controller and simulator; agent-device and EAS Simulator are the defaults, which leave the config as it was.
|
||||
const { controller: _controller, simulator: _simulator, ...capture } = config.capture;
|
||||
void _controller; void _simulator;
|
||||
const controller = entry.controller ?? config.capture.controller ?? "agent-device";
|
||||
const simulator = entry.simulator ?? config.capture.simulator ?? "eas";
|
||||
return { ...rest, target: chosen,
|
||||
capture: { ...capture, ...(controller === "argent" ? { controller } : {}), ...(simulator === "local" ? { simulator } : {}) },
|
||||
app: { ...config.app, platform: entry.platform, bundleId: entry.bundleId ?? config.app.bundleId, easProfile: entry.easProfile ?? config.app.easProfile },
|
||||
device: { name: entry.device ?? (primary ? config.device.name : DEFAULT_ANDROID_DEVICE),
|
||||
// A target's own pose; else the top-level one, which belongs to the primary platform's device.
|
||||
...(entry.pose ? { pose: entry.pose } : primary && !entry.device && config.device.pose ? { pose: config.device.pose } : {}) } };
|
||||
}
|
||||
|
||||
function targetNotConfigured(id: string, targets: RunTarget[]): CiError {
|
||||
return new CiError({ code: "TARGET_NOT_CONFIGURED", stage: "preflight", message: `${DEFAULT_EXPLORE_CONFIG_PATH} has no target ${id}.`,
|
||||
nextAction: `Capture one of: ${targets.map(target => target.id).join(", ")}.` });
|
||||
}
|
||||
|
||||
/**
|
||||
* The flat configuration capture consumes for one platform: `app.platform`, `app.bundleId`,
|
||||
* `app.easProfile`, and `device.name` describe that platform; everything else is shared.
|
||||
*/
|
||||
export function resolvePlatformConfig(config: ExploreConfig, platform: ExplorePlatform | undefined): ExploreConfig {
|
||||
if (config.targets) return resolveTargetConfig(config, { platform });
|
||||
const platforms = configPlatforms(config);
|
||||
if (platform === undefined) {
|
||||
if (platforms.length > 1) throw new CiError({ code: "PLATFORM_REQUIRED", stage: "preflight",
|
||||
@@ -385,13 +508,22 @@ export function resolvePlatformConfig(config: ExploreConfig, platform: ExplorePl
|
||||
* every screen (`scope: all`) and keep its hosted link (`expiresIn: never`). `expiresIn` changes nothing when the
|
||||
* config hosts no report.
|
||||
*/
|
||||
export function withRunOverrides(config: ExploreConfig, overrides: { scope?: string | undefined; expiresIn?: string | undefined; controller?: string | undefined }): ExploreConfig {
|
||||
export function withRunOverrides(config: ExploreConfig, overrides: { scope?: string | undefined; expiresIn?: string | undefined; controller?: string | undefined; simulator?: string | undefined; repack?: string | undefined }): ExploreConfig {
|
||||
let result = config;
|
||||
if (overrides.repack !== undefined) {
|
||||
if (overrides.repack !== "eas" && overrides.repack !== "local") fail("--repack must be eas or local", "--repack");
|
||||
result = { ...result, capture: { ...result.capture, repack: overrides.repack } };
|
||||
}
|
||||
if (overrides.controller !== undefined) {
|
||||
if (overrides.controller !== "agent-device" && overrides.controller !== "argent") fail("--controller must be agent-device or argent", "--controller");
|
||||
const { controller: _previous, ...capture } = result.capture;
|
||||
result = { ...result, capture: { ...capture, ...(overrides.controller === "argent" ? { controller: "argent" as const } : {}) } };
|
||||
}
|
||||
if (overrides.simulator !== undefined) {
|
||||
if (overrides.simulator !== "eas" && overrides.simulator !== "local") fail("--simulator must be eas or local", "--simulator");
|
||||
const { simulator: _previous, ...capture } = result.capture;
|
||||
result = { ...result, capture: { ...capture, ...(overrides.simulator === "local" ? { simulator: "local" as const } : {}) } };
|
||||
}
|
||||
if (overrides.scope !== undefined) {
|
||||
if (overrides.scope !== "changes" && overrides.scope !== "all") fail("--scope must be changes or all", "--scope");
|
||||
result = { ...result, exploration: { ...result.exploration, scope: overrides.scope } };
|
||||
@@ -404,6 +536,14 @@ export function withRunOverrides(config: ExploreConfig, overrides: { scope?: str
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Where a capture repacks the app with the route observer: the config's choice, else on this machine when the app runs on
|
||||
* a local simulator (which already needs Xcode or the Android SDK), and in a hosted EAS job otherwise.
|
||||
*/
|
||||
export function captureRepack(config: ExploreConfig): "eas" | "local" {
|
||||
return config.capture.repack ?? (config.capture.simulator === "local" ? "local" : "eas");
|
||||
}
|
||||
|
||||
/** `expiresAfter` is a whole number of days (`30d`, `30 days`, or `30`), at most PREVIEW_MAX_DAYS, or `never` (null). */
|
||||
export function previewDays(value: unknown, field: string): number | null {
|
||||
if (value === undefined) return PREVIEW_DEFAULT_DAYS;
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { validateSourceRoutes, type SourceRoute } from "./source-route.js";
|
||||
import type { SourceCapturePlan, SurfaceSourceScope } from "../source/capture-plan.js";
|
||||
import type { ReviewPresentation } from "./review.js";
|
||||
@@ -249,6 +250,10 @@ export type PublicReview = {
|
||||
homeIndicatorBandPercent?: number;
|
||||
/** Every platform the config captures, so the Viewer can offer the sibling platform's report of the same run. */
|
||||
platforms?: Array<"ios" | "android">;
|
||||
/** The target this report captured; absent in reports from before targets, whose target is their platform. */
|
||||
target?: RunTarget;
|
||||
/** Every target the config captures, in config order, when more than one: the sibling reports of the same run. */
|
||||
targets?: RunTarget[];
|
||||
/** Every appearance the capture rendered, primary first, when it rendered several; surfaces then carry their `colorScheme`. */
|
||||
colorSchemes?: Array<"light" | "dark">;
|
||||
};
|
||||
|
||||
+46
-6
@@ -60,18 +60,51 @@ export type AgentContext = {
|
||||
pageUrl: string;
|
||||
/** This report's platform when the deployment serves several, so links keep `?platform=`. */
|
||||
platform?: string | undefined;
|
||||
/** The distinct platforms the deployment serves. */
|
||||
platforms: string[];
|
||||
/** This report's target id when the deployment serves several targets, so links keep selecting it. */
|
||||
target?: string | undefined;
|
||||
/** Every target the deployment serves, in config order; absent from contexts that predate targets. */
|
||||
targets?: AgentTarget[] | undefined;
|
||||
expiresAt: string | null;
|
||||
};
|
||||
export type AgentTarget = { id: string; platform: string; label?: string | undefined };
|
||||
|
||||
/**
|
||||
* The query parameter that keeps a link on this report: `target=<id>`, or `platform=<id>` for a target named after its
|
||||
* platform (as links were before targets), or the platform alone in contexts that predate targets.
|
||||
*/
|
||||
function selection(context: AgentContext): [string, string] | undefined {
|
||||
if (context.target && (context.targets?.length ?? 0) > 1) return [context.target === "ios" || context.target === "android" ? "platform" : "target", context.target];
|
||||
return context.platform && context.platforms.length > 1 ? ["platform", context.platform] : undefined;
|
||||
}
|
||||
/** The same page for another target of the deployment. */
|
||||
function targetPageUrl(context: AgentContext, id: string): string {
|
||||
return viewerUrl({ ...context, target: id }, {});
|
||||
}
|
||||
|
||||
const apiUrl = (context: AgentContext, path = "") => `${context.pageUrl}/api/${AGENT_API_VERSION}${path}`;
|
||||
function viewerUrl(context: AgentContext, params: Record<string, string> = {}): string {
|
||||
const url = new URL(context.pageUrl);
|
||||
if (context.platform && context.platforms.length > 1) url.searchParams.set("platform", context.platform);
|
||||
const selected = selection(context);
|
||||
if (selected) url.searchParams.set(...selected);
|
||||
for (const [key, value] of Object.entries(params)) url.searchParams.set(key, value);
|
||||
return url.href;
|
||||
}
|
||||
const withPlatform = (context: AgentContext, url: string) => (context.platform && context.platforms.length > 1 ? `${url}${url.includes("?") ? "&" : "?"}platform=${context.platform}` : url);
|
||||
const withPlatform = (context: AgentContext, url: string) => {
|
||||
const selected = selection(context);
|
||||
return selected ? `${url}${url.includes("?") ? "&" : "?"}${selected[0]}=${selected[1]}` : url;
|
||||
};
|
||||
/** The targets as the summary lists them: each with its label and Viewer link, this one marked. */
|
||||
function targetList(context: AgentContext): Json[] | undefined {
|
||||
if (!context.targets || context.targets.length < 2) return undefined;
|
||||
return context.targets.map(target => defined({ id: target.id, platform: target.platform, label: target.label, current: target.id === context.target ? true : undefined,
|
||||
viewer: targetPageUrl(context, target.id), summary: `${apiUrl(context)}?${new URLSearchParams([selection({ ...context, target: target.id })!]).toString()}` }));
|
||||
}
|
||||
/** What the index title names this report by: the target's label when the deployment serves several. */
|
||||
function targetLabel(context: AgentContext): string | undefined {
|
||||
return (context.targets?.length ?? 0) > 1 ? context.targets!.find(target => target.id === context.target)?.label ?? context.target : undefined;
|
||||
}
|
||||
|
||||
type Page<T> = { items: T[]; total: number; count: number; hasMore: boolean; nextCursor?: string };
|
||||
function page<T>(items: T[], params: URLSearchParams): Page<T> | undefined {
|
||||
@@ -177,7 +210,7 @@ function reviewSummary(context: AgentContext, review: Json): Json {
|
||||
kind: "pr-review", api: AGENT_API_VERSION, contract: str(review.contract),
|
||||
pullRequest: defined({ origin: str(pr.origin), repository: str(pr.repository), number: num(pr.number), title: str(pr.title), url: str(pr.url), head: str(rec(pr.head).sha), base: str(rec(pr.base).sha) }),
|
||||
app: defined({ name: str(runtime.appName), version: str(runtime.appVersion), build: str(runtime.appBuildNumber), platform: str(runtime.platform) ?? context.platform, device: rec(runtime.device).model === undefined ? undefined : `${str(rec(runtime.device).model)} ${str(rec(runtime.device).osVersion) ?? ""}`.trim() }),
|
||||
createdAt: str(review.createdAt), mode: str(review.mode), platforms: context.platforms, expiresAt: context.expiresAt,
|
||||
createdAt: str(review.createdAt), mode: str(review.mode), platforms: context.platforms, target: context.target, targets: targetList(context), expiresAt: context.expiresAt,
|
||||
screens: { total: surfaces.length, ...counts },
|
||||
links: {
|
||||
screens: withPlatform(context, apiUrl(context, "/screens")), changed: withPlatform(context, apiUrl(context, "/screens?status=modified,accessibility-only,added,removed")),
|
||||
@@ -237,7 +270,7 @@ function explorationSummary(context: AgentContext, report: Json): Json {
|
||||
kind: "exploration", api: AGENT_API_VERSION, contract: str(map.contract),
|
||||
app: defined({ name: str(app.name), bundleId: str(app.bundleId), platform: str(app.platform) ?? context.platform, version: str(app.version), build: str(app.buildNumber), device: device.model === undefined ? undefined : `${str(device.model)} ${str(device.osVersion) ?? ""}`.trim() }),
|
||||
startedAt: str(exploration.startedAt), completedAt: str(exploration.completedAt), stopReason: str(exploration.stopReason), summary: str(exploration.summary),
|
||||
model: str(rec(exploration.model).model), platforms: context.platforms, expiresAt: context.expiresAt,
|
||||
model: str(rec(exploration.model).model), platforms: context.platforms, target: context.target, targets: targetList(context), expiresAt: context.expiresAt,
|
||||
screens: { total: screens.length, coverage: Object.keys(coverage).length ? coverage : undefined },
|
||||
counts: { transitions: arr(map.transitions).length, elements: arr(map.elements).length, journeys: arr(map.journeys).length, gaps: arr(map.gaps).length, frontier: arr(map.frontier).length },
|
||||
links: {
|
||||
@@ -258,12 +291,14 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
|
||||
const links = rec(summary.links) as Record<string, string>;
|
||||
const app = rec(summary.app), screens = rec(summary.screens);
|
||||
const lines: string[] = [];
|
||||
const label = targetLabel(context);
|
||||
const titled = (platform: unknown) => (label ? ` (${escapeMd(label)})` : platform ? ` (${escapeMd(platform)})` : "");
|
||||
if (loaded.kind === "pr-review") {
|
||||
const pr = rec(summary.pullRequest);
|
||||
// A comparison of two commits has a title ("v1.4.0 vs v1.3.0") where a pull request has a number.
|
||||
// A comparison of two commits, or a local review on someone's machine, has no pull request: its title names both refs.
|
||||
const compared = pr.origin === "compare" || pr.origin === "local";
|
||||
lines.push(`# Expo Explore report: ${escapeMd(app.name ?? pr.repository)} ${compared ? escapeMd(pr.title) : `PR #${escapeMd(pr.number)}`}${app.platform ? ` (${escapeMd(app.platform)})` : ""}`, "",
|
||||
lines.push(`# Expo Explore report: ${escapeMd(app.name ?? pr.repository)} ${compared ? escapeMd(pr.title) : `PR #${escapeMd(pr.number)}`}${titled(app.platform)}`, "",
|
||||
`> Visual review of ${compared ? `${escapeMd(pr.repository)} ${escapeMd(pr.title)}` : `pull request ${escapeMd(pr.repository)}#${escapeMd(pr.number)}`} by Expo Explore. ${screens.total} screens: ${screenCounts(screens)}.${context.expiresAt ? ` This link stops serving the report after ${context.expiresAt}.` : ""}`, "",
|
||||
"This URL is the human Viewer. The same report is available as read-only JSON (no credentials beyond this URL):", "",
|
||||
`- [Summary](${links.summary ?? withPlatform(context, apiUrl(context))}): kind, counts by status, app and PR identity, links`,
|
||||
@@ -275,7 +310,7 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
|
||||
`Start with the changed screens. Every item carries a \`viewerUrl\` that opens that screen in the Viewer for a human; [${escapeMd(links.viewerChanges)}](${links.viewerChanges}) opens the list of changes.`);
|
||||
} else {
|
||||
const counts = rec(summary.counts);
|
||||
lines.push(`# Expo Explore exploration: ${escapeMd(app.name)}${app.platform ? ` (${escapeMd(app.platform)})` : ""}`, "",
|
||||
lines.push(`# Expo Explore exploration: ${escapeMd(app.name)}${titled(app.platform)}`, "",
|
||||
`> An agent explored ${escapeMd(app.name)} ${escapeMd(app.version ?? "")} on ${escapeMd(app.device ?? app.platform)} and mapped ${screens.total} screens, ${counts.transitions} transitions, ${counts.elements} elements; ${counts.gaps} coverage gaps. Stopped: ${escapeMd(summary.stopReason)}.${summary.summary ? ` ${escapeMd(summary.summary)}` : ""}${context.expiresAt ? ` This link stops serving the report after ${context.expiresAt}.` : ""}`, "",
|
||||
"This URL is the human Viewer. The same map is available as read-only JSON (no credentials beyond this URL):", "",
|
||||
`- [Summary](${withPlatform(context, apiUrl(context))}): app, device, model, stop reason, counts, links`,
|
||||
@@ -287,6 +322,11 @@ export function agentIndexMarkdown(context: AgentContext, loaded: LoadedReport):
|
||||
`- [Raw exploration.json](${links.raw}): the full map contract`, "",
|
||||
"Start with the screens list, then open the screens you care about. Every item carries a `viewerUrl` that opens it in the Viewer for a human.");
|
||||
}
|
||||
const others = (context.targets ?? []).filter(target => target.id !== context.target);
|
||||
if (label && others.length) {
|
||||
lines.push("", `This link also serves the same run's other targets; each has its own index and JSON API:`, "",
|
||||
...others.map(target => `- [${escapeMd(target.label ?? target.id).replace(/[[\]]/g, "")}](${targetPageUrl(context, target.id)}) (${escapeMd(target.platform)})`));
|
||||
}
|
||||
return lines.join("\n") + "\n";
|
||||
}
|
||||
|
||||
|
||||
+33
-12
@@ -6,7 +6,7 @@ import { createHash } from "node:crypto";
|
||||
import type { ArtifactReport } from "../contracts/artifact-report.js";
|
||||
import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPresentation } from "../contracts/review.js";
|
||||
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
|
||||
import type { ExplorePlatform } from "../config/explore-config.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { upsertStickyComment } from "./pr-comment.js";
|
||||
import { previewLinks, viewerLinks } from "./viewer-links.js";
|
||||
import type { PublicReview } from "../contracts/capture.js";
|
||||
@@ -112,10 +112,23 @@ async function exportCiReportUnchecked(options: { inputPath: string; outputPath:
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* The suffix of this matrix job's artifacts: `--target`, else for a `--platform` caller the captured target when it
|
||||
* has that platform (its id is the platform for a config without targets), else nothing (a workflow without a matrix).
|
||||
*/
|
||||
function reportTarget(options: { target?: string; platform?: ExplorePlatform }, state: PublicCommentState): string | undefined {
|
||||
const target = options.target ?? (options.platform && state.target?.platform === options.platform ? state.target.id : options.platform);
|
||||
if (target !== undefined && !isTargetId(target)) throw new CiError({ code: "TARGET_INVALID", stage: "preflight", message: `${target} is not a target id.`,
|
||||
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
|
||||
return target;
|
||||
}
|
||||
|
||||
/** Finalize only an uploaded artifact from this run while the captured PR is still current. */
|
||||
export async function publishCiReportComment(options: {
|
||||
inputPath: string; artifactUrl: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
|
||||
/** Set by the matrix workflows: the artifact carries the platform suffix and the comment gets one section per platform. */
|
||||
/** Set by the matrix workflows: the artifact carries the target suffix and the comment gets one section per target. */
|
||||
target?: string;
|
||||
/** What callers from before targets pass: the platform of the captured target, whose id then names the artifact. */
|
||||
platform?: ExplorePlatform;
|
||||
/** A verified hosted preview from `ci:deploy`; the comment then links to it as Explore report. */
|
||||
preview?: { url: string; expiresAt: number | null };
|
||||
@@ -135,10 +148,11 @@ export async function publishCiReportComment(options: {
|
||||
nextAction: "Publish the report-input.json produced by this repository's current workflow run and attempt." });
|
||||
}
|
||||
if (pr.origin === "local") throw new Error("Local reports cannot be published as GitHub PR comments");
|
||||
const target = reportTarget(options, input.commentState);
|
||||
const links = viewerLinks({ repository: pr.repository, headSha: pr.head.sha, runId: review.runId,
|
||||
runAttempt: review.runAttempt, configPath: input.commentState.configPath, artifactUrl: options.artifactUrl,
|
||||
...(options.platform ? { platform: options.platform } : {}) });
|
||||
if (options.preview) links.preview = previewLinks(options.preview.url, options.preview.expiresAt, options.platform);
|
||||
...(target ? { target } : {}) });
|
||||
if (options.preview) links.preview = previewLinks(options.preview.url, options.preview.expiresAt, target);
|
||||
else if (input.preview && !options.previewFailed) links.deploying = true;
|
||||
const api = async (path: string) => {
|
||||
let response: Response;
|
||||
@@ -171,7 +185,7 @@ export async function publishCiReportComment(options: {
|
||||
message: "GitHub returned invalid report metadata.", nextAction: "Rerun publication; if the response remains invalid, inspect the GitHub metadata request.", cause: error }); }
|
||||
};
|
||||
const artifact = await api(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
|
||||
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${options.platform ? `-${options.platform}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
|
||||
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${target ? `-${target}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
|
||||
throw new CiError({ code: artifact.expired ? "REPORT_ARTIFACT_EXPIRED" : "REPORT_ARTIFACT_MISMATCH", stage: "publication",
|
||||
message: "The uploaded report artifact is unavailable or belongs to another run",
|
||||
nextAction: artifact.expired ? "Rerun Explore to upload a fresh report artifact." : "Pass the final report artifact from this workflow run and attempt." });
|
||||
@@ -188,9 +202,9 @@ export async function publishCiReportComment(options: {
|
||||
const superseded = current.head?.sha !== pr.head.sha || current.base?.sha !== pr.base.sha;
|
||||
const state: PublicCommentState = { ...input.commentState, phase: "ready", updatedAt: Date.now(),
|
||||
review, links, artifactOnly: true, ...(superseded ? { superseded: true } : {}) };
|
||||
const body = renderPublicComment(state);
|
||||
const body = renderPublicComment(state, undefined, target);
|
||||
let previousBody: string | undefined;
|
||||
try { previousBody = (await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, options.platform),
|
||||
try { previousBody = (await upsertStickyComment({ repository: pr.repository, issueNumber: pr.number, body, ...platformSectionMerge(state, target),
|
||||
token: environment.GITHUB_TOKEN, fetchImpl: transport })).previousBody; }
|
||||
catch (error) { throw toCiError(error, { code: "COMMENT_PUBLICATION_FAILED", stage: "publication",
|
||||
nextAction: "Grant the GitHub token PR comment write permission and retry publication for the current PR head." }); }
|
||||
@@ -200,9 +214,9 @@ export async function publishCiReportComment(options: {
|
||||
|
||||
/**
|
||||
* A comparison has no pull request to comment on: `ci:publish` links its report from the run summary instead,
|
||||
* with the same Open (central Viewer) and zip links a PR comment carries for this platform.
|
||||
* with the same Open (central Viewer) and zip links a PR comment carries for this target, labelled as the comment labels it.
|
||||
*/
|
||||
async function publishCompareSummary(input: CiReportInput, options: { artifactUrl: string; platform?: ExplorePlatform }, environment: NodeJS.ProcessEnv) {
|
||||
async function publishCompareSummary(input: CiReportInput, options: { artifactUrl: string; target?: string; platform?: ExplorePlatform }, environment: NodeJS.ProcessEnv) {
|
||||
const review = input.publicReview; const comparison = review.pullRequest as CompareReviewPresentation;
|
||||
if (review.runId !== environment.GITHUB_RUN_ID || review.runAttempt !== environment.GITHUB_RUN_ATTEMPT
|
||||
|| (environment.GITHUB_REPOSITORY && environment.GITHUB_REPOSITORY !== comparison.repository)) {
|
||||
@@ -210,14 +224,21 @@ async function publishCompareSummary(input: CiReportInput, options: { artifactUr
|
||||
message: "Report input is not from the current repository run and attempt",
|
||||
nextAction: "Publish the report-input.json produced by this repository's current workflow run and attempt." });
|
||||
}
|
||||
const target = reportTarget(options, input.commentState);
|
||||
const links = viewerLinks({ repository: comparison.repository, headSha: comparison.head.sha, runId: review.runId,
|
||||
runAttempt: review.runAttempt, configPath: input.commentState.configPath, artifactUrl: options.artifactUrl,
|
||||
...(options.platform ? { platform: options.platform } : {}) });
|
||||
...(target ? { target } : {}) });
|
||||
const changes = input.commentState.review ?? review;
|
||||
const count = reviewChangeCount({ review: changes }) ?? 0;
|
||||
const platform = (options.platform ?? review.runtime.platform) === "android" ? "Android" : "iOS";
|
||||
const label = summaryText(input.commentState.target?.label ?? review.runtime.target?.label
|
||||
?? ((options.platform ?? review.runtime.platform) === "android" ? "Android" : "iOS"));
|
||||
if (environment.GITHUB_STEP_SUMMARY) {
|
||||
await appendFile(environment.GITHUB_STEP_SUMMARY, `- ${platform} report of ${compareTitleMarkdown(comparison)}: [Open](${links.viewer!.open}) · [zip](${links.download!}) · ${count} ${count === 1 ? "change" : "changes"}\n`);
|
||||
await appendFile(environment.GITHUB_STEP_SUMMARY, `- ${label} report of ${compareTitleMarkdown(comparison)}: [Open](${links.viewer!.open}) · [zip](${links.download!}) · ${count} ${count === 1 ? "change" : "changes"}\n`);
|
||||
}
|
||||
return { artifactUrl: links.viewer!.open, headSha: comparison.head.sha };
|
||||
}
|
||||
|
||||
/** A config-authored label as plain Markdown text on one line. */
|
||||
function summaryText(value: string): string {
|
||||
return value.replace(/[\u0000-\u001f\u007f]+/g, " ").replace(/[\\`*_{}[\]()#+!|<>~]/g, "\\$&").trim().slice(0, 80);
|
||||
}
|
||||
@@ -4,7 +4,7 @@ import { CiError } from "../shared/ci-errors.js";
|
||||
import { renderPublicComment, platformSectionMerge, type PublicCommentState } from "./pr-comment-body.js";
|
||||
import { upsertStickyComment } from "./pr-comment.js";
|
||||
import { viewerLinks } from "./viewer-links.js";
|
||||
import type { ExplorePlatform } from "../config/explore-config.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
|
||||
export type FailureCommentOptions = {
|
||||
repository: string;
|
||||
@@ -15,6 +15,9 @@ export type FailureCommentOptions = {
|
||||
runAttempt: string;
|
||||
/** The directory the failure job downloaded diagnostics artifacts into (`<stage>/<artifact>/…/error.json`). */
|
||||
diagnosticsPath?: string;
|
||||
/** The failed target's id; otherwise the one the first diagnostics artifact's name carries. */
|
||||
target?: string;
|
||||
/** What callers from before targets pass: a platform is the id of its default target. */
|
||||
platform?: ExplorePlatform;
|
||||
configPath?: string;
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
@@ -23,7 +26,9 @@ export type FailureCommentOptions = {
|
||||
|
||||
type Diagnostic = { code: string; stage: string; message: string; nextAction: string };
|
||||
const SHA = /^[0-9a-f]{40}$/;
|
||||
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-(ios|android)$/;
|
||||
// `explore-<kind>-<run>-<attempt>-<target>`: the kind has no digits, so the first number is the run and the rest is the target id.
|
||||
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
|
||||
const artifactTarget = (name: string): string | undefined => { const id = ARTIFACT_DIR.exec(name)?.[1]; return isTargetId(id) ? id : undefined; };
|
||||
|
||||
const MAX_DIAGNOSTIC_BYTES = 32_768;
|
||||
const CODE = /^[A-Z][A-Z0-9_]{1,63}$/;
|
||||
@@ -42,21 +47,23 @@ function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
|
||||
}
|
||||
|
||||
/**
|
||||
* The error.json a failed job left behind and the platform its artifact name carries. A report failure's
|
||||
* diagnostic takes precedence over capture's; a present but unreadable file yields the generic failure
|
||||
* rather than an earlier stage's error, and only regular files count (never symlinks out of the artifact).
|
||||
* The error.json a failed job left behind and the target its artifact name carries (`ios` or `android` for a config
|
||||
* without targets, and for artifacts of versions before targets). A report failure's diagnostic takes precedence over
|
||||
* capture's; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
|
||||
* regular files count (never symlinks out of the artifact). `platform` is set when the target id is a platform's.
|
||||
*/
|
||||
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; platform: ExplorePlatform } | undefined> {
|
||||
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; target: string; platform?: ExplorePlatform } | undefined> {
|
||||
for (const [stage, file] of [["report", "error.json"], ["capture", join("explore-diagnostics", "error.json")]] as const) {
|
||||
const entries = await readdir(join(root, stage), { withFileTypes: true }).catch(() => []);
|
||||
for (const entry of entries.filter(entry => entry.isDirectory() && ARTIFACT_DIR.test(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
|
||||
for (const entry of entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
|
||||
const path = join(root, stage, entry.name, file);
|
||||
const info = await lstat(path).catch(() => undefined);
|
||||
if (!info) continue;
|
||||
const platform = ARTIFACT_DIR.exec(entry.name)![1] as ExplorePlatform;
|
||||
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return { platform };
|
||||
const target = artifactTarget(entry.name)!;
|
||||
const located: { target: string; platform?: ExplorePlatform } = { target, ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) };
|
||||
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located;
|
||||
const diagnostic = parseDiagnostic(await readFile(path, "utf8"), stage);
|
||||
return diagnostic ? { diagnostic, platform } : { platform };
|
||||
return diagnostic ? { diagnostic, ...located } : located;
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
@@ -64,7 +71,7 @@ export async function locateFailureDiagnostic(root: string): Promise<{ diagnosti
|
||||
|
||||
/**
|
||||
* The failure job's comment: a job died outside Explore's own progress comments (install, checkout, a crash
|
||||
* before the pipeline posted), so the sticky comment gets a failed record for that platform from the same
|
||||
* before the pipeline posted), so the sticky comment gets a failed record for that target from the same
|
||||
* renderer every other writer uses. Nothing is posted when the PR is closed; a PR that moved on is marked
|
||||
* superseded so the failure lands under previous runs.
|
||||
*/
|
||||
@@ -75,6 +82,9 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
|
||||
if (!token) throw new CiError({ code: "GITHUB_TOKEN_MISSING", stage: "publication", message: "GITHUB_TOKEN is required to post the failure comment",
|
||||
nextAction: "Pass GITHUB_TOKEN to the failure job with PR comment write permission." });
|
||||
if (!SHA.test(options.headSha) || !SHA.test(options.baseSha)) return { posted: false, reason: "The capture job did not record the PR head and base." };
|
||||
const requested = options.target ?? options.platform;
|
||||
if (requested !== undefined && !isTargetId(requested)) throw new CiError({ code: "TARGET_INVALID", stage: "publication", message: `${requested} is not a target id.`,
|
||||
nextAction: "Pass --target with an id from targets: in .expo-explore/config.yaml (ios or android without targets:)." });
|
||||
const response = await transport(`https://api.github.com/repos/${options.repository}/pulls/${options.pullNumber}`, {
|
||||
headers: { authorization: `Bearer ${token}`, accept: "application/vnd.github+json" }, redirect: "error", signal: AbortSignal.timeout(15_000) });
|
||||
if (!response.ok) throw new CiError({ code: "GITHUB_REQUEST_FAILED", stage: "publication", message: `GitHub PR lookup failed (${response.status})`,
|
||||
@@ -85,7 +95,9 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
|
||||
}
|
||||
const superseded = pr.head?.sha !== options.headSha || pr.base?.sha !== options.baseSha;
|
||||
const located = options.diagnosticsPath ? await locateFailureDiagnostic(options.diagnosticsPath) : undefined;
|
||||
const platform = options.platform ?? located?.platform;
|
||||
const target = requested ?? located?.target;
|
||||
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
|
||||
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
|
||||
const configPath = options.configPath ?? ".expo-explore/config.yaml";
|
||||
const now = Date.now();
|
||||
const diagnostic = located?.diagnostic;
|
||||
@@ -93,7 +105,8 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
|
||||
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
|
||||
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
|
||||
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
|
||||
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath, ...(platform ? { platform } : {}) }),
|
||||
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
|
||||
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
|
||||
startedAt: now, updatedAt: now, artifactOnly: true,
|
||||
...(platform ? { build: { platform, easProfile: "" } } : {}),
|
||||
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
|
||||
@@ -101,7 +114,7 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
|
||||
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
|
||||
...(superseded ? { superseded: true } : {}),
|
||||
};
|
||||
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state),
|
||||
...platformSectionMerge(state, platform), token, fetchImpl: transport });
|
||||
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
|
||||
...platformSectionMerge(state, target), token, fetchImpl: transport });
|
||||
return { posted: true, ...(superseded ? { superseded: true } : {}) };
|
||||
}
|
||||
@@ -4,16 +4,19 @@ import { createServer, type Server } from "node:http";
|
||||
import { extname, resolve, sep } from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import type { ExplorePlatform } from "../config/explore-config.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { reportTarget } from "./saved-runs.js";
|
||||
import { AGENT_API_VERSION, agentApiReply, agentIndexMarkdown, loadReport, prefersHtml, type AgentContext, type LoadedReport } from "./agent-api.js";
|
||||
|
||||
/**
|
||||
* Serve review reports on this machine the way a hosted report serves them: the built Viewer at `/p/<token>`, each
|
||||
* platform's report at `/p/<token>/report.zip?platform=…`, and the platform list at `/p/<token>/reports.json`. The
|
||||
* target's report at `/p/<token>/report.zip?target=…` (or `?platform=…`), and the list at `/p/<token>/reports.json`. The
|
||||
* Viewer already knows this layout, so nothing in it changes. An agent on this machine gets what it gets from a hosted
|
||||
* link: the Markdown index when it fetches `/p/<token>` without asking for HTML, `/p/<token>/llms.txt`, and the JSON
|
||||
* API at `/p/<token>/api/v1/...` (agent-api.ts, shared with the hosted Worker). Loopback only; anything else answers 404.
|
||||
*/
|
||||
export type LocalReport = { platform: ExplorePlatform; zip: Uint8Array; changes?: number; device?: string };
|
||||
/** A report to serve; without a target, it is the one named for its platform. */
|
||||
export type LocalReport = { platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string };
|
||||
export type LocalReportServer = { server: Server; url: string; close: () => Promise<void> };
|
||||
|
||||
const TYPES: Record<string, string> = { ".html": "text/html; charset=utf-8", ".js": "text/javascript; charset=utf-8", ".css": "text/css; charset=utf-8",
|
||||
@@ -27,7 +30,8 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
|
||||
await stat(resolve(viewerRoot, "index.html"));
|
||||
const token = options.token ?? [...randomBytes(32)].map(byte => BASE32[byte % 32]).join("");
|
||||
const page = `/p/${token}`;
|
||||
const listing = JSON.stringify(options.reports.map(report => ({ platform: report.platform,
|
||||
// The hosted listing's shape and key order (preview-deploy.ts), without the hosted file paths.
|
||||
const listing = JSON.stringify(options.reports.map(report => ({ target: reportTarget(report).id, platform: report.platform, label: reportTarget(report).label,
|
||||
...(report.changes === undefined ? {} : { changes: report.changes }), ...(report.device ? { device: report.device } : {}) })));
|
||||
const loaded = new Map<LocalReport, Promise<LoadedReport | undefined>>();
|
||||
let pageUrl = "";
|
||||
@@ -39,9 +43,13 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
|
||||
response.end(body);
|
||||
};
|
||||
if (request.method !== "GET" && request.method !== "HEAD") return send(405, "Method not allowed");
|
||||
// `?platform=` picks one of several reports, the first otherwise; an unknown platform matches nothing.
|
||||
const platforms = url.searchParams.getAll("platform");
|
||||
const report = platforms.length > 1 ? undefined : platforms.length ? options.reports.find(candidate => candidate.platform === platforms[0]) : options.reports[0];
|
||||
// `?target=` picks one of several reports; `?platform=`, from links made before targets, the target named for it, else
|
||||
// the first of that platform; neither, the first. An unknown one matches nothing.
|
||||
const targets = url.searchParams.getAll("target"), platforms = url.searchParams.getAll("platform");
|
||||
const report = targets.length + platforms.length > 1 ? undefined
|
||||
: targets.length ? options.reports.find(candidate => reportTarget(candidate).id === targets[0])
|
||||
: platforms.length ? options.reports.find(candidate => reportTarget(candidate).id === platforms[0]) ?? options.reports.find(candidate => candidate.platform === platforms[0])
|
||||
: options.reports[0];
|
||||
const accept = request.headers.accept ?? null;
|
||||
const isPage = url.pathname === page || url.pathname === `${page}/`;
|
||||
const agentPath = url.pathname.startsWith(`${page}/`) ? url.pathname.slice(page.length) : "";
|
||||
@@ -50,7 +58,8 @@ export async function startLocalReportServer(options: { reports: LocalReport[];
|
||||
if (!loaded.has(report)) loaded.set(report, loadReport(report.zip));
|
||||
const content = await loaded.get(report);
|
||||
if (!content) return send(404, "Not found");
|
||||
const context: AgentContext = { pageUrl, platform: report.platform, platforms: options.reports.map(entry => entry.platform), expiresAt: null };
|
||||
const context: AgentContext = { pageUrl, platform: report.platform, platforms: [...new Set(options.reports.map(entry => entry.platform))], expiresAt: null,
|
||||
target: reportTarget(report).id, targets: options.reports.map(entry => { const { id, platform, label } = reportTarget(entry); return { id, platform, label }; }) };
|
||||
const link = { link: `<${pageUrl}/api/${AGENT_API_VERSION}>; rel="alternate"; type="application/json", <${pageUrl}/llms.txt>; rel="alternate"; type="text/markdown"`, vary: "Accept" };
|
||||
if (isPage || agentPath === "/llms.txt") return send(200, agentIndexMarkdown(context, content), "text/markdown; charset=utf-8", link);
|
||||
const reply = await agentApiReply(context, content, agentPath.slice("/api/v1".length).replace(/\/$/, ""), url.searchParams, accept);
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
import type { PublicReview } from "../contracts/capture.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import type { SimulatorRuntimeMetadata } from "../capture/run.js";
|
||||
import { CI_COMMENT_MARKER } from "./pr-comment.js";
|
||||
import { CHANGE_GROUPS, changeCountText, foldRecord, strongerGroup, historyLine, readCommentRecords, recordLine, recordSummary, type ChangeGroup, type CommentPlatform, type CommentRecords, type HistoryEntry, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, changeCountText, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedRecords, readCommentRecords, recordLabel, recordLine, recordSummary, recordTarget,
|
||||
type ChangeGroup, type CommentTarget, type CommentRecords, type HistoryEntry, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
|
||||
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
|
||||
import type { ReviewPresentation } from "../contracts/review.js";
|
||||
@@ -34,6 +36,10 @@ export type PublicCommentState = {
|
||||
easBuildId?: string;
|
||||
reusedEasBuild?: boolean;
|
||||
};
|
||||
/** The target this run captures; absent in states from before targets (then the target is build.platform). */
|
||||
target?: RunTarget;
|
||||
/** Every target the config captures, in config order, when more than one. */
|
||||
targets?: RunTarget[];
|
||||
runtime?: SimulatorRuntimeMetadata;
|
||||
capture?: {
|
||||
planned: { base: number; head: number };
|
||||
@@ -227,8 +233,6 @@ function contextLines(review: PublicReview): string[] {
|
||||
return lines.length ? [...lines, ""] : [];
|
||||
}
|
||||
|
||||
const PLATFORM_LABELS: Record<CommentPlatform, string> = { ios: "iOS", android: "Android" };
|
||||
const PLATFORM_ORDER: CommentPlatform[] = ["ios", "android"];
|
||||
const SURFACE_ID = /^[A-Za-z0-9._-]{1,200}(@(light|dark))?$/;
|
||||
const MAX_ROWS_PER_GROUP = 200;
|
||||
|
||||
@@ -242,9 +246,28 @@ function schemeOf(id: string): string | undefined {
|
||||
return /@(light|dark)$/.exec(id)?.[1];
|
||||
}
|
||||
|
||||
/** This writer's state as the compact record the comment is rendered from. */
|
||||
export function platformRecordOf(state: PublicCommentState, platform?: CommentPlatform): PlatformRecord {
|
||||
/**
|
||||
* The position of a target in config.yaml, recorded only when the run's targets are not the per-platform ios and
|
||||
* android (in that order, with their default labels): those render in the order and with the labels they always had.
|
||||
*/
|
||||
function targetOrder(targets: PublicCommentState["targets"], id: CommentTarget): number | undefined {
|
||||
if (!targets?.length) return undefined;
|
||||
const ids = targets.map(target => target.id).join(",");
|
||||
const perPlatform = ["ios", "android", "ios,android"].includes(ids) && targets.every(target => target.id === target.platform && target.label === defaultTargetLabel(target.id));
|
||||
const index = targets.findIndex(target => target.id === id);
|
||||
return perPlatform || index < 0 || index >= MAX_COMMENT_TARGETS ? undefined : index;
|
||||
}
|
||||
|
||||
/**
|
||||
* This writer's state as the compact record the comment is rendered from, keyed by its target: the state's own, else
|
||||
* `target` (a writer that knows only the id, such as the failure job), else the build's platform (states from before targets).
|
||||
*/
|
||||
export function platformRecordOf(state: PublicCommentState, target?: CommentTarget): PlatformRecord {
|
||||
const pr = state.pullRequest;
|
||||
const id = state.target?.id ?? target ?? state.build?.platform ?? "ios";
|
||||
const platform = state.target?.platform ?? state.build?.platform ?? (id === "android" ? "android" : "ios");
|
||||
const label = state.target?.label && state.target.label !== defaultTargetLabel(id) ? state.target.label : undefined;
|
||||
const order = targetOrder(state.targets, id);
|
||||
const { runId, runAttempt } = runIdentity(state.links.run);
|
||||
// While the hosted preview is deploying the central Viewer's download-and-drop page would read as the report, so no link.
|
||||
const deploying = state.phase === "ready" && !state.links.preview && state.links.deploying === true;
|
||||
@@ -252,7 +275,7 @@ export function platformRecordOf(state: PublicCommentState, platform?: CommentPl
|
||||
// A republished review keeps the duration of the run that produced it.
|
||||
const reviewedAt = state.phase === "ready" && state.review ? Date.parse(state.review.createdAt) : NaN;
|
||||
const record: PlatformRecord = {
|
||||
v: 1, platform: platform ?? state.build?.platform ?? "ios", runId, runAttempt, headSha: pr.head.sha, baseSha: pr.base.sha,
|
||||
v: 1, platform, ...(id !== platform ? { target: id } : {}), ...(label ? { label } : {}), ...(order !== undefined ? { order } : {}), runId, runAttempt, headSha: pr.head.sha, baseSha: pr.base.sha,
|
||||
startedAt: state.startedAt, updatedAt: Number.isFinite(reviewedAt) ? reviewedAt : state.updatedAt, phase: state.phase,
|
||||
links: { run: state.links.run, artifacts: state.links.artifacts, config: state.links.config, ...(report ? { report } : {}),
|
||||
...(state.phase === "ready" && state.links.download ? { download: state.links.download } : {}),
|
||||
@@ -352,13 +375,21 @@ function reportCell(record: PlatformRecord): string {
|
||||
return record.links.report ? link(record.links.report.includes(".expo.app/") ? "Open" : "Viewer", record.links.report) : record.links.deploying ? "deploying…" : run;
|
||||
}
|
||||
|
||||
/** "Workflow iOS run · zip; Android run · zip" for the ready platforms, with the platform named only when there are several. */
|
||||
/** A target's label as Markdown text. */
|
||||
const labelOf = (record: PlatformRecord) => inlineText(recordLabel(record), 80);
|
||||
|
||||
/** "platform" for the per-platform targets of a config without targets, "device" once a config names its own. */
|
||||
function targetNoun(records: PlatformRecord[]): "platform" | "device" {
|
||||
return records.every(record => !record.target && record.label === undefined) ? "platform" : "device";
|
||||
}
|
||||
|
||||
/** "Workflow iOS run · zip; Android run · zip" for the ready targets, with the target named only when there are several. */
|
||||
function artifactLinks(records: PlatformRecord[]): string | undefined {
|
||||
const ready = records.filter(record => record.phase === "ready");
|
||||
if (!ready.length) return undefined;
|
||||
const parts = ready.map(record => {
|
||||
const links = [link("run", record.links.run), record.links.download ? link("zip", record.links.download) : undefined].filter(Boolean).join(" · ");
|
||||
return ready.length > 1 ? `${PLATFORM_LABELS[record.platform]} ${links}` : links;
|
||||
return ready.length > 1 ? `${labelOf(record)} ${links}` : links;
|
||||
});
|
||||
return `Workflow ${parts.join("; ")}`;
|
||||
}
|
||||
@@ -369,7 +400,7 @@ function deviceCell(record: PlatformRecord): string {
|
||||
return parts.length ? parts.join(" · ") : "—";
|
||||
}
|
||||
|
||||
type ChangeRow = { id: string; route: string; scheme?: string; group: ReviewGroup; description: string; perPlatform: Partial<Record<CommentPlatform, { group: ReviewGroup; href?: string }>> };
|
||||
type ChangeRow = { id: string; route: string; scheme?: string; group: ReviewGroup; description: string; perTarget: Partial<Record<CommentTarget, { group: ReviewGroup; href?: string }>> };
|
||||
|
||||
function changeRows(records: PlatformRecord[]): Map<ReviewGroup, ChangeRow[]> {
|
||||
const rows = new Map<string, ChangeRow>();
|
||||
@@ -377,10 +408,10 @@ function changeRows(records: PlatformRecord[]): Map<ReviewGroup, ChangeRow[]> {
|
||||
if (record.phase !== "ready") continue;
|
||||
for (const change of record.changes ?? []) {
|
||||
const href = record.links.report ? surfaceLink(record.links.report, change.id) : undefined;
|
||||
const row = rows.get(change.id) ?? { id: change.id, route: change.route, group: change.group, description: change.description, perPlatform: {}, ...(change.scheme ? { scheme: change.scheme } : {}) };
|
||||
// A screen accessibility-only on one platform and visibly changed on another is listed as the visible change.
|
||||
const row = rows.get(change.id) ?? { id: change.id, route: change.route, group: change.group, description: change.description, perTarget: {}, ...(change.scheme ? { scheme: change.scheme } : {}) };
|
||||
// A screen accessibility-only on one target and visibly changed on another is listed as the visible change.
|
||||
if (strongerGroup(row.group, change.group) !== row.group) Object.assign(row, { group: change.group, description: change.description });
|
||||
row.perPlatform[record.platform] = { group: change.group, ...(href ? { href } : {}) };
|
||||
row.perTarget[recordTarget(record)] = { group: change.group, ...(href ? { href } : {}) };
|
||||
rows.set(change.id, row);
|
||||
}
|
||||
}
|
||||
@@ -389,32 +420,33 @@ function changeRows(records: PlatformRecord[]): Map<ReviewGroup, ChangeRow[]> {
|
||||
return groups;
|
||||
}
|
||||
|
||||
function renderChangeRow(row: ChangeRow, platforms: CommentPlatform[]): string {
|
||||
const where = platforms.flatMap(platform => {
|
||||
const entry = row.perPlatform[platform];
|
||||
function renderChangeRow(row: ChangeRow, records: PlatformRecord[]): string {
|
||||
const where = records.flatMap(record => {
|
||||
const entry = row.perTarget[recordTarget(record)];
|
||||
if (!entry) return [];
|
||||
const label = PLATFORM_LABELS[platform] + (entry.group !== row.group ? ` (${GROUP_LABEL[entry.group].replace(/^\S+ /, "").toLowerCase()})` : "");
|
||||
const label = labelOf(record) + (entry.group !== row.group ? ` (${GROUP_LABEL[entry.group].replace(/^\S+ /, "").toLowerCase()})` : "");
|
||||
return [entry.href ? link(label, entry.href) : label];
|
||||
});
|
||||
const route = `\`${plainText(row.route, MAX_ROUTE_LENGTH).replace(/`/g, "")}\`${row.scheme ? ` (${inlineText(row.scheme, 20)})` : ""}`;
|
||||
return `- ${route} — ${inlineText(row.description, MAX_DESCRIPTION_LENGTH)}${where.length ? ` · ${where.join(" · ")}` : ""}`;
|
||||
}
|
||||
|
||||
function changesSection(records: PlatformRecord[], platforms: CommentPlatform[], rowCap: number): string[] {
|
||||
function changesSection(records: PlatformRecord[], rowCap: number): string[] {
|
||||
const ready = records.filter(record => record.phase === "ready");
|
||||
if (!ready.length) return [];
|
||||
const groups = changeRows(ready);
|
||||
const lines: string[] = [];
|
||||
const noun = targetNoun(records);
|
||||
const total = [...groups.values()].reduce((sum, rows) => sum + rows.length, 0);
|
||||
lines.push(`**Changes** · ${plural(total, "screen")}${platforms.length > 1 && ready.length > 1 ? " · a screen is listed once, with a link per platform" : ""}`, "");
|
||||
lines.push(`**Changes** · ${plural(total, "screen")}${records.length > 1 && ready.length > 1 ? ` · a screen is listed once, with a link per ${noun}` : ""}`, "");
|
||||
// With screens left uncompared, nothing changed only among the ones compared.
|
||||
if (total === 0) lines.push(ready.some(record => record.notCompared) ? "No compared screen changed on the reviewed platforms." : "No screen changed on the reviewed platforms.", "");
|
||||
if (total === 0) lines.push(ready.some(record => record.notCompared) ? `No compared screen changed on the reviewed ${noun}s.` : `No screen changed on the reviewed ${noun}s.`, "");
|
||||
for (const group of GROUP_ORDER) {
|
||||
const rows = groups.get(group) ?? [];
|
||||
if (!rows.length) continue;
|
||||
const shown = rows.slice(0, rowCap);
|
||||
const content = ["", ...(group === "accessibility-only" ? ["Before and After look the same. What screen readers and voice control read changed.", ""] : []),
|
||||
...shown.map(row => renderChangeRow(row, platforms))];
|
||||
...shown.map(row => renderChangeRow(row, records))];
|
||||
if (rows.length > shown.length) {
|
||||
const report = ready.find(record => record.links.report)?.links.report;
|
||||
content.push(`- ${rows.length - shown.length} more${report ? ` — ${link("Explore report", report)}` : ""}`);
|
||||
@@ -427,14 +459,14 @@ function changesSection(records: PlatformRecord[], platforms: CommentPlatform[],
|
||||
if (seen.has(line)) continue;
|
||||
seen.add(line);
|
||||
const everywhere = ready.every(other => other.context?.includes(line));
|
||||
lines.push(everywhere ? line : `${PLATFORM_LABELS[record.platform]} · ${line}`, "");
|
||||
lines.push(everywhere ? line : `${labelOf(record)} · ${line}`, "");
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
/**
|
||||
* The heading carries the report links: on a phone the table's last column is clipped, and the
|
||||
* commits it reviews are a subtitle under it. A platform still capturing adds its link when it is ready.
|
||||
* commits it reviews are a subtitle under it. A target still capturing adds its link when it is ready.
|
||||
*/
|
||||
function heading(records: PlatformRecord[]): string {
|
||||
const ready = records.filter(record => record.phase === "ready" && record.links.report);
|
||||
@@ -442,7 +474,7 @@ function heading(records: PlatformRecord[]): string {
|
||||
return records.some(record => record.phase === "ready" && record.links.deploying) ? "### Explore review · report deploying, not ready yet" : "### Explore review";
|
||||
}
|
||||
const links = ready.length === 1 ? [link("Open report", ready[0]!.links.report!)]
|
||||
: ready.map(record => link(`${PLATFORM_LABELS[record.platform]} report`, record.links.report!));
|
||||
: ready.map(record => link(`${labelOf(record)} report`, record.links.report!));
|
||||
return `### Explore review · ${links.join(" · ")}`;
|
||||
}
|
||||
|
||||
@@ -495,24 +527,23 @@ function validationSummary(record: PlatformRecord): string {
|
||||
}
|
||||
}
|
||||
|
||||
function validationSection(records: PlatformRecord[], platforms: CommentPlatform[]): string[] {
|
||||
if (!records.some(record => record.phase === "ready" || record.phase === "failed")) return [];
|
||||
const byPlatform = platforms.map(platform => records.find(record => record.platform === platform)!);
|
||||
const summary = `Validation · ${byPlatform.map(record => `${PLATFORM_LABELS[record.platform]} ${validationSummary(record)}`).join(" · ")}`;
|
||||
const header = platforms.length > 1 ? `| Check | ${byPlatform.map(record => PLATFORM_LABELS[record.platform]).join(" | ")} |` : `| Check | ${PLATFORM_LABELS[byPlatform[0]!.platform]} |`;
|
||||
function validationSection(byTarget: PlatformRecord[]): string[] {
|
||||
if (!byTarget.some(record => record.phase === "ready" || record.phase === "failed")) return [];
|
||||
const summary = `Validation · ${byTarget.map(record => `${labelOf(record)} ${validationSummary(record)}`).join(" · ")}`;
|
||||
const header = `| Check | ${byTarget.map(labelOf).join(" | ")} |`;
|
||||
const checks: [string, Parameters<typeof validationCell>[1]][] = [["Capture", "capture"], ["Route verification", "routes"], ["Visual comparison", "visual"], ["Accessibility comparison", "accessibility"], ["Source inventory", "inventory"]];
|
||||
const content = ["", header, `|---|${byPlatform.map(() => "---").join("|")}|`,
|
||||
...checks.map(([label, check]) => `| ${label} | ${byPlatform.map(record => validationCell(record, check)).join(" | ")} |`), ""];
|
||||
for (const record of byPlatform) {
|
||||
const content = ["", header, `|---|${byTarget.map(() => "---").join("|")}|`,
|
||||
...checks.map(([label, check]) => `| ${label} | ${byTarget.map(record => validationCell(record, check)).join(" | ")} |`), ""];
|
||||
for (const record of byTarget) {
|
||||
if (record.phase === "failed" && record.failure) {
|
||||
content.push(`**${PLATFORM_LABELS[record.platform]} failed** — ${inlineText(record.failure.message, 1200)} ${link("Open the failed run", record.links.run)} · ${link("Evidence artifact", record.links.artifacts)}`, "");
|
||||
content.push(`**${labelOf(record)} failed** — ${inlineText(record.failure.message, 1200)} ${link("Open the failed run", record.links.run)} · ${link("Evidence artifact", record.links.artifacts)}`, "");
|
||||
}
|
||||
if (record.phase !== "ready") continue;
|
||||
const health = record.health;
|
||||
const gaps = health ? health.base.unavailable + health.base.unverified + health.head.unavailable + health.head.unverified : 0;
|
||||
if (!gaps && !record.diagnostics?.length) continue;
|
||||
const sideLine = (side: "base" | "head") => { const h = health![side]; return `${side} ${h.verified}/${h.planned} verified${h.unverified ? ` · ${h.unverified} unattributed` : ""}${h.unavailable ? ` · ${h.unavailable} unavailable` : ""}`; };
|
||||
content.push(health ? `**${PLATFORM_LABELS[record.platform]}** · ${sideLine("base")} · ${sideLine("head")}` : `**${PLATFORM_LABELS[record.platform]}**`, "");
|
||||
content.push(health ? `**${labelOf(record)}** · ${sideLine("base")} · ${sideLine("head")}` : `**${labelOf(record)}**`, "");
|
||||
for (const diagnostic of record.diagnostics ?? []) {
|
||||
content.push(`- ${diagnostic.side ? `${diagnostic.side === "base" ? "Base" : "Head"} · ` : ""}${inlineText(diagnostic.route, MAX_ROUTE_LENGTH)} · ${inlineText(diagnostic.code, 80)}: ${inlineText(diagnostic.message, 160)} Next action: ${inlineText(diagnostic.nextAction, 240)}`);
|
||||
}
|
||||
@@ -526,13 +557,12 @@ function validationSection(records: PlatformRecord[], platforms: CommentPlatform
|
||||
function historySection(repository: string, history: HistoryEntry[]): string[] {
|
||||
if (!history.length) return [];
|
||||
const content = ["", ...history.map(entry => {
|
||||
const platforms = PLATFORM_ORDER.flatMap(platform => {
|
||||
const item = entry.platforms[platform];
|
||||
if (!item) return [];
|
||||
const links = [item.report ? link("report", item.report) : undefined, link("run", item.run)].filter(Boolean).join(" · ");
|
||||
return [`${PLATFORM_LABELS[platform]} ${inlineText(item.summary, 120)} (${links})`];
|
||||
});
|
||||
return `- ${commitLink(repository, entry.headSha)} · ${platforms.join(" · ")}`;
|
||||
const targets = Object.keys(entry.platforms).map(id => ({ id, item: entry.platforms[id]! })).filter(({ item }) => Boolean(item))
|
||||
.sort((a, b) => compareTargets({ id: a.id, order: a.item.order }, { id: b.id, order: b.item.order })).map(({ id, item }) => {
|
||||
const links = [item.report ? link("report", item.report) : undefined, link("run", item.run)].filter(Boolean).join(" · ");
|
||||
return `${inlineText(item.label ?? defaultTargetLabel(id), 80)} ${inlineText(item.summary, 120)} (${links})`;
|
||||
});
|
||||
return `- ${commitLink(repository, entry.headSha)} · ${targets.join(" · ")}`;
|
||||
}), ""];
|
||||
return details(`Previous runs (${history.length})`, content);
|
||||
}
|
||||
@@ -555,10 +585,9 @@ function deploymentMarkerOf(records: CommentRecords): string | undefined {
|
||||
return names.size ? `<!-- expo-explore-deployments:${[...names].sort().join(",")} -->` : undefined;
|
||||
}
|
||||
|
||||
/** The whole comment from its records: hidden lines first, then one review for every platform of the current run. */
|
||||
/** The whole comment from its records: hidden lines first, then one review for every target of the current run, in config order. */
|
||||
export function renderCommentRecords(records: CommentRecords, existing?: string, budget = PUBLIC_COMMENT_BODY_BUDGET): string {
|
||||
const current = PLATFORM_ORDER.flatMap(platform => records.current[platform] ? [records.current[platform]!] : []);
|
||||
const platforms = current.map(record => record.platform);
|
||||
const current = orderedRecords(records);
|
||||
const hidden = [CI_COMMENT_MARKER, ...[deploymentMarkerOf(records)].filter((line): line is string => Boolean(line)),
|
||||
...current.map(recordLine), ...[historyLine(records.history)].filter((line): line is string => Boolean(line))];
|
||||
if (!current.length) return [...hidden, "### Explore review", "", ...(records.history.some(entry => Object.values(entry.platforms).some(item => item?.superseded)) ? [SUPERSEDED_NOTE, ""] : []),
|
||||
@@ -570,9 +599,9 @@ export function renderCommentRecords(records: CommentRecords, existing?: string,
|
||||
`<sub>base ${commitLink(repository, first.baseSha)} → ${commitLink(repository, first.headSha)}</sub>`, ""];
|
||||
if (first.superseded) lines.push(SUPERSEDED_NOTE, "");
|
||||
lines.push(`| | Device | Result | Report |`, `|---|---|---|---|`,
|
||||
...current.map(record => `| ${PLATFORM_LABELS[record.platform]} | ${deviceCell(record)} | ${resultCell(record)} | ${reportCell(record)} |`), "");
|
||||
lines.push(...changesSection(current, platforms, rowCap));
|
||||
lines.push(...validationSection(current, platforms));
|
||||
...current.map(record => `| ${labelOf(record)} | ${deviceCell(record)} | ${resultCell(record)} | ${reportCell(record)} |`), "");
|
||||
lines.push(...changesSection(current, rowCap));
|
||||
lines.push(...validationSection(current));
|
||||
lines.push(...historySection(repository, records.history));
|
||||
const expiries = current.filter(record => record.phase === "ready" && record.links.expiresAt !== undefined).map(record => record.links.expiresAt);
|
||||
const footer: string[] = [];
|
||||
@@ -599,16 +628,19 @@ function configPathOf(config: string): string {
|
||||
return match ? decodeURIComponent(match[1]!) : "config";
|
||||
}
|
||||
|
||||
/** Render the sticky pull-request comment for any phase of a public review run, folding this writer into the existing comment's records. */
|
||||
export function renderPublicComment(state: PublicCommentState, existing?: string, platform?: CommentPlatform): string {
|
||||
/**
|
||||
* Render the sticky pull-request comment for any phase of a public review run, folding this writer into the existing
|
||||
* comment's records. `target` keys the record when the state names no target of its own (see platformRecordOf).
|
||||
*/
|
||||
export function renderPublicComment(state: PublicCommentState, existing?: string, target?: CommentTarget): string {
|
||||
const pr = state.pullRequest;
|
||||
if (pr.origin === "local") return renderLocalText(state);
|
||||
return renderCommentRecords(foldRecord(readCommentRecords(existing), platformRecordOf(state, platform)), existing);
|
||||
return renderCommentRecords(foldRecord(readCommentRecords(existing), platformRecordOf(state, target)), existing);
|
||||
}
|
||||
|
||||
/** The sticky-comment merge for a writer: every writer re-renders the whole comment from the records it carries plus its own. */
|
||||
export function platformSectionMerge(state: PublicCommentState, platform: CommentPlatform | undefined): { merge: (existing: string | undefined) => string } {
|
||||
return { merge: existing => renderPublicComment(state, existing, platform) };
|
||||
export function platformSectionMerge(state: PublicCommentState, target: CommentTarget | undefined): { merge: (existing: string | undefined) => string } {
|
||||
return { merge: existing => renderPublicComment(state, existing, target) };
|
||||
}
|
||||
|
||||
/** "iPhone 17 Pro 26.0 · light + dark": the device model and OS version the report's head capture ran on, and its appearances when it captured several. */
|
||||
|
||||
@@ -1,17 +1,33 @@
|
||||
import { deflateRawSync, inflateRawSync } from "node:zlib";
|
||||
import { isTargetId } from "../config/explore-config.js";
|
||||
|
||||
/**
|
||||
* The sticky PR comment is rendered from compact per-platform records that every writer embeds as hidden
|
||||
* The sticky PR comment is rendered from compact per-target records that every writer embeds as hidden
|
||||
* HTML comment lines, so the capture, report, deploy and failure jobs of one run (and the runs that follow
|
||||
* it) each rewrite the whole comment from the same data without needing the other jobs' files:
|
||||
*
|
||||
* <!-- expo-explore-record:<platform>:<base64url(deflate(json))> --> one per platform of the current run
|
||||
* <!-- expo-explore-history:<base64url(deflate(json))> --> earlier runs on this PR
|
||||
* <!-- expo-explore-record:<target>:<base64url(deflate(json))> --> one per target of the current run
|
||||
* <!-- expo-explore-history:<base64url(deflate(json))> --> earlier runs on this PR
|
||||
*
|
||||
* A config without targets has one target per platform whose id is the platform (`ios`, `android`); its records
|
||||
* carry neither `target` nor `label` nor `order`, so they are byte-identical to the per-platform records of
|
||||
* versions before targets, and those still parse.
|
||||
*
|
||||
* Records read back from GitHub are untrusted: anything that does not match the schema is dropped and the
|
||||
* comment renders without it.
|
||||
*/
|
||||
export type CommentPlatform = "ios" | "android";
|
||||
/** A target id (`ios`, `android`, or an id from config.yaml's targets); it keys records and history entries. */
|
||||
export type CommentTarget = string;
|
||||
/** A config has at most 8 targets; a comment never holds more records than that. */
|
||||
export const MAX_COMMENT_TARGETS = 8;
|
||||
const PLATFORM_LABELS: Record<CommentPlatform, string> = { ios: "iOS", android: "Android" };
|
||||
const LEGACY_ORDER: CommentPlatform[] = ["ios", "android"];
|
||||
|
||||
/** The label a target shows without a `label` of its own: iOS and Android for the per-platform ids, else the id. */
|
||||
export function defaultTargetLabel(id: CommentTarget): string {
|
||||
return id === "ios" || id === "android" ? PLATFORM_LABELS[id] : id;
|
||||
}
|
||||
export type RecordPhase = "pending" | "capturing" | "ready" | "failed";
|
||||
/**
|
||||
* `accessibility-only`: modified, but the screenshots match; only what assistive technology reads changed. A screen
|
||||
@@ -26,8 +42,8 @@ export const CHANGE_GROUPS: ChangeGroup[] = ["added", "removed", "modified", "ac
|
||||
* are changes too (screen readers and voice control see them), but not ones a screenshot shows.
|
||||
*/
|
||||
/**
|
||||
* The group of a screen that changed on several platforms. Accessibility only says the screenshots match, so it
|
||||
* yields to any other group; otherwise the first platform's group stands, as it always has.
|
||||
* The group of a screen that changed on several targets. Accessibility only says the screenshots match, so it
|
||||
* yields to any other group; otherwise the first target's group stands, as it always has.
|
||||
*/
|
||||
export function strongerGroup(first: ChangeGroup, other: ChangeGroup): ChangeGroup {
|
||||
return first === "accessibility-only" ? other : first;
|
||||
@@ -44,7 +60,14 @@ export type SideHealth = { planned: number; captured: number; verified: number;
|
||||
|
||||
export type PlatformRecord = {
|
||||
v: 1;
|
||||
/** The target's platform. A failure record of a target it never saw before guesses ios; nothing renders it. */
|
||||
platform: CommentPlatform;
|
||||
/** The target id, when it is not the platform. */
|
||||
target?: CommentTarget;
|
||||
/** What the comment calls the target, when that is not defaultTargetLabel(id). */
|
||||
label?: string;
|
||||
/** The target's position in config.yaml, when the run's targets are not the per-platform ios, android. */
|
||||
order?: number;
|
||||
runId: string;
|
||||
runAttempt: string;
|
||||
headSha: string;
|
||||
@@ -81,13 +104,36 @@ export type HistoryEntry = {
|
||||
baseSha: string;
|
||||
runId: string;
|
||||
startedAt: number;
|
||||
platforms: Partial<Record<CommentPlatform, { phase: RecordPhase; summary: string; run: string; report?: string; download?: string; superseded?: boolean }>>;
|
||||
/** Keyed by target id (the platform for configs without targets; the key keeps its old name so old entries parse). */
|
||||
platforms: Partial<Record<CommentTarget, HistoryItem>>;
|
||||
};
|
||||
export type HistoryItem = { phase: RecordPhase; summary: string; run: string; report?: string; download?: string; superseded?: boolean; label?: string; order?: number };
|
||||
|
||||
export type CommentRecords = { current: Partial<Record<CommentPlatform, PlatformRecord>>; history: HistoryEntry[] };
|
||||
export type CommentRecords = { current: Partial<Record<CommentTarget, PlatformRecord>>; history: HistoryEntry[] };
|
||||
|
||||
/** The id a record is keyed by. */
|
||||
export function recordTarget(record: Pick<PlatformRecord, "platform" | "target">): CommentTarget {
|
||||
return record.target ?? record.platform;
|
||||
}
|
||||
|
||||
export function recordLabel(record: Pick<PlatformRecord, "platform" | "target" | "label">): string {
|
||||
return record.label ?? defaultTargetLabel(recordTarget(record));
|
||||
}
|
||||
|
||||
/** Config order where the run recorded one, else iOS before Android, then by id. */
|
||||
export function compareTargets(a: { id: CommentTarget; order?: number | undefined }, b: { id: CommentTarget; order?: number | undefined }): number {
|
||||
const rank = (item: { id: CommentTarget; order?: number | undefined }) => item.order ?? (LEGACY_ORDER.includes(item.id as CommentPlatform) ? LEGACY_ORDER.indexOf(item.id as CommentPlatform) : MAX_COMMENT_TARGETS);
|
||||
return rank(a) - rank(b) || (a.id < b.id ? -1 : a.id > b.id ? 1 : 0);
|
||||
}
|
||||
|
||||
/** The current records in display order. */
|
||||
export function orderedRecords(records: CommentRecords): PlatformRecord[] {
|
||||
return Object.values(records.current).filter((record): record is PlatformRecord => Boolean(record))
|
||||
.sort((a, b) => compareTargets({ id: recordTarget(a), order: a.order }, { id: recordTarget(b), order: b.order }));
|
||||
}
|
||||
|
||||
export const HISTORY_LIMIT = 5;
|
||||
const RECORD_LINE = /^<!-- expo-explore-record:(ios|android):([A-Za-z0-9_-]+) -->$/gm;
|
||||
const RECORD_LINE = /^<!-- expo-explore-record:([a-z][a-z0-9-]{0,31}):([A-Za-z0-9_-]+) -->$/gm;
|
||||
const HISTORY_LINE = /^<!-- expo-explore-history:([A-Za-z0-9_-]+) -->$/m;
|
||||
const MAX_ENCODED = 24_000;
|
||||
const MAX_DECODED = 256_000;
|
||||
@@ -109,7 +155,7 @@ function decodePayload(encoded: string): unknown {
|
||||
}
|
||||
|
||||
export function recordLine(record: PlatformRecord): string {
|
||||
return `<!-- expo-explore-record:${record.platform}:${encodeRecordPayload(record)} -->`;
|
||||
return `<!-- expo-explore-record:${recordTarget(record)}:${encodeRecordPayload(record)} -->`;
|
||||
}
|
||||
|
||||
export function historyLine(history: HistoryEntry[]): string | undefined {
|
||||
@@ -122,6 +168,8 @@ const isCount = (value: unknown): value is number => typeof value === "number" &
|
||||
const isTime = (value: unknown): value is number => typeof value === "number" && Number.isFinite(value) && value > 0;
|
||||
const isPhase = (value: unknown): value is RecordPhase => value === "pending" || value === "capturing" || value === "ready" || value === "failed";
|
||||
const isPlatform = (value: unknown): value is CommentPlatform => value === "ios" || value === "android";
|
||||
const isLabel = (value: unknown): value is string => isString(value, 80) && value.trim().length > 0;
|
||||
const isOrder = (value: unknown): value is number => isCount(value) && value < MAX_COMMENT_TARGETS;
|
||||
const isSide = (value: unknown): value is "base" | "head" => value === "base" || value === "head";
|
||||
const isUrl = (value: unknown): value is string => {
|
||||
if (!isString(value, 4000)) return false;
|
||||
@@ -143,9 +191,11 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
|
||||
|| !isRecord(value.links) || !isUrl(value.links.run) || !isUrl(value.links.artifacts) || !isUrl(value.links.config)
|
||||
|| !optional(value.links.report, isUrl) || !optional(value.links.download, isUrl)
|
||||
|| !(value.links.expiresAt === undefined || value.links.expiresAt === null || isTime(value.links.expiresAt))
|
||||
|| !(value.links.deploying === undefined || value.links.deploying === true)) return undefined;
|
||||
|| !(value.links.deploying === undefined || value.links.deploying === true)
|
||||
|| !optional(value.target, isTargetId) || !optional(value.label, isLabel) || !optional(value.order, isOrder)) return undefined;
|
||||
const record: PlatformRecord = {
|
||||
v: 1, platform: value.platform, runId: value.runId, runAttempt: value.runAttempt, headSha: value.headSha, baseSha: value.baseSha,
|
||||
v: 1, platform: value.platform, ...(value.target !== undefined && value.target !== value.platform ? { target: value.target } : {}),
|
||||
...(value.label !== undefined ? { label: value.label } : {}), ...(value.order !== undefined ? { order: value.order } : {}), runId: value.runId, runAttempt: value.runAttempt, headSha: value.headSha, baseSha: value.baseSha,
|
||||
startedAt: value.startedAt, updatedAt: value.updatedAt, phase: value.phase,
|
||||
links: { run: value.links.run, artifacts: value.links.artifacts, config: value.links.config,
|
||||
...(value.links.report ? { report: value.links.report } : {}), ...(value.links.download ? { download: value.links.download } : {}),
|
||||
@@ -206,12 +256,12 @@ export function parseHistory(value: unknown): HistoryEntry[] {
|
||||
if (!isRecord(entry) || !isString(entry.headSha) || !SHA.test(entry.headSha) || !isString(entry.baseSha) || !SHA.test(entry.baseSha)
|
||||
|| !isString(entry.runId, 200) || !SAFE_ID.test(entry.runId) || !isTime(entry.startedAt) || !isRecord(entry.platforms)) continue;
|
||||
const platforms: HistoryEntry["platforms"] = {};
|
||||
for (const platform of ["ios", "android"] as const) {
|
||||
const item = entry.platforms[platform];
|
||||
for (const target of Object.keys(entry.platforms).filter(isTargetId).slice(0, MAX_COMMENT_TARGETS)) {
|
||||
const item = entry.platforms[target];
|
||||
if (!isRecord(item) || !isPhase(item.phase) || !isString(item.summary, 400) || !isUrl(item.run)
|
||||
|| !optional(item.report, isUrl) || !optional(item.download, isUrl)) continue;
|
||||
platforms[platform] = { phase: item.phase, summary: item.summary, run: item.run, ...(item.report ? { report: item.report } : {}), ...(item.download ? { download: item.download } : {}),
|
||||
...(item.superseded === true ? { superseded: true } : {}) };
|
||||
|| !optional(item.report, isUrl) || !optional(item.download, isUrl) || !optional(item.label, isLabel) || !optional(item.order, isOrder)) continue;
|
||||
platforms[target] = { phase: item.phase, summary: item.summary, run: item.run, ...(item.report ? { report: item.report } : {}), ...(item.download ? { download: item.download } : {}),
|
||||
...(item.superseded === true ? { superseded: true } : {}), ...(item.label !== undefined ? { label: item.label } : {}), ...(item.order !== undefined ? { order: item.order } : {}) };
|
||||
}
|
||||
if (Object.keys(platforms).length) entries.push({ headSha: entry.headSha, baseSha: entry.baseSha, runId: entry.runId, startedAt: entry.startedAt, platforms });
|
||||
if (entries.length === HISTORY_LIMIT) break;
|
||||
@@ -225,7 +275,9 @@ export function readCommentRecords(body: string | undefined): CommentRecords {
|
||||
if (!body) return records;
|
||||
for (const match of body.matchAll(RECORD_LINE)) {
|
||||
const record = parsePlatformRecord(decodePayload(match[2]!));
|
||||
if (record && record.platform === match[1]) records.current[record.platform] = record;
|
||||
const target = record && recordTarget(record);
|
||||
if (!record || target !== match[1] || !isTargetId(target)) continue;
|
||||
if (records.current[target] || Object.keys(records.current).length < MAX_COMMENT_TARGETS) records.current[target] = record;
|
||||
}
|
||||
const history = body.match(HISTORY_LINE);
|
||||
if (history) records.history = parseHistory(decodePayload(history[1]!));
|
||||
@@ -250,9 +302,10 @@ function historyEntryOf(records: PlatformRecord[]): HistoryEntry | undefined {
|
||||
if (!first) return undefined;
|
||||
const entry: HistoryEntry = { headSha: first.headSha, baseSha: first.baseSha, runId: first.runId, startedAt: Math.min(...records.map(record => record.startedAt)), platforms: {} };
|
||||
for (const record of records) {
|
||||
entry.platforms[record.platform] = { phase: record.phase, summary: recordSummary(record), run: record.links.run,
|
||||
entry.platforms[recordTarget(record)] = { phase: record.phase, summary: recordSummary(record), run: record.links.run,
|
||||
...(record.links.report ? { report: record.links.report } : {}), ...(record.links.download ? { download: record.links.download } : {}),
|
||||
...(record.superseded ? { superseded: true } : {}) };
|
||||
...(record.superseded ? { superseded: true } : {}), ...(record.label !== undefined ? { label: record.label } : {}),
|
||||
...(record.order !== undefined ? { order: record.order } : {}) };
|
||||
}
|
||||
return entry;
|
||||
}
|
||||
@@ -262,27 +315,42 @@ const runOrder = (runId: string): number => Number.parseInt(runId, 10) || 0;
|
||||
function pushHistory(history: HistoryEntry[], entry: HistoryEntry | undefined): HistoryEntry[] {
|
||||
if (!entry) return history;
|
||||
const merged = [entry, ...history.filter(item => item.runId !== entry.runId)];
|
||||
// One entry per run: a platform that reaches history later joins the entry its sibling made.
|
||||
// One entry per run: a target that reaches history later joins the entry its sibling made.
|
||||
const existing = history.find(item => item.runId === entry.runId);
|
||||
if (existing) merged[0] = { ...existing, platforms: { ...existing.platforms, ...entry.platforms } };
|
||||
return merged.sort((a, b) => runOrder(b.runId) - runOrder(a.runId) || b.startedAt - a.startedAt).slice(0, HISTORY_LIMIT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fold one writer's record into the comment's records. The same run replaces its own platform; a newer run
|
||||
* Fold one writer's record into the comment's records. The same run replaces its own target; a newer run
|
||||
* moves the previous run into history; a run that finds a newer run already current (the PR moved while it
|
||||
* worked) is superseded and only adds itself to history, so its report stays linked without displacing the
|
||||
* current review.
|
||||
*/
|
||||
export function foldRecord(existing: CommentRecords, record: PlatformRecord): CommentRecords {
|
||||
const current = Object.values(existing.current).filter((item): item is PlatformRecord => Boolean(item));
|
||||
export function foldRecord(existing: CommentRecords, incoming: PlatformRecord): CommentRecords {
|
||||
const current = orderedRecords(existing);
|
||||
const record = withKnownTarget(incoming, existing);
|
||||
const target = recordTarget(record);
|
||||
const currentRun = current[0];
|
||||
if (!currentRun && record.superseded) return { current: {}, history: pushHistory(existing.history, historyEntryOf([record])) };
|
||||
if (!currentRun || currentRun.runId === record.runId) {
|
||||
return { current: { ...existing.current, [record.platform]: record }, history: existing.history };
|
||||
return { current: { ...existing.current, [target]: record }, history: existing.history };
|
||||
}
|
||||
if (runOrder(currentRun.runId) > runOrder(record.runId) || record.superseded) {
|
||||
return { current: existing.current, history: pushHistory(existing.history, historyEntryOf([{ ...record, superseded: true }])) };
|
||||
}
|
||||
return { current: { [record.platform]: record }, history: pushHistory(existing.history, historyEntryOf(current)) };
|
||||
return { current: { [target]: record }, history: pushHistory(existing.history, historyEntryOf(current)) };
|
||||
}
|
||||
|
||||
/**
|
||||
* The failure job knows a target only by the id in an artifact name: its record takes the label, order and platform
|
||||
* the comment already holds for that id (from the capture job's progress record, or the newest run that had it).
|
||||
*/
|
||||
function withKnownTarget(record: PlatformRecord, existing: CommentRecords): PlatformRecord {
|
||||
const target = recordTarget(record);
|
||||
if (!record.target || record.label !== undefined || record.order !== undefined) return record;
|
||||
const known = existing.current[target];
|
||||
if (known) return { ...record, platform: known.platform, ...(known.label !== undefined ? { label: known.label } : {}), ...(known.order !== undefined ? { order: known.order } : {}) };
|
||||
const item = existing.history.find(entry => entry.platforms[target])?.platforms[target];
|
||||
return item ? { ...record, ...(item.label !== undefined ? { label: item.label } : {}), ...(item.order !== undefined ? { order: item.order } : {}) } : record;
|
||||
}
|
||||
+143
-70
@@ -8,7 +8,9 @@ import { MAX_METADATA_BYTES } from "./agent-api.js";
|
||||
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
|
||||
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
|
||||
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
|
||||
import type { ExplorePlatform } from "../config/explore-config.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { targetParameter } from "./viewer-links.js";
|
||||
import type { ArtifactReport } from "../contracts/artifact-report.js";
|
||||
import { normalizePublicReviewForReading } from "../contracts/review-validation.js";
|
||||
import { EXPLORATION_REPORT_KIND, type ExplorationReport } from "../contracts/standalone-report.js";
|
||||
@@ -31,6 +33,11 @@ export type CommandRunner = (command: string, args: readonly string[], options:
|
||||
export type PreviewReportInput = {
|
||||
/** Set by the matrix workflows; the preview then serves this report at report.zip?platform=<platform>. */
|
||||
platform?: ExplorePlatform;
|
||||
/**
|
||||
* The capture target, set by the matrix workflows (wins over `platform`): the preview serves the report as
|
||||
* `<target id>.zip.enc` at report.zip?target=<id> (?platform=<id> for a target named after its platform).
|
||||
*/
|
||||
target?: RunTarget;
|
||||
inputPath: string;
|
||||
/** The `ci:report` output directory: review.json and assets/. */
|
||||
reportPath: string;
|
||||
@@ -67,7 +74,7 @@ export type PreviewDeployResult = {
|
||||
/** The first (or only) report's archive, as before; `reports` lists every platform's. */
|
||||
reportSha256: string;
|
||||
reportBytes: number;
|
||||
reports: Array<{ platform?: ExplorePlatform; artifactUrl: string; reportSha256: string; reportBytes: number }>;
|
||||
reports: Array<{ platform?: ExplorePlatform; target?: RunTarget; artifactUrl: string; reportSha256: string; reportBytes: number }>;
|
||||
headSha: string;
|
||||
/** A comparison's link is in the run summary only: callers must not print previewUrl, which is unmasked for it. */
|
||||
linkedFromRunSummary?: true;
|
||||
@@ -79,6 +86,33 @@ const BASE32 = "abcdefghijklmnopqrstuvwxyz234567";
|
||||
/** The largest report ZIP a hosted preview serves. */
|
||||
export const MAX_REPORT_BYTES = 256 * 1024 * 1024;
|
||||
const ZIP_DATE = new Date("2000-01-01T00:00:00Z");
|
||||
const PLATFORM_LABELS: Record<ExplorePlatform, string> = { ios: "iOS", android: "Android" };
|
||||
|
||||
/** The target of a report from before targets, or of a config without them: its platform, under the platform's name. */
|
||||
export function platformTarget(platform: ExplorePlatform): RunTarget {
|
||||
return { id: platform, platform, label: PLATFORM_LABELS[platform] };
|
||||
}
|
||||
|
||||
/** The report.zip query that selects a target (see targetParameter): `?platform=ios` for configs without targets, as before. */
|
||||
function targetQuery(target: RunTarget): string {
|
||||
const [key, value] = targetParameter(target.id);
|
||||
return `?${key}=${value}`;
|
||||
}
|
||||
|
||||
/** A target as untrusted JSON names it (a report's review.runtime.target): its id, platform and a plain label, or undefined. */
|
||||
function readTarget(value: unknown): RunTarget | undefined {
|
||||
if (typeof value !== "object" || value === null) return undefined;
|
||||
const { id, platform, label } = value as Record<string, unknown>;
|
||||
if (!isTargetId(id) || (platform !== "ios" && platform !== "android")) return undefined;
|
||||
const shown = typeof label === "string" ? listingLabel(label) : "";
|
||||
return { id, platform, label: shown || PLATFORM_LABELS[platform] };
|
||||
}
|
||||
|
||||
function assertTargets(targets: RunTarget[], message: string, nextAction: string): void {
|
||||
// At most 8, as a config names: the Worker refuses a longer listing.
|
||||
if (!targets.length || targets.length > 8 || targets.some(target => !isTargetId(target.id) || (target.platform !== "ios" && target.platform !== "android"))
|
||||
|| new Set(targets.map(target => target.id)).size !== targets.length) throw previewError("PREVIEW_REPORTS_INVALID", message, nextAction);
|
||||
}
|
||||
|
||||
function base32(bytes: Uint8Array): string {
|
||||
let bits = 0; let value = 0; let out = "";
|
||||
@@ -163,8 +197,11 @@ export async function zipReportDirectory(reportPath: string): Promise<Uint8Array
|
||||
return writer.close();
|
||||
}
|
||||
|
||||
/** What a report ZIP holds, from its review.json or exploration.json: where to host it and how the platform switch labels it. */
|
||||
export type ReportZipSummary = { platform: ExplorePlatform; changes?: number; device?: string }
|
||||
/**
|
||||
* What a report ZIP holds, from its review.json or exploration.json: where to host it and how the target switch labels it.
|
||||
* `target` is review.runtime.target, or for reports from before targets (and explorations) the platform's own target.
|
||||
*/
|
||||
export type ReportZipSummary = { platform: ExplorePlatform; target: RunTarget; changes?: number; device?: string }
|
||||
& ({ kind: "review"; repository: string; runId: string; base: string; head: string } | { kind: "exploration" });
|
||||
|
||||
/**
|
||||
@@ -189,7 +226,7 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
|
||||
if (report?.kind !== EXPLORATION_REPORT_KIND || !exploration || (exploration.app?.platform !== "ios" && exploration.app?.platform !== "android")) {
|
||||
throw new Error("exploration.json is not an Explore exploration report");
|
||||
}
|
||||
return { kind: "exploration", platform: exploration.app.platform, device: `${exploration.device.model} ${exploration.device.osVersion}`.trim() };
|
||||
return { kind: "exploration", platform: exploration.app.platform, target: platformTarget(exploration.app.platform), device: `${exploration.device.model} ${exploration.device.osVersion}`.trim() };
|
||||
}
|
||||
const review = (report as Partial<ArtifactReport>).review;
|
||||
const pr = review?.pullRequest;
|
||||
@@ -207,7 +244,10 @@ export async function readReportZip(zip: Uint8Array): Promise<ReportZipSummary>
|
||||
const changes = reviewChangeCount({ review: normalizePublicReviewForReading(review) });
|
||||
const device = reviewDevice({ runtime: { deviceModel: review.runtime?.device?.model ?? "", osVersion: review.runtime?.device?.osVersion ?? "",
|
||||
...(review.runtime?.colorSchemes ? { colorSchemes: review.runtime.colorSchemes } : {}) } });
|
||||
return { kind: "review", platform, repository: pr.repository, runId: review.runId, base: pr.base.sha, head: pr.head.sha,
|
||||
// A target whose platform is not the report's own is not this report's target.
|
||||
const named = readTarget(review.runtime?.target);
|
||||
const target = named?.platform === platform ? named : platformTarget(platform);
|
||||
return { kind: "review", platform, target, repository: pr.repository, runId: review.runId, base: pr.base.sha, head: pr.head.sha,
|
||||
...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) };
|
||||
}
|
||||
|
||||
@@ -232,11 +272,10 @@ async function assertExport(exportPath: string): Promise<void> {
|
||||
}
|
||||
}
|
||||
|
||||
type SealedReport = { entry: PreviewReportInput; input: CiReportInput; zip: Uint8Array; sha256: string; file: string };
|
||||
type SealedReport = { entry: PreviewReportInput; input: CiReportInput; target?: RunTarget; zip: Uint8Array; sha256: string; file: string };
|
||||
|
||||
function previewError(code: string, message: string, nextAction: string): CiError { return new CiError({ code, stage: "preflight", message, nextAction }); }
|
||||
|
||||
/** A device label for the platform switch, safe in the sealed .env: no `#` (a dotenv comment), markup or control characters, and short. */
|
||||
/**
|
||||
* A device label for the platform switch, safe in the sealed .env: letters, digits and a few separators only. `eas
|
||||
* deploy` reads that file with variable expansion, so a `$` (even single-quoted) would pull the deploying process's
|
||||
@@ -245,15 +284,21 @@ function previewError(code: string, message: string, nextAction: string): CiErro
|
||||
function listingDevice(device: string): string {
|
||||
return device.replace(/[^\p{L}\p{N} .,()+·_:/-]/gu, "").replace(/\s+/g, " ").trim().slice(0, 120);
|
||||
}
|
||||
/** A target's label for the switch, as safe as a device label and shorter. */
|
||||
function listingLabel(label: string): string {
|
||||
return listingDevice(label).slice(0, 80).trim();
|
||||
}
|
||||
|
||||
/** The worker's EXPLORE_PREVIEW_REPORTS entries, in the order the workflow lists platforms; also what reports.json must echo. */
|
||||
export function previewReportListing(reports: ReadonlyArray<Pick<SealedReport, "entry" | "input" | "file">>, reportDirectory: string) {
|
||||
return reports.map(report => {
|
||||
const changes = reviewChangeCount(report.input.commentState);
|
||||
const device = listingDevice(reviewDevice(report.input.commentState));
|
||||
return { platform: report.entry.platform!, path: `/_report/${reportDirectory}/${report.file}`,
|
||||
...(changes === undefined ? {} : { changes }), ...(device ? { device } : {}) };
|
||||
});
|
||||
/** One EXPLORE_PREVIEW_REPORTS entry, keys in the order the Worker echoes them in reports.json. */
|
||||
export type PreviewListingEntry = { target: string; platform: ExplorePlatform; label?: string; path: string; changes?: number; device?: string };
|
||||
function listingEntry(target: RunTarget, path: string, changes?: number, device?: string): PreviewListingEntry {
|
||||
const label = listingLabel(target.label), shown = device ? listingDevice(device) : "";
|
||||
return { target: target.id, platform: target.platform, ...(label ? { label } : {}), path, ...(changes === undefined ? {} : { changes }), ...(shown ? { device: shown } : {}) };
|
||||
}
|
||||
|
||||
/** The worker's EXPLORE_PREVIEW_REPORTS entries, in the order the workflow lists targets; also what reports.json must echo. */
|
||||
export function previewReportListing(reports: ReadonlyArray<Pick<SealedReport, "input" | "file"> & { target: RunTarget }>, reportDirectory: string): PreviewListingEntry[] {
|
||||
return reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, reviewChangeCount(report.input.commentState), reviewDevice(report.input.commentState)));
|
||||
}
|
||||
|
||||
export async function deployPreview(options: PreviewDeployOptions): Promise<PreviewDeployResult> {
|
||||
@@ -263,12 +308,19 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
: [{ inputPath: options.inputPath, reportPath: options.reportPath, artifactUrl: options.artifactUrl }];
|
||||
if (!entries.length) throw previewError("PREVIEW_REPORTS_MISSING", "There is no platform report to deploy",
|
||||
"Pass --inputs and --reports directories holding one explore-capture and one explore-review artifact per platform.");
|
||||
const multi = entries.some(entry => entry.platform !== undefined);
|
||||
if (multi && (entries.some(entry => !entry.platform) || new Set(entries.map(entry => entry.platform)).size !== entries.length)) {
|
||||
throw previewError("PREVIEW_REPORTS_INVALID", "Each report of a multi-platform preview must name a distinct platform", "Deploy one report per platform of the same run.");
|
||||
const multi = entries.some(entry => entry.platform !== undefined || entry.target !== undefined);
|
||||
if (multi) {
|
||||
if (entries.some(entry => !entry.platform && !entry.target)) throw previewError("PREVIEW_REPORTS_INVALID", "Each report of a multi-target preview must name its target", "Deploy one report per target of the same run.");
|
||||
assertTargets(entries.map(entry => entry.target ?? platformTarget(entry.platform!)), "Each report of a multi-target preview must name a distinct target", "Deploy one report per target of the same run.");
|
||||
}
|
||||
const inputs: Array<{ entry: PreviewReportInput; input: CiReportInput; target?: RunTarget }> = [];
|
||||
for (const entry of entries) {
|
||||
const input = await readCiReportInput(entry.inputPath);
|
||||
// A platform-named entry takes the report's own label when the report names that target.
|
||||
const named = readTarget(input.publicReview.runtime.target);
|
||||
const target = entry.target ?? (entry.platform ? (named?.id === entry.platform ? named : platformTarget(entry.platform)) : undefined);
|
||||
inputs.push({ entry, input, ...(target ? { target } : {}) });
|
||||
}
|
||||
const inputs: Array<{ entry: PreviewReportInput; input: CiReportInput }> = [];
|
||||
for (const entry of entries) inputs.push({ entry, input: await readCiReportInput(entry.inputPath) });
|
||||
const first = inputs[0]!.input; const review = first.publicReview; const pr = review.pullRequest;
|
||||
if (!first.preview) throw new CiError({ code: "PREVIEW_NOT_CONFIGURED", stage: "preflight",
|
||||
message: "This review did not request a hosted preview", nextAction: "Set report.preview.hosting: eas in .expo-explore/config.yaml, or remove the deploy job." });
|
||||
@@ -281,29 +333,29 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
|
||||
const other = input.publicReview;
|
||||
if (!input.preview || other.pullRequest.origin !== pr.origin || other.pullRequest.repository !== pr.repository || other.pullRequest.number !== pr.number
|
||||
|| other.pullRequest.head.sha !== pr.head.sha || other.pullRequest.base.sha !== pr.base.sha || other.runId !== review.runId || other.runAttempt !== review.runAttempt) {
|
||||
throw previewError("PREVIEW_REPORTS_MISMATCH", "The platform reports do not come from the same review run", "Deploy only the reports this workflow run produced for the same PR head.");
|
||||
throw previewError("PREVIEW_REPORTS_MISMATCH", "The target reports do not come from the same review run", "Deploy only the reports this workflow run produced for the same PR head.");
|
||||
}
|
||||
}
|
||||
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
|
||||
await assertExport(exportPath);
|
||||
|
||||
const reports: SealedReport[] = [];
|
||||
for (const { entry, input } of inputs) {
|
||||
for (const { entry, input, target } of inputs) {
|
||||
let zip: Uint8Array;
|
||||
try { zip = await zipReportDirectory(entry.reportPath); }
|
||||
catch (error) { throw toCiError(error, { code: "REPORT_ZIP_FAILED", stage: "export",
|
||||
nextAction: "Pass the ci:report output directory downloaded from this run's explore-review artifact." }); }
|
||||
reports.push({ entry, input, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi ? `${entry.platform}.zip.enc` : "report.zip.enc" });
|
||||
reports.push({ entry, input, ...(target ? { target } : {}), zip, sha256: createHash("sha256").update(zip).digest("hex"), file: multi && target ? `${target.id}.zip.enc` : "report.zip.enc" });
|
||||
}
|
||||
|
||||
const reportDirectory = base32(random(10));
|
||||
const expiresAt = first.preview.expiresAfterDays === null ? null : now() + first.preview.expiresAfterDays * 86_400_000;
|
||||
const project = previewProjectSlug(pr.repository, first.preview.project);
|
||||
const listing = multi ? previewReportListing(reports, reportDirectory) : undefined;
|
||||
const listing = multi ? previewReportListing(reports.map(report => ({ ...report, target: report.target! })), reportDirectory) : undefined;
|
||||
let hosted: Awaited<ReturnType<typeof deploySealedReports>>;
|
||||
try {
|
||||
hosted = await deploySealedReports({
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: multi ? `?platform=${report.entry.platform}` : "" })),
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: multi && report.target ? targetQuery(report.target) : "" })),
|
||||
reportDirectory, ...(listing ? { listing } : {}), project, ...(first.preview.owner ? { owner: first.preview.owner } : {}),
|
||||
ownerHint: "Set report.preview.owner in .expo-explore/config.yaml to the account that should hold the preview project.",
|
||||
projectHint: "Give EXPO_TOKEN's account permission to create projects, or set report.preview.project to an existing project it can deploy to.",
|
||||
@@ -317,7 +369,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,
|
||||
...(report.entry.platform ? { platform: report.entry.platform } : {}), previewFailed: true });
|
||||
...commentTarget(report), previewFailed: true });
|
||||
} catch { /* the deployment failure is the one to report */ }
|
||||
}
|
||||
throw error;
|
||||
@@ -329,23 +381,30 @@ 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,
|
||||
...(report.entry.platform ? { platform: report.entry.platform } : {}), preview: { url: previewUrl, expiresAt } });
|
||||
...commentTarget(report), preview: { url: previewUrl, expiresAt } });
|
||||
headSha = published.headSha;
|
||||
}
|
||||
return { previewUrl, expiresAt: expiresAt === null ? null : new Date(expiresAt).toISOString(), deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
|
||||
project, owner: hosted.owner, reportSha256: reports[0]!.sha256, reportBytes: reports[0]!.zip.byteLength,
|
||||
reports: reports.map(report => ({ ...(report.entry.platform ? { platform: report.entry.platform } : {}), artifactUrl: report.entry.artifactUrl,
|
||||
reports: reports.map(report => ({ ...(report.entry.platform ? { platform: report.entry.platform } : {}), ...(report.target ? { target: report.target } : {}), artifactUrl: report.entry.artifactUrl,
|
||||
reportSha256: report.sha256, reportBytes: report.zip.byteLength })), headSha,
|
||||
...(pr.origin === "compare" ? { linkedFromRunSummary: true as const } : {}) };
|
||||
}
|
||||
}
|
||||
|
||||
/** The comparison's job summary: what was compared, the hosted link, and each platform's change count. */
|
||||
/** Which comment section and artifact a report is: its target, or (single-report runs) none. */
|
||||
function commentTarget(report: SealedReport): { target?: string; platform?: ExplorePlatform } {
|
||||
if (report.target) return { target: report.target.id, platform: report.target.platform };
|
||||
return report.entry.platform ? { platform: report.entry.platform } : {};
|
||||
}
|
||||
|
||||
/** The comparison's job summary: what was compared, the hosted link, and each target's change count. */
|
||||
export function renderCompareSummary(comparison: CompareReviewPresentation, previewUrl: string, expiresAt: number | null, inputs: CiReportInput[]): string {
|
||||
const platforms = inputs.map(input => {
|
||||
const changes = reviewChangeCount(input.commentState);
|
||||
const device = reviewDevice(input.commentState);
|
||||
return `- ${input.publicReview.runtime.platform === "android" ? "Android" : "iOS"}${device ? ` (${device})` : ""}: ${changes === undefined ? "no review" : `${changes} ${changes === 1 ? "change" : "changes"}`}`;
|
||||
const label = readTarget(input.publicReview.runtime.target)?.label ?? (input.publicReview.runtime.platform === "android" ? "Android" : "iOS");
|
||||
return `- ${label}${device ? ` (${device})` : ""}: ${changes === undefined ? "no review" : `${changes} ${changes === 1 ? "change" : "changes"}`}`;
|
||||
});
|
||||
return [`### Explore: ${compareTitleMarkdown(comparison)}`, "",
|
||||
`[Open the report](${previewUrl}) · [${comparison.base.sha.slice(0, 8)}..${comparison.head.sha.slice(0, 8)}](${comparison.url})`
|
||||
@@ -528,9 +587,10 @@ export async function deployExplorationReport(options: ExplorationDeployOptions)
|
||||
const now = options.now ?? Date.now;
|
||||
const sha256 = createHash("sha256").update(zip).digest("hex");
|
||||
const reportDirectory = base32(random(10));
|
||||
const file = options.platform ? `${options.platform}.zip.enc` : "report.zip.enc";
|
||||
const hosted = await deploySealedReports({ reports: [{ zip, sha256, file, query: options.platform ? `?platform=${options.platform}` : "" }], reportDirectory,
|
||||
...(options.platform ? { listing: [{ platform: options.platform, path: `/_report/${reportDirectory}/${file}` }] } : {}), project: options.project,
|
||||
const target = options.platform ? platformTarget(options.platform) : undefined;
|
||||
const file = target ? `${target.id}.zip.enc` : "report.zip.enc";
|
||||
const hosted = await deploySealedReports({ reports: [{ zip, sha256, file, query: target ? targetQuery(target) : "" }], reportDirectory,
|
||||
...(target ? { listing: [listingEntry(target, `/_report/${reportDirectory}/${file}`)] } : {}), project: options.project,
|
||||
...(options.owner ? { owner: options.owner } : {}), ownerHint: "Pass --owner with the Expo account that should host the report.",
|
||||
projectHint: "Give this EAS login permission to create projects under the owner, or pass --project with an existing slug.",
|
||||
expiresAt: options.expiresAfterDays === null ? null : now() + options.expiresAfterDays * 86_400_000, exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}),
|
||||
@@ -540,8 +600,8 @@ export async function deployExplorationReport(options: ExplorationDeployOptions)
|
||||
}
|
||||
|
||||
export type FixturePreviewOptions = {
|
||||
/** Report ZIPs as a hosted preview serves them from report.zip, one per platform, with what the platform switch says of each. */
|
||||
reports: Array<{ platform: ExplorePlatform; zipPath: string; changes?: number; device?: string }>;
|
||||
/** Report ZIPs as a hosted preview serves them from report.zip, one per target (`platform` alone: the platform's target), with what the switch says of each. */
|
||||
reports: Array<{ platform: ExplorePlatform; target?: RunTarget; zipPath: string; changes?: number; device?: string }>;
|
||||
project: string;
|
||||
owner?: string;
|
||||
alias: string;
|
||||
@@ -568,21 +628,19 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
|
||||
message: "An EAS login is required to deploy the Viewer preview", nextAction: "Run `eas login` or set EXPO_TOKEN." });
|
||||
if (!HOSTING_ALIAS.test(options.alias)) throw previewError("PREVIEW_ALIAS_INVALID", `Invalid EAS Hosting alias: ${options.alias}`, "Pass --alias as a lowercase slug such as pr-123.");
|
||||
if (options.token !== undefined && !HOSTED_TOKEN.test(options.token)) throw previewError("PREVIEW_TOKEN_INVALID", "The preview token must be 32 characters of a-z and 2-7.", "Pass the /p/<token> segment of the previous preview link, or none for a new one.");
|
||||
if (!options.reports.length || new Set(options.reports.map(report => report.platform)).size !== options.reports.length) {
|
||||
throw previewError("PREVIEW_REPORTS_INVALID", "A fixture preview needs one report per platform", "Pass each platform's report ZIP once.");
|
||||
}
|
||||
assertTargets(options.reports.map(report => report.target ?? platformTarget(report.platform)), "A fixture preview needs one report per target", "Pass each target's report ZIP once.");
|
||||
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
|
||||
await assertExport(exportPath);
|
||||
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
|
||||
const reportDirectory = base32(random(10));
|
||||
const reports = await Promise.all(options.reports.map(async report => {
|
||||
const zip = new Uint8Array(await readFile(report.zipPath));
|
||||
return { ...report, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: `${report.platform}.zip.enc` };
|
||||
const target = report.target ?? platformTarget(report.platform);
|
||||
return { ...report, target, zip, sha256: createHash("sha256").update(zip).digest("hex"), file: `${target.id}.zip.enc` };
|
||||
}));
|
||||
const listing = reports.map(report => ({ platform: report.platform, path: `/_report/${reportDirectory}/${report.file}`,
|
||||
...(report.changes === undefined ? {} : { changes: report.changes }), ...(report.device ? { device: report.device } : {}) }));
|
||||
const listing = reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, report.changes, report.device));
|
||||
return deploySealedReports({
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: `?platform=${report.platform}` })),
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: targetQuery(report.target) })),
|
||||
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
|
||||
ownerHint: "Pass --owner with the Expo account that holds the preview project.",
|
||||
projectHint: "Give EXPO_TOKEN's account permission to create projects, or pass --project with an existing slug.",
|
||||
@@ -592,11 +650,12 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
|
||||
}
|
||||
|
||||
/**
|
||||
* Report ZIPs on this machine behind one token (`capture:review --upload`, `report:upload`), one per platform: the same
|
||||
* Report ZIPs on this machine behind one token (`capture:review --upload`, `report:upload`), one per target: the same
|
||||
* sealed deployment as a PR preview, from ZIPs instead of GitHub artifacts, with the local EAS login or EXPO_TOKEN.
|
||||
*/
|
||||
export async function deployLocalReports(options: {
|
||||
reports: Array<{ platform: ExplorePlatform; zip: Uint8Array; changes?: number; device?: string }>;
|
||||
/** One per target; an entry without `target` is its platform's target, as before targets. */
|
||||
reports: Array<{ platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string }>;
|
||||
project: string; owner?: string; expiresAfterDays: number | null;
|
||||
/** What to change when the owner or project is not usable; defaults name report.preview in config.yaml. */
|
||||
ownerHint?: string; projectHint?: string;
|
||||
@@ -604,22 +663,20 @@ export async function deployLocalReports(options: {
|
||||
transport?: typeof fetch; now?: () => number; random?: (bytes: number) => Uint8Array; verifyTimeoutMs?: number;
|
||||
}): Promise<HostedDeployment> {
|
||||
const environment = options.environment ?? process.env;
|
||||
if (!options.reports.length || new Set(options.reports.map(report => report.platform)).size !== options.reports.length) {
|
||||
throw previewError("PREVIEW_REPORTS_INVALID", "A local upload needs one report per platform", "Capture each platform once, then upload.");
|
||||
}
|
||||
assertTargets(options.reports.map(report => report.target ?? platformTarget(report.platform)), "A local upload needs one report per target", "Capture each target once, then upload.");
|
||||
const exportPath = resolve(options.exportPath ?? PREVIEW_EXPORT_PATH);
|
||||
await assertExport(exportPath);
|
||||
const now = options.now ?? Date.now;
|
||||
const random = options.random ?? (bytes => new Uint8Array(randomBytes(bytes)));
|
||||
const reportDirectory = base32(random(10));
|
||||
// Always listed, even alone: the Worker takes an unlisted report for iOS, so an Android one would be mislabelled.
|
||||
const reports = options.reports.map(report => ({ ...report, sha256: createHash("sha256").update(report.zip).digest("hex"), file: `${report.platform}.zip.enc` }));
|
||||
const listing = reports.map(report => {
|
||||
const device = report.device ? listingDevice(report.device) : "";
|
||||
return { platform: report.platform, path: `/_report/${reportDirectory}/${report.file}`, ...(report.changes === undefined ? {} : { changes: report.changes }), ...(device ? { device } : {}) };
|
||||
const reports = options.reports.map(report => {
|
||||
const target = report.target ?? platformTarget(report.platform);
|
||||
return { ...report, target, sha256: createHash("sha256").update(report.zip).digest("hex"), file: `${target.id}.zip.enc` };
|
||||
});
|
||||
const listing = reports.map(report => listingEntry(report.target, `/_report/${reportDirectory}/${report.file}`, report.changes, report.device));
|
||||
return deploySealedReports({
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: `?platform=${report.platform}` })),
|
||||
reports: reports.map(report => ({ zip: report.zip, sha256: report.sha256, file: report.file, query: targetQuery(report.target) })),
|
||||
reportDirectory, listing, project: options.project, ...(options.owner ? { owner: options.owner } : {}),
|
||||
ownerHint: options.ownerHint ?? "Set report.preview.owner in .expo-explore/config.yaml to the account that should hold the hosted reports.",
|
||||
projectHint: options.projectHint ?? "Make sure your Expo account can create projects, or set report.preview.project to an existing project you can deploy to.",
|
||||
@@ -628,36 +685,52 @@ export async function deployLocalReports(options: {
|
||||
verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000 });
|
||||
}
|
||||
|
||||
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-(ios|android)$/;
|
||||
/** explore-(capture|review)-<run>-<attempt>-<target id>; the id starts with a letter, so the run and attempt end unambiguously. */
|
||||
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
|
||||
|
||||
/**
|
||||
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<platform>
|
||||
* directory under --inputs and each explore-review-… directory under --reports. Pairs them by platform and
|
||||
* looks up each report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
|
||||
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<target>
|
||||
* directory under --inputs and each explore-review-… directory under --reports (the target is the platform for
|
||||
* configs without targets). Pairs them by target, in the order the run's review lists its targets, and looks up each
|
||||
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
|
||||
*/
|
||||
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch }): Promise<PreviewReportInput[]> {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const directories = async (root: string, kind: "capture" | "review") => {
|
||||
const found = new Map<ExplorePlatform, string>();
|
||||
const found = new Map<string, string>();
|
||||
for (const name of (await readdir(root)).sort()) {
|
||||
const match = ARTIFACT_DIRECTORY.exec(name);
|
||||
if (!match || match[1] !== kind) continue;
|
||||
if (found.has(match[2] as ExplorePlatform)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
|
||||
if (!match || match[1] !== kind || !isTargetId(match[2])) continue;
|
||||
if (found.has(match[2]!)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
|
||||
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
|
||||
found.set(match[2] as ExplorePlatform, join(root, name));
|
||||
found.set(match[2]!, join(root, name));
|
||||
}
|
||||
return found;
|
||||
};
|
||||
const inputs = await directories(options.inputsPath, "capture"); const reports = await directories(options.reportsPath, "review");
|
||||
if (!inputs.size) throw previewError("PREVIEW_REPORTS_MISSING", "No explore-capture-<run>-<attempt>-<platform> artifact was downloaded",
|
||||
if (!inputs.size) throw previewError("PREVIEW_REPORTS_MISSING", "No explore-capture-<run>-<attempt>-<target> artifact was downloaded",
|
||||
"Download this run's explore-capture artifacts into the --inputs directory before ci:deploy.");
|
||||
if (inputs.size > 8) throw previewError("PREVIEW_REPORTS_INVALID", `${inputs.size} capture artifacts were downloaded; a run has at most 8 targets`,
|
||||
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
|
||||
const entries: PreviewReportInput[] = [];
|
||||
for (const [platform, inputDirectory] of inputs) {
|
||||
const reportPath = reports.get(platform);
|
||||
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${platform} capture has no report artifact to deploy`,
|
||||
"Rerun the workflow; the report job for that platform did not upload its explore-review artifact.");
|
||||
entries.push({ platform, inputPath: join(inputDirectory, "report-input.json"), reportPath, artifactUrl: "" });
|
||||
for (const [id, inputDirectory] of inputs) {
|
||||
const reportPath = reports.get(id);
|
||||
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${id} capture has no report artifact to deploy`,
|
||||
"Rerun the workflow; the report job for that target did not upload its explore-review artifact.");
|
||||
const inputPath = join(inputDirectory, "report-input.json");
|
||||
const runtime = (await readCiReportInput(inputPath)).publicReview.runtime;
|
||||
// A report from before targets names only its platform, and its artifact is named after it.
|
||||
const named = readTarget(runtime.target);
|
||||
if (named && named.id !== id) throw previewError("PREVIEW_REPORTS_INVALID", `The ${id} capture artifact holds the report of ${named.id}`,
|
||||
"Download only this run attempt's artifacts, as the capture jobs named them.");
|
||||
const target = named ?? (id === "ios" || id === "android" ? platformTarget(id) : { id, platform: runtime.platform ?? "ios", label: id });
|
||||
entries.push({ ...(id === target.platform ? { platform: target.platform } : {}), target, inputPath, reportPath, artifactUrl: "" });
|
||||
}
|
||||
// Config order, as the review lists its targets (or, before targets, its platforms); directory order otherwise.
|
||||
const listed = (await readCiReportInput(entries[0]!.inputPath)).publicReview.runtime;
|
||||
const order: string[] = listed.targets?.map(target => target.id) ?? listed.platforms ?? [];
|
||||
const rank = (entry: PreviewReportInput) => { const index = order.indexOf(entry.target!.id); return index === -1 ? order.length : index; };
|
||||
entries.sort((a, b) => rank(a) - rank(b));
|
||||
const review = (await readCiReportInput(entries[0]!.inputPath)).publicReview;
|
||||
if (review.pullRequest.origin === "local") throw new Error("Local reports cannot be deployed as hosted previews");
|
||||
const repository = review.pullRequest.repository;
|
||||
@@ -665,7 +738,7 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
|
||||
throw previewError("REPORT_INPUT_INVALID", "The report input does not name a GitHub run", "Use the report-input.json produced by this run's capture job.");
|
||||
}
|
||||
for (const entry of entries) {
|
||||
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.platform}`;
|
||||
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.target!.id}`;
|
||||
const url = `https://api.github.com/repos/${repository}/actions/runs/${review.runId}/artifacts?per_page=100&name=${encodeURIComponent(name)}`;
|
||||
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
|
||||
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
|
||||
@@ -673,7 +746,7 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
|
||||
const artifact = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
|
||||
if (!artifact || typeof artifact.id !== "number" || !Number.isSafeInteger(artifact.id) || artifact.id <= 0) {
|
||||
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
|
||||
"Rerun the workflow so every platform's report job uploads its artifact before the deploy job runs.", { retryable: true });
|
||||
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true });
|
||||
}
|
||||
entry.artifactUrl = `https://github.com/${repository}/actions/runs/${review.runId}/artifacts/${artifact.id}`;
|
||||
}
|
||||
@@ -723,7 +796,7 @@ async function verifyDeployment(check: { origin: string; token: string; reports:
|
||||
if (check.listing !== undefined) {
|
||||
const list = await get(`/p/${check.token}/reports.json`);
|
||||
const body = list.status === 200 ? await list.text() : "";
|
||||
if (list.status !== 200 || body !== check.listing) throw deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not list the platforms that were deployed.",
|
||||
if (list.status !== 200 || body !== check.listing) throw deployError("PREVIEW_VERIFY_FAILED", "The hosted preview did not list the targets that were deployed.",
|
||||
"Rerun the deploy job; the deployment's report listing did not match.", { details: { status: list.status } });
|
||||
}
|
||||
const other = check.token.endsWith("a") ? `${check.token.slice(0, -1)}b` : `${check.token.slice(0, -1)}a`;
|
||||
|
||||
+34
-13
@@ -1,7 +1,8 @@
|
||||
import { createHash, randomBytes } from "node:crypto";
|
||||
import { lstat, mkdir, readdir, readFile, rename, rm, writeFile } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import type { ExplorePlatform } from "../config/explore-config.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import type { ArtifactReport } from "../contracts/artifact-report.js";
|
||||
import { EXPLORATION_REPORT_KIND, type ExplorationReport } from "../contracts/standalone-report.js";
|
||||
import { exploreCacheRoot } from "../shared/cache-root.js";
|
||||
@@ -12,7 +13,7 @@ import { strongerGroup, type ChangeGroup } from "./pr-comment-record.js";
|
||||
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
|
||||
|
||||
/**
|
||||
* Every report a run produces on this machine is kept under `<cache>/reports/<id>/`: one `<platform>.zip` per platform
|
||||
* Every report a run produces on this machine is kept under `<cache>/reports/<id>/`: one `<target>.zip` per target
|
||||
* (the same ZIP a hosted or local Viewer serves) and `run.json`, what `expo-explore reports` lists. Local reviews,
|
||||
* explorations and uploaded reports land here, so a past run can be reopened or hosted without capturing it again.
|
||||
* Runs older than 30 days, and the oldest beyond 2 GB, are pruned whenever a run is saved.
|
||||
@@ -30,6 +31,8 @@ export type SavedRun = {
|
||||
/** A local review of uncommitted changes: how many files differed from HEAD. */
|
||||
uncommittedFiles?: number;
|
||||
platforms: ExplorePlatform[];
|
||||
/** The run's targets, in order; their ids name its ZIPs. Absent in runs saved before targets, whose ZIPs are named for `platforms`. */
|
||||
targets?: RunTarget[];
|
||||
device?: string;
|
||||
/** Changed surfaces by group across the platforms, as the PR comment counts them. */
|
||||
changes?: Partial<Record<ChangeGroup, number>>;
|
||||
@@ -40,7 +43,15 @@ export type SavedRun = {
|
||||
savedAt: string;
|
||||
bytes: number;
|
||||
};
|
||||
export type SavedReport = { platform: ExplorePlatform; zip: Uint8Array; changes?: number; device?: string };
|
||||
/** One report of a run. Without a target, it is the target named for its platform, as runs saved before targets were. */
|
||||
export type SavedReport = { platform: ExplorePlatform; target?: RunTarget; zip: Uint8Array; changes?: number; device?: string };
|
||||
|
||||
const PLATFORM_LABELS: Record<ExplorePlatform, string> = { ios: "iOS", android: "Android" };
|
||||
|
||||
/** A report's target: its own, else the one named for its platform. */
|
||||
export function reportTarget(report: Pick<SavedReport, "platform" | "target">): RunTarget {
|
||||
return report.target ?? { id: report.platform, platform: report.platform, label: PLATFORM_LABELS[report.platform] };
|
||||
}
|
||||
|
||||
export const SAVED_RUN_LIMITS = { maxAgeDays: 30, maxBytes: 2 * 1024 * 1024 * 1024 } as const;
|
||||
const ID = /^[a-z0-9][a-z0-9._-]{0,119}$/;
|
||||
@@ -84,14 +95,17 @@ export async function describeReports(reports: SavedReport[], extra: { subjects?
|
||||
const first = parsed[0]?.content;
|
||||
if (!first) throw new Error("Not an Explore report ZIP");
|
||||
const createdAt = extra.createdAt ?? new Date().toISOString();
|
||||
const platforms = parsed.map(entry => entry.report.platform);
|
||||
const platforms = [...new Set(parsed.map(entry => entry.report.platform))];
|
||||
// Targets named for their platforms describe a run saved the old way, which older versions can still read.
|
||||
const targets = reports.map(reportTarget);
|
||||
const named = targets.some(target => target.id !== target.platform) ? { targets } : {};
|
||||
if (first.file === "exploration.json") {
|
||||
const report = first.json as Partial<ExplorationReport>;
|
||||
if (report.kind !== EXPLORATION_REPORT_KIND || !report.exploration || !report.map) throw new Error("Not an Explore exploration report");
|
||||
const { app, device } = report.exploration;
|
||||
const zipHash = createHash("sha256").update(reports[0]!.zip).digest("hex").slice(0, 10);
|
||||
return { id: `explore-${slug(app.name, 40)}-${zipHash}`, kind: "exploration", title: `${app.name}${app.version ? ` ${app.version}` : ""}${app.buildNumber ? ` (${app.buildNumber})` : ""} on ${device.model}`,
|
||||
platforms, device: `${device.model} ${device.osVersion}`.trim(),
|
||||
platforms, ...named, device: `${device.model} ${device.osVersion}`.trim(),
|
||||
explored: { app: app.name, ...(app.version ? { version: app.version } : {}), ...(app.buildNumber ? { buildNumber: app.buildNumber } : {}),
|
||||
screens: report.map.screens.length, unexplored: report.coverage?.frontier.pending ?? 0 },
|
||||
createdAt: report.exploration.completedAt ?? createdAt };
|
||||
@@ -117,7 +131,7 @@ export async function describeReports(reports: SavedReport[], extra: { subjects?
|
||||
: `${kind === "compare" ? "compare" : `pr-${number}`}-${slug(pr.repository.split("/").at(-1) ?? "", 40)}-${slug(review.runId, 40)}-${slug(String(review.runAttempt), 8)}`;
|
||||
const commit = (side: "head" | "base"): SavedCommit => ({ ref: pr[side].ref, sha: pr[side].sha, ...(extra.subjects?.[side] ? { subject: extra.subjects[side] } : {}) });
|
||||
return { id, kind, title: pr.title, repository: pr.repository, ...(number === undefined ? {} : { number }), head: commit("head"), base: commit("base"),
|
||||
...(extra.uncommittedFiles ? { uncommittedFiles: extra.uncommittedFiles } : {}), platforms, ...(devices.length ? { device: devices.join(", ") } : {}),
|
||||
...(extra.uncommittedFiles ? { uncommittedFiles: extra.uncommittedFiles } : {}), platforms, ...named, ...(devices.length ? { device: devices.join(", ") } : {}),
|
||||
changes, createdAt: review.createdAt ?? createdAt };
|
||||
}
|
||||
|
||||
@@ -135,10 +149,13 @@ export async function saveRun(reports: SavedReport[], extra: Parameters<typeof d
|
||||
const kept = await findSavedRun(described.id, environment);
|
||||
if (kept && described.kind !== "exploration" && kept.kind === described.kind && kept.repository === described.repository
|
||||
&& kept.head?.sha === described.head?.sha && kept.base?.sha === described.base?.sha) {
|
||||
const others = (await readSavedReports(kept, environment).catch(() => [] as SavedReport[])).filter(report => !reports.some(each => each.platform === report.platform));
|
||||
const others = (await readSavedReports(kept, environment).catch(() => [] as SavedReport[])).filter(report => !reports.some(each => reportTarget(each).id === reportTarget(report).id));
|
||||
if (others.length) {
|
||||
const order: ExplorePlatform[] = ["ios", "android"];
|
||||
reports = [...reports, ...others].sort((a, b) => order.indexOf(a.platform) - order.indexOf(b.platform));
|
||||
// The targets' own order when the reports name it; iOS before Android for reports from before targets.
|
||||
const order = (await Promise.all([...reports, ...others].map(async report => ((await reportJson(report.zip))?.json as Partial<ArtifactReport> | undefined)?.review?.runtime?.targets)))
|
||||
.find(list => Array.isArray(list))?.map(target => target.id) ?? ["ios", "android"];
|
||||
const rank = (report: SavedReport) => { const index = order.indexOf(reportTarget(report).id); return index < 0 ? order.length : index; };
|
||||
reports = [...reports, ...others].sort((a, b) => rank(a) - rank(b));
|
||||
const subjects = { ...(kept.head?.subject ? { head: kept.head.subject } : {}), ...(kept.base?.subject ? { base: kept.base.subject } : {}), ...extra.subjects };
|
||||
described = await describeReports(reports, { ...extra, subjects, ...(kept.uncommittedFiles && !extra.uncommittedFiles ? { uncommittedFiles: kept.uncommittedFiles } : {}) });
|
||||
}
|
||||
@@ -147,7 +164,7 @@ export async function saveRun(reports: SavedReport[], extra: Parameters<typeof d
|
||||
const run = cleanRun({ version: 1, ...described, savedAt: new Date(now).toISOString(), bytes: reports.reduce((total, report) => total + report.zip.byteLength, 0) });
|
||||
try {
|
||||
await mkdir(staged);
|
||||
for (const report of reports) await writeFile(join(staged, `${report.platform}.zip`), report.zip);
|
||||
for (const report of reports) await writeFile(join(staged, `${reportTarget(report).id}.zip`), report.zip);
|
||||
await writeFile(join(staged, "run.json"), `${JSON.stringify(run, null, 2)}\n`);
|
||||
await rm(target, { recursive: true, force: true });
|
||||
await rename(staged, target);
|
||||
@@ -161,8 +178,11 @@ export async function saveRun(reports: SavedReport[], extra: Parameters<typeof d
|
||||
function validRun(value: unknown, id: string): SavedRun | undefined {
|
||||
const run = value as Partial<SavedRun> | undefined;
|
||||
if (!run || run.version !== 1 || run.id !== id || typeof run.title !== "string" || typeof run.bytes !== "number") return undefined;
|
||||
// Platforms name the ZIP files read back, so only the two there are.
|
||||
// Targets (else platforms) name the ZIP files read back, so only valid ids.
|
||||
if (!Array.isArray(run.platforms) || !run.platforms.length || run.platforms.some(platform => platform !== "ios" && platform !== "android")) return undefined;
|
||||
if (run.targets !== undefined && (!Array.isArray(run.targets) || !run.targets.length || run.targets.some(target => !target || !isTargetId(target.id)
|
||||
|| (target.platform !== "ios" && target.platform !== "android") || typeof target.label !== "string")
|
||||
|| new Set(run.targets.map(target => target.id)).size !== run.targets.length)) return undefined;
|
||||
if (!["local", "pull-request", "compare", "exploration"].includes(run.kind ?? "") || Number.isNaN(Date.parse(run.createdAt ?? "")) || Number.isNaN(Date.parse(run.savedAt ?? ""))) return undefined;
|
||||
return run as SavedRun;
|
||||
}
|
||||
@@ -188,10 +208,11 @@ export async function findSavedRun(idOrLatest: string, environment: NodeJS.Proce
|
||||
return idOrLatest === "latest" ? runs[0] : runs.find(run => run.id === idOrLatest);
|
||||
}
|
||||
|
||||
/** A saved run's reports, in the order the run lists its platforms, labelled for a Viewer's platform switch. */
|
||||
/** A saved run's reports, in the order the run lists its targets, labelled for a Viewer's target switch. */
|
||||
export async function readSavedReports(run: SavedRun, environment: NodeJS.ProcessEnv = process.env): Promise<SavedReport[]> {
|
||||
const root = join(savedRunsDirectory(environment), run.id);
|
||||
return Promise.all(run.platforms.map(async platform => ({ platform, zip: new Uint8Array(await readFile(join(root, `${platform}.zip`))) })));
|
||||
const targets = run.targets ?? run.platforms.map(platform => reportTarget({ platform }));
|
||||
return Promise.all(targets.map(async target => ({ platform: target.platform, target, zip: new Uint8Array(await readFile(join(root, `${target.id}.zip`))) })));
|
||||
}
|
||||
|
||||
export async function removeSavedRun(id: string, environment: NodeJS.ProcessEnv = process.env): Promise<boolean> {
|
||||
|
||||
@@ -50,9 +50,23 @@ export type ViewerLinkInput = {
|
||||
runAttempt: string;
|
||||
/** Set by the matrix workflows; the Viewer then downloads the platform-suffixed report artifact. */
|
||||
platform?: "ios" | "android";
|
||||
/** The capture target's id when the run captures several (wins over `platform`); the artifact is suffixed with it. */
|
||||
target?: string;
|
||||
configPath: string;
|
||||
};
|
||||
|
||||
/** The target id grammar (TARGET_ID_PATTERN, minus the names isTargetId reserves). */
|
||||
const TARGET_ID = /^[a-z][a-z0-9-]{0,31}$/;
|
||||
|
||||
/**
|
||||
* The query parameter that selects a target's report: `platform=<id>` for a target named after its platform, so links for
|
||||
* configs without targets stay byte-identical and old Workers and Viewers still read them; `target=<id>` for any other.
|
||||
*/
|
||||
export function targetParameter(id: string): ["platform" | "target", string] {
|
||||
if (!TARGET_ID.test(id) || ["base", "head", "report"].includes(id) || id.startsWith("install-")) throw new Error("target id is invalid");
|
||||
return [id === "ios" || id === "android" ? "platform" : "target", id];
|
||||
}
|
||||
|
||||
const SAFE_ID = /^[A-Za-z0-9._-]{1,200}$/;
|
||||
// A secondary appearance surface is `<route>@<scheme>` (see schemeScreenId).
|
||||
const SURFACE_ID = /^[A-Za-z0-9._-]{1,200}(@(light|dark))?$/;
|
||||
@@ -77,16 +91,17 @@ function repositoryPath(repository: string): string {
|
||||
const PREVIEW_PATH = /^\/p\/[a-z2-7]{32}$/;
|
||||
|
||||
/** Deep links on a verified preview URL (`https://<project>--<id>.expo.app/p/<token>`), same grammar as the central Viewer. */
|
||||
export function previewLinks(previewUrl: string, expiresAt: number | null, platform?: "ios" | "android"): PreviewLinks {
|
||||
export function previewLinks(previewUrl: string, expiresAt: number | null, target?: string): PreviewLinks {
|
||||
const url = safeHttpUrl(previewUrl, "preview URL");
|
||||
if (url.protocol !== "https:" || url.search || url.hash || !PREVIEW_PATH.test(url.pathname)) {
|
||||
throw new Error("preview URL must be an https token page without a query or fragment");
|
||||
}
|
||||
if (expiresAt !== null && (!Number.isFinite(expiresAt) || expiresAt <= 0)) throw new Error("preview expiry must be a timestamp or null");
|
||||
const selection = target ? targetParameter(target) : undefined;
|
||||
const make = (params: Record<string, string> = {}) => {
|
||||
const link = new URL(url.href);
|
||||
// Several platforms share one token page; `platform` picks this report's archive.
|
||||
if (platform) link.searchParams.set("platform", platform);
|
||||
// Several targets share one token page; `platform` or `target` picks this report's archive.
|
||||
if (selection) link.searchParams.set(...selection);
|
||||
for (const [key, value] of Object.entries(params)) link.searchParams.set(key, value);
|
||||
return link.href;
|
||||
};
|
||||
@@ -107,6 +122,8 @@ export function viewerLinks(input: ViewerLinkInput): ViewerLinks {
|
||||
throw new Error("configPath must be a relative repository path");
|
||||
}
|
||||
const repository = `https://github.com/${repositoryPath(input.repository)}`;
|
||||
const targetId = input.target ?? input.platform;
|
||||
const selection = targetId ? targetParameter(targetId) : undefined;
|
||||
const artifact = input.artifactUrl ? safeHttpUrl(input.artifactUrl, "artifact URL") : undefined;
|
||||
if (artifact && (artifact.origin !== "https://github.com" || artifact.search || artifact.hash
|
||||
|| !new RegExp(`^/${repositoryPath(input.repository).replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}/actions/runs/${input.runId}/artifacts/[1-9][0-9]*$`).test(artifact.pathname))) {
|
||||
@@ -119,7 +136,7 @@ export function viewerLinks(input: ViewerLinkInput): ViewerLinks {
|
||||
url.searchParams.set("repo", input.repository);
|
||||
url.searchParams.set("run", input.runId);
|
||||
url.searchParams.set("attempt", input.runAttempt);
|
||||
if (input.platform) url.searchParams.set("platform", input.platform);
|
||||
if (selection) url.searchParams.set(...selection);
|
||||
url.searchParams.set("artifact", artifact.pathname.split("/").at(-1)!);
|
||||
for (const [key, value] of Object.entries(params)) url.searchParams.set(key, value);
|
||||
return url.href;
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { appearancePairs, bundleColorSchemes, routeIdOfScreen } from "../capture/appearance.js";
|
||||
import { createHash } from "node:crypto";
|
||||
import { lstat, readFile, realpath } from "node:fs/promises";
|
||||
@@ -259,6 +260,9 @@ export type CaptureReviewOptions = {
|
||||
app?: { version?: string; buildNumber?: string };
|
||||
/** The platforms config.yaml captures (this report's platform among them), when more than one. */
|
||||
platforms?: Array<"ios" | "android">;
|
||||
/** The target this report captures, and every target config.yaml captures (this one among them), when more than one. */
|
||||
target?: RunTarget;
|
||||
targets?: RunTarget[];
|
||||
};
|
||||
|
||||
/** Build the validated review independently of where its metadata and images will be stored. */
|
||||
@@ -298,6 +302,8 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
|
||||
platform: head.bundle.platform ?? "ios", ...(head.bundle.controller === "argent" ? { controller: "argent" as const } : {}), statusBarBandPercent: statusBarBandPercent(head.bundle.platform),
|
||||
...(homeIndicatorBandPercent(head.bundle.platform) > 0 ? { homeIndicatorBandPercent: homeIndicatorBandPercent(head.bundle.platform) } : {}),
|
||||
...(options.platforms && options.platforms.length > 1 ? { platforms: [...options.platforms] } : {}),
|
||||
...(options.target ? { target: { ...options.target } } : {}),
|
||||
...(options.targets && options.targets.length > 1 ? { targets: options.targets.map(target => ({ ...target })) } : {}),
|
||||
...(colorSchemes.length > 1 ? { colorSchemes: [...colorSchemes] } : {}),
|
||||
...(head.bundle.runtimeProfile ? { device: { model: head.bundle.runtimeProfile.deviceModel, osVersion: head.bundle.runtimeProfile.osVersion } } : {}),
|
||||
...(head.bundle.appName?.trim() ? { appName: head.bundle.appName.trim() } : {}),
|
||||
|
||||
@@ -13,9 +13,10 @@ import type { ExploreMap, Observation, Screen } from "../types.js";
|
||||
import { CAPTURE_OBSERVER_IDENTIFIER } from "../capture/observer.js";
|
||||
import { ARGENT_VERSION } from "../shared/argent-version.js";
|
||||
|
||||
/** Strict, non-secret subset written after a successful EAS Simulator cleanup. */
|
||||
/** Strict, non-secret subset written after a successful simulator cleanup. */
|
||||
export type RuntimeExecutionContext = {
|
||||
provider: "eas-simulator";
|
||||
/** EAS Simulator, or a simulator Explore created on the capturing Mac (`capture.simulator: local`). */
|
||||
provider: "eas-simulator" | "local-simulator";
|
||||
controller: "agent-device" | "argent";
|
||||
/** The pinned package of the controller that drove the session. */
|
||||
controllerPackageVersion: typeof AGENT_DEVICE_VERSION | typeof ARGENT_VERSION;
|
||||
@@ -111,7 +112,7 @@ export function parseRuntimeExecutionContext(value: unknown): RuntimeExecutionCo
|
||||
})();
|
||||
const controller = literal(context.controller, ["agent-device", "argent"], "Runtime controller");
|
||||
return {
|
||||
provider: literal(context.provider, ["eas-simulator"], "Runtime provider"),
|
||||
provider: literal(context.provider, ["eas-simulator", "local-simulator"], "Runtime provider"),
|
||||
controller,
|
||||
controllerPackageVersion: literal(
|
||||
context.controllerPackageVersion,
|
||||
|
||||
@@ -92,7 +92,7 @@ export type RawCaptureSample = {
|
||||
};
|
||||
|
||||
export type RawSimulatorEnvironment = {
|
||||
provider: "eas-simulator";
|
||||
provider: "eas-simulator" | "local-simulator";
|
||||
controller: "agent-device" | "argent";
|
||||
platform: Platform;
|
||||
deviceModel: string;
|
||||
@@ -246,7 +246,7 @@ export type RuntimeEnvironmentEvidence = {
|
||||
id: "environment";
|
||||
profile: EvidenceField<"capture-context", string>;
|
||||
fixturePersona?: EvidenceField<"capture-context", string>;
|
||||
provider: EvidenceField<"eas-agent-device", "eas-simulator">;
|
||||
provider: EvidenceField<"eas-agent-device", "eas-simulator" | "local-simulator">;
|
||||
controller: EvidenceField<"eas-agent-device", "agent-device" | "argent">;
|
||||
controllerPackageVersion?: EvidenceField<"capture-context", string>;
|
||||
easCliVersion?: EvidenceField<"capture-context", string>;
|
||||
@@ -784,7 +784,7 @@ function parseEnvironment(value: unknown): RawSimulatorEnvironment {
|
||||
"Runtime environment",
|
||||
);
|
||||
return {
|
||||
provider: literal(environment.provider, ["eas-simulator"], "Runtime provider"),
|
||||
provider: literal(environment.provider, ["eas-simulator", "local-simulator"], "Runtime provider"),
|
||||
controller: literal(environment.controller, ["agent-device", "argent"], "Runtime controller"),
|
||||
platform: literal(environment.platform, PLATFORMS, "Runtime platform"),
|
||||
deviceModel: safeString(environment.deviceModel, "Device model", 256),
|
||||
|
||||
@@ -3,4 +3,4 @@
|
||||
* controller (`--package-version`), the daemon health check, and the screenshot diff tool must
|
||||
* all be this version; each caller checks it by exact equality.
|
||||
*/
|
||||
export const AGENT_DEVICE_VERSION = "0.21.15";
|
||||
export const AGENT_DEVICE_VERSION = "0.21.28";
|
||||
@@ -1,8 +1,10 @@
|
||||
/**
|
||||
* The device controllers Explore drives, fetched on first use instead of installed with Explore. Each is pinned to
|
||||
* an exact npm release and its sha512 integrity; the tarball is checked before anything in it is written, nothing in
|
||||
* it runs at install time, and neither controller needs other packages at run time.
|
||||
* it runs at install time, and neither controller needs other packages at run time. Argent's tool-server, which a
|
||||
* local simulator needs, is the exception: ensureArgentToolServer installs it with its dependencies.
|
||||
*/
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { createHash, randomUUID } from "node:crypto";
|
||||
import { existsSync, mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
|
||||
import { chmod, mkdir, open, readdir, rename, rm, stat, writeFile } from "node:fs/promises";
|
||||
@@ -19,7 +21,7 @@ export type ControllerName = "agent-device" | "argent";
|
||||
/** Each controller's npm release, the file Explore runs from it, and the integrity npm publishes for it. */
|
||||
export const CONTROLLER_PACKAGES: Record<ControllerName, { name: string; version: string; bin: string; integrity: string }> = {
|
||||
"agent-device": { name: "agent-device", version: AGENT_DEVICE_VERSION, bin: "bin/agent-device.mjs",
|
||||
integrity: "sha512-Om1j6oNJkeKlkk8lBM+0V9bKwpxUXLMf/PDDSvAt3RFquBRqAiM58J81E0rvPQNxs6GCjhABYpwVvIAXptxjjA==" },
|
||||
integrity: "sha512-uGEENVhPzSpIACrVlt16O1mloODWJyAemTCT0boDb4L006JXN2rG747u1TRoQJudOpdP/Pm2urxNRHeECLMLfg==" },
|
||||
argent: { name: "@swmansion/argent", version: ARGENT_VERSION, bin: "dist/cli.js",
|
||||
integrity: "sha512-XXWlWZJlHKqnAvNx3RDhuiVFQOPqh5EDB76+mFAyqC2mutC6irzw03+M/6S/WQ+Dzz2IYOkEfOzQnOOdhrGgJg==" },
|
||||
};
|
||||
@@ -168,3 +170,66 @@ export async function ensureController(controller: ControllerName, options: {
|
||||
await rm(staging, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
/** The tool-server's package and its lockfile, shipped with Explore: every dependency is the version and tarball locked there. */
|
||||
const ARGENT_TOOL_SERVER_LOCK = fileURLToPath(new URL("../../controllers/argent-tool-server/", import.meta.url));
|
||||
|
||||
/**
|
||||
* Where the tool-server is installed in the controller cache: by Argent's version and the lockfile's hash, so a changed
|
||||
* lock (or an install from before there was one) is installed afresh.
|
||||
*/
|
||||
export function argentToolServerDirectory(root: string): string {
|
||||
const lock = createHash("sha256").update(readFileSync(join(ARGENT_TOOL_SERVER_LOCK, "package-lock.json"))).digest("hex").slice(0, 12);
|
||||
return join(root, `argent-tool-server@${CONTROLLER_PACKAGES.argent.version}-${lock}`);
|
||||
}
|
||||
|
||||
/** npm gets what it needs to reach the registry, never the tokens and keys a capture's environment carries. */
|
||||
export function npmEnvironment(environment: NodeJS.ProcessEnv): NodeJS.ProcessEnv {
|
||||
return Object.fromEntries(Object.entries(environment).filter(([name]) => /^(PATH|HOME|USER|LOGNAME|SHELL|TMPDIR|TEMP|TMP|LANG|LC_ALL|LC_CTYPE|SystemRoot|WINDIR|APPDATA|LOCALAPPDATA|NODE_EXTRA_CA_CERTS|(HTTPS?|NO|ALL)_PROXY|(https?|no|all)_proxy|npm_config_\w+|NPM_CONFIG_\w+)$/.test(name)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Argent's tool-server, for driving simulators on this machine (`capture.simulator: local`): unlike the client, it
|
||||
* needs Argent's dependencies, some with native prebuilds (tree-sitter). They are installed once, on first use, with
|
||||
* `npm ci` from the lockfile Explore ships, so each package is the exact tarball locked there, and without running any
|
||||
* package's install scripts. Returns its CLI.
|
||||
*/
|
||||
export async function ensureArgentToolServer(options: { environment?: NodeJS.ProcessEnv; progress?: (message: string) => void;
|
||||
/** Tests: stands in for `npm ci`, given the folder to install into (its package.json and lockfile are there). */
|
||||
install?: (directory: string) => Promise<void> } = {}): Promise<string> {
|
||||
const environment = options.environment ?? process.env;
|
||||
const pinned = CONTROLLER_PACKAGES.argent;
|
||||
const root = controllerCacheRoot(environment);
|
||||
const directory = argentToolServerDirectory(root);
|
||||
const cli = join(directory, "node_modules", "@swmansion", "argent", pinned.bin);
|
||||
if (existsSync(join(directory, COMPLETE))) return cli;
|
||||
await mkdir(root, { recursive: true, mode: 0o700 });
|
||||
await removeAbandonedStaging(root);
|
||||
const staging = join(root, `.staging-${process.pid}-${randomUUID()}`);
|
||||
try {
|
||||
options.progress?.(`installing Argent's tool-server (${pinned.name}@${pinned.version} and its locked dependencies)`);
|
||||
await mkdir(staging, { mode: 0o700 });
|
||||
for (const file of ["package.json", "package-lock.json"]) await writeFile(join(staging, file), readFileSync(join(ARGENT_TOOL_SERVER_LOCK, file)));
|
||||
await (options.install ?? (async target => {
|
||||
const registry = environment.EXPLORE_NPM_REGISTRY ? ["--registry", environment.EXPLORE_NPM_REGISTRY] : [];
|
||||
const npm = spawnSync("npm", ["ci", "--omit=optional", "--ignore-scripts", "--no-audit", "--no-fund", ...registry],
|
||||
{ cwd: target, env: npmEnvironment(environment), encoding: "utf8", timeout: 10 * 60_000 });
|
||||
if (npm.error || npm.status !== 0) throw new CiError({ code: "CONTROLLER_DOWNLOAD_FAILED", stage: "preflight",
|
||||
message: `Argent's tool-server could not be installed: ${(npm.error?.message ?? npm.stderr ?? "").trim().split("\n").at(-1) ?? "npm failed"}`,
|
||||
nextAction: "Check that npm is on PATH and can reach the registry (or set EXPLORE_NPM_REGISTRY), then rerun." });
|
||||
}))(staging);
|
||||
// npm ci checked every package against the lockfile; Argent itself must also be the exact release Explore pins.
|
||||
const lock = JSON.parse(readFileSync(join(staging, "package-lock.json"), "utf8")) as { packages?: Record<string, { version?: string; integrity?: string }> };
|
||||
const installed = lock.packages?.[`node_modules/${pinned.name}`];
|
||||
if (installed?.version !== pinned.version || installed.integrity !== pinned.integrity) throw new CiError({ code: "CONTROLLER_INTEGRITY_MISMATCH", stage: "preflight",
|
||||
message: `The ${pinned.name} npm installed (${installed?.version ?? "none"}, ${installed?.integrity ?? "no integrity"}) is not the release Explore pins.`,
|
||||
nextAction: "Do not use this registry for Explore's controllers; unset EXPLORE_NPM_REGISTRY or point it at a faithful mirror." });
|
||||
await writeFile(join(staging, COMPLETE), `${JSON.stringify({ name: pinned.name, version: pinned.version, integrity: pinned.integrity })}\n`);
|
||||
// Several captures may install at once; the first to finish keeps its copy.
|
||||
try { await rename(staging, directory); }
|
||||
catch (error) { if (!existsSync(join(directory, COMPLETE))) throw error; }
|
||||
return cli;
|
||||
} finally {
|
||||
await rm(staging, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
@@ -77,12 +77,22 @@ export type RunEnvironment = {
|
||||
instructions?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* A named capture target: one platform's device, in one pose, captured as its own report. A config without `targets`
|
||||
* has one target per platform, named after it (`ios`, `android`).
|
||||
*/
|
||||
export type RunTarget = { id: string; platform: Platform; label: string };
|
||||
|
||||
export type ExploreRun = {
|
||||
id: string;
|
||||
name: string;
|
||||
platform: Platform;
|
||||
/** Every platform the review captured, when more than one; the Viewer links the sibling report. */
|
||||
platforms?: Platform[];
|
||||
/** The target this report captured; absent in reports from before targets, which are named for their platform. */
|
||||
target?: RunTarget;
|
||||
/** Every target the review captured, in config order, when more than one; the Viewer links the sibling reports. */
|
||||
targets?: RunTarget[];
|
||||
controller: Controller;
|
||||
bundleId?: string;
|
||||
deviceId?: string;
|
||||
|
||||
@@ -16,15 +16,15 @@ concurrency:
|
||||
group: explore-baseline-${{ github.sha }}
|
||||
cancel-in-progress: false
|
||||
jobs:
|
||||
# The platforms .expo-explore/config.yaml captures (ios, android, or both): one baseline job each.
|
||||
platforms:
|
||||
# The targets .expo-explore/config.yaml captures (ios, android, or the devices under targets:): one baseline job each.
|
||||
targets:
|
||||
if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 10
|
||||
permissions:
|
||||
contents: read
|
||||
outputs:
|
||||
platforms: ${{ steps.platforms.outputs.platforms }}
|
||||
targets: ${{ steps.targets.outputs.targets }}
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with: { ref: '${{ github.sha }}', path: app, persist-credentials: false }
|
||||
@@ -46,25 +46,25 @@ jobs:
|
||||
tar -xzf "$TOOLS_PREFIX"/expo-explore-*.tgz -C "$TOOLS_PREFIX"
|
||||
cd "$TOOLS"
|
||||
npm ci --omit=dev --include=optional --ignore-scripts --no-audit --no-fund
|
||||
- name: List the configured platforms
|
||||
id: platforms
|
||||
- name: List the configured targets
|
||||
id: targets
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
platforms="$(node "$TOOLS/dist/cli.js" config:platforms --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '.platforms')"
|
||||
echo "platforms=$platforms" >> "$GITHUB_OUTPUT"
|
||||
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
|
||||
echo "targets=$targets" >> "$GITHUB_OUTPUT"
|
||||
baseline:
|
||||
needs: platforms
|
||||
needs: targets
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
platform: ${{ fromJSON(needs.platforms.outputs.platforms) }}
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 90
|
||||
permissions:
|
||||
contents: read
|
||||
env:
|
||||
PLATFORM: ${{ matrix.platform }}
|
||||
TARGET: ${{ matrix.target }}
|
||||
steps:
|
||||
- name: Validate baseline source
|
||||
shell: bash
|
||||
@@ -93,7 +93,7 @@ jobs:
|
||||
node "$TOOLS/dist/cli.js" source:verify \
|
||||
--base-project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --head-project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" \
|
||||
--base-sha "$GITHUB_SHA" --head-sha "$GITHUB_SHA" --scope all \
|
||||
--config .expo-explore/config.yaml --output "$RUNNER_TEMP/explore-consistency" --platform "$PLATFORM"
|
||||
--config .expo-explore/config.yaml --output "$RUNNER_TEMP/explore-consistency" --target "$TARGET"
|
||||
- name: Install app dependencies
|
||||
shell: bash
|
||||
run: npm ci --ignore-scripts --prefix "app/$APP_INSTALL_DIR"
|
||||
@@ -108,7 +108,7 @@ jobs:
|
||||
run: |
|
||||
set -euo pipefail
|
||||
node "$TOOLS/dist/cli.js" capture:baseline --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" \
|
||||
--sha "$GITHUB_SHA" --config .expo-explore/config.yaml --output "$RUNNER_TEMP/explore-baseline" --platform "$PLATFORM"
|
||||
--sha "$GITHUB_SHA" --config .expo-explore/config.yaml --output "$RUNNER_TEMP/explore-baseline" --target "$TARGET"
|
||||
- name: Stop the capture session and check the checkout
|
||||
if: always() && steps.explore.outcome == 'success'
|
||||
timeout-minutes: 5
|
||||
@@ -119,7 +119,7 @@ jobs:
|
||||
- name: Upload exact-commit baseline evidence
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-baseline-${{ github.sha }}-${{ matrix.platform }}
|
||||
name: explore-baseline-${{ github.sha }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-baseline/baseline-export
|
||||
retention-days: 30
|
||||
if-no-files-found: error
|
||||
@@ -127,7 +127,7 @@ jobs:
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-baseline-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-baseline-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: |
|
||||
${{ runner.temp }}/explore-consistency
|
||||
${{ runner.temp }}/explore-diagnostics
|
||||
|
||||
@@ -40,14 +40,14 @@ concurrency:
|
||||
group: explore-compare-${{ inputs.base }}..${{ inputs.head }}
|
||||
cancel-in-progress: false
|
||||
jobs:
|
||||
# Resolves both refs to commits once, and lists the platforms .expo-explore/config.yaml captures at head.
|
||||
platforms:
|
||||
# Resolves both refs to commits once, and lists the targets .expo-explore/config.yaml captures at head.
|
||||
targets:
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 10
|
||||
permissions:
|
||||
contents: read
|
||||
outputs:
|
||||
platforms: ${{ steps.platforms.outputs.platforms }}
|
||||
targets: ${{ steps.targets.outputs.targets }}
|
||||
base: ${{ steps.refs.outputs.base }}
|
||||
head: ${{ steps.refs.outputs.head }}
|
||||
compare: ${{ steps.refs.outputs.compare }}
|
||||
@@ -84,19 +84,19 @@ jobs:
|
||||
HEAD_SHA: ${{ steps.refs.outputs.head }}
|
||||
shell: bash
|
||||
run: git -C app-head checkout --quiet --detach "$HEAD_SHA"
|
||||
- name: List the configured platforms
|
||||
id: platforms
|
||||
- name: List the configured targets
|
||||
id: targets
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
platforms="$(node "$TOOLS/dist/cli.js" config:platforms --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '.platforms')"
|
||||
echo "platforms=$platforms" >> "$GITHUB_OUTPUT"
|
||||
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
|
||||
echo "targets=$targets" >> "$GITHUB_OUTPUT"
|
||||
capture:
|
||||
needs: platforms
|
||||
needs: targets
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
platform: ${{ fromJSON(needs.platforms.outputs.platforms) }}
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 120
|
||||
permissions:
|
||||
@@ -106,14 +106,14 @@ jobs:
|
||||
# "eas" when .expo-explore/config.yaml sets report.preview.hosting; the deploy job runs only then.
|
||||
preview: ${{ steps.capture.outputs.preview }}
|
||||
env:
|
||||
PLATFORM: ${{ matrix.platform }}
|
||||
BASE_SHA: ${{ needs.platforms.outputs.base }}
|
||||
HEAD_SHA: ${{ needs.platforms.outputs.head }}
|
||||
TARGET: ${{ matrix.target }}
|
||||
BASE_SHA: ${{ needs.targets.outputs.base }}
|
||||
HEAD_SHA: ${{ needs.targets.outputs.head }}
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with: { ref: '${{ needs.platforms.outputs.base }}', path: app-base, fetch-depth: 0, persist-credentials: false }
|
||||
with: { ref: '${{ needs.targets.outputs.base }}', path: app-base, fetch-depth: 0, persist-credentials: false }
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with: { ref: '${{ needs.platforms.outputs.head }}', path: app-head, fetch-depth: 0, persist-credentials: false }
|
||||
with: { ref: '${{ needs.targets.outputs.head }}', path: app-head, fetch-depth: 0, persist-credentials: false }
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
- name: Install the launch recording decoder
|
||||
@@ -132,7 +132,7 @@ jobs:
|
||||
node "$TOOLS/dist/cli.js" source:verify \
|
||||
--base-project "$GITHUB_WORKSPACE/app-base/$APP_PROJECT_DIR" --head-project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" \
|
||||
--base-sha "$BASE_SHA" --head-sha "$HEAD_SHA" --config .expo-explore/config.yaml --output "$RUNNER_TEMP/explore-consistency" \
|
||||
--platform "$PLATFORM" ${SCOPE:+--scope "$SCOPE"}
|
||||
--target "$TARGET" ${SCOPE:+--scope "$SCOPE"}
|
||||
- name: Install app dependencies
|
||||
shell: bash
|
||||
run: |
|
||||
@@ -145,7 +145,7 @@ jobs:
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:find-baseline --sha "$BASE_SHA" --platform "$PLATFORM"
|
||||
run: node "$TOOLS/dist/cli.js" ci:find-baseline --sha "$BASE_SHA" --target "$TARGET"
|
||||
- name: Download optional exact-base evidence
|
||||
if: steps.cache.outputs.id != ''
|
||||
continue-on-error: true
|
||||
@@ -159,7 +159,7 @@ jobs:
|
||||
- name: Capture review
|
||||
id: capture
|
||||
env:
|
||||
COMPARE: ${{ needs.platforms.outputs.compare }}
|
||||
COMPARE: ${{ needs.targets.outputs.compare }}
|
||||
SCOPE: ${{ inputs.scope }}
|
||||
EXPIRES_IN: ${{ inputs.expires-in }}
|
||||
EXPO_TOKEN: ${{ secrets.EXPO_TOKEN }}
|
||||
@@ -175,7 +175,7 @@ jobs:
|
||||
node "$TOOLS/dist/cli.js" capture:review \
|
||||
--base-project "$GITHUB_WORKSPACE/app-base/$APP_PROJECT_DIR" --head-project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" \
|
||||
--compare "$RUNNER_TEMP/explore-compare.json" --output "$RUNNER_TEMP/explore-review" --config .expo-explore/config.yaml \
|
||||
--platform "$PLATFORM" ${SCOPE:+--scope "$SCOPE"} ${EXPIRES_IN:+--expires-in "$EXPIRES_IN"}
|
||||
--target "$TARGET" ${SCOPE:+--scope "$SCOPE"} ${EXPIRES_IN:+--expires-in "$EXPIRES_IN"}
|
||||
- name: Stop capture sessions and check the checkouts
|
||||
if: always() && steps.explore.outcome == 'success'
|
||||
timeout-minutes: 5
|
||||
@@ -186,7 +186,7 @@ jobs:
|
||||
- name: Upload captured review for packaging
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: |
|
||||
${{ runner.temp }}/explore-review/report-input.json
|
||||
${{ runner.temp }}/explore-review/plan.json
|
||||
@@ -201,7 +201,7 @@ jobs:
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: |
|
||||
${{ runner.temp }}/explore-consistency
|
||||
${{ runner.temp }}/explore-diagnostics
|
||||
@@ -216,32 +216,32 @@ jobs:
|
||||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
report:
|
||||
needs: [platforms, capture]
|
||||
needs: [targets, capture]
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
platform: ${{ fromJSON(needs.platforms.outputs.platforms) }}
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 20
|
||||
permissions:
|
||||
contents: read
|
||||
env:
|
||||
PLATFORM: ${{ matrix.platform }}
|
||||
TARGET: ${{ matrix.target }}
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-review
|
||||
- name: Package the report
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --platform "$PLATFORM"
|
||||
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
|
||||
id: report
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-review-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-review-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-report
|
||||
retention-days: 30
|
||||
if-no-files-found: error
|
||||
@@ -249,19 +249,19 @@ jobs:
|
||||
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" --platform "$PLATFORM"
|
||||
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
|
||||
- name: Upload report failure diagnostics
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-report-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-report-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-diagnostics
|
||||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
# Hosted report (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment serving every platform's report.
|
||||
# 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.
|
||||
deploy:
|
||||
needs: [platforms, capture, report]
|
||||
needs: [targets, capture, report]
|
||||
if: needs.capture.outputs.preview == 'eas'
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 20
|
||||
@@ -271,7 +271,7 @@ jobs:
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
# One directory per platform artifact (explore-capture-<run>-<attempt>-<platform>, explore-review-<run>-<attempt>-<platform>).
|
||||
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
|
||||
|
||||
@@ -21,8 +21,8 @@ concurrency:
|
||||
group: explore-review-${{ github.event.pull_request.number || inputs.pr }}
|
||||
cancel-in-progress: false
|
||||
jobs:
|
||||
# The platforms .expo-explore/config.yaml captures (ios, android, or both): one capture and report job each.
|
||||
platforms:
|
||||
# The targets .expo-explore/config.yaml captures (ios, android, or the devices under targets:): one capture and report job each.
|
||||
targets:
|
||||
if: >-
|
||||
github.event_name != 'pull_request_target' ||
|
||||
(github.event.pull_request.draft == false && github.event.pull_request.head.repo.full_name == github.repository)
|
||||
@@ -32,7 +32,7 @@ jobs:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
outputs:
|
||||
platforms: ${{ steps.platforms.outputs.platforms }}
|
||||
targets: ${{ steps.targets.outputs.targets }}
|
||||
# The failure job comments with these when a capture job fails before it resolves the PR itself.
|
||||
pr_number: ${{ steps.pr.outputs.pr_number }}
|
||||
base: ${{ steps.pr.outputs.base }}
|
||||
@@ -64,19 +64,19 @@ jobs:
|
||||
run: node "$TOOLS/dist/cli.js" ci:pr --pr "$PR_NUMBER" --app-dir "$APP_PROJECT_DIR"
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with: { ref: '${{ steps.pr.outputs.head }}', path: app-head, persist-credentials: false }
|
||||
- name: List the configured platforms
|
||||
id: platforms
|
||||
- name: List the configured targets
|
||||
id: targets
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
platforms="$(node "$TOOLS/dist/cli.js" config:platforms --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '.platforms')"
|
||||
echo "platforms=$platforms" >> "$GITHUB_OUTPUT"
|
||||
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
|
||||
echo "targets=$targets" >> "$GITHUB_OUTPUT"
|
||||
capture:
|
||||
needs: platforms
|
||||
needs: targets
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
platform: ${{ fromJSON(needs.platforms.outputs.platforms) }}
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 120
|
||||
permissions:
|
||||
@@ -91,7 +91,7 @@ jobs:
|
||||
# "eas" when .expo-explore/config.yaml sets report.preview.hosting; the deploy job runs only then.
|
||||
preview: ${{ steps.capture.outputs.preview }}
|
||||
env:
|
||||
PLATFORM: ${{ matrix.platform }}
|
||||
TARGET: ${{ matrix.target }}
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
@@ -122,7 +122,7 @@ jobs:
|
||||
node "$TOOLS/dist/cli.js" source:verify \
|
||||
--base-project "$GITHUB_WORKSPACE/app-base/$APP_PROJECT_DIR" --head-project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" \
|
||||
--base-sha "$BASE_SHA" --head-sha "$HEAD_SHA" --config .expo-explore/config.yaml --output "$RUNNER_TEMP/explore-consistency" \
|
||||
--platform "$PLATFORM"
|
||||
--target "$TARGET"
|
||||
- name: Install app dependencies
|
||||
shell: bash
|
||||
run: |
|
||||
@@ -136,7 +136,7 @@ jobs:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
BASE_SHA: ${{ steps.pr.outputs.base }}
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:find-baseline --sha "$BASE_SHA" --platform "$PLATFORM"
|
||||
run: node "$TOOLS/dist/cli.js" ci:find-baseline --sha "$BASE_SHA" --target "$TARGET"
|
||||
- name: Download optional exact-base evidence
|
||||
if: steps.cache.outputs.id != ''
|
||||
continue-on-error: true
|
||||
@@ -163,7 +163,7 @@ jobs:
|
||||
node "$TOOLS/dist/cli.js" capture:review \
|
||||
--base-project "$GITHUB_WORKSPACE/app-base/$APP_PROJECT_DIR" --head-project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" \
|
||||
--pull-request "$RUNNER_TEMP/explore-pr.json" --output "$RUNNER_TEMP/explore-review" --config .expo-explore/config.yaml \
|
||||
--platform "$PLATFORM"
|
||||
--target "$TARGET"
|
||||
- name: Stop capture sessions and check the checkouts
|
||||
if: always() && steps.pr.outcome == 'success'
|
||||
timeout-minutes: 5
|
||||
@@ -174,7 +174,7 @@ jobs:
|
||||
- name: Upload captured review for packaging
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: |
|
||||
${{ runner.temp }}/explore-review/report-input.json
|
||||
${{ runner.temp }}/explore-review/plan.json
|
||||
@@ -189,7 +189,7 @@ jobs:
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: |
|
||||
${{ runner.temp }}/explore-consistency
|
||||
${{ runner.temp }}/explore-diagnostics
|
||||
@@ -204,11 +204,11 @@ jobs:
|
||||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
report:
|
||||
needs: [platforms, capture]
|
||||
needs: [targets, capture]
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
platform: ${{ fromJSON(needs.platforms.outputs.platforms) }}
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 20
|
||||
permissions:
|
||||
@@ -216,22 +216,22 @@ jobs:
|
||||
actions: read
|
||||
pull-requests: write
|
||||
env:
|
||||
PLATFORM: ${{ matrix.platform }}
|
||||
TARGET: ${{ matrix.target }}
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-review
|
||||
- name: Package hosted review bundle
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --platform "$PLATFORM"
|
||||
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
|
||||
id: viewer
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-review-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-review-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-report
|
||||
retention-days: 30
|
||||
if-no-files-found: error
|
||||
@@ -240,20 +240,20 @@ jobs:
|
||||
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" --platform "$PLATFORM"
|
||||
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
|
||||
- name: Upload report failure diagnostics
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
|
||||
with:
|
||||
name: explore-report-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}
|
||||
name: explore-report-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
|
||||
path: ${{ runner.temp }}/explore-diagnostics
|
||||
retention-days: 7
|
||||
if-no-files-found: ignore
|
||||
# Hosted preview (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment per review, serving every platform's report.
|
||||
# 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.
|
||||
deploy:
|
||||
needs: [platforms, capture, report]
|
||||
needs: [targets, capture, report]
|
||||
if: needs.capture.outputs.preview == 'eas'
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 20
|
||||
@@ -264,7 +264,7 @@ jobs:
|
||||
steps:
|
||||
- *setup-node
|
||||
- *install-explore
|
||||
# One directory per platform artifact (explore-capture-<run>-<attempt>-<platform>, explore-review-<run>-<attempt>-<platform>).
|
||||
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
|
||||
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||
with:
|
||||
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
|
||||
@@ -280,8 +280,8 @@ jobs:
|
||||
shell: bash
|
||||
run: node "$TOOLS/dist/cli.js" ci:deploy --inputs "$RUNNER_TEMP/explore-review" --reports "$RUNNER_TEMP/explore-report"
|
||||
failure:
|
||||
needs: [platforms, capture, report, deploy]
|
||||
if: always() && (needs.platforms.result == 'failure' || needs.capture.result == 'failure' || needs.report.result == 'failure' || needs.deploy.result == 'failure')
|
||||
needs: [targets, capture, report, deploy]
|
||||
if: always() && (needs.targets.result == 'failure' || needs.capture.result == 'failure' || needs.report.result == 'failure' || needs.deploy.result == 'failure')
|
||||
runs-on: ubuntu-22.04
|
||||
timeout-minutes: 10
|
||||
permissions:
|
||||
@@ -307,12 +307,12 @@ jobs:
|
||||
- name: Report failure only on the current PR
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
PR_NUMBER: ${{ needs.capture.outputs.pr_number || needs.platforms.outputs.pr_number }}
|
||||
HEAD_SHA: ${{ needs.capture.outputs.head || needs.platforms.outputs.head }}
|
||||
BASE_SHA: ${{ needs.capture.outputs.base || needs.platforms.outputs.base }}
|
||||
PR_NUMBER: ${{ needs.capture.outputs.pr_number || needs.targets.outputs.pr_number }}
|
||||
HEAD_SHA: ${{ needs.capture.outputs.head || needs.targets.outputs.head }}
|
||||
BASE_SHA: ${{ needs.capture.outputs.base || needs.targets.outputs.base }}
|
||||
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 platform, and the comment keeps every other platform's result.
|
||||
# the first error.json names the failed target, 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"
|
||||
@@ -106,24 +106,31 @@ test("artifact cache isolates repository, run and attempt, ignores the artifact
|
||||
assert.deepEqual(result, { misses: [true, true, true], artifactIgnored: true, deleted: true, retained: true });
|
||||
});
|
||||
|
||||
test("artifact cache keeps one report per platform of a run and both survive the prune of a later write", async t => {
|
||||
test("artifact cache keeps one report per target of a run, under the platform keys reports were saved with before targets", async t => {
|
||||
const { open } = await harness(t);
|
||||
const page = await open();
|
||||
const result = await page.evaluate(async identity => {
|
||||
const ios = { ...identity, platform: "ios" };
|
||||
const android = { ...identity, platform: "android" };
|
||||
const result = await page.evaluate(async ({ identity, namespace }) => {
|
||||
const ios = { ...identity, target: "ios" };
|
||||
const android = { ...identity, target: "android" };
|
||||
const duo = { ...identity, target: "duo-open" };
|
||||
const { digest: iosDigest } = await window.writeArtifact(ios, [80, 75, 3, 4, 1]);
|
||||
const { digest: androidDigest } = await window.writeArtifact(android, [80, 75, 3, 4, 2]);
|
||||
// Storing another report prunes every key it does not recognise; platform keys must be recognised.
|
||||
const { digest: duoDigest } = await window.writeArtifact(duo, [80, 75, 3, 4, 3]);
|
||||
// Storing another report prunes every key it does not recognise; target keys must be recognised.
|
||||
await window.writeArtifact({ ...identity, run: "999" });
|
||||
const [iosHit, androidHit, unsuffixed] = await Promise.all([ios, android, identity].map(value => window.cacheApi.getCachedArtifact(value)));
|
||||
const [iosHit, androidHit, duoHit, unsuffixed] = await Promise.all([ios, android, duo, identity].map(value => window.cacheApi.getCachedArtifact(value)));
|
||||
const keys = (await (await caches.open(namespace)).keys()).map(request => new URL(request.url).search).sort();
|
||||
return {
|
||||
ios: iosHit?.digest === iosDigest, android: androidHit?.digest === androidDigest, distinct: iosHit?.digest !== androidHit?.digest,
|
||||
ios: iosHit?.digest === iosDigest, android: androidHit?.digest === androidDigest, duo: duoHit?.digest === duoDigest,
|
||||
distinct: new Set([iosHit?.digest, androidHit?.digest, duoHit?.digest]).size === 3,
|
||||
unsuffixedMisses: !unsuffixed,
|
||||
invalid: !await window.cacheApi.getCachedArtifact({ ...identity, platform: "web" }),
|
||||
invalid: !await window.cacheApi.getCachedArtifact({ ...identity, target: "Duo Open" }),
|
||||
keys,
|
||||
};
|
||||
}, identity);
|
||||
assert.deepEqual(result, { ios: true, android: true, distinct: true, unsuffixedMisses: true, invalid: true });
|
||||
}, { identity, namespace });
|
||||
assert.deepEqual(result, { ios: true, android: true, duo: true, distinct: true, unsuffixedMisses: true, invalid: true, keys: [
|
||||
"?repo=expo%2Fexample&run=123&attempt=2&platform=android", "?repo=expo%2Fexample&run=123&attempt=2&platform=ios",
|
||||
"?repo=expo%2Fexample&run=123&attempt=2&target=duo-open", "?repo=expo%2Fexample&run=999&attempt=2"] });
|
||||
});
|
||||
|
||||
test("artifact cache removes the retired public download cache the first time it is used", async t => {
|
||||
|
||||
@@ -69,11 +69,16 @@ async function harness(t, bytes, { app = false, open = true, name = fileName, re
|
||||
// A preview deployment's Worker: the decrypted report behind the token, or the same 404 as any other path.
|
||||
if (preview && url.pathname === `${pagePath}/report.zip`) {
|
||||
preview.requests = (preview.requests ?? 0) + 1;
|
||||
preview.queries = [...(preview.queries ?? []), url.search];
|
||||
if (preview.status && preview.status !== 200) { response.statusCode = preview.status; return response.end(preview.body ?? "Not found"); }
|
||||
response.setHeader("content-type", "application/zip");
|
||||
response.setHeader("content-length", String(bytes.length));
|
||||
return response.end(bytes);
|
||||
}
|
||||
if (preview?.listing && url.pathname === `${pagePath}/reports.json`) {
|
||||
response.setHeader("content-type", "application/json");
|
||||
return response.end(JSON.stringify(preview.listing));
|
||||
}
|
||||
if (url.pathname !== pagePath) return next();
|
||||
response.setHeader("content-type", "text/html");
|
||||
response.end(`<!doctype html><html><head><meta charset="utf-8"><link rel="icon" href="/favicon.svg" type="image/svg+xml"></head><body><div id="root"></div>
|
||||
@@ -408,6 +413,91 @@ test("a hosted preview link downloads the report from its own token route, opens
|
||||
assert.deepEqual(gone.errors, []);
|
||||
});
|
||||
|
||||
test("a hosted run of several targets opens the linked target and switches between all of them in config order", { timeout: 60_000 }, async t => {
|
||||
const targets = [
|
||||
{ id: "iphone", platform: "ios", label: "iPhone 17" },
|
||||
{ id: "duo-closed", platform: "ios", label: "iPhone Duo (closed)" },
|
||||
{ id: "duo-open", platform: "ios", label: "iPhone Duo (open)" },
|
||||
{ id: "android", platform: "android", label: "Android" },
|
||||
];
|
||||
const report = reportFixture();
|
||||
report.review.runtime = { ...report.review.runtime, platform: "ios", platforms: ["ios", "android"], target: targets[2], targets };
|
||||
const preview = { token: "defghijklmnopqrstuvwxyz234567234", listing: [
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", changes: 1 },
|
||||
{ target: "duo-closed", platform: "ios", label: "iPhone Duo (closed)" },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", changes: 1 },
|
||||
{ target: "android", platform: "android", label: "Android", changes: 2, device: "Pixel 9 16" },
|
||||
] };
|
||||
const { page, errors } = await harness(t, await archive(report), { app: true, reportIdentity: null, preview, query: "&target=duo-open" });
|
||||
const button = page.getByRole("button", { name: "Device: iPhone Duo (open). Open another device's report" });
|
||||
await expect(button).toBeVisible();
|
||||
assert.deepEqual(preview.queries, ["?target=duo-open"], "the Viewer asks the Worker for the linked target's report");
|
||||
await button.click();
|
||||
const items = page.getByRole("menu", { name: "Device" }).getByRole("menuitemradio");
|
||||
await expect(items).toHaveCount(4);
|
||||
assert.deepEqual(await items.evaluateAll(rows => rows.map(row => [row.querySelector(".menu-row-label")?.firstChild?.textContent, row.getAttribute("aria-checked")])),
|
||||
[["iPhone 17", "false"], ["iPhone Duo (closed)", "false"], ["iPhone Duo (open)", "true"], ["Android", "false"]]);
|
||||
await expect(items.nth(3)).toContainText("2 changes · Pixel 9 16");
|
||||
await expect(items.nth(1)).toContainText("Same review, other device");
|
||||
await items.nth(3).click();
|
||||
await page.waitForURL(url => new URL(url).searchParams.get("platform") === "android");
|
||||
const next = new URL(page.url());
|
||||
assert.equal(next.searchParams.get("target"), null, "a target named after its platform is linked as before targets");
|
||||
await expect.poll(() => preview.queries.at(-1)).toBe("?platform=android");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a hosted report from before targets still switches platforms by ?platform=", { timeout: 60_000 }, async t => {
|
||||
const report = reportFixture();
|
||||
report.review.runtime = { ...report.review.runtime, platform: "android", platforms: ["ios", "android"] };
|
||||
const preview = { token: "efghijklmnopqrstuvwxyz2345672345", listing: [{ platform: "ios", changes: 3 }, { platform: "android" }] };
|
||||
const { page, errors } = await harness(t, await archive(report), { app: true, reportIdentity: null, preview, query: "&platform=android" });
|
||||
const button = page.getByRole("button", { name: "Platform: Android. Open another platform's report" });
|
||||
await expect(button).toBeVisible();
|
||||
assert.deepEqual(preview.queries, ["?platform=android"]);
|
||||
await button.click();
|
||||
const items = page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio");
|
||||
assert.deepEqual(await items.evaluateAll(rows => rows.map(row => [row.querySelector(".menu-row-label")?.firstChild?.textContent, row.getAttribute("aria-checked")])),
|
||||
[["iOS", "false"], ["Android", "true"]]);
|
||||
await expect(items.nth(0)).toContainText("3 changes");
|
||||
await items.nth(0).click();
|
||||
await page.waitForURL(url => new URL(url).searchParams.get("platform") === "ios");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("report links name their target: ?target=, ?platform= from before targets, and the artifact file name", async t => {
|
||||
const { page } = await harness(t, undefined, { reportIdentity: null, query: "" });
|
||||
const result = await page.evaluate(() => {
|
||||
const api = window.archiveApi;
|
||||
const attempt = fn => { try { return fn(); } catch (error) { return `error: ${error.message}`; } };
|
||||
const preview = "http://x/p/abcdefghijklmnopqrstuvwxyz234567";
|
||||
return {
|
||||
target: api.previewReportUrl(new URL(`${preview}?target=duo-open`)),
|
||||
platform: api.previewReportUrl(new URL(`${preview}?platform=android`)),
|
||||
none: api.previewReportUrl(new URL(preview)),
|
||||
both: attempt(() => api.reportTarget(new URL(`${preview}?target=duo-open&platform=ios`))),
|
||||
invalid: attempt(() => api.reportTarget(new URL(`${preview}?target=Duo`))),
|
||||
reserved: attempt(() => api.reportTarget(new URL(`${preview}?target=report`))),
|
||||
identity: api.artifactIdentity(new URL("http://x/r?repo=expo/example&run=1&attempt=2&target=duo-open")),
|
||||
legacy: api.artifactIdentity(new URL("http://x/r?repo=expo/example&run=1&attempt=2&platform=android")),
|
||||
fileName: api.reportFileName({ run: "1", attempt: "2", target: "duo-open" }),
|
||||
legacyFileName: api.reportFileName({ run: "1", attempt: "2", target: "ios" }),
|
||||
};
|
||||
});
|
||||
assert.deepEqual(result, {
|
||||
target: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip?target=duo-open",
|
||||
platform: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip?platform=android",
|
||||
none: "/p/abcdefghijklmnopqrstuvwxyz234567/report.zip",
|
||||
both: "error: This report link needs one target, such as ios or android.",
|
||||
invalid: "error: This report link needs one target, such as ios or android.",
|
||||
reserved: "error: This report link needs one target, such as ios or android.",
|
||||
identity: { repo: "expo/example", run: "1", attempt: "2", target: "duo-open" },
|
||||
legacy: { repo: "expo/example", run: "1", attempt: "2", target: "android" },
|
||||
fileName: "explore-review-1-2-duo-open.zip",
|
||||
legacyFileName: "explore-review-1-2-ios.zip",
|
||||
});
|
||||
});
|
||||
|
||||
test("a bare /r opens any report and takes its identity from review.json", async t => {
|
||||
const { page, errors, origin } = await harness(t, undefined, { app: true, reportIdentity: null, query: "" });
|
||||
const drop = page.locator(".report-drop");
|
||||
|
||||
@@ -436,3 +436,27 @@ test("dev opens the report ZIP named by EXPLORE_REPORT and preserves the explici
|
||||
assert.equal(payload.map.screens.length, 32);
|
||||
await expectStopped(mapDev, "SIGINT");
|
||||
});
|
||||
|
||||
test("a Screens card keeps its status dot on the route's line, however tall its row", { timeout: 60_000 }, async t => {
|
||||
const { page, url, errors } = await openReport(t, { width: 1440, height: 900 });
|
||||
await page.goto(`${url}#/screens`);
|
||||
const all = page.getByRole("button", { name: /^All/ }).first();
|
||||
await expect(all).toBeVisible();
|
||||
if ((await all.getAttribute("aria-pressed")) !== "true") await all.click();
|
||||
await expect(page.locator(".screens-cell .diff-label").first()).toBeVisible();
|
||||
const layout = await page.locator(".screens-page").evaluate(async () => {
|
||||
const cards = [...document.querySelectorAll(".screens-cell .screen-screenshot-card")];
|
||||
// A row grows with a neighbour's notes ("Changed in dark") and stretches every card in it: stretch each one well past its content.
|
||||
for (const card of cards) card.style.height = `${card.getBoundingClientRect().height + 48}px`;
|
||||
await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)));
|
||||
const offsets = cards.filter(card => card.querySelector(".diff-label")).map(card => {
|
||||
const dot = card.querySelector(".diff-label").getBoundingClientRect(), title = card.querySelector(".screen-node-title").getBoundingClientRect();
|
||||
const line = parseFloat(getComputedStyle(card.querySelector(".screen-node-title")).lineHeight);
|
||||
return Math.abs(dot.top + dot.height / 2 - (title.top + line / 2));
|
||||
});
|
||||
return { offsets };
|
||||
});
|
||||
assert.ok(layout.offsets.length > 0, "the report has changed screens");
|
||||
assert.ok(layout.offsets.every(offset => offset <= 1), `each dot is centred on its route's first line: ${layout.offsets}`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
@@ -41,7 +41,7 @@ export async function readUsage(output) {
|
||||
|
||||
export async function fixture(t, provider, { docsOnly = false, unresolvedParameters = false, observerFailurePath, agentMode = false,
|
||||
instructions = 'Explore selected routes in a stable, comparable state.', recoverableOpenFailure = false,
|
||||
userInterfaceStyle, headUserInterfaceStyle, platform: initialPlatform = 'ios' } = {}) {
|
||||
userInterfaceStyle, headUserInterfaceStyle, platform: initialPlatform = 'ios', targets } = {}) {
|
||||
let platform = initialPlatform;
|
||||
const root = await realpath(await mkdtemp(join(tmpdir(), 'explore-ci-integration-')));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
@@ -56,6 +56,7 @@ export async function fixture(t, provider, { docsOnly = false, unresolvedParamet
|
||||
device: { name: 'iPhone 17 Pro' }, navigation: { provider, ...(provider === 'react-navigation' ? { entry: 'src/App.tsx' } : {}) },
|
||||
exploration: { scope: 'changes' }, capture: { maxMinutes: 30, maxActions: 500, repack: 'eas' },
|
||||
parameters: provider === 'expo-router' && !unresolvedParameters ? { '/item/[id]': { id: 'example-item' } } : {} };
|
||||
if (targets) config.targets = targets;
|
||||
if (agentMode) { config.mode = 'agent'; config.agent = { provider: 'anthropic', model: 'fixture-model', instructions: '.expo-explore/instructions.md' }; }
|
||||
await put('.expo-explore/instructions.md', instructions);
|
||||
await put('.gitignore', 'node_modules/\n');
|
||||
@@ -105,9 +106,10 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
const environment = { PATH: process.env.PATH, HOME: root, RUNNER_TEMP: root, EXPO_TOKEN: 'test-expo-secret', GITHUB_TOKEN: 'test-github-secret',
|
||||
GITHUB_RUN_ID: '1234', GITHUB_RUN_ATTEMPT: '1', GITHUB_REPOSITORY: pr.repository, TOOLS_COMMIT: 'c'.repeat(40), EXPLORE_VIEWER_ORIGIN: 'https://viewer.example' };
|
||||
const requests = []; const comments = []; const sessions = new Map(); let currentSession; const idleDevice = { path: '/', scheme: 'light' }; let sessionCounter = 0; let repackedSha; let openFailed = false;
|
||||
const identity = () => ({ session: 'expo-explore-runtime', appBundleId: config.app.bundleId,
|
||||
device: { id: 'device-1', name: config.device.name, platform, target: 'mobile', osVersion: '26.0', locale: 'en-US', orientation: 'portrait', colorScheme: 'light' },
|
||||
identifiers: { session: 'expo-explore-runtime', appBundleId: config.app.bundleId, deviceId: 'device-1', deviceName: config.device.name } });
|
||||
const identity = (session) => ({ session: 'expo-explore-runtime', appBundleId: config.app.bundleId,
|
||||
// The device the session was started with, as EAS starts the one a target names.
|
||||
device: { id: 'device-1', name: session?.device ?? config.device.name, platform, target: 'mobile', osVersion: '26.0', locale: 'en-US', orientation: 'portrait', colorScheme: 'light' },
|
||||
identifiers: { session: 'expo-explore-runtime', appBundleId: config.app.bundleId, deviceId: 'device-1', deviceName: session?.device ?? config.device.name } });
|
||||
// The fixture's clock: every controller round trip advances it by one poll interval, as a device snapshot would, so a
|
||||
// readiness budget expires in simulated time and a route that never becomes ready costs no real seconds.
|
||||
let clockMs = Date.now();
|
||||
@@ -129,7 +131,13 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
if (command === 'build:list') return json([]);
|
||||
if (command === 'build') return json([{ id: `build-${git(request.cwd, 'rev-parse', 'HEAD')}`, fingerprint: { hash: 'mock-native-fingerprint' }, appVersion: '3.0.0', appBuildVersion: '7' }]);
|
||||
if (command === 'env:pull') { writeFileSync(value(request, '--path'), '# Environment: preview\n'); return { stdout: '', stderr: '' }; }
|
||||
if (command === 'build:download') { const path = join(request.environment.TMPDIR, 'native.app'); mkdirSync(path); return json({ path }); }
|
||||
// The app carries its build's id, so the session it is installed on knows which commit it runs.
|
||||
if (command === 'build:download') {
|
||||
const build = value(request, '--build-id');
|
||||
const path = join(request.environment.TMPDIR, platform === 'android' ? 'native.apk' : 'native.app');
|
||||
if (platform === 'android') writeFileSync(path, build); else { mkdirSync(path); writeFileSync(join(path, 'build-id'), build); }
|
||||
return json({ path });
|
||||
}
|
||||
if (command === 'upload') return json({ url: `https://expo.dev/accounts/acme/projects/example/builds/repacked-${repackedSha}` });
|
||||
if (command === 'workflow:run') {
|
||||
assert.equal(request.environment.EAS_NO_VCS, '1');
|
||||
@@ -142,7 +150,7 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
}
|
||||
if (command === 'simulator:start') {
|
||||
const id = `session-${++sessionCounter}`; currentSession = id; openFailed = false;
|
||||
const session = { id, name: value(request, '--name'), build: value(request, '--build-id'), path: '/', scheme: 'light' }; sessions.set(id, session);
|
||||
const session = { id, name: value(request, '--name'), build: value(request, '--build-id'), device: value(request, '--device'), path: '/', scheme: 'light' }; sessions.set(id, session);
|
||||
writeFileSync(join(request.cwd, '.env.eas-simulator'), `${HEADER}EAS_SIMULATOR_SESSION_ID='${id}'\nAGENT_DEVICE_DAEMON_BASE_URL='https://controller.example/${id}'\nAGENT_DEVICE_DAEMON_AUTH_TOKEN='controller-private-token'\n`);
|
||||
return { stdout: 'ready', stderr: '' };
|
||||
}
|
||||
@@ -152,7 +160,8 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
if (basename(request.command) === 'repack-app') {
|
||||
repackedSha = git(request.cwd, 'rev-parse', 'HEAD');
|
||||
assert.ok(request.environment.EXPO_OVERRIDE_METRO_CONFIG, 'fresh and reused native builds must include the automatic observer');
|
||||
mkdirSync(value(request, '--output'));
|
||||
const output = value(request, '--output');
|
||||
if (platform === 'android') writeFileSync(output, `repacked-${repackedSha}`); else { mkdirSync(output); writeFileSync(join(output, 'build-id'), `repacked-${repackedSha}`); }
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
if (/^agent-device(-|$)/.test(basename(request.command))) {
|
||||
@@ -168,7 +177,13 @@ const Navigation=createStaticNavigation(Root); export default function App(){ret
|
||||
}
|
||||
device.path = '/' + request.args[2].slice('sample://'.length);
|
||||
}
|
||||
return ok(identity());
|
||||
return ok(identity(device));
|
||||
}
|
||||
if (command === 'fold') return ok({ action: 'fold', pose: request.args[1] });
|
||||
if (command === 'install') {
|
||||
const app = request.args[1];
|
||||
device.build = platform === 'android' ? readFileSync(app, 'utf8') : readFileSync(join(app, 'build-id'), 'utf8');
|
||||
return ok({ installed: true, appBundleId: config.app.bundleId });
|
||||
}
|
||||
if (command === 'appstate') return ok({ platform, appBundleId: config.app.bundleId, source: 'session', device_udid: 'device-1' });
|
||||
if (command === 'wait') return ok({});
|
||||
|
||||
@@ -119,7 +119,7 @@ test("trusted tools retain native agent runtimes while omitting development depe
|
||||
const builds = [action.runs.steps.find(step => step.name === "Build the pinned Explore CLI"),
|
||||
...workflows.flatMap(workflow => Object.values(workflow.jobs)
|
||||
.flatMap(job => job.steps.filter(step => step.name === "Install Explore")))];
|
||||
assert.equal(builds.length, 12, "composite action, review platforms/capture/report/deploy/failure, baseline platforms/baseline, and compare platforms/capture/report/deploy install the trusted tools");
|
||||
assert.equal(builds.length, 12, "composite action, review targets/capture/report/deploy/failure, baseline targets/baseline, and compare targets/capture/report/deploy install the trusted tools");
|
||||
for (const step of builds) {
|
||||
const install = step.run.split("\n").find(line => /^\s*npm ci\b/.test(line));
|
||||
assert.ok(install, step.name);
|
||||
@@ -136,18 +136,18 @@ test("baseline captures a complete single default-branch commit without a PR", (
|
||||
assert.ok(Object.hasOwn(baseline.on, "push"));
|
||||
assert.ok(Object.hasOwn(baseline.on, "workflow_dispatch"));
|
||||
const job = baseline.jobs.baseline;
|
||||
assert.match(baseline.jobs.platforms.if, /github\.event\.repository\.default_branch/);
|
||||
assert.deepEqual(job.needs, "platforms");
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { platform: "${{ fromJSON(needs.platforms.outputs.platforms) }}" } });
|
||||
assert.equal(job.env.PLATFORM, "${{ matrix.platform }}");
|
||||
assert.match(baseline.jobs.platforms.steps.at(-1).run, /config:platforms .* \| jq -c '\.platforms'/);
|
||||
assert.match(baseline.jobs.targets.if, /github\.event\.repository\.default_branch/);
|
||||
assert.deepEqual(job.needs, "targets");
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
assert.equal(job.env.TARGET, "${{ matrix.target }}");
|
||||
assert.match(baseline.jobs.targets.steps.at(-1).run, /config:targets .* \| jq -c '\[\.targets\[\]\.id\]'/);
|
||||
const verify = job.steps.find(step => step.name === "Verify deterministic source planning");
|
||||
assert.match(verify.run, /--base-sha "\$GITHUB_SHA" --head-sha "\$GITHUB_SHA" --scope all/);
|
||||
const capture = job.steps.find(step => step.name === "Capture complete single-commit baseline");
|
||||
assert.match(capture.run, /capture:baseline/);
|
||||
assert.doesNotMatch(baselineSource, /--pull-request|capture:review|inputs\.pr/);
|
||||
const upload = job.steps.find(step => step.name === "Upload exact-commit baseline evidence");
|
||||
assert.equal(upload.with.name, "explore-baseline-${{ github.sha }}-${{ matrix.platform }}");
|
||||
assert.equal(upload.with.name, "explore-baseline-${{ github.sha }}-${{ matrix.target }}");
|
||||
assert.equal(upload.with["retention-days"], 30);
|
||||
const diagnostics = job.steps.find(step => step.name === "Upload planning and baseline diagnostics");
|
||||
assert.equal(diagnostics.if, "always()");
|
||||
@@ -291,7 +291,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, ["platforms", "capture", "report"]);
|
||||
assert.deepEqual(deploy.needs, ["targets", "capture", "report"]);
|
||||
assert.equal(deploy.if, "needs.capture.outputs.preview == 'eas'");
|
||||
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");
|
||||
@@ -299,7 +299,7 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
|
||||
assert.equal(step.env.GITHUB_TOKEN, "${{ github.token }}");
|
||||
assert.equal(step.env.ARTIFACT_URL, undefined);
|
||||
assert.match(step.run, /ci:deploy --inputs "\$RUNNER_TEMP\/explore-review" --reports "\$RUNNER_TEMP\/explore-report"/);
|
||||
// Every platform's capture and report artifact, one directory each, so the deployment serves all of them.
|
||||
// Every target's capture and report artifact, one directory each, so the deployment serves all of them.
|
||||
const downloads = deploy.steps.filter(step => step.uses?.startsWith("actions/download-artifact@"));
|
||||
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));
|
||||
@@ -308,44 +308,49 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
|
||||
// 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/);
|
||||
assert.deepEqual(review.jobs.failure.needs, ["platforms", "capture", "report", "deploy"]);
|
||||
assert.match(review.jobs.failure.if, /needs\.platforms\.result == 'failure'/);
|
||||
assert.deepEqual(review.jobs.failure.needs, ["targets", "capture", "report", "deploy"]);
|
||||
assert.match(review.jobs.failure.if, /needs\.targets\.result == 'failure'/);
|
||||
assert.match(review.jobs.failure.if, /needs\.deploy\.result == 'failure'/);
|
||||
});
|
||||
|
||||
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.platforms.if, /closed/);
|
||||
assert.doesNotMatch(review.jobs.targets.if, /closed/);
|
||||
assert.equal(review.jobs.cleanup, undefined);
|
||||
for (const workflow of workflows) assert.doesNotMatch(JSON.stringify(workflow), /ci:cleanup|deploy:delete/);
|
||||
});
|
||||
|
||||
test("review captures and reports each configured platform in its own matrix job, with platform-suffixed artifacts", () => {
|
||||
const platforms = review.jobs.platforms;
|
||||
assert.deepEqual(platforms.permissions, { contents: "read", "pull-requests": "read" });
|
||||
assert.equal(platforms.outputs.platforms, "${{ steps.platforms.outputs.platforms }}");
|
||||
assert.match(platforms.steps.at(-1).run, /config:platforms --project "\$GITHUB_WORKSPACE\/app-head\/\$APP_PROJECT_DIR" --config \.expo-explore\/config\.yaml \| jq -c '\.platforms'/);
|
||||
assert.doesNotMatch(JSON.stringify(platforms), /EXPO_TOKEN|OPENAI_API_KEY|ANTHROPIC_API_KEY|APP_REVIEW/);
|
||||
for (const job of [review.jobs.capture, review.jobs.report]) {
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { platform: "${{ fromJSON(needs.platforms.outputs.platforms) }}" } });
|
||||
assert.equal(job.env.PLATFORM, "${{ matrix.platform }}");
|
||||
test("review captures and reports each configured target in its own matrix job, with target-suffixed artifacts", () => {
|
||||
const targets = review.jobs.targets;
|
||||
assert.deepEqual(targets.permissions, { contents: "read", "pull-requests": "read" });
|
||||
assert.equal(targets.outputs.targets, "${{ steps.targets.outputs.targets }}");
|
||||
// config:targets lists ids in config order; a config without targets: lists ["ios"] / ["ios","android"], as config:platforms did.
|
||||
assert.match(targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app-head\/\$APP_PROJECT_DIR" --config \.expo-explore\/config\.yaml \| jq -c '\[\.targets\[\]\.id\]'/);
|
||||
assert.doesNotMatch(JSON.stringify(targets), /EXPO_TOKEN|OPENAI_API_KEY|ANTHROPIC_API_KEY|APP_REVIEW/);
|
||||
for (const workflow of [review, compare, baseline]) {
|
||||
assert.doesNotMatch(JSON.stringify(workflow), /matrix\.platform|config:platforms|\$PLATFORM|needs\.platforms/, "every job is keyed by target, never by platform");
|
||||
assert.match(JSON.stringify(workflow), /matrix\.target/, "doctor looks for matrix.target in an installed workflow");
|
||||
}
|
||||
assert.equal(review.jobs.capture.needs, "platforms");
|
||||
assert.deepEqual(review.jobs.report.needs, ["platforms", "capture"]);
|
||||
for (const job of [review.jobs.capture, review.jobs.report]) {
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
assert.equal(job.env.TARGET, "${{ matrix.target }}");
|
||||
}
|
||||
assert.equal(review.jobs.capture.needs, "targets");
|
||||
assert.deepEqual(review.jobs.report.needs, ["targets", "capture"]);
|
||||
const runs = [review.jobs.capture, review.jobs.report, baseline.jobs.baseline].flatMap(job => job.steps.filter(step => step.run).map(step => step.run));
|
||||
for (const command of ["source:verify", "capture:review", "capture:baseline", "ci:report", "ci:publish"]) {
|
||||
const uses = runs.filter(run => run.includes(`cli.js" ${command}`));
|
||||
assert.ok(uses.length > 0, command);
|
||||
for (const run of uses) assert.match(run, /--platform "\$PLATFORM"/, command);
|
||||
for (const run of uses) assert.match(run, /--target "\$TARGET"/, command);
|
||||
}
|
||||
for (const workflow of [review, compare]) {
|
||||
assert.equal(workflow.jobs.capture.steps.find(step => step.name === "Find optional exact-base evidence").run,
|
||||
'node "$TOOLS/dist/cli.js" ci:find-baseline --sha "$BASE_SHA" --platform "$PLATFORM"');
|
||||
'node "$TOOLS/dist/cli.js" ci:find-baseline --sha "$BASE_SHA" --target "$TARGET"');
|
||||
}
|
||||
for (const [job, name] of [[review.jobs.capture, "Upload captured review for packaging"], [review.jobs.capture, "Upload planning and failure diagnostics"],
|
||||
[review.jobs.report, "Upload hosted review bundle"], [review.jobs.report, "Upload report failure diagnostics"],
|
||||
[baseline.jobs.baseline, "Upload exact-commit baseline evidence"], [baseline.jobs.baseline, "Upload planning and baseline diagnostics"]]) {
|
||||
assert.ok(job.steps.find(step => step.name === name).with.name.endsWith("-${{ matrix.platform }}"), name);
|
||||
assert.ok(job.steps.find(step => step.name === name).with.name.endsWith("-${{ matrix.target }}"), name);
|
||||
}
|
||||
});
|
||||
|
||||
@@ -363,13 +368,13 @@ test("compare reviews any two refs from a manual run or another workflow, with n
|
||||
// Each override reaches the CLI only when the caller set it; the CLI validates the value.
|
||||
assert.match(capture.run, /\$\{SCOPE:\+--scope "\$SCOPE"\} \$\{EXPIRES_IN:\+--expires-in "\$EXPIRES_IN"\}/);
|
||||
assert.match(compare.jobs.capture.steps.find(step => step.name === "Verify deterministic source planning").run, /\$\{SCOPE:\+--scope "\$SCOPE"\}/);
|
||||
assert.match(compare.jobs.report.steps.find(step => step.name === "Link the report from the run summary").run, /ci:publish --input .* --artifact-url "\$ARTIFACT_URL" --platform "\$PLATFORM"/);
|
||||
assert.equal(compare.jobs.capture.env.BASE_SHA, "${{ needs.platforms.outputs.base }}", "capture checks out the commits the refs resolved to once");
|
||||
assert.equal(compare.jobs.capture.env.HEAD_SHA, "${{ needs.platforms.outputs.head }}");
|
||||
assert.match(compare.jobs.report.steps.find(step => step.name === "Link the report from the run summary").run, /ci:publish --input .* --artifact-url "\$ARTIFACT_URL" --target "\$TARGET"/);
|
||||
assert.equal(compare.jobs.capture.env.BASE_SHA, "${{ needs.targets.outputs.base }}", "capture checks out the commits the refs resolved to once");
|
||||
assert.equal(compare.jobs.capture.env.HEAD_SHA, "${{ needs.targets.outputs.head }}");
|
||||
assert.equal(compare.concurrency.group, "explore-compare-${{ inputs.base }}..${{ inputs.head }}", "\"..\" cannot appear in a ref, so groups never collide");
|
||||
const diagnostics = compare.jobs.report.steps.find(step => step.name === "Upload report failure diagnostics");
|
||||
assert.deepEqual([diagnostics.if, diagnostics.with.path], ["always()", "${{ runner.temp }}/explore-diagnostics"]);
|
||||
assert.match(compare.jobs.platforms.steps.find(step => step.id === "refs").run, /ci:compare-refs --project app-head --base "\$BASE_REF" --head "\$HEAD_REF"/);
|
||||
assert.match(compare.jobs.targets.steps.find(step => step.id === "refs").run, /ci:compare-refs --project app-head --base "\$BASE_REF" --head "\$HEAD_REF"/);
|
||||
assert.match(compare.jobs.capture.steps.find(step => step.id === "capture").run, /printf '%s' "\$COMPARE" > "\$RUNNER_TEMP\/explore-compare\.json"/);
|
||||
assert.match(compare.jobs.deploy.steps.at(-1).run, /ci:deploy --inputs/);
|
||||
});
|
||||
@@ -541,3 +541,19 @@ test("a fold whose panel Argent never reads fails clearly instead of capturing t
|
||||
assert.equal(failed.json.error.code, "CONTROLLER_FOLD_UNVERIFIED");
|
||||
assert.equal(stuck.calls.filter(call => call.tool === "fold").length, 1, "the session is not folded back and forth");
|
||||
});
|
||||
|
||||
test("an opened foldable's screenshots are captured upright and its recordings handed to be turned; others are left as Argent saves them", async () => {
|
||||
const replies = { "list-devices": IOS_DEVICES, screenshot: {}, "screen-recording-start": {}, "screen-recording-stop": { video: "/home/.argent/recordings/r.mp4" } };
|
||||
for (const landscape of [true, false]) {
|
||||
const { run, context, calls } = harness("ios", replies, { state: { generation: 0, screen: { width: 669, height: 951 } } });
|
||||
// Argent reads the opened panel on its portrait axes, like the closed one: only the pose tells them apart.
|
||||
if (landscape) context.landscape = true;
|
||||
const oriented = [];
|
||||
context.orientVideo = async path => { oriented.push(path); };
|
||||
assert.equal((await run(["screenshot", "/work/screen.png", ...flags("ios")])).exitCode, 0);
|
||||
await run(["record", "start", "/work/launch.mp4", ...flags("ios")]);
|
||||
await run(["record", "stop", ...flags("ios")]);
|
||||
assert.deepEqual(calls.find(call => call.tool === "screenshot").args, { udid: UDID, scale: 1, ...(landscape ? { rotation: "LandscapeRight" } : {}) });
|
||||
assert.deepEqual(oriented, landscape ? ["/work/launch.mp4"] : []);
|
||||
}
|
||||
});
|
||||
@@ -14,7 +14,7 @@ test("report publishes one normal ZIP artifact to the hosted Viewer", () => {
|
||||
assert.ok(packageIndex > 0 && uploadIndex > packageIndex && publishIndex > uploadIndex);
|
||||
assert.match(report.steps[packageIndex].run, /ci:report --input/);
|
||||
const upload = report.steps[uploadIndex];
|
||||
assert.equal(upload.with.name, "explore-review-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}");
|
||||
assert.equal(upload.with.name, "explore-review-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}");
|
||||
assert.equal(upload.with.path, "${{ runner.temp }}/explore-report");
|
||||
assert.equal(upload.with.archive, undefined);
|
||||
assert.equal(upload.with["retention-days"], 30);
|
||||
@@ -46,7 +46,7 @@ test("report job persists its own diagnostics even when packaging or publication
|
||||
assert.equal(step.if, "always()");
|
||||
assert.equal(step.with.path, "${{ runner.temp }}/explore-diagnostics");
|
||||
assert.equal(step.with["retention-days"], 7);
|
||||
assert.equal(step.with.name, "explore-report-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.platform }}");
|
||||
assert.equal(step.with.name, "explore-report-diagnostics-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}");
|
||||
});
|
||||
|
||||
test("failure reporting downloads only this run attempt's failed-job diagnostics", () => {
|
||||
@@ -65,10 +65,10 @@ test("failure reporting downloads only this run attempt's failed-job diagnostics
|
||||
assert.equal(step.with.repository, undefined);
|
||||
}
|
||||
// A capture job that fails before it resolves the PR (its tool install, say) still gets its failure comment:
|
||||
// the platforms job already resolved and authorized the same PR.
|
||||
// the targets job already resolved and authorized the same PR.
|
||||
const report = job.steps.find(step => step.name === "Report failure only on the current PR");
|
||||
for (const [env, output] of [["PR_NUMBER", "pr_number"], ["HEAD_SHA", "head"], ["BASE_SHA", "base"]]) {
|
||||
assert.equal(report.env[env], `\${{ needs.capture.outputs.${output} || needs.platforms.outputs.${output} }}`);
|
||||
assert.equal(workflow.jobs.platforms.outputs[output], `\${{ steps.pr.outputs.${output} }}`);
|
||||
assert.equal(report.env[env], `\${{ needs.capture.outputs.${output} || needs.targets.outputs.${output} }}`);
|
||||
assert.equal(workflow.jobs.targets.outputs[output], `\${{ steps.pr.outputs.${output} }}`);
|
||||
}
|
||||
});
|
||||
@@ -88,3 +88,13 @@ test("a route the primary pass lost keeps its verified secondary frame under <id
|
||||
assert.equal(merged["q@dark"], undefined, "two failures stay one failure");
|
||||
assert.equal(Object.keys(mergeSchemeOutcomes([{ p: failed }, { p: captured }]))["p@dark"], undefined, "no scheme list, no secondary slot");
|
||||
});
|
||||
|
||||
test("a note on a verified frame of another appearance stays with the route its primary frame is published under", () => {
|
||||
const captured = { status: "captured", attempts: 1, landing: "verified", screenshotSha256: "a".repeat(64) };
|
||||
const incomplete = "Setup did not complete: a setup step stopped twice (RUNNER_WEDGED), so this route was opened by app link without the state the remaining setup steps prepare.";
|
||||
const merged = mergeSchemeOutcomes([{ p: captured, q: { ...captured, reason: "Already noted." } }, { p: { ...captured, reason: incomplete }, q: captured }], ["light", "dark"]);
|
||||
assert.equal(merged.p.reason, `In dark: ${incomplete}`);
|
||||
assert.equal(merged.p.status, "captured");
|
||||
assert.equal(merged.q.reason, "Already noted.", "a pass without a note adds none");
|
||||
assert.equal(merged["p@dark"], undefined, "the dark frame is still published under the route, as before");
|
||||
});
|
||||
@@ -135,6 +135,10 @@ test("capture recipes exclude display settings but bind agent instructions and c
|
||||
assert.equal(JSON.parse(key).observer, CAPTURE_OBSERVER_HASH);
|
||||
assert.match(JSON.parse(key).observer, /^[a-f0-9]{64}$/);
|
||||
assert.equal(key,captureRecipeConfig({...config,app:{...config.app,name:"Renamed display"}}));
|
||||
// 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");
|
||||
assert.equal(JSON.parse(captureRecipeConfig({...config,capture:{...config.capture,simulator:"local"}})).capture.repack, "local");
|
||||
// agent-device recipes are unchanged by Argent support; an Argent capture is keyed to Argent and its version.
|
||||
assert.equal(JSON.parse(key).controllerVersion, undefined);
|
||||
const argent = JSON.parse(captureRecipeConfig({...config,capture:{...config.capture,controller:"argent"}}));
|
||||
|
||||
+492
-22
@@ -1,12 +1,15 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import test from 'node:test';
|
||||
import { spawnSync } from 'node:child_process';
|
||||
import { spawn, spawnSync } from 'node:child_process';
|
||||
import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from 'node:fs';
|
||||
import { createHash } from 'node:crypto';
|
||||
import { mkdtemp, mkdir, readdir, readFile, realpath, rm, writeFile } from 'node:fs/promises';
|
||||
import { join, relative, sep } from 'node:path';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { Worker } from 'node:worker_threads';
|
||||
import { PNG } from 'pngjs';
|
||||
import { BlobReader, Uint8ArrayWriter, ZipWriter } from '@zip.js/zip.js';
|
||||
import { argentToolServerDirectory } from '../../dist/shared/controller-cache.js';
|
||||
import { AGENT_DEVICE_VERSION, captureDeepLink, controllerCommandFailure, revisionSetup, runCiMap, runControllerRead, runControllerReadAsync, runAgentControllerCommand } from '../../dist/capture/run.js';
|
||||
import { CiError, serializeCiError } from '../../dist/shared/ci-errors.js';
|
||||
import { createSourceCapturePlan } from '../../dist/source/capture-plan.js';
|
||||
@@ -21,6 +24,16 @@ const SHA = 'a'.repeat(40);
|
||||
const HEAD = 'b'.repeat(40);
|
||||
const PROJECT_ID = '00000000-0000-4000-8000-000000000001';
|
||||
const DAEMON_TOKEN = 'private-controller-token-value';
|
||||
const LOCAL_UDID = '0A1B2C3D-4E5F-4A6B-8C7D-9E0F1A2B3C4D';
|
||||
// The ABI this machine's emulator runs, as Explore picks it.
|
||||
const HOST_ABI = process.arch === 'arm64' ? 'arm64-v8a' : 'x86_64';
|
||||
|
||||
/** An APK-shaped zip with native libraries for these ABIs: enough for the local emulator's ABI check. */
|
||||
async function apkWithAbis(abis) {
|
||||
const zip = new ZipWriter(new Uint8ArrayWriter());
|
||||
for (const abi of abis) await zip.add(`lib/${abi}/libapp.so`, new BlobReader(new Blob(['so'])));
|
||||
return Buffer.from(await zip.close());
|
||||
}
|
||||
const PREVIEW_TOKEN = 'private-preview-token-value';
|
||||
const PREVIEW_ID = '5f1e08dd0defd834caf6908fe5ebd38b';
|
||||
const HEADER = '# Do not commit this file.\n# Do not modify these values manually. They are managed by eas-cli.\n# It holds configuration only for the current simulator session.\n\n';
|
||||
@@ -79,6 +92,13 @@ let clockMs = Date.now();
|
||||
async function fixture(t, settings = {}) {
|
||||
const root = await realpath(await mkdtemp(join(tmpdir(), 'explore-source-capture-')));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
// A local emulator reads the SDK's system images and checks the APK's native libraries.
|
||||
const sdk = join(root, 'android-sdk');
|
||||
if (settings.local && settings.android) {
|
||||
await mkdir(join(sdk, 'system-images', 'android-35', 'google_apis', HOST_ABI), { recursive: true });
|
||||
await writeFile(join(sdk, 'system-images', 'android-35', 'google_apis', HOST_ABI, 'system.img'), '');
|
||||
}
|
||||
const apk = settings.local && settings.android ? await apkWithAbis(settings.abis ?? ['arm64-v8a', 'x86_64']) : 'apk';
|
||||
const project = join(root, 'app'); await mkdir(project);
|
||||
await writeCaptureObserverPackages(project);
|
||||
await writeFile(join(project, 'package.json'), '{"name":"example","main":"index.js"}\n');
|
||||
@@ -91,14 +111,17 @@ async function fixture(t, settings = {}) {
|
||||
const planPath = join(root, 'plan.json'); await writeFile(planPath, JSON.stringify(plan));
|
||||
const requests = [];
|
||||
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 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;
|
||||
const deviceName = settings.android ? 'Pixel 7' : 'iPhone 17 Pro';
|
||||
const platform = settings.android ? 'android' : 'ios';
|
||||
// A local simulator is the one the capture created, named for Explore.
|
||||
const deviceId = settings.local ? (settings.android ? settings.serial ?? 'emulator-5556' : LOCAL_UDID) : 'device-1';
|
||||
const openedName = settings.deviceMismatch ? 'Wrong device' : settings.local && !settings.android ? `Explore ${deviceName} (base ${SHA.slice(0, 8)})` : deviceName;
|
||||
const identity = () => ({ session: 'expo-explore-runtime', appBundleId: 'com.example.app',
|
||||
// agent-device 0.20.2 reports no runtime or OS version for a simulator.
|
||||
device: { id: 'device-1', name: settings.deviceMismatch ? 'Wrong device' : deviceName, platform, target: 'mobile',
|
||||
device: { id: deviceId, name: openedName, platform, target: 'mobile',
|
||||
locale: 'en-US', orientation: 'portrait', colorScheme: 'light' },
|
||||
identifiers: { session: 'expo-explore-runtime', appBundleId: 'com.example.app', deviceId: 'device-1', deviceName: settings.deviceMismatch ? 'Wrong device' : deviceName } });
|
||||
identifiers: { session: 'expo-explore-runtime', appBundleId: 'com.example.app', deviceId, deviceName: openedName } });
|
||||
const runner = request => {
|
||||
requests.push(request);
|
||||
const command = request.args[0];
|
||||
@@ -108,6 +131,52 @@ async function fixture(t, settings = {}) {
|
||||
.map(entry => relative(project, join(entry.parentPath, entry.name))).join('\0') + '\0', stderr: '' };
|
||||
return { stdout: command === 'rev-parse' ? `${SHA}\n` : settings.dirty ? ' M app/home.tsx\n' : '', stderr: '' };
|
||||
}
|
||||
if (request.command.endsWith('/avdmanager')) {
|
||||
assert.deepEqual(request.args.slice(0, 2), ['create', 'avd']);
|
||||
mkdirSync(join(request.environment.ANDROID_AVD_HOME, `${value(request, '--name')}.avd`));
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
if (request.command === '/bin/sh') {
|
||||
// A local Argent tool-server says where it listens, as `argent server start` does.
|
||||
if (request.args[1]?.includes('server start')) {
|
||||
const port = 4100 + serverStarts++;
|
||||
writeFileSync(request.environment.EXPLORE_ARGENT_SERVER_LOG, ` (or: argent link --host 127.0.0.1 --port ${port} --token abc123)\n[t] Tools server listening on http://127.0.0.1:${port}\n`);
|
||||
return { stdout: `${4242 + serverStarts}\n`, stderr: '' };
|
||||
}
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
// An emulator process left on a stopped capture's console port: listed until the test's emulatorProcess is killed.
|
||||
if (request.command === 'pgrep') return { stdout: settings.emulatorProcess?.exitCode === null && settings.emulatorProcess.signalCode === null ? `${settings.emulatorProcess.pid}\n` : '', stderr: '' };
|
||||
if (request.command.endsWith('/adb')) {
|
||||
// Another emulator already holds the first console port.
|
||||
if (command === 'devices') return { stdout: 'List of devices attached\nemulator-5554\tdevice\n', stderr: '' };
|
||||
const rest = request.args.slice(2);
|
||||
if (rest[0] === 'shell') return { stdout: rest[2] === 'sys.boot_completed' ? '1\n' : '15\n', stderr: '' };
|
||||
if (rest[0] === 'install') { assert.ok(existsSync(rest[2]), 'the instrumented APK is on this machine when it is installed'); return { stdout: 'Success\n', stderr: '' }; }
|
||||
if (rest[0] === 'wait-for-device' || rest[0] === 'emu') return { stdout: '', stderr: '' };
|
||||
}
|
||||
if (request.command === 'xcrun') {
|
||||
assert.equal(command, 'simctl');
|
||||
const [action, ...rest] = request.args.slice(1);
|
||||
if (action === 'list' && rest[0] === 'devicetypes') return json({ devicetypes: [{ name: 'iPhone 17', identifier: 'com.apple.CoreSimulator.SimDeviceType.iPhone-17' },
|
||||
{ name: deviceName, identifier: 'com.apple.CoreSimulator.SimDeviceType.iPhone-17-Pro' }] });
|
||||
if (action === 'list' && rest[0] === 'runtimes') return json({ runtimes: [
|
||||
{ identifier: 'com.apple.CoreSimulator.SimRuntime.iOS-26-5', version: '26.5', platform: 'iOS', isAvailable: true,
|
||||
supportedDeviceTypes: [{ identifier: 'com.apple.CoreSimulator.SimDeviceType.iPhone-17-Pro' }] },
|
||||
{ identifier: 'com.apple.CoreSimulator.SimRuntime.iOS-27-0', version: '27.0', platform: 'iOS', isAvailable: true,
|
||||
supportedDeviceTypes: [{ identifier: 'com.apple.CoreSimulator.SimDeviceType.iPhone-17-Pro' }] },
|
||||
{ identifier: 'com.apple.CoreSimulator.SimRuntime.iOS-27-1', version: '27.1', platform: 'iOS', isAvailable: false,
|
||||
supportedDeviceTypes: [{ identifier: 'com.apple.CoreSimulator.SimDeviceType.iPhone-17-Pro' }] }] });
|
||||
if (action === 'create') return { stdout: `${LOCAL_UDID}\n`, stderr: '' };
|
||||
if (action === 'install') { assert.ok(existsSync(rest[1]), 'the instrumented app is on this machine when it is installed'); return { stdout: '', stderr: '' }; }
|
||||
if (['boot', 'bootstatus', 'shutdown', 'delete', 'spawn', 'ui'].includes(action)) return { stdout: '', stderr: '' };
|
||||
// The lit display after a fold: landscape when the inner one is lit, unless the test says the fold did not take.
|
||||
if (action === 'io') {
|
||||
const open = settings.devicePose === 'open' && !settings.foldIgnored;
|
||||
writeFileSync(rest[2], PNG.sync.write(new PNG(open ? { width: 30, height: 20 } : { width: 20, height: 30 })));
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
}
|
||||
if (request.command === 'fake-eas') {
|
||||
if (command === 'config') return json({ buildProfile: { ...(settings.android ? { buildType: 'apk' } : { simulator: settings.simulator !== false }), distribution: 'internal', environment: 'preview', env: {} },
|
||||
appConfig: { name: 'Example', slug: 'example', owner: 'acme', ...(settings.userInterfaceStyle ? { userInterfaceStyle: settings.userInterfaceStyle } : {}), scheme: settings.noScheme ? undefined : 'sample',
|
||||
@@ -120,7 +189,7 @@ async function fixture(t, settings = {}) {
|
||||
if (command === 'env:pull') { writeFileSync(value(request, '--path'), '# Environment: preview\nEXPO_PUBLIC_ENDPOINT=sample\n'); return { stdout: '', stderr: '' }; }
|
||||
if (command === 'build:download') {
|
||||
const path = join(request.environment.TMPDIR, settings.android ? 'native.apk' : 'native.app');
|
||||
if (settings.android) writeFileSync(path, 'apk'); else mkdirSync(path);
|
||||
if (settings.android) writeFileSync(path, apk); else mkdirSync(path);
|
||||
return json({ path });
|
||||
}
|
||||
if (command === 'workflow:run') {
|
||||
@@ -133,11 +202,11 @@ 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' } }] });
|
||||
}
|
||||
if (command === 'upload') {
|
||||
if (settings.uploadPlanLimit) throw new Error('fake-eas upload exited with status 1: Uploading your app archive to EAS | ✔ Uploaded to EAS | 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.');
|
||||
return json({ url: 'https://expo.dev/accounts/acme/projects/example/builds/repacked-app' });
|
||||
}
|
||||
if (command === 'simulator:start') {
|
||||
@@ -161,18 +230,22 @@ async function fixture(t, settings = {}) {
|
||||
}
|
||||
}
|
||||
if (request.command === 'fake-repack') {
|
||||
if (settings.repackFails) throw new Error('repack-app exited with status 1');
|
||||
assert.ok(request.args.includes('--js-bundle-only'));
|
||||
const observerConfig = request.environment.EXPO_OVERRIDE_METRO_CONFIG;
|
||||
assert.ok(observerConfig && !observerConfig.startsWith(`${project}/`), 'observer is staged outside the clean source checkout');
|
||||
assert.match(readFileSync(observerConfig, 'utf8'), /navigation-observer/);
|
||||
if (settings.android) writeFileSync(value(request, '--output'), 'apk'); else mkdirSync(value(request, '--output'));
|
||||
if (settings.android) writeFileSync(value(request, '--output'), apk); else mkdirSync(value(request, '--output'));
|
||||
return { stdout: '', stderr: '' };
|
||||
}
|
||||
// An Argent capture runs its per-run bridge in place of agent-device; the bridge answers in agent-device's envelopes.
|
||||
if (request.command === 'fake-controller' || (settings.argent && request.command.endsWith('/argent-controller'))) {
|
||||
if (command === '--version') return { stdout: settings.argent ? '0.29.0' : AGENT_DEVICE_VERSION, stderr: '' };
|
||||
if (command === 'open') {
|
||||
if (request.args.includes('--relaunch')) splashLeft = settings.splashFrames ?? 0;
|
||||
// unreadableAfterFold: Argent's reader stayed on the outer panel, so the first app opens find no readable app.
|
||||
if (unreadableLeft > 0 && !request.args[2]?.startsWith('sample://')) { unreadableLeft -= 1;
|
||||
return json({ success: false, error: { code: 'APP_NOT_READY', message: 'open: com.example.app did not come up with a readable accessibility tree after relaunching.' } }); }
|
||||
if (request.args.includes('--relaunch')) { splashLeft = settings.splashFrames ?? 0; relaunchedAfterForeign = true; if (settings.wedgeAt === current) { wedgeCleared = !settings.wedgeRecurs; current = '/'; } }
|
||||
if (request.args[2]?.startsWith('sample://')) {
|
||||
const previous = current;
|
||||
current = '/' + request.args[2].slice('sample://'.length);
|
||||
@@ -182,14 +255,27 @@ async function fixture(t, settings = {}) {
|
||||
alert = (!settings.alertOnlyAt || settings.alertOnlyAt === current) ? settings.deepLinkAlert ?? null : null;
|
||||
}
|
||||
if (settings.openFailure === current) throw new Error('route could not open');
|
||||
// The emulator's adb connection drops for a few seconds as this route opens, once.
|
||||
if (settings.deviceLostOnOpen === current && !deviceLost) { deviceLost = true;
|
||||
return json({ success: false, error: { code: 'COMMAND_FAILED', message: "open: device 'emulator-5556' not found",
|
||||
details: { reason: 'device_not_found', hint: 'The device disconnected or is restarting — verify it is listed in adb devices, then retry.' } } }); }
|
||||
return ok(identity());
|
||||
}
|
||||
if (command === 'appstate') {
|
||||
// foreignUntilRelaunch: a setup tap brought another app to the front; starting the app again brings it back.
|
||||
if (settings.foreignUntilRelaunch && !relaunchedAfterForeign) return ok({ appBundleId: 'com.apple.springboard' });
|
||||
if (settings.android) return ok({ platform: 'android', package: settings.wrongForeground ? 'com.foreign.app' : 'com.example.app', activity: 'com.example.app.MainActivity' });
|
||||
return ok(settings.wrongForeground ? { appBundleId: 'com.foreign.app' } : identity());
|
||||
}
|
||||
if (command === 'wait') return ok({});
|
||||
if (command === 'fold') return ok({ action: 'fold', pose: request.args[1] });
|
||||
if (command === 'close') return ok({});
|
||||
// claimedSerials: device claims an interrupted run left behind, which agent-device hides as stale but still enforces.
|
||||
if (command === 'device') return ok({ claims: [], hiddenStaleClaims: (settings.claimedSerials ?? []).includes(value(request, '--serial')) ? 1 : 0 });
|
||||
// An EAS session starts empty while the app is repacked; the controller installs the app from this machine.
|
||||
if (command === 'install') { assert.ok(existsSync(request.args[1]), 'the repacked app is on this machine'); return ok({ installed: true, appBundleId: 'com.example.app' }); }
|
||||
// agent-device 0.21.15 cannot read Xcode 27.1's hinge angle back, so a local fold reports a failure after folding.
|
||||
if (command === 'fold') return settings.local ? json({ success: false, error: { code: 'COMMAND_FAILED', message: "CoreDevice reported no hinge angle sample: Unknown option '--device'" } })
|
||||
: ok({ action: 'fold', pose: request.args[1] });
|
||||
if (command === 'record' && settings.recording) {
|
||||
if (request.args[1] === 'start') { recordingPath = request.args[2]; return ok({ path: recordingPath }); }
|
||||
writeFileSync(recordingPath, 'mp4-bytes'); return ok({ path: recordingPath });
|
||||
@@ -224,6 +310,10 @@ async function fixture(t, settings = {}) {
|
||||
return ok({ message: 'accepted' });
|
||||
}
|
||||
if (command === 'snapshot') {
|
||||
// wedgeAt: the runner wedges on this screen until the app is restarted, as agent-device's did on iPhone Duo's covered Done
|
||||
// (with wedgeRecurs, every time the screen is shown again).
|
||||
if (settings.wedgeAt === current && !wedgeCleared) return json({ success: false, error: { code: 'COMMAND_FAILED',
|
||||
message: 'The iOS runner is still finishing a previous command that exceeded its execution watchdog (usually an accessibility capture on a heavy or animating screen).' } });
|
||||
snapshots += 1;
|
||||
// markerMismatchAt: the observer reports another route only at one path (optionally in one appearance).
|
||||
const mismatchHere = settings.markerMismatch || (settings.markerMismatchAt && settings.markerMismatchAt.path === current
|
||||
@@ -288,8 +378,8 @@ async function fixture(t, settings = {}) {
|
||||
buildId: 'source-capture', buildVersion: '1', gitCommit: SHA, bundleId: 'com.example.app',
|
||||
...(settings.noScheme ? {} : { scheme: 'sample' }), device: deviceName, easProfile: 'capture', expoToken: 'expo-private', ...(settings.android ? { platform: 'android' } : {}),
|
||||
planPath, maxScreens: 120, maxActions: 500, maxDurationMinutes: 30, forceFreshBuild: false,
|
||||
confirmExternalRun: true, confirmTrustedSource: true, easCommand: 'fake-eas', repackCommand: 'fake-repack', agentDeviceCommand: 'fake-controller', ...(settings.argent ? { controller: 'argent' } : {}), ...(settings.devicePose ? { devicePose: settings.devicePose } : {}), ...(settings.launch ? { launch: settings.launch, recordingTools: settings.recordingTools ?? null } : {}), ...(settings.repack ? { repack: settings.repack } : {}),
|
||||
environment: { PATH: process.env.PATH, HOME: root, GITHUB_TOKEN: 'github-private', ANTHROPIC_API_KEY: 'must-not-be-used', AGENT_DEVICE_DAEMON_AUTH_TOKEN: 'wrong-token', ...settings.environment },
|
||||
confirmExternalRun: true, confirmTrustedSource: true, easCommand: 'fake-eas', repackCommand: 'fake-repack', agentDeviceCommand: 'fake-controller', ...(settings.argent ? { controller: 'argent' } : {}), ...(settings.devicePose ? { devicePose: settings.devicePose } : {}), ...(settings.launch ? { launch: settings.launch, recordingTools: settings.recordingTools ?? null } : {}), ...(settings.repack ? { repack: settings.repack } : {}), ...(settings.local ? { simulator: 'local' } : {}),
|
||||
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]) };
|
||||
@@ -408,11 +498,327 @@ test('device.pose folds the device first, before the app is opened, read or capt
|
||||
assert.equal(folds.length, 1);
|
||||
assert.deepEqual(folds[0].args.slice(0, 2), ['fold', 'open']);
|
||||
const foldAt = controller.indexOf(folds[0]);
|
||||
// The fold comes first: the app is not opened, read or captured before it, so the controller starts on the lit panel.
|
||||
assert.deepEqual(controller.slice(0, foldAt).map(request => request.args[0]).filter(command => command !== '--version'), []);
|
||||
// The fold comes first: the app is installed but not opened, read or captured before it, so the controller starts on the lit panel.
|
||||
assert.deepEqual(controller.slice(0, foldAt).map(request => request.args[0]).filter(command => command !== '--version' && command !== 'install'), []);
|
||||
// Argent's bridge is told the pose, so it captures the opened panel's landscape UI upright.
|
||||
if (argent) for (const request of controller) assert.equal(request.environment.EXPLORE_ARGENT_POSE, 'open');
|
||||
}
|
||||
});
|
||||
|
||||
test('a local simulator capture creates its own iOS simulator, installs the repacked app there, and deletes the simulator', async t => {
|
||||
for (const repack of ['local', 'eas']) {
|
||||
const f = await fixture(t, { local: true, repack });
|
||||
const result = await runCiMap({ ...f.options, sessionStatePath: join(f.root, `session-${repack}`) });
|
||||
assert.equal(result.runStatus, 'complete', JSON.stringify(result.outcomes));
|
||||
const eas = f.requests.filter(request => request.command === 'fake-eas').map(request => request.args[0]);
|
||||
assert.equal(eas.some(command => command.startsWith('simulator:')), false, 'no EAS Simulator session or availability check');
|
||||
// A local repack's app stays on this machine; a hosted one is downloaded back.
|
||||
assert.equal(eas.includes('upload'), false);
|
||||
if (repack === 'eas') assert.ok(eas.includes('workflow:run') && eas.includes('build:download'));
|
||||
// Every captured route exports its frame. A local repack is never uploaded, so its frames name the native build it repacked.
|
||||
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
const captured = Object.keys(bundle.outcomes).filter(id => bundle.outcomes[id].status === 'captured');
|
||||
assert.ok(captured.length > 0);
|
||||
assert.deepEqual(captured.filter(id => !bundle.images[id]), [], 'no captured route is missing its image');
|
||||
for (const id of captured) assert.equal(bundle.images[id].buildId, repack === 'local' ? 'built-app' : result.easBuildId);
|
||||
assert.equal(bundle.easBuildId, bundle.images[captured[0]].buildId, 'the review names the build its frames came from');
|
||||
const simctl = f.requests.filter(request => request.command === 'xcrun').map(request => request.args.slice(1));
|
||||
assert.deepEqual(simctl.find(args => args[0] === 'create'),
|
||||
['create', `Explore iPhone 17 Pro (base ${SHA.slice(0, 8)})`, 'com.apple.CoreSimulator.SimDeviceType.iPhone-17-Pro', 'com.apple.CoreSimulator.SimRuntime.iOS-27-0'],
|
||||
'the newest available runtime that runs the device');
|
||||
assert.deepEqual(simctl.map(args => args[0]).filter(action => action !== 'list'), ['create', 'boot', 'bootstatus', 'spawn', 'install', 'shutdown', 'delete']);
|
||||
// The app's links open without iOS asking first.
|
||||
assert.deepEqual(simctl.find(args => args[0] === 'spawn'), ['spawn', LOCAL_UDID, 'defaults', 'write', 'com.apple.launchservices.schemeapproval',
|
||||
'com.apple.CoreSimulator.CoreSimulatorBridge-->sample', '-string', 'com.example.app']);
|
||||
assert.equal(existsSync(join(f.root, `session-${repack}`)), false, 'the recorded simulator is cleared once it is deleted');
|
||||
assert.deepEqual(await readdir(join(f.root, '.cache', 'expo-explore', 'local-captures')), [], 'a clean stop leaves nothing for a later sweep');
|
||||
const controller = f.requests.filter(request => request.command === 'fake-controller' && request.args[0] !== '--version' && request.args[0] !== 'close');
|
||||
assert.ok(controller.length > 0);
|
||||
for (const request of controller) {
|
||||
assert.equal(value(request, '--udid'), LOCAL_UDID, `${request.args[0]} targets the created simulator`);
|
||||
assert.equal(request.args.includes('--device'), false);
|
||||
assert.equal(request.environment.AGENT_DEVICE_DAEMON_BASE_URL, undefined, 'agent-device runs locally');
|
||||
assert.equal(request.environment.AGENT_DEVICE_DAEMON_AUTH_TOKEN, undefined);
|
||||
assert.ok(request.environment.AGENT_DEVICE_STATE_DIR, 'its own daemon, so head and base do not share one');
|
||||
}
|
||||
assert.equal(result.simulatorSessionId, null);
|
||||
assert.equal(result.simulatorRuntime.provider, 'local-simulator');
|
||||
assert.equal(result.simulatorRuntime.deviceModel, 'iPhone 17 Pro', 'the model it was created as, not the Explore name');
|
||||
assert.equal(result.simulatorRuntime.osVersion, '27.0');
|
||||
const execution = parseRuntimeExecutionContext(JSON.parse(await readFile(join(f.options.outputDirectory, 'execution.json'), 'utf8')));
|
||||
assert.equal(execution.provider, 'local-simulator');
|
||||
}
|
||||
});
|
||||
|
||||
test('Argent drives a local simulator through a tool-server of the capture\'s own, and the host switches the appearance', async t => {
|
||||
const f = await fixture(t, { local: true, argent: true, repack: 'local', userInterfaceStyle: 'automatic' });
|
||||
// The tool-server is installed already, as the pipeline's prefetch leaves it.
|
||||
const cache = join(f.root, 'controllers');
|
||||
mkdirSync(argentToolServerDirectory(cache), { recursive: true });
|
||||
writeFileSync(join(argentToolServerDirectory(cache), '.explore-controller.json'), '{}');
|
||||
const result = await runCiMap({ ...f.options, environment: { ...f.options.environment, EXPLORE_CONTROLLER_CACHE: cache } });
|
||||
assert.equal(result.runStatus, 'complete', JSON.stringify(result.outcomes));
|
||||
const bridge = f.requests.filter(request => request.command.endsWith('/argent-controller'));
|
||||
assert.ok(bridge.length > 0);
|
||||
for (const request of bridge) {
|
||||
assert.equal(request.environment.ARGENT_TOOLS_URL, 'http://127.0.0.1:4100');
|
||||
assert.equal(request.environment.ARGENT_AUTH_TOKEN, 'abc123');
|
||||
assert.equal(request.environment.EXPLORE_ARGENT_DEVICE, LOCAL_UDID, 'the bridge drives the capture\'s own simulator');
|
||||
assert.equal(request.environment.EXPLORE_ARGENT_POSE, undefined, 'no pose, so screenshots are captured as Argent reads the screen');
|
||||
}
|
||||
// Both appearances, switched with simctl, since Argent cannot.
|
||||
assert.deepEqual(f.requests.filter(request => request.command === 'xcrun' && request.args[1] === 'ui').map(request => request.args.slice(2)), [[LOCAL_UDID, 'appearance', 'light'], [LOCAL_UDID, 'appearance', 'dark']]);
|
||||
assert.equal(f.requests.some(request => request.command === 'fake-eas' && request.args[0].startsWith('simulator:')), false);
|
||||
});
|
||||
|
||||
test('a local Android capture starts its own emulator in a private AVD home, installs the APK there, and stops it', async t => {
|
||||
const f = await fixture(t, { local: true, android: true, repack: 'local' });
|
||||
const result = await runCiMap({ ...f.options, sessionStatePath: join(f.root, 'session') });
|
||||
assert.equal(result.runStatus, 'complete', JSON.stringify(result.outcomes));
|
||||
const eas = f.requests.filter(request => request.command === 'fake-eas').map(request => request.args[0]);
|
||||
assert.equal(eas.some(command => command.startsWith('simulator:') || command === 'upload'), false);
|
||||
const create = f.requests.find(request => request.command.endsWith('/avdmanager'));
|
||||
assert.equal(value(create, '--device'), 'Pixel 7');
|
||||
assert.equal(value(create, '--package'), `system-images;android-35;google_apis;${HOST_ABI}`);
|
||||
assert.ok(!create.environment.ANDROID_AVD_HOME.startsWith(f.root + '/app'), 'the AVD is not in the app');
|
||||
const start = f.requests.find(request => request.command === '/bin/sh');
|
||||
assert.equal(start.args[start.args.indexOf('-port') + 1], '5556', 'the next free console port');
|
||||
assert.ok(start.args.includes('-no-window'));
|
||||
const adb = f.requests.filter(request => request.command.endsWith('/adb')).map(request => request.args.slice(2, 3)[0] ?? request.args[0]);
|
||||
assert.ok(adb.indexOf('install') < adb.indexOf('emu'), 'installed, then stopped at the end');
|
||||
assert.deepEqual(adb.slice(adb.lastIndexOf('emu')), ['emu', 'devices'], 'stopped, and checked gone');
|
||||
for (const request of f.requests.filter(request => request.command === 'fake-controller' && !['--version', 'close'].includes(request.args[0]))) {
|
||||
assert.equal(value(request, '--serial'), 'emulator-5556', `${request.args[0]} targets the started emulator`);
|
||||
assert.equal(request.environment.AGENT_DEVICE_DAEMON_BASE_URL, undefined);
|
||||
}
|
||||
assert.equal(result.simulatorRuntime.provider, 'local-simulator');
|
||||
assert.equal(result.simulatorRuntime.osVersion, '15');
|
||||
assert.equal(existsSync(join(f.root, 'session')), false);
|
||||
assert.equal(existsSync(join(f.root, '.cache', 'expo-explore', 'emulator-ports', '5556.lock')), false, 'its console port is free again');
|
||||
assert.deepEqual(await readdir(join(f.root, '.cache', 'expo-explore', 'local-captures')), [], 'a clean stop leaves nothing for a later sweep');
|
||||
});
|
||||
|
||||
test('a local emulator adb has lost is stopped by its process', async t => {
|
||||
// A real process stands in for the emulator: adb does not list it and emu kill does not reach it.
|
||||
const emulatorProcess = spawn(process.execPath, ['-e', 'setInterval(() => {}, 1000)'], { stdio: 'ignore' });
|
||||
t.after(() => emulatorProcess.kill('SIGKILL'));
|
||||
const exited = new Promise(resolve => emulatorProcess.once('exit', resolve));
|
||||
const f = await fixture(t, { local: true, android: true, repack: 'local', emulatorProcess });
|
||||
const result = await runCiMap({ ...f.options, sessionStatePath: join(f.root, 'session') });
|
||||
assert.equal(result.runStatus, 'complete', JSON.stringify(result.outcomes));
|
||||
assert.equal(await exited, null, 'the emulator process was signalled');
|
||||
const pgrep = f.requests.find(request => request.command === 'pgrep');
|
||||
assert.equal(pgrep.args[1], 'qemu-system.* -avd explore-[a-z]+-[0-9a-f]{8} -port 5556 ', 'only an Explore emulator on this capture\'s port');
|
||||
assert.equal(existsSync(join(f.root, '.cache', 'expo-explore', 'emulator-ports', '5556.lock')), false);
|
||||
});
|
||||
|
||||
test('a local emulator skips a console port another capture holds and takes over one an exited run left', async t => {
|
||||
const f = await fixture(t, { local: true, android: true, repack: 'local', serial: 'emulator-5558' });
|
||||
// Another capture of this process has reserved 5556, and one that exited left 5558's reservation behind.
|
||||
// Reservations live in this user's Explore cache (HOME is the fixture's root), not the shared temporary directory.
|
||||
await mkdir(join(f.root, '.cache', 'expo-explore', 'emulator-ports'), { recursive: true });
|
||||
await writeFile(join(f.root, '.cache', 'expo-explore', 'emulator-ports', '5556.lock'), String(process.pid));
|
||||
await writeFile(join(f.root, '.cache', 'expo-explore', 'emulator-ports', '5558.lock'), '999999999');
|
||||
assert.equal((await runCiMap(f.options)).runStatus, 'complete');
|
||||
const start = f.requests.find(request => request.command === '/bin/sh');
|
||||
assert.equal(start.args[start.args.indexOf('-port') + 1], '5558');
|
||||
assert.equal(existsSync(join(f.root, '.cache', 'expo-explore', 'emulator-ports', '5556.lock')), true, 'the other capture keeps its port');
|
||||
});
|
||||
|
||||
test('of captures reserving one console port at the same moment, exactly one gets it', async t => {
|
||||
const module = new URL('../../dist/capture/local-simulator.js', import.meta.url).href;
|
||||
const root = await mkdtemp(join(tmpdir(), 'explore-port-race-'));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const ports = join(root, 'emulator-ports');
|
||||
// Head and base of one review start their emulators together, each on its own worker thread of one process.
|
||||
const reserveOnThread = () => new Promise((resolve, reject) => {
|
||||
const worker = new Worker(`import(${JSON.stringify(module)}).then(m => m.reservePort(5554, { EXPLORE_CACHE_DIR: ${JSON.stringify(root)} })).then(r => require('node:worker_threads').parentPort.postMessage(r));`, { eval: true });
|
||||
worker.once('message', resolve); worker.once('error', reject);
|
||||
});
|
||||
for (let round = 0; round < 30; round++) {
|
||||
await rm(ports, { recursive: true, force: true });
|
||||
await mkdir(ports, { recursive: true });
|
||||
// Free; left behind by a run that exited (its process is gone); or that, with the mutex too, which that run died holding.
|
||||
if (round % 3) await writeFile(join(ports, '5554.lock'), '999999999');
|
||||
if (round % 3 === 2) { await mkdir(join(ports, 'mutex')); await writeFile(join(ports, 'mutex', 'owner'), '999999999'); }
|
||||
const reserved = await Promise.all(Array.from({ length: 4 }, reserveOnThread));
|
||||
assert.equal(reserved.filter(Boolean).length, 1, `round ${round}: ${reserved}`);
|
||||
assert.equal(await readFile(join(ports, '5554.lock'), 'utf8'), String(process.pid));
|
||||
assert.equal(existsSync(join(ports, 'mutex')), false, 'the mutex is released');
|
||||
}
|
||||
});
|
||||
|
||||
test('a local emulator skips a port whose serial agent-device still claims for an interrupted run', async t => {
|
||||
const f = await fixture(t, { local: true, android: true, repack: 'local', claimedSerials: ['emulator-5556'], serial: 'emulator-5558' });
|
||||
assert.equal((await runCiMap(f.options)).runStatus, 'complete');
|
||||
const start = f.requests.find(request => request.command === '/bin/sh');
|
||||
assert.equal(start.args[start.args.indexOf('-port') + 1], '5558');
|
||||
});
|
||||
|
||||
test('a local Android capture refuses an APK without libraries for this machine before installing it, and stops its emulator', async t => {
|
||||
const other = HOST_ABI === 'arm64-v8a' ? 'x86_64' : 'arm64-v8a';
|
||||
const f = await fixture(t, { local: true, android: true, repack: 'local', abis: [other] });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'LOCAL_EMULATOR_ABI_UNSUPPORTED');
|
||||
const adb = f.requests.filter(request => request.command.endsWith('/adb')).map(request => request.args[2] ?? request.args[0]);
|
||||
assert.equal(adb.includes('install'), false);
|
||||
assert.ok(adb.includes('emu'), 'the emulator started during the repack is stopped');
|
||||
});
|
||||
|
||||
test('a local device starts before the build, so it boots while the app is repacked', async t => {
|
||||
for (const android of [false, true]) {
|
||||
const f = await fixture(t, { local: true, android, repack: 'local' });
|
||||
assert.equal((await runCiMap(f.options)).runStatus, 'complete');
|
||||
const order = f.requests.map(request => request.command === 'fake-repack' ? 'repack'
|
||||
: request.command === 'xcrun' && ['boot', 'bootstatus'].includes(request.args[1]) ? request.args[1]
|
||||
: request.command === '/bin/sh' ? 'boot' : request.command.endsWith('/adb') && request.args[2] === 'wait-for-device' ? 'bootstatus' : undefined).filter(Boolean);
|
||||
assert.deepEqual(order, ['boot', 'repack', 'bootstatus'], android ? 'Android' : 'iOS');
|
||||
}
|
||||
});
|
||||
|
||||
test('a failed repack deletes the local device it started', async t => {
|
||||
const f = await fixture(t, { local: true, repack: 'local', repackFails: true });
|
||||
await assert.rejects(runCiMap(f.options));
|
||||
assert.deepEqual(f.requests.filter(request => request.command === 'xcrun').map(request => request.args[1]).slice(-2), ['shutdown', 'delete']);
|
||||
});
|
||||
|
||||
test('when Argent cannot read the app after a fold, the capture restarts its local tool-server and opens the app again', async t => {
|
||||
const f = await fixture(t, { local: true, argent: true, repack: 'local', devicePose: 'open', unreadableAfterFold: 1 });
|
||||
const cache = join(f.root, 'controllers');
|
||||
mkdirSync(argentToolServerDirectory(cache), { recursive: true });
|
||||
writeFileSync(join(argentToolServerDirectory(cache), '.explore-controller.json'), '{}');
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, environment: { ...f.options.environment, EXPLORE_CONTROLLER_CACHE: cache }, progress: line => lines.push(line) });
|
||||
assert.equal(result.runStatus, 'complete', JSON.stringify(result.outcomes));
|
||||
assert.equal(f.requests.filter(request => request.command === '/bin/sh' && request.args[1]?.includes('server start')).length, 2);
|
||||
assert.ok(lines.some(line => /restarting Argent's tool-server/.test(line)), lines.join('\n'));
|
||||
// Every call after the restart goes to the new server.
|
||||
const bridge = f.requests.filter(request => request.command.endsWith('/argent-controller'));
|
||||
assert.equal(bridge.at(-1).environment.ARGENT_TOOLS_URL, 'http://127.0.0.1:4101');
|
||||
|
||||
// A second failure restarts SpringBoard as well; a third is reported.
|
||||
for (const [unreadable, completes] of [[2, true], [3, false]]) {
|
||||
const again = await fixture(t, { local: true, argent: true, repack: 'local', devicePose: 'open', unreadableAfterFold: unreadable });
|
||||
mkdirSync(argentToolServerDirectory(join(again.root, 'controllers')), { recursive: true });
|
||||
writeFileSync(join(argentToolServerDirectory(join(again.root, 'controllers')), '.explore-controller.json'), '{}');
|
||||
const run = runCiMap({ ...again.options, environment: { ...again.options.environment, EXPLORE_CONTROLLER_CACHE: join(again.root, 'controllers') } });
|
||||
if (completes) assert.equal((await run).runStatus, 'complete');
|
||||
else await assert.rejects(run, error => JSON.stringify(error).includes('APP_NOT_READY'));
|
||||
assert.deepEqual(again.requests.filter(request => request.command === 'xcrun' && request.args[3] === 'launchctl').map(request => request.args.slice(3)),
|
||||
[['launchctl', 'kickstart', '-k', 'system/com.apple.SpringBoard']]);
|
||||
}
|
||||
});
|
||||
|
||||
test('a local foldable opens the app, folds, and is checked by the shape of its lit display', async t => {
|
||||
const f = await fixture(t, { local: true, repack: 'local', devicePose: 'open' });
|
||||
assert.equal((await runCiMap(f.options)).runStatus, 'complete');
|
||||
const controller = f.requests.filter(request => request.command === 'fake-controller' && request.args[0] !== '--version');
|
||||
assert.deepEqual(controller.slice(0, 2).map(request => request.args[0]), ['open', 'fold'], 'a local fold needs a session');
|
||||
assert.equal(value(controller[1], '--udid'), LOCAL_UDID);
|
||||
assert.ok(f.requests.some(request => request.command === 'xcrun' && request.args[1] === 'io'));
|
||||
|
||||
const ignored = await fixture(t, { local: true, repack: 'local', devicePose: 'open', foldIgnored: true });
|
||||
await assert.rejects(runCiMap(ignored.options), error => error.code === 'CONTROLLER_FOLD_UNVERIFIED' && /hinge angle/.test(error.message));
|
||||
assert.deepEqual(ignored.requests.filter(request => request.command === 'xcrun').map(request => request.args[1]).slice(-2), ['shutdown', 'delete']);
|
||||
});
|
||||
|
||||
test('a controller that wedges on one screen costs that route only: the app restarts and later routes are captured', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('settings'), route('profile')], wedgeAt: '/settings', stableLabels: true });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, progress: line => lines.push(line) });
|
||||
assert.equal(result.outcomes[f.ids.home].status, 'captured');
|
||||
assert.equal(result.outcomes[f.ids.settings].status, 'failed');
|
||||
assert.match(result.outcomes[f.ids.settings].reason, /stopped answering on this screen/);
|
||||
assert.match(result.outcomes[f.ids.settings].error.message, /execution watchdog/, 'the report says what the controller did');
|
||||
assert.equal(result.outcomes[f.ids.profile].status, 'captured', 'the route after the wedge starts on a restarted app');
|
||||
assert.ok(lines.some(line => /stopped answering on \/settings/.test(line)), lines.join('\n'));
|
||||
const recoveries = (await readFile(join(f.options.outputDirectory, 'capture-diagnostics', 'controller-recoveries.jsonl'), 'utf8')).trim().split('\n').map(line => JSON.parse(line));
|
||||
assert.deepEqual(recoveries.map(entry => [entry.where, entry.recovered]), [['/settings', true]]);
|
||||
});
|
||||
|
||||
test('a controller that wedges during setup does not fail every route: setup stops there and routes go on by app link', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('settings')], wedgeAt: '/setup', stableLabels: true });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, setup: [{ action: 'open', url: 'sample://setup' }], progress: line => lines.push(line) });
|
||||
assert.equal(result.outcomes[f.ids.home].status, 'captured');
|
||||
assert.equal(result.outcomes[f.ids.settings].status, 'captured');
|
||||
assert.ok(lines.some(line => /setup stopped \(/.test(line)), lines.join('\n'));
|
||||
const recoveries = (await readFile(join(f.options.outputDirectory, 'capture-diagnostics', 'controller-recoveries.jsonl'), 'utf8')).trim().split('\n').map(line => JSON.parse(line));
|
||||
assert.deepEqual(recoveries.map(entry => [entry.where, entry.recovered]), [['a setup step', true]]);
|
||||
});
|
||||
|
||||
test('a setup step that wedges the controller once runs setup again from the start, and the routes are captured as usual', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('settings')], wedgeAt: '/setup', stableLabels: true });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, setup: [{ action: 'open', url: 'sample://setup' }, { action: 'open', url: 'sample://ready' }], progress: line => lines.push(line) });
|
||||
assert.ok(lines.some(line => /setup stopped \(.*\); running setup again from the start/.test(line)), lines.join('\n'));
|
||||
assert.ok(lines.some(line => /setup 2\/2:/.test(line)), 'every setup step ran on the rerun');
|
||||
for (const id of [f.ids.home, f.ids.settings]) {
|
||||
assert.equal(result.outcomes[id].status, 'captured');
|
||||
assert.equal(result.outcomes[id].landing, 'verified');
|
||||
assert.equal(result.outcomes[id].reason, undefined, 'setup completed, so the outcome carries no setup note');
|
||||
}
|
||||
const recoveries = (await readFile(join(f.options.outputDirectory, 'capture-diagnostics', 'controller-recoveries.jsonl'), 'utf8')).trim().split('\n').map(line => JSON.parse(line));
|
||||
assert.deepEqual(recoveries.map(entry => [entry.where, entry.recovered, entry.next]), [['a setup step', true, 'setup-rerun']]);
|
||||
});
|
||||
|
||||
test('a setup step that wedges again on the rerun lets routes go on by app link, each marked as captured without complete setup', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('settings')], wedgeAt: '/setup', wedgeRecurs: true, stableLabels: true });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, setup: [{ action: 'open', url: 'sample://setup' }, { action: 'open', url: 'sample://ready' }], progress: line => lines.push(line) });
|
||||
assert.ok(lines.some(line => /setup stopped again \(/.test(line)), lines.join('\n'));
|
||||
assert.ok(!lines.some(line => /setup 2\/2:/.test(line)), 'the steps after the wedge never ran');
|
||||
for (const id of [f.ids.home, f.ids.settings]) {
|
||||
assert.equal(result.outcomes[id].status, 'captured', 'the routes are not failed');
|
||||
assert.match(result.outcomes[id].reason, /Setup did not complete/);
|
||||
}
|
||||
const recoveries = (await readFile(join(f.options.outputDirectory, 'capture-diagnostics', 'controller-recoveries.jsonl'), 'utf8')).trim().split('\n').map(line => JSON.parse(line));
|
||||
assert.deepEqual(recoveries.map(entry => [entry.where, entry.recovered, entry.next]), [['a setup step', true, 'setup-rerun'], ['a setup step', true, 'setup-incomplete']]);
|
||||
});
|
||||
|
||||
test('a setup step that leaves another app in front costs that step: the app restarts and the routes are captured', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('settings')], foreignUntilRelaunch: true, stableLabels: true });
|
||||
const lines = [];
|
||||
const result = await runCiMap({ ...f.options, setup: [{ action: 'tap', label: 'Get Started' }], progress: line => lines.push(line) });
|
||||
assert.equal(result.outcomes[f.ids.home].status, 'captured');
|
||||
assert.equal(result.outcomes[f.ids.settings].status, 'captured');
|
||||
assert.ok(lines.some(line => /the app was no longer in front on a setup step \(CONTROLLER_IDENTITY_MISMATCH\)/.test(line)), lines.join('\n'));
|
||||
});
|
||||
|
||||
test('a local simulator capture deletes its simulator when the capture fails', async t => {
|
||||
const f = await fixture(t, { local: true, repack: 'local', openFailure: '/' });
|
||||
const result = await runCiMap(f.options).catch(error => error);
|
||||
assert.ok(result instanceof Error || result.runStatus === 'partial');
|
||||
const simctl = f.requests.filter(request => request.command === 'xcrun').map(request => request.args[1]);
|
||||
assert.deepEqual(simctl.slice(-2), ['shutdown', 'delete']);
|
||||
});
|
||||
|
||||
test('an EAS session asks for the capture minutes plus a repack allowance, and a plan that refuses them gets its own maximum', async t => {
|
||||
const minutes = request => Number(value(request, '--max-duration-minutes'));
|
||||
const f = await fixture(t);
|
||||
await runCiMap(f.options);
|
||||
assert.deepEqual(f.requests.filter(request => request.args[0] === 'simulator:start').map(minutes), [50]);
|
||||
// EAS names the plan's maximum when it refuses; the start is retried once, never with less than the capture's own 30.
|
||||
for (const [limit, retried] of [[40, 40], [20, 30]]) {
|
||||
const f = await fixture(t);
|
||||
const starts = [];
|
||||
const result = await runCiMap({ ...f.options, runner: request => {
|
||||
if (request.command === 'fake-eas' && request.args[0] === 'simulator:start' && (starts.push(minutes(request)), starts.length === 1))
|
||||
throw new Error(`Controller simulator:start exited with status 1: Failed to create simulator session | Device run session max duration must not exceed ${limit} minutes for this account; received 50 minutes.`);
|
||||
return f.options.runner(request);
|
||||
} });
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
assert.deepEqual(starts, [50, retried]);
|
||||
}
|
||||
// Any other start failure is not retried.
|
||||
const g = await fixture(t);
|
||||
let other = 0;
|
||||
await assert.rejects(runCiMap({ ...g.options, runner: request => {
|
||||
if (request.command === 'fake-eas' && request.args[0] === 'simulator:start') { other += 1; throw new Error('Controller simulator:start exited with status 1: quota exhausted'); }
|
||||
return g.options.runner(request);
|
||||
} }), error => error.code === 'SIMULATOR_START_FAILED');
|
||||
assert.equal(other, 1);
|
||||
});
|
||||
|
||||
test('an agent-device capture writes no controller into its bundle', async t => {
|
||||
const f = await fixture(t);
|
||||
await runCiMap(f.options);
|
||||
@@ -480,6 +886,16 @@ test('one failed route preserves its placeholder and captures later routes', asy
|
||||
assert.equal(result.outcomes[f.ids.settings].status, 'captured');
|
||||
});
|
||||
|
||||
test('a route whose open loses the Android emulator for a moment is opened again once the device answers', async t => {
|
||||
const f = await fixture(t, { android: true, deviceLostOnOpen: '/home' });
|
||||
const result = await runCiMap(f.options);
|
||||
assert.equal(result.outcomes[f.ids.home].status, 'captured', JSON.stringify(result.outcomes[f.ids.home]));
|
||||
assert.equal(result.outcomes[f.ids.home].attempts, 2);
|
||||
assert.equal(result.outcomes[f.ids.settings].status, 'captured');
|
||||
const retries = (await readFile(join(f.options.mapDirectory, 'capture-diagnostics', 'controller-retries.jsonl'), 'utf8')).trim().split('\n').map(line => JSON.parse(line));
|
||||
assert.ok(retries.some(entry => entry.reason === 'route-reopened-after-device-lost' && /not found/.test(entry.fault)), JSON.stringify(retries));
|
||||
});
|
||||
|
||||
test('iOS app-link confirmation is accepted once before fresh route evidence', async t => {
|
||||
const f = await fixture(t, { routes: [route('home')], marker: true, alertOnlyAt: '/home',
|
||||
deepLinkAlert: { message: 'Open in “Example”?', items: ['Cancel', 'Open'] } });
|
||||
@@ -822,6 +1238,23 @@ test('every route link starts from the root link, so a sheet left by the previou
|
||||
assert.equal(bundle.procedure.reset, 'root-link');
|
||||
});
|
||||
|
||||
test('a route costs no more controller calls than it needs: the reset is an open and a settle, and no appstate follows the screenshot', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('settings')], userInterfaceStyle: 'light' });
|
||||
assert.equal((await runCiMap(f.options)).runStatus, 'complete');
|
||||
const calls = f.requests.filter(request => request.command === 'fake-controller').map(request => [request.args[0], request.args[2]]);
|
||||
for (const [index, [command, link]] of calls.entries()) {
|
||||
// The route's own link waits for the root link to finish closing what the last route left (a sheet still being
|
||||
// dismissed can stop the next one presenting); its readiness poll then checks where it landed.
|
||||
if (command === 'open' && link === 'sample://') {
|
||||
const [[next, nextArg], [after, afterLink]] = [calls[index + 1], calls[index + 2]];
|
||||
assert.ok(next === 'wait' && nextArg === '500' && after === 'open' && afterLink?.startsWith('sample://') && afterLink !== 'sample://', JSON.stringify(calls.slice(index, index + 3)));
|
||||
}
|
||||
// The snapshot after the screenshot also proves which app is in front.
|
||||
if (command === 'screenshot') assert.equal(calls[index + 1][0], 'snapshot');
|
||||
}
|
||||
assert.ok(calls.filter(([command, link]) => command === 'open' && link === 'sample://').length >= 2);
|
||||
});
|
||||
|
||||
test('capture.reset: none keeps today\'s sequencing, and a sheet left behind makes the next route land elsewhere (unattributed)', async t => {
|
||||
const f = await fixture(t, { routes: [route('home'), route('modal'), route('settings')], presentedUntilRoot: '/modal' });
|
||||
const result = await runCiMap({ ...f.options, reset: 'none' });
|
||||
@@ -1097,7 +1530,12 @@ test('fresh and reusable native builds are repacked on EAS from a staged copy wi
|
||||
assert.equal(result.app.buildNumber, '42');
|
||||
assert.equal(f.operations().includes('workflow:run'), true);
|
||||
assert.equal(f.operations().includes('upload'), false);
|
||||
assert.equal(f.operations().includes('build:download'), false);
|
||||
// The session starts empty while the job repacks; the repacked app is downloaded and installed through the controller.
|
||||
const start = f.requests.find(request => request.args[0] === 'simulator:start');
|
||||
assert.equal(start.args.includes('--build-id'), false);
|
||||
assert.ok(f.requests.indexOf(start) < f.requests.findIndex(request => request.args[0] === 'workflow:run'), 'the session starts before the repack');
|
||||
assert.equal(f.operations().includes('build:download'), true);
|
||||
assert.equal(f.operations().filter(operation => operation === 'install').length, 1);
|
||||
assert.equal(f.operations().includes('build'), !reuse);
|
||||
assert.equal(f.requests.some(request => request.command === 'fake-repack'), false);
|
||||
const staged = f.requests.find(request => request.args[0] === 'workflow:run').cwd;
|
||||
@@ -1110,16 +1548,18 @@ test('fresh and reusable native builds are repacked on EAS from a staged copy wi
|
||||
test('a failed hosted repack job stops the capture as EAS_REPACK_FAILED with the workflow logs', async t => {
|
||||
const f = await fixture(t, { workflowFailure: true });
|
||||
await assert.rejects(runCiMap(f.options), error => error.code === 'EAS_REPACK_FAILED' && /Build step "Repack" failed/.test(error.message) && /workflows\/run-1/.test(error.nextAction));
|
||||
assert.equal(f.operations().includes('simulator:start'), false);
|
||||
// The session started beside the repack, so it is stopped.
|
||||
assert.deepEqual(f.operations().filter(operation => operation.startsWith('simulator:')).filter(operation => operation !== 'simulator:availability'), ['simulator:start', 'simulator:stop']);
|
||||
});
|
||||
|
||||
test('capture.repack: local repacks on the runner and uploads the result', async t => {
|
||||
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 });
|
||||
const result = await runCiMap(f.options);
|
||||
assert.equal(result.reusedEasBuild, reuse);
|
||||
assert.equal(result.easBuildId, 'repacked-app');
|
||||
assert.equal(f.operations().includes('upload'), true);
|
||||
assert.equal(result.easBuildId, null);
|
||||
assert.equal(f.operations().includes('upload'), false);
|
||||
assert.equal(f.operations().filter(operation => operation === 'install').length, 1);
|
||||
assert.equal(f.operations().includes('workflow:run'), false);
|
||||
assert.equal(f.operations().includes('build'), !reuse);
|
||||
assert.equal(f.requests.filter(request => request.command === 'fake-repack').length, 1);
|
||||
@@ -1221,7 +1661,7 @@ test('setup reads again while a system prompt briefly returns an incomplete tree
|
||||
});
|
||||
|
||||
test('an exhausted EAS build plan is reported as EAS_PLAN_LIMIT_REACHED with the reset date', async t => {
|
||||
const f = await fixture(t, { repack: 'local', uploadPlanLimit: true });
|
||||
const f = await fixture(t, { workflowPlanLimit: true });
|
||||
await assert.rejects(runCiMap(f.options), error => {
|
||||
assert.equal(error.code, 'EAS_PLAN_LIMIT_REACHED');
|
||||
assert.match(error.message, /production_plus plan this month, which will reset in 13 days \(on Sat Oct 24 2026\)/);
|
||||
@@ -1974,7 +2414,11 @@ test('a recycled helper with an unknown observer or different app cannot proceed
|
||||
return f.options.runner(request);
|
||||
} });
|
||||
assert.notEqual(result.runStatus, 'complete');
|
||||
assert.equal(f.operations().includes('screenshot'), false);
|
||||
// Another app in front is contained like a stuck controller: the app restarts and the route is tried, and while
|
||||
// the wrong app stays in front its frame is never published.
|
||||
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
assert.deepEqual(Object.keys(bundle.images), []);
|
||||
if (badState === 'invalidObserver') assert.equal(f.operations().includes('screenshot'), false);
|
||||
assert.equal(result.outcomes[f.ids.home].error.code,
|
||||
badState === 'invalidObserver' ? 'CONTROLLER_RECOVERY_UNVERIFIED' : 'CONTROLLER_IDENTITY_MISMATCH');
|
||||
}
|
||||
@@ -2041,6 +2485,22 @@ test('agent coordinate fallback uses logical bounds and presses only the unchang
|
||||
assert.deepEqual(press[0].args.slice(0, 3), ['press', '2', '3']);
|
||||
});
|
||||
|
||||
test('agent coordinate fallback turns a tap on an upright frame back onto the portrait axes of a panel showing a landscape UI', async t => {
|
||||
// An opened iPhone Duo under Argent: the 4x6 screenshot is the panel's 6x4 tree turned a quarter clockwise, so the image
|
||||
// point (u, v) is the tree point (v, H - u). The tap at (0.5, 0.25) of the image is pixel (2, 1.5), the tree point (1.5, 4 - 2).
|
||||
const f = await fixture(t, { routes: [route('home')], stableLabels: true, logicalBounds: { x: 0, y: 0, width: 6, height: 4 } });
|
||||
const agent = agentFixture([
|
||||
state => ({ action: 'tap', frameId: state.frameId, x: 0.5, y: 0.25 }),
|
||||
{ action: 'capture', targetId: f.ids.home, description: 'Loaded screen after tapping the observed control.', requiredLabels: ['screen-title'] },
|
||||
{ action: 'done' },
|
||||
]);
|
||||
const result = await runCiMap({ ...f.options, agent, setup: [{ action: 'open', url: 'sample://home' }] });
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
const press = f.requests.filter(request => request.command === 'fake-controller' && request.args[0] === 'press');
|
||||
assert.equal(press.length, 1);
|
||||
assert.deepEqual(press[0].args.slice(0, 3), ['press', '1.5', '2']);
|
||||
});
|
||||
|
||||
test('coordinate freshness compares rectangle values independently of native JSON property order', async t => {
|
||||
const f = await fixture(t, { routes: [route('home')], stableLabels: true, logicalBounds: { x: 0, y: 0, width: 4, height: 6 } });
|
||||
let snapshots = 0;
|
||||
@@ -2701,7 +3161,7 @@ test('an Android capture builds an APK, repacks it with the SDK build-tools, and
|
||||
assert.equal(result.simulatorRuntime.deviceModel, 'Pixel 7');
|
||||
assert.equal(result.simulatorRuntime.osVersion, '15.0');
|
||||
assert.deepEqual(f.catalogRequests.map(request => request.url), [`https://web-preview-${PREVIEW_ID}.eas-simulator.ngrok.dev/api/devices`], 'the Android preview server lists emulators at /api/devices, not /grid/api');
|
||||
for (const command of ['config', 'fingerprint:generate', 'build:list', 'build', 'upload', 'simulator:start']) {
|
||||
for (const command of ['config', 'fingerprint:generate', 'build:list', 'build', 'simulator:start']) {
|
||||
const request = f.requests.find(item => item.command === 'fake-eas' && item.args[0] === command);
|
||||
assert.equal(value(request, '--platform'), 'android', `eas ${command} targets android`);
|
||||
}
|
||||
@@ -2709,7 +3169,8 @@ test('an Android capture builds an APK, repacks it with the SDK build-tools, and
|
||||
const repack = f.requests.find(request => request.command === 'fake-repack');
|
||||
assert.equal(value(repack, '--platform'), 'android');
|
||||
assert.equal(repack.environment.ANDROID_SDK_ROOT, '/opt/android-sdk', 'repack-app reads ANDROID_SDK_ROOT; ANDROID_HOME is the fallback source');
|
||||
assert.match(value(f.requests.find(request => request.args[0] === 'upload'), '--build-path'), /repacked\.apk$/);
|
||||
// The repacked APK is installed through the controller, not uploaded.
|
||||
assert.match(f.requests.find(request => request.command === 'fake-controller' && request.args[0] === 'install').args[1], /app\.apk$/);
|
||||
for (const request of f.requests.filter(request => request.command === 'fake-controller' && request.args[0] === 'open')) {
|
||||
assert.equal(value(request, '--platform'), 'android');
|
||||
}
|
||||
@@ -2882,3 +3343,12 @@ test('controller recovery time is not charged to the app\'s readiness budget', a
|
||||
assert.ok(first.recoveryMs > 0, 'the busy backoff was waited for');
|
||||
assert.ok(first.elapsedMs >= first.budgetMs && first.elapsedMs < first.budgetMs * 2, `the app still got its ${first.budgetMs} ms: ${JSON.stringify(first)}`);
|
||||
});
|
||||
|
||||
test('a verified label is located on the image\'s axes when the screenshot is the portrait screen turned a quarter clockwise', async () => {
|
||||
const { verifiedCaptureLabels } = await import('../../dist/capture/route-capture.js');
|
||||
const nodes = [{ type: 'Button', label: 'Done', rect: { x: 10, y: 900, width: 100, height: 40 } }];
|
||||
// On the screen's own axes the bounds are as the tree gives them.
|
||||
assert.deepEqual(verifiedCaptureLabels(nodes, ['Done'])[0].rect, { x: 10, y: 900, width: 100, height: 40 });
|
||||
// A 669 x 951 portrait panel captured upright as a 951 x 669 image: the button near its bottom-left is near the image's top-left.
|
||||
assert.deepEqual(verifiedCaptureLabels(nodes, ['Done'], { height: 951 })[0].rect, { x: 11, y: 10, width: 40, height: 100 });
|
||||
});
|
||||
@@ -39,6 +39,14 @@ test('any two commits: a capture and report like a pull request\'s, with no pull
|
||||
const line = await readFile(runSummary, 'utf8');
|
||||
assert.match(line, /^- iOS report of `v1\.1\.0` vs `v1\.0\.0`: \[Open\]\(https:\/\/explore-preview\.expo\.app\/\?repo=acme%2Fexample&run=1234&attempt=1&artifact=900\) · \[zip\]\(https:\/\/github\.com\/acme\/example\/actions\/runs\/1234\/artifacts\/900\) · \d+ changes?\n$/);
|
||||
assert.equal(f.comments.length, 0);
|
||||
// A target of a config with targets: is linked by its id and labelled as config.yaml names it, escaped as Markdown text.
|
||||
const targeted = join(f.root, 'targeted-input.json');
|
||||
const input = JSON.parse(await readFile(result.inputPath, 'utf8'));
|
||||
await writeFile(targeted, JSON.stringify({ ...input, commentState: { ...input.commentState, target: { id: 'duo-open', platform: 'ios', label: 'iPhone Duo [open]' } } }));
|
||||
const targetSummary = join(f.root, 'target-summary.md');
|
||||
await publishCiReportComment({ inputPath: targeted, artifactUrl: 'https://github.com/acme/example/actions/runs/1234/artifacts/900', target: 'duo-open',
|
||||
environment: { ...f.environment, GITHUB_TOKEN: '', GITHUB_STEP_SUMMARY: targetSummary }, transport: async input => assert.fail(`no GitHub request: ${input}`) });
|
||||
assert.match(await readFile(targetSummary, 'utf8'), /^- iPhone Duo \\\[open\\\] report of `v1\.1\.0` vs `v1\.0\.0`: \[Open\]\(https:\/\/explore-preview\.expo\.app\/\?repo=acme%2Fexample&run=1234&attempt=1&target=duo-open&artifact=900\) · /);
|
||||
|
||||
const summary = renderCompareSummary(result.review.pullRequest, 'https://example.expo.app/p/token', null, [await readCiReportInput(result.inputPath)]);
|
||||
assert.match(summary, /^### Explore: `v1\.1\.0` vs `v1\.0\.0`$/m);
|
||||
|
||||
@@ -9,7 +9,7 @@ import test from "node:test";
|
||||
import { gzipSync } from "node:zlib";
|
||||
import { AGENT_DEVICE_VERSION } from "../../dist/shared/agent-device-version.js";
|
||||
import { ARGENT_VERSION } from "../../dist/shared/argent-version.js";
|
||||
import { CONTROLLER_PACKAGES, agentDeviceLauncher, controllerBin, controllerCacheRoot, controllerCached, controllerDirectory, controllerTarballUrl, ensureController } from "../../dist/shared/controller-cache.js";
|
||||
import { CONTROLLER_PACKAGES, agentDeviceLauncher, argentToolServerDirectory, controllerBin, controllerCacheRoot, controllerCached, controllerDirectory, controllerTarballUrl, ensureArgentToolServer, ensureController, npmEnvironment } from "../../dist/shared/controller-cache.js";
|
||||
|
||||
/** A gzip tarball of `entries` ({ name, contents?, type?, mode?, link? }), laid out as npm publishes one. */
|
||||
function tarball(entries) {
|
||||
@@ -122,3 +122,38 @@ test("the agent-device command runs the cached release with the caller's argumen
|
||||
assert.equal(run.status, 0, run.stderr);
|
||||
assert.deepEqual(JSON.parse(run.stdout), ["snapshot", "--json", "--", "-h"]);
|
||||
});
|
||||
|
||||
test("the tool-server's shipped lockfile locks the Argent release Explore pins, and every package with an integrity", async () => {
|
||||
const lock = JSON.parse(await readFile(new URL("../../controllers/argent-tool-server/package-lock.json", import.meta.url), "utf8"));
|
||||
const argent = lock.packages["node_modules/@swmansion/argent"];
|
||||
assert.deepEqual([argent.version, argent.integrity], [CONTROLLER_PACKAGES.argent.version, CONTROLLER_PACKAGES.argent.integrity]);
|
||||
const unlocked = Object.entries(lock.packages).filter(([path, entry]) => path && !entry.link && !/^sha512-/.test(entry.integrity ?? ""));
|
||||
assert.deepEqual(unlocked.map(([path]) => path), [], "every package is locked to its tarball");
|
||||
const manifest = JSON.parse(await readFile(new URL("../../controllers/argent-tool-server/package.json", import.meta.url), "utf8"));
|
||||
assert.deepEqual(manifest.dependencies, { "@swmansion/argent": CONTROLLER_PACKAGES.argent.version });
|
||||
assert.ok(JSON.parse(await readFile(new URL("../../package.json", import.meta.url), "utf8")).files.includes("controllers/argent-tool-server"), "it ships with Explore");
|
||||
});
|
||||
|
||||
test("the tool-server installs from the shipped lockfile into a folder named for it, once", async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-tool-server-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const environment = { EXPLORE_CONTROLLER_CACHE: root, HOME: root };
|
||||
const installs = [];
|
||||
const install = async directory => {
|
||||
installs.push(await readdir(directory));
|
||||
// npm ci leaves the lockfile it installed from, and the package under node_modules.
|
||||
await mkdir(join(directory, "node_modules", "@swmansion", "argent", "dist"), { recursive: true });
|
||||
};
|
||||
const cli = await ensureArgentToolServer({ environment, install });
|
||||
assert.ok(cli.startsWith(argentToolServerDirectory(root)));
|
||||
assert.match(argentToolServerDirectory(root), /argent-tool-server@0\.29\.0-[0-9a-f]{12}$/);
|
||||
assert.deepEqual(installs, [["package-lock.json", "package.json"]]);
|
||||
assert.equal(await ensureArgentToolServer({ environment, install }), cli);
|
||||
assert.equal(installs.length, 1, "an installed copy is reused");
|
||||
});
|
||||
|
||||
test("npm installing the tool-server gets what reaches the registry and none of a capture's secrets", () => {
|
||||
const passed = npmEnvironment({ PATH: "/usr/bin", HOME: "/home/me", TMPDIR: "/tmp/me", HTTPS_PROXY: "http://proxy", npm_config_registry: "https://mirror",
|
||||
EXPO_TOKEN: "expo", GITHUB_TOKEN: "github", ANTHROPIC_API_KEY: "key", OPENAI_API_KEY: "key", AGENT_DEVICE_DAEMON_AUTH_TOKEN: "token" });
|
||||
assert.deepEqual(Object.keys(passed).sort(), ["HOME", "HTTPS_PROXY", "PATH", "TMPDIR", "npm_config_registry"]);
|
||||
});
|
||||
@@ -510,12 +510,20 @@ test("doctor checks each configured platform's EAS profile and warns when the wo
|
||||
|
||||
for (const name of ["explore-review.yml", "explore-baseline.yml"]) {
|
||||
const path = join(root, ".github/workflows", name);
|
||||
await writeFile(path, (await readFile(path, "utf8")).replaceAll("matrix.platform", "github.ref_name"));
|
||||
await writeFile(path, (await readFile(path, "utf8")).replaceAll("matrix.target", "github.ref_name"));
|
||||
}
|
||||
const single = await runDoctor(offline(root));
|
||||
assert.deepEqual(check(single, "workflow-platforms-explore-review.yml").map(item => item.code), ["WORKFLOW_PLATFORM_MATRIX_MISSING"]);
|
||||
assert.deepEqual(check(single, "workflow-platforms-explore-baseline.yml").map(item => item.status), ["warn"]);
|
||||
const one = await app(t); await workflows(one); assert.deepEqual((await runDoctor(offline(one))).checks.filter(item => item.id.startsWith("workflow-platforms")), []);
|
||||
// A workflow installed before targets runs one job per platform: enough for platforms, not for targets.
|
||||
for (const name of ["explore-review.yml", "explore-baseline.yml"]) {
|
||||
const path = join(root, ".github/workflows", name);
|
||||
await writeFile(path, (await readFile(path, "utf8")).replaceAll("github.ref_name", "matrix.platform"));
|
||||
}
|
||||
assert.deepEqual(check(await runDoctor(offline(root)), "workflow-platforms-explore-review.yml"), []);
|
||||
await write(root, { ".expo-explore/config.yaml": JSON.stringify({ ...baseConfig, targets: { phone: { platform: "ios" }, duo: { platform: "ios", device: "iPhone Duo", pose: "open" } } }) });
|
||||
assert.deepEqual(check(await runDoctor(offline(root)), "workflow-platforms-explore-review.yml").map(item => item.code), ["WORKFLOW_PLATFORM_MATRIX_MISSING"]);
|
||||
});
|
||||
|
||||
test("doctor warns when ffmpeg is missing and the launch is observed", async t => {
|
||||
@@ -563,3 +571,79 @@ test("doctor warns when an installed workflow drifts from this version's templat
|
||||
assert.match(edited[0].message, /edited after setup/);
|
||||
assert.match(edited[0].nextAction, /--force/);
|
||||
});
|
||||
|
||||
test("with a local Android emulator, doctor checks the device profile and that the APK can be repacked on this machine", async (t) => {
|
||||
const root = await app(t, { ...baseConfig, app: { ...baseConfig.app, platform: "android" }, device: { name: "pixel_7" } });
|
||||
const sdk = await mkdtemp(join(tmpdir(), "explore-doctor-sdk-"));
|
||||
t.after(() => rm(sdk, { recursive: true, force: true }));
|
||||
for (const abi of ["arm64-v8a", "x86_64"]) {
|
||||
await mkdir(join(sdk, "system-images", "android-35", "google_apis", abi), { recursive: true });
|
||||
await writeFile(join(sdk, "system-images", "android-35", "google_apis", abi, "system.img"), "");
|
||||
}
|
||||
const eas = easRun({ available: false });
|
||||
const run = ({ java = true } = {}) => (command, args, cwd) => {
|
||||
if (command.endsWith("/avdmanager")) return { status: 0, stderr: "", stdout: "pixel_7\npixel_8\n" };
|
||||
if (command === "java") return java ? { status: 0, stdout: "", stderr: "openjdk version \"17.0.20.1\" 2026-08-18 LTS\nOpenJDK Runtime Environment\n" } : { status: 127, stdout: "", stderr: "java: not found" };
|
||||
return eas.run(command, args, cwd);
|
||||
};
|
||||
const doctor = (options = {}) => runDoctor({ project: root, github: false, simulator: "local", environment: { ...process.env, ANDROID_HOME: sdk }, run: run(options), ...options.extra });
|
||||
// Without build-tools the local repack, now the default with a local emulator, cannot run.
|
||||
const noTools = await doctor();
|
||||
assert.equal(check(noTools, "local-emulator")[0].status, "pass");
|
||||
assert.equal(check(noTools, "local-repack")[0].code, "LOCAL_REPACK_UNAVAILABLE");
|
||||
assert.match(check(noTools, "local-repack")[0].message, /build-tools/);
|
||||
await mkdir(join(sdk, "build-tools", "35.0.0"), { recursive: true });
|
||||
const ready = await doctor();
|
||||
assert.equal(check(ready, "local-repack")[0].status, "pass");
|
||||
assert.match(check(ready, "local-repack")[0].message, /build-tools 35\.0\.0, openjdk version "17\.0\.20\.1"/);
|
||||
assert.match(check(await doctor({ java: false }), "local-repack")[0].message, /needs Java/);
|
||||
// A hosted EAS repack needs neither.
|
||||
assert.deepEqual(check(await doctor({ extra: { repack: "eas" } }), "local-repack"), []);
|
||||
});
|
||||
|
||||
test("with a local simulator, doctor checks that this Mac can create the device instead of EAS Simulator access", async (t) => {
|
||||
const root = await app(t);
|
||||
const eas = easRun({ available: false });
|
||||
const simctl = (devicetypes, runtimes) => (command, args, cwd) => {
|
||||
if (command !== "xcrun") return eas.run(command, args, cwd);
|
||||
const json = args[2] === "devicetypes" ? devicetypes : runtimes;
|
||||
return { status: 0, stderr: "", stdout: JSON.stringify(json) };
|
||||
};
|
||||
const types = { devicetypes: [{ name: "iPhone 17", identifier: "type.iPhone-17" }, { name: "iPhone 17 Pro", identifier: "type.iPhone-17-Pro" }] };
|
||||
const runtimes = { runtimes: [{ identifier: "runtime.iOS-27-0", version: "27.0", platform: "iOS", isAvailable: true,
|
||||
supportedDeviceTypes: [{ identifier: "type.iPhone-17" }, { identifier: "type.iPhone-17-Pro" }] }] };
|
||||
const ready = await runDoctor({ project: root, github: false, simulator: "local", run: simctl(types, runtimes) });
|
||||
assert.deepEqual(check(ready, "eas-simulator"), [], "EAS Simulator access is not needed");
|
||||
assert.equal(check(ready, "local-simulator")[0].status, "pass");
|
||||
assert.match(check(ready, "local-simulator")[0].message, /iOS 27\.0/);
|
||||
const missing = await runDoctor({ project: root, github: false, simulator: "local", run: simctl({ devicetypes: [] }, runtimes) });
|
||||
assert.equal(check(missing, "local-simulator")[0].code, "LOCAL_SIMULATOR_DEVICE_UNAVAILABLE");
|
||||
});
|
||||
|
||||
test("doctor checks each target where it runs: local tools for local targets, EAS Simulator access when any target uses it", async (t) => {
|
||||
const eas = easRun();
|
||||
const run = (command, args, cwd) => {
|
||||
if (command !== "xcrun") return eas.run(command, args, cwd);
|
||||
return { status: 0, stderr: "", stdout: JSON.stringify(args[2] === "devicetypes"
|
||||
? { devicetypes: [{ name: "iPhone 17", identifier: "type.iPhone-17" }, { name: "iPhone 17 Pro", identifier: "type.iPhone-17-Pro" }] }
|
||||
: { runtimes: [{ identifier: "runtime.iOS-27-0", version: "27.0", platform: "iOS", isAvailable: true, supportedDeviceTypes: [{ identifier: "type.iPhone-17" }, { identifier: "type.iPhone-17-Pro" }] }] }) };
|
||||
};
|
||||
const doctor = async (config, options = {}) => runDoctor({ project: await app(t, config), github: false, run, ...options });
|
||||
const devices = report => check(report, "local-simulator").map(item => item.message.match(/create an (.+) simulator/)[1]);
|
||||
// Every target runs locally on its own say, with nothing at the top level: no EAS Simulator access is needed.
|
||||
const local = await doctor({ ...baseConfig, targets: { phone: { platform: "ios", simulator: "local" }, pro: { platform: "ios", device: "iPhone 17 Pro", simulator: "local" } } });
|
||||
assert.deepEqual(devices(local), ["iPhone 17", "iPhone 17 Pro"]);
|
||||
assert.deepEqual(check(local, "eas-simulator"), []);
|
||||
// A local config with one target on EAS: that target needs EAS Simulator access, and the local one this Mac's tools.
|
||||
const mixed = await doctor({ ...baseConfig, capture: { ...baseConfig.capture, simulator: "local" },
|
||||
targets: { phone: { platform: "ios" }, cloud: { platform: "ios", device: "iPhone 17 Pro", simulator: "eas", controller: "argent" } } });
|
||||
assert.deepEqual(devices(mixed), ["iPhone 17"]);
|
||||
assert.equal(check(mixed, "eas-simulator")[0].status, "pass");
|
||||
// The target's Argent is reported as a top-level one would be.
|
||||
assert.equal(check(mixed, "controller")[0].code, "CONTROLLER_APPEARANCE_FIXED");
|
||||
// --simulator and --controller decide for every target, as they do in a capture.
|
||||
const forced = await doctor({ ...baseConfig, targets: { phone: { platform: "ios", simulator: "local", controller: "argent" } } }, { simulator: "eas", controller: "agent-device" });
|
||||
assert.deepEqual(devices(forced), []);
|
||||
assert.equal(check(forced, "eas-simulator")[0].status, "pass");
|
||||
assert.deepEqual(check(forced, "controller"), []);
|
||||
});
|
||||
@@ -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, resolvePlatformConfig, withRunOverrides } =
|
||||
const { DEFAULT_EXPLORE_CONFIG_PATH, assertExecutionMode, parseExploreConfig, readExploreConfig, validateExploreConfig, configPlatforms, configTargets, resolvePlatformConfig, resolveTargetConfig, withRunOverrides, captureRepack } =
|
||||
await tsImport("../../src/config/explore-config.ts", import.meta.url);
|
||||
|
||||
const SOURCE = `app:
|
||||
@@ -24,7 +24,7 @@ test("normalizes current configuration with deterministic defaults and no versio
|
||||
mode: "deterministic",
|
||||
app: { name: "Example", platform: "ios", bundleId: "com.example.app", easProfile: "explore", scheme: "example-app" },
|
||||
device: { name: "iPhone 17 Pro" }, navigation: { provider: "auto" },
|
||||
exploration: { scope: "changes" }, capture: { maxMinutes: 30, maxActions: 500, repack: "eas", appearance: "auto", launch: "screenshot", reset: "root-link", unattributed: "publish" },
|
||||
exploration: { scope: "changes" }, capture: { maxMinutes: 30, maxActions: 500, appearance: "auto", launch: "screenshot", reset: "root-link", unattributed: "publish" },
|
||||
});
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), navigation: { provider: "react-navigation", entry: "src/navigation/Root.tsx" }, exploration: { scope: "all" } }).navigation,
|
||||
{ provider: "react-navigation", entry: "src/navigation/Root.tsx" });
|
||||
@@ -259,6 +259,37 @@ test("--controller overrides the config's controller for one run and is validate
|
||||
assert.throws(() => withRunOverrides(plain, { controller: "appium" }), /--controller must be agent-device or argent/);
|
||||
});
|
||||
|
||||
test("capture.simulator: local runs on a simulator on this Mac; eas, the default, leaves the config as it was", () => {
|
||||
const plain = validateExploreConfig(base());
|
||||
assert.equal("simulator" in plain.capture, false);
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), capture: { simulator: "eas" } }), plain);
|
||||
assert.equal(validateExploreConfig({ ...base(), capture: { simulator: "local" } }).capture.simulator, "local");
|
||||
assert.throws(() => validateExploreConfig({ ...base(), capture: { simulator: "device-farm" } }), error => error.code === "CONFIG_INVALID");
|
||||
});
|
||||
|
||||
test("the repack runs on this machine with a local simulator and in EAS otherwise, unless the config or --repack chooses", () => {
|
||||
const plain = validateExploreConfig(base());
|
||||
assert.equal("repack" in plain.capture, false, "an unset repack is resolved where it is used");
|
||||
assert.equal(captureRepack(plain), "eas");
|
||||
assert.equal(captureRepack(validateExploreConfig({ ...base(), capture: { simulator: "local" } })), "local");
|
||||
assert.equal(captureRepack(validateExploreConfig({ ...base(), capture: { simulator: "local", repack: "eas" } })), "eas");
|
||||
assert.equal(captureRepack(validateExploreConfig({ ...base(), capture: { repack: "local" } })), "local");
|
||||
// --simulator local brings the local repack with it; --repack wins over both.
|
||||
assert.equal(captureRepack(withRunOverrides(plain, { simulator: "local" })), "local");
|
||||
assert.equal(captureRepack(withRunOverrides(plain, { simulator: "local", repack: "eas" })), "eas");
|
||||
assert.equal(captureRepack(withRunOverrides(plain, { repack: "local" })), "local");
|
||||
assert.throws(() => withRunOverrides(plain, { repack: "remote" }), /--repack must be eas or local/);
|
||||
assert.throws(() => validateExploreConfig({ ...base(), capture: { repack: "remote" } }), error => error.code === "CONFIG_INVALID");
|
||||
});
|
||||
|
||||
test("--simulator overrides the config's simulator for one run and is validated", () => {
|
||||
const plain = validateExploreConfig(base());
|
||||
const local = withRunOverrides(plain, { simulator: "local" });
|
||||
assert.equal(local.capture.simulator, "local");
|
||||
assert.deepEqual(withRunOverrides(local, { simulator: "eas" }), plain);
|
||||
assert.throws(() => withRunOverrides(plain, { simulator: "remote" }), /--simulator must be eas or local/);
|
||||
});
|
||||
|
||||
test("device.pose folds the primary platform's device and is validated", () => {
|
||||
const open = validateExploreConfig({ ...base(), device: { name: "iPhone Duo", pose: "open" } });
|
||||
assert.deepEqual(open.device, { name: "iPhone Duo", pose: "open" });
|
||||
@@ -269,3 +300,57 @@ test("device.pose folds the primary platform's device and is validated", () => {
|
||||
assert.deepEqual(resolvePlatformConfig(both, "ios").device, { name: "iPhone Duo", pose: "open" });
|
||||
assert.deepEqual(resolvePlatformConfig(both, "android").device, { name: "pixel_7" });
|
||||
});
|
||||
|
||||
test("targets name several captures, even of one platform, each resolved to its own flat config", () => {
|
||||
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", label: "Duo open" },
|
||||
android: { platform: "android", bundleId: "com.example.app", easProfile: "explore-apk" },
|
||||
} });
|
||||
assert.deepEqual(configTargets(config), [
|
||||
{ id: "iphone", platform: "ios", label: "iPhone 17 Pro" },
|
||||
{ id: "duo-closed", platform: "ios", label: "iPhone Duo (closed)" },
|
||||
{ id: "duo-open", platform: "ios", label: "Duo open" },
|
||||
{ id: "android", platform: "android", label: "pixel_7" },
|
||||
]);
|
||||
assert.deepEqual(configPlatforms(config), ["ios", "android"]);
|
||||
const open = resolveTargetConfig(config, { target: "duo-open" });
|
||||
assert.deepEqual(open.device, { name: "iPhone Duo", pose: "open" });
|
||||
assert.deepEqual(open.target, { id: "duo-open", platform: "ios", label: "Duo open" });
|
||||
assert.equal("targets" in open, false);
|
||||
const android = resolveTargetConfig(config, { platform: "android" });
|
||||
assert.deepEqual([android.app.platform, android.app.easProfile, android.device.name], ["android", "explore-apk", "pixel_7"]);
|
||||
assert.throws(() => resolveTargetConfig(config, { platform: "ios" }), error => error.code === "TARGET_REQUIRED");
|
||||
assert.throws(() => resolveTargetConfig(config, { target: "tablet" }), error => error.code === "TARGET_NOT_CONFIGURED");
|
||||
});
|
||||
|
||||
test("a config without targets has one target per platform, named after it", () => {
|
||||
const config = validateExploreConfig({ ...base(), platforms: { ios: {}, android: { bundleId: "com.example.app", easProfile: "explore-apk" } } });
|
||||
assert.deepEqual(configTargets(config).map(target => target.id), ["ios", "android"]);
|
||||
assert.deepEqual(resolveTargetConfig(config, { target: "android" }).target, { id: "android", platform: "android", label: "Android" });
|
||||
assert.deepEqual(resolveTargetConfig(validateExploreConfig(base())).target, { id: "ios", platform: "ios", label: "iOS" });
|
||||
});
|
||||
|
||||
test("target ids and entries are validated", () => {
|
||||
for (const targets of [{ Base: { platform: "ios" } }, { head: { platform: "ios" } }, { iphone: { platform: "web" } }, { iphone: { platform: "ios", pose: "flat" } },
|
||||
{ pixel: { platform: "android" } }, {}]) {
|
||||
assert.throws(() => validateExploreConfig({ ...base(), targets }), error => error.code === "CONFIG_INVALID", JSON.stringify(targets));
|
||||
}
|
||||
assert.throws(() => validateExploreConfig({ ...base(), platforms: { ios: {} }, targets: { iphone: { platform: "ios" } } }), /targets or platforms, not both/);
|
||||
});
|
||||
|
||||
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" },
|
||||
android: { platform: "android", bundleId: "com.example.app", easProfile: "explore-apk", controller: "agent-device" },
|
||||
cloud: { platform: "ios", simulator: "eas" },
|
||||
} });
|
||||
const capture = id => resolveTargetConfig(config, { target: id }).capture;
|
||||
assert.deepEqual([capture("duo").controller, capture("duo").simulator], ["argent", "local"]);
|
||||
assert.deepEqual([capture("android").controller, capture("android").simulator], [undefined, "local"], "agent-device is the default, so it is absent");
|
||||
assert.deepEqual([capture("cloud").controller, capture("cloud").simulator], ["argent", undefined]);
|
||||
// The repack follows each target's simulator.
|
||||
assert.deepEqual(["duo", "android", "cloud"].map(id => captureRepack(resolveTargetConfig(config, { target: id }))), ["local", "local", "eas"]);
|
||||
assert.throws(() => validateExploreConfig({ ...base(), targets: { duo: { platform: "ios", controller: "maestro" } } }), error => error.code === "CONFIG_INVALID");
|
||||
});
|
||||
@@ -15,6 +15,8 @@ test("a hosted preview and a local review's Viewer have a link an agent can fetc
|
||||
assert.equal(handoffPageUrl(new URL("http://127.0.0.1:4319/#/map")), undefined);
|
||||
assert.equal(handoffPageUrl(new URL(`http://127.0.0.1:4319/p/${TOKEN}?platform=ios`)), `http://127.0.0.1:4319/p/${TOKEN}?platform=ios`, "a local review's Viewer serves the agent API too");
|
||||
assert.equal(handoffPageUrl(new URL("https://explore.expo.app/r?repo=a/b&run=1&attempt=1")), undefined);
|
||||
assert.equal(handoffPageUrl(new URL(`https://app-explore--abc.expo.app/p/${TOKEN}?target=duo-open&view=compare&screen=x`)), `https://app-explore--abc.expo.app/p/${TOKEN}?target=duo-open`,
|
||||
"a target's link keeps the agent on that target's report");
|
||||
});
|
||||
|
||||
const input = {
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { spawn } from "node:child_process";
|
||||
import { existsSync } from "node:fs";
|
||||
import { mkdir, mkdtemp, readdir, readFile, rm, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
import { openLocalCaptureRecord, sweepLocalCaptures } from "../../dist/capture/local-registry.js";
|
||||
|
||||
const UDID = "0A1B2C3D-4E5F-4A6B-8C7D-9E0F1A2B3C4D";
|
||||
const DEAD = 999999999;
|
||||
|
||||
async function scratch(t) {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-local-registry-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
// HOME is the scratch root, so the registry and port locks live in its .cache/expo-explore.
|
||||
return { root, environment: { PATH: process.env.PATH, HOME: root, ANDROID_HOME: join(root, "sdk") }, registry: join(root, ".cache", "expo-explore", "local-captures") };
|
||||
}
|
||||
|
||||
/** A runner that records commands: adb lists nothing (the emulator is gone after emu kill) and pgrep finds no process. */
|
||||
function recordingRunner() {
|
||||
const requests = [];
|
||||
const runner = request => { requests.push([request.command.split("/").at(-1), ...request.args]); return { stdout: "", stderr: "" }; };
|
||||
return { requests, runner };
|
||||
}
|
||||
|
||||
test("a capture's record names what it started, and goes once everything is stopped", async t => {
|
||||
const { root, environment, registry } = await scratch(t);
|
||||
const record = await openLocalCaptureRecord(environment, join(root, "session"));
|
||||
const [file] = await readdir(registry);
|
||||
await record.update({ udid: UDID });
|
||||
await record.update({ argent: { pid: 4242, cli: "/cli.js", home: "/home" } });
|
||||
const saved = JSON.parse(await readFile(join(registry, file), "utf8"));
|
||||
assert.equal(saved.owner, process.pid);
|
||||
assert.equal(saved.directory, join(root, "session"));
|
||||
assert.equal(saved.udid, UDID);
|
||||
assert.deepEqual(saved.argent, { pid: 4242, cli: "/cli.js", home: "/home" });
|
||||
await record.close();
|
||||
assert.deepEqual(await readdir(registry), []);
|
||||
});
|
||||
|
||||
test("a review sweeps what a capture stopped hard left running: its simulator, emulator, daemon, tool-server and files", async t => {
|
||||
const { root, environment, registry } = await scratch(t);
|
||||
await mkdir(registry, { recursive: true });
|
||||
const directory = join(root, "expo-explore-session-old");
|
||||
await mkdir(join(directory, "agent-device-state"), { recursive: true });
|
||||
// Stand-ins for the orphaned agent-device daemon and Argent tool-server.
|
||||
const daemon = spawn(process.execPath, ["-e", "setInterval(() => {}, 1000)"], { stdio: "ignore" });
|
||||
const server = spawn(process.execPath, ["-e", "setInterval(() => {}, 1000)"], { stdio: "ignore" });
|
||||
t.after(() => { daemon.kill("SIGKILL"); server.kill("SIGKILL"); });
|
||||
const exited = child => new Promise(resolve => child.once("exit", () => resolve(true)));
|
||||
const daemonExited = exited(daemon), serverExited = exited(server);
|
||||
await writeFile(join(directory, "agent-device-state", "daemon.json"), JSON.stringify({ pid: daemon.pid }));
|
||||
await writeFile(join(registry, "old.json"), JSON.stringify({ owner: DEAD, startedAt: "2026-10-17T00:00:00.000Z", directory, udid: UDID,
|
||||
serial: "emulator-5556", avd: "explore-base-d6227297", argent: { pid: server.pid, cli: join(root, "missing-cli.js"), home: join(root, "argent-home") } }));
|
||||
const { requests, runner } = recordingRunner();
|
||||
const swept = await sweepLocalCaptures({ environment, runner, cwd: root });
|
||||
assert.deepEqual(swept, [`Argent tool-server (pid ${server.pid})`, "agent-device daemon", `simulator ${UDID}`, "emulator emulator-5556"]);
|
||||
assert.ok(await daemonExited && await serverExited, "the daemon and tool-server are stopped");
|
||||
assert.ok(requests.some(request => request.join(" ") === `xcrun simctl delete ${UDID}`));
|
||||
assert.ok(requests.some(request => request.join(" ") === "adb -s emulator-5556 emu kill"));
|
||||
assert.equal(existsSync(directory), false, "its files go");
|
||||
assert.deepEqual(await readdir(registry), [], "and so does its record");
|
||||
});
|
||||
|
||||
test("a sweep leaves a live capture's record alone, and an emulator whose port a live capture now holds", async t => {
|
||||
const { root, environment, registry } = await scratch(t);
|
||||
await mkdir(registry, { recursive: true });
|
||||
await writeFile(join(registry, "live.json"), JSON.stringify({ owner: process.pid, startedAt: "2026-10-17T00:00:00.000Z", directory: join(root, "live"), udid: UDID }));
|
||||
// A dead capture's emulator port, since reserved by this (live) process for its own emulator.
|
||||
const ports = join(root, ".cache", "expo-explore", "emulator-ports");
|
||||
await mkdir(ports, { recursive: true });
|
||||
await writeFile(join(ports, "5554.lock"), String(process.pid));
|
||||
await writeFile(join(registry, "dead.json"), JSON.stringify({ owner: DEAD, startedAt: "2026-10-17T00:00:00.000Z", directory: join(root, "dead"), serial: "emulator-5554" }));
|
||||
const { requests, runner } = recordingRunner();
|
||||
const swept = await sweepLocalCaptures({ environment, runner, cwd: root });
|
||||
assert.deepEqual(swept, ["agent-device daemon"]);
|
||||
assert.equal(requests.some(request => request.includes("simctl") || request.includes("emu")), false, "nothing live is stopped");
|
||||
assert.deepEqual((await readdir(registry)).sort(), ["live.json"]);
|
||||
});
|
||||
@@ -1,11 +1,11 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import http from 'node:http';
|
||||
import test from 'node:test';
|
||||
import { spawnSync } from 'node:child_process';
|
||||
import { spawn, spawnSync } from 'node:child_process';
|
||||
import { lstat, mkdtemp, readFile, realpath, rm, writeFile } from 'node:fs/promises';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { join } from 'node:path';
|
||||
import { appEnvironment, captureCacheDirectory, defaultBase, installDependencies, keepCapture, localInstallCommand, localReviewConfig, reportRef, reviewHeadSource, runLocalReview, snapshotWorkingTree } from '../../dist/ci/local-review.js';
|
||||
import { appEnvironment, captureCacheDirectory, defaultBase, installDependencies, keepCapture, localInstallCommand, localReviewConfig, reportRef, reviewHeadSource, runLocalReview, snapshotWorkingTree, stopRecordedSessions } from '../../dist/ci/local-review.js';
|
||||
import { mkdir, readdir } from 'node:fs/promises';
|
||||
import { startLocalReportServer } from '../../dist/report/local-report-server.js';
|
||||
import { fixture, git } from '../helpers/public-ci-fixture.mjs';
|
||||
@@ -205,12 +205,30 @@ test('the local Viewer serves the built Viewer and each report the way a hosted
|
||||
assert.equal((await get(server.url)).status, 404, 'an agent fetch of a report the agent API cannot read is a 404, not the Viewer shell');
|
||||
assert.deepEqual(new Uint8Array(await (await get(`${server.url}/report.zip?platform=android`)).arrayBuffer()), new Uint8Array([4]));
|
||||
assert.deepEqual(new Uint8Array(await (await get(`${server.url}/report.zip`)).arrayBuffer()), new Uint8Array([1, 2]));
|
||||
assert.deepEqual(await (await get(`${server.url}/reports.json`)).json(), [{ platform: 'ios', changes: 3, device: 'iPhone 17' }, { platform: 'android' }]);
|
||||
assert.deepEqual(await (await get(`${server.url}/reports.json`)).json(), [{ target: 'ios', platform: 'ios', label: 'iOS', changes: 3, device: 'iPhone 17' }, { target: 'android', platform: 'android', label: 'Android' }]);
|
||||
for (const path of ['/', '/p/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', '/p/abcdefghijklmnopqrstuvwxyz234567/x', '/assets/../index.html', '/assets/missing.js']) {
|
||||
assert.equal((await get(path)).status, 404, path);
|
||||
}
|
||||
});
|
||||
|
||||
test('the local Viewer serves each target of a run, by ?target= or, for links from before targets, ?platform=', async t => {
|
||||
const viewerRoot = await scratch(t, 'explore-local-viewer-');
|
||||
await writeFile(join(viewerRoot, 'index.html'), '<!doctype html><title>Viewer</title>');
|
||||
const reports = [{ platform: 'ios', target: { id: 'phone', platform: 'ios', label: 'iPhone 17' }, zip: new Uint8Array([1]) },
|
||||
{ platform: 'ios', target: { id: 'duo-open', platform: 'ios', label: 'iPhone Duo (open)' }, zip: new Uint8Array([2]) },
|
||||
{ platform: 'android', target: { id: 'android', platform: 'android', label: 'Android' }, zip: new Uint8Array([3]) }];
|
||||
const server = await startLocalReportServer({ reports, viewerRoot });
|
||||
t.after(() => server.close());
|
||||
const zip = async query => new Uint8Array(await (await fetch(`${server.url}/report.zip${query}`)).arrayBuffer());
|
||||
assert.deepEqual(await zip('?target=duo-open'), new Uint8Array([2]));
|
||||
assert.deepEqual(await zip('?platform=ios'), new Uint8Array([1]), 'the first iOS target');
|
||||
assert.deepEqual(await zip('?platform=android'), new Uint8Array([3]), 'the target named for the platform');
|
||||
assert.equal((await fetch(`${server.url}/report.zip?target=tablet`)).status, 404);
|
||||
assert.equal((await fetch(`${server.url}/report.zip?target=phone&platform=ios`)).status, 404);
|
||||
assert.deepEqual((await (await fetch(`${server.url}/reports.json`)).json()).map(entry => [entry.target, entry.label]),
|
||||
[['phone', 'iPhone 17'], ['duo-open', 'iPhone Duo (open)'], ['android', 'Android']]);
|
||||
});
|
||||
|
||||
test('a local review captures two commits of the repository in its own worktrees and packages a report', async t => {
|
||||
const f = await fixture(t, 'expo-router');
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
@@ -303,3 +321,133 @@ test('Ctrl+C stops the review, and the checkouts are removed while its files are
|
||||
t.after(() => rm(kept, { recursive: true, force: true }));
|
||||
assert.equal(process.listenerCount('SIGINT'), listeners, 'its handlers are gone, so a later Ctrl+C behaves normally');
|
||||
});
|
||||
|
||||
test('an interrupted review deletes the local simulators it recorded and stops its EAS sessions', async t => {
|
||||
const output = await realpath(await mkdtemp(join(tmpdir(), 'explore-recorded-')));
|
||||
t.after(() => rm(output, { recursive: true, force: true }));
|
||||
const udid = '0A1B2C3D-4E5F-4A6B-8C7D-9E0F1A2B3C4D';
|
||||
await writeFile(join(output, 'head-session'), `simctl-${udid}\n`);
|
||||
await writeFile(join(output, 'base-session'), 'session-1\n');
|
||||
const eas = [], simctl = [];
|
||||
const stopped = await stopRecordedSessions([output], {}, args => { eas.push(args); return { status: 0 }; }, true,
|
||||
args => { simctl.push(args); return { status: 0 }; });
|
||||
assert.deepEqual(stopped, [`simctl-${udid}`, 'session-1']);
|
||||
assert.deepEqual(simctl, [['shutdown', udid], ['delete', udid]]);
|
||||
assert.deepEqual(eas, [['simulator:stop', '--id', 'session-1', '--json', '--non-interactive']]);
|
||||
await assert.rejects(lstat(join(output, 'head-session')));
|
||||
});
|
||||
|
||||
test('a local review captures every target of the config at once, two of them on one platform', async t => {
|
||||
const targets = { phone: { platform: 'ios' }, 'duo-open': { platform: 'ios', device: 'iPhone Duo', pose: 'open' } };
|
||||
const f = await fixture(t, 'expo-router', { targets });
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const environment = { ...f.environment, EXPLORE_CACHE_DIR: await scratch(t, 'explore-local-cache-'), GITHUB_RUN_ID: '', GITHUB_RUN_ATTEMPT: '', GITHUB_TOKEN: '' };
|
||||
const lines = [];
|
||||
const result = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, progress: line => lines.push(line),
|
||||
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
t.after(() => rm(result.work, { recursive: true, force: true }));
|
||||
assert.deepEqual(result.reports.map(report => [report.target.id, report.platform]), [['phone', 'ios'], ['duo-open', 'ios']]);
|
||||
assert.deepEqual((await readdir(result.work)).sort(), ['duo-open', 'phone']);
|
||||
const runtimes = await Promise.all(result.reports.map(async report => JSON.parse(await readFile(join(report.directory, 'review.json'), 'utf8')).review.runtime));
|
||||
assert.deepEqual(runtimes.map(runtime => runtime.target.id), ['phone', 'duo-open']);
|
||||
assert.deepEqual(runtimes[0].targets, [{ id: 'phone', platform: 'ios', label: 'iPhone 17 Pro' }, { id: 'duo-open', platform: 'ios', label: 'iPhone Duo (open)' }]);
|
||||
assert.equal(runtimes[1].device.model, 'iPhone Duo');
|
||||
// Both targets capture the same two commits of one platform: one build lookup and one repack per commit, not per target.
|
||||
const eas = command => f.requests.filter(request => request.args[0] === command).length;
|
||||
assert.equal(eas('workflow:run'), 2);
|
||||
assert.equal(eas('fingerprint:generate'), 2);
|
||||
// The Duo target folds before capture; the phone does not.
|
||||
const folds = f.requests.filter(request => request.args[0] === 'fold');
|
||||
assert.equal(folds.length, 2, 'head and base of the Duo target');
|
||||
assert.ok(folds.every(request => request.args[1] === 'open'));
|
||||
// Each target keeps its own captures for later reviews.
|
||||
for (const id of ['phone', 'duo-open']) assert.ok((await lstat(join(captureCacheDirectory(environment, id, f.baseSha), 'bundle.json'))).isFile(), id);
|
||||
assert.ok(lines.some(line => line.startsWith('duo-open: reviewing (iPhone Duo (open))')), lines.join('\n'));
|
||||
|
||||
const one = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, target: 'duo-open', cache: false,
|
||||
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
t.after(() => rm(one.work, { recursive: true, force: true }));
|
||||
assert.deepEqual(one.reports.map(report => report.target.id), ['duo-open']);
|
||||
await assert.rejects(runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, target: 'tablet', runner: f.runner }),
|
||||
error => error.code === 'TARGET_NOT_CONFIGURED');
|
||||
});
|
||||
|
||||
test('a review of some targets names only those in its reports, so the Viewer links to no report the review did not make', async t => {
|
||||
const targets = { phone: { platform: 'ios' }, tablet: { platform: 'ios', device: 'iPad Air' }, pixel: { platform: 'android', bundleId: 'com.example.app', easProfile: 'capture' } };
|
||||
const f = await fixture(t, 'expo-router', { targets });
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const environment = { ...f.environment, EXPLORE_CACHE_DIR: await scratch(t, 'explore-local-cache-'), GITHUB_RUN_ID: '', GITHUB_RUN_ATTEMPT: '', GITHUB_TOKEN: '' };
|
||||
const review = async selection => {
|
||||
const result = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, cache: false, ...selection,
|
||||
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
t.after(() => rm(result.work, { recursive: true, force: true }));
|
||||
return Promise.all(result.reports.map(async report => JSON.parse(await readFile(join(report.directory, 'review.json'), 'utf8')).review.runtime));
|
||||
};
|
||||
// --platform ios: the two iOS targets link to each other, and to no Android report.
|
||||
const ios = await review({ platform: 'ios' });
|
||||
assert.deepEqual(ios.map(runtime => runtime.target.id), ['phone', 'tablet']);
|
||||
for (const runtime of ios) {
|
||||
assert.deepEqual(runtime.targets.map(target => target.id), ['phone', 'tablet']);
|
||||
assert.equal(runtime.platforms, undefined);
|
||||
}
|
||||
// --target phone: a report alone, with no other target or platform to switch to.
|
||||
const [phone] = await review({ target: 'phone' });
|
||||
assert.equal(phone.targets, undefined);
|
||||
assert.equal(phone.platforms, undefined);
|
||||
});
|
||||
|
||||
test('a review runs at most --parallel targets at once, and every target settles even when one fails', async () => {
|
||||
const { settleLimited } = await import('../../dist/ci/local-review.js');
|
||||
let running = 0, peak = 0;
|
||||
const results = await settleLimited([1, 2, 3, 4, 5], 2, async item => {
|
||||
running += 1; peak = Math.max(peak, running);
|
||||
await new Promise(resolve => setTimeout(resolve, 10));
|
||||
running -= 1;
|
||||
if (item === 3) throw new Error('three');
|
||||
return item * 10;
|
||||
});
|
||||
assert.equal(peak, 2);
|
||||
assert.deepEqual(results.map(result => result.status === 'fulfilled' ? result.value : result.reason.message), [10, 20, 'three', 40, 50]);
|
||||
});
|
||||
|
||||
test('a target that fails outright costs only its own report', async t => {
|
||||
const targets = { phone: { platform: 'ios' }, tablet: { platform: 'ios', device: 'iPad Air' } };
|
||||
const f = await fixture(t, 'expo-router', { targets });
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const environment = { ...f.environment, EXPLORE_CACHE_DIR: await scratch(t, 'explore-local-cache-'), GITHUB_RUN_ID: '', GITHUB_RUN_ATTEMPT: '', GITHUB_TOKEN: '' };
|
||||
// EAS cannot start the tablet's session; the phone's review goes on.
|
||||
const runner = request => {
|
||||
if (request.args[0] === 'simulator:start' && request.args.includes('iPad Air')) throw new Error('No simulator capacity for iPad Air');
|
||||
return f.runner(request);
|
||||
};
|
||||
const result = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, cache: false,
|
||||
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner, now: f.now, sleep: f.sleep });
|
||||
t.after(() => rm(result.work, { recursive: true, force: true }));
|
||||
assert.deepEqual(result.reports.map(report => report.target.id), ['phone']);
|
||||
assert.deepEqual(result.failures.map(failure => failure.target.id), ['tablet']);
|
||||
assert.match(result.failures[0].error.message, /iPad Air/);
|
||||
});
|
||||
|
||||
test('a local review first stops what a review stopped hard left running', async t => {
|
||||
const f = await fixture(t, 'expo-router');
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const cache = await scratch(t, 'explore-local-cache-');
|
||||
// An Argent tool-server whose capture's process is gone, and that capture's files.
|
||||
const orphan = spawn(process.execPath, ['-e', 'setInterval(() => {}, 1000)'], { stdio: 'ignore' });
|
||||
t.after(() => orphan.kill('SIGKILL'));
|
||||
const stopped = new Promise(resolve => orphan.once('exit', () => resolve(true)));
|
||||
const leftovers = join(cache, 'expo-explore-session-old');
|
||||
await mkdir(leftovers, { recursive: true });
|
||||
await mkdir(join(cache, 'local-captures'), { recursive: true });
|
||||
await writeFile(join(cache, 'local-captures', 'old.json'), JSON.stringify({ owner: 999999999, startedAt: '2026-10-17T00:00:00.000Z', directory: leftovers,
|
||||
argent: { pid: orphan.pid, cli: join(cache, 'missing-cli.js'), home: join(cache, 'argent-home') } }));
|
||||
const lines = [];
|
||||
const environment = { ...f.environment, EXPLORE_CACHE_DIR: cache, GITHUB_RUN_ID: '', GITHUB_RUN_ATTEMPT: '', GITHUB_TOKEN: '' };
|
||||
const result = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, progress: line => lines.push(line),
|
||||
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
t.after(() => rm(result.work, { recursive: true, force: true }));
|
||||
assert.equal(await stopped, true, 'the orphaned tool-server is stopped');
|
||||
assert.ok(lines.some(line => line === `stopped what an interrupted review left running: Argent tool-server (pid ${orphan.pid}), agent-device daemon`), lines.join('\n'));
|
||||
assert.deepEqual(await readdir(join(cache, 'local-captures')), []);
|
||||
await assert.rejects(lstat(leftovers), 'its files are gone');
|
||||
});
|
||||
@@ -108,8 +108,10 @@ function easFixture({ origin = "https://acme-explore--1lcbdcpwn3.expo.app", alia
|
||||
: new Response("# Expo Explore report", { status: 200, headers: { "content-type": "text/markdown; charset=utf-8" } });
|
||||
if (match[2] === "api/v1") return new Response(JSON.stringify({ kind: "pr-review" }), { status: 200, headers: { "content-type": "application/json; charset=utf-8" } });
|
||||
if (match[2] === "reports.json") return new Response(JSON.stringify(captured.listing.map(({ path: _path, ...rest }) => rest)), { status: 200, headers: { "content-type": "application/json; charset=utf-8" } });
|
||||
const platform = url.searchParams.get("platform");
|
||||
const entry = platform ? captured.listing.find(candidate => candidate.platform === platform) : captured.listing[0];
|
||||
// Selection as the Worker does it: ?target= by id, ?platform= by id and then by platform, else the first.
|
||||
const target = url.searchParams.get("target"), platform = url.searchParams.get("platform");
|
||||
const entry = target ? captured.listing.find(candidate => candidate.target === target)
|
||||
: platform ? captured.listing.find(candidate => candidate.target === platform) ?? captured.listing.find(candidate => candidate.platform === platform) : captured.listing[0];
|
||||
if (!entry) return new Response("Not found", { status: 404 });
|
||||
const key = Buffer.from(captured.env.EXPLORE_PREVIEW_KEY, "base64"); const sealed = Buffer.from(captured.sealedFiles[entry.path]);
|
||||
const decipher = createDecipheriv("aes-256-gcm", key, sealed.subarray(0, 12));
|
||||
@@ -325,7 +327,7 @@ test("ci:deploy fans several platforms' reports into one sealed deployment, veri
|
||||
const token = eas.captured.env.EXPLORE_PREVIEW_TOKEN;
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, undefined, "multi-platform deployments use the listing only");
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [
|
||||
{ platform: "ios", path: "ios.zip.enc" }, { platform: "android", path: "android.zip.enc" }], "the capturing-phase fixture has no review yet, so no change count");
|
||||
{ target: "ios", platform: "ios", label: "iOS", path: "ios.zip.enc" }, { target: "android", platform: "android", label: "Android", path: "android.zip.enc" }], "the capturing-phase fixture has no review yet, so no change count");
|
||||
assert.ok(!eas.captured.env.EXPLORE_PREVIEW_REPORTS.includes("#"), "dotenv treats # as a comment");
|
||||
const zips = [await zipReportDirectory(ios.reportPath), await zipReportDirectory(android.reportPath)];
|
||||
assert.deepEqual(result.reports.map(report => [report.platform, report.reportSha256, report.reportBytes, report.artifactUrl]),
|
||||
@@ -360,8 +362,8 @@ test("collectPlatformReports pairs downloaded artifact directories by platform a
|
||||
const eas = easFixture();
|
||||
const entries = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport });
|
||||
assert.deepEqual(entries, [
|
||||
{ platform: "android", inputPath: join(root, "inputs", "explore-capture-10-1-android", "report-input.json"), reportPath: join(root, "reports", "explore-review-10-1-android"), artifactUrl: artifactUrl.replace(/20$/, "22") },
|
||||
{ platform: "ios", inputPath: join(root, "inputs", "explore-capture-10-1-ios", "report-input.json"), reportPath: join(root, "reports", "explore-review-10-1-ios"), artifactUrl: artifactUrl.replace(/20$/, "21") },
|
||||
{ platform: "android", target: { id: "android", platform: "android", label: "Android" }, inputPath: join(root, "inputs", "explore-capture-10-1-android", "report-input.json"), reportPath: join(root, "reports", "explore-review-10-1-android"), artifactUrl: artifactUrl.replace(/20$/, "22") },
|
||||
{ platform: "ios", target: { id: "ios", platform: "ios", label: "iOS" }, inputPath: join(root, "inputs", "explore-capture-10-1-ios", "report-input.json"), reportPath: join(root, "reports", "explore-review-10-1-ios"), artifactUrl: artifactUrl.replace(/20$/, "21") },
|
||||
]);
|
||||
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"]);
|
||||
@@ -449,8 +451,8 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
|
||||
assert.equal(eas.captured.alias, "pr-12");
|
||||
assert.equal("EXPLORE_PREVIEW_EXPIRES_AT" in eas.captured.env, false, "a fixture preview does not expire");
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [
|
||||
{ platform: "android", path: "android.zip.enc", changes: 12, device: "Pixel · light + dark" },
|
||||
{ platform: "ios", path: "ios.zip.enc" },
|
||||
{ target: "android", platform: "android", label: "Android", changes: 12, device: "Pixel · light + dark", path: "android.zip.enc" },
|
||||
{ target: "ios", platform: "ios", label: "iOS", path: "ios.zip.enc" },
|
||||
]);
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/report.zip`).map(request => request.url.searchParams.get("platform"));
|
||||
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' bytes are verified");
|
||||
@@ -535,8 +537,9 @@ test("a comparison of two commits deploys the same way and links its report from
|
||||
test("readReportZip reads a review ZIP's platform, run and labels, and rejects anything that is not a report", async t => {
|
||||
const { reportPath } = await exportFixture(t);
|
||||
const zip = await zipReportDirectory(reportPath);
|
||||
const { platform, device: _device, ...summary } = await readReportZip(zip);
|
||||
const { platform, device: _device, target, ...summary } = await readReportZip(zip);
|
||||
assert.ok(["ios", "android"].includes(platform));
|
||||
assert.deepEqual(target, { id: platform, platform, label: platform === "ios" ? "iOS" : "Android" }, "a report from before targets is its platform's target");
|
||||
assert.deepEqual(summary, { kind: "review", repository: pr.repository, runId: "10", base: pr.base.sha, head: pr.head.sha, changes: 0 });
|
||||
|
||||
// GitHub's artifact download lists directories as entries of their own.
|
||||
@@ -568,7 +571,7 @@ test("readReportZip reads a review ZIP's platform, run and labels, and rejects a
|
||||
await assert.rejects(readReportZip(await zipReportDirectory(reportPath)), /not an Explore exploration report/);
|
||||
await writeFile(join(reportPath, "exploration.json"), JSON.stringify({ kind: "explore.exploration-report",
|
||||
exploration: { app: { name: "Acme", bundleId: "com.acme", platform: "android" }, device: { model: "Pixel 9", osVersion: "16" } } }));
|
||||
assert.deepEqual(await readReportZip(await zipReportDirectory(reportPath)), { kind: "exploration", platform: "android", device: "Pixel 9 16" });
|
||||
assert.deepEqual(await readReportZip(await zipReportDirectory(reportPath)), { kind: "exploration", platform: "android", target: { id: "android", platform: "android", label: "Android" }, device: "Pixel 9 16" });
|
||||
});
|
||||
|
||||
test("deployLocalReports hosts one review's platforms behind one link, labelled from each ZIP", async t => {
|
||||
@@ -581,8 +584,8 @@ test("deployLocalReports hosts one review's platforms behind one link, labelled
|
||||
assert.equal(result.owner, "brent-org", "the only account of the login holds the project");
|
||||
assert.equal(result.expiresAt, null);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [
|
||||
{ platform: "ios", path: "ios.zip.enc", changes: 3, device: "iPhone 17 26.5" },
|
||||
{ platform: "android", path: "android.zip.enc" },
|
||||
{ target: "ios", platform: "ios", label: "iOS", changes: 3, device: "iPhone 17 26.5", path: "ios.zip.enc" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "android.zip.enc" },
|
||||
]);
|
||||
await assert.rejects(deployLocalReports({ reports: [{ platform: "ios", zip }, { platform: "ios", zip }], project: "acme-explore", expiresAfterDays: 7, exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run }), error => error.code === "PREVIEW_REPORTS_INVALID");
|
||||
@@ -591,11 +594,11 @@ test("deployLocalReports hosts one review's platforms behind one link, labelled
|
||||
await deployLocalReports({ reports: [{ platform: "android", zip, changes: 1, device: "Pixel #9 <Pro>\n" }], project: "acme-explore", expiresAfterDays: 7, exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.equal(eas.captured.env.EXPLORE_PREVIEW_REPORT, undefined);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ platform: "android", path: "android.zip.enc", changes: 1, device: "Pixel 9 Pro" }]);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", changes: 1, device: "Pixel 9 Pro", path: "android.zip.enc" }]);
|
||||
// eas deploy expands $VARIABLES in that .env, even single-quoted: a label never carries one in, nor a backslash.
|
||||
await deployLocalReports({ reports: [{ platform: "ios", zip, device: "iPhone ${EXPO_TOKEN} $EXPLORE_PREVIEW_KEY \\$ · light + dark" }], project: "acme-explore",
|
||||
expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ platform: "ios", path: "ios.zip.enc", device: "iPhone EXPO_TOKEN EXPLORE_PREVIEW_KEY · light + dark" }]);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "ios", platform: "ios", label: "iOS", device: "iPhone EXPO_TOKEN EXPLORE_PREVIEW_KEY · light + dark", path: "ios.zip.enc" }]);
|
||||
});
|
||||
|
||||
test("an explore:binary report names its platform, so an Android exploration is not served as iOS", async t => {
|
||||
@@ -604,7 +607,7 @@ test("an explore:binary report names its platform, so an Android exploration is
|
||||
const eas = easFixture();
|
||||
await deployExplorationReport({ reportPath, platform: "android", project: "acme-explore", owner: "brent-org", expiresAfterDays: 7, exportPath,
|
||||
environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ platform: "android", path: "android.zip.enc" }]);
|
||||
assert.deepEqual(captureListing(eas.captured.listing), [{ target: "android", platform: "android", label: "Android", path: "android.zip.enc" }]);
|
||||
});
|
||||
|
||||
test("readReportZip stops inflating a report file once it passes the size its header declares", async () => {
|
||||
@@ -647,7 +650,93 @@ test("report:upload checks its reports before it deploys anything", async t => {
|
||||
assert.match(upload("missing.zip").output, /There is no report at missing\.zip/);
|
||||
assert.match(upload("notes.txt").output, /notes\.txt is not an Explore report/);
|
||||
assert.match(upload("one.zip", "--expires-in", "7d", "two.zip").output, /More than one (ios|android) report/, "a value flag between paths is not read as a path");
|
||||
assert.match(upload("one.zip", "other").output, /one\.zip and other are not the same review's platforms/, "another run's report of the other platform");
|
||||
assert.match(upload("one.zip", "other").output, /one\.zip and other are not the same review's (platforms|targets)/, "another run's report of the other platform");
|
||||
assert.match(upload("one.zip", "--alias", "x").output, /Unknown flag for report:upload: --alias/);
|
||||
for (const result of [upload(), upload("one.zip", "two.zip")]) assert.equal(result.status, 1);
|
||||
});
|
||||
|
||||
const TARGETS = [
|
||||
{ id: "iphone", platform: "ios", label: "iPhone 17" },
|
||||
{ id: "duo-closed", platform: "ios", label: "iPhone Duo (closed)" },
|
||||
{ id: "duo-open", platform: "ios", label: "iPhone Duo (open)" },
|
||||
{ id: "android", platform: "android", label: "Android" },
|
||||
];
|
||||
|
||||
/** Rewrites a fixture's report input (and exported review.json) as one target's report of a run with several targets. */
|
||||
async function asTarget(fixturePaths, target) {
|
||||
const input = JSON.parse(await readFile(fixturePaths.inputPath, "utf8"));
|
||||
input.publicReview.runtime = { ...input.publicReview.runtime, platform: target.platform, target, targets: TARGETS };
|
||||
await writeFile(fixturePaths.inputPath, JSON.stringify(input));
|
||||
const report = JSON.parse(await readFile(join(fixturePaths.reportPath, "review.json"), "utf8"));
|
||||
report.review.runtime = { ...report.review.runtime, platform: target.platform, target, targets: TARGETS };
|
||||
await writeFile(join(fixturePaths.reportPath, "review.json"), JSON.stringify(report));
|
||||
return fixturePaths;
|
||||
}
|
||||
|
||||
test("readReportZip names the report's target from review.runtime.target, and ignores one that does not fit", async t => {
|
||||
const { reportPath } = await asTarget(await exportFixture(t), TARGETS[2]);
|
||||
const summary = await readReportZip(await zipReportDirectory(reportPath));
|
||||
assert.deepEqual([summary.platform, summary.target], ["ios", TARGETS[2]]);
|
||||
const report = JSON.parse(await readFile(join(reportPath, "review.json"), "utf8"));
|
||||
for (const target of [{ id: "Bad Id", platform: "ios", label: "x" }, { id: "install-x", platform: "ios", label: "x" }, { id: "pixel", platform: "android", label: "Pixel" }]) {
|
||||
report.review.runtime.target = target;
|
||||
await writeFile(join(reportPath, "review.json"), JSON.stringify(report));
|
||||
assert.deepEqual((await readReportZip(await zipReportDirectory(reportPath))).target, { id: "ios", platform: "ios", label: "iOS" }, target.id);
|
||||
}
|
||||
report.review.runtime.target = { id: "duo-open", platform: "ios", label: "Duo ${HOME} [open] #1" };
|
||||
await writeFile(join(reportPath, "review.json"), JSON.stringify(report));
|
||||
assert.equal((await readReportZip(await zipReportDirectory(reportPath))).target.label, "Duo HOME open 1", "a label is plain text, safe in the sealed .env");
|
||||
});
|
||||
|
||||
test("deployLocalReports hosts four targets, three of them iOS, as <target>.zip.enc selected by ?target=", async t => {
|
||||
const { reportPath, exportPath } = await exportFixture(t);
|
||||
const zip = await zipReportDirectory(reportPath);
|
||||
const eas = easFixture();
|
||||
await deployLocalReports({ reports: TARGETS.map((target, index) => ({ platform: target.platform, target, zip: new Uint8Array([...zip, ...new Array(index).fill(0)]), changes: index })),
|
||||
project: "acme-explore", expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 });
|
||||
assert.deepEqual(captureListing(eas.captured.listing), TARGETS.map((target, index) => ({ target: target.id, platform: target.platform, label: target.label, path: `${target.id}.zip.enc`, changes: index })));
|
||||
const served = eas.requests.filter(request => request.url.pathname === `/p/${eas.captured.env.EXPLORE_PREVIEW_TOKEN}/report.zip`).map(request => request.url.search);
|
||||
assert.deepEqual([...new Set(served)], ["?target=iphone", "?target=duo-closed", "?target=duo-open", "?platform=android"],
|
||||
"a target named after its platform keeps the ?platform= link it always had");
|
||||
for (const reports of [[{ platform: "ios", target: TARGETS[0], zip }, { platform: "ios", target: TARGETS[0], zip }],
|
||||
[{ platform: "ios", target: { id: "Bad", platform: "ios", label: "x" }, zip }],
|
||||
Array.from({ length: 9 }, (_, index) => ({ platform: "ios", target: { id: `t${index}`, platform: "ios", label: "x" }, zip }))]) {
|
||||
await assert.rejects(deployLocalReports({ reports, project: "acme-explore", expiresAfterDays: 7, exportPath, environment: deployEnvironment, transport: eas.transport, run: eas.run }),
|
||||
error => error.code === "PREVIEW_REPORTS_INVALID");
|
||||
}
|
||||
});
|
||||
|
||||
test("ci:deploy pairs target-named artifacts, deploys them in config order, and seals each as its target", async t => {
|
||||
const fixtures = [];
|
||||
for (const target of TARGETS) fixtures.push(await asTarget(await exportFixture(t), target));
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-fanin-targets-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
for (const [index, target] of TARGETS.entries()) {
|
||||
await mkdir(join(root, "inputs", `explore-capture-10-1-${target.id}`), { recursive: true });
|
||||
await cp(fixtures[index].inputPath, join(root, "inputs", `explore-capture-10-1-${target.id}`, "report-input.json"));
|
||||
await cp(fixtures[index].reportPath, join(root, "reports", `explore-review-10-1-${target.id}`), { recursive: true });
|
||||
}
|
||||
const eas = easFixture();
|
||||
const names = { "explore-review-10-1-iphone": 31, "explore-review-10-1-duo-closed": 32, "explore-review-10-1-duo-open": 33, "explore-review-10-1-android": 34 };
|
||||
const transport = async (input, options) => {
|
||||
const url = new URL(input);
|
||||
const name = url.searchParams.get("name");
|
||||
if (url.pathname.endsWith("/actions/runs/10/artifacts") && names[name]) return new Response(JSON.stringify({ artifacts: [{ id: names[name], name }] }), { status: 200 });
|
||||
return eas.transport(input, options);
|
||||
};
|
||||
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 })
|
||||
.catch(error => error);
|
||||
// Publishing each target's comment section after the deployment is the comment code's (publishCiReportComment, which needs
|
||||
// the target to name the artifact); the deployment itself must have been sealed per target either way.
|
||||
assert.deepEqual(captureListing(eas.captured.listing).map(entry => [entry.target, entry.platform, entry.label, entry.path]),
|
||||
TARGETS.map(target => [target.id, target.platform, target.label, `${target.id}.zip.enc`]), String(sealed?.message ?? ""));
|
||||
|
||||
// An artifact named for one target that holds another's report is refused.
|
||||
await rm(join(root, "inputs", "explore-capture-10-1-duo-open"), { recursive: true });
|
||||
await mkdir(join(root, "inputs", "explore-capture-10-1-duo-open"));
|
||||
await cp(fixtures[0].inputPath, join(root, "inputs", "explore-capture-10-1-duo-open", "report-input.json"));
|
||||
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport }),
|
||||
error => error.code === "PREVIEW_REPORTS_INVALID" && /holds the report of iphone/.test(error.message));
|
||||
});
|
||||
@@ -56,7 +56,10 @@ for (const provider of ['expo-router', 'react-navigation']) {
|
||||
const starts = f.requests.slice(before).filter(request => request.args[0] === 'simulator:start');
|
||||
assert.equal(starts.length, 1, 'an exact baseline cache avoids a second EAS allocation');
|
||||
assert.equal(value(starts[0], '--device'), f.config.device.name);
|
||||
assert.equal(value(starts[0], '--build-id'), `repacked-${f.headSha}`);
|
||||
// The session starts empty beside the repack; the head's repacked app is installed through the controller.
|
||||
assert.equal(starts[0].args.includes('--build-id'), false);
|
||||
const installs = f.requests.slice(before).filter(request => request.args[0] === 'install');
|
||||
assert.equal(installs.length, 1);
|
||||
const packaged = await exportCiReport({ inputPath: result.inputPath, outputPath: join(f.root, 'artifact') });
|
||||
const report = JSON.parse(await readFile(join(packaged.outputPath, 'review.json'), 'utf8'));
|
||||
assert.equal(report.kind, 'explore.report');
|
||||
@@ -77,6 +80,12 @@ for (const provider of ['expo-router', 'react-navigation']) {
|
||||
assert.match(f.comments.at(-1), /\[zip\]\(<https:\/\/github\.com\/acme\/example\/actions\/runs\/1234\/artifacts\/900>\)/);
|
||||
assert.match(f.comments.at(-1), /explore-preview\.expo\.app/);
|
||||
assert.doesNotMatch(f.comments.at(-1), /viewer\.example/);
|
||||
// A matrix job's report artifact carries its target id: an unsuffixed artifact is not target duo-open's.
|
||||
const publishAs = selection => publishCiReportComment({ inputPath: result.inputPath,
|
||||
artifactUrl: 'https://github.com/acme/example/actions/runs/1234/artifacts/900', environment: f.environment, transport: f.transport, ...selection });
|
||||
await assert.rejects(publishAs({ target: 'duo-open' }), error => error.code === 'REPORT_ARTIFACT_MISMATCH');
|
||||
await assert.rejects(publishAs({ platform: 'ios' }), error => error.code === 'REPORT_ARTIFACT_MISMATCH', '--platform ios names explore-review-<run>-<attempt>-ios');
|
||||
await assert.rejects(publishAs({ target: 'Duo/../x' }), error => error.code === 'TARGET_INVALID');
|
||||
assert.equal(git(f.baseProject, 'status', '--porcelain'), '');
|
||||
assert.equal(git(f.headProject, 'status', '--porcelain'), '');
|
||||
assert.equal(f.requests.filter(request => request.args[0] === 'simulator:start').length,
|
||||
|
||||
@@ -514,3 +514,77 @@ test('screens whose comparison did not run are counted as not compared, never as
|
||||
assert.match(platformRow(quiet, 'iOS'), /\| 🟩 0 changes · 6m 12s \|/);
|
||||
assert.match(quiet, /\nNo screen changed on the reviewed platforms\.\n/);
|
||||
});
|
||||
|
||||
const duoTargets = [{ id: 'iphone', platform: 'ios', label: 'iPhone 17' }, { id: 'duo-closed', platform: 'ios', label: 'iPhone Duo (closed)' },
|
||||
{ id: 'duo-open', platform: 'ios', label: 'iPhone Duo (open)' }, { id: 'android', platform: 'android', label: 'Pixel 7' }];
|
||||
const targetState = (target, overrides = {}) => state({ artifactOnly: true, target, targets: duoTargets,
|
||||
build: { ...state().build, platform: target.platform }, runtime: { ...state().runtime, platform: target.platform, deviceModel: target.label }, ...overrides });
|
||||
|
||||
test('a config without targets writes the same records and comment as before targets: target ios and android are the platforms', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const perPlatform = [{ id: 'ios', platform: 'ios', label: 'iOS' }, { id: 'android', platform: 'android', label: 'Android' }];
|
||||
const android = overrides => state({ artifactOnly: true, build: { ...state().build, platform: 'android' }, runtime: { ...state().runtime, platform: 'android', deviceModel: 'Pixel 9' }, ...overrides });
|
||||
const before = platformSectionMerge(android(), 'android').merge(platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined));
|
||||
const after = platformSectionMerge(android({ target: perPlatform[1], targets: perPlatform }), 'android')
|
||||
.merge(platformSectionMerge(state({ artifactOnly: true, target: perPlatform[0], targets: perPlatform }), 'ios').merge(undefined));
|
||||
assert.equal(after, before, 'byte-identical comment, record lines included');
|
||||
const record = platformRecordOf(state({ target: perPlatform[0], targets: perPlatform }));
|
||||
assert.deepEqual(Object.keys(record).slice(0, 3), ['v', 'platform', 'runId'], 'no target, label or order fields');
|
||||
// A writer that knows its target only from the CLI flag (the state names none) keys its record the same way.
|
||||
assert.equal(platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined), renderPublicComment(state({ artifactOnly: true, target: perPlatform[0] })));
|
||||
assert.deepEqual(Object.keys(readCommentRecords(after).current), ['ios', 'android']);
|
||||
});
|
||||
|
||||
test('several targets share a comment: one row each in config order, labelled by target, keyed by id in the records and history', async () => {
|
||||
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const [iphone, closed, open, android] = duoTargets;
|
||||
// Report jobs finish in any order; the comment follows config order.
|
||||
let body;
|
||||
for (const target of [android, open, iphone]) body = platformSectionMerge(targetState(target), target.id).merge(body);
|
||||
body = platformSectionMerge(targetState(closed, { phase: 'capturing', review: undefined, evidence: undefined,
|
||||
capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 1 }, baseFromCache: false, current: 'head' } }), 'duo-closed').merge(body);
|
||||
assert.deepEqual([...body.matchAll(/^<!-- expo-explore-record:([a-z0-9-]+):/gm)].map(match => match[1]), ['iphone', 'duo-closed', 'duo-open', 'android']);
|
||||
const records = readCommentRecords(body).current;
|
||||
assert.deepEqual(Object.keys(records).sort(), ['android', 'duo-closed', 'duo-open', 'iphone']);
|
||||
assert.deepEqual([records['duo-open'].platform, records['duo-open'].target, records['duo-open'].label, records['duo-open'].order], ['ios', 'duo-open', 'iPhone Duo (open)', 2]);
|
||||
assert.deepEqual([records.android.platform, records.android.target, records.android.label, records.android.order], ['android', undefined, 'Pixel 7', 3]);
|
||||
const lines = body.split('\n'), header = lines.indexOf('| | Device | Result | Report |');
|
||||
assert.deepEqual(lines.slice(header + 2, lines.indexOf('', header)).map(line => line.split(' | ')[0]),
|
||||
['| iPhone 17', '| iPhone Duo \\(closed\\)', '| iPhone Duo \\(open\\)', '| Pixel 7']);
|
||||
assert.match(body, /^### Explore review · \[iPhone 17 report\]\(<[^>]+>\) · \[iPhone Duo \\\(open\\\) report\]\(<[^>]+>\) · \[Pixel 7 report\]\(<[^>]+>\)$/m);
|
||||
assert.match(body, /\*\*Changes\*\* · 3 screens · a screen is listed once, with a link per device\n/);
|
||||
assert.match(body, /\n- `\/cats\/care-guide` — Added \/cats\/care\\-guide screen · \[iPhone 17\]\(<[^>]+>\) · \[iPhone Duo \\\(open\\\)\]\(<[^>]+>\) · \[Pixel 7\]\(<[^>]+>\)\n/);
|
||||
assert.match(body, /\| Check \| iPhone 17 \| iPhone Duo \\\(closed\\\) \| iPhone Duo \\\(open\\\) \| Pixel 7 \|\n\|---\|---\|---\|---\|---\|/);
|
||||
assert.deepEqual(summaries(body).at(-1), 'Validation · iPhone 17 🟩 6/6 captured · iPhone Duo \\(closed\\) ⏳ in progress · iPhone Duo \\(open\\) 🟩 6/6 captured · Pixel 7 🟩 6/6 captured');
|
||||
// A newer run moves them all into history, still labelled and ordered by target.
|
||||
const nextHead = 'd'.repeat(40);
|
||||
const next = platformSectionMerge(targetState(open, { phase: 'capturing', review: undefined, evidence: undefined, pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
links: viewerLinks({ repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }), 'duo-open').merge(body);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).current), ['duo-open']);
|
||||
const history = readCommentRecords(next).history;
|
||||
assert.deepEqual(Object.keys(history[0].platforms).sort(), ['android', 'duo-closed', 'duo-open', 'iphone']);
|
||||
assert.match(next, /\n- \[bbbbbbbb\]\(<[^>]+>\) · iPhone 17 🟩 3 changes \(.*?\) · iPhone Duo \\\(closed\\\) ⏳ did not finish \(.*?\) · iPhone Duo \\\(open\\\) 🟩 3 changes \(.*?\) · Pixel 7 🟩 3 changes /);
|
||||
});
|
||||
|
||||
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');
|
||||
const old = platformSectionMerge(state({ artifactOnly: true }), 'ios').merge(undefined);
|
||||
// A run with targets follows a per-platform run: the iOS run lands in history under its old key and label.
|
||||
const nextHead = 'd'.repeat(40);
|
||||
const next = platformSectionMerge(targetState(duoTargets[0], { pullRequest: { ...pullRequest, head: { ref: 'feature', sha: nextHead } },
|
||||
links: viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/43/artifacts/7655', repository: pullRequest.repository, headSha: nextHead, runId: '43', runAttempt: '1', configPath: '.expo-explore/config.yaml' }) }), 'iphone').merge(old);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).current), ['iphone']);
|
||||
assert.deepEqual(Object.keys(readCommentRecords(next).history[0].platforms), ['ios']);
|
||||
assert.match(next, /\n- \[bbbbbbbb\]\(<[^>]+>\) · iOS 🟩 3 changes /);
|
||||
const valid = platformRecordOf(targetState(duoTargets[2]));
|
||||
const line = (key, record) => `<!-- expo-explore-record:${key}:${encodeRecordPayload(record)} -->`;
|
||||
const parse = (...lines) => Object.keys(readCommentRecords([CI_COMMENT_MARKER, ...lines].join('\n')).current);
|
||||
assert.deepEqual(parse(line('duo-open', valid)), ['duo-open']);
|
||||
assert.deepEqual(parse(line('ios', valid)), [], 'the line names the record it carries');
|
||||
assert.deepEqual(parse(line('base', { ...valid, target: 'base' })), [], 'reserved ids are not targets');
|
||||
assert.deepEqual(parse(line('duo-open', { ...valid, label: 'x'.repeat(81) })), []);
|
||||
assert.deepEqual(parse(line('duo-open', { ...valid, order: 8 })), []);
|
||||
const many = Array.from({ length: 10 }, (_, index) => line(`t${index}`, { ...valid, target: `t${index}` }));
|
||||
assert.equal(parse(...many).length, 8, 'a comment holds at most one record per configurable target');
|
||||
});
|
||||
@@ -800,3 +800,28 @@ test("launch evidence projects as a Launch screen per appearance with a splash c
|
||||
assert.equal(surface.visual.mismatchPercentage, 12.5);
|
||||
assert.equal(surface.noVisibleChange, false);
|
||||
});
|
||||
|
||||
test("a target's review carries its target and the run's targets into the map; a review from before targets carries neither", () => {
|
||||
const targets = [
|
||||
{ id: "iphone", platform: "ios", label: "iPhone 17" },
|
||||
{ id: "duo-open", platform: "ios", label: "iPhone Duo (open)" },
|
||||
{ id: "android", platform: "android", label: "Android" },
|
||||
];
|
||||
const review = fixture();
|
||||
review.runtime = { ...review.runtime, platform: "ios", platforms: ["ios", "android"], target: targets[1], targets };
|
||||
const workspace = publicReviewToWorkspace(review);
|
||||
const { baseline, current } = workspaceSides(workspace);
|
||||
for (const map of [baseline.map, current.map]) {
|
||||
assert.deepEqual(map.run.target, targets[1]);
|
||||
assert.deepEqual(map.run.targets, targets);
|
||||
assert.deepEqual(map.run.platforms, ["ios", "android"]);
|
||||
}
|
||||
const old = workspaceSides(publicReviewToWorkspace(fixture())).current.map.run;
|
||||
assert.equal(old.target, undefined);
|
||||
assert.equal(old.targets, undefined);
|
||||
const odd = fixture();
|
||||
odd.runtime = { ...odd.runtime, target: { id: "Not An Id", platform: "ios", label: "x" }, targets: [targets[0], { id: "x", platform: "web" }] };
|
||||
const oddRun = workspaceSides(publicReviewToWorkspace(odd)).current.map.run;
|
||||
assert.equal(oddRun.target, undefined, "a malformed target is dropped, and the report reads as its platform's");
|
||||
assert.equal(oddRun.targets, undefined);
|
||||
});
|
||||
@@ -206,3 +206,36 @@ test('a screen accessibility-only on one platform and visibly modified on the ot
|
||||
assert.equal(both.modified, alone.modified + 1, 'the Android visual change is what the run counts');
|
||||
assert.deepEqual((await describeReports([android, ios])).changes, both);
|
||||
});
|
||||
|
||||
test('a run with several targets of one platform keeps a ZIP per target, in config order, and only valid ids name them', async t => {
|
||||
const environment = await cache(t);
|
||||
const dir = await mkdtemp(join(tmpdir(), 'explore-saved-targets-'));
|
||||
t.after(() => rm(dir, { recursive: true, force: true }));
|
||||
await writeFile(join(dir, 'a.zip'), review);
|
||||
spawnSync('unzip', ['-q', '-o', join(dir, 'a.zip'), '-d', join(dir, 'report')]);
|
||||
const targets = [{ id: 'phone', platform: 'ios', label: 'iPhone 17' }, { id: 'duo-open', platform: 'ios', label: 'iPhone Duo (open)' }];
|
||||
const variant = async target => {
|
||||
const json = JSON.parse(await readFile(join(dir, 'report', 'review.json'), 'utf8'));
|
||||
Object.assign(json.review.runtime, { target, targets });
|
||||
const copy = join(dir, target.id);
|
||||
await mkdir(copy);
|
||||
await writeFile(join(copy, 'review.json'), JSON.stringify(json));
|
||||
spawnSync('cp', ['-R', join(dir, 'report', 'assets'), join(copy, 'assets')]);
|
||||
return zipReportDirectory(copy);
|
||||
};
|
||||
const [phone, duo] = await Promise.all(targets.map(variant));
|
||||
// Saved one at a time, in the opposite order: the run still lists them in config order.
|
||||
await saveRun([{ platform: 'ios', target: targets[1], zip: duo }], {}, environment);
|
||||
const run = await saveRun([{ platform: 'ios', target: targets[0], zip: phone }], {}, environment);
|
||||
assert.deepEqual(run.platforms, ['ios']);
|
||||
assert.deepEqual(run.targets, targets);
|
||||
assert.deepEqual((await readdir(join(savedRunsDirectory(environment), run.id))).sort(), ['duo-open.zip', 'phone.zip', 'run.json']);
|
||||
assert.deepEqual((await readSavedReports(run, environment)).map(report => [report.target.id, report.zip.byteLength]), [['phone', phone.byteLength], ['duo-open', duo.byteLength]]);
|
||||
assert.deepEqual((await readReportZip(duo)).target, targets[1]);
|
||||
const file = join(savedRunsDirectory(environment), run.id, 'run.json');
|
||||
const saved = JSON.parse(await readFile(file, 'utf8'));
|
||||
for (const id of ['../escape', 'Phone', 'base']) {
|
||||
await writeFile(file, JSON.stringify({ ...saved, targets: [{ ...targets[0], id }] }));
|
||||
assert.deepEqual(await listSavedRuns(environment), [], id);
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,61 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtemp, rm } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
import { abandonSharedBuilds, sharedBuild } from "../../dist/capture/shared-build.js";
|
||||
|
||||
const key = { platform: "ios", easProfile: "explore", bundleId: "com.example.app", gitCommit: "a".repeat(40), repack: "local", local: true, routes: ["/", "/settings"] };
|
||||
|
||||
async function scratch(t) {
|
||||
const directory = await mkdtemp(join(tmpdir(), "explore-shared-build-"));
|
||||
t.after(() => rm(directory, { recursive: true, force: true }));
|
||||
return directory;
|
||||
}
|
||||
|
||||
test("targets of one commit share one build: the first builds it, the others wait for its result", async t => {
|
||||
const directory = await scratch(t);
|
||||
let builds = 0, waited = 0;
|
||||
let finish, started;
|
||||
const building = new Promise(resolve => { started = resolve; });
|
||||
const owner = sharedBuild({ directory, key, appName: "App.app", owner: "/work/phone/head",
|
||||
build: () => new Promise(resolve => { builds += 1; finish = () => resolve({ buildId: "native", app: "App.app" }); started(); }) });
|
||||
// The first to claim the build's folder builds it; the second capture starts once it has.
|
||||
await building;
|
||||
// Routes are compared sorted, so the same set in another order is the same build.
|
||||
const waiter = sharedBuild({ directory, key: { ...key, routes: ["/settings", "/"] }, appName: "App.app", owner: "/work/duo/head",
|
||||
build: async () => { builds += 1; return { buildId: "other", app: "Other.app" }; }, waiting: () => { waited += 1; } });
|
||||
finish();
|
||||
assert.deepEqual(await owner, { buildId: "native", app: "App.app" });
|
||||
assert.deepEqual(await waiter, { buildId: "native", app: "App.app" });
|
||||
assert.deepEqual([builds, waited], [1, 1]);
|
||||
});
|
||||
|
||||
test("a shared build that fails fails the targets waiting on it", async t => {
|
||||
const directory = await scratch(t);
|
||||
let started;
|
||||
const building = new Promise(resolve => { started = resolve; });
|
||||
const owner = sharedBuild({ directory, key, appName: "App.app", build: async () => { started(); await new Promise(resolve => setTimeout(resolve, 20)); throw new Error("repack-app exited with status 1"); } });
|
||||
await building;
|
||||
const waiter = sharedBuild({ directory, key, appName: "App.app", build: async () => assert.fail("only the owner builds") });
|
||||
await assert.rejects(owner, /repack-app exited/);
|
||||
await assert.rejects(waiter, error => error.code === "CAPTURE_BUILD_FAILED" && /The shared build failed: repack-app exited/.test(error.message));
|
||||
});
|
||||
|
||||
test("a capture that ends without finishing its shared build releases the targets waiting on it", async t => {
|
||||
const directory = await scratch(t);
|
||||
// The owner's worker exits mid-build: its build never resolves and writes nothing.
|
||||
let started;
|
||||
const building = new Promise(resolve => { started = resolve; });
|
||||
void sharedBuild({ directory, key, appName: "App.app", owner: "/work/phone/head", build: () => { started(); return new Promise(() => {}); } });
|
||||
await building;
|
||||
const waiter = sharedBuild({ directory, key, appName: "App.app", owner: "/work/duo/head", build: async () => assert.fail("only the owner builds") });
|
||||
const outcome = waiter.then(() => "resolved", error => error);
|
||||
// Another target's failure leaves its builds alone; only the dead capture's are failed.
|
||||
await abandonSharedBuilds(directory, owner => owner.startsWith("/work/duo/"), "duo failed");
|
||||
assert.equal(await Promise.race([outcome, new Promise(resolve => setTimeout(() => resolve("waiting"), 2_500))]), "waiting");
|
||||
await abandonSharedBuilds(directory, owner => owner.startsWith("/work/phone/"), "CAPTURE_WORKER_EXITED");
|
||||
const error = await outcome;
|
||||
assert.equal(error.code, "CAPTURE_BUILD_FAILED");
|
||||
assert.match(error.message, /the capture building it stopped \(CAPTURE_WORKER_EXITED\)/);
|
||||
});
|
||||
@@ -89,3 +89,14 @@ test("map semantic validation rejects dangling, unsafe, and duplicate source lin
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
test("map schema accepts a run's capture target and its sibling targets", () => {
|
||||
const map = fixture();
|
||||
const targets = [{ id: "iphone", platform: "ios", label: "iPhone 17" }, { id: "duo-open", platform: "ios", label: "iPhone Duo (open)" }];
|
||||
map.run = { ...map.run, target: targets[1], targets };
|
||||
assert.equal(validate(map), true, JSON.stringify(validate.errors));
|
||||
for (const target of [{ id: "Duo", platform: "ios", label: "x" }, { id: "duo", platform: "web", label: "x" }, { id: "duo", platform: "ios" }]) {
|
||||
assert.equal(validate({ ...map, run: { ...map.run, target } }), false, JSON.stringify(target));
|
||||
}
|
||||
assert.equal(validate({ ...map, run: { ...map.run, targets: [targets[0]] } }), false, "one target is no sibling");
|
||||
});
|
||||
@@ -91,3 +91,21 @@ test('matrix jobs add platform to the Viewer link and nothing else changes', asy
|
||||
android.searchParams.delete('platform');
|
||||
assert.equal(android.href, plain.href);
|
||||
});
|
||||
|
||||
test("a target's links select it with ?target=, and a target named after its platform keeps ?platform=", async () => {
|
||||
const { viewerLinks, previewLinks } = await import('../../dist/report/viewer-links.js');
|
||||
const token = "abcdefghijklmnopqrstuvwxyz234567";
|
||||
const page = `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`;
|
||||
assert.equal(previewLinks(page, null, "ios").open, `${page}?platform=ios`, "byte-identical to links from before targets");
|
||||
assert.equal(previewLinks(page, null, "android").focus("modified"), `${page}?platform=android&focus=modified&inspect=diff`);
|
||||
assert.equal(previewLinks(page, null, "duo-open").open, `${page}?target=duo-open`);
|
||||
assert.equal(previewLinks(page, null, "duo-open").surface("home"), `${page}?target=duo-open&view=compare&screen=home`);
|
||||
for (const bad of ["Duo", "report", "install-x", "a".repeat(33), "duo open"]) assert.throws(() => previewLinks(page, null, bad), /target id/, bad);
|
||||
const input = { repository: 'expo/explore-playground', headSha: 'b'.repeat(40), runId: '42', runAttempt: '1', configPath: '.expo-explore/config.yaml',
|
||||
artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/42/artifacts/7654' };
|
||||
const duo = new URL(viewerLinks({ ...input, platform: "ios", target: "duo-closed" }).viewer.open);
|
||||
assert.equal(duo.searchParams.get('target'), 'duo-closed', "the target wins over its platform");
|
||||
assert.equal(duo.searchParams.get('platform'), null);
|
||||
assert.equal(viewerLinks({ ...input, target: "ios" }).viewer.open, viewerLinks({ ...input, platform: "ios" }).viewer.open);
|
||||
assert.throws(() => viewerLinks({ ...input, target: "Bad" }), /target id/);
|
||||
});
|
||||
@@ -33,7 +33,7 @@ async function authorize(t, { pr = samplePr(), permission = "write", number = "9
|
||||
}
|
||||
|
||||
test("the review workflow resolves and authorizes the PR with ci:pr from the installed release, in both jobs that need it", () => {
|
||||
for (const job of ["platforms", "capture"]) {
|
||||
for (const job of ["targets", "capture"]) {
|
||||
const step = workflow.jobs[job].steps.find(step => step.id === "pr");
|
||||
assert.match(step.run, /cli\.js" ci:pr --pr "\$PR_NUMBER"/);
|
||||
assert.equal(step.env.GITHUB_TOKEN, "${{ github.token }}");
|
||||
@@ -90,6 +90,31 @@ 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 is named after its id; only target ios also reuses the unsuffixed name", async () => {
|
||||
const lookups = async target => {
|
||||
const names = [];
|
||||
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") { names.push(url.searchParams.get("name")); return Response.json({ artifacts: [] }); }
|
||||
throw new Error(`unexpected request ${url}`);
|
||||
};
|
||||
assert.equal(await findBaselineArtifact({ sha: "a".repeat(40), ...target, environment, transport }), undefined);
|
||||
return names;
|
||||
};
|
||||
const sha = "a".repeat(40);
|
||||
assert.deepEqual(await lookups({ target: "duo-open" }), [`explore-baseline-${sha}-duo-open`]);
|
||||
assert.deepEqual(await lookups({ target: "iphone" }), [`explore-baseline-${sha}-iphone`], "an iOS target other than ios never takes the old unsuffixed baseline");
|
||||
assert.deepEqual(await lookups({ target: "android" }), [`explore-baseline-${sha}-android`]);
|
||||
assert.deepEqual(await lookups({ platform: "android" }), [`explore-baseline-${sha}-android`], "--platform still names the target of that id");
|
||||
assert.deepEqual(await lookups({ target: "ios" }), [`explore-baseline-${sha}-ios`, `explore-baseline-${sha}`]);
|
||||
assert.deepEqual(await lookups({}), [`explore-baseline-${sha}-ios`, `explore-baseline-${sha}`]);
|
||||
for (const target of ["Duo", "base", "install-x", "a/b", "-x"]) {
|
||||
await assert.rejects(findBaselineArtifact({ sha, target, environment, transport: async () => { throw new Error("no request"); } }), error => error.code === "TARGET_INVALID", target);
|
||||
}
|
||||
});
|
||||
|
||||
test("a failed baseline lookup is a warning and no baseline, never an error a failure comment could blame", async () => {
|
||||
const outage = async () => new Response("bad gateway", { status: 502 });
|
||||
const result = await findOptionalBaseline({ sha: "a".repeat(40), platform: "ios", environment, transport: outage });
|
||||
@@ -234,6 +259,44 @@ test("a failed platform joins the other platform's row in a multi-platform comme
|
||||
assert.doesNotMatch(whole.body, /\| iOS \|/);
|
||||
});
|
||||
|
||||
test("a failed target is named by its artifact and keeps the label and config order its capture record posted", async t => {
|
||||
const { renderPublicComment } = await import("../../dist/report/pr-comment-body.js");
|
||||
const { locateFailureDiagnostic } = await import("../../dist/report/failure-comment.js");
|
||||
const { viewerLinks } = await import("../../dist/report/viewer-links.js");
|
||||
const links = viewerLinks({ repository: "acme/app", headSha: "b".repeat(40), runId: "1234", runAttempt: "1", configPath: ".expo-explore/config.yaml" });
|
||||
const pr = samplePr();
|
||||
const targets = [{ id: "iphone", platform: "ios", label: "iPhone 17" }, { id: "duo-closed", platform: "ios", label: "iPhone Duo (closed)" },
|
||||
{ id: "duo-open", platform: "ios", label: "iPhone Duo (open)" }, { id: "android", platform: "android", label: "Pixel 7" }];
|
||||
const capturing = target => ({ phase: "capturing", mode: "changes", executionMode: "deterministic", configPath: ".expo-explore/config.yaml",
|
||||
pullRequest: { repositoryId: "12", repository: "acme/app", number: 91, title: "PR", url: pr.html_url, base: { ref: "main", sha: "a".repeat(40) }, head: { ref: "feature/settings", sha: "b".repeat(40) } },
|
||||
links, startedAt: Date.now(), updatedAt: Date.now(), artifactOnly: true, build: { platform: target.platform, easProfile: "x" }, target, targets,
|
||||
capture: { planned: { base: 2, head: 2 }, done: { base: 2, head: 1 }, baseFromCache: false, current: "head" } });
|
||||
let existing;
|
||||
for (const target of [targets[3], targets[2], targets[0]]) existing = renderPublicComment(capturing(target), existing);
|
||||
const [write] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "duo-open", comments: [{ id: 7, user: { login: "github-actions[bot]" }, body: existing }] });
|
||||
assert.equal(write.comment_id, 7);
|
||||
assert.match(write.body, /^<!-- expo-explore-record:duo-open:/m);
|
||||
const lines = write.body.split("\n"), header = lines.indexOf("| | Device | Result | Report |");
|
||||
const rows = lines.slice(header + 2, lines.indexOf("", header));
|
||||
assert.deepEqual(rows.map(line => line.split(" | ")[0].slice(2)), ["iPhone 17", "iPhone Duo \\(open\\)", "Pixel 7"], "config order, each target's own label");
|
||||
assert.match(write.body, /\| iPhone Duo \\\(open\\\) \| [^|]*\| 🟥 failed · capture\\-head \|/);
|
||||
// A target the comment has not seen yet is labelled by its id.
|
||||
const [fresh] = await reportFailure(t, { capture: sampleDiagnostic(), platform: "duo-closed" });
|
||||
assert.match(fresh.body, /^<!-- expo-explore-record:duo-closed:/m);
|
||||
assert.match(fresh.body, /\| duo\\-closed \| [^|]*\| 🟥 failed/);
|
||||
// Artifact directories: any valid id, never a reserved or malformed one.
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-failure-targets-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
for (const name of ["explore-diagnostics-1234-1-base", "explore-diagnostics-1234-1-Duo", "explore-diagnostics-1234-1-pixel-7"]) {
|
||||
await mkdir(join(root, "capture", name, "explore-diagnostics"), { recursive: true });
|
||||
await writeFile(join(root, "capture", name, "explore-diagnostics", "error.json"), JSON.stringify(sampleDiagnostic()));
|
||||
}
|
||||
const located = await locateFailureDiagnostic(root);
|
||||
assert.equal(located.target, "pixel-7");
|
||||
assert.equal(located.platform, undefined);
|
||||
assert.equal(located.diagnostic.code, "APP_INPUT_MISSING");
|
||||
});
|
||||
|
||||
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";
|
||||
|
||||
@@ -25,7 +25,7 @@ The central host reads no environment variables and holds no secrets. A preview
|
||||
A hosted preview is one immutable EAS Hosting deployment per review, in the reviewed application's own EAS account, that opens the report without a download. Its export (`npm run export:preview`, written to `dist-preview/`) holds the identical staged Viewer under `/viewer/` and three API routes:
|
||||
|
||||
- `/p/<token>` serves the Viewer shell for exactly one 160-bit token (32 lowercase base32 characters) to requests that accept HTML; the shell's `#root` holds a text index of the report (title, counts, API links) until the Viewer renders, and a `Link` header names the JSON and Markdown alternates. Requests that do not prefer HTML (`Accept: */*`, `text/markdown`, `application/json`) get the same index as Markdown, so an agent handed the link finds the API by itself.
|
||||
- `/p/<token>/report.zip` fetches the encrypted report from this deployment's own static files, decrypts it, and streams the ZIP to the Viewer, which verifies and opens it exactly like a dropped file. `/p/<token>/reports.json` lists the platforms a multi-platform deployment serves; `?platform=` selects one on every other route.
|
||||
- `/p/<token>/report.zip` fetches the encrypted report from this deployment's own static files, decrypts it, and streams the ZIP to the Viewer, which verifies and opens it exactly like a dropped file. `/p/<token>/reports.json` lists the capture targets (up to 8, each with its platform and label) a multi-target deployment serves; `?target=<id>` selects one on every other route, and `?platform=<p>`, from links before targets, selects the target named `<p>`, else the first of that platform.
|
||||
- `/p/<token>/llms.txt` is the Markdown index at a fixed path, and `/p/<token>/api/v1/...` is the read-only agent API (`src/server/agent-api.ts`): summary, `/screens[?status=]`, `/screens/<id>`, `/transitions`, and for exploration reports `/journeys`, `/gaps`, `/frontier`, `/assets/<sha256>`, `/raw`, with `?limit=`/`?cursor=` paging (50 default, 200 max). The Worker decrypts and parses the archive once per isolate (`src/server/report-zip.ts` reads the stored PNGs and the deflated report JSON) and answers from memory after that.
|
||||
- `/` and every other path, token, or method answer the same `404 Not found`, so a response never confirms that a deployment or token exists. After the sealed expiry the exact token still opens the Viewer shell for browsers, and every report route, including the Markdown index and the API, answers `410` with the expiry instant so the Viewer and agents can say the link expired.
|
||||
|
||||
|
||||
@@ -17,40 +17,58 @@ export type PreviewEnvironment = {
|
||||
/** Absolute path of the encrypted report inside this deployment, e.g. /_report/<id>/report.zip.enc (single-report deployments). */
|
||||
EXPLORE_PREVIEW_REPORT?: string | undefined;
|
||||
/**
|
||||
* JSON, one entry per platform in the order the review lists them:
|
||||
* `[{"platform":"ios","path":"/_report/<id>/ios.zip.enc","changes":3,"device":"iPhone 17 Pro 26.0"}]`.
|
||||
* Set instead of EXPLORE_PREVIEW_REPORT by deployments that serve several platforms' reports.
|
||||
* JSON, one entry per capture target in config order:
|
||||
* `[{"target":"duo-open","platform":"ios","label":"iPhone Duo (open)","path":"/_report/<id>/duo-open.zip.enc","changes":3,"device":"iPhone Duo 26.0"}]`.
|
||||
* Deployments from before targets list `{"platform":"ios","path":"/_report/<id>/ios.zip.enc",…}`: the target is the platform.
|
||||
* Set instead of EXPLORE_PREVIEW_REPORT by deployments that serve several reports (or one that is not iOS).
|
||||
*/
|
||||
EXPLORE_PREVIEW_REPORTS?: string | undefined;
|
||||
};
|
||||
|
||||
export type PreviewPlatform = "ios" | "android";
|
||||
export type PreviewReport = { platform: PreviewPlatform; path: string; changes?: number; device?: string };
|
||||
/** `target` names the report (and its file, `<target>.zip.enc`); `platform` is the device's. */
|
||||
export type PreviewReport = { target: string; platform: PreviewPlatform; label?: string; path: string; changes?: number; device?: string };
|
||||
export type PreviewConfig = { token: string; key: Uint8Array<ArrayBuffer>; expiresAt: number | null; reports: PreviewReport[] };
|
||||
|
||||
export const PREVIEW_TOKEN = /^[a-z2-7]{32}$/;
|
||||
const REPORT_PATH = /^\/_report\/[a-z2-7]{16,64}\/(?:report|ios|android)\.zip\.enc$/;
|
||||
/** A capture target id, as the CLI's isTargetId accepts it: the Worker does not bundle the config reader. */
|
||||
const TARGET_ID = /^[a-z][a-z0-9-]{0,31}$/;
|
||||
export function isPreviewTargetId(value: unknown): value is string {
|
||||
return typeof value === "string" && TARGET_ID.test(value) && !["base", "head", "report"].includes(value) && !value.startsWith("install-");
|
||||
}
|
||||
const REPORT_PATH = /^\/_report\/[a-z2-7]{16,64}\/(report|[a-z][a-z0-9-]{0,31})\.zip\.enc$/;
|
||||
const PLATFORMS: readonly PreviewPlatform[] = ["ios", "android"];
|
||||
/** As many targets as a config may name. */
|
||||
export const MAX_PREVIEW_REPORTS = 8;
|
||||
const PLAIN_TEXT = /[\u0000-\u001f\u007f<>[\]]/;
|
||||
|
||||
/** The report list, strictly shaped: unknown platforms, duplicates, odd paths, or extra keys reject the whole configuration. */
|
||||
/**
|
||||
* The report list, strictly shaped: an unknown platform, an invalid or repeated target, a path that is not
|
||||
* `<target>.zip.enc`, an odd label or device, or extra keys reject the whole configuration.
|
||||
*/
|
||||
function parseReports(env: PreviewEnvironment): PreviewReport[] | undefined {
|
||||
if (env.EXPLORE_PREVIEW_REPORTS === undefined) {
|
||||
const reportPath = env.EXPLORE_PREVIEW_REPORT ?? "";
|
||||
return REPORT_PATH.test(reportPath) ? [{ platform: "ios", path: reportPath }] : undefined;
|
||||
return REPORT_PATH.test(reportPath) ? [{ target: "ios", platform: "ios", path: reportPath }] : undefined;
|
||||
}
|
||||
if (env.EXPLORE_PREVIEW_REPORT !== undefined || env.EXPLORE_PREVIEW_REPORTS.length > 4096) return undefined;
|
||||
if (env.EXPLORE_PREVIEW_REPORT !== undefined || env.EXPLORE_PREVIEW_REPORTS.length > 8192) return undefined;
|
||||
let parsed: unknown;
|
||||
try { parsed = JSON.parse(env.EXPLORE_PREVIEW_REPORTS); } catch { return undefined; }
|
||||
if (!Array.isArray(parsed) || parsed.length === 0 || parsed.length > PLATFORMS.length) return undefined;
|
||||
if (!Array.isArray(parsed) || parsed.length === 0 || parsed.length > MAX_PREVIEW_REPORTS) return undefined;
|
||||
const reports: PreviewReport[] = [];
|
||||
for (const entry of parsed as unknown[]) {
|
||||
if (typeof entry !== "object" || entry === null || Array.isArray(entry)) return undefined;
|
||||
const { platform, path, changes, device, ...rest } = entry as Record<string, unknown>;
|
||||
if (Object.keys(rest).length || !PLATFORMS.includes(platform as PreviewPlatform) || typeof path !== "string" || !REPORT_PATH.test(path)) return undefined;
|
||||
const { platform, path, changes, device, label, ...rest } = entry as Record<string, unknown>;
|
||||
// Listings from before targets name each report by its platform.
|
||||
const { target = platform, ...extra } = rest;
|
||||
if (Object.keys(extra).length || !PLATFORMS.includes(platform as PreviewPlatform) || !isPreviewTargetId(target)) return undefined;
|
||||
if (typeof path !== "string" || REPORT_PATH.exec(path)?.[1] !== target) return undefined;
|
||||
if (changes !== undefined && (typeof changes !== "number" || !Number.isInteger(changes) || changes < 0 || changes > 100_000)) return undefined;
|
||||
if (device !== undefined && (typeof device !== "string" || device.length > 120 || /[\u0000-\u001f\u007f<>]/.test(device))) return undefined;
|
||||
if (reports.some(report => report.platform === platform)) return undefined;
|
||||
reports.push({ platform: platform as PreviewPlatform, path, ...(changes === undefined ? {} : { changes }), ...(device === undefined ? {} : { device }) });
|
||||
if (device !== undefined && (typeof device !== "string" || device.length > 120 || PLAIN_TEXT.test(device))) return undefined;
|
||||
if (label !== undefined && (typeof label !== "string" || !label.trim() || label.length > 80 || PLAIN_TEXT.test(label))) return undefined;
|
||||
if (reports.some(report => report.target === target)) return undefined;
|
||||
reports.push({ target, platform: platform as PreviewPlatform, ...(label === undefined ? {} : { label }), path,
|
||||
...(changes === undefined ? {} : { changes }), ...(device === undefined ? {} : { device }) });
|
||||
}
|
||||
return reports;
|
||||
}
|
||||
@@ -125,8 +143,8 @@ const reportCache = new Map<string, Promise<LoadedReport | undefined>>();
|
||||
* `GET /p/<token>` serves the Viewer shell to browsers and the report's Markdown index to anything
|
||||
* that does not ask for HTML (agents fetch with `Accept: text/markdown` or `*/*`); the shell itself
|
||||
* carries that index as text inside `#root` until the Viewer hydrates, and a `Link` header names the
|
||||
* JSON API. `GET /p/<token>/report.zip` streams the decrypted report (`?platform=` selects one of
|
||||
* several; the first listed otherwise), `GET /p/<token>/reports.json` lists the platforms the
|
||||
* JSON API. `GET /p/<token>/report.zip` streams the decrypted report (`?target=`, or `?platform=` in older
|
||||
* links, selects one of several; the first listed otherwise), `GET /p/<token>/reports.json` lists the targets the
|
||||
* deployment serves, `GET /p/<token>/llms.txt` is the Markdown index, and `GET /p/<token>/api/v1/...`
|
||||
* answers the agent API (see agent-api.ts). Every other method, path, or token is an identical 404,
|
||||
* so the response never confirms that a deployment or token exists. After the sealed expiry the exact
|
||||
@@ -183,16 +201,24 @@ export async function previewResponse(request: Request, options: PreviewRequestO
|
||||
return new Response(reply.body, { status: reply.status, headers });
|
||||
}
|
||||
|
||||
/** `?platform=` picks one of several reports; the first listed otherwise; two values or an unknown platform match nothing. */
|
||||
function selectReport(config: PreviewConfig, url: URL): PreviewReport | undefined {
|
||||
const platforms = url.searchParams.getAll("platform");
|
||||
if (platforms.length > 1) return undefined;
|
||||
return platforms.length ? config.reports.find(report => report.platform === platforms[0]) : config.reports[0];
|
||||
/**
|
||||
* `?target=` picks one of several reports by id; `?platform=` (links from before targets) picks the target named after
|
||||
* it, else the first of that platform; neither picks the first listed. Two values, both parameters, or no match: nothing.
|
||||
*/
|
||||
export function selectReport(config: PreviewConfig, url: URL): PreviewReport | undefined {
|
||||
const targets = url.searchParams.getAll("target"), platforms = url.searchParams.getAll("platform");
|
||||
if (targets.length + platforms.length > 1) return undefined;
|
||||
if (targets.length) return config.reports.find(report => report.target === targets[0]);
|
||||
if (platforms.length) return config.reports.find(report => report.target === platforms[0]) ?? config.reports.find(report => report.platform === platforms[0]);
|
||||
return config.reports[0];
|
||||
}
|
||||
|
||||
function agentContext(pageUrl: string, config: PreviewConfig, report: PreviewReport): AgentContext {
|
||||
return { pageUrl, platform: report.platform, platforms: config.reports.map(entry => entry.platform), expiresAt: config.expiresAt === null ? null : new Date(config.expiresAt).toISOString() };
|
||||
return { pageUrl, platform: report.platform, platforms: [...new Set(config.reports.map(entry => entry.platform))], target: report.target,
|
||||
targets: config.reports.map(entry => ({ id: entry.target, platform: entry.platform, label: entry.label ?? (entry.target === entry.platform ? PLATFORM_LABELS[entry.platform] : entry.target) })),
|
||||
expiresAt: config.expiresAt === null ? null : new Date(config.expiresAt).toISOString() };
|
||||
}
|
||||
const PLATFORM_LABELS: Record<PreviewPlatform, string> = { ios: "iOS", android: "Android" };
|
||||
|
||||
/** The agent index as the shell's initial `#root` content; the Viewer replaces it when it renders. */
|
||||
export function shellWithIndex(indexHtml: string, indexBlock: string): string {
|
||||
|
||||
@@ -334,3 +334,32 @@ test("statuses follow the Viewer: accessibility-only, unavailable for a failed o
|
||||
const only = JSON.parse((await agentApiReply(context, loaded, "/screens", new URLSearchParams("status=accessibility-only"), "application/json")).body as string);
|
||||
assert.deepEqual(only.items.map((item: { id: string; status: string; sourceStatus: string }) => [item.id, item.status, item.sourceStatus]), [["device-picker", "accessibility-only", "modified"]]);
|
||||
});
|
||||
|
||||
test("a deployment of several targets keeps each target in its links and names the others in the index", async () => {
|
||||
const listing = [
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", path: "/_report/abcdefghijklmnop/iphone.zip.enc" },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: "/_report/abcdefghijklmnop/duo-open.zip.enc" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "/_report/abcdefghijklmnop/android.zip.enc" },
|
||||
];
|
||||
const targetsEnv: PreviewEnvironment = { ...reviewEnv, EXPLORE_PREVIEW_REPORT: undefined, EXPLORE_PREVIEW_REPORTS: JSON.stringify(listing) };
|
||||
const site = deployment({ [listing[0]!.path]: await sealed(review), [listing[1]!.path]: await sealed(review), [listing[2]!.path]: await sealed(explorationZip) }, targetsEnv);
|
||||
const duo = await (await site.get("/api/v1?target=duo-open")).json();
|
||||
assert.equal(duo.kind, "pr-review");
|
||||
assert.deepEqual(duo.platforms, ["ios", "android"], "distinct platforms, as before targets");
|
||||
assert.equal(duo.target, "duo-open");
|
||||
assert.deepEqual(duo.targets.map((target: { id: string; current?: boolean }) => [target.id, target.current ?? false]), [["iphone", false], ["duo-open", true], ["android", false]]);
|
||||
assert.equal(duo.targets[2].viewer, `${origin}/p/${token}?platform=android`, "a target named after its platform keeps ?platform=");
|
||||
assert.equal(duo.targets[0].summary, `${origin}/p/${token}/api/v1?target=iphone`);
|
||||
assert.equal(duo.links.screens, `${origin}/p/${token}/api/v1/screens?target=duo-open`);
|
||||
assert.equal(duo.links.viewer, `${origin}/p/${token}?target=duo-open`);
|
||||
const first = await (await site.get("/api/v1")).json();
|
||||
assert.equal(first.target, "iphone");
|
||||
assert.equal(first.links.viewer, `${origin}/p/${token}?target=iphone`);
|
||||
const index = await (await site.get("?target=duo-open")).text();
|
||||
assert.match(index, /^# Expo Explore report: .+ \(iPhone Duo \(open\)\)$/m);
|
||||
assert.ok(index.includes(`- [iPhone 17](${origin}/p/${token}?target=iphone) (ios)`), index);
|
||||
assert.ok(index.includes(`- [Android](${origin}/p/${token}?platform=android) (android)`), index);
|
||||
assert.ok(!index.includes(`- [iPhone Duo (open)]`), "the index does not list its own target among the others");
|
||||
assert.equal((await (await site.get("/api/v1?platform=android")).json()).kind, "exploration");
|
||||
assert.equal((await site.get("/api/v1?target=pixel")).status, 404);
|
||||
});
|
||||
@@ -123,13 +123,14 @@ test("a multi-platform deployment serves reports.json, one report per platform,
|
||||
const multi: PreviewEnvironment = { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(reports) };
|
||||
const fetchImpl = staticFiles({ [reports[0]!.path]: await sealed(keyBytes), [reports[1]!.path]: await sealed(keyBytes, android) });
|
||||
const options = { env: multi, indexHtml: html, fetchImpl, subtle };
|
||||
assert.deepEqual(previewConfig(multi)?.reports, reports);
|
||||
// A listing from before targets names each report by its platform, which is then its target.
|
||||
assert.deepEqual(previewConfig(multi)?.reports, reports.map(entry => ({ target: entry.platform, ...entry })));
|
||||
|
||||
const list = await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options);
|
||||
assert.equal(list.status, 200);
|
||||
assert.equal(list.headers.get("content-type"), "application/json; charset=utf-8");
|
||||
assert.equal(list.headers.get("cache-control"), "private, no-store");
|
||||
assert.deepEqual(await list.json(), [{ platform: "ios", changes: 3, device: "iPhone 17 Pro 26.0" }, { platform: "android", changes: 0, device: "Pixel 7 15" }]);
|
||||
assert.deepEqual(await list.json(), [{ target: "ios", platform: "ios", changes: 3, device: "iPhone 17 Pro 26.0" }, { target: "android", platform: "android", changes: 0, device: "Pixel 7 15" }]);
|
||||
|
||||
const first = await previewResponse(new Request(`${origin}/p/${token}/report.zip`), options);
|
||||
assert.deepEqual(new Uint8Array(await first.arrayBuffer()), report);
|
||||
@@ -142,7 +143,7 @@ test("a multi-platform deployment serves reports.json, one report per platform,
|
||||
}
|
||||
// Single-report deployments still answer reports.json (one iOS entry) and ignore an unknown platform.
|
||||
const single = { env, indexHtml: html, fetchImpl: staticFiles({ [env.EXPLORE_PREVIEW_REPORT!]: await sealed(keyBytes) }), subtle };
|
||||
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), single)).json(), [{ platform: "ios" }]);
|
||||
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), single)).json(), [{ target: "ios", platform: "ios" }]);
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}/report.zip?platform=android`), single)).status, 404);
|
||||
|
||||
const loose: Array<[string, unknown]> = [
|
||||
@@ -161,3 +162,48 @@ test("a multi-platform deployment serves reports.json, one report per platform,
|
||||
assert.equal((await previewResponse(new Request(`${origin}/p/${token}`), { ...options, env: value as PreviewEnvironment })).status, 404, name);
|
||||
}
|
||||
});
|
||||
|
||||
test("a deployment of several targets, three of them iOS, selects by ?target= and still by ?platform=", async () => {
|
||||
const targets = [
|
||||
{ target: "iphone", platform: "ios", label: "iPhone 17", path: "/_report/abcdefghijklmnop/iphone.zip.enc", changes: 1 },
|
||||
{ target: "duo-closed", platform: "ios", label: "iPhone Duo (closed)", path: "/_report/abcdefghijklmnop/duo-closed.zip.enc" },
|
||||
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", path: "/_report/abcdefghijklmnop/duo-open.zip.enc", device: "iPhone Duo 26.0" },
|
||||
{ target: "android", platform: "android", label: "Android", path: "/_report/abcdefghijklmnop/android.zip.enc" },
|
||||
];
|
||||
const bodies = targets.map(entry => new TextEncoder().encode(`PK\u0003\u0004 ${entry.target} report stand-in`));
|
||||
const { EXPLORE_PREVIEW_REPORT: _single, ...rest } = env;
|
||||
const multi: PreviewEnvironment = { ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(targets) };
|
||||
const files: Record<string, Uint8Array<ArrayBuffer>> = {};
|
||||
for (const [index, entry] of targets.entries()) files[entry.path] = await sealed(keyBytes, bodies[index]!);
|
||||
const options = { env: multi, indexHtml: html, fetchImpl: staticFiles(files), subtle };
|
||||
assert.deepEqual(previewConfig(multi)?.reports, targets);
|
||||
assert.deepEqual(await (await previewResponse(new Request(`${origin}/p/${token}/reports.json`), options)).json(), targets.map(({ path: _path, ...entry }) => entry));
|
||||
const served = async (query: string) => {
|
||||
const response = await previewResponse(new Request(`${origin}/p/${token}/report.zip${query}`), options);
|
||||
return response.status === 200 ? new TextDecoder().decode(await response.arrayBuffer()).split(" ")[1] : response.status;
|
||||
};
|
||||
assert.equal(await served(""), "iphone", "the first listed");
|
||||
assert.equal(await served("?target=duo-open"), "duo-open");
|
||||
assert.equal(await served("?target=android"), "android");
|
||||
assert.equal(await served("?platform=android"), "android", "an old link names the target after its platform");
|
||||
assert.equal(await served("?platform=ios"), "iphone", "with no target named ios, the first iOS target");
|
||||
for (const query of ["?target=web", "?target=duo-open&target=iphone", "?target=duo-open&platform=ios", "?target=", "?target=Duo-Open"]) {
|
||||
assert.equal(await served(query), 404, query);
|
||||
}
|
||||
|
||||
const eight = Array.from({ length: 8 }, (_, index) => ({ target: `t${index}`, platform: "ios", path: `/_report/abcdefghijklmnop/t${index}.zip.enc` }));
|
||||
assert.equal(previewConfig({ ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(eight) })?.reports.length, 8);
|
||||
const loose: Array<[string, unknown]> = [
|
||||
["nine targets", [...eight, { target: "t8", platform: "ios", path: "/_report/abcdefghijklmnop/t8.zip.enc" }]],
|
||||
["duplicate target", [targets[0], { ...targets[1], target: "iphone", path: targets[0]!.path }]],
|
||||
["invalid id", [{ ...targets[0], target: "iPhone", path: "/_report/abcdefghijklmnop/iPhone.zip.enc" }]],
|
||||
["reserved id", [{ ...targets[0], target: "report", path: "/_report/abcdefghijklmnop/report.zip.enc" }]],
|
||||
["install id", [{ ...targets[0], target: "install-x", path: "/_report/abcdefghijklmnop/install-x.zip.enc" }]],
|
||||
["path of another target", [{ ...targets[0], path: targets[1]!.path }]],
|
||||
["null target", [{ ...targets[0], target: null }]],
|
||||
["markup label", [{ ...targets[0], label: "<b>x</b>" }]],
|
||||
["empty label", [{ ...targets[0], label: " " }]],
|
||||
["long label", [{ ...targets[0], label: "x".repeat(81) }]],
|
||||
];
|
||||
for (const [name, value] of loose) assert.equal(previewConfig({ ...rest, EXPLORE_PREVIEW_REPORTS: JSON.stringify(value) }), undefined, name);
|
||||
});
|
||||
+3
-2
@@ -1360,7 +1360,8 @@ function ViewerApp() {
|
||||
icon?.setAttribute("href", fallback);
|
||||
return;
|
||||
}
|
||||
const platform = PLATFORM_NAMES[map.run.platform] ?? map.run.platform;
|
||||
// A run of several targets names the one it shows; one platform's run names its platform.
|
||||
const platform = (map.run.targets ? map.run.target?.label : undefined) ?? PLATFORM_NAMES[map.run.platform] ?? map.run.platform;
|
||||
const screen = selectedScreenId ? index.screens.get(selectedScreenId) : undefined;
|
||||
document.title = [screen ? screenLabel(screen, index) : undefined, map.run.name, platform, "Explore"].filter(Boolean).join(" · ");
|
||||
const appIcon = artifactUrl(map.run.appIcon);
|
||||
@@ -1495,7 +1496,7 @@ function ViewerApp() {
|
||||
} : undefined;
|
||||
const handoffView = {
|
||||
view: CANVAS_LABELS[route.canvas],
|
||||
platform: PLATFORM_NAMES[map.run.platform] ?? map.run.platform,
|
||||
platform: (map.run.targets ? map.run.target?.label : undefined) ?? PLATFORM_NAMES[map.run.platform] ?? map.run.platform,
|
||||
...(appearances.length > 1 && appearance ? { appearance: appearanceLabel(appearance) } : {}),
|
||||
...(selectedScreen ? { screen: screenLabel(selectedScreen, index) } : {}),
|
||||
};
|
||||
|
||||
@@ -30,6 +30,8 @@ export type ScreenScreenshotCardProps = {
|
||||
loading?: "eager" | "lazy";
|
||||
leading?: ReactNode;
|
||||
trailing?: ReactNode;
|
||||
/** Short lines about the screen, inside the card after its screenshot (Screens: how it was reached, where else it changed). */
|
||||
note?: ReactNode;
|
||||
onClick: MouseEventHandler<HTMLButtonElement>;
|
||||
onMouseEnter?: MouseEventHandler<HTMLDivElement>;
|
||||
onMouseLeave?: MouseEventHandler<HTMLDivElement>;
|
||||
@@ -120,6 +122,7 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
</button>
|
||||
{props.trailing}
|
||||
</span>
|
||||
{props.note ? <span className="screen-node-note">{props.note}</span> : null}
|
||||
</div>
|
||||
</CanvasActiveFrame>
|
||||
);
|
||||
|
||||
@@ -3,7 +3,7 @@ import { useEffect, useRef, useState, type ReactNode } from "react";
|
||||
import { Search } from "lucide-react";
|
||||
import { ExpoLogo } from "../shared/expo-logo";
|
||||
import { Menu } from "../shared/menu";
|
||||
import { isPreviewPath, previewReportsUrl, type ReportPlatform } from "../../utils/artifact-report";
|
||||
import { isPreviewPath, isReportTargetId, previewReportsUrl, targetQuery } from "../../utils/artifact-report";
|
||||
import { ScreenshotImage } from "../shared/screenshot-image";
|
||||
import { artifactUrl } from "../../utils/model";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
@@ -15,22 +15,43 @@ import type { PullRequestPresentation } from "../../utils/review-model";
|
||||
|
||||
export const PLATFORM_NAMES: Record<string, string> = { ios: "iOS", android: "Android" };
|
||||
|
||||
type SiblingReport = { platform: ReportPlatform; changes?: number; device?: string };
|
||||
/** What a hosted preview lists of each report it serves; listings from before targets name only the platform. */
|
||||
type SiblingReport = { target: string; changes?: number; device?: string };
|
||||
/** One report of the run, as the switch offers it. */
|
||||
export type SwitchTarget = { id: string; platform: string; label: string };
|
||||
|
||||
/** The same review's report for another platform: this page's URL with `platform` swapped (and the artifact id dropped). */
|
||||
export function siblingReportUrl(page: URL, platform: ReportPlatform): string | undefined {
|
||||
/** The same review's report for another target: this page's URL with the target swapped (and the artifact id dropped). */
|
||||
export function siblingReportUrl(page: URL, target: string): string | undefined {
|
||||
const preview = isPreviewPath(page.pathname);
|
||||
if (!preview && page.searchParams.get("origin") === "local") return undefined;
|
||||
if (!preview && !["repo", "run", "attempt"].every(key => page.searchParams.has(key))) return undefined;
|
||||
if (!isReportTargetId(target)) return undefined;
|
||||
const url = new URL(page.href);
|
||||
url.searchParams.set("platform", platform);
|
||||
url.searchParams.delete("platform");
|
||||
url.searchParams.delete("target");
|
||||
const [key, value] = targetQuery(target).split("=") as [string, string];
|
||||
url.searchParams.set(key, value);
|
||||
url.searchParams.delete("artifact");
|
||||
url.searchParams.delete("screen");
|
||||
url.hash = "";
|
||||
return url.href;
|
||||
}
|
||||
|
||||
/** On a hosted preview, the deployment lists what it serves per platform; elsewhere only the platform names are known. */
|
||||
/**
|
||||
* Every report of this report's run, in config order, and which one this is: `run.targets` with their labels, or for
|
||||
* reports from before targets one per platform of `run.platforms` (iOS first, as they list it). One report: none.
|
||||
*/
|
||||
export function runTargets(run: ExploreMap["run"]): { current: string; targets: SwitchTarget[] } {
|
||||
const current = run.target?.id ?? run.platform;
|
||||
if (run.targets && run.targets.length > 1) {
|
||||
return { current, targets: run.targets.filter(target => isReportTargetId(target.id)).map(target => ({ id: target.id, platform: target.platform,
|
||||
label: target.label?.trim() || (target.id === target.platform ? PLATFORM_NAMES[target.platform] ?? target.id : target.id) })) };
|
||||
}
|
||||
const platforms = (run.platforms ?? []).filter(platform => platform in PLATFORM_NAMES);
|
||||
return { current, targets: platforms.length > 1 ? platforms.map(platform => ({ id: platform, platform, label: PLATFORM_NAMES[platform]! })) : [] };
|
||||
}
|
||||
|
||||
/** On a hosted preview, the deployment lists what it serves per target; elsewhere only the targets' names are known. */
|
||||
function useSiblingReports(page: URL | undefined): SiblingReport[] | undefined {
|
||||
const [reports, setReports] = useState<SiblingReport[]>();
|
||||
const url = page ? previewReportsUrl(page) : undefined;
|
||||
@@ -39,8 +60,12 @@ function useSiblingReports(page: URL | undefined): SiblingReport[] | undefined {
|
||||
let cancelled = false;
|
||||
fetch(url, { cache: "no-store" }).then(response => response.ok ? response.json() : undefined).then((list: unknown) => {
|
||||
if (cancelled || !Array.isArray(list)) return;
|
||||
setReports(list.filter((entry): entry is SiblingReport => typeof entry === "object" && entry !== null
|
||||
&& (entry as SiblingReport).platform in PLATFORM_NAMES));
|
||||
setReports(list.flatMap(entry => {
|
||||
if (typeof entry !== "object" || entry === null) return [];
|
||||
const { target, platform, changes, device } = entry as Record<string, unknown>;
|
||||
const id = target ?? platform;
|
||||
return isReportTargetId(id) ? [{ target: id, ...(typeof changes === "number" ? { changes } : {}), ...(typeof device === "string" ? { device } : {}) }] : [];
|
||||
}));
|
||||
}).catch(() => {});
|
||||
return () => { cancelled = true; };
|
||||
}, [url]);
|
||||
@@ -108,20 +133,28 @@ export function AppPill(props: AppPillProps) {
|
||||
// The URL is validated as https://github.com/owner/repo/pull/N (or /compare/<base>..<head>), so its parent is the repository.
|
||||
const repositoryUrl = pullRequest?.url && pullRequest.origin !== "local" ? pullRequest.url.replace(/\/(pull\/\d+|compare\/.+)$/, "") : undefined;
|
||||
const appTitle = device ? `${applicationName} · ${device}` : applicationName;
|
||||
// Reports of a multi-platform review name every platform; the other ones are one menu away.
|
||||
const siblings = (props.map.run.platforms ?? [])
|
||||
.filter((entry): entry is ReportPlatform => entry !== platform && entry in PLATFORM_NAMES)
|
||||
.map(entry => ({ platform: entry, url: page ? siblingReportUrl(page, entry) : undefined, report: siblingReports?.find(report => report.platform === entry) }))
|
||||
.filter((entry): entry is { platform: ReportPlatform; url: string; report: SiblingReport | undefined } => Boolean(entry.url));
|
||||
const platformItems = siblings.length ? [
|
||||
{ kind: "item" as const, label: PLATFORM_NAMES[platform] ?? platform, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) },
|
||||
...siblings.map(sibling => ({
|
||||
kind: "item" as const, label: PLATFORM_NAMES[sibling.platform]!,
|
||||
// Reports of a run with several targets name every target; the others are one menu away, in config order.
|
||||
const run = runTargets(props.map.run);
|
||||
const currentTarget = run.targets.find(target => target.id === run.current);
|
||||
const targetLabel = currentTarget?.label ?? PLATFORM_NAMES[platform] ?? platform;
|
||||
// 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
|
||||
.filter(target => target.id !== run.current)
|
||||
.map(target => ({ target, url: page ? siblingReportUrl(page, target.id) : undefined, report: siblingReports?.find(report => report.target === target.id) }))
|
||||
.filter((entry): entry is { target: SwitchTarget; url: string; report: SiblingReport | undefined } => Boolean(entry.url));
|
||||
const platformItems = siblings.length ? run.targets.flatMap(target => {
|
||||
if (target.id === run.current) return [{ kind: "item" as const, label: target.label, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) }];
|
||||
const sibling = siblings.find(entry => entry.target.id === target.id);
|
||||
return sibling ? [{
|
||||
kind: "item" as const, label: target.label,
|
||||
description: [sibling.report?.changes === undefined ? undefined : `${sibling.report.changes} ${sibling.report.changes === 1 ? "change" : "changes"}`, sibling.report?.device]
|
||||
.filter(Boolean).join(" · ") || "Same review, other platform",
|
||||
.filter(Boolean).join(" · ") || (target.platform === platform ? "Same review, other device" : "Same review, other platform"),
|
||||
checked: false, onSelect: () => { setPlatformOpen(false); window.location.assign(sibling.url); },
|
||||
})),
|
||||
] : [];
|
||||
}] : [];
|
||||
}) : [];
|
||||
// A report whose target is not among the run's (a hand-edited one) still lists itself first, checked.
|
||||
if (siblings.length && !currentTarget) platformItems.unshift({ kind: "item" as const, label: targetLabel, description: device || undefined, checked: true, onSelect: () => setPlatformOpen(false) });
|
||||
|
||||
return (
|
||||
<div className="left-panel collapsed">
|
||||
@@ -146,15 +179,15 @@ export function AppPill(props: AppPillProps) {
|
||||
</strong>
|
||||
{siblings.length ? (
|
||||
<>
|
||||
<Tooltip label={`${device || PLATFORM_NAMES[platform] || platform} · open another platform's report`} placement="bottom">
|
||||
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} placement="bottom">
|
||||
<button ref={platformRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={platformOpen}
|
||||
aria-label={`Platform: ${PLATFORM_NAMES[platform] ?? platform}. Open another platform's report`}
|
||||
aria-label={`${noun === "device" ? "Device" : "Platform"}: ${targetLabel}. Open another ${noun}'s report`}
|
||||
onClick={() => setPlatformOpen(open => !open)}>
|
||||
{PLATFORM_NAMES[platform] ?? platform}
|
||||
{targetLabel}
|
||||
<svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>
|
||||
</button>
|
||||
</Tooltip>
|
||||
<Menu items={platformItems} open={platformOpen} anchorRef={platformRef} ariaLabel="Platform" onDismiss={() => setPlatformOpen(false)} />
|
||||
<Menu items={platformItems} open={platformOpen} anchorRef={platformRef} ariaLabel={noun === "device" ? "Device" : "Platform"} onDismiss={() => setPlatformOpen(false)} />
|
||||
</>
|
||||
) : null}
|
||||
{props.appearance ? (
|
||||
|
||||
@@ -181,6 +181,7 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
|
||||
.screens-cell.dimmed { opacity: var(--dim-out); }
|
||||
.screens-cell .screen-screenshot-card { gap: 8px; }
|
||||
.screens-cell .screen-node-image img { width: 100%; }
|
||||
.screens-cell .screen-node-note { display: flex; min-width: 0; flex-direction: column; gap: 2px; }
|
||||
.screens-cell-via { overflow: hidden; color: var(--tertiary); font-size: 11px; text-overflow: ellipsis; white-space: nowrap; }
|
||||
.screens-cell-elsewhere { color: var(--modified); font-size: 11px; font-weight: 600; }
|
||||
|
||||
@@ -192,7 +193,8 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
|
||||
.screens-page:not(.phone) .screens-grid { gap: 12px; }
|
||||
/* Wide enough for a 28-character route after the dot, in the footer's 10.5px mono with room to spare: Linux's
|
||||
fonts set it at about 183px. Five cards fit beside the tree at 1440px. */
|
||||
.screens-page:not(.phone) .screens-cell { width: 216px; }
|
||||
/* The screenshot well's height, which the status dot is placed below (see .diff-label). */
|
||||
.screens-page:not(.phone) .screens-cell { --screens-well: 236px; width: 216px; }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card {
|
||||
overflow: hidden;
|
||||
gap: 0;
|
||||
@@ -205,7 +207,7 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card.selected { border-color: var(--accent); box-shadow: 0 0 0 1px var(--accent); }
|
||||
/* The status is laid out against the card, not the screenshot, so it can sit in the footer. */
|
||||
.screens-page:not(.phone) .screens-cell :is(.screen-screenshot-slot, .diff-frame) { position: static; }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-slot { order: 1; height: 236px; flex: none; padding: 12px 0; background: var(--element); }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-slot { order: 1; height: var(--screens-well); flex: none; padding: 12px 0; background: var(--element); }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card.selected .screen-screenshot-slot { background: var(--accent-soft); }
|
||||
.screens-page:not(.phone) .screens-cell .screen-node-image img,
|
||||
.screens-page:not(.phone) .screens-cell .screen-node-image > .image-placeholder,
|
||||
@@ -247,13 +249,17 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
|
||||
}
|
||||
.screens-page:not(.phone) .screens-cell .screen-node-heading { order: 2; min-height: 0; padding: 10px 6px 10px 8px; }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card:has(.diff-label) .screen-node-heading { padding-left: 20px; }
|
||||
/* The notes sit under the route, in the footer, lined up with it. */
|
||||
.screens-page:not(.phone) .screens-cell .screen-node-note { order: 3; margin-top: -6px; padding: 0 6px 10px 8px; }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card:has(.diff-label) .screen-node-note { padding-left: 20px; }
|
||||
.screens-page:not(.phone) .screens-cell .screen-node-title { font-size: 10.5px; line-height: 14px; }
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card.selected .screen-node-title { color: var(--accent-strong); font-weight: 600; }
|
||||
/* The status is the tree's dot before the route, in the status colour (a square for accessibility only); the word
|
||||
stays in the label's accessible name. */
|
||||
stays in the label's accessible name. It is placed from the top of the footer, on the route's first line: a card
|
||||
stretched to its row, or one with notes, has a taller footer. */
|
||||
.screens-page:not(.phone) .screens-cell .screen-screenshot-card .diff-label {
|
||||
top: auto;
|
||||
bottom: 13.5px;
|
||||
top: calc(var(--screens-well) + 13.5px);
|
||||
bottom: auto;
|
||||
left: 8px;
|
||||
width: 7px;
|
||||
height: 7px;
|
||||
@@ -267,7 +273,6 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
|
||||
transform: none;
|
||||
}
|
||||
.screens-page:not(.phone) .screens-cell .diff-accessibility-only .diff-label { border-radius: 2px; }
|
||||
.screens-page:not(.phone) .screens-cell :is(.screens-cell-via, .screens-cell-elsewhere) { padding-inline: 2px; }
|
||||
|
||||
/* ── Phone ── */
|
||||
/* The space under the top bar is a block, not padding: both engines inset a sticky child's rest
|
||||
|
||||
@@ -140,11 +140,11 @@ function ScreenCell(props: {
|
||||
ariaPressed={props.selected}
|
||||
loading="lazy"
|
||||
onClick={props.onSelect}
|
||||
{...(props.via || props.elsewhere?.length ? { note: <>
|
||||
{props.via ? <span className="screens-cell-via">via “{props.via}”</span> : null}
|
||||
{props.elsewhere?.length ? <span className="screens-cell-elsewhere">Changed in {props.elsewhere.join(" and ")}</span> : null}
|
||||
</> } : {})}
|
||||
/>
|
||||
{props.via ? <span className="screens-cell-via">via “{props.via}”</span> : null}
|
||||
{props.elsewhere?.length ? (
|
||||
<span className="screens-cell-elsewhere">Changed in {props.elsewhere.join(" and ")}</span>
|
||||
) : null}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -6,6 +6,7 @@ import type {
|
||||
BuildWorkspacePayload,
|
||||
Coverage,
|
||||
ExploreMap,
|
||||
RunTarget,
|
||||
} from "../../../src/types";
|
||||
import {
|
||||
captureNotes,
|
||||
@@ -258,6 +259,10 @@ function sidePayload(review: PublicReview, side: Side): { map: ExploreMap; cover
|
||||
// Reports published before Android support carry no platform: they are iOS.
|
||||
platform: review.runtime.platform ?? "ios",
|
||||
...(review.runtime.platforms && review.runtime.platforms.length > 1 ? { platforms: [...review.runtime.platforms] } : {}),
|
||||
// Reports from before targets name neither: their target is their platform.
|
||||
...(runTarget(review.runtime.target) ? { target: runTarget(review.runtime.target)! } : {}),
|
||||
...(review.runtime.targets && review.runtime.targets.length > 1 && review.runtime.targets.every(target => runTarget(target))
|
||||
? { targets: review.runtime.targets.map(target => runTarget(target)!) } : {}),
|
||||
// Reviews name the controller only when it is not agent-device.
|
||||
controller: review.runtime.controller ?? "agent-device",
|
||||
status: "complete",
|
||||
@@ -648,3 +653,11 @@ export function publicReviewProjection(review: PublicReview): ViewerReviewProjec
|
||||
runtimeEvidence: evidence,
|
||||
};
|
||||
}
|
||||
|
||||
/** A review's target as the map carries it: id, platform and label, nothing else, or undefined when it is not one. */
|
||||
function runTarget(value: unknown): RunTarget | undefined {
|
||||
if (typeof value !== "object" || value === null) return undefined;
|
||||
const { id, platform, label } = value as Record<string, unknown>;
|
||||
if (typeof id !== "string" || !/^[a-z][a-z0-9-]{0,31}$/.test(id) || (platform !== "ios" && platform !== "android")) return undefined;
|
||||
return { id, platform, label: typeof label === "string" && label.trim() ? label.trim().slice(0, 120) : platform === "ios" ? "iOS" : "Android" };
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/** Optional, origin-local storage for report ZIPs the reviewer dropped on this browser. */
|
||||
type ArtifactIdentity = { origin?: "local"; repo: string; run: string; attempt: string; platform?: "ios" | "android" };
|
||||
type ArtifactIdentity = { origin?: "local"; repo: string; run: string; attempt: string; target?: string };
|
||||
export type CachedArtifact = { blob: Blob; digest: string; expiresAt: number };
|
||||
|
||||
const CACHE_NAME = "explore-reports";
|
||||
@@ -32,21 +32,27 @@ function cacheKey(identity: ArtifactIdentity): string | undefined {
|
||||
const origin = globalThis.location?.origin;
|
||||
if (!origin || !/^https?:\/\//.test(origin)) return undefined;
|
||||
const url = new URL(CACHE_PATH, origin);
|
||||
if (identity.platform !== undefined && identity.platform !== "ios" && identity.platform !== "android") return undefined;
|
||||
if (identity.target !== undefined && !targetId(identity.target)) return undefined;
|
||||
// A target named after its platform keeps the `platform` key reports were saved under before targets.
|
||||
url.search = new URLSearchParams({ ...(identity.origin ? { origin: identity.origin } : {}), repo: identity.repo.toLowerCase(), run: identity.run, attempt: identity.attempt,
|
||||
...(identity.platform ? { platform: identity.platform } : {}) }).toString();
|
||||
...(identity.target ? { [identity.target === "ios" || identity.target === "android" ? "platform" : "target"]: identity.target } : {}) }).toString();
|
||||
return url.href;
|
||||
}
|
||||
|
||||
/** The capture target grammar (isReportTargetId in artifact-report, which imports this module). */
|
||||
function targetId(value: unknown): boolean {
|
||||
return typeof value === "string" && /^[a-z][a-z0-9-]{0,31}$/.test(value) && !["base", "head", "report"].includes(value) && !value.startsWith("install-");
|
||||
}
|
||||
|
||||
function validKey(request: Request): boolean {
|
||||
if (request.method !== "GET") return false;
|
||||
try {
|
||||
const url = new URL(request.url);
|
||||
const local = url.searchParams.get("origin") === "local";
|
||||
const platform = url.searchParams.getAll("platform");
|
||||
if (platform.length > 1 || (platform[0] !== undefined && platform[0] !== "ios" && platform[0] !== "android")) return false;
|
||||
if ([...url.searchParams].length !== IDENTITY_KEYS.length + (local ? 1 : 0) + platform.length) return false;
|
||||
const identity: ArtifactIdentity = { ...(local ? { origin: "local" } : {}), ...(platform[0] ? { platform: platform[0] } : {}) } as ArtifactIdentity;
|
||||
const target = [...url.searchParams.getAll("platform"), ...url.searchParams.getAll("target")];
|
||||
if (target.length > 1 || (target[0] !== undefined && !targetId(target[0]))) return false;
|
||||
if ([...url.searchParams].length !== IDENTITY_KEYS.length + (local ? 1 : 0) + target.length) return false;
|
||||
const identity: ArtifactIdentity = { ...(local ? { origin: "local" } : {}), ...(target[0] ? { target: target[0] } : {}) } as ArtifactIdentity;
|
||||
for (const key of IDENTITY_KEYS) {
|
||||
const values = url.searchParams.getAll(key);
|
||||
if (values.length !== 1) return false;
|
||||
|
||||
@@ -17,8 +17,11 @@ export const ARTIFACT_LIMITS = {
|
||||
/** The workflow run attempt a report belongs to; `artifact` is GitHub's id of its ZIP when a link carries it. */
|
||||
export type ReportPlatform = "ios" | "android";
|
||||
export const REPORT_PLATFORMS: readonly ReportPlatform[] = ["ios", "android"];
|
||||
/** `platform` names the matrix job's report artifact (explore-review-<run>-<attempt>-<platform>); absent for single-platform runs. */
|
||||
export type ArtifactIdentity = { origin?: "local"; repo: string; run: string; attempt: string; artifact?: string; platform?: ReportPlatform };
|
||||
/**
|
||||
* `target` names the matrix job's report artifact (explore-review-<run>-<attempt>-<target>); absent for single-target
|
||||
* runs. For configs without targets it is the platform, as `?platform=` links name it.
|
||||
*/
|
||||
export type ArtifactIdentity = { origin?: "local"; repo: string; run: string; attempt: string; artifact?: string; target?: string };
|
||||
export type ArtifactLoadProgress = { phase: "cache" | "downloading" | "verifying" | "opening"; cached?: boolean; loaded?: number; total?: number };
|
||||
export type ReportFileErrorCode = "not-zip" | "not-report" | "mismatch" | "too-large" | "invalid";
|
||||
|
||||
@@ -59,22 +62,38 @@ export function isPreviewPath(pathname: string): boolean {
|
||||
export function previewReportUrl(page: URL): string | undefined {
|
||||
const match = PREVIEW_PATH.exec(page.pathname);
|
||||
if (!match) return undefined;
|
||||
const platform = reportPlatform(page);
|
||||
return `/p/${match[1]}/report.zip${platform ? `?platform=${platform}` : ""}`;
|
||||
const target = reportTarget(page);
|
||||
return `/p/${match[1]}/report.zip${target ? `?${targetQuery(target)}` : ""}`;
|
||||
}
|
||||
|
||||
/** The hosted preview's list of the platforms it serves (`/p/<token>/reports.json`). */
|
||||
/** The hosted preview's list of the targets it serves (`/p/<token>/reports.json`). */
|
||||
export function previewReportsUrl(page: URL): string | undefined {
|
||||
const match = PREVIEW_PATH.exec(page.pathname);
|
||||
return match ? `/p/${match[1]}/reports.json` : undefined;
|
||||
}
|
||||
|
||||
/** The `platform` query value when it is one platform Explore captures; throws on other values. */
|
||||
export function reportPlatform(page: URL): ReportPlatform | undefined {
|
||||
const values = page.searchParams.getAll("platform");
|
||||
/** A capture target id (the CLI's isTargetId): lowercase, starting with a letter, never a reserved name. */
|
||||
export function isReportTargetId(value: unknown): value is string {
|
||||
return typeof value === "string" && /^[a-z][a-z0-9-]{0,31}$/.test(value) && !["base", "head", "report"].includes(value) && !value.startsWith("install-");
|
||||
}
|
||||
|
||||
/**
|
||||
* The query that selects a target's report: `platform=<id>` for a target named after its platform, as every link before
|
||||
* targets did (and as the local report server and older Workers read it), `target=<id>` for any other.
|
||||
*/
|
||||
export function targetQuery(id: string): string {
|
||||
return `${id === "ios" || id === "android" ? "platform" : "target"}=${id}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* The target a link selects: `?target=<id>`, or `?platform=<id>` from links before targets (the target named after the
|
||||
* platform, which the Worker falls back to the platform's first target for). Throws on two values or an invalid id.
|
||||
*/
|
||||
export function reportTarget(page: URL): string | undefined {
|
||||
const values = [...page.searchParams.getAll("target"), ...page.searchParams.getAll("platform")];
|
||||
if (values.length === 0) return undefined;
|
||||
if (values.length > 1 || !REPORT_PLATFORMS.includes(values[0] as ReportPlatform)) throw new Error("This report link needs one platform: ios or android.");
|
||||
return values[0] as ReportPlatform;
|
||||
if (values.length > 1 || !isReportTargetId(values[0])) throw new Error("This report link needs one target, such as ios or android.");
|
||||
return values[0];
|
||||
}
|
||||
|
||||
function validIdentity(values: ArtifactIdentity): boolean {
|
||||
@@ -94,8 +113,8 @@ export function artifactIdentity(page: URL): ArtifactIdentity | undefined {
|
||||
const artifacts = page.searchParams.getAll("artifact");
|
||||
if (artifacts.length > 1 || artifacts[0] === "") throw new Error("This report link needs one artifact value.");
|
||||
if (artifacts[0]) values.artifact = artifacts[0];
|
||||
const platform = reportPlatform(page);
|
||||
if (platform) values.platform = platform;
|
||||
const target = reportTarget(page);
|
||||
if (target) values.target = target;
|
||||
if (page.searchParams.has("origin")) {
|
||||
if (page.searchParams.getAll("origin").length !== 1 || page.searchParams.get("origin") !== "local") throw new Error("Invalid report origin");
|
||||
values.origin = "local";
|
||||
@@ -105,8 +124,8 @@ export function artifactIdentity(page: URL): ArtifactIdentity | undefined {
|
||||
return identity;
|
||||
}
|
||||
|
||||
export function reportFileName(identity: Pick<ArtifactIdentity, "run" | "attempt" | "platform">): string {
|
||||
return `explore-review-${identity.run}-${identity.attempt}${identity.platform ? `-${identity.platform}` : ""}.zip`;
|
||||
export function reportFileName(identity: Pick<ArtifactIdentity, "run" | "attempt" | "target">): string {
|
||||
return `explore-review-${identity.run}-${identity.attempt}${identity.target ? `-${identity.target}` : ""}.zip`;
|
||||
}
|
||||
|
||||
export function workflowRunUrl(identity: ArtifactIdentity): string | undefined {
|
||||
|
||||
@@ -9,14 +9,18 @@ import type { PullRequestPresentation } from "./review-model";
|
||||
export function handoffPageUrl(page: URL): string | undefined {
|
||||
if (!isPreviewPath(page.pathname)) return undefined;
|
||||
const url = new URL(page.origin + page.pathname.replace(/\/$/, ""));
|
||||
const platform = page.searchParams.get("platform");
|
||||
if (platform) url.searchParams.set("platform", platform);
|
||||
// The agent API reads the same selection as the report: `target`, or `platform` in links from before targets.
|
||||
for (const key of ["target", "platform"]) {
|
||||
const value = page.searchParams.get(key);
|
||||
if (value) url.searchParams.set(key, value);
|
||||
}
|
||||
return url.href;
|
||||
}
|
||||
|
||||
/** What the reader is looking at, for the scoped prompt's last line. */
|
||||
export type HandoffView = {
|
||||
view: string;
|
||||
/** The platform, or the target's label when the run captured several. */
|
||||
platform?: string;
|
||||
appearance?: string;
|
||||
/** The selected screen's route or title. */
|
||||
|
||||
Reference in new issue
Block a user