Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Enhancement] Layer config: Add column validators (#1287)
Shan Hed882ba096d93
diff --git a/src/components/side-panel/layer-panel/layer-column-config.js b/src/components/side-panel/layer-panel/layer-column-config.jsindex 2c1197568..01d579a5c 100644--- a/src/components/side-panel/layer-panel/layer-column-config.js+++ b/src/components/side-panel/layer-panel/layer-column-config.js@@ -25,7 +25,8 @@ import {FormattedMessage} from 'localization';import {createSelector} from 'reselect';import {PanelLabel, SidePanelSection} from 'components/common/styled-components';-import FieldSelectorFactory from '../../common/field-selector';+import FieldSelectorFactory from 'components/common/field-selector';+import {validateColumn} from 'reducers/vis-state-merger';const TopRow = styled.div`display: flex;@@ -91,6 +92,7 @@ function LayerColumnConfigFactory(ColumnSelector) {{Object.keys(columns).map(key => (<ColumnSelectorcolumn={columns[key]}+ columns={columns}label={(columnLabels && columnLabels[key]) || key}key={key}allFields={fields}@@ -108,7 +110,7 @@ function LayerColumnConfigFactory(ColumnSelector) {}ColumnSelectorFactory.deps = [FieldSelectorFactory];function ColumnSelectorFactory(FieldSelector) {- const ColumnSelector = ({column, label, allFields, onSelect, fieldPairs}) => (+ const ColumnSelector = ({column, columns, label, allFields, onSelect, fieldPairs}) => (<ColumnRow className="layer-config__column__selector"><ColumnName className="layer-config__column__name"><PanelLabel>@@ -119,7 +121,7 @@ function ColumnSelectorFactory(FieldSelector) {<ColumnSelect className="layer-config__column__select"><FieldSelectorsuggested={fieldPairs}- error={!column.optional && !column.value}+ error={!validateColumn(column, columns, allFields)}fields={allFields}value={column.value}erasable={Boolean(column.optional)}diff --git a/src/layers/base-layer.js b/src/layers/base-layer.jsindex f88c7c545..bc4673d67 100644--- a/src/layers/base-layer.js+++ b/src/layers/base-layer.js@@ -511,10 +511,13 @@ export default class Layer {}getLayerColumns() {+ const columnValidators = this.columnValidators || {};const required = this.requiredLayerColumns.reduce((accu, key) => ({...accu,- [key]: {value: null, fieldIdx: -1}+ [key]: columnValidators[key]+ ? {value: null, fieldIdx: -1, validator: columnValidators[key]}+ : {value: null, fieldIdx: -1}}),{});diff --git a/src/reducers/vis-state-merger.js b/src/reducers/vis-state-merger.jsindex a966366d9..6828949b0 100644--- a/src/reducers/vis-state-merger.js+++ b/src/reducers/vis-state-merger.js@@ -356,28 +356,44 @@ export function mergeAnimationConfig(state, animation) {* @return {null | Object} - validated columns or null*/-export function validateSavedLayerColumns(fields, savedCols, emptyCols) {- const colFound = {};- // find actual column fieldIdx, in case it has changed- const allColFound = Object.keys(emptyCols).every(key => {- const saved = savedCols[key];- colFound[key] = {...emptyCols[key]};+export function validateSavedLayerColumns(fields, savedCols = {}, emptyCols) {+ // Prepare columns for the validator+ const columns = {};+ for (const key of Object.keys(emptyCols)) {+ columns[key] = {...emptyCols[key]};- // TODO: replace with new approach- const fieldIdx = fields.findIndex(({name}) => name === saved);+ const saved = savedCols[key];+ if (saved) {+ const fieldIdx = fields.findIndex(({name}) => name === saved);- if (fieldIdx > -1) {- // update found columns- colFound[key].fieldIdx = fieldIdx;- colFound[key].value = saved;- return true;+ if (fieldIdx > -1) {+ // update found columns+ columns[key].fieldIdx = fieldIdx;+ columns[key].value = saved;+ }}+ }- // if col is optional, allow null value- return emptyCols[key].optional || false;- });+ // find actual column fieldIdx, in case it has changed+ const allColFound = Object.keys(columns).every(key =>+ validateColumn(columns[key], columns, fields)+ );++ if (allColFound) {+ return columns;+ }- return allColFound && colFound;+ return null;+}++export function validateColumn(column, columns, allFields) {+ if (column.optional || column.value) {+ return true;+ }+ if (column.validator) {+ return column.validator(column, columns, allFields);+ }+ return false;}/**diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.jsindex 2689d388a..b4db4f1d0 100644--- a/test/node/reducers/vis-state-test.js+++ b/test/node/reducers/vis-state-test.js@@ -1442,7 +1442,7 @@ test('#visStateReducer -> UPDATE_VIS_DATA -> mergeFilters', t => {metadata: {id: 'smoothie',label: 'smoothie and milkshake',- format: ''+ format: ''},fields: expectedFields.map(f =>f.name === mockFilter.name