Merge branch 'feat/deleteBy'

Author: PLNech

algoliasearch/src/main/java/com/algolia/search/saas/Index.java

@@ -657,7 +657,6 @@ public Request getObjectsAsync(final @NonNull List<String> objectIDs, final List
      * @param taskID            Identifier of the task (as returned by the server).
      * @param completionHandler The listener that will be notified of the request's outcome.
      * @return A cancellable request.
-     *
      * @deprecated Task IDs are always integers. Please use {@link #waitTaskAsync(int, CompletionHandler)} instead.
      */
     public Request waitTaskAsync(final @NonNull String taskID, @NonNull CompletionHandler completionHandler) {
@@ -743,11 +742,12 @@ public Request deleteObjectsAsync(final @NonNull List<String> objectIDs, @Nullab
     }
 
     /**
-     * Delete all objects matching a query (helper).
+     * Delete all objects matching a query (helper) using browse and deleteObjects.
      *
      * @param query             The query that objects to delete must match.
      * @param completionHandler The listener that will be notified of the request's outcome.
      * @return A cancellable request.
+     * @deprecated use {@link Index#deleteByAsync(Query, CompletionHandler)} instead.
      */
     public Request deleteByQueryAsync(@NonNull Query query, CompletionHandler completionHandler) {
         return deleteByQueryAsync(query, /* requestOptions: */ null, completionHandler);
@@ -772,6 +772,23 @@ public Request deleteByQueryAsync(@NonNull Query query, @Nullable final RequestO
         }.start();
     }
 
+    /**
+     * Delete all objects matching a query (helper).
+     *
+     * @param query             The query that objects to delete must match.
+     * @param completionHandler The listener that will be notified of the request's outcome.
+     * @return A cancellable request.
+     */
+    public Request deleteByAsync(@NonNull Query query, CompletionHandler completionHandler) {
+        final Query queryCopy = new Query(query);
+        return getClient().new AsyncTaskRequest(completionHandler) {
+            @NonNull
+            @Override protected JSONObject run() throws AlgoliaException {
+                return deleteBy(queryCopy);
+            }
+        }.start();
+    }
+
     /**
      * Get this index's settings (asynchronously).
      *
@@ -1238,12 +1255,14 @@ protected JSONObject deleteObjects(List<String> objects, @Nullable RequestOption
     }
 
     /**
-     * Delete all objects matching a query
+     * Delete all objects matching a query using browse and deleteObjects.
      *
      * @param query the query string
      * @param requestOptions Request-specific options.
      * @throws AlgoliaException
+     * @deprecated use {@link Index#deleteBy(Query)} instead.
      */
+    @Deprecated
     protected void deleteByQuery(@NonNull Query query, @Nullable RequestOptions requestOptions) throws AlgoliaException {
         try {
             boolean hasMore;
@@ -1269,6 +1288,21 @@ protected void deleteByQuery(@NonNull Query query, @Nullable RequestOptions requ
         }
     }
 
+    /**
+     * Delete all records matching the query.
+     *
+     * @param query the query string
+     * @throws AlgoliaException
+     */
+    protected JSONObject deleteBy(@NonNull Query query) throws AlgoliaException {
+        try {
+            return client.postRequest("/1/indexes/" + indexName + "/deleteByQuery", query.getParameters(), new JSONObject().put("params", query.build()).toString(), false, /* requestOptions: */ null);
+        } catch (JSONException e) {
+            e.printStackTrace();
+            return null;
+        }
+    }
+
     /**
      * Search inside the index
      *

algoliasearch/src/test/java/com/algolia/search/saas/IndexTest.java

@@ -785,6 +785,41 @@ public void doRequestCompleted(JSONObject content, AlgoliaException error) {
         });
     }
 
+    @Test
+    public void deleteByAsync() throws Exception {
+        addDummyObjects(3000);
+        final Query query = new Query().setNumericFilters(new JSONArray().put("dummy < 1500"));
+        index.deleteByAsync(query, new AssertCompletionHandler() {
+            @Override
+            public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+                if (error == null) {
+                    int taskID = content.optInt("taskID");
+                    index.waitTaskAsync(taskID, new AssertCompletionHandler() {
+                        @Override
+                        public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+                            assertNull(error);
+                            index.browseAsync(query, new AssertCompletionHandler() {
+                                @Override
+                                public void doRequestCompleted(JSONObject content, AlgoliaException error) {
+                                    if (error == null) {
+                                        // There should not remain any object matching the query.
+                                        assertNotNull(content.optJSONArray("hits"));
+                                        assertEquals(0, content.optJSONArray("hits").length());
+                                        assertNull(content.optString("cursor", null));
+                                    } else {
+                                        fail("Fail inner: " + error.getMessage());
+                                    }
+                                }
+                            });
+                        }
+                    });
+                } else {
+                    fail("Fail outer: " + error.getMessage());
+                }
+            }
+        });
+    }
+
     @Test
     public void error404() throws Exception {
         Index unknownIndex = client.getIndex("doesnotexist");