MOB-10364 Support for In App JSON Only Messages (#857)

* [MOB-10364] some work on in app json only messages

* [MOB-10364] fix the test

* [MOB-10364] Rewrite of logic and tests

* [MOB-10364] Add editorconfig

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* updates json only flag parsing

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

* [MOB-10364] Update according to new discussiom

---------

Co-authored-by: Evan Takeo Kanaiaupuni Greer <[email protected]>
Co-authored-by: Evan Greer <[email protected]>

Author: 3 people

Diff for: .editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+tab_width = 4

Diff for: iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java

@@ -398,6 +398,11 @@ private void onForeground() {
             fetchRemoteConfiguration();
         }
 
+        if (_applicationContext == null || sharedInstance.getMainActivityContext() == null) {
+            IterableLogger.w(TAG, "onForeground: _applicationContext is null");
+            return;
+        }
+
         boolean systemNotificationEnabled = NotificationManagerCompat.from(_applicationContext).areNotificationsEnabled();
         SharedPreferences sharedPref = sharedInstance.getMainActivityContext().getSharedPreferences(IterableConstants.SHARED_PREFS_FILE, Context.MODE_PRIVATE);
 
@@ -1435,4 +1440,4 @@ public void trackEmbeddedSession(@NonNull IterableEmbeddedSession session) {
         apiClient.trackEmbeddedSession(session);
     }
 //endregion
-}
+}

Diff for: iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java

