Added NotificationExtender to allow customizing notifications

Author: jkasten2

OneSignalSDK/app/src/main/AndroidManifest.xml

@@ -90,6 +90,16 @@
             </intent-filter>
         </receiver>
 -->
+
+
+        <service
+            android:name=".NotificationExtenderServiceTest"
+            android:exported="false">
+            <intent-filter>
+                <action android:name="com.onesignal.NotificationExtender" />
+            </intent-filter>
+        </service>
+
     </application>
 
 </manifest>

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

@@ -0,0 +1,46 @@
+package com.onesignal.example;
+
+import android.support.v4.app.NotificationCompat;
+
+import com.onesignal.OSNotificationPayload;
+import com.onesignal.NotificationExtenderService;
+
+import java.lang.reflect.Field;
+import java.math.BigInteger;
+
+public class NotificationExtenderServiceTest extends NotificationExtenderService {
+
+   @Override
+   protected boolean onNotificationProcessing(OSNotificationPayload notification) {
+      printObject(notification);
+      if (notification.actionButtons != null) {
+         for(OSNotificationPayload.ActionButton button : notification.actionButtons) {
+            System.out.println("button:");
+            printObject(button);
+         }
+      }
+
+      OverrideSettings overrideSettings = new OverrideSettings();
+
+      overrideSettings.extender = new NotificationCompat.Extender() {
+         @Override
+         public NotificationCompat.Builder extend(NotificationCompat.Builder builder) {
+            return builder.setColor(new BigInteger("FF00FF00", 16).intValue());
+         }
+      };
+
+      displayNotification(overrideSettings);
+
+      return true;
+   }
+
+   private void printObject(Object obj) {
+      for (Field field : obj.getClass().getDeclaredFields()) {
+         String name = field.getName();
+         try {
+            Object value = field.get(obj);
+            System.out.printf("Field name: %s, Field value: %s%n", name, value);
+         } catch (Throwable t){}
+      }
+   }
+}

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

@@ -1,7 +1,10 @@
 package com.onesignal;
 
+import android.content.Context;
+import android.os.Bundle;
 import android.os.Looper;
 
+import org.json.JSONObject;
 import org.robolectric.util.Scheduler;
 
 import java.util.Map;
@@ -38,6 +41,18 @@ public static void SyncService_onTaskRemoved() {
       SyncService.onTaskRemoved();
    }
 
+   public static JSONObject bundleAsJSONObject(Bundle bundle) {
+      return NotificationBundleProcessor.bundleAsJSONObject(bundle);
+   }
+
+   public static void NotificationBundleProcessor_ProcessFromGCMIntentService(Context context, Bundle bundle, NotificationExtenderService.OverrideSettings overrideSettings) {
+      NotificationBundleProcessor.ProcessFromGCMIntentService(context, bundle, overrideSettings);
+   }
+
+   public static boolean GcmBroadcastReceiver_processBundle(Context context, Bundle bundle) {
+      return GcmBroadcastReceiver.processBundle(context, bundle);
+   }
+
 
    public class NotificationTable extends OneSignalDbContract.NotificationTable { }
 }

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

@@ -62,9 +62,7 @@ public void notify(String tag, int id, Notification notification) {
       lastNotif = shadowOf(notification);
       lastNotifId = id;
       notifications.add(new PostedNotification(id, lastNotif));
-      System.out.println("notification: " + lastNotif.getContentText());
       super.notify(tag, id, notification);
-      //throw new RuntimeException("Get stack trace!");
    }
 
 }

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

@@ -32,14 +32,18 @@
 import android.content.Intent;
 import android.content.pm.ActivityInfo;
 import android.content.pm.ResolveInfo;
+import android.content.pm.ServiceInfo;
 import android.database.Cursor;
 import android.database.sqlite.SQLiteDatabase;
 import android.os.Bundle;
 
 import com.onesignal.BuildConfig;
