mirror of
https://github.com/expo/explore.git
synced 2026-11-15 13:18:16 -10:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1f7396222c |
No files matched your search
@@ -67,12 +67,9 @@ 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" --arg catchup "$ALIAS_CATCH_UP" '
|
||||
jq -r --arg marker "$MARKER" --arg sha "${SHA:0:7}" --arg run "$RUN_URL" '
|
||||
.previewUrl as $url
|
||||
| ([.reports[] | select(.platform == "android")] + [.reports[] | select(.platform != "android")]) as $reports
|
||||
| ($reports[0].source // "") as $source
|
||||
@@ -88,8 +85,6 @@ 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
|
||||
|
||||
@@ -435,9 +435,7 @@ 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;
|
||||
/** The link is the alias, which still served an earlier deployment when the wait for it ran out. */
|
||||
aliasBehind?: true; project: string; owner: string };
|
||||
export type HostedDeployment = { previewUrl: string; expiresAt: string | null; deploymentId: string; deploymentUrl: string; aliasUrl?: string; 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]$/;
|
||||
@@ -497,13 +495,6 @@ 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;
|
||||
@@ -580,8 +571,7 @@ 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, alias,
|
||||
timeoutMs: alias ? options.aliasWaitMs ?? options.verifyTimeoutMs : options.verifyTimeoutMs,
|
||||
const verify = (origin: string, alias = false) => verifyDeployment({ origin, token, transport, now, timeoutMs: options.verifyTimeoutMs, alias,
|
||||
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`;
|
||||
@@ -591,9 +581,7 @@ 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);
|
||||
@@ -601,16 +589,12 @@ async function deployReports(options: {
|
||||
linkOrigin = aliasUrl.origin;
|
||||
} catch (error) {
|
||||
if ((error as { code?: string }).code !== "PREVIEW_ALIAS_BEHIND") throw error;
|
||||
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`);
|
||||
process.stderr.write(`::warning::${(error as Error).message} 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 } : {}), ...(aliasBehind ? { aliasBehind: true as const } : {}), project, owner };
|
||||
...(aliasUrl ? { aliasUrl: aliasUrl.origin } : {}), project, owner };
|
||||
} finally {
|
||||
await rm(work, { recursive: true, force: true });
|
||||
}
|
||||
@@ -684,20 +668,8 @@ 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.
|
||||
@@ -725,7 +697,6 @@ 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 } : {}) });
|
||||
}
|
||||
|
||||
|
||||
@@ -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, FIXTURE_ALIAS_WAIT_MS, fixtureReports, deployPreview, previewProjectSlug, readReportZip, whoamiAccounts, zipReportDirectory } from "../../dist/report/preview-deploy.js";
|
||||
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, 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";
|
||||
@@ -456,20 +456,6 @@ 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",
|
||||
@@ -501,28 +487,21 @@ 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 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.
|
||||
// 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).
|
||||
const behind = easFixture({ aliasOrigin: "https://explore-viewer-pr--pr-12.expo.app", aliasServes: false });
|
||||
// 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);
|
||||
let clock = now; const ticking = () => (clock += 31_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: 180_000 });
|
||||
exportPath, environment: deployEnvironment, transport: behind.transport, run: behind.run, now: ticking, verifyTimeoutMs: 60_000 });
|
||||
} finally { process.stderr.write = quiet; }
|
||||
assert.equal(linked.previewUrl, `https://explore-viewer-pr--pr-12.expo.app/p/${token}`);
|
||||
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.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);
|
||||
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.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);
|
||||
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
|
||||
@@ -534,8 +513,7 @@ 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://explore-viewer-pr--pr-12.expo.app/p/${token}`);
|
||||
assert.equal(linked.aliasBehind, true);
|
||||
assert.equal(linked.previewUrl, `https://acme-explore--1lcbdcpwn3.expo.app/p/${token}`);
|
||||
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") }],
|
||||
|
||||
Reference in new issue
Block a user