Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

fix(deckgl): guard empty 3d building tiles (#3856)

Igor Dykhta2288a22b4b79
diff --git a/src/deckgl-layers/src/3d-building-layer/3d-building-layer.spec.ts b/src/deckgl-layers/src/3d-building-layer/3d-building-layer.spec.ts
new file mode 100644
index 000000000..a257e5796
--- /dev/null
+++ b/src/deckgl-layers/src/3d-building-layer/3d-building-layer.spec.ts
@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {SolidPolygonLayer} from '@deck.gl/layers';
+
+import ThreeDBuildingLayer from './3d-building-layer';
+import {TileDataItem} from './types';
+
+const color: [number, number, number] = [10, 20, 30];
+
+function makeLayer() {
+ return new ThreeDBuildingLayer({
+ id: 'test-3d-buildings',
+ mapboxApiAccessToken: 'test-token',
+ mapboxApiUrl: 'https://example.com',
+ threeDBuildingColor: color,
+ updateTriggers: {getFillColor: color}
+ });
+}
+
+describe('ThreeDBuildingLayer', () => {
+ test('declares a stable deck.gl component name', () => {
+ expect(ThreeDBuildingLayer.layerName).toBe('ThreeDBuildingLayer');
+ expect(ThreeDBuildingLayer.componentName).toBe('ThreeDBuildingLayer');
+ });
+
+ test('does not create an extruded polygon layer for empty tile content', () => {
+ const layer = makeLayer();
+
+ expect(layer.renderSubLayers({data: []} as any)).toBeNull();
+ expect(layer.renderSubLayers({data: null} as any)).toBeNull();
+ expect(
+ layer.renderSubLayers({
+ data: [{coordinates: [], properties: {layer: 'building', height: 25}}]
+ } as any)
+ ).toBeNull();
+ });
+
+ test('keeps rendering non-empty building tiles', () => {
+ const layer = makeLayer();
+ const data: TileDataItem[] = [
+ {
+ coordinates: [
+ [
+ [-122.42, 37.77],
+ [-122.41, 37.77],
+ [-122.41, 37.78],
+ [-122.42, 37.77]
+ ]
+ ],
+ properties: {layer: 'building', height: 25}
+ }
+ ];
+
+ const subLayer = layer.renderSubLayers({data} as any);
+
+ expect(subLayer).toBeInstanceOf(SolidPolygonLayer);
+ expect(subLayer?.props.data).toBe(data);
+ expect(subLayer?.props.extruded).toBe(true);
+ const getElevation = subLayer?.props.getElevation;
+ expect(typeof getElevation).toBe('function');
+ expect(typeof getElevation === 'function' && getElevation(data[0], {} as any)).toBe(25);
+ expect(subLayer?.props.getPolygon(data[0], {} as any)).toBe(data[0].coordinates);
+ });
+});
diff --git a/src/deckgl-layers/src/3d-building-layer/3d-building-layer.ts b/src/deckgl-layers/src/3d-building-layer/3d-building-layer.ts
index ec8e0704b..f2ea6cb66 100644
--- a/src/deckgl-layers/src/3d-building-layer/3d-building-layer.ts
+++ b/src/deckgl-layers/src/3d-building-layer/3d-building-layer.ts
@@ -10,11 +10,20 @@ import {getTileData} from './3d-building-utils';
import {ThreeDBuildingLayerProps, TileDataItem, TileLoadProps} from './types';
export default class ThreeDBuildingLayer extends CompositeLayer<ThreeDBuildingLayerProps> {
+ static layerName = 'ThreeDBuildingLayer';
+
// this layer add its subLayers to the redux store, and push sample data
renderSubLayers(props: SolidPolygonLayerProps<any>) {
+ const data = props.data as TileDataItem[] | null;
+
+ if (!data?.some(feature => feature.coordinates.some(ring => ring.length))) {
+ return null;
+ }
+
return new SolidPolygonLayer<TileDataItem>({
...props,
+ data,
parameters: BLEND_PARAMS_ALPHA,
extruded: true,
opacity: 1,