fix: change the screen unique id generation method (#30)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>
awslabs · Sep 9, 2023 · cbf6e16 · cbf6e16
1 parent 041f3c6
commit cbf6e16
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 14 deletions.
diff --git a/Sources/Clickstream/Dependency/Clickstream/AutoRecord/AutoRecordEventClient.swift b/Sources/Clickstream/Dependency/Clickstream/AutoRecord/AutoRecordEventClient.swift
@@ -35,10 +35,9 @@ class AutoRecordEventClient {
     }
 
     func onViewDidAppear(screenName: String, screenPath: String, screenHashValue: String) {
-        let screenUniqueId = getScreenUniqueId(screenHashValue)
-        if !isSameScreen(screenName, screenPath, screenUniqueId) {
+        if !isSameScreen(screenName, screenPath, screenHashValue) {
             recordUserEngagement()
-            recordScreenView(screenName, screenPath, screenUniqueId)
+            recordScreenView(screenName, screenPath, screenHashValue)
         }
     }
 
@@ -101,13 +100,6 @@ class AutoRecordEventClient {
         }
     }
 
-    func getScreenUniqueId(_ screenHashValue: String) -> String {
-        let shortDeviceId = clickstream.systemInfo.deviceId.padding(toLength: Constants.maxDeviceIdLength,
-                                                                    withPad: Constants.paddingChar,
-                                                                    startingAt: 0)
-        return "\(shortDeviceId)-\(screenHashValue)"
-    }
-
     func isSameScreen(_ screenName: String, _ screenPath: String, _ screenUniqueId: String) -> Bool {
         lastScreenName != nil
             && lastScreenPath != nil
@@ -220,8 +212,6 @@ class AutoRecordEventClient {
 extension AutoRecordEventClient {
     enum Constants {
         static let minEngagementTime = 1_000
-        static let maxDeviceIdLength = 8
-        static let paddingChar = "_"
     }
 }
 

diff --git a/Sources/Clickstream/Dependency/Clickstream/Event/ClickstreamEvent.swift b/Sources/Clickstream/Dependency/Clickstream/Event/ClickstreamEvent.swift
@@ -105,7 +105,7 @@ class ClickstreamEvent: AnalyticsPropertiesModel, Hashable {
     func getJsonStringFromObject(jsonObject: JsonObject) -> String {
         do {
             let jsonData = try JSONSerialization.data(withJSONObject: jsonObject, options: [.sortedKeys])
-            return String(data: jsonData, encoding: .utf8)!
+            return String(data: jsonData, encoding: .utf8) ?? ""
         } catch {
             log.error("Error serializing dictionary to JSON: \(error.localizedDescription)")
         }

diff --git a/Tests/ClickstreamTests/Clickstream/AutoRecordEventClientTest.swift b/Tests/ClickstreamTests/Clickstream/AutoRecordEventClientTest.swift
@@ -80,13 +80,16 @@ class AutoRecordEventClientTest: XCTestCase {
         XCTAssertEqual(eventRecorder.lastSavedEvent?.eventType, Event.PresetEvent.SCREEN_VIEW)
         XCTAssertNotNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.SCREEN_ID])
         XCTAssertNotNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.SCREEN_NAME])
-        XCTAssertNotNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.SCREEN_UNIQUEID])
         XCTAssertNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.ENGAGEMENT_TIMESTAMP])
         XCTAssertNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.PREVIOUS_SCREEN_ID])
         XCTAssertNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.PREVIOUS_SCREEN_NAME])
         XCTAssertNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.PREVIOUS_SCREEN_UNIQUEID])
         XCTAssertNil(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.PREVIOUS_TIMESTAMP])
         XCTAssertTrue(eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.ENTRANCES] as! Int == 1)
+
+        let screenUniqueId = eventRecorder.lastSavedEvent!.attributes[Event.ReservedAttribute.SCREEN_UNIQUEID] as! String
+        XCTAssertNotNil(screenUniqueId)
+        XCTAssertEqual(screenUniqueId, String(describing: viewController.hashValue))
     }
 
     func testTwoScreenViewWithoutUserEngagement() {