WL#11858, DevAPI: Core API v1 alignment

Author: soklakov

CHANGES

@@ -3,6 +3,8 @@
 
 Version 8.0.12
 
+  - WL#11858, DevAPI: Core API v1 alignment.
+
   - Fix for Bug#27652379, NPE FROM GETSESSION(PROPERTIES) WHEN HOST PARAMETER IS GIVEN IN SMALL LETTER.
 
   - Fix for BUG#87600 (26724154), CONNECTOR THROWS 'MALFORMED DATABASE URL' ON NON MYSQL CONNECTION-URLS.

src/main/core-api/java/com/mysql/cj/conf/ConnectionUrl.java

@@ -475,12 +475,10 @@ protected HostInfo fixHostInfo(HostInfo hi) {
     }
 
     /**
-     * Subclasses should override this to perform any required preprocessing on the host information properties.
+     * Subclasses should override this to perform any required pre-processing on the host information properties.
      * 
      * @param hostProps
      *            the host properties map to process
-     * @return
-     *         the processed host properties map
      */
     protected void preprocessPerTypeHostProperties(Map<String, String> hostProps) {
         // To be overridden in subclasses if needed.

src/main/core-api/java/com/mysql/cj/conf/HostInfo.java

@@ -137,7 +137,7 @@ public HostInfo(DatabaseUrlContainer url, String host, int port, String user, St
     /**
      * Constructs a {@link HostInfo} instance initialized with the provided properties.
      * 
-     * @param properties
+     * @param props
      *            a connection arguments map.
      */
     public HostInfo(Properties props) {

src/main/user-api/java/com/mysql/cj/xdevapi/FindStatement.java

@@ -95,8 +95,21 @@ public interface FindStatement extends Statement<FindStatement, DocResult> {
      * @param limitOffset
      *            number of documents to skip
      * @return {@link FindStatement}
+     * @deprecated Deprecated in c/J 8.0.12, please use {@link #offset(long)} instead.
      */
-    FindStatement skip(long limitOffset);
+    @Deprecated
+    default FindStatement skip(long limitOffset) {
+        return offset(limitOffset);
+    }
+
+    /**
+     * Add/replace the document offset for this query.
+     * 
+     * @param limitOffset
+     *            number of documents to skip
+     * @return {@link FindStatement}
+     */
+    FindStatement offset(long limitOffset);
 
     /**
      * Add/replace the document limit for this query.

src/main/user-api/java/com/mysql/cj/xdevapi/ModifyStatement.java

@@ -82,16 +82,6 @@ public interface ModifyStatement extends Statement<ModifyStatement, Result> {
      */
     ModifyStatement unset(String... fields);
 
-    /**
-     * Unsupported.
-     * 
-     * @param document
-     *            document
-     * @return {@link ModifyStatement}
-     */
-    // TODO determine status of this feature
-    ModifyStatement merge(String document);
-
     /**
      * Takes in a patch object and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function.
      * Please note that {@link DbDoc} does not support expressions as a field values, please use {@link #patch(String)} method if you need
@@ -139,16 +129,4 @@ public interface ModifyStatement extends Statement<ModifyStatement, Result> {
      * @return {@link ModifyStatement}
      */
     ModifyStatement arrayAppend(String field, Object value);
-
-    /**
-     * Unsupported.
-     * 
-     * @param field
-     *            document path to the array field
-     * @param position
-     *            array index
-     * @return {@link ModifyStatement}
-     */
-    // TODO determine status of this feature
-    ModifyStatement arrayDelete(String field, int position);
 }

src/main/user-impl/java/com/mysql/cj/xdevapi/FilterableStatement.java

@@ -122,17 +122,6 @@ public STMT_T limit(long numberOfRows) {
         return (STMT_T) this;
     }
 
-    /**
-     * Synonym to {@link #offset(long)}.
-     * 
-     * @param limitOffset
-     *            number of rows to skip
-     * @return this statement
-     */
-    public STMT_T skip(long limitOffset) {
-        return offset(limitOffset);
-    }
-
     /**
      * Add maximum number of rows to skip before find others.
      * 

src/main/user-impl/java/com/mysql/cj/xdevapi/ModifyStatementImpl.java

@@ -37,7 +37,6 @@
 
 import com.mysql.cj.Messages;
 import com.mysql.cj.MysqlxSession;
-import com.mysql.cj.exceptions.FeatureNotAvailableException;
 import com.mysql.cj.protocol.x.StatementExecuteOk;
 import com.mysql.cj.protocol.x.XMessage;
 import com.mysql.cj.protocol.x.XMessageBuilder;
@@ -90,11 +89,6 @@ public ModifyStatement unset(String... fields) {
         return this;
     }
 
-    @Override
-    public ModifyStatement merge(String document) {
-        throw new FeatureNotAvailableException("TODO: not supported in xplugin");
-    }
-
     @Override
     public ModifyStatement patch(DbDoc document) {
         return patch(document.toString());
@@ -117,9 +111,4 @@ public ModifyStatement arrayAppend(String docPath, Object value) {
         this.updates.add(new UpdateSpec(UpdateType.ARRAY_APPEND, docPath).setValue(value));
         return this;
     }
-
-    @Override
-    public ModifyStatement arrayDelete(String field, int position) {
-        throw new FeatureNotAvailableException("TODO: not supported in xplugin");
-    }
 }

src/test/java/testsuite/x/devapi/CollectionFindTest.java

@@ -183,6 +183,7 @@ public void basicCollectionAsTable() {
         assertEquals(new Integer(1), ((JsonNumber) doc.get("xyz")).getInteger());
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void testLimitOffset() {
         if (!this.isSetForXTests) {
@@ -210,14 +211,21 @@ public void testLimitOffset() {
         assertFalse(docs.hasNext());
 
         // limit 3, offset 1, order by ID, make sure we don't see the first ID
-        docs = this.collection.find().orderBy("$._id").limit(3).skip(1).execute();
+        docs = this.collection.find().orderBy("$._id").limit(3).offset(1).execute();
         assertTrue(docs.hasNext());
         assertNotEquals(firstId, ((JsonString) docs.next().get("_id")).getString());
         assertTrue(docs.hasNext());
         assertNotEquals(firstId, ((JsonString) docs.next().get("_id")).getString());
         assertTrue(docs.hasNext());
         assertNotEquals(firstId, ((JsonString) docs.next().get("_id")).getString());
         assertFalse(docs.hasNext());
+
+        // Test deprecated skip(n) alias for offset
+        // limit 1, offset 1, order by ID, make sure we don't see the first ID
+        docs = this.collection.find().orderBy("$._id").limit(1).skip(1).execute();
+        assertTrue(docs.hasNext());
+        assertNotEquals(firstId, ((JsonString) docs.next().get("_id")).getString());
+        assertFalse(docs.hasNext());
     }
 
     @Test
@@ -885,4 +893,54 @@ public void getOne() {
         doc = this.collection.getOne(null);
         assertNull(doc);
     }
+
+    @Test
+    public void testGroupingQuery() {
+        if (!this.isSetForXTests) {
+            return;
+        }
+
+        this.collection.add("{\"_id\": \"01\", \"name\":\"Mamie\", \"age\":11, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"02\", \"name\":\"Eulalia\", \"age\":11, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"03\", \"name\":\"Polly\", \"age\":12, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"04\", \"name\":\"Rufus\", \"age\":12, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"05\", \"name\":\"Cassidy\", \"age\":13, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"06\", \"name\":\"Olympia\", \"age\":14, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"07\", \"name\":\"Lev\", \"age\":14, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"08\", \"name\":\"Tierney\", \"age\":15, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"09\", \"name\":\"Octavia\", \"age\":15, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"10\", \"name\":\"Vesper\", \"age\":16, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"11\", \"name\":\"Caspian\", \"age\":17, \"something\":0}").execute();
+        this.collection.add("{\"_id\": \"12\", \"name\":\"Romy\", \"age\":17, \"something\":0}").execute();
+
+        // Result:
+        // age_group | cnt
+        // 11        | 2   <-- filtered out by where
+        // 12        | 2   <-- filtered out by limit
+        // 13        | 1   <-- filtered out by having
+        // 14        | 2   * second row in result
+        // 15        | 2   * first row in result
+        // 16        | 1   <-- filtered out by having
+        // 17        | 2   <-- filtered out by offset
+        DocResult res = this.collection.find("age > 11 and 1 < 2 and 40 between 30 and 900") //
+                .fields("age as age_group, count(name) as cnt, something as something") //
+                .groupBy("something, age") //
+                .having("count(name) > 1") //
+                .orderBy("age desc") //
+                .limit(2).offset(1) //
+                .execute();
+
+        assertEquals(2, res.count());
+
+        DbDoc doc = res.fetchOne();
+        assertEquals(15, ((JsonNumber) doc.get("age_group")).getInteger().intValue());
+        assertEquals(2, ((JsonNumber) doc.get("cnt")).getInteger().intValue());
+        assertEquals(0, ((JsonNumber) doc.get("something")).getInteger().intValue());
+
+        doc = res.fetchOne();
+        assertEquals(14, ((JsonNumber) doc.get("age_group")).getInteger().intValue());
+        assertEquals(2, ((JsonNumber) doc.get("cnt")).getInteger().intValue());
+        assertEquals(0, ((JsonNumber) doc.get("something")).getInteger().intValue());
+
+    }
 }