[cleanup] remove unused methods from OneSignalClient

Looks like these methods are no longer used within the SDK, so let's remove them from OneSignalClient:
- executeSimultaneousRequests
- executeSynchronousRequest
- executeDataRequest

Update OneSignalClient.h

And types:
- OSDataRequestSuccessBlock
- OSMultipleCompletionBlock
- OSMultipleFailureBlock
- OSMultipleSuccessBlock

- genericTimedOutError

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalCore/Source/API/OneSignalClient.h

@@ -31,52 +31,9 @@
 #ifndef OneSignalClient_h
 #define OneSignalClient_h
 
-typedef void (^OSDataRequestSuccessBlock)(NSData *data);
-
-typedef void (^OSMultipleCompletionBlock)(NSDictionary *responses);
-typedef void (^OSMultipleFailureBlock)(NSDictionary<NSString *, NSError *> *errors);
-typedef void (^OSMultipleSuccessBlock)(NSDictionary<NSString *, NSDictionary *> *results);
-
 @interface OneSignalClient : NSObject
 + (OneSignalClient *)sharedClient;
 - (void)executeRequest:(OneSignalRequest *)request onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock;
-- (void)executeSynchronousRequest:(OneSignalRequest *)request onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock;
-
-// ie. for loading HTML or other non-JSON based requests
-- (void)executeDataRequest:(OneSignalRequest *)request onSuccess:(OSDataRequestSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock;
-
-// Executes multiple OneSignalRequest's simultaneously, needs a unique identifier for each request
-- (void)executeSimultaneousRequests:(NSDictionary<NSString *, OneSignalRequest *> *)requests withSuccess:(OSMultipleSuccessBlock)successBlock onFailure:(OSMultipleFailureBlock)failureBlock;
-
-/*
- TODO: We want to eventually migrate over to using this method for executing simultaneous requests:
-  This allows us to combine multiple async concurrent requests to return from a single callback with the proper formatted responses from each reuqest (successful or not, account for params returning from GETs).
-  A generalized format should be followed and we should make sure not to break form that as it could break peoples apps in the future if we add params and remove params from this callback.
-  Currently for the only implementation this is used for "setExternalUserId:withCOmpletion:" the format is as follows:
-  
-     NSDictionary response = @{
-        (required) @"push" : {
-            @"success" : @(true) or @(false)
-        },
-        
-        (optional) @"email" : {
-            @"success" : @(true) or @(false)
-        }
-     }
-
- 
-  Building off of this format now will require:
- 
-    1. Including other attributes and whether they are required or not
-        ex. @"push" is always going to be within the callback resposne (required), meanwhile,
-            @"email" will not always exist in the callback resposne (optoinal)
-    
-    2. Can't remove params that are required as an app may be expecting them and removing/modifying a key could break there app with an SDK upgrade
-    
-    3. Add more requirements...
- 
- */
-- (void)executeSimultaneousRequests:(NSDictionary<NSString *, OneSignalRequest *> *)requests withCompletion:(OSMultipleCompletionBlock)completionBlock;
 @end
 
 #endif

iOS_SDK/OneSignalSDK/OneSignalCore/Source/API/OneSignalClient.m

@@ -73,117 +73,6 @@ - (NSError *)privacyConsentErrorWithRequestType:(NSString *)type {
     return [NSError errorWithDomain:@"OneSignal Error" code:0 userInfo:@{@"error" : [NSString stringWithFormat: @"Attempted to perform an HTTP request (%@) before the user provided privacy consent.", type]}];
 }
 
-- (NSError *)genericTimedOutError {
-    return [NSError errorWithDomain:@"OneSignal Error" code:0 userInfo:@{@"error" : @"The request timed out"}];
-}
-
-- (void)executeSimultaneousRequests:(NSDictionary<NSString *, OneSignalRequest *> *)requests withCompletion:(OSMultipleCompletionBlock)completionBlock {
-    if (requests.allKeys.count == 0)
-        return;
-    
-    // Execute on a background thread or the semaphore will block the caller thread
-    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
-        dispatch_group_t group = dispatch_group_create();
-        
-        __block NSMutableDictionary<NSString *, NSError *> *errors = [NSMutableDictionary new];
-        __block NSMutableDictionary<NSString *, NSDictionary *> *results = [NSMutableDictionary new];
-        
-        // Used as the reasposne for the completion callback
-        __block NSMutableDictionary *response = [NSMutableDictionary new];
-        
-        for (NSString *identifier in requests.allKeys) {
-            OneSignalRequest *request = requests[identifier];
-            
-            // Use a dispatch_group instead of a semaphore, in case the failureBlock gets called synchronously
-            // This will prevent the SDK from waiting/blocking on a request that instantly failed
-            dispatch_group_enter(group);
-            [self executeRequest:request onSuccess:^(NSDictionary *result) {
-                results[identifier] = result;
-                // Add a success as 1 (success) to the response
-                response[identifier] = @{ @"success" : @(true) };
-                [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Request %@ success result %@", request, result]];
-                dispatch_group_leave(group);
-            } onFailure:^(NSError *error) {
-                errors[identifier] = error;
-                // Add a success as 0 (failed) to the response
-                response[identifier] = @{ @"success" : @(false) };
-                [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Request %@ fail result error %@", request, error]];
-
-                dispatch_group_leave(group);
-            }];
-        }
-        
-        // Will wait for up to (maxTimeout) seconds and will then give up and call
-        //  the failure block if the request times out.
-        BOOL timedOut = (bool)(0 != dispatch_group_wait(group, dispatch_time(DISPATCH_TIME_NOW, MAX_TIMEOUT)));
-        
-        // Add a generic 'timed out' error if the request timed out
-        //  and there are no other errors present.
-        if (timedOut && errors.allKeys.count == 0) {
-            for (NSString *key in requests.allKeys) {
-                errors[key] = [self genericTimedOutError];
-                // Add a success as 0 (timeout/failed) to the response
-                response[key] = @{ @"success" : @(false) };
-            }
-        }
-        
-        // Requests should all be completed at this point, the response NSDictionary will be passed back
-        dispatch_async(dispatch_get_main_queue(), ^{
-            if (completionBlock)
-                completionBlock(response);
-        });
-    });
-}
-
-- (void)executeSimultaneousRequests:(NSDictionary<NSString *, OneSignalRequest *> *)requests withSuccess:(OSMultipleSuccessBlock)successBlock onFailure:(OSMultipleFailureBlock)failureBlock {
-    if (requests.allKeys.count == 0)
-        return;
-    
-    //execute on a background thread or the semaphore will block the caller thread
-    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
-        dispatch_group_t group = dispatch_group_create();
-        
-        __block NSMutableDictionary<NSString *, NSError *> *errors = [NSMutableDictionary new];
-        __block NSMutableDictionary<NSString *, NSDictionary *> *results = [NSMutableDictionary new];
-        
-        for (NSString *identifier in requests.allKeys) {
-            OneSignalRequest *request = requests[identifier];
-            
-            //use a dispatch_group instead of a semaphore, in case the failureBlock gets called synchronously
-            //this will prevent the SDK from waiting/blocking on a request that instantly failed
-            dispatch_group_enter(group);
-            [self executeRequest:request onSuccess:^(NSDictionary *result) {
-                results[identifier] = result;
-                [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Request %@ success result %@", request, result]];
-                dispatch_group_leave(group);
-            } onFailure:^(NSError *error) {
-                errors[identifier] = error;
-                [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Request %@ fail result error %@", request, error]];
-                dispatch_group_leave(group);
-            }];
-        }
-        
-        // Will wait for up to (maxTimeout) seconds and will then give up and call
-        // the failure block if the request times out.
-        BOOL timedOut = (bool)(0 != dispatch_group_wait(group, dispatch_time(DISPATCH_TIME_NOW, MAX_TIMEOUT)));
-        
-        // add a generic 'timed out' error if the request timed out
-        // and there are no other errors present.
-        if (timedOut && errors.allKeys.count == 0)
-            for (NSString *key in requests.allKeys)
-                errors[key] = [self genericTimedOutError];
-        
-        //requests should all be completed at this point
-        dispatch_async(dispatch_get_main_queue(), ^{
-            if (errors.allKeys.count > 0 && failureBlock) {
-                failureBlock(errors);
-            } else if (errors.allKeys.count == 0 && successBlock) {
-                successBlock(results);
-            }
-        });
-    });
-}
-
 - (void)executeRequest:(OneSignalRequest *)request onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock {
     // If privacy consent is required but not yet given, any non-GET request should be blocked.
     if (request.method != GET && [OSPrivacyConsentController shouldLogMissingPrivacyConsentErrorWithMethodName:nil]) {
@@ -223,75 +112,6 @@ - (void)executeRequest:(OneSignalRequest *)request onSuccess:(OSResultSuccessBlo
     [task resume];
 }
 
-// while this method still uses completion blocks like the asynchronous method,
-// it pauses execution of the thread until the request is finished
-- (void)executeSynchronousRequest:(OneSignalRequest *)request onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock {
-    if (![self validRequest:request]) {
-        [self handleMissingAppIdError:failureBlock withRequest:request];
-        return;
-    }
-    
-    if (request.dataRequest) {
-        if (failureBlock) {
-            failureBlock([NSError errorWithDomain:@"onesignal" code:0 userInfo:@{@"error" : [NSString stringWithFormat:@"Attempted to execute a data-only API request (%@) using OneSignalClient's executeRequest: method, which only accepts JSON-based API requests", NSStringFromClass(request.class)]}]);
-        }
-        
-        return;
-    }
-    
-    __block NSURLResponse *httpResponse;
-    __block NSError *httpError;
-    
-    dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
-    
-    NSURLSessionDataTask *dataTask = [self.sharedSession dataTaskWithRequest:request.urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
-        httpResponse = response;
-        httpError = error;
-        
-        dispatch_semaphore_signal(semaphore);
-    }];
-    
-    [dataTask resume];
-    
-    dispatch_semaphore_wait(semaphore, dispatch_time(DISPATCH_TIME_NOW, REQUEST_TIMEOUT_RESOURCE * NSEC_PER_SEC));
-    
-    [self handleJSONNSURLResponse:httpResponse data:nil error:httpError isAsync:false withRequest:request onSuccess:successBlock onFailure:failureBlock];
-}
-
-- (void)executeDataRequest:(OneSignalRequest *)request onSuccess:(OSDataRequestSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock {
-    [self prettyPrintDebugStatementWithRequest:request];
-    
-    if (!request.dataRequest) {
-        if (failureBlock) {
-            failureBlock([NSError errorWithDomain:@"onesignal" code:0 userInfo:@{@"error" : [NSString stringWithFormat:@"Attempted to execute an API request (%@) using OneSignalClient's executeDataRequest: method, which only accepts data based requests", NSStringFromClass(request.class)]}]);
-        }
-        
-        return;
-    }
-    
-    NSURLSession *session = request.disableLocalCaching ? self.noCacheSession : self.sharedSession;
-    
-    NSURLSessionDataTask *task = [session dataTaskWithRequest:request.urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
-        NSError *requestError = error;
-        int status = (int)((NSHTTPURLResponse *)response).statusCode;
-        
-        if (requestError || status >= 300) {
-            if (!requestError)
-                requestError = [NSError errorWithDomain:@"onesignal" code:0 userInfo:@{@"error" : [NSString stringWithFormat:@"Request (%@)encountered an unknown error with HTTP status code %i", NSStringFromClass([request class]), status]}];
-            
-            if (failureBlock)
-                failureBlock(requestError);
-            
-            return;
-        }
-        
-        if (successBlock)
-            successBlock(data);
-    }];
-    
-    [task resume];
-}
-
 - (void)handleMissingAppIdError:(OSFailureBlock)failureBlock withRequest:(OneSignalRequest *)request {
     NSString *errorDescription = [NSString stringWithFormat:@"HTTP Request (%@) must contain app_id parameter", NSStringFromClass([request class])];