Skip to content

[Messaging] - Fix crash for strongSelf dereference #10740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 27, 2023
Merged

[Messaging] - Fix crash for strongSelf dereference #10740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0703865
[Messaging] - Fix crash for strongSelf dereference
aashishpatil-g Jan 26, 2023
de18f68
Charlotte Feedback: Fix naming for error variable
aashishpatil-g Jan 26, 2023
4ad5db9
code formatting/style changes
aashishpatil-g Jan 26, 2023
4b2e279
Add and use Internal error code
aashishpatil-g Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions FirebaseMessaging/Sources/NSError+FIRMessaging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ NS_ASSUME_NONNULL_BEGIN
// FIRMessaging Internal Error Code
typedef NS_ENUM(NSUInteger, FIRMessagingErrorCode) {
kFIRMessagingErrorCodeUnknown = 0,
kFIRMessagingErrorCodeInternal = 1,

kFIRMessagingErrorCodeNetwork = 4,

Expand Down
139 changes: 82 additions & 57 deletions FirebaseMessaging/Sources/Token/FIRMessagingTokenManager.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,17 +239,25 @@ - (void)tokenWithAuthorizedEntity:(NSString *)authorizedEntity
}

FIRMessaging_WEAKIFY(self);
[_authService
fetchCheckinInfoWithHandler:^(FIRMessagingCheckinPreferences *preferences, NSError *error) {
FIRMessaging_STRONGIFY(self);
if (error) {
newHandler(nil, error);
return;
}
[_authService fetchCheckinInfoWithHandler:^(FIRMessagingCheckinPreferences *preferences,
NSError *error) {
FIRMessaging_STRONGIFY(self);
if (error) {
newHandler(nil, error);
return;
}

if (!self) {
NSError *derefErr =
[NSError messagingErrorWithCode:kFIRMessagingErrorCodeInternal
failureReason:@"Unable to fetch token. Lost Reference to TokenManager"];
handler(nil, derefErr);
return;
}

FIRMessaging_WEAKIFY(self);
[self->_installations installationIDWithCompletion:^(NSString *_Nullable identifier,
NSError *_Nullable error) {
FIRMessaging_WEAKIFY(self);
[self->_installations
installationIDWithCompletion:^(NSString *_Nullable identifier, NSError *_Nullable error) {
FIRMessaging_STRONGIFY(self);

if (error) {
Expand All @@ -275,7 +283,7 @@ - (void)tokenWithAuthorizedEntity:(NSString *)authorizedEntity
handler:newHandler];
}
}];
}];
}];
}

- (void)fetchNewTokenWithAuthorizedEntity:(NSString *)authorizedEntity
Expand All @@ -292,52 +300,60 @@ - (void)fetchNewTokenWithAuthorizedEntity:(NSString *)authorizedEntity
options:options
instanceID:instanceID];
FIRMessaging_WEAKIFY(self);
FIRMessagingTokenOperationCompletion completion =
^(FIRMessagingTokenOperationResult result, NSString *_Nullable token,
NSError *_Nullable error) {
FIRMessaging_STRONGIFY(self);
if (error) {
handler(nil, error);
return;
}
if ([self isDefaultTokenWithAuthorizedEntity:authorizedEntity scope:scope]) {
[self postTokenRefreshNotificationWithDefaultFCMToken:token];
}
NSString *firebaseAppID = options[kFIRMessagingTokenOptionsFirebaseAppIDKey];
FIRMessagingTokenInfo *tokenInfo =
[[FIRMessagingTokenInfo alloc] initWithAuthorizedEntity:authorizedEntity
scope:scope
token:token
appVersion:FIRMessagingCurrentAppVersion()
firebaseAppID:firebaseAppID];
tokenInfo.APNSInfo = [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:options];

[self->_tokenStore
saveTokenInfo:tokenInfo
handler:^(NSError *error) {
if (!error) {
// Do not send the token back in case the save was unsuccessful. Since with
// the new asychronous fetch mechanism this can lead to infinite loops, for
// example, we will return a valid token even though we weren't able to store
// it in our cache. The first token will lead to a onTokenRefresh callback
// wherein the user again calls `getToken` but since we weren't able to save
// it we won't hit the cache but hit the server again leading to an infinite
// loop.
FIRMessagingLoggerDebug(
kFIRMessagingMessageCodeTokenManager001,
@"Token fetch successful, token: %@, authorizedEntity: %@, scope:%@",
token, authorizedEntity, scope);

if (handler) {
handler(token, nil);
}
} else {
if (handler) {
handler(nil, error);
}
}
}];
};
FIRMessagingTokenOperationCompletion completion = ^(FIRMessagingTokenOperationResult result,
NSString *_Nullable token,
NSError *_Nullable error) {
FIRMessaging_STRONGIFY(self);
if (error) {
handler(nil, error);
return;
}

if (!self) {
NSError *lostRefError = [NSError messagingErrorWithCode:kFIRMessagingErrorCodeInternal
failureReason:@"Lost Reference to TokenManager"];
handler(nil, lostRefError);
return;
}

if ([self isDefaultTokenWithAuthorizedEntity:authorizedEntity scope:scope]) {
[self postTokenRefreshNotificationWithDefaultFCMToken:token];
}
NSString *firebaseAppID = options[kFIRMessagingTokenOptionsFirebaseAppIDKey];
FIRMessagingTokenInfo *tokenInfo =
[[FIRMessagingTokenInfo alloc] initWithAuthorizedEntity:authorizedEntity
scope:scope
token:token
appVersion:FIRMessagingCurrentAppVersion()
firebaseAppID:firebaseAppID];
tokenInfo.APNSInfo = [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:options];

[self->_tokenStore
saveTokenInfo:tokenInfo
handler:^(NSError *error) {
if (!error) {
// Do not send the token back in case the save was unsuccessful. Since with
// the new asychronous fetch mechanism this can lead to infinite loops, for
// example, we will return a valid token even though we weren't able to store
// it in our cache. The first token will lead to a onTokenRefresh callback
// wherein the user again calls `getToken` but since we weren't able to save
// it we won't hit the cache but hit the server again leading to an infinite
// loop.
FIRMessagingLoggerDebug(
kFIRMessagingMessageCodeTokenManager001,
@"Token fetch successful, token: %@, authorizedEntity: %@, scope:%@", token,
authorizedEntity, scope);

if (handler) {
handler(token, nil);
}
} else {
if (handler) {
handler(nil, error);
}
}
}];
};
// Add completion handler, and ensure it's called on the main queue
[operation addCompletionHandler:^(FIRMessagingTokenOperationResult result,
NSString *_Nullable token, NSError *_Nullable error) {
Expand Down Expand Up @@ -456,6 +472,15 @@ - (void)deleteWithHandler:(void (^)(NSError *))handler {
handler(error);
return;
}

if (!self) {
NSError *lostRefError =
[NSError messagingErrorWithCode:kFIRMessagingErrorCodeInternal
failureReason:@"Cannot delete token. Lost reference to TokenManager"];
handler(lostRefError);
return;
}

[self deleteAllTokensLocallyWithHandler:^(NSError *localError) {
[self postTokenRefreshNotificationWithDefaultFCMToken:nil];
self->_defaultFCMToken = nil;
Expand Down