feat(ios, messaging): add getIsHeadless method to access iOS launch state (#4304)

* Exposed getIsHeadless on the iOS messaging module

- Fixes: #4233

* Added platform annotation to method declaration

* Added documentation for getIsHeadless

* Fixed type typo

* Fixed ios isHeadless property

* Turned the isHeadless method into a launchedHeadless constant

* Apply suggestions from code review

* Update packages/messaging/lib/index.d.ts

* Revert "Turned the isHeadless method into a launchedHeadless constant"

This reverts commit c181528.

Co-authored-by: Mike Hardy <[email protected]>

Author: SudoPlz

docs/messaging/usage/index.md

@@ -295,6 +295,15 @@ RCTRootView *rootView = [[RCTRootView alloc] initWithBridge:bridge
                                              initialProperties:appProperties];
 ```
 
+- For projects that use react-native-navigation (or if you just don't want to mess with your launchProperties) you can use the `getIsHeadless` method (iOS only) from messaging like so:
+
+```jsx
+messaging().getIsHeadless().then(isHeadless => {
+  // do sth with isHeadless
+});
+
+```
+
 
 On Android, the `isHeadless` prop will not exist.
 

packages/messaging/ios/RNFBMessaging/RNFBMessaging+NSNotificationCenter.h

@@ -22,6 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
 @interface RNFBMessagingNSNotificationCenter : NSObject
 
 + (_Nonnull instancetype)sharedInstance;
+@property (nonatomic) BOOL isHeadless;
 
 @end
 

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

@@ -26,7 +26,7 @@
 #import "RNFBMessaging+FIRMessagingDelegate.h"
 
 @implementation RNFBMessagingNSNotificationCenter
-
+@synthesize isHeadless;
 + (instancetype)sharedInstance {
   static dispatch_once_t once;
   __strong static RNFBMessagingNSNotificationCenter *sharedInstance;
@@ -135,9 +135,10 @@ - (void)application_onDidFinishLaunchingNotification:(nonnull NSNotification *)n
   if (notification.userInfo[UIApplicationLaunchOptionsRemoteNotificationKey]) {
     if ([UIApplication sharedApplication].applicationState == UIApplicationStateBackground) {
       if (rctRootView != nil) {
+        isHeadless = YES;
         NSMutableDictionary *appPropertiesDict = rctRootView.appProperties != nil ? [rctRootView.appProperties mutableCopy] : [NSMutableDictionary dictionary];
         if([appPropertiesDict objectForKey:@"isHeadless"] != nil && [appPropertiesDict[@"isHeadless"] isEqual:@([RCTConvert BOOL:@(NO)])]) {
-          appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(YES)]);
+          appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(isHeadless)]);
           rctRootView.appProperties = appPropertiesDict;
         }
       }
@@ -153,19 +154,21 @@ - (void)application_onDidFinishLaunchingNotification:(nonnull NSNotification *)n
       #endif
     } else {
       if (rctRootView != nil) {
+        isHeadless = NO;
         NSMutableDictionary *appPropertiesDict = rctRootView.appProperties != nil ? [rctRootView.appProperties mutableCopy] : [NSMutableDictionary dictionary];
         if([appPropertiesDict objectForKey:@"isHeadless"] != nil && [appPropertiesDict[@"isHeadless"] isEqual:@([RCTConvert BOOL:@(YES)])]) {
-          appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(NO)]);
+          appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(isHeadless)]);
           rctRootView.appProperties = appPropertiesDict;
         }
 
       }
     }
   } else {
     if (rctRootView != nil) {
+      isHeadless = NO;
       NSMutableDictionary *appPropertiesDict = rctRootView.appProperties != nil ? [rctRootView.appProperties mutableCopy] : [NSMutableDictionary dictionary];
       if([appPropertiesDict objectForKey:@"isHeadless"] != nil && [appPropertiesDict[@"isHeadless"] isEqual:@([RCTConvert BOOL:@(YES)])]) {
-        appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(NO)]);
+        appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(isHeadless)]);
         rctRootView.appProperties = appPropertiesDict;
       }
 
@@ -182,10 +185,12 @@ - (void)application_onDidEnterForeground {
     [[UIApplication sharedApplication].delegate.window.rootViewController.view isKindOfClass:[RCTRootView class]]
   ) {
     RCTRootView *rctRootView = (RCTRootView *) [UIApplication sharedApplication].delegate.window.rootViewController.view;
+
     if (rctRootView.appProperties != nil && rctRootView.appProperties[@"isHeadless"] == @(YES)) {
       NSMutableDictionary *appPropertiesDict = [rctRootView.appProperties mutableCopy];
+      isHeadless = NO;
       if([appPropertiesDict objectForKey:@"isHeadless"] != nil && [appPropertiesDict[@"isHeadless"] isEqual:@([RCTConvert BOOL:@(YES)])]) {
-        appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(NO)]);
+        appPropertiesDict[@"isHeadless"] = @([RCTConvert BOOL:@(isHeadless)]);
         rctRootView.appProperties = appPropertiesDict;
       }
     }

packages/messaging/ios/RNFBMessaging/RNFBMessagingModule.m

@@ -24,6 +24,7 @@
 #import "RNFBMessagingSerializer.h"
 #import "RNFBMessaging+AppDelegate.h"
 #import "RNFBMessaging+UNUserNotificationCenter.h"
+#import "RNFBMessaging+NSNotificationCenter.h"
 
 @implementation RNFBMessagingModule
 #pragma mark -
@@ -164,6 +165,15 @@ - (NSDictionary *)constantsToExport {
   }
 }
 
+RCT_EXPORT_METHOD(getIsHeadless
+    :(RCTPromiseResolveBlock) resolve
+    :(RCTPromiseRejectBlock) reject
+) {
+    RNFBMessagingNSNotificationCenter* notifCenter = [RNFBMessagingNSNotificationCenter sharedInstance];
+
+    return resolve(@([RCTConvert BOOL:@(notifCenter.isHeadless)]));
+}
+
 RCT_EXPORT_METHOD(requestPermission:
   (NSDictionary *) permissions
     :(RCTPromiseResolveBlock) resolve

packages/messaging/lib/index.d.ts

@@ -610,6 +610,15 @@ export namespace FirebaseMessagingTypes {
      */
     getToken(authorizedEntity?: string, scope?: string): Promise<string>;
 
+    /**
+     * Returns wether the root view is headless or not
+     * i.e true if the app was launched in the background (for example, by data-only cloud message)
+     *
+     * More info: https://rnfirebase.io/messaging/usage#background-application-state
+     * @platform ios iOS
+     */
+    getIsHeadless(): Promise<boolean>;
+
     /**
      * Removes access to an FCM token previously authorized by it's scope. Messages sent by the server
      * to this token will fail.

packages/messaging/lib/index.js

@@ -126,6 +126,10 @@ class FirebaseMessagingModule extends FirebaseModule {
     return this.native.getInitialNotification();
   }
 
+  getIsHeadless() {
+    return this.native.getIsHeadless();
+  }
+
   getToken(authorizedEntity, scope) {
     if (!isUndefined(authorizedEntity) && !isString(authorizedEntity)) {
       throw new Error(