Remove instanceID dependency from Messaging (#6103)

Author: charlotteliang

FirebaseMessaging.podspec

@@ -39,7 +39,10 @@ device, and it is completely free.
     'GoogleUtilities/Reachability/Private/*.h',
     'GoogleUtilities/UserDefaults/Private/*.h',
   ]
-  s.requires_arc = base_dir + 'Sources/*.m'
+  s.requires_arc = [
+    base_dir + 'Sources/*.m',
+    base_dir + 'Sources/Token/*.m'
+  ]
   s.public_header_files = base_dir + 'Sources/Public/*.h'
   s.library = 'sqlite3'
   s.pod_target_xcconfig = {
@@ -55,7 +58,7 @@ device, and it is completely free.
   s.osx.framework = 'SystemConfiguration'
   s.weak_framework = 'UserNotifications'
   s.dependency 'FirebaseCore', '~> 6.8'
-  s.dependency 'FirebaseInstanceID', '~> 4.3'
+  s.dependency 'FirebaseInstallations', '~> 1.5'
   s.dependency 'GoogleUtilities/AppDelegateSwizzler', '~> 6.7'
   s.dependency 'GoogleUtilities/Reachability', '~> 6.7'
   s.dependency 'GoogleUtilities/Environment', '~> 6.7'

FirebaseMessaging/Apps/Sample/Sample/SceneDelegate.swift

@@ -15,7 +15,6 @@
 import Combine
 import UIKit
 import SwiftUI
-import FirebaseInstanceID
 import FirebaseMessaging
 import FirebaseInstallations
 
@@ -67,8 +66,8 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate, MessagingDelegate {
             return
           }
           self.identity.instanceID = fid
-          })
         })
+      })
       .store(in: &cancellables)
   }
 

FirebaseMessaging/Apps/Sample/iOS/NotificationsController.swift

@@ -54,7 +54,7 @@ class NotificationsController: NSObject {
                               completionHandler: { granted, error in
                                 NotificationCenter.default
                                   .post(name: UserNotificationsChangedNotification, object: nil)
-        })
+      })
     } else if #available(iOS 8.0, *) {
       let userNotificationSettings = UIUserNotificationSettings(types: [.alert, .badge, .sound],
                                                                 categories: [])

FirebaseMessaging/Sources/FIRMessaging.m

@@ -22,6 +22,7 @@
 @class FIRMessagingConnection;
 @class FIRMessagingDataMessageManager;
 @class FIRMessagingRmqManager;
