Skip to content

fix(react): Require ReactElement in ErrorBoundary props and render #3857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 4 commits into from
Aug 3, 2021
Merged

fix(react): Require ReactElement in ErrorBoundary props and render #3857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fdb7c34
Require ReactElement in ErrorBoundary props and render
Aug 1, 2021
af921d7
Remove console log
Aug 1, 2021
40bed07
Log a warning when fallback does not produce ReactElement
Aug 3, 2021
bb5f91c
Merge remote-tracking branch 'upstream/master' into fix/errorboundary…
Aug 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions packages/react/src/errorboundary.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
withScope,
} from '@sentry/browser';
import { Event } from '@sentry/types';
import { parseSemver } from '@sentry/utils';
import { logger, parseSemver } from '@sentry/utils';
import hoistNonReactStatics from 'hoist-non-react-statics';
import * as React from 'react';

Expand All @@ -21,7 +21,7 @@ export type FallbackRender = (errorData: {
componentStack: string | null;
eventId: string | null;
resetError(): void;
}) => React.ReactNode;
}) => React.ReactElement;

export type ErrorBoundaryProps = {
/** If a Sentry report dialog should be rendered on error */
Expand All @@ -39,7 +39,7 @@ export type ErrorBoundaryProps = {
* the error, the component stack, and an function that resets the error boundary on error.
*
*/
fallback?: React.ReactNode | FallbackRender;
fallback?: React.ReactElement | FallbackRender;
/** Called with the error boundary encounters an error */
onError?(error: Error, componentStack: string, eventId: string): void;
/** Called on componentDidMount() */
Expand Down Expand Up @@ -160,14 +160,22 @@ class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundarySta
const { error, componentStack, eventId } = this.state;

if (error) {
if (React.isValidElement(fallback)) {
return fallback;
}
let element: React.ReactElement | undefined = undefined;
if (typeof fallback === 'function') {
return fallback({ error, componentStack, resetError: this.resetErrorBoundary, eventId }) as FallbackRender;
element = fallback({ error, componentStack, resetError: this.resetErrorBoundary, eventId });
} else {
element = fallback;
}

if (React.isValidElement(element)) {
return element;
}

if (fallback) {
logger.warn('fallback did not produce a valid ReactElement');
}

// Fail gracefully if no fallback provided
// Fail gracefully if no fallback provided or is not valid
Copy link
Member

@AbhiPrasad AbhiPrasad Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use logger from @sentry/utils to log out a warning here: https://github.com/getsentry/sentry-javascript/blob/master/packages/utils/src/logger.ts

import { logger } from `@sentry/utils`

Copy link
Author

@jcomo jcomo Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thanks!

return null;
}

Expand Down
12 changes: 11 additions & 1 deletion packages/react/test/errorboundary.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,17 @@ describe('ErrorBoundary', () => {

it('renders null if not given a valid `fallback` prop', () => {
const { container } = render(
<ErrorBoundary fallback={new Error('true')}>
<ErrorBoundary fallback="Not a ReactElement">
<Bam />
</ErrorBoundary>,
);

expect(container.innerHTML).toBe('');
});

it('renders null if not given a valid `fallback` prop function', () => {
const { container } = render(
<ErrorBoundary fallback={() => 'Not a ReactElement'}>
<Bam />
</ErrorBoundary>,
);
Expand Down