Compare commits

...
46 changed files with 2439 additions and 231 deletions

No files matched your search

+6 -1
View File
@@ -67,9 +67,12 @@ jobs:
shell: bash
env:
COMMENT_ID: ${{ steps.comment.outputs.id }}
# How long an alias can keep serving the previous push: an EAS Hosting edge that served it keeps it for about
# five minutes (FIXTURE_ALIAS_WAIT_MS in src/report/preview-deploy.ts).
ALIAS_CATCH_UP: 5 minutes
run: |
set -euo pipefail
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" '
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" --arg catchup "$ALIAS_CATCH_UP" '
.previewUrl as $url
| ([.reports[] | select(.platform == "android")] + [.reports[] | select(.platform != "android")]) as $reports
| ($reports[0].source // "") as $source
@@ -85,6 +88,8 @@ jobs:
| ((.label // (if .platform == "ios" then "iOS" else "Android" end)) | gsub("\\|"; "\\\\|")) as $name
| "| \($name)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?\($query)) · [Screens](\($url)?\($query)#/screens) · [Compare](\($url)?\($query)&view=compare) |"),
"",
# The alias still served the previous push when the deploy stopped waiting for it: say so, and link the new deployment.
(if .aliasBehind then "> **Going live:** this link can take up to \($catchup) to show \($sha); until then it shows the previous push, or nothing on a new pull request. [This push'"'"'s deployment](\(.deploymentUrl)/p/\($url | split("/p/")[1])) is live now.\n" else empty end),
"The link stays the same on every push. [Deploy run](\($run))"]
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
if [[ -n "$COMMENT_ID" ]]; then
+4 -4
View File
@@ -49,16 +49,16 @@ Each workflow starts with a `targets` job: it installs the pinned CLI and runs `
| | checkout `app-base`, `app-head` | Checks out the exact base and head SHAs with full history and without persisted credentials. |
| | Verify deterministic source planning | `source:verify` builds the capture plan from source alone in two fresh processes and compares the bytes. Runs before any build or simulator work and needs no credentials. |
| | Install app dependencies | `npm ci --ignore-scripts` in both checkouts (`APP_INSTALL_DIR` for monorepos). |
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a successful `explore-baseline-<base sha>-<target>` artifact (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
| | Find / Download optional exact-base evidence | `ci:find-baseline` looks for a finished run's `explore-baseline-<base sha>-<target>` artifact (a run another target's baseline failed in counts: a baseline job uploads its artifact only after its own steps passed) (target `ios` also accepts the older unsuffixed `explore-baseline-<base sha>`) from the baseline workflow on the default branch and downloads it as `EXPLORE_CAPTURE_CACHE`. Missing evidence is not an error. |
| | Capture review | `capture:review` (§3). `EXPO_TOKEN`, the provider key and the app's `{{secret:NAME}}` values reach only this step. The sticky PR comment is updated while it runs. It writes `preview=<hosting>` to the step outputs, which decides whether the deploy job runs. |
| | Stop capture sessions and check the checkouts | `ci:after-capture`, whenever the PR was resolved, success or not: stops the EAS Simulator sessions named in `head-session` / `base-session`, nothing else, then fails with `CHECKOUT_MODIFIED` if capture modified an app checkout. |
| | Upload captured review / diagnostics | `explore-capture-<run>-<attempt>-<target>` feeds the report job. On failure `explore-diagnostics-<run>-<attempt>-<target>` keeps plans, exports and agent diagnostics for 7 days. |
| report (matrix: target) | Install Explore, download the capture | Runs without Expo or model credentials. |
| report (matrix: target) | Download the capture, install Explore | Runs without Expo or model credentials, after every capture job, whether or not each succeeded (`!cancelled()`). Each leg downloads its own target's capture by an exact-name pattern: a target whose capture failed uploaded none, so its leg packages and publishes nothing, and the other targets' reports still reach the comment. |
| | Package hosted review bundle | `ci:report` writes the report directory. |
| | Upload hosted review bundle | `explore-review-<run>-<attempt>-<target>`, kept 30 days. |
| | Publish current PR hosted links | `ci:publish` re-checks that the artifact belongs to this PR, then updates the sticky comment with **Open** (the hosted Viewer) and **zip**. The comment is rendered from one hidden record per target (`<!-- expo-explore-record:<target>:… -->`, plus one history line for earlier runs); each job folds its own record into the ones the comment already carries and re-renders the whole comment, so parallel targets do not overwrite each other. Rows, report links and validation columns are labelled with the target's label (`iOS` and `Android` without `targets:`) and follow config order. |
| `deploy` (only when `report.preview` is set; after every report job) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every target's capture and report artifacts, writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only the failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with, and its label comes from the record the capture job already posted. |
| `deploy` (only when `report.preview` is set; after every report job, once any of them published) | Deploy the hosted preview | `ci:deploy --inputs --reports` downloads every capture and report artifact the run has (a target whose capture or report job failed has none and is left out), writes each report's manifest and screenshots as static files under the link's token, deploys them with the prebuilt preview Viewer to a dedicated EAS Hosting project (the only post-capture job holding `EXPO_TOKEN`), verifies that only `/p/<token>` answers, then updates the comment with **Explore report**. The link works as long as the EAS Hosting deployment. |
| failure | Report failure only on the current PR | Downloads whichever diagnostics exist and posts the failure comment to this PR alone, replacing only each failed target's record when the run has several; the target is the id the failed job's diagnostics artifact name ends with (or, when download-artifact extracted a lone artifact without its directory, the `target` its `error.json` records), and its label comes from the record the capture job already posted. Once the other targets published, the comment shows their reports and this failure, with no new-run line. |
A reviewer downloads the report ZIP and drops it on the hosted Viewer; downloading needs read access to the repository.
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@expo/explore",
"version": "0.20.0",
"version": "0.20.2",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@expo/explore",
"version": "0.20.0",
"version": "0.20.2",
"license": "MIT",
"dependencies": {
"@expo/repack-app": "0.10.1",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/explore",
"version": "0.20.0",
"version": "0.20.2",
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
"license": "MIT",
"type": "module",
+27 -3
View File
@@ -216,6 +216,21 @@ const KEYBOARD_DISMISS_LABELS = ["Hide keyboard", "Dismiss keyboard", "Done"];
const KEYBOARD_TOP = 0.4;
const ALERT_PREFERRED_BUTTONS = ["Open", "OK", "Allow", "Allow While Using App", "Continue"];
const READ_TOOLS = new Set(["ui-tree", "list-devices", "screenshot", "foreground-app", "await-screen-idle", "describe"]);
/**
* Argent 0.29's answer when a service a tool depends on (the device's simulator-server, its accessibility service) did
* not start: the registry resolves a tool's services before it calls the tool, and wraps a start failure as
* "[Tool:<id>] Service dependency failed: …", so the tool itself never ran and resending it is safe, a UI action too.
* The tools the bridge sends that resolve a service while they run (keyboard, fill, restart-app, screen-recording-start)
* resolve it before they act, and run-sequence answers a step's failure in its result rather than raising it. A failed
* start leaves the service in the registry's ERROR state, so the next call starts it afresh.
*/
const SERVICE_DEPENDENCY_FAILED = "Service dependency failed:";
/**
* In brentvatne/euxy#172 (review run 39348956443) capture restarted SpringBoard and folded the iPhone Duo open again 8 s
* later; that fold's simulator-server did not become ready within Argent's 30 s, and the whole target failed. The resend
* comes after a pause, so a device still coming back from the restart has the time it needs.
*/
const DEPENDENCY_RETRY_DELAYS_MS = [3_000, 6_000] as const;
const SPRINGBOARD = "com.apple.springboard";
const ANDROID_SYSTEM_UI = "com.android.systemui";
const OPEN_IN_APP_PROMPT = /^Open in “.+”\?$/;
@@ -299,14 +314,23 @@ export async function runBridgeCommand(argv: readonly string[], context: ArgentB
const { positional, flags } = parseCommand(rest);
const bundleFlag = typeof flags["bundle-id"] === "string" ? flags["bundle-id"] : context.bundleId;
/** Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check. */
/**
* Reads are resent after a transport failure (they change nothing); a UI action is sent once, after a health check.
* Any tool, a UI action too, is resent when Argent could not start a service it depends on, which it raises before
* the tool runs (see SERVICE_DEPENDENCY_FAILED).
*/
const call = async (tool: string, args: Record<string, unknown> = {}, options?: { out?: string }): Promise<Record<string, unknown>> => {
// Tools that name devices their own way (or none) take no udid.
const withDevice = tool === "list-devices" || tool === "stop-all-simulator-servers" ? args : { udid: state.udid, ...args };
for (let attempt = 0; ; attempt++) {
for (let readRetry = 0, dependencyRetry = 0; ;) {
try { return record(await context.call(tool, withDevice, options)); }
catch (error) {
if (READ_TOOLS.has(tool) && attempt < 2) { await context.sleep(1_000 * (attempt + 1)); continue; }
if (error instanceof ArgentCallError && error.message.includes(`[Tool:${tool}] ${SERVICE_DEPENDENCY_FAILED}`)
&& dependencyRetry < DEPENDENCY_RETRY_DELAYS_MS.length) {
await context.sleep(DEPENDENCY_RETRY_DELAYS_MS[dependencyRetry++]!);
continue;
}
if (READ_TOOLS.has(tool) && readRetry < 2) { await context.sleep(1_000 * ++readRetry); continue; }
throw error;
}
}
+10 -6
View File
@@ -454,6 +454,8 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
// `eas simulator:control` names the session by id, from the session's own project directory.
const sessionEas: EasCommand = (args, commandOptions) => runner({ command: options.easCommand, args, cwd: simulatorProject, environment: easEnvironment,
timeoutMs: commandOptions?.timeoutMs ?? 5 * 60_000, ...(commandOptions?.allowFailure ? { allowFailure: true } : {}) });
// A failed simulator:control action is sent again after a pause, which a test's clock replaces.
const controlOptions = { sleep: options.sleep };
// What the EAS session's host can do through simulator:control (iOS sessions on serve-sim 0.10.0 or later).
let controlActions = new Set<string>();
const configResult = eas(["config", "--platform", options.platform, "--profile", options.easProfile, "--json", "--non-interactive"]);
@@ -785,7 +787,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
"--platform", options.platform, "--json"], cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 15 * 60_000 });
// Before any link opens, as a local capture does with simctl: the app's own links then open without the prompt.
if (sessionId && scheme) {
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme]);
const approved = approveSessionUrlSchemes(sessionEas, sessionId, controlActions, options.bundleId, [scheme], controlOptions);
if (approved.length) say(`approved ${approved.map(item => `${item}://`).join(", ")} links on session ${sessionId}`);
}
}
@@ -796,8 +798,10 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
const target = deviceArgs({ platform: options.platform, deviceModel: options.device, ...(localDevice() ? { provider: "local-simulator" as const, controllerDeviceId: localDevice()! } : {}) });
// agent-device reads the hinge back after folding and fails to (locally and on EAS); its display is checked instead.
const easAgentDevice = !!sessionId && controller === "agent-device";
// Argent's bridge sends a fold again, twice, when the simulator-server it needs did not start within Argent's 30 s,
// so a fold can take three of those waits and the panel checks after it: 4 minutes covers that.
const fold = () => runner({ command: controllerCommand, args: ["fold", options.devicePose!, "--session", CONTROLLER_SESSION, ...target, "--platform", options.platform, "--json"],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 2 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 4 * 60_000, ...(localSimulator || easAgentDevice ? { allowFailure: true } : {}) });
const pause = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
if (localSimulator && controller === "argent") {
// Argent folds without a session and checks the fold against its own reader; this machine also checks the display.
@@ -844,7 +848,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
if (!controlActions.has("springboard.restart")) throw new CiError({ code: "CONTROLLER_FOLD_UNVERIFIED", stage: "session",
message: `${options.device} did not show the ${options.devicePose} display after folding.`, nextAction: "Rerun the capture on a new session." });
say(`${options.device} did not draw the ${options.devicePose} display after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
simulatorControl(sessionEas, sessionId, "springboard.restart");
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
pause(8_000);
open(true);
fold();
@@ -859,7 +863,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
catch (error) {
if (toCiError(error).code !== "CONTROLLER_FOLD_UNVERIFIED") throw error;
say(`Argent kept reading the other panel after the fold; restarting SpringBoard and folding ${options.devicePose} again`);
simulatorControl(sessionEas, sessionId, "springboard.restart");
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
pause(8_000);
try { fold(); }
catch (retry) {
@@ -892,7 +896,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
nextAction: "Rerun the capture; if it keeps happening, report it to Explore: this session's Argent tool-server needs a restart that EAS cannot do yet.", cause: error });
if (recovery === 1) {
say("Argent still did not read the app; restarting SpringBoard, then resetting Argent's device helpers and opening the app again");
simulatorControl(sessionEas, sessionId, "springboard.restart");
simulatorControl(sessionEas, sessionId, "springboard.restart", [], controlOptions);
// SpringBoard takes a moment to come back, and sends the app to the background; the next open brings it back.
(options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); }))(8_000);
} else say("Argent did not read the app after starting it; resetting Argent's device helpers and opening the app again");
@@ -944,7 +948,7 @@ async function executeCiMap(options: CiMapOptions, setStage: (stage: string) =>
// machine and serve-sim on an EAS iOS session; elsewhere its single pass runs as the device starts.
if (controller !== "argent") runner({ command: controllerCommand, args: [...appearanceArgs(colorScheme), "--session", CONTROLLER_SESSION, ...deviceArgs(runtime), "--platform", options.platform],
cwd: simulatorProject, environment: controllerEnvironment, timeoutMs: 60_000 });
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme]);
else if (sessionId && controlActions.has("appearance.set")) simulatorControl(sessionEas, sessionId, "appearance.set", [colorScheme], controlOptions);
else if (localSimulator) setLocalSimulatorAppearance({ runner, udid: localSimulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
else if (localEmulator) setLocalEmulatorAppearance({ runner, serial: localEmulator, scheme: colorScheme, cwd: simulatorProject, environment: restrictedEnvironment });
// A scheme change recreates the Android activity in place, and the sheets it re-presents lose their inset; a
+35 -5
View File
@@ -20,23 +20,53 @@ export function simulatorControlActions(eas: EasCommand, sessionId: string): Set
} catch { return new Set(); }
}
/** Runs one `eas simulator:control` action on the session; eas-cli fills in the device. Throws with EAS's reason. */
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = []): void {
/**
* Pauses before each resend of a failed action. Every action Explore runs is idempotent, and the session's host can fail
* one once: in brentvatne/euxy's baseline run 39348933440, `app.approveUrlScheme` failed in its `simctl spawn … defaults
* write`, which failed the dark-appearance session and with it the target's whole baseline.
*/
const SIMULATOR_CONTROL_RETRY_DELAYS_MS = [3_000, 6_000] as const;
/** Lets a test replace the pause between resends of a failed action. */
export type SimulatorControlOptions = { sleep?: ((milliseconds: number) => void) | undefined };
/**
* Runs one `eas simulator:control` action on the session; eas-cli fills in the device. A failed action is sent again
* after a pause; one that still fails throws with EAS's reason.
*/
export function simulatorControl(eas: EasCommand, sessionId: string, action: string, values: readonly string[] = [], options: SimulatorControlOptions = {}): void {
const sleep = options.sleep ?? (milliseconds => { Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, milliseconds); });
// Values follow `--` so one that starts with a dash is never read as a flag.
eas(["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values], { timeoutMs: 2 * 60_000 });
const args = ["simulator:control", action, "--id", sessionId, "--json", "--non-interactive", "--", ...values];
for (let retry = 0; ; retry += 1) {
try { eas(args, { timeoutMs: 2 * 60_000 }); return; }
catch (error) {
const delayMs = SIMULATOR_CONTROL_RETRY_DELAYS_MS[retry];
if (delayMs === undefined) throw error;
// A resend that succeeds would otherwise leave no trace of the failure in the job log.
process.stderr.write(`simulator:control ${action} failed (${firstLine(error)}); sending it again in ${delayMs / 1000} s\n`);
sleep(delayMs);
}
}
}
/**
* Lets the app open its own links without iOS asking "Open in “App”?" first, like local captures do with simctl. A
* session without the action keeps the controllers' prompt handling; http and https never prompt and are skipped.
*/
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[]): string[] {
export function approveSessionUrlSchemes(eas: EasCommand, sessionId: string, actions: ReadonlySet<string>, bundleId: string, schemes: readonly string[],
options: SimulatorControlOptions = {}): string[] {
if (!actions.has("app.approveUrlScheme")) return [];
const approved: string[] = [];
for (const scheme of new Set(schemes.map(value => value.toLowerCase()))) {
if (scheme === "http" || scheme === "https" || !/^[a-z][a-z0-9+.-]*$/.test(scheme)) continue;
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme]);
simulatorControl(eas, sessionId, "app.approveUrlScheme", [bundleId, scheme], options);
approved.push(scheme);
}
return approved;
}
/** The first line of a failure, for a log line. */
function firstLine(error: unknown): string {
return (error instanceof Error ? error.message : String(error)).split("\n", 1)[0]!.slice(0, 300);
}
+6 -3
View File
@@ -106,8 +106,11 @@ type GithubArtifact = { id: number; expired: boolean; workflow_run?: { id?: numb
type GithubRun = { conclusion: string | null; workflow_id: number; head_sha: string; head_branch: string; event: string; head_repository?: { full_name?: string } };
/**
* `ci:find-baseline`: the newest successful baseline-workflow artifact of exactly this commit, uploaded from the
* default branch of this repository. Its id and run go to the step outputs for actions/download-artifact.
* `ci:find-baseline`: the newest baseline-workflow artifact of exactly this commit, uploaded from the default branch of
* this repository by a finished run. Its id and run go to the step outputs for actions/download-artifact. A run that
* failed counts: a target's baseline job uploads its artifact only after every step before it passed, so another
* target's failure (one flaky simulator session, as in brentvatne/euxy#172) does not make this target's baseline
* unusable. A run still in progress or cancelled does not.
*/
export async function findBaselineArtifact(options: { sha: string; target?: string;
/** What callers from before targets pass: a platform is the id of its default target. */ platform?: string; environment?: Environment; transport?: typeof fetch }): Promise<{ id: number; run: number } | undefined> {
@@ -131,7 +134,7 @@ export async function findBaselineArtifact(options: { sha: string; target?: stri
for (const artifact of artifacts.filter(candidate => !candidate.expired).sort((a, b) => b.id - a.id)) {
if (!artifact.workflow_run?.id) continue;
const run = await githubGet<GithubRun>(`repos/${context.repository}/actions/runs/${artifact.workflow_run.id}`, context, transport);
if (!run || run.conclusion !== "success" || run.workflow_id !== workflow.id || run.head_sha !== options.sha
if (!run || (run.conclusion !== "success" && run.conclusion !== "failure") || run.workflow_id !== workflow.id || run.head_sha !== options.sha
|| run.head_branch !== repository.default_branch || !["push", "workflow_dispatch"].includes(run.event)
|| run.head_repository?.full_name !== context.repository) continue;
return { id: artifact.id, run: artifact.workflow_run.id };
+4
View File
@@ -5,6 +5,7 @@ import { resolve } from "node:path";
import { ExploreStore } from "./map/store.js";
import { QUERY_CONTRACT } from "./types.js";
import { EXPLORE_VERSION } from "./shared/package-paths.js";
import { isTargetId } from "./config/explore-config.js";
import { command, resultContract, argumentError, validateCommandArguments, flag, has, setStore } from "./cli/args.js";
import { help } from "./cli/help.js";
import { listScreens, getScreen, listElements, listObservations, getObservation, nextFrontier, listAttempts, getAttempt, listTransitions, getTransition, neighbors, pathQuery, listJourneys, getJourney, listFrontier, listGaps, summary, search, status, validate, exportArtifacts } from "./cli/map-commands.js";
@@ -81,8 +82,11 @@ try {
await handler();
} catch (error) {
if (command.startsWith("capture:") || command.startsWith("source:") || command.startsWith("ci:") || command.startsWith("config:")) {
// The failure comment names the target from this: a capture, report or publication of one matrix target.
const target = (() => { try { return flag("target"); } catch { return undefined; } })();
const diagnostic = await reportCiError(ciErrorForCommand(error, command), {
...(process.env.RUNNER_TEMP ? { diagnosticsPath: resolve(process.env.RUNNER_TEMP, "explore-diagnostics", "error.json") } : {}),
...(isTargetId(target) ? { target } : {}),
...(has("json") ? { write: (line: string) => { if (process.env.GITHUB_ACTIONS === "true") console.log(line); } } : {}),
});
if (has("json")) console.error(JSON.stringify({ contract: resultContract, command, ok: false, error: diagnostic.message, diagnostic }));
+11 -3
View File
@@ -8,6 +8,7 @@ import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPres
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
import { upsertStickyComment } from "./pr-comment.js";
import { retryGitHubLookup } from "./github-lookup.js";
import { previewLinks, viewerLinks } from "./viewer-links.js";
import type { PublicReview } from "../contracts/capture.js";
import { CiError, toCiError } from "../shared/ci-errors.js";
@@ -136,6 +137,8 @@ export async function publishCiReportComment(options: {
preview?: { url: string; expiresAt: number | null };
/** Set by `ci:deploy` when the hosted preview failed: the comment falls back to the central Viewer and the ZIP. */
previewFailed?: boolean;
/** Pause between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
sleep?: (milliseconds: number) => Promise<void>;
}) {
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
const input = await readInput(options.inputPath); const review = input.publicReview; const pr = review.pullRequest;
@@ -186,16 +189,21 @@ export async function publishCiReportComment(options: {
catch (error) { throw new CiError({ code: "GITHUB_RESPONSE_INVALID", stage: "publication",
message: "GitHub returned invalid report metadata.", nextAction: "Rerun publication; if the response remains invalid, inspect the GitHub metadata request.", cause: error }); }
};
const artifact = await api(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
// A lookup is made again when GitHub may answer it later: no answer, a 5xx, or a 404 from the Actions API, which may
// not list a just-uploaded artifact yet. A bad token, a missing permission or a rate limit fails at once, as before.
const lookup = (path: string) => retryGitHubLookup(() => api(path), error => error instanceof CiError
&& (error.code === "GITHUB_NETWORK_FAILED" || error.code === "GITHUB_REQUEST_FAILED" && error.retryable
|| error.code === "GITHUB_RESOURCE_NOT_FOUND" && path.startsWith("actions/")), options.sleep);
const artifact = await lookup(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${target ? `-${target}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
throw new CiError({ code: artifact.expired ? "REPORT_ARTIFACT_EXPIRED" : "REPORT_ARTIFACT_MISMATCH", stage: "publication",
message: "The uploaded report artifact is unavailable or belongs to another run",
nextAction: artifact.expired ? "Rerun Explore to upload a fresh report artifact." : "Pass the final report artifact from this workflow run and attempt." });
}
const attempt = await api(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
const attempt = await lookup(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
if (String(attempt.id) !== review.runId || String(attempt.run_attempt) !== review.runAttempt) throw new CiError({ code: "REPORT_RUN_MISMATCH", stage: "publication",
message: "Report run attempt mismatch", nextAction: "Publish the artifact and report input from the same current workflow attempt." });
const current = await api(`pulls/${pr.number}`);
const current = await lookup(`pulls/${pr.number}`);
if (current.state !== "open" || current.head?.repo?.full_name !== pr.repository || current.head?.ref !== pr.head.ref) {
throw new CiError({ code: "PR_CHANGED", stage: "publication", message: "PR closed or changed branches before the report artifact was ready",
nextAction: "Run Explore for the current PR head and base before publishing a ready report." });
+69 -41
View File
@@ -15,7 +15,7 @@ export type FailureCommentOptions = {
runAttempt: string;
/** The directory the failure job downloaded diagnostics artifacts into (`<stage>/<artifact>/…/error.json`). */
diagnosticsPath?: string;
/** The failed target's id; otherwise the one the first diagnostics artifact's name carries. */
/** The failed target's id; otherwise every target the diagnostics artifacts name. */
target?: string;
/** What callers from before targets pass: a platform is the id of its default target. */
platform?: ExplorePlatform;
@@ -25,6 +25,8 @@ export type FailureCommentOptions = {
};
type Diagnostic = { code: string; stage: string; message: string; nextAction: string };
/** A failed target's diagnostic. `target` is absent when neither the artifact's name nor the file names one. */
export type LocatedFailure = { diagnostic?: Diagnostic; target?: string; platform?: ExplorePlatform };
const SHA = /^[0-9a-f]{40}$/;
// `explore-<kind>-<run>-<attempt>-<target>`: the kind has no digits, so the first number is the run and the rest is the target id.
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
@@ -34,11 +36,14 @@ const MAX_DIAGNOSTIC_BYTES = 32_768;
const CODE = /^[A-Z][A-Z0-9_]{1,63}$/;
const STAGE = /^[a-z][a-z0-9-]{0,63}$/;
function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
function parseJson(text: string): Record<string, unknown> | undefined {
let parsed: unknown;
try { parsed = JSON.parse(text); } catch { return undefined; }
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return undefined;
const value = parsed as Record<string, unknown>;
return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed as Record<string, unknown> : undefined;
}
function parseDiagnostic(value: Record<string, unknown> | undefined, stage: string): Diagnostic | undefined {
if (!value) return undefined;
const field = (name: string, max: number) => typeof value[name] === "string" && (value[name] as string).trim() && (value[name] as string).length <= max ? value[name] as string : undefined;
const code = field("code", 64), message = field("message", 4000), nextAction = field("nextAction", 4000), stageName = field("stage", 64) ?? stage;
if (!code || !CODE.test(code) || !message || !nextAction || !STAGE.test(stageName)) return undefined;
@@ -46,32 +51,51 @@ function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
return { code, stage: stageName, message, nextAction };
}
/** Reads one error.json; `named` is the target its artifact directory names, else the one the file records. */
async function readFailure(path: string, stage: string, named: string | undefined): Promise<LocatedFailure | undefined> {
const info = await lstat(path).catch(() => undefined);
if (!info) return undefined;
const located = (target: string | undefined): LocatedFailure => ({ ...(target ? { target } : {}), ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) });
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located(named);
const value = parseJson(await readFile(path, "utf8"));
const target = named ?? (isTargetId(value?.target) ? value.target : undefined);
const diagnostic = parseDiagnostic(value, stage);
return diagnostic ? { diagnostic, ...located(target) } : located(target);
}
/**
* The error.json a failed job left behind and the target its artifact name carries (`ios` or `android` for a config
* without targets, and for artifacts of versions before targets). A report failure's diagnostic takes precedence over
* capture's; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
* Every failed target's error.json and the target it belongs to (`ios` or `android` for a config without targets, and
* for artifacts of versions before targets). actions/download-artifact puts each artifact a pattern matches in a
* directory named after it, except when the pattern matches exactly one: that one lands in the stage's directory
* itself, and the file names its target. A report failure's diagnostic takes precedence over its target's capture
* diagnostic; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
* regular files count (never symlinks out of the artifact). `platform` is set when the target id is a platform's.
*/
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; target: string; platform?: ExplorePlatform } | undefined> {
export async function locateFailureDiagnostics(root: string): Promise<LocatedFailure[]> {
const failures: LocatedFailure[] = [];
const seen = new Set<string>();
for (const [stage, file] of [["report", "error.json"], ["capture", join("explore-diagnostics", "error.json")]] as const) {
const entries = await readdir(join(root, stage), { withFileTypes: true }).catch(() => []);
for (const entry of entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
const path = join(root, stage, entry.name, file);
const info = await lstat(path).catch(() => undefined);
if (!info) continue;
const target = artifactTarget(entry.name)!;
const located: { target: string; platform?: ExplorePlatform } = { target, ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) };
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located;
const diagnostic = parseDiagnostic(await readFile(path, "utf8"), stage);
return diagnostic ? { diagnostic, ...located } : located;
const candidates = [...entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))
.map(entry => ({ path: join(root, stage, entry.name, file), named: artifactTarget(entry.name) })), { path: join(root, stage, file), named: undefined }];
for (const { path, named } of candidates) {
const located = await readFailure(path, stage, named);
if (!located || seen.has(located.target ?? "")) continue;
seen.add(located.target ?? "");
failures.push(located);
}
}
return undefined;
return failures;
}
/** The first failure locateFailureDiagnostics finds: a report failure before a capture failure. */
export async function locateFailureDiagnostic(root: string): Promise<LocatedFailure | undefined> {
return (await locateFailureDiagnostics(root))[0];
}
/**
* The failure job's comment: a job died outside Explore's own progress comments (install, checkout, a crash
* before the pipeline posted), so the sticky comment gets a failed record for that target from the same
* before the pipeline posted), so the sticky comment gets a failed record for each failed target from the same
* renderer every other writer uses. Nothing is posted when the PR is closed; a PR that moved on is marked
* superseded so the failure lands under previous runs.
*/
@@ -94,27 +118,31 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
return { posted: false, reason: "The PR is no longer an open same-repository PR." };
}
const superseded = pr.head?.sha !== options.headSha || pr.base?.sha !== options.baseSha;
const located = options.diagnosticsPath ? await locateFailureDiagnostic(options.diagnosticsPath) : undefined;
const target = requested ?? located?.target;
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
const configPath = options.configPath ?? ".expo-explore/config.yaml";
const now = Date.now();
const diagnostic = located?.diagnostic;
const state: PublicCommentState = {
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
startedAt: now, updatedAt: now, artifactOnly: true,
...(platform ? { build: { platform, easProfile: "" } } : {}),
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
...(superseded ? { superseded: true } : {}),
};
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
...platformSectionMerge(state, target), token, fetchImpl: transport });
const located = options.diagnosticsPath ? await locateFailureDiagnostics(options.diagnosticsPath) : [];
// Each failed target gets its own failed record: since one target's failed capture no longer stops the others'
// reports (brentvatne/euxy#172), several targets of one run can fail in different jobs.
const failures: LocatedFailure[] = requested !== undefined ? [{ ...(located.find(failure => failure.target === requested) ?? located[0]), target: requested }]
: located.length ? located : [{}];
for (const { target, diagnostic } of failures) {
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
const configPath = options.configPath ?? ".expo-explore/config.yaml";
const now = Date.now();
const state: PublicCommentState = {
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
startedAt: now, updatedAt: now, artifactOnly: true,
...(platform ? { build: { platform, easProfile: "" } } : {}),
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
...(superseded ? { superseded: true } : {}),
};
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
...platformSectionMerge(state, target), token, fetchImpl: transport });
}
return { posted: true, ...(superseded ? { superseded: true } : {}) };
}
+25
View File
@@ -0,0 +1,25 @@
/**
* Pauses between attempts of a GitHub lookup that may succeed later, 45 seconds in all. GitHub's Actions API is
* eventually consistent just after an upload: in brentvatne/euxy's review run 39348956443, the duo-closed report job's
* `actions/artifacts/<id>` answered 404 for the artifact that job had just uploaded, while the other four targets'
* jobs found theirs.
*/
const GITHUB_LOOKUP_RETRY_DELAYS_MS = [3_000, 6_000, 12_000, 24_000] as const;
/**
* Runs a read-only GitHub lookup again after each pause while `transient` says its failure may clear on its own. The
* caller decides what is transient; any other failure, or the last one, is thrown as it is.
*/
export async function retryGitHubLookup<T>(lookup: () => Promise<T>, transient: (error: unknown) => boolean,
sleep: (milliseconds: number) => Promise<void> = milliseconds => new Promise<void>(done => setTimeout(done, milliseconds))): Promise<T> {
for (let retry = 0; ; retry += 1) {
try { return await lookup(); }
catch (error) {
const delayMs = GITHUB_LOOKUP_RETRY_DELAYS_MS[retry];
if (delayMs === undefined || !transient(error)) throw error;
// A lookup that succeeds later would otherwise leave no trace of the failure in the job log.
process.stderr.write(`GitHub lookup failed (${(error instanceof Error ? error.message : String(error)).split("\n", 1)[0]}); trying again in ${delayMs / 1000} s\n`);
await sleep(delayMs);
}
}
}
+81 -20
View File
@@ -7,6 +7,7 @@ import { Uint8ArrayReader, Uint8ArrayWriter, ZipWriter, configure } from "@zip.j
import { loadReport, MAX_METADATA_BYTES } from "./agent-api.js";
import { MAX_ASSET_BYTES, manifestBody, PREVIEW_ASSET } from "./preview-manifest.js";
import { publishCiReportComment, readCiReportInput, type CiReportInput } from "./artifact.js";
import { retryGitHubLookup } from "./github-lookup.js";
import { readZipDirectory, readZipEntry } from "./zip-reader.js";
import { reviewChangeCount, reviewDevice } from "./pr-comment-body.js";
import { isTargetId, warnIgnoredExpiry, type ExplorePlatform } from "../config/explore-config.js";
@@ -54,7 +55,7 @@ export type PreviewDeployOptions = (PreviewReportInput | {
environment?: NodeJS.ProcessEnv;
transport?: typeof fetch;
run?: CommandRunner;
/** Pause between `eas deploy` attempts; tests replace it so retries take no real time. */
/** Pause between `eas deploy` attempts and between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
sleep?: (milliseconds: number) => Promise<void>;
/** The preview export (client/ and server/); defaults to the one shipped in this package. */
exportPath?: string;
@@ -386,7 +387,7 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
if (pr.origin !== "compare") for (const report of reports) {
try {
await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
...commentTarget(report), previewFailed: true });
...commentTarget(report), previewFailed: true, ...(options.sleep ? { sleep: options.sleep } : {}) });
} catch { /* the deployment failure is the one to report */ }
}
throw error;
@@ -398,7 +399,7 @@ export async function deployPreview(options: PreviewDeployOptions): Promise<Prev
let headSha = pr.head.sha;
if (pr.origin !== "compare") for (const report of reports) {
const published = await publishCiReportComment({ inputPath: report.entry.inputPath, artifactUrl: report.entry.artifactUrl, environment, transport,
...commentTarget(report), preview: { url: previewUrl, expiresAt: null } });
...commentTarget(report), preview: { url: previewUrl, expiresAt: null }, ...(options.sleep ? { sleep: options.sleep } : {}) });
headSha = published.headSha;
}
return { previewUrl, expiresAt: null, deploymentId: hosted.deploymentId, deploymentUrl: hosted.deploymentUrl,
@@ -435,7 +436,9 @@ async function writeCompareSummary(environment: NodeJS.ProcessEnv, comparison: C
}
type HostedReportInput = { zip: Uint8Array; sha256: string; file: string; query: string };
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string; project: string; owner: string };
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string;
/** The link is the alias, which still served an earlier deployment when the wait for it ran out. */
aliasBehind?: true; project: string; owner: string };
/** EAS Hosting alias names: lowercase slugs, as `eas deploy --alias` normalises them. */
export const HOSTING_ALIAS = /^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$/;
@@ -495,6 +498,13 @@ async function deployReports(options: {
alias?: string;
/** A caller-chosen `/p/<token>`; with `alias`, the hosted link is identical from one run to the next. */
token?: string;
/** How long the alias has to serve this deployment once the deployment does; `verifyTimeoutMs` by default. */
aliasWaitMs?: number;
/**
* Link the alias even when it still serves an earlier deployment after `aliasWaitMs`, for a link whose readers are
* told it can lag, rather than the deployment's own host.
*/
linkBehindAlias?: boolean;
sleep?: (milliseconds: number) => Promise<void>;
}): Promise<HostedDeployment> {
const { reports, project, environment, run, transport, now, random } = options;
@@ -571,7 +581,8 @@ async function deployReports(options: {
throw deployError("PREVIEW_DEPLOY_FAILED", `EAS Hosting deployed ${deploymentUrl.origin} but did not report the alias ${options.alias}.`,
"Check the deployment's aliases in the EAS Hosting dashboard and rerun.", { retryable: true, details: { project, owner, alias: options.alias } });
}
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, timeoutMs: options.verifyTimeoutMs, alias,
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, alias,
timeoutMs: alias ? options.aliasWaitMs ?? options.verifyTimeoutMs : options.verifyTimeoutMs,
reports: reports.map((report, index) => ({ query: report.query, ...written[index]! })),
...(listing ? { listing: JSON.stringify(listing.map(({ path: _path, ...rest }) => rest)) } : {}) });
const seconds = (milliseconds: number) => `${Math.round(milliseconds / 1000)} s after eas deploy returned`;
@@ -581,7 +592,9 @@ async function deployReports(options: {
// taken longer than the whole budget (every verification failure of 2026-10-14 was the alias, with the deployment
// serving in 1 s). The deployment is verified and immutable, so when the alias is still behind the pull request
// links the deployment instead of failing the job; the alias catches up on its own and the next push relinks it.
// With `linkBehindAlias` it links the alias anyway, and its readers are told the link can lag.
let linkOrigin = deploymentUrl.origin;
let aliasBehind = false;
if (aliasUrl) {
try {
const alias = await verify(aliasUrl.origin, true);
@@ -589,12 +602,16 @@ async function deployReports(options: {
linkOrigin = aliasUrl.origin;
} catch (error) {
if ((error as { code?: string }).code !== "PREVIEW_ALIAS_BEHIND") throw error;
process.stderr.write(`::warning::${(error as Error).message} The pull request links the deployment ${deploymentUrl.origin} instead.\n`);
aliasBehind = Boolean(options.linkBehindAlias);
if (aliasBehind) linkOrigin = aliasUrl.origin;
process.stderr.write(`::warning::${(error as Error).message} ${aliasBehind
? `The pull request links it anyway, until it catches up, beside the deployment ${deploymentUrl.origin}.`
: `The pull request links the deployment ${deploymentUrl.origin} instead.`}\n`);
}
}
const previewUrl = `${linkOrigin}/p/${token}`;
return { previewUrl, expiresAt: null, deploymentId: deployment.identifier!, deploymentUrl: deploymentUrl.origin,
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), project, owner };
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), ...(aliasBehind ? { aliasBehind: true as const } : {}), project, owner };
} finally {
await rm(work, { recursive: true, force: true });
}
@@ -668,8 +685,20 @@ export type FixturePreviewOptions = {
random?: (bytes: number) => Uint8Array;
onSecret?: (secret: string) => void;
verifyTimeoutMs?: number;
/** How long the alias has to serve the new deployment before the link is the alias anyway; FIXTURE_ALIAS_WAIT_MS by default. */
aliasWaitMs?: number;
};
/**
* How long a fixture preview waits for its alias. An edge of EAS Hosting that served an alias keeps serving the
* deployment it named for about five minutes (307–314 s, measured 2026-10-19 redeploying back to back from one machine),
* so a deploy whose check reaches an edge that served the alias in the last five minutes, to the previous deploy's check
* or to a reviewer, finds it behind; otherwise it has moved within seconds. Waiting the whole verification budget for
* that held a third of the pull requests' deploy jobs for three minutes, only to link the deployment instead. The pull
* request's comment says when the alias is behind.
*/
export const FIXTURE_ALIAS_WAIT_MS = 20_000;
/**
* Host fixed reports behind a fixed alias with this checkout's Viewer: the Explore repository's own pull requests
* preview their Viewer changes on real data. No GitHub token, no expiry; each run replaces what the alias serves.
@@ -697,6 +726,7 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
projectHint: "Give EXPO_TOKEN's account permission to create projects, or pass --project with an existing slug.",
exportPath, environment, run: options.run ?? defaultRun, ...(options.sleep ? { sleep: options.sleep } : {}), transport: options.transport ?? fetch, now: options.now ?? Date.now, random,
...(options.onSecret ? { onSecret: options.onSecret } : {}), verifyTimeoutMs: options.verifyTimeoutMs ?? 180_000, alias: options.alias,
aliasWaitMs: options.aliasWaitMs ?? FIXTURE_ALIAS_WAIT_MS, linkBehindAlias: true,
...(options.token ? { token: options.token } : {}) });
}
@@ -760,23 +790,43 @@ export async function deployLocalReports(options: {
/** explore-(capture|review)-<run>-<attempt>-<target id>; the id starts with a letter, so the run and attempt end unambiguously. */
const ARTIFACT_DIRECTORY = /^explore-(capture|review)-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
/**
* The target a lone artifact holds. actions/download-artifact puts each artifact a pattern matches in a directory named
* after it, except when the pattern matches exactly one, which it extracts into the download path itself: then only the
* report names its target (its platform for configs without targets).
*/
async function unnamedArtifactTarget(root: string, kind: "capture" | "review"): Promise<string | undefined> {
const file = join(root, kind === "capture" ? "report-input.json" : "review.json");
if (!(await lstat(file).catch(() => undefined))?.isFile()) return undefined;
const runtime = kind === "capture" ? (await readCiReportInput(file)).publicReview.runtime
: (JSON.parse(await readFile(file, "utf8")) as Partial<ArtifactReport>).review?.runtime;
const id = readTarget(runtime?.target)?.id ?? runtime?.platform;
return isTargetId(id) ? id : undefined;
}
/**
* The fan-in deploy job's inputs: actions/download-artifact puts each explore-capture-<run>-<attempt>-<target>
* directory under --inputs and each explore-review-… directory under --reports (the target is the platform for
* configs without targets). Pairs them by target, in the order the run's review lists its targets, and looks up each
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward.
* report artifact's URL on the run, since matrix jobs cannot hand their artifact URLs forward. A target whose capture
* failed uploaded no capture artifact, and one whose report job failed no report artifact: the preview serves the
* targets that have both, and the review workflow's failure job names the others on the comment.
*/
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch }): Promise<PreviewReportInput[]> {
export async function collectPlatformReports(options: { inputsPath: string; reportsPath: string; environment?: NodeJS.ProcessEnv; transport?: typeof fetch;
/** Pause between artifact lookups that may succeed later; tests replace it so retries take no real time. */
sleep?: (milliseconds: number) => Promise<void> }): Promise<PreviewReportInput[]> {
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
const directories = async (root: string, kind: "capture" | "review") => {
const found = new Map<string, string>();
for (const name of (await readdir(root)).sort()) {
// A pattern that matched nothing leaves no directory behind.
for (const name of (await readdir(root).catch(() => [] as string[])).sort()) {
const match = ARTIFACT_DIRECTORY.exec(name);
if (!match || match[1] !== kind || !isTargetId(match[2])) continue;
if (found.has(match[2]!)) throw previewError("PREVIEW_REPORTS_INVALID", `Several ${kind} artifacts for ${match[2]} were downloaded`,
"Download only this run attempt's artifacts into the --inputs and --reports directories.");
found.set(match[2]!, join(root, name));
}
if (!found.size) { const id = await unnamedArtifactTarget(root, kind); if (id) found.set(id, root); }
return found;
};
const inputs = await directories(options.inputsPath, "capture"); const reports = await directories(options.reportsPath, "review");
@@ -787,8 +837,9 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
const entries: PreviewReportInput[] = [];
for (const [id, inputDirectory] of inputs) {
const reportPath = reports.get(id);
if (!reportPath) throw previewError("PREVIEW_REPORTS_INCOMPLETE", `The ${id} capture has no report artifact to deploy`,
"Rerun the workflow; the report job for that target did not upload its explore-review artifact.");
// In brentvatne/euxy#172 (review run 39348956443) one target's failed job kept every other target's report off the
// PR; a target without a report is left out of the preview instead.
if (!reportPath) { process.stderr.write(`The ${id} capture has no report artifact (its report job failed), so the preview leaves it out.\n`); continue; }
const inputPath = join(inputDirectory, "report-input.json");
const runtime = (await readCiReportInput(inputPath)).publicReview.runtime;
// A report from before targets names only its platform, and its artifact is named after it.
@@ -798,6 +849,8 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
const target = named ?? (id === "ios" || id === "android" ? platformTarget(id) : { id, platform: runtime.platform ?? "ios", label: id });
entries.push({ ...(id === target.platform ? { platform: target.platform } : {}), target, inputPath, reportPath, artifactUrl: "" });
}
if (!entries.length) throw previewError("PREVIEW_REPORTS_INCOMPLETE", "No target's capture has a report artifact to deploy",
"Rerun the workflow; the report jobs did not upload their explore-review artifacts.");
// Config order, as the review lists its targets (or, before targets, its platforms); directory order otherwise.
const listed = (await readCiReportInput(entries[0]!.inputPath)).publicReview.runtime;
const order: string[] = listed.targets?.map(target => target.id) ?? listed.platforms ?? [];
@@ -812,14 +865,22 @@ export async function collectPlatformReports(options: { inputsPath: string; repo
for (const entry of entries) {
const name = `explore-review-${review.runId}-${review.runAttempt}-${entry.target!.id}`;
const url = `https://api.github.com/repos/${repository}/actions/runs/${review.runId}/artifacts?per_page=100&name=${encodeURIComponent(name)}`;
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
const body = response.ok ? await response.json() as { artifacts?: Array<{ id?: unknown; name?: unknown; expired?: unknown }> } : undefined;
const artifact = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
if (!artifact || typeof artifact.id !== "number" || !Number.isSafeInteger(artifact.id) || artifact.id <= 0) {
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true });
}
// The run's artifact list can lag an upload, as the artifact lookup of a report job's publication does, so an
// empty list, a 404, a 5xx or no answer is looked up again; a bad token or a missing permission fails at once.
const artifact = await retryGitHubLookup(async () => {
const response = await transport(url, { headers: { accept: "application/vnd.github+json", authorization: `Bearer ${environment.GITHUB_TOKEN ?? ""}`,
"x-github-api-version": "2022-11-28" }, signal: AbortSignal.timeout(60_000) });
const body = response.ok ? await response.json() as { artifacts?: Array<{ id?: unknown; name?: unknown; expired?: unknown }> } : undefined;
const found = body?.artifacts?.find(candidate => candidate.name === name && candidate.expired !== true);
if (!found || typeof found.id !== "number" || !Number.isSafeInteger(found.id) || found.id <= 0) {
throw deployError("REPORT_ARTIFACT_MISSING", `The run has no artifact named ${name} (HTTP ${response.status}).`,
"Rerun the workflow so every target's report job uploads its artifact before the deploy job runs.", { retryable: true, details: { status: response.status } });
}
return found;
}, error => {
const status = error instanceof CiError ? error.details?.status : undefined;
return !(error instanceof CiError) || typeof status === "number" && (status === 200 || status === 404 || status >= 500);
}, options.sleep);
entry.artifactUrl = `https://github.com/${repository}/actions/runs/${review.runId}/artifacts/${artifact.id}`;
}
return entries;
+7 -1
View File
@@ -148,6 +148,12 @@ export async function reportCiError(error: unknown, options: {
env?: NodeJS.ProcessEnv;
secrets?: readonly string[];
diagnosticsPath?: string;
/**
* The matrix target the failed command ran for, written into the diagnostics file. actions/download-artifact puts an
* artifact in a directory named after it only when a pattern matches several, so the failure job cannot always read
* the target from where the file lands.
*/
target?: string;
write?: (value: string) => void;
} = {}): Promise<CiErrorData> {
const env = options.env ?? process.env;
@@ -166,7 +172,7 @@ export async function reportCiError(error: unknown, options: {
if (env.GITHUB_STEP_SUMMARY) outputs.push({ label: "job summary", operation: appendFile(env.GITHUB_STEP_SUMMARY, `${renderCiErrorSummary(error, renderOptions)}\n`) });
if (options.diagnosticsPath) outputs.push({ label: "diagnostics file", operation: (async () => {
await mkdir(dirname(options.diagnosticsPath!), { recursive: true });
await writeFile(options.diagnosticsPath!, `${JSON.stringify(diagnostic, null, 2)}\n`);
await writeFile(options.diagnosticsPath!, `${JSON.stringify(options.target ? { ...diagnostic, target: options.target } : diagnostic, null, 2)}\n`);
})() });
const results = await Promise.allSettled(outputs.map(output => output.operation));
for (const [index, result] of results.entries()) {
+33 -7
View File
@@ -219,8 +219,12 @@ jobs:
${{ runner.temp }}/explore-review/agent-usage.jsonl
retention-days: 7
if-no-files-found: ignore
# Each target's report runs once its own capture uploaded one, whatever the other targets' captures did, as in the
# review workflow (brentvatne/euxy#172): needs.capture.result is the whole matrix's, so each leg looks for its own
# artifact, and a target whose capture failed packages and links nothing. !cancelled() keeps a cancelled run stopped.
report:
needs: [targets, capture]
if: needs.targets.result == 'success' && !cancelled()
strategy:
fail-fast: false
matrix:
@@ -229,19 +233,34 @@ jobs:
timeout-minutes: 20
permissions:
contents: read
outputs:
# "true" from every leg that linked its report, so "true" once any did: the deploy job runs only then.
published: ${{ steps.publish.outputs.published }}
env:
TARGET: ${{ matrix.target }}
steps:
# Downloading by name fails when the artifact is missing. A pattern that matches nothing downloads nothing and
# succeeds, so only a download that went wrong fails this step; its one match is extracted into the path itself.
- name: Download this target's captured review
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Check that this target's capture succeeded
id: captured
shell: bash
run: |
set -euo pipefail
if [[ -f "$RUNNER_TEMP/explore-review/report-input.json" ]]; then echo "found=true" >> "$GITHUB_OUTPUT"
else echo "The $TARGET capture uploaded no review: its capture job failed."; fi
- *setup-node
- *install-explore
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Package the report
if: steps.captured.outputs.found == 'true'
shell: bash
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --target "$TARGET"
- name: Upload the report
if: steps.captured.outputs.found == 'true'
id: report
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
@@ -250,10 +269,15 @@ jobs:
retention-days: 30
if-no-files-found: error
- name: Link the report from the run summary
if: steps.captured.outputs.found == 'true'
id: publish
env:
ARTIFACT_URL: ${{ steps.report.outputs.artifact-url }}
shell: bash
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
run: |
set -euo pipefail
node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
echo "published=true" >> "$GITHUB_OUTPUT"
- name: Upload report failure diagnostics
if: always()
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
@@ -264,9 +288,10 @@ jobs:
if-no-files-found: ignore
# Hosted report (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment serving every target's report.
# This is the only job after capture that holds EXPO_TOKEN; it writes the link to the run summary.
# It runs once any target linked its report, and serves the targets that did; a failed target has no report to wait for.
deploy:
needs: [targets, capture, report]
if: needs.capture.outputs.preview == 'eas'
if: needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()
runs-on: ubuntu-22.04
timeout-minutes: 20
permissions:
@@ -275,7 +300,8 @@ jobs:
steps:
- *setup-node
- *install-explore
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>),
# or a lone artifact's files in the path itself; ci:deploy reads both.
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
+37 -9
View File
@@ -207,8 +207,14 @@ jobs:
${{ runner.temp }}/explore-review/agent-usage.jsonl
retention-days: 7
if-no-files-found: ignore
# Each target's report runs once its own capture uploaded one, whatever the other targets' captures did: in
# brentvatne/euxy#172 (run 39348956443) one flaky simulator session failed one of five captures, and with the report
# waiting on every capture the PR got no report at all. needs.capture.result is the whole matrix's, so each leg looks
# for its own artifact instead; a target whose capture failed uploaded none, packages and publishes nothing here, and
# is named by the failure job. !cancelled() lets the legs run after a failed capture leg, but not in a cancelled run.
report:
needs: [targets, capture]
if: needs.targets.result == 'success' && !cancelled()
strategy:
fail-fast: false
matrix:
@@ -219,19 +225,34 @@ jobs:
contents: read
actions: read
pull-requests: write
outputs:
# "true" from every leg that published, so "true" once any did: the deploy job runs only then.
published: ${{ steps.publish.outputs.published }}
env:
TARGET: ${{ matrix.target }}
steps:
# Downloading by name fails when the artifact is missing. A pattern that matches nothing downloads nothing and
# succeeds, so only a download that went wrong fails this step; its one match is extracted into the path itself.
- name: Download this target's captured review
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Check that this target's capture succeeded
id: captured
shell: bash
run: |
set -euo pipefail
if [[ -f "$RUNNER_TEMP/explore-review/report-input.json" ]]; then echo "found=true" >> "$GITHUB_OUTPUT"
else echo "The $TARGET capture uploaded no review: its capture job failed, and the failure job reports it."; fi
- *setup-node
- *install-explore
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
name: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}
path: ${{ runner.temp }}/explore-review
- name: Package hosted review bundle
if: steps.captured.outputs.found == 'true'
shell: bash
run: node "$TOOLS/dist/cli.js" ci:report --input "$RUNNER_TEMP/explore-review/report-input.json" --output "$RUNNER_TEMP/explore-report" --target "$TARGET"
- name: Upload hosted review bundle
if: steps.captured.outputs.found == 'true'
id: viewer
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
@@ -240,11 +261,16 @@ jobs:
retention-days: 30
if-no-files-found: error
- name: Publish current PR hosted links
if: steps.captured.outputs.found == 'true'
id: publish
env:
GITHUB_TOKEN: ${{ github.token }}
ARTIFACT_URL: ${{ steps.viewer.outputs.artifact-url }}
shell: bash
run: node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
run: |
set -euo pipefail
node "$TOOLS/dist/cli.js" ci:publish --input "$RUNNER_TEMP/explore-review/report-input.json" --artifact-url "$ARTIFACT_URL" --target "$TARGET"
echo "published=true" >> "$GITHUB_OUTPUT"
- name: Upload report failure diagnostics
if: always()
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
@@ -256,9 +282,10 @@ jobs:
# Hosted preview (opt-in, report.preview in config.yaml): one token-gated EAS Hosting deployment per review, serving every target's report.
# This is the only job after capture that holds EXPO_TOKEN; the report job stays credential-free and has already
# published the Download report link, so a failed deployment leaves the comment on the download-and-drop flow.
# It runs once any target published its report, and serves the targets that did; a failed target has no report to wait for.
deploy:
needs: [targets, capture, report]
if: needs.capture.outputs.preview == 'eas'
if: needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()
runs-on: ubuntu-22.04
timeout-minutes: 20
permissions:
@@ -268,7 +295,8 @@ jobs:
steps:
- *setup-node
- *install-explore
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>).
# One directory per target artifact (explore-capture-<run>-<attempt>-<target>, explore-review-<run>-<attempt>-<target>),
# or a lone artifact's files in the path itself; ci:deploy reads both.
- uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
pattern: explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*
@@ -317,6 +345,6 @@ jobs:
shell: bash
run: |
set -euo pipefail
# The diagnostics artifacts are data files from this run and attempt, never executable report code;
# the first error.json names the failed target, and the comment keeps every other target's result.
# The diagnostics artifacts are data files from this run and attempt, never executable report code; each
# error.json names its failed target, which gets a failed record, and the comment keeps every other target's result.
node "$TOOLS/dist/cli.js" ci:failure --pr "${PR_NUMBER:-0}" --head "${HEAD_SHA:-}" --base "${BASE_SHA:-}" --diagnostics "$RUNNER_TEMP/explore-failure"
+754 -2
View File
@@ -196,7 +196,7 @@ test("the pill shows the app's own icon when the report has one, and the Expo ma
report.review.runtime.appIcon = { url: `https://artifact.expo-explore.invalid/${iconSha}.png`, sha256: iconSha, width: 4, height: 4 };
report.assets.push({ sha256: iconSha, path: iconPath });
const withIcon = await harness(t, await archive(report, [{ name: iconPath, bytes: iconBytes }]), { app: true });
const logo = withIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true });
const logo = withIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map of Fixture", exact: true });
await expect(logo.locator("img.panel-app-icon")).toHaveJSProperty("naturalWidth", 4);
await expect(logo.locator(".expo-mark")).toHaveCount(0);
// The tab shows it too, from a Blob URL: the ZIP's own reference is not one the browser can load.
@@ -206,7 +206,7 @@ test("the pill shows the app's own icon when the report has one, and the Expo ma
assert.deepEqual(withIcon.errors, []);
const withoutIcon = await harness(t, await archive(), { app: true });
const mark = withoutIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true });
const mark = withoutIcon.page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map of Fixture", exact: true });
await expect(mark.locator(".expo-mark")).toHaveCount(1);
await expect(mark.locator("img")).toHaveCount(0);
assert.deepEqual(withoutIcon.errors, []);
@@ -647,6 +647,259 @@ test("a switch to a target whose screenshots have another shape lays the map out
assert.deepEqual(errors, []);
});
/**
* The phone header as drawn, once a resize's fit has run. Its shown controls, each of the row's clipped at the row's
* edges: how many pairs overlap, how many run past the row's end (past the window on a desktop, whose row does not
* clip), and the page's overflow; the target label's parts cut without a fade or faded though whole; the room around
* the row's first and last controls for a focus ring; and the name's width against its text's and its minimum.
*/
function phoneHeader(page) {
return page.locator(".left-panel-collapsed-pill").evaluate(async pill => {
await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)));
const row = pill.querySelector(".collapsed-app-identity");
const clip = row.getBoundingClientRect();
const end = getComputedStyle(row).overflowX === "clip" ? clip.right - parseFloat(getComputedStyle(row).paddingRight) : innerWidth;
const shown = [...pill.querySelectorAll(".panel-logo-button, .collapsed-app-identity > strong, .collapsed-platform, .collapsed-pr, .collapsed-search")]
.filter(node => node.checkVisibility({ visibilityProperty: true }));
const boxes = shown.map(node => {
const box = node.getBoundingClientRect();
return row.contains(node) ? { left: Math.max(box.left, clip.left), right: Math.min(box.right, clip.right) } : box;
});
let overlaps = 0;
for (const [index, a] of boxes.entries()) for (const b of boxes.slice(index + 1)) if (a.left < b.right - 1 && b.left < a.right - 1) overlaps += 1;
const items = shown.filter(node => row.contains(node));
const past = items.filter(node => node.getBoundingClientRect().right > end + 1).length;
const parts = [...row.querySelectorAll(".collapsed-target .collapsed-platform-label, .collapsed-target .collapsed-platform-label-text, .collapsed-target .collapsed-platform-label-suffix")];
const cut = node => node.scrollWidth > node.offsetWidth;
const faded = node => getComputedStyle(node).maskImage !== "none";
const controls = items.filter(node => node.matches(".collapsed-platform, .collapsed-pr"));
const ring = controls.length ? Math.floor(Math.min(controls[0].getBoundingClientRect().left - clip.left, clip.right - controls.at(-1).getBoundingClientRect().right)) : 4;
const name = row.querySelector(":scope > strong");
const minimum = parseFloat(getComputedStyle(row).getPropertyValue("--collapsed-name-min")) || 64;
return {
overlaps, past, overflow: document.documentElement.scrollWidth - innerWidth,
unfaded: parts.filter(node => cut(node) && !faded(node)).length, fadedWhole: parts.filter(node => faded(node) && !cut(node)).length,
ring, targetCut: parts.some(cut),
name: name.checkVisibility({ visibilityProperty: true }) ? { width: name.getBoundingClientRect().width, text: name.scrollWidth, minimum: Math.min(minimum, name.scrollWidth) } : undefined,
};
});
}
/** What a header that fits shows: nothing overlaps or runs past the row, and a label fades exactly where it is cut. */
const FITS = { overlaps: 0, past: 0, overflow: 0, unfaded: 0, fadedWhole: 0 };
const fitOf = ({ overlaps, past, overflow, unfaded, fadedWhole }) => ({ overlaps, past, overflow, unfaded, fadedWhole });
/**
* A report of two targets, `label` the shown one's, for the phone header: `icon` adds the app's icon (`"broken"`, one
* whose bytes are no image), `appearances` a second chip, and the pull request is #1234.
*/
async function phoneReport({ label, appName = "Acme Super Long Application Name", icon = false, appearances = false }) {
const targets = [{ id: "shown", platform: "ios", label }, { id: "other", platform: "ios", label: "iPhone 17" }];
const report = reportFixture();
report.review.runtime = { ...report.review.runtime, appName, platform: "ios", platforms: ["ios"], target: targets[0], targets,
...(appearances ? { colorSchemes: ["light", "dark"] } : {}) };
report.review.pullRequest.number = 1234;
const extra = [];
if (icon) {
const image = new PNG({ width: 4, height: 4 });
image.data.fill(180);
const bytes = icon === "broken" ? new TextEncoder().encode("not an image") : PNG.sync.write(image);
const sha = createHash("sha256").update(bytes).digest("hex");
report.review.runtime.appIcon = { url: `https://artifact.expo-explore.invalid/${sha}.png`, sha256: sha, width: 4, height: 4 };
report.assets.push({ sha256: sha, path: `assets/${sha}.png` });
extra.push({ name: `assets/${sha}.png`, bytes });
}
return archive(report, extra);
}
test("at a phone's width the header leaves out the app's name, then the pull request link, then fades the target's device; nothing overlaps", { timeout: 60_000 }, async t => {
const targets = [{ id: "iphone", platform: "ios", label: "iPhone 17" }, { id: "duo-half", platform: "ios", label: "iPhone 17 Pro Max Duo (half-open, outer)" }];
const icon = new PNG({ width: 4, height: 4 });
icon.data.fill(180);
const iconBytes = PNG.sync.write(icon);
const iconSha = createHash("sha256").update(iconBytes).digest("hex");
const report = reportFixture();
// An icon to name the app once its name is left out; two appearances for the second chip; the longest target.
report.review.runtime = {
...report.review.runtime, platform: "ios", platforms: ["ios"], target: targets[1], targets, colorSchemes: ["light", "dark"],
appIcon: { url: `https://artifact.expo-explore.invalid/${iconSha}.png`, sha256: iconSha, width: 4, height: 4 },
};
report.assets.push({ sha256: iconSha, path: `assets/${iconSha}.png` });
report.review.pullRequest.number = 1234;
const { page, errors } = await harness(t, await archive(report, [{ name: `assets/${iconSha}.png`, bytes: iconBytes }]), { app: true });
const pill = page.locator(".left-panel-collapsed-pill");
const name = pill.locator(".collapsed-app-identity > strong");
const target = pill.locator(".collapsed-target");
const device = target.locator(".collapsed-platform-label-text");
const pose = target.locator(".collapsed-platform-label-suffix");
const pr = pill.locator(".collapsed-pr");
const layout = async () => fitOf(await phoneHeader(page));
const clipped = locator => locator.evaluate(node => node.scrollWidth - node.offsetWidth > 1);
const whole = async () => ({ device: !await clipped(device), pose: !await clipped(pose) });
const dropped = () => pill.locator(".collapsed-app-identity").evaluate(node => node.dataset.drop ?? "");
// The fit measures text: the Viewer's font must be in before the row's widths mean anything.
await page.evaluate(() => document.fonts.ready);
// A desktop window's pill is sized by its content and shows the whole row.
await page.setViewportSize({ width: 1180, height: 820 });
await expect(name).toBeVisible();
await expect(target).toHaveText("iPhone 17 Pro Max Duo (half-open, outer)");
await expect(pr).toHaveText("PR #1234");
await expect(pr).toBeVisible();
expect(await whole()).toEqual({ device: true, pose: true });
expect(await dropped()).toBe("");
await expect.poll(layout).toEqual(FITS);
// A small tablet has no room for the name beside Search: the row leaves it out (the icon still names the app) and
// keeps the whole target and a shorter link.
await page.setViewportSize({ width: 560, height: 932 });
await expect(name).toBeHidden();
await expect(pr).toHaveText("#1234");
await expect(pr).toBeVisible();
await expect(target).toHaveText("iPhone 17 Pro Max Duo (half-open, outer)");
expect(await whole()).toEqual({ device: true, pose: true });
await expect.poll(layout).toEqual(FITS);
const search = pill.getByRole("button", { name: "Search", exact: true });
const finger = await search.boundingBox();
assert.ok(finger.width >= 44 && finger.height >= 44, `Search is ${finger.width}×${finger.height}`);
// A large phone's width leaves out the link too (Search keeps "Open pull request") before it touches the target.
await page.setViewportSize({ width: 500, height: 844 });
await expect(pr).toBeHidden();
await expect(target).toHaveText("iPhone 17 Pro Max Duo (half-open, outer)");
expect(await whole()).toEqual({ device: true, pose: true });
await expect.poll(layout).toEqual(FITS);
await page.keyboard.press("ControlOrMeta+KeyK");
const palette = page.getByRole("dialog", { name: "Search Explore" });
await palette.getByRole("combobox", { name: "Search screens and commands" }).fill("pull request");
await expect(palette.getByRole("option", { name: /^Open pull request #1234 on GitHub/ })).toBeVisible();
await page.keyboard.press("Escape");
await expect(palette).toBeHidden();
// An iPhone's width fades the device's name; the pose stays whole and nothing overlaps.
await page.setViewportSize({ width: 390, height: 844 });
await expect(pill.locator(".collapsed-app-identity")).toHaveAttribute("data-drop", /squeeze/);
await expect(pill.locator(".collapsed-app-identity")).not.toHaveAttribute("data-drop", /pose/);
expect(await whole()).toEqual({ device: false, pose: true });
await expect.poll(layout).toEqual(FITS);
// Narrower than the pose beside two chips: the pose fades too, inside its chip, never over the appearance chip.
await page.setViewportSize({ width: 320, height: 568 });
await expect(pill.locator(".collapsed-app-identity")).toHaveAttribute("data-drop", /pose/);
await expect(pill.locator(".collapsed-platform").nth(1)).toHaveText("Light");
await expect.poll(layout).toEqual(FITS);
// Widened again, the row takes everything back: the desktop's pill is sized by its content and leaves nothing out
// (its own width rule ellipsizes the name beside so long a target; the fit does not touch it).
await page.setViewportSize({ width: 1180, height: 820 });
await expect(name).toHaveCSS("visibility", "visible");
await expect(name).toHaveCSS("position", "static");
await expect(pr).toHaveText("PR #1234");
await expect(pr).toBeVisible();
expect(await whole()).toEqual({ device: true, pose: true });
expect(await dropped()).toBe("");
assert.deepEqual(errors, []);
});
test("a phone's row without the app's icon cuts the name down to its minimum before it squeezes the target, and fades a label only where it is cut", { timeout: 90_000 }, async t => {
const { page, errors } = await harness(t, await phoneReport({ label: "iPhone 16 Pro (open)" }), { app: true });
const row = page.locator(".left-panel-collapsed-pill .collapsed-app-identity");
await expect(row.locator(".collapsed-target")).toHaveText("iPhone 16 Pro (open)");
await page.evaluate(() => document.fonts.ready);
// An iPhone's width has room for the whole target beside a cut name: the name gives way, the target keeps its label.
await page.setViewportSize({ width: 390, height: 844 });
await expect(row).not.toHaveAttribute("data-drop", /squeeze/);
const iphone = await phoneHeader(page);
assert.equal(iphone.targetCut, false);
assert.ok(iphone.name && iphone.name.width > iphone.name.minimum + 1 && iphone.name.width < iphone.name.text, `the name is ${JSON.stringify(iphone.name)}`);
// At every phone width, the target is cut only once the name is at its minimum, and only what is cut fades.
for (const width of [320, 340, 360, 375, 390, 414, 430, 460, 480, 560, 700]) {
await page.setViewportSize({ width, height: 844 });
const header = await phoneHeader(page);
assert.deepEqual(fitOf(header), FITS, `at ${width}px`);
if (header.name) assert.ok(header.name.width >= header.name.minimum - 1, `at ${width}px the name is ${JSON.stringify(header.name)}`);
if (header.targetCut && header.name) assert.ok(header.name.width <= header.name.minimum + 1, `at ${width}px the target is cut beside ${JSON.stringify(header.name)}`);
}
assert.deepEqual(errors, []);
});
test("a phone's header with Hand off fits its row at an iPhone's widths, with or without the app's icon", { timeout: 120_000 }, async t => {
// The hosted preview's header: Hand off sits before Search, so the row has less room than at /r.
const reports = [
{ label: "iPhone 16 Pro (open)", icon: false, appearances: true },
{ label: "iPhone 16 Pro (open)", icon: true, appearances: true },
{ label: "iOS", icon: false, appearances: true },
];
for (const [index, options] of reports.entries()) {
const preview = { token: `${"qrstuvwxyz234567234567234567".slice(0, 28)}${"abcd".slice(index, index + 1)}bcd` };
const { page, errors } = await harness(t, await phoneReport(options), { app: true, reportIdentity: null, preview, query: "" });
const pill = page.locator(".left-panel-collapsed-pill");
await expect(pill.locator(".collapsed-target")).toHaveText(options.label);
await page.evaluate(() => document.fonts.ready);
for (const width of [320, 360, 390, 430, 460]) {
await page.setViewportSize({ width, height: 844 });
await expect(pill.getByRole("button", { name: "Hand off to AI" })).toBeVisible();
const header = await phoneHeader(page);
const where = `${JSON.stringify(options)} at ${width}px`;
assert.deepEqual(fitOf(header), FITS, where);
// The row's end chip has room for its focus ring (2px, 2px out) and its key hint.
assert.ok(header.ring >= 4, `${where}: ${header.ring}px around the row's controls`);
// A name the row keeps is readable; one it leaves out is still the Map button's.
if (header.name) assert.ok(header.name.width >= header.name.minimum - 1, `${where}: the name is ${JSON.stringify(header.name)}`);
else await expect(pill.getByRole("button", { name: "Map of Acme Super Long Application Name", exact: true })).toBeVisible();
// A short label is no squeeze's to give: it shows whole.
if (options.label === "iOS") assert.equal(header.targetCut, false, where);
}
assert.deepEqual(errors, []);
await page.close();
}
});
test("a phone's row keeps the app's name when its icon cannot be read and the Expo mark stands in", { timeout: 60_000 }, async t => {
const { page, errors } = await harness(t, await phoneReport({ label: "iPhone 17 Pro Max Duo (half-open, outer)", icon: "broken", appearances: true }), { app: true });
const pill = page.locator(".left-panel-collapsed-pill");
await expect(pill.locator(".panel-logo-button .expo-mark")).toHaveCount(1);
await expect(pill.locator(".panel-logo-button img")).toHaveCount(0);
await page.evaluate(() => document.fonts.ready);
// With the icon, this width leaves the name out; the Expo mark does not name the app, so the name stays, cut.
await page.setViewportSize({ width: 560, height: 932 });
await expect(pill.locator(".collapsed-app-identity > strong")).toBeVisible();
const header = await phoneHeader(page);
assert.deepEqual(fitOf(header), FITS);
assert.ok(header.name && header.name.width >= header.name.minimum - 1, `the name is ${JSON.stringify(header.name)}`);
assert.deepEqual(errors, []);
});
test("a phone's fit that waits on the fonts does nothing once the window is a desktop's", { timeout: 60_000 }, async t => {
// The fonts arrive only when the test says, after the window has crossed to the desktop layout.
const fault = () => {
let release;
const ready = new Promise(resolve => { release = () => resolve(document.fonts); });
Object.defineProperty(document.fonts, "ready", { configurable: true, get: () => ready });
window.releaseFonts = release;
};
const bytes = await phoneReport({ label: "iPhone 16 Pro (open)", icon: true, appearances: true });
const { page, errors } = await harness(t, bytes, { app: true, open: false, fault });
await page.setViewportSize({ width: 390, height: 844 });
await chooseFile(page, bytes);
const pill = page.locator(".left-panel-collapsed-pill");
const row = pill.locator(".collapsed-app-identity");
await expect(row).toHaveAttribute("data-drop", /name/);
await page.setViewportSize({ width: 1180, height: 820 });
await expect(pill.locator(".collapsed-pr")).toHaveText("PR #1234");
await page.evaluate(async () => {
window.releaseFonts();
await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)));
});
await expect(row).not.toHaveAttribute("data-drop");
await expect(pill.locator(".collapsed-pr")).toBeVisible();
await expect(pill.locator(".collapsed-app-identity > strong")).toBeVisible();
assert.deepEqual(errors, []);
});
test("a hosted manifest larger than the Viewer reads is refused before it is parsed", { timeout: 60_000 }, async t => {
const preview = { token: "klmnopqrstuvwxyz2345672345672345", padding: 11 * 1024 * 1024 };
const { page, errors } = await harness(t, await archive(), { app: true, reportIdentity: null, preview, query: "" });
@@ -1774,3 +2027,502 @@ test("a near-square landscape pair in a short window keeps both halves on screen
}
assert.deepEqual(errors, []);
});
/** A capture in a colour of its own, so every side of every screen is a screenshot of its own. */
function tintedCapture(seed) {
const picture = new PNG({ width: 32, height: 64 });
for (let offset = 0; offset < picture.data.length; offset += 4) picture.data.set([(seed * 53) % 256, (seed * 101 + 40) % 256, (seed * 151 + 90) % 256, 255], offset);
const bytes = PNG.sync.write(picture);
const digest = createHash("sha256").update(bytes).digest("hex");
return { bytes, sha256: digest, path: `assets/${digest}.png`, reference: `expo-explore-asset:${digest}.png`,
record: { url: `https://artifact.expo-explore.invalid/${digest}.png`, sha256: digest, width: 32, height: 64 } };
}
/**
* `count` modified screens, screen-1 to screen-<count>, each with a Before and an After of its own. `seed` gives
* another target its own captures. `screens[i]` holds screen-(i + 1)'s `before` and `after`. `sameAfter: { i: j }`
* gives the screen at index i the After of the one at index j.
*/
async function changedScreensArchive(count, { seed = 1, runtime, sameAfter = {} } = {}) {
const report = reportFixture();
const home = report.review.surfaces[0];
const route = id => ({ ...home.head, id, route: `/${id}`, path: `/${id}`, routeFile: `app/${id}.tsx`, logicalPath: `app/${id}.tsx` });
const extra = [];
const screens = [];
report.assets = [];
report.review.surfaces = Array.from({ length: count }, (_, index) => {
const id = `screen-${index + 1}`;
const before = tintedCapture(seed * 100 + index * 2);
const after = sameAfter[index] !== undefined ? screens[sameAfter[index]].after : tintedCapture(seed * 100 + index * 2 + 1);
screens.push({ id, before, after });
for (const capture of [before, after]) {
if (report.assets.some(asset => asset.sha256 === capture.sha256)) continue;
report.assets.push({ sha256: capture.sha256, path: capture.path });
extra.push({ name: capture.path, bytes: capture.bytes });
}
return { ...structuredClone(home), id, base: route(id), head: route(id),
baseImage: { ...home.baseImage, ...before.record }, headImage: { ...home.headImage, ...after.record } };
});
const empty = { contract: "explore.navigation", edges: [], modalSurfaceIds: [], unresolved: [] };
report.review.navigation = { base: structuredClone(empty), head: empty };
if (runtime) report.review.runtime = { ...report.review.runtime, ...runtime };
return { bytes: await archive(report, extra), screens };
}
/** Records each screenshot request (reference, priority, when) and release on the page's report archives. */
async function recordScreenshotReads(page) {
await page.evaluate(async () => {
const { ArtifactReportArchive } = await import("/src/utils/artifact-report.ts");
window.reads = [];
window.releases = [];
const { resolve, release } = ArtifactReportArchive.prototype;
ArtifactReportArchive.prototype.resolve = function (reference, priority) {
window.reads.push({ reference, priority: priority ?? "lazy", at: performance.now() });
return resolve.call(this, reference, priority);
};
ArtifactReportArchive.prototype.release = function (reference) {
window.releases.push({ reference, at: performance.now() });
return release.call(this, reference);
};
});
}
/** How many uses of each screenshot the shown report counts, by reference. */
const screenshotUses = page => page.evaluate(async () => {
const { activeArtifactReport } = await import("/src/utils/artifact-report.ts");
return Object.fromEntries([...activeArtifactReport.loads.values()].map(load => [`expo-explore-asset:${load.sha256}.png`, load.users]));
});
/** How many mounted images show each screenshot, by reference. */
const mountedScreenshots = page => page.evaluate(() => {
const counts = {};
for (const image of document.querySelectorAll("img[data-screenshot-src]")) counts[image.dataset.screenshotSrc] = (counts[image.dataset.screenshotSrc] ?? 0) + 1;
return counts;
});
/** Every use the report counts belongs to an image on the page; nothing else holds a screenshot. */
async function expectBalancedUses(page, message) {
await expect.poll(async () => {
const uses = await screenshotUses(page);
const mounted = await mountedScreenshots(page);
return Object.entries(uses).filter(([reference, users]) => users > (mounted[reference] ?? 0));
}, { message }).toEqual([]);
}
test("Compare reads the next screen's screenshots once it rests on a screen, never while an arrow is held, and they are released when it moves on", { timeout: 90_000 }, async t => {
const { bytes, screens } = await changedScreensArchive(9);
const { page, errors } = await harness(t, bytes, { app: true, open: false, query: "&view=compare&screen=screen-1" });
await recordScreenshotReads(page);
await chooseFile(page, bytes);
const compare = page.locator(".compare-section");
await expect(compare.locator(".compare-frame img")).toHaveCount(2);
for (const image of await compare.locator(".compare-frame img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
const position = compare.locator(".compare-nav-position");
await expect(position).toHaveText(/^1 of 9$/);
const shownAt = await page.evaluate(() => Math.min(...window.reads.filter(read => read.priority === "eager").map(read => read.at)));
// Resting on screen-1, its neighbour in the direction of travel (screen-2) is read, after the settle delay, as a
// prefetch that leaves the next step's slots free.
const prefetchesOf = screen => page.evaluate(references => window.reads.filter(read => read.priority === "prefetch" && references.includes(read.reference)),
[screen.before.reference, screen.after.reference]);
await expect.poll(async () => (await prefetchesOf(screens[1])).length).toBe(2);
assert.ok((await prefetchesOf(screens[1]))[0].at - shownAt >= 240, "Nothing is read before Compare rests on the screen");
assert.equal((await page.evaluate(() => window.reads.filter(read => read.priority === "prefetch"))).length, 2, "Only the neighbour is read");
await expect.poll(() => screenshotUses(page)).toMatchObject({ [screens[1].before.reference]: 1, [screens[1].after.reference]: 1 });
// The step finds its pictures decoded: nothing new is decoded for them.
await expect.poll(() => page.evaluate(() => window.createdUrls.length)).toBe(4);
await page.keyboard.press("ArrowRight");
await expect(position).toHaveText(/^2 of 9$/);
for (const image of await compare.locator(".compare-frame img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
assert.equal(await page.evaluate(() => window.createdUrls.length), 4, "The prefetched screenshots were shown without a new decode");
// A held arrow steps past several screens; nothing is read for a neighbour until it is released.
await expect.poll(async () => (await prefetchesOf(screens[2])).length).toBe(2);
const downAt = await page.evaluate(() => performance.now());
await page.keyboard.down("ArrowRight");
await expect.poll(async () => Number((await position.textContent()).split(" ")[0]), { timeout: 4000 }).toBeGreaterThanOrEqual(6);
// The stage is marked while the key repeats, so the screenshots it passes appear without a fade.
await expect(compare.locator(".compare-stage")).toHaveAttribute("data-screenshot-instant", "");
await page.waitForTimeout(150);
const upAt = await page.evaluate(() => performance.now());
await page.keyboard.up("ArrowRight");
await expect(compare.locator(".compare-stage")).not.toHaveAttribute("data-screenshot-instant", /.*/);
const heldPrefetches = await page.evaluate(({ downAt, upAt }) => window.reads.filter(read => read.priority === "prefetch" && read.at > downAt && read.at <= upAt), { downAt, upAt });
assert.deepEqual(heldPrefetches, [], "No neighbour was read while the arrow was held");
const landed = Number((await position.textContent()).split(" ")[0]);
const next = screens[landed];
if (next) await expect.poll(async () => (await prefetchesOf(next)).length).toBe(2);
// Leaving Compare lets go of every screenshot it, and its prefetch, held.
await page.getByRole("group", { name: "Canvas view" }).getByRole("button", { name: "Screens", exact: true }).click();
await expect(page.locator(".screens-page")).toBeVisible();
await expect(compare).toHaveCount(0);
await expectBalancedUses(page, "Every use left after Compare belongs to an image on Screens");
const uses = await screenshotUses(page);
for (const screen of screens) assert.equal(uses[screen.before.reference] ?? 0, 0, `${screen.id}'s Before is no longer in use`);
assert.deepEqual(errors, []);
});
test("a prefetch never holds a slot the screen the reviewer steps to needs, whichever way the step goes", { timeout: 20_000 }, async t => {
const { page, errors } = await harness(t);
const { bytes, shas } = await multiImageArchive(8);
const result = await page.evaluate(async ({ bytes, identity, shas, probe }) => {
const archive = await window.openReport(bytes, identity);
const decodes = new Function(`return (${probe})()`)();
const [shown, shownToo, ahead, aheadToo, behind, behindToo, later, laterToo] = shas.map(sha => archive.reference(sha));
const settle = () => new Promise(resolve => setTimeout(resolve, 30));
// The screen on show is still being read when Compare rests on it: its neighbour's prefetches wait.
const visible = [archive.resolve(shown, "eager"), archive.resolve(shownToo, "eager")];
await decodes.until(() => decodes.held() === 2);
const waited = [archive.resolve(ahead, "prefetch"), archive.resolve(aheadToo, "prefetch")].map(read => read.then(() => "read", error => error.message));
await settle();
const heldWhileShownReads = decodes.held();
// The reviewer steps the other way before they start: they are dropped, unread.
archive.release(ahead);
archive.release(aheadToo);
const stepped = [archive.resolve(behind, "eager"), archive.resolve(behindToo, "eager")];
await decodes.until(() => decodes.held() === 4);
decodes.all();
await Promise.all([...visible, ...stepped]);
const dropped = await Promise.all(waited);
// Resting on that screen, its own neighbour's prefetches start, in the slots its reads have finished with.
const running = [archive.resolve(later, "prefetch"), archive.resolve(laterToo, "prefetch")];
await decodes.until(() => decodes.held() === 2);
// The reviewer steps the other way while they run: they keep their slots, and the screen stepped to starts at once.
archive.release(later);
archive.release(laterToo);
archive.release(shown);
archive.release(shownToo);
const back = [archive.resolve(shown, "eager"), archive.resolve(shownToo, "eager")];
await settle();
const heldAfterStep = decodes.held();
decodes.all();
await Promise.all([...running, ...back]);
return { heldWhileShownReads, dropped, heldAfterStep, hashed: decodes.hashed() };
}, { bytes, identity, shas, probe: decodeProbe.toString() });
assert.equal(result.heldWhileShownReads, 2, "The prefetches waited while the shown screen was still being read");
assert.deepEqual(result.dropped, ["This screenshot is no longer in use.", "This screenshot is no longer in use."]);
assert.ok(!result.hashed.includes(shas[2]) && !result.hashed.includes(shas[3]), "A prefetch let go before it started was never read");
assert.equal(result.heldAfterStep, 2, "The screen stepped to was read at once, beside the running prefetches");
assert.deepEqual(errors, []);
});
test("Flip reads a screen's Before only once its After has loaded, and flipping reads nothing new", { timeout: 90_000 }, async t => {
const { bytes, screens } = await changedScreensArchive(4);
const { page, errors } = await harness(t, bytes, { app: true, open: false, query: "&view=compare&screen=screen-1" });
await page.addInitScript(() => localStorage.setItem("expo-explore:compare-mode", "flip"));
await page.reload();
await recordScreenshotReads(page);
await chooseFile(page, bytes);
const frame = page.locator(".compare-section .compare-flip-frame");
await expect(frame.locator(".compare-flip-layer")).toHaveCount(2);
for (const image of await frame.locator("img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// The side off screen is hidden, its spinner with it.
await expect(frame.locator(".compare-flip-layer[data-side='before']")).toHaveAttribute("aria-hidden", "true");
await expect(frame.locator(".compare-flip-layer[data-side='before']")).toHaveCSS("visibility", "hidden");
// The next screen's After is held back: its Before is not read meanwhile, and only After's layer is mounted.
await page.evaluate(after => {
const digest = crypto.subtle.digest.bind(crypto.subtle);
const hex = buffer => Array.from(new Uint8Array(buffer), byte => byte.toString(16).padStart(2, "0")).join("");
window.heldAfter = [];
crypto.subtle.digest = async (algorithm, data) => {
const value = await digest(algorithm, data);
if (hex(value) === after) await new Promise(resolve => window.heldAfter.push(resolve));
return value;
};
}, screens[1].after.sha256);
const readsOf = reference => page.evaluate(reference => window.reads.filter(read => read.reference === reference && read.priority !== "prefetch").length, reference);
await page.keyboard.press("ArrowRight");
await expect(page.locator(".compare-section .compare-nav-position")).toHaveText(/^2 of 4$/);
await expect(frame.locator(".compare-flip-layer")).toHaveCount(1);
await page.waitForTimeout(150);
assert.equal(await readsOf(screens[1].before.reference), 0, "Before is not read while After loads");
await page.evaluate(() => window.heldAfter.splice(0).forEach(release => release()));
await expect(frame.locator(".compare-flip-layer")).toHaveCount(2);
for (const image of await frame.locator("img").all()) await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// StrictMode mounts each image's lease twice in development.
assert.ok(await readsOf(screens[1].before.reference) > 0, "Before is read once After has loaded");
// Flipping swaps the two decoded sides at once.
const reads = await page.evaluate(() => window.reads.length);
await page.keyboard.press("KeyX");
await expect(frame.locator(".compare-flip-layer[data-side='before']")).not.toHaveAttribute("aria-hidden", /.*/);
await expect(frame.locator(".compare-flip-layer[data-side='after']")).toHaveCSS("visibility", "hidden");
await expect(frame.locator(".compare-flip-layer[data-side='before'] img")).toHaveCSS("opacity", "1");
await page.keyboard.press("KeyX");
await expect(frame.locator(".compare-flip-layer[data-side='after']")).not.toHaveAttribute("aria-hidden", /.*/);
assert.equal(await page.evaluate(() => window.reads.length), reads, "A flip reads nothing");
assert.deepEqual(errors, []);
});
test("a Map card's backing draws the frame its screenshot waits and fades in over, and steps aside for No screenshot", { timeout: 60_000 }, async t => {
const { page, errors } = await harness(t, await archive(), { app: true, fault: holdScreenshotHashes() });
await expect(page.locator(".app-shell")).toBeVisible();
const slot = page.locator(".map-canvas .screen-node-image").first();
const image = slot.locator("img[data-screenshot-src]");
const backing = slot.locator(".screenshot-backing");
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
await expect(image).toHaveCSS("opacity", "0");
await expect(backing).toHaveCSS("visibility", "visible");
const frames = () => slot.evaluate(element => {
const box = node => { const { left, top, width, height } = node.getBoundingClientRect(); return [left, top, width, height].map(value => Math.round(value * 10) / 10); };
const style = node => { const { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow } = getComputedStyle(node); return { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow }; };
const [img, backing] = [element.querySelector("img"), element.querySelector(".screenshot-backing")];
return { image: box(img), backing: box(backing), imageStyle: style(img), backingStyle: style(backing) };
});
// The link selects Home, so the frame carries the selection ring past the Modified status.
await expect(page.locator(".map-canvas .react-flow__node-screen.selected")).toHaveCount(1);
// The ring follows the canvas zoom, and the backing's ring eases to it as the opening camera settles.
await expect.poll(async () => { const { backingStyle, imageStyle } = await frames(); return backingStyle.boxShadow === imageStyle.boxShadow; }).toBe(true);
const waiting = await frames();
assert.deepEqual(waiting.backing, waiting.image, "The backing sits exactly where the image does");
assert.deepEqual(waiting.backingStyle, waiting.imageStyle, "and draws the same frame: fill, border, radius, status and ring");
assert.match(waiting.backingStyle.boxShadow, /rgb\(5, 136, 240\)/);
await page.evaluate(() => window.releaseScreenshotHashes());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.deepEqual((await frames()).image, waiting.image, "Loading moved nothing");
// Once the picture has faded in, the backing hides.
await expect(backing).toHaveCSS("visibility", "hidden");
await expect(image).toHaveCSS("opacity", "1");
assert.deepEqual(errors, []);
});
test("a Map card whose screenshot cannot be read shows No screenshot in one frame, its backing hidden", async t => {
const damaged = Buffer.from(png);
damaged[damaged.length - 1] ^= 1;
const { page, errors } = await harness(t, await archive(reportFixture(), [], damaged), { app: true });
await expect(page.locator(".app-shell")).toBeVisible();
const slot = page.locator(".map-canvas .screen-node-image").first();
await expect(slot.locator(".image-placeholder")).toHaveText("No screenshot");
await expect(slot.locator(".screenshot-backing")).toHaveCSS("visibility", "hidden");
assert.deepEqual(errors, []);
});
test("on a phone, a Screens card's screenshot keeps its height while it loads and once it has", { timeout: 60_000 }, async t => {
const { bytes } = await changedScreensArchive(2);
const { page, errors } = await harness(t, bytes, { app: true, open: false, fault: holdScreenshotHashes(tintedCapture(100).bytes.length) });
await page.setViewportSize({ width: 390, height: 844 });
await chooseFile(page, bytes);
await expect(page.locator(".app-shell")).toBeVisible();
await page.goto(`${page.url().split("#")[0]}#/screens`);
const slot = page.locator(".screens-cell .screen-node-image.has-screenshot").first();
await expect(slot).toBeVisible();
const height = () => slot.evaluate(element => [element.getBoundingClientRect().height, element.querySelector("img").getBoundingClientRect().height]);
const [waiting, waitingImage] = await height();
assert.ok(waiting > 100 && Math.abs(waiting - waitingImage) < 1, `The waiting screenshot holds the slot open: ${waiting}, ${waitingImage}`);
// The image is the frame here, and hidden while it loads: its backing draws the same frame in its place.
await expect(slot.locator("img")).toHaveCSS("opacity", "0");
const backing = slot.locator(".screenshot-backing");
await expect(backing).toHaveCSS("visibility", "visible");
const frames = await slot.evaluate(element => {
const box = node => { const { left, top, width, height } = node.getBoundingClientRect(); return [left, top, width, height].map(value => Math.round(value)); };
const style = node => { const { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow } = getComputedStyle(node); return { borderTopColor, borderTopWidth, borderTopLeftRadius, backgroundColor, boxShadow }; };
const [img, backing] = [element.querySelector("img"), element.querySelector(".screenshot-backing")];
return { image: box(img), backing: box(backing), imageStyle: style(img), backingStyle: style(backing) };
});
assert.deepEqual(frames.backing, frames.image);
assert.deepEqual(frames.backingStyle, frames.imageStyle, "The backing draws the image's frame: border, fill, radius, status and ring");
assert.notEqual(frames.backingStyle.backgroundColor, "rgba(0, 0, 0, 0)");
// Selected, the backing carries the image's ring while the screenshot still loads (a changed screen's is its status).
await page.goto(`${page.url().split("#")[0]}#/screens?screen=screen-1`);
const selected = page.locator(".screens-cell .screen-screenshot-card.selected .screen-node-image");
await expect(selected.locator("img")).toHaveAttribute("data-screenshot-state", "loading");
const rings = await selected.evaluate(element => [element.querySelector("img"), element.querySelector(".screenshot-backing")]
.map(node => getComputedStyle(node).boxShadow));
assert.equal(rings[1], rings[0]);
assert.notEqual(rings[1], "none");
await page.evaluate(() => window.releaseScreenshotHashes());
await expect(slot.locator("img")).toHaveAttribute("data-screenshot-state", "ready");
assert.deepEqual(await height(), [waiting, waitingImage]);
assert.deepEqual(errors, []);
});
test("a target switch blanks every card whose screenshot differs, never showing the other target's picture, and switching back reuses the kept pictures", { timeout: 90_000 }, async t => {
const runtime = { platform: "android", platforms: ["ios", "android"] };
const android = await changedScreensArchive(3, { seed: 1, runtime });
const ios = await changedScreensArchive(3, { seed: 2, runtime: { ...runtime, platform: "ios" } });
const preview = { token: "pqrstuvwxyz234567234567234567234", listing: [{ platform: "ios" }, { platform: "android" }],
archives: { "?platform=ios": ios.bytes } };
const { page, errors } = await harness(t, android.bytes, { app: true, reportIdentity: null, preview, query: "&platform=android" });
await expect(page.locator(".app-shell")).toBeVisible();
const cards = page.locator(".map-canvas img[data-screenshot-src]");
await expect(cards).toHaveCount(3);
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "ready");
const shown = await cards.evaluateAll(images => Object.fromEntries(images.map(image => [image.getAttribute("src"), image.dataset.screenshotSrc])));
// Hold iOS's screenshots back so the switch is caught while they load.
await page.evaluate(sizes => {
const digest = crypto.subtle.digest.bind(crypto.subtle);
window.heldIos = [];
window.releaseIos = () => window.heldIos.splice(0).forEach(release => release());
window.holdIos = true;
crypto.subtle.digest = (algorithm, data) => window.holdIos && sizes.includes(data.byteLength)
? new Promise(resolve => window.heldIos.push(() => resolve(digest(algorithm, data)))) : digest(algorithm, data);
}, ios.screens.flatMap(screen => [screen.before.bytes.length, screen.after.bytes.length]));
// Every frame from the switch on: no card shows a picture under another screenshot's name, and a waiting one is hidden.
await page.evaluate(shown => {
window.staleFrames = [];
window.sampling = true;
const sample = () => {
for (const image of document.querySelectorAll(".map-canvas img[data-screenshot-src]")) {
const source = shown[image.getAttribute("src")];
const opacity = Number(getComputedStyle(image).opacity);
if (source && source !== image.dataset.screenshotSrc && opacity > 0) window.staleFrames.push({ source, named: image.dataset.screenshotSrc, opacity });
if (image.dataset.screenshotState === "loading" && opacity > 0) window.staleFrames.push({ waiting: image.dataset.screenshotSrc, opacity });
}
if (window.sampling) requestAnimationFrame(sample);
};
requestAnimationFrame(sample);
}, shown);
await page.getByRole("button", { name: "Platform: Android. Open another platform's report" }).click();
await page.getByRole("menu", { name: "Platform" }).getByRole("menuitemradio").nth(0).click();
await page.waitForURL(url => new URL(url).searchParams.get("platform") === "ios");
await expect(cards.first()).toHaveAttribute("data-screenshot-src", ios.screens[0].after.reference);
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "loading");
await page.waitForTimeout(200);
await page.evaluate(() => { window.holdIos = false; window.releaseIos(); });
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(() => { window.sampling = false; });
assert.deepEqual(await page.evaluate(() => window.staleFrames), [], "No frame showed Android's picture on iOS's cards, or a waiting picture");
await expectBalancedUses(page, "After the switch, the iOS report counts only the cards' uses");
// Back to Android: its kept pictures come back without a new decode.
const created = await page.evaluate(() => window.createdUrls.length);
await page.goBack();
await page.waitForURL(url => new URL(url).searchParams.get("platform") === "android");
for (const card of await cards.all()) await expect(card).toHaveAttribute("data-screenshot-state", "ready");
const back = await cards.evaluateAll(images => Object.fromEntries(images.map(image => [image.getAttribute("src"), image.dataset.screenshotSrc])));
assert.deepEqual(back, shown, "Android's cards show the Blob URLs they showed before");
assert.equal(await page.evaluate(() => window.createdUrls.length), created, "nothing was decoded again");
await expectBalancedUses(page, "After switching back, the Android report counts only the cards' uses");
assert.deepEqual(errors, []);
});
test("a prefetch the reviewer steps onto starts at once when a slot is free, instead of waiting for a running read", { timeout: 20_000 }, async t => {
const { page, errors } = await harness(t);
const { bytes, shas } = await multiImageArchive(4);
const result = await page.evaluate(async ({ bytes, identity, shas, probe }) => {
const archive = await window.openReport(bytes, identity);
const decodes = new Function(`return (${probe})()`)();
const [shown, shownToo, next, nextToo] = shas.map(sha => archive.reference(sha));
// The screen on show is still being read after the rest: the next screen's prefetches wait behind the reserve.
const visible = [archive.resolve(shown, "eager"), archive.resolve(shownToo, "eager")];
await decodes.until(() => decodes.held() === 2);
const prefetched = [archive.resolve(next, "prefetch"), archive.resolve(nextToo, "prefetch")];
await new Promise(resolve => setTimeout(resolve, 30));
const heldBeforeStep = decodes.held();
// The reviewer steps onto that screen: its reads start in the two free slots, beside the running ones.
const stepped = [archive.resolve(next, "eager"), archive.resolve(nextToo, "eager")];
await new Promise(resolve => setTimeout(resolve, 30));
const heldAfterStep = decodes.held();
decodes.all();
await Promise.all([...visible, ...prefetched, ...stepped]);
return { heldBeforeStep, heldAfterStep, shared: await prefetched[0] === await stepped[0] };
}, { bytes, identity, shas, probe: decodeProbe.toString() });
assert.equal(result.heldBeforeStep, 2, "The prefetches waited behind the reserve");
assert.equal(result.heldAfterStep, 4, "Stepped onto, they started at once");
assert.equal(result.shared, true);
assert.deepEqual(errors, []);
});
test("a prefetch read that never finishes does not stop Compare reading the next screens ahead", { timeout: 90_000 }, async t => {
const { bytes, screens } = await changedScreensArchive(5);
const { page, errors } = await harness(t, bytes, { app: true, open: false, query: "&view=compare&screen=screen-1" });
await recordScreenshotReads(page);
// Screen-2's Before never finishes verifying.
await page.evaluate(stuck => {
const digest = crypto.subtle.digest.bind(crypto.subtle);
const hex = buffer => Array.from(new Uint8Array(buffer), byte => byte.toString(16).padStart(2, "0")).join("");
crypto.subtle.digest = async (algorithm, data) => {
const value = await digest(algorithm, data);
if (hex(value) === stuck) await new Promise(() => {});
return value;
};
}, screens[1].before.sha256);
await chooseFile(page, bytes);
const compare = page.locator(".compare-section");
await expect(compare.locator(".compare-frame img[data-screenshot-state='ready']")).toHaveCount(2);
const prefetchesOf = screen => page.evaluate(references => window.reads.filter(read => read.priority === "prefetch" && references.includes(read.reference)).length,
[screen.before.reference, screen.after.reference]);
await expect.poll(() => prefetchesOf(screens[1])).toBe(2);
await page.keyboard.press("ArrowRight");
await expect(compare.locator(".compare-nav-position")).toHaveText(/^2 of 5$/);
await expect.poll(() => prefetchesOf(screens[2])).toBe(2);
await page.keyboard.press("ArrowRight");
await expect(compare.locator(".compare-nav-position")).toHaveText(/^3 of 5$/);
await expect.poll(() => prefetchesOf(screens[3])).toBe(2);
assert.deepEqual(errors, []);
});
/** Opens Compare in Flip at `screen`, recording screenshot reads. */
async function openFlip(t, bytes, screen) {
const opened = await harness(t, bytes, { app: true, open: false, query: `&view=compare&screen=${screen}` });
await opened.page.addInitScript(() => localStorage.setItem("expo-explore:compare-mode", "flip"));
await opened.page.reload();
await recordScreenshotReads(opened.page);
return opened;
}
/** Holds back verifying the screenshot with this hash until `window.releaseHeld()`. */
const holdScreenshot = (page, sha256) => page.evaluate(held => {
const digest = crypto.subtle.digest.bind(crypto.subtle);
const hex = buffer => Array.from(new Uint8Array(buffer), byte => byte.toString(16).padStart(2, "0")).join("");
const waiting = [];
window.releaseHeld = () => waiting.splice(0).forEach(release => release());
crypto.subtle.digest = async (algorithm, data) => {
const value = await digest(algorithm, data);
if (hex(value) === held) await new Promise(resolve => waiting.push(resolve));
return value;
};
}, sha256);
test("Flip reads the next screen's Before when a step keeps the After it shows, which fires no load", { timeout: 90_000 }, async t => {
// Screen-2 keeps screen-1's After beside a Before of its own.
const { bytes, screens } = await changedScreensArchive(3, { sameAfter: { 1: 0 } });
const { page, errors } = await openFlip(t, bytes, "screen-1");
await chooseFile(page, bytes);
const frame = page.locator(".compare-section .compare-flip-frame");
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
await page.keyboard.press("ArrowRight");
await expect(page.locator(".compare-section .compare-nav-position")).toHaveText(/^2 of 3$/);
await expect(frame.locator(".compare-flip-layer[data-side='before'] img")).toHaveAttribute("data-screenshot-src", screens[1].before.reference);
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
assert.deepEqual(errors, []);
});
test("Flip stepped from Before shows the next screen's After from its first frame and reads its Before only once After is ready", { timeout: 90_000 }, async t => {
const { bytes, screens } = await changedScreensArchive(3);
const { page, errors } = await openFlip(t, bytes, "screen-1");
await chooseFile(page, bytes);
const frame = page.locator(".compare-section .compare-flip-frame");
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
await page.keyboard.press("KeyX");
await expect(frame).toHaveAttribute("data-side", "before");
await holdScreenshot(page, screens[1].after.sha256);
// Every frame from the step: which side the frame shows, and which layers are mounted.
await page.evaluate(() => {
window.flipFrames = [];
const sample = () => {
const element = document.querySelector(".compare-flip-frame");
window.flipFrames.push({ route: document.querySelector(".compare-nav-route")?.textContent, side: element?.dataset.side,
layers: [...(element?.querySelectorAll(".compare-flip-layer") ?? [])].map(layer => layer.dataset.side).join(",") });
if (window.flipFrames.length < 20) requestAnimationFrame(sample);
};
requestAnimationFrame(sample);
});
await page.keyboard.press("ArrowRight");
await expect.poll(() => page.evaluate(() => window.flipFrames.length)).toBe(20);
const stepped = (await page.evaluate(() => window.flipFrames)).filter(sample => sample.route === "/screen-2");
assert.ok(stepped.length > 0);
assert.deepEqual([...new Set(stepped.map(sample => `${sample.side}:${sample.layers}`))], ["after:after"],
"From its first frame screen-2 shows After alone");
const readsOf = reference => page.evaluate(reference => window.reads.filter(read => read.reference === reference && read.priority !== "prefetch").length, reference);
assert.equal(await readsOf(screens[1].before.reference), 0, "Before waits for After");
await page.evaluate(() => window.releaseHeld());
await expect(frame.locator(".compare-flip-layer img[data-screenshot-state='ready']")).toHaveCount(2);
assert.deepEqual(errors, []);
});
+211 -2
View File
@@ -48,6 +48,8 @@ const entry = `
import { useEffect, useState } from "react";
import { createRoot } from "react-dom/client";
import { ScreenshotImage } from "/src/components/shared/screenshot-image.tsx";
// The Viewer's own rules hide a waiting screenshot and fade a ready one in.
if (window.fixture.styles) await import("/src/styles.css");
function Harness() {
const [state, setState] = useState(window.fixture);
@@ -66,10 +68,13 @@ function Harness() {
return <main style={{ position: "relative", height: state.layout === "scroll" ? 3300 : 300,
width: 600, overflow: state.layout === "pan" ? "hidden" : undefined }}>
{state.normalSource && <ScreenshotImage src={state.normalSource} alt="Hosted screenshot"
width={24} height={18} decoding="async" onLoad={loaded} />}
width={24} height={18} decoding="async" onLoad={loaded} {...(state.holdPrevious ? { holdPrevious: true } : {})}
{...(state.fallback ? { fallback: <span data-testid="hosted-fallback">No hosted screenshot</span> } : {})} />}
<div data-testid="positioner" style={{ position: "absolute", left: 20,
top: state.layout === "scroll" ? 3000 : 30,
transform: state.layout === "pan" ? "translateX(2500px)" : undefined }}>
transform: state.layout === "pan" ? "translateX(2500px)" : undefined }}
{...(state.instant ? { "data-screenshot-instant": "" } : {})}
{...(state.thumbnail ? { className: "variant-thumbnail", "aria-selected": "false" } : {})}>
{state.mounted !== false && <ScreenshotImage src={state.source} alt="Captured checkout"
width={120} height={80} loading={state.loading} decoding="async" className="captured-image"
data-screen="checkout" onLoad={loaded} onError={failed}
@@ -106,6 +111,18 @@ async function fixture(t, options = {}) {
response.end(firstImage);
return;
}
// A hosted screenshot that is not there.
if (request.url === "/__missing.png") {
response.statusCode = 404;
response.end("Not found");
return;
}
// A hosted screenshot that takes a while to arrive.
if (request.url === "/__slow.png") {
response.setHeader("Content-Type", "image/png");
setTimeout(() => response.end(secondImage), 600);
return;
}
if (request.url !== "/") return next();
response.setHeader("Content-Type", "text/html");
response.end('<!doctype html><html><head><style>body{margin:0}</style></head><body><div id="root"></div><script type="module" src="/__screenshot_image.tsx"></script></body></html>');
@@ -163,7 +180,15 @@ async function fixture(t, options = {}) {
window.pendingScreenshots.delete(source);
for (const { reject } of pending) reject(new Error("Screenshot resolution failed"));
};
if (fixture.decode === "manual") {
// The test settles each decode; one it never settles stands in for a decode that hangs.
window.pendingDecodes = [];
HTMLImageElement.prototype.decode = function () {
return new Promise((resolve, reject) => window.pendingDecodes.push({ image: this, resolve, reject }));
};
}
}, { source: firstSource, layout: "visible", ...options });
if (options.reducedMotion) await page.emulateMedia({ reducedMotion: "reduce" });
await page.goto(`http://127.0.0.1:${address.port}/`);
await page.waitForFunction(() => window.harnessReady);
return { page, image: page.getByRole("img", { name: "Captured checkout", exact: true }) };
@@ -505,3 +530,187 @@ test("an image that leaves and re-enters the viewport within one render is ready
await expect(image).not.toHaveAttribute("aria-busy", /.*/);
assert.equal(await page.evaluate(() => window.imageLoads.length), 1, "No second load event fired");
});
/** The image's opacity and state in each of the next `frames` frames, from the frame after `change` runs. */
async function framesAfter(page, change, frames = 4, selector = "img[alt='Captured checkout']") {
return page.evaluate(({ change, frames, selector }) => new Promise(resolve => {
const samples = [];
new Function(change)();
const sample = () => {
const image = document.querySelector(selector);
samples.push(image ? { source: image.dataset.screenshotSrc ?? image.getAttribute("src"),
state: image.dataset.screenshotState, opacity: getComputedStyle(image).opacity } : undefined);
if (samples.length < frames) requestAnimationFrame(sample);
else resolve(samples);
};
requestAnimationFrame(sample);
}), { change, frames, selector });
}
/** The reveal animation on the image, paused and sought to `at` milliseconds: its opacity there. */
async function revealOpacityAt(image, at) {
return image.evaluate((element, at) => {
const [animation] = element.getAnimations().filter(animation => animation.animationName === "screenshot-reveal");
if (!animation) return undefined;
animation.pause();
animation.currentTime = at;
return Number(getComputedStyle(element).opacity);
}, at);
}
test("a waiting screenshot is hidden from its first frame, and one that fills its empty frame fades in", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true });
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
await expect(image).toHaveCSS("opacity", "0");
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.equal(await revealOpacityAt(image, 0), 0, "The fade starts from nothing");
const midway = await revealOpacityAt(image, 80);
assert.ok(midway > 0 && midway < 1, `Halfway through the fade the picture is partly shown (${midway})`);
await image.evaluate(element => element.getAnimations().forEach(animation => animation.finish()));
await expect(image).toHaveCSS("opacity", "1");
// Another source: the picture before is hidden in the very frame the new source lands, never faded out.
const samples = await framesAfter(page, `window.updateScreenshot({ source: ${JSON.stringify(secondSource)} })`);
const landed = samples.filter(sample => sample?.source === secondSource);
assert.ok(landed.length > 0, "The new source landed within a few frames");
assert.deepEqual(landed.map(sample => sample.opacity), landed.map(() => "0"));
assert.deepEqual(samples.filter(sample => sample?.source !== secondSource).map(sample => sample.opacity),
samples.filter(sample => sample?.source !== secondSource).map(() => "1"), "Until then, the shown picture is the one it names");
assert.deepEqual(await image.evaluate(element => element.getAnimations().map(animation => animation.constructor.name)), [],
"Nothing animates the hiding");
});
test("a loaded screenshot is shown only once it has decoded, or after a short wait for a decode that hangs", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, decode: "manual" });
await resolveImage(page, firstSource);
// The caller hears the load at once (Compare takes its shape from it); the picture waits for its pixels.
await expect.poll(() => page.evaluate(() => window.imageLoads.length)).toBe(1);
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
await page.waitForTimeout(100);
await expect(image).toHaveAttribute("data-screenshot-state", "loading");
await expect(image).toHaveCSS("opacity", "0");
await page.evaluate(() => window.pendingDecodes.shift().resolve());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
// A decode that never settles: shown anyway, with its fade.
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await resolveImage(page, secondSource, secondImage);
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
const loadedAt = await page.evaluate(() => performance.now());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
const waited = await page.evaluate(() => performance.now()) - loadedAt;
assert.ok(waited >= 200, `The hung decode was waited for before the picture was shown (${Math.round(waited)}ms)`);
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.equal(await image.evaluate(element => element.naturalWidth), 4);
});
test("a screenshot the report still holds decoded fades in when it is shown again", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true });
const url = await blobUrl(page, firstImage);
await expect.poll(() => page.evaluate(() => window.resolverCalls)).toEqual([firstSource]);
await page.evaluate(({ source, url }) => window.resolveScreenshot(source, url), { source: firstSource, url });
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// Shown again (Compare stepping back to it, a view mounting again) while the report still holds its decoded URL.
await page.evaluate(() => window.updateScreenshot({ mounted: false }));
await expect(image).toHaveCount(0);
await page.evaluate(({ source, url }) => {
window.immediateScreenshots.set(source, url);
window.updateScreenshot({ mounted: true });
}, { source: firstSource, url });
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).toHaveAttribute("data-screenshot-reveal", "");
assert.equal(await revealOpacityAt(image, 0), 0);
});
test("an ordinary URL is a new image for each source and never shows the one before while it loads", { timeout: 30_000 }, async t => {
const { page } = await fixture(t, { loading: "eager", styles: true, normalSource: "/__normal.png" });
const hosted = page.getByRole("img", { name: "Hosted screenshot", exact: true });
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
await expect(hosted).toHaveAttribute("data-screenshot-reveal", "");
await hosted.evaluate(element => { element.dataset.first = "true"; });
const samples = await framesAfter(page, "window.updateScreenshot({ normalSource: '/__slow.png' })", 6, "img[alt='Hosted screenshot']");
const landed = samples.filter(sample => sample?.source === "/__slow.png");
assert.ok(landed.length > 0);
assert.deepEqual(landed.map(sample => [sample.state, sample.opacity]), landed.map(() => ["loading", "0"]));
await expect(hosted).not.toHaveAttribute("data-first", /.*/);
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
await expect(hosted).toHaveAttribute("data-screenshot-reveal", "");
await expectDecoded(hosted, 4, 5);
});
test("a held picture stays shown while its replacement loads, and the replacement appears without a fade", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, holdPrevious: true, fallback: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(source => window.updateScreenshot({ source }), secondSource);
await expect(image).toHaveAttribute("data-screenshot-held", "");
await expect(image).toHaveCSS("opacity", "1");
await resolveImage(page, secondSource, secondImage);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expectDecoded(image, 4, 5);
await expect(image).not.toHaveAttribute("data-screenshot-reveal", /.*/);
await expect(image).not.toHaveAttribute("data-screenshot-held", /.*/);
assert.deepEqual(await image.evaluate(element => element.getAnimations().length), 0);
});
test("inside an instant stage a picture appears at once", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, instant: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await expect(image).not.toHaveAttribute("data-screenshot-reveal", /.*/);
await expect(image).toHaveCSS("opacity", "1");
});
test("with reduced motion a screenshot appears without a fade", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, reducedMotion: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
// The Viewer's reduced-motion rule leaves every transition a hundredth of a millisecond long; the fade is gone.
assert.deepEqual(await image.evaluate(element => element.getAnimations().map(animation => animation.animationName).filter(Boolean)), []);
await expect(image).toHaveCSS("opacity", "1");
});
test("an unselected variant thumbnail that changes source hides at once, despite its own dimmed opacity and its transition", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, thumbnail: true });
await resolveImage(page, firstSource);
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
await image.evaluate(element => element.getAnimations().forEach(animation => animation.finish()));
await expect(image).toHaveCSS("opacity", "0.35");
const samples = await framesAfter(page, `window.updateScreenshot({ source: ${JSON.stringify(secondSource)} })`);
const landed = samples.filter(sample => sample?.source === secondSource);
assert.ok(landed.length > 0);
assert.deepEqual(landed.map(sample => sample.opacity), landed.map(() => "0"));
});
test("an ordinary URL that cannot be loaded shows the fallback, and a held one gives way to it", { timeout: 30_000 }, async t => {
const { page } = await fixture(t, { loading: "eager", styles: true, fallback: true, holdPrevious: true, normalSource: "/__normal.png" });
const hosted = page.getByRole("img", { name: "Hosted screenshot", exact: true });
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
// The app icon's case: a held picture whose replacement is missing ends on the fallback, not on the picture before.
await page.evaluate(() => window.updateScreenshot({ normalSource: "/__missing.png" }));
await expect(page.getByTestId("hosted-fallback")).toHaveText("No hosted screenshot");
await expect(hosted).toHaveCount(0);
// A new source tries again.
await page.evaluate(() => window.updateScreenshot({ normalSource: "/__normal.png" }));
await expect(hosted).toHaveAttribute("data-screenshot-state", "ready");
await expect(page.getByTestId("hosted-fallback")).toHaveCount(0);
});
test("re-rendering an image that waits for its decode starts no second wait", { timeout: 30_000 }, async t => {
const { page, image } = await fixture(t, { loading: "eager", styles: true, decode: "manual" });
await resolveImage(page, firstSource);
await expect.poll(() => page.evaluate(() => window.pendingDecodes.length)).toBe(1);
// Renders while the decode is pending find the image loaded but not shown yet.
for (let render = 0; render < 5; render++) {
await page.evaluate(render => window.updateScreenshot({ render }), render);
await page.evaluate(() => new Promise(resolve => requestAnimationFrame(resolve)));
}
assert.equal(await page.evaluate(() => window.pendingDecodes.length), 1, "One decode wait for the one picture");
await page.evaluate(() => window.pendingDecodes.shift().resolve());
await expect(image).toHaveAttribute("data-screenshot-state", "ready");
});
+46 -5
View File
@@ -5,11 +5,13 @@ import { chromium, expect } from "@playwright/test";
import { PNG } from "pngjs";
import { createBrowserVite } from "../helpers/browser-vite.mjs";
function png(width, height, color) {
function pngBytes(width, height, color) {
const image = new PNG({ width, height });
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
return PNG.sync.write(image);
}
const png = (width, height, color) => `data:image/png;base64,${pngBytes(width, height, color).toString("base64")}`;
const GREEN = [40, 200, 40];
// Split over one screen with two changed areas and a card that moved 40% of the width right (at 60% in After, so
// at 20% in Before), and a second screen with one changed area elsewhere. The status bar CI left out is a foldable's
@@ -45,7 +47,9 @@ function Harness() {
window.addEventListener("keydown", onKey);
return () => window.removeEventListener("keydown", onKey);
}, []);
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: window.before, afterScreenshot: window.after };
// The second screen has screenshots of its own when the test gives it some.
const diff = { id: "s" + screen, status: "modified", beforeScreenshot: screen && window.nextBefore || window.before,
afterScreenshot: screen && window.nextAfter || window.after };
return (
<div className={"compare-stage mode-" + mode} style={{ width: 800, height: 500, display: "flex" }}>
<CompareStage key="stage" mode={mode} diff={diff} title="Share" areas={screens[screen]} activeArea={active}
@@ -57,7 +61,7 @@ function Harness() {
createRoot(document.getElementById("root")).render(<Harness />);
`;
async function openSplit(t, contextOptions = {}) {
async function openSplit(t, contextOptions = {}, images = {}) {
const vite = await createBrowserVite(t, {
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
logLevel: "error", esbuild: { jsx: "automatic" },
@@ -67,6 +71,12 @@ async function openSplit(t, contextOptions = {}) {
load: id => id === "/__split-outlines.tsx" ? entry : undefined,
configureServer(server) {
server.middlewares.use((request, response, next) => {
// The next screen's Before, which takes a while to arrive.
if (request.url === "/__slow-before.png") {
response.setHeader("Content-Type", "image/png");
setTimeout(() => response.end(pngBytes(100, 100, GREEN)), 1000);
return;
}
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
response.setHeader("Content-Type", "text/html");
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__split-outlines.tsx"></script></body></html>');
@@ -82,7 +92,7 @@ async function openSplit(t, contextOptions = {}) {
const errors = [];
page.on("pageerror", error => errors.push(error.message));
t.after(() => assert.deepEqual(errors, []));
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]), ...images });
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
const outline = (side, index) => page.locator(`[data-side="${side}"] .visual-change-outline`).nth(index);
await expect(outline("after", 0)).toBeVisible();
@@ -143,3 +153,34 @@ test("A screen without hover keeps Before's outlines, as it cannot reveal one",
await expect.poll(() => opacity(outline("before", 0))).toBe(1);
await expect.poll(() => opacity(outline("before", 2))).toBe(1);
});
test("Stepping never shows the screen before's pictures under the next one's outlines: a side still loading is an empty frame", { timeout: 30_000 }, async t => {
const images = { before: png(100, 100, [200, 40, 40]), after: png(100, 100, [40, 40, 200]),
nextBefore: "/__slow-before.png", nextAfter: png(100, 100, [200, 200, 40]) };
const { page } = await openSplit(t, {}, images);
for (const side of ["before", "after"]) await expect(page.locator(`[data-side="${side}"] img`)).toHaveAttribute("data-screenshot-state", "ready");
// Every frame from the step on: the screen the outlines belong to, and any picture of the screen before still showing.
await page.evaluate(previous => {
window.stepFrames = [];
const sample = () => {
const outlines = document.querySelectorAll('[data-side="after"] .visual-change-outline').length;
const stale = [...document.querySelectorAll(".compare-frame img")].filter(image => previous.includes(image.getAttribute("src"))
&& Number(getComputedStyle(image).opacity) > 0).length;
window.stepFrames.push({ outlines, stale });
if (window.stepFrames.length < 30) requestAnimationFrame(sample);
};
requestAnimationFrame(sample);
}, [images.before, images.after]);
await page.keyboard.press("n");
await expect.poll(() => page.evaluate(() => window.stepFrames.length)).toBe(30);
const frames = await page.evaluate(() => window.stepFrames);
assert.ok(frames.some(frame => frame.outlines === 1), "The step landed while the frames were sampled");
assert.deepEqual(frames.filter(frame => frame.outlines === 1 && frame.stale > 0), [], "No frame showed a picture of the screen before under the next one's outlines");
// Before is still loading: its frame is empty, After's shows the new screen.
const before = page.locator('[data-side="before"] img');
await expect(before).toHaveAttribute("data-screenshot-state", "loading");
await expect(before).toHaveCSS("opacity", "0");
await expect(page.locator('[data-side="after"] img')).toHaveAttribute("data-screenshot-state", "ready");
await expect(before).toHaveAttribute("data-screenshot-state", "ready", { timeout: 5000 });
});
+53 -6
View File
@@ -5,11 +5,15 @@ import { chromium, expect } from "@playwright/test";
import { PNG } from "pngjs";
import { createBrowserVite } from "../helpers/browser-vite.mjs";
function png(width, height, color) {
function pngBytes(width, height, color) {
const image = new PNG({ width, height });
for (let index = 0; index < image.data.length; index += 4) image.data.set([...color, 255], index);
return `data:image/png;base64,${PNG.sync.write(image).toString("base64")}`;
return PNG.sync.write(image);
}
const png = (width, height, color) => `data:image/png;base64,${pngBytes(width, height, color).toString("base64")}`;
const RED = [200, 40, 40];
const BLUE = [40, 40, 200];
// A card that moved 40% of the width right: it is at 60% in After, so it was at 20% in Before.
const entry = `
@@ -19,11 +23,11 @@ import "/src/styles.css";
const changes = [{ x: 60, y: 30, width: 30, height: 30, share: 100, regionCount: 1,
move: { x: 40, y: 0, amount: { x: 400, y: 0 }, unit: "px" } }];
createRoot(document.getElementById("root")).render(<div style={{ width: 400, display: "flex" }}>
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={50} />
<SwipeCompare title="Share" before={window.before} after={window.after} imageAspect={1} changes={changes} position={window.position ?? 50} />
</div>);
`;
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
async function openSwipe(t, images) {
const vite = await createBrowserVite(t, {
configFile: false, root: fileURLToPath(new URL("../../viewer", import.meta.url)),
logLevel: "error", esbuild: { jsx: "automatic" },
@@ -33,6 +37,12 @@ test("Swipe draws a moved area where its content was on Before's half and where
load: id => id === "/__swipe-outlines.tsx" ? entry : undefined,
configureServer(server) {
server.middlewares.use((request, response, next) => {
// A Before that takes a while to arrive.
if (request.url === "/__slow-before.png") {
response.setHeader("Content-Type", "image/png");
setTimeout(() => response.end(pngBytes(100, 100, RED)), 1000);
return;
}
if (new URL(request.url, "http://localhost").pathname !== "/") return next();
response.setHeader("Content-Type", "text/html");
response.end('<!doctype html><html><body style="margin:0"><div id="root"></div><script type="module" src="/__swipe-outlines.tsx"></script></body></html>');
@@ -47,9 +57,23 @@ test("Swipe draws a moved area where its content was on Before's half and where
const page = await browser.newPage({ viewport: { width: 600, height: 600 } });
const errors = [];
page.on("pageerror", error => errors.push(error.message));
await page.addInitScript(images => Object.assign(window, images), { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
t.after(() => assert.deepEqual(errors, []));
await page.addInitScript(images => Object.assign(window, images), images);
await page.goto(`http://127.0.0.1:${vite.httpServer.address().port}/`);
return page;
}
/** The colour on screen at `x` (a share of the frame's width), a fifth of the way down the Swipe frame, clear of the divider's handle. */
async function colourAt(page, x) {
const box = await page.locator(".visual-swipe").boundingBox();
const shot = PNG.sync.read(await page.screenshot({ clip: { x: box.x + box.width * x, y: box.y + box.height / 5, width: 1, height: 1 } }));
return [...shot.data.subarray(0, 3)];
}
const near = (colour, expected) => colour.every((value, index) => Math.abs(value - expected[index]) <= 6);
test("Swipe draws a moved area where its content was on Before's half and where it is on After's", { timeout: 30_000 }, async t => {
const page = await openSwipe(t, { before: png(100, 100, [240, 240, 240]), after: png(100, 100, [230, 230, 230]) });
const frame = page.locator(".visual-swipe");
const before = page.locator(".visual-swipe-outlines.before .visual-change-outline.moved");
const after = page.locator(".visual-swipe-outlines.after .visual-change-outline.moved");
@@ -60,5 +84,28 @@ test("Swipe draws a moved area where its content was on Before's half and where
// Each side's outlines show only over its own half of the frame.
const clips = await page.locator(".visual-swipe-outlines").evaluateAll(spans => spans.map(span => getComputedStyle(span).clipPath));
assert.deepEqual(clips.map(clip => clip.startsWith("inset(")), [true, true]);
assert.deepEqual(errors, []);
});
test("Swipe never shows After on Before's half: while Before loads, its half is the empty frame", { timeout: 30_000 }, async t => {
const page = await openSwipe(t, { before: "/__slow-before.png", after: png(100, 100, BLUE) });
const before = page.locator("img.visual-swipe-before");
await expect(page.locator("img.visual-swipe-after")).toHaveAttribute("data-screenshot-state", "ready");
await expect(before).toHaveAttribute("data-screenshot-state", "loading");
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
assert.ok(near(await colourAt(page, 0.75), BLUE), "After shows on its own half");
const waiting = await colourAt(page, 0.25);
assert.ok(!near(waiting, BLUE) && !near(waiting, RED), `Before's half is the empty frame while Before loads: ${waiting}`);
await expect(before).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
assert.ok(near(await colourAt(page, 0.25), RED));
assert.ok(near(await colourAt(page, 0.75), BLUE));
});
for (const [position, shown] of [[0, BLUE], [100, RED]]) {
test(`Swipe at ${position}% shows only ${position ? "Before" : "After"}, across the whole frame`, { timeout: 30_000 }, async t => {
const page = await openSwipe(t, { before: png(100, 100, RED), after: png(100, 100, BLUE), position });
for (const side of ["before", "after"]) await expect(page.locator(`img.visual-swipe-${side}`)).toHaveAttribute("data-screenshot-state", "ready");
await page.evaluate(() => document.getAnimations().forEach(animation => animation.finish()));
for (const x of [0.03, 0.5, 0.97]) assert.ok(near(await colourAt(page, x), shown), `${position}%: ${x} of the way across`);
});
}
+115 -3
View File
@@ -1254,7 +1254,7 @@ test("does not send viewer cookies to a cross-origin static workspace", async ({
test("the logo returns to the Map root", async ({ page }) => {
await page.goto("/screens?screen=settings-root");
await page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true }).click();
await page.locator(".left-panel-collapsed-pill").getByRole("button", { name: /^Map of / }).click();
await expect(page).toHaveURL(/\/map$/);
await expect(page.locator(".map-canvas")).toBeVisible();
});
@@ -2811,7 +2811,7 @@ test("floats the pill over the canvas and remembers the Inspector across a reloa
expect(expandedCameraShadow).not.toBe("none");
const collapsedPanel = page.locator(".left-panel.collapsed");
await expect(collapsedPanel).toBeVisible();
await expect(collapsedPanel.getByRole("button", { name: "Map", exact: true })).toBeVisible();
await expect(collapsedPanel.getByRole("button", { name: /^Map of / })).toBeVisible();
await expect(collapsedPanel.locator(".collapsed-app-identity strong")).toBeVisible();
// There is no sidebar to open: the pill is the only left chrome.
await expect(page.getByRole("button", { name: /^(Expand|Collapse) panel$/ })).toHaveCount(0);
@@ -3076,7 +3076,7 @@ test("keeps fixed objects and canvas pan after a reload", async ({ page }) => {
test("delays the first tooltip, then shows subsequent tooltips instantly", async ({ page }) => {
await page.goto("/map");
const menu = page.locator(".left-panel-collapsed-pill").getByRole("button", { name: "Map", exact: true });
const menu = page.locator(".left-panel-collapsed-pill").getByRole("button", { name: /^Map of / });
const changes = page.getByRole("button", { name: "Fit canvas", exact: true });
const tooltip = page.locator(".tooltip");
@@ -3576,6 +3576,13 @@ test("the Map's top right holds only fit, center and zoom; theme and full screen
await expect.poll(() => viewport.getAttribute("style")).not.toBe(panned);
await expect.poll(async () => scaleFromTransform(await viewport.getAttribute("style")))
.toBeCloseTo(pannedScale, 6);
// The flight to the centre dips the scale on its way, and a drag interrupts it where it is: let it
// land first, the camera unchanged across two frames. The check above can pass on the flight's
// first frame, before the dip shows.
await expect.poll(() => viewport.evaluate((element) => new Promise<boolean>((resolve) => {
const before = element.getAttribute("style");
requestAnimationFrame(() => requestAnimationFrame(() => resolve(element.getAttribute("style") === before)));
}))).toBe(true);
// The keyboard shortcut performs the same scale-preserving camera action.
await page.mouse.move(panPoint.x, panPoint.y);
@@ -4432,6 +4439,93 @@ test("pull-request comment deep links open the Changes filter and a surface's Di
expect(new URL(page.url()).searchParams.get("workspace")).toBe(workspaceUrl);
});
/**
* Records, every frame, the route Compare names and the screenshots it shows: those at any opacity above nothing,
* not on a hidden Flip side. An image still loading counts as the source it had before, which the browser keeps
* painting until the new one is there. `staleCompareFrames` then checks each frame showed only its own screen's.
*/
async function sampleCompareFrames(page: Page, root: string) {
await page.evaluate((root) => {
const record = window as unknown as { compareFrames: { route: string; shown: string[] }[]; sampling: boolean };
record.compareFrames = [];
record.sampling = true;
const sample = () => {
const scope = document.querySelector(root);
const route = scope?.querySelector(".compare-nav-route")?.textContent ?? "";
const shown = [...(scope?.querySelectorAll<HTMLImageElement>(".compare-stage img") ?? [])]
.filter((image) => Number(getComputedStyle(image).opacity) > 0 && getComputedStyle(image).visibility !== "hidden")
.map((image) => image.complete && image.naturalWidth > 0 ? image.getAttribute("src") ?? "" : "(still loading)");
record.compareFrames.push({ route, shown });
if (record.sampling) requestAnimationFrame(sample);
};
requestAnimationFrame(sample);
}, root);
}
/** Every screenshot the stage holds for the route on show, once its pictures have loaded. */
async function settledCompareScreen(page: Page, root: string) {
const stage = page.locator(`${root} .compare-stage`);
await expect(stage.locator("img[data-screenshot-state='loading']")).toHaveCount(0);
return stage.evaluate((element, root) => ({
route: document.querySelector(root)?.querySelector(".compare-nav-route")?.textContent ?? "",
sources: [...element.querySelectorAll("img")].map((image) => image.getAttribute("src") ?? ""),
}), root);
}
/** The sampled frames in which a picture showed under a route it does not belong to. */
async function staleCompareFrames(page: Page, screens: { route: string; sources: string[] }[]) {
const frames = await page.evaluate(() => {
const record = window as unknown as { compareFrames: { route: string; shown: string[] }[]; sampling: boolean };
record.sampling = false;
return record.compareFrames;
});
const sources = new Map<string, Set<string>>();
for (const screen of screens) sources.set(screen.route, new Set([...(sources.get(screen.route) ?? []), ...screen.sources]));
expect(new Set(frames.map((frame) => frame.route)).size, "The steps were sampled").toBeGreaterThan(1);
return frames.filter((frame) => frame.shown.some((source) => !sources.get(frame.route)?.has(source)));
}
test("a screenshot whose URL cannot be loaded shows No screenshot in its frame on the Map and in the Inspector", async ({ page }) => {
await page.route((url) => url.pathname === "/api/artifacts/artifacts/area-0-screen-1-0.svg", (route) => route.fulfill({ status: 404, body: "" }));
await page.goto("/map");
const card = (title: string) => page.locator(".map-canvas .react-flow__node").filter({ hasText: title }).locator(".screen-node-image");
const missing = card("/onboarding-step-2").locator(".image-placeholder");
await expect(missing).toContainText("No screenshot");
await expect(card("/onboarding-step-2").locator("img")).toHaveCount(0);
// The placeholder takes the frame the screenshot would have had, like the screenshot beside it.
const neighbour = card("/onboarding-step-1").locator("img");
await expect(neighbour).toHaveAttribute("data-screenshot-state", "ready");
const size = (locator: Locator) => locator.evaluate((element) => [element.offsetWidth, element.offsetHeight]);
expect(await size(missing)).toEqual(await size(neighbour));
await expect(card("/onboarding-step-2").locator(".screenshot-backing")).toHaveCSS("visibility", "hidden");
await page.locator(".map-canvas .react-flow__node").filter({ hasText: "/onboarding-step-2" }).locator(".screen-screenshot-target").click();
await expect(page.locator(".right-panel .inspector-preview .screenshot-placeholder")).toContainText("No screenshot");
});
test("stepping Compare by key or by its buttons never shows the screen before's pictures under the next one's name", async ({ page }) => {
await page.setViewportSize({ width: 1440, height: 860 });
await serveWorkspace(page);
await page.goto("/compare?screen=current-profile");
const root = ".compare-section";
const bar = page.locator(`${root} .compare-bar`);
await expect(bar).toBeVisible();
for (const mode of ["1", "2", "3"]) {
await page.keyboard.press(mode);
const screens = [await settledCompareScreen(page, root)];
await sampleCompareFrames(page, root);
await page.keyboard.press("ArrowRight");
screens.push(await settledCompareScreen(page, root));
await bar.getByRole("button", { name: "Previous changed screen" }).click();
screens.push(await settledCompareScreen(page, root));
await bar.getByRole("button", { name: "Next changed screen" }).click();
screens.push(await settledCompareScreen(page, root));
await page.keyboard.press("ArrowLeft");
screens.push(await settledCompareScreen(page, root));
expect(await staleCompareFrames(page, screens), `Mode ${mode}`).toEqual([]);
}
});
test("desktop Compare: one command bar with the modes in it, even gaps to both bars", async ({ page }) => {
await page.setViewportSize({ width: 1440, height: 860 });
await serveWorkspace(page);
@@ -4906,6 +5000,24 @@ test.describe("phone layout", () => {
}
});
test("stepping Compare from the header never shows the screen before's pictures under the next one's name", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/map");
await page.getByRole("navigation", { name: "Views" }).getByRole("button", { name: /Compare/ }).tap();
const root = ".phone-compare";
const compare = page.locator(root);
await expect(compare).toBeVisible();
const next = compare.getByRole("button", { name: "Next changed screen" });
const previous = compare.getByRole("button", { name: "Previous changed screen" });
const screens = [await settledCompareScreen(page, root)];
await sampleCompareFrames(page, root);
for (const step of [next, next, previous]) {
await step.tap();
screens.push(await settledCompareScreen(page, root));
}
expect(await staleCompareFrames(page, screens)).toEqual([]);
});
test("Compare is full screen, opens in Flip and steps from the header", async ({ page }) => {
await serveWorkspace(page);
await page.goto("/map");
+45 -2
View File
@@ -293,7 +293,7 @@ test("action rejects unsupported Node versions before installing tools", async t
test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it runs only for a requested hosted preview", () => {
const deploy = review.jobs.deploy;
assert.deepEqual(deploy.needs, ["targets", "capture", "report"]);
assert.equal(deploy.if, "needs.capture.outputs.preview == 'eas'");
assert.equal(deploy.if, "needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()");
assert.deepEqual(deploy.permissions, { contents: "read", actions: "read", "pull-requests": "write" });
const step = deploy.steps.find(step => step.name === "Deploy the hosted preview and publish its Explore report links");
assert.equal(step.env.EXPO_TOKEN, "${{ secrets.EXPO_TOKEN }}");
@@ -305,7 +305,8 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
assert.deepEqual(downloads.map(step => step.with.pattern), ["explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-*", "explore-review-${{ github.run_id }}-${{ github.run_attempt }}-*"]);
assert.ok(downloads.every(step => step.with.name === undefined && step.with["merge-multiple"] === undefined));
assert.doesNotMatch(JSON.stringify(deploy), /OPENAI_API_KEY|ANTHROPIC_API_KEY/);
assert.equal(review.jobs.report.outputs, undefined);
// A report job hands forward only whether it published; its artifact URL is looked up again (matrix outputs keep one leg's value).
assert.deepEqual(review.jobs.report.outputs, { published: "${{ steps.publish.outputs.published }}" });
// capture:review writes preview=<hosting> to the step outputs from the reviewed config.
assert.equal(review.jobs.capture.outputs.preview, "${{ steps.capture.outputs.preview }}");
assert.match(review.jobs.capture.steps.find(step => step.id === "capture").run, /capture:review/);
@@ -314,6 +315,48 @@ test("the deploy job is the only post-capture job that holds EXPO_TOKEN, and it
assert.match(review.jobs.failure.if, /needs\.deploy\.result == 'failure'/);
});
test("one target's failed capture keeps neither the other targets' reports nor the preview off the PR (brentvatne/euxy#172)", async t => {
for (const workflow of [review, compare]) {
const report = workflow.jobs.report;
// A plain needs: [capture] skips every report once one capture leg fails; !cancelled() runs them, except in a cancelled run.
assert.equal(report.if, "needs.targets.result == 'success' && !cancelled()");
assert.deepEqual(report.needs, ["targets", "capture"]);
const [download, check] = report.steps;
assert.ok(download.uses.startsWith("actions/download-artifact@"));
// A pattern without a wildcard names this leg's artifact alone, and matching nothing is not a failure, as a name is.
assert.deepEqual(download.with, { pattern: "explore-capture-${{ github.run_id }}-${{ github.run_attempt }}-${{ matrix.target }}", path: "${{ runner.temp }}/explore-review" });
assert.equal(download["continue-on-error"], undefined, "a download that went wrong still fails the leg");
assert.equal(check.id, "captured");
const explore = report.steps.filter(step => /cli\.js" ci:(report|publish)/.test(step.run ?? "") || step.uses?.startsWith("actions/upload-artifact@") && step.if !== "always()");
assert.equal(explore.length, 3);
for (const step of explore) assert.equal(step.if, "steps.captured.outputs.found == 'true'", step.name);
const publish = report.steps.find(step => step.id === "publish");
assert.match(publish.run, /ci:publish[^\n]*\n\s*echo "published=true" >> "\$GITHUB_OUTPUT"/, "published only once ci:publish succeeded");
assert.deepEqual(report.outputs, { published: "${{ steps.publish.outputs.published }}" });
assert.equal(workflow.jobs.deploy.if, "needs.report.outputs.published == 'true' && needs.capture.outputs.preview == 'eas' && !cancelled()");
assert.deepEqual(workflow.jobs.deploy.needs, ["targets", "capture", "report"]);
// The check reads what the download left: this target's report input, or nothing.
const root = await mkdtemp(join(tmpdir(), "explore-report-check-"));
t.after(() => rm(root, { recursive: true, force: true }));
const runCheck = async () => {
const output = join(root, "output"); await writeFile(output, "");
const result = spawnSync("bash", ["-c", check.run], { encoding: "utf8", env: { ...process.env, RUNNER_TEMP: root, GITHUB_OUTPUT: output, TARGET: "duo-open" } });
assert.equal(result.status, 0, result.stderr);
return { output: await readFile(output, "utf8"), stdout: result.stdout };
};
const failed = await runCheck();
assert.equal(failed.output, "");
assert.match(failed.stdout, /The duo-open capture uploaded no review: its capture job failed/);
await mkdir(join(root, "explore-review"), { recursive: true });
await writeFile(join(root, "explore-review", "report-input.json"), "{}");
assert.equal((await runCheck()).output, "found=true\n");
}
// The failure job still runs when a capture leg failed, and names that target from its diagnostics.
const failure = review.jobs.failure;
assert.match(failure.if, /^always\(\) && \(.*needs\.capture\.result == 'failure'.*needs\.report\.result == 'failure'/);
for (const step of failure.steps.filter(step => step.uses?.startsWith("actions/download-artifact@"))) assert.equal(step["continue-on-error"], true, step.name);
});
test("closing a pull request runs nothing: hosted previews stay until a developer deletes them", () => {
assert.ok(!review.on.pull_request_target.types.includes("closed"));
assert.doesNotMatch(review.jobs.targets.if, /closed/);
+36
View File
@@ -439,6 +439,42 @@ test("a reader stuck on the dark panel after a fold is reset once more before th
assert.equal(stuck.calls.filter(call => call.tool === "stop-all-simulator-servers").length, 2, "before the fold and once after, not in a loop");
});
// brentvatne/euxy#172, review run 39348956443: the fold after capture restarted SpringBoard failed with this, before it ran.
const DEPENDENCY_FAILED = "argent run fold failed: [Tool:fold] Service dependency failed: [SimulatorServer:74195B53-4DBC-4EAA-9991-F98E5BB86BA8] Timed out waiting for simulator-server to become ready";
test("a fold whose simulator-server did not start is sent again after a pause, and then folds", async () => {
const lit = { activeScreen: 3, screen: { id: 3, panel: "inner panel", width: 2007, height: 2853 }, posture: "open", hingeAngle: 180 };
const { run, calls, context } = harness("ios", { "list-devices": DUO_DEVICES, "ui-tree": DUO_OPEN_EDIT_LANE, "stop-all-simulator-servers": { stopped: [] },
fold: [new ArgentCallError(DEPENDENCY_FAILED, true), lit] });
const pauses = [];
context.sleep = async milliseconds => { pauses.push(milliseconds); };
assert.deepEqual((await run(["fold", "open", ...flags("ios")])).json.data, { action: "fold", pose: "open" });
assert.equal(calls.filter(call => call.tool === "fold").length, 2);
assert.deepEqual(pauses, [3_000], "one pause before the fold is sent again");
});
test("a fold whose simulator-server never starts fails as it did before, after two more tries", async () => {
const { run, calls, context } = harness("ios", { "list-devices": DUO_DEVICES, "ui-tree": DUO_OPEN_EDIT_LANE, "stop-all-simulator-servers": { stopped: [] },
fold: new ArgentCallError(DEPENDENCY_FAILED, true) });
const pauses = [];
context.sleep = async milliseconds => { pauses.push(milliseconds); };
const failed = await run(["fold", "open", ...flags("ios")]);
assert.deepEqual(failed.json.error, { code: "ARGENT_TOOL_FAILED", message: DEPENDENCY_FAILED });
assert.equal(calls.filter(call => call.tool === "fold").length, 3);
assert.deepEqual(pauses, [3_000, 6_000]);
});
test("a UI action that failed for another reason is still sent once, even when its message mentions a dependency", async () => {
// Only the tool's own wrap counts: a nested tool's dependency failure is not this tool failing to start.
for (const message of ["argent run gesture-tap failed: [Tool:gesture-tap] simulator-server answered 500",
"argent run gesture-tap failed: [Tool:gesture-tap] [Tool:keyboard] Service dependency failed: [SimulatorServer:x] Timed out"]) {
const { run, calls } = harness("ios", { "list-devices": IOS_DEVICES, "ui-tree": IOS_HOME, "gesture-tap": new ArgentCallError(message, true) });
const pressed = await run(["press", "10", "10", ...flags("ios")]);
assert.deepEqual(pressed.json.error, { code: "ARGENT_TOOL_FAILED", message });
assert.equal(calls.filter(call => call.tool === "gesture-tap").length, 1, message);
}
});
test("an alert that is not the link prompt is left for capture to answer", async () => {
const other = { ...IOS_HOME, alertVisible: true, foregroundApp: "com.apple.springboard",
roots: [{ type: "Alert", label: "Delete all data?", frame: { x: 0.1, y: 0.4, width: 0.8, height: 0.2 }, children: [
+16
View File
@@ -173,6 +173,22 @@ test("CI argument failures preserve JSON output, annotation, summary, and diagno
assert.match(await readFile(summary, "utf8"), /Next action/);
});
test("a failed command's diagnostics file names the matrix target it ran for, so the failure comment can", async (t) => {
const root = await mkdtemp(join(tmpdir(), "explore-cli-target-"));
t.after(() => rm(root, { recursive: true, force: true }));
const cli = new URL("../../src/cli.ts", import.meta.url);
const run = target => {
const result = spawnSync(process.execPath, ["--import", "tsx", cli.pathname, "ci:report", "--input", join(root, "missing.json"), "--output", join(root, "out"), "--target", target],
{ encoding: "utf8", env: { ...process.env, GITHUB_ACTIONS: "true", RUNNER_TEMP: root } });
assert.equal(result.status, 1, result.stderr);
return readFile(join(root, "explore-diagnostics/error.json"), "utf8").then(JSON.parse);
};
const written = await run("duo-closed");
assert.equal(written.target, "duo-closed");
assert.equal(written.code, "REPORT_INPUT_INVALID");
assert.equal((await run("../ios")).target, undefined, "only a valid target id is written");
});
test("source worker failures emit a structured diagnostic without a raw stack", () => {
const worker = new URL("../../src/source/plan-worker.ts", import.meta.url);
const result = spawnSync(process.execPath, ["--import", "tsx", worker.pathname], { input: "{", encoding: "utf8" });
+23
View File
@@ -60,6 +60,29 @@ test("ending a hold, or beginning another key, stops the first", (t) => {
assert.equal(left, 2);
});
test("a hold says when it ends, however it ends, and whether any key is held", (t) => {
t.mock.timers.enable({ apis: ["setTimeout"] });
const hold = createKeyHold();
const ended = [];
assert.ok(!hold.holding());
hold.begin("ArrowRight", () => true, () => ended.push("released"));
assert.ok(hold.holding());
hold.release("ArrowLeft");
assert.deepEqual(ended, [], "another key going up leaves it held");
hold.release("ArrowRight");
hold.begin("ArrowLeft", () => true, () => ended.push("replaced"));
hold.begin("ArrowRight", () => true, () => ended.push("ended"));
hold.end();
let steps = 0;
hold.begin("ArrowDown", () => (steps += 1) < 2, () => ended.push("at the end"));
t.mock.timers.tick(HOLD_INITIAL_DELAY_MS);
t.mock.timers.tick(holdIntervalMs(1));
assert.deepEqual(ended, ["released", "replaced", "ended", "at the end"]);
assert.ok(!hold.holding());
hold.end();
assert.equal(ended.length, 4, "an ended hold does not end again");
});
test("another key ends a hold, as the OS's own repeat stops; its own repeats and a modifier do not", () => {
const key = (code, key = code, repeat = false) => ({ code, key, repeat });
const hold = createKeyHold();
+98 -9
View File
@@ -7,7 +7,7 @@ import test from "node:test";
import { prepareCaptureReview } from "../../dist/review/capture-review.js";
import { createSourceCapturePlan } from "../../dist/source/capture-plan.js";
import { writeCiReportInput, exportCiReport } from "../../dist/report/artifact.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, FIXTURE_ALIAS_WAIT_MS, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
import { spawnSync } from "node:child_process";
import { ZipReader, Uint8ArrayReader, TextWriter, configure } from "@zip.js/zip.js";
import { viewerLinks } from "../../dist/report/viewer-links.js";
@@ -387,11 +387,76 @@ test("collectPlatformReports pairs downloaded artifact directories by platform a
const lookups = eas.requests.filter(request => request.url.pathname.endsWith("/actions/runs/10/artifacts"));
assert.deepEqual(lookups.map(request => request.url.searchParams.get("name")), ["explore-review-10-1-android", "explore-review-10-1-ios"]);
assert.ok(lookups.every(request => request.options.headers.authorization === "Bearer test-token"));
// A target whose report job failed (brentvatne/euxy#172) is left out; the others still deploy, without waiting for it.
await rm(join(root, "reports", "explore-review-10-1-android"), { recursive: true });
const before = eas.requests.length;
const remaining = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport });
assert.deepEqual(remaining.map(entry => entry.target.id), ["ios"]);
assert.deepEqual(eas.requests.slice(before).map(request => request.url.searchParams.get("name")), ["explore-review-10-1-ios"], "no lookup for the target without a report");
await rm(join(root, "reports", "explore-review-10-1-ios"), { recursive: true });
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: eas.transport }),
error => error.code === "PREVIEW_REPORTS_INCOMPLETE");
});
test("collectPlatformReports reads a lone target's artifacts, which download-artifact extracts into the path itself", async t => {
const fixture = await asTarget(await exportFixture(t), TARGETS[2]);
const root = await mkdtemp(join(tmpdir(), "explore-fanin-lone-")); t.after(() => rm(root, { recursive: true, force: true }));
// Four of five captures failed, so each pattern matched one artifact: its files sit in --inputs and --reports themselves.
await mkdir(join(root, "inputs"), { recursive: true }); await cp(fixture.inputPath, join(root, "inputs", "report-input.json"));
await cp(fixture.reportPath, join(root, "reports"), { recursive: true });
const eas = easFixture();
const transport = async (input, options) => {
const url = new URL(input);
if (url.pathname.endsWith("/actions/runs/10/artifacts") && url.searchParams.get("name") === "explore-review-10-1-duo-open") {
return new Response(JSON.stringify({ artifacts: [{ id: 33, name: "explore-review-10-1-duo-open" }] }), { status: 200 });
}
return eas.transport(input, options);
};
const [entry, ...rest] = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport });
assert.deepEqual(rest, []);
assert.deepEqual([entry.target.id, entry.inputPath, entry.reportPath, entry.artifactUrl.split("/").at(-1)],
["duo-open", join(root, "inputs", "report-input.json"), join(root, "reports"), "33"]);
// A pattern that matched nothing left no directory: there is nothing to deploy, and that is said plainly.
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "missing"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport }),
error => error.code === "PREVIEW_REPORTS_MISSING");
});
test("collectPlatformReports looks up a report artifact the run does not list yet again, but not one its token cannot read", async t => {
const ios = await exportFixture(t);
const root = await mkdtemp(join(tmpdir(), "explore-fanin-late-")); t.after(() => rm(root, { recursive: true, force: true }));
const { cp } = await import("node:fs/promises");
await mkdir(join(root, "inputs", "explore-capture-10-1-ios"), { recursive: true }); await cp(ios.inputPath, join(root, "inputs", "explore-capture-10-1-ios", "report-input.json"));
await cp(ios.reportPath, join(root, "reports", "explore-review-10-1-ios"), { recursive: true });
const eas = easFixture();
const listing = answers => {
const lookups = [];
const transport = async (input, options) => {
const url = new URL(input);
if (!url.pathname.endsWith("/actions/runs/10/artifacts")) return eas.transport(input, options);
lookups.push(url);
const answer = answers[Math.min(lookups.length, answers.length) - 1];
return answer ? new Response(JSON.stringify(answer.body ?? {}), { status: answer.status }) : eas.transport(input, options);
};
return { lookups, transport };
};
const pauses = [];
const sleep = async milliseconds => { pauses.push(milliseconds); };
// The list lags the report job's upload: empty, then a 404, then the artifact.
const late = listing([{ status: 200, body: { artifacts: [] } }, { status: 404 }, undefined]);
const [entry] = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: late.transport, sleep });
assert.equal(entry.artifactUrl, artifactUrl.replace(/20$/, "21"));
assert.equal(late.lookups.length, 3);
assert.equal(pauses.length, 2);
const denied = listing([{ status: 403 }]);
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: denied.transport, sleep }),
error => error.code === "REPORT_ARTIFACT_MISSING" && /HTTP 403/.test(error.message));
assert.equal(denied.lookups.length, 1);
const never = listing([{ status: 200, body: { artifacts: [] } }]);
await assert.rejects(collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport: never.transport, sleep }),
error => error.code === "REPORT_ARTIFACT_MISSING");
assert.equal(never.lookups.length, 5);
});
const now = Date.UTC(2026, 8, 11, 3, 7);
const STALE_COMMENT = `<!-- expo-explore-ci -->
Explore review for abc · Managed via config
@@ -456,6 +521,20 @@ test("a standalone report deploys to a fixed alias with a fixed token, verifies
assert.match(plain.previewUrl, /^https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\/p\/[a-z2-7]{32}$/);
assert.notEqual(plain.previewUrl, result.previewUrl, "without a fixed token the link is random");
// A standalone report's alias that is still behind after the whole budget: its link is the deployment, which
// serves this run, and nothing says the alias is behind (only a fixture preview's comment explains a lagging link).
const behind = easFixture({ aliasServes: false });
let clock = now;
const quiet = process.stderr.write.bind(process.stderr);
process.stderr.write = () => true;
let fallback;
try {
fallback = await deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "bluesky", token,
environment: deployEnvironment, transport: behind.transport, run: behind.run, now: () => (clock += 31_000), verifyTimeoutMs: 60_000 });
} finally { process.stderr.write = quiet; }
assert.equal(fallback.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.equal(fallback.aliasBehind, undefined);
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, alias: "Blue Sky",
environment: deployEnvironment, transport: eas.transport, run: eas.run, verifyTimeoutMs: 1 }), error => error.code === "PREVIEW_ALIAS_INVALID");
await assert.rejects(deployExplorationReport({ reportPath, project: "acme-explore", owner: "brent-org", exportPath, token: "short",
@@ -487,21 +566,28 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
const served = eas.requests.filter(request => request.url.pathname === `/p/${token}/manifest.json`).map(request => request.url.searchParams.get("platform"));
assert.deepEqual([...new Set(served)].sort(), ["android", "ios"], "both platforms' manifests are verified");
// The alias lagging the deployment past the budget is not a failed deployment: the deployment is verified, so the
// link is the deployment's own origin and the job log carries a warning (every 2026-10-14 "HTTP 404" failure was this).
// The alias lagging the deployment is not a failed deployment (every 2026-10-14 "HTTP 404" failure was this): the
// deployment is verified, so after FIXTURE_ALIAS_WAIT_MS, not the whole verification budget, the pull request links
// the alias anyway, says it is behind, and the job log carries a warning.
const behind = easFixture({ aliasOrigin: "https://explore-viewer-pr--pr-12.expo.app", aliasServes: false });
let clock = now; const ticking = () => (clock += 31_000);
// Each poll really waits 3 s, so the clock moves 7 s a reading: the 20 s wait is three polls, not twenty.
let clock = now; const ticking = () => (clock += 7_000);
const quiet = process.stderr.write.bind(process.stderr); const logged = [];
process.stderr.write = chunk => { logged.push(String(chunk)); return true; };
let linked;
try {
linked = await deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }], project: "explore-viewer-pr", owner: "brent-org", alias: "pr-12", token,
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 60_000 });
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 180_000 });
} finally { process.stderr.write = quiet; }
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
assert.equal(linked.aliasUrl, "https://explore-viewer-pr--pr-12.expo.app");
assert.equal(linked.aliasBehind, true);
assert.equal(linked.deploymentUrl, "https://acme-explore--1lcbdcpwn3.expo.app", "the comment links the verified deployment beside the alias");
assert.equal(logged.filter(line => /^Deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app serves this run's report \(\d+ s after eas deploy returned\)\./.test(line)).length, 1);
assert.equal(logged.filter(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still answers HTTP 404 \d+ s after eas deploy returned\. The pull request links the deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app instead\./.test(line)).length, 1);
const warning = logged.find(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still answers HTTP 404 \d+ s after eas deploy returned\. The pull request links it anyway, until it catches up, beside the deployment https:\/\/acme-explore--1lcbdcpwn3\.expo\.app\./.test(line));
assert.ok(warning, logged.join(""));
const waited = Number(/HTTP 404 (\d+) s/.exec(warning)[1]);
assert.ok(waited >= FIXTURE_ALIAS_WAIT_MS / 1000 && waited < FIXTURE_ALIAS_WAIT_MS / 1000 + 15, `gave up on the alias after ${waited} s, not the 180 s budget`);
assert.ok(behind.requests.some(request => request.url.origin === "https://explore-viewer-pr--pr-12.expo.app"), "the alias was polled");
// The example report keeps one token and the same fixtures, so an alias still on the previous deployment serves the
@@ -513,7 +599,8 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
linked = await deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }], project: "explore-viewer-pr", owner: "brent-org", alias: "pr-12", token,
exportPath, environment: deployEnvironment, transport: stale.transport, run: stale.run, now: ticking, verifyTimeoutMs: 60_000 });
} finally { process.stderr.write = quiet; }
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
assert.equal(linked.aliasBehind, true);
assert.equal(logged.filter(line => /^::warning::The alias https:\/\/explore-viewer-pr--pr-12\.expo\.app still serves an earlier deployment \d+ s after eas deploy returned\./.test(line)).length, 1);
await assert.rejects(deployFixturePreview({ reports: [{ platform: "ios", zipPath: join(root, "ios.zip") }, { platform: "ios", zipPath: join(root, "ios.zip") }],
@@ -789,7 +876,9 @@ test("ci:deploy pairs target-named artifacts, deploys them in config order, and
const entries = await collectPlatformReports({ inputsPath: join(root, "inputs"), reportsPath: join(root, "reports"), environment: deployEnvironment, transport });
assert.deepEqual(entries.map(entry => [entry.target.id, entry.platform, entry.artifactUrl.split("/").at(-1)]),
[["iphone", undefined, "31"], ["duo-closed", undefined, "32"], ["duo-open", undefined, "33"], ["android", "android", "34"]], "config order, not directory order");
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1 })
// The fixture serves none of these artifacts by id, so each comment's artifact lookup answers 404 through all its retries.
const sealed = await deployPreview({ reports: entries.map(({ platform: _platform, ...entry }) => entry), exportPath: fixtures[0].exportPath, environment: deployEnvironment, transport, run: eas.run, now: () => now, verifyTimeoutMs: 1,
sleep: async () => {} })
.catch(error => error);
// Publishing each target's comment section after the deployment is the comment code's (publishCiReportComment, which needs
// the target to name the artifact); the deployment itself must have been written per target either way.
+47
View File
@@ -710,6 +710,53 @@ test('several targets share a comment: named in config order in the subtitle, ea
assert.match(next, /\n- \[bbbbbbbb\]\(<[^>]+>\) · iPhone 17 🟩 3 changes \(.*?\) · iPhone Duo \\\(closed\\\) ⏳ did not finish \(.*?\) · iPhone Duo \\\(open\\\) 🟩 3 changes \(.*?\) · Pixel 7 🟩 3 changes /);
});
test('one of five targets failed: the comment shows the four reports and that failure, and no new-run banner (brentvatne/euxy#172)', async t => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const { publishFailureComment } = await import('../../dist/report/failure-comment.js');
const { mkdir, mkdtemp, rm, writeFile } = await import('node:fs/promises');
const { tmpdir } = await import('node:os');
const { join } = await import('node:path');
const targets = [...duoTargets, { id: 'pixel-dark', platform: 'android', label: 'Pixel 7 (dark)' }];
const configPath = '.expo-explore/config.yaml';
const firstAttempt = viewerLinks({ artifactUrl: 'https://github.com/expo/explore-playground/actions/runs/42/artifacts/7650', repository: pullRequest.repository, headSha, runId: '42', runAttempt: '1', configPath });
const working = viewerLinks({ repository: pullRequest.repository, headSha, runId: '42', runAttempt: '2', configPath });
// Attempt 1 published every target; attempt 2 captured them all at once, and the iPhone Duo (open) session failed.
let body;
for (const target of targets) body = platformSectionMerge(targetState(target, { targets, links: firstAttempt }), target.id).merge(body);
for (const target of targets) body = platformSectionMerge(targetState(target, { targets, links: working, phase: 'capturing', review: undefined, evidence: undefined,
capture: { planned: { base: 3, head: 3 }, done: { base: 3, head: 1 }, baseFromCache: false, current: 'head' } }), target.id).merge(body);
assert.match(visible(body), /New run in progress/);
for (const target of targets.filter(target => target.id !== 'duo-open')) body = platformSectionMerge(targetState(target, { targets }), target.id).merge(body);
const root = await mkdtemp(join(tmpdir(), 'explore-one-failed-')); t.after(() => rm(root, { recursive: true, force: true }));
for (const target of targets) await mkdir(join(root, 'capture', `explore-diagnostics-42-2-${target.id}`, 'explore-diagnostics'), { recursive: true });
await writeFile(join(root, 'capture', 'explore-diagnostics-42-2-duo-open', 'explore-diagnostics', 'error.json'), JSON.stringify({ code: 'ARGENT_TOOL_FAILED', stage: 'session',
message: 'fold: argent run fold failed: [Tool:fold] Service dependency failed', nextAction: 'Rerun the capture.', retryable: false, target: 'duo-open' }));
let comments = [{ id: 5, user: { login: 'github-actions[bot]' }, body }];
const transport = async (input, init = {}) => {
const url = new URL(input);
if (url.pathname === '/repos/expo/explore-playground/pulls/1') return Response.json({ state: 'open', draft: false, title: pullRequest.title, html_url: pullRequest.url,
base: { ref: 'main', sha: baseSha, repo: { id: 1, full_name: pullRequest.repository } }, head: { ref: pullRequest.head.ref, sha: headSha, repo: { full_name: pullRequest.repository } } });
if (url.pathname === '/repos/expo/explore-playground/issues/1/comments') return Response.json(comments);
if (url.pathname === '/repos/expo/explore-playground/issues/comments/5' && init.method === 'PATCH') {
comments = [{ ...comments[0], body: JSON.parse(init.body).body }]; return Response.json({ id: 5 });
}
throw new Error(`unexpected request ${init.method ?? 'GET'} ${url}`);
};
assert.deepEqual(await publishFailureComment({ repository: pullRequest.repository, pullNumber: 1, headSha, baseSha, runId: '42', runAttempt: '2', diagnosticsPath: root,
environment: { GITHUB_TOKEN: 'test-token' }, transport }), { posted: true });
const final = comments[0].body;
assert.doesNotMatch(visible(final), /New run in progress|New run failed/);
assert.equal(readCommentRecords(final).previous, undefined, "attempt 1's records go once every target of attempt 2 finished");
const records = readCommentRecords(final).current;
assert.deepEqual(targets.map(target => [records[target.id].runAttempt, records[target.id].phase]),
[['2', 'ready'], ['2', 'ready'], ['2', 'failed'], ['2', 'ready'], ['2', 'ready']]);
assert.match(statusOf(final, 'iPhone Duo \\(open\\)'), /^\*\*iPhone Duo \\\(open\\\) failed\*\* · session · ARGENT\\_TOOL\\_FAILED\\: fold\\: argent run fold failed/);
// Each published target links its report; the failure's record is the newest, so it sets the updated time.
assert.ok(subtitleOf(final).startsWith(`<sub>[iPhone 17](<${reportUrl}>) · [iPhone Duo \\(closed\\)](<${reportUrl}>) · iPhone Duo \\(open\\) · [Pixel 7](<${reportUrl}>) · [Pixel 7 \\(dark\\)](<${reportUrl}>) · ${commits} · updated `), subtitleOf(final));
assert.equal(titleOf(final), `### 3 screens changed · [Review in Explore](<${reportUrl}>)`);
});
test('a comment written by a per-platform version keeps parsing, and malformed target records are dropped', async () => {
const { platformSectionMerge, readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
const { encodeRecordPayload } = await import('../../dist/report/pr-comment-record.js');
+37
View File
@@ -38,3 +38,40 @@ test("link schemes are approved once each, lowercased, never http or https, and
assert.deepEqual(approveSessionUrlSchemes(none.eas, "session-1", new Set(), "dev.example.app", ["example"]), []);
assert.equal(none.calls.length, 0);
});
// The host can fail an action once, as `app.approveUrlScheme` did in its `simctl spawn … defaults write` (euxy run 39348933440).
function flakyEas(failures) {
const calls = [];
const eas = args => {
calls.push(args);
if (calls.length <= failures) throw new Error("eas simulator:control exited with status 1: The simulator could not run app.approveUrlScheme");
return { stdout: "{}" };
};
return { calls, eas };
}
test("an action that fails once is sent again after a pause", () => {
const { calls, eas } = flakyEas(1);
const pauses = [];
simulatorControl(eas, "session-1", "app.approveUrlScheme", ["dev.example.app", "example"], { sleep: milliseconds => pauses.push(milliseconds) });
assert.equal(calls.length, 2);
assert.deepEqual(calls[1], calls[0]);
assert.equal(pauses.length, 1);
});
test("an action that keeps failing throws EAS's reason after its last attempt, with no pause after it", () => {
const { calls, eas } = flakyEas(Infinity);
const pauses = [];
assert.throws(() => simulatorControl(eas, "session-1", "app.approveUrlScheme", ["dev.example.app", "example"], { sleep: milliseconds => pauses.push(milliseconds) }),
/could not run app\.approveUrlScheme/);
assert.equal(calls.length, 3);
assert.equal(pauses.length, calls.length - 1);
assert.ok(pauses.every(milliseconds => milliseconds > 0 && milliseconds <= 10_000));
});
test("a link scheme the host fails to approve once is approved on the next attempt", () => {
const { calls, eas } = flakyEas(1);
const approved = approveSessionUrlSchemes(eas, "session-1", new Set(["app.approveUrlScheme"]), "dev.example.app", ["example"], { sleep: () => {} });
assert.deepEqual(approved, ["example"]);
assert.equal(calls.length, 2);
});
+33 -2
View File
@@ -133,11 +133,14 @@ test("report export rejects path traversal and symlink images from downloaded ev
});
function transportFixture({ stale = false, expired = false, artifactName = "explore-review-10-1", artifactRun = 10, attempt = 1,
status, headers } = {}) {
status, headers, artifactNotFound = 0 } = {}) {
const calls = [];
let artifactLookups = 0;
const transport = async (input, options = {}) => {
const url = new URL(input); calls.push({ url, options });
if (status) return new Response("private-upstream-error", { status, headers });
// GitHub can answer 404 for an artifact its run uploaded moments ago (euxy run 39348956443).
if (url.pathname.endsWith("/actions/artifacts/20") && (artifactLookups += 1) <= artifactNotFound) return new Response("Not Found", { status: 404 });
if (url.pathname.endsWith("/actions/artifacts/20")) return Response.json({ id: 20, name: artifactName, expired, workflow_run: { id: artifactRun } });
if (url.pathname.endsWith("/actions/runs/10/attempts/1")) return Response.json({ id: 10, run_attempt: attempt, status: "in_progress", conclusion: null });
if (url.pathname.endsWith("/pulls/1")) return Response.json({ state: "open", base: pr.base,
@@ -191,7 +194,8 @@ test("report publication separates credential, permission, rate limit, and servi
[503, {}, "GITHUB_REQUEST_FAILED", true, /service status/],
]) {
const { transport, calls } = transportFixture({ status, headers });
await assert.rejects(publishCiReportComment({ inputPath, artifactUrl, environment, transport }), error => {
const pauses = [];
await assert.rejects(publishCiReportComment({ inputPath, artifactUrl, environment, transport, sleep: async milliseconds => { pauses.push(milliseconds); } }), error => {
assert.equal(error.code, code);
assert.equal(error.stage, "publication");
assert.equal(error.retryable, retryable);
@@ -200,9 +204,36 @@ test("report publication separates credential, permission, rate limit, and servi
return true;
});
assert.equal(calls.some(call => call.options.method === "POST"), false);
// Only a 5xx is looked up again; a bad token, a missing permission and a rate limit fail on the first answer.
assert.equal(calls.length, status >= 500 ? 5 : 1, `${status} ${JSON.stringify(headers)}`);
assert.equal(pauses.length, calls.length - 1);
}
});
test("an artifact GitHub does not list yet is looked up again, and one it never lists keeps the not-found failure", async t => {
const { inputPath } = await fixture(t);
const late = transportFixture({ artifactNotFound: 1 });
const pauses = [];
await publishCiReportComment({ inputPath, artifactUrl, environment, transport: late.transport, sleep: async milliseconds => { pauses.push(milliseconds); } });
assert.equal(late.calls.filter(call => call.url.pathname.endsWith("/actions/artifacts/20")).length, 2);
assert.equal(pauses.length, 1);
assert.ok(late.calls.some(call => call.options.method === "POST"), "the comment is published once the artifact is found");
const missing = transportFixture({ artifactNotFound: Infinity });
const waited = [];
await assert.rejects(publishCiReportComment({ inputPath, artifactUrl, environment, transport: missing.transport, sleep: async milliseconds => { waited.push(milliseconds); } }), error => {
assert.equal(error.code, "GITHUB_RESOURCE_NOT_FOUND");
assert.equal(error.message, "Report publication GitHub check failed (404)");
assert.match(error.nextAction, /artifact ID/);
return true;
});
assert.equal(missing.calls.length, 5);
assert.equal(waited.length, 4, "no pause after the last lookup");
const total = waited.reduce((sum, milliseconds) => sum + milliseconds, 0);
assert.ok(total >= 30_000 && total <= 60_000, `${total} ms of pauses`);
assert.equal(missing.calls.some(call => call.options.method === "POST"), false);
});
test("stale PRs, expired artifacts, foreign artifacts, and replayed attempts cannot announce Ready", async t => {
const { inputPath } = await fixture(t);
const moved = transportFixture({ stale: true });
+71 -3
View File
@@ -67,7 +67,7 @@ test("baseline restore rejects foreign workflows, revisions, branches, and unfin
event: "push", head_repository: { full_name: "acme/app" } };
const mutations = [
{ workflow_id: 99 }, { head_sha: "b".repeat(40) }, { head_branch: "feature" },
{ conclusion: null }, { head_repository: { full_name: "fork/app" } }, { event: "pull_request_target" },
{ conclusion: null }, { conclusion: "cancelled" }, { head_repository: { full_name: "fork/app" } }, { event: "pull_request_target" },
];
const runs = Object.fromEntries(mutations.map((mutation, i) => [i + 30, { ...valid, ...mutation, id: i + 30 }]));
runs[20] = valid;
@@ -90,6 +90,20 @@ test("baseline restore rejects foreign workflows, revisions, branches, and unfin
assert.deepEqual(names, [`explore-baseline-${"a".repeat(40)}-ios`, `explore-baseline-${"a".repeat(40)}`], "iOS also accepts the unsuffixed name older baselines used");
});
test("a target's baseline from a run another target's baseline failed in is still reused (brentvatne/euxy#172)", async () => {
// The baseline job uploads its artifact only after its own steps passed, so the run's failure is another target's.
const run = { id: 20, workflow_id: 77, conclusion: "failure", head_sha: "a".repeat(40), head_branch: "main", event: "push", head_repository: { full_name: "acme/app" } };
const transport = async input => {
const url = new URL(input);
if (url.pathname === "/repos/acme/app") return Response.json({ default_branch: "main" });
if (url.pathname === "/repos/acme/app/actions/workflows/explore-baseline.yml") return Response.json({ id: 77 });
if (url.pathname === "/repos/acme/app/actions/artifacts") return Response.json({ artifacts: [{ id: 20, workflow_run: { id: 20 }, expired: false }] });
if (url.pathname === "/repos/acme/app/actions/runs/20") return Response.json(run);
throw new Error(`unexpected request ${url}`);
};
assert.deepEqual(await findBaselineArtifact({ sha: "a".repeat(40), target: "iphone", environment, transport }), { id: 20, run: 20 });
});
test("a target's baseline is named after its id; only target ios also reuses the unsuffixed name", async () => {
const lookups = async target => {
const names = [];
@@ -145,10 +159,19 @@ async function reportFailure(t, { capture, report, comments = [], pr = samplePr(
const url = new URL(input);
assert.equal(init.headers?.authorization, "Bearer test-token");
if (url.pathname === "/repos/acme/app/pulls/91") return Response.json(pr);
// The comments as GitHub holds them, so a second write merges into the first.
if (url.pathname === "/repos/acme/app/issues/91/comments" && (init.method ?? "GET") === "GET") return Response.json(comments);
if (url.pathname === "/repos/acme/app/issues/91/comments" && init.method === "POST") { writes.push({ action: "create", body: JSON.parse(init.body).body }); return Response.json({ id: 100 }); }
if (url.pathname === "/repos/acme/app/issues/91/comments" && init.method === "POST") {
const body = JSON.parse(init.body).body;
writes.push({ action: "create", body }); comments = [...comments, { id: 100, user: { login: "github-actions[bot]" }, body }];
return Response.json({ id: 100 });
}
const update = /^\/repos\/acme\/app\/issues\/comments\/(\d+)$/.exec(url.pathname);
if (update && init.method === "PATCH") { writes.push({ action: "update", comment_id: Number(update[1]), body: JSON.parse(init.body).body }); return Response.json({ id: Number(update[1]) }); }
if (update && init.method === "PATCH") {
const body = JSON.parse(init.body).body;
writes.push({ action: "update", comment_id: Number(update[1]), body }); comments = comments.map(comment => comment.id === Number(update[1]) ? { ...comment, body } : comment);
return Response.json({ id: Number(update[1]) });
}
throw new Error(`unexpected request ${init.method ?? "GET"} ${url}`);
};
const result = await publishFailureComment({ repository: "acme/app", pullNumber: 91, headSha: head, baseSha: base, runId: "1234", runAttempt: "1",
@@ -296,6 +319,51 @@ test("a failed target is named by its artifact and keeps the label and config or
assert.equal(located.diagnostic.code, "APP_INPUT_MISSING");
});
test("a lone failed job's diagnostics, which download-artifact extracts without its artifact's directory, still name the target (euxy#172 attempt 1)", async t => {
// Run 39348956443 attempt 1: only duo-closed's report job failed (ci:publish's artifact lookup answered 404), so the
// failure job's pattern matched one artifact, extracted into report/ itself, and the comment said "iOS failed".
const report = { ...sampleDiagnostic(), code: "GITHUB_RESOURCE_NOT_FOUND", stage: "publication", message: "Report publication GitHub check failed (404)", target: "duo-closed" };
const [write] = await reportFailure(t, { mutateFiles: async directory => {
await mkdir(join(directory, "explore-failure", "report"), { recursive: true });
await writeFile(join(directory, "explore-failure", "report", "error.json"), JSON.stringify(report));
} });
assert.match(write.body, /^<!-- expo-explore-record:duo-closed:/m);
assert.match(write.body, /^\*\*duo\\-closed failed\*\* · publication · GITHUB\\_RESOURCE\\_NOT\\_FOUND/m);
assert.doesNotMatch(write.body, /iOS failed/);
// A capture diagnostics artifact on its own keeps its explore-diagnostics directory; a target id the file names is checked.
const [capture] = await reportFailure(t, { mutateFiles: async directory => {
await mkdir(join(directory, "explore-failure", "capture", "explore-diagnostics"), { recursive: true });
await writeFile(join(directory, "explore-failure", "capture", "explore-diagnostics", "error.json"), JSON.stringify({ ...sampleDiagnostic(), target: "duo-open" }));
} });
assert.match(capture.body, /^\*\*duo\\-open failed\*\* · capture\\-head · APP\\_INPUT\\_MISSING/m);
const [invalid] = await reportFailure(t, { mutateFiles: async directory => {
await mkdir(join(directory, "explore-failure", "report"), { recursive: true });
await writeFile(join(directory, "explore-failure", "report", "error.json"), JSON.stringify({ ...report, target: "../ios" }));
} });
assert.match(invalid.body, /^<!-- expo-explore-record:ios:/m, "an invalid target id is no target: the record falls back to ios, as before targets");
});
test("every failed target of a run gets its own failed record, and a target's report failure outranks its capture's", async t => {
const { locateFailureDiagnostics } = await import("../../dist/report/failure-comment.js");
const writes = await reportFailure(t, { mutateFiles: async directory => {
const root = join(directory, "explore-failure");
// Every capture leg uploads diagnostics; only the failed ones hold an error.json.
for (const target of ["iphone", "duo-closed", "duo-open", "android"]) await mkdir(join(root, "capture", `explore-diagnostics-1234-1-${target}`, "explore-diagnostics"), { recursive: true });
await writeFile(join(root, "capture", "explore-diagnostics-1234-1-duo-open", "explore-diagnostics", "error.json"), JSON.stringify({ ...sampleDiagnostic(), code: "CONTROLLER_READER_STUCK", stage: "session" }));
await writeFile(join(root, "capture", "explore-diagnostics-1234-1-android", "explore-diagnostics", "error.json"), JSON.stringify(sampleDiagnostic()));
await mkdir(join(root, "report", "explore-report-diagnostics-1234-1-android"), { recursive: true });
await writeFile(join(root, "report", "explore-report-diagnostics-1234-1-android", "error.json"), JSON.stringify({ ...sampleDiagnostic(), code: "REPORT_EXPORT_FAILED", stage: "export" }));
const located = await locateFailureDiagnostics(root);
assert.deepEqual(located.map(failure => [failure.target, failure.diagnostic.code]), [["android", "REPORT_EXPORT_FAILED"], ["duo-open", "CONTROLLER_READER_STUCK"]]);
} });
assert.equal(writes.length, 2);
assert.equal(writes[1].action, "update", "the second failure merges into the comment the first created");
assert.match(writes[1].body, /^\*\*Android failed\*\* · export · REPORT\\_EXPORT\\_FAILED/m);
assert.match(writes[1].body, /^\*\*duo\\-open failed\*\* · session · CONTROLLER\\_READER\\_STUCK/m);
assert.doesNotMatch(writes[1].body, /APP\\_INPUT\\_MISSING/);
assert.deepEqual(writes.result, { posted: true });
});
test("ci.trustedAuthors on the default branch admits listed authors without write access, nobody else", async t => {
const block = "app:\n bundleId: com.acme.app\nci:\n trustedAuthors:\n - devin-ai-integration[bot] # reviews\n - 'Renovate[bot]'\nreport:\n preview:\n hosting: eas\n";
const flow = "ci: # bots\n trustedAuthors: [\"devin-ai-integration[bot]\", 'renovate[bot]'] # quoted: plain scalars cannot hold [ ] in flow style\n";
@@ -29,6 +29,12 @@ export type ScreenScreenshotCardProps = {
/** The frame of a screen without a screenshot: its run's screenshots, so it lines up beside them. */
placeholderSize?: { width: number; height: number };
loading?: "eager" | "lazy";
/**
* Frame the screenshot from behind while it loads and fades in, where the frame and its rings are drawn on the image
* itself: the Map, and Screens on a phone. Screens' wells frame their own screenshots on wider windows. Only a
* screenshot of recorded size has one.
*/
backing?: boolean;
leading?: ReactNode;
trailing?: ReactNode;
/** Say "Open in Inspector" in a tooltip over the screenshot (Screens). The Map's cards go without. */
@@ -47,13 +53,13 @@ export type ScreenScreenshotCardProps = {
export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
// The placeholder takes the frame of the image it stands in for: a failed screenshot keeps the
// frame it waited in, and a screen without one is framed like a phone screenshot beside it.
const frame = props.screenshot && props.imageWidth && props.imageHeight
? { width: props.imageWidth, height: props.imageHeight }
const sized = Boolean(props.screenshot && props.imageWidth && props.imageHeight);
const frame = sized
? { width: props.imageWidth!, height: props.imageHeight! }
: props.placeholderSize ?? DEFAULT_SCREENSHOT_SIZE;
const frameStyle = { "--screenshot-width": frame.width, "--screenshot-height": frame.height } as CSSProperties;
const missing = (
<span
className="image-placeholder"
style={{ "--screenshot-width": frame.width, "--screenshot-height": frame.height } as CSSProperties}>
<span className="image-placeholder" style={frameStyle}>
<ImageOff aria-hidden="true" size={20} />
No screenshot
{props.missingReason ? <small className="image-placeholder-reason">{props.missingReason}</small> : null}
@@ -104,6 +110,7 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
onClick={props.onClick}>
<DiffFrame status={props.diff} accessibilityOnly={props.accessibilityOnly}>
<span className={`screen-node-image${props.screenshot ? " has-screenshot" : " is-missing"}`}>
{props.backing && sized ? <span className="screenshot-backing" style={frameStyle} aria-hidden="true" /> : null}
{props.screenshot ? (
<ScreenshotImage
src={props.screenshot}
@@ -114,7 +121,6 @@ export function ScreenScreenshotCard(props: ScreenScreenshotCardProps) {
decoding="async"
loading={props.loading ?? "lazy"}
fallback={missing}
holdPrevious
/>
) : missing}
{/* On a phone's map, says what the second tap on the selected screen does. */}
@@ -327,13 +327,24 @@
border-radius: 14px;
background: var(--subtle);
}
.compare-frame > img {
.compare-frame > img,
.compare-flip-layer > img {
display: block;
width: 100%;
height: 100%;
object-fit: contain;
}
.compare-flip-frame { cursor: pointer; }
/* Flip's two sides fill the frame, one over the other; the frame takes its size from its aspect ratio, not from them.
The side off screen is hidden, spinner and all, and a flip shows it at once. */
.compare-flip-layer {
position: absolute;
inset: 0;
display: flex;
align-items: center;
justify-content: center;
}
.compare-flip-layer[aria-hidden="true"] { visibility: hidden; }
.compare-flip-frame:focus-visible { outline: 2px solid var(--accent); outline-offset: 3px; }
.compare-swipe .visual-swipe { width: auto; height: var(--compare-frame-height); }
@@ -9,6 +9,7 @@ import { formatShortcut, matchesShortcut, SHORTCUTS, shortcutsLive } from "../..
import { createKeyHold, DIVIDER_GLIDE, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
import { optionalStorage } from "../../utils/embedded-report";
import { usePhoneLayout } from "../../utils/phone-layout";
import { useNeighborScreenshots } from "../../hooks/use-neighbor-screenshots";
import { ToggleGroup } from "../shared/toggle-group";
import { Tooltip } from "../shared/tooltip";
import { DEFAULT_SCREENSHOT_RATIO, ScreenshotImage, ScreenshotPlaceholder } from "../shared/screenshot-image";
@@ -133,7 +134,10 @@ export function useCompareController(options: CompareControllerOptions) {
const mode: CompareMode = comparable ? (phone ? phoneMode : desktopMode) : "flip";
const outlines = useOutlinesShown();
const [activeArea, setActiveArea] = useState<number>();
const [flipSide, setFlipSide] = useState<"before" | "after">("after");
// Flip's side belongs to the screen it was chosen on: each screen starts on After, from its very
// first render, so a step never shows the next screen's Before for a frame.
const [flipped, setFlipped] = useState<{ screenId: string; side: "before" | "after" }>();
const flipSide = flipped?.screenId === options.screenId ? flipped.side : "after";
const [swipePosition, setSwipePosition] = useState(50);
const [factsOpen, setFactsOpen] = useState(false);
// The frame takes the recorded screenshot's shape at once, then the loaded image's (they agree
@@ -150,10 +154,11 @@ export function useCompareController(options: CompareControllerOptions) {
setLoadedAspect({ screenId: options.screenId, aspect: value });
}, [options.screenId, hasAfter]);
// Each screen starts whole: no area selected, After showing, the facts closed.
// Each screen starts whole: no area selected, After showing, the facts closed. A side flipped to on
// another screen is already not this one's (above); it is dropped, so coming back starts on After.
useEffect(() => {
setActiveArea(undefined);
setFlipSide("after");
setFlipped(undefined);
setFactsOpen(false);
}, [options.screenId]);
@@ -171,7 +176,7 @@ export function useCompareController(options: CompareControllerOptions) {
return Math.min(areas.length - 1, Math.max(0, current + step));
});
};
const flip = () => setFlipSide((side) => (side === "after" ? "before" : "after"));
const flip = () => setFlipped({ screenId: options.screenId, side: flipSide === "after" ? "before" : "after" });
const keyState = useRef({ previous, next, mode, activeArea, options, swipePosition });
keyState.current = { previous, next, mode, activeArea, options, swipePosition };
@@ -199,6 +204,17 @@ export function useCompareController(options: CompareControllerOptions) {
holdRef.current ??= createKeyHold();
const hold = holdRef.current;
useEffect(() => hold.end, [hold]);
// A held key steps faster than a screenshot fades in, so while it repeats each screen's pictures appear at once:
// the stage is marked for ScreenshotImage directly, without a render of its own.
const stageRef = useRef<HTMLDivElement>(null);
const stepHeld = (direction: 1 | -1): boolean => {
const stepped = stepScreen(direction);
if (stepped) stageRef.current?.setAttribute("data-screenshot-instant", "");
return stepped;
};
const endHeldSteps = () => stageRef.current?.removeAttribute("data-screenshot-instant");
useNeighborScreenshots({ diff: options.diff, order: options.order, screenId: options.screenId,
enabled: options.stepScreens !== false, hold });
// A tap of [ or ] moves the divider one step; held, it keeps going from the same motion. The hold only
// tracks the key; the glide reads it every frame and stops with it.
const glideDivider = (code: string, direction: 1 | -1) => {
@@ -215,9 +231,9 @@ export function useCompareController(options: CompareControllerOptions) {
const keys = SHORTCUTS.compare;
const stepScreens = state.options.stepScreens !== false;
if (stepScreens && matchesShortcut(event, keys.previousScreen)) {
if (stepScreen(-1)) hold.begin(event.code, () => stepScreen(-1));
if (stepScreen(-1)) hold.begin(event.code, () => stepHeld(-1), endHeldSteps);
} else if (stepScreens && matchesShortcut(event, keys.nextScreen)) {
if (stepScreen(1)) hold.begin(event.code, () => stepScreen(1));
if (stepScreen(1)) hold.begin(event.code, () => stepHeld(1), endHeldSteps);
} else if (matchesShortcut(event, keys.nextArea)) {
stepArea(1);
} else if (matchesShortcut(event, keys.previousArea)) {
@@ -279,7 +295,7 @@ export function useCompareController(options: CompareControllerOptions) {
screen, screenDiff, route, position, previous, next, comparable, areas, facts, split, layoutShift, measurable,
mode, chosenMode, modesDisabled, chooseMode, modeOptions, outlines, shownOutlines, statusBarIgnored, homeIndicatorIgnored, systemRegions, toggleOutlines,
activeArea, setActiveArea, stepArea, flipSide, flip, swipePosition, setSwipePosition,
aspect, setAspect, factsOpen, setFactsOpen,
aspect, setAspect, factsOpen, setFactsOpen, stageRef,
};
}
@@ -393,7 +409,7 @@ export function CompareSection(props: CompareSectionProps) {
</div>
</header>
<div className={`compare-stage mode-${mode}`}>
<div ref={compare.stageRef} className={`compare-stage mode-${mode}`}>
{/* Every mode names Before and After in a row above the screenshots. */}
<CompareStage
mode={mode}
@@ -472,6 +488,21 @@ export function CompareStage(props: StageProps) {
// An outline taken out from under the pointer reports no leave, so another screen, mode or outline
// toggle drops the hover rather than lighting an area the pointer is not on.
useLayoutEffect(() => setHoverIndex(undefined), [props.areas, props.mode, props.showOutlines]);
// Flip keeps both sides mounted, so flipping is an instant swap of two decoded pictures. The side off screen mounts
// once the side on screen is ready for this pair of screenshots, or on the first flip to it, so a held key stepping
// through Flip reads one side of each screen it passes, not two.
const pair = `${before ?? ""} ${after ?? ""}`;
const [flipPair, setFlipPair] = useState<string>();
const flipBoth = flipPair === pair;
if (props.mode === "flip" && props.flipSide === "before" && flipPair !== pair) setFlipPair(pair);
// The side on screen loads (CompareImage reports it), or a step kept its screenshot (the same After beside another
// Before), which fires no load: it is ready as it is.
const flipFrameRef = useRef<HTMLButtonElement>(null);
useLayoutEffect(() => {
if (props.mode !== "flip" || flipPair === pair) return;
const shown = flipFrameRef.current?.querySelector(`.compare-flip-layer[data-side="${props.flipSide}"] img`);
if (shown?.getAttribute("data-screenshot-state") === "ready") setFlipPair(pair);
}, [props.mode, props.flipSide, flipPair, pair]);
if (!before && !after) {
const reason = diff.captureNotes?.after ?? diff.captureNotes?.before;
return (
@@ -515,6 +546,7 @@ export function CompareStage(props: StageProps) {
}
if (props.mode === "flip" && before && after) {
const showing = props.flipSide;
const sides = (["before", "after"] as const).filter((side) => side === showing || flipBoth);
return (
<figure className="compare-side">
{/* Both names, with the one on screen lit; the other one flips to it. */}
@@ -527,10 +559,21 @@ export function CompareStage(props: StageProps) {
))}
</figcaption>
<div className="compare-frame-wrap">
<button type="button" className="compare-frame compare-flip-frame" data-side={showing}
<button ref={flipFrameRef} type="button" className="compare-frame compare-flip-frame" data-side={showing}
aria-label={`Show ${showing === "after" ? "Before" : "After"}`} onClick={props.onFlip}>
<CompareImage src={showing === "after" ? after : before} alt={`${props.title}, ${showing}`}
placeholder="No screenshot" side={showing} onAspect={props.onAspect} />
{/* Each side is a layer of its own, with its spinner and its no-screenshot state; the one off screen
is hidden, and its pictures land without a fade, so a flip shows the other side at once. */}
{sides.map((side) => (
<span key={side} className="compare-flip-layer" data-side={side}
{...(side === showing ? {} : { "aria-hidden": true, "data-screenshot-instant": "" })}>
<CompareImage src={side === "after" ? after : before} alt={`${props.title}, ${side}`}
placeholder="No screenshot" side={side}
onAspect={(aspect, loaded) => {
if (loaded === showing) setFlipPair(pair);
props.onAspect(aspect, loaded);
}} />
</span>
))}
{props.overlay}
</button>
</div>
+101 -8
View File
@@ -1,5 +1,5 @@
import { appearanceLabel, type Appearance } from "../../utils/appearance";
import { useEffect, useRef, useState, useSyncExternalStore, type ReactNode } from "react";
import { useEffect, useLayoutEffect, useRef, useState, useSyncExternalStore, type ReactNode } from "react";
import { LoaderCircle, Search } from "lucide-react";
import { toast } from "sonner";
import { ExpoLogo } from "../shared/expo-logo";
@@ -13,6 +13,7 @@ import { KeyHint } from "../shared/key-hint";
import { formatShortcut, matchesShortcut, shortcutsLive, SHORTCUTS, TARGET_NUMBER_KEYS } from "../../utils/shortcuts";
import { ChangesMenu } from "./changes-menu";
import { placeForAnotherTarget, type FocusStatus } from "../../utils/navigation";
import { usePhoneLayout } from "../../utils/phone-layout";
import type { ExploreMap, MapIndex } from "../../utils/model";
import type { BuildDiff } from "../../utils/build-diff";
import type { PullRequestPresentation } from "../../utils/review-model";
@@ -103,6 +104,25 @@ function useSiblingReports(page: URL | undefined): SiblingReport[] | undefined {
return reports;
}
/**
* A chip's label, truncating from its end when the chip is squeezed, except a trailing parenthetical: a target's
* pose, "iPhone Duo (open)", keeps "(open)" and loses letters of the device.
*/
function ChipLabel({ text }: { text: string }) {
const suffix = /^(.*\S) (\(.+\))$/.exec(text);
return (
<span className="collapsed-platform-label">
<span className="collapsed-platform-label-text">{suffix ? suffix[1] : text}</span>
{suffix ? <span className="collapsed-platform-label-suffix">{` ${suffix[2]}`}</span> : null}
</span>
);
}
/** Whether an element's text runs past its box: scrollWidth is an integer, so a sub-pixel overrun is no cut. */
function cut(element: HTMLElement | null): boolean {
return Boolean(element && element.scrollWidth > element.offsetWidth);
}
type AppPillProps = {
/** The phone layout puts Search in the pill, at its trailing edge. */
onOpenSearch?: (() => void) | undefined;
@@ -136,6 +156,8 @@ type AppPillProps = {
export function AppPill(props: AppPillProps) {
const pillRef = useRef<HTMLDivElement>(null);
const platformRef = useRef<HTMLButtonElement>(null);
const phone = usePhoneLayout();
const identityRef = useRef<HTMLDivElement>(null);
const [platformOpen, setPlatformOpen] = useState(false);
// A target still downloading: this report stays up, the trigger and the menu row say so. One that failed says why.
const { switching, switchError } = useSyncExternalStore(REPORT_SOURCE.subscribe, REPORT_SOURCE.getSnapshot, REPORT_SOURCE.getSnapshot);
@@ -150,6 +172,9 @@ export function AppPill(props: AppPillProps) {
const applicationName = props.map.run.name;
// The app's own icon when the report carries one; the Expo mark otherwise.
const appIcon = artifactUrl(props.map.run.appIcon);
// An icon that cannot be read shows the Expo mark instead, which does not name the app: the icon it was for.
const [failedIcon, setFailedIcon] = useState<string>();
const iconShown = Boolean(appIcon) && failedIcon !== appIcon;
const platform = props.map.run.platform;
const environment = props.map.run.environment ?? {};
const device = [
@@ -170,6 +195,72 @@ export function AppPill(props: AppPillProps) {
const run = runTargets(props.map.run);
const currentTarget = run.targets.find(target => target.id === run.current);
const targetLabel = currentTarget?.label ?? PLATFORM_NAMES[platform] ?? platform;
// The phone's header is the window's width. When the row cannot fit, it gives way in order: the app's name (left
// out while the app's own icon names it, or else cut down to its minimum), then the pull request link (Search keeps
// "Open pull request"); only then does the target's chip shrink, holding the name at its minimum: its device first,
// its pose only once the device is gone, so the label never runs out of its chip over the next. A name without its
// icon is left out last, when even the shrunk chip leaves it no room. Each step is laid out and measured in turn
// from the first, so the result is a function of the row's width alone, never of the last result. A label fades at
// its end only where it is cut. The desktop's pill is sized by its content, so it leaves nothing out.
const appearanceCurrent = props.appearance?.current;
useLayoutEffect(() => {
const row = identityRef.current;
if (!row) return;
if (!phone) {
delete row.dataset.drop;
delete row.dataset.fade;
return;
}
let disposed = false;
const fit = () => {
if (disposed) return;
const name = row.querySelector<HTMLElement>(":scope > strong");
const target = row.querySelector<HTMLElement>(".collapsed-target");
const label = target?.querySelector<HTMLElement>(".collapsed-platform-label") ?? null;
const device = target?.querySelector<HTMLElement>(".collapsed-platform-label-text") ?? null;
const pose = target?.querySelector<HTMLElement>(".collapsed-platform-label-suffix") ?? null;
const style = getComputedStyle(row);
const minimum = parseFloat(style.getPropertyValue("--collapsed-name-min")) || 0;
// A chip no wider than its squeezed minimum has nothing to give: squeezing it would only widen it.
row.dataset.drop = "";
const squeezable = Boolean(target && target.getBoundingClientRect().width > (parseFloat(style.getPropertyValue("--collapsed-target-min")) || 0));
const steps = [
...(name && iconShown ? ["name"] : []),
...(row.querySelector(".collapsed-pr") ? ["pr"] : []),
...(squeezable ? ["squeeze"] : []),
...(squeezable && pose ? ["pose"] : []),
...(name && !iconShown ? ["name"] : []),
];
// With `drops` left out, nothing runs past the row's end, a name that stays shows whole beside its icon and at
// least its minimum without, and a squeezed label still shows its whole pose.
const fits = (drops: string[]) => {
row.dataset.drop = drops.join(" ");
const end = row.getBoundingClientRect().right - parseFloat(style.paddingRight);
if (Array.from(row.children).some(item => item.getBoundingClientRect().right > end + 0.5)) return false;
if (name && !drops.includes("name") && !drops.includes("squeeze")) {
if (iconShown ? cut(name) : name.getBoundingClientRect().width < Math.min(minimum, name.scrollWidth) - 0.5) return false;
}
return !drops.includes("squeeze") || drops.includes("pose") || !cut(label);
};
let count = 0;
while (count < steps.length && !fits(steps.slice(0, count))) count += 1;
if (count === steps.length) row.dataset.drop = steps.join(" ");
if (!row.dataset.drop) delete row.dataset.drop;
const fade = [...(cut(device) ? ["device"] : []), ...(cut(pose) ? ["pose"] : [])];
if (fade.length) row.dataset.fade = fade.join(" ");
else delete row.dataset.fade;
};
fit();
// The row's room, and its items' widths: a font arriving after the first paint changes the latter alone.
const observer = new ResizeObserver(fit);
for (const node of [row, ...row.children]) observer.observe(node);
void document.fonts.ready.then(fit);
return () => {
disposed = true;
observer.disconnect();
};
}, [targetLabel, appearanceCurrent, pullRequest, phone, iconShown]);
// Platform-named targets (every report from before targets) switch platforms; named targets switch devices.
const noun = run.targets.every(target => target.id === target.platform) ? "platform" : "device";
const siblings = run.targets
@@ -241,15 +332,17 @@ export function AppPill(props: AppPillProps) {
<div className="left-panel collapsed">
<div ref={pillRef} className="left-panel-collapsed-pill">
<Tooltip label="Map">
<button type="button" className="panel-logo-button" aria-label="Map" onClick={props.onOpenMap}>
{/* The button names the app as well: the icon has no text of its own, and a phone's row can leave the name out. */}
<button type="button" className="panel-logo-button" aria-label={`Map of ${applicationName}`} onClick={props.onOpenMap}>
{appIcon ? (
<ScreenshotImage className="panel-app-icon" src={appIcon} alt="" loading="eager" draggable={false}
fallback={<ExpoLogo mark />} holdPrevious />
fallback={<ExpoLogo mark />} holdPrevious onError={() => setFailedIcon(appIcon)} />
) : <ExpoLogo mark />}
</button>
</Tooltip>
<span className="panel-logo-divider" aria-hidden="true" />
<div className="collapsed-app-identity">
{/* The phone's fit (above) sets data-drop and data-fade on the row itself. */}
<div ref={identityRef} className="collapsed-app-identity">
<strong title={appTitle}>
{repositoryUrl ? (
<a className="collapsed-app-name" href={repositoryUrl} target="_blank" rel="noreferrer noopener"
@@ -261,11 +354,11 @@ export function AppPill(props: AppPillProps) {
{siblings.length ? (
<>
<Tooltip label={`${device || targetLabel} · open another ${noun}'s report`} shortcut={formatShortcut(SHORTCUTS.target.menu)} placement="bottom">
<button ref={platformRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={platformOpen}
<button ref={platformRef} type="button" className="collapsed-platform collapsed-target" aria-haspopup="menu" aria-expanded={platformOpen}
aria-label={`${noun === "device" ? "Device" : "Platform"}: ${targetLabel}. Open another ${noun}'s report`}
aria-busy={switching ? true : undefined}
onClick={() => setPlatformOpen(open => !open)}>
{targetLabel}
<ChipLabel text={targetLabel} />
{switching
? <LoaderCircle aria-hidden="true" className="collapsed-platform-busy" />
: <svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>}
@@ -280,7 +373,7 @@ export function AppPill(props: AppPillProps) {
<button ref={appearanceRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={appearanceOpen}
aria-label={`Appearance: ${appearanceLabel(props.appearance.current)}. Show the other appearance`}
onClick={() => setAppearanceOpen(open => !open)}>
{appearanceLabel(props.appearance.current)}
<ChipLabel text={appearanceLabel(props.appearance.current)} />
<svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>
<KeyHint shortcut={SHORTCUTS.appearance.app} />
</button>
@@ -307,7 +400,7 @@ export function AppPill(props: AppPillProps) {
target="_blank"
rel="noreferrer noopener"
aria-label={`PR #${pullRequest.number} on GitHub`}>
PR #{pullRequest.number}
{phone ? `#${pullRequest.number}` : `PR #${pullRequest.number}`}
</a>
</Tooltip>
) : pullRequest ? (
@@ -109,7 +109,10 @@
object-fit: cover;
pointer-events: none;
}
/* Each side shows only its own half of the frame, so a side still loading leaves its half empty
instead of showing the other side's picture there. */
.visual-swipe-before { clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
.visual-swipe-after { clip-path: inset(0 0 0 var(--swipe-position)); }
/* With a moved area, each side's outlines over its own half (see ChangeOutlines). */
.visual-swipe-outlines { position: absolute; z-index: 1; inset: 0; pointer-events: none; }
.visual-swipe-outlines.before { --outline-before: 1; clip-path: inset(0 calc(100% - var(--swipe-position)) 0 0); }
@@ -94,7 +94,7 @@ export function PhoneCompare(props: CompareControllerOptions & {
/>
</div>
<div className={`compare-stage phone-compare-stage mode-${mode}`}
<div ref={compare.stageRef} className={`compare-stage phone-compare-stage mode-${mode}`}
style={{ "--compare-aspect": compare.aspect } as CSSProperties}
onPointerDownCapture={(event) => { pressed.current = { x: event.clientX, y: event.clientY }; }}
onClickCapture={stepFromEdge}>
+16 -1
View File
@@ -375,6 +375,14 @@
}
.collapsed-search > svg { width: 20px; height: 20px; }
.collapsed-search:active { background: var(--panel-hover); }
/* Hand off sits before Search: only Search fills the pill's trailing padding. */
.phone-layout .handoff-icon-button.collapsed-search { margin-right: -6px; }
/* Whatever the row cannot fit is clipped at its end, never drawn under Hand off and Search. The clip edge sits 6px
out from its items, where Search's box (and Hand off's) begins, so an end chip's focus ring and key hint show. */
.phone-layout .collapsed-app-identity { overflow-x: clip; overflow-y: visible; margin-inline: -6px; padding-inline: 6px; }
/* The 24px chips keep their size; their hit area is the pill's height. */
.phone-layout .collapsed-platform { position: relative; }
.phone-layout .collapsed-platform::before { content: ""; position: absolute; inset: -10px 0; }
/* Text links and titles keep their size; their hit area grows into the space around them. */
.phone-layout .collapsed-app-name,
.phone-layout .collapsed-pr,
@@ -562,7 +570,7 @@
/* A screen without a screenshot: on the Map the placeholder is sized by its slot's height, which a
Screens grid cell does not have. Here it takes the cell's width and a screenshot's proportions,
so it lines up with the screenshots beside it. */
.screens-cell .screen-node-image:has(> .image-placeholder) { container-type: normal; }
.screens-cell .screen-node-image:has(> :is(.image-placeholder, .screenshot-backing)) { container-type: normal; }
.screens-cell .screen-node-image > .image-placeholder {
/* Like the image beside it: the screenshot's proportions inside the frame's 1px border. */
box-sizing: content-box;
@@ -571,6 +579,13 @@
aspect-ratio: var(--screenshot-width) / var(--screenshot-height);
font-size: var(--phone-caption-size, 12px);
}
/* A screenshot's backing fills the image box exactly: the image sets the cell's height from its own
proportions, and the backing draws its frame there while it loads. */
.screens-cell .screen-node-image > .screenshot-backing {
box-sizing: border-box;
width: 100%;
height: 100%;
}
/* Pinch and double-tap zoom the page on a phone; only the map canvas zooms, and it handles that itself. */
.phone-layout { touch-action: pan-x pan-y; }
@@ -64,7 +64,10 @@
.image-lightbox-step:disabled { opacity: 0.3; cursor: default; }
.image-lightbox-close:focus-visible,
.image-lightbox-step:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
/* The image is all the stage shows, and it is hidden while it loads: the spinner centres in the
stage meanwhile, in the bar's light text colour. */
.image-lightbox-stage {
position: relative;
display: flex;
min-height: 0;
flex: 1;
@@ -82,3 +85,4 @@
object-fit: contain;
box-shadow: 0 20px 60px rgb(0 0 0 / 0.5);
}
.image-lightbox-stage > .screenshot-loading { color: rgb(237 238 240 / 0.6); }
@@ -58,7 +58,7 @@ export function ImageLightbox(props: { images: readonly LightboxImage[]; initial
<ChevronLeft aria-hidden="true" />
</button>
) : null}
<ScreenshotImage key={image.src} src={image.src} alt={image.alt} loading="eager" draggable={false} />
<ScreenshotImage key={image.src} src={image.src} alt={image.alt} loading="eager" indicator="spinner" draggable={false} />
{multiple ? (
<button type="button" className="image-lightbox-step" aria-label="Next image"
disabled={index === props.images.length - 1} onClick={() => move(1)}>
@@ -10,16 +10,21 @@ export const DEFAULT_SCREENSHOT_SIZE = { width: 390, height: Math.round(390 / DE
type ScreenshotImageProps = ImgHTMLAttributes<HTMLImageElement> & {
/** Large previews centre a spinner while an embedded screenshot resolves; small images wait as a quiet empty frame. */
indicator?: "spinner";
/** Stands in for an embedded screenshot that cannot be read: the caller's own no-screenshot state. */
/** Stands in for a screenshot that cannot be read or loaded: the caller's own no-screenshot state. */
fallback?: ReactNode;
/**
* Keeps the picture of the source before on screen until the new one has decoded: for a map card, whose source
* changes only when the report's other appearance or target swaps every screenshot at once. Never for a view that
* steps between screens or draws changes over the picture, where it would show the screen before under the new one.
* Keeps the picture of the source before on screen until the new one has decoded, and shows the new one without a
* fade: for the app icon, which changes only when another target's report is shown and should not blink. Never for a
* screenshot. A view that steps between screens or draws changes over the picture would show the screen before under
* the new one, and a card would show the other target's or appearance's capture as this one's: a screenshot goes
* blank while its replacement loads.
*/
holdPrevious?: boolean;
};
/** How long a loaded screenshot waits for its decode before it is shown anyway. */
const DECODE_WAIT_MS = 300;
type ScreenshotState = "loading" | "ready" | "failed";
function dimension(value: number | string | undefined): number | undefined {
@@ -38,16 +43,45 @@ function waitingSource(width: number | string | undefined, height: number | stri
return `data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='${w}' height='${h}'/%3E`;
}
/** The picture each image is waiting to decode, so a load and a re-render waiting for the same one share a wait. */
const decodeWaits = new WeakMap<HTMLImageElement, string>();
/**
* Decode embedded evidence near the viewport; ordinary image URLs keep native loading. While an
* embedded screenshot resolves, the image shows an empty frame (and, with `indicator`, a spinner)
* and never its alt text; a screenshot that cannot be read shows `fallback`.
* Calls `show` once `image` has decoded `picture`, so the picture fades in on its own pixels rather than on an empty
* box its decode fills in partway; one whose decode does not settle soon is shown anyway. A rejected decode is a
* broken image, whose error event follows, or a source replaced meanwhile, which is shown on its own load. One wait
* runs per image and picture: a second call while it runs adds nothing.
*/
function whenDecoded(image: HTMLImageElement, picture: string, show: () => void) {
if (decodeWaits.get(image) === picture) return;
decodeWaits.set(image, picture);
let settled = false;
const settle = (shown: boolean) => {
if (settled) return;
settled = true;
clearTimeout(timer);
if (decodeWaits.get(image) === picture) decodeWaits.delete(image);
if (shown && image.isConnected && image.getAttribute("src") === picture) show();
};
const timer = setTimeout(() => settle(true), DECODE_WAIT_MS);
image.decode().then(() => settle(true), () => settle(image.complete && image.naturalWidth > 0));
}
/**
* Decode embedded evidence near the viewport; ordinary image URLs keep native loading. While a
* screenshot loads, the image is hidden over its frame (an embedded one keeps its size and, with
* `indicator`, shows a spinner) and never shows its alt text or the picture of the source before;
* a screenshot that cannot be read or loaded shows `fallback`. A picture that fills an empty frame
* fades in, unless it lands inside `[data-screenshot-instant]` (Compare stepping under a held key,
* Flip's hidden side), where it appears at once.
*/
export function ScreenshotImage({ src, loading, indicator, fallback, holdPrevious, onLoad, onError, ...props }: ScreenshotImageProps) {
const imageRef = useRef<HTMLImageElement>(null);
const [resolved, setResolved] = useState<{ source: string; url: string }>();
const [failed, setFailed] = useState<string>();
const [shown, setShown] = useState<string>();
// The picture shown, when it fades in: it filled an empty frame outside an instant stage.
const [revealed, setRevealed] = useState<string>();
const [lastSource, setLastSource] = useState(src);
// With `holdPrevious`, the picture of the source before, kept on screen until the new one has decoded.
const [held, setHeld] = useState<string>();
@@ -60,6 +94,7 @@ export function ScreenshotImage({ src, loading, indicator, fallback, holdPreviou
setHeld(holdPrevious && failed !== lastSource ? shown ?? held : undefined);
setResolved(undefined);
setShown(undefined);
setRevealed(undefined);
setFailed(undefined);
}
@@ -122,39 +157,56 @@ export function ScreenshotImage({ src, loading, indicator, fallback, holdPreviou
};
}, [embedded, src, loading]);
const url = embedded && resolved?.source === src ? resolved.url : undefined;
// An ordinary URL is its own picture; an embedded one is the URL its report resolved it to.
const url = !embedded ? src : resolved?.source === src ? resolved.url : undefined;
const state: ScreenshotState = failed === src ? "failed" : url && shown === url ? "ready" : "loading";
const displayed = state !== "failed" ? url ?? held : undefined;
// Shown once decoded. Replacing a held picture is no reveal: it stays up until the new one is there.
const show = (image: HTMLImageElement, picture: string) => whenDecoded(image, picture, () => {
setShown(picture);
setRevealed(held || image.closest("[data-screenshot-instant]") ? undefined : picture);
setHeld(undefined);
});
// Re-committing the URL the image already shows (it left the viewport and came back before a
// render, and the report still held the URL) fires no load event: the decoded image is ready.
// render, and the report still held the URL) fires no load event: the loaded image is shown once
// its decode settles, as a load would show it.
useLayoutEffect(() => {
const image = imageRef.current;
if (!displayed || displayed !== url || shown === displayed || !image || image.getAttribute("src") !== displayed) return;
if (image.complete && image.naturalWidth > 0) {
setShown(displayed);
setHeld(undefined);
}
}, [displayed, url, shown]);
if (image.complete && image.naturalWidth > 0) show(image, displayed);
});
if (!embedded) return <img {...props} ref={imageRef} loading={loading} src={src} onLoad={onLoad} onError={onError} />;
if (state === "failed" && fallback !== undefined) return <>{fallback}</>;
// The caller hears the screenshot's own load and error events and a failed resolve (dispatched
// above, so untrusted), never the stand-in's.
const isScreenshot = (event: SyntheticEvent<HTMLImageElement>) => Boolean(url) && event.currentTarget.getAttribute("src") === url;
const status = {
"data-screenshot-state": state,
// A held picture stays shown while the new one loads; every other waiting image is hidden at once.
"data-screenshot-held": state === "loading" && held ? "" : undefined,
"data-screenshot-reveal": state === "ready" && revealed === url ? "" : undefined,
onLoad: (event: SyntheticEvent<HTMLImageElement>) => {
if (!isScreenshot(event)) return;
show(event.currentTarget, url!);
onLoad?.(event);
},
};
// An ordinary URL loads natively. Each source is an image of its own, so the browser never paints the picture of
// the source before while the new one loads; a held one keeps its element, which keeps painting it.
if (!embedded) {
return <img key={holdPrevious ? undefined : src} {...props} {...status} ref={imageRef} loading={loading} src={src}
onError={event => {
if (event.currentTarget.getAttribute("src") === src) { setFailed(src); setHeld(undefined); }
onError?.(event);
}} />;
}
return (
<>
<img {...props} ref={imageRef} loading={loading}
<img {...props} {...status} ref={imageRef} loading={loading}
src={displayed ?? waitingSource(props.width, props.height)}
data-screenshot-src={src}
data-screenshot-state={state}
aria-busy={state === "loading" || undefined}
onLoad={event => {
if (!isScreenshot(event)) return;
setShown(url);
setHeld(undefined);
onLoad?.(event);
}}
onError={event => {
if (event.nativeEvent.isTrusted) {
// The held picture's URL was revoked since (the report let it go): nothing to show until the new one.
+4
View File
@@ -157,6 +157,8 @@ function ScreenCell(props: {
dimmed: boolean;
/** The run's screenshot shape, which a screen without a screenshot is framed in. */
typicalSize?: ScreenshotSize | undefined;
/** A phone's cell, whose screenshot is its own frame: no well frames it while it loads. */
phone?: boolean | undefined;
onSelect: () => void;
}) {
const artifact = primaryScreenshotForScreen(props.screen, props.index);
@@ -179,6 +181,7 @@ function ScreenCell(props: {
selected={props.selected}
ariaPressed={props.selected}
loading="lazy"
backing={props.phone === true}
onClick={props.onSelect}
{...(props.via || props.elsewhere?.length ? { note: <>
{props.via ? <span className="screens-cell-via">via “{props.via}”</span> : null}
@@ -578,6 +581,7 @@ export function ScreensView(props: ScreensViewProps) {
elsewhere={isChanged(props.diff, id) ? undefined : props.changedElsewhere?.get(id)}
via={tree.via.get(id)}
typicalSize={typicalSize}
phone={props.phone}
selected={props.selectedScreenId === id}
dimmed={Boolean(props.focus?.length) && !props.focus!.some((state) => state === focusStatusOf(props.diff?.screens.get(id)))}
onSelect={() => props.onSelectScreen(id)} />
@@ -117,6 +117,7 @@ function ScreenNodeCard({ data, selected }: NodeProps<ScreenGraphNode>) {
imageHeight={data.screenshotSize?.imageHeight ?? data.frame.screen.height}
placeholderSize={data.frame.screen}
loading="lazy"
backing
// The ring says which screen is which; a click opening it in the Inspector needs no tooltip.
inspectorTooltip={false}
leading={<Handle type="target" position={horizontal ? Position.Left : Position.Top} className="graph-handle" />}
@@ -0,0 +1,65 @@
import { useEffect, useRef } from "react";
import type { BuildDiff } from "../utils/build-diff";
import type { ChangedScreen } from "../utils/changed-screens";
import { isEmbeddedArtifactUrl, leaseEmbeddedArtifactUrl } from "../utils/embedded-report";
import type { KeyHold } from "../utils/key-hold";
/** How long Compare rests on a screen before it reads the next one's screenshots. */
export const NEIGHBOR_SETTLE_MS = 250;
export type NeighborScreenshotsOptions = {
diff: BuildDiff;
order: readonly ChangedScreen[];
screenId: string;
/** Compare steps between screens; the Inspector, which stays on its screen, reads no neighbour. */
enabled: boolean;
/** The keys that step: no neighbour is read while one is held. */
hold: KeyHold;
};
/**
* Reads the screenshots of the screen Compare would step to next, in the direction it last stepped (by key, the
* header's buttons, a tap or the picker), once it has rested on a screen. The next step usually finds them decoded,
* so its pictures fade in within a frame of the step. Each is one use of the report's screenshot until Compare moves
* on, then released; nothing is decoded outside the page's own images.
*
* A held key steps past screens faster than they could be read, so nothing is read until it is released. The reads
* are the report's prefetches: one starts only while two slots stay free for the step the reviewer takes, so
* speculative work never holds more than two, whatever earlier prefetches are still reading, and one that has not
* started when Compare moves on is dropped unread.
*/
export function useNeighborScreenshots({ diff, order, screenId, enabled, hold }: NeighborScreenshotsOptions) {
const position = order.findIndex((entry) => entry.id === screenId);
const last = useRef<{ position: number; direction: 1 | -1 }>({ position, direction: 1 });
useEffect(() => {
if (!enabled || position < 0) return;
const previous = last.current;
const direction = position === previous.position ? previous.direction : position > previous.position ? 1 : -1;
last.current = { position, direction };
const neighbor = order[position + direction];
const screen = neighbor ? diff.screens.get(neighbor.id) : undefined;
const sources = new Set([screen?.beforeScreenshot, screen?.afterScreenshot]
.filter((source): source is string => Boolean(source && isEmbeddedArtifactUrl(source))));
if (sources.size === 0) return;
const leases: { release: () => boolean; held: boolean }[] = [];
let timer: ReturnType<typeof setTimeout>;
const read = () => {
if (hold.holding()) {
timer = setTimeout(read, NEIGHBOR_SETTLE_MS);
return;
}
for (const source of sources) {
const leased = leaseEmbeddedArtifactUrl(source, "prefetch");
const lease = { release: leased.release, held: true };
leases.push(lease);
// A read that failed (a report switched away from, or a prefetch dropped) holds nothing to release.
void leased.url.catch(() => { lease.held = false; });
}
};
timer = setTimeout(read, NEIGHBOR_SETTLE_MS);
return () => {
clearTimeout(timer);
for (const lease of leases) if (lease.held) lease.release();
};
}, [enabled, position, order, diff, hold]);
}
+79 -12
View File
@@ -154,6 +154,8 @@
/* The bottom bar resizes with the same timing as the canvas it switches. */
--toolbar-motion: 220ms;
--toolbar-easing: ease-in-out;
/* A screenshot fades in over its empty frame once its pixels are decoded. */
--screenshot-reveal: 160ms;
}
:root[data-theme="dark"] {
@@ -634,9 +636,10 @@ code {
/* A screen without a screenshot, or whose screenshot could not be read, frames its placeholder
where an image of --screenshot-width x --screenshot-height would sit under the rules above:
contained in the slot inside its border, never enlarged. It lines up with the screenshots
beside it, and a failed screenshot keeps the frame it waited in. */
.screen-node-image:has(> .image-placeholder) { container-type: size; }
.screen-node-image > .image-placeholder {
beside it, and a failed screenshot keeps the frame it waited in. A Map card's screenshot waits
over a backing of the same frame (below; a phone's Screens cell sizes it in phone.css). */
.screen-node-image:has(> :is(.image-placeholder, .screenshot-backing)) { container-type: size; }
.screen-node-image > :is(.image-placeholder, .screenshot-backing) {
--frame-border: 1px;
display: flex;
box-sizing: content-box;
@@ -670,8 +673,28 @@ code {
specificity. The Map leaves the border to the status and rings the card from outside instead. */
.screen-node-image:hover img,
.screen-screenshot-card.selected .screen-node-image img { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
.screen-node-image:hover > .image-placeholder,
.screen-screenshot-card.selected .screen-node-image > .image-placeholder { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
.screen-node-image:hover > :is(.image-placeholder, .screenshot-backing),
.screen-screenshot-card.selected .screen-node-image > :is(.image-placeholder, .screenshot-backing) { border-color: var(--accent); box-shadow: 0 0 0 2px var(--accent); }
/* A Map card, and a Screens card on a phone, draws its frame (fill, border, status and rings) on
the image itself, which is hidden while it loads. The backing draws the same frame under it, in
the image's geometry, while the image waits and while it fades in, so the frame and its rings
hold steady; then it hides. The fading image leaves its rings to the backing, so their soft lift
is not drawn twice, and takes them back in the frame the backing hides. */
.screen-node-image > .screenshot-backing {
position: absolute;
inset: 0;
margin: auto;
pointer-events: none;
visibility: hidden;
}
.screen-node-image:has(> .screenshot-backing) > img { position: relative; }
.screen-node-image:has(> img[data-screenshot-state="loading"]) > .screenshot-backing { visibility: visible; }
.screen-node-image:has(> img[data-screenshot-reveal]) > .screenshot-backing { animation: screenshot-backing var(--screenshot-reveal) step-end; }
.screen-node-image:has(> .screenshot-backing) > img[data-screenshot-reveal] {
animation: screenshot-reveal var(--screenshot-reveal) ease-out, screenshot-backed var(--screenshot-reveal) step-end;
}
@keyframes screenshot-backing { from, to { visibility: visible; } }
@keyframes screenshot-backed { from, to { box-shadow: none; } }
.canvas-active-frame {
position: relative;
display: block;
@@ -726,11 +749,11 @@ code {
--ring-status: 0px;
}
.map-surface .screen-screenshot-card:is(.diff-added, .diff-modified, .diff-removed) { --ring-status: 2px; }
.map-surface .screen-screenshot-card .screen-node-image :is(img, .image-placeholder) {
.map-surface .screen-screenshot-card .screen-node-image :is(img, .image-placeholder, .screenshot-backing) {
border-color: var(--border-subtle);
box-shadow: none;
}
.map-surface .react-flow__node-screen:is(.selected, .graph-node-hover-subject) .screen-screenshot-card .screen-node-image :is(img, .image-placeholder) {
.map-surface .react-flow__node-screen:is(.selected, .graph-node-hover-subject) .screen-screenshot-card .screen-node-image :is(img, .image-placeholder, .screenshot-backing) {
box-shadow:
0 0 0 var(--ring-status) var(--diff, transparent),
0 0 0 calc(var(--ring-status) + 4 * var(--ring-unit)) var(--screen),
@@ -1348,12 +1371,17 @@ code {
align-items: center;
justify-content: center;
}
/* The frame holds the fill, so a screenshot that is hidden while it loads leaves its frame in place.
Nothing clips to it: an outline's ring and measurement may cross the frame's edge. */
.inspector-diff-preview:has(> img) {
border-radius: 9px;
background: var(--subtle);
}
.inspector-diff-preview img {
display: block;
width: 100%;
height: 100%;
border-radius: 9px;
background: var(--subtle);
object-fit: cover;
}
/* The frame line is drawn over the screenshot's edge, not inside its box, so the image fills
@@ -1700,9 +1728,9 @@ code {
border-color: var(--diff);
box-shadow: 0 0 0 2px var(--diff);
}
.screen-screenshot-card .diff-frame.diff-added .screen-node-image > .image-placeholder,
.screen-screenshot-card .diff-frame.diff-modified .screen-node-image > .image-placeholder,
.screen-screenshot-card .diff-frame.diff-removed .screen-node-image > .image-placeholder {
.screen-screenshot-card .diff-frame.diff-added .screen-node-image > :is(.image-placeholder, .screenshot-backing),
.screen-screenshot-card .diff-frame.diff-modified .screen-node-image > :is(.image-placeholder, .screenshot-backing),
.screen-screenshot-card .diff-frame.diff-removed .screen-node-image > :is(.image-placeholder, .screenshot-backing) {
border-color: var(--diff);
box-shadow: 0 0 0 2px var(--diff);
}
@@ -1779,6 +1807,24 @@ code {
@media (prefers-reduced-motion: reduce) {
.screenshot-loading > svg { animation: none; }
}
/* A screenshot that is loading or could not be read is hidden at once, in the same frame as its
new source, so no view paints the picture of the source before (the browser keeps painting it
until the new one loads) under a new screen's name or outlines; its frame stays. Hiding never
fades, and outranks a view's own image opacity, such as a dimmed variant thumbnail's. A held
picture (the app icon) stays shown until the new one is there. */
:root img:is([data-screenshot-state="loading"]:not([data-screenshot-held]), [data-screenshot-state="failed"]) {
opacity: 0;
transition: none;
}
/* A picture that fills an empty frame fades in. An animation, not a transition: the image can be
ready before its first paint, and it keeps a view's own resting opacity. */
img[data-screenshot-reveal] { animation: screenshot-reveal var(--screenshot-reveal) ease-out; }
@keyframes screenshot-reveal { from { opacity: 0; } }
@media (prefers-reduced-motion: reduce) {
img[data-screenshot-reveal],
.screen-node-image:has(> .screenshot-backing) > img[data-screenshot-reveal],
.screen-node-image:has(> img[data-screenshot-reveal]) > .screenshot-backing { animation: none; }
}
.status-badge { display: inline-flex; align-items: center; width: fit-content; padding: 4px 7px; border-radius: 6px; color: var(--secondary); background: var(--element); font-size: 10px; font-weight: 500; line-height: 1.2; text-transform: capitalize; }
.status-badge.info { color: var(--accent-strong); background: var(--accent-soft); }
.status-badge.success { color: var(--success); background: var(--success-soft); }
@@ -2402,7 +2448,28 @@ html [data-sonner-toaster][data-sonner-theme] {
flex: none; display: inline-flex; height: 24px; align-items: center; gap: 6px; margin: 0; padding: 0 8px 0 10px; border: 0; border-radius: 7px;
background: var(--element); color: var(--secondary); font: inherit; font-size: 12.5px; font-weight: 500; line-height: 16px; white-space: nowrap; cursor: pointer;
}
.collapsed-platform > svg { width: 9px; height: 9px; }
.collapsed-platform > svg { flex: none; width: 9px; height: 9px; }
/* What the phone's fit leaves out (AppPill's data-drop) is not drawn. */
.phone-layout .collapsed-app-identity[data-drop~="name"] > strong { display: none; }
.phone-layout .collapsed-app-identity[data-drop~="pr"] > .tooltip-anchor:has(> .collapsed-pr) { display: none; }
.collapsed-platform-label { display: flex; min-width: 0; overflow: hidden; }
.collapsed-platform-label-text { min-width: 0; overflow: hidden; }
.collapsed-platform-label-suffix { flex: none; white-space: pre; }
/* The name a phone's row keeps gives way first, cut to its end down to its minimum, and the target's chip after it,
down to its own; the fit reads both. */
.phone-layout .collapsed-app-identity { --collapsed-name-min: 64px; --collapsed-target-min: 72px; }
/* The target's label is the pill's one long configured text: once the phone's row has left out all it can, the name
holds at its minimum and the target's chip shrinks instead. */
.phone-layout .collapsed-app-identity[data-drop~="squeeze"] > strong { flex: none; max-width: var(--collapsed-name-min); }
.phone-layout .collapsed-app-identity[data-drop~="squeeze"] .collapsed-target { flex: 0 1 auto; min-width: var(--collapsed-target-min); }
.phone-layout .collapsed-app-identity[data-drop~="squeeze"] > .tooltip-anchor:has(> .collapsed-target) { flex: 0 1 auto; min-width: var(--collapsed-target-min); }
.phone-layout .collapsed-app-identity[data-drop~="pose"] .collapsed-target .collapsed-platform-label-suffix { flex: 0 1 auto; min-width: 0; overflow: hidden; }
/* The device's text gives way before the pose: it takes what the pose leaves, if anything. */
.phone-layout .collapsed-app-identity[data-drop~="pose"] .collapsed-target .collapsed-platform-label-text { flex: 1 1 0; }
/* A cut device or pose (AppPill's data-fade) fades out at its end rather than ending in "…" and the slack an ellipsis
leaves; the full name is a tap away in its menu. */
.phone-layout .collapsed-app-identity[data-fade~="device"] .collapsed-target .collapsed-platform-label-text,
.phone-layout .collapsed-app-identity[data-fade~="pose"] .collapsed-target .collapsed-platform-label-suffix { mask-image: linear-gradient(to right, #000 calc(100% - 16px), transparent); }
.collapsed-platform > .collapsed-platform-busy { width: 11px; height: 11px; animation: spin 1s linear infinite; }
.collapsed-platform:hover, .collapsed-platform[aria-expanded="true"] { color: var(--text); background: var(--hover); }
.collapsed-platform:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
+52 -14
View File
@@ -266,8 +266,12 @@ function validateManifest(value: unknown): PreviewManifest {
}
return manifest;
}
/** Eager screenshots (the Inspector's) are decoded before lazy ones (canvas nodes and thumbnails). */
export type ScreenshotPriority = "eager" | "lazy";
/**
* Eager screenshots (the Inspector's) are decoded before lazy ones (canvas nodes and thumbnails), and both before a
* prefetch (the screen Compare would step to next), which only takes a slot while PREFETCH_RESERVE others stay free.
*/
export type ScreenshotPriority = "eager" | "lazy" | "prefetch";
const PRIORITY_RANK: Record<ScreenshotPriority, number> = { eager: 0, lazy: 1, prefetch: 2 };
type ImageLoad = {
sha256: string;
users: number;
@@ -279,6 +283,12 @@ type ImageLoad = {
};
const DECODE_SLOTS = 4;
/**
* The slots a prefetch leaves free: a running read keeps its slot after it is let go, so these are what the two
* screenshots of the screen the reviewer does step to start in, whichever way that is. A prefetch waiting for a slot
* is dropped, unread, when it is let go first.
*/
const PREFETCH_RESERVE = 2;
/**
* Released screenshots keep their Blob URL, up to this many and this many bytes in all, so panning
* back needs no new decode.
@@ -299,7 +309,7 @@ export class ArtifactReportArchive {
/** Decoded screenshots nobody uses, least recently released first, and their total size. */
private readonly retained = new Map<string, { url: string; bytes: number }>();
private retainedBytes = 0;
private readonly queues: Record<ScreenshotPriority, ImageLoad[]> = { eager: [], lazy: [] };
private readonly queues: Record<ScreenshotPriority, ImageLoad[]> = { eager: [], lazy: [], prefetch: [] };
private disposed = false;
private running = 0;
private retainedLimit = RETAINED_SCREENSHOTS;
@@ -418,7 +428,8 @@ export class ArtifactReportArchive {
/**
* A verified Blob URL for an embedded screenshot. Each call is one use until `release`. At most
* four screenshots are read and hashed at once; eager requests wait ahead of lazy ones.
* four screenshots are read and hashed at once; eager requests wait ahead of lazy ones, and both
* ahead of a prefetch.
*/
async resolve(reference: string, priority: ScreenshotPriority = "lazy"): Promise<string> {
const sha256 = IMAGE_REFERENCE.exec(reference)?.[1];
@@ -429,7 +440,7 @@ export class ArtifactReportArchive {
const existing = this.loads.get(sha256);
if (existing) {
existing.users++;
if (priority === "eager" && existing.priority === "lazy") this.promote(existing);
if (PRIORITY_RANK[priority] < PRIORITY_RANK[existing.priority]) this.promote(existing, priority);
return existing.pending;
}
const kept = this.retained.get(sha256);
@@ -460,7 +471,7 @@ export class ArtifactReportArchive {
dispose(): void {
this.disposed = true;
for (const load of this.queues.eager.splice(0).concat(this.queues.lazy.splice(0))) {
for (const load of this.waitingLoads()) {
load.waiting?.drop(new Error("This report was closed."));
}
for (const load of this.loads.values()) if (load.url) URL.revokeObjectURL(load.url);
@@ -476,7 +487,7 @@ export class ArtifactReportArchive {
* used them releases them against the report shown next, so the ones still in use are dropped here instead.
*/
trim(): void {
for (const load of this.queues.eager.splice(0).concat(this.queues.lazy.splice(0))) {
for (const load of this.waitingLoads()) {
load.waiting?.drop(new Error("This screenshot is no longer in use."));
}
// What the Viewer was showing is kept as released, most recent last, so switching back shows it at once.
@@ -523,7 +534,7 @@ export class ArtifactReportArchive {
}
private acquireSlot(load: ImageLoad): Promise<void> {
if (this.running < DECODE_SLOTS) {
if (this.running < this.slotsFor(load)) {
this.running++;
return Promise.resolve();
}
@@ -533,6 +544,11 @@ export class ArtifactReportArchive {
});
}
/** How many slots may be running when `load` starts: all of them, or for a prefetch all but the reserve. */
private slotsFor(load: ImageLoad): number {
return load.priority === "prefetch" ? DECODE_SLOTS - PREFETCH_RESERVE : DECODE_SLOTS;
}
/** Hand a finished decode's slot to the next waiting load that someone still uses. */
private releaseSlot(): void {
for (let load = this.nextWaiting(); load; load = this.nextWaiting()) {
@@ -549,16 +565,38 @@ export class ArtifactReportArchive {
this.running--;
}
/**
* The next waiting load the slot being handed on may start. A prefetch waits while the other running loads would
* leave less than the reserve free, unless it was let go, which drops it.
*/
private nextWaiting(): ImageLoad | undefined {
return this.queues.eager.shift() ?? this.queues.lazy.shift();
const load = this.queues.eager[0] ?? this.queues.lazy[0] ?? this.queues.prefetch[0];
if (load && load.users > 0 && this.running > this.slotsFor(load)) return undefined;
return load ? this.queues[load.priority].shift() : undefined;
}
private promote(load: ImageLoad): void {
load.priority = "eager";
const index = this.queues.lazy.indexOf(load);
private waitingLoads(): ImageLoad[] {
return this.queues.eager.splice(0).concat(this.queues.lazy.splice(0), this.queues.prefetch.splice(0));
}
/**
* Move a load up to `priority`. A prefetch waiting for its reserve that the reviewer has stepped to starts at once
* when a slot is free, rather than waiting for a running read to finish.
*/
private promote(load: ImageLoad, priority: ScreenshotPriority): void {
const queue = this.queues[load.priority];
load.priority = priority;
const index = queue.indexOf(load);
if (index < 0) return;
this.queues.lazy.splice(index, 1);
this.queues.eager.push(load);
queue.splice(index, 1);
if (load.waiting && this.running < this.slotsFor(load)) {
const waiting = load.waiting;
delete load.waiting;
this.running++;
waiting.start();
return;
}
this.queues[priority].push(load);
}
/** Keep a released URL; beyond either limit the least recently released ones are revoked. */
+16 -13
View File
@@ -41,9 +41,10 @@ export type KeyPress = {
export type KeyHold = {
/**
* Starts holding `code` after its first step already landed. `step` takes the next step and
* says whether there was one; the hold ends by itself when there is not.
* says whether there was one; the hold ends by itself when there is not. `onEnd` hears the hold
* end, however it ends.
*/
begin: (code: string, step: () => boolean) => KeyPress;
begin: (code: string, step: () => boolean, onEnd?: () => void) => KeyPress;
/** Ends the hold as an interruption: another key, blur, a field or dialog taking the keyboard. */
end: () => void;
/** Ends the hold because `code` went up, if it is the key being held. */
@@ -53,8 +54,8 @@ export type KeyHold = {
* not end it, so ⇧ or ⌘ can join a held key. Call it first in the listener, before any guard.
*/
interrupt: (event: KeyboardEvent) => void;
/** Whether `code` is the key being held. */
holding: (code: string) => boolean;
/** Whether `code` is the key being held, or without one, whether any key is. */
holding: (code?: string) => boolean;
};
const MODIFIER_KEYS = new Set(["Shift", "Control", "Alt", "Meta"]);
@@ -115,18 +116,20 @@ export function glideWhileHeld(press: KeyPress, move: (steps: number) => boolean
/** One held key at a time, timed on the schedule above. */
export function createKeyHold(): KeyHold {
let current: { code: string; timer: ReturnType<typeof setTimeout>; press: { held: boolean; released: boolean } } | undefined;
let current: { code: string; timer: ReturnType<typeof setTimeout>; press: { held: boolean; released: boolean }; onEnd?: (() => void) | undefined } | undefined;
const finish = (released: boolean) => {
if (current) {
clearTimeout(current.timer);
current.press.held = false;
current.press.released = released;
}
const ended = current;
current = undefined;
if (ended) {
clearTimeout(ended.timer);
ended.press.held = false;
ended.press.released = released;
ended.onEnd?.();
}
};
const end = () => finish(false);
return {
begin(code, step) {
begin(code, step, onEnd) {
end();
let count = 1;
const tick = () => {
@@ -137,7 +140,7 @@ export function createKeyHold(): KeyHold {
count += 1;
};
const state = { held: true, released: false };
current = { code, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS), press: state };
current = { code, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS), press: state, onEnd };
return {
get held() { return state.held; },
get released() { return state.released; },
@@ -151,6 +154,6 @@ export function createKeyHold(): KeyHold {
interrupt(event) {
if (current && !event.repeat && event.code !== current.code && !MODIFIER_KEYS.has(event.key)) end();
},
holding: (code) => current?.code === code,
holding: (code) => (code === undefined ? current !== undefined : current?.code === code),
};
}