feat(deleteBy): add new deleteBy method that directly hits the new deleteByQuery endpoint

Author: spinach

Source/Index.swift

@@ -620,13 +620,36 @@ import Foundation
             }
         }
     }
+    
+    /// Delete all objects matching a query.
+    ///
+    /// - parameter query: The query that objects to delete must match.
+    /// - parameter requestOptions: Request-specific options.
+    /// - parameter completionHandler: Completion handler to be notified of the request's outcome.
+    /// - returns: A cancellable operation.
+    /// + Warning: Deprecated, use deleteBy instead.
+    ///
+    @objc
+    @discardableResult public func deleteBy(_ query: Query, requestOptions: RequestOptions? = nil, completionHandler: CompletionHandler? = nil) -> Operation {
+        let path = "1/indexes/\(urlEncodedName)/deleteByQuery"
+        let body = [
+            "params": query.build()
+        ]
+        return client.performHTTPQuery(path: path, method: .POST, body: body, hostnames: client.readHosts, requestOptions: requestOptions, completionHandler: completionHandler)
+    }
+    
+    @objc(deleteBy:completionHandler:)
+    @discardableResult public func z_objc_deleteBy(_ query: Query, completionHandler: CompletionHandler?) -> Operation {
+        return self.deleteBy(query, completionHandler: completionHandler)
+    }
 
     /// Delete all objects matching a query (helper).
     ///
     /// - parameter query: The query that objects to delete must match.
     /// - parameter requestOptions: Request-specific options.
     /// - parameter completionHandler: Completion handler to be notified of the request's outcome.
     /// - returns: A cancellable operation.
+    /// + Warning: Deprecated, use deleteBy instead.
     ///
     @objc
     @discardableResult public func deleteByQuery(_ query: Query, requestOptions: RequestOptions? = nil, completionHandler: CompletionHandler? = nil) -> Operation {

Tests/IndexTests.swift

@@ -844,6 +844,53 @@ class IndexTests: OnlineTestCase {
         self.waitForExpectations(timeout: expectationTimeout, handler: nil)
     }
 
+    func testDeleteBy() {
+        let expectation = self.expectation(description: #function)
+        var objects: [JSONObject] = []
+        for i in 0..<3000 {
+            objects.append(["dummy": i])
+        }
+        
+        // Add a batch of objects.
+        index.addObjects(objects, completionHandler: { (content, error) -> Void in
+            if error != nil {
+                XCTFail(error!.localizedDescription)
+                expectation.fulfill()
+            } else {
+                // Wait for the objects to be indexed.
+                self.index.waitTask(withID: content!["taskID"] as! Int, completionHandler: { (content, error) -> Void in
+                    if error != nil {
+                        XCTFail(error!.localizedDescription)
+                        expectation.fulfill()
+                    } else {
+                        // Delete by query.
+                        let query = Query()
+                        query.numericFilters = ["dummy < 1500"]
+                        self.index.deleteBy(query, completionHandler: { (content, error) -> Void in
+                            if error != nil {
+                                XCTFail(error!.localizedDescription)
+                                expectation.fulfill()
+                            } else {
+                                // Check that the deleted objects no longer exist.
+                                self.index.browse(query: query, completionHandler: { (content, error) in
+                                    if error != nil {
+                                        XCTFail(error!.localizedDescription)
+                                    } else {
+                                        XCTAssertEqual((content!["hits"] as? [Any])?.count, 0)
+                                        XCTAssertNil(content!["cursor"])
+                                    }
+                                    expectation.fulfill()
+                                })
+                            }
+                        })
+                    }
+                })
+            }
+        })
+        
+        self.waitForExpectations(timeout: expectationTimeout, handler: nil)
+    }
+    
     func testSearchDisjunctiveFaceting() {
         let expectation = self.expectation(description: "testAddObjects")
         let objects: [JSONObject] = [

Tests/ObjectiveCBridging.m

@@ -278,6 +278,9 @@ - (void)testIndex {
     [index deleteByQuery:[Query new] completionHandler:^(NSDictionary<NSString*,id>* content, NSError* error) {
         // Do nothing.
     }];
+    [index deleteBy:[Query new] completionHandler:^(NSDictionary<NSString*,id>* content, NSError* error) {
+        // Do nothing.
+    }];
     [index searchDisjunctiveFaceting:[Query new] disjunctiveFacets:@[ @"disjunctive", @"facets" ] refinements:@{ @"facets": @[ @"refinements" ] } completionHandler:^(NSDictionary<NSString*,id>* content, NSError* error) {
         // Do nothing.
     }];