Merge pull request #663 from algolia/fix/url-parameters-percent-encoding

Add explicit percent encoding for plus sign for the browsing cursor

Author: VladislavFitz

Sources/AlgoliaSearchClient/Command/Command+Search.swift

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

Sources/AlgoliaSearchClient/Transport/URLSession/URLRequest+Convenience.swift

@@ -9,6 +9,12 @@ import Foundation
 
 extension URLRequest: Builder {}
 
+extension CharacterSet {
+  
+  static var uriAllowed = CharacterSet.urlQueryAllowed.subtracting(.init(charactersIn: "+"))
+  
+}
+
 extension URLRequest {
 
   subscript(header key: HTTPHeaderKey) -> String? {
@@ -28,41 +34,35 @@ extension URLRequest {
     var urlComponents = URLComponents()
     urlComponents.scheme = "https"
     urlComponents.path = path.fullPath
+  
+    if let urlParameters = requestOptions?.urlParameters {
+      urlComponents.queryItems = urlParameters.map { (key, value) in .init(name: key.rawValue, value: value) }
+    }
 
     var request = URLRequest(url: urlComponents.url!)
 
     request.httpMethod = method.rawValue
     request.httpBody = body
-
+    
     if let requestOptions = requestOptions {
-      request.setRequestOptions(requestOptions)
+      
+      requestOptions.headers.forEach { header in
+        let (value, field) = (header.value, header.key.rawValue)
+        request.setValue(value, forHTTPHeaderField: field)
+      }
+      
+      // If body is set in query parameters, it will override the body passed as parameter to this function
+      if let body = requestOptions.body, !body.isEmpty {
+        let jsonEncodedBody = try? JSONSerialization.data(withJSONObject: body, options: [])
+        request.httpBody = jsonEncodedBody
+      }
+      
     }
-
+        
+    request.httpBody = body
     self = request
   }
 
-  mutating func setRequestOptions(_ requestOptions: RequestOptions) {
-
-    // Append headers
-    requestOptions.headers.forEach { setValue($0.value, forHTTPHeaderField: $0.key.rawValue) }
-
-    // Append query items
-    if let url = url, var currentComponents = URLComponents(string: url.absoluteString) {
-      let requestOptionsItems = requestOptions.urlParameters.map { URLQueryItem(name: $0.key.rawValue, value: $0.value) }
-      var existingItems = currentComponents.queryItems ?? []
-      existingItems.append(contentsOf: requestOptionsItems)
-      currentComponents.queryItems = existingItems
-      self.url = currentComponents.url
-    }
-
-    // Set body
-    if
-      let body = requestOptions.body,
-      let jsonData = try? JSONSerialization.data(withJSONObject: body, options: []) {
-      httpBody = jsonData
-    }
-  }
-
 }
 
 extension URLRequest {

Tests/AlgoliaSearchClientTests/Unit/Command/SearchCommandTests.swift

@@ -39,7 +39,7 @@ class SearchCommandTests: XCTestCase, AlgoliaCommandTest {
           callType: .read,
           method: .get,
           urlPath: "/1/indexes/testIndex/browse",
-          queryItems: [.init(name: "testParameter", value: "testParameterValue"), .init(name: "cursor", value: "testCursor")],
+          queryItems: [.init(name: "testParameter", value: "testParameterValue"), .init(name: "cursor", value: "AgA%2BBgg4MTUyNTQ0Mg==")],
           body: nil,
           requestOptions: test.requestOptions)
   }

Tests/AlgoliaSearchClientTests/Unit/TestValues.swift

@@ -28,7 +28,7 @@ struct TestValues {
   }()
   let taskID: TaskID = "testTaskID"
   let requestOptions = RequestOptions(headers: ["testHeader": "testHeaderValue"], urlParameters: ["testParameter": "testParameterValue"])
-  let cursor: Cursor = "testCursor"
+  let cursor: Cursor = "AgA+Bgg4MTUyNTQ0Mg=="
   let userID: UserID = "testUserID"
   let clusterName: ClusterName = "testClusterName"