fix: timestamp order in event and user attributes. (#15)

zhu-xiaowei · xiaoweii · web-flow · commit 6d9cf5385b0c · 2023-06-14T07:35:28.000+08:00
Co-authored-by: xiaoweii &lt;xiaoweii@amazom.com&gt;
diff --git a/Sources/Clickstream/AWSClickstreamPlugin+ClientBehavior.swift b/Sources/Clickstream/AWSClickstreamPlugin+ClientBehavior.swift
@@ -10,25 +10,23 @@ import Foundation
 
 extension AWSClickstreamPlugin {
     func identifyUser(userId: String, userProfile: AnalyticsUserProfile?) {
-        if userId == Event.User.USER_ID_EMPTY {
-            userProfile?.properties?.forEach { key, value in
-                Task {
-                    await analyticsClient.addUserAttribute(value, forKey: key)
+        Task {
+            if userId == Event.User.USER_ID_EMPTY {
+                if let attributes = userProfile?.properties {
+                    for attribute in attributes {
+                        await analyticsClient.addUserAttribute(attribute.value, forKey: attribute.key)
+                    }
                 }
-            }
-        } else {
-            Task {
+            } else {
                 if userId == Event.User.USER_ID_NIL {
                     await analyticsClient.updateUserId(nil)
                 } else {
                     await analyticsClient.updateUserId(userId)
                 }
             }
-        }
-        Task {
             await analyticsClient.updateUserAttributes()
+            record(eventWithName: Event.PresetEvent.PROFILE_SET)
         }
-        record(eventWithName: Event.PresetEvent.PROFILE_SET)
     }
 
     func record(event: AnalyticsEvent) {
diff --git a/Sources/Clickstream/ClickstreamAnalytics.swift b/Sources/Clickstream/ClickstreamAnalytics.swift
@@ -17,15 +17,15 @@ public enum ClickstreamAnalytics {
 
     /// Use this method to record event
     /// - Parameter eventName: the event name
-    public static func recordEvent(eventName: String) {
+    public static func recordEvent(_ eventName: String) {
         Amplify.Analytics.record(eventWithName: eventName)
     }
 
     /// The method to record event with ClickstreamAttribute
     /// - Parameters:
     ///   - eventName: the event name
     ///   - attributes: the event attributes
-    public static func recordEvent(eventName: String, attributes: ClickstreamAttribute) {
+    public static func recordEvent(_ eventName: String, _ attributes: ClickstreamAttribute) {
         let event = BaseClickstreamEvent(name: eventName, attribute: attributes)
         Amplify.Analytics.record(event: event)
     }
@@ -37,27 +37,27 @@ public enum ClickstreamAnalytics {
 
     /// Add global attributes
     /// - Parameter attributes: the global attributes to add
-    public static func addGlobalAttributes(attributes: ClickstreamAttribute) {
+    public static func addGlobalAttributes(_ attributes: ClickstreamAttribute) {
         Amplify.Analytics.registerGlobalProperties(attributes)
     }
 
     /// Delete global attributes
     /// - Parameter attributes: the global attributes names to delete
-    public static func deleteGlobalAttributes(attributes: String...) {
+    public static func deleteGlobalAttributes(_ attributes: String...) {
         Amplify.Analytics.unregisterGlobalProperties(attributes)
     }
 
     /// Add user attributes
     /// - Parameter attributes: the user attributes to add
-    public static func addUserAttributes(attributes: ClickstreamAttribute) {
+    public static func addUserAttributes(_ attributes: ClickstreamAttribute) {
         let userProfile = AnalyticsUserProfile(location: nil, properties: attributes)
         Amplify.Analytics.identifyUser(userId: Event.User.USER_ID_EMPTY,
                                        userProfile: userProfile)
     }
 
     /// Set user id for login and logout
     /// - Parameter userId: current userId, nil for logout
-    public static func setUserId(userId: String?) {
+    public static func setUserId(_ userId: String?) {
         if userId == nil {
             Amplify.Analytics.identifyUser(userId: Event.User.USER_ID_NIL)
         } else {
diff --git a/Sources/Clickstream/ClickstreamObjc.swift b/Sources/Clickstream/ClickstreamObjc.swift
@@ -9,6 +9,13 @@ import Foundation
 
 /// ClickstreamAnalytics api for objective-c
 @objcMembers public class ClickstreamObjc: NSObject {
+    
+    /// Hide the constructor
+    @nonobjc
+    override private init() {
+        super.init()
+    }
+
     /// Init the Clickstream sdk
     public static func initSDK() throws {
         try ClickstreamAnalytics.initSDK()
@@ -17,15 +24,15 @@ import Foundation
     /// Use this method to record event
     /// - Parameter eventName: the event name
     public static func recordEvent(_ eventName: String) {
-        ClickstreamAnalytics.recordEvent(eventName: eventName)
+        ClickstreamAnalytics.recordEvent(eventName)
     }
 
     /// The method to record event with attributes
     /// - Parameters:
     ///   - eventName: the event name
     ///   - attributes: the event attributes which type is NSDictionary
     public static func recordEvent(_ eventName: String, _ attributes: NSDictionary) {
-        ClickstreamAnalytics.recordEvent(eventName: eventName, attributes: getAttributes(attributes))
+        ClickstreamAnalytics.recordEvent(eventName, getAttributes(attributes))
     }
 
     /// Use this method to send events immediately
@@ -36,27 +43,27 @@ import Foundation
     /// Add global attributes
     /// - Parameter attributes: the global attributes to add
     public static func addGlobalAttributes(_ attributes: NSDictionary) {
-        ClickstreamAnalytics.addGlobalAttributes(attributes: getAttributes(attributes))
+        ClickstreamAnalytics.addGlobalAttributes(getAttributes(attributes))
     }
 
     /// Delete global attributes
     /// - Parameter attributes: the global attributes names to delete
     public static func deleteGlobalAttributes(_ attributes: [String]) {
         for attribute in attributes {
-            ClickstreamAnalytics.deleteGlobalAttributes(attributes: attribute)
+            ClickstreamAnalytics.deleteGlobalAttributes(attribute)
         }
     }
 
     /// Add user attributes
     /// - Parameter attributes: the user attributes to add
     public static func addUserAttributes(_ attributes: NSDictionary) {
-        ClickstreamAnalytics.addUserAttributes(attributes: getAttributes(attributes))
+        ClickstreamAnalytics.addUserAttributes(getAttributes(attributes))
     }
 
     /// Set user id for login and logout
     /// - Parameter userId: current userId, nil for logout
     public static func setUserId(_ userId: String?) {
-        ClickstreamAnalytics.setUserId(userId: userId)
+        ClickstreamAnalytics.setUserId(userId)
     }
 
     /// Get Clickstream configuration, please config it after initialize sdk
diff --git a/Sources/Clickstream/PackageInfo.swift b/Sources/Clickstream/PackageInfo.swift
@@ -8,5 +8,5 @@
 enum PackageInfo {
     /// the clickstream analytics iOS sdk version
     /// note: update and align the version with new tag version before committing new tag
-    static let version = "0.4.2"
+    static let version = "0.5.0"
 }
diff --git a/Tests/ClickstreamTests/IntegrationTest.swift b/Tests/ClickstreamTests/IntegrationTest.swift
@@ -37,7 +37,7 @@ class IntegrationTest: XCTestCase {
                 "appId": appId,
                 "endpoint": "http://localhost:8080/collect",
                 "isCompressEvents": false,
-                "autoFlushEventsInterval": 80,
+                "autoFlushEventsInterval": 10000,
                 "isTrackAppExceptionEvents": false
             ]
         ]
@@ -61,42 +61,41 @@ class IntegrationTest: XCTestCase {
     }
 
     func testRecordOneEventSuccess() throws {
-        let attribute: ClickstreamAttribute = [
+        ClickstreamAnalytics.recordEvent("userId", [
             "Channel": "SMS",
             "Successful": true,
             "Score": 90
-        ]
-        ClickstreamAnalytics.recordEvent(eventName: "userId", attributes: attribute)
+        ])
         ClickstreamAnalytics.flushEvents()
         Thread.sleep(forTimeInterval: 0.2)
         let eventCount = try eventRecorder.dbUtil.getEventCount()
         XCTAssertEqual(0, eventCount)
     }
 
     func testRecordOneEventWithNameSuccess() throws {
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.recordEvent("testEvent")
         ClickstreamAnalytics.flushEvents()
         Thread.sleep(forTimeInterval: 0.2)
         let eventCount = try eventRecorder.dbUtil.getEventCount()
         XCTAssertEqual(0, eventCount)
     }
 
     func testFlushEvents() throws {
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.recordEvent("testEvent")
         ClickstreamAnalytics.flushEvents()
         Thread.sleep(forTimeInterval: 0.2)
         let eventCount = try eventRecorder.dbUtil.getEventCount()
         XCTAssertEqual(0, eventCount)
     }
 
     func testAddGlobalAttribute() throws {
-        ClickstreamAnalytics.addGlobalAttributes(attributes: [
+        ClickstreamAnalytics.addGlobalAttributes([
             "channel": "AppStore",
             "level": 5.1,
             "class": 5,
             "isOpenNotification": true
         ])
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
 
         let testEvent = try getTestEvent()
@@ -108,14 +107,14 @@ class IntegrationTest: XCTestCase {
     }
 
     func testDeleteGlobalAttribute() throws {
-        ClickstreamAnalytics.addGlobalAttributes(attributes: [
+        ClickstreamAnalytics.addGlobalAttributes([
             "channel": "AppStore",
             "level": 5.1,
             "class": 5,
             "isOpenNotification": true
         ])
-        ClickstreamAnalytics.deleteGlobalAttributes(attributes: "channel")
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.deleteGlobalAttributes("channel")
+        ClickstreamAnalytics.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
 
         let testEvent = try getTestEvent()
@@ -127,15 +126,15 @@ class IntegrationTest: XCTestCase {
     }
 
     func testAddUserAttribute() throws {
-        ClickstreamAnalytics.setUserId(userId: "13232")
-        let userAttribute: ClickstreamAttribute = [
+        ClickstreamAnalytics.setUserId("13232")
+        ClickstreamAnalytics.addUserAttributes([
             "_user_age": 21,
             "isFirstOpen": true,
             "score": 85.2,
             "_user_name": "carl"
-        ]
-        ClickstreamAnalytics.addUserAttributes(attributes: userAttribute)
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ])
+        Thread.sleep(forTimeInterval: 0.1)
+        ClickstreamAnalytics.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
         let testEvent = try getTestEvent()
         let userInfo = testEvent["user"] as! [String: Any]
@@ -147,26 +146,26 @@ class IntegrationTest: XCTestCase {
     }
 
     func testSetUserIdString() throws {
-        ClickstreamAnalytics.setUserId(userId: "12345")
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.setUserId("12345")
+        ClickstreamAnalytics.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
         let testEvent = try getTestEvent()
         let userInfo = testEvent["user"] as! [String: Any]
         XCTAssertEqual("12345", (userInfo[Event.ReservedAttribute.USER_ID] as! JsonObject)["value"] as! String)
     }
 
     func testSetUserIdNil() throws {
-        ClickstreamAnalytics.setUserId(userId: "12345")
-        ClickstreamAnalytics.setUserId(userId: nil)
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.setUserId("12345")
+        ClickstreamAnalytics.setUserId(nil)
+        ClickstreamAnalytics.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
         let testEvent = try getTestEvent()
         let userInfo = testEvent["user"] as! [String: Any]
         XCTAssertNil(userInfo[Event.ReservedAttribute.USER_ID])
     }
 
     func testProfileSetEvent() throws {
-        ClickstreamAnalytics.setUserId(userId: "12345")
+        ClickstreamAnalytics.setUserId("12345")
         Thread.sleep(forTimeInterval: 0.1)
         let eventArray = try eventRecorder.getBatchEvent().eventsJson.jsonArray()
         let profileSetEvent = eventArray[eventArray.count - 1]
@@ -175,10 +174,52 @@ class IntegrationTest: XCTestCase {
                 as! JsonObject)["value"] as! String, "12345")
     }
 
+    func testProfileSetEventWithAllAttributes() throws {
+        ClickstreamAnalytics.addUserAttributes([
+            "_user_age": 21,
+            "isFirstOpen": true,
+            "score": 85.2,
+            "_user_name": "carl"
+        ])
+        Thread.sleep(forTimeInterval: 0.1)
+        let eventArray = try eventRecorder.getBatchEvent().eventsJson.jsonArray()
+        let profileSetEvent = eventArray[eventArray.count - 1]
+        XCTAssertEqual(profileSetEvent["event_type"] as! String, Event.PresetEvent.PROFILE_SET)
+        let user = (profileSetEvent["user"] as! JsonObject)
+        XCTAssertEqual((user["_user_age"] as! JsonObject)["value"] as! Int, 21)
+        XCTAssertEqual((user["isFirstOpen"] as! JsonObject)["value"] as! Bool, true)
+        XCTAssertEqual((user["score"] as! JsonObject)["value"] as! Double, 85.2)
+        XCTAssertEqual((user["_user_name"] as! JsonObject)["value"] as! String, "carl")
+        XCTAssertNotNil(user[Event.ReservedAttribute.USER_FIRST_TOUCH_TIMESTAMP])
+    }
+
+    func testProfileSetTimestamp() throws {
+        ClickstreamAnalytics.addUserAttributes([
+            "_user_age": 21,
+            "isFirstOpen": true,
+            "score": 85.2,
+            "_user_name": "carl"
+        ])
+        Thread.sleep(forTimeInterval: 0.1)
+        let eventArray = try eventRecorder.getBatchEvent().eventsJson.jsonArray()
+        let profileSetEvent = eventArray[eventArray.count - 1]
+        XCTAssertEqual(profileSetEvent["event_type"] as! String, Event.PresetEvent.PROFILE_SET)
+        let eventTime = profileSetEvent["timestamp"] as! Int64
+        let user = (profileSetEvent["user"] as! JsonObject)
+        let userAgeSetTime = (user["_user_age"] as! JsonObject)["set_timestamp"] as! Int64
+        let isFirstOpenSetTime = (user["isFirstOpen"] as! JsonObject)["set_timestamp"] as! Int64
+        let scoreSetTime = (user["score"] as! JsonObject)["set_timestamp"] as! Int64
+        let userNameSetTime = (user["_user_name"] as! JsonObject)["set_timestamp"] as! Int64
+        XCTAssertTrue(eventTime >= userAgeSetTime)
+        XCTAssertTrue(eventTime >= isFirstOpenSetTime)
+        XCTAssertTrue(eventTime >= scoreSetTime)
+        XCTAssertTrue(eventTime >= userNameSetTime)
+    }
+
     func testModifyEndpoint() throws {
         let configuration = try ClickstreamAnalytics.getClickstreamConfiguration()
         configuration.endpoint = testFailEndpoint
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.recordEvent("testEvent")
         ClickstreamAnalytics.flushEvents()
         Thread.sleep(forTimeInterval: 0.2)
         let eventCount = try eventRecorder.dbUtil.getEventCount()
@@ -190,7 +231,7 @@ class IntegrationTest: XCTestCase {
         configuration.isCompressEvents = true
         configuration.isLogEvents = true
         configuration.authCookie = "authCookie"
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.recordEvent("testEvent")
         ClickstreamAnalytics.flushEvents()
         Thread.sleep(forTimeInterval: 0.2)
         let eventCount = try eventRecorder.dbUtil.getEventCount()
@@ -223,6 +264,7 @@ class IntegrationTest: XCTestCase {
         ]
         ClickstreamObjc.addGlobalAttributes(attribute)
         ClickstreamObjc.deleteGlobalAttributes(["Channel"])
+        Thread.sleep(forTimeInterval: 0.1)
         ClickstreamObjc.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
         let testEvent = try getTestEvent()
@@ -242,6 +284,7 @@ class IntegrationTest: XCTestCase {
             "_user_name": "carl"
         ]
         ClickstreamObjc.addUserAttributes(userAttribute)
+        Thread.sleep(forTimeInterval: 0.1)
         ClickstreamObjc.recordEvent("testEvent")
         Thread.sleep(forTimeInterval: 0.1)
         let testEvent = try getTestEvent()
@@ -257,7 +300,7 @@ class IntegrationTest: XCTestCase {
         let configuration = try ClickstreamObjc.getClickstreamConfiguration()
         configuration.isCompressEvents = true
         configuration.authCookie = "authCookie"
-        ClickstreamAnalytics.recordEvent(eventName: "testEvent")
+        ClickstreamAnalytics.recordEvent("testEvent")
         ClickstreamAnalytics.flushEvents()
         Thread.sleep(forTimeInterval: 0.2)
         let eventCount = try eventRecorder.dbUtil.getEventCount()

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@`
`8`	`8`	`enum PackageInfo {`
`9`	`9`	`/// the clickstream analytics iOS sdk version`
`10`	`10`	`/// note: update and align the version with new tag version before committing new tag`
`11`		`- static let version = "0.4.2"`
	`11`	`+ static let version = "0.5.0"`
`12`	`12`	`}`