[Cleanup] Follow-up to #10259 (#10262)

* [Cleanup] Follow-up to 10259

* [skip ci] Resolve TODO

In an effort to resolve this TODO, I marked the protocol as @optional to clean
up some of the duplicate test code. While it cleaned up the test code, it did
clutter up the actual usage of the API so I decided against doing so.

Author: ncooke3

FirebaseAppCheck/Tests/Unit/Core/FIRAppCheckAPIServiceTests.m

@@ -41,7 +41,7 @@
 @interface FIRHeartbeatLoggerFake : NSObject <FIRHeartbeatLoggerProtocol>
 @property(nonatomic, copy, nullable) FIRHeartbeatsPayload * (^onFlushHeartbeatsIntoPayloadHandler)
     (void);
-@property(nonatomic, copy, nullable) FIRHeartbeatInfoCode (^onHeartbeatCodeForTodayHandler)(void);
+@property(nonatomic, copy, nullable) FIRDailyHeartbeatCode (^onHeartbeatCodeForTodayHandler)(void);
 @end
 
 @implementation FIRHeartbeatLoggerFake
@@ -54,12 +54,12 @@ - (nonnull FIRHeartbeatsPayload *)flushHeartbeatsIntoPayload {
   }
 }
 
-- (FIRHeartbeatInfoCode)heartbeatCodeForToday {
+- (FIRDailyHeartbeatCode)heartbeatCodeForToday {
   // This API should not be used by the below tests because the AppCheck SDK
   // uses only the V2 heartbeat API (`flushHeartbeatsIntoPayload`) for getting
   // heartbeats.
   [self doesNotRecognizeSelector:_cmd];
-  return FIRHeartbeatInfoCodeNone;
+  return FIRDailyHeartbeatCodeNone;
 }
 
 - (void)log {

FirebaseAuth/Tests/Unit/FIRAuthBackendRPCImplementationTests.m

@@ -147,7 +147,7 @@ - (void)postWithRequest:(id<FIRAuthRPCRequest>)request
 @interface FIRFakeHeartbeatLogger : NSObject <FIRHeartbeatLoggerProtocol>
 @property(nonatomic, copy, nullable) FIRHeartbeatsPayload * (^onFlushHeartbeatsIntoPayloadHandler)
     (void);
-@property(nonatomic, copy, nullable) FIRHeartbeatInfoCode (^onHeartbeatCodeForTodayHandler)(void);
+@property(nonatomic, copy, nullable) FIRDailyHeartbeatCode (^onHeartbeatCodeForTodayHandler)(void);
 @end
 
 @implementation FIRFakeHeartbeatLogger
@@ -160,12 +160,12 @@ - (nonnull FIRHeartbeatsPayload *)flushHeartbeatsIntoPayload {
   }
 }
 
-- (FIRHeartbeatInfoCode)heartbeatCodeForToday {
+- (FIRDailyHeartbeatCode)heartbeatCodeForToday {
   // This API should not be used by the below tests because the Auth
   // SDK uses only the V2 heartbeat API (`flushHeartbeatsIntoPayload`) for
   // getting heartbeats.
   [self doesNotRecognizeSelector:_cmd];
-  return FIRHeartbeatInfoCodeNone;
+  return FIRDailyHeartbeatCodeNone;
 }
 
 - (void)log {

FirebaseCore/Extension/FIRHeartbeatInfo.h

@@ -14,16 +14,22 @@
 
 #import <Foundation/Foundation.h>
 
-// TODO(ncooke3): Remove in future PR when `FIRHeartbeatInfo` symbol is removed.
-#import "FIRHeartbeatInfo.h"
-
 NS_ASSUME_NONNULL_BEGIN
 
 #ifndef FIREBASE_BUILD_CMAKE
 @class FIRHeartbeatsPayload;
 #endif  // FIREBASE_BUILD_CMAKE
 
-// TODO(ncooke3): Consider annotating protocol API as `@optional`. (#9568)
+/// Enum representing different daily heartbeat codes.
+/// This enum is only used by clients using platform logging V1. This is because
+/// the V1 payload only supports a single daily heartbeat.
+typedef NS_ENUM(NSInteger, FIRDailyHeartbeatCode) {
+  /// Represents the absence of a daily heartbeat.
+  FIRDailyHeartbeatCodeNone = 0,
+  /// Represents the presence of a daily heartbeat.
+  FIRDailyHeartbeatCodeSome = 2,
+};
+
 @protocol FIRHeartbeatLoggerProtocol <NSObject>
 
 /// Asynchronously logs a heartbeat.
@@ -35,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN
 #endif  // FIREBASE_BUILD_CMAKE
 
 /// Gets the heartbeat code for today.
-- (FIRHeartbeatInfoCode)heartbeatCodeForToday;
+- (FIRDailyHeartbeatCode)heartbeatCodeForToday;
 
 @end
 
@@ -77,7 +83,7 @@ NSString *_Nullable FIRHeaderValueFromHeartbeatsPayload(FIRHeartbeatsPayload *he
 ///
 /// @note This API is thread-safe.
 /// @return Heartbeat code indicating whether or not there is an unsent global heartbeat.
-- (FIRHeartbeatInfoCode)heartbeatCodeForToday;
+- (FIRDailyHeartbeatCode)heartbeatCodeForToday;
 
 @end
 

FirebaseCore/Extension/FIRHeartbeatLogger.h

@@ -19,7 +19,6 @@
 #import "FIRComponentContainer.h"
 #import "FIRComponentType.h"
 #import "FIRDependency.h"
-#import "FIRHeartbeatInfo.h"
 #import "FIRHeartbeatLogger.h"
 #import "FIRLibrary.h"
 #import "FIRLogger.h"

FirebaseCore/Extension/FirebaseCoreInternal.h

@@ -76,17 +76,17 @@ - (FIRHeartbeatsPayload *)flushHeartbeatsIntoPayload {
 }
 #endif  // FIREBASE_BUILD_CMAKE
 
-- (FIRHeartbeatInfoCode)heartbeatCodeForToday {
+- (FIRDailyHeartbeatCode)heartbeatCodeForToday {
 #ifndef FIREBASE_BUILD_CMAKE
   FIRHeartbeatsPayload *todaysHeartbeatPayload = [_heartbeatController flushHeartbeatFromToday];
 
   if ([todaysHeartbeatPayload isEmpty]) {
-    return FIRHeartbeatInfoCodeNone;
+    return FIRDailyHeartbeatCodeNone;
   } else {
-    return FIRHeartbeatInfoCodeGlobal;
+    return FIRDailyHeartbeatCodeSome;
   }
 #else
-  return FIRHeartbeatInfoCodeNone;
+  return FIRDailyHeartbeatCodeNone;
 #endif  // FIREBASE_BUILD_CMAKE
 }
 

FirebaseCore/Sources/FIRHeartbeatInfo.m

@@ -91,23 +91,23 @@ - (void)testDoNotLogMoreThanOnceToday_AfterFlushing {
   [self assertHeartbeatsPayloadIsEmpty:secondHeartbeatsPayload];
 }
 
-- (void)testFlushing_UsingV1API_WhenHeartbeatsAreStored_ReturnsFIRHeartbeatInfoCodeGlobal {
+- (void)testFlushing_UsingV1API_WhenHeartbeatsAreStored_ReturnsFIRDailyHeartbeatCodeSome {
   // Given
   FIRHeartbeatLogger *heartbeatLogger = self.heartbeatLogger;
   // When
   [heartbeatLogger log];
-  FIRHeartbeatInfoCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
+  FIRDailyHeartbeatCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
   // Then
-  XCTAssertEqual(heartbeatInfoCode, FIRHeartbeatInfoCodeGlobal);
+  XCTAssertEqual(heartbeatInfoCode, FIRDailyHeartbeatCodeSome);
 }
 
-- (void)testFlushing_UsingV1API_WhenNoHeartbeatsAreStored_ReturnsFIRHeartbeatInfoCodeNone {
+- (void)testFlushing_UsingV1API_WhenNoHeartbeatsAreStored_ReturnsFIRDailyHeartbeatCodeNone {
   // Given
   FIRHeartbeatLogger *heartbeatLogger = self.heartbeatLogger;
   // When
-  FIRHeartbeatInfoCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
+  FIRDailyHeartbeatCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
   // Then
-  XCTAssertEqual(heartbeatInfoCode, FIRHeartbeatInfoCodeNone);
+  XCTAssertEqual(heartbeatInfoCode, FIRDailyHeartbeatCodeNone);
 }
 
 - (void)testFlushing_UsingV2API_WhenHeartbeatsAreStored_ReturnsNonEmptyPayload {
@@ -139,10 +139,10 @@ - (void)testLogAndFlushUsingV1API_AndThenFlushAgainUsingV2API_FlushesHeartbeatIn
   FIRHeartbeatLogger *heartbeatLogger = self.heartbeatLogger;
   [heartbeatLogger log];
   // When
-  FIRHeartbeatInfoCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
+  FIRDailyHeartbeatCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
   FIRHeartbeatsPayload *heartbeatsPayload = [heartbeatLogger flushHeartbeatsIntoPayload];
   // Then
-  XCTAssertEqual(heartbeatInfoCode, FIRHeartbeatInfoCodeGlobal);
+  XCTAssertEqual(heartbeatInfoCode, FIRDailyHeartbeatCodeSome);
   [self assertHeartbeatsPayloadIsEmpty:heartbeatsPayload];
 }
 
@@ -153,14 +153,14 @@ - (void)testLogAndFlushUsingV2API_AndThenFlushAgainUsingV1API_FlushesHeartbeatIn
   [heartbeatLogger log];
   // When
   FIRHeartbeatsPayload *heartbeatsPayload = [heartbeatLogger flushHeartbeatsIntoPayload];
-  FIRHeartbeatInfoCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
+  FIRDailyHeartbeatCode heartbeatInfoCode = [heartbeatLogger heartbeatCodeForToday];
   // Then
   [self assertEncodedPayloadHeader:FIRHeaderValueFromHeartbeatsPayload(heartbeatsPayload)
               isEqualToPayloadJSON:@{
                 @"version" : @2,
                 @"heartbeats" : @[ @{@"agent" : @"dummy_agent", @"dates" : @[ expectedDate ]} ]
               }];
-  XCTAssertEqual(heartbeatInfoCode, FIRHeartbeatInfoCodeNone);
+  XCTAssertEqual(heartbeatInfoCode, FIRDailyHeartbeatCodeNone);
 }
 
 - (void)testHeartbeatLoggersWithSameIDShareTheSameStorage {