Merge pull request #341 from algolia/fix/multi-query-headers

fix: add `requestOptions` to `MultiSearcher` init

Author: shaejaz

Sources/InstantSearchCore/Searcher/Multi/MultiSearcher.swift

@@ -14,11 +14,21 @@ public class MultiSearcher: AbstractMultiSearcher<AlgoliaMultiSearchService> {
     - Parameters:
        - client: Algolia search client
    */
+  @available(*, deprecated, message: "Use init(client:requestOptions:) instead")
   public convenience init(client: SearchClient) {
+      self.init(client: client, requestOptions: nil)
+  }
+
+  /**
+    - Parameters:
+       - client: Algolia search client
+       - requestOptions: Custom request options. Default is `nil`.
+   */
+  public convenience init(client: SearchClient, requestOptions: RequestOptions? = nil) {
     let service = AlgoliaMultiSearchService(client: client)
     let initialRequest = Request(queries: [],
                                  strategy: .none,
-                                 requestOptions: .none)
+                                 requestOptions: requestOptions)
     self.init(service: service,
               initialRequest: initialRequest)
     Telemetry.shared.trace(type: .multiSearcher)
@@ -29,17 +39,30 @@ public class MultiSearcher: AbstractMultiSearcher<AlgoliaMultiSearchService> {
        - appID: Application ID
        - apiKey: API Key
    */
+  @available(*, deprecated, message: "Use init(appID:apiKey:requestOptions:) instead")
   public convenience init(appID: ApplicationID,
                           apiKey: APIKey) {
+    self.init(appID: appID, apiKey: apiKey, requestOptions: nil)
+  }
+
+  /**
+    - Parameters:
+       - appID: Application ID
+       - apiKey: API Key
+       - requestOptions: Custom request options. Default is `nil`.
+   */
+  public convenience init(appID: ApplicationID,
+                          apiKey: APIKey,
+                          requestOptions: RequestOptions? = nil) {
     let client = SearchClient(appID: appID, apiKey: apiKey)
-    self.init(client: client)
+    self.init(client: client, requestOptions: requestOptions)
   }
 
   /**
     - Parameters:
         - indexName: Name of the index in which search will be performed
         - query: Instance of Query. By default a new empty instant of Query will be created.
-        - requestOptions: Custom request options. Default is `nil`.
+        - requestOptions: requestOptions: Deprecated: This option does not have an effect, use `requestOptions` in `init` instead.
    */
   @discardableResult public func addHitsSearcher(indexName: IndexName,
                                                  query: Query = .init(),
@@ -57,7 +80,7 @@ public class MultiSearcher: AbstractMultiSearcher<AlgoliaMultiSearchService> {
        - query: Instance of Query. By default a new empty instant of Query will be created.
        - attribute: Name of facet attribute for which the values will be searched
        - facetQuery: Initial facet search query
-       - requestOptions: Custom request options. Default is `nil`.
+       - requestOptions: requestOptions: Deprecated: This option does not have an effect, use `requestOptions` in `init` instead.
    */
   @discardableResult public func addFacetsSearcher(indexName: IndexName,
                                                    query: Query = .init(),

Tests/InstantSearchCoreTests/Unit/Searcher/MultiSearcherTests.swift

@@ -45,6 +45,19 @@ class MultiSearcherTests: XCTestCase {
 
     completion(.success(["res1", "res2", "res3", "res4"]))
   }
+
+  func testRequestOptions() {
+    let searcher = MultiSearcher(appID: "", apiKey: "", requestOptions: .init(headers: ["test": "test"]))
+    searcher.addHitsSearcher(indexName: "")
+
+    let exp = expectation(description: "Search expectation")
+    searcher.onRequestChanged.subscribe(with: self) { _, request in
+      XCTAssertEqual(request.requestOptions?.headers, ["test": "test"])
+      exp.fulfill()
+    }
+    searcher.search()
+    waitForExpectations(timeout: 2, handler: .none)
+  }
 }
 
 struct TestMultiRequest: MultiRequest {