FIS: Additional FIRInstallationsItem validation (#6570)

* FIS API tests for no FID in response

* FIRInstallationsIDControllerTests: test names

* FIRInstallationsIDControllerTests: corrupted storage tests

* FIRInstallationsItem validation

* Fix FIRInstallationsItem.IIDDefaultToken copy

* Improve error description.

* FIRInstallationsItem validation error

* FIRInstallationsItem validation tests

* ./scripts/style.sh

* FIRInstallationsIDController: validate stored installation

* FIRInstallationsAPIService installation validation

* Changelog

Author: maksymmalyhin

FirebaseInstallations/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.7.1 -- Unreleased
+- [changed] Additional `FIRInstallationsItem` validation to catch potential storage issues. (#6570)
+
 # v1.7.0 -- M78
 - [changed] Use ephemeral `NSURLSession` to prevent caching of request/response. (#6226)
 - [changed] Backoff added for some error to prevent unnecessary API requests. (#6232)

FirebaseInstallations/Source/Library/Errors/FIRInstallationsErrorUtil.h

@@ -56,6 +56,10 @@ void FIRInstallationsItemSetErrorToPointer(NSError *error, NSError **pointer);
 
 + (FBLPromise *)rejectedPromiseWithError:(NSError *)error;
 
++ (NSError *)installationsErrorWithCode:(FIRInstallationsErrorCode)code
+                          failureReason:(nullable NSString *)failureReason
+                        underlyingError:(nullable NSError *)underlyingError;
+
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseInstallations/Source/Library/Errors/FIRInstallationsErrorUtil.m

@@ -128,7 +128,10 @@ + (NSError *)installationsErrorWithCode:(FIRInstallationsErrorCode)code
                         underlyingError:(nullable NSError *)underlyingError {
   NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
   userInfo[NSUnderlyingErrorKey] = underlyingError;
-  userInfo[NSLocalizedFailureReasonErrorKey] = failureReason;
+  userInfo[NSLocalizedFailureReasonErrorKey] =
+      failureReason
+          ?: [NSString
+                 stringWithFormat:@"Underlying error: %@", underlyingError.localizedDescription];
 
   return [NSError errorWithDomain:kFirebaseInstallationsErrorDomain code:code userInfo:userInfo];
 }

FirebaseInstallations/Source/Library/FIRInstallationsItem.h

@@ -67,6 +67,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (NSString *)identifier;
 
+/** Validates if all the required item fields are populated and values don't explicitly conflict
+ * with each other.
+ *  @param outError A reference to be populated with an error containing validation failure details.
+ *  @return `YES` if the item it valid, `NO` otherwise.
+ */
+- (BOOL)isValid:(NSError *_Nullable *)outError;
+
 /**
  * The installation identifier.
  * @param appID A `FirebaseApp` identifier.

FirebaseInstallations/Source/Library/FIRInstallationsItem.m

@@ -19,6 +19,8 @@
 #import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredAuthToken.h"
 #import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.h"
 
+#import "FirebaseInstallations/Source/Library/Errors/FIRInstallationsErrorUtil.h"
+
 @implementation FIRInstallationsItem
 
 - (instancetype)initWithAppID:(NSString *)appID firebaseAppName:(NSString *)firebaseAppName {
@@ -37,6 +39,7 @@ - (nonnull id)copyWithZone:(nullable NSZone *)zone {
   clone.refreshToken = [self.refreshToken copy];
   clone.authToken = [self.authToken copy];
   clone.registrationStatus = self.registrationStatus;
+  clone.IIDDefaultToken = [self.IIDDefaultToken copy];
 
   return clone;
 }
@@ -63,6 +66,60 @@ - (nonnull NSString *)identifier {
   return [[self class] identifierWithAppID:self.appID appName:self.firebaseAppName];
 }
 
+- (BOOL)isValid:(NSError *_Nullable *)outError {
+  NSMutableArray<NSString *> *validationIssues = [NSMutableArray array];
+
+  if (self.appID.length == 0) {
+    [validationIssues addObject:@"`appID` must not be empty"];
+  }
+
+  if (self.firebaseAppName.length == 0) {
+    [validationIssues addObject:@"`firebaseAppName` must not be empty"];
+  }
+
+  if (self.firebaseInstallationID.length == 0) {
+    [validationIssues addObject:@"`firebaseInstallationID` must not be empty"];
+  }
+
+  switch (self.registrationStatus) {
+    case FIRInstallationStatusUnknown:
+      [validationIssues addObject:@"invalid `registrationStatus`"];
+      break;
+
+    case FIRInstallationStatusRegistered:
+      if (self.refreshToken == 0) {
+        [validationIssues addObject:@"registered installation must have non-empty `refreshToken`"];
+      }
+
+      if (self.authToken.token == 0) {
+        [validationIssues
+            addObject:@"registered installation must have non-empty `authToken.token`"];
+      }
+
+      if (self.authToken.expirationDate == nil) {
+        [validationIssues
+            addObject:@"registered installation must have non-empty `authToken.expirationDate`"];
+      }
+
+    case FIRInstallationStatusUnregistered:
+      break;
+  }
+
+  BOOL isValid = validationIssues.count == 0;
+
+  if (!isValid && outError) {
+    NSString *failureReason =
+        [NSString stringWithFormat:@"FIRInstallationsItem validation errors: %@",
+                                   [validationIssues componentsJoinedByString:@", "]];
+    *outError =
+        [FIRInstallationsErrorUtil installationsErrorWithCode:FIRInstallationsErrorCodeUnknown
+                                                failureReason:failureReason
+                                              underlyingError:nil];
+  }
+
+  return isValid;
+}
+
 + (NSString *)identifierWithAppID:(NSString *)appID appName:(NSString *)appName {
   return [appID stringByAppendingString:appName];
 }

FirebaseInstallations/Source/Library/FIRInstallationsLogger.h

@@ -36,6 +36,7 @@ extern NSString *const kFIRInstallationsMessageCodeNewGetInstallationOperationCr
 extern NSString *const kFIRInstallationsMessageCodeNewGetAuthTokenOperationCreated;
 extern NSString *const kFIRInstallationsMessageCodeNewDeleteInstallationOperationCreated;
 extern NSString *const kFIRInstallationsMessageCodeInvalidFirebaseConfiguration;
+extern NSString *const kFIRInstallationsMessageCodeCorruptedStoredInstallation;
 
 // FIRInstallationsStoredItem.m
 extern NSString *const kFIRInstallationsMessageCodeInstallationCoderVersionMismatch;

FirebaseInstallations/Source/Library/FIRInstallationsLogger.m

@@ -34,6 +34,7 @@
 NSString *const kFIRInstallationsMessageCodeNewGetAuthTokenOperationCreated = @"I-FIS002001";
 NSString *const kFIRInstallationsMessageCodeNewDeleteInstallationOperationCreated = @"I-FIS002002";
 NSString *const kFIRInstallationsMessageCodeInvalidFirebaseConfiguration = @"I-FIS002003";
+NSString *const kFIRInstallationsMessageCodeCorruptedStoredInstallation = @"I-FIS002004";
 
 // FIRInstallationsStoredItem.m
 NSString *const kFIRInstallationsMessageCodeInstallationCoderVersionMismatch = @"I-FIS003000";

FirebaseInstallations/Source/Library/InstallationsAPI/FIRInstallationsAPIService.m

@@ -92,7 +92,10 @@ - (instancetype)initWithURLSession:(NSURLSession *)URLSession
 #pragma mark - Public
 
 - (FBLPromise<FIRInstallationsItem *> *)registerInstallation:(FIRInstallationsItem *)installation {
-  return [self registerRequestWithInstallation:installation]
+  return [self validateInstallation:installation]
+      .then(^id _Nullable(FIRInstallationsItem *_Nullable validInstallation) {
+        return [self registerRequestWithInstallation:validInstallation];
+      })
       .then(^id _Nullable(NSURLRequest *_Nullable request) {
         return [self sendURLRequest:request];
       })
@@ -138,7 +141,9 @@ - (instancetype)initWithURLSession:(NSURLSession *)URLSession
   NSURL *URL = [NSURL URLWithString:URLString];
 
   NSDictionary *bodyDict = @{
-    @"fid" : installation.firebaseInstallationID,
+    // `firebaseInstallationID` is validated before but let's make sure it is not `nil` one more
+    // time to prevent a crash.
+    @"fid" : installation.firebaseInstallationID ?: @"",
     @"authVersion" : @"FIS_v2",
     @"appId" : installation.appID,
     @"sdkVersion" : [self SDKVersion]
@@ -346,6 +351,20 @@ - (NSString *)SDKVersion {
   return [NSString stringWithFormat:@"i:%s", FIRInstallationsVersionStr];
 }
 
+#pragma mark - Validation
+
+- (FBLPromise<FIRInstallationsItem *> *)validateInstallation:(FIRInstallationsItem *)installation {
+  FBLPromise<FIRInstallationsItem *> *result = [FBLPromise pendingPromise];
+
+  NSError *validationError;
+  if ([installation isValid:&validationError]) {
+    [result fulfill:installation];
+  } else {
+    [result reject:validationError];
+  }
+  return result;
+}
+
 #pragma mark - JSON
 
 - (void)setJSONHTTPBody:(NSDictionary<NSString *, id> *)body

FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsIDController.m

@@ -180,18 +180,11 @@ - (instancetype)initWithGoogleAppID:(NSString *)appID
 - (FBLPromise<FIRInstallationsItem *> *)getStoredInstallation {
   return [self.installationsStore installationForAppID:self.appID appName:self.appName].validate(
       ^BOOL(FIRInstallationsItem *installation) {
-        BOOL isValid = NO;
-        switch (installation.registrationStatus) {
-          case FIRInstallationStatusUnregistered:
-          case FIRInstallationStatusRegistered:
-            isValid = YES;
-            break;
-
-          case FIRInstallationStatusUnknown:
-            isValid = NO;
-            break;
-        }
-
+        NSError *validationError;
+        BOOL isValid = [installation isValid:&validationError];
+        FIRLogWarning(
+            kFIRLoggerInstallations, kFIRInstallationsMessageCodeCorruptedStoredInstallation,
+            @"Stored installation validation error: %@", validationError.localizedDescription);
         return isValid;
       });
 }

FirebaseInstallations/Source/Tests/Fixture/APIRegisterInstallationResponseSuccessNoFID.json

@@ -0,0 +1,8 @@
+{
+    "name": "projects/project-id/installations/eapzYQai_g8flVQyfKoGs7",
+    "refreshToken": "aaaaaaabbbbbbbbcccccccccdddddddd00000000",
+    "authToken": {
+      "token": "aaaaaaaaaaaaaa.bbbbbbbbbbbbbbbbb.cccccccccccccccccccccccc",
+      "expiresIn": "604800s"
+    }
+  }