Implementing NotificationReceivedHandler

Author: jkasten2

OneSignalSDK/app/src/main/java/com/onesignal/example/MainActivity.java

@@ -73,7 +73,7 @@ protected void onCreate(Bundle savedInstanceState) {
 //          .setNotificationOpenedHandler(new ExampleNotificationOpenedHandler())
 //          .init();
 
-      OneSignal.setInFocusDisplaying(OneSignal.OSDefaultDisplay.InAppAlert);
+      OneSignal.setInFocusDisplaying(OneSignal.OSInFocusDisplay.InAppAlert);
       OneSignal.sendTag("test3", "test7");
       //OneSignal.setSubscription(false);
 

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

@@ -67,6 +67,9 @@ public static void OneSignalStateSynchronizer_syncUserState(boolean fromSyncServ
       OneSignalStateSynchronizer.syncUserState(fromSyncService);
    }
 
+   public static int NotificationBundleProcessor_Process(Context context, boolean restoring, JSONObject jsonPayload, NotificationExtenderService.OverrideSettings overrideSettings) {
+      return NotificationBundleProcessor.Process(context, restoring, jsonPayload, overrideSettings);
+   }
 
    public class NotificationTable extends OneSignalDbContract.NotificationTable { }
    public class NotificationRestorer extends com.onesignal.NotificationRestorer { }

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

@@ -40,6 +40,7 @@
 import android.os.Bundle;
 
 import com.onesignal.BuildConfig;
+import com.onesignal.OSNotification;
 import com.onesignal.OSNotificationOpenResult;
 import com.onesignal.OneSignal;
 import com.onesignal.OneSignalDbHelper;
@@ -69,6 +70,7 @@
 import org.robolectric.RuntimeEnvironment;
 import org.robolectric.Shadows;
 import org.robolectric.annotation.Config;
+import org.robolectric.shadows.ShadowActivity;
 import org.robolectric.shadows.ShadowApplication;
 import org.robolectric.shadows.ShadowConnectivityManager;
 import org.robolectric.shadows.ShadowLog;
@@ -82,6 +84,9 @@
 import java.util.List;
 import java.util.Map;
 
+import static com.onesignal.OneSignalPackagePrivateHelper.GcmBroadcastReceiver_processBundle;
+import static com.onesignal.OneSignalPackagePrivateHelper.NotificationBundleProcessor_Process;
+import static com.onesignal.OneSignalPackagePrivateHelper.bundleAsJSONObject;
 import static com.test.onesignal.GenerateNotificationRunner.getBaseNotifBundle;
 
 @Config(packageName = "com.onesignal.example",
@@ -194,7 +199,7 @@ public void testInitFromApplicationContext() throws Exception {
 
    @Test
    public void testOpenFromNotificationWhenAppIsDead() throws Exception {
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Robo test message\", \"custom\": { \"i\": \"UUID\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Robo test message\", \"custom\": { \"i\": \"UUID\" } }]"), false);
 
       OneSignal.init(blankActivity, "123456789", ONESIGNAL_APP_ID, getNotificationOpenedHandler());
 
@@ -209,7 +214,7 @@ public void shouldCorrectlyRemoveOpenedHandlerAndFireMissedOnesWhenAddedBack() t
       threadAndTaskWait();
 
       OneSignal.removeNotificationOpenedHandler();
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Robo test message\", \"custom\": { \"i\": \"UUID\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Robo test message\", \"custom\": { \"i\": \"UUID\" } }]"), false);
       Assert.assertNull(notificationOpenedMessage);
 
       OneSignal.init(blankActivity, "123456789", ONESIGNAL_APP_ID, getNotificationOpenedHandler());
@@ -244,7 +249,7 @@ public void testOpenFromNotificationWhenAppIsInBackground() throws Exception {
       OneSignal.init(blankActivity, "123456789", ONESIGNAL_APP_ID, getNotificationOpenedHandler());
       Assert.assertNull(notificationOpenedMessage);
 
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\" } }]"), false);
       Assert.assertEquals("Test Msg", notificationOpenedMessage);
       threadWait();
    }
@@ -256,7 +261,7 @@ public void testOpeningLauncherActivity() throws Exception {
       // From app launching normally
       Assert.assertNotNull(Shadows.shadowOf(blankActivity).getNextStartedActivity());
 
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\" } }]"), false);
 
       Assert.assertNotNull(Shadows.shadowOf(blankActivity).getNextStartedActivity());
       Assert.assertNull(Shadows.shadowOf(blankActivity).getNextStartedActivity());
@@ -269,7 +274,7 @@ public void testOpeningLaunchUrl() throws Exception {
 
       // No OneSignal init here to test case where it is located in an Activity.
 
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\", \"u\": \"http://google.com\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\", \"u\": \"http://google.com\" } }]"), false);
 
       Intent intent = Shadows.shadowOf(blankActivity).getNextStartedActivity();
       Assert.assertEquals("android.intent.action.VIEW", intent.getAction());
