Lp 11236 fix push metrics (#386)

* fixing remote notifications metrics

* prevent sending open status to server when app is in foreground and there is no users action

* remove logs and no needed code

* set appWasActivatedByReceivingPushNotification to NO when code goes through the logic to handle opening of push notificaiton

* fix tests

* added logs for push received and opened

Co-authored-by: Mayank Sanganeria <[email protected]>

Author: dejan2k

Example/Tests/Classes/LPPushNotificationsHandlerTest.m

@@ -19,10 +19,11 @@
 #import "LPPushNotificationsManager.h"
 #import "LPNotificationsManager.h"
 
-
 @interface LPPushNotificationsHandler (Test)
 - (void)requireMessageContent:(NSString *)messageId
           withCompletionBlock:(LeanplumVariablesChangedBlock)onCompleted;
+- (void)handleNotificationResponse:(NSDictionary *)userInfo
+                 completionHandler:(LeanplumFetchCompletionBlock)completionHandler;
 @end
 
 @interface LPPushNotificationsHandlerTest : XCTestCase
@@ -90,16 +91,27 @@ - (void) test_receive_notification
                                @"_lpx": @"test_action",
                                @"aps" : @{@"alert": @"test"}};
 
-    XCTestExpectation* expectation = [self expectationWithDescription:@"notification"];
+    XCTestExpectation* userNotificationCenterExpectation = [self expectationWithDescription:@"UNUserNotificationCenter_notification"];
+    XCTestExpectation* applicationNotificationExpectation = [self expectationWithDescription:@"UIApplication_notification"];
 
     LPPushNotificationsHandler *handler = [[LPPushNotificationsHandler alloc] init];
 
+    //test when UNUserNotificationCenter.currentNotificationCenter.delegate is set
+    if (UNUserNotificationCenter.currentNotificationCenter.delegate != nil) {
+        [handler handleNotificationResponse:userInfo completionHandler:^(LeanplumUIBackgroundFetchResult result) {
+            [userNotificationCenterExpectation fulfill];
+        }];
+    }
+    
+    //test when UNUserNotificationCenter.currentNotificationCenter.delegate is nil
+    UNUserNotificationCenter.currentNotificationCenter.delegate = nil;
     [handler didReceiveRemoteNotification:userInfo
                                withAction:@"test_action"
                    fetchCompletionHandler: ^(LeanplumUIBackgroundFetchResult result) {
-                                            [expectation fulfill];
+                                            [applicationNotificationExpectation fulfill];
 
-                    }];
+    }];
+    
     [self waitForExpectationsWithTimeout:10 handler:nil];
 }
 

Leanplum-SDK/Classes/Notifications/Push/LPPushNotificationsHandler.h

@@ -14,6 +14,7 @@ NS_ASSUME_NONNULL_BEGIN
 @interface LPPushNotificationsHandler : NSObject
 
 @property (nonatomic, strong) LeanplumShouldHandleNotificationBlock shouldHandleNotification;
+@property (nonatomic, assign) BOOL appWasActivatedByReceivingPushNotification;
 
 - (void)didReceiveRemoteNotification:(NSDictionary *)userInfo;
 - (void)didReceiveRemoteNotification:(NSDictionary *)userInfo
