Make some vector tile body parameters as query parameters (#75522)

Following the same structure of the _search API, this changes makes possible to define some 
body parameters as query parameters (e.g. defined as URL parameters)

Author: iverase

x-pack/plugin/vector-tile/src/javaRestTest/java/org/elasticsearch/xpack/vectortile/VectorTileRestIT.java

@@ -159,7 +159,7 @@ public void deleteData() throws IOException {
     }
 
     public void testBasicGet() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity("{\"size\" : 100}");
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(3));
@@ -169,7 +169,7 @@ public void testBasicGet() throws Exception {
     }
 
     public void testExtent() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity("{\"size\" : 100, \"extent\" : 256}");
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(3));
@@ -178,17 +178,67 @@ public void testExtent() throws Exception {
         assertLayer(tile, META_LAYER, 256, 1, 14);
     }
 
+    public void testExtentURL() throws Exception {
+        final Request mvtRequest = new Request(
+            getHttpMethod(),
+            INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y + "?extent=" + 512
+        );
+        mvtRequest.setJsonEntity("{\"size\" : 100, \"extent\" : 256}");
+        final VectorTile.Tile tile = execute(mvtRequest);
+        assertThat(tile.getLayersCount(), Matchers.equalTo(3));
+        assertLayer(tile, HITS_LAYER, 512, 33, 1);
+        assertLayer(tile, AGGS_LAYER, 512, 1, 1);
+        assertLayer(tile, META_LAYER, 512, 1, 14);
+    }
+
+    public void testExactBounds() throws Exception {
+        {
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            mvtRequest.setJsonEntity("{\"size\" : 0, \"grid_precision\" : 0}");
+            final VectorTile.Tile tile = execute(mvtRequest);
+            assertThat(tile.getLayersCount(), Matchers.equalTo(1));
+            assertLayer(tile, META_LAYER, 4096, 1, 8);
+            final VectorTile.Tile.Layer layer = getLayer(tile, META_LAYER);
+            assertThat(layer.getFeatures(0).getType(), Matchers.equalTo(VectorTile.Tile.GeomType.POLYGON));
+
+        }
+        {
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            mvtRequest.setJsonEntity("{\"size\" : 0, \"grid_precision\" : 0, \"exact_bounds\" : true}");
+            final VectorTile.Tile tile = execute(mvtRequest);
+            assertThat(tile.getLayersCount(), Matchers.equalTo(1));
+            assertLayer(tile, META_LAYER, 4096, 1, 8);
+            final VectorTile.Tile.Layer layer = getLayer(tile, META_LAYER);
+            // edge case: because all points are the same, the bounding box is a point and cannot be expressed as a polygon.
+            // Therefore the feature ends-up without a geometry.
+            assertThat(layer.getFeatures(0).hasType(), Matchers.equalTo(false));
+        }
+        {
+            final Request mvtRequest = new Request(
+                getHttpMethod(),
+                INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y + "?exact_bounds=false"
+            );
+            mvtRequest.setJsonEntity("{\"size\" : 0, \"grid_precision\" : 0, \"exact_bounds\" : true}");
+            final VectorTile.Tile tile = execute(mvtRequest);
+            assertThat(tile.getLayersCount(), Matchers.equalTo(1));
+            assertLayer(tile, META_LAYER, 4096, 1, 8);
+            final VectorTile.Tile.Layer layer = getLayer(tile, META_LAYER);
+            assertThat(layer.getFeatures(0).getType(), Matchers.equalTo(VectorTile.Tile.GeomType.POLYGON));
+
+        }
+    }
+
     public void testEmpty() throws Exception {
         final int newY = (1 << z) - 1 == y ? y - 1 : y + 1;
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + newY);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + newY);
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(1));
         assertLayer(tile, META_LAYER, 4096, 1, 10);
     }
 
     public void testGridPrecision() throws Exception {
         {
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity("{\"size\" : 100, \"grid_precision\": 7 }");
             final VectorTile.Tile tile = execute(mvtRequest);
             assertThat(tile.getLayersCount(), Matchers.equalTo(3));
@@ -197,7 +247,7 @@ public void testGridPrecision() throws Exception {
             assertLayer(tile, META_LAYER, 4096, 1, 14);
         }
         {
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity("{\"grid_precision\": 9 }");
             final ResponseException ex = expectThrows(ResponseException.class, () -> execute(mvtRequest));
             assertThat(ex.getResponse().getStatusLine().getStatusCode(), Matchers.equalTo(HttpStatus.SC_BAD_REQUEST));
@@ -206,49 +256,86 @@ public void testGridPrecision() throws Exception {
 
     public void testGridType() throws Exception {
         {
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity("{\"size\" : 100, \"grid_type\": \"point\" }");
             final VectorTile.Tile tile = execute(mvtRequest);
             assertThat(tile.getLayersCount(), Matchers.equalTo(3));
             assertLayer(tile, HITS_LAYER, 4096, 33, 1);
             assertLayer(tile, AGGS_LAYER, 4096, 1, 1);
             assertLayer(tile, META_LAYER, 4096, 1, 14);
+            assertFeatureType(tile, AGGS_LAYER, VectorTile.Tile.GeomType.POINT);
         }
         {
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity("{\"size\" : 100, \"grid_type\": \"grid\" }");
             final VectorTile.Tile tile = execute(mvtRequest);
             assertThat(tile.getLayersCount(), Matchers.equalTo(3));
             assertLayer(tile, HITS_LAYER, 4096, 33, 1);
             assertLayer(tile, AGGS_LAYER, 4096, 1, 1);
             assertLayer(tile, META_LAYER, 4096, 1, 14);
+            assertFeatureType(tile, AGGS_LAYER, VectorTile.Tile.GeomType.POLYGON);
         }
         {
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity("{\"grid_type\": \"invalid_type\" }");
             final ResponseException ex = expectThrows(ResponseException.class, () -> execute(mvtRequest));
             assertThat(ex.getResponse().getStatusLine().getStatusCode(), Matchers.equalTo(HttpStatus.SC_BAD_REQUEST));
         }
     }
 
+    public void testGridTypeURL() throws Exception {
+        final Request mvtRequest = new Request(
+            getHttpMethod(),
+            INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y + "?grid_type=grid"
+        );
+        mvtRequest.setJsonEntity("{\"size\" : 100, \"grid_type\": \"point\" }");
+        final VectorTile.Tile tile = execute(mvtRequest);
+        assertThat(tile.getLayersCount(), Matchers.equalTo(3));
+        assertLayer(tile, HITS_LAYER, 4096, 33, 1);
+        assertLayer(tile, AGGS_LAYER, 4096, 1, 1);
+        assertLayer(tile, META_LAYER, 4096, 1, 14);
+        assertFeatureType(tile, AGGS_LAYER, VectorTile.Tile.GeomType.POLYGON);
+    }
+
     public void testNoAggLayer() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity("{\"size\" : 100, \"grid_precision\": 0 }");
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(2));
         assertLayer(tile, HITS_LAYER, 4096, 33, 1);
         assertLayer(tile, META_LAYER, 4096, 1, 9);
     }
 
+    public void testNoAggLayerURL() throws Exception {
+        final Request mvtRequest = new Request(
+            getHttpMethod(),
+            INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y + "?grid_precision=" + 0
+        );
+        mvtRequest.setJsonEntity("{\"size\" : 100, \"grid_precision\": 4 }");
+        final VectorTile.Tile tile = execute(mvtRequest);
+        assertThat(tile.getLayersCount(), Matchers.equalTo(2));
+        assertLayer(tile, HITS_LAYER, 4096, 33, 1);
+        assertLayer(tile, META_LAYER, 4096, 1, 9);
+    }
+
     public void testNoHitsLayer() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity("{\"size\": 0 }");
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(2));
         assertLayer(tile, AGGS_LAYER, 4096, 1, 1);
         assertLayer(tile, META_LAYER, 4096, 1, 13);
     }
 
