[GEO] GIS envelope validation

[missinglink]

This is likely related to spatial4j. There is an inconsistency [bug?] in the way the envelope geo-shape type is being validated.

The docs say that the envelope format "consists of coordinates for upper left and lower right points of the shape to represent a bounding rectangle".

However, being human it's pretty easy to screw this up, of the 4 different ways you can specify the co-ordinates; one is correct, two throw validation errors and one bites you every time by not throwing and messing up all your results.

Below I've attached a minimal testcase which outlines the 3 different ways you could screw up specifying the envelope and the status code and error produced for each.

I would expect the last request to error the same as the previous 2 do with a message like "maxX must be >= minX: 1.0 to -1.0"

here's an example of the sort of confusion this causes:

• GIS Query not working on ES as expected #9079
• Bug in geo_bounding_box #9067

There's actually a bunch more like this in the issue tracker so it's pretty low-hanging-fruit for resolving much frustration, complaining and time-wasting with GIS bbox queries in ES.

#!/bin/bash

################################################
# geo_shape envelope validation
################################################

ES='localhost:9200';

# drop index
curl -XDELETE "$ES/foo?pretty=true" 2>/dev/null;

# create index
curl -XPUT "$ES/foo?pretty=true" -d'
{ 
  "settings": {
    "index": {
      "number_of_shards": 1,
      "number_of_replicas": 0
    }
  },
  "mappings": {
    "bar": {
      "properties": {
        "polys" : {
          "type" : "geo_shape",
          "tree" : "quadtree",
          "tree_levels" : "26"
        }
      }
    }
  }
}';

# index a single polygon, so the index isn't empty
curl -XPOST "$ES/foo/bar/1?pretty=true" -d'
{
  "polys":{
    "type":"Polygon",
    "coordinates":[[
      ["-1","1"],
      ["-1","-1"],
      ["1","-1"],
      ["1","1"],
      ["-1","1"]
    ]]
  }
}';

# top-left / bottom-right (correct)
#200 OK
curl -XPOST "$ES/foo/_search?pretty=true" -d'
{
  "query": {
    "geo_shape": {
      "polys": {
        "shape": {
          "type": "envelope",
          "coordinates": [
            ["-1", "1"],
            ["1", "-1"]
          ]
        }
      }
    }
  }
}';

# bottom-left / top-right (wrong)
#400 InvalidShapeException[maxY must be >= minY: 1.0 to -1.0]
curl -XPOST "$ES/foo/_search?pretty=true" -d'
{
  "query": {
    "geo_shape": {
      "polys": {
        "shape": {
          "type": "envelope",
          "coordinates": [
            ["-1", "-1"],
            ["1", "1"]
          ]
        }
      }
    }
  }
}';

# bottom-right / top-left (wrong)
#400 InvalidShapeException[maxY must be >= minY: 1.0 to -1.0]
curl -XPOST "$ES/foo/_search?pretty=true" -d'
{
  "query": {
    "geo_shape": {
      "polys": {
        "shape": {
          "type": "envelope",
          "coordinates": [
            ["1", "-1"],
            ["-1", "1"]
          ]
        }
      }
    }
  }
}';

# top-right / bottom-left (wrong)
#200 OK
curl -XPOST "$ES/foo/_search?pretty=true" -d'
{
  "query": {
    "geo_shape": {
      "polys": {
        "shape": {
          "type": "envelope",
          "coordinates": [
            ["1", "1"],
            ["-1", "-1"]
          ]
        }
      }
    }
  }
}';