Add failure reason to messaging NSError

FirebaseMessaging/Sources/FIRMessaging.m

@@ -578,14 +578,14 @@ - (NSString *)FCMToken {
 - (void)retrieveFCMTokenForSenderID:(nonnull NSString *)senderID
                          completion:(nonnull FIRMessagingFCMTokenFetchCompletion)completion {
   if (!senderID.length) {
-    FIRMessagingLoggerError(kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenFetch,
-                            @"Sender ID not supplied. It is required for a token fetch, "
-                            @"to identify the sender.");
+    NSString *description = @"Couldn't fetch token because a Sender ID was not supplied. A valid "
+                            @"Sender ID is required to fetch an FCM token";
+    FIRMessagingLoggerError(kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenFetch, @"%@",
+                            description);
     if (completion) {
-      NSString *description = @"Couldn't fetch token because a Sender ID was not supplied. A valid "
-                              @"Sender ID is required to fetch an FCM token";
-      NSError *error = [NSError fcm_errorWithCode:FIRMessagingErrorInvalidRequest
-                                         userInfo:@{NSLocalizedDescriptionKey : description}];
+      NSError *error = [NSError
+          messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorInvalidRequest
+                   failureReason:description];
       completion(nil, error);
     }
     return;
@@ -610,13 +610,14 @@ - (void)retrieveFCMTokenForSenderID:(nonnull NSString *)senderID
 - (void)deleteFCMTokenForSenderID:(nonnull NSString *)senderID
                        completion:(nonnull FIRMessagingDeleteFCMTokenCompletion)completion {
   if (!senderID.length) {
-    FIRMessagingLoggerError(kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenDelete,
-                            @"Sender ID not supplied. It is required to delete an FCM token.");
+    NSString *description = @"Couldn't delete token because a Sender ID was not supplied. A "
+                            @"valid Sender ID is required to delete an FCM token";
+    FIRMessagingLoggerError(kFIRMessagingMessageCodeSenderIDNotSuppliedForTokenDelete, @"%@",
+                            description);
     if (completion) {
-      NSString *description = @"Couldn't delete token because a Sender ID was not supplied. A "
-                              @"valid Sender ID is required to delete an FCM token";
-      NSError *error = [NSError fcm_errorWithCode:FIRMessagingErrorInvalidRequest
-                                         userInfo:@{NSLocalizedDescriptionKey : description}];
+      NSError *error = [NSError
+          messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorInvalidRequest
+                   failureReason:description];
       completion(error);
     }
     return;
@@ -786,10 +787,13 @@ - (void)subscribeToTopic:(NSString *)topic
       [strongSelf.pubsub subscribeToTopic:normalizeTopic handler:completion];
       return;
     }
-    FIRMessagingLoggerError(kFIRMessagingMessageCodeMessaging009,
-                            @"Cannot parse topic name %@. Will not subscribe.", topic);
+    NSString *failureReason =
+        [NSString stringWithFormat:@"Cannot parse topic name: '%@'. Will not subscribe.", topic];
+    FIRMessagingLoggerError(kFIRMessagingMessageCodeMessaging009, @"%@", failureReason);
     if (completion) {
-      completion([NSError fcm_errorWithCode:FIRMessagingErrorInvalidTopicName userInfo:nil]);
+      completion([NSError
+          messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorInvalidTopicName
+                   failureReason:failureReason]);
     }
   }];
 }
@@ -824,10 +828,13 @@ - (void)unsubscribeFromTopic:(NSString *)topic
       [strongSelf.pubsub unsubscribeFromTopic:normalizeTopic handler:completion];
       return;
     }
