Migrate to UserDefaults based heartbeat on tvOS (#7893)

* Migrate to UserDefaults based heartbeat on tvOS

This should mitigate heartbeat files being wiped due to tvOS cache being
invalidated.

* Move defaults suite name to widely available constant.

* Point to GULs 7.4.0+ in Package.swift

Co-authored-by: Nick Cooke <[email protected]>

Author: ryanwilson

FirebaseCore/Sources/FIRApp.m

@@ -95,6 +95,9 @@
  */
 NSString *const kFirebaseCoreErrorDomain = @"com.firebase.core";
 
+/** The NSUserDefaults suite name for FirebaseCore, for those storage locations that use it. */
+NSString *const kFirebaseCoreDefaultsSuiteName = @"com.firebase.core";
+
 /**
  * The URL to download plist files.
  */

FirebaseCore/Sources/FIRHeartbeatInfo.m

@@ -13,8 +13,11 @@
 // limitations under the License.
 
 #import "FirebaseCore/Sources/Private/FIRHeartbeatInfo.h"
+#import <GoogleUtilities/GULHeartbeatDateStorable.h>
 #import <GoogleUtilities/GULHeartbeatDateStorage.h>
+#import <GoogleUtilities/GULHeartbeatDateStorageUserDefaults.h>
 #import <GoogleUtilities/GULLogger.h>
+#import "FirebaseCore/Sources/Private/FIRAppInternal.h"
 
 const static long secondsInDay = 86400;
 @implementation FIRHeartbeatInfo : NSObject
@@ -25,9 +28,17 @@ @implementation FIRHeartbeatInfo : NSObject
  */
 + (BOOL)updateIfNeededHeartbeatDateForTag:(NSString *)heartbeatTag {
   @synchronized(self) {
-    NSString *const kHeartbeatStorageFile = @"HEARTBEAT_INFO_STORAGE";
-    GULHeartbeatDateStorage *dataStorage =
-        [[GULHeartbeatDateStorage alloc] initWithFileName:kHeartbeatStorageFile];
+    NSString *const kHeartbeatStorageName = @"HEARTBEAT_INFO_STORAGE";
+    id<GULHeartbeatDateStorable> dataStorage;
+#if TARGET_OS_TV
+    NSUserDefaults *defaults =
+        [[NSUserDefaults alloc] initWithSuiteName:kFirebaseCoreDefaultsSuiteName];
+    dataStorage =
+        [[GULHeartbeatDateStorageUserDefaults alloc] initWithDefaults:defaults
+                                                                  key:kHeartbeatStorageName];
+#else
+    dataStorage = [[GULHeartbeatDateStorage alloc] initWithFileName:kHeartbeatStorageName];
+#endif
     NSDate *heartbeatTime = [dataStorage heartbeatDateForTag:heartbeatTag];
     NSDate *currentDate = [NSDate date];
     if (heartbeatTime != nil) {

FirebaseCore/Sources/Private/FIRAppInternal.h

@@ -41,6 +41,9 @@ extern NSString *const kFIRAppNameKey;
 extern NSString *const kFIRGoogleAppIDKey;
 extern NSString *const kFirebaseCoreErrorDomain;
 
+/** The NSUserDefaults suite name for FirebaseCore, for those storage locations that use it. */
+extern NSString *const kFirebaseCoreDefaultsSuiteName;
+
 /**
  * The format string for the User Defaults key used for storing the data collection enabled flag.
  * This includes formatting to append the Firebase App's name.

FirebaseCore/Tests/Unit/FIRHeartbeatInfoTest.m

@@ -12,23 +12,37 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#import <GoogleUtilities/GULHeartbeatDateStorable.h>
 #import <GoogleUtilities/GULHeartbeatDateStorage.h>
+#import <GoogleUtilities/GULHeartbeatDateStorageUserDefaults.h>
 #import <XCTest/XCTest.h>
 #import "FirebaseCore/Sources/Private/FIRHeartbeatInfo.h"
 
+/// Taken from the implementation of `FIRHeartbeatInfo.m`.
+NSString *const kFIRCoreSuiteName = @"com.firebase.core";
+
 @interface FIRHeartbeatInfoTest : XCTestCase
 
-@property(nonatomic, strong) GULHeartbeatDateStorage *dataStorage;
+@property(nonatomic, strong) id<GULHeartbeatDateStorable> dataStorage;
 
-@property(nonatomic, strong) NSMutableDictionary *dictionary;
+#if TARGET_OS_TV
+@property(nonatomic, strong) NSUserDefaults *defaults;
+#endif  // TARGET_OS_TV
 
 @end
 
 @implementation FIRHeartbeatInfoTest
 
 - (void)setUp {
-  NSString *const kHeartbeatStorageFile = @"HEARTBEAT_INFO_STORAGE";
-  self.dataStorage = [[GULHeartbeatDateStorage alloc] initWithFileName:kHeartbeatStorageFile];
+  NSString *const kHeartbeatStorageName = @"HEARTBEAT_INFO_STORAGE";
+#if TARGET_OS_TV
+  self.defaults = [[NSUserDefaults alloc] initWithSuiteName:kFIRCoreSuiteName];
+  self.dataStorage =
+      [[GULHeartbeatDateStorageUserDefaults alloc] initWithDefaults:self.defaults
+                                                                key:kHeartbeatStorageName];
+#else
+  self.dataStorage = [[GULHeartbeatDateStorage alloc] initWithFileName:kHeartbeatStorageName];
+#endif  // TARGET_OS_TV
   NSDateComponents *componentsToAdd = [[NSDateComponents alloc] init];
   componentsToAdd.day = -1;
 
@@ -40,6 +54,16 @@ - (void)setUp {
   [self.dataStorage setHearbeatDate:dayAgo forTag:@"GLOBAL"];
 }
 
+#if TARGET_OS_TV
+- (void)tearDown {
+  // Delete any residual storage.
+  [self.defaults removePersistentDomainForName:kFIRCoreSuiteName];
+  self.defaults = nil;
+
+  [super tearDown];
+}
+#endif  // TARGET_OS_TV
+
 - (void)testCombinedHeartbeat {
   FIRHeartbeatInfoCode heartbeatCode = [FIRHeartbeatInfo heartbeatCodeForTag:@"fire-iid"];
   XCTAssertEqual(heartbeatCode, FIRHeartbeatInfoCodeCombined);

Package.swift

@@ -150,7 +150,7 @@ let package = Package(
     .package(
       name: "GoogleUtilities",
       url: "https://github.com/google/GoogleUtilities.git",
-      "7.3.0" ..< "8.0.0"
+      "7.4.0" ..< "8.0.0"
     ),
     .package(
       name: "GTMSessionFetcher",