Migration: Use loggedInUserId to identify previously logged-in users (#572)

* Fixes for CleverTap ID

* Identity fixes, allow login with deviceId

* Fix tests

* Update sample response

* Fix setting the loggedInUserId in Leanplum

* Refactor IdentityManagerTest

* Fix for changing the user while offline before getMigrateState

Author: nzagorchev

LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager+Constants.swift

@@ -16,6 +16,7 @@ import Foundation
         static let RegionCodeKey = "__leanplum_region_code"
         static let AttributeMappingsKey = "__leanplum_attribute_mappings"
         static let IdentityKeysKey = "__leanplum_identity_keys"
+        static let LoggedInUserIdKey = "__leanplum_logged_in_user_id"
 
         static let DefaultIdentityKeys = [IdentityManager.Constants.Identity]
 

LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager+ResponseHandler.swift

@@ -20,11 +20,13 @@ import Foundation
         let ct: CTConfig?
         let migrationState: String?
         let hash: String?
+        let loggedInUserId: String?
 
         enum CodingKeys: String, CodingKey {
             case hash = "sha256"
             case migrationState = "sdk"
             case ct
+            case loggedInUserId
         }
     }
 
@@ -80,6 +82,7 @@ import Foundation
     //            "sdk": "lp+ct",
     //            "sha256": "31484a565dcd3e1672922c7c4166bfeee0f500b6d6473fc412091304cc162ca8",
     //            "state": "EVENTS_UPLOAD_STARTED",
+    //            "loggedInUserId": "9da5cdc6-m340-42a8-9110-1d4a1099f157",
     //            "success": 1,
     //        }
     //    ]
@@ -106,12 +109,23 @@ import Foundation
             }
         }
 
-        if let sdk = migrationData.migrationState {
-            migrationState = MigrationState(stringValue: sdk)
-        }
         if let hash = migrationData.hash {
             migrationHash = hash
         }
+        
+        if let loggedInUser = migrationData.loggedInUserId {
+            loggedInUserId = loggedInUser
+            Leanplum.onStartResponse { _ in
+                if Leanplum.userId() == Leanplum.deviceId() {
+                    Leanplum.setUserId(loggedInUser)
+                }
+            }
+        }
+        
+        // Changing the migrationState value will initialize the Wrapper
+        if let sdk = migrationData.migrationState {
+            migrationState = MigrationState(stringValue: sdk)
+        }
     }
 
     // MARK: - Utils

LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager.swift

@@ -36,6 +36,9 @@ import Foundation
     @PropUserDefaults(key: Constants.IdentityKeysKey, defaultValue: Constants.DefaultIdentityKeys)
     var identityKeys: [String]
 
+    @StringOptionalUserDefaults(key: Constants.LoggedInUserIdKey)
+    var loggedInUserId: String?
+    
     @MigrationStateUserDefaults(key: Constants.MigrationStateKey, defaultValue: .undefined)
     var migrationState: MigrationState {
         didSet {
@@ -61,10 +64,11 @@ import Foundation
                 Log.error("[Wrapper] Missing Leanplum userId and deviceId. Cannot initialize CleverTap.")
                 return
             }
-
+            
             wrapper = CTWrapper(accountId: id, accountToken: token,
                                 accountRegion: accountRegion,
-                                userId: user, deviceId: device,
+                                useCustomCleverTapId: state != .cleverTap,
+                                userId: user, deviceId: device, loggedInUserId: loggedInUserId,
                                 callbacks: instanceCallbacks)
             wrapper?.launch()
         }

LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/Wrapper/CTWrapper.swift

