fix(useHoverOverlay): Prevent React 19 act() console.error in tests - #120676
Draft
sentry[bot] wants to merge 2 commits into
Draft
fix(useHoverOverlay): Prevent React 19 act() console.error in tests#120676sentry[bot] wants to merge 2 commits into
sentry[bot] wants to merge 2 commits into
Conversation
Member
|
duplicate of #120675 |
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
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 issue
JEST-2Y29manifested asError: Expected test not to call console.error(), specifically complaining about "An update to Tooltip inside a test was not wrapped in act(...)". This occurred because theuseHoverOverlayhook'ssetTriggerElementRefcallback directly calledsetTriggerElement(auseStatesetter) when the component was unmounted during test teardown. In React 19, state updates during unmount that happen outsideact()boundaries trigger aconsole.error, whichjest-fail-on-consolethen converts into a test failure.The solution refactors how the
triggerElementis managed:useRef,triggerElementRef, is introduced to store the DOM element directly within thesetTriggerElementRefcallback.useLayoutEffectis added to synchronize the value fromtriggerElementRef.currentto thetriggerElementstate. ThisuseLayoutEffectruns during React's commit phase, which is always within anact()boundary in tests, thus preventing theconsole.error.useLayoutEffectintentionally has no dependency array to ensure it runs after every render, allowing it to catch ref updates. An internal guard (if (triggerElement !== triggerElementRef.current)) prevents infinite loops, and aneslint-disable-next-linecomment is added to clarify this.This change ensures that state updates related to the trigger element only occur within
act()boundaries, resolving the test failures.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-2Y29
Comment
@sentry <feedback>on this PR to have Autofix iterate on the changes.