Should only have only one local cache of token (#7233)

Author: charlotteliang

FirebaseMessaging/Apps/Shared/ContentView.swift

@@ -60,6 +60,7 @@ struct ContentView: View {
           }
 
           // MARK: Action buttons
+
           VStack(alignment: .leading) {
             Text("getToken")
               .fontWeight(.semibold)

FirebaseMessaging/Sources/FIRMessaging.m

@@ -19,22 +19,22 @@
 #error FIRMessagingLib should be compiled with ARC.
 #endif
 
-#import "GoogleUtilities/AppDelegateSwizzler/Public/GoogleUtilities/GULAppDelegateSwizzler.h"
-#import "GoogleUtilities/Environment/Public/GoogleUtilities/GULAppEnvironmentUtil.h"
-#import "GoogleUtilities/Reachability/Public/GoogleUtilities/GULReachabilityChecker.h"
-#import "GoogleUtilities/UserDefaults/Public/GoogleUtilities/GULUserDefaults.h"
 #import "FirebaseMessaging/Sources/Public/FirebaseMessaging/FIRMessaging.h"
 #import "Firebase/InstanceID/Private/FIRInstanceID_Private.h"
-#import "FirebaseInstallations/Source/Library/Public/FirebaseInstallations/FirebaseInstallations.h"
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
+#import "FirebaseInstallations/Source/Library/Public/FirebaseInstallations/FirebaseInstallations.h"
 #import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
 #import "FirebaseMessaging/Sources/Public/FirebaseMessaging/FIRMessagingExtensionHelper.h"
+#import "GoogleUtilities/AppDelegateSwizzler/Public/GoogleUtilities/GULAppDelegateSwizzler.h"
+#import "GoogleUtilities/Environment/Public/GoogleUtilities/GULAppEnvironmentUtil.h"
+#import "GoogleUtilities/Reachability/Public/GoogleUtilities/GULReachabilityChecker.h"
+#import "GoogleUtilities/UserDefaults/Public/GoogleUtilities/GULUserDefaults.h"
 #import "Interop/Analytics/Public/FIRAnalyticsInterop.h"
 
 #import "FirebaseMessaging/Sources/FIRMessagingAnalytics.h"
+#import "FirebaseMessaging/Sources/FIRMessagingCode.h"
 #import "FirebaseMessaging/Sources/FIRMessagingConstants.h"
 #import "FirebaseMessaging/Sources/FIRMessagingContextManagerService.h"
-#import "FirebaseMessaging/Sources/FIRMessagingCode.h"
 #import "FirebaseMessaging/Sources/FIRMessagingDefines.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 #import "FirebaseMessaging/Sources/FIRMessagingPubSub.h"
@@ -106,7 +106,6 @@ @interface FIRMessaging () <GULReachabilityDelegate>
 
 // FIRApp properties
 @property(nonatomic, readwrite, strong) NSData *apnsTokenData;
-@property(nonatomic, readwrite, strong) NSString *defaultFcmToken;
 @property(nonatomic, readwrite, strong) FIRMessagingClient *client;
 @property(nonatomic, readwrite, strong) GULReachabilityChecker *reachability;
 @property(nonatomic, readwrite, strong) FIRMessagingPubSub *pubsub;
@@ -247,6 +246,11 @@ - (void)didCompleteConfigure {
                                completion:^(NSString *_Nullable FCMToken, NSError *_Nullable error){
                                }];
       }
+      // Set the default FCM token, there's an issue that FIRApp configure
+      // happens before developers able to set the delegate
+      // Hence first token set must be happen here after listener is set
+      // TODO(chliangGoogle) Need to investigate better solution.
+      [self updateDefaultFCMToken:self.FCMToken];
     }];
   } else if (self.isAutoInitEnabled) {
     // When there is no cached token, must check auto init is enabled.
@@ -315,7 +319,7 @@ - (void)setupNotificationListeners {
   NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
   [center removeObserver:self];
   [center addObserver:self
-             selector:@selector(defaultInstanceIDTokenWasRefreshed:)
+             selector:@selector(defaultFCMTokenWasRefreshed:)
                  name:kFIRMessagingRegistrationTokenRefreshNotification
                object:nil];
 }
@@ -326,7 +330,7 @@ - (void)setupRmqManager {
 }
 
 - (void)setupTopics {
-  self.pubsub = [[FIRMessagingPubSub alloc] initWithTokenManager:_tokenManager];
+  self.pubsub = [[FIRMessagingPubSub alloc] initWithTokenManager:self.tokenManager];
 }
 
 - (void)setupSyncMessageManager {
@@ -540,7 +544,8 @@ - (void)setAutoInitEnabled:(BOOL)autoInitEnabled {
 
 - (NSString *)FCMToken {
   // Gets the current default token, and requets a new one if it doesn't exist.
-  return [[FIRMessaging messaging].tokenManager tokenAndRequestIfNotExist];
+  NSString *token = [self.tokenManager tokenAndRequestIfNotExist];
+  return token;
 }
 
 - (void)tokenWithCompletion:(FIRMessagingFCMTokenFetchCompletion)completion {
@@ -625,7 +630,7 @@ - (void)deleteFCMTokenForSenderID:(nonnull NSString *)senderID
 
 - (void)deleteDataWithCompletion:(void (^)(NSError *_Nullable))completion {
   FIRMessaging_WEAKIFY(self);
-  [self.tokenManager deleteWithHandler:^(NSError * error) {
+  [self.tokenManager deleteWithHandler:^(NSError *error) {
     FIRMessaging_STRONGIFY(self);
     if (error) {
       if (completion) {
@@ -637,8 +642,7 @@ - (void)deleteDataWithCompletion:(void (^)(NSError *_Nullable))completion {
     // enabled.
     if ([self isAutoInitEnabled]) {
       // Deletion succeeds! Requesting new checkin, IID and token.
-      [self tokenWithCompletion:^(NSString *_Nullable token,
-                                  NSError *_Nullable error) {
+      [self tokenWithCompletion:^(NSString *_Nullable token, NSError *_Nullable error) {
         if (completion) {
           completion(error);
         }
@@ -829,20 +833,23 @@ - (FIRMessagingNetworkStatus)networkType {
 
 #pragma mark - Notifications
 
-- (void)defaultInstanceIDTokenWasRefreshed:(NSNotification *)notification {
+- (void)defaultFCMTokenWasRefreshed:(NSNotification *)notification {
   if (notification.object && ![notification.object isKindOfClass:[NSString class]]) {
     FIRMessagingLoggerDebug(kFIRMessagingMessageCodeMessaging015,
                             @"Invalid default FCM token type %@",
                             NSStringFromClass([notification.object class]));
     return;
   }
-  // Retrieve the Instance ID default token, and should notify delegate and
-  // trigger notification as long as the token is different from previous state.
-  NSString *oldToken = self.defaultFcmToken;
-  self.defaultFcmToken = [(NSString *)notification.object copy];
-  if ((self.defaultFcmToken.length && oldToken.length &&
-       ![self.defaultFcmToken isEqualToString:oldToken]) ||
-      self.defaultFcmToken.length != oldToken.length) {
+  NSString *newToken = [(NSString *)notification.object copy];
+  [self updateDefaultFCMToken:newToken];
+}
+
+- (void)updateDefaultFCMToken:(NSString *)defaultFCMToken {
+  NSString *oldToken = self.tokenManager.defaultFCMToken;
+  NSString *newToken = defaultFCMToken;
+  if ([self.tokenManager hasTokenChangedFromOldToken:oldToken toNewToken:newToken]) {
+    // Make sure to set default token first before notifying others.
+    [self.tokenManager saveDefaultTokenInfoInKeychain:newToken];
     [self notifyDelegateOfFCMTokenAvailability];
     [self.pubsub scheduleSync:YES];
   }
@@ -857,12 +864,12 @@ - (void)notifyDelegateOfFCMTokenAvailability {
     return;
   }
   if ([self.delegate respondsToSelector:@selector(messaging:didReceiveRegistrationToken:)]) {
-    [self.delegate messaging:self didReceiveRegistrationToken:self.defaultFcmToken];
+    [self.delegate messaging:self didReceiveRegistrationToken:self.tokenManager.defaultFCMToken];
   }
   // Should always trigger the token refresh notification when the delegate method is called
   NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
   [center postNotificationName:FIRMessagingRegistrationTokenRefreshedNotification
-                        object:self.defaultFcmToken];
+                        object:self.tokenManager.defaultFCMToken];
 }
 
 #pragma mark - Application Support Directory

FirebaseMessaging/Sources/FIRMessagingClient.h

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-#import <FirebaseMessaging/FIRMessaging.h>
+#import "FirebaseMessaging/Sources/Public/FirebaseMessaging/FIRMessaging.h"
 
 @class GULReachabilityChecker;
 @class GPBMessage;

FirebaseMessaging/Sources/FIRMessagingPubSub.m

@@ -16,10 +16,10 @@
 
 #import "FirebaseMessaging/Sources/FIRMessagingPubSub.h"
 
-#import "GoogleUtilities/Environment/Public/GoogleUtilities/GULSecureCoding.h"
-#import "GoogleUtilities/UserDefaults/Public/GoogleUtilities/GULUserDefaults.h"
 #import "Firebase/InstanceID/Private/FIRInstanceID_Private.h"
 #import "FirebaseMessaging/Sources/Public/FirebaseMessaging/FIRMessaging.h"
+#import "GoogleUtilities/Environment/Public/GoogleUtilities/GULSecureCoding.h"
+#import "GoogleUtilities/UserDefaults/Public/GoogleUtilities/GULUserDefaults.h"
 
 #import "FirebaseMessaging/Sources/FIRMessagingDefines.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"

FirebaseMessaging/Sources/FIRMessagingUtilities.h

@@ -16,8 +16,6 @@
 
 #import <Foundation/Foundation.h>
 
-
-
 #pragma mark - URL Helpers
 
 FOUNDATION_EXPORT NSString *FIRMessagingTokenRegisterServer(void);

FirebaseMessaging/Sources/FIRMessagingUtilities.m

@@ -17,10 +17,9 @@
 #import "FirebaseMessaging/Sources/FIRMessagingUtilities.h"
 
 #import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
-#import "GoogleUtilities/UserDefaults/Public/GoogleUtilities/GULUserDefaults.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 #import "GoogleUtilities/Environment/Public/GoogleUtilities/GULAppEnvironmentUtil.h"
-
+#import "GoogleUtilities/UserDefaults/Public/GoogleUtilities/GULUserDefaults.h"
 
 static const uint64_t kBytesToMegabytesDivisor = 1024 * 1024LL;
 NSString *const kFIRMessagingInstanceIDUserDefaultsKeyLocale =

FirebaseMessaging/Sources/FIRMessaging_Private.h

@@ -34,7 +34,6 @@ FOUNDATION_EXPORT NSString *const kFIRMessagingPlistUseMessagingDelegate;
 
 #pragma mark - Private API
 
-- (NSString *)defaultFcmToken;
 - (FIRMessagingPubSub *)pubsub;
 
 - (BOOL)isNetworkAvailable;

FirebaseMessaging/Sources/Token/FIRMessagingAPNSInfo.m

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-#import "FIRMessagingAPNSInfo.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAPNSInfo.h"
 
-#import "FIRMessagingConstants.h"
+#import "FirebaseMessaging/Sources/FIRMessagingConstants.h"
 
 /// The key used to find the APNs device token in an archive.
 static NSString *const kFIRInstanceIDAPNSInfoTokenKey = @"device_token";

FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.m

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-#import "FIRMessagingAuthKeyChain.h"
-#import "FIRMessagingKeychain.h"
-#import "FIRMessagingLogger.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.h"
+#import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingKeychain.h"
 
 /**
  *  The error type representing why we couldn't read data from the keychain.

FirebaseMessaging/Sources/Token/FIRMessagingAuthService.h

@@ -15,7 +15,7 @@
  */
 
 #import <Foundation/Foundation.h>
-#import "FIRMessagingCheckinService.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingCheckinService.h"
 
 NS_ASSUME_NONNULL_BEGIN