[In Progress] SDK - 2519 Open Request Input Params Refactor

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

@@ -71,7 +71,8 @@ - (void)testBranchEventRequestArchive {
 
 - (void)testBranchOpenRequestArchive {
     BranchOpenRequest *request = [[BranchOpenRequest alloc] initWithCallback:nil];
-    request.urlString = @"https://branch.io";
+    request.linkParams = [[BranchOpenRequestLinkParams alloc] init];
+    request.linkParams.referringURL = @"https://branch.io";
 
     // archive the event
     NSError *error = nil;
@@ -88,14 +89,15 @@ - (void)testBranchOpenRequestArchive {
     XCTAssertTrue([object isKindOfClass:BranchOpenRequest.class]);
     BranchOpenRequest *unarchivedRequest = (BranchOpenRequest *)object;
 
-    XCTAssertTrue([request.urlString isEqualToString:unarchivedRequest.urlString]);
+    XCTAssertTrue([request.linkParams.referringURL isEqualToString:unarchivedRequest.linkParams.referringURL]);
     XCTAssertNil(unarchivedRequest.callback);
     XCTAssertTrue([@"open" isEqualToString:[unarchivedRequest getActionName]]);
 }
 
 - (void)testBranchInstallRequestArchive {
     BranchInstallRequest *request = [[BranchInstallRequest alloc] initWithCallback:nil];
-    request.urlString = @"https://branch.io";
+    request.linkParams = [[BranchOpenRequestLinkParams alloc] init];
+    request.linkParams.referringURL = @"https://branch.io";
 
     // archive the event
     NSError *error = nil;
@@ -112,7 +114,7 @@ - (void)testBranchInstallRequestArchive {
     XCTAssertTrue([object isKindOfClass:BranchInstallRequest.class]);
     BranchInstallRequest *unarchivedRequest = (BranchInstallRequest *)object;
 
-    XCTAssertTrue([request.urlString isEqualToString:unarchivedRequest.urlString]);
+    XCTAssertTrue([request.linkParams.referringURL isEqualToString:unarchivedRequest.linkParams.referringURL]);
     XCTAssertNil(unarchivedRequest.callback);
     XCTAssertTrue([@"install" isEqualToString:[unarchivedRequest getActionName]]);
 }

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

@@ -243,13 +243,6 @@ - (void)testSetLastStrongMatchDate {
     XCTAssertEqualObjects(expectedDate, actualDate);
 }
 
-- (void)testSetAppVersion {
-    NSString *expectedVersion = @"1.0.0";
-    [self.prefHelper setAppVersion: expectedVersion];
-
-    NSString *actualVersion = [self.prefHelper appVersion];
-    XCTAssertEqualObjects(expectedVersion, actualVersion);
-}
 
 - (void)testSetLocalUrl {
     NSString *expectedLocalURL = @"https://local.example.com";
@@ -364,14 +357,8 @@ - (void)testClearTrackingInformation {
     [self.prefHelper clearTrackingInformation];
 
     XCTAssertNil(self.prefHelper.sessionID);
-    XCTAssertNil(self.prefHelper.linkClickIdentifier);
-    XCTAssertNil(self.prefHelper.spotlightIdentifier);
-    XCTAssertNil(self.prefHelper.referringURL);
-    XCTAssertNil(self.prefHelper.universalLinkUrl);
-    XCTAssertNil(self.prefHelper.initialReferrer);
     XCTAssertNil(self.prefHelper.installParams);
     XCTAssertNil(self.prefHelper.sessionParams);
-    XCTAssertNil(self.prefHelper.externalIntentURI);
     XCTAssertNil(self.prefHelper.savedAnalyticsData);
     XCTAssertNil(self.prefHelper.previousAppBuildDate);
     XCTAssertEqual(self.prefHelper.requestMetadataDictionary.count, 0);

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

@@ -29,7 +29,7 @@ - (void)tearDown {
 
 - (void)testInitWithBranchKeyNil {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:nil UUID:_requestUUID TimeStamp:_requestCreationTimeStamp];
-    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
+    NSDictionary *json = [factory dataForInstallWithLinkParams:nil];
     XCTAssertNotNil(json);
 
     // key is omitted when nil
@@ -40,7 +40,7 @@ - (void)testInitWithBranchKeyNil {
 
 - (void)testInitWithBranchKeyEmpty {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"" UUID:self.requestUUID TimeStamp:self.requestCreationTimeStamp];
-    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
+    NSDictionary *json = [factory dataForInstallWithLinkParams:nil];
     XCTAssertNotNil(json);
 
     // empty string is allowed
@@ -52,7 +52,7 @@ - (void)testInitWithBranchKeyEmpty {
 
 - (void)testInitWithBranchKey {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd" UUID:self.requestUUID TimeStamp:self.requestCreationTimeStamp];
-    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
+    NSDictionary *json = [factory dataForInstallWithLinkParams:nil];
     XCTAssertNotNil(json);
     XCTAssertTrue([@"key_abcd" isEqualToString:[json objectForKey:@"branch_key"]]);
 
@@ -62,7 +62,7 @@ - (void)testInitWithBranchKey {
 
 - (void)testDataForInstall {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd" UUID:self.requestUUID TimeStamp:self.requestCreationTimeStamp];
-    NSDictionary *json = [factory dataForInstallWithURLString:@"https://branch.io"];
+    NSDictionary *json = [factory dataForInstallWithLinkParams:nil];
     XCTAssertNotNil(json);
 
     XCTAssertTrue([@"key_abcd" isEqualToString:[json objectForKey:@"branch_key"]]);
@@ -79,7 +79,7 @@ - (void)testDataForInstall {
 
 - (void)testDataForOpen {
     BNCRequestFactory *factory = [[BNCRequestFactory alloc] initWithBranchKey:@"key_abcd" UUID:self.requestUUID TimeStamp:self.requestCreationTimeStamp];
-    NSDictionary *json = [factory dataForOpenWithURLString:@"https://branch.io"];
+    NSDictionary *json = [factory dataForInstallWithLinkParams:nil];
     XCTAssertNotNil(json);
 
     XCTAssertTrue([@"key_abcd" isEqualToString:[json objectForKey:@"branch_key"]]);

Sources/BranchSDK/BNCAppGroupsData.m

@@ -64,7 +64,7 @@ - (NSDate *)getDateForKey:(NSString *)key {
     return nil;
 }
 
-- (void)saveAppClipData {
+- (void)saveAppClipData:(NSString *) referringURL {
     if ([BNCSystemObserver isAppClip]) {
 
         BNCApplication *application = [BNCApplication currentApplication];
@@ -79,7 +79,7 @@ - (void)saveAppClipData {
 
         BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
 
-        NSString *url = preferenceHelper.referringURL;
+        NSString *url = referringURL;
         NSString *token = preferenceHelper.randomizedDeviceToken;
         NSString *bundleToken = preferenceHelper.randomizedBundleToken;
 

Sources/BranchSDK/BNCPreferenceHelper.m

@@ -73,7 +73,6 @@ @interface BNCPreferenceHelper () {
     NSOperationQueue *_persistPrefsQueue;
     NSString         *_lastSystemBuildVersion;
     NSString         *_browserUserAgentString;
-    NSString         *_referringURL;
 }
 
 @property (strong, nonatomic) NSMutableDictionary *persistenceDict;
@@ -90,20 +89,15 @@ @implementation BNCPreferenceHelper
 // since we override both setter and getter, these properties do not auto synthesize
 @synthesize
     lastRunBranchKey = _lastRunBranchKey,
-    appVersion = _appVersion,
     randomizedDeviceToken = _randomizedDeviceToken,
     sessionID = _sessionID,
-    spotlightIdentifier = _spotlightIdentifier,
     randomizedBundleToken = _randomizedBundleToken,
-    linkClickIdentifier = _linkClickIdentifier,
     userUrl = _userUrl,
     userIdentity = _userIdentity,
     sessionParams = _sessionParams,
     installParams = _installParams,
-    universalLinkUrl = _universalLinkUrl,
     initialReferrer = _initialReferrer,
     localUrl = _localUrl,
-    externalIntentURI = _externalIntentURI,
     isDebug = _isDebug,
     retryCount = _retryCount,
     retryInterval = _retryInterval,
@@ -220,20 +214,6 @@ - (void)setLastStrongMatchDate:(NSDate *)lastStrongMatchDate {
     }
 }
 
-- (NSString *)appVersion {
-    if (!_appVersion) {
-        _appVersion = [self readStringFromDefaults:BRANCH_PREFS_KEY_APP_VERSION];
-    }
-    return _appVersion;
-}
-
-- (void)setAppVersion:(NSString *)appVersion {
-    if (![_appVersion isEqualToString:appVersion]) {
-        _appVersion = appVersion;
-        [self writeObjectToDefaults:BRANCH_PREFS_KEY_APP_VERSION value:appVersion];
-    }
-}
-
 - (NSString *)randomizedDeviceToken {
     if (!_randomizedDeviceToken) {
         NSString *tmp = [self readStringFromDefaults:BRANCH_PREFS_KEY_RANDOMIZED_DEVICE_TOKEN];
@@ -308,62 +288,6 @@ - (void)setUserIdentity:(NSString *)userIdentity {
     [self writeObjectToDefaults:BRANCH_PREFS_KEY_IDENTITY value:userIdentity];
 }
 
-- (NSString *)linkClickIdentifier {
-    return [self readStringFromDefaults:BRANCH_PREFS_KEY_LINK_CLICK_IDENTIFIER];
-}
-
-- (void)setLinkClickIdentifier:(NSString *)linkClickIdentifier {
-    [self writeObjectToDefaults:BRANCH_PREFS_KEY_LINK_CLICK_IDENTIFIER value:linkClickIdentifier];
-}
-
-- (NSString *)spotlightIdentifier {
-    return [self readStringFromDefaults:BRANCH_PREFS_KEY_SPOTLIGHT_IDENTIFIER];
-}
-
-- (void)setSpotlightIdentifier:(NSString *)spotlightIdentifier {
-    [self writeObjectToDefaults:BRANCH_PREFS_KEY_SPOTLIGHT_IDENTIFIER value:spotlightIdentifier];
-}
-
-- (NSString *)externalIntentURI {
-    @synchronized(self) {
-        if (!_externalIntentURI) {
-            _externalIntentURI = [self readStringFromDefaults:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI];
-        }
-        return _externalIntentURI;
-    }
-}
-
-- (void)setExternalIntentURI:(NSString *)externalIntentURI {
-    @synchronized(self) {
-        if (externalIntentURI == nil || ![_externalIntentURI isEqualToString:externalIntentURI]) {
-            _externalIntentURI = externalIntentURI;
-            [self writeObjectToDefaults:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI value:externalIntentURI];
-        }
-    }
-}
-
-- (NSString*) referringURL {
-    @synchronized (self) {
-        if (!_referringURL) _referringURL = [self readStringFromDefaults:@"referringURL"];
-        return _referringURL;
-    }
-}
-
-- (void) setReferringURL:(NSString *)referringURL {
-    @synchronized (self) {
-        _referringURL = [referringURL copy];
-        [self writeObjectToDefaults:@"referringURL" value:_referringURL];
-    }
-}
-
-- (NSString *)universalLinkUrl {
-    return [self readStringFromDefaults:BRANCH_PREFS_KEY_UNIVERSAL_LINK_URL];
-}
-
-- (void)setUniversalLinkUrl:(NSString *)universalLinkUrl {
-    [self writeObjectToDefaults:BRANCH_PREFS_KEY_UNIVERSAL_LINK_URL value:universalLinkUrl];
-}
-
 - (NSString *)localUrl {
     return [self readStringFromDefaults:BRANCH_PREFS_KEY_LOCAL_URL];
 }
@@ -618,18 +542,6 @@ - (void) setSavedURLPatternListVersion:(NSInteger)URLPatternListVersion {
     }
 }
 
-- (BOOL) dropURLOpen {
-    @synchronized(self) {
-        return [self readBoolFromDefaults:@"dropURLOpen"];
-    }
-}
-
-- (void) setDropURLOpen:(BOOL)value {
-    @synchronized(self) {
-        [self writeBoolToDefaults:@"dropURLOpen" value:value];
-    }
-}
-
 - (BOOL) trackingDisabled {
     @synchronized(self) {
         NSNumber *b = (id) [self readObjectFromDefaults:@"trackingDisabled"];
@@ -849,14 +761,8 @@ - (void) clearTrackingInformation {
          self.randomizedBundleToken = nil;
          */
         self.sessionID = nil;
-        self.linkClickIdentifier = nil;
-        self.spotlightIdentifier = nil;
-        self.referringURL = nil;
-        self.universalLinkUrl = nil;
-        self.initialReferrer = nil;
         self.installParams = nil;
         self.sessionParams = nil;
-        self.externalIntentURI = nil;
         self.savedAnalyticsData = nil;
         self.previousAppBuildDate = nil;
         self.requestMetadataDictionary = nil;

Sources/BranchSDK/BNCRequestFactory.m

@@ -34,6 +34,8 @@
 #import "BNCSKAdNetwork.h"
 #import "BNCReferringURLUtility.h"
 #import "BNCPasteboard.h"
+#import "BranchOpenRequest.h"
+#import "BranchInstallRequest.h"
 
 @interface BNCRequestFactory()
 
@@ -80,7 +82,7 @@ - (BOOL)isTrackingDisabled {
     return Branch.trackingDisabled;
 }
 
-- (NSDictionary *)dataForInstallWithURLString:(NSString *)urlString {
+- (NSDictionary *)dataForInstallWithLinkParams:(BranchOpenRequestLinkParams *) linkParams {
     NSMutableDictionary *json = [NSMutableDictionary new];
 
     // All requests
@@ -99,18 +101,18 @@ - (NSDictionary *)dataForInstallWithURLString:(NSString *)urlString {
     // Install and Open
     [self addDeveloperUserIDToJSON:json];
     [self addSystemObserverDataToJSON:json];
-    [self addPreferenceHelperDataToJSON:json];
+    [self addOpenRequestDataToJSON:json fromLinkParams:linkParams];
     [self addPartnerParametersToJSON:json];
     [self addAppleReceiptSourceToJSON:json];
     [self addTimestampsToJSON:json];
 
     // Check if the urlString is a valid URL to ensure it's a universal link, not the external intent uri
-    if (urlString) {
-        NSURL *url = [NSURL URLWithString:urlString];
+    if (linkParams.referringURL && !linkParams.dropURLOpen) {
+        NSURL *url = [NSURL URLWithString:linkParams.referringURL];
         if (url && ([url.scheme isEqualToString:@"http"] || [url.scheme isEqualToString:@"https"])) {
-            [self safeSetValue:urlString forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
+            [self safeSetValue:linkParams.referringURL forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
         } else {
-            [self safeSetValue:urlString forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:json];
+            [self safeSetValue:linkParams.referringURL forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:json];
         }
     }
 
@@ -132,7 +134,7 @@ - (NSDictionary *)dataForInstallWithURLString:(NSString *)urlString {
     return json;
 }
 
-- (NSDictionary *)dataForOpenWithURLString:(NSString *)urlString {
+- (NSDictionary *)dataForOpenWithLinkParams:(BranchOpenRequestLinkParams *) linkParams{
     NSMutableDictionary *json = [NSMutableDictionary new];
 
     // All requests
@@ -154,19 +156,19 @@ - (NSDictionary *)dataForOpenWithURLString:(NSString *)urlString {
     // Install and Open
     [self addDeveloperUserIDToJSON:json];
     [self addSystemObserverDataToJSON:json];
-    [self addPreferenceHelperDataToJSON:json];
+    [self addOpenRequestDataToJSON:json fromLinkParams:linkParams];
     [self addPartnerParametersToJSON:json];
     [self addAppleReceiptSourceToJSON:json];
     [self addTimestampsToJSON:json];
 
 
     // Check if the urlString is a valid URL to ensure it's a universal link, not the external intent uri
-    if (urlString) {
-        NSURL *url = [NSURL URLWithString:urlString];
+    if (linkParams.referringURL && !linkParams.dropURLOpen) {
+        NSURL *url = [NSURL URLWithString:linkParams.referringURL];
         if (url && ([url.scheme isEqualToString:@"http"] || [url.scheme isEqualToString:@"https"])) {
-            [self safeSetValue:urlString forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
+            [self safeSetValue:linkParams.referringURL forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:json];
         } else {
-            [self safeSetValue:urlString forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:json];
+            [self safeSetValue:linkParams.referringURL forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:json];
         }
     }
 
@@ -303,15 +305,13 @@ - (void)addShortURLTokensToJSON:(NSMutableDictionary *)json isSpotlightRequest:(
     json[BRANCH_REQUEST_KEY_SESSION_ID] = self.preferenceHelper.sessionID;
 }
 
-- (void)addPreferenceHelperDataToJSON:(NSMutableDictionary *)json {
+- (void)addOpenRequestDataToJSON:(NSMutableDictionary *)json fromLinkParams:(BranchOpenRequestLinkParams *) linkParams{
     json[BRANCH_REQUEST_KEY_DEBUG] = @(self.preferenceHelper.isDebug);
-
-    [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.initialReferrer forKey:BRANCH_REQUEST_KEY_INITIAL_REFERRER onDict:json];
 
-    // This was only on opens before, cause it can't exist on install.
-    [self safeSetValue:self.preferenceHelper.externalIntentURI forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:json];
+    [self safeSetValue:linkParams.linkClickIdentifier forKey:BRANCH_REQUEST_KEY_LINK_IDENTIFIER onDict:json];
+    [self safeSetValue:linkParams.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:json];
+
 }
 
 - (void)addSystemObserverDataToJSON:(NSMutableDictionary *)json {

Sources/BranchSDK/BNCServerRequestQueue.m

@@ -138,7 +138,7 @@ - (BranchOpenRequest *)findExistingInstallOrOpen {
 
             // Install subclasses open, so only need to check open
             // Request should not be the one added from archived queue
-            if ([request isKindOfClass:[BranchOpenRequest class]] && !((BranchOpenRequest *)request).isFromArchivedQueue) {
+            if ([request isKindOfClass:[BranchOpenRequest class]]) {
                 return (BranchOpenRequest *)request;
             }
         }