Serialize scroll location #1965
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ninadbstack
reviewed
Aug 22, 2025
packages/dom/src/clone-dom.js
Outdated
|
|
||
| // We apply any element transformations here to avoid another treeWalk | ||
| applyElementTransformations(clone); | ||
| applyElementTransformations(clone, node); |
There was a problem hiding this comment.
change the order of params, it should be node, clone
There was a problem hiding this comment.
did the change
ninadbstack
approved these changes
Aug 22, 2025
|
This change broke ~1/4 of our screenshots. I think it at least deserves being mentioned in the release notes (and I'd argue it should not have been released as a patch version as well). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preserve scroll location during DOM serialization
Problem
We currently don't preserve scroll positions when serializing DOM elements. This can lead to visual differences when capturing screenshots, as elements that were scrolled in the original page appear at their default scroll position (top/left) in the serialized version.
Solution
This PR introduces scroll state serialization functionality through the
serializeScrollStatefunction intransform-dom.js. The function:scrollTopandscrollLeftvalues from original DOM elementsdata-percy-scrolltopanddata-percy-scrollleftattributes on cloned elements