[MOB-10616] Improve Criteria Update Frequency (#886)

Author: joaodordio

swift-sdk.xcodeproj/project.pbxproj

@@ -12,6 +12,7 @@
 		00B6FAD1210E8D90007535CF /* dev-1.mobileprovision in Resources */ = {isa = PBXBuildFile; fileRef = 00B6FAD0210E8D90007535CF /* dev-1.mobileprovision */; };
 		00CB31B621096129004ACDEC /* TestUtils.swift in Sources */ = {isa = PBXBuildFile; fileRef = 00CB31B4210960C4004ACDEC /* TestUtils.swift */; };
 		092D01942D3038F600E3066A /* NotificationObserverTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 092D01932D3038F600E3066A /* NotificationObserverTests.swift */; };
+		09CAA47B2D4B9AD80057FB72 /* IterableApiCriteriaFetchTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 09CAA47A2D4B9AD80057FB72 /* IterableApiCriteriaFetchTests.swift */; };
 		1802C00F2CA2C99E009DEA2B /* CombinationComplexCriteria.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1802C00E2CA2C99E009DEA2B /* CombinationComplexCriteria.swift */; };
 		181063DB2C9841460078E0ED /* CustomEventUserUpdateTestCaseTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 181063DA2C9841460078E0ED /* CustomEventUserUpdateTestCaseTests.swift */; };
 		181063DD2C994FA40078E0ED /* ValidateCustomEventUserUpdateAPITest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 181063DC2C994FA40078E0ED /* ValidateCustomEventUserUpdateAPITest.swift */; };
