Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[chore] Add several vis state mergers combineConfigs and improve TS (#2634)
Igor Dykhta141236513aa9
diff --git a/src/reducers/src/merger-handler.ts b/src/reducers/src/merger-handler.tsindex 8d46c187c..86b2e28d2 100644--- a/src/reducers/src/merger-handler.ts+++ b/src/reducers/src/merger-handler.ts@@ -29,7 +29,7 @@ function callFunctionGetTask(fn: () => any): [any, any] {export function mergeStateFromMergers<State extends VisState>(state: State,initialState: State,- mergers: Merger<any>[],+ mergers: Merger<State>[],postMergerPayload: PostMergerPayload): {mergedState: State;@@ -80,7 +80,7 @@ export function mergeStateFromMergers<State extends VisState>(export function hasPropsToMerge<State extends object>(state: State,- mergerProps: string | string[]+ mergerProps?: string | string[]): boolean {return Array.isArray(mergerProps)? Boolean(mergerProps.some(p => Object.prototype.hasOwnProperty.call(state, p)))@@ -89,15 +89,15 @@ export function hasPropsToMerge<State extends object>(export function getPropValueToMerger<State extends object>(state: State,- mergerProps: string | string[],+ mergerProps?: string | string[],toMergeProps?: string | string[]): Partial<State> | ValueOf<State> {- return Array.isArray(mergerProps)+ return Array.isArray(mergerProps) && Array.isArray(toMergeProps)? mergerProps.reduce((accu, p, i) => {if (!toMergeProps) return accu;return {...accu, [toMergeProps[i]]: state[p]};}, {})- : state[mergerProps];+ : state[mergerProps as string];}export function resetStateToMergeProps<State extends VisState>(diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.tsindex e30da01c0..5bd596f7f 100644--- a/src/reducers/src/vis-state-merger.ts+++ b/src/reducers/src/vis-state-merger.ts@@ -10,12 +10,14 @@ import {getInitialMapLayersForSplitMap,applyFiltersToDatasets,validateFiltersUpdateDatasets,- findById+ findById,+ aggregate} from '@kepler.gl/utils';import {Layer, VisualChannel} from '@kepler.gl/layers';import {createEffect} from '@kepler.gl/effects';-import {LAYER_BLENDINGS, OVERLAY_BLENDINGS} from '@kepler.gl/constants';+import {notNullorUndefined} from '@kepler.gl/common-utils';+import {AGGREGATION_TYPES, LAYER_BLENDINGS, OVERLAY_BLENDINGS} from '@kepler.gl/constants';import {CURRENT_VERSION, VisState, VisStateMergers, KeplerGLSchemaClass} from '@kepler.gl/schemas';import {@@ -30,7 +32,9 @@ import {ParsedEffect,LayerColumns,LayerColumn,- ParsedFilter+ ParsedFilter,+ NestedPartial,+ SavedAnimationConfig} from '@kepler.gl/types';import {KeplerTable, Datasets, assignGpuChannels, resetFilterGpuMode} from '@kepler.gl/table';@@ -334,7 +338,7 @@ export function mergeInteractions<S extends VisState>(state: S,interactionToBeMerged: Partial<SavedInteractionConfig> | undefined): S {- const merged: Partial<SavedInteractionConfig> = {};+ const merged: NestedPartial<SavedInteractionConfig> = {};const unmerged: Partial<SavedInteractionConfig> = {};if (interactionToBeMerged) {@@ -399,6 +403,64 @@ export function mergeInteractions<S extends VisState>(return nextState;}+function combineInteractionConfigs(configs: SavedInteractionConfig[]): SavedInteractionConfig {+ const combined = {...configs[0]};+ // handle each property key of an `InteractionConfig`, e.g. tooltip, geocoder, brush, coordinate+ // by combining values for each among all passed in configs++ for (const key in combined) {+ const toBeCombinedProps = configs.map(c => c[key]);++ // all of these have an enabled boolean+ combined[key] = {+ // are any of the configs' enabled values true?+ enabled: toBeCombinedProps.some(p => p?.enabled)+ };++ if (key === 'tooltip') {+ // are any of the configs' compareMode values true?+ combined[key].compareMode = toBeCombinedProps.some(p => p?.compareMode);++ // return the compare type mode, it will be either absolute or relative+ combined[key].compareType = getValueWithHighestOccurrence(+ toBeCombinedProps.map(p => p.compareType)+ );++ // combine fieldsToShow among all dataset ids+ combined[key].fieldsToShow = toBeCombinedProps+ .map(p => p.fieldsToShow)+ .reduce((acc, nextFieldsToShow) => {+ for (const nextDataIdKey in nextFieldsToShow) {+ const nextTooltipFields = nextFieldsToShow[nextDataIdKey];+ if (!acc[nextDataIdKey]) {+ // if the dataset id is not present in the accumulator+ // then add it with its tooltip fields+ acc[nextDataIdKey] = nextTooltipFields;+ } else {+ // otherwise the dataset id is already present in the accumulator+ // so only add the next tooltip fields for this dataset's array if they are not already present,+ // using the tooltipField.name property for uniqueness+ nextTooltipFields.forEach(nextTF => {+ if (!acc[nextDataIdKey].find(({name}) => nextTF.name === name)) {+ acc[nextDataIdKey].push(nextTF);+ }+ });+ }+ }+ return acc;+ }, {});+ }++ if (key === 'brush') {+ // keep the biggest brush size+ combined[key].size =+ aggregate(toBeCombinedProps, AGGREGATION_TYPES.maximum, p => p.size) ?? null;+ }+ }++ return combined;+}+function savedUnmergedInteraction<S extends VisState>(state: S,unmerged: Partial<SavedInteractionConfig>@@ -434,6 +496,7 @@ function replaceInteractionDatasetIds(interactionConfig, dataId: string, dataIdT}return null;}+/*** Merge splitMaps config with current visStete.* 1. if current map is split, but splitMap DOESNOT contain maps@@ -571,6 +634,15 @@ export function mergeLayerBlending<S extends VisState>(return state;}+/**+ * Combines multiple layer blending configs into a single string+ * by returning the one with the highest occurrence+ */+function combineLayerBlendingConfigs(configs: string[]): string | null {+ // return the mode of the layer blending type+ return getValueWithHighestOccurrence(configs);+}+/*** Merge overlayBlending with saved*/@@ -588,6 +660,15 @@ export function mergeOverlayBlending<S extends VisState>(return state;}+/**+ * Combines multiple overlay blending configs into a single string+ * by returning the one with the highest occurrence+ **/+function combineOverlayBlendingConfigs(configs: string[]): string | null {+ // return the mode of the overlay blending type+ return getValueWithHighestOccurrence(configs);+}+/*** Merge animation config*/@@ -609,6 +690,14 @@ export function mergeAnimationConfig<S extends VisState>(return state;}+function combineAnimationConfigs(configs: SavedAnimationConfig[]): SavedAnimationConfig {+ // get the smallest values of currentTime and speed among all configs+ return {+ currentTime: aggregate(configs, AGGREGATION_TYPES.minimum, c => c.currentTime) ?? null,+ speed: aggregate(configs, AGGREGATION_TYPES.minimum, c => c.speed) ?? null+ };+}+/*** Validate saved layer columns with new data,* update fieldIdx based on new fields@@ -944,6 +1033,24 @@ export function mergeEditor<S extends VisState>(state: S, savedEditor: SavedEdit};}+function combineEditorConfigs(configs: SavedEditor[]): SavedEditor {+ return configs.reduce(+ (acc, nextConfig) => {+ return {+ ...acc,+ features: [...acc.features, ...(nextConfig.features || [])]+ };+ },+ {+ // start with:+ // - empty array for features accumulation+ // - and are any of the configs' visible values true?+ features: [],+ visible: configs.some(c => c?.visible)+ }+ );+}+/*** Validate saved layer config with new data,* update fieldIdx based on new fields@@ -971,6 +1078,29 @@ export function mergeDatasetsByOrder(state: VisState, newDataEntries: Datasets):return merged;}+/**+ * Simliar purpose to aggregation utils `getMode` function,+ * but returns the mode in the same value type without coercing to a string.+ * It ignores `undefined` or `null` values, but returns `null` if no mode could be calculated.+ */+function getValueWithHighestOccurrence<T>(arr: T[]): T | null {+ const tallys = new Map();+ arr.forEach(value => {+ if (notNullorUndefined(value)) {+ if (!tallys.has(value)) {+ tallys.set(value, 1);+ } else {+ tallys.set(value, tallys.get(value) + 1);+ }+ }+ });+ // return the value with the highest total occurrence count+ if (tallys.size === 0) {+ return null;+ }+ return [...tallys.entries()]?.reduce((acc, next) => (next[1] > acc[1] ? next : acc))[0];+}+export const VIS_STATE_MERGERS: VisStateMergers<any> = [{merge: mergeLayers,@@ -994,11 +1124,16 @@ export const VIS_STATE_MERGERS: VisStateMergers<any> = [prop: 'interactionConfig',toMergeProp: 'interactionToBeMerged',replaceParentDatasetIds: replaceInteractionDatasetIds,- saveUnmerged: savedUnmergedInteraction+ saveUnmerged: savedUnmergedInteraction,+ combineConfigs: combineInteractionConfigs+ },+ {merge: mergeLayerBlending, prop: 'layerBlending', combineConfigs: combineLayerBlendingConfigs},+ {+ merge: mergeOverlayBlending,+ prop: 'overlayBlending',+ combineConfigs: combineOverlayBlendingConfigs},- {merge: mergeLayerBlending, prop: 'layerBlending'},- {merge: mergeOverlayBlending, prop: 'overlayBlending'},{merge: mergeSplitMaps, prop: 'splitMaps', toMergeProp: 'splitMapsToBeMerged'},- {merge: mergeAnimationConfig, prop: 'animationConfig'},- {merge: mergeEditor, prop: 'editor'}+ {merge: mergeAnimationConfig, prop: 'animationConfig', combineConfigs: combineAnimationConfigs},+ {merge: mergeEditor, prop: 'editor', combineConfigs: combineEditorConfigs}];diff --git a/src/schemas/src/vis-state-schema.ts b/src/schemas/src/vis-state-schema.tsindex 9e977babe..f5100925b 100644--- a/src/schemas/src/vis-state-schema.ts+++ b/src/schemas/src/vis-state-schema.ts@@ -117,6 +117,7 @@ export type Merger<S extends object> = {waitForLayerData?: boolean;replaceParentDatasetIds?: ReplaceParentDatasetIdsFunc<ValueOf<S>>;saveUnmerged?: (state: S, unmerged: any) => S;+ combineConfigs?: (configs: S[]) => S;getChildDatasetIds?: any;};export type VisStateMergers<S extends object> = Merger<S>[];diff --git a/src/types/schemas.d.ts b/src/types/schemas.d.tsindex e8bc93c9c..f0c31a84f 100644--- a/src/types/schemas.d.ts+++ b/src/types/schemas.d.ts@@ -3,7 +3,7 @@import {RGBColor, Merge, RequireFrom} from './types';-import {Filter, TooltipInfo, AnimationConfig, SplitMap, Feature} from './reducers';+import {Filter, InteractionConfig, AnimationConfig, SplitMap, Feature} from './reducers';import {LayerTextLabel} from './layers';@@ -30,16 +30,16 @@ export type MinSavedFilter = RequireFrom<SavedFilter, 'dataId' | 'id' | 'name' |export type ParsedFilter = SavedFilter | MinSavedFilter;export type SavedInteractionConfig = {- tooltip: TooltipInfo['config'] & {+ tooltip: InteractionConfig['tooltip']['config'] & {enabled: boolean;};- geocoder: TooltipInfo['geocoder'] & {+ geocoder: {enabled: boolean;};- brush: TooltipInfo['brush'] & {+ brush: InteractionConfig['brush']['config'] & {enabled: boolean;};- coordinate: TooltipInfo['coordinate'] & {+ coordinate: {enabled: boolean;};};diff --git a/test/node/reducers/vis-state-merger-combine-configs-test.spec.js b/test/node/reducers/vis-state-merger-combine-configs-test.spec.jsnew file mode 100644index 000000000..fa01ab56d--- /dev/null+++ b/test/node/reducers/vis-state-merger-combine-configs-test.spec.js@@ -0,0 +1,208 @@+import {VIS_STATE_MERGERS} from '@kepler.gl/reducers';++const TEST_CASES = [+ {+ testMessage:+ "interactionConfig (with input configs' tooltips.fieldsToShow with no repeated fields)",+ propName: 'interactionConfig',+ configsToMerge: [+ {+ tooltip: {+ enabled: true,+ fieldsToShow: {+ 'point-dataset': [+ {name: 'DateTime', format: null},+ {name: 'Latitude', format: null},+ {name: 'Longitude', format: null}+ ],+ 'trip-dataset': [{name: 'vendor', format: null}]+ },+ compareMode: true,+ compareType: 'absolute'+ },+ geocoder: {enabled: true},+ brush: {enabled: true, size: 0.5},+ coordinate: {enabled: false}+ },+ {+ tooltip: {+ enabled: true,+ fieldsToShow: {+ 'trip-dataset': [{name: 'customer', format: null}]+ },+ compareMode: true,+ compareType: 'relative'+ },+ geocoder: {enabled: true},+ brush: {enabled: true, size: 2},+ coordinate: {enabled: false}+ },+ {+ tooltip: {+ enabled: true,+ fieldsToShow: {},+ compareMode: true,+ compareType: 'relative'+ },+ geocoder: {enabled: false},+ brush: {enabled: true, size: 3},+ coordinate: {enabled: false}+ }+ ],+ expected: {+ tooltip: {+ enabled: true,+ fieldsToShow: {+ 'point-dataset': [+ {name: 'DateTime', format: null},+ {name: 'Latitude', format: null},+ {name: 'Longitude', format: null}+ ],+ 'trip-dataset': [+ {name: 'vendor', format: null},+ {name: 'customer', format: null}+ ]+ },+ compareMode: true,+ compareType: 'relative'+ },+ geocoder: {enabled: true},+ brush: {enabled: true, size: 3},+ coordinate: {enabled: false}+ }+ },+ {+ testMessage:+ "interactionConfig (with input configs' tooltips.fieldsToShow with some repeated fields)",+ propName: 'interactionConfig',+ configsToMerge: [+ {+ tooltip: {+ enabled: true,+ fieldsToShow: {+ 'point-dataset': [+ {name: 'DateTime', format: null},+ {name: 'Latitude', format: null},+ {name: 'Longitude', format: null}+ ],+ 'trip-dataset': [{name: 'vendor', format: null}]+ },+ compareMode: true,+ compareType: 'absolute'+ },+ geocoder: {enabled: true},+ brush: {enabled: true, size: 0.5},+ coordinate: {enabled: false}+ },+ {+ tooltip: {+ enabled: true,+ fieldsToShow: {+ 'trip-dataset': [+ {name: 'customer', format: null},+ {name: 'vendor', format: null}+ ],+ 'point-dataset': [+ {name: 'DateTime', format: null},+ {name: 'Latitude', format: null},+ {name: 'Longitude', format: null}+ ]+ },+ compareMode: true,+ compareType: 'relative'+ },+ geocoder: {enabled: true},+ brush: {enabled: true, size: 2},+ coordinate: {enabled: false}+ },+ {+ tooltip: {+ enabled: true,+ fieldsToShow: {},+ compareMode: true,+ compareType: 'relative'+ },+ geocoder: {enabled: false},+ brush: {enabled: true, size: 3},+ coordinate: {enabled: false}+ }+ ],+ expected: {+ tooltip: {+ enabled: true,+ fieldsToShow: {+ 'point-dataset': [+ {name: 'DateTime', format: null},+ {name: 'Latitude', format: null},+ {name: 'Longitude', format: null}+ ],+ 'trip-dataset': [+ {name: 'vendor', format: null},+ {name: 'customer', format: null}+ ]+ },+ compareMode: true,+ compareType: 'relative'+ },+ geocoder: {enabled: true},+ brush: {enabled: true, size: 3},+ coordinate: {enabled: false}+ }+ },+ {+ testMessage: 'layerBlending (with a majority of "additive" values)',+ propName: 'layerBlending',+ configsToMerge: ['normal', 'additive', 'additive'],+ expected: 'additive'+ },+ {+ testMessage: 'layerBlending (with all undefined or null values)',+ propName: 'layerBlending',+ configsToMerge: [undefined, null, undefined],+ expected: null+ },+ {+ testMessage: 'overlayBlending (with 3 unique values)',+ propName: 'overlayBlending',+ configsToMerge: ['normal', 'screen', 'darken'],+ expected: 'normal'+ },+ {+ testMessage: 'overlayBlending (with some undefined values)',+ propName: 'overlayBlending',+ configsToMerge: [undefined, 'darken', undefined, 'darken', 'screen', undefined],+ expected: 'darken'+ },+ {+ testMessage: 'animationConfig',+ propName: 'animationConfig',+ configsToMerge: [+ {currentTime: 500, speed: 1},+ {currentTime: 100, speed: 5}+ ],+ expected: {currentTime: 100, speed: 1}+ },+ {+ testMessage: 'editor',+ propName: 'editor',+ configsToMerge: [+ {features: [], visible: undefined},+ {features: [{foo: 'bar'}], visible: true},+ {features: [{foo: 'bar'}, {abc: 'def'}], visible: false}+ ],+ expected: {+ features: [{foo: 'bar'}, {foo: 'bar'}, {abc: 'def'}],+ visible: true+ }+ }+];++describe('VisStateMergers: combineConfigs', () => {+ test.each(TEST_CASES)('$testMessage', ({propName, configsToMerge, expected}) => {+ const {combineConfigs} = VIS_STATE_MERGERS.find(+ m => m.prop === propName && typeof m.combineConfigs === 'function'+ );++ expect(combineConfigs(configsToMerge)).toEqual(expected);+ });+});