Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
fix: handle absent shared props in Trip label collisions (#3924)
Igor Dykhtaa02cd0e93fd8
diff --git a/src/layers/src/base-layer.ts b/src/layers/src/base-layer.tsindex b8d3f5d46..ee4de12df 100644--- a/src/layers/src/base-layer.ts+++ b/src/layers/src/base-layer.ts@@ -1797,7 +1797,7 @@ class Layer implements KeplerLayer {},...(collisionEnabled? {- extensions: [...(sharedProps.extensions || []), collisionFilterExtension],+ extensions: [...(sharedProps?.extensions || []), collisionFilterExtension],collisionEnabled: true,collisionGroup: `${this.id}-text-label-${i}`,getCollisionPriority: 0,diff --git a/src/layers/src/layer-text-label.spec.ts b/src/layers/src/layer-text-label.spec.tsindex 7ecc2c469..768ee7097 100644--- a/src/layers/src/layer-text-label.spec.ts+++ b/src/layers/src/layer-text-label.spec.ts@@ -1,6 +1,7 @@// SPDX-License-Identifier: MIT// Copyright contributors to the kepler.gl project+import {DataFilterExtension} from '@deck.gl/extensions';import KeplerTable from '@kepler.gl/table';import {ALL_FIELD_TYPES, DEFAULT_TEXT_LABEL} from '@kepler.gl/constants';import PointLayer from './point-layer/point-layer';@@ -133,3 +134,26 @@ describe('renderTextLabelLayer', () => {});});});++test('collision labels preserve shared extensions without mutating another layer', async () => {+ const table = await makeTable();+ const field = table.fields[2];+ const layer = new PointLayer({id: 'point', dataId: table.id});+ layer.updateLayerConfig({+ textLabel: [{...DEFAULT_TEXT_LABEL, field, collisionEnabled: true}]+ });+ const extension = new DataFilterExtension();+ const extensions = Object.freeze([extension]);+ const [text] = layer.renderTextLabelLayer(+ {getPixelOffset: () => [0, 0], updateTriggers: {}, sharedProps: {extensions}},+ {+ data: {data: [], textLabels: [{getText: () => 'label', characterSet: ['l']}]},+ mapState: {},+ visible: true+ }+ );+ expect(extensions).toEqual([extension]);+ expect(text.props.extensions).toHaveLength(2);+ expect(text.props.extensions[0]).toBe(extension);+ expect(text.props.extensions[1].constructor.extensionName).toBe('CollisionFilterExtension');+});diff --git a/src/layers/src/trip-layer/trip-layer-color.spec.ts b/src/layers/src/trip-layer/trip-layer-color.spec.tsindex bc4d9f125..cf360ac20 100644--- a/src/layers/src/trip-layer/trip-layer-color.spec.ts+++ b/src/layers/src/trip-layer/trip-layer-color.spec.ts@@ -3,7 +3,7 @@import TripLayer from './trip-layer';import KeplerTable from '@kepler.gl/table';-import {ALL_FIELD_TYPES, SCALE_TYPES} from '@kepler.gl/constants';+import {ALL_FIELD_TYPES, DEFAULT_TEXT_LABEL, SCALE_TYPES} from '@kepler.gl/constants';/*** Build a small taxi-trip table: 3 trips (2 points each) across 3 companies.@@ -108,3 +108,41 @@ describe('TripLayer TABLE mode color by field', () => {expect(colors[2]).toEqual([232, 33, 39]);});});++describe('TripLayer text label collision', () => {+ test('renders moving labels with collision off, on, and off again', async () => {+ const table = await makeTripTable();+ const layer = makeTripLayer(table);+ const field = table.fields[4];+ let previousData = null;++ for (const collisionEnabled of [false, true, false]) {+ layer.updateLayerConfig({textLabel: [{...DEFAULT_TEXT_LABEL, field, collisionEnabled}]});+ const data = layer.formatLayerData({[table.id]: table}, previousData);+ const domain = layer.config.animation.domain;+ if (!domain) {+ throw new Error('Trip data should provide an animation domain');+ }+ const [trail, text] = layer.renderLayer({+ data,+ gpuFilter: table.gpuFilter,+ mapState: {zoom: 10, latitude: 37.77, longitude: -122.42},+ animationConfig: {domain, currentTime: domain[0] + 5000},+ visible: true,+ layerCallbacks: {},+ idx: 0+ });+ expect(text.props.getText(data.data[0])).toBe('Uber');+ expect(text.props.getPosition(data.data[0])[0]).toBeCloseTo(-122.415);+ expect(text.props.getPosition(data.data[0])[1]).toBeCloseTo(37.775);+ expect(text.props.extensions).toHaveLength(collisionEnabled ? 1 : 0);+ expect(text.props.extensions.map(extension => extension.constructor.extensionName)).toEqual(+ collisionEnabled ? ['CollisionFilterExtension'] : []+ );+ expect(trail.props.extensions.map(extension => extension.constructor.extensionName)).toEqual([+ 'DataFilterExtension'+ ]);+ previousData = data;+ }+ });+});