fix(jest): Update eventDisplay test for TanStack Query timing#114734
Merged
fix(jest): Update eventDisplay test for TanStack Query timing#114734
Conversation
github-actions
Bot
added
the
Scope: Frontend
ryan953
added
the
Trigger: getsentry tests
Contributor
📊 Type Coverage Diff✅ No new type safety issues introduced. Coverage: 93.40% |
JoshuaKGoldberg
approved these changes
May 4, 2026
cleptric
pushed a commit
that referenced
this pull request
May 5, 2026
The `eventDisplay.spec.tsx` test `renders an event with tags` was
failing with a `TestingLibraryElementError` because
`screen.findByText('mock-tag', {selector: 'div'})` timed out.
This issue stemmed from the upgrade to TanStack Query v5.96 (commit
`3561a70`), which introduced an extra microtask delay in query
resolution. The `EventTagsTree` component, used by `EventDisplay`,
renders a loading indicator while its `useDetailedProject` query is
pending.
Although the test already used `findByText`, the new async timing meant
the tag element was not consistently present in the DOM within the
default timeout. This PR wraps the assertion in `waitFor` to explicitly
wait for the DOM to update after the asynchronous project data has
loaded, aligning with the pattern used to address similar timing issues
across other tests during the TanStack Query upgrade.
<!--
Sentry employees and contractors can delete or ignore the following.
-->
### Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated
in the State of Delaware in 2015 as Functional Software, Inc. and is
gonna need some rights from me in order to utilize my contributions in
this here PR. So here's the deal: I retain all rights, title and
interest in and to my contributions, and by keeping this boilerplate
intact I confirm that Sentry can use, modify, copy, and redistribute my
contributions, under Sentry's choice of terms.
Fixes JEST-21HV
Co-authored-by: sentry[bot] <39604003+sentry[bot]@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
eventDisplay.spec.tsxtestrenders an event with tagswas failing with aTestingLibraryElementErrorbecausescreen.findByText('mock-tag', {selector: 'div'})timed out.This issue stemmed from the upgrade to TanStack Query v5.96 (commit
3561a70), which introduced an extra microtask delay in query resolution. TheEventTagsTreecomponent, used byEventDisplay, renders a loading indicator while itsuseDetailedProjectquery is pending.Although the test already used
findByText, the new async timing meant the tag element was not consistently present in the DOM within the default timeout. This PR wraps the assertion inwaitForto explicitly wait for the DOM to update after the asynchronous project data has loaded, aligning with the pattern used to address similar timing issues across other tests during the TanStack Query upgrade.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Fixes JEST-21HV