Merge pull request #916 from snowplow/release/6.2.0

matus-tomlein · web-flow · commit 3872d6f2e088 · 2025-02-13T11:30:26.000+01:00
Release/6.2.0
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -24,33 +24,33 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - name: "Integration (iOS, Xcode 13.4)"
-            os: macos-12
-            xcode-version: 13.4
-            destination: "platform=iOS Simulator,name=iPhone 13"
+          - name: "Integration (iOS, Xcode 14.1)"
+            os: macos-13
+            xcode-version: 14.1
+            destination: "platform=iOS Simulator,name=iPhone 14"
             target: IntegrationTests
 
-          - name: "Unit (iOS, Xcode 13.4)"
-            os: macos-12
-            xcode-version: 13.4
-            destination: "platform=iOS Simulator,name=iPhone 13"
+          - name: "Unit (iOS, Xcode 14.1)"
+            os: macos-13
+            xcode-version: 14.1
+            destination: "platform=iOS Simulator,name=iPhone 14"
             target: Tests
 
-          - name: "Unit (macOS, Xcode 13.4)"
-            os: macos-12
-            xcode-version: 13.4
+          - name: "Unit (macOS, Xcode 14.1)"
+            os: macos-13
+            xcode-version: 14.1
             destination: "platform=macOS"
             target: Tests
 
-          - name: "Unit (watchOS, Xcode 13.4)"
-            os: macos-12
-            xcode-version: 13.4
-            destination: "platform=watchOS Simulator,name=Apple Watch Series 7 - 45mm"
+          - name: "Unit (watchOS, Xcode 14.1)"
+            os: macos-13
+            xcode-version: 14.1
+            destination: "platform=watchOS Simulator,name=Apple Watch Series 8 (45mm)"
             target: Tests
 
-          - name: "Unit (tvOS, Xcode 13.4)"
-            os: macos-12
-            xcode-version: 13.4
+          - name: "Unit (tvOS, Xcode 14.1)"
+            os: macos-13
+            xcode-version: 14.1
             destination: "platform=tvOS Simulator,name=Apple TV"
             target: Tests
 
@@ -90,16 +90,8 @@ jobs:
             -scheme SnowplowTracker \
             -destination "${{ matrix.destination }}" \
             -only-testing ${{ matrix.target }} \
-            -resultBundlePath TestResults \
             clean test | xcpretty
 
