[Messaging] - Decline Registration when there is no APNS Token (#10590)

* [Messaging] - Decline Registration when there is no APNS Token

Author: aashishpatil-g

Diff for: FirebaseMessaging/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 10.4.0
+- [changed] On app startup, an APNS Token must be provided to FCM SDK before retrieving an FCM Token otherwise an error will be returned as part of the completion.
+
 # 10.3.0
 - [changed] Allow notification support on iOS 16 Simulator on Xcode 14 (#9968) (Reference: Xcode 14 Release Notes -> Simulator -> New Features: https://developer.apple.com/documentation/xcode-release-notes/xcode-14-release-notes)
 

Diff for: FirebaseMessaging/Sources/FIRMessaging.m

@@ -578,7 +578,7 @@ - (void)retrieveFCMTokenForSenderID:(nonnull NSString *)senderID
   } else {
     FIRMessagingLoggerWarn(kFIRMessagingMessageCodeAPNSTokenNotAvailableDuringTokenFetch,
                            @"APNS device token not set before retrieving FCM Token for Sender ID "
-                           @"'%@'. Notifications to this FCM Token will not be delivered over APNS."
+                           @"'%@'."
                            @"Be sure to re-retrieve the FCM token once the APNS device token is "
                            @"set.",
                            senderID);

Diff for: FirebaseMessaging/Sources/NSError+FIRMessaging.h

@@ -36,6 +36,7 @@ typedef NS_ENUM(NSUInteger, FIRMessagingErrorCode) {
   kFIRMessagingErrorCodeMissingAuthorizedEntity = 502,
   kFIRMessagingErrorCodeMissingScope = 503,
   kFIRMessagingErrorCodeMissingFid = 504,
+  kFIRMessagingErrorCodeMissingDeviceToken = 505,
 
   // Upstream send errors
   kFIRMessagingErrorCodeServiceNotAvailable = 1001,

Diff for: FirebaseMessaging/Sources/Token/FIRMessagingTokenManager.m

@@ -180,6 +180,20 @@ - (void)tokenWithAuthorizedEntity:(NSString *)authorizedEntity
     [tokenOptions addEntriesFromDictionary:options];
   }
 
+  // ensure we have an APNS Token
+  if (tokenOptions[kFIRMessagingTokenOptionsAPNSKey] == nil) {
+    // we don't have an APNS token. Don't fetch or return a FCM Token
+    FIRMessagingLoggerWarn(kFIRMessagingMessageCodeAPNSTokenNotAvailableDuringTokenFetch,
+                           @"Declining request for FCM Token since no APNS Token specified");
+    dispatch_async(dispatch_get_main_queue(), ^{
+      NSError *missingAPNSTokenError =
+          [NSError messagingErrorWithCode:kFIRMessagingErrorCodeMissingDeviceToken
+                            failureReason:@"No APNS token specified before fetching FCM Token"];
+      handler(nil, missingAPNSTokenError);
+    });
+    return;
+  }
+
 #if TARGET_OS_SIMULATOR && TARGET_OS_IOS
   if (tokenOptions[kFIRMessagingTokenOptionsAPNSKey] != nil) {
     // If APNS token is available on iOS Simulator, we must use the sandbox profile

Diff for: FirebaseMessaging/Tests/IntegrationTests/FIRMessagingPubSubTest.swift

@@ -35,6 +35,9 @@
 
     override func setUpWithError() throws {
       messaging = try XCTUnwrap(Messaging.messaging())
+      // fake APNS Token
+      messaging.apnsToken = "eb706b132b2f9270faac751e4ceab283f1803b729ac1dd399db3fd2a98bb101b"
+        .data(using: .utf8)
     }
 
     override func tearDown() {

Diff for: FirebaseMessaging/Tests/IntegrationTests/FIRMessagingTokenRefreshTests.swift

@@ -44,6 +44,9 @@
 
     override func setUpWithError() throws {
       messaging = try XCTUnwrap(Messaging.messaging())
+      // fake APNS Token
+      messaging.apnsToken = "eb706b132b2f9270faac751e4ceab283f1803b729ac1dd399db3fd2a98bb101b"
+        .data(using: .utf8)
     }
 
     override func tearDown() {

Diff for: FirebaseMessaging/Tests/UnitTests/FIRMessagingTest.m

@@ -206,6 +206,22 @@ - (void)testReturnsErrorWhenFetchingTokenWithoutSenderID {
   [self waitForExpectationsWithTimeout:0.1 handler:nil];
 }
 
+- (void)testReturnsErrorWhenFetchingTokenWithoutAPNSToken {
+  XCTestExpectation *expectation =
+      [self expectationWithDescription:@"Returned an error fetching token without APNS Token"];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wnonnull"
+  [self.messaging
+      retrieveFCMTokenForSenderID:@"12345"
+                       completion:^(NSString *_Nullable FCMToken, NSError *_Nullable error) {
+                         if (error != nil) {
+                           [expectation fulfill];
+                         }
+                       }];
+#pragma clang diagnostic pop
+  [self waitForExpectationsWithTimeout:0.1 handler:nil];
+}
+
 - (void)testReturnsErrorWhenFetchingTokenWithEmptySenderID {
   XCTestExpectation *expectation =
       [self expectationWithDescription:@"Returned an error fetching token with empty Sender ID"];