Merge pull request #952 from OneSignal/fix/failure_block_in_send_tags

Calling the failure block of send tags for bad input

Author: emawby

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -1248,17 +1248,27 @@ + (void)sendTags:(NSDictionary*)keyValuePair {
 + (void)sendTags:(NSDictionary*)keyValuePair onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock {
 
     // return if the user has not granted privacy permissions
-    if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:@"sendTags:onSuccess:onFailure:"])
+    if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:@"sendTags:onSuccess:onFailure:"]) {
+        NSError *error = [NSError errorWithDomain:@"com.onesignal.tags" code:0 userInfo:@{@"error" : @"Your application has called sendTags:onSuccess:onFailure: before the user granted privacy permission. Please call `consentGranted(bool)` in order to provide user privacy consent"}];
+        failureBlock(error);
         return;
+    }
+        
 
     if (![NSJSONSerialization isValidJSONObject:keyValuePair]) {
-        onesignal_Log(ONE_S_LL_WARN, [NSString stringWithFormat:@"sendTags JSON Invalid: The following key/value pairs you attempted to send as tags are not valid JSON: %@", keyValuePair]);
+        NSString *errorMessage = [NSString stringWithFormat:@"sendTags JSON Invalid: The following key/value pairs you attempted to send as tags are not valid JSON: %@", keyValuePair];
+        onesignal_Log(ONE_S_LL_WARN, errorMessage);
+        NSError *error = [NSError errorWithDomain:@"com.onesignal.tags" code:0 userInfo:@{@"error" : errorMessage}];
+        failureBlock(error);
         return;
     }
 
     for (NSString *key in [keyValuePair allKeys]) {
         if ([keyValuePair[key] isKindOfClass:[NSDictionary class]]) {
-            onesignal_Log(ONE_S_LL_WARN, @"sendTags Tags JSON must not contain nested objects");
+            NSString *errorMessage = @"sendTags Tags JSON must not contain nested objects";
+            onesignal_Log(ONE_S_LL_WARN, errorMessage);
+            NSError *error = [NSError errorWithDomain:@"com.onesignal.tags" code:0 userInfo:@{@"error" : errorMessage}];
+            failureBlock(error);
             return;
         }
     }

iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m

@@ -1388,15 +1388,23 @@ - (void)testSendBadObjectInTags {
     [UnitTestCommonMethods initOneSignal_andThreadWait];
 
     XCTAssertEqual(OneSignalClientOverrider.networkRequestCount, 2);
+    XCTestExpectation *errorExpectation = [self expectationWithDescription:@"onesignal_failure_block_called"];
+    errorExpectation.expectedFulfillmentCount = 1;
     //The OneSignal class is not a valid json object
-    [OneSignal sendTags:@{@"key1": @"value1", @"key2": [OneSignal new]}];
+    [OneSignal sendTags:@{@"key1": @"value1", @"key2": [OneSignal new]} onSuccess:^(NSDictionary *result) {
+        XCTAssertNotNil(nil); //Assert if success is called
+    } onFailure:^(NSError *error) {
+        XCTAssertEqualObjects(error.domain, @"com.onesignal.tags");
+        [errorExpectation fulfill];
+    }];
 
     // Make sure the tags were not sent.
     [NSObjectOverrider runPendingSelectors];
     [UnitTestCommonMethods runBackgroundThreads];
     [NSObjectOverrider runPendingSelectors];
 
     XCTAssertEqual(OneSignalClientOverrider.networkRequestCount, 2);
+    [self waitForExpectations:@[errorExpectation] timeout:1];
 }
 
 - (void)testDeleteTags {