Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Bug] fix tooltip config, add boolean formatter (#1216)
Shan He8b782122f755
diff --git a/package.json b/package.jsonindex 7ecce734d..6ea1717a8 100644--- a/package.json+++ b/package.json@@ -24,7 +24,7 @@"fast-test": "npm run test-node && npm run test-browser","test-browser": "NODE_ENV=test babel-tape-runner -r ./test/setup-browser-env.js ./test/browser/index.js | tap-spec","test-node": "NODE_ENV=test babel-tape-runner ./test/node.js | tap-spec",- "test-browser-headless": "NODE_ENV=test node ./test/browser-drive.js",+ "test-browser-drive": "NODE_ENV=test node ./test/browser-drive.js","test-e2e": "NODE_ENV=test HEADLESS=true SLOWMO=true jest","test": "npm run lint && npm run test-node && npm run test-browser","cover": "nyc --reporter html --reporter cobertura --reporter json-summary npm test && nyc report",diff --git a/src/components/common/field-selector.js b/src/components/common/field-selector.jsindex 0ffc9624a..610b1f3e3 100644--- a/src/components/common/field-selector.js+++ b/src/components/common/field-selector.js@@ -39,7 +39,7 @@ const StyledToken = styled.div`// custom list Itemexport const FieldListItemFactory = (showToken = true) => {const FieldListItem = ({value, displayOption = defaultDisplayOption}) => (- <div>+ <div className="field-selector_list-item">{showToken ? (<StyledToken><FieldToken type={value.type} />@@ -113,16 +113,15 @@ class FieldSelector extends Component {showTokenSelector = props => props.showToken;selectedItemsSelector = createSelector(this.fieldsSelector, this.valueSelector, (fields, value) =>- fields.filter(f =>- Boolean(- toArray(value).find(d => {- if (!notNullorUndefined(d)) {- return false;- }- return d.name ? d.name === defaultDisplayOption(f) : d === defaultDisplayOption(f);- })+ toArray(value)+ .map(d =>+ fields.find(f =>+ notNullorUndefined(d) && d.name+ ? d.name === defaultDisplayOption(f)+ : d === defaultDisplayOption(f)+ ))- )+ .filter(d => d));fieldOptionsSelector = createSelector(@@ -146,7 +145,7 @@ class FieldSelector extends Component {getOptionValue={d => d}closeOnSelect={this.props.closeOnSelect}displayOption={defaultDisplayOption}- filterOption={'id'}+ filterOption="name"fixedOptions={this.props.suggested}inputTheme={this.props.inputTheme}isError={this.props.error}diff --git a/src/components/common/item-selector/item-selector.js b/src/components/common/item-selector/item-selector.jsindex 9408f2a6d..c78d4fb32 100644--- a/src/components/common/item-selector/item-selector.js+++ b/src/components/common/item-selector/item-selector.js@@ -174,7 +174,6 @@ class ItemSelector extends Component {if (this.props.multiSelect) {const items = uniqBy(previousSelected.concat(toArray(item)), getValue);-this.props.onChange(items);} else {this.props.onChange(getValue(item));diff --git a/src/components/geocoder-panel.js b/src/components/geocoder-panel.jsindex 152c9352d..c5db7afd3 100644--- a/src/components/geocoder-panel.js+++ b/src/components/geocoder-panel.js@@ -28,7 +28,7 @@ import KeplerGlSchema from 'schemas';import Geocoder from './geocoder/geocoder';import {- GEOCODER_DATASET_NAME,+ GEOCODER_DATASET_NAME,GEOCODER_LAYER_ID,GEOCODER_GEO_OFFSET,GEOCODER_ICON_COLOR,diff --git a/src/components/side-panel/interaction-panel/tooltip-config.js b/src/components/side-panel/interaction-panel/tooltip-config.jsindex a81754705..549c9bb70 100644--- a/src/components/side-panel/interaction-panel/tooltip-config.js+++ b/src/components/side-panel/interaction-panel/tooltip-config.js@@ -101,12 +101,21 @@ function TooltipConfigFactory(DatasetTag) {<FieldSelectorfields={datasets[dataId].fields}value={config.fieldsToShow[dataId]}- onSelect={fieldsToShow => {+ onSelect={selected => {const newConfig = {...config,fieldsToShow: {...config.fieldsToShow,- [dataId]: fieldsToShow+ [dataId]: selected.map(+ f =>+ config.fieldsToShow[dataId].find(+ tooltipField => tooltipField.name === f.name+ ) || {+ name: f.name,+ // default initial tooltip is null+ format: null+ }+ )}};onChange(newConfig);diff --git a/src/components/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.js b/src/components/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.jsindex 9c41e9df5..d3069b54b 100644--- a/src/components/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.js+++ b/src/components/side-panel/interaction-panel/tooltip-config/tooltip-chicklet.js@@ -71,7 +71,9 @@ const hashStyles = {ACTIVE: 'ACTIVE'};-const IconDiv = styled.div`+const IconDiv = styled.div.attrs({+ className: 'tooltip-chicklet__icon'+})`color: ${props =>props.status === hashStyles.SHOW? props.theme.subtextColorActive@@ -79,6 +81,18 @@ const IconDiv = styled.div`? props.theme.activeColor: props.theme.textColor};`;++function getFormatTooltip(formatLabels, format) {+ if (!format) {+ return null;+ }+ const formatLabel = formatLabels.find(fl => getValue(fl) === format);+ if (formatLabel) {+ return formatLabel.label;+ }+ return typeof format === 'object' ? JSON.stringify(format, null, 2) : String(format);+}+function TooltipChickletFactory(dataId, config, onChange, fields) {class TooltipChicklet extends Component {state = {@@ -103,11 +117,13 @@ function TooltipChickletFactory(dataId, config, onChange, fields) {render() {const {disabled, name, remove} = this.props;const {show} = this.state;- const field = config.fieldsToShow[dataId].find(fieldToShow => fieldToShow.name === name);- const formatLabels = getFormatLabels(fields, field.name);- let selectionIndex = formatLabels.findIndex(fl => getValue(fl) === field.format);- if (selectionIndex < 0) selectionIndex = 0;- const hashStyle = show ? hashStyles.SHOW : selectionIndex ? hashStyles.ACTIVE : null;+ const tooltipField = config.fieldsToShow[dataId].find(+ fieldToShow => fieldToShow.name === name+ );+ const formatLabels = getFormatLabels(fields, tooltipField.name);+ const hasFormat = Boolean(tooltipField.format);+ const selectionIndex = formatLabels.findIndex(fl => getValue(fl) === tooltipField.format);+ const hashStyle = show ? hashStyles.SHOW : hasFormat ? hashStyles.ACTIVE : null;return (<ChickletButton ref={node => (this.node = node)}>@@ -126,7 +142,9 @@ function TooltipChickletFactory(dataId, config, onChange, fields) {</IconDiv><Tooltip id={`addon-${name}`} effect="solid"><span>- {(selectionIndex && formatLabels[selectionIndex]).label || (+ {hasFormat ? (+ getFormatTooltip(formatLabels, tooltipField.format)+ ) : (<FormattedMessage id={'fieldSelector.formatting'} />)}</span>diff --git a/src/constants/default-settings.js b/src/constants/default-settings.jsindex fc3e3768a..1a0fbb1d5 100644--- a/src/constants/default-settings.js+++ b/src/constants/default-settings.js@@ -535,7 +535,11 @@ export const FIELD_OPTS = {},format: {legend: d => d,- tooltip: [TOOLTIP_FORMAT_TYPES.DECIMAL, TOOLTIP_FORMAT_TYPES.PERCENTAGE]+ tooltip: [+ TOOLTIP_FORMAT_TYPES.NONE,+ TOOLTIP_FORMAT_TYPES.DECIMAL,+ TOOLTIP_FORMAT_TYPES.PERCENTAGE+ ]}},timestamp: {@@ -546,7 +550,11 @@ export const FIELD_OPTS = {},format: {legend: d => d,- tooltip: [TOOLTIP_FORMAT_TYPES.DATE, TOOLTIP_FORMAT_TYPES.DATE_TIME]+ tooltip: [+ TOOLTIP_FORMAT_TYPES.NONE,+ TOOLTIP_FORMAT_TYPES.DATE,+ TOOLTIP_FORMAT_TYPES.DATE_TIME+ ]}},integer: {@@ -557,7 +565,11 @@ export const FIELD_OPTS = {},format: {legend: d => d,- tooltip: [TOOLTIP_FORMAT_TYPES.DECIMAL, TOOLTIP_FORMAT_TYPES.PERCENTAGE]+ tooltip: [+ TOOLTIP_FORMAT_TYPES.NONE,+ TOOLTIP_FORMAT_TYPES.DECIMAL,+ TOOLTIP_FORMAT_TYPES.PERCENTAGE+ ]}},boolean: {@@ -568,7 +580,7 @@ export const FIELD_OPTS = {},format: {legend: d => d,- tooltip: []+ tooltip: [TOOLTIP_FORMAT_TYPES.NONE, TOOLTIP_FORMAT_TYPES.BOOLEAN]}},date: {@@ -578,7 +590,7 @@ export const FIELD_OPTS = {},format: {legend: d => d,- tooltip: [TOOLTIP_FORMAT_TYPES.DATE]+ tooltip: [TOOLTIP_FORMAT_TYPES.NONE, TOOLTIP_FORMAT_TYPES.DATE]}},geojson: {@@ -809,7 +821,6 @@ export const GEOCODER_GEO_OFFSET = 0.05;export const GEOCODER_ICON_COLOR = [255, 0, 0];export const GEOCODER_ICON_SIZE = 80;-// We could use directly react-map-gl-draw EditorMode but this would// create a direct dependency with react-map-gl-draw// Created this map to be independent from react-map-gl-drawdiff --git a/src/constants/tooltip.js b/src/constants/tooltip.jsindex 8d2a138f5..163642c6a 100644--- a/src/constants/tooltip.js+++ b/src/constants/tooltip.js@@ -19,10 +19,12 @@// THE SOFTWARE.export const TOOLTIP_FORMAT_TYPES = {+ NONE: 'none',DATE: 'date',DATE_TIME: 'date_time',DECIMAL: 'decimal',- PERCENTAGE: 'percentage'+ PERCENTAGE: 'percentage',+ BOOLEAN: 'boolean'};export const TOOLTIP_KEY = 'format';@@ -30,7 +32,9 @@ export const TOOLTIP_KEY = 'format';export const TOOLTIP_FORMATS = {NONE: {id: 'NONE',- label: 'None'+ label: 'None',+ format: null,+ type: TOOLTIP_FORMAT_TYPES.NONE},DECIMAL_SHORT: {id: 'DECIMAL_SHORT',@@ -163,10 +167,22 @@ export const TOOLTIP_FORMATS = {},DATE_TIME_LTS: {// 12:00:00 AM- id: 'DATE_TIME',+ id: 'DATE_TIME_LTS',label: '',format: 'LTS',type: TOOLTIP_FORMAT_TYPES.DATE_TIME+ },+ BOOLEAN_NUM: {+ id: 'BOOLEAN_NUM',+ label: '0 | 1',+ format: '01',+ type: TOOLTIP_FORMAT_TYPES.BOOLEAN+ },+ BOOLEAN_Y_N: {+ id: 'BOOLEAN_Y_N',+ label: 'yes | no',+ format: 'yn',+ type: TOOLTIP_FORMAT_TYPES.BOOLEAN}};diff --git a/src/utils/data-utils.js b/src/utils/data-utils.jsindex d4a32c0f4..96ba4a954 100644--- a/src/utils/data-utils.js+++ b/src/utils/data-utils.js@@ -368,11 +368,23 @@ export function applyDefaultFormat(tooltipFormat) {return v => moment.utc(v).format(tooltipFormat.format);case TOOLTIP_FORMAT_TYPES.PERCENTAGE:return v => `${d3Format(TOOLTIP_FORMATS.DECIMAL_DECIMAL_FIXED_2.format)(v)}%`;+ case TOOLTIP_FORMAT_TYPES.BOOLEAN:+ return getBooleanFormatter(tooltipFormat.format);default:return defaultFormatter;}}+export function getBooleanFormatter(format) {+ switch (format) {+ case '01':+ return v => (v ? '1' : '0');+ case 'yn':+ return v => (v ? 'yes' : 'no');+ default:+ return defaultFormatter;+ }+}// Allow user to specify custom tooltip format via configexport function applyCustomFormat(format, field) {switch (field.type) {diff --git a/test/browser/components/tooltip-config-test.js b/test/browser/components/tooltip-config-test.jsindex e23a3b0b9..dcd65a842 100644--- a/test/browser/components/tooltip-config-test.js+++ b/test/browser/components/tooltip-config-test.js@@ -21,44 +21,233 @@import React from 'react';import sinon from 'sinon';import test from 'tape';+import uniq from 'lodash.uniq';+import {IntlWrapper, mountWithTheme} from 'test/helpers/component-utils';import TooltipConfigFactory from 'components/side-panel/interaction-panel/tooltip-config';-import {StateWTrips} from 'test/helpers/mock-state';+import DatasetTagFactory from 'components/side-panel/common/dataset-tag';+import FieldSelector from 'components/common/field-selector';+import ChickletedInput from 'components/common/item-selector/chickleted-input';+import {ChickletButton} from 'components/common/item-selector/chickleted-input';+import DropdownList from 'components/common/item-selector/dropdown-list';+import Typeahead from 'components/common/item-selector/typeahead';++import {Hash, Delete} from 'components/common/icons';+import {StateWFiles} from 'test/helpers/mock-state';+import {appInjector} from 'components/container';++const TooltipConfig = appInjector.get(TooltipConfigFactory);+const DatasetTag = appInjector.get(DatasetTagFactory);++// const tooltipConfig = {+// fieldsToShow: {+// '190vdll3di': [+// {name: 'gps_data.utc_timestamp', format: null},+// {name: 'gps_data.types', format: null},+// {name: 'epoch', format: null},+// {name: 'has_result', format: null},+// {name: 'id', format: null}+// ],+// ieukmgne: [+// {name: 'OBJECTID', format: null},+// {name: 'ZIP_CODE', format: null},+// {name: 'ID', format: null},+// {name: 'TRIPS', format: null},+// {name: 'RATE', format: null}+// ]+// },+// compareMode: false,+// compareType: 'absolute'+// };test('TooltipConfig - render', t => {- const DataSetTag = () => <div className="dataset-tag" />;- const TooltipConfig = TooltipConfigFactory(DataSetTag);- const datasets = StateWTrips.visState.datasets;- const config = {+ const datasets = StateWFiles.visState.datasets;+ const tooltipConfig = StateWFiles.visState.interactionConfig.tooltip.config;++ const onChange = sinon.spy();+ let wrapper;++ t.doesNotThrow(() => {+ wrapper = mountWithTheme(+ <IntlWrapper>+ <TooltipConfig onChange={onChange} config={tooltipConfig} datasets={datasets} />+ </IntlWrapper>+ );+ }, 'Should render');++ t.equal(wrapper.find(TooltipConfig).length, 1, 'Should render 1 TooltipConfig');+ t.equal(wrapper.find(DatasetTag).length, 2, 'Should render 2 DatasetTag');+ t.equal(wrapper.find(FieldSelector).length, 2, 'Should render 2 FieldSelector');+ t.equal(wrapper.find(ChickletedInput).length, 2, 'Should render 2 ChickletedInput');++ // tooltip chicklets+ const tooltipButtons = wrapper+ .find(ChickletedInput)+ .at(0)+ .find(ChickletButton);++ t.equal(tooltipButtons.length, 5, 'should render 6 tooltip buttons');+ t.equal(+ tooltipButtons+ .at(0)+ .find('span')+ .at(0)+ .text(),+ 'gps_data.utc_timestamp'+ );++ t.end();+});++test('TooltipConfig - render -> onSelect', t => {+ const datasets = StateWFiles.visState.datasets;+ const tooltipConfig = StateWFiles.visState.interactionConfig.tooltip.config;++ const onChange = sinon.spy();+ let wrapper;++ t.doesNotThrow(() => {+ wrapper = mountWithTheme(+ <IntlWrapper>+ <TooltipConfig onChange={onChange} config={tooltipConfig} datasets={datasets} />+ </IntlWrapper>+ );+ }, 'Should render');++ t.equal(wrapper.find(ChickletedInput).length, 2, 'Should render 2 ChickletedInput');++ // click chicklet input to open dropdown+ wrapper+ .find(ChickletedInput)+ .at(0)+ .simulate('click');++ const dropdownSelect = wrapper.find(Typeahead);+ t.equal(dropdownSelect.length, 1, 'should render 1 Typeahead');++ const listItems = dropdownSelect.find('.field-selector_list-item');++ t.deepEqual(+ dropdownSelect.find('.list__item__anchor').map(item => item.text()),+ ['gps_data.lat', 'gps_data.lng', 'time', 'begintrip_ts_utc', 'begintrip_ts_local', 'date'],+ 'should filter out selected tooltip items'+ );++ // click 1 item to add+ listItems.at(0).simulate('click');++ const expectedArgs0 = {+ ...tooltipConfig,fieldsToShow: {- test_trip_data: [- {- name: 'tpep_pickup_datetime',- format: null- },- {- name: 'tpep_dropoff_datetime',- format: null- },- {- name: 'fare_amount',- format: null- }+ ...tooltipConfig.fieldsToShow,+ '190vdll3di': [+ ...tooltipConfig.fieldsToShow['190vdll3di'],+ {name: 'gps_data.lat', format: null}]- },- enabled: true+ }+ };++ t.deepEqual(onChange.args[0], [expectedArgs0], 'should call onchange with new tooltip appended');++ // delete 1 item+ const tooltipButtons = wrapper+ .find(ChickletedInput)+ .at(0)+ .find(ChickletButton);++ tooltipButtons+ .at(0)+ .find(Delete)+ .simulate('click');+ const expectedArgs1 = {+ ...tooltipConfig,+ fieldsToShow: {+ ...tooltipConfig.fieldsToShow,+ '190vdll3di': tooltipConfig.fieldsToShow['190vdll3di'].slice(+ 1,+ tooltipConfig.fieldsToShow['190vdll3di'].length+ )+ }+ };+ t.deepEqual(onChange.args[1], [expectedArgs1], 'should call onchange with 1 item removed');++ // clear All+ t.equal(wrapper.find('.button.clear-all').length, 2, 'should render 2 clea all buttons');++ // click to clear all+ wrapper+ .find('.button.clear-all')+ .at(0)+ .simulate('click');+ const expectedArgs2 = {+ ...tooltipConfig,+ fieldsToShow: {+ ...tooltipConfig.fieldsToShow,+ '190vdll3di': []+ }};+ t.deepEqual(onChange.args[2], [expectedArgs2], 'should call onchange to clear all tooltips');++ t.end();+});++test('TooltipConfig - render -> tooltip format', t => {+ const datasets = StateWFiles.visState.datasets;+ const tooltipConfig = StateWFiles.visState.interactionConfig.tooltip.config;+const onChange = sinon.spy();let wrapper;t.doesNotThrow(() => {wrapper = mountWithTheme(<IntlWrapper>- <TooltipConfig onChange={onChange} config={config} datasets={datasets} />+ <TooltipConfig onChange={onChange} config={tooltipConfig} datasets={datasets} /></IntlWrapper>);}, 'Should render');- t.equal(wrapper.find(TooltipConfig).length, 1, 'Should display 1 TooltipConfig');+ const tooltipButtons = wrapper+ .find(ChickletedInput)+ .at(0)+ .find(ChickletButton);++ // click on hash+ tooltipButtons+ .at(0)+ .find(Hash)+ .simulate('click');++ const formatDropdown = wrapper.find(DropdownList);+ t.equal(formatDropdown.length, 1, 'should render 1 format dropdown');++ const options = formatDropdown.at(0).props().options;++ t.deepEqual(+ uniq(options.map(op => op.type)),+ ['none', 'date', 'date_time'],+ 'should render date type formats'+ );++ const option1 = options[1].format;++ // click option1+ formatDropdown+ .find('.list__item')+ .at(1)+ .simulate('click');+ const expectedArgs0 = {+ ...tooltipConfig,+ fieldsToShow: {+ ...tooltipConfig.fieldsToShow,+ '190vdll3di': [+ {name: 'gps_data.utc_timestamp', format: option1},+ ...tooltipConfig.fieldsToShow['190vdll3di'].slice(+ 1,+ tooltipConfig.fieldsToShow['190vdll3di'].length+ )+ ]+ }+ };+ t.deepEqual(onChange.args[0], [expectedArgs0], 'should call onchange to set format');t.end();});diff --git a/test/node/utils/data-utils-test.js b/test/node/utils/data-utils-test.jsindex c4a3dffa5..cc01976e9 100644--- a/test/node/utils/data-utils-test.js+++ b/test/node/utils/data-utils-test.js@@ -151,6 +151,22 @@ test('dataUtils -> getFormatter', t => {}],assert: [4223, '4,200']+ },+ {+ input: ['01'],+ assert: [true, '1']+ },+ {+ input: ['01'],+ assert: [false, '0']+ },+ {+ input: ['yn'],+ assert: [false, 'no']+ },+ {+ input: ['yn'],+ assert: [true, 'yes']}];