IAM still show form the queue when IAM is pasued (Reported from Unity) (#942)

* Changes to the aim controller to fix a bug reported from Unity
* IAM will show form the queue even when IAM is paused
* Must wrap the check around the display action not the action to add to the queue
* When IAM is paused adding to the queue works now and displaying will be prevented instead

* Modified more triggeredMessages old code
* Now we call them dismissedMessages, as triggered is confusing and sounds like it refers to IAM triggers added from the dashboard
* `tempTriggeredSet` is now `tempDismissedSet` when get persisted IAMs

* Updates to fix unit tests related to IAM functionality
* Removed the `ShadowOSInAppMessageController.java`, this was duplicate logic not necessary to test in app messaging
* Instead of Shadow for IAM controller, the `OneSignalPackagePrivateHelper.java` was given some helpers to access the current `OSInAppMessageController.java`
* `messageDisplayQueue` can accumulate as many IAMs as it would like, but the `inAppMessagingEnabled` flag will control whether or not anything IAMs will show from the queue
* `inAppMessageShowing` flag determines if an IAM is actually on the screen or not

* Updates from comments on last PR review
* `messageDisplayQueue` never gets duplicates of the same IAM
* Handle failure case for pulling down all of the HTML for an IAM messageId
  * Decided to create a list (401 to 404, 410) in OSUtils and a helper to verify whether or not to reattempt a network request based on the status code in the response
  * Added a constant to represent a max retry count, 3, for now until other cases arise
* Make sure when removing, the messageDisplayQueue is not empty'
* Dismiss preview IAMs with failed html request
* Split logic for dismissing IAM by things we need for all IAMs and non-preview IAMs

* Broke a unit test for IAM removing `inAppMessageShowing = false;`
* Called in 3 spots, did not account for the 3rd and it broke a unit test, now fixed by adding it back

Author: mikechoch

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

@@ -43,7 +43,7 @@ boolean dynamicTriggerShouldFire(final OSTrigger trigger) {
                     currentTimeInterval = new Date().getTime() - sessionLaunchTime.getTime();
                     break;
                 case TIME_SINCE_LAST_IN_APP:
-                    if (OSInAppMessageController.getController().isDisplayingInApp())
+                    if (OSInAppMessageController.getController().isInAppMessageShowing())
                         return false;
                     Date lastTimeAppDismissed = OSInAppMessageController.getController().lastTimeInAppDismissed;
                     if (lastTimeAppDismissed == null)

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

@@ -34,7 +34,7 @@ void onMessageActionOccurredOnMessage(@NonNull OSInAppMessage message, @NonNull
     void onMessageActionOccurredOnPreview(@NonNull OSInAppMessage message, @NonNull JSONObject actionJson) { }
 
     @Override
-    boolean isDisplayingInApp() { return false; }
+    boolean isInAppMessageShowing() { return false; }
 
     @Nullable
     @Override

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

@@ -67,6 +67,9 @@ class OSUtils {
 
    static final int UNINITIALIZABLE_STATUS = -999;
 
+   public static int MAX_NETWORK_REQUEST_ATTEMPT_COUNT = 3;
+   static final int[] NO_RETRY_NETWROK_REQUEST_STATUS_CODES = {401, 402, 403, 404, 410};
+
    public enum SchemaType {
       DATA("data"),
       HTTPS("https"),
@@ -89,6 +92,14 @@ public static SchemaType fromString(String text) {
       }
    }
 
+   public static boolean shouldRetryNetworkRequest(int statusCode) {
+      for (int code : NO_RETRY_NETWROK_REQUEST_STATUS_CODES)
+         if (statusCode == code)
+            return false;
+
+      return true;
+   }
+
    int initializationChecker(Context context, int deviceType, String oneSignalAppId) {
       int subscribableStatus = 1;
 

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

@@ -76,7 +76,7 @@ class OneSignalPrefs {
     public static final String PREFS_OS_ETAG_PREFIX = "PREFS_OS_ETAG_PREFIX_";
     public static final String PREFS_OS_HTTP_CACHE_PREFIX = "PREFS_OS_HTTP_CACHE_PREFIX_";
     public static final String PREFS_OS_CACHED_IAMS = "PREFS_OS_CACHED_IAMS";
-    public static final String PREFS_OS_DISPLAYED_IAMS = "PREFS_OS_DISPLAYED_IAMS";
+    public static final String PREFS_OS_DISMISSED_IAMS = "PREFS_OS_DISPLAYED_IAMS";
     public static final String PREFS_OS_IMPRESSIONED_IAMS = "PREFS_OS_IMPRESSIONED_IAMS";
     public static final String PREFS_OS_CLICKED_CLICK_IDS_IAMS = "PREFS_OS_CLICKED_CLICK_IDS_IAMS";
     public static final String PREFS_OS_RECEIVE_RECEIPTS_ENABLED = "PREFS_OS_RECEIVE_RECEIPTS_ENABLED";

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

@@ -32,7 +32,6 @@ public static void resetSessionLaunchTime() {
 
     public static void clearTestState() {
         OneSignal.pauseInAppMessages(false);
-        ShadowOSInAppMessageController.displayedMessages.clear();
         OSInAppMessageController.getController().messageDisplayQueue.clear();
     }
 

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

@@ -320,7 +320,20 @@ public OSTestInAppMessageAction(JSONObject json) throws JSONException {
 
    public static void dismissCurrentMessage() {
       com.onesignal.OSInAppMessage message = com.onesignal.OSInAppMessageController.getController().getCurrentDisplayedInAppMessage();
-      com.onesignal.OSInAppMessageController.getController().messageWasDismissed(message);
+      if (message != null)
+         com.onesignal.OSInAppMessageController.getController().messageWasDismissed(message);
+   }
+
+   public static boolean isInAppMessageShowing() {
+      return com.onesignal.OSInAppMessageController.getController().isInAppMessageShowing();
+   }
+
+   public static String getShowingInAppMessageId() {
+      return com.onesignal.OSInAppMessageController.getController().getCurrentDisplayedInAppMessage().messageId;
+   }
+
+   public static ArrayList<com.onesignal.OSInAppMessage> getInAppMessageDisplayQueue() {
+      return com.onesignal.OSInAppMessageController.getController().messageDisplayQueue;
    }
 
    public static class OSInAppMessageController extends com.onesignal.OSInAppMessageController {
@@ -332,6 +345,7 @@ public static OSInAppMessageController getController() {
 
          return sharedInstance;
       }
+
       public void onMessageActionOccurredOnMessage(@NonNull final com.onesignal.OSInAppMessage message, @NonNull final JSONObject actionJson) {
          super.onMessageActionOccurredOnMessage(message, actionJson);
       }

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

@@ -15,7 +15,6 @@
 import com.onesignal.ShadowDynamicTimer;
 import com.onesignal.ShadowJobService;
 import com.onesignal.ShadowNotificationManagerCompat;
-import com.onesignal.ShadowOSInAppMessageController;
 import com.onesignal.ShadowOSUtils;
 import com.onesignal.ShadowOSViewUtils;
 import com.onesignal.ShadowOSWebView;
@@ -53,6 +52,7 @@
 import static com.test.onesignal.TestHelpers.threadAndTaskWait;
 import static junit.framework.Assert.assertEquals;
 import static junit.framework.Assert.assertFalse;
+import static junit.framework.Assert.assertTrue;
 
 @Config(packageName = "com.onesignal.example",
         instrumentedPackages = { "com.onesignal" },
@@ -66,7 +66,6 @@
             ShadowNotificationManagerCompat.class,
             ShadowJobService.class,
             ShadowDynamicTimer.class,
-            ShadowOSInAppMessageController.class,
             ShadowOSWebView.class,
             ShadowOSViewUtils.class
         },
@@ -134,7 +133,10 @@ public void testDisableInAppMessagingPreventsMessageDisplay() throws Exception {
         // We will set the trigger. However, since messaging is disabled, the message should not be shown
         OneSignal.addTrigger("test_key", 3);
 
-        assertEquals(0, ShadowOSInAppMessageController.displayedMessages.size());
+        // Make sure 1 IAM is in the display queue
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        // Make sure no IAM is showing
+        assertFalse(OneSignalPackagePrivateHelper.isInAppMessageShowing());
     }
 
     /**
@@ -151,16 +153,28 @@ public void testMultipleMessagesDoNotBothDisplay() throws Exception {
         }});
         threadAndTaskWait();
 
-        //both messages should now be valid but only one should display
-        //which one displays first is undefined and doesn't really matter
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        // Make sure 2 items are in the display queue
+        assertEquals(2, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        // Make sure an IAM is showing
+        assertTrue(OneSignalPackagePrivateHelper.isInAppMessageShowing());
 
-        // dismiss the message
+        // Dismiss the message
         OneSignalPackagePrivateHelper.dismissCurrentMessage();
         threadAndTaskWait();
 
-        // the second in app message should now be displayed
-        assertEquals(2, ShadowOSInAppMessageController.displayedMessages.size());
+        // Make sure 1 item is in the display queue
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        // Make sure an IAM is showing
+        assertTrue(OneSignalPackagePrivateHelper.isInAppMessageShowing());
+
+        // Dismiss the message
+        OneSignalPackagePrivateHelper.dismissCurrentMessage();
+        threadAndTaskWait();
+
+        // Make sure no items are in the display queue
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        // Make sure no IAM is showing
+        assertFalse(OneSignalPackagePrivateHelper.isInAppMessageShowing());
     }
 
     // This tests both rotating the device or the app being resumed.
@@ -175,8 +189,9 @@ public void testMessageDismissingWhileDeviceIsRotating() throws Exception {
         }});
         threadAndTaskWait();
 
-        // 2. Assert one IAM was displayed
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        // 2. Assert two IAM in the queue and 1 is showing
+        assertEquals(2, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        assertTrue(OneSignalPackagePrivateHelper.isInAppMessageShowing());
 
         // 3. Rotate device - This will kick off a JS task to get the new height
         blankActivityController.pause();
@@ -189,6 +204,10 @@ public void testMessageDismissingWhileDeviceIsRotating() throws Exception {
         // 5. Now fire resize event which was scheduled in step 3.
         //    Test that this does not throw and handles this missing IAM view.
         ShadowOSWebView.fireEvalJSCallbacks();
+
+        // 6. Make sure only 1 IAM ios left in queue now and it is showing
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        assertTrue(OneSignalPackagePrivateHelper.isInAppMessageShowing());
     }
 
 
@@ -233,7 +252,7 @@ public void testTimedMessageIsDisplayed() throws Exception {
                 .until(new Callable<Boolean>() {
             @Override
             public Boolean call() throws Exception {
-                return ShadowOSInAppMessageController.displayedMessages.size() == 1;
+                return OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size() == 1;
             }
         });
     }
@@ -276,8 +295,8 @@ public void testAfterLastInAppTimeIsDisplayed() throws Exception {
            .untilAsserted(new ThrowingRunnable() {
                @Override
                public void run() {
-                   assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
-                   assertEquals(message1.messageId, ShadowOSInAppMessageController.displayedMessages.get(0));
+                   assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+                   assertEquals(message1.messageId, OneSignalPackagePrivateHelper.getShowingInAppMessageId());
                }
            });
 
@@ -290,8 +309,8 @@ public void run() {
           .untilAsserted(new ThrowingRunnable() {
               @Override
               public void run() {
-                  assertEquals(2, ShadowOSInAppMessageController.displayedMessages.size());
-                  assertEquals(message2.messageId, ShadowOSInAppMessageController.displayedMessages.get(1));
+                  assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+                  assertEquals(message2.messageId, OneSignalPackagePrivateHelper.getShowingInAppMessageId());
               }
           });
     }
@@ -324,20 +343,20 @@ public void testTimedMessageDisplayedAfterAllTriggersValid() throws Exception {
 
         // no timer should be scheduled since 'test_key' != 'squirrel'
         assertFalse(ShadowDynamicTimer.hasScheduledTimer);
-        assertEquals(0, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
 
         // since we are not actually waiting on any logic to finish, sleeping here is fine
         Thread.sleep(20);
 
         // the message still should not be displayed
-        assertEquals(0, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
 
         // after setting this trigger the message should be displayed immediately
         OneSignal.addTrigger("test_key", "squirrel");
         threadAndTaskWait();
 
         // the message should now have been displayed
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
         assertFalse(ShadowDynamicTimer.hasScheduledTimer);
     }
 
@@ -353,7 +372,7 @@ public void useCachedInAppListOnQuickColdRestart() throws Exception {
         // Should used cached triggers since we won't be making an on_session call.
         //   Testing for this by trying to add a trigger that should display an IAM
         OneSignal.addTrigger("test_2", 2);
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
     @Test
@@ -374,7 +393,7 @@ public void useCachedInAppListOnQuickColdRestartWhenInitFromAppClass() throws Ex
         // Should used cached triggers since we won't be making an on_session call.
         //   Testing for this by trying to add a trigger that should display an IAM
         OneSignal.addTrigger("test_2", 2);
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
     @Test
@@ -383,15 +402,15 @@ public void doNotReshowInAppIfDismissed_evenAfterColdRestart() throws Exception
         initializeSdkWithMultiplePendingMessages();
         // 2. Trigger showing In App and dismiss it
         OneSignal.addTrigger("test_2", 2);
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
         OneSignalPackagePrivateHelper.dismissCurrentMessage();
         // 3. Swipe away app
         fastColdRestartApp();
         // 4. Cold Start app
         initializeSdkWithMultiplePendingMessages();
         // 5. Set same trigger, should not display again
         OneSignal.addTrigger("test_2", 2);
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
     @Test
@@ -400,15 +419,15 @@ public void reshowInAppIfDisplayedButNeverDismissedAfterColdRestart() throws Exc
         initializeSdkWithMultiplePendingMessages();
         // 2. Trigger showing In App
         OneSignal.addTrigger("test_2", 2);
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
         // 3. Swipe away app
         fastColdRestartApp();
         // 4. Cold Start app
         initializeSdkWithMultiplePendingMessages();
-        assertEquals(1, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
         // 5. Set same trigger, should now display again, since it was never dismissed
         OneSignal.addTrigger("test_2", 2);
-        assertEquals(2, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
     @Test
@@ -560,7 +579,7 @@ public void testMessageNotShownForAndroidApi18Lower() throws Exception {
         threadAndTaskWait();
 
         // Check no messages exist
-        assertEquals(0, ShadowOSInAppMessageController.displayedMessages.size());
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
     private void setMockRegistrationResponseWithMessages(ArrayList<OSTestInAppMessage> messages) throws JSONException {

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

@@ -17,7 +17,6 @@
 import com.onesignal.ShadowDynamicTimer;
 import com.onesignal.ShadowJobService;
 import com.onesignal.ShadowNotificationManagerCompat;
-import com.onesignal.ShadowOSInAppMessageController;
 import com.onesignal.ShadowOSUtils;
 import com.onesignal.ShadowOneSignalRestClient;
 import com.onesignal.ShadowPushRegistratorGCM;
@@ -64,7 +63,6 @@
             ShadowNotificationManagerCompat.class,
             ShadowJobService.class,
             ShadowDynamicTimer.class,
-            ShadowOSInAppMessageController.class
         },
         sdk = 26
 )