-      - name: Create test results
-        uses: kishikawakatsumi/xcresulttool@v1
-        with:
-          path: TestResults.xcresult
-          title: "Test results: ${{ matrix.name }}"
-        if: success() || failure()
-
   build_objc_demo_app:
     name: "ObjC demo (iOS ${{ matrix.version.ios }})"
     needs: test_framework
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,8 @@
+Version 6.2.0 (2025-02-11)
+--------------------------
+Add an option to continue previously persisted session when the app restarts rather than starting a new one (#912)
+Make SelfDescribingJson class open to allow for inheritance (#906) thanks to @TwoDollarsEsq
+
 Version 6.1.0 (2025-01-16)
 --------------------------
 Add new WebView interface (#913)
diff --git a/Examples b/Examples
@@ -1 +1 @@
-Subproject commit cc2de41856454face374a74fa6b47b7e49c46943
+Subproject commit 0df808785ee9111a84777549d78ec78689473784
diff --git a/SnowplowTracker.podspec b/SnowplowTracker.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name             = "SnowplowTracker"
-    s.version          = "6.1.0"
+    s.version          = "6.2.0"
     s.summary          = "Snowplow event tracker for iOS, macOS, tvOS, watchOS for apps and games."
     s.description      = <<-DESC
     Snowplow is a mobile and event analytics platform with a difference: rather than tell our users how they should analyze their data, we deliver their event-level data in their own data warehouse, on their own Amazon Redshift or Postgres database, so they can analyze it any way they choose. Snowplow mobile is used by data-savvy games companies and app developers to better understand their users and how they engage with their games and applications. Snowplow is open source using the business-friendly Apache License, Version 2.0 and scales horizontally to many billions of events.
diff --git a/Sources/Core/InternalQueue/SessionControllerIQWrapper.swift b/Sources/Core/InternalQueue/SessionControllerIQWrapper.swift
@@ -59,6 +59,11 @@ class SessionControllerIQWrapper: SessionController {
         get { InternalQueue.sync { controller.onSessionStateUpdate } }
         set { InternalQueue.sync { controller.onSessionStateUpdate = newValue } }
     }
+    
+    var continueSessionOnRestart: Bool {
+        get { InternalQueue.sync { controller.continueSessionOnRestart } }
+        set { InternalQueue.sync { controller.continueSessionOnRestart = newValue } }
+    }
 
     var sessionIndex: Int {
         InternalQueue.sync { controller.sessionIndex }
diff --git a/Sources/Core/Session/Session.swift b/Sources/Core/Session/Session.swift
@@ -21,11 +21,8 @@ class Session {
     // MARK: - Private properties
     
     private var dataPersistence: DataPersistence?
-    /// The event index
-    private var eventIndex = 0
     private var isNewSession = true
     private var isSessionCheckerEnabled = false
-    private var lastSessionCheck: NSNumber = Utilities.getTimestamp()
     /// Returns the current session state
     private var state: SessionState?
     /// The current tracker associated with the session
@@ -51,6 +48,8 @@ class Session {
     var sessionId: String? { return state?.sessionId }
     var previousSessionId: String? { return state?.previousSessionId }
     var firstEventId: String? { return state?.firstEventId }
+    /// If enabled, will persist all session updates (also changes to eventIndex) and will be able to continue the previous session when the app is closed and reopened.
+    var continueSessionOnRestart: Bool
     
     // MARK: - Constructor and destructor
 
@@ -59,11 +58,20 @@ class Session {
     ///   - foregroundTimeout: the session timeout while it is in the foreground
     ///   - backgroundTimeout: the session timeout while it is in the background
     ///   - tracker: reference to the associated tracker of the session
+    ///   - continueSessionOnRestart: whether to resume previous persisted session
     /// - Returns: a SnowplowSession
-    init(foregroundTimeout: Int, backgroundTimeout: Int, trackerNamespace: String? = nil, tracker: Tracker? = nil) {
+    init(
+        foregroundTimeout: Int,
+        backgroundTimeout: Int,
+        trackerNamespace: String? = nil,
+        tracker: Tracker? = nil,
+        continueSessionOnRestart: Bool = false
+    ) {
         
         self.foregroundTimeout = foregroundTimeout * 1000
         self.backgroundTimeout = backgroundTimeout * 1000
+        self.continueSessionOnRestart = continueSessionOnRestart
+        self.isNewSession = !continueSessionOnRestart
         self.tracker = tracker
         if let namespace = trackerNamespace {
             dataPersistence = DataPersistence.getFor(namespace: namespace)
@@ -73,7 +81,6 @@ class Session {
         if var storedSessionDict = storedSessionDict {
             storedSessionDict[kSPSessionUserId] = userId
             state = SessionState(storedState: storedSessionDict)
-            dataPersistence?.session = storedSessionDict
         }
         if state == nil {
             logDiagnostic(message: "No previous session info available")
@@ -127,25 +134,27 @@ class Session {
     ///   - firstEventTimestamp: Device created timestamp of the first event of the session
     ///   - userAnonymisation: Whether to anonymise user identifiers
     /// - Returns: a SnowplowPayload containing the session dictionary
-    func getDictWithEventId(_ eventId: String?, eventTimestamp: Int64, userAnonymisation: Bool) -> [String : Any]? {
+    func getAndUpdateSessionForEvent(_ eventId: String?, eventTimestamp: Int64, userAnonymisation: Bool) -> [String : Any]? {
         var context: [String : Any]? = nil
         
         if isSessionCheckerEnabled {
-            if shouldUpdate() {
-                update(eventId: eventId, eventTimestamp: eventTimestamp)
+            if shouldStartNewSession() {
+                startNewSession(eventId: eventId, eventTimestamp: eventTimestamp)
                 if let onSessionStateUpdate = onSessionStateUpdate, let state = state {
                     DispatchQueue.global(qos: .default).async {
                         onSessionStateUpdate(state)
                     }
                 }
+                // only persist session changes
+                if !continueSessionOnRestart { persist() }
             }
-            lastSessionCheck = Utilities.getTimestamp()
         }
         
-        eventIndex += 1
+        state?.updateForNextEvent(isSessionCheckerEnabled: isSessionCheckerEnabled)
+        // persist every session update
+        if continueSessionOnRestart { persist() }
         
         context = state?.sessionContext
-        context?[kSPSessionEventIndex] = NSNumber(value: eventIndex)
 
         if userAnonymisation {
             // mask the user identifier
@@ -180,38 +189,29 @@ class Session {
         return userId
     }
 
-    private func shouldUpdate() -> Bool {
+    private func shouldStartNewSession() -> Bool {
         if isNewSession {
             return true
         }
-        let lastAccess = lastSessionCheck.int64Value
-        let now = Utilities.getTimestamp().int64Value
-        let timeout = inBackground ? backgroundTimeout : foregroundTimeout
-        return now < lastAccess || Int(now - lastAccess) > timeout
+        if let state = state, let lastAccess = state.lastUpdate {
+            let now = Utilities.getTimestamp().int64Value
+            let timeout = inBackground ? backgroundTimeout : foregroundTimeout
+            return now < lastAccess || Int(now - lastAccess) > timeout
+        }
+        return true
     }
 
-    private func update(eventId: String?, eventTimestamp: Int64) {
+    private func startNewSession(eventId: String?, eventTimestamp: Int64) {
         isNewSession = false
-        let sessionIndex = (state?.sessionIndex ?? 0) + 1
-        let eventISOTimestamp = Utilities.timestamp(toISOString: eventTimestamp)
-        state = SessionState(
-            firstEventId: eventId,
-            firstEventTimestamp: eventISOTimestamp,
-            currentSessionId: Utilities.getUUIDString(),
-            previousSessionId: state?.sessionId,
-            sessionIndex: sessionIndex,
-            userId: userId,
-            storage: "LOCAL_STORAGE")
-        var sessionToPersist = state?.sessionContext
-        // Remove previousSessionId if nil because dictionaries with nil values aren't plist serializable
-        // and can't be stored with SPDataPersistence.
-        if state?.previousSessionId == nil {
-            var sessionCopy = sessionToPersist
-            sessionCopy?.removeValue(forKey: kSPSessionPreviousId)
-            sessionToPersist = sessionCopy
+        if let state = state {
+            state.startNewSession(eventId: eventId, eventTimestamp: eventTimestamp)
+        } else {
+            state = SessionState(eventId: eventId, eventTimestamp: eventTimestamp, userId: userId)
         }
-        dataPersistence?.session = sessionToPersist
-        eventIndex = 0
+    }
+    
+    private func persist() {
+        dataPersistence?.session = state?.dataToPersist
     }
     
     // MARK: - background and foreground notifications
diff --git a/Sources/Core/Session/SessionControllerImpl.swift b/Sources/Core/Session/SessionControllerImpl.swift
@@ -87,6 +87,17 @@ class SessionControllerImpl: Controller, SessionController {
             session?.backgroundTimeout = newValue * 1000
         }
     }
+    
+    var continueSessionOnRestart: Bool {
+        get {
+            return session?.continueSessionOnRestart ?? TrackerDefaults.continueSessionOnRestart
+        }
+        set {
+            dirtyConfig.continueSessionOnRestart = newValue
+            session?.continueSessionOnRestart = newValue
+        }
+    }
+    
 
     var onSessionStateUpdate: ((_ sessionState: SessionState) -> Void)? {
         get {
diff --git a/Sources/Core/Tracker/ServiceProvider.swift b/Sources/Core/Tracker/ServiceProvider.swift
@@ -290,6 +290,7 @@ class ServiceProvider: NSObject, ServiceProviderProtocol {
             tracker.sessionContext = trackerConfiguration.sessionContext
             tracker.foregroundTimeout = sessionConfiguration.foregroundTimeoutInSeconds
             tracker.backgroundTimeout = sessionConfiguration.backgroundTimeoutInSeconds
+            tracker.continueSessionOnRestart = sessionConfiguration.continueSessionOnRestart
             tracker.exceptionEvents = trackerConfiguration.exceptionAutotracking
             tracker.subject = subject
             tracker.base64Encoded = trackerConfiguration.base64Encoding
diff --git a/Sources/Core/Tracker/Tracker.swift b/Sources/Core/Tracker/Tracker.swift
@@ -209,6 +209,20 @@ class Tracker: NSObject {
         }
     }
     
+    private var _continueSessionOnRestart = TrackerDefaults.continueSessionOnRestart
+    public var continueSessionOnRestart: Bool {
+        get {
+            return _continueSessionOnRestart
+        }
+        set(continueSessionOnRestart) {
+            _continueSessionOnRestart = continueSessionOnRestart
+            if builderFinished && session != nil {
+                session?.continueSessionOnRestart = continueSessionOnRestart
+            }
+        }
+    }
+
+    
     private var _lifecycleEvents = false
     /// Returns whether lifecyle events is enabled.
     /// - Returns: Whether background and foreground events are sent.
@@ -299,7 +313,9 @@ class Tracker: NSObject {
                 foregroundTimeout: foregroundTimeout,
                 backgroundTimeout: backgroundTimeout,
                 trackerNamespace: trackerNamespace,
-                tracker: self)
+                tracker: self,
+                continueSessionOnRestart: continueSessionOnRestart
+            )
         }
 
         if autotrackScreenViews {
@@ -588,9 +604,9 @@ class Tracker: NSObject {
 
         // Add session
         if let session = session {
-            if let sessionDict = session.getDictWithEventId(event.eventId.uuidString,
-                                                            eventTimestamp: event.timestamp,
-                                                            userAnonymisation: userAnonymisation) {
+            if let sessionDict = session.getAndUpdateSessionForEvent(event.eventId.uuidString,
+                                                                     eventTimestamp: event.timestamp,
+                                                                     userAnonymisation: userAnonymisation) {
                 event.addContextEntity(SelfDescribingJson(schema: kSPSessionContextSchema, andDictionary: sessionDict))
             } else {
                 logDiagnostic(message: String(format: "Unable to get session context for eventId: %@", event.eventId.uuidString))
diff --git a/Sources/Core/Tracker/TrackerDefaults.swift b/Sources/Core/Tracker/TrackerDefaults.swift
@@ -33,4 +33,5 @@ class TrackerDefaults {
     private(set) static var geoLocationContext = false
     private(set) static var screenEngagementAutotracking = true
     private(set) static var immersiveSpaceContext = true
+    private(set) static var continueSessionOnRestart = false
 }
diff --git a/Sources/Core/TrackerConstants.swift b/Sources/Core/TrackerConstants.swift
@@ -14,7 +14,7 @@
 import Foundation
 
 // --- Version
-let kSPRawVersion = "6.1.0"
+let kSPRawVersion = "6.2.0"
 #if os(iOS)
 let kSPVersion = "ios-\(kSPRawVersion)"
 #elseif os(tvOS)
@@ -157,6 +157,7 @@ let kSPSessionFirstEventId = "firstEventId"
 let kSPSessionFirstEventTimestamp = "firstEventTimestamp"
 let kSPSessionEventIndex = "eventIndex"
 let kSPSessionAnonymousUserId = "00000000-0000-0000-0000-000000000000"
+let ksSPSessionLastUpdate = "lastUpdate"
 
 // --- Geo-Location Context
 let kSPGeoLatitude = "latitude"
diff --git a/Sources/Snowplow/Configurations/SessionConfiguration.swift b/Sources/Snowplow/Configurations/SessionConfiguration.swift
@@ -39,6 +39,11 @@ public protocol SessionConfigurationProtocol: AnyObject {
     /// The callback called everytime the session is updated.
     @objc
     var onSessionStateUpdate: ((_ sessionState: SessionState) -> Void)? { get set }
+    /// If enabled, will be able to continue the previous session when the app is closed and reopened (if it doesn't timeout).
+    /// Disabled by default, which means that every restart of the app starts a new session.
+    /// When enabled, every event will result in the session being updated in the UserDefaults.
+    @objc
+    var continueSessionOnRestart: Bool { get set }
 }
 
 /// This class represents the configuration from of the applications session.
@@ -65,18 +70,28 @@ public class SessionConfiguration: SerializableConfiguration, SessionConfigurati
     /// The timeout set for the inactivity of app when in background.
     @objc
     public var backgroundTimeoutInSeconds: Int {
-        get { return _backgroundTimeoutInSeconds ?? sourceConfig?.backgroundTimeoutInSeconds ?? 1800 }
+        get { return _backgroundTimeoutInSeconds ?? sourceConfig?.backgroundTimeoutInSeconds ?? TrackerDefaults.backgroundTimeout }
         set { _backgroundTimeoutInSeconds = newValue }
     }
     
     private var _foregroundTimeoutInSeconds: Int?
     /// The timeout set for the inactivity of app when in foreground.
     @objc
     public var foregroundTimeoutInSeconds: Int {
-        get { return _foregroundTimeoutInSeconds ?? sourceConfig?.foregroundTimeoutInSeconds ?? 1800 }
+        get { return _foregroundTimeoutInSeconds ?? sourceConfig?.foregroundTimeoutInSeconds ?? TrackerDefaults.foregroundTimeout }
         set { _foregroundTimeoutInSeconds = newValue }
     }
     
+    private var _continueSessionOnRestart: Bool?
+    /// If enabled, will be able to continue the previous session when the app is closed and reopened (if it doesn't timeout).
+    /// Disabled by default, which means that every restart of the app starts a new session.
+    /// When enabled, every event will result in the session being updated in the UserDefaults.
+    @objc
+    public var continueSessionOnRestart: Bool {
+        get { return _continueSessionOnRestart ?? sourceConfig?.continueSessionOnRestart ?? TrackerDefaults.continueSessionOnRestart }
+        set { _continueSessionOnRestart = newValue }
+    }
+
     private var _onSessionStateUpdate: ((_ sessionState: SessionState) -> Void)?
     /// The callback called everytime the session is updated.
     @objc
@@ -149,10 +164,20 @@ public class SessionConfiguration: SerializableConfiguration, SessionConfigurati
     // MARK: - Builders
 
     /// The callback called everytime the session is updated.
+    @objc
     public func onSessionStateUpdate(_ value: ((_ sessionState: SessionState) -> Void)?) -> Self {
         onSessionStateUpdate = value
         return self
     }
+    
+    /// If enabled, will be able to continue the previous session when the app is closed and reopened (if it doesn't timeout).
+    /// Disabled by default, which means that every restart of the app starts a new session.
+    /// When enabled, every event will result in the session being updated in the UserDefaults.
+    @objc
+    public func continueSessionOnRestart(_ value: Bool) -> Self {
+        self.continueSessionOnRestart = value
+        return self
+    }
 
     // MARK: - NSCopying
 
diff --git a/Sources/Snowplow/Payload/SelfDescribingJson.swift b/Sources/Snowplow/Payload/SelfDescribingJson.swift
diff --git a/Sources/Snowplow/Tracker/SessionState.swift b/Sources/Snowplow/Tracker/SessionState.swift
diff --git a/Tests/Configurations/TestTrackerConfiguration.swift b/Tests/Configurations/TestTrackerConfiguration.swift
diff --git a/Tests/TestSession.swift b/Tests/TestSession.swift

Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,5 @@ class TrackerDefaults {`
`33`	`33`	`private(set) static var geoLocationContext = false`
`34`	`34`	`private(set) static var screenEngagementAutotracking = true`
`35`	`35`	`private(set) static var immersiveSpaceContext = true`
	`36`	`+ private(set) static var continueSessionOnRestart = false`
`36`	`37`	`}`