Merge pull request #870 from OneSignal/feature/base-receive-receipt

Feature/base receive receipt

Author: jkasten2

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

@@ -145,15 +145,16 @@ private static void saveAndProcessNotification(Context context, Bundle bundle, b
    }
 
    /**
-    * Must call this method instead of saveNotification
-    *
-    * This method save the last notification that might influence session
+    * Save notification, updates Outcomes, and sends Received Receipt if they are enabled.
     */
    static void processNotification(NotificationGenerationJob notifiJob, boolean opened) {
       saveNotification(notifiJob, opened);
-      if (notifiJob.isNotificationToDisplay()) {
-         OutcomesUtils.markLastNotificationReceived(notifiJob.getApiNotificationId());
-      }
+
+      if (!notifiJob.isNotificationToDisplay())
+         return;
+      String notificationId = notifiJob.getApiNotificationId();
+      OutcomesUtils.markLastNotificationReceived(notificationId);
+      OSReceiveReceiptController.getInstance().sendReceiveReceipt(notificationId);
    }
 
    // Saving the notification provides the following:

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

@@ -112,4 +112,5 @@ void setAndroidIdWithOutOverriding(Integer id) {
    boolean hasExtender() {
       return overrideSettings != null && overrideSettings.extender != null;
    }
+
 }

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