@@ -221,6 +221,7 @@ public final class IterableConstants {
     public static final String ITERABLE_IN_APP_BUTTONS          = "buttons";
     public static final String ITERABLE_IN_APP_COLOR            = "color";
     public static final String ITERABLE_IN_APP_CONTENT          = "content";
+    public static final String ITERABLE_IN_APP_JSON_ONLY        = "jsonOnly";
     public static final String ITERABLE_IN_APP_COUNT            = "count";
     public static final String ITERABLE_IN_APP_MAIN_IMAGE       = "mainImage";
     public static final String ITERABLE_IN_APP_MESSAGE          = "inAppMessages";

Diff for: iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppDisplayer.java

@@ -20,6 +20,11 @@ boolean isShowingInApp() {
     }
 
     boolean showMessage(@NonNull IterableInAppMessage message, IterableInAppLocation location, @NonNull final IterableHelper.IterableUrlCallback clickCallback) {
+        // Early return for JSON-only messages
+        if (message.isJsonOnly()) {
+            return false;
+        }
+
         Activity currentActivity = activityMonitor.getCurrentActivity();
         // Prevent double display
         if (currentActivity != null) {

Diff for: iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java

@@ -405,7 +405,6 @@ private void processMessages() {
         IterableLogger.printInfo();
 
         List<IterableInAppMessage> messages = getMessages();
-
         List<IterableInAppMessage> messagesByPriorityLevel = getMessagesSortedByPriorityLevel(messages);
 
         for (IterableInAppMessage message : messagesByPriorityLevel) {
@@ -414,6 +413,14 @@ private void processMessages() {
                 InAppResponse response = handler.onNewInApp(message);
                 IterableLogger.d(TAG, "Response: " + response);
                 message.setProcessed(true);
+
+                if (message.isJsonOnly()) {
+                    setRead(message, true, null, null);
+                    message.setConsumed(true);
+                    api.inAppConsume(message, null, null, null, null);
+                    return;
+                }
+
                 if (response == InAppResponse.SHOW) {
                     boolean consume = !message.isInboxMessage();
                     showMessage(message, consume, null);
@@ -519,4 +526,4 @@ public void run() {
             }
         });
     }
-}
+}

Diff for: iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppMessage.java

@@ -31,6 +31,7 @@ public class IterableInAppMessage {
     private boolean loadedHtmlFromJson = false;
     private boolean markedForDeletion = false;
     private @Nullable IterableInAppStorage inAppStorageInterface;
+    private final boolean jsonOnly;
 
     IterableInAppMessage(@NonNull String messageId,
                          @NonNull Content content,
@@ -41,7 +42,8 @@ public class IterableInAppMessage {
                          @NonNull Double priorityLevel,
                          @Nullable Boolean saveToInbox,
                          @Nullable InboxMetadata inboxMetadata,
-                         @Nullable Long campaignId) {
+                         @Nullable Long campaignId,
+                         boolean jsonOnly) {
 
         this.messageId = messageId;
         this.content = content;
@@ -50,9 +52,10 @@ public class IterableInAppMessage {
         this.expiresAt = expiresAt;
         this.trigger = trigger;
         this.priorityLevel = priorityLevel;
-        this.saveToInbox = saveToInbox;
+        this.saveToInbox = saveToInbox != null ? (saveToInbox && !jsonOnly) : null;
         this.inboxMetadata = inboxMetadata;
         this.campaignId = campaignId;
+        this.jsonOnly = jsonOnly;
     }
 
     static class Trigger {
@@ -246,7 +249,7 @@ public Date getExpiresAt() {
 
     @NonNull
     public Content getContent() {
-        if (content.html == null) {
+        if (content.html == null && !jsonOnly) {
             content.html = inAppStorageInterface.getHTML(messageId);
         }
         return content;
@@ -322,70 +325,87 @@ public void markForDeletion(boolean delete) {
         this.markedForDeletion = delete;
     }
 
+    public boolean isJsonOnly() {
+        return jsonOnly;
+    }
+
     static IterableInAppMessage fromJSONObject(@NonNull JSONObject messageJson, @Nullable IterableInAppStorage storageInterface) {
 
         if (messageJson == null) {
             return null;
         }
 
-        JSONObject contentJson = messageJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_CONTENT);
-        if (contentJson == null) {
-            return null;
-        }
-
         String messageId = messageJson.optString(IterableConstants.KEY_MESSAGE_ID);
         final Long campaignId = IterableUtil.retrieveValidCampaignIdOrNull(messageJson, IterableConstants.KEY_CAMPAIGN_ID);
+        boolean jsonOnly = messageJson.optBoolean(IterableConstants.ITERABLE_IN_APP_JSON_ONLY, false);
+
+        JSONObject customPayload = messageJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_CUSTOM_PAYLOAD);
+        if (customPayload == null && jsonOnly) {
+            customPayload = new JSONObject();
+        }
+
+        Content content;
+        if (jsonOnly) {
+            content = new Content("", new Rect(), 0.0, false, new InAppDisplaySettings(false, new InAppBgColor(null, 0.0f)));
+        } else {
+            JSONObject contentJson = messageJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_CONTENT);
+            if (contentJson == null) {
+                return null;
+            }
+            if (customPayload == null) {
+                customPayload = contentJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_LEGACY_PAYLOAD);
+            }
+
+            String html = contentJson.optString(IterableConstants.ITERABLE_IN_APP_HTML, null);
+            JSONObject inAppDisplaySettingsJson = contentJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_DISPLAY_SETTINGS);
+            Rect padding = getPaddingFromPayload(inAppDisplaySettingsJson);
+            double backgroundAlpha = contentJson.optDouble(IterableConstants.ITERABLE_IN_APP_BACKGROUND_ALPHA, 0);
+            boolean shouldAnimate = inAppDisplaySettingsJson.optBoolean(IterableConstants.ITERABLE_IN_APP_SHOULD_ANIMATE, false);
+            JSONObject bgColorJson = inAppDisplaySettingsJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_BGCOLOR);
+
+            String bgColorInHex = null;
+            double bgAlpha = 0.0f;
+            if (bgColorJson != null) {
+                bgColorInHex = bgColorJson.optString(IterableConstants.ITERABLE_IN_APP_BGCOLOR_HEX);
+                bgAlpha = bgColorJson.optDouble(IterableConstants.ITERABLE_IN_APP_BGCOLOR_ALPHA);
+            }
+
+            InAppDisplaySettings inAppDisplaySettings = new InAppDisplaySettings(shouldAnimate, new InAppBgColor(bgColorInHex, bgAlpha));
+            content = new Content(html, padding, backgroundAlpha, shouldAnimate, inAppDisplaySettings);
+        }
+
         long createdAtLong = messageJson.optLong(IterableConstants.ITERABLE_IN_APP_CREATED_AT);
         Date createdAt = createdAtLong != 0 ? new Date(createdAtLong) : null;
         long expiresAtLong = messageJson.optLong(IterableConstants.ITERABLE_IN_APP_EXPIRES_AT);
         Date expiresAt = expiresAtLong != 0 ? new Date(expiresAtLong) : null;
 
-        String html = contentJson.optString(IterableConstants.ITERABLE_IN_APP_HTML, null);
-        JSONObject inAppDisplaySettingsJson = contentJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_DISPLAY_SETTINGS);
-        Rect padding = getPaddingFromPayload(inAppDisplaySettingsJson);
-        double backgroundAlpha = contentJson.optDouble(IterableConstants.ITERABLE_IN_APP_BACKGROUND_ALPHA, 0);
-        boolean shouldAnimate = inAppDisplaySettingsJson.optBoolean(IterableConstants.ITERABLE_IN_APP_SHOULD_ANIMATE, false);
-        JSONObject bgColorJson = inAppDisplaySettingsJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_BGCOLOR);
-
-        String bgColorInHex = null;
-        double bgAlpha = 0.0f;
-        if (bgColorJson != null) {
-            bgColorInHex = bgColorJson.optString(IterableConstants.ITERABLE_IN_APP_BGCOLOR_HEX);
-            bgAlpha = bgColorJson.optDouble(IterableConstants.ITERABLE_IN_APP_BGCOLOR_ALPHA);
-        }
-
-        InAppDisplaySettings inAppDisplaySettings = new InAppDisplaySettings(shouldAnimate, new InAppBgColor(bgColorInHex, bgAlpha));
         JSONObject triggerJson = messageJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_TRIGGER);
         Trigger trigger = Trigger.fromJSONObject(triggerJson);
-        JSONObject customPayload = messageJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_CUSTOM_PAYLOAD);
-        if (customPayload == null) {
-            customPayload = contentJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_LEGACY_PAYLOAD);
-        }
-        if (customPayload == null) {
-            customPayload = new JSONObject();
-        }
 
