Skip to content

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

fix: keep the parked layers' place when another dataset is replaced (#3750)

Javier Andrés Garcíace25658f4b11
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 3ae9b368f..fd548cdd2 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -5818,6 +5818,37 @@ export function prepareStateForDatasetReplace<T extends VisState>(
return nextState;
}
+/**
+ * The order to preserve for the items that will be merged back.
+ *
+ * `ids` comes from the serialized state, so it lists everything but the items
+ * another dataset's replacement parked a moment ago: an app refreshing several
+ * datasets in a row prepares the second replacement before the first one's
+ * items have merged back. Writing `ids` as it is would drop those, and
+ * `insertItemBasedOnPreservedOrder` puts an item it cannot place at the front —
+ * so they would come back reversed. Where they belong is what the order written
+ * when they were parked already says, so that order is kept for them.
+ */
+export function preservedOrderWithParked(
+ previousOrder: string[] = [],
+ ids: string[],
+ parked: {id?: string}[]
+): string[] {
+ const parkedIds = parked
+ .map(item => item?.id)
+ .filter((id): id is string => Boolean(id) && !ids.includes(id as string));
+
+ if (!parkedIds.length) {
+ return ids;
+ }
+
+ const known = new Set([...ids, ...parkedIds]);
+ const ordered = (previousOrder || []).filter(id => known.has(id));
+ const rest = [...ids, ...parkedIds].filter(id => !ordered.includes(id));
+
+ return [...ordered, ...rest];
+}
+
export function replaceDatasetDepsInState<T extends VisState>(
state: T,
{dataId, dataIdToUse}: {dataId: string; dataIdToUse: string}
@@ -5843,6 +5874,13 @@ export function replaceDatasetDepsInState<T extends VisState>(
saveUnmerged
};
+ // What another dataset's replacement parked a moment ago and has not
+ // merged back yet, read before this one parks anything of its own.
+ const parkedElsewhere =
+ mergerOptions.toMergeProp !== undefined
+ ? toArray(replacedState[mergerOptions.toMergeProp] ?? [])
+ : [];
+
const replacedItem =
replaceParentDatasetIds?.(propValue, dataId, dataIdToUse) ||
defaultReplaceParentDatasetIds(propValue, dataId, dataIdToUse);
@@ -5860,7 +5898,11 @@ export function replaceDatasetDepsInState<T extends VisState>(
replacedState[mergerOptions.toMergeProp]?.length &&
preserveOrder
) {
- replacedState[preserveOrder] = propValue.map(item => item.id);
+ replacedState[preserveOrder] = preservedOrderWithParked(
+ replacedState[preserveOrder],
+ propValue.map(item => item.id),
+ parkedElsewhere
+ );
}
});
diff --git a/test/node/reducers/composer-state-test.js b/test/node/reducers/composer-state-test.js
index 03e492e5d..6fd21e2ce 100644
--- a/test/node/reducers/composer-state-test.js
+++ b/test/node/reducers/composer-state-test.js
@@ -827,6 +827,78 @@ test('#composerStateReducer - replaceDataInMapUpdater: replacing a dataset with
t.end();
});
+test('#composerStateReducer - replaceDataInMapUpdater: replacing a dataset that has layers before the previous replace merges', t => {
+ const secondDataId = 'dataset_with_its_own_layer';
+ const state = keplerGlReducer({}, registerEntry({id: 'test'})).test;
+
+ // Two layers on the first dataset and one on the second, which is what an app
+ // drawing a query per dataset ends up with.
+ const configWithBothDatasets = {
+ ...sampleConfig.config,
+ config: {
+ ...sampleConfig.config.config,
+ visState: {
+ ...sampleConfig.config.config.visState,
+ layers: [
+ ...sampleConfig.config.config.visState.layers,
+ {
+ id: 'second_ds_layer',
+ type: 'point',
+ config: {
+ dataId: secondDataId,
+ label: 'second dataset',
+ columns: {lat: 'gps_data.lat', lng: 'gps_data.lng', altitude: null},
+ isVisible: true
+ }
+ }
+ ]
+ }
+ }
+ };
+
+ let oldState = addDataToMapUpdater(state, {
+ payload: {
+ datasets: [
+ {data: processCsvData(testCsvData), info: {id: sampleConfig.dataId}},
+ {data: processCsvData(testCsvData), info: {id: secondDataId}}
+ ],
+ config: configWithBothDatasets,
+ options: {autoCreateLayers: false}
+ }
+ });
+ oldState = {...oldState, visState: applyExistingDatasetTasks(visStateReducer, oldState.visState)};
+ drainTasksForTesting();
+
+ const layerOrder = oldState.visState.layerOrder;
+ t.equal(layerOrder.length, 3, 'should start with the three layers of the config');
+
+ // Refresh both datasets back to back: the second replace is prepared while the
+ // first one's layers are still parked in layerToBeMerged.
+ 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: secondDataId,
+ datasetToUse: {data: processCsvData(testCsvData), info: {id: secondDataId}},
+ 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: replacing datasets back to back keeps the split map panels', t => {
const noLayersId = 'dataset_without_layers';
const state = keplerGlReducer({}, registerEntry({id: 'test'})).test;