Merge pull request #358 from BranchMetrics/check-fb-app-links-client-side

aaustin · aaustin · commit f3026493682d · 2016-05-24T09:58:55.000-07:00
Check fb app links client side
diff --git a/Branch-SDK/Branch-SDK/BNCPreferenceHelper.h b/Branch-SDK/Branch-SDK/BNCPreferenceHelper.h
@@ -31,8 +31,9 @@
 @property (assign, nonatomic) BOOL explicitlyRequestedReferrable;
 @property (assign, nonatomic) BOOL isReferrable;
 @property (assign, nonatomic) BOOL isDebug;
-@property (assign, nonatomic) BOOL isContinuingUserActivity;
+@property (assign, nonatomic) BOOL shouldWaitForInit;
 @property (assign, nonatomic) BOOL suppressWarningLogs;
+@property (assign, nonatomic) BOOL checkedFacebookAppLinks;
 @property (assign, nonatomic) NSInteger retryCount;
 @property (assign, nonatomic) NSTimeInterval retryInterval;
 @property (assign, nonatomic) NSTimeInterval timeout;
diff --git a/Branch-SDK/Branch-SDK/BNCPreferenceHelper.m b/Branch-SDK/Branch-SDK/BNCPreferenceHelper.m
@@ -25,6 +25,7 @@
 NSString * const BRANCH_PREFS_KEY_SESSION_ID = @"bnc_session_id";
 NSString * const BRANCH_PREFS_KEY_IDENTITY_ID = @"bnc_identity_id";
 NSString * const BRANCH_PREFS_KEY_IDENTITY = @"bnc_identity";
+NSString * const BRANCH_PREFS_KEY_CHECKED_FACEBOOK_APP_LINKS = @"bnc_checked_fb_app_links";
 NSString * const BRANCH_PREFS_KEY_LINK_CLICK_IDENTIFIER = @"bnc_link_click_identifier";
 NSString * const BRANCH_PREFS_KEY_SPOTLIGHT_IDENTIFIER = @"bnc_spotlight_identifier";
 NSString * const BRANCH_PREFS_KEY_UNIVERSAL_LINK_URL = @"bnc_universal_link_url";
@@ -73,12 +74,13 @@ @implementation BNCPreferenceHelper
             externalIntentURI = _externalIntentURI,
             isReferrable = _isReferrable,
             isDebug = _isDebug,
-            isContinuingUserActivity = _isContinuingUserActivity,
+            shouldWaitForInit = _shouldWaitForInit,
             suppressWarningLogs = _suppressWarningLogs,
             retryCount = _retryCount,
             retryInterval = _retryInterval,
             timeout = _timeout,
             lastStrongMatchDate = _lastStrongMatchDate,
+            checkedFacebookAppLinks = _checkedFacebookAppLinks,
             requestMetadataDictionary = _requestMetadataDictionary;
 
 + (BNCPreferenceHelper *)preferenceHelper {
@@ -421,6 +423,16 @@ - (void)setUserUrl:(NSString *)userUrl {
     }
 }
 
