Skip to content

test: use forceCloseAllModals instead of closeCurrentModal #30211

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

Merged
florianduros merged 1 commit into from
Jun 26, 2025
Merged

test: use forceCloseAllModals instead of closeCurrentModal #30211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 2 additions & 26 deletions test/test-utils/utilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,35 +188,11 @@ export const waitEnoughCyclesForModal = async ({
};

/**
* A horrible hack necessary to make sure modals don't leak and pollute tests.
* `jest-matrix-react` automatic cleanup function does not pick up the async modal
* rendering and the modals don't unmount when the component unmounts. We should strive
* to fix this.
* Clears all modals that are currently open.
*/
export const clearAllModals = async (): Promise<void> => {
// Prevent modals from leaking and polluting other tests
let keepClosingModals = true;
while (keepClosingModals) {
keepClosingModals = await act(() => Modal.closeCurrentModal());

// Then wait for the screen to update (probably React rerender and async/await).
// Important for tests using Jest fake timers to not get into an infinite loop
// of removing the same modal because the promises don't flush otherwise.
//
// XXX: Maybe in the future with Jest 29.5.0+, we could use `runAllTimersAsync` instead.

// this is called in some places where timers are not faked
// which causes a lot of noise in the console
// to make a hack even hackier check if timers are faked using a weird trick from github
// then call the appropriate promise flusher
// https://github.com/facebook/jest/issues/10555#issuecomment-1136466942
const jestTimersFaked = setTimeout.name === "setTimeout";
if (jestTimersFaked) {
await flushPromisesWithFakeTimers();
} else {
await flushPromises();
}
}
act(() => Modal.forceCloseAllModals());
};

/** Install a stub object at `navigator.mediaDevices` */
Expand Down
4 changes: 2 additions & 2 deletions test/unit-tests/components/views/settings/AddRemoveThreepids-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ describe("AddRemoveThreepids", () => {
client = stubClient();
});

afterEach(() => {
afterEach(async () => {
jest.restoreAllMocks();
clearAllModals();
await clearAllModals();
cleanup();
});

Expand Down
8 changes: 4 additions & 4 deletions test/unit-tests/components/views/settings/__snapshots__/AddRemoveThreepids-test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ exports[`AddRemoveThreepids should render email addresses 1`] = `
>
<input
autocomplete="email"
id="mx_Field_14"
id="mx_Field_15"
label="Email Address"
placeholder="Email Address"
type="text"
value=""
/>
<label
for="mx_Field_14"
for="mx_Field_15"
>
Email Address
</label>
Expand Down Expand Up @@ -148,14 +148,14 @@ exports[`AddRemoveThreepids should render phone numbers 1`] = `
</span>
<input
autocomplete="tel-national"
id="mx_Field_15"
id="mx_Field_16"
label="Phone Number"
placeholder="Phone Number"
type="text"
value=""
/>
<label
for="mx_Field_15"
for="mx_Field_16"
>
Phone Number
</label>
Expand Down
Loading