fix(react): Hoist component resolution in OverrideOrDefault#120028
Open
sentry[bot] wants to merge 1 commit into
Open
fix(react): Hoist component resolution in OverrideOrDefault#120028sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
| function OverrideOrDefaultComponent(props: Props) { | ||
| if (!ResolvedComponent) { | ||
| return null; | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Bug: Calling OverrideOrDefault inside a render function creates a new component on every render, causing React to unmount and remount the component tree, losing all state.
Severity: HIGH
Suggested Fix
Move the invocations of OverrideOrDefault from within the component render bodies to the module scope. This ensures the component is created only once, maintaining a stable reference across renders and preserving its state.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: static/app/components/overrideOrDefault.tsx#L75
Potential issue: The `OverrideOrDefault` factory function is intended to be called once
at the module scope. However, it is being called inside the render function of React
components in files like `accountClose.tsx` and `cronsLandingPanel.tsx`. Because the
`defaultComponent` prop is a new inline function on each render, `OverrideOrDefault`
generates a new component type every time the parent re-renders. This causes React to
unmount and remount the entire component subtree, leading to the loss of all internal
state and breaking user interactions, such as with confirmation modals.
Also affects:
accountClose.tsx:137cronsLandingPanel.tsx:67
Did we get this right? 👍 / 👎 to inform future reviews.
Contributor
📊 Type Coverage Diff
🔍 1 new type safety issue introduced
This is informational only and does not block the PR. |
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.
This PR addresses the
static-component-definitionswarning instatic/app/components/overrideOrDefault.tsx.Problem:
The
OverrideOrDefaultComponentwas callinggetOverride(overrideName)?.() ?? getDefaultComponent()directly within its render function. WhendefaultComponentPromisewas provided,getDefaultComponent()would create a newReact.lazy()instance and an anonymous wrapper component on every render. This caused React to perceive a new component type on each re-render, leading to unnecessary unmounting/remounting of the component subtree, state resets, and preventing React Compiler optimizations.Solution:
The component resolution logic (both
getOverrideandgetDefaultComponentcalls) has been hoisted out of theOverrideOrDefaultComponent's render function and into the factory function scope ofOverrideOrDefault. Now, theResolvedComponentis determined only once whenOverrideOrDefaultis initially called. This ensures thatOverrideOrDefaultComponentalways renders a stable component type, resolving thestatic-component-definitionsviolation and allowing for proper React state management and compiler optimizations.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 CODING-CONVENTIONS-36Y
Comment
@sentry <feedback>on this PR to have Autofix iterate on the changes.