unit tests for IAM end_time logic

Author: emawby

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

@@ -108,6 +108,17 @@ public static OSTestInAppMessage buildTestMessage(final JSONArray triggerJson) t
         return new OSTestInAppMessage(basicIAMJSONObject(triggerJson));
     }
 
+    public static OSTestInAppMessage buildTestMessageWithEndTime(final OSTriggerKind kind, final String key, final String operator, final Object value, final boolean pastEndTime) throws JSONException {
+        JSONArray triggerJson = basicTrigger(kind, key, operator, value);
+        JSONObject json = basicIAMJSONObject(triggerJson);
+        if (pastEndTime) {
+            json.put("end_time", "1960-01-01T00:00:00.000Z");
+        } else {
+            json.put("end_time", "2200-01-01T00:00:00.000Z");
+        }
+        return new OSTestInAppMessage(json);
+    }
+
     public static OSTestInAppMessage buildTestMessageWithMultipleTriggers(ArrayList<ArrayList<OSTestTrigger>> triggers) throws JSONException {
         JSONArray ors = buildTriggers(triggers);
         return buildTestMessage(ors);

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

@@ -171,6 +171,46 @@ public void testDisableInAppMessagingPreventsMessageDisplay() throws Exception {
         assertFalse(OneSignalPackagePrivateHelper.isInAppMessageShowing());
     }
 
+    @Test
+    public void testMessagesDoNotDisplayPastEndTime() throws Exception {
+        final OSTestInAppMessage message = InAppMessagingHelpers.buildTestMessageWithEndTime(OSTriggerKind.CUSTOM, "test_key", OSTestTrigger.OSTriggerOperator.EQUAL_TO.toString(), 3, true);
+        setMockRegistrationResponseWithMessages(new ArrayList<OSTestInAppMessage>() {{
+            add(message);
+        }});
+
+        // the SDK should read the message from registration JSON, set up a timer, and once
+        // the timer fires the message should get shown.
+        OneSignalInit();
+        threadAndTaskWait();
+
+        // We will set the trigger. However, since the end time is in the past the message should not be shown
+        OneSignal.addTrigger("test_key", 3);
+        // Make no IAMs are in the display queue
+        assertEquals(0, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        // Make sure no IAM is showing
+        assertFalse(OneSignalPackagePrivateHelper.isInAppMessageShowing());
+    }
+
+    @Test
+    public void testMessagesDoDisplayBeforeEndTime() throws Exception {
+        final OSTestInAppMessage message = InAppMessagingHelpers.buildTestMessageWithEndTime(OSTriggerKind.CUSTOM, "test_key", OSTestTrigger.OSTriggerOperator.EQUAL_TO.toString(), 3, false);
+        setMockRegistrationResponseWithMessages(new ArrayList<OSTestInAppMessage>() {{
+            add(message);
+        }});
+
+        // the SDK should read the message from registration JSON, set up a timer, and once
+        // the timer fires the message should get shown.
+        OneSignalInit();
+        threadAndTaskWait();
+
+        // We will set the trigger. However, since the end time is in the past the message should not be shown
+        OneSignal.addTrigger("test_key", 3);
+        // Make no IAMs are in the display queue
+        assertEquals(1, OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size());
+        // Make sure no IAM is showing
+        assertTrue(OneSignalPackagePrivateHelper.isInAppMessageShowing());
+    }
+
     /**
      * Since it is possible for multiple in-app messages to be valid at the same time, we've implemented
      * a queue so that the SDK does not try to display both messages at the same time.
@@ -307,7 +347,12 @@ public void testTimedMessageIsDisplayedOncePerSession() throws Exception {
         Awaitility.await()
                 .atMost(new Duration(150, TimeUnit.MILLISECONDS))
                 .pollInterval(new Duration(10, TimeUnit.MILLISECONDS))
-                .until(() -> OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size() == 1);
+                .until(new Callable<Boolean>() {
+                    @Override
+                    public Boolean call() throws Exception {
+                        return OneSignalPackagePrivateHelper.getInAppMessageDisplayQueue().size() == 1;
+                    }
+                });
 
         OneSignalPackagePrivateHelper.dismissCurrentMessage();