Merge pull request #1289 from OneSignal/fix/not-restore-disbale-channel-notifications

Fix notification disabled by channel being restored

Author: emawby

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

@@ -95,12 +95,12 @@ private static void setStatics(Context inContext) {
    }
 
    @WorkerThread
-   static void fromJsonPayload(OSNotificationGenerationJob notificationJob) {
+   static boolean displayNotificationFromJsonPayload(OSNotificationGenerationJob notificationJob) {
       setStatics(notificationJob.getContext());
 
       isRunningOnMainThreadCheck();
 
-      showNotification(notificationJob);
+      return showNotification(notificationJob);
    }
 
    /**
@@ -263,7 +263,7 @@ private static void removeNotifyOptions(NotificationCompat.Builder builder) {
    }
 
    // Put the message into a notification and post it.
-   private static void showNotification(OSNotificationGenerationJob notificationJob) {
+   private static boolean showNotification(OSNotificationGenerationJob notificationJob) {
       int notificationId = notificationJob.getAndroidId();
       JSONObject fcmJson = notificationJob.getJsonPayload();
       String group = fcmJson.optString("grp", null);
@@ -326,6 +326,10 @@ private static void showNotification(OSNotificationGenerationJob notificationJob
          addXiaomiSettings(oneSignalNotificationBuilder, notification);
          NotificationManagerCompat.from(currentContext).notify(notificationId, notification);
       }
+
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O)
+         return OneSignalNotificationManager.areNotificationsEnabled(currentContext, notification.getChannelId());
+      return true;
    }
 
    private static Notification createGenericPendingIntentsForNotif(NotificationCompat.Builder notifBuilder, JSONObject gcmBundle, int notificationId) {

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

@@ -133,6 +133,8 @@ static int processJobForDisplay(OSNotificationController notificationController,
 
         int androidNotificationId = notificationJob.getAndroidIdWithoutCreate();
         boolean doDisplay = shouldDisplayNotif(notificationJob);
+        boolean notificationDisplayed = false;
+
         if (doDisplay) {
             androidNotificationId = notificationJob.getAndroidId();
             if (fromBackgroundLogic && OneSignal.shouldFireForegroundHandlers()) {
@@ -141,12 +143,13 @@ static int processJobForDisplay(OSNotificationController notificationController,
                 // Notification will be processed by foreground user complete or timer complete
                 return androidNotificationId;
             } else {
-                GenerateNotification.fromJsonPayload(notificationJob);
+                // Notification might end not displaying because the channel for that notification has notification disable
+                notificationDisplayed = GenerateNotification.displayNotificationFromJsonPayload(notificationJob);
             }
         }
 
         if (!notificationJob.isRestoring() && !notificationJob.isIamPreview()) {
-            processNotification(notificationJob, opened);
+            processNotification(notificationJob, opened, notificationDisplayed);
 
             // No need to keep notification duplicate check on memory, we have database check at this point
             // Without removing duplicate, summary restoration might not happen
@@ -171,15 +174,20 @@ private static boolean shouldDisplayNotif(OSNotificationGenerationJob notificati
     /**
      * Save notification, updates Outcomes, and sends Received Receipt if they are enabled.
      */
-    static void processNotification(OSNotificationGenerationJob notificationJob, boolean opened) {
+    static void processNotification(OSNotificationGenerationJob notificationJob, boolean opened, boolean notificationDisplayed) {
         saveNotification(notificationJob, opened);
 
-        if (!notificationJob.isNotificationToDisplay())
+        if (!notificationDisplayed) {
+            // Notification channel disable or not displayed
+            // save notification as dismissed to avoid user re-enabling channel and notification being displayed due to restore
+            markNotificationAsDismissed(notificationJob);
             return;
+        }
 
+        // Logic for when the notification is displayed
         String notificationId = notificationJob.getApiNotificationId();
-        OneSignal.getSessionManager().onNotificationReceived(notificationId);
         OSReceiveReceiptController.getInstance().sendReceiveReceipt(notificationId);
+        OneSignal.getSessionManager().onNotificationReceived(notificationId);
     }
 
    // Saving the notification provides the following:
@@ -244,11 +252,11 @@ private static void saveNotification(OSNotificationGenerationJob notificationJob
       }
    }
 
-    static void markRestoredNotificationAsDismissed(OSNotificationGenerationJob notifiJob) {
-        OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "Marking restored notifications as dismissed: " + notifiJob.toString());
+    static void markNotificationAsDismissed(OSNotificationGenerationJob notifiJob) {
         if (notifiJob.getAndroidIdWithoutCreate() == -1)
             return;
 
+        OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "Marking restored or disabled notifications as dismissed: " + notifiJob.toString());
         String whereStr = NotificationTable.COLUMN_NAME_ANDROID_NOTIFICATION_ID + " = " + notifiJob.getAndroidIdWithoutCreate();
 
         OneSignalDbHelper dbHelper = OneSignalDbHelper.getInstance(notifiJob.getContext());

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

@@ -105,11 +105,11 @@ private void notDisplayNotificationLogic(OSNotification originalNotification) {
       if (restoring) {
          // If we are not displaying a restored notification make sure we mark it as dismissed
          // This will prevent it from being restored again
-         NotificationBundleProcessor.markRestoredNotificationAsDismissed(notificationJob);
+         NotificationBundleProcessor.markNotificationAsDismissed(notificationJob);
       } else {
          // -1 is used to note never displayed
          notificationJob.getNotification().setAndroidNotificationId(-1);
-         NotificationBundleProcessor.processNotification(notificationJob, true);
+         NotificationBundleProcessor.processNotification(notificationJob, true, false);
          OneSignal.handleNotificationReceived(notificationJob);
       }
    }

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

@@ -2,7 +2,6 @@
 
 import android.content.Context;
 import android.database.Cursor;
-import android.database.sqlite.SQLiteDatabase;
 import android.os.Build;
 import android.service.notification.StatusBarNotification;
 import android.text.TextUtils;

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

@@ -1,17 +1,22 @@
 package com.onesignal;
 
 import android.app.Notification;
+import android.app.NotificationChannel;
 import android.app.NotificationManager;
 import android.content.Context;
 import android.database.Cursor;
 import android.os.Build;
 import android.service.notification.StatusBarNotification;
+
+import androidx.annotation.Nullable;
 import androidx.annotation.RequiresApi;
 import androidx.core.app.NotificationCompat;
 import androidx.core.app.NotificationManagerCompat;
 
 import java.util.ArrayList;
 
+import static android.app.NotificationManager.IMPORTANCE_NONE;
+
 public class OneSignalNotificationManager {
 
     private static final String GROUPLESS_SUMMARY_KEY = "os_group_undefined";
@@ -157,4 +162,18 @@ static Integer getMostRecentNotifIdFromGroup(OneSignalDbHelper db, String group,
 
         return recentId;
     }
+
+    @Nullable
+    public static boolean areNotificationsEnabled(Context context, String channelId) {
+        boolean notificationsEnabled = NotificationManagerCompat.from(context).areNotificationsEnabled();
+        if (!notificationsEnabled)
+            return false;
+
+        if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
+            NotificationChannel channel = getNotificationManager(context).getNotificationChannel(channelId);
+            return channel == null || channel.getImportance() != IMPORTANCE_NONE;
+        }
+
+        return true;
+    }
 }

