🐛 Serialize iframe document URLs #405
Merged
Conversation
This file contains 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
Robdel12
approved these changes
Jul 7, 2021
| @@ -22,6 +72,7 @@ export default function serializeFrames(dom, clone, { enableJavaScript }) { | |||
|
|
|||
| // recersively serialize contents | |||
| let serialized = serializeDOM({ | |||
| domTransformation: transformRelativeUrls, | |||
samarsault
pushed a commit
that referenced
this pull request
Mar 3, 2023
Bumps [@percy/sdk-utils](https://github.com/percy/cli/tree/HEAD/packages/sdk-utils) from 1.0.0-beta.65 to 1.0.0-beta.67. - [Release notes](https://github.com/percy/cli/releases) - [Commits](https://github.com/percy/cli/commits/v1.0.0-beta.67/packages/sdk-utils) --- updated-dependencies: - dependency-name: "@percy/sdk-utils" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.
What is this?
As per #396, when a same-origin frame is serialized, all of its content becomes relative to the frame parent, which can then result in invalid resource URLs. Like the issue suggests, we can transform the URLs within the frame document to be fully qualified URLs based on the frame document's URL.
During the recursive DOM serialization, we can provide a custom transform function to be applied to iframe documents after cloning but before the function returns a string. In this transformation we can then find all relevant elements to transform their respective URLs.
According to HTML 4/5 spec the
href,src,srcset,poster, andbackgroundattributes are attributes that may contain URIs (and that we care about transforming). Most attributes' property counterparts are already resolved, however that is not always the case (such asbackground). Thesrcsetproperty is also not resolved, and requires parsing to properly replace URLs within the list of image candidates.In addition to those attributes, CSS within
styleelements or inlinestyleattributes may also contain URLs using theurl()CSS function and therefore are also transformed.In adding a test, Karma complained about assets being missing. I found a workaround by setting a
proxyoption to a semi-valid URL so it doesn't proxy and doesn't log. If logs crop up in the future, we probably want to host a single fake asset to silence them.Fixes #396