Bug#32975221: 5.7.29+ REGRESSION, SPATIAL INDEX NOT USED

              ANYMORE FOR MBRCONTAINS

Description:
============
This is a regression from the fix for Bug#29770705. The fix
introduced cloning of range tree for a special case when we
have a predicate having an AND condition ("pred1 AND pred2")
and one part of this AND condition is not a simple
predicate(an OR condition - "pred2"). For such a case, we
needed to clone the range tree created for "pred1". However,
when we clone the range tree, we do not copy the "geometry
flag" associated with the range tree. This results in
ignoring the spatial index available to do the range scan.

Fix
===
Copy the `rkey_func_flag` from original tree if GEOM_FLAG is
set.

On 8.0, this issue is not reproducible because the use_count
handling is different and clone() is not invoked. However it
is clear that for some case it might fail. So we need the
changes, hence added the unit test for the same.

Change-Id: I36312bc2c11db4e4e77d67e9443a98b37ade38e8

Author: wikigurram

mysql-test/r/gis.result

@@ -3077,3 +3077,20 @@ ST_GeometryType(ST_GeomFromText('POINT(1 1)')) HOUR_SECOND;
 '2010-10-10 10:10:10' + INTERVAL
 ST_GeometryType(ST_GeomFromText('POINT(1 1)')) HOUR_SECOND
 2010-10-10 10:10:10
+#
+# Bug #32975221 5.7.29+ REGRESSION, SPATIAL INDEX NOT USED ANYMORE FOR MBRCONTAINS
+#
+CREATE TABLE t (
+c1 VARCHAR(8) NOT NULL,
+c2 VARCHAR(16) NOT NULL,
+geom POINT NOT NULL,
+PRIMARY KEY (c2,c1),
+SPATIAL KEY coord (geom)
+) ENGINE=INNODB DEFAULT CHARSET=UTF8;
+INSERT INTO t VALUES (1, 2, POINT(1, 2));
+EXPLAIN SELECT COUNT(*) FROM t WHERE MBRCONTAINS(ST_GEOMFROMTEXT('POLYGON((1 2, 2 2, 2 3, 1 2))'), geom) AND c1 <> '10';
+id	select_type	table	partitions	type	possible_keys	key	key_len	ref	rows	filtered	Extra
+1	SIMPLE	t	NULL	range	coord	coord	34	NULL	##	##	Using where
+Warnings:
+Note	1003	/* select#1 */ select count(0) AS `COUNT(*)` from `test`.`t` where (mbrcontains(<cache>(st_geometryfromtext('POLYGON((1 2, 2 2, 2 3, 1 2))')),`test`.`t`.`geom`) and (`test`.`t`.`c1` <> '10'))
+DROP TABLE t;

mysql-test/t/gis.test

@@ -2868,3 +2868,21 @@ DROP TABLE d, dp, r;
 SET collation_connection='utf32_bin';
 SELECT '2010-10-10 10:10:10' + INTERVAL
   ST_GeometryType(ST_GeomFromText('POINT(1 1)')) HOUR_SECOND;
+
+--echo #
+--echo # Bug #32975221 5.7.29+ REGRESSION, SPATIAL INDEX NOT USED ANYMORE FOR MBRCONTAINS
+--echo #
+
+CREATE TABLE t (
+  c1 VARCHAR(8) NOT NULL,
+  c2 VARCHAR(16) NOT NULL,
+  geom POINT NOT NULL,
+  PRIMARY KEY (c2,c1),
+  SPATIAL KEY coord (geom)
+) ENGINE=INNODB DEFAULT CHARSET=UTF8;
+
+INSERT INTO t VALUES (1, 2, POINT(1, 2));
+
+--replace_column 10 ## 11 ##
+EXPLAIN SELECT COUNT(*) FROM t WHERE MBRCONTAINS(ST_GEOMFROMTEXT('POLYGON((1 2, 2 2, 2 3, 1 2))'), geom) AND c1 <> '10';
+DROP TABLE t;

sql/opt_range.cc

