fix: inconsistent issue when setting attributes asynchronously (#20)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>

Author: zhu-xiaowei

.github/workflows/test.yml

@@ -8,15 +8,23 @@ on:
 
 jobs:
   test:
-    runs-on: macos-12
+    runs-on: macos-13-xl
     steps:
       - uses: actions/checkout@v3
       - name: Run test
-        run: xcodebuild test -scheme aws-solution-clickstream-swift -destination 'platform=iOS Simulator,name=iPhone 14 Pro,OS=latest' -resultBundlePath .build/test/TestResults.xcresult | xcpretty --simple --color --report junit
+        run: xcodebuild test -scheme aws-solution-clickstream-swift -sdk iphonesimulator -derivedDataPath .build/ -destination 'platform=iOS Simulator,name=iPhone 14 Pro,OS=latest' -enableCodeCoverage YES | xcpretty --simple --color --report junit && exit ${PIPESTATUS[0]}
+      - name: Convert to json format
+        run: |
+          cd .build/Build/ProfileData
+          cd $(ls -d */|head -n 1)
+          directory=${PWD##*/}
+          pathCoverage=.build/Build/ProfileData/${directory}/Coverage.profdata
+          cd ../../../../
+          xcrun llvm-cov export -format="lcov" -instr-profile $pathCoverage .build/Build/Products/Debug-iphonesimulator/Clickstream.o > .build/info.lcov
       - name: Upload Test Report
         uses: codecov/codecov-action@v3
         with:
           name: report
-          files: .build/test/TestResults.xcresult
+          files: .build/info.lcov
           swift: true
 

Sources/Clickstream/AWSClickstreamPlugin+ClientBehavior.swift

@@ -10,21 +10,21 @@ import Foundation
 
 extension AWSClickstreamPlugin {
     func identifyUser(userId: String, userProfile: AnalyticsUserProfile?) {
-        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)
-                    }
+        if userId == Event.User.USER_ID_EMPTY {
+            if let attributes = userProfile?.properties {
+                for attribute in attributes {
+                    analyticsClient.addUserAttribute(attribute.value, forKey: attribute.key)
                 }
+            }
+        } else {
+            if userId == Event.User.USER_ID_NIL {
+                analyticsClient.updateUserId(nil)
             } else {
-                if userId == Event.User.USER_ID_NIL {
-                    await analyticsClient.updateUserId(nil)
-                } else {
-                    await analyticsClient.updateUserId(userId)
-                }
+                analyticsClient.updateUserId(userId)
             }
-            await analyticsClient.updateUserAttributes()
+        }
+        analyticsClient.updateUserAttributes()
+        Task {
             record(eventWithName: Event.PresetEvent.PROFILE_SET)
         }
     }
@@ -59,17 +59,13 @@ extension AWSClickstreamPlugin {
 
     func registerGlobalProperties(_ properties: AnalyticsProperties) {
         properties.forEach { key, value in
-            Task {
-                await analyticsClient.addGlobalAttribute(value, forKey: key)
-            }
+            analyticsClient.addGlobalAttribute(value, forKey: key)
         }
     }
 
     func unregisterGlobalProperties(_ keys: Set<String>?) {
         keys?.forEach { key in
-            Task {
-                await analyticsClient.removeGlobalAttribute(forKey: key)
-            }
+            analyticsClient.removeGlobalAttribute(forKey: key)
         }
     }
 
@@ -83,9 +79,7 @@ extension AWSClickstreamPlugin {
             log.error("Device is offline, skipping submitting events to Clickstream server")
             return
         }
-        Task {
-            try await analyticsClient.submitEvents()
-        }
+        analyticsClient.submitEvents()
     }
 
     func getEscapeHatch() -> ClickstreamContext {

Sources/Clickstream/Dependency/Clickstream/Analytics/AnalyticsClient.swift

@@ -7,22 +7,22 @@
 
 import Foundation
 
-protocol AnalyticsClientBehaviour: Actor {
+protocol AnalyticsClientBehaviour {
     func addGlobalAttribute(_ attribute: AttributeValue, forKey key: String)
     func addUserAttribute(_ attribute: AttributeValue, forKey key: String)
     func removeGlobalAttribute(forKey key: String)
     func removeUserAttribute(forKey key: String)
     func updateUserId(_ id: String?)
     func updateUserAttributes()
 
-    nonisolated func createEvent(withEventType eventType: String) -> ClickstreamEvent
+    func createEvent(withEventType eventType: String) -> ClickstreamEvent
     func record(_ event: ClickstreamEvent) async throws
-    func submitEvents() throws
+    func submitEvents()
 }
 
 typealias SessionProvider = () -> Session?
 
-actor AnalyticsClient: AnalyticsClientBehaviour {
+class AnalyticsClient: AnalyticsClientBehaviour {
     private(set) var eventRecorder: AnalyticsEventRecording
     private let sessionProvider: SessionProvider
     private(set) lazy var globalAttributes: [String: AttributeValue] = [:]
@@ -101,7 +101,7 @@ actor AnalyticsClient: AnalyticsClientBehaviour {
 
     // MARK: - Event recording
 
-    nonisolated func createEvent(withEventType eventType: String) -> ClickstreamEvent {
+    func createEvent(withEventType eventType: String) -> ClickstreamEvent {
         let (isValid, errorType) = Event.isValidEventType(eventType: eventType)
         precondition(isValid, errorType)
 
@@ -124,7 +124,7 @@ actor AnalyticsClient: AnalyticsClientBehaviour {
         try eventRecorder.save(event)
     }
 
-    func submitEvents() throws {
-        try eventRecorder.submitEvents()
+    func submitEvents() {
+        eventRecorder.submitEvents()
     }
 }

Sources/Clickstream/Dependency/Clickstream/Analytics/EventRecorder.swift

@@ -16,7 +16,7 @@ protocol AnalyticsEventRecording {
 
     /// Submit locally stored events
     /// - Returns: A collection of events submitted to Clickstream
-    func submitEvents() throws
+    func submitEvents()
 }
 
 /// An AnalyticsEventRecording implementation that stores and submits clickstream events

Sources/Clickstream/Dependency/Clickstream/AutoRecord/AutoRecordEventClient.swift

@@ -155,7 +155,11 @@ class AutoRecordEventClient {
 
     func recordEvent(_ event: ClickstreamEvent) {
         Task {
-            try await clickstream.analyticsClient.record(event)
+            do {
+                try await clickstream.analyticsClient.record(event)
+            } catch {
+                log.error("Record event error:\(error)")
+            }
         }
     }
 }

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.5.0"
+    static let version = "0.5.1"
 }