FirebaseInstallations: re-generate Installation on HTTP 401 and 404 (#4079)

* WIP: FID re-generating introduced.

* WIP: FID regenerating tests.

* FIS regenerate: tests and fixes.

* Cleanup.

Author: maksymmalyhin

FirebaseInstallations/Source/Library/Errors/FIRInstallationsHTTPError.h

@@ -32,6 +32,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 NS_ASSUME_NONNULL_END
 
+typedef NS_ENUM(NSInteger, FIRInstallationsHTTPCodes) {
+  FIRInstallationsHTTPCodesTooManyRequests = 429,
+  FIRInstallationsHTTPCodesServerInternalError = 500,
+};
+
 /** Possible response HTTP codes for `CreateInstallation` API request. */
 typedef NS_ENUM(NSInteger, FIRInstallationsRegistrationHTTPCode) {
   FIRInstallationsRegistrationHTTPCodeSuccess = 201,
@@ -43,4 +48,7 @@ typedef NS_ENUM(NSInteger, FIRInstallationsRegistrationHTTPCode) {
   FIRInstallationsRegistrationHTTPCodeServerInternalError = 500
 };
 
-extern NSInteger const kFIRInstallationsAPIInternalErrorHTTPCode;
+typedef NS_ENUM(NSInteger, FIRInstallationsAuthTokenHTTPCode) {
+  FIRInstallationsAuthTokenHTTPCodeInvalidAuthentication = 401,
+  FIRInstallationsAuthTokenHTTPCodeFIDNotFound = 404,
+};

FirebaseInstallations/Source/Library/Errors/FIRInstallationsHTTPError.m

@@ -76,5 +76,3 @@ + (BOOL)supportsSecureCoding {
 }
 
 @end
-
-NSInteger const kFIRInstallationsAPIInternalErrorHTTPCode = 500;

FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsIDController.m

@@ -325,7 +325,7 @@ - (FIRInstallationsStoredRegistrationParameters *)currentRegistrationParameters
 #pragma mark - Auth Token
 
 - (FBLPromise<FIRInstallationsItem *> *)getAuthTokenForcingRefresh:(BOOL)forceRefresh {
-  if (forceRefresh) {
+  if (forceRefresh || [self.authTokenForcingRefreshPromiseCache getExistingPendingPromise] != nil) {
     return [self.authTokenForcingRefreshPromiseCache getExistingPendingOrCreateNewPromise];
   } else {
     return [self.authTokenPromiseCache getExistingPendingOrCreateNewPromise];
@@ -353,11 +353,37 @@ - (FIRInstallationsStoredRegistrationParameters *)currentRegistrationParameters
           return registeredInstallation;
         }
       })
-      .catch(^void(NSError *error){
-          // TODO: Handle the errors.
+      .recover(^id(NSError *error) {
+        return [self regenerateFIDOnRefreshTokenErrorIfNeeded:error];
       });
 }
 
+- (id)regenerateFIDOnRefreshTokenErrorIfNeeded:(NSError *)error {
+  if (![error isKindOfClass:[FIRInstallationsHTTPError class]]) {
+    // No recovery possible. Return the same error.
+    return error;
+  }
+
+  FIRInstallationsHTTPError *HTTPError = (FIRInstallationsHTTPError *)error;
+  switch (HTTPError.HTTPResponse.statusCode) {
+    case FIRInstallationsAuthTokenHTTPCodeInvalidAuthentication:
+    case FIRInstallationsAuthTokenHTTPCodeFIDNotFound:
+      // The stored installation was damaged or blocked by the server.
+      // Delete the stored installation then generate and register a new one.
+      return [self getInstallationItem]
+          .then(^FBLPromise<NSNull *> *(FIRInstallationsItem *installation) {
+            return [self deleteInstallationLocally:installation];
+          })
+          .then(^FBLPromise<FIRInstallationsItem *> *(id result) {
+            return [self installationWithValidAuthTokenForcingRefresh:NO];
+          });
+
+    default:
+      // No recovery possible. Return the same error.
+      return error;
+  }
+}
+
 #pragma mark - Delete FID
 
 - (FBLPromise<NSNull *> *)deleteInstallation {
@@ -380,9 +406,13 @@ - (FIRInstallationsStoredRegistrationParameters *)currentRegistrationParameters
       })
       .then(^id(FIRInstallationsItem *installation) {
         // Remove the installation from the local storage.
-        return [self.installationsStore removeInstallationForAppID:installation.appID
-                                                           appName:installation.firebaseAppName];
-      })
+        return [self deleteInstallationLocally:installation];
+      });
+}
+
+- (FBLPromise<NSNull *> *)deleteInstallationLocally:(FIRInstallationsItem *)installation {
+  return [self.installationsStore removeInstallationForAppID:installation.appID
+                                                     appName:installation.firebaseAppName]
       .then(^FBLPromise<NSNull *> *(NSNull *result) {
         return [self deleteExistingIIDIfNeeded];
       })

FirebaseInstallations/Source/Tests/Unit/FIRInstallationsAPIServiceTests.m

@@ -178,7 +178,7 @@ - (void)testRegisterInstallation_WhenError500_ThenRetriesOnce {
   NSData *successResponseData =
       [self loadFixtureNamed:@"APIRegisterInstallationResponseSuccess.json"];
   taskCompletion(successResponseData,
-                 [self responseWithStatusCode:kFIRInstallationsAPIInternalErrorHTTPCode], nil);
+                 [self responseWithStatusCode:FIRInstallationsHTTPCodesServerInternalError], nil);
 
   // 6.1. Expect network request to send again.
   id mockDataTask2 = OCMClassMock([NSURLSessionDataTask class]);
@@ -192,7 +192,7 @@ - (void)testRegisterInstallation_WhenError500_ThenRetriesOnce {
 
   // 6.3. Send network response again.
   taskCompletion(successResponseData,
-                 [self responseWithStatusCode:kFIRInstallationsAPIInternalErrorHTTPCode], nil);
+                 [self responseWithStatusCode:FIRInstallationsHTTPCodesServerInternalError], nil);
 
   // 7. Check result.
   XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
@@ -202,7 +202,7 @@ - (void)testRegisterInstallation_WhenError500_ThenRetriesOnce {
 
   XCTAssertTrue([promise.error isKindOfClass:[FIRInstallationsHTTPError class]]);
   FIRInstallationsHTTPError *HTTPError = (FIRInstallationsHTTPError *)promise.error;
-  XCTAssertEqual(HTTPError.HTTPResponse.statusCode, kFIRInstallationsAPIInternalErrorHTTPCode);
+  XCTAssertEqual(HTTPError.HTTPResponse.statusCode, FIRInstallationsHTTPCodesServerInternalError);
 }
 
 - (void)testRefreshAuthTokenSuccess {
@@ -353,7 +353,7 @@ - (void)testRefreshAuthToken_WhenAPIError500_ThenRetriesOnce {
 
   // 5. Call the data task completion.
   taskCompletion(errorResponseData,
-                 [self responseWithStatusCode:kFIRInstallationsAPIInternalErrorHTTPCode], nil);
+                 [self responseWithStatusCode:FIRInstallationsHTTPCodesServerInternalError], nil);
 
   // 6. Retry:
 
@@ -368,13 +368,14 @@ - (void)testRefreshAuthToken_WhenAPIError500_ThenRetriesOnce {
 
   // 6.2. Send the API response again.
   taskCompletion(errorResponseData,
-                 [self responseWithStatusCode:kFIRInstallationsAPIInternalErrorHTTPCode], nil);
+                 [self responseWithStatusCode:FIRInstallationsHTTPCodesServerInternalError], nil);
 
   // 6. Check result.
   XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
-  XCTAssertTrue([FIRInstallationsErrorUtil isAPIError:promise.error
-                                         withHTTPCode:kFIRInstallationsAPIInternalErrorHTTPCode]);
+  XCTAssertTrue([FIRInstallationsErrorUtil
+        isAPIError:promise.error
+      withHTTPCode:FIRInstallationsHTTPCodesServerInternalError]);
   XCTAssertNil(promise.value);
 }
 
@@ -549,7 +550,8 @@ - (void)testDeleteInstallation_WhenAPIError500_ThenRetriesOnce {
 
   // 5. Call the data task completion.
   // HTTP 200 but no data (a potential server failure).
-  taskCompletion(nil, [self responseWithStatusCode:kFIRInstallationsAPIInternalErrorHTTPCode], nil);
+  taskCompletion(nil, [self responseWithStatusCode:FIRInstallationsHTTPCodesServerInternalError],
+                 nil);
 
   // 6. Retry:
   // 6.1. Wait for the API request to be sent again.
@@ -562,13 +564,15 @@ - (void)testDeleteInstallation_WhenAPIError500_ThenRetriesOnce {
   OCMVerifyAllWithDelay(mockDataTask1, 1.5);
 
   // 6.1. Send another response.
-  taskCompletion(nil, [self responseWithStatusCode:kFIRInstallationsAPIInternalErrorHTTPCode], nil);
+  taskCompletion(nil, [self responseWithStatusCode:FIRInstallationsHTTPCodesServerInternalError],
+                 nil);
 
   // 7. Check result.
   FBLWaitForPromisesWithTimeout(0.5);
 
-  XCTAssertTrue([FIRInstallationsErrorUtil isAPIError:promise.error
-                                         withHTTPCode:kFIRInstallationsAPIInternalErrorHTTPCode]);
+  XCTAssertTrue([FIRInstallationsErrorUtil
+        isAPIError:promise.error
+      withHTTPCode:FIRInstallationsHTTPCodesServerInternalError]);
   XCTAssertNil(promise.value);
 }
 

FirebaseInstallations/Source/Tests/Unit/FIRInstallationsIDControllerTests.m

@@ -553,6 +553,89 @@ - (void)testGetAuthTokenForceRefresh_WhenCalledSeveralTimes_OnlyOneOperationIsPe
   }
 }
 
