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

Fix flaky unit test for the CMReleasesContainer component #20233

Closed
wants to merge 8 commits into from
Closed

Fix flaky unit test for the CMReleasesContainer component #20233

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
35fabe0
fix(chore): fix flaky test
simotae14 Apr 30, 2024
aefeb9f
fix(chore): skip unit test to find the failing one
simotae14 Apr 30, 2024
3dfbe14
fix(chore): remove skip to the second test
simotae14 Apr 30, 2024
bd9a1b6
fix(chore): enable test
simotae14 Apr 30, 2024
0abcfcf
fix(chore): remove skip to tests
simotae14 Apr 30, 2024
d175cab
fix(chore): use waitFor to fix flaky test
simotae14 Apr 30, 2024
3ed3ccf
fix(chore): remove comment
simotae14 Apr 30, 2024
8a26401
Merge branch 'v5/main' into fix/fe-flaky-unit-test
simotae14 Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/core/content-releases/admin/src/components/tests/CMReleasesContainer.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,10 @@ describe('CMReleasesContainer', () => {
it('should render the container', async () => {
render();

const informationBox = await screen.findByRole('complementary', { name: 'Releases' });
expect(informationBox).toBeInTheDocument();
await waitFor(async () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think findBy queries already use a waitFor https://testing-library.com/docs/dom-testing-library/api-async#findby-queries. I think what you end up doing here with an additional waitFor is increase the timeout / retries. But It looks like you can pass waitFor options to the findBy query to do that as well.

Copy link
Member

Choose a reason for hiding this comment

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

Mark is right, it'll also fail if it's not in the document. There's probably a different async fetch happening elsewhere that updates the component, you might needed to await something else.

const informationBox = await screen.findByRole('complementary', { name: 'Releases' });
expect(informationBox).toBeInTheDocument();
});

const addToReleaseButton = await screen.findByRole('button', { name: 'Add to release' });
expect(addToReleaseButton).toBeInTheDocument();
Expand Down