[SDK-2017] Remove v1/profile and v1/logout calls

nsingh-branch · web-flow · commit c4b53a992ac5 · 2023-10-18T09:50:22.000-07:00
diff --git a/Branch/BNCNetworkAPIService.m b/Branch/BNCNetworkAPIService.m
@@ -205,7 +205,7 @@ - (void) postOperationForAPIServiceName:(NSString*)serviceName
         }
     } else {
         NSString *endpoint = url.path;
-        if ([endpoint isEqualToString:@"/v1/open"]) {
+        if ([endpoint isEqualToString:@"/v1/open"] || [endpoint isEqualToString:@"/v1/install"]) {
             dictionary[@"identity"] = self.settings.userIdentityForDeveloper;
         }
     }
@@ -417,8 +417,6 @@ - (void) main {
 
     if (self.session.linkCreationURL.length)
         self.settings.linkCreationURL = self.session.linkCreationURL;
-    if (self.session.userIdentityForDeveloper.length)
-        self.settings.userIdentityForDeveloper = self.session.userIdentityForDeveloper;
     if (self.session.sessionID.length)
         self.settings.sessionID = self.session.sessionID;
        
diff --git a/Branch/BranchMainClass.h b/Branch/BranchMainClass.h
@@ -137,19 +137,27 @@ so that Branch can handle the passed URL.
 
 /**
  Set the user's identity to an ID used by your system, so that it is identifiable by you elsewhere. Receive
- a completion callback, notifying you whether it succeeded or failed.
+ a completion callback.
 
  @param   userId      The ID Branch should use to identify this user.
- @param   completion  The callback to be called once the request has completed (success or failure).
+ @param   completion  The callback to be called once the identity has been set.
 
  @warning If you use the same ID between users on different sessions / devices, their actions will be merged.
- @warning This request is not removed from the queue upon failure -- it will be retried until it succeeds.
-          The callback will only ever be called once, though.
  @warning You should call `logout` before calling `setIdentity:` a second time.
 */
 - (void)setUserIdentity:(NSString*)userId
          completion:(void (^_Nullable)(BranchSession*_Nullable session, NSError*_Nullable error))completion;
 
+/**
+ Set the user's identity to an ID used by your system, so that it is identifiable by you elsewhere.
+
+ @param   userId      The ID Branch should use to identify this user.
+
+ @warning If you use the same ID between users on different sessions / devices, their actions will be merged.
+ @warning You should call `logout` before calling `setIdentity:` a second time.
+*/
+- (void)setUserIdentity:(NSString*)userId;
+
 /**
  Retrieve the user identity set via setUserIdentity
  
@@ -181,6 +189,12 @@ so that Branch can handle the passed URL.
  */
 - (void) logoutWithCompletion:(void (^_Nullable)(NSError*_Nullable error))completion;
 
+/**
+ Clear all of the current user's session items.
+ 
+ */
+- (void) logout;
+
 /**
  Generates a Branch short URL that describes the content described in the Branch Universal Object and
  has the passed link properties.
diff --git a/Branch/BranchMainClass.m b/Branch/BranchMainClass.m
@@ -586,31 +586,37 @@ - (BOOL) userTrackingIsDisabled {
 
 #pragma mark - User Identity
 
+- (void)setUserIdentity:(NSString*)userID {
+    [self setUserIdentity:userID completion:nil];
+}
+
 - (void)setUserIdentity:(NSString*)userID
-         completion:(void (^_Nullable)(BranchSession*session, NSError*_Nullable error))completion {
+             completion:(void (^_Nullable)(BranchSession*session, NSError*_Nullable error))completion {
+    
     if (!userID || [self.settings.userIdentityForDeveloper isEqualToString:userID]) {
         if (completion) completion(nil, nil);   // TODO: fix the session.
         return;
     }
-    // [self initSessionIfNeededAndNotInProgress];
-    NSMutableDictionary *dictionary = [NSMutableDictionary new];
-    dictionary[@"identity"] = userID;
-    dictionary[@"randomized_device_token"] = self.settings.randomizedDeviceToken;
-    dictionary[@"session_id"] = self.settings.sessionID;
-    dictionary[@"randomized_bundle_token"] = self.settings.randomizedBundleToken;
-    [self.networkAPIService appendV1APIParametersWithDictionary:dictionary];
-    [self.networkAPIService postOperationForAPIServiceName:@"v1/profile"
-        dictionary:dictionary
-        completion:^(BNCNetworkAPIOperation*_Nonnull operation) {
-            BNCPerformBlockOnMainThreadAsync(^{
-                if (!operation.error) {
-                    self.settings.userIdentityForDeveloper = userID;
-                    operation.session.userIdentityForDeveloper = userID;
-                }
-                if (completion) completion(operation.session, operation.error);
-            });
-        }
-    ];
+    
+    BranchSession *session = [BranchSession new];
+    
+    if (self.settings.userTrackingDisabled) {
+        [self.settings clearUserIdentifyingInformation];
+        NSError *error = [NSError branchErrorWithCode:BNCTrackingDisabledError];
+        BNCLogError(@"Branch error: %@.", error);
+        if (completion) completion(session, error);
+        return;
+    }
+    
+    BNCPerformBlockOnMainThreadAsync(^{
+        session.userIdentityForDeveloper = userID;
+        session.sessionID = self.settings.sessionID;
+        
+        self.settings.userIdentityForDeveloper = userID;
+        
+        if (completion) completion(session, nil);
+    });
+
 }
 
 - (nullable NSString *)getUserIdentity {
@@ -625,22 +631,19 @@ - (nullable NSString *)getKey {
     return self.configuration.key;
 }
 
-
 #pragma mark - Logout
 
+- (void)logout {
+    [self logoutWithCompletion:nil];
+}
+
 - (void)logoutWithCompletion:(void (^_Nullable)(NSError*_Nullable))completion {
-    NSMutableDictionary *dictionary = [NSMutableDictionary new];
-    dictionary[@"randomized_device_token"] = self.settings.randomizedDeviceToken;
-    dictionary[@"session_id"] = self.settings.sessionID;
-    dictionary[@"randomized_bundle_token"] = self.settings.randomizedBundleToken;
-    [self.networkAPIService appendV1APIParametersWithDictionary:dictionary];
-    [self.networkAPIService postOperationForAPIServiceName:@"v1/logout"
-        dictionary:dictionary
-        completion:^(BNCNetworkAPIOperation * _Nonnull operation) {
-            if (!operation.error)
-                self.settings.userIdentityForDeveloper = nil;
-            BNCPerformBlockOnMainThreadAsync(^{ if (completion) completion(operation.error); });
-        }];
+
+    BNCPerformBlockOnMainThreadAsync(^{
+        self.settings.userIdentityForDeveloper = nil;
+        
+        if (completion) completion(nil);
+    });
 }
 
 #pragma mark - Miscellaneous
diff --git a/BranchTests/BNCDevice.Test.m b/BranchTests/BNCDevice.Test.m
@@ -33,7 +33,7 @@ - (void)testDevice {
 
     XCTAssertTrue(
         device.systemVersion.doubleValue > 10.15 &&
-        device.systemVersion.doubleValue <= 13
+        device.systemVersion.doubleValue <= 14
     );
     XCTAssertTrue(BNCTestStringMatchesRegex(device.systemBuildVersion, @"^[0-9A-Za-z]+$"));
     XCTAssertTrue(
diff --git a/BranchTests/BNCTestNetworkService.Test.m b/BranchTests/BNCTestNetworkService.Test.m
@@ -26,24 +26,17 @@ - (void) testTheTestService {
     XCTestExpectation*requestExpectation = [self expectationWithDescription:@"testTheTestService-1"];
     BNCTestNetworkService.requestHandler = ^ id<BNCNetworkOperationProtocol> (NSMutableURLRequest*request) {
         XCTAssertEqualObjects(request.HTTPMethod, @"POST");
-        XCTAssertEqualObjects(request.URL.path, @"/v1/logout");
-        NSMutableDictionary*truthDictionary = [self mutableDictionaryFromBundleJSONWithKey:@"logoutRequest"];
+        XCTAssertEqualObjects(request.URL.path, @"/v1/install");
+        NSMutableDictionary*truthDictionary = [self mutableDictionaryFromBundleJSONWithKey:@"BranchInstallRequestMac"];
         NSMutableDictionary*requestDictionary = [BNCTestNetworkService mutableDictionaryFromRequest:request];
         XCTAssertNotNil(truthDictionary);
         XCTAssertNotNil(requestDictionary);
 
         [requestExpectation fulfill];
-        NSString*responseString = [self stringFromBundleJSONWithKey:@"logoutResponse"];
+        NSString*responseString = [self stringFromBundleJSONWithKey:@"BranchOpenResponseMac"];
         return [BNCTestNetworkService operationWithRequest:request response:responseString];
     };
-
-    [branch.networkAPIService clearNetworkQueue];
-    XCTestExpectation*expectation = [self expectationWithDescription:@"testTheTestService-2"];
-    [branch logoutWithCompletion:^(NSError * _Nullable error) {
-        XCTAssertNil(error);
-        [expectation fulfill];
-    }];
-
+    
     [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
diff --git a/BranchTests/BranchMainClass.Test.m b/BranchTests/BranchMainClass.Test.m
@@ -66,14 +66,13 @@ - (void) testSetIdentity {
     NSString*const kUserIdentity = @"Nada";
     Branch*branch = self.branch;
     XCTestExpectation *expectation = [self expectationWithDescription:@"testSetIdentity"];
-    [branch setUserIdentity:kUserIdentity
-        completion:^ (BranchSession * _Nullable session, NSError * _Nullable error) {
+    [branch setUserIdentity:kUserIdentity completion:^ (BranchSession * _Nullable session, NSError * _Nullable error) {
             XCTAssertNil(error);
             XCTAssertEqualObjects(session.userIdentityForDeveloper, kUserIdentity);
             [expectation fulfill];
         }
     ];
-    [self waitForExpectationsWithTimeout:5.0 handler:nil];
+    [self waitForExpectationsWithTimeout:0.1 handler:nil];
     XCTAssertTrue(branch.userIdentityIsSet);
 
     [self resetExpectations];
@@ -82,7 +81,7 @@ - (void) testSetIdentity {
         XCTAssertNil(error);
         [expectation fulfill];
     }];
-    [self waitForExpectationsWithTimeout:5.0 handler:nil];
+    [self waitForExpectationsWithTimeout:0.1 handler:nil];
     XCTAssertFalse(branch.userIdentityIsSet);
 }
 
@@ -102,7 +101,7 @@ - (void)testGetUserIdentityEmail {
         XCTAssertEqualObjects(session.userIdentityForDeveloper, userIdentity);
         [expectation fulfill];
     }];
-    [self waitForExpectationsWithTimeout:5.0 handler:nil];
+    [self waitForExpectationsWithTimeout:0.1 handler:nil];
     XCTAssertTrue(branch.userIdentityIsSet);
     XCTAssertTrue([userIdentity isEqualToString:[branch getUserIdentity]]);
 }
@@ -149,13 +148,14 @@ - (void) testShortLinksWithoutBUO1 {
     NSString *channel = @"facebook";
     NSString *feature = @"sharing";
     NSArray *tags = @[ @"t1", @"t2" ];
-    NSString *alias =  @"testAlias";
-    
+    NSString *alias = [NSString stringWithFormat:@"testAlias_%@", [NSUUID UUID].UUIDString];
+
     XCTestExpectation *expectation = [self expectationWithDescription:@"testShortLinksWithoutBUO"];
     [self.branch branchShortUrlWithParams:( NSDictionary * _Nullable )params andChannel:( NSString * _Nullable )channel andFeature:(NSString * _Nullable)feature andTags:(NSArray * _Nullable)tags andAlias:(NSString * _Nullable)alias andCallback:^ (NSURL * _Nullable shortURL, NSError * _Nullable error) {
         XCTAssertNil(error);
         XCTAssertNotNil(shortURL);
-        XCTAssertTrue([shortURL.absoluteString isEqualToString:@"https://testbed-mac.app.link/testAlias"]);
+        NSString *expectedURL = [NSString stringWithFormat:@"https://testbed-mac.app.link/%@", alias];
+        XCTAssertTrue([shortURL.absoluteString isEqualToString:expectedURL]);
         [expectation fulfill];
     }];
     [self waitForExpectationsWithTimeout:5.0 handler:nil];
@@ -167,13 +167,14 @@ - (void) testShortLinksWithoutBUO2 {
     NSString *channel = @"facebook";
     NSString *feature = @"sharing";
     NSArray *tags = @[ @"t1", @"t2" ];
-    NSString *alias =  @"testAlias";
-    
+    NSString *alias = [NSString stringWithFormat:@"testAlias_%@", [NSUUID UUID].UUIDString];
+
     XCTestExpectation *expectation = [self expectationWithDescription:@"testShortLinksWithoutBUO"];
     [self.branch branchShortUrlWithParams:( NSDictionary * _Nullable )params andChannel:( NSString * _Nullable )channel andFeature:(NSString * _Nullable)feature andTags:(NSArray * _Nullable)tags andAlias:(NSString * _Nullable)alias andCallback:^ (NSURL * _Nullable shortURL, NSError * _Nullable error) {
         XCTAssertNil(error);
         XCTAssertNotNil(shortURL);
-        XCTAssertTrue([shortURL.absoluteString isEqualToString:@"https://testbed-mac.app.link/testAlias"]);
+        NSString *expectedURL = [NSString stringWithFormat:@"https://testbed-mac.app.link/%@", alias];
+        XCTAssertTrue([shortURL.absoluteString isEqualToString:expectedURL]);
         [expectation fulfill];
     }];
     [self waitForExpectationsWithTimeout:5.0 handler:nil];
diff --git a/Examples/TestBed-macOS/TestBed-macOS/APPActionItemView.xib b/Examples/TestBed-macOS/TestBed-macOS/APPActionItemView.xib
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="20037" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
+<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="21701" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
     <dependencies>
         <deployment identifier="macosx"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="20037"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="21701"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <objects>
diff --git a/Examples/TestBed-macOS/TestBed-macOS/APPViewController.m b/Examples/TestBed-macOS/TestBed-macOS/APPViewController.m
@@ -160,9 +160,9 @@ - (IBAction) showConfiguration:(id)sender {
 
 - (IBAction) setIdentity:(id)sender {
     [self clearUIFields];
-    [[Branch sharedInstance] setUserIdentity:@"Bob" completion:^ (BranchSession*session, NSError*error) {
+    [[Branch sharedInstance] setUserIdentity:@"BranchUser123" completion:^ (BranchSession*session, NSError*error) {
         self.stateField.stringValue =
-            [NSString stringWithFormat:@"Set Identity: '%@'", session.userIdentityForDeveloper];
+            [NSString stringWithFormat:@"Set Identity: '%@'", [Branch sharedInstance].getUserIdentity];
         self.errorField.stringValue = [self errorMessage:error];
     }];
 }
@@ -171,7 +171,7 @@ - (IBAction) logUserOut:(id)sender {
     BNCLogMethodName();
     [self clearUIFields];
     [[Branch sharedInstance] logoutWithCompletion:^ (NSError*error) {
-        self.stateField.stringValue = @"Log User Out";
+        self.stateField.stringValue = [NSString stringWithFormat:@"Logged User Out: '%@'", [Branch sharedInstance].getUserIdentity];
         self.errorField.stringValue = [self errorMessage:error];
     }];
 }

Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ - (void) postOperationForAPIServiceName:(NSString*)serviceName`
`205`	`205`	`}`
`206`	`206`	`} else {`
`207`	`207`	`NSString *endpoint = url.path;`
`208`		`- if ([endpoint isEqualToString:@"/v1/open"]) {`
	`208`	`+ if ([endpoint isEqualToString:@"/v1/open"] \|\| [endpoint isEqualToString:@"/v1/install"]) {`
`209`	`209`	`dictionary[@"identity"] = self.settings.userIdentityForDeveloper;`
`210`	`210`	`}`
`211`	`211`	`}`
`@@ -417,8 +417,6 @@ - (void) main {`
`417`	`417`
`418`	`418`	`if (self.session.linkCreationURL.length)`
`419`	`419`	`self.settings.linkCreationURL = self.session.linkCreationURL;`
`420`		`- if (self.session.userIdentityForDeveloper.length)`
`421`		`- self.settings.userIdentityForDeveloper = self.session.userIdentityForDeveloper;`
`422`	`420`	`if (self.session.sessionID.length)`
`423`	`421`	`self.settings.sessionID = self.session.sessionID;`
`424`	`422`