Merge pull request #1239 from OneSignal/feature/iam_carousel

Iam carousel page impressions

Author: emawby

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

@@ -17,6 +17,7 @@ public class OSInAppMessageAction {
     private static final String ID = "id";
     private static final String NAME = "name";
     private static final String URL = "url";
+    private static final String PAGE_ID = "pageId";
     private static final String URL_TARGET = "url_target";
     private static final String CLOSE = "close";
     private static final String CLICK_NAME = "click_name";
@@ -52,6 +53,12 @@ public class OSInAppMessageAction {
     @Nullable
     private String clickUrl;
 
+    /**
+     * UUID for the page in an IAM Carousel
+     */
+    @Nullable
+    private String pageId;
+
     /**
      * Outcome for action
      */
@@ -83,6 +90,7 @@ public class OSInAppMessageAction {
         clickId = json.optString(ID, null);
         clickName = json.optString(NAME, null);
         clickUrl = json.optString(URL, null);
+        pageId = json.optString(PAGE_ID, null);
         urlTarget = OSInAppMessageActionUrlType.fromString(json.optString(URL_TARGET, null));
         if (urlTarget == null)
             urlTarget = OSInAppMessageActionUrlType.IN_APP_WEBVIEW;
@@ -125,6 +133,10 @@ public String getClickName() {
         return clickName;
     }
 
+    String getPageId() {
+        return pageId;
+    }
+
     @Nullable
     public OSInAppMessageActionUrlType getUrlTarget() {
         return urlTarget;

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

@@ -51,6 +51,9 @@ class OSInAppMessageController implements OSDynamicTriggerControllerObserver, OS
     //   This means their impression has been successfully posted to our backend and should not be counted again
     @NonNull
     final private Set<String> impressionedMessages;
+    //   This means their impression has been successfully posted to our backend and should not be counted again
+    @NonNull
+    final private Set<String> viewedPageIds;
     // IAM clicks that have been successfully posted to our backend and should not be counted again
     @NonNull
     final private Set<String> clickedClickIds;
@@ -75,6 +78,7 @@ protected OSInAppMessageController(OneSignalDbHelper dbHelper, OSLogger logger)
         dismissedMessages = OSUtils.newConcurrentSet();
         messageDisplayQueue = new ArrayList<>();
         impressionedMessages = OSUtils.newConcurrentSet();
+        viewedPageIds = OSUtils.newConcurrentSet();
         clickedClickIds = OSUtils.newConcurrentSet();
         triggerController = new OSTriggerController(this);
         systemConditionController = new OSSystemConditionController(this);
@@ -96,6 +100,14 @@ protected OSInAppMessageController(OneSignalDbHelper dbHelper, OSLogger logger)
         if (tempImpressionsSet != null)
             impressionedMessages.addAll(tempImpressionsSet);
 
+        Set<String> tempPageImpressionsSet = OneSignalPrefs.getStringSet(
+                OneSignalPrefs.PREFS_ONESIGNAL,
+                OneSignalPrefs.PREFS_OS_PAGE_IMPRESSIONED_IAMS,
+                null
+        );
+        if (tempPageImpressionsSet != null)
+            viewedPageIds.addAll(tempPageImpressionsSet);
+
         Set<String> tempClickedMessageIdsSet = OneSignalPrefs.getStringSet(
                 OneSignalPrefs.PREFS_ONESIGNAL,
                 OneSignalPrefs.PREFS_OS_CLICKED_CLICK_IDS_IAMS,
@@ -281,6 +293,14 @@ void onFailure(int statusCode, String response, Throwable throwable) {
         }
     }
 
+    void onPageChanged(@NonNull final OSInAppMessage message, @NonNull final JSONObject eventJson) {
+        final OSInAppMessagePage newPage = new OSInAppMessagePage(eventJson);
+        if (message.isPreview) {
+            return;
+        }
+        fireRESTCallForPageChange(message, newPage);
+    }
+
     void onMessageActionOccurredOnMessage(@NonNull final OSInAppMessage message, @NonNull final JSONObject actionJson) throws JSONException {
         final OSInAppMessageAction action = new OSInAppMessageAction(actionJson);
         action.setFirstClick(message.takeActionAsUnique());
@@ -409,6 +429,60 @@ else if (action.getUrlTarget() == OSInAppMessageAction.OSInAppMessageActionUrlTy
         }
     }
 
+    private void saveViewedPageIdsToPrefs() {
+        OneSignalPrefs.saveStringSet(
+                OneSignalPrefs.PREFS_ONESIGNAL,
+                OneSignalPrefs.PREFS_OS_PAGE_IMPRESSIONED_IAMS,
+                // Post success, store impressioned pages to disk
+                viewedPageIds);
+    }
+
+    private void fireRESTCallForPageChange(@NonNull final OSInAppMessage message, @NonNull final OSInAppMessagePage page) {
+        final String variantId = variantIdForMessage(message);
+        if (variantId == null)
+            return;
+
+        final String pageId = page.getPageId();
+
+        final String messagePrefixedPageId = message.messageId + pageId;
+
+        // Never send multiple page impressions for the same message UUID unless that page change is from an IAM with redisplay
+        if (viewedPageIds.contains(messagePrefixedPageId)) {
+            OneSignal.onesignalLog(OneSignal.LOG_LEVEL.VERBOSE, "Already sent page impression for id: " + pageId);
+            return;
+        }
+
+        viewedPageIds.add(messagePrefixedPageId);
+
+        try {
+            JSONObject json = new JSONObject() {{
+                put("app_id", OneSignal.appId);
+                put("player_id", OneSignal.getUserId());
+                put("variant_id", variantId);
+                put("device_type", new OSUtils().getDeviceType());
+                put("page_id", pageId);
+            }};
+
+            OneSignalRestClient.post("in_app_messages/" + message.messageId + "/pageImpression", json, new ResponseHandler() {
+                @Override
+                void onSuccess(String response) {
+                    printHttpSuccessForInAppMessageRequest("page impression", response);
+                    saveViewedPageIdsToPrefs();
+                }
+
+                @Override
+                void onFailure(int statusCode, String response, Throwable throwable) {
+                    printHttpErrorForInAppMessageRequest("page impression", statusCode, response);
+                    // Post failed, viewed page should be removed and this way another post can be attempted
+                    viewedPageIds.remove(messagePrefixedPageId);
+                }
+            });
+        } catch (JSONException e) {
+            e.printStackTrace();
+            OneSignal.onesignalLog(OneSignal.LOG_LEVEL.ERROR, "Unable to execute in-app message impression HTTP request due to invalid JSON");
+        }
+    }
+
     private void fireRESTCallForClick(@NonNull final OSInAppMessage message, @NonNull final OSInAppMessageAction action) {
         final String variantId = variantIdForMessage(message);
         if (variantId == null)
@@ -493,6 +567,10 @@ private void setDataForRedisplay(OSInAppMessage message) {
 
                 dismissedMessages.remove(message.messageId);
                 impressionedMessages.remove(message.messageId);
+                // Pages from different IAMs should not impact each other so we can clear the entire
+                // list when an IAM is dismissed or we are re-displaying the same one
+                viewedPageIds.clear();
+                saveViewedPageIdsToPrefs();
                 message.clearClickIds();
             }
         }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessagePage.kt

@@ -0,0 +1,29 @@
+package com.onesignal
+
+
+import org.json.JSONException
+import org.json.JSONObject
+
+const val PAGE_ID = "pageId"
+const val PAGE_INDEX = "pageIndex"
+
+class OSInAppMessagePage constructor(jsonObject: JSONObject) {
+    var pageId: String? = null
+    var pageIndex: String? = null
+
+    init {
+        pageId = jsonObject.optString(PAGE_ID, null)
+        pageIndex = jsonObject.optString(PAGE_INDEX, null)
+    }
+
+    fun toJSONObject(): JSONObject {
+        val mainObj = JSONObject()
+        try {
+            mainObj.put(PAGE_ID, pageId)
+            mainObj.put(PAGE_INDEX, pageIndex)
+        } catch (e: JSONException) {
+            e.printStackTrace()
+        }
+        return mainObj
+    }
+}

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

@@ -108,6 +108,7 @@ class OneSignalPrefs {
     public static final String PREFS_OS_DISMISSED_IAMS = "PREFS_OS_DISPLAYED_IAMS";
     public static final String PREFS_OS_IMPRESSIONED_IAMS = "PREFS_OS_IMPRESSIONED_IAMS";
     public static final String PREFS_OS_CLICKED_CLICK_IDS_IAMS = "PREFS_OS_CLICKED_CLICK_IDS_IAMS";
+    public static final String PREFS_OS_PAGE_IMPRESSIONED_IAMS = "PREFS_OS_PAGE_IMPRESSIONED_IAMS";
 
     // Player Purchase Keys
     static final String PREFS_PURCHASE_TOKENS = "purchaseTokens";

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

@@ -155,6 +155,7 @@ class OSJavaScriptInterface {
         static final String EVENT_TYPE_KEY = "type";
         static final String EVENT_TYPE_RENDERING_COMPLETE = "rendering_complete";
         static final String EVENT_TYPE_ACTION_TAKEN = "action_taken";
+        static final String EVENT_TYPE_PAGE_CHANGE = "page_change";
 
         static final String IAM_DISPLAY_LOCATION_KEY = "displayLocation";
         static final String IAM_PAGE_META_DATA_KEY = "pageMetaData";
@@ -168,11 +169,20 @@ public void postMessage(String message) {
                 JSONObject jsonObject = new JSONObject(message);
                 String messageType = jsonObject.getString(EVENT_TYPE_KEY);
 
-                if (messageType.equals(EVENT_TYPE_RENDERING_COMPLETE))
-                    handleRenderComplete(jsonObject);
-                else if (messageType.equals(EVENT_TYPE_ACTION_TAKEN) && !messageView.isDragging()) {
-                    // Added handling so that click actions won't trigger while dragging the IAM
-                    handleActionTaken(jsonObject);
+                switch (messageType) {
+                    case EVENT_TYPE_RENDERING_COMPLETE:
+                        handleRenderComplete(jsonObject);
+                        break;
+                    case EVENT_TYPE_ACTION_TAKEN:
+                        // Added handling so that click actions won't trigger while dragging the IAM
+                        if (!messageView.isDragging())
+                            handleActionTaken(jsonObject);
+                        break;
+                    case EVENT_TYPE_PAGE_CHANGE:
+                        handlePageChange(jsonObject);
+                        break;
+                    default:
+                        break;
                 }
             } catch (JSONException e) {
                 e.printStackTrace();
@@ -226,6 +236,10 @@ private void handleActionTaken(JSONObject jsonObject) throws JSONException {
             if (close)
                 dismissAndAwaitNextMessage(null);
         }
+
+        private void handlePageChange(JSONObject jsonObject) throws JSONException {
+            OneSignal.getInAppMessageController().onPageChanged(message, jsonObject);
+        }
     }
 
     private static int pageRectToViewHeight(final @NonNull Activity activity, @NonNull JSONObject jsonObject) {

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

@@ -17,6 +17,7 @@ public class InAppMessagingHelpers {
     public static final String TEST_ENGLISH_ANDROID_VARIANT_ID = "11e4-bed1-df8f05be55ba-a4b3gj7f-d8cc";
     public static final String ONESIGNAL_APP_ID = "b4f7f966-d8cc-11e4-bed1-df8f05be55ba";
     public static final String IAM_CLICK_ID = "12345678-1234-1234-1234-123456789012";
+    public static final String IAM_PAGE_ID = "12345678-1234-ABCD-1234-123456789012";
 
     public static boolean evaluateMessage(OSInAppMessage message) {
         return OneSignal.getInAppMessageController().triggerController.evaluateMessageTriggers(message);
@@ -171,9 +172,17 @@ public static JSONObject buildTestActionJson() throws JSONException {
             put("url", "https://www.onesignal.com");
             put("url_target", "webview");
             put("close", true);
+            put("pageId", IAM_PAGE_ID);
             put("data", new JSONObject() {{
                 put("test", "value");
             }});
         }};
     }
+
+    public static JSONObject buildTestPageJson() throws JSONException {
+        return new JSONObject() {{
+            put("pageIndex", 1);
+            put("pageId", IAM_PAGE_ID);
+        }};
+    }
 }

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

@@ -495,6 +495,10 @@ public static void onMessageWasShown(@NonNull com.onesignal.OSInAppMessage messa
       OneSignal.getInAppMessageController().onMessageWasShown(message);
    }
 
+   public static void onPageChanged(@NonNull com.onesignal.OSInAppMessage message, @NonNull final JSONObject eventJson) {
+      OneSignal.getInAppMessageController().onPageChanged(message, eventJson);
+   }
+
    public static List<OSTestInAppMessage> getRedisplayInAppMessages() {
       List<OSInAppMessage> messages = OneSignal.getInAppMessageController().getRedisplayedInAppMessages();
       List<OSTestInAppMessage> testMessages = new ArrayList<>();

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

@@ -616,4 +616,19 @@ public void testOnMessageWasShown() throws Exception {
         assertEquals(1, iamImpressionRequest.payload.get("device_type"));
         assertEquals(true, iamImpressionRequest.payload.get("first_impression"));
     }
+
+    @Test
+    public void testOnPageChanged() throws Exception {
+        threadAndTaskWait();
+
+        OneSignalPackagePrivateHelper.onPageChanged(message, InAppMessagingHelpers.buildTestPageJson());
+
+        ShadowOneSignalRestClient.Request iamPageImpressionRequest = ShadowOneSignalRestClient.requests.get(2);
+
+        assertEquals("in_app_messages/" + message.messageId + "/pageImpression", iamPageImpressionRequest.url);
+        assertEquals(InAppMessagingHelpers.ONESIGNAL_APP_ID, iamPageImpressionRequest.payload.get("app_id"));
+        assertEquals(ShadowOneSignalRestClient.pushUserId, iamPageImpressionRequest.payload.get("player_id"));
+        assertEquals(1, iamPageImpressionRequest.payload.get("device_type"));
+        assertEquals(InAppMessagingHelpers.IAM_PAGE_ID, iamPageImpressionRequest.payload.get("page_id"));
+    }
 }