Merge pull request #666 from algolia/develop

Release 8.1.1

Author: VladislavFitz

Sources/AlgoliaSearchClient/Command/Command+Personalization.swift

@@ -31,6 +31,8 @@ extension Command {
       let requestOptions: RequestOptions?
 
       init(strategy: PersonalizationStrategy, requestOptions: RequestOptions?) {
+        var requestOptions = requestOptions.unwrapOrCreate()
+        requestOptions.setHeader("application/json", forKey: .contentType)
         self.requestOptions = requestOptions
         self.urlRequest = .init(method: .post, path: .strategies >>> PersonalizationRoute.personalization, body: strategy.httpBody, requestOptions: self.requestOptions)
       }

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/Models/Internal/HTTP/HTTPStatusCode.swift

@@ -13,6 +13,7 @@ extension HTTPStatusСode {
 
   static let notFound: HTTPStatusСode = 404
   static let requestTimeout: HTTPStatusСode = 408
+  static let tooManyRequests: HTTPStatusСode = 429
 
   func belongs(to categories: HTTPStatusCategory...) -> Bool {
     return categories.map { $0.contains(self) }.contains(true)

Sources/AlgoliaSearchClient/Models/Places/PlacesQuery.swift

@@ -16,28 +16,33 @@ public struct PlacesQuery {
   public var type: PlaceType?
 
   /// If specified, restrict the search results to a specific list of countries.
-  /// Engine default: Search on the whole planet.
+  /// - Engine default: Search on the whole planet.
   public var countries: [Country]?
 
   /// Force to first search around a specific latitude longitude.
   public var aroundLatLng: Point?
 
   /// Whether or not to first search around the geolocation of the user found via his IP address.
-  /// Engine default: true
+  /// - Engine default: true
   public var aroundLatLngViaIP: Bool?
 
   /// Radius in meters to search around the latitude/longitude.
   /// Otherwise a default radius is automatically computed given the area density.
   public var aroundRadius: AroundRadius?
 
   /// Controls whether the _rankingInfo object should be included in the hits.
-  /// Engine default: false
+  /// - Engine default: false
   public var getRankingInfo: Bool?
 
   /// Specifies how many results you want to retrieve per search.
-  /// Engine default: 20
+  /// - Engine default: 20
   public var hitsPerPage: Int?
 
+  /// Specifies the language of the results.
+  ///
+  /// When set to nil, engine returns the results in all available languages
+  /// - Remark: Cannot be set explicitly. To set the language of places query, set the `language` parameter of `PlaceClients.search` method.
+  /// - Engine default: nil
   internal var language: Language?
 
   public init(_ query: String? = nil) {

Sources/AlgoliaSearchClient/Transport/HTTP/HTTPRequest.swift

@@ -14,12 +14,13 @@ class HTTPRequest<ResponseType: Decodable, Output>: AsyncOperation, ResultContai
   typealias Result = Swift.Result<Output, Swift.Error>
 
   let requester: HTTPRequester
-  let hostIterator: HostIterator
   let retryStrategy: RetryStrategy
   let timeout: TimeInterval
   let request: URLRequest
+  let callType: CallType
   let transform: (ResponseType) -> Output
   let completion: (Result) -> Void
+  let hostIterator: HostIterator
   var didUpdateProgress: ((ProgressReporting) -> Void)?
 
   var underlyingTask: (TransportTask)? {
@@ -42,19 +43,20 @@ class HTTPRequest<ResponseType: Decodable, Output>: AsyncOperation, ResultContai
 
   init(requester: HTTPRequester,
        retryStrategy: RetryStrategy,
-       hostIterator: HostIterator,
        request: URLRequest,
+       callType: CallType,
        timeout: TimeInterval,
        transform: @escaping Transform,
        completion: @escaping (Result) -> Void) {
     self.requester = requester
     self.retryStrategy = retryStrategy
-    self.hostIterator = hostIterator
     self.request = request
+    self.callType = callType
     self.timeout = timeout
     self.transform = transform
     self.completion = completion
     self.underlyingTask = nil
+    self.hostIterator = retryStrategy.retryableHosts(for: callType)
   }
 
   override func main() {
@@ -151,12 +153,13 @@ extension HTTPRequest where ResponseType == Output {
                    retryStrategy: RetryStrategy,
                    hostIterator: HostIterator,
                    request: URLRequest,
+                   callType: CallType,
                    timeout: TimeInterval,
                    completion: @escaping (Result) -> Void) {
     self.init(requester: requester,
               retryStrategy: retryStrategy,
-              hostIterator: hostIterator,
               request: request,
+              callType: callType,
               timeout: timeout,
               transform: { $0 },
               completion: completion)

Sources/AlgoliaSearchClient/Transport/HTTP/HTTPRequestBuilder.swift

@@ -27,15 +27,22 @@ class HTTPRequestBuilder {
   func build<Response: Decodable, Output>(for command: AlgoliaCommand, transform: @escaping (Response) -> Output, with completion: @escaping (HTTPRequest<Response, Output>.Result) -> Void) -> HTTPRequest<Response, Output> {
 
     let timeout = command.requestOptions?.timeout(for: command.callType) ?? configuration.timeout(for: command.callType)
-    let hostIterator = HostIterator(retryStrategy: retryStrategy, callType: command.callType)
     var request = command.urlRequest.setIfNotNil(\.credentials, to: credentials)
     let userAgentsValue = UserAgentController.userAgents.map(\.description).joined(separator: "; ")
     request.addValue(userAgentsValue, forHTTPHeaderField: HTTPHeaderKey.userAgent.rawValue)
-    return HTTPRequest(requester: requester, retryStrategy: retryStrategy, hostIterator: hostIterator, request: request, timeout: timeout, transform: transform, completion: completion)
+    return HTTPRequest(requester: requester,
+                       retryStrategy: retryStrategy,
+                       request: request,
+                       callType: command.callType,
+                       timeout: timeout,
+                       transform: transform,
+                       completion: completion)
   }
 
   func build<Response: Decodable, Output>(for command: AlgoliaCommand, transform: @escaping (Response) -> Output, responseType: Output.Type) -> HTTPRequest<Response, Output> {
-    return build(for: command, transform: transform, with: { (_:HTTPRequest<Response, Output>.Result) in })
+    return build(for: command,
+                 transform: transform,
+                 with: { (_:HTTPRequest<Response, Output>.Result) in })
   }
 
 }

Sources/AlgoliaSearchClient/Transport/HTTP/HTTPTransport+Error.swift

@@ -9,9 +9,21 @@ import Foundation
 
 extension HTTPTransport {
 
-  enum Error: Swift.Error {
+  enum Error: Swift.Error, LocalizedError {
     case noReachableHosts
     case missingData
+    case decodingFailure(Swift.Error)
+    
+    var localizedDescription: String {
+      switch self {
+      case .noReachableHosts:
+        return "All hosts are unreachable"
+      case .missingData:
+        return "Missing response data"
+      case .decodingFailure:
+        return "Response decoding failed"
+      }
+    }
   }
 
 }

Sources/AlgoliaSearchClient/Transport/HTTP/HTTPTransport+Result.swift

@@ -32,7 +32,7 @@ extension Result where Success: Decodable, Failure == Error {
       let object = try jsonDecoder.decode(Success.self, from: data)
       self = .success(object)
     } catch let error {
-      self = .failure(error)
+      self = .failure(HTTPTransport.Error.decodingFailure(error))
     }
 
   }

Sources/AlgoliaSearchClient/Transport/RetryStrategy/AlgoliaRetryStrategy.swift

@@ -25,23 +25,21 @@ class AlgoliaRetryStrategy: RetryStrategy {
   convenience init(configuration: Configuration) {
     self.init(hosts: configuration.hosts)
   }
-
-  func host(for callType: CallType) -> RetryableHost? {
+  
+  func retryableHosts(for callType: CallType) -> HostIterator {
     return queue.sync {
+      // Reset expired hosts
       hosts.resetExpired(expirationDelay: hostsExpirationDelay)
-
-      func firstUpHostForCallType() -> RetryableHost? {
-        return hosts.first { $0.supports(callType) && $0.isUp }
-      }
-
-      guard let host = firstUpHostForCallType() else {
+      
+      // If all hosts of the required type are down, reset them all
+      if !hosts.contains(where: { $0.supports(callType) && $0.isUp }) {
         hosts.resetAll(for: callType)
-        return firstUpHostForCallType()
       }
-
-      return host
+      
+      return HostIterator { [weak self] in
+        self?.hosts.first { $0.supports(callType) && $0.isUp }
+      }
     }
-
   }
 
   func notify<T>(host: RetryableHost, result: Result<T, Swift.Error>) -> RetryOutcome<T> {

Sources/AlgoliaSearchClient/Transport/RetryStrategy/HostIterator.swift

@@ -9,16 +9,14 @@ import Foundation
 
 class HostIterator: IteratorProtocol {
 
-  var retryStrategy: RetryStrategy
-  let callType: CallType
-
-  init(retryStrategy: RetryStrategy, callType: CallType) {
-    self.retryStrategy = retryStrategy
-    self.callType = callType
+  var getHost: () -> RetryableHost?
+  
+  init(getHost: @escaping () -> RetryableHost?) {
+    self.getHost = getHost
   }
 
   func next() -> RetryableHost? {
-    return retryStrategy.host(for: callType)
+    return getHost()
   }
 
 }