SDK-76 remove NSException on branchKey errors. replace with NSError. Also add unit tests

Author: echo-branch

Branch-SDK/Branch-SDK/Branch.h

@@ -225,9 +225,24 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  You can only set the Branch key once per app run.
 
  @param branchKey The Branch key to use.
+ @param error NSError will be set if Branch encounters a key error.
 */
++ (void) setBranchKey:(NSString*)branchKey error:(NSError **)error;
+
+/**
+ Directly sets the Branch key to be used.  Branch usually reads the Branch key from your app's
+ Info.plist file which is recommended and more convenient.  But the Branch key can also be set
+ with this method. See the documentation at
+ https://dev.branch.io/getting-started/sdk-integration-guide/guide/ios/#configure-xcode-project
+ for information about configuring your app with Branch keys.
+ 
+ You can only set the Branch key once per app run.  Any errors are logged.
+ 
+ @param branchKey The Branch key to use.
+ */
 + (void) setBranchKey:(NSString*)branchKey;
 
+
 /// @return Returns the current Branch key.
 + (NSString*) branchKey;
 

Branch-SDK/Branch-SDK/Branch.m

@@ -339,6 +339,10 @@ + (BranchActivityItemProvider *)getBranchActivityItemWithParams:(NSDictionary *)
 static NSString *bnc_branchKey = nil;
 static BOOL bnc_enableFingerprintIDInCrashlyticsReports = YES;
 
