fix(attachments): Resolve static-component-definitions in screenshot viewers#120043
Open
sentry[bot] wants to merge 1 commit into
Open
fix(attachments): Resolve static-component-definitions in screenshot viewers#120043sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
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-definitionslinting error (CODING-CONVENTIONS-366) found instatic/app/components/events/eventTagsAndScreenshot/screenshot/modal.tsxandstatic/app/components/events/eventTagsAndScreenshot/screenshot/index.tsx.Root Cause:
The issue stemmed from dynamically determining a React component type (
AttachmentComponent) during the render cycle usinggetImageAttachmentRenderer(). This violates React's rule that component types used in JSX must be stable references at module scope, leading to unnecessary unmounting/remounting and blocking React Compiler optimizations.Solution:
To resolve this, a new module-scoped component,
ScreenshotAttachmentViewer, was introduced instatic/app/components/events/attachmentViewers/previewAttachmentTypes.tsx. This component now encapsulates the logic for conditionally rendering eitherImageViewerorVideoViewerbased on the attachment's mimetype, using static JSX branches.Changes Made:
static/app/components/events/attachmentViewers/previewAttachmentTypes.tsx: AddedScreenshotAttachmentViewerwhich takesViewerPropsand renders the appropriate viewer (VideoViewerfor webm,ImageViewerotherwise) using static conditional logic.static/app/components/events/eventTagsAndScreenshot/screenshot/modal.tsx: Replaced the dynamicAttachmentComponentvariable and its usage with the new, stableScreenshotAttachmentViewercomponent.static/app/components/events/eventTagsAndScreenshot/screenshot/index.tsx: Applied the same fix, replacing the dynamicAttachmentComponentwithScreenshotAttachmentViewer.This ensures that the component type remains stable across renders, satisfying the
static-component-definitionsrule and allowing for better React performance and optimization.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-366
Comment
@sentry <feedback>on this PR to have Autofix iterate on the changes.