Make IAM not display under splas screenh when back pressing

* If user implements splash with a handler timer activity and back press while displaying an IAM, IAM will be displayed under splash
* Add callback for when the app lost focus, dismiss IAM but not save it as dismissed this will allow the IAM to be displayed again until the user dismiss it
* If the user back press and come too quickly to the app, focus detection won't happen, IAM will still be shown under the splash screen

Author: Jeasmine

OneSignalSDK/onesignal/src/main/java/com/onesignal/ActivityLifecycleHandler.java

@@ -50,7 +50,10 @@ abstract static class ActivityAvailableListener {
         void available(@NonNull Activity activity) {
         }
 
-        void stopped(WeakReference<Activity> reference) {
+        void stopped() {
+        }
+
+        void lostFocus() {
         }
     }
 
@@ -145,7 +148,7 @@ static void onActivityStopped(Activity activity) {
         }
 
         for (Map.Entry<String, ActivityAvailableListener> entry : sActivityAvailableListeners.entrySet()) {
-            entry.getValue().stopped(new WeakReference<>(activity));
+            entry.getValue().stopped();
         }
 
         logCurActivity();
@@ -185,7 +188,7 @@ private static void onOrientationChanged() {
         // Remove view
         handleLostFocus();
         for (Map.Entry<String, ActivityAvailableListener> entry : sActivityAvailableListeners.entrySet()) {
-            entry.getValue().stopped(new WeakReference<>(curActivity));
+            entry.getValue().stopped();
         }
 
         // Show view
@@ -260,6 +263,9 @@ public void run() {
                 return;
 
             backgrounded = true;
+            for (Map.Entry<String, ActivityAvailableListener> entry : sActivityAvailableListeners.entrySet()) {
+                entry.getValue().lostFocus();
+            }
             OneSignal.onAppLostFocus();
             completed = true;
         }

OneSignalSDK/onesignal/src/main/java/com/onesignal/InAppMessageView.java

@@ -451,7 +451,6 @@ public void run() {
      * IAM has been fully dismissed, remove all views and call the onMessageWasDismissed callback
      */
     private void cleanupViewsAfterDismiss() {
-        OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "InAppMessageView cleanupViewsAfterDismiss");
         removeAllViews();
         if (messageController != null)
             messageController.onMessageWasDismissed();
@@ -461,6 +460,7 @@ private void cleanupViewsAfterDismiss() {
      * Remove all views and dismiss PopupWindow
      */
     void removeAllViews() {
+        OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "InAppMessageView removing views");
         if (scheduleDismissRunnable != null) {
             // Dismissed before the dismiss delay
             handler.removeCallbacks(scheduleDismissRunnable);

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageController.java

@@ -127,8 +127,10 @@ void resetSessionLaunchTime() {
     //    however an on session won't happen
     void initWithCachedInAppMessages() {
         // Do not reload from cache if already loaded.
-        if (!messages.isEmpty())
+        if (!messages.isEmpty()) {
+            OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "initWithCachedInAppMessages with already in memory messages: " + messages);
             return;
+        }
 
         String cachedInAppMessageString = OneSignalPrefs.getString(
                 OneSignalPrefs.PREFS_ONESIGNAL,
@@ -550,9 +552,6 @@ void messageWasDismissed(@NonNull OSInAppMessage message) {
     }
 
     void messageWasDismissed(@NonNull OSInAppMessage message, boolean failed) {
-        // Remove DIRECT influence due to ClickHandler of ClickAction outcomes
-        OneSignal.getSessionManager().onDirectInfluenceFromIAMClickFinished();
-
         if (!message.isPreview) {
             dismissedMessages.add(message.messageId);
             // If failed we will retry on next session
@@ -573,12 +572,21 @@ void messageWasDismissed(@NonNull OSInAppMessage message, boolean failed) {
         dismissCurrentMessage(message);
     }
 
+    void messageWasDismissedByBackPress(@NonNull OSInAppMessage message) {
+        OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "OSInAppMessageController messageWasDismissed by back press: " + message.toString());
+        // IAM was not dismissed by user, will be redisplay again until user dismiss it
+        dismissCurrentMessage(message);
+    }
+
     /**
      * Removes first item from the queue and attempts to show the next IAM in the queue
      *
      * @param message The message dismissed, preview messages are null
      */
     private void dismissCurrentMessage(@Nullable OSInAppMessage message) {
+        // Remove DIRECT influence due to ClickHandler of ClickAction outcomes
+        OneSignal.getSessionManager().onDirectInfluenceFromIAMClickFinished();
+
         if (currentPrompt != null) {
             OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "Stop evaluateMessageDisplayQueue because prompt is currently displayed");
             return;

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -844,18 +844,20 @@ private static void handleAmazonPurchase() {
    // If the app is not in the foreground yet do not make an on_session call yet.
    // If we don't have a OneSignal player_id yet make the call to create it regardless of focus
    private static void doSessionInit() {
-      getInAppMessageController().initWithCachedInAppMessages();
       // Check session time to determine whether to start a new session or not
       if (isPastOnSessionTime()) {
+         OneSignal.onesignalLog(LOG_LEVEL.DEBUG, "Starting new session");
          OneSignalStateSynchronizer.setNewSession();
          if (foreground) {
             outcomeEventsController.cleanOutcomes();
             sessionManager.restartSessionIfNeeded(getAppEntryState());
             getInAppMessageController().resetSessionLaunchTime();
          }
       } else if (foreground) {
+         OneSignal.onesignalLog(LOG_LEVEL.DEBUG, "Continue on same session");
          sessionManager.attemptSessionUpgrade(getAppEntryState());
       }
+      getInAppMessageController().initWithCachedInAppMessages();
 
       // We still want register the user to OneSignal if the SDK was initialized
       //   in the background for the first time.

OneSignalSDK/onesignal/src/main/java/com/onesignal/WebViewManager.java

@@ -84,6 +84,7 @@ protected WebViewManager(@NonNull OSInAppMessage message, @NonNull Activity acti
      */
     static void showHTMLString(@NonNull final OSInAppMessage message, @NonNull final String htmlStr) {
         final Activity currentActivity = ActivityLifecycleHandler.curActivity;
+        OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "in app message showHTMLString on currentActivity: " + currentActivity);
         /* IMPORTANT
          * This is the starting route for grabbing the current Activity and passing it to InAppMessageView */
         if (currentActivity != null) {
@@ -98,9 +99,9 @@ public void onComplete() {
                         initInAppMessage(currentActivity, message, htmlStr);
                     }
                 });
-            }
-            else
+            } else {
                 initInAppMessage(currentActivity, message, htmlStr);
+            }
             return;
         }
 
@@ -248,6 +249,8 @@ private void calculateHeightAndShowWebViewAfterNewActivity() {
             return;
         }
 
+        OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "In app message new activity, calculate height and show ");
+
        // Using post to ensure that the status bar inset is already added to the view
        OSViewUtils.decorViewReady(activity, new Runnable() {
           @Override
@@ -280,17 +283,25 @@ void available(final @NonNull Activity activity) {
     }
 
     @Override
-    void stopped(WeakReference<Activity> reference) {
+    void stopped() {
         if (messageView != null)
             messageView.removeAllViews();
     }
 
+    @Override
+    void lostFocus() {
+        OneSignal.getInAppMessageController().messageWasDismissedByBackPress(message);
+        removeActivityListener();
+        messageView = null;
+    }
+
     private void showMessageView(@Nullable Integer newHeight) {
         if (messageView == null) {
             OneSignal.Log(OneSignal.LOG_LEVEL.WARN, "No messageView found to update a with a new height.");
             return;
         }
 
+        OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "In app message, showing fist one with height: " + newHeight);
         messageView.setWebView(webView);
         if (newHeight != null)
             messageView.updateHeight(newHeight);
@@ -353,7 +364,7 @@ public void onMessageWasShown() {
             @Override
             public void onMessageWasDismissed() {
                 OneSignal.getInAppMessageController().messageWasDismissed(message);
-                ActivityLifecycleHandler.removeActivityAvailableListener(TAG + message.messageId);
+                removeActivityListener();
             }
         });
 
@@ -377,6 +388,9 @@ private static int getWebViewMaxSizeY(Activity activity) {
        return OSViewUtils.getWindowHeight(activity) - (MARGIN_PX_SIZE * 2);
     }
 
+    private void removeActivityListener() {
+        ActivityLifecycleHandler.removeActivityAvailableListener(TAG + message.messageId);
+    }
     /**
      * Trigger the {@link #messageView} dismiss animation flow
      */

OneSignalSDK/unittest/src/test/java/com/test/onesignal/InAppMessageIntegrationTests.java

@@ -465,6 +465,25 @@ public void doNotReshowInAppIfDismissed_evenAfterColdRestart() throws Exception
         assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
+    @Test
+    public void doNotReshowInAppUntilTriggerIfAppBackPressed() throws Exception {
+        // 1. Start app
+        initializeSdkWithMultiplePendingMessages();
+        // 2. Trigger showing In App and dismiss it
+        OneSignal.addTrigger("test_2", 2);
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        assertTrue(OneSignalPackagePrivateHelper.isInAppMessageShowing());
+        // 3. Emulate back pressing
+        blankActivityController.destroy();
+        threadAndTaskWait();
+        // 4. Put activity back to foreground
+        blankActivityController = Robolectric.buildActivity(BlankActivity.class).create();
+        OneSignalInit();
+        threadAndTaskWait();
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        assertFalse(OneSignalPackagePrivateHelper.isInAppMessageShowing());
+    }
+
     @Test
     public void reshowInAppIfDisplayedButNeverDismissedAfterColdRestart() throws Exception {
         // 1. Start app