Compare commits

...
Author SHA1 Message Date
Brent Vatne a03bfbdc6a Filmstrip: review fixes — double-clicks keep to their card, frames fit their own shape, Changed marks the folded sidebar
- A double-click opens the filmstrip only within 8px of the click that picked the card, and its second click selects nothing. A click on one card and a quick double-click elsewhere no longer opens the first, and a card the Inspector moves no longer leaves a stray selection behind.
- Each frame is fitted to its own screenshot's shape, so a landscape neighbour beside portrait screens is no longer a slab wider than the stage. Sizes ease as the strip moves.
- The middle frame keeps its screenshot's colours when the arrows focus it. The brightening that marks a focused pressed button elsewhere is off.
- When Changed or a find hides the selection, the middle is the nearest shown screen after it in the tree, as the grid's arrows step.
- The sidebar still folds on each switch to the filmstrip. Under Changed, the button left in its place has a dot in the changed colour and says so. Folding or opening the sidebar moves the keyboard to the button that replaces the one pressed.
- A neighbour's status outline covers every status the tree's dot shows.
2026-10-23 11:11:00 -07:00
Brent Vatne 4dcfa0c184 Screens: the sidebar folds away, folded by default in the filmstrip; G and E switch Grid and Filmstrip; the find field says Search
- A button in the tree's head folds the sidebar away, and a button left in its place opens it again.
- Each switch to the filmstrip starts with the sidebar folded, and each switch to the grid with it open.
- A find narrows the screens, so a switch with a query keeps the sidebar that shows it open, and folding the sidebar clears the query.
- `/` opens a folded sidebar and focuses the field.
- G and E switch Grid and Filmstrip on Screens, after Lightroom's Library keys. The switch's tooltips and the shortcuts list name them.
- The find field's placeholder is "Search".
2026-10-23 10:40:13 -07:00
Brent Vatne 0de1aa8f9c Filmstrip: the find field's arrows step from the middle screen; the layout switch keeps clear of a wide pill
- In the filmstrip, ↓ and ↑ in the find field step from the screen in the middle, as the page's arrows do, and no longer scroll the page under the strip.
- The layout switch hides below 540px of canvas, where even its icons would reach the pill, which grows to 420px.
2026-10-22 23:58:15 -07:00
Brent Vatne bbcca92a0f Filmstrip: the screenshots take the height; status beside the name; review fixes
- The caption, step buttons and scrubber under the strip are gone, so the screenshots take that height. The path above the strip ends in the screen's name, and ← / → and a click on a neighbour still step.
- The middle frame has no selection border. Its status is the tree's dot beside its name in the path, and neighbours keep their status outline.
- A long route keeps the path to one line. The screen's name truncates, ancestors are capped, and the full name is in the tooltip.
- A double-click opens the screen its first click picked, heard on the whole document. The first click opens the Inspector, which can reflow the grid or slide over the card before the second click lands.
- A layout switch replaces the history entry, as the change filter does, so Back leaves Screens rather than bringing back a layout the reader left.
- The layout switch keeps only its icons when the Inspector narrows the canvas, and hides when even those would not fit, as the Map's camera does.
2026-10-22 23:53:58 -07:00
Brent Vatne a5f395eea6 Screens: Grid / Filmstrip moves to a labelled switch at the top right; the sidebar is headed by its find field; review fixes
Layout switch
- Grid and Filmstrip are a labelled switch at the top right, in the pill's row, where the Map keeps its camera. It stays clear of the Inspector.
- The bottom bar goes back to one width on every section, and clicking the open Screens tab does nothing again.

Sidebar header
- The find field is always there at the head of the tree, with fold-all beside it and a `/` hint while it is empty.
- Changed / All sits under it only when there are changes, and the title row is gone.
- Esc in the field clears the query, then hands the keyboard back to the page.

Review fixes
- The filmstrip renders screenshots with ScreenshotImage, so downloaded reports and hosted previews resolve their screenshots instead of showing broken images.
- A layout switch keeps the focus request, so Changed and the find no longer reset to All when the selection is hidden.
- The remembered layout comes from the loaded report, whichever way it was loaded. It is read on entry from Search as well as from the toolbar.
- Only an explicit switch remembers the grid; a link that opens the filmstrip is remembered too.
- Only a double-click on a card's screenshot opens the filmstrip. The route under it copies a link and selects nothing.
- Only the middle frame is in the tab order, and the stage clips rather than hides its overflow, so focus cannot scroll it off centre.
- A click around the strip no longer clears the selection.
- The scrubber groups runs of top-level screens, so an app with many top-level routes shows a few groups, not one per route.
- A landscape frame no longer overflows a narrow stage.
- The current tick has aria-current.
2026-10-22 23:41:18 -07:00
Brent Vatne 500616b1b2 Screens: a filmstrip layout beside the grid, switched from the Screens tab; the sidebar's title shares a row with Find and fold-all
The filmstrip shows one screen at a time: the focused screen large in the middle, the screens before and after it smaller and fainter with distance, in the tree's order. Above it, the tree rows it was opened from; below it, its name, how it was reached and its place, and a scrubber with a tick per screen grouped by the tree's top rows, changed screens outlined.

- While Screens is open its tab in the bottom bar holds a Grid / Filmstrip switch, and clicking Screens again steps to the other layout.
- A double-click on a card opens it in the filmstrip. With the Inspector closed, Esc steps back out to the grid, keeping the selection.
- ← and → step the middle screen, and Return opens it in the Inspector, as in the grid.
- The layout is in the URL (`layout=filmstrip`) and remembered per report. Phones keep their list.