++ (void) resetBranchKey {
+    bnc_branchKey = nil;
+}
+
 + (void) setUseTestBranchKey:(BOOL)useTestKey {
     @synchronized (self) {
         if (bnc_branchKey && !!useTestKey != !!bnc_useTestBranchKey) {
@@ -355,36 +359,51 @@ + (BOOL) useTestBranchKey {
     }
 }
 
-+ (void) setBranchKey:(NSString*)branchKey {
++ (void)setBranchKey:(NSString *)branchKey {
+    NSError *error;
+    [self setBranchKey:branchKey error:&error];
+    
+    if (error) {
+        BNCLogError(@"Branch init error: %@", error.localizedDescription);
+    }
+}
+
++ (void)setBranchKey:(NSString*)branchKey error:(NSError **)error {
     @synchronized (self) {
         if (bnc_branchKey) {
             if (branchKey &&
                 [branchKey isKindOfClass:[NSString class]] &&
                 [branchKey isEqualToString:bnc_branchKey]) {
                 return;
             }
-            BNCLogError(@"Branch key can only be set once.");
+            
+            NSString *errorMessage = [NSString stringWithFormat:@"Branch key can only be set once."];
+            *error = [NSError branchErrorWithCode:BNCInitError localizedMessage:errorMessage];
             return;
         }
+        
         if (![branchKey isKindOfClass:[NSString class]]) {
             NSString *typeName = (branchKey) ? NSStringFromClass(branchKey.class) : @"<nil>";
-            [NSException raise:NSInternalInconsistencyException
-                format:@"Invalid Branch key of type '%@'.", typeName];
+            
+            NSString *errorMessage = [NSString stringWithFormat:@"Invalid Branch key of type '%@'.", typeName];
+            *error = [NSError branchErrorWithCode:BNCInitError localizedMessage:errorMessage];
             return;
         }
 
         if ([branchKey hasPrefix:@"key_test"]) {
             bnc_useTestBranchKey = YES;
+            // Consider making this an NSError?  It's not really an error but users need to be aware they're using a test key.
             BNCLogWarning(
                 @"You are using your test app's Branch Key. "
                  "Remember to change it to live Branch Key for production deployment."
             );
-        } else
-        if ([branchKey hasPrefix:@"key_live"]) {
+        
+        } else if ([branchKey hasPrefix:@"key_live"]) {
             bnc_useTestBranchKey = NO;
+        
         } else {
-            [NSException raise:NSInternalInconsistencyException
-                format:@"Invalid Branch key format. Did you add your Branch key to your Info.plist? Passed key is '%@'.", branchKey];
+            NSString *errorMessage = [NSString stringWithFormat:@"Invalid Branch key format. Did you add your Branch key to your Info.plist? Passed key is '%@'.", branchKey];
+            *error = [NSError branchErrorWithCode:BNCInitError localizedMessage:errorMessage];
             return;
         }
 

Branch-TestBed/Branch-SDK-Unhosted-Tests/Branch_setBranchKeyTests.m

@@ -9,33 +9,91 @@
 #import <XCTest/XCTest.h>
 #import "Branch.h"
 
-/**
- Tests pre-init methods.  These must run unhosted in order to avoid initialization that the test app does.
- */
+// expose private methods used by tests
+@interface Branch()
++ (void) resetBranchKey;
+@end
+
+// Tests pre-init methods.  These run unhosted in order to avoid initialization that the test app does.
 @interface Branch_setBranchKeyTests : XCTestCase
 
 @end
 
 @implementation Branch_setBranchKeyTests
 
 - (void)setUp {
-
+    [Branch resetBranchKey];
 }
 
 - (void)tearDown {
 
 }
 
 - (void)testSetBranchKey_validKey {
-    XCTAssertNoThrow([Branch setBranchKey:@"key_live_foo"]);
+    NSString *testKey = @"key_live_foo";
+    
+    // previous implementation would throw exceptions on misconfiguration, this is deprecated behavior.
+    XCTAssertNoThrow([Branch setBranchKey:testKey]);
+    XCTAssert([[Branch branchKey] isEqualToString:testKey]);
 }
 
 - (void)testSetBranchKey_nilKey {
-    XCTAssertNoThrow([Branch setBranchKey:nil]);
+    NSString *testKey = nil;
+    
+    // previous implementation would throw exceptions on misconfiguration, this is deprecated behavior.
+    XCTAssertNoThrow([Branch setBranchKey:testKey]);
+    XCTAssert([Branch branchKey] == nil);
 }
 
 - (void)testSetBranchKey_invalidKey {
-    XCTAssertNoThrow([Branch setBranchKey:@"invalid_key"]);
+    NSString *testKey = @"invalid_key";
+    
+    // previous implementation would throw exceptions on misconfiguration, this is deprecated behavior.
+    XCTAssertNoThrow([Branch setBranchKey:testKey]);
+    XCTAssert([Branch branchKey] == nil);
+}
+
+- (void)testSetBranchKeyWithError_validKey {
+    NSString *testKey = @"key_live_foo";
+    
+    NSError *error = nil;
+    [Branch setBranchKey:testKey error:&error];
+    XCTAssertNil(error);
+    
+    XCTAssert([[Branch branchKey] isEqualToString:testKey]);
+}
+
+- (void)testSetBranchKeyWithError_nilKey {
+    NSError *error = nil;
+    [Branch setBranchKey:nil error:&error];
+    XCTAssertNotNil(error);
+    
+    XCTAssert([error.localizedFailureReason isEqualToString:@"Invalid Branch key of type '<nil>'."]);
+    XCTAssert([Branch branchKey] == nil);
+}
+
+- (void)testSetBranchKeyWithError_invalidKey {
+    NSError *error = nil;
+    [Branch setBranchKey:@"invalid_key" error:&error];
+    XCTAssertNotNil(error);
+    
+    XCTAssert([error.localizedFailureReason isEqualToString:@"Invalid Branch key format. Did you add your Branch key to your Info.plist? Passed key is 'invalid_key'."]);
+    XCTAssert([Branch branchKey] == nil);
+}
+
+- (void)testSetBranchKeyWithError_validKeyTwice {
+    NSString *testKey = @"key_live_foo";
+    
+    NSError *error = nil;
+    [Branch setBranchKey:testKey error:&error];
+    XCTAssertNil(error);
+    XCTAssert([[Branch branchKey] isEqualToString:testKey]);
+
+    // Cannot change the key after it is set once
+    [Branch setBranchKey:@"key_live_bar" error:&error];
+    XCTAssertNotNil(error);
+    XCTAssert([error.localizedFailureReason isEqualToString:@"Branch key can only be set once."]);
+    XCTAssert([[Branch branchKey] isEqualToString:testKey]);
 }
 
 @end