mirror of
https://github.com/PostHog/posthog.git
synced 2024-11-24 18:07:17 +01:00
273 lines
11 KiB
TypeScript
273 lines
11 KiB
TypeScript
import { toMatchImageSnapshot } from 'jest-image-snapshot'
|
||
import { getStoryContext, TestRunnerConfig, TestContext } from '@storybook/test-runner'
|
||
import type { Locator, Page, LocatorScreenshotOptions } from '@playwright/test'
|
||
import type { Mocks } from '~/mocks/utils'
|
||
import { StoryContext } from '@storybook/csf'
|
||
|
||
const DEFAULT_VIEWPORT = { width: 1280, height: 720 }
|
||
|
||
// 'firefox' is technically supported too, but as of June 2023 it has memory usage issues that make is unusable
|
||
type SupportedBrowserName = 'chromium' | 'webkit'
|
||
type SnapshotTheme = 'light' | 'dark'
|
||
|
||
// Extend Storybook interface `Parameters` with Chromatic parameters
|
||
declare module '@storybook/types' {
|
||
interface Parameters {
|
||
options?: any
|
||
/** @default 'padded' */
|
||
layout?: 'padded' | 'fullscreen' | 'centered'
|
||
testOptions?: {
|
||
/**
|
||
* Whether we should wait for all loading indicators to disappear before taking a snapshot.
|
||
* @default true
|
||
*/
|
||
waitForLoadersToDisappear?: boolean
|
||
/** If set, we'll wait for the given selector (or all selectors, if multiple) to be satisfied. */
|
||
waitForSelector?: string | string[]
|
||
/**
|
||
* Whether navigation should be included in the snapshot. Only applies to `layout: 'fullscreen'` stories.
|
||
* @default false
|
||
*/
|
||
includeNavigationInSnapshot?: boolean
|
||
/**
|
||
* The test will always run for all the browers, but snapshots are only taken in Chromium by default.
|
||
* Override this to take snapshots in other browsers too.
|
||
*
|
||
* @default ['chromium']
|
||
*/
|
||
snapshotBrowsers?: SupportedBrowserName[]
|
||
/** If taking a component snapshot, you can narrow it down by specifying the selector. */
|
||
snapshotTargetSelector?: string
|
||
/** specify an alternative viewport size */
|
||
viewport?: { width: number; height: number }
|
||
}
|
||
msw?: {
|
||
mocks?: Mocks
|
||
}
|
||
[name: string]: any
|
||
}
|
||
|
||
interface Globals {
|
||
theme: SnapshotTheme
|
||
}
|
||
}
|
||
|
||
const RETRY_TIMES = 2
|
||
const LOADER_SELECTORS = [
|
||
'.Spinner',
|
||
'.LemonSkeleton',
|
||
'.LemonTableLoader',
|
||
'.Toastify__toast',
|
||
'[aria-busy="true"]',
|
||
'.SessionRecordingPlayer--buffering',
|
||
'.Lettermark--unknown',
|
||
]
|
||
|
||
const customSnapshotsDir = `${process.cwd()}/frontend/__snapshots__`
|
||
|
||
const JEST_TIMEOUT_MS = 15000
|
||
const PLAYWRIGHT_TIMEOUT_MS = 10000 // Must be shorter than JEST_TIMEOUT_MS
|
||
|
||
const ATTEMPT_COUNT_PER_ID: Record<string, number> = {}
|
||
|
||
module.exports = {
|
||
setup() {
|
||
expect.extend({ toMatchImageSnapshot })
|
||
jest.retryTimes(RETRY_TIMES, { logErrorsBeforeRetry: true })
|
||
jest.setTimeout(JEST_TIMEOUT_MS)
|
||
},
|
||
async preVisit(page, context) {
|
||
const storyContext = await getStoryContext(page, context)
|
||
const viewport = storyContext.parameters?.testOptions?.viewport || DEFAULT_VIEWPORT
|
||
await page.setViewportSize(viewport)
|
||
},
|
||
async postVisit(page, context) {
|
||
ATTEMPT_COUNT_PER_ID[context.id] = (ATTEMPT_COUNT_PER_ID[context.id] || 0) + 1
|
||
const storyContext = await getStoryContext(page, context)
|
||
const viewport = storyContext.parameters?.testOptions?.viewport || DEFAULT_VIEWPORT
|
||
await page.evaluate(
|
||
([retry, id]) => console.log(`[${id}] Attempt ${retry}`),
|
||
[ATTEMPT_COUNT_PER_ID[context.id], context.id]
|
||
)
|
||
if (ATTEMPT_COUNT_PER_ID[context.id] > 1) {
|
||
// When retrying, resize the viewport and then resize again to default,
|
||
// just in case the retry is due to a useResizeObserver fail
|
||
await page.setViewportSize({ width: 1920, height: 1080 })
|
||
await page.setViewportSize(viewport)
|
||
}
|
||
const browserContext = page.context()
|
||
const { snapshotBrowsers = ['chromium'] } = storyContext.parameters?.testOptions ?? {}
|
||
|
||
browserContext.setDefaultTimeout(PLAYWRIGHT_TIMEOUT_MS)
|
||
const currentBrowser = browserContext.browser()!.browserType().name() as SupportedBrowserName
|
||
if (snapshotBrowsers.includes(currentBrowser)) {
|
||
await expectStoryToMatchSnapshot(page, context, storyContext, currentBrowser)
|
||
}
|
||
},
|
||
tags: {
|
||
skip: ['test-skip'], // NOTE: This is overridden by the CI action storybook-chromatic.yml to include browser specific skipping
|
||
},
|
||
} as TestRunnerConfig
|
||
|
||
async function expectStoryToMatchSnapshot(
|
||
page: Page,
|
||
context: TestContext,
|
||
storyContext: StoryContext,
|
||
browser: SupportedBrowserName
|
||
): Promise<void> {
|
||
const {
|
||
waitForLoadersToDisappear = true,
|
||
waitForSelector,
|
||
includeNavigationInSnapshot = false,
|
||
} = storyContext.parameters?.testOptions ?? {}
|
||
|
||
let check: (
|
||
page: Page,
|
||
context: TestContext,
|
||
browser: SupportedBrowserName,
|
||
theme: SnapshotTheme,
|
||
targetSelector?: string
|
||
) => Promise<void>
|
||
if (storyContext.parameters?.layout === 'fullscreen') {
|
||
if (includeNavigationInSnapshot) {
|
||
check = expectStoryToMatchViewportSnapshot
|
||
} else {
|
||
check = expectStoryToMatchSceneSnapshot
|
||
}
|
||
} else {
|
||
check = expectStoryToMatchComponentSnapshot
|
||
}
|
||
|
||
await waitForPageReady(page)
|
||
await page.evaluate((layout: string) => {
|
||
// Stop all animations for consistent snapshots, and adjust other styles
|
||
document.body.classList.add('storybook-test-runner')
|
||
document.body.classList.add(`storybook-test-runner--${layout}`)
|
||
}, storyContext.parameters?.layout || 'padded')
|
||
if (waitForLoadersToDisappear) {
|
||
// The timeout is reduced so that we never allow toasts – they usually signify something wrong
|
||
await page.waitForSelector(LOADER_SELECTORS.join(','), { state: 'detached', timeout: 3000 })
|
||
}
|
||
if (typeof waitForSelector === 'string') {
|
||
await page.waitForSelector(waitForSelector)
|
||
} else if (Array.isArray(waitForSelector)) {
|
||
await Promise.all(waitForSelector.map((selector) => page.waitForSelector(selector)))
|
||
}
|
||
|
||
// Snapshot light theme
|
||
await page.evaluate(() => {
|
||
document.body.setAttribute('theme', 'light')
|
||
})
|
||
|
||
await waitForPageReady(page)
|
||
await page.waitForFunction(() => Array.from(document.images).every((i: HTMLImageElement) => !!i.naturalWidth))
|
||
await page.waitForTimeout(2000)
|
||
|
||
await check(page, context, browser, 'light', storyContext.parameters?.testOptions?.snapshotTargetSelector)
|
||
|
||
// Snapshot dark theme
|
||
await page.evaluate(() => {
|
||
document.body.setAttribute('theme', 'dark')
|
||
})
|
||
|
||
await waitForPageReady(page)
|
||
await page.waitForFunction(() => Array.from(document.images).every((i: HTMLImageElement) => !!i.naturalWidth))
|
||
await page.waitForTimeout(100)
|
||
|
||
await check(page, context, browser, 'dark', storyContext.parameters?.testOptions?.snapshotTargetSelector)
|
||
}
|
||
|
||
async function expectStoryToMatchViewportSnapshot(
|
||
page: Page,
|
||
context: TestContext,
|
||
browser: SupportedBrowserName,
|
||
theme: SnapshotTheme
|
||
): Promise<void> {
|
||
await expectLocatorToMatchStorySnapshot(page, context, browser, theme)
|
||
}
|
||
|
||
async function expectStoryToMatchSceneSnapshot(
|
||
page: Page,
|
||
context: TestContext,
|
||
browser: SupportedBrowserName,
|
||
theme: SnapshotTheme
|
||
): Promise<void> {
|
||
// If the `main` element isn't present, let's use `body` - this is needed in logged-out screens.
|
||
// We use .last(), because the order of selector matches is based on the order of elements in the DOM,
|
||
// and not the order of the selectors in the query.
|
||
await expectLocatorToMatchStorySnapshot(page.locator('body, main').last(), context, browser, theme)
|
||
}
|
||
|
||
async function expectStoryToMatchComponentSnapshot(
|
||
page: Page,
|
||
context: TestContext,
|
||
browser: SupportedBrowserName,
|
||
theme: SnapshotTheme,
|
||
targetSelector: string = '#storybook-root'
|
||
): Promise<void> {
|
||
await page.evaluate(() => {
|
||
const rootEl = document.getElementById('storybook-root')
|
||
if (!rootEl) {
|
||
throw new Error('Could not find root element')
|
||
}
|
||
// If needed, expand the root element so that all popovers are visible in the screenshot
|
||
document.querySelectorAll('.Popover').forEach((popover) => {
|
||
const currentRootBoundingClientRect = rootEl.getBoundingClientRect()
|
||
const popoverBoundingClientRect = popover.getBoundingClientRect()
|
||
if (popoverBoundingClientRect.right > currentRootBoundingClientRect.right) {
|
||
rootEl.style.width = `${popoverBoundingClientRect.right}px`
|
||
}
|
||
if (popoverBoundingClientRect.bottom > currentRootBoundingClientRect.bottom) {
|
||
rootEl.style.height = `${popoverBoundingClientRect.bottom}px`
|
||
}
|
||
if (popoverBoundingClientRect.top < currentRootBoundingClientRect.top) {
|
||
rootEl.style.height = `${-popoverBoundingClientRect.top + currentRootBoundingClientRect.bottom}px`
|
||
}
|
||
if (popoverBoundingClientRect.left < currentRootBoundingClientRect.left) {
|
||
rootEl.style.width = `${-popoverBoundingClientRect.left + currentRootBoundingClientRect.right}px`
|
||
}
|
||
})
|
||
})
|
||
|
||
await expectLocatorToMatchStorySnapshot(page.locator(targetSelector), context, browser, theme, {
|
||
omitBackground: true,
|
||
})
|
||
}
|
||
|
||
async function expectLocatorToMatchStorySnapshot(
|
||
locator: Locator | Page,
|
||
context: TestContext,
|
||
browser: SupportedBrowserName,
|
||
theme: SnapshotTheme,
|
||
options?: LocatorScreenshotOptions
|
||
): Promise<void> {
|
||
const image = await locator.screenshot({ ...options })
|
||
let customSnapshotIdentifier = `${context.id}--${theme}`
|
||
if (browser !== 'chromium') {
|
||
customSnapshotIdentifier += `--${browser}`
|
||
}
|
||
expect(image).toMatchImageSnapshot({
|
||
customSnapshotsDir,
|
||
customSnapshotIdentifier,
|
||
// Compare structural similarity instead of raw pixels - reducing false positives
|
||
// See https://github.com/americanexpress/jest-image-snapshot#recommendations-when-using-ssim-comparison
|
||
comparisonMethod: 'ssim',
|
||
// 0.01 would be a 1% difference
|
||
failureThreshold: 0.01,
|
||
failureThresholdType: 'percent',
|
||
})
|
||
}
|
||
|
||
/**
|
||
* Just like the `waitForPageReady` helper offered by Playwright - except we only wait for `networkidle` in CI,
|
||
* as it doesn't work with local Storybook (the live reload feature keeps up a long-running request, so we aren't idle).
|
||
*/
|
||
async function waitForPageReady(page: Page): Promise<void> {
|
||
await page.waitForLoadState("domcontentloaded");
|
||
await page.waitForLoadState("load");
|
||
if (process.env.CI) {
|
||
await page.waitForLoadState("networkidle");
|
||
}
|
||
await page.evaluate(() => document.fonts.ready);
|
||
}
|