mirror of
https://github.com/expo/explore.git
synced 2026-11-15 17:32:23 -10:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7bc6cc23b8 | ||
|
|
8a96513e37 |
No files matched your search
@@ -217,7 +217,7 @@ exploration:
|
||||
- /c/[channel]
|
||||
```
|
||||
|
||||
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the map and the screen counts, and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
|
||||
An excluded route stays in its neighbors' navigation context (a screen that links to it is still captured when it changes), but neither revision captures it, it is left off the report (the Map, Screens, search and the screen counts), and a change to it gets no before/after comparison. A name that matches no route at either compared revision fails the plan with `EXCLUDE_ROUTE_UNKNOWN`; `doctor` warns about it first. Prefer `parameters` or `setup` when a route does show a screen.
|
||||
|
||||
Capture handles iOS's confirmation to open a link in the expected app. After a form submits a password, iOS may offer to save or update it depending on the simulator's AutoFill state; capture declines that prompt with Not Now in both modes, never stores the credential, and records each decision in `capture-diagnostics/system-prompts.jsonl`. Do not script that tap in setup. Include required system-alert handling in setup or app instructions; Explore does not automatically grant application permissions.
|
||||
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
import type { PublicReview } from "./capture.js";
|
||||
import { navigationCaptureContext } from "./navigation-graph.js";
|
||||
|
||||
type Surface = PublicReview["surfaces"][number];
|
||||
type Side = "base" | "head";
|
||||
|
||||
/** Navigation is route-level: a secondary-appearance surface (`<id>@<scheme>`) rides on its route's entry. */
|
||||
const SCHEME_SUFFIX = /@(light|dark)$/;
|
||||
const routeOf = (id: string): string => id.replace(SCHEME_SUFFIX, "");
|
||||
|
||||
/**
|
||||
* The surfaces a side planned to capture: every route in `all` mode, the changed routes and their navigation context in
|
||||
* `changes` mode. Undefined without navigation, which leaves no route outside the context.
|
||||
*/
|
||||
export function captureContext(review: PublicReview, side: Side): ReadonlySet<string> | undefined {
|
||||
const navigation = review.navigation?.[side];
|
||||
if (!navigation) return undefined;
|
||||
const inventory = review.surfaces.filter((surface) => surface[side]);
|
||||
const routes = new Map<string, NonNullable<Surface[Side]>>();
|
||||
for (const surface of inventory) {
|
||||
const id = routeOf(surface.id);
|
||||
if (!routes.has(id)) routes.set(id, { ...surface[side]!, id });
|
||||
}
|
||||
const selected = new Set(review.mode === "all" ? [...routes.keys()] : navigationCaptureContext(navigation,
|
||||
inventory.filter((surface) => surface.status !== "unchanged").map((surface) => routeOf(surface.id)),
|
||||
[...routes.values()]));
|
||||
return new Set(inventory.filter((surface) => selected.has(routeOf(surface.id))).map((surface) => surface.id));
|
||||
}
|
||||
|
||||
/** Both a screenshot of the planned route and a verified landing on it. */
|
||||
export function verifiedCapture(surface: Surface, side: Side): boolean {
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
return Boolean(surface[side]?.kind === "screen" && (side === "base" ? surface.baseImage : surface.headImage)
|
||||
&& outcome?.status === "captured" && outcome.landing === "verified");
|
||||
}
|
||||
|
||||
/**
|
||||
* Why a side that exists in its revision has no verified capture, as the report's capture gap: `accepted` when the run
|
||||
* left it uncaptured on purpose (a redirect declaration, a route named in `exploration.exclude`, or a route outside the
|
||||
* capture context), `open` for anything else, such as a capture that failed. Undefined for a verified capture or an
|
||||
* absent side. `context` is the side's `captureContext`.
|
||||
*/
|
||||
export function captureGap(review: PublicReview, surface: Surface, side: Side,
|
||||
context: ReadonlySet<string> | undefined): "accepted" | "open" | undefined {
|
||||
const entry = surface[side];
|
||||
if (!entry || verifiedCapture(surface, side)) return undefined;
|
||||
const image = side === "base" ? surface.baseImage : surface.headImage;
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
const outsideCaptureContext = review.mode === "changes" && context !== undefined && !context.has(surface.id);
|
||||
const deliberate = !image && !outcome && (entry.kind === "redirect" || surface.excluded === true || outsideCaptureContext
|
||||
|| (!review.navigation?.[side] && review.mode === "changes" && surface.status === "unchanged"));
|
||||
return deliberate ? "accepted" : "open";
|
||||
}
|
||||
|
||||
/**
|
||||
* The surfaces the run never captured on purpose: no screenshot of their own on either side, and every side that exists
|
||||
* left uncaptured deliberately (`captureGap` is `accepted`). None is one of the report's screens. The Viewer leaves them
|
||||
* out (viewer/src/utils/omitted-screens.ts reaches the same set from the map's gaps), and the PR comment skips them.
|
||||
* A side with an open gap, such as a failed capture, keeps the surface: its failure is part of the report.
|
||||
*/
|
||||
export function neverCapturedSurfaceIds(review: PublicReview): ReadonlySet<string> {
|
||||
// The Viewer refuses a review whose navigation names a route its inventory lacks; the comment still renders one,
|
||||
// without a capture context, so no route counts as outside it.
|
||||
const contextOf = (side: Side) => { try { return captureContext(review, side); } catch { return undefined; } };
|
||||
const contexts = { base: contextOf("base"), head: contextOf("head") };
|
||||
const omitted = new Set<string>();
|
||||
for (const surface of review.surfaces) {
|
||||
if (surface.baseImage || surface.headImage) continue;
|
||||
const gaps = (["base", "head"] as const).map((side) => captureGap(review, surface, side, contexts[side]));
|
||||
if (gaps.includes("accepted") && !gaps.includes("open")) omitted.add(surface.id);
|
||||
}
|
||||
return omitted;
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import { CI_COMMENT_MARKER } from "./pr-comment.js";
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedPrevious, orderedRecords, previousLine, readCommentRecords, recordLabel, recordLine, recordSummary,
|
||||
type ChangeGroup, type CommentNavigation, type CommentTarget, type CommentRecords, type HistoryEntry, type NavigationGroup, type NavigationKind, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
|
||||
import { neverCapturedSurfaceIds } from "../contracts/surface-capture.js";
|
||||
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
|
||||
import type { ReviewPresentation } from "../contracts/review.js";
|
||||
import type { ViewerLinks } from "./viewer-links.js";
|
||||
@@ -294,8 +295,10 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
|
||||
if (state.review) {
|
||||
const evidenceBased = state.review.surfaces.some(surface => surface.review);
|
||||
record.changes = [];
|
||||
// A route the run never captured on purpose is not one of the report's screens, here as in the Viewer.
|
||||
const omitted = neverCapturedSurfaceIds(state.review);
|
||||
for (const surface of state.review.surfaces) {
|
||||
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
|
||||
if (omitted.has(surface.id)) continue;
|
||||
const group = groupOf(surface, evidenceBased);
|
||||
if (group === "unlisted") continue;
|
||||
const scheme = schemeOf(surface.id);
|
||||
@@ -348,9 +351,10 @@ function navigationOf(review: PublicReview, groups: Map<string, ChangeGroup>): C
|
||||
if (!review.navigation) return undefined;
|
||||
const keyOf = new Map<string, string>();
|
||||
const groupOf = new Map<string, NavigationGroup>();
|
||||
const omitted = neverCapturedSurfaceIds(review);
|
||||
for (const surface of review.surfaces) {
|
||||
const route = surface.head ?? surface.base;
|
||||
if (!route || route.kind === "redirect") continue;
|
||||
if (!route || omitted.has(surface.id)) continue;
|
||||
const key = routePattern(route);
|
||||
keyOf.set(surface.id.replace(/@(light|dark)$/, ""), key);
|
||||
const group = groups.get(surface.id);
|
||||
@@ -718,8 +722,9 @@ export function reviewDevice(state: { runtime?: Pick<SimulatorRuntimeMetadata, "
|
||||
export function reviewChanges(review: PublicReview): Map<string, ChangeGroup> {
|
||||
const evidenceBased = review.surfaces.some(surface => surface.review);
|
||||
const changes = new Map<string, ChangeGroup>();
|
||||
const omitted = neverCapturedSurfaceIds(review);
|
||||
for (const surface of review.surfaces) {
|
||||
if ((surface.head ?? surface.base)?.kind === "redirect") continue;
|
||||
if (omitted.has(surface.id)) continue;
|
||||
const group = groupOf(surface, evidenceBased);
|
||||
if (group !== "unlisted") changes.set(surface.id, group);
|
||||
}
|
||||
|
||||
@@ -1346,7 +1346,7 @@ test("transition thumbnails without a readable screenshot show the variant thumb
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a docs-only report with zero images and no EAS build opens Screens without a visual verdict", async t => {
|
||||
test("a docs-only report with zero images and no EAS build has no screens to show, and its link to a route says why", async t => {
|
||||
const report = reportFixture();
|
||||
report.review.mode = "changes";
|
||||
report.review.runtime.projectId = "";
|
||||
@@ -1359,12 +1359,11 @@ test("a docs-only report with zero images and no EAS build opens Screens without
|
||||
report.assets = [];
|
||||
const { page, errors } = await harness(t, await archive(report), { app: true });
|
||||
await expect(page.locator(".app-shell")).toBeVisible();
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(1);
|
||||
await expect(page.locator(".screens-page .diff-frame.diff-not-compared")).toHaveCount(1);
|
||||
// The Inspector's missing screenshot matches the canvas node: the icon above a short label and
|
||||
// the report's reason for the gap, centred in a phone-shaped preview frame.
|
||||
await page.locator(".screens-page .screen-screenshot-target").click();
|
||||
// The change reaches no screen, so the one route was never captured: the Map and Screens say so instead of an empty page.
|
||||
const empty = page.locator(".map-empty");
|
||||
await expect(empty.getByRole("heading")).toHaveText("No screens were captured");
|
||||
// The link names /home, and the Inspector says why it has no screenshot: the icon above a short label and the report's
|
||||
// reason for the gap, centred in a phone-shaped preview frame.
|
||||
const placeholder = page.locator(".inspector .inspector-preview .screenshot-placeholder");
|
||||
await expect(placeholder.locator("span")).toHaveText("No screenshot");
|
||||
await expect(placeholder.locator(".screenshot-placeholder-detail")).toHaveText("Not compared; no capture was recorded");
|
||||
@@ -1390,10 +1389,98 @@ test("a docs-only report with zero images and no EAS build opens Screens without
|
||||
await expect(page.locator(".collapsed-change-count")).toHaveCount(0);
|
||||
await expect(page.locator(".changes-screen-row")).toHaveCount(0);
|
||||
await expect(page.locator(".diff-frame.diff-modified, .diff-frame.diff-unchanged")).toHaveCount(0);
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
await expect(empty.getByRole("heading")).toHaveText("No screens were captured");
|
||||
await expect(page.locator(".screens-cell, .screens-tree-row")).toHaveCount(0);
|
||||
assert.equal(await page.evaluate(() => window.createdUrls.length), 0);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
/** A report with Home (modified) and Profile (not compared) captured, a new route named in exploration.exclude, and a redirect. */
|
||||
function omittedRoutesReport() {
|
||||
const report = reportFixture();
|
||||
const home = report.review.surfaces[0];
|
||||
const route = (id, path, extra = {}) => ({ ...home.head, id, route: path, path, routeFile: `app/${id}.tsx`, logicalPath: `app/${id}.tsx`, ...extra });
|
||||
const redirect = route("start", "/start", { kind: "redirect", redirectTo: "/home" });
|
||||
report.review.surfaces.push(
|
||||
{ id: "profile", status: "unchanged", base: route("profile", "/profile"), head: route("profile", "/profile"),
|
||||
baseImage: { ...home.baseImage }, headImage: { ...home.headImage }, baseOutcome: { ...home.baseOutcome }, headOutcome: { ...home.headOutcome } },
|
||||
{ id: "channel", status: "added", excluded: true, base: null, head: route("channel", "/c/[channel]") },
|
||||
{ id: "start", status: "unchanged", base: { ...redirect }, head: redirect });
|
||||
return report;
|
||||
}
|
||||
|
||||
test("a public report's excluded route and redirect are not among its screens: Screens, its counts, find, search and the changes leave them out", { timeout: 60_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await archive(omittedRoutesReport()), { app: true, query: "&screen=home" });
|
||||
await expect(page.locator(".map-canvas .react-flow__node")).toHaveCount(2);
|
||||
// The excluded route is new in this change, but it was never captured: it is not a change to review.
|
||||
const menu = await openChangesMenu(page);
|
||||
await expect(menu.getByRole("group", { name: "Filter changes" }).getByRole("button")).toHaveText(["Modified 1"]);
|
||||
await expect(menu.getByText("/c/[channel]")).toHaveCount(0);
|
||||
await page.keyboard.press("Escape");
|
||||
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
const cells = page.locator(".screens-page .screens-cell");
|
||||
await expect(cells).toHaveCount(2);
|
||||
await expect(page.locator(".screens-tree-row[data-screen-id]")).toHaveCount(2);
|
||||
for (const id of ["channel", "start"]) await expect(page.locator(`[data-screen-id="${id}"]`)).toHaveCount(0);
|
||||
await expect(page.locator(".screens-filter .screens-chip")).toHaveText(["Changed1", "All2"]);
|
||||
// ← and → step through the two screens and no others.
|
||||
await page.locator(".screens-page").click({ position: { x: 4, y: 4 } });
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(page.locator(".screens-cell .screen-screenshot-card.selected")).toHaveCount(1);
|
||||
const picked = async () => page.locator(".screens-cell:has(.screen-screenshot-card.selected)").getAttribute("data-screen-id");
|
||||
const first = await picked();
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect.poll(picked).not.toBe(first);
|
||||
const second = await picked();
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect.poll(picked).toBe(second);
|
||||
assert.deepEqual([first, second].sort(), ["home", "profile"]);
|
||||
|
||||
// `/` finds the report's screens only.
|
||||
await page.keyboard.press("/");
|
||||
const find = page.getByRole("searchbox", { name: "Find screens" });
|
||||
await expect(find).toBeFocused();
|
||||
for (const query of ["channel", "start"]) {
|
||||
await find.fill(query);
|
||||
await expect(page.locator(".screens-find-empty")).toHaveText(`No screens match “${query}”`);
|
||||
await expect(cells).toHaveCount(0);
|
||||
}
|
||||
await find.fill("profile");
|
||||
await expect(cells).toHaveCount(1);
|
||||
await page.keyboard.press("Escape");
|
||||
await page.keyboard.press("Escape");
|
||||
|
||||
// So does the command palette's screen search.
|
||||
await page.keyboard.press("ControlOrMeta+KeyK");
|
||||
const palette = page.getByRole("dialog", { name: "Search Explore" });
|
||||
const box = palette.getByRole("combobox", { name: "Search screens and commands" });
|
||||
await expect(box).toBeFocused();
|
||||
await box.fill("/c/");
|
||||
await expect(palette.getByRole("option")).toHaveCount(0);
|
||||
await box.fill("/st");
|
||||
await expect(palette.getByRole("option")).toHaveCount(0);
|
||||
await box.fill("/pro");
|
||||
await expect(palette.getByRole("option")).toHaveText([/\/profile/]);
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("a link to an excluded route opens it in the Inspector, which says why it has no screenshot, on the Map and on Screens", { timeout: 60_000 }, async t => {
|
||||
const { page, errors } = await harness(t, await archive(omittedRoutesReport()), { app: true, query: "&screen=channel" });
|
||||
const detail = page.locator(".inspector .inspector-preview .screenshot-placeholder-detail");
|
||||
await expect(detail).toHaveText("Excluded by exploration.exclude; never captured");
|
||||
await expect(page.locator(".map-canvas .react-flow__node")).toHaveCount(2);
|
||||
await expect(page.locator(".map-canvas .react-flow__node.selected")).toHaveCount(0);
|
||||
// The same link on Screens, opened afresh: no card is picked, and the Inspector explains the route.
|
||||
await page.goto(page.url().replace("#/map/", "#/screens/"));
|
||||
await page.reload();
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(2);
|
||||
await expect(page.locator(".screens-cell .screen-screenshot-card.selected")).toHaveCount(0);
|
||||
await expect(detail).toHaveText("Excluded by exploration.exclude; never captured");
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
test("unverified capture diagnostics stay separate from verified Needs review, and source changes nobody compared are not changes", async t => {
|
||||
const report = reportFixture();
|
||||
const home = report.review.surfaces[0];
|
||||
@@ -1507,10 +1594,11 @@ test("a recorded pull-request artifact opens its verified verdicts and every scr
|
||||
await expect(menu.getByText(route, { exact: true })).toBeVisible();
|
||||
}
|
||||
|
||||
// Its two redirect declarations (/ and /scan/select-photo) were never captured: they are not among its screens.
|
||||
await page.getByRole("button", { name: "Screens", exact: true }).click();
|
||||
const frames = page.locator(".screens-page .diff-frame");
|
||||
await expect(frames).toHaveCount(35);
|
||||
for (const [status, count] of [["modified", 3], ["added", 1], ["removed", 1], ["unchanged", 28], ["not-compared", 2]]) {
|
||||
await expect(frames).toHaveCount(33);
|
||||
for (const [status, count] of [["modified", 3], ["added", 1], ["removed", 1], ["unchanged", 28], ["not-compared", 0]]) {
|
||||
await expect(page.locator(`.screens-page .diff-frame.diff-${status}`)).toHaveCount(count);
|
||||
}
|
||||
const screenshots = page.locator(".screens-page img[data-screenshot-src]");
|
||||
|
||||
@@ -318,7 +318,7 @@ test("Compare steps through changed screens and their changed areas", { timeout:
|
||||
/** The Inspector's one frame for a screen outside the review, and its Swipe frame for a changed one, in this viewport. */
|
||||
async function inspectorFrames(page, url) {
|
||||
const games = "expo-tabs-games-index-2c6605360b11";
|
||||
const index = "expo-index-02872ff9f2ca";
|
||||
const unchanged = "expo-tabs-scan-index-2bbf42237cc6";
|
||||
const open = async id => {
|
||||
await page.goto(`${url}#/screens`);
|
||||
const all = page.getByRole("button", { name: /^All/ }).first();
|
||||
@@ -333,14 +333,14 @@ async function inspectorFrames(page, url) {
|
||||
const swipeImage = page.locator(".sidebar-review-stage img").first();
|
||||
await expect(swipeImage).toBeVisible();
|
||||
const changed = await swipeImage.boundingBox();
|
||||
await open(index);
|
||||
await open(unchanged);
|
||||
const single = page.locator(".sidebar-review-off .variant-preview");
|
||||
await expect(single).toBeVisible();
|
||||
return { changed, single: await single.boundingBox() };
|
||||
}
|
||||
|
||||
test("the Inspector frames an unchanged screen at the size of a changed screen's Swipe frame", { timeout: 90_000 }, async t => {
|
||||
// / is unchanged (not compared); /games is modified. The single frame used to take at most half the panel, the
|
||||
// /scan is unchanged; /games is modified. The single frame used to take at most half the panel, the
|
||||
// width of one frame of a Before/After pair, while Swipe and Flip fill the panel up to 70 % (phone: 52 %) of the window.
|
||||
for (const viewport of [{ width: 1024, height: 820 }, { width: 390, height: 844 }]) {
|
||||
const { page, url, errors } = await openReport(t, viewport);
|
||||
|
||||
@@ -3147,6 +3147,25 @@ test("Screens adds the screens a live map gains", async ({ page }) => {
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(30, { timeout: 7_000 });
|
||||
});
|
||||
|
||||
test("a local map keeps a screen whose capture gap was accepted on its Map, in Screens and in find", async ({ page }) => {
|
||||
// A public report leaves such a route out (omitted-screens.ts); a local run's screens are all its own.
|
||||
const payload = await liveMapPayload(3, 100);
|
||||
payload.map.gaps.push({ id: "accepted", screenId: "live-screen-2", kind: "coverage", status: "accepted",
|
||||
message: "Redirect declaration; no screenshot selected", createdAt: payload.map.run.createdAt });
|
||||
await serveMap(page, payload);
|
||||
await page.goto("/map");
|
||||
await expect(page.locator(".react-flow__node-screen")).toHaveCount(3);
|
||||
await page.goto("/screens");
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(3);
|
||||
await expect(page.locator('.screens-page .screens-tree-row[data-screen-id="live-screen-2"]')).toHaveCount(1);
|
||||
await page.keyboard.press("/");
|
||||
const field = page.getByRole("main", { name: "Screens" }).getByRole("searchbox", { name: "Find screens" });
|
||||
await expect(field).toBeFocused();
|
||||
await field.fill("screen 2");
|
||||
await expect(page.locator(".screens-page .screens-cell")).toHaveCount(1);
|
||||
await expect(page.locator('.screens-page .screens-cell[data-screen-id="live-screen-2"]')).toHaveCount(1);
|
||||
});
|
||||
|
||||
test("zooms Map inspection up to 25600% without exceeding the ceiling", async ({ page }) => {
|
||||
test.setTimeout(30_000);
|
||||
await page.goto("/map");
|
||||
|
||||
@@ -796,3 +796,16 @@ test('an excluded route is neither listed nor counted as an app-wide screen', ()
|
||||
const body = renderPublicComment(state({ review: review([...evidenceReview().surfaces, excluded]) }));
|
||||
assert.doesNotMatch(body, /\/channel|App-wide source changes|not compared/);
|
||||
});
|
||||
|
||||
test('an excluded route that is new is not one of the changed screens, nor of the ones the list links to', () => {
|
||||
const screens = Array.from({ length: 11 }, (_, index) => surface(`screen-${index}`, 'modified', { extra: {
|
||||
review: { status: 'modified', description: `Changed ${index}` },
|
||||
visual: { verdict: 'modified', reason: 'repeated-cross-build-delta', mismatchPercentage: 1, threshold: 0.1, tool: '[email protected]' },
|
||||
} }));
|
||||
const excluded = surface('channel', 'added', { route: '/c/[channel]', extra: { excluded: true } });
|
||||
for (const key of ['baseImage', 'headImage', 'baseOutcome', 'headOutcome']) delete excluded[key];
|
||||
const body = renderPublicComment(state({ review: review([...screens, excluded]) }));
|
||||
assert.equal(titleOf(body), `### 11 screens changed · [Review in Explore](<${reportUrl}>)`);
|
||||
assert.equal(listOf(body).at(-1), `- [1 more screen in the report](<${reportUrl}>)`);
|
||||
assert.doesNotMatch(body, /\/c\/\[channel\]/);
|
||||
});
|
||||
@@ -13,6 +13,13 @@ const { presentScreensByPath, presentBuildDiff } = await tsImport(
|
||||
const { artifactUrl, indexMap } = await tsImport("../../viewer/src/utils/model.ts", import.meta.url);
|
||||
const { primaryScreenshotForScreen } = await tsImport("../../viewer/src/utils/screen-images.ts", import.meta.url);
|
||||
const { buildObservedGraph, buildViewerGraph, projectFullGraph } = await tsImport("../../viewer/src/utils/graph-model.ts", import.meta.url);
|
||||
const { omittedScreenIds, omittedSourceScreenIds, reportScreens, withoutOmittedScreens } = await tsImport("../../viewer/src/utils/omitted-screens.ts", import.meta.url);
|
||||
const { reviewChanges } = await import("../../dist/report/pr-comment-body.js");
|
||||
const { neverCapturedSurfaceIds } = await tsImport("../../src/contracts/surface-capture.ts", import.meta.url);
|
||||
const { buildSearchItems } = await tsImport("../../viewer/src/utils/search.ts", import.meta.url);
|
||||
|
||||
/** The Map as the Viewer draws a map without a comparison: its own screens, less the ones it never captured. */
|
||||
const viewerGraph = (map, index = indexMap(map)) => buildViewerGraph(map, index, omittedScreenIds(map));
|
||||
|
||||
function entry(id, route, variant = "default", extra = {}) {
|
||||
return {
|
||||
@@ -124,10 +131,10 @@ test("source navigation projects directional context and route variants without
|
||||
assert.equal(payload.coverage.transitions, 0);
|
||||
for (const collection of ["transitions", "actionAttempts", "journeys"]) assert.deepEqual(payload.map[collection], []);
|
||||
assert.equal(buildObservedGraph(payload.map, indexMap(payload.map)).groups.length, 0);
|
||||
const viewerGraph = buildViewerGraph(payload.map, indexMap(payload.map));
|
||||
assert.deepEqual(viewerGraph.screens.map(screen => screen.id).sort(), ["camera-alias", "games-free", "games-pro", "scan-breed", "scan-mood"]);
|
||||
assert.equal(viewerGraph.groups.length, 2);
|
||||
assert.ok(viewerGraph.groups.every(group => group.transitionIds.length === 0 && group.sourceEdges.length > 0));
|
||||
const graph = viewerGraph(payload.map);
|
||||
assert.deepEqual(graph.screens.map(screen => screen.id).sort(), ["camera-alias", "games-free", "games-pro", "scan-breed", "scan-mood"]);
|
||||
assert.equal(graph.groups.length, 2);
|
||||
assert.ok(graph.groups.every(group => group.transitionIds.length === 0 && group.sourceEdges.length > 0));
|
||||
const presentation = presentScreensByPath(payload.map);
|
||||
const scan = presentation.map.screens.find(screen => screen.route === "/scan/instruction");
|
||||
assert.equal(scan.variantIds.length, 2);
|
||||
@@ -139,7 +146,7 @@ test("source navigation projects directional context and route variants without
|
||||
test("public map omits redirects and unselected changes routes while retaining selected failures", () => {
|
||||
const review = verifyImages(fixture("changes"));
|
||||
const current = workspaceSides(publicReviewToWorkspace(review)).current;
|
||||
const graph = buildViewerGraph(current.map, indexMap(current.map));
|
||||
const graph = viewerGraph(current.map);
|
||||
assert.deepEqual(graph.screens.map(screen => screen.id).sort(), ["care-guide", "games-free"]);
|
||||
assert.equal(current.map.screens.length, 7, "the published source inventory remains available");
|
||||
|
||||
@@ -149,7 +156,7 @@ test("public map omits redirects and unselected changes routes while retaining s
|
||||
status: "failed", attempts: 1, landing: "unverified", reason: "Capture failed",
|
||||
};
|
||||
const failedMap = workspaceSides(publicReviewToWorkspace(failed)).current.map;
|
||||
const failedGraph = buildViewerGraph(failedMap, indexMap(failedMap));
|
||||
const failedGraph = viewerGraph(failedMap);
|
||||
assert.equal(failedGraph.screens.some(screen => screen.id === "scan-mood"), true);
|
||||
assert.equal(failedGraph.screens.some(screen => screen.id === "home"), false);
|
||||
});
|
||||
@@ -833,7 +840,7 @@ test("an excluded route leaves the map with an accepted gap, like a redirect", (
|
||||
excluded.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete excluded[`${side}Image`]; delete excluded[`${side}Outcome`]; }
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(review));
|
||||
const graph = buildViewerGraph(current.map, indexMap(current.map));
|
||||
const graph = viewerGraph(current.map);
|
||||
assert.equal(graph.screens.some(screen => screen.id === "games-pro"), false, "never captured, so not a card on the map");
|
||||
assert.ok(current.map.screens.some(screen => screen.id === "games-pro"), "the inventory still knows the route");
|
||||
const gap = current.map.gaps.find(gap => gap.screenId === "games-pro");
|
||||
@@ -885,3 +892,151 @@ test("a screen's note is its first open gap of any kind, and an accepted gap onl
|
||||
assert.equal(indexMap({ ...current.map, gaps: [resolved, accepted] }).screenNotes.get("games-free"), accepted.message);
|
||||
assert.equal(indexMap({ ...current.map, gaps: [resolved] }).screenNotes.has("games-free"), false);
|
||||
});
|
||||
|
||||
/** What the Viewer leaves out of a review and the comparison it then shows, computed as app.tsx does. */
|
||||
function viewerOmission(review) {
|
||||
const workspace = publicReviewToWorkspace(review);
|
||||
const diff = diffFor(review);
|
||||
const presentation = presentScreensByPath(diff.map);
|
||||
const omitted = omittedScreenIds(diff.map, { diff, presentation });
|
||||
const presented = presentBuildDiff(diff, presentation);
|
||||
// The surfaces the Viewer leaves out, before path grouping: a removed screen goes back to its surface id.
|
||||
const removed = new Map(review.surfaces.map(surface => [removedScreenId(workspace.catalog.defaultBaselineBuildId, surface.id), surface.id]));
|
||||
const surfaces = new Set([...omittedSourceScreenIds(diff.map, diff)].map(id => removed.get(id) ?? id));
|
||||
return { diff, presentation, omitted, presented, shown: withoutOmittedScreens(presented, omitted), surfaces,
|
||||
graph: buildViewerGraph(presentation.map, presentation.index, omitted) };
|
||||
}
|
||||
|
||||
test("a public report's never-captured routes are not its screens anywhere; a captured screen and a local map keep theirs", () => {
|
||||
const review = verifyImages(fixture());
|
||||
// A new route named in exploration.exclude, and a route that was a redirect and is now a captured screen.
|
||||
review.surfaces.push({ id: "channel", status: "added", excluded: true, base: null, head: entry("channel", "/c/[channel]") });
|
||||
const nowCaptured = review.surfaces.find(surface => surface.id === "games-pro");
|
||||
nowCaptured.status = "modified";
|
||||
nowCaptured.base = entry("games-pro", "/games", "pro", { kind: "redirect", redirectTo: "/games" });
|
||||
delete nowCaptured.baseImage; delete nowCaptured.baseOutcome;
|
||||
const { presentation, presented, omitted, shown, graph } = viewerOmission(review);
|
||||
assert.equal(presented.screens.get("channel").status, "added", "the comparison alone would count it as a change");
|
||||
|
||||
assert.deepEqual([...omitted].sort(), ["channel", "home"], "the excluded route and the redirect; the route captured now stays");
|
||||
assert.deepEqual(reportScreens(presentation.map.screens, omitted).map(screen => screen.id).sort(),
|
||||
graph.screens.map(screen => screen.id).sort(), "Screens lists what the Map draws");
|
||||
assert.deepEqual(buildSearchItems({ screens: reportScreens(presentation.map.screens, omitted) }).filter(item => omitted.has(item.screenId)), []);
|
||||
|
||||
assert.deepEqual([...shown.screens.keys()].filter(id => omitted.has(id)), []);
|
||||
assert.equal(shown.counts.added, presented.counts.added - 1);
|
||||
assert.equal(shown.counts["not-compared"], presented.counts["not-compared"] - 1);
|
||||
assert.equal(Object.values(shown.counts).reduce((sum, count) => sum + count, 0), shown.screens.size);
|
||||
assert.ok(shown.index.screens.has("channel"), "a link to it still opens it");
|
||||
assert.equal(shown.index.screenNotes.get("channel"), "Excluded by exploration.exclude; never captured");
|
||||
|
||||
// A captured route whose excluded variant joins it on one card stays on the Map and in Screens.
|
||||
const variants = navigationReview();
|
||||
const pro = variants.surfaces.find(surface => surface.id === "games-pro");
|
||||
pro.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete pro[`${side}Image`]; delete pro[`${side}Outcome`]; }
|
||||
const { current } = workspaceSides(publicReviewToWorkspace(variants));
|
||||
const family = presentScreensByPath(current.map);
|
||||
const familyOmitted = omittedScreenIds(current.map, { presentation: family });
|
||||
const games = family.map.screens.find(screen => screen.route === "/games");
|
||||
assert.equal(games.variantIds.length, 2);
|
||||
assert.ok(reportScreens(family.map.screens, familyOmitted).includes(games));
|
||||
assert.ok(buildViewerGraph(family.map, family.index, familyOmitted).screens.includes(games));
|
||||
|
||||
// A local map with the same gaps lists every screen.
|
||||
const diff = diffFor(review);
|
||||
const local = { ...diff.map, run: { ...diff.map.run, id: "local-run" } };
|
||||
assert.equal(omittedScreenIds(local, { diff, presentation: presentScreensByPath(local) }).size, 0);
|
||||
});
|
||||
|
||||
test("an open capture gap keeps a screen that also has an accepted one, from the baseline or from a sibling", () => {
|
||||
// `/scan/camera` was a redirect and is now a screen whose capture failed: the comparison retargets the baseline's
|
||||
// accepted redirect gap onto it, beside the head's open failure.
|
||||
const redirected = verifyImages(fixture());
|
||||
const camera = redirected.surfaces.find(surface => surface.id === "camera-alias");
|
||||
camera.status = "modified";
|
||||
camera.base = entry("camera-alias", "/scan/camera?action=mood", "mood", { kind: "redirect", redirectTo: "/games" });
|
||||
delete camera.baseImage; delete camera.baseOutcome; delete camera.headImage;
|
||||
camera.headOutcome = { status: "failed", attempts: 2, landing: "unverified", reason: "timeout" };
|
||||
const baseline = viewerOmission(redirected);
|
||||
assert.deepEqual(baseline.diff.map.gaps.filter(gap => gap.screenId === "camera-alias").map(gap => gap.status).sort(), ["accepted", "open"]);
|
||||
assert.equal(baseline.omitted.has("camera-alias"), false);
|
||||
assert.equal(baseline.shown.screens.get("camera-alias").status, "unavailable");
|
||||
assert.equal(baseline.shown.counts.unavailable, 1, "the failed capture is still counted");
|
||||
assert.ok(baseline.graph.screens.some(screen => screen.id === "camera-alias"));
|
||||
assert.equal(neverCapturedSurfaceIds(redirected).has("camera-alias"), false);
|
||||
|
||||
// `/games` free's capture failed and `/games` pro is excluded: both gaps land on the one `/games` card.
|
||||
const sibling = verifyImages(fixture());
|
||||
const pro = sibling.surfaces.find(surface => surface.id === "games-pro");
|
||||
pro.excluded = true;
|
||||
for (const side of ["base", "head"]) { delete pro[`${side}Image`]; delete pro[`${side}Outcome`]; }
|
||||
const free = sibling.surfaces.find(surface => surface.id === "games-free");
|
||||
delete free.headImage;
|
||||
free.headOutcome = { status: "failed", attempts: 2, landing: "unverified", reason: "timeout" };
|
||||
const merged = viewerOmission(sibling);
|
||||
assert.equal(merged.omitted.has("games-free"), false);
|
||||
assert.equal(merged.shown.screens.get("games-free").status, "unavailable");
|
||||
assert.equal(merged.shown.counts.unavailable, 1);
|
||||
assert.ok(merged.surfaces.has("games-pro"), "the excluded variant itself is still never captured");
|
||||
assert.equal(merged.surfaces.has("games-free"), false);
|
||||
});
|
||||
|
||||
test("a removed screen keeps its card when the route that replaces it on the same path is a redirect or excluded", () => {
|
||||
for (const replacement of [
|
||||
{ kind: "redirect", entry: entry("sweet-bee-new", "/games/sweet-bee", "default", { kind: "redirect", redirectTo: "/games" }) },
|
||||
{ kind: "excluded", entry: entry("sweet-bee-new", "/games/sweet-bee"), excluded: true },
|
||||
]) {
|
||||
const review = verifyImages(fixture());
|
||||
review.surfaces.push({ id: "sweet-bee-new", status: "added", base: null, head: replacement.entry,
|
||||
...(replacement.excluded ? { excluded: true } : {}) });
|
||||
const { omitted, shown, graph, surfaces, presentation } = viewerOmission(review);
|
||||
const card = presentation.representativeIdByScreenId.get("sweet-bee-new");
|
||||
assert.equal(omitted.has(card), false, `${replacement.kind}: the removed screen's capture keeps the card`);
|
||||
assert.ok(shown.screens.get(card)?.beforeScreenshot, `${replacement.kind}: Compare and Changes keep the removed screenshot`);
|
||||
assert.ok(graph.screens.some(screen => screen.id === card));
|
||||
assert.ok(surfaces.has("sweet-bee-new"), `${replacement.kind}: the replacement on its own is never captured`);
|
||||
assert.equal(surfaces.has("sweet-bee"), false);
|
||||
assert.equal(reviewChanges(review).get("sweet-bee"), "removed", "the comment lists the removal the Viewer shows");
|
||||
}
|
||||
});
|
||||
|
||||
test("a captured screen that becomes a redirect keeps its card and its screenshot from before", () => {
|
||||
const review = verifyImages(fixture());
|
||||
const camera = review.surfaces.find(surface => surface.id === "camera-alias");
|
||||
camera.status = "modified";
|
||||
camera.head = entry("camera-alias", "/scan/camera?action=mood", "mood", { kind: "redirect", redirectTo: "/games" });
|
||||
delete camera.headImage; delete camera.headOutcome;
|
||||
const { omitted, shown, graph, surfaces } = viewerOmission(review);
|
||||
assert.equal(omitted.has("camera-alias"), false);
|
||||
assert.ok(shown.screens.get("camera-alias").beforeScreenshot);
|
||||
assert.ok(graph.screens.some(screen => screen.id === "camera-alias"));
|
||||
assert.equal(surfaces.has("camera-alias"), false);
|
||||
assert.equal(neverCapturedSurfaceIds(review).has("camera-alias"), false);
|
||||
});
|
||||
|
||||
test("the Viewer leaves out exactly the surfaces the PR comment skips", () => {
|
||||
const review = verifyImages(fixture());
|
||||
review.surfaces.push(
|
||||
{ id: "channel", status: "added", excluded: true, base: null, head: entry("channel", "/c/[channel]") },
|
||||
{ id: "old-start", status: "removed", base: entry("old-start", "/start", "default", { kind: "redirect", redirectTo: "/games" }), head: null },
|
||||
{ id: "sweet-bee-new", status: "added", base: null, head: entry("sweet-bee-new", "/games/sweet-bee", "default", { kind: "redirect", redirectTo: "/games" }) },
|
||||
);
|
||||
const camera = review.surfaces.find(surface => surface.id === "camera-alias");
|
||||
camera.head = entry("camera-alias", "/scan/camera?action=mood", "mood", { kind: "redirect", redirectTo: "/games" });
|
||||
camera.status = "modified";
|
||||
delete camera.headImage; delete camera.headOutcome;
|
||||
const skipped = neverCapturedSurfaceIds(review);
|
||||
assert.deepEqual([...skipped].sort(), ["channel", "home", "old-start", "sweet-bee-new"]);
|
||||
assert.deepEqual([...viewerOmission(review).surfaces].sort(), [...skipped].sort());
|
||||
const listed = reviewChanges(review);
|
||||
for (const id of skipped) assert.equal(listed.has(id), false, `${id} is not a listed change`);
|
||||
assert.equal(listed.get("care-guide"), "added");
|
||||
assert.equal(listed.get("sweet-bee"), "removed");
|
||||
|
||||
const changes = verifyImages(fixture("changes"));
|
||||
assert.deepEqual([...viewerOmission(changes).surfaces].sort(), [...neverCapturedSurfaceIds(changes)].sort());
|
||||
const navigated = navigationReview();
|
||||
assert.deepEqual([...viewerOmission(navigated).surfaces].sort(), [...neverCapturedSurfaceIds(navigated)].sort());
|
||||
assert.ok(neverCapturedSurfaceIds(navigated).size > 0);
|
||||
});
|
||||
+18
-5
@@ -73,6 +73,7 @@ import {
|
||||
isBlackBoxMap,
|
||||
} from "./utils/graph-model";
|
||||
import { buildSearchItems, suggestedSearchItems } from "./utils/search";
|
||||
import { omittedScreenIds, reportScreens, withoutOmittedScreens } from "./utils/omitted-screens";
|
||||
import {
|
||||
presentBuildDiff,
|
||||
presentScreensByPath,
|
||||
@@ -1198,11 +1199,18 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
() => (reviewedMap ? presentScreensByPath(reviewedMap) : undefined),
|
||||
[reviewedMap],
|
||||
);
|
||||
// A route the report never captured is not one of its screens, so the comparison names it nowhere (omitted-screens.ts).
|
||||
const omittedIds = useMemo(
|
||||
() => (reviewedMap && screenPresentation
|
||||
? omittedScreenIds(reviewedMap, { diff: sourceDiff, presentation: screenPresentation })
|
||||
: new Set<string>()),
|
||||
[reviewedMap, screenPresentation, sourceDiff],
|
||||
);
|
||||
const diff = useMemo(
|
||||
() => (sourceDiff && screenPresentation
|
||||
? presentBuildDiff(sourceDiff, screenPresentation)
|
||||
? withoutOmittedScreens(presentBuildDiff(sourceDiff, screenPresentation), omittedIds)
|
||||
: undefined),
|
||||
[screenPresentation, sourceDiff],
|
||||
[omittedIds, screenPresentation, sourceDiff],
|
||||
);
|
||||
// The Screens page says which screens changed in an appearance other than the one shown.
|
||||
const changedElsewhere = useMemo(() => {
|
||||
@@ -1222,7 +1230,9 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
comparison: filterComparisonAppearance(wholeComparison, otherScope),
|
||||
...(wholeReview ? { review: filterReviewAppearance(wholeReview, otherScope) } : {}),
|
||||
});
|
||||
const presented = presentBuildDiff(otherDiff, presentScreensByPath(otherDiff.map));
|
||||
const otherPresentation = presentScreensByPath(otherDiff.map);
|
||||
const presented = withoutOmittedScreens(presentBuildDiff(otherDiff, otherPresentation),
|
||||
omittedScreenIds(otherDiff.map, { diff: otherDiff, presentation: otherPresentation }));
|
||||
for (const [id, entry] of presented.screens) {
|
||||
if (["modified", "added", "removed"].includes(entry.status)) changed.set(id, [...(changed.get(id) ?? []), option]);
|
||||
}
|
||||
@@ -1260,9 +1270,10 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
: !baseline ? "This report has no baseline build to compare against."
|
||||
: !diff ? "The baseline is still loading."
|
||||
: "No screen looks different from the baseline.";
|
||||
// Search finds the report's screens, as Screens lists them; a link to one it never captured still opens it.
|
||||
const searchIndex = useMemo(
|
||||
() => map ? buildSearchItems({ screens: map.screens }) : [],
|
||||
[map],
|
||||
() => map ? buildSearchItems({ screens: reportScreens(map.screens, omittedIds) }) : [],
|
||||
[map, omittedIds],
|
||||
);
|
||||
const openChangedScreen = useCallback((screenId: string) => {
|
||||
const current = routeRef.current;
|
||||
@@ -1634,6 +1645,7 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
index={index}
|
||||
diff={diff}
|
||||
routeFiles={routeFiles}
|
||||
omittedScreenIds={omittedIds}
|
||||
changedElsewhere={changedElsewhere}
|
||||
selectedScreenId={selectedScreenId}
|
||||
{...(focusRequest ? { focusRequest } : {})}
|
||||
@@ -1686,6 +1698,7 @@ const ViewerApp = memo(function ViewerApp({ reportKey }: { reportKey: number })
|
||||
direction="TB"
|
||||
focus={focusFilter}
|
||||
projectionFitKey={mapProjectionFitKey}
|
||||
omittedScreenIds={omittedIds}
|
||||
{...(diff ? { diff } : {})}
|
||||
{...(selectedScreenId ? { selectedScreenId } : {})}
|
||||
{...(focusRequest ? { focusRequest } : {})}
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
import type { ExploreMap } from "../../utils/model";
|
||||
|
||||
/**
|
||||
* The Map and Screens with no screen to show. A run that observed none says what stopped it; a public report whose routes
|
||||
* were all deliberately left uncaptured (omitted-screens.ts) says so, rather than showing an empty page.
|
||||
*/
|
||||
export function NoScreens(props: { map: ExploreMap }) {
|
||||
const recorded = props.map.screens.length > 0;
|
||||
const blockers = props.map.gaps.filter((gap) => gap.status === "open" && !gap.screenId).map((gap) => gap.message);
|
||||
return (
|
||||
<div className="graph-canvas canvas-empty">
|
||||
<div className="page-empty compact-empty map-empty" role="status">
|
||||
<h2>{recorded ? "No screens were captured" : "No screens were recorded"}</h2>
|
||||
{recorded
|
||||
? <p>Every route in this report is a redirect, is named in exploration.exclude, or is outside what the change reaches.</p>
|
||||
: blockers.length > 0
|
||||
? blockers.map((message) => <p key={message}>{message}</p>)
|
||||
: <p>The run ended before any screen of the app was observed.</p>}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -12,7 +12,9 @@ import { shortcutsLive } from "../../utils/shortcuts";
|
||||
import { normalizeSearchText } from "../../utils/search";
|
||||
import { createKeyHold } from "../../utils/key-hold";
|
||||
import { placeholderScreen } from "../../utils/map-frame";
|
||||
import { reportScreens } from "../../utils/omitted-screens";
|
||||
import { ScreenScreenshotCard } from "../canvas/screen-screenshot-card";
|
||||
import { NoScreens } from "../shared/no-screens";
|
||||
import { useCanvasVisibleFrame } from "../canvas/visible-frame-provider";
|
||||
import { PhoneSheet } from "../phone/phone-chrome";
|
||||
import { PanelSearch } from "../shared/panel-search";
|
||||
@@ -33,6 +35,8 @@ export type ScreensViewProps = {
|
||||
/** The other appearances each screen changed in, when the report captured several. */
|
||||
changedElsewhere?: ReadonlyMap<string, Appearance[]> | undefined;
|
||||
selectedScreenId?: string | undefined;
|
||||
/** The routes a public report never captured: not listed, counted or found, as on the Map (omitted-screens.ts). */
|
||||
omittedScreenIds?: ReadonlySet<string> | undefined;
|
||||
/** A request (search, the Changes menu) to bring a screen into view; a new key asks again for the same screen. */
|
||||
focusRequest?: FocusRequest | undefined;
|
||||
/** The Changes menu's status filter: screens outside it are dimmed, as on the Map. */
|
||||
@@ -269,19 +273,21 @@ function Legend(props: { others: Appearance[] }) {
|
||||
* phone, a section per route folder (or per tab, when there are no route files), with the tree behind a Tree button.
|
||||
*/
|
||||
export function ScreensView(props: ScreensViewProps) {
|
||||
// The report's screens, as the Map draws them: a public report's routes it never captured are not among them.
|
||||
const screens = useMemo(() => reportScreens(props.map.screens, props.omittedScreenIds ?? new Set()), [props.map.screens, props.omittedScreenIds]);
|
||||
const tree: ScreenTree = useMemo(
|
||||
() => screenTree(props.map.screens, props.index, props.routeFiles),
|
||||
[props.index, props.map.screens, props.routeFiles],
|
||||
() => screenTree(screens, props.index, props.routeFiles),
|
||||
[props.index, screens, props.routeFiles],
|
||||
);
|
||||
const typicalSize = useMemo(
|
||||
() => typicalScreenshotSize(props.map.screens.map(screen => screenshotSize(primaryScreenshotForScreen(screen, props.index)))),
|
||||
[props.index, props.map.screens],
|
||||
() => typicalScreenshotSize(screens.map(screen => screenshotSize(primaryScreenshotForScreen(screen, props.index)))),
|
||||
[props.index, screens],
|
||||
);
|
||||
const changedIds = useMemo(
|
||||
() => new Set(props.map.screens
|
||||
() => new Set(screens
|
||||
.filter(screen => isChanged(props.diff, screen.id) || (props.changedElsewhere?.get(screen.id)?.length ?? 0) > 0)
|
||||
.map(screen => screen.id)),
|
||||
[props.changedElsewhere, props.diff, props.map.screens],
|
||||
[props.changedElsewhere, props.diff, screens],
|
||||
);
|
||||
const [filter, setFilter] = useState<Filter>(props.phone && changedIds.size > 0 ? "changed" : "all");
|
||||
const [treeOpen, setTreeOpen] = useState(false);
|
||||
@@ -290,9 +296,9 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
const [query, setQuery] = useState("");
|
||||
// The phone layout has no field to show or clear a query, so a query typed on desktop does not narrow it.
|
||||
const findQuery = findOpen && !props.phone ? query : "";
|
||||
const matches = useMemo(() => findMatches(props.map.screens, props.index, findQuery), [props.index, props.map.screens, findQuery]);
|
||||
const matches = useMemo(() => findMatches(screens, props.index, findQuery), [props.index, screens, findQuery]);
|
||||
const inChanged = filter === "changed" && changedIds.size > 0;
|
||||
const inFilter = inChanged ? changedIds : new Set(props.map.screens.map(screen => screen.id));
|
||||
const inFilter = inChanged ? changedIds : new Set(screens.map(screen => screen.id));
|
||||
const shown = matches ? new Set([...inFilter].filter(id => matches.has(id))) : inFilter;
|
||||
const sections = tree.sections
|
||||
.map(section => ({ ...section, screenIds: section.screenIds.filter(id => shown.has(id)) }))
|
||||
@@ -406,7 +412,7 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
setFilter(value);
|
||||
}}>
|
||||
{value === "changed" ? "Changed" : "All"}
|
||||
<span className="screens-chip-count">{value === "changed" ? changedIds.size : props.map.screens.length}</span>
|
||||
<span className="screens-chip-count">{value === "changed" ? changedIds.size : screens.length}</span>
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
@@ -563,6 +569,8 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
? ({ "--screens-right-inset": `calc(100% - ${visibleFrame.x + visibleFrame.width}px)` } as CSSProperties)
|
||||
: undefined;
|
||||
|
||||
if (screens.length === 0) return <NoScreens map={props.map} />;
|
||||
|
||||
const cell = (id: string) => {
|
||||
const screen = props.index.screens.get(id);
|
||||
return screen ? (
|
||||
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
} from "../canvas/stage";
|
||||
import type { ProjectionMotionMetadata } from "../canvas/projection-motion";
|
||||
import { ScreenScreenshotCard } from "../canvas/screen-screenshot-card";
|
||||
import { NoScreens } from "../shared/no-screens";
|
||||
import { TransitionEdge, type TransitionGraphEdge } from "../canvas/transition-edge";
|
||||
import {
|
||||
buildViewerGraph,
|
||||
@@ -480,7 +481,11 @@ type BaseCanvasProps = {
|
||||
onSelectScreen: (id: string, options?: { replace?: boolean }) => void;
|
||||
onClearSelection?: () => void;
|
||||
};
|
||||
export type MapViewProps = BaseCanvasProps & { projectionFitKey?: number };
|
||||
export type MapViewProps = BaseCanvasProps & {
|
||||
projectionFitKey?: number;
|
||||
/** The routes a public report never captured: not drawn (omitted-screens.ts). */
|
||||
omittedScreenIds?: ReadonlySet<string> | undefined;
|
||||
};
|
||||
|
||||
function ConnectionCanvas(props: MapViewProps) {
|
||||
const surfaceRef = useRef<HTMLDivElement>(null);
|
||||
@@ -493,7 +498,10 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
});
|
||||
const previousLayout = useRef<{ nodes: CanvasGraphNode[]; edges: TransitionGraphEdge[] } | undefined>(undefined);
|
||||
|
||||
const observedGraph = useMemo(() => buildViewerGraph(props.map, props.index), [props.index, props.map]);
|
||||
const observedGraph = useMemo(
|
||||
() => buildViewerGraph(props.map, props.index, props.omittedScreenIds),
|
||||
[props.index, props.map, props.omittedScreenIds],
|
||||
);
|
||||
const projection = useMemo(() => projectFullGraph(observedGraph), [observedGraph]);
|
||||
const structure = useMemo(
|
||||
() => projectedStructure(projection, props.index, isBlackBoxMap(props.map)),
|
||||
@@ -657,19 +665,7 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
.sort((left, right) => left.depth - right.depth || left.y - right.y || left.x - right.x || left.index - right.index)
|
||||
.map(({ id }) => id), [layout.nodes]);
|
||||
const phone = usePhoneLayout();
|
||||
if (props.map.screens.length === 0) {
|
||||
const blockers = props.map.gaps.filter((gap) => gap.status === "open" && !gap.screenId).map((gap) => gap.message);
|
||||
return (
|
||||
<div className="graph-canvas canvas-empty">
|
||||
<div className="page-empty compact-empty map-empty">
|
||||
<h2>No screens were recorded</h2>
|
||||
{blockers.length > 0
|
||||
? blockers.map((message) => <p key={message}>{message}</p>)
|
||||
: <p>The run ended before any screen of the app was observed.</p>}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
if (observedGraph.screens.length === 0) return <NoScreens map={props.map} />;
|
||||
return (
|
||||
<div ref={surfaceRef} className="connection-canvas-surface map-surface">
|
||||
<CanvasStage
|
||||
|
||||
@@ -24,7 +24,7 @@ export function reportContractGap(gap: ReviewContractGap): void {
|
||||
console.warn(`Explore report: ${where} failed the review contract (${gap.message}); ${gap.dropped} omitted.`);
|
||||
}
|
||||
import { sourceImpactSentences } from "../../../src/contracts/source-change";
|
||||
import { navigationCaptureContext } from "../../../src/contracts/navigation-graph";
|
||||
import { captureContext, captureGap, verifiedCapture } from "../../../src/contracts/surface-capture";
|
||||
import { projectSourceNavigation } from "../utils/source-navigation";
|
||||
|
||||
type Side = "base" | "head";
|
||||
@@ -89,12 +89,6 @@ function unattributedSummary(surface: Surface, side: Side): string {
|
||||
return "destination unverified";
|
||||
}
|
||||
|
||||
function verifiedCapture(surface: Surface, side: Side): boolean {
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
return Boolean(surface[side]?.kind === "screen" && imageFor(surface, side)
|
||||
&& outcome?.status === "captured" && outcome.landing === "verified");
|
||||
}
|
||||
|
||||
function comparisonReview(surface: Surface): Surface["review"] {
|
||||
if (surface.status === "added" || surface.status === "removed") {
|
||||
return surface.review?.status === surface.status ? surface.review : undefined;
|
||||
@@ -217,10 +211,7 @@ function sidePayload(review: PublicReview, side: Side): { map: ExploreMap; cover
|
||||
const id = routeOf(surface.id);
|
||||
if (!routes.has(id)) routes.set(id, { ...surface[side]!, id });
|
||||
}
|
||||
const selectedRoutes = navigation ? new Set(review.mode === "all" ? [...routes.keys()] : navigationCaptureContext(navigation,
|
||||
inventory.filter(surface => surface.status !== "unchanged").map(surface => routeOf(surface.id)),
|
||||
[...routes.values()])) : undefined;
|
||||
const selected = selectedRoutes ? new Set(inventory.filter(surface => selectedRoutes.has(routeOf(surface.id))).map(surface => surface.id)) : undefined;
|
||||
const selected = captureContext(review, side);
|
||||
// Planned structural groups describe the full inventory, including routes outside the
|
||||
// capture budget. Keep their placeholders available in every canvas.
|
||||
const declared = inventory;
|
||||
@@ -356,11 +347,11 @@ function sidePayload(review: PublicReview, side: Side): { map: ExploreMap; cover
|
||||
screenshotArtifactId: artifact.id,
|
||||
});
|
||||
}
|
||||
if (!verifiedCapture(surface, side)) {
|
||||
const outcome = side === "base" ? surface.baseOutcome : surface.headOutcome;
|
||||
// The gap's status is the one the PR comment reads too (surface-capture.ts), so both leave out the same routes.
|
||||
const gap = captureGap(review, surface, side, selected);
|
||||
if (gap) {
|
||||
const outsideCaptureContext = review.mode === "changes" && selected !== undefined && !selected.has(surface.id);
|
||||
const deliberatelyOmitted = !image && !outcome && (entry.kind === "redirect" || surface.excluded === true || outsideCaptureContext
|
||||
|| (!navigation && review.mode === "changes" && surface.status === "unchanged"));
|
||||
const deliberatelyOmitted = gap === "accepted";
|
||||
map.gaps.push({
|
||||
id: `capture:${side}:${surface.id}`,
|
||||
screenId: surface.id,
|
||||
|
||||
@@ -123,15 +123,16 @@ export function buildObservedGraph(map: ExploreMap, index: MapIndex): ObservedGr
|
||||
};
|
||||
}
|
||||
|
||||
/** The Viewer can overlay declarations; the observed graph and event indexes stay intact. */
|
||||
export function buildViewerGraph(map: ExploreMap, index: MapIndex): ObservedGraph {
|
||||
const NONE: ReadonlySet<string> = new Set();
|
||||
|
||||
/**
|
||||
* The Viewer can overlay declarations; the observed graph and event indexes stay intact. A public report preserves its
|
||||
* complete source inventory, but the routes it never captured are not its screens: `omitted` names them, the one set
|
||||
* every view of the report takes (omitted-screens.ts). The launch is never among them: it is where the app starts,
|
||||
* drawn above the start screens with a synthetic edge into each of them.
|
||||
*/
|
||||
export function buildViewerGraph(map: ExploreMap, index: MapIndex, omitted: ReadonlySet<string> = NONE): ObservedGraph {
|
||||
const observed = buildObservedGraph(map, index);
|
||||
// A public report preserves its complete source inventory, but an accepted capture gap
|
||||
// marks a redirect or a route outside changes-mode selection. Neither is a screen image. The app
|
||||
// launch is not a route, so its accepted "no splash observed" gap keeps it on the map: it is where
|
||||
// the app starts, drawn above the start screens with a synthetic edge into each of them.
|
||||
const omitted = new Set<string>();
|
||||
if (map.run.id.startsWith("public:")) for (const gap of map.gaps) if (gap.status === "accepted" && gap.screenId && !isLaunchScreen({ id: gap.screenId })) omitted.add(gap.screenId);
|
||||
const screens = observed.screens.filter(screen => !omitted.has(screen.id));
|
||||
const visibleIds = new Set(screens.map(screen => screen.id));
|
||||
const launchEdges = launchGroups(screens);
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
import type { BuildDiff, DiffStatus, ScreenDiff } from "./build-diff";
|
||||
import { isLaunchScreen, type ExploreMap, type Screen } from "./model";
|
||||
import type { ScreenPresentation } from "./screen-presentation";
|
||||
|
||||
const NONE: ReadonlySet<string> = new Set();
|
||||
|
||||
/**
|
||||
* The screens of a public report's map, before path grouping, that the run never captured on purpose: a redirect
|
||||
* declaration, a route named in `exploration.exclude`, or one outside the capture context in changes mode. Each has an
|
||||
* accepted capture gap, no open one, and no screenshot of its own on either side. A screenshot a redirect borrows from
|
||||
* the route it declares is not its own: build-diff names a side's own capture by its observation id. An open gap, such
|
||||
* as a failed capture, keeps the screen: its failure is part of the report. The app launch is not a route, and a local
|
||||
* map leaves nothing out.
|
||||
*
|
||||
* This is the map's view of `neverCapturedSurfaceIds` (src/contracts/surface-capture.ts), which the PR comment uses.
|
||||
*/
|
||||
export function omittedSourceScreenIds(
|
||||
source: Pick<ExploreMap, "run" | "gaps" | "screens">,
|
||||
diff?: Pick<BuildDiff, "screens">,
|
||||
): ReadonlySet<string> {
|
||||
if (!source.run.id.startsWith("public:")) return NONE;
|
||||
const accepted = new Set<string>();
|
||||
const open = new Set<string>();
|
||||
for (const gap of source.gaps) {
|
||||
if (gap.screenId && gap.status === "accepted") accepted.add(gap.screenId);
|
||||
if (gap.screenId && gap.status === "open") open.add(gap.screenId);
|
||||
}
|
||||
const omitted = new Set<string>();
|
||||
for (const screen of source.screens) {
|
||||
if (!accepted.has(screen.id) || open.has(screen.id) || isLaunchScreen(screen) || screen.observationIds.length > 0) continue;
|
||||
const compared = diff?.screens.get(screen.id);
|
||||
if (compared?.baselineObservationId || compared?.currentObservationId) continue;
|
||||
omitted.add(screen.id);
|
||||
}
|
||||
return omitted;
|
||||
}
|
||||
|
||||
/**
|
||||
* The screens none of the report's views list: the Map, Screens, search, Compare, the Changes list and their counts all
|
||||
* take this one set. With a path presentation, a card leaves only when every screen it stands for does, a removed one
|
||||
* included, so a card whose current route is a redirect still shows the screenshot of the screen it replaced. The map's
|
||||
* index keeps them all: a link to one opens it in the Inspector, which says why it has no screenshot.
|
||||
*/
|
||||
export function omittedScreenIds(
|
||||
source: Pick<ExploreMap, "run" | "gaps" | "screens">,
|
||||
options: { diff?: Pick<BuildDiff, "screens"> | undefined; presentation?: Pick<ScreenPresentation, "families"> | undefined } = {},
|
||||
): ReadonlySet<string> {
|
||||
const members = omittedSourceScreenIds(source, options.diff);
|
||||
if (!options.presentation || members.size === 0) return members;
|
||||
return new Set(options.presentation.families
|
||||
.filter((family) => family.members.every((member) => members.has(member.id)))
|
||||
.map((family) => family.representative.id));
|
||||
}
|
||||
|
||||
/** The report's screens: the map's screens but the omitted ones. */
|
||||
export function reportScreens<T extends Pick<Screen, "id">>(screens: readonly T[], omitted: ReadonlySet<string>): readonly T[] {
|
||||
return omitted.size ? screens.filter((screen) => !omitted.has(screen.id)) : screens;
|
||||
}
|
||||
|
||||
/**
|
||||
* The comparison without the omitted screens, so no count, Changes row, Compare step or Changed filter names a route
|
||||
* that was never captured. Its map and index keep them, for a link to one.
|
||||
*/
|
||||
export function withoutOmittedScreens(diff: BuildDiff, omitted: ReadonlySet<string>): BuildDiff {
|
||||
if (![...diff.screens.keys()].some((id) => omitted.has(id))) return diff;
|
||||
const screens = new Map<string, ScreenDiff>();
|
||||
const counts: Record<DiffStatus, number> = { ...diff.counts };
|
||||
for (const [id, screen] of diff.screens) {
|
||||
if (omitted.has(id)) counts[screen.status] -= 1;
|
||||
else screens.set(id, screen);
|
||||
}
|
||||
return { ...diff, screens, counts };
|
||||
}
|
||||
Reference in new issue
Block a user