feat: support field a compares to field b for cosmosdb (#104)

Author: thunderz99

README.md

@@ -23,7 +23,7 @@ java-cosmos is a client for Azure CosmosDB 's SQL API (also called documentdb fo
 <dependency>
   <groupId>com.github.thunderz99</groupId>
     <artifactId>java-cosmos</artifactId>
-    <version>0.6.7</version>
+    <version>0.6.8</version>
 </dependency>
 ```
 
@@ -254,6 +254,7 @@ The main difference between Partial update and Patch is that:
         "firstName STARTSWITH","H", // see cosmosdb STARTSWITH
         "desciption CONTAINS","Project manager",// see cosmosdb CONTAINS
         "fullName.last RegexMatch","[A-Z]{1}ank\\w+$", // see cosmosdb RegexMatch
+        "mail !=",Condition.key("mail2"), // using field a compares to field b
         "certificates IS_DEFINED",true, // see cosmosdb IS_DEFINED
         "families.villa IS_DEFINED",false, // see cosmosdb IS_DEFINED
         "age IS_NUMBER",true, // see cosmosdb type check functions

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.github.thunderz99</groupId>
     <artifactId>java-cosmos</artifactId>
     <packaging>jar</packaging>
-    <version>0.6.7</version>
+    <version>0.6.8</version>
     <name>${project.groupId}:${project.artifactId}$</name>
     <description>A lightweight Azure CosmosDB client for Java</description>
     <url>https://github.com/thunderz99/java-cosmos</url>

src/main/java/io/github/thunderz99/cosmos/condition/Condition.java

@@ -961,4 +961,15 @@ public String getRawQuerySpecJson() {
         return JsonUtil.toJson(this.rawQuerySpec);
     }
 
+    /**
+     * Return a FieldKey obj representing a keyName in json documents of db
+     *
+     * @param keyName
+     * @return fieldKey obj
+     */
+    public static FieldKey key(String keyName) {
+        return new FieldKey(keyName);
+    }
+
+
 }

src/main/java/io/github/thunderz99/cosmos/condition/FieldKey.java

@@ -0,0 +1,23 @@
+package io.github.thunderz99.cosmos.condition;
+
+import io.github.thunderz99.cosmos.dto.RecordData;
+
+/**
+ * A class representing a key of a json field. e.g. "name" for "c.name" or "address.country" for "c.address.country"
+ *
+ * <pre>
+ *     e.g. find documents where mail field does not equal mail2 field
+ *     Condition.filter("mail !=", Condition.key("mail2"))
+ * </pre>
+ */
+public class FieldKey extends RecordData {
+    public String keyName;
+
+    public FieldKey(){
+    }
+
+    public FieldKey(String keyName){
+        this.keyName = keyName;
+    }
+
+}

src/main/java/io/github/thunderz99/cosmos/condition/SimpleExpression.java

@@ -70,7 +70,7 @@ public CosmosSqlQuerySpec toQuerySpec(AtomicInteger paramIndex) {
         // fullName.last -> @param001_fullName__last
         // or
         // "829cc727-2d49-4d60-8f91-b30f50560af7.name" -> @param001_wg31gsa.name
-        var paramName = getParamNameFromKey(this.key, paramIndex.get());
+        var paramName = getParamNameFromKey(this.key, paramIndex.getAndIncrement());
 
         var paramValue = this.value;
 
@@ -88,7 +88,6 @@ public CosmosSqlQuerySpec toQuerySpec(AtomicInteger paramIndex) {
             // array equals or not
             if (Set.of("=", "!=").contains(this.operator)) {
                 // use = or !=
-                paramIndex.getAndIncrement();
                 ret.setQueryText(String.format(" (%s %s %s)", Condition.getFormattedKey(this.key), this.operator, paramName));
                 params.add(Condition.createSqlParameter(paramName, paramValue));
             } else {
@@ -99,32 +98,41 @@ public CosmosSqlQuerySpec toQuerySpec(AtomicInteger paramIndex) {
                     ret.setQueryText(" (1=0)");
 				} else {
 					// use ARRAY_CONTAINS by default to minimize the sql length
-					paramIndex.getAndIncrement();
 					ret.setQueryText(buildArrayContains(this.key, paramName, coll, params));
 				}
 			}
 
 		} else {
-			// single param value
+            // single param value
 
-			if (StringUtils.isEmpty(this.operator)) {
-				// set the default operator for scalar value
-				this.operator = "=";
-			}
+            if (StringUtils.isEmpty(this.operator)) {
+                // set the default operator for scalar value
+                this.operator = "=";
+            }
+
+            // paramName or fieldName
+            var valuePart = "";
+
+            if (paramValue instanceof FieldKey) {
+                // valuePart should be "mail2" for "c.mail != c.mail2"
+                valuePart = Condition.getFormattedKey(((FieldKey) paramValue).keyName);
+            } else {
+                // valuePart should be "@param001_wg31gsa"
+                valuePart = paramName;
+                params.add(Condition.createSqlParameter(paramName, paramValue));
+            }
 
-			paramIndex.getAndIncrement();
-			// other types
-			var formattedKey = Condition.getFormattedKey(this.key);
+            // other types
+            var formattedKey = Condition.getFormattedKey(this.key);
             if (this.type == OperatorType.BINARY_OPERATOR) { // operators, e.g. =, !=, <, >, LIKE
                 //use c["key"] for cosmosdb reserved words
-                ret.setQueryText(String.format(" (%s %s %s)", formattedKey, this.operator, paramName));
+                ret.setQueryText(String.format(" (%s %s %s)", formattedKey, this.operator, valuePart));
             } else if (Condition.typeCheckFunctionPattern.asMatchPredicate().test(this.operator)) { // type check funcs: IS_DEFINED|IS_NUMBER|IS_PRIMITIVE, etc
-                ret.setQueryText(String.format(" (%s(%s) = %s)", this.operator, formattedKey, paramName));
+                ret.setQueryText(String.format(" (%s(%s) = %s)", this.operator, formattedKey, valuePart));
             } else { // other binary funcs. e.g. STARTSWITH, CONTAINS, ARRAY_CONTAINS
-                ret.setQueryText(String.format(" (%s(%s, %s))", this.operator, formattedKey, paramName));
+                ret.setQueryText(String.format(" (%s(%s, %s))", this.operator, formattedKey, valuePart));
             }
 
-			params.add(Condition.createSqlParameter(paramName, paramValue));
 		}
 
 		ret.setParameters(params);

src/test/java/io/github/thunderz99/cosmos/CosmosDatabaseTest.java

@@ -838,7 +838,64 @@ public void regex_should_work_with_filter() throws Exception {
         }
 
     }
-    
+
+    @Test
+    public void field_a_equals_field_b_should_work_with_filter() throws Exception {
+
+        // test condition that use field a and field b
+        var id1 = "field_a_equals_field_b_should_work_with_filter1";
+        var id2 = "field_a_equals_field_b_should_work_with_filter2";
+        var partition = "FieldTest";
+        try {
+
+            var data1 = Map.of("id", id1, "mail", "mail1", "uniqueKey", "aaa");
+            var data2 = Map.of("id", id2, "mail", "mail2", "uniqueKey", "mail2");
+
+            db.upsert(coll, data1, partition);
+            db.upsert(coll, data2, partition);
+
+            {
+                // equal
+                var cond = Condition.filter("mail", Condition.key("uniqueKey") //
+                        ).sort("id", "ASC") //
+                        .limit(10) //
+                        .offset(0);
+
+                var results = db.find(coll, cond, partition).toMap();
+
+                assertThat(results.size()).isEqualTo(1);
+                assertThat(results.get(0)).containsEntry("id", id2);
+            }
+            {
+                // not equal
+                var cond = Condition.filter("mail !=", Condition.key("uniqueKey") //
+                        ).sort("id", "ASC") //
+                        .limit(10) //
+                        .offset(0);
+
+                var results = db.find(coll, cond, partition).toMap();
+
+                assertThat(results.size()).isEqualTo(1);
+                assertThat(results.get(0)).containsEntry("id", id1);
+            }
+            {
+                // greater than
+                var cond = Condition.filter("mail >=", Condition.key("uniqueKey") //
+                        ).sort("id", "ASC") //
+                        .limit(10) //
+                        .offset(0);
+
+                var results = db.find(coll, cond, partition).toMap();
+
+                assertThat(results.size()).isEqualTo(2);
+            }
+        } finally {
+            db.delete(coll, id1, partition);
+            db.delete(coll, id2, partition);
+        }
+
+    }
+
     @Test
     void aggregate_should_work() throws Exception {
         // test aggregate(simple)

src/test/java/io/github/thunderz99/cosmos/condition/ConditionTest.java

@@ -425,8 +425,8 @@ public void buildQuerySpec_should_work_empty_list() {
 		{
 			var q = Condition.filter("id", List.of(), "name", "Tom").toQuerySpec();
 
-			assertThat(q.getQueryText().trim()).isEqualTo("SELECT * FROM c WHERE (1=0) AND (c[\"name\"] = @param000_name) OFFSET 0 LIMIT 100");
-			assertThat(q.getParameters()).hasSize(1);
+			assertThat(q.getQueryText().trim()).isEqualTo("SELECT * FROM c WHERE (1=0) AND (c[\"name\"] = @param001_name) OFFSET 0 LIMIT 100");
+            assertThat(q.getParameters()).hasSize(1);
 		}
 
 		{