Release notes
The happo npm package: the CLI and its Storybook, Cypress, Playwright, and Vitest integrations.
This release adds support for taking snapshots from Testing Library tests run under Vitest Browser Mode, along with smaller fixes.
happoVitestPlugin() and happoScreenshot() from happo/vitest and happo/vitest/browser to send snapshots from Testing Library tests, with support for targets, dynamic targets, snapshotStrategy, --skip, and autoApplyPseudoStateAttributes [by @trotzig in #308]autoApplyPseudoStateAttributes to true in the Vitest integration, matching the Cypress and Playwright integrations, so hover and focus attributes apply by default [by @lencioni in #763]write EPIPE errors to the error tracker and failing the exit code when whatever reads the CLI's stdout disconnects mid-run [by @lencioni in #748]<endpoint>/api-tokens instead of /settings [by @trotzig in #768]Breaking
This release turns on by default the checks that used to be opt-in, removes config options and CLI flags Happo no longer needs, fails on config options it doesn't recognize, and raises the minimum Node and Storybook versions. Expect the first run after upgrading to report diffs for examples with outlines or box shadows at their edges, and expect the projects that run for the same commit to post a single Happo status check. See the upgrade guide at https://docs.happo.io/docs/upgrading-to-v7 and the announcement at https://happo.io/blog/happo-v7.
blockApproval now turns on every condition, and a condition left out of a blockApproval object is on too; set one to false to allow approval despite it. A page that already scrolled sideways before the upgrade doesn't block [by @trotzig in #178]group to true, so the projects that run for the same commit combine into one job with a single Happo status check instead of a Happo (<project>) check each; require Happo in branch protection, or set group: false to keep a project's own job and check [by @trotzig in #178]includeOutlinesAndShadows to true, so screenshots grow to hold the outlines and outer box shadows at the edge of an example; expect a diff for each such example on the first run, or set it to false on a target to crop to the elements' boxes [by @trotzig in #178]detectHorizontalOverflow to true, so a page that starts to scroll sideways is a diff even when its pixels are the same; a page that already overflowed is flagged but doesn't become a diff, and false on a target turns the check off [by @trotzig in #178]deepCompare now compares with { compareThreshold: 0.002, diffAlgorithm: 'color-delta' }, which takes the place of a threshold set for the project on happo.io; set deepCompare: false to keep using the project's settings [by @trotzig in #178]allowedHostnames to an empty list, so a target blocks every external request unless the config names the hostnames it needs; ios-safari and ipad-safari targets are unaffected [by @trotzig in #178]integration.autoApplyPseudoStateAttributes to true for Cypress and Playwright; set it to false to manage the data-happo-* attributes yourself [by @trotzig in #178]target.chunks, useFullPageFallbackForTallScreenshots and githubApiUrl config options, and the --githubToken and --skippedExamples CLI flags; use --skip instead of --skippedExamples, and drop the rest [by @trotzig in #178]pages integration and Cypress and Playwright runs, which used to run as a single chunk [by @trotzig in #178]build() to return estimatedSnapsCount; it doesn't have to be exact [by @trotzig in #178]^22.18.0 || >=24.0.0, dropping Node 23, and the minimum Storybook version to v9, dropping the v8 addon [by @trotzig in #178]blockApproval.horizontalOverflow option, on by default, that blocks approval when a page starts to scroll sideways, whether an existing snapshot now overflows or a new one does; a page that already overflowed, or whose baseline was never measured, doesn't block [by @lencioni in #675]This release adds new ways to authenticate and link comparisons on GitLab CI, Bitbucket Pipelines, and GitHub Actions, and fixes screenshots being filed under temporary merge commits.
screenshotScale target option for ios-safari and ipad-safari targets, to take screenshots at 1x instead of the default 2x [by @lencioni in #399, #405]This release adds several opt-in capabilities for rendering and organizing Happo runs, including new config options and a CLI command.
includeOutlinesAndShadows target option that grows screenshot crops to include outlines and box shadows at the edge of an example [by @trotzig in #310]animate.scrollTimelines: 'seek' option to render scroll-driven animations instead of leaving them as stills--onlyBaseSha CLI flag so --only runs borrow unrendered stories from the exact commit the list was computed from, instead of the newest available reportgroup config option and a happo skip command to combine several Happo projects into one job and status check, and to post a passing status when a project's run is skipped