Merge pull request #575 from Iterable/jay/MOB-4781-userdefaults-migration

[MOB-4781] userdefaults migration refactor

Author: roninopf

swift-sdk/Internal/IterableUserDefaults.swift

@@ -10,6 +10,7 @@ class IterableUserDefaults {
         self.userDefaults = userDefaults
     }
 
+    // migrated to IterableKeychain
     var userId: String? {
         get {
             string(withKey: .userId)
@@ -18,6 +19,7 @@ class IterableUserDefaults {
         }
     }
 
+    // migrated to IterableKeychain
     var email: String? {
         get {
             string(withKey: .email)
@@ -26,6 +28,7 @@ class IterableUserDefaults {
         }
     }
 
+    // migrated to IterableKeychain
     var authToken: String? {
         get {
             string(withKey: .authToken)
@@ -34,6 +37,7 @@ class IterableUserDefaults {
         }
     }
 
+    // deprecated, not in use anymore
     var ddlChecked: Bool {
         get {
             bool(withKey: .ddlChecked)
@@ -74,15 +78,19 @@ class IterableUserDefaults {
         try? save(codable: attributionInfo, withKey: .attributionInfo, andExpiration: expiration)
     }
 
+    // migrated to IterableKeychain
     func getPayload(currentDate: Date) -> [AnyHashable: Any]? {
         (try? dict(withKey: .payload, currentDate: currentDate)) ?? nil
     }
 
+    // migrated to IterableKeychain
     func save(payload: [AnyHashable: Any]?, withExpiration expiration: Date?) {
         try? save(dict: payload, withKey: .payload, andExpiration: expiration)
     }
 
-    func getLastPushPayloadAndExpirationPair() -> (payload: [AnyHashable: Any]?, expiration: Date?)? {
+    // MARK: data migration functions
+    
+    func getLastPushPayloadExpirationPairForMigration() -> (payload: [AnyHashable: Any]?, expiration: Date?)? {
         guard let encodedEnvelope = userDefaults.value(forKey: UserDefaultsKey.payload.value) as? Data else {
             return nil
         }
@@ -97,7 +105,9 @@ class IterableUserDefaults {
         }
     }
 
-    // create migration function for email, userId, authToken here
+    func getAuthDataForMigration() -> (email: String?, userId: String?, authToken: String?) {
+        return (email: email, userId: userId, authToken: authToken)
+    }
 
     // MARK: Private implementation
 

swift-sdk/Internal/LocalStorage.swift

@@ -99,35 +99,45 @@ struct LocalStorage: LocalStorageProtocol {
     private let keychain: IterableKeychain
 
     private func moveAuthDataFromUserDefaultsToKeychain() {
-        // in the future, use the migration function from IterableUserDefaults like with the last push payload
+        let (userDefaultEmail, userDefaultUserId, userDefaultAuthToken) = iterableUserDefaults.getAuthDataForMigration()
 
-        if let userDefaultAuthToken = iterableUserDefaults.authToken, keychain.authToken == nil {
-            keychain.authToken = userDefaultAuthToken
-            iterableUserDefaults.authToken = nil
+        if let userDefaultEmail = userDefaultEmail {
+            if keychain.email == nil {
+                keychain.email = userDefaultEmail
+            }
 
-            ITBInfo("UPDATED: moved authToken from UserDefaults to IterableKeychain")
-        }
-        
-        if let userDefaultEmail = iterableUserDefaults.email, keychain.email == nil {
-            keychain.email = userDefaultEmail
             iterableUserDefaults.email = nil
 
-            ITBInfo("UPDATED: moved email from UserDefaults to IterableKeychain")
+            ITBInfo("UPDATED: migrated email from UserDefaults to IterableKeychain")
         }
 
-        if let userDefaultUserId = iterableUserDefaults.userId, keychain.userId == nil {
-            keychain.userId = userDefaultUserId
+        if let userDefaultUserId = userDefaultUserId {
+            if keychain.userId == nil {
+                keychain.userId = userDefaultUserId
+            }
+            
             iterableUserDefaults.userId = nil
 
-            ITBInfo("UPDATED: moved userId from UserDefaults to IterableKeychain")
+            ITBInfo("UPDATED: migrated userId from UserDefaults to IterableKeychain")
+        }
+        
+        if let userDefaultAuthToken = userDefaultAuthToken {
+            if keychain.authToken == nil {
+                keychain.authToken = userDefaultAuthToken
+            }
+            
+            iterableUserDefaults.authToken = nil
+            
+            ITBInfo("UPDATED: migrated authToken from UserDefaults to IterableKeychain")
         }
     }
 
     private func moveLastPushPayloadFromUserDefaultsToKeychain() {
-        if let (userDefaultLastPushPayload, expiration) = iterableUserDefaults.getLastPushPayloadAndExpirationPair() {
+        if let (userDefaultLastPushPayload, expiration) = iterableUserDefaults.getLastPushPayloadExpirationPairForMigration() {
             keychain.setLastPushPayload(userDefaultLastPushPayload, withExpiration: expiration)
+            iterableUserDefaults.save(payload: nil, withExpiration: nil)
 
-            ITBInfo("UPDATED: moved lastPushPayload from UserDefaults to IterableKeychain")
+            ITBInfo("UPDATED: migrated lastPushPayload from UserDefaults to IterableKeychain")
         }
     }
 }