whitelist performance update

- better null whitelist handling
- some debug logs
- updated readme

Author: Random90

README.md

@@ -7,6 +7,10 @@ It is a replacement of [https://github.com/Alone2/capacitor-notificationlistener
 This plugin works on Android 14 and adds few additional features like persistent notifications caching.
 Tested on Capacitor v6.
 
+**Note: Plugin is in active development, bugs are to be expected, especially in background processing service.** 
+
+Background service autostart is TODO, right now it only works on reboot if you start your app manually. Caching works when main app is killed, but for now there is no prevention from android killing the service. Not happened to me during testing though. 
+
 ## Install
 
 ```bash
@@ -224,14 +228,15 @@ removeAllListeners() => Promise<void>
 ### replacePackagesWhitelist(...)
 
 ```typescript
-replacePackagesWhitelist(options: { packagesWhitelist: string[]; }) => Promise<void>
+replacePackagesWhitelist(options: { packagesWhitelist: string[] | null; }) => Promise<void>
 ```
 
 Replace the current white list of packages with new one.
+send null to disable whitelist.
 
-| Param         | Type                                          |
-| ------------- | --------------------------------------------- |
-| **`options`** | <code>{ packagesWhitelist: string[]; }</code> |
+| Param         | Type                                                  |
+| ------------- | ----------------------------------------------------- |
+| **`options`** | <code>{ packagesWhitelist: string[] \| null; }</code> |
 
 --------------------
 
@@ -260,9 +265,9 @@ Replace the current white list of packages with new one.
 
 #### ListenerOptions
 
-| Prop                     | Type                  |
-| ------------------------ | --------------------- |
-| **`cacheNotifications`** | <code>boolean</code>  |
-| **`packagesWhitelist`**  | <code>string[]</code> |
+| Prop                     | Type                          |
+| ------------------------ | ----------------------------- |
+| **`cacheNotifications`** | <code>boolean</code>          |
+| **`packagesWhitelist`**  | <code>string[] \| null</code> |
 
 </docgen-api>

android/src/main/java/com/capacitor/notifications/listener/NotificationService.java

@@ -6,6 +6,9 @@
 import android.service.notification.StatusBarNotification;
 import android.util.Log;
 
+import java.util.ArrayList;
+import java.util.Objects;
+
 public class NotificationService extends NotificationListenerService {
     public static final String ACTION_RECEIVE      = "com.capacitor.notifications.listener.NOTIFICATION_RECEIVE_EVENT";
     public static final String ACTION_REMOVE      = "com.capacitor.notifications.listener.NOTIFICATION_REMOVE_EVENT";
@@ -21,6 +24,8 @@ public class NotificationService extends NotificationListenerService {
     // TODO hold the 'old' app context?
     public static NotificationsListenerPlugin.NotificationReceiver notificationReceiver;
     public static boolean isConnected = false;
+    // TODO: persist whitelist for autostart
+    public static ArrayList<String> packagesWhitelist = null;
 
     private static final String TAG = NotificationService.class.getSimpleName();
 
@@ -33,14 +38,18 @@ public void onDestroy() {
 
     @Override
     public void onNotificationPosted(StatusBarNotification sbn) {
-        Intent i = notificationToIntent(sbn, ACTION_RECEIVE);
-        sendBroadcast(i);
+        if (packagesWhitelist == null || existsInWhitelist(sbn)) {
+            Intent i = notificationToIntent(sbn, ACTION_RECEIVE);
+            sendBroadcast(i);
+        }
     }
 
     @Override
     public void onNotificationRemoved(StatusBarNotification sbn) {
-        Intent i = notificationToIntent(sbn, ACTION_REMOVE);
-        sendBroadcast(i);
+        if (packagesWhitelist == null || existsInWhitelist(sbn)) {
+            Intent i = notificationToIntent(sbn, ACTION_REMOVE);
+            sendBroadcast(i);
+        }
     }
 
     @Override
@@ -74,6 +83,9 @@ private Intent notificationToIntent(StatusBarNotification sbn, String action) {
 
         i.putExtra(ARG_TIME, n.when);
 
+        if (Objects.equals(action, ACTION_RECEIVE)) {
+            Log.d(TAG, "Received notification: " + text);
+        }
         return i;
     }
 
@@ -85,11 +97,19 @@ private String[] charSequenceArrayToStringArray(CharSequence[] c) {
         if (c == null) return new String[0];
         String[] out = new String[c.length];
         for (int i = 0; i < c.length; i++) {
-            Log.d(TAG, String.valueOf(c[i]));
             out[i] = charSequenceToString(c[i]);
         }
         return out;
     }
+
+    private boolean existsInWhitelist(StatusBarNotification notification) {
+        String packageName = notification.getPackageName();
+        boolean exists = packagesWhitelist.contains(packageName);
+        if (!exists) {
+            Log.d(TAG, "Package not in whitelist: " + packageName);
+        }
+        return exists;
+    }
 }
 
 

android/src/main/java/com/capacitor/notifications/listener/NotificationsListenerPlugin.java

@@ -49,19 +49,19 @@ protected void handleOnDestroy() {
         Log.d(TAG, "Destroyed");
     }
 
+    // TODO: test if reinstalling the app will properly register new listener
     @SuppressLint("UnspecifiedRegisterReceiverFlag")
     @PluginMethod
     public void startListening(PluginCall call) {
         Boolean cacheEnabledValue = call.getBoolean("cacheNotifications");
-        // TODO: persist whitelist for autostart
         ArrayList<String> packagesWhitelist = arrayFromPluginCall(call);
         if (packagesWhitelist != null) {
             Log.d(TAG, "Listening to packages: " + packagesWhitelist.toString());
         }
 
         cacheEnabled = (cacheEnabledValue != null) ? cacheEnabledValue : false;
         if (NotificationService.notificationReceiver != null) {
-            Log.d(TAG, "NotificationReceiver already exists");
+            Log.d(TAG, "NotificationReceiver already exists, unregistering");
             NotificationService.notificationReceiver.unregister(getContext());
         }
         NotificationService.notificationReceiver = new NotificationReceiver(cacheEnabled, webViewActive, packagesWhitelist);
@@ -174,14 +174,13 @@ public class NotificationReceiver extends BroadcastReceiver {
         public boolean isRegistered;
         private boolean cacheEnabled;
         private boolean webViewActive;
-        private ArrayList<String> packagesWhitelist;
 
         private NotificationReceiver(boolean cacheEnabled, boolean webViewActive, ArrayList<String> packagesWhitelist) {
             Log.d(TAG, "NotificationReceiver created");
             this.isRegistered = false;
             this.cacheEnabled = cacheEnabled;
             this.webViewActive = webViewActive;
-            this.packagesWhitelist = packagesWhitelist;
+            NotificationService.packagesWhitelist = packagesWhitelist;
         }
 
         /**
@@ -236,7 +235,7 @@ public void setWebViewActive(boolean webViewActive) {
         }
 
         public void setPackagesWhitelist(ArrayList<String> packagesWhitelist) {
-            this.packagesWhitelist = packagesWhitelist;
+            NotificationService.packagesWhitelist = packagesWhitelist;
         }
 
         @Override
@@ -245,19 +244,17 @@ public void onReceive(Context context, Intent intent) {
                 Log.w(TAG, "Unregistered receiver is still registered in Android. Hope it kills it");
                 return;
             }
-            if (packagesWhitelist != null && !existsInWhitelist(intent)) {
-                return;
-            }
             JSObject jo = parseNotification(intent);
             switch (Objects.requireNonNull(intent.getAction())) {
                 case NotificationService.ACTION_RECEIVE:
                     // log original intent
-                    Log.d(TAG, "Received notification: " + jo.toString());
                     if (cacheEnabled && !webViewActive) {
                         Log.d(TAG, "Caching notification");
                         persistentStorage.append(STORAGE_KEY, jo);
                         Log.d(TAG, "New cache size: " + persistentStorage.size(STORAGE_KEY));
                         return;
+                    } else if (!cacheEnabled && !webViewActive) {
+                        Log.d(TAG, "Cache disabled, not caching notification in bg");
                     }
                     notifyListeners(EVENT_NOTIFICATION_RECEIVED, jo);
                     break;
@@ -285,10 +282,5 @@ private JSObject parseNotification(Intent intent) {
             }
             return jo;
         }
-
-        private boolean existsInWhitelist(Intent intent) {
-            String packageName = intent.getStringExtra(NotificationService.ARG_PACKAGE);
-            return packagesWhitelist.contains(packageName);
-        }
     }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-notifications-listener",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Plugin for reading all android notifications in capacitor.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",

src/definitions.ts

@@ -27,16 +27,17 @@ export interface NotificationsListenerPlugin {
   removeAllListeners(): Promise<void>;
   /**
    * Replace the current white list of packages with new one.
+   * send null to disable whitelist.
    */
   replacePackagesWhitelist(options: {
-    packagesWhitelist: string[];
+    packagesWhitelist: string[] | null;
   }): Promise<void>;
 }
 
 export interface ListenerOptions {
   cacheNotifications?: boolean;
-  // listen to notifications from specific packages. Improves performance.
-  packagesWhitelist?: string[];
+  // listen to notifications from specific packages. Improves performance
+  packagesWhitelist?: string[] | null;
 }
 
 export interface AndroidNotification {