Add geo shape query filter

Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com>
opensearch-project · Mar 6, 2023 · b6a8739 · b6a8739
1 parent e3eef6b
commit b6a8739
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 3 deletions.
diff --git a/public/model/geo/filter.test.ts b/public/model/geo/filter.test.ts
@@ -5,8 +5,9 @@
 
 import { LngLat } from 'maplibre-gl';
 import { GeoBounds } from '../map/boundary';
-import { FilterMeta, GeoBoundingBoxFilter } from '../../../../../src/plugins/data/common';
-import { buildBBoxFilter } from './filter';
+import { FilterMeta, FILTERS, GeoBoundingBoxFilter } from '../../../../../src/plugins/data/common';
+import { buildBBoxFilter, buildSpatialGeometryFilter, GeoShapeFilter } from './filter';
+import { Polygon } from 'geojson';
 
 describe('test bounding box filter', function () {
   it('should return valid bounding box', function () {
@@ -40,3 +41,55 @@ describe('test bounding box filter', function () {
     expect(actualGeoBoundingBoxFilter.meta.params).toEqual(expectedBounds);
   });
 });
+
+describe('test geo shape filter', function () {
+  it('should return valid geo shape query', function () {
+    const mockPolygon: Polygon = {
+      type: 'Polygon',
+      coordinates: [
+        [
+          [74.006, 40.7128],
+          [71.0589, 42.3601],
+          [73.7562, 42.6526],
+          [74.006, 40.7128],
+        ],
+      ],
+    };
+    const mockLabel: string = 'mypolygon';
+    const fieldName: string = 'location';
+
+    const geoShapeFilter: GeoShapeFilter = buildSpatialGeometryFilter(
+      fieldName,
+      mockPolygon,
+      mockLabel,
+      'INTERSECTS'
+    );
+    const expectedFilter: GeoShapeFilter = {
+      meta: {
+        alias: mockLabel,
+        disabled: false,
+        negate: false,
+        key: 'location',
+        type: FILTERS.SPATIAL_FILTER,
+      },
+      geo_shape: {
+        ignore_unmaped: true,
+        location: {
+          relation: 'INTERSECTS',
+          shape: {
+            type: 'Polygon',
+            coordinates: [
+              [
+                [74.006, 40.7128],
+                [71.0589, 42.3601],
+                [73.7562, 42.6526],
+                [74.006, 40.7128],
+              ],
+            ],
+          },
+        },
+      },
+    };
+    expect(geoShapeFilter).toEqual(expectedFilter);
+  });
+});
diff --git a/public/model/geo/filter.ts b/public/model/geo/filter.ts
@@ -4,9 +4,22 @@
  */
 
 import { LatLon } from '@opensearch-project/opensearch/api/types';
-import { FilterMeta, GeoBoundingBoxFilter } from '../../../../../src/plugins/data/common';
+import { Polygon } from 'geojson';
+import {
+  Filter,
+  FilterMeta,
+  FILTERS,
+  GeoBoundingBoxFilter,
+} from '../../../../../src/plugins/data/common';
 import { GeoBounds } from '../map/boundary';
 
+export type FilterRelations = 'INTERSECTS' | 'DISJOINT' | 'WITHIN';
+
+export type GeoShapeFilter = Filter & {
+  meta: FilterMeta;
+  geo_shape: any;
+};
+
 export const buildBBoxFilter = (
   fieldName: string,
   mapBounds: GeoBounds,
@@ -36,3 +49,29 @@ export const buildBBoxFilter = (
     },
   };
 };
+
+export const buildSpatialGeometryFilter = (
+  fieldName: string,
+  filterShape: Polygon,
+  filterLabel: string,
+  relation: FilterRelations
+): GeoShapeFilter => {
+  const meta: FilterMeta = {
+    negate: false,
+    key: fieldName,
+    alias: filterLabel,
+    type: FILTERS.SPATIAL_FILTER,
+    disabled: false,
+  };
+
+  return {
+    meta,
+    geo_shape: {
+      ignore_unmaped: true,
+      [fieldName]: {
+        relation,
+        shape: filterShape,
+      },
+    },
+  };
+};
diff --git a/public/model/layerRenderController.ts b/public/model/layerRenderController.ts
@@ -16,6 +16,7 @@ import {
   isCompleteResponse,
   TimeRange,
   Query,
+  FILTERS,
 } from '../../../../src/plugins/data/common';
 import { layersFunctionMap } from './layersFunctions';
 import { MapServices } from '../types';
@@ -116,6 +117,7 @@ export const handleDataLayerRender = (
     alias: null,
     disabled: !mapLayer.source.useGeoBoundingBoxFilter || geoFieldType !== 'geo_point',
     negate: false,
+    type: FILTERS.GEO_BOUNDING_BOX,
   };
   const geoBoundingBoxFilter: GeoBoundingBoxFilter = buildBBoxFilter(geoField, mapBounds, meta);
   filters.push(geoBoundingBoxFilter);