#518 Background Messages Android: fix foreground=true/false flag, removed notifications without 'from'.

Author: EddyVerbruggen

demo/app/main-view-model.ts

@@ -255,11 +255,10 @@ export class HelloWorldModel extends Observable {
         }
       },
       onMessageReceivedCallback: message => {
-        console.log("--- message received: " + message);
         setTimeout(() => {
           alert({
             title: "Push message!",
-            message: (message.title !== undefined ? message.title : ""),
+            message: (message.title !== undefined ? message.title : "") + (message.data ? " Data: " + JSON.stringify(message.data) : ""),
             okButtonText: "Sw33t"
           });
         }, 500);

demo/package.json

@@ -1,11 +1,11 @@
 {
   "nativescript": {
     "id": "org.nativescript.firebasedemo",
-    "tns-android": {
-      "version": "3.3.1"
-    },
     "tns-ios": {
       "version": "3.3.0"
+    },
+    "tns-android": {
+      "version": "3.3.1"
     }
   },
   "dependencies": {

docs/MESSAGING.md

@@ -168,6 +168,16 @@ curl -X POST --header "Authorization: key=SERVER_KEY" --Header "Content-Type: ap
 * SERVER_KEY: see below
 * DEVICE_TOKEN: the one you got in `addOnPushTokenReceivedCallback` or `init`'s `onPushTokenReceivedCallback`
 
+Examples:
+
+```
+// noti + data
+curl -X POST --header "Authorization: key=AAAA9SHtZvM:APA91bGoY0H2nS8GlzzypDXSiUkNY3nrti4st4WOUs_w1A0Rttcx31U90YGv-p3U4Oql-vh-FzZzWUUPEwl47uvwhI4tB5yz4wwzrJA2fVqLEKZpDU42AQppYnU2-dsURqkyc9sKcjay2egWbfyNK2b-G2JQCqrLVA" --Header "Content-Type: application/json" https://fcm.googleapis.com/fcm/send -d "{\"notification\":{\"title\": \"My title\", \"text\": \"My text\", \"badge\": \"1\", \"sound\": \"default\"}, \"data\":{\"foo\":\"bar\"}, \"priority\": \"High\", \"to\": \"fmt3SiVgJH4:APA91bFNvamGmOr_ELaa2oFPunF7PzVfjINe3Hdu5UyqJpfdisCXZUFLyVwISqu7j5Ff9yGh3iPrMHHg3rEXwMRpQE9oCG85YV5pQ1pGjIjpAOAJCU31RKIqGLC5bIrTHxk1Dz--cmGE\"}"
+
+// data only
+curl -X POST --header "Authorization: key=AAAA9SHtZvM:APA91bGoY0H2nS8GlzzypDXSiUkNY3nrti4st4WOUs_w1A0Rttcx31U90YGv-p3U4Oql-vh-FzZzWUUPEwl47uvwhI4tB5yz4wwzrJA2fVqLEKZpDU42AQppYnU2-dsURqkyc9sKcjay2egWbfyNK2b-G2JQCqrLVA" --Header "Content-Type: application/json" https://fcm.googleapis.com/fcm/send -d "{\"data\":{\"foo\":\"bar\"}, \"priority\": \"High\", \"to\": \"fmt3SiVgJH4:APA91bFNvamGmOr_ELaa2oFPunF7PzVfjINe3Hdu5UyqJpfdisCXZUFLyVwISqu7j5Ff9yGh3iPrMHHg3rEXwMRpQE9oCG85YV5pQ1pGjIjpAOAJCU31RKIqGLC5bIrTHxk1Dz--cmGE\"}"
+```
+
 If you don't want a badge on the app icon, remove the `badge` property or set it to 0. Note that launching the app clears the badge anyway.
 
 <img src="images/push-server-key.png" width="459px" height="220px" alt="Push server key"/>

src/firebase.android.ts

@@ -25,13 +25,17 @@ const messagingEnabled = lazy(() => typeof(com.google.firebase.messaging) !== "u
 const dynamicLinksEnabled = lazy(() => typeof(com.google.android.gms.appinvite) !== "undefined");
 
 (() => {
-  appModule.on("launch", args => {
+  // note that this means we need to require the plugin before the app is loaded
+  appModule.on(appModule.launchEvent, args => {
+    org.nativescript.plugins.firebase.FirebasePluginLifecycleCallbacks.registerCallbacks(appModule.android.nativeApp);
+
     const intent = args.android;
     const isLaunchIntent = "android.intent.action.VIEW" === intent.getAction();
 
     if (!isLaunchIntent && messagingEnabled()) {
       const extras = intent.getExtras();
-      if (extras !== null) {
+      // filter out any rubbish that doesn't have a 'from' key
+      if (extras !== null && extras.keySet().contains("from")) {
         let result = {
           foreground: false,
           data: {}

src/platforms/android/firebase-release.aar

@@ -0,0 +1,65 @@
+package org.nativescript.plugins.firebase;
+
+import android.app.Activity;
+import android.app.Application;
+import android.os.Bundle;
+import android.util.Log;
+
+/**
+ * Subscribe to the Pause and Resume activity events in order to toggle the PushPlugin's status.
+ * When the Plugin is not in active state - i.e. at foreground, notifications should be created
+ * and published in the Notification Center, otherwise they're passed directly to the application
+ * by invoking the onMessageReceived callback.
+ */
+public class FirebasePluginLifecycleCallbacks implements Application.ActivityLifecycleCallbacks {
+  static final String TAG = "FirebasePluginCB";
+
+  private static FirebasePluginLifecycleCallbacks callbacks = new FirebasePluginLifecycleCallbacks();
+
+  /**
+   * Register for the application's events
+   * @param app
+   */
+  public static void registerCallbacks(Application app) {
+    if (app == null) {
+      Log.d(TAG, "The application is null, it's not passed correctly!");
+      throw new RuntimeException("The application is null, it's not passed correctly!");
+    }
+
+    // clean up, not to leak and register it N times...
+    Log.d(TAG, "Unregistering the activity lifecycle callbacks...");
+    app.unregisterActivityLifecycleCallbacks(callbacks);
+
+    Log.d(TAG, "Registering the activity lifecycle callbacks...");
+    app.registerActivityLifecycleCallbacks(callbacks);
+  }
+
+  public void onActivityPaused(Activity activity) {
+    Log.d(MyFirebaseMessagingService.TAG, "onActivityPaused: Application has been stopped.");
+
+    // the application is being stopped -> the push plugin is not in active/foreground state anymore
+    MyFirebaseMessagingService.isActive = false;
+  }
+
+  public void onActivityResumed(Activity activity) {
+    Log.d(MyFirebaseMessagingService.TAG, "onActivityResumed: Application has been started");
+
+    // the application has been resumed-> the push plugin is now in active/foreground state
+    MyFirebaseMessagingService.isActive = true;
+  }
+
+  public void onActivityCreated(Activity activity, Bundle bundle) {
+  }
+
+  public void onActivityDestroyed(Activity activity) {
+  }
+
+  public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
+  }
+
+  public void onActivityStarted(Activity activity) {
+  }
+
+  public void onActivityStopped(Activity activity) {
+  }
+}

src/platforms/android/libraryproject/firebase/src/main/java/org/nativescript/plugins/firebase/FirebasePluginLifecycleCallbacks.java

@@ -12,12 +12,15 @@
  * This class takes care of notifications received while the app is in the foreground.
  */
 public class MyFirebaseMessagingService extends FirebaseMessagingService {
+  static final String TAG = "FirebasePlugin";
+
+  static boolean isActive = false;
 
   @Override
   public void onMessageReceived(RemoteMessage remoteMessage) {
     try {
       final JSONObject json = new JSONObject()
-        .put("foreground", true)
+        .put("foreground", isActive)
         .put("from", remoteMessage.getFrom());
 
       final RemoteMessage.Notification not = remoteMessage.getNotification();