Skip to content

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

fix: keep layer order when replacing datasets back to back (#3728)

Javier Andrés García5cae52f56f18
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 3fea0bf0b..57722ccff 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -5688,7 +5688,12 @@ export function replaceDatasetDepsInState<T extends VisState>(
? replacePropValueInState(replacedState, replacedItem, mergerOptions)
: replacedState;
+ // Only when this dataset had items of its own to park. The toBeMerged list
+ // can still hold another dataset's items, replaced a moment earlier and
+ // not merged back yet; overwriting the order they were parked with would
+ // merge them back in reverse.
if (
+ replacedItem &&
mergerOptions.toMergeProp !== undefined &&
replacedState[mergerOptions.toMergeProp]?.length &&
preserveOrder
diff --git a/test/node/reducers/composer-state-test.js b/test/node/reducers/composer-state-test.js
index 8f80adbab..d2cd384f1 100644
--- a/test/node/reducers/composer-state-test.js
+++ b/test/node/reducers/composer-state-test.js
@@ -777,6 +777,53 @@ test('#composerStateReducer - replaceDataInMapUpdater: same dataId', t => {
t.end();
});
+test('#composerStateReducer - replaceDataInMapUpdater: replacing a dataset with no layers before the previous replace merges', t => {
+ const noLayersId = 'dataset_without_layers';
+ const state = keplerGlReducer({}, registerEntry({id: 'test'})).test;
+
+ let oldState = addDataToMapUpdater(state, {
+ payload: {
+ datasets: [
+ {data: processCsvData(testCsvData), info: {id: sampleConfig.dataId}},
+ {data: processCsvData(testCsvData), info: {id: noLayersId}}
+ ],
+ config: sampleConfig.config,
+ options: {autoCreateLayers: false}
+ }
+ });
+ oldState = {...oldState, visState: applyExistingDatasetTasks(visStateReducer, oldState.visState)};
+ drainTasksForTesting();
+
+ const layerOrder = oldState.visState.layerOrder;
+ t.ok(layerOrder.length > 1, 'should start with more than one layer on the first dataset');
+
+ // Refresh both datasets back to back, the way an app refreshing every query
+ // does: the second replace is prepared before the first one has merged.
+ let nextState = replaceDataInMapUpdater(oldState, {
+ payload: {
+ datasetToReplaceId: sampleConfig.dataId,
+ datasetToUse: {data: processCsvData(testCsvData), info: {id: sampleConfig.dataId}},
+ options: {autoCreateLayers: false, centerMap: false}
+ }
+ });
+ nextState = replaceDataInMapUpdater(nextState, {
+ payload: {
+ datasetToReplaceId: noLayersId,
+ datasetToUse: {data: processCsvData(testCsvData), info: {id: noLayersId}},
+ options: {autoCreateLayers: false, centerMap: false}
+ }
+ });
+ nextState = {
+ ...nextState,
+ visState: applyExistingDatasetTasks(visStateReducer, nextState.visState)
+ };
+ drainTasksForTesting();
+
+ t.deepEqual(nextState.visState.layerToBeMerged, [], 'should merge every layer back');
+ t.deepEqual(nextState.visState.layerOrder, layerOrder, 'should keep the layer order');
+ t.end();
+});
+
test('#composerStateReducer - replaceDataInMapUpdater: syncedTimeFilter & match', t => {
const oldState = StateWSyncedTimeFilter;
const dataIdToReplace = 'dataset_to_replace';