Switch to Completion Block Based Approach

• Instead of using a pointer based approach to setting the display type for a given notification, we are switching to using a completion block (callback)
• This commit changes the OSNotificationDisplayTypeDelegate to accept the completion block. If the delegate has been set, the SDK will wait until the delegate calls the completion block to deliver a notification.

Author: Nightsd01

iOS_SDK/OneSignalSDK/Source/OneSignal.h

@@ -213,10 +213,14 @@ typedef NS_ENUM(NSInteger, OSNotificationPermission) {
     OSNotificationPermissionProvisional
 };
 
+typedef void (^OSNotificationDisplayTypeResponse)(OSNotificationDisplayType displayType);
+
 // Notification Display Type Delegate
 // Allows apps to customize per-notification display-type
 @protocol OSNotificationDisplayTypeDelegate <NSObject>
-- (void)willPresentInFocusNotificationWithPayload:(OSNotificationPayload *)payload forDisplayType:(OSNotificationDisplayType *)type;
+- (void)willPresentInFocusNotificationWithPayload:(OSNotificationPayload *)payload
+                           withDefaultDisplayType:(OSNotificationDisplayType)displayType
+                                   withCompletion:(OSNotificationDisplayTypeResponse)completion;
 @end
 
 

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -201,8 +201,7 @@ @implementation OneSignal
 // Display type is used in multiple areas of the SDK
 // To avoid calling the delegate multiple times, we store
 // the type and notification ID for each notification
