FirebaseInstallations: CreateInstallation API request error handling

FirebaseInstallations/Source/Library/Errors/FIRInstallationsHTTPError.h

@@ -31,3 +31,14 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 NS_ASSUME_NONNULL_END
+
+/** Possible response HTTP codes for `CreateInstallation` API request. */
+typedef NS_ENUM(NSInteger, FIRInstallationsRegistrationHTTPCode) {
+  FIRInstallationsRegistrationHTTPCodeSuccess = 201,
+  FIRInstallationsRegistrationHTTPCodeInvalidArgument = 400,
+  FIRInstallationsRegistrationHTTPCodeInvalidAPIKey = 401,
+  FIRInstallationsRegistrationHTTPCodeAPIKeyToProjectIDMismatch = 403,
+  FIRInstallationsRegistrationHTTPCodeProjectNotFound = 404,
+  FIRInstallationsRegistrationHTTPCodeTooManyRequests = 429,
+  FIRInstallationsRegistrationHTTPCodeServerInternalError = 500
+};

FirebaseInstallations/Source/Library/FIRInstallationsItem.h

@@ -20,6 +20,8 @@
 
 @class FIRInstallationsStoredItem;
 @class FIRInstallationsStoredAuthToken;
+@class FIRInstallationsStoredRegistrationError;
+@class FIRInstallationsStoredRegistrationParameters;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -43,6 +45,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, nullable) FIRInstallationsStoredAuthToken *authToken;
 @property(nonatomic, assign) FIRInstallationsStatus registrationStatus;
 
+@property(nonatomic, nullable) FIRInstallationsStoredRegistrationError *registrationError;
+
 - (instancetype)initWithAppID:(NSString *)appID firebaseAppName:(NSString *)firebaseAppName;
 
 /**
@@ -77,6 +81,15 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (NSString *)generateFID;
 
+/**
+ * Updates `registrationStatus` and `registrationError` accordingly.
+ * @param error The error for the Installation Registration API request.
+ * @param registrationParameters The parameters used for the  Installation Registration API request.
+ */
+- (void)updateWithRegistrationError:(NSError *)error
+             registrationParameters:
+                 (FIRInstallationsStoredRegistrationParameters *)registrationParameters;
+
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseInstallations/Source/Library/FIRInstallationsItem.m

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

FirebaseInstallations/Source/Library/FIRInstallationsLogger.h

@@ -35,9 +35,17 @@ extern NSString *const kFIRInstallationsMessageCodeAPIResponseParsingAuthTokenSu
 extern NSString *const kFIRInstallationsMessageCodeNewGetInstallationOperationCreated;
 extern NSString *const kFIRInstallationsMessageCodeNewGetAuthTokenOperationCreated;
 extern NSString *const kFIRInstallationsMessageCodeNewDeleteInstallationOperationCreated;
+extern NSString *const kFIRInstallationsMessageCodeInvalidFirebaseConfiguration;
 
 // FIRInstallationsStoredItem.m
 extern NSString *const kFIRInstallationsMessageCodeInstallationCoderVersionMismatch;
 
 // FIRInstallationsStoredAuthToken.m
 extern NSString *const kFIRInstallationsMessageCodeAuthTokenCoderVersionMismatch;
+
+// FIRInstallationsStoredRegistrationError.m
+extern NSString *const kFIRInstallationsMessageCodeRegistrationErrorCoderVersionMismatch;
+extern NSString *const kFIRInstallationsMessageCodeRegistrationErrorFailedToDecode;
+
+// FIRInstallationsStoredRegistrationParameters.m
+extern NSString *const kFIRInstallationsMessageCodeRegistrationParametersCoderVersionMismatch;

FirebaseInstallations/Source/Library/FIRInstallationsLogger.m

@@ -33,9 +33,18 @@
 NSString *const kFIRInstallationsMessageCodeNewGetInstallationOperationCreated = @"I-FIS002000";
 NSString *const kFIRInstallationsMessageCodeNewGetAuthTokenOperationCreated = @"I-FIS002001";
 NSString *const kFIRInstallationsMessageCodeNewDeleteInstallationOperationCreated = @"I-FIS002002";
+NSString *const kFIRInstallationsMessageCodeInvalidFirebaseConfiguration = @"I-FIS002003";
 
 // FIRInstallationsStoredItem.m
 NSString *const kFIRInstallationsMessageCodeInstallationCoderVersionMismatch = @"I-FIS003000";
 
 // 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";

FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.h

@@ -26,6 +26,9 @@ 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

@@ -55,8 +55,6 @@ - (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

@@ -31,9 +31,13 @@
 #import "FIRInstallationsLogger.h"
 #import "FIRInstallationsSingleOperationPromiseCache.h"
 #import "FIRInstallationsStore.h"
-#import "FIRInstallationsStoredAuthToken.h"
 #import "FIRSecureStorage.h"
 
+#import "FIRInstallationsHTTPError.h"
+#import "FIRInstallationsStoredAuthToken.h"
+#import "FIRInstallationsStoredRegistrationError.h"
+#import "FIRInstallationsStoredRegistrationParameters.h"
+
 const NSNotificationName FIRInstallationIDDidChangeNotification =
     @"FIRInstallationIDDidChangeNotification";
 NSString *const kFIRInstallationIDDidChangeNotificationAppNameKey =
@@ -135,9 +139,21 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
               __PRETTY_FUNCTION__, self.appName);
 
   FBLPromise<FIRInstallationsItem *> *installationItemPromise =
