react-native-notify-kit 9.3.0 → 9.5.0

package/android/src/main/java/app/notifee/core/NotifeeAlarmManager.java

@@ -26,6 +26,7 @@ import android.content.Context;
 import android.content.Intent;
 import android.os.Build;
 import android.os.Bundle;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.core.app.AlarmManagerCompat;
 import app.notifee.core.database.WorkDataEntity;
@@ -40,10 +41,14 @@ import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.ListeningExecutorService;
 import com.google.common.util.concurrent.MoreExecutors;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
 
 class NotifeeAlarmManager {
   private static final String TAG = "NotifeeAlarmManager";
@@ -52,6 +57,59 @@ class NotifeeAlarmManager {
   private static final ListeningExecutorService alarmManagerListeningExecutor =
       MoreExecutors.listeningDecorator(alarmManagerExecutor);
 
+  // Scheduler used only as the timeout clock for Futures.withTimeout on Room
+  // writes happening inside BroadcastReceiver.goAsync() scopes. Broadcasts have
+  // ~10s before Android kills the process, so we cap the Room wait at 8s and
+  // call pendingResult.finish() anyway on timeout to avoid ANRs.
+  private static final ScheduledExecutorService TIMEOUT_SCHEDULER =
+      Executors.newSingleThreadScheduledExecutor();
+  private static final long RECEIVER_WRITE_TIMEOUT_SECONDS = 8;
+
+  /**
+   * Wraps {@code future} in a {@link Futures#withTimeout} safety net and arranges for {@code
+   * pendingResult.finish()} to be called exactly once — on success, on failure, or on timeout. Use
+   * from a {@link BroadcastReceiver#goAsync} scope where the receiver must tell Android "I'm done"
+   * within ~10s or the process is killed. Timeouts are logged at {@code WARN} with the supplied
+   * {@code logContext}; real failures at {@code ERROR}.
+   */
+  private static void finishReceiverWhenDone(
+      @NonNull ListenableFuture<?> future,
+      @Nullable BroadcastReceiver.PendingResult pendingResult,
+      @NonNull String logContext) {
+    ListenableFuture<?> bounded =
+        Futures.withTimeout(
+            future, RECEIVER_WRITE_TIMEOUT_SECONDS, TimeUnit.SECONDS, TIMEOUT_SCHEDULER);
+    Futures.addCallback(
+        bounded,
+        new FutureCallback<Object>() {
+          @Override
+          public void onSuccess(Object result) {
+            if (pendingResult != null) {
+              pendingResult.finish();
+            }
+          }
+
+          @Override
+          public void onFailure(@NonNull Throwable t) {
+            if (t instanceof TimeoutException) {
+              Logger.w(
+                  TAG,
+                  "Room write for "
+                      + logContext
+                      + " did not complete within "
+                      + RECEIVER_WRITE_TIMEOUT_SECONDS
+                      + "s; finishing BroadcastReceiver anyway to avoid ANR");
+            } else {
+              Logger.e(TAG, "Failure in " + logContext, new Exception(t));
+            }
+            if (pendingResult != null) {
+              pendingResult.finish();
+            }
+          }
+        },
+        alarmManagerListeningExecutor);
+  }
+
   static void displayScheduledNotification(
       Bundle alarmManagerNotification, @Nullable BroadcastReceiver.PendingResult pendingResult) {
     if (alarmManagerNotification == null) {
@@ -71,72 +129,60 @@ class NotifeeAlarmManager {
 
     WorkDataRepository workDataRepository = new WorkDataRepository(getApplicationContext());
 
-    ListenableFuture<?> displayFuture =
-        new ExtendedListenableFuture<>(workDataRepository.getWorkDataById(id))
-            .continueWith(
-                workDataEntity -> {
-                  Bundle notificationBundle;
-
-                  Bundle triggerBundle;
-
-                  if (workDataEntity == null
-                      || workDataEntity.getNotification() == null
-                      || workDataEntity.getTrigger() == null) {
-                    // check if notification bundle is stored with Work Manager
-                    Logger.w(
-                        TAG,
-                        "Attempted to handle doScheduledWork but no notification data was found.");
-                    return Futures.immediateFuture(null);
-                  } else {
-                    triggerBundle = ObjectUtils.bytesToBundle(workDataEntity.getTrigger());
-                    notificationBundle =
-                        ObjectUtils.bytesToBundle(workDataEntity.getNotification());
-                  }
-
-                  NotificationModel notificationModel =
-                      NotificationModel.fromBundle(notificationBundle);
-
-                  return new ExtendedListenableFuture<>(
-                          NotificationManager.displayNotification(notificationModel, triggerBundle))
-                      .continueWith(
-                          voidDisplayedNotification -> {
-                            if (triggerBundle.containsKey("repeatFrequency")
-                                && ObjectUtils.getInt(triggerBundle.get("repeatFrequency")) != -1) {
-                              TimestampTriggerModel trigger =
-                                  TimestampTriggerModel.fromBundle(triggerBundle);
-                              // scheduleTimestampTriggerNotification() calls setNextTimestamp()
-                              // internally, so we must NOT call it here to avoid double-advancing
-                              scheduleTimestampTriggerNotification(notificationModel, trigger);
-                              WorkDataRepository.getInstance(getApplicationContext())
-                                  .update(
-                                      new WorkDataEntity(
-                                          id,
-                                          workDataEntity.getNotification(),
-                                          ObjectUtils.bundleToBytes(trigger.toBundle()),
-                                          true));
-                            } else {
-                              // not repeating, delete database entry if work is a one-time request
-                              WorkDataRepository.getInstance(getApplicationContext())
-                                  .deleteById(id);
-                            }
-                            return Futures.immediateFuture(null);
-                          },
-                          alarmManagerExecutor);
-                },
-                alarmManagerExecutor)
-            .addOnCompleteListener(
-                (e, result) -> {
-                  try {
-                    if (e != null) {
-                      Logger.e(TAG, "Failed to display notification", e);
-                    }
-                  } finally {
-                    if (pendingResult != null) {
-                      pendingResult.finish();
+    // Chain: read → display → persist (update for repeat / delete for one-shot).
+    // The final Room write is awaited before pendingResult.finish() so the
+    // BroadcastReceiver only tells Android "I'm done" once the next-fire anchor
+    // (or the deletion) has actually landed in Room. Without this, process death
+    // between finish() and the enqueued write could lose the updated timestamp
+    // and cause the same alarm to fire again on the next reboot. See #549 audit
+    // callers #6 and #7.
+    ListenableFuture<Void> displayAndPersistFuture =
+        Futures.transformAsync(
+            workDataRepository.getWorkDataById(id),
+            workDataEntity -> {
+              if (workDataEntity == null
+                  || workDataEntity.getNotification() == null
+                  || workDataEntity.getTrigger() == null) {
+                Logger.w(
+                    TAG, "Attempted to handle doScheduledWork but no notification data was found.");
+                return Futures.immediateFuture(null);
+              }
+
+              Bundle triggerBundle = ObjectUtils.bytesToBundle(workDataEntity.getTrigger());
+              Bundle notificationBundle =
+                  ObjectUtils.bytesToBundle(workDataEntity.getNotification());
+              NotificationModel notificationModel =
+                  NotificationModel.fromBundle(notificationBundle);
+
+              return Futures.transformAsync(
+                  NotificationManager.displayNotification(notificationModel, triggerBundle),
+                  voidDisplayedNotification -> {
+                    if (triggerBundle.containsKey("repeatFrequency")
+                        && ObjectUtils.getInt(triggerBundle.get("repeatFrequency")) != -1) {
+                      TimestampTriggerModel trigger =
+                          TimestampTriggerModel.fromBundle(triggerBundle);
+                      // scheduleTimestampTriggerNotification() calls setNextTimestamp()
+                      // internally, so we must NOT call it here to avoid double-advancing
+                      scheduleTimestampTriggerNotification(notificationModel, trigger);
+                      return WorkDataRepository.getInstance(getApplicationContext())
+                          .update(
+                              new WorkDataEntity(
+                                  id,
+                                  workDataEntity.getNotification(),
+                                  ObjectUtils.bundleToBytes(trigger.toBundle()),
+                                  true));
                     }
-                  }
-                },
-                alarmManagerExecutor);
+                    // not repeating, delete database entry if work is a one-time request
+                    return WorkDataRepository.getInstance(getApplicationContext()).deleteById(id);
+                  },
+                  alarmManagerExecutor);
+            },
+            alarmManagerExecutor);
+
+    // Awaits the Room write before pendingResult.finish(), bounded by the 8s
+    // ANR safety timeout. Handles success, failure, and timeout uniformly.
+    finishReceiverWhenDone(
+        displayAndPersistFuture, pendingResult, "displayScheduledNotification[" + id + "]");
   }
 
   public static PendingIntent getAlarmManagerIntentForNotification(String notificationId) {
@@ -283,10 +329,18 @@ class NotifeeAlarmManager {
             alarmManagerListeningExecutor);
   }
 
-  /* On reboot, reschedule trigger notifications created via alarm manager  */
-  void rescheduleNotification(WorkDataEntity workDataEntity) {
+  /**
+   * On reboot, reschedule one trigger notification created via alarm manager.
+   *
+   * <p>Returns a future that completes when Room has persisted the updated next-fire anchor. The
+   * caller MUST await this future before calling {@code pendingResult.finish()} — otherwise Android
+   * may kill the boot receiver's process before Room has drained, and the next reboot will
+   * reschedule from the stale anchor. This bug is NOT in upstream invertase/notifee#549 and was
+   * surfaced only by the pre-fix-549-audit.md read-only caller audit (Caller #8).
+   */
+  ListenableFuture<Void> rescheduleNotification(WorkDataEntity workDataEntity) {
     if (workDataEntity.getNotification() == null || workDataEntity.getTrigger() == null) {
-      return;
+      return Futures.immediateFuture(null);
     }
 
     byte[] notificationBytes = workDataEntity.getNotification();
@@ -302,22 +356,23 @@ class NotifeeAlarmManager {
       case 0:
         TimestampTriggerModel trigger = TimestampTriggerModel.fromBundle(triggerBundle);
         if (!trigger.getWithAlarmManager()) {
-          return;
+          return Futures.immediateFuture(null);
         }
 
         scheduleTimestampTriggerNotification(notificationModel, trigger);
-        // Persist updated timestamp so next reboot starts from the correct anchor
-        WorkDataRepository.getInstance(getApplicationContext())
+        // Persist updated timestamp so next reboot starts from the correct anchor.
+        return WorkDataRepository.getInstance(getApplicationContext())
             .update(
                 new WorkDataEntity(
                     workDataEntity.getId(),
                     workDataEntity.getNotification(),
                     ObjectUtils.bundleToBytes(trigger.toBundle()),
                     workDataEntity.getWithAlarmManager()));
-        break;
       case 1:
         // TODO: support interval triggers with alarm manager
-        break;
+        return Futures.immediateFuture(null);
+      default:
+        return Futures.immediateFuture(null);
     }
   }
 
@@ -328,19 +383,45 @@ class NotifeeAlarmManager {
         new FutureCallback<List<WorkDataEntity>>() {
           @Override
           public void onSuccess(List<WorkDataEntity> workDataEntities) {
-            try {
-              for (WorkDataEntity workDataEntity : workDataEntities) {
-                rescheduleNotification(workDataEntity);
-              }
-            } finally {
+            Logger.d(
+                TAG,
+                "Reschedule starting for "
+                    + (workDataEntities != null ? workDataEntities.size() : 0)
+                    + " recurring alarms");
+
+            if (workDataEntities == null || workDataEntities.isEmpty()) {
               if (pendingResult != null) {
                 pendingResult.finish();
               }
+              return;
             }
+
+            List<ListenableFuture<Void>> updateFutures = new ArrayList<>(workDataEntities.size());
+            for (WorkDataEntity workDataEntity : workDataEntities) {
+              try {
+                updateFutures.add(rescheduleNotification(workDataEntity));
+              } catch (Throwable t) {
+                // A single bad entity must not prevent the rest of the batch
+                // from being rescheduled — log and continue.
+                Logger.w(
+                    TAG,
+                    "Failed to reschedule entity "
+                        + workDataEntity.getId()
+                        + ": "
+                        + t.getMessage());
+              }
+            }
+
+            // Awaits all per-entity update futures before finishing the boot
+            // receiver, bounded by the 8s ANR safety timeout. Any not-yet-
+            // persisted next-fire anchors left behind on timeout will catch up
+            // on the next alarm fire.
+            ListenableFuture<List<Void>> combined = Futures.allAsList(updateFutures);
+            finishReceiverWhenDone(combined, pendingResult, "rescheduleNotifications");
           }
 
           @Override
-          public void onFailure(Throwable t) {
+          public void onFailure(@NonNull Throwable t) {
             Logger.e(TAG, "Failed to reschedule notifications", new Exception(t));
             if (pendingResult != null) {
               pendingResult.finish();