mirror of
https://github.com/expo/explore.git
synced 2026-11-15 13:18:16 -10:00
Compare commits
11
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0a4c5690d1 | ||
|
|
458003e9e5 | ||
|
|
5f12800908 | ||
|
|
2c5f8f85a3 | ||
|
|
23227ca55c | ||
|
|
ed1bf34434 | ||
|
|
bdf9e597d3 | ||
|
|
9063de5c52 | ||
|
|
21ed8c06f6 | ||
|
|
6795f19d04 | ||
|
|
990e2ecc8d |
No files matched your search
+7
-3
@@ -157,6 +157,10 @@ runs:
|
||||
EXPO_TOKEN: ${{ inputs.expo_token }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [[ ! -e "$OUTPUT/head-session" && ! -L "$OUTPUT/head-session" && ! -e "$OUTPUT/base-session" && ! -L "$OUTPUT/base-session" ]]; then exit 0; fi
|
||||
node "$TOOLS/scripts/cleanup-ci-sessions.mjs" --eas "$TOOLS/node_modules/.bin/eas" \
|
||||
--session-file "$OUTPUT/head-session" --session-file "$OUTPUT/base-session"
|
||||
# A side that captures an appearance in a session of its own records it as <side>-session-<scheme>.
|
||||
files=()
|
||||
for name in head-session base-session head-session-light head-session-dark base-session-light base-session-dark; do
|
||||
if [[ -e "$OUTPUT/$name" || -L "$OUTPUT/$name" ]]; then files+=(--session-file "$OUTPUT/$name"); fi
|
||||
done
|
||||
if (( ${#files[@]} == 0 )); then exit 0; fi
|
||||
node "$TOOLS/scripts/cleanup-ci-sessions.mjs" --eas "$TOOLS/node_modules/.bin/eas" "${files[@]}"
|
||||
@@ -103,6 +103,8 @@ exploration:
|
||||
capture:
|
||||
maxMinutes: 30
|
||||
maxActions: 500
|
||||
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
|
||||
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
|
||||
repack: eas # eas (hosted workflow job; the default on EAS Simulator) | local (repack-app on the runner; the default with simulator: local)
|
||||
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
|
||||
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
|
||||
|
||||
@@ -109,6 +109,8 @@ capture:
|
||||
# simulator: eas # eas (EAS Simulator, default) | local (a simulator or emulator Explore starts on this machine with Xcode or the Android SDK; --simulator overrides it for one run)
|
||||
maxMinutes: 30
|
||||
maxActions: 500
|
||||
# maxSessions: 5 # the most EAS Simulator sessions one review runs at once, across all its targets and sides (default: 5, a typical plan's concurrent simulator limit). Each target's job gets floor(maxSessions / targets) sessions, at least one, and sessions left over go to foldable targets (pose): one target gets 5 (head and base at once, light and dark in their own sessions when that pays), two get 2 each, five get 1 each (head, then base). Below the number of targets, only that many target jobs run at once (the workflow's max-parallel, and a local review's targets), one session each. A side spreads its light and dark passes over separate sessions only when that saves it at least a minute, so the ceiling is a limit, not a target: a 3-route target stays on two sessions. euxy's four targets: 8 is two per target, 16 captures each appearance in its own session (measured: an iPhone side 6:12 → 4:26, one repack shared by its sessions, ~3.5 session-minutes more per side).
|
||||
# On a starter plan (one simulator per platform), set maxSessions to the plan's limit, e.g. 2 for an iOS and an Android target.
|
||||
repack: eas # eas (hosted EAS workflow job, the default on EAS Simulator) | local (repack-app on the runner, the default with simulator: local; --repack overrides it for one run)
|
||||
appearance: auto # auto (follow the app's userInterfaceStyle: automatic captures light and dark) | dark | light | [dark, light]
|
||||
launch: screenshot # screenshot (relaunch the app per appearance and keep its splash and first settled frame, default) | video (also keep a launch recording in the report) | off
|
||||
@@ -221,7 +223,7 @@ Capture handles iOS's confirmation to open a link in the expected app. After a f
|
||||
|
||||
### Stable captures (optional)
|
||||
|
||||
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
|
||||
Screenshots are compared pixel by pixel, so anything that changes between runs shows up as a Screen variant or noise: the current time and relative dates, animations and loading indicators that can be caught mid-frame, screens that move on by themselves, and permission prompts that depend on earlier runs. When both builds capture light and dark, text that differs between each build's own two captures (a clock, a relative date, a random name) is reported as runtime state, never as the change that makes a screen Modified; text that only follows the appearance, or a word beside it that changed, is still a change. If your app has these, consider making the capture profile's build fix them, for example with an environment variable in that EAS profile that the app reads. What to fix depends on your app; your coding agent can find candidates in the source, and each change is an app change for you to approve. The [example app's `explore` profile](../test/ci/apps/wallet/README.md#explore-build-profile) is one example.
|
||||
|
||||
### Agent usage and reuse
|
||||
|
||||
|
||||
+1
-1
@@ -50,7 +50,7 @@
|
||||
"test:node": "node --test test/node/*.test.mjs",
|
||||
"test:hosting": "npm --prefix viewer-host run typecheck && npm --prefix viewer-host test",
|
||||
"test:viewer:artifacts": "node --test test/browser/artifact-report.browser.mjs test/browser/artifact-cache.browser.mjs",
|
||||
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
|
||||
"test:viewer:browser": "node --test test/browser/screenshot-image.browser.mjs test/browser/swipe-outlines.browser.mjs test/browser/split-outlines.browser.mjs test/browser/inspector-notes.browser.mjs test/browser/inspector-variants.browser.mjs test/browser/inspector-source-navigation.browser.mjs test/browser/map-edge-presentation.browser.mjs test/browser/local-ci-view.browser.mjs test/browser/report-viewer.browser.mjs",
|
||||
"test:viewer:e2e": "npm run test:viewer:browser && playwright test",
|
||||
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p viewer/tsconfig.json --noEmit",
|
||||
"lint": "eslint .",
|
||||
|
||||
@@ -10,7 +10,8 @@ const SESSION_ID = /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/;
|
||||
|
||||
/** Stop only exact sessions whose ownership the capture coordinator already verified. */
|
||||
export async function cleanupCiSessions({ sessionFiles, easCommand, environment = process.env, runCommand = spawnSync }) {
|
||||
if (!Array.isArray(sessionFiles) || sessionFiles.length > 3) throw new Error('Provide at most three explicit session handoff files.');
|
||||
// head, base and baseline, each with a session per appearance pass (light, dark) beside its own.
|
||||
if (!Array.isArray(sessionFiles) || sessionFiles.length > 9) throw new Error('Provide at most nine explicit session handoff files.');
|
||||
const temporary = await realpath(environment.RUNNER_TEMP || tmpdir());
|
||||
const result = { stopped: [], failures: [] };
|
||||
let project;
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
/**
|
||||
* Runs the Argent bridge's commands on a worker thread of this process, through a synchronous runner, so the
|
||||
* capture's command-at-a-time control flow keeps one bridge and one tool-server connection for the whole run
|
||||
* instead of starting a process per command. Commands for any other executable go to the fallback runner.
|
||||
*/
|
||||
import { Worker } from "node:worker_threads";
|
||||
import { commandOutcome } from "./controller.js";
|
||||
import type { CommandRequest, CommandResult, CommandRunner } from "./run.js";
|
||||
import { BRIDGE_HEADER_BYTES, BRIDGE_KIND_UNAVAILABLE, BRIDGE_SLOT_KIND, BRIDGE_SLOT_LENGTH, BRIDGE_SLOT_READY, type BridgeRequest, type BridgeWorkerData } from "./argent-bridge-worker.js";
|
||||
|
||||
/** Room for one answer: an accessibility tree of a large screen is a few megabytes. */
|
||||
const BRIDGE_BUFFER_BYTES = 64 * 1024 * 1024;
|
||||
/** How long a command gets when its request names no timeout. */
|
||||
const DEFAULT_COMMAND_TIMEOUT_MS = 10 * 60_000;
|
||||
/** After a timeout, how long the thread gets to confirm it dropped the command. */
|
||||
const ABORT_GRACE_MS = 15_000;
|
||||
|
||||
export type ArgentBridgeRunner = {
|
||||
runner: CommandRunner;
|
||||
/** Whether commands still go to the thread (false after it proved unavailable or stopped answering). */
|
||||
readonly active: boolean;
|
||||
close(): void;
|
||||
};
|
||||
|
||||
export function startArgentBridgeRunner(options: {
|
||||
/** The bridge executable the callers name; its commands run on the thread. */
|
||||
command: string;
|
||||
/** The bridge's environment, as argentControllerInvocation builds it. */
|
||||
environment: NodeJS.ProcessEnv;
|
||||
fallback: CommandRunner;
|
||||
/** Tests: a module exporting `createArgentClient` in place of the pinned Argent release's client. */
|
||||
clientModule?: string;
|
||||
progress?: (message: string) => void;
|
||||
}): ArgentBridgeRunner {
|
||||
const shared = new SharedArrayBuffer(BRIDGE_HEADER_BYTES + BRIDGE_BUFFER_BYTES);
|
||||
const header = new Int32Array(shared, 0, BRIDGE_HEADER_BYTES / 4);
|
||||
const bytes = new Uint8Array(shared, BRIDGE_HEADER_BYTES);
|
||||
const workerData: BridgeWorkerData = { shared, ...(options.clientModule ? { clientModule: options.clientModule } : {}) };
|
||||
let worker: Worker | undefined;
|
||||
// The environment the thread runs with: a copy, so a caller that changes the session's (a restarted local
|
||||
// tool-server's URL and token) is seen by the next command, which starts a thread with the new one.
|
||||
let environment: NodeJS.ProcessEnv = {};
|
||||
const start = (from: NodeJS.ProcessEnv) => {
|
||||
environment = { ...from };
|
||||
try {
|
||||
const started = new Worker(new URL("./argent-bridge-worker.js", import.meta.url), { workerData, env: environment });
|
||||
// A thread that crashes stops serving; the commands after it run per command.
|
||||
started.on("error", error => { if (worker === started) stop(`the Argent bridge thread failed (${error.message}); running the bridge per command`); });
|
||||
worker = started;
|
||||
} catch (error) { options.progress?.(`the Argent bridge thread could not start (${(error as Error).message}); running the bridge per command`); }
|
||||
};
|
||||
let sequence = 0;
|
||||
const stop = (reason: string) => {
|
||||
if (!worker) return;
|
||||
options.progress?.(reason);
|
||||
void worker.terminate();
|
||||
worker = undefined;
|
||||
};
|
||||
const changed = (next: NodeJS.ProcessEnv) => {
|
||||
const keys = new Set([...Object.keys(environment), ...Object.keys(next)]);
|
||||
return [...keys].some(key => environment[key] !== next[key]);
|
||||
};
|
||||
const waitFor = (id: number, timeoutMs: number): boolean => {
|
||||
const deadline = Date.now() + timeoutMs;
|
||||
for (;;) {
|
||||
// The value waited on is the one just compared: an answer stored after the comparison wakes the wait at once.
|
||||
const ready = Atomics.load(header, BRIDGE_SLOT_READY);
|
||||
if (ready === id) return true;
|
||||
const remaining = deadline - Date.now();
|
||||
if (remaining <= 0) return false;
|
||||
Atomics.wait(header, BRIDGE_SLOT_READY, ready, remaining);
|
||||
}
|
||||
};
|
||||
start(options.environment);
|
||||
const runner: CommandRunner = (request: CommandRequest): CommandResult => {
|
||||
// A recording runs per command, in the session's own directory: Argent's client saves one under the project its
|
||||
// working directory is in, and this thread's is the caller's checkout. The state file carries it between hosts.
|
||||
if (!worker || request.command !== options.command || request.args[0] === "record") return options.fallback(request);
|
||||
if (changed(request.environment)) { void worker.terminate(); worker = undefined; start(request.environment); }
|
||||
if (!worker) return options.fallback(request);
|
||||
const id = ++sequence;
|
||||
Atomics.store(header, BRIDGE_SLOT_READY, 0);
|
||||
worker.postMessage({ id, argv: request.args, ...(request.timeoutMs !== undefined ? { timeoutMs: request.timeoutMs } : {}) } satisfies BridgeRequest);
|
||||
const timeoutMs = request.timeoutMs ?? DEFAULT_COMMAND_TIMEOUT_MS;
|
||||
if (!waitFor(id, timeoutMs)) {
|
||||
worker.postMessage({ abort: id } satisfies BridgeRequest);
|
||||
if (!waitFor(id, ABORT_GRACE_MS)) stop("the Argent bridge thread stopped answering; running the bridge per command");
|
||||
throw Object.assign(new Error(`${request.command} ${request.args[0] ?? ""} timed out after ${timeoutMs} ms`), { code: "ETIMEDOUT" });
|
||||
}
|
||||
const text = Buffer.from(bytes.subarray(0, Atomics.load(header, BRIDGE_SLOT_LENGTH))).toString("utf8");
|
||||
if (Atomics.load(header, BRIDGE_SLOT_KIND) === BRIDGE_KIND_UNAVAILABLE) {
|
||||
stop(`the Argent bridge thread is unavailable (${text}); running the bridge per command`);
|
||||
return options.fallback(request);
|
||||
}
|
||||
const result = JSON.parse(text) as { exitCode: number; stdout: string };
|
||||
return commandOutcome(request, { status: result.exitCode, stdout: result.stdout, stderr: "" });
|
||||
};
|
||||
return { runner, get active() { return worker !== undefined; }, close: () => { if (worker) { void worker.terminate(); worker = undefined; } } };
|
||||
}
|
||||
@@ -0,0 +1,144 @@
|
||||
/**
|
||||
* The Argent bridge on a worker thread: one bridge and one tool-server connection for a whole capture, instead of a
|
||||
* process (and a TLS handshake) per command. The capture thread posts a command and blocks on the shared buffer;
|
||||
* this thread runs it through Argent's own client library (the code `argent run` uses) and writes the answer back.
|
||||
*/
|
||||
import { isMainThread, parentPort, workerData } from "node:worker_threads";
|
||||
import { copyFile, mkdir, open, writeFile } from "node:fs/promises";
|
||||
import { dirname, join } from "node:path";
|
||||
import { pathToFileURL } from "node:url";
|
||||
import { ArgentCallError, type ArgentCall } from "./argent-driver.js";
|
||||
import { argentBridgeSettings, createArgentBridge, type ArgentBridge } from "./argent-bridge.js";
|
||||
import { ensureController } from "../shared/controller-cache.js";
|
||||
|
||||
/** The shared buffer: four Int32 header slots, then the UTF-8 answer. */
|
||||
export const BRIDGE_HEADER_BYTES = 16;
|
||||
export const BRIDGE_SLOT_READY = 0;
|
||||
export const BRIDGE_SLOT_LENGTH = 1;
|
||||
export const BRIDGE_SLOT_KIND = 2;
|
||||
export const BRIDGE_KIND_RESULT = 0;
|
||||
/** The bridge cannot run on this thread (Argent's client did not load); the host falls back to the process bridge. */
|
||||
export const BRIDGE_KIND_UNAVAILABLE = 1;
|
||||
|
||||
export type BridgeWorkerData = { shared: SharedArrayBuffer; clientModule?: string };
|
||||
export type BridgeRequest = { id: number; argv: readonly string[]; timeoutMs?: number } | { abort: number };
|
||||
|
||||
const ARGENT_CALL_TIMEOUT_MS = 180_000;
|
||||
|
||||
/** Argent's programmatic client, as `dist/client.js` of the pinned release exports it. */
|
||||
type ArgentClient = { callTool(name: string, args: Record<string, unknown>, options?: { signal?: AbortSignal }): Promise<{ data: unknown; note?: string }> };
|
||||
|
||||
/** Whether some bytes begin as a PNG or a JPEG does: `--out` is a screenshot, and nothing else is taken for one. */
|
||||
function isImage(head: Uint8Array): boolean {
|
||||
const png = [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a], jpeg = [0xff, 0xd8, 0xff];
|
||||
return [png, jpeg].some(signature => signature.every((byte, index) => head[index] === byte));
|
||||
}
|
||||
|
||||
/** Whether a path names a file that is an image by its content. */
|
||||
async function imageFile(path: string): Promise<boolean> {
|
||||
const file = await open(path, "r").catch(() => undefined);
|
||||
if (!file) return false;
|
||||
try {
|
||||
if (!(await file.stat()).isFile()) return false;
|
||||
const head = new Uint8Array(8);
|
||||
const { bytesRead } = await file.read(head, 0, head.length, 0);
|
||||
return isImage(head.subarray(0, bytesRead));
|
||||
} finally { await file.close(); }
|
||||
}
|
||||
|
||||
/** The first string in a tool's answer that names an image file: the materialized screenshot (`path` first). */
|
||||
async function materializedFile(data: unknown): Promise<string | undefined> {
|
||||
const candidates: string[] = [];
|
||||
const walk = (value: unknown, key?: string) => {
|
||||
if (typeof value === "string") { if (key === "path") candidates.unshift(value); else candidates.push(value); }
|
||||
else if (Array.isArray(value)) value.forEach(item => walk(item));
|
||||
else if (value && typeof value === "object") Object.entries(value).forEach(([k, v]) => walk(v, k));
|
||||
};
|
||||
walk(data);
|
||||
for (const candidate of candidates) {
|
||||
if (candidate.startsWith("/") && await imageFile(candidate)) return candidate;
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
async function loadClient(environment: NodeJS.ProcessEnv, clientModule?: string): Promise<ArgentClient> {
|
||||
const module = clientModule ?? join(dirname(await ensureController("argent", { environment })), "client.js");
|
||||
const loaded = await import(pathToFileURL(module).href) as { createArgentClient?: () => ArgentClient };
|
||||
if (typeof loaded.createArgentClient !== "function") throw new Error(`${module} does not export createArgentClient`);
|
||||
return loaded.createArgentClient();
|
||||
}
|
||||
|
||||
/** The in-thread Argent call: the client's `callTool`, with `--out` served from the artifact it materialized. */
|
||||
export function argentClientCall(client: ArgentClient, signal: () => AbortSignal): ArgentCall {
|
||||
return async (tool, args, options) => {
|
||||
const active = signal();
|
||||
if (active.aborted) throw new ArgentCallError(`argent run ${tool} was not sent: the command was given up.`, false);
|
||||
let answer: { data: unknown };
|
||||
try { answer = await client.callTool(tool, args, { signal: AbortSignal.any([active, AbortSignal.timeout(ARGENT_CALL_TIMEOUT_MS)]) }); }
|
||||
catch (error) { throw new ArgentCallError(`argent run ${tool} failed: ${(error instanceof Error ? error.message : String(error)).slice(0, 800)}`, true); }
|
||||
if (!options?.out) return answer.data;
|
||||
const file = await materializedFile(answer.data);
|
||||
if (!file) {
|
||||
const url = (answer.data as { url?: unknown } | null)?.url;
|
||||
if (typeof url !== "string") throw new ArgentCallError(`argent run ${tool} did not write ${options.out}`, true);
|
||||
const response = await fetch(url, { signal: signal() });
|
||||
if (!response.ok) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}: ${response.status}`, true);
|
||||
const body = Buffer.from(await response.arrayBuffer());
|
||||
if (!isImage(body)) throw new ArgentCallError(`argent run ${tool} did not write ${options.out}: the answer is not an image`, true);
|
||||
await mkdir(dirname(options.out), { recursive: true });
|
||||
await writeFile(options.out, body);
|
||||
return { path: options.out };
|
||||
}
|
||||
await mkdir(dirname(options.out), { recursive: true });
|
||||
if (file !== options.out) await copyFile(file, options.out);
|
||||
return { path: options.out };
|
||||
};
|
||||
}
|
||||
|
||||
if (!isMainThread && parentPort && (workerData as Partial<BridgeWorkerData> | null)?.shared instanceof SharedArrayBuffer) {
|
||||
const port = parentPort;
|
||||
const { shared, clientModule } = workerData as BridgeWorkerData;
|
||||
const header = new Int32Array(shared, 0, BRIDGE_HEADER_BYTES / 4);
|
||||
const bytes = new Uint8Array(shared, BRIDGE_HEADER_BYTES);
|
||||
const answer = (id: number, kind: number, text: string) => {
|
||||
let encoded = Buffer.from(text, "utf8");
|
||||
if (encoded.length > bytes.length) {
|
||||
encoded = Buffer.from(JSON.stringify({ exitCode: 1, stdout: JSON.stringify({ success: false,
|
||||
error: { code: "COMMAND_FAILED", message: `The controller's answer (${encoded.length} bytes) exceeds the bridge buffer.` } }) }));
|
||||
}
|
||||
bytes.set(encoded);
|
||||
Atomics.store(header, BRIDGE_SLOT_LENGTH, encoded.length);
|
||||
Atomics.store(header, BRIDGE_SLOT_KIND, kind);
|
||||
Atomics.store(header, BRIDGE_SLOT_READY, id);
|
||||
Atomics.notify(header, BRIDGE_SLOT_READY);
|
||||
};
|
||||
const controllers = new Map<number, AbortController>();
|
||||
let current: AbortController | undefined;
|
||||
const settings = argentBridgeSettings(process.env);
|
||||
const bridge: Promise<ArgentBridge> = settings && settings.toolsUrl
|
||||
? loadClient(process.env, clientModule).then(client => createArgentBridge(settings, argentClientCall(client, () => current?.signal ?? new AbortController().signal), "thread"))
|
||||
: Promise.reject(new Error("The Argent bridge needs EXPLORE_ARGENT_STATE, EXPLORE_ARGENT_PLATFORM and ARGENT_TOOLS_URL."));
|
||||
bridge.catch(() => undefined);
|
||||
let queue: Promise<unknown> = Promise.resolve();
|
||||
port.on("message", (request: BridgeRequest) => {
|
||||
if ("abort" in request) { controllers.get(request.abort)?.abort(new Error("The capture gave up waiting for this command.")); return; }
|
||||
const controller = new AbortController();
|
||||
controllers.set(request.id, controller);
|
||||
queue = queue.then(async () => {
|
||||
current = controller;
|
||||
try {
|
||||
const ready = await bridge.catch(error => { throw Object.assign(error as Error, { unavailable: true }); });
|
||||
if (controller.signal.aborted) throw controller.signal.reason;
|
||||
const result = await ready.run(request.argv);
|
||||
answer(request.id, BRIDGE_KIND_RESULT, JSON.stringify(result));
|
||||
} catch (error) {
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
if ((error as { unavailable?: boolean }).unavailable) answer(request.id, BRIDGE_KIND_UNAVAILABLE, message);
|
||||
else answer(request.id, BRIDGE_KIND_RESULT, JSON.stringify({ exitCode: 1, stdout: JSON.stringify({ success: false, error: { code: "COMMAND_FAILED", message } }) }));
|
||||
} finally {
|
||||
controllers.delete(request.id);
|
||||
current = undefined;
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,137 @@
|
||||
/**
|
||||
* The Argent bridge behind both of its hosts: the command-line worker Explore spawns per command, and the
|
||||
* in-process worker thread that keeps one bridge (and one tool-server connection) for a whole capture. Each command
|
||||
* reads the shared state file, runs through `runBridgeCommand`, and writes the state back, so the two hosts can
|
||||
* take turns on one session.
|
||||
*/
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { appendFile, copyFile, mkdir, readFile, realpath, rename, rm, writeFile } from "node:fs/promises";
|
||||
import { dirname, join } from "node:path";
|
||||
import { createRequire } from "node:module";
|
||||
import type { DecodedFrame } from "../shared/png-evidence.js";
|
||||
import { runBridgeCommand, type ArgentBridgeState, type ArgentCall, type ArgentPlatform, type ArgentTree, type BridgeResult } from "./argent-driver.js";
|
||||
import { ARGENT_VERSION } from "../shared/argent-version.js";
|
||||
|
||||
export type ArgentBridgeSettings = {
|
||||
environment: NodeJS.ProcessEnv;
|
||||
statePath: string;
|
||||
platform: ArgentPlatform;
|
||||
toolsUrl: string | undefined;
|
||||
};
|
||||
|
||||
/** Reads the settings the bridge takes from its environment; absent when they are incomplete. */
|
||||
export function argentBridgeSettings(environment: NodeJS.ProcessEnv): ArgentBridgeSettings | undefined {
|
||||
const statePath = environment.EXPLORE_ARGENT_STATE;
|
||||
const platform = environment.EXPLORE_ARGENT_PLATFORM;
|
||||
if (!statePath || (platform !== "ios" && platform !== "android")) return undefined;
|
||||
return { environment, statePath, platform, toolsUrl: environment.ARGENT_TOOLS_URL };
|
||||
}
|
||||
|
||||
async function readState(path: string): Promise<ArgentBridgeState> {
|
||||
try { return JSON.parse(await readFile(path, "utf8")) as ArgentBridgeState; }
|
||||
catch { return { generation: 0 }; }
|
||||
}
|
||||
|
||||
/** Written whole and renamed into place, so a command stopped mid-write never leaves a torn state. */
|
||||
async function writeState(path: string, state: ArgentBridgeState): Promise<void> {
|
||||
const temporary = `${path}.${process.pid}.tmp`;
|
||||
await writeFile(temporary, JSON.stringify(state), { mode: 0o600 });
|
||||
await rename(temporary, path);
|
||||
}
|
||||
|
||||
/** A call's arguments for the debug log: text that could be typed into a field is logged by length only. */
|
||||
function loggedArgs(args: Record<string, unknown>): Record<string, unknown> {
|
||||
return Object.fromEntries(Object.entries(args).map(([key, value]) => key === "text" && typeof value === "string" ? [key, `<${value.length} characters>`]
|
||||
: key === "steps" && Array.isArray(value) ? [key, `<${value.length} steps>`] : [key, value]));
|
||||
}
|
||||
|
||||
/** What a call answered, for the debug log: a tree's shape, not its contents. */
|
||||
function summarize(tool: string, value: unknown): unknown {
|
||||
if (!value || typeof value !== "object") return value;
|
||||
if (tool !== "ui-tree") return Object.keys(value);
|
||||
const tree = value as ArgentTree;
|
||||
let nodes = 0;
|
||||
const walk = (node: { children?: unknown[] }) => { nodes++; (node.children ?? []).forEach(child => walk(child as { children?: unknown[] })); };
|
||||
(tree.roots ?? []).forEach(walk);
|
||||
return { foregroundApp: tree.foregroundApp, alertVisible: tree.alertVisible, keyboardVisible: tree.keyboardVisible, truncated: tree.truncated,
|
||||
screen: tree.screen, nodes, roots: (tree.roots ?? []).map(root => [root.type ?? null, root.bundleId ?? null, (root.children ?? []).length]) };
|
||||
}
|
||||
|
||||
export type ArgentBridge = {
|
||||
/** Runs one agent-device-shaped command against the session. */
|
||||
run(argv: readonly string[]): Promise<BridgeResult>;
|
||||
};
|
||||
|
||||
/**
|
||||
* One bridge over the given Argent call. `host` names the process running it in the debug log.
|
||||
*/
|
||||
export function createArgentBridge(settings: ArgentBridgeSettings, call: ArgentCall, host: "process" | "thread"): ArgentBridge {
|
||||
const { environment, statePath, platform, toolsUrl } = settings;
|
||||
const logPath = environment.EXPLORE_ARGENT_LOG_DIR
|
||||
? join(environment.EXPLORE_ARGENT_LOG_DIR, `argent-${platform}-${environment.EXPLORE_ARGENT_LOG_NAME ?? "bridge"}.jsonl`) : undefined;
|
||||
return {
|
||||
async run(argv) {
|
||||
// EXPLORE_ARGENT_LOG_DIR (opt-in): every Argent call this bridge makes, how long it took, and the shape of what it read.
|
||||
const log = async (entry: Record<string, unknown>) => {
|
||||
if (!logPath) return;
|
||||
await appendFile(logPath, `${JSON.stringify({ at: new Date().toISOString(), host, command: argv[0], ...entry })}\n`, { mode: 0o600 }).catch(() => undefined);
|
||||
};
|
||||
const state = await readState(statePath);
|
||||
const result = await runBridgeCommand(argv, {
|
||||
state, platform, version: ARGENT_VERSION,
|
||||
...(environment.EXPLORE_ARGENT_BUNDLE_ID ? { bundleId: environment.EXPLORE_ARGENT_BUNDLE_ID } : {}),
|
||||
...(environment.EXPLORE_ARGENT_DEVICE ? { device: environment.EXPLORE_ARGENT_DEVICE } : {}),
|
||||
// An opened foldable's inner panel shows its UI in landscape (Argent's fold: "Unfolded, the UI is landscape").
|
||||
...(platform === "ios" && ["open", "half-open"].includes(environment.EXPLORE_ARGENT_POSE ?? "") ? { landscape: true } : {}),
|
||||
call: async (tool, args, options) => {
|
||||
const started = Date.now();
|
||||
try {
|
||||
const value = await call(tool, args, options);
|
||||
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, summary: summarize(tool, value) });
|
||||
return value;
|
||||
} catch (error) {
|
||||
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, error: (error instanceof Error ? error.message : String(error)).slice(0, 400) });
|
||||
throw error;
|
||||
}
|
||||
},
|
||||
reachable: async () => {
|
||||
let ok = false;
|
||||
try {
|
||||
const token = environment.ARGENT_AUTH_TOKEN;
|
||||
// The same URL Argent's own client checks: ARGENT_TOOLS_URL may carry a path, which /tools is appended to.
|
||||
const response = await fetch(`${(toolsUrl ?? "").replace(/\/+$/, "")}/tools`, { headers: token ? { authorization: `Bearer ${token}` } : {}, signal: AbortSignal.timeout(5_000) });
|
||||
await response.body?.cancel();
|
||||
ok = response.status < 500;
|
||||
} catch { ok = false; }
|
||||
if (!ok) await log({ tool: "reachable", ok });
|
||||
return ok;
|
||||
},
|
||||
sleep: milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds)),
|
||||
orientVideo: async path => {
|
||||
const probed = spawnSync("ffprobe", ["-v", "error", "-select_streams", "v:0", "-show_entries", "stream=width,height", "-of", "csv=p=0:s=x", path], { encoding: "utf8", timeout: 30_000 });
|
||||
const [width, height] = (probed.stdout ?? "").trim().split("x").map(Number);
|
||||
if (probed.status !== 0 || !width || !height || width >= height) return;
|
||||
const turned = `${path}.upright.mp4`;
|
||||
const ffmpeg = spawnSync("ffmpeg", ["-nostdin", "-y", "-loglevel", "error", "-i", path, "-vf", "transpose=clock", "-an", turned], { encoding: "utf8", timeout: 120_000 });
|
||||
if (ffmpeg.status === 0) await rename(turned, path);
|
||||
else await rm(turned, { force: true });
|
||||
},
|
||||
scratchImage: { path: join(dirname(statePath), "argent-scratch.png"), read: async path => {
|
||||
const { PNG } = createRequire(import.meta.url)("pngjs") as { PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
|
||||
return PNG.sync.read(await readFile(path), { checkCRC: false });
|
||||
} },
|
||||
moveFile: async (from, to) => {
|
||||
const source = await realpath(from);
|
||||
const roots = await Promise.all([environment.HOME, process.cwd()].filter((root): root is string => !!root).map(root => realpath(root).catch(() => root)));
|
||||
if (!roots.some(root => source.startsWith(`${root}/`))) throw new Error(`Argent returned a recording outside its own directories: ${from}`);
|
||||
await mkdir(dirname(to), { recursive: true });
|
||||
try { await rename(from, to); }
|
||||
catch { await copyFile(from, to); await rm(from, { force: true }); }
|
||||
},
|
||||
});
|
||||
await writeState(statePath, state);
|
||||
await log({ result: result.exitCode === 0 ? "ok" : result.stdout.slice(0, 300) });
|
||||
return result;
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -2,71 +2,30 @@
|
||||
* The Argent controller's command line: Explore runs it where it would run agent-device, with the same
|
||||
* arguments. Each command becomes `argent run <tool> --args <json>` calls, as EAS Simulator recommends
|
||||
* driving an `argent` session, with the session's ARGENT_TOOLS_URL and ARGENT_AUTH_TOKEN in the environment.
|
||||
* A capture keeps the same bridge on a worker thread instead (argent-bridge-host); this entry serves the callers
|
||||
* that run one command at a time.
|
||||
*/
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { appendFile, copyFile, mkdir, readFile, realpath, rename, rm, stat, writeFile } from "node:fs/promises";
|
||||
import { dirname, join } from "node:path";
|
||||
import { createRequire } from "node:module";
|
||||
import type { DecodedFrame } from "../shared/png-evidence.js";
|
||||
import { ArgentCallError, runBridgeCommand, type ArgentBridgeState, type ArgentPlatform, type ArgentTree } from "./argent-driver.js";
|
||||
import { ARGENT_VERSION } from "../shared/argent-version.js";
|
||||
import { stat } from "node:fs/promises";
|
||||
import { ArgentCallError } from "./argent-driver.js";
|
||||
import { argentBridgeSettings, createArgentBridge } from "./argent-bridge.js";
|
||||
import { ensureController } from "../shared/controller-cache.js";
|
||||
|
||||
const ARGENT_CALL_TIMEOUT_MS = 180_000;
|
||||
|
||||
async function readState(path: string): Promise<ArgentBridgeState> {
|
||||
try { return JSON.parse(await readFile(path, "utf8")) as ArgentBridgeState; }
|
||||
catch { return { generation: 0 }; }
|
||||
}
|
||||
|
||||
/** Written whole and renamed into place, so a command stopped mid-write never leaves a torn state. */
|
||||
async function writeState(path: string, state: ArgentBridgeState): Promise<void> {
|
||||
const temporary = `${path}.${process.pid}.tmp`;
|
||||
await writeFile(temporary, JSON.stringify(state), { mode: 0o600 });
|
||||
await rename(temporary, path);
|
||||
}
|
||||
|
||||
/** A call's arguments for the debug log: text that could be typed into a field is logged by length only. */
|
||||
function loggedArgs(args: Record<string, unknown>): Record<string, unknown> {
|
||||
return Object.fromEntries(Object.entries(args).map(([key, value]) => key === "text" && typeof value === "string" ? [key, `<${value.length} characters>`]
|
||||
: key === "steps" && Array.isArray(value) ? [key, `<${value.length} steps>`] : [key, value]));
|
||||
}
|
||||
|
||||
/** What a call answered, for the debug log: a tree's shape, not its contents. */
|
||||
function summarize(tool: string, value: unknown): unknown {
|
||||
if (!value || typeof value !== "object") return value;
|
||||
if (tool !== "ui-tree") return Object.keys(value);
|
||||
const tree = value as ArgentTree;
|
||||
let nodes = 0;
|
||||
const walk = (node: { children?: unknown[] }) => { nodes++; (node.children ?? []).forEach(child => walk(child as { children?: unknown[] })); };
|
||||
(tree.roots ?? []).forEach(walk);
|
||||
return { foregroundApp: tree.foregroundApp, alertVisible: tree.alertVisible, keyboardVisible: tree.keyboardVisible, truncated: tree.truncated,
|
||||
screen: tree.screen, nodes, roots: (tree.roots ?? []).map(root => [root.type ?? null, root.bundleId ?? null, (root.children ?? []).length]) };
|
||||
}
|
||||
|
||||
async function main(): Promise<number> {
|
||||
const environment = process.env;
|
||||
const statePath = environment.EXPLORE_ARGENT_STATE;
|
||||
const platform = environment.EXPLORE_ARGENT_PLATFORM as ArgentPlatform | undefined;
|
||||
const toolsUrl = environment.ARGENT_TOOLS_URL;
|
||||
if (!statePath || (platform !== "ios" && platform !== "android")) {
|
||||
const settings = argentBridgeSettings(environment);
|
||||
if (!settings) {
|
||||
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: "The Argent controller needs EXPLORE_ARGENT_STATE and EXPLORE_ARGENT_PLATFORM." } }));
|
||||
return 1;
|
||||
}
|
||||
const argv = process.argv.slice(2);
|
||||
if (argv[0] !== "--version" && !toolsUrl) {
|
||||
if (argv[0] !== "--version" && !settings.toolsUrl) {
|
||||
// Without a URL the Argent client would start a local tool-server; Explore only drives the session's own.
|
||||
process.stdout.write(JSON.stringify({ success: false, error: { code: "INVALID_ARGS", message: "ARGENT_TOOLS_URL is not set for the Argent controller." } }));
|
||||
return 1;
|
||||
}
|
||||
// EXPLORE_ARGENT_LOG_DIR (opt-in): every Argent call this bridge makes, how long it took, and the shape of what it read.
|
||||
const logPath = environment.EXPLORE_ARGENT_LOG_DIR
|
||||
? join(environment.EXPLORE_ARGENT_LOG_DIR, `argent-${platform}-${environment.EXPLORE_ARGENT_LOG_NAME ?? "bridge"}.jsonl`) : undefined;
|
||||
const log = async (entry: Record<string, unknown>) => {
|
||||
if (!logPath) return;
|
||||
await appendFile(logPath, `${JSON.stringify({ at: new Date().toISOString(), command: argv[0], ...entry })}\n`, { mode: 0o600 }).catch(() => undefined);
|
||||
};
|
||||
const state = await readState(statePath);
|
||||
let cli: string;
|
||||
try { cli = argv[0] === "--version" ? "" : await ensureController("argent", { environment, progress: message => process.stderr.write(`[explore] ${message}\n`) }); }
|
||||
catch (error) {
|
||||
@@ -93,65 +52,9 @@ async function main(): Promise<number> {
|
||||
catch { throw new ArgentCallError(`argent run ${tool} did not answer with JSON`, true); }
|
||||
};
|
||||
|
||||
const result = await runBridgeCommand(argv, {
|
||||
state, platform, version: ARGENT_VERSION,
|
||||
...(environment.EXPLORE_ARGENT_BUNDLE_ID ? { bundleId: environment.EXPLORE_ARGENT_BUNDLE_ID } : {}),
|
||||
...(environment.EXPLORE_ARGENT_DEVICE ? { device: environment.EXPLORE_ARGENT_DEVICE } : {}),
|
||||
// An opened foldable's inner panel shows its UI in landscape (Argent's fold: "Unfolded, the UI is landscape").
|
||||
...(platform === "ios" && ["open", "half-open"].includes(environment.EXPLORE_ARGENT_POSE ?? "") ? { landscape: true } : {}),
|
||||
call: async (tool, args, options) => {
|
||||
const started = Date.now();
|
||||
try {
|
||||
const value = await callArgent(tool, args, options);
|
||||
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, summary: summarize(tool, value) });
|
||||
return value;
|
||||
} catch (error) {
|
||||
await log({ tool, args: loggedArgs(args), ms: Date.now() - started, error: (error instanceof Error ? error.message : String(error)).slice(0, 400) });
|
||||
throw error;
|
||||
}
|
||||
},
|
||||
reachable: async () => {
|
||||
let ok = false;
|
||||
try {
|
||||
const token = environment.ARGENT_AUTH_TOKEN;
|
||||
// The same URL Argent's own client checks: ARGENT_TOOLS_URL may carry a path, which /tools is appended to.
|
||||
const response = await fetch(`${(toolsUrl ?? "").replace(/\/+$/, "")}/tools`, { headers: token ? { authorization: `Bearer ${token}` } : {}, signal: AbortSignal.timeout(5_000) });
|
||||
await response.body?.cancel();
|
||||
ok = response.status < 500;
|
||||
} catch { ok = false; }
|
||||
if (!ok) await log({ tool: "reachable", ok });
|
||||
return ok;
|
||||
},
|
||||
sleep: milliseconds => new Promise(resolve => setTimeout(resolve, milliseconds)),
|
||||
orientVideo: async path => {
|
||||
// Turned with ffmpeg, which observing a launch needs anyway; without it the recording is left as it is.
|
||||
const probed = spawnSync("ffprobe", ["-v", "error", "-select_streams", "v:0", "-show_entries", "stream=width,height", "-of", "csv=p=0:s=x", path], { encoding: "utf8", timeout: 30_000 });
|
||||
const [width, height] = (probed.stdout ?? "").trim().split("x").map(Number);
|
||||
if (probed.status !== 0 || !width || !height || width >= height) return;
|
||||
const turned = `${path}.upright.mp4`;
|
||||
const ffmpeg = spawnSync("ffmpeg", ["-nostdin", "-y", "-loglevel", "error", "-i", path, "-vf", "transpose=clock", "-an", turned], { encoding: "utf8", timeout: 120_000 });
|
||||
if (ffmpeg.status === 0) await rename(turned, path);
|
||||
else await rm(turned, { force: true });
|
||||
},
|
||||
scratchImage: { path: join(dirname(statePath), "argent-scratch.png"), read: async path => {
|
||||
const { PNG } = createRequire(import.meta.url)("pngjs") as { PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
|
||||
return PNG.sync.read(await readFile(path), { checkCRC: false });
|
||||
} },
|
||||
moveFile: async (from, to) => {
|
||||
// Argent's client downloads a recording under its HOME or the working directory; nothing else is moved.
|
||||
const source = await realpath(from);
|
||||
const roots = await Promise.all([environment.HOME, process.cwd()].filter((root): root is string => !!root).map(root => realpath(root).catch(() => root)));
|
||||
if (!roots.some(root => source.startsWith(`${root}/`))) throw new Error(`Argent returned a recording outside its own directories: ${from}`);
|
||||
await mkdir(dirname(to), { recursive: true });
|
||||
try { await rename(from, to); }
|
||||
catch { await copyFile(from, to); await rm(from, { force: true }); }
|
||||
},
|
||||
});
|
||||
await writeState(statePath, state);
|
||||
await log({ result: result.exitCode === 0 ? "ok" : result.stdout.slice(0, 300) });
|
||||
const result = await createArgentBridge(settings, callArgent, "process").run(argv);
|
||||
process.stdout.write(result.stdout);
|
||||
return result.exitCode;
|
||||
}
|
||||
|
||||
process.exitCode = await main();
|
||||
|
||||
@@ -14,20 +14,25 @@ export function defaultRunner(request: CommandRequest): CommandResult {
|
||||
...(request.timeoutMs ? { timeout: request.timeoutMs } : {}),
|
||||
});
|
||||
if (result.error) throw result.error;
|
||||
return commandOutcome(request, { status: result.status, stdout: result.stdout ?? "", stderr: result.stderr ?? "" });
|
||||
}
|
||||
|
||||
/** A finished command's output, or the error its exit status and output describe. */
|
||||
export function commandOutcome(request: CommandRequest, result: { status: number | null; stdout: string; stderr: string }): CommandResult {
|
||||
if (result.status !== 0 && !request.allowFailure) {
|
||||
const sessionIndex = request.args.indexOf("--session");
|
||||
// Our own session or a caller's session attached by explore:session: both answer --json failures with a structured error.
|
||||
const structuredFailure = (sessionIndex >= 0 && request.args[sessionIndex + 1] === CONTROLLER_SESSION) || request.args.includes("--json")
|
||||
? controllerCommandFailure(result.stdout ?? "", request.args[0] ?? "command") : undefined;
|
||||
? controllerCommandFailure(result.stdout, request.args[0] ?? "command") : undefined;
|
||||
if (structuredFailure) throw structuredFailure;
|
||||
const subcommand = typeof request.args[0] === "string" ? ` ${request.args[0]}` : "";
|
||||
const detail = failureDetail(`${result.stderr ?? ""}\n${result.stdout ?? ""}`);
|
||||
const detail = failureDetail(`${result.stderr}\n${result.stdout}`);
|
||||
throw new Error(
|
||||
`${request.command}${subcommand} exited with status ${result.status ?? "unknown"}`
|
||||
+ (detail ? `: ${detail}` : ""),
|
||||
);
|
||||
}
|
||||
return { stdout: result.stdout ?? "", stderr: result.stderr ?? "" };
|
||||
return { stdout: result.stdout, stderr: result.stderr };
|
||||
}
|
||||
|
||||
/** Keep the CLI tool host responsive while a remote controller request is in flight. */
|
||||
|
||||
+47
-13
@@ -1,4 +1,4 @@
|
||||
import { appearanceArgs, argentColorSchemes, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, type AppearanceSetting, type ColorScheme } from "./appearance.js";
|
||||
import { appearanceArgs, argentColorSchemes, bundleColorSchemes, mergeSchemeOutcomes, resolveColorSchemes, routeIdOfScreen, schemeScreenId, type AppearanceSetting, type ColorScheme } from "./appearance.js";
|
||||
import { assertNoCaptureHealthIssues, captureHealthIssues, partitionCaptureHealthIssues } from "./health.js";
|
||||
import { type RouteResetSetting } from "./route-reset.js";
|
||||
import { defaultReadinessSeconds } from "./readiness.js";
|
||||
@@ -24,6 +24,7 @@ import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
import { assertCaptureEasProfile, assertSimulatorAvailable, fingerprintFrom, hasEasEnvironmentFetchFailure, nativeBuildFrom, existingBuild, repackProfileFrom, prepareExactSourceBuild, type RepackMode } from "./eas-build.js";
|
||||
import { SIMULATOR_DOTENV_FILE_NAME, SIMULATOR_DOTENV_HEADER, endedOwnSimulatorSession, liveSimulatorSessionsNamed, simulatorSessionName, simulatorStartFailure, readSimulatorDotenvHandoff, assertSimulatorSessionIdentity, assertSimulatorStopped, collectRuntime, controllerVersion, simulatorOsVersion, type ActiveSimulatorRuntime, type SimulatorConnection } from "./simulator.js";
|
||||
import { argentControllerInvocation } from "./controller-invocation.js";
|
||||
import { startArgentBridgeRunner, type ArgentBridgeRunner } from "./argent-bridge-host.js";
|
||||
import { sharedBuild } from "./shared-build.js";
|
||||
import { LOCAL_EMULATOR_STATE_PREFIX, LOCAL_SIMULATOR_STATE_PREFIX, agentDeviceClaims, assertLocalEmulatorCompatible, createLocalSimulator, startLocalEmulator, waitForLocalEmulator, waitForLocalSimulator, deleteLocalEmulator,
|
||||
deleteLocalSimulator, hostEmulatorAbi, installOnLocalEmulator, installOnLocalSimulator, approveLinkScheme, localPoseShown,
|
||||
@@ -72,6 +73,12 @@ export type CiMapOptions = {
|
||||
buildShare?: string;
|
||||
/** Which appearances to capture; `auto` (default) follows the app's `userInterfaceStyle`. */
|
||||
appearance?: AppearanceSetting;
|
||||
/**
|
||||
* One session's share of the appearance passes when a side splits them across sessions: `capture` names the passes
|
||||
* this run makes, out of the `all` it would make alone, so frames keep the ids of a single run (`<id>@dark`) and the
|
||||
* exports merge. Absent: every resolved appearance.
|
||||
*/
|
||||
appearancePass?: { all: readonly ColorScheme[]; capture: readonly ColorScheme[] };
|
||||
/** Whether to observe the app launch (splash screen) per appearance; `video` also keeps the recording. Defaults to `off`. */
|
||||
launch?: LaunchSetting;
|
||||
/** Decodes launch recordings; defaults to ffmpeg when installed. */
|
||||
@@ -218,7 +225,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
});
|
||||
const routes = inventory.filter(route => selected.has(route.id));
|
||||
const setup = revisionSetup(options.setup ?? [], plan, side);
|
||||
const runner = options.runner ?? defaultRunner;
|
||||
let runner = options.runner ?? defaultRunner;
|
||||
const sourceEnvironment = options.environment ?? process.env;
|
||||
const controller = options.controller ?? "agent-device";
|
||||
const local = options.simulator === "local";
|
||||
@@ -353,7 +360,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
let captureFailure: unknown;
|
||||
const finish = async (): Promise<CiMapResult> => {
|
||||
if (!(await store.exists())) await store.initialize(map, false);
|
||||
const incomplete = captureFailure !== undefined || selectedIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
|
||||
// A session making only secondary passes owns the `<id>@<scheme>` frames of those passes, not the primary ones.
|
||||
const ownFrameIds = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
|
||||
? selectedIds.flatMap(id => colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)).map(scheme => schemeScreenId(id, scheme)))
|
||||
: selectedIds;
|
||||
const incomplete = captureFailure !== undefined || ownFrameIds.some(id => outcomes[id]?.status !== "captured" || outcomes[id]?.landing !== "verified")
|
||||
|| map.gaps.some(gap => gap.status === "open");
|
||||
map.run.status = incomplete || map.screens.length === 0 ? "partial" : "complete";
|
||||
if (routes.length === 0) map.run.stopReason = "No source targets require capture.";
|
||||
@@ -422,7 +433,9 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
if (options.agent) assertAgentAcceptance(bundle, map, { required: true });
|
||||
// The side that produces the evidence checks it the way the review will: an integrity defect fails here, naming
|
||||
// its codes, instead of on the consuming side after both captures. Unavailable screens are not defects.
|
||||
assertNoCaptureHealthIssues(partitionCaptureHealthIssues(captureHealthIssues(bundle, selectedIds)).integrity);
|
||||
// A session capturing only a secondary appearance has no primary frames by design; the merged export is checked instead.
|
||||
const partialPass = options.appearancePass !== undefined && !options.appearancePass.capture.includes(colorSchemes[0]!);
|
||||
if (!partialPass) assertNoCaptureHealthIssues(partitionCaptureHealthIssues(captureHealthIssues(bundle, selectedIds)).integrity);
|
||||
await writeFile(join(outputDirectory, "bundle.json"), `${JSON.stringify(bundle, null, 2)}\n`, { flag: "wx" });
|
||||
if (metadata) await writeFile(join(outputDirectory, "execution.json"), `${JSON.stringify(metadata, null, 2)}\n`, { flag: "wx" });
|
||||
assertCheckout();
|
||||
@@ -481,6 +494,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
let localOsVersion: string | undefined;
|
||||
// Argent's tool-server on this machine, when Argent drives a local device.
|
||||
let localArgent: LocalArgentServer | undefined;
|
||||
let argentBridge: ArgentBridgeRunner | undefined;
|
||||
const localDevice = () => localSimulator ?? localEmulator;
|
||||
// A local device starts booting now and finishes while the app is built and repacked; the session waits for it.
|
||||
let localEmulatorStart: Awaited<ReturnType<typeof startLocalEmulator>> | undefined;
|
||||
@@ -563,7 +577,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
const appDirectory = !options.buildShare ? await realpath(await mkdtemp(join(tmpdir(), "expo-explore-app-"))) : undefined;
|
||||
let localApp: string | undefined;
|
||||
type BuiltApp = { fingerprint: string; nativeEasBuildId: string | null; easBuildId: string | null; app?: string; reused: boolean; version?: string; buildNumber?: string };
|
||||
const buildApp = async (keepApp: string): Promise<BuiltApp> => {
|
||||
// `repacking` tells the captures sharing this build that their sessions can start too (sharedBuild).
|
||||
const buildApp = async (keepApp: string, repacking?: () => Promise<void>): Promise<BuiltApp> => {
|
||||
options.signal?.throwIfAborted();
|
||||
say("computing the native fingerprint");
|
||||
const fingerprintResult = eas(["fingerprint:generate", "--platform", options.platform, "--build-profile", options.easProfile, "--json", "--non-interactive"]);
|
||||
@@ -573,7 +588,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
"--fingerprint-hash", sourceFingerprint, ...(options.platform === "ios" ? ["--simulator"] : []), "--limit", "1", "--json", "--non-interactive"]).stdout);
|
||||
if (reusable) {
|
||||
say(`reusing EAS build ${reusable.id} (fingerprint ${sourceFingerprint.slice(0, 12)}); repacking it with this commit's JavaScript and the route observer`);
|
||||
startSession();
|
||||
startSession(); await repacking?.();
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: reusable.id, fingerprint: sourceFingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
@@ -587,7 +602,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
: `no finished simulator build has fingerprint ${sourceFingerprint.slice(0, 12)}; building on EAS and waiting for it to finish`);
|
||||
const built = nativeBuildFrom(eas(["build", "--platform", options.platform, "--profile", options.easProfile, "--wait", "--json", "--non-interactive"], 45 * 60_000).stdout);
|
||||
say(`EAS build ${built.id} finished; repacking it with the route observer`);
|
||||
startSession();
|
||||
startSession(); await repacking?.();
|
||||
const repacked = await prepareExactSourceBuild({ platform: options.platform, runner, easCommand: options.easCommand, repackCommand: options.repackCommand,
|
||||
project, nativeBuildId: built.id, fingerprint: built.fingerprint, repackProfile: profile, easEnvironment, repackEnvironment: restrictedEnvironment, routes: inventory, repack: options.repack, easProfile: options.easProfile, keepApp });
|
||||
if (!repacked) throw new CiError({ code: "CAPTURE_OBSERVER_BUILD_UNSUPPORTED", stage: "instrumentation",
|
||||
@@ -603,9 +618,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
? await sharedBuild({ directory: options.buildShare, appName, ...(options.signal ? { signal: options.signal } : {}), build: buildApp, owner: options.outputDirectory,
|
||||
key: { platform: options.platform, easProfile: options.easProfile, bundleId: options.bundleId, gitCommit: options.gitCommit, repack: options.repack ?? "eas", local,
|
||||
routes: inventory.map(route => route.id) },
|
||||
waiting: () => say("using the build another target of this review is preparing for this commit") })
|
||||
waiting: () => say("using the build another target of this review is preparing for this commit"),
|
||||
// The session is named before its app exists, so a waiter's session boots while the other capture repacks.
|
||||
repacking: () => startSession() })
|
||||
: await buildApp(join(appDirectory!, appName));
|
||||
// A capture that used another target's build starts its session now.
|
||||
// A capture that used another capture's build has its session started above; this starts the rest.
|
||||
startSession();
|
||||
fingerprint = built.fingerprint; nativeEasBuildId = built.nativeEasBuildId; easBuildId = built.easBuildId; localApp = built.app; reusedEasBuild = built.reused;
|
||||
if (!app.version && built.version) app.version = built.version;
|
||||
@@ -756,6 +773,11 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
AGENT_DEVICE_SESSION: CONTROLLER_SESSION, AGENT_DEVICE_SESSION_LOCK: "reject", AGENT_DEVICE_PLATFORM: options.platform };
|
||||
// Every controller call below goes to the session's controller; for Argent that is the bridge.
|
||||
const controllerCommand = argent?.command ?? options.agentDeviceCommand;
|
||||
// The capture's commands keep one bridge on a worker thread (EXPLORE_ARGENT_BRIDGE=process: one process per command, as before).
|
||||
if (argent && !options.runner && sourceEnvironment.EXPLORE_ARGENT_BRIDGE !== "process") {
|
||||
argentBridge = startArgentBridgeRunner({ command: argent.command, environment: argent.environment, fallback: defaultRunner, progress: say });
|
||||
runner = argentBridge.runner;
|
||||
}
|
||||
if (!local && localApp) {
|
||||
// The session started empty while the app was repacked; the controller installs it now.
|
||||
say(`installing the app on session ${sessionId}`);
|
||||
@@ -914,7 +936,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
// Every pass sets the appearance explicitly, so a capture does not inherit whatever the simulator last used.
|
||||
const passes: CaptureBundle["outcomes"][] = [];
|
||||
const recordingTools = launchSetting === "off" ? undefined : options.recordingTools === undefined ? ffmpegRecordingTools() : options.recordingTools ?? undefined;
|
||||
const capturedSchemes = options.appearancePass ? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : colorSchemes;
|
||||
for (const [index, colorScheme] of colorSchemes.entries()) {
|
||||
// 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],
|
||||
@@ -944,16 +969,22 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
...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, agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
|
||||
passes.push(await capturePlannedRoutes({ capture: { ...options, ...(argentBridge && !options.agent ? { runner: argentBridge.runner } : {}), agentDeviceCommand: controllerCommand, setup, progress: say }, routes: missingRoutes, inventory, scheme, appName: app.name, runtime,
|
||||
connection, environment: controllerEnvironment, store, map, acceptedFrames, outcomes: index === 0 ? outcomes : {},
|
||||
...(colorSchemes.length > 1 ? { appearance: { scheme: colorScheme, primary: index === 0 } } : {}) }));
|
||||
}
|
||||
runtime.colorScheme = colorSchemes[0]!;
|
||||
Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
|
||||
// A session without the primary pass keeps each outcome as its pass recorded it, under `<id>@<scheme>`: the export
|
||||
// merge recombines them with the primary pass's (mergeSchemeOutcomes), which only then can tell an unattributed
|
||||
// frame beside a primary one from a lost route.
|
||||
if (options.appearancePass && !capturedSchemes.includes(colorSchemes[0]!)) {
|
||||
for (const [index, pass] of passes.entries()) for (const [id, outcome] of Object.entries(pass)) outcomes[schemeScreenId(id, colorSchemes[index])] = outcome;
|
||||
} else Object.assign(outcomes, mergeSchemeOutcomes(passes, colorSchemes));
|
||||
} catch (error) { primaryError = toCiError(error, { code: `CAPTURE_${runtimeStage.toUpperCase()}_FAILED`, stage: runtimeStage,
|
||||
nextAction: "Inspect the capture diagnostic, correct the failing prerequisite, and rerun Explore." }); }
|
||||
finally {
|
||||
if (appDirectory) await rm(appDirectory, { recursive: true, force: true });
|
||||
argentBridge?.close();
|
||||
if (localArgent) stopLocalArgentServer(localArgent);
|
||||
if (localEmulator) {
|
||||
try {
|
||||
@@ -1017,7 +1048,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
|
||||
throw primaryError;
|
||||
}
|
||||
setStage("export");
|
||||
const captured = selectedIds.filter(id => outcomes[id]?.status === "captured").length;
|
||||
say(`${captured} of ${selectedIds.length} ${selectedIds.length === 1 ? "route" : "routes"} captured`);
|
||||
const ownSchemes = options.appearancePass && !options.appearancePass.capture.includes(colorSchemes[0]!)
|
||||
? colorSchemes.filter(scheme => options.appearancePass!.capture.includes(scheme)) : undefined;
|
||||
const captured = selectedIds.filter(id => ownSchemes
|
||||
? ownSchemes.every(scheme => outcomes[schemeScreenId(id, scheme)]?.status === "captured") : outcomes[id]?.status === "captured").length;
|
||||
say(`${captured} of ${selectedIds.length} ${selectedIds.length === 1 ? "route" : "routes"} captured${ownSchemes ? ` in ${ownSchemes.join(", ")}` : ""}`);
|
||||
return finish();
|
||||
}
|
||||
@@ -19,21 +19,23 @@ const POLL_MS = 2_000;
|
||||
|
||||
/**
|
||||
* Runs `build` once per key across every capture sharing `directory`; the app it leaves goes in the build's folder
|
||||
* (`keepApp`), which outlives each capture. A waiter is told so it can say whose build it uses.
|
||||
* (`keepApp`), which outlives each capture. A waiter is told so it can say whose build it uses, and told again
|
||||
* (`repacking`) once the builder calls its `repacking` (the native build is known and is being repacked), or the
|
||||
* build is done: a waiter starts its session then, not while a native build may run for most of an hour.
|
||||
*/
|
||||
export async function sharedBuild<T extends object>(options: { directory: string; key: SharedBuildKey; appName: string; signal?: AbortSignal;
|
||||
build: (keepApp: string) => Promise<T>; waiting?: () => void;
|
||||
build: (keepApp: string, repacking: () => Promise<void>) => Promise<T>; waiting?: () => void; repacking?: () => void;
|
||||
/** Who builds it (the capture's output directory), so a review can fail its waiters if that capture dies (abandonSharedBuilds). */
|
||||
owner?: string }): Promise<T> {
|
||||
const folder = join(options.directory, sharedBuildId(options.key));
|
||||
const result = join(folder, "result.json"), failure = join(folder, "failure.json");
|
||||
const result = join(folder, "result.json"), failure = join(folder, "failure.json"), repack = join(folder, "repacking");
|
||||
await mkdir(options.directory, { recursive: true });
|
||||
let owner = true;
|
||||
try { await mkdir(folder); } catch (error) { if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error; owner = false; }
|
||||
if (owner) {
|
||||
if (options.owner) await writeFile(join(folder, "owner"), options.owner);
|
||||
try {
|
||||
const built = await options.build(join(folder, options.appName));
|
||||
const built = await options.build(join(folder, options.appName), () => writeFile(repack, "").catch(() => undefined));
|
||||
await writeFile(`${result}.tmp`, JSON.stringify(built));
|
||||
await rename(`${result}.tmp`, result);
|
||||
return built;
|
||||
@@ -44,9 +46,11 @@ export async function sharedBuild<T extends object>(options: { directory: string
|
||||
}
|
||||
}
|
||||
options.waiting?.();
|
||||
let repackSeen = false;
|
||||
for (;;) {
|
||||
options.signal?.throwIfAborted();
|
||||
const done = await readFile(result, "utf8").catch(() => undefined);
|
||||
if (!repackSeen && (done !== undefined || existsSync(repack))) { repackSeen = true; options.repacking?.(); }
|
||||
if (done !== undefined) return JSON.parse(done) as T;
|
||||
const failed = await readFile(failure, "utf8").catch(() => undefined);
|
||||
if (failed !== undefined) {
|
||||
|
||||
@@ -28,6 +28,9 @@ const recipeKey = ({ inventory, profile, config, toolsCommit }: Recipe) => {
|
||||
|
||||
/** Only settings that can change captured runtime evidence belong in the recipe. */
|
||||
export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?: string): string {
|
||||
// How many sessions capture the evidence (capture.maxSessions) does not change it.
|
||||
const { maxSessions: _maxSessions, ...capture } = config.capture;
|
||||
void _maxSessions;
|
||||
return canonicalJson({
|
||||
observer: CAPTURE_OBSERVER_HASH,
|
||||
mode: config.mode,
|
||||
@@ -36,7 +39,7 @@ export function captureRecipeConfig(config: ExploreConfig, instructionsSha256?:
|
||||
...(config.app.scheme === undefined ? {} : { scheme: config.app.scheme }) },
|
||||
device: config.device, parameters: config.parameters, setup: config.setup ?? [],
|
||||
// The repack as it resolves, so a config that leaves it to the default keeps the recipe it had when the default was written out.
|
||||
capture: { ...config.capture, repack: captureRepack(config) },
|
||||
capture: { ...capture, repack: captureRepack(config) },
|
||||
// agent-device recipes stay as they were; an Argent capture is keyed to the Argent release that drove it.
|
||||
...(config.capture.controller === "argent" ? { controllerVersion: ARGENT_VERSION } : {}),
|
||||
});
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
import { copyFile, mkdir, readdir, readFile, writeFile, appendFile, lstat } from "node:fs/promises";
|
||||
import { dirname, join, relative } from "node:path";
|
||||
|
||||
import { bundleColorSchemes, mergeSchemeOutcomes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
|
||||
import type { CaptureOutcome } from "../contracts/capture.js";
|
||||
import type { CaptureBundle } from "../contracts/capture.js";
|
||||
import type { ExploreMap } from "../types.js";
|
||||
|
||||
const LIST_FIELDS = ["artifacts", "screens", "variants", "observations", "elements", "actionAttempts", "transitions", "journeys", "frontier", "gaps"] as const;
|
||||
|
||||
async function readJson<T>(path: string): Promise<T> { return JSON.parse(await readFile(path, "utf8")) as T; }
|
||||
|
||||
async function copyTree(source: string, destination: string, skip: (relativePath: string) => boolean, root = source): Promise<void> {
|
||||
for (const entry of await readdir(source, { withFileTypes: true })) {
|
||||
const from = join(source, entry.name), to = join(destination, entry.name), rel = relative(root, from);
|
||||
if (skip(rel)) continue;
|
||||
if (entry.isDirectory()) { await mkdir(to, { recursive: true }); await copyTree(from, to, skip, root); continue; }
|
||||
if (!entry.isFile()) continue;
|
||||
if ((await lstat(to).catch(() => undefined))) continue;
|
||||
await mkdir(dirname(to), { recursive: true });
|
||||
await copyFile(from, to);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fold the exports of a side's secondary appearance sessions into its primary export, in place: the frames, outcomes,
|
||||
* launch evidence and map records of each `<id>@<scheme>` screen, and their files. Each session captured its passes as
|
||||
* one run would (`appearancePass`), so records only append; a secondary export never replaces a primary record.
|
||||
*/
|
||||
export async function mergeCaptureExports(primary: string, secondaries: readonly { directory: string; scheme: ColorScheme }[]): Promise<void> {
|
||||
if (secondaries.length === 0) return;
|
||||
const bundle = await readJson<CaptureBundle>(join(primary, "bundle.json"));
|
||||
const map = await readJson<ExploreMap>(join(primary, "screen-map.json"));
|
||||
const known = { screens: new Set(map.screens.map(screen => screen.id)), artifacts: new Set(map.artifacts.map(artifact => artifact.id)) };
|
||||
// The outcomes recombine as one run's passes do (mergeSchemeOutcomes): a secondary pass records a verified frame under
|
||||
// `<id>@<scheme>` and a lost route under `<id>`, which the merge folds into the primary record the same way.
|
||||
const schemes = bundleColorSchemes(bundle);
|
||||
const passes: Record<string, CaptureOutcome>[] = schemes.map(() => ({}));
|
||||
for (const [id, outcome] of Object.entries(bundle.outcomes)) if (!routeIdOfScreen(id).scheme) passes[0]![id] = outcome;
|
||||
for (const { directory: secondary, scheme } of secondaries) {
|
||||
const other = await readJson<CaptureBundle>(join(secondary, "bundle.json"));
|
||||
const pass = passes[schemes.indexOf(scheme)];
|
||||
// A session that could not show its appearance (Argent without appearance.set captures one) has nothing to add, as
|
||||
// one run would have no pass for it.
|
||||
if (!pass && !bundleColorSchemes(other).includes(scheme)) continue;
|
||||
if (!pass) throw new Error(`The ${scheme} session's export is not an appearance of the primary export (${schemes.join(", ")})`);
|
||||
for (const [id, outcome] of Object.entries(other.outcomes)) pass[routeIdOfScreen(id).routeId] = outcome;
|
||||
const otherMap = await readJson<ExploreMap>(join(secondary, "screen-map.json"));
|
||||
for (const [id, image] of Object.entries(other.images)) if (routeIdOfScreen(id).scheme && !bundle.images[id]) bundle.images[id] = image;
|
||||
for (const [scheme, record] of Object.entries(other.launch ?? {})) { bundle.launch ??= {}; bundle.launch[scheme] ??= record; }
|
||||
for (const [id, context] of Object.entries(other.captureContexts ?? {})) { bundle.captureContexts ??= {}; bundle.captureContexts[id] ??= context; }
|
||||
for (const field of LIST_FIELDS) {
|
||||
const records = (otherMap[field] ?? []) as Array<Record<string, unknown>>;
|
||||
const target = ((map as unknown as Record<string, unknown[]>)[field] ??= []);
|
||||
for (const record of records) {
|
||||
if (field === "screens" && known.screens.has(record.id as string)) continue;
|
||||
if (field === "artifacts" && known.artifacts.has(record.id as string)) continue;
|
||||
if (field === "screens") known.screens.add(record.id as string);
|
||||
if (field === "artifacts") known.artifacts.add(record.id as string);
|
||||
target.push(record);
|
||||
}
|
||||
}
|
||||
// Files: artifacts and launch evidence are new paths; diagnostics append to the primary's lines.
|
||||
await copyTree(secondary, primary, rel => rel === "bundle.json" || rel === "screen-map.json" || rel === "screen-map.schema.json" || rel === "manifest.json"
|
||||
|| rel === "execution.json" || rel.startsWith("capture-diagnostics"));
|
||||
const diagnostics = join(secondary, "capture-diagnostics");
|
||||
for (const entry of await readdir(diagnostics, { withFileTypes: true }).catch(() => [])) {
|
||||
if (!entry.isFile()) continue;
|
||||
const to = join(primary, "capture-diagnostics", entry.name);
|
||||
await mkdir(dirname(to), { recursive: true });
|
||||
if (entry.name.endsWith(".jsonl")) await appendFile(to, await readFile(join(diagnostics, entry.name)));
|
||||
else if (!(await lstat(to).catch(() => undefined))) await copyFile(join(diagnostics, entry.name), to);
|
||||
}
|
||||
}
|
||||
// An open gap a secondary pass left makes the run partial, as it does one run's (a complete run has none).
|
||||
if (map.gaps.some(gap => gap.status === "open")) map.run.status = "partial";
|
||||
const manifest = await readJson<{ files: unknown[] }>(join(primary, "manifest.json"));
|
||||
manifest.files = map.artifacts.map(artifact => ({ path: artifact.path, sha256: artifact.sha256, bytes: artifact.bytes, mimeType: artifact.mimeType }));
|
||||
await writeFile(join(primary, "screen-map.json"), JSON.stringify(map));
|
||||
bundle.outcomes = mergeSchemeOutcomes(passes, schemes);
|
||||
await writeFile(join(primary, "bundle.json"), JSON.stringify(bundle));
|
||||
await writeFile(join(primary, "manifest.json"), `${JSON.stringify(manifest, null, 2)}\n`);
|
||||
}
|
||||
+16
-7
@@ -1,14 +1,14 @@
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { randomBytes } from "node:crypto";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { readFileSync, readdirSync } from "node:fs";
|
||||
import { copyFile, cp, lstat, mkdir, mkdtemp, readdir, readFile, realpath, rename, rm, stat, utimes, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join, relative, resolve } from "node:path";
|
||||
import { runCiReview } from "./pipeline.js";
|
||||
import { resolveCommit } from "./workflow-steps.js";
|
||||
import { ciLayout, installCommand, type PackageManager } from "./workflow-install.js";
|
||||
import { configPlatforms, readExploreConfig, resolveTargetConfig, configTargets, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { configPlatforms, readExploreConfig, resolveTargetConfig, configTargets, posedTargets, withRunOverrides, DEFAULT_EXPLORE_CONFIG_PATH, type ExploreConfig, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { AGENT_PROVIDERS, defaultExploreConfig } from "../config/setup.js";
|
||||
import type { PrepareCiExplorationOptions } from "../capture/agent/exploration.js";
|
||||
import { createCiAgentSession } from "../capture/agent/session.js";
|
||||
@@ -26,6 +26,7 @@ import { abandonSharedBuilds } from "../capture/shared-build.js";
|
||||
import { exploreCacheRoot } from "../shared/cache-root.js";
|
||||
import { packageBin } from "../shared/package-paths.js";
|
||||
import { silentProgress, type Progress } from "../shared/progress.js";
|
||||
import { maxParallelTargets } from "./session-plan.js";
|
||||
|
||||
/**
|
||||
* `capture:review --base REF [--head REF]` on a laptop: the same review CI runs (`runCiReview`), on two commits of the
|
||||
@@ -44,7 +45,7 @@ export type LocalReviewOptions = {
|
||||
platform?: ExplorePlatform | undefined;
|
||||
/** `--target`: capture this config.yaml target alone; with `platform`, the targets of that platform. */
|
||||
target?: string | undefined;
|
||||
/** `--parallel`: how many targets capture at once (each runs a simulator or emulator per side); all of them by default. */
|
||||
/** `--parallel`: how many targets capture at once (each runs a simulator or emulator per side); by default all of them, up to capture.maxSessions. */
|
||||
parallel?: number | undefined;
|
||||
scope?: string | undefined;
|
||||
expiresIn?: string | undefined;
|
||||
@@ -285,8 +286,15 @@ export async function keepCapture(exported: string, target: string): Promise<boo
|
||||
}
|
||||
}
|
||||
|
||||
/** The session state files a review writes: `<side>-session`, and `<side>-session-<scheme>` for appearance passes in their own sessions. */
|
||||
function sessionStateFiles(output: string): string[] {
|
||||
const rank = (name: string) => ["head", "base", "baseline"].indexOf(name.split("-")[0]!);
|
||||
try { return readdirSync(output).filter(name => /^(head|base|baseline)-session(-[a-z]+)?$/.test(name)).sort((a, b) => rank(a) - rank(b) || a.localeCompare(b)); }
|
||||
catch { return []; }
|
||||
}
|
||||
|
||||
function recordedSessionIds(outputs: string[]): string[] {
|
||||
return outputs.flatMap(output => ["head-session", "base-session"].flatMap(name => {
|
||||
return outputs.flatMap(output => sessionStateFiles(output).flatMap(name => {
|
||||
try { const id = readFileSync(join(output, name), "utf8").trim(); return /^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id) ? [id] : []; } catch { return []; }
|
||||
}));
|
||||
}
|
||||
@@ -307,7 +315,7 @@ export async function stopRecordedSessions(outputs: string[], environment: NodeJ
|
||||
simctl: (args: string[]) => { status: number | null } = args => spawnSync("xcrun", ["simctl", ...args], { env: environment, encoding: "utf8", timeout: 120_000 }),
|
||||
adb: (args: string[]) => { status: number | null } = args => spawnSync(androidTools(environment).adb, args, { env: environment, encoding: "utf8", timeout: 60_000 })): Promise<string[]> {
|
||||
const stopped: string[] = [];
|
||||
for (const output of outputs) for (const name of ["head-session", "base-session"]) {
|
||||
for (const output of outputs) for (const name of sessionStateFiles(output)) {
|
||||
const file = join(output, name);
|
||||
const id = (await readFile(file, "utf8").catch(() => "")).trim();
|
||||
if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,199}$/.test(id)) continue;
|
||||
@@ -479,7 +487,7 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
target, ...(targets.length > 1 ? { targets } : {}) };
|
||||
progress(`${target.id}: reviewing${target.id === platform ? "" : ` (${target.label})`}`);
|
||||
const result = await runCiReview({ projects, output, config, presentation, runId, runAttempt: "1", state, environment: platformEnvironment,
|
||||
...(platforms.length > 1 ? { platforms } : {}), ...(targets.length > 1 ? { targets } : {}),
|
||||
...(platforms.length > 1 ? { platforms } : {}), ...(targets.length > 1 ? { targets } : {}), posedTargets: posedTargets(rawConfig),
|
||||
// Targets of one platform capture the same commits from the same build; it is built and repacked once.
|
||||
...(targets.length > 1 ? { buildShare: join(work, ".builds") } : {}),
|
||||
subscription, useLocalEasSession, progress: message => progress(`${target.id}: ${message}`),
|
||||
@@ -537,7 +545,8 @@ export async function runLocalReview(options: LocalReviewOptions): Promise<Local
|
||||
await abandonSharedBuilds(join(work, ".builds"), owner => owner === join(work, target.id, `${side}-export`), failure.code);
|
||||
}
|
||||
};
|
||||
const settled = await settleLimited(targets, options.parallel ?? targets.length,
|
||||
// Each target needs a simulator session: no more run at once than capture.maxSessions, unless --parallel says.
|
||||
const settled = await settleLimited(targets, options.parallel ?? maxParallelTargets(rawConfig.capture.maxSessions, targets.length),
|
||||
target => captureTarget(target).catch(async (error: unknown) => { await releaseBuilds(target, error).catch(() => undefined); throw error; }));
|
||||
// One target that fails costs that target's report, not the others': they are kept, and the failure is named.
|
||||
// Only an interrupted review, or one where every target failed, fails as a whole.
|
||||
|
||||
+129
-12
@@ -1,12 +1,18 @@
|
||||
import { systemRegions } from "../contracts/capture.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { mkdir, open, readFile, realpath, writeFile } from "node:fs/promises";
|
||||
import { execFile, spawnSync } from "node:child_process";
|
||||
import { mkdir, mkdtemp, open, readFile, realpath, rm, writeFile } from "node:fs/promises";
|
||||
import { join, relative, resolve, isAbsolute } from "node:path";
|
||||
import { tmpdir } from "node:os";
|
||||
import { setTimeout as delay } from "node:timers/promises";
|
||||
import { promisify } from "node:util";
|
||||
import { buildVerifiedPlan } from "./verified-plan.js";
|
||||
import { runCiMap, type CommandRunner } from "../capture/run.js";
|
||||
import { routeIdOfScreen } from "../capture/appearance.js";
|
||||
import { runCiMap, type CiMapOptions, type CommandRunner } from "../capture/run.js";
|
||||
import { resolveColorSchemes, routeIdOfScreen, type ColorScheme } from "../capture/appearance.js";
|
||||
import { baseEnvironment } from "../capture/common.js";
|
||||
import { DEFAULT_MAX_SESSIONS, planSideSessions, sessionShare } from "./session-plan.js";
|
||||
import { mergeCaptureExports } from "./export-merge.js";
|
||||
import { abandonSharedBuilds } from "../capture/shared-build.js";
|
||||
import { prepareCaptureReview, readCaptureBundle } from "../review/capture-review.js";
|
||||
import { quarantineReviewContract } from "../contracts/review-validation.js";
|
||||
import { agentCaptureConstraints } from "../capture/agent/source-context.js";
|
||||
@@ -63,6 +69,8 @@ async function recipe(config: ExploreConfig, plan: SourceCapturePlan, side: "bas
|
||||
/** The capture's clock and host-side pause; tests pair them with an injected runner so readiness budgets are not real time. */
|
||||
type CaptureClock = { now?: (() => number) | undefined; sleep?: ((milliseconds: number) => void) | undefined };
|
||||
|
||||
const execFileAsync = promisify(execFile);
|
||||
|
||||
function captureOptions(config: ExploreConfig, environment: NodeJS.ProcessEnv, runner?: CommandRunner, clock: CaptureClock = {}) {
|
||||
return { ...(runner && clock.now ? { now: clock.now } : {}), ...(runner && clock.sleep ? { sleep: clock.sleep } : {}), platform: config.app.platform, bundleId: config.app.bundleId,
|
||||
...(config.app.scheme ? { scheme: config.app.scheme } : {}), device: config.device.name, ...(config.device.pose ? { devicePose: config.device.pose } : {}),
|
||||
@@ -84,6 +92,87 @@ async function prefetchControllers(config: ExploreConfig, environment: NodeJS.Pr
|
||||
if (config.capture.controller === "argent" && config.capture.simulator === "local") await ensureArgentToolServer({ environment, progress });
|
||||
}
|
||||
|
||||
/**
|
||||
* The appearances a capture of this side renders, read before any session starts so the sessions can divide them. The
|
||||
* app config comes from `eas config` in a child process, as the capture reads it, with the capture's restricted
|
||||
* environment: never evaluated in this process, which holds the review's secrets. Unknown: undefined.
|
||||
*/
|
||||
async function expectedColorSchemes(config: ExploreConfig, project: string, environment: NodeJS.ProcessEnv, easCommand: string): Promise<ColorScheme[] | undefined> {
|
||||
// Argent switches the appearance only through serve-sim on an EAS iOS session; elsewhere it captures one.
|
||||
if (config.capture.controller === "argent" && config.capture.simulator !== "local" && config.app.platform !== "ios") return undefined;
|
||||
if (config.capture.appearance !== "auto") return resolveColorSchemes(config.capture.appearance, undefined, config.app.platform);
|
||||
const easEnvironment = { ...baseEnvironment(environment), ...(environment.EXPO_TOKEN ? { EXPO_TOKEN: environment.EXPO_TOKEN } : {}) };
|
||||
try {
|
||||
const { stdout } = await execFileAsync(easCommand, ["config", "--platform", config.app.platform, "--profile", config.app.easProfile, "--json", "--non-interactive"],
|
||||
{ cwd: project, env: easEnvironment, timeout: 5 * 60_000, maxBuffer: 16 * 1024 * 1024 });
|
||||
const app = (JSON.parse(stdout) as { appConfig?: Record<string, unknown> }).appConfig;
|
||||
return app && typeof app === "object" ? resolveColorSchemes("auto", app, config.app.platform) : undefined;
|
||||
} catch {
|
||||
// The capture reads the same config and reports why it cannot; until then the side keeps one session.
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run one side's capture: in one session, or when `passes` splits its appearances, one worker session per pass. The
|
||||
* primary pass exports to `mapOptions.outputDirectory`; the others beside it, named by their appearances, then merge.
|
||||
*/
|
||||
async function captureSideInSessions(mapOptions: CiMapOptions, passes: readonly (readonly ColorScheme[])[] | undefined,
|
||||
progress: Progress, signal: AbortSignal | undefined, worker: boolean): Promise<Awaited<ReturnType<typeof runCiMap>>> {
|
||||
const runOnWorker = (passOptions: CiMapOptions) =>
|
||||
runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(passOptions), progress, signal);
|
||||
if (!passes || passes.length <= 1) return worker ? runOnWorker(mapOptions) : runCiMap(mapOptions);
|
||||
const schemes = passes.flat();
|
||||
progress(`${mapOptions.side}: capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions`);
|
||||
// The passes install the same app: they share one build and repack, as the targets of a local review do.
|
||||
const ownBuildShare = mapOptions.buildShare ? undefined : await mkdtemp(join(tmpdir(), "expo-explore-builds-"));
|
||||
const buildShare = mapOptions.buildShare ?? ownBuildShare!;
|
||||
const settled = await Promise.allSettled(passes.map(async (pass, index) => {
|
||||
const suffix = index === 0 ? "" : `-${pass.join("-")}`;
|
||||
const outputDirectory = `${mapOptions.outputDirectory}${suffix}`;
|
||||
try {
|
||||
return await runOnWorker({ ...mapOptions, mapDirectory: `${mapOptions.mapDirectory}${suffix}`, outputDirectory, buildShare,
|
||||
...(mapOptions.sessionStatePath ? { sessionStatePath: `${mapOptions.sessionStatePath}${suffix}` } : {}), appearancePass: { all: schemes, capture: pass } });
|
||||
} catch (error) {
|
||||
// A pass that dies mid-build must not leave the others polling for its result.
|
||||
await abandonSharedBuilds(buildShare, owner => owner === outputDirectory, toCiError(error).code).catch(() => undefined);
|
||||
throw error;
|
||||
}
|
||||
}));
|
||||
// The build folder holds the repacked app, which the sessions have installed.
|
||||
if (ownBuildShare) await rm(ownBuildShare, { recursive: true, force: true });
|
||||
for (const outcome of settled) if (outcome.status === "rejected") throw outcome.reason;
|
||||
await mergeCaptureExports(mapOptions.outputDirectory, passes.slice(1).map(pass => ({ directory: `${mapOptions.outputDirectory}-${pass.join("-")}`, scheme: pass[0]! })));
|
||||
return (settled[0] as PromiseFulfilledResult<Awaited<ReturnType<typeof runCiMap>>>).value;
|
||||
}
|
||||
|
||||
/**
|
||||
* This target's share of `capture.maxSessions`: the targets are this review's (`targets`), or the config's one, and
|
||||
* `posedTargets` (foldables) take the sessions that do not divide evenly.
|
||||
*/
|
||||
function targetSessionShare(config: ExploreConfig, targets: readonly RunTarget[] | undefined, posedTargets: readonly string[] | undefined): number {
|
||||
const targetIds: string[] = (targets ?? []).map(target => target.id);
|
||||
if (targetIds.length === 0) targetIds.push(...(config.targets ? Object.keys(config.targets) : [config.target?.id ?? "default"]));
|
||||
return sessionShare({ maxSessions: config.capture.maxSessions, targets: targetIds, target: config.target?.id ?? targetIds[0]!,
|
||||
prefer: id => posedTargets?.includes(id) ? 1 : 0 });
|
||||
}
|
||||
|
||||
/**
|
||||
* The appearance passes one side spreads over sessions of its own, out of its target's share of `capture.maxSessions`;
|
||||
* undefined keeps the side in one session. The side's app config is read only when its share and routes could pay for
|
||||
* a split.
|
||||
*/
|
||||
export async function sideAppearancePasses(config: ExploreConfig, environment: NodeJS.ProcessEnv,
|
||||
input: { share: number; sides: 1 | 2; routes: number; project: string; easCommand?: string }): Promise<ColorScheme[][] | undefined> {
|
||||
// A pass observes its launch only when capture.launch asks for it.
|
||||
const plan = (schemes: readonly ColorScheme[]) => planSideSessions({ share: input.share, sides: input.sides, routes: input.routes, schemes,
|
||||
...(config.capture.launch === "off" ? { launchSeconds: 0 } : {}) }).passes;
|
||||
if (plan(["light", "dark"]).length < 2) return undefined;
|
||||
const schemes = await expectedColorSchemes(config, input.project, environment, input.easCommand ?? packageBin("eas-cli", "eas"));
|
||||
const passes = schemes ? plan(schemes) : [];
|
||||
return passes.length > 1 ? passes.map(pass => [...pass]) : undefined;
|
||||
}
|
||||
|
||||
export function captureSidesConcurrently(input: { plan: SourceCapturePlan; agent: boolean; injectedRunner: boolean; baselineMayExist: boolean }): boolean {
|
||||
return !input.agent && !input.injectedRunner && !input.baselineMayExist
|
||||
&& input.plan.headCaptureSurfaceIds.length > 0 && input.plan.baseCaptureSurfaceIds.length > 0;
|
||||
@@ -111,6 +200,8 @@ export type PublicCiOptions = {
|
||||
platforms?: ExplorePlatform[];
|
||||
/** Every target config.yaml captures, in config order; recorded in the report so the Viewer links the sibling targets' reports. */
|
||||
targets?: RunTarget[];
|
||||
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
|
||||
posedTargets?: readonly string[];
|
||||
baseProject: string; headProject: string; pullRequestPath: string; output: string;
|
||||
config: ExploreConfig; configPath?: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
|
||||
now?: () => number; sleep?: (milliseconds: number) => void; onComment?: (state: PublicCommentState, body: string) => void;
|
||||
@@ -253,6 +344,8 @@ export async function runCiReview(options: {
|
||||
platforms?: ExplorePlatform[];
|
||||
/** Every target config.yaml captures; `config.target` is the one this review captures. */
|
||||
targets?: RunTarget[];
|
||||
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
|
||||
posedTargets?: readonly string[];
|
||||
/** A folder shared with the other targets' reviews, so the targets of one platform build each commit once. */
|
||||
buildShare?: string;
|
||||
measure?: Parameters<typeof assessPublicEvidence>[0]["measure"];
|
||||
@@ -308,7 +401,20 @@ export async function runCiReview(options: {
|
||||
// A baseline that may be restored needs the head runtime profile first; otherwise both sides capture at once.
|
||||
const baselineMayExist = plan.baseCaptureSurfaceIds.length > 0 && await captureArtifactCacheMayMatch({ ...cacheRecipes.base,
|
||||
...(environment.EXPLORE_CAPTURE_CACHE ? { sourceDirectory: environment.EXPLORE_CAPTURE_CACHE } : {}), commit: pr.base.sha });
|
||||
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist });
|
||||
const share = targetSessionShare(config, options.targets, options.posedTargets);
|
||||
// A share of one session captures the sides in turn.
|
||||
const concurrent = captureSidesConcurrently({ plan, agent: !!exploration.agent, injectedRunner: !!options.runner, baselineMayExist }) && share >= 2;
|
||||
// Each side's appearances split by its own app config: a pull request can change userInterfaceStyle. Sides taken in
|
||||
// turn (a baseline may be restored) each have the whole share. Passes run on worker threads, which cannot take an
|
||||
// injected runner or an agent session.
|
||||
const sidePasses = { head: undefined as ColorScheme[][] | undefined, base: undefined as ColorScheme[][] | undefined };
|
||||
if (!exploration.agent && !options.runner) await Promise.all((["head", "base"] as const).map(async side => {
|
||||
sidePasses[side] = await sideAppearancePasses(config, environment, { share, sides: concurrent ? 2 : 1, routes: plan[`${side}CaptureSurfaceIds`].length, project: projects[side] });
|
||||
}));
|
||||
const split = (["head", "base"] as const).filter(side => sidePasses[side]);
|
||||
progress(`sessions: ${share} of ${config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
|
||||
+ (split.length ? `${split.join(" and ")} ${split.length === 1 ? "captures its" : "capture their"} appearances in separate sessions`
|
||||
: concurrent ? "one session per side" : "the sides in turn"));
|
||||
const captureSide = async (side: "head" | "base") => {
|
||||
const directory = join(output, `${side}-export`);
|
||||
const selectedIds = plan[`${side}CaptureSurfaceIds`];
|
||||
@@ -328,9 +434,8 @@ export async function runCiReview(options: {
|
||||
name: config.app.name ?? pr.repository, buildId: pr.origin === "local" ? `local-${pr.runId}-${side}` : pr.origin === "compare" ? `compare-${options.runId}-${side}` : `pr-${pr.number}-${side}`, buildVersion: pr[side].sha.slice(0, 8), gitCommit: pr[side].sha,
|
||||
planPath: join(output, "execution-plan.json"), side, sessionStatePath: join(output, `${side}-session`), ...(options.buildShare ? { buildShare: options.buildShare } : {}),
|
||||
...(reuseDirectory ? { reuseDirectory } : {}), ...(options.signal ? { signal: options.signal } : {}) };
|
||||
const captured = concurrent
|
||||
? await runCiMapOnWorker((({ progress: _progress, runner: _runner, agent: _agent, signal: _signal, ...rest }) => rest)(mapOptions), progress, options.signal)
|
||||
: await runCiMap(mapOptions);
|
||||
// A restored baseline already holds every appearance pass, so it never splits.
|
||||
const captured = await captureSideInSessions(mapOptions, reuseDirectory ? undefined : sidePasses[side], progress, options.signal, concurrent);
|
||||
const bundle = await readCaptureBundle(directory);
|
||||
bundle.profile = cacheRecipe.profile;
|
||||
await writeFile(join(directory, "bundle.json"), JSON.stringify(bundle));
|
||||
@@ -369,8 +474,9 @@ export async function runCiReview(options: {
|
||||
stage = "compare";
|
||||
progress("comparing base and head captures");
|
||||
const sides = { base: await evidenceSide(join(output, "base-export")), head: await evidenceSide(join(output, "head-export")) };
|
||||
const evidence = await assessPublicEvidence({ platform: config.app.platform, plan, ...sides, ...(options.measure ? { measure: options.measure } : {}), profile: `${config.app.easProfile}:${config.app.bundleId}`, agentDeviceCommand: agentDeviceLauncher(options.environment) });
|
||||
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory,
|
||||
const system = systemRegions({ platform: config.app.platform, device: config.device.name, pose: config.device.pose });
|
||||
const evidence = await assessPublicEvidence({ platform: config.app.platform, systemRegions: system, plan, ...sides, ...(options.measure ? { measure: options.measure } : {}), profile: `${config.app.easProfile}:${config.app.bundleId}`, agentDeviceCommand: agentDeviceLauncher(options.environment) });
|
||||
const result = await prepareCaptureReview({ plan, pullRequest: pr, baseDirectory: sides.base.directory, headDirectory: sides.head.directory, systemRegions: system,
|
||||
runId: options.runId, runAttempt: options.runAttempt, assertCurrentHead, assessments: evidence.surfaces,
|
||||
...(options.platforms ? { platforms: options.platforms } : {}),
|
||||
...(config.target ? { target: config.target } : {}), ...(options.targets ? { targets: options.targets } : {}),
|
||||
@@ -462,6 +568,10 @@ export async function runCiReview(options: {
|
||||
}
|
||||
|
||||
export async function runBaselineCi(options: { platform?: ExplorePlatform; project: string; sha: string; output: string; config: ExploreConfig; environment?: NodeJS.ProcessEnv; runner?: CommandRunner;
|
||||
/** Every target config.yaml captures, so this baseline takes its target's share of `capture.maxSessions`. */
|
||||
targets?: RunTarget[];
|
||||
/** The targets with a device pose (foldables), which take the sessions `capture.maxSessions` does not divide evenly. */
|
||||
posedTargets?: readonly string[];
|
||||
now?: () => number; sleep?: (milliseconds: number) => void;
|
||||
agentSessionFactory?: PrepareCiExplorationOptions["createSession"]; progress?: Progress;
|
||||
/** Use the local `eas login` session instead of EXPO_TOKEN (expo-explore doctor --capture). */
|
||||
@@ -487,12 +597,19 @@ export async function runBaselineCi(options: { platform?: ExplorePlatform; proje
|
||||
onUsage: recordAgentUsage(output, () => usagePhase), ...(options.subscription ? { subscription: true } : {}) });
|
||||
const directory = join(output, "baseline-export");
|
||||
usagePhase = "capture-baseline";
|
||||
const result = await runCiMap({ ...captureOptions(options.config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
|
||||
const baselineOptions: CiMapOptions = { ...captureOptions(options.config, environment, options.runner, { now: options.now, sleep: options.sleep }), progress,
|
||||
...(options.useLocalEasSession ? { useLocalEasSession: true } : {}),
|
||||
...(exploration.agent ? { agent: exploration.agent } : {}), project: options.project,
|
||||
mapDirectory: join(output, "baseline-map"), outputDirectory: directory, name: options.config.app.name ?? options.config.app.bundleId,
|
||||
buildId: `baseline-${options.sha.slice(0, 12)}`, buildVersion: options.sha.slice(0, 8), gitCommit: options.sha,
|
||||
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") });
|
||||
side: "head", planPath: join(output, "execution-plan.json"), sessionStatePath: join(output, "baseline-session") };
|
||||
const share = targetSessionShare(options.config, options.targets, options.posedTargets);
|
||||
// Passes on worker threads cannot take an injected runner or an agent session.
|
||||
const passes = !options.runner && !exploration.agent
|
||||
? await sideAppearancePasses(options.config, environment, { share, sides: 1, routes: plan.headCaptureSurfaceIds.length, project: options.project }) : undefined;
|
||||
progress(`sessions: ${share} of ${options.config.capture.maxSessions ?? DEFAULT_MAX_SESSIONS} for this target; `
|
||||
+ (passes ? `capturing ${passes.map(pass => pass.join("+")).join(" and ")} in separate sessions` : "one session"));
|
||||
const result = await captureSideInSessions(baselineOptions, passes, progress, undefined, passes !== undefined);
|
||||
const cacheRecipe = await recipe(options.config, plan, "head", environment, exploration.instructionsSha256);
|
||||
if (options.subscription) cacheRecipe.toolsCommit += ":local-subscription";
|
||||
const bundle = await readCaptureBundle(directory); bundle.profile = cacheRecipe.profile;
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
import type { ColorScheme } from "../capture/appearance.js";
|
||||
|
||||
/** One route capture on a remote session, with the bridge thread (observed ~5 s; 9.4 s before it). */
|
||||
export const ROUTE_SECONDS = 5;
|
||||
/** Observing the app launch once per appearance. */
|
||||
export const LAUNCH_SECONDS = 28;
|
||||
/** A pass moves to its own session only when that shortens the side by at least this much. */
|
||||
export const SPLIT_MIN_SAVING_SECONDS = 60;
|
||||
/**
|
||||
* `capture.maxSessions` when the config sets none: the simulators a typical EAS plan runs at once. A starter plan runs
|
||||
* one per platform, so its config sets the ceiling lower (2 for an iOS and an Android target).
|
||||
*/
|
||||
export const DEFAULT_MAX_SESSIONS = 5;
|
||||
|
||||
export type SessionShareInput = {
|
||||
/** `capture.maxSessions`: the review-wide ceiling; absent means DEFAULT_MAX_SESSIONS. */
|
||||
maxSessions: number | undefined;
|
||||
/** The review's target ids in config order, and the one this job captures. */
|
||||
targets: readonly string[];
|
||||
target: string;
|
||||
/** Targets a split pays off most for take the sessions that do not divide evenly: foldables and large screens first. */
|
||||
prefer?: (target: string) => number;
|
||||
};
|
||||
|
||||
/**
|
||||
* This job's share of the review's session ceiling: the ceiling divided over the targets, the remainder going to the
|
||||
* preferred targets (foldables) in config order, and unused when there are none. Never below 1 (a side then captures after the other): under a ceiling below the
|
||||
* number of targets, at most that many target jobs run at once (maxParallelTargets).
|
||||
*/
|
||||
export function sessionShare(input: SessionShareInput): number {
|
||||
const count = Math.max(1, input.targets.length);
|
||||
const ceiling = input.maxSessions ?? DEFAULT_MAX_SESSIONS;
|
||||
const base = Math.floor(ceiling / count);
|
||||
let remainder = ceiling - base * count;
|
||||
// A session left over goes to a preferred target only; without one it stays unused (two targets of five: two each).
|
||||
const ranked = input.targets.filter(id => (input.prefer?.(id) ?? 0) > 0)
|
||||
.sort((a, b) => input.prefer!(b) - input.prefer!(a) || input.targets.indexOf(a) - input.targets.indexOf(b));
|
||||
const extra = new Set<string>();
|
||||
for (const id of ranked) { if (remainder <= 0) break; extra.add(id); remainder -= 1; }
|
||||
return Math.max(1, base + (extra.has(input.target) ? 1 : 0));
|
||||
}
|
||||
|
||||
/** How many target jobs one review runs at once: each needs a session, so never more than the ceiling. */
|
||||
export function maxParallelTargets(maxSessions: number | undefined, targets: number): number {
|
||||
return Math.max(1, Math.min(targets, maxSessions ?? DEFAULT_MAX_SESSIONS));
|
||||
}
|
||||
|
||||
export type SidePlan = {
|
||||
/** Whether head and base capture at the same time. */
|
||||
concurrentSides: boolean;
|
||||
/** The appearance passes of one side, each on its own session; one entry means the side keeps a single session. */
|
||||
passes: readonly (readonly ColorScheme[])[];
|
||||
};
|
||||
|
||||
/**
|
||||
* How one target's job spends its share of sessions: both sides at once when it has two, and a side's appearance passes
|
||||
* in separate sessions only when the pass moved out shortens the side by at least a minute (a session costs its fixed
|
||||
* boot and install time, so a few routes are not worth one). Sessions the work cannot fill stay unused: the ceiling is
|
||||
* a limit, not a target.
|
||||
*/
|
||||
export function planSideSessions(input: { share: number; sides: 1 | 2; routes: number; schemes: readonly ColorScheme[];
|
||||
minSavingSeconds?: number; routeSeconds?: number; launchSeconds?: number }): SidePlan {
|
||||
const minSaving = input.minSavingSeconds ?? SPLIT_MIN_SAVING_SECONDS, perRoute = input.routeSeconds ?? ROUTE_SECONDS, launch = input.launchSeconds ?? LAUNCH_SECONDS;
|
||||
const concurrentSides = input.sides === 1 || input.share >= 2;
|
||||
const perSide = Math.floor(input.share / (concurrentSides ? input.sides : 1));
|
||||
const schemes = [...input.schemes];
|
||||
const passSeconds = input.routes * perRoute + launch;
|
||||
const splitAppearances = schemes.length > 1 && perSide >= schemes.length && passSeconds >= minSaving;
|
||||
return { concurrentSides, passes: splitAppearances ? schemes.map(scheme => [scheme]) : [schemes] };
|
||||
}
|
||||
@@ -196,7 +196,8 @@ export async function cleanupAfterCapture(options: { output: string; checkouts:
|
||||
const environment = options.environment ?? process.env;
|
||||
const result: { stopped: string[]; failures: Array<{ code: string; message: string; nextAction: string }> } = { stopped: [], failures: [] };
|
||||
const sessionFiles: string[] = [];
|
||||
for (const name of ["head-session", "base-session", "baseline-session"]) {
|
||||
// A side that captures an appearance in a session of its own (capture.maxSessions) records it as `<side>-session-<scheme>`.
|
||||
for (const name of ["head", "base", "baseline"].flatMap(side => ["", "-light", "-dark"].map(scheme => `${side}-session${scheme}`))) {
|
||||
const path = resolve(options.output, name);
|
||||
try { await lstat(path); sessionFiles.push(path); } catch { /* That side never started a session. */ }
|
||||
}
|
||||
|
||||
+12
-6
@@ -15,12 +15,13 @@ import { installCiFiles } from "../ci/workflow-install.js";
|
||||
import { readRouteEntry } from "../ci/route-entry.js";
|
||||
import { buildVerifiedPlan } from "../ci/verified-plan.js";
|
||||
import { formatCaptureCheck, formatDoctorReport, referencedSecretNames, runCaptureCheck, runDoctor } from "../ci/doctor.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { readExploreConfig, readExploreInstructions, resolveTargetConfig, configTargets, posedTargets, isTargetId, withRunOverrides, warnIgnoredExpiry, configPlatforms as listPlatforms, EXPLORE_PLATFORMS, DEFAULT_EXPLORE_CONFIG_PATH, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { argumentError, output, required, has, flag, flags, nonNegativeInteger, oneOf, positiveInteger } from "./args.js";
|
||||
import { help } from "./help.js";
|
||||
import { CiError } from "../shared/ci-errors.js";
|
||||
import { cleanupAfterCapture, findOptionalBaseline, resolveCompareRefs, resolvePullRequest, writeCaptureOutputs, writeStepOutputs } from "../ci/workflow-steps.js";
|
||||
import { stderrProgress } from "../shared/progress.js";
|
||||
import { maxParallelTargets } from "../ci/session-plan.js";
|
||||
|
||||
export async function doctor(): Promise<void> {
|
||||
if (has("help")) return help();
|
||||
@@ -159,10 +160,14 @@ export async function configPlatforms(): Promise<void> {
|
||||
output({ ok: true, platforms: configTargets(config).map(target => target.id) });
|
||||
}
|
||||
|
||||
/** The targets config.yaml captures, in order, with their platforms and labels: the review workflow's matrix. */
|
||||
/**
|
||||
* The targets config.yaml captures, in order, with their platforms and labels: the review workflow's matrix, and how
|
||||
* many of its jobs run at once (`maxParallel`), since each needs a session of capture.maxSessions.
|
||||
*/
|
||||
export async function configTargetList(): Promise<void> {
|
||||
const config = await readExploreConfig(flag("project") ?? process.cwd(), flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
|
||||
output({ ok: true, targets: configTargets(config) });
|
||||
const targets = configTargets(config);
|
||||
output({ ok: true, targets, maxParallel: maxParallelTargets(config.capture.maxSessions, targets.length) });
|
||||
}
|
||||
|
||||
async function exists(path: string): Promise<boolean> {
|
||||
@@ -229,7 +234,7 @@ export async function captureReview(): Promise<void> {
|
||||
// A matrix job names its target; its artifacts, report and comment section carry the target's id.
|
||||
const named = selection.target !== undefined || selection.platform !== undefined;
|
||||
const common = { ...(named ? { target: config.target!.id } : {}), ...(selection.platform ? { platform: selection.platform } : {}),
|
||||
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), baseProject: required("base-project"), headProject,
|
||||
platforms: listPlatforms(rawConfig), targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), baseProject: required("base-project"), headProject,
|
||||
output: required("output"), config, configPath, progress: stderrProgress() };
|
||||
const result = has("compare") ? await runCompareCi({ ...common, comparePath: required("compare") })
|
||||
: await runPublicCi({ ...common, pullRequestPath: required("pull-request") });
|
||||
@@ -240,8 +245,9 @@ export async function captureReview(): Promise<void> {
|
||||
|
||||
export async function captureBaseline(): Promise<void> {
|
||||
const project = required("project");
|
||||
const config = withRunOverrides(resolveTargetConfig(await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH), targetSelection()), { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
|
||||
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, progress: stderrProgress() }) });
|
||||
const rawConfig = await readExploreConfig(project, flag("config") ?? DEFAULT_EXPLORE_CONFIG_PATH);
|
||||
const config = withRunOverrides(resolveTargetConfig(rawConfig, targetSelection()), { controller: flag("controller"), simulator: flag("simulator"), repack: flag("repack") });
|
||||
output({ ok: true, ...await runBaselineCi({ platform: config.app.platform, project, sha: required("sha"), output: required("output"), config, targets: configTargets(rawConfig), posedTargets: posedTargets(rawConfig), progress: stderrProgress() }) });
|
||||
}
|
||||
|
||||
/** `capture` (or `capture:review`) `[--base REF] [--head REF | --committed]`: a local review, opened in the Viewer or hosted with --upload. */
|
||||
|
||||
+1
-1
@@ -31,7 +31,7 @@ const GET_STARTED = `Get started (run these in the Expo app's directory):
|
||||
machine, instead of EAS Simulator, and removes it afterwards (or set capture.simulator in config.yaml); builds
|
||||
still run on EAS, and the host switches appearance for either controller; the app is repacked with the route
|
||||
observer on this machine too (--repack eas, or capture.repack, keeps the hosted EAS job);
|
||||
with targets in config.yaml it reviews them at once (--parallel N at most N at a time; the targets of a platform
|
||||
with targets in config.yaml it reviews them at once, up to capture.maxSessions (--parallel N at most N at a time; the targets of a platform
|
||||
share each commit's build), --target ID one of them, --platform those of a platform)
|
||||
view [--catalog FILE] [--port N] [--no-open]
|
||||
(opens a report in the Viewer)
|
||||
|
||||
@@ -94,6 +94,11 @@ export type ExploreConfig = {
|
||||
/** `exclude` names routes, as `requiresRoute` does, that stay in the map but are never captured. */
|
||||
exploration: { scope: "changes" | "all"; exclude?: string[] };
|
||||
capture: { maxMinutes: number; maxActions: number;
|
||||
/**
|
||||
* The most EAS Simulator sessions one review may run at once, across its targets and sides; absent:
|
||||
* DEFAULT_MAX_SESSIONS (5). Below the number of targets, that many target jobs run at once, one session each.
|
||||
*/
|
||||
maxSessions?: number;
|
||||
/** Where the route observer is bundled into the app, when the config chooses; captureRepack gives the default. */
|
||||
repack?: "eas" | "local"; appearance: AppearanceSetting; launch: LaunchSetting; reset: RouteResetSetting; unattributed: UnattributedSetting; readinessSeconds?: number;
|
||||
/** The device controller; absent means agent-device, so configs that never chose one keep their cache recipes. */
|
||||
@@ -295,7 +300,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
const exploration = optionalRecord(root.exploration, "exploration");
|
||||
exactKeys(exploration, ["scope", "exclude"], "exploration");
|
||||
const capture = optionalRecord(root.capture, "capture");
|
||||
exactKeys(capture, ["maxMinutes", "maxActions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
|
||||
exactKeys(capture, ["maxMinutes", "maxActions", "maxSessions", "repack", "appearance", "launch", "reset", "unattributed", "readinessSeconds", "controller", "simulator"], "capture");
|
||||
const controller = literal(capture.controller, ["agent-device", "argent"] as const, "capture.controller", "agent-device");
|
||||
const simulator = literal(capture.simulator, ["eas", "local"] as const, "capture.simulator", "eas");
|
||||
const mode = literal(root.mode, ["deterministic", "agent"] as const, "mode", "deterministic");
|
||||
@@ -342,6 +347,7 @@ export function validateExploreConfig(value: unknown): ExploreConfig {
|
||||
capture: {
|
||||
maxMinutes: positiveInteger(capture.maxMinutes, "capture.maxMinutes", 30),
|
||||
maxActions: positiveInteger(capture.maxActions, "capture.maxActions", 500),
|
||||
...(capture.maxSessions === undefined ? {} : { maxSessions: positiveInteger(capture.maxSessions, "capture.maxSessions", 2) }),
|
||||
...(capture.repack === undefined ? {} : { repack: literal(capture.repack, ["eas", "local"] as const, "capture.repack") }),
|
||||
appearance: parseAppearance(capture.appearance, "capture.appearance"),
|
||||
launch: parseLaunchSetting(capture.launch, "capture.launch"),
|
||||
@@ -440,6 +446,11 @@ export function configTargets(config: ExploreConfig): RunTarget[] {
|
||||
label: target.label ?? `${target.device ?? (target.platform === config.app.platform ? config.device.name : DEFAULT_ANDROID_DEVICE)}${target.pose ? ` (${target.pose})` : ""}` }));
|
||||
}
|
||||
|
||||
/** The targets with a device pose (foldables): they take the sessions `capture.maxSessions` does not divide evenly. */
|
||||
export function posedTargets(config: ExploreConfig): string[] {
|
||||
return Object.entries(config.targets ?? {}).filter(([, target]) => target.pose).map(([id]) => id);
|
||||
}
|
||||
|
||||
/**
|
||||
* The flat configuration capture consumes for one target, with `target` naming it. `--target` names one; `--platform`
|
||||
* names the target of that platform, when only one has it; with neither, the config must have a single target.
|
||||
|
||||
@@ -166,6 +166,47 @@ export function homeIndicatorBandPercent(platform: "ios" | "android" | undefined
|
||||
return HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM[platform ?? "ios"];
|
||||
}
|
||||
|
||||
/**
|
||||
* An area of a screenshot the system draws, in percent of the screenshot's width and height. A difference that
|
||||
* lies entirely inside one is never an app change; the verdict leaves it out and the Viewer blurs it.
|
||||
*/
|
||||
export type SystemRegion = { kind: "status-bar" | "home-indicator"; x: number; y: number; width: number; height: number };
|
||||
|
||||
/**
|
||||
* iPhone Duo (iOS 27) has no status bar across the top: its clock and Wi-Fi indicator stack in one pill in the
|
||||
* right-hand rail, 28 points from the edge, lower on the outer (closed) panel than on the inner one. Measured on
|
||||
* EAS Simulator captures of both panels; the pill is the same 40×64 points on each, only its top differs. The app's own
|
||||
* rail controls start about 3% of the height below it on the outer panel, so the padding stays small.
|
||||
*/
|
||||
const DUO_PANELS = {
|
||||
outer: { width: 466, height: 678, statusBar: { x: 398, y: 87, width: 40, height: 64 } },
|
||||
inner: { width: 951, height: 669, statusBar: { x: 883, y: 34, width: 40, height: 64 } },
|
||||
} as const;
|
||||
const DUO_STATUS_BAR_PADDING_POINTS = 4;
|
||||
const isFoldable = (platform: "ios" | "android" | undefined, device: string | undefined) => platform !== "android" && /\bduo\b/i.test(device ?? "");
|
||||
|
||||
/**
|
||||
* The areas the verdict leaves out for a capture: the platform's status-bar band and, on iOS, its home-indicator
|
||||
* band; on an iPhone foldable, the lit panel's status-bar pill instead of a top band. `pose` is the capture's device pose
|
||||
* (closed lights the outer panel; open and half-open the inner one); a foldable with none boots closed.
|
||||
*/
|
||||
export function systemRegions(options: { platform?: "ios" | "android" | undefined; device?: string | undefined; pose?: string | undefined }): SystemRegion[] {
|
||||
const regions: SystemRegion[] = [];
|
||||
if (isFoldable(options.platform, options.device)) {
|
||||
const panel = options.pose === "open" || options.pose === "half-open" ? DUO_PANELS.inner : DUO_PANELS.outer;
|
||||
const pad = DUO_STATUS_BAR_PADDING_POINTS;
|
||||
const percent = (value: number, of: number) => Math.round((value / of) * 10000) / 100;
|
||||
regions.push({ kind: "status-bar",
|
||||
x: percent(panel.statusBar.x - pad, panel.width), y: percent(panel.statusBar.y - pad, panel.height),
|
||||
width: percent(panel.statusBar.width + 2 * pad, panel.width), height: percent(panel.statusBar.height + 2 * pad, panel.height) });
|
||||
} else {
|
||||
regions.push({ kind: "status-bar", x: 0, y: 0, width: 100, height: statusBarBandPercent(options.platform) });
|
||||
}
|
||||
const home = homeIndicatorBandPercent(options.platform);
|
||||
if (home > 0) regions.push({ kind: "home-indicator", x: 0, y: 100 - home, width: 100, height: home });
|
||||
return regions;
|
||||
}
|
||||
|
||||
/** Deterministic pixel comparison of one surface's base and head screenshots. */
|
||||
export type PublicVisualVerdict = {
|
||||
verdict: "unchanged" | "modified" | "needs-review";
|
||||
@@ -193,6 +234,8 @@ export type PublicVisualVerdict = {
|
||||
ignoredStatusBarRegions?: number;
|
||||
/** Diff regions that lay inside the home-indicator band and were left out of the verdict, or clipped to their part above it. */
|
||||
ignoredHomeIndicatorRegions?: number;
|
||||
/** The system-drawn areas the verdict left out, present when a difference inside one was ignored. */
|
||||
systemRegions?: SystemRegion[];
|
||||
};
|
||||
/**
|
||||
* Evidence-based reviewer status. `status` on the surface stays source-derived because capture
|
||||
@@ -250,6 +293,8 @@ export type PublicReview = {
|
||||
statusBarBandPercent?: number;
|
||||
/** The share of each screenshot's height, from the bottom, the verdict ignored as the home indicator. */
|
||||
homeIndicatorBandPercent?: number;
|
||||
/** Every system-drawn area the verdict leaves out of each screenshot; the bands above, or a foldable's rail pill. */
|
||||
systemRegions?: SystemRegion[];
|
||||
/** Every platform the config captures, so the Viewer can offer the sibling platform's report of the same run. */
|
||||
platforms?: Array<"ios" | "android">;
|
||||
/** The target this report captured; absent in reports from before targets, whose target is their platform. */
|
||||
|
||||
@@ -75,11 +75,17 @@ function assertReviewFields(surface: Surface, enforceComparisonEvidence: boolean
|
||||
}
|
||||
}
|
||||
|
||||
/** A region's move between the screenshots: finite, and small enough to be layout drift rather than another screen. */
|
||||
/**
|
||||
* The farthest a region may move between the screenshots, in screenshot pixels: within the largest screenshot a
|
||||
* device takes (an element recentred on a wide display moves hundreds of pixels), not an unbounded number.
|
||||
*/
|
||||
const MAX_SHIFT = 8192;
|
||||
|
||||
/** A region's move between the screenshots: finite, and within a screenshot. */
|
||||
function validShift(shift: unknown): boolean {
|
||||
if (!shift || typeof shift !== "object") return false;
|
||||
const { x, y } = shift as { x?: unknown; y?: unknown };
|
||||
return typeof x === "number" && typeof y === "number" && Number.isFinite(x) && Number.isFinite(y) && Math.abs(x) <= 64 && Math.abs(y) <= 64;
|
||||
return typeof x === "number" && typeof y === "number" && Number.isFinite(x) && Number.isFinite(y) && Math.abs(x) <= MAX_SHIFT && Math.abs(y) <= MAX_SHIFT;
|
||||
}
|
||||
|
||||
function assertVisualVerdict(visual: PublicVisualVerdict, enforceComparisonEvidence: boolean, paired: boolean): void {
|
||||
|
||||
@@ -4,7 +4,7 @@ import { createHash } from "node:crypto";
|
||||
import { lstat, readFile, realpath } from "node:fs/promises";
|
||||
import { isAbsolute, relative, resolve, sep } from "node:path";
|
||||
import { assertDecodedPng } from "../shared/png-evidence.js";
|
||||
import { assertAgentAcceptance, validateCapturePlan, type AppIconImage, type BundleLaunchCapture, type CaptureBundle, type CaptureOutcome, type CapturedImage, type LaunchFilmstrip, type LaunchFrame, type PublicLaunchSide, type PublicReview, homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
|
||||
import { assertAgentAcceptance, validateCapturePlan, type AppIconImage, type BundleLaunchCapture, type CaptureBundle, type CaptureOutcome, type CapturedImage, type LaunchFilmstrip, type LaunchFrame, type PublicLaunchSide, type PublicReview, homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent, systemRegions, type SystemRegion } from "../contracts/capture.js";
|
||||
import { COLOR_SCHEMES } from "../capture/appearance.js";
|
||||
import { launchDirectory } from "../capture/launch-capture.js";
|
||||
import { APP_ICON_FILE, APP_ICON_MAX_SIZE } from "../capture/app-icon.js";
|
||||
@@ -263,6 +263,11 @@ export type CaptureReviewOptions = {
|
||||
/** The target this report captures, and every target config.yaml captures (this one among them), when more than one. */
|
||||
target?: RunTarget;
|
||||
targets?: RunTarget[];
|
||||
/**
|
||||
* The system-drawn areas the verdict left out of each screenshot; absent, the platform's bands, as the assessment's
|
||||
* default. A bundle does not record a foldable's pose, so its panel is not guessed here.
|
||||
*/
|
||||
systemRegions?: SystemRegion[];
|
||||
};
|
||||
|
||||
/** Build the validated review independently of where its metadata and images will be stored. */
|
||||
@@ -302,6 +307,7 @@ async function constructCaptureReview(options: CaptureReviewOptions, store: Scre
|
||||
runtime: { projectId: head.bundle.easProjectId ?? "", buildId: head.bundle.easBuildId ?? "", gitCommit: plan.headSha,
|
||||
platform: head.bundle.platform ?? "ios", ...(head.bundle.controller === "argent" ? { controller: "argent" as const } : {}), statusBarBandPercent: statusBarBandPercent(head.bundle.platform),
|
||||
...(homeIndicatorBandPercent(head.bundle.platform) > 0 ? { homeIndicatorBandPercent: homeIndicatorBandPercent(head.bundle.platform) } : {}),
|
||||
systemRegions: (options.systemRegions ?? systemRegions({ platform: head.bundle.platform })).map((area) => ({ ...area })),
|
||||
...(options.platforms && options.platforms.length > 1 ? { platforms: [...options.platforms] } : {}),
|
||||
...(options.target ? { target: { ...options.target } } : {}),
|
||||
...(options.targets && options.targets.length > 1 ? { targets: options.targets.map(target => ({ ...target })) } : {}),
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { unattributedIssue } from "../capture/health.js";
|
||||
import { appearancePairs, bundleColorSchemes } from "../capture/appearance.js";
|
||||
import { homeIndicatorBandPercent, launchSurfaceId, statusBarBandPercent } from "../contracts/capture.js";
|
||||
import { appearancePairs, bundleColorSchemes, type ColorScheme } from "../capture/appearance.js";
|
||||
import { launchSurfaceId, systemRegions as defaultSystemRegions, type SystemRegion } from "../contracts/capture.js";
|
||||
import { readFileSync, statSync } from "node:fs";
|
||||
import { stat } from "node:fs/promises";
|
||||
import { isAbsolute, resolve } from "node:path";
|
||||
@@ -27,7 +27,9 @@ import {
|
||||
} from "./visual-evidence.js";
|
||||
import { AGENT_DEVICE_VERSION } from "../shared/agent-device-version.js";
|
||||
import { STATUS_BAR_BAND_PERCENT, decodePng, differentPixelsInRect, maxColorDistance, type DecodedFrame } from "../shared/png-evidence.js";
|
||||
import { measureRegionShifts } from "./region-shift.js";
|
||||
import type { RegionMove, RegionShift } from "./region-shift.js";
|
||||
import { measureRegionMovesInWorker } from "./region-shift-worker.js";
|
||||
import { availableParallelism } from "node:os";
|
||||
|
||||
export const DEFAULT_VISUAL_THRESHOLD = 0.1;
|
||||
export const DEFAULT_EVIDENCE_TIME_BUDGET_MS = 10 * 60_000;
|
||||
@@ -142,16 +144,61 @@ function visualVerdict(assessment: VisualEvidenceAssessment, threshold: number):
|
||||
};
|
||||
}
|
||||
|
||||
type PublishedRegion = NonNullable<PublicVisualVerdict["regions"]>[number];
|
||||
|
||||
/** A region as published: the fields a review carries, without the comparison's own bookkeeping. */
|
||||
function publishedRegion(region: VisualDiffRegion): PublishedRegion {
|
||||
return { rect: region.rect, normalizedRect: region.normalizedRect, differentPixels: region.differentPixels,
|
||||
shareOfDiffPercentage: region.shareOfDiffPercentage, dominantChange: region.dominantChange, location: region.location };
|
||||
}
|
||||
|
||||
/**
|
||||
* The regions to publish from every region the comparison found, given what moved: each region with its small
|
||||
* shift, if one explains it, and each large move as one region in place of the regions it explains (where the
|
||||
* content is now, their pixels and share, its location the region the content arrived in), largest share first.
|
||||
* `allRegionsMoved` when every region, before any are left out, moved.
|
||||
*/
|
||||
export function publishMeasuredRegions(all: readonly VisualDiffRegion[], shifts: ReadonlyArray<RegionShift | undefined>,
|
||||
moves: readonly RegionMove[], width: number, height: number): Pick<PublicVisualVerdict, "regions" | "allRegionsMoved"> {
|
||||
const merged = new Set(moves.flatMap(move => move.members));
|
||||
const percent = (value: number, total: number) => Math.round((value / total) * 10_000) / 100;
|
||||
const regions: PublishedRegion[] = [
|
||||
...all.flatMap((region, index) => {
|
||||
if (merged.has(index)) return [];
|
||||
const shift = shifts[index];
|
||||
return [{ ...publishedRegion(region), ...(shift ? { shift } : {}) }];
|
||||
}),
|
||||
...moves.map(move => {
|
||||
const members = move.members.map(index => all[index]!);
|
||||
return {
|
||||
rect: move.rect,
|
||||
normalizedRect: { x: percent(move.rect.x, width), y: percent(move.rect.y, height), width: percent(move.rect.width, width), height: percent(move.rect.height, height) },
|
||||
differentPixels: members.reduce((sum, region) => sum + region.differentPixels, 0),
|
||||
// Each member's share is rounded, so their sum can pass 100; a share is at most the whole difference.
|
||||
shareOfDiffPercentage: Math.min(100, Math.round(members.reduce((sum, region) => sum + region.shareOfDiffPercentage, 0) * 100) / 100),
|
||||
dominantChange: "mixed", location: members[0]!.location, shift: move.shift,
|
||||
};
|
||||
}),
|
||||
];
|
||||
return {
|
||||
regions: regions.sort((left, right) => right.shareOfDiffPercentage - left.shareOfDiffPercentage).slice(0, MAX_REGIONS),
|
||||
...(regions.length > 0 && regions.every(region => region.shift) ? { allRegionsMoved: true as const } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The published regions with how far their content moved, where a move explains it: a layout that shifted by a
|
||||
* device pixel reads as moved, not as changed. Every region the comparison found is measured, not only the ones
|
||||
* published, so `allRegionsMoved` can say nothing else on the screen changed. A measurement that fails leaves the
|
||||
* regions as they were.
|
||||
* device pixel reads as moved, not as changed, and an element that moved further (a card recentred on a wider
|
||||
* screen) reads as one moved region instead of the fragments the comparison split it into. Every region the
|
||||
* comparison found is measured, not only the ones published, so `allRegionsMoved` can say nothing else on the
|
||||
* screen changed. A measurement that fails leaves the regions as they were.
|
||||
*/
|
||||
async function withRegionShifts(basePath: string, headPath: string, all: readonly VisualDiffRegion[], published: NonNullable<PublicVisualVerdict["regions"]>):
|
||||
Promise<Pick<PublicVisualVerdict, "regions" | "allRegionsMoved">> {
|
||||
try {
|
||||
const shifts = await measureRegionShifts(basePath, headPath, all.map(region => region.rect));
|
||||
const { shifts, moves, width, height } = await measureRegionMovesInWorker(basePath, headPath,
|
||||
all.map(region => ({ ...region.rect, dominantChange: region.dominantChange })));
|
||||
if (moves.length) return publishMeasuredRegions(all, shifts, moves, width, height);
|
||||
const shiftOf = new Map(all.map((region, index) => [region.rect, shifts[index]] as const));
|
||||
return {
|
||||
regions: published.map(region => {
|
||||
@@ -186,59 +233,82 @@ export function systemBandFrameLoader(measurement: ScreenshotDiffMeasurement, th
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Leaves out of a measurement every diff region that lies inside the system's bands: the status bar at the top and,
|
||||
* on iOS, the home indicator at the bottom. Both are drawn by the OS and differ between captures without the app
|
||||
* having changed. A region that crosses a band's edge is clipped to the part below (above) it when the frames can be
|
||||
* read: its pixels inside the band are dropped, and it stays only for what differs in the app's area.
|
||||
* Without frames such a region is kept whole, as before. (A region's pixel count is its own cluster's, while its rect
|
||||
* can overlap other regions, so what it keeps is counted outside the band and clamped to its own count.)
|
||||
*/
|
||||
/** `ignoreSystemRegions` for the plain case: a status-bar band across the top and a home-indicator band along the bottom. */
|
||||
export function ignoreSystemBands(measurement: ScreenshotDiffMeasurement, bands: { top: number; bottom: number }, frames?: SystemBandFrameLoader):
|
||||
{ measurement: ScreenshotDiffMeasurement; ignoredTop: number; ignoredBottom: number } {
|
||||
if (measurement.match || measurement.regions.length === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
|
||||
const inTop = (region: VisualDiffRegion) => bands.top > 0 && region.normalizedRect.y + region.normalizedRect.height <= bands.top;
|
||||
const inBottom = (region: VisualDiffRegion) => bands.bottom > 0 && region.normalizedRect.y >= 100 - bands.bottom;
|
||||
const crossesTop = (region: VisualDiffRegion) => bands.top > 0 && !inTop(region) && region.normalizedRect.y < bands.top;
|
||||
const crossesBottom = (region: VisualDiffRegion) => bands.bottom > 0 && !inBottom(region) && region.normalizedRect.y + region.normalizedRect.height > 100 - bands.bottom;
|
||||
const regions: SystemRegion[] = [
|
||||
...(bands.top > 0 ? [{ kind: "status-bar" as const, x: 0, y: 0, width: 100, height: bands.top }] : []),
|
||||
...(bands.bottom > 0 ? [{ kind: "home-indicator" as const, x: 0, y: 100 - bands.bottom, width: 100, height: bands.bottom }] : []),
|
||||
];
|
||||
const result = ignoreSystemRegions(measurement, regions, frames);
|
||||
return { measurement: result.measurement, ignoredTop: result.ignoredStatusBar, ignoredBottom: result.ignoredHomeIndicator };
|
||||
}
|
||||
|
||||
/**
|
||||
* Leaves out of a measurement every diff region that lies inside a system-drawn area: the status bar (a band across
|
||||
* the top of a phone, a pill in the rail of a foldable) and, on iOS, the home indicator at the bottom. Both differ
|
||||
* between captures without the app having changed. A region that crosses the edge of a band across the whole width
|
||||
* is clipped to the part outside it when the frames can be read: its pixels inside the band are dropped, and it stays
|
||||
* only for what differs in the app's area. Without frames, and across a pill's edge, such a region is kept whole.
|
||||
* (A region's pixel count is its own cluster's, while its rect can overlap other regions, so what it keeps is counted
|
||||
* outside the band and clamped to its own count.)
|
||||
*/
|
||||
export function ignoreSystemRegions(measurement: ScreenshotDiffMeasurement, system: readonly SystemRegion[], frames?: SystemBandFrameLoader):
|
||||
{ measurement: ScreenshotDiffMeasurement; ignoredStatusBar: number; ignoredHomeIndicator: number } {
|
||||
if (measurement.match || measurement.regions.length === 0 || system.length === 0) return { measurement, ignoredStatusBar: 0, ignoredHomeIndicator: 0 };
|
||||
// agent-device rounds each of x, y, width and height to 0.01%, so an edge it reports can be up to 0.01% past the real one.
|
||||
const slack = 0.015;
|
||||
const inside = (region: VisualDiffRegion, area: SystemRegion) => {
|
||||
const rect = region.normalizedRect;
|
||||
return rect.x >= area.x - slack && rect.y >= area.y - slack
|
||||
&& rect.x + rect.width <= area.x + area.width + slack && rect.y + rect.height <= area.y + area.height + slack;
|
||||
};
|
||||
const across = system.filter((area) => area.x <= slack && area.x + area.width >= 100 - slack);
|
||||
const topBand = across.find((area) => area.y <= slack);
|
||||
const bottomBand = across.find((area) => area !== topBand && area.y + area.height >= 100 - slack);
|
||||
const crossesTop = (region: VisualDiffRegion) => topBand !== undefined && region.normalizedRect.y < topBand.y + topBand.height - slack;
|
||||
const crossesBottom = (region: VisualDiffRegion) => bottomBand !== undefined && region.normalizedRect.y + region.normalizedRect.height > bottomBand.y + slack;
|
||||
let loaded: SystemBandFrames | undefined | null = null;
|
||||
const load = () => { if (loaded === null) loaded = frames?.() ?? undefined; return loaded; };
|
||||
let ignoredTop = 0; let ignoredBottom = 0; let ignoredPixels = 0;
|
||||
const ignored: Record<SystemRegion["kind"], number> = { "status-bar": 0, "home-indicator": 0 };
|
||||
let ignoredPixels = 0;
|
||||
const remaining: VisualDiffRegion[] = [];
|
||||
for (const region of measurement.regions) {
|
||||
if (inTop(region)) { ignoredTop += 1; ignoredPixels += region.differentPixels; continue; }
|
||||
if (inBottom(region)) { ignoredBottom += 1; ignoredPixels += region.differentPixels; continue; }
|
||||
const top = crossesTop(region); const bottom = crossesBottom(region);
|
||||
const area = system.find((candidate) => inside(region, candidate));
|
||||
if (area) { ignored[area.kind] += 1; ignoredPixels += region.differentPixels; continue; }
|
||||
const top = crossesTop(region) ? topBand : undefined; const bottom = crossesBottom(region) ? bottomBand : undefined;
|
||||
const decoded = top || bottom ? load() : undefined;
|
||||
if (!decoded) { remaining.push(region); continue; }
|
||||
const { height, width } = decoded.baseline;
|
||||
const bandRows = Math.floor((height * bands.top) / 100); const indicatorStart = height - Math.floor((height * bands.bottom) / 100);
|
||||
const rect = { ...region.rect };
|
||||
if (top) { const rows = Math.max(0, Math.min(rect.y + rect.height, bandRows) - rect.y); rect.y += rows; rect.height -= rows; }
|
||||
if (bottom) rect.height = Math.min(rect.y + rect.height, indicatorStart) - rect.y;
|
||||
if (top) {
|
||||
const bandRows = Math.floor((height * (top.y + top.height)) / 100);
|
||||
const rows = Math.max(0, Math.min(rect.y + rect.height, bandRows) - rect.y); rect.y += rows; rect.height -= rows;
|
||||
}
|
||||
if (bottom) rect.height = Math.min(rect.y + rect.height, height - Math.floor((height * bottom.height) / 100)) - rect.y;
|
||||
// Counted in what is left of the rect, not in what the band takes: the rect can enclose another region's pixels,
|
||||
// which can only add to what is kept (up to the region's own count), never take from it.
|
||||
const differentPixels = rect.height > 0 ? Math.min(region.differentPixels, differentPixelsInRect(decoded.baseline, decoded.current, rect, decoded.distance)) : 0;
|
||||
const inside = region.differentPixels - differentPixels;
|
||||
const inBand = region.differentPixels - differentPixels;
|
||||
if (differentPixels === 0) {
|
||||
if (top) ignoredTop += 1; else ignoredBottom += 1;
|
||||
ignored[(top ?? bottom)!.kind] += 1;
|
||||
ignoredPixels += region.differentPixels;
|
||||
continue;
|
||||
}
|
||||
// Its pixels inside the band were left out too, so the band is marked as not compared, as for a dropped region.
|
||||
if (inside > 0) { if (top) ignoredTop += 1; if (bottom) ignoredBottom += 1; }
|
||||
ignoredPixels += inside;
|
||||
if (inBand > 0) { if (top) ignored[top.kind] += 1; if (bottom) ignored[bottom.kind] += 1; }
|
||||
ignoredPixels += inBand;
|
||||
const round = (value: number) => Math.round(value * 100) / 100;
|
||||
remaining.push({ ...region, rect, differentPixels,
|
||||
normalizedRect: { x: round((rect.x / width) * 100), y: round((rect.y / height) * 100), width: round((rect.width / width) * 100), height: round((rect.height / height) * 100) } });
|
||||
}
|
||||
if (ignoredPixels === 0) return { measurement, ignoredTop: 0, ignoredBottom: 0 };
|
||||
if (ignoredPixels === 0) return { measurement, ignoredStatusBar: 0, ignoredHomeIndicator: 0 };
|
||||
const differentPixels = Math.max(0, measurement.differentPixels - ignoredPixels);
|
||||
const regions = remaining.map((region) => ({ ...region,
|
||||
shareOfDiffPercentage: differentPixels > 0 ? Math.round((region.differentPixels / differentPixels) * 10000) / 100 : 0 }));
|
||||
return {
|
||||
ignoredTop,
|
||||
ignoredBottom,
|
||||
ignoredStatusBar: ignored["status-bar"],
|
||||
ignoredHomeIndicator: ignored["home-indicator"],
|
||||
measurement: {
|
||||
...measurement,
|
||||
differentPixels,
|
||||
@@ -338,6 +408,40 @@ function impactFor(surface: PlanSurface, presence: ComparatorSurfaceImpact["pres
|
||||
};
|
||||
}
|
||||
|
||||
/** The screenshot pairs `assessPublicEvidence` compares: both sides captured and landed, in the loop's order. */
|
||||
function comparablePairs(options: { plan: SourceCapturePlan; base: PublicEvidenceSide; head: PublicEvidenceSide }, colorSchemes: readonly ColorScheme[],
|
||||
baseColorSchemes: readonly ColorScheme[]): Array<{ id: string; basePath: string; headPath: string }> {
|
||||
const pairs: Array<{ id: string; basePath: string; headPath: string }> = [];
|
||||
for (const surface of options.plan.surfaces) {
|
||||
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen" || (!surface.baseCapture && !surface.headCapture)) continue;
|
||||
for (const { id, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
|
||||
if (baseId === null) continue;
|
||||
const basePath = localImagePath(options.base, baseId);
|
||||
const headPath = localImagePath(options.head, id);
|
||||
if (!basePath || !headPath || captureDiagnostic(surface, "base", options.base, baseId) || captureDiagnostic(surface, "head", options.head, id)) continue;
|
||||
pairs.push({ id, basePath, headPath });
|
||||
}
|
||||
}
|
||||
return pairs;
|
||||
}
|
||||
|
||||
/** Runs tasks at most `size` at a time, each started in the order it was queued. */
|
||||
function concurrencyLimit(size: number): <T>(task: () => Promise<T>) => Promise<T> {
|
||||
let active = 0;
|
||||
const queue: Array<() => void> = [];
|
||||
const next = () => { if (active < size) queue.shift()?.(); };
|
||||
return task => new Promise((resolve, reject) => {
|
||||
queue.push(() => {
|
||||
active += 1;
|
||||
task().then(resolve, reject).finally(() => { active -= 1; next(); });
|
||||
});
|
||||
next();
|
||||
});
|
||||
}
|
||||
|
||||
/** The limit the reviews in this process share when none is given: a local review compares its targets at once. */
|
||||
let processLimit: ReturnType<typeof concurrencyLimit> | undefined;
|
||||
|
||||
function localImagePath(side: PublicEvidenceSide, id: string): string | undefined {
|
||||
const frame = side.bundle.images[id];
|
||||
return frame ? localEvidencePath(side, frame.path) : undefined;
|
||||
@@ -358,19 +462,21 @@ function localEvidencePath(side: PublicEvidenceSide, relativePath: string): stri
|
||||
*/
|
||||
export function decideReview(scope: SurfaceSourceScope, visual: PublicVisualVerdict, summary?: WhatChangedSummary): PublicSurfaceReview {
|
||||
const facts = summary?.facts.map((fact) => ({ category: fact.category, templateId: fact.templateId, bullet: truncate(fact.bullet) })) ?? [];
|
||||
const differs = visual.verdict === "modified" || facts.length > 0;
|
||||
// Text that also differs between two captures of the same build is runtime state: listed, never what makes a change.
|
||||
const changes = facts.filter((fact) => fact.templateId !== "visible-text.unstable-within-build");
|
||||
const differs = visual.verdict === "modified" || changes.length > 0;
|
||||
const inconclusive = !differs && (visual.verdict === "needs-review" || Boolean(summary?.needsReview));
|
||||
const issue = summary?.reviewIssues[0]?.reason;
|
||||
const evidenceText = facts[0]?.bullet ?? visualDescription(visual);
|
||||
const evidenceText = changes[0]?.bullet ?? visualDescription(visual);
|
||||
if (scope === "none") {
|
||||
if (!differs) return { status: "unchanged", description: "No visible change" };
|
||||
// The comparator's generic visual fact reads as a styling change; a variant names what differs.
|
||||
const state = facts.find((fact) => fact.category !== "visual")?.bullet
|
||||
const state = [...changes, ...facts].find((fact) => fact.category !== "visual")?.bullet
|
||||
?? `${percentage(visual.mismatchPercentage)}${visual.regions?.[0]?.location ? ` · ${visual.regions[0].location}` : ""}`;
|
||||
return { status: "variant", description: truncate(`Runtime state differs: ${state}`), ...(facts.length ? { facts } : {}) };
|
||||
}
|
||||
if (differs) {
|
||||
const description = !facts.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
|
||||
const description = !changes.length && issue ? `${visualDescription(visual)} · ${issue}` : evidenceText;
|
||||
return { status: "modified", description: truncate(description), ...(facts.length ? { facts } : {}) };
|
||||
}
|
||||
if (inconclusive) {
|
||||
@@ -418,6 +524,8 @@ function captureDiagnostic(surface: PlanSurface, side: "base" | "head", evidence
|
||||
export async function assessPublicEvidence(options: {
|
||||
/** The captured platform; its status bar band is left out of the visual verdict. Absent: iOS. */
|
||||
platform?: "ios" | "android";
|
||||
/** The system-drawn areas left out of the visual verdict; absent, the platform's bands. */
|
||||
systemRegions?: SystemRegion[];
|
||||
plan: SourceCapturePlan;
|
||||
base: PublicEvidenceSide;
|
||||
head: PublicEvidenceSide;
|
||||
@@ -427,8 +535,11 @@ export async function assessPublicEvidence(options: {
|
||||
timeBudgetMs?: number;
|
||||
now?: () => number;
|
||||
measure?: (baselinePath: string, currentPath: string) => Promise<ScreenshotDiffMeasurement>;
|
||||
/** How many screenshot pairs compare at once. Absent: one per available CPU, shared by every review in this process. */
|
||||
concurrency?: number;
|
||||
}): Promise<PublicEvidenceResult> {
|
||||
const threshold = options.threshold ?? DEFAULT_VISUAL_THRESHOLD;
|
||||
const system = options.systemRegions ?? defaultSystemRegions({ platform: options.platform });
|
||||
const now = options.now ?? Date.now;
|
||||
const deadline = now() + (options.timeBudgetMs ?? DEFAULT_EVIDENCE_TIME_BUDGET_MS);
|
||||
const surfaces: Record<string, PublicSurfaceAssessment> = {};
|
||||
@@ -444,6 +555,34 @@ export async function assessPublicEvidence(options: {
|
||||
const measure = options.measure ?? (async (baselinePath: string, currentPath: string) => (
|
||||
await diffScreenshots({ baselinePath, currentPath, command: options.agentDeviceCommand, threshold })
|
||||
));
|
||||
type ComparedPair = { visual: PublicVisualVerdict; assessment: VisualEvidenceAssessment };
|
||||
/** One pair's measurement, verdict and region moves: the work that runs ahead of the surface loop. */
|
||||
const comparePair = async (basePath: string, headPath: string): Promise<ComparedPair> => {
|
||||
const raw = await measure(basePath, headPath);
|
||||
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
|
||||
const assessment = assessVisualMeasurements({
|
||||
baselineSamples: 1,
|
||||
currentSamples: 1,
|
||||
requiredSamples: 1,
|
||||
baselineWithin: [],
|
||||
currentWithin: [],
|
||||
crossBuild: [measurement],
|
||||
representative: measurement,
|
||||
});
|
||||
const visual = visualVerdict(assessment, threshold);
|
||||
// Measuring moves is extra: once the comparison budget is spent, regions go out unmeasured.
|
||||
if (visual.verdict === "modified" && visual.regions?.length && now() <= deadline) {
|
||||
Object.assign(visual, await withRegionShifts(basePath, headPath, measurement.regions, visual.regions));
|
||||
}
|
||||
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
|
||||
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
|
||||
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
|
||||
return { visual, assessment };
|
||||
};
|
||||
/** A pair compared if the budget has not expired when its turn to start comes; undefined when it has. */
|
||||
const compareInBudget = async (basePath: string, headPath: string): Promise<ComparedPair | undefined> => (
|
||||
now() > deadline ? undefined : await comparePair(basePath, headPath)
|
||||
);
|
||||
const visualCounts = { compared: 0, modified: 0, unchanged: 0, needsReview: 0, failed: 0, errors: [] as string[] };
|
||||
const accessibilityCounts = { compared: 0, described: 0, failed: 0, skipped: 0, errors: [] as string[] };
|
||||
const reviewCounts = { modified: 0, needsReview: 0, variants: 0, unchanged: 0 };
|
||||
@@ -460,6 +599,20 @@ export async function assessPublicEvidence(options: {
|
||||
|
||||
const colorSchemes = bundleColorSchemes(options.head.bundle);
|
||||
const baseColorSchemes = bundleColorSchemes(options.base.bundle);
|
||||
// The pairs the loop below compares start now, a few at a time: each is a comparator process and a pixel search
|
||||
// that take seconds on a large screenshot, so they overlap instead of queueing behind one another. The loop reads
|
||||
// them in its own order, so the result does not depend on which finishes first. A pair whose turn comes after the
|
||||
// budget expired is not started; one started in time is waited for and used.
|
||||
const ahead = new Map<string, Promise<ComparedPair | undefined>>();
|
||||
if (visualAvailable) {
|
||||
const limit = options.concurrency !== undefined ? concurrencyLimit(Math.max(1, Math.floor(options.concurrency)))
|
||||
: processLimit ??= concurrencyLimit(availableParallelism());
|
||||
for (const { id, basePath, headPath } of comparablePairs(options, colorSchemes, baseColorSchemes)) {
|
||||
const started = limit(() => compareInBudget(basePath, headPath));
|
||||
started.catch(() => undefined);
|
||||
ahead.set(id, started);
|
||||
}
|
||||
}
|
||||
for (const surface of options.plan.surfaces) {
|
||||
for (const side of ["base", "head"] as const) {
|
||||
if (!surface[`${side}Capture`] || surface[`${side}Surface`]?.kind !== "screen") continue;
|
||||
@@ -488,7 +641,19 @@ export async function assessPublicEvidence(options: {
|
||||
if (surface.baseSurface?.kind !== "screen" || surface.headSurface?.kind !== "screen"
|
||||
|| (!surface.baseCapture && !surface.headCapture)) continue;
|
||||
// Every appearance the capture rendered is compared like-for-like: `<id>@<scheme>` frames against each other.
|
||||
for (const { id, scheme, baseId } of appearancePairs(surface.id, colorSchemes, baseColorSchemes)) {
|
||||
const pairs = appearancePairs(surface.id, colorSchemes, baseColorSchemes);
|
||||
// The screen's other appearances, rendered by both builds and verified on both: a label that varies between a
|
||||
// build's own appearances is runtime state. An unverified capture may show another screen, so it is no evidence.
|
||||
const baseRoute = surface.baseSurface, headRoute = surface.headSurface;
|
||||
const siblings = (current: string) => pairs.flatMap((pair) => {
|
||||
if (pair.id === current || pair.baseId === null || captureDiagnostic(surface, "base", options.base, pair.baseId)
|
||||
|| captureDiagnostic(surface, "head", options.head, pair.id)) return [];
|
||||
try {
|
||||
return [{ base: matchedSide("base", options.base, { ...baseRoute, id: pair.baseId }, options.profile),
|
||||
head: matchedSide("head", options.head, { ...headRoute, id: pair.id }, options.profile) }];
|
||||
} catch { return []; }
|
||||
});
|
||||
for (const { id, scheme, baseId } of pairs) {
|
||||
// An appearance the base never rendered has nothing to compare against: the head frame is new evidence.
|
||||
if (baseId === null) {
|
||||
if (localImagePath(options.head, id)) {
|
||||
@@ -513,47 +678,29 @@ export async function assessPublicEvidence(options: {
|
||||
continue;
|
||||
}
|
||||
|
||||
let visual: PublicVisualVerdict;
|
||||
let assessment: VisualEvidenceAssessment | undefined;
|
||||
if (now() > deadline) {
|
||||
let compared: ComparedPair | undefined;
|
||||
try {
|
||||
compared = await (ahead.get(id) ?? compareInBudget(basePath, headPath));
|
||||
} catch (error) {
|
||||
visualCounts.failed += 1;
|
||||
const diagnostic = comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
|
||||
message: "Screenshot comparison failed.", nextAction: "Check the screenshot files and the agent-device comparison diagnostics, then rerun comparison.", retryable: true });
|
||||
recordError(visualCounts.errors, id, diagnostic.message);
|
||||
continue;
|
||||
}
|
||||
if (!compared) {
|
||||
visualCounts.failed += 1;
|
||||
const diagnostic = comparisonError(id, undefined, { code: "VISUAL_COMPARISON_BUDGET_EXHAUSTED", stage: "compare",
|
||||
message: "The time budget expired before screenshot comparison.",
|
||||
nextAction: "Increase the evidence comparison time budget or reduce the number of selected routes, then rerun comparison.", retryable: true });
|
||||
recordError(visualCounts.errors, id, diagnostic.message);
|
||||
continue;
|
||||
} else {
|
||||
try {
|
||||
const raw = await measure(basePath, headPath);
|
||||
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) }, systemBandFrameLoader(raw, threshold));
|
||||
assessment = assessVisualMeasurements({
|
||||
baselineSamples: 1,
|
||||
currentSamples: 1,
|
||||
requiredSamples: 1,
|
||||
baselineWithin: [],
|
||||
currentWithin: [],
|
||||
crossBuild: [measurement],
|
||||
representative: measurement,
|
||||
});
|
||||
visual = visualVerdict(assessment, threshold);
|
||||
// Measuring moves is extra: once the comparison budget is spent, regions go out unmeasured.
|
||||
if (visual.verdict === "modified" && visual.regions?.length && now() <= deadline) {
|
||||
Object.assign(visual, await withRegionShifts(basePath, headPath, measurement.regions, visual.regions));
|
||||
}
|
||||
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
|
||||
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
|
||||
visualCounts.compared += 1;
|
||||
if (visual.verdict === "modified") visualCounts.modified += 1;
|
||||
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
|
||||
else visualCounts.needsReview += 1;
|
||||
} catch (error) {
|
||||
visualCounts.failed += 1;
|
||||
const diagnostic = comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
|
||||
message: "Screenshot comparison failed.", nextAction: "Check the screenshot files and the agent-device comparison diagnostics, then rerun comparison.", retryable: true });
|
||||
recordError(visualCounts.errors, id, diagnostic.message);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
const { visual, assessment } = compared;
|
||||
visualCounts.compared += 1;
|
||||
if (visual.verdict === "modified") visualCounts.modified += 1;
|
||||
else if (visual.verdict === "unchanged") visualCounts.unchanged += 1;
|
||||
else visualCounts.needsReview += 1;
|
||||
|
||||
const scope = surfaceSourceScope(surface) ?? "none";
|
||||
let review: PublicSurfaceReview | undefined;
|
||||
@@ -564,6 +711,7 @@ export async function assessPublicEvidence(options: {
|
||||
base: matchedSide("base", options.base, { ...surface.baseSurface, id: baseId }, options.profile),
|
||||
head: matchedSide("head", options.head, { ...surface.headSurface, id }, options.profile),
|
||||
visualAssessment: assessment,
|
||||
siblings: siblings(id),
|
||||
});
|
||||
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
|
||||
accessibilityCounts.compared += 1;
|
||||
@@ -594,11 +742,12 @@ export async function assessPublicEvidence(options: {
|
||||
if (!basePath || !headPath) continue;
|
||||
try {
|
||||
const raw = await measure(basePath, headPath);
|
||||
const { measurement, ignoredTop, ignoredBottom } = ignoreSystemBands(raw, { top: statusBarBandPercent(options.platform), bottom: homeIndicatorBandPercent(options.platform) }, systemBandFrameLoader(raw, threshold));
|
||||
const { measurement, ignoredStatusBar: ignoredTop, ignoredHomeIndicator: ignoredBottom } = ignoreSystemRegions(raw, system, systemBandFrameLoader(raw, threshold));
|
||||
const visual = visualVerdict(assessVisualMeasurements({ baselineSamples: 1, currentSamples: 1, requiredSamples: 1,
|
||||
baselineWithin: [], currentWithin: [], crossBuild: [measurement], representative: measurement }), threshold);
|
||||
if (ignoredTop > 0) visual.ignoredStatusBarRegions = ignoredTop;
|
||||
if (ignoredBottom > 0) visual.ignoredHomeIndicatorRegions = ignoredBottom;
|
||||
if (ignoredTop > 0 || ignoredBottom > 0) visual.systemRegions = system.map((area) => ({ ...area }));
|
||||
surfaces[id] = { visual };
|
||||
} catch (error) {
|
||||
comparisonError(id, error, { code: "VISUAL_COMPARISON_FAILED", stage: "compare",
|
||||
|
||||
@@ -70,6 +70,11 @@ export type CommonSurfaceComparatorInput = {
|
||||
visualAssessment: VisualEvidenceAssessment;
|
||||
/** Explicit stable runtime scope; semantic meaning is never inferred from diff pixels. */
|
||||
visualScope?: VisualReviewerChange["scope"];
|
||||
/**
|
||||
* The screen's other appearances, captured and verified on both builds. A label that varies between each build's own
|
||||
* captures, in the words that differ between the builds, is runtime state, and its difference is reported as such.
|
||||
*/
|
||||
siblings?: readonly { base: MatchedSurfaceSide; head: MatchedSurfaceSide }[];
|
||||
};
|
||||
|
||||
export type EvidenceComparatorInput =
|
||||
@@ -139,6 +144,7 @@ const CHANGE_PRIORITY: Record<SupportedReviewerChange["kind"], number> = {
|
||||
"element-added": 20,
|
||||
"element-removed": 20,
|
||||
"visible-text-changed": 30,
|
||||
"unstable-text": 35,
|
||||
"action-target-changed": 40,
|
||||
"accessibility-label-changed": 50,
|
||||
"accessibility-role-changed": 50,
|
||||
@@ -772,10 +778,76 @@ function actionTarget(side: ResolvedSide, element: ObservedElement): ActionTarge
|
||||
return target ? { kind: "target", target } : { kind: "none", evidenceRefs: [] };
|
||||
}
|
||||
|
||||
type ResolvedSibling = { base: ResolvedSide; head: ResolvedSide };
|
||||
|
||||
function resolveSiblings(input: CommonSurfaceComparatorInput, requiredSamples: 1 | 3): ResolvedSibling[] {
|
||||
const resolve = (side: "base" | "head", sibling: MatchedSurfaceSide) => {
|
||||
const screenId = sibling.map.observations.find((candidate) => candidate.id === sibling.observationId)?.screenId;
|
||||
const resolution = screenId === undefined ? undefined : resolveSide(side, sibling, { ...input.impact, id: screenId }, requiredSamples);
|
||||
// A sibling is evidence only when it resolves as cleanly as a comparison would.
|
||||
return resolution?.kind === "resolved" && resolution.side.issues.length === 0 ? resolution.side : undefined;
|
||||
};
|
||||
return (input.siblings ?? []).flatMap((sibling) => {
|
||||
const base = resolve("base", sibling.base);
|
||||
const head = resolve("head", sibling.head);
|
||||
return base && head ? [{ base, head }] : [];
|
||||
});
|
||||
}
|
||||
|
||||
function sameBounds(left: ElementBounds | undefined, right: ElementBounds | undefined): boolean {
|
||||
return !!left && !!right && left.x === right.x && left.y === right.y && left.width === right.width && left.height === right.height;
|
||||
}
|
||||
|
||||
/** The element at the same place in another capture: the one of its role with its identifier or, without one, its bounds. */
|
||||
function counterpart(element: ObservedElement, other: ResolvedSide): ObservedElement | undefined {
|
||||
const identifier = compact(element.identifier ?? "");
|
||||
const bounds = boundsOf(element);
|
||||
const candidates = other.elements.filter((candidate) => candidate.role === element.role && (identifier
|
||||
? compact(candidate.identifier ?? "") === identifier
|
||||
: !compact(candidate.identifier ?? "") && sameBounds(bounds, boundsOf(candidate))));
|
||||
return candidates.length === 1 ? candidates[0] : undefined;
|
||||
}
|
||||
|
||||
/** The word positions at which two labels differ, or undefined when they have different numbers of words. */
|
||||
function changedWords(left: string, right: string): number[] | undefined {
|
||||
const leftWords = left.split(" ");
|
||||
const rightWords = right.split(" ");
|
||||
return leftWords.length === rightWords.length
|
||||
? leftWords.flatMap((word, index) => word === rightWords[index] ? [] : [index])
|
||||
: undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* What the head showed in its other appearance, when a label's difference between the builds is runtime state: each
|
||||
* build shows the label differently in its own two appearances, the other appearance differs between the builds too,
|
||||
* and every word that differs between the builds is one that varies within a build. A label that follows the
|
||||
* appearance ("Switch to dark mode") does not vary within a build that broke it, or keeps a word that changed, so
|
||||
* its change is still a change.
|
||||
*/
|
||||
function unstableWithin(base: ObservedElement, head: ObservedElement, siblings: readonly ResolvedSibling[]): string | undefined {
|
||||
const baseLabel = compact(base.label);
|
||||
const headLabel = compact(head.label);
|
||||
for (const sibling of siblings) {
|
||||
const baseOther = compact(counterpart(base, sibling.base)?.label ?? "");
|
||||
const headOther = compact(counterpart(head, sibling.head)?.label ?? "");
|
||||
if (!baseLabel || !headLabel || !baseOther || !headOther) continue;
|
||||
const withinBase = changedWords(baseLabel, baseOther);
|
||||
const withinHead = changedWords(headLabel, headOther);
|
||||
const across = changedWords(baseLabel, headLabel);
|
||||
const acrossOther = changedWords(baseOther, headOther);
|
||||
if (!withinBase?.length || !withinHead?.length || !across?.length || !acrossOther?.length) continue;
|
||||
const varying = new Set([...withinBase, ...withinHead]);
|
||||
if ([...across, ...acrossOther].every((index) => varying.has(index))) return headOther;
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function comparePair(
|
||||
pair: ElementPair,
|
||||
base: ResolvedSide,
|
||||
head: ResolvedSide,
|
||||
/** What the head showed in its other appearance when this element's label is runtime state. */
|
||||
within?: string,
|
||||
): { facts: SupportedInput[]; issues: IssueInput[] } {
|
||||
const facts: SupportedInput[] = [];
|
||||
const issues: IssueInput[] = [];
|
||||
@@ -784,6 +856,10 @@ function comparePair(
|
||||
const headLabel = compact(pair.head.label);
|
||||
const baseAnnotation = base.annotationsByElementId.get(pair.base.elementId);
|
||||
const headAnnotation = head.annotationsByElementId.get(pair.head.elementId);
|
||||
// Runtime state replaces a label change only where the label comparison itself holds: provenance still decides first.
|
||||
const labelChange = (change: SupportedReviewerChange): SupportedReviewerChange => within
|
||||
? { kind: "unstable-text", subjectRole: reviewerRole(pair.head.role), before: baseLabel, after: headLabel, within }
|
||||
: change;
|
||||
|
||||
if (baseLabel !== headLabel) {
|
||||
if (baseAnnotation && headAnnotation) {
|
||||
@@ -793,14 +869,14 @@ function comparePair(
|
||||
} else if (!baseLabel || !headLabel) {
|
||||
issues.push(inconclusive("Visible-title comparison is missing before or after text.", refs));
|
||||
} else {
|
||||
facts.push(supported({
|
||||
facts.push(supported(labelChange({
|
||||
kind: "visible-text-changed",
|
||||
subjectRole: subject.subjectRole,
|
||||
subjectLabel: subject.subjectLabel,
|
||||
textKind: pair.head.role === "button" ? "title" : "label",
|
||||
before: baseLabel,
|
||||
after: headLabel,
|
||||
}, refs));
|
||||
}), refs));
|
||||
}
|
||||
} else if (baseAnnotation || headAnnotation) {
|
||||
issues.push(inconclusive(
|
||||
@@ -810,12 +886,12 @@ function comparePair(
|
||||
} else if (!baseLabel || !headLabel) {
|
||||
issues.push(inconclusive("Accessibility label comparison is missing before or after text.", refs));
|
||||
} else {
|
||||
facts.push(supported({
|
||||
facts.push(supported(labelChange({
|
||||
kind: "accessibility-label-changed",
|
||||
subjectRole: reviewerRole(pair.head.role),
|
||||
before: baseLabel,
|
||||
after: headLabel,
|
||||
}, refs));
|
||||
}), refs));
|
||||
}
|
||||
}
|
||||
if (pair.base.role !== pair.head.role) {
|
||||
@@ -1110,6 +1186,27 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
gone = base.elements.filter(element => content(element, headWords));
|
||||
arrived = head.elements.filter(element => content(element, baseWords));
|
||||
}
|
||||
// Text without an identifier is matched by its label, so a label that changed on its own leaves as one element and
|
||||
// arrives as another: the one of its role at the same place on both sides is runtime state when its label is.
|
||||
const siblings = mixedBackends ? [] : resolveSiblings(input, input.impact.baseSamples);
|
||||
const runtimeText = { base: new Set<string>(), head: new Set<string>() };
|
||||
for (const removed of siblings.length ? specificByLabel(gone) : []) {
|
||||
const added = counterpart(removed, head);
|
||||
if (!added || !arrived.includes(added) || counterpart(added, base) !== removed) continue;
|
||||
const within = unstableWithin(removed, added, siblings);
|
||||
if (!within) continue;
|
||||
runtimeText.base.add(compact(removed.label));
|
||||
runtimeText.head.add(compact(added.label));
|
||||
facts.push(supported({
|
||||
kind: "unstable-text",
|
||||
subjectRole: reviewerRole(added.role),
|
||||
before: compact(removed.label),
|
||||
after: compact(added.label),
|
||||
within,
|
||||
}, [elementRef("base", removed), elementRef("head", added)]));
|
||||
}
|
||||
gone = gone.filter((element) => !runtimeText.base.has(compact(element.label)));
|
||||
arrived = arrived.filter((element) => !runtimeText.head.has(compact(element.label)));
|
||||
for (const element of outermost(specificByLabel(gone))) {
|
||||
const label = compact(element.label);
|
||||
if (!label) {
|
||||
@@ -1141,7 +1238,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
}
|
||||
}
|
||||
for (const pair of pairing.pairs) {
|
||||
const comparison = comparePair(pair, base, head);
|
||||
const comparison = comparePair(pair, base, head, unstableWithin(pair.base, pair.head, siblings));
|
||||
facts.push(...comparison.facts);
|
||||
issues.push(...comparison.issues);
|
||||
}
|
||||
@@ -1154,7 +1251,7 @@ function commonResult(input: CommonSurfaceComparatorInput): EvidenceComparatorRe
|
||||
const visual = visualFact(input, base, head);
|
||||
// Pixels always move when an element appears or its text changes. The generic styling line
|
||||
// only informs when nothing in the accessibility tree accounts for the difference.
|
||||
const explained = facts.length > 0 && input.visualScope?.kind !== "landmark";
|
||||
const explained = facts.some((fact) => fact.change.kind !== "unstable-text") && input.visualScope?.kind !== "landmark";
|
||||
if (visual.fact && !explained) facts.push(visual.fact);
|
||||
if (visual.issue) issues.push(visual.issue);
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
import { Worker, isMainThread, parentPort, workerData } from "node:worker_threads";
|
||||
import { measureRegionMoves, type Rect } from "./region-shift.js";
|
||||
|
||||
type MeasuredRegions = Awaited<ReturnType<typeof measureRegionMoves>>;
|
||||
type RegionMoveWork = { regionMoveWork: true; basePath: string; headPath: string; regions: ReadonlyArray<Rect & { dominantChange?: string }> };
|
||||
type RegionMoveReply = { measured: MeasuredRegions } | { error: string };
|
||||
|
||||
/**
|
||||
* Measures region shifts and large moves on a worker thread, so several screenshot pairs search at once while the
|
||||
* main thread stays free: the search is CPU-bound and takes seconds on a tablet-sized screenshot. Falls back to the
|
||||
* calling thread when no worker can start.
|
||||
*/
|
||||
export async function measureRegionMovesInWorker(basePath: string, headPath: string, regions: RegionMoveWork["regions"]): Promise<MeasuredRegions> {
|
||||
const work: RegionMoveWork = { regionMoveWork: true, basePath, headPath, regions };
|
||||
let worker: Worker;
|
||||
try { worker = new Worker(new URL("./region-shift-worker.js", import.meta.url), { workerData: work }); }
|
||||
catch { return measureRegionMoves(basePath, headPath, regions); }
|
||||
return new Promise((resolve, reject) => {
|
||||
let settled = false;
|
||||
const finish = (outcome: () => void) => { if (!settled) { settled = true; outcome(); } };
|
||||
worker.once("message", (reply: RegionMoveReply) => finish(() => "error" in reply ? reject(new Error(reply.error)) : resolve(reply.measured)));
|
||||
// A worker that fails to load or dies before answering is a worker that did not start: the calling thread measures.
|
||||
worker.once("error", () => finish(() => resolve(measureRegionMoves(basePath, headPath, regions))));
|
||||
worker.once("exit", () => finish(() => resolve(measureRegionMoves(basePath, headPath, regions))));
|
||||
});
|
||||
}
|
||||
|
||||
if (!isMainThread && parentPort && (workerData as Partial<RegionMoveWork> | null)?.regionMoveWork === true) {
|
||||
const port = parentPort;
|
||||
const work = workerData as RegionMoveWork;
|
||||
measureRegionMoves(work.basePath, work.headPath, work.regions)
|
||||
.then(measured => port.postMessage({ measured } satisfies RegionMoveReply), (error: unknown) => port.postMessage({ error: (error as Error).message } satisfies RegionMoveReply));
|
||||
}
|
||||
+304
-8
@@ -4,7 +4,7 @@ import type { DecodedFrame } from "../shared/png-evidence.js";
|
||||
|
||||
/** How far a region's content moved from Before to After, in screenshot pixels (right and down are positive). */
|
||||
export type RegionShift = { x: number; y: number };
|
||||
type Rect = { x: number; y: number; width: number; height: number };
|
||||
export type Rect = { x: number; y: number; width: number; height: number };
|
||||
|
||||
/**
|
||||
* The farthest a region is searched for, in screenshot pixels: layout drift, not a different screen. Drift adds up
|
||||
@@ -63,13 +63,38 @@ function at(source: Image, x: number, y: number, channel?: number): number {
|
||||
return value(x0, y0) * (1 - fx) * (1 - fy) + value(x1, y0) * fx * (1 - fy) + value(x0, y1) * (1 - fx) * fy + value(x1, y1) * fx * fy;
|
||||
}
|
||||
|
||||
/** How badly After's region matches Before shifted by (sx, sy). */
|
||||
function mismatch(base: Image, head: Image, rect: Rect, sx: number, sy: number): number {
|
||||
/**
|
||||
* How badly After's region matches Before shifted by (sx, sy): the summed luminance difference, row by row. A sum
|
||||
* that passes `limit` stops early and returns a value above it: such a fit is neither the best, nor a tie, nor an
|
||||
* ambiguity, so its exact error is never read. Whole-pixel shifts read the pixel directly (the bilinear weights are
|
||||
* exactly 1 and 0 there); fractional ones interpolate like `at`.
|
||||
*/
|
||||
function mismatch(base: Image, head: Image, rect: Rect, sx: number, sy: number, limit = Infinity): number {
|
||||
const { width, height, luminance } = base;
|
||||
const maxX = width - 1, maxY = height - 1;
|
||||
const headLuminance = head.luminance, headWidth = head.width;
|
||||
const whole = Number.isInteger(sx) && Number.isInteger(sy);
|
||||
let error = 0;
|
||||
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
|
||||
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
|
||||
error += Math.abs(at(base, x - sx, y - sy) - head.luminance[y * head.width + x]!);
|
||||
const headRow = y * headWidth;
|
||||
if (whole) {
|
||||
const row = Math.min(maxY, Math.max(0, y - sy)) * width;
|
||||
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
|
||||
error += Math.abs(luminance[row + Math.min(maxX, Math.max(0, x - sx))]! - headLuminance[headRow + x]!);
|
||||
}
|
||||
} else {
|
||||
const cy = Math.min(maxY, Math.max(0, y - sy));
|
||||
const y0 = Math.floor(cy), y1 = Math.min(maxY, y0 + 1), fy = cy - y0;
|
||||
const row0 = y0 * width, row1 = y1 * width;
|
||||
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
|
||||
const cx = Math.min(maxX, Math.max(0, x - sx));
|
||||
const x0 = Math.floor(cx), x1 = Math.min(maxX, x0 + 1), fx = cx - x0;
|
||||
const sample = luminance[row0 + x0]! * (1 - fx) * (1 - fy) + luminance[row0 + x1]! * fx * (1 - fy)
|
||||
+ luminance[row1 + x0]! * (1 - fx) * fy + luminance[row1 + x1]! * fx * fy;
|
||||
error += Math.abs(sample - headLuminance[headRow + x]!);
|
||||
}
|
||||
}
|
||||
if (error > limit) return error;
|
||||
}
|
||||
return error;
|
||||
}
|
||||
@@ -110,18 +135,29 @@ function regionShift(base: Image, head: Image, region: Rect): RegionShift | unde
|
||||
const unshifted = mismatch(base, head, rect, 0, 0);
|
||||
if (unshifted === 0) return undefined;
|
||||
// Whole pixels first, every pixel counting: sampling every other row aliases on thin shapes (text, hairlines).
|
||||
// A fit worse than the best so far by more than the ambiguity margin cannot become the best, tie with it, or make
|
||||
// it ambiguous; its measurement stops as soon as that is known. The margin is taken from the worst fit the tie
|
||||
// could choose, since a tie goes to the smallest move, not the least error.
|
||||
const whole: Fit[] = [];
|
||||
let least = unshifted;
|
||||
for (let sy = -MAX_SHIFT_Y; sy <= MAX_SHIFT_Y; sy += 1) {
|
||||
for (let sx = -MAX_SHIFT_X; sx <= MAX_SHIFT_X; sx += 1) whole.push({ sx, sy, error: mismatch(base, head, rect, sx, sy) });
|
||||
for (let sx = -MAX_SHIFT_X; sx <= MAX_SHIFT_X; sx += 1) {
|
||||
const error = sx === 0 && sy === 0 ? unshifted : mismatch(base, head, rect, sx, sy, (least * TIE + 1e-6) * AMBIGUOUS + 1e-6);
|
||||
least = Math.min(least, error);
|
||||
whole.push({ sx, sy, error });
|
||||
}
|
||||
}
|
||||
const coarse = bestOf(whole);
|
||||
if (whole.some(fit => Math.abs(fit.sy - coarse.sy) >= 2 && fit.error <= coarse.error * AMBIGUOUS + 1e-6)) return undefined;
|
||||
// Then sixths of a pixel around it, from whole-number steps so a move up and a move down round alike.
|
||||
const fine: Fit[] = [];
|
||||
least = coarse.error;
|
||||
for (let iy = -STEPS_PER_PIXEL; iy <= STEPS_PER_PIXEL; iy += 1) {
|
||||
for (let ix = -STEPS_PER_PIXEL; ix <= STEPS_PER_PIXEL; ix += 1) {
|
||||
const sx = coarse.sx + ix / STEPS_PER_PIXEL, sy = coarse.sy + iy / STEPS_PER_PIXEL;
|
||||
fine.push({ sx, sy, error: ix === 0 && iy === 0 ? coarse.error : mismatch(base, head, rect, sx, sy) });
|
||||
const error = ix === 0 && iy === 0 ? coarse.error : mismatch(base, head, rect, sx, sy, least * TIE + 1e-6);
|
||||
least = Math.min(least, error);
|
||||
fine.push({ sx, sy, error });
|
||||
}
|
||||
}
|
||||
const best = bestOf(fine);
|
||||
@@ -141,10 +177,270 @@ export function regionShifts(baseFrame: DecodedFrame, headFrame: DecodedFrame, r
|
||||
return regions.map(region => regionShift(base, head, region));
|
||||
}
|
||||
|
||||
/**
|
||||
* A move too large for the drift search: content that left one area and arrived in another, such as a card that
|
||||
* went from the left of a wide sheet to its centre. `rect` is where the moved content is in After, `shift` how far it
|
||||
* went, and `members` the regions it explains (indices into the regions measured), the region it arrived in first.
|
||||
*/
|
||||
export type RegionMove = { rect: Rect; shift: RegionShift; members: number[] };
|
||||
|
||||
type Axis = "x" | "y";
|
||||
/** How alike two regions' extents across the move must be to be one element's two ends: overlap and size. */
|
||||
const PAIR_OVERLAP = 0.8;
|
||||
const PAIR_SIZE = 0.25;
|
||||
/** Rows (or columns) sampled for the brightness profiles that estimate a large move: every second one is plenty. */
|
||||
const PROFILE_STEP = 2;
|
||||
/** Another local best this close to the best makes a large move ambiguous: repeating content (a grid, a list). */
|
||||
const AMBIGUOUS_LARGE = 1.05;
|
||||
/** The share of the arrived region the move must explain, as for a small move. */
|
||||
const MIN_EXPLAINED_LARGE = MIN_EXPLAINED;
|
||||
/** After aligning by the move, at most this share of a region may still differ strongly (antialiased edges). */
|
||||
const CHANGED_SHARE = 0.001;
|
||||
/** How far across the move a large one may also drift, as layout below a moved element does; ties keep it in line. */
|
||||
const ACROSS_OFFSETS = [0, -1, 1, -2, 2, -3, 3];
|
||||
/**
|
||||
* Blocks that give something drawn away, where every pixel differs by more than `channel` in some channel: a 2×2
|
||||
* block of strongly different pixels (an icon, a badge, a mark), or a 4×4 block of moderately different ones (a
|
||||
* tint, a low-contrast label, a grey badge). Antialiased edges and hairlines against another backdrop are thinner:
|
||||
* the chevrons in euxy's Patterns rows (brentvatne/euxy#163) cross a curve that differs by up to 69 in 3×3 blocks
|
||||
* but only 26 in 4×4 ones, while a grey "Off" label the move did not bring differs by 55 in 4×4 blocks.
|
||||
*/
|
||||
const SOLID_BLOCKS = [{ size: 2, channel: CHANGED_CHANNEL }, { size: 4, channel: 40 }];
|
||||
|
||||
const extent = (rect: Rect, axis: Axis) => axis === "x" ? { start: rect.x, size: rect.width } : { start: rect.y, size: rect.height };
|
||||
const across = (axis: Axis): Axis => axis === "x" ? "y" : "x";
|
||||
const shiftAlong = (axis: Axis, along: number, other = 0): RegionShift => axis === "x" ? { x: along, y: other } : { x: other, y: along };
|
||||
|
||||
/** Whether two regions could be one element's two ends of a move along `axis`: side by side, alike across it. */
|
||||
function pairAlong(a: Rect, b: Rect, axis: Axis): boolean {
|
||||
const ea = extent(a, axis), eb = extent(b, axis), ca = extent(a, across(axis)), cb = extent(b, across(axis));
|
||||
const separate = ea.start + ea.size <= eb.start || eb.start + eb.size <= ea.start;
|
||||
const overlap = Math.min(ca.start + ca.size, cb.start + cb.size) - Math.max(ca.start, cb.start);
|
||||
const alike = Math.abs(ea.size - eb.size) <= PAIR_SIZE * Math.max(ea.size, eb.size);
|
||||
return separate && alike && overlap >= PAIR_OVERLAP * Math.min(ca.size, cb.size);
|
||||
}
|
||||
|
||||
/** Mean luminance along `axis` of a band across it: one value per column (axis x) or row (axis y). */
|
||||
function profile(source: Image, axis: Axis, bandStart: number, bandEnd: number): Float32Array {
|
||||
const length = axis === "x" ? source.width : source.height;
|
||||
const values = new Float32Array(length);
|
||||
for (let position = 0; position < length; position += 1) {
|
||||
let sum = 0, count = 0;
|
||||
for (let other = bandStart; other < bandEnd; other += PROFILE_STEP) {
|
||||
sum += axis === "x" ? source.luminance[other * source.width + position]! : source.luminance[position * source.width + other]!;
|
||||
count += 1;
|
||||
}
|
||||
values[position] = count ? sum / count : 0;
|
||||
}
|
||||
return values;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a region holds something drawn: a solid block (SOLID_BLOCKS), or more than `allowed` strongly different
|
||||
* pixels anywhere. `difference` is how much the pixel at (x, y) differs, in its most different channel.
|
||||
*/
|
||||
function drawnIn(rect: Rect, difference: (x: number, y: number) => number, allowed = Infinity): boolean {
|
||||
// Per block: how many pixels differ in a row up to here, and for each column, how many rows have such a run.
|
||||
const blocks = SOLID_BLOCKS.map(block => ({ ...block, run: 0, rows: new Uint32Array(rect.width) }));
|
||||
let strong = 0;
|
||||
for (let y = rect.y; y < rect.y + rect.height; y += 1) {
|
||||
for (const block of blocks) block.run = 0;
|
||||
for (let x = rect.x; x < rect.x + rect.width; x += 1) {
|
||||
const value = difference(x, y), column = x - rect.x;
|
||||
if (value > CHANGED_CHANNEL && ++strong > allowed) return true;
|
||||
for (const block of blocks) {
|
||||
block.run = value > block.channel ? block.run + 1 : 0;
|
||||
block.rows[column] = block.run >= block.size ? block.rows[column]! + 1 : 0;
|
||||
if (block.rows[column]! >= block.size) return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether, aligned by an integer move, some of the region still differs: content that changed, not only moved. A
|
||||
* whole-pixel move copies the pixels, so only a sliver may differ strongly (antialiased edges against another
|
||||
* backdrop, never more than CHANGED_SHARE of the region), and never a solid block. Pixels the move brings in from
|
||||
* off screen differ.
|
||||
*/
|
||||
function changedAfterLargeMove(base: Image, head: Image, rect: Rect, sx: number, sy: number): boolean {
|
||||
return drawnIn(rect, (x, y) => {
|
||||
const bx = x - sx, by = y - sy;
|
||||
if (bx < 0 || by < 0 || bx >= base.width || by >= base.height) return 255;
|
||||
const h = (y * head.width + x) * 4, b = (by * base.width + bx) * 4;
|
||||
return Math.max(Math.abs(base.frame.data[b]! - head.frame.data[h]!), Math.abs(base.frame.data[b + 1]! - head.frame.data[h + 1]!),
|
||||
Math.abs(base.frame.data[b + 2]! - head.frame.data[h + 2]!));
|
||||
}, Math.max(CHANGED_PIXELS, rect.width * rect.height * CHANGED_SHARE));
|
||||
}
|
||||
|
||||
/** How much of a region's difference an integer move explains: 1 is all of it, 0 none. `unshifted` is the region's own. */
|
||||
function explained(base: Image, head: Image, rect: Rect, shift: RegionShift, unshifted = mismatch(base, head, rect, 0, 0)): number {
|
||||
return unshifted === 0 ? 0 : 1 - mismatch(base, head, rect, shift.x, shift.y) / unshifted;
|
||||
}
|
||||
|
||||
/** Whether a region's content, moved by `shift`, is the same in After: explained, and nothing changed in it. */
|
||||
function movedIntact(base: Image, head: Image, rect: Rect, shift: RegionShift): boolean {
|
||||
return rect.width > 0 && rect.height > 0 && explained(base, head, rect, shift) >= MIN_EXPLAINED_LARGE
|
||||
&& !changedAfterLargeMove(base, head, rect, shift.x, shift.y);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a part of After where content left is plain backdrop: the colour around it (the median of the pixels just
|
||||
* outside it, not in the moved content's `outline`), with nothing drawn on it. A part with nothing around it is not.
|
||||
*/
|
||||
function plain(head: Image, rect: Rect, outline: Rect): boolean {
|
||||
if (rect.width <= 0 || rect.height <= 0) return true;
|
||||
const around: number[][] = [[], [], []];
|
||||
const add = (x: number, y: number) => {
|
||||
if (x < 0 || y < 0 || x >= head.width || y >= head.height) return;
|
||||
if (x >= outline.x && y >= outline.y && x < outline.x + outline.width && y < outline.y + outline.height) return;
|
||||
for (let channel = 0; channel < 3; channel += 1) around[channel]!.push(head.frame.data[(y * head.width + x) * 4 + channel]!);
|
||||
};
|
||||
for (let x = rect.x - 1; x <= rect.x + rect.width; x += 1) { add(x, rect.y - 1); add(x, rect.y + rect.height); }
|
||||
for (let y = rect.y; y < rect.y + rect.height; y += 1) { add(rect.x - 1, y); add(rect.x + rect.width, y); }
|
||||
if (!around[0]!.length) return false;
|
||||
const backdrop = around.map(values => values.sort((a, b) => a - b)[values.length >> 1]!);
|
||||
return !drawnIn(rect, (x, y) => {
|
||||
const offset = (y * head.width + x) * 4;
|
||||
return Math.max(Math.abs(head.frame.data[offset]! - backdrop[0]!), Math.abs(head.frame.data[offset + 1]! - backdrop[1]!),
|
||||
Math.abs(head.frame.data[offset + 2]! - backdrop[2]!));
|
||||
});
|
||||
}
|
||||
|
||||
/** The parts of `rect` before and after `outline` along `axis`: what is left of it outside the outline. */
|
||||
function outside(rect: Rect, outline: Rect, axis: Axis): Rect[] {
|
||||
const r = extent(rect, axis), o = extent(outline, axis);
|
||||
const parts: Array<[number, number]> = [[r.start, Math.min(r.start + r.size, o.start)], [Math.max(r.start, o.start + o.size), r.start + r.size]];
|
||||
return parts.filter(([from, to]) => to > from)
|
||||
.map(([from, to]) => (axis === "x" ? { ...rect, x: from, width: to - from } : { ...rect, y: from, height: to - from }));
|
||||
}
|
||||
|
||||
function clip(rect: Rect, width: number, height: number): Rect {
|
||||
const x = Math.max(0, Math.floor(rect.x)), y = Math.max(0, Math.floor(rect.y));
|
||||
return { x, y, width: Math.max(0, Math.min(width, Math.ceil(rect.x + rect.width)) - x), height: Math.max(0, Math.min(height, Math.ceil(rect.y + rect.height)) - y) };
|
||||
}
|
||||
|
||||
function union(a: Rect, b: Rect): Rect {
|
||||
const x = Math.min(a.x, b.x), y = Math.min(a.y, b.y);
|
||||
return { x, y, width: Math.max(a.x + a.width, b.x + b.width) - x, height: Math.max(a.y + a.height, b.y + b.height) - y };
|
||||
}
|
||||
|
||||
/**
|
||||
* The large move a pair of regions shows, if one does: `left` is where content was (it differs because the content
|
||||
* left), `arrived` where it is now, both already clipped to the screenshot. The pair only names the axis and how far
|
||||
* to look; the distance is where After's brightness profile across the arrived region best matches Before's, and
|
||||
* the pixels must agree once aligned, both where the content arrived and where the content that left went.
|
||||
*/
|
||||
function pairMove(base: Image, head: Image, left: Rect, arrived: Rect, axis: Axis): RegionShift | undefined {
|
||||
const a = extent(arrived, axis), l = extent(left, axis), band = extent(arrived, across(axis)), lb = extent(left, across(axis));
|
||||
const bandStart = Math.max(band.start, lb.start), bandEnd = Math.min(band.start + band.size, lb.start + lb.size);
|
||||
if (bandEnd <= bandStart || a.size <= 0) return undefined;
|
||||
const baseProfile = profile(base, axis, bandStart, bandEnd), headProfile = profile(head, axis, bandStart, bandEnd);
|
||||
const length = baseProfile.length;
|
||||
// Content moving toward the arrived region: the distance is positive when it lies after the region it left.
|
||||
const sign = a.start > l.start ? 1 : -1;
|
||||
const farthest = Math.abs(a.start + a.size - l.start) + Math.abs(l.start + l.size - a.start);
|
||||
const errors: Array<{ distance: number; error: number }> = [];
|
||||
for (let distance = (axis === "x" ? MAX_SHIFT_X : MAX_SHIFT_Y) + 1; distance <= farthest; distance += 1) {
|
||||
const move = sign * distance;
|
||||
let sum = 0, count = 0;
|
||||
for (let position = a.start; position < a.start + a.size; position += 1) {
|
||||
const from = position - move;
|
||||
if (from < 0 || from >= length) continue;
|
||||
sum += Math.abs(headProfile[position]! - baseProfile[from]!);
|
||||
count += 1;
|
||||
}
|
||||
if (count >= a.size / 2) errors.push({ distance: move, error: sum / count });
|
||||
}
|
||||
if (errors.length < 3) return undefined;
|
||||
const minima = errors.filter((fit, index) => index > 0 && index < errors.length - 1
|
||||
&& fit.error <= errors[index - 1]!.error && fit.error <= errors[index + 1]!.error);
|
||||
if (!minima.length) return undefined;
|
||||
const best = minima.reduce((least, fit) => (fit.error < least.error ? fit : least));
|
||||
if (minima.some(fit => fit !== best && Math.abs(fit.distance - best.distance) > 2 && fit.error <= best.error * AMBIGUOUS_LARGE + 1e-6)) return undefined;
|
||||
// The pixels decide: across the move it may also drift a little, as content below a moved element does. A tie
|
||||
// keeps the move in line (content the same all across it fits every drift equally).
|
||||
let chosen: RegionShift | undefined, fit = -Infinity;
|
||||
const unshifted = mismatch(base, head, arrived, 0, 0);
|
||||
for (const other of ACROSS_OFFSETS) {
|
||||
const shift = shiftAlong(axis, best.distance, other);
|
||||
const share = explained(base, head, arrived, shift, unshifted);
|
||||
if (share > fit) { fit = share; chosen = shift; }
|
||||
}
|
||||
if (!chosen || fit < MIN_EXPLAINED_LARGE || changedAfterLargeMove(base, head, arrived, chosen.x, chosen.y)) return undefined;
|
||||
// The content that left must be intact where the move takes it: a deletion is not a move.
|
||||
const landed = clip({ ...left, x: left.x + chosen.x, y: left.y + chosen.y }, head.width, head.height);
|
||||
return movedIntact(base, head, landed, chosen) ? chosen : undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves too large for the drift search, among the regions it left unexplained: two regions alike across an axis
|
||||
* and side by side along it, one darker and one brighter, are the two ends of something that moved. Where the
|
||||
* content left must be plain backdrop in After for that region to be part of the move; anything drawn there is a
|
||||
* change of its own and stays one. A move that checks out also takes in any other unexplained region it explains
|
||||
* (fragments of the same element where its old and new places overlap), and its outline is the moved content in After.
|
||||
*/
|
||||
export function regionMoves(baseFrame: DecodedFrame, headFrame: DecodedFrame,
|
||||
regions: ReadonlyArray<Rect & { dominantChange?: string }>, shifts: ReadonlyArray<RegionShift | undefined>): RegionMove[] {
|
||||
if (baseFrame.width !== headFrame.width || baseFrame.height !== headFrame.height) return [];
|
||||
const base = image(baseFrame), head = image(headFrame);
|
||||
const clipped = regions.map(region => clip(region, head.width, head.height));
|
||||
const open = new Set(regions.map((_, index) => index).filter(index => !shifts[index] && clipped[index]!.width > 0 && clipped[index]!.height > 0));
|
||||
const moves: RegionMove[] = [];
|
||||
// Largest first: the element that moved the most content is the one a reader is looking at.
|
||||
const order = [...open].sort((left, right) => clipped[right]!.width * clipped[right]!.height - clipped[left]!.width * clipped[left]!.height);
|
||||
for (let first = 0; first < order.length; first += 1) {
|
||||
for (let second = first + 1; second < order.length; second += 1) {
|
||||
const i = order[first]!, j = order[second]!;
|
||||
if (!open.has(i) || !open.has(j)) continue;
|
||||
const opposite = new Set([regions[i]!.dominantChange, regions[j]!.dominantChange]);
|
||||
if (!(opposite.has("brighter") && opposite.has("darker"))) continue;
|
||||
const a = clipped[i]!, b = clipped[j]!;
|
||||
for (const axis of ["x", "y"] as const) {
|
||||
if (!pairAlong(a, b, axis)) continue;
|
||||
// Either could be where the content arrived; the pixels decide which.
|
||||
const forward = pairMove(base, head, a, b, axis);
|
||||
const shift = forward ?? pairMove(base, head, b, a, axis);
|
||||
if (!shift) continue;
|
||||
const [leftIndex, arrivedIndex] = forward ? [i, j] : [j, i];
|
||||
const left = clipped[leftIndex]!, arrived = clipped[arrivedIndex]!;
|
||||
let rect = clip(union(arrived, { ...left, x: left.x + shift.x, y: left.y + shift.y }), head.width, head.height);
|
||||
open.delete(i); open.delete(j);
|
||||
// Where the content left: plain backdrop belongs to the move, anything drawn there is a change of its own.
|
||||
const members = outside(left, rect, axis).every(part => plain(head, part, rect)) ? [arrivedIndex, leftIndex] : [arrivedIndex];
|
||||
// Fragments of the same element inside its new place, where the old and new overlap.
|
||||
for (const k of [...open]) {
|
||||
const fragment = clipped[k]!;
|
||||
const inside = fragment.x >= rect.x && fragment.y >= rect.y && fragment.x + fragment.width <= rect.x + rect.width && fragment.y + fragment.height <= rect.y + rect.height;
|
||||
if (!inside || !movedIntact(base, head, fragment, shift)) continue;
|
||||
members.push(k); open.delete(k); rect = union(rect, fragment);
|
||||
}
|
||||
moves.push({ rect, shift, members });
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
return moves;
|
||||
}
|
||||
|
||||
/** Reads both PNG screenshots and measures each region's shift. */
|
||||
export async function measureRegionShifts(basePath: string, headPath: string, regions: readonly Rect[]): Promise<Array<RegionShift | undefined>> {
|
||||
const [base, head] = await readFrames(basePath, headPath);
|
||||
return regionShifts(base, head, regions);
|
||||
}
|
||||
|
||||
/** Reads both PNG screenshots once and measures each region's shift, then the large moves the rest show. */
|
||||
export async function measureRegionMoves(basePath: string, headPath: string, regions: ReadonlyArray<Rect & { dominantChange?: string }>):
|
||||
Promise<{ shifts: Array<RegionShift | undefined>; moves: RegionMove[]; width: number; height: number }> {
|
||||
const [base, head] = await readFrames(basePath, headPath);
|
||||
const shifts = regionShifts(base, head, regions);
|
||||
return { shifts, moves: regionMoves(base, head, regions, shifts), width: head.width, height: head.height };
|
||||
}
|
||||
|
||||
async function readFrames(basePath: string, headPath: string): Promise<[DecodedFrame, DecodedFrame]> {
|
||||
const { PNG } = createRequire(import.meta.url.replace(/\?.*$/, ""))("pngjs") as
|
||||
{ PNG: { sync: { read(bytes: Buffer, options: { checkCRC: boolean }): DecodedFrame } } };
|
||||
const [base, head] = await Promise.all([readFile(basePath), readFile(headPath)]);
|
||||
return regionShifts(PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false }), regions);
|
||||
return [PNG.sync.read(base, { checkCRC: false }), PNG.sync.read(head, { checkCRC: false })];
|
||||
}
|
||||
@@ -28,6 +28,7 @@ export type ReviewerChangeTemplateId =
|
||||
| "element.removed"
|
||||
| "visible-text.changed-short"
|
||||
| "visible-text.changed-long"
|
||||
| "visible-text.unstable-within-build"
|
||||
| "interaction.target-changed"
|
||||
| "accessibility.label-changed"
|
||||
| "accessibility.role-changed"
|
||||
@@ -95,6 +96,19 @@ export type VisibleTextReviewerChange = {
|
||||
after: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* A label that differs between the two builds but also between two captures of the same build (its light and dark
|
||||
* appearances): a clock, a relative time, a random name. Runtime state, not a change.
|
||||
*/
|
||||
export type UnstableTextReviewerChange = {
|
||||
kind: "unstable-text";
|
||||
subjectRole: ReviewerSubjectRole;
|
||||
before: string;
|
||||
after: string;
|
||||
/** What the same build showed in its other capture. */
|
||||
within: string;
|
||||
};
|
||||
|
||||
export type InteractionReviewerChange = {
|
||||
kind: "action-target-changed";
|
||||
subjectRole: ReviewerSubjectRole;
|
||||
@@ -134,6 +148,7 @@ export type SupportedReviewerChange =
|
||||
| ScreenReviewerChange
|
||||
| ElementReviewerChange
|
||||
| VisibleTextReviewerChange
|
||||
| UnstableTextReviewerChange
|
||||
| InteractionReviewerChange
|
||||
| AccessibilityReviewerChange
|
||||
| VisualReviewerChange
|
||||
@@ -387,6 +402,28 @@ function buildFact(change: SupportedReviewerChange, evidenceRefs: string[]): Can
|
||||
},
|
||||
};
|
||||
}
|
||||
case "unstable-text": {
|
||||
const before = compact(change.before);
|
||||
const after = compact(change.after);
|
||||
const within = compact(change.within);
|
||||
if (!before || !after || !within) return invalidChange("An unstable-text change requires all three labels.", evidenceRefs);
|
||||
if (before === after) return invalidChange("An unstable-text change has identical labels.", evidenceRefs);
|
||||
const seen = [...new Set([before, within, after])];
|
||||
return {
|
||||
kind: "fact",
|
||||
fact: {
|
||||
category: "visible-text",
|
||||
templateId: "visible-text.unstable-within-build",
|
||||
bullet: `Text varies between captures of the same build: ${seen.map(quote).join(" / ")}.`,
|
||||
subjectRole: change.subjectRole,
|
||||
subjectLabel: after,
|
||||
before,
|
||||
after,
|
||||
priority: PRIORITY["visible-text"],
|
||||
evidenceRefs,
|
||||
},
|
||||
};
|
||||
}
|
||||
case "accessibility-label-changed": {
|
||||
const before = compact(change.before);
|
||||
const after = compact(change.after);
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { execFile } from "node:child_process";
|
||||
import { lstat, readFile, realpath } from "node:fs/promises";
|
||||
import { isAbsolute } from "node:path";
|
||||
|
||||
@@ -133,30 +133,34 @@ export async function diffScreenshots(options: {
|
||||
|| !isAbsolute(options.command)
|
||||
|| /[\u0000-\u001f\u007f]/.test(options.command)
|
||||
) throw new Error("agent-device command must be an absolute path");
|
||||
const result = spawnSync(
|
||||
options.command,
|
||||
[
|
||||
"--json",
|
||||
"diff",
|
||||
"screenshot",
|
||||
"--baseline",
|
||||
baselinePath,
|
||||
currentPath,
|
||||
"--threshold",
|
||||
String(threshold),
|
||||
],
|
||||
{
|
||||
encoding: "utf8",
|
||||
shell: false,
|
||||
timeout: options.timeoutMs ?? 60_000,
|
||||
env: {
|
||||
PATH: process.env.PATH,
|
||||
const result = await new Promise<{ error: (Error & { code?: unknown }) | null; stdout: string; stderr: string }>(resolve => {
|
||||
execFile(
|
||||
options.command,
|
||||
[
|
||||
"--json",
|
||||
"diff",
|
||||
"screenshot",
|
||||
"--baseline",
|
||||
baselinePath,
|
||||
currentPath,
|
||||
"--threshold",
|
||||
String(threshold),
|
||||
],
|
||||
{
|
||||
encoding: "utf8",
|
||||
shell: false,
|
||||
timeout: options.timeoutMs ?? 60_000,
|
||||
env: {
|
||||
PATH: process.env.PATH,
|
||||
},
|
||||
maxBuffer: 4 * 1024 * 1024,
|
||||
},
|
||||
maxBuffer: 4 * 1024 * 1024,
|
||||
},
|
||||
);
|
||||
if (result.error) throw new Error(`Could not run screenshot diff: ${result.error.message}`);
|
||||
if (result.status !== 0) {
|
||||
(error, stdout, stderr) => resolve({ error, stdout, stderr }),
|
||||
);
|
||||
});
|
||||
// execFile reports a non-zero exit as an error carrying the exit status; a spawn failure or timeout carries none.
|
||||
if (result.error && typeof result.error.code !== "number") throw new Error(`Could not run screenshot diff: ${result.error.message}`);
|
||||
if (result.error) {
|
||||
const detail = (result.stderr || result.stdout || "unknown error").trim().slice(0, 500);
|
||||
throw new Error(`Screenshot diff failed: ${detail}`);
|
||||
}
|
||||
|
||||
@@ -25,6 +25,7 @@ jobs:
|
||||
contents: read
|
||||
outputs:
|
||||
targets: ${{ steps.targets.outputs.targets }}
|
||||
max_parallel: ${{ steps.targets.outputs.max_parallel }}
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with: { ref: '${{ github.sha }}', path: app, persist-credentials: false }
|
||||
@@ -51,12 +52,15 @@ jobs:
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
|
||||
echo "targets=$targets" >> "$GITHUB_OUTPUT"
|
||||
listed="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app/$APP_PROJECT_DIR" --config .expo-explore/config.yaml)"
|
||||
echo "targets=$(jq -c '[.targets[].id]' <<< "$listed")" >> "$GITHUB_OUTPUT"
|
||||
# Each target job needs a simulator session: at most capture.maxSessions of them run at once.
|
||||
echo "max_parallel=$(jq '.maxParallel // (.targets | length)' <<< "$listed")" >> "$GITHUB_OUTPUT"
|
||||
baseline:
|
||||
needs: targets
|
||||
strategy:
|
||||
fail-fast: false
|
||||
max-parallel: ${{ fromJSON(needs.targets.outputs.max_parallel) }}
|
||||
matrix:
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
@@ -48,6 +48,7 @@ jobs:
|
||||
contents: read
|
||||
outputs:
|
||||
targets: ${{ steps.targets.outputs.targets }}
|
||||
max_parallel: ${{ steps.targets.outputs.max_parallel }}
|
||||
base: ${{ steps.refs.outputs.base }}
|
||||
head: ${{ steps.refs.outputs.head }}
|
||||
compare: ${{ steps.refs.outputs.compare }}
|
||||
@@ -89,12 +90,15 @@ jobs:
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
|
||||
echo "targets=$targets" >> "$GITHUB_OUTPUT"
|
||||
listed="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml)"
|
||||
echo "targets=$(jq -c '[.targets[].id]' <<< "$listed")" >> "$GITHUB_OUTPUT"
|
||||
# Each target job needs a simulator session: at most capture.maxSessions of them run at once.
|
||||
echo "max_parallel=$(jq '.maxParallel // (.targets | length)' <<< "$listed")" >> "$GITHUB_OUTPUT"
|
||||
capture:
|
||||
needs: targets
|
||||
strategy:
|
||||
fail-fast: false
|
||||
max-parallel: ${{ fromJSON(needs.targets.outputs.max_parallel) }}
|
||||
matrix:
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
@@ -33,6 +33,7 @@ jobs:
|
||||
pull-requests: read
|
||||
outputs:
|
||||
targets: ${{ steps.targets.outputs.targets }}
|
||||
max_parallel: ${{ steps.targets.outputs.max_parallel }}
|
||||
# The failure job comments with these when a capture job fails before it resolves the PR itself.
|
||||
pr_number: ${{ steps.pr.outputs.pr_number }}
|
||||
base: ${{ steps.pr.outputs.base }}
|
||||
@@ -69,12 +70,15 @@ jobs:
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
targets="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml | jq -c '[.targets[].id]')"
|
||||
echo "targets=$targets" >> "$GITHUB_OUTPUT"
|
||||
listed="$(node "$TOOLS/dist/cli.js" config:targets --project "$GITHUB_WORKSPACE/app-head/$APP_PROJECT_DIR" --config .expo-explore/config.yaml)"
|
||||
echo "targets=$(jq -c '[.targets[].id]' <<< "$listed")" >> "$GITHUB_OUTPUT"
|
||||
# Each target job needs a simulator session: at most capture.maxSessions of them run at once.
|
||||
echo "max_parallel=$(jq '.maxParallel // (.targets | length)' <<< "$listed")" >> "$GITHUB_OUTPUT"
|
||||
capture:
|
||||
needs: targets
|
||||
strategy:
|
||||
fail-fast: false
|
||||
max-parallel: ${{ fromJSON(needs.targets.outputs.max_parallel) }}
|
||||
matrix:
|
||||
target: ${{ fromJSON(needs.targets.outputs.targets) }}
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
@@ -1543,3 +1543,146 @@ test("local run ZIP opens and reloads without a fabricated GitHub identity", asy
|
||||
await expect(localRun).toHaveText("Local");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("the Inspector stacks Before over After for a landscape screenshot; Swipe and Flip keep one frame", async t => {
|
||||
// An opened iPhone Duo's inner display, as a screenshot: wider than tall.
|
||||
const picture = new PNG({ width: 951, height: 669 });
|
||||
picture.data.fill(255);
|
||||
const capture = PNG.sync.write(picture);
|
||||
const report = reportFixture();
|
||||
for (const side of ["baseImage", "headImage"]) Object.assign(report.review.surfaces[0][side], { width: 951, height: 669 });
|
||||
const { bytes } = await imageArchive([capture], 0, report);
|
||||
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true, fault: holdScreenshotHashes(capture.length) });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const stage = page.locator(".sidebar-review-stage");
|
||||
const box = locator => locator.evaluate(element => {
|
||||
const { left, top, width, height } = element.getBoundingClientRect();
|
||||
return { left, top, width, height };
|
||||
});
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
// The report's recorded size shapes the pair before the screenshots load: no side-by-side flash.
|
||||
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "loading");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const waiting = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const [before, after] = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
|
||||
assert.deepEqual([before, after], waiting, "The frames do not move or resize when the screenshots load");
|
||||
const panel = await box(stage);
|
||||
// Each frame takes the review's width; After sits under Before, not beside it.
|
||||
assert.ok(Math.abs(before.width - panel.width) <= 2, `Before spans the panel: ${JSON.stringify({ before, panel })}`);
|
||||
assert.ok(Math.abs(after.width - panel.width) <= 2, `After spans the panel: ${JSON.stringify({ after, panel })}`);
|
||||
assert.ok(after.top >= before.top + before.height, `After is under Before: ${JSON.stringify({ before, after })}`);
|
||||
assert.ok(Math.abs(before.width / before.height - 951 / 669) < 0.02, `The frame keeps the screenshot's shape: ${JSON.stringify(before)}`);
|
||||
// Swipe and Flip show one frame the panel's width, as before.
|
||||
for (const mode of ["Swipe", "Flip"]) {
|
||||
await page.locator(".sidebar-review-modes").getByRole("button", { name: mode, exact: true }).click();
|
||||
const frame = await box(page.locator(".sidebar-review :is(.visual-swipe, .compare-frame)").first());
|
||||
assert.ok(Math.abs(frame.width - panel.width) <= 2, `${mode} spans the panel: ${JSON.stringify({ frame, panel })}`);
|
||||
}
|
||||
await page.locator(".sidebar-review-modes").getByRole("button", { name: "Split", exact: true }).click();
|
||||
await expect(frames).toHaveCount(2);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("the Inspector keeps a portrait pair side by side", async t => {
|
||||
const { page, errors } = await harness(t, await archive(), { app: true });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
await expect(frames.first().locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(page.locator(".sidebar-review-stage")).not.toHaveClass(/landscape/);
|
||||
const box = locator => locator.evaluate(element => {
|
||||
const { left, top, width } = element.getBoundingClientRect();
|
||||
return { left, top, width };
|
||||
});
|
||||
const [before, after] = await Promise.all([box(frames.nth(0)), box(frames.nth(1))]);
|
||||
assert.equal(after.top, before.top, `Before and After share a row: ${JSON.stringify({ before, after })}`);
|
||||
assert.ok(after.left >= before.left + before.width, `After is beside Before: ${JSON.stringify({ before, after })}`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/** A white PNG of `width` × `height`, and the asset entry and record fields a report gives it. */
|
||||
function sizedCapture(width, height) {
|
||||
const picture = new PNG({ width, height });
|
||||
picture.data.fill(255);
|
||||
const bytes = PNG.sync.write(picture);
|
||||
const digest = createHash("sha256").update(bytes).digest("hex");
|
||||
return { bytes, sha256: digest, path: `assets/${digest}.png`,
|
||||
record: { url: `https://artifact.expo-explore.invalid/${digest}.png`, sha256: digest, width, height } };
|
||||
}
|
||||
|
||||
test("the Inspector takes a pair's shape from After, whichever side loads last", async t => {
|
||||
// A screen that turned landscape: Before is the 32×64 portrait fixture, After is landscape.
|
||||
const landscape = sizedCapture(951, 669);
|
||||
const report = reportFixture();
|
||||
Object.assign(report.review.surfaces[0].headImage, landscape.record);
|
||||
report.assets.push({ sha256: landscape.sha256, path: landscape.path });
|
||||
// Before's screenshot is held until After's has loaded, so it loads last.
|
||||
const { page, errors } = await harness(t, await archive(report, [{ name: landscape.path, bytes: landscape.bytes }]),
|
||||
{ app: true, fault: holdScreenshotHashes(png.length) });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const stage = page.locator(".sidebar-review-stage");
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
await expect(frames.nth(1).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(frames.nth(0).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const ratio = await frames.nth(0).evaluate(element => element.getBoundingClientRect().width / element.getBoundingClientRect().height);
|
||||
assert.ok(Math.abs(ratio - 951 / 669) < 0.02, `Both frames keep After's shape: ${ratio}`);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("Swipe takes the loaded screenshot's shape when it differs from the recorded one", async t => {
|
||||
// The record says portrait; the screenshot is landscape. Swipe's frame follows the image, as
|
||||
// Split's and Flip's do, so a capture whose size the report does not hold is not cropped.
|
||||
const landscape = sizedCapture(951, 669);
|
||||
const { bytes } = await imageArchive([landscape.bytes]);
|
||||
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true, fault: holdScreenshotHashes(landscape.bytes.length) });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
// Swipe is chosen before any screenshot loads, so only Swipe's images report a size.
|
||||
await page.locator(".sidebar-review-modes").getByRole("button", { name: "Swipe", exact: true }).click();
|
||||
const swipe = page.locator(".sidebar-review .visual-swipe");
|
||||
await expect(swipe).toBeVisible();
|
||||
await page.evaluate(() => window.releaseScreenshotHashes());
|
||||
await expect(swipe.locator("img.visual-swipe-after")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
await expect.poll(() => swipe.evaluate(element => {
|
||||
const { width, height } = element.getBoundingClientRect();
|
||||
return Math.abs(width / height - 951 / 669) < 0.02;
|
||||
})).toBe(true);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a near-square landscape pair in a short window keeps both halves on screen, centred", async t => {
|
||||
// An unfolded foldable's inner display on its side: barely wider than tall.
|
||||
const foldable = sizedCapture(960, 800);
|
||||
const report = reportFixture();
|
||||
for (const side of ["baseImage", "headImage"]) Object.assign(report.review.surfaces[0][side], { width: 960, height: 800 });
|
||||
const { bytes } = await imageArchive([foldable.bytes], 0, report);
|
||||
const { page, errors } = await harness(t, Buffer.from(bytes), { app: true });
|
||||
await page.setViewportSize({ width: 1440, height: 760 });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
const stage = page.locator(".sidebar-review-stage");
|
||||
await expect(stage).toHaveClass(/landscape/);
|
||||
const frames = page.locator(".sidebar-review .compare-frame");
|
||||
await expect(frames).toHaveCount(2);
|
||||
await expect(frames.nth(1).locator("img")).toHaveAttribute("data-screenshot-state", "ready");
|
||||
const box = locator => locator.evaluate(element => {
|
||||
const { left, top, width, height, bottom } = element.getBoundingClientRect();
|
||||
return { left, top, width, height, bottom };
|
||||
});
|
||||
const [before, after, panel] = await Promise.all([box(frames.nth(0)), box(frames.nth(1)), box(stage)]);
|
||||
const viewport = page.viewportSize();
|
||||
assert.ok(after.top >= before.top + before.height, `After is under Before: ${JSON.stringify({ before, after })}`);
|
||||
assert.ok(before.top >= 0 && after.bottom <= viewport.height, `Both halves are on screen: ${JSON.stringify({ before, after, viewport })}`);
|
||||
for (const frame of [before, after]) {
|
||||
assert.ok(frame.width < panel.width - 2, `The frame is held under the panel's width: ${JSON.stringify({ frame, panel })}`);
|
||||
assert.ok(Math.abs(frame.left + frame.width / 2 - (panel.left + panel.width / 2)) <= 1, `The frame is centred: ${JSON.stringify({ frame, panel })}`);
|
||||
assert.ok(Math.abs(frame.width / frame.height - 960 / 800) < 0.02, `The frame keeps the screenshot's shape: ${JSON.stringify(frame)}`);
|
||||
}
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
@@ -188,12 +188,11 @@ test("Map keeps selected elevated arrows behind screenshots without rendering na
|
||||
await expect(sourceHitArea.locator("title")).toHaveText("Source navigation\npush · app/home.tsx");
|
||||
await page.mouse.move(1320, 30);
|
||||
const dimmedComparisons = [];
|
||||
for (const presentation of ["muted", "selection"]) {
|
||||
// Only the Changes filter dims a screen; a selection fades nothing.
|
||||
for (const presentation of ["muted"]) {
|
||||
await page.evaluate(mode => {
|
||||
const profile = document.querySelector('.react-flow__node[data-id="profile"]');
|
||||
const canvas = document.querySelector(".map-canvas");
|
||||
profile.classList.toggle("graph-node-muted", mode === "muted");
|
||||
canvas.classList.toggle("screen-selection-active", mode === "selection");
|
||||
}, presentation);
|
||||
const dimmedWithArrows = await profileImage.screenshot({ animations: "disabled" });
|
||||
await page.locator(".map-surface .react-flow__edges").evaluate(node => { node.style.visibility = "hidden"; });
|
||||
@@ -216,7 +215,6 @@ test("Map keeps selected elevated arrows behind screenshots without rendering na
|
||||
}
|
||||
await page.evaluate(() => {
|
||||
document.querySelector('.react-flow__node[data-id="profile"]').classList.remove("graph-node-muted");
|
||||
document.querySelector(".map-canvas").classList.remove("screen-selection-active");
|
||||
});
|
||||
await page.getByRole("button", { name: "Open Profile", exact: true }).click();
|
||||
assert.equal(await page.evaluate(() => window.selectedScreen), "profile");
|
||||
|
||||
@@ -155,7 +155,7 @@ test("Compare steps through changed screens and their changed areas", { timeout:
|
||||
|
||||
// A changed screen opens the same review in the Inspector on every canvas: Compare at sidebar
|
||||
// size. CI compares the images pixel for pixel, so /games's four CI regions read as changed
|
||||
// areas, outlined at the same place on both sides.
|
||||
// areas, outlined on After; Before keeps the same outlines unseen until one is hovered on After.
|
||||
await openChangedScreen(page, /, Modified, \/games$/);
|
||||
const inspector = page.locator(".right-panel");
|
||||
const review = inspector.getByRole("region", { name: "Changes in /games" });
|
||||
@@ -166,6 +166,8 @@ test("Compare steps through changed screens and their changed areas", { timeout:
|
||||
await expect.poll(() => outlineCount("after")).toBeGreaterThan(0);
|
||||
const areas = await outlineCount("after");
|
||||
assert.equal(await outlineCount("before"), areas);
|
||||
await expect(review.locator('[data-side="after"] .visual-change-outlines')).toHaveClass(/linked/);
|
||||
await expect(review.locator('[data-side="before"] .visual-change-outlines')).toHaveClass(/ghost/);
|
||||
// Esc closes the Inspector; the selection stays, a second Esc clears it.
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
|
||||
await page.keyboard.press("Escape");
|
||||
@@ -225,6 +227,12 @@ test("Compare steps through changed screens and their changed areas", { timeout:
|
||||
await expect.poll(() => compare.locator(`[data-side="${side}"] img`).first()
|
||||
.evaluate(image => image.naturalWidth)).toBe(402);
|
||||
}
|
||||
// Hovering an outline on After lights the same area on Before, and only that one.
|
||||
await compare.locator('[data-side="after"] .visual-change-outline').nth(1).hover();
|
||||
await expect(compare.locator('[data-side="before"] .visual-change-outline.hovered')).toHaveCount(1);
|
||||
await expect(compare.locator('[data-side="before"] .visual-change-outline').nth(1)).toHaveClass(/hovered/);
|
||||
await page.mouse.move(0, 0);
|
||||
await expect(compare.locator(".visual-change-outline.hovered")).toHaveCount(0);
|
||||
|
||||
// J and K step through the changed areas; Esc clears the highlight.
|
||||
const outlines = compare.locator('[data-side="after"] .visual-change-outline');
|
||||
|
||||
@@ -0,0 +1,145 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { chromium, expect } from "@playwright/test";
|
||||
import { PNG } from "pngjs";
|
||||
import { createBrowserVite } from "../helpers/browser-vite.mjs";
|
||||
|
||||
function png(width, height, color) {
|
||||
const image = new PNG({ width, height });
|
||||
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
|
||||
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
|
||||
}
|
||||
|
||||
// Split over one screen with two changed areas and a card that moved 40% of the width right (at 60% in After, so
|
||||
// at 20% in Before), and a second screen with one changed area elsewhere. The status bar CI left out is a foldable's
|
||||
// rail pill, not a band across the top. Keys stand in for the controller's, so the pointer can stay where it is:
|
||||
// 1 and 2 pick Split and Swipe, o toggles the outlines, n steps to the other screen, j selects the first area.
|
||||
const entry = `
|
||||
import { useState, useEffect } from "react";
|
||||
import { createRoot } from "react-dom/client";
|
||||
import { CompareStage } from "/src/components/compare/compare-section.tsx";
|
||||
import "/src/styles.css";
|
||||
const screens = [
|
||||
[
|
||||
{ x: 10, y: 20, width: 30, height: 20, share: 40, regionCount: 1 },
|
||||
{ x: 60, y: 60, width: 30, height: 20, share: 30, regionCount: 1, move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } },
|
||||
{ x: 55, y: 20, width: 35, height: 20, share: 30, regionCount: 1 },
|
||||
],
|
||||
[{ x: 10, y: 85, width: 20, height: 10, share: 100, regionCount: 1 }],
|
||||
];
|
||||
const systemRegions = [{ kind: "status-bar", x: 40, y: 0, width: 20, height: 4 }];
|
||||
function Harness() {
|
||||
const [mode, setMode] = useState("split");
|
||||
const [outlines, setOutlines] = useState(true);
|
||||
const [screen, setScreen] = useState(0);
|
||||
const [active, setActive] = useState();
|
||||
useEffect(() => {
|
||||
const onKey = (event) => {
|
||||
if (event.key === "1") setMode("split");
|
||||
if (event.key === "2") setMode("swipe");
|
||||
if (event.key === "o") setOutlines((shown) => !shown);
|
||||
if (event.key === "n") setScreen((index) => 1 - index);
|
||||
if (event.key === "j") setActive(0);
|
||||
};
|
||||
window.addEventListener("keydown", onKey);
|
||||
return () => window.removeEventListener("keydown", onKey);
|
||||
}, []);
|
||||
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: window.before, afterScreenshot: window.after };
|
||||
return (
|
||||
<div className={"compare-stage mode-" + mode} style={{ width: 800, height: 500, display: "flex" }}>
|
||||
<CompareStage key="stage" mode={mode} diff={diff} title="Share" areas={screens[screen]} activeArea={active}
|
||||
showOutlines={outlines} systemRegions={systemRegions} overlay={null} flipSide="after" onFlip={() => {}}
|
||||
swipePosition={50} onSwipePosition={() => {}} aspect={1} onAspect={() => {}} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
createRoot(document.getElementById("root")).render(<Harness />);
|
||||
`;
|
||||
|
||||
async function openSplit(t, contextOptions = {}) {
|
||||
const vite = await createBrowserVite(t, {
|
||||
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
|
||||
logLevel: "error", esbuild: { jsx: "automatic" },
|
||||
plugins: [{
|
||||
name: "split-outlines-fixture",
|
||||
resolveId: id => id === "/__split-outlines.tsx" ? id : undefined,
|
||||
load: id => id === "/__split-outlines.tsx" ? entry : undefined,
|
||||
configureServer(server) {
|
||||
server.middlewares.use((request, response, next) => {
|
||||
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
|
||||
response.setHeader("Content-Type", "text/html");
|
||||
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__split-outlines.tsx"></script></body></html>');
|
||||
});
|
||||
},
|
||||
}],
|
||||
server: { host: "127.0.0.1", port: 0 },
|
||||
});
|
||||
await vite.listen();
|
||||
const browser = await chromium.launch({ headless: true });
|
||||
t.after(() => browser.close());
|
||||
const page = await browser.newPage({ viewport: { width: 900, height: 600 }, ...contextOptions });
|
||||
const errors = [];
|
||||
page.on("pageerror", error => errors.push(error.message));
|
||||
t.after(() => assert.deepEqual(errors, []));
|
||||
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
|
||||
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
|
||||
const outline = (side, index) => page.locator(`[data-side="${side}"] .visual-change-outline`).nth(index);
|
||||
await expect(outline("after", 0)).toBeVisible();
|
||||
return { page, outline };
|
||||
}
|
||||
|
||||
const opacity = locator => locator.evaluate(element => Number(getComputedStyle(element).opacity));
|
||||
|
||||
test("Split keeps the ignored system regions the report names on both sides", { timeout: 30_000 }, async t => {
|
||||
const { page } = await openSplit(t);
|
||||
for (const side of ["before", "after"]) {
|
||||
const band = page.locator(`[data-side="${side}"] .visual-system-region-status-bar`);
|
||||
await expect(band).toHaveCount(1);
|
||||
const [frame, box] = await Promise.all([page.locator(`[data-side="${side}"] .compare-frame`).boundingBox(), band.boundingBox()]);
|
||||
assert.ok(Math.abs((box.x - frame.x) - 0.4 * frame.width) < 1, `${side}'s band sits where the report puts the rail pill`);
|
||||
assert.ok(Math.abs(box.width - 0.2 * frame.width) < 1);
|
||||
}
|
||||
});
|
||||
|
||||
test("Split hides Before's changed outlines but keeps a moved area where its content was", { timeout: 30_000 }, async t => {
|
||||
const { page, outline } = await openSplit(t);
|
||||
await expect.poll(() => opacity(outline("before", 0))).toBe(0);
|
||||
await expect.poll(() => opacity(outline("before", 1))).toBe(1);
|
||||
await expect(outline("before", 1).locator(".visual-change-measure")).toHaveCount(1);
|
||||
const frame = side => page.locator(`[data-side="${side}"] .compare-frame`).boundingBox();
|
||||
const [before, after, beforeFrame, afterFrame] = await Promise.all([outline("before", 1).boundingBox(), outline("after", 1).boundingBox(),
|
||||
frame("before"), frame("after")]);
|
||||
assert.ok(Math.abs(((after.x - afterFrame.x) - (before.x - beforeFrame.x)) - 0.4 * afterFrame.width) < 1, "Before's moved outline is back by the move");
|
||||
});
|
||||
|
||||
test("A hover is dropped when the screen, the mode or the outlines change under the pointer", { timeout: 30_000 }, async t => {
|
||||
const { page, outline } = await openSplit(t);
|
||||
const hovered = page.locator(".visual-change-outline.hovered");
|
||||
for (const [away, back] of [["2", "1"], ["o", "o"], ["n", "n"]]) {
|
||||
await outline("after", 0).hover();
|
||||
await expect(outline("before", 0)).toHaveClass(/hovered/);
|
||||
// The outline goes from under the pointer, which then moves off the frame before it comes back.
|
||||
await page.keyboard.press(away);
|
||||
await page.mouse.move(0, 0);
|
||||
await page.keyboard.press(back);
|
||||
await expect(outline("after", 0)).toBeVisible();
|
||||
await expect(hovered).toHaveCount(0);
|
||||
}
|
||||
});
|
||||
|
||||
test("The hovered outline on After stays lit while another area is selected", { timeout: 30_000 }, async t => {
|
||||
const { page, outline } = await openSplit(t);
|
||||
await page.keyboard.press("j");
|
||||
await outline("after", 2).hover();
|
||||
await expect.poll(() => opacity(outline("after", 2))).toBe(1);
|
||||
await expect.poll(() => opacity(outline("before", 2))).toBe(1);
|
||||
await expect.poll(() => opacity(outline("after", 1))).toBe(0.35);
|
||||
});
|
||||
|
||||
test("A screen without hover keeps Before's outlines, as it cannot reveal one", { timeout: 30_000 }, async t => {
|
||||
const { page, outline } = await openSplit(t, { hasTouch: true, isMobile: true });
|
||||
assert.equal(await page.evaluate(() => matchMedia("(hover: none)").matches), true);
|
||||
await expect.poll(() => opacity(outline("before", 0))).toBe(1);
|
||||
await expect.poll(() => opacity(outline("before", 2))).toBe(1);
|
||||
});
|
||||
@@ -0,0 +1,64 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { chromium, expect } from "@playwright/test";
|
||||
import { PNG } from "pngjs";
|
||||
import { createBrowserVite } from "../helpers/browser-vite.mjs";
|
||||
|
||||
function png(width, height, color) {
|
||||
const image = new PNG({ width, height });
|
||||
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
|
||||
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
|
||||
}
|
||||
|
||||
// A card that moved 40% of the width right: it is at 60% in After, so it was at 20% in Before.
|
||||
const entry = `
|
||||
import { createRoot } from "react-dom/client";
|
||||
import { SwipeCompare } from "/src/components/panels/visual-diff.tsx";
|
||||
import "/src/styles.css";
|
||||
const changes = [{ x: 60, y: 30, width: 30, height: 30, share: 100, regionCount: 1,
|
||||
move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } }];
|
||||
createRoot(document.getElementById("root")).render(<div style={{ width: 400, display: "flex" }}>
|
||||
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={50} />
|
||||
</div>);
|
||||
`;
|
||||
|
||||
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
|
||||
const vite = await createBrowserVite(t, {
|
||||
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
|
||||
logLevel: "error", esbuild: { jsx: "automatic" },
|
||||
plugins: [{
|
||||
name: "swipe-outlines-fixture",
|
||||
resolveId: id => id === "/__swipe-outlines.tsx" ? id : undefined,
|
||||
load: id => id === "/__swipe-outlines.tsx" ? entry : undefined,
|
||||
configureServer(server) {
|
||||
server.middlewares.use((request, response, next) => {
|
||||
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
|
||||
response.setHeader("Content-Type", "text/html");
|
||||
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__swipe-outlines.tsx"></script></body></html>');
|
||||
});
|
||||
},
|
||||
}],
|
||||
server: { host: "127.0.0.1", port: 0 },
|
||||
});
|
||||
await vite.listen();
|
||||
const browser = await chromium.launch({ headless: true });
|
||||
t.after(() => browser.close());
|
||||
const page = await browser.newPage({ viewport: { width: 600, height: 600 } });
|
||||
const errors = [];
|
||||
page.on("pageerror", error => errors.push(error.message));
|
||||
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
|
||||
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
|
||||
|
||||
const frame = page.locator(".visual-swipe");
|
||||
const before = page.locator(".visual-swipe-outlines.before .visual-change-outline.moved");
|
||||
const after = page.locator(".visual-swipe-outlines.after .visual-change-outline.moved");
|
||||
await expect(before).toHaveCount(1);
|
||||
await expect(after).toHaveCount(1);
|
||||
const [box, beforeBox, afterBox] = await Promise.all([frame.boundingBox(), before.boundingBox(), after.boundingBox()]);
|
||||
assert.ok(Math.abs((afterBox.x - beforeBox.x) - 0.4 * box.width) < 1, "Before's outline is back by the move");
|
||||
// Each side's outlines show only over its own half of the frame.
|
||||
const clips = await page.locator(".visual-swipe-outlines").evaluateAll(spans => spans.map(span => getComputedStyle(span).clipPath));
|
||||
assert.deepEqual(clips.map(clip => clip.startsWith("inset(")), [true, true]);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
@@ -6,6 +6,7 @@ import { join, resolve } from 'node:path';
|
||||
import { parseArgs } from 'node:util';
|
||||
import { parse } from 'yaml';
|
||||
import { assessPublicEvidence, readExportedMap } from '../../dist/review/evidence-assessment.js';
|
||||
import { systemRegions } from '../../dist/contracts/capture.js';
|
||||
import { prepareCaptureReview, readCaptureBundle } from '../../dist/review/capture-review.js';
|
||||
import { parseRuntimeExecutionContext } from '../../dist/review/runtime-adapter.js';
|
||||
import { generateAgentChangeNotes } from '../../dist/capture/agent/change-notes.js';
|
||||
@@ -28,11 +29,13 @@ export async function recompare(runDirectory) {
|
||||
const existing = (await readdir(join(run, 'artifacts'))).filter(name => /^recompare-\d+$/.test(name)).length;
|
||||
const label = `recompare-${existing + 1}`;
|
||||
const sides = { base: await side(join(capture, 'base-export')), head: await side(join(capture, 'head-export')) };
|
||||
const evidence = await assessPublicEvidence({ plan, ...sides, profile: `${config.app.easProfile}:${config.app.bundleId}`,
|
||||
// The run's own device and pose, as its comparison had them: a foldable's rail pill, or the platform's bands.
|
||||
const system = systemRegions({ platform: config.app.platform, device: config.device.name, pose: config.device.pose });
|
||||
const evidence = await assessPublicEvidence({ platform: config.app.platform, systemRegions: system, plan, ...sides, profile: `${config.app.easProfile}:${config.app.bundleId}`,
|
||||
agentDeviceCommand: join(repository, 'node_modules/.bin/agent-device') });
|
||||
const state = { ...previous.commentState };
|
||||
let { review, assets } = await prepareCaptureReview({ plan, pullRequest: state.pullRequest,
|
||||
baseDirectory: sides.base.directory, headDirectory: sides.head.directory, runId: previous.publicReview.runId,
|
||||
baseDirectory: sides.base.directory, headDirectory: sides.head.directory, systemRegions: system, runId: previous.publicReview.runId,
|
||||
runAttempt: previous.publicReview.runAttempt, assertCurrentHead: async () => {}, assessments: evidence.surfaces,
|
||||
app: { ...(state.build?.appVersion ? { version: state.build.appVersion } : {}),
|
||||
...(state.build?.appBuildNumber ? { buildNumber: state.build.appBuildNumber } : {}) } });
|
||||
|
||||
+184
-149
@@ -80,136 +80,121 @@ async function expectAutoHideScrollbar(
|
||||
await expect(scrollbar).toHaveCSS("opacity", "0");
|
||||
}
|
||||
|
||||
async function expectMapScreenSelectionDimming(
|
||||
page: Page,
|
||||
options: { hoverTargetCount?: number } = {},
|
||||
) {
|
||||
const screens = page.locator(
|
||||
".map-canvas .react-flow__node-screen:not(.canvas-node-exit)",
|
||||
);
|
||||
const selected = page.locator(
|
||||
".map-canvas .react-flow__node-screen.selected:not(.canvas-node-exit)",
|
||||
);
|
||||
const dimmed = page.locator(
|
||||
".map-canvas .react-flow__node-screen:not(.selected):not(.canvas-node-exit)",
|
||||
);
|
||||
await expect(page.locator(".map-canvas")).toHaveClass(/screen-selection-active/);
|
||||
await expect(selected).toHaveCount(1);
|
||||
await expect.poll(async () => dimmed.count()).toBe((await screens.count()) - 1);
|
||||
expect(await screens.evaluateAll(nodes => nodes.every(node => getComputedStyle(node).opacity === "1"))).toBe(true);
|
||||
/** The Map's canvas tokens as computed colours, to compare with what a ring or an edge draws. */
|
||||
async function mapCanvasColors(page: Page) {
|
||||
return page.locator(".map-canvas").evaluate((canvas) => {
|
||||
const resolve = (token: string) => {
|
||||
const probe = document.createElement("span");
|
||||
probe.style.color = `var(${token})`;
|
||||
canvas.append(probe);
|
||||
const color = getComputedStyle(probe).color;
|
||||
probe.remove();
|
||||
return color;
|
||||
};
|
||||
return {
|
||||
accent: resolve("--accent"),
|
||||
accentStrong: resolve("--accent-strong"),
|
||||
hoverRing: resolve("--hover-ring"),
|
||||
quiet: resolve("--border-subtle"),
|
||||
hoverEdge: resolve("--tertiary"),
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
await expect.poll(async () => {
|
||||
const [selectedOpacity, dimmedOpacity] = await Promise.all([
|
||||
selected.locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
|
||||
dimmed.first().locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
|
||||
]);
|
||||
return dimmedOpacity < selectedOpacity;
|
||||
}).toBe(true);
|
||||
/** The screenshot frame's box shadow on a Map card: where its ring is drawn. */
|
||||
function mapCardRing(node: Locator) {
|
||||
return node.locator(".screen-node-image :is(img, .image-placeholder)").first()
|
||||
.evaluate((frame) => getComputedStyle(frame).boxShadow);
|
||||
}
|
||||
|
||||
// Selection focus moves the canvas before hover affordances are exercised. Choose hover
|
||||
// targets only after that flight settles so a node cannot move underneath the minimap between
|
||||
// the hit-test below and Playwright's pointer action.
|
||||
await expect(page.locator(".map-canvas.canvas-focus-animating")).toHaveCount(0);
|
||||
|
||||
const hoverableDimmedIndexes = await dimmed.evaluateAll((nodes) => nodes.flatMap((node, index) => {
|
||||
const bounds = node.getBoundingClientRect();
|
||||
const centerTarget = document.elementFromPoint(
|
||||
bounds.left + bounds.width / 2,
|
||||
bounds.top + bounds.height / 2,
|
||||
);
|
||||
const nodeId = node.getAttribute("data-id");
|
||||
const hasDirectEdge = nodeId !== null && [...document.querySelectorAll(".react-flow__edge")]
|
||||
.some((edge) => {
|
||||
const label = edge.getAttribute("aria-label") ?? "";
|
||||
return label.startsWith(`Edge from ${nodeId} to `) || label.endsWith(` to ${nodeId}`);
|
||||
});
|
||||
return centerTarget !== null && node.contains(centerTarget) && hasDirectEdge ? [index] : [];
|
||||
/** Each Map edge's id, ends and drawn stroke. */
|
||||
function mapEdgeStrokes(page: Page) {
|
||||
return page.locator(".map-canvas .react-flow__edge").evaluateAll((edges) => edges.map((edge) => {
|
||||
const match = /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "");
|
||||
const path = getComputedStyle(edge.querySelector(".transition-edge-path")!);
|
||||
return {
|
||||
id: edge.getAttribute("data-id") ?? "",
|
||||
from: match?.[1] ?? "",
|
||||
to: match?.[2] ?? "",
|
||||
stroke: path.stroke,
|
||||
strokeWidth: Number.parseFloat(path.strokeWidth),
|
||||
};
|
||||
}));
|
||||
const hoverTargetCount = options.hoverTargetCount ?? 1;
|
||||
expect(hoverableDimmedIndexes.length).toBeGreaterThanOrEqual(hoverTargetCount);
|
||||
// A card fades through its frame's --map-card-opacity (the node itself stays opaque over the
|
||||
// connectors). The property is not animated, so it reads what hover asks for at once.
|
||||
const cardOpacities = () => screens.evaluateAll((nodes) => Object.fromEntries(nodes.map((node) => [
|
||||
node.getAttribute("data-id") ?? "",
|
||||
getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim(),
|
||||
])));
|
||||
const restingOpacities = await cardOpacities();
|
||||
let lastHoverTarget = dimmed.nth(hoverableDimmedIndexes[0]!);
|
||||
}
|
||||
|
||||
for (const index of hoverableDimmedIndexes.slice(0, hoverTargetCount)) {
|
||||
const hoverTarget = dimmed.nth(index);
|
||||
const hoverTargetId = await hoverTarget.getAttribute("data-id");
|
||||
expect(hoverTargetId).not.toBeNull();
|
||||
await hoverTarget.hover();
|
||||
await expect.poll(() => hoverTarget.locator(":scope > .canvas-active-frame").evaluate(
|
||||
(node) => Number.parseFloat(getComputedStyle(node).opacity),
|
||||
)).toBe(1);
|
||||
await expect(hoverTarget).toHaveCSS("filter", "none");
|
||||
const hoverSubject = page.locator(
|
||||
".map-canvas .react-flow__node-screen.graph-node-hover-subject",
|
||||
);
|
||||
await expect(hoverSubject).toHaveCount(1);
|
||||
await expect(hoverSubject).toHaveAttribute("data-id", hoverTargetId!);
|
||||
const allEdges = page.locator(".map-canvas .react-flow__edge");
|
||||
const directEdgeCount = await allEdges.evaluateAll((edges, nodeId) => edges.filter((edge) => {
|
||||
const label = edge.getAttribute("aria-label") ?? "";
|
||||
return label.startsWith(`Edge from ${nodeId} to `) || label.endsWith(` to ${nodeId}`);
|
||||
}).length, hoverTargetId!);
|
||||
expect(directEdgeCount).toBeGreaterThan(0);
|
||||
// The hovered screen and every screen it shares an edge with are marked related; nothing on
|
||||
// the map recedes while hovering, so the only changes are the subject ring, the incident
|
||||
// edges and the neighbours' frames.
|
||||
const neighbourIds = await allEdges.evaluateAll((edges, nodeId) => {
|
||||
const ids = new Set<string>([nodeId]);
|
||||
for (const edge of edges) {
|
||||
const match = /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "");
|
||||
if (!match) continue;
|
||||
if (match[1] === nodeId) ids.add(match[2]!);
|
||||
if (match[2] === nodeId) ids.add(match[1]!);
|
||||
}
|
||||
return [...ids].sort();
|
||||
}, hoverTargetId!);
|
||||
const brightNodes = page.locator(
|
||||
".map-canvas .react-flow__node-screen.graph-node-hover-related",
|
||||
);
|
||||
await expect.poll(() => brightNodes.evaluateAll((nodes) => (
|
||||
nodes.map((node) => node.getAttribute("data-id") ?? "").sort()
|
||||
))).toEqual(neighbourIds);
|
||||
const unrelated = page.locator(
|
||||
".map-canvas .react-flow__node-screen:not(.graph-node-hover-related):not(.canvas-node-exit)",
|
||||
);
|
||||
const unrelatedIds = await unrelated.evaluateAll((nodes) => nodes.map((node) => node.getAttribute("data-id") ?? ""));
|
||||
expect(unrelatedIds.length).toBeGreaterThan(0);
|
||||
const hoverOpacities = await cardOpacities();
|
||||
expect(unrelatedIds.map((id) => hoverOpacities[id])).toEqual(unrelatedIds.map((id) => restingOpacities[id]));
|
||||
expect(await unrelated.evaluateAll((nodes) => nodes.every((node) => getComputedStyle(node).filter === "none"))).toBe(true);
|
||||
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
|
||||
const activeEdges = page.locator(
|
||||
".map-canvas .react-flow__edge.graph-edge-hover-related",
|
||||
);
|
||||
await expect(activeEdges).toHaveCount(directEdgeCount);
|
||||
const activeEdgeLabels = await activeEdges.evaluateAll((edges) => (
|
||||
edges.map((edge) => edge.getAttribute("aria-label") ?? "")
|
||||
/**
|
||||
* A selected Map screen is ringed in the accent, its route turns accent and its transitions stay
|
||||
* accent while every other transition quiets to a hairline. No card fades. Hovering another card
|
||||
* rings it in grey beside the selection, with no tooltip, and darkens its own transitions;
|
||||
* hovering the selected card keeps its accent ring.
|
||||
*/
|
||||
async function expectMapSelectionRing(page: Page) {
|
||||
const screens = page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)");
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected:not(.canvas-node-exit)");
|
||||
await expect(selected).toHaveCount(1);
|
||||
const selectedId = (await selected.getAttribute("data-id"))!;
|
||||
const colors = await mapCanvasColors(page);
|
||||
await expect.poll(() => mapCardRing(selected)).toContain(colors.accent);
|
||||
await expect(selected.locator(".screen-node-title")).toHaveCSS("color", colors.accentStrong);
|
||||
// Nothing fades: every card and its frame stay at full strength.
|
||||
await expect.poll(() => screens.evaluateAll((nodes) => nodes.every((node) => (
|
||||
getComputedStyle(node).opacity === "1"
|
||||
&& getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).opacity === "1"
|
||||
&& ["", "1"].includes(getComputedStyle(node.querySelector(":scope > .canvas-active-frame")!).getPropertyValue("--map-card-opacity").trim())
|
||||
)))).toBe(true);
|
||||
const unselected = page.locator(".map-canvas .react-flow__node-screen:not(.selected):not(.canvas-node-exit)");
|
||||
expect(await unselected.evaluateAll((nodes, accent) => nodes.every((node) => (
|
||||
!getComputedStyle(node.querySelector(".screen-node-image :is(img, .image-placeholder)")!).boxShadow.includes(accent)
|
||||
)), colors.accent)).toBe(true);
|
||||
// The selection's transitions are accent and a little heavier; every other one is a hairline.
|
||||
const edges = await mapEdgeStrokes(page);
|
||||
const incident = edges.filter((edge) => edge.from === selectedId || edge.to === selectedId);
|
||||
const others = edges.filter((edge) => edge.from !== selectedId && edge.to !== selectedId);
|
||||
expect(incident.length).toBeGreaterThan(0);
|
||||
expect(others.length).toBeGreaterThan(0);
|
||||
expect(incident.every((edge) => edge.stroke === colors.accent && edge.strokeWidth === 2.5)).toBe(true);
|
||||
expect(others.every((edge) => edge.stroke === colors.quiet && edge.strokeWidth === 1)).toBe(true);
|
||||
await expect(page.locator(".map-canvas .react-flow__edge.graph-edge-quiet")).toHaveCount(others.length);
|
||||
|
||||
// Hover a card that shares no edge with the selection but has edges of its own.
|
||||
await expect(page.locator(".map-canvas.canvas-focus-animating")).toHaveCount(0);
|
||||
const neighbours = new Set(incident.flatMap((edge) => [edge.from, edge.to]));
|
||||
const hoverId = await unselected.evaluateAll((nodes, excluded) => nodes.find((node) => {
|
||||
const id = node.getAttribute("data-id") ?? "";
|
||||
const target = node.querySelector(".screen-screenshot-target")!.getBoundingClientRect();
|
||||
const hit = document.elementFromPoint(target.left + target.width / 2, target.top + target.height / 3);
|
||||
const linked = [...document.querySelectorAll(".map-canvas .react-flow__edge")].some((edge) => (
|
||||
(edge.getAttribute("aria-label") ?? "").split(/ (?:from|to) /).slice(1).includes(id)
|
||||
));
|
||||
expect(activeEdgeLabels.every((label) => (
|
||||
label.startsWith(`Edge from ${hoverTargetId} to `)
|
||||
|| label.endsWith(` to ${hoverTargetId}`)
|
||||
))).toBe(true);
|
||||
lastHoverTarget = hoverTarget;
|
||||
if (index !== hoverableDimmedIndexes.slice(0, hoverTargetCount).at(-1)) {
|
||||
await page.mouse.move(1, 1);
|
||||
await page.waitForTimeout(160);
|
||||
}
|
||||
return !excluded.includes(id) && linked && hit !== null && node.contains(hit);
|
||||
})?.getAttribute("data-id"), [...neighbours]);
|
||||
expect(hoverId).toBeTruthy();
|
||||
const hovered = page.locator(`.map-canvas .react-flow__node-screen[data-id="${hoverId}"]`);
|
||||
const target = hovered.locator(".screen-screenshot-target");
|
||||
const box = (await target.boundingBox())!;
|
||||
await target.hover({ position: { x: box.width / 2, y: box.height / 3 } });
|
||||
await expect(hovered).toHaveClass(/graph-node-hover-subject/);
|
||||
await expect.poll(() => mapCardRing(hovered)).toContain(colors.hoverRing);
|
||||
await expect.poll(() => mapCardRing(selected)).toContain(colors.accent);
|
||||
// Past the tooltip delay, nothing says Open in Inspector.
|
||||
await page.waitForTimeout(600);
|
||||
await expect(page.locator(".tooltip")).toHaveCount(0);
|
||||
// The hovered card's transitions darken to grey; the selection's stay accent; the rest stay quiet.
|
||||
const hovering = await mapEdgeStrokes(page);
|
||||
for (const edge of hovering) {
|
||||
if (edge.from === selectedId || edge.to === selectedId) expect(edge.stroke, edge.id).toBe(colors.accent);
|
||||
else if (edge.from === hoverId || edge.to === hoverId) expect(edge.stroke, edge.id).toBe(colors.hoverEdge);
|
||||
else expect(edge.stroke, edge.id).toBe(colors.quiet);
|
||||
}
|
||||
|
||||
// Hovering the selected card keeps its accent ring.
|
||||
const selectedTarget = selected.locator(".screen-screenshot-target");
|
||||
const selectedBox = (await selectedTarget.boundingBox())!;
|
||||
await selectedTarget.hover({ position: { x: selectedBox.width / 2, y: selectedBox.height / 3 } });
|
||||
await expect(selected).toHaveClass(/graph-node-hover-subject/);
|
||||
await expect.poll(() => mapCardRing(selected)).toContain(colors.accent);
|
||||
expect(await mapCardRing(selected)).not.toContain(colors.hoverRing);
|
||||
await expect.poll(() => mapCardRing(hovered)).not.toContain(colors.hoverRing);
|
||||
await page.mouse.move(1, 1);
|
||||
await expect.poll(async () => {
|
||||
const [selectedOpacity, dimmedOpacity] = await Promise.all([
|
||||
selected.locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
|
||||
lastHoverTarget.locator(":scope > .canvas-active-frame").evaluate((node) => Number.parseFloat(getComputedStyle(node).opacity)),
|
||||
]);
|
||||
return dimmedOpacity < selectedOpacity;
|
||||
}).toBe(true);
|
||||
}
|
||||
|
||||
/** The camera chrome's theme button steps Auto → Dark → Light; press it until the page shows the option. */
|
||||
@@ -1529,6 +1514,59 @@ test("Esc closes the Inspector first, then deselects; arrows and hjkl walk the m
|
||||
await expect(selected).toHaveAttribute("data-id", child!);
|
||||
});
|
||||
|
||||
test("Return after the arrow keys opens the screen they reached, not the one clicked before, on the Map and on Screens", async ({ page }) => {
|
||||
await serveSyntheticWorkspace(page);
|
||||
const inspector = page.getByRole("complementary", { name: "Inspector panel" });
|
||||
const accent = await page.evaluate(() => {
|
||||
const probe = document.createElement("span");
|
||||
probe.style.color = "#0588f0";
|
||||
document.body.append(probe);
|
||||
const color = getComputedStyle(probe).color;
|
||||
probe.remove();
|
||||
return color;
|
||||
});
|
||||
|
||||
// Map: the click leaves the keyboard focus on the first screen's button; Return must not press it.
|
||||
await page.goto("/map?screen=area-0-screen-1");
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
|
||||
await expect(selected).toHaveAttribute("data-id", "area-0-screen-1");
|
||||
await expectMapCameraAtRest(page);
|
||||
await selected.locator(".screen-screenshot-target").click();
|
||||
await expect(inspector).toBeVisible();
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(inspector).toBeHidden();
|
||||
await page.keyboard.press("ArrowDown");
|
||||
await expect(selected).not.toHaveAttribute("data-id", "area-0-screen-1");
|
||||
const reached = (await selected.getAttribute("data-id"))!;
|
||||
// The ring went with the selection.
|
||||
const ring = (id: string) => page.locator(`.map-canvas .react-flow__node-screen[data-id="${id}"] .screen-node-image img`)
|
||||
.evaluate((image) => getComputedStyle(image).boxShadow);
|
||||
await expect.poll(() => ring(reached)).toContain(accent);
|
||||
await expect.poll(() => ring("area-0-screen-1")).not.toContain(accent);
|
||||
const reachedPath = (await selected.locator(".screen-node-title").textContent())!;
|
||||
await page.keyboard.press("Enter");
|
||||
await expect(inspector).toBeVisible();
|
||||
await expect(selected).toHaveAttribute("data-id", reached);
|
||||
await expect(page).toHaveURL(new RegExp(`screen=${reached}`));
|
||||
await expect(inspector).toContainText(reachedPath);
|
||||
|
||||
// Screens: the same walk, from a clicked card.
|
||||
await chooseCanvasView(page, "Screens");
|
||||
const grid = page.getByRole("main", { name: "Screens" });
|
||||
await grid.getByRole("button", { name: /^All/ }).click();
|
||||
const ids = await grid.locator(".screens-grid .screens-cell")
|
||||
.evaluateAll((elements) => elements.map((element) => element.getAttribute("data-screen-id")!));
|
||||
await grid.locator(`.screens-cell[data-screen-id="${ids[0]}"] .screen-screenshot-target`).click();
|
||||
await expect(inspector).toBeVisible();
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(inspector).toBeHidden();
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(grid.locator(`.screens-cell[data-screen-id="${ids[1]}"] .screen-screenshot-card`)).toHaveClass(/selected/);
|
||||
await page.keyboard.press("Enter");
|
||||
await expect(inspector).toBeVisible();
|
||||
await expect(page).toHaveURL(new RegExp(`screen=${ids[1]}`));
|
||||
});
|
||||
|
||||
test("a held key stops when Esc, another key or a dialog takes the keyboard; a menu keeps its own arrows", async ({ page }) => {
|
||||
await page.goto("/map");
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
|
||||
@@ -1955,7 +1993,7 @@ test("fits the visible Map screenshot frame to the capture's intrinsic ratio", a
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
|
||||
const image = selected.locator(".screen-node-image img");
|
||||
await expect(image).toBeVisible();
|
||||
await expectMapScreenSelectionDimming(page);
|
||||
await expectMapSelectionRing(page);
|
||||
const pathStyle = await selected.locator(".screen-node-title").evaluate((element) => {
|
||||
const style = getComputedStyle(element);
|
||||
const bounds = element.getBoundingClientRect();
|
||||
@@ -2042,13 +2080,18 @@ async function hoverableMapScreen(candidates: Locator, room = 80) {
|
||||
return candidates.nth(index);
|
||||
}
|
||||
|
||||
test("hovering a Map screen fades nothing and says Open in Inspector in a tooltip below the card that keeps to it", async ({ page }) => {
|
||||
test("hovering a Map screen fades nothing, rings it in grey, darkens its transitions and shows no tooltip", async ({ page }) => {
|
||||
await serveSyntheticWorkspace(page);
|
||||
await page.goto("/map");
|
||||
const screens = page.locator(".map-canvas .react-flow__node-screen:not(.canvas-node-exit)");
|
||||
await expect(screens.first()).toBeVisible();
|
||||
await expectMapCameraAtRest(page);
|
||||
const colors = await mapCanvasColors(page);
|
||||
const resting = await mapCardOpacities(page);
|
||||
// With nothing selected no transition is quiet: they keep their own colours.
|
||||
await expect(page.locator(".map-canvas .react-flow__edge.graph-edge-quiet")).toHaveCount(0);
|
||||
const restingEdges = await mapEdgeStrokes(page);
|
||||
expect(restingEdges.some((edge) => edge.stroke === colors.quiet)).toBe(false);
|
||||
// A screen at one end of a secondary transition, which rests a little faded.
|
||||
const secondaryEnds = await page.locator(".map-canvas .react-flow__edge.graph-edge-secondary").evaluateAll((edges) => (
|
||||
[...new Set(edges.flatMap((edge) => /^Edge from (.+) to (.+)$/.exec(edge.getAttribute("aria-label") ?? "")?.slice(1) ?? []))]
|
||||
@@ -2057,42 +2100,34 @@ test("hovering a Map screen fades nothing and says Open in Inspector in a toolti
|
||||
const node = await hoverableMapScreen(page.locator(
|
||||
secondaryEnds.map((id) => `.map-canvas .react-flow__node-screen[data-id="${id}"]`).join(", "),
|
||||
));
|
||||
const id = (await node.getAttribute("data-id"))!;
|
||||
const target = node.locator(".screen-screenshot-target");
|
||||
const heading = node.locator(".screen-node-heading");
|
||||
// The tooltip says what a click does; no native title tooltip joins it.
|
||||
// No native title tooltip either; the heading names the screen.
|
||||
await expect(target).not.toHaveAttribute("title");
|
||||
// Near the card's top, so the pan below keeps the pointer on it.
|
||||
const box = (await target.boundingBox())!;
|
||||
await target.hover({ position: { x: box.width / 2, y: box.height / 4 } });
|
||||
await expect(page.locator(".connection-canvas-surface.canvas-hovering")).toHaveCount(1);
|
||||
const tooltip = page.locator(".tooltip", { hasText: "Open in Inspector" });
|
||||
await expect(tooltip).toBeVisible();
|
||||
await expect.poll(() => mapCardRing(node)).toContain(colors.hoverRing);
|
||||
expect(await mapCardRing(node)).not.toContain(colors.accent);
|
||||
// Past the tooltip delay, nothing covers or labels the card.
|
||||
await page.waitForTimeout(600);
|
||||
await expect(page.locator(".tooltip")).toHaveCount(0);
|
||||
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
|
||||
const related = await page.locator(".map-canvas .react-flow__node-screen.graph-node-hover-related")
|
||||
.evaluateAll((nodes) => nodes.map((element) => element.getAttribute("data-id") ?? ""));
|
||||
const unrelated = Object.keys(resting).filter((id) => !related.includes(id));
|
||||
const unrelated = Object.keys(resting).filter((other) => !related.includes(other));
|
||||
expect(unrelated.length).toBeGreaterThan(0);
|
||||
const hovering = await mapCardOpacities(page);
|
||||
expect(unrelated.map((id) => hovering[id])).toEqual(unrelated.map((id) => resting[id]));
|
||||
await expect(page.locator(".map-canvas .screen-open-hint:visible")).toHaveCount(0);
|
||||
// The transitions into and out of it come fully up, the secondary one too.
|
||||
expect(unrelated.map((other) => hovering[other])).toEqual(unrelated.map((other) => resting[other]));
|
||||
// The transitions into and out of it come fully up in a darker grey, the secondary one too; the rest stay as they were.
|
||||
const incident = page.locator(".map-canvas .react-flow__edge.graph-edge-hover-related");
|
||||
await expect(incident.and(page.locator(".graph-edge-secondary"))).not.toHaveCount(0);
|
||||
await expect.poll(() => incident.evaluateAll((edges) => edges.every((edge) => getComputedStyle(edge).opacity === "1"))).toBe(true);
|
||||
// The route heads a Map card, so the bubble sits below the screenshot, clear of both.
|
||||
const clearance = async () => {
|
||||
const [bubble, card, title] = await Promise.all([tooltip.boundingBox(), target.boundingBox(), heading.boundingBox()]);
|
||||
if (!bubble || !card || !title) return Number.NaN;
|
||||
const headingOverlap = bubble.y < title.y + title.height && title.y < bubble.y + bubble.height
|
||||
&& bubble.x < title.x + title.width && title.x < bubble.x + bubble.width;
|
||||
return headingOverlap ? -1 : bubble.y - (card.y + card.height);
|
||||
};
|
||||
expect(await clearance()).toBeGreaterThan(0);
|
||||
// Panning with the pointer still on the card moves the card by transform; the bubble follows it
|
||||
// rather than staying behind over the screenshot.
|
||||
const before = await target.boundingBox();
|
||||
await page.mouse.wheel(0, 40);
|
||||
await expect.poll(async () => (await target.boundingBox())!.y).toBeLessThan(before!.y - 10);
|
||||
await expect.poll(clearance).toBeGreaterThan(0);
|
||||
const hoverEdges = await mapEdgeStrokes(page);
|
||||
for (const edge of hoverEdges) {
|
||||
if (edge.from === id || edge.to === id) expect(edge.stroke, edge.id).toBe(colors.hoverEdge);
|
||||
else expect(edge.stroke, edge.id).toBe(restingEdges.find((resting) => resting.id === edge.id)!.stroke);
|
||||
}
|
||||
});
|
||||
|
||||
test("hovering a Map screen the Changes filter muted brings it and its neighbours back up, and nothing else", async ({ page }) => {
|
||||
|
||||
@@ -54,7 +54,7 @@ export async function readUsage(output) {
|
||||
|
||||
export async function fixture(t, provider, { docsOnly = false, unresolvedParameters = false, observerFailurePath, agentMode = false,
|
||||
instructions = 'Explore selected routes in a stable, comparable state.', recoverableOpenFailure = false,
|
||||
userInterfaceStyle, headUserInterfaceStyle, platform: initialPlatform = 'ios', targets } = {}) {
|
||||
userInterfaceStyle, headUserInterfaceStyle, platform: initialPlatform = 'ios', targets, maxSessions } = {}) {
|
||||
let platform = initialPlatform;
|
||||
const root = await realpath(await mkdtemp(join(tmpdir(), 'explore-ci-integration-')));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
@@ -67,7 +67,7 @@ export async function fixture(t, provider, { docsOnly = false, unresolvedParamet
|
||||
const commit = message => { git(headProject, 'add', '.'); git(headProject, 'commit', '-m', message); return git(headProject, 'rev-parse', 'HEAD'); };
|
||||
const config = { mode: 'deterministic', app: { name: 'Example', platform, bundleId: 'com.example.app', easProfile: 'capture', scheme: 'sample' },
|
||||
device: { name: 'iPhone 17 Pro' }, navigation: { provider, ...(provider === 'react-navigation' ? { entry: 'src/App.tsx' } : {}) },
|
||||
exploration: { scope: 'changes' }, capture: { maxMinutes: 30, maxActions: 500, repack: 'eas' },
|
||||
exploration: { scope: 'changes' }, capture: { maxMinutes: 30, maxActions: 500, repack: 'eas', ...(maxSessions ? { maxSessions } : {}) },
|
||||
parameters: provider === 'expo-router' && !unresolvedParameters ? { '/item/[id]': { id: 'example-item' } } : {} };
|
||||
if (targets) config.targets = targets;
|
||||
if (agentMode) { config.mode = 'agent'; config.agent = { provider: 'anthropic', model: 'fixture-model', instructions: '.expo-explore/instructions.md' }; }
|
||||
|
||||
@@ -138,9 +138,10 @@ test("baseline captures a complete single default-branch commit without a PR", (
|
||||
const job = baseline.jobs.baseline;
|
||||
assert.match(baseline.jobs.targets.if, /github\.event\.repository\.default_branch/);
|
||||
assert.deepEqual(job.needs, "targets");
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, "max-parallel": "${{ fromJSON(needs.targets.outputs.max_parallel) }}",
|
||||
matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
assert.equal(job.env.TARGET, "${{ matrix.target }}");
|
||||
assert.match(baseline.jobs.targets.steps.at(-1).run, /config:targets .* \| jq -c '\[\.targets\[\]\.id\]'/);
|
||||
assert.match(baseline.jobs.targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app\/\$APP_PROJECT_DIR"/);
|
||||
const verify = job.steps.find(step => step.name === "Verify deterministic source planning");
|
||||
assert.match(verify.run, /--base-sha "\$GITHUB_SHA" --head-sha "\$GITHUB_SHA" --scope all/);
|
||||
const capture = job.steps.find(step => step.name === "Capture complete single-commit baseline");
|
||||
@@ -325,16 +326,21 @@ test("review captures and reports each configured target in its own matrix job,
|
||||
assert.deepEqual(targets.permissions, { contents: "read", "pull-requests": "read" });
|
||||
assert.equal(targets.outputs.targets, "${{ steps.targets.outputs.targets }}");
|
||||
// config:targets lists ids in config order; a config without targets: lists ["ios"] / ["ios","android"], as config:platforms did.
|
||||
assert.match(targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app-head\/\$APP_PROJECT_DIR" --config \.expo-explore\/config\.yaml \| jq -c '\[\.targets\[\]\.id\]'/);
|
||||
assert.match(targets.steps.at(-1).run, /config:targets --project "\$GITHUB_WORKSPACE\/app-head\/\$APP_PROJECT_DIR" --config \.expo-explore\/config\.yaml/);
|
||||
assert.equal(targets.outputs.max_parallel, "${{ steps.targets.outputs.max_parallel }}");
|
||||
assert.doesNotMatch(JSON.stringify(targets), /EXPO_TOKEN|OPENAI_API_KEY|ANTHROPIC_API_KEY|APP_REVIEW/);
|
||||
for (const workflow of [review, compare, baseline]) {
|
||||
assert.doesNotMatch(JSON.stringify(workflow), /matrix\.platform|config:platforms|\$PLATFORM|needs\.platforms/, "every job is keyed by target, never by platform");
|
||||
assert.match(JSON.stringify(workflow), /matrix\.target/, "doctor looks for matrix.target in an installed workflow");
|
||||
}
|
||||
for (const job of [review.jobs.capture, review.jobs.report]) {
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
// Each capture job needs a simulator session, so at most capture.maxSessions of them run at once; a report needs none.
|
||||
for (const job of [review.jobs.capture, compare.jobs.capture]) {
|
||||
assert.deepEqual(job.strategy, { "fail-fast": false, "max-parallel": "${{ fromJSON(needs.targets.outputs.max_parallel) }}",
|
||||
matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
assert.equal(job.env.TARGET, "${{ matrix.target }}");
|
||||
}
|
||||
assert.deepEqual(review.jobs.report.strategy, { "fail-fast": false, matrix: { target: "${{ fromJSON(needs.targets.outputs.targets) }}" } });
|
||||
assert.equal(review.jobs.report.env.TARGET, "${{ matrix.target }}");
|
||||
assert.equal(review.jobs.capture.needs, "targets");
|
||||
assert.deepEqual(review.jobs.report.needs, ["targets", "capture"]);
|
||||
const runs = [review.jobs.capture, review.jobs.report, baseline.jobs.baseline].flatMap(job => job.steps.filter(step => step.run).map(step => step.run));
|
||||
@@ -378,3 +384,27 @@ test("compare reviews any two refs from a manual run or another workflow, with n
|
||||
assert.match(compare.jobs.capture.steps.find(step => step.id === "capture").run, /printf '%s' "\$COMPARE" > "\$RUNNER_TEMP\/explore-compare\.json"/);
|
||||
assert.match(compare.jobs.deploy.steps.at(-1).run, /ci:deploy --inputs/);
|
||||
});
|
||||
|
||||
test("the targets job lists the target ids and how many capture jobs run at once: no more than capture.maxSessions", async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-targets-step-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const tools = new URL("../..", import.meta.url).pathname;
|
||||
const run = async (workflow, checkout, config) => {
|
||||
const project = join(root, checkout); await mkdir(join(project, ".expo-explore"), { recursive: true });
|
||||
await writeFile(join(project, ".expo-explore", "config.yaml"), config);
|
||||
const output = join(root, "output"); await writeFile(output, "");
|
||||
const step = workflow.jobs.targets.steps.find(entry => entry.id === "targets");
|
||||
const result = spawnSync("bash", ["-c", step.run], { encoding: "utf8",
|
||||
env: { PATH: process.env.PATH, HOME: root, TOOLS: tools, GITHUB_WORKSPACE: root, APP_PROJECT_DIR: ".", GITHUB_OUTPUT: output } });
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
const outputs = Object.fromEntries((await readFile(output, "utf8")).trim().split("\n").map(line => line.split(/=(.*)/s).slice(0, 2)));
|
||||
return { targets: JSON.parse(outputs.targets), maxParallel: JSON.parse(outputs.max_parallel) };
|
||||
};
|
||||
const app = "app:\n bundleId: com.example.app\n easProfile: explore\ndevice:\n name: iPhone 17\n";
|
||||
const five = "targets:\n" + ["iphone", "ipad", "duo-closed", "duo-open"].map(id => ` ${id}: { platform: ios }\n`).join("") + " pixel: { platform: android, bundleId: com.example.app, easProfile: explore }\n";
|
||||
for (const [workflow, checkout] of [[review, "app-head"], [compare, "app-head"], [baseline, "app"]]) {
|
||||
assert.deepEqual(await run(workflow, checkout, app + five), { targets: ["iphone", "ipad", "duo-closed", "duo-open", "pixel"], maxParallel: 5 }, "unset: five");
|
||||
assert.deepEqual((await run(workflow, checkout, app + "capture:\n maxSessions: 2\n" + five)).maxParallel, 2, "a starter plan's two");
|
||||
assert.deepEqual(await run(workflow, checkout, app), { targets: ["ios"], maxParallel: 1 });
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,135 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
|
||||
import { startArgentBridgeRunner } from "../../dist/capture/argent-bridge-host.js";
|
||||
import { ARGENT_VERSION } from "../../dist/shared/argent-version.js";
|
||||
|
||||
const PNG = Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "base64");
|
||||
|
||||
async function fakeClient(root, body) {
|
||||
const module = join(root, "client.mjs");
|
||||
await writeFile(module, `const calls = [];\nexport function createArgentClient() { return { calls, async callTool(name, args, options) { calls.push({ name, args }); ${body} } }; }\n`);
|
||||
return module;
|
||||
}
|
||||
|
||||
test("the bridge thread answers the capture's commands through Argent's client and falls back for other executables", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
await writeFile(join(root, "shot.png"), PNG);
|
||||
const clientModule = await fakeClient(root, `
|
||||
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
|
||||
if (name === "screenshot") return { data: { path: ${JSON.stringify(join(root, "shot.png"))} } };
|
||||
if (name === "await-screen-idle") { if (options?.signal?.aborted) throw options.signal.reason; await new Promise((resolve, reject) => { const timer = setTimeout(resolve, 5_000); options?.signal?.addEventListener("abort", () => { clearTimeout(timer); reject(options.signal.reason); }); }); return { data: { idle: true } }; }
|
||||
throw new Error("unexpected tool " + name);`);
|
||||
const fallbackCalls = [];
|
||||
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, fallback: request => { fallbackCalls.push(request.args[0]); return { stdout: "{}", stderr: "" }; } });
|
||||
t.after(() => bridge.close());
|
||||
const request = args => ({ command: "/opt/argent-controller", args, cwd: root, environment, timeoutMs: 20_000 });
|
||||
|
||||
const version = bridge.runner(request(["--version"]));
|
||||
assert.equal(version.stdout.trim(), ARGENT_VERSION);
|
||||
const shot = JSON.parse(bridge.runner(request(["screenshot", join(root, "out", "screen.png"), "--session", "explore", "--platform", "ios", "--json"])).stdout);
|
||||
assert.equal(shot.success, true);
|
||||
assert.deepEqual(await readFile(join(root, "out", "screen.png")), PNG, "the materialized artifact is copied where the command asked");
|
||||
assert.ok(bridge.active);
|
||||
|
||||
bridge.runner({ command: "/usr/bin/other", args: ["noop"], cwd: root, environment });
|
||||
assert.deepEqual(fallbackCalls, ["noop"], "other executables go to the fallback runner");
|
||||
|
||||
const started = Date.now();
|
||||
assert.throws(() => bridge.runner({ ...request(["wait", "stable", "500", "8000", "--session", "explore", "--platform", "ios", "--json"]), timeoutMs: 300 }), /timed out after 300 ms/);
|
||||
assert.ok(Date.now() - started < 5_000, "a timed-out command is aborted, not waited out");
|
||||
assert.ok(bridge.active, "the thread answered the abort, so it keeps serving");
|
||||
assert.equal(bridge.runner(request(["--version"])).stdout.trim(), ARGENT_VERSION);
|
||||
});
|
||||
|
||||
test("a thread whose Argent client cannot load hands every command to the fallback runner", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const fallbackCalls = [];
|
||||
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: join(root, "missing.mjs"), fallback: request => { fallbackCalls.push(request.args[0]); return { stdout: "{}", stderr: "" }; } });
|
||||
t.after(() => bridge.close());
|
||||
bridge.runner({ command: "/opt/argent-controller", args: ["snapshot", "--json"], cwd: root, environment, timeoutMs: 20_000 });
|
||||
bridge.runner({ command: "/opt/argent-controller", args: ["screenshot", "x.png", "--json"], cwd: root, environment, timeoutMs: 20_000 });
|
||||
assert.deepEqual(fallbackCalls, ["snapshot", "screenshot"]);
|
||||
assert.equal(bridge.active, false);
|
||||
});
|
||||
|
||||
test("a session whose tool-server was replaced is driven at the new one: the thread starts again with the changed environment", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
await writeFile(join(root, "shot.png"), PNG);
|
||||
// The fake client notes which tool-server it was given, as Argent's reads ARGENT_TOOLS_URL from its environment.
|
||||
const clientModule = await fakeClient(root, `
|
||||
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
|
||||
if (name === "screenshot") { (await import("node:fs")).appendFileSync(${JSON.stringify(join(root, "servers.txt"))}, process.env.ARGENT_TOOLS_URL + "\\n"); return { data: { path: ${JSON.stringify(join(root, "shot.png"))} } }; }
|
||||
throw new Error("unexpected tool " + name);`);
|
||||
const environment = { EXPLORE_ARGENT_STATE: join(root, "state.json"), EXPLORE_ARGENT_PLATFORM: "ios", ARGENT_TOOLS_URL: "http://127.0.0.1:9/old", HOME: root, PATH: process.env.PATH };
|
||||
const bridge = startArgentBridgeRunner({ command: "/opt/argent-controller", environment, clientModule, fallback: () => assert.fail("the thread serves every command") });
|
||||
t.after(() => bridge.close());
|
||||
const screenshot = () => JSON.parse(bridge.runner({ command: "/opt/argent-controller", args: ["screenshot", join(root, "out", "screen.png"), "--session", "explore", "--platform", "ios", "--json"],
|
||||
cwd: root, environment, timeoutMs: 20_000 }).stdout);
|
||||
assert.equal(screenshot().success, true);
|
||||
// As the capture's local recovery does: the same environment object, pointed at the restarted tool-server.
|
||||
Object.assign(environment, { ARGENT_TOOLS_URL: "http://127.0.0.1:9/new", ARGENT_AUTH_TOKEN: "new-token" });
|
||||
assert.equal(screenshot().success, true);
|
||||
assert.deepEqual((await readFile(join(root, "servers.txt"), "utf8")).trim().split("\n"), ["http://127.0.0.1:9/old", "http://127.0.0.1:9/new"]);
|
||||
assert.ok(bridge.active);
|
||||
});
|
||||
|
||||
test("a thread that crashes stops serving, and the commands after it run per command", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
await writeFile(join(root, "shot.png"), PNG);
|
||||
// An exception nothing catches, thrown on the thread well after its answer.
|
||||
const clientModule = await fakeClient(root, `
|
||||
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
|
||||
if (name === "screenshot") { setTimeout(() => { throw new Error("the client crashed"); }, 300); return { data: { path: ${JSON.stringify(join(root, "shot.png"))} } }; }
|
||||
throw new Error("unexpected tool " + name);`);
|
||||
const fallbackCalls = [], 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: request => { fallbackCalls.push(request.args[0]); return { stdout: "{}", stderr: "" }; } });
|
||||
t.after(() => bridge.close());
|
||||
const request = args => ({ command: "/opt/argent-controller", args, cwd: root, environment, timeoutMs: 20_000 });
|
||||
assert.equal(JSON.parse(bridge.runner(request(["screenshot", join(root, "out", "screen.png"), "--session", "explore", "--platform", "ios", "--json"])).stdout).success, true);
|
||||
await new Promise(resolve => setTimeout(resolve, 1_500));
|
||||
assert.equal(bridge.active, false);
|
||||
assert.match(messages.join("\n"), /the Argent bridge thread failed \(the client crashed\)/);
|
||||
bridge.runner(request(["snapshot", "--json"]));
|
||||
assert.deepEqual(fallbackCalls, ["snapshot"]);
|
||||
});
|
||||
|
||||
test("a recording runs per command, and a screenshot is taken only from a file that is an image", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-argent-bridge-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
await writeFile(join(root, "shot.png"), PNG);
|
||||
await writeFile(join(root, "notes.txt"), "not a screenshot\n");
|
||||
const answer = join(root, "answer.json");
|
||||
const clientModule = await fakeClient(root, `
|
||||
if (name === "list-devices") return { data: { devices: [{ udid: "UDID-1", name: "iPhone 17", state: "Booted", platform: "ios", runtime: "iOS 26.0" }] } };
|
||||
if (name === "screenshot") return { data: JSON.parse((await import("node:fs")).readFileSync(${JSON.stringify(answer)}, "utf8")) };
|
||||
throw new Error("unexpected tool " + name);`);
|
||||
const fallbackCalls = [];
|
||||
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,
|
||||
fallback: request => { fallbackCalls.push(request.args.slice(0, 2).join(" ")); return { stdout: "{}", stderr: "" }; } });
|
||||
t.after(() => bridge.close());
|
||||
const request = args => ({ command: "/opt/argent-controller", args, cwd: root, environment, timeoutMs: 20_000 });
|
||||
|
||||
bridge.runner(request(["record", "start", join(root, "launch.mp4"), "--scope", "app", "--json"]));
|
||||
bridge.runner(request(["record", "stop", "--json"]));
|
||||
assert.deepEqual(fallbackCalls, ["record start", "record stop"], "recordings go to the per-command bridge");
|
||||
assert.ok(bridge.active);
|
||||
|
||||
const screenshot = out => JSON.parse(bridge.runner({ ...request(["screenshot", out, "--session", "explore", "--platform", "ios", "--json"]), allowFailure: true }).stdout);
|
||||
// A path to a file that is not an image is not a screenshot, whatever its key; the image beside it is.
|
||||
await writeFile(answer, JSON.stringify({ path: join(root, "notes.txt"), image: join(root, "shot.png") }));
|
||||
assert.equal(screenshot(join(root, "out", "one.png")).success, true);
|
||||
assert.deepEqual(await readFile(join(root, "out", "one.png")), PNG);
|
||||
await writeFile(answer, JSON.stringify({ path: join(root, "notes.txt") }));
|
||||
const failed = screenshot(join(root, "out", "two.png"));
|
||||
assert.equal(failed.success, false);
|
||||
assert.match(failed.error.message, /did not write/);
|
||||
await assert.rejects(readFile(join(root, "out", "two.png")), { code: "ENOENT" });
|
||||
});
|
||||
@@ -94,6 +94,31 @@ test("reviewed build diff preserves exact cross-build evidence and split/merge s
|
||||
);
|
||||
});
|
||||
|
||||
test("a screen diff carries the compared screenshot's recorded shape, After's first", async () => {
|
||||
const fixture = await createBuildWorkspaceFixture();
|
||||
const currentBuild = fixture.catalog.builds.find((build) => build.id === "build-2.0.0");
|
||||
const baselineBuild = fixture.catalog.builds.find((build) => build.id === "build-1.0.0");
|
||||
const artifact = (map, id) => map.artifacts.find((entry) => entry.id === `artifact-observation-${id}`);
|
||||
// The reviewed After turned landscape; Before stays portrait.
|
||||
Object.assign(artifact(fixture.currentMap, "build-2.0.0-current-profile-reviewed"), { width: 60, height: 30 });
|
||||
// A capture without a recorded size (not a PNG) gives the frame nothing to take.
|
||||
const added = artifact(fixture.currentMap, "build-2.0.0-current-added-primary");
|
||||
delete added.width;
|
||||
delete added.height;
|
||||
|
||||
const diff = diffModel.buildDiff({
|
||||
currentBuild,
|
||||
currentMap: fixture.currentMap,
|
||||
baselineBuild,
|
||||
baselineMap: fixture.baselineMap,
|
||||
comparison: fixture.comparison,
|
||||
});
|
||||
|
||||
assert.equal(diff.screens.get("current-profile")?.screenshotAspect, 2);
|
||||
assert.equal(diff.screens.get(removedScreenId("build-1.0.0", "baseline-legacy"))?.screenshotAspect, 0.5);
|
||||
assert.equal(diff.screens.get("current-added")?.screenshotAspect, undefined);
|
||||
});
|
||||
|
||||
test("catalog route context contains only the two real builds", async () => {
|
||||
const fixture = await createBuildWorkspaceFixture();
|
||||
assert.deepEqual(diffModel.routeContextForCatalog(fixture.catalog), {
|
||||
|
||||
@@ -135,6 +135,9 @@ test("capture recipes exclude display settings but bind agent instructions and c
|
||||
assert.equal(JSON.parse(key).observer, CAPTURE_OBSERVER_HASH);
|
||||
assert.match(JSON.parse(key).observer, /^[a-f0-9]{64}$/);
|
||||
assert.equal(key,captureRecipeConfig({...config,app:{...config.app,name:"Renamed display"}}));
|
||||
// How many sessions capture it does not change the evidence: a baseline captured under any ceiling serves the review.
|
||||
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,maxSessions:16}}));
|
||||
assert.equal(captureRecipeConfig({...config,capture:{...config.capture,maxSessions:4}}),captureRecipeConfig({...config,capture:{...config.capture,maxSessions:16}}));
|
||||
// An unset repack is keyed as it resolves, so configs that never chose one keep the recipe of the old written-out default.
|
||||
assert.equal(key,captureRecipeConfig({...config,capture:{...config.capture,repack:"eas"}}));
|
||||
assert.equal(JSON.parse(key).capture.repack, "eas");
|
||||
|
||||
@@ -14,7 +14,10 @@ import { AGENT_DEVICE_VERSION, captureDeepLink, controllerCommandFailure, revisi
|
||||
import { CiError, serializeCiError } from '../../dist/shared/ci-errors.js';
|
||||
import { createSourceCapturePlan } from '../../dist/source/capture-plan.js';
|
||||
import { CAPTURE_OBSERVER_IDENTIFIER } from '../../dist/capture/observer.js';
|
||||
import { parseRuntimeExecutionContext } from '../../dist/review/runtime-adapter.js';
|
||||
import { parseRuntimeExecutionContext, runtimeEvidenceInputFromMap } from '../../dist/review/runtime-adapter.js';
|
||||
import { readExportedMap } from '../../dist/review/evidence-assessment.js';
|
||||
import { projectRuntimeEvidence } from '../../dist/review/runtime-evidence.js';
|
||||
import { mergeCaptureExports } from '../../dist/ci/export-merge.js';
|
||||
import { assertCompleteCaptures, hasVerifiedCapture } from '../../dist/capture/health.js';
|
||||
import { readCaptureBundle } from '../../dist/review/capture-review.js';
|
||||
import { writeCaptureObserverPackages } from '../helpers/capture-observer-fixture.mjs';
|
||||
@@ -3557,3 +3560,57 @@ test('a verified label is located on the image\'s axes when the screenshot is th
|
||||
// A 669 x 951 portrait panel captured upright as a 951 x 669 image: the button near its bottom-left is near the image's top-left.
|
||||
assert.deepEqual(verifiedCaptureLabels(nodes, ['Done'], { height: 951 })[0].rect, { x: 11, y: 10, width: 40, height: 100 });
|
||||
});
|
||||
|
||||
test('a session given only the dark pass (appearancePass) captures @dark screens shaped as in a single run', async t => {
|
||||
const f = await fixture(t, { userInterfaceStyle: 'automatic' });
|
||||
const result = await runCiMap({ ...f.options, appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
|
||||
assert.equal(result.runStatus, 'complete');
|
||||
assert.deepEqual(f.requests.filter(request => request.args[0] === 'settings').map(request => request.args.slice(1, 3)), [['appearance', 'dark']]);
|
||||
assert.equal(f.requests.filter(request => request.args[0] === 'screenshot').length, 2);
|
||||
const map = JSON.parse(await readFile(join(f.options.outputDirectory, 'screen-map.json'), 'utf8'));
|
||||
assert.deepEqual(map.run.environment.colorSchemes, ['light', 'dark']);
|
||||
assert.deepEqual(map.screens.map(screen => [screen.id, screen.colorScheme]), [[`${f.ids.home}@dark`, 'dark'], [`${f.ids.settings}@dark`, 'dark']]);
|
||||
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
assert.deepEqual(Object.keys(bundle.images).sort(), [`${f.ids.home}@dark`, `${f.ids.settings}@dark`]);
|
||||
assert.deepEqual(Object.keys(bundle.outcomes).sort(), [`${f.ids.home}@dark`, `${f.ids.settings}@dark`]);
|
||||
assert.equal(bundle.runtimeProfile.colorSchemes, 'light,dark');
|
||||
});
|
||||
|
||||
test('a session given only the dark pass keeps a wrong landing as the unattributed frame its pass recorded, for the export merge', async t => {
|
||||
const f = await fixture(t, { userInterfaceStyle: 'automatic', markerMismatchAt: { path: '/settings', scheme: 'dark' } });
|
||||
const result = await runCiMap({ ...f.options, appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
|
||||
const dark = `${f.ids.settings}@dark`;
|
||||
// Without the light pass beside it, the frame is not demoted to a lost route: the merge decides, as one run's passes do.
|
||||
assert.equal(result.outcomes[dark].status, 'captured');
|
||||
assert.equal(result.outcomes[dark].landing, 'unverified');
|
||||
assert.equal(result.outcomes[f.ids.settings], undefined);
|
||||
assert.equal(result.runStatus, 'partial');
|
||||
const bundle = JSON.parse(await readFile(join(f.options.outputDirectory, 'bundle.json'), 'utf8'));
|
||||
assert.equal(bundle.images[dark].sha256, result.outcomes[dark].screenshotSha256);
|
||||
assert.deepEqual(Object.keys(bundle.outcomes).sort(), [`${f.ids.home}@dark`, dark].sort());
|
||||
});
|
||||
|
||||
test('a split side merges into the export one run makes: each appearance a verified sibling, its runtime evidence resolvable', async t => {
|
||||
const f = await fixture(t, { userInterfaceStyle: 'automatic' });
|
||||
const at = name => ({ mapDirectory: join(f.root, `map${name}`), outputDirectory: join(f.root, `export${name}`) });
|
||||
await runCiMap({ ...f.options, ...at('-single') });
|
||||
await runCiMap({ ...f.options, ...at(''), appearancePass: { all: ['light', 'dark'], capture: ['light'] } });
|
||||
await runCiMap({ ...f.options, ...at('-dark'), appearancePass: { all: ['light', 'dark'], capture: ['dark'] } });
|
||||
await mergeCaptureExports(join(f.root, 'export'), [{ directory: join(f.root, 'export-dark'), scheme: 'dark' }]);
|
||||
const [single, merged] = await Promise.all(['export-single', 'export'].map(name => readCaptureBundle(join(f.root, name))));
|
||||
assert.deepEqual(Object.keys(merged.images).sort(), Object.keys(single.images).sort());
|
||||
assert.deepEqual(merged.outcomes, single.outcomes);
|
||||
// What a review needs of a sibling appearance (#28): its own verified frame and a map that resolves it as one run's would.
|
||||
const map = await readExportedMap(join(f.root, 'export'));
|
||||
const execution = parseRuntimeExecutionContext(JSON.parse(await readFile(join(f.root, 'export', 'execution.json'), 'utf8')));
|
||||
for (const [route, id] of Object.values(f.ids).flatMap(id => [[id, id], [id, `${id}@dark`]])) {
|
||||
// A verified secondary frame has no outcome of its own: it is verified under its route's, as the review reads it.
|
||||
const outcome = merged.outcomes[id] ?? merged.outcomes[route];
|
||||
assert.equal(outcome.status, 'captured', id); assert.equal(outcome.landing, 'verified', id);
|
||||
assert.ok(existsSync(join(f.root, 'export', merged.images[id].path)), id);
|
||||
const screen = map.screens.find(entry => entry.id === id);
|
||||
assert.equal(screen.observationIds.length, 1, id);
|
||||
projectRuntimeEvidence(runtimeEvidenceInputFromMap({ side: 'head', map, screenId: id, representativeObservationId: screen.observationIds[0],
|
||||
sampleObservationIds: screen.observationIds, expectedSampleCount: 1, profile: 'capture:com.example.app', execution }));
|
||||
}
|
||||
});
|
||||
@@ -17,6 +17,7 @@ function element(options = {}) {
|
||||
label: options.label ?? "Continue",
|
||||
...(options.visible === undefined ? { visible: true } : { visible: options.visible }),
|
||||
...(options.selector === undefined ? {} : { selector: options.selector }),
|
||||
...(options.bounds === undefined ? {} : { bounds: options.bounds }),
|
||||
occurrence: options.occurrence ?? 0,
|
||||
controller: "agent-device",
|
||||
actions: options.actions ?? ["press"],
|
||||
@@ -320,6 +321,104 @@ test("keeps an unannotated label delta in the accessibility category", () => {
|
||||
);
|
||||
});
|
||||
|
||||
test("a label that varies within both builds, in the words that differ between them, is runtime state", () => {
|
||||
const stamp = (label) => [element({ elementId: "stamp", identifier: "stamp", role: "text", label, actions: [], actionable: false })];
|
||||
const sibling = (base, head) => ({ base: side("base", base), head: side("head", head) });
|
||||
const input = {
|
||||
impact: impact(),
|
||||
base: side("base", stamp("edited 2m ago")),
|
||||
head: side("head", stamp("edited 3m ago")),
|
||||
visualAssessment: visual(),
|
||||
};
|
||||
const plain = supportedChanges(compareSurfaceEvidence(input));
|
||||
assert.ok(plain.some((change) => change.kind === "accessibility-label-changed"), "without a sibling capture the label difference is a change");
|
||||
|
||||
const result = compareSurfaceEvidence({ ...input, siblings: [sibling(stamp("edited 1m ago"), stamp("edited 4m ago"))] });
|
||||
const changes = supportedChanges(result);
|
||||
assert.deepEqual(changes.map((change) => change.kind), ["unstable-text"]);
|
||||
assert.deepEqual(changes[0], { kind: "unstable-text", subjectRole: "text", before: "edited 2m ago", after: "edited 3m ago", within: "edited 4m ago" });
|
||||
const summary = summarizeReviewerChanges({ changes: result.reviewerChanges });
|
||||
assert.deepEqual(summary.facts.map((fact) => [fact.templateId, fact.bullet]),
|
||||
[["visible-text.unstable-within-build", "Text varies between captures of the same build: \u201cedited 2m ago\u201d / \u201cedited 4m ago\u201d / \u201cedited 3m ago\u201d."]]);
|
||||
assert.equal(summary.needsReview, false);
|
||||
|
||||
// A stable label beside it is still a change.
|
||||
const save = (label) => element({ identifier: "save", label });
|
||||
const mixed = compareSurfaceEvidence({
|
||||
...input,
|
||||
base: side("base", [...stamp("edited 2m ago"), save("Submit")]),
|
||||
head: side("head", [...stamp("edited 3m ago"), save("Save")]),
|
||||
siblings: [sibling([...stamp("edited 1m ago"), save("Submit")], [...stamp("edited 4m ago"), save("Save")])],
|
||||
});
|
||||
assert.deepEqual(supportedChanges(mixed).map((change) => change.kind).sort(), ["accessibility-label-changed", "unstable-text"]);
|
||||
// Pixels that only an unstable label explains still get the generic styling line.
|
||||
const pixels = compareSurfaceEvidence({ ...input, visualAssessment: visual("modified"), siblings: [sibling(stamp("edited 1m ago"), stamp("edited 4m ago"))] });
|
||||
assert.deepEqual(supportedChanges(pixels).map((change) => change.kind), ["unstable-text", "visual-changed"]);
|
||||
});
|
||||
|
||||
test("a label that follows the appearance, or changed in a word that does not vary, is still a change", () => {
|
||||
const label = (text) => [element({ identifier: "toggle", label: text })];
|
||||
const compare = ([baseLight, baseDark], [headLight, headDark], options = {}) => supportedChanges(compareSurfaceEvidence({
|
||||
impact: impact(),
|
||||
base: side("base", label(baseLight), options.base),
|
||||
head: side("head", label(headLight), options.head),
|
||||
visualAssessment: visual(),
|
||||
siblings: [{ base: side("base", label(baseDark)), head: side("head", label(headDark), options.headSibling) }],
|
||||
})).map((change) => change.kind);
|
||||
// The theme toggle's label follows the appearance; the head broke it in light only.
|
||||
assert.deepEqual(compare(["Switch to dark mode", "Switch to light mode"], ["Switch to light mode", "Switch to light mode"]), ["accessibility-label-changed"]);
|
||||
assert.deepEqual(compare(["Switch to dark mode", "Switch to light mode"], ["Enable dark mode", "Switch to light mode"]), ["accessibility-label-changed"]);
|
||||
// The base varies, the head does not.
|
||||
assert.deepEqual(compare(["Save", "Save draft"], ["Submit", "Submit"]), ["accessibility-label-changed"]);
|
||||
// The time varies; the name beside it changed.
|
||||
assert.deepEqual(compare(["Posted by Alice · 2m", "Posted by Alice · 3m"], ["Posted by Bob · 4m", "Posted by Bob · 5m"]), ["accessibility-label-changed"]);
|
||||
// A sibling capture that did not resolve cleanly is no evidence.
|
||||
assert.deepEqual(compare(["Saved 2m ago", "Saved 3m ago"], ["Saved 4m ago", "Saved 5m ago"], { headSibling: { capturedSamples: 1 } }), ["accessibility-label-changed"]);
|
||||
assert.deepEqual(compare(["Saved 2m ago", "Saved 3m ago"], ["Saved 4m ago", "Saved 5m ago"]), ["unstable-text"]);
|
||||
|
||||
// Provenance on one side only stays inconclusive.
|
||||
const annotation = [{ identifier: "toggle", role: "button", textSource: "visible-title" }];
|
||||
const result = compareSurfaceEvidence({
|
||||
impact: impact(),
|
||||
base: side("base", label("Saved 2m ago"), { annotations: annotation }),
|
||||
head: side("head", label("Saved 4m ago")),
|
||||
visualAssessment: visual(),
|
||||
siblings: [{ base: side("base", label("Saved 3m ago"), { annotations: annotation }), head: side("head", label("Saved 5m ago")) }],
|
||||
});
|
||||
assert.equal(result.needsReview, true);
|
||||
assert.ok(result.reviewReasons.some((reason) => /provenance.*one side/i.test(reason)));
|
||||
assert.equal(supportedChanges(result).some((change) => change.kind === "unstable-text"), false);
|
||||
});
|
||||
|
||||
test("text without an identifier that varies within both builds is matched by its place, not its label", () => {
|
||||
const bounds = { x: 0, y: 120, width: 390, height: 64 };
|
||||
// A pattern row: a pressable with one accessibility label and no testID, exposed again by its container on iOS.
|
||||
const row = (label) => [
|
||||
element({ elementId: "row", role: "button", label, selector: `label=${label}`, bounds }),
|
||||
element({ elementId: "row-cell", role: "other", label, selector: `label=${label}`, bounds, actions: [], actionable: false }),
|
||||
];
|
||||
const compare = (baseLabels, headLabels) => compareSurfaceEvidence({
|
||||
impact: impact(),
|
||||
base: side("base", row(baseLabels[0])),
|
||||
head: side("head", row(headLabels[0])),
|
||||
visualAssessment: visual(),
|
||||
...(baseLabels[1] ? { siblings: [{ base: side("base", row(baseLabels[1])), head: side("head", row(headLabels[1])) }] } : {}),
|
||||
});
|
||||
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo, 4 lanes, edited 2m ago"], ["Velvet Tresillo, 4 lanes, edited 4m ago"])).map((change) => change.kind).sort(),
|
||||
["element-added", "element-removed"], "without a sibling capture the row left and arrived");
|
||||
|
||||
const result = compare(["Velvet Tresillo, 4 lanes, edited 2m ago", "Velvet Tresillo, 4 lanes, edited 3m ago"],
|
||||
["Velvet Tresillo, 4 lanes, edited 4m ago", "Velvet Tresillo, 4 lanes, edited 5m ago"]);
|
||||
assert.deepEqual(supportedChanges(result), [{ kind: "unstable-text", subjectRole: "button",
|
||||
before: "Velvet Tresillo, 4 lanes, edited 2m ago", after: "Velvet Tresillo, 4 lanes, edited 4m ago", within: "Velvet Tresillo, 4 lanes, edited 5m ago" }]);
|
||||
assert.equal(result.needsReview, false);
|
||||
// A random name is runtime state the same way.
|
||||
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo", "Copper Pulse"], ["Hollow Echo", "Ghost Relay"])).map((change) => change.kind), ["unstable-text"]);
|
||||
// A real change in the same row is still a change.
|
||||
assert.deepEqual(supportedChanges(compare(["Velvet Tresillo, 4 lanes, edited 2m ago", "Velvet Tresillo, 4 lanes, edited 3m ago"],
|
||||
["Velvet Tresillo, 5 lanes, edited 4m ago", "Velvet Tresillo, 5 lanes, edited 5m ago"])).map((change) => change.kind).sort(), ["element-added", "element-removed"]);
|
||||
});
|
||||
|
||||
test("fails closed when visible-title provenance exists on only one side", () => {
|
||||
const annotation = [{
|
||||
identifier: "primary-cta",
|
||||
|
||||
@@ -346,6 +346,15 @@ test("target ids and entries are validated", () => {
|
||||
assert.throws(() => validateExploreConfig({ ...base(), targets }), error => error.code === "CONFIG_INVALID", JSON.stringify(targets));
|
||||
}
|
||||
assert.throws(() => validateExploreConfig({ ...base(), platforms: { ios: {} }, targets: { iphone: { platform: "ios" } } }), /targets or platforms, not both/);
|
||||
const twoTargets = { iphone: { platform: "ios" }, ipad: { platform: "ios" } };
|
||||
assert.equal(validateExploreConfig({ ...base(), targets: twoTargets, capture: { maxSessions: 2 } }).capture.maxSessions, 2);
|
||||
assert.equal("maxSessions" in validateExploreConfig({ ...base(), targets: twoTargets }).capture, false);
|
||||
// A ceiling below the number of targets runs that many target jobs at once (a starter plan's one simulator per platform).
|
||||
assert.equal(validateExploreConfig({ ...base(), targets: twoTargets, capture: { maxSessions: 1 } }).capture.maxSessions, 1);
|
||||
assert.throws(() => validateExploreConfig({ ...base(), capture: { maxSessions: 0 } }), /capture.maxSessions must be a positive integer/);
|
||||
assert.throws(() => validateExploreConfig({ ...base(), capture: { maxSessions: 1.5 } }), /capture.maxSessions must be a positive integer/);
|
||||
const platforms = { ios: {}, android: { bundleId: "com.example.app", easProfile: "explore" } };
|
||||
assert.equal(validateExploreConfig({ ...base(), platforms, capture: { maxSessions: 1 } }).capture.maxSessions, 1);
|
||||
});
|
||||
|
||||
test("a target can choose its own controller and simulator over capture's", () => {
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtemp, mkdir, readFile, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
|
||||
import { mergeSchemeOutcomes } from "../../dist/capture/appearance.js";
|
||||
import { mergeCaptureExports } from "../../dist/ci/export-merge.js";
|
||||
|
||||
async function writeExport(root, { screens, images, outcomes, launch, diagnostics }) {
|
||||
await mkdir(join(root, "artifacts"), { recursive: true });
|
||||
await mkdir(join(root, "capture-diagnostics"), { recursive: true });
|
||||
const artifacts = [];
|
||||
for (const screen of screens) {
|
||||
const path = `artifacts/${screen}.png`;
|
||||
await writeFile(join(root, path), screen);
|
||||
artifacts.push({ id: `artifact-${screen}`, path, sha256: screen, bytes: screen.length, mimeType: "image/png" });
|
||||
}
|
||||
const map = { contract: "explore.map", revision: 1, run: { id: "run", environment: { colorSchemes: ["light", "dark"] } }, artifacts,
|
||||
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, "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;
|
||||
}
|
||||
|
||||
test("a dark session's export folds into the light session's: @dark frames, outcomes, launch, map records, files and diagnostics", async () => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
|
||||
const primary = await writeExport(join(root, "head-export"), { screens: ["home", "settings"],
|
||||
images: { home: { path: "artifacts/home.png" }, settings: { path: "artifacts/settings.png" } },
|
||||
outcomes: { home: { status: "captured", landing: "verified", attempts: 1 }, settings: { status: "captured", landing: "verified", attempts: 1 } },
|
||||
launch: { light: { splash: "l" } }, diagnostics: "{\"pass\":\"light\"}\n" });
|
||||
const dark = await writeExport(join(root, "head-export-dark"), { screens: ["home@dark", "settings@dark"],
|
||||
images: { "home@dark": { path: "artifacts/[email protected]" }, "settings@dark": { path: "artifacts/[email protected]" } },
|
||||
// A secondary-only run reports a route it lost under the route id, as a run's dark pass does before the passes merge.
|
||||
outcomes: { "home@dark": { status: "captured", landing: "verified", attempts: 2 }, settings: { status: "failed", landing: "unverified", attempts: 3 } },
|
||||
launch: { dark: { splash: "d" } }, diagnostics: "{\"pass\":\"dark\"}\n" });
|
||||
await mergeCaptureExports(primary, [{ directory: dark, scheme: "dark" }]);
|
||||
const bundle = JSON.parse(await readFile(join(primary, "bundle.json"), "utf8"));
|
||||
assert.deepEqual(Object.keys(bundle.images).sort(), ["home", "home@dark", "settings", "settings@dark"]);
|
||||
// As in one run: a dark frame verified beside its light one needs no record of its own; a lost one is the scheme's own outcome.
|
||||
assert.deepEqual(bundle.outcomes, { home: { status: "captured", landing: "verified", attempts: 2 }, settings: { status: "captured", landing: "verified", attempts: 3 },
|
||||
"settings@dark": { status: "failed", landing: "unverified", attempts: 3 } });
|
||||
assert.deepEqual(bundle.launch, { light: { splash: "l" }, dark: { splash: "d" } });
|
||||
const map = JSON.parse(await readFile(join(primary, "screen-map.json"), "utf8"));
|
||||
assert.deepEqual(map.screens.map(screen => screen.id), ["home", "settings", "home@dark", "settings@dark"]);
|
||||
assert.equal(map.observations.length, 4);
|
||||
assert.equal(map.artifacts.length, 4);
|
||||
const manifest = JSON.parse(await readFile(join(primary, "manifest.json"), "utf8"));
|
||||
assert.deepEqual(manifest.files.map(file => file.path).sort(), ["artifacts/home.png", "artifacts/[email protected]", "artifacts/settings.png", "artifacts/[email protected]"]);
|
||||
assert.equal(await readFile(join(primary, "artifacts/[email protected]"), "utf8"), "home@dark");
|
||||
assert.equal(await readFile(join(primary, "capture-diagnostics/controller-timing.jsonl"), "utf8"), "{\"pass\":\"light\"}\n{\"pass\":\"dark\"}\n");
|
||||
// Merging is idempotent for records already present.
|
||||
await mergeCaptureExports(primary, [{ directory: dark, scheme: "dark" }]);
|
||||
assert.equal(JSON.parse(await readFile(join(primary, "screen-map.json"), "utf8")).screens.length, 4);
|
||||
});
|
||||
|
||||
test("merged passes recombine as one run's: an unattributed dark frame beside a verified light one is kept", async () => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-merge-"));
|
||||
const light = { status: "captured", landing: "verified", attempts: 1 };
|
||||
const wrong = { status: "captured", landing: "unverified", attempts: 2, screenshotSha256: "x", observed: { reason: "landing-mismatch", route: "/login", attempts: 2 } };
|
||||
const primary = await writeExport(join(root, "head-export"), { screens: ["settings"], images: { settings: { path: "artifacts/settings.png" } },
|
||||
outcomes: { settings: light }, diagnostics: "" });
|
||||
const dark = await writeExport(join(root, "head-export-dark"), { screens: ["settings@dark"], images: { "settings@dark": { path: "artifacts/[email protected]" } },
|
||||
outcomes: { "settings@dark": wrong }, diagnostics: "" });
|
||||
await mergeCaptureExports(primary, [{ directory: dark, scheme: "dark" }]);
|
||||
const bundle = JSON.parse(await readFile(join(primary, "bundle.json"), "utf8"));
|
||||
assert.deepEqual(bundle.outcomes, mergeSchemeOutcomes([{ settings: light }, { settings: wrong }], ["light", "dark"]));
|
||||
assert.deepEqual(bundle.outcomes["settings@dark"], wrong);
|
||||
});
|
||||
|
||||
test("a dark session that could not show dark (Argent without appearance.set) adds nothing, and an open gap leaves the run partial", 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"), mapPath = join(primary, "screen-map.json");
|
||||
// The primary session could not switch either: it captured light only.
|
||||
await writeFile(bundlePath, JSON.stringify({ ...JSON.parse(await readFile(bundlePath, "utf8")), runtimeProfile: { colorScheme: "light" } }));
|
||||
await writeFile(mapPath, JSON.stringify({ ...JSON.parse(await readFile(mapPath, "utf8")), run: { id: "run", status: "complete", environment: {} } }));
|
||||
const narrowed = await writeExport(join(root, "head-export-dark"), { screens: [], images: {}, outcomes: {}, diagnostics: "" });
|
||||
const narrowedBundle = join(narrowed, "bundle.json");
|
||||
await writeFile(narrowedBundle, JSON.stringify({ ...JSON.parse(await readFile(narrowedBundle, "utf8")), runtimeProfile: { colorScheme: "light" } }));
|
||||
await mergeCaptureExports(primary, [{ directory: narrowed, scheme: "dark" }]);
|
||||
assert.deepEqual(Object.keys(JSON.parse(await readFile(bundlePath, "utf8")).outcomes), ["home"]);
|
||||
assert.equal(JSON.parse(await readFile(mapPath, "utf8")).run.status, "complete");
|
||||
|
||||
const gapped = await writeExport(join(root, "other-export-dark"), { screens: ["home@dark"], images: { "home@dark": { path: "artifacts/[email protected]" } },
|
||||
outcomes: { "home@dark": { status: "captured", landing: "verified", attempts: 1 } }, diagnostics: "" });
|
||||
const gappedMap = join(gapped, "screen-map.json");
|
||||
await writeFile(gappedMap, JSON.stringify({ ...JSON.parse(await readFile(gappedMap, "utf8")), gaps: [{ id: "gap-1", status: "open" }] }));
|
||||
await writeFile(bundlePath, JSON.stringify({ ...JSON.parse(await readFile(bundlePath, "utf8")), runtimeProfile: { colorSchemes: "light,dark" } }));
|
||||
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");
|
||||
});
|
||||
@@ -437,6 +437,30 @@ test('a review runs at most --parallel targets at once, and every target settles
|
||||
assert.deepEqual(results.map(result => result.status === 'fulfilled' ? result.value : result.reason.message), [10, 20, 'three', 40, 50]);
|
||||
});
|
||||
|
||||
test('a local review runs no more targets at once than capture.maxSessions', async t => {
|
||||
const targets = { phone: { platform: 'ios' }, tablet: { platform: 'ios', device: 'iPad Air' } };
|
||||
// Whether one target's review began before the other's ended, from the order of their progress lines.
|
||||
const overlapped = async (maxSessions, parallel) => {
|
||||
const f = await fixture(t, 'expo-router', { targets, maxSessions });
|
||||
t.mock.method(globalThis, 'fetch', async input => assert.fail(`Unmocked network request: ${input}`));
|
||||
const environment = { ...f.environment, EXPLORE_CACHE_DIR: await scratch(t, 'explore-local-cache-'), GITHUB_RUN_ID: '', GITHUB_RUN_ATTEMPT: '', GITHUB_TOKEN: '' };
|
||||
const lines = [];
|
||||
const result = await runLocalReview({ project: f.headProject, base: f.baseSha, head: f.headSha, environment, cache: false, ...(parallel ? { parallel } : {}),
|
||||
install: async checkout => { await writeCaptureObserverPackages(checkout, { provider: 'expo-router' }); }, runner: f.runner, now: f.now, sleep: f.sleep,
|
||||
progress: message => lines.push(message) });
|
||||
t.after(() => rm(result.work, { recursive: true, force: true }));
|
||||
assert.deepEqual(result.reports.map(report => report.target.id).sort(), ['phone', 'tablet']);
|
||||
const span = id => [lines.findIndex(line => line.startsWith(`${id}: `)), lines.findLastIndex(line => line.startsWith(`${id}: `))];
|
||||
const [phone, tablet] = [span('phone'), span('tablet')];
|
||||
return phone[0] < tablet[1] && tablet[0] < phone[1];
|
||||
};
|
||||
// One simulator at a time: the targets take turns.
|
||||
assert.equal(await overlapped(1), false);
|
||||
// The default ceiling (five) runs both at once, and --parallel still chooses for itself.
|
||||
assert.equal(await overlapped(undefined), true);
|
||||
assert.equal(await overlapped(1, 2), true);
|
||||
});
|
||||
|
||||
test('a target that fails outright costs only its own report', async t => {
|
||||
const targets = { phone: { platform: 'ios' }, tablet: { platform: 'ios', device: 'iPad Air' } };
|
||||
const f = await fixture(t, 'expo-router', { targets });
|
||||
|
||||
@@ -127,6 +127,17 @@ test('local review preparation preserves metadata and verified evidence without
|
||||
await assert.rejects(readCaptureBundle(join(f.root, 'bad')), /explore\.bundle/);
|
||||
});
|
||||
|
||||
test('a review names the system areas its verdict left out, the platform\'s bands unless told otherwise', async t => {
|
||||
const f = await captureFixture(t);
|
||||
// The bundle names the device but not its pose, so preparation does not guess a foldable's panel from it.
|
||||
const duo = { ...runtimeProfile, deviceModel: 'iPhone Duo' };
|
||||
for (const side of ['base', 'head']) await writeFile(join(f.options[`${side}Directory`], 'bundle.json'), JSON.stringify({ ...f.bundles[side], runtimeProfile: duo }));
|
||||
const bands = [{ kind: 'status-bar', x: 0, y: 0, width: 100, height: 6.5 }, { kind: 'home-indicator', x: 0, y: 97, width: 100, height: 3 }];
|
||||
assert.deepEqual((await prepareCaptureReview(f.options)).review.runtime.systemRegions, bands);
|
||||
const pill = [{ kind: 'status-bar', x: 92.43, y: 4.48, width: 5.05, height: 10.76 }, bands[1]];
|
||||
assert.deepEqual((await prepareCaptureReview({ ...f.options, systemRegions: pill })).review.runtime.systemRegions, pill);
|
||||
});
|
||||
|
||||
test('review preparation rejects altered image hashes, metadata and paths outside the capture directory', async t => {
|
||||
for (const mutation of ['hash', 'dimensions', 'source-commit', 'parent-path', 'absolute-path', 'symlink']) {
|
||||
await t.test(mutation, async t => {
|
||||
|
||||
@@ -5,9 +5,9 @@ import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
import { PNG as PngImage } from "pngjs";
|
||||
|
||||
import { assessPublicEvidence, presenceDescription, ignoreStatusBar, ignoreSystemBands, readExportedMap } from "../../dist/review/evidence-assessment.js";
|
||||
import { assessPublicEvidence, decideReview, presenceDescription, ignoreStatusBar, ignoreSystemBands, ignoreSystemRegions, readExportedMap } from "../../dist/review/evidence-assessment.js";
|
||||
import { STATUS_BAR_BAND_PERCENT } from "../../dist/shared/png-evidence.js";
|
||||
import { homeIndicatorBandPercent, statusBarBandPercent } from "../../dist/contracts/capture.js";
|
||||
import { homeIndicatorBandPercent, statusBarBandPercent, systemRegions } from "../../dist/contracts/capture.js";
|
||||
import { AGENT_DEVICE_VERSION } from "../../dist/capture/run.js";
|
||||
|
||||
const BASE_SHA = "a".repeat(40);
|
||||
@@ -340,8 +340,10 @@ test("expired comparison budgets produce diagnostics rather than review verdicts
|
||||
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);
|
||||
let clock = 0;
|
||||
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", timeBudgetMs: 0, now: () => clock++, measure: async () => { assert.fail('expired comparisons do not run'); } });
|
||||
let clock = 0, measured = 0;
|
||||
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", timeBudgetMs: 0, now: () => clock++,
|
||||
measure: async (...args) => { measured += 1; return measurer({})(...args); } });
|
||||
assert.equal(measured, 0, "expired comparisons do not run");
|
||||
assert.equal(result.summary.visual.compared, 0);
|
||||
assert.equal(result.summary.visual.failed, 3);
|
||||
assert.equal(result.summary.visual.needsReview, 0);
|
||||
@@ -525,3 +527,160 @@ test("a presence verdict for a long route (an encoded share link) stays within t
|
||||
}
|
||||
assert.equal(presenceDescription("Added ", "/home", " screen."), "Added /home screen.");
|
||||
});
|
||||
|
||||
test("screenshot pairs compare a few at a time, in the loop's order, with the same verdicts as one at a time", async (t) => {
|
||||
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 run = async (concurrency) => {
|
||||
let active = 0, peak = 0;
|
||||
const started = [];
|
||||
const measure = async (baselinePath, currentPath) => {
|
||||
started.push(baselinePath);
|
||||
active += 1; peak = Math.max(peak, active);
|
||||
await new Promise(resolve => setTimeout(resolve, 20));
|
||||
active -= 1;
|
||||
return measurer({ changed: 3.2, stable: 0.4 })(baselinePath, currentPath);
|
||||
};
|
||||
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure, concurrency });
|
||||
return { peak, started, surfaces: result.surfaces, summary: result.summary };
|
||||
};
|
||||
const sequential = await run(1);
|
||||
const parallel = await run(4);
|
||||
assert.equal(sequential.peak, 1);
|
||||
assert.ok(parallel.peak > 1, `comparisons overlap (peak ${parallel.peak})`);
|
||||
assert.deepEqual(parallel.started, sequential.started, "pairs start in the loop's order");
|
||||
assert.deepEqual(parallel.surfaces, sequential.surfaces);
|
||||
assert.deepEqual(parallel.summary, sequential.summary);
|
||||
});
|
||||
|
||||
test("a pair whose turn comes after the budget expired is not started, and one started in time is used", async (t) => {
|
||||
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);
|
||||
// The first comparison takes past the budget: it was started in time, the two queued behind it were not.
|
||||
let time = 0, measured = 0;
|
||||
const measure = async (...args) => { measured += 1; time += 1_000; return measurer({})(...args); };
|
||||
const result = await assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device",
|
||||
timeBudgetMs: 100, now: () => time, measure, concurrency: 1 });
|
||||
assert.equal(measured, 1);
|
||||
assert.equal(result.summary.visual.compared, 1);
|
||||
assert.equal(result.summary.visual.failed, 2);
|
||||
assert.ok(result.summary.diagnostics.every(item => item.code === 'VISUAL_COMPARISON_BUDGET_EXHAUSTED'));
|
||||
});
|
||||
|
||||
test("unstable text never makes a screen Modified, and names a variant's runtime state", () => {
|
||||
const unstable = { category: "visible-text", templateId: "visible-text.unstable-within-build", bullet: 'Text varies between captures of the same build: "2m" / "4m" / "3m".' };
|
||||
const summary = (facts) => ({ facts, needsReview: false, reviewIssues: [] });
|
||||
const unchanged = { verdict: "unchanged", reason: "matched", mismatchPercentage: 0, threshold: 0.1, tool: "t" };
|
||||
const modified = { ...unchanged, verdict: "modified", reason: "repeated-cross-build-delta", mismatchPercentage: 0.4, regions: [{ location: "center" }] };
|
||||
assert.deepEqual(decideReview("screen", unchanged, summary([unstable])), { status: "unchanged", description: "No visible change" });
|
||||
const pixels = decideReview("screen", modified, summary([unstable]));
|
||||
assert.deepEqual([pixels.status, pixels.description, pixels.facts.length], ["modified", "Visual change · 0.4% · center", 1]);
|
||||
const real = decideReview("screen", modified, summary([{ category: "accessibility", templateId: "accessibility.label-changed", bullet: 'Changed accessibility label from "Submit" to "Save".' }, unstable]));
|
||||
assert.equal(real.description, 'Changed accessibility label from "Submit" to "Save".');
|
||||
assert.equal(decideReview("none", modified, summary([unstable])).description, 'Runtime state differs: Text varies between captures of the same build: "2m" / "4m" / "3m".');
|
||||
// A variant is named by what else differs, ahead of the runtime text.
|
||||
const target = { category: "interaction", templateId: "interaction.target-changed", bullet: "Changed where “Open” leads." };
|
||||
assert.equal(decideReview("none", modified, summary([unstable, target])).description, "Runtime state differs: Changed where “Open” leads.");
|
||||
});
|
||||
|
||||
test("text that varies between both builds' own verified appearances is runtime state; an unverified one is no evidence", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-public-evidence-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const capture = async (unverifiedHeadDark) => {
|
||||
const base = await side(join(root, `${unverifiedHeadDark}`), "base", manifests.base);
|
||||
const head = await side(join(root, `${unverifiedHeadDark}`), "head", manifests.head);
|
||||
const labels = { base: ["edited 2m ago", "edited 3m ago"], head: ["edited 4m ago", "edited 5m ago"] };
|
||||
for (const [name, current] of [["base", base], ["head", head]]) {
|
||||
current.bundle.runtimeProfile = { deviceModel: "iPhone 17", osVersion: "26.0", locale: "en-US", orientation: "portrait", colorScheme: "light", colorSchemes: "light,dark" };
|
||||
await addDarkAppearance(current, manifests[name]);
|
||||
for (const [index, suffix] of ["", "@dark"].entries()) {
|
||||
const observation = current.map.observations.find((entry) => entry.id === `${name}-changed-observation${suffix}`);
|
||||
observation.elements[0].label = labels[name][index];
|
||||
}
|
||||
}
|
||||
if (unverifiedHeadDark) head.bundle.outcomes["changed@dark"] = { status: "captured", attempts: 1, landing: "unverified" };
|
||||
return assessPublicEvidence({ plan: plan(), base, head, profile: "explore:bundle", agentDeviceCommand: "/nonexistent/agent-device", measure: measurer({}) });
|
||||
};
|
||||
const verified = await capture(false);
|
||||
assert.deepEqual(verified.surfaces.changed.review, { status: "unchanged", description: "No visible change" });
|
||||
assert.deepEqual(verified.surfaces["changed@dark"].review, { status: "unchanged", description: "No visible change" });
|
||||
// The head's dark capture may show another screen: the light label difference stays a change.
|
||||
const unverified = await capture(true);
|
||||
assert.equal(unverified.surfaces.changed.review.status, "modified");
|
||||
assert.deepEqual(unverified.surfaces.changed.review.facts.map((fact) => fact.templateId), ["accessibility.label-changed"]);
|
||||
});
|
||||
|
||||
test("a foldable's rail clock pill is left out of the verdict like a phone's status bar", () => {
|
||||
// Measured on EAS Simulator captures of an iPhone Duo (iOS 27.1): a 40×64 pt clock + Wi-Fi pill 28 pt from the right edge.
|
||||
const closed = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "closed" });
|
||||
const open = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "open" });
|
||||
assert.deepEqual(closed, [{ kind: "status-bar", x: 84.55, y: 12.24, width: 10.3, height: 10.62 }, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }]);
|
||||
assert.deepEqual(open[0], { kind: "status-bar", x: 92.43, y: 4.48, width: 5.05, height: 10.76 });
|
||||
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone Duo", pose: "half-open" })[0], open[0]);
|
||||
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone Duo" })[0], closed[0], "a foldable boots closed");
|
||||
assert.deepEqual(systemRegions({ platform: "ios", device: "iPhone 17" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 6.5 }, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }]);
|
||||
assert.deepEqual(systemRegions({ platform: "android" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 7 }]);
|
||||
|
||||
// Diff regions from a comment-only PR's report: the ticking clock on each panel, in that report's normalized rects.
|
||||
const region = (rect, location) => ({ index: 0, rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: rect, differentPixels: 400, shareOfDiffPercentage: 100, densityPercentage: 50, shape: "wide", size: "small", location, dominantChange: "brighter" });
|
||||
const closedClock = region({ x: 85.12, y: 12.78, width: 9.08, height: 1.77 }, "middle-right");
|
||||
const openClock = region({ x: 92.71, y: 5.08, width: 4.45, height: 1.79 }, "top-right");
|
||||
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 2843532, differentPixels: 400 * regions.length, mismatchPercentage: 0.01, match: false, regions });
|
||||
|
||||
const closedOnly = ignoreSystemRegions(measurement([closedClock]), closed);
|
||||
assert.equal(closedOnly.ignoredStatusBar, 1);
|
||||
assert.equal(closedOnly.measurement.match, true);
|
||||
assert.deepEqual(closedOnly.measurement.regions, []);
|
||||
assert.equal(ignoreSystemRegions(measurement([openClock]), open).measurement.match, true);
|
||||
// Each panel's pill is only ignored on that panel: the other pose's clock is app content there.
|
||||
assert.equal(ignoreSystemRegions(measurement([openClock]), closed).ignoredStatusBar, 0);
|
||||
assert.equal(ignoreSystemRegions(measurement([closedClock]), open).ignoredStatusBar, 0);
|
||||
// The phone's top band never reached the closed panel's pill, and the open clock's bottom edge (6.9%) crossed it.
|
||||
assert.equal(ignoreSystemBands(measurement([closedClock, openClock]), { top: 6.5, bottom: 0 }).ignoredTop, 0);
|
||||
// The app's own rail control just below the pill is kept whole, as is a region that straddles the pill's edge.
|
||||
const railButton = region({ x: 85.4, y: 25.2, width: 8.6, height: 7.4 }, "middle-right");
|
||||
const straddling = region({ x: 83, y: 12.78, width: 11.2, height: 1.77 }, "middle-right");
|
||||
const mixed = ignoreSystemRegions(measurement([closedClock, railButton, straddling]), closed);
|
||||
assert.equal(mixed.ignoredStatusBar, 1);
|
||||
// What is kept shares the remaining difference between them.
|
||||
assert.deepEqual(mixed.measurement.regions, [railButton, straddling].map((kept) => ({ ...kept, shareOfDiffPercentage: 50 })));
|
||||
assert.equal(mixed.measurement.differentPixels, 800);
|
||||
assert.equal(mixed.measurement.match, false);
|
||||
// A region inside the home indicator counts under its own kind.
|
||||
const indicator = region({ x: 40, y: 97.5, width: 20, height: 1 }, "bottom-center");
|
||||
const both = ignoreSystemRegions(measurement([closedClock, indicator]), closed);
|
||||
assert.deepEqual([both.ignoredStatusBar, both.ignoredHomeIndicator, both.measurement.match], [1, 1, true]);
|
||||
});
|
||||
|
||||
test("only an iPhone foldable gets the rail pill, and a region reaching the right edge stays inside a band", () => {
|
||||
// An Android device whose name matches keeps its own top band; the iPhone Duo's rail is not on its screen.
|
||||
assert.deepEqual(systemRegions({ platform: "android", device: "Surface Duo", pose: "open" }), [{ kind: "status-bar", x: 0, y: 0, width: 100, height: 7 }]);
|
||||
|
||||
// agent-device rounds x and width to 0.01% each, so a region that ends at the right edge can read as ending at 100.01%.
|
||||
const region = (rect) => ({ index: 0, rect: { x: 0, y: 0, width: 1, height: 1 }, normalizedRect: rect, differentPixels: 400, shareOfDiffPercentage: 100, densityPercentage: 50, shape: "wide", size: "small", location: "top-right", dominantChange: "brighter" });
|
||||
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 2843532, differentPixels: 400 * regions.length, mismatchPercentage: 0.01, match: false, regions });
|
||||
const battery = region({ x: 0.63, y: 2, width: 99.38, height: 2 }); // minX 9 of 1440 px
|
||||
assert.equal(ignoreSystemBands(measurement([battery]), { top: 6.5, bottom: 0 }).ignoredTop, 1);
|
||||
const indicator = region({ x: 0.63, y: 97.5, width: 99.38, height: 1 });
|
||||
assert.equal(ignoreSystemRegions(measurement([indicator]), systemRegions({ platform: "ios", device: "iPhone 17" })).ignoredHomeIndicator, 1);
|
||||
// The slack is the rounding, no more: a region a tenth of a percent past the band is still kept.
|
||||
assert.equal(ignoreSystemBands(measurement([region({ x: 10, y: 2, width: 20, height: 4.6 })]), { top: 6.5, bottom: 0 }).ignoredTop, 0);
|
||||
});
|
||||
|
||||
test("on a foldable a region across the pill's edge is kept whole, and one across the home indicator's edge is clipped", () => {
|
||||
const duo = systemRegions({ platform: "ios", device: "iPhone Duo", pose: "closed" });
|
||||
const region = (rect, normalizedRect, differentPixels) => ({ index: 0, rect, normalizedRect, differentPixels, shareOfDiffPercentage: 100, densityPercentage: 100, shape: "block", size: "small", location: "middle-right", dominantChange: "darker" });
|
||||
const measurement = (regions) => ({ baselinePath: "b", currentPath: "h", totalPixels: 87400, differentPixels: regions.reduce((total, entry) => total + entry.differentPixels, 0), mismatchPercentage: 0.11, match: false, regions });
|
||||
// A pill is not a band: what crosses its edge is the app's own rail, so the frames are never read for it.
|
||||
const belowPill = region({ x: 85, y: 190, width: 10, height: 20 }, { x: 85, y: 21.74, width: 10, height: 2.29 }, 200);
|
||||
const kept = ignoreSystemRegions(measurement([belowPill]), duo, () => assert.fail("a pill's edge needs no frames"));
|
||||
assert.deepEqual([kept.ignoredStatusBar, kept.measurement.match, kept.measurement.regions], [0, false, [belowPill]]);
|
||||
// The home indicator is a band across the width, as on a phone: in a 100x874 frame its 3% is the last 26 rows, from 848.
|
||||
const frame = (paint) => { const png = new PngImage({ width: 100, height: 874 }); png.data.fill(255); paint?.(png); return png; };
|
||||
const painted = (png) => { for (let y = 840; y < 850; y += 1) for (let x = 10; x < 20; x += 1) png.data.fill(0, (y * 100 + x) * 4, (y * 100 + x) * 4 + 3); };
|
||||
const crossing = region({ x: 10, y: 840, width: 10, height: 10 }, { x: 10, y: 96.11, width: 10, height: 1.14 }, 100);
|
||||
const clipped = ignoreSystemRegions(measurement([crossing]), duo, () => ({ baseline: frame(), current: frame(painted), distance: 0.1 * Math.sqrt(3 * 255 ** 2) }));
|
||||
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]]);
|
||||
});
|
||||
@@ -258,7 +258,9 @@ test('a visual region may carry the shift its content moved by, and a malformed
|
||||
const { assertPublicReview } = await import('../../dist/contracts/review-validation.js');
|
||||
const valid = JSON.parse(JSON.stringify(reviewWithRegion({ x: 0, y: -4.17 })));
|
||||
assert.doesNotThrow(() => assertPublicReview(valid));
|
||||
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 500 }, 'up']) {
|
||||
// A card recentred on iPhone Duo's inner display moved 395 pixels: a large move is still a move.
|
||||
assert.doesNotThrow(() => assertPublicReview(JSON.parse(JSON.stringify(reviewWithRegion({ x: 395, y: 0 })))));
|
||||
for (const shift of [{ x: 0 }, { x: 0, y: Number.NaN }, { x: 0, y: 9000 }, 'up']) {
|
||||
assert.throws(() => assertPublicReview(reviewWithRegion(shift)), /visual verdict is inconsistent/, JSON.stringify(shift));
|
||||
}
|
||||
});
|
||||
@@ -287,6 +289,28 @@ test('allRegionsMoved is only true, and only where every published region carrie
|
||||
}
|
||||
});
|
||||
|
||||
test('a large move publishes as one region where the content is now, with its members\' pixels and the arrived region\'s location', async () => {
|
||||
const { publishMeasuredRegions } = await import('../../dist/review/evidence-assessment.js');
|
||||
const region = (x, share, location, dominantChange) => ({ index: 0, rect: { x, y: 100, width: 100, height: 200 },
|
||||
normalizedRect: { x: x / 10, y: 10, width: 10, height: 20 }, differentPixels: share * 100, shareOfDiffPercentage: share,
|
||||
densityPercentage: 50, shape: 'block', size: 'large', location, dominantChange });
|
||||
// Arrived first: the card is centred now, so the region says center whichever member has more pixels.
|
||||
const all = [region(100, 50.01, 'middle-left', 'brighter'), region(450, 50.01, 'center', 'darker')];
|
||||
const moves = [{ rect: { x: 450, y: 100, width: 100, height: 200 }, shift: { x: 350, y: 0 }, members: [1, 0] }];
|
||||
const published = publishMeasuredRegions(all, [undefined, undefined], moves, 1000, 1000);
|
||||
assert.deepEqual(published.regions, [{ rect: { x: 450, y: 100, width: 100, height: 200 }, normalizedRect: { x: 45, y: 10, width: 10, height: 20 },
|
||||
differentPixels: 10002, shareOfDiffPercentage: 100, dominantChange: 'mixed', location: 'center', shift: { x: 350, y: 0 } }],
|
||||
'two shares of 50.01 cap at 100, the Viewer\'s bound');
|
||||
assert.equal(published.allRegionsMoved, true, 'nothing else on the screen changed');
|
||||
// A change that is not part of the move keeps the screen from reading as only moved, and more regions than the
|
||||
// published limit keep the largest.
|
||||
const crowded = [...all, ...Array.from({ length: 9 }, (_, index) => region(index, 0.5, 'top-left', 'mixed'))];
|
||||
const withChanges = publishMeasuredRegions(crowded, crowded.map(() => undefined), moves, 1000, 1000);
|
||||
assert.equal(withChanges.allRegionsMoved, undefined);
|
||||
assert.equal(withChanges.regions.length, 8);
|
||||
assert.deepEqual(withChanges.regions[0].shift, { x: 350, y: 0 });
|
||||
});
|
||||
|
||||
test("an excluded surface carries no capture evidence", () => {
|
||||
const excluded = review();
|
||||
excluded.surfaces[1].excluded = true;
|
||||
|
||||
@@ -1,7 +1,12 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
import { Buffer } from "node:buffer";
|
||||
import { regionShifts } from "../../dist/review/region-shift.js";
|
||||
import { mkdtemp, rm, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { PNG } from "pngjs";
|
||||
import { measureRegionMoves, regionMoves, regionShifts } from "../../dist/review/region-shift.js";
|
||||
import { measureRegionMovesInWorker } from "../../dist/review/region-shift-worker.js";
|
||||
|
||||
/** A 120×160 frame of a light background with dark text-like bars, drawn `offsetY` pixels lower (fractions blend rows). */
|
||||
function frame(offsetY, { barColor = 40, extraBar = false } = {}) {
|
||||
@@ -101,3 +106,195 @@ test("a half-pixel move up and down is judged alike", () => {
|
||||
const up = regionShifts(frame(0), frame(-0.5), [region])[0], down = regionShifts(frame(0), frame(0.5), [region])[0];
|
||||
assert.deepEqual([up?.y, down?.y], [-0.5, 0.5]);
|
||||
});
|
||||
|
||||
test("a move whose best fit ties with a smaller one is still a move: the search stops no fit that could make it ambiguous", () => {
|
||||
// Two and a half pixels lower, with a sparse speckle of noise. The tie goes to a fit a little worse than the least error,
|
||||
// and an ambiguity is judged against that one, so a fit stopped short against the least error must not pass for one.
|
||||
const moved = frame(2.5), speckled = { ...moved, data: Buffer.from(moved.data) };
|
||||
for (let y = 0; y < moved.height; y += 1) for (let x = 0; x < moved.width; x += 1) {
|
||||
if ((x * 3 + y * 5) % 11 !== 0) continue;
|
||||
const offset = (y * moved.width + x) * 4, value = Math.max(0, Math.min(255, moved.data[offset] + ((x + y) % 2 ? 10 : -10)));
|
||||
speckled.data.fill(value, offset, offset + 3);
|
||||
}
|
||||
assert.deepEqual(regionShifts(frame(0), speckled, [region]), [{ x: 0, y: 2.5 }]);
|
||||
});
|
||||
|
||||
/**
|
||||
* A light frame with a dark card of irregular blocks at (x, y): the blocks make every offset look different, as a
|
||||
* real card's text and icons do. `tile` repeats one such block pattern every `tile` pixels across the whole row
|
||||
* instead, as a grid of identical cells does, starting `x` pixels in.
|
||||
*/
|
||||
function cardFrame({ width = 600, height = 300, x = 60, y = 80, cardWidth = 150, cardHeight = 120, seed = 7, tile } = {}) {
|
||||
const data = Buffer.alloc(width * height * 4, 240);
|
||||
for (let index = 3; index < data.length; index += 4) data[index] = 255;
|
||||
const paint = (px, py, value) => data.fill(value, (py * width + px) * 4, (py * width + px) * 4 + 3);
|
||||
let state = seed;
|
||||
const random = () => (state = (state * 1103515245 + 12345) % 2147483648) / 2147483648;
|
||||
const blocks = Array.from({ length: tile ? 6 : 40 }, () => {
|
||||
const span = tile ?? cardWidth;
|
||||
return [Math.floor(random() * (span - 12)), Math.floor(random() * (cardHeight - 8)), 4 + Math.floor(random() * 8), 3 + Math.floor(random() * 5), 80 + Math.floor(random() * 160)];
|
||||
});
|
||||
for (let py = y; py < y + cardHeight; py += 1) {
|
||||
for (let px = tile ? 0 : x; px < (tile ? width : x + cardWidth); px += 1) {
|
||||
const local = tile ? (((px - x) % tile) + tile) % tile : px - x;
|
||||
const block = blocks.find(([bx, by, bw, bh]) => local >= bx && local < bx + bw && py - y >= by && py - y < by + bh);
|
||||
paint(px, py, block ? block[4] : 12);
|
||||
}
|
||||
}
|
||||
return { width, height, data };
|
||||
}
|
||||
|
||||
test("a card that moved far along a row is one move, from the regions where it left and where it arrived", () => {
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
const shifts = regionShifts(cardFrame(), cardFrame({ x: 330 }), regions);
|
||||
assert.deepEqual(shifts, [undefined, undefined], "too far for the drift search");
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, shifts),
|
||||
[{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1, 0] }], "the region it arrived in first");
|
||||
});
|
||||
|
||||
test("a large move is measured on a worker thread the same as on the calling thread", async (t) => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-region-shift-")); t.after(() => rm(root, { recursive: true, force: true }));
|
||||
const write = async (name, frame) => {
|
||||
const png = new PNG({ width: frame.width, height: frame.height }); frame.data.copy(png.data);
|
||||
await writeFile(join(root, name), PNG.sync.write(png)); return join(root, name);
|
||||
};
|
||||
const basePath = await write("base.png", cardFrame()), headPath = await write("head.png", cardFrame({ x: 330 }));
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
const measured = await measureRegionMovesInWorker(basePath, headPath, regions);
|
||||
assert.deepEqual(measured, await measureRegionMoves(basePath, headPath, regions));
|
||||
assert.deepEqual(measured.moves, [{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1, 0] }]);
|
||||
});
|
||||
|
||||
test("a move whose old and new places overlap takes in the fragments of it the comparison found in between", () => {
|
||||
// A 300-wide card moved 120 right: the comparison sees where it only was, where it only is, and a fragment of the
|
||||
// overlap whose pixels differ because the card's own content moved over itself.
|
||||
const base = cardFrame({ width: 700, cardWidth: 300 }), head = cardFrame({ width: 700, cardWidth: 300, x: 180 });
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 120, height: 120, dominantChange: "brighter" },
|
||||
{ x: 360, y: 80, width: 120, height: 120, dominantChange: "darker" },
|
||||
{ x: 200, y: 100, width: 120, height: 40, dominantChange: "mixed" },
|
||||
];
|
||||
const [move] = regionMoves(base, head, regions, regions.map(() => undefined));
|
||||
assert.deepEqual(move, { rect: { x: 180, y: 80, width: 300, height: 120 }, shift: { x: 120, y: 0 }, members: [1, 0, 2] });
|
||||
});
|
||||
|
||||
test("a card that moved far down a column is a vertical move", () => {
|
||||
const regions = [
|
||||
{ x: 100, y: 20, width: 150, height: 100, dominantChange: "brighter" },
|
||||
{ x: 100, y: 330, width: 150, height: 100, dominantChange: "darker" },
|
||||
];
|
||||
const base = cardFrame({ height: 480, x: 100, y: 20, cardHeight: 100 }), head = cardFrame({ height: 480, x: 100, y: 330, cardHeight: 100 });
|
||||
assert.deepEqual(regionMoves(base, head, regions, [undefined, undefined]),
|
||||
[{ rect: { x: 100, y: 330, width: 150, height: 100 }, shift: { x: 0, y: 310 }, members: [1, 0] }]);
|
||||
});
|
||||
|
||||
test("content that left one place while other content arrived elsewhere is not a move", () => {
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330, seed: 99 }), regions, [undefined, undefined]), [], "another card arrived");
|
||||
// The pair must be opposite: two regions that both got darker are two changes.
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions.map(region => ({ ...region, dominantChange: "darker" })), [undefined, undefined]), []);
|
||||
// Regions already explained by a small move are not reconsidered.
|
||||
assert.deepEqual(regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, [{ x: 0, y: 1 }, undefined]), []);
|
||||
});
|
||||
|
||||
test("repeating content that lines up at several distances is not a move: the distance would be a guess", () => {
|
||||
// A row of identical cells every 40 pixels, all moved 260 right: 220, 260 and 300 fit about as well.
|
||||
const regions = [
|
||||
{ x: 60, y: 80, width: 100, height: 120, dominantChange: "brighter" },
|
||||
{ x: 300, y: 80, width: 100, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
assert.deepEqual(regionMoves(cardFrame({ tile: 40 }), cardFrame({ tile: 40, x: 320 }), regions, [undefined, undefined]), []);
|
||||
});
|
||||
|
||||
/** Two frames laid over each other: the darker pixel of each wins, so a dark card in either shows. */
|
||||
function overlay(first, second) {
|
||||
const data = Buffer.from(first.data);
|
||||
for (let index = 0; index < data.length; index += 1) data[index] = Math.min(first.data[index], second.data[index]);
|
||||
return { ...first, data };
|
||||
}
|
||||
|
||||
/** Paints a block of one colour into a frame, as a badge or icon drawn on top. */
|
||||
function withBlock(frame, { x, y, width, height, value }) {
|
||||
const data = Buffer.from(frame.data);
|
||||
for (let py = y; py < y + height; py += 1) for (let px = x; px < x + width; px += 1) data.fill(value, (py * frame.width + px) * 4, (py * frame.width + px) * 4 + 3);
|
||||
return { ...frame, data };
|
||||
}
|
||||
|
||||
const farMove = [
|
||||
{ x: 60, y: 80, width: 150, height: 120, dominantChange: "brighter" },
|
||||
{ x: 330, y: 80, width: 150, height: 120, dominantChange: "darker" },
|
||||
];
|
||||
|
||||
test("something new where the card was stays a change: the move takes only the place it arrived", () => {
|
||||
// The card moved right, and another card took its old place.
|
||||
const head = overlay(cardFrame({ x: 330 }), cardFrame({ x: 60, seed: 99 }));
|
||||
assert.deepEqual(regionMoves(cardFrame(), head, farMove, [undefined, undefined]),
|
||||
[{ rect: { x: 330, y: 80, width: 150, height: 120 }, shift: { x: 270, y: 0 }, members: [1] }]);
|
||||
// A flat panel in another colour than the backdrop around it: nothing spreads, but it is not the backdrop.
|
||||
const panel = withBlock(cardFrame({ x: 330 }), { x: 60, y: 80, width: 150, height: 120, value: 180 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), panel, farMove, [undefined, undefined])[0]?.members, [1]);
|
||||
// An 8×8 badge where a large card was: a small mark in a large plain area is still something drawn.
|
||||
const large = [
|
||||
{ x: 60, y: 80, width: 300, height: 400, dominantChange: "brighter" },
|
||||
{ x: 600, y: 80, width: 300, height: 400, dominantChange: "darker" },
|
||||
];
|
||||
const card = x => cardFrame({ width: 960, height: 560, x, cardWidth: 300, cardHeight: 400 });
|
||||
assert.deepEqual(regionMoves(card(60), card(600), large, [undefined, undefined])[0]?.members, [1, 0], "plain backdrop joins the move");
|
||||
const badge = withBlock(card(600), { x: 200, y: 250, width: 8, height: 8, value: 0 });
|
||||
assert.deepEqual(regionMoves(card(60), badge, large, [undefined, undefined])[0]?.members, [1]);
|
||||
});
|
||||
|
||||
test("content that did not arrive intact is not a move: part of it deleted, or something changed inside it", () => {
|
||||
// Only the card's top half arrived; its body was deleted.
|
||||
const deleted = withBlock(cardFrame({ x: 330 }), { x: 330, y: 140, width: 150, height: 60, value: 240 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), deleted, farMove, [undefined, undefined]), []);
|
||||
// The card moved, and an 8×8 white mark appeared inside it: a badge is a change, however small.
|
||||
const marked = withBlock(cardFrame({ x: 330 }), { x: 400, y: 130, width: 8, height: 8, value: 255 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), marked, farMove, [undefined, undefined]), []);
|
||||
// Changes of moderate contrast on the dark card: a grey badge, and a button in another shade.
|
||||
for (const block of [{ x: 400, y: 130, width: 8, height: 8, value: 120 }, { x: 340, y: 160, width: 40, height: 20, value: 60 }]) {
|
||||
assert.deepEqual(regionMoves(cardFrame(), withBlock(cardFrame({ x: 330 }), block), farMove, [undefined, undefined]), [], JSON.stringify(block));
|
||||
}
|
||||
});
|
||||
|
||||
test("a hairline that differs where the content arrived is not a change: antialiased edges against another backdrop", () => {
|
||||
// Two pixels wide and of moderate contrast, as the curve under euxy's Patterns chevrons (brentvatne/euxy#163).
|
||||
const crossed = withBlock(cardFrame({ x: 330 }), { x: 330, y: 150, width: 150, height: 2, value: 90 });
|
||||
assert.deepEqual(regionMoves(cardFrame(), crossed, farMove, [undefined, undefined])[0]?.shift, { x: 270, y: 0 });
|
||||
});
|
||||
|
||||
test("content that is the same all down a move along a row keeps the move in line", () => {
|
||||
// Vertical bars of irregular widths: every small vertical drift fits as well as none.
|
||||
const bars = x => {
|
||||
const frame = cardFrame({ x });
|
||||
const data = Buffer.from(frame.data);
|
||||
const widths = [6, 11, 4, 9, 14, 5, 8, 12, 7, 10, 6, 13, 9, 5, 11, 7, 6, 8];
|
||||
let px = x, dark = true;
|
||||
for (const width of widths) {
|
||||
for (let py = 80; py < 200; py += 1) for (let column = px; column < Math.min(px + width, x + 150); column += 1) data.fill(dark ? 20 : 200, (py * frame.width + column) * 4, (py * frame.width + column) * 4 + 3);
|
||||
px += width; dark = !dark;
|
||||
}
|
||||
return { ...frame, data };
|
||||
};
|
||||
const [move] = regionMoves(bars(60), bars(330), farMove, [undefined, undefined]);
|
||||
assert.deepEqual(move?.shift, { x: 270, y: 0 });
|
||||
assert.deepEqual(move?.rect, { x: 330, y: 80, width: 150, height: 120 });
|
||||
});
|
||||
|
||||
test("regions with fractional edges, or reaching past the screenshot, are measured on the pixels they cover", () => {
|
||||
const regions = [
|
||||
{ x: 60.4, y: 79.6, width: 149.8, height: 120.5, dominantChange: "brighter" },
|
||||
{ x: 330.2, y: 80, width: 150.3, height: 400, dominantChange: "darker" },
|
||||
];
|
||||
const [move] = regionMoves(cardFrame(), cardFrame({ x: 330 }), regions, [undefined, undefined]);
|
||||
assert.deepEqual(move?.shift, { x: 270, y: 0 });
|
||||
});
|
||||
@@ -0,0 +1,86 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { chmod, mkdir, mkdtemp, readFile, realpath, rm, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
|
||||
import { sideAppearancePasses } from "../../dist/ci/pipeline.js";
|
||||
import { DEFAULT_MAX_SESSIONS, maxParallelTargets, planSideSessions, sessionShare } from "../../dist/ci/session-plan.js";
|
||||
import { validateExploreConfig } from "../../dist/config/explore-config.js";
|
||||
|
||||
test("the review-wide session ceiling is divided over the targets, the remainder going to the preferred ones", () => {
|
||||
const targets = ["iphone", "duo-closed", "duo-open", "android"];
|
||||
const prefer = target => target.startsWith("duo") ? 1 : 0;
|
||||
assert.equal(sessionShare({ maxSessions: 8, targets, target: "android" }), 2);
|
||||
assert.equal(sessionShare({ maxSessions: 16, targets, target: "iphone" }), 4);
|
||||
assert.equal(sessionShare({ maxSessions: 10, targets, target: "duo-closed", prefer }), 3, "remainder goes to the foldable first");
|
||||
assert.equal(sessionShare({ maxSessions: 10, targets, target: "duo-open", prefer }), 3);
|
||||
assert.equal(sessionShare({ maxSessions: 10, targets, target: "iphone", prefer }), 2);
|
||||
assert.equal(sessionShare({ maxSessions: 2, targets, target: "iphone" }), 1, "never below one");
|
||||
});
|
||||
|
||||
test("unset, the ceiling is a typical plan's five simulators; below the number of targets, that many target jobs run at once", () => {
|
||||
assert.equal(DEFAULT_MAX_SESSIONS, 5);
|
||||
// One target: head and base at once, with sessions left to split light and dark.
|
||||
assert.equal(sessionShare({ maxSessions: undefined, targets: ["iphone"], target: "iphone" }), 5);
|
||||
assert.deepEqual(planSideSessions({ share: 5, sides: 2, routes: 16, schemes: ["light", "dark"] }), { concurrentSides: true, passes: [["light"], ["dark"]] });
|
||||
// Two targets: two each, head and base at once, as before the option.
|
||||
for (const target of ["iphone", "android"]) assert.equal(sessionShare({ maxSessions: undefined, targets: ["iphone", "android"], target }), 2);
|
||||
// Five targets: one each, head then base.
|
||||
const five = ["iphone", "ipad", "duo-closed", "duo-open", "android"];
|
||||
for (const target of five) assert.equal(sessionShare({ maxSessions: undefined, targets: five, target }), 1);
|
||||
assert.equal(planSideSessions({ share: 1, sides: 2, routes: 16, schemes: ["light", "dark"] }).concurrentSides, false);
|
||||
assert.deepEqual([maxParallelTargets(undefined, 1), maxParallelTargets(undefined, 2), maxParallelTargets(undefined, 5), maxParallelTargets(undefined, 7)], [1, 2, 5, 5]);
|
||||
// A starter plan, one simulator per platform: an iOS and an Android target, one session each, both jobs at once.
|
||||
for (const target of ["iphone", "android"]) assert.equal(sessionShare({ maxSessions: 2, targets: ["iphone", "android"], target }), 1);
|
||||
assert.equal(maxParallelTargets(2, 2), 2);
|
||||
// A ceiling below the targets: one session each, and only that many target jobs at a time.
|
||||
for (const target of five) assert.equal(sessionShare({ maxSessions: 2, targets: five, target }), 1);
|
||||
assert.equal(maxParallelTargets(2, 5), 2);
|
||||
assert.equal(maxParallelTargets(16, 4), 4);
|
||||
});
|
||||
|
||||
test("a side splits its appearance passes only when the pass moved out saves at least a minute", () => {
|
||||
const euxy = { sides: 2, routes: 16, schemes: ["light", "dark"] };
|
||||
assert.deepEqual(planSideSessions({ share: 2, ...euxy }), { concurrentSides: true, passes: [["light", "dark"]] });
|
||||
assert.deepEqual(planSideSessions({ share: 4, ...euxy }), { concurrentSides: true, passes: [["light"], ["dark"]] });
|
||||
assert.deepEqual(planSideSessions({ share: 3, ...euxy }), { concurrentSides: true, passes: [["light", "dark"]] }, "one spare session cannot host a pass for both sides");
|
||||
assert.deepEqual(planSideSessions({ share: 8, ...euxy, routes: 3 }), { concurrentSides: true, passes: [["light", "dark"]] }, "three routes would save under a minute");
|
||||
assert.deepEqual(planSideSessions({ share: 8, ...euxy, schemes: ["light"] }), { concurrentSides: true, passes: [["light"]] }, "one appearance never splits");
|
||||
assert.deepEqual(planSideSessions({ share: 1, ...euxy }), { concurrentSides: false, passes: [["light", "dark"]] }, "one session: the sides take turns");
|
||||
assert.deepEqual(planSideSessions({ share: 2, sides: 1, routes: 16, schemes: ["light", "dark"] }), { concurrentSides: true, passes: [["light"], ["dark"]] }, "a baseline has one side");
|
||||
});
|
||||
|
||||
test("a side's appearances come from eas config in a child with the capture's environment, read only when a split could pay", async t => {
|
||||
const root = await mkdtemp(join(tmpdir(), "explore-session-plan-"));
|
||||
t.after(() => rm(root, { recursive: true, force: true }));
|
||||
// The app config would leak this process's environment if it were evaluated here.
|
||||
await writeFile(join(root, "app.config.js"), `module.exports = () => { require("fs").writeFileSync(${JSON.stringify(join(root, "evaluated"))}, "yes"); return {}; };\n`);
|
||||
const eas = join(root, "eas");
|
||||
await writeFile(eas, `#!/usr/bin/env node
|
||||
require("fs").appendFileSync(${JSON.stringify(join(root, "calls"))}, JSON.stringify({ args: process.argv.slice(2), cwd: process.cwd(), env: process.env }) + "\\n");
|
||||
process.stdout.write(JSON.stringify({ appConfig: { userInterfaceStyle: require("fs").existsSync("light-only") ? "light" : "automatic" }, buildProfile: {} }));
|
||||
`);
|
||||
await chmod(eas, 0o755);
|
||||
const calls = async () => (await readFile(join(root, "calls"), "utf8").catch(() => "")).split("\n").filter(Boolean).map(line => JSON.parse(line));
|
||||
const config = maxSessions => validateExploreConfig({ app: { bundleId: "com.example.app", easProfile: "explore" }, device: { name: "iPhone 17" },
|
||||
...(maxSessions === undefined ? {} : { capture: { maxSessions } }) });
|
||||
const environment = { PATH: process.env.PATH, HOME: process.env.HOME, EXPO_TOKEN: "expo-token", GITHUB_TOKEN: "github-token", ANTHROPIC_API_KEY: "agent-key" };
|
||||
const side = { share: 2, sides: 1, routes: 16, project: root, easCommand: eas };
|
||||
assert.equal(await sideAppearancePasses(config(8), environment, { ...side, routes: 3 }), undefined, "three routes would save under a minute");
|
||||
assert.equal(await sideAppearancePasses(config(1), environment, { ...side, share: 1 }), undefined);
|
||||
assert.deepEqual(await calls(), [], "no app config is read when no split could pay");
|
||||
assert.deepEqual(await sideAppearancePasses(config(2), environment, side), [["light"], ["dark"]]);
|
||||
const [call] = await calls();
|
||||
assert.deepEqual(call.args, ["config", "--platform", "ios", "--profile", "explore", "--json", "--non-interactive"]);
|
||||
assert.equal(await realpath(call.cwd), await realpath(root));
|
||||
assert.equal(call.env.EXPO_TOKEN, "expo-token");
|
||||
assert.equal(call.env.GITHUB_TOKEN, undefined);
|
||||
assert.equal(call.env.ANTHROPIC_API_KEY, undefined);
|
||||
await assert.rejects(readFile(join(root, "evaluated")), "the app config is never evaluated in the review's process");
|
||||
assert.deepEqual(await sideAppearancePasses(config(undefined), environment, side), [["light"], ["dark"]], "unset, the default ceiling's share splits too");
|
||||
// Each side reads its own app config: one that declares a single appearance keeps one session.
|
||||
const lightOnly = join(root, "base"); await mkdir(lightOnly); await writeFile(join(lightOnly, "light-only"), "");
|
||||
assert.equal(await sideAppearancePasses(config(2), environment, { ...side, project: lightOnly }), undefined);
|
||||
assert.equal(await sideAppearancePasses(config(2), environment, { ...side, easCommand: join(root, "missing-eas") }), undefined, "an unreadable config keeps one session");
|
||||
});
|
||||
@@ -59,3 +59,33 @@ test("a capture that ends without finishing its shared build releases the target
|
||||
assert.equal(error.code, "CAPTURE_BUILD_FAILED");
|
||||
assert.match(error.message, /the capture building it stopped \(CAPTURE_WORKER_EXITED\)/);
|
||||
});
|
||||
|
||||
test("a waiter is told the build is repacking only when its builder says so, not while a native build may run", async t => {
|
||||
const directory = await scratch(t);
|
||||
let started, repack, finish;
|
||||
const building = new Promise(resolve => { started = resolve; });
|
||||
const owner = sharedBuild({ directory, key, appName: "App.app", build: (_keepApp, repacking) => new Promise(resolve => {
|
||||
started(); repack = repacking; finish = () => resolve({ buildId: "native" }); }) });
|
||||
await building;
|
||||
const told = [];
|
||||
const waiter = sharedBuild({ directory, key, appName: "App.app", build: async () => assert.fail("only the owner builds"),
|
||||
waiting: () => told.push("waiting"), repacking: () => told.push("repacking") });
|
||||
// The owner is still in its native build: two polls go by without the waiter's session starting.
|
||||
await new Promise(resolve => setTimeout(resolve, 4_500));
|
||||
assert.deepEqual(told, ["waiting"]);
|
||||
await repack();
|
||||
await new Promise(resolve => setTimeout(resolve, 2_500));
|
||||
assert.deepEqual(told, ["waiting", "repacking"]);
|
||||
finish();
|
||||
await owner; await waiter;
|
||||
assert.deepEqual(told, ["waiting", "repacking"]);
|
||||
});
|
||||
|
||||
test("a waiter whose build finished before it looked is told it is repacking once, with the result", async t => {
|
||||
const directory = await scratch(t);
|
||||
await sharedBuild({ directory, key, appName: "App.app", build: async () => ({ buildId: "native" }) });
|
||||
const told = [];
|
||||
assert.deepEqual(await sharedBuild({ directory, key, appName: "App.app", build: async () => assert.fail("only the owner builds"),
|
||||
waiting: () => told.push("waiting"), repacking: () => told.push("repacking") }), { buildId: "native" });
|
||||
assert.deepEqual(told, ["waiting", "repacking"]);
|
||||
});
|
||||
@@ -82,6 +82,10 @@ test("visual diff data from a report is validated before the viewer draws it", (
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 2 }), { regions: [], ignoredStatusBarRegions: 2 });
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 0 }), { regions: [] });
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: "2" }), { regions: [] });
|
||||
const pill = { kind: "status-bar", x: 84.55, y: 12.24, width: 10.3, height: 10.62 };
|
||||
assert.deepEqual(visualDiff({ regions: [], ignoredStatusBarRegions: 1, systemRegions: [pill, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }] }),
|
||||
{ regions: [], ignoredStatusBarRegions: 1, systemRegions: [pill, { kind: "home-indicator", x: 0, y: 97, width: 100, height: 3 }] });
|
||||
assert.deepEqual(visualDiff({ regions: [], systemRegions: [{ kind: "notch", x: 0, y: 0, width: 10, height: 10 }, { ...pill, width: 0 }, { ...pill, x: 101 }, "pill"] }), { regions: [] });
|
||||
assert.equal(visualDiff({ regions: Array.from({ length: 200 }, () => PAYWALL[0]) }).regions.length, 64);
|
||||
});
|
||||
|
||||
|
||||
@@ -45,3 +45,12 @@ test("What changed summarizes a screen whose every area moved, per direction, an
|
||||
assert.equal(layoutShiftSummary([...moved, ...groupVisualRegions([region(90, 3)])]), undefined);
|
||||
assert.equal(layoutShiftSummary([]), undefined);
|
||||
});
|
||||
|
||||
test("the Viewer keeps a move hundreds of pixels long: a card recentred on a wide screen", async () => {
|
||||
const { visualDiff } = await tsImport("../../viewer/src/utils/review-model.ts", import.meta.url);
|
||||
const parsed = visualDiff({ regions: [{ x: 31.2, y: 21.2, width: 37.6, height: 70.3, share: 63, move: { x: 13.8, y: 0, amount: { x: 395, y: 0 }, unit: "pt" } }], allRegionsMoved: true });
|
||||
assert.deepEqual(parsed?.regions[0]?.move, { x: 13.8, y: 0, amount: { x: 395, y: 0 }, unit: "pt" });
|
||||
// An offset is a percent of the image and still bounded by it; the amount only by the review's own limit.
|
||||
assert.equal(visualDiff({ regions: [{ x: 1, y: 1, width: 10, height: 10, share: 50, move: { x: 140, y: 0, amount: { x: 395, y: 0 }, unit: "pt" } }] })?.regions[0]?.move, undefined);
|
||||
assert.equal(visualDiff({ regions: [{ x: 1, y: 1, width: 10, height: 10, share: 50, move: { x: 1, y: 0, amount: { x: 9000, y: 0 }, unit: "pt" } }] })?.regions[0]?.move, undefined);
|
||||
});
|
||||
@@ -93,3 +93,13 @@ test("doctor names a workflow that sets the app directory in one job but not ano
|
||||
assert.deepEqual(issues.map(issue => issue.code), ["WORKFLOW_APP_DIR_MISMATCH"]);
|
||||
assert.match(issues[0].message, /APP_PROJECT_DIR is \. in one of its jobs/);
|
||||
});
|
||||
|
||||
test("ci:after-capture stops the sessions a side's appearance passes recorded, not only the side's own", async t => {
|
||||
const output = await mkdtemp(join(tmpdir(), "explore-steps-sessions-"));
|
||||
t.after(() => rm(output, { recursive: true, force: true }));
|
||||
// Unreadable ids make the cleanup report each file it was handed without calling EAS.
|
||||
for (const name of ["head-session-dark", "base-session-dark", "baseline-session-light"]) await writeFile(join(output, name), "not a session id\n");
|
||||
await writeFile(join(output, "head-session-sepia"), "not a session id\n");
|
||||
const result = await cleanupAfterCapture({ output, checkouts: [], environment: { RUNNER_TEMP: output, EXPO_TOKEN: "token" } });
|
||||
assert.deepEqual(result.failures.map(failure => failure.message), Array(3).fill("Refusing an invalid session ID."));
|
||||
});
|
||||
@@ -31,8 +31,8 @@ export type ScreenScreenshotCardProps = {
|
||||
loading?: "eager" | "lazy";
|
||||
leading?: ReactNode;
|
||||
trailing?: ReactNode;
|
||||
/** Where the "Open in Inspector" tooltip sits: away from the route heading, which is above the screenshot on the Map. */
|
||||
tooltipPlacement?: "top" | "bottom";
|
||||
/** Say "Open in Inspector" in a tooltip over the screenshot (Screens). The Map's cards go without. */
|
||||
inspectorTooltip?: boolean;
|
||||
/** Short lines about the screen, inside the card after its screenshot (Screens: how it was reached, where else it changed). */
|
||||
note?: ReactNode;
|
||||
onClick: MouseEventHandler<HTMLButtonElement>;
|
||||
@@ -92,10 +92,10 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
|
||||
free of block children. */}
|
||||
<span className="screen-screenshot-slot">
|
||||
{props.leading}
|
||||
{/* With a pointer, what a click does is said once, zoom-independent, in the shared tooltip
|
||||
after its usual delay; the selected screen is already in the Inspector. The button has
|
||||
no title of its own, so no native tooltip joins it; the heading names the screen. */}
|
||||
<Tooltip label="Open in Inspector" placement={props.tooltipPlacement ?? "top"} disabled={Boolean(props.selected)}>
|
||||
{/* On Screens, with a pointer, what a click does is said once in the shared tooltip after
|
||||
its usual delay; the selected screen is already in the Inspector. The button has no
|
||||
title of its own, so no native tooltip joins it; the heading names the screen. */}
|
||||
<Tooltip label="Open in Inspector" placement="top" disabled={props.inspectorTooltip === false || Boolean(props.selected)}>
|
||||
<button
|
||||
type="button"
|
||||
className="screen-screenshot-target"
|
||||
|
||||
@@ -12,7 +12,8 @@ export type TransitionEdgeData = {
|
||||
transitionCount: number;
|
||||
active: boolean;
|
||||
primary: boolean;
|
||||
dimmed: boolean;
|
||||
/** Another screen is selected: the edge steps back to a hairline, so the selection's own stand out. */
|
||||
quiet: boolean;
|
||||
sourceOnly?: boolean;
|
||||
previousSource?: boolean;
|
||||
tooltip?: string;
|
||||
@@ -39,9 +40,10 @@ export function TransitionEdge(props: EdgeProps<TransitionGraphEdge>) {
|
||||
curvature: 0.24,
|
||||
});
|
||||
const emphasized = Boolean(props.data?.active || props.selected || hovered);
|
||||
const dimmed = Boolean(props.data?.dimmed && !emphasized);
|
||||
const quiet = Boolean(props.data?.quiet && !emphasized);
|
||||
const stroke = emphasized
|
||||
? "var(--accent)"
|
||||
: quiet ? "var(--border-subtle)"
|
||||
: props.data?.previousSource ? "var(--danger)" : props.data?.primary ? "var(--graph-line)" : "var(--graph-line-soft)";
|
||||
|
||||
return (
|
||||
@@ -66,9 +68,8 @@ export function TransitionEdge(props: EdgeProps<TransitionGraphEdge>) {
|
||||
style={{
|
||||
...props.style,
|
||||
stroke,
|
||||
strokeWidth: emphasized ? 2.2 : props.data?.primary ? 1.15 : 0.9,
|
||||
strokeWidth: emphasized ? 2.5 : quiet ? 1 : props.data?.primary ? 1.15 : 0.9,
|
||||
strokeDasharray: props.data?.sourceOnly ? "6 5" : emphasized || props.data?.primary ? undefined : "4 7",
|
||||
opacity: dimmed ? 0.12 : 1,
|
||||
}}
|
||||
/>
|
||||
</>
|
||||
|
||||
@@ -107,6 +107,13 @@ export function ZoomBridge(props: {
|
||||
publishZoom(Math.round(zoom * 100) / 100);
|
||||
}, [props.cameraReady, zoom]);
|
||||
|
||||
// What a stroke that must stay legible at any zoom divides by (the Map's selection ring). It
|
||||
// moves in quarter-octave steps, so a pinch restyles the canvas a few times, not every frame.
|
||||
const strokeZoom = 2 ** (Math.round(Math.log2(zoom) * 4) / 4);
|
||||
useEffect(() => {
|
||||
canvas?.style.setProperty("--canvas-zoom", String(strokeZoom));
|
||||
}, [canvas, strokeZoom]);
|
||||
|
||||
useEffect(() => {
|
||||
// Re-registering after selection changes publishes the new capability to the zoom menu.
|
||||
// Reading through getNodes keeps the commands themselves on the latest canvas snapshot.
|
||||
|
||||
@@ -308,11 +308,14 @@
|
||||
.compare-frame-wrap { position: relative; }
|
||||
/* Flip: one frame, centred under its Before/After names, in Compare and in the Inspector. The wrap
|
||||
is a flex row because a block sized by height + aspect-ratio does not shrink-wrap in every engine
|
||||
(WebKit left the frame at the left edge). */
|
||||
(WebKit left the frame at the left edge). A stacked landscape pair whose frames are held to part
|
||||
of the window's height centres them the same way. */
|
||||
.compare-stage.mode-flip .compare-side,
|
||||
.sidebar-review-stage.mode-flip .compare-side { width: 100%; align-items: center; }
|
||||
.sidebar-review-stage.mode-flip .compare-side,
|
||||
.sidebar-review-stage.mode-split.landscape .compare-side { width: 100%; align-items: center; }
|
||||
.compare-stage.mode-flip .compare-frame-wrap,
|
||||
.sidebar-review-stage.mode-flip .compare-frame-wrap { display: flex; justify-content: center; }
|
||||
.sidebar-review-stage.mode-flip .compare-frame-wrap,
|
||||
.sidebar-review-stage.mode-split.landscape .compare-frame-wrap { display: flex; justify-content: center; }
|
||||
.compare-frame {
|
||||
position: relative;
|
||||
display: block;
|
||||
@@ -496,6 +499,15 @@
|
||||
.sidebar-review-stage.mode-flip {
|
||||
--compare-frame-height: min(calc(100cqw / var(--compare-aspect)), 70dvh);
|
||||
}
|
||||
/* A landscape screenshot (an opened iPhone Duo, an iPad on its side) is too wide for two frames to
|
||||
share the panel: Before stacks over After, each the panel's width, up to about a third of
|
||||
the window's height (half of Swipe's and Flip's one frame), so a near-square pair (an unfolded
|
||||
foldable) and a short window still show both. */
|
||||
.sidebar-review-stage.mode-split.landscape {
|
||||
flex-direction: column;
|
||||
align-items: stretch;
|
||||
--compare-frame-height: min(calc(100cqw / var(--compare-aspect)), 35dvh);
|
||||
}
|
||||
/* Split's labels sit inside the frames here, as Swipe's do. */
|
||||
.compare-side-tag {
|
||||
position: absolute;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
|
||||
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, type CSSProperties, type ReactNode, type RefObject } from "react";
|
||||
import { ImageOff, ScanSearch } from "lucide-react";
|
||||
import type { ChangesMenuData } from "../panels/changes-menu";
|
||||
import { diffLabel, ACCESSIBILITY_ONLY_HIGHLIGHT, type BuildDiff, type ScreenDiff } from "../../utils/build-diff";
|
||||
@@ -12,7 +12,8 @@ import { usePhoneLayout } from "../../utils/phone-layout";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { DEFAULT_SCREENSHOT_RATIO, ScreenshotImage, ScreenshotPlaceholder } from "../shared/screenshot-image";
|
||||
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand, SwipeCompare, SWIPE_STEP } from "../panels/visual-diff";
|
||||
import { ChangeOutlines, ignoredSystemRegions, SwipeCompare, SystemRegionBands, SWIPE_STEP } from "../panels/visual-diff";
|
||||
import type { SystemRegion } from "../../utils/review-model";
|
||||
import { placeholderFor, presentedChanges, splitForAssistiveTechnology } from "../../utils/presented-changes";
|
||||
import { CompareNav, WhatChangedPopover } from "./compare-header";
|
||||
import "./compare-section.css";
|
||||
@@ -135,7 +136,19 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const [flipSide, setFlipSide] = useState<"before" | "after">("after");
|
||||
const [swipePosition, setSwipePosition] = useState(50);
|
||||
const [factsOpen, setFactsOpen] = useState(false);
|
||||
const [aspect, setAspect] = useState(DEFAULT_SCREENSHOT_RATIO);
|
||||
// The frame takes the recorded screenshot's shape at once, then the loaded image's (they agree
|
||||
// unless the report's record is off), so a landscape pair stacks before its pixels arrive. A
|
||||
// screen with no recorded size keeps the last screen's shape until its own image loads. After
|
||||
// decides, as it does for the recorded shape: Before's image counts only on a screen without one,
|
||||
// so a pair whose shape changed does not take whichever side loaded last.
|
||||
const [loadedAspect, setLoadedAspect] = useState<{ screenId: string; aspect: number }>();
|
||||
const aspect = (loadedAspect?.screenId === options.screenId ? loadedAspect.aspect : undefined)
|
||||
?? screenDiff?.screenshotAspect ?? loadedAspect?.aspect ?? DEFAULT_SCREENSHOT_RATIO;
|
||||
const hasAfter = Boolean(screenDiff?.afterScreenshot);
|
||||
const setAspect = useCallback((value: number, side: "before" | "after") => {
|
||||
if (side === "before" && hasAfter) return;
|
||||
setLoadedAspect({ screenId: options.screenId, aspect: value });
|
||||
}, [options.screenId, hasAfter]);
|
||||
|
||||
// Each screen starts whole: no area selected, After showing, the facts closed.
|
||||
useEffect(() => {
|
||||
@@ -255,6 +268,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const shownOutlines = outlines && areas.length > 0;
|
||||
const statusBarIgnored = (screenDiff?.visual?.ignoredStatusBarRegions ?? 0) > 0;
|
||||
const homeIndicatorIgnored = (screenDiff?.visual?.ignoredHomeIndicatorRegions ?? 0) > 0;
|
||||
const systemRegions = useMemo(() => ignoredSystemRegions(screenDiff?.visual), [screenDiff]);
|
||||
const modeOptions = compareModeOptions();
|
||||
// The switch shows the mode the reviewer chose, not the one-screenshot view a screen with nothing
|
||||
// to compare falls back to. Such a screen turns the whole switch off, with nothing current, so
|
||||
@@ -263,7 +277,7 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
const modesDisabled = !comparable;
|
||||
return {
|
||||
screen, screenDiff, route, position, previous, next, comparable, areas, facts, split, layoutShift, measurable,
|
||||
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, toggleOutlines,
|
||||
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines,
|
||||
activeArea, setActiveArea, stepArea, flipSide, flip, swipePosition, setSwipePosition,
|
||||
aspect, setAspect, factsOpen, setFactsOpen,
|
||||
};
|
||||
@@ -318,7 +332,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
const compare = useCompareController(props);
|
||||
const {
|
||||
screen, screenDiff, route, areas, facts, mode, chooseMode, modeOptions, outlines, shownOutlines,
|
||||
statusBarIgnored, homeIndicatorIgnored, toggleOutlines, activeArea, flipSide, flip, swipePosition, setSwipePosition, aspect,
|
||||
statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines, activeArea, flipSide, flip, swipePosition, setSwipePosition, aspect,
|
||||
setAspect, factsOpen, setFactsOpen,
|
||||
} = compare;
|
||||
const sectionRef = useRef<HTMLElement>(null);
|
||||
@@ -336,8 +350,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
const overlay = shownOutlines ? (
|
||||
<>
|
||||
<ChangeOutlines changes={areas} activeIndex={activeArea} />
|
||||
{statusBarIgnored ? <StatusBarBand /> : null}
|
||||
{homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
|
||||
<SystemRegionBands regions={systemRegions} />
|
||||
</>
|
||||
) : null;
|
||||
|
||||
@@ -390,8 +403,7 @@ export function CompareSection(props: CompareSectionProps) {
|
||||
areas={areas}
|
||||
activeArea={activeArea}
|
||||
showOutlines={shownOutlines}
|
||||
statusBarIgnored={statusBarIgnored}
|
||||
homeIndicatorIgnored={homeIndicatorIgnored}
|
||||
systemRegions={systemRegions}
|
||||
overlay={overlay}
|
||||
flipSide={flipSide}
|
||||
onFlip={flip}
|
||||
@@ -441,21 +453,25 @@ type StageProps = {
|
||||
areas: VisualChange[];
|
||||
activeArea: number | undefined;
|
||||
showOutlines: boolean;
|
||||
statusBarIgnored: boolean;
|
||||
homeIndicatorIgnored: boolean;
|
||||
systemRegions: readonly SystemRegion[];
|
||||
overlay: ReactNode;
|
||||
flipSide: "before" | "after";
|
||||
onFlip: () => void;
|
||||
swipePosition: number;
|
||||
onSwipePosition: (position: number) => void;
|
||||
aspect: number;
|
||||
onAspect: (aspect: number) => void;
|
||||
/** A screenshot of the stage loaded: its width over its height, and which side it shows. */
|
||||
onAspect: (aspect: number, side: "before" | "after") => void;
|
||||
};
|
||||
|
||||
export function CompareStage(props: StageProps) {
|
||||
const { diff } = props;
|
||||
const before = diff.beforeScreenshot;
|
||||
const after = diff.afterScreenshot;
|
||||
const [hoverIndex, setHoverIndex] = useState<number>();
|
||||
// An outline taken out from under the pointer reports no leave, so another screen, mode or outline
|
||||
// toggle drops the hover rather than lighting an area the pointer is not on.
|
||||
useLayoutEffect(() => setHoverIndex(undefined), [props.areas, props.mode, props.showOutlines]);
|
||||
if (!before && !after) {
|
||||
const reason = diff.captureNotes?.after ?? diff.captureNotes?.before;
|
||||
return (
|
||||
@@ -474,11 +490,11 @@ export function CompareStage(props: StageProps) {
|
||||
before={before}
|
||||
after={after}
|
||||
imageAspect={props.aspect}
|
||||
onAspect={props.onAspect}
|
||||
changes={props.areas}
|
||||
activeIndex={props.activeArea}
|
||||
showOutlines={props.showOutlines}
|
||||
statusBarIgnored={props.statusBarIgnored}
|
||||
homeIndicatorIgnored={props.homeIndicatorIgnored}
|
||||
systemRegions={props.systemRegions}
|
||||
position={props.swipePosition}
|
||||
onPositionChange={props.onSwipePosition}
|
||||
labels={props.swipeLabels !== "above"}
|
||||
@@ -514,7 +530,7 @@ export function CompareStage(props: StageProps) {
|
||||
<button type="button" className="compare-frame compare-flip-frame" data-side={showing}
|
||||
aria-label={`Show ${showing === "after" ? "Before" : "After"}`} onClick={props.onFlip}>
|
||||
<CompareImage src={showing === "after" ? after : before} alt={`${props.title}, ${showing}`}
|
||||
placeholder="No screenshot" onAspect={props.onAspect} />
|
||||
placeholder="No screenshot" side={showing} onAspect={props.onAspect} />
|
||||
{props.overlay}
|
||||
</button>
|
||||
</div>
|
||||
@@ -535,7 +551,7 @@ export function CompareStage(props: StageProps) {
|
||||
<div className="compare-frame-wrap">
|
||||
<div className="compare-frame">
|
||||
<CompareImage src={src} alt={`${props.title}, ${showing}`}
|
||||
placeholder={placeholderFor(showing, diff.status, diff.captureNotes)} onAspect={props.onAspect} />
|
||||
placeholder={placeholderFor(showing, diff.status, diff.captureNotes)} side={showing} onAspect={props.onAspect} />
|
||||
</div>
|
||||
</div>
|
||||
</figure>
|
||||
@@ -544,6 +560,21 @@ export function CompareStage(props: StageProps) {
|
||||
const sides = (["before", "after"] as const).filter((side) => (
|
||||
side === "before" ? diff.status !== "added" : diff.status !== "removed"
|
||||
));
|
||||
// Split outlines the changed areas on After, where the eye lands; Before keeps the same outlines
|
||||
// unseen, and shows one while its twin on After is hovered or the area is selected (J, K). A moved area keeps
|
||||
// its outline on Before, where its content was.
|
||||
// One frame, or no outlines, takes the caller's overlay as the other modes do.
|
||||
const paired = Boolean(before && after) && props.showOutlines && props.areas.length > 0;
|
||||
const sideOverlay = (side: "before" | "after"): ReactNode => {
|
||||
if (!paired) return props.overlay;
|
||||
return (
|
||||
<>
|
||||
<ChangeOutlines changes={props.areas} activeIndex={props.activeArea} hoverIndex={hoverIndex}
|
||||
reveal={side === "after" ? "linked" : "ghost"} onHover={side === "after" ? setHoverIndex : undefined} />
|
||||
<SystemRegionBands regions={props.systemRegions} />
|
||||
</>
|
||||
);
|
||||
};
|
||||
return (
|
||||
<>
|
||||
{sides.map((side) => {
|
||||
@@ -558,11 +589,11 @@ export function CompareStage(props: StageProps) {
|
||||
<div className="compare-frame">
|
||||
{src ? (
|
||||
<CompareImage src={src} alt={`${props.title}, ${side}`}
|
||||
placeholder={placeholderFor(side, diff.status, diff.captureNotes)} onAspect={props.onAspect} />
|
||||
placeholder={placeholderFor(side, diff.status, diff.captureNotes)} side={side} onAspect={props.onAspect} />
|
||||
) : (
|
||||
<ScreenshotPlaceholder label={placeholderFor(side, diff.status, diff.captureNotes)} />
|
||||
)}
|
||||
{src ? props.overlay : null}
|
||||
{src ? sideOverlay(side) : null}
|
||||
</div>
|
||||
{props.labels === "inside" ? (
|
||||
<span className={`compare-side-label compare-side-tag ${side}`}>{label}{note}</span>
|
||||
@@ -575,7 +606,10 @@ export function CompareStage(props: StageProps) {
|
||||
);
|
||||
}
|
||||
|
||||
function CompareImage(props: { src: string; alt: string; placeholder: string; onAspect: (aspect: number) => void }) {
|
||||
function CompareImage(props: {
|
||||
src: string; alt: string; placeholder: string; side: "before" | "after";
|
||||
onAspect: (aspect: number, side: "before" | "after") => void;
|
||||
}) {
|
||||
return (
|
||||
<ScreenshotImage
|
||||
src={props.src}
|
||||
@@ -586,7 +620,7 @@ function CompareImage(props: { src: string; alt: string; placeholder: string; on
|
||||
fallback={<ScreenshotPlaceholder label={props.placeholder} />}
|
||||
onLoad={(event) => {
|
||||
const { naturalWidth, naturalHeight } = event.currentTarget;
|
||||
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect(naturalWidth / naturalHeight);
|
||||
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect(naturalWidth / naturalHeight, props.side);
|
||||
}}
|
||||
/>
|
||||
);
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { type CSSProperties, type ReactNode } from "react";
|
||||
import { ChevronDown } from "lucide-react";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand } from "../panels/visual-diff";
|
||||
import { ChangeOutlines, SystemRegionBands } from "../panels/visual-diff";
|
||||
import { WhatChangedContent, type LayoutShift } from "./compare-header";
|
||||
import {
|
||||
CompareStage,
|
||||
@@ -110,8 +110,7 @@ export function SidebarReview(props: CompareControllerOptions) {
|
||||
? (
|
||||
<>
|
||||
<ChangeOutlines changes={areas} activeIndex={activeArea} />
|
||||
{compare.statusBarIgnored ? <StatusBarBand /> : null}
|
||||
{compare.homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
|
||||
<SystemRegionBands regions={compare.systemRegions} />
|
||||
</>
|
||||
)
|
||||
: null;
|
||||
@@ -123,7 +122,7 @@ export function SidebarReview(props: CompareControllerOptions) {
|
||||
<section className="sidebar-review" aria-label={`Changes in ${route}`}>
|
||||
<ReviewModes value={compare.chosenMode} disabled={compare.modesDisabled} onChange={compare.chooseMode} />
|
||||
|
||||
<div className={`compare-stage sidebar-review-stage mode-${mode}`}
|
||||
<div className={`compare-stage sidebar-review-stage mode-${mode}${compare.aspect > 1 ? " landscape" : ""}`}
|
||||
style={{ "--compare-aspect": compare.aspect } as CSSProperties}>
|
||||
{/* Before and After are named above the frames in every mode, as in Compare. */}
|
||||
<CompareStage
|
||||
@@ -135,8 +134,7 @@ export function SidebarReview(props: CompareControllerOptions) {
|
||||
areas={areas}
|
||||
activeArea={activeArea}
|
||||
showOutlines={compare.shownOutlines}
|
||||
statusBarIgnored={compare.statusBarIgnored}
|
||||
homeIndicatorIgnored={compare.homeIndicatorIgnored}
|
||||
systemRegions={compare.systemRegions}
|
||||
overlay={overlay}
|
||||
flipSide={compare.flipSide}
|
||||
onFlip={compare.flip}
|
||||
|
||||
@@ -18,7 +18,20 @@
|
||||
background: color-mix(in srgb, var(--modified) 22%, transparent);
|
||||
box-shadow: 0 0 0 3px color-mix(in srgb, var(--modified) 35%, transparent);
|
||||
}
|
||||
.visual-change-outlines.has-active .visual-change-outline:not(.active) { opacity: 0.35; }
|
||||
.visual-change-outlines.has-active .visual-change-outline:not(.active):not(.hovered) { opacity: 0.35; }
|
||||
/* Split's pair: linked outlines (After) take the pointer, and the hovered one reads as the selected one
|
||||
does; ghost outlines (Before) show nothing until their twin is hovered or the area is selected. An area
|
||||
that only moved keeps its outline on Before, where its content was, and a screen without hover (touch)
|
||||
keeps them all, as it has no way to reveal one. */
|
||||
.visual-change-outlines.linked .visual-change-outline { pointer-events: auto; cursor: default; }
|
||||
.visual-change-outline.hovered { background: color-mix(in srgb, var(--modified) 22%, transparent); box-shadow: 0 0 0 3px color-mix(in srgb, var(--modified) 35%, transparent); }
|
||||
.visual-change-outline.moved.hovered { background: color-mix(in srgb, var(--moved) 14%, transparent); box-shadow: 0 0 0 3px color-mix(in srgb, var(--moved) 30%, transparent); }
|
||||
@media (hover: hover) {
|
||||
.visual-change-outlines.ghost .visual-change-outline:not(.moved) { opacity: 0; transition: opacity 120ms ease, box-shadow 120ms ease, background-color 120ms ease; }
|
||||
.visual-change-outlines.ghost .visual-change-outline.hovered,
|
||||
.visual-change-outlines.ghost .visual-change-outline.active { opacity: 1; }
|
||||
.visual-change-outlines.ghost.has-active .visual-change-outline:not(.active):not(.hovered):not(.moved) { opacity: 0; }
|
||||
}
|
||||
/* An area that only moved: dashed and quiet, in the slate of a measurement rather than the orange of a change. */
|
||||
.visual-change-outline.moved {
|
||||
border: 1.5px dashed var(--moved);
|
||||
@@ -49,11 +62,11 @@
|
||||
Inspector's side-by-side pair. */
|
||||
.compare-side[data-side="before"], .compare-flip-frame[data-side="before"], [data-diff-side="before"] { --outline-before: 1; }
|
||||
|
||||
/* The status-bar band CI does not compare: blurred out, explained by its tooltip on hover. */
|
||||
/* The system-drawn areas CI does not compare (status bar, rail clock pill, home indicator): blurred out, each placed
|
||||
by its inline percentages, explained by its tooltip on hover. */
|
||||
.visual-status-bar-band {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
inset: 0 0 auto 0;
|
||||
background: rgba(127, 127, 127, 0.08);
|
||||
cursor: help;
|
||||
pointer-events: auto;
|
||||
@@ -62,7 +75,6 @@
|
||||
transition: background 120ms ease;
|
||||
}
|
||||
.visual-status-bar-band:hover { background: rgba(127, 127, 127, 0.2); }
|
||||
.visual-home-indicator-band { inset: auto 0 0 0; }
|
||||
|
||||
/* ── Swipe: one frame, Before left of the divider and After right of it ─── */
|
||||
|
||||
@@ -98,6 +110,10 @@
|
||||
pointer-events: none;
|
||||
}
|
||||
.visual-swipe-before { clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
|
||||
/* With a moved area, each side's outlines over its own half (see ChangeOutlines). */
|
||||
.visual-swipe-outlines { position: absolute; z-index: 1; inset: 0; pointer-events: none; }
|
||||
.visual-swipe-outlines.before { --outline-before: 1; clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
|
||||
.visual-swipe-outlines.after { clip-path: inset(0 0 0 var(--swipe-position)); }
|
||||
.visual-swipe .visual-change-outline { background: transparent; border-style: dashed; }
|
||||
.visual-swipe-divider {
|
||||
position: absolute;
|
||||
|
||||
@@ -3,6 +3,7 @@ import { ChevronsLeftRight } from "lucide-react";
|
||||
import { formatMove, outlineRect, type VisualChange } from "../../utils/visual-diff";
|
||||
import { useMeasurementsShown } from "../../utils/measurements-setting";
|
||||
import { HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM, STATUS_BAR_BAND_PERCENT } from "../../../../src/contracts/capture";
|
||||
import type { ReviewVisualDiff, SystemRegion } from "../../utils/review-model";
|
||||
import { ScreenshotImage } from "../shared/screenshot-image";
|
||||
import "./visual-diff.css";
|
||||
|
||||
@@ -14,11 +15,23 @@ import "./visual-diff.css";
|
||||
export function ChangeOutlines(props: {
|
||||
changes: readonly VisualChange[];
|
||||
activeIndex?: number | undefined;
|
||||
/** The outline under the pointer, on this frame or its twin; drawn as the selected one is. */
|
||||
hoverIndex?: number | undefined;
|
||||
/** Reports the outline under the pointer; with it the outlines take the pointer (see `reveal`). */
|
||||
onHover?: ((index: number | undefined) => void) | undefined;
|
||||
/**
|
||||
* How Split pairs its two frames: `linked` outlines (on After) take the pointer and report hovers;
|
||||
* `ghost` ones (on Before) sit at the same places unseen until one is hovered on After or selected; a moved
|
||||
* area's stays, where its content was, and a screen without hover shows them all. Without it every outline
|
||||
* shows, as on a single frame.
|
||||
*/
|
||||
reveal?: "all" | "ghost" | "linked";
|
||||
}) {
|
||||
const measurements = useMeasurementsShown();
|
||||
const reveal = props.reveal ?? "all";
|
||||
return (
|
||||
<span
|
||||
className={`visual-change-outlines${props.activeIndex !== undefined ? " has-active" : ""}`}
|
||||
className={`visual-change-outlines${props.activeIndex !== undefined ? " has-active" : ""}${reveal !== "all" ? ` ${reveal}` : ""}`}
|
||||
aria-hidden="true">
|
||||
{props.changes.map((change, index) => {
|
||||
const rect = outlineRect(change);
|
||||
@@ -28,7 +41,9 @@ export function ChangeOutlines(props: {
|
||||
return (
|
||||
<span
|
||||
key={index}
|
||||
className={`visual-change-outline${change.move ? " moved" : ""}${props.activeIndex === index ? " active" : ""}`}
|
||||
className={`visual-change-outline${change.move ? " moved" : ""}${props.activeIndex === index ? " active" : ""}${props.hoverIndex === index ? " hovered" : ""}`}
|
||||
onPointerEnter={props.onHover ? () => props.onHover!(index) : undefined}
|
||||
onPointerLeave={props.onHover ? () => props.onHover!(undefined) : undefined}
|
||||
style={{
|
||||
left: back(rect.x, change.move?.x),
|
||||
top: back(rect.y, change.move?.y),
|
||||
@@ -43,39 +58,60 @@ export function ChangeOutlines(props: {
|
||||
);
|
||||
}
|
||||
|
||||
const SYSTEM_REGION_COPY: Record<SystemRegion["kind"], { label: string; title: string }> = {
|
||||
"status-bar": { label: "Status bar, not compared",
|
||||
title: "The status bar (clock, signal, battery) differs between the captures. It is not counted as a change." },
|
||||
"home-indicator": { label: "Home indicator, not compared",
|
||||
title: "The home indicator at the bottom differs between the captures. It is not counted as a change." },
|
||||
};
|
||||
|
||||
/**
|
||||
* The band CI leaves out of the verdict, blurred out over the top of a screenshot. Shown only
|
||||
* when CI reports that it ignored differences there; hovering it says why the clocks disagree.
|
||||
* The parent must be positioned.
|
||||
* The system-drawn areas CI left out of the verdict for a screen: the ones the report names, or, for a report
|
||||
* from before it named them, the platform's bands where CI says it ignored something. Empty when nothing was ignored.
|
||||
*/
|
||||
export function StatusBarBand({ percent = STATUS_BAR_BAND_PERCENT }: { percent?: number }) {
|
||||
return (
|
||||
<span
|
||||
className="visual-status-bar-band"
|
||||
style={{ height: `${percent}%` }}
|
||||
role="img"
|
||||
aria-label="Status bar, not compared"
|
||||
title="The status bar (clock, signal, battery) differs between the captures. It is not counted as a change."
|
||||
/>
|
||||
);
|
||||
export function ignoredSystemRegions(visual: ReviewVisualDiff | undefined): SystemRegion[] {
|
||||
if (!visual) return [];
|
||||
const statusBar = (visual.ignoredStatusBarRegions ?? 0) > 0;
|
||||
const homeIndicator = (visual.ignoredHomeIndicatorRegions ?? 0) > 0;
|
||||
if (visual.systemRegions) return visual.systemRegions.filter((area) => (area.kind === "status-bar" ? statusBar : homeIndicator));
|
||||
return [
|
||||
...(statusBar ? [{ kind: "status-bar" as const, x: 0, y: 0, width: 100, height: STATUS_BAR_BAND_PERCENT }] : []),
|
||||
...(homeIndicator ? [{ kind: "home-indicator" as const, x: 0, y: 100 - HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios, width: 100, height: HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios }] : []),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* The same for the iOS home indicator, over the bottom of the screenshot: the system draws it in
|
||||
* whichever shade contrasts with the app underneath, so it changes without the app changing.
|
||||
* The areas CI leaves out of the verdict, blurred out over a screenshot: a status-bar band across the top of a
|
||||
* phone, the clock pill in a foldable's rail, the home indicator along the bottom. Shown only when CI reports
|
||||
* that it ignored differences there; hovering one says why. The parent must be positioned.
|
||||
*/
|
||||
export function HomeIndicatorBand({ percent = HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios }: { percent?: number }) {
|
||||
export function SystemRegionBands({ regions }: { regions: readonly SystemRegion[] }) {
|
||||
return (
|
||||
<span
|
||||
className="visual-status-bar-band visual-home-indicator-band"
|
||||
style={{ height: `${percent}%` }}
|
||||
role="img"
|
||||
aria-label="Home indicator, not compared"
|
||||
title="The home indicator at the bottom differs between the captures. It is not counted as a change."
|
||||
/>
|
||||
<>
|
||||
{regions.map((area, index) => (
|
||||
<span
|
||||
key={`${area.kind}:${index}`}
|
||||
className={`visual-status-bar-band visual-system-region-${area.kind}`}
|
||||
style={{ left: `${area.x}%`, top: `${area.y}%`, width: `${area.width}%`, height: `${area.height}%` }}
|
||||
role="img"
|
||||
aria-label={SYSTEM_REGION_COPY[area.kind].label}
|
||||
title={SYSTEM_REGION_COPY[area.kind].title}
|
||||
/>
|
||||
))}
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
/** The status-bar band of a phone, for callers without a report (fixtures, stories). */
|
||||
export function StatusBarBand({ percent = STATUS_BAR_BAND_PERCENT }: { percent?: number }) {
|
||||
return <SystemRegionBands regions={[{ kind: "status-bar", x: 0, y: 0, width: 100, height: percent }]} />;
|
||||
}
|
||||
|
||||
/** The iOS home indicator's band, for callers without a report. */
|
||||
export function HomeIndicatorBand({ percent = HOME_INDICATOR_BAND_PERCENT_BY_PLATFORM.ios }: { percent?: number }) {
|
||||
return <SystemRegionBands regions={[{ kind: "home-indicator", x: 0, y: 100 - percent, width: 100, height: percent }]} />;
|
||||
}
|
||||
|
||||
export const SWIPE_STEP = 5;
|
||||
|
||||
/**
|
||||
@@ -88,11 +124,13 @@ export function SwipeCompare(props: {
|
||||
before: string;
|
||||
after: string;
|
||||
imageAspect: number;
|
||||
/** After's screenshot loaded: its width over its height, for a frame shaped before it arrived. */
|
||||
onAspect?: (aspect: number, side: "after") => void;
|
||||
changes: readonly VisualChange[];
|
||||
activeIndex?: number | undefined;
|
||||
showOutlines?: boolean;
|
||||
statusBarIgnored?: boolean;
|
||||
homeIndicatorIgnored?: boolean;
|
||||
/** The system-drawn areas CI left out, blurred over both frames with the outlines. */
|
||||
systemRegions?: readonly SystemRegion[];
|
||||
position?: number;
|
||||
onPositionChange?: (position: number) => void;
|
||||
/** Before and After in the frame's bottom corners; off where the caller names them above the frame. */
|
||||
@@ -150,12 +188,21 @@ export function SwipeCompare(props: {
|
||||
onPointerUp={onPointerUp}
|
||||
onPointerCancel={onPointerUp}>
|
||||
<ScreenshotImage className="visual-swipe-after" src={props.after} alt={`${props.title}, after`}
|
||||
loading="eager" draggable={false} />
|
||||
loading="eager" draggable={false}
|
||||
onLoad={(event) => {
|
||||
const { naturalWidth, naturalHeight } = event.currentTarget;
|
||||
if (naturalWidth > 0 && naturalHeight > 0) props.onAspect?.(naturalWidth / naturalHeight, "after");
|
||||
}} />
|
||||
<ScreenshotImage className="visual-swipe-before" src={props.before} alt={`${props.title}, before`}
|
||||
loading="eager" draggable={false} />
|
||||
{props.showOutlines === false ? null : <ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} />}
|
||||
{props.statusBarIgnored && props.showOutlines !== false ? <StatusBarBand /> : null}
|
||||
{props.homeIndicatorIgnored && props.showOutlines !== false ? <HomeIndicatorBand /> : null}
|
||||
{props.showOutlines === false ? null : props.changes.some(change => change.move) ? (
|
||||
// A moved area sits where its content is on each side: Before's outlines left of the divider, After's right.
|
||||
<>
|
||||
<span className="visual-swipe-outlines before"><ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} /></span>
|
||||
<span className="visual-swipe-outlines after"><ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} /></span>
|
||||
</>
|
||||
) : <ChangeOutlines changes={props.changes} activeIndex={props.activeIndex} />}
|
||||
{props.systemRegions && props.showOutlines !== false ? <SystemRegionBands regions={props.systemRegions} /> : null}
|
||||
{props.labels === false ? null : (
|
||||
<>
|
||||
<span className="visual-swipe-label before" aria-hidden="true">Before</span>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { useRef, type CSSProperties, type MouseEvent, type ReactNode } from "react";
|
||||
import { List, ScanSearch } from "lucide-react";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
import { ChangeOutlines, HomeIndicatorBand, StatusBarBand } from "../panels/visual-diff";
|
||||
import { ChangeOutlines, SystemRegionBands } from "../panels/visual-diff";
|
||||
import { CompareNav, CompareSteps, WhatChangedContent } from "../compare/compare-header";
|
||||
import {
|
||||
CompareStage,
|
||||
@@ -41,8 +41,7 @@ export function PhoneCompare(props: CompareControllerOptions & {
|
||||
const overlay = compare.shownOutlines ? (
|
||||
<>
|
||||
<ChangeOutlines changes={areas} activeIndex={activeArea} />
|
||||
{compare.statusBarIgnored ? <StatusBarBand /> : null}
|
||||
{compare.homeIndicatorIgnored ? <HomeIndicatorBand /> : null}
|
||||
<SystemRegionBands regions={compare.systemRegions} />
|
||||
</>
|
||||
) : null;
|
||||
const facts = compare.split.visible.map((fact) => fact.copy);
|
||||
@@ -109,8 +108,7 @@ export function PhoneCompare(props: CompareControllerOptions & {
|
||||
areas={areas}
|
||||
activeArea={activeArea}
|
||||
showOutlines={compare.shownOutlines}
|
||||
statusBarIgnored={compare.statusBarIgnored}
|
||||
homeIndicatorIgnored={compare.homeIndicatorIgnored}
|
||||
systemRegions={compare.systemRegions}
|
||||
overlay={overlay}
|
||||
flipSide={compare.flipSide}
|
||||
onFlip={compare.flip}
|
||||
|
||||
@@ -31,6 +31,7 @@ import { arrowsOwnedBy, mapKeyDirection, mapKeyEntry, mapKeyTarget, type MapKeyD
|
||||
import { createKeyHold } from "../../utils/key-hold";
|
||||
|
||||
const HOVER_CLEAR_DELAY = 180;
|
||||
const PRESSABLE = 'button, a, summary, [role="button"]';
|
||||
const MAP_LAYOUT_REVISION = "flat-v1";
|
||||
const MAP_FIT_VIEW_OPTIONS = {
|
||||
padding: 0.04,
|
||||
@@ -115,8 +116,8 @@ function ScreenNodeCard({ data, selected }: NodeProps<ScreenGraphNode>) {
|
||||
imageHeight={data.screenshotSize?.imageHeight ?? data.frame.screen.height}
|
||||
placeholderSize={data.frame.screen}
|
||||
loading="lazy"
|
||||
// The route heads the card, so the tooltip goes below it.
|
||||
tooltipPlacement="bottom"
|
||||
// The ring says which screen is which; a click opening it in the Inspector needs no tooltip.
|
||||
inspectorTooltip={false}
|
||||
leading={<Handle type="target" position={horizontal ? Position.Left : Position.Top} className="graph-handle" />}
|
||||
trailing={<Handle type="source" position={horizontal ? Position.Right : Position.Bottom} className="graph-handle" />}
|
||||
onMouseEnter={() => data.onHover(data.screen.id)}
|
||||
@@ -342,8 +343,9 @@ function projectionElements(
|
||||
const edges: TransitionGraphEdge[] = structure.groups.map((group) => {
|
||||
const hierarchyEdge = structure.primaryEdgeKeys.has(group.key);
|
||||
const connected = group.from === selectedScreenId || group.to === selectedScreenId;
|
||||
const dimmed = false;
|
||||
const active = connected;
|
||||
// While a screen is selected, every other transition quiets to a hairline; cards never fade.
|
||||
const quiet = Boolean(selectedScreenId) && !connected;
|
||||
const sourceOnly = group.transitionIds.length === 0 && Boolean(group.sourceEdges?.length);
|
||||
const previousSource = group.sourceRevision === "baseline";
|
||||
const removed = previousSource || (!group.synthetic && diff?.screens.get(group.to)?.status === "removed");
|
||||
@@ -356,25 +358,26 @@ function projectionElements(
|
||||
const primary = hierarchyEdge;
|
||||
const stroke = active
|
||||
? "var(--accent)"
|
||||
: quiet ? "var(--border-subtle)"
|
||||
: removed ? "var(--danger)" : primary ? "var(--graph-line)" : "var(--graph-line-soft)";
|
||||
return {
|
||||
id: edgeElementId(group.key),
|
||||
source: group.from,
|
||||
target: group.to,
|
||||
type: "transition",
|
||||
className: `${hierarchyEdge ? "graph-edge-primary" : "graph-edge-secondary"}${sourceOnly ? " graph-edge-source" : ""}${previousSource ? " graph-edge-source-baseline" : ""}${active ? " graph-edge-active" : ""}${dimmed ? " graph-edge-dimmed" : ""}`,
|
||||
className: `${hierarchyEdge ? "graph-edge-primary" : "graph-edge-secondary"}${sourceOnly ? " graph-edge-source" : ""}${previousSource ? " graph-edge-source-baseline" : ""}${active ? " graph-edge-active" : ""}${quiet ? " graph-edge-quiet" : ""}`,
|
||||
markerEnd: {
|
||||
type: MarkerType.ArrowClosed,
|
||||
width: active || hierarchyEdge ? 14 : 11,
|
||||
height: active || hierarchyEdge ? 14 : 11,
|
||||
width: active || (hierarchyEdge && !quiet) ? 14 : 11,
|
||||
height: active || (hierarchyEdge && !quiet) ? 14 : 11,
|
||||
color: stroke,
|
||||
},
|
||||
style: {
|
||||
stroke,
|
||||
strokeWidth: active ? 2.2 : hierarchyEdge ? 1.15 : 0.9,
|
||||
strokeWidth: active ? 2.5 : quiet ? 1 : hierarchyEdge ? 1.15 : 0.9,
|
||||
strokeDasharray: !hierarchyEdge && !active && !removed ? "4 7" : undefined,
|
||||
},
|
||||
data: { label, transitionCount: group.transitionIds.length, active, primary, dimmed, sourceOnly, previousSource, ...(tooltip ? { tooltip } : {}) },
|
||||
data: { label, transitionCount: group.transitionIds.length, active, primary, quiet, sourceOnly, previousSource, ...(tooltip ? { tooltip } : {}) },
|
||||
// React Flow renders a positive edge z-index above root nodes. Keep every connection in
|
||||
// the base edge layer so selected/highlighted paths still pass behind screen imagery.
|
||||
zIndex: 0,
|
||||
@@ -433,7 +436,7 @@ function sameTransitionEdge(a: TransitionGraphEdge, b: TransitionGraphEdge) {
|
||||
&& a.data?.transitionCount === b.data?.transitionCount
|
||||
&& a.data?.active === b.data?.active
|
||||
&& a.data?.primary === b.data?.primary
|
||||
&& a.data?.dimmed === b.data?.dimmed;
|
||||
&& a.data?.quiet === b.data?.quiet;
|
||||
}
|
||||
|
||||
function reuseUnchangedElements(
|
||||
@@ -557,7 +560,8 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
}, [applyHover]);
|
||||
// The arrow keys (or h j k l) walk the map from the selected screen: along an edge in the
|
||||
// layout's flow, across to the neighbour on the same rank otherwise. With nothing selected they
|
||||
// enter the map at its edge, as on the Screens page. A held key keeps walking.
|
||||
// enter the map at its edge, as on the Screens page. A held key keeps walking. Return opens the
|
||||
// selection in the Inspector.
|
||||
const { selectedScreenId } = props;
|
||||
const selectedRef = useRef(selectedScreenId);
|
||||
selectedRef.current = selectedScreenId;
|
||||
@@ -568,22 +572,39 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
if (!structure) return undefined;
|
||||
return from ? mapKeyTarget(structure, from, direction) : mapKeyEntry(structure, direction);
|
||||
};
|
||||
// A click leaves the keyboard focus on the clicked screen's button, where Return would press it
|
||||
// and open that screen again. A walk lets go of it, so Return reaches the screen walked to.
|
||||
const walkTo = (id: string) => {
|
||||
const focused = document.activeElement;
|
||||
if (focused instanceof HTMLElement && surfaceRef.current?.contains(focused)) focused.blur();
|
||||
selectScreen(id);
|
||||
};
|
||||
const onKeyDown = (event: KeyboardEvent) => {
|
||||
hold.interrupt(event);
|
||||
if (event.repeat && hold.holding(event.code)) { event.preventDefault(); return; }
|
||||
if (event.defaultPrevented || !shortcutsLive(event) || arrowsOwnedBy(event.target)) return;
|
||||
if (event.key === "Enter") {
|
||||
// A focused button or link keeps its own Return; elsewhere on the page it opens the selection.
|
||||
const target = event.target instanceof Element ? event.target : null;
|
||||
const selected = selectedRef.current;
|
||||
if (!selected || event.isComposing || event.metaKey || event.ctrlKey || event.altKey || event.shiftKey) return;
|
||||
if (target && target !== document.body && (target.closest(PRESSABLE) || !surfaceRef.current?.contains(target))) return;
|
||||
event.preventDefault();
|
||||
selectScreen(selected);
|
||||
return;
|
||||
}
|
||||
const direction = mapKeyDirection(event);
|
||||
if (!direction) return;
|
||||
if (!structureRef.current) return;
|
||||
event.preventDefault();
|
||||
let at = move(direction, selectedRef.current);
|
||||
if (!at) return;
|
||||
selectScreen(at);
|
||||
walkTo(at);
|
||||
hold.begin(event.code, () => {
|
||||
const target = move(direction, at);
|
||||
if (!target) return false;
|
||||
at = target;
|
||||
selectScreen(target);
|
||||
walkTo(target);
|
||||
return true;
|
||||
});
|
||||
};
|
||||
@@ -636,9 +657,6 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
.sort((left, right) => left.depth - right.depth || left.y - right.y || left.x - right.x || left.index - right.index)
|
||||
.map(({ id }) => id), [layout.nodes]);
|
||||
const phone = usePhoneLayout();
|
||||
const selectedScreenVisible = Boolean(
|
||||
props.selectedScreenId && layout.nodes.some((node) => node.id === props.selectedScreenId),
|
||||
);
|
||||
if (props.map.screens.length === 0) {
|
||||
const blockers = props.map.gaps.filter((gap) => gap.status === "open" && !gap.screenId).map((gap) => gap.message);
|
||||
return (
|
||||
@@ -656,10 +674,7 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
<div ref={surfaceRef} className="connection-canvas-surface map-surface">
|
||||
<CanvasStage
|
||||
ariaLabel="Screen map"
|
||||
className={[
|
||||
"map-canvas",
|
||||
selectedScreenVisible ? "screen-selection-active" : "",
|
||||
].filter(Boolean).join(" ")}
|
||||
className="map-canvas"
|
||||
nodes={layout.nodes}
|
||||
edges={layout.edges}
|
||||
nodeTypes={NODE_TYPES}
|
||||
|
||||
@@ -593,6 +593,7 @@ export function publicReviewProjection(review: PublicReview): ViewerReviewProjec
|
||||
...(surface.visual?.mismatchPercentage !== undefined ? { mismatchPercentage: surface.visual.mismatchPercentage } : {}),
|
||||
...(surface.visual?.ignoredStatusBarRegions ? { ignoredStatusBarRegions: surface.visual.ignoredStatusBarRegions } : {}),
|
||||
...(surface.visual?.ignoredHomeIndicatorRegions ? { ignoredHomeIndicatorRegions: surface.visual.ignoredHomeIndicatorRegions } : {}),
|
||||
...(surface.visual?.systemRegions ? { systemRegions: surface.visual.systemRegions } : {}),
|
||||
...(surface.visual?.allRegionsMoved ? { allRegionsMoved: true } : {}),
|
||||
regions: (surface.visual?.regions ?? []).map((region) => {
|
||||
const move = regionMove(region, review.runtime.platform);
|
||||
@@ -634,6 +635,7 @@ export function publicReviewProjection(review: PublicReview): ViewerReviewProjec
|
||||
...(entry.visual.mismatchPercentage !== undefined ? { mismatchPercentage: entry.visual.mismatchPercentage } : {}),
|
||||
...(entry.visual.ignoredStatusBarRegions ? { ignoredStatusBarRegions: entry.visual.ignoredStatusBarRegions } : {}),
|
||||
...(entry.visual.ignoredHomeIndicatorRegions ? { ignoredHomeIndicatorRegions: entry.visual.ignoredHomeIndicatorRegions } : {}),
|
||||
...(entry.visual.systemRegions ? { systemRegions: entry.visual.systemRegions } : {}),
|
||||
regions: (entry.visual.regions ?? []).map((region) => ({ ...region.normalizedRect, share: region.shareOfDiffPercentage })),
|
||||
})
|
||||
: undefined;
|
||||
|
||||
+53
-40
@@ -110,7 +110,6 @@
|
||||
/* How far an item the Changes filter does not cover falls back. Low enough to read as
|
||||
background at a glance, high enough that the canvas keeps its shape. */
|
||||
--dim-out: 0.35;
|
||||
--hover-neighbour-frame: color-mix(in srgb, var(--accent) 55%, var(--border-subtle));
|
||||
--shadow-xs: 0 1px 3px rgba(0, 0, 0, 0.025), 0 1px 2px rgba(0, 0, 0, 0.05);
|
||||
--shadow-md: 0 10px 20px rgba(0, 0, 0, 0.1), 0 3px 6px rgba(0, 0, 0, 0.05);
|
||||
|
||||
@@ -461,6 +460,8 @@ code {
|
||||
--graph-line-soft: #c5c7ce;
|
||||
/* One flat fill for a group — no border, no second tone inside it. */
|
||||
--canvas-group: #f5f5f6;
|
||||
/* The ring a hovered Map card takes: a step past the border scale, short of the connectors. */
|
||||
--hover-ring: #b9bbc6;
|
||||
color: var(--text);
|
||||
background: var(--screen);
|
||||
}
|
||||
@@ -480,6 +481,7 @@ code {
|
||||
--graph-line: #696e77;
|
||||
--graph-line-soft: #3f4349;
|
||||
--canvas-group: #18191b;
|
||||
--hover-ring: #5a6169;
|
||||
}
|
||||
/* The canvas is a fixed map: dragging anywhere pans, while clicking an object selects it. */
|
||||
.graph-canvas .canvas-tool-pan,
|
||||
@@ -499,27 +501,14 @@ code {
|
||||
.graph-canvas .transition-edge-hitarea { cursor: pointer; pointer-events: stroke; }
|
||||
.graph-canvas .transition-edge-path { transition: stroke 100ms ease, stroke-width 100ms ease, opacity 140ms ease; }
|
||||
.graph-canvas .graph-edge-secondary { opacity: 0.72; }
|
||||
.graph-canvas .graph-edge-dimmed { opacity: 0.14; }
|
||||
.graph-canvas .graph-edge-active { opacity: 1; }
|
||||
.graph-canvas .react-flow__node { transition: opacity 180ms ease, filter 180ms ease; }
|
||||
.graph-canvas .canvas-focus-animating .react-flow__node { transition: none; }
|
||||
/* Focus: what the chosen state does not cover only steps back, so the map is still readable. */
|
||||
.graph-canvas .react-flow__node.graph-node-muted { opacity: var(--dim-out); --map-card-opacity: var(--dim-out); }
|
||||
/* A route-selected screenshot stays visually anchored while the surrounding screenshots recede.
|
||||
They fade as focus dims them, by opacity alone: a filter would grey the card's opaque backing.
|
||||
Summary cards retain their normal contrast so the selected screen's semantic context is legible. */
|
||||
.map-canvas.screen-selection-active .react-flow__node-screen:not(.selected) {
|
||||
opacity: var(--dim-out);
|
||||
--map-card-opacity: var(--dim-out);
|
||||
}
|
||||
.map-canvas.screen-selection-active .react-flow__node-screen:not(.selected):hover,
|
||||
.map-canvas.screen-selection-active .react-flow__node-screen:not(.selected):focus-within {
|
||||
opacity: 1;
|
||||
--map-card-opacity: 1;
|
||||
}
|
||||
/* Hover never recedes anything, but where focus or a selection has already dimmed the map, the
|
||||
hovered screen and the screens it connects to come back up, with the transitions between them,
|
||||
so the neighbourhood reads. These come after both dimming rules so the pointer's context wins. */
|
||||
/* Hover never recedes anything, but where the Changes filter has dimmed the map, the hovered
|
||||
screen and the screens it connects to come back up, with the transitions between them, so the
|
||||
neighbourhood reads. These come after the dimming rule so the pointer's context wins. */
|
||||
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related {
|
||||
opacity: 1;
|
||||
--map-card-opacity: 1;
|
||||
@@ -687,7 +676,7 @@ code {
|
||||
/* Hover and selection draw a 3px ring in the accent colour: the 1px border recoloured plus a 2px
|
||||
shadow outside it, so the image keeps its size (a thicker border would shrink the picture inside
|
||||
its box). Changed screens keep their own colour at the same weight: the diff rules below win on
|
||||
specificity. */
|
||||
specificity. The Map leaves the border to the status and rings the card from outside instead. */
|
||||
.screen-node-image:hover img,
|
||||
.screen-screenshot-card.selected .screen-node-image img { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
|
||||
.screen-node-image:hover > .image-placeholder,
|
||||
@@ -707,8 +696,8 @@ code {
|
||||
border-radius: 17px;
|
||||
pointer-events: none;
|
||||
}
|
||||
/* Selection needs no ring: the canvas dims every other screen. The highlight ring stays for the
|
||||
transient pointer-over state that panels project onto the canvas. */
|
||||
/* Selection needs no overlay: the Map rings the screenshot and Screens frames the card. The
|
||||
highlight ring stays for the transient pointer-over state that panels project onto the canvas. */
|
||||
.canvas-active-frame.is-highlighted::after {
|
||||
border-color: var(--accent);
|
||||
box-shadow: 0 0 24px color-mix(in srgb, var(--accent) 24%, transparent);
|
||||
@@ -723,10 +712,9 @@ code {
|
||||
pointer-events: none;
|
||||
}
|
||||
/* A screen's handles are ports on its frame: they take the frame colour, whether that is the
|
||||
status colour of a changed screen or the accent of a hovered or selected one, and a ring in
|
||||
the canvas colour keeps them legible as connection points on the border. */
|
||||
status colour of a changed screen or the accent of a selected one, and a ring in the canvas
|
||||
colour keeps them legible as connection points on the border. */
|
||||
.screen-screenshot-card { --screen-frame: var(--graph-line); }
|
||||
.screen-screenshot-card:has(.screen-node-image:hover),
|
||||
.screen-screenshot-card.selected,
|
||||
.screen-screenshot-card.highlighted { --screen-frame: var(--accent); }
|
||||
.screen-screenshot-card:is(.diff-added, .diff-modified, .diff-removed) { --screen-frame: var(--diff); }
|
||||
@@ -738,23 +726,48 @@ code {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
/* Hover is transient canvas state. Nothing recedes: the pointer's screen gets its ring, the
|
||||
transitions into and out of it turn accent, and the screens at their other ends take a tinted
|
||||
frame, so the neighbourhood reads without the rest of the map changing. Only the symmetric
|
||||
difference of related nodes/edges receives a class, avoiding a React commit across the graph. */
|
||||
.connection-canvas-surface.canvas-hovering .graph-edge-hover-related .transition-edge-path {
|
||||
stroke: var(--accent) !important;
|
||||
stroke-width: 2.2 !important;
|
||||
/* A Map card's border is its status alone. Selection rings it from outside instead: an accent
|
||||
ring past a gap in the canvas colour, outside the status border, with a soft lift; hover draws
|
||||
the same ring in grey. The ring scales with the canvas, so below a readable zoom its unit grows
|
||||
to keep it about a screen pixel and a half wide (--canvas-zoom, set by the zoom bridge). */
|
||||
.map-surface .screen-screenshot-card {
|
||||
--ring-unit: clamp(1px, 0.6px / var(--canvas-zoom, 1), 6px);
|
||||
--ring-status: 0px;
|
||||
}
|
||||
.map-surface .screen-screenshot-card:is(.diff-added, .diff-modified, .diff-removed) { --ring-status: 2px; }
|
||||
.map-surface .screen-screenshot-card .screen-node-image :is(img, .image-placeholder) {
|
||||
border-color: var(--border-subtle);
|
||||
box-shadow: none;
|
||||
}
|
||||
.map-surface .react-flow__node-screen:is(.selected, .graph-node-hover-subject) .screen-screenshot-card .screen-node-image :is(img, .image-placeholder) {
|
||||
box-shadow:
|
||||
0 0 0 var(--ring-status) var(--diff, transparent),
|
||||
0 0 0 calc(var(--ring-status) + 4 * var(--ring-unit)) var(--screen),
|
||||
0 0 0 calc(var(--ring-status) + 6.5 * var(--ring-unit)) var(--ring-color),
|
||||
var(--ring-lift, 0 0 transparent);
|
||||
}
|
||||
.map-surface .react-flow__node-screen.graph-node-hover-subject { --ring-color: var(--hover-ring); }
|
||||
.map-surface .react-flow__node-screen.selected {
|
||||
--ring-color: var(--accent);
|
||||
--ring-lift: 0 calc(10 * var(--ring-unit)) calc(28 * var(--ring-unit)) color-mix(in srgb, var(--accent) 18%, transparent);
|
||||
}
|
||||
.map-surface .react-flow__node-screen.selected .screen-node-title { color: var(--accent-strong); }
|
||||
/* Keyboard focus is dashed, past where a ring would sit, so it never reads as either. */
|
||||
.map-surface .screen-screenshot-target:focus-visible {
|
||||
outline: 2px dashed var(--accent-strong) !important;
|
||||
outline-offset: calc(var(--ring-status) + 9 * var(--ring-unit)) !important;
|
||||
filter: none !important;
|
||||
}
|
||||
|
||||
/* Hover is transient canvas state. Nothing recedes: the pointer's screen takes its grey ring and
|
||||
the transitions into and out of it darken. Only the symmetric difference of related
|
||||
nodes/edges receives a class, avoiding a React commit across the graph. A selected screen's
|
||||
transitions stay accent. */
|
||||
.connection-canvas-surface.canvas-hovering .graph-edge-hover-related:not(.graph-edge-active) .transition-edge-path {
|
||||
stroke: var(--tertiary) !important;
|
||||
stroke-width: 2 !important;
|
||||
stroke-dasharray: none !important;
|
||||
}
|
||||
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related:not(.graph-node-hover-subject)
|
||||
.screen-screenshot-card:not(.selected, .diff-added, .diff-modified, .diff-removed) {
|
||||
--screen-frame: var(--hover-neighbour-frame);
|
||||
}
|
||||
.connection-canvas-surface.canvas-hovering .react-flow__node-screen.graph-node-hover-related:not(.graph-node-hover-subject)
|
||||
.screen-screenshot-card:not(.selected, .diff-added, .diff-modified, .diff-removed) .screen-node-image :is(img, .image-placeholder) {
|
||||
border-color: var(--hover-neighbour-frame);
|
||||
}
|
||||
|
||||
/* Semantic Map: an area is a meaningful destination, never an anonymous "X states" step. */
|
||||
.semantic-summary-node {
|
||||
@@ -928,7 +941,7 @@ code {
|
||||
|
||||
/* The phone map's open hint. The first tap there only selects, so the pill sits in the middle of
|
||||
the selected screenshot (always on the image whatever the slot's shape) and says what the next
|
||||
tap does. In a wider window the card's tooltip carries the message and nothing covers the image. */
|
||||
tap does. In a wider window a click opens the Inspector at once and nothing covers the image. */
|
||||
.screen-screenshot-target { cursor: pointer; }
|
||||
.screen-open-hint {
|
||||
position: absolute;
|
||||
@@ -954,7 +967,7 @@ code {
|
||||
.screen-open-hint > svg { width: 14px; height: 14px; flex: none; }
|
||||
/* Only the phone layout's map shows the pill, on the selected screen, where a second tap or click
|
||||
opens the Inspector. That layout is a width, not a device, and has no tooltips, so a narrow
|
||||
desktop window shows it too. Elsewhere the screenshot button's tooltip says it instead. */
|
||||
desktop window shows it too. */
|
||||
.phone-layout .map-canvas .screen-screenshot-card.selected .screen-open-hint {
|
||||
display: inline-flex;
|
||||
animation: screen-open-hint-in 140ms ease-out;
|
||||
|
||||
@@ -52,6 +52,8 @@ export type ScreenDiff = {
|
||||
note?: string;
|
||||
beforeScreenshot?: string;
|
||||
afterScreenshot?: string;
|
||||
/** The compared screenshot's recorded width over its height (After's when it has one), so a frame takes its shape before it loads. */
|
||||
screenshotAspect?: number;
|
||||
/** The CI pixel comparison of the two screenshots, when both captures were verified. */
|
||||
visual?: ReviewVisualDiff;
|
||||
/** Why a side that exists in its revision has no screenshot. */
|
||||
@@ -335,6 +337,7 @@ export function buildDiff(options: {
|
||||
const after = screen.after
|
||||
? artifactUrl(screen.after.artifact, screen.after.buildId)
|
||||
: undefined;
|
||||
const recorded = recordedAspect(screen.after?.artifact) ?? recordedAspect(screen.before?.artifact);
|
||||
const reviewSurface = reviewSurfaceFor(review, [
|
||||
screen.id,
|
||||
screen.sourceScreenId,
|
||||
@@ -354,10 +357,15 @@ export function buildDiff(options: {
|
||||
};
|
||||
const baseDestination = destinationIn(baselineIndex);
|
||||
const headDestination = destinationIn(index);
|
||||
const borrowed = {
|
||||
before: baseDestination ? artifactUrl(screenshotForScreen(baseDestination, baselineIndex), baselineBuild.id) : undefined,
|
||||
after: headDestination ? artifactUrl(screenshotForScreen(headDestination, index)) : undefined,
|
||||
const borrowedArtifacts = {
|
||||
before: baseDestination ? screenshotForScreen(baseDestination, baselineIndex) : undefined,
|
||||
after: headDestination ? screenshotForScreen(headDestination, index) : undefined,
|
||||
};
|
||||
const borrowed = {
|
||||
before: baseDestination ? artifactUrl(borrowedArtifacts.before, baselineBuild.id) : undefined,
|
||||
after: headDestination ? artifactUrl(borrowedArtifacts.after) : undefined,
|
||||
};
|
||||
const screenshotAspect = recorded ?? recordedAspect(borrowedArtifacts.after) ?? recordedAspect(borrowedArtifacts.before);
|
||||
screens.set(screen.id, {
|
||||
status: screen.status,
|
||||
changeSummary: screen.changeSummary,
|
||||
@@ -370,6 +378,7 @@ export function buildDiff(options: {
|
||||
...(screen.status === "modified" && reviewSurface?.pixelsUnchanged ? { accessibilityOnly: true as const } : {}),
|
||||
...(before ?? borrowed.before ? { beforeScreenshot: (before ?? borrowed.before)! } : {}),
|
||||
...(after ?? borrowed.after ? { afterScreenshot: (after ?? borrowed.after)! } : {}),
|
||||
...(screenshotAspect ? { screenshotAspect } : {}),
|
||||
...(redirectTo && (borrowed.before || borrowed.after) ? { redirectTo } : {}),
|
||||
...(redirectTargets?.length ? { redirectTargets } : {}),
|
||||
...(screen.baselineScreenId ? { baselineScreenId: screen.baselineScreenId } : {}),
|
||||
@@ -384,12 +393,14 @@ export function buildDiff(options: {
|
||||
}
|
||||
|
||||
for (const screen of baselineContext) {
|
||||
const before = artifactUrl(screenshotForScreen(screen, baselineIndex), baselineBuild.id);
|
||||
const artifact = screenshotForScreen(screen, baselineIndex);
|
||||
const before = artifactUrl(artifact, baselineBuild.id);
|
||||
const screenshotAspect = recordedAspect(artifact);
|
||||
const reviewSurface = reviewSurfaceFor(review, [screen.id]);
|
||||
screens.set(baselineContextScreenId(baselineBuild.id, screen.id), {
|
||||
status: "not-compared", changeSummary: "Captured as navigation context in the previous revision; not compared.",
|
||||
...(reviewSurface?.note ? { note: reviewSurface.note } : {}),
|
||||
...(before ? { beforeScreenshot: before } : {}), baselineScreenId: screen.id,
|
||||
...(before ? { beforeScreenshot: before } : {}), ...(screenshotAspect ? { screenshotAspect } : {}), baselineScreenId: screen.id,
|
||||
reviewerChanges: reviewSurface?.reviewerChanges ?? [], runtimeEvidenceRefs: reviewSurface?.runtimeEvidenceRefs ?? [],
|
||||
noVisibleChange: false,
|
||||
});
|
||||
@@ -398,3 +409,8 @@ export function buildDiff(options: {
|
||||
return { baselineId: baselineBuild.id, screens, map, index,
|
||||
counts: { ...projection.counts, "not-compared": projection.counts["not-compared"] + baselineContext.length } };
|
||||
}
|
||||
|
||||
/** A screenshot's recorded width over its height, when the report recorded both. */
|
||||
function recordedAspect(artifact: Pick<Artifact, "width" | "height"> | undefined): number | undefined {
|
||||
return artifact?.width && artifact.height && artifact.width > 0 && artifact.height > 0 ? artifact.width / artifact.height : undefined;
|
||||
}
|
||||
@@ -95,8 +95,22 @@ export type ReviewVisualDiff = {
|
||||
ignoredStatusBarRegions?: number;
|
||||
/** Diff regions inside the home-indicator band (iOS, bottom) that CI left out of the verdict. */
|
||||
ignoredHomeIndicatorRegions?: number;
|
||||
/** The system-drawn areas CI left out, in percent of the screenshot; older reports name only the counts above. */
|
||||
systemRegions?: SystemRegion[];
|
||||
};
|
||||
|
||||
/** An area the system draws (status bar, home indicator), in percent of the screenshot's width and height. */
|
||||
export type SystemRegion = { kind: "status-bar" | "home-indicator"; x: number; y: number; width: number; height: number };
|
||||
|
||||
function systemRegion(value: unknown): SystemRegion | undefined {
|
||||
const candidate = record(value);
|
||||
if (!candidate || (candidate.kind !== "status-bar" && candidate.kind !== "home-indicator")) return undefined;
|
||||
const side = (entry: unknown) => (typeof entry === "number" && Number.isFinite(entry) && entry >= 0 && entry <= 100 ? entry : undefined);
|
||||
const x = side(candidate.x), y = side(candidate.y), width = side(candidate.width), height = side(candidate.height);
|
||||
if (x === undefined || y === undefined || width === undefined || height === undefined || width === 0 || height === 0) return undefined;
|
||||
return { kind: candidate.kind, x, y, width, height };
|
||||
}
|
||||
|
||||
/** Why a side that exists in its revision has no screenshot, as the report states it. */
|
||||
export type CaptureNotes = { before?: string; after?: string };
|
||||
|
||||
@@ -274,11 +288,17 @@ function visualDiffRegion(value: unknown): VisualDiffRegion | undefined {
|
||||
return { x, y, width, height, share, ...(move ? { move } : {}) };
|
||||
}
|
||||
|
||||
/** The farthest a published move may go, in screenshot pixels (the review contract's own limit). */
|
||||
const MAX_MOVE_AMOUNT = 8192;
|
||||
|
||||
function regionMove(value: unknown): RegionMove | undefined {
|
||||
const candidate = record(value);
|
||||
const amount = record(candidate?.amount);
|
||||
const finite = (entry: unknown): entry is number => typeof entry === "number" && Number.isFinite(entry) && Math.abs(entry) <= 100;
|
||||
if (!candidate || !amount || !finite(candidate.x) || !finite(candidate.y) || !finite(amount.x) || !finite(amount.y)
|
||||
// x and y place the outline in percent of the image; the amount is how far, in pixels or points, and a card
|
||||
// recentred on a wide screen moves hundreds.
|
||||
const within = (limit: number) => (entry: unknown): entry is number => typeof entry === "number" && Number.isFinite(entry) && Math.abs(entry) <= limit;
|
||||
const offset = within(100), distance = within(MAX_MOVE_AMOUNT);
|
||||
if (!candidate || !amount || !offset(candidate.x) || !offset(candidate.y) || !distance(amount.x) || !distance(amount.y)
|
||||
|| (candidate.unit !== "pt" && candidate.unit !== "px")) return undefined;
|
||||
return { x: candidate.x, y: candidate.y, amount: { x: amount.x, y: amount.y }, unit: candidate.unit };
|
||||
}
|
||||
@@ -294,8 +314,11 @@ export function visualDiff(value: unknown): ReviewVisualDiff | undefined {
|
||||
const count = (value: unknown) => (typeof value === "number" && Number.isInteger(value) && value > 0 ? value : undefined);
|
||||
const ignoredStatusBarRegions = count(candidate.ignoredStatusBarRegions);
|
||||
const ignoredHomeIndicatorRegions = count(candidate.ignoredHomeIndicatorRegions);
|
||||
const systemRegions = Array.isArray(candidate.systemRegions)
|
||||
? candidate.systemRegions.slice(0, MAX_VISUAL_REGIONS).flatMap((entry) => { const area = systemRegion(entry); return area ? [area] : []; }) : [];
|
||||
return {
|
||||
regions,
|
||||
...(systemRegions.length > 0 ? { systemRegions } : {}),
|
||||
...(candidate.allRegionsMoved === true && regions.length > 0 && regions.every((region) => region.move) ? { allRegionsMoved: true as const } : {}),
|
||||
...(mismatchPercentage !== undefined ? { mismatchPercentage } : {}),
|
||||
...(ignoredStatusBarRegions !== undefined ? { ignoredStatusBarRegions } : {}),
|
||||
|
||||
@@ -235,6 +235,7 @@ function familyEvidence(diffs: readonly ScreenDiff[]): {
|
||||
note?: string;
|
||||
beforeScreenshot?: string;
|
||||
afterScreenshot?: string;
|
||||
screenshotAspect?: number;
|
||||
visual?: ReviewVisualDiff;
|
||||
captureNotes?: CaptureNotes;
|
||||
redirectTo?: string;
|
||||
@@ -264,6 +265,7 @@ function familyEvidence(diffs: readonly ScreenDiff[]): {
|
||||
)];
|
||||
const metadata = {
|
||||
...(primary.note ? { note: primary.note } : {}),
|
||||
...(primary.screenshotAspect ? { screenshotAspect: primary.screenshotAspect } : {}),
|
||||
reviewerChanges,
|
||||
runtimeEvidenceRefs,
|
||||
noVisibleChange: diffs.some((diff) => diff.noVisibleChange),
|
||||
|
||||
Reference in new issue
Block a user