Merge pull request #839 from Iterable/feature/MOB-9677-Keep-AUT-off-until-consent-to-track-has-been-granted

evantk91 · web-flow · commit 7b89260a0e18 · 2024-10-10T14:01:14.000-06:00
Keep AUT off until consent to track has been granted
diff --git a/sample-apps/swift-sample-app/swift-sample-app/Base.lproj/Main.storyboard b/sample-apps/swift-sample-app/swift-sample-app/Base.lproj/Main.storyboard
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="22505" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="umW-9Q-hvM">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="32700.99.1234" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="umW-9Q-hvM">
     <device id="retina4_7" orientation="portrait" appearance="light"/>
     <dependencies>
         <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="22504"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="22685"/>
         <capability name="Safe area layout guides" minToolsVersion="9.0"/>
         <capability name="collection view cell content view" minToolsVersion="11.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
@@ -19,7 +19,7 @@
                         <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
                         <color key="tintColor" red="0.31372549020000001" green="0.71372549019999998" blue="0.98823529409999999" alpha="1" colorSpace="calibratedRGB"/>
                         <view key="tableFooterView" contentMode="scaleToFill" id="VEA-om-wVt">
-                            <rect key="frame" x="0.0" y="121.5" width="375" height="44"/>
+                            <rect key="frame" x="0.0" y="165" width="375" height="44"/>
                             <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/>
                             <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
                         </view>
@@ -35,6 +35,14 @@
                                     <segue destination="Ez8-MY-tka" kind="show" identifier="showCoffeeSegue" id="pgY-3d-VNl"/>
                                 </connections>
                             </tableViewCell>
+                            <tableViewCell clipsSubviews="YES" contentMode="scaleToFill" preservesSuperviewLayoutMargins="YES" selectionStyle="default" accessoryType="checkmark" indentationWidth="10" reuseIdentifier="anonymousUsageTrackCell" id="nSd-28-WlN">
+                                <rect key="frame" x="0.0" y="93.5" width="375" height="43.5"/>
+                                <autoresizingMask key="autoresizingMask"/>
+                                <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" preservesSuperviewLayoutMargins="YES" insetsLayoutMarginsFromSafeArea="NO" tableViewCell="nSd-28-WlN" id="4YR-d9-FwM">
+                                    <rect key="frame" x="0.0" y="0.0" width="335" height="43.5"/>
+                                    <autoresizingMask key="autoresizingMask"/>
+                                </tableViewCellContentView>
+                            </tableViewCell>
                         </prototypes>
                         <connections>
                             <outlet property="dataSource" destination="AsM-Cj-iLA" id="zCP-mf-9X0"/>
diff --git a/sample-apps/swift-sample-app/swift-sample-app/CoffeeListTableViewController.swift b/sample-apps/swift-sample-app/swift-sample-app/CoffeeListTableViewController.swift
@@ -60,22 +60,42 @@ class CoffeeListTableViewController: UITableViewController {
     }
     
     // MARK: - TableViewDataSourceDelegate Functions
-    
-    override func tableView(_: UITableView, numberOfRowsInSection _: Int) -> Int {
-        filtering ? filteredCoffees.count : coffees.count
+    override func numberOfSections(in tableView: UITableView) -> Int {
+        return 2
+    }
+    override func tableView(_: UITableView, numberOfRowsInSection section: Int) -> Int {
+        if section == 0 {
+            return 1
+        } else {
+            return filtering ? filteredCoffees.count : coffees.count
+        }
+
     }
-    
     override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
-        let cell = tableView.dequeueReusableCell(withIdentifier: "coffeeCell", for: indexPath)
-        
-        let coffeeList = filtering ? filteredCoffees : coffees
-        let coffee = coffeeList[indexPath.row]
-        cell.textLabel?.text = coffee.name
-        cell.imageView?.image = coffee.image
-        
-        return cell
+        if indexPath.section == 0 {
+            let cell = tableView.dequeueReusableCell(withIdentifier: "anonymousUsageTrackCell", for: indexPath)
+            cell.textLabel?.text = IterableAPI.getAnonymousUsageTracked() ? "Tap to enable Anonymous Usage Track" : "Tap to disable Anonymous Usage Track"
+            cell.textLabel?.numberOfLines = 0
+            cell.accessoryType = IterableAPI.getAnonymousUsageTracked() ? .checkmark : .none
+            return cell
+        } else {
+            let cell = tableView.dequeueReusableCell(withIdentifier: "coffeeCell", for: indexPath)
+            let coffeeList = filtering ? filteredCoffees : coffees
+            let coffee = coffeeList[indexPath.row]
+            cell.textLabel?.text = coffee.name
+            cell.imageView?.image = coffee.image
+            return cell
+        }
     }
