Merge pull request #196 from Iterable/feature/MOB-1187-add-isghostpush-method

[MOB-1187] Add isGhostPush method for apps to detect ghost/silent pushes

Author: vbabenkoru

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

@@ -46,10 +46,7 @@ public static boolean handleMessageReceived(Context context, RemoteMessage remot
             IterableLogger.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody());
         }
 
-        Bundle extras = new Bundle();
-        for (Map.Entry<String, String> entry : messageData.entrySet()) {
-            extras.putString(entry.getKey(), entry.getValue());
-        }
+        Bundle extras = IterableNotificationHelper.mapToBundle(messageData);
 
         if (!IterableNotificationHelper.isIterablePush(extras)) {
             IterableLogger.d(TAG, "Not an Iterable push message");
@@ -92,6 +89,23 @@ public static void handleTokenRefresh() {
         IterableLogger.d(TAG, "New Firebase Token generated: " + registrationToken);
         IterableApi.getInstance().registerForPush();
     }
+
+    /**
+     * Checks if the message is an Iterable ghost push or silent push message
+     * @param remoteMessage Remote message received from Firebase in
+     *        {@link FirebaseMessagingService#onMessageReceived(RemoteMessage)}
+     * @return Boolean indicating whether the message is an Iterable ghost push or silent push
+     */
+    public static boolean isGhostPush(RemoteMessage remoteMessage) {
+        Map<String,String> messageData = remoteMessage.getData();
+
+        if (messageData == null || messageData.isEmpty()) {
+            return false;
+        }
+
+        Bundle extras = IterableNotificationHelper.mapToBundle(messageData);
+        return IterableNotificationHelper.isGhostPush(extras);
+    }
 }
 
 

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

@@ -18,6 +18,8 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
+import java.util.Map;
+
 class IterableNotificationHelper {
     private static final String DEFAULT_CHANNEL_NAME = "iterable channel";
 
@@ -79,6 +81,14 @@ static boolean isEmptyBody(Bundle extras) {
         return instance.isEmptyBody(extras);
     }
 
+    static Bundle mapToBundle(Map<String,String> map) {
+        Bundle bundle = new Bundle();
+        for (Map.Entry<String, String> entry : map.entrySet()) {
+            bundle.putString(entry.getKey(), entry.getValue());
+        }
+        return bundle;
+    }
+
     static class IterableNotificationHelperImpl {
 
         public IterableNotificationBuilder createNotification(Context context, Bundle extras) {

iterableapi/src/test/java/com/iterable/iterableapi/IterableFirebaseMessagingServiceTest.java

@@ -3,7 +3,6 @@
 import android.content.Intent;
 import android.os.Bundle;
 
-import com.google.firebase.iid.FirebaseInstanceId;
 import com.google.firebase.messaging.RemoteMessage;
 
 import org.junit.After;
@@ -21,6 +20,8 @@
 
 import static com.iterable.iterableapi.IterableTestUtils.bundleToMap;
 import static junit.framework.Assert.assertEquals;
+import static junit.framework.TestCase.assertFalse;
+import static junit.framework.TestCase.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.doNothing;
@@ -112,4 +113,20 @@ public void testSilentPushInAppRemoved() throws Exception {
         verify(inAppManagerSpy).removeMessage("1234567890abcdef");
     }
 
+    @Test
+    public void testIsGhostPushWithGhostPushMessage() throws Exception {
+        RemoteMessage.Builder builder = new RemoteMessage.Builder("[email protected]");
+        builder.setData(IterableTestUtils.getMapFromJsonResource("push_payload_ghost_push.json"));
+        assertTrue(IterableFirebaseMessagingService.isGhostPush(builder.build()));
+        verify(notificationHelperSpy).isGhostPush(any(Bundle.class));
+    }
+
+    @Test
+    public void testIsGhostPushWithNotificationMessage() throws Exception {
+        RemoteMessage.Builder builder = new RemoteMessage.Builder("[email protected]");
+        builder.setData(IterableTestUtils.getMapFromJsonResource("push_payload_legacy_deep_link.json"));
+        assertFalse(IterableFirebaseMessagingService.isGhostPush(builder.build()));
+        verify(notificationHelperSpy).isGhostPush(any(Bundle.class));
+    }
+
 }

iterableapi/src/test/resources/push_payload_ghost_push.json

@@ -0,0 +1,8 @@
+{
+  "itbl": {
+    "campaignId": 1234,
+    "templateId": 4321,
+    "messageId": "123456789abcdef",
+    "isGhostPush": true
+  }
+}