Skip to content

fix: merge .percy.yml config options into serializeDOM #754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rishigupta1599 wants to merge 6 commits into
base: master
Choose a base branch
from
Open

fix: merge .percy.yml config options into serializeDOM #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
13465ff
fix: merge .percy.yml config options with snapshot options for serial…
rishigupta1599 May 5, 2026
ca9b0cb
refactor: use utils.mergeSnapshotOptions() from @percy/sdk-utils
rishigupta1599 May 5, 2026
639b9ec
chore: bump @percy deps to ^1.32.0 (published mergeSnapshotOptions); …
rishigupta1599 Jun 17, 2026
5818def
build: pin transitive deps to keep Node 14 CI green
rishigupta1599 Jun 19, 2026
db7dae6
build: restore yarn.lock (was wrongly deleted) + regenerate with pins
rishigupta1599 Jul 10, 2026
b04524e
build: pin event-loop-spinner to 2.3.2 to keep Node 14 CI green
rishigupta1599 Jul 10, 2026
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
3 changes: 2 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,13 @@ module.exports = function percySnapshot(name, options) {
await nEval(new Function(await utils.fetchPercyDOM()));

// Serialize and capture the DOM
const mergedOptions = utils.mergeSnapshotOptions(options);

@rishigupta1599 rishigupta1599 Jun 16, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Medium] mergeSnapshotOptions requires a newer @percy/sdk-utils than the pinned range

utils.mergeSnapshotOptions was only added to @percy/sdk-utils in 1.32.0-beta.9, but package.json pins @percy/sdk-utils: ^1.0.0. An environment resolving an older 1.x sdk-utils satisfies the range yet lacks this export, so this line throws TypeError: utils.mergeSnapshotOptions is not a function and the snapshot is silently swallowed by the surrounding catch.

Suggestion: Bump the minimum @percy/sdk-utils to the version that ships mergeSnapshotOptions (e.g. ^1.32.0), or guard the call: const mergedOptions = utils.mergeSnapshotOptions?.(options) ?? options;

Reviewer: stack:code-review

/* istanbul ignore next: no instrumenting injected code */
let { domSnapshot, url } = await nEval(options => ({
/* eslint-disable-next-line no-undef */
domSnapshot: PercyDOM.serialize(options),
url: document.URL
}), options);
}), mergedOptions);

@Shivanshu-07 Shivanshu-07 Jun 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No test coverage for this? is it covered in the existing UTs?


// Post the DOM to the snapshot endpoint with snapshot options and other info
await utils.postSnapshot({
Expand Down
9 changes: 7 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,18 @@
"test:types": "tsd"
},
"dependencies": {
"@percy/sdk-utils": "^1.0.0"
"@percy/sdk-utils": "^1.32.0"
},
"resolutions": {
"node-releases": "2.0.19",
"snyk-nodejs-lockfile-parser": "1.59.0",
"event-loop-spinner": "2.3.2"
},
"peerDependencies": {
"nightmare": "~3"
},
"devDependencies": {
"@percy/core": "^1.0.0",
"@percy/core": "^1.32.0",
"@types/nightmare": "^2.10.4",
"cross-env": "^7.0.2",
"eslint": "^7.11.0",
Expand Down
Loading
Loading