expo-notifications 0.29.5 → 0.29.6

package/CHANGELOG.md

@@ -10,6 +10,13 @@
 
 ### 💡 Others
 
+## 0.29.6 — 2024-11-10
+
+### 🎉 New features
+
+- [android] run notification tasks from killed state ([#32531](https://github.com/expo/expo/pull/32531) by [@vonovak](https://github.com/vonovak))
+- add `enableBackgroundRemoteNotifications` option to config plugin ([#32716](https://github.com/expo/expo/pull/32716) by [@vonovak](https://github.com/vonovak))
+
 ## 0.29.5 — 2024-11-07
 
 ### 🛠 Breaking changes

package/android/build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-parcelize'
 
 group = 'host.exp.exponent'
-version = '0.29.5'
+version = '0.29.6'
 
 def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
 apply from: expoModulesCorePlugin
@@ -15,7 +15,7 @@ android {
   namespace "expo.modules.notifications"
   defaultConfig {
     versionCode 21
-    versionName '0.29.5'
+    versionName '0.29.6'
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
   }
 

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

@@ -6,6 +6,7 @@ import com.google.firebase.messaging.RemoteMessage;
 
 import java.util.Map;
 
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
 /**
@@ -19,7 +20,7 @@ public class RemoteMessageSerializer {
    * @param message {@link RemoteMessage} to serialize
    * @return Serialized message
    */
-  public static Bundle toBundle(RemoteMessage message) {
+  public static @NonNull Bundle toBundle(RemoteMessage message) {
     Bundle serializedMessage = new Bundle();
     serializedMessage.putString("collapseKey", message.getCollapseKey());
     serializedMessage.putBundle("data", toBundle(message.getData()));

package/android/src/main/java/expo/modules/notifications/notifications/background/BackgroundRemoteNotificationTaskConsumer.java

@@ -6,6 +6,7 @@ import android.content.Context;
 import android.os.Bundle;
 import android.os.PersistableBundle;
 import android.util.Log;
+import androidx.annotation.NonNull;
 
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -120,5 +121,9 @@ public class BackgroundRemoteNotificationTaskConsumer extends TaskConsumer imple
     return bundle;
   }
 
+  public void executeTask(@NonNull Bundle bundle) {
+    mTask.execute(bundle, null);
+  }
+
   //endregion
 }

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

@@ -45,7 +45,7 @@ class ExpoHandlingDelegate(protected val context: Context) : HandlingDelegate {
       }
 
       sListenersReferences[listener] = WeakReference(listener)
-      if (!sPendingNotificationResponses.isEmpty()) {
+      if (sPendingNotificationResponses.isNotEmpty()) {
         val responseIterator = sPendingNotificationResponses.iterator()
         while (responseIterator.hasNext()) {
           listener.onNotificationResponseReceived(responseIterator.next())
@@ -139,11 +139,11 @@ class ExpoHandlingDelegate(protected val context: Context) : HandlingDelegate {
     if (notificationResponse.action.opensAppToForeground()) {
       openAppToForeground(context, notificationResponse)
     }
-
-    if (getListeners().isEmpty()) {
+    val listeners = getListeners()
+    if (listeners.isEmpty()) {
       sPendingNotificationResponses.add(notificationResponse)
     } else {
-      getListeners().forEach {
+      listeners.forEach {
         it.onNotificationResponseReceived(notificationResponse)
       }
     }

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

@@ -2,6 +2,7 @@ package expo.modules.notifications.service.delegates
 
 import android.content.Context
 import com.google.firebase.messaging.RemoteMessage
+import expo.modules.interfaces.taskManager.TaskServiceProviderHelper
 import expo.modules.notifications.notifications.RemoteMessageSerializer
 import expo.modules.notifications.notifications.background.BackgroundRemoteNotificationTaskConsumer
 import expo.modules.notifications.notifications.debug.DebugLogging
@@ -94,9 +95,16 @@ open class FirebaseMessagingDelegate(protected val context: Context) : FirebaseM
     val notification = createNotification(remoteMessage)
     DebugLogging.logNotification("FirebaseMessagingDelegate.onMessageReceived: notification", notification)
     NotificationsService.receive(context, notification)
-    // background tasks are separate from the main notification handling flow; they are executed through task-manager
+    runTaskManagerTasks(remoteMessage)
+  }
+
+  private fun runTaskManagerTasks(remoteMessage: RemoteMessage) {
+    // getTaskServiceImpl() has a side effect:
+    // the TaskService constructor calls restoreTasks which then constructs a BackgroundRemoteNotificationTaskConsumer,
+    // and the getBackgroundTasks() call below doesn't return an empty collection.
+    TaskServiceProviderHelper.getTaskServiceImpl(context.applicationContext)
     getBackgroundTasks().forEach {
-      it.scheduleJob(RemoteMessageSerializer.toBundle(remoteMessage))
+      it.executeTask(RemoteMessageSerializer.toBundle(remoteMessage))
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-notifications",
-  "version": "0.29.5",
+  "version": "0.29.6",
   "description": "Provides an API to fetch push notification tokens and to present, schedule, receive, and respond to notifications.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -55,5 +55,5 @@
     "react": "*",
     "react-native": "*"
   },
-  "gitHead": "c0899e56c5be08b0142f06f05aa7bac8d6bc18b8"
+  "gitHead": "1f84b4c952ed9785c41ee65c9877e44f1df27af9"
 }

package/plugin/build/withNotifications.d.ts

@@ -28,6 +28,14 @@ export type NotificationsPluginProps = {
      * @platform ios
      */
     mode?: 'development' | 'production';
+    /**
+     * Whether to enable background remote notifications, as described in [Apple documentation](https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app).
+     *
+     * This sets the `UIBackgroundModes` key in the `Info.plist` to include `remote-notification`.
+     * @default false
+     * @platform ios
+     */
+    enableBackgroundRemoteNotifications?: boolean;
 };
 declare const _default: ConfigPlugin<void | NotificationsPluginProps>;
 export default _default;

package/plugin/build/withNotificationsIOS.d.ts

@@ -1,9 +1,6 @@
 import { ConfigPlugin, XcodeProject } from 'expo/config-plugins';
 import { NotificationsPluginProps } from './withNotifications';
 export declare const withNotificationsIOS: ConfigPlugin<NotificationsPluginProps>;
-export declare const withNotificationSounds: ConfigPlugin<{
-    sounds: string[];
-}>;
 /**
  * Save sound files to the Xcode project root and add them to the Xcode project.
  */

package/plugin/build/withNotificationsIOS.js

@@ -1,21 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setNotificationSounds = exports.withNotificationSounds = exports.withNotificationsIOS = void 0;
+exports.setNotificationSounds = exports.withNotificationsIOS = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const ERROR_MSG_PREFIX = 'An error occurred while configuring iOS notifications. ';
-const withNotificationsIOS = (config, { mode = 'development', sounds = [] }) => {
+const withNotificationsIOS = (config, { mode = 'development', sounds = [], enableBackgroundRemoteNotifications }) => {
     config = (0, config_plugins_1.withEntitlementsPlist)(config, (config) => {
         if (!config.modResults['aps-environment']) {
             config.modResults['aps-environment'] = mode;
         }
         return config;
     });
-    config = (0, exports.withNotificationSounds)(config, { sounds });
+    config = withNotificationSounds(config, { sounds });
+    config = withBackgroundRemoteNotifications(config, enableBackgroundRemoteNotifications);
     return config;
 };
 exports.withNotificationsIOS = withNotificationsIOS;
+const withBackgroundRemoteNotifications = (config, enableBackgroundRemoteNotifications) => {
+    if (!(enableBackgroundRemoteNotifications === undefined ||
+        typeof enableBackgroundRemoteNotifications === 'boolean')) {
+        throw new Error(ERROR_MSG_PREFIX +
+            `"enableBackgroundRemoteNotifications" has an invalid value: ${enableBackgroundRemoteNotifications}. Expected a boolean.`);
+    }
+    if (!enableBackgroundRemoteNotifications) {
+        return config;
+    }
+    return (0, config_plugins_1.withInfoPlist)(config, (config) => {
+        if (!Array.isArray(config.modResults.UIBackgroundModes)) {
+            config.modResults.UIBackgroundModes = [];
+        }
+        const notificationBackgroundMode = 'remote-notification';
+        if (!config.modResults.UIBackgroundModes.includes(notificationBackgroundMode)) {
+            config.modResults.UIBackgroundModes.push(notificationBackgroundMode);
+        }
+        return config;
+    });
+};
 const withNotificationSounds = (config, { sounds }) => {
     return (0, config_plugins_1.withXcodeProject)(config, (config) => {
         setNotificationSounds(config.modRequest.projectRoot, {
@@ -26,7 +47,6 @@ const withNotificationSounds = (config, { sounds }) => {
         return config;
     });
 };
-exports.withNotificationSounds = withNotificationSounds;
 /**
  * Save sound files to the Xcode project root and add them to the Xcode project.
  */

package/plugin/src/withNotifications.ts

@@ -34,6 +34,15 @@ export type NotificationsPluginProps = {
    * @platform ios
    */
   mode?: 'development' | 'production';
+
+  /**
+   * Whether to enable background remote notifications, as described in [Apple documentation](https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app).
+   *
+   * This sets the `UIBackgroundModes` key in the `Info.plist` to include `remote-notification`.
+   * @default false
+   * @platform ios
+   */
+  enableBackgroundRemoteNotifications?: boolean;
 };
 
 const withNotifications: ConfigPlugin<NotificationsPluginProps | void> = (config, props) => {

package/plugin/src/withNotificationsIOS.ts

@@ -4,6 +4,7 @@ import {
   IOSConfig,
   withXcodeProject,
   XcodeProject,
+  withInfoPlist,
 } from 'expo/config-plugins';
 import { copyFileSync } from 'fs';
 import { basename, resolve } from 'path';
@@ -14,7 +15,7 @@ const ERROR_MSG_PREFIX = 'An error occurred while configuring iOS notifications.
 
 export const withNotificationsIOS: ConfigPlugin<NotificationsPluginProps> = (
   config,
-  { mode = 'development', sounds = [] }
+  { mode = 'development', sounds = [], enableBackgroundRemoteNotifications }
 ) => {
   config = withEntitlementsPlist(config, (config) => {
     if (!config.modResults['aps-environment']) {
@@ -23,10 +24,42 @@ export const withNotificationsIOS: ConfigPlugin<NotificationsPluginProps> = (
     return config;
   });
   config = withNotificationSounds(config, { sounds });
+  config = withBackgroundRemoteNotifications(config, enableBackgroundRemoteNotifications);
+
   return config;
 };
 
-export const withNotificationSounds: ConfigPlugin<{ sounds: string[] }> = (config, { sounds }) => {
+const withBackgroundRemoteNotifications: ConfigPlugin<boolean | undefined> = (
+  config,
+  enableBackgroundRemoteNotifications
+) => {
+  if (
+    !(
+      enableBackgroundRemoteNotifications === undefined ||
+      typeof enableBackgroundRemoteNotifications === 'boolean'
+    )
+  ) {
+    throw new Error(
+      ERROR_MSG_PREFIX +
+        `"enableBackgroundRemoteNotifications" has an invalid value: ${enableBackgroundRemoteNotifications}. Expected a boolean.`
+    );
+  }
+  if (!enableBackgroundRemoteNotifications) {
+    return config;
+  }
+  return withInfoPlist(config, (config) => {
+    if (!Array.isArray(config.modResults.UIBackgroundModes)) {
+      config.modResults.UIBackgroundModes = [];
+    }
+    const notificationBackgroundMode = 'remote-notification';
+    if (!config.modResults.UIBackgroundModes.includes(notificationBackgroundMode)) {
+      config.modResults.UIBackgroundModes.push(notificationBackgroundMode);
+    }
+    return config;
+  });
+};
+
+const withNotificationSounds: ConfigPlugin<{ sounds: string[] }> = (config, { sounds }) => {
   return withXcodeProject(config, (config) => {
     setNotificationSounds(config.modRequest.projectRoot, {
       sounds,