-static NSString *_lastCustomDisplayTypeNotificationId;
-static OSNotificationDisplayType _lastCustomDisplayType;
+static NSMutableDictionary<NSString *, NSNumber *> *_displayTypeMap;
 
 static OSNotificationDisplayType _inFocusDisplayType = OSNotificationDisplayTypeInAppAlert;
 + (void)setInFocusDisplayType:(OSNotificationDisplayType)value {
@@ -403,7 +402,7 @@ + (void)clearStatics {
     pendingExternalUserId = nil;
 
     _displayDelegate = nil;
-    _lastCustomDisplayTypeNotificationId = nil;
+    _displayTypeMap = [NSMutableDictionary new];
 }
 
 // Set to false as soon as it's read.
@@ -1758,27 +1757,37 @@ + (void)setLastAppActiveMessageId:(NSString*)value { _lastAppActiveMessageId = v
 static NSString *_lastnonActiveMessageId;
 + (void)setLastnonActiveMessageId:(NSString*)value { _lastnonActiveMessageId = value; }
 
-+ (OSNotificationDisplayType)displayTypeForNotificationPayload:(NSDictionary *)payload {
-    var type = self.inFocusDisplayType;
-    
-    // check to make sure the app is in focus and it's a OneSignal notification
-    if (![OneSignalHelper isOneSignalPayload:payload]
-        || UIApplication.sharedApplication.applicationState != UIApplicationStateActive)
-        return type;
-    
-    let osPayload = [OSNotificationPayload parseWithApns:payload];
-    
-    // Prevent calling the delegate multiple times for the same payload
-    if (_lastCustomDisplayTypeNotificationId && [osPayload.notificationID isEqualToString:_lastCustomDisplayTypeNotificationId])
-        return _lastCustomDisplayType;
-    
-    if (_displayDelegate) {
-        [_displayDelegate willPresentInFocusNotificationWithPayload:osPayload forDisplayType:&type];
-        _lastCustomDisplayType = type;
-        _lastCustomDisplayTypeNotificationId = osPayload.notificationID;
-    }
-    
-    return type;
++ (void)displayTypeForNotificationPayload:(NSDictionary *)payload withCompletion:(OSNotificationDisplayTypeResponse)completion {
+    [OneSignalHelper runOnMainThread:^{
+        var type = self.inFocusDisplayType;
+        
+        // check to make sure the app is in focus and it's a OneSignal notification
+        if (![OneSignalHelper isOneSignalPayload:payload]
+            || UIApplication.sharedApplication.applicationState != UIApplicationStateActive) {
+            completion(type);
+            return;
+        }
+        
+        let osPayload = [OSNotificationPayload parseWithApns:payload];
+        
+        let notificationId = osPayload.notificationID;
+        
+        // Prevent calling the delegate multiple times for the same payload
+        if (_displayTypeMap[osPayload.notificationID]) {
+            type = (OSNotificationDisplayType)[_displayTypeMap[osPayload.notificationID] intValue];
+            completion(type);
+        } else if (_displayDelegate) {
+            [_displayDelegate willPresentInFocusNotificationWithPayload:osPayload withDefaultDisplayType:type withCompletion:^(OSNotificationDisplayType displayType) {
+                [OneSignalHelper runOnMainThread:^{
+                    _displayTypeMap[notificationId] = @((int)displayType);
+                    completion(displayType);
+                }];
+            }];
+        } else {
+            _displayTypeMap[notificationId] = @((int)type);
+            completion(type);
+        }
+    }];
 }
 
 // Entry point for the following:
@@ -1812,40 +1821,46 @@ + (void)notificationReceived:(NSDictionary*)messageDict isActive:(BOOL)isActive
         if (newId)
             _lastAppActiveMessageId = newId;
 
-        let displayType = [self displayTypeForNotificationPayload:messageDict];
-        
-        let inAppAlert = (displayType == OSNotificationDisplayTypeInAppAlert);
-        
-        // Make sure it is not a silent one do display, if inAppAlerts are enabled
-        if (inAppAlert && ![OneSignalHelper isRemoteSilentNotification:messageDict]) {
-            [OneSignalAlertView showInAppAlert:messageDict];
-            return;
-        }
-        
-        // App is active and a notification was received without inApp display. Display type is none or notification
-        // Call Received Block
-        [OneSignalHelper handleNotificationReceived:displayType];
+        [self displayTypeForNotificationPayload:messageDict withCompletion:^(OSNotificationDisplayType displayType) {
+            let inAppAlert = (displayType == OSNotificationDisplayTypeInAppAlert);
+            
+            // Make sure it is not a silent one do display, if inAppAlerts are enabled
+            if (inAppAlert && ![OneSignalHelper isRemoteSilentNotification:messageDict]) {
+                [OneSignalAlertView showInAppAlert:messageDict];
+                return;
+            }
+            
+            // App is active and a notification was received without inApp display. Display type is none or notification
+            // Call Received Block
+            [OneSignalHelper handleNotificationReceived:displayType];
+            
+            if (opened)
+                [self openedNotificationWithDisplayType:displayType withPayload:messageDict isActive:isActive];
+        }];
     } else {
         // Prevent duplicate calls
         let newId = [self checkForProcessedDups:customDict lastMessageId:_lastnonActiveMessageId];
         if ([@"dup" isEqualToString:newId])
             return;
         if (newId)
             _lastnonActiveMessageId = newId;
-    }
-    
-    if (opened) {
-        //app was in background / not running and opened due to a tap on a notification or an action check what type
-        OSNotificationActionType type = OSNotificationActionTypeOpened;
-        
-        if (messageDict[@"custom"][@"a"][@"actionSelected"] || messageDict[@"actionSelected"])
-            type = OSNotificationActionTypeActionTaken;
 
-        // Call Action Block
-        [OneSignal handleNotificationOpened:messageDict isActive:isActive actionType:type displayType:OneSignal.inFocusDisplayType];
+        if (opened)
+            [self openedNotificationWithDisplayType:OneSignal.inFocusDisplayType withPayload:messageDict isActive:isActive];
     }
 }
 
++ (void)openedNotificationWithDisplayType:(OSNotificationDisplayType)displayType withPayload:(NSDictionary *)payload isActive:(BOOL)isActive {
+    //app was in background / not running and opened due to a tap on a notification or an action check what type
+    OSNotificationActionType type = OSNotificationActionTypeOpened;
+    
+    if (payload[@"custom"][@"a"][@"actionSelected"] || payload[@"actionSelected"])
+        type = OSNotificationActionTypeActionTaken;
+    
+    // Call Action Block
+    [OneSignal handleNotificationOpened:payload isActive:isActive actionType:type displayType:displayType];
+}
+
 + (NSString*) checkForProcessedDups:(NSDictionary*)customDict lastMessageId:(NSString*)lastMessageId {
     if (customDict && customDict[@"i"]) {
         NSString* currentNotificationId = customDict[@"i"];

iOS_SDK/OneSignalSDK/Source/UNUserNotificationCenter+OneSignal.m

@@ -46,10 +46,12 @@
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
 
+typedef void (^OSUNNotificationCenterCompletionHandler)(UNNotificationPresentationOptions options);
+
 @interface OneSignal (UN_extra)
 + (void)notificationReceived:(NSDictionary*)messageDict isActive:(BOOL)isActive wasOpened:(BOOL)opened;
 + (BOOL)shouldLogMissingPrivacyConsentErrorWithMethodName:(NSString *)methodName;
-+ (OSNotificationDisplayType)displayTypeForNotificationPayload:(NSDictionary *)payload;
++ (void)displayTypeForNotificationPayload:(NSDictionary *)payload withCompletion:(OSNotificationDisplayTypeResponse)completion;
 @end
 
 // This class hooks into the following iSO 10 UNUserNotificationCenterDelegate selectors:
@@ -176,12 +178,19 @@ - (void)onesignalUserNotificationCenter:(UNUserNotificationCenter *)center
 
     [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"onesignalUserNotificationCenter:willPresentNotification:withCompletionHandler: Fired!"];
 
+    [OneSignal displayTypeForNotificationPayload:notification.request.content.userInfo withCompletion:^(OSNotificationDisplayType displayType) {
+        finishProcessingNotification(notification, center, displayType, completionHandler, self);
+    }];
+}
+
+// To avoid complications caused by swizzling, this is implemented as a C function
+void finishProcessingNotification(UNNotification *notification,
+                                  UNUserNotificationCenter *center,
+                                  OSNotificationDisplayType displayType,
+                                  OSUNNotificationCenterCompletionHandler completionHandler,
+                                  OneSignalUNUserNotificationCenter *instance) {
     NSUInteger completionHandlerOptions = 0;
 
-    let messagePayload = notification.request.content.userInfo;
-    
-    let displayType = [OneSignal displayTypeForNotificationPayload:messagePayload];
-    
     switch (displayType) {
         case OSNotificationDisplayTypeNone: completionHandlerOptions = 0; break; // Nothing
         case OSNotificationDisplayTypeInAppAlert: completionHandlerOptions = 3; break; // Badge + Sound
@@ -192,19 +201,19 @@ - (void)onesignalUserNotificationCenter:(UNUserNotificationCenter *)center
     let notShown = displayType == OSNotificationDisplayTypeNone && notification.request.content.body != nil;
 
     if ([OneSignal app_id])
-        [OneSignal notificationReceived:messagePayload isActive:YES wasOpened:notShown];
+        [OneSignal notificationReceived:notification.request.content.userInfo isActive:YES wasOpened:notShown];
 
     // Call orginal selector if one was set.
-    if ([self respondsToSelector:@selector(onesignalUserNotificationCenter:willPresentNotification:withCompletionHandler:)])
-        [self onesignalUserNotificationCenter:center willPresentNotification:notification withCompletionHandler:completionHandler];
+    if ([instance respondsToSelector:@selector(onesignalUserNotificationCenter:willPresentNotification:withCompletionHandler:)])
+        [instance onesignalUserNotificationCenter:center willPresentNotification:notification withCompletionHandler:completionHandler];
     // Or call a legacy AppDelegate selector
     else {
         [OneSignalUNUserNotificationCenter callLegacyAppDeletegateSelector:notification
-                                                isTextReply:false
-                                           actionIdentifier:nil
-                                                   userText:nil
-                                    fromPresentNotification:true
-                                      withCompletionHandler:^() {}];
+                                                               isTextReply:false
+                                                          actionIdentifier:nil
+                                                                  userText:nil
+                                                   fromPresentNotification:true
+                                                     withCompletionHandler:^() {}];
     }
 
     // Calling completionHandler for the following reasons:

iOS_SDK/OneSignalSDK/UnitTests/DummyNotificationDisplayTypeDelegate.m

@@ -37,10 +37,10 @@ - (instancetype)init {
     return self;
 }
 
-- (void)willPresentInFocusNotificationWithPayload:(OSNotificationPayload *)payload forDisplayType:(OSNotificationDisplayType *)type {
+- (void)willPresentInFocusNotificationWithPayload:(OSNotificationPayload *)payload withDefaultDisplayType:(OSNotificationDisplayType)displayType withCompletion:(OSNotificationDisplayTypeResponse)completion {
     _notificationId = payload.notificationID;
 
-    *type = _overrideDisplayType;
+    completion(_overrideDisplayType);
 
     _numberOfCalls += 1;
 }