Mark ObjC typedefs as unavailable in Swift. (#9387)

* Mark ObjC typedefs as unavailable in Swift.

This is part of the larger Swift API improvements effort. These reduce
visibility in autocomplete, and we've mostly migrated away from them
already. This hides the unused type from the API surface to avoid
cluttering the list of types avialable.

* Revert FDL Test

* Fix CombineSwift tests

* Fixed Firestore tests

* Revert unneeded changes for FDL internal headers.

Author: ryanwilson

FirebaseAuth/Interop/FIRAuthInterop.h

@@ -25,15 +25,16 @@ NS_ASSUME_NONNULL_BEGIN
  @brief The type of block which gets called when a token is ready.
  */
 typedef void (^FIRTokenCallback)(NSString *_Nullable token, NSError *_Nullable error)
-    NS_SWIFT_NAME(TokenCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /// Common methods for Auth interoperability.
 NS_SWIFT_NAME(AuthInterop)
 @protocol FIRAuthInterop
 
 /// Retrieves the Firebase authentication token, possibly refreshing it if it has expired.
 - (void)getTokenForcingRefresh:(BOOL)forceRefresh
-                  withCallback:(FIRTokenCallback)callback
+                  withCallback:
+                      (void (^)(NSString *_Nullable token, NSError *_Nullable error))callback
     NS_SWIFT_NAME(getToken(forcingRefresh:completion:));
 
 /// Get the current Auth user's UID. Returns nil if there is no user signed in.

FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuth.h

@@ -35,7 +35,8 @@ NS_ASSUME_NONNULL_BEGIN
 /** @typedef FIRUserUpdateCallback
     @brief The type of block invoked when a request to update the current user is completed.
  */
-typedef void (^FIRUserUpdateCallback)(NSError *_Nullable error) NS_SWIFT_NAME(UserUpdateCallback);
+typedef void (^FIRUserUpdateCallback)(NSError *_Nullable error)
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRAuthStateDidChangeListenerHandle
     @brief The type of handle returned by `FIRAuth.addAuthStateDidChangeListener:`.
@@ -53,7 +54,7 @@ typedef id<NSObject> FIRAuthStateDidChangeListenerHandle
     @param user Optionally; the current signed in user, if any.
  */
 typedef void (^FIRAuthStateDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullable user)
-    NS_SWIFT_NAME(AuthStateDidChangeListenerBlock);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRIDTokenDidChangeListenerHandle
     @brief The type of handle returned by `FIRAuth.addIDTokenDidChangeListener:`.
@@ -71,7 +72,7 @@ typedef id<NSObject> FIRIDTokenDidChangeListenerHandle
     @param user Optionally; the current signed in user, if any.
  */
 typedef void (^FIRIDTokenDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullable user)
-    NS_SWIFT_NAME(IDTokenDidChangeListenerBlock);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRAuthDataResultCallback
     @brief The type of block invoked when sign-in related events complete.
@@ -82,7 +83,7 @@ typedef void (^FIRIDTokenDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullab
  */
 typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable authResult,
                                           NSError *_Nullable error)
-    NS_SWIFT_NAME(AuthDataResultCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 /**
     @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
@@ -98,7 +99,7 @@ extern const NSNotificationName FIRAuthStateDidChangeNotification NS_SWIFT_NAME(
         problem. Set to nil otherwise.
  */
 typedef void (^FIRAuthResultCallback)(FIRUser *_Nullable user, NSError *_Nullable error)
-    NS_SWIFT_NAME(AuthResultCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRProviderQueryCallback
     @brief The type of block invoked when a list of identity providers for a given email address is
@@ -111,14 +112,14 @@ typedef void (^FIRAuthResultCallback)(FIRUser *_Nullable user, NSError *_Nullabl
  */
 typedef void (^FIRProviderQueryCallback)(NSArray<NSString *> *_Nullable providers,
                                          NSError *_Nullable error)
-    NS_SWIFT_NAME(ProviderQueryCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRSignInMethodQueryCallback
     @brief The type of block invoked when a list of sign-in methods for a given email address is
         requested.
  */
 typedef void (^FIRSignInMethodQueryCallback)(NSArray<NSString *> *_Nullable, NSError *_Nullable)
-    NS_SWIFT_NAME(SignInMethodQueryCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRSendPasswordResetCallback
     @brief The type of block invoked when sending a password reset email.
@@ -127,13 +128,13 @@ typedef void (^FIRSignInMethodQueryCallback)(NSArray<NSString *> *_Nullable, NSE
         problem. Set to nil otherwise.
  */
 typedef void (^FIRSendPasswordResetCallback)(NSError *_Nullable error)
-    NS_SWIFT_NAME(SendPasswordResetCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRSendSignInLinkToEmailCallback
     @brief The type of block invoked when sending an email sign-in link email.
  */
 typedef void (^FIRSendSignInLinkToEmailCallback)(NSError *_Nullable error)
-    NS_SWIFT_NAME(SendSignInLinkToEmailCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRConfirmPasswordResetCallback
     @brief The type of block invoked when performing a password reset.
@@ -142,7 +143,7 @@ typedef void (^FIRSendSignInLinkToEmailCallback)(NSError *_Nullable error)
         problem. Set to nil otherwise.
  */
 typedef void (^FIRConfirmPasswordResetCallback)(NSError *_Nullable error)
-    NS_SWIFT_NAME(ConfirmPasswordResetCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRVerifyPasswordResetCodeCallback
     @brief The type of block invoked when verifying that an out of band code should be used to
@@ -154,7 +155,7 @@ typedef void (^FIRConfirmPasswordResetCallback)(NSError *_Nullable error)
  */
 typedef void (^FIRVerifyPasswordResetCodeCallback)(NSString *_Nullable email,
                                                    NSError *_Nullable error)
-    NS_SWIFT_NAME(VerifyPasswordResetCodeCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRApplyActionCodeCallback
     @brief The type of block invoked when applying an action code.
@@ -163,9 +164,10 @@ typedef void (^FIRVerifyPasswordResetCodeCallback)(NSString *_Nullable email,
         problem. Set to nil otherwise.
  */
 typedef void (^FIRApplyActionCodeCallback)(NSError *_Nullable error)
-    NS_SWIFT_NAME(ApplyActionCodeCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
-typedef void (^FIRAuthVoidErrorCallback)(NSError *_Nullable) NS_SWIFT_NAME(AuthVoidErrorCallback);
+typedef void (^FIRAuthVoidErrorCallback)(NSError *_Nullable)
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @class FIRActionCodeInfo
     @brief Manages information regarding action codes.
@@ -279,7 +281,7 @@ NS_SWIFT_NAME(ActionCodeURL)
  */
 typedef void (^FIRCheckActionCodeCallBack)(FIRActionCodeInfo *_Nullable info,
                                            NSError *_Nullable error)
-    NS_SWIFT_NAME(CheckActionCodeCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @class FIRAuth
     @brief Manages authentication for Firebase apps.

FirebaseAuth/Sources/Public/FirebaseAuth/FIRFederatedAuthProvider.h

@@ -35,7 +35,7 @@ NS_SWIFT_NAME(FederatedAuthProvider)
  */
 typedef void (^FIRAuthCredentialCallback)(FIRAuthCredential *_Nullable credential,
                                           NSError *_Nullable error)
-    NS_SWIFT_NAME(AuthCredentialCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @fn getCredentialWithUIDelegate:completion:
     @brief Used to obtain an auth credential via a mobile web flow.

FirebaseAuth/Sources/Public/FirebaseAuth/FIRGameCenterAuthProvider.h

@@ -38,7 +38,7 @@ extern NSString *const _Nonnull FIRGameCenterAuthSignInMethod NS_SWIFT_NAME(
  */
 typedef void (^FIRGameCenterCredentialCallback)(FIRAuthCredential *_Nullable credential,
                                                 NSError *_Nullable error)
-    NS_SWIFT_NAME(GameCenterCredentialCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @class FIRGameCenterAuthProvider
     @brief A concrete implementation of @c FIRAuthProvider for Game Center Sign In. Not available on

FirebaseAuth/Sources/Public/FirebaseAuth/FIRMultiFactor.h

@@ -31,7 +31,8 @@ NS_ASSUME_NONNULL_BEGIN
 */
 typedef void (^FIRMultiFactorSessionCallback)(FIRMultiFactorSession *_Nullable session,
                                               NSError *_Nullable error)
-    NS_SWIFT_NAME(MultiFactorSessionCallback) API_UNAVAILABLE(macos, tvos, watchos);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.")
+        API_UNAVAILABLE(macos, tvos, watchos);
 
 /**
    @brief The string identifier for second factors. e.g. "phone".

FirebaseAuth/Sources/Public/FirebaseAuth/FIRPhoneAuthProvider.h

@@ -47,7 +47,8 @@ extern NSString *const _Nonnull FIRPhoneAuthSignInMethod NS_SWIFT_NAME(PhoneAuth
  */
 typedef void (^FIRVerificationResultCallback)(NSString *_Nullable verificationID,
                                               NSError *_Nullable error)
-    NS_SWIFT_NAME(VerificationResultCallback) API_UNAVAILABLE(macos, tvos, watchos);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.")
+        API_UNAVAILABLE(macos, tvos, watchos);
 
 /** @class FIRPhoneAuthProvider
     @brief A concrete implementation of `FIRAuthProvider` for phone auth providers.
@@ -86,7 +87,8 @@ NS_SWIFT_NAME(PhoneAuthProvider) API_UNAVAILABLE(macos, tvos, watchos)
  */
 - (void)verifyPhoneNumber:(NSString *)phoneNumber
                UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
-               completion:(nullable FIRVerificationResultCallback)completion;
+               completion:(nullable void (^)(NSString *_Nullable verificationID,
+                                             NSError *_Nullable error))completion;
 
 /** @fn verifyPhoneNumber:UIDelegate:multiFactorSession:completion:
     @brief Verify ownership of the second factor phone number by the current user.
@@ -101,7 +103,8 @@ NS_SWIFT_NAME(PhoneAuthProvider) API_UNAVAILABLE(macos, tvos, watchos)
 - (void)verifyPhoneNumber:(NSString *)phoneNumber
                UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
        multiFactorSession:(nullable FIRMultiFactorSession *)session
-               completion:(nullable FIRVerificationResultCallback)completion;
+               completion:(nullable void (^)(NSString *_Nullable verificationID,
+                                             NSError *_Nullable error))completion;
 
 /** @fn verifyPhoneNumberWithMultiFactorInfo:UIDelegate:multiFactorSession:completion:
     @brief Verify ownership of the second factor phone number by the current user.

FirebaseAuth/Sources/Public/FirebaseAuth/FIRUser.h

@@ -40,7 +40,7 @@ NS_ASSUME_NONNULL_BEGIN
     @remarks One of: `token` or `error` will always be non-nil.
  */
 typedef void (^FIRAuthTokenCallback)(NSString *_Nullable token, NSError *_Nullable error)
-    NS_SWIFT_NAME(AuthTokenCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRAuthTokenResultCallback
     @brief The type of block called when a token is ready for use.
@@ -55,23 +55,23 @@ typedef void (^FIRAuthTokenCallback)(NSString *_Nullable token, NSError *_Nullab
  */
 typedef void (^FIRAuthTokenResultCallback)(FIRAuthTokenResult *_Nullable tokenResult,
                                            NSError *_Nullable error)
-    NS_SWIFT_NAME(AuthTokenResultCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRUserProfileChangeCallback
     @brief The type of block called when a user profile change has finished.
 
     @param error Optionally; the error which occurred - or nil if the request was successful.
  */
 typedef void (^FIRUserProfileChangeCallback)(NSError *_Nullable error)
-    NS_SWIFT_NAME(UserProfileChangeCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @typedef FIRSendEmailVerificationCallback
     @brief The type of block called when a request to send an email verification has finished.
 
     @param error Optionally; the error which occurred - or nil if the request was successful.
  */
 typedef void (^FIRSendEmailVerificationCallback)(NSError *_Nullable error)
-    NS_SWIFT_NAME(SendEmailVerificationCallback);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /** @class FIRUser
     @brief Represents a user. Firebase Auth does not attempt to validate users

FirebaseCombineSwift/Tests/Unit/Firestore/GetDocumentsTests.swift

@@ -27,7 +27,7 @@ class GetDocumentsTests: XCTestCase {
     var verifySource: ((_ source: FirestoreSource) -> Void)?
 
     override func getDocuments(source: FirestoreSource,
-                               completion: @escaping FIRQuerySnapshotBlock) {
+                               completion: @escaping (QuerySnapshot?, Error?) -> Void) {
       do {
         verifySource?(source)
         let snapshot = try mockGetDocuments()

FirebaseCore/Sources/Public/FirebaseCore/FIRApp.h

@@ -21,7 +21,8 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /** A block that takes a BOOL and has no return value. */
-typedef void (^FIRAppVoidBoolCallback)(BOOL success) NS_SWIFT_NAME(FirebaseAppVoidBoolCallback);
+typedef void (^FIRAppVoidBoolCallback)(BOOL success)
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /**
  * The entry point of Firebase SDKs.
@@ -96,7 +97,7 @@ NS_SWIFT_NAME(FirebaseApp)
  * Cleans up the current `FirebaseApp`, freeing associated data and returning its name to the pool
  * for future use. This method is thread safe.
  */
-- (void)deleteApp:(FIRAppVoidBoolCallback)completion;
+- (void)deleteApp:(void (^)(BOOL success))completion;
 
 /**
  * `FirebaseApp` instances should not be initialized directly. Call `FirebaseApp.configure()`,

FirebaseDynamicLinks/Sources/Public/FirebaseDynamicLinks/FDLURLComponents.h

@@ -43,7 +43,7 @@ typedef NS_ENUM(NSInteger, FIRShortDynamicLinkPathLength) {
 typedef void (^FIRDynamicLinkShortenerCompletion)(NSURL *_Nullable shortURL,
                                                   NSArray<NSString *> *_Nullable warnings,
                                                   NSError *_Nullable error)
-    NS_SWIFT_NAME(DynamicLinkShortenerCompletion);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /**
  * @class FIRDynamicLinkGoogleAnalyticsParameters
@@ -541,15 +541,19 @@ NS_SWIFT_NAME(DynamicLinkComponents)
  */
 + (void)shortenURL:(NSURL *)url
            options:(FIRDynamicLinkComponentsOptions *_Nullable)options
-        completion:(FIRDynamicLinkShortenerCompletion)completion;
+        completion:(void (^)(NSURL *_Nullable shortURL,
+                             NSArray<NSString *> *_Nullable warnings,
+                             NSError *_Nullable error))completion;
 
 /**
  * @method shortenWithCompletion:
  * @abstract Generates a short Dynamic Link URL using all set parameters.
  * @param completion A block to be executed upon completion of the shortening attempt. It is
  *     guaranteed to be executed once and on the main thread.
  */
-- (void)shortenWithCompletion:(FIRDynamicLinkShortenerCompletion)completion;
+- (void)shortenWithCompletion:(void (^)(NSURL *_Nullable shortURL,
+                                        NSArray<NSString *> *_Nullable warnings,
+                                        NSError *_Nullable error))completion;
 
 @end
 

FirebaseDynamicLinks/Sources/Public/FirebaseDynamicLinks/FIRDynamicLinks.h

@@ -80,7 +80,8 @@ NS_SWIFT_NAME(DynamicLinks)
  * universal link URL.
  */
 - (void)dynamicLinkFromUniversalLinkURL:(NSURL *)url
-                             completion:(FIRDynamicLinkUniversalLinkHandler)completion
+                             completion:(void (^)(FIRDynamicLink *_Nullable dynamicLink,
+                                                  NSError *_Nullable error))completion
     NS_SWIFT_NAME(dynamicLink(fromUniversalLink:completion:));
 
 /**
@@ -104,15 +105,18 @@ NS_SWIFT_NAME(DynamicLinks)
  * @param completion A block that handles the outcome of attempting to create a FIRDynamicLink.
  * @return YES if FIRDynamicLinks is handling the link, otherwise, NO.
  */
-- (BOOL)handleUniversalLink:(NSURL *)url completion:(FIRDynamicLinkUniversalLinkHandler)completion;
+- (BOOL)handleUniversalLink:(NSURL *)url
+                 completion:(void (^)(FIRDynamicLink *_Nullable dynamicLink,
+                                      NSError *_Nullable error))completion;
 
 /**
  * @method resolveShortLink:completion:
  * @abstract Retrieves the details of the Dynamic Link that the shortened URL represents.
  * @param url A Short Dynamic Link.
  * @param completion Block to be run upon completion.
  */
-- (void)resolveShortLink:(NSURL *)url completion:(FIRDynamicLinkResolverHandler)completion;
+- (void)resolveShortLink:(NSURL *)url
+              completion:(void (^)(NSURL *_Nullable url, NSError *_Nullable error))completion;
 
 /**
  * @method matchesShortLinkFormat:

FirebaseDynamicLinks/Sources/Public/FirebaseDynamicLinks/FIRDynamicLinksCommon.h

@@ -29,13 +29,13 @@ NS_ASSUME_NONNULL_BEGIN
  * @abstract The definition of the block used by |resolveShortLink:completion:|
  */
 typedef void (^FIRDynamicLinkResolverHandler)(NSURL* _Nullable url, NSError* _Nullable error)
-    NS_SWIFT_NAME(DynamicLinkResolverHandler);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /**
  * @abstract The definition of the block used by |handleUniversalLink:completion:|
  */
 typedef void (^FIRDynamicLinkUniversalLinkHandler)(FIRDynamicLink* _Nullable dynamicLink,
                                                    NSError* _Nullable error)
-    NS_SWIFT_NAME(DynamicLinkUniversalLinkHandler);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 NS_ASSUME_NONNULL_END

FirebaseInstallations/Source/Library/Public/FirebaseInstallations/FIRInstallations.h

@@ -38,7 +38,7 @@ FOUNDATION_EXPORT NSString *const kFIRInstallationIDDidChangeNotificationAppName
  */
 typedef void (^FIRInstallationsIDHandler)(NSString *__nullable identifier,
                                           NSError *__nullable error)
-    NS_SWIFT_NAME(InstallationsIDHandler);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /**
  * An authorization token handler block.
@@ -48,7 +48,7 @@ typedef void (^FIRInstallationsIDHandler)(NSString *__nullable identifier,
  */
 typedef void (^FIRInstallationsTokenHandler)(
     FIRInstallationsAuthTokenResult *__nullable tokenResult, NSError *__nullable error)
-    NS_SWIFT_NAME(InstallationsTokenHandler);
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 /**
  * The class provides API for Firebase Installations.
@@ -83,20 +83,20 @@ NS_SWIFT_NAME(Installations)
  * The method creates or retrieves an installation ID. The installation ID is a stable identifier
  * that uniquely identifies the app instance. NOTE: If the application already has an existing
  * FirebaseInstanceID then the InstanceID identifier will be used.
- * @param completion A completion handler which is invoked when the operation completes. See
- * `InstallationsIDHandler` for additional details.
+ * @param completion A completion handler which is invoked when the operation completes.
  */
-- (void)installationIDWithCompletion:(FIRInstallationsIDHandler)completion;
+- (void)installationIDWithCompletion:(void (^)(NSString *__nullable identifier,
+                                               NSError *__nullable error))completion;
 
 /**
  * Retrieves (locally if it exists or from the server) a valid installation auth token. An existing
  * token may be invalidated or expired, so it is recommended to fetch the installation auth token
  * before each server request. The method does the same as `Installations.authTokenForcingRefresh(:,
  * completion:)` with forcing refresh `NO`.
- * @param completion A completion handler which is invoked when the operation completes. See
- * `InstallationsTokenHandler` for additional details.
+ * @param completion A completion handler which is invoked when the operation completes.
  */
-- (void)authTokenWithCompletion:(FIRInstallationsTokenHandler)completion;
+- (void)authTokenWithCompletion:(void (^)(FIRInstallationsAuthTokenResult *__nullable tokenResult,
+                                          NSError *__nullable error))completion;
 
 /**
  * Retrieves (locally or from the server depending on `forceRefresh` value) a valid installation
@@ -111,7 +111,8 @@ NS_SWIFT_NAME(Installations)
  * `InstallationsTokenHandler` for additional details.
  */
 - (void)authTokenForcingRefresh:(BOOL)forceRefresh
-                     completion:(FIRInstallationsTokenHandler)completion;
+                     completion:(void (^)(FIRInstallationsAuthTokenResult *__nullable tokenResult,
+                                          NSError *__nullable error))completion;
 
 /**
  * Deletes all the installation data including the unique identifier, auth tokens and