Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

Modify cloneNode to handle shadow dom. #1

Merged
merged 2 commits into from
Apr 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions packages/dom/src/serialize-dom.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import serializeCSSOM from './serialize-cssom';
import serializeCanvas from './serialize-canvas';
import serializeVideos from './serialize-video';

import { cloneNodeAndShadow, getOuterHTML } from './wc-clone';

// Returns a copy or new doctype for a document.
function doctype(dom) {
let { name = 'html', publicId = '', systemId = '' } = dom?.doctype ?? {};
Expand Down Expand Up @@ -32,7 +34,7 @@ export function serializeDOM(options) {

prepareDOM(dom);

let clone = dom.cloneNode(true);
let clone = cloneNodeAndShadow(dom);
serializeInputs(dom, clone);
serializeFrames(dom, clone, { enableJavaScript });
serializeVideos(dom, clone);
Expand All @@ -52,7 +54,7 @@ export function serializeDOM(options) {
}
}

return doctype(dom) + doc.outerHTML;
return doctype(dom) + getOuterHTML(doc);
}

export default serializeDOM;
68 changes: 68 additions & 0 deletions packages/dom/src/wc-clone.js
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 => {

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 ?

Copy link

@mmun mmun Apr 25, 2022

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...

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>`);
Copy link

Choose a reason for hiding this comment

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

I like this!

};


export { cloneNodeAndShadow, getOuterHTML }