-    FIRMessagingLoggerError(kFIRMessagingMessageCodeMessaging011,
-                            @"Cannot parse topic name %@. Will not unsubscribe.", topic);
+    NSString *failureReason =
+        [NSString stringWithFormat:@"Cannot parse topic name: '%@'. Will not unsubscribe.", topic];
+    FIRMessagingLoggerError(kFIRMessagingMessageCodeMessaging011, @"%@", failureReason);
     if (completion) {
-      completion([NSError fcm_errorWithCode:FIRMessagingErrorInvalidTopicName userInfo:nil]);
+      completion([NSError
+          messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorInvalidTopicName
+                   failureReason:failureReason]);
     }
   }];
 }

FirebaseMessaging/Sources/FIRMessagingClient.m

@@ -195,9 +195,11 @@ - (void)updateSubscriptionWithToken:(NSString *)token
                                  shouldDelete:shouldDelete
                                       handler:completion];
   } else {
-    FIRMessagingLoggerDebug(kFIRMessagingMessageCodeRegistrar000,
-                            @"Device check in error, no auth credentials found");
-    NSError *error = [NSError errorWithFCMErrorCode:kFIRMessagingErrorCodeMissingDeviceID];
+    NSString *failureReason = @"Device ID and checkin info is not found. Will not proceed with "
+                              @"subscription/unsubscription.";
+    FIRMessagingLoggerDebug(kFIRMessagingMessageCodeRegistrar000, @"%@", failureReason);
+    NSError *error = [NSError messagingErrorWithCode:kFIRMessagingErrorCodeMissingDeviceID
+                                       failureReason:failureReason];
     handler(error);
   }
 }
