feat(Insights): add user-agent extension (#274)

algolia · Feb 12, 2023 · 42b5d08 · 42b5d08
1 parent 27ab59c
commit 42b5d08
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 10 deletions.
diff --git a/Cartfile b/Cartfile
@@ -1,3 +1,3 @@
 github "apple/swift-log" ~> 1.4
-github "algolia/algoliasearch-client-swift" ~> 8.15
+github "algolia/algoliasearch-client-swift" ~> 8.17
 github "algolia/instantsearch-telemetry-native" ~> 0.1.3
diff --git a/InstantSearch.podspec b/InstantSearch.podspec
@@ -15,7 +15,7 @@ Pod::Spec.new do |s|
 
   s.subspec "Insights" do |ss|
       ss.source_files = 'Sources/InstantSearchInsights/**/*.{swift}'
-      ss.dependency 'AlgoliaSearchClient', '~> 8.15'
+      ss.dependency 'AlgoliaSearchClient', '~> 8.17'
       ss.ios.deployment_target = '9.0'
       ss.osx.deployment_target = '10.10'
       ss.watchos.deployment_target = '2.0'
@@ -24,7 +24,7 @@ Pod::Spec.new do |s|
 
   s.subspec "Core" do |ss|
       ss.source_files = 'Sources/InstantSearchCore/**/*.{swift}'
-      ss.dependency 'AlgoliaSearchClient', '~> 8.15'
+      ss.dependency 'AlgoliaSearchClient', '~> 8.17'
       ss.dependency 'InstantSearch/Insights'
       ss.dependency 'InstantSearchTelemetry', '~> 0.1.3'
       ss.ios.deployment_target = '9.0'

diff --git a/Package.swift b/Package.swift
@@ -32,7 +32,7 @@ let package = Package(
   dependencies: [
     .package(name: "AlgoliaSearchClient",
              url: "https://github.com/algolia/algoliasearch-client-swift",
-             from: "8.15.0"),
+             from: "8.17.0"),
     .package(name: "InstantSearchTelemetry",
              url: "https://github.com/algolia/instantsearch-telemetry-native",
              from: "0.1.3")

diff --git a/...ntSearchCore/Helper/UserAgentSetter.swift → ...archCore/Helper/CoreUserAgentSetter.swift b/...ntSearchCore/Helper/UserAgentSetter.swift → ...archCore/Helper/CoreUserAgentSetter.swift
@@ -1,13 +1,13 @@
 //
-//  UserAgentSetter.swift
+//  CoreUserAgentSetter.swift
 //
 //
 //  Created by Vladislav Fitc on 16/06/2020.
 //
 
 import Foundation
 
-struct UserAgentSetter {
+struct CoreUserAgentSetter {
   /// Add the library's version to the client's user agents, if not already present.
   static let set = Self()
 

diff --git a/Sources/InstantSearchCore/Searcher/Searcher.swift b/Sources/InstantSearchCore/Searcher/Searcher.swift
@@ -60,7 +60,7 @@ public protocol ErrorObservable {
 extension Searcher {
   /// Add the library's version to the client's user agents, if not already present.
   func updateClientUserAgents() {
-    _ = UserAgentSetter.set
+    _ = CoreUserAgentSetter.set
   }
 }
 

diff --git a/Sources/InstantSearchInsights/Helpers/InsightsUserAgentSetter.swift b/Sources/InstantSearchInsights/Helpers/InsightsUserAgentSetter.swift
@@ -0,0 +1,18 @@
+//
+//  InsightsUserAgentSetter.swift
+//
+//
+//  Created by Vladislav Fitc on 03/02/2023.
+//
+
+import AlgoliaSearchClient
+import Foundation
+
+struct InsightsUserAgentSetter {
+  /// Add the library's version to the client's user agents, if not already present.
+  static let set = Self()
+
+  init() {
+    UserAgentController.append(UserAgent(title: "Algolia insights for iOS", version: Version.current.description))
+  }
+}
diff --git a/Sources/InstantSearchInsights/Logic/Insights.swift b/Sources/InstantSearchInsights/Logic/Insights.swift
@@ -161,6 +161,7 @@ public class Insights {
                                                  userToken: UserToken? = .none,
                                                  generateTimestamps: Bool = true,
                                                  region: Region? = region) -> Insights {
+    _ = InsightsUserAgentSetter.set
     let logger = Logger(label: "Insights (\(appId.rawValue))")
     logger.info("application registered")
     let insights = Insights(applicationID: appId,

diff --git a/Sources/InstantSearchSwiftUI/DataModel/HitsObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/HitsObservableController.swift
@@ -30,9 +30,9 @@ import InstantSearchTelemetry
 
     public func reload() {
       if let hitsSource = hitsSource, hitsSource.numberOfHits() > 0 {
-          self.hits = hitsSource.hits
+        hits = hitsSource.hits
       } else {
-          self.hits = []
+        hits = []
       }
     }
 

diff --git a/Tests/InstantSearchCoreTests/Integration/OnlineTestCase.swift b/Tests/InstantSearchCoreTests/Integration/OnlineTestCase.swift
@@ -33,7 +33,7 @@ class OnlineTestCase: XCTestCase {
       throw Error.missingCredentials
     }
 
-    _ = UserAgentSetter.set
+    _ = CoreUserAgentSetter.set
 
     client = SearchClient(appID: credentials.applicationID, apiKey: credentials.apiKey)
 

diff --git a/Tests/InstantSearchInsightsTests/Unit/UserAgentTest.swift b/Tests/InstantSearchInsightsTests/Unit/UserAgentTest.swift
@@ -0,0 +1,19 @@
+//
+//  UserAgentTest.swift
+//
+//
+//  Created by Vladislav Fitc on 03/02/2023.
+//
+
+import AlgoliaSearchClient
+@testable import InstantSearchInsights
+import XCTest
+
+class UserAgentTest: XCTestCase {
+  func testUserAgentUniqueness() {
+    Insights.register(appId: "a", apiKey: "a")
+    Insights.register(appId: "b", apiKey: "b")
+    Insights.register(appId: "c", apiKey: "c")
+    XCTAssertEqual(UserAgentController.extensions.filter { $0.userAgentExtension.contains("Algolia insights for iOS") }.count, 1)
+  }
+}