SDK-777 switch to NSError

Author: echo-branch

Branch-SDK-Tests/BNCCallbackMapTests.m

@@ -8,6 +8,7 @@
 
 #import <XCTest/XCTest.h>
 #import "BNCCallbackMap.h"
+#import "NSError+Branch.h"
 
 // expose private storage object for state checks
 @interface BNCCallbackMap()
@@ -28,42 +29,67 @@ - (void)tearDown {
     // Put teardown code here. This method is called after the invocation of each test method in the class.
 }
 
-- (void)testSingleSave {
+- (void)testRequestSaveAndCallback {
     BNCCallbackMap *map = [BNCCallbackMap new];
 
     __block BOOL successResult = NO;
-    __block NSString *statusMessageResult = @"no callback";
+    __block NSError *errorResult = nil;
 
     // store a request and callback block
     BNCServerRequest *request = [BNCServerRequest new];
-    [map storeRequest:request withCompletion:^(BOOL success, NSString * _Nonnull statusMessage) {
+    [map storeRequest:request withCompletion:^(BOOL success, NSError * _Nullable error) {
         successResult = success;
-        statusMessageResult = statusMessage;
+        errorResult = error;
     }];
 
     // confirm there's one entry
     XCTAssert([map containsRequest:request] != NO);
     XCTAssert(map.callbacks.count == 1);
 
     // call callback
-    [map callCompletionForRequest:request withSuccessStatus:YES message:@"callback"];
+    [map callCompletionForRequest:request withSuccessStatus:YES error:nil];
 
     // check if variable was updated
     XCTAssertTrue(successResult);
-    XCTAssert([@"callback" isEqualToString:statusMessageResult]);
+    XCTAssertNil(errorResult);
 }
 
-- (void)testDeletedRequest {
+- (void)testRequestSaveAndCallbackWithError {
     BNCCallbackMap *map = [BNCCallbackMap new];
 
-    __block BOOL successResult = NO;
-    __block NSString *statusMessageResult = @"no callback";
+    __block BOOL successResult = YES;
+    __block NSError *errorResult = nil;
+    
+    // store a request and callback block
+    BNCServerRequest *request = [BNCServerRequest new];
+    [map storeRequest:request withCompletion:^(BOOL success, NSError * _Nullable error) {
+        successResult = success;
+        errorResult = error;
+    }];
+    
+    // confirm there's one entry
+    XCTAssert([map containsRequest:request] != NO);
+    XCTAssert(map.callbacks.count == 1);
+    
+    // call callback
+    [map callCompletionForRequest:request withSuccessStatus:NO error:[NSError branchErrorWithCode:BNCGeneralError localizedMessage:@"Test Error"]];
 
+    // check if variable was updated
+    XCTAssertFalse(successResult);
+    XCTAssert([@"Test Error" isEqualToString:errorResult.localizedFailureReason]);
+}
+
+- (void)testAttemptCallbackWithUnsavedRequest {
+    BNCCallbackMap *map = [BNCCallbackMap new];
+    
+    __block BOOL successResult = NO;
+    __block NSError *errorResult = nil;
+
     // store a request and callback block
     BNCServerRequest *request = [BNCServerRequest new];
-    [map storeRequest:request withCompletion:^(BOOL success, NSString * _Nonnull statusMessage) {
+    [map storeRequest:request withCompletion:^(BOOL success, NSError * _Nullable error) {
         successResult = success;
-        statusMessageResult = statusMessage;
+        errorResult = error;
     }];
 
     // confirm there's one entry
@@ -73,34 +99,35 @@ - (void)testDeletedRequest {
     // confirm a new request results in no callback
     request = [BNCServerRequest new];
     XCTAssert([map containsRequest:request] == NO);
-    [map callCompletionForRequest:request withSuccessStatus:YES message:@"callback"];
-    
+    [map callCompletionForRequest:request withSuccessStatus:YES error:nil];
+
     // check if variable was updated
     XCTAssertFalse(successResult);
-    XCTAssert([@"no callback" isEqualToString:statusMessageResult]);
+    XCTAssertNil(errorResult);
 }
 
-- (void)testSeveralBlocks {
+- (void)testRequestsGetReleasedAutomatically {
     BNCCallbackMap *map = [BNCCallbackMap new];
 
     __block int count = 0;
 
     BNCServerRequest *request = [BNCServerRequest new];
-    [map storeRequest:request withCompletion:^(BOOL success, NSString * _Nonnull statusMessage) {
+    [map storeRequest:request withCompletion:^(BOOL success, NSError * _Nullable error) {
         count++;
     }];
 
     for (int i=0; i<100; i++) {
         BNCServerRequest *tmp = [BNCServerRequest new];
-        [map storeRequest:tmp withCompletion:^(BOOL success, NSString * _Nonnull statusMessage) {
-             count++;
+        [map storeRequest:tmp withCompletion:^(BOOL success, NSError * _Nullable error) {
+            count++;
         }];
     }
 
-    // confirm there's less than 100 entries.  By not retaining the tmp request, they should be getting ARC'd
+    // confirm there's less than 100 entries. By not retaining the tmp request, they should be getting ARC'd
     XCTAssert(map.callbacks.count < 100);
 
-    [map callCompletionForRequest:request withSuccessStatus:YES message:@"callback"];
+    // confirm the one request we held does get a callback
+    [map callCompletionForRequest:request withSuccessStatus:YES error:nil];
     XCTAssert(count == 1);
 }
 

Branch-SDK/Branch-SDK/BNCCallbackMap.h

@@ -15,11 +15,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 + (instancetype)shared;
 
-- (void)storeRequest:(BNCServerRequest *)request withCompletion:(void (^_Nullable)(BOOL success, NSString *statusMessage))completion;
+- (void)storeRequest:(BNCServerRequest *)request withCompletion:(void (^_Nullable)(BOOL success, NSError * _Nullable error))completion;
 
 - (BOOL)containsRequest:(BNCServerRequest *)request;
 
-- (void)callCompletionForRequest:(BNCServerRequest *)request withSuccessStatus:(BOOL)status message:(NSString *)statusMessage;
+- (void)callCompletionForRequest:(BNCServerRequest *)request withSuccessStatus:(BOOL)status error:(nullable NSError *)error;
 
 @end
 

Branch-SDK/Branch-SDK/BNCCallbackMap.m

@@ -35,7 +35,7 @@ - (instancetype)init {
     return self;
 }
 
-- (void)storeRequest:(BNCServerRequest *)request withCompletion:(void (^_Nullable)(BOOL success, NSString *statusMessage))completion {
+- (void)storeRequest:(BNCServerRequest *)request withCompletion:(void (^_Nullable)(BOOL success, NSError * _Nullable error))completion {
     [self.callbacks setObject:completion forKey:request];
 }
 
@@ -47,10 +47,10 @@ - (BOOL)containsRequest:(BNCServerRequest *)request {
     return contains;
 }
 
-- (void)callCompletionForRequest:(BNCServerRequest *)request withSuccessStatus:(BOOL)status message:(NSString *)statusMessage {
-    void (^completion)(BOOL, NSString *) = [self.callbacks objectForKey:request];
+- (void)callCompletionForRequest:(BNCServerRequest *)request withSuccessStatus:(BOOL)status error:(nullable NSError *)error {
+    void (^completion)(BOOL, NSError * _Nullable) = [self.callbacks objectForKey:request];
     if (completion) {
-        completion(status, statusMessage);
+        completion(status, error);
     }
 }
 

Branch-SDK/Branch-SDK/Branch.m

@@ -1877,15 +1877,7 @@ - (void) processRequest:(BNCServerRequest*)req
         BNCPerformBlockOnMainThreadSync(^{
             [req processResponse:response error:error];
             if ([req isKindOfClass:[BranchEventRequest class]]) {
-                if (error) {
-                    NSString *message = @"Error: server returned an error";
-                    if (error.description) {
-                        message = [NSString stringWithFormat:@"Error: %@", error.description];
-                    }
-                    [[BNCCallbackMap shared] callCompletionForRequest:req withSuccessStatus:NO message:message];
-                } else {
-                    [[BNCCallbackMap shared] callCompletionForRequest:req withSuccessStatus:YES message:@"Success"];
-                }
+                [[BNCCallbackMap shared] callCompletionForRequest:req withSuccessStatus:(error == nil) error:error];
             }
         });
 
@@ -1925,8 +1917,8 @@ - (void) processRequest:(BNCServerRequest*)req
 
                 // BranchEventRequests can have callbacks directly tied to them.
                 if ([request isKindOfClass:[BranchEventRequest class]]) {
-                    NSString *message = @"Error: server returned an error. Cancelling queued network requests";
-                    [[BNCCallbackMap shared] callCompletionForRequest:request withSuccessStatus:NO message:message];
+                    NSError *error = [NSError branchErrorWithCode:BNCGeneralError localizedMessage:@"Cancelling queued network requests due to a previous network error."];
+                    [[BNCCallbackMap shared] callCompletionForRequest:req withSuccessStatus:NO error:error];
                 }
             });
         }

Branch-SDK/Branch-SDK/BranchEvent.h

@@ -91,7 +91,7 @@ typedef NS_ENUM(NSInteger, BranchEventAdType) {
 /**
  Logs the event on the Branch server.  This version will callback on success/failure.
  */
-- (void)logEventWithCompletion:(void (^_Nullable)(BOOL success, NSString * _Nullable statusMessage))completion;
+- (void)logEventWithCompletion:(void (^_Nullable)(BOOL success, NSError * _Nullable error))completion;
 
 - (void) logEvent;                      //!< Logs the event on the Branch server.  This version automatically caches and retries as necessary.
 - (NSDictionary*_Nonnull) dictionary;   //!< Returns a dictionary representation of the event.

Branch-SDK/Branch-SDK/BranchEvent.m

@@ -222,19 +222,21 @@ - (NSDictionary*) dictionary {
     ];
 }
 
-- (void)logEventWithCompletion:(void (^_Nullable)(BOOL success, NSString *statusMessage))completion {
+- (void)logEventWithCompletion:(void (^_Nullable)(BOOL success, NSError * _Nullable error))completion {
     if (![_eventName isKindOfClass:[NSString class]] || _eventName.length == 0) {
         BNCLogError(@"Invalid event type '%@' or empty string.", NSStringFromClass(_eventName.class));
         if (completion) {
-            completion(NO, @"Error: Invalid event type");
+            NSError *error = [NSError branchErrorWithCode:BNCGeneralError localizedMessage: @"Invalid event type"];
+            completion(NO, error);
         }
         return;
     }
 
     // logEvent requests without a completion are automatically retried later
     if (completion != nil && [[BNCReachability shared] reachabilityStatus] == nil) {
         if (completion) {
-            completion(NO, @"Error: No connectivity");
+            NSError *error = [NSError branchErrorWithCode:BNCGeneralError localizedMessage: @"No connectivity"];
+            completion(NO, error);
         }
         return;
     }