@@ -35,28 +35,48 @@ class CTWrapper: Wrapper {
     var accountRegion: String
     var identityManager: IdentityManager
 
+    var useCustomCleverTapId: Bool
+    
     public init(accountId: String,
                 accountToken: String,
                 accountRegion: String,
+                useCustomCleverTapId: Bool,
                 userId: String,
                 deviceId: String,
+                loggedInUserId: String?,
                 callbacks: [CleverTapInstanceCallback]) {
         Log.info("[Wrapper] Wrapper Instantiated")
         self.accountId = accountId
         self.accountToken = accountToken
         self.accountRegion = accountRegion
         self.instanceCallbacks = callbacks
+        self.useCustomCleverTapId = useCustomCleverTapId
 
-        identityManager = IdentityManager(userId: userId, deviceId: deviceId)
+        identityManager = IdentityManager(userId: userId, deviceId: deviceId, loggedInUserId: loggedInUserId)
         setLogLevel(LPLogManager.logLevel())
     }
 
+    func onUserLogin() {
+        if useCustomCleverTapId {
+            cleverTapInstance?.onUserLogin(identityManager.profile,
+                                           withCleverTapID: identityManager.cleverTapID)
+        } else {
+            cleverTapInstance?.onUserLogin(identityManager.profile)
+        }
+    }
+    
     func launch() {
         let config = CleverTapInstanceConfig.init(accountId: accountId, accountToken: accountToken, accountRegion: accountRegion)
         config.identityKeys = MigrationManager.shared.identityKeys
-        config.useCustomCleverTapId = true
         config.logLevel = CleverTapLogLevel(LPLogManager.logLevel())
-        cleverTapInstance = CleverTap.instance(with: config, andCleverTapID: identityManager.cleverTapID)
+        
+        if useCustomCleverTapId {
+            config.useCustomCleverTapId = true
+            cleverTapInstance = CleverTap.instance(with: config, andCleverTapID: identityManager.cleverTapID)
+        } else {
+            cleverTapInstance = CleverTap.instance(with: config)
+        }
+
         cleverTapInstance?.setLibrary("Leanplum")
         // Track App Launched
         cleverTapInstance?.notifyApplicationLaunched(withOptions: [:])
@@ -69,8 +89,7 @@ class CTWrapper: Wrapper {
                     [Wrapper] will call onUserLogin with \
                     Identity: \(identityManager.userId) and cleverTapId: \(identityManager.cleverTapID)"
                     """)
-            cleverTapInstance?.onUserLogin(identityManager.profile,
-                                           withCleverTapID: identityManager.cleverTapID)
+            onUserLogin()
             setDevicesProperty()
         } else {
             if !identityManager.isValidCleverTapID {
@@ -216,7 +235,7 @@ class CTWrapper: Wrapper {
                 with identity: \(profile) \
                 and CleverTapID:  \(cleverTapID)")
                 """)
-        cleverTapInstance?.onUserLogin(profile, withCleverTapID: cleverTapID)
+        onUserLogin()
 
         setDevicesProperty()
     }

LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/Wrapper/IdentityManager.swift

@@ -3,7 +3,7 @@
 //  LeanplumSDK
 //
 //  Created by Nikola Zagorchev on 6.10.22.
-//  Copyright © 2022 Leanplum. All rights reserved.
+//  Copyright © 2023 Leanplum. All rights reserved.
 
 import Foundation
 // Use @_implementationOnly to *not* expose CleverTapSDK to the Leanplum-Swift header
@@ -28,6 +28,18 @@ import Foundation
  *  For this userId, the CTID is always set to deviceId.
  *  Leanplum UserId can be set through Leanplum.start and Leanplum.setUserId
  *
+ *  - Note: There are cases where the deviceId can remain the same after app uninstall.
+ *  In this case, the SDK has lost the data on the anonymous and logged in user.
+ *  If there is already logged in user on that device, the API will return the logged in userId with the migration data.
+ *  Use this userId as Identified, so CTID is non-anonymous when the `Wrapper` is created.
+ *  The very first `CleverTap` instance must be created as non-anonymous <CTID=deviceId_userIdHash, Identity=userId>.
+ *  This ensures the data will go to the logged in user according to the Leanplum API.
+ *
+ *  - Note: Allow setting the userId to the deviceId if user has already logged in - non-anonymous.
+ *  If the user is anonymous, calling `setUserId` with <userId=deviceId> should be a NOOP.
+ *  If user has logged in on the device, and then `setUserId` is called with <userId=deviceId>,
+ *  treat this as a new user login <CTID=deviceId_deviceIdHash, Identity=deviceId>
+ *
  * - Precondition: DeviceId cannot be changed when CT is used,
  *  since CTID cannot be modified for the same Identity.
 */
@@ -36,6 +48,7 @@ class IdentityManager {
         static let Identity = "Identity"
         static let AnonymousLoginUserIdKey = "__leanplum_anonymous_login_user_id"
         static let IdentityStateKey = "__leanplum_identity_state"
+        static let LoggedInUserKey = "__leanplum_logged_in_user"
 
         static let DeviceIdLengthLimit = 50
         static let IdentityHashLength = 10
@@ -59,15 +72,27 @@ class IdentityManager {
     @StringOptionalUserDefaults(key: Constants.IdentityStateKey)
     var state: String?
 
-    init(userId: String, deviceId: String) {
+    @StringOptionalUserDefaults(key: Constants.LoggedInUserKey)
+    var loggedInUserId: String?
+    
+    convenience init(userId: String, deviceId: String) {
+        self.init(userId: userId, deviceId: deviceId, loggedInUserId: nil)
+    }
+    
+    init(userId: String, deviceId: String, loggedInUserId: String?) {
         self.userId = userId
         self.deviceId = deviceId
+        self.loggedInUserId = loggedInUserId
 
         identify()
     }
 
     func setUserId(_ userId: String) {
-        if (state == IdentityState.anonymous()) {
+        if userId == deviceId && state == IdentityState.anonymous() {
+            return
+        }
+        
+        if state == IdentityState.anonymous() {
             if let hash = Utilities.sha256_40(string: userId) {
                 anonymousLoginUserId = hash
             } else {
@@ -81,7 +106,10 @@ class IdentityManager {
     }
 
     func identify() {
-        if isAnonymous {
+        if isAnonymous, let loggedInUserId = self.loggedInUserId {
+            self.userId = loggedInUserId
+            state = IdentityState.identified()
+        } else if isAnonymous {
             state = IdentityState.anonymous()
         } else {
             identifyNonAnonymous()
@@ -141,10 +169,10 @@ class IdentityManager {
     }
 
     var isAnonymous: Bool {
-        userId == deviceId
+        userId == deviceId && state != IdentityState.identified()
     }
 
     var shouldAppendUserId: Bool {
-        userIdHash != anonymousLoginUserId && userId != deviceId
+        userIdHash != anonymousLoginUserId && (userId != deviceId || state == IdentityState.identified())
     }
 }

LeanplumSDKApp/LeanplumSDKTests/Classes/Migration/CTWrapperTest.swift

@@ -12,8 +12,8 @@ import XCTest
 class CTWrapperTest: XCTestCase {
 
     static let attributeMappings = ["lpName": "ctName", "lpName2": "ctName2"]
-    let wrapper = CTWrapper(accountId: "", accountToken: "", accountRegion: "", userId: "", deviceId: "", callbacks: [])
-    
+    let wrapper = CTWrapper(accountId: "", accountToken: "", accountRegion: "", useCustomCleverTapId: true,
+                            userId: "", deviceId: "", loggedInUserId: nil, callbacks: [])
     override class func setUp() {
         MigrationManager.shared.attributeMappings = attributeMappings
     }

LeanplumSDKApp/LeanplumSDKTests/Classes/Migration/IdentityManagerMocks.swift

@@ -51,11 +51,11 @@ class IdentityManagerMockStatic: IdentityManager {
         }
     }
 
-    init(userId: String, deviceId: String, anonymousLoginUserId: String?, state: String?) {
+    init(userId: String, deviceId: String, anonymousLoginUserId: String?, state: String?, loggedInUserId: String? = nil) {
         // Needs to be set before call to super.init
         IdentityManagerMockStatic._anonymousLoginUserId = anonymousLoginUserId
         IdentityManagerMockStatic._state = state
 
-        super.init(userId: userId, deviceId: deviceId)
+        super.init(userId: userId, deviceId: deviceId, loggedInUserId: loggedInUserId)
     }
 }