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

[MOB-2606] persistent read state for inbox in-apps

Author: Ayyanchira

.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

iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java

@@ -307,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();
@@ -358,7 +376,7 @@ private void processMessages() {
         List<IterableInAppMessage> messagesByPriorityLevel = getMessagesSortedByPriorityLevel(messages);
 
         for (IterableInAppMessage message : messagesByPriorityLevel) {
-            if (!message.isProcessed() && !message.isConsumed() && message.getTriggerType() == TriggerType.IMMEDIATE) {
+            if (!message.isProcessed() && !message.isConsumed() && message.getTriggerType() == TriggerType.IMMEDIATE && !message.isRead()) {
                 IterableLogger.d(TAG, "Calling onNewInApp on " + message.getMessageId());
                 InAppResponse response = handler.onNewInApp(message);
                 IterableLogger.d(TAG, "Response: " + response);

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;
@@ -382,12 +384,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;
         }
     }
-
 }

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 {

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"
+            }
+        }
+    ]
+}

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"
+            }
+        }
+    ]
+}