Compare commits

...
Author SHA1 Message Date
Brent Vatne ef92af830d Viewer preview fixtures: one report per target
The fixtures every pull request's Viewer preview serves were one report per platform: the refresh script fetched
report.zip?platform= for each platform and wrote <platform>.zip. A review with targets (euxy#163: iPhone 17,
iPhone Duo closed, iPhone Duo open, Android) has three iOS reports, which would all have landed in ios.zip.

- refresh-viewer-preview-fixtures.sh: one ZIP per listing entry, <target>.zip, fetched at ?target= (?platform= for
  a target named after its platform); reports.json keeps target and label. Target ids from the hosted listing are
  checked before they name a file.
- deploy-viewer-preview.mjs: fixtureReports reads the listing into deployFixturePreview's reports, each with its
  target and ZIP; a listing from before targets is its platforms', as before.
- viewer-preview.yml: one comment row per target, named by its label, linking ?target=.
2026-10-18 09:56:38 -07:00
5 changed files with 78 additions and 24 deletions

No files matched your search

+7 -2
View File
@@ -76,9 +76,14 @@ jobs:
| [$marker,
"**Viewer preview** of \($sha)\(if $source != "" then " · reports from \($source)" else "" end)",
"",
"| Platform | Changes | Open |",
"| Report | Changes | Open |",
"| --- | --- | --- |",
($reports[] | "| \(if .platform == "ios" then "iOS" else "Android" end)\(if .device then " · \(.device)" else "" end) | \(.changes // "–") | [Map](\($url)?platform=\(.platform)) · [Screens](\($url)?platform=\(.platform)#/screens) · [Compare](\($url)?platform=\(.platform)&view=compare) |"),
# One row per target, named by its label; a target named after its platform keeps ?platform= links.
($reports[]
| (.target // .platform) as $id
| "\(if $id == "ios" or $id == "android" then "platform" else "target" end)=\($id)" as $query
| ((.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 link stays the same on every push. [Deploy run](\($run))"]
| join("\n")' "$RUNNER_TEMP/preview.json" > "$RUNNER_TEMP/comment.md"
+6 -5
View File
@@ -3,13 +3,14 @@
//
// node scripts/deploy-viewer-preview.mjs --fixtures DIR --alias pr-123 --project explore-viewer-pr [--owner expo-public]
//
// DIR holds reports.json ([{ platform, changes?, device? }], as a hosted preview's /reports.json lists them) and one
// <platform>.zip per entry (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an
// earlier link's /p/<token>; without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
// DIR holds reports.json ([{ target?, platform, label?, changes?, device? }], as a hosted preview's /reports.json lists
// them) and one <target>.zip per entry, or <platform>.zip for an entry without a target
// (scripts/refresh-viewer-preview-fixtures.sh writes both). EXPLORE_PREVIEW_TOKEN keeps an earlier link's /p/<token>;
// without it the link gets a new one. EXPO_TOKEN must be able to deploy to the project.
import { readFile } from "node:fs/promises";
import { join } from "node:path";
import { parseArgs } from "node:util";
import { deployFixturePreview } from "../dist/report/preview-deploy.js";
import { deployFixturePreview, fixtureReports } from "../dist/report/preview-deploy.js";
const { values } = parseArgs({ options: { fixtures: { type: "string" }, alias: { type: "string" }, project: { type: "string" }, owner: { type: "string" } } });
if (!values.fixtures || !values.alias || !values.project) {
@@ -19,7 +20,7 @@ if (!values.fixtures || !values.alias || !values.project) {
const listing = JSON.parse(await readFile(join(values.fixtures, "reports.json"), "utf8"));
const token = process.env.EXPLORE_PREVIEW_TOKEN?.trim() || undefined;
const result = await deployFixturePreview({
reports: listing.map(({ platform, changes, device }) => ({ platform, zipPath: join(values.fixtures, `${platform}.zip`), changes, device })),
reports: fixtureReports(listing, values.fixtures),
project: values.project, alias: values.alias, ...(values.owner ? { owner: values.owner } : {}), ...(token ? { token } : {}),
});
console.log(JSON.stringify({ ...result, reports: listing }));
+21 -16
View File
@@ -18,30 +18,35 @@ trap 'rm -rf "$work"' EXIT
if ! curl -fsS "$base/reports.json" -o "$work/listing.json"; then
echo '[{"platform":"ios"}]' > "$work/listing.json"
fi
# One ZIP per target, named for it: <target>.zip, or <platform>.zip for a report from before targets. A target named
# after its platform is selected with ?platform=, any other with ?target= (as viewer-links.ts targetParameter does).
# A preview deployed before Explore wrote static files serves each target's ZIP; a newer one serves its manifest and
# screenshots, so the ZIP is put back together here. Screenshot requests keep ?platform=, which deployments that
# answered them from the ZIP need and static files ignore.
for platform in $(jq -r '.[].platform' "$work/listing.json"); do
if curl -fsS "$base/report.zip?platform=$platform" -o "$work/$platform.zip" 2> /dev/null; then
unzip -tq "$work/$platform.zip" > /dev/null
# screenshots, so the ZIP is put back together here. Screenshot requests keep the target's query, which deployments
# that answered them from the ZIP need and static files ignore.
for key in $(jq -r '.[] | .target // .platform' "$work/listing.json"); do
# The listing comes from the hosted preview: a key names files here, so it must be a target id.
[[ "$key" =~ ^[a-z][a-z0-9-]{0,31}$ ]] || { echo "Not a target id in reports.json: $key" >&2; exit 2; }
case "$key" in ios|android) query="platform=$key" ;; *) query="target=$key" ;; esac
if curl -fsS "$base/report.zip?$query" -o "$work/$key.zip" 2> /dev/null; then
unzip -tq "$work/$key.zip" > /dev/null
continue
fi
report="$work/$platform"
report="$work/$key"
mkdir -p "$report/assets"
curl -fsS "$base/manifest.json?platform=$platform" -o "$work/$platform.manifest.json"
file="$(jq -r .file "$work/$platform.manifest.json")"
[[ "$file" == review.json || "$file" == exploration.json ]] || { echo "Not a report manifest: $platform" >&2; exit 1; }
jq -c .report "$work/$platform.manifest.json" > "$report/$file"
for asset in $(jq -r '.entries | keys[]' "$work/$platform.manifest.json"); do
curl -fsS "$base/manifest.json?$query" -o "$work/$key.manifest.json"
file="$(jq -r .file "$work/$key.manifest.json")"
[[ "$file" == review.json || "$file" == exploration.json ]] || { echo "Not a report manifest: $key" >&2; exit 1; }
jq -c .report "$work/$key.manifest.json" > "$report/$file"
for asset in $(jq -r '.entries | keys[]' "$work/$key.manifest.json"); do
[[ "$asset" =~ ^assets/[a-f0-9]{64}\.(png|jpg|mp4)$ ]] || { echo "Unexpected asset name: $asset" >&2; exit 1; }
curl -fsS "$base/$asset?platform=$platform" -o "$report/$asset"
curl -fsS "$base/$asset?$query" -o "$report/$asset"
[[ "$(shasum -a 256 "$report/$asset" | cut -c1-64)" == "${asset:7:64}" ]] || { echo "Checksum mismatch: $asset" >&2; exit 1; }
done
rm -f "$work/$platform.zip"
(cd "$report" && zip -qrX "$work/$platform.zip" "$file" assets)
unzip -tq "$work/$platform.zip" > /dev/null
rm -f "$work/$key.zip"
(cd "$report" && zip -qrX "$work/$key.zip" "$file" assets)
unzip -tq "$work/$key.zip" > /dev/null
done
jq --arg source "$source_name" '[.[] | {platform, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
jq --arg source "$source_name" '[.[] | {target, platform, label, changes, device, source: $source} | with_entries(select(.value != null))]' "$work/listing.json" > "$work/reports.json"
gh release view "$tag" > /dev/null 2>&1 || gh release create "$tag" --prerelease --latest=false --title "Viewer preview fixtures" \
--notes "Reports the Viewer preview workflow serves on every pull request. Refresh with scripts/refresh-viewer-preview-fixtures.sh."
+22
View File
@@ -700,6 +700,28 @@ export async function deployFixturePreview(options: FixturePreviewOptions): Prom
...(options.token ? { token: options.token } : {}) });
}
/**
* The reports a fixture directory holds (scripts/refresh-viewer-preview-fixtures.sh writes it): its reports.json, as a
* hosted preview's /reports.json lists them, with `<target>.zip` beside it for each entry. An entry without a target,
* from fixtures refreshed before targets, is its platform's target with `<platform>.zip`.
*/
export function fixtureReports(listing: unknown, directory: string): FixturePreviewOptions["reports"] {
const invalid = () => previewError("PREVIEW_REPORTS_INVALID", "The fixtures' reports.json does not list valid reports",
"Refresh the fixtures with scripts/refresh-viewer-preview-fixtures.sh.");
if (!Array.isArray(listing)) throw invalid();
return listing.map((entry: unknown) => {
if (typeof entry !== "object" || entry === null) throw invalid();
const { platform, target: id, label, changes, device } = entry as Record<string, unknown>;
if (platform !== "ios" && platform !== "android") throw invalid();
const target = id === undefined ? undefined : readTarget({ id, platform, label });
if (id !== undefined && !target) throw invalid();
return {
platform, ...(target ? { target } : {}), zipPath: join(directory, `${target?.id ?? platform}.zip`),
...(typeof changes === "number" ? { changes } : {}), ...(typeof device === "string" ? { device } : {}),
};
});
}
/**
* Report ZIPs on this machine behind one token (`capture:review --upload`, `report:upload`), one per target: the same
* sealed deployment as a PR preview, from ZIPs instead of GitHub artifacts, with the local EAS login or EXPO_TOKEN.
+22 -1
View File
@@ -7,7 +7,7 @@ import test from "node:test";
import { prepareCaptureReview } from "../../dist/review/capture-review.js";
import { createSourceCapturePlan } from "../../dist/source/capture-plan.js";
import { writeCiReportInput, exportCiReport } from "../../dist/report/artifact.js";
import { collectPlatformReports, deployExplorationReport, deployFixturePreview, deployLocalReports, 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";
@@ -525,6 +525,27 @@ test("a fixture preview seals each platform's ZIP as is behind one alias and lis
error => error.code === "PREVIEW_ALIAS_INVALID");
});
test("fixture reports name each target's ZIP, and a listing from before targets its platform's", () => {
const listing = [
{ target: "iphone", platform: "ios", label: "iPhone 17", changes: 11, device: "iPhone 17 26.5 · light + dark", source: "brentvatne/euxy#163" },
{ target: "duo-open", platform: "ios", label: "iPhone Duo (open)", changes: 34 },
{ target: "android", platform: "android", label: "Android", changes: 5 },
];
assert.deepEqual(fixtureReports(listing, "/fixtures"), [
{ platform: "ios", target: { id: "iphone", platform: "ios", label: "iPhone 17" }, zipPath: "/fixtures/iphone.zip", changes: 11, device: "iPhone 17 26.5 · light + dark" },
{ platform: "ios", target: { id: "duo-open", platform: "ios", label: "iPhone Duo (open)" }, zipPath: "/fixtures/duo-open.zip", changes: 34 },
{ platform: "android", target: { id: "android", platform: "android", label: "Android" }, zipPath: "/fixtures/android.zip", changes: 5 },
]);
assert.deepEqual(fixtureReports([{ platform: "ios", changes: 3 }, { platform: "android" }], "/fixtures"), [
{ platform: "ios", zipPath: "/fixtures/ios.zip", changes: 3 },
{ platform: "android", zipPath: "/fixtures/android.zip" },
]);
// reports.json comes from a hosted preview: a target that is not an id never names a file.
for (const bad of [[{ target: "../escape", platform: "ios" }], [{ platform: "web" }], [null], { platform: "ios" }]) {
assert.throws(() => fixtureReports(bad, "/fixtures"), error => error.code === "PREVIEW_REPORTS_INVALID", JSON.stringify(bad));
}
});
test("a deployment that does not report the requested alias is a retryable deploy failure", async t => {
const { reportPath, exportPath } = await exportFixture(t);
await asExploration(reportPath);