From 8e6b35a2a826e65c65bbc409fad2717262636eb4 Mon Sep 17 00:00:00 2001 From: Andrew Heard Date: Thu, 20 Jul 2023 10:07:16 -0400 Subject: [PATCH] Rename Swift symbols to AppCheckCore* --- .../Public/AppCheck/GACAppAttestProvider.h | 2 +- .../Sources/Public/AppCheck/GACAppCheck.h | 6 ++-- .../AppCheck/GACAppCheckDebugProvider.h | 2 +- .../Public/AppCheck/GACAppCheckErrors.h | 6 ++-- .../Public/AppCheck/GACAppCheckProvider.h | 2 +- .../Public/AppCheck/GACAppCheckSettings.h | 1 + .../Public/AppCheck/GACAppCheckToken.h | 2 +- .../AppCheck/GACAppCheckTokenDelegate.h | 1 + .../Public/AppCheck/GACDeviceCheckProvider.h | 2 +- .../Tests/Unit/Swift/AppCheckAPITests.swift | 34 +++++++++---------- 10 files changed, 30 insertions(+), 28 deletions(-) diff --git a/AppCheck/Sources/Public/AppCheck/GACAppAttestProvider.h b/AppCheck/Sources/Public/AppCheck/GACAppAttestProvider.h index ad7a7708aa5..5eeb03fc3c2 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppAttestProvider.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppAttestProvider.h @@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN /// This class is available on all platforms for select OS versions. See /// https://firebase.google.com/docs/ios/learn-more for more details. GAC_APP_ATTEST_PROVIDER_AVAILABILITY -NS_SWIFT_NAME(InternalAppAttestProvider) +NS_SWIFT_NAME(AppCheckCoreAppAttestProvider) @interface GACAppAttestProvider : NSObject - (instancetype)init NS_UNAVAILABLE; diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheck.h b/AppCheck/Sources/Public/AppCheck/GACAppCheck.h index f4240a1da82..d0f2f989f6d 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheck.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheck.h @@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN /// A class used to manage App Check tokens for a given resource. -NS_SWIFT_NAME(InternalAppCheck) +NS_SWIFT_NAME(AppCheckCore) @interface GACAppCheck : NSObject - (instancetype)init NS_UNAVAILABLE; /// Returns an instance of `AppCheck` for an application. -/// @param appCheckProvider An `InternalAppCheckProvider` instance that provides App Check tokens. -/// @return An instance of `AppCheck` corresponding to the provided `app`. +/// @param appCheckProvider An `AppCheckCoreProvider` instance that provides App Check tokens. +/// @return An instance of `AppCheckCore` corresponding to the provided `app`. - (instancetype)initWithInstanceName:(NSString *)instanceName appCheckProvider:(id)appCheckProvider settings:(id)settings diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheckDebugProvider.h b/AppCheck/Sources/Public/AppCheck/GACAppCheckDebugProvider.h index 5ef378248c5..8bfcd3dd0e6 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheckDebugProvider.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheckDebugProvider.h @@ -58,7 +58,7 @@ NS_ASSUME_NONNULL_BEGIN /// `xcodebuild test -scheme InstallationsExample -workspace InstallationsExample.xcworkspace \ /// MY_APP_CHECK_DEBUG_TOKEN=$(MY_SECRET_ON_CI)` /// -NS_SWIFT_NAME(InternalAppCheckDebugProvider) +NS_SWIFT_NAME(AppCheckCoreDebugProvider) @interface GACAppCheckDebugProvider : NSObject - (instancetype)init NS_UNAVAILABLE; diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheckErrors.h b/AppCheck/Sources/Public/AppCheck/GACAppCheckErrors.h index 521e69ea355..48a551b3d00 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheckErrors.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheckErrors.h @@ -17,7 +17,7 @@ #import /// Firebase app check error domain. -FOUNDATION_EXTERN NSErrorDomain const GACAppCheckErrorDomain NS_SWIFT_NAME(InternalAppCheckErrorDomain); +FOUNDATION_EXTERN NSErrorDomain const GACAppCheckErrorDomain NS_SWIFT_NAME(AppCheckCoreErrorDomain); typedef NS_ERROR_ENUM(GACAppCheckErrorDomain, GACAppCheckErrorCode){ /// An unknown or non-actionable error. @@ -36,7 +36,7 @@ typedef NS_ERROR_ENUM(GACAppCheckErrorDomain, GACAppCheckErrorCode){ /// Selected app attestation provider is not supported on the current platform or OS version. GACAppCheckErrorCodeUnsupported = 4 -} NS_SWIFT_NAME(InternalAppCheckErrorCode); +} NS_SWIFT_NAME(AppCheckCoreErrorCode); #pragma mark - Error Message Codes @@ -53,4 +53,4 @@ typedef NS_ENUM(NSInteger, GACAppCheckMessageCode) { // App Attest Provider GACLoggerAppCheckMessageCodeAppAttestNotSupported = 7001, GACLoggerAppCheckMessageCodeAttestationRejected = 7002 -}; +} NS_SWIFT_NAME(AppCheckCoreMessageCode); diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheckProvider.h b/AppCheck/Sources/Public/AppCheck/GACAppCheckProvider.h index 23bbc909db3..f453dc6a1eb 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheckProvider.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheckProvider.h @@ -26,7 +26,7 @@ typedef void (^GACAppCheckAPIRequestHook)(NSMutableURLRequest *request); /// Defines the methods required to be implemented by a specific Firebase App Check /// provider. -NS_SWIFT_NAME(InternalAppCheckProvider) +NS_SWIFT_NAME(AppCheckCoreProvider) @protocol GACAppCheckProvider /// Returns a new Firebase App Check token. diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheckSettings.h b/AppCheck/Sources/Public/AppCheck/GACAppCheckSettings.h index 66249c89e79..03d19379a4b 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheckSettings.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheckSettings.h @@ -19,6 +19,7 @@ NS_ASSUME_NONNULL_BEGIN /// A collection of App Check-wide settings and parameters. +NS_SWIFT_NAME(AppCheckCoreSettingsProtocol) @protocol GACAppCheckSettingsProtocol /// If App Check token auto-refresh is enabled. diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheckToken.h b/AppCheck/Sources/Public/AppCheck/GACAppCheckToken.h index 04646589a81..10280e5025a 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheckToken.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheckToken.h @@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN /// An object representing a Firebase App Check token. -NS_SWIFT_NAME(InternalAppCheckToken) +NS_SWIFT_NAME(AppCheckCoreToken) @interface GACAppCheckToken : NSObject /// A Firebase App Check token. diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheckTokenDelegate.h b/AppCheck/Sources/Public/AppCheck/GACAppCheckTokenDelegate.h index 80a6ebf9b56..195946e45c9 100644 --- a/AppCheck/Sources/Public/AppCheck/GACAppCheckTokenDelegate.h +++ b/AppCheck/Sources/Public/AppCheck/GACAppCheckTokenDelegate.h @@ -18,6 +18,7 @@ NS_ASSUME_NONNULL_BEGIN +NS_SWIFT_NAME(AppCheckCoreTokenDelegate) @protocol GACAppCheckTokenDelegate /// Called each time an App Check token is refreshed. diff --git a/AppCheck/Sources/Public/AppCheck/GACDeviceCheckProvider.h b/AppCheck/Sources/Public/AppCheck/GACDeviceCheckProvider.h index 7c47e2cad65..6a45da693cb 100644 --- a/AppCheck/Sources/Public/AppCheck/GACDeviceCheckProvider.h +++ b/AppCheck/Sources/Public/AppCheck/GACDeviceCheckProvider.h @@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN /// This class is available on all platforms for select OS versions. See /// https://firebase.google.com/docs/ios/learn-more for more details. GAC_DEVICE_CHECK_PROVIDER_AVAILABILITY -NS_SWIFT_NAME(InternalDeviceCheckProvider) +NS_SWIFT_NAME(AppCheckCoreDeviceCheckProvider) @interface GACDeviceCheckProvider : NSObject - (instancetype)init NS_UNAVAILABLE; diff --git a/AppCheck/Tests/Unit/Swift/AppCheckAPITests.swift b/AppCheck/Tests/Unit/Swift/AppCheckAPITests.swift index e9609b0119c..d8920dfb646 100644 --- a/AppCheck/Tests/Unit/Swift/AppCheckAPITests.swift +++ b/AppCheck/Tests/Unit/Swift/AppCheckAPITests.swift @@ -32,7 +32,7 @@ final class AppCheckAPITests { #if TARGET_OS_IOS if #available(iOS 14.0, *) { // TODO(andrewheard): Add `requestHooks` in API tests. - if let provider = InternalAppAttestProvider( + if let provider = AppCheckCoreAppAttestProvider( storageID: app.name, resourceName: resourceName, apiKey: app.options.apiKey, @@ -51,7 +51,7 @@ final class AppCheckAPITests { guard let app = FirebaseApp.app() else { return } // Retrieving an AppCheck instance - let appCheck = InternalAppCheck( + let appCheck = AppCheckCore( instanceName: app.name, appCheckProvider: DummyAppCheckProvider(), settings: DummyAppCheckSettings(), @@ -85,7 +85,7 @@ final class AppCheckAPITests { // `AppCheckDebugProvider` initializer // TODO(andrewheard): Add `requestHooks` in API tests. - let debugProvider = InternalAppCheckDebugProvider( + let debugProvider = AppCheckCoreDebugProvider( storageID: app.name, resourceName: resourceName, apiKey: app.options.apiKey, @@ -117,7 +117,7 @@ final class AppCheckAPITests { // MARK: - AppCheckToken - let token = InternalAppCheckToken(token: "token", expirationDate: Date.distantFuture) + let token = AppCheckCoreToken(token: "token", expirationDate: Date.distantFuture) _ = token.token _ = token.expirationDate @@ -126,15 +126,15 @@ final class AppCheckAPITests { appCheck.token(forcingRefresh: false) { _, error in if let error = error { switch error { - case InternalAppCheckErrorCode.unknown: + case AppCheckCoreErrorCode.unknown: break - case InternalAppCheckErrorCode.serverUnreachable: + case AppCheckCoreErrorCode.serverUnreachable: break - case InternalAppCheckErrorCode.invalidConfiguration: + case AppCheckCoreErrorCode.invalidConfiguration: break - case InternalAppCheckErrorCode.keychain: + case AppCheckCoreErrorCode.keychain: break - case InternalAppCheckErrorCode.unsupported: + case AppCheckCoreErrorCode.unsupported: break default: break @@ -156,7 +156,7 @@ final class AppCheckAPITests { #if !os(watchOS) if #available(iOS 11.0, macOS 10.15, macCatalyst 13.0, tvOS 11.0, *) { // TODO(andrewheard): Add `requestHooks` in API tests. - let deviceCheckProvider = InternalDeviceCheckProvider( + let deviceCheckProvider = AppCheckCoreDeviceCheckProvider( storageID: app.name, resourceName: resourceName, apiKey: app.options.apiKey, @@ -176,7 +176,7 @@ final class AppCheckAPITests { Task { do { _ = try await deviceCheckProvider.getToken() - } catch InternalAppCheckErrorCode.unsupported { + } catch AppCheckCoreErrorCode.unsupported { // ... } catch { // ... @@ -193,16 +193,16 @@ final class AppCheckAPITests { } } -class DummyAppCheckProvider: NSObject, InternalAppCheckProvider { - func getToken(completion handler: @escaping (InternalAppCheckToken?, Error?) -> Void) { - handler(InternalAppCheckToken(token: "token", expirationDate: .distantFuture), nil) +class DummyAppCheckProvider: NSObject, AppCheckCoreProvider { + func getToken(completion handler: @escaping (AppCheckCoreToken?, Error?) -> Void) { + handler(AppCheckCoreToken(token: "token", expirationDate: .distantFuture), nil) } } -class DummyAppCheckSettings: NSObject, GACAppCheckSettingsProtocol { +class DummyAppCheckSettings: NSObject, AppCheckCoreSettingsProtocol { var isTokenAutoRefreshEnabled: Bool = true } -class DummyAppCheckTokenDelegate: NSObject, GACAppCheckTokenDelegate { - func tokenDidUpdate(_ token: InternalAppCheckToken, instanceName: String) {} +class DummyAppCheckTokenDelegate: NSObject, AppCheckCoreTokenDelegate { + func tokenDidUpdate(_ token: AppCheckCoreToken, instanceName: String) {} }