✨Added consent logging

Author: joaodordio

swift-sdk/Core/Constants.swift

@@ -54,6 +54,7 @@ enum Const {
         static let mergeUser = "users/merge";
         static let getCriteria = "anonymoususer/list";
         static let trackAnonSession = "anonymoususer/events/session";
+        static let trackConsent = "anonymoususer/events/trackConsent";
         static let getEmbeddedMessages = "embedded-messaging/messages"
         static let embeddedMessageReceived = "embedded-messaging/events/received"
         static let embeddedMessageClick = "embedded-messaging/events/click"
@@ -78,6 +79,7 @@ enum Const {
         static let matchedCriteria = "itbl_matched_criteria"
         static let eventList = "itbl_event_list"
         static let anonymousUsageTrack = "itbl_anonymous_usage_track"
+        static let visitorConsentTimestamp = "itbl_visitor_consent_timestamp"
         static let isNotificationsEnabled = "itbl_isNotificationsEnabled"
         static let hasStoredNotificationSetting = "itbl_hasStoredNotificationSetting"
 
@@ -265,7 +267,11 @@ enum JsonKey {
 
     static let frameworkType = "frameworkType"
 
-//    embedded
+// Consent tracking
+    static let consentTimestamp = "consentTimestamp"
+    static let isUserKnown = "isUserKnown"
+    
+    // Embedded Messages
     static let embeddedSessionId = "session"
     static let placementId = "placementId"
     static let embeddedSessionStart = "embeddedSessionStart"

swift-sdk/Internal/AnonymousUserManager.swift

@@ -193,6 +193,9 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
 
                 IterableAPI.implementation?.setUserId(userId, isAnon: true)
 
+                // Send consent data after session creation
+                self.sendConsentAfterCriteriaMatch(userId: userId)
+                
                 self.syncNonSyncedEvents()
             }
         }
@@ -266,4 +269,23 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
 
         localStorage.anonymousUserEvents = eventsDataObjects
     }
+    
+    /// Sends consent data after user meets criteria and anonymous user is created
+    private func sendConsentAfterCriteriaMatch(userId: String) {
+        guard let consentTimestamp = localStorage.visitorConsentTimestamp else {
+            ITBInfo("No consent timestamp found, skipping consent tracking")
+            return
+        }
+        
+        IterableAPI.implementation?.apiClient.trackConsent(
+            consentTimestamp: consentTimestamp,
+            email: nil,
+            userId: userId,
+            isUserKnown: false
+        ).onSuccess { _ in
+            ITBInfo("Consent tracked successfully for criteria match")
+        }.onError { error in
+            ITBError("Failed to track consent for criteria match: \(error)")
+        }
+    }
 }

swift-sdk/Internal/InternalIterableAPI.swift

@@ -161,6 +161,9 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
                     isEmail: true,
                     failureHandler: failureHandler
                 )
+                // Send consent for replay scenario if user didn't meet criteria but had consent
+                self?.sendConsentForReplayScenario(email: email, userId: nil)
+                
                 self?.localStorage.userIdAnnon = nil
             }
         }
@@ -203,6 +206,8 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
                         isEmail: false,
                         failureHandler: failureHandler
                     )
