feat(ios, messaging): Allow notifications in foreground on iOS, configure in firebase.json (#6407)

Author: ken0nek

.spellcheck.dict.txt

@@ -2,16 +2,16 @@
 64k
 Ad
 AdMob
-Analytics
+AirPods
 analytics
+Analytics
 ANR
 APIs
 APIs.
+APNs
 AppAttest
 AppCheck
 AppDelegate.m
-APNs
-AirPods
 async
 ATT
 ATT-compatible
@@ -22,16 +22,17 @@ AuthSettings
 autolinking
 Autolinking
 AVD
-Axios
 axios
+Axios
 backend
 backgrounded
 backoff
-Barcode
 barcode
+Barcode
 barcodes
 BUGFIX
 CarPlay
+CDN
 Changelog
 checkForUpdate
 CLI
@@ -40,16 +41,17 @@ codebase
 config
 Config
 config-plugin
+CP-User
 crashlytics
 Crashlytics
 datastore
 deprecations
 Deprecations
 Detox
 DEVEX
+DeviceCheck
 Diarmid
 Distribution
-DeviceCheck
 dropdown
 e2e
 EEA
@@ -61,47 +63,50 @@ Fastlane
 FCM
 firebase
 Firebase
-FirebaseApp
+firebase-admin
 firebase-ios-sdk
-Firestore
+FirebaseApp
 firestore
-getIdToken
+Firestore
 GDPR
 GDPR-compliant
+getIdToken
 github
 globals
-Gradle
 gradle
+Gradle
 Hesp
 Homebrew
 HTTP
 HTTPS
 IDFA
 installable
 integrations
+Intellisense
 IntelliSense
-Interstitials
 interstitials
-Invertase
+Interstitials
 invertase
+Invertase
 iOS
 iOS13
 IPs
 isTesterSignedIn
-Javascript
 javascript
+Javascript
 JS
 JSON
 lastDocument
 launchProperties
 learnt
 Lerna
+lifecycle
 MDX
-MLKit
 mlkit
+MLKit
 mono-repo
-Multidex
 multidex
+Multidex
 namespace
 namespaced
 natively
@@ -119,8 +124,8 @@ OpenID
 perf
 performant
 personalization
-Podfile
 plist
+Podfile
 pre-fetched
 pre-release
 pre-rendered
@@ -151,14 +156,16 @@ SDKs
 SDKs.
 serverless
 setBackgroundMessageHandler
-SHA1
 SHA
 SHA-256
+SHA1
 SIGABRT
 signInTester
 Siri
 SMS
+SNS
 src
+SSV
 stacktrace
 SVG
 TestLab
@@ -169,30 +176,24 @@ timezones
 triaging
 TypeDoc
 UI
-UIViewController
 uid
+UIViewController
 uncomment
 unhandled
+UNNotificationPresentationOptions
 unsubscriber
 untampered
 userData
 utils
 Utils
+v15
 v5
 v6
 v9
-v15
 VPN
 VSCode
 Wix
 Xcode
 Xcode.
-lifecycle
-SNS
-XMPP
 XCS
-firebase-admin
-SSV
-CP-User
-Intellisense
-CDN
+XMPP

docs/messaging/usage/index.md

@@ -386,6 +386,20 @@ async function registerAppWithFCM() {
 }
 ```
 
+## Foreground Presentation Options (iOS)
+
+React Native Firebase Messaging configures how to present a notification in a foreground app.
+Refer to [UNNotificationPresentationOptions](https://developer.apple.com/documentation/usernotifications/unnotificationpresentationoptions) for the details.
+
+```json
+// <projectRoot>/firebase.json
+{
+  "react-native": {
+    "messaging_ios_foreground_presentation_options": ["badge", "sound", "list", "banner"]
+  }
+}
+```
+
 ## Auto initialization
 
 Firebase generates an Instance ID, which FCM uses to generate a registration token and which Analytics uses for data collection.

packages/app/firebase-schema.json

@@ -94,6 +94,10 @@
           "description": "Whether RNFirebase Messaging automatically calls `[[UIApplication sharedApplication] registerForRemoteNotifications];`\nautomatically on app launch (recommended) - defaults to true.\n If set to false; make sure to call `firebase.messaging().registerDeviceForRemoteMessages()`\nearly on in your app startup - otherwise you will NOT receive remote messages/notifications\nin your app.\n",
           "type": "boolean"
         },
+        "messaging_ios_foreground_presentation_options": {
+          "description": "On iOS, indicating how to present a notification in a foreground app.",
+          "type": "array"
+        },
         "perf_auto_collection_enabled": {
           "description": "Disable or enable auto collection of performance monitoring data collection.\n This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.",
           "type": "boolean"

packages/app/ios/RNFBApp/RNFBJSON.h

@@ -25,6 +25,8 @@
 
 - (NSString *)getStringValue:(NSString *)key defaultValue:(NSString *)defaultValue;
 
+- (NSArray *)getArrayValue:(NSString *)key defaultValue:(NSArray *)defaultValue;
+
 - (NSDictionary *)getAll;
 
 - (NSString *)getRawJSON;

packages/app/ios/RNFBApp/RNFBJSON.m

@@ -75,6 +75,12 @@ - (NSString *)getStringValue:(NSString *)key defaultValue:(NSString *)defaultVal
   return string;
 }
 
+- (NSArray *)getArrayValue:(NSString *)key defaultValue:(NSArray *)defaultValue {
+  if ([_firebaseJson valueForKey:key] == nil) return defaultValue;
+  NSArray *array = [_firebaseJson valueForKey:key];
+  return array;
+}
+
 - (NSDictionary *)getAll {
   return [[NSDictionary alloc] initWithDictionary:_firebaseJson copyItems:YES];
 }

packages/messaging/ios/RNFBMessaging/RNFBMessaging+UNUserNotificationCenter.m

@@ -17,6 +17,7 @@
 
 #import <RNFBApp/RNFBRCTEventEmitter.h>
 
+#import "RNFBJSON.h"
 #import "RNFBMessaging+UNUserNotificationCenter.h"
 #import "RNFBMessagingSerializer.h"
 
@@ -82,6 +83,50 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center
        willPresentNotification:(UNNotification *)notification
          withCompletionHandler:
              (void (^)(UNNotificationPresentationOptions options))completionHandler {
+  NSArray *presentationOptionsConfig =
+      [[RNFBJSON shared] getArrayValue:@"messaging_ios_foreground_presentation_options"
+                          defaultValue:@[]];
+
+  UNNotificationPresentationOptions presentationOptions = UNNotificationPresentationOptionNone;
+
+  BOOL badge = [presentationOptionsConfig containsObject:@"badge"];
+  BOOL sound = [presentationOptionsConfig containsObject:@"sound"];
+  BOOL alert = [presentationOptionsConfig containsObject:@"alert"];
+  BOOL list = [presentationOptionsConfig containsObject:@"list"];
+  BOOL banner = [presentationOptionsConfig containsObject:@"banner"];
+
+  if (badge) {
+    presentationOptions |= UNNotificationPresentationOptionBadge;
+  }
+
+  if (sound) {
+    presentationOptions |= UNNotificationPresentationOptionSound;
+  }
+
+  // if list or banner is true, ignore `alert` property
+  if (banner || list) {
+    if (banner) {
+      if (@available(iOS 14, *)) {
+        presentationOptions |= UNNotificationPresentationOptionBanner;
+      } else {
+        // for iOS 13 we need to set `alert`
+        presentationOptions |= UNNotificationPresentationOptionAlert;
+      }
+    }
+
+    if (list) {
+      if (@available(iOS 14, *)) {
+        presentationOptions |= UNNotificationPresentationOptionList;
+      } else {
+        // for iOS 13 we need to set `alert`
+        presentationOptions |= UNNotificationPresentationOptionAlert;
+      }
+    }
+  } else if (alert) {
+    // TODO: Remove `alert` once iOS 14 becomes the minimum deployment target
+    presentationOptions |= UNNotificationPresentationOptionAlert;
+  }
+
   if (notification.request.content.userInfo[@"gcm.message_id"]) {
     NSDictionary *notificationDict = [RNFBMessagingSerializer notificationToDict:notification];
 
@@ -91,17 +136,15 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center
       [[RNFBRCTEventEmitter shared] sendEventWithName:@"messaging_message_received"
                                                  body:notificationDict];
     }
-
-    // TODO in a later version allow customising completion options in JS code
-    completionHandler(UNNotificationPresentationOptionNone);
+    completionHandler(presentationOptions);
   }
 
   if (_originalDelegate != nil && originalDelegateRespondsTo.willPresentNotification) {
     [_originalDelegate userNotificationCenter:center
                       willPresentNotification:notification
                         withCompletionHandler:completionHandler];
   } else {
-    completionHandler(UNNotificationPresentationOptionNone);
+    completionHandler(presentationOptions);
   }
 }