Allow early initialization of CleverTap (#541)

nzagorchev · web-flow · commit 3c352a8bad3a · 2022-11-23T19:56:33.000+02:00
* Enable CT wrapper early initialization

* Fixes for early initialization

* Handle push on launch
diff --git a/LeanplumSDK/LeanplumSDK/Classes/Internal/Leanplum.m b/LeanplumSDK/LeanplumSDK/Classes/Internal/Leanplum.m
@@ -94,7 +94,7 @@ - (void)leanplum_cancelRequestWithError:(NSError *)error
 
 @implementation Leanplum
 
-+(void)load
++ (void)load
 {
     static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{
@@ -103,6 +103,11 @@ +(void)load
         }
     });
     
+    [self setUsingPlist];
+}
+
++ (void)setUsingPlist
+{
     NSDictionary *appKeysDictionary = [self getDefaultAppKeysPlist];
     if (appKeysDictionary == nil) {
         return;
@@ -916,11 +921,7 @@ + (void)startWithUserId:(NSString *)userId
              withContextualValues:nil];
     }];
     
-    [[MigrationManager shared] fetchMigrationState:^{
-        if ([[MigrationManager shared] useCleverTap]) {
-            [[MigrationManager shared] launch];
-        }
-    
+    [[MigrationManager shared] fetchMigrationState:^{    
         if ([[MigrationManager shared] useLeanplum]) {
             // hasStarted and startSuccessful will be set from the request callbacks
             // triggerStartResponse will be called from the request callbacks
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/LPCTNotificationsManager.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/LPCTNotificationsManager.swift
@@ -23,13 +23,19 @@ import Foundation
         }
     }
     
-    override func notificationOpened(userInfo: [AnyHashable : Any], action: String = LP_VALUE_DEFAULT_PUSH_ACTION) {
+    override func notificationOpened(userInfo: [AnyHashable : Any], action: String = LP_VALUE_DEFAULT_PUSH_ACTION, fromLaunch: Bool = false) {
         if Utilities.messageIdFromUserInfo(userInfo) != nil {
             // Handle Leanplum notifications
             super.notificationOpened(userInfo: userInfo, action: action)
             return
         }
-        handlerCleverTapNotification(userInfo: userInfo, event: .opened)
+        // If the app is launched from notification and CT instance has already been created,
+        // CT will handle the notification from their UIApplication didFinishLaunchingNotification observer
+        if fromLaunch && MigrationManager.shared.hasLaunched {
+            return
+        }
+        
+        handleCleverTapNotification(userInfo: userInfo, event: .opened)
     }
     
     override func notificationReceived(userInfo: [AnyHashable : Any], isForeground: Bool) {
@@ -38,31 +44,38 @@ import Foundation
             super.notificationReceived(userInfo: userInfo, isForeground: isForeground)
             return
         }
-        handlerCleverTapNotification(userInfo: userInfo, event: .received)
+        handleCleverTapNotification(userInfo: userInfo, event: .received)
     }
     
     public override func didRegisterForRemoteNotificationsWithDeviceToken(_ deviceToken: Data) {
         super.didRegisterForRemoteNotificationsWithDeviceToken(deviceToken)
         
         Log.debug("[Wrapper] Will call CleverTap.setPushToken for didRegisterForRemoteNotifications, when Leanplum has issued start.")
-        // Leanplum.onStartIssued guarantees that Wrapper is initialized and CT instance is available, if migration has started.
-        Leanplum.onStartIssued {
-            if MigrationManager.shared.useCleverTap {
-                MigrationManager.shared.setPushToken(deviceToken)
-            }
+        handleWithCleverTapInstance {
+            MigrationManager.shared.setPushToken(deviceToken)
         }
     }
     
-    func handlerCleverTapNotification(userInfo: [AnyHashable : Any], event: NotificationEvent) {
+    func handleCleverTapNotification(userInfo: [AnyHashable : Any], event: NotificationEvent) {
         Log.debug("[Wrapper] Will call CleverTap.handlePushNotification for Push \(event), when Leanplum has issued start.")
-        // Leanplum.onStartIssued guarantees that Wrapper is initialized and CT instance is available, if migration has started.
-        Leanplum.onStartIssued {
-            if MigrationManager.shared.useCleverTap {
-                Log.debug("""
-                        [Wrapper] Calling CleverTap.handlePushNotification:openDeepLinksInForeground: \
-                        \(Constants.OpenDeepLinksInForeground) for Push \(event)
-                        """)
-                CleverTap.handlePushNotification(userInfo, openDeepLinksInForeground: Constants.OpenDeepLinksInForeground)
+        handleWithCleverTapInstance {
+            Log.debug("""
+                    [Wrapper] Calling CleverTap.handlePushNotification:openDeepLinksInForeground: \
+                    \(Constants.OpenDeepLinksInForeground) for Push \(event)
+                    """)
+            CleverTap.handlePushNotification(userInfo, openDeepLinksInForeground: Constants.OpenDeepLinksInForeground)
+        }
+    }
+    
+    func handleWithCleverTapInstance(action: @escaping () -> ()) {
+        if MigrationManager.shared.hasLaunched {
+            action()
+        } else {
+            // Leanplum.onStartIssued guarantees that Wrapper is initialized and CT instance is available, if migration has started.
+            Leanplum.onStartIssued {
+                if MigrationManager.shared.useCleverTap {
+                    action()
+                }
             }
         }
     }
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager+API.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager+API.swift
@@ -6,18 +6,25 @@
 //  Copyright © 2022 Leanplum. All rights reserved.
 
 @objc public extension MigrationManager {
-
-    func launch() {
-        guard let wrapper = wrapper else {
-            Log.debug("[Wrapper] Calling launch before wrapper is initialized.")
-            return
-        }
-        wrapper.launch()
-    }
-    
     var state: MigrationState {
         return migrationState
     }
+    
+    var hasLaunched: Bool {
+        guard let wrapper = wrapper else { return false }
+        
+        return wrapper.hasLaunched
+    }
+    
+    // Expose to ObjC
+    var useLeanplum: Bool {
+        migrationState.useLeanplum
+    }
+
+    // Expose to ObjC
+    var useCleverTap: Bool {
+        migrationState.useCleverTap
+    }
 
     func track(_ eventName: String?, value: Double, info: String?, params: [String: Any]) {
         wrapper?.track(eventName, value: value, info: info, params: params)
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/MigrationManager.swift
@@ -44,23 +44,19 @@ import Foundation
     
     private let lock = NSLock()
     
-    // Expose to ObjC
-    @objc public var useLeanplum: Bool {
-        migrationState.useLeanplum
-    }
-    
-    // Expose to ObjC
-    @objc public var useCleverTap: Bool {
-        migrationState.useCleverTap
-    }
-    
-    func initWrapper() {
+    @objc public func launchWrapper() {
         if migrationState.useCleverTap, wrapper == nil {
             guard let id = accountId, let token = accountToken, let accountRegion = regionCode else {
                 Log.error("[Wrapper] Missing CleverTap Credentials. Cannot initialize CleverTap.")
                 return
             }
-            guard let user = Leanplum.userId(), let device = Leanplum.deviceId() else {
+            
+            if !LPInternalState.shared().calledStart {
+                Log.info("[Wrapper] Initializing before calling start. Loading user.")
+                loadUser()
+            }
+
+            guard let user = Leanplum.user.userId, let device = Leanplum.user.deviceId else {
                 Log.error("[Wrapper] Missing Leanplum userId and deviceId. Cannot initialize CleverTap.")
                 return
             }
@@ -69,12 +65,31 @@ import Foundation
                                 accountRegion: accountRegion,
                                 userId: user, deviceId: device,
                                 callbacks: instanceCallbacks)
-            
-            if Leanplum.hasStarted() {
-                Log.debug("[Wrapper] Leanplum has already started, launching CleverTap as well.")
-                wrapper?.launch()
+            wrapper?.launch()
+        }
+    }
+    
+    func loadUser() {
+        guard let encryptedDiffs = UserDefaults.standard.data(forKey: LEANPLUM_DEFAULTS_VARIABLES_KEY),
+              let diffsData = LPAES.decryptedData(from: encryptedDiffs) else { return }
+        
+        var unarchiver: NSKeyedUnarchiver?
+        
+        if #available(iOS 11.0, *) {
+            do {
+                unarchiver = try NSKeyedUnarchiver(forReadingFrom: diffsData)
+            } catch {
+                Log.error("[Wrapper] Error unarchiving userId and deviceId.")
             }
+        } else {
+            unarchiver = NSKeyedUnarchiver(forReadingWith: diffsData)
         }
+
+        unarchiver?.requiresSecureCoding = false
+        
+        Leanplum.user.deviceId = unarchiver?.decodeObject(forKey: LP_PARAM_DEVICE_ID) as? String
+        
+        Leanplum.user.userId = unarchiver?.decodeObject(forKey: LP_PARAM_USER_ID) as? String
     }
     
     func handleMigrationStateChanged(oldValue: MigrationState) {
@@ -84,7 +99,7 @@ import Foundation
             // Flush all saved requests to Leanplum
             LPRequestSender.sharedInstance().sendRequests()
             // Create wrapper
-            initWrapper()
+            launchWrapper()
         }
         
         if (oldValue.useLeanplum && !migrationState.useLeanplum) {
@@ -108,7 +123,7 @@ import Foundation
     
     @objc public func fetchMigrationState(_ completion: @escaping ()->()) {
         if migrationState != .undefined {
-            initWrapper()
+            launchWrapper()
             completion()
             return
         }
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/Wrapper/CTWrapper.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/Wrapper/CTWrapper.swift
@@ -79,6 +79,10 @@ class CTWrapper: Wrapper {
         triggerInstanceCallbacks()
     }
     
+    var hasLaunched: Bool {
+        return cleverTapInstance != nil
+    }
+    
     // MARK: Callback
     func addInstanceCallback(_ callback: CleverTapInstanceCallback) {
         instanceCallbacks.append(callback)
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/Wrapper/Wrapper.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Migration/Wrapper/Wrapper.swift
@@ -10,6 +10,8 @@ protocol Wrapper {
     /// equivalent to Leanplum start
     func launch()
     
+    var hasLaunched: Bool { get }
+    
     /// Adds instance callback, executed when wrapper has initialized
     func addInstanceCallback(_ callback: CleverTapInstanceCallback)
     
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Notifications/NotificationsManager.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Notifications/NotificationsManager.swift
@@ -85,8 +85,8 @@ import UIKit
     
     // MARK: - Notification Actions
     // MARK: Notification Open
-    @objc(notificationOpened:action:)
-    func notificationOpened(userInfo: [AnyHashable: Any], action: String = LP_VALUE_DEFAULT_PUSH_ACTION) {
+    @objc(notificationOpened:action:fromLaunch:)
+    func notificationOpened(userInfo: [AnyHashable: Any], action: String = LP_VALUE_DEFAULT_PUSH_ACTION, fromLaunch: Bool = false) {
         guard let messageId = Utilities.messageIdFromUserInfo(userInfo) else {
             Log.debug("Push notification not handled, no message id found.")
             return
diff --git a/LeanplumSDK/LeanplumSDK/ClassesSwift/Notifications/Proxy/NotificationsProxy.swift b/LeanplumSDK/LeanplumSDK/ClassesSwift/Notifications/Proxy/NotificationsProxy.swift
@@ -75,7 +75,7 @@ public class NotificationsProxy: NSObject {
                 Leanplum.notificationsManager().notificationReceived(userInfo: remoteNotification, isForeground: false)
             } else {
                 notificationOpenedFromStart = true
-                Leanplum.notificationsManager().notificationOpened(userInfo: remoteNotification)
+                Leanplum.notificationsManager().notificationOpened(userInfo: remoteNotification, action: LP_VALUE_DEFAULT_PUSH_ACTION, fromLaunch: true)
             }
         } else if
             let localNotification =
diff --git a/LeanplumSDKApp/LeanplumSDKTests/Classes/Notifications/NotificationsManagerMock.swift b/LeanplumSDKApp/LeanplumSDKTests/Classes/Notifications/NotificationsManagerMock.swift
@@ -22,7 +22,9 @@ class NotificationsManagerMock: NotificationsManager {
     public var methodInvocations = 0
     public var isPushEnabled: Bool?
     
-    override func notificationOpened(userInfo: [AnyHashable : Any], action: String = LP_VALUE_DEFAULT_PUSH_ACTION) {
+    override func notificationOpened(userInfo: [AnyHashable : Any],
+                                     action: String = LP_VALUE_DEFAULT_PUSH_ACTION,
+                                     fromLaunch: Bool = false) {
         userInfoProcessed = userInfo
         actionName = action
         methodInvocations += 1

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public class NotificationsProxy: NSObject {`
`75`	`75`	`Leanplum.notificationsManager().notificationReceived(userInfo: remoteNotification, isForeground: false)`
`76`	`76`	`} else {`
`77`	`77`	`notificationOpenedFromStart = true`
`78`		`- Leanplum.notificationsManager().notificationOpened(userInfo: remoteNotification)`
	`78`	`+ Leanplum.notificationsManager().notificationOpened(userInfo: remoteNotification, action: LP_VALUE_DEFAULT_PUSH_ACTION, fromLaunch: true)`
`79`	`79`	`}`
`80`	`80`	`} else if`
`81`	`81`	`let localNotification =`