expo-notifications 58.1.0 → 58.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 58.1.1
+
+### Patch Changes
+
+- [Android] Add support for grouping notifications via `threadIdentifier`. ([#43388](https://github.com/expo/expo/pull/43388) by [@vonovak](https://github.com/vonovak))
+- [Android] Add `getExactAlarmPermissionsAsync` and `requestExactAlarmPermissionsAsync` to check and request the exact alarm permission. ([#50919](https://github.com/expo/expo/pull/50919) by [@vonovak](https://github.com/vonovak))
+- [Internal] [Android] Return notification permission responses as records instead of bundles. ([#51060](https://github.com/expo/expo/pull/51060) by [@vonovak](https://github.com/vonovak))
+- Updated dependencies. ([#51077](https://github.com/expo/expo/pull/51077))
+  - expo-application@58.0.4
+  - @expo/image-utils@0.12.4
+  - expo-constants@58.0.10
+
 ## 58.1.0
 
 ### Minor Changes

package/android/build.gradle

@@ -5,13 +5,13 @@ plugins {
 }
 
 group = 'host.exp.exponent'
-version = '58.1.0'
+version = '58.1.1'
 
 android {
   namespace "expo.modules.notifications"
   defaultConfig {
     versionCode 21
-    versionName '58.1.0'
+    versionName '58.1.1'
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     consumerProguardFiles 'proguard-rules.pro'
   }

package/android/src/main/java/expo/modules/notifications/Exceptions.kt

@@ -7,3 +7,9 @@ class ModuleNotFoundException(moduleClass: KClass<*>) :
   CodedException(message = "$moduleClass module not found")
 
 class NotificationWasAlreadyHandledException(val id: String) : CodedException("Failed to handle notification $id, it has already been handled.")
+
+class ExactAlarmPermissionNotDeclaredException :
+  CodedException(
+    "Cannot request the exact alarm permission because the app does not declare android.permission.SCHEDULE_EXACT_ALARM. " +
+      "Add it to `android.permissions` in your app config and rebuild the app."
+  )

package/android/src/main/java/expo/modules/notifications/notifications/ArgumentsNotificationContentBuilder.java

@@ -29,6 +29,7 @@ public class ArgumentsNotificationContentBuilder extends NotificationContent.Bui
   private static final String AUTO_DISMISS_KEY = "autoDismiss";
   private static final String CATEGORY_IDENTIFIER_KEY = "categoryIdentifier";
   private static final String STICKY_KEY = "sticky";
+  private static final String THREAD_IDENTIFIER_KEY = "threadIdentifier";
 
   private SoundResolver mSoundResolver;
 
@@ -46,7 +47,8 @@ public class ArgumentsNotificationContentBuilder extends NotificationContent.Bui
       .setColor(getColor(payload))
       .setAutoDismiss(getAutoDismiss(payload))
       .setCategoryId(getCategoryId(payload))
-      .setSticky(getSticky(payload));
+      .setSticky(getSticky(payload))
+      .setGroup(getGroup(payload));
 
     if (shouldPlayDefaultSound(payload)) {
       useDefaultSound();
@@ -146,4 +148,9 @@ public class ArgumentsNotificationContentBuilder extends NotificationContent.Bui
     // TODO: the default value should be determined by NotificationContent.Builder
     return payload.getBoolean(STICKY_KEY, false);
   }
+
+  @Nullable
+  protected String getGroup(ReadableArguments payload) {
+    return payload.getString(THREAD_IDENTIFIER_KEY, null);
+  }
 }

package/android/src/main/java/expo/modules/notifications/notifications/NotificationSerializer.java

@@ -129,6 +129,7 @@ public class NotificationSerializer {
       serializedContent.putString("categoryIdentifier", content.getCategoryId());
     }
     serializedContent.putBoolean("sticky", content.isSticky());
+    serializedContent.putString("threadIdentifier", content.getGroup());
     return serializedContent;
   }
 
@@ -187,6 +188,9 @@ public class NotificationSerializer {
       serializedContent.putBundle("data", filteredBundleForJSTypeConverter(extras));
     }
 
+    String threadIdentifier = extras.getString("threadIdentifier");
+    serializedContent.putString("threadIdentifier", threadIdentifier == null || threadIdentifier.isEmpty() ? null : threadIdentifier);
+
     Bundle serializedTrigger = new Bundle();
     serializedTrigger.putString("type", "push");
     serializedTrigger.putString("channelId", extras.getString("channelId"));

package/android/src/main/java/expo/modules/notifications/notifications/interfaces/INotificationContent.kt

@@ -31,6 +31,7 @@ interface INotificationContent : Parcelable {
   val color: Number?
   val isAutoDismiss: Boolean
   val categoryId: String?
+  val group: String?
   val isSticky: Boolean
 
   fun containsImage(): Boolean

package/android/src/main/java/expo/modules/notifications/notifications/model/NotificationContent.java

@@ -44,6 +44,7 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
   private boolean mAutoDismiss;
   private String mCategoryId;
   private boolean mSticky;
+  private String mGroup;
 
   protected NotificationContent() {
   }
@@ -134,6 +135,11 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
     return mCategoryId;
   }
   
+  @Nullable
+  public String getGroup() {
+    return mGroup;
+  }
+
   public boolean isSticky() {
     return mSticky;
   }
@@ -165,6 +171,7 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
     mAutoDismiss = in.readByte() == 1;
     mCategoryId = in.readString();
     mSticky = in.readByte() == 1;
+    mGroup = in.readString();
   }
 
   @Override
@@ -183,6 +190,7 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
     dest.writeByte((byte) (mAutoDismiss ? 1 : 0));
     dest.writeString(mCategoryId);
     dest.writeByte((byte) (mSticky ? 1 : 0));
+    dest.writeString(mGroup);
   }
 
   //                                           EXPONOTIFCONTENT02
@@ -210,6 +218,7 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
     out.writeByte(mAutoDismiss ? 1 : 0);
     out.writeObject(mCategoryId != null ? mCategoryId.toString() : null);
     out.writeByte(mSticky ? 1 : 0);
+    out.writeObject(mGroup);
   }
 
   private void readObject(java.io.ObjectInputStream in) throws IOException, ClassNotFoundException {
@@ -257,6 +266,11 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
       mCategoryId = new String(categoryIdString);
     }
     mSticky = in.readByte() == 1;
+    try {
+      mGroup = (String) in.readObject();
+    } catch (java.io.OptionalDataException | java.io.EOFException e) {
+      // Backward compatibility: old serialized data won't have this field
+    }
   }
 
   private void readObjectNoData() throws ObjectStreamException {
@@ -354,6 +368,12 @@ public class NotificationContent implements Parcelable, Serializable, INotificat
       return this;
     }
 
+    public Builder setGroup(String group) {
+      // An empty group would be nameless. iOS also reports it as null.
+      content.mGroup = group == null || group.isEmpty() ? null : group;
+      return this;
+    }
+
     public NotificationContent build() {
       return content;
     }

package/android/src/main/java/expo/modules/notifications/notifications/model/NotificationData.kt

@@ -58,6 +58,9 @@ value class NotificationData(private val data: Map<String, String>) {
   val categoryId: String?
     get() = data["categoryId"]
 
+  val group: String?
+    get() = data["threadIdentifier"]?.takeIf { it.isNotEmpty() }
+
   val subText: String?
     get() = data["subtitle"]
 

package/android/src/main/java/expo/modules/notifications/notifications/model/RemoteNotificationContent.kt

@@ -67,6 +67,9 @@ class RemoteNotificationContent(private val remoteMessage: RemoteMessage) : INot
 
   override val categoryId = notificationData.categoryId
 
+  // FCM's notification payload has no group field.
+  override val group = notificationData.group
+
   override val isSticky = notificationData.isSticky
 
   override val subText = notificationData.subText

package/android/src/main/java/expo/modules/notifications/notifications/presentation/builders/ExpoNotificationBuilder.kt

@@ -114,6 +114,11 @@ open class ExpoNotificationBuilder(
 
     applySoundsAndVibrations(content, builder)
 
+    content.group?.let {
+      builder.setGroup(it)
+      builder.setDeleteIntent(NotificationsService.createGroupedNotificationDeletedIntent(context, notification))
+    }
+
     if (content.body != null) {
       // Add body - JSON data - to extras
       val extras = builder.extras

package/android/src/main/java/expo/modules/notifications/permissions/NotificationPermissionRecords.kt

@@ -0,0 +1,40 @@
+package expo.modules.notifications.permissions
+
+import expo.modules.interfaces.permissions.PermissionsResponse
+import expo.modules.kotlin.records.Field
+import expo.modules.kotlin.records.Record
+import expo.modules.kotlin.types.OptimizedRecord
+
+@OptimizedRecord
+class AndroidNotificationPermissionDetails(
+  @Field
+  val importance: Int,
+  @Field
+  val interruptionFilter: Int
+) : Record
+
+@OptimizedRecord
+class NotificationPermissionResponse(
+  @Field
+  val status: String,
+  @Field
+  val expires: String = PermissionsResponse.PERMISSION_EXPIRES_NEVER,
+  @Field
+  val canAskAgain: Boolean,
+  @Field
+  val granted: Boolean,
+  @Field
+  val android: AndroidNotificationPermissionDetails
+) : Record
+
+@OptimizedRecord
+class ExactAlarmPermissionResponse(
+  @Field
+  val status: String,
+  @Field
+  val expires: String = PermissionsResponse.PERMISSION_EXPIRES_NEVER,
+  @Field
+  val canAskAgain: Boolean,
+  @Field
+  val granted: Boolean
+) : Record

package/android/src/main/java/expo/modules/notifications/permissions/NotificationPermissionsModule.kt

@@ -1,25 +1,27 @@
 package expo.modules.notifications.permissions
 
 import android.Manifest
-import android.app.NotificationManager
+import android.app.AlarmManager
 import android.content.Context
+import android.content.Intent
+import android.content.pm.PackageManager
+import android.net.Uri
 import android.os.Build
+import android.provider.Settings
 import androidx.annotation.RequiresApi
 import androidx.core.app.NotificationManagerCompat
-import androidx.core.os.bundleOf
 import expo.modules.core.arguments.ReadableArguments
 import expo.modules.interfaces.permissions.Permissions
 import expo.modules.interfaces.permissions.PermissionsResponse
 import expo.modules.interfaces.permissions.PermissionsStatus
 import expo.modules.kotlin.Promise
 import expo.modules.kotlin.exception.Exceptions
+import expo.modules.kotlin.functions.Queues
 import expo.modules.kotlin.modules.Module
 import expo.modules.kotlin.modules.ModuleDefinition
+import expo.modules.notifications.ExactAlarmPermissionNotDeclaredException
 import expo.modules.notifications.ModuleNotFoundException
 
-private const val ANDROID_RESPONSE_KEY = "android"
-private const val IMPORTANCE_KEY = "importance"
-private const val INTERRUPTION_FILTER_KEY = "interruptionFilter"
 private val PERMISSIONS: Array<String> = arrayOf(Manifest.permission.POST_NOTIFICATIONS)
 
 class NotificationPermissionsModule : Module() {
@@ -29,6 +31,8 @@ class NotificationPermissionsModule : Module() {
   private val context: Context
     get() = appContext.reactContext ?: throw Exceptions.ReactContextLost()
 
+  private val pendingExactAlarmPromises = mutableListOf<Promise>()
+
   override fun definition() = ModuleDefinition {
     Name("ExpoNotificationPermissionsModule")
 
@@ -47,6 +51,72 @@ class NotificationPermissionsModule : Module() {
         getPermissionsWithPromiseImplClassic(promise)
       }
     }
+
+    AsyncFunction("getExactAlarmPermissionsAsync") {
+      getExactAlarmPermissionsResponse()
+    }
+
+    AsyncFunction("requestExactAlarmPermissionsAsync") { promise: Promise ->
+      if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S || canScheduleExactAlarms()) {
+        promise.resolve(getExactAlarmPermissionsResponse())
+        return@AsyncFunction
+      }
+      if (!isScheduleExactAlarmDeclared()) {
+        throw ExactAlarmPermissionNotDeclaredException()
+      }
+      val activity = appContext.currentActivity ?: throw Exceptions.MissingActivity()
+      pendingExactAlarmPromises.add(promise)
+      val intent = Intent(Settings.ACTION_REQUEST_SCHEDULE_EXACT_ALARM, Uri.parse("package:${context.packageName}"))
+      try {
+        activity.startActivity(intent)
+      } catch (e: Throwable) {
+        pendingExactAlarmPromises.remove(promise)
+        throw e
+      }
+    }.runOnQueue(Queues.MAIN)
+
+    OnActivityEntersForeground {
+      if (pendingExactAlarmPromises.isNotEmpty()) {
+        val promises = pendingExactAlarmPromises.toList()
+        pendingExactAlarmPromises.clear()
+        val response = getExactAlarmPermissionsResponse()
+        promises.forEach { it.resolve(response) }
+      }
+    }
+  }
+
+  private fun canScheduleExactAlarms(): Boolean {
+    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
+      return true
+    }
+    val alarmManager = context.getSystemService(AlarmManager::class.java)
+    return alarmManager?.canScheduleExactAlarms() ?: false
+  }
+
+  private fun isScheduleExactAlarmDeclared(): Boolean {
+    val requested = if (Build.VERSION.SDK_INT >= 33) {
+      context.packageManager
+        .getPackageInfo(context.packageName, PackageManager.PackageInfoFlags.of(PackageManager.GET_PERMISSIONS.toLong()))
+        .requestedPermissions
+    } else {
+      @Suppress("DEPRECATION")
+      context.packageManager.getPackageInfo(context.packageName, PackageManager.GET_PERMISSIONS).requestedPermissions
+    }
+    return requested?.contains(Manifest.permission.SCHEDULE_EXACT_ALARM) == true
+  }
+
+  private fun getExactAlarmPermissionsResponse(): ExactAlarmPermissionResponse {
+    val granted = canScheduleExactAlarms()
+    val status = if (granted) {
+      PermissionsStatus.GRANTED
+    } else {
+      PermissionsStatus.DENIED
+    }
+    return ExactAlarmPermissionResponse(
+      status = status.status,
+      canAskAgain = granted || isScheduleExactAlarmDeclared(),
+      granted = granted
+    )
   }
 
   @RequiresApi(33)
@@ -55,15 +125,6 @@ class NotificationPermissionsModule : Module() {
       { permissionsMap: Map<String, PermissionsResponse> ->
         val managerCompat = NotificationManagerCompat.from(context)
         val areEnabled = managerCompat.areNotificationsEnabled()
-        val platformBundle = bundleOf(
-          IMPORTANCE_KEY to managerCompat.importance
-        ).apply {
-          val notificationManager = context.getSystemService(Context.NOTIFICATION_SERVICE) as? NotificationManager
-          if (notificationManager != null) {
-            putInt(INTERRUPTION_FILTER_KEY, notificationManager.currentInterruptionFilter)
-          }
-        }
-
         val areAllGranted = permissionsMap.all { (_, response) -> response.status == PermissionsStatus.GRANTED }
         val areAllDenied = permissionsMap.all { (_, response) -> response.status == PermissionsStatus.DENIED }
         val canAskAgain = permissionsMap.all { (_, response) -> response.canAskAgain }
@@ -75,12 +136,11 @@ class NotificationPermissionsModule : Module() {
         }
 
         promise.resolve(
-          bundleOf(
-            PermissionsResponse.EXPIRES_KEY to PermissionsResponse.PERMISSION_EXPIRES_NEVER,
-            PermissionsResponse.STATUS_KEY to status,
-            PermissionsResponse.CAN_ASK_AGAIN_KEY to canAskAgain,
-            PermissionsResponse.GRANTED_KEY to areAllGranted,
-            ANDROID_RESPONSE_KEY to platformBundle
+          NotificationPermissionResponse(
+            status = status,
+            canAskAgain = canAskAgain,
+            granted = areAllGranted,
+            android = getAndroidDetails(managerCompat)
           )
         )
       },
@@ -96,26 +156,23 @@ class NotificationPermissionsModule : Module() {
     } else {
       PermissionsStatus.DENIED
     }
-    val platformBundle = bundleOf(
-      IMPORTANCE_KEY to managerCompat.importance
-    ).apply {
-      val notificationManager = context.getSystemService(Context.NOTIFICATION_SERVICE) as? NotificationManager
-      if (notificationManager != null) {
-        putInt(INTERRUPTION_FILTER_KEY, notificationManager.currentInterruptionFilter)
-      }
-    }
 
     promise.resolve(
-      bundleOf(
-        PermissionsResponse.EXPIRES_KEY to PermissionsResponse.PERMISSION_EXPIRES_NEVER,
-        PermissionsResponse.STATUS_KEY to status.status,
-        PermissionsResponse.CAN_ASK_AGAIN_KEY to areEnabled,
-        PermissionsResponse.GRANTED_KEY to (status == PermissionsStatus.GRANTED),
-        ANDROID_RESPONSE_KEY to platformBundle
+      NotificationPermissionResponse(
+        status = status.status,
+        canAskAgain = areEnabled,
+        granted = status == PermissionsStatus.GRANTED,
+        android = getAndroidDetails(managerCompat)
       )
     )
   }
 
+  private fun getAndroidDetails(managerCompat: NotificationManagerCompat) =
+    AndroidNotificationPermissionDetails(
+      importance = managerCompat.importance,
+      interruptionFilter = managerCompat.currentInterruptionFilter
+    )
+
   @RequiresApi(33)
   private fun requestPermissionsWithPromiseImplApi33(promise: Promise) {
     permissions.askForPermissions(

package/android/src/main/java/expo/modules/notifications/service/NotificationsService.kt

@@ -56,6 +56,7 @@ open class NotificationsService : BroadcastReceiver() {
     private const val GET_SCHEDULED_TYPE = "getScheduled"
     private const val REMOVE_SELECTED_TYPE = "removeSelected"
     private const val REMOVE_ALL_TYPE = "removeAll"
+    private const val GROUPED_NOTIFICATION_DELETED_TYPE = "groupedNotificationDeleted"
 
     // Messages parts
     const val SUCCESS_CODE = 0
@@ -443,6 +444,28 @@ open class NotificationsService : BroadcastReceiver() {
       )
     }
 
+    fun createGroupedNotificationDeletedIntent(context: Context, notification: Notification): PendingIntent {
+      // The identifier in the URI keeps FLAG_UPDATE_CURRENT from replacing one child's extras with another's.
+      val intent = Intent(
+        NOTIFICATION_EVENT_ACTION,
+        getUriBuilderForIdentifier(notification.notificationRequest.identifier).appendPath("groupedDeleted").build()
+      ).also { intent ->
+        findDesignatedBroadcastReceiver(context, intent)?.let {
+          intent.component = ComponentName(it.packageName, it.name)
+        }
+        intent.putExtra(EVENT_TYPE_KEY, GROUPED_NOTIFICATION_DELETED_TYPE)
+        intent.putExtra(NOTIFICATION_KEY, notification)
+        // Byte-array copy: Parcelable extras can come back null from a PendingIntent, see #38908
+        marshalObject(notification)?.let { intent.putExtra(NOTIFICATION_BYTES_KEY, it) }
+      }
+      return PendingIntent.getBroadcast(
+        context,
+        0,
+        intent,
+        PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
+      )
+    }
+
     /**
      * Creates and returns a pending intent that will trigger [NotificationsService]'s "response received"
      * event.
@@ -694,6 +717,8 @@ open class NotificationsService : BroadcastReceiver() {
 
           TRIGGER_TYPE -> onNotificationTriggered(context, intent)
 
+          GROUPED_NOTIFICATION_DELETED_TYPE -> onGroupedNotificationDeleted(context, intent)
+
           else -> throw IllegalArgumentException("Received event of unrecognized type: $eventType. Ignoring.")
         }
 
@@ -753,11 +778,24 @@ open class NotificationsService : BroadcastReceiver() {
   open fun onReceiveNotificationResponse(context: Context, intent: Intent) {
     val response = getNotificationResponseFromBroadcastIntent(intent)
     getHandlingDelegate(context).handleNotificationResponse(response)
+    // Auto-cancel on tap does not fire the delete intent. Action buttons do not dismiss.
+    val content = response.notification.notificationRequest.content
+    val isTap = response.actionIdentifier == NotificationResponse.DEFAULT_ACTION_IDENTIFIER
+    if (isTap && content.isAutoDismiss && content.group != null) {
+      getPresentationDelegate(context).removeOrphanedGroupSummaries(response.notification)
+    }
   }
 
   open fun onNotificationsDropped(context: Context, intent: Intent) =
     getHandlingDelegate(context).handleNotificationsDropped()
 
+  open fun onGroupedNotificationDeleted(context: Context, intent: Intent) {
+    val notification = intent.getParcelableExtra<Notification>(NOTIFICATION_KEY)
+      ?: unmarshalObject(Notification.CREATOR, intent.getByteArrayExtra(NOTIFICATION_BYTES_KEY))
+      ?: throw IllegalArgumentException("$NOTIFICATION_KEY not found in the intent extras.")
+    getPresentationDelegate(context).removeOrphanedGroupSummaries(notification)
+  }
+
   //endregion
 
   //region Category handling