Merge pull request #323 from Iterable/MOB-2606-read-state

Ayyanchira · Ayyanchira · commit f8bb6cfb3dca · 2021-03-30T13:19:20.000-07:00
[MOB-2606] persistent read state for inbox in-apps
# Conflicts:
#	iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java
diff --git a/.gitignore b/.gitignore
@@ -54,4 +54,7 @@ google-services.json
 # Freeline
 freeline.py
 freeline/
-freeline_project_description.json
+freeline_project_description.json
+
+# MacOS generated files
+.DS_Store
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java
@@ -179,6 +179,8 @@ public void execute(String payload) {
                     } catch (JSONException e) {
                         IterableLogger.e(TAG, e.toString());
                     }
+                } else {
+                    scheduleProcessing();
                 }
             }
         });
@@ -305,20 +307,38 @@ private boolean isMessageExpired(IterableInAppMessage message) {
     private void syncWithRemoteQueue(List<IterableInAppMessage> remoteQueue) {
         boolean changed = false;
         Map<String, IterableInAppMessage> remoteQueueMap = new HashMap<>();
+
         for (IterableInAppMessage message : remoteQueue) {
             remoteQueueMap.put(message.getMessageId(), message);
-            if (storage.getMessage(message.getMessageId()) == null) {
+
+            boolean isInAppStored = storage.getMessage(message.getMessageId()) != null;
+
+            if (!isInAppStored) {
                 storage.addMessage(message);
                 onMessageAdded(message);
                 changed = true;
             }
+
+            if (isInAppStored) {
+                IterableInAppMessage localMessage = storage.getMessage(message.getMessageId());
+
+                boolean shouldOverwriteInApp = !localMessage.isRead() && message.isRead();
+
+                if (shouldOverwriteInApp) {
+                    localMessage.setRead(message.isRead());
+
+                    changed = true;
+                }
+            }
         }
+
         for (IterableInAppMessage localMessage : storage.getMessages()) {
             if (!remoteQueueMap.containsKey(localMessage.getMessageId())) {
                 storage.removeMessage(localMessage);
                 changed = true;
             }
         }
+
         scheduleProcessing();
         if (changed) {
             notifyOnChange();
@@ -386,9 +406,10 @@ private void handleIterableCustomAction(String actionName, IterableInAppMessage
 
     @Override
     public void onSwitchToForeground() {
-        scheduleProcessing();
         if (IterableUtil.currentTimeMillis() - lastSyncTime > MOVE_TO_FOREGROUND_SYNC_INTERVAL_MS) {
             syncInApp();
+        } else {
+            scheduleProcessing();
         }
     }
 
diff --git a/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java b/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java
@@ -7,6 +7,8 @@
 import androidx.annotation.NonNull;
 import androidx.fragment.app.FragmentActivity;
 
+import java.util.List;
+
 import com.iterable.iterableapi.unit.PathBasedQueueDispatcher;
 
 import org.json.JSONArray;
@@ -161,15 +163,14 @@ public void testReset() throws Exception {
     @Test
     public void testProcessAfterForeground() throws Exception {
         dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_single.json")));
-        IterableInAppManager inAppManager = IterableApi.getInstance().getInAppManager();
-        assertEquals(0, inAppManager.getMessages().size());
 
-        inAppManager.syncInApp();
+        ActivityController<Activity> activityController = Robolectric.buildActivity(Activity.class).create().start().resume();
         shadowOf(getMainLooper()).idle();
-        assertEquals(1, inAppManager.getMessages().size());
+        shadowOf(getMainLooper()).runToEndOfTasks();
 
-        ActivityController<Activity> activityController = Robolectric.buildActivity(Activity.class).create().start().resume();
+        IterableInAppManager inAppManager = IterableApi.getInstance().getInAppManager();
         shadowOf(getMainLooper()).idle();
+        assertEquals(1, inAppManager.getMessages().size());
 
         ArgumentCaptor<IterableInAppMessage> inAppMessageCaptor = ArgumentCaptor.forClass(IterableInAppMessage.class);
         verify(inAppHandler).onNewInApp(inAppMessageCaptor.capture());
@@ -382,12 +383,30 @@ public void testInAppAutoDisplayPause() throws Exception {
         verify(inAppHandler, times(1)).onNewInApp(inAppMessageCaptor.capture());
     }
 
+    @Test
+    public void testMessagePersistentReadStateFromServer() throws Exception {
+        // load the in-app that has not been synchronized with the server yet (read state is set to false)
+        dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_inbox_read_state_1.json")));
+        IterableInAppManager inAppManager = IterableApi.getInstance().getInAppManager();
+        inAppManager.syncInApp();
+        shadowOf(getMainLooper()).idle();
+
+        List<IterableInAppMessage> inboxMessages = inAppManager.getInboxMessages();
+        assertFalse(inboxMessages.get(0).isRead());
+
+        // now load the one that has the in-app with read state set to true
+        dispatcher.enqueueResponse("/inApp/getMessages", new MockResponse().setBody(IterableTestUtils.getResourceString("inapp_payload_inbox_read_state_2.json")));
+        inAppManager.syncInApp();
+        shadowOf(getMainLooper()).idle();
+
+        assertTrue(inboxMessages.get(0).isRead());
+    }
+
     private static class IterableSkipInAppHandler implements IterableInAppHandler {
         @NonNull
         @Override
         public InAppResponse onNewInApp(@NonNull IterableInAppMessage message) {
             return InAppResponse.SKIP;
         }
     }
-
 }
diff --git a/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppMessageTest.java b/iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppMessageTest.java
@@ -79,6 +79,15 @@ public void testInAppMessageOnChangeListener_consumed() throws Exception {
         verify(mockChangeListener).onInAppMessageChanged(testInAppMessage);
     }
 
+    @Test
+    public void testInAppMessageOnChangeListener_read() throws Exception {
+        IterableInAppMessage testInAppMessage = InAppTestUtils.getTestInAppMessage();
+        IterableInAppMessage.OnChangeListener mockChangeListener = mock(IterableInAppMessage.OnChangeListener.class);
+        testInAppMessage.setOnChangeListener(mockChangeListener);
+
+        testInAppMessage.setRead(true);
+        verify(mockChangeListener).onInAppMessageChanged(testInAppMessage);
+    }
 
     @Test
     public void testStorageNotInvoked() throws Exception {
diff --git a/iterableapi/src/test/java/com/iterable/iterableapi/IterableInboxTest.java b/iterableapi/src/test/java/com/iterable/iterableapi/IterableInboxTest.java
@@ -127,13 +127,9 @@ public IterableConfig.Builder run(IterableConfig.Builder builder) {
                 return builder.setInAppHandler(inAppHandler).setCustomActionHandler(customActionHandler).setUrlHandler(urlHandler);
             }
         });
-        inAppManager.syncInApp();
-        shadowOf(getMainLooper()).idle();
-
-        assertEquals(2, inAppManager.getInboxMessages().size());
-        assertEquals(2, inAppManager.getUnreadInboxMessagesCount());
 
         Robolectric.buildActivity(Activity.class).create().start().resume();
+        shadowOf(getMainLooper()).idle();
 
         verify(inAppDisplayerMock).showMessage(any(IterableInAppMessage.class), eq(IterableInAppLocation.IN_APP), any(IterableHelper.IterableUrlCallback.class));
 
diff --git a/iterableapi/src/test/resources/inapp_payload_inbox_read_state_1.json b/iterableapi/src/test/resources/inapp_payload_inbox_read_state_1.json
@@ -0,0 +1,31 @@
+{
+    "inAppMessages": [
+        {
+            "messageId": "readMessage1",
+            "read": false,
+            "content": {
+                "html": "<html><head></head><body>Test</body></html>",
+                "inAppDisplaySettings": {
+                    "top": {
+                        "percentage": 0
+                    },
+                    "right": {
+                        "percentage": 0
+                    },
+                    "bottom": {
+                        "percentage": 0
+                    },
+                    "left": {
+                        "percentage": 0
+                    }
+                }
+            },
+            "saveToInbox": true,
+            "inboxMetadata": {
+                "title": "Title",
+                "subtitle": "Subtitle",
+                "icon": "icon.png"
+            }
+        }
+    ]
+}
diff --git a/iterableapi/src/test/resources/inapp_payload_inbox_read_state_2.json b/iterableapi/src/test/resources/inapp_payload_inbox_read_state_2.json
@@ -0,0 +1,31 @@
+{
+    "inAppMessages": [
+        {
+            "messageId": "readMessage1",
+            "read": true,
+            "content": {
+                "html": "<html><head></head><body>Test</body></html>",
+                "inAppDisplaySettings": {
+                    "top": {
+                        "percentage": 0
+                    },
+                    "right": {
+                        "percentage": 0
+                    },
+                    "bottom": {
+                        "percentage": 0
+                    },
+                    "left": {
+                        "percentage": 0
+                    }
+                }
+            },
+            "saveToInbox": true,
+            "inboxMetadata": {
+                "title": "Title",
+                "subtitle": "Subtitle",
+                "icon": "icon.png"
+            }
+        }
+    ]
+}
diff --git a/iterableapi/src/test/resources/inapp_payload_inbox_show.json b/iterableapi/src/test/resources/inapp_payload_inbox_show.json
@@ -2,6 +2,7 @@
   "inAppMessages": [
     {
       "messageId": "message1",
+      "read": false,
       "trigger": {
         "type": "immediate"
       },
@@ -28,6 +29,7 @@
       }
     },{
       "messageId": "message2",
+      "read": false,
       "trigger": {
         "type": "immediate"
       },
diff --git a/iterableapi/src/test/resources/inapp_payload_single.json b/iterableapi/src/test/resources/inapp_payload_single.json
@@ -3,6 +3,7 @@
     {
       "messageId": "7kx2MmoGdCpuZao9fDueuQoXVAZuDaVV",
       "expiresAt": 1949157312395,
+      "read": false,
       "trigger": {
         "type": "immediate"
       },

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`{`
`4`	`4`	`"messageId": "7kx2MmoGdCpuZao9fDueuQoXVAZuDaVV",`
`5`	`5`	`"expiresAt": 1949157312395,`
	`6`	`+ "read": false,`
`6`	`7`	`"trigger": {`
`7`	`8`	`"type": "immediate"`
`8`	`9`	`},`