@@ -287,7 +292,7 @@ public void testOpeningLaunchUrlWithDisableDefault() throws Exception {
 
       // No OneSignal init here to test case where it is located in an Activity.
 
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\", \"u\": \"http://google.com\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\", \"u\": \"http://google.com\" } }]"), false);
       Assert.assertNull(Shadows.shadowOf(blankActivity).getNextStartedActivity());
    }
 
@@ -302,30 +307,59 @@ public void testDisableOpeningLauncherActivityOnNotifiOpen() throws Exception {
       OneSignal.init(blankActivity, "123456789", ONESIGNAL_APP_ID, getNotificationOpenedHandler());
       Assert.assertNull(notificationOpenedMessage);
 
-      OneSignal.handleNotificationOpened(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\" } }]"), false);
+      OneSignal.handleNotificationReceivedWhenInFocus(blankActivity, new JSONArray("[{ \"alert\": \"Test Msg\", \"custom\": { \"i\": \"UUID\" } }]"), false);
 
       Assert.assertNull(Shadows.shadowOf(blankActivity).getNextStartedActivity());
       Assert.assertEquals("Test Msg", notificationOpenedMessage);
    }
 
+   private static String notificationReceivedBody;
+   private static int androidNotificationId;
    @Test
    public void testNotificationReceivedWhenAppInFocus() throws Exception {
-      OneSignal.init(blankActivity, "123456789", ONESIGNAL_APP_ID, getNotificationOpenedHandler());
+      OneSignal.init(blankActivity, "123456789", ONESIGNAL_APP_ID, getNotificationOpenedHandler(), new OneSignal.NotificationReceivedHandler() {
+         @Override
+         public void notificationReceived(OSNotification notification) {
+            androidNotificationId = notification.androidNotificationId;
+            notificationReceivedBody = notification.payload.body;
+         }
+      });
       threadAndTaskWait();
+
+      OneSignal.setInFocusDisplaying(OneSignal.OSInFocusDisplay.Notification);
+
+      Bundle bundle = getBaseNotifBundle();
+      boolean processResult = GcmBroadcastReceiver_processBundle(blankActivity, bundle);
+      threadAndTaskWait(); threadAndTaskWait();
+      Assert.assertEquals(null, notificationOpenedMessage);
+      Assert.assertFalse(processResult);
+      // NotificationBundleProcessor.Process(...) will be called if processResult is true as a service
+      NotificationBundleProcessor_Process(blankActivity, false, bundleAsJSONObject(bundle), null);
+      Assert.assertEquals("Robo test message", notificationReceivedBody);
+      Assert.assertFalse(0 == androidNotificationId);
+
+      // Don't fire for duplicates
+      notificationOpenedMessage = null;
+      notificationReceivedBody = null;
+      OneSignal.setInFocusDisplaying(OneSignal.OSInFocusDisplay.None);
       Assert.assertNull(notificationOpenedMessage);
 
-      OneSignalPackagePrivateHelper.GcmBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
+      GcmBroadcastReceiver_processBundle(blankActivity, bundle);
       threadAndTaskWait();
       Assert.assertEquals(null, notificationOpenedMessage);
+      Assert.assertEquals(null, notificationReceivedBody);
 
+      // Test that only NotificationReceivedHandler fires
+      OneSignal.setInFocusDisplaying(OneSignal.OSInFocusDisplay.None);
+      bundle = getBaseNotifBundle("UUID2");
       notificationOpenedMessage = null;
+      notificationReceivedBody = null;
 
-      OneSignal.setInFocusDisplaying(OneSignal.OSDefaultDisplay.NONE);
+      GcmBroadcastReceiver_processBundle(blankActivity, bundle);
+      threadAndTaskWait(); threadAndTaskWait();
+      Assert.assertEquals(null, notificationOpenedMessage);
       Assert.assertNull(notificationOpenedMessage);
-
-      OneSignalPackagePrivateHelper.GcmBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
-      threadAndTaskWait();
-      Assert.assertEquals("Robo test message", notificationOpenedMessage);
+      Assert.assertEquals("Robo test message", notificationReceivedBody);
    }
 
    @Test

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

