Add support for the new FCM registration ID. #16133
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
leojaygoogle marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,12 +51,18 @@ | |
| const NSNotificationName FIRMessagingRegistrationTokenRefreshedNotification = | ||
| @"com.firebase.messaging.notif.fcm-token-refreshed"; | ||
|
|
||
| const NSNotificationName FIRMessagingInstallationIdUnregisteredNotification = | ||
| @"com.firebase.messaging.notif.installation-id-unregistered"; | ||
|
|
||
| NSString *const kFIRMessagingUserDefaultsKeyAutoInitEnabled = | ||
| @"com.firebase.messaging.auto-init.enabled"; // Auto Init Enabled key stored in NSUserDefaults | ||
|
|
||
| NSString *const kFIRMessagingPlistAutoInitEnabled = | ||
| @"FirebaseMessagingAutoInitEnabled"; // Auto Init Enabled key stored in Info.plist | ||
|
|
||
| NSString *const kFIRMessagingPlistInstallationIdEnabled = | ||
| @"FirebaseMessagingInstallationIdEnabled"; // Installation ID Enabled key stored in Info.plist | ||
|
|
||
| NSString *const FIRMessagingErrorDomain = @"com.google.fcm"; | ||
|
|
||
| BOOL FIRMessagingIsAPNSSyncMessage(NSDictionary *message) { | ||
|
|
@@ -114,6 +120,8 @@ @interface FIRMessaging () <GULReachabilityDelegate> | |
| /// calling it implicitly during swizzling. | ||
| @property(nonatomic, readwrite, strong) NSMutableSet *loggedMessageIDs; | ||
| @property(nonatomic, readwrite, strong) id<FIRAnalyticsInterop> _Nullable analytics; | ||
| @property(nonatomic, readwrite, strong, nullable) id<NSObject> installationIDObserver; | ||
| @property(nonatomic, readwrite, copy, nullable) NSString *lastKnownFID; | ||
|
|
||
| @end | ||
|
|
||
|
|
@@ -232,7 +240,7 @@ - (void)didCompleteConfigure { | |
| // 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.tokenManager tokenAndRequestIfNotExist]]; | ||
| }]; | ||
| } else if (self.isAutoInitEnabled && self.APNSToken) { | ||
| // When there is no cached token, must check auto init is enabled. | ||
|
|
@@ -493,7 +501,19 @@ - (void)setAutoInitEnabled:(BOOL)autoInitEnabled { | |
| } | ||
| } | ||
|
|
||
| - (BOOL)isInstallationIdEnabled { | ||
| id isInstallationIdEnabledObject = | ||
| [[NSBundle mainBundle] objectForInfoDictionaryKey:kFIRMessagingPlistInstallationIdEnabled]; | ||
| return [isInstallationIdEnabledObject boolValue]; | ||
| } | ||
|
leojaygoogle marked this conversation as resolved.
|
||
|
|
||
| - (NSString *)FCMToken { | ||
| if (self.isInstallationIdEnabled) { | ||
| FIRMessagingLoggerDebug( | ||
| kFIRMessagingMessageCodeInstallationIdEnabled, | ||
| @"FirebaseMessagingInstallationIdEnabled is set to YES, token is not available."); | ||
| return nil; | ||
| } | ||
| // Gets the current default token, and requests a new one if it doesn't exist. | ||
| NSString *token = [self.tokenManager tokenAndRequestIfNotExist]; | ||
| return token; | ||
|
|
@@ -617,14 +637,27 @@ - (void)setDelegate:(id<FIRMessagingDelegate>)delegate { | |
| // NOTE: Once |didReceiveRegistrationToken:| can be made a required method, this | ||
| // check can be removed. | ||
| - (void)validateDelegateConformsToTokenAvailabilityMethods { | ||
| if (self.delegate) { | ||
| if ([self isInstallationIdEnabled]) { | ||
| if (![self.delegate respondsToSelector:@selector(messaging:didReceiveRegistration:)]) { | ||
| FIRMessagingLoggerWarn( | ||
| kFIRMessagingMessageCodeTokenDelegateMethodsNotImplemented, | ||
| @"The object %@ does not respond to " | ||
| @"-messaging:didReceiveRegistration:. Please implement " | ||
| @"-messaging:didReceiveRegistration: to be provided with an installation ID.", | ||
| self.delegate.description); | ||
| } | ||
| } else { | ||
| if (![self.delegate respondsToSelector:@selector(messaging:didReceiveRegistrationToken:)]) { | ||
| FIRMessagingLoggerWarn( | ||
| kFIRMessagingMessageCodeTokenDelegateMethodsNotImplemented, | ||
| @"The object %@ does not respond to " | ||
| @"-messaging:didReceiveRegistrationToken:. Please implement " | ||
| @"-messaging:didReceiveRegistrationToken: to be provided with an FCM " | ||
| @"token.", | ||
| self.delegate.description); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -636,8 +669,14 @@ - (void)notifyRefreshedFCMToken { | |
| }); | ||
| return; | ||
| } | ||
| if ([self isInstallationIdEnabled]) { | ||
| if ([self.delegate respondsToSelector:@selector(messaging:didReceiveRegistration:)]) { | ||
| [self.delegate messaging:self didReceiveRegistration:self.tokenManager.defaultFCMToken]; | ||
| } | ||
| } else { | ||
| if ([self.delegate respondsToSelector:@selector(messaging:didReceiveRegistrationToken:)]) { | ||
| [self.delegate messaging:self didReceiveRegistrationToken:self.tokenManager.defaultFCMToken]; | ||
| } | ||
| } | ||
|
|
||
| // Should always trigger the token refresh notification when the delegate method is called | ||
|
|
@@ -646,6 +685,120 @@ - (void)notifyRefreshedFCMToken { | |
| object:self.tokenManager.defaultFCMToken]; | ||
| } | ||
|
|
||
| - (void)notifyInstallationIdUnregistered:(nonnull NSString *)installationID { | ||
| if (![self isInstallationIdEnabled]) { | ||
| return; | ||
| } | ||
|
|
||
| __weak FIRMessaging *weakSelf = self; | ||
| if (![NSThread isMainThread]) { | ||
| dispatch_async(dispatch_get_main_queue(), ^{ | ||
| [weakSelf notifyInstallationIdUnregistered:installationID]; | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| if ([self.delegate respondsToSelector:@selector(messaging:didUnregister:)]) { | ||
| [self.delegate messaging:self didUnregister:installationID]; | ||
| } | ||
|
|
||
| NSNotificationCenter *center = [NSNotificationCenter defaultCenter]; | ||
| [center postNotificationName:FIRMessagingInstallationIdUnregisteredNotification | ||
| object:installationID]; | ||
| } | ||
|
|
||
| #pragma mark - FID | ||
|
|
||
| - (void)handleInstallationIDDidChangeNotification:(NSNotification *)notification { | ||
| FIRMessaging_WEAKIFY(self); | ||
| [self.installations installationIDWithCompletion:^(NSString *_Nullable identifier, | ||
| NSError *_Nullable error) { | ||
| dispatch_async(dispatch_get_main_queue(), ^{ | ||
| FIRMessaging_STRONGIFY(self); | ||
| if (error || !identifier.length) { | ||
| return; | ||
| } | ||
| // Registration will only be triggered if FID is changed | ||
| if (![identifier isEqualToString:self.lastKnownFID]) { | ||
|
Contributor
There was a problem hiding this comment. Shall we also check if the app instance is registered or not? I think we should avoid creating a registration if the app disables auto-init and never calls
Contributor
Author
There was a problem hiding this comment. Done. also added tests. |
||
| FIRMessagingLoggerInfo(kFIRMessagingMessageCodeInstallationIdRotation, | ||
| @"FID rotated. Registering with the new FID '%@'", identifier); | ||
| self.lastKnownFID = identifier; | ||
| [self retrieveFCMTokenForSenderID:self.tokenManager.fcmSenderID | ||
| completion:^(NSString *_Nullable FCMToken, NSError *_Nullable error){ | ||
| }]; | ||
|
leojaygoogle marked this conversation as resolved.
Outdated
leojaygoogle marked this conversation as resolved.
Outdated
|
||
| } | ||
| }); | ||
| }]; | ||
| } | ||
|
|
||
| - (void)setupInstallationIDObserver { | ||
| if (self.installationIDObserver) { | ||
| return; | ||
| } | ||
| // Monitor FID rotation events. When FID rotates, register with the new FID. | ||
| FIRMessagingLoggerDebug(kFIRMessagingMessageCodeDebug, @"Listening for FID rotation events"); | ||
| FIRMessaging_WEAKIFY(self); | ||
| self.installationIDObserver = [NSNotificationCenter.defaultCenter | ||
|
ncooke3 marked this conversation as resolved.
|
||
| addObserverForName:FIRInstallationIDDidChangeNotification | ||
| object:nil | ||
| queue:nil | ||
| usingBlock:^(NSNotification *notification) { | ||
| FIRMessaging_STRONGIFY(self); | ||
| [self handleInstallationIDDidChangeNotification:notification]; | ||
| }]; | ||
| } | ||
|
|
||
| - (void)register { | ||
|
Contributor
There was a problem hiding this comment. This method should always trigger the Consider adding a unit test for this scenario.
Contributor
Author
There was a problem hiding this comment. Done. also added a test case. |
||
| if (!self.isInstallationIdEnabled) { | ||
| FIRMessagingLoggerError(kFIRMessagingMessageCodeInstallationIdDisabled, | ||
| @"FirebaseMessagingInstallationIdEnabled is not set to YES, so " | ||
| @"FID operations are not supported."); | ||
| return; | ||
| } | ||
| if (!FIRApp.defaultApp.options.GCMSenderID.length) { | ||
| FIRMessagingLoggerError(kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenFetch, | ||
| @"No Sender ID is available to register"); | ||
| return; | ||
| } | ||
| [self setupInstallationIDObserver]; | ||
|
leojaygoogle marked this conversation as resolved.
Outdated
|
||
| [self.tokenManager tokenAndRequestIfNotExist]; | ||
| } | ||
|
|
||
| - (void)unregister { | ||
| if (!self.isInstallationIdEnabled) { | ||
| FIRMessagingLoggerError(kFIRMessagingMessageCodeInstallationIdDisabled, | ||
| @"FirebaseMessagingInstallationIdEnabled is not set to YES, so " | ||
| @"FID operations are not supported."); | ||
| return; | ||
| } | ||
| NSString *senderID = FIRApp.defaultApp.options.GCMSenderID; | ||
| if (!senderID.length) { | ||
| FIRMessagingLoggerError(kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenDelete, | ||
| @"No Sender ID is available to unregister"); | ||
| return; | ||
| } | ||
|
|
||
| FIRMessaging_WEAKIFY(self); | ||
| [self.installations | ||
| installationIDWithCompletion:^(NSString *_Nullable identifier, NSError *_Nullable error) { | ||
| FIRMessaging_STRONGIFY(self); | ||
| if (error || !identifier.length) { | ||
| FIRMessagingLoggerError(kFIRMessagingMessageCodeTokenOperationInstallationIdNotAvailable, | ||
| @"Failed to get installation ID."); | ||
| } else { | ||
| [self.tokenManager | ||
| deleteTokenWithAuthorizedEntity:senderID | ||
| scope:kFIRMessagingDefaultTokenScope | ||
| instanceID:identifier | ||
| handler:^(NSError *_Nullable error) { | ||
| if (!error) { | ||
| [self notifyInstallationIdUnregistered:identifier]; | ||
| } | ||
| }]; | ||
| } | ||
| }]; | ||
| } | ||
|
|
||
| #pragma mark - Topics | ||
|
|
||
| + (NSString *)normalizeTopic:(NSString *)topic { | ||
|
|
@@ -673,7 +826,7 @@ - (void)subscribeToTopic:(NSString *)topic | |
| @"subscribeToTopic.", | ||
| topic, [FIRMessagingPubSub removePrefixFromTopic:topic]); | ||
| } | ||
| FIRMessaging_WEAKIFY(self); | ||
| [self | ||
| retrieveFCMTokenForSenderID:self.tokenManager.fcmSenderID | ||
| completion:^(NSString *_Nullable FCMToken, NSError *_Nullable error) { | ||
|
|
@@ -687,10 +840,10 @@ - (void)subscribeToTopic:(NSString *)topic | |
| } | ||
| return; | ||
| } | ||
| FIRMessaging_STRONGIFY(self); | ||
| NSString *normalizeTopic = [[self class] normalizeTopic:topic]; | ||
| if (normalizeTopic.length) { | ||
| [self.pubsub subscribeToTopic:normalizeTopic handler:completion]; | ||
| return; | ||
| } | ||
| NSString *failureReason = [NSString | ||
|
|
@@ -814,8 +967,14 @@ - (void)notifyDelegateOfFCMTokenAvailability { | |
| }); | ||
| return; | ||
| } | ||
| if ([self isInstallationIdEnabled]) { | ||
| if ([self.delegate respondsToSelector:@selector(messaging:didReceiveRegistration:)]) { | ||
| [self.delegate messaging:self didReceiveRegistration:self.tokenManager.defaultFCMToken]; | ||
| } | ||
| } else { | ||
| if ([self.delegate respondsToSelector:@selector(messaging:didReceiveRegistrationToken:)]) { | ||
| [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]; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.