Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions tools/snapshot-tests/tests/basic-snapshots.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { type BrowserContext, expect, type Page, test } from "@playwright/test";
import { initialLocalStorage } from "./utils/add-notes-to-local-storage";
import { maskedPdfScreenshot } from "./utils/screenshot-opts";
import { waitForPdfReady } from "./utils/wait-for-pdf";

const port = process.env.PLAYWRIGHT_PORT || "5173";
Expand Down Expand Up @@ -40,7 +41,7 @@ test.describe
await page.goto(hostname, { waitUntil: "networkidle" });
await page.evaluate(() => document.fonts.ready);
await waitForPdfReady(page);
await expect(page).toHaveScreenshot("homepage-outline.png", { fullPage: true });
await expect(page).toHaveScreenshot("homepage-outline.png", maskedPdfScreenshot(page));
});

test.describe
Expand Down Expand Up @@ -113,14 +114,14 @@ test.describe
await page.locator('[data-testid="tab-content-search"]').waitFor({ state: "visible" });
}

await expect(page).toHaveScreenshot("search-initial.png", { fullPage: true });
await expect(page).toHaveScreenshot("search-initial.png", maskedPdfScreenshot(page));
const searchInput = page.locator('input[placeholder*="search"]');
await searchInput.first().fill("protocol");
await page.locator(".search-results:not(.search-loading)").waitFor({ state: "visible" });
await expect(page).toHaveScreenshot("search-with-query.png", { fullPage: true });
await expect(page).toHaveScreenshot("search-with-query.png", maskedPdfScreenshot(page));
await searchInput.first().fill("blockchain");
await page.locator(".search-results:not(.search-loading)").waitFor({ state: "visible" });
await expect(page).toHaveScreenshot("search-with-results.png", { fullPage: true });
await expect(page).toHaveScreenshot("search-with-results.png", maskedPdfScreenshot(page));
});
});
});
Expand All @@ -138,14 +139,14 @@ test.describe("Top Bar Tests", () => {
if ((await githubButton.count()) > 0) {
await githubButton.first().click();

await expect(page).toHaveScreenshot("topbar-github-expanded.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-github-expanded.png", maskedPdfScreenshot(page));

// Hover over dropdown options
const dropdownOptions = page.locator('[role="menuitem"], .dropdown-item, .github-menu-item');
if ((await dropdownOptions.count()) > 0) {
await dropdownOptions.first().hover();

await expect(page).toHaveScreenshot("topbar-github-option-hover.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-github-option-hover.png", maskedPdfScreenshot(page));
}
}
});
Expand All @@ -165,7 +166,7 @@ test.describe("Top Bar Tests", () => {
if ((await notesDropdown.count()) > 0) {
await notesDropdown.first().click();

await expect(page).toHaveScreenshot("topbar-notes-dropdown.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-notes-dropdown.png", maskedPdfScreenshot(page));
}
});

Expand All @@ -186,11 +187,11 @@ test.describe("Top Bar Tests", () => {
if ((await noteOptions.count()) > 0) {
await noteOptions.first().click();

await expect(page).toHaveScreenshot("topbar-notes-selected-on.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-notes-selected-on.png", maskedPdfScreenshot(page));

await noteOptions.first().click();

await expect(page).toHaveScreenshot("topbar-notes-selected-off.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-notes-selected-off.png", maskedPdfScreenshot(page));
}
}
});
Expand All @@ -204,10 +205,10 @@ test.describe("Top Bar Tests", () => {

const moreButton = page.locator('button:has-text("...")');
await moreButton.first().click();
await expect(page).toHaveScreenshot("topbar-more-clicked.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-more-clicked.png", maskedPdfScreenshot(page));
const settingsMenuItem = page.locator("role=menuitem", { hasText: "Settings" });
await settingsMenuItem.click();
await expect(page).toHaveScreenshot("topbar-more-settings-clicked.png", { fullPage: true });
await expect(page).toHaveScreenshot("topbar-more-settings-clicked.png", maskedPdfScreenshot(page));
});
});
});
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 6 additions & 7 deletions tools/snapshot-tests/tests/narrow-screen.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { expect, test } from "@playwright/test";
import { initialLocalStorage } from "./utils/add-notes-to-local-storage";
import { maskedPdfScreenshot } from "./utils/screenshot-opts";
import { waitForPdfReady } from "./utils/wait-for-pdf";

