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

Migrate ScoreCard.test.js from Enzyme to React Shallow Renderer #1653

Merged
merged 11 commits into from
Aug 12, 2023
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@
// limitations under the License.

import React from 'react';
import { shallow } from 'enzyme';

import ScoreCard from './ScoreCard';
import shallow from '../../utils/helpers/ReactShallowRenderer.js';

describe('ScoreCard', () => {
const link = 'test.link';
Expand Down
94 changes: 94 additions & 0 deletions packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// Copyright (c) 2023 The Jaeger Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
anshgoyalevil marked this conversation as resolved.
Show resolved Hide resolved

/* eslint-disable import/no-extraneous-dependencies */
import React from 'react';
import ShallowRenderer from 'react-test-renderer/shallow';
import { isFragment, isLazy, isPortal, isMemo, isSuspense, isForwardRef } from 'react-is';

const shallow = (element, options) => {
const localOptions = options === undefined ? {} : options;
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved
const Wrapper = localOptions.Wrapper || null;
const shallowRenderer = new ShallowRenderer();
const shallowWrapper = Wrapper
? shallowRenderer.render(<Wrapper>{element}</Wrapper>)

Check warning on line 25 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L25

Added line #L25 was not covered by tests
: shallowRenderer.render(element);

const getNodeName = node => {
return node.displayName || node.name || '';
};

const getWrappedName = (outerNode, innerNode, wrapperName) => {
const functionName = getNodeName(innerNode);
return (
outerNode.type.displayName || (functionName !== '' ? `${wrapperName}(${functionName})` : wrapperName)

Check warning on line 35 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L33-L35

Added lines #L33 - L35 were not covered by tests
);
};

const extractType = node => {
if (typeof node === 'string') return node;
const name = getNodeName(node.type) || node.type || 'Component';
if (isLazy(node)) {
return 'Lazy';

Check warning on line 43 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L43

Added line #L43 was not covered by tests
}

if (isMemo(node)) {
return `Memo(${name || extractType(node.type)})`;
}

if (isSuspense(node)) {
return 'Suspense';

Check warning on line 51 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L51

Added line #L51 was not covered by tests
}

if (isPortal(node)) {
return 'Portal';

Check warning on line 55 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L55

Added line #L55 was not covered by tests
}

if (isFragment(node)) {
return 'Fragment';

Check warning on line 59 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L59

Added line #L59 was not covered by tests
}
if (isForwardRef(node)) {
return getWrappedName(node, node.type.render, 'ForwardRef');

Check warning on line 62 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L62

Added line #L62 was not covered by tests
}
return name;
};

const transformNode = current => {
const extractProps = ({ children, ...props }, key) => {
const childrenArray = Array.isArray(children) ? children : [children];
return {
children: childrenArray.filter(Boolean).map(transformNode),
props: {
...props,
...(key ? { key } : {}),
},
};
};
if (Array.isArray(current)) {
return current.map(transformNode);

Check warning on line 79 in packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js

View check run for this annotation

Codecov / codecov/patch

packages/jaeger-ui/src/utils/helpers/ReactShallowRenderer.js#L79

Added line #L79 was not covered by tests
}
if (typeof current !== 'object') {
return current;
}
return {
$$typeof: Symbol.for('react.test.json'),
type: extractType(current),
...extractProps(current.props, current.key),
};
};

return transformNode(shallowWrapper);
};

export default shallow;