-      [self getStoredInstallation].recover(^id(NSError *error) {
-        return [self createAndSaveFID];
-      });
+      [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 areInstallationRegistrationParametersEqualToCurrent:
+                          installation.registrationError.registrationParameters]) {
+              return installation.registrationError.APIError;
+            }
+
+            return installation;
+          });
 
   // Initiate registration process on success if needed, but return the installation without waiting
   // for it.
@@ -156,6 +172,7 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
         switch (installation.registrationStatus) {
           case FIRInstallationStatusUnregistered:
           case FIRInstallationStatusRegistered:
+          case FIRInstallationStatusRegistrationFailed:
             isValid = YES;
             break;
 
@@ -201,6 +218,14 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
   });
 }
 
+- (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]);
+}
+
 #pragma mark - FID registration
 
 - (FBLPromise<FIRInstallationsItem *> *)registerInstallationIfNeeded:
@@ -212,11 +237,15 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
 
     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];
+      })
       .then(^id(FIRInstallationsItem *registeredInstallation) {
         // Expected successful result: @[FIRInstallationsItem *registeredInstallation, NSNull]
         return [FBLPromise all:@[
@@ -234,6 +263,56 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
       });
 }
 
+- (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
+                             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]]) {
+    return NO;
+  }
+
+  switch (HTTPError.HTTPResponse.statusCode) {
+    // These are the errors that require Firebase configuration change.
+    case FIRInstallationsRegistrationHTTPCodeInvalidArgument:
+    case FIRInstallationsRegistrationHTTPCodeInvalidAPIKey:
+    case FIRInstallationsRegistrationHTTPCodeAPIKeyToProjectIDMismatch:
+    case FIRInstallationsRegistrationHTTPCodeProjectNotFound:
+      return YES;
+
+    default:
+      return NO;
+  }
+}
+
+- (FIRInstallationsStoredRegistrationParameters *)currentRegistrationParameters {
+  return [[FIRInstallationsStoredRegistrationParameters alloc]
+      initWithAPIKey:self.APIService.APIKey
+           projectID:self.APIService.projectID];
+}
+
 #pragma mark - Auth Token
 
 - (FBLPromise<FIRInstallationsItem *> *)getAuthTokenForcingRefresh:(BOOL)forceRefresh {
@@ -321,6 +400,7 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
   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,4 +32,7 @@ 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/FIRInstallationsStoredAuthToken.h

@@ -51,7 +51,7 @@ typedef NS_ENUM(NSInteger, FIRInstallationsAuthTokenStatus) {
 @property(nullable, copy) NSDate *expirationDate;
 
 /// The version of local storage.
-@property(nonatomic) NSInteger storageVersion;
+@property(nonatomic, readonly) NSInteger storageVersion;
 
 @end
 

FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredAuthToken.m

@@ -27,12 +27,15 @@
 
 @implementation FIRInstallationsStoredAuthToken
 
+- (NSInteger)storageVersion {
+  return kFIRInstallationsStoredAuthTokenStorageVersion;
+}
+
 - (nonnull id)copyWithZone:(nullable NSZone *)zone {
   FIRInstallationsStoredAuthToken *clone = [[FIRInstallationsStoredAuthToken alloc] init];
   clone.status = self.status;
   clone.token = [self.token copy];
   clone.expirationDate = self.expirationDate;
-  clone.storageVersion = self.storageVersion;
   return clone;
 }
 
@@ -41,7 +44,7 @@ - (void)encodeWithCoder:(nonnull NSCoder *)aCoder {
   [aCoder encodeObject:self.token forKey:kFIRInstallationsStoredAuthTokenTokenKey];
   [aCoder encodeObject:self.expirationDate
                 forKey:kFIRInstallationsStoredAuthTokenExpirationDateKey];
-  [aCoder encodeInteger:kFIRInstallationsStoredAuthTokenStorageVersion
+  [aCoder encodeInteger:self.storageVersion
                  forKey:kFIRInstallationsStoredAuthTokenStorageVersionKey];
 }
 

FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.h

@@ -19,6 +19,7 @@
 #import "FIRInstallationsStatus.h"
 
 @class FIRInstallationsStoredAuthToken;
+@class FIRInstallationsStoredRegistrationError;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -40,8 +41,10 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, nullable) FIRInstallationsStoredAuthToken *authToken;
 @property(nonatomic) FIRInstallationsStatus registrationStatus;
 
+@property(nonatomic, nullable) FIRInstallationsStoredRegistrationError *registrationError;
+
 /// The version of local storage.
-@property(nonatomic) NSInteger storageVersion;
+@property(nonatomic, readonly) NSInteger storageVersion;
 @end
 
 NS_ASSUME_NONNULL_END