Merge c770a41 into 916759e

Author: ncooke3

FirebaseCore/Internal/Sources/HeartbeatLogging/HeartbeatController.swift

@@ -22,7 +22,6 @@ public final class HeartbeatController {
   private let heartbeatsStorageCapacity: Int = 30
   /// Current date provider. It is used for testability.
   private let dateProvider: () -> Date
-  // TODO: Maybe share config with HeartbeatsPayload's DateFormatter?
   /// Used for standardizing dates for calendar-day comparision.
   static let dateStandardizer: (Date) -> (Date) = {
     var calendar = Calendar(identifier: .iso8601)

FirebaseCore/Internal/Sources/HeartbeatLogging/HeartbeatStorage.swift

@@ -90,7 +90,9 @@ final class HeartbeatStorage: HeartbeatStorageProtocol {
 
   // MARK: - HeartbeatStorageProtocol
 
-  // TODO: Document.
+  /// Synchronously reads from and writes to storage using the given transform block.
+  /// - Parameter transform: A block to transform the currently stored heartbeats bundle to a new
+  /// heartbeats bundle value.
   func readAndWriteSync(using transform: (HeartbeatsBundle?) -> HeartbeatsBundle?) {
     queue.sync {
       let oldHeartbeatsBundle = try? load(from: storage)

FirebaseCore/Internal/Sources/HeartbeatLogging/StorageFactory.swift

@@ -32,7 +32,10 @@ extension FileStorage: StorageFactory {
   static func makeStorage(id: String) -> Storage {
     let rootDirectory = FileManager.default.applicationSupportDirectory
     let heartbeatDirectoryPath = Constants.heartbeatFileStorageDirectoryPath
-    let heartbeatFilePath = "heartbeats-\(id)"
+
+    // Sanitize the `id` so the heartbeat file name does not include a ":".
+    let sanitizedID = id.replacingOccurrences(of: ":", with: "_")
+    let heartbeatFilePath = "heartbeats-\(sanitizedID)"
 
     let storageURL = rootDirectory
       .appendingPathComponent(heartbeatDirectoryPath, isDirectory: true)

FirebaseCore/Internal/Tests/Integration/HeartbeatLoggingIntegrationTests.swift

@@ -364,4 +364,30 @@ class HeartbeatLoggingIntegrationTests: XCTestCase {
       XCTAssertNotNil(try Data(contentsOf: heartbeatsFileURL), "Data should not be nil.")
     #endif
   }
+
+  #if !os(tvOS)
+    // Do not run on tvOS because tvOS uses UserDefaults to store heartbeats.
+    func testControllerCreatesHeartbeatStorageWithSanitizedFileName() throws {
+      // Given
+      let appID = "1:123456789000:ios:abcdefghijklmnop"
+      let sanitizedAppID = appID.replacingOccurrences(of: ":", with: "_")
+      let controller = HeartbeatController(id: appID)
+      // When
+      // - Trigger the controller to write to the file system.
+      controller.log("dummy_agent")
+      _ = XCTWaiter.wait(for: [expectation(description: "Wait for async log.")], timeout: 0.1)
+      // Then
+      let heartbeatsDirectoryURL = FileManager.default
+        .applicationSupportDirectory
+        .appendingPathComponent(
+          HeartbeatLoggingTestUtils.Constants.heartbeatFileStorageDirectoryPath,
+          isDirectory: true
+        )
+
+      let directoryContents = try FileManager.default
+        .contentsOfDirectory(atPath: heartbeatsDirectoryURL.path)
+
+      XCTAssertEqual(directoryContents, ["heartbeats-\(sanitizedAppID)"])
+    }
+  #endif // !os(tvOS)
 }