fix(coding-conventions): Resolve static-component-definitions in progressActivityTooltip#120046
Open
sentry[bot] wants to merge 2 commits into
Open
fix(coding-conventions): Resolve static-component-definitions in progressActivityTooltip#120046sentry[bot] wants to merge 2 commits into
sentry[bot] wants to merge 2 commits into
Conversation
…ressActivityTooltip
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 a
static-component-definitionsviolation reported instatic/app/views/issueList/progressActivityTooltip.tsx.Problem:
The
ProgressActivityItemcomponent was dynamically creating a React component type (Icon) during its render cycle. Specifically, forGroupActivityType.NOTE, thecomponentFunctioningroupActivityIcons.tsxwas returning a new inline arrow function (() => <StyledUserAvatar />) on every render. React interprets this as a new component identity each time, leading to unnecessary unmounting and remounting of the icon subtree, which is flagged by the React Compiler'sStaticComponentsdiagnostic.Solution:
To resolve this, a new module-scoped functional component,
ActivityIcon, has been introduced inprogressActivityTooltip.tsx. ThisActivityIconcomponent now encapsulates the logic for determining and rendering the correct icon based on theitemandiconMappingprops. By makingActivityIcona stable, module-scoped component, React always sees the same component type, even though the content rendered insideActivityIconmight vary based on props. This ensures that the icon subtree maintains its state across renders and adheres to thestatic-component-definitionsconvention.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-36D
Comment
@sentry <feedback>on this PR to have Autofix iterate on the changes.