@@ -497,7 +497,8 @@ class SEL_ARG :public Sql_alloc
   SEL_ARG(SEL_ARG &);
   SEL_ARG(Field *,const uchar *, const uchar *);
   SEL_ARG(Field *field, uint8 part, uchar *min_value, uchar *max_value,
-	  uint8 min_flag, uint8 max_flag, uint8 maybe_flag);
+	  uint8 min_flag, uint8 max_flag, uint8 maybe_flag,
+	  enum ha_rkey_function gis_func_flag);
   /*
     Used to construct MAYBE_KEY and IMPOSSIBLE SEL_ARGs. left and
     right is NULL, so this ctor must not be used to create other
@@ -582,18 +583,21 @@ class SEL_ARG :public Sql_alloc
       new_max=arg->max_value; flag_max=arg->max_flag;
     }
     return new (mem_root) SEL_ARG(field, part, new_min, new_max, flag_min, flag_max,
-		       MY_TEST(maybe_flag && arg->maybe_flag));
+		       MY_TEST(maybe_flag && arg->maybe_flag),
+		       flag_min & GEOM_FLAG ? rkey_func_flag : HA_READ_INVALID);
   }
   SEL_ARG *clone_first(SEL_ARG *arg, MEM_ROOT *mem_root)
   {						// min <= X < arg->min
     return new (mem_root) SEL_ARG(field,part, min_value, arg->min_value,
 		       min_flag, arg->min_flag & NEAR_MIN ? 0 : NEAR_MAX,
-		       maybe_flag | arg->maybe_flag);
+		       maybe_flag | arg->maybe_flag,
+		       min_flag & GEOM_FLAG ? rkey_func_flag : HA_READ_INVALID);
   }
   SEL_ARG *clone_last(SEL_ARG *arg, MEM_ROOT *mem_root)
   {						// min <= X <= key_max
     return new (mem_root) SEL_ARG(field, part, min_value, arg->max_value,
-		       min_flag, arg->max_flag, maybe_flag | arg->maybe_flag);
+		       min_flag, arg->max_flag, maybe_flag | arg->maybe_flag,
+		       min_flag & GEOM_FLAG ? rkey_func_flag : HA_READ_INVALID);
   }
   SEL_ARG *clone(RANGE_OPT_PARAM *param, SEL_ARG *new_parent, SEL_ARG **next);
 
@@ -2134,10 +2138,11 @@ SEL_ARG::SEL_ARG(Field *f,const uchar *min_value_arg,
 
 SEL_ARG::SEL_ARG(Field *field_,uint8 part_,
                  uchar *min_value_, uchar *max_value_,
-		 uint8 min_flag_,uint8 max_flag_,uint8 maybe_flag_)
+		 uint8 min_flag_,uint8 max_flag_,uint8 maybe_flag_,
+		 enum ha_rkey_function gis_func_flag)
   :min_flag(min_flag_),max_flag(max_flag_),maybe_flag(maybe_flag_), part(part_),
   maybe_null(field_->real_maybe_null()),
-  rkey_func_flag(HA_READ_INVALID), elements(1),use_count(1),
+  rkey_func_flag(gis_func_flag), elements(1),use_count(1),
   field(field_), min_value(min_value_), max_value(max_value_),
   left(&null_element), right(&null_element),
   next(NULL), prev(NULL), next_key_part(0), color(BLACK), type(KEY_RANGE)
@@ -2163,7 +2168,9 @@ SEL_ARG *SEL_ARG::clone(RANGE_OPT_PARAM *param, SEL_ARG *new_parent,
   else
   {
     if (!(tmp= new (param->mem_root) SEL_ARG(field,part, min_value,max_value,
-                                             min_flag, max_flag, maybe_flag)))
+                                             min_flag, max_flag, maybe_flag,
+                                             min_flag & GEOM_FLAG ?
+                                             rkey_func_flag : HA_READ_INVALID)))
       return 0;					// OOM
     tmp->parent=new_parent;
     tmp->next_key_part=next_key_part;

unittest/gunit/opt_range-t.cc

@@ -2066,6 +2066,25 @@ TEST_F(OptRangeTest, AppendRange)
   EXPECT_STREQ("42 < my_field < 42", out.c_ptr());
 }
 
+TEST_F(OptRangeTest, CloneSpatialKey) {
+  Fake_RANGE_OPT_PARAM param(thd(), &m_alloc, 2, false);
+  Mock_SEL_ARG key1(SEL_ARG::KEY_RANGE, 2, 0);
+  Mock_SEL_ARG key2(SEL_ARG::MAYBE_KEY, 1, 0);
+  // dummy field
+  Mock_field_long field1("geom1");
+  key1.field = &field1;
+  key1.left = &null_element;
+  key1.next_key_part = NULL;
+  key1.min_flag |= GEOM_FLAG;
+  key1.rkey_func_flag = HA_READ_MBR_CONTAIN;
+  // check if tree is cloned along with gis flag.
+  SEL_ARG *cloned_key1 = key_and(&param, &key1, &key2, CLONE_KEY2_MAYBE);
+  EXPECT_NE(cloned_key1, &key1);
+  EXPECT_EQ(cloned_key1->rkey_func_flag, key1.rkey_func_flag);
+  key1.use_count = 0;
+  key2.use_count = 0;
+}
+
 }
 
 #undef create_tree