@@ -23,6 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
               fetchCompletionHandler:(LeanplumFetchCompletionBlock __nullable)completionHandler;
 - (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)token;
 - (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error;
+- (void)handleWillPresentNotification:(NSDictionary *)userInfo;
 - (void)willPresentNotification:(UNNotification *)notification
           withCompletionHandler:(void(^)(UNNotificationPresentationOptions options))completionHandler API_AVAILABLE(ios(10.0));
 - (void)didReceiveNotificationResponse:(UNNotificationResponse *)response

Leanplum-SDK/Classes/Notifications/Push/LPPushNotificationsHandler.m

@@ -44,10 +44,18 @@ - (void)didReceiveRemoteNotification:(NSDictionary *)userInfo
 
 -(void)didReceiveRemoteNotification:(NSDictionary *)userInfo withAction:(NSString *__nullable)action fetchCompletionHandler:(LeanplumFetchCompletionBlock __nullable)completionHandler
 {
+    if (@available(iOS 10, *)) {
+        if ([UNUserNotificationCenter currentNotificationCenter].delegate != nil) {
+            if (UIApplication.sharedApplication.applicationState != UIApplicationStateBackground) {
+                return;
+            }
+        }
+    }
+    
     [self.countAggregator incrementCount:@"did_receive_remote_notification"];
 
     // If app was inactive, then handle notification because the user tapped it.
-    if ([[UIApplication sharedApplication] applicationState] != UIApplicationStateActive) {
+    if ([[UIApplication sharedApplication] applicationState] == UIApplicationStateInactive) {
         [self handleNotification:userInfo
                       withAction:action
                        appActive:NO
@@ -184,19 +192,26 @@ - (void)handleNotification:(NSDictionary *)userInfo
     if (messageId == nil) {
         return;
     }
-
+    
     void (^onContent)(void) = ^{
         if (completionHandler) {
             completionHandler(UIBackgroundFetchResultNewData);
         }
+        
         BOOL hasAlert = userInfo[@"aps"][@"alert"] != nil;
         if (hasAlert) {
-            UIApplicationState appState = [[UIApplication sharedApplication] applicationState];
-            if (appState != UIApplicationStateBackground) {
-                [self maybePerformNotificationActions:userInfo action:action active:active];
-            }
+            [self maybePerformNotificationActions:userInfo action:action active:active];
         }
     };
+    
+    if (UIApplication.sharedApplication.applicationState == UIApplicationStateInactive && !self.appWasActivatedByReceivingPushNotification) {
+        [self setAppWasActivatedByReceivingPushNotification:NO];
+        onContent();
+        return;
+    }
+    [self setAppWasActivatedByReceivingPushNotification:NO];
+    
+    NSLog(@"Push RECEIVED");
 
     [Leanplum onStartIssued:^() {
         if ([self areActionsEmbedded:userInfo]) {
@@ -214,6 +229,11 @@ - (void)maybePerformNotificationActions:(NSDictionary *)userInfo
                                  action:(NSString *)action
                                  active:(BOOL)active
 {
+    // Do not perform the action if the app is in background
+    if (UIApplication.sharedApplication.applicationState == UIApplicationStateBackground) {
+        return;
+    }
+
     // Don't handle duplicate notifications.
     if ([self isDuplicateNotification:userInfo]) {
         return;
@@ -226,6 +246,7 @@ - (void)maybePerformNotificationActions:(NSDictionary *)userInfo
         }
     }
 
+    NSLog(@"Push OPENED");
     LPLog(LPInfo, @"Handling push notification");
     NSString *messageId = [[LPNotificationsManager shared] messageIdFromUserInfo:userInfo];
     NSString *actionName;
@@ -389,10 +410,20 @@ - (void)handleNotificationResponse:(NSDictionary *)userInfo
         }
         BOOL hasAlert = userInfo[@"aps"][@"alert"] != nil;
         if (hasAlert) {
-            [self maybePerformNotificationActions:userInfo action:nil active:NO];
+            BOOL active = UIApplication.sharedApplication.applicationState == UIApplicationStateActive;
+            [self maybePerformNotificationActions:userInfo action:nil active:active];
         }
     };
-
+    
+    if (UIApplication.sharedApplication.applicationState == UIApplicationStateInactive || self.appWasActivatedByReceivingPushNotification) {
+        [self setAppWasActivatedByReceivingPushNotification:NO];
+        onContent();
+        return;
+    }
+    [self setAppWasActivatedByReceivingPushNotification:NO];
+    
+    NSLog(@"Push RECEIVED");
+    
     if ([[UIApplication sharedApplication] applicationState] != UIApplicationStateActive) {
         [Leanplum onStartIssued:^() {
             if ([self areActionsEmbedded:userInfo]) {
@@ -408,6 +439,13 @@ - (void)handleNotificationResponse:(NSDictionary *)userInfo
     }
 }
 
+- (void)handleWillPresentNotification:(NSDictionary *)userInfo
+{
+    if(@available(iOS 10, *)) {
+        [self handleWillPresentNotification:userInfo withCompletionHandler:nil];
+    }
+}
+
 // Will be called when user receives notification and app is in foreground iff UNUserNotificationCenterDelegate is implemented in UIApplicationDelegate.
 // We need to check first whether the action is muted, and depending on it show or silence the action.
 - (void)handleWillPresentNotification:(NSDictionary *)userInfo
@@ -425,9 +463,12 @@ - (void)handleWillPresentNotification:(NSDictionary *)userInfo
         }
         BOOL hasAlert = userInfo[@"aps"][@"alert"] != nil;
         if (hasAlert) {
-            [self maybePerformNotificationActions:userInfo action:nil active:YES];
+            BOOL active = UIApplication.sharedApplication.applicationState == UIApplicationStateActive;
+            [self maybePerformNotificationActions:userInfo action:nil active:active];
         }
     };
+    
+    NSLog(@"Push RECEIVED");
 
     if (!userInfo[LP_KEY_PUSH_MUTE_IN_APP] && !userInfo[LP_KEY_PUSH_NO_ACTION_MUTE]) {
         [Leanplum onStartIssued:^() {

Leanplum-SDK/Classes/Notifications/Push/LPPushNotificationsManager.m

@@ -350,6 +350,17 @@ + (void) load
 
 + (void)handleApplicationDidBecomeActive:(NSNotification *)notification {
     [[LPPushNotificationsManager sharedManager] swizzleAppMethods];
+    NSDictionary *userInfo = notification.userInfo[@"UIApplicationLaunchOptionsRemoteNotificationKey"];
+    if (userInfo != nil) {
+        [[LPPushNotificationsManager sharedManager].handler setAppWasActivatedByReceivingPushNotification:YES];
+        if (@available(iOS 10, *)) {
+            if ([UNUserNotificationCenter currentNotificationCenter].delegate != nil) {
+                [[LPPushNotificationsManager sharedManager].handler handleWillPresentNotification:userInfo];
+                return;
+            }
+        }
+        [[LPPushNotificationsManager sharedManager].handler didReceiveRemoteNotification:userInfo];
+    }
 }
 
 - (void)swizzleAppMethods