fix(Browse): change browse with cursor method GET -> POST (#671)

* fix(browse) Use POST method for browse with cursor call instead of GET to avoid issues with cursor URL encoding
* Set browse method by default with the empty query, not the empty cursor

Author: VladislavFitz

AlgoliaSearchClient.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |spec|
   spec.name         = "AlgoliaSearchClient"
   spec.module_name  = 'AlgoliaSearchClient'
-  spec.version      = "8.1.1"
+  spec.version      = "8.1.2-beta.1"
   spec.summary      = "Algolia Search API Client written in Swift."
   spec.homepage     = "https://github.com/algolia/algoliasearch-client-swift"
   spec.license      = { :type => "MIT", :file => "LICENSE" }

Sources/AlgoliaSearchClient/Command/Command+Search.swift

@@ -39,10 +39,11 @@ extension Command {
         urlRequest = .init(method: .post, path: path, body: query.httpBody, requestOptions: requestOptions)
       }
 
-      init(indexName: IndexName, cursor: Cursor? = nil, requestOptions: RequestOptions?) {
-        self.requestOptions = requestOptions.updateOrCreate(cursor.flatMap { [.cursor: $0.rawValue.addingPercentEncoding(withAllowedCharacters: .uriAllowed)] } ?? [:])
+      init(indexName: IndexName, cursor: Cursor, requestOptions: RequestOptions?) {
+        self.requestOptions = requestOptions
+        let body = CursorWrapper(cursor)
         let path = .indexesV1 >>> .index(indexName) >>> IndexCompletion.browse
-        urlRequest = .init(method: .get, path: path, requestOptions: self.requestOptions)
+        urlRequest = .init(method: .post, path: path, body: body.httpBody, requestOptions: self.requestOptions)
       }
 
     }

Sources/AlgoliaSearchClient/Helpers/Version+Current.swift

@@ -1,2 +1,2 @@
 // This is generated file. Don't modify it manually.
-public extension Version { static let current: Version = .init(major: 8, minor: 1, patch: 1, prereleaseIdentifier: nil) }
+public extension Version { static let current: Version = .init(major: 8, minor: 1, patch: 2, prereleaseIdentifier: "beta.1") }

Sources/AlgoliaSearchClient/Index/Index+Search.swift

@@ -107,7 +107,7 @@ public extension Index {
    - Parameter completion: Result completion
    - Returns: SearchResponse object
    */
-  @discardableResult func browse(query: Query,
+  @discardableResult func browse(query: Query = .init(),
                                  requestOptions: RequestOptions? = nil,
                                  completion: @escaping ResultCallback<SearchResponse>) -> Operation & TransportTask {
     let command = Command.Search.Browse(indexName: name, query: query, requestOptions: requestOptions)
@@ -122,7 +122,7 @@ public extension Index {
    - Parameter completion: Result completion
    - Returns: Launched asynchronous operation
    */
-  @discardableResult func browse(query: Query,
+  @discardableResult func browse(query: Query = .init(),
                                  requestOptions: RequestOptions? = nil) throws -> SearchResponse {
     let command = Command.Search.Browse(indexName: name, query: query, requestOptions: requestOptions)
     return try execute(command)
@@ -137,7 +137,7 @@ public extension Index {
    - Parameter completion: Result completion
    - Returns: Launched asynchronous operation
    */
-  @discardableResult func browse(cursor: Cursor? = nil,
+  @discardableResult func browse(cursor: Cursor,
                                  requestOptions: RequestOptions? = nil,
                                  completion: @escaping ResultCallback<SearchResponse>) -> Operation & TransportTask {
     let command = Command.Search.Browse(indexName: name, cursor: cursor, requestOptions: requestOptions)
@@ -152,7 +152,7 @@ public extension Index {
    - Parameter requestOptions: Configure request locally with RequestOptions.
    - Returns: SearchResponse object
    */
-  @discardableResult func browse(cursor: Cursor? = nil,
+  @discardableResult func browse(cursor: Cursor,
                                  requestOptions: RequestOptions? = nil) throws -> SearchResponse {
     let command = Command.Search.Browse(indexName: name, cursor: cursor, requestOptions: requestOptions)
     return try execute(command)

Sources/AlgoliaSearchClient/Models/Data structures/FieldWrapper.swift

@@ -37,10 +37,12 @@ struct EditsKey: Key { static let value = "edits" }
 struct ObjectIDKey: Key { static let value = "objectID" }
 struct RemoveKey: Key { static let value = "remove" }
 struct ClusterKey: Key { static let value = "cluster" }
+struct CursorKey: Key { static let value = "cursor" }
 
 typealias ParamsWrapper<Wrapped: Codable> = FieldWrapper<ParamsKey, Wrapped>
 typealias RequestsWrapper<Wrapped: Codable> = FieldWrapper<RequestsKey, Wrapped>
 typealias EventsWrapper<Wrapped: Codable> = FieldWrapper<EventsKey, Wrapped>
 typealias EditsWrapper = FieldWrapper<EditsKey, [Rule.Edit]>
 typealias ObjectIDWrapper = FieldWrapper<ObjectIDKey, ObjectID>
 typealias ClusterWrapper<Wrapped: Codable> = FieldWrapper<ClusterKey, Wrapped>
+typealias CursorWrapper = FieldWrapper<CursorKey, Cursor>

Tests/AlgoliaSearchClientTests/Integration/BrowseIntegrationTests.swift

@@ -35,11 +35,12 @@ class BrowseIntegrationTests: OnlineTestCase {
       let objectID: String
       let name: String
     }
-    
-    let records: [Record] = (0...50).map { _ in
-      .init(objectID: .random(length: 5), name: String.random(length: .random(in: 1...20)))
+        
+    let records: [Record] = (0...10000).map { _ in
+        .init(objectID: .random(length: 5), name: String.random(length: .random(in: 1...20)))
     }
 
+    try index.setSettings(Settings().set(\.attributesForFaceting, to: ["metric", "color"]))
     try index.saveObjects(records).wait()
 
     let responses = try index.browseObjects()

Tests/AlgoliaSearchClientTests/Unit/Command/SearchCommandTests.swift

@@ -37,10 +37,10 @@ class SearchCommandTests: XCTestCase, AlgoliaCommandTest {
     let command = Command.Search.Browse(indexName: test.indexName, cursor: test.cursor, requestOptions: test.requestOptions)
     check(command: command,
           callType: .read,
-          method: .get,
+          method: .post,
           urlPath: "/1/indexes/testIndex/browse",
-          queryItems: [.init(name: "testParameter", value: "testParameterValue"), .init(name: "cursor", value: "AgA%2BBgg4MTUyNTQ0Mg==")],
-          body: nil,
+          queryItems: [.init(name: "testParameter", value: "testParameterValue")],
+          body: CursorWrapper(test.cursor).httpBody,
           requestOptions: test.requestOptions)
   }