Skip to content

fix(Charts): use ErrorBoundary to prevent errors when components are re-mounted #1190

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
MarcusNotheis merged 1 commit into from
Jan 20, 2021
Merged

fix(Charts): use ErrorBoundary to prevent errors when components are re-mounted #1190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 26 additions & 4 deletions packages/charts/src/internal/ChartContainer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ import { createComponentStyles } from '@ui5/webcomponents-react-base/lib/createC
import { ThemingParameters } from '@ui5/webcomponents-react-base/lib/ThemingParameters';
import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/lib/usePassThroughHtmlProps';
import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
import { Label } from '@ui5/webcomponents-react/lib/Label';
import { Loader } from '@ui5/webcomponents-react/lib/Loader';
import React, { ComponentType, CSSProperties, FC, forwardRef, ReactElement, Ref, useMemo } from 'react';
import React, { ComponentType, CSSProperties, FC, forwardRef, ReactElement, ReactNode, Ref, useMemo } from 'react';
import { ResponsiveContainer } from 'recharts';

export interface ContainerProps extends CommonProps {
Expand Down Expand Up @@ -41,6 +42,25 @@ const chartContainerStyles = {

const useStyles = createComponentStyles(chartContainerStyles, { name: 'ChartContainer' });

class ErrorBoundary extends React.Component<{ children: ReactNode }, { errorCount: number }> {
state = {
errorCount: 0
};

componentDidCatch() {
if (this.state.errorCount < 3) {
this.setState((old) => ({ ...old, errorCount: old.errorCount + 1 }));
}
}

render() {
if (this.state.errorCount >= 3) {
return <Label>Sorry, something went wrong while rendering this chart!</Label>;
}
return this.props.children;
}
}

const ChartContainer: FC<ContainerProps> = forwardRef((props: ContainerProps, ref: Ref<any>) => {
const { Placeholder, loading = false, dataset, style, className, tooltip, slot, children, resizeDebounce } = props;
useStyles();
Expand All @@ -65,9 +85,11 @@ const ChartContainer: FC<ContainerProps> = forwardRef((props: ContainerProps, re
<>
{loading && <Loader style={loaderStyles} />}
{
<ResponsiveContainer debounce={resizeDebounce} {...__testingProps__}>
{children}
</ResponsiveContainer>
<ErrorBoundary>
<ResponsiveContainer debounce={resizeDebounce} {...__testingProps__}>
{children}
</ResponsiveContainer>
</ErrorBoundary>
}
</>
) : (
Expand Down