-        double priorityLevel = messageJson.optDouble(IterableConstants.ITERABLE_IN_APP_PRIORITY_LEVEL, IterableConstants.ITERABLE_IN_APP_PRIORITY_LEVEL_UNASSIGNED);
+        double priorityLevel = messageJson.optDouble(IterableConstants.ITERABLE_IN_APP_PRIORITY_LEVEL,
+            IterableConstants.ITERABLE_IN_APP_PRIORITY_LEVEL_UNASSIGNED);
+
+        Boolean saveToInbox = messageJson.has(IterableConstants.ITERABLE_IN_APP_SAVE_TO_INBOX) ?
+            messageJson.optBoolean(IterableConstants.ITERABLE_IN_APP_SAVE_TO_INBOX) : null;
 
-        Boolean saveToInbox = messageJson.has(IterableConstants.ITERABLE_IN_APP_SAVE_TO_INBOX) ? messageJson.optBoolean(IterableConstants.ITERABLE_IN_APP_SAVE_TO_INBOX) : null;
         JSONObject inboxPayloadJson = messageJson.optJSONObject(IterableConstants.ITERABLE_IN_APP_INBOX_METADATA);
         InboxMetadata inboxMetadata = InboxMetadata.fromJSONObject(inboxPayloadJson);
 
-
         IterableInAppMessage message = new IterableInAppMessage(
                 messageId,
-                new Content(html, padding, backgroundAlpha, shouldAnimate, inAppDisplaySettings),
+                content,
                 customPayload,
                 createdAt,
                 expiresAt,
                 trigger,
                 priorityLevel,
                 saveToInbox,
                 inboxMetadata,
-                campaignId);
+                campaignId,
+                jsonOnly);
 
         message.inAppStorageInterface = storageInterface;
