FIS: Complex unrecoverable error handling reverted and replaced by a simple log message. (#4120)

* Revert "FIS: stored registration error timeout (#4032)"

This reverts commit 37747db.

* Revert "FirebaseInstallations: CreateInstallation API request error handling (#4024)"

This reverts commit 27384c0.

* Complex unrecoverable error handling reverted and replaced by a simple log message.

Author: maksymmalyhin

FirebaseInstallations/Source/Library/FIRInstallationsItem.h

@@ -20,8 +20,6 @@
 
 @class FIRInstallationsStoredItem;
 @class FIRInstallationsStoredAuthToken;
-@class FIRInstallationsStoredRegistrationError;
-@class FIRInstallationsStoredRegistrationParameters;
 @class FIRInstallationsStoredIIDCheckin;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -46,8 +44,6 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, nullable) FIRInstallationsStoredAuthToken *authToken;
 @property(nonatomic, assign) FIRInstallationsStatus registrationStatus;
 
-@property(nonatomic, nullable) FIRInstallationsStoredRegistrationError *registrationError;
-
 /// Instance ID checkin data imported from IID checkin store as a part of IID migration.
 @property(nonatomic, nullable) FIRInstallationsStoredIIDCheckin *IIDCheckin;
 
@@ -85,17 +81,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (NSString *)generateFID;
 
-/**
- * Updates `registrationStatus` and `registrationError` accordingly.
- * @param error The error for the Installation Registration API request.
- * @param date The date when the error occurred.
- * @param registrationParameters The parameters used for the  Installation Registration API request.
- */
-- (void)updateWithRegistrationError:(NSError *)error
-                               date:(NSDate *)date
-             registrationParameters:
-                 (FIRInstallationsStoredRegistrationParameters *)registrationParameters;
-
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseInstallations/Source/Library/FIRInstallationsItem.m

@@ -18,7 +18,6 @@
 
 #import "FIRInstallationsStoredAuthToken.h"
 #import "FIRInstallationsStoredItem.h"
-#import "FIRInstallationsStoredRegistrationError.h"
 
 @implementation FIRInstallationsItem
 
@@ -47,7 +46,6 @@ - (void)updateWithStoredItem:(FIRInstallationsStoredItem *)item {
   self.refreshToken = item.refreshToken;
   self.authToken = item.authToken;
   self.registrationStatus = item.registrationStatus;
-  self.registrationError = item.registrationError;
   self.IIDCheckin = item.IIDCheckin;
 }
 
@@ -57,7 +55,6 @@ - (FIRInstallationsStoredItem *)storedItem {
   storedItem.refreshToken = self.refreshToken;
   storedItem.authToken = self.authToken;
   storedItem.registrationStatus = self.registrationStatus;
-  storedItem.registrationError = self.registrationError;
   storedItem.IIDCheckin = self.IIDCheckin;
   return storedItem;
 }
@@ -104,17 +101,4 @@ + (NSString *)base64URLEncodedStringWithData:(NSData *)data {
   return string;
 }
 
-- (void)updateWithRegistrationError:(NSError *)error
-                               date:(NSDate *)date
-             registrationParameters:
-                 (FIRInstallationsStoredRegistrationParameters *)registrationParameters {
-  self.registrationStatus = FIRInstallationStatusRegistrationFailed;
-  self.registrationError = [[FIRInstallationsStoredRegistrationError alloc]
-      initWithRegistrationParameters:registrationParameters
-                                date:date
-                            APIError:error];
-  self.authToken = nil;
-  self.refreshToken = nil;
-}
-
 @end

FirebaseInstallations/Source/Library/FIRInstallationsLogger.h

@@ -43,13 +43,6 @@ extern NSString *const kFIRInstallationsMessageCodeInstallationCoderVersionMisma
 // FIRInstallationsStoredAuthToken.m
 extern NSString *const kFIRInstallationsMessageCodeAuthTokenCoderVersionMismatch;
 
-// FIRInstallationsStoredRegistrationError.m
-extern NSString *const kFIRInstallationsMessageCodeRegistrationErrorCoderVersionMismatch;
-extern NSString *const kFIRInstallationsMessageCodeRegistrationErrorFailedToDecode;
-
-// FIRInstallationsStoredRegistrationParameters.m
-extern NSString *const kFIRInstallationsMessageCodeRegistrationParametersCoderVersionMismatch;
-
 // FIRInstallationsStoredIIDCheckin.m
 extern NSString *const kFIRInstallationsMessageCodeIIDCheckinCoderVersionMismatch;
 extern NSString *const kFIRInstallationsMessageCodeIIDCheckinFailedToDecode;

