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

[test][material-ui] Remove unnecessary async act calls #42942

Merged
merged 4 commits into from
Jul 18, 2024
Merged

[test][material-ui] Remove unnecessary async act calls #42942

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
1e22be8
Remove unnecessary async act calls
aarongarciah Jul 15, 2024
360c097
More changes
aarongarciah Jul 15, 2024
3cc3c66
Undo unintended change
aarongarciah Jul 16, 2024
cb529fe
Remove unnecessary ESlint disable comment
aarongarciah Jul 16, 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
6 changes: 3 additions & 3 deletions packages/mui-joy/src/MenuItem/MenuItem.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ describe('Joy <MenuItem />', () => {
const handler = spy();
render(<MenuItem {...{ [handlerName]: handler }} />);

await act(async () => fireEvent[eventName](screen.getByRole('menuitem')));
fireEvent[eventName](screen.getByRole('menuitem'));

expect(handler.callCount).to.equal(1);
});
Expand Down Expand Up @@ -125,11 +125,11 @@ describe('Joy <MenuItem />', () => {

expect(handleFocus.callCount).to.equal(1);

await act(async () => fireEvent.keyDown(menuitem));
fireEvent.keyDown(menuitem);

expect(handleKeyDown.callCount).to.equal(1);

await act(async () => fireEvent.keyUp(menuitem));
fireEvent.keyUp(menuitem);

expect(handleKeyUp.callCount).to.equal(1);

Expand Down
88 changes: 46 additions & 42 deletions packages/mui-material/src/ButtonBase/ButtonBase.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,47 +202,47 @@ describe('<ButtonBase />', () => {
if (typeof Touch !== 'undefined') {
const touch = new Touch({ identifier: 0, target: button, clientX: 0, clientY: 0 });

await act(async () => fireEvent.touchStart(button, { touches: [touch] }));
fireEvent.touchStart(button, { touches: [touch] });
expect(onTouchStart.callCount).to.equal(1);

await act(async () => fireEvent.touchEnd(button, { touches: [touch] }));
fireEvent.touchEnd(button, { touches: [touch] });
expect(onTouchEnd.callCount).to.equal(1);
}

if (canFireDragEvents) {
await act(async () => fireEvent.dragEnd(button));
fireEvent.dragEnd(button);
expect(onDragEnd.callCount).to.equal(1);
}

await act(async () => fireEvent.mouseDown(button));
fireEvent.mouseDown(button);
expect(onMouseDown.callCount).to.equal(1);

await act(async () => fireEvent.mouseUp(button));
fireEvent.mouseUp(button);
expect(onMouseUp.callCount).to.equal(1);

await act(async () => fireEvent.contextMenu(button));
fireEvent.contextMenu(button);
expect(onContextMenu.callCount).to.equal(1);

await user.click(button);
expect(onClick.callCount).to.equal(1);

act(() => {
await act(async () => {
button.focus();
});
expect(onFocus.callCount).to.equal(1);

await act(async () => fireEvent.keyDown(button));
fireEvent.keyDown(button);
expect(onKeyDown.callCount).to.equal(1);

await act(async () => fireEvent.keyUp(button));
fireEvent.keyUp(button);
expect(onKeyUp.callCount).to.equal(1);

act(() => {
await act(async () => {
Copy link
Member Author

@aarongarciah aarongarciah Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Per React docs, act is meant to be awaited and the callback passed to it to be async:

We recommend using act with await and an async function. Although the sync version works in many cases, it doesn’t work in all cases and due to the way React schedules updates internally, it’s difficult to predict when you can use the sync version.

We will deprecate and remove the sync version in the future.

Source: https://react.dev/reference/react/act#await-act-async-actfn

Copy link
Member Author

Choose a reason for hiding this comment

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

We should probably create an ESLint rule for this in the future if there's no "official" one.

button.blur();
});
expect(onBlur.callCount).to.equal(1);

await act(async () => fireEvent.mouseLeave(button));
fireEvent.mouseLeave(button);
expect(onMouseLeave.callCount).to.equal(1);
});
});
Expand Down Expand Up @@ -942,9 +942,7 @@ describe('<ButtonBase />', () => {

await ripple.startFocus(button);

act(() => {
fireEvent.keyDown(button, { key: 'Enter' });
});
fireEvent.keyDown(button, { key: 'Enter' });

expect(container.querySelectorAll('.ripple-visible')).to.have.lengthOf(1);

Expand Down Expand Up @@ -1007,7 +1005,7 @@ describe('<ButtonBase />', () => {
});

describe('keyboard accessibility for non interactive elements', () => {
it('does not call onClick when a spacebar is pressed on the element but prevents the default', () => {
it('does not call onClick when a spacebar is pressed on the element but prevents the default', async () => {
const onKeyDown = spy();
const onClickSpy = spy();
const { getByRole } = render(
Expand All @@ -1017,19 +1015,20 @@ describe('<ButtonBase />', () => {
);
const button = getByRole('button');

act(() => {
await act(async () => {
button.focus();
fireEvent.keyDown(button, {
key: ' ',
});
});

fireEvent.keyDown(button, {
key: ' ',
});

expect(onClickSpy.callCount).to.equal(0);
expect(onKeyDown.callCount).to.equal(1);
expect(onKeyDown.firstCall.args[0]).to.have.property('defaultPrevented', true);
});

it('does call onClick when a spacebar is released on the element', () => {
it('does call onClick when a spacebar is released on the element', async () => {
const onClickSpy = spy();
const { getByRole } = render(
<ButtonBase onClick={onClickSpy} component="div">
Expand All @@ -1038,18 +1037,19 @@ describe('<ButtonBase />', () => {
);
const button = getByRole('button');

act(() => {
await act(async () => {
button.focus();
fireEvent.keyUp(button, {
key: ' ',
});
});

fireEvent.keyUp(button, {
key: ' ',
});

expect(onClickSpy.callCount).to.equal(1);
expect(onClickSpy.firstCall.args[0]).to.have.property('defaultPrevented', false);
});

it('does not call onClick when a spacebar is released and the default is prevented', () => {
it('does not call onClick when a spacebar is released and the default is prevented', async () => {
const onClickSpy = spy();
const { getByRole } = render(
<ButtonBase
Expand All @@ -1067,17 +1067,18 @@ describe('<ButtonBase />', () => {
);
const button = getByRole('button');

act(() => {
await act(async () => {
button.focus();
fireEvent.keyUp(button, {
key: ' ',
});
});

fireEvent.keyUp(button, {
key: ' ',
});

expect(onClickSpy.callCount).to.equal(0);
});

it('calls onClick when Enter is pressed on the element', () => {
it('calls onClick when Enter is pressed on the element', async () => {
const onClickSpy = spy();
const { getByRole } = render(
<ButtonBase onClick={onClickSpy} component="div">
Expand All @@ -1086,11 +1087,12 @@ describe('<ButtonBase />', () => {
);
const button = getByRole('button');

act(() => {
await act(async () => {
button.focus();
fireEvent.keyDown(button, {
key: 'Enter',
});
});

fireEvent.keyDown(button, {
key: 'Enter',
});

expect(onClickSpy.calledOnce).to.equal(true);
Expand Down Expand Up @@ -1131,7 +1133,7 @@ describe('<ButtonBase />', () => {
expect(onClickSpy.callCount).to.equal(0);
});

it('prevents default with an anchor and empty href', () => {
it('prevents default with an anchor and empty href', async () => {
const onClickSpy = spy();
const { getByRole } = render(
<ButtonBase component="a" onClick={onClickSpy}>
Expand All @@ -1140,16 +1142,17 @@ describe('<ButtonBase />', () => {
);
const button = getByRole('button');

act(() => {
await act(async () => {
button.focus();
fireEvent.keyDown(button, { key: 'Enter' });
});

fireEvent.keyDown(button, { key: 'Enter' });

expect(onClickSpy.calledOnce).to.equal(true);
expect(onClickSpy.firstCall.args[0]).to.have.property('defaultPrevented', true);
});

it('should ignore anchors with href', () => {
it('should ignore anchors with href', async () => {
const onClick = spy();
const onKeyDown = spy();
const { getByText } = render(
Expand All @@ -1159,11 +1162,12 @@ describe('<ButtonBase />', () => {
);
const button = getByText('Hello');

act(() => {
await act(async () => {
button.focus();
fireEvent.keyDown(button, {
key: 'Enter',
});
});

fireEvent.keyDown(button, {
key: 'Enter',
});

expect(onClick.callCount).to.equal(0);
Expand Down
3 changes: 2 additions & 1 deletion packages/mui-material/src/ListItemButton/ListItemButton.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,9 @@ describe('<ListItemButton />', () => {
);
const button = getByRole('button');

fireEvent.keyDown(document.activeElement || document.body, { key: 'Tab' });

act(() => {
fireEvent.keyDown(document.activeElement || document.body, { key: 'Tab' });
button.focus();
});

Expand Down
4 changes: 2 additions & 2 deletions packages/mui-material/src/MenuItem/MenuItem.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,11 @@ describe('<MenuItem />', () => {

expect(handleFocus.callCount).to.equal(1);

await act(async () => fireEvent.keyDown(menuitem));
fireEvent.keyDown(menuitem);

expect(handleKeyDown.callCount).to.equal(1);

await act(async () => fireEvent.keyUp(menuitem));
fireEvent.keyUp(menuitem);

expect(handleKeyUp.callCount).to.equal(1);

Expand Down
6 changes: 2 additions & 4 deletions packages/mui-material/src/Popper/Popper.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';
import { expect } from 'chai';
import { act, createRenderer, fireEvent, screen } from '@mui/internal-test-utils';
import { createRenderer, fireEvent, screen } from '@mui/internal-test-utils';
import { ThemeProvider } from '@mui/system';
import createTheme from '@mui/system/createTheme';
import Grow from '@mui/material/Grow';
Expand Down Expand Up @@ -114,9 +114,7 @@ describe('<Popper />', () => {
);
expect(screen.getByTestId('placement')).to.have.text('bottom');

await act(async () => {
await popperRef.current.setOptions({ placement: 'top' });
});
await popperRef.current.setOptions({ placement: 'top' });

expect(screen.getByTestId('placement')).to.have.text('bottom');
});
Expand Down
7 changes: 4 additions & 3 deletions packages/mui-material/src/Select/Select.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,15 @@ describe('<Select />', () => {
);
const trigger = getByRole('combobox');

await act(async () => fireEvent.mouseDown(trigger));
fireEvent.mouseDown(trigger);

expect(handleBlur.callCount).to.equal(0);
expect(getByRole('listbox')).not.to.equal(null);

const options = getAllByRole('option');
fireEvent.mouseDown(options[0]);

await act(async () => {
const options = getAllByRole('option');
fireEvent.mouseDown(options[0]);
options[0].click();
});

Expand Down
24 changes: 14 additions & 10 deletions packages/mui-material/src/SpeedDial/SpeedDial.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,15 @@ describe('<SpeedDial />', () => {
</SpeedDial>,
);
const buttonWrapper = getByRole('button', { expanded: true });

fireEvent.keyDown(document.body, { key: 'TAB' });

await act(async () => {
fireEvent.keyDown(document.body, { key: 'TAB' });
buttonWrapper.focus();
fireEvent.keyDown(buttonWrapper, { key: ' ' });
});

fireEvent.keyDown(buttonWrapper, { key: ' ' });

expect(handleKeyDown.callCount).to.equal(1);
expect(handleKeyDown.args[0][0]).to.have.property('key', ' ');
});
Expand Down Expand Up @@ -190,7 +194,7 @@ describe('<SpeedDial />', () => {
expect(handleOpen.callCount).to.equal(1);
const actions = getAllByRole('menuitem');
expect(actions.length).to.equal(2);
await act(async () => fireEvent.keyDown(fab, { key: 'ArrowUp' }));
fireEvent.keyDown(fab, { key: 'ArrowUp' });
expect(document.activeElement).to.equal(actions[0]);
expect(fab).to.have.attribute('aria-expanded', 'true');
});
Expand Down Expand Up @@ -218,11 +222,11 @@ describe('<SpeedDial />', () => {

expect(fab).to.have.attribute('aria-expanded', 'true');

await act(async () => fireEvent.keyDown(fab, { key: 'ArrowUp' }));
fireEvent.keyDown(fab, { key: 'ArrowUp' });
clock.runAll();
expect(queryByRole('tooltip')).not.to.equal(null);

await act(async () => fireDiscreteEvent.keyDown(actions[0], { key: 'Escape' }));
fireDiscreteEvent.keyDown(actions[0], { key: 'Escape' });
clock.runAll();

expect(queryByRole('tooltip')).to.equal(null);
Expand Down Expand Up @@ -312,13 +316,13 @@ describe('<SpeedDial />', () => {

it('considers arrow keys with the same initial orientation', async () => {
await renderSpeedDial();
await act(async () => fireEvent.keyDown(fabButton, { key: 'left' }));
fireEvent.keyDown(fabButton, { key: 'left' });
expect(isActionFocused(0)).to.equal(true);
await act(async () => fireEvent.keyDown(getActionButton(0), { key: 'up' }));
fireEvent.keyDown(getActionButton(0), { key: 'up' });
expect(isActionFocused(0)).to.equal(true);
await act(async () => fireEvent.keyDown(getActionButton(0), { key: 'left' }));
fireEvent.keyDown(getActionButton(0), { key: 'left' });
expect(isActionFocused(1)).to.equal(true);
await act(async () => fireEvent.keyDown(getActionButton(1), { key: 'right' }));
fireEvent.keyDown(getActionButton(1), { key: 'right' });
expect(isActionFocused(0)).to.equal(true);
});

Expand All @@ -333,7 +337,7 @@ describe('<SpeedDial />', () => {

await renderSpeedDial(dialDirection);

await act(async () => fireEvent.keyDown(fabButton, { key: firstKey }));
fireEvent.keyDown(fabButton, { key: firstKey });
expect(isActionFocused(firstFocusedAction)).to.equal(
true,
`focused action initial ${firstKey} should be ${firstFocusedAction}`,
Expand Down
Loading