OneSignalSDK/unittest/src/test/java/com/onesignal/ShadowOneSignalNotificationManager.java

@@ -0,0 +1,28 @@
+package com.onesignal;
+
+import android.content.Context;
+
+import org.robolectric.annotation.Implementation;
+import org.robolectric.annotation.Implements;
+
+@Implements(OneSignalNotificationManager.class)
+public class ShadowOneSignalNotificationManager {
+
+   private static boolean notificationChannelEnabled = true;
+
+   public static void setNotificationChannelEnabled(boolean notificationChannelEnabled) {
+      ShadowOneSignalNotificationManager.notificationChannelEnabled = notificationChannelEnabled;
+   }
+
+   @Implementation
+   public static boolean areNotificationsEnabled(Context context, String channelId) {
+      return notificationChannelEnabled;
+   }
+
+   /**
+    * Reset all static values (should be called before each test)
+    */
+   public static void resetStatics() {
+      notificationChannelEnabled = true;
+   }
+}

OneSignalSDK/unittest/src/test/java/com/onesignal/ShadowOneSignalRestClient.java

@@ -48,6 +48,9 @@ public class ShadowOneSignalRestClient {
    public static final String PUSH_USER_ID = "a2f7f967-e8cc-11e4-bed1-118f05be4511";
    public static final String EMAIL_USER_ID = "b007f967-98cc-11e4-bed1-118f05be4522";
    public static final String SMS_USER_ID = "d007f967-98cc-11e4-bed1-118f05be4522";
+   private static final String REQUIRES_USER_PRIVACY_CONSENT = "requires_user_privacy_consent";
+   private static final String RECEIVE_RECEIPTS_ENABLE = "receive_receipts_enable";
+
    public enum REST_METHOD {
       GET, POST, PUT
    }
@@ -205,7 +208,12 @@ public static void setSuccessfulGETJSONResponses(JSONObject... responses) throws
    }
 
    public static void setRemoteParamsRequirePrivacyConsent(boolean requirePrivacyConsent) throws JSONException {
-      JSONObject remoteParams = new JSONObject().put("requires_user_privacy_consent", requirePrivacyConsent);
+      JSONObject remoteParams = new JSONObject().put(REQUIRES_USER_PRIVACY_CONSENT, requirePrivacyConsent);
+      ShadowOneSignalRestClient.setRemoteParamsGetHtmlResponse(remoteParams);
+   }
+
+   public static void setRemoteParamsReceiveReceiptsEnable(boolean requirePrivacyConsent) throws JSONException {
+      JSONObject remoteParams = new JSONObject().put(RECEIVE_RECEIPTS_ENABLE, requirePrivacyConsent);
       ShadowOneSignalRestClient.setRemoteParamsGetHtmlResponse(remoteParams);
    }
 

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

