mirror of
https://github.com/expo/explore.git
synced 2026-11-15 13:18:16 -10:00
Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ed31b0c767 | ||
|
|
b1edd7ea81 | ||
|
|
50230b7f93 | ||
|
|
33f31da08e |
No files matched your search
@@ -67,9 +67,12 @@ jobs:
|
||||
shell: bash
|
||||
env:
|
||||
COMMENT_ID: ${{ steps.comment.outputs.id }}
|
||||
# How long an alias can keep serving the previous push: an EAS Hosting edge that served it keeps it for about
|
||||
# five minutes (FIXTURE_ALIAS_WAIT_MS in src/report/preview-deploy.ts).
|
||||
ALIAS_CATCH_UP: 5 minutes
|
||||
run: |
|
||||
set -euo pipefail
|
||||
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" '
|
||||
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" --arg catchup "$ALIAS_CATCH_UP" '
|
||||
.previewUrl as $url
|
||||
| ([.reports[] | select(.platform == "android")] + [.reports[] | select(.platform != "android")]) as $reports
|
||||
| ($reports[0].source // "") as $source
|
||||
@@ -85,6 +88,8 @@ jobs:
|
||||
| ((.label // (if .platform == "ios" then "iOS" else "Android" end)) | gsub("\\|"; "\\\\|")) as $name
|
||||
| "| \($name)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?\($query)) · [Screens](\($url)?\($query)#/screens) · [Compare](\($url)?\($query)&view=compare) |"),
|
||||
"",
|
||||
# The alias still served the previous push when the deploy stopped waiting for it: say so, and link the new deployment.
|
||||
(if .aliasBehind then "> **Going live:** this link can take up to \($catchup) to show \($sha); until then it shows the previous push, or nothing on a new pull request. [This push'"'"'s deployment](\(.deploymentUrl)/p/\($url | split("/p/")[1])) is live now.\n" else empty end),
|
||||
"The link stays the same on every push. [Deploy run](\($run))"]
|
||||
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
|
||||
if [[ -n "$COMMENT_ID" ]]; then
|
||||
|
||||
+4
-4
@@ -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.
|
||||
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.20.1",
|
||||
"version": "0.20.2",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@expo/explore",
|
||||
"version": "0.20.1",
|
||||
"version": "0.20.2",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/repack-app": "0.10.1",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.20.1",
|
||||
"version": "0.20.2",
|
||||
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
|
||||
@@ -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
@@ -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
|
||||
|
||||
@@ -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);
|
||||
}
|
||||
@@ -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 };
|
||||
|
||||
@@ -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
@@ -8,6 +8,7 @@ import { compareTitleMarkdown, projectReviewPresentation, type CompareReviewPres
|
||||
import { renderPublicComment, platformSectionMerge, reviewChangeCount, type PublicCommentState } from "./pr-comment-body.js";
|
||||
import { isTargetId, type ExplorePlatform } from "../config/explore-config.js";
|
||||
import { upsertStickyComment } from "./pr-comment.js";
|
||||
import { retryGitHubLookup } from "./github-lookup.js";
|
||||
import { previewLinks, viewerLinks } from "./viewer-links.js";
|
||||
import type { PublicReview } from "../contracts/capture.js";
|
||||
import { CiError, toCiError } from "../shared/ci-errors.js";
|
||||
@@ -136,6 +137,8 @@ export async function publishCiReportComment(options: {
|
||||
preview?: { url: string; expiresAt: number | null };
|
||||
/** Set by `ci:deploy` when the hosted preview failed: the comment falls back to the central Viewer and the ZIP. */
|
||||
previewFailed?: boolean;
|
||||
/** Pause between GitHub lookups that may succeed later; tests replace it so retries take no real time. */
|
||||
sleep?: (milliseconds: number) => Promise<void>;
|
||||
}) {
|
||||
const environment = options.environment ?? process.env; const transport = options.transport ?? fetch;
|
||||
const input = await readInput(options.inputPath); const review = input.publicReview; const pr = review.pullRequest;
|
||||
@@ -186,16 +189,21 @@ export async function publishCiReportComment(options: {
|
||||
catch (error) { throw new CiError({ code: "GITHUB_RESPONSE_INVALID", stage: "publication",
|
||||
message: "GitHub returned invalid report metadata.", nextAction: "Rerun publication; if the response remains invalid, inspect the GitHub metadata request.", cause: error }); }
|
||||
};
|
||||
const artifact = await api(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
|
||||
// A lookup is made again when GitHub may answer it later: no answer, a 5xx, or a 404 from the Actions API, which may
|
||||
// not list a just-uploaded artifact yet. A bad token, a missing permission or a rate limit fails at once, as before.
|
||||
const lookup = (path: string) => retryGitHubLookup(() => api(path), error => error instanceof CiError
|
||||
&& (error.code === "GITHUB_NETWORK_FAILED" || error.code === "GITHUB_REQUEST_FAILED" && error.retryable
|
||||
|| error.code === "GITHUB_RESOURCE_NOT_FOUND" && path.startsWith("actions/")), options.sleep);
|
||||
const artifact = await lookup(`actions/artifacts/${new URL(options.artifactUrl).pathname.split("/").at(-1)}`);
|
||||
if (artifact.expired || artifact.name !== `explore-review-${review.runId}-${review.runAttempt}${target ? `-${target}` : ""}` || String(artifact.workflow_run?.id) !== review.runId) {
|
||||
throw new CiError({ code: artifact.expired ? "REPORT_ARTIFACT_EXPIRED" : "REPORT_ARTIFACT_MISMATCH", stage: "publication",
|
||||
message: "The uploaded report artifact is unavailable or belongs to another run",
|
||||
nextAction: artifact.expired ? "Rerun Explore to upload a fresh report artifact." : "Pass the final report artifact from this workflow run and attempt." });
|
||||
}
|
||||
const attempt = await api(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
|
||||
const attempt = await lookup(`actions/runs/${review.runId}/attempts/${review.runAttempt}`);
|
||||
if (String(attempt.id) !== review.runId || String(attempt.run_attempt) !== review.runAttempt) throw new CiError({ code: "REPORT_RUN_MISMATCH", stage: "publication",
|
||||
message: "Report run attempt mismatch", nextAction: "Publish the artifact and report input from the same current workflow attempt." });
|
||||
const current = await api(`pulls/${pr.number}`);
|
||||
const current = await lookup(`pulls/${pr.number}`);
|
||||
if (current.state !== "open" || current.head?.repo?.full_name !== pr.repository || current.head?.ref !== pr.head.ref) {
|
||||
throw new CiError({ code: "PR_CHANGED", stage: "publication", message: "PR closed or changed branches before the report artifact was ready",
|
||||
nextAction: "Run Explore for the current PR head and base before publishing a ready report." });
|
||||
|
||||
@@ -15,7 +15,7 @@ export type FailureCommentOptions = {
|
||||
runAttempt: string;
|
||||
/** The directory the failure job downloaded diagnostics artifacts into (`<stage>/<artifact>/…/error.json`). */
|
||||
diagnosticsPath?: string;
|
||||
/** The failed target's id; otherwise the one the first diagnostics artifact's name carries. */
|
||||
/** The failed target's id; otherwise every target the diagnostics artifacts name. */
|
||||
target?: string;
|
||||
/** What callers from before targets pass: a platform is the id of its default target. */
|
||||
platform?: ExplorePlatform;
|
||||
@@ -25,6 +25,8 @@ export type FailureCommentOptions = {
|
||||
};
|
||||
|
||||
type Diagnostic = { code: string; stage: string; message: string; nextAction: string };
|
||||
/** A failed target's diagnostic. `target` is absent when neither the artifact's name nor the file names one. */
|
||||
export type LocatedFailure = { diagnostic?: Diagnostic; target?: string; platform?: ExplorePlatform };
|
||||
const SHA = /^[0-9a-f]{40}$/;
|
||||
// `explore-<kind>-<run>-<attempt>-<target>`: the kind has no digits, so the first number is the run and the rest is the target id.
|
||||
const ARTIFACT_DIR = /^explore-[a-z-]+-\d+-\d+-([a-z][a-z0-9-]{0,31})$/;
|
||||
@@ -34,11 +36,14 @@ const MAX_DIAGNOSTIC_BYTES = 32_768;
|
||||
const CODE = /^[A-Z][A-Z0-9_]{1,63}$/;
|
||||
const STAGE = /^[a-z][a-z0-9-]{0,63}$/;
|
||||
|
||||
function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
|
||||
function parseJson(text: string): Record<string, unknown> | undefined {
|
||||
let parsed: unknown;
|
||||
try { parsed = JSON.parse(text); } catch { return undefined; }
|
||||
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return undefined;
|
||||
const value = parsed as Record<string, unknown>;
|
||||
return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed as Record<string, unknown> : undefined;
|
||||
}
|
||||
|
||||
function parseDiagnostic(value: Record<string, unknown> | undefined, stage: string): Diagnostic | undefined {
|
||||
if (!value) return undefined;
|
||||
const field = (name: string, max: number) => typeof value[name] === "string" && (value[name] as string).trim() && (value[name] as string).length <= max ? value[name] as string : undefined;
|
||||
const code = field("code", 64), message = field("message", 4000), nextAction = field("nextAction", 4000), stageName = field("stage", 64) ?? stage;
|
||||
if (!code || !CODE.test(code) || !message || !nextAction || !STAGE.test(stageName)) return undefined;
|
||||
@@ -46,32 +51,51 @@ function parseDiagnostic(text: string, stage: string): Diagnostic | undefined {
|
||||
return { code, stage: stageName, message, nextAction };
|
||||
}
|
||||
|
||||
/** Reads one error.json; `named` is the target its artifact directory names, else the one the file records. */
|
||||
async function readFailure(path: string, stage: string, named: string | undefined): Promise<LocatedFailure | undefined> {
|
||||
const info = await lstat(path).catch(() => undefined);
|
||||
if (!info) return undefined;
|
||||
const located = (target: string | undefined): LocatedFailure => ({ ...(target ? { target } : {}), ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) });
|
||||
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located(named);
|
||||
const value = parseJson(await readFile(path, "utf8"));
|
||||
const target = named ?? (isTargetId(value?.target) ? value.target : undefined);
|
||||
const diagnostic = parseDiagnostic(value, stage);
|
||||
return diagnostic ? { diagnostic, ...located(target) } : located(target);
|
||||
}
|
||||
|
||||
/**
|
||||
* The error.json a failed job left behind and the target its artifact name carries (`ios` or `android` for a config
|
||||
* without targets, and for artifacts of versions before targets). A report failure's diagnostic takes precedence over
|
||||
* capture's; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
|
||||
* Every failed target's error.json and the target it belongs to (`ios` or `android` for a config without targets, and
|
||||
* for artifacts of versions before targets). actions/download-artifact puts each artifact a pattern matches in a
|
||||
* directory named after it, except when the pattern matches exactly one: that one lands in the stage's directory
|
||||
* itself, and the file names its target. A report failure's diagnostic takes precedence over its target's capture
|
||||
* diagnostic; a present but unreadable file yields the generic failure rather than an earlier stage's error, and only
|
||||
* regular files count (never symlinks out of the artifact). `platform` is set when the target id is a platform's.
|
||||
*/
|
||||
export async function locateFailureDiagnostic(root: string): Promise<{ diagnostic?: Diagnostic; target: string; platform?: ExplorePlatform } | undefined> {
|
||||
export async function locateFailureDiagnostics(root: string): Promise<LocatedFailure[]> {
|
||||
const failures: LocatedFailure[] = [];
|
||||
const seen = new Set<string>();
|
||||
for (const [stage, file] of [["report", "error.json"], ["capture", join("explore-diagnostics", "error.json")]] as const) {
|
||||
const entries = await readdir(join(root, stage), { withFileTypes: true }).catch(() => []);
|
||||
for (const entry of entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))) {
|
||||
const path = join(root, stage, entry.name, file);
|
||||
const info = await lstat(path).catch(() => undefined);
|
||||
if (!info) continue;
|
||||
const target = artifactTarget(entry.name)!;
|
||||
const located: { target: string; platform?: ExplorePlatform } = { target, ...(target === "ios" || target === "android" ? { platform: target as ExplorePlatform } : {}) };
|
||||
if (!info.isFile() || info.size > MAX_DIAGNOSTIC_BYTES) return located;
|
||||
const diagnostic = parseDiagnostic(await readFile(path, "utf8"), stage);
|
||||
return diagnostic ? { diagnostic, ...located } : located;
|
||||
const candidates = [...entries.filter(entry => entry.isDirectory() && artifactTarget(entry.name)).sort((a, b) => a.name.localeCompare(b.name))
|
||||
.map(entry => ({ path: join(root, stage, entry.name, file), named: artifactTarget(entry.name) })), { path: join(root, stage, file), named: undefined }];
|
||||
for (const { path, named } of candidates) {
|
||||
const located = await readFailure(path, stage, named);
|
||||
if (!located || seen.has(located.target ?? "")) continue;
|
||||
seen.add(located.target ?? "");
|
||||
failures.push(located);
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
return failures;
|
||||
}
|
||||
|
||||
/** The first failure locateFailureDiagnostics finds: a report failure before a capture failure. */
|
||||
export async function locateFailureDiagnostic(root: string): Promise<LocatedFailure | undefined> {
|
||||
return (await locateFailureDiagnostics(root))[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* The failure job's comment: a job died outside Explore's own progress comments (install, checkout, a crash
|
||||
* before the pipeline posted), so the sticky comment gets a failed record for that target from the same
|
||||
* before the pipeline posted), so the sticky comment gets a failed record for each failed target from the same
|
||||
* renderer every other writer uses. Nothing is posted when the PR is closed; a PR that moved on is marked
|
||||
* superseded so the failure lands under previous runs.
|
||||
*/
|
||||
@@ -94,27 +118,31 @@ export async function publishFailureComment(options: FailureCommentOptions): Pro
|
||||
return { posted: false, reason: "The PR is no longer an open same-repository PR." };
|
||||
}
|
||||
const superseded = pr.head?.sha !== options.headSha || pr.base?.sha !== options.baseSha;
|
||||
const located = options.diagnosticsPath ? await locateFailureDiagnostic(options.diagnosticsPath) : undefined;
|
||||
const target = requested ?? located?.target;
|
||||
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
|
||||
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
|
||||
const configPath = options.configPath ?? ".expo-explore/config.yaml";
|
||||
const now = Date.now();
|
||||
const diagnostic = located?.diagnostic;
|
||||
const state: PublicCommentState = {
|
||||
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
|
||||
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
|
||||
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
|
||||
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
|
||||
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
|
||||
startedAt: now, updatedAt: now, artifactOnly: true,
|
||||
...(platform ? { build: { platform, easProfile: "" } } : {}),
|
||||
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
|
||||
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
|
||||
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
|
||||
...(superseded ? { superseded: true } : {}),
|
||||
};
|
||||
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
|
||||
...platformSectionMerge(state, target), token, fetchImpl: transport });
|
||||
const located = options.diagnosticsPath ? await locateFailureDiagnostics(options.diagnosticsPath) : [];
|
||||
// Each failed target gets its own failed record: since one target's failed capture no longer stops the others'
|
||||
// reports (brentvatne/euxy#172), several targets of one run can fail in different jobs.
|
||||
const failures: LocatedFailure[] = requested !== undefined ? [{ ...(located.find(failure => failure.target === requested) ?? located[0]), target: requested }]
|
||||
: located.length ? located : [{}];
|
||||
for (const { target, diagnostic } of failures) {
|
||||
// The failure job knows a target by its id alone; the comment's own record for that id supplies its label and platform.
|
||||
const platform: ExplorePlatform | undefined = target === "ios" || target === "android" ? target : undefined;
|
||||
const configPath = options.configPath ?? ".expo-explore/config.yaml";
|
||||
const now = Date.now();
|
||||
const state: PublicCommentState = {
|
||||
phase: "failed", mode: "changes", executionMode: "deterministic", configPath,
|
||||
pullRequest: { repositoryId: String(pr.base?.repo?.id ?? ""), repository: options.repository, number: options.pullNumber, title: String(pr.title ?? ""), url: String(pr.html_url ?? ""),
|
||||
base: { ref: String(pr.base?.ref ?? ""), sha: options.baseSha }, head: { ref: String(pr.head?.ref ?? ""), sha: options.headSha } },
|
||||
// No artifact URL, so no Viewer link: the target would only pick a report that this failure never uploaded.
|
||||
links: viewerLinks({ repository: options.repository, headSha: options.headSha, runId: options.runId, runAttempt: options.runAttempt, configPath }),
|
||||
startedAt: now, updatedAt: now, artifactOnly: true,
|
||||
...(platform ? { build: { platform, easProfile: "" } } : {}),
|
||||
failure: { step: diagnostic?.stage ?? "workflow", message: diagnostic
|
||||
? `${diagnostic.code}: ${diagnostic.message} Next action: ${diagnostic.nextAction}`
|
||||
: "Explore could not finish this review. See the run for the error code, cause, and next action. Fix the reported issue and rerun Explore." },
|
||||
...(superseded ? { superseded: true } : {}),
|
||||
};
|
||||
await upsertStickyComment({ repository: options.repository, issueNumber: options.pullNumber, body: renderPublicComment(state, undefined, target),
|
||||
...platformSectionMerge(state, target), token, fetchImpl: transport });
|
||||
}
|
||||
return { posted: true, ...(superseded ? { superseded: true } : {}) };
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* Pauses between attempts of a GitHub lookup that may succeed later, 45 seconds in all. GitHub's Actions API is
|
||||
* eventually consistent just after an upload: in brentvatne/euxy's review run 39348956443, the duo-closed report job's
|
||||
* `actions/artifacts/<id>` answered 404 for the artifact that job had just uploaded, while the other four targets'
|
||||
* jobs found theirs.
|
||||
*/
|
||||
const GITHUB_LOOKUP_RETRY_DELAYS_MS = [3_000, 6_000, 12_000, 24_000] as const;
|
||||
|
||||
/**
|
||||
* Runs a read-only GitHub lookup again after each pause while `transient` says its failure may clear on its own. The
|
||||
* caller decides what is transient; any other failure, or the last one, is thrown as it is.
|
||||
*/
|
||||
export async function retryGitHubLookup<T>(lookup: () => Promise<T>, transient: (error: unknown) => boolean,
|
||||
sleep: (milliseconds: number) => Promise<void> = milliseconds => new Promise<void>(done => setTimeout(done, milliseconds))): Promise<T> {
|
||||
for (let retry = 0; ; retry += 1) {
|
||||
try { return await lookup(); }
|
||||
catch (error) {
|
||||
const delayMs = GITHUB_LOOKUP_RETRY_DELAYS_MS[retry];
|
||||
if (delayMs === undefined || !transient(error)) throw error;
|
||||
// A lookup that succeeds later would otherwise leave no trace of the failure in the job log.
|
||||
process.stderr.write(`GitHub lookup failed (${(error instanceof Error ? error.message : String(error)).split("\n", 1)[0]}); trying again in ${delayMs / 1000} s\n`);
|
||||
await sleep(delayMs);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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;
|
||||
|
||||
@@ -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()) {
|
||||
|
||||
@@ -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 }}-*
|
||||
|
||||
@@ -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"
|
||||
@@ -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/);
|
||||
|
||||
@@ -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: [
|
||||
|
||||
@@ -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" });
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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');
|
||||
|
||||
@@ -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);
|
||||
});
|
||||
@@ -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 });
|
||||
|
||||
@@ -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";
|
||||
|
||||
Reference in new issue
Block a user