Add Receive Receipt delay.

* Add random delay from 0 to 25 seconds
* Add OSDelayTaskController for future delays
* Add MockDelayTaskController for test approaches
* Refactor Notification Work Manager to extends ListenableWorker. This adds future completion. Complete future after sending receive receipts
* Refactor Restoration Work Manager to not init another work manager, since Notification Work Manager nows expects a future when Restoration work is done, it will finish notification work manager that will end on a FutureGarbageCollectedException, avoid this exception by running everything on the same work thread

Author: Jeasmine

OneSignalSDK/build.gradle

@@ -8,6 +8,7 @@ buildscript {
                 targetSdkVersion: 28
         ]
         androidGradlePluginVersion = '3.6.2'
+        androidConcurrentFutures = '1.1.0'
         googleServicesGradlePluginVersion = '4.3.2'
         huaweiAgconnectVersion = '1.2.1.301'
         huaweiHMSPushVersion = '4.0.2.300'

OneSignalSDK/onesignal/build.gradle

@@ -49,6 +49,8 @@ dependencies {
     // Required for GoogleApiAvailability
     implementation 'com.google.android.gms:play-services-base:[17.0.0, 17.6.99]'
 
+    implementation("androidx.concurrent:concurrent-futures:$androidConcurrentFutures")
+
     // firebase-messaging:18.0.0 is the last version before going to AndroidX
     // firebase-messaging:19.0.0 is the first version using AndroidX
     api 'com.google.firebase:firebase-messaging:[19.0.0, 22.0.99]'

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

@@ -36,6 +36,8 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.WorkerThread;
+import androidx.concurrent.futures.CallbackToFutureAdapter;
+import androidx.work.ListenableWorker;
 
 import com.onesignal.OneSignalDbContract.NotificationTable;
 
@@ -97,9 +99,10 @@ public void onResult(boolean result) {
                             osNotificationId,
                             finalAndroidNotificationId,
                             jsonStrPayload,
-                            isRestoring,
                             shownTimeStamp,
-                            false);
+                            isRestoring,
+                            false,
+                            true);
 
                     // Delay to prevent CPU spikes.
                     // Normally more than one notification is restored at a time.
@@ -131,7 +134,7 @@ static int processJobForDisplay(OSNotificationController notificationController,
     }
 
     @WorkerThread
-    static int processJobForDisplay(OSNotificationController notificationController, boolean opened, boolean fromBackgroundLogic) {
+    private static int processJobForDisplay(OSNotificationController notificationController, boolean opened, boolean fromBackgroundLogic) {
         OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "Starting processJobForDisplay opened: " + opened + " fromBackgroundLogic: " + fromBackgroundLogic);
         OSNotificationGenerationJob notificationJob = notificationController.getNotificationJob();
 
@@ -176,17 +179,22 @@ private static boolean shouldDisplayNotification(OSNotificationGenerationJob not
      */
     static void processNotification(OSNotificationGenerationJob notificationJob, boolean opened, boolean notificationDisplayed) {
         saveNotification(notificationJob, opened);
+        CallbackToFutureAdapter.Completer<ListenableWorker.Result>  callbackCompleter = notificationJob.getCallbackCompleter();
 
         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);
+
+            OneSignal.Log(OneSignal.LOG_LEVEL.DEBUG, "Process notification not displayed with callback completer: " + callbackCompleter);
+            if (callbackCompleter != null)
+                callbackCompleter.set(ListenableWorker.Result.success());
             return;
         }
 
         // Logic for when the notification is displayed
         String notificationId = notificationJob.getApiNotificationId();
-        OSReceiveReceiptController.getInstance().sendReceiveReceipt(notificationId);
+        OSReceiveReceiptController.getInstance().sendReceiveReceipt(callbackCompleter, notificationId);
         OneSignal.getSessionManager().onNotificationReceived(notificationId);
     }
 
@@ -425,9 +433,10 @@ public void onResult(boolean result) {
                         osNotificationId,
                         androidNotificationId,
                         jsonPayload.toString(),
-                        isRestoring,
                         timestamp,
-                        isHighPriority);
+                        isRestoring,
+                        isHighPriority,
+                        true);
 
                 bundleResult.setWorkManagerProcessing(true);
                 notificationProcessingCallback.onResult(true);

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