const port = process.env.PLAYWRIGHT_PORT || "5173";
Expand All @@ -21,8 +22,6 @@ function getCommonContext() {
};
}

const screenshotOpts = { fullPage: true };

test.describe("Narrow Screen - Bottom Drawer", () => {
test("narrow layout shows bottom drawer collapsed", async ({ browser }) => {
const context = await browser.newContext({
Expand All @@ -39,7 +38,7 @@ test.describe("Narrow Screen - Bottom Drawer", () => {
await expect(drawer).toBeVisible();
await expect(drawer).toHaveClass(/collapsed/);

await expect(page).toHaveScreenshot("narrow-layout-collapsed.png", screenshotOpts);
await expect(page).toHaveScreenshot("narrow-layout-collapsed.png", maskedPdfScreenshot(page));
});

test("bottom drawer expands on click", async ({ browser }) => {
Expand All @@ -59,7 +58,7 @@ test.describe("Narrow Screen - Bottom Drawer", () => {
const drawer = page.locator(".bottom-drawer");
await expect(drawer).toHaveClass(/expanded/);

await expect(page).toHaveScreenshot("narrow-layout-expanded.png", screenshotOpts);
await expect(page).toHaveScreenshot("narrow-layout-expanded.png", maskedPdfScreenshot(page));
});

test("bottom drawer collapses on second click", async ({ browser }) => {
Expand All @@ -83,7 +82,7 @@ test.describe("Narrow Screen - Bottom Drawer", () => {
await handle.click();
await expect(page.locator(".bottom-drawer")).toHaveClass(/collapsed/);

await expect(page).toHaveScreenshot("narrow-layout-re-collapsed.png", screenshotOpts);
await expect(page).toHaveScreenshot("narrow-layout-re-collapsed.png", maskedPdfScreenshot(page));
});

test("narrow layout does not show split tab", async ({ browser }) => {
Expand Down Expand Up @@ -122,7 +121,7 @@ test.describe("Narrow Screen - Bottom Drawer", () => {
const splitPane = page.locator(".split-pane-view");
await expect(splitPane).toHaveCount(0);

await expect(page).toHaveScreenshot("narrow-layout-ignores-split.png", screenshotOpts);
await expect(page).toHaveScreenshot("narrow-layout-ignores-split.png", maskedPdfScreenshot(page));
});
});

Expand All @@ -141,6 +140,6 @@ test.describe("Narrow Screen - Tablet", () => {
const drawer = page.locator(".bottom-drawer");
await expect(drawer).toBeVisible();

await expect(page).toHaveScreenshot("tablet-layout.png", screenshotOpts);
await expect(page).toHaveScreenshot("tablet-layout.png", maskedPdfScreenshot(page));
});
});
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 10 additions & 11 deletions tools/snapshot-tests/tests/split-screen.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { expect, test } from "@playwright/test";
import { initialLocalStorage } from "./utils/add-notes-to-local-storage";
import { maskedPdfScreenshot } from "./utils/screenshot-opts";
import { waitForPdfReady, waitForSplitPdfReady } from "./utils/wait-for-pdf";

const port = process.env.PLAYWRIGHT_PORT || "5173";
Expand All @@ -22,8 +23,6 @@ function getCommonContext() {
};
}

const screenshotOpts = { fullPage: true };

test.describe("Split Screen", () => {
test("sidebar shows split tab icon", async ({ browser }) => {
const context = await browser.newContext(getCommonContext());
Expand All @@ -36,7 +35,7 @@ test.describe("Split Screen", () => {
const splitTab = page.locator('[data-testid="tab-split"]');
await expect(splitTab).toBeVisible();

await expect(page).toHaveScreenshot("sidebar-with-split-tab.png", screenshotOpts);
await expect(page).toHaveScreenshot("sidebar-with-split-tab.png", maskedPdfScreenshot(page));
});

test("split view opens when clicking split tab", async ({ browser }) => {
Expand All @@ -52,7 +51,7 @@ test.describe("Split Screen", () => {
await page.locator(".split-pane-view").waitFor({ state: "visible", timeout: 5000 });
await waitForSplitPdfReady(page);

await expect(page).toHaveScreenshot("split-view-opened.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-view-opened.png", maskedPdfScreenshot(page));
});

test("split view opens via URL param", async ({ browser }) => {
Expand All @@ -65,7 +64,7 @@ test.describe("Split Screen", () => {
await page.locator(".split-pane-view").waitFor({ state: "visible", timeout: 5000 });
await waitForSplitPdfReady(page);

await expect(page).toHaveScreenshot("split-view-via-url.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-view-via-url.png", maskedPdfScreenshot(page));
});

test("split pane header - version dropdown", async ({ browser }) => {
Expand All @@ -82,7 +81,7 @@ test.describe("Split Screen", () => {
await versionButton.click({ force: true });
await page.locator('[role="menu"], [role="radiogroup"]').first().waitFor({ state: "visible", timeout: 5000 });

await expect(page).toHaveScreenshot("split-header-version-dropdown.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-header-version-dropdown.png", maskedPdfScreenshot(page));
});

test("split pane header - options menu", async ({ browser }) => {
Expand All @@ -99,7 +98,7 @@ test.describe("Split Screen", () => {
await optionsButton.click({ force: true });
await page.locator('[role="menu"]').waitFor({ state: "visible", timeout: 5000 });

await expect(page).toHaveScreenshot("split-header-options-menu.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-header-options-menu.png", maskedPdfScreenshot(page));
});

test("sidebar overlay in split mode", async ({ browser }) => {
Expand All @@ -116,7 +115,7 @@ test.describe("Split Screen", () => {
await sidebarButton.click({ force: true });
await page.locator(".sidebar-overlay-panel").waitFor({ state: "visible", timeout: 5000 });

await expect(page).toHaveScreenshot("split-sidebar-overlay.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-sidebar-overlay.png", maskedPdfScreenshot(page));
});

test("sidebar overlay closes on Escape", async ({ browser }) => {
Expand All @@ -136,7 +135,7 @@ test.describe("Split Screen", () => {
await page.keyboard.press("Escape");
await page.locator(".sidebar-overlay-panel").waitFor({ state: "hidden", timeout: 2500 });

await expect(page).toHaveScreenshot("split-sidebar-overlay-closed.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-sidebar-overlay-closed.png", maskedPdfScreenshot(page));
});

test("split view closes via options menu", async ({ browser }) => {
Expand All @@ -157,7 +156,7 @@ test.describe("Split Screen", () => {
await page.locator(".split-pane-view").waitFor({ state: "hidden", timeout: 2500 });
await page.locator(".gp-sidebar").waitFor({ state: "visible", timeout: 2500 });

await expect(page).toHaveScreenshot("split-view-closed.png", screenshotOpts);
await expect(page).toHaveScreenshot("split-view-closed.png", maskedPdfScreenshot(page));
});

test("split tab not visible in sidebar overlay", async ({ browser }) => {
Expand Down Expand Up @@ -196,6 +195,6 @@ test.describe("Version Compare", () => {
const compareSection = page.locator('text="Compare with..."');
await expect(compareSection).toBeVisible();

await expect(page).toHaveScreenshot("version-dropdown-with-compare.png", screenshotOpts);
await expect(page).toHaveScreenshot("version-dropdown-with-compare.png", maskedPdfScreenshot(page));
});
});
20 changes: 20 additions & 0 deletions tools/snapshot-tests/tests/utils/screenshot-opts.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import type { Page } from "@playwright/test";

/**
* Build `toHaveScreenshot` options that mask out the rendered PDF.
*
* The PDF.js canvas can render a few pixels off between otherwise identical
* runs. That shift is not a regression we care about in these layout/chrome
* snapshots, but it trips the pixel-diff threshold because shifted text
* changes a band of pixels around every glyph. Masking the PDF viewer(s) lets
* us keep a tight threshold on the surrounding UI while ignoring the
* inherently non-deterministic PDF region.
*
* The selector matches both the main viewer and any split-pane viewer.
*/
export function maskedPdfScreenshot(page: Page) {
return {
fullPage: true,
mask: [page.locator(".pdf-viewer-root")],
};
}