feat: support add global attributes when using Objc api (#64)

zhu-xiaowei · xiaoweii · web-flow · commit daa98c80433e · 2024-04-15T10:10:04.000+08:00
Co-authored-by: xiaoweii &lt;xiaoweii@amazom.com&gt;
diff --git a/README.md b/README.md
@@ -226,7 +226,7 @@ ClickstreamAnalytics.recordEvent(ClickstreamAnalytics.EventName.SCREEN_VIEW, [
 import Clickstream
 
 let globalAttribute: ClickstreamAttribute = [
-    "channel": "apple",
+    ClickstreamAnalytics.Attr.APP_INSTALL_CHANNEL: "apple",
     "class": 6,
     "level": 5.1,
     "isOpenNotification": true,
diff --git a/Sources/Clickstream/ClickstreamObjc.swift b/Sources/Clickstream/ClickstreamObjc.swift
@@ -103,7 +103,7 @@ import Foundation
         ClickstreamAnalytics.enable()
     }
 
-    private static func getAttributes(_ attributes: NSDictionary) -> ClickstreamAttribute {
+    static func getAttributes(_ attributes: NSDictionary) -> ClickstreamAttribute {
         var result: ClickstreamAttribute = [:]
         for case let (key as String, value) in attributes {
             if value is String {
diff --git a/Sources/Clickstream/Dependency/Clickstream/ClickstreamContext.swift b/Sources/Clickstream/Dependency/Clickstream/ClickstreamContext.swift
@@ -124,6 +124,11 @@ extension UserDefaults: UserDefaultsBehaviour {
         self.globalAttributes = globalAttributes
         return self
     }
+    
+    public func withInitialGlobalAttributesObjc(_ globalAttributes: NSDictionary) -> ClickstreamConfiguration {
+        self.globalAttributes = ClickstreamObjc.getAttributes(globalAttributes)
+        return self
+    }
 }
 
 struct ClickstreamContextStorage {
diff --git a/Tests/ClickstreamTests/Clickstream/AnalyticsClientTest.swift b/Tests/ClickstreamTests/Clickstream/AnalyticsClientTest.swift
@@ -19,7 +19,7 @@ class AnalyticsClientTest: XCTestCase {
     override func setUp() async throws {
         UserDefaults.standard.removePersistentDomain(forName: Bundle.main.bundleIdentifier!)
         let contextConfiguration = ClickstreamConfiguration.getDefaultConfiguration()
-            .withAppId(testAppId)
+            .withAppId(testAppId + UUID().uuidString)
             .withEndpoint(testEndpoint)
             .withSendEventInterval(10_000)
             .withTrackAppExceptionEvents(false)
diff --git a/Tests/ClickstreamTests/Clickstream/AutoRecordEventClientTest.swift b/Tests/ClickstreamTests/Clickstream/AutoRecordEventClientTest.swift
@@ -24,7 +24,7 @@ class AutoRecordEventClientTest: XCTestCase {
         activityTracker = MockActivityTracker()
 
         let contextConfiguration = ClickstreamConfiguration.getDefaultConfiguration()
-            .withAppId(testAppId)
+            .withAppId(testAppId + UUID().uuidString)
             .withEndpoint(testEndpoint)
             .withSendEventInterval(10_000)
             .withTrackAppExceptionEvents(true)
diff --git a/Tests/ClickstreamTests/Clickstream/EventRecorderTest.swift b/Tests/ClickstreamTests/Clickstream/EventRecorderTest.swift
@@ -40,7 +40,7 @@ class EventRecorderTest: XCTestCase {
                 return HttpResponse.ok(.text("request success"))
             }
             try! server.start()
-            let appId = testAppId + String(describing: Date().millisecondsSince1970)
+            let appId = testAppId + UUID().uuidString
 
             let contextConfiguration = ClickstreamConfiguration.getDefaultConfiguration()
                 .withAppId(appId)
diff --git a/Tests/ClickstreamTests/Clickstream/SessionClientTests.swift b/Tests/ClickstreamTests/Clickstream/SessionClientTests.swift
@@ -24,7 +24,7 @@ class SessionClientTests: XCTestCase {
         mockNetworkMonitor = MockNetworkMonitor()
 
         let contextConfiguration = ClickstreamConfiguration.getDefaultConfiguration()
-            .withAppId(testAppId)
+            .withAppId(testAppId + UUID().uuidString)
             .withEndpoint(testEndpoint)
             .withSendEventInterval(10_000)
             .withTrackAppExceptionEvents(false)
diff --git a/Tests/ClickstreamTests/ClickstreamPluginTestBase.swift b/Tests/ClickstreamTests/ClickstreamPluginTestBase.swift
@@ -21,7 +21,7 @@ class ClickstreamPluginTestBase: XCTestCase {
         analyticsPlugin = AWSClickstreamPlugin()
 
         let contextConfiguration = ClickstreamConfiguration.getDefaultConfiguration()
-            .withAppId(testAppId)
+            .withAppId(testAppId + UUID().uuidString)
             .withEndpoint(testEndpoint)
             .withSendEventInterval(10_000)
             .withTrackAppExceptionEvents(false)
@@ -34,7 +34,7 @@ class ClickstreamPluginTestBase: XCTestCase {
         let eventRecorder = try EventRecorder(clickstream: clickstream)
         let analyticsClient = try AnalyticsClient(clickstream: clickstream,
                                                   eventRecorder: eventRecorder,
-                                                  sessionClient: sessionClient )
+                                                  sessionClient: sessionClient)
         analyticsPlugin.analyticsClient = analyticsClient
         clickstream.analyticsClient = analyticsClient
         clickstream.networkMonitor = mockNetworkMonitor
diff --git a/Tests/ClickstreamTests/DataBase/ClickstreamDBUtilTest.swift b/Tests/ClickstreamTests/DataBase/ClickstreamDBUtilTest.swift
@@ -17,7 +17,7 @@ class ClickstreamDBUtiltest: XCTestCase {
 
     override func setUp() {
         do {
-            let appId = testAppId + String(describing: Date().millisecondsSince1970)
+            let appId = testAppId + UUID().uuidString
             dbAdapter = try BaseDBAdapter(prefixPath: EventRecorder.Constants.dbPathPrefix,
                                           databaseName: appId)
             dbUtil = ClickstreamDBUtil(dbAdapter: dbAdapter)
diff --git a/Tests/ClickstreamTests/IntegrationTest.swift b/Tests/ClickstreamTests/IntegrationTest.swift
@@ -30,7 +30,7 @@ class IntegrationTest: XCTestCase {
         }
         try! server.start()
         await Amplify.reset()
-        let appId = "testAppId" + String(describing: Date().millisecondsSince1970)
+        let appId = "testAppId" + UUID().uuidString
         let configure = ClickstreamConfiguration.getDefaultConfiguration()
             .withAppId(appId)
             .withEndpoint("http://localhost:8080/collect")
@@ -117,7 +117,7 @@ class IntegrationTest: XCTestCase {
         ClickstreamAnalytics.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
         ClickstreamAnalytics.flushEvents()
-        Thread.sleep(forTimeInterval: 0.2)
+        Thread.sleep(forTimeInterval: 0.5)
         let eventCount = try eventRecorder.dbUtil.getEventCount()
         XCTAssertEqual(0, eventCount)
     }
diff --git a/Tests/ClickstreamTests/SDKInitialTest.swift b/Tests/ClickstreamTests/SDKInitialTest.swift
@@ -44,14 +44,28 @@ class SDKInitialTest: XCTestCase {
             .withTrackUserEngagementEvents(false)
             .withAuthCookie("testAuthCookie")
             .withInitialGlobalAttributes([
-                "channel": "AppStore",
+                ClickstreamAnalytics.Attr.APP_INSTALL_CHANNEL: "AppStore",
                 "level": 5.1,
                 "class": 5,
                 "isOpenNotification": true
             ])
         try ClickstreamAnalytics.initSDK(configure)
     }
 
+    func testInitSDKWithGlobalAttributeForObjc() throws {
+        let globalAttribute: NSDictionary = [
+            ClickstreamAnalytics.Attr.APP_INSTALL_CHANNEL: "SMS",
+            "Successful": true,
+            "Score": 90.1,
+            "level": 5
+        ]
+        let configure = ClickstreamConfiguration()
+            .withAppId("testAppId")
+            .withEndpoint("https://example.com/collect")
+            .withInitialGlobalAttributesObjc(globalAttribute)
+        try ClickstreamAnalytics.initSDK(configure)
+    }
+
     func testInitSDKOverrideAllAmplifyConfiguration() throws {
         let configure = ClickstreamConfiguration()
             .withAppId("testAppId1")

Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ import Foundation`
`103`	`103`	`ClickstreamAnalytics.enable()`
`104`	`104`	`}`
`105`	`105`
`106`		`- private static func getAttributes(_ attributes: NSDictionary) -> ClickstreamAttribute {`
	`106`	`+ static func getAttributes(_ attributes: NSDictionary) -> ClickstreamAttribute {`
`107`	`107`	`var result: ClickstreamAttribute = [:]`
`108`	`108`	`for case let (key as String, value) in attributes {`
`109`	`109`	`if value is String {`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,11 @@ extension UserDefaults: UserDefaultsBehaviour {`
`124`	`124`	`self.globalAttributes = globalAttributes`
`125`	`125`	`return self`
`126`	`126`	`}`
	`127`	`+`
	`128`	`+ public func withInitialGlobalAttributesObjc(_ globalAttributes: NSDictionary) -> ClickstreamConfiguration {`
	`129`	`+ self.globalAttributes = ClickstreamObjc.getAttributes(globalAttributes)`
	`130`	`+ return self`
	`131`	`+ }`
`127`	`132`	`}`
`128`	`133`
`129`	`134`	`struct ClickstreamContextStorage {`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ class EventRecorderTest: XCTestCase {`
`40`	`40`	`return HttpResponse.ok(.text("request success"))`
`41`	`41`	`}`
`42`	`42`	`try! server.start()`
`43`		`- let appId = testAppId + String(describing: Date().millisecondsSince1970)`
	`43`	`+ let appId = testAppId + UUID().uuidString`
`44`	`44`
`45`	`45`	`let contextConfiguration = ClickstreamConfiguration.getDefaultConfiguration()`
`46`	`46`	`.withAppId(appId)`