+@class FIRMessagingTokenManager;
 
 /**
  *  Callback to handle MCS connection requests.
@@ -45,11 +46,13 @@ typedef void (^FIRMessagingConnectCompletionHandler)(NSError *error);
 
 @property(nonatomic, readonly, strong) FIRMessagingConnection *connection;
 @property(nonatomic, readwrite, weak) FIRMessagingDataMessageManager *dataMessageManager;
+@property(nonatomic, readonly, strong) FIRMessagingTokenManager *tokenManager;
 
 // Designated initializer
 - (instancetype)initWithDelegate:(id<FIRMessagingClientDelegate>)delegate
                     reachability:(GULReachabilityChecker *)reachability
-                     rmq2Manager:(FIRMessagingRmqManager *)rmq2Manager;
+                     rmq2Manager:(FIRMessagingRmqManager *)rmq2Manager
+                    tokenManager:(FIRMessagingTokenManager *)tokenManager;
 
 - (void)teardown;
 

FirebaseMessaging/Sources/FIRMessagingClient.h

@@ -18,7 +18,6 @@
 
 #import "FirebaseMessaging/Sources/Protos/GtalkCore.pbobjc.h"
 
-#import <FirebaseInstanceID/FIRInstanceID_Private.h>
 #import <FirebaseMessaging/FIRMessaging.h>
 #import "GoogleUtilities/Reachability/Private/GULReachabilityChecker.h"
 
@@ -32,6 +31,7 @@
 #import "FirebaseMessaging/Sources/FIRMessagingTopicsCommon.h"
 #import "FirebaseMessaging/Sources/FIRMessagingUtilities.h"
 #import "FirebaseMessaging/Sources/NSError+FIRMessaging.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingTokenManager.h"
 
 static const NSTimeInterval kConnectTimeoutInterval = 40.0;
 static const NSTimeInterval kReconnectDelayInSeconds = 2 * 60;  // 2 minutes
@@ -85,6 +85,7 @@ @interface FIRMessagingClient () <FIRMessagingConnectionDelegate>
 // FIRMessagingService owns these instances
 @property(nonatomic, readwrite, weak) FIRMessagingRmqManager *rmq2Manager;
 @property(nonatomic, readwrite, weak) GULReachabilityChecker *reachability;
+@property(nonatomic, readwrite, strong) FIRMessagingTokenManager *tokenManager;
 
 @property(nonatomic, readwrite, assign) int64_t lastConnectedTimestamp;
 @property(nonatomic, readwrite, assign) int64_t lastDisconnectedTimestamp;
@@ -114,12 +115,14 @@ - (instancetype)init {
 
 - (instancetype)initWithDelegate:(id<FIRMessagingClientDelegate>)delegate
                     reachability:(GULReachabilityChecker *)reachability
-                     rmq2Manager:(FIRMessagingRmqManager *)rmq2Manager {
+                     rmq2Manager:(FIRMessagingRmqManager *)rmq2Manager
+                    tokenManager:(FIRMessagingTokenManager *)tokenManager {
   self = [super init];
   if (self) {
     _reachability = reachability;
     _clientDelegate = delegate;
     _rmq2Manager = rmq2Manager;
+    _tokenManager = tokenManager;
     _registrar = [[FIRMessagingPubSubRegistrar alloc] init];
     _connectionTimeoutInterval = kConnectTimeoutInterval;
     // Listen for checkin fetch notifications, as connecting to MCS may have failed due to
@@ -188,9 +191,9 @@ - (void)updateSubscriptionWithToken:(NSString *)token
     }
   };
 
-  if ([[FIRInstanceID instanceID] tryToLoadValidCheckinInfo]) {
+  if ([_tokenManager hasValidCheckinInfo]) {
     [self.registrar updateSubscriptionToTopic:topic
-                                    withToken:token
+                             withTokenManager:_tokenManager
                                       options:options
                                  shouldDelete:shouldDelete
                                       handler:completion];
@@ -289,7 +292,7 @@ - (void)connect {
   }
 
   self.stayConnected = YES;
-  if (![[FIRInstanceID instanceID] tryToLoadValidCheckinInfo]) {
+  if (![_tokenManager hasValidCheckinInfo]) {
     // Checkin info is not available. This may be due to the checkin still being fetched.
     NSString *failureReason = @"Failed to connect to MCS. No deviceID and secret found.";
     if (self.connectHandler) {
@@ -378,8 +381,8 @@ - (void)didLoginWithConnection:(FIRMessagingConnection *)fcmConnection {
   self.connectRetryCount = 0;
   self.lastConnectedTimestamp = FIRMessagingCurrentTimestampInMilliseconds();
 
-  [self.dataMessageManager setDeviceAuthID:[FIRInstanceID instanceID].deviceAuthID
-                               secretToken:[FIRInstanceID instanceID].secretToken];
+  [self.dataMessageManager setDeviceAuthID:_tokenManager.deviceAuthID
+                               secretToken:_tokenManager.secretToken];
   if (self.connectHandler) {
     self.connectHandler(nil);
     // notified the third party app with the registrationId.
@@ -429,14 +432,13 @@ - (void)setupConnection {
     [self.connection signOut];
     self.connection.delegate = nil;
   }
-  self.connection =
-      [[FIRMessagingConnection alloc] initWithAuthID:[FIRInstanceID instanceID].deviceAuthID
-                                               token:[FIRInstanceID instanceID].secretToken
-                                                host:host
-                                                port:port
-                                             runLoop:[NSRunLoop mainRunLoop]
-                                         rmq2Manager:self.rmq2Manager
-                                          fcmManager:self.dataMessageManager];
+  self.connection = [[FIRMessagingConnection alloc] initWithAuthID:_tokenManager.deviceAuthID
+                                                             token:_tokenManager.secretToken
+                                                              host:host
+                                                              port:port
+                                                           runLoop:[NSRunLoop mainRunLoop]
+                                                       rmq2Manager:self.rmq2Manager
+                                                        fcmManager:self.dataMessageManager];
   self.connection.delegate = self;
 }
 
@@ -449,8 +451,8 @@ - (void)tryToConnect {
   [NSObject cancelPreviousPerformRequestsWithTarget:self
                                            selector:@selector(tryToConnect)
                                              object:nil];
-  NSString *deviceAuthID = [FIRInstanceID instanceID].deviceAuthID;
-  NSString *secretToken = [FIRInstanceID instanceID].secretToken;
+  NSString *deviceAuthID = _tokenManager.deviceAuthID;
+  NSString *secretToken = _tokenManager.secretToken;
   if (deviceAuthID.length == 0 || secretToken.length == 0 || !self.connection) {
     FIRMessagingLoggerWarn(
         kFIRMessagingMessageCodeClientInvalidState,

FirebaseMessaging/Sources/FIRMessagingClient.m

@@ -36,10 +36,10 @@ typedef NS_ENUM(NSInteger, FIRMessagingMessageCode) {
   kFIRMessagingMessageCodeMessaging012 = 2012,                  // I-FCM002012
   kFIRMessagingMessageCodeMessaging013 = 2013,                  // I-FCM002013
   kFIRMessagingMessageCodeMessaging014 = 2014,                  // I-FCM002014
-  kFIRMessagingMessageCodeMessaging015 = 2015,                  // I-FCM002015
-  kFIRMessagingMessageCodeMessaging016 = 2016,                  // I-FCM002016 - no longer used
-  kFIRMessagingMessageCodeMessaging017 = 2017,                  // I-FCM002017
-  kFIRMessagingMessageCodeMessaging018 = 2018,                  // I-FCM002018
+  kFIRMessagingMessageCodeMessaging015 = 2015,
+  kFIRMessagingMessageCodeMessaging016 = 2016,  // I-FCM002016 - no longer used
+  kFIRMessagingMessageCodeMessaging017 = 2017,  // I-FCM002017
+  kFIRMessagingMessageCodeMessaging018 = 2018,  // I-FCM002018
   kFIRMessagingMessageCodeRemoteMessageDelegateMethodNotImplemented = 2019,  // I-FCM002019
   kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenFetch = 2020,           // I-FCM002020
   kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenDelete = 2021,          // I-FCM002021
@@ -206,4 +206,121 @@ typedef NS_ENUM(NSInteger, FIRMessagingMessageCode) {
   // FIRMessagingCodedInputStream.m
   kFIRMessagingCodeInputStreamInvalidParameters = 21000,
 
+  kFIRMessagingMessageCodeFIRApp002 = 22002,
+  kFIRMessagingMessageCodeInternal001 = 22001,
+  kFIRMessagingMessageCodeInternal002 = 22002,
+  // FIRMessaging.m
+  // DO NOT USE 4000.
+  kFIRMessagingMessageCodeInstanceID000 = 23000,
+  kFIRMessagingMessageCodeInstanceID001 = 23001,
+  kFIRMessagingMessageCodeInstanceID002 = 23002,
+  kFIRMessagingMessageCodeInstanceID003 = 23003,
+  kFIRMessagingMessageCodeInstanceID004 = 23004,
+  kFIRMessagingMessageCodeInstanceID005 = 23005,
+  kFIRMessagingMessageCodeInstanceID006 = 23006,
+  kFIRMessagingMessageCodeInstanceID007 = 23007,
+  kFIRMessagingMessageCodeInstanceID008 = 23008,
+  kFIRMessagingMessageCodeInstanceID009 = 23009,
+  kFIRMessagingMessageCodeInstanceID010 = 23010,
+  kFIRMessagingMessageCodeInstanceID011 = 23011,
+  kFIRMessagingMessageCodeInstanceID012 = 23012,
+  kFIRMessagingMessageCodeInstanceID013 = 23013,
+  kFIRMessagingMessageCodeInstanceID014 = 23014,
+  kFIRMessagingMessageCodeInstanceID015 = 23015,
+  kFIRMessagingMessageCodeRefetchingTokenForAPNS = 23016,
+  kFIRMessagingMessageCodeInstanceID017 = 23017,
+  kFIRMessagingMessageCodeInstanceID018 = 23018,
+  // FIRMessagingAuthService.m
+  kFIRMessagingMessageCodeAuthService000 = 25000,
+  kFIRMessagingMessageCodeAuthService001 = 25001,
+  kFIRMessagingMessageCodeAuthService002 = 25002,
+  kFIRMessagingMessageCodeAuthService003 = 25003,
+  kFIRMessagingMessageCodeAuthService004 = 25004,
+  kFIRMessagingMessageCodeAuthServiceCheckinInProgress = 25004,
+
+  // FIRMessagingBackupExcludedPlist.m
+  // Do NOT USE 6003
+  kFIRMessagingMessageCodeBackupExcludedPlist000 = 26000,
+  kFIRMessagingMessageCodeBackupExcludedPlist001 = 26001,
+  kFIRMessagingMessageCodeBackupExcludedPlist002 = 26002,
+  // FIRMessagingCheckinService.m
+  kFIRMessagingMessageCodeService000 = 27000,
+  kFIRMessagingMessageCodeService001 = 27001,
+  kFIRMessagingMessageCodeService002 = 27002,
+  kFIRMessagingMessageCodeService003 = 27003,
+  kFIRMessagingMessageCodeService004 = 27004,
+  kFIRMessagingMessageCodeService005 = 27005,
+  kFIRMessagingMessageCodeService006 = 27006,
+  kFIRMessagingInvalidSettingResponse = 27008,
+  // FIRMessagingCheckinStore.m
+  // DO NOT USE 8002, 8004 - 8008
+  kFIRMessagingMessageCodeCheckinStore000 = 28000,
+  kFIRMessagingMessageCodeCheckinStore001 = 28001,
+  kFIRMessagingMessageCodeCheckinStore003 = 28003,
+  kFIRMessagingMessageCodeCheckinStoreCheckinPlistDeleted = 28009,
+  kFIRMessagingMessageCodeCheckinStoreCheckinPlistSaved = 28010,
+
+  // DO NOT USE 9000 - 9006
+
+  // DO NOT USE 10000 - 10009
+
+  // DO NOT USE 11000 - 11002
+
+  // DO NOT USE 12000 - 12014
+
+  // DO NOT USE 13004, 13005, 13007, 13008, 13010, 13011, 13013, 13014
+  kFIRMessagingMessageCodeStore000 = 33000,
+  kFIRMessagingMessageCodeStore002 = 33002,
+  kFIRMessagingMessageCodeStore003 = 33003,
+  kFIRMessagingMessageCodeStore006 = 33006,
+  kFIRMessagingMessageCodeStore009 = 33009,
+  kFIRMessagingMessageCodeStore012 = 33012,
+  // FIRMessagingTokenManager.m
+  // DO NOT USE 14002, 14005
+  kFIRMessagingMessageCodeTokenManager000 = 34000,
+  kFIRMessagingMessageCodeTokenManager001 = 34001,
+  kFIRMessagingMessageCodeTokenManager003 = 34003,
+  kFIRMessagingMessageCodeTokenManager004 = 34004,
+  kFIRMessagingMessageCodeTokenManagerErrorDeletingFCMTokensOnAppReset = 34006,
+  kFIRMessagingMessageCodeTokenManagerDeletedFCMTokensOnAppReset = 34007,
+  kFIRMessagingMessageCodeTokenManagerSavedAppVersion = 34008,
+  kFIRMessagingMessageCodeTokenManagerErrorInvalidatingAllTokens = 34009,
+  kFIRMessagingMessageCodeTokenManagerAPNSChanged = 34010,
+  kFIRMessagingMessageCodeTokenManagerAPNSChangedTokenInvalidated = 34011,
+  kFIRMessagingMessageCodeTokenManagerInvalidateStaleToken = 34012,
+  // FIRMessagingTokenStore.m
+  // DO NOT USE 15002 - 15013
+  kFIRMessagingMessageCodeTokenStore000 = 35000,
+  kFIRMessagingMessageCodeTokenStore001 = 35001,
+  kFIRMessagingMessageCodeTokenStoreExceptionUnarchivingTokenInfo = 35015,
+
+  // DO NOT USE 16000, 18004
+
+  // FIRMessagingUtilities.m
+  kFIRMessagingMessageCodeUtilitiesMissingBundleIdentifier = 38000,
+  kFIRMessagingMessageCodeUtilitiesAppEnvironmentUtilNotAvailable = 38001,
+  kFIRMessagingMessageCodeUtilitiesCannotGetHardwareModel = 38002,
+  kFIRMessagingMessageCodeUtilitiesCannotGetSystemVersion = 38003,
+  // FIRMessagingTokenOperation.m
+  kFIRMessagingMessageCodeTokenOperationFailedToSignParams = 39000,
+  // FIRMessagingTokenFetchOperation.m
+  // DO NOT USE 40004, 40005
+  kFIRMessagingMessageCodeTokenFetchOperationFetchRequest = 40000,
+  kFIRMessagingMessageCodeTokenFetchOperationRequestError = 40001,
+  kFIRMessagingMessageCodeTokenFetchOperationBadResponse = 40002,
+  kFIRMessagingMessageCodeTokenFetchOperationBadTokenStructure = 40003,
+  // FIRMessagingTokenDeleteOperation.m
+  kFIRMessagingMessageCodeTokenDeleteOperationFetchRequest = 41000,
+  kFIRMessagingMessageCodeTokenDeleteOperationRequestError = 41001,
+  kFIRMessagingMessageCodeTokenDeleteOperationBadResponse = 41002,
+  // FIRMessagingTokenInfo.m
+  kFIRMessagingMessageCodeTokenInfoBadAPNSInfo = 42000,
+  kFIRMessagingMessageCodeTokenInfoFirebaseAppIDChanged = 42001,
+  kFIRMessagingMessageCodeTokenInfoLocaleChanged = 42002,
+  // FIRMessagingKeychain.m
+  kFIRMessagingKeychainReadItemError = 43000,
+  kFIRMessagingKeychainAddItemError = 43001,
+  kFIRMessagingKeychainDeleteItemError = 43002,
+  kFIRMessagingKeychainCreateKeyPairError = 43003,
+  kFIRMessagingKeychainUpdateItemError = 43004,
 };

FirebaseMessaging/Sources/FIRMMessageCode.h renamed to FirebaseMessaging/Sources/FIRMessagingCode.h

@@ -16,7 +16,7 @@
 
 #import "FirebaseMessaging/Sources/FIRMessagingCodedInputStream.h"
 
-#import "FirebaseMessaging/Sources/FIRMMessageCode.h"
+#import "FirebaseMessaging/Sources/FIRMessagingCode.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 
 typedef struct {

FirebaseMessaging/Sources/FIRMessagingCodedInputStream.m

@@ -46,11 +46,52 @@ FOUNDATION_EXPORT NSString *const kFIRMessagingRemoteNotificationsProxyEnabledIn
 
 FOUNDATION_EXPORT NSString *const kFIRMessagingSubDirectoryName;
 
-// Notifications
+#pragma mark - Notifications
+
 FOUNDATION_EXPORT NSString *const kFIRMessagingCheckinFetchedNotification;
 FOUNDATION_EXPORT NSString *const kFIRMessagingAPNSTokenNotification;
+FOUNDATION_EXPORT NSString *const kFIRMessagingDefaultGCMTokenFailNotification;
 FOUNDATION_EXPORT NSString *const kFIRMessagingRegistrationTokenRefreshNotification;
 
 FOUNDATION_EXPORT const int kFIRMessagingSendTtlDefault;  // 24 hours
 
+/**
+ *  Value included in a structured response or GCM message from IID, indicating
+ *  an identity reset.
+ */
+FOUNDATION_EXPORT NSString *const kFIRMessaging_CMD_RST;
+
+#pragma mark - Miscellaneous
+
+/// The scope used to save the IID "*" scope token. This is used for saving the
+/// IID auth token that we receive from the server. This feature was never
+/// implemented on the server side.
+FOUNDATION_EXPORT NSString *const kFIRMessagingAllScopeIdentifier;
+/// The scope used to save the IID "*" scope token.
+FOUNDATION_EXPORT NSString *const kFIRMessagingDefaultTokenScope;
+
+/// Subdirectory in search path directory to store InstanceID preferences.
+FOUNDATION_EXPORT NSString *const kFIRMessagingInstanceIDSubDirectoryName;
+
+/// The key for APNS token in options dictionary.
+FOUNDATION_EXPORT NSString *const kFIRMessagingTokenOptionsAPNSKey;
+
+/// The key for APNS token environment type in options dictionary.
+FOUNDATION_EXPORT NSString *const kFIRMessagingTokenOptionsAPNSIsSandboxKey;
+
+/// The key for GMP AppID sent in registration requests.
+FOUNDATION_EXPORT NSString *const kFIRMessagingTokenOptionsFirebaseAppIDKey;
+
+FOUNDATION_EXPORT NSString *const kFIRMessagingAPNSTokenType;
+
+/// The key to enable auto-register by swizzling AppDelegate's methods.
+FOUNDATION_EXPORT NSString *const kFIRMessagingAppDelegateProxyEnabledInfoPlistKey;
+
+/// Error code for missing entitlements in Keychain. iOS Keychain error
+/// https://forums.developer.apple.com/thread/4743
+FOUNDATION_EXPORT const int kFIRMessagingSecMissingEntitlementErrorCode;
+
+/// The key for InstallationID or InstanceID in token request.
+FOUNDATION_EXPORT NSString *const kFIRMessagingParamInstanceID;
+
 #endif