FirebaseInstallations/Source/Library/FIRInstallationsLogger.m

@@ -41,14 +41,6 @@
 // FIRInstallationsStoredAuthToken.m
 NSString *const kFIRInstallationsMessageCodeAuthTokenCoderVersionMismatch = @"I-FIS004000";
 
-// FIRInstallationsStoredRegistrationError.m
-NSString *const kFIRInstallationsMessageCodeRegistrationErrorCoderVersionMismatch = @"I-FIS005000";
-NSString *const kFIRInstallationsMessageCodeRegistrationErrorFailedToDecode = @"I-FIS005001";
-
-// FIRInstallationsStoredRegistrationParameters.m
-NSString *const kFIRInstallationsMessageCodeRegistrationParametersCoderVersionMismatch =
-    @"I-FIS006000";
-
 // FIRInstallationsStoredIIDCheckin.m
 NSString *const kFIRInstallationsMessageCodeIIDCheckinCoderVersionMismatch = @"I-FIS007000";
 NSString *const kFIRInstallationsMessageCodeIIDCheckinFailedToDecode = @"I-FIS007001";

FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.h

@@ -26,9 +26,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface FIRInstallationsAPIService : NSObject
 
-@property(nonatomic, readonly) NSString *APIKey;
-@property(nonatomic, readonly) NSString *projectID;
-
 /**
  * The default initializer.
  * @param APIKey The Firebase project API key (see `FIROptions.APIKey`).

FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.m

@@ -57,6 +57,8 @@ - (instancetype)initWithResponse:(NSHTTPURLResponse *)response data:(nullable NS
 
 @interface FIRInstallationsAPIService ()
 @property(nonatomic, readonly) NSURLSession *URLSession;
+@property(nonatomic, readonly) NSString *APIKey;
+@property(nonatomic, readonly) NSString *projectID;
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsIDController.m

@@ -32,13 +32,11 @@
 #import "FIRInstallationsLogger.h"
 #import "FIRInstallationsSingleOperationPromiseCache.h"
 #import "FIRInstallationsStore.h"
-#import "FIRInstallationsStoredIIDCheckin.h"
 #import "FIRSecureStorage.h"
 
 #import "FIRInstallationsHTTPError.h"
 #import "FIRInstallationsStoredAuthToken.h"
-#import "FIRInstallationsStoredRegistrationError.h"
-#import "FIRInstallationsStoredRegistrationParameters.h"
+#import "FIRInstallationsStoredIIDCheckin.h"
 
 const NSNotificationName FIRInstallationIDDidChangeNotification =
     @"FIRInstallationIDDidChangeNotification";
@@ -47,8 +45,6 @@
 
 NSTimeInterval const kFIRInstallationsTokenExpirationThreshold = 60 * 60;  // 1 hour.
 
-NSTimeInterval const kFIRInstallationsRegistrationErrorTimeout = 24 * 60 * 60;  // 1 day.
-
 @interface FIRInstallationsIDController ()
 @property(nonatomic, readonly) NSString *appID;
 @property(nonatomic, readonly) NSString *appName;
@@ -149,22 +145,9 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
               __PRETTY_FUNCTION__, self.appName);
 
   FBLPromise<FIRInstallationsItem *> *installationItemPromise =
-      [self getStoredInstallation]
-          .recover(^id(NSError *error) {
-            return [self createAndSaveFID];
-          })
-          .then(^id(FIRInstallationsItem *installation) {
-            // Validate if a previous registration attempt failed with an error requiring Firebase
-            // configuration changes.
-            if (installation.registrationStatus == FIRInstallationStatusRegistrationFailed &&
-                [self isRegistrationErrorWithDateUpToDate:installation.registrationError.date] &&
-                [self areInstallationRegistrationParametersEqualToCurrent:
-                          installation.registrationError.registrationParameters]) {
-              return installation.registrationError.APIError;
-            }
-
-            return installation;
-          });
+      [self getStoredInstallation].recover(^id(NSError *error) {
+        return [self createAndSaveFID];
+      });
 
   // Initiate registration process on success if needed, but return the installation without waiting
   // for it.
@@ -183,7 +166,6 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
         switch (installation.registrationStatus) {
           case FIRInstallationStatusUnregistered:
           case FIRInstallationStatusRegistered:
-          case FIRInstallationStatusRegistrationFailed:
             isValid = YES;
             break;
 
@@ -249,19 +231,6 @@ - (FIRInstallationsItem *)createInstallationWithFID:(NSString *)FID
   return installation;
 }
 
-- (BOOL)areInstallationRegistrationParametersEqualToCurrent:
-    (FIRInstallationsStoredRegistrationParameters *)parameters {
-  NSString *APIKey = self.APIService.APIKey;
-  NSString *projectID = self.APIService.projectID;
-  return (parameters.APIKey == APIKey || [parameters.APIKey isEqual:APIKey]) &&
-         (parameters.projectID == projectID || [parameters.projectID isEqual:projectID]);
-}
-
-- (BOOL)isRegistrationErrorWithDateUpToDate:(NSDate *)errorDate {
-  return errorDate != nil &&
-         -[errorDate timeIntervalSinceNow] <= kFIRInstallationsRegistrationErrorTimeout;
-}
-
 #pragma mark - FID registration
 
 - (FBLPromise<FIRInstallationsItem *> *)registerInstallationIfNeeded:
@@ -273,14 +242,19 @@ - (BOOL)isRegistrationErrorWithDateUpToDate:(NSDate *)errorDate {
 
     case FIRInstallationStatusUnknown:
     case FIRInstallationStatusUnregistered:
-    case FIRInstallationStatusRegistrationFailed:
       // Registration required. Proceed.
       break;
   }
 
   return [self.APIService registerInstallation:installation]
-      .recover(^id(NSError *error) {
-        return [self handleRegistrationRequestError:error installation:installation];
+      .catch(^(NSError *_Nonnull error) {
+        if ([self doesRegistrationErrorRequireConfigChange:error]) {
+          FIRLogError(kFIRLoggerInstallations,
+                      kFIRInstallationsMessageCodeInvalidFirebaseConfiguration,
+                      @"Firebase Installation registration failed for app with name: %@, error: "
+                      @"%@\nPlease make sure you use valid GoogleService-Info.plist",
+                      self.appName, error);
+        }
       })
       .then(^id(FIRInstallationsItem *registeredInstallation) {
         // Expected successful result: @[FIRInstallationsItem *registeredInstallation, NSNull]
@@ -299,32 +273,6 @@ - (BOOL)isRegistrationErrorWithDateUpToDate:(NSDate *)errorDate {
       });
 }
 
-- (FBLPromise<FIRInstallationsItem *> *)handleRegistrationRequestError:(NSError *)error
-                                                          installation:
-                                                              (FIRInstallationsItem *)installation {
-  if ([self doesRegistrationErrorRequireConfigChange:error]) {
-    FIRLogError(kFIRLoggerInstallations, kFIRInstallationsMessageCodeInvalidFirebaseConfiguration,
-                @"Firebase Installation registration failed for app with name: %@, error: "
-                @"%@\nPlease make sure you use valid GoogleService-Info.plist",
-                self.appName, error);
-
-    FIRInstallationsItem *failedInstallation = [installation copy];
-    [failedInstallation updateWithRegistrationError:error
-                                               date:[NSDate date]
-                             registrationParameters:[self currentRegistrationParameters]];
-
-    // Save the error and then fail with the API error.
-    return
-        [self.installationsStore saveInstallation:failedInstallation].then(^NSError *(id result) {
-          return error;
-        });
-  }
-
-  FBLPromise *errorPromise = [FBLPromise pendingPromise];
-  [errorPromise reject:error];
-  return errorPromise;
-}
-
 - (BOOL)doesRegistrationErrorRequireConfigChange:(NSError *)error {
   FIRInstallationsHTTPError *HTTPError = (FIRInstallationsHTTPError *)error;
   if (![HTTPError isKindOfClass:[FIRInstallationsHTTPError class]]) {
@@ -344,12 +292,6 @@ - (BOOL)doesRegistrationErrorRequireConfigChange:(NSError *)error {
   }
 }
 
-- (FIRInstallationsStoredRegistrationParameters *)currentRegistrationParameters {
-  return [[FIRInstallationsStoredRegistrationParameters alloc]
-      initWithAPIKey:self.APIService.APIKey
-           projectID:self.APIService.projectID];
-}
-
 #pragma mark - Auth Token
 
 - (FBLPromise<FIRInstallationsItem *> *)getAuthTokenForcingRefresh:(BOOL)forceRefresh {
@@ -455,7 +397,6 @@ - (id)regenerateFIDOnRefreshTokenErrorIfNeeded:(NSError *)error {
   switch (installation.registrationStatus) {
     case FIRInstallationStatusUnknown:
     case FIRInstallationStatusUnregistered:
-    case FIRInstallationStatusRegistrationFailed:
       // The installation is not registered, so it is safe to be deleted as is, so return early.
       return [FBLPromise resolvedWith:installation];
       break;

FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsStatus.h

@@ -32,7 +32,4 @@ typedef NS_ENUM(NSInteger, FIRInstallationsStatus) {
   FIRInstallationStatusUnregistered,
   /// The Firebase Installation has successfully been registered with FIS.
   FIRInstallationStatusRegistered,
-  /// The Firebase Installation registration with FIS failed. Firebase configuration changes are
-  /// required.
-  FIRInstallationStatusRegistrationFailed,
 };

FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.h

@@ -19,7 +19,6 @@
 #import "FIRInstallationsStatus.h"
 
 @class FIRInstallationsStoredAuthToken;
-@class FIRInstallationsStoredRegistrationError;
 @class FIRInstallationsStoredIIDCheckin;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -42,8 +41,6 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, nullable) FIRInstallationsStoredAuthToken *authToken;
 @property(nonatomic) FIRInstallationsStatus registrationStatus;
 
-@property(nonatomic, nullable) FIRInstallationsStoredRegistrationError *registrationError;
-
 /// Instance ID checkin data imported from IID checkin store as a part of IID migration.
 @property(nonatomic, nullable) FIRInstallationsStoredIIDCheckin *IIDCheckin;
 

FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.m

@@ -19,13 +19,11 @@
 #import "FIRInstallationsLogger.h"
 #import "FIRInstallationsStoredAuthToken.h"
 #import "FIRInstallationsStoredIIDCheckin.h"
-#import "FIRInstallationsStoredRegistrationError.h"
 
 NSString *const kFIRInstallationsStoredItemFirebaseInstallationIDKey = @"firebaseInstallationID";
 NSString *const kFIRInstallationsStoredItemRefreshTokenKey = @"refreshToken";
 NSString *const kFIRInstallationsStoredItemAuthTokenKey = @"authToken";
 NSString *const kFIRInstallationsStoredItemRegistrationStatusKey = @"registrationStatus";
-NSString *const kFIRInstallationsStoredItemRegistrationErrorKey = @"registrationError";
 NSString *const kFIRInstallationsStoredItemIIDCheckinKey = @"IIDCheckin";
 NSString *const kFIRInstallationsStoredItemStorageVersionKey = @"storageVersion";
 
@@ -44,8 +42,6 @@ - (void)encodeWithCoder:(nonnull NSCoder *)aCoder {
   [aCoder encodeObject:self.authToken forKey:kFIRInstallationsStoredItemAuthTokenKey];
   [aCoder encodeInteger:self.registrationStatus
                  forKey:kFIRInstallationsStoredItemRegistrationStatusKey];
-  [aCoder encodeObject:self.registrationError
-                forKey:kFIRInstallationsStoredItemRegistrationErrorKey];
   [aCoder encodeObject:self.IIDCheckin forKey:kFIRInstallationsStoredItemIIDCheckinKey];
   [aCoder encodeInteger:self.storageVersion forKey:kFIRInstallationsStoredItemStorageVersionKey];
 }
@@ -71,9 +67,6 @@ - (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder {
                                           forKey:kFIRInstallationsStoredItemAuthTokenKey];
   item.registrationStatus =
       [aDecoder decodeIntegerForKey:kFIRInstallationsStoredItemRegistrationStatusKey];
-  item.registrationError =
-      [aDecoder decodeObjectOfClass:[FIRInstallationsStoredRegistrationError class]
-                             forKey:kFIRInstallationsStoredItemRegistrationErrorKey];
   item.IIDCheckin = [aDecoder decodeObjectOfClass:[FIRInstallationsStoredIIDCheckin class]
                                            forKey:kFIRInstallationsStoredItemIIDCheckinKey];