feat: support lazy initialization of the SDK (#58)

Co-authored-by: xiaoweii <[email protected]>
awslabs · Mar 22, 2024 · 32f44a8 · 32f44a8
1 parent a850795
commit 32f44a8
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 5 deletions.
diff --git a/.github/workflows/integration_test.yml b/.github/workflows/integration_test.yml
@@ -25,6 +25,7 @@ jobs:
           token: ${{ secrets.PROJECT_TOKEN }}
       - name: Modify SDK for integration test
         run: |
+          sed -i '' -e "s#isLogEvents: Bool = false#isLogEvents: Bool = true#g" Sources/Clickstream/Dependency/Clickstream/ClickstreamContext.swift
           sed -i '' -e "s#private(set) var bundleSequenceId: Int#private(set) var bundleSequenceId: Int\n    var allEventJson: String = \"\"#g" Sources/Clickstream/Dependency/Clickstream/Analytics/EventRecorder.swift
           sed -i '' -e "s#toPrettierJsonString())\")#toPrettierJsonString())\")\n            allEventJson.append(\"Saved event \\\(event.eventType):\\\(eventObject.toJsonString())\\\n\")\n            UIPasteboard.general.string = allEventJson#g" Sources/Clickstream/Dependency/Clickstream/Analytics/EventRecorder.swift
           sed -i '' -e "s#batchEvent.eventCount) events\")#batchEvent.eventCount) events\")\n                allEventJson.append(\"Send \\\(batchEvent.eventCount) events\\\n\")\n                UIPasteboard.general.string = allEventJson#g" Sources/Clickstream/Dependency/Clickstream/Analytics/EventRecorder.swift

diff --git a/Sources/Clickstream/AWSClickstreamPlugin+Configure.swift b/Sources/Clickstream/AWSClickstreamPlugin+Configure.swift
@@ -62,6 +62,7 @@ extension AWSClickstreamPlugin {
             networkMonitor: networkMonitor
         )
         log.debug("initialize Clickstream SDK successful")
+        sessionClient.handleAppStart()
     }
 
     // MARK: Internal

diff --git a/Sources/Clickstream/ClickstreamObjc.swift b/Sources/Clickstream/ClickstreamObjc.swift
@@ -30,6 +30,15 @@ import Foundation
     /// - Parameters:
     ///   - eventName: the event name
     ///   - attributes: the event attributes which type is NSDictionary
+    public static func recordEvent(_ eventName: String, _ attributes: NSDictionary) {
+        ClickstreamAnalytics.recordEvent(eventName, getAttributes(attributes))
+    }
+
+    /// The method to record event with attributes and items
+    /// - Parameters:
+    ///   - eventName: the event name
+    ///   - attributes: the event attributes which type is NSDictionary
+    ///   - items: the event items which type is NSDictionary
     public static func recordEvent(_ eventName: String, _ attributes: NSDictionary, _ items: [NSDictionary] = []) {
         ClickstreamAnalytics.recordEvent(eventName, getAttributes(attributes), getItems(items))
     }