+                    // Send consent for replay scenario if user didn't meet criteria but had consent
+                    self?.sendConsentForReplayScenario(email: nil, userId: userId)
                 }
 
                 if !isAnon {
@@ -238,6 +243,14 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     func setVisitorUsageTracked(isVisitorUsageTracked: Bool) {
         ITBInfo("CONSENT CHANGED - local events cleared")
         self.localStorage.anonymousUsageTrack = isVisitorUsageTracked
+        
+        // Store consent timestamp when consent is given
+        if isVisitorUsageTracked {
+            self.localStorage.visitorConsentTimestamp = Int64(dateProvider.currentDate.timeIntervalSince1970)
+        } else {
+            self.localStorage.visitorConsentTimestamp = nil
+        }
+        
         self.localStorage.anonymousUserEvents = nil
         self.localStorage.anonymousSessions = nil
         self.localStorage.anonymousUserUpdate = nil
@@ -254,6 +267,29 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
         return self.localStorage.anonymousUsageTrack
     }
 
+    /// Sends consent data for replay scenarios when user signs up/in but didn't meet criteria
+    private func sendConsentForReplayScenario(email: String?, userId: String?) {
+        guard let consentTimestamp = localStorage.visitorConsentTimestamp else {
+            return
+        }
+        
+        // Only send consent if we have previous anonymous tracking consent but no anonymous user ID
+        guard localStorage.userIdAnnon == nil && localStorage.anonymousUsageTrack else {
+            return
+        }
+        
+        apiClient.trackConsent(
+            consentTimestamp: consentTimestamp,
+            email: email,
+            userId: userId,
+            isUserKnown: true
+        ).onSuccess { _ in
+            ITBInfo("Consent tracked successfully for replay scenario")
+        }.onError { error in
+            ITBError("Failed to track consent for replay scenario: \(error)")
+        }
+    }
+
     // MARK: - API Request Calls
 
     func register(token: String,

swift-sdk/Internal/IterableUserDefaults.swift

@@ -78,6 +78,14 @@ class IterableUserDefaults {
         }
     }
 
+    var visitorConsentTimestamp: Int64? {
+        get {
+            return int64(withKey: .visitorConsentTimestamp)
+        } set {
+            save(int64: newValue, withKey: .visitorConsentTimestamp)
+        }
+    }
+
     var anonymousUserEvents: [[AnyHashable: Any]]? {
         get {
             return eventData(withKey: .anonymousUserEvents)
@@ -242,6 +250,14 @@ class IterableUserDefaults {
         userDefaults.object(forKey: key.value) as? Data
     }
 
+    private func int64(withKey key: UserDefaultsKey) -> Int64? {
+        userDefaults.object(forKey: key.value) as? Int64
+    }
+
+    private func save(int64: Int64?, withKey key: UserDefaultsKey) {
+        userDefaults.set(int64, forKey: key.value)
+    }
+    
     private static func isExpired(expiration: Date?, currentDate: Date) -> Bool {
         if let expiration = expiration {
             if expiration.timeIntervalSinceReferenceDate > currentDate.timeIntervalSinceReferenceDate {
@@ -326,6 +342,7 @@ class IterableUserDefaults {
         static let criteriaData = UserDefaultsKey(value: Const.UserDefault.criteriaData)
         static let anonymousSessions = UserDefaultsKey(value: Const.UserDefault.anonymousSessions)
         static let anonymousUsageTrack = UserDefaultsKey(value: Const.UserDefault.anonymousUsageTrack)
+        static let visitorConsentTimestamp = UserDefaultsKey(value: Const.UserDefault.visitorConsentTimestamp)
 
         static let isNotificationsEnabled = UserDefaultsKey(value: Const.UserDefault.isNotificationsEnabled)
         static let hasStoredNotificationSetting = UserDefaultsKey(value: Const.UserDefault.hasStoredNotificationSetting)

swift-sdk/Internal/Utilities/LocalStorage.swift

@@ -116,6 +116,14 @@ struct LocalStorage: LocalStorageProtocol {
         }
     }
 
+    var visitorConsentTimestamp: Int64? {
+        get {
+            iterableUserDefaults.visitorConsentTimestamp
+        } set {
+            iterableUserDefaults.visitorConsentTimestamp = newValue
+        }
+    }
+
     var isNotificationsEnabled: Bool {
         get {
             iterableUserDefaults.isNotificationsEnabled

swift-sdk/Internal/Utilities/LocalStorageProtocol.swift

@@ -23,6 +23,8 @@ protocol LocalStorageProtocol {
 
     var anonymousUsageTrack: Bool { get set }
 
+    var visitorConsentTimestamp: Int64? { get set }
+
     var anonymousUserEvents: [[AnyHashable: Any]]? { get set }
 
     var anonymousUserUpdate: [AnyHashable: Any]? { get set }

swift-sdk/Internal/api-client/ApiClient.swift

@@ -292,6 +292,12 @@ extension ApiClient: ApiClientProtocol {
         let result = createRequestCreator().flatMap { $0.createTrackAnonSessionRequest(createdAt: createdAt, withUserId: userId, dataFields: dataFields, requestJson: requestJson) }
         return send(iterableRequestResult: result)
     }
+    
+    func trackConsent(consentTimestamp: Int64, email: String?, userId: String?, isUserKnown: Bool) -> Pending<SendRequestValue, SendRequestError> {
+        let result = createRequestCreator().flatMap { $0.createTrackConsentRequest(consentTimestamp: consentTimestamp, email: email, userId: userId, isUserKnown: isUserKnown) }
+        return send(iterableRequestResult: result)
+    }
+    
     // MARK: - Embedded Messaging
 
     func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError> {

swift-sdk/Internal/api-client/ApiClientProtocol.swift

@@ -57,6 +57,9 @@ protocol ApiClientProtocol: AnyObject {
     func getCriteria() -> Pending<SendRequestValue, SendRequestError>
 
     func trackAnonSession(createdAt: Int, withUserId userId: String, dataFields: [AnyHashable: Any]?, requestJson: [AnyHashable: Any])  -> Pending<SendRequestValue, SendRequestError>
+    
+    func trackConsent(consentTimestamp: Int64, email: String?, userId: String?, isUserKnown: Bool) -> Pending<SendRequestValue, SendRequestError>
+    
     func getEmbeddedMessages() -> Pending<PlacementsPayload, SendRequestError>
 
     @discardableResult func track(embeddedMessageReceived message: IterableEmbeddedMessage) -> Pending<SendRequestValue, SendRequestError>

swift-sdk/Internal/api-client/Request/RequestCreator.swift

@@ -702,6 +702,25 @@ struct RequestCreator {
         return .success(.post(createPostRequest(path: Const.Path.trackAnonSession, body: body)))
     }
 
+    func createTrackConsentRequest(consentTimestamp: Int64, email: String?, userId: String?, isUserKnown: Bool) -> Result<IterableRequest, IterableError> {
+        var body = [AnyHashable: Any]()
+        
+        body.setValue(for: JsonKey.consentTimestamp, value: Int(consentTimestamp))
+        
+        if let email = email {
+            body.setValue(for: JsonKey.email, value: email)
+        }
+        
+        if let userId = userId {
+            body.setValue(for: JsonKey.userId, value: userId)
+        }
+        
+        body.setValue(for: JsonKey.isUserKnown, value: isUserKnown)
+        body.setValue(for: JsonKey.deviceInfo, value: deviceMetadata.asDictionary())
+        
+        return .success(.post(createPostRequest(path: Const.Path.trackConsent, body: body)))
+    }
+    
     // MARK: - PRIVATE
 
     private static let authMissingMessage = "Both email and userId are nil"