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.

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

use react-is in pretty-format #8060

Merged
merged 10 commits into from Mar 7, 2019
1 change: 1 addition & 0 deletions CHANGELOG.md
Expand Up @@ -94,6 +94,7 @@
- `[jest]`: Migrate to TypeScript ([#8024](https://github.com/facebook/jest/pull/8024))
- `[docs]` Update automock configuration, add note related to manual mocks ([#8051](https://github.com/facebook/jest/pull/8051))
- `[@jest/test-result]`: Extract TestResult types and helpers into a new separate package ([#8034](https://github.com/facebook/jest/pull/8034))
- `[pretty-format]`: Use `react-is` instead of manual `$$typeof` checks ([#8060](https://github.com/facebook/jest/pull/8060))

### Performance

Expand Down
4 changes: 3 additions & 1 deletion packages/pretty-format/package.json
Expand Up @@ -15,12 +15,14 @@
"dependencies": {
"@jest/types": "^24.1.0",
"ansi-regex": "^4.0.0",
"ansi-styles": "^3.2.0"
"ansi-styles": "^3.2.0",
"react-is": "^16.8.4"
},
"devDependencies": {
"@types/ansi-regex": "^4.0.0",
"@types/ansi-styles": "^3.2.1",
"@types/react": "*",
"@types/react-is": "^16.7.1",
"@types/react-test-renderer": "*",
"immutable": "4.0.0-rc.9",
"react": "*",
Expand Down
21 changes: 8 additions & 13 deletions packages/pretty-format/src/plugins/ReactElement.ts
Expand Up @@ -5,6 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/

import * as ReactIs from 'react-is';
import {Config, NewPlugin, Printer, Refs} from '../types';

import {
Expand All @@ -14,13 +15,6 @@ import {
printProps,
} from './lib/markup';

const elementSymbol = Symbol.for('react.element');
const fragmentSymbol = Symbol.for('react.fragment');
const forwardRefSymbol = Symbol.for('react.forward_ref');
const providerSymbol = Symbol.for('react.provider');
const contextSymbol = Symbol.for('react.context');
const memoSymbol = Symbol.for('react.memo');

// Given element.props.children, or subtree during recursive traversal,
// return flattened array of children.
const getChildren = (arg: Array<any>, children = []) => {
Expand All @@ -42,27 +36,28 @@ const getType = (element: any) => {
if (typeof type === 'function') {
return type.displayName || type.name || 'Unknown';
}
if (type === fragmentSymbol) {

if (ReactIs.isFragment(element)) {
return 'React.Fragment';
}
if (typeof type === 'object' && type !== null) {
if (type.$$typeof === providerSymbol) {
if (ReactIs.isContextProvider(element)) {
return 'Context.Provider';
}

if (type.$$typeof === contextSymbol) {
if (ReactIs.isContextConsumer(element)) {
return 'Context.Consumer';
}

if (type.$$typeof === forwardRefSymbol) {
if (ReactIs.isForwardRef(element)) {
const functionName = type.render.displayName || type.render.name || '';

return functionName !== ''
? 'ForwardRef(' + functionName + ')'
: 'ForwardRef';
}

if (type.$$typeof === memoSymbol) {
if (ReactIs.isMemo(type)) {
const functionName = type.type.displayName || type.type.name || '';

return functionName !== '' ? 'Memo(' + functionName + ')' : 'Memo';
Expand Down Expand Up @@ -112,7 +107,7 @@ export const serialize = (
indentation,
);

export const test = (val: any) => val && val.$$typeof === elementSymbol;
export const test = (val: any) => val && ReactIs.isElement(val);

const plugin: NewPlugin = {serialize, test};

Expand Down