@@ -0,0 +1,76 @@
+/**
+ * Modified MIT License
+ * <p>
+ * Copyright 2019 OneSignal
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.onesignal;
+
+import android.support.annotation.NonNull;
+
+class OSReceiveReceiptController {
+
+    private final OSReceiveReceiptRepository repository;
+
+    private static OSReceiveReceiptController sInstance;
+    private OSReceiveReceiptController() {
+        this.repository = new OSReceiveReceiptRepository();
+    }
+    public static synchronized OSReceiveReceiptController getInstance() {
+        if (sInstance == null)
+            sInstance = new OSReceiveReceiptController();
+        return sInstance;
+    }
+
+    void sendReceiveReceipt(@NonNull final String notificationId) {
+        String appId = OneSignal.appId == null || OneSignal.appId.isEmpty() ? OneSignal.getSavedAppId() : OneSignal.appId;
+        String playerId = OneSignal.getUserId();
+
+        if (!isReceiveReceiptEnabled()) {
+            OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "sendReceiveReceipt disable");
+            return;
+        }
+
+        OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "sendReceiveReceipt appId: " + appId + " playerId: " + playerId + " notificationId: " + notificationId);
+        repository.sendReceiveReceipt(appId, playerId, notificationId, new OneSignalRestClient.ResponseHandler() {
+            @Override
+            void onSuccess(String response) {
+                OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "Receive receipt sent for notificationID: " + notificationId);
+            }
+
+            @Override
+            void onFailure(int statusCode, String response, Throwable throwable) {
+                OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Receive receipt failed with statusCode: " + statusCode + " response: " + response);
+            }
+        });
+    }
+
+    private boolean isReceiveReceiptEnabled() {
+        return OneSignalPrefs.getBool(
+           OneSignalPrefs.PREFS_ONESIGNAL,
+           OneSignalPrefs.PREFS_OS_RECEIVE_RECEIPTS_ENABLED,
+           false
+        );
+    }
+}

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

@@ -0,0 +1,51 @@
+/**
+ * Modified MIT License
+ * <p>
+ * Copyright 2019 OneSignal
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * 1. The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * 2. All copies of substantial portions of the Software may only be used in connection
+ * with services provided by OneSignal.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.onesignal;
+
+import android.support.annotation.NonNull;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+class OSReceiveReceiptRepository {
+
+    private static final String APP_ID = "app_id";
+    private static final String PLAYER_ID = "player_id";
+
+    void sendReceiveReceipt(@NonNull String appId, @NonNull String playerId, @NonNull String notificationId, @NonNull OneSignalRestClient.ResponseHandler responseHandler) {
+        try {
+            JSONObject jsonBody = new JSONObject()
+                    .put(APP_ID, appId)
+                    .put(PLAYER_ID, playerId);
+
+            OneSignalRestClient.put("notifications/" + notificationId + "/report_received", jsonBody, responseHandler);
+        } catch (JSONException e) {
+            OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Generating direct receive receipt:JSON Failed.", e);
+        }
+    }
+}

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

@@ -998,6 +998,12 @@ public void complete(OneSignalRemoteParams.Params params) {
                OneSignalPrefs.PREFS_OS_CLEAR_GROUP_SUMMARY_CLICK,
                remoteParams.clearGroupOnSummaryClick
             );
+            OneSignalPrefs.saveBool(
+               OneSignalPrefs.PREFS_ONESIGNAL,
+               OneSignalPrefs.PREFS_OS_RECEIVE_RECEIPTS_ENABLED,
+               remoteParams.receiveReceiptEnabled
+            );
+           
             OutcomesUtils.saveOutcomesParams(params.outcomesParams);
 
             NotificationChannelManager.processChannelList(

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

@@ -80,6 +80,7 @@ class OneSignalPrefs {
     public static final String PREFS_OS_DISPLAYED_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_RECEIVE_RECEIPTS_ENABLED = "PREFS_OS_RECEIVE_RECEIPTS_ENABLED";
     public static final String PREFS_OS_LAST_ATTRIBUTED_NOTIFICATION_OPEN = "PREFS_OS_LAST_ATTRIBUTED_NOTIFICATION_OPEN";
     public static final String PREFS_OS_LAST_NOTIFICATIONS_RECEIVED = "PREFS_OS_LAST_NOTIFICATIONS_RECEIVED";
     public static final String PREFS_OS_NOTIFICATION_LIMIT = "PREFS_OS_NOTIFICATION_LIMIT";
@@ -90,7 +91,6 @@ class OneSignalPrefs {
     public static final String PREFS_OS_OUTCOMES_CURRENT_SESSION = "PREFS_OS_OUTCOMES_CURRENT_SESSION";
     public static final String PREFS_OS_UNIQUE_OUTCOME_EVENTS_SENT = "PREFS_OS_UNIQUE_OUTCOME_EVENTS_SENT";
 
-
     // PLAYER PURCHASE KEYS
     static final String PREFS_PURCHASE_TOKENS = "purchaseTokens";
     static final String PREFS_EXISTING_PURCHASES = "ExistingPurchases";

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

@@ -27,6 +27,7 @@ static class Params {
       boolean firebaseAnalytics;
       boolean restoreTTLFilter;
       boolean clearGroupOnSummaryClick;
+      boolean receiveReceiptEnabled;
       OutcomesParams outcomesParams;
    }
 
@@ -107,6 +108,7 @@ static private void processJson(String json, final @NonNull CallBack callBack) {
          restoreTTLFilter = responseJson.optBoolean("restore_ttl_filter", true);
          googleProjectNumber = responseJson.optString("android_sender_id", null);
          clearGroupOnSummaryClick = responseJson.optBoolean("clear_group_on_summary_click", true);
+         receiveReceiptEnabled = responseJson.optBoolean("receive_receipts_enable", false);
          outcomesParams = new OutcomesParams();
 
          //Process outcomes params

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

@@ -0,0 +1,13 @@
+package com.onesignal;
+
+import org.robolectric.annotation.Implementation;
+import org.robolectric.annotation.Implements;
+
+@Implements(OSReceiveReceiptController.class)
+public class ShadowReceiveReceiptController {
+
+    @Implementation
+    public boolean isReceiveReceiptEnabled() {
+        return true;
+    }
+}

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

@@ -72,6 +72,7 @@
 import com.onesignal.ShadowOSWebView;
 import com.onesignal.ShadowOneSignal;
 import com.onesignal.ShadowOneSignalRestClient;
+import com.onesignal.ShadowReceiveReceiptController;
 import com.onesignal.ShadowRoboNotificationManager;
 import com.onesignal.ShadowRoboNotificationManager.PostedNotification;
 import com.onesignal.StaticResetHelper;
@@ -106,8 +107,11 @@
 import static com.onesignal.OneSignalPackagePrivateHelper.NotificationOpenedProcessor_processFromContext;
 import static com.onesignal.OneSignalPackagePrivateHelper.NotificationSummaryManager_updateSummaryNotificationAfterChildRemoved;
 import static com.onesignal.OneSignalPackagePrivateHelper.createInternalPayloadBundle;
+import static com.test.onesignal.RestClientAsserts.assertReportReceivedAtIndex;
+import static com.test.onesignal.RestClientAsserts.assertRestCalls;
 import static com.test.onesignal.TestHelpers.advanceSystemTimeBy;
 import static com.test.onesignal.TestHelpers.threadAndTaskWait;
+
 import static junit.framework.Assert.assertEquals;
 import static junit.framework.Assert.assertFalse;
 import static junit.framework.Assert.assertNotNull;
@@ -296,8 +300,6 @@ public void shouldSetCorrectNumberOfButtonsOnSummaryNotification() throws Except
       assertEquals(1, postedSummaryNotification.notif.actions.length);
    }
 
-   
-   
    @Test
    public void shouldCancelAllNotificationsPartOfAGroup() throws Exception {
       // Setup - Init
@@ -1222,6 +1224,34 @@ public void shouldShowInAppPreviewWhenOpeningPreviewNotification() throws Except
 
       assertEquals("PGh0bWw+PC9odG1sPg==", ShadowOSWebView.lastData);
    }
+
+   @Test
+   @Config(shadows = { ShadowReceiveReceiptController.class })
+   public void shouldSendReceivedReceiptWhenEnabled() throws Exception {
+      String appId = "b2f7f966-d8cc-11e4-bed1-df8f05be55ba";
+      OneSignal.init(blankActivity, "123456789", appId);
+      threadAndTaskWait();
+      NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, getBaseNotifBundle(), null);
+      threadAndTaskWait();
+
+      assertReportReceivedAtIndex(
+         2,
+         "UUID",
+         new JSONObject().put("app_id", appId).put("player_id", ShadowOneSignalRestClient.pushUserId)
+      );
+   }
+
+   @Test
+   public void shouldNotSendReceivedReceiptWhenDisabled() throws Exception {
+      String appId = "b2f7f966-d8cc-11e4-bed1-df8f05be55ba";
+      OneSignal.init(blankActivity, "123456789", appId);
+      threadAndTaskWait();
+      NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, getBaseNotifBundle(), null);
+      threadAndTaskWait();
+
+      assertRestCalls(2);
+   }
+
 
    private OSNotification lastNotificationReceived;
    @Test

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

@@ -77,6 +77,7 @@
 import com.onesignal.ShadowOneSignal;
 import com.onesignal.ShadowOneSignalRestClient;
 import com.onesignal.ShadowPushRegistratorGCM;
+import com.onesignal.ShadowReceiveReceiptController;
 import com.onesignal.ShadowRoboNotificationManager;
 import com.onesignal.StaticResetHelper;
 import com.onesignal.SyncJobService;
@@ -137,6 +138,8 @@
 import static junit.framework.Assert.assertNull;
 import static junit.framework.Assert.assertTrue;
 import static org.hamcrest.CoreMatchers.not;
+import static org.hamcrest.core.Is.is;
+import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertThat;
 import static org.robolectric.Shadows.shadowOf;
 
@@ -923,12 +926,13 @@ public void notificationReceived(OSNotification notification) {
       Bundle bundle = getBaseNotifBundle();
       boolean processResult = GcmBroadcastReceiver_processBundle(blankActivity, bundle);
       threadAndTaskWait();
-      assertEquals(null, notificationOpenedMessage);
+
+      assertNull(notificationOpenedMessage);
       assertFalse(processResult);
       // NotificationBundleProcessor.Process(...) will be called if processResult is true as a service
       NotificationBundleProcessor_Process(blankActivity, false, bundleAsJSONObject(bundle), null);
       assertEquals("Robo test message", notificationReceivedBody);
-      assertFalse(0 == androidNotificationId);
+      assertNotEquals(0, androidNotificationId);
 
       // Don't fire for duplicates
       notificationOpenedMessage = null;
@@ -938,8 +942,8 @@ public void notificationReceived(OSNotification notification) {
 
       GcmBroadcastReceiver_processBundle(blankActivity, bundle);
       threadAndTaskWait();
-      assertEquals(null, notificationOpenedMessage);
-      assertEquals(null, notificationReceivedBody);
+      assertNull(notificationOpenedMessage);
+      assertNull(notificationReceivedBody);
 
       // Test that only NotificationReceivedHandler fires
       OneSignal.setInFocusDisplaying(OneSignal.OSInFocusDisplayOption.None);
@@ -949,7 +953,6 @@ public void notificationReceived(OSNotification notification) {
 
       GcmBroadcastReceiver_processBundle(blankActivity, bundle);
       threadAndTaskWait();
-      assertEquals(null, notificationOpenedMessage);
       assertNull(notificationOpenedMessage);
       assertEquals("Robo test message", notificationReceivedBody);
    }