In the sidebar, "Explored app" now sits in the row with Find and fold-all. Changed / All follows under it only when there are changes, so a report without changes no longer has an empty row with two icons in the corner.
2026-10-22 22:59:32 -07:00
Brent Vatne 72bdb8772c Ideas: capture base and head under the same conditions (#63) 2026-10-21 14:21:54 -07:00
Brent Vatne 4ed584c990 Release 0.20.7 (#62) 2026-10-20 17:17:14 -07:00
Brent Vatne f2de6c9002 Repack sharing: list the EAS environment without --non-interactive, and check every eas flag against the pinned eas-cli (#61) 2026-10-20 17:13:34 -07:00
Brent Vatne d992899292 Release 0.20.6 (#60) 2026-10-20 16:42:02 -07:00
Brent Vatne 8e86e6a14e Argent capture waits for a new session's tool server, and a side keeps its light captures when only its dark session fails (#58) 2026-10-20 16:38:49 -07:00
48 changed files with 2069 additions and 216 deletions

No files matched your search

+9
View File
@@ -0,0 +1,9 @@
# Ideas
Plans for work we may build later. An idea records the problem, the evidence
for it, and a plan someone can pick up. Nothing here is scheduled. Defects that
CI hits today belong in [`issues/`](../issues/README.md), not here.
Start each file with its status: `Not started`, `In progress` (with a link to
the branch or PR), or `Built` (with a link to what shipped). Line references
are to the commit named at the top of each file and will drift.
+245
View File
@@ -0,0 +1,245 @@
# Capture base and head under the same conditions
Status: Not started. Line references are to `4ed584c9` (Release 0.20.7).
A review compares a route's base frame with its head frame and reports the
difference as the PR's change. That only holds when both frames were captured
from the same app state and the same keyboard. Today neither is guaranteed,
and a screen the PR did not touch can lead the comment with a large change.
## What we saw
In euxy#176's 0.20.7 review (iPhone, runs 39521260432 head and 39521251171
baseline), two rows were wrong:
1. **App state.** Dark `/rename-pattern` showed "Untitled" on base and
"Lo-Fi Bounce" on head. The row led with "Added button 'Pattern Lo-Fi
Bounce — menu'".
2. **Keyboard.** The software keyboard was drawn in some captures of the
autofocused rename sheet and not others, a 46–48% visual mismatch.
`keyboard.jsonl` said `shown` for every frame, drawn or not.
## Why
**App data carries from one appearance pass to the next.** Head ran light
routes 1–16 and then dark routes 1–16 in one session. The light pass's `/p`
import (routes 10–11) appends a pattern and makes it active, persisted in
sqlite:
```ts
// euxy src/state/store.ts
patterns: [...s.patterns, pattern],
activePatternId: pattern.id,
```
euxy captures with `launch: video`, so the dark pass relaunches through
`captureLaunch` ([`run.ts:1030`](../src/capture/run.ts)), which keeps app data
on purpose. Launch errors there are caught and logged, and routes are captured
anyway. The plain relaunch at [`run.ts:1041`](../src/capture/run.ts) only runs
when launch observation is off. The baseline split light and dark into fresh
sessions, so its dark pass started clean. Session layout is excluded from the
capture recipe on the grounds that it does not change the evidence
([`artifact-cache.ts:34`](../src/ci/artifact-cache.ts)), which is not true
today.
**Partial baseline reuse changes the order.** When only some routes are cached,
the base side captures just the rest
([`run.ts:357`](../src/capture/run.ts)):
```ts
const missingRoutes = routes.filter(route => !cachedImages[route.id]);
```
Those frames see a different history within the pass from head's.
**"Shown" is only the accessibility tree's word.** `keyboardSettle`
([`keyboard.ts`](../src/capture/keyboard.ts)) reports `shown` after two
matching tree reads, including frames with no keyboard drawn.
`keyboard.jsonl` is not in the exported diagnostics
([`run.ts:384`](../src/capture/run.ts)).
**A caveat cannot win the row.** `decideReview`
([`evidence-assessment.ts:471`](../src/review/evidence-assessment.ts)) makes
any difference `modified` and uses the first fact as the description:
```ts
const differs = visual.verdict === "modified" || changes.length > 0;
```
Review issues are appended only when there are no facts. Added and removed
elements rank ahead of text changes (priority 20 vs 30,
[`evidence-comparator.ts:143`](../src/review/evidence-comparator.ts)). With the
keyboard up, euxy's raised sheet covers Hat, Clap and Bass, so those become the
leading "Added/Removed button" facts.
**Reinstalling is not a clean slate.** Argent's `reinstall-app`
([`argent-driver.ts:712`](../src/capture/argent-driver.ts)) uninstalls and
installs, but ignores uninstall errors. iOS keychain and SecureStore data
survive an uninstall. EAS `simulator:control` has no clear-data, keychain or
keyboard action.
## Goal
For each route, base and head frames in the same appearance come from the same
app history and an equally verified keyboard state, whatever the session layout
and including reused baselines. Where the conditions still differ, the row says
so instead of reporting a PR change. Real text changes are still reported.
Done means:
- Rerun euxy#176 against a fresh baseline. Dark `/rename-pattern` and
`/patterns` show the same pattern on both sides.
- Each keyboard screen either draws the keyboard on both sides, or reads
"Added text 'Pattern name' · keyboard shown on one side only". It no longer
leads with a 46% visual change or with buttons the sheet covers.
- An unchanged screen with an autofocused field is never a PR change.
## Plan
### Phase 0: probes and diagnostics
These results decide whether phase 2 goes ahead and which reset each backend
uses.
1. **Fuller keyboard log.** Add the scheme, the pass, the tree's keyboard
bounds, Argent's `keyboardVisible`, the screen size and the app's keyboard
metrics to `keyboard.jsonl`, and export it.
2. **App-side keyboard probe on EAS**, with Argent and with agent-device. Read
`Keyboard.metrics()` and the show and hide events, and work out how much of
the window the keyboard covers. Compare that with a screenshot, a tree read,
and a second screenshot about 2 s later. Capture at least one session where
the keyboard is not drawn. The question is whether any signal separates
drawn from not drawn, and whether a missing keyboard is a late draw or a
suppressed one.
3. **Reset probe.** Write a test value into app storage through a fixture
app's deep link, reinstall through each controller on EAS and locally, and
check that it is gone. Check the keychain too, and time each reset.
### Phase 1: identical app history
4. **`resetAppData` per backend**, using what phase 0 verified:
- Argent: `reinstall-app`, checked with the test value.
- agent-device: uninstall, then install.
- Local iOS: `simctl uninstall` and `install`, plus
`simctl keychain <udid> reset`.
- Local Android: `pm clear`.
Reuse the built `localApp`. Any other backend reports `unsupported`.
5. **Reset at the start of every later captured pass** (`capturePass` in
`run.ts`):
- Run it before appearance and launch observation, so it covers
`launch: video` and `launch: off` alike.
- Count the passes captured in this session, not the loop index. A
dark-only split session starts at index 1.
- A failed reset escapes into the per-pass `try` and lands in
`sessionFailures`, not in the launch catch.
- Clear `deepLinkPromptAccepted` in the bridge's install case and approve
URL schemes again.
6. **Fall back to separate sessions.** When no verified reset exists, or the
app keeps state in the keychain on EAS, run each appearance in its own
session ([`session-plan.ts`](../src/ci/session-plan.ts)).
7. **Same history on both sides.**
- Reuse a baseline pass only if every selected route in it is cached;
otherwise capture the whole pass.
- Capture routes that exist on only one side last in that side's pass.
- Record `passStart: "fresh" | "continued"` and `reused` on each image
entry.
8. **Cache recipe.** Add `passStart` to `captureRecipeConfig`, so a capture
without the reset is never reused against one with it, even without a
version bump. Reword the `maxSessions` comment.
### Phase 2: keyboard state and an honest row
Only if phase 0 finds a signal that separates a drawn keyboard from an
undrawn one.
9. **Keyboard signal from the app.** The observer
([`observer.ts`](../src/capture/observer.ts)) reads `Keyboard.metrics()`
when it mounts, then listens for show and hide. Add the key to the
`parseCaptureDestination` allowlist so it never becomes a text node.
10. **Three-state wait:**
- `shown` when the tree and the app agree;
- `suppressed` after two reads with the tree stable and the app reporting
no coverage, without waiting out the 4 s cap;
- `unknown` when the app gives no signal.
11. **Tie the state to the screenshot.** Read it just before and just after
the screenshot ([`route-capture.ts`](../src/capture/route-capture.ts)). If
it changed, retake once, or record `unstable`. Store it on
`images[id].keyboard` so it survives the scheme merge, `export-merge`,
restore and the schema.
12. **Review rule** (`evidence-assessment.ts`, after the facts are computed).
It applies when the two sides' states differ, or when either is `unknown`
or `unstable` on a screen with a focused text field. Then:
- mark the visual verdict not comparable;
- drop added or removed elements that sit where the other side's raised
sheet or keyboard would cover them;
- keep paired text edits, and text inside the focused container;
- if text facts remain, the row is `modified` with the keyboard caveat
appended to the description after `decideReview`;
- otherwise a `scope === "none"` screen stays a variant, and anything else
is `needs-review` with the caveat;
- show the caveat in the PR comment and the Viewer.
13. **Keep the keyboard on screen where possible.** Local Android:
`settings put secure show_ime_with_hard_keyboard 1`. EAS: a serve-sim
action, if one is added. Local iOS boots headless, so phase 0 confirms
whether the Simulator.app preference applies.
### Rejected
- Dismissing the keyboard: Return submits euxy's sheet.
- Masking the keyboard band: the sheet shift is most of the mismatch.
- Detecting the keyboard from pixels: brittle across keyboards and themes.
- A fresh context for every route: cost, and
[`route-reset.ts`](../src/capture/route-reset.ts) records the settle
failures that led away from it.
- Replaying the other side's history: fragile; whole-pass reuse covers the
case.
## Risks
- **Cost:** about 25 s of reset per extra pass, measured in phase 0.
Whole-pass reuse costs more only when a pass is partly cached.
- **No usable keyboard signal:** phase 2 ships only the "keyboard couldn't be
verified" path.
- **A real change hidden behind the sheet gets dropped:** the visual verdict is
already not comparable there, and the caveat flags the screen for a person.
- **New fields lost in merge or restore:** one test runs them through every
step.
## Tests
- **`ci-map`:** reset before later passes with `launch: video` and
`launch: off`; no reset for a dark-only first pass; a failed reset lands in
`sessionFailures`; the session split when no reset exists; whole-pass reuse;
one-side-only routes last.
- **`keyboard`:** each state, Android `keyboardVisible`, and an `unstable`
change around the screenshot.
- **Observer:** the keyboard key never becomes a text node.
- **Merge, cache and schema:** `images[id].keyboard` and `passStart` survive.
- **Assessment, on the real rename trees from the runs above:** covered Hat,
Clap and Bass are dropped; "Pattern name" carries the caveat; an unchanged
autofocus screen is not a PR change; the comment row wording.
- **Local end to end:** force no keyboard on Android
(`show_ime_with_hard_keyboard 0` with a hardware keyboard) and check the
recorded state and the row.
- **Real run:** a fresh euxy baseline, then #176. Check the reset log and
timing, dark rename and `/patterns`, `keyboard.jsonl`, and the row wording.
## Open questions
1. Can serve-sim add clear-app-data, keychain-reset and hardware-keyboard
actions to EAS sessions? Without them, EAS relies on Argent's reinstall and
on separate sessions for apps that keep state in the keychain.
2. Is about 25 s per extra appearance pass acceptable by default, or should
the reset be a setting?
3. If phase 0 finds no signal that separates a drawn keyboard from an undrawn
one, is labelling every focused-field screen with a differing or unverified
keyboard as "keyboard couldn't be verified" acceptable?
## How this plan was made
Codex `gpt-6-astra`, Grok `grok-4.7` and Claude each wrote a plan
independently. Each plan was reviewed by a different model, merged, and the
merged plan reviewed again by all three, at high effort. The backbone is
Claude's; the per-frame condition record came from Codex's; keeping the
keyboard on screen and rejecting dismissal came from Grok's.
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@expo/explore",
"version": "0.20.5",
"version": "0.20.7",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.20.5",
"version": "0.20.7",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.20.5",
"version": "0.20.7",
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
"license": "MIT",
"type": "module",
+9 -1
View File
@@ -1,4 +1,4 @@
import type { CaptureOutcome } from "../contracts/capture.js";
import type { CaptureBundle, CaptureOutcome } from "../contracts/capture.js";
export type ColorScheme = "light" | "dark";
/** `auto` follows the app's `userInterfaceStyle`; a list captures exactly those schemes, first one primary. */
@@ -118,3 +118,11 @@ export function appearancePairs(routeId: string, headSchemes: readonly ColorSche
baseId: baseSchemes.includes(scheme) ? schemeScreenId(routeId, scheme === baseSchemes[0] ? undefined : scheme) : null,
}));
}
/** A `<id>@<scheme>` outcome recording that its whole appearance pass failed (`sessionFailures`), whatever the primary did. */
export function failedPassOutcome(bundle: Pick<CaptureBundle, "outcomes" | "sessionFailures">, id: string): boolean {
const { scheme } = routeIdOfScreen(id);
const own = bundle.outcomes[id];
return scheme !== undefined && own?.status === "failed" && (bundle.sessionFailures ?? []).some(failure => failure.scheme === scheme
&& failure.error.code === own.error?.code && failure.error.message === own.error?.message);
}
+3 -1
View File
@@ -92,7 +92,9 @@ export function startArgentBridgeRunner(options: {
stop(`the Argent bridge thread is unavailable (${text}); running the bridge per command`);
return options.fallback(request);
}
const result = JSON.parse(text) as { exitCode: number; stdout: string };
const result = JSON.parse(text) as { exitCode: number; stdout: string; notes?: string[] };
// The thread cannot reach the capture's log while this one waits for it, so its lines come with the answer.
for (const note of result.notes ?? []) options.progress?.(note);
return commandOutcome(request, { status: result.exitCode, stdout: result.stdout, stderr: "" });
};
return { runner, get active() { return worker !== undefined; }, close: () => { if (worker) { void worker.terminate(); worker = undefined; } } };
+17 -2
View File
@@ -61,6 +61,20 @@ async function materializedFile(data: unknown): Promise<string | undefined> {
return undefined;
}
/**
* An error's message with its cause's, as Argent's client words a failed fetch: "fetch failed: connect ECONNREFUSED …".
* A host that resolves to several addresses (localhost: ::1 and 127.0.0.1) fails with an AggregateError whose message is
* empty, so the causes' codes are named too.
*/
export function failureText(error: unknown): string {
if (!(error instanceof Error)) return String(error);
const cause = error.cause;
if (!(cause instanceof Error)) return error.message;
const codes = [cause, ...(cause instanceof AggregateError ? cause.errors : [])]
.map(item => (item as { code?: unknown } | undefined)?.code).filter((code): code is string => typeof code === "string" && !cause.message.includes(code));
return [`${error.message}:`, cause.message, ...(codes.length ? [`(${[...new Set(codes)].join(", ")})`] : [])].filter(Boolean).join(" ");
}
async function loadClient(environment: NodeJS.ProcessEnv, clientModule?: string): Promise<ArgentClient> {
const module = clientModule ?? join(dirname(await ensureController("argent", { environment })), "client.js");
const loaded = await import(pathToFileURL(module).href) as { createArgentClient?: () => ArgentClient };
@@ -74,8 +88,9 @@ export function argentClientCall(client: ArgentClient, signal: () => AbortSignal
const active = signal();
if (active.aborted) throw new ArgentCallError(`argent run ${tool} was not sent: the command was given up.`, false);
let answer: { data: unknown };
try { answer = await client.callTool(tool, args, { signal: AbortSignal.any([active, AbortSignal.timeout(ARGENT_CALL_TIMEOUT_MS)]) }); }
catch (error) { throw new ArgentCallError(`argent run ${tool} failed: ${(error instanceof Error ? error.message : String(error)).slice(0, 800)}`, true); }
const timeoutMs = Math.max(1, Math.ceil(Math.min(ARGENT_CALL_TIMEOUT_MS, options?.timeoutMs ?? ARGENT_CALL_TIMEOUT_MS)));
try { answer = await client.callTool(tool, args, { signal: AbortSignal.any([active, AbortSignal.timeout(timeoutMs)]) }); }
catch (error) { throw new ArgentCallError(`argent run ${tool} failed: ${failureText(error).slice(0, 800)}`, true); }
if (!options?.out) return answer.data;
const file = await materializedFile(answer.data);
if (!file) {
+20 -3
View File
@@ -57,9 +57,23 @@ function summarize(tool: string, value: unknown): unknown {
screen: tree.screen, nodes, roots: (tree.roots ?? []).map(root => [root.type ?? null, root.bundleId ?? null, (root.children ?? []).length]) };
}
/**
* What a failed `argent run` printed, for its error: the last few lines, and ahead of them the line saying the
* tool-server is not serving its tools yet, which the bridge waits out (argent-driver's TOOLS_NOT_SERVED) and which a
* stack trace can push out of the last lines.
*/
export function argentRunFailureDetail(stderr: string, stdout: string): string {
const lines = `${stderr}\n${stdout}`.trim().split("\n").filter(Boolean);
const notServed = lines.find(line => /GET \/tools failed: \d{3}|ECONNREFUSED/.test(line));
return [...new Set([...(notServed ? [notServed] : []), ...lines.slice(-4)])].join(" | ").slice(0, 800);
}
/** A command's answer, with the lines it has for the capture's log (`notes`), which its host prints. */
export type ArgentBridgeResult = BridgeResult & { notes?: string[] };
export type ArgentBridge = {
/** Runs one agent-device-shaped command against the session. */
run(argv: readonly string[]): Promise<BridgeResult>;
run(argv: readonly string[]): Promise<ArgentBridgeResult>;
};
/**
@@ -77,8 +91,10 @@ export function createArgentBridge(settings: ArgentBridgeSettings, call: ArgentC
await appendFile(logPath, `${JSON.stringify({ at: new Date().toISOString(), host, command: argv[0], ...entry })}\n`, { mode: 0o600 }).catch(() => undefined);
};
const state = await readState(statePath);
const notes: string[] = [];
const result = await runBridgeCommand(argv, {
state, platform, version: ARGENT_VERSION,
progress: message => { notes.push(message); void log({ note: message }); },
...(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").
@@ -101,7 +117,8 @@ export function createArgentBridge(settings: ArgentBridgeSettings, call: ArgentC
// The same URL Argent's own client checks: ARGENT_TOOLS_URL may carry a path, which /tools is appended to.
const response = await fetch(`${(toolsUrl ?? "").replace(/\/+$/, "")}/tools`, { headers: token ? { authorization: `Bearer ${token}` } : {}, signal: AbortSignal.timeout(5_000) });
await response.body?.cancel();
ok = response.status < 500;
// A tool-server still starting can answer 404 to /tools (euxy main baseline run 39506374824): it is not serving yet.
ok = response.status < 500 && response.status !== 404;
} catch { ok = false; }
if (!ok) await log({ tool: "reachable", ok });
return ok;
@@ -131,7 +148,7 @@ export function createArgentBridge(settings: ArgentBridgeSettings, call: ArgentC
});
await writeState(statePath, state);
await log({ result: result.exitCode === 0 ? "ok" : result.stdout.slice(0, 300) });
return result;
return notes.length ? { ...result, notes } : result;
},
};
}
+5 -5
View File
@@ -8,7 +8,7 @@
import { spawnSync } from "node:child_process";
import { stat } from "node:fs/promises";
import { ArgentCallError } from "./argent-driver.js";
import { argentBridgeSettings, createArgentBridge } from "./argent-bridge.js";
import { argentBridgeSettings, argentRunFailureDetail, createArgentBridge } from "./argent-bridge.js";
import { ensureController } from "../shared/controller-cache.js";
const ARGENT_CALL_TIMEOUT_MS = 180_000;
@@ -34,13 +34,12 @@ async function main(): Promise<number> {
return 1;
}
const callArgent = async (tool: string, args: Record<string, unknown>, options?: { out?: string }): Promise<unknown> => {
const callArgent = async (tool: string, args: Record<string, unknown>, options?: { out?: string; timeoutMs?: number }): Promise<unknown> => {
const run = spawnSync(process.execPath, [cli, "run", tool, "--args", JSON.stringify(args), ...(options?.out ? ["--out", options.out] : [])],
{ env: environment, encoding: "utf8", maxBuffer: 64 * 1024 * 1024, timeout: ARGENT_CALL_TIMEOUT_MS });
{ env: environment, encoding: "utf8", maxBuffer: 64 * 1024 * 1024, timeout: Math.min(ARGENT_CALL_TIMEOUT_MS, options?.timeoutMs ?? ARGENT_CALL_TIMEOUT_MS) });
if (run.error) throw new ArgentCallError(`argent run ${tool}: ${run.error.message}`, true);
if (run.status !== 0) {
const detail = `${run.stderr ?? ""}\n${run.stdout ?? ""}`.trim().split("\n").filter(Boolean).slice(-4).join(" | ").slice(0, 800);
throw new ArgentCallError(`argent run ${tool} failed: ${detail}`, true);
throw new ArgentCallError(`argent run ${tool} failed: ${argentRunFailureDetail(run.stderr ?? "", run.stdout ?? "")}`, true);
}
// With --out the client saves the tool's file and prints where ("Wrote: <path>"), not the tool's JSON.
if (options?.out) {
@@ -53,6 +52,7 @@ async function main(): Promise<number> {
};
const result = await createArgentBridge(settings, callArgent, "process").run(argv);
for (const note of result.notes ?? []) process.stderr.write(`[explore] ${note}\n`);
process.stdout.write(result.stdout);
return result.exitCode;
}
+55 -7
View File
@@ -15,7 +15,8 @@ export class ArgentCallError extends Error {
constructor(message: string, readonly sent: boolean) { super(message); }
}
export type ArgentCall = (tool: string, args: Record<string, unknown>, options?: { out?: string }) => Promise<unknown>;
/** `timeoutMs` shortens the call's own timeout, so a wait for a tool-server still starting stays within its window. */
export type ArgentCall = (tool: string, args: Record<string, unknown>, options?: { out?: string; timeoutMs?: number }) => Promise<unknown>;
type Rect = { x: number; y: number; width: number; height: number };
@@ -31,6 +32,8 @@ export type ArgentBridgeState = {
/** iOS asks "Open in “<app>”?" for the first custom-scheme link of a session; later links open directly. */
deepLinkPromptAccepted?: boolean;
recording?: string;
/** The tool-server has answered a call this session, so a GET /tools it fails is no longer taken for it still starting. */
toolsServed?: boolean;
};
export type ArgentBridgeContext = {
@@ -43,6 +46,8 @@ export type ArgentBridgeContext = {
device?: string;
version: string;
sleep: (milliseconds: number) => Promise<void>;
/** A monotonic clock in milliseconds (performance.now when absent), which bounds the wait for a tool-server to start. */
now?: () => number;
/** Moves a file the Argent client downloaded (a screen recording) to where Explore asked for it. */
moveFile: (from: string, to: string) => Promise<void>;
/** Whether the tool-server answers, checked before a UI action is sent (see `remoteUnavailable`). */
@@ -57,6 +62,8 @@ export type ArgentBridgeContext = {
landscape?: boolean;
/** Turns a portrait screen recording a quarter clockwise, to the landscape UI it shows. */
orientVideo?: (path: string) => Promise<void>;
/** A line for the capture's log: the bridge waiting on a tool-server that is still starting. */
progress?: (message: string) => void;
};
export type BridgeResult = { exitCode: number; stdout: string };
@@ -259,6 +266,20 @@ const SERVICE_DEPENDENCY_FAILED = "Service dependency failed:";
* comes after a pause, so a device still coming back from the restart has the time it needs.
*/
const DEPENDENCY_RETRY_DELAYS_MS = [3_000, 6_000] as const;
/**
* A tool-server that is not serving its tools yet. Argent's client asks GET /tools before every tool call and stops with
* "GET /tools failed: <status>" when that is not answered, so the tool itself was never sent; a refused connection
* reached nothing at all. Either is safe to send again, a UI action too. In brentvatne/euxy's main baseline run
* 39506374824 a replacement EAS session's tool-server answered 404 to /tools for the first list-devices of its install,
* and the whole target failed. An unknown tool's 404 comes from POST /tools/<name> instead, and still fails at once.
*/
const TOOLS_NOT_SERVED = /GET \/tools failed: (?:404|503)\b|ECONNREFUSED/;
/**
* How long a tool-server that has not answered yet gets to start serving its tools, requests included: a deadline, not
* a number of tries, since each try can itself take until the call's timeout. The pauses between tries grow to 10 s.
*/
const STARTUP_WINDOW_MS = 75_000;
const STARTUP_RETRY_DELAYS_MS = [1_000, 2_000, 4_000, 8_000, 10_000] as const;
const SPRINGBOARD = "com.apple.springboard";
const ANDROID_SYSTEM_UI = "com.android.systemui";
const OPEN_IN_APP_PROMPT = /^Open in “.+”\?$/;
@@ -345,14 +366,40 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
/**
* Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check.
* Any tool, a UI action too, is resent when Argent could not start a service it depends on, which it raises before
* the tool runs (see SERVICE_DEPENDENCY_FAILED).
* the tool runs (see SERVICE_DEPENDENCY_FAILED), and while a tool-server that has not answered yet is still starting
* (see TOOLS_NOT_SERVED).
*/
const call = async (tool: string, args: Record<string, unknown> = {}, options?: { out?: string }): Promise<Record<string, unknown>> => {
// Tools that name devices their own way (or none) take no udid.
const withDevice = tool === "list-devices" || tool === "stop-all-simulator-servers" ? args : { udid: state.udid, ...args };
for (let readRetry = 0, dependencyRetry = 0; ;) {
try { return record(await context.call(tool, withDevice, options)); }
catch (error) {
const clock = context.now ?? (() => performance.now());
// The window opens with the first call to a tool-server that has not answered yet, and closes 75 s later. A device
// already named came from the tool-server's own answer.
const served = () => state.toolsServed === true || state.udid !== undefined;
const startupDeadline = served() ? undefined : clock() + STARTUP_WINDOW_MS;
for (let readRetry = 0, dependencyRetry = 0, startupRetry = 0; ;) {
const starting = !served() && startupDeadline !== undefined;
try {
// A call to a tool-server still starting gets only the time left in the window.
const answer = record(await context.call(tool, withDevice, starting ? { ...options, timeoutMs: Math.max(1, Math.ceil(startupDeadline - clock())) } : options));
state.toolsServed = true;
return answer;
} catch (error) {
// Until the session's tool-server has answered once, a GET /tools it does not serve is it still starting.
if (starting && error instanceof ArgentCallError) {
const notServed = TOOLS_NOT_SERVED.test(error.message);
const left = startupDeadline - clock();
// A try the window's end cut short is the tool-server not starting in time, whatever the request reported.
if (left <= 0) {
throw new BridgeFailure("TOOL_SERVER_NOT_READY", `Argent's tool-server did not start serving its tools within ${STARTUP_WINDOW_MS / 1_000} s: ${error.message}`);
}
if (notServed) {
const delay = Math.min(STARTUP_RETRY_DELAYS_MS[Math.min(startupRetry++, STARTUP_RETRY_DELAYS_MS.length - 1)]!, left);
context.progress?.(`Argent's tool-server is not serving its tools yet (${error.message}); sending ${tool} again in ${Math.ceil(delay / 1_000)} s (${Math.ceil(left / 1_000)} s left of ${STARTUP_WINDOW_MS / 1_000} s)`);
await context.sleep(delay);
continue;
}
}
if (error instanceof ArgentCallError && error.message.includes(`[Tool:${tool}] ${SERVICE_DEPENDENCY_FAILED}`)
&& dependencyRetry < DEPENDENCY_RETRY_DELAYS_MS.length) {
await context.sleep(DEPENDENCY_RETRY_DELAYS_MS[dependencyRetry++]!);
@@ -417,8 +464,9 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
return target;
};
/**
* A UI action is only sent when the tool-server answers first, so a failure after this point is never resent. A
* session's tool-server can still be starting when EAS reports the session ready, so it is given about 25 s to answer.
* A UI action is only sent when the tool-server answers first, so a failure after this point is never resent unless
* the tool provably never ran (see call). A session's tool-server can still be starting when EAS reports the session
* ready, so it is given about 25 s to answer.
*/
const beforeAction = async () => {
for (const delay of [1_000, 2_000, 3_000, 4_000, 5_000, 5_000, 5_000]) {
+1 -1
View File
@@ -897,7 +897,7 @@ async function prepareHostedRepack(options: {
const environment = options.repackProfile.easEnvironment;
const variables = easEnvironmentSnapshot(scope => {
try {
const listedVariables = options.runner({ command: options.easCommand, args: ["env:list", "--environment", environment, "--scope", scope, "--format", "long", "--non-interactive"],
const listedVariables = options.runner({ command: options.easCommand, args: ["env:list", "--environment", environment, "--scope", scope, "--format", "long"],
cwd: options.project, environment: privateEnvironment, timeoutMs: 2 * 60_000 });
return listedVariables.stdout;
} catch { return undefined; }
+12 -2
View File
@@ -1,5 +1,5 @@
import type { CaptureBundle, CaptureOutcome } from "../contracts/capture.js";
import { bundleColorSchemes, routeIdOfScreen, schemeScreenId } from "./appearance.js";
import { bundleColorSchemes, failedPassOutcome, routeIdOfScreen, schemeScreenId } from "./appearance.js";
import { CiError } from "../shared/ci-errors.js";
type CaptureSide = CaptureBundle["side"];
@@ -59,8 +59,10 @@ export function captureHealthIssues(bundle: CaptureBundle, expectedIds: readonly
for (const id of [...extras].sort()) {
// A secondary frame is expected evidence; its own outcome is the failure of that appearance pass, or its verified
// frame when the primary pass has none (the route is then published from this appearance alone).
// A pass that failed as a whole (sessionFailures) records its failure under every route's `<target>@<scheme>`.
const primaryCaptured = bundle.outcomes[routeIdOfScreen(id).routeId]?.status === "captured";
if (!expected.has(id) && !(expectedSecondary.has(id) && !selected.has(id) && hasVerifiedOutcome(bundle.outcomes[id]) !== primaryCaptured)) {
if (!expected.has(id) && !(expectedSecondary.has(id) && !selected.has(id)
&& (hasVerifiedOutcome(bundle.outcomes[id]) !== primaryCaptured || failedPassOutcome(bundle, id)))) {
add(id, "CAPTURE_TARGET_UNEXPECTED", "Capture evidence contains a target absent from the source plan.", inventoryAction);
}
}
@@ -121,6 +123,14 @@ export function captureHealthIssues(bundle: CaptureBundle, expectedIds: readonly
const INTEGRITY_CODES = new Set(["CAPTURE_SIDE_MISMATCH", "CAPTURE_COMMIT_INVALID", "CAPTURE_SELECTION_DUPLICATE", "CAPTURE_TARGET_UNEXPECTED",
"CAPTURE_TARGET_MISSING", "CAPTURE_OUTCOME_MISSING", "CAPTURE_IMAGE_BINDING_INVALID", "CAPTURE_IMAGE_PROVENANCE_INVALID"]);
/**
* Whether a failure casts doubt on everything a capture took, so its other appearances cannot be kept as a partial
* report: a checkout that changed under it, or evidence that failed its integrity checks.
*/
export function capturedEvidenceInDoubt(code: string): boolean {
return /^(?:SOURCE|CHECKOUT)_/.test(code) || code === "CAPTURE_INCOMPLETE" || INTEGRITY_CODES.has(code);
}
export function sortedCaptureHealthIssues(inputs: readonly CaptureHealthInput[]): CaptureHealthIssue[] {
const compare = (a: string, b: string) => a < b ? -1 : a > b ? 1 : 0;
return inputs.flatMap(({ bundle, selectedIds, side }) => captureHealthIssues(bundle, selectedIds, side))
+79 -39
View File
@@ -1,5 +1,5 @@
import { appearanceArgs, argentColorSchemes, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, schemeScreenId, type AppearanceSetting, type ColorScheme } from "./appearance.js";
import { assertNoCaptureHealthIssues, captureHealthIssues, partitionCaptureHealthIssues } from "./health.js";
import { assertNoCaptureHealthIssues, capturedEvidenceInDoubt, captureHealthIssues, partitionCaptureHealthIssues } from "./health.js";
import { type RouteResetSetting } from "./route-reset.js";
import { defaultReadinessSeconds } from "./readiness.js";
import { captureLaunch, ffmpegRecordingTools, launchDirectory, type LaunchSetting, type RecordingTools } from "./launch-capture.js";
@@ -13,7 +13,7 @@ import { sourceRouteNames } from "../contracts/source-route.js";
import type { SourceCapturePlan } from "../source/capture-plan.js";
import { CONTRACT, type ExploreMap, type Platform, type RunStatus } from "../types.js";
import { ExploreStore, validateMap } from "../map/store.js";
import { CiError, serializeCiError, toCiError } from "../shared/ci-errors.js";
import { CiError, environmentSecrets, serializeCiError, toCiError } from "../shared/ci-errors.js";
import type { CaptureSetupAction, DevicePose } from "../config/explore-config.js";
import { type CiAgentRuntimeOptions } from "./agent/runtime.js";
import { EAS_CLI_VERSION, CONTROLLER_SESSION, isRecord, parseJson, baseEnvironment, nonEmpty } from "./common.js";
@@ -360,6 +360,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
+ (routes.length - missingRoutes.length ? `, ${routes.length - missingRoutes.length} reused from the baseline` : "")
+ (missingRoutes.length ? `, ${missingRoutes.length} to capture` : ""));
let captureFailure: unknown;
// Later appearance passes that failed after the primary one captured (see the pass loop).
const sessionFailures: NonNullable<CaptureBundle["sessionFailures"]> = [];
const finish = async (): Promise<CiMapResult> => {
if (!(await store.exists())) await store.initialize(map, false);
// A session making only secondary passes owns the `<id>@<scheme>` frames of those passes, not the primary ones, even
@@ -368,10 +370,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
? selectedIds.flatMap(id => options.appearancePass!.capture.filter(scheme => scheme !== colorSchemes[0]).map(scheme => schemeScreenId(id, scheme)))
: selectedIds;
const incomplete = captureFailure !== undefined || ownFrameIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
|| map.gaps.some(gap => gap.status === "open");
|| map.gaps.some(gap => gap.status === "open") || sessionFailures.length > 0;
map.run.status = incomplete || map.screens.length === 0 ? "partial" : "complete";
if (routes.length === 0) map.run.stopReason = "No source targets require capture.";
else if (captureFailure) map.run.stopReason = "Agent exploration did not finish; see capture diagnostics and bundle outcomes.";
else if (sessionFailures.length) map.run.stopReason = sessionFailures.map(failure => `The ${failure.scheme} pass failed (${failure.error.code}): ${failure.error.message.replace(/\.+$/, "")}.`).join(" ");
else if (incomplete) map.run.stopReason = "Some source targets could not be captured; see bundle outcomes.";
map.run.completedAt = new Date((options.now ?? Date.now)()).toISOString();
await store.write(map);
@@ -432,7 +435,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
...(Object.keys(launchRecords).length ? { launch: launchRecords } : {}),
...(options.agent ? { captureContexts: Object.fromEntries(selectedIds.filter(id => outcomes[id]?.status === "captured" && options.agent!.contexts[id])
.map(id => [id, options.agent!.contexts[id]!])), agentAcceptance: { policy: AGENT_ACCEPTANCE_POLICY,
frames: Object.fromEntries(Object.keys(images).map(id => [id, acceptedFrames[id]!])) } } : {}) };
frames: Object.fromEntries(Object.keys(images).map(id => [id, acceptedFrames[id]!])) } } : {}),
...(sessionFailures.length ? { sessionFailures } : {}) };
if (options.agent) assertAgentAcceptance(bundle, map, { required: true });
// The side that produces the evidence checks it the way the review will: an integrity defect fails here, naming
// its codes, instead of on the consuming side after both captures. Unavailable screens are not defects.
@@ -521,6 +525,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
await rm(simulatorProject, { recursive: true, force: true });
await localRecord?.close();
};
const earlyCleanupFailure = (original: unknown, cleanup: unknown) => new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup",
message: "A simulator Explore started before the app was ready could not be confirmed stopped.",
nextAction: "Stop the EAS Simulator session or local device this capture started (eas simulator:list), and verify its status.",
details: { originalFailure: serializeCiError(original, { secrets: [options.expoToken] }) }, cause: cleanup });
// 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 {
@@ -546,7 +554,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
} });
localOsVersion = created.osVersion;
}
} catch (error) { await stopEarlyDevice().catch(() => undefined); throw error; }
} catch (error) { await stopEarlyDevice().catch(cleanup => { throw earlyCleanupFailure(error, cleanup); }); throw error; }
// The session is named before its app exists: an EAS session starts while the app is repacked (startSession).
// A session EAS failed to start is replaced once (see the session block), under a name of its own.
const sessionNameFor = (retry: number) => simulatorSessionName({ mapName: options.name, mapId: options.buildId, gitCommit: options.gitCommit, easBuildId: local ? "local" : "installed",
@@ -659,7 +667,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
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);
// One that does not go is the failure to report: a session left running is never hidden behind the build's error.
await stopEarlyDevice().catch(cleanup => { throw earlyCleanupFailure(error, cleanup); });
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
throw error;
}
@@ -714,7 +723,14 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const live = liveSimulatorSessionsNamed(easRead(["simulator:list", "--name", sessionName, "--status", "new", "--status", "queued", "--status", "starting",
"--status", "in-progress", "--limit", "100", "--json", "--non-interactive"]), sessionName, profile.projectIdentity);
if (live) {
for (const id of live) assertSimulatorStopped(eas(["simulator:stop", "--id", id, "--json", "--non-interactive"], 2 * 60_000).stdout, id);
// No session file names these sessions, so one that does not stop is reported as left running, never as a
// capture failure a split side could keep as a partial report.
for (const id of live) {
try { assertSimulatorStopped(eas(["simulator:stop", "--id", id, "--json", "--non-interactive"], 2 * 60_000).stdout, id); }
catch (error) { throw new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup",
message: `EAS Simulator session ${id}, started by a request that failed, could not be confirmed stopped.`,
nextAction: `Stop EAS Simulator session ${id} and verify its status.`, details: { sessionId: id }, cause: error }); }
}
reason = `EAS could not start the simulator session (${simulatorStartFailure(startError, [options.expoToken]).message})`;
}
}
@@ -991,41 +1007,60 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const passes: CaptureBundle["outcomes"][] = [];
const recordingTools = launchSetting === "off" ? undefined : options.recordingTools === undefined ? ffmpegRecordingTools() : options.recordingTools ?? undefined;
const capturedSchemes = options.appearancePass ? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : colorSchemes;
const activeRuntime = runtime;
for (const [index, colorScheme] of colorSchemes.entries()) {
// A pass another session makes leaves its slot empty, so the passes stay aligned with the appearances they merge by.
if (!capturedSchemes.includes(colorScheme)) { passes.push({}); continue; }
// Argent cannot switch the appearance yet (software-mansion/argent#1509): the host does, simctl or adb on this
// machine and serve-sim on an EAS iOS session; elsewhere its single pass runs as the device starts.
if (controller !== "argent") runner({ command: controllerCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(runtime), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme], controlOptions);
else if (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
// relaunch starts the app in the new scheme, the same way the first pass did.
if (launchSetting !== "off") {
// Observing the launch relaunches the app before setup runs, so no UI-created state is lost.
say(`observing the app launch${colorSchemes.length > 1 ? ` (${colorScheme})` : ""}`);
try {
// A restored baseline's launch evidence is replaced only by a fresh observation.
const record = await captureLaunch({ bundleId: options.bundleId, keepVideo: launchSetting === "video", platform: options.platform,
directory: join(launchWorkDirectory, launchDirectory(colorScheme)), relativeDirectory: launchDirectory(colorScheme), ...(options.now ? { now: options.now } : {}),
...(recordingTools ? { recordingTools } : {}),
controller: (args, controllerOptions) => runner({ command: controllerCommand, args: [...args, "--session", CONTROLLER_SESSION, ...deviceArgs(runtime!), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: controllerOptions?.timeoutMs ?? 60_000, ...(controllerOptions?.allowFailure ? { allowFailure: true } : {}) }) });
launch[colorScheme] = { root: launchWorkDirectory, record };
} catch (error) {
// The launch is supplementary evidence: a failure to observe it leaves the route capture intact.
say(`the app launch could not be observed (${(error as Error).message}); the report has no launch evidence for ${colorScheme}`);
await rm(join(launchWorkDirectory, launchDirectory(colorScheme)), { recursive: true, force: true });
}
} else if (index > 0) runner({ command: controllerCommand, args: ["open", options.bundleId, "--relaunch", "--session", CONTROLLER_SESSION,
...deviceArgs(runtime), "--platform", options.platform, "--level", "full", "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
runtime.colorScheme = colorScheme;
if (colorSchemes.length > 1) say(`appearance ${colorScheme} (${index + 1}/${colorSchemes.length})`);
passes.push(await capturePlannedRoutes({ capture: { ...options, ...(argentBridge && !options.agent ? { runner: argentBridge.runner } : {}), agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
...(colorSchemes.length > 1 ? { appearance: { scheme: colorScheme, primary: index === 0 } } : {}) }));
const passOutcomes: CaptureBundle["outcomes"] = index === 0 ? outcomes : {};
const capturePass = async () => {
// Argent cannot switch the appearance yet (software-mansion/argent#1509): the host does, simctl or adb on this
// machine and serve-sim on an EAS iOS session; elsewhere its single pass runs as the device starts.
if (controller !== "argent") runner({ command: controllerCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(activeRuntime), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme], controlOptions);
else if (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
// relaunch starts the app in the new scheme, the same way the first pass did.
if (launchSetting !== "off") {
// Observing the launch relaunches the app before setup runs, so no UI-created state is lost.
say(`observing the app launch${colorSchemes.length > 1 ? ` (${colorScheme})` : ""}`);
try {
// A restored baseline's launch evidence is replaced only by a fresh observation.
const record = await captureLaunch({ bundleId: options.bundleId, keepVideo: launchSetting === "video", platform: options.platform,
directory: join(launchWorkDirectory, launchDirectory(colorScheme)), relativeDirectory: launchDirectory(colorScheme), ...(options.now ? { now: options.now } : {}),
...(recordingTools ? { recordingTools } : {}),
controller: (args, controllerOptions) => runner({ command: controllerCommand, args: [...args, "--session", CONTROLLER_SESSION, ...deviceArgs(activeRuntime), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: controllerOptions?.timeoutMs ?? 60_000, ...(controllerOptions?.allowFailure ? { allowFailure: true } : {}) }) });
launch[colorScheme] = { root: launchWorkDirectory, record };
} catch (error) {
// The launch is supplementary evidence: a failure to observe it leaves the route capture intact.
say(`the app launch could not be observed (${(error as Error).message}); the report has no launch evidence for ${colorScheme}`);
await rm(join(launchWorkDirectory, launchDirectory(colorScheme)), { recursive: true, force: true });
}
} else if (index > 0) runner({ command: controllerCommand, args: ["open", options.bundleId, "--relaunch", "--session", CONTROLLER_SESSION,
...deviceArgs(activeRuntime), "--platform", options.platform, "--level", "full", "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
activeRuntime.colorScheme = colorScheme;
if (colorSchemes.length > 1) say(`appearance ${colorScheme} (${index + 1}/${colorSchemes.length})`);
return await capturePlannedRoutes({ capture: { ...options, ...(argentBridge && !options.agent ? { runner: argentBridge.runner } : {}), agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime: activeRuntime,
connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: passOutcomes,
...(colorSchemes.length > 1 ? { appearance: { scheme: colorScheme, primary: index === 0 } } : {}) });
};
// A later pass of a session whose primary pass captured fails only its own appearance, as a secondary session does
// when the passes are split over sessions (captureSideInSessions): in brentvatne/euxy's main baseline run
// 39506374824 a failed dark session failed a target whose light session had captured 16 of 16 routes.
if (index === 0 || !capturedSchemes.includes(colorSchemes[0]!) || options.agent) { passes.push(await capturePass()); continue; }
try { passes.push(await capturePass()); }
catch (error) {
const failure = toCiError(error, { code: `CAPTURE_${runtimeStage.toUpperCase()}_FAILED`, stage: runtimeStage,
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." });
if (options.signal?.aborted || capturedEvidenceInDoubt(failure.code)) throw failure;
const { code, stage, message, nextAction, retryable } = serializeCiError(failure, { secrets: [options.expoToken, ...environmentSecrets(sourceEnvironment)] });
say(`the ${colorScheme} pass failed (${code}: ${message}); keeping the ${colorSchemes[0]} captures, and the report marks every ${colorScheme} frame it did not take failed`);
sessionFailures.push({ scheme: colorScheme, error: { code, stage, message, nextAction, retryable } });
// The routes the pass finished keep what it recorded.
passes.push(passOutcomes);
}
}
runtime.colorScheme = colorSchemes[0]!;
// A session without the primary pass keeps each outcome as its pass recorded it, under `<id>@<scheme>`: the export
@@ -1034,6 +1069,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
if (options.appearancePass && !capturedSchemes.includes(colorSchemes[0]!)) {
for (const [index, pass] of passes.entries()) for (const [id, outcome] of Object.entries(pass)) outcomes[schemeScreenId(id, colorSchemes[index])] = outcome;
} else Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
// A failed pass records its failure under each route it did not finish, as the export merge does for a failed session.
for (const { scheme: failedScheme, error } of sessionFailures) {
const pass = passes[colorSchemes.indexOf(failedScheme)] ?? {};
for (const id of selectedIds) if (!pass[id]) outcomes[schemeScreenId(id, failedScheme)] = { status: "failed", attempts: 0, landing: "unverified", reason: error.message, error };
}
} 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 {
+35 -4
View File
@@ -1,4 +1,4 @@
import { routeIdOfScreen } from "../capture/appearance.js";
import { bundleColorSchemes, routeIdOfScreen, schemeScreenId } from "../capture/appearance.js";
import { createHash } from "node:crypto";
import { cp, lstat, mkdtemp, readFile, readdir, realpath, rm, writeFile } from "node:fs/promises";
import { isAbsolute, join, relative, resolve, sep } from "node:path";
@@ -54,7 +54,8 @@ function requiresAgentAcceptance(recipe: Recipe, bundle: CaptureBundle): boolean
catch { return false; }
}
async function validateEvidence(directory: string, bundle: CaptureBundle): Promise<void> {
/** Checks an export the way a cache entry is checked before it is written or restored: its provenance, profile and frames. */
export async function validateEvidence(directory: string, bundle: CaptureBundle): Promise<void> {
const map = await readExportedMap(directory, { checkArtifacts: true });
const execution = parseRuntimeExecutionContext(JSON.parse(await readFile(join(directory, "execution.json"), "utf8")));
if (!bundle.runtimeProfile || !/^[a-f0-9]{40}$/.test(bundle.gitCommit)
@@ -113,6 +114,31 @@ async function fileInventory(directory: string, path = ""): Promise<FileRecord[]
return files;
}
/**
* The routes a review can reuse from a capture: a verified frame in every appearance it renders. A baseline whose dark
* session failed (brentvatne/euxy's main baseline run 39506374824) holds its light frames and a failed `<route>@dark`;
* reusing the light frame alone would leave the review's base with no dark frame, and dark would read as unavailable
* because of the base. Such a route is captured by the review's base instead, in every appearance.
*/
export function reusableSurfaceIds(bundle: CaptureBundle): string[] {
const secondarySchemes = bundleColorSchemes(bundle).slice(1);
return bundle.selectedSurfaceIds.filter(id => hasVerifiedCapture(bundle, id)
&& secondarySchemes.every(scheme => bundle.images[schemeScreenId(id, scheme)] && bundle.outcomes[schemeScreenId(id, scheme)] === undefined));
}
/**
* Why a capture of `commit` in `sourceDirectory` is not offered for reuse, when it is there and captured some routes:
* none has every appearance (its dark session failed). Undefined otherwise, the cache's usual misses included.
*/
export async function incompleteCaptureReason(sourceDirectory: string, commit: string): Promise<string | undefined> {
try {
const bundle = await readCaptureBundle(sourceDirectory);
if (bundle.gitCommit !== commit || reusableSurfaceIds(bundle).length || !bundle.selectedSurfaceIds.some(id => hasVerifiedCapture(bundle, id))) return undefined;
const failed = (bundle.sessionFailures ?? []).map(failure => failure.scheme);
return failed.length ? `its ${failed.join(" and ")} session failed, so no route has every appearance` : "no route was captured in every appearance";
} catch { return undefined; }
}
/** Cache full exported evidence, including accessibility maps and all referenced screenshots. */
export async function writeCaptureArtifactCache(directory: string, recipe: Recipe): Promise<boolean> {
try {
@@ -122,6 +148,9 @@ export async function writeCaptureArtifactCache(directory: string, recipe: Recip
if (!bundle.runtimeProfile) return false;
assertAgentAcceptance(bundle, undefined, { required: requiresAgentAcceptance(recipe, bundle) });
await validateEvidence(directory, bundle);
// A capture with no route a review could reuse is not offered: a review that found it would wait for it, and capture
// its sides in turn instead of together, only to capture every route of the base itself.
if (!reusableSurfaceIds(bundle).length) return false;
const metadata: CacheMetadata = {
contract: CONTRACT, recipe: recipeKey(recipe), commit: bundle.gitCommit, files: await fileInventory(directory),
};
@@ -181,7 +210,8 @@ export async function restoreCaptureArtifactCache(options: Recipe & {
stage = await mkdtemp(`${options.directory}.cache-`);
const stagedEvidence = join(stage, "evidence");
await cp(source, stagedEvidence, { recursive: true, force: false, errorOnExist: true });
const available = options.selectedIds.filter(id => hasVerifiedCapture(bundle, id)
const reusable = new Set(reusableSurfaceIds(bundle));
const available = options.selectedIds.filter(id => reusable.has(id)
&& (!options.captureContexts || options.captureContexts[id] && bundle.captureContexts?.[id]
&& canonicalJson(options.captureContexts[id]) === canonicalJson(bundle.captureContexts[id])));
if (!available.length) return false;
@@ -192,7 +222,8 @@ export async function restoreCaptureArtifactCache(options: Recipe & {
const captureContexts = bundle.captureContexts ? Object.fromEntries(available.map(id => [id, bundle.captureContexts![id]])) : undefined;
const agentAcceptance = bundle.agentAcceptance ? { policy: bundle.agentAcceptance.policy,
frames: Object.fromEntries(available.map(id => [id, bundle.agentAcceptance!.frames[id]!])) } : undefined;
await writeFile(join(stagedEvidence, "bundle.json"), JSON.stringify({ ...bundle, side: "base", selectedSurfaceIds: available, images, outcomes,
// Only complete routes are restored, so a failed pass of the baseline's is no part of the restored bundle.
await writeFile(join(stagedEvidence, "bundle.json"), JSON.stringify({ ...bundle, side: "base", selectedSurfaceIds: available, images, outcomes, sessionFailures: undefined,
...(captureContexts ? { captureContexts } : {}), ...(agentAcceptance ? { agentAcceptance } : {}) }));
await cp(stagedEvidence, options.directory, { recursive: true, force: false, errorOnExist: true });
return true;
+2 -2
View File
@@ -1,6 +1,6 @@
import { Worker, isMainThread, parentPort, workerData } from "node:worker_threads";
import { runCiMap, type CiMapOptions, type CiMapResult } from "../capture/run.js";
import { CiError, serializeCiError, type CiErrorData } from "../shared/ci-errors.js";
import { CiError, environmentSecrets, serializeCiError, type CiErrorData } from "../shared/ci-errors.js";
import type { Progress } from "../shared/progress.js";
type WorkerMessage = { type: "progress"; message: string } | { type: "done"; result: CiMapResult } | { type: "error"; error: CiErrorData };
@@ -41,5 +41,5 @@ if (!isMainThread && parentPort) {
port.unref();
runCiMap({ ...options, signal: controller.signal, progress: message => port.postMessage({ type: "progress", message } satisfies WorkerMessage) })
.then(result => port.postMessage({ type: "done", result } satisfies WorkerMessage))
.catch((error: unknown) => port.postMessage({ type: "error", error: serializeCiError(error, { secrets: [options.expoToken] }) } satisfies WorkerMessage));
.catch((error: unknown) => port.postMessage({ type: "error", error: serializeCiError(error, { secrets: [options.expoToken, ...environmentSecrets(options.environment ?? {})] }) } satisfies WorkerMessage));
}
+38 -11
View File
@@ -1,7 +1,7 @@
import { copyFile, mkdir, readdir, readFile, writeFile, appendFile, lstat } from "node:fs/promises";
import { dirname, join, relative } from "node:path";
import { bundleColorSchemes, mergeSchemeOutcomes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
import { bundleColorSchemes, mergeSchemeOutcomes, routeIdOfScreen, schemeScreenId, type ColorScheme } from "../capture/appearance.js";
import type { CaptureOutcome } from "../contracts/capture.js";
import type { CaptureBundle } from "../contracts/capture.js";
import type { ExploreMap } from "../types.js";
@@ -22,12 +22,21 @@ async function copyTree(source: string, destination: string, skip: (relativePath
}
}
/**
* A secondary appearance session's result: its export, or the error it failed with, when it left none. In brentvatne/euxy's
* main baseline run 39506374824 the dark session's install failed after the light session had captured 16 of 16 routes.
*/
export type SecondaryCaptureExport = { directory: string; scheme: ColorScheme } | { scheme: ColorScheme; error: NonNullable<CaptureOutcome["error"]> };
/**
* Fold the exports of a side's secondary appearance sessions into its primary export, in place: the frames, outcomes,
* launch evidence and map records of each `<id>@<scheme>` screen, and their files. Each session captured its passes as
* one run would (`appearancePass`), so records only append; a secondary export never replaces a primary record.
* one run would (`appearancePass`), so records only append; a secondary export never replaces a primary record. A session
* that failed is listed in the bundle's `sessionFailures`, adds a failed `<id>@<scheme>` outcome carrying its error for
* every selected route, and leaves the run partial, so its appearance reads as unavailable with its own reason (a route
* the primary lost too would otherwise show the primary's) instead of going missing.
*/
export async function mergeCaptureExports(primary: string, secondaries: readonly { directory: string; scheme: ColorScheme }[]): Promise<void> {
export async function mergeCaptureExports(primary: string, secondaries: readonly SecondaryCaptureExport[]): Promise<void> {
if (secondaries.length === 0) return;
const bundle = await readJson<CaptureBundle>(join(primary, "bundle.json"));
const map = await readJson<ExploreMap>(join(primary, "screen-map.json"));
@@ -37,15 +46,28 @@ export async function mergeCaptureExports(primary: string, secondaries: readonly
const schemes = bundleColorSchemes(bundle);
const passes: Record<string, CaptureOutcome>[] = schemes.map(() => ({}));
for (const [id, outcome] of Object.entries(bundle.outcomes)) if (!routeIdOfScreen(id).scheme) passes[0]![id] = outcome;
for (const { directory: secondary, scheme } of secondaries) {
const other = await readJson<CaptureBundle>(join(secondary, "bundle.json"));
const failedSessions: string[] = [];
const failedOutcomes: Record<string, CaptureOutcome> = {};
for (const secondary of secondaries) {
const { scheme } = secondary;
if ("error" in secondary) {
failedSessions.push(`The ${scheme} session failed (${secondary.error.code}): ${secondary.error.message.replace(/\.+$/, "")}.`);
(bundle.sessionFailures ??= []).push({ scheme, error: secondary.error });
// A primary that renders no such appearance has no slot for its frames; the failure stays on the bundle alone.
if (!schemes.includes(scheme)) continue;
for (const id of bundle.selectedSurfaceIds) {
failedOutcomes[schemeScreenId(id, scheme)] = { status: "failed", attempts: 0, landing: "unverified", reason: secondary.error.message, error: secondary.error };
}
continue;
}
const other = await readJson<CaptureBundle>(join(secondary.directory, "bundle.json"));
const pass = passes[schemes.indexOf(scheme)];
// A session that could not show its appearance (Argent without appearance.set captures one) has nothing to add, as
// one run would have no pass for it.
if (!pass && !bundleColorSchemes(other).includes(scheme)) continue;
if (!pass) throw new Error(`The ${scheme} session's export is not an appearance of the primary export (${schemes.join(", ")})`);
for (const [id, outcome] of Object.entries(other.outcomes)) pass[routeIdOfScreen(id).routeId] = outcome;
const otherMap = await readJson<ExploreMap>(join(secondary, "screen-map.json"));
const otherMap = await readJson<ExploreMap>(join(secondary.directory, "screen-map.json"));
for (const [id, image] of Object.entries(other.images)) if (routeIdOfScreen(id).scheme && !bundle.images[id]) bundle.images[id] = image;
for (const [scheme, record] of Object.entries(other.launch ?? {})) { bundle.launch ??= {}; bundle.launch[scheme] ??= record; }
for (const [id, context] of Object.entries(other.captureContexts ?? {})) { bundle.captureContexts ??= {}; bundle.captureContexts[id] ??= context; }
@@ -61,9 +83,9 @@ export async function mergeCaptureExports(primary: string, secondaries: readonly
}
}
// Files: artifacts and launch evidence are new paths; diagnostics append to the primary's lines.
await copyTree(secondary, primary, rel => rel === "bundle.json" || rel === "screen-map.json" || rel === "screen-map.schema.json" || rel === "manifest.json"
await copyTree(secondary.directory, primary, rel => rel === "bundle.json" || rel === "screen-map.json" || rel === "screen-map.schema.json" || rel === "manifest.json"
|| rel === "execution.json" || rel.startsWith("capture-diagnostics"));
const diagnostics = join(secondary, "capture-diagnostics");
const diagnostics = join(secondary.directory, "capture-diagnostics");
for (const entry of await readdir(diagnostics, { withFileTypes: true }).catch(() => [])) {
if (!entry.isFile()) continue;
const to = join(primary, "capture-diagnostics", entry.name);
@@ -72,12 +94,17 @@ export async function mergeCaptureExports(primary: string, secondaries: readonly
else if (!(await lstat(to).catch(() => undefined))) await copyFile(join(diagnostics, entry.name), to);
}
}
// An open gap a secondary pass left makes the run partial, as it does one run's (a complete run has none).
if (map.gaps.some(gap => gap.status === "open")) map.run.status = "partial";
// An open gap a secondary pass left makes the run partial, as it does one run's (a complete run has none), and so does
// a secondary session that failed. A partial run names why, as the map's schema requires.
if (map.gaps.some(gap => gap.status === "open") || failedSessions.length) {
map.run.status = "partial";
map.run.stopReason = [map.run.stopReason ?? (failedSessions.length ? undefined : "Some source targets could not be captured; see bundle outcomes."),
...failedSessions].filter(Boolean).join(" ");
}
const manifest = await readJson<{ files: unknown[] }>(join(primary, "manifest.json"));
manifest.files = map.artifacts.map(artifact => ({ path: artifact.path, sha256: artifact.sha256, bytes: artifact.bytes, mimeType: artifact.mimeType }));
await writeFile(join(primary, "screen-map.json"), JSON.stringify(map));
bundle.outcomes = mergeSchemeOutcomes(passes, schemes);
bundle.outcomes = { ...mergeSchemeOutcomes(passes, schemes), ...failedOutcomes };
await writeFile(join(primary, "bundle.json"), JSON.stringify(bundle));
await writeFile(join(primary, "manifest.json"), `${JSON.stringify(manifest, null, 2)}\n`);
}
+12 -2
View File
@@ -293,6 +293,17 @@ function sessionStateFiles(output: string): string[] {
catch { return []; }
}
/**
* A finished target keeps only its report: the captures, maps and checkouts are the bulk of the run. A session file
* stays, since it names a session no capture confirmed stopped; the review stops it on its way out (stopRecordedSessions).
*/
export async function pruneTargetOutput(output: string): Promise<void> {
const sessions = new Set(sessionStateFiles(output));
for (const entry of await readdir(output)) {
if (entry !== "report" && entry !== "report.zip" && !sessions.has(entry)) await rm(join(output, entry), { recursive: true, force: true });
}
}
function recordedSessionIds(outputs: string[]): string[] {
return outputs.flatMap(output => sessionStateFiles(output).flatMap(name => {
try { const id = readFileSync(join(output, name), "utf8").trim(); return /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id) ? [id] : []; } catch { return []; }
@@ -526,8 +537,7 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
if (side === "head" && head.uncommitted) continue;
await keepCapture(join(output, `${side}-export`), captureCacheDirectory(environment, target.id, side === "base" ? base.sha : head.sha));
}
// 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 });
await pruneTargetOutput(output);
abort.signal.throwIfAborted();
return report;
};
+60 -14
View File
@@ -1,7 +1,7 @@
import { systemRegions } from "../contracts/capture.js";
import type { RunTarget } from "../types.js";
import { execFile, spawnSync } from "node:child_process";
import { mkdir, mkdtemp, open, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { lstat, mkdir, mkdtemp, open, readFile, realpath, rm, writeFile } from "node:fs/promises";
import { join, relative, resolve, isAbsolute } from "node:path";
import { tmpdir } from "node:os";
import { setTimeout as delay } from "node:timers/promises";
@@ -12,12 +12,12 @@ import type { RepackShare } from "../capture/eas-build.js";
import { resolveColorSchemes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
import { baseEnvironment } from "../capture/common.js";
import { DEFAULT_MAX_SESSIONS, planSideSessions, sessionShare } from "./session-plan.js";
import { mergeCaptureExports } from "./export-merge.js";
import { mergeCaptureExports, type SecondaryCaptureExport } from "./export-merge.js";
import { abandonSharedBuilds } from "../capture/shared-build.js";
import { prepareCaptureReview, readCaptureBundle } from "../review/capture-review.js";
import { quarantineReviewContract } from "../contracts/review-validation.js";
import { agentCaptureConstraints } from "../capture/agent/source-context.js";
import { captureArtifactCacheMayMatch, captureRecipeConfig, restoreCaptureArtifactCache, writeCaptureArtifactCache } from "./artifact-cache.js";
import { captureArtifactCacheMayMatch, captureRecipeConfig, incompleteCaptureReason, restoreCaptureArtifactCache, writeCaptureArtifactCache } from "./artifact-cache.js";
import { runCiMapOnWorker } from "./capture-worker.js";
import { DEFAULT_BASELINE_WAIT_MINUTES, awaitPendingBaseline } from "./baseline-wait.js";
import { writeCiReportInput, readAppDirectory } from "../report/artifact.js";
@@ -30,10 +30,10 @@ import { viewerLinks } from "../report/viewer-links.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";
import { CiError, environmentSecrets, serializeCiError, toCiError } from "../shared/ci-errors.js";
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 { assertNoCaptureHealthIssues, capturedEvidenceInDoubt, partitionCaptureHealthIssues, renderCaptureIssueAnnotation, renderComparisonDiagnosticAnnotation, renderNotesUnavailableAnnotation, renderReviewGapAnnotation, sortedCaptureHealthIssues } from "../capture/health.js";
import { EXPLORE_PACKAGE, packageBin } from "../shared/package-paths.js";
import { agentDeviceLauncher, ensureArgentToolServer, ensureController } from "../shared/controller-cache.js";
import { silentProgress, type Progress } from "../shared/progress.js";
@@ -130,14 +130,37 @@ async function expectedColorSchemes(config: ExploreConfig, project: string, envi
}
}
/**
* Failures that fail the side even when only a secondary appearance session had them. A session Explore could not
* confirm stopped, or whose identity it could not verify, must never be hidden behind a partial report; a checkout that
* changed, evidence that failed its integrity checks, or a failure Explore did not classify means the primary's frames
* may not be what they claim either.
*/
const SIDE_FAILURE_CODES = new Set(["SESSION_CLEANUP_FAILED", "SESSION_HANDOFF_UNVERIFIED", "CAPTURE_WORKER_EXITED", "EXPLORE_FAILED"]);
/**
* Whether a secondary appearance session's failure can be reported as that appearance's frames failing, keeping the
* primary's: only when the capture reported it itself (a worker that died before its cleanup ran rejects otherwise), its
* session is proven stopped (the capture removes its session file only after a confirmed stop), and nothing in it
* casts doubt on the primary's evidence.
*/
async function secondaryFailureKept(error: unknown, sessionStatePath: string | undefined): Promise<boolean> {
if (!(error instanceof CiError)) return false;
if (SIDE_FAILURE_CODES.has(error.code) || capturedEvidenceInDoubt(error.code)
|| (error.details as { allocation?: unknown } | undefined)?.allocation === "unknown") return false;
return !(sessionStatePath && await lstat(sessionStatePath).then(() => true, () => false));
}
/**
* Run one side's capture: in one session, or when `passes` splits its appearances, one worker session per pass. The
* primary pass exports to `mapOptions.outputDirectory`; the others beside it, named by their appearances, then merge.
* `runPass` replaces the worker capture of each pass (tests).
*/
async function captureSideInSessions(mapOptions: CiMapOptions, passes: readonly (readonly ColorScheme[])[] | undefined,
progress: Progress, signal: AbortSignal | undefined, worker: boolean): Promise<Awaited<ReturnType<typeof runCiMap>>> {
const runOnWorker = (passOptions: CiMapOptions) =>
runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(passOptions), progress, signal);
export async function captureSideInSessions(mapOptions: CiMapOptions, passes: readonly (readonly ColorScheme[])[] | undefined,
progress: Progress, signal: AbortSignal | undefined, worker: boolean,
runPass?: (passOptions: CiMapOptions) => Promise<Awaited<ReturnType<typeof runCiMap>>>): Promise<Awaited<ReturnType<typeof runCiMap>>> {
const runOnWorker = runPass ?? ((passOptions: CiMapOptions) =>
runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(passOptions), progress, signal));
if (!passes || passes.length <= 1) return worker ? runOnWorker(mapOptions) : runCiMap(mapOptions);
const schemes = passes.flat();
progress(`${mapOptions.side}: capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions`);
@@ -158,9 +181,29 @@ async function captureSideInSessions(mapOptions: CiMapOptions, passes: readonly
}));
// The build folder holds the repacked app, which the sessions have installed.
if (ownBuildShare) await rm(ownBuildShare, { recursive: true, force: true });
for (const outcome of settled) if (outcome.status === "rejected") throw outcome.reason;
await mergeCaptureExports(mapOptions.outputDirectory, passes.slice(1).map(pass => ({ directory: `${mapOptions.outputDirectory}-${pass.join("-")}`, scheme: pass[0]! })));
return (settled[0] as PromiseFulfilledResult<Awaited<ReturnType<typeof runCiMap>>>).value;
// Only the primary appearance's session fails the side, besides a stopped review and a secondary failure that cannot be
// kept (secondaryFailureKept). In brentvatne/euxy's main baseline run 39506374824 the light session captured 16 of 16
// routes and the dark session's install failed, which failed the whole target and lost its baseline. Such a failure is
// kept in the report instead: every frame of its appearance is failed with its error, and the run is partial.
const suffixOf = (pass: readonly ColorScheme[]) => `-${pass.join("-")}`;
for (const [index, outcome] of settled.entries()) {
if (outcome.status !== "rejected" || index === 0) continue;
const statePath = mapOptions.sessionStatePath ? `${mapOptions.sessionStatePath}${suffixOf(passes[index]!)}` : undefined;
if (signal?.aborted || !await secondaryFailureKept(outcome.reason, statePath)) throw outcome.reason;
}
const primary = settled[0]!;
if (primary.status === "rejected") throw primary.reason;
const secrets = [mapOptions.expoToken, ...environmentSecrets(mapOptions.environment ?? {})];
const secondaries = passes.slice(1).map((pass, index): SecondaryCaptureExport => {
const outcome = settled[index + 1]!;
if (outcome.status === "fulfilled") return { directory: `${mapOptions.outputDirectory}${suffixOf(pass)}`, scheme: pass[0]! };
const error = serializeCiError(outcome.reason, { secrets });
progress(`${mapOptions.side}: the ${pass.join("+")} session failed (${error.code}: ${error.message}); keeping the ${passes[0]!.join("+")} captures, and the report marks every ${pass.join("+")} frame failed`);
return { scheme: pass[0]!, error: { code: error.code, stage: error.stage, message: error.message, nextAction: error.nextAction, retryable: error.retryable } };
});
await mergeCaptureExports(mapOptions.outputDirectory, secondaries);
const result = primary.value;
return secondaries.some(secondary => "error" in secondary) ? { ...result, runStatus: "partial" } : result;
}
/**
@@ -435,7 +478,7 @@ export async function runCiReview(options: {
if (!options.runner) await prefetchControllers(config, environment, progress);
const pr = options.presentation;
const now = options.now ?? Date.now;
const secretValues = Object.entries(environment).filter(([key]) => /(?:TOKEN|SECRET|PASSWORD|API_KEY)/i.test(key)).flatMap(([, value]) => value ? [value] : []);
const secretValues = environmentSecrets(environment);
let stage = "plan";
let usagePhase: AgentUsagePhase = "preflight";
let preserveReport: (() => Promise<void>) | undefined;
@@ -500,7 +543,10 @@ export async function runCiReview(options: {
commit: pr.base.sha, selectedIds, directory: join(output, "base-cache"), runtimeProfile,
...(exploration.agent ? { captureContexts: exploration.agent.contexts } : {}) });
if (restored) reuseDirectory = join(output, "base-cache");
progress(restored ? `base: found the baseline captures of ${pr.base.sha.slice(0, 8)}` : `base: no compatible baseline of ${pr.base.sha.slice(0, 8)}; capturing the base too`);
const incomplete = restored ? undefined : await incompleteCaptureReason(cacheDirectory, pr.base.sha);
progress(restored ? `base: found the baseline captures of ${pr.base.sha.slice(0, 8)}`
: incomplete ? `base: the baseline of ${pr.base.sha.slice(0, 8)} has nothing to reuse (${incomplete}); capturing the base too`
: `base: no compatible baseline of ${pr.base.sha.slice(0, 8)}; capturing the base too`);
}
const mapOptions = { ...captureOptions(config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
...(options.useLocalEasSession ? { useLocalEasSession: true } : {}),
+6
View File
@@ -93,6 +93,12 @@ export type CaptureBundle = {
}>;
/** The exact observed frames explicitly accepted by the agent, never replacement screenshots. */
agentAcceptance?: { policy: typeof AGENT_ACCEPTANCE_POLICY; frames: Record<string, AgentAcceptedFrame> };
/**
* The appearance passes that failed while the primary one captured (a secondary session that failed, or a later pass of
* one session), each with its error. Every selected route then has a failed `<id>@<scheme>` outcome carrying it, when
* the bundle renders that appearance. Absent when every pass finished.
*/
sessionFailures?: Array<{ scheme: "light" | "dark"; error: NonNullable<CaptureOutcome["error"]> }>;
};
/** Bind acceptance receipts to captured images and, when supplied, their exported observations. */
+31 -7
View File
@@ -321,21 +321,34 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
if (notCompared) record.notCompared = notCompared;
record.context = splashLines(state.review);
const diagnostics = [...(state.evidence?.diagnostics ?? [])];
// A failed appearance pass is one issue, named first, rather than one per frame it left unavailable: in brentvatne/
// euxy's main baseline run 39506374824 the dark session's failure would have listed all 16 routes, crowding out the rest.
const sessionFailures = state.evidence?.sessionFailures ?? [];
if (sessionFailures.length) record.sessionFailures = sessionFailures.map(({ side, scheme, frames }) => ({ side, scheme, frames }));
const sessionLines = sessionFailures.map(failure => ({ side: failure.side, route: `${failure.scheme} session`, code: failure.code,
message: `${failure.message.replace(/\.+$/, "")}.${failure.frames ? ` ${plural(failure.frames, `${failure.scheme} frame`)} ${failure.frames === 1 ? "is" : "are"} unavailable.` : ""}`,
nextAction: failure.nextAction }));
const ofFailedPass = (surfaceId: string, side: "base" | "head", outcome: NonNullable<Surface["headOutcome"]>) => sessionFailures.some(failure => failure.side === side
&& schemeOf(surfaceId) === failure.scheme && outcome.error?.code === failure.code && outcome.error.message === failure.message);
for (const surface of state.review.surfaces) {
for (const side of ["base", "head"] as const) {
const outcome = surface[`${side}Outcome`];
if (!outcome || (outcome.status === "captured" && outcome.landing === "verified") || diagnostics.some(item => item.surfaceId === surface.id && item.side === side)) continue;
if (ofFailedPass(surface.id, side, outcome)) continue;
diagnostics.push({ surfaceId: surface.id, side, code: outcome.error?.code ?? (outcome.status === "captured" ? "CAPTURE_LANDING_UNVERIFIED" : "CAPTURE_UNAVAILABLE"),
stage: outcome.error?.stage ?? "capture", message: outcome.error?.message ?? outcome.reason ?? (outcome.status === "captured" ? "Destination route was not verified." : `Capture ${outcome.status}.`),
nextAction: outcome.error?.nextAction ?? "Check this side's capture diagnostics, correct the route configuration or capture failure, and rerun capture.", retryable: outcome.error?.retryable ?? false });
}
}
if (diagnostics.length) {
record.diagnostics = diagnostics.slice(0, 20).map(diagnostic => {
if (diagnostics.length || sessionLines.length) {
record.diagnostics = [...sessionLines, ...diagnostics.map(diagnostic => {
const surface = state.review!.surfaces.find(surface => surface.id === diagnostic.surfaceId);
return { ...(diagnostic.side ? { side: diagnostic.side } : {}), route: surface ? routeOf(surface) : diagnostic.surfaceId, code: diagnostic.code, message: diagnostic.message, nextAction: diagnostic.nextAction };
});
record.diagnosticCount = diagnostics.length;
// A secondary appearance's issue names its appearance, as its change row does: its light frame may be fine.
const scheme = schemeOf(diagnostic.surfaceId);
return { ...(diagnostic.side ? { side: diagnostic.side } : {}), route: `${surface ? routeOf(surface) : diagnostic.surfaceId}${surface && scheme ? ` (${scheme})` : ""}`,
code: diagnostic.code, message: diagnostic.message, nextAction: diagnostic.nextAction };
})].slice(0, 20);
record.diagnosticCount = sessionLines.length + diagnostics.length;
}
}
if (state.failure) record.failure = { step: state.failure.step, message: state.failure.message };
@@ -480,9 +493,11 @@ function title(records: PlatformRecord[], rows: ChangeRow[]): string {
}
// With screens left uncompared, nothing changed only among the ones compared.
const summary = rows.length ? `${plural(rows.length, "screen")} changed` : ready.some(record => gaps(record).length) ? "No compared screens changed" : "No screens changed";
// An appearance a pass never captured is said in the heading too: the verdict above says nothing about it.
const missing = [...new Set(ready.flatMap(record => (record.sessionFailures ?? []).map(failure => failure.scheme)))].map(scheme => `${scheme} not captured`);
const report = firstReport(ready);
const open = report ? link("Review in Explore", report) : ready.some(record => record.links.deploying) ? "report deploying…" : undefined;
return `### ${summary}${open ? ` · ${open}` : ""}`;
return `### ${[summary, ...missing, ...(open ? [open] : [])].join(" · ")}`;
}
/** Every target by name, each linking its own report, then the commits and when the comment last changed. */
@@ -512,12 +527,21 @@ function statusLine(record: PlatformRecord): string | undefined {
}
}
/** "dark not captured" for an appearance whose pass failed on head (or both sides), "… on base" when only the base's did. */
function missingAppearances(record: PlatformRecord): string[] {
const failures = record.sessionFailures ?? [];
return [...new Set(failures.map(failure => failure.scheme))].map(scheme => {
const sides = new Set(failures.filter(failure => failure.scheme === scheme).map(failure => failure.side));
return `${scheme} not captured${sides.size === 1 && sides.has("base") ? " on base" : ""}`;
});
}
/** What a finished target has no verdict on: captures missing or unattributed, comparisons that did not run or failed. */
function gaps(record: PlatformRecord): string[] {
const unavailable = record.health ? record.health.base.unavailable + record.health.head.unavailable : 0;
const unverified = record.health ? record.health.base.unverified + record.health.head.unverified : 0;
const failed = (record.validation?.visual?.failed ?? 0) + (record.validation?.accessibility?.failed ?? 0);
return [unavailable ? `${plural(unavailable, "capture")} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
return [...missingAppearances(record), unavailable ? `${plural(unavailable, "capture")} unavailable` : undefined, unverified ? `${unverified} unattributed` : undefined,
record.notCompared ? `${record.notCompared} not compared` : undefined, failed ? `${plural(failed, "comparison")} failed` : undefined]
.filter((part): part is string => Boolean(part));
}
+7
View File
@@ -115,6 +115,8 @@ export type PlatformRecord = {
navigation?: CommentNavigation;
diagnostics?: { side?: "base" | "head"; route: string; code: string; message: string; nextAction: string }[];
diagnosticCount?: number;
/** Appearance passes that failed while the primary one captured: that appearance was not captured on that side. */
sessionFailures?: { side: "base" | "head"; scheme: "light" | "dark"; frames: number }[];
failure?: { step: string; message: string };
/** The PR moved while this run worked; its report stays reachable but it is not the current review. */
superseded?: boolean;
@@ -287,6 +289,11 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
}
if (isCount(value.notCompared) && value.notCompared > 0) record.notCompared = value.notCompared;
if (isCount(value.diagnosticCount)) record.diagnosticCount = value.diagnosticCount;
if (Array.isArray(value.sessionFailures)) {
const failures = value.sessionFailures.flatMap((entry): NonNullable<PlatformRecord["sessionFailures"]> => isRecord(entry) && isSide(entry.side)
&& (entry.scheme === "light" || entry.scheme === "dark") && isCount(entry.frames) ? [{ side: entry.side, scheme: entry.scheme, frames: entry.frames }] : []).slice(0, 4);
if (failures.length) record.sessionFailures = failures;
}
if (isRecord(value.failure) && isString(value.failure.step, 200) && isString(value.failure.message)) record.failure = { step: value.failure.step, message: value.failure.message };
if (value.superseded === true) record.superseded = true;
return record;
+9 -2
View File
@@ -1,5 +1,5 @@
import type { RunTarget } from "../types.js";
import { appearancePairs, bundleColorSchemes, routeIdOfScreen } from "../capture/appearance.js";
import { appearancePairs, bundleColorSchemes, failedPassOutcome, routeIdOfScreen } from "../capture/appearance.js";
import { createHash } from "node:crypto";
import { lstat, readFile, realpath } from "node:fs/promises";
import { isAbsolute, relative, resolve, sep } from "node:path";
@@ -95,9 +95,11 @@ function secondaryPassOutcome(bundle: CaptureBundle, selected: ReadonlySet<strin
const { routeId, scheme } = routeIdOfScreen(id);
const own = bundle.outcomes[id];
const verified = own?.status === "captured" && own.landing === "verified";
return scheme !== undefined && selected.has(routeId) && verified !== (bundle.outcomes[routeId]?.status === "captured");
return scheme !== undefined && selected.has(routeId)
&& (verified !== (bundle.outcomes[routeId]?.status === "captured") || failedPassOutcome(bundle, id));
}
export async function readCaptureBundle(directory: string): Promise<CaptureBundle> {
const bundle = JSON.parse(await readFile(resolve(await realpath(directory), "bundle.json"), "utf8")) as CaptureBundle;
if (!bundle || bundle.contract !== "explore.bundle" || typeof bundle.gitCommit !== "string"
@@ -110,6 +112,11 @@ export async function readCaptureBundle(directory: string): Promise<CaptureBundl
throw new Error("Capture bundle completion timestamp is invalid");
}
if (bundle.appIcon !== undefined) assertAppIconRecord(bundle.appIcon);
if (bundle.sessionFailures !== undefined && (!Array.isArray(bundle.sessionFailures) || bundle.sessionFailures.some(failure => !failure
|| !["light", "dark"].includes(failure.scheme) || !failure.error || typeof failure.error.code !== "string" || typeof failure.error.message !== "string"
|| typeof failure.error.stage !== "string" || typeof failure.error.nextAction !== "string" || typeof failure.error.retryable !== "boolean"))) {
throw new Error("Capture bundle session failures are invalid");
}
if (bundle.launch !== undefined) assertLaunchRecords(bundle.launch);
const selected = new Set(bundle.selectedSurfaceIds);
if (selected.size !== bundle.selectedSurfaceIds.length
+13 -1
View File
@@ -1,5 +1,5 @@
import { unattributedIssue } from "../capture/health.js";
import { appearancePairs, bundleColorSchemes, type ColorScheme } from "../capture/appearance.js";
import { appearancePairs, bundleColorSchemes, failedPassOutcome, type ColorScheme } from "../capture/appearance.js";
import { launchSurfaceId, systemRegions as defaultSystemRegions, type SystemRegion } from "../contracts/capture.js";
import { readFileSync, statSync } from "node:fs";
import { stat } from "node:fs/promises";
@@ -79,8 +79,16 @@ export type PublicEvidenceSummary = {
comparison: { planned: number; eligible: number; skipped: number };
/** Every unavailable or unverified requested side, plus operational comparison errors. */
diagnostics: PublicEvidenceDiagnostic[];
/**
* Each appearance pass of a side that failed while its primary one captured (the bundle's `sessionFailures`), with how
* many of its frames the failure left unavailable: the comment names it once, not once per frame.
*/
sessionFailures?: PublicSessionFailure[];
};
export type PublicSessionFailure = { side: "base" | "head"; scheme: ColorScheme; frames: number;
code: string; stage: string; message: string; nextAction: string; retryable: boolean };
const MAX_SUMMARY_ERRORS = 5;
function recordError(errors: string[], surfaceId: string, error: unknown): void {
@@ -756,6 +764,9 @@ export async function assessPublicEvidence(options: {
}
}
const sessionFailures = (["base", "head"] as const).flatMap(side => (options[side].bundle.sessionFailures ?? []).map(({ scheme, error }): PublicSessionFailure => ({
side, scheme, frames: Object.keys(options[side].bundle.outcomes).filter(id => id.endsWith(`@${scheme}`) && failedPassOutcome(options[side].bundle, id)
&& options[side].bundle.outcomes[id]!.error?.message === error.message).length, ...error })));
return {
surfaces,
summary: {
@@ -763,6 +774,7 @@ export async function assessPublicEvidence(options: {
accessibility: accessibilityAvailable ? accessibilityCounts : null,
review: reviewCounts,
capture, comparison, diagnostics,
...(sessionFailures.length ? { sessionFailures } : {}),
},
};
}
+5
View File
@@ -55,6 +55,11 @@ export function ciErrorForCommand(error: unknown, command: string): CiError {
export type CiErrorRenderOptions = { secrets?: readonly string[] };
/** The values of every variable that names a secret (a token, secret, password or API key), to redact from what Explore writes. */
export function environmentSecrets(environment: NodeJS.ProcessEnv): string[] {
return Object.entries(environment).filter(([key]) => /(?:TOKEN|SECRET|PASSWORD|API_KEY)/i.test(key)).flatMap(([, value]) => value ? [value] : []);
}
function redact(value: string, secrets: readonly string[]): string {
let result = value;
// Controller failures may embed JSON or URLs inside their message rather than
+12
View File
@@ -2342,6 +2342,18 @@ test("on a phone, a Screens card's screenshot keeps its height while it loads an
assert.deepEqual(errors, []);
});
test("the Screens filmstrip shows a downloaded report's screenshots, resolved as the grid's are", { timeout: 60_000 }, async t => {
const { bytes } = await changedScreensArchive(3);
const { page, errors } = await harness(t, bytes, { app: true, open: false });
await chooseFile(page, bytes);
await expect(page.locator(".app-shell")).toBeVisible();
await page.goto(`${page.url().split("#")[0]}#/screens?layout=filmstrip`);
const middle = page.locator(".screens-strip-frame.focused img");
await expect(middle).toHaveAttribute("data-screenshot-state", "ready");
assert.match(await middle.getAttribute("src"), /^blob:/);
assert.deepEqual(errors, []);
});
test("a target switch blanks every card whose screenshot differs, never showing the other target's picture, and switching back reuses the kept pictures", { timeout: 90_000 }, async t => {
const runtime = { platform: "android", platforms: ["ios", "android"] };
const android = await changedScreensArchive(3, { seed: 1, runtime });
+2 -1
View File
@@ -453,7 +453,8 @@ test("a fold tried during a find changes nothing: the tree's own folds come back
await expect(other).toHaveAttribute("aria-expanded", "true");
await field.press("Escape");
await field.press("Escape");
await expect(field).toHaveCount(0);
await expect(field).toHaveValue("");
await expect(field).not.toBeFocused();
await expect(folder).toHaveAttribute("aria-expanded", "false");
await expect(other).toHaveAttribute("aria-expanded", "true");
+244 -12
View File
@@ -1402,6 +1402,236 @@ test("→ steps the Screens cards right after Screens is opened from the toolbar
await expect(grid.locator(`.screens-cell[data-screen-id="${expected}"] .screen-screenshot-card`)).toHaveClass(/selected/);
});
test("the Screens sidebar is headed by its find field with fold-all beside it, and Changed / All sits under it only when there are changes", async ({ page }) => {
// The fixture server's own report has no baseline, so no changes.
await page.goto("/screens");
const tree = page.getByRole("main", { name: "Screens" }).locator(".screens-tree");
const head = tree.locator(".screens-tree-head");
const field = head.getByRole("searchbox", { name: "Find screens" });
await expect(field).toBeVisible();
await expect(field).toHaveAttribute("placeholder", "Search");
await expect(head.getByRole("button", { name: "Collapse all" })).toBeVisible();
await expect(tree.locator(".screens-filter")).toHaveCount(0);
// Nothing sits above the field.
const treeBox = (await tree.boundingBox())!;
expect((await head.boundingBox())!.y - treeBox.y).toBeLessThan(16);
await serveWorkspace(page);
await page.goto("/screens");
const filter = tree.locator(".screens-filter");
await expect(filter).toBeVisible();
// Under the head, as wide as it.
const headBox = (await head.boundingBox())!;
const filterBox = (await filter.boundingBox())!;
expect(filterBox.y).toBeGreaterThanOrEqual(headBox.y + headBox.height);
expect(Math.abs(filterBox.width - headBox.width)).toBeLessThan(2);
});
test("Screens' filmstrip: switched from the corner switch, stepped with the arrows and clicks, opened by a double-click, left with Esc, and remembered", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const view = page.getByRole("main", { name: "Screens" });
await view.getByRole("button", { name: /^All/ }).click();
const cells = view.locator(".screens-grid .screens-cell");
const ids = await cells.evaluateAll(elements => elements.map(element => element.getAttribute("data-screen-id")!));
expect(ids.length).toBeGreaterThan(2);
const layouts = page.getByRole("group", { name: "Screens layout" });
await expect(layouts.getByRole("button", { name: "Grid" })).toHaveAttribute("aria-pressed", "true");
// The switch at the top right opens the filmstrip at the first screen, with nothing selected yet.
await layouts.getByRole("button", { name: "Filmstrip" }).click();
await expect(page).toHaveURL(/[?&]layout=filmstrip/);
const strip = view.getByRole("region", { name: "Filmstrip" });
const middle = strip.locator(".screens-strip-frame.focused");
await expect(middle).toHaveAttribute("data-screen-id", ids[0]!);
await expect(cells).toHaveCount(0);
// The sidebar is folded, and `/` opens it with the find field focused.
await expect(view.locator(".screens-tree")).toHaveCount(0);
// In the find field, ↓ and ↑ step from the screen in the middle too; Esc then hands the keyboard back.
await page.keyboard.press("/");
const field = view.getByRole("searchbox", { name: "Find screens" });
await expect(field).toBeFocused();
await page.keyboard.press("ArrowDown");
await expect(middle).toHaveAttribute("data-screen-id", ids[1]!);
await page.keyboard.press("ArrowUp");
await expect(middle).toHaveAttribute("data-screen-id", ids[0]!);
await page.keyboard.press("Escape");
await expect(field).not.toBeFocused();
await expect(strip).toBeVisible();
// → steps the middle frame through the screens in the grid's order.
await page.keyboard.press("ArrowRight");
await expect(middle).toHaveAttribute("data-screen-id", ids[1]!);
await expect(middle.locator(".screens-strip-target")).toBeFocused();
await page.keyboard.press("ArrowRight");
await expect(middle).toHaveAttribute("data-screen-id", ids[2]!);
await page.keyboard.press("ArrowLeft");
await expect(middle).toHaveAttribute("data-screen-id", ids[1]!);
// A neighbour comes to the middle when clicked, without opening the Inspector.
const inspector = page.getByRole("complementary", { name: "Inspector panel" });
await strip.locator(`.screens-strip-frame[data-screen-id="${ids[2]}"] .screens-strip-target`).click();
await expect(middle).toHaveAttribute("data-screen-id", ids[2]!);
await expect(inspector).toBeHidden();
// The switch's Grid goes back to the grid, keeping the selection.
await layouts.getByRole("button", { name: "Grid" }).click();
await expect(page).not.toHaveURL(/layout=/);
await expect(view.locator(`.screens-cell[data-screen-id="${ids[2]}"] .screen-screenshot-card`)).toHaveClass(/selected/);
// A double-click on a card opens it in the filmstrip. Its first click opens the Inspector, which narrows the grid: the
// last card of the first row moves before the second click lands, and it is still that card that opens.
await page.keyboard.press("Escape");
await expect(inspector).toBeHidden();
const tops = await cells.evaluateAll(elements => elements.map(element => Math.round(element.getBoundingClientRect().top)));
const last = ids[tops.filter(top => top === tops[0]).length - 1]!;
const box = (await view.locator(`.screens-cell[data-screen-id="${last}"] .screen-screenshot-target`).boundingBox())!;
const at = { x: box.x + box.width / 2, y: box.y + box.height / 2 };
await page.mouse.click(at.x, at.y);
await expect(inspector).toBeVisible();
// The second click of the pair, where the pointer still is.
await page.mouse.down({ clickCount: 2 });
await page.mouse.up({ clickCount: 2 });
await expect(middle).toHaveAttribute("data-screen-id", last);
await expect(inspector).toBeVisible();
// Esc closes the Inspector first, then steps back out to the grid with the screen still picked.
await page.keyboard.press("Escape");
await expect(inspector).toBeHidden();
await expect(strip).toBeVisible();
await page.keyboard.press("Escape");
await expect(strip).toHaveCount(0);
await expect(view.locator(`.screens-cell[data-screen-id="${last}"] .screen-screenshot-card`)).toHaveClass(/selected/);
// The layout is remembered for the report: Screens opens in the filmstrip again after a visit to the Map.
await layouts.getByRole("button", { name: "Filmstrip" }).click();
await chooseCanvasView(page, "Map");
await chooseCanvasView(page, "Screens");
await expect(page).toHaveURL(/[?&]layout=filmstrip/);
await expect(page.getByRole("region", { name: "Filmstrip" })).toBeVisible();
});
test("Screens' filmstrip keeps Changed across a layout switch, opens only from a screenshot, and is remembered through Search and links", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const view = page.getByRole("main", { name: "Screens" });
const layouts = page.getByRole("group", { name: "Screens layout" });
const strip = view.getByRole("region", { name: "Filmstrip" });
const cells = view.locator(".screens-grid .screens-cell");
const ids = () => cells.evaluateAll(elements => elements.map(element => element.getAttribute("data-screen-id")!));
// A double-click on a card's route copies a link and selects nothing, so it does not open the filmstrip.
await view.getByRole("button", { name: /^All/ }).click();
await cells.nth(1).locator(".screen-node-title").dblclick();
await expect(strip).toHaveCount(0);
// A click on one card and then a quick double-click on another opens the other.
const [firstId, secondId] = await ids();
await view.locator(`.screens-cell[data-screen-id="${firstId}"] .screen-screenshot-target`).click();
await view.locator(`.screens-cell[data-screen-id="${secondId}"] .screen-screenshot-target`).dblclick();
await expect(strip.locator(".screens-strip-frame.focused")).toHaveAttribute("data-screen-id", secondId!);
await layouts.getByRole("button", { name: "Grid" }).click();
await page.keyboard.press("Escape");
// A pick that Changed hides stays picked across a switch, and Changed stays on.
const all = await ids();
await view.getByRole("button", { name: /^Changed/ }).click();
const changed = await ids();
const hidden = all.find(id => !changed.includes(id));
test.skip(!hidden, "the fixture has no unchanged screen");
await view.getByRole("button", { name: /^All/ }).click();
await view.locator(`.screens-cell[data-screen-id="${hidden}"] .screen-screenshot-target`).click();
await page.keyboard.press("Escape");
await view.getByRole("button", { name: /^Changed/ }).click();
await layouts.getByRole("button", { name: "Filmstrip" }).click();
// The sidebar folds away with Changed in it; the button left in its place says the screens are narrowed, and Changed
// is still on behind it.
const show = view.getByRole("button", { name: "Show sidebar, showing changed screens only" });
await expect(show).toBeVisible();
await show.click();
await expect(view.getByRole("button", { name: "Hide sidebar" })).toBeFocused();
await expect(view.getByRole("button", { name: /^Changed/ })).toHaveAttribute("aria-pressed", "true");
// The middle is the nearest changed screen after the hidden pick in the tree, as the grid's arrows step from it.
const at = all.indexOf(hidden!);
const nearest = all.slice(at + 1).find(id => changed.includes(id)) ?? all.slice(0, at).reverse().find(id => changed.includes(id));
await expect(strip.locator(".screens-strip-frame.focused")).toHaveAttribute("data-screen-id", nearest!);
// A click on the page around the strip keeps the screen in the middle.
await view.click({ position: { x: 600, y: 4 } });
await expect(strip.locator(".screens-strip-frame.focused")).toHaveAttribute("data-screen-id", nearest!);
// Folded again by hand, the keyboard moves to the button left in its place.
await view.getByRole("button", { name: "Hide sidebar" }).click();
await expect(show).toBeFocused();
// Search opens Screens in the remembered layout, and landing there does not forget it.
await chooseCanvasView(page, "Map");
await page.getByRole("toolbar", { name: "Canvas tools" }).getByRole("button", { name: "Search", exact: true }).click();
const search = page.getByRole("dialog", { name: "Search Explore" });
await search.getByRole("combobox").fill("/current-profile");
await search.getByRole("option").filter({ hasText: "/current-profile" }).first().click();
await expect(page).toHaveURL(/\/screens.*[?&]layout=filmstrip/);
await expect(strip.locator(".screens-strip-frame.focused")).toHaveAttribute("data-screen-id", "current-profile");
// Switched back to the grid, Screens opens in the grid; a link that opens the filmstrip is remembered again.
await layouts.getByRole("button", { name: "Grid" }).click();
await chooseCanvasView(page, "Map");
await chooseCanvasView(page, "Screens");
await expect(page).not.toHaveURL(/layout=/);
await page.goto("/screens?layout=filmstrip");
await expect(strip).toBeVisible();
await chooseCanvasView(page, "Map");
await chooseCanvasView(page, "Screens");
await expect(page).toHaveURL(/[?&]layout=filmstrip/);
});
test("Screens' layouts switch with G and E, and the sidebar folds by its own buttons and on each switch to the filmstrip", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
const view = page.getByRole("main", { name: "Screens" });
const tree = view.locator(".screens-tree");
const strip = view.getByRole("region", { name: "Filmstrip" });
const show = view.getByRole("button", { name: "Show sidebar" });
// The grid opens with the sidebar; its head folds it away, and the button left in its place opens it again.
await expect(tree).toBeVisible();
await tree.getByRole("button", { name: "Hide sidebar" }).click();
await expect(tree).toHaveCount(0);
await show.click();
await expect(tree).toBeVisible();
// E opens the filmstrip, with the sidebar folded.
await page.keyboard.press("e");
await expect(page).toHaveURL(/[?&]layout=filmstrip/);
await expect(strip).toBeVisible();
await expect(tree).toHaveCount(0);
// G goes back to the grid, with the sidebar open, even though it was opened in the filmstrip.
await show.click();
await page.keyboard.press("g");
await expect(page).not.toHaveURL(/layout=/);
await expect(strip).toHaveCount(0);
await expect(tree).toBeVisible();
// Each switch to the filmstrip folds the sidebar again.
await page.keyboard.press("e");
await expect(strip).toBeVisible();
await expect(tree).toHaveCount(0);
// A find keeps the sidebar that shows it open on the switch to the filmstrip; folding the sidebar clears the find.
await page.keyboard.press("g");
const field = tree.getByRole("searchbox", { name: "Find screens" });
const firstTitle = (await view.locator(".screens-grid .screens-cell .screen-node-title").first().textContent())!;
await field.fill(firstTitle);
await field.blur();
await page.keyboard.press("e");
await expect(strip).toBeVisible();
await expect(tree).toBeVisible();
await expect(field).toHaveValue(firstTitle);
await tree.getByRole("button", { name: "Hide sidebar" }).click();
await show.click();
await expect(field).toHaveValue("");
// Elsewhere G and E do nothing.
await chooseCanvasView(page, "Map");
await page.keyboard.press("e");
await expect(page).not.toHaveURL(/\/screens/);
});
test("reuses the Map screenshot card in Screens, with the route under the screenshot at the card's left edge", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/screens");
@@ -5612,7 +5842,7 @@ test("in a window too short for it, the More menu scrolls", async ({ page }) =>
await expect(page.getByRole("menu", { name: "More" }).getByRole("menuitem", { name: "Keyboard shortcuts" })).toBeInViewport({ ratio: 1 });
});
test("the top right is the camera's alone: fit, center and zoom on the Map, nothing on Screens or Compare", async ({ page }) => {
test("the top right holds the camera on the Map, the layout switch on Screens, and nothing on Compare", async ({ page }) => {
await page.setViewportSize({ width: 1440, height: 900 });
await serveWorkspace(page);
await page.goto("/map");
@@ -5631,7 +5861,7 @@ test("the top right is the camera's alone: fit, center and zoom on the Map, noth
await expect(page).toHaveURL(/\/screens/);
await expect(page.locator(".screens-page .screens-cell").first()).toBeVisible();
await expect(page.locator(".canvas-camera-controls")).toHaveCount(0);
expect(await topRightButtons(page)).toEqual([]);
expect(await topRightButtons(page)).toEqual(["Grid", "Filmstrip"]);
await page.goto("/compare?screen=current-profile");
await expect(page.getByRole("region", { name: /^Compare / })).toBeVisible();
@@ -5653,13 +5883,13 @@ test("/ finds screens on the Screens page: the tree and the grid narrow to the q
.find(segment => segment && titles.filter(title => title.includes(segment)).length < titles.length)!;
expect(query).toBeTruthy();
// Opening the field does not move the tree under it: the head keeps one height in every state.
const heading = grid.locator(".screens-tree h2");
const headingTop = (await heading.boundingBox())!.y;
// Opening the field does not move the tree under it: the field takes the title's row, which keeps one height.
const firstRow = treeRows.first();
const rowTop = (await firstRow.boundingBox())!.y;
await page.keyboard.press("/");
const field = grid.getByRole("searchbox", { name: "Find screens" });
await expect(field).toBeFocused();
expect((await heading.boundingBox())!.y).toBe(headingTop);
expect((await firstRow.boundingBox())!.y).toBe(rowTop);
await field.fill(query);
const matching = titles.filter(title => title.toLowerCase().includes(query.toLowerCase()));
await expect(cells).toHaveCount(matching.length);
@@ -5690,9 +5920,10 @@ test("/ finds screens on the Screens page: the tree and the grid narrow to the q
await field.press("Escape");
await expect(field).toHaveValue("");
await expect(cells).toHaveCount(all);
// A second Esc hands the keyboard back to the page; the field stays, empty, at the head of the tree.
await field.press("Escape");
await expect(field).toHaveCount(0);
await expect(grid.getByRole("button", { name: "Find a screen" })).toBeVisible();
await expect(field).not.toBeFocused();
await expect(field).toBeVisible();
// From the Map, "/" opens Screens with the field focused.
await chooseCanvasView(page, "Map");
@@ -5769,7 +6000,7 @@ test("⌘K steps through its results in the order it shows them, and a command t
await expect(page.locator(".changes-menu-body")).toBeFocused();
});
test("a / from the Map opens the find once: Screens opened again from the toolbar comes up without it", async ({ page }) => {
test("a / from the Map focuses the find once: Screens opened again from the toolbar comes up with the field unfocused", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/map");
await page.keyboard.press("/");
@@ -5777,13 +6008,14 @@ test("a / from the Map opens the find once: Screens opened again from the toolba
const field = grid.getByRole("searchbox", { name: "Find screens" });
await expect(field).toBeFocused();
await field.press("Escape");
await expect(field).toHaveCount(0);
await expect(field).not.toBeFocused();
await chooseCanvasView(page, "Map");
await chooseCanvasView(page, "Screens");
await expect(grid.locator(".screens-grid .screens-cell").first()).toBeVisible();
await expect(grid.getByRole("button", { name: "Find a screen" })).toBeVisible();
await expect(field).toHaveCount(0);
await expect(field).toBeVisible();
await expect(field).not.toBeFocused();
await expect(field).toHaveValue("");
});
test("the find's keys stay in its field: Return on the clear button clears, and Return while composing text opens nothing", async ({ page }) => {
+49
View File
@@ -4,7 +4,11 @@ import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { createServer } from "node:http";
import { startArgentBridgeRunner } from "../../dist/capture/argent-bridge-host.js";
import { argentClientCall } from "../../dist/capture/argent-bridge-worker.js";
import { argentRunFailureDetail } from "../../dist/capture/argent-bridge.js";
import { runBridgeCommand } from "../../dist/capture/argent-driver.js";
import { ARGENT_VERSION } from "../../dist/shared/argent-version.js";
const PNG = Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "base64");
@@ -133,3 +137,48 @@ test("a recording runs per command, and a screenshot is taken only from a file t
assert.match(failed.error.message, /did not write/);
await assert.rejects(readFile(join(root, "out", "two.png")), { code: "ENOENT" });
});
test("the thread's lines about a tool-server still starting reach the capture's log with the command's answer", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
// Argent's client asks GET /tools before each call; the first one is answered 404, as on euxy's main baseline run 39506374824.
const clientModule = await fakeClient(root, `
if (name === "list-devices" && calls.filter(call => call.name === "list-devices").length === 1) throw new Error("GET /tools failed: 404 Not Found");
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
if (name === "await-screen-idle") return { data: { settled: true } };
throw new Error("unexpected tool " + name);`);
const messages = [];
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/tools", HOME: root, PATH: process.env.PATH };
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule, progress: message => messages.push(message),
fallback: () => assert.fail("the thread serves every command") });
t.after(() => bridge.close());
const waited = JSON.parse(bridge.runner({ command: "/opt/argent-controller", args: ["wait", "stable", "--session", "explore", "--platform", "ios", "--json"], cwd: root, environment, timeoutMs: 20_000 }).stdout);
assert.deepEqual(waited, { success: true, data: { stable: true } });
assert.deepEqual(messages, ["Argent's tool-server is not serving its tools yet (argent run list-devices failed: GET /tools failed: 404 Not Found); sending list-devices again in 1 s (75 s left of 75 s)"]);
});
test("a refused connection to a localhost tool-server, whose cause is an AggregateError with no message, is the tool-server still starting", async () => {
// A port nothing listens on: bound, then closed.
const port = await new Promise(resolve => { const server = createServer().listen(0, "127.0.0.1", () => { const { port } = server.address(); server.close(() => resolve(port)); }); });
const client = { async callTool() { const response = await fetch(`http://localhost:${port}/tools`); return { data: await response.json() }; } };
const call = argentClientCall(client, () => new AbortController().signal);
const refused = await call("list-devices", {}).then(() => assert.fail("nothing listens"), error => error);
assert.match(refused.message, /^argent run list-devices failed: fetch failed: .*ECONNREFUSED/);
// Through the bridge, the refusal is waited out like a 404 from /tools, until the window ends.
let now = 0, tries = 0;
const result = await runBridgeCommand(["snapshot", "--platform", "ios", "--json"], { state: { generation: 0 }, platform: "ios", version: "0.29.0",
now: () => now, sleep: async milliseconds => { now += milliseconds; }, reachable: async () => true, moveFile: async () => {},
call: async (tool, args, options) => { tries++; return call(tool, args, options); } });
assert.equal(JSON.parse(result.stdout).error.code, "TOOL_SERVER_NOT_READY");
assert.equal(tries, 11);
});
test("a failed argent run keeps the line saying /tools is not served ahead of the stack trace that follows it", () => {
const stderr = ["[argent] Unhandled rejection: Error: GET /tools failed: 404 Not Found", " at fetchTools (file:///argent/dist/cli-cmds.mjs:10065:21)",
" at async fetchTool (file:///argent/dist/cli-cmds.mjs:10070:19)", " at async run (file:///argent/dist/cli-cmds.mjs:31166:17)",
" at async main (file:///argent/dist/cli.js:12:3)"].join("\n");
const detail = argentRunFailureDetail(stderr, "");
assert.ok(detail.startsWith("[argent] Unhandled rejection: Error: GET /tools failed: 404 Not Found | at fetchTools "), detail);
assert.ok(detail.endsWith("at async main (file:///argent/dist/cli.js:12:3)"), "the last frames follow it");
assert.equal(argentRunFailureDetail("Tool \"gesture-tap\" not found. Run `argent tools` to list available tools.\n", ""), "Tool \"gesture-tap\" not found. Run `argent tools` to list available tools.");
assert.equal(argentRunFailureDetail("GET /tools failed: 503 Service Unavailable\n", ""), "GET /tools failed: 503 Service Unavailable", "a line named once");
});
+81
View File
@@ -302,6 +302,87 @@ test("an unreachable tool-server before a UI action is the retryable 'Remote dae
assert.ok(!calls.some(call => call.tool === "gesture-tap"));
});
// brentvatne/euxy's main baseline run 39506374824: a replacement session's tool-server answered 404 to /tools for the
// first list-devices of its install, before it served its tools.
const TOOLS_404 = "argent run list-devices failed: GET /tools failed: 404 Not Found";
/** A clock the harness's pauses (and, given `requestMs`, its requests) move forward. */
function withClock(context, requestMs = () => 0) {
const clock = { now: 0, pauses: [], timeouts: [] };
context.now = () => clock.now;
context.sleep = async milliseconds => { clock.pauses.push(milliseconds); clock.now += milliseconds; };
const call = context.call;
context.call = async (tool, args, options) => {
if (options?.timeoutMs !== undefined) clock.timeouts.push(options.timeoutMs);
clock.now += Math.min(requestMs(tool), options?.timeoutMs ?? Infinity);
return call(tool, args, options);
};
return clock;
}
test("a tool-server that does not serve /tools yet is asked again, with a log line, until it does", async () => {
const { run, calls, context } = harness("ios", { "list-devices": [new ArgentCallError(TOOLS_404, true), new ArgentCallError(TOOLS_404, true), IOS_DEVICES], "reinstall-app": {} }, { bundleId: BUNDLE });
const clock = withClock(context);
const lines = [];
context.progress = line => lines.push(line);
assert.deepEqual((await run(["install", "/work/bundle/euxy.app", ...flags("ios")])).json.data, { installed: true, appBundleId: BUNDLE });
assert.equal(calls.filter(call => call.tool === "list-devices").length, 3);
assert.deepEqual(clock.pauses, [1_000, 2_000]);
assert.deepEqual(lines, [
"Argent's tool-server is not serving its tools yet (argent run list-devices failed: GET /tools failed: 404 Not Found); sending list-devices again in 1 s (75 s left of 75 s)",
"Argent's tool-server is not serving its tools yet (argent run list-devices failed: GET /tools failed: 404 Not Found); sending list-devices again in 2 s (74 s left of 75 s)"]);
assert.equal(context.state.toolsServed, true);
assert.deepEqual(clock.timeouts, [75_000, 74_000, 72_000], "each try gets only what is left of the window");
assert.equal(calls.filter(call => call.tool === "reinstall-app")[0].options, undefined, "a served tool-server's calls keep their own timeout");
});
test("a refused connection or a 503 from /tools is the tool-server still starting too", async () => {
for (const failure of ["fetch failed: connect ECONNREFUSED 127.0.0.1:9", "GET /tools failed: 503 Service Unavailable"]) {
const starting = new ArgentCallError(`argent run list-devices failed: ${failure}`, true);
const { run, calls, context } = harness("ios", { "list-devices": [starting, starting, starting, IOS_DEVICES], "ui-tree": IOS_HOME });
withClock(context);
assert.equal((await run(["snapshot", ...flags("ios")])).exitCode, 0, failure);
assert.equal(calls.filter(call => call.tool === "list-devices").length, 4, "asked past the two read retries");
}
});
test("a tool-server that never serves /tools fails with a clear error 75 s after the first try", async () => {
const { run, calls, context } = harness("ios", { "list-devices": new ArgentCallError(TOOLS_404, true), "reinstall-app": {} }, { bundleId: BUNDLE });
const clock = withClock(context);
const failed = await run(["install", "/work/bundle/euxy.app", ...flags("ios")]);
assert.deepEqual(failed.json.error, { code: "TOOL_SERVER_NOT_READY", message: `Argent's tool-server did not start serving its tools within 75 s: ${TOOLS_404}` });
assert.equal(clock.now, 75_000);
assert.equal(calls.filter(call => call.tool === "list-devices").length, 11);
assert.ok(!calls.some(call => call.tool === "reinstall-app"));
});
test("slow answers count against the 75 s too: each try is cut to the time left, and the wait ends on time", async () => {
const slow = new ArgentCallError("argent run list-devices failed: GET /tools failed: 503 Service Unavailable", true);
const { run, calls, context } = harness("ios", { "list-devices": slow, "reinstall-app": {} }, { bundleId: BUNDLE });
// Each 503 takes 30 s to come back, as a gateway's might.
const clock = withClock(context, () => 30_000);
assert.equal((await run(["install", "/work/bundle/euxy.app", ...flags("ios")])).json.error.code, "TOOL_SERVER_NOT_READY");
assert.equal(clock.now, 75_000, "not eleven 30 s tries");
assert.deepEqual(clock.timeouts, [75_000, 44_000, 12_000]);
assert.equal(calls.filter(call => call.tool === "list-devices").length, 3);
});
test("an unknown tool's 404 after the tool-server is up fails at once, and a later /tools 404 keeps only the read retries", async () => {
const unknown = 'argent run gesture-tap failed: Tool "gesture-tap" not found';
const { run, calls, context } = harness("ios", { "list-devices": IOS_DEVICES, "ui-tree": IOS_HOME, "gesture-tap": new ArgentCallError(unknown, true) });
const pauses = [];
context.sleep = async milliseconds => { pauses.push(milliseconds); };
assert.deepEqual((await run(["press", "10", "10", ...flags("ios")])).json.error, { code: "ARGENT_TOOL_FAILED", message: unknown });
assert.equal(calls.filter(call => call.tool === "gesture-tap").length, 1);
assert.deepEqual(pauses, []);
const served = harness("ios", { "list-devices": IOS_DEVICES, "ui-tree": new ArgentCallError("argent run ui-tree failed: GET /tools failed: 404 Not Found", true) },
{ state: { generation: 0, udid: UDID, toolsServed: true } });
served.context.sleep = async milliseconds => { pauses.push(milliseconds); };
assert.equal((await served.run(["snapshot", ...flags("ios")])).json.error.code, "ARGENT_TOOL_FAILED");
assert.equal(served.calls.filter(call => call.tool === "ui-tree").length, 3);
assert.deepEqual(pauses, [1_000, 2_000]);
});
test("a UI action whose answer is lost is reported once and never retried", async () => {
const { run, calls } = harness("ios", { "list-devices": IOS_DEVICES, "ui-tree": IOS_HOME, "gesture-tap": new ArgentCallError("argent run gesture-tap failed: socket hang up", true) });
const pressed = await run(["press", "10", "10", ...flags("ios")]);
+68 -8
View File
@@ -9,7 +9,9 @@ import { AGENT_DEVICE_VERSION, EAS_CLI_VERSION } from "../../dist/capture/run.js
import { readExportedMap } from "../../dist/review/evidence-assessment.js";
import { ExploreStore, recordObservation } from "../../dist/map/store.js";
const { captureRecipeConfig, restoreCaptureArtifactCache, writeCaptureArtifactCache } = await tsImport("../../src/ci/artifact-cache.ts", import.meta.url);
const { captureRecipeConfig, incompleteCaptureReason, restoreCaptureArtifactCache, validateEvidence, writeCaptureArtifactCache } = await tsImport("../../src/ci/artifact-cache.ts", import.meta.url);
const { mergeCaptureExports } = await tsImport("../../src/ci/export-merge.ts", import.meta.url);
const { captureHealthIssues, partitionCaptureHealthIssues } = await tsImport("../../src/capture/health.ts", import.meta.url);
const { readCaptureBundle } = await tsImport("../../src/review/capture-review.ts", import.meta.url);
const { CAPTURE_OBSERVER_HASH } = await tsImport("../../src/capture/observer.ts", import.meta.url);
const { AGENT_ACCEPTANCE_POLICY } = await tsImport("../../src/contracts/capture.ts", import.meta.url);
@@ -36,7 +38,7 @@ function acceptedFrames(bundle) {
}])) };
}
async function fixture(t, { missingAccessibility = false, partial = false } = {}) {
async function fixture(t, { missingAccessibility = false, partial = false, appearances = false, darkFrames = appearances } = {}) {
const root = await mkdtemp(join(tmpdir(), "explore-capture-artifact-cache-"));
t.after(() => rm(root, { recursive: true, force: true }));
const store = new ExploreStore(join(root, "active"));
@@ -47,7 +49,7 @@ async function fixture(t, { missingAccessibility = false, partial = false } = {}
id: "capture-run", name: "Cache evidence", platform: "ios", controller: "agent-device", status: "draft",
createdAt: timestamp, updatedAt: timestamp,
build: { id: "eas-build", gitCommit: COMMIT, source: "eas" },
environment: { ...RUNTIME, authState: "logged-out" },
environment: { ...RUNTIME, authState: "logged-out", ...(appearances ? { colorSchemes: ["light", "dark"] } : {}) },
limits: { maxScreens: 20, maxActions: 100, maxDurationMinutes: 60 },
},
screens: [], variants: [], observations: [], elements: [], artifacts: [],
@@ -58,7 +60,7 @@ async function fixture(t, { missingAccessibility = false, partial = false } = {}
const snapshotPath = join(root, "sample.json");
await writeFile(screenshotPath, PNG);
const images = {};
for (const id of ["home", "settings"]) {
for (const id of darkFrames ? ["home", "settings", "home@dark", "settings@dark"] : ["home", "settings"]) {
const snapshotText = JSON.stringify({ nodes: [{ type: "text", label: id }] });
await writeFile(snapshotPath, snapshotText);
const result = await recordObservation({
@@ -81,15 +83,17 @@ async function fixture(t, { missingAccessibility = false, partial = false } = {}
await store.exportTo(sourceDirectory, map);
const bundle = {
contract: "explore.bundle", side: "head", gitCommit: COMMIT,
easBuildId: "eas-build", easProjectId: "eas-project", profile: RECIPE.profile, runtimeProfile: RUNTIME,
easBuildId: "eas-build", easProjectId: "eas-project", profile: RECIPE.profile, runtimeProfile: appearances ? { ...RUNTIME, colorSchemes: "light,dark" } : RUNTIME,
selectedSurfaceIds: ["home", "settings"], images,
outcomes: Object.fromEntries(Object.entries(images).map(([id, image]) => [id, { status: "captured", attempts: 1, landing: "verified", screenshotSha256: image.sha256 }])),
// A dark frame verified beside its light one has no outcome of its own, as the passes merge them.
outcomes: Object.fromEntries(Object.entries(images).filter(([id]) => !id.endsWith("@dark"))
.map(([id, image]) => [id, { status: "captured", attempts: 1, landing: "verified", screenshotSha256: image.sha256 }])),
};
await writeFile(join(sourceDirectory, "bundle.json"), JSON.stringify(bundle));
await writeFile(join(sourceDirectory, "execution.json"), JSON.stringify(EXECUTION));
// Construct actual exported, validated evidence; this fixture cannot pass with stub JSON maps.
assert.equal((await readExportedMap(sourceDirectory)).observations.length, 2);
const options = { ...RECIPE, sourceDirectory, directory: join(root, "restored"), commit: COMMIT, selectedIds: ["home", "settings"], runtimeProfile: RUNTIME };
assert.equal((await readExportedMap(sourceDirectory)).observations.length, darkFrames ? 4 : 2);
const options = { ...RECIPE, sourceDirectory, directory: join(root, "restored"), commit: COMMIT, selectedIds: ["home", "settings"], runtimeProfile: bundle.runtimeProfile };
return { root, sourceDirectory, map, bundle, options };
}
@@ -302,6 +306,62 @@ test("partial captures reuse only the screens with complete successful evidence"
assert.equal(await restoreCaptureArtifactCache({ ...f.options, directory: join(f.root, "failed-only"), selectedIds: ["settings"] }), false);
});
test("a baseline whose dark session failed is cached, and a review captures the routes without a dark frame itself", async t => {
// brentvatne/euxy's main baseline run 39506374824: the light session captured every route and the dark session failed.
const failedDark = { status: "failed", attempts: 0, landing: "unverified", reason: "install: argent run list-devices failed: GET /tools failed: 404 Not Found",
error: { code: "CAPTURE_SESSION_FAILED", stage: "session", message: "install: argent run list-devices failed: GET /tools failed: 404 Not Found", nextAction: "Rerun the capture.", retryable: false } };
const f = await fixture(t, { partial: true, appearances: true });
const complete = structuredClone(f.bundle);
assert.equal(await writeCaptureArtifactCache(f.sourceDirectory, RECIPE), true);
assert.equal(await restoreCaptureArtifactCache(f.options), true, "a baseline with every appearance is reused whole");
assert.deepEqual(Object.keys((await readCaptureBundle(f.options.directory)).images).sort(), ["home", "home@dark", "settings", "settings@dark"]);
for (const id of ["home", "settings"]) { delete f.bundle.images[`${id}@dark`]; f.bundle.outcomes[`${id}@dark`] = failedDark; }
f.bundle.sessionFailures = [{ scheme: "dark", error: failedDark.error }];
await writeFile(join(f.sourceDirectory, "bundle.json"), JSON.stringify(f.bundle));
// No route has its dark frame: offering it would make a review wait for it and capture its sides in turn, only to
// capture every route of the base itself.
assert.equal(await writeCaptureArtifactCache(f.sourceDirectory, RECIPE), false, "a baseline with nothing to reuse is not offered");
assert.equal(await restoreCaptureArtifactCache({ ...f.options, directory: join(f.root, "no-dark") }), false);
assert.equal(await incompleteCaptureReason(f.sourceDirectory, COMMIT), "its dark session failed, so no route has every appearance");
assert.equal(await incompleteCaptureReason(f.sourceDirectory, "b".repeat(40)), undefined, "another commit's baseline is the usual miss");
const mixed = structuredClone(complete);
delete mixed.images["settings@dark"]; mixed.outcomes["settings@dark"] = failedDark; delete mixed.sessionFailures;
await writeFile(join(f.sourceDirectory, "bundle.json"), JSON.stringify(mixed));
assert.equal(await writeCaptureArtifactCache(f.sourceDirectory, RECIPE), true);
assert.equal(await restoreCaptureArtifactCache({ ...f.options, directory: join(f.root, "mixed") }), true);
const restored = await readCaptureBundle(join(f.root, "mixed"));
assert.deepEqual(restored.selectedSurfaceIds, ["home"], "settings has no dark frame, so the review's base captures it in both appearances");
assert.deepEqual(Object.keys(restored.images).sort(), ["home", "home@dark"]);
assert.deepEqual(Object.keys(restored.outcomes), ["home"]);
});
test("a light session's real export merged with a failed dark session is valid evidence, a valid map, and healthy but for dark", async t => {
// The light session of a side split over sessions: it renders light and dark, and took light alone.
const f = await fixture(t, { appearances: true, darkFrames: false });
const error = { code: "CAPTURE_SESSION_FAILED", stage: "session", message: "install: argent run list-devices failed: GET /tools failed: 404 Not Found",
nextAction: "Rerun the capture.", retryable: true };
// The light session lost /settings.
delete f.bundle.images.settings;
f.bundle.outcomes.settings = { status: "failed", attempts: 2, landing: "unverified", reason: "The route observer never answered." };
await writeFile(join(f.sourceDirectory, "bundle.json"), JSON.stringify(f.bundle));
await mergeCaptureExports(f.sourceDirectory, [{ scheme: "dark", error }]);
const map = await readExportedMap(f.sourceDirectory);
assert.equal(map.run.status, "partial");
assert.equal(map.run.stopReason, `The dark session failed (CAPTURE_SESSION_FAILED): ${error.message}.`);
const bundle = await readCaptureBundle(f.sourceDirectory);
assert.deepEqual(Object.keys(bundle.outcomes).sort(), ["home", "home@dark", "settings", "settings@dark"]);
// Each dark frame carries the dark session's reason, the one light lost too: the review shows it, not light's.
assert.equal(bundle.outcomes["settings@dark"].reason, error.message);
assert.equal(bundle.outcomes.settings.reason, "The route observer never answered.");
await validateEvidence(f.sourceDirectory, bundle);
const issues = partitionCaptureHealthIssues(captureHealthIssues(bundle, ["home", "settings"]));
assert.deepEqual(issues.integrity, []);
assert.deepEqual(issues.unavailable.map(issue => [issue.surfaceId, issue.code]), [["home@dark", "CAPTURE_SESSION_FAILED"], ["settings", "CAPTURE_FAILED"]]);
assert.equal(await writeCaptureArtifactCache(f.sourceDirectory, RECIPE), false, "valid, but nothing in it a review could reuse");
});
test("partial caches retain verified targets without restoring captured but unverified screenshots", async t => {
const f = await fixture(t, { partial: true });
f.bundle.outcomes.settings.landing = "unverified";
+47
View File
@@ -562,6 +562,36 @@ test('an app that follows the system appearance is captured light then dark, dar
assert.equal(execution.colorScheme, 'light');
});
test('a single session whose dark pass fails keeps its light captures and marks every dark frame failed, as split sessions do', async t => {
// brentvatne/euxy's main baseline run 39506374824 split the appearances over two sessions; one session must read the same.
const f = await fixture(t, { userInterfaceStyle: 'automatic' });
const lines = [];
const result = await runCiMap({ ...f.options, progress: line => lines.push(line), runner: request => {
if (request.args[0] === 'settings' && request.args[2] === 'dark') throw new Error('Controller settings exited with status 1: the device stopped answering');
return f.options.runner(request);
} });
assert.equal(result.runStatus, 'partial');
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
assert.deepEqual(Object.keys(bundle.images).sort(), [f.ids.home, f.ids.settings].sort());
for (const id of Object.values(f.ids)) {
assert.equal(bundle.outcomes[id].status, 'captured');
assert.equal(bundle.outcomes[`${id}@dark`].status, 'failed');
assert.match(bundle.outcomes[`${id}@dark`].error.message, /the device stopped answering/);
}
assert.deepEqual(bundle.sessionFailures.map(failure => failure.scheme), ['dark']);
const map = JSON.parse(await readFile(join(f.options.outputDirectory, 'screen-map.json'), 'utf8'));
assert.equal(map.run.status, 'partial');
assert.match(map.run.stopReason, /^The dark pass failed \(/);
assert.ok(lines.some(line => /the dark pass failed .*keeping the light captures/.test(line)), lines.join('\n'));
assert.equal(f.operations().filter(operation => operation === 'simulator:stop').length, 1);
// A checkout that changed under the dark pass casts doubt on the light frames too: the capture fails.
const g = await fixture(t, { userInterfaceStyle: 'automatic' });
await assert.rejects(runCiMap({ ...g.options, runner: request => {
if (request.args[0] === 'settings' && request.args[2] === 'dark') throw new CiError({ code: 'SOURCE_CHECKOUT_CHANGED', stage: 'source', message: 'The application checkout differs from its recorded commit.', nextAction: 'Rerun.' });
return g.options.runner(request);
} }), error => error.code === 'SOURCE_CHECKOUT_CHANGED');
});
test('an app pinned to one appearance is captured once, in that appearance', async t => {
const f = await fixture(t, { userInterfaceStyle: 'dark' });
const result = await runCiMap(f.options);
@@ -780,6 +810,15 @@ test('a start that fails before naming a session stops any session of that name
assert.equal(always.requests.filter(request => request.args[0] === 'simulator:stop' && value(request, '--id') === 'orphan-1').length, 6);
});
test('a session a failed start left that does not stop is reported as left running, not as a start failure', async t => {
// No session file names it, so a split side would otherwise keep its other appearance and hide it.
const f = await fixture(t, { startsUnnamed: 1, orphanFromFailedStart: true });
await assert.rejects(runCiMap({ ...f.options, sleep: () => {}, runner: request => {
if (request.args[0] === 'simulator:stop' && value(request, '--id') === 'orphan-1') throw new Error('Controller simulator:stop exited with status 1: network unreachable');
return f.options.runner(request);
} }), error => error.code === 'SESSION_CLEANUP_FAILED' && /orphan-1/.test(error.message));
});
test('a session of that name Explore cannot prove is its own is never stopped or replaced', async t => {
const f = await fixture(t, { startsUnnamed: 1, orphanFromFailedStart: true, orphanUnproven: true });
await assert.rejects(runCiMap({ ...f.options, sleep: () => {} }), error => error.code === 'SIMULATOR_START_FAILED');
@@ -1943,6 +1982,14 @@ test('a failed hosted repack job stops the capture as EAS_REPACK_FAILED with the
assert.deepEqual(f.operations().filter(operation => operation.startsWith('simulator:')).filter(operation => operation !== 'simulator:availability'), ['simulator:start', 'simulator:stop']);
});
test('a session started beside a repack that failed, and that does not stop, is the failure reported', async t => {
const f = await fixture(t, { workflowFailure: true });
await assert.rejects(runCiMap({ ...f.options, runner: request => {
if (request.args[0] === 'simulator:stop') throw new Error('Controller simulator:stop exited with status 1: network unreachable');
return f.options.runner(request);
} }), error => error.code === 'SESSION_CLEANUP_FAILED' && error.details.originalFailure.code === 'EAS_REPACK_FAILED');
});
const runs = f => f.operations().filter(operation => operation === 'workflow:run').length;
const sessionOperations = f => f.operations().filter(operation => /^simulator:(start|stop)$/.test(operation));
// The upload step of brentvatne/euxy#176 (review run 39506405687), refused once the build had repacked.
+51
View File
@@ -0,0 +1,51 @@
import assert from "node:assert/strict";
import { readFile, readdir } from "node:fs/promises";
import { createRequire } from "node:module";
import { join, relative } from "node:path";
import test from "node:test";
import { fileURLToPath } from "node:url";
// A fake EAS accepts any flag, so a flag the pinned eas-cli does not have passes every other test and fails only on a
// real runner: 0.20.6 sent `env:list --non-interactive`, which eas-cli 25.2.0 refuses, so every capture logged "EAS did
// not list the development environment's variables" and never shared a repack (brentvatne/euxy review run 39517635857).
// Every literal `eas` command in src is checked against the command manifest of the eas-cli package.json pins.
const root = fileURLToPath(new URL("../..", import.meta.url));
const manifest = JSON.parse(await readFile(createRequire(join(root, "package.json")).resolve("eas-cli/oclif.manifest.json"), "utf8")).commands;
const commands = new Map();
for (const [id, command] of Object.entries(manifest)) {
commands.set(id, command);
for (const alias of command.aliases ?? []) commands.set(alias, command);
}
async function sources(directory) {
const files = [];
for (const entry of await readdir(directory, { withFileTypes: true })) {
const path = join(directory, entry.name);
if (entry.isDirectory()) files.push(...await sources(path));
else if (entry.name.endsWith(".ts")) files.push(path);
}
return files;
}
test("every literal eas command in src names a flag the pinned eas-cli has", async () => {
const checked = new Set();
const unknown = [];
for (const file of await sources(join(root, "src"))) {
const text = await readFile(file, "utf8");
// An argument list that starts with a command id, up to its closing bracket.
for (const match of text.matchAll(/\[\s*"([a-z]+(?::[a-z-]+)+)"([^\]]*)\]/g)) {
const command = commands.get(match[1]);
if (!command) continue; // Explore's own commands (source:verify, explore:binary, …) share the shape.
checked.add(match[1]);
const flags = command.flags ?? {};
for (const flag of match[2].matchAll(/"--([a-z0-9-]+)(?:=[^"]*)?"/g)) {
if (!(flag[1] in flags)) unknown.push(`${relative(root, file)}: eas ${match[1]} --${flag[1]}`);
}
}
}
assert.deepEqual(unknown, []);
// The scan finds the commands capture depends on, so it cannot pass by matching nothing.
for (const id of ["env:list", "build:list", "build:view", "workflow:run", "workflow:view", "workflow:cancel", "simulator:start", "simulator:stop", "simulator:control"]) {
assert.ok(checked.has(id), `eas ${id} was not found in src`);
}
});
+112 -1
View File
@@ -6,6 +6,8 @@ import test from "node:test";
import { mergeSchemeOutcomes } from "../../dist/capture/appearance.js";
import { mergeCaptureExports } from "../../dist/ci/export-merge.js";
import { captureSideInSessions } from "../../dist/ci/pipeline.js";
import { CiError } from "../../dist/shared/ci-errors.js";
async function writeExport(root, { screens, images, outcomes, launch, diagnostics }) {
await mkdir(join(root, "artifacts"), { recursive: true });
@@ -20,7 +22,8 @@ async function writeExport(root, { screens, images, outcomes, launch, diagnostic
screens: screens.map(id => ({ id, colorScheme: id.endsWith("@dark") ? "dark" : "light" })), variants: [], observations: screens.map(id => ({ screenId: id })),
elements: [], actionAttempts: [], transitions: [], journeys: [], frontier: [], gaps: [] };
await writeFile(join(root, "screen-map.json"), JSON.stringify(map));
await writeFile(join(root, "bundle.json"), JSON.stringify({ contract: "explore.bundle", side: "head", runtimeProfile: { colorSchemes: "light,dark" }, images, outcomes, ...(launch ? { launch } : {}) }));
await writeFile(join(root, "bundle.json"), JSON.stringify({ contract: "explore.bundle", side: "head", runtimeProfile: { colorSchemes: "light,dark" },
selectedSurfaceIds: [...new Set(Object.keys(outcomes).map(id => id.replace(/@(light|dark)$/, "")))], images, outcomes, ...(launch ? { launch } : {}) }));
await writeFile(join(root, "manifest.json"), JSON.stringify({ contract: "explore.map", runId: "run", revision: 1, files: artifacts.map(({ id: _id, ...file }) => file) }));
await writeFile(join(root, "capture-diagnostics", "controller-timing.jsonl"), diagnostics);
return root;
@@ -94,3 +97,111 @@ test("a dark session that could not show dark (Argent without appearance.set) ad
await mergeCaptureExports(primary, [{ directory: gapped, scheme: "dark" }]);
assert.equal(JSON.parse(await readFile(mapPath, "utf8")).run.status, "partial", "a complete run has no open gaps");
});
// brentvatne/euxy's main baseline run 39506374824: the light session captured every route, then the dark session's install failed.
const DARK_FAILURE = { code: "CAPTURE_SESSION_FAILED", stage: "session", message: "install: argent run list-devices failed: GET /tools failed: 404 Not Found",
nextAction: "Rerun the capture on a new session.", retryable: true };
const failedDark = { status: "failed", attempts: 0, landing: "unverified", reason: DARK_FAILURE.message, error: DARK_FAILURE };
test("a dark session that left no export records its failure as every route's own dark outcome, and the run is partial", async () => {
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
const lost = { status: "failed", landing: "unverified", attempts: 3, reason: "The route observer never answered." };
const primary = await writeExport(join(root, "head-export"), { screens: ["home"], images: { home: { path: "artifacts/home.png" } },
outcomes: { home: { status: "captured", landing: "verified", attempts: 1 }, settings: lost }, diagnostics: "" });
const mapPath = join(primary, "screen-map.json");
await writeFile(mapPath, JSON.stringify({ ...JSON.parse(await readFile(mapPath, "utf8")), run: { id: "run", status: "complete", environment: { colorSchemes: ["light", "dark"] } } }));
await mergeCaptureExports(primary, [{ scheme: "dark", error: DARK_FAILURE }]);
const bundle = JSON.parse(await readFile(join(primary, "bundle.json"), "utf8"));
// A route the light session lost keeps its own reason, and its dark frame carries the dark session's, not the light one's.
assert.deepEqual(bundle.outcomes, { home: { status: "captured", landing: "verified", attempts: 1 }, settings: lost, "home@dark": failedDark, "settings@dark": failedDark });
assert.deepEqual(bundle.sessionFailures, [{ scheme: "dark", error: DARK_FAILURE }]);
assert.deepEqual(Object.keys(bundle.images), ["home"]);
const map = JSON.parse(await readFile(mapPath, "utf8"));
assert.equal(map.run.status, "partial");
assert.equal(map.run.stopReason, `The dark session failed (CAPTURE_SESSION_FAILED): ${DARK_FAILURE.message}.`);
});
test("a dark session that failed beside a primary that renders no dark has no frames to fail, and stays on the bundle", async () => {
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
const primary = await writeExport(join(root, "head-export"), { screens: ["home"], images: { home: { path: "artifacts/home.png" } },
outcomes: { home: { status: "captured", landing: "verified", attempts: 1 } }, diagnostics: "" });
const bundlePath = join(primary, "bundle.json");
// The light session could not switch appearance (Argent without appearance.set): it captured light alone.
await writeFile(bundlePath, JSON.stringify({ ...JSON.parse(await readFile(bundlePath, "utf8")), runtimeProfile: { colorScheme: "light" } }));
await mergeCaptureExports(primary, [{ scheme: "dark", error: DARK_FAILURE }]);
const bundle = JSON.parse(await readFile(bundlePath, "utf8"));
assert.deepEqual(Object.keys(bundle.outcomes), ["home"]);
assert.deepEqual(bundle.sessionFailures, [{ scheme: "dark", error: DARK_FAILURE }], "the comment still names the failed session");
assert.equal(JSON.parse(await readFile(join(primary, "screen-map.json"), "utf8")).run.status, "partial");
});
/** The side's sessions as captureSideInSessions runs them: the light one exports, the dark one does what `dark` says. */
async function sideInSessions({ light, dark, leftSessionFile = false, environment = {}, signal } = {}) {
const root = await mkdtemp(join(tmpdir(), "explore-sessions-"));
const progress = [];
const mapOptions = { side: "head", outputDirectory: join(root, "head-export"), mapDirectory: join(root, "head-map"), buildShare: join(root, "builds"),
sessionStatePath: join(root, "head-session"), expoToken: "expo-secret-token", environment };
const runPass = async options => {
const scheme = options.appearancePass.capture[0];
const outcome = scheme === "light" ? light : dark;
// A capture removes its session file only once its session is confirmed stopped.
if (scheme === "dark" && leftSessionFile) await writeFile(options.sessionStatePath, "01a15b61-4df9\n");
if (outcome instanceof Error) throw outcome;
const id = scheme === "light" ? "home" : "home@dark";
await writeExport(options.outputDirectory, { screens: [id], images: { [id]: { path: `artifacts/${id}.png` } },
outcomes: { [id]: { status: "captured", landing: "verified", attempts: 1 } }, diagnostics: "" });
return { runStatus: "complete", outputDirectory: options.outputDirectory, scheme };
};
const run = () => captureSideInSessions(mapOptions, [["light"], ["dark"]], line => progress.push(line), signal, true, runPass);
return { root, progress, run, bundle: async () => JSON.parse(await readFile(join(mapOptions.outputDirectory, "bundle.json"), "utf8")) };
}
test("a side keeps its light captures when only its dark session fails, and the report marks every dark frame failed", async () => {
const side = await sideInSessions({ dark: new CiError({ ...DARK_FAILURE, message: `${DARK_FAILURE.message} (tokens expo-secret-token, gh-secret)` }),
environment: { GITHUB_TOKEN: "gh-secret", PATH: "/usr/bin" } });
const result = await side.run();
assert.equal(result.scheme, "light", "the primary session's result");
assert.equal(result.runStatus, "partial");
const bundle = await side.bundle();
assert.deepEqual(Object.keys(bundle.images), ["home"]);
assert.equal(bundle.outcomes["home@dark"].status, "failed");
assert.equal(bundle.outcomes["home@dark"].error.code, "CAPTURE_SESSION_FAILED");
assert.doesNotMatch(JSON.stringify(bundle), /expo-secret-token|gh-secret/, "the session's error is stored without any secret the environment holds");
assert.ok(side.progress.some(line => /^head: the dark session failed \(CAPTURE_SESSION_FAILED: install: argent run list-devices failed/.test(line)
&& line.endsWith("keeping the light captures, and the report marks every dark frame failed")), side.progress.join("\n"));
});
test("a side whose light session fails still fails, whatever the dark session did", async () => {
const light = new CiError({ ...DARK_FAILURE, code: "CAPTURE_INSTALL_FAILED" });
await assert.rejects((await sideInSessions({ light })).run(), { code: "CAPTURE_INSTALL_FAILED" });
await assert.rejects((await sideInSessions({ light, dark: new CiError({ ...DARK_FAILURE }) })).run(), { code: "CAPTURE_INSTALL_FAILED" });
});
test("a dark session not proven stopped fails the side, so a running session is never hidden behind a partial report", async () => {
const cleanup = new CiError({ code: "SESSION_CLEANUP_FAILED", stage: "cleanup", message: "The exact EAS session could not be confirmed stopped.",
nextAction: "Stop EAS Simulator session 01a15b61 and verify its status.", retryable: false });
await assert.rejects((await sideInSessions({ dark: cleanup })).run(), { code: "SESSION_CLEANUP_FAILED" });
await assert.rejects((await sideInSessions({ light: new CiError({ ...DARK_FAILURE, code: "CAPTURE_INSTALL_FAILED" }), dark: cleanup })).run(), { code: "SESSION_CLEANUP_FAILED" },
"the leaked session is reported before the light session's own failure");
const handoff = new CiError({ code: "SESSION_HANDOFF_UNVERIFIED", stage: "session", message: "EAS did not provide an exact verifiable simulator session.",
nextAction: "Verify a session's exact ID and ownership before cleanup." });
await assert.rejects((await sideInSessions({ dark: handoff })).run(), { code: "SESSION_HANDOFF_UNVERIFIED" });
const unverified = new CiError({ code: "SIMULATOR_START_FAILED", stage: "session", message: "EAS simulator:start failed before a session identity could be verified.",
nextAction: "Verify a session's exact ID and ownership before cleanup.", details: { allocation: "unknown" } });
await assert.rejects((await sideInSessions({ dark: unverified })).run(), { code: "SIMULATOR_START_FAILED" });
// A worker that died before its capture's own cleanup ran: it exited, or failed with a raw error.
const exited = new CiError({ code: "CAPTURE_WORKER_EXITED", stage: "capture-head", message: "The capture worker for the head side exited with code 1 before it reported a result.",
nextAction: "Inspect the job log for the worker's failure, then rerun Explore." });
await assert.rejects((await sideInSessions({ dark: exited })).run(), { code: "CAPTURE_WORKER_EXITED" });
await assert.rejects((await sideInSessions({ dark: new Error("Worker terminated due to reaching memory limit: JS heap out of memory") })).run(), /memory limit/);
// Any failure that left the session's file behind: the session was never confirmed stopped.
await assert.rejects((await sideInSessions({ dark: new CiError({ ...DARK_FAILURE }), leftSessionFile: true })).run(), { code: "CAPTURE_SESSION_FAILED" });
});
test("a dark session whose checkout changed, whose evidence failed its checks, or whose review was stopped fails the side", async () => {
for (const code of ["SOURCE_CHECKOUT_CHANGED", "CHECKOUT_MODIFIED", "CAPTURE_INCOMPLETE", "CAPTURE_IMAGE_BINDING_INVALID", "EXPLORE_FAILED"]) {
await assert.rejects((await sideInSessions({ dark: new CiError({ ...DARK_FAILURE, code }) })).run(), { code }, code);
}
const stop = new AbortController(); stop.abort(new CiError({ code: "LOCAL_REVIEW_INTERRUPTED", stage: "capture", message: "Interrupted.", nextAction: "Rerun." }));
await assert.rejects((await sideInSessions({ dark: new CiError({ ...DARK_FAILURE }), signal: stop.signal })).run(), { code: "CAPTURE_SESSION_FAILED" });
});
+14 -1
View File
@@ -5,7 +5,7 @@ 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, stopRecordedSessions } from '../../dist/ci/local-review.js';
import { appEnvironment, captureCacheDirectory, defaultBase, installDependencies, keepCapture, localInstallCommand, localReviewConfig, reportRef, pruneTargetOutput, 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 { loadReport } from '../../dist/report/agent-api.js';
@@ -364,6 +364,19 @@ test('an interrupted review deletes the local simulators it recorded and stops i
await assert.rejects(lstat(join(output, 'head-session')));
});
test('a finished target keeps its report and any session file, so the review still stops a session no capture confirmed stopped', async t => {
const output = await realpath(await mkdtemp(join(tmpdir(), 'explore-pruned-')));
t.after(() => rm(output, { recursive: true, force: true }));
for (const name of ['report.zip', 'head-session-dark', 'head-export', 'base-export-dark', 'head-map']) await writeFile(join(output, name), 'x\n');
await mkdir(join(output, 'report'));
await pruneTargetOutput(output);
assert.deepEqual((await readdir(output)).sort(), ['head-session-dark', 'report', 'report.zip']);
const eas = [];
await writeFile(join(output, 'head-session-dark'), '01a15b61-4df9\n');
assert.deepEqual(await stopRecordedSessions([output], {}, args => { eas.push(args); return { status: 0 }; }, true), ['01a15b61-4df9']);
assert.deepEqual(eas, [['simulator:stop', '--id', '01a15b61-4df9', '--json', '--non-interactive']]);
});
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 });
+15
View File
@@ -257,6 +257,20 @@ test("semantic Map scope is discarded by non-Map canvases", () => {
}
});
test("Screens' filmstrip layout round-trips, and other canvases and unknown layouts drop it", () => {
const route = { ...base, canvas: "screens", screen: "accessibility", layout: "filmstrip" };
assert.equal(nav.formatRoute(route, ctx), "/screens?screen=accessibility&layout=filmstrip");
assert.deepEqual(parse("/screens?screen=accessibility&layout=filmstrip"), route);
// The grid is the default, so it is never written.
assert.equal(nav.formatRoute({ ...base, canvas: "screens", layout: "grid" }, ctx), "/screens");
assert.deepEqual(parse("/screens?layout=grid"), { ...base, canvas: "screens" });
assert.deepEqual(parse("/screens?layout=nope"), { ...base, canvas: "screens" });
for (const canvas of ["map", "compare"]) {
assert.equal(nav.formatRoute({ ...base, canvas, layout: "filmstrip" }, ctx), `/${canvas}`);
assert.deepEqual(parse(`/${canvas}?layout=filmstrip`), { ...base, canvas });
}
});
test("ids with reserved characters survive the query", () => {
const route = { ...base, screen: "removed:a+b%c" };
assert.deepEqual(parse(nav.formatRoute(route, ctx)), route);
@@ -274,6 +288,7 @@ test("another target's report opens at the same canvas and route, keeping only w
"#/compare/settings/profile?inspect=diff&dir=in&focus=modified,added");
assert.equal(nav.placeForAnotherTarget("#/map/home"), "#/map/home");
assert.equal(nav.placeForAnotherTarget("#/screens?screen=s-3"), "#/screens");
assert.equal(nav.placeForAnotherTarget("#/screens?screen=s-3&layout=filmstrip"), "#/screens?layout=filmstrip");
// No place, or a hash from before routes: the other report opens where a link to it would.
assert.equal(nav.placeForAnotherTarget(""), "");
assert.equal(nav.placeForAnotherTarget("#map"), "");
+32
View File
@@ -325,6 +325,38 @@ test('a failed dark pass on a route that captured in light reads as a valid bund
assert.equal(dark.headOutcome?.error?.code, 'CAPTURE_OBSERVER_MISSING');
});
test('a route light lost and whose dark session failed reviews dark with the dark session\'s reason, not light\'s', async t => {
// brentvatne/euxy's main baseline run 39506374824: the dark session's install failed; here light also lost the route.
const f = await captureFixture(t);
const error = { code: 'CAPTURE_SESSION_FAILED', stage: 'session', message: 'install: argent run list-devices failed: GET /tools failed: 404 Not Found',
nextAction: 'Rerun the capture on a new session.', retryable: true };
for (const side of ['base', 'head']) {
const bundle = f.bundles[side];
bundle.runtimeProfile = { ...runtimeProfile, colorSchemes: 'light,dark' };
if (side === 'base') {
await writeFile(join(f.root, side, 'home-dark.png'), png);
bundle.images[`${f.id}@dark`] = { ...bundle.images[f.id], path: 'home-dark.png' };
} else {
delete bundle.images[f.id];
bundle.outcomes[f.id] = { status: 'failed', attempts: 2, landing: 'unverified', reason: 'The route observer never answered.' };
bundle.outcomes[`${f.id}@dark`] = { status: 'failed', attempts: 0, landing: 'unverified', reason: error.message, error };
bundle.sessionFailures = [{ scheme: 'dark', error }];
}
await writeFile(join(f.root, side, 'bundle.json'), JSON.stringify(bundle));
}
await readCaptureBundle(f.options.headDirectory);
const result = await prepareCaptureReview(f.options);
assertPublicReview(result.review);
const [light, dark] = result.review.surfaces;
assert.equal(light.headOutcome.reason, 'The route observer never answered.');
assert.equal(dark.headOutcome.error.code, 'CAPTURE_SESSION_FAILED');
assert.equal(dark.headOutcome.reason, error.message);
// Without the session's record, a failed dark outcome beside a failed light one is not one the passes produce.
delete f.bundles.head.sessionFailures;
await writeFile(join(f.root, 'head', 'bundle.json'), JSON.stringify(f.bundles.head));
await assert.rejects(readCaptureBundle(f.options.headDirectory), /inventory is inconsistent/);
});
test('a head that gained a light appearance keeps its route in source navigation on the dark-only base', async t => {
const f = await captureFixture(t);
f.bundles.base.runtimeProfile = { ...runtimeProfile, colorSchemes: 'dark' };
+40
View File
@@ -268,6 +268,46 @@ test('capture problems are counted on the target\'s line and listed, collapsed,
assert.doesNotMatch(body, /needs review|Modified|old capture|old destination|token=private|\*\*iOS\*\*|Validation/);
});
test('a target whose dark session failed reads as ready, says dark was not captured, and names the session once', async () => {
const { readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
// brentvatne/euxy's main baseline run 39506374824: the light session captured every route, the dark session's install failed.
const error = { code: 'CAPTURE_SESSION_FAILED', stage: 'session', message: 'install: argent run list-devices failed: GET /tools failed: 404 Not Found',
nextAction: 'Rerun the capture on a new session.', retryable: true };
const unchanged = { review: { status: 'unchanged', description: 'No visible change' }, visual: { verdict: 'unchanged', reason: 'matched', mismatchPercentage: 0, threshold: 0.1, tool: '[email protected]' } };
const surfaces = [];
// 24 routes: more dark frames than the comment lists issues, and one light route the light session lost.
for (let index = 0; index < 24; index++) {
const id = `route-${index}`;
const light = surface(id, 'modified', { extra: { colorScheme: 'light', ...unchanged } });
if (index === 23) { delete light.headImage; delete light.review; light.headOutcome = { status: 'failed', attempts: 2, landing: 'unverified', reason: 'The route observer never answered.' }; }
const dark = surface(`${id}@dark`, 'modified', { route: `/${id}`, extra: { colorScheme: 'dark', headOutcome: { status: 'failed', attempts: 0, landing: 'unverified', reason: error.message, error } } });
delete dark.headImage;
surfaces.push(light, dark);
}
const health = { planned: 24, captured: 24, verified: 24, unverified: 0, unavailable: 0 };
const evidence = { visual: null, accessibility: null, capture: { base: health, head: { ...health, captured: 23, verified: 23, unavailable: 1 } },
comparison: { planned: 24, eligible: 23, skipped: 0 }, diagnostics: [], sessionFailures: [{ side: 'head', scheme: 'dark', frames: 24, ...error }] };
const body = renderPublicComment(state({ review: review(surfaces), evidence, capture: { planned: { base: 24, head: 24 }, done: { base: 24, head: 23 }, baseFromCache: true } }));
assert.doesNotMatch(body, /failed\*\*|capture failed|🟥/, 'one appearance missing is not a failed review');
assert.match(titleOf(body), /^### No compared screens changed · dark not captured · /);
assert.equal(statusOf(body, 'iOS'), `iOS · dark not captured · 1 capture unavailable · ${runLink}`);
assert.deepEqual(summaries(body), ['Capture issues (2)'], 'the session once, and the light route it lost');
assert.match(body, /\n- Head · dark session · CAPTURE\\_SESSION\\_FAILED: install\\: argent run list\\-devices failed\\: GET \/tools failed\\: 404 Not Found\\. 24 dark frames are unavailable\\. Next action: Rerun the capture on a new session\\\.\n/);
assert.match(body, /\n- Head · \/route\\-23 · CAPTURE\\_UNAVAILABLE: The route observer never answered\\. /, 'the light route is not crowded out');
assert.doesNotMatch(body, /\(dark\\\) · CAPTURE\\_SESSION\\_FAILED/, 'no dark frame repeats the session');
const record = readCommentRecords(body).current.ios;
assert.deepEqual(record.sessionFailures, [{ side: 'head', scheme: 'dark', frames: 24 }], 'the record keeps it, so a republished comment says it too');
});
test('a dark issue that is not the session\'s is still listed with its appearance', () => {
const error = { code: 'CAPTURE_OBSERVER_MISSING', stage: 'capture', message: 'The capture build has not exposed its active navigation destination.', nextAction: 'Rerun capture.', retryable: true };
const dark = surface('settings@dark', 'modified', { route: '/settings', extra: { colorScheme: 'dark', headOutcome: { status: 'failed', attempts: 2, landing: 'unverified', reason: error.message, error } } });
delete dark.headImage;
const body = renderPublicComment(state({ review: review([surface('settings', 'modified', { extra: { colorScheme: 'light' } }), dark]), evidence: undefined }));
assert.match(body, /\n- Head · \/settings \\\(dark\\\) · CAPTURE\\_OBSERVER\\_MISSING/);
assert.doesNotMatch(titleOf(body), /not captured/);
});
test('zero eligible pairs are counted as unattributed instead of successful comparisons', () => {
const flagged = evidenceReview();
for (const surface of flagged.surfaces) {
+17
View File
@@ -684,3 +684,20 @@ test("on a foldable a region across the pill's edge is kept whole, and one acros
assert.deepEqual([clipped.ignoredStatusBar, clipped.ignoredHomeIndicator, clipped.measurement.match, clipped.measurement.differentPixels], [0, 1, false, 80]);
assert.deepEqual(clipped.measurement.regions.map((entry) => [entry.rect.y, entry.rect.height, entry.differentPixels, entry.shareOfDiffPercentage]), [[840, 8, 80, 100]]);
});
test("a failed appearance pass is summarized once per side, with the frames it left unavailable", async (t) => {
// brentvatne/euxy's main baseline run 39506374824: the dark session's install failed after light captured every route.
const root = await mkdtemp(join(tmpdir(), "explore-public-evidence-")); t.after(() => rm(root, { recursive: true, force: true }));
const base = await side(root, "base", manifests.base);
const head = await side(root, "head", manifests.head);
const error = { code: "CAPTURE_SESSION_FAILED", stage: "session", message: "install: argent run list-devices failed: GET /tools failed: 404 Not Found",
nextAction: "Rerun the capture on a new session.", retryable: true };
head.bundle.runtimeProfile = { deviceModel: "iPhone 17", osVersion: "26.0", locale: "en-US", orientation: "portrait", colorScheme: "light", colorSchemes: "light,dark" };
for (const id of head.bundle.selectedSurfaceIds) head.bundle.outcomes[`${id}@dark`] = { status: "failed", attempts: 0, landing: "unverified", reason: error.message, error };
head.bundle.sessionFailures = [{ scheme: "dark", error }];
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure: measurer({}) });
assert.deepEqual(result.summary.sessionFailures, [{ side: "head", scheme: "dark", frames: head.bundle.selectedSurfaceIds.length, ...error }]);
delete head.bundle.sessionFailures;
const complete = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure: measurer({}) });
assert.equal(complete.summary.sessionFailures, undefined);
});
+23
View File
@@ -740,6 +740,29 @@ test("a planned screen whose capture failed is unavailable, with the report's re
assert.equal(isChangedStatus(screen.status), false);
});
test("a dark frame whose session failed is unavailable with the session's error, and its light frame is unaffected", () => {
// brentvatne/euxy's main baseline run 39506374824: the light session captured every route, the dark session's install failed.
const review = navigationReview();
const scan = review.surfaces.find(surface => surface.id === "scan-mood");
const error = { code: "CAPTURE_SESSION_FAILED", stage: "session", message: "install: argent run list-devices failed: GET /tools failed: 404 Not Found",
nextAction: "Rerun the capture on a new session.", retryable: true };
scan.colorScheme = "light";
review.surfaces.push({ id: "scan-mood@dark", status: "unchanged", colorScheme: "dark",
base: entry("scan-mood@dark", scan.base.route, "mood"), head: entry("scan-mood@dark", scan.head.route, "mood"),
baseImage: { ...scan.baseImage, url: `${scan.baseImage.url}-dark`, sha256: "f".repeat(64) }, baseOutcome: { status: "captured", attempts: 1, landing: "verified" },
headOutcome: { status: "failed", attempts: 0, landing: "unverified", reason: error.message, error } });
verifyImages(review);
const diff = diffFor(review);
const dark = diff.screens.get("scan-mood@dark");
assert.equal(dark.status, "unavailable");
assert.match(dark.captureNotes.after, /^Capture failed: install: argent run list-devices failed: GET \/tools failed: 404 Not Found/);
assert.equal(dark.afterScreenshot, undefined);
assert.notEqual(diff.screens.get("scan-mood").status, "unavailable", "the light frame keeps its own verdict");
const capture = publicReviewProjection(review).runtimeEvidence["public:scan-mood@dark"].current.groups.capture;
assert.equal(capture.find(row => row.label === "Capture error").value, `CAPTURE_SESSION_FAILED: ${error.message}`);
assert.equal(capture.find(row => row.label === "Next action").value, error.nextAction);
});
test("source navigation names routes, so a route whose only base frame is a secondary appearance stays known on base", () => {
const review = navigationReview();
const scan = review.surfaces.find(surface => surface.id === "scan-mood");
+38 -4
View File
@@ -47,8 +47,10 @@ import {
type MapDirection,
type Route,
type RouteContext,
type ScreensLayout,
type ThemePreference,
} from "./utils/navigation";
import { readScreensLayout, writeScreensLayout } from "./utils/screens-layout";
import {
CANVAS_NUMBER_KEYS,
matchesShortcut,
@@ -897,6 +899,12 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
// Every canvas starts with the Inspector closed; selecting a screenshot opens the Inspector on
// demand. A peer canvas is a fresh inventory, so a screen selection never travels with the reader
// into the destination view.
// The report Screens' layout is remembered for: the loaded one, however it was loaded.
const runId = payload?.map.run.id;
/** Screens opens in the layout the reader last left it in for this report; phones have only their list. */
const rememberedScreensLayout = useCallback((canvas: CanvasView): Partial<Route> => (
canvas === "screens" && routeRef.current.canvas !== "screens" && !phoneRef.current ? { layout: readScreensLayout(runId) } : {}
), [runId]);
const commitCanvasSelection = useCallback((canvas: CanvasView) => {
const current = routeRef.current;
if (canvas === "compare") {
@@ -928,9 +936,22 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
} : {
canvas,
...clearedCanvasSelection,
...rememberedScreensLayout(canvas),
},
);
}, [applyCanvasPanelDefaults, navigate]);
}, [applyCanvasPanelDefaults, navigate, rememberedScreensLayout]);
// Only a switch the reader makes is remembered as the grid: landing on Screens in the grid (from Search, Back or a
// link) leaves a remembered filmstrip alone. The selection and its focus request carry over, so the Screens page
// does not read the switch as a new pick that Changed or a find hides.
const changeScreensLayout = useCallback((layout: ScreensLayout) => {
writeScreensLayout(runId, layout);
// A change of view, not a move: Back leaves Screens rather than undoing it, as the change filter's does.
navigate({ layout: layout === "filmstrip" ? "filmstrip" : undefined }, { replace: true, preserveFocus: true });
}, [navigate, runId]);
// A link that opens the filmstrip is remembered as a switch to it is.
useEffect(() => {
if (route.canvas === "screens" && route.layout === "filmstrip" && !phone) writeScreensLayout(runId, "filmstrip");
}, [phone, route.canvas, route.layout, runId]);
// The logo returns to the Map root, the equivalent of the "/map" URL.
const openMapHome = useCallback(() => {
@@ -1010,6 +1031,13 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
if (event.key === "Escape") {
if (routeRef.current.canvas === "compare") return;
if (rightCollapsedRef.current) {
// The filmstrip is a screen opened from the grid: Esc steps back out to the grid, keeping the selection.
if (routeRef.current.canvas === "screens" && routeRef.current.layout === "filmstrip" && !phoneRef.current) {
setTimeout(() => {
if (!event.defaultPrevented) changeScreensLayout("grid");
}, 0);
return;
}
if (!resolveScreenId(routeRef.current, contextRef.current)) return;
setTimeout(() => {
if (!event.defaultPrevented) clearSelectedScreen();
@@ -1056,6 +1084,9 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
setChangesOpen((open) => !open);
} else if (matchesShortcut(event, SHORTCUTS.panel.right)) {
toggleRightPanel();
} else if (matchesShortcut(event, SHORTCUTS.screens.grid) || matchesShortcut(event, SHORTCUTS.screens.filmstrip)) {
if (routeRef.current.canvas !== "screens" || phoneRef.current) return;
changeScreensLayout(matchesShortcut(event, SHORTCUTS.screens.grid) ? "grid" : "filmstrip");
} else {
const canvas = CANVAS_KEYS.find(([, shortcut]) => matchesShortcut(event, shortcut));
if (!canvas) return;
@@ -1067,7 +1098,7 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
return () => {
window.removeEventListener("keydown", onKeyDown);
};
}, [chooseAppearance, clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleFullscreen, toggleRightPanel]);
}, [changeScreensLayout, chooseAppearance, clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleFullscreen, toggleRightPanel]);
// A side-panel row or a deep link is a "go to": the camera fits that screen and the step is
// kept. Screens inventory clicks only select in place; Map clicks also focus the chosen screen. Repeating a selected target refits it without adding history.
@@ -1134,10 +1165,11 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
canvas: "screens",
...screenPatch(screenId),
expandedGroups: [],
...rememberedScreensLayout("screens"),
}, {
resetCamera: true,
});
}, [applyCanvasPanelDefaults, navigate, screenPatch]);
}, [applyCanvasPanelDefaults, navigate, rememberedScreensLayout, screenPatch]);
// Following a row inside the inspector is the exception: a transition or changed screen is
// read from a view the reader chose, and landing somewhere new is no
// reason to close it. The panel stays where it was and only its subject changes.
@@ -1656,6 +1688,8 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
onSelectScreen={selectScreenOnCanvas}
onPickScreen={pickScreenInPlace}
onClearSelection={clearSelectedScreen}
layout={route.layout ?? "grid"}
onChangeLayout={changeScreensLayout}
/>
) : null}
{comparing && phone && diff && selectedScreenId && comparePicker ? (
@@ -1707,7 +1741,7 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
/>
)}
</div>
{/* Top right holds the camera only, so only the Map has anything there. */}
{/* Top right holds the Map's camera; Screens puts its layout switch there itself. */}
{phone || route.canvas !== "map" ? null : <CanvasCameraControls />}
{phone ? (
<PhoneTabBar
@@ -112,7 +112,8 @@ export function shortcutGroups(context: ShortcutContext): Group[][] {
title: "Screens",
rows: [
{ label: "Move through the screens", keys: ["←", "→", "↑", "↓"] },
{ label: "Close the inspector, then deselect", keys: ["Esc"] },
{ label: "Grid or filmstrip", keys: [SHORTCUTS.screens.grid, SHORTCUTS.screens.filmstrip] },
{ label: "Close the inspector, then leave the filmstrip or deselect", keys: ["Esc"] },
],
};
const here: Group[] = context.canvas === "compare"
@@ -1,4 +1,4 @@
import { useRef } from "react";
import { useRef, type ReactNode } from "react";
import { Search, X } from "lucide-react";
import "./panel-search.css";
@@ -9,6 +9,8 @@ type PanelSearchProps = {
clearLabel: string;
name?: string;
autoFocus?: boolean;
/** Shown at the field's end while it is empty, such as the key that focuses it. */
hint?: ReactNode;
onEscape?: () => void;
onChange: (value: string) => void;
};
@@ -36,6 +38,7 @@ export function PanelSearch(props: PanelSearchProps) {
}}
onChange={(event) => props.onChange(event.target.value)}
/>
{props.value ? null : props.hint}
{props.value && (
<button
type="button"
@@ -0,0 +1,174 @@
import { useLayoutEffect, useMemo, useState } from "react";
import { ChevronRight } from "lucide-react";
import { artifactUrl, isLaunchScreen, type MapIndex, type Screen } from "../../utils/model";
import { primaryScreenshotForScreen, screenshotSize, type ScreenshotSize } from "../../utils/screen-images";
import { diffClass, type BuildDiff } from "../../utils/build-diff";
import { screenLabel } from "../../utils/screen-path";
import { treeNodeKey, type ScreenTree, type ScreenTreeIndex, type ScreenTreeNode } from "../../utils/screen-tree";
import { ScreenshotImage } from "../shared/screenshot-image";
/** A neighbour's size and opacity by its distance from the screen in the middle. */
const SCALES = [1, 0.74, 0.54, 0.4];
const OPACITIES = [1, 0.9, 0.6, 0.3];
const GAP = 32;
/** An iPhone's portrait shape, for a run with no screenshot sizes at all. */
const FALLBACK_SIZE: ScreenshotSize = { imageWidth: 390, imageHeight: 844 };
export type ScreensFilmstripProps = {
/** The screens shown, in the tree's order. */
order: readonly string[];
/** The screen in the middle. */
focusedId: string;
selectedId?: string | undefined;
index: MapIndex;
diff?: BuildDiff | undefined;
tree: ScreenTree;
shape: ScreenTreeIndex;
typicalSize?: ScreenshotSize | undefined;
/** The element id a screen's frame takes, which the page's arrow keys focus by. */
frameId: (id: string) => string;
/** The tree's dot class for a screen: its status, shown beside its name as the grid and the tree show it. */
dot: (id: string) => string | undefined;
dimmed: (id: string) => boolean;
/** Brings a screen to the middle without opening the Inspector. */
onPick: (id: string) => void;
/** Selects a screen and opens it in the Inspector, as a click on its card does. */
onOpen: (id: string) => void;
};
function labelOf(screen: Screen, index: MapIndex): string {
return isLaunchScreen(screen) ? "Cold start" : screenLabel(screen, index);
}
/** The stage's size, which the frames are fitted to. */
function useSize(): [(element: HTMLDivElement | null) => void, { width: number; height: number }] {
const [element, setElement] = useState<HTMLDivElement | null>(null);
const [size, setSize] = useState({ width: 0, height: 0 });
useLayoutEffect(() => {
if (!element) return;
const measure = () => setSize({ width: element.clientWidth, height: element.clientHeight });
measure();
if (typeof ResizeObserver === "undefined") return;
const observer = new ResizeObserver(measure);
observer.observe(element);
return () => observer.disconnect();
}, [element]);
return [setElement, size];
}
/**
* Screens one at a time: the focused screen large in the middle, the screens before and after it smaller and fainter
* the further they are, in the tree's order. Above it, the rows of the tree it was opened from, ending in its name with
* its status dot. The neighbours, whose names are not shown, are outlined in their status colour instead.
*/
export function ScreensFilmstrip(props: ScreensFilmstripProps) {
const [stageRef, stage] = useSize();
const at = props.order.indexOf(props.focusedId);
const focused = props.index.screens.get(props.focusedId);
// A row of the tree by its fold key, as the path above the frame names it.
const rowLabels = useMemo(() => {
const labels = new Map<string, string>();
const walk = (nodes: readonly ScreenTreeNode[]) => {
for (const node of nodes) {
if (node.kind === "folder") labels.set(node.id, node.label);
else {
const screen = props.index.screens.get(node.screenId);
if (screen) labels.set(treeNodeKey(node), labelOf(screen, props.index));
}
walk(node.children);
}
};
walk(props.tree.tree);
return labels;
}, [props.index, props.tree]);
if (!focused || at < 0) return null;
const sizeOf = (screen: Screen) => screenshotSize(primaryScreenshotForScreen(screen, props.index)) ?? props.typicalSize ?? FALLBACK_SIZE;
const aspect = (screen: Screen) => {
const size = sizeOf(screen);
return size.imageWidth / size.imageHeight;
};
// Every frame is laid out as the middle one would be, filling the stage's height short of growing wider than half
// the stage, so a landscape capture beside portrait ones is as wide as it may be rather than as tall; then it is scaled
// down around its centre, and the centres are spaced so the scaled frames sit a gap apart, the gap shrinking with them.
const frameSize = (screen: Screen) => {
const height = Math.max(0, Math.min(stage.height - 16, (stage.width * 0.5) / aspect(screen)));
return { width: height * aspect(screen), height };
};
const middle = frameSize(focused);
const frames: { id: string; screen: Screen; distance: number; x: number; width: number; height: number }[] = [
{ id: props.focusedId, screen: focused, distance: 0, x: 0, ...middle },
];
for (const direction of [-1, 1]) {
let edge = middle.width / 2;
for (let distance = 1; distance < SCALES.length; distance++) {
const id = props.order[at + direction * distance];
const screen = id ? props.index.screens.get(id) : undefined;
if (!id || !screen) break;
const size = frameSize(screen);
const scaled = size.width * SCALES[distance]!;
const centre = edge + GAP * SCALES[distance]! + scaled / 2;
frames.push({ id, screen, distance, x: direction * centre, ...size });
edge = centre + scaled / 2;
}
}
const path = (props.shape.ancestors.get(props.focusedId) ?? []).flatMap(key => rowLabels.get(key) ?? []);
const plain = props.index.plainTitles || isLaunchScreen(focused);
const dot = props.dot(props.focusedId);
return (
<section className="screens-strip" aria-label="Filmstrip">
<div className="screens-strip-path">
{path.map((label, position) => (
<span key={position} className="screens-strip-crumb" title={label}>
<span className={`screens-strip-crumb-label${plain ? "" : " path"}`}>{label}</span>
<ChevronRight aria-hidden="true" />
</span>
))}
<span className="screens-strip-crumb current" title={labelOf(focused, props.index)}>
{dot ? <span className={`screens-tree-dot ${dot}`} aria-hidden="true" /> : null}
<span className={`screens-strip-crumb-label${plain ? "" : " path"}`}>{labelOf(focused, props.index)}</span>
</span>
</div>
<div ref={stageRef} className="screens-strip-stage">
{stage.width > 0 ? frames.map(({ id, screen, distance, x, width, height }) => {
const artifact = primaryScreenshotForScreen(screen, props.index);
const url = artifactUrl(artifact);
const size = screenshotSize(artifact);
const placeholder = <span className="screens-strip-placeholder" aria-hidden="true" />;
const frameDiff = props.diff?.screens.get(id);
const scale = SCALES[distance]!;
const label = labelOf(screen, props.index);
return (
<div key={id} id={props.frameId(id)} data-screen-id={id}
className={`screens-strip-frame${distance === 0 ? " focused" : ""}${frameDiff ? ` ${diffClass(frameDiff)}` : ""}${props.dimmed(id) ? " dimmed" : ""}`}
style={{
width,
height,
opacity: OPACITIES[distance],
zIndex: SCALES.length - distance,
transform: `translate(-50%, -50%) translateX(${x}px) scale(${scale})`,
}}>
{/* Only the middle frame is in the tab order: the arrows step the strip, and focus on a neighbour the stage
clips would scroll it off its centre. */}
<button type="button" className="screens-strip-target" aria-label={label} title={distance === 0 ? undefined : label}
tabIndex={distance === 0 ? undefined : -1}
aria-pressed={props.selectedId === id} aria-current={distance === 0 ? "true" : undefined}
onClick={() => (distance === 0 ? props.onOpen(id) : props.onPick(id))}>
{/* A downloaded report's screenshot is a reference that ScreenshotImage resolves. */}
{url ? (
<ScreenshotImage src={url} alt="" draggable={false} decoding="async" loading={distance <= 1 ? "eager" : "lazy"}
{...(size ? { width: size.imageWidth, height: size.imageHeight } : {})} fallback={placeholder} />
) : placeholder}
</button>
</div>
);
}) : null}
</div>
</section>
);
}
+152 -35
View File
@@ -55,48 +55,65 @@
border-radius: 14px;
background: var(--side-panel-surface);
}
.screens-tree > h2 {
margin: 0;
padding: 4px 8px 10px;
color: var(--tertiary);
font-family: "JetBrains Mono", ui-monospace, SFMono-Regular, Menlo, monospace;
font-size: 11px;
font-weight: 600;
letter-spacing: 0.04em;
}
.screens-tree ul { margin: 0; padding: 0; list-style: none; }
/* Changed / All filter the tree and the grid alike, so they sit in the tree's head as one segmented control,
beside the button that folds or unfolds every folder. */
/* One height in every state (chips, the find field, or only the icons), so opening the find does not move the tree. */
.screens-tree-head { display: flex; height: 34px; flex: none; align-items: center; gap: 6px; margin: 0 0 10px; }
.screens-tree-head > .screens-filter {
flex: 1;
/* The tree's head: the find field, with fold-all beside it. */
.screens-tree-head { display: flex; height: 34px; flex: none; align-items: center; gap: 4px; margin: 0 0 8px; }
/* Changed / All filter the tree and the grid alike: one segmented control under the head, the tree's width. */
.screens-tree > .screens-filter {
flex: none;
gap: 2px;
margin: 0 0 10px;
padding: 3px;
border-radius: 9px;
background: var(--element);
}
.screens-tree-fold-all {
.screens-tree-fold-all,
.screens-side-toggle {
display: grid;
width: 32px;
height: 32px;
flex: none;
margin-left: auto;
place-items: center;
border-radius: 8px;
color: var(--secondary);
background: transparent;
}
.screens-tree-fold-all:hover { color: var(--text); background: var(--panel-hover); }
.screens-tree-fold-all > svg { width: 16px; height: 16px; }
.screens-tree-head > .screens-filter .screens-chip {
.screens-tree-fold-all { margin-left: auto; }
.screens-tree-fold-all:hover,
.screens-side-toggle:hover { color: var(--text); background: var(--panel-hover); }
.screens-tree-fold-all > svg,
.screens-side-toggle > svg { width: 16px; height: 16px; }
/* Folded, the sidebar is only the button that opens it, on the tree's surface at the tree's top. */
.screens-side.collapsed { width: auto; }
.screens-side.collapsed > .screens-side-toggle {
width: 36px;
height: 36px;
border: 1px solid var(--border-subtle);
border-radius: 10px;
background: var(--side-panel-surface);
}
.screens-side.collapsed > .screens-side-toggle:hover { background: var(--panel-hover); }
/* Folded under Changed: a dot on the button, in the changed colour, says the screens are narrowed. */
.screens-side-toggle.narrowed { position: relative; }
.screens-side-toggle.narrowed::after {
content: "";
position: absolute;
top: 6px;
right: 6px;
width: 7px;
height: 7px;
border: 1.5px solid var(--side-panel-surface);
border-radius: 50%;
background: var(--modified);
}
.screens-tree > .screens-filter .screens-chip {
height: 28px;
flex: 1;
justify-content: center;
border-radius: 7px;
background: transparent;
}
.screens-tree-head > .screens-filter .screens-chip[aria-pressed="true"] { background: var(--selected); }
.screens-tree > .screens-filter .screens-chip[aria-pressed="true"] { background: var(--selected); }
.screens-tree-row {
display: flex;
width: 100%;
@@ -339,25 +356,125 @@ button.screens-tree-row:hover { color: var(--text); background: var(--panel-hove
.screens-tree.phone .screens-tree-label.path { font-size: var(--phone-body-mono-size); }
.screens-tree.phone .screens-tree-kind { font-size: var(--phone-micro-size); }
/* ── Find: `/` or the magnifier turns the tree's head into a field; the tree and the grid narrow to its matches ── */
.screens-tree-head > .tooltip-anchor { display: flex; flex: none; margin-left: auto; }
.screens-tree-head > .tooltip-anchor + .screens-tree-fold-all { margin-left: 0; }
.screens-tree-find {
/* ── Find: the field heading the tree, focused by `/`; the tree and the grid narrow to its matches ── */
.screens-find { display: flex; min-width: 0; flex: 1; }
.screens-find .panel-search { height: 34px; flex: 1; border-radius: 9px; }
/* The key that focuses the field, at its end while it is empty and unfocused. */
.screens-find-key {
display: grid;
width: 32px;
height: 32px;
min-width: 18px;
height: 18px;
flex: none;
place-items: center;
border-radius: 8px;
color: var(--secondary);
background: transparent;
margin-right: 2px;
padding: 0 4px;
border: 1px solid var(--border-subtle);
border-radius: 5px;
color: var(--tertiary);
background: var(--surface);
font: 600 11px/1 var(--screens-mono);
}
.screens-tree-find:hover { color: var(--text); background: var(--panel-hover); }
.screens-tree-find > svg { width: 16px; height: 16px; }
.screens-tree-head.searching { gap: 4px; }
.screens-find { display: flex; min-width: 0; flex: 1; }
.screens-find .panel-search { height: 34px; border-radius: 9px; }
.screens-find .panel-search:focus-within .screens-find-key { display: none; }
.screens-find-empty { margin: 0; padding: 4px 8px; color: var(--tertiary); font-size: 12px; }
.screens-empty { min-height: 240px; flex: 1; }
.screens-empty-all { padding: 0; color: var(--accent); font: inherit; background: transparent; }
.screens-empty-all:hover { text-decoration-line: underline; text-underline-offset: 3px; }
/* ── Filmstrip: one screen at a time, its neighbours smaller and fainter on either side ── */
/* The page stops scrolling; the strip fills the height between the pill and the bottom toolbar. */
.screens-page.filmstrip { overflow: hidden; padding-bottom: calc(84px * var(--ui-scale)); }
.screens-page.filmstrip .screens-body { height: 100%; }
.screens-page.filmstrip .screens-side { max-height: 100%; }
.screens-page.filmstrip .screens-sections { display: flex; height: 100%; flex-wrap: nowrap; align-items: stretch; }
.screens-strip { display: flex; min-width: 0; flex: 1; flex-direction: column; align-items: center; gap: 8px; }
.screens-strip-path {
display: flex;
width: 100%;
min-height: 28px;
flex: none;
align-items: center;
justify-content: safe center;
gap: 6px;
overflow: hidden;
color: var(--tertiary);
font-size: 13px;
white-space: nowrap;
}
/* A long route keeps the path to one line: the screen's name shrinks to an ellipsis, and each row above it is capped
at a width of its own. A path still too long is cut at its end, not on both sides. */
.screens-strip-crumb { display: inline-flex; min-width: 0; flex: 0 1 auto; align-items: center; gap: 6px; }
.screens-strip-crumb:not(.current) { max-width: 160px; flex-shrink: 0; }
.screens-strip-crumb > svg { width: 12px; height: 12px; flex: none; opacity: 0.7; }
.screens-strip-crumb.current { flex-shrink: 1; gap: 7px; color: var(--text); font-weight: 600; }
.screens-strip-crumb.current > .screens-tree-dot { flex: none; }
.screens-strip-crumb.current > .screens-tree-dot[class*="diff-"] { background: var(--diff); }
.screens-strip-crumb-label { min-width: 0; overflow: hidden; text-overflow: ellipsis; }
.screens-strip-crumb-label.path { font-size: 12px; }
.screens-strip-stage { position: relative; width: 100%; min-height: 0; flex: 1; overflow: hidden; overflow: clip; }
.screens-strip-frame {
position: absolute;
top: 50%;
left: 50%;
/* A frame's size follows its screenshot's shape, so it eases with the move rather than snapping. */
transition: transform 300ms cubic-bezier(0.2, 0.75, 0.2, 1), width 300ms cubic-bezier(0.2, 0.75, 0.2, 1), height 300ms cubic-bezier(0.2, 0.75, 0.2, 1), opacity 300ms ease;
will-change: transform;
}
@media (prefers-reduced-motion: reduce) { .screens-strip-frame { transition: none; } }
.screens-strip-frame.dimmed:not(.focused) { opacity: calc(var(--dim-out) * 0.6) !important; }
.screens-strip-target {
display: block;
width: 100%;
height: 100%;
overflow: hidden;
padding: 0;
border: 1px solid var(--border-subtle);
border-radius: 14px;
background: var(--element);
cursor: pointer;
}
.screens-strip-frame.focused .screens-strip-target {
border-color: color-mix(in srgb, var(--text) 30%, var(--border-subtle));
box-shadow: 0 24px 48px rgb(0 0 0 / 0.08), 0 2px 6px rgb(0 0 0 / 0.08);
cursor: zoom-in;
}
/* A changed neighbour is outlined in its status colour; the middle screen's status is the dot beside its name. */
.screens-strip-frame:not(.focused):is(.diff-added, .diff-modified, .diff-removed, .diff-accessibility-only, .diff-needs-review, .diff-source-affected) .screens-strip-target { outline: 2px solid var(--diff); outline-offset: 2px; }
/* Focused by the arrows, the middle frame keeps its screenshot's own colours: the brightening that marks a focused
pressed button elsewhere (styles.css) would change what is being reviewed. Being in the middle is its focus. */
.screens-page .screens-strip-target:focus-visible { filter: none; }
.screens-strip-target img { display: block; width: 100%; height: 100%; object-fit: contain; }
.screens-strip-placeholder { display: block; width: 100%; height: 100%; }
/* ── Layout switch: Grid or Filmstrip, in words, at the top right in the pill's row ── */
.screens-layout-switch {
position: absolute;
z-index: 20;
top: var(--chrome-top);
right: calc(var(--screens-switch-right, 0px) + var(--canvas-chrome-inline-inset));
display: inline-flex;
height: var(--chrome-height);
align-items: stretch;
gap: 2px;
padding: calc(3px * var(--ui-scale));
border: 1px solid var(--border-subtle);
border-radius: calc(10px * var(--ui-scale));
background: var(--side-panel-surface);
box-shadow: var(--floating-chrome-shadow);
}
.screens-layout-switch button {
display: inline-flex;
align-items: center;
gap: 7px;
padding: 0 12px 0 10px;
border-radius: calc(7px * var(--ui-scale));
color: var(--secondary);
background: transparent;
font-size: 13px;
font-weight: 500;
transition: color 120ms ease, background 120ms ease;
}
.screens-layout-switch button:hover { color: var(--text); background: var(--panel-hover); }
.screens-layout-switch button[aria-pressed="true"] { color: var(--text); background: var(--selected); }
.screens-layout-switch button > svg { width: 15px; height: 15px; flex: none; }
.screens-layout-switch.compact button { padding: 0 9px; }
.screens-layout-switch.compact button > span { display: none; }
+182 -44
View File
@@ -1,5 +1,5 @@
import { useEffect, useMemo, useRef, useState, type CSSProperties, type KeyboardEvent, type ReactNode } from "react";
import { ChevronRight, ChevronsDownUp, ChevronsUpDown, ListTree, Search } from "lucide-react";
import { useEffect, useMemo, useRef, useState, type CSSProperties, type KeyboardEvent, type MouseEvent as ReactMouseEvent, type ReactNode } from "react";
import { ChevronRight, ChevronsDownUp, ChevronsUpDown, GalleryHorizontal, LayoutGrid, ListTree, PanelLeftClose, PanelLeftOpen } from "lucide-react";
import { artifactUrl, isLaunchScreen, type ExploreMap, type MapIndex, type Screen } from "../../utils/model";
import { primaryScreenshotForScreen, screenshotSize, typicalScreenshotSize, type ScreenshotSize } from "../../utils/screen-images";
import { diffClass, type BuildDiff, type DiffStatus } from "../../utils/build-diff";
@@ -7,8 +7,8 @@ import { focusStatusOf, isCapturedChange } from "../../utils/changed-screens";
import { displayPathForScreen, screenLabel } from "../../utils/screen-path";
import { screenTree, treeIndex, treeNodeKey, treeScreenOrder, type ScreenTree, type ScreenTreeNode } from "../../utils/screen-tree";
import type { Appearance } from "../../utils/appearance";
import type { FocusRequest, FocusStatus } from "../../utils/navigation";
import { shortcutsLive } from "../../utils/shortcuts";
import type { FocusRequest, FocusStatus, ScreensLayout } from "../../utils/navigation";
import { formatShortcut, SHORTCUTS, shortcutsLive } from "../../utils/shortcuts";
import { normalizeSearchText } from "../../utils/search";
import { createKeyHold } from "../../utils/key-hold";
import { placeholderScreen } from "../../utils/map-frame";
@@ -19,6 +19,7 @@ import { useCanvasVisibleFrame } from "../canvas/visible-frame-provider";
import { PhoneSheet } from "../phone/phone-chrome";
import { PanelSearch } from "../shared/panel-search";
import { Tooltip } from "../shared/tooltip";
import { ScreensFilmstrip } from "./screens-filmstrip";
import "./screens.css";
/** The statuses a tree dot marks. The Changed filter keeps only the screens whose captures differ (isCapturedChange). */
@@ -52,6 +53,10 @@ export type ScreensViewProps = {
onPickScreen?: ((id: string) => void) | undefined;
/** A click on the page around the cards clears the selection, as a click on a canvas's pane does. */
onClearSelection?: (() => void) | undefined;
/** Desktop only: every card in a grid, or one screen at a time in a filmstrip. */
layout?: ScreensLayout | undefined;
/** A double-click on a card opens it in the filmstrip. */
onChangeLayout?: ((layout: ScreensLayout) => void) | undefined;
};
function statusOf(diff: BuildDiff | undefined, id: string): DiffStatus | undefined {
@@ -85,6 +90,27 @@ function writeFolded(key: string, folded: ReadonlySet<string>): void {
} catch { /* Folds last for this visit only. */ }
}
/**
* The canvas widths below which the layout switch drops its labels, and below which it is hidden: the pill at the top
* left grows to 420px (`--left-collapsed-pill-width`), and the switch keeps clear of it, labelled or not.
*/
const SWITCH_LABELLED_FRAME_WIDTH = 640;
const SWITCH_MINIMUM_FRAME_WIDTH = 540;
/** How soon, and how near, a second click follows the first to make a double-click that opens a card in the filmstrip. */
const DOUBLE_CLICK_MS = 500;
const DOUBLE_CLICK_SLOP_PX = 8;
/** A shown screen to stand for `selected`: itself, or the nearest shown screen after it in the tree, else before it. */
function nearestShown(selected: string | undefined, shown: readonly string[], tree: readonly string[]): string | undefined {
if (!selected) return undefined;
if (shown.includes(selected)) return selected;
const at = tree.indexOf(selected);
if (at < 0) return undefined;
const set = new Set(shown);
return tree.slice(at + 1).find(id => set.has(id)) ?? tree.slice(0, at).reverse().find(id => set.has(id));
}
/** The key that opens the find field: a character, not a key position, so it is read from the layout like "?". */
export const FIND_KEY = "/";
@@ -159,7 +185,7 @@ function ScreenCell(props: {
typicalSize?: ScreenshotSize | undefined;
/** A phone's cell, whose screenshot is its own frame: no well frames it while it loads. */
phone?: boolean | undefined;
onSelect: () => void;
onSelect: (event: ReactMouseEvent) => void;
}) {
const artifact = primaryScreenshotForScreen(props.screen, props.index);
const url = artifactUrl(artifact);
@@ -272,8 +298,9 @@ function Legend(props: { others: Appearance[] }) {
}
/**
* Screens as a page that scrolls. On desktop, one grid of every screen in the order of the tree beside it; on a
* phone, a section per route folder (or per tab, when there are no route files), with the tree behind a Tree button.
* Screens as a page that scrolls. On desktop, one grid of every screen in the order of the tree beside it, or the same
* screens one at a time in a filmstrip (screens-filmstrip.tsx); on a phone, a section per route folder (or per tab,
* when there are no route files), with the tree behind a Tree button.
*/
export function ScreensView(props: ScreensViewProps) {
// The report's screens, as the Map draws them: a public report's routes it never captured are not among them.
@@ -295,10 +322,9 @@ export function ScreensView(props: ScreensViewProps) {
const [filter, setFilter] = useState<Filter>(props.phone && changedIds.size > 0 ? "changed" : "all");
const [treeOpen, setTreeOpen] = useState(false);
// Find: a query narrows the tree and the grid to the screens whose route or title contains it, inside Changed or All.
const [findOpen, setFindOpen] = useState(false);
const [query, setQuery] = useState("");
// The phone layout has no field to show or clear a query, so a query typed on desktop does not narrow it.
const findQuery = findOpen && !props.phone ? query : "";
const findQuery = props.phone ? "" : query;
const matches = useMemo(() => findMatches(screens, props.index, findQuery), [props.index, screens, findQuery]);
const inChanged = filter === "changed" && changedIds.size > 0;
const inFilter = inChanged ? changedIds : new Set(screens.map(screen => screen.id));
@@ -310,6 +336,23 @@ export function ScreensView(props: ScreensViewProps) {
const treeOrder = useMemo(() => treeScreenOrder(tree), [tree]);
const order = props.phone ? sections.flatMap(section => section.screenIds) : treeOrder.filter(id => shown.has(id));
const others = [...new Set([...(props.changedElsewhere?.values() ?? [])].flat())];
const filmstrip = !props.phone && props.layout === "filmstrip";
// The filmstrip always has a screen in the middle: the selection when it is shown; else, when Changed or a find hides
// it, the nearest shown screen after it in the tree (before it, at the end), as the grid's arrows step from it; else
// the first screen.
const stripFocus = filmstrip ? nearestShown(props.selectedScreenId, order, treeOrder) ?? order[0] : undefined;
// The sidebar folds away to give the screens its width. Each switch of layout starts over: the filmstrip with the
// sidebar folded, the grid with it open. A find's query lives only in the sidebar's field, so the sidebar stays open
// while one narrows the screens. Changed folds away with it, and the button left in its place says it is on.
const [side, setSide] = useState({ filmstrip, collapsed: filmstrip && !findQuery });
if (side.filmstrip !== filmstrip) setSide({ filmstrip, collapsed: filmstrip && !findQuery });
const sideCollapsed = side.filmstrip === filmstrip ? side.collapsed : filmstrip && !findQuery;
const setSideCollapsed = (collapsed: boolean) => setSide({ filmstrip, collapsed });
// A button that folds or opens the sidebar is replaced by the other one; the keyboard moves to it.
const toggleSide = (collapsed: boolean) => {
setSideCollapsed(collapsed);
requestAnimationFrame(() => document.querySelector<HTMLElement>(".screens-side .screens-side-toggle")?.focus());
};
// Folding. All keeps the reader's folds and remembers them per report. Changed folds separately, starting
// each time with only the rows that hold no change folded, so trying Changed never disturbs the folds in All.
@@ -363,49 +406,54 @@ export function ScreensView(props: ScreensViewProps) {
setTreeOpen(false);
if (!inFilter.has(id)) setFilter("all");
(props.onPickScreen ?? props.onSelectScreen)(id);
requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "center", behavior: "smooth" }));
// The filmstrip brings the screen to its middle itself.
if (!filmstrip) requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "center", behavior: "smooth" }));
};
const findField = useRef<HTMLDivElement>(null);
const focusFind = () => findField.current?.querySelector("input")?.focus();
// `/` focuses the field, deferred a frame so the key itself is not typed into it. A folded sidebar opens first.
const findOnOpen = useRef(false);
const openFind = () => {
setFindOpen(true);
requestAnimationFrame(focusFind);
if (!sideCollapsed) {
requestAnimationFrame(focusFind);
return;
}
findOnOpen.current = true;
setSideCollapsed(false);
};
useEffect(() => {
if (sideCollapsed || !findOnOpen.current) return;
findOnOpen.current = false;
requestAnimationFrame(focusFind);
}, [sideCollapsed]);
const closeFind = () => {
setQuery("");
setFindOpen(false);
// The field took the keyboard; hand it back to the page so its arrows work again.
if (document.activeElement instanceof HTMLElement) document.activeElement.blur();
};
// `/` from another canvas lands here with the field open.
// `/` from another canvas lands here with the field focused.
useEffect(() => {
if (props.findRequest === undefined) return;
if (!props.phone) openFind();
props.onFindRequestDone?.();
// eslint-disable-next-line react-hooks/exhaustive-deps -- a new request opens it once
// eslint-disable-next-line react-hooks/exhaustive-deps -- a new request focuses it once
}, [props.findRequest]);
const findButton = props.phone ? null : (
<Tooltip label="Find a screen" shortcut={FIND_KEY} placement="bottom">
<button type="button" className="screens-tree-find" aria-label="Find a screen" onClick={openFind}>
<Search aria-hidden="true" />
</button>
</Tooltip>
);
const findSearch = findOpen ? (
// The find field heads the tree on desktop.
const findSearch = props.phone ? null : (
<div ref={findField} className="screens-find">
<PanelSearch
value={query}
placeholder="Find…"
placeholder="Search"
ariaLabel="Find screens"
clearLabel="Clear find query"
name="screens-find"
autoFocus
hint={<kbd className="screens-find-key" aria-hidden="true">{FIND_KEY}</kbd>}
onEscape={() => (query ? setQuery("") : closeFind())}
onChange={setQuery}
/>
</div>
) : null;
);
const filterChips = changedIds.size > 0 ? (
<div className="screens-filter" role="group" aria-label="Show">
{(["changed", "all"] as const).map((value) => (
@@ -424,6 +472,7 @@ export function ScreensView(props: ScreensViewProps) {
// A selection made elsewhere (search, the map, the Inspector) scrolls its card to the middle of
// the page, as a pick in the tree does; a card already in view stays put.
const scroller = useRef<HTMLElement>(null);
const cardClick = useRef<{ id: string; at: number; x: number; y: number } | undefined>(undefined);
const selected = props.selectedScreenId;
const focusKey = props.focusRequest?.id === selected ? props.focusRequest?.key : undefined;
const selectedShown = selected !== undefined && shown.has(selected);
@@ -445,13 +494,13 @@ export function ScreensView(props: ScreensViewProps) {
setFoldedChanged(unfold);
}, [selected, focusKey, shape]);
useEffect(() => {
if (!selected || !selectedShown) return;
if (!selected || !selectedShown || filmstrip) return;
const card = document.getElementById(cardId(selected));
if (!card || !scroller.current) return;
const bounds = card.getBoundingClientRect();
const view = scroller.current.getBoundingClientRect();
if (bounds.top < view.top || bounds.bottom > view.bottom) card.scrollIntoView({ block: "center", behavior: "smooth" });
}, [selected, selectedShown, focusKey]);
}, [selected, selectedShown, focusKey, filmstrip]);
// On desktop the arrow keys move through the cards: ← and → in their order on the page (`order`), as the arrows step
// through screens in Compare, and ↑ and ↓ to the card above or below, by where the cards sit, so they follow the grid
@@ -459,13 +508,17 @@ export function ScreensView(props: ScreensViewProps) {
// nothing picked, → and ↓ start at the first card, and a pick that Changed hides steps from where it sits in the tree.
// The tree's rows keep their arrow keys, and so do the Inspector's controls. Phones are left as they were.
// Held, an arrow keeps stepping as Compare's do (key-hold.ts). Return opens the picked screen in the Inspector, as a
// click on its card does; on the card itself the button already does.
// click on its card does; on the card itself the button already does. In the filmstrip, ← and → step from the screen
// in the middle and Return opens it.
const orderRef = useRef(order);
orderRef.current = order;
const treeOrderRef = useRef(treeOrder);
treeOrderRef.current = treeOrder;
const selectedRef = useRef(selected);
selectedRef.current = selected;
// In the filmstrip the arrows step from the screen in the middle, which is the pick once there is one.
const stripFocusRef = useRef(stripFocus);
stripFocusRef.current = stripFocus;
const pickRef = useRef(props.onPickScreen ?? props.onSelectScreen);
pickRef.current = props.onPickScreen ?? props.onSelectScreen;
const openRef = useRef(props.onSelectScreen);
@@ -479,6 +532,8 @@ export function ScreensView(props: ScreensViewProps) {
const ids = orderRef.current;
const vertical = code === "ArrowUp" || code === "ArrowDown";
const forward = code === "ArrowRight" || code === "ArrowDown";
// The filmstrip is one row.
if (vertical && stripFocusRef.current !== undefined) return undefined;
if (from && ids.includes(from)) return vertical ? cardInNextRow(from, ids, forward) : ids[ids.indexOf(from) + (forward ? 1 : -1)];
if (from && treeOrderRef.current.includes(from)) {
// Picked, but hidden by Changed: the nearest shown card past it in the tree's order.
@@ -491,7 +546,7 @@ export function ScreensView(props: ScreensViewProps) {
};
const go = (id: string) => {
pickRef.current(id);
requestAnimationFrame(() => document.getElementById(cardId(id))?.querySelector<HTMLElement>(".screen-screenshot-target")?.focus({ preventScroll: true }));
requestAnimationFrame(() => document.getElementById(cardId(id))?.querySelector<HTMLElement>(".screen-screenshot-target, .screens-strip-target")?.focus({ preventScroll: true }));
};
// A held arrow keeps stepping from the card the last step landed on, not the lagging pick.
const hold = createKeyHold();
@@ -520,13 +575,15 @@ export function ScreensView(props: ScreensViewProps) {
if (event.target instanceof Element && event.target.matches(".screens-find input")) {
if (event.isComposing || event.metaKey || event.ctrlKey || event.altKey || event.shiftKey || event.code === "ArrowLeft" || event.code === "ArrowRight") return;
const ids = orderRef.current;
const picked = selectedRef.current && ids.includes(selectedRef.current) ? selectedRef.current : undefined;
// In the filmstrip they step from the screen in the middle, as the page's arrows do.
const picked = stripFocusRef.current ?? (selectedRef.current && ids.includes(selectedRef.current) ? selectedRef.current : undefined);
const id = !arrow ? picked ?? ids[0] : next(event.code === "ArrowDown" ? "ArrowRight" : "ArrowLeft", picked);
if (!id) return;
event.preventDefault();
if (!arrow) { openRef.current(id); return; }
pickRef.current(id);
requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "nearest" }));
// The filmstrip brings the screen to its middle itself; scrolling its frame would move the page under it.
if (stripFocusRef.current === undefined) requestAnimationFrame(() => document.getElementById(cardId(id))?.scrollIntoView({ block: "nearest" }));
return;
}
// The browser's own repeat of a held arrow would scroll the page under the hold.
@@ -535,17 +592,18 @@ export function ScreensView(props: ScreensViewProps) {
const target = event.target instanceof Element ? event.target : null;
if (!arrow) {
// Return on a button or a link presses it; elsewhere on the page it opens the pick.
const selectedId = selectedRef.current;
const selectedId = stripFocusRef.current ?? selectedRef.current;
if (target?.closest("button, a, [role=\"button\"]") || !target?.closest("body") || !selectedId || !orderRef.current.includes(selectedId)) return;
if (target !== document.body && !target.closest(".screens-page")) return;
event.preventDefault();
openRef.current(selectedId);
return;
}
// The page, or the bottom toolbar that Screens was just opened from; its buttons have no arrow keys of their own.
const onPage = !target || target === document.body || target.closest(".screens-page, .canvas-toolbar") !== null;
// The page, or the bottom toolbar that Screens was just opened from, or the layout switch just used; their buttons
// have no arrow keys of their own.
const onPage = !target || target === document.body || target.closest(".screens-page, .canvas-toolbar, .screens-layout-switch") !== null;
if (!onPage || target?.closest(".screens-tree-list")) return;
const id = next(event.code, selectedRef.current);
const id = next(event.code, stripFocusRef.current ?? selectedRef.current);
if (!id) return;
event.preventDefault();
go(id);
@@ -566,6 +624,28 @@ export function ScreensView(props: ScreensViewProps) {
};
}, [props.phone]);
// A double-click on a card's screenshot opens that screen in the filmstrip. The first click selects it and opens the
// Inspector, which narrows the grid and can slide over the card, so the second click may land on another card or on
// the Inspector: the double-click is heard on the whole document, and the screen opened is the one the first click
// picked. The route under a screenshot copies a link and is no click on the card.
const openFilmstripRef = useRef<((id: string) => void) | undefined>(undefined);
openFilmstripRef.current = !props.phone && !filmstrip && props.onChangeLayout ? (id: string) => {
(props.onPickScreen ?? props.onSelectScreen)(id);
props.onChangeLayout!("filmstrip");
} : undefined;
useEffect(() => {
const onDoubleClick = (event: MouseEvent) => {
const first = cardClick.current;
// A double-click elsewhere, or later, is not this card's.
if (!first || event.timeStamp - first.at > DOUBLE_CLICK_MS
|| Math.hypot(event.clientX - first.x, event.clientY - first.y) > DOUBLE_CLICK_SLOP_PX) return;
cardClick.current = undefined;
openFilmstripRef.current?.(first.id);
};
document.addEventListener("dblclick", onDoubleClick);
return () => document.removeEventListener("dblclick", onDoubleClick);
}, []);
// The Inspector floats over the right edge; the page keeps its content clear of it.
const { visibleFrame } = useCanvasVisibleFrame();
const style = !props.phone && visibleFrame
@@ -574,6 +654,30 @@ export function ScreensView(props: ScreensViewProps) {
if (screens.length === 0) return <NoScreens map={props.map} />;
// Grid or Filmstrip, in words, at the top right where the Map keeps its camera: outside the page, so it stays put
// as the grid scrolls, and clear of the Inspector.
// A canvas narrowed by the Inspector keeps the switch's icons only, clear of the pill; one too narrow for even those
// hides it, as the Map's camera hides (camera-controls.tsx). Esc, a double-click and closing the Inspector remain.
const frameWidth = visibleFrame?.width ?? Infinity;
const layoutSwitch = !props.phone && props.onChangeLayout && frameWidth >= SWITCH_MINIMUM_FRAME_WIDTH ? (
<div className={`screens-layout-switch${frameWidth < SWITCH_LABELLED_FRAME_WIDTH ? " compact" : ""}`} role="group" aria-label="Screens layout"
style={visibleFrame ? ({ "--screens-switch-right": `calc(100% - ${visibleFrame.x + visibleFrame.width}px)` } as CSSProperties) : undefined}>
{([
["grid", "Grid", <LayoutGrid key="grid" aria-hidden="true" />, SHORTCUTS.screens.grid],
["filmstrip", "Filmstrip", <GalleryHorizontal key="filmstrip" aria-hidden="true" />, SHORTCUTS.screens.filmstrip],
] as const)
.map(([value, label, icon, shortcut]) => (
<Tooltip key={value} label={label} shortcut={formatShortcut(shortcut)} placement="bottom">
<button type="button" aria-label={label} aria-pressed={(filmstrip ? "filmstrip" : "grid") === value}
onClick={() => props.onChangeLayout!(value)}>
{icon}<span aria-hidden="true">{label}</span>
</button>
</Tooltip>
))}
</div>
) : null;
const dimmed = (id: string) => Boolean(props.focus?.length) && !props.focus!.some((state) => state === focusStatusOf(props.diff?.screens.get(id)));
const cell = (id: string) => {
const screen = props.index.screens.get(id);
return screen ? (
@@ -583,8 +687,14 @@ export function ScreensView(props: ScreensViewProps) {
typicalSize={typicalSize}
phone={props.phone}
selected={props.selectedScreenId === id}
dimmed={Boolean(props.focus?.length) && !props.focus!.some((state) => state === focusStatusOf(props.diff?.screens.get(id)))}
onSelect={() => props.onSelectScreen(id)} />
dimmed={dimmed(id)}
onSelect={(event) => {
// The second click of a double-click selects nothing: it may land on another card the first click's Inspector
// moved under the pointer. The first click is kept with its place, for the double-click that follows.
if (event.detail >= 2) return;
cardClick.current = { id, at: event.timeStamp, x: event.clientX, y: event.clientY };
props.onSelectScreen(id);
}} />
) : null;
};
@@ -601,9 +711,12 @@ export function ScreensView(props: ScreensViewProps) {
);
return (
<main ref={scroller} className={`screens-page${props.phone ? " phone" : ""}`} aria-label="Screens" style={style}
<>
{layoutSwitch}
<main ref={scroller} className={`screens-page${props.phone ? " phone" : ""}${filmstrip ? " filmstrip" : ""}`} aria-label="Screens" style={style}
onClick={(event) => {
if (!props.onClearSelection || !props.selectedScreenId) return;
// The filmstrip always shows a screen; clearing the pick there would only jump it back to the first.
if (!props.onClearSelection || !props.selectedScreenId || filmstrip) return;
if ((event.target as Element).closest("button, a, input, .screens-cell, .screens-side")) return;
props.onClearSelection();
}}>
@@ -632,12 +745,29 @@ export function ScreensView(props: ScreensViewProps) {
) : null}
<div className="screens-body">
{props.phone ? null : (
{props.phone ? null : sideCollapsed ? (
<aside className="screens-side collapsed">
<button type="button" className={`screens-side-toggle${inChanged ? " narrowed" : ""}`} aria-expanded={false}
aria-label={inChanged ? "Show sidebar, showing changed screens only" : "Show sidebar"}
title={inChanged ? "Show sidebar · Changed only" : "Show sidebar"}
onClick={() => toggleSide(false)}>
<PanelLeftOpen aria-hidden="true" />
</button>
</aside>
) : (
<aside className="screens-side">
<nav className="screens-tree" aria-label={tree.mode === "source" ? "Route files" : "Navigation"}>
{findSearch ? <div className="screens-tree-head searching">{findSearch}</div>
: filterChips || foldAll || findButton ? <div className="screens-tree-head">{filterChips}{findButton}{foldAll}</div> : null}
<h2>{tree.mode === "source" ? "app/" : "Explored app"}</h2>
{/* The find field heads the tree with fold-all and the sidebar's own fold beside it, so a report without
changes has no empty row; Changed / All follows under it, the whole width, when there are changes. */}
<div className="screens-tree-head">
{findSearch}{foldAll}
{/* Folding the sidebar away clears its find, which would otherwise narrow the screens out of sight. */}
<button type="button" className="screens-side-toggle" aria-label="Hide sidebar" title="Hide sidebar" aria-expanded
onClick={() => { setQuery(""); toggleSide(true); }}>
<PanelLeftClose aria-hidden="true" />
</button>
</div>
{filterChips}
{matches && order.length === 0
? <p className="screens-find-empty" role="status">{noMatch}</p>
: treeRows}
@@ -664,6 +794,13 @@ export function ScreensView(props: ScreensViewProps) {
<button type="button" className="screens-empty-all" onPointerDown={(event) => event.preventDefault()}
onClick={() => { setFilter("all"); focusFind(); }}>Show all</button></p>
: <p>Try part of a route, or press Esc to show every {inChanged ? "changed " : ""}screen.</p>}</div>
: stripFocus ? (
<ScreensFilmstrip order={order} focusedId={stripFocus} selectedId={props.selectedScreenId}
index={props.index} diff={props.diff} tree={tree} shape={shape}
typicalSize={typicalSize} frameId={cardId} dimmed={dimmed}
dot={(id) => dotClass(props.diff, props.changedElsewhere, id)}
onPick={props.onPickScreen ?? props.onSelectScreen} onOpen={props.onSelectScreen} />
)
: <div className="screens-grid">{order.map(cell)}</div>
)}
</div>
@@ -678,5 +815,6 @@ export function ScreensView(props: ScreensViewProps) {
</PhoneSheet>
) : null}
</main>
</>
);
}
+8 -1
View File
@@ -14,6 +14,8 @@ export type FocusStatus = "added" | "modified" | "accessibility-only" | "removed
export type InspectView = "session" | "diff";
/** Which way the inspector's transition list reads: into the screen, or out of it. */
export type TransitionDirection = "in" | "out";
/** How Screens lays out its screens: every card in a grid, or one at a time in a filmstrip. */
export type ScreensLayout = "grid" | "filmstrip";
export type Route = {
canvas: CanvasView;
@@ -35,6 +37,8 @@ export type Route = {
focus: FocusStatus[];
/** Progressive Map groups the reader explicitly expanded, in stable URL order. */
expandedGroups: string[];
/** Screens' layout; unset is the grid. Only Screens has one. */
layout?: ScreensLayout | undefined;
};
/** What the grammar needs from the app: which baselines exist, and which screens record a route. */
@@ -218,11 +222,12 @@ export function canonicalRoute(route: Route, ctx: RouteContext): Route {
baseline,
focus: compared ? FOCUSES.filter((status) => route.focus.includes(status)) : [],
expandedGroups,
...(canvas === "screens" && route.layout === "filmstrip" ? { layout: "filmstrip" as const } : {}),
};
}
/** The query parameters that mean the same in another target's report of the run. */
const PLACE_PARAMS = ["inspect", "dir", "focus"] as const;
const PLACE_PARAMS = ["inspect", "dir", "focus", "layout"] as const;
/**
* Where the reader is, as another target's report reads it: the canvas and the screen's route (which resolves to that
@@ -291,6 +296,7 @@ export function parseLocation(location: LocationLike, ctx: RouteContext): Route
baseline: baseline === null ? ctx.defaultBaseline : baseline === "none" ? "" : baseline,
focus,
expandedGroups: legacyGraph ? [] : params.getAll("expand"),
...(params.get("layout") === "filmstrip" ? { layout: "filmstrip" as const } : {}),
}, ctx);
}
@@ -319,6 +325,7 @@ export function formatRoute(route: Route, ctx: RouteContext): string {
params.set("baseline", next.baseline === "" ? "none" : next.baseline);
}
if (next.focus.length > 0) params.set("focus", next.focus.join(","));
if (next.layout) params.set("layout", next.layout);
const search = params.toString().replace(/%2C/gi, ",");
return `/${next.canvas}${suffix}${search ? `?${search}` : ""}`;
+21
View File
@@ -0,0 +1,21 @@
import type { ScreensLayout } from "./navigation";
function storageKey(runId: string): string {
return `explore:screens-layout:${runId}`;
}
/** The layout Screens last showed for a report, so opening Screens again shows it; unavailable storage remembers nothing. */
export function readScreensLayout(runId: string | undefined): ScreensLayout | undefined {
if (!runId) return undefined;
try {
return localStorage.getItem(storageKey(runId)) === "filmstrip" ? "filmstrip" : undefined;
} catch { return undefined; }
}
export function writeScreensLayout(runId: string | undefined, layout: ScreensLayout): void {
if (!runId) return;
try {
if (layout === "filmstrip") localStorage.setItem(storageKey(runId), layout);
else localStorage.removeItem(storageKey(runId));
} catch { /* The layout lasts for this visit only. */ }
}
+5
View File
@@ -116,6 +116,11 @@ export const SHORTCUTS = {
screens: ctrl("Digit2", "2"),
compare: ctrl("Digit3", "3"),
},
/** Screens only, on desktop: G for the grid and E for the filmstrip, as Lightroom's Library switches Grid and Loupe. */
screens: {
grid: plain("KeyG", "G"),
filmstrip: plain("KeyE", "E"),
},
/** Compare only. The arrows walk changed screens; J and K walk the changed areas of one. */
compare: {
previousScreen: plain("ArrowLeft", "←"),