@@ -575,6 +576,7 @@
 		00B6FAD0210E8D90007535CF /* dev-1.mobileprovision */ = {isa = PBXFileReference; lastKnownFileType = file; path = "dev-1.mobileprovision"; sourceTree = "<group>"; };
 		00CB31B4210960C4004ACDEC /* TestUtils.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestUtils.swift; sourceTree = "<group>"; };
 		092D01932D3038F600E3066A /* NotificationObserverTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationObserverTests.swift; sourceTree = "<group>"; };
+		09CAA47A2D4B9AD80057FB72 /* IterableApiCriteriaFetchTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IterableApiCriteriaFetchTests.swift; sourceTree = "<group>"; };
 		1802C00E2CA2C99E009DEA2B /* CombinationComplexCriteria.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CombinationComplexCriteria.swift; sourceTree = "<group>"; };
 		181063DA2C9841460078E0ED /* CustomEventUserUpdateTestCaseTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomEventUserUpdateTestCaseTests.swift; sourceTree = "<group>"; };
 		181063DC2C994FA40078E0ED /* ValidateCustomEventUserUpdateAPITest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ValidateCustomEventUserUpdateAPITest.swift; sourceTree = "<group>"; };
@@ -1705,6 +1707,7 @@
 		E9EA7CA52C1EE39A00A9D6FB /* anonymous-tracking-tests */ = {
 			isa = PBXGroup;
 			children = (
+				09CAA47A2D4B9AD80057FB72 /* IterableApiCriteriaFetchTests.swift */,
 				E9EA7CA62C1EE3BA00A9D6FB /* AnonymousUserCriteriaMatchTests.swift */,
 				DF97D12A2C2D4A060034D38C /* AnonymousUserCriteriaIsSetTests.swift */,
 				DF7302142C2C176E0002633A /* AnonymousUserComplexCriteriaMatchTests.swift */,
@@ -2371,6 +2374,7 @@
 				DF7302152C2C176E0002633A /* AnonymousUserComplexCriteriaMatchTests.swift in Sources */,
 				18BB8B7A2C64DC8D007EBF23 /* ComparatorTypeDoesNotEqualMatchTest.swift in Sources */,
 				00B6FACC210E8484007535CF /* APNSTypeCheckerTests.swift in Sources */,
+				09CAA47B2D4B9AD80057FB72 /* IterableApiCriteriaFetchTests.swift in Sources */,
 				AC8F35A2239806B500302994 /* InboxViewControllerViewModelTests.swift in Sources */,
 				092D01942D3038F600E3066A /* NotificationObserverTests.swift in Sources */,
 				AC995F9A2166EEB50099A184 /* CommonMocks.swift in Sources */,

swift-sdk/Core/Constants.swift

@@ -26,6 +26,7 @@ enum Const {
     static let deepLinkRegex = "/a/[a-zA-Z0-9]+"
     static let href = "href"
     static let exponentialFactor = 2.0
+    static let criteriaFetchingCooldown = 120.0 // 120 seconds = 120,000 milliseconds
 
     enum Http {
         static let GET = "GET"

swift-sdk/Internal/AnonymousUserManager.swift

@@ -27,6 +27,7 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
     private let dateProvider: DateProviderProtocol
     private let notificationStateProvider: NotificationStateProviderProtocol
     private var config: IterableConfig
+    private(set) var lastCriteriaFetch: Double = 0
 
     // Tracks an anonymous event and store it locally
     public func trackAnonEvent(name: String, dataFields: [AnyHashable: Any]?) {
@@ -85,38 +86,6 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
         }
     }
 
-    // Creates a user after criterias met and login the user and then sync the data through track APIs
-    private func createAnonymousUser(_ criteriaId: String) {
-        var anonSessions = convertToDictionary(data: localStorage.anonymousSessions?.itbl_anon_sessions)
-        let userId = IterableUtil.generateUUID()
-        anonSessions[JsonKey.matchedCriteriaId] = Int(criteriaId)
-        let appName = Bundle.main.appPackageName ?? ""
-        notificationStateProvider.isNotificationsEnabled { isEnabled in
-            if !appName.isEmpty && isEnabled {
-                anonSessions[JsonKey.mobilePushOptIn] = appName
-            }
-           
-            //track anon session for new user
-            IterableAPI.implementation?.apiClient.trackAnonSession(
-                createdAt: IterableUtil.secondsFromEpoch(for: self.dateProvider.currentDate),
-                withUserId: userId,
-                dataFields: self.localStorage.anonymousUserUpdate,
-                requestJson: anonSessions
-            ).onError { error in
-                if error.httpStatusCode == 409 {
-                    self.getAnonCriteria() // refetch the criteria
-                }
-            }.onSuccess { success in
-                self.localStorage.userIdAnnon = userId
-                self.config.anonUserDelegate?.onAnonUserCreated(userId: userId)
-                
-                IterableAPI.implementation?.setUserId(userId, isAnon: true)
-                
-                self.syncNonSyncedEvents()
-            }
-        }
-    }
-    
     // Syncs unsynced data which might have failed to sync when calling syncEvents for the first time after criterias met
     public func syncNonSyncedEvents() {
         DispatchQueue.main.asyncAfter(deadline: .now() + 2) { // little delay necessary in case it takes time to store userIdAnon in localstorage
@@ -174,6 +143,57 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
         localStorage.anonymousSessions = nil
         localStorage.anonymousUserUpdate = nil
     }
+    
+    // Gets the anonymous criteria
+    public func getAnonCriteria() {
+        lastCriteriaFetch = Date().timeIntervalSince1970 * 1000
+        
+        IterableAPI.implementation?.getCriteriaData { returnedData in
+            self.localStorage.criteriaData = returnedData
+        };
+    }
+    
+    // Gets the last criteria fetch time in milliseconds
+    public func getLastCriteriaFetch() -> Double {
+        return lastCriteriaFetch
+    }
+    
+    // Sets the last criteria fetch time in milliseconds
+    public func updateLastCriteriaFetch(currentTime: Double) {
+        lastCriteriaFetch = currentTime
+    }
+    
+    // Creates a user after criterias met and login the user and then sync the data through track APIs
+    private func createAnonymousUser(_ criteriaId: String) {
+        var anonSessions = convertToDictionary(data: localStorage.anonymousSessions?.itbl_anon_sessions)
+        let userId = IterableUtil.generateUUID()
+        anonSessions[JsonKey.matchedCriteriaId] = Int(criteriaId)
+        let appName = Bundle.main.appPackageName ?? ""
+        notificationStateProvider.isNotificationsEnabled { isEnabled in
+            if !appName.isEmpty && isEnabled {
+                anonSessions[JsonKey.mobilePushOptIn] = appName
+            }
+           
+            //track anon session for new user
+            IterableAPI.implementation?.apiClient.trackAnonSession(
+                createdAt: IterableUtil.secondsFromEpoch(for: self.dateProvider.currentDate),
+                withUserId: userId,
+                dataFields: self.localStorage.anonymousUserUpdate,
+                requestJson: anonSessions
+            ).onError { error in
+                if error.httpStatusCode == 409 {
+                    self.getAnonCriteria() // refetch the criteria
+                }
+            }.onSuccess { success in
+                self.localStorage.userIdAnnon = userId
+                self.config.anonUserDelegate?.onAnonUserCreated(userId: userId)
+                
+                IterableAPI.implementation?.setUserId(userId, isAnon: true)
+                
+                self.syncNonSyncedEvents()
+            }
+        }
+    }
 
     // Checks if criterias are being met and returns criteriaId if it matches the criteria.
     private func evaluateCriteriaAndReturnID() -> String? {
@@ -194,13 +214,6 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
         return CriteriaCompletionChecker(anonymousCriteria: criteriaData, anonymousEvents: events).getMatchedCriteria()
     }
 
-    // Gets the anonymous criteria
-    public func getAnonCriteria() {
-        IterableAPI.implementation?.getCriteriaData { returnedData in
-            self.localStorage.criteriaData = returnedData
-        };
-    }
-    
     // Stores event data locally
     private func storeEventData(type: String, data: [AnyHashable: Any], shouldOverWrite: Bool = false) {
         // Early return if no AUT consent was given

swift-sdk/Internal/AnonymousUserManagerProtocol.swift

@@ -12,6 +12,8 @@ import Foundation
     func trackAnonTokenRegistration(token: String)
     func trackAnonUpdateUser(_ dataFields: [AnyHashable: Any])
     func updateAnonSession()
+    func getLastCriteriaFetch() -> Double
+    func updateLastCriteriaFetch(currentTime: Double)
     func getAnonCriteria()
     func syncEvents()
     func clearVisitorEventsAndUserData()

swift-sdk/Internal/InternalIterableAPI.swift

@@ -720,7 +720,7 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     }
 
 
-    func isSDKInitialized() -> Bool {
+    public func isSDKInitialized() -> Bool {
         let isInitialized = !apiKey.isEmpty && isEitherUserIdOrEmailSet()
 
         if !isInitialized {
@@ -734,6 +734,10 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
         IterableUtil.isNotNullOrEmpty(string: _email) || IterableUtil.isNotNullOrEmpty(string: _userId)
     }
 
+    public func noUserLoggedIn() -> Bool {
+        IterableUtil.isNullOrEmpty(string: _email) && IterableUtil.isNullOrEmpty(string: _userId)
+    }
+    
     public func isAnonUserSet() -> Bool {
         IterableUtil.isNotNullOrEmpty(string: localStorage.userIdAnnon)
     }
@@ -904,6 +908,11 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     }
 
     @objc private func onAppDidBecomeActiveNotification(notification: Notification) {
+        handlePushNotificationState()
+        handleMatchingCriteriaState()
+    }
+    
+    private func handlePushNotificationState() {
         guard config.autoPushRegistration else { return }
 
         notificationStateProvider.isNotificationsEnabled { [weak self] systemEnabled in
@@ -928,6 +937,24 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
         }
     }
 
+    private func handleMatchingCriteriaState() {
+        guard config.enableForegroundCriteriaFetch else { return }
+        
+        let currentTime = Date().timeIntervalSince1970 * 1000  // Convert to milliseconds
+        
+        // fetching anonymous user criteria on foregrounding
+        if noUserLoggedIn()
+            && !isAnonUserSet()
+            && config.enableAnonActivation
+            && getVisitorUsageTracked()
+            && (currentTime - anonymousUserManager.getLastCriteriaFetch() >= Const.criteriaFetchingCooldown) {
+            
+            anonymousUserManager.updateLastCriteriaFetch(currentTime: currentTime)
+            anonymousUserManager.getAnonCriteria()
+            ITBInfo("Fetching anonymous user criteria - Foreground")
+        }
+    }
+    
     private func handle(launchOptions: [UIApplication.LaunchOptionsKey: Any]?) {
         guard let launchOptions = launchOptions else {
             return

swift-sdk/SDK/IterableConfig.swift

@@ -153,6 +153,11 @@ public class IterableConfig: NSObject {
 
     /// When set to `true`, IterableSDK will track all events when users are not logged into the application.
     public var enableAnonActivation = true
+    
+    /// Enables fetching of anonymous user criteria on foreground when set to `true`
+    /// By default, the SDK will fetch anonymous user criteria on foreground.
+    public var enableForegroundCriteriaFetch = true
+    
     /// Allows for fetching embedded messages.
     public var enableEmbeddedMessaging = false
 

tests/unit-tests/IterableApiCriteriaFetchTests.swift

@@ -0,0 +1,159 @@
+//
+//  IterableApiCriteriaFetchTests.swift
+//  swift-sdk
+//
+//  Created by Joao Dordio on 30/01/2025.
+//  Copyright © 2025 Iterable. All rights reserved.
+//
+
+import XCTest
+
+@testable import IterableSDK
+
+class IterableApiCriteriaFetchTests: XCTestCase {
+    private var mockNetworkSession: MockNetworkSession!
+    private var mockDateProvider: MockDateProvider!
+    private var mockNotificationCenter: MockNotificationCenter!
+    private var internalApi: InternalIterableAPI!
+    private var mockApplicationStateProvider: MockApplicationStateProvider!
+    private static let apiKey = "zeeApiKey"
+    let localStorage = MockLocalStorage()
+    
+    override func setUp() {
+        super.setUp()
+        mockNetworkSession = MockNetworkSession()
+        mockDateProvider = MockDateProvider()
+        mockNotificationCenter = MockNotificationCenter()
+        mockApplicationStateProvider = MockApplicationStateProvider(applicationState: .active)
+    }
+    
+    override func tearDown() {
+        mockNetworkSession = nil
+        mockDateProvider = nil
+        mockNotificationCenter = nil
+        internalApi = nil
+        mockApplicationStateProvider = nil
+        super.tearDown()
+    }
+    
+    func testForegroundCriteriaFetchWhenConditionsMet() {
+        let expectation1 = expectation(description: "First criteria fetch")
+        expectation1.expectedFulfillmentCount = 2
+        
+        mockNetworkSession.responseCallback = { urlRequest in
+            if urlRequest.absoluteString.contains(Const.Path.getCriteria) == true {
+                expectation1.fulfill()
+            }
+            return nil
+        }
+        
+        let config = IterableConfig()
+        config.enableAnonActivation = true
+        config.enableOnForegroundCriteriaFetching = true
+        
+        IterableAPI.initializeForTesting(apiKey: IterableApiCriteriaFetchTests.apiKey,
+                                         config: config,
+                                         networkSession: mockNetworkSession,
+                                         localStorage: localStorage)
+        
+        internalApi = InternalIterableAPI.initializeForTesting(
+            config: config,
+            dateProvider: mockDateProvider,
+            networkSession: mockNetworkSession,
+            applicationStateProvider: mockApplicationStateProvider,
+            notificationCenter: mockNotificationCenter
+        )
+        
+        internalApi.setVisitorUsageTracked(isVisitorUsageTracked: true)
+        sleep(5)
+        // Simulate app coming to foreground
+        mockNotificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil, userInfo: nil)
+        
+        wait(for: [expectation1], timeout: testExpectationTimeout)
+    }
+    
+    func testCriteriaFetchNotCalledWhenDisabled() {
+        let expectation1 = expectation(description: "No criteria fetch")
+        expectation1.isInverted = true
+        
+        mockNetworkSession.responseCallback = { urlRequest in
+            if urlRequest.absoluteString.contains(Const.Path.getCriteria) == true {
+                expectation1.fulfill()
+            }
+            return nil
+        }
+        
+        let config = IterableConfig()
+        config.enableAnonActivation = true
+        config.enableOnForegroundCriteriaFetching = false
+        
+        internalApi = InternalIterableAPI.initializeForTesting(
+            config: config,
+            dateProvider: mockDateProvider,
+            networkSession: mockNetworkSession,
+            applicationStateProvider: mockApplicationStateProvider,
+            notificationCenter: mockNotificationCenter
+        )
+        internalApi.setVisitorUsageTracked(isVisitorUsageTracked: true)
+        
+        // Simulate app coming to foreground
+        mockNotificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil, userInfo: nil)
+        
+        wait(for: [expectation1], timeout: testExpectationTimeout)
+    }
+    
+    func testForegroundCriteriaFetchWithCooldown() {
+        let expectation1 = expectation(description: "First criteria fetch")
+        let expectation2 = expectation(description: "Second criteria fetch")
+        let expectation3 = expectation(description: "No third fetch during cooldown")
+        expectation3.isInverted = true
+        
+        var fetchCount = 0
+        mockNetworkSession.responseCallback = { urlRequest in
+            if urlRequest.absoluteString.contains(Const.Path.getCriteria) == true {
+                fetchCount += 1
+                switch fetchCount {
+                case 1: expectation1.fulfill()
+                case 2: expectation2.fulfill()
+                case 3: expectation3.fulfill()
+                default: break
+                }
+            }
+            return nil
+        }
+        
+        let config = IterableConfig()
+        config.enableAnonActivation = true
+        config.enableOnForegroundCriteriaFetching = true
+        
+        IterableAPI.initializeForTesting(apiKey: IterableApiCriteriaFetchTests.apiKey,
+                                         config: config,
+                                         networkSession: mockNetworkSession,
+                                         localStorage: localStorage)
+
+        internalApi = InternalIterableAPI.initializeForTesting(
+            config: config,
+            dateProvider: mockDateProvider,
+            networkSession: mockNetworkSession,
+            applicationStateProvider: mockApplicationStateProvider,
+            notificationCenter: mockNotificationCenter
+        )
+        
+        internalApi.setVisitorUsageTracked(isVisitorUsageTracked: true)
+        
+        sleep(5)
+        
+        // First foreground
+        mockNotificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil, userInfo: nil)
+        
+        // Second foreground after some time
+        mockDateProvider.currentDate = mockDateProvider.currentDate.addingTimeInterval(130) // After cooldown
+        mockNotificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil, userInfo: nil)
+        
+        // Third foreground during cooldown
+        mockDateProvider.currentDate = mockDateProvider.currentDate.addingTimeInterval(10) // Within cooldown
+        mockNotificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil, userInfo: nil)
+        
+        wait(for: [expectation1, expectation2, expectation3], timeout: testExpectationTimeout)
+    }
+}