fix(inputgroup): Prevent infinite re-render loop in Leading/TrailingItems - #121043
Draft
sentry[bot] wants to merge 2 commits into
Draft
fix(inputgroup): Prevent infinite re-render loop in Leading/TrailingItems#121043sentry[bot] wants to merge 2 commits into
sentry[bot] wants to merge 2 commits into
Conversation
Contributor
Story previewsPreview the stories changed in this PR on the Vercel deployment: Preview deployment: https://sentry-dnj04fi4c.sentry.dev |
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.
Problem:
The
useLayoutEffectin these components includedchildrenin its dependency array. When the parentInputGroupre-rendered,childrenwould often receive a new object identity, even if its content was visually the same. This triggered theuseLayoutEffectto callsetLeadingWidthorsetTrailingWidth, which in turn caused the parentInputGroupto re-render, creating an infinite loop.Solution:
childrendependency withResizeObserver: TheuseLayoutEffectnow initializes aResizeObserverto monitor the actualoffsetWidthof theref.currentelement. This ensures that the effect only triggers when the physical dimensions of the leading/trailing items change, rather than when thechildrenprop's reference changes.entries[0]?.borderBoxSize[0]?.inlineSizeas it caused issues in JSDOM (Jest tests). Instead,el.offsetWidthis used directly within theResizeObservercallback, which is simpler and more robust across environments.ResizeObserveris disconnected when the component unmounts to prevent memory leaks.This change ensures that
setLeadingWidthandsetTrailingWidthare only called when truly necessary, resolving the infinite re-render loop.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 JAVASCRIPT-3AYS
Comment
@sentry <feedback>on this PR to have Autofix iterate on the changes.