-import com.onesignal.NotificationBundleProcessor;
+import com.onesignal.NotificationExtenderService;
 import com.onesignal.NotificationOpenedProcessor;
+import com.onesignal.OSNotificationDisplayedResult;
+import com.onesignal.OSNotificationPayload;
 import com.onesignal.OneSignalDbHelper;
+import com.onesignal.OneSignalPackagePrivateHelper;
 import com.onesignal.ShadowBadgeCountUpdater;
 import com.onesignal.ShadowOneSignalRestClient;
 import com.onesignal.ShadowRoboNotificationManager;
@@ -49,15 +53,18 @@
 
 import junit.framework.Assert;
 
+import org.json.JSONObject;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.robolectric.Robolectric;
 import org.robolectric.RuntimeEnvironment;
+import org.robolectric.Shadows;
 import org.robolectric.annotation.Config;
 import org.robolectric.shadows.ShadowLog;
 import org.robolectric.shadows.ShadowSystemClock;
+import org.robolectric.util.ServiceController;
 
 import java.util.List;
 
@@ -116,7 +123,7 @@ public static Bundle getBaseNotifBundle(String id) {
    static Intent createOpenIntent(int notifId, Bundle bundle) {
       return new Intent()
             .putExtra("notificationId", notifId)
-            .putExtra("onesignal_data", NotificationBundleProcessor.bundleAsJSONObject(bundle).toString());
+            .putExtra("onesignal_data", OneSignalPackagePrivateHelper.bundleAsJSONObject(bundle).toString());
    }
 
    private Intent createOpenIntent(Bundle bundle) {
@@ -127,14 +134,14 @@ private Intent createOpenIntent(Bundle bundle) {
    public void shouldSetTitleCorrectly() throws Exception {
       // Should use app's Title by default
       Bundle bundle = getBaseNotifBundle();
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
       Assert.assertEquals("UnitTestApp", ShadowRoboNotificationManager.lastNotif.getContentTitle());
       Assert.assertEquals(1, ShadowBadgeCountUpdater.lastCount);
 
       // Should allow title from GCM payload.
       bundle = getBaseNotifBundle("UUID2");
       bundle.putString("title", "title123");
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
       Assert.assertEquals("title123", ShadowRoboNotificationManager.lastNotif.getContentTitle());
       Assert.assertEquals(2, ShadowBadgeCountUpdater.lastCount);
    }
@@ -143,7 +150,7 @@ public void shouldSetTitleCorrectly() throws Exception {
    public void shouldHandleBasicNotifications() throws Exception {
       // Make sure the notification got posted and the content is correct.
       Bundle bundle = getBaseNotifBundle();
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
       Assert.assertEquals(notifMessage, ShadowRoboNotificationManager.lastNotif.getContentText());
       Assert.assertEquals(1, ShadowBadgeCountUpdater.lastCount);
 
@@ -165,14 +172,14 @@ public void shouldHandleBasicNotifications() throws Exception {
       int firstNotifId = cursor.getInt(1);
 
       // Should not display a duplicate notification, count should still be 1
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
       cursor = readableDb.query(NotificationTable.TABLE_NAME, null, null, null, null, null, null);
       Assert.assertEquals(1, cursor.getCount());
       Assert.assertEquals(0, ShadowBadgeCountUpdater.lastCount);
 
       // Display a second notification
       bundle = getBaseNotifBundle("UUID2");
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
       cursor = readableDb.query(NotificationTable.TABLE_NAME, new String[] { "android_notification_id" }, "android_notification_id <> " + firstNotifId, null, null, null, null);
       cursor.moveToFirst();
       int secondNotifId = cursor.getInt(0);
@@ -184,28 +191,29 @@ public void shouldHandleBasicNotifications() throws Exception {
       // Should of been added for a total of 2 records now.
       // First opened should of been cleaned up, 1 week old non opened notification should stay, and one new record.
       bundle = getBaseNotifBundle("UUID3");
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
       cursor = readableDb.query(NotificationTable.TABLE_NAME, new String[] { "android_notification_id" }, null, null, null, null, null);
       Assert.assertEquals(2, cursor.getCount());
       Assert.assertEquals(2, ShadowBadgeCountUpdater.lastCount);
 
       cursor.moveToFirst();
-      boolean foundSecond = true;
+      boolean foundSecond = false;
       do {
          Assert.assertTrue(cursor.getInt(0) != firstNotifId);
          if (cursor.getInt(0) == secondNotifId)
             foundSecond = true;
       } while (cursor.moveToNext());
 
       Assert.assertTrue(foundSecond);
+      cursor.close();
    }
 
    @Test
    public void shouldGenerate2BasicGroupNotifications() throws Exception {
       // Make sure the notification got posted and the content is correct.
       Bundle bundle = getBaseNotifBundle();
       bundle.putString("grp", "test1");
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
 
       List<PostedNotification> postedNotifs = ShadowRoboNotificationManager.notifications;
       Assert.assertEquals(2, postedNotifs.size());
@@ -233,7 +241,7 @@ public void shouldGenerate2BasicGroupNotifications() throws Exception {
       bundle.putString("alert", "Notif test 2");
       bundle.putString("custom", "{\"i\": \"UUID2\"}");
       bundle.putString("grp", "test1");
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
 
       postedNotifs = ShadowRoboNotificationManager.notifications;
       Assert.assertEquals(2, postedNotifs.size());
@@ -263,10 +271,121 @@ public void shouldGenerate2BasicGroupNotifications() throws Exception {
       bundle.putString("alert", "Notif test 3");
       bundle.putString("custom", "{\"i\": \"UUID3\"}");
       bundle.putString("grp", "test1");
-      NotificationBundleProcessor.Process(blankActivity, bundle);
+      OneSignalPackagePrivateHelper.NotificationBundleProcessor_ProcessFromGCMIntentService(blankActivity, bundle, null);
 
       Assert.assertEquals("Notif test 3", postedNotifs.get(0).notif.getContentText());
       Assert.assertEquals(Notification.FLAG_GROUP_SUMMARY, postedNotifs.get(0).notif.getRealNotification().flags & Notification.FLAG_GROUP_SUMMARY);
       Assert.assertEquals(1, ShadowBadgeCountUpdater.lastCount);
+      cursor.close();
+   }
+
+   @Test
+   public void shouldFireNotificationExtenderService() throws Exception {
+      Bundle bundle = getBaseNotifBundle();
+
+      Intent serviceIntent = new Intent();
+      serviceIntent.setPackage("com.onesignal.example");
+      serviceIntent.setAction("com.onesignal.NotificationExtender");
+      ResolveInfo resolveInfo = new ResolveInfo();
+      resolveInfo.serviceInfo = new ServiceInfo();
+      resolveInfo.serviceInfo.name = "com.onesignal.example.NotificationExtenderServiceTest";
+      RuntimeEnvironment.getRobolectricPackageManager().addResolveInfoForIntent(serviceIntent, resolveInfo);
+
+      boolean ret = OneSignalPackagePrivateHelper.GcmBroadcastReceiver_processBundle(blankActivity, bundle);
+      Assert.assertEquals(true, ret);
+
+      Intent intent = Shadows.shadowOf(blankActivity).getNextStartedService();
+      Assert.assertEquals("com.onesignal.NotificationExtender", intent.getAction());
+
+      ServiceController<NotificationExtenderServiceTest> controller = Robolectric.buildService(NotificationExtenderServiceTest.class);
+      NotificationExtenderServiceTest service = controller.attach().create().get();
+      Intent testIntent = new Intent(RuntimeEnvironment.application, NotificationExtenderServiceTest.class);
+      testIntent.putExtras(getBundleWithAllOptionsSet());
+      controller.withIntent(testIntent).startCommand(0, 0);
+
+      OSNotificationPayload notification = service.notification;
+      Assert.assertEquals("Test H", notification.title);
+      Assert.assertEquals("Test B", notification.message);
+      Assert.assertEquals("9764eaeb-10ce-45b1-a66d-8f95938aaa51", notification.notificationId);
+
+      Assert.assertEquals(true, notification.backgroundData);
+      Assert.assertEquals(0, notification.visibility);
+      Assert.assertEquals("FF0000FF", notification.backgroundColor);
+      Assert.assertEquals("703322744261", notification.fromProjectNumber);
+      Assert.assertEquals("FFFFFF00", notification.ledColor);
+      Assert.assertEquals("big_picture", notification.bigPicture);
+      Assert.assertEquals("large_icon", notification.largeIcon);
+      Assert.assertEquals("small_icon", notification.smallIcon);
+      Assert.assertEquals("test_sound", notification.sound);
+      Assert.assertEquals("You test $[notif_count] MSGs!", notification.groupMessage);
+      Assert.assertEquals("http://google.com", notification.launchUrl);
+
+      Assert.assertEquals("id1", notification.actionButtons.get(0).id);
+      Assert.assertEquals("button1", notification.actionButtons.get(0).text);
+      Assert.assertEquals("ic_menu_share", notification.actionButtons.get(0).icon);
+      Assert.assertEquals("id2", notification.actionButtons.get(1).id);
+      Assert.assertEquals("button2", notification.actionButtons.get(1).text);
+      Assert.assertEquals("ic_menu_send", notification.actionButtons.get(1).icon);
+
+      JSONObject additionalData = notification.additionalData;
+      Assert.assertEquals("myValue", additionalData.getString("myKey"));
+      Assert.assertEquals("nValue", additionalData.getJSONObject("nested").getString("nKey"));
+
+      Assert.assertNotSame(-1, service.notificationId);
+   }
+
+   private static Bundle getBundleWithAllOptionsSet() {
+      Bundle bundle = new Bundle();
+
+      bundle.putString("title", "Test H");
+      bundle.putString("alert", "Test B");
+      bundle.putString("bgn", "1");
+      bundle.putString("vis", "0");
+      bundle.putString("bgac", "FF0000FF");
+      bundle.putString("from", "703322744261");
+      bundle.putString("ledc", "FFFFFF00");
+      bundle.putString("bicon", "big_picture");
+      bundle.putString("licon", "large_icon");
+      bundle.putString("sicon", "small_icon");
+      bundle.putString("sound", "test_sound");
+      bundle.putString("grp_msg", "You test $[notif_count] MSGs!");
+      bundle.putString("collapse_key", "do_not_collapse");
+
+
+      bundle.putString("custom",
+                     "{\"a\": {" +
+                     "        \"myKey\": \"myValue\"," +
+                     "        \"nested\": {\"nKey\": \"nValue\"}," +
+                     "        \"actionButtons\": [{\"id\": \"id1\", \"text\": \"button1\", \"icon\": \"ic_menu_share\"}," +
+                     "                            {\"id\": \"id2\", \"text\": \"button2\", \"icon\": \"ic_menu_send\"}" +
+                     "        ]," +
+                     "         \"actionSelected\": \"__DEFAULT__\"" +
+                     "      }," +
+                     "\"u\":\"http://google.com\"," +
+                     "\"i\":\"9764eaeb-10ce-45b1-a66d-8f95938aaa51\"" +
+                     "}");
+
+      return bundle;
+   }
+
+
+   public static class NotificationExtenderServiceTest extends NotificationExtenderService {
+      public OSNotificationPayload notification;
+      public int notificationId = -1;
+
+      // Override onStart to manually call onHandleIntent on the main thread.
+      @Override
+      public void onStart(Intent intent, int startId) {
+         onHandleIntent(intent);
+         stopSelf(startId);
+      }
+
+      @Override
+      protected boolean onNotificationProcessing(OSNotificationPayload notification) {
+         this.notification = notification;
+         notificationId = displayNotification(new OverrideSettings()).notificationId;
+
+         return true;
+      }
    }
 }