Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

color picker crashes studio inside iframe (#1989)

Igor Dykhta51a05ffe4e2e
diff --git a/src/components/src/common/portaled.tsx b/src/components/src/common/portaled.tsx
index 0afb5ed20..aedca5e1b 100644
--- a/src/components/src/common/portaled.tsx
+++ b/src/components/src/common/portaled.tsx
@@ -161,6 +161,13 @@ interface PortaledState {
}
class Portaled extends Component<PortaledProps, PortaledState> {
+ // Make Portaled a component with Error Boundary, so React can recreate
+ // this component if the child 'ColorPicker' throws cross-origin error.
+ // see function componentDidCatch()
+ static getDerivedStateFromError() {
+ return {hasError: true};
+ }
+
static defaultProps = {
component: 'div',
onClose: noop,
@@ -194,6 +201,16 @@ class Portaled extends Component<PortaledProps, PortaledState> {
this.handleScroll();
}
+ // ColorPicker will throw a cross-origin error when it is closed
+ // when the app is within an iframe.
+ // This is a known issue of react-color component:
+ // see: https://github.com/casesandberg/react-color/issues/806
+ componentDidCatch() {
+ // Do nothing here, since React will try to recreate this component
+ // tree from scratch using the error boundary, which is this component
+ // itself. This is a temporal fix for a crash.
+ }
+
componentWillUnmount() {
this._unmounted = true;
// @ts-ignore
diff --git a/test/browser/components/side-panel/color-selector-test.js b/test/browser/components/side-panel/color-selector-test.js
index cc795b88b..3197e84b8 100644
--- a/test/browser/components/side-panel/color-selector-test.js
+++ b/test/browser/components/side-panel/color-selector-test.js
@@ -41,7 +41,8 @@ import {
ColorPalette,
CustomPalette,
CustomPicker,
- Button
+ Button,
+ Portaled
} from '@kepler.gl/components';
import {COLOR_RANGES} from '@kepler.gl/constants';
@@ -781,5 +782,11 @@ test('Components -> LayerColorRangeSelector.render -> ColorSelector -> ColorRang
const picker = cp.find(CustomPicker);
t.equal(picker.length, 1, 'should render 1 CustomPicker');
+ // SecurityError (e.g. cross-origin error) should be handled in Portaled component
+ t.doesNotThrow(() => {
+ picker.simulateError({name: 'SecurityError', message: '', stack: []});
+ t.equal(wrapper.find(Portaled).length, 1);
+ }, 'Should not fail with SecurityError when close CustomPicker');
+
t.end();
});