Auth: Remove all #ifs in favor of API_UNAVAILABLE (#8451)

* Remove all #ifs in favor of API_UNAVAILABLE

* fix build

* style

* Fix FIRAuthUIDelegate availability

* fix availability for real this time

* Add headerdoc comments

* Add changelog

Author: morganchen12

FirebaseAuth/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Unreleased
+- [fixed] Annotated platform-level availability using `API_UNAVAILABLE` instead of conditionally compiling certain methods with `#if` directives (#8451).
+
 # 8.5.0
 - [fixed] Fixed an analyze issue introduced in Xcode 12.5. (#8411)
 

FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuth.h

@@ -17,11 +17,8 @@
 #import <AvailabilityMacros.h>
 #import <Foundation/Foundation.h>
 
-#import "FIRAuthErrors.h"
-
-#if TARGET_OS_IOS
 #import "FIRAuthAPNSTokenType.h"
-#endif
+#import "FIRAuthErrors.h"
 
 @class FIRActionCodeSettings;
 @class FIRApp;
@@ -87,26 +84,12 @@ typedef void (^FIRIDTokenDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullab
 typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable authResult,
                                           NSError *_Nullable error)
     NS_SWIFT_NAME(AuthDataResultCallback);
-
-#if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0
 /**
     @brief The name of the `NSNotificationCenter` notification which is posted when the auth state
         changes (for example, a new token has been produced, a user signs in or signs out). The
         object parameter of the notification is the sender `FIRAuth` instance.
  */
 extern const NSNotificationName FIRAuthStateDidChangeNotification NS_SWIFT_NAME(AuthStateDidChange);
-#else
-/**
-    @brief The name of the `NSNotificationCenter` notification which is posted when the auth state
-        changes (for example, a new token has been produced, a user signs in or signs out). The
-        object parameter of the notification is the sender `FIRAuth` instance.
- */
-// clang-format off
-// clang-format12 merges the next two lines.
-extern NSString *const FIRAuthStateDidChangeNotification
-    NS_SWIFT_NAME(AuthStateDidChangeNotification);
-// clang-format off
-#endif  // defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0
 
 /** @typedef FIRAuthResultCallback
     @brief The type of block invoked when sign-in related events complete.
@@ -362,15 +345,14 @@ NS_SWIFT_NAME(Auth)
  */
 @property(nonatomic, copy, nullable) NSString *tenantID;
 
-#if TARGET_OS_IOS
 /** @property APNSToken
     @brief The APNs token used for phone number authentication. The type of the token (production
         or sandbox) will be attempted to be automatcially detected.
+        This property is available on iOS only.
     @remarks If swizzling is disabled, the APNs Token must be set for phone number auth to work,
-        by either setting this property or by calling `setAPNSToken:type:`
+        by either setting this property or by calling `setAPNSToken:type:`.
  */
-@property(nonatomic, strong, nullable) NSData *APNSToken;
-#endif
+@property(nonatomic, strong, nullable) NSData *APNSToken API_UNAVAILABLE(macos, tvos, watchos);
 
 /** @fn init
     @brief Please access auth instances using `FIRAuth.auth` and `FIRAuth.authForApp:`.
@@ -379,7 +361,7 @@ NS_SWIFT_NAME(Auth)
 
 /** @fn updateCurrentUser:completion:
     @brief Sets the currentUser on the calling Auth instance to the provided user object.
-    @param  user The user object to be set as the current user of the calling Auth instance.
+    @param user The user object to be set as the current user of the calling Auth instance.
     @param completion Optionally; a block invoked after the user of the calling Auth instance has
         been updated or an error was encountered.
  */
@@ -459,6 +441,7 @@ NS_SWIFT_NAME(Auth)
 
 /** @fn signInWithProvider:UIDelegate:completion:
     @brief Signs in using the provided auth provider instance.
+        This method is available on iOS, macOS Catalyst, and tvOS only.
 
     @param provider An instance of an auth provider used to initiate the sign-in flow.
     @param UIDelegate Optionally an instance of a class conforming to the FIRAuthUIDelegate
@@ -505,7 +488,7 @@ NS_SWIFT_NAME(Auth)
                 UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
                 completion:(nullable void (^)(FIRAuthDataResult *_Nullable authResult,
                                               NSError *_Nullable error))completion
-    API_UNAVAILABLE(watchos);
+    API_UNAVAILABLE(macosx, watchos);
 
 /** @fn signInWithCredential:completion:
     @brief Asynchronously signs in to Firebase with the given 3rd-party credentials (e.g. a Facebook
@@ -828,10 +811,9 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)useEmulatorWithHost:(NSString *)host port:(NSInteger)port;
 
-#if TARGET_OS_IOS
-
 /** @fn canHandleURL:
     @brief Whether the specific URL is handled by `FIRAuth` .
+        This method is available on iOS only.
     @param URL The URL received by the application delegate from any of the openURL method.
     @return Whether or the URL is handled. YES means the URL is for Firebase Auth
         so the caller should ignore the URL from further processing, and NO means the
@@ -840,17 +822,20 @@ NS_SWIFT_NAME(Auth)
     @remarks If swizzling is disabled, URLs received by the application delegate must be forwarded
         to this method for phone number auth to work.
  */
-- (BOOL)canHandleURL:(nonnull NSURL *)URL;
+- (BOOL)canHandleURL:(nonnull NSURL *)URL API_UNAVAILABLE(macos, tvos, watchos);
 
 /** @fn setAPNSToken:type:
     @brief Sets the APNs token along with its type.
+        This method is available on iOS only.
     @remarks If swizzling is disabled, the APNs Token must be set for phone number auth to work,
         by either setting calling this method or by setting the `APNSToken` property.
  */
-- (void)setAPNSToken:(NSData *)token type:(FIRAuthAPNSTokenType)type;
+- (void)setAPNSToken:(NSData *)token
+                type:(FIRAuthAPNSTokenType)type API_UNAVAILABLE(macos, tvos, watchos);
 
 /** @fn canHandleNotification:
     @brief Whether the specific remote notification is handled by `FIRAuth` .
+        This method is available on iOS only.
     @param userInfo A dictionary that contains information related to the
         notification in question.
     @return Whether or the notification is handled. YES means the notification is for Firebase Auth
@@ -860,9 +845,7 @@ NS_SWIFT_NAME(Auth)
     @remarks If swizzling is disabled, related remote notifications must be forwarded to this method
         for phone number auth to work.
  */
-- (BOOL)canHandleNotification:(NSDictionary *)userInfo;
-
-#endif  // TARGET_OS_IOS
+- (BOOL)canHandleNotification:(NSDictionary *)userInfo API_UNAVAILABLE(macos, tvos, watchos);
 
 #pragma mark - User sharing
 

FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuthAPNSTokenType.h

@@ -14,15 +14,13 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if !TARGET_OS_OSX
-
 #import <Foundation/Foundation.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
 /**
  *  @brief The APNs token type for the app.
+ *      This enum is available on iOS, macOS Catalyst, tvOS, and watchOS only.
  */
 typedef NS_ENUM(NSInteger, FIRAuthAPNSTokenType) {
 
@@ -38,8 +36,6 @@ typedef NS_ENUM(NSInteger, FIRAuthAPNSTokenType) {
   /** Production token type.
    */
   FIRAuthAPNSTokenTypeProd,
-} NS_SWIFT_NAME(AuthAPNSTokenType);
+} NS_SWIFT_NAME(AuthAPNSTokenType) API_UNAVAILABLE(macosx);
 
 NS_ASSUME_NONNULL_END
-
-#endif

FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuthUIDelegate.h

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if !TARGET_OS_OSX
-
 #import <Foundation/Foundation.h>
 
 @class UIViewController;
@@ -25,9 +22,9 @@ NS_ASSUME_NONNULL_BEGIN
 
 /** @protocol FIRAuthUIDelegate
     @brief A protocol to handle user interface interactions for Firebase Auth.
+        This protocol is available on iOS, macOS Catalyst, and tvOS only.
  */
-NS_SWIFT_NAME(AuthUIDelegate)
-@protocol FIRAuthUIDelegate <NSObject>
+NS_SWIFT_NAME(AuthUIDelegate) API_UNAVAILABLE(macosx, watchos) @protocol FIRAuthUIDelegate<NSObject>
 
 /** @fn presentViewController:animated:completion:
     @brief If implemented, this method will be invoked when Firebase Auth needs to display a view
@@ -55,5 +52,3 @@ NS_SWIFT_NAME(AuthUIDelegate)
 @end
 
 NS_ASSUME_NONNULL_END
-
-#endif

FirebaseAuth/Sources/Public/FirebaseAuth/FIRFederatedAuthProvider.h

@@ -16,9 +16,7 @@
 
 #import <Foundation/Foundation.h>
 
-#if TARGET_OS_IOS
 #import "FIRAuthUIDelegate.h"
-#endif  // TARGET_OS_IOS
 
 @class FIRAuthCredential;
 
@@ -39,17 +37,17 @@ typedef void (^FIRAuthCredentialCallback)(FIRAuthCredential *_Nullable credentia
                                           NSError *_Nullable error)
     NS_SWIFT_NAME(AuthCredentialCallback);
 
-#if TARGET_OS_IOS
 /** @fn getCredentialWithUIDelegate:completion:
     @brief Used to obtain an auth credential via a mobile web flow.
+        This method is available on iOS only.
     @param UIDelegate An optional UI delegate used to presenet the mobile web flow.
     @param completion Optionally; a block which is invoked asynchronously on the main thread when
         the mobile web flow is completed.
  */
 - (void)getCredentialWithUIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
                          completion:(nullable void (^)(FIRAuthCredential *_Nullable credential,
-                                                       NSError *_Nullable error))completion;
-#endif  // TARGET_OS_IOS
+                                                       NSError *_Nullable error))completion
+    API_UNAVAILABLE(macos, tvos, watchos);
 
 @end
 

FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactor.h

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS
-
 #import <Foundation/Foundation.h>
 
 #import "FIRAuth.h"
@@ -28,24 +25,28 @@ NS_ASSUME_NONNULL_BEGIN
 
 /** @typedef FIRMultiFactorSessionCallback
     @brief The callback that triggered when a developer calls `getSessionWithCompletion`.
+        This type is available on iOS only.
     @param session The multi factor session returned, if any.
     @param error The error which occurred, if any.
 */
 typedef void (^FIRMultiFactorSessionCallback)(FIRMultiFactorSession *_Nullable session,
                                               NSError *_Nullable error)
-    NS_SWIFT_NAME(MultiFactorSessionCallback);
+    NS_SWIFT_NAME(MultiFactorSessionCallback) API_UNAVAILABLE(macos, tvos, watchos);
 
 /**
    @brief The string identifier for second factors. e.g. "phone".
+        This constant is available on iOS only.
 */
-extern NSString *const _Nonnull FIRPhoneMultiFactorID NS_SWIFT_NAME(PhoneMultiFactorID);
+extern NSString *const _Nonnull FIRPhoneMultiFactorID NS_SWIFT_NAME(PhoneMultiFactorID)
+    API_UNAVAILABLE(macos, tvos, watchos);
 
 /** @class FIRMultiFactor
     @brief The interface defining the multi factor related properties and operations pertaining to a
-   user.
+        user.
+        This class is available on iOS only.
 */
