@react-native-firebase/messaging 16.7.0 → 17.1.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.1.0](https://github.com/invertase/react-native-firebase/compare/v17.0.0...v17.1.0) (2023-02-09)
+
+**Note:** Version bump only for package @react-native-firebase/messaging
+
+## [17.0.0](https://github.com/invertase/react-native-firebase/compare/v16.7.0...v17.0.0) (2023-02-02)
+
+### ⚠ BREAKING CHANGES
+
+- **app, ios:** You must have an APNS token before calling getToken to
+  get an FCM token on iOS. Previously it was not required. See documentation
+  for setAPNSToken if you are using getToken in testing or have disabled
+  FCM Swizzling, and use setAPNSToken to set a token before using getToken
+
+### Features
+
+- **app, ios:** adopt firebase-ios-sdk 10.4.0 ([1b8df4c](https://github.com/invertase/react-native-firebase/commit/1b8df4c8e55d474c09e301f9c7b58b6128ae6485))
+- **messaging, ios:** new setAPNSToken API / getToken works on M1 Simulator ([8d75b36](https://github.com/invertase/react-native-firebase/commit/8d75b36f485af07ecfa653192ca56f761d0cc5b7))
+
 ## [16.7.0](https://github.com/invertase/react-native-firebase/compare/v16.6.0...v16.7.0) (2023-01-28)
 
 **Note:** Version bump only for package @react-native-firebase/messaging

package/ios/RNFBMessaging/RNFBMessaging+NSNotificationCenter.m

@@ -87,12 +87,12 @@
         (RCTRootView *)[UIApplication sharedApplication].delegate.window.rootViewController.view;
   }
 
-#if !(TARGET_IPHONE_SIMULATOR)
+  // #if !(TARGET_IPHONE_SIMULATOR)
   if ([[RNFBJSON shared] getBooleanValue:@"messaging_ios_auto_register_for_remote_messages"
                             defaultValue:YES]) {
     [[UIApplication sharedApplication] registerForRemoteNotifications];
   }
-#endif
+  // #endif
 
   if (notification.userInfo[UIApplicationLaunchOptionsRemoteNotificationKey]) {
     if ([UIApplication sharedApplication].applicationState == UIApplicationStateBackground) {
@@ -108,7 +108,7 @@
         }
       }
 
-#if !(TARGET_IPHONE_SIMULATOR)
+      // #if !(TARGET_IPHONE_SIMULATOR)
       // When an app launches in the background (BG mode) and is launched with the notification
       // launch option the app delegate method
       // application:didReceiveRemoteNotification:fetchCompletionHandler: will not get called unless
@@ -118,7 +118,7 @@
       // `messaging_ios_auto_register_for_remote_messages` as this is most likely an app launching
       // as a result of a remote notification - so has been registered previously
       [[UIApplication sharedApplication] registerForRemoteNotifications];
-#endif
+      // #endif
     } else {
       if (rctRootView != nil) {
         isHeadless = NO;

package/ios/RNFBMessaging/RNFBMessagingModule.m

@@ -114,7 +114,6 @@ RCT_EXPORT_METHOD(getToken
                   : (NSString *)senderId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-#if !(TARGET_IPHONE_SIMULATOR)
   if ([UIApplication sharedApplication].isRegisteredForRemoteNotifications == NO) {
     [RNFBSharedUtils
         rejectPromiseWithUserInfo:reject
@@ -126,7 +125,14 @@ RCT_EXPORT_METHOD(getToken
                          }];
     return;
   }
-#endif
+
+  // As of firebase-ios-sdk 10.4.0, an APNS token is strictly required for getToken to work
+  NSData *apnsToken = [FIRMessaging messaging].APNSToken;
+  if (apnsToken == nil) {
+    DLog(@"RNFBMessaging getToken - no APNS token is available. Firebase requires an APNS token to "
+         @"vend an FCM token in firebase-ios-sdk 10.4.0 and higher. See documentation on "
+         @"setAPNSToken and getAPNSToken.")
+  }
 
   [[FIRMessaging messaging]
       retrieveFCMTokenForSenderID:senderId
@@ -160,7 +166,17 @@ RCT_EXPORT_METHOD(getAPNSToken : (RCTPromiseResolveBlock)resolve : (RCTPromiseRe
   if (apnsToken) {
     resolve([RNFBMessagingSerializer APNSTokenFromNSData:apnsToken]);
   } else {
-#if !(TARGET_IPHONE_SIMULATOR)
+#if TARGET_IPHONE_SIMULATOR
+#if !TARGET_CPU_ARM64
+    DLog(@"RNFBMessaging getAPNSToken - Simulator without APNS support detected, with no token "
+         @"set. Use setAPNSToken with an arbitrary string if needed for testing.")
+        resolve([NSNull null]);
+    return;
+#endif
+    DLog(@"RNFBMessaging getAPNSToken - ARM64 Simulator detected, but no APNS token set. Assuming "
+         @"APNS token is possible. macOS13+ / iOS16+ / M1 mac required for assumption to be valid. "
+         @"Use setAPNSToken in testing if needed.");
+#endif
     if ([UIApplication sharedApplication].isRegisteredForRemoteNotifications == NO) {
       [RNFBSharedUtils
           rejectPromiseWithUserInfo:reject
@@ -172,11 +188,28 @@ RCT_EXPORT_METHOD(getAPNSToken : (RCTPromiseResolveBlock)resolve : (RCTPromiseRe
                            }];
       return;
     }
-#endif
-    resolve([NSNull null]);
   }
 }
 
+RCT_EXPORT_METHOD(setAPNSToken
+                  : (NSString *)token
+                  : (NSString *)type
+                  : (RCTPromiseResolveBlock)resolve
+                  : (RCTPromiseRejectBlock)reject) {
+  // Default to unknown (determined by provisioning profile) type, but user may have passed type as
+  // param
+  FIRMessagingAPNSTokenType tokenType = FIRMessagingAPNSTokenTypeUnknown;
+  if (type != nil && [@"prod" isEqualToString:type]) {
+    tokenType = FIRMessagingAPNSTokenTypeProd;
+  } else if (type != nil && [@"sandbox" isEqualToString:type]) {
+    tokenType = FIRMessagingAPNSTokenTypeSandbox;
+  }
+
+  [[FIRMessaging messaging] setAPNSToken:[RNFBMessagingSerializer APNSTokenDataFromNSString:token]
+                                    type:tokenType];
+  resolve([NSNull null]);
+}
+
 RCT_EXPORT_METHOD(getIsHeadless : (RCTPromiseResolveBlock)resolve : (RCTPromiseRejectBlock)reject) {
   RNFBMessagingNSNotificationCenter *notifCenter =
       [RNFBMessagingNSNotificationCenter sharedInstance];
@@ -267,12 +300,19 @@ RCT_EXPORT_METHOD(registerForRemoteNotifications
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
 #if TARGET_IPHONE_SIMULATOR
+#if !TARGET_CPU_ARM64
+  // Do the registration on this unsupported simulator, but don't set up to wait for a token that
+  // won't arrive
+  [[UIApplication sharedApplication] registerForRemoteNotifications];
   resolve(@([RCTConvert BOOL:@(YES)]));
   return;
+#endif
+  DLog(@"RNFBMessaging registerForRemoteNotifications ARM64 Simulator detected, attempting real "
+       @"registration. macOS13+ / iOS16+ / M1 mac required or will timeout.")
 #endif
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wunreachable-code"
-  if (@available(iOS 10.0, *)) {
+      if (@available(iOS 10.0, *)) {
 #pragma pop
     if ([UIApplication sharedApplication].isRegisteredForRemoteNotifications == YES) {
       resolve(@([RCTConvert BOOL:@(YES)]));
@@ -286,7 +326,8 @@ RCT_EXPORT_METHOD(registerForRemoteNotifications
     dispatch_async(dispatch_get_main_queue(), ^{
       [[UIApplication sharedApplication] registerForRemoteNotifications];
     });
-  } else {
+  }
+  else {
     [RNFBSharedUtils
         rejectPromiseWithUserInfo:reject
                          userInfo:[@{

package/ios/RNFBMessaging/RNFBMessagingSerializer.h

@@ -21,6 +21,8 @@
 
 @interface RNFBMessagingSerializer : NSObject
 
++ (NSData *)APNSTokenDataFromNSString:(NSString *)token;
+
 + (NSString *)APNSTokenFromNSData:(NSData *)tokenData;
 
 + (NSDictionary *)notificationToDict:(UNNotification *)notification;

package/ios/RNFBMessaging/RNFBMessagingSerializer.m

@@ -20,6 +20,24 @@
 
 @implementation RNFBMessagingSerializer
 
++ (NSData *)APNSTokenDataFromNSString:(NSString *)token {
+  NSString *string = [token lowercaseString];
+  NSMutableData *data = [NSMutableData new];
+  unsigned char whole_byte;
+  char byte_chars[3] = {'\0', '\0', '\0'};
+  NSUInteger i = 0;
+  NSUInteger length = string.length;
+  while (i < length - 1) {
+    char c = [string characterAtIndex:i++];
+    if (c < '0' || (c > '9' && c < 'a') || c > 'f') continue;
+    byte_chars[0] = c;
+    byte_chars[1] = [string characterAtIndex:i++];
+    whole_byte = strtol(byte_chars, NULL, 16);
+    [data appendBytes:&whole_byte length:1];
+  }
+  return data;
+}
+
 + (NSString *)APNSTokenFromNSData:(NSData *)tokenData {
   const char *data = [tokenData bytes];
 

package/lib/index.d.ts

@@ -881,10 +881,43 @@ export namespace FirebaseMessagingTypes {
      * }
      * ```
      *
-     * @ios
+     * @platform ios
      */
     getAPNSToken(): Promise<string | null>;
 
+    /**
+     * On iOS, This method is used to set the APNs Token received by the application delegate.
+     * Note that the token is expected to be a hexadecimal string, as it is an NSData type in
+     * the underlying native firebase SDK, and raw data may only be passed as a string if it is
+     * hex encoded. Calling code is responsible for correct encoding, you should verify by comparing
+     * the results of `getAPNSToken()` with your token parameter to make sure they are equivalent
+     *
+     * Messaging uses method swizzling to ensure that the APNs token is set automatically.
+     * However, if you have disabled swizzling by setting FirebaseAppDelegateProxyEnabled to NO
+     * in your app’s Info.plist, you should manually set the APNs token in your application
+     * delegate’s application(_:didRegisterForRemoteNotificationsWithDeviceToken:) method.
+     *
+     * If you would like to set the type of the APNs token, rather than relying on automatic
+     * detection, provide a type of either 'prod', 'sandbox'. Omitting the type parameter
+     * or specifying 'unknown' will rely on automatic type detection based on provisioning profile.
+     *
+     * At a native level you may also call objective-c `[FIRMessaging setAPNSToken];` as needed
+     *
+     * > You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `null`.
+     *
+     * #### Example
+     *
+     * ```js
+     * let myAPNSToken = someOthermodule.someWayToGetAPNSToken();
+     * await firebase.messaging().setAPNSToken(myAPNSToken);
+     * ```
+     *
+     * @param token a hexadecimal string representing your APNS token
+     * @param type optional string specifying 'prod', 'sandbox' or 'unknown' token type
+     * @platform ios
+     */
+    setAPNSToken(token: string, type?: string): Promise<void>;
+
     /**
      * Returns a `AuthorizationStatus` as to whether the user has messaging permission for this app.
      *

package/lib/index.js

@@ -51,6 +51,7 @@ export {
   isDeviceRegisteredForRemoteMessages,
   unregisterDeviceForRemoteMessages,
   getAPNSToken,
+  setAPNSToken,
   hasPermission,
   onDeletedMessages,
   onMessageSent,
@@ -340,6 +341,27 @@ class FirebaseMessagingModule extends FirebaseModule {
     return this.native.getAPNSToken();
   }
 
+  /**
+   * @platform ios
+   */
+  setAPNSToken(token, type) {
+    if (isUndefined(token) || !isString(token)) {
+      throw new Error("firebase.messaging().setAPNSToken(*) 'token' expected a string value.");
+    }
+
+    if (!isUndefined(type) && (!isString(type) || !['prod', 'sandbox', 'unknown'].includes(type))) {
+      throw new Error(
+        "firebase.messaging().setAPNSToken(*) 'type' expected one of 'prod', 'sandbox', or 'unknown'.",
+      );
+    }
+
+    if (isAndroid) {
+      return Promise.resolve(null);
+    }
+
+    return this.native.setAPNSToken(token, type);
+  }
+
   hasPermission() {
     return this.native.hasPermission();
   }

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '16.7.0';
+module.exports = '17.1.0';

package/modular/index.js

@@ -176,6 +176,33 @@ export function getAPNSToken(messaging) {
   return messaging.getAPNSToken();
 }
 
+/**
+ * On iOS, This method is used to set the APNs Token received by the application delegate.
+ * Note that the token is expected to be a hexadecimal string, as it is an NSData type in
+ * the underlying native firebase SDK, and raw data may only be passed as a string if it is
+ * hex encoded. Calling code is responsible for correct encoding, you should verify by comparing
+ * the results of `getAPNSToken()` with your token parameter to make sure they are equivalent
+ *
+ * Messaging uses method swizzling to ensure that the APNs token is set automatically.
+ * However, if you have disabled swizzling by setting FirebaseAppDelegateProxyEnabled to NO
+ * in your app’s Info.plist, you should manually set the APNs token in your application
+ * delegate’s application(_:didRegisterForRemoteNotificationsWithDeviceToken:) method.
+ *
+ * If you would like to set the type of the APNs token, rather than relying on automatic
+ * detection, provide a type of either 'prod', 'sandbox'. Omitting the type parameter
+ * or specifying 'unknown' will rely on automatic type detection based on provisioning profile.
+ *
+ * At a native level you may also call objective-c `[FIRMessaging setAPNSToken];` as needed
+ *
+ * @param messaging Messaging instance.
+ * @param {string} token a hexadecimal string representing your APNS token
+ * @param {string?} type specifying 'prod', 'sandbox' or 'unknown' token type
+ * @returns {Promise<void>}
+ */
+export function setAPNSToken(messaging, token, type) {
+  return messaging.setAPNSToken(token, type);
+}
+
 /**
  * Returns a `AuthorizationStatus` as to whether the user has messaging permission for this app.
  * @param messaging Messaging instance.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/messaging",
-  "version": "16.7.0",
+  "version": "17.1.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration of Firebase Cloud Messaging (FCM) for both Android & iOS. FCM is a cost free service, allowing for server-device and device-device communication. The React Native Firebase Messaging module provides a simple JavaScript API to interact with FCM.",
   "main": "lib/index.js",
@@ -22,10 +22,10 @@
     "messaging"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "16.7.0"
+    "@react-native-firebase/app": "17.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a94f371da16f9bf873c18b09541cbeb19960978d"
+  "gitHead": "635d595389bfb224fc530681627fb2180fea6e26"
 }