Fix IAM redisplay multiple times

* When IAM only has dynamic triggers it can end redisplaying multiple times on the same session
* Limit IAM with only dynamic trigger to display once per session
* Add test for escenario

Author: Jeasmine

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

@@ -222,9 +222,13 @@ void setRedisplayStats(int displayQuantity, long lastDisplayTime) {
     public String toString() {
         return "OSInAppMessage{" +
                 "messageId='" + messageId + '\'' +
+                ", variants=" + variants +
                 ", triggers=" + triggers +
                 ", clickedClickIds=" + clickedClickIds +
-                ", displayStats=" + redisplayStats +
+                ", redisplayStats=" + redisplayStats +
+                ", displayDuration=" + displayDuration +
+                ", displayedInSession=" + displayedInSession +
+                ", triggerChanged=" + triggerChanged +
                 ", actionTaken=" + actionTaken +
                 ", isPreview=" + isPreview +
                 '}';

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

@@ -479,10 +479,9 @@ private void setDataForRedisplay(OSInAppMessage message) {
         if (messageDismissed && index != -1) {
             OSInAppMessage savedIAM = redisplayedInAppMessages.get(index);
             message.getRedisplayStats().setDisplayStats(savedIAM.getRedisplayStats());
+            message.setDisplayedInSession(savedIAM.isDisplayedInSession());
 
-            // Message that don't have triggers should display only once per session
-            boolean triggerHasChanged = message.isTriggerChanged() || (!savedIAM.isDisplayedInSession() && message.triggers.isEmpty());
-
+            boolean triggerHasChanged = hasMessageTriggerChanged(message);
             OneSignal.onesignalLog(OneSignal.LOG_LEVEL.DEBUG, "setDataForRedisplay: " + message.toString() + " triggerHasChanged: " + triggerHasChanged);
 
             // Check if conditions are correct for redisplay
@@ -498,6 +497,18 @@ private void setDataForRedisplay(OSInAppMessage message) {
         }
     }
 
+    private boolean hasMessageTriggerChanged(OSInAppMessage message) {
+        // Message that only have dynamic trigger should display only once per session
+        boolean messageHasOnlyDynamicTrigger = triggerController.messageHasOnlyDynamicTriggers(message);
+        if (messageHasOnlyDynamicTrigger)
+            return !message.isDisplayedInSession();
+
+        // Message that don't have triggers should display only once per session
+        boolean shouldMessageDisplayInSession = !message.isDisplayedInSession() && message.triggers.isEmpty();
+
+        return message.isTriggerChanged() || shouldMessageDisplayInSession;
+    }
+
     /**
      * Message has passed triggers and de-duplication logic.
      * Display message now or add it to the queue to be displayed.

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

@@ -191,6 +191,26 @@ boolean isTriggerOnMessage(OSInAppMessage message, Collection<String> newTrigger
         return false;
     }
 
+    /**
+     * Part of redisplay logic
+     *
+     * If message has only dynamic trigger return true, otherwise false
+     * */
+    boolean messageHasOnlyDynamicTriggers(OSInAppMessage message) {
+        if (message.triggers == null || message.triggers.isEmpty())
+            return false;
+
+        for (ArrayList<OSTrigger> andConditions : message.triggers) {
+            for (OSTrigger trigger : andConditions) {
+                if (trigger.kind == OSTrigger.OSTriggerKind.CUSTOM || trigger.kind == OSTrigger.OSTriggerKind.UNKNOWN)
+                    // At least one trigger is not dynamic
+                    return false;
+            }
+        }
+
+        return true;
+    }
+
     /**
      * Trigger Set/Delete/Persist Logic
      */

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

@@ -282,8 +282,14 @@ private void initializeSdkWithMultiplePendingMessages() throws Exception {
     }
 
     @Test
-    public void testTimedMessageIsDisplayed() throws Exception {
-        final OSTestInAppMessage message = InAppMessagingHelpers.buildTestMessageWithSingleTrigger(OSTriggerKind.SESSION_TIME, null, OSTestTrigger.OSTriggerOperator.GREATER_THAN.toString(), 0.05);
+    public void testTimedMessageIsDisplayedOncePerSession() throws Exception {
+        final OSTestInAppMessage message = InAppMessagingHelpers.buildTestMessageWithSingleTriggerAndRedisplay(
+                OSTriggerKind.SESSION_TIME,
+                null,
+                OSTestTrigger.OSTriggerOperator.GREATER_THAN.toString(),
+                0.05,
+                10,
+                0);
 
         setMockRegistrationResponseWithMessages(new ArrayList<OSTestInAppMessage>() {{
             add(message);
@@ -301,31 +307,31 @@ public void testTimedMessageIsDisplayed() throws Exception {
         Awaitility.await()
                 .atMost(new Duration(150, TimeUnit.MILLISECONDS))
                 .pollInterval(new Duration(10, TimeUnit.MILLISECONDS))
-                .until(new Callable<Boolean>() {
-                    @Override
-                    public Boolean call() throws Exception {
-                        return OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size() == 1;
-                    }
-                });
-    }
+                .until(() -> OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size() == 1);
 
+        OneSignalPackagePrivateHelper.dismissCurrentMessage();
+
+        // Check that the IAM is not displayed again
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+    }
 
     @Test
-    public void testAfterLastInAppTimeIsDisplayed() throws Exception {
-        final OSTestInAppMessage message1 = InAppMessagingHelpers.buildTestMessageWithSingleTrigger(
+    public void testAfterLastInAppTimeIsDisplayedOncePerSession() throws Exception {
+        final OSTestInAppMessage message1 = InAppMessagingHelpers.buildTestMessageWithSingleTriggerAndRedisplay(
                 OSTriggerKind.SESSION_TIME,
                 null,
                 OSTestTrigger.OSTriggerOperator.GREATER_THAN.toString(),
-                0.05
-        );
+                0.05,
+                10,
+                0);
 
         ArrayList<ArrayList<OSTestTrigger>> triggers2 = new ArrayList<ArrayList<OSTestTrigger>>() {{
             add(new ArrayList<OSTestTrigger>() {{
                 add(InAppMessagingHelpers.buildTrigger(OSTriggerKind.SESSION_TIME, null, OSTestTrigger.OSTriggerOperator.GREATER_THAN.toString(), 0.1));
                 add(InAppMessagingHelpers.buildTrigger(OSTriggerKind.TIME_SINCE_LAST_IN_APP, null, OSTestTrigger.OSTriggerOperator.GREATER_THAN.toString(), 0.05));
             }});
         }};
-        final OSTestInAppMessage message2 = InAppMessagingHelpers.buildTestMessageWithMultipleTriggers(triggers2);
+        final OSTestInAppMessage message2 = InAppMessagingHelpers.buildTestMessageWithMultipleTriggersAndRedisplay(triggers2, 10, 0);
 
         setMockRegistrationResponseWithMessages(new ArrayList<OSTestInAppMessage>() {{
             add(message1);
@@ -365,6 +371,12 @@ public void run() {
                         assertEquals(message2.messageId, OneSignalPackagePrivateHelper.getShowingInAppMessageId());
                     }
                 });
+
+
+        OneSignalPackagePrivateHelper.dismissCurrentMessage();
+
+        // Check that the IAM is not displayed again
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
     }
 
     /**