Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Feat] add supportedFilterTypes to dataset (#1594)
Shan He782745620160
diff --git a/src/actions/actions.d.ts b/src/actions/actions.d.tsindex f3333413d..9acefec60 100644--- a/src/actions/actions.d.ts+++ b/src/actions/actions.d.ts@@ -48,6 +48,7 @@ export type ProtoDataset = {// table-injected metadatametadata?: any;+ supportedFilterTypes?: string[];};export type AddDataToMapOptions = {diff --git a/src/components/filters/filter-panels/filter-panel-with-field-select.js b/src/components/filters/filter-panels/filter-panel-with-field-select.jsindex 6dc8f97f8..708d1e4ce 100644--- a/src/components/filters/filter-panels/filter-panel-with-field-select.js+++ b/src/components/filters/filter-panels/filter-panel-with-field-select.js@@ -24,6 +24,7 @@ import FilterPanelHeaderFactory from 'components/side-panel/filter-panel/filter-import PanelHeaderActionFactory from 'components/side-panel/panel-header-action';import SourceDataSelectorFactory from 'components/side-panel/common/source-data-selector';import FieldSelectorFactory from '../../common/field-selector';+import {getSupportedFilterFields} from './new-filter-panel';FieldPanelWithFieldSelectFactory.deps = [FilterPanelHeaderFactory,@@ -65,18 +66,23 @@ function FieldPanelWithFieldSelectFactory([filter.name]);+ const dataset = datasets[filter.dataId[0]];+ const supportedFields = useMemo(+ () => getSupportedFilterFields(dataset.supportedFilterTypes, allAvailableFields),+ [dataset.supportedFilterTypes, allAvailableFields]+ );return (<><FilterPanelHeader- datasets={[datasets[filter.dataId[0]]]}- allAvailableFields={allAvailableFields}+ datasets={[dataset]}+ allAvailableFields={supportedFields}idx={idx}filter={filter}removeFilter={removeFilter}><FieldSelectorinputTheme="secondary"- fields={allAvailableFields}+ fields={supportedFields}value={fieldValue}erasable={false}onSelect={onFieldSelector}diff --git a/src/components/filters/filter-panels/new-filter-panel.js b/src/components/filters/filter-panels/new-filter-panel.jsindex 960dbc2bc..28ef5f024 100644--- a/src/components/filters/filter-panels/new-filter-panel.js+++ b/src/components/filters/filter-panels/new-filter-panel.js@@ -18,7 +18,7 @@// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN// THE SOFTWARE.-import React, {useCallback} from 'react';+import React, {useCallback, useMemo} from 'react';import {StyledFilterContent} from 'components/common/styled-components';import FilterPanelHeaderFactory from 'components/side-panel/filter-panel/filter-panel-header';import SourceDataSelectorFactory from 'components/side-panel/common/source-data-selector';@@ -30,6 +30,12 @@ NewFilterPanelFactory.deps = [FieldSelectorFactory];+export function getSupportedFilterFields(supportedFilterTypes, fields) {+ return supportedFilterTypes+ ? fields.filter(field => supportedFilterTypes.includes(field.type))+ : fields;+}+function NewFilterPanelFactory(FilterPanelHeader, SourceDataSelector, FieldSelector) {/** @type {import('./filter-panel-types').FilterPanelComponent} */const NewFilterPanel = React.memo(@@ -44,11 +50,17 @@ function NewFilterPanelFactory(FilterPanelHeader, SourceDataSelector, FieldSelecsetFilter]);+ const dataset = datasets[filter.dataId[0]];+ const supportedFields = useMemo(+ () => getSupportedFilterFields(dataset.supportedFilterTypes, allAvailableFields),+ [dataset.supportedFilterTypes, allAvailableFields]+ );+return (<><FilterPanelHeader- datasets={[datasets[filter.dataId[0]]]}- allAvailableFields={allAvailableFields}+ datasets={[dataset]}+ allAvailableFields={supportedFields}idx={idx}filter={filter}removeFilter={removeFilter}@@ -57,7 +69,7 @@ function NewFilterPanelFactory(FilterPanelHeader, SourceDataSelector, FieldSelec><FieldSelectorinputTheme="secondary"- fields={allAvailableFields}+ fields={supportedFields}value={Array.isArray(filter.name) ? filter.name[0] : filter.name}erasable={false}onSelect={onFieldSelector}diff --git a/src/components/side-panel/filter-panel/filter-panel.js b/src/components/side-panel/filter-panel/filter-panel.jsindex 27924e1f6..9951e8f9c 100644--- a/src/components/side-panel/filter-panel/filter-panel.js+++ b/src/components/side-panel/filter-panel/filter-panel.js@@ -25,7 +25,6 @@ import styled from 'styled-components';import get from 'lodash.get';import {ALL_FIELD_TYPES, FILTER_TYPES} from 'constants/default-settings';-import FilterPanelHeaderFactory from 'components/side-panel/filter-panel/filter-panel-header';import NewFilterPanelFactory from 'components/filters/filter-panels/new-filter-panel';import TimeRangeFilterPanelFactory from 'components/filters/filter-panels/time-range-filter-panel';import SingleSelectFilterPanelFactory from 'components/filters/filter-panels/single-select-filter-panel';@@ -39,7 +38,6 @@ const StyledFilterPanel = styled.div``;FilterPanelFactory.deps = [- FilterPanelHeaderFactory,NewFilterPanelFactory,TimeRangeFilterPanelFactory,SingleSelectFilterPanelFactory,@@ -49,7 +47,6 @@ FilterPanelFactory.deps = [];function FilterPanelFactory(- FilterPanelHeader,NewFilterPanel,TimeRangeFilterPanel,SingleSelectFilterPanel,diff --git a/src/reducers/vis-state-updaters.js b/src/reducers/vis-state-updaters.jsindex 1106470ae..5fd74dcb6 100644--- a/src/reducers/vis-state-updaters.js+++ b/src/reducers/vis-state-updaters.js@@ -1322,9 +1322,9 @@ export const updateVisDataUpdater = (state, action) => {const datasets = toArray(action.datasets);const newDataEntries = datasets.reduce(- (accu, {info = {}, data, metadata} = {}) => ({+ (accu, {info = {}, ...rest} = {}) => ({...accu,- ...(createNewDataEntry({info, data, metadata}, state.datasets) || {})+ ...(createNewDataEntry({info, ...rest}, state.datasets) || {})}),{});diff --git a/src/utils/dataset-utils.js b/src/utils/dataset-utils.jsindex 9ab110081..a98caaec0 100644--- a/src/utils/dataset-utils.js+++ b/src/utils/dataset-utils.js@@ -76,7 +76,7 @@ export function getNewDatasetColor(datasets) {* Take datasets payload from addDataToMap, create datasets entry save to visState* @type {typeof import('./dataset-utils').createNewDataEntry}*/-export function createNewDataEntry({info, data, metadata}, datasets = {}) {+export function createNewDataEntry({info, data, ...opts}, datasets = {}) {const validatedData = validateInputData(data);if (!validatedData) {return {};@@ -85,7 +85,7 @@ export function createNewDataEntry({info, data, metadata}, datasets = {}) {info = info || {};const color = info.color || getNewDatasetColor(datasets);- const keplerTable = new KeplerTable({info, data: validatedData, color, metadata});+ const keplerTable = new KeplerTable({info, data: validatedData, color, ...opts});return {[keplerTable.id]: keplerTable};diff --git a/src/utils/filter-utils.d.ts b/src/utils/filter-utils.d.tsindex 2b6419d25..be96a7c8d 100644--- a/src/utils/filter-utils.d.ts+++ b/src/utils/filter-utils.d.ts@@ -133,6 +133,8 @@ export function getHistogram(export function getNumericStepSize(diff: number): number;+export function formatNumberByStep(val: number, step: number, bound: 'floor' | 'ceil'): number;+export function mergeFilterDomainStep(filter: Filter, filterProps?: any): Filter | null;export function getFilterProps(diff --git a/src/utils/gpu-filter-utils.d.ts b/src/utils/gpu-filter-utils.d.tsindex 1c4cc3c15..3dcda5d8e 100644--- a/src/utils/gpu-filter-utils.d.ts+++ b/src/utils/gpu-filter-utils.d.ts@@ -23,6 +23,6 @@ import {Filter, Field, GpuFilter} from 'reducers/vis-state-updaters';export function setFilterGpuMode(filter: Filter, filters: Filter[]): Filter;export function assignGpuChannel(filter: Filter, filters: Filter[]): Filter;export function assignGpuChannels(allFilters: Filter[]): Filter[];-export function resetFilterGpuMode( filters: Filter[]): Filter[];+export function resetFilterGpuMode(filters: Filter[]): Filter[];export function getGpuFilterProps(filters: Filter[], dataId: string, fields: Field[]): GpuFilter;export function getDatasetFieldIndexForFilter(dataId: string, filter: Filter): number;diff --git a/src/utils/index.js b/src/utils/index.jsindex a8af3cb8a..55ef2afce 100644--- a/src/utils/index.js+++ b/src/utils/index.js@@ -36,7 +36,9 @@ export {applyFiltersToDatasets,validateFilterWithData,validateFiltersUpdateDatasets,- getIntervalBins+ getIntervalBins,+ getNumericStepSize,+ formatNumberByStep} from 'utils/filter-utils';export {resetFilterGpuMode, assignGpuChannels} from 'utils/gpu-filter-utils';diff --git a/src/utils/table-utils/kepler-table.d.ts b/src/utils/table-utils/kepler-table.d.tsindex 60806df07..eea96c225 100644--- a/src/utils/table-utils/kepler-table.d.ts+++ b/src/utils/table-utils/kepler-table.d.ts@@ -25,14 +25,8 @@ export type GpuFilter = {dc: DataContainerInterface) => (getIndex?: (any) => number,- getData?: (- dc: DataContainerInterface,- d: any,- fieldIndex: number- ) => any- ) => (- d: any- ) => number;+ getData?: (dc: DataContainerInterface, d: any, fieldIndex: number) => any+ ) => (d: any) => number;};export type FieldPair = {@@ -65,8 +59,16 @@ export function sortDatasetByColumn(dataset: Dataset, column: string, mode?: strexport function findPointFieldPairs(fields: Field[]): FieldPair[];export class KeplerTable {- constructor(schema: {info?: object; data: any; color: RGBColor; metadata: any});- id: string;+ readonly id: string;++ constructor(schema: {+ info?: ProtoDataset['info'];+ data: ProtoDataset['data'];+ color: RGBColor;+ metadata?: ProtoDataset['metadata'];+ supportedFilterTypes?: ProtoDataset['supportedFilterTypes'];+ });+ type?: string;label?: string;color: RGBColor;@@ -93,6 +95,7 @@ export class KeplerTable {sortOrder?: number[] | null;pinnedColumns?: string[];+ supportedFilterTypes?: string[];// table-injected metadatametadata?: object;diff --git a/src/utils/table-utils/kepler-table.js b/src/utils/table-utils/kepler-table.jsindex 1c1869e5a..25330055a 100644--- a/src/utils/table-utils/kepler-table.js+++ b/src/utils/table-utils/kepler-table.js@@ -55,7 +55,7 @@ const FID_KEY = 'name';* @type {KeplerTableClass}*/class KeplerTable {- constructor({info = {}, data, color, metadata}) {+ constructor({info = {}, data, color, metadata, supportedFilterTypes}) {// TODO - what to do if validation fails? Can kepler handle exceptions?// const validatedData = validateInputData(data);// if (!validatedData) {@@ -104,6 +104,9 @@ class KeplerTable {this.fieldPairs = findPointFieldPairs(fields);this.fields = fields;this.gpuFilter = getGpuFilterProps([], dataId, fields);+ if (supportedFilterTypes) {+ this.supportedFilterTypes = supportedFilterTypes;+ }}/**diff --git a/test/browser/components/side-panel/filter-manager-test.js b/test/browser/components/side-panel/filter-manager-test.jsindex b011f0416..ea713d8c1 100644--- a/test/browser/components/side-panel/filter-manager-test.js+++ b/test/browser/components/side-panel/filter-manager-test.js@@ -25,19 +25,31 @@ import {FilterManagerFactory,SourceDataCatalogFactory,FilterPanelFactory,- Button+ FieldSelectorFactory,+ Button,+ FilterPanelHeaderFactory} from 'components';+import NewFilterPanelFactory from 'components/side-panel/filter-panel/filter-panel';+import {appInjector} from 'components/container';import {mountWithTheme, IntlWrapper} from 'test/helpers/component-utils';+import keplerGlReducer from 'reducers/core';+import * as VisStateActions from 'actions/vis-state-actions';+import {testFields, testAllData} from 'test/fixtures/test-csv-data';+import {ALL_FIELD_TYPES} from 'constants/default-settings';+import {assertDatasetIsTable} from '../../../helpers/comparison-utils';// componentsconst FilterManager = appInjector.get(FilterManagerFactory);const SourceDataCatalog = appInjector.get(SourceDataCatalogFactory);const FilterPanel = appInjector.get(FilterPanelFactory);+const NewFilterPanel = appInjector.get(NewFilterPanelFactory);+const FilterPanelHeader = appInjector.get(FilterPanelHeaderFactory);+const FieldSelector = appInjector.get(FieldSelectorFactory);// mock state-import {StateWFilters} from 'test/helpers/mock-state';+import {StateWFilters, InitialState, applyActions, csvInfo} from 'test/helpers/mock-state';const nop = () => {};// default props from initial state@@ -142,3 +154,77 @@ test('Components -> FilterManager.mount -> with prop', t => {t.end();});++test('Components -> FilterManager.mount -> with supportedFilterTypes', t => {+ // load csv and geojson+ const updatedState = applyActions(keplerGlReducer, InitialState, [+ {+ action: VisStateActions.updateVisData,+ payload: [+ [+ {+ info: csvInfo,+ data: {fields: testFields, rows: testAllData},+ supportedFilterTypes: [ALL_FIELD_TYPES.real, ALL_FIELD_TYPES.integer]+ }+ ]+ ]+ }+ ]);++ const {visState} = updatedState;+ // test dataset is table+ assertDatasetIsTable(t, visState.datasets[csvInfo.id]);+ t.deepEqual(+ visState.datasets[csvInfo.id].supportedFilterTypes,+ [ALL_FIELD_TYPES.real, ALL_FIELD_TYPES.integer],+ 'supportedFilterTypes should be correct'+ );++ // call addFilter+ const stateWithEmptyFilter = keplerGlReducer(updatedState, VisStateActions.addFilter(csvInfo.id));+ // mount filter panel+ // components+ const props = {+ filters: stateWithEmptyFilter.visState.filters,+ datasets: stateWithEmptyFilter.visState.datasets,+ layers: stateWithEmptyFilter.visState.layers,+ showDatasetTable: nop,+ visStateActions: {+ addFilter: nop,+ setFilter: nop,+ removeFilter: nop,+ enlargeFilter: nop,+ toggleAnimation: nop,+ toggleFilterFeature: nop+ }+ };++ let wrapper;+ t.doesNotThrow(() => {+ wrapper = mountWithTheme(+ <IntlWrapper>+ <FilterManager {...props} />+ </IntlWrapper>+ );+ }, 'FilterManager should not fail when mount with dataset.supportedFilterTypes');++ t.ok(wrapper.find(FilterPanel).length === 1, 'should render 1 FilterPanel');+ t.ok(wrapper.find(NewFilterPanel).length === 1, 'should render 1 NewFilterPanel');+ t.ok(wrapper.find(FilterPanelHeader).length === 1, 'should render 1 FilterPanelHeader');+ t.ok(wrapper.find(FieldSelector).length === 1, 'should render FieldSelector');++ // check field options+ const fieldOptions = wrapper+ .find(FieldSelector)+ .at(0)+ .props().fields;++ t.deepEqual(+ fieldOptions.map(f => f.name),+ ['gps_data.lat', 'gps_data.lng', 'id'],+ 'should only pass real / integer fields'+ );++ t.end();+});diff --git a/test/helpers/comparison-utils.js b/test/helpers/comparison-utils.jsindex 77403d4db..08b59e585 100644--- a/test/helpers/comparison-utils.js+++ b/test/helpers/comparison-utils.js@@ -20,6 +20,7 @@import {FILTER_TYPES} from 'constants/default-settings';import {toArray} from '../../src/utils/utils';+import KeplerTable from '../../src/utils/table-utils/kepler-table';export function cmpObjectKeys(t, expectedObj, actualObj, name) {t.deepEqual(@@ -222,6 +223,9 @@ export function cmpDatasets(t, expectedDatasets, actualDatasets) {cmpDataset(t, expectedDatasets[dataId], actualDatasets[dataId]);});}+export function assertDatasetIsTable(t, dataset) {+ t.ok(dataset instanceof KeplerTable, `${dataset.label || 'dataset'} should be a KeplerTable`);+}export function cmpDataset(t, expectedDataset, actualDataset, opt = {}) {cmpObjectKeys(t, expectedDataset, actualDataset, `dataset:${expectedDataset.id}`);