@@ -267,10 +269,9 @@ - (void)retryConnectionImmediately:(BOOL)immediately {
 - (void)connectWithHandler:(FIRMessagingConnectCompletionHandler)handler {
   if (self.isConnected) {
     NSError *error =
-        [NSError fcm_errorWithCode:kFIRMessagingErrorCodeAlreadyConnected
-                          userInfo:@{
-                            NSLocalizedFailureReasonErrorKey : @"FIRMessaging is already connected",
-                          }];
+        [NSError messagingErrorWithCode:kFIRMessagingErrorCodeAlreadyConnected
+                          failureReason:
+                              @"FIRMessaging is already connected. Will not try to connect again."];
     handler(error);
     return;
   }
@@ -290,12 +291,13 @@ - (void)connect {
   self.stayConnected = YES;
   if (![[FIRInstanceID instanceID] tryToLoadValidCheckinInfo]) {
     // 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) {
-      NSError *error = [NSError errorWithFCMErrorCode:kFIRMessagingErrorCodeMissingDeviceID];
+      NSError *error = [NSError messagingErrorWithCode:kFIRMessagingErrorCodeMissingDeviceID
+                                         failureReason:failureReason];
       self.connectHandler(error);
     }
-    FIRMessagingLoggerDebug(kFIRMessagingMessageCodeClient009,
-                            @"Failed to connect to MCS. No deviceID and secret found.");
+    FIRMessagingLoggerDebug(kFIRMessagingMessageCodeClient009, @"%@", failureReason);
     // Return for now. If checkin is, in fact, retrieved, the
     // |kFIRMessagingCheckinFetchedNotification| will be fired.
     return;
@@ -492,9 +494,8 @@ - (void)scheduleConnectRetry {
     // disconnect before issuing a callback
     [self disconnectWithTryToConnectLater:YES];
     NSError *error =
-        [NSError errorWithDomain:@"No internet available, cannot connect to FIRMessaging"
-                            code:kFIRMessagingErrorCodeNetwork
-                        userInfo:nil];
+        [NSError messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorNetwork
+                          failureReason:@"No internet available, cannot connect to FIRMessaging"];
     if (handler) {
       handler(error);
       self.connectHandler = nil;

FirebaseMessaging/Sources/FIRMessagingDataMessageManager.m

@@ -322,7 +322,9 @@ - (void)sendDataMessageStanza:(NSMutableDictionary *)dataMessage {
       NSString *event __unused = [NSString stringWithFormat:@"Queued message: %@", [stanza id_p]];
       FIRMessagingLoggerDebug(kFIRMessagingMessageCodeDataMessageManager007, @"%@", event);
     } else {
-      [self willSendDataMessageFail:stanza withMessageId:msgId error:kFIRMessagingErrorCodeNetwork];
+      [self willSendDataMessageFail:stanza
+                      withMessageId:msgId
+                              error:(FIRMessagingInternalErrorCode)FIRMessagingErrorNetwork];
       return;
     }
   }
@@ -404,10 +406,11 @@ - (void)willSendDataMessageSuccess:(GtalkDataMessageStanza *)stanza
 - (void)willSendDataMessageFail:(GtalkDataMessageStanza *)stanza
                   withMessageId:(NSString *)messageId
                           error:(FIRMessagingInternalErrorCode)errorCode {
-  FIRMessagingLoggerDebug(kFIRMessagingMessageCodeDataMessageManager011,
-                          @"Send message fail: %@ error: %lu", messageId, (unsigned long)errorCode);
+  NSString *failureReason = [NSString
+      stringWithFormat:@"Send message fail: %@ error: %lu", messageId, (unsigned long)errorCode];
+  FIRMessagingLoggerDebug(kFIRMessagingMessageCodeDataMessageManager011, @"%@", failureReason);
 
-  NSError *error = [NSError errorWithFCMErrorCode:errorCode];
+  NSError *error = [NSError messagingErrorWithCode:errorCode failureReason:failureReason];
   if ([self.delegate respondsToSelector:@selector(willSendDataMessageWithID:error:)]) {
     [self.delegate willSendDataMessageWithID:messageId error:error];
   }

FirebaseMessaging/Sources/FIRMessagingPubSub.m

@@ -61,7 +61,10 @@ - (void)subscribeWithToken:(NSString *)token
                    options:(NSDictionary *)options
                    handler:(FIRMessagingTopicOperationCompletion)handler {
   if (!self.client) {
-    handler([NSError errorWithFCMErrorCode:kFIRMessagingErrorCodePubSubFIRMessagingNotSetup]);
+    handler([NSError
+        messagingErrorWithCode:kFIRMessagingErrorCodePubSubClientNotSetup
+                 failureReason:@"Firebase Messaging Client does not exist. Firebase Messaging was "
+                               @"not setup property and subscription failed."]);
     return;
   }
 
@@ -73,9 +76,12 @@ - (void)subscribeWithToken:(NSString *)token
   }
 
   if (![[self class] isValidTopicWithPrefix:topic]) {
-    FIRMessagingLoggerError(kFIRMessagingMessageCodePubSub000,
-                            @"Invalid FIRMessaging Pubsub topic %@", topic);
-    handler([NSError errorWithFCMErrorCode:kFIRMessagingErrorCodePubSubInvalidTopic]);
+    NSString *failureReason =
+        [NSString stringWithFormat:@"Invalid subscription topic :'%@'", topic];
+    FIRMessagingLoggerError(kFIRMessagingMessageCodePubSub000, @"%@", failureReason);
+    handler([NSError
+        messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorInvalidTopicName
+                 failureReason:failureReason]);
     return;
   }
 
@@ -102,7 +108,10 @@ - (void)unsubscribeWithToken:(NSString *)token
                      options:(NSDictionary *)options
                      handler:(FIRMessagingTopicOperationCompletion)handler {
   if (!self.client) {
-    handler([NSError errorWithFCMErrorCode:kFIRMessagingErrorCodePubSubFIRMessagingNotSetup]);
+    handler([NSError
+        messagingErrorWithCode:kFIRMessagingErrorCodePubSubClientNotSetup
+                 failureReason:@"Firebase Messaging Client does not exist. Firebase Messaging was "
+                               @"not setup property and subscription failed."]);
     return;
   }
   token = [token copy];
@@ -112,9 +121,12 @@ - (void)unsubscribeWithToken:(NSString *)token
   }
 
   if (![[self class] isValidTopicWithPrefix:topic]) {
-    FIRMessagingLoggerError(kFIRMessagingMessageCodePubSub002,
-                            @"Invalid FIRMessaging Pubsub topic %@", topic);
-    handler([NSError errorWithFCMErrorCode:kFIRMessagingErrorCodePubSubInvalidTopic]);
+    NSString *failureReason =
+        [NSString stringWithFormat:@"Invalid topic name : '%@' for unsubscription.", topic];
+    FIRMessagingLoggerError(kFIRMessagingMessageCodePubSub002, @"%@", failureReason);
+    handler([NSError
+        messagingErrorWithCode:(FIRMessagingInternalErrorCode)FIRMessagingErrorInvalidTopicName
+                 failureReason:failureReason]);
     return;
   }
   if (![self verifyPubSubOptions:options]) {

FirebaseMessaging/Sources/FIRMessagingTopicOperation.m

@@ -120,8 +120,10 @@ - (void)setFinished:(BOOL)finished {
 
 - (void)start {
   if (self.isCancelled) {
-    NSError *error =
-        [NSError errorWithFCMErrorCode:kFIRMessagingErrorCodePubSubOperationIsCancelled];
+    NSError *error = [NSError
+        messagingErrorWithCode:kFIRMessagingErrorCodePubSubOperationIsCancelled
+                 failureReason:
+                     @"Failed to start the pubsub service as the topic operation is cancelled."];
     [self finishWithError:error];
     return;
   }
@@ -148,7 +150,8 @@ - (void)finishWithError:(NSError *)error {
 - (void)cancel {
   [super cancel];
   [self.dataTask cancel];
-  NSError *error = [NSError errorWithFCMErrorCode:kFIRMessagingErrorCodePubSubOperationIsCancelled];
+  NSError *error = [NSError messagingErrorWithCode:kFIRMessagingErrorCodePubSubOperationIsCancelled
+                                     failureReason:@"The topic operation is cancelled."];
   [self finishWithError:error];
 }
 
@@ -210,16 +213,23 @@ - (void)performSubscriptionChange {
         }
         NSString *response = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
         if (response.length == 0) {
-          FIRMessagingLoggerDebug(kFIRMessagingMessageCodeTopicOperationEmptyResponse,
-                                  @"Invalid registration response - zero length.");
-          [self finishWithError:[NSError errorWithFCMErrorCode:kFIRMessagingErrorCodeUnknown]];
+          NSString *failureReason = @"Invalid registration response - zero length.";
+          FIRMessagingLoggerDebug(kFIRMessagingMessageCodeTopicOperationEmptyResponse, @"%@",
+                                  failureReason);
+          [self finishWithError:[NSError messagingErrorWithCode:(FIRMessagingInternalErrorCode)
+                                                                    FIRMessagingErrorUnknown
+                                                  failureReason:failureReason]];
           return;
         }
         NSArray *parts = [response componentsSeparatedByString:@"="];
         if (![parts[0] isEqualToString:@"token"] || parts.count <= 1) {
-          FIRMessagingLoggerDebug(kFIRMessagingMessageCodeTopicOption002,
-                                  @"Invalid registration response %@", response);
-          [self finishWithError:[NSError errorWithFCMErrorCode:kFIRMessagingErrorCodeUnknown]];
+          NSString *failureReason = [NSString
+              stringWithFormat:@"Invalid registration response :'%@'. It is missing 'token' field.",
+                               response];
+          FIRMessagingLoggerDebug(kFIRMessagingMessageCodeTopicOption002, @"%@", failureReason);
+          [self finishWithError:[NSError messagingErrorWithCode:(FIRMessagingInternalErrorCode)
+                                                                    FIRMessagingErrorUnknown
+                                                  failureReason:failureReason]];
           return;
         }
         [self finishWithError:nil];

FirebaseMessaging/Sources/NSError+FIRMessaging.h

@@ -16,54 +16,44 @@
 
 #import <Foundation/Foundation.h>
 
+#import <FirebaseMessaging/FIRMessaging.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
 FOUNDATION_EXPORT NSString *const kFIRMessagingDomain;
 
 typedef NS_ENUM(NSUInteger, FIRMessagingInternalErrorCode) {
   // Unknown error.
   kFIRMessagingErrorCodeUnknown = 0,
 
-  // HTTP related errors.
-  kFIRMessagingErrorCodeAuthentication = 1,
-  kFIRMessagingErrorCodeNoAccess = 2,
-  kFIRMessagingErrorCodeTimeout = 3,
   kFIRMessagingErrorCodeNetwork = 4,
 
-  // Another operation is in progress.
-  kFIRMessagingErrorCodeOperationInProgress = 5,
-
-  // Failed to perform device check in.
-  kFIRMessagingErrorCodeRegistrarFailedToCheckIn = 6,
-
   kFIRMessagingErrorCodeInvalidRequest = 7,
 
+  kFIRMessagingErrorInvalidTopicName = 8,
+
   // FIRMessaging generic errors
   kFIRMessagingErrorCodeMissingDeviceID = 501,
 
-  // upstream send errors
+  // Upstream send errors
   kFIRMessagingErrorServiceNotAvailable = 1001,
-  kFIRMessagingErrorInvalidParameters = 1002,
   kFIRMessagingErrorMissingTo = 1003,
   kFIRMessagingErrorSave = 1004,
   kFIRMessagingErrorSizeExceeded = 1005,
-  // Future Send Errors
 
-  // MCS errors
   // Already connected with MCS
   kFIRMessagingErrorCodeAlreadyConnected = 2001,
 
   // PubSub errors
-  kFIRMessagingErrorCodePubSubAlreadySubscribed = 3001,
-  kFIRMessagingErrorCodePubSubAlreadyUnsubscribed = 3002,
-  kFIRMessagingErrorCodePubSubInvalidTopic = 3003,
-  kFIRMessagingErrorCodePubSubFIRMessagingNotSetup = 3004,
+  kFIRMessagingErrorCodePubSubClientNotSetup = 3004,
   kFIRMessagingErrorCodePubSubOperationIsCancelled = 3005,
 };
 
 @interface NSError (FIRMessaging)
 
-@property(nonatomic, readonly) FIRMessagingInternalErrorCode fcmErrorCode;
-
-+ (NSError *)errorWithFCMErrorCode:(FIRMessagingInternalErrorCode)fcmErrorCode;
-+ (NSError *)fcm_errorWithCode:(NSInteger)code userInfo:(NSDictionary *)userInfo;
++ (NSError *)messagingErrorWithCode:(FIRMessagingInternalErrorCode)fcmErrorCode
+                      failureReason:(NSString *)failureReason;
 
 @end
+
+NS_ASSUME_NONNULL_END

FirebaseMessaging/Sources/NSError+FIRMessaging.m

@@ -20,16 +20,11 @@
 
 @implementation NSError (FIRMessaging)
 
-- (FIRMessagingInternalErrorCode)fcmErrorCode {
-  return (FIRMessagingInternalErrorCode)self.code;
-}
-
-+ (NSError *)errorWithFCMErrorCode:(FIRMessagingInternalErrorCode)fcmErrorCode {
-  return [NSError errorWithDomain:kFIRMessagingDomain code:fcmErrorCode userInfo:nil];
-}
-
-+ (NSError *)fcm_errorWithCode:(NSInteger)code userInfo:(NSDictionary *)userInfo {
-  return [NSError errorWithDomain:kFIRMessagingDomain code:code userInfo:userInfo];
++ (NSError *)messagingErrorWithCode:(FIRMessagingInternalErrorCode)fcmErrorCode
+                      failureReason:(NSString *)failureReason {
+  NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
+  userInfo[NSLocalizedFailureReasonErrorKey] = failureReason;
+  return [NSError errorWithDomain:kFIRMessagingDomain code:fcmErrorCode userInfo:userInfo];
 }
 
 @end