Merge pull request #420 from BranchMetrics/spotlight

AIS-47 - Spotlight

Author: ahmednawar

Branch-SDK/Branch-SDK/BNCContentDiscoveryManager.h

@@ -8,7 +8,7 @@
 
 #import "Branch.h"
 
-@interface BNCContentDiscoveryManager : NSObject
+@interface BNCContentDiscoveryManager : NSObject<NSUserActivityDelegate>
 
 - (NSString *)spotlightIdentifierFromActivity:(NSUserActivity *)userActivity;
 - (NSString *)standardSpotlightIdentifierFromActivity:(NSUserActivity *)userActivity;

Branch-SDK/Branch-SDK/BNCContentDiscoveryManager.m

@@ -30,7 +30,7 @@
 
 @interface BNCContentDiscoveryManager ()
 
-@property (strong, nonatomic) NSUserActivity *currentUserActivity;
+@property (strong, nonatomic) NSMutableDictionary *userInfo;
 
 @end
 
@@ -40,18 +40,14 @@ @implementation BNCContentDiscoveryManager
 
 - (NSString *)spotlightIdentifierFromActivity:(NSUserActivity *)userActivity {
 #if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 90000
-    if ([userActivity.activityType hasPrefix:BRANCH_SPOTLIGHT_PREFIX]) {
-        return userActivity.activityType;
-    }
+    // If it has our prefix, then the link identifier is just the last piece of the identifier.
+    NSString *activityIdentifier = userActivity.userInfo[CSSearchableItemActivityIdentifier];
+    BOOL isBranchIdentifier = [activityIdentifier hasPrefix:BRANCH_SPOTLIGHT_PREFIX];
 
-    // CoreSpotlight version. Matched if it has our prefix, then the link identifier is just the last piece of the identifier.
-    if ([userActivity.activityType isEqualToString:CSSearchableItemActionType]) {
-        NSString *activityIdentifier = userActivity.userInfo[CSSearchableItemActivityIdentifier];
-        BOOL isBranchIdentifier = [activityIdentifier hasPrefix:BRANCH_SPOTLIGHT_PREFIX];
-        
-        if (isBranchIdentifier) {
-            return activityIdentifier;
-        }
+    // Checking for CSSearchableItemActionType in the activity for legacy spotlight indexing (pre 0.12.7)
+    // Now we index NSUserActivies with type set to io.branch. + bundleId for better SEO
+    if ([userActivity.activityType isEqualToString:CSSearchableItemActionType] || isBranchIdentifier) {
+        return activityIdentifier;
     }
 #endif
 
@@ -60,16 +56,14 @@ - (NSString *)spotlightIdentifierFromActivity:(NSUserActivity *)userActivity {
 
 - (NSString *)standardSpotlightIdentifierFromActivity:(NSUserActivity *)userActivity {
 #if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 90000
-    // CoreSpotlight version. Matched if it has our prefix, then the link identifier is just the last piece of the identifier.
-    if ([userActivity.activityType isEqualToString:CSSearchableItemActionType] && userActivity.userInfo[CSSearchableItemActivityIdentifier]) {
+    if (userActivity.userInfo[CSSearchableItemActivityIdentifier]) {
         return userActivity.userInfo[CSSearchableItemActivityIdentifier];
     }
 #endif
 
     return nil;
 }
 
-
 #pragma mark - Content Indexing
 
 - (void)indexContentWithTitle:(NSString *)title
@@ -431,8 +425,6 @@ - (void)indexContentWithUrl:(NSString *)url spotlightIdentifier:(NSString *)spot
     attributes = ((id (*)(id, SEL, NSString *))[attributes methodForSelector:initAttributesSelector])(attributes, initAttributesSelector, type);
     SEL setIdentifierSelector = NSSelectorFromString(@"setIdentifier:");
     ((void (*)(id, SEL, NSString *))[attributes methodForSelector:setIdentifierSelector])(attributes, setIdentifierSelector, spotlightIdentifier);
-    SEL setRelatedUniqueIdentifierSelector = NSSelectorFromString(@"setRelatedUniqueIdentifier:");
-    ((void (*)(id, SEL, NSString *))[attributes methodForSelector:setRelatedUniqueIdentifierSelector])(attributes, setRelatedUniqueIdentifierSelector, spotlightIdentifier);
     SEL setTitleSelector = NSSelectorFromString(@"setTitle:");
     ((void (*)(id, SEL, NSString *))[attributes methodForSelector:setTitleSelector])(attributes, setTitleSelector, title);
     SEL setContentDescriptionSelector = NSSelectorFromString(@"setContentDescription:");
@@ -441,65 +433,86 @@ - (void)indexContentWithUrl:(NSString *)url spotlightIdentifier:(NSString *)spot
     ((void (*)(id, SEL, NSURL *))[attributes methodForSelector:setThumbnailURLSelector])(attributes, setThumbnailURLSelector, thumbnailUrl);
     SEL setThumbnailDataSelector = NSSelectorFromString(@"setThumbnailData:");
     ((void (*)(id, SEL, NSData *))[attributes methodForSelector:setThumbnailDataSelector])(attributes, setThumbnailDataSelector, thumbnailData);
+    // NSUserActivity.CSSearchableItemAttributeSet.contentURL
     SEL setContentURLSelector = NSSelectorFromString(@"setContentURL:");
     ((void (*)(id, SEL, NSURL *))[attributes methodForSelector:setContentURLSelector])(attributes, setContentURLSelector, [NSURL URLWithString:url]);
 
-    // Index via the NSUserActivity strategy
-    // Currently (iOS 9 Beta 4) we need a strong reference to this, or it isn't indexed
-    self.currentUserActivity = [[NSUserActivity alloc] initWithActivityType:spotlightIdentifier];
-    self.currentUserActivity.title = title;
-    self.currentUserActivity.webpageURL = [NSURL URLWithString:url]; // This should allow indexed content to fall back to the web if user doesn't have the app installed. Unable to test as of iOS 9 Beta 4
-    self.currentUserActivity.eligibleForSearch = YES;
-    self.currentUserActivity.eligibleForPublicIndexing = publiclyIndexable;
-    SEL setContentAttributeSetSelector = NSSelectorFromString(@"setContentAttributeSet:");
-    ((void (*)(id, SEL, id))[self.currentUserActivity methodForSelector:setContentAttributeSetSelector])(self.currentUserActivity, setContentAttributeSetSelector, attributes);
-    self.currentUserActivity.userInfo = userInfo; // As of iOS 9 Beta 4, this gets lost and never makes it through to application:continueActivity:restorationHandler:
-    self.currentUserActivity.requiredUserInfoKeys = [NSSet setWithArray:userInfo.allKeys]; // This, however, seems to force the userInfo to come through.
-    self.currentUserActivity.keywords = keywords;
-    [self.currentUserActivity becomeCurrent];
+    NSDictionary *userActivityIndexingParams = @{@"title": title,
+                                                 @"url": url,
+                                                 @"spotlightId": spotlightIdentifier,
+                                                 @"userInfo": [userInfo mutableCopy],
+                                                 @"keywords": keywords,
+                                                 @"publiclyIndexable": [NSNumber numberWithBool:publiclyIndexable],
+                                                 @"attributeSet": attributes
+                                                 };
+    [self indexUsingNSUserActivity:userActivityIndexingParams];
 
-    // Index via the CoreSpotlight strategy
-    //get the CSSearchableItem Class object
-    id CSSearchableItemClass = NSClassFromString(@"CSSearchableItem");
-    //alloc an empty instance
-    id searchableItem = [CSSearchableItemClass alloc];
-    //create-by-name a selector fot the init method we want
-    SEL initItemSelector = NSSelectorFromString(@"initWithUniqueIdentifier:domainIdentifier:attributeSet:");
-    //call the selector on the searchableItem with appropriate arguments
-    searchableItem = ((id (*)(id, SEL, NSString *, NSString *, id))[searchableItem methodForSelector:initItemSelector])(searchableItem, initItemSelector, spotlightIdentifier, BRANCH_SPOTLIGHT_PREFIX, attributes);
-  
-    //create an assignment method to set the expiration date on the searchableItem
-    SEL expirationSelector = NSSelectorFromString(@"setExpirationDate:");
-    //now invoke it on the searchableItem, providing the expirationdate
-    ((void (*)(id, SEL, NSDate *))[searchableItem methodForSelector:expirationSelector])(searchableItem, expirationSelector, expirationDate);
-  
-
-    Class CSSearchableIndexClass = NSClassFromString(@"CSSearchableIndex");
-    SEL defaultSearchableIndexSelector = NSSelectorFromString(@"defaultSearchableIndex");
-    id defaultSearchableIndex = ((id (*)(id, SEL))[CSSearchableIndexClass methodForSelector:defaultSearchableIndexSelector])(CSSearchableIndexClass, defaultSearchableIndexSelector);
-    SEL indexSearchableItemsSelector = NSSelectorFromString(@"indexSearchableItems:completionHandler:");
-    void (^__nullable completionBlock)(NSError *indexError) = ^void(NSError *__nullable indexError) {
-        if (callback || spotlightCallback) {
-            if (indexError) {
-                if (callback) {
-                    callback([BNCPreferenceHelper preferenceHelper].userUrl, indexError);
-                }
-                else if (spotlightCallback) {
-                    spotlightCallback(nil, nil, indexError);
-                }
-            }
-            else {
-                if (callback) {
-                    callback(url, nil);
-                }
-                else if (spotlightCallback) {
-                    spotlightCallback(url, spotlightIdentifier, nil);
-                }
-            }
+    // Not handling error scenarios because they are already handled upstream by the caller
+    if (url) {
+        if (callback) {
+            callback(url, nil);
+        } else if (spotlightCallback) {
+            spotlightCallback(url, spotlightIdentifier, nil);
         }
-    };
-    ((void (*)(id, SEL, NSArray *, void (^ __nullable)(NSError * __nullable error)))[defaultSearchableIndex methodForSelector:indexSearchableItemsSelector])(defaultSearchableIndex, indexSearchableItemsSelector, @[searchableItem], completionBlock);
+    }
 #endif
 }
 
+#pragma mark Delegate Methods
+
+- (void)userActivityWillSave:(NSUserActivity *)userActivity {
+    [userActivity addUserInfoEntriesFromDictionary:self.userInfo];
+}
+
+#pragma mark Helper Methods
+
+- (UIViewController *)getActiveViewController {
+    Class UIApplicationClass = NSClassFromString(@"UIApplication");
+    if (UIApplicationClass) {
+        UIViewController *rootViewController = [UIApplication sharedApplication].keyWindow.rootViewController;
+        return [self getActiveViewController:rootViewController];
+    }
+    
+    return nil;
+}
+
+- (UIViewController *)getActiveViewController:(UIViewController *)rootViewController {
+    UIViewController *activeController;
+    if ([rootViewController isKindOfClass:[UINavigationController class]]) {
+        activeController = ((UINavigationController *)rootViewController).topViewController;
+    } else if ([rootViewController isKindOfClass:[UITabBarController class]]) {
+        activeController = ((UITabBarController *)rootViewController).selectedViewController;
+    } else {
+        activeController = rootViewController;
+    }
+    return activeController;
+}
+
+- (void)indexUsingNSUserActivity:(NSDictionary *)params {
+    self.userInfo = params[@"userInfo"];
+    self.userInfo[CSSearchableItemActivityIdentifier] = params[@"spotlightId"];
+    
+    UIViewController *activeViewController = [self getActiveViewController];
+    
+    if (!activeViewController) {
+        // if no view controller, don't index. Current use case: iMessage extensions
+        return;
+    }
+    NSString *uniqueIdentifier = [NSString stringWithFormat:@"io.branch.%@", [[NSBundle mainBundle] bundleIdentifier]];
+    // Can't create any weak references here to the userActivity, otherwise it will not index.
+    activeViewController.userActivity = [[NSUserActivity alloc] initWithActivityType:uniqueIdentifier];
+    activeViewController.userActivity.delegate = self;
+    activeViewController.userActivity.title = params[@"title"];
+    activeViewController.userActivity.webpageURL = [NSURL URLWithString:params[@"url"]];
+    activeViewController.userActivity.eligibleForSearch = YES;
+    activeViewController.userActivity.eligibleForPublicIndexing = params[@"publiclyIndexable"];
+    activeViewController.userActivity.userInfo = self.userInfo; // This alone doesn't pass userInfo through
+    activeViewController.userActivity.requiredUserInfoKeys = [NSSet setWithArray:self.userInfo.allKeys]; // This along with the delegate method userActivityWillSave, however, seem to force the userInfo to come through.
+    activeViewController.userActivity.keywords = params[@"keywords"];
+    SEL setContentAttributeSetSelector = NSSelectorFromString(@"setContentAttributeSet:");
+    ((void (*)(id, SEL, id))[activeViewController.userActivity methodForSelector:setContentAttributeSetSelector])(activeViewController.userActivity, setContentAttributeSetSelector, params[@"attributeSet"]);
+
+    [activeViewController.userActivity becomeCurrent];
+}
+
 @end

Branch-SDK/Branch-SDK/Branch.m

@@ -406,7 +406,7 @@ - (BOOL)continueUserActivity:(NSUserActivity *)userActivity {
         return NO;
     }
 
-    //check to see if a spotlight activity needs to be handled
+    // Check to see if a spotlight activity needs to be handled
     NSString *spotlightIdentifier = [self.contentDiscoveryManager spotlightIdentifierFromActivity:userActivity];
 
     if (spotlightIdentifier) {
@@ -418,6 +418,7 @@ - (BOOL)continueUserActivity:(NSUserActivity *)userActivity {
             self.preferenceHelper.spotlightIdentifier = nonBranchSpotlightIdentifier;
         }
     }
+    
     [self initUserSessionAndCallCallback:YES];
     self.preferenceHelper.shouldWaitForInit = NO;
 
@@ -1325,4 +1326,4 @@ + (NSString *)kitDisplayVersion {
 	return @"0.12.6";
 }
 
-@end
+@end

Branch-SDK/Branch-SDK/BranchUniversalObject.h

@@ -34,6 +34,7 @@ typedef NS_ENUM(NSInteger, ContentIndexMode) {
 @property (nonatomic, strong) NSString *spotlightIdentifier;
 @property (nonatomic, assign) CGFloat price;
 @property (nonatomic, strong) NSString *currency;
+@property (nonatomic, assign) BOOL automaticallyListOnSpotlight;
 
 
 - (instancetype)initWithCanonicalIdentifier:(NSString *)canonicalIdentifier;
@@ -59,7 +60,7 @@ typedef NS_ENUM(NSInteger, ContentIndexMode) {
 
 - (void)listOnSpotlight;
 - (void)listOnSpotlightWithCallback:(callbackWithUrl)callback;
-- (void)listOnSpotlightWithIdentifierCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback;
+- (void)listOnSpotlightWithIdentifierCallback:(callbackWithUrlAndSpotlightIdentifier)spotlightCallback __attribute__((deprecated(("iOS 10 has changed how Spotlight indexing works and we’ve updated the SDK to reflect this. Please see https://dev.branch.io/features/spotlight-indexing/overview/ for instructions on migration"))));;
 
 // Convenience method for initSession methods that return BranchUniversalObject, but can be used safely by anyone.
 + (BranchUniversalObject *)getBranchUniversalObjectFromDictionary:(NSDictionary *)dictionary;

Branch-SDK/Branch-SDK/BranchUniversalObject.m

@@ -49,13 +49,7 @@ - (void)addMetadataKey:(NSString *)key value:(NSString *)value {
 }
 
 - (void)registerView {
-    if (!self.canonicalIdentifier && !self.title) {
-        [_preferenceHelper logWarning:@"A canonicalIdentifier or title are required to uniquely identify content, so could not register view."];
-        return;
-    }
-    
-    [[Branch getInstance] registerViewWithParams:[self getParamsForServerRequest]
-                                     andCallback:nil];
+    [self registerViewWithCallback:nil];
 }
 
 - (void)registerViewWithCallback:(callbackWithParams)callback {
@@ -71,6 +65,9 @@ - (void)registerViewWithCallback:(callbackWithParams)callback {
         return;
     }
 
+    if (self.automaticallyListOnSpotlight) {
+        [self listOnSpotlight];
+    }
     [[Branch getInstance] registerViewWithParams:[self getParamsForServerRequest] andCallback:callback];
 }
 
@@ -81,6 +78,9 @@ - (void)userCompletedAction:(NSString *)action {
     actionPayload[self.canonicalIdentifier] = linkParams;
 
     [[Branch getInstance] userCompletedAction:action withState:actionPayload];
+    if (self.automaticallyListOnSpotlight && [action isEqualToString:BNCRegisterViewEvent]) {
+        [self listOnSpotlight];
+    }
 }
 
 #pragma mark - Link Creation Methods
@@ -168,6 +168,8 @@ - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties
     [self showShareSheetWithLinkProperties:linkProperties andShareText:shareText fromViewController:viewController anchor:nil completion:completion];
 }
 - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties andShareText:(NSString *)shareText fromViewController:(UIViewController *)viewController anchor:(UIBarButtonItem *)anchor completion:(shareCompletion)completion {
+    // Log share initiated event
+    [self userCompletedAction:BNCShareInitiatedEvent];
     UIActivityItemProvider *itemProvider = [self getBranchActivityItemWithLinkProperties:linkProperties];
     NSMutableArray *items = [NSMutableArray arrayWithObject:itemProvider];
     if (shareText) {
@@ -177,6 +179,8 @@ - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties
 
     if ([shareViewController respondsToSelector:@selector(completionWithItemsHandler)]) {
         shareViewController.completionWithItemsHandler = ^(NSString *activityType, BOOL completed, NSArray *returnedItems, NSError *activityError) {
+            // Log share completed event
+            [self userCompletedAction:BNCShareCompletedEvent];
             if (completion) {
                 completion(activityType, completed);
                 [BNCFabricAnswers sendEventWithName:@"Branch Share" andAttributes:[self getDictionaryWithCompleteLinkProperties:linkProperties]];

Branch-TestBed/Branch-TestBed/AppDelegate.m

@@ -69,7 +69,7 @@ - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceAppl
 
 
 - (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *))restorationHandler {
-    NSLog(@"application:continueUserActivity:restorationHandler: invoked. userActivity.webpageURL if any: %@", userActivity.webpageURL.absoluteString);
+    NSLog(@"application:continueUserActivity:restorationHandler: invoked. activityType: %@ userActivity.webpageURL: %@", userActivity.activityType, userActivity.webpageURL.absoluteString);
 
     // Required. Returns YES if Branch Universal Link, else returns NO. Add `branch_universal_link_domains` to .plist (String or Array) for custom domain(s).
     [[Branch getInstance] continueUserActivity:userActivity];

Branch-TestBed/Branch-TestBed/ViewController.m

@@ -199,18 +199,6 @@ - (IBAction)shareLinkButtonTouchUpInside:(id)sender {
 }
 
 
-/*
- - (IBAction)cmdIndexSpotlight:(id)sender {
- [self.branchUniversalObject listOnSpotlightWithCallback:^(NSString *url, NSError *error) {
- if (!error) {
- NSLog(@"Branch TestBed: ShortURL: %@", url);
- } else {
- NSLog(@"Branch TestBed: Error: %@", error);
- }
- }];
- }*/
-
-
 //example using callbackWithURLandSpotlightIdentifier
 - (IBAction)registerWithSpotlightButtonTouchUpInside:(id)sender {
     [self.branchUniversalObject addMetadataKey:@"deeplink_text" value:@"This link was generated for Spotlight registration"];