From 84d8078f12da9ce011c2ce2e7093b7078186bffc Mon Sep 17 00:00:00 2001
From: Trevor Anderson <63077034+trande4884@users.noreply.github.com>
Date: Fri, 24 Jun 2022 05:08:48 -0400
Subject: [PATCH] Performance improvement for case insensitive queries (#29597)

* Performance update for case insensitive queries. No unit tests needed as functionality is already tested with existing tests.

* Fixing logic error.

* Updating logic to be more accurate, including addinga new CriteriaType function. Also added unit tests.

* Adding performance enhancing logic for IS_EQUAL and unit tests.

* Fixing IS_EQUAL performance logic related to case insensitive search and added unit tests.

* Fixing code style issues.

* Update CriteriaType.java

* Update AbstractQueryGenerator.java

* Update CriteriaType.java

* Update AbstractQueryGenerator.java

* Update AbstractQueryGenerator.java

Co-authored-by: Fabian Meiswinkel <fabian@meiswinkel.com>
---
 .../data/cosmos/core/CosmosTemplateIT.java    | 33 ++++++++++++
 .../generator/AbstractQueryGenerator.java     | 17 ++++--
 .../data/cosmos/core/query/CriteriaType.java  | 25 ++++++++-
 .../generator/AbstractQueryGeneratorTest.java | 53 ++++++++++++++++++-
 4 files changed, 122 insertions(+), 6 deletions(-)

diff --git a/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java b/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java
index 01c6651c4399b..eb19fa2b42d4b 100644
--- a/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java
+++ b/sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java
@@ -573,6 +573,39 @@ public void testArrayContainsCriteria() {
         assertThat(people).containsExactly(TEST_PERSON);
     }
 
+    @Test
+    public void testIsNotNullCriteriaCaseSensitive() {
+        Criteria hasLastName = Criteria.getInstance(CriteriaType.IS_NOT_NULL, "lastName",
+            Collections.emptyList(),
+            Part.IgnoreCaseType.ALWAYS);
+        List<Person> people = TestUtils.toList(cosmosTemplate.find(new CosmosQuery(hasLastName), Person.class,
+            containerName));
+
+        assertThat(people).containsExactly(TEST_PERSON);
+    }
+
+    @Test
+    public void testStartsWithCriteriaCaseSensitive() {
+        Criteria nameStartsWith = Criteria.getInstance(CriteriaType.STARTS_WITH, "firstName",
+            Collections.singletonList(TEST_PERSON.getFirstName().toUpperCase()),
+            Part.IgnoreCaseType.ALWAYS);
+        List<Person> people = TestUtils.toList(cosmosTemplate.find(new CosmosQuery(nameStartsWith), Person.class,
+            containerName));
+
+        assertThat(people).containsExactly(TEST_PERSON);
+    }
+
+    @Test
+    public void testIsEqualCriteriaCaseSensitive() {
+        Criteria nameStartsWith = Criteria.getInstance(CriteriaType.IS_EQUAL, "firstName",
+            Collections.singletonList(TEST_PERSON.getFirstName().toUpperCase()),
+            Part.IgnoreCaseType.ALWAYS);
+        List<Person> people = TestUtils.toList(cosmosTemplate.find(new CosmosQuery(nameStartsWith), Person.class,
+            containerName));
+
+        assertThat(people).containsExactly(TEST_PERSON);
+    }
+
     @Test
     public void testBetweenCriteria() {
         Criteria ageBetween = Criteria.getInstance(CriteriaType.BETWEEN, "age", Arrays.asList(AGE - 1, AGE + 1),
diff --git a/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGenerator.java b/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGenerator.java
index 80544c6f8cfef..0027706f1cb2a 100644
--- a/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGenerator.java
+++ b/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGenerator.java
@@ -64,7 +64,13 @@ private String generateBinaryQuery(@NonNull Criteria criteria, @NonNull List<Pai
         parameters.add(Pair.of(parameter, subjectValue));
 
         if (CriteriaType.isFunction(criteria.getType())) {
-            return getFunctionCondition(ignoreCase, sqlKeyword, subject, parameter);
+            return getFunctionCondition(ignoreCase, sqlKeyword, subject, parameter,
+                CriteriaType.isFunctionWithCaseSensitiveSupport(criteria.getType()));
+        } else if (criteria.getType() == CriteriaType.IS_EQUAL
+                && ignoreCase != Part.IgnoreCaseType.NEVER
+                && subjectValue instanceof String) {
+            return getFunctionCondition(ignoreCase, CriteriaType.STRING_EQUALS.getSqlKeyword(),
+                subject, parameter, true);
         } else {
             return getCondition(ignoreCase, sqlKeyword, subject, parameter);
         }
@@ -95,14 +101,19 @@ private String getCondition(final Part.IgnoreCaseType ignoreCase, final String s
      * @param sqlKeyword sql key word, operation name
      * @param subject sql column name
      * @param parameter sql filter value
+     * @param takesCaseSensitiveParam if the function type can take the third boolean param
      * @return condition string
      */
     private String getFunctionCondition(final Part.IgnoreCaseType ignoreCase, final String sqlKeyword,
-                                        final String subject, final String parameter) {
+                                        final String subject, final String parameter, final boolean takesCaseSensitiveParam) {
         if (Part.IgnoreCaseType.NEVER == ignoreCase) {
             return String.format("%s(r.%s, @%s)", sqlKeyword, subject, parameter);
         } else {
-            return String.format("%s(UPPER(r.%s), UPPER(@%s))", sqlKeyword, subject, parameter);
+            if (takesCaseSensitiveParam) {
+                return String.format("%s(r.%s, @%s, true)", sqlKeyword, subject, parameter);
+            } else {
+                return String.format("%s(UPPER(r.%s), UPPER(@%s))", sqlKeyword, subject, parameter);
+            }
         }
     }
 
diff --git a/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/query/CriteriaType.java b/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/query/CriteriaType.java
index 51cba65c33c45..dfa100ccc9bc9 100644
--- a/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/query/CriteriaType.java
+++ b/sdk/cosmos/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/query/CriteriaType.java
@@ -123,7 +123,12 @@ public enum CriteriaType {
     /**
      * Array contains
      */
-    ARRAY_CONTAINS("ARRAY_CONTAINS");
+    ARRAY_CONTAINS("ARRAY_CONTAINS"),
+    
+    /**
+     * String equals
+     */
+    STRING_EQUALS("STRINGEQUALS");
 
     private String sqlKeyword;
 
@@ -274,6 +279,24 @@ public static boolean isFunction(CriteriaType type) {
         }
     }
 
+    /**
+     * Check if CriteriaType operation is a function.
+     *
+     * @param type CriteriaType
+     * @return True if match, or false.
+     */
+    public static boolean isFunctionWithCaseSensitiveSupport(CriteriaType type) {
+        switch (type) {
+            case CONTAINING:
+            case ENDS_WITH:
+            case STARTS_WITH:
+            case STRING_EQUALS:
+                return true;
+            default:
+                return false;
+        }
+    }
+
     /**
      * Check if CriteriaType operation is unary, with format of (ops A -&gt; B).
      *
diff --git a/sdk/cosmos/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGeneratorTest.java b/sdk/cosmos/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGeneratorTest.java
index f7ffd7621a2c8..38404af5ff98d 100644
--- a/sdk/cosmos/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGeneratorTest.java
+++ b/sdk/cosmos/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/core/generator/AbstractQueryGeneratorTest.java
@@ -15,9 +15,10 @@
 import org.junit.Test;
 import org.mockito.Mock;
 import org.springframework.data.repository.query.parser.Part;
+import org.springframework.data.util.*;
+import org.springframework.lang.*;
 
-import java.util.Collections;
-import java.util.List;
+import java.util.*;
 import java.util.stream.Collectors;
 
 public class AbstractQueryGeneratorTest {
@@ -48,6 +49,54 @@ public void binaryOperatorPriorityPreserved() {
             "(", parameterNames.get(1), CriteriaType.OR.getSqlKeyword(), parameterNames.get(2), ")"));
     }
 
+    @Test
+    public void generateBinaryQueryWithStartsWithDoesNotUseUpper() {
+        Criteria nameStartsWith = Criteria.getInstance(CriteriaType.STARTS_WITH, "firstName",
+            Collections.singletonList("TREVOR"),
+            Part.IgnoreCaseType.ALWAYS);
+        CosmosQuery query = new CosmosQuery(nameStartsWith);
+
+        SqlQuerySpec result = queryGenerator.generateCosmos(query);
+
+        Assert.assertEquals(result.getQueryText(), " WHERE STARTSWITH(r.firstName, @firstName0, true) ");
+    }
+
+    @Test
+    public void generateBinaryQueryWithArrayContainsUsesUpper() {
+        Criteria hasLastName = Criteria.getInstance(CriteriaType.ARRAY_CONTAINS, "lastName",
+            Collections.singletonList("ANDERSON"),
+            Part.IgnoreCaseType.ALWAYS);
+        CosmosQuery query = new CosmosQuery(hasLastName);
+
+        SqlQuerySpec result = queryGenerator.generateCosmos(query);
+
+        Assert.assertEquals(result.getQueryText(), " WHERE ARRAY_CONTAINS(UPPER(r.lastName), UPPER(@lastName0)) ");
+    }
+
+    @Test
+    public void generateBinaryQueryWithIsEqualIntUsesUpper() {
+        Criteria isEqualInt = Criteria.getInstance(CriteriaType.IS_EQUAL, "zipcode",
+            Collections.singletonList(20180),
+            Part.IgnoreCaseType.ALWAYS);
+        CosmosQuery query = new CosmosQuery(isEqualInt);
+
+        SqlQuerySpec result = queryGenerator.generateCosmos(query);
+
+        Assert.assertEquals(result.getQueryText(), " WHERE UPPER(r.zipcode) = UPPER(@zipcode0) ");
+    }
+
+    @Test
+    public void generateBinaryQueryWithIsEqualStringDoesNotUseUpper() {
+        Criteria isEqualString = Criteria.getInstance(CriteriaType.IS_EQUAL, "firstName",
+            Collections.singletonList("TREVOR"),
+            Part.IgnoreCaseType.ALWAYS);
+        CosmosQuery query = new CosmosQuery(isEqualString);
+
+        SqlQuerySpec result = queryGenerator.generateCosmos(query);
+
+        Assert.assertEquals(result.getQueryText(), " WHERE STRINGEQUALS(r.firstName, @firstName0, true) ");
+    }
+
     private static class EmptyQueryGenerator extends AbstractQueryGenerator implements QuerySpecGenerator {
 
         @Override