fix(replays): Guard against undefined frame.data in BreadcrumbWebVital - #124990
Open
sentry[bot] wants to merge 3 commits into
Open
sentry[bot] wants to merge 3 commits into
sentry[bot] wants to merge 3 commits 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 fixes a
TypeError: Cannot read properties of undefined (reading 'value')occurring in theBreadcrumbWebVitalcomponent.Root Cause:
The
BreadcrumbWebVitalcomponent attempts to accessframe.data.valuewithout ensuringframe.datais defined. WhileisWebVitalFramechecks the frame'sopproperty, it does not guarantee the presence of thedatafield. Older replay SDK versions (specifically < 8.22.0) can produce web-vital span frames where thedatafield is entirely absent, leading to a runtime error when these frames are processed.Fix:
Added a null guard (
if (!frame.data) return null;) instatic/app/components/replays/breadcrumbs/breadcrumbWebVital.tsximmediately after theisWebVitalFramecheck. This ensures that the component gracefully handles frames with missingdataby not rendering, preventing theTypeError.Test:
Added a new test file
static/app/components/replays/breadcrumbs/breadcrumbWebVital.spec.tsxwith two test cases:frame.dataisundefined(simulating the problematic legacy frames).frame.datais present.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-3B62
@sentry <feedback>: Autofix iterates on these changes@sentry stop iterating: Autofix stops iterating on this runThis PR was automatically generated by Sentry. You can adjust this setting at any time.