feat(react)!: Update ErrorBoundary componentStack type
#14742
Merged
Conversation
This file contains 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
requested review from
Lms24 and
chargome
and removed request for
a team
2 tasks
size-limit report 📦
|
Lms24
reviewed
Dec 17, 2024
docs/migration/v8-to-v9.md
Outdated
| @@ -70,6 +70,10 @@ Sentry.init({ | |||
|
|
|||
| - When `skipOpenTelemetrySetup: true` is configured, `httpIntegration({ spans: false })` will be configured by default. This means that you no longer have to specify this yourself in this scenario. With this change, no spans are emitted once `skipOpenTelemetrySetup: true` is configured, without any further configuration being needed. | |||
|
|
|||
| ### `@sentry/react` | |||
|
|
|||
| The `componentStack` field in the `ErrorBoundary` component is now typed as `string | undefined` instead of `string | null | undefined`. This more closely matches the actual behavior of React, which always returns a `string` whenever a component stack is available. `undefined` is only returned if no error has been caught by the error boundary. | |||
There was a problem hiding this comment.
m: Looking at the code, I don't see componentStack being typed as string | undefined but rather string | null. Should we update the migration note accordingly?
Suggested change
| The `componentStack` field in the `ErrorBoundary` component is now typed as `string | undefined` instead of `string | null | undefined`. This more closely matches the actual behavior of React, which always returns a `string` whenever a component stack is available. `undefined` is only returned if no error has been caught by the error boundary. | |
| The `componentStack` field in the `ErrorBoundary` component is now typed as `string | null` instead of `string | null | undefined`. This more closely matches the actual behavior of React, which always returns a `string` whenever a component stack is available. `undefined` is only returned if no error has been caught by the error boundary. |
i might just also be missing something 😅 - in that case, feel free to disregard!
There was a problem hiding this comment.
Internally we keep the componentStack as null, but to the user it should always be defined. There is actually one scenario where things are now null, I extended the changelog to talk about this.
chargome
reviewed
Dec 17, 2024
packages/react/src/errorboundary.tsx
Outdated
| /** Called on componentDidMount() */ | ||
| onMount?: (() => void) | undefined; | ||
| /** Called if resetError() is called from the fallback render props function */ | ||
| onReset?: ((error: unknown, componentStack: string | null | undefined, eventId: string | null) => void) | undefined; | ||
| onReset?: ((error: unknown, componentStack: string | null, eventId: string | null) => void) | undefined; |
There was a problem hiding this comment.
Can we remove null here as well?
There was a problem hiding this comment.
Not exactly, I expanded the migration doc to talk about this.
AbhiPrasad
force-pushed
the
abhi-error-boundary-component-stack
branch
from
4e80697 to
04f6178
Compare
|
sorry for the delay, refactored this a little more, ready for another round! |
Lms24
approved these changes
Jan 14, 2025
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.
resolves #14310
supercedes #14327 (I have left @kunal-511 a shout out on the changelog for getting this work started!)
The principle thing that drove this change was this todo:
sentry-javascript/packages/react/src/errorboundary.tsx
Lines 101 to 102 in 5b77377
Specifically we wanted to remove
nullas a valid state fromcomponentStack, making sure that all exposed public API see it asstring | undefined. React always returns astringcomponentStackfrom the error boundary, so this matches our typings more closely to react.By making this change, we can also clean up the
renderlogic a little. Specifically we can check forstate.componentStack === nullto determine if a fallback is rendered, and then I went ahead and removed some unnecessary nesting.