-    
+
+    override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
+        if indexPath.section == 0 {
+            let permissionToTrack = IterableAPI.getAnonymousUsageTracked()
+            IterableAPI.setAnonymousUsageTracked(isAnonymousUsageTracked: !permissionToTrack)
+            self.tableView.reloadData()
+        }
+    }
+
     // MARK: Tap Handlers
     
     @IBAction func loginOutBarButtonTapped(_: UIBarButtonItem) {
@@ -93,7 +113,7 @@ class CoffeeListTableViewController: UITableViewController {
     // MARK: - Navigation
     
     override func prepare(for segue: UIStoryboardSegue, sender _: Any?) {
-        guard let indexPath = tableView.indexPathForSelectedRow else {
+        guard let indexPath = tableView.indexPathForSelectedRow, indexPath.section == 1 else {
             return
         }
         
diff --git a/swift-sdk/Constants.swift b/swift-sdk/Constants.swift
@@ -75,7 +75,7 @@ enum Const {
         static let anonymousSessions = "itbl_anon_sessions"
         static let matchedCriteria = "itbl_matched_criteria"
         static let eventList = "itbl_event_list"
-
+        static let anonymousUsageTrack = "itbl_anonymous_usage_track"
         static let attributionInfoExpiration = 24
     }
     
diff --git a/swift-sdk/Internal/AnonymousUserManager.swift b/swift-sdk/Internal/AnonymousUserManager.swift
@@ -212,6 +212,10 @@ public class AnonymousUserManager: AnonymousUserManagerProtocol {
     
     // Stores event data locally
     private func storeEventData(type: String, data: [AnyHashable: Any], shouldOverWrite: Bool? = false) {
+        if !self.localStorage.anonymousUsageTrack {
+            return
+        }
+
         let storedData = localStorage.anonymousUserEvents
         var eventsDataObjects: [[AnyHashable: Any]] = []
 
diff --git a/swift-sdk/Internal/InternalIterableAPI.swift b/swift-sdk/Internal/InternalIterableAPI.swift
@@ -217,7 +217,21 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
             }
         }
     }
-    
+
+    func setAnonymousUsageTracked(isAnonymousUsageTracked: Bool) {
+        self.localStorage.anonymousUsageTrack = isAnonymousUsageTracked
+        self.localStorage.anonymousUserEvents = nil
+        self.localStorage.anonymousSessions = nil
+        if isAnonymousUsageTracked {
+            self.anonymousUserManager.getAnonCriteria()
+            self.anonymousUserManager.updateAnonSession()
+        }
+    }
+
+    func getAnonymousUsageTracked() -> Bool {
+        return self.localStorage.anonymousUsageTrack
+    }
+
     // MARK: - API Request Calls
     
     func register(token: Data,
diff --git a/swift-sdk/Internal/IterableUserDefaults.swift b/swift-sdk/Internal/IterableUserDefaults.swift
@@ -9,7 +9,7 @@ class IterableUserDefaults {
     init(userDefaults: UserDefaults = UserDefaults.standard) {
         self.userDefaults = userDefaults
     }
-    
+
     // migrated to IterableKeychain
     var userId: String? {
         get {
@@ -18,7 +18,7 @@ class IterableUserDefaults {
             save(string: newValue, withKey: .userId)
         }
     }
-    
+
     // migrated to IterableKeychain
     var email: String? {
         get {
@@ -27,7 +27,7 @@ class IterableUserDefaults {
             save(string: newValue, withKey: .email)
         }
     }
-    
+
     // migrated to IterableKeychain
     var authToken: String? {
         get {
@@ -36,7 +36,7 @@ class IterableUserDefaults {
             save(string: newValue, withKey: .authToken)
         }
     }
-    
+
     // deprecated, not in use anymore
     var ddlChecked: Bool {
         get {
@@ -45,31 +45,39 @@ class IterableUserDefaults {
             save(bool: newValue, withKey: .ddlChecked)
         }
     }
-    
+
     var deviceId: String? {
         get {
             string(withKey: .deviceId)
         } set {
             save(string: newValue, withKey: .deviceId)
         }
     }
-    
+
     var sdkVersion: String? {
         get {
             string(withKey: .sdkVersion)
         } set {
             save(string: newValue, withKey: .sdkVersion)
         }
     }
-    
+
     var offlineMode: Bool {
         get {
             return bool(withKey: .offlineMode)
         } set {
             save(bool: newValue, withKey: .offlineMode)
         }
     }
-    
+
+    var anonymousUsageTrack: Bool {
+        get {
+            return bool(withKey: .anonymousUsageTrack)
+        } set {
+            save(bool: newValue, withKey: .anonymousUsageTrack)
+        }
+    }
+
     var anonymousUserEvents: [[AnyHashable: Any]]? {
         get {
             return eventData(withKey: .anonymousUserEvents)
@@ -284,6 +292,8 @@ class IterableUserDefaults {
         static let anonymousUserEvents = UserDefaultsKey(value: Const.UserDefault.offlineMode)
         static let criteriaData = UserDefaultsKey(value: Const.UserDefault.criteriaData)
         static let anonymousSessions = UserDefaultsKey(value: Const.UserDefault.anonymousSessions)
+        static let anonymousUsageTrack = UserDefaultsKey(value: Const.UserDefault.anonymousUsageTrack)
+
     }
     private struct Envelope: Codable {
         let payload: Data
diff --git a/swift-sdk/Internal/LocalStorage.swift b/swift-sdk/Internal/LocalStorage.swift
@@ -5,7 +5,7 @@
 import Foundation
 
 struct LocalStorage: LocalStorageProtocol {
-    
+
     init(userDefaults: UserDefaults = UserDefaults.standard,
          keychain: IterableKeychain = IterableKeychain()) {
         iterableUserDefaults = IterableUserDefaults(userDefaults: userDefaults)
@@ -99,7 +99,15 @@ struct LocalStorage: LocalStorageProtocol {
             iterableUserDefaults.criteriaData = newValue
         }
     }
-    
+
+    var anonymousUsageTrack: Bool {
+        get {
+            iterableUserDefaults.anonymousUsageTrack
+        } set {
+            iterableUserDefaults.anonymousUsageTrack = newValue
+        }
+    }
+
     func getAttributionInfo(currentDate: Date) -> IterableAttributionInfo? {
         iterableUserDefaults.getAttributionInfo(currentDate: currentDate)
     }
diff --git a/swift-sdk/Internal/LocalStorageProtocol.swift b/swift-sdk/Internal/LocalStorageProtocol.swift
@@ -20,7 +20,9 @@ protocol LocalStorageProtocol {
     var sdkVersion: String? { get set }
     
     var offlineMode: Bool { get set }
-    
+
+    var anonymousUsageTrack: Bool { get set }
+
     var anonymousUserEvents: [[AnyHashable: Any]]? { get set }
 
     var criteriaData: Data? { get set }
diff --git a/swift-sdk/IterableAPI.swift b/swift-sdk/IterableAPI.swift
@@ -126,17 +126,21 @@ import UIKit
             callback?(false)
         }
         
-        if(config.enableAnonTracking) {
-            if let _implementation = implementation {
-                // call this to fetch anon criteria from API and save it into userdefaults
-                if(!_implementation.isEitherUserIdOrEmailSet()) {
-                    _implementation.anonymousUserManager.getAnonCriteria()
-                    _implementation.anonymousUserManager.updateAnonSession()
-                }
-            }
+        if let _implementation = implementation, config.enableAnonTracking, !_implementation.isEitherUserIdOrEmailSet(), _implementation.getAnonymousUsageTracked() {
+            _implementation.anonymousUserManager.getAnonCriteria()
+            _implementation.anonymousUserManager.updateAnonSession()
         }
     }
 
+    public static func setAnonymousUsageTracked(isAnonymousUsageTracked: Bool) {
+        if let _implementation = implementation {
+            _implementation.setAnonymousUsageTracked(isAnonymousUsageTracked: isAnonymousUsageTracked)
+        }
+    }
+
+    public static func getAnonymousUsageTracked() -> Bool {
+        return implementation?.getAnonymousUsageTracked() ?? false
+    }
     // MARK: - SDK
     
     public static func setEmail(_ email: String?, _ authToken: String? = nil,  _ identityResolution: IterableIdentityResolution? = nil, _ successHandler: OnSuccessHandler? = nil, _ failureHandler: OnFailureHandler? = nil) {
diff --git a/tests/common/MockLocalStorage.swift b/tests/common/MockLocalStorage.swift
@@ -7,6 +7,7 @@ import Foundation
 @testable import IterableSDK
 
 class MockLocalStorage: LocalStorageProtocol {
+
     var userIdAnnon: String?
     
     var anonymousUserEvents: [[AnyHashable : Any]]?
@@ -28,7 +29,9 @@ class MockLocalStorage: LocalStorageProtocol {
     var sdkVersion: String? = nil
     
     var offlineMode: Bool = false
-    
+
+    var anonymousUsageTrack: Bool = true
+
     func getAttributionInfo(currentDate: Date) -> IterableAttributionInfo? {
         guard !MockLocalStorage.isExpired(expiration: attributionInfoExpiration, currentDate: currentDate) else {
             return nil

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ enum Const {`
`75`	`75`	`static let anonymousSessions = "itbl_anon_sessions"`
`76`	`76`	`static let matchedCriteria = "itbl_matched_criteria"`
`77`	`77`	`static let eventList = "itbl_event_list"`
`78`		`-`
	`78`	`+ static let anonymousUsageTrack = "itbl_anonymous_usage_track"`
`79`	`79`	`static let attributionInfoExpiration = 24`
`80`	`80`	`}`
`81`	`81`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class IterableUserDefaults {`
`9`	`9`	`init(userDefaults: UserDefaults = UserDefaults.standard) {`
`10`	`10`	`self.userDefaults = userDefaults`
`11`	`11`	`}`
`12`		`-`
	`12`	`+`
`13`	`13`	`// migrated to IterableKeychain`
`14`	`14`	`var userId: String? {`
`15`	`15`	`get {`
`@@ -18,7 +18,7 @@ class IterableUserDefaults {`
`18`	`18`	`save(string: newValue, withKey: .userId)`
`19`	`19`	`}`
`20`	`20`	`}`
`21`		`-`
	`21`	`+`
`22`	`22`	`// migrated to IterableKeychain`
`23`	`23`	`var email: String? {`
`24`	`24`	`get {`
`@@ -27,7 +27,7 @@ class IterableUserDefaults {`
`27`	`27`	`save(string: newValue, withKey: .email)`
`28`	`28`	`}`
`29`	`29`	`}`
`30`		`-`
	`30`	`+`
`31`	`31`	`// migrated to IterableKeychain`
`32`	`32`	`var authToken: String? {`
`33`	`33`	`get {`
`@@ -36,7 +36,7 @@ class IterableUserDefaults {`
`36`	`36`	`save(string: newValue, withKey: .authToken)`
`37`	`37`	`}`
`38`	`38`	`}`
`39`		`-`
	`39`	`+`
`40`	`40`	`// deprecated, not in use anymore`
`41`	`41`	`var ddlChecked: Bool {`
`42`	`42`	`get {`
`@@ -45,31 +45,39 @@ class IterableUserDefaults {`
`45`	`45`	`save(bool: newValue, withKey: .ddlChecked)`
`46`	`46`	`}`
`47`	`47`	`}`
`48`		`-`
	`48`	`+`
`49`	`49`	`var deviceId: String? {`
`50`	`50`	`get {`
`51`	`51`	`string(withKey: .deviceId)`
`52`	`52`	`} set {`
`53`	`53`	`save(string: newValue, withKey: .deviceId)`
`54`	`54`	`}`
`55`	`55`	`}`
`56`		`-`
	`56`	`+`
`57`	`57`	`var sdkVersion: String? {`
`58`	`58`	`get {`
`59`	`59`	`string(withKey: .sdkVersion)`
`60`	`60`	`} set {`
`61`	`61`	`save(string: newValue, withKey: .sdkVersion)`
`62`	`62`	`}`
`63`	`63`	`}`
`64`		`-`
	`64`	`+`
`65`	`65`	`var offlineMode: Bool {`
`66`	`66`	`get {`
`67`	`67`	`return bool(withKey: .offlineMode)`
`68`	`68`	`} set {`
`69`	`69`	`save(bool: newValue, withKey: .offlineMode)`
`70`	`70`	`}`
`71`	`71`	`}`
`72`		`-`
	`72`	`+`
	`73`	`+ var anonymousUsageTrack: Bool {`
	`74`	`+ get {`
	`75`	`+ return bool(withKey: .anonymousUsageTrack)`
	`76`	`+ } set {`
	`77`	`+ save(bool: newValue, withKey: .anonymousUsageTrack)`
	`78`	`+ }`
	`79`	`+ }`
	`80`	`+`
`73`	`81`	`var anonymousUserEvents: [[AnyHashable: Any]]? {`
`74`	`82`	`get {`
`75`	`83`	`return eventData(withKey: .anonymousUserEvents)`
`@@ -284,6 +292,8 @@ class IterableUserDefaults {`
`284`	`292`	`static let anonymousUserEvents = UserDefaultsKey(value: Const.UserDefault.offlineMode)`
`285`	`293`	`static let criteriaData = UserDefaultsKey(value: Const.UserDefault.criteriaData)`
`286`	`294`	`static let anonymousSessions = UserDefaultsKey(value: Const.UserDefault.anonymousSessions)`
	`295`	`+ static let anonymousUsageTrack = UserDefaultsKey(value: Const.UserDefault.anonymousUsageTrack)`
	`296`	`+`
`287`	`297`	`}`
`288`	`298`	`private struct Envelope: Codable {`
`289`	`299`	`let payload: Data`