FIS: Make sure refreshed auth token is stored to the storage. (#4146)

* FIRInstallationsIDControllerTests: test refreshed token is stored.

* FIRInstallationsIDControllerTests: all required tests updated to expect refreshed token to be stored.

* Tests: assert all FBLWaitForPromisesWithTimeout

* FIRInstallationsIDController: saving refreshed token implemented.

* FIRInstallationsIDController: duplicated code removed.

Author: maksymmalyhin

FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsIDController.m

@@ -257,13 +257,9 @@ - (FIRInstallationsItem *)createInstallationWithFID:(NSString *)FID
         }
       })
       .then(^id(FIRInstallationsItem *registeredInstallation) {
-        // Expected successful result: @[FIRInstallationsItem *registeredInstallation, NSNull]
-        return [FBLPromise all:@[
-          registeredInstallation, [self.installationsStore saveInstallation:registeredInstallation]
-        ]];
+        return [self saveInstallation:registeredInstallation];
       })
-      .then(^FIRInstallationsItem *(NSArray *result) {
-        FIRInstallationsItem *registeredInstallation = result.firstObject;
+      .then(^FIRInstallationsItem *(FIRInstallationsItem *registeredInstallation) {
         // Server may respond with a different FID if the sent one cannot be accepted.
         if (![registeredInstallation.firebaseInstallationID
                 isEqualToString:installation.firebaseInstallationID]) {
@@ -318,7 +314,7 @@ - (BOOL)doesRegistrationErrorRequireConfigChange:(NSError *)error {
             [registeredInstallation.authToken.expirationDate timeIntervalSinceDate:[NSDate date]] <
             kFIRInstallationsTokenExpirationThreshold;
         if (forceRefresh || isTokenExpiredOrExpiresSoon) {
-          return [self.APIService refreshAuthTokenForInstallation:registeredInstallation];
+          return [self refreshAuthTokenForInstallation:registeredInstallation];
         } else {
           return registeredInstallation;
         }
@@ -328,6 +324,14 @@ - (BOOL)doesRegistrationErrorRequireConfigChange:(NSError *)error {
       });
 }
 
+- (FBLPromise<FIRInstallationsItem *> *)refreshAuthTokenForInstallation:
+    (FIRInstallationsItem *)installation {
+  return [[self.APIService refreshAuthTokenForInstallation:installation]
+      then:^id _Nullable(FIRInstallationsItem *_Nullable refreshedInstallation) {
+        return [self saveInstallation:refreshedInstallation];
+      }];
+}
+
 - (id)regenerateFIDOnRefreshTokenErrorIfNeeded:(NSError *)error {
   if (![error isKindOfClass:[FIRInstallationsHTTPError class]]) {
     // No recovery possible. Return the same error.

FirebaseInstallations/Source/Tests/Unit/FIRInstallationsAPIServiceTests.m

@@ -132,7 +132,7 @@ - (void)testRegisterInstallationSuccess {
   taskCompletion(successResponseData, [self responseWithStatusCode:201], nil);
 
   // 6. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertNotNil(promise.value);
@@ -254,7 +254,7 @@ - (void)testRefreshAuthTokenSuccess {
   taskCompletion(successResponseData, [self responseWithStatusCode:200], nil);
 
   // 6. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertNotNil(promise.value);
@@ -313,7 +313,7 @@ - (void)testRefreshAuthTokenAPIError {
   taskCompletion(errorResponseData, [self responseWithStatusCode:401], nil);
 
   // 6. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertTrue([FIRInstallationsErrorUtil isAPIError:promise.error withHTTPCode:401]);
   XCTAssertNil(promise.value);
@@ -426,7 +426,7 @@ - (void)testRefreshAuthTokenDataNil {
   taskCompletion(nil, [self responseWithStatusCode:200], nil);
 
   // 6. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertEqualObjects(promise.error.userInfo[NSLocalizedFailureReasonErrorKey],
                         @"Failed to serialize JSON data.");
@@ -472,7 +472,7 @@ - (void)testDeleteInstallationSuccess {
   taskCompletion(successResponseData, [self responseWithStatusCode:200], nil);
 
   // 6. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertEqual(promise.value, installation);
@@ -516,7 +516,7 @@ - (void)testDeleteInstallationErrorNotFound {
   taskCompletion(nil, [self responseWithStatusCode:404], nil);
 
   // 6. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertTrue([FIRInstallationsErrorUtil isAPIError:promise.error withHTTPCode:404]);
   XCTAssertNil(promise.value);
@@ -575,7 +575,7 @@ - (void)testDeleteInstallation_WhenAPIError500_ThenRetriesOnce {
                  nil);
 
   // 7. Check result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertTrue([FIRInstallationsErrorUtil
         isAPIError:promise.error

FirebaseInstallations/Source/Tests/Unit/FIRInstallationsIDControllerTests.m

@@ -392,7 +392,7 @@ - (void)testGetAuthToken_WhenValidInstallationExists_ThenItIsReturned {
   FBLPromise<FIRInstallationsItem *> *promise = [self.controller getAuthTokenForcingRefresh:NO];
 
   // 3. Wait for the promise to resolve.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   // 4. Check.
   OCMVerifyAll(self.mockInstallationsStore);
@@ -414,19 +414,15 @@ - (void)testGetAuthToken_WhenValidInstallationWithExpiredTokenExists_ThenTokenRe
   OCMExpect([self.mockInstallationsStore installationForAppID:self.appID appName:self.appName])
       .andReturn([FBLPromise resolvedWith:storedInstallation]);
 
-  // 1.2. Expect API request.
+  // 1.2. Auth Token refresh.
   FIRInstallationsItem *responseInstallation =
-      [FIRInstallationsItem createRegisteredInstallationItem];
-  responseInstallation.authToken.token =
-      [responseInstallation.authToken.token stringByAppendingString:@"_new"];
-  OCMExpect([self.mockAPIService refreshAuthTokenForInstallation:storedInstallation])
-      .andReturn([FBLPromise resolvedWith:responseInstallation]);
+      [self expectAuthTokenRefreshForInstallation:storedInstallation];
 
   // 2. Request auth token.
   FBLPromise<FIRInstallationsItem *> *promise = [self.controller getAuthTokenForcingRefresh:NO];
 
   // 3. Wait for the promise to resolve.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   // 4. Check.
   OCMVerifyAll(self.mockInstallationsStore);
@@ -447,19 +443,15 @@ - (void)testGetAuthTokenForcingRefresh_WhenValidInstallationExists_ThenTokenRequ
   OCMExpect([self.mockInstallationsStore installationForAppID:self.appID appName:self.appName])
       .andReturn([FBLPromise resolvedWith:storedInstallation]);
 
-  // 1.2. Expect API request.
+  // 1.2. Auth Token refresh.
   FIRInstallationsItem *responseInstallation =
-      [FIRInstallationsItem createRegisteredInstallationItem];
-  responseInstallation.authToken.token =
-      [responseInstallation.authToken.token stringByAppendingString:@"_new"];
-  OCMExpect([self.mockAPIService refreshAuthTokenForInstallation:storedInstallation])
-      .andReturn([FBLPromise resolvedWith:responseInstallation]);
+      [self expectAuthTokenRefreshForInstallation:storedInstallation];
 
   // 2. Request auth token.
   FBLPromise<FIRInstallationsItem *> *promise = [self.controller getAuthTokenForcingRefresh:YES];
 
   // 3. Wait for the promise to resolve.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   // 4. Check.
   OCMVerifyAll(self.mockInstallationsStore);
@@ -494,7 +486,7 @@ - (void)testGetAuthToken_WhenCalledSeveralTimes_OnlyOneOperationIsPerformed {
   [storagePendingPromise fulfill:storedInstallation];
 
   // 4. Wait for the promise to resolve.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   // 5. Check.
   OCMVerifyAll(self.mockInstallationsStore);
@@ -525,6 +517,10 @@ - (void)testGetAuthTokenForceRefresh_WhenCalledSeveralTimes_OnlyOneOperationIsPe
   OCMExpect([self.mockAPIService refreshAuthTokenForInstallation:storedInstallation])
       .andReturn(pendingAPIPromise);
 
+  // 1.3. Expect new token to be stored.
+  OCMExpect([self.mockInstallationsStore saveInstallation:responseInstallation])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+
   // 2. Request auth token n times.
   NSInteger requestCount = 10;
   NSMutableArray *authTokenPromises = [NSMutableArray arrayWithCapacity:requestCount];
@@ -536,7 +532,7 @@ - (void)testGetAuthTokenForceRefresh_WhenCalledSeveralTimes_OnlyOneOperationIsPe
   [pendingAPIPromise fulfill:responseInstallation];
 
   // 4. Wait for the promise to resolve.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   // 5. Check.
   OCMVerifyAll(self.mockInstallationsStore);
@@ -664,7 +660,7 @@ - (void)testDeleteRegisteredInstallation {
   FBLPromise<NSNull *> *promise = [self.controller deleteInstallation];
 
   // 6. Wait for operations to complete and check.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertTrue(promise.isFulfilled);
@@ -702,7 +698,7 @@ - (void)testDeleteUnregisteredInstallation {
   FBLPromise<NSNull *> *promise = [self.controller deleteInstallation];
 
   // 6. Wait for operations to complete and check.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertTrue(promise.isFulfilled);
@@ -742,7 +738,7 @@ - (void)testDeleteRegisteredInstallation_WhenAPIRequestFails_ThenFailsAndInstall
   FBLPromise<NSNull *> *promise = [self.controller deleteInstallation];
 
   // 6. Wait for operations to complete and check.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertEqualObjects(promise.error, error500);
   XCTAssertTrue(promise.isRejected);
@@ -781,7 +777,7 @@ - (void)testDeleteRegisteredInstallation_WhenAPIFailsWithNotFound_ThenInstallati
   FBLPromise<NSNull *> *promise = [self.controller deleteInstallation];
 
   // 6. Wait for operations to complete and check.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertTrue(promise.isFulfilled);
@@ -839,10 +835,14 @@ - (void)testDeleteInstallation_WhenThereIsOngoingAuthTokenRequest_ThenUsesItsRes
   FBLPromise<NSNull *> *deletePromise = [self.controller deleteInstallation];
 
   // 4. Fulfill auth token promise to proceed.
+  // 4.1. Expect new token to be stored on API response.
+  OCMExpect([self.mockInstallationsStore saveInstallation:responseInstallation])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+
   [pendingAuthTokenAPIPromise fulfill:responseInstallation];
 
   // 5. Wait for operations to complete and check the result.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(deletePromise.error);
   XCTAssertTrue(deletePromise.isFulfilled);
@@ -884,7 +884,7 @@ - (void)testDeleteInstallation_WhenNotDefaultApp_ThenIIDIsNotDeleted {
   FBLPromise<NSNull *> *promise = [self.controller deleteInstallation];
 
   // 6. Wait for operations to complete and check.
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(promise.error);
   XCTAssertTrue(promise.isFulfilled);
@@ -938,7 +938,7 @@ - (void)testFIDDidChangeNotificationIsSentWhenFIDCreated {
 
   // 3. Request FID.
   FBLPromise *promise = [self.controller getInstallationItem];
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   // 4. Check.
   XCTAssertNil(promise.error);
@@ -1035,4 +1035,20 @@ - (void)expectInstallationStoreToBeRequestedAndReturnInstallation:
       .andReturn([FBLPromise resolvedWith:storedInstallation]);
 }
 
+- (FIRInstallationsItem *)expectAuthTokenRefreshForInstallation:
+    (FIRInstallationsItem *)installation {
+  FIRInstallationsItem *responseInstallation =
+      [FIRInstallationsItem createRegisteredInstallationItem];
+  responseInstallation.authToken.token =
+      [responseInstallation.authToken.token stringByAppendingString:@"_new"];
+  OCMExpect([self.mockAPIService refreshAuthTokenForInstallation:installation])
+      .andReturn([FBLPromise resolvedWith:responseInstallation]);
+
+  // 1.3. Expect new token to be stored.
+  OCMExpect([self.mockInstallationsStore saveInstallation:responseInstallation])
+      .andReturn([FBLPromise resolvedWith:[NSNull null]]);
+
+  return responseInstallation;
+}
+
 @end

FirebaseInstallations/Source/Tests/Unit/FIRInstallationsIIDStoreTests.m

@@ -60,7 +60,7 @@ - (void)testExistingIIDSuccess {
 
   FBLPromise<NSString *> *IIDPromise = [self.IIDStore existingIID];
 
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(IIDPromise.error);
   XCTAssertEqualObjects(IIDPromise.value, existingIID);
@@ -73,14 +73,14 @@ - (void)testDeleteExistingIID {
 
   // 2. Delete IID.
   FBLPromise<NSNull *> *deletePromise = [self.IIDStore deleteExistingIID];
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNil(deletePromise.error);
   XCTAssertTrue(deletePromise.isFulfilled);
 
   // 3. Check there is no IID.
   FBLPromise<NSString *> *IIDPromise = [self.IIDStore existingIID];
-  FBLWaitForPromisesWithTimeout(0.5);
+  XCTAssert(FBLWaitForPromisesWithTimeout(0.5));
 
   XCTAssertNotNil(IIDPromise.error);
   XCTAssertTrue(IIDPromise.isRejected);