fix: handle non-http(s) URL schemes in DOM serialization #2095
+14
−0
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
- Modified rewriteLocalhostURL() to detect and rewrite non-http(s) schemes - URLs with schemes like chrome-error://, file://, data:, etc. are now rewritten to http://render.percy.local - Preserves pathname, search params, and hash when rewriting - Added comprehensive test coverage for new behavior - Fixes PER-6667: Snapshots failing when Confluence macros use chrome-error:// scheme
pranavz28
changed the title
Comment on lines
+48
to
+53
| let parsedURL = new URL(url); | ||
|
|
||
| // check if URL has chrome-error scheme and rewrite to a non-existent URL that will 404 | ||
| if (parsedURL.protocol === 'chrome-error:') { | ||
| url = 'http://we-got-a-chrome-error-url-handled-gracefully.com/' + parsedURL.host + parsedURL.pathname + parsedURL.search + parsedURL.hash; | ||
| } |
Contributor
There was a problem hiding this comment.
Instead of CLI we should bypass the check in API?, in case any future changes or request comes we will be able to support from API itself without any new release?
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.
Problem
Customers migrating from Confluence Server to Cloud with broken macros were unable to take snapshots with Percy. When Confluence pages contain broken macros, Confluence adds
chrome-error://chromewebdata/URIs to the DOM. Percy's DOM serialization creates__serialized__resource URLs using the page's base URL (document.URL), and if that base URL uses a non-http(s) scheme, the generated resource URLs inherit that scheme (e.g.,chrome-error://chromewebdata/__serialized__/uid.png). Percy's upload validation rejects non-http(s) schemes, causing snapshot upload failures.Jira Ticket: PER-6667
Solution
Modified
rewriteLocalhostURL()in@percy/domto detect and rewrite URLs with non-http(s) schemes tohttp://render.percy.local. The function now:http:orhttps:This ensures that serialized resources always use valid http(s) schemes, regardless of the page's base URL scheme.
Changes
Modified:
packages/dom/src/utils.jsrewriteLocalhostURL()to handle non-http(s) schemesModified:
packages/dom/test/utils.test.jschrome-error://schemesTesting
Impact
@percy/dom)