@@ -46,7 +46,10 @@ public class GcmIntentService extends IntentService {
    public GcmIntentService() {
       super("GcmIntentService");
    }
-   
+
+   // Called when GCM message is received from Google or a notification is being restored.
+   //    Even for ADM messages.
+   //    Expect if a NotificationExtenderService is setup.
    @Override
    protected void onHandleIntent(Intent intent) {
       Bundle extras = intent.getExtras();

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

@@ -77,8 +77,16 @@ static int Process(Context context, boolean restoring, JSONObject jsonPayload, N
          notificationId = new Random().nextInt();
 
       GenerateNotification.fromJsonPayload(context, restoring, notificationId, jsonPayload, showAsAlert && OneSignal.isAppActive(), overrideSettings);
-      if (!restoring)
+
+      if (!restoring) {
          saveNotification(context, jsonPayload, false, notificationId);
+         try {
+            JSONObject jsonObject = new JSONObject(jsonPayload.toString());
+            jsonObject.put("notificationId", notificationId);
+            OneSignal.handleNotificationReceivedWhenInFocus(newJsonArray(jsonObject));
+         } catch(Throwable t) {}
+      }
+
       return notificationId;
    }
 
@@ -273,43 +281,49 @@ private static void setBackgroundImageLayout(OSNotificationPayload notification,
       }
    }
 
+   // Return true to count the payload as processed.
    static boolean processBundle(Context context, final Bundle bundle) {
       // Not a OneSignal GCM message
       if (OneSignal.getNotificationIdFromGCMBundle(bundle) == null)
          return true;
 
       prepareBundle(bundle);
 
-      boolean showAsAlert = OneSignal.getInAppAlertNotificationEnabled();
-      boolean isActive = OneSignal.isAppActive();
-      boolean display = OneSignal.getNotificationsWhenActiveEnabled()
-            || showAsAlert
-            || !isActive;
-
       Intent overrideIntent = NotificationExtenderService.getIntent(context);
       if (overrideIntent != null) {
          overrideIntent.putExtra("json_payload", bundleAsJSONObject(bundle).toString());
          WakefulBroadcastReceiver.startWakefulService(context, overrideIntent);
          return true;
       }
 
-      if (bundle.getString("alert") == null || "".equals(bundle.getString("alert")))
-         return true;
+      boolean showAsAlert = OneSignal.getInAppAlertNotificationEnabled();
+      boolean isActive = OneSignal.isAppActive();
+      boolean hasBody = bundle.getString("alert") != null && !"".equals(bundle.getString("alert"));
+      boolean display = hasBody &&
+                          (OneSignal.getNotificationsWhenActiveEnabled()
+                        || showAsAlert
+                        || !isActive);
 
+      // Save as a opened notification to prevent duplicates.
       if (!display) {
+         if (OneSignal.notValidOrDuplicated(context, bundleAsJSONObject(bundle)))
+            return true;
+         saveNotification(context, bundle, true, -1);
          // Current thread is meant to be short lived.
          //    Make a new thread to do our OneSignal work on.
          new Thread(new Runnable() {
             public void run() {
-               OneSignal.handleNotificationOpened(bundleAsJsonArray(bundle));
+               OneSignal.handleNotificationReceivedWhenInFocus(bundleAsJsonArray(bundle));
             }
          }).start();
-
-         // Save as a opened notification to prevent duplicates.
-         saveNotification(context, bundle, true, -1);
-         return true;
       }
 
-      return false;
+      return !display;
+   }
+
+   static JSONArray newJsonArray(JSONObject jsonObject) {
+      JSONArray jsonArray = new JSONArray();
+      jsonArray.put(jsonObject);
+      return jsonArray;
    }
 }

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

@@ -73,7 +73,8 @@ static void processIntent(Context incContext, Intent inIntent) {
          try {
             JSONObject jsonData = new JSONObject(intent.getStringExtra("onesignal_data"));
             jsonData.put("notificationId", inIntent.getIntExtra("notificationId", 0));
-            dataArray = newJsonArray(new JSONObject(intent.getStringExtra("onesignal_data")));
+            intent.putExtra("onesignal_data", jsonData.toString());
+            dataArray = NotificationBundleProcessor.newJsonArray(new JSONObject(intent.getStringExtra("onesignal_data")));
          } catch (Throwable t) {
             t.printStackTrace();
          }
@@ -92,7 +93,7 @@ static void processIntent(Context incContext, Intent inIntent) {
       writableDb.close();
 
       if (!dismissed)
-         OneSignal.handleNotificationOpened(context, dataArray, inIntent.getBooleanExtra("from_alert", false));
+         OneSignal.handleNotificationReceivedWhenInFocus(context, dataArray, inIntent.getBooleanExtra("from_alert", false));
    }
 
    private static void addChildNotifications(JSONArray dataArray, String summaryGroup, SQLiteDatabase writableDb) {
@@ -178,9 +179,4 @@ private static ContentValues newContentValuesWithConsumed() {
       return values;
    }
 
-   private static JSONArray newJsonArray(JSONObject jsonObject) {
-      JSONArray jsonArray = new JSONArray();
-      jsonArray.put(jsonObject);
-      return jsonArray;
-   }
 }