Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[feat] loading indicator (#2936)
Igor Dykhta029bcc548109
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.tsindex 713459810..7499abd55 100644--- a/src/actions/src/action-types.ts+++ b/src/actions/src/action-types.ts@@ -151,6 +151,7 @@ export const ActionTypes = {SYNC_TIME_FILTER_WITH_LAYER_TIMELINE: `${ACTION_PREFIX}SYNC_TIME_FILTER_WITH_LAYER_TIMELINE`,SYNC_TIME_FILTER_TIMELINE_MODE: `${ACTION_PREFIX}SYNC_TIME_FILTER_TIMELINE_MODE`,TOGGLE_PANEL_LIST_VIEW: `${ACTION_PREFIX}TOGGLE_PANEL_LIST_VIEW`,+ SET_LOADING_INDICATOR: `${ACTION_PREFIX}SET_LOADING_INDICATOR`,// uiState > export imageSET_EXPORT_IMAGE_SETTING: `${ACTION_PREFIX}SET_EXPORT_IMAGE_SETTING`,diff --git a/src/actions/src/ui-state-actions.ts b/src/actions/src/ui-state-actions.tsindex 39d360c66..b8a02ad88 100644--- a/src/actions/src/ui-state-actions.ts+++ b/src/actions/src/ui-state-actions.ts@@ -495,3 +495,25 @@ export const togglePanelListView: (// @ts-ignoreconst uiStateActions = null;/* eslint-enable @typescript-eslint/no-unused-vars */++/** SET_LOADING_INDICATOR */+export type SetLoadingIndicatorAction = {+ payload: {+ change: number;+ };+};++/**+ * Change of number of active loading actions.+ * @memberof uiStateActions+ * @param payload+ * @param payload.change Change of number of active loading actions.+ * @public+ */+export const setLoadingIndicator: (+ payload: SetLoadingIndicatorAction['payload']+) => Merge<SetLoadingIndicatorAction, {type: typeof ActionTypes.SET_LOADING_INDICATOR}> =+ createAction(+ ActionTypes.SET_LOADING_INDICATOR,+ (payload: SetLoadingIndicatorAction['payload']) => ({payload})+ );diff --git a/src/components/src/kepler-gl.tsx b/src/components/src/kepler-gl.tsxindex b44d3cc89..70e2dc874 100644--- a/src/components/src/kepler-gl.tsx+++ b/src/components/src/kepler-gl.tsx@@ -182,6 +182,8 @@ export const mapFieldsSelector = (props: KeplerGLProps, index = 0) => ({mapControls: props.uiState.mapControls,readOnly: props.uiState.readOnly,locale: props.uiState.locale,+ isLoadingIndicatorVisible: Number(props.uiState.loadingIndicatorValue) > 0,+ sidePanelWidth: props.sidePanelWidth ? props.sidePanelWidth : DEFAULT_KEPLER_GL_PROPS.width,// mapStyletopMapContainerProps: props.topMapContainerProps,diff --git a/src/components/src/loading-indicator.tsx b/src/components/src/loading-indicator.tsxnew file mode 100644index 000000000..daa3a9f2c--- /dev/null+++ b/src/components/src/loading-indicator.tsx@@ -0,0 +1,49 @@+// SPDX-License-Identifier: MIT+// Copyright contributors to the kepler.gl project++import React, {PropsWithChildren} from 'react';+import styled, {withTheme} from 'styled-components';++type StyledContainerProps = {+ isVisible?: boolean;+ left: number;+};++export const StyledContainer = styled.div<StyledContainerProps>`+ position: absolute;+ left: ${props => props.left}px;+ bottom: ${props => props.theme.sidePanel.margin.left}px;+ z-index: 1;+ color: ${props => props.theme.textColorHl};+ opacity: ${props => (props.isVisible ? 1 : 0)};+ transition: opacity 0.5s ease-in-out;+ background-color: ${props => props.theme.sidePanelBg};+ border-radius: 0px;+ padding-left: 3px;+ padding-right: 3px;+ font-size: 12px;+`;++type LoadingIndicatorProps = {+ isVisible?: boolean;+ activeSidePanel?: boolean;+ sidePanelWidth?: number;+};++const LoadingIndicator: React.FC<PropsWithChildren<LoadingIndicatorProps> & {theme: any}> = ({+ isVisible,+ children,+ activeSidePanel,+ sidePanelWidth,+ theme+}) => {+ const left = (activeSidePanel ? sidePanelWidth || 0 : 0) + theme.sidePanel.margin.left;++ return (+ <StyledContainer isVisible={isVisible} left={left}>+ {children}+ </StyledContainer>+ );+};++export default withTheme(LoadingIndicator) as React.FC<PropsWithChildren<LoadingIndicatorProps>>;diff --git a/src/components/src/map-container.tsx b/src/components/src/map-container.tsxindex 93bb4575a..88407241e 100644--- a/src/components/src/map-container.tsx+++ b/src/components/src/map-container.tsx@@ -91,6 +91,8 @@ import {} from '@kepler.gl/reducers';import {VisState} from '@kepler.gl/schemas';+import LoadingIndicator from './loading-indicator';+// Debounce the propagation of viewport change and mouse moves to redux store.// This is to avoid too many renders of other components when the map is// being panned/zoomed (leading to laggy basemap/deck syncing).@@ -324,6 +326,10 @@ export interface MapContainerProps {deleteMapLabels?: (containerId: string, layerId: string) => void;containerId?: number;+ isLoadingIndicatorVisible?: boolean;+ activeSidePanel: string | null;+ sidePanelWidth?: number;+locale?: any;theme?: any;editor?: any;@@ -1022,7 +1028,10 @@ export default function MapContainerFactory(topMapContainerProps,theme,datasetAttributions = [],- containerId = 0+ containerId = 0,+ isLoadingIndicatorVisible,+ activeSidePanel,+ sidePanelWidth} = this.props;const {layers, datasets, editor, interactionConfig} = visState;@@ -1144,6 +1153,15 @@ export default function MapContainerFactory(): null}{this._renderMapPopover()}+ {primary !== isSplit ? (+ <LoadingIndicator+ isVisible={Boolean(isLoadingIndicatorVisible)}+ activeSidePanel={Boolean(activeSidePanel)}+ sidePanelWidth={sidePanelWidth}+ >+ Loading...+ </LoadingIndicator>+ ) : null}{this.props.primary ? (<AttributionshowBaseMapLibLogo={this.state.showBaseMapAttribution}diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.tsindex 124fb5ac2..9d92ef30c 100644--- a/src/constants/src/default-settings.ts+++ b/src/constants/src/default-settings.ts@@ -113,7 +113,7 @@ export const KEPLER_GL_WEBSITE = 'http://kepler.gl/';export const DIMENSIONS = {sidePanel: {width: 300,- margin: {top: 20, left: 20, bottom: 30, right: 20},+ margin: {top: 12, left: 12, bottom: 12, right: 20},headerHeight: 96},mapControl: {diff --git a/src/reducers/src/ui-state-updaters.ts b/src/reducers/src/ui-state-updaters.tsindex fb9a637e0..e4f18e422 100644--- a/src/reducers/src/ui-state-updaters.ts+++ b/src/reducers/src/ui-state-updaters.ts@@ -902,3 +902,27 @@ export const togglePanelListViewUpdater = ([stateProp]: listView};};++/**+ * Update state of the loading indicator.+ * @memberof uiStateUpdaters+ * @param state uiState+ * @param action+ * @param action.payload Payload with change of number of active loading actions.+ * @returns nextState+ * @public+ */+export const setLoadingIndicatorUpdater = (+ state: UiState,+ {payload: {change}}: UIStateActions.SetLoadingIndicatorAction+): UiState => {+ let {loadingIndicatorValue} = state;+ if (!loadingIndicatorValue) {+ loadingIndicatorValue = 0;+ }++ return {+ ...state,+ loadingIndicatorValue: Math.max(loadingIndicatorValue + change, 0)+ };+};diff --git a/src/reducers/src/ui-state.ts b/src/reducers/src/ui-state.tsindex 95fa20444..88a0f0e53 100644--- a/src/reducers/src/ui-state.ts+++ b/src/reducers/src/ui-state.ts@@ -44,7 +44,9 @@ const actionHandler = {[ActionTypes.TOGGLE_SPLIT_MAP]: uiStateUpdaters.toggleSplitMapUpdater,[ActionTypes.SHOW_DATASET_TABLE]: uiStateUpdaters.showDatasetTableUpdater,[ActionTypes.SET_LOCALE]: uiStateUpdaters.setLocaleUpdater,- [ActionTypes.TOGGLE_PANEL_LIST_VIEW]: uiStateUpdaters.togglePanelListViewUpdater+ [ActionTypes.TOGGLE_PANEL_LIST_VIEW]: uiStateUpdaters.togglePanelListViewUpdater,++ [ActionTypes.SET_LOADING_INDICATOR]: uiStateUpdaters.setLoadingIndicatorUpdater};/* Reducer */diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.tsindex dab48ee72..af94a6e93 100644--- a/src/reducers/src/vis-state-updaters.ts+++ b/src/reducers/src/vis-state-updaters.ts@@ -41,6 +41,7 @@ import {setFilter,processFileContent,fitBounds as fitMapBounds,+ setLoadingIndicator,toggleLayerForMap,applyFilterConfig} from '@kepler.gl/actions';@@ -2327,17 +2328,23 @@ export const updateVisDataUpdater = (}): state;+ // indicate that something is in progress+ const setIsLoadingTask = ACTION_TASK().map(() => {+ return setLoadingIndicator({change: 1});+ });+ const updatedState = withTask(previousState, setIsLoadingTask);+const datasets = toArray(action.datasets);const allCreateDatasetsTasks = datasets.map(({info = {}, ...rest}) => createNewDataEntry({info, ...rest}, state.datasets) || {});// call all Tasks- const tasks = Task.allSettled(allCreateDatasetsTasks).map(results =>+ const datasetTasks = Task.allSettled(allCreateDatasetsTasks).map(results =>createNewDatasetSuccess({results, addToMapOptions: options}));- return withTask(previousState, tasks);+ return withTask(updatedState, datasetTasks);};export const createNewDatasetSuccessUpdater = (@@ -2376,7 +2383,16 @@ export const createNewDatasetSuccessUpdater = (layerMergers};- return applyMergersUpdater(mergedState, {mergers: datasetMergers, postMergerPayload});+ const updatedState = applyMergersUpdater(mergedState, {+ mergers: datasetMergers,+ postMergerPayload+ });++ // resolve active loading initiated by updateVisDataUpdater+ const setIsLoadingTask = ACTION_TASK().map(() => {+ return setLoadingIndicator({change: -1});+ });+ return withTask(updatedState, setIsLoadingTask);};/**diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.tsindex 0d1dd34ca..fcfd5e9ed 100644--- a/src/types/reducers.d.ts+++ b/src/types/reducers.d.ts@@ -472,6 +472,8 @@ export type UiState = {filterPanelListView: PanelListView;// side panel close button visibilityisSidePanelCloseButtonVisible: boolean | null;+ // positive value indicates that something is loading+ loadingIndicatorValue?: number;};/** Width of viewport */diff --git a/test/node/reducers/composer-state-test.js b/test/node/reducers/composer-state-test.jsindex 0f1d8ad9c..f45884576 100644--- a/test/node/reducers/composer-state-test.js+++ b/test/node/reducers/composer-state-test.js@@ -127,7 +127,7 @@ test('#composerStateReducer - addDataToMapUpdater: mapState should be centered (// layers should generate a fit bounds taskconst tasks = drainTasksForTesting();- t.equal(tasks.length, 1, 'One fit bounds task should be present');+ t.equal(tasks.length, 2, 'Should create one fit bounds task and one setLoadingIndicator task');newState.mapState = mapStateReducer(newState.mapState, succeedTaskWithValues(tasks[0], {}));@@ -441,7 +441,7 @@ test('#composerStateReducer - replaceDataInMapUpdater', t => {// layers should generate a fit bounds taskconst tasks = drainTasksForTesting();- t.equal(tasks.length, 1, 'A fit bounds Task should be present');+ t.equal(tasks.length, 2, 'Should create one fit bounds task and one setLoadingIndicator task');nextState = {...nextState,mapState: mapStateReducer(nextState.mapState, succeedTaskWithValues(tasks[0], {}))diff --git a/test/node/reducers/vis-state-merger-test.js b/test/node/reducers/vis-state-merger-test.jsindex 8862e48ec..db6ce0cd6 100644--- a/test/node/reducers/vis-state-merger-test.js+++ b/test/node/reducers/vis-state-merger-test.js@@ -2217,7 +2217,7 @@ test('VisStateMerger -> asynс mergers', t => {t.ok(nextState.test.visState.datasets[testCsvDataId], 'should add csv data');const tasks = drainTasksForTesting();- t.equal(tasks.length, 1, 'should create 1 task');+ t.equal(tasks.length, 2, 'Should create one fit bounds task and one setLoadingIndicator task');t.equal(tasks[0].type, 'MOCK_MERGE_TASK', 'should create merger task');// add another dataset will async merger is in processdiff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.jsindex d79bd8a9f..b273efdcf 100644--- a/test/node/reducers/vis-state-test.js+++ b/test/node/reducers/vis-state-test.js@@ -5626,6 +5626,8 @@ test('#visStateReducer -> PIN_TABLE_COLUMN', t => {});test('#visStateReducer -> LOAD_FILES', async t => {+ drainTasksForTesting();+const loadFilesSuccessSpy = sinon.spy(VisStateActions, 'loadFilesSuccess');const loadFileErrSpy = sinon.spy(Console, 'warn');const initialState = CloneDeep(InitialState).visState;@@ -5653,8 +5655,8 @@ test('#visStateReducer -> LOAD_FILES', async t => {const nextState = reducer(initialState, VisStateActions.loadFiles(mockFiles));const tasks = drainTasksForTesting();- t.equal(tasks.length, 2, 'should ceate 2 tasks');- const task1 = tasks[1];+ t.equal(tasks.length, 1, 'should create 1 task');+ const task1 = tasks[0];const expectedTask1 = {type: 'LOAD_FILE_TASK',