Make sure we turn of fetchInProgress flag on any fetch completion for error scenarios. Also add UT and add UT file to podspec. (#4844)

(cherry picked from commit cb9e083)

Author: dmandar

FirebaseRemoteConfig.podspec

@@ -61,7 +61,8 @@ app update.
 #        'FirebaseRemoteConfig/Tests/Unit/RCNThrottlingTests.m',
         'FirebaseRemoteConfig/Tests/Unit/RCNTestUtilities.m',
         'FirebaseRemoteConfig/Tests/Unit/RCNUserDefaultsManagerTests.m',
-        'FirebaseRemoteConfig/Tests/Unit/RCNTestUtilities.h'
+        'FirebaseRemoteConfig/Tests/Unit/RCNTestUtilities.h',
+        'FirebaseRemoteConfig/Tests/Unit/RCNInstanceIDTest.m'
     # Supply plist custom plist testing.
     unit_tests.resources =
         'FirebaseRemoteConfig/Tests/Unit/Defaults-testInfo.plist',

FirebaseRemoteConfig/Sources/RCNFetch.m

@@ -165,7 +165,8 @@ - (void)fetchConfigWithExpirationDuration:(NSTimeInterval)expirationDuration
             [NSError errorWithDomain:FIRRemoteConfigErrorDomain
                                 code:FIRErrorCodeConfigFailed
                             userInfo:@{
-                              @"FetchError" : @"Duplicate request while the previous one is pending"
+                              NSLocalizedDescriptionKey :
+                                  @"FetchError: Duplicate request while the previous one is pending"
                             }];
         return [strongSelf reportCompletionOnHandler:completionHandler
                                           withStatus:FIRRemoteConfigFetchStatusFailure
@@ -206,6 +207,7 @@ - (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
     NSString *errorDescription = @"Failed to get GCMSenderID";
     FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000074", @"%@",
                 [NSString stringWithFormat:@"%@", errorDescription]);
+    self->_settings.isFetchInProgress = NO;
     return [self
         reportCompletionOnHandler:completionHandler
                        withStatus:FIRRemoteConfigFetchStatusFailure
@@ -221,6 +223,7 @@ - (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
           [NSString stringWithFormat:@"Failed to get InstanceID token. Error : %@.", error];
       FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000073", @"%@",
                   [NSString stringWithFormat:@"%@", errorDescription]);
+      self->_settings.isFetchInProgress = NO;
       return [self
           reportCompletionOnHandler:completionHandler
                          withStatus:FIRRemoteConfigFetchStatusFailure
@@ -249,7 +252,8 @@ - (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
               [NSString stringWithFormat:@"Error getting iid : %@.", error];
           FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000055", @"%@",
                       [NSString stringWithFormat:@"%@", errorDescription]);
-          return [self
+          strongSelfQueue->_settings.isFetchInProgress = NO;
+          return [strongSelfQueue
               reportCompletionOnHandler:completionHandler
                              withStatus:FIRRemoteConfigFetchStatusFailure
                               withError:[NSError
@@ -345,6 +349,7 @@ - (void)fetchWithUserProperties:(NSDictionary *)userProperties
     NSString *errString = [NSString stringWithFormat:@"Failed to compress the config request."];
     FIRLogWarning(kFIRLoggerRemoteConfig, @"I-RCN000033", @"%@", errString);
 
+    self->_settings.isFetchInProgress = NO;
     return [self
         reportCompletionOnHandler:completionHandler
                        withStatus:FIRRemoteConfigFetchStatusFailure
@@ -361,6 +366,10 @@ - (void)fetchWithUserProperties:(NSDictionary *)userProperties
     FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000050",
                 @"config fetch completed. Error: %@ StatusCode: %ld", (error ? error : @"nil"),
                 (long)[((NSHTTPURLResponse *)response) statusCode]);
+
+    // The fetch has completed.
+    self->_settings.isFetchInProgress = NO;
+
     RCNConfigFetch *fetcherCompletionSelf = weakSelf;
     if (!fetcherCompletionSelf) {
       return;
@@ -372,7 +381,6 @@ - (void)fetchWithUserProperties:(NSDictionary *)userProperties
         return;
       }
 
-      strongSelf->_settings.isFetchInProgress = NO;
       NSInteger statusCode = [((NSHTTPURLResponse *)response) statusCode];
 
       if (error || (statusCode != kRCNFetchResponseHTTPStatusCodeOK)) {

FirebaseRemoteConfig/Tests/Unit/RCNInstanceIDTest.m

@@ -229,6 +229,50 @@ - (void)testNilInstanceIDTokenAndError {
                                }];
 }
 
+// Test IID error. Subsequent request also fails with same error (b/148975341).
+- (void)testMultipleFetchCallsFailing {
+  NSMutableArray<XCTestExpectation *> *expectations =
+      [[NSMutableArray alloc] initWithCapacity:RCNTestRCNumTotalInstances];
+
+  // Set the token as nil.
+  [self mockInstanceIDMethodForTokenAndIdentity:nil
+                                     tokenError:[NSError errorWithDomain:@"com.google.instanceid"
+                                                                    code:FIRInstanceIDErrorUnknown
+                                                                userInfo:nil]
+                                       identity:nil
+                                  identityError:nil];
+  // Test for each RC FIRApp, namespace instance.
+  for (int i = 0; i < RCNTestRCNumTotalInstances; i++) {
+    expectations[i] =
+        [self expectationWithDescription:
+                  [NSString stringWithFormat:@"Test fetch configs successfully - instance %d", i]];
+    XCTAssertEqual(_configInstances[i].lastFetchStatus, FIRRemoteConfigFetchStatusNoFetchYet);
+    FIRRemoteConfigFetchCompletion fetchCompletion =
+        ^void(FIRRemoteConfigFetchStatus status, NSError *error) {
+          XCTAssertNotNil(error);
+          XCTAssertFalse([[error.userInfo objectForKey:@"NSLocalizedDescription"]
+                             rangeOfString:@"Failed to get InstanceID token"]
+                             .location == NSNotFound);
+          // Make a second fetch call.
+          [_configInstances[i]
+              fetchWithExpirationDuration:43200
+                        completionHandler:^void(FIRRemoteConfigFetchStatus status, NSError *error) {
+                          XCTAssertNotNil(error);
+                          XCTAssertFalse([[error.userInfo objectForKey:@"NSLocalizedDescription"]
+                                             rangeOfString:@"Failed to get InstanceID token"]
+                                             .location == NSNotFound);
+                          [expectations[i] fulfill];
+                        }];
+        };
+    [_configInstances[i] fetchWithExpirationDuration:43200 completionHandler:fetchCompletion];
+  }
+
+  [self waitForExpectationsWithTimeout:_expectationTimeout
+                               handler:^(NSError *error) {
+                                 XCTAssertNil(error);
+                               }];
+}
+
 // Instance ID token is not nil. Error is not nil. Verify fetch fails.
 - (void)testValidInstanceIDTokenAndValidError {
   NSMutableArray<XCTestExpectation *> *expectations =