Skip to content

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

fix: reject non-hexadecimal S2 tokens before rendering (#3913)

Igor Dykhta8efc72bfe51b
diff --git a/src/layers/src/s2-geometry-layer/s2-utils.ts b/src/layers/src/s2-geometry-layer/s2-utils.ts
index b234a265b..80e2e4269 100644
--- a/src/layers/src/s2-geometry-layer/s2-utils.ts
+++ b/src/layers/src/s2-geometry-layer/s2-utils.ts
@@ -23,7 +23,7 @@ export function getS2Center(s2Token): [number, number] | null {
}
}
-const re = /^[0-9a-z]+$/;
+const re = /^[0-9a-f]+$/;
export function maybeStripQuotes(token: string): string {
if (token.length >= 2) {
diff --git a/test/browser/layer-tests/s2-geometry-layer-specs.js b/test/browser/layer-tests/s2-geometry-layer-specs.js
index dc441e1da..85dca4523 100644
--- a/test/browser/layer-tests/s2-geometry-layer-specs.js
+++ b/test/browser/layer-tests/s2-geometry-layer-specs.js
@@ -15,6 +15,8 @@ import {
} from 'test/helpers/layer-utils';
import {s2DefaultElevation as defaultElevation, KeplerGlLayers} from '@kepler.gl/layers';
import {copyTableAndUpdate} from '@kepler.gl/table';
+import {createDataContainer} from '@kepler.gl/utils';
+import {INITIAL_MAP_STATE, INITIAL_VIS_STATE} from '@kepler.gl/reducers';
const {S2GeometryLayer} = KeplerGlLayers;
@@ -291,3 +293,73 @@ test('#S2Geometry -> renderLayer', t => {
t.end();
});
+
+test('#S2Geometry -> invalid non-hex tokens never reach polygon generation', t => {
+ const valid = ['80858004', "'80858004'", '"8085801c"', '8085801c'];
+ const invalid = ['zz', 'unknown', '8085800g', "'zz'", '"unknown"', '', null, undefined, 80858004];
+ const field = preparedDataset.fields.find(candidate => candidate.name === 's2x');
+ const makeDataset = tokens =>
+ copyTableAndUpdate(preparedDataset, {
+ dataContainer: createDataContainer(
+ tokens.map(token => {
+ const row = [...testRows[0]];
+ row[field.fieldIdx] = token;
+ return row;
+ })
+ ),
+ filteredIndex: tokens.map((_, index) => index)
+ });
+ const formatAndRender = tokens => {
+ const dataset = makeDataset(tokens);
+ const layer = new S2GeometryLayer({id: 's2-token-validation', dataId});
+ layer.updateLayerConfig({columns: {token: {value: field.name, fieldIdx: field.fieldIdx}}});
+ const data = layer.formatLayerData({[dataId]: dataset});
+ const [rendered] = layer.renderLayer({
+ data,
+ gpuFilter: dataset.gpuFilter,
+ interactionConfig: INITIAL_VIS_STATE.interactionConfig,
+ mapState: INITIAL_MAP_STATE,
+ visible: true
+ });
+ // This invokes deck.gl's actual S2 token-to-polygon conversion, without a WebGL draw.
+ const {getPolygon} = rendered.indexToBounds();
+ const polygons = rendered.props.data.map((row, index) => Array.from(getPolygon(row, {index})));
+ return {layer, data, polygons};
+ };
+
+ const baseline = formatAndRender(valid);
+ t.equal(baseline.polygons.length, valid.length, 'valid and quoted tokens generate polygons');
+ t.deepEqual(
+ baseline.polygons[0],
+ baseline.polygons[1],
+ 'single-quoted token preserves its geometry'
+ );
+ t.deepEqual(
+ baseline.polygons[2],
+ baseline.polygons[3],
+ 'double-quoted token preserves its geometry'
+ );
+ t.ok(
+ baseline.polygons.every(polygon => polygon.length >= 10 && polygon.every(Number.isFinite)),
+ 'valid geometry has finite coordinates'
+ );
+
+ const mixed = formatAndRender([...valid, ...invalid]);
+ t.deepEqual(
+ mixed.data.data.map(row => row.index),
+ [0, 1, 2, 3],
+ 'invalid and missing tokens are filtered out'
+ );
+ t.deepEqual(mixed.polygons, baseline.polygons, 'invalid tokens produce no extra polygons');
+ t.deepEqual(
+ mixed.layer.meta.bounds,
+ baseline.layer.meta.bounds,
+ 'invalid tokens cannot distort map bounds'
+ );
+
+ const empty = formatAndRender(invalid);
+ t.deepEqual(empty.data.data, [], 'an invalid-only dataset has no renderable cells');
+ t.deepEqual(empty.polygons, [], 'an invalid-only dataset creates no polygons');
+ t.deepEqual(formatAndRender([]).polygons, [], 'an empty dataset creates no polygons');
+ t.end();
+});