feat(react): Track duration of React component updates #5531
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
AbhiPrasad
reviewed
Aug 5, 2022
There was a problem hiding this comment.
It looks like we probably don't need to update docs! https://github.com/getsentry/sentry-docs/blob/master/src/platforms/javascript/guides/react/components/profiler.mdx
|
Perfect! 😄 |
AbhiPrasad
approved these changes
Aug 8, 2022
AbhiPrasad
reviewed
Aug 8, 2022
| @@ -34,6 +34,7 @@ class Profiler extends React.Component<ProfilerProps> { | |||
| * Made protected for the React Native SDK to access | |||
| */ | |||
| protected _mountSpan: Span | undefined = undefined; | |||
| protected _updateSpan: Span | undefined = undefined; | |||
There was a problem hiding this comment.
Can we add a doc string for this?
AbhiPrasad
reviewed
Aug 8, 2022
| // New props yet again | ||
| rerender(<ProfiledComponent num={2} />); | ||
| expect(mockStartChild).toHaveBeenCalledTimes(3); | ||
| expect(mockStartChild).toHaveBeenLastCalledWith({ | ||
| data: { changedProps: ['num'] }, | ||
| description: `<${UNKNOWN_COMPONENT}>`, | ||
| endTimestamp: expect.any(Number), | ||
| op: REACT_UPDATE_OP, | ||
| startTimestamp: expect.any(Number), | ||
| }); |
There was a problem hiding this comment.
Can we assert on mockFinish after this block here?
0Calories
commented
Aug 9, 2022
| @@ -76,8 +79,6 @@ class Profiler extends React.Component<ProfilerProps> { | |||
| // set as data on the span. We just store the prop keys as the values could be potenially very large. | |||
| const changedProps = Object.keys(updateProps).filter(k => updateProps[k] !== this.props.updateProps[k]); | |||
| if (changedProps.length > 0) { | |||
| // The update span is a point in time span with 0 duration, just signifying that the component | |||
| // has been updated. | |||
There was a problem hiding this comment.
Removed this comment since it's no longer true
AbhiPrasad
approved these changes
Aug 9, 2022
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 gives the React SDK the ability to track the duration of
ui.react.updatespans by callingstartChildwithin theshouldComponentUpdatelifecycle method, and then callingfinishincomponentDidUpdateThis will allow Performance users to see in their transactions how long it is taking their components to update
Before
After