Fixed Branch Universal Object & Update UITestBed (#768)

* Updated the UITestBed for better link testing.
* Fixed expired link generation. Fixed split view.
* Need to fix how BUO dictionaries are merged.
* Checked BUO compatibility with Android.
* Fixed unit test.

Author: E-B-Smith

Branch-SDK/Branch-SDK/Branch.h

@@ -124,7 +124,6 @@ extern NSString * const BNCCanonicalIdList;
 extern NSString * const BNCPurchaseAmount;
 extern NSString * const BNCPurchaseCurrency;
 extern NSString * const BNCCanonicalIdList;
-extern NSString * const BNCPurchaseAmount;
 extern NSString * const BNCRegisterViewEvent;
 extern NSString * const BNCAddToWishlistEvent;
 extern NSString * const BNCAddToCartEvent;

Branch-SDK/Branch-SDK/Branch.m

@@ -1174,7 +1174,7 @@ - (void)getCreditHistoryForBucket:(NSString *)bucket after:(NSString *)creditTra
 - (BranchUniversalObject *)getFirstReferringBranchUniversalObject {
     NSDictionary *params = [self getFirstReferringParams];
     if ([[params objectForKey:BRANCH_INIT_KEY_CLICKED_BRANCH_LINK] isEqual:@1]) {
-        return [BranchUniversalObject getBranchUniversalObjectFromDictionary:params];
+        return [BranchUniversalObject objectWithDictionary:params];
     }
     return nil;
 }
@@ -1221,7 +1221,7 @@ - (NSDictionary*) getLatestReferringParamsSynchronous {
 - (BranchUniversalObject *)getLatestReferringBranchUniversalObject {
     NSDictionary *params = [self getLatestReferringParams];
     if ([[params objectForKey:BRANCH_INIT_KEY_CLICKED_BRANCH_LINK] isEqual:@1]) {
-        return [BranchUniversalObject getBranchUniversalObjectFromDictionary:params];
+        return [BranchUniversalObject objectWithDictionary:params];
     }
     return nil;
 }
@@ -1670,7 +1670,7 @@ - (NSString *)generateShortUrl:(NSArray *)tags
                 linkCache:self.linkCache];
 
         if (self.isInitialized) {
-            BNCLogDebug(@"Created a custom URL synchronously.");
+            BNCLogDebug(@"Creating a custom URL synchronously.");
             BNCServerResponse *serverResponse = [req makeRequest:self.serverInterface key:self.class.branchKey];
             shortURL = [req processResponse:serverResponse];
 
@@ -2205,10 +2205,8 @@ - (void) sendOpenNotificationWithLinkParameters:(NSDictionary*)linkParameters
 
     NSNumber *isBranchLink = linkParameters[BRANCH_INIT_KEY_CLICKED_BRANCH_LINK];
     if ([isBranchLink boolValue]) {
-        universalObject =
-            [BranchUniversalObject getBranchUniversalObjectFromDictionary:linkParameters];
-        linkProperties =
-            [BranchLinkProperties getBranchLinkPropertiesFromDictionary:linkParameters];
+        universalObject = [BranchUniversalObject objectWithDictionary:linkParameters];
+        linkProperties = [BranchLinkProperties getBranchLinkPropertiesFromDictionary:linkParameters];
     }
 
     if (error) {

Branch-SDK/Branch-SDK/BranchUniversalObject.h

@@ -239,14 +239,11 @@ FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionRefurbished;
 
 - (void)removeFromSpotlightWithCallback:(void (^_Nullable)(NSError * _Nullable error))completion;
 
-/// Convenience method for initSession methods that return BranchUniversalObject, but can be used safely by anyone.
-+ (nonnull BranchUniversalObject *)getBranchUniversalObjectFromDictionary:(nonnull NSDictionary *)dictionary;
-
-- (NSDictionary*_Nonnull)getParamsForServerRequest;
 - (NSDictionary*_Nonnull)getDictionaryWithCompleteLinkProperties:(BranchLinkProperties*_Nonnull)linkProperties;
 - (NSDictionary*_Nonnull)getParamsForServerRequestWithAddedLinkProperties:(BranchLinkProperties*_Nonnull)linkProperties;
 
-- (NSDictionary*_Nonnull) dictionary;
+/// Convenience method for initSession methods that return BranchUniversalObject, but can be used safely by anyone.
+- (NSMutableDictionary*_Nonnull) dictionary;
 + (BranchUniversalObject*_Nonnull) objectWithDictionary:(NSDictionary*_Null_unspecified)dictionary;
 
 - (NSString*_Nonnull) description;

Branch-SDK/Branch-SDK/BranchUniversalObject.m

@@ -305,7 +305,7 @@ - (void)userCompletedAction:(NSString *)action withState:(NSDictionary *)state {
     [[BranchEvent customEventWithName:action contentItem:self] logEvent];
 
     // Maybe list on spotlight --
-    NSDictionary *linkParams = [self getParamsForServerRequest];
+    NSDictionary *linkParams = self.dictionary;
     if (self.locallyIndex && self.canonicalIdentifier && linkParams) {
 
         NSMutableDictionary *actionPayload = [[NSMutableDictionary alloc] init];
@@ -377,8 +377,20 @@ - (NSString *)getShortUrlWithLinkPropertiesAndIgnoreFirstClick:(BranchLinkProper
                               forceLinkCreation:YES];
 }
 
-- (NSString *)getLongUrlWithChannel:(NSString *)channel andTags:(NSArray *)tags andFeature:(NSString *)feature andStage:(NSString *)stage andAlias:(NSString *)alia{
-    return [[Branch getInstance] getLongURLWithParams:[self getParamsForServerRequest] andChannel:channel andTags:tags andFeature:feature andStage:stage andAlias:alia];
+- (NSString *)getLongUrlWithChannel:(NSString *)channel
+                            andTags:(NSArray *)tags
+                         andFeature:(NSString *)feature
+                           andStage:(NSString *)stage
+                           andAlias:(NSString *)alias {
+    NSString *urlString =
+        [[Branch getInstance]
+            getLongURLWithParams:self.dictionary
+            andChannel:channel
+            andTags:tags
+            andFeature:feature
+            andStage:stage
+            andAlias:alias];
+    return urlString;
 }
 
 #pragma mark - Share Sheets
@@ -596,85 +608,13 @@ - (void) removeFromSpotlightWithCallback:(void (^_Nullable)(NSError * _Nullable
     }
 }
 
-#pragma mark - Private methods
 #pragma mark - Dictionary Methods
 
-+ (BranchUniversalObject *)getBranchUniversalObjectFromDictionary:(NSDictionary *)dictionary {
-    BranchUniversalObject *universalObject = [[BranchUniversalObject alloc] init];
-    
-    // Build BranchUniversalObject base properties
-    universalObject.contentMetadata.customMetadata = [dictionary copy];
-    if (dictionary[BRANCH_LINK_DATA_KEY_CANONICAL_IDENTIFIER]) {
-        universalObject.canonicalIdentifier = dictionary[BRANCH_LINK_DATA_KEY_CANONICAL_IDENTIFIER];
-    }
-    if (dictionary[BRANCH_LINK_DATA_KEY_CANONICAL_URL]) {
-        universalObject.canonicalUrl = dictionary[BRANCH_LINK_DATA_KEY_CANONICAL_URL];
-    }
-    if (dictionary[BRANCH_LINK_DATA_KEY_OG_TITLE]) {
-        universalObject.title = dictionary[BRANCH_LINK_DATA_KEY_OG_TITLE];
-    }
-    if (dictionary[BRANCH_LINK_DATA_KEY_OG_DESCRIPTION]) {
-        universalObject.contentDescription = dictionary[BRANCH_LINK_DATA_KEY_OG_DESCRIPTION];
-    }
-    if (dictionary[BRANCH_LINK_DATA_KEY_OG_IMAGE_URL]) {
-        universalObject.imageUrl = dictionary[BRANCH_LINK_DATA_KEY_OG_IMAGE_URL];
-    }
-    universalObject.publiclyIndex = [dictionary[BRANCH_LINK_DATA_KEY_PUBLICLY_INDEXABLE] boolValue];
-    universalObject.locallyIndex  = [dictionary[BRANCH_LINK_DATA_KEY_LOCALLY_INDEXABLE] boolValue];
-
-    NSNumber *number = dictionary[BRANCH_LINK_DATA_KEY_CONTENT_EXPIRATION_DATE];
-    if ([number isKindOfClass:[NSNumber class]]) {
-        // Number is millisecondsSince1970
-        universalObject.expirationDate = [NSDate dateWithTimeIntervalSince1970:number.integerValue/1000];
-    }
-    if (dictionary[BRANCH_LINK_DATA_KEY_KEYWORDS]) {
-        universalObject.keywords = dictionary[BRANCH_LINK_DATA_KEY_KEYWORDS];
-    }
-    NSString *s = dictionary[BNCPurchaseAmount];
-    if (s) {
-        if ([s isKindOfClass:NSString.class])
-            universalObject.contentMetadata.price = [NSDecimalNumber decimalNumberWithString:s];
-        else
-        if ([s isKindOfClass:NSDecimalNumber.class])
-            universalObject.contentMetadata.price = (NSDecimalNumber*) s;
-        else
-        if ([s isKindOfClass:NSNumber.class]) {
-            s = [((NSNumber*)s) stringValue];
-            universalObject.contentMetadata.price = [NSDecimalNumber decimalNumberWithString:s];
-        }
-    }
-    if (dictionary[BNCPurchaseCurrency]) {
-        universalObject.contentMetadata.currency = dictionary[BNCPurchaseCurrency];
-    }
-    
-    if (dictionary[BRANCH_LINK_DATA_KEY_CONTENT_TYPE]) {
-        universalObject.contentMetadata.contentSchema = dictionary[BRANCH_LINK_DATA_KEY_CONTENT_TYPE];
-    }
-    return universalObject;
-}
-
-- (NSDictionary*_Nonnull) getParamsForServerRequest {
-    NSMutableDictionary *temp = [[NSMutableDictionary alloc] init];
-    [self safeSetValue:self.canonicalIdentifier forKey:BRANCH_LINK_DATA_KEY_CANONICAL_IDENTIFIER onDict:temp];
-    [self safeSetValue:self.canonicalUrl forKey:BRANCH_LINK_DATA_KEY_CANONICAL_URL onDict:temp];
-    [self safeSetValue:self.title forKey:BRANCH_LINK_DATA_KEY_OG_TITLE onDict:temp];
-    [self safeSetValue:self.contentDescription forKey:BRANCH_LINK_DATA_KEY_OG_DESCRIPTION onDict:temp];
-    [self safeSetValue:self.imageUrl forKey:BRANCH_LINK_DATA_KEY_OG_IMAGE_URL onDict:temp];
-    temp[BRANCH_LINK_DATA_KEY_PUBLICLY_INDEXABLE]  = [NSNumber numberWithBool:self.publiclyIndex];
-    temp[BRANCH_LINK_DATA_KEY_LOCALLY_INDEXABLE]   = [NSNumber numberWithBool:self.locallyIndex];
-    [self safeSetValue:self.keywords forKey:BRANCH_LINK_DATA_KEY_KEYWORDS onDict:temp];
-    [self safeSetValue:@(1000 * [self.expirationDate timeIntervalSince1970]) forKey:BRANCH_LINK_DATA_KEY_CONTENT_EXPIRATION_DATE onDict:temp];
-    [self safeSetValue:self.contentMetadata.contentSchema forKey:BRANCH_LINK_DATA_KEY_CONTENT_TYPE onDict:temp];
-    [self safeSetValue:self.contentMetadata.currency forKey:BNCPurchaseCurrency onDict:temp];
-    temp[BNCPurchaseAmount] = self.contentMetadata.price;
-    [temp addEntriesFromDictionary:[self.contentMetadata.customMetadata copy]];
-    return [temp copy];
-}
-
 - (NSDictionary *)getParamsForServerRequestWithAddedLinkProperties:(BranchLinkProperties *)linkProperties {
-    NSMutableDictionary *temp = [[self getParamsForServerRequest] mutableCopy];
-    [temp addEntriesFromDictionary:[linkProperties.controlParams copy]]; // TODO: Add warnings if controlParams contains non-control params
-    return [temp copy];
+    // TODO: Add warnings if controlParams contains non-control params
+    NSMutableDictionary *temp = self.dictionary;
+    [temp addEntriesFromDictionary:[linkProperties.controlParams copy]];
+    return temp;
 }
 
 - (NSDictionary *)getDictionaryWithCompleteLinkProperties:(BranchLinkProperties *)linkProperties {
@@ -717,14 +657,60 @@ + (BranchUniversalObject*_Nonnull) objectWithDictionary:(NSDictionary*_Null_unsp
 
     BranchContentMetadata *data = [BranchContentMetadata contentMetadataWithDictionary:dictionary];
     object.contentMetadata = data;
-    
+
+    NSSet *fieldsAdded = [NSSet setWithArray:@[
+        @"$canonical_identifier",
+        @"$canonical_url",
+        @"$creation_timestamp",
+        @"$exp_date",
+        @"$keywords",
+        @"$locally_indexable",
+        @"$og_description",
+        @"$og_image_url",
+        @"$og_title",
+        @"$publicly_indexable",
+        @"$content_schema",
+        @"$quantity",
+        @"$price",
+        @"$currency",
+        @"$sku",
+        @"$product_name",
+        @"$product_brand",
+        @"$product_category",
+        @"$product_variant",
+        @"$condition",
+        @"$rating_average",
+        @"$rating_count",
+        @"$rating_max",
+        @"$address_street",
+        @"$address_city",
+        @"$address_region",
+        @"$address_country",
+        @"$address_postal_code",
+        @"$latitude",
+        @"$longitude",
+        @"$image_captions",
+        @"$custom_fields",
+    ]];
+
+    // Add any extra fields to the content object.contentMetadata.customMetadata
+
+    for (NSString* key in dictionary.keyEnumerator) {
+        if (![fieldsAdded containsObject:key]) {
+            object.contentMetadata.customMetadata[key] = dictionary[key];
+        }
+    }
+
     return object;
 }
 
 - (NSDictionary*_Nonnull) dictionary {
 
     NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
 
+    NSDictionary *contentDictionary = [self.contentMetadata dictionary];
+    if (contentDictionary.count) [dictionary addEntriesFromDictionary:contentDictionary];
+
     #define BNCFieldDefinesDictionaryFromSelf
     #include "BNCFieldDefines.h"
 
@@ -741,9 +727,6 @@ - (NSDictionary*_Nonnull) dictionary {
 
     #include "BNCFieldDefines.h"
 
-    NSDictionary *contentDictionary = [self.contentMetadata dictionary];
-    if (contentDictionary.count) [dictionary addEntriesFromDictionary:contentDictionary];
-
     return dictionary;
 }
 

Branch-TestBed/Branch-SDK-Tests/BNCLog.Test.m

@@ -816,37 +816,6 @@ - (void) testLogByteWrapPerformanceTesting {
     BNCLogCloseLogFile();
     NSLog(@"%@: Synchronized time: %1.5f.",
         BNCSStringForCurrentMethod(), - startTime.timeIntervalSinceNow);
-
-/*  //  Non-sychronized --
-    //  EBS: Non-sychronized is no longer a thing. It was slower and less safe.
-    
-    BNCLogSetOutputToURLByteWrap(URL, kLogSize);
-    BNCLogSetSynchronizeMessages(NO);
-
-    startTime = [NSDate date];
-    waitGroup = dispatch_group_create();
-
-    dispatch_group_async(waitGroup,dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^ {
-        for (long i = 0; i < 2000; i++)
-            BNCLog(@"Message 1x%ld", i);
-    });
-
-    dispatch_group_async(waitGroup,dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^ {
-        for (long i = 0; i < 2000; i++)
-            BNCLog(@"Message 2x%ld", i);
-    });
-
-    dispatch_group_async(waitGroup,dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^ {
-        for (long i = 0; i < 2000; i++)
-            BNCLog(@"Message 3x%ld", i);
-    });
-
-    dispatch_group_wait(waitGroup, DISPATCH_TIME_FOREVER);
-    BNCLogCloseLogFile();
-    BNCLogFlushMessages();
-    NSLog(@"%@: Non-synchronized time: %1.5f",
-        BNCSStringForCurrentMethod(), - startTime.timeIntervalSinceNow);
-*/
 }
 
 - (void) testByteWrapTruncate {

Branch-TestBed/Branch-SDK-Tests/BranchDelegate.Test.m

@@ -7,6 +7,7 @@
 //
 
 #import "BNCTestCase.h"
+#import "BNCEncodingUtils.h"
 
 @interface BranchDelegateTest : BNCTestCase <BranchDelegate>
 @property (assign, nonatomic) NSInteger notificationOrder;
@@ -22,10 +23,6 @@ @interface BranchDelegateTest : BNCTestCase <BranchDelegate>
 
 @implementation BranchDelegateTest
 
-+ (void) tearDown {
-    [[NSNotificationCenter defaultCenter] removeObserver:self];
-}
-
 // Test that Branch notifications work.
 // Test that they 1) work and 2) are sent in the right order.
 - (void) testNotificationsSuccess {
@@ -276,21 +273,49 @@ - (void) branchDidStartSessionNotification:(NSNotification*)notification {
         XCTAssertNotNil(error);
         XCTAssertNil(URL);
         XCTAssertNil(object);
-        XCTAssertNil(object);
+        XCTAssertNil(properties);
 
     } else {
 
         XCTAssertNil(error);
         XCTAssertNotNil(URL);
         XCTAssertNotNil(object);
-        XCTAssertNotNil(object);
+        XCTAssertNotNil(properties);
+
+        NSMutableDictionary *d =
+            [NSMutableDictionary dictionaryWithDictionary:
+                [object getDictionaryWithCompleteLinkProperties:properties]];
+        NSMutableDictionary *truth = [NSMutableDictionary dictionaryWithDictionary:@{
+            @"$amount": @1000,
+            @"$canonical_identifier": @"item/12345",
+            @"$canonical_url": @"https://dev.branch.io/getting-started/deep-link-routing/guide/ios/",
+            @"$content_type": @"some type",
+            @"$currency": @"$",
+            @"$custom_fields": @"{\"+click_timestamp\":1506983962,\"+clicked_branch_link\":true,\"$identity_id\":\"423237095633725879\",\"$one_time_use\":false,\"$amount\":1000,\"~feature\":\"Sharing Feature\",\"$content_type\":\"some type\",\"~creation_source\":3,\"~channel\":\"Distribution Channel\",\"~id\":423243086454504450,\"deeplink_text\":\"This text was embedded as data in a Branch link with the following characteristics:\\n\\ncanonicalUrl: https://dev.branch.io/getting-started/deep-link-routing/guide/ios/\\n  title: Content Title\\n  contentDescription: My Content Description\\n  imageUrl: https://pbs.twimg.com/profile_images/658759610220703744/IO1HUADP.png\\n\",\"~referring_link\":\"https://bnctestbed.app.link/izPBY2xCqF\",\"+match_guaranteed\":true,\"$desktop_url\":\"http://branch.io\",\"+is_first_session\":false,\"$ios_url\":\"https://dev.branch.io/getting-started/sdk-integration-guide/guide/ios/\",\"~campaign\":\"some campaign\"}",
+            @"$desktop_url": @"http://branch.io",
+            @"$exp_date": @0,
+            @"$identity_id": @"423237095633725879",
+            @"$ios_url": @"https://dev.branch.io/getting-started/sdk-integration-guide/guide/ios/",
+            @"$og_description": @"My Content Description",
+            @"$og_image_url": @"https://pbs.twimg.com/profile_images/658759610220703744/IO1HUADP.png",
+            @"$og_title": @"Content Title",
+            @"$one_time_use": @0,
+            @"$publicly_indexable": @1,
+            @"~campaign": @"some campaign",
+            @"~channel": @"Distribution Channel",
+            @"~duration": @0,
+            @"~feature": @"Sharing Feature",
+        }];
+
+        NSDictionary *dCustom = [BNCEncodingUtils decodeJsonStringToDictionary:d[@"$custom_fields"]];
+        d[@"$custom_fields"] = nil;
+        
+        NSDictionary *tCustom = [BNCEncodingUtils decodeJsonStringToDictionary:truth[@"$custom_fields"]];
+        truth[@"$custom_fields"] = nil;
 
-        NSDictionary *d = [object getDictionaryWithCompleteLinkProperties:properties];
-        NSMutableDictionary *truth = [NSMutableDictionary dictionaryWithDictionary:self.deepLinkParams];
-        truth[@"~duration"] = @(0);         // ~duration not added because zero value?
-        truth[@"$locally_indexable"] = @(0);
         XCTAssertTrue(d.count == truth.count);
         XCTAssertTrue(!d || [d isEqualToDictionary:truth]);
+        XCTAssertTrue(!dCustom || [dCustom isEqualToDictionary:tCustom]);
     }
 
     [self.branchDidOpenURLNotificationExpectation fulfill];

Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.swift

@@ -73,7 +73,7 @@ class BranchEventTestSwift : BNCTestCase {
         var dictionary = self.mutableDictionaryFromBundleJSON(withKey: "V2EventProperties")
         XCTAssert((dictionary?.isEqual(to: testDictionary))!)
 
-        testDictionary = branchUniversalObject.dictionary()
+        testDictionary = branchUniversalObject.dictionary() as! [AnyHashable : Any]
         dictionary = self.mutableDictionaryFromBundleJSON(withKey: "BranchUniversalObjectJSON")
         dictionary!["$publicly_indexable"] = nil // Remove this value since we don't add false values.
         XCTAssert((dictionary?.isEqual(to: testDictionary))!)