feat: add preset events. (#2)

---------

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

Author: zhu-xiaowei

Package.resolved

@@ -14,7 +14,7 @@ let package = Package(
         )
     ],
     dependencies: [
-        .package(url: "https://github.com/aws-amplify/amplify-swift.git", exact: "2.4.0"),
+        .package(url: "https://github.com/aws-amplify/amplify-swift.git", exact: "2.10.0"),
         .package(url: "https://github.com/stephencelis/SQLite.swift.git", exact: "0.13.2"),
         .package(url: "https://github.com/1024jp/GzipSwift", exact: "5.2.0"),
         .package(url: "https://github.com/httpswift/swifter", exact: "1.5.0")

Package.swift

@@ -10,22 +10,29 @@ import Foundation
 
 public extension AWSClickstreamPlugin {
     func identifyUser(userId: String, userProfile: AnalyticsUserProfile?) {
-        Task {
-            if userId == Event.User.USER_ID_NIL {
-                await analyticsClient.removeUserAttribute(forKey: Event.ReservedAttribute.USER_ID)
-            } else if userId != Event.User.USER_ID_EMPTY {
-                await analyticsClient.addUserAttribute(userId, forKey: Event.ReservedAttribute.USER_ID)
+        if userId == Event.User.USER_ID_EMPTY {
+            userProfile?.properties?.forEach { key, value in
+                Task {
+                    await analyticsClient.addUserAttribute(value, forKey: key)
+                }
             }
-        }
-        userProfile?.properties?.forEach { key, value in
+        } else {
             Task {
-                await analyticsClient.addUserAttribute(value, forKey: key)
+                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)
     }
 
     func record(event: AnalyticsEvent) {
-        guard let event = event as? BaseClickstreamEvent else{
+        guard let event = event as? BaseClickstreamEvent else {
             log.error("Event type does not match")
             return
         }
@@ -83,8 +90,8 @@ public extension AWSClickstreamPlugin {
         }
     }
 
-    func getEscapeHatch() -> ClickstreamContextConfiguration {
-        clickstream.configuration
+    func getEscapeHatch() -> ClickstreamContext {
+        clickstream
     }
 
     func enable() {

Sources/Clickstream/AWSClickstreamPlugin+ClientBehavior.swift

@@ -8,6 +8,9 @@
 import Amplify
 import Foundation
 import Network
+#if canImport(UIKit)
+    import UIKit
+#endif
 
 public extension AWSClickstreamPlugin {
     /// called when sdk init.
@@ -32,22 +35,19 @@ public extension AWSClickstreamPlugin {
                                                                    isCompressEvents: configuration.isCompressEvents)
         clickstream = try ClickstreamContext(with: contextConfiguration)
 
-        let sessionClient = SessionClient(configuration: .init(uniqueDeviceId: clickstream.uniqueId,
-                                                               sessionBackgroundTimeout: TimeInterval(10)),
-                                          userDefaults: clickstream.storage.userDefaults)
+        let sessionClient = SessionClient(clickstream: clickstream)
         clickstream.sessionClient = sessionClient
-        let sessionProvider: () -> Session = { [weak sessionClient] in
+        let sessionProvider: () -> Session? = { [weak sessionClient] in
             guard let sessionClient else {
                 fatalError("SessionClient was deallocated")
             }
-            return sessionClient.currentSession
+            return sessionClient.getCurrentSession()
         }
         let eventRecorder = try EventRecorder(clickstream: clickstream)
         analyticsClient = try AnalyticsClient(clickstream: clickstream,
                                               eventRecorder: eventRecorder,
                                               sessionProvider: sessionProvider)
         clickstream.analyticsClient = analyticsClient
-        sessionClient.analyticsClient = analyticsClient
         let networkMonitor = NWPathMonitor()
         clickstream.networkMonitor = networkMonitor
 
@@ -57,7 +57,6 @@ public extension AWSClickstreamPlugin {
             autoFlushEventsTimer = RepeatingTimer.createRepeatingTimer(
                 timeInterval: timeInterval,
                 eventHandler: { [weak self] in
-                    self?.log.debug("AutoFlushTimer triggered, flushing events")
                     self?.flushEvents()
                 }
             )
@@ -67,7 +66,6 @@ public extension AWSClickstreamPlugin {
             autoFlushEventsTimer: autoFlushEventsTimer,
             networkMonitor: networkMonitor
         )
-        sessionClient.startSession()
         log.debug("init the sdk success")
     }
 
@@ -84,7 +82,7 @@ public extension AWSClickstreamPlugin {
         self.networkMonitor = networkMonitor
         self.networkMonitor.startMonitoring(
             using: DispatchQueue(
-                label: "com.amazonaws.solution.clickstream.AnalyticsPlugin.NetworkMonitor"
+                label: "software.aws.solution.clickstream.AnalyticsPlugin.NetworkMonitor"
             )
         )
     }

Sources/Clickstream/AWSClickstreamPlugin+Configure.swift

@@ -9,7 +9,7 @@ import Amplify
 import Foundation
 
 public final class AWSClickstreamPlugin: AnalyticsCategoryPlugin {
-    var clickstream: ClickstreamContext!
+    public var clickstream: ClickstreamContext!
 
     /// Automatically flushes the events that have been recorded on an interval
     var autoFlushEventsTimer: DispatchSourceTimer?

Sources/Clickstream/AWSClickstreamPlugin.swift

@@ -45,10 +45,9 @@ public enum ClickstreamAnalytics {
 
     /// Add user attributes
     /// - Parameter attributes: the user attributes to add
-    public static func addUserAttributes(userAttributes: ClickstreamUserAttribute) {
-        let userId: String = userAttributes.userId ?? Event.User.USER_ID_EMPTY
-        let userProfile = AnalyticsUserProfile(location: nil, properties: userAttributes.attribute)
-        Amplify.Analytics.identifyUser(userId: userId,
+    public static func addUserAttributes(attributes: ClickstreamAttribute) {
+        let userProfile = AnalyticsUserProfile(location: nil, properties: attributes)
+        Amplify.Analytics.identifyUser(userId: Event.User.USER_ID_EMPTY,
                                        userProfile: userProfile)
     }
 
@@ -66,6 +65,6 @@ public enum ClickstreamAnalytics {
     /// - Returns: ClickstreamContextConfiguration: current userId, nil for logout
     public static func getClickStreamConfiguration() throws -> ClickstreamContextConfiguration? {
         let plugin = try Amplify.Analytics.getPlugin(for: "awsClickstreamPlugin")
-        return (plugin as? AWSClickstreamPlugin)?.getEscapeHatch()
+        return (plugin as? AWSClickstreamPlugin)?.getEscapeHatch().configuration
     }
 }

Sources/Clickstream/ClickstreamAnalytics.swift

@@ -9,6 +9,7 @@ import Amplify
 
 public typealias ClickstreamAttribute = AnalyticsProperties
 public typealias AttributeValue = AnalyticsPropertyValue
+extension Int64: AnalyticsPropertyValue {}
 
 public struct BaseClickstreamEvent: AnalyticsEvent {
     public var properties: AnalyticsProperties?
@@ -32,10 +33,8 @@ public struct BaseClickstreamEvent: AnalyticsEvent {
 }
 
 public struct ClickstreamUserAttribute {
-    public var userId: String?
     public var attribute: ClickstreamAttribute?
-    public init(userId: String?, attribute: ClickstreamAttribute?) {
-        self.userId = userId
+    public init(attribute: ClickstreamAttribute?) {
         self.attribute = attribute
     }
 }

Sources/Clickstream/ClickstreamAttribute.swift

@@ -17,13 +17,12 @@ enum ActivityEvent {
     case applicationDidMoveToBackground
     case applicationWillMoveToForeground
     case applicationWillTerminate
-    case backgroundTrackingDidTimeout
 }
 
 enum ApplicationState {
     case initializing
     case runningInForeground
-    case runningInBackground(isStale: Bool)
+    case runningInBackground
     case terminated
 
     enum Resolver {
@@ -37,11 +36,9 @@ enum ApplicationState {
             case .applicationWillTerminate:
                 return .terminated
             case .applicationDidMoveToBackground:
-                return .runningInBackground(isStale: false)
+                return .runningInBackground
             case .applicationWillMoveToForeground:
                 return .runningInForeground
-            case .backgroundTrackingDidTimeout:
-                return .runningInBackground(isStale: true)
             }
         }
     }
@@ -56,17 +53,6 @@ protocol ActivityTrackerBehaviour {
 }
 
 class ActivityTracker: ActivityTrackerBehaviour {
-    #if canImport(UIKit)
-        private var backgroundTask: UIBackgroundTaskIdentifier = .invalid
-    #endif
-
-    private var backgroundTimer: Timer? {
-        willSet {
-            backgroundTimer?.invalidate()
-        }
-    }
-
-    private let backgroundTrackingTimeout: TimeInterval
     private let stateMachine: StateMachine<ApplicationState, ActivityEvent>
     private var stateMachineSubscriberToken: StateMachineSubscriberToken?
 
@@ -100,10 +86,7 @@ class ActivityTracker: ActivityTrackerBehaviour {
         applicationWillTerminate
     ]
 
-    init(backgroundTrackingTimeout: TimeInterval,
-         stateMachine: StateMachine<ApplicationState, ActivityEvent>? = nil)
-    {
-        self.backgroundTrackingTimeout = backgroundTrackingTimeout
+    init(stateMachine: StateMachine<ApplicationState, ActivityEvent>? = nil) {
         self.stateMachine = stateMachine ??
             StateMachine(initialState: .initializing,
                          resolver: ApplicationState.Resolver.resolve(currentState:event:))
@@ -128,44 +111,11 @@ class ActivityTracker: ActivityTrackerBehaviour {
         stateMachineSubscriberToken = stateMachine.subscribe(listener)
     }
 
-    private func beginBackgroundTracking() {
-        #if canImport(UIKit)
-            if backgroundTrackingTimeout > 0 {
-                backgroundTask = UIApplication.shared.beginBackgroundTask(withName:
-                    Constants.backgroundTask)
-                    { [weak self] in
-                        self?.stateMachine.process(.backgroundTrackingDidTimeout)
-                        self?.stopBackgroundTracking()
-                    }
-            }
-        #endif
-        guard backgroundTrackingTimeout != .infinity else { return }
-        backgroundTimer = Timer.scheduledTimer(withTimeInterval:
-            backgroundTrackingTimeout, repeats: false)
-            { [weak self] _ in
-                self?.stateMachine.process(.backgroundTrackingDidTimeout)
-                self?.stopBackgroundTracking()
-            }
-    }
-
-    private func stopBackgroundTracking() {
-        backgroundTimer = nil
-        #if canImport(UIKit)
-            guard backgroundTask != .invalid else {
-                return
-            }
-            UIApplication.shared.endBackgroundTask(backgroundTask)
-            backgroundTask = .invalid
-        #endif
-    }
-
     @objc private func handleApplicationStateChange(_ notification: Notification) {
         switch notification.name {
         case Self.applicationDidMoveToBackground:
-            beginBackgroundTracking()
             stateMachine.process(.applicationDidMoveToBackground)
         case Self.applicationWillMoveToForegound:
-            stopBackgroundTracking()
             stateMachine.process(.applicationWillMoveToForeground)
         case Self.applicationWillTerminate:
             stateMachine.process(.applicationWillTerminate)
@@ -174,11 +124,3 @@ class ActivityTracker: ActivityTrackerBehaviour {
         }
     }
 }
-
-#if canImport(UIKit)
-    extension ActivityTracker {
-        enum Constants {
-            static let backgroundTask = "com.amazonaws.solution.clickstream.SessionBackgroundTask"
-        }
-    }
-#endif

Sources/Clickstream/Dependency/Clickstream/ActivityTracking/ActivityTracker.swift

@@ -16,7 +16,7 @@ extension AnyCancellable: StateMachineSubscriberToken {}
 class StateMachine<State, Event> {
     typealias Reducer = (State, Event) -> State
     private let queue = DispatchQueue(
-        label: "com.amazonaws.solution.Clickstream.StateMachine<\(State.self), \(Event.self)>",
+        label: "software.aws.solution.Clickstream.StateMachine<\(State.self), \(Event.self)>",
         target: DispatchQueue.global())
     private var reducer: Reducer
 #if canImport(Combine)
@@ -37,9 +37,7 @@ class StateMachine<State, Event> {
 
     func process(_ event: Event) {
         queue.sync {
-            log.info("Processing event \(event) for current state \(self.state)")
             let newState = self.reducer(self.state, event)
-            log.info("New state: \(newState)")
             self.state = newState
         }
     }