+- (BOOL)checkedFacebookAppLinks {
+    _checkedFacebookAppLinks = [self readBoolFromDefaults:BRANCH_PREFS_KEY_CHECKED_FACEBOOK_APP_LINKS];
+    return _checkedFacebookAppLinks;
+}
+
+- (void)setCheckedFacebookAppLinks:(BOOL)checked {
+    _checkedFacebookAppLinks = checked;
+    [self writeBoolToDefaults:BRANCH_PREFS_KEY_CHECKED_FACEBOOK_APP_LINKS value:checked];
+}
+
 - (BOOL)isReferrable {
     BOOL hasIdentity = self.identityID != nil;
     
diff --git a/Branch-SDK/Branch-SDK/Branch.h b/Branch-SDK/Branch-SDK/Branch.h
@@ -382,9 +382,16 @@ typedef NS_ENUM(NSUInteger, BranchPromoCodeUsageType) {
  
  @param debugParams dictionary of keystrings/valuestrings that will be added to response 
  */
--(void) setDeepLinkDebugMode:(NSDictionary *)debugParams;
+-(void)setDeepLinkDebugMode:(NSDictionary *)debugParams;
 
 
+/**
+ Register your Facebook SDK's FBSDKAppLinkUtility class to be used by Branch for deferred deep linking from their platform
+ 
+ @param FBSDKAppLinkUtility - call [FBSDKAppLinkUtility class] after importing #import <FBSDKCoreKit/FBSDKCoreKit.h>
+ */
+- (void)registerFacebookDeepLinkingClass:(id)FBSDKAppLinkUtility;
+
 /**
  Specify the time to wait in seconds between retries in the case of a Branch server error
  
diff --git a/Branch-SDK/Branch-SDK/Branch.m b/Branch-SDK/Branch-SDK/Branch.m
@@ -85,7 +85,7 @@ @interface Branch() <BranchDeepLinkingControllerCompletionDelegate, FABKit>
 @property (assign, nonatomic) BOOL useCookieBasedMatching;
 @property (strong, nonatomic) NSDictionary *deepLinkDebugParams;
 @property (assign, nonatomic) BOOL accountForFacebookSDK;
-
+@property (assign, nonatomic) id FBSDKAppLinkUtility;
 
 @end
 
@@ -340,16 +340,20 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)
     
     if ([BNCSystemObserver getOSVersion].integerValue >= 8) {
         if (![options objectForKey:UIApplicationLaunchOptionsURLKey] && ![options objectForKey:UIApplicationLaunchOptionsUserActivityDictionaryKey]) {
-            [self initUserSessionAndCallCallback:YES];
+            // If Facebook SDK is present, call deferred app link check here
+            if (![self checkFacebookAppLinks]) {
+                [self initUserSessionAndCallCallback:YES];
+            }
         }
         else if ([options objectForKey:UIApplicationLaunchOptionsUserActivityDictionaryKey]) {
-            self.preferenceHelper.isContinuingUserActivity = YES;
             if (self.accountForFacebookSDK) {
                 id activity = [[options objectForKey:UIApplicationLaunchOptionsUserActivityDictionaryKey] objectForKey:@"UIApplicationLaunchOptionsUserActivityKey"];
                 if (activity && [activity isKindOfClass:[NSUserActivity class]]) {
                     [self continueUserActivity:activity];
+                    return;
                 }
             }
+            self.preferenceHelper.shouldWaitForInit = YES;
         }
     }
     else if (![options objectForKey:UIApplicationLaunchOptionsURLKey]) {
@@ -367,7 +371,7 @@ - (void) setDeepLinkDebugMode:(NSDictionary *)debugParams {
 
 - (BOOL)handleDeepLink:(NSURL *)url {
     BOOL handled = NO;
-    if (url) {
+    if (url && ![url isEqual:[NSNull null]]) {
         //always save the incoming url in the preferenceHelper in the externalIntentURI field
         self.preferenceHelper.externalIntentURI = [url absoluteString];
 
@@ -393,7 +397,7 @@ - (BOOL)continueUserActivity:(NSUserActivity *)userActivity {
     if ([userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb]) {
         self.preferenceHelper.universalLinkUrl = [userActivity.webpageURL absoluteString];
         [self initUserSessionAndCallCallback:YES];
-        self.preferenceHelper.isContinuingUserActivity = NO;
+        self.preferenceHelper.shouldWaitForInit = NO;
         
         id branchUniversalLinkDomains = [self.preferenceHelper getBranchUniversalLinkDomains];
         if ([branchUniversalLinkDomains isKindOfClass:[NSString class]] && [[userActivity.webpageURL absoluteString] containsString:branchUniversalLinkDomains]) {
@@ -430,7 +434,7 @@ - (BOOL)continueUserActivity:(NSUserActivity *)userActivity {
         }
     }
     [self initUserSessionAndCallCallback:YES];
-    self.preferenceHelper.isContinuingUserActivity = NO;
+    self.preferenceHelper.shouldWaitForInit = NO;
     
     return spotlightIdentifier != nil;
 }
@@ -466,6 +470,33 @@ - (void)handlePushNotification:(NSDictionary *) userInfo {
     }
 }
 
+# pragma mark - Facebook App Link check
+
+- (void)registerFacebookDeepLinkingClass:(id)FBSDKAppLinkUtility {
+    self.FBSDKAppLinkUtility = FBSDKAppLinkUtility;
+}
+
+- (BOOL)checkFacebookAppLinks {
+    if (self.FBSDKAppLinkUtility) {
+        SEL fetchDeferredAppLink = NSSelectorFromString(@"fetchDeferredAppLink:");
+        
+        if ([self.FBSDKAppLinkUtility methodForSelector:fetchDeferredAppLink]) {
+            void (^__nullable completionBlock)(NSURL *appLink, NSError *error) = ^void(NSURL *__nullable appLink, NSError *__nullable error) {
+                self.preferenceHelper.shouldWaitForInit = NO;
+                [self handleDeepLink:appLink];
+            };
+        
+            self.preferenceHelper.checkedFacebookAppLinks = YES;
+            self.preferenceHelper.shouldWaitForInit = YES;
+        
+            ((void (*)(id, SEL, void (^ __nullable)(NSURL *__nullable appLink, NSError * __nullable error)))[self.FBSDKAppLinkUtility methodForSelector:fetchDeferredAppLink])(self.FBSDKAppLinkUtility, fetchDeferredAppLink, completionBlock);
+        
+            return YES;
+        }
+    }
+    
+    return NO;
+}
 
 #pragma mark - Deep Link Controller methods
 
@@ -1204,7 +1235,7 @@ - (void)registerViewWithParams:(NSDictionary *)params andCallback:(callbackWithP
 #pragma mark - Application State Change methods
 
 - (void)applicationDidBecomeActive {
-    if (!self.isInitialized && !self.preferenceHelper.isContinuingUserActivity && ![self.requestQueue containsInstallOrOpen]) {
+    if (!self.isInitialized && !self.preferenceHelper.shouldWaitForInit && ![self.requestQueue containsInstallOrOpen]) {
         [self initUserSessionAndCallCallback:YES];
     }
 }
@@ -1320,7 +1351,7 @@ - (void)processNextQueueItem {
 #pragma mark - Session Initialization
 
 - (void)initSessionIfNeededAndNotInProgress {
-    if (!self.isInitialized && !self.preferenceHelper.isContinuingUserActivity && ![self.requestQueue containsInstallOrOpen]) {
+    if (!self.isInitialized && !self.preferenceHelper.shouldWaitForInit && ![self.requestQueue containsInstallOrOpen]) {
         [self initUserSessionAndCallCallback:NO];
     }
 }
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.h b/Branch-SDK/Branch-SDK/BranchConstants.h
@@ -51,6 +51,7 @@ extern NSString * const BRANCH_REQUEST_KEY_OS;
 extern NSString * const BRANCH_REQUEST_KEY_OS_VERSION;
 extern NSString * const BRANCH_REQUEST_KEY_URI_SCHEME;
 extern NSString * const BRANCH_REQUEST_KEY_UPDATE;
+extern NSString * const BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS;
 extern NSString * const BRANCH_REQUEST_KEY_LINK_IDENTIFIER;
 extern NSString * const BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER;
 extern NSString * const BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL;
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.m b/Branch-SDK/Branch-SDK/BranchConstants.m
@@ -52,6 +52,7 @@
 NSString * const BRANCH_REQUEST_KEY_URI_SCHEME = @"uri_scheme";
 NSString * const BRANCH_REQUEST_KEY_UPDATE = @"update";
 NSString * const BRANCH_REQUEST_KEY_LINK_IDENTIFIER = @"link_identifier";
+NSString * const BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS = @"facebook_app_link_checked";
 NSString * const BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER = @"spotlight_identifier";
 NSString * const BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL = @"universal_link_url";
 NSString * const BRANCH_REQUEST_KEY_BRAND = @"brand";
diff --git a/Branch-SDK/Branch-SDK/Requests/BranchInstallRequest.m b/Branch-SDK/Branch-SDK/Requests/BranchInstallRequest.m
@@ -28,6 +28,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:[BNCSystemObserver getAppVersion] forKey:BRANCH_REQUEST_KEY_APP_VERSION onDict:params];
     [self safeSetValue:[BNCSystemObserver getDefaultUriScheme] forKey:BRANCH_REQUEST_KEY_URI_SCHEME onDict:params];
     [self safeSetValue:[BNCSystemObserver getUpdateState] forKey:BRANCH_REQUEST_KEY_UPDATE onDict:params];
+    [self safeSetValue:[NSNumber numberWithBool:preferenceHelper.checkedFacebookAppLinks] forKey:BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS onDict:params];
     [self safeSetValue:preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
diff --git a/Branch-SDK/Branch-SDK/Requests/BranchOpenRequest.m b/Branch-SDK/Branch-SDK/Requests/BranchOpenRequest.m
@@ -51,6 +51,7 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:[BNCSystemObserver getAppVersion] forKey:BRANCH_REQUEST_KEY_APP_VERSION onDict:params];        
     [self safeSetValue:[BNCSystemObserver getDefaultUriScheme] forKey:BRANCH_REQUEST_KEY_URI_SCHEME onDict:params];
     [self safeSetValue:[BNCSystemObserver getUpdateState] forKey:BRANCH_REQUEST_KEY_UPDATE onDict:params];
+    [self safeSetValue:[NSNumber numberWithBool:preferenceHelper.checkedFacebookAppLinks] forKey:BRANCH_REQUEST_KEY_CHECKED_FACEBOOK_APPLINKS onDict:params];
     [self safeSetValue:preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
@@ -108,6 +109,7 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
     }
     
     // Clear link identifiers so they don't get reused on the next open
+    preferenceHelper.checkedFacebookAppLinks = NO;
     preferenceHelper.linkClickIdentifier = nil;
     preferenceHelper.spotlightIdentifier = nil;
     preferenceHelper.universalLinkUrl = nil;
