[GH-1761] error when invalid ST_Subdivide maxVertices argument (#1926)

Author: jgoday

common/src/main/java/org/apache/sedona/common/Functions.java

@@ -1866,6 +1866,9 @@ public static Geometry createMultiGeometryFromOneElement(Geometry geometry) {
   }
 
   public static Geometry[] subDivide(Geometry geometry, int maxVertices) {
+    if (maxVertices < 5) {
+      throw new IllegalArgumentException("ST_Subdivide needs 5 or more max vertices");
+    }
     return GeometrySubDivider.subDivide(geometry, maxVertices);
   }
 

common/src/test/java/org/apache/sedona/common/FunctionsTest.java

@@ -4420,4 +4420,12 @@ public void emptyPoint() throws ParseException {
     assertFalse(Functions.hasM(emptyPoint));
     assertFalse(Functions.hasZ(emptyPoint));
   }
+
+  @Test
+  public void subdivideInvalidMaxVertices() {
+    LineString lineString = GEOMETRY_FACTORY.createLineString(coordArray(0, 0, 99, 99));
+    IllegalArgumentException e =
+        assertThrows(IllegalArgumentException.class, () -> Functions.subDivide(lineString, 4));
+    assertEquals("ST_Subdivide needs 5 or more max vertices", e.getMessage());
+  }
 }

docs/api/flink/Function.md

@@ -4041,6 +4041,8 @@ POINT(100 150)
 
 Introduction: Returns list of geometries divided based of given maximum number of vertices.
 
+A minimum of 5 vertices is required for maxVertices parameter to form a closed box.
+
 Format: `ST_SubDivide(geom: Geometry, maxVertices: Integer)`
 
 Since: `v1.5.0`

docs/api/snowflake/vector-data/Function.md

@@ -3169,6 +3169,8 @@ Output: `POINT(100 150)`
 
 Introduction: Returns a multi-geometry divided based of given maximum number of vertices.
 
+A minimum of 5 vertices is required for maxVertices parameter to form a closed box.
+
 Format: `ST_SubDivide(geom: geometry, maxVertices: int)`
 
 SQL example:
@@ -3188,6 +3190,8 @@ MULTILINESTRING ((0 0, 5 5), (5 5, 10 10), (10 10, 21 21), (21 21, 60 60), (60 6
 
 Introduction: It works the same as ST_SubDivide but returns new rows with geometries instead of a multi-geometry.
 
+A minimum of 5 vertices is required for maxVertices parameter to form a closed box.
+
 Format: `
 SELECT SEDONA.ST_AsText(GEOM)
 FROM table(SEDONA.ST_SubDivideExplode(geom: geometry, maxVertices: int))`

docs/api/sql/Function.md

@@ -4253,6 +4253,8 @@ POINT(100 150)
 
 Introduction: Returns list of geometries divided based of given maximum number of vertices.
 
+A minimum of 5 vertices is required for maxVertices parameter to form a closed box.
+
 Format: `ST_SubDivide(geom: Geometry, maxVertices: Integer)`
 
 Since: `v1.1.0`
@@ -4309,6 +4311,8 @@ Output:
 
 Introduction: It works the same as ST_SubDivide but returns new rows with geometries instead of list.
 
+A minimum of 5 vertices is required for maxVertices parameter to form a closed box.
+
 Format: `ST_SubDivideExplode(geom: Geometry, maxVertices: Integer)`
 
 Since: `v1.1.0`

spark/common/src/test/scala/org/apache/sedona/sql/PreserveSRIDSuite.scala

@@ -75,7 +75,7 @@ class PreserveSRIDSuite extends TestBaseScala with TableDrivenPropertyChecks {
       ("ST_SetPoint(geom3, 1, ST_Point(0.5, 0.5))", 1000),
       ("ST_ClosestPoint(geom1, geom2)", 1000),
       ("ST_FlipCoordinates(geom1)", 1000),
-      ("ST_SubDivide(geom4, 4)", 1000),
+      ("ST_SubDivide(geom4, 5)", 1000),
       ("ST_MakeEnvelope(0, 1, 2, 3, 1000)", 1000),
       ("ST_MakeLine(geom3, geom3)", 1000),
       ("ST_Points(geom1)", 1000),

spark/common/src/test/scala/org/apache/sedona/sql/functionTestScala.scala

@@ -3770,4 +3770,14 @@ class functionTestScala
       "The Line has SRID 4326 and Point has SRID 3857. The Line and Point should be in the same SRID.")
   }
 
+  it("should raise an error when using ST_SubDivide with not enough vertices") {
+    val invalidDf = sparkSession.sql("""
+        |SELECT ST_Subdivide(ST_GeomFromWKT('LINESTRING(0 0, 99 99)'), 4) as result
+    """.stripMargin)
+
+    val exception = intercept[Exception] {
+      invalidDf.collect()
+    }
+    exception.getMessage should include("ST_Subdivide needs 5 or more max vertices")
+  }
 }