diff --git a/Sources/Clickstream/Dependency/Clickstream/AutoRecord/AutoRecordEventClient.swift b/Sources/Clickstream/Dependency/Clickstream/AutoRecord/AutoRecordEventClient.swift
@@ -15,6 +15,7 @@ class AutoRecordEventClient {
     private var isEntrances = false
     private var isFirstOpen: Bool
     private var isFirstTime = true
+    private var isAppEndCalled = false
     private var lastEngageTime: Int64 = 0
     private(set) var lastScreenName: String?
     private var lastScreenPath: String?
@@ -190,15 +191,18 @@ class AutoRecordEventClient {
     }
 
     func handleAppStart() {
-        let event = clickstream.analyticsClient.createEvent(withEventType: Event.PresetEvent.APP_START)
-        event.addAttribute(isFirstTime, forKey: Event.ReservedAttribute.IS_FIRST_TIME)
-        recordEvent(event)
+        if isFirstTime || isAppEndCalled {
+            let event = clickstream.analyticsClient.createEvent(withEventType: Event.PresetEvent.APP_START)
+            event.addAttribute(isFirstTime, forKey: Event.ReservedAttribute.IS_FIRST_TIME)
+            recordEvent(event)
+        }
         isFirstTime = false
     }
 
     func recordAppEnd() {
         let event = clickstream.analyticsClient.createEvent(withEventType: Event.PresetEvent.APP_END)
         recordEvent(event)
+        isAppEndCalled = true
     }
 
     func recordSessionStartEvent() {

diff --git a/Sources/Clickstream/Dependency/Clickstream/Session/SessionClient.swift b/Sources/Clickstream/Dependency/Clickstream/Session/SessionClient.swift
@@ -38,6 +38,12 @@ class SessionClient: SessionClientBehaviour {
         }
     }
 
+    func handleAppStart() {
+        autoRecordClient.handleFirstOpen()
+        autoRecordClient.handleAppStart()
+        handleSesionStart()
+    }
+
     func storeSession() {
         session.pause()
         UserDefaultsUtil.saveSession(storage: clickstream.storage, session: session)

diff --git a/Tests/ClickstreamTests/Clickstream/SessionClientTests.swift b/Tests/ClickstreamTests/Clickstream/SessionClientTests.swift
@@ -74,6 +74,23 @@ class SessionClientTests: XCTestCase {
         XCTAssertEqual(Event.PresetEvent.SESSION_START, events[2].eventType)
     }
 
+    func testRunningInForegroundAfterHandleAppStart() {
+        sessionClient.handleAppStart()
+        activityTracker.callback?(.runningInForeground)
+        let session = sessionClient.getCurrentSession()
+        XCTAssertTrue(session.isNewSession)
+        XCTAssertTrue(session.sessionIndex == 1)
+        XCTAssertNotNil(session.sessionId)
+        XCTAssertNotNil(session.startTime)
+
+        Thread.sleep(forTimeInterval: 0.1)
+        let events = eventRecorder.savedEvents
+        XCTAssertEqual(3, events.count)
+        XCTAssertEqual(Event.PresetEvent.FIRST_OPEN, events[0].eventType)
+        XCTAssertEqual(Event.PresetEvent.APP_START, events[1].eventType)
+        XCTAssertEqual(Event.PresetEvent.SESSION_START, events[2].eventType)
+    }
+
     func testGoBackground() {
         activityTracker.callback?(.runningInForeground)
         Thread.sleep(forTimeInterval: 0.1)

diff --git a/Tests/ClickstreamTests/IntegrationTest.swift b/Tests/ClickstreamTests/IntegrationTest.swift
@@ -51,6 +51,9 @@ class IntegrationTest: XCTestCase {
         } catch {
             XCTFail("Error setting up Amplify: \(error)")
         }
+        let eventCount = try eventRecorder.dbUtil.getEventCount()
+        XCTAssertEqual(3, eventCount)
+        try eventRecorder.dbUtil.deleteAllEvents()
     }
 
     override func tearDown() async throws {
@@ -108,7 +111,7 @@ class IntegrationTest: XCTestCase {
         let attributes = event["attributes"] as! [String: Any]
         XCTAssertEqual("HomeView", attributes[ClickstreamAnalytics.Attr.SCREEN_NAME] as! String)
         XCTAssertEqual("23ac31df", attributes[ClickstreamAnalytics.Attr.SCREEN_UNIQUE_ID] as! String)
-        XCTAssertEqual(0, attributes[Event.ReservedAttribute.ENTRANCES] as! Int)
+        XCTAssertEqual(1, attributes[Event.ReservedAttribute.ENTRANCES] as! Int)
     }
 
     func testFlushEvents() throws {
@@ -351,7 +354,7 @@ class IntegrationTest: XCTestCase {
         let attributes = event["attributes"] as! [String: Any]
         XCTAssertEqual("HomeView", attributes[ClickstreamAnalytics.Attr.SCREEN_NAME] as! String)
         XCTAssertEqual("23ac31df", attributes[ClickstreamAnalytics.Attr.SCREEN_UNIQUE_ID] as! String)
-        XCTAssertEqual(0, attributes[Event.ReservedAttribute.ENTRANCES] as! Int)
+        XCTAssertEqual(1, attributes[Event.ReservedAttribute.ENTRANCES] as! Int)
     }
 
     func testGlobalAttributeForObjc() throws {