Add geo polygon query type (#613)

* Add geo polygon query type

* Detect closed polygons, update docs

clientlib/src/main/proto/yelp/nrtsearch/search.proto

@@ -263,6 +263,22 @@ message GeoPointQuery {
     google.type.LatLng point = 2; // point used to query whether the polygon contains it.
 }
 
+// Polygon defined by a list of geo points
+message Polygon {
+    // Points defining the polygon, conforming to the https://geojson.org/ standard. The polygon must not be self-crossing, otherwise may result in unexpected behavior. Polygons cannot cross the 180th meridian. Instead, use two polygons: one on each side.
+    repeated google.type.LatLng points = 1;
+    // Specify holes in the polygon. Hole polygons cannot themselves contain holes.
+    repeated Polygon holes = 2;
+}
+
+// A query that matches documents with geo points within polygons
+message GeoPolygonQuery {
+    // Field in the document to query
+    string field = 1;
+    // Geo polygons to search for containing points
+    repeated Polygon polygons = 2;
+}
+
 // A query that matches documents which contain a value for a field.
 message ExistsQuery {
     string field = 1; // Field in the document to query
@@ -363,6 +379,7 @@ enum QueryType {
     MATCH_PHRASE_PREFIX = 18;
     PREFIX = 19;
     CONSTANT_SCORE_QUERY = 20;
+    GEO_POLYGON = 21;
 }
 
 // Defines a full query consisting of a QueryNode which may be one of several types.
@@ -392,6 +409,7 @@ message Query {
         MatchPhrasePrefixQuery matchPhrasePrefixQuery = 21;
         PrefixQuery prefixQuery = 22;
         ConstantScoreQuery constantScoreQuery = 23;
+        GeoPolygonQuery geoPolygonQuery = 24;
     }
 }
 

docs/queries/geo_polygon.rst

@@ -0,0 +1,19 @@
+Geo-Polygon Query
+==========================
+
+A query that matches documents with geo point within a defined set of polygons.
+
+Polygon definitions must conform to the `GeoJson <https://geojson.org/>`_ standard.
+Polygons must not be self-crossing, otherwise may result in unexpected behavior.
+Polygons cannot cross the 180th meridian. Instead, use two polygons: one on each side.
+
+Proto definition:
+
+.. code-block::
+
+   message GeoPolygonQuery {
+       // Field in the document to query
+       string field = 1;
+       // Geo polygons to search for containing points
+       repeated Polygon polygons = 2;
+   }

grpc-gateway/luceneserver.swagger.json

@@ -3475,6 +3475,23 @@
       },
       "description": "A query that matches documents with polygon that contains the geo point."
     },
+    "luceneserverGeoPolygonQuery": {
+      "type": "object",
+      "properties": {
+        "field": {
+          "type": "string",
+          "title": "Field in the document to query"
+        },
+        "polygons": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/luceneserverPolygon"
+          },
+          "title": "Geo polygons to search for containing points"
+        }
+      },
+      "title": "A query that matches documents with geo points within polygons"
+    },
     "luceneserverGeoRadiusQuery": {
       "type": "object",
       "properties": {
@@ -4243,6 +4260,26 @@
       },
       "title": "Point representation"
     },
+    "luceneserverPolygon": {
+      "type": "object",
+      "properties": {
+        "points": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/typeLatLng"
+          },
+          "description": "Points defining the polygon, conforming to the https://geojson.org/ standard. The polygon must not be self-crossing, otherwise may result in unexpected behavior. Polygons cannot cross the 180th meridian. Instead, use two polygons: one on each side."
+        },
+        "holes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/luceneserverPolygon"
+          },
+          "description": "Specify holes in the polygon. Hole polygons cannot themselves contain holes."
+        }
+      },
+      "title": "Polygon defined by a list of geo points"
+    },
     "luceneserverPrefixQuery": {
       "type": "object",
       "properties": {
@@ -4356,6 +4393,9 @@
         },
         "constantScoreQuery": {
           "$ref": "#/definitions/luceneserverConstantScoreQuery"
+        },
+        "geoPolygonQuery": {
+          "$ref": "#/definitions/luceneserverGeoPolygonQuery"
         }
       },
       "description": "Defines a full query consisting of a QueryNode which may be one of several types."
@@ -4414,7 +4454,8 @@
         "MULTI_FUNCTION_SCORE_QUERY",
         "MATCH_PHRASE_PREFIX",
         "PREFIX",
-        "CONSTANT_SCORE_QUERY"
+        "CONSTANT_SCORE_QUERY",
+        "GEO_POLYGON"
       ],
       "default": "NONE",
       "description": "Defines different types of QueryNodes."