+    public void testNoHitsLayerURL() throws Exception {
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y + "?size=" + 0);
+        mvtRequest.setJsonEntity("{\"size\": 100 }");
+        final VectorTile.Tile tile = execute(mvtRequest);
+        assertThat(tile.getLayersCount(), Matchers.equalTo(2));
+        assertLayer(tile, AGGS_LAYER, 4096, 1, 1);
+        assertLayer(tile, META_LAYER, 4096, 1, 13);
+    }
+
     public void testRuntimeFieldWithSort() throws Exception {
         String runtimeMapping = "\"runtime_mappings\": {\n"
             + "  \"width\": {\n"
@@ -259,7 +346,7 @@ public void testRuntimeFieldWithSort() throws Exception {
             + "}\n";
         {
             // desc order, polygon should be the first hit
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_ALL + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_ALL + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity(
                 "{\n"
                     + "  \"size\" : 100,\n"
@@ -285,7 +372,7 @@ public void testRuntimeFieldWithSort() throws Exception {
         }
         {
             // asc order, polygon should be the last hit
-            final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_ALL + "/_mvt/location/" + z + "/" + x + "/" + y);
+            final Request mvtRequest = new Request(getHttpMethod(), INDEX_ALL + "/_mvt/location/" + z + "/" + x + "/" + y);
             mvtRequest.setJsonEntity(
                 "{\n"
                     + "  \"size\" : 100,\n"
@@ -312,7 +399,7 @@ public void testRuntimeFieldWithSort() throws Exception {
     }
 
     public void testBasicQueryGet() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_POINTS + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity(
             "{\n"
                 + "  \"query\": {\n"
@@ -332,7 +419,7 @@ public void testBasicQueryGet() throws Exception {
     }
 
     public void testBasicShape() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_SHAPES + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_SHAPES + "/_mvt/location/" + z + "/" + x + "/" + y);
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(3));
         assertLayer(tile, HITS_LAYER, 4096, 1, 1);
@@ -341,7 +428,7 @@ public void testBasicShape() throws Exception {
     }
 
     public void testWithFields() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_SHAPES + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_SHAPES + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity("{\"fields\": [\"name\", \"value1\"] }");
         final VectorTile.Tile tile = execute(mvtRequest);
         assertThat(tile.getLayersCount(), Matchers.equalTo(3));
@@ -351,7 +438,7 @@ public void testWithFields() throws Exception {
     }
 
     public void testMinAgg() throws Exception {
-        final Request mvtRequest = new Request(HttpGet.METHOD_NAME, INDEX_SHAPES + "/_mvt/location/" + z + "/" + x + "/" + y);
+        final Request mvtRequest = new Request(getHttpMethod(), INDEX_SHAPES + "/_mvt/location/" + z + "/" + x + "/" + y);
         mvtRequest.setJsonEntity(
             "{\n"
                 + "  \"aggs\": {\n"
@@ -370,6 +457,18 @@ public void testMinAgg() throws Exception {
         assertLayer(tile, META_LAYER, 4096, 1, 19);
     }
 
+    private String getHttpMethod() {
+        return random().nextBoolean() ? HttpGet.METHOD_NAME : HttpPost.METHOD_NAME;
+    }
+
+    private void assertFeatureType(VectorTile.Tile tile, String name, VectorTile.Tile.GeomType type) {
+        final VectorTile.Tile.Layer layer = getLayer(tile, name);
+        for (int i = 0; i < layer.getFeaturesCount(); i++) {
+            final VectorTile.Tile.Feature feature = layer.getFeatures(i);
+            assertThat(feature.getType(), Matchers.equalTo(type));
+        }
+    }
+
     private void assertLayer(VectorTile.Tile tile, String name, int extent, int numFeatures, int numTags) {
         final VectorTile.Tile.Layer layer = getLayer(tile, name);
         assertThat(layer.getExtent(), Matchers.equalTo(extent));

x-pack/plugin/vector-tile/src/main/java/org/elasticsearch/xpack/vectortile/rest/RestVectorTileAction.java

@@ -58,6 +58,7 @@
 import java.util.stream.Collectors;
 
 import static org.elasticsearch.rest.RestRequest.Method.GET;
+import static org.elasticsearch.rest.RestRequest.Method.POST;
 
 /**
  * Main class handling a call to the _mvt API.
@@ -81,7 +82,7 @@ public RestVectorTileAction() {}
 
     @Override
     public List<Route> routes() {
-        return List.of(new Route(GET, "{index}/_mvt/{field}/{z}/{x}/{y}"));
+        return List.of(new Route(GET, "{index}/_mvt/{field}/{z}/{x}/{y}"), new Route(POST, "{index}/_mvt/{field}/{z}/{x}/{y}"));
     }
 
     @Override

x-pack/plugin/vector-tile/src/main/java/org/elasticsearch/xpack/vectortile/rest/VectorTileRequest.java

@@ -141,6 +141,23 @@ static VectorTileRequest parseRestRequest(RestRequest restRequest) throws IOExce
                 PARSER.parse(contentParser, request, restRequest);
             }
         }
+        // Following the same strategy of the _search API, some parameters can be defined in the body or as URL parameters.
+        // URL parameters takes precedence so we check them here.
+        if (restRequest.hasParam(SearchSourceBuilder.SIZE_FIELD.getPreferredName())) {
+            request.setSize(restRequest.paramAsInt(SearchSourceBuilder.SIZE_FIELD.getPreferredName(), Defaults.SIZE));
+        }
+        if (restRequest.hasParam(GRID_PRECISION_FIELD.getPreferredName())) {
+            request.setGridPrecision(restRequest.paramAsInt(GRID_PRECISION_FIELD.getPreferredName(), Defaults.GRID_PRECISION));
+        }
+        if (restRequest.hasParam(EXTENT_FIELD.getPreferredName())) {
+            request.setExtent(restRequest.paramAsInt(EXTENT_FIELD.getPreferredName(), Defaults.EXTENT));
+        }
+        if (restRequest.hasParam(GRID_TYPE_FIELD.getPreferredName())) {
+            request.setGridType(restRequest.param(GRID_TYPE_FIELD.getPreferredName(), Defaults.GRID_TYPE.name()));
+        }
+        if (restRequest.hasParam(EXACT_BOUNDS_FIELD.getPreferredName())) {
+            request.setExactBounds(restRequest.paramAsBoolean(EXACT_BOUNDS_FIELD.getPreferredName(), Defaults.EXACT_BOUNDS));
+        }
         return request;
     }