Fix FIAM test flakes and exposed library bugs (#3101)

* Fix FIAM test flakes and resulting library bugs

* style

* Fix naming of initWithExpireAdfterInSeconds:withTimeFetcher:withCacheFile. Move mock setup of mockTimeFetcher prior to initializing FIRIAMClearcutLogStorage

* FIRIAMClearcutUploader: Only schedule next log send on init if there are logs that haven't been sent at that time. Early return from scheduling if there's already a pending send

* Fix whitespace

* Make cachePath in `initWithExpireAfterInSeconds:withTimeFetcher:cachePath:` nullable

Author: paulb777

Firebase/InAppMessaging/Analytics/FIRIAMClearcutLogStorage.h

@@ -34,6 +34,10 @@ NS_ASSUME_NONNULL_BEGIN
 // attempted.
 
 @interface FIRIAMClearcutLogStorage : NSObject
+- (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
+                             withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher
+                                   cachePath:(nullable NSString *)cachePath;
+
 - (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
                              withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher;
 

Firebase/InAppMessaging/Analytics/FIRIAMClearcutLogStorage.m

@@ -82,7 +82,8 @@ + (NSString *)determineCacheFilePath {
 }
 
 - (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
-                             withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher {
+                             withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher
+                                   cachePath:(nullable NSString *)cachePath {
   if (self = [super init]) {
     _records = [[NSMutableArray alloc] init];
     _timeFetcher = timeFetcher;
@@ -92,7 +93,7 @@ - (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
                                                  name:UIApplicationWillResignActiveNotification
                                                object:nil];
     @try {
-      [self loadFromCachePath:nil];
+      [self loadFromCachePath:cachePath];
     } @catch (NSException *exception) {
       FIRLogWarning(kFIRLoggerInAppMessaging, @"I-IAM230004",
                     @"Non-fatal exception in loading persisted clearcut log records: %@.",
@@ -102,6 +103,13 @@ - (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
   return self;
 }
 
+- (instancetype)initWithExpireAfterInSeconds:(NSInteger)expireInSeconds
+                             withTimeFetcher:(id<FIRIAMTimeFetcher>)timeFetcher {
+  return [self initWithExpireAfterInSeconds:expireInSeconds
+                            withTimeFetcher:timeFetcher
+                                  cachePath:nil];
+}
+
 - (void)appWillBecomeInactive {
   dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0ul), ^{
     [self saveIntoCacheWithPath:nil];

Firebase/InAppMessaging/Analytics/FIRIAMClearcutUploader.m

@@ -105,8 +105,11 @@ - (instancetype)initWithRequestSender:(FIRIAMClearcutHttpRequestSender *)request
     _nextValidSendTimeInMills = (int64_t)
         [_userDefaults doubleForKey:FIRIAM_UserDefaultsKeyForNextValidClearcutUploadTimeInMills];
 
-    // seed the first send upon SDK start-up
-    [self scheduleNextSend];
+    NSArray<FIRIAMClearcutLogRecord *> *availableLogs =
+        [logStorage popStillValidRecordsForUpTo:strategy.batchSendSize];
+    if (availableLogs.count) {
+      [self scheduleNextSend];
+    }
 
     FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM260001",
                 @"FIRIAMClearcutUploader created with strategy as %@", self.strategy);
@@ -133,20 +136,20 @@ - (void)addNewLogRecord:(FIRIAMClearcutLogRecord *)record {
 }
 
 - (void)attemptUploading {
-  NSArray<FIRIAMClearcutLogRecord *> *availbleLogs =
+  NSArray<FIRIAMClearcutLogRecord *> *availableLogs =
       [self.logStorage popStillValidRecordsForUpTo:self.strategy.batchSendSize];
 
-  if (availbleLogs.count > 0) {
+  if (availableLogs.count > 0) {
     FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM260011", @"Deliver %d clearcut records",
-                (int)availbleLogs.count);
+                (int)availableLogs.count);
     [self.requestSender
-        sendClearcutHttpRequestForLogs:availbleLogs
+        sendClearcutHttpRequestForLogs:availableLogs
                         withCompletion:^(BOOL success, BOOL shouldRetryLogs,
                                          int64_t waitTimeInMills) {
                           if (success) {
                             FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM260003",
                                         @"Delivering %d clearcut records was successful",
-                                        (int)availbleLogs.count);
+                                        (int)availableLogs.count);
                             // make sure the effective wait time is between two bounds
                             // defined in strategy
                             waitTimeInMills =
@@ -159,7 +162,7 @@ - (void)attemptUploading {
                             FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM260004",
                                         @"Failed to attempt the delivery of %d clearcut "
                                         @"records and should-retry for them is %@",
-                                        (int)availbleLogs.count, shouldRetryLogs ? @"YES" : @"NO");
+                                        (int)availableLogs.count, shouldRetryLogs ? @"YES" : @"NO");
                             if (shouldRetryLogs) {
                               /**
                                * Note that there is a chance that the app crashes before we can
@@ -170,7 +173,7 @@ - (void)attemptUploading {
                                */
                               FIRLogDebug(kFIRLoggerInAppMessaging, @"I-IAM260007",
                                           @"Push failed log records back to storage");
-                              [self.logStorage pushRecords:availbleLogs];
+                              [self.logStorage pushRecords:availableLogs];
                             }
 
                             waitTimeInMills = (int64_t)self.strategy.failureBackoffTimeInMills;
@@ -207,10 +210,7 @@ - (void)attemptUploading {
 - (void)scheduleNextSend {
   @synchronized(self) {
     if (_nextSendScheduled) {
-      // already scheduled next send, don't do it again
       return;
-    } else {
-      _nextSendScheduled = YES;
     }
   }
 
@@ -228,6 +228,9 @@ - (void)scheduleNextSend {
                  _queue, ^{
                    [self attemptUploading];
                  });
+  @synchronized(self) {
+    _nextSendScheduled = YES;
+  }
 }
 
 @end