-NS_SWIFT_NAME(MultiFactor)
-@interface FIRMultiFactor : NSObject
+NS_SWIFT_NAME(MultiFactor) API_UNAVAILABLE(macos, tvos, watchos) @interface FIRMultiFactor
+    : NSObject
 
 @property(nonatomic, readonly) NSArray<FIRMultiFactorInfo *> *enrolledFactors;
 
@@ -86,5 +87,3 @@ NS_SWIFT_NAME(MultiFactor)
 @end
 
 NS_ASSUME_NONNULL_END
-
-#endif

FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactorAssertion.h

@@ -14,19 +14,17 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS
-
 #import <Foundation/Foundation.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
 /** @class FIRMultiFactorAssertion
     @brief The base class for asserting ownership of a second factor. This is equivalent to the
-   AuthCredential class.
+        AuthCredential class.
+        This class is available on iOS only.
 */
-NS_SWIFT_NAME(MultiFactorAssertion)
-@interface FIRMultiFactorAssertion : NSObject
+NS_SWIFT_NAME(MultiFactorAssertion) API_UNAVAILABLE(macos, tvos, watchos)
+    @interface FIRMultiFactorAssertion : NSObject
 
 /**
    @brief The second factor identifier for this opaque object asserting a second factor.
@@ -36,5 +34,3 @@ NS_SWIFT_NAME(MultiFactorAssertion)
 @end
 
 NS_ASSUME_NONNULL_END
-
-#endif

FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactorInfo.h

@@ -14,18 +14,16 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS
-
 #import <Foundation/Foundation.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
 /** @class FIRMultiFactorInfo
     @brief Safe public structure used to represent a second factor entity from a client perspective.
+        This class is available on iOS only.
 */
-NS_SWIFT_NAME(MultiFactorInfo)
-@interface FIRMultiFactorInfo : NSObject
+NS_SWIFT_NAME(MultiFactorInfo) API_UNAVAILABLE(macos, tvos, watchos) @interface FIRMultiFactorInfo
+    : NSObject
 
 /**
    @brief The multi-factor enrollment ID.
@@ -50,5 +48,3 @@ NS_SWIFT_NAME(MultiFactorInfo)
 @end
 
 NS_ASSUME_NONNULL_END
-
-#endif

FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactorResolver.h

@@ -14,19 +14,17 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS
-
 #import "FIRMultiFactor.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 /** @class FIRMultiFactorResolver
     @brief The data structure used to help developers resolve 2nd factor requirements on users that
         have opted in to 2 factor authentication.
+        This class is available on iOS only.
 */
-NS_SWIFT_NAME(MultiFactorResolver)
-@interface FIRMultiFactorResolver : NSObject
+NS_SWIFT_NAME(MultiFactorResolver) API_UNAVAILABLE(macos, tvos, watchos)
+    @interface FIRMultiFactorResolver : NSObject
 
 /**
    @brief The opaque session identifier for the current sign-in flow.
@@ -56,5 +54,3 @@ NS_SWIFT_NAME(MultiFactorResolver)
 @end
 
 NS_ASSUME_NONNULL_END
-
-#endif

FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactorSession.h

@@ -14,22 +14,18 @@
  * limitations under the License.
  */
 
-#import <TargetConditionals.h>
-#if TARGET_OS_IOS
-
 #import <Foundation/Foundation.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
 /** @class FIRMultiFactorSession
     @brief Opaque object that identifies the current session to enroll a second factor or to
         complete sign in when previously enrolled.
+        This class is available on iOS only.
  */
-NS_SWIFT_NAME(MultiFactorSession)
-@interface FIRMultiFactorSession : NSObject
+NS_SWIFT_NAME(MultiFactorSession) API_UNAVAILABLE(macos, tvos, watchos)
+    @interface FIRMultiFactorSession : NSObject
 
 @end
 
 NS_ASSUME_NONNULL_END
-
-#endif