@@ -81,6 +81,7 @@
 import com.onesignal.ShadowNotificationManagerCompat;
 import com.onesignal.ShadowOSUtils;
 import com.onesignal.ShadowOneSignal;
+import com.onesignal.ShadowOneSignalNotificationManager;
 import com.onesignal.ShadowOneSignalRestClient;
 import com.onesignal.ShadowPushRegistratorADM;
 import com.onesignal.ShadowPushRegistratorFCM;
@@ -222,6 +223,7 @@ private static void getGetTagsHandler() {
    private static OSSMSSubscriptionStateChanges lastSMSSubscriptionStateChanges;
 
    private static void cleanUp() throws Exception {
+      lastServiceNotificationReceivedEvent = null;
       lastNotificationOpenedBody = null;
       lastGetTags = null;
       lastEmailSubscriptionStateChanges = null;
@@ -1227,6 +1229,154 @@ public void testNotificationReceivedWhenAppInFocus() throws Exception {
       assertEquals("Robo test message", notificationReceivedBody);
    }
 
+   // Start Received Request tests (report_received)
+
+   @Test
+   @Config(shadows = { ShadowGenerateNotification.class })
+   public void testNotificationReceivedSendReceivedRequest_WhenAppInBackground() throws Exception {
+      // First init run for appId to be saved
+      // At least OneSignal was init once for user to be subscribed
+      // If this doesn't' happen, notifications will not arrive
+      OneSignal.setAppId(ONESIGNAL_APP_ID);
+      OneSignal.initWithContext(blankActivity);
+      threadAndTaskWait();
+      fastColdRestartApp();
+
+      ShadowOneSignalRestClient.setRemoteParamsReceiveReceiptsEnable(true);
+      // 1. initWithContext is called when startProcessing notification
+      OneSignal.initWithContext(blankActivity.getApplicationContext());
+      // 2. Receive a notification in background
+      FCMBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
+      threadAndTaskWait();
+
+      // 3. Check that report_received where sent
+      assertEquals(4, ShadowOneSignalRestClient.requests.size());
+      assertEquals("notifications/UUID/report_received", ShadowOneSignalRestClient.lastUrl);
+   }
+
+   @Test
+   @Config(shadows = { ShadowGenerateNotification.class })
+   public void testNotificationReceivedSendReceivedRequest_WhenAppInForeground() throws Exception {
+      ShadowOneSignalRestClient.setRemoteParamsReceiveReceiptsEnable(true);
+      // First init run for appId to be saved
+      // At least OneSignal was init once for user to be subscribed
+      // If this doesn't' happen, notifications will not arrive
+      OneSignal.setAppId(ONESIGNAL_APP_ID);
+      OneSignal.initWithContext(blankActivity);
+      threadAndTaskWait();
+
+      // 1. Receive a notification in background
+      FCMBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
+      threadAndTaskWait();
+
+      // 2. Check that report_received where sent
+      assertEquals(3, ShadowOneSignalRestClient.requests.size());
+      assertEquals("notifications/UUID/report_received", ShadowOneSignalRestClient.lastUrl);
+   }
+
+   @Test
+   @Config(shadows = { ShadowGenerateNotification.class })
+   public void testNotificationReceivedNoSendReceivedRequest_WhenDisabled() throws Exception {
+      ShadowOneSignalRestClient.setRemoteParamsReceiveReceiptsEnable(false);
+      // First init run for appId to be saved
+      // At least OneSignal was init once for user to be subscribed
+      // If this doesn't' happen, notifications will not arrive
+      OneSignal.setAppId(ONESIGNAL_APP_ID);
+      OneSignal.initWithContext(blankActivity);
+      threadAndTaskWait();
+
+      // 1. Receive a notification in background
+      FCMBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
+      threadAndTaskWait();
+
+      // 2. Check that report_received where sent
+      assertEquals(2, ShadowOneSignalRestClient.requests.size());
+      assertNotEquals("notifications/UUID/report_received", ShadowOneSignalRestClient.lastUrl);
+   }
+
+   @Test
+   @Config(shadows = { ShadowGenerateNotification.class })
+   public void testNotificationReceivedNoSendReceivedRequest_WhenNotificationNotDisplayed() throws Exception {
+      // 1. Setup correct notification extension service class
+      startRemoteNotificationReceivedHandlerService("com.test.onesignal.MainOneSignalClassRunner$" +
+              "RemoteNotificationReceivedHandler_NoDisplay");
+
+      ShadowOneSignalRestClient.setRemoteParamsReceiveReceiptsEnable(true);
+      // First init run for appId to be saved
+      // At least OneSignal was init once for user to be subscribed
+      // If this doesn't' happen, notifications will not arrive
+      OneSignal.setAppId(ONESIGNAL_APP_ID);
+      OneSignal.initWithContext(blankActivity);
+      threadAndTaskWait();
+
+      // 2. Receive a notification in background
+      FCMBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
+      threadAndTaskWait();
+
+      // 3. Make sure service was called
+      assertNotNull(lastServiceNotificationReceivedEvent);
+
+      // 4. Check that report_received where sent
+      assertEquals(2, ShadowOneSignalRestClient.requests.size());
+      assertNotEquals("notifications/UUID/report_received", ShadowOneSignalRestClient.lastUrl);
+   }
+
+   @Test
+   @Config(sdk = 26, shadows = { ShadowGenerateNotification.class, ShadowOneSignalNotificationManager.class })
+   public void testNotificationReceivedNoSendReceivedRequest_WhenNotificationNotDisplayed_DisabledByChannel() throws Exception {
+      // 1. Setup correct notification extension service class
+      startRemoteNotificationReceivedHandlerService("com.test.onesignal.MainOneSignalClassRunner$" +
+              "RemoteNotificationReceivedHandler");
+
+      ShadowOneSignalRestClient.setRemoteParamsReceiveReceiptsEnable(true);
+      ShadowOneSignalNotificationManager.setNotificationChannelEnabled(false);
+      // First init run for appId to be saved
+      // At least OneSignal was init once for user to be subscribed
+      // If this doesn't' happen, notifications will not arrive
+      OneSignal.setAppId(ONESIGNAL_APP_ID);
+      OneSignal.initWithContext(blankActivity);
+      threadAndTaskWait();
+
+      // 2. Receive a notification in background
+      FCMBroadcastReceiver_processBundle(blankActivity, getBaseNotifBundle());
+      threadAndTaskWait();
+
+      // 3. Make sure service was called
+      assertNotNull(lastServiceNotificationReceivedEvent);
+
+      // 4. Check that report_received where sent
+      assertEquals(2, ShadowOneSignalRestClient.requests.size());
+      assertNotEquals("notifications/UUID/report_received", ShadowOneSignalRestClient.lastUrl);
+   }
+
+   /**
+    * @see #testNotificationReceivedNoSendReceivedRequest_WhenNotificationNotDisplayed
+    */
+   public static class RemoteNotificationReceivedHandler_NoDisplay implements OneSignal.OSRemoteNotificationReceivedHandler {
+
+      @Override
+      public void remoteNotificationReceived(Context context, OSNotificationReceivedEvent receivedEvent) {
+         lastServiceNotificationReceivedEvent = receivedEvent;
+
+         receivedEvent.complete(null);
+      }
+   }
+
+   /**
+    * @see #testNotificationReceivedNoSendReceivedRequest_WhenNotificationNotDisplayed_DisabledByChannel
+    */
+   public static class RemoteNotificationReceivedHandler implements OneSignal.OSRemoteNotificationReceivedHandler {
+
+      @Override
+      public void remoteNotificationReceived(Context context, OSNotificationReceivedEvent receivedEvent) {
+         lastServiceNotificationReceivedEvent = receivedEvent;
+
+         receivedEvent.complete(receivedEvent.getNotification());
+      }
+   }
+
+   // End Received Request tests (report_received)
+
    @Test
    @Config(shadows = {ShadowBadgeCountUpdater.class})
    public void testBadgeClearOnFirstStart() throws Exception {