-        if (html != null) {
+        if (!jsonOnly && content.html != null && !content.html.isEmpty()) {
             message.setLoadedHtmlFromJson(true);
         }
         message.processed = messageJson.optBoolean(IterableConstants.ITERABLE_IN_APP_PROCESSED, false);
@@ -410,6 +430,9 @@ JSONObject toJSONObject() {
             if (expiresAt != null) {
                 messageJson.putOpt(IterableConstants.ITERABLE_IN_APP_EXPIRES_AT, expiresAt.getTime());
             }
+            if (jsonOnly) {
+                messageJson.put(IterableConstants.ITERABLE_IN_APP_JSON_ONLY, 1);
+            }
 
             messageJson.putOpt(IterableConstants.ITERABLE_IN_APP_TRIGGER, trigger.toJSONObject());
 
@@ -435,7 +458,7 @@ JSONObject toJSONObject() {
             messageJson.putOpt(IterableConstants.ITERABLE_IN_APP_CUSTOM_PAYLOAD, customPayload);
 
             if (saveToInbox != null) {
-                messageJson.putOpt(IterableConstants.ITERABLE_IN_APP_SAVE_TO_INBOX, saveToInbox);
+                messageJson.putOpt(IterableConstants.ITERABLE_IN_APP_SAVE_TO_INBOX, saveToInbox && !jsonOnly);
             }
             if (inboxMetadata != null) {
                 messageJson.putOpt(IterableConstants.ITERABLE_IN_APP_INBOX_METADATA, inboxMetadata.toJSONObject());
@@ -472,6 +495,9 @@ private void onChanged() {
      * @return
      */
     static Rect getPaddingFromPayload(JSONObject paddingOptions) {
+        if (paddingOptions == null) {
+            return new Rect(0, 0, 0, 0);
+        }
         Rect rect = new Rect();
         rect.top = decodePadding(paddingOptions.optJSONObject("top"));
         rect.left = decodePadding(paddingOptions.optJSONObject("left"));
@@ -529,4 +555,4 @@ static JSONObject encodePadding(int padding) throws JSONException {
         }
         return paddingJson;
     }
-}
+}

Diff for: iterableapi/src/test/java/com/iterable/iterableapi/InAppTestUtils.java

@@ -30,7 +30,8 @@ public static IterableInAppMessage getTestInboxInAppWithId(String messageId) {
                 new Double(300.5),
                 true,
                 null,
-                null
+                null,
+                false
                 );
     }
 }

Diff for: iterableapi/src/test/java/com/iterable/iterableapi/IterableApiAuthTests.java

@@ -397,7 +397,23 @@ public void testAuthTokenPresentInRequest() throws Exception {
     public void testAuthFailureReturns401() throws InterruptedException {
         doReturn(expiredJWT).when(authHandler).onAuthTokenRequested();
         dispatcher.enqueueResponse("/events/inAppConsume", new MockResponse().setResponseCode(401).setBody("{\"code\": \"InvalidJwtPayload\"}"));
-        IterableApi.getInstance().inAppConsume(new IterableInAppMessage("asd", null, null, null, null, null, 0.0, null, null, (long) 2), null, null);
+        IterableApi.getInstance().inAppConsume(
+            new IterableInAppMessage(
+                "asd",          // messageId
+                null,           // content
+                null,           // customPayload
+                null,           // createdAt
+                null,           // expiresAt
+                null,           // trigger
+                0.0,           // priorityLevel
+                null,          // saveToInbox
+                null,          // inboxMetadata
+                2L,            // campaignId
+                false          // jsonOnly - since this is a test message, not a JSON message
+            ),
+            null,              // urlHandler
+            null              // customActionHandler
+        );
         Robolectric.flushForegroundThreadScheduler();
         assertEquals(IterableApi.getInstance().getAuthToken(), expiredJWT);
     }