Merge pull request #27 from BranchMetrics/SDK-2246-prep-iOS-3.3.0-sync

sync with 3.3.0

Branch-TestBed/Branch-SDK-Tests/BNCRequestFactoryTests.m

@@ -25,7 +25,7 @@ - (void)tearDown {
 
 - (void)testInitWithBranchKeyNil {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:nil];
-    NSDictionary *json = [factory dataForInstall];
+    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
     XCTAssertNotNil(json);
 
     // key is omitted when nil
@@ -34,7 +34,7 @@ - (void)testInitWithBranchKeyNil {
 
 - (void)testInitWithBranchKeyEmpty {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@""];
-    NSDictionary *json = [factory dataForInstall];
+    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
     XCTAssertNotNil(json);
 
     // empty string is allowed
@@ -43,14 +43,14 @@ - (void)testInitWithBranchKeyEmpty {
 
 - (void)testInitWithBranchKey {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd"];
-    NSDictionary *json = [factory dataForInstall];
+    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
     XCTAssertNotNil(json);
     XCTAssertTrue([@"key_abcd" isEqualToString:[json objectForKey:@"branch_key"]]);
 }
 
 - (void)testDataForInstall {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd"];
-    NSDictionary *json = [factory dataForInstall];
+    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
     XCTAssertNotNil(json);
 
     XCTAssertTrue([@"key_abcd" isEqualToString:[json objectForKey:@"branch_key"]]);
@@ -64,7 +64,7 @@ - (void)testDataForInstall {
 
 - (void)testDataForOpen {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd"];
-    NSDictionary *json = [factory dataForOpen];
+    NSDictionary *json = [factory dataForOpenWithURLString:@"https://branch.io"];
     XCTAssertNotNil(json);
 
     XCTAssertTrue([@"key_abcd" isEqualToString:[json objectForKey:@"branch_key"]]);
@@ -182,13 +182,13 @@ - (void)testDataForEventNil {
 
 - (void)testDataForShortURL {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd"];
-    NSDictionary *json = [factory dataForInstall];
+    NSDictionary *json = [factory dataForShortURLWithLinkDataDictionary:@{}.mutableCopy isSpotlightRequest:NO];
     XCTAssertNotNil(json);
 }
 
 - (void)testDataForLATD {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd"];
-    NSDictionary *json = [factory dataForInstall];
+    NSDictionary *json = [factory dataForLATDWithDataDictionary:@{}.mutableCopy];
     XCTAssertNotNil(json);
 }
 

BranchSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "BranchSDK"
-  s.version          = "3.2.0"
+  s.version          = "3.3.0"
   s.summary          = "Create an HTTP URL for any piece of content in your app"
   s.description      = <<-DESC
 - Want the highest possible conversions on your sharing feature?

BranchSDK.xcodeproj/project.pbxproj

@@ -1974,7 +1974,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.2.0;
+				MARKETING_VERSION = 3.3.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2009,7 +2009,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.2.0;
+				MARKETING_VERSION = 3.3.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2215,7 +2215,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACH_O_TYPE = staticlib;
-				MARKETING_VERSION = 3.2.0;
+				MARKETING_VERSION = 3.3.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2254,7 +2254,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACH_O_TYPE = staticlib;
-				MARKETING_VERSION = 3.2.0;
+				MARKETING_VERSION = 3.3.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2291,7 +2291,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.2.0;
+				MARKETING_VERSION = 3.3.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,
@@ -2326,7 +2326,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.2.0;
+				MARKETING_VERSION = 3.3.0;
 				OTHER_LDFLAGS = (
 					"-weak_framework",
 					LinkPresentation,

ChangeLog.md

@@ -1,5 +1,10 @@
 Branch iOS SDK Change Log
 
+v.3.3.0
+- SDK behavior change to fix a race condition when opening a closed app with a link. In some apps, this race condition could cause the occasional loss of link data.
+
+When opening a closed app with a link, the Branch SDK will no longer attempt to merge the app open and link arrival lifecycle events. Apps will now get called on "app open" and on "link arrival", which are often very close together. If your app ignores callbacks with no link data, then this change should be transparent.
+
 v.3.2.0
 - Add support for setting DMA compliance parameters.
 - Update logging to allow a custom callback so clients may reroute Branch Logs to their logging infrastructure.

Sources/BranchSDK/BNCConfig.m

@@ -8,7 +8,7 @@
 
 #include "BNCConfig.h"
 
-NSString * const BNC_SDK_VERSION  = @"3.2.0";
+NSString * const BNC_SDK_VERSION  = @"3.3.0";
 NSString * const BNC_LINK_URL = @"https://bnc.lt";
 NSString * const BNC_CDN_URL = @"https://cdn.branch.io";
 

Sources/BranchSDK/BNCRequestFactory.m

@@ -76,7 +76,7 @@ - (BOOL)isTrackingDisabled {
     return Branch.trackingDisabled;
 }
 
-- (NSDictionary *)dataForInstall {
+- (NSDictionary *)dataForInstallWithURLString:(NSString *)urlString {
     NSMutableDictionary *json = [NSMutableDictionary new];
 
     // All requests
@@ -100,6 +100,10 @@ - (NSDictionary *)dataForInstall {
     [self addAppleReceiptSourceToJSON:json];
     [self addTimestampsToJSON:json];
 
+    if (urlString) {
+        [self safeSetValue:urlString forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
+    }
+
     [self addAppleAttributionTokenToJSON:json];
 
     // Install Only
@@ -116,7 +120,7 @@ - (NSDictionary *)dataForInstall {
     return json;
 }
 
-- (NSDictionary *)dataForOpen {
+- (NSDictionary *)dataForOpenWithURLString:(NSString *)urlString {
     NSMutableDictionary *json = [NSMutableDictionary new];
 
     // All requests
@@ -143,6 +147,10 @@ - (NSDictionary *)dataForOpen {
     [self addAppleReceiptSourceToJSON:json];
     [self addTimestampsToJSON:json];
 
+    if (urlString) {
+        [self safeSetValue:urlString forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
+    }
+
     // Usually sent with install, but retry on open if it didn't get sent
     [self addAppleAttributionTokenToJSON:json];
 
@@ -279,7 +287,6 @@ - (void)addPreferenceHelperDataToJSON:(NSMutableDictionary *)json {
 
     [self safeSetValue:self.preferenceHelper.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:json];
     [self safeSetValue:self.preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:json];
-    [self safeSetValue:self.preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
     [self safeSetValue:self.preferenceHelper.initialReferrer forKey:BRANCH_REQUEST_KEY_INITIAL_REFERRER onDict:json];
 
     // This was only on opens before, cause it can't exist on install.

Sources/BranchSDK/BNCServerRequestQueue.m

@@ -161,56 +161,17 @@ - (BOOL)containsInstallOrOpen {
     }
 }
 
-- (BOOL)removeInstallOrOpen {
+- (BranchOpenRequest *)findExistingInstallOrOpen {
     @synchronized (self) {
         for (NSUInteger i = 0; i < self.queue.count; i++) {
             BNCServerRequest *request = [self.queue objectAtIndex:i];
-            // Install extends open, so only need to check open.
-            if ([request isKindOfClass:[BranchOpenRequest class]]) {
-                [[BranchLogger shared] logDebug:@"Removing open request."];
-                ((BranchOpenRequest *)request).callback = nil;
-                [self remove:request];
-                return YES;
-            }
-        }
-        return NO;
-    }
-}
-
-- (BranchOpenRequest *)moveInstallOrOpenToFront:(NSInteger)networkCount {
-    @synchronized (self) {
-
-        BOOL requestAlreadyInProgress = networkCount > 0;
 
-        BNCServerRequest *openOrInstallRequest;
-        for (NSUInteger i = 0; i < self.queue.count; i++) {
-            BNCServerRequest *req = [self.queue objectAtIndex:i];
-            if ([req isKindOfClass:[BranchOpenRequest class]]) {
-
-                // Already in front, nothing to do
-                if (i == 0 || (i == 1 && requestAlreadyInProgress)) {
-                    return (BranchOpenRequest *)req;
-                }
-
-                // Otherwise, pull this request out and stop early
-                openOrInstallRequest = [self removeAt:i];
-                break;
+            // Install subclasses open, so only need to check open
+            if ([request isKindOfClass:[BranchOpenRequest class]]) {
+                return (BranchOpenRequest *)request;
             }
         }
-
-        if (!openOrInstallRequest) {
-            [[BranchLogger shared] logError:@"No install or open request in queue while trying to move it to the front." error:nil];
-            return nil;
-        }
-
-        if (!requestAlreadyInProgress || !self.queue.count) {
-            [self insert:openOrInstallRequest at:0];
-        }
-        else {
-            [self insert:openOrInstallRequest at:1];
-        }
-
-        return (BranchOpenRequest *)openOrInstallRequest;
+        return nil;
     }
 }