Merge pull request #959 from BranchMetrics/SDK-554-swift-fixes

echo-branch · web-flow · commit ce3f3c1e8efd · 2019-11-01T15:31:16.000-07:00
SDK-554 Fixes for swift project
diff --git a/Branch-SDK/Branch-SDK/Branch.h b/Branch-SDK/Branch-SDK/Branch.h
@@ -168,21 +168,21 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 
  @warning This method is not meant to be used in production!
 */
-+ (nullable Branch *) getTestInstance __attribute__((deprecated(("Use `Branch.useTestBranchKey = YES;` instead."))));
++ (Branch *)getTestInstance __attribute__((deprecated(("Use `Branch.useTestBranchKey = YES;` instead."))));
 
 
 /**
  Gets the global, live Branch instance.
  */
-+ (nullable Branch *)getInstance;
++ (Branch *)getInstance;
 
 /**
  Gets the global Branch instance, configures using the specified key
 
  @param branchKey The Branch key to be used by the Branch instance. This can be any live or test key.
  @warning This method is not the recommended way of using Branch. Try using your project's `Info.plist` if possible.
  */
-+ (nullable Branch *)getInstance:(NSString *)branchKey;
++ (Branch *)getInstance:(NSString *)branchKey;
 
 /**
  Set the network service class.
@@ -947,7 +947,7 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void) sendCommerceEvent:(BNCCommerceEvent*)commerceEvent
 				  metadata:(NSDictionary<NSString*,id>*)metadata
-			withCompletion:(void (^) (NSDictionary*response, NSError*error))completion __attribute__((deprecated(("Please use BranchEvent to track commerce events."))));
+			withCompletion:(void (^) (NSDictionary* _Nullable response, NSError* _Nullable error))completion __attribute__((deprecated(("Please use BranchEvent to track commerce events."))));
 
 
 #pragma mark - Query methods
diff --git a/Branch-SDK/Branch-SDK/Branch.m b/Branch-SDK/Branch-SDK/Branch.m
@@ -206,16 +206,16 @@ + (void)load {
 // deprecated
 + (Branch *)getTestInstance {
     Branch.useTestBranchKey = YES;
-    return Branch.getInstance;
+    return [Branch getInstance];
 }
 
 + (Branch *)getInstance {
-    return [Branch getInstanceInternal:self.class.branchKey returnNilIfNoCurrentInstance:NO];
+    return [Branch getInstanceInternal:self.class.branchKey];
 }
 
 + (Branch *)getInstance:(NSString *)branchKey {
     self.branchKey = branchKey;
-    return [Branch getInstanceInternal:self.branchKey returnNilIfNoCurrentInstance:NO];
+    return [Branch getInstanceInternal:self.branchKey];
 }
 
 - (id)initWithInterface:(BNCServerInterface *)interface
@@ -1496,14 +1496,10 @@ - (void)removeAllPrivateContentFromSpotLightWithCallback:(void (^)(NSError * err
 
 #pragma mark - Private methods
 
-+ (Branch *)getInstanceInternal:(NSString *)key returnNilIfNoCurrentInstance:(BOOL)returnNilIfNoCurrentInstance {
++ (Branch *)getInstanceInternal:(NSString *)key {
 
     static Branch *branch = nil;
     @synchronized (self) {
-        if (!branch && returnNilIfNoCurrentInstance) {
-            return nil;
-        }
-
         static dispatch_once_t onceToken = 0;
         dispatch_once(&onceToken, ^{
             BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
diff --git a/Branch-TestBed-Swift/TestBed-Swift/AppDelegate.swift b/Branch-TestBed-Swift/TestBed-Swift/AppDelegate.swift
@@ -57,131 +57,126 @@ class AppDelegate: UIResponder, UIApplicationDelegate, AdjustDelegate, AppsFlyer
         activateSingular()
         activateStitch()
         
-        if let branch = Branch.getInstance(branchKey) {
+        let branch = Branch.getInstance(branchKey)
             
-            if StartupOptionsData.getPendingSetDebugEnabled()! {
-                branch.setDebug()
-                StartupOptionsData.setActiveSetDebugEnabled(true)
-            } else {
-                StartupOptionsData.setActiveSetDebugEnabled(false)
+        if StartupOptionsData.getPendingSetDebugEnabled()! {
+            branch.setDebug()
+            StartupOptionsData.setActiveSetDebugEnabled(true)
+        } else {
+            StartupOptionsData.setActiveSetDebugEnabled(false)
+        }
+        
+        // To use automaticallyDisplayDeepLinkController:
+        // 1) Uncomment the following code block
+        // 2) Comment out the code in the 'if (error == nil)' code block in initSession callback below
+        // 3) Change automaticallyDisplayDeepLinkController to true
+        /* let navigationController = UIStoryboard(name: "Main", bundle: nil).instantiateInitialViewController() as! UINavigationController
+         branch.registerDeepLinkController(navigationController, forKey:"~referring_link")*/
+        
+        // Required. Initialize session. automaticallyDisplayDeepLinkController is optional (default is false).
+        
+        branch.initSession(
+            launchOptions: launchOptions,
+            automaticallyDisplayDeepLinkController: false,
+            deepLinkHandler: { params, error in
+            
+            defer {
+                let notificationName = Notification.Name("BranchCallbackCompleted")
+                NotificationCenter.default.post(name: notificationName, object: nil)
+            }
+            
+            guard error == nil else {
+                print("Branch TestBed: Initialization failed: " + error!.localizedDescription)
+                return
             }
             
-            // To use automaticallyDisplayDeepLinkController:
-            // 1) Uncomment the following code block
-            // 2) Comment out the code in the 'if (error == nil)' code block in initSession callback below
-            // 3) Change automaticallyDisplayDeepLinkController to true
-            /* let navigationController = UIStoryboard(name: "Main", bundle: nil).instantiateInitialViewController() as! UINavigationController
-             branch.registerDeepLinkController(navigationController, forKey:"~referring_link")*/
+            guard let paramsDictionary = (params as? Dictionary<String, Any>) else {
+                print("No Branch parameters returned")
+                return
+            }
             
-            // Required. Initialize session. automaticallyDisplayDeepLinkController is optional (default is false).
+
+            let clickedBranchLink = params?[BRANCH_INIT_KEY_CLICKED_BRANCH_LINK] as! Bool?
             
-            branch.initSession(
-                launchOptions: launchOptions,
-                automaticallyDisplayDeepLinkController: false,
-                deepLinkHandler: { params, error in
-                
-                defer {
-                    let notificationName = Notification.Name("BranchCallbackCompleted")
-                    NotificationCenter.default.post(name: notificationName, object: nil)
-                }
-                
-                guard error == nil else {
-                    print("Branch TestBed: Initialization failed: " + error!.localizedDescription)
-                    return
+            if  let referringLink = paramsDictionary["~referring_link"] as! String?,
+                let trackerId = paramsDictionary["ios_tracker_id"] as! String?,
+                let clickedBranchLink = clickedBranchLink,
+                clickedBranchLink {
+                var adjustUrl = URLComponents(string: referringLink)
+                var adjust_tracker:URLQueryItem
+                //
+                // Here's how to add Adjust attribution:
+                //
+                // Check if the deeplink is a Universal link.
+                if referringLink.starts(with: "https://") || referringLink.starts(with: "http://") {
+                    adjust_tracker = URLQueryItem(name: "adjust_t", value: trackerId)
+                } else {
+                    adjust_tracker = URLQueryItem(name: "adjust_tracker", value: trackerId)
                 }
-                
-                guard let paramsDictionary = (params as? Dictionary<String, Any>) else {
-                    print("No Branch parameters returned")
-                    return
+                let adjust_campaign = URLQueryItem(name: "adjust_campaign", value: paramsDictionary[BRANCH_INIT_KEY_CAMPAIGN] as? String)
+                let adjust_adgroup = URLQueryItem(name: "adjust_adgroup", value: paramsDictionary[BRANCH_INIT_KEY_CHANNEL] as? String)
+                let adjust_creative = URLQueryItem(name: "adjust_creative", value: paramsDictionary[BRANCH_INIT_KEY_FEATURE] as? String)
+                let queryItems = [adjust_tracker,adjust_campaign,adjust_adgroup,adjust_creative]
+                adjustUrl?.queryItems = queryItems
+                if let url = adjustUrl?.url {
+                    Adjust.appWillOpen(url)
                 }
+            }
+            
+            // Deeplinking logic for use when automaticallyDisplayDeepLinkController = false
+            if let clickedBranchLink = clickedBranchLink,
+               clickedBranchLink {
+                let nc = self.window!.rootViewController as! UINavigationController
+                let storyboard = UIStoryboard(name: "Content", bundle: nil)
+                let contentViewController = storyboard.instantiateViewController(withIdentifier: "Content") as! ContentViewController
+                nc.pushViewController(contentViewController, animated: true)
                 
-
-                let clickedBranchLink = params?[BRANCH_INIT_KEY_CLICKED_BRANCH_LINK] as! Bool?
+                let referringLink = paramsDictionary["~referring_link"] as! String
+                let content = String(format:"\nReferring link: \(referringLink)\n\nSession Details:\n\(paramsDictionary.JSONDescription())")
+                contentViewController.content = content
+                contentViewController.contentType = "Content"
+            } else {
+                print(String(format: "Branch TestBed: Finished init with params\n%@", paramsDictionary.description))
+            }
+            
+            // Adobe
+            if IntegratedSDKsData.activeAdobeEnabled()! {
+                let adobeVisitorID = ADBMobile.trackingIdentifier()
                 
-                if  let referringLink = paramsDictionary["~referring_link"] as! String?,
-                    let trackerId = paramsDictionary["ios_tracker_id"] as! String?,
-                    let clickedBranchLink = clickedBranchLink,
-                    clickedBranchLink {
-                    var adjustUrl = URLComponents(string: referringLink)
-                    var adjust_tracker:URLQueryItem
-                    //
-                    // Here's how to add Adjust attribution:
-                    //
-                    // Check if the deeplink is a Universal link.
-                    if referringLink.starts(with: "https://") || referringLink.starts(with: "http://") {
-                        adjust_tracker = URLQueryItem(name: "adjust_t", value: trackerId)
-                    } else {
-                        adjust_tracker = URLQueryItem(name: "adjust_tracker", value: trackerId)
-                    }
-                    let adjust_campaign = URLQueryItem(name: "adjust_campaign", value: paramsDictionary[BRANCH_INIT_KEY_CAMPAIGN] as? String)
-                    let adjust_adgroup = URLQueryItem(name: "adjust_adgroup", value: paramsDictionary[BRANCH_INIT_KEY_CHANNEL] as? String)
-                    let adjust_creative = URLQueryItem(name: "adjust_creative", value: paramsDictionary[BRANCH_INIT_KEY_FEATURE] as? String)
-                    let queryItems = [adjust_tracker,adjust_campaign,adjust_adgroup,adjust_creative]
-                    adjustUrl?.queryItems = queryItems
-                    if let url = adjustUrl?.url {
-                        Adjust.appWillOpen(url)
-                    }
-                }
+                branch.setRequestMetadataKey("$adobe_visitor_id", value:adobeVisitorID)
+            }
+            
+            
+            // Amplitude
+            if IntegratedSDKsData.activeAmplitudeEnabled()! {
+                var userID: String
                 
-                // Deeplinking logic for use when automaticallyDisplayDeepLinkController = false
-                if let clickedBranchLink = clickedBranchLink,
-                   clickedBranchLink {
-                    let nc = self.window!.rootViewController as! UINavigationController
-                    let storyboard = UIStoryboard(name: "Content", bundle: nil)
-                    let contentViewController = storyboard.instantiateViewController(withIdentifier: "Content") as! ContentViewController
-                    nc.pushViewController(contentViewController, animated: true)
-                    
-                    let referringLink = paramsDictionary["~referring_link"] as! String
-                    let content = String(format:"\nReferring link: \(referringLink)\n\nSession Details:\n\(paramsDictionary.JSONDescription())")
-                    contentViewController.content = content
-                    contentViewController.contentType = "Content"
+                if paramsDictionary["developer_identity"] != nil {
+                    userID = paramsDictionary["developer_identity"] as! String
                 } else {
-                    print(String(format: "Branch TestBed: Finished init with params\n%@", paramsDictionary.description))
-                }
-                
-                // Adobe
-                if IntegratedSDKsData.activeAdobeEnabled()! {
-                    let adobeVisitorID = ADBMobile.trackingIdentifier()
-                    
-                    branch.setRequestMetadataKey("$adobe_visitor_id", value:adobeVisitorID)
+                    userID = "Anonymous"
                 }
                 
+                Amplitude.instance().setUserId(userID)
+                branch.setRequestMetadataKey("$amplitude_user_id",
+                                             value: userID)
+            }
+            
+            // Mixpanel
+            if IntegratedSDKsData.activeMixpanelEnabled()! {
+                var userID: String
                 
-                // Amplitude
-                if IntegratedSDKsData.activeAmplitudeEnabled()! {
-                    var userID: String
-                    
-                    if paramsDictionary["developer_identity"] != nil {
-                        userID = paramsDictionary["developer_identity"] as! String
-                    } else {
-                        userID = "Anonymous"
-                    }
-                    
-                    Amplitude.instance().setUserId(userID)
-                    branch.setRequestMetadataKey("$amplitude_user_id",
-                                                 value: userID)
+                if paramsDictionary["developer_identity"] != nil {
+                    userID = paramsDictionary["developer_identity"] as! String
+                } else {
+                    userID = "Anonymous"
                 }
                 
-                // Mixpanel
-                if IntegratedSDKsData.activeMixpanelEnabled()! {
-                    var userID: String
-                    
-                    if paramsDictionary["developer_identity"] != nil {
-                        userID = paramsDictionary["developer_identity"] as! String
-                    } else {
-                        userID = "Anonymous"
-                    }
-                    
-                    Mixpanel.sharedInstance()?.identify(userID)
-                    branch.setRequestMetadataKey("$mixpanel_distinct_id",
-                                                 value: userID)
-                }
-            })
-        } else {
-            print("Branch TestBed: Invalid Key\n")
-            StartupOptionsData.setActiveBranchKey("")
-            StartupOptionsData.setPendingBranchKey("")
-        }
+                Mixpanel.sharedInstance()?.identify(userID)
+                branch.setRequestMetadataKey("$mixpanel_distinct_id",
+                                             value: userID)
+            }
+        })
         
         return true
     }
diff --git a/Branch-TestBed-Swift/TestBed-Swift/CommerceEventDetailsTableViewController.swift b/Branch-TestBed-Swift/TestBed-Swift/CommerceEventDetailsTableViewController.swift
@@ -101,7 +101,7 @@ class CommerceEventDetailsTableViewController: UITableViewController, UITextFiel
     }
     
     func refreshControls() {
-        guard var commerceEvent = CommerceEventData.commerceEvent() else {
+        guard let commerceEvent = CommerceEventData.commerceEvent() else {
             return
         }
 
diff --git a/Branch-TestBed-Swift/TestBed-Swift/CommerceEventTableViewController.swift b/Branch-TestBed-Swift/TestBed-Swift/CommerceEventTableViewController.swift
@@ -90,7 +90,7 @@ class CommerceEventTableViewController: UITableViewController {
             disableTouches:true
         )
         
-        Branch.getInstance()?.send(
+        Branch.getInstance().send(
             commerceEvent,
             metadata: commerceEventCustomMetadata,
             withCompletion: { (response, error) in
diff --git a/Branch-TestBed-Swift/TestBed-Swift/CustomEventTableViewController.swift b/Branch-TestBed-Swift/TestBed-Swift/CustomEventTableViewController.swift
@@ -107,9 +107,9 @@ class CustomEventTableViewController: UITableViewController {
         }
         
         if customEventMetadata.count == 0 {
-            branch?.userCompletedAction(customEventName)
+            branch.userCompletedAction(customEventName)
         } else {
-            branch?.userCompletedAction(customEventName, withState: customEventMetadata)
+            branch.userCompletedAction(customEventName, withState: customEventMetadata)
         }
         self.showAlert(String(format: "Custom event '%@' dispatched", customEventName), withDescription: "")
     }
diff --git a/Branch-TestBed-Swift/TestBed-Swift/HomeViewController.swift b/Branch-TestBed-Swift/TestBed-Swift/HomeViewController.swift
diff --git a/Branch-TestBed-Swift/TestBed-Swift/ReferralRewardsTableViewController.swift b/Branch-TestBed-Swift/TestBed-Swift/ReferralRewardsTableViewController.swift
diff --git a/carthage-files/BranchSDK.xcodeproj/project.pbxproj b/carthage-files/BranchSDK.xcodeproj/project.pbxproj

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ class CommerceEventDetailsTableViewController: UITableViewController, UITextFiel`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`func refreshControls() {`
`104`		`- guard var commerceEvent = CommerceEventData.commerceEvent() else {`
	`104`	`+ guard let commerceEvent = CommerceEventData.commerceEvent() else {`
`105`	`105`	`return`
`106`	`106`	`}`
`107`	`107`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ class CommerceEventTableViewController: UITableViewController {`
`90`	`90`	`disableTouches:true`
`91`	`91`	`)`
`92`	`92`
`93`		`- Branch.getInstance()?.send(`
	`93`	`+ Branch.getInstance().send(`
`94`	`94`	`commerceEvent,`
`95`	`95`	`metadata: commerceEventCustomMetadata,`
`96`	`96`	`withCompletion: { (response, error) in`
Original file line number	Diff line number	Diff line change
`@@ -107,9 +107,9 @@ class CustomEventTableViewController: UITableViewController {`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`if customEventMetadata.count == 0 {`
`110`		`- branch?.userCompletedAction(customEventName)`
	`110`	`+ branch.userCompletedAction(customEventName)`
`111`	`111`	`} else {`
`112`		`- branch?.userCompletedAction(customEventName, withState: customEventMetadata)`
	`112`	`+ branch.userCompletedAction(customEventName, withState: customEventMetadata)`
`113`	`113`	`}`
`114`	`114`	`self.showAlert(String(format: "Custom event '%@' dispatched", customEventName), withDescription: "")`
`115`	`115`	`}`