This repository has been archived by the owner on Jan 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Modify cloneNode to handle shadow dom. #1
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/** | ||
* Custom deep clone function that replaces Percy's current clone behavior. | ||
* This enables us to capture shadow DOM in snapshots. It takes advantage of `attachShadow`'s mode option set to open | ||
* https://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow#parameters | ||
*/ | ||
const deepClone = host => { | ||
let cloneNode = (node, parent) => { | ||
let walkTree = (nextn, nextp) => { | ||
while (nextn) { | ||
cloneNode(nextn, nextp); | ||
nextn = nextn.nextSibling; | ||
} | ||
}; | ||
|
||
let clone = node.cloneNode(); | ||
parent.appendChild(clone); | ||
|
||
if (node.shadowRoot) { | ||
if (clone.shadowRoot) { | ||
// it may be set up in a custom element's constructor | ||
clone.shadowRoot.innerHTML = ''; | ||
} else { | ||
clone.attachShadow({ | ||
mode: 'open' | ||
}); | ||
} | ||
|
||
for (let sheet of node.shadowRoot.adoptedStyleSheets) { | ||
let cssText = Array.from(sheet.rules).map(rule => rule.cssText).join('\n'); | ||
let style = document.createElement('style'); | ||
style.appendChild(document.createTextNode(cssText)); | ||
clone.shadowRoot.prepend(style); | ||
} | ||
} | ||
|
||
if (node.shadowRoot) { | ||
walkTree(node.shadowRoot.firstChild, clone.shadowRoot); | ||
} | ||
|
||
walkTree(node.firstChild, clone); | ||
}; | ||
|
||
let fragment = document.createDocumentFragment(); | ||
cloneNode(host, fragment); | ||
return fragment; | ||
}; | ||
|
||
|
||
/** | ||
* Deep clone a document while also preserving shadow roots and converting adoptedStylesheets to <style> tags. | ||
*/ | ||
const cloneNodeAndShadow = doc => { | ||
let clonedDocument = doc.cloneNode(true); | ||
clonedDocument.documentElement.replaceWith(deepClone(doc.documentElement)); | ||
return clonedDocument; | ||
}; | ||
|
||
/** | ||
* Use `getInnerHTML()` to serialize shadow dom as <template> tags. `innerHTML` and `outerHTML` don't do this. Buzzword: "declarative shadow dom" | ||
*/ | ||
const getOuterHTML = docElement => { | ||
let innerHTML = docElement.getInnerHTML(); | ||
docElement.textContent = ''; | ||
return docElement.outerHTML.replace('</html>', `${innerHTML}</html>`); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I like this! |
||
}; | ||
|
||
|
||
export { cloneNodeAndShadow, getOuterHTML } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how do we know this (not-trivial) walker works ?
do we need any tests ? or is this code copy-pasted from somewhere ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's copied from https://stackoverflow.com/a/55540552 and modified a bit. I don't think this fork is really set up to run tests.
I'd like to see the code tidied up and tested but yeah...