Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

support serializing DocumentFragment #6705

Merged
merged 4 commits into from
Aug 8, 2018
Merged

support serializing DocumentFragment #6705

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa16957
support serializing `DocumentFragment`
SimenB Jul 17, 2018
592e402
rename to DocumentFragment
SimenB Jul 17, 2018
c24ece7
Merge branch 'master' into document-fragment
thymikee Aug 8, 2018
3d7c975
Merge branch 'master' into document-fragment
thymikee Aug 8, 2018
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## master

### Features

- `[pretty-format]` Support serializing `DocumentFragment` ([#6705](https://github.com/facebook/jest/pull/6705))

### Fixes

- `[babel-jest]` Make `getCacheKey()` take into account `createTransformer` options ([#6699](https://github.com/facebook/jest/pull/6699))
Expand Down
39 changes: 39 additions & 0 deletions packages/pretty-format/src/__tests__/dom_element.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,45 @@ Testing.`;
);
});

it('supports fragment node', () => {
const fragment = document.createDocumentFragment();
Copy link
Member Author

Choose a reason for hiding this comment

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

example from https://developer.mozilla.org/en-US/docs/Web/API/Document/createDocumentFragment

const browsers = [
'Firefox',
'Chrome',
'Opera',
'Safari',
'Internet Explorer',
];

browsers.forEach(browser => {
const li = document.createElement('li');
li.textContent = browser;
fragment.appendChild(li);
});

expect(fragment).toPrettyPrintTo(
[
'<DocumentFragment>',
' <li>',
' Firefox',
' </li>',
' <li>',
' Chrome',
' </li>',
' <li>',
' Opera',
' </li>',
' <li>',
' Safari',
' </li>',
' <li>',
' Internet Explorer',
' </li>',
'</DocumentFragment>',
].join('\n'),
);
});

describe('matches constructor name of SVG elements', () => {
// Too bad, so sad, element.constructor.name of SVG elements
// is HTMLUnknownElement in jsdom v9 and v10
Expand Down
22 changes: 16 additions & 6 deletions packages/pretty-format/src/plugins/dom_element.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,23 @@ type Comment = {
data: string,
nodeType: 8,
};
type DocumentFragment = {
children: Array<Element>,
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure how important typing this is? It's not an Array, it's an HTMLCollection, but the other typing here is pretty bad anyways

Copy link
Member Author

Choose a reason for hiding this comment

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

using the types from flow makes the other stuff fail here since we can't use instanceof checks and not explode outside of jsdom 🤷‍♂️

Copy link
Member Author

Choose a reason for hiding this comment

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

FWIW, flow passes with this diff

diff --git i/packages/pretty-format/src/plugins/dom_element.js w/packages/pretty-format/src/plugins/dom_element.js
index 26f0801f6..59957aa54 100644
--- i/packages/pretty-format/src/plugins/dom_element.js
+++ w/packages/pretty-format/src/plugins/dom_element.js
@@ -18,30 +18,6 @@ import {
   printText,
 } from './lib/markup';
 
-type Attribute = {
-  name: string,
-  value: string,
-};
-
-type Element = {
-  attributes: Array<Attribute>,
-  childNodes: Array<Element | Text | Comment>,
-  nodeType: 1,
-  tagName: string,
-};
-type Text = {
-  data: string,
-  nodeType: 3,
-};
-type Comment = {
-  data: string,
-  nodeType: 8,
-};
-type DocumentFragment = {
-  children: Array<Element>,
-  nodeType: 11,
-};
-
 const ELEMENT_NODE = 1;
 const TEXT_NODE = 3;
 const COMMENT_NODE = 8;
@@ -76,17 +52,17 @@ export const serialize = (
   refs: Refs,
   printer: Printer,
 ): string => {
-  if (node.nodeType === TEXT_NODE) {
+  if (node instanceof Text) {
     return printText(node.data, config);
   }
 
-  if (node.nodeType === COMMENT_NODE) {
+  if (node instanceof Comment) {
     return printComment(node.data, config);
   }
 
   let type;
 
-  if (node.nodeType === FRAGMENT_NODE) {
+  if (node instanceof DocumentFragment) {
     type = `Fragment`;
   } else {
     type = node.tagName.toLowerCase();

Copy link
Collaborator

Choose a reason for hiding this comment

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

nice, maybe it's worth to use those?

Copy link
Member Author

Choose a reason for hiding this comment

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

It only works with instanceof checks, which means it doesn't work in node, just jsdom

nodeType: 11,
};

const ELEMENT_NODE = 1;
const TEXT_NODE = 3;
const COMMENT_NODE = 8;
const FRAGMENT_NODE = 11;

const ELEMENT_REGEXP = /^((HTML|SVG)\w*)?Element$/;

const testNode = (nodeType: any, name: any) =>
(nodeType === ELEMENT_NODE && ELEMENT_REGEXP.test(name)) ||
(nodeType === TEXT_NODE && name === 'Text') ||
(nodeType === COMMENT_NODE && name === 'Comment');
(nodeType === COMMENT_NODE && name === 'Comment') ||
(nodeType === FRAGMENT_NODE && name === 'DocumentFragment');

export const test = (val: any) =>
val &&
Expand All @@ -63,7 +69,7 @@ const propsReducer = (props, attribute) => {
};

export const serialize = (
node: Element | Text | Comment,
node: Element | Text | Comment | DocumentFragment,
config: Config,
indentation: string,
depth: number,
Expand All @@ -78,24 +84,28 @@ export const serialize = (
return printComment(node.data, config);
}

const type = node.tagName.toLowerCase();
const type =
node.nodeType === FRAGMENT_NODE
? `DocumentFragment`
: node.tagName.toLowerCase();

if (++depth > config.maxDepth) {
return printElementAsLeaf(type, config);
}

return printElement(
type,
printProps(
Array.prototype.map.call(node.attributes, keysMapper).sort(),
Array.prototype.reduce.call(node.attributes, propsReducer, {}),
Array.prototype.map.call(node.attributes || [], keysMapper).sort(),
Array.prototype.reduce.call(node.attributes || [], propsReducer, {}),
config,
indentation + config.indent,
depth,
refs,
printer,
),
printChildren(
Array.prototype.slice.call(node.childNodes),
Array.prototype.slice.call(node.childNodes || node.children),
config,
indentation + config.indent,
depth,
Expand Down