[SDK-1944] feat(install): Add Developer ID to v1/install

Author: nsingh-branch

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

@@ -15,10 +15,25 @@
 static NSString * const IDENTITY_TEST_USER_ID = @"foo_id";
 
 @interface BranchSetIdentityRequestTests : BNCTestCase
+//@property (nonatomic, strong) Branch *branch;
+//@property (nonatomic, strong) BNCPreferenceHelper *preferenceHelper;
 @end
 
 @implementation BranchSetIdentityRequestTests
 
+//- (void)setUp {
+//    [super setUp];
+//    self.branch = [Branch getInstance];
+//    self.preferenceHelper = [BNCPreferenceHelper sharedInstance];
+//    [self.branch logout];
+//}
+//
+//- (void)tearDown {
+//    self.branch = nil;
+//    self.preferenceHelper = nil;
+//    [super tearDown];
+//}
+
 - (void)testRequestBody {
     BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
     NSDictionary * const expectedParams = @{
@@ -178,4 +193,52 @@ - (void)testEmptyResponseFieldsAfterSetIdentity {
     XCTAssertNotNil(preferenceHelper.randomizedBundleToken);
 }
 
+#pragma mark -  setIdentity Tests
+- (void)testSetIdentityWithCallback {
+    Branch *branch = [Branch getInstance];
+    [branch logoutWithCallback:^(BOOL changed, NSError * _Nullable error) {
+        BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper new];
+
+        XCTestExpectation *expectation = [self expectationWithDescription:@"setIdentity callback is called"];
+        
+        [branch setIdentity:@"testUserIdWithCallback" withCallback:^(NSDictionary *params, NSError *error) {
+            XCTAssertEqualObjects(@"testUserIdWithCallback", preferenceHelper.userIdentity);
+            [expectation fulfill];
+        }];
+        
+        [self waitForExpectationsWithTimeout:5 handler:nil];
+    }];
+}
+
+- (void)testSetIdentityWithNilUserId {
+    Branch *branch = [Branch getInstance];
+    [branch logoutWithCallback:^(BOOL changed, NSError * _Nullable error) {
+        BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper new];
+
+        XCTestExpectation *expectation = [self expectationWithDescription:@"setIdentityWithNil callback is called"];
+        
+        [branch setIdentity:nil withCallback:^(NSDictionary *params, NSError *error) {
+            XCTAssertNil(preferenceHelper.userIdentity);
+            [expectation fulfill];
+        }];
+        
+        [self waitForExpectationsWithTimeout:5 handler:nil];
+    }];
+    
+
+}
+
+- (void)testSetIdentityWithUserId {
+    Branch *branch = [Branch getInstance];
+    [branch logoutWithCallback:^(BOOL changed, NSError * _Nullable error) {
+        BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper new];
+
+        NSString *testUserId = @"testUserId";
+        [branch setIdentity:testUserId withCallback:nil];
+
+        XCTAssertEqualObjects(@"testUserId", preferenceHelper.userIdentity);
+    }];
+
+}
+
 @end

Branch-TestBed/Branch-TestBed/AppDelegate.m

@@ -51,19 +51,19 @@ - (BOOL)application:(UIApplication *)application
 
     [branch checkPasteboardOnInstall];
 
-
     /*
      *    Required: Initialize Branch, passing a deep link handler block:
      */
 
     [self setLogFile:@"OpenNInstall"];
