Fix flakey ProfileModal tests #6613
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The ProfileModal tests would sometimes fail with this error:
```
FAILED TESTS:
✖ "after each" hook for "shows modal on "openProfile" event"
Chrome Headless 129.0.0.0 (Linux x86_64)
Error: Failed to execute 'showModal' on 'HTMLDialogElement': The element is not in a Document.
```
The `HTMLDialogElement.showModal` call happens in an effect when the
`ModalDialog` component is rendered with the `isClosed` prop set to false. In
the ProfileModal tests, the component was rendered in a disconnected DOM node,
so this error should have happened on every run. However the
`emitter.publish("openProfile")` call which triggered this render was not
wrapped in `act` and so the effect which calls `showModal` was scheduled, but
often did not actually run before the component was unmounted in the `afterEach`
hook.
Fix the issue by:
- Wrapping all `emitter.publish("openProfile")` calls in `act`, so they
synchronously execute the effect.
- Rendering the `ProfileModal` component in a connected DOM container
which is removed after the test runs
- For consistency, update the `NotebookModal` tests to work in the same
way as the ProfileModal tests, with a single container element which
is removed at the end of the test
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6613 +/- ##
=======================================
Coverage 99.42% 99.42%
=======================================
Files 270 270
Lines 10175 10175
Branches 2419 2419
=======================================
Hits 10117 10117
Misses 58 58 ☔ View full report in Codecov by Sentry. |
acelaya
approved these changes
Oct 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The ProfileModal tests would sometimes fail with this error:
The
HTMLDialogElement.showModalcall happens in an effect when theModalDialogcomponent is rendered with theisClosedprop set to false. In the ProfileModal tests, the component was rendered in a disconnected DOM node, so this error should have happened on every run. However theemitter.publish("openProfile")call which triggered this render was not wrapped inactand so the effect which callsshowModalwas scheduled, but often did not actually run before the component was unmounted in theafterEachhook.Fix the issue by:
emitter.publish("openProfile")calls inact, so they synchronously execute the effect.ProfileModalcomponent in a connected DOM container which is removed after the test runs. This is what actually fixes the error shown above.NotebookModaltests to work in the same way as the ProfileModal tests, with a single container element which is removed at the end of the test