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

[mui-utils][test] Remove usages of deprecated react-dom APIs #42780

Merged
merged 4 commits into from
Jul 1, 2024
Merged

[mui-utils][test] Remove usages of deprecated react-dom APIs #42780

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21d1ff5
Remove usages of deprecated react-dom APIs
aarongarciah Jun 28, 2024
f51b56d
Remove unnecessary comment
aarongarciah Jun 28, 2024
0925920
Simplify tests
aarongarciah Jul 1, 2024
303e01e
Move cloneElement
aarongarciah Jul 1, 2024
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
63 changes: 27 additions & 36 deletions packages/mui-utils/src/elementAcceptingRef/elementAcceptingRef.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
/* eslint-disable react/prefer-stateless-function */
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { expect } from 'chai';
import PropTypes from 'prop-types';
import { createRenderer, waitFor } from '@mui/internal-test-utils';
import elementAcceptingRef from './elementAcceptingRef';

describe('elementAcceptingRef', () => {
const { render } = createRenderer();

function checkPropType(element: any, required = false) {
PropTypes.checkPropTypes(
{ children: required ? elementAcceptingRef.isRequired : elementAcceptingRef },
Expand All @@ -20,94 +22,83 @@ describe('elementAcceptingRef', () => {
});

describe('acceptance when not required', () => {
let rootNode: HTMLElement;

function assertPass(element: any, { shouldMount = true } = {}) {
async function assertPass(element: any, { shouldMount = true } = {}) {
aarongarciah marked this conversation as resolved.
Show resolved Hide resolved
function testAct() {
checkPropType(element);
if (shouldMount) {
// TODO: replace with React 18 implementation after https://github.com/testing-library/react-testing-library/issues/1216 is closed.
aarongarciah marked this conversation as resolved.
Show resolved Hide resolved
// eslint-disable-next-line react/no-deprecated
ReactDOM.render(
render(
<React.Suspense fallback={<p />}>
{React.cloneElement(element, { ref: React.createRef() })}
</React.Suspense>,
rootNode,
);
}
}

expect(testAct).not.toErrorDev();
await waitFor(() => {
expect(testAct).not.toErrorDev();
});
}

before(() => {
rootNode = document.createElement('div');
});

afterEach(() => {
// eslint-disable-next-line react/no-deprecated
ReactDOM.unmountComponentAtNode(rootNode);
});

it('accepts nully values', () => {
assertPass(undefined, { shouldMount: false });
assertPass(null, { shouldMount: false });
it('accepts nully values', async () => {
await assertPass(undefined, { shouldMount: false });
await assertPass(null, { shouldMount: false });
});

it('accepts host components', () => {
assertPass(<div />);
it('accepts host components', async () => {
await assertPass(<div />);
});

it('class components', () => {
it('class components', async () => {
class Component extends React.Component {
render() {
return null;
}
}

assertPass(<Component />);
await assertPass(<Component />);
});

it('accepts pure class components', () => {
it('accepts pure class components', async () => {
class Component extends React.PureComponent {
render() {
return null;
}
}

assertPass(<Component />);
await assertPass(<Component />);
});

it('accepts forwardRef', () => {
it('accepts forwardRef', async () => {
const Component = React.forwardRef(() => null);

assertPass(<Component />);
await assertPass(<Component />);
});

it('accepts memo', () => {
it('accepts memo', async () => {
const Component = React.memo(React.forwardRef(() => null));

assertPass(<Component />);
await assertPass(<Component />);
});

it('accepts lazy', () => {
it('accepts lazy', async () => {
const Component = React.lazy(() =>
Promise.resolve({
default: React.forwardRef((props, ref) => <div {...props} ref={ref} />),
}),
);

assertPass(<Component />);
await assertPass(<Component />);
});

it('technically allows other exotics like strict mode', () => {
assertPass(<React.StrictMode />);
it('technically allows other exotics like strict mode', async () => {
await assertPass(<React.StrictMode />);
});

// undesired behavior
it('accepts Fragment', () => {
it('accepts Fragment', async () => {
// eslint-disable-next-line react/jsx-no-useless-fragment
assertPass(<React.Fragment />);
await assertPass(<React.Fragment />);
});
});

Expand Down
71 changes: 31 additions & 40 deletions packages/mui-utils/src/elementTypeAcceptingRef/elementTypeAcceptingRef.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
/* eslint-disable react/prefer-stateless-function */
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { expect } from 'chai';
import PropTypes from 'prop-types';
import { createRenderer, waitFor } from '@mui/internal-test-utils';
import elementTypeAcceptingRef from './elementTypeAcceptingRef';

describe('elementTypeAcceptingRef', () => {
const { render } = createRenderer();

function checkPropType(elementType: any) {
PropTypes.checkPropTypes(
{ component: elementTypeAcceptingRef },
Expand All @@ -20,97 +22,86 @@ describe('elementTypeAcceptingRef', () => {
});

describe('acceptance', () => {
let rootNode: HTMLElement;

function assertPass(Component: any, { failsOnMount = false, shouldMount = true } = {}) {
async function assertPass(Component: any, { failsOnMount = false, shouldMount = true } = {}) {
function testAct() {
checkPropType(Component);
if (shouldMount) {
// TODO: replace with React 18 implementation after https://github.com/testing-library/react-testing-library/issues/1216 is closed.
// eslint-disable-next-line react/no-deprecated
ReactDOM.render(
render(
<React.Suspense fallback={<p />}>
<Component ref={React.createRef()} />
</React.Suspense>,
rootNode,
);
}
}

if (failsOnMount) {
expect(testAct).toErrorDev('');
} else {
expect(testAct).not.toErrorDev();
}
await waitFor(() => {
if (failsOnMount) {
expect(testAct).toErrorDev('');
} else {
expect(testAct).not.toErrorDev();
}
});
}

before(() => {
rootNode = document.createElement('div');
});

afterEach(() => {
// eslint-disable-next-line react/no-deprecated
ReactDOM.unmountComponentAtNode(rootNode);
});

it('accepts nully values', () => {
assertPass(undefined, { shouldMount: false });
assertPass(null, { shouldMount: false });
it('accepts nully values', async () => {
await assertPass(undefined, { shouldMount: false });
await assertPass(null, { shouldMount: false });
});

it('accepts host components', () => {
assertPass('div');
it('accepts host components', async () => {
await assertPass('div');
});

it('class components', () => {
it('class components', async () => {
class Component extends React.Component {
render() {
return null;
}
}

assertPass(Component);
await assertPass(Component);
});

it('accepts pure class components', () => {
it('accepts pure class components', async () => {
class Component extends React.PureComponent {
render() {
return null;
}
}

assertPass(Component);
await assertPass(Component);
});

it('accepts forwardRef', () => {
it('accepts forwardRef', async () => {
const Component = React.forwardRef(() => null);

assertPass(Component);
await assertPass(Component);
});

it('accepts memo', () => {
it('accepts memo', async () => {
const Component = React.memo(React.forwardRef(() => null));

assertPass(Component);
await assertPass(Component);
});

it('accepts lazy', () => {
it('accepts lazy', async () => {
const Component = React.lazy(() =>
Promise.resolve({
default: React.forwardRef((props, ref) => <div ref={ref} {...props} />),
}),
);

assertPass(Component);
await assertPass(Component);
});

it('technically allows other exotics like strict mode', () => {
assertPass(React.StrictMode);
it('technically allows other exotics like strict mode', async () => {
await assertPass(React.StrictMode);
});

// undesired behavior
it('accepts Fragment', () => {
assertPass(React.Fragment, { failsOnMount: true });
it('accepts Fragment', async () => {
await assertPass(React.Fragment, { failsOnMount: true });
});
});

Expand Down