Remove optional protocol method, mark sync headerValue unavailable in…

… Swift
firebase · Oct 9, 2024 · d2b64ab · d2b64ab
1 parent a44d799
commit d2b64ab
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 9 deletions.
diff --git a/FirebaseAuth/Sources/Swift/Backend/AuthBackend.swift b/FirebaseAuth/Sources/Swift/Backend/AuthBackend.swift
@@ -99,7 +99,7 @@ class AuthBackend {
                      contentType: String,
                      requestConfiguration: AuthRequestConfiguration) async -> URLRequest {
     // Kick off tasks for the async header values.
-    async let heartbeatsHeaderValue = requestConfiguration.heartbeatLogger?.asyncHeaderValue!()
+    async let heartbeatsHeaderValue = requestConfiguration.heartbeatLogger?.asyncHeaderValue()
     async let appCheckTokenHeaderValue = requestConfiguration.appCheck?
       .getToken(forcingRefresh: true)
 

diff --git a/FirebaseAuth/Tests/Unit/AuthBackendRPCImplementationTests.swift b/FirebaseAuth/Tests/Unit/AuthBackendRPCImplementationTests.swift
@@ -535,10 +535,6 @@ class AuthBackendRPCImplementationTests: RPCBaseTests {
   #if COCOAPODS || SWIFT_PACKAGE
     private class FakeHeartbeatLogger: NSObject, FIRHeartbeatLoggerProtocol {
       func asyncHeaderValue() async -> String? {
-        headerValue()
-      }
-
-      func headerValue() -> String? {
         let payload = flushHeartbeatsIntoPayload()
         guard !payload.isEmpty else {
           return nil

diff --git a/FirebaseCore/Extension/FIRHeartbeatLogger.h b/FirebaseCore/Extension/FIRHeartbeatLogger.h
@@ -39,13 +39,13 @@ typedef NS_ENUM(NSInteger, FIRDailyHeartbeatCode) {
 - (FIRDailyHeartbeatCode)heartbeatCodeForToday;
 
 #ifndef FIREBASE_BUILD_CMAKE
-/// Return the header value for the heartbeat logger.
-- (NSString *_Nullable)headerValue;
-
-@optional
 /// Returns the header value for the heartbeat logger via the given completion handler..
 - (void)asyncHeaderValueWithCompletionHandler:(void (^)(NSString *_Nullable))completionHandler
     API_AVAILABLE(ios(13.0), macosx(10.15), macCatalyst(13.0), tvos(13.0), watchos(6.0));
+
+/// Return the header value for the heartbeat logger.
+- (NSString *_Nullable)
+    headerValue NS_SWIFT_UNAVAILABLE("Use `asyncHeaderValue() async -> String?` instead.");
 #endif  // FIREBASE_BUILD_CMAKE
 
 @end

diff --git a/FirebaseInstallations/Source/Tests/Unit/FIRInstallationsAPIServiceTests.m b/FirebaseInstallations/Source/Tests/Unit/FIRInstallationsAPIServiceTests.m
@@ -69,6 +69,11 @@ - (NSString *_Nullable)headerValue {
   return FIRHeaderValueFromHeartbeatsPayload([self flushHeartbeatsIntoPayload]);
 }
 
+- (void)asyncHeaderValueWithCompletionHandler:
+    (nonnull void (^)(NSString *_Nullable))completionHandler {
+  [self doesNotRecognizeSelector:_cmd];
+}
+
 @end
 
 #pragma mark - FIRInstallationsAPIService + Internal

diff --git a/FirebaseMessaging/Tests/UnitTests/FIRMessagingTokenOperationsTest.m b/FirebaseMessaging/Tests/UnitTests/FIRMessagingTokenOperationsTest.m
@@ -102,6 +102,11 @@ - (NSString *_Nullable)headerValue {
   return @"unimplemented";
 }
 
+- (void)asyncHeaderValueWithCompletionHandler:
+    (nonnull void (^)(NSString *_Nullable))completionHandler {
+  [self doesNotRecognizeSelector:_cmd];
+}
+
 @end
 
 #pragma mark - FIRMessagingTokenOperationsTest