Skip to content
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.

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

Wrap <LoadableRenderer /> with <ErrorBoundary /> #6294

Merged
merged 2 commits into from
Nov 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 14 additions & 10 deletions superset/assets/src/chart/Chart.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import RefreshChartOverlay from '../components/RefreshChartOverlay';
import StackTraceMessage from '../components/StackTraceMessage';
import ChartProps from '../visualizations/core/models/ChartProps';
import SuperChart from '../visualizations/core/components/SuperChart';
import ErrorBoundary from '../components/ErrorBoundary';
import './chart.css';

const propTypes = {
Expand Down Expand Up @@ -92,7 +93,7 @@ class Chart extends React.PureComponent {
handleRenderFailure(e) {
const { actions, chartId } = this.props;
console.warn(e); // eslint-disable-line
actions.chartRenderingFailed(e, chartId);
actions.chartRenderingFailed(e.toString(), chartId);
}

prepareChartProps() {
Expand Down Expand Up @@ -181,7 +182,8 @@ class Chart extends React.PureComponent {
{chartAlert && (
<StackTraceMessage
message={chartAlert}
queryResponse={queryResponse}
link={queryResponse ? queryResponse.link : null}
stackTrace={queryResponse ? queryResponse.stacktrace : null}
/>
)}

Expand All @@ -194,14 +196,16 @@ class Chart extends React.PureComponent {
/>
)}

<SuperChart
className={`slice_container ${snakeCase(vizType)} ${isFaded ? ' faded' : ''}`}
chartType={vizType}
chartProps={skipChartRendering ? null : this.prepareChartProps()}
onRenderSuccess={this.handleRenderSuccess}
onRenderFailure={this.handleRenderFailure}
skipRendering={skipChartRendering}
/>
<ErrorBoundary onError={this.handleRenderFailure} showMessage={false}>
<SuperChart
className={`slice_container ${snakeCase(vizType)} ${isFaded ? ' faded' : ''}`}
chartType={vizType}
chartProps={skipChartRendering ? null : this.prepareChartProps()}
onRenderSuccess={this.handleRenderSuccess}
onRenderFailure={this.handleRenderFailure}
skipRendering={skipChartRendering}
/>
</ErrorBoundary>
</div>
);
}
Expand Down
2 changes: 1 addition & 1 deletion superset/assets/src/components/CachedLabel.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class CacheLabel extends React.PureComponent {
onMouseOver={this.mouseOver.bind(this)}
onMouseOut={this.mouseOut.bind(this)}
>
cached <i className="fa fa-refresh" />
{t('cached')} <i className="fa fa-refresh" />
</Label>
</TooltipWrapper>);
}
Expand Down
45 changes: 45 additions & 0 deletions superset/assets/src/components/ErrorBoundary.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import React from 'react';
import PropTypes from 'prop-types';
import { t } from '@superset-ui/translation';
import StackTraceMessage from './StackTraceMessage';

const propTypes = {
children: PropTypes.node.isRequired,
onError: PropTypes.func,
showMessage: PropTypes.bool,
};
const defaultProps = {
onError: () => {},
showMessage: true,
};

export default class ErrorBoundary extends React.Component {
constructor(props) {
super(props);
this.state = { error: null, info: null };
}

componentDidCatch(error, info) {
this.props.onError(error, info);
this.setState({ error, info });
}

render() {
const { error, info } = this.state;
if (error) {
const firstLine = error ? error.toString() : null;
const message = (
<span>
<strong>{t('Unexpected error')}</strong>{firstLine ? `: ${firstLine}` : ''}
</span>);
if (this.props.showMessage) {
return (
<StackTraceMessage message={message} stackTrace={info ? info.componentStack : null} />);
}
return null;
}
return this.props.children;
}
}
ErrorBoundary.propTypes = propTypes;
ErrorBoundary.defaultProps = defaultProps;
25 changes: 10 additions & 15 deletions superset/assets/src/components/StackTraceMessage.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ import PropTypes from 'prop-types';
import { Alert, Collapse } from 'react-bootstrap';

const propTypes = {
message: PropTypes.string,
queryResponse: PropTypes.object,
message: PropTypes.node.isRequired,
link: PropTypes.string,
stackTrace: PropTypes.string,
showStackTrace: PropTypes.bool,
};
const defaultProps = {
showStackTrace: false,
link: null,
stackTrace: null,
};

class StackTraceMessage extends React.PureComponent {
Expand All @@ -21,36 +24,28 @@ class StackTraceMessage extends React.PureComponent {
};
}

hasTrace() {
return this.props.queryResponse && this.props.queryResponse.stacktrace;
}

hasLink() {
return this.props.queryResponse && this.props.queryResponse.link;
}

render() {
return (
<div className={`stack-trace-container${this.hasTrace() ? ' has-trace' : ''}`}>
<div className={`stack-trace-container${this.props.stackTrace ? ' has-trace' : ''}`}>
<Alert
bsStyle="warning"
onClick={() => this.setState({ showStackTrace: !this.state.showStackTrace })}
>
{this.props.message}
{this.hasLink() &&
{this.props.link &&
<a
href={this.props.queryResponse.link}
href={this.props.link}
target="_blank"
rel="noopener noreferrer"
>
(Request Access)
</a>
}
</Alert>
{this.hasTrace() &&
{this.props.stackTrace &&
<Collapse in={this.state.showStackTrace}>
<pre>
{this.props.queryResponse.stacktrace}
{this.props.stackTrace}
</pre>
</Collapse>
}
Expand Down
2 changes: 1 addition & 1 deletion superset/assets/src/visualizations/TimeTable/TimeTable.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ class TimeTable extends React.PureComponent {
.map(time => ({ ...data[time], time }));
const reversedEntries = entries.concat().reverse();

const defaultSort = rowType === 'column' ? {
const defaultSort = rowType === 'column' && columnConfigs.length ? {
column: columnConfigs[0].key,
direction: 'desc',
} : false;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export default function transformProps(chartProps) {
const { height, datasource, formData, payload } = chartProps;
const {
columnCollection,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can do columnCollection = [] to default to []

columnCollection = 0,
groupby,
metrics,
url,
Expand Down