@@ -143,7 +143,7 @@ private static void restoreSummary(Context context, String group) {
              null
          );
 
-         OSNotificationRestoreWorkManager.showNotificationsFromCursor(context, cursor, 0);
+         OSNotificationRestoreWorkManager.showNotificationsFromCursor(context, cursor, 0, true);
       } catch (Throwable t) {
          OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Error restoring notification records! ", t);
       } finally {

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSDelayTaskController.kt

@@ -0,0 +1,40 @@
+package com.onesignal
+
+import java.util.concurrent.ScheduledThreadPoolExecutor
+import java.util.concurrent.ThreadFactory
+import java.util.concurrent.TimeUnit
+import kotlin.math.roundToInt
+
+open class OSDelayTaskController(private val logger: OSLogger) {
+    private val maxDelay = 25
+    private val minDelay = 0
+
+    private var scheduledThreadPoolExecutor: ScheduledThreadPoolExecutor
+
+    init {
+        scheduledThreadPoolExecutor = ScheduledThreadPoolExecutor(1, JobThreadFactory())
+    }
+
+    protected open fun getRandomNumber(): Int {
+        return (Math.random() * (maxDelay - minDelay + 1) + minDelay).roundToInt()
+    }
+
+    open fun delayTaskByRandom(runnable: Runnable) {
+        val randomNum = getRandomNumber()
+
+        logger.debug("OSDelayTaskController delaying task $randomNum second from thread: ${Thread.currentThread()}")
+        scheduledThreadPoolExecutor.schedule(runnable, randomNum.toLong(), TimeUnit.SECONDS)
+    }
+
+    fun shutdownNow() {
+        scheduledThreadPoolExecutor.shutdownNow()
+    }
+
+    private class JobThreadFactory : ThreadFactory {
+        private val delayThreadName = "ONE_SIGNAL_DELAY"
+
+        override fun newThread(runnable: Runnable): Thread {
+            return Thread(runnable, delayThreadName)
+        }
+    }
+}

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

@@ -30,6 +30,8 @@
 import android.content.Context;
 
 import androidx.annotation.Nullable;
+import androidx.concurrent.futures.CallbackToFutureAdapter;
+import androidx.work.ListenableWorker;
 
 import org.json.JSONObject;
 
@@ -40,6 +42,7 @@ public class OSNotificationController {
    // The extension service app AndroidManifest.xml meta data tag key name
    private static final String EXTENSION_SERVICE_META_DATA_TAG_NAME = "com.onesignal.NotificationServiceExtension";
 
+   private final CallbackToFutureAdapter.Completer<ListenableWorker.Result> callbackCompleter;
    private final OSNotificationGenerationJob notificationJob;
    private boolean restoring;
    private boolean fromBackgroundLogic;
@@ -48,9 +51,12 @@ public class OSNotificationController {
       this.restoring = restoring;
       this.fromBackgroundLogic = fromBackgroundLogic;
       this.notificationJob = notificationJob;
+      this.callbackCompleter = notificationJob.getCallbackCompleter();
    }
 
-   OSNotificationController(Context context, JSONObject jsonPayload, boolean restoring, boolean fromBackgroundLogic, Long timestamp) {
+   OSNotificationController(CallbackToFutureAdapter.Completer<ListenableWorker.Result> callbackCompleter,
+                            Context context, JSONObject jsonPayload, boolean restoring, boolean fromBackgroundLogic, Long timestamp) {
+      this.callbackCompleter = callbackCompleter;
       this.restoring = restoring;
       this.fromBackgroundLogic = fromBackgroundLogic;
 
@@ -64,7 +70,7 @@ public class OSNotificationController {
     * @see OSNotificationGenerationJob
     */
    private OSNotificationGenerationJob createNotificationJobFromCurrent(Context context, JSONObject jsonPayload, Long timestamp) {
-      OSNotificationGenerationJob notificationJob = new OSNotificationGenerationJob(context);
+      OSNotificationGenerationJob notificationJob = new OSNotificationGenerationJob(callbackCompleter, context);
       notificationJob.setJsonPayload(jsonPayload);
       notificationJob.setShownTimeStamp(timestamp);
       notificationJob.setRestoring(restoring);

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

@@ -30,15 +30,17 @@
 import android.content.Context;
 import android.net.Uri;
 
-import androidx.core.app.NotificationCompat;
+import androidx.annotation.Nullable;
+import androidx.concurrent.futures.CallbackToFutureAdapter;
+import androidx.work.ListenableWorker;
 
-import org.json.JSONException;
 import org.json.JSONObject;
 
 import java.security.SecureRandom;
 
 public class OSNotificationGenerationJob {
 
+    private CallbackToFutureAdapter.Completer<ListenableWorker.Result> callbackCompleter;
     private OSNotification notification;
     private Context context;
     private JSONObject jsonPayload;
@@ -54,6 +56,11 @@ public class OSNotificationGenerationJob {
     private Uri orgSound;
 
     OSNotificationGenerationJob(Context context) {
+        this(null, context);
+    }
+
+    OSNotificationGenerationJob(CallbackToFutureAdapter.Completer<ListenableWorker.Result> callbackCompleter, Context context) {
+        this.callbackCompleter = callbackCompleter;
         this.context = context;
     }
 
@@ -67,6 +74,11 @@ public class OSNotificationGenerationJob {
         this.notification = notification;
     }
 
+    @Nullable
+    public CallbackToFutureAdapter.Completer<ListenableWorker.Result> getCallbackCompleter() {
+        return callbackCompleter;
+    }
+
     /**
      * Get the notification title from the payload
      */

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

@@ -77,7 +77,7 @@ public Result doWork() {
             StringBuilder dbQuerySelection = OneSignalDbHelper.recentUninteractedWithNotificationsWhere();
             skipVisibleNotifications(context, dbQuerySelection);
 
-            queryAndRestoreNotificationsAndBadgeCount(context, dbHelper, dbQuerySelection);
+            queryAndRestoreNotificationsAndBadgeCount(context, dbHelper, dbQuerySelection, false);
 
             return Result.success();
         }
@@ -87,7 +87,8 @@ public Result doWork() {
     private static void queryAndRestoreNotificationsAndBadgeCount(
             Context context,
             OneSignalDbHelper dbHelper,
-            StringBuilder dbQuerySelection) {
+            StringBuilder dbQuerySelection,
+            boolean needsWorkerThread) {
 
         OneSignal.Log(OneSignal.LOG_LEVEL.INFO,
                 "Querying DB for notifications to restore: " + dbQuerySelection.toString());
@@ -104,7 +105,7 @@ private static void queryAndRestoreNotificationsAndBadgeCount(
                     OneSignalDbContract.NotificationTable._ID + " DESC", // sort order, new to old
                     NotificationLimitManager.MAX_NUMBER_OF_NOTIFICATIONS_STR // limit
             );
-            showNotificationsFromCursor(context, cursor, DELAY_BETWEEN_NOTIFICATION_RESTORES_MS);
+            showNotificationsFromCursor(context, cursor, DELAY_BETWEEN_NOTIFICATION_RESTORES_MS, needsWorkerThread);
             BadgeCountUpdater.update(dbHelper, context);
         } catch (Throwable t) {
             OneSignal.Log(OneSignal.LOG_LEVEL.ERROR, "Error restoring notification records! ", t);
@@ -144,7 +145,7 @@ private static void skipVisibleNotifications(Context context, StringBuilder dbQu
      * @param cursor - Source cursor to generate notifications from
      * @param delay - Delay to slow down process to ensure we don't spike CPU and I/O on the device
      */
-    static void showNotificationsFromCursor(Context context, Cursor cursor, int delay) {
+    static void showNotificationsFromCursor(Context context, Cursor cursor, int delay, boolean needsWorkerThread) {
         if (!cursor.moveToFirst())
             return;
 
@@ -159,9 +160,10 @@ static void showNotificationsFromCursor(Context context, Cursor cursor, int dela
                     osNotificationId,
                     existingId,
                     fullData,
-                    true,
                     dateTime,
-                    false
+                    true,
+                    false,
+                    needsWorkerThread
             );
 
             if (delay > 0)