Merge pull request #1180 from BranchMetrics/SDK-1391-empty-response-fields

SDK-1391 : Don't Delete response fields from shared preference if the…

Author: nsingh-branch

Branch-SDK/BranchOpenRequest.m

@@ -161,16 +161,22 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
     if ([userIdentity isKindOfClass:[NSNumber class]]) {
         userIdentity = [userIdentity stringValue];
     }
-
-    preferenceHelper.randomizedDeviceToken = data[BRANCH_RESPONSE_KEY_RANDOMIZED_DEVICE_TOKEN];
-    if (!preferenceHelper.randomizedDeviceToken) {
-        // fallback to deprecated name. Fingerprinting was removed long ago, hence the name change.
-        preferenceHelper.randomizedDeviceToken = data[@"device_fingerprint_id"];
-    }
 
-    preferenceHelper.userUrl = data[BRANCH_RESPONSE_KEY_USER_URL];
+    
+    if ([data objectForKey:BRANCH_RESPONSE_KEY_RANDOMIZED_DEVICE_TOKEN]) {
+        preferenceHelper.randomizedDeviceToken = data[BRANCH_RESPONSE_KEY_RANDOMIZED_DEVICE_TOKEN];
+        if (!preferenceHelper.randomizedDeviceToken) {
+            // fallback to deprecated name. Fingerprinting was removed long ago, hence the name change.
+            preferenceHelper.randomizedDeviceToken = data[@"device_fingerprint_id"];
+        }
+    }
+   
+    if (data[BRANCH_RESPONSE_KEY_USER_URL]) {
+        preferenceHelper.userUrl = data[BRANCH_RESPONSE_KEY_USER_URL];
+    }
     preferenceHelper.userIdentity = userIdentity;
-    preferenceHelper.sessionID = data[BRANCH_RESPONSE_KEY_SESSION_ID];
+    if ([data objectForKey:BRANCH_RESPONSE_KEY_SESSION_ID])
+        preferenceHelper.sessionID = data[BRANCH_RESPONSE_KEY_SESSION_ID];
     preferenceHelper.previousAppBuildDate = [BNCApplication currentApplication].currentBuildDate;
 
 

Branch-SDK/BranchSetIdentityRequest.m

@@ -52,8 +52,11 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
     }
 
     BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
-    preferenceHelper.randomizedBundleToken = BNCStringFromWireFormat(response.data[BRANCH_RESPONSE_KEY_RANDOMIZED_BUNDLE_TOKEN]);
-    preferenceHelper.userUrl = response.data[BRANCH_RESPONSE_KEY_USER_URL];
+    if (response.data[BRANCH_RESPONSE_KEY_RANDOMIZED_BUNDLE_TOKEN])
+        preferenceHelper.randomizedBundleToken = BNCStringFromWireFormat(response.data[BRANCH_RESPONSE_KEY_RANDOMIZED_BUNDLE_TOKEN]);
+    if (response.data[BRANCH_RESPONSE_KEY_USER_URL]) {
+        preferenceHelper.userUrl = response.data[BRANCH_RESPONSE_KEY_USER_URL];
+    }
     preferenceHelper.userIdentity = self.userId;
     if (response.data[BRANCH_RESPONSE_KEY_SESSION_ID]) {
         preferenceHelper.sessionID = response.data[BRANCH_RESPONSE_KEY_SESSION_ID];

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

@@ -499,4 +499,52 @@ - (void)testOpenWhenNotReferrable {
     [self awaitExpectations];
 }
 
+- (void)testEmptyResponseFields {
+    NSString *  DEVICE_TOKEN = @"foo-token";
+    NSString *  USER_URL = @"http://foo";
+    NSString *  DEVELOPER_ID = @"foo";
+    NSString *  SESSION_ID = @"foo-session";
+    NSString *  IDENTITY = @"branch-id";
+    
+    BNCServerResponse *response = [[BNCServerResponse alloc] init];
+    response.data = @{
+        BRANCH_RESPONSE_KEY_RANDOMIZED_DEVICE_TOKEN: DEVICE_TOKEN,
+        BRANCH_RESPONSE_KEY_USER_URL: USER_URL,
+        BRANCH_RESPONSE_KEY_DEVELOPER_IDENTITY: DEVELOPER_ID,
+        BRANCH_RESPONSE_KEY_SESSION_ID: SESSION_ID,
+        BRANCH_RESPONSE_KEY_RANDOMIZED_BUNDLE_TOKEN: IDENTITY
+    };
+    
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
+
+    XCTestExpectation *openExpectation = [self expectationWithDescription:@"OpenRequest Expectation"];
+    BranchOpenRequest *request = [[BranchOpenRequest alloc] initWithCallback:^(BOOL success, NSError *error) {
+        XCTAssertNil(error);
+        XCTAssertTrue(success);
+        [self safelyFulfillExpectation:openExpectation];
+    } isInstall:NO];
+    
+    [request processResponse:response error:nil];
+    
+    [self awaitExpectations];
+    
+    XCTAssertEqualObjects(preferenceHelper.randomizedDeviceToken, DEVICE_TOKEN);
+    XCTAssertEqualObjects(preferenceHelper.userUrl, USER_URL);
+    XCTAssertEqualObjects(preferenceHelper.userIdentity, DEVELOPER_ID);
+    XCTAssertEqualObjects(preferenceHelper.sessionID, SESSION_ID);
+    XCTAssertEqualObjects(preferenceHelper.randomizedBundleToken, IDENTITY);
+    XCTAssertNil(preferenceHelper.sessionParams);
+    XCTAssertNil(preferenceHelper.linkClickIdentifier);
+    XCTAssertNil(preferenceHelper.installParams);
+    
+    // Now call processResponse with empty fields again.
+    response.data = @{};
+    [request processResponse:response error:nil];
+    
+    XCTAssertNotNil(preferenceHelper.randomizedDeviceToken);
+    XCTAssertNotNil(preferenceHelper.userUrl);
+    XCTAssertNotNil(preferenceHelper.sessionID);
+    XCTAssertNotNil(preferenceHelper.randomizedBundleToken);
+}
+
 @end

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

@@ -156,4 +156,26 @@ - (void)testErrorFollowedBySuccess {
     XCTAssertEqualObjects(preferenceHelper.installParams, RESPONSE_INSTALL_PARAMS);
 }
 
+
+- (void)testEmptyResponseFieldsAfterSetIdentity {
+    
+    BNCServerResponse *response = [[BNCServerResponse alloc] init];
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper sharedInstance];
+    
+    __block NSInteger callbackCount = 0;
+    
+    BranchSetIdentityRequest *request = [[BranchSetIdentityRequest alloc] initWithUserId:IDENTITY_TEST_USER_ID callback:^(NSDictionary *params, NSError *error) {
+        callbackCount++;
+        XCTAssertNil(error);
+    }];
+    
+    response.data = @{};
+    [request processResponse:response error:nil];
+    
+    XCTAssertNotNil(preferenceHelper.randomizedDeviceToken);
+    XCTAssertNotNil(preferenceHelper.userUrl);
+    XCTAssertNotNil(preferenceHelper.sessionID);
+    XCTAssertNotNil(preferenceHelper.randomizedBundleToken);
+}
+
 @end