+- (void)testGetAuthToken_WhenAPIResponse401_ThenFISResetAndReregistered {
+  NSTimeInterval timeout = 0.5;
+
+  // 1.1. Expect installation to be requested from the store.
+  FIRInstallationsItem *storedInstallation =
+      [FIRInstallationsItem createRegisteredInstallationItem];
+  [self expectInstallationStoreToBeRequestedAndReturnInstallation:storedInstallation];
+
+  // 1.2. Expect API request.
+  FBLPromise *rejectedAPIPromise = [FBLPromise pendingPromise];
+  OCMExpect([self.mockAPIService refreshAuthTokenForInstallation:storedInstallation])
+      .andReturn(rejectedAPIPromise);
+
+  // 2. Request auth token.
+  FBLPromise<FIRInstallationsItem *> *promise = [self.controller getAuthTokenForcingRefresh:YES];
+
+  // 3. Wait for refresh token request.
+  OCMVerifyAllWithDelay(self.mockAPIService, timeout);
+
+  // 4.1. Expect Installation to be requested before deletion.
+  [self expectInstallationStoreToBeRequestedAndReturnInstallation:storedInstallation];
+  // 4. Expect for FIS to be deleted locally.
+  NSArray<XCTestExpectation *> *deleteExpectations =
+      [self expectInstallationToBeDeletedLocally:storedInstallation];
+
+  // 6. Expect a new installation to be created and registered.
+  // 6.1. Expect to request FIS from storage.
+  [self expectInstallationsStoreGetInstallationNotFound];
+  // 6.2. Expect stored IID not found.
+  [self expectStoredIIDNotFound];
+  // 6.3. Expect new Installation to be stored.
+  __block FIRInstallationsItem *createdInstallation;
+  OCMExpect([self.mockInstallationsStore
+                saveInstallation:[OCMArg checkWithBlock:^BOOL(FIRInstallationsItem *obj) {
+                  [self assertValidCreatedInstallation:obj];
+
+                  createdInstallation = obj;
+                  return YES;
+                }]])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+  // 6.4. Expect registration API request to be sent.
+  FBLPromise<FIRInstallationsItem *> *registerPromise = [FBLPromise pendingPromise];
+  OCMExpect([self.mockAPIService registerInstallation:[OCMArg any]]).andReturn(registerPromise);
+
+  // 6.5. Reject API request promise with 401.
+  NSError *error401 = [FIRInstallationsErrorUtil APIErrorWithHTTPCode:404];
+  [rejectedAPIPromise reject:error401];
+  // 6.6. Wait local FIS to be deleted.
+  [self waitForExpectations:deleteExpectations timeout:timeout];
+
+  // 6.7 Wait for the new Installation to be stored.
+  OCMVerifyAllWithDelay(self.mockInstallationsStore, timeout);
+  // 6.8. Wait for registration API request to be sent.
+  OCMVerifyAllWithDelay(self.mockAPIService, timeout);
+  // 6.9.  Expect for the registered installation to be saved.
+  FIRInstallationsItem *registeredInstallation = [FIRInstallationsItem
+      createRegisteredInstallationItemWithAppID:createdInstallation.appID
+                                        appName:createdInstallation.firebaseAppName];
+
+  OCMExpect([self.mockInstallationsStore
+                saveInstallation:[OCMArg checkWithBlock:^BOOL(FIRInstallationsItem *obj) {
+                  XCTAssertEqual(registeredInstallation, obj);
+                  return YES;
+                }]])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+  // 6.9. Fulfill the registration API request promise.
+  [registerPromise fulfill:registeredInstallation];
+
+  // 7. Wait for promises.
+  XCTAssert(FBLWaitForPromisesWithTimeout(timeout));
+
+  // 8. Check.
+  OCMVerifyAll(self.mockInstallationsStore);
+  OCMVerifyAll(self.mockAPIService);
+
+  XCTAssertNil(promise.error);
+  XCTAssertNotNil(promise.value);
+
+  XCTAssertNotEqualObjects(promise.value.firebaseInstallationID,
+                           storedInstallation.firebaseInstallationID);
+  XCTAssertEqualObjects(promise.value, registeredInstallation);
+}
+
 #pragma mark - FID Deletion
 
 - (void)testDeleteRegisteredInstallation {
@@ -642,7 +725,7 @@ - (void)testDeleteRegisteredInstallation_WhenAPIRequestFails_ThenFailsAndInstall
   // 2. Expect API request to delete installation.
   FBLPromise *rejectedAPIPromise = [FBLPromise pendingPromise];
   NSError *error500 =
-      [FIRInstallationsErrorUtil APIErrorWithHTTPCode:kFIRInstallationsAPIInternalErrorHTTPCode];
+      [FIRInstallationsErrorUtil APIErrorWithHTTPCode:FIRInstallationsHTTPCodesServerInternalError];
   [rejectedAPIPromise reject:error500];
   OCMExpect([self.mockAPIService deleteInstallation:installation]).andReturn(rejectedAPIPromise);
 
@@ -814,6 +897,24 @@ - (void)testDeleteInstallation_WhenNotDefaultApp_ThenIIDIsNotDeleted {
   OCMVerifyAll(self.mockIIDStore);
 }
 
+- (NSArray<XCTestExpectation *> *)expectInstallationToBeDeletedLocally:
+    (FIRInstallationsItem *)installation {
+  // 3.1. Expect the installation to be removed from the storage.
+  OCMExpect([self.mockInstallationsStore removeInstallationForAppID:installation.appID
+                                                            appName:installation.firebaseAppName])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+
+  // 3.2. Expect IID to be deleted, because it is default app.
+  OCMExpect([self.mockIIDStore deleteExistingIID])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+
+  // 4. Expect FIRInstallationIDDidChangeNotification to be sent.
+  XCTestExpectation *notificationExpectation =
+      [self installationIDDidChangeNotificationExpectation];
+
+  return @[ notificationExpectation ];
+}
+
 // TODO: Test a single delete installation request at a time.
 
 #pragma mark - Notifications
@@ -1087,6 +1188,12 @@ - (void)expectInstallationsStoreGetInstallationNotFound {
       .andReturn(installationNotFoundPromise);
 }
 
+- (void)expectStoredIIDNotFound {
+  FBLPromise *rejectedPromise = [FBLPromise pendingPromise];
+  [rejectedPromise reject:[FIRInstallationsErrorUtil keychainErrorWithFunction:@"" status:-1]];
+  OCMExpect([self.mockIIDStore existingIID]).andReturn(rejectedPromise);
+}
+
 - (void)assertValidCreatedInstallation:(FIRInstallationsItem *)installation {
   XCTAssertEqualObjects([installation class], [FIRInstallationsItem class]);
   XCTAssertEqualObjects(installation.appID, self.appID);
@@ -1138,4 +1245,10 @@ - (FIRInstallationsStoredRegistrationParameters *)otherRegistrationParameters {
                                                                     projectID:projectID];
 }
 
+- (void)expectInstallationStoreToBeRequestedAndReturnInstallation:
+    (FIRInstallationsItem *)storedInstallation {
+  OCMExpect([self.mockInstallationsStore installationForAppID:self.appID appName:self.appName])
+      .andReturn([FBLPromise resolvedWith:storedInstallation]);
+}
+
 @end

FirebaseInstallations/Source/Tests/Unit/FIRInstallationsTests.m

@@ -137,7 +137,7 @@ - (void)testAuthTokenSuccess {
 - (void)testAuthTokenError {
   FBLPromise *errorPromise = [FBLPromise pendingPromise];
   [errorPromise reject:[FIRInstallationsErrorUtil
-                           APIErrorWithHTTPCode:kFIRInstallationsAPIInternalErrorHTTPCode]];
+                           APIErrorWithHTTPCode:FIRInstallationsHTTPCodesServerInternalError]];
   OCMExpect([self.mockIDController getAuthTokenForcingRefresh:NO]).andReturn(errorPromise);
 
   XCTestExpectation *tokenExpectation = [self expectationWithDescription:@"AuthTokenSuccess"];
@@ -186,7 +186,7 @@ - (void)testAuthTokenForcingRefreshSuccess {
 - (void)testAuthTokenForcingRefreshError {
   FBLPromise *errorPromise = [FBLPromise pendingPromise];
   [errorPromise reject:[FIRInstallationsErrorUtil
-                           APIErrorWithHTTPCode:kFIRInstallationsAPIInternalErrorHTTPCode]];
+                           APIErrorWithHTTPCode:FIRInstallationsHTTPCodesServerInternalError]];
   OCMExpect([self.mockIDController getAuthTokenForcingRefresh:YES]).andReturn(errorPromise);
 
   XCTestExpectation *tokenExpectation = [self expectationWithDescription:@"AuthTokenSuccess"];
@@ -221,7 +221,7 @@ - (void)testDeleteSuccess {
 - (void)testDeleteError {
   FBLPromise *errorPromise = [FBLPromise pendingPromise];
   NSError *APIError =
-      [FIRInstallationsErrorUtil APIErrorWithHTTPCode:kFIRInstallationsAPIInternalErrorHTTPCode];
+      [FIRInstallationsErrorUtil APIErrorWithHTTPCode:FIRInstallationsHTTPCodesServerInternalError];
   [errorPromise reject:APIError];
   OCMExpect([self.mockIDController deleteInstallation]).andReturn(errorPromise);