Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project
import React from 'react';
import sinon from 'sinon';
import test from 'tape';
import {IntlWrapper, mountWithTheme} from 'test/helpers/component-utils';
import {
Icons,
MapPopoverFactory,
appInjector,
LayerHoverInfoFactory,
CoordinateInfoFactory
} from '@kepler.gl/components';
import {
expectedLayerHoverProp as layerHoverProp,
expectedGeojsonLayerHoverProp as geojsonLayerHoverProp,
testCsvDataId,
mockKeplerProps
} from 'test/helpers/mock-state';
import {COMPARE_TYPES} from '@kepler.gl/constants';
const {Pin} = Icons;
const MapPopover = appInjector.get(MapPopoverFactory);
const LayerHoverInfo = appInjector.get(LayerHoverInfoFactory);
const CoordinateInfo = appInjector.get(CoordinateInfoFactory);
const defaultProps = {
x: 400,
y: 300,
zoom: 13,
onClose: null,
coordinate: null,
layerHoverProp: {},
isBase: false,
frozen: false
};
test('Map Popover - render', t => {
const onClose = sinon.spy();
defaultProps.onClose = onClose;
let wrapper;
t.doesNotThrow(() => {
wrapper = mountWithTheme(
<IntlWrapper>
<MapPopover {...defaultProps} />
</IntlWrapper>
);
}, 'Should render');
t.equal(wrapper.find(MapPopover).length, 1, 'Should display 1 MapPopover');
t.equal(wrapper.find('.coordingate-hover-info').length, 0, 'Should display 0 coordinates');
t.equal(wrapper.find('.map-popover__layer-info').length, 0, 'Should display 0 layer info');
t.equal(wrapper.find(Pin).length, 0, 'Should display 0 pin');
t.equal(wrapper.find('.primary-label').length, 0, 'Should display 0 primary label');
t.equal(
wrapper.find('.select-geometry').length,
0,
'Should not display select geometry for point layer'
);
wrapper.setProps({
children: <MapPopover {...defaultProps} isBase={true} frozen={true} />
});
t.equal(wrapper.find(Pin).length, 1, 'Should display 1 pin');
t.equal(wrapper.find('.primary-label').length, 1, 'Should display 1 primary label');
t.equal(
wrapper.find('.select-geometry').length,
0,
'Should not display select geometry for point layer'
);
// click pin
wrapper.find('.popover-pin').at(0).simulate('click');
t.ok(onClose.called, 'should call onClose when click pin');
// render coordinate
wrapper.setProps({
children: (
<MapPopover {...defaultProps} coordinate={[127.12345678, -31.12345678]} zoom={12.123} />
)
});
t.equal(wrapper.find('CoordinateInfo').length, 1, 'Should render CoordinateInfo');
t.equal(wrapper.find('.row__value').at(0).text(), '-31.123457,', 'should render lat');
t.equal(wrapper.find('.row__value').at(1).text(), '127.123457,', 'should render longitude');
t.equal(wrapper.find('.row__value').at(2).text(), '12.1z', 'should render zoom');
t.end();
});
test('Map Popover - render with layerHoverProp', t => {
let wrapper;
t.doesNotThrow(() => {
wrapper = mountWithTheme(
<IntlWrapper>
<MapPopover {...defaultProps} layerHoverProp={layerHoverProp} />
</IntlWrapper>
);
}, 'Should render map popover with layerHoverProps');
t.equal(wrapper.find(LayerHoverInfo).length, 1, 'Should render LayerHoverInfo');
t.equal(wrapper.find('table').length, 1, 'Should render 1 table');
const table = wrapper.find('table').at(0);
const rows = table.find('.layer-hover-info__row');
t.equal(rows.length, 5, 'should render 5 rows');
const expectedTooltips = [
['gps_data.utc_timestamp', '09/17/2016 12:24:24 AM'],
['gps_data.types', 'driver_analytics'],
['epoch', '09/01/2016 6:26:40 PM'],
['has_result', ''],
['uid', '1']
];
for (let i = 0; i < 5; i++) {
t.equal(
rows.at(i).find('.row__name').text(),
expectedTooltips[i][0],
'row name should be correct'
);
t.equal(
rows.at(i).find('.row__value').text(),
expectedTooltips[i][1],
'row value should be correct'
);
}
t.end();
});
test('Map Popover - render with geojsonLayerHoverProp', t => {
const setSelectedFeature = sinon.spy();
const onSetFeatures = sinon.spy();
const onClose = sinon.spy();
defaultProps.setSelectedFeature = setSelectedFeature;
defaultProps.onSetFeatures = onSetFeatures;
defaultProps.onClose = onClose;
let wrapper;
t.doesNotThrow(() => {
wrapper = mountWithTheme(
<IntlWrapper>
<MapPopover
{...defaultProps}
isBase={true}
frozen={true}
layerHoverProp={geojsonLayerHoverProp}
/>
</IntlWrapper>
);
}, 'Should render map popover with geojsonLayerHoverProp');
t.equal(wrapper.find(MapPopover).length, 1, 'Should display 1 MapPopover');
t.equal(wrapper.find(Pin).length, 1, 'Should display 1 pin');
t.equal(wrapper.find('.primary-label').length, 1, 'Should display 1 primary label');
// click select geometry
wrapper.find('.select-geometry').at(0).simulate('click');
t.ok(setSelectedFeature.called, 'should call setSelectedFeature when click select geometry');
t.ok(onSetFeatures.called, 'should call onSetFeatures when click select geometry');
// click pin
wrapper.find('.popover-pin').at(0).simulate('click');
t.ok(onClose.called, 'should call onClose when click pin');
// render coordinate
wrapper.setProps({
children: (
<MapPopover {...defaultProps} coordinate={[127.12345678, -31.12345678]} zoom={12.123} />
)
});
t.equal(wrapper.find(CoordinateInfo).length, 1, 'Should render CoordinateInfo');
t.equal(wrapper.find('.row__value').at(0).text(), '-31.123457,', 'should render lat');
t.equal(wrapper.find('.row__value').at(1).text(), '127.123457,', 'should render longitude');
t.equal(wrapper.find('.row__value').at(2).text(), '12.1z', 'should render zoom');
t.end();
});
test('Map Popover - render comparison mode with delta column', t => {
const comparisonLayerHoverProp = {
...layerHoverProp,
primaryData: mockKeplerProps.visState.datasets[testCsvDataId].dataContainer.row(14),
compareType: COMPARE_TYPES.ABSOLUTE
};
let wrapper;
t.doesNotThrow(() => {
wrapper = mountWithTheme(
<IntlWrapper>
<MapPopover {...defaultProps} layerHoverProp={comparisonLayerHoverProp} />
</IntlWrapper>
);
}, 'Should render map popover in comparison mode');
t.equal(wrapper.find(LayerHoverInfo).length, 1, 'Should render LayerHoverInfo');
t.equal(wrapper.find('table').length, 1, 'Should render 1 table');
const table = wrapper.find('table').at(0);
t.ok(
table.hasClass('comparing'),
'Table should have "comparing" class when primaryData is present'
);
const rows = table.find('.layer-hover-info__row');
t.ok(rows.length > 0, 'Should render tooltip rows');
for (let i = 0; i < rows.length; i++) {
const deltaCell = rows.at(i).find('td.row__delta-value');
t.equal(deltaCell.length, 1, `Row ${i} should render a delta value cell`);
}
t.end();
});
test('Map Popover - raster tooltip keeps a delta column in comparison mode', t => {
const rasterHoverProp = {
data: {
rasterFeatureData: [
{name: 'Longitude', value: '33.738085'},
{name: 'Latitude', value: '16.720055'},
{name: 'Tile', value: '12/2431/1855'},
{name: 'b1', value: '255'},
{name: 'b2', value: '178'}
]
},
layer: {config: {label: 'Africa Farms'}, isAggregated: false},
fields: [],
fieldsToShow: [],
primaryData: {
rasterFeatureData: [
{name: 'Longitude', value: '33.683164'},
{name: 'Latitude', value: '16.714997'},
{name: 'b1', value: '131'},
{name: 'b2', value: '113'}
]
},
compareType: COMPARE_TYPES.ABSOLUTE
};
let wrapper;
t.doesNotThrow(() => {
wrapper = mountWithTheme(
<IntlWrapper>
<MapPopover {...defaultProps} layerHoverProp={rasterHoverProp} />
</IntlWrapper>
);
}, 'Should render raster tooltip in comparison mode');
const table = wrapper.find('table').at(0);
t.ok(table.hasClass('comparing'), 'Table should use the comparing grid');
const rows = table.find('.layer-hover-info__row');
t.equal(rows.length, 5, 'Should render all raster identify rows');
for (let i = 0; i < rows.length; i++) {
t.equal(
rows.at(i).find('td').length,
3,
`Row ${i} should have name, value, and delta cells so the grid does not wrap`
);
}
t.equal(rows.at(0).find('.row__name').text(), 'Longitude');
t.equal(rows.at(1).find('.row__name').text(), 'Latitude');
t.equal(rows.at(3).find('.row__name').text(), 'b1');
t.end();
});
test('Map Popover - aggregation tooltip deduplicates identical visual channel rows', t => {
const field = {name: 'fare', type: 'real'};
const layer = {
isAggregated: true,
visualChannels: {color: {}, size: {}},
config: {
label: 'Hexbin',
colorField: field,
sizeField: field
},
getVisualChannelDescription: () => ({measure: 'Average of fare'})
};
const aggregationHoverProp = {
data: {points: [], colorValue: 42, elevationValue: 42},
fields: [field],
fieldsToShow: [{name: field.name}],
layer
};
const wrapper = mountWithTheme(
<IntlWrapper>
<LayerHoverInfo {...aggregationHoverProp} />
</IntlWrapper>
);
const rows = wrapper.find('.layer-hover-info__row');
t.equal(rows.length, 2, 'should render total points and one shared aggregation row');
t.equal(rows.at(1).find('.row__name').text(), 'Average of fare');
t.equal(rows.at(1).find('.row__value').text(), '42');
t.end();
});
test('Map Popover - aggregation tooltip retains rows with different comparison deltas', t => {
const field = {name: 'fare', type: 'real'};
const layer = {
isAggregated: true,
visualChannels: {color: {}, size: {}},
config: {
label: 'Hexbin',
colorField: field,
sizeField: field
},
getVisualChannelDescription: () => ({measure: 'Average of fare'})
};
const aggregationHoverProp = {
data: {points: [], colorValue: 42, elevationValue: 42},
fields: [field],
fieldsToShow: [{name: field.name}],
layer,
primaryData: {points: [], colorValue: 10, elevationValue: 20},
compareType: COMPARE_TYPES.ABSOLUTE
};
const wrapper = mountWithTheme(
<IntlWrapper>
<LayerHoverInfo {...aggregationHoverProp} />
</IntlWrapper>
);
const rows = wrapper.find('.layer-hover-info__row');
t.equal(rows.length, 3, 'should render both aggregation rows');
t.equal(rows.at(1).find('.row__delta-value').text(), '+32');
t.equal(rows.at(2).find('.row__delta-value').text(), '+22');
t.end();
});
test('Map Popover - aggregation tooltip retains rows with different aggregations', t => {
const field = {name: 'fare', type: 'real'};
const layer = {
isAggregated: true,
visualChannels: {color: {}, size: {}},
config: {
label: 'Hexbin',
colorField: field,
sizeField: field
},
getVisualChannelDescription: channel => ({
measure: channel === 'color' ? 'Average of fare' : 'Sum of fare'
})
};
const aggregationHoverProp = {
data: {points: [], colorValue: 42, elevationValue: 42},
fields: [field],
fieldsToShow: [{name: field.name}],
layer
};
const wrapper = mountWithTheme(
<IntlWrapper>
<LayerHoverInfo {...aggregationHoverProp} />
</IntlWrapper>
);
const rows = wrapper.find('.layer-hover-info__row');
t.equal(rows.length, 3, 'should render both aggregation rows');
t.equal(rows.at(1).find('.row__name').text(), 'Average of fare');
t.equal(rows.at(2).find('.row__name').text(), 'Sum of fare');
t.end();
});