-    // [branch setIdentity:@"Bobby Branch"];
-        
-    [branch initSessionWithLaunchOptions:launchOptions
-        andRegisterDeepLinkHandlerUsingBranchUniversalObject:
-        ^ (BranchUniversalObject * _Nullable universalObject, BranchLinkProperties * _Nullable linkProperties, NSError * _Nullable error) {
+    
+    [branch setIdentity:@"Bobby Branch"];
+    
+    [branch initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandlerUsingBranchUniversalObject:
+     ^ (BranchUniversalObject * _Nullable universalObject, BranchLinkProperties * _Nullable linkProperties, NSError * _Nullable error) {
+
         [self setLogFile:nil];
-            [self handleDeepLinkObject:universalObject linkProperties:linkProperties error:error];
+        [self handleDeepLinkObject:universalObject linkProperties:linkProperties error:error];
     }];
 
     // Push notification support (Optional)

BranchSDK/BNCServerInterface.m

@@ -465,7 +465,12 @@ - (NSMutableDictionary *)prepareParamDict:(NSDictionary *)params
 
     if ([self.requestEndpoint containsString:@"/v1/open"]) {
         [fullParamDict bnc_safeSetObject:[BNCPreferenceHelper sharedInstance].userIdentity forKey:@"identity"];
-    } 
+    }
+    
+    if ([self.requestEndpoint containsString:@"/v1/install"]) {
+        [fullParamDict bnc_safeSetObject: [Branch getInstance].installUserId forKey:@"identity"];
+    }
+        
 
     return fullParamDict;
 }

BranchSDK/Branch.h

@@ -1856,6 +1856,9 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
 - (void)passPasteItemProviders:(NSArray<NSItemProvider *> *)itemProviders API_AVAILABLE(ios(16));
 #endif
 
+@property (copy, nonatomic, nullable) NSString *installUserId;
+@property (copy, nonatomic, nullable) callbackWithParams setIdentityCallback;
+
 @end
 
 NS_ASSUME_NONNULL_END

BranchSDK/Branch.m

@@ -1047,7 +1047,7 @@ - (void)registerDeepLinkController:(UIViewController <BranchDeepLinkingControlle
 #pragma mark - Identity methods
 
 - (void)setIdentity:(NSString *)userId {
-    [self setIdentity:userId withCallback:NULL];
+    [self setIdentity:userId withCallback: nil];
 }
 
 - (void)setIdentity:(NSString *)userId withCallback:(callbackWithParams)callback {
@@ -1057,20 +1057,40 @@ - (void)setIdentity:(NSString *)userId withCallback:(callbackWithParams)callback
         }
         return;
     }
+    
+    if (self.initializationStatus == BNCInitStatusUninitialized ) {
+        [self cacheIdentity:userId withCallback:callback];
+    } else {
+        [self sendIdentity:userId withCallback:callback];
+    }
+}
 
-    [self initSafetyCheck];
+- (void) sendIdentity:(NSString *)userId withCallback:(callbackWithParams)callback {
     dispatch_async(self.isolationQueue, ^(){
         BranchSetIdentityRequest *req = [[BranchSetIdentityRequest alloc] initWithUserId:userId callback:callback];
         [self.requestQueue enqueue:req];
         [self processNextQueueItem];
     });
 }
 
+- (void) cacheIdentity: (NSString *)userId withCallback:(callbackWithParams)callback {
+    self.installUserId = userId;
+    self.setIdentityCallback = callback;
+}
+
+- (void) applySavedIdentity {
+    if (self.installUserId != nil) {
+        [self sendIdentity:self.installUserId withCallback:self.setIdentityCallback];
+        
+        self.installUserId = nil;
+        self.setIdentityCallback = nil;
+    }
+}
+
 - (void)logout {
     [self logoutWithCallback:nil];
 }
 
-
 - (void)logoutWithCallback:(callbackWithStatus)callback {
     if (self.initializationStatus == BNCInitStatusUninitialized) {
         NSError *error =
@@ -2285,6 +2305,8 @@ - (void)handleInitSuccessAndCallCallback:(BOOL)callCallback sceneIdentifier:(NSS
     }
     [self sendOpenNotificationWithLinkParameters:latestReferringParams error:nil];
 
+    [self applySavedIdentity];
+    
     if (!self.urlFilter.hasUpdatedPatternList) {
         [self.urlFilter updatePatternListWithCompletion:nil];
     }