Iam carousel page impressions #1239

emawby · 2020-12-10T18:15:15Z

This PR adds SDK support for individual IAM Carousel page impressions.

It adds a new model OSInAppMessagePage.kt and event type pageChange that reads the pageId from the new page_change event that is received from the carousel's javascript.

To send the page impression we use the new pageImpression endpoint using the new request fireRESTCallForPageChange
Page impressions are only sent once per Impression of a Carousel. The ids are tracked in a new set viewedPageIds on the OSInAppMessage object

Additionally we receive the pageId for click events, but do not currently use them.

Question: Do we need to save impressioned pages in OneSignalPrefs like we do for normal impression? (commented out code right now)

This change is

jkasten2 · 2020-12-11T00:49:18Z

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

+                @Override
+                void onSuccess(String response) {
+                    printHttpSuccessForInAppMessageRequest("page impression", response);
+                    /*OneSignalPrefs.saveStringSet(


Looks like this is a TODO yet?

Yes this was my question at the end of the PR do we need to save the ids to the prefs?

The only scenario that I think needs this.
1 - Opening app
2 - Display IAM
3 - Impression sent
4 - Close application (swipe away) without dismiss IAM
5 - Open app
6 - IAM should display again
7 - Impression shouldn't be sent again

Cool confirmed that this is an issue so I will store them in the prefs

Jeasmine · 2020-12-11T18:08:56Z

Examples/OneSignalDemo/local.properties

@@ -4,6 +4,6 @@
 # Location of the SDK. This is only used by Gradle.
 # For customization when using a Version Control System, please read the
 # header note.
-#Tue Jul 23 19:22:28 PDT 2019


this should be a ignored file

can we remove this file from the PR?

Jeasmine · 2020-12-11T18:10:23Z

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

@@ -125,6 +133,11 @@ public String getClickName() {
        return clickName;
    }

+    @NonNull


this is marked as notNull but

pageId = json.optString(PAGE_ID, null); it could end being null, maybe set a default value? tr change to Nullable

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

Jeasmine · 2020-12-11T18:12:27Z

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

+
+
+        // Never send multiple page impressions for the same message UUID unless that page change is from an IAM with redisplay
+        if (message.getViewedPageIds().contains(pageId))


this is checked under onPageChanged too, is that ok?

Now only checking in the rest method call for consistency with iOS and better separation of concerns

Jeasmine · 2020-12-11T18:18:53Z

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

+        pageIndex = jsonObject.optString(PAGE_INDEX, null)
+    }
+
+    fun toJSONObject(): JSONObject? {


is the optional needed?

Jeasmine · 2020-12-11T18:20:32Z

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

+
+    @Test
+    public void testOnPageChanged() throws Exception {
+        threadAndTaskWait();


is this needed?

yes it crashes without it

oh, weird 🤔 test setup should not break tests, can you point out which error it is?

Ah sorry the crash can be fixed, but you need to initialize to have the player id etc for the request

Jeasmine · 2020-12-11T18:21:25Z

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

+    public void testOnPageChanged() throws Exception {
+        threadAndTaskWait();
+
+        OneSignalPackagePrivateHelper.onPageChanged(message, InAppMessagingHelpers.buildTestPageJson());


is ok to test without mocking the IAM display?

Yes we test without mocking the iam display for clicks as well and they should be entirely independent

Jeasmine · 2020-12-14T19:34:19Z

Examples/OneSignalDemo/local.properties

@@ -4,6 +4,6 @@
 # Location of the SDK. This is only used by Gradle.
 # For customization when using a Version Control System, please read the
 # header note.
-#Tue Jul 23 19:22:28 PDT 2019


can we remove this file from the PR?

Jeasmine · 2020-12-14T19:35:22Z

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

+        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 (message.getViewedPageIds().contains(pageId) || viewedPageIds.contains(messagePrefixedPageId)) {


same question as on iOS, see OneSignal/OneSignal-iOS-SDK#735 (comment)

same fix as ios. only tracking globally now, but it is still per inapp since we don't want them to affect each other (in local testing I was getting duplicate page ids for different inapps which is why I prefixed the page id with the message id)

Jeasmine · 2020-12-15T21:08:25Z

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

@@ -494,6 +568,8 @@ private void setDataForRedisplay(OSInAppMessage message) {

                dismissedMessages.remove(message.messageId);
                impressionedMessages.remove(message.messageId);
+                viewedPageIds.clear();


can we put some comment over this desition of cleaning impressions, so we know in the future?

emawby added 7 commits December 9, 2020 15:49

adding pageIds to OSInAppMessage

142e4b4

adding page Id to in app message action

999ca8d

creating OSInAppMessagePage class

24d41f0

adding page impression rest call and page changed logic

2d04a71

firing onPageChanged from json event

565f476

Unit test for page changed event

0149a12

matching json to backend spec change

0479008

emawby requested review from jkasten2 and Jeasmine December 10, 2020 18:15

jkasten2 requested changes Dec 11, 2020

View reviewed changes

emawby requested a review from jkasten2 December 11, 2020 18:12

Jeasmine reviewed Dec 11, 2020

View reviewed changes

emawby requested a review from Jeasmine December 14, 2020 19:27

Jeasmine reviewed Dec 14, 2020

View reviewed changes

emawby requested a review from Jeasmine December 14, 2020 21:45

Jeasmine reviewed Dec 16, 2020

View reviewed changes

emawby requested a review from Jeasmine December 16, 2020 20:26

Jeasmine approved these changes Dec 16, 2020

View reviewed changes

emawby force-pushed the feature/iam_carousel branch 2 times, most recently from 9fd9540 to 1a8c6a9 Compare December 23, 2020 22:23

emawby added 2 commits December 23, 2020 14:24

removing page id check in pageChanged

d865c22

Storing pageIds to prefs to fix double impression

38ef376

emawby force-pushed the feature/iam_carousel branch from 1a8c6a9 to 38ef376 Compare December 23, 2020 22:24

emawby merged commit 09ebc87 into master Dec 23, 2020

emawby deleted the feature/iam_carousel branch December 23, 2020 22:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Iam carousel page impressions #1239

Iam carousel page impressions #1239

emawby commented Dec 10, 2020 •

edited by sync-by-unito bot

jkasten2 Dec 11, 2020

emawby Dec 11, 2020

Jeasmine Dec 11, 2020

emawby Dec 11, 2020

Jeasmine Dec 11, 2020

Jeasmine Dec 14, 2020

Jeasmine Dec 11, 2020

emawby Dec 14, 2020

Jeasmine Dec 11, 2020

emawby Dec 14, 2020

Jeasmine Dec 11, 2020

emawby Dec 14, 2020

Jeasmine Dec 11, 2020

emawby Dec 14, 2020

Jeasmine Dec 14, 2020

emawby Dec 14, 2020

Jeasmine Dec 11, 2020

emawby Dec 14, 2020

Jeasmine Dec 14, 2020

Jeasmine Dec 14, 2020

emawby Dec 14, 2020

Jeasmine Dec 15, 2020

emawby Dec 16, 2020



		// Never send multiple page impressions for the same message UUID unless that page change is from an IAM with redisplay
		if (message.getViewedPageIds().contains(pageId))

Iam carousel page impressions #1239

Iam carousel page impressions #1239

Conversation

emawby commented Dec 10, 2020 • edited by sync-by-unito bot

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emawby commented Dec 10, 2020 •

edited by sync-by-unito bot