fix: provide user agents as url parmeter (#808)

Author: VladislavFitz

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

@@ -54,9 +54,14 @@ extension URLRequest {
     var urlComponents = URLComponents()
     urlComponents.scheme = "https"
     urlComponents.percentEncodedPath = command.path.path
+    urlComponents.queryItems = [
+      URLQueryItem(name: "X-Algolia-Agent", value: UserAgentController.httpHeaderValue)
+    ]
 
     if let urlParameters = command.requestOptions?.urlParameters {
-      urlComponents.queryItems = urlParameters.map { (key, value) in .init(name: key.rawValue, value: value) }
+      let existingQueryItems = urlComponents.queryItems ?? []
+      let extraQueryItems = urlParameters.mapKeys(\.rawValue).map(URLQueryItem.init)
+      urlComponents.queryItems = existingQueryItems + extraQueryItems
     }
 
     var request = URLRequest(url: urlComponents.url!)

Tests/AlgoliaSearchClientTests/Unit/Command/AlgoliaCommandTest.swift

@@ -46,7 +46,7 @@ extension AlgoliaCommandTest {
     try XCTAssertEqual(request.httpBody.flatMap(dataToJSON), body.flatMap(dataToJSON), file: file, line: line)
     #else
     XCTAssertEqual(request.allHTTPHeaderFields, requestOptions.headers.merging(additionalHeaders ?? [:]).mapKeys { $0.rawValue }, file: file, line: line)
-    XCTAssertEqual(Set(requestQueryItems), queryItems, file: file, line: line)
+    XCTAssertTrue(Set(requestQueryItems).isSuperset(of: queryItems), file: file, line: line)
     XCTAssertEqual(request.httpBody, body, "Compare with assertEqual", file: file, line: line)
     #endif
   }

Tests/AlgoliaSearchClientTests/Unit/PathTests.swift

@@ -18,7 +18,7 @@ class PathTests: XCTestCase {
   func testIndexNameEncoding() {
     let path = URL(string: "/1/indexes/")!.appendingPathComponent("Index name with spaces".addingPercentEncoding(withAllowedCharacters: .urlPathComponentAllowed)!)
     let request = URLRequest(command: Command.Custom(method: .post, callType: .write, path: path, body: nil, requestOptions: nil))
-    XCTAssertEqual(request.url?.absoluteString, "https:/1/indexes/Index%20name%20with%20spaces")
+    XCTAssertEqual(request.url?.absoluteString.starts(with: "https:/1/indexes/Index%20name%20with%20spaces"), true)
   }
 
 }

Tests/AlgoliaSearchClientTests/Unit/RecommendClientTests.swift

@@ -18,7 +18,7 @@ class RecommendClientTests: XCTestCase {
     let exp = expectation(description: "request")
 
     requester.onRequest = { request in
-      XCTAssertEqual(request.url?.absoluteString, "https://test-app-id-dsn.algolia.net/1/indexes/*/recommendations?")
+      XCTAssertEqual(request.url?.absoluteString.starts(with: "https://test-app-id-dsn.algolia.net/1/indexes/*/recommendations?"), true)
       XCTAssertEqual(request.value(forHTTPHeaderField: "Content-Type"), "application/json")
       XCTAssertEqual(request.value(forHTTPHeaderField: "X-Algolia-Application-Id"), "test-app-id")
       XCTAssertEqual(request.value(forHTTPHeaderField: "X-Algolia-API-Key"), "test-api-key")
@@ -53,7 +53,7 @@ class RecommendClientTests: XCTestCase {
     let exp = expectation(description: "request")
 
     requester.onRequest = { request in
-      XCTAssertEqual(request.url?.absoluteString, "https://test-app-id-dsn.algolia.net/1/indexes/*/recommendations?")
+      XCTAssertEqual(request.url?.absoluteString.starts(with: "https://test-app-id-dsn.algolia.net/1/indexes/*/recommendations?"), true)
       XCTAssertEqual(request.value(forHTTPHeaderField: "Content-Type"), "application/json")
       XCTAssertEqual(request.value(forHTTPHeaderField: "X-Algolia-Application-Id"), "test-app-id")
       XCTAssertEqual(request.value(forHTTPHeaderField: "X-Algolia-API-Key"), "test-api-key")
@@ -86,7 +86,7 @@ class RecommendClientTests: XCTestCase {
     let exp = expectation(description: "request")
 
     requester.onRequest = { request in
-      XCTAssertEqual(request.url?.absoluteString, "https://test-app-id-dsn.algolia.net/1/indexes/*/recommendations?")
+      XCTAssertEqual(request.url?.absoluteString.starts(with: "https://test-app-id-dsn.algolia.net/1/indexes/*/recommendations?"), true)
       XCTAssertEqual(request.value(forHTTPHeaderField: "Content-Type"), "application/json")
       XCTAssertEqual(request.value(forHTTPHeaderField: "X-Algolia-Application-Id"), "test-app-id")
       XCTAssertEqual(request.value(forHTTPHeaderField: "X-Algolia-API-Key"), "test-api-key")

Tests/AlgoliaSearchClientTests/Unit/Transport/URLRequestConstructionTests.swift

@@ -33,7 +33,7 @@ class URLRequestConstructionTests: XCTestCase {
     XCTAssertEqual(request.allHTTPHeaderFields, expectedHeaders)
     #endif
     XCTAssertEqual(request.httpMethod, method.rawValue)
-    XCTAssertEqual(request.url?.absoluteString, "https:/my/test/path")
+    XCTAssertEqual(request.url?.absoluteString.starts(with: "https:/my/test/path"), true)
     XCTAssertEqual(request.httpBody, body)
 
   }
@@ -73,7 +73,7 @@ class URLRequestConstructionTests: XCTestCase {
       host.retryCount = index
       let requestWithHost = try request.switchingHost(by: host, withBaseTimeout: timeout)
       XCTAssertEqual(requestWithHost.timeoutInterval, timeout * TimeInterval(index + 1))
-      XCTAssertEqual(requestWithHost.url?.absoluteString, "https://test\(index).algolia.com/my/test/path")
+      XCTAssertEqual(requestWithHost.url?.absoluteString.starts(with: "https://test\(index).algolia.com/my/test/path"), true)
     }
 
   }
@@ -83,7 +83,7 @@ class URLRequestConstructionTests: XCTestCase {
                                              objectID: "gid://shopify/Collection/1122334455",
                                              attributesToRetrieve: [],
                                              requestOptions: nil)
-    XCTAssertEqual(URLRequest(command: command).url?.absoluteString, "https:/1/indexes/myIndex/gid:%2F%2Fshopify%2FCollection%2F1122334455")
+    XCTAssertEqual(URLRequest(command: command).url?.absoluteString.starts(with: "https:/1/indexes/myIndex/gid:%2F%2Fshopify%2FCollection%2F1122334455"), true)
   }
 
   func testFiltersEncoding() {