Remove App Check Core Interop SDK (#11595)

The ObjC Protocol-only interop SDK is not needed by our integrators.
firebase · andrewheard · Nov 7, 2023 · May 5, 2023 · May 9, 2023 · May 9, 2023
commit fb660ae24dc8c80707fbe903c91c772706ce1e23
diff --git a/AppCheckCore.podspec b/AppCheckCore.podspec
@@ -43,7 +43,6 @@ Pod::Spec.new do |s|
   s.osx.weak_framework = 'DeviceCheck'
   s.tvos.weak_framework = 'DeviceCheck'
 
-  s.dependency 'AppCheckCoreInterop', '~> 10.11'
   s.dependency 'PromisesObjC', '~> 2.1'
   s.dependency 'GoogleUtilities/Environment', '~> 7.8'
 

diff --git a/AppCheckCore/Interop/CMakeLists.txt b/AppCheckCore/Interop/CMakeLists.txt
diff --git a/AppCheckCore/Interop/Public/AppCheckCoreInterop/AppCheckCoreInterop.h b/AppCheckCore/Interop/Public/AppCheckCoreInterop/AppCheckCoreInterop.h
diff --git a/AppCheckCore/Interop/Public/AppCheckCoreInterop/GACAppCheckInterop.h b/AppCheckCore/Interop/Public/AppCheckCoreInterop/GACAppCheckInterop.h
diff --git a/AppCheckCore/Interop/Public/AppCheckCoreInterop/GACAppCheckTokenInterop.h b/AppCheckCore/Interop/Public/AppCheckCoreInterop/GACAppCheckTokenInterop.h
diff --git a/AppCheckCore/Interop/dummy.m b/AppCheckCore/Interop/dummy.m
diff --git a/AppCheckCore/Sources/Core/GACAppCheck.m b/AppCheckCore/Sources/Core/GACAppCheck.m
@@ -22,8 +22,6 @@
 #import "FBLPromises.h"
 #endif
 
-@import AppCheckCoreInterop;
-
 #import "AppCheckCore/Sources/Public/AppCheckCore/GACAppCheckErrors.h"
 #import "AppCheckCore/Sources/Public/AppCheckCore/GACAppCheckProvider.h"
 #import "AppCheckCore/Sources/Public/AppCheckCore/GACAppCheckSettings.h"
@@ -42,6 +40,9 @@
 
 static NSString *const kDummyFACTokenValue = @"eyJlcnJvciI6IlVOS05PV05fRVJST1IifQ==";
 
+typedef void (^GACAppCheckTokenHandler)(id<GACAppCheckTokenProtocol> _Nullable token,
+                                        NSError *_Nullable error);
+
 @interface GACAppCheck ()
 
 @property(nonatomic, readonly) NSString *instanceName;
@@ -112,10 +113,9 @@ - (instancetype)initWithInstanceName:(NSString *)instanceName
 
 #pragma mark - GACAppCheckInterop
 
-- (void)getTokenForcingRefresh:(BOOL)forcingRefresh
-                    completion:(GACAppCheckTokenHandlerInterop)handler {
+- (void)getTokenForcingRefresh:(BOOL)forcingRefresh completion:(GACAppCheckTokenHandler)handler {
   [self retrieveOrRefreshTokenForcingRefresh:forcingRefresh]
-      .then(^id _Nullable(GACAppCheckToken *token) {
+      .then(^id _Nullable(id<GACAppCheckTokenProtocol> token) {
         handler(token, nil);
         return token;
       })
@@ -124,9 +124,9 @@ - (void)getTokenForcingRefresh:(BOOL)forcingRefresh
       });
 }
 
-- (void)getLimitedUseTokenWithCompletion:(GACAppCheckTokenHandlerInterop)handler {
+- (void)getLimitedUseTokenWithCompletion:(GACAppCheckTokenHandler)handler {
   [self limitedUseToken]
-      .then(^id _Nullable(GACAppCheckToken *token) {
+      .then(^id _Nullable(id<GACAppCheckTokenProtocol> token) {
         handler(token, nil);
         return token;
       })

diff --git a/AppCheckCore/Sources/Core/GACAppCheckToken.m b/AppCheckCore/Sources/Core/GACAppCheckToken.m
@@ -20,6 +20,10 @@
 
 @implementation GACAppCheckToken
 
+@synthesize token = _token;
+@synthesize expirationDate = _expirationDate;
+@synthesize receivedAtDate = _receivedAtDate;
+
 - (instancetype)initWithToken:(NSString *)token
                expirationDate:(NSDate *)expirationDate
                receivedAtDate:(NSDate *)receivedAtDate {

diff --git a/AppCheckCore/Sources/Public/AppCheckCore/GACAppCheck.h b/AppCheckCore/Sources/Public/AppCheckCore/GACAppCheck.h
@@ -16,18 +16,41 @@
 
 #import <Foundation/Foundation.h>
 
-@import AppCheckCoreInterop;
-
 @class GACAppCheckToken;
 @protocol GACAppCheckProvider;
 @protocol GACAppCheckSettingsProtocol;
 @protocol GACAppCheckTokenDelegate;
+@protocol GACAppCheckTokenProtocol;
 
 NS_ASSUME_NONNULL_BEGIN
 
+NS_SWIFT_NAME(AppCheckCoreProtocol) @protocol GACAppCheckProtocol
+
+/// Requests Firebase app check token.
+///
+/// @param forcingRefresh If `YES`,  a new Firebase app check token is requested and the token
+/// cache is ignored. If `NO`, the cached token is used if it exists and has not expired yet. In
+/// most cases, `NO` should be used. `YES` should only be used if the server explicitly returns an
+/// error, indicating a revoked token.
+/// @param handler The completion handler. Includes the app check token if the request succeeds,
+/// or an error if the request fails.
+- (void)getTokenForcingRefresh:(BOOL)forcingRefresh
+                    completion:(void (^)(id<GACAppCheckTokenProtocol> _Nullable token,
+                                         NSError *_Nullable error))handler
+    NS_SWIFT_NAME(token(forcingRefresh:completion:));
+
+/// Retrieve a new limited-use App Check token
+///
+/// This method does not affect the token generation behavior of the
+/// ``tokenForcingRefresh()`` method.
+- (void)getLimitedUseTokenWithCompletion:(void (^)(id<GACAppCheckTokenProtocol> _Nullable token,
+                                                   NSError *_Nullable error))handler;
+
+@end
+
 /// A class used to manage App Check tokens for a given resource.
 NS_SWIFT_NAME(AppCheckCore)
-@interface GACAppCheck : NSObject <GACAppCheckInterop>
+@interface GACAppCheck : NSObject <GACAppCheckProtocol>
 
 - (instancetype)init NS_UNAVAILABLE;
 

diff --git a/AppCheckCore/Sources/Public/AppCheckCore/GACAppCheckToken.h b/AppCheckCore/Sources/Public/AppCheckCore/GACAppCheckToken.h
@@ -16,13 +16,10 @@
 
 #import <Foundation/Foundation.h>
 
-@import AppCheckCoreInterop;
-
 NS_ASSUME_NONNULL_BEGIN
 
-/// An object representing a Firebase App Check token.
-NS_SWIFT_NAME(AppCheckCoreToken)
-@interface GACAppCheckToken : NSObject <GACAppCheckTokenInterop>
+NS_SWIFT_NAME(AppCheckCoreTokenProtocol)
+@protocol GACAppCheckTokenProtocol <NSObject>
 
 /// A Firebase App Check token.
 @property(nonatomic, readonly) NSString *token;
@@ -33,6 +30,12 @@ NS_SWIFT_NAME(AppCheckCoreToken)
 /// The date when the App Check token was received in the device's local time.
 @property(nonatomic, readonly) NSDate *receivedAtDate;
 
+@end
+
+/// An object representing a Firebase App Check token.
+NS_SWIFT_NAME(AppCheckCoreToken)
+@interface GACAppCheckToken : NSObject <GACAppCheckTokenProtocol>
+
 - (instancetype)init NS_UNAVAILABLE;
 
 /// Convenience initializer that uses the current device local time to set `receivedAtDate`.

diff --git a/AppCheckCore/Tests/Unit/Core/GACAppCheckTests.m b/AppCheckCore/Tests/Unit/Core/GACAppCheckTests.m
@@ -41,7 +41,7 @@
 static NSString *const kAppName = @"GACAppCheckTests";
 static NSString *const kAppGroupID = @"app_group_id";
 
-@interface GACAppCheck (Tests) <GACAppCheckInterop>
+@interface GACAppCheck (Tests)
 
 - (instancetype)initWithInstanceName:(NSString *)instanceName
                     appCheckProvider:(id<GACAppCheckProvider>)appCheckProvider
@@ -59,7 +59,7 @@ @interface GACAppCheckTests : XCTestCase
 @property(nonatomic) OCMockObject<GACAppCheckTokenRefresherProtocol> *mockTokenRefresher;
 @property(nonatomic) OCMockObject<GACAppCheckSettingsProtocol> *mockSettings;
 @property(nonatomic) OCMockObject<GACAppCheckTokenDelegate> *mockTokenDelegate;
-@property(nonatomic) GACAppCheck<GACAppCheckInterop> *appCheck;
+@property(nonatomic) GACAppCheck *appCheck;
 
 @property(nonatomic, copy, nullable) GACAppCheckTokenRefreshBlock tokenRefreshHandler;
 
@@ -184,7 +184,7 @@ - (void)testInteropGetToken_WhenNoCache_Success {
   // 2. Request token and verify result.
   [self.appCheck
       getTokenForcingRefresh:NO
-                  completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                  completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                     [expectation fulfill];
                     XCTAssertNotNil(token);
                     XCTAssertEqualObjects(token.token, expectedToken.token);
@@ -210,7 +210,7 @@ - (void)testInteropGetTokenForcingRefresh_WhenCachedTokenIsValid_Success {
   // 2. Request token and verify result.
   [self.appCheck
       getTokenForcingRefresh:YES
-                  completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                  completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                     [expectation fulfill];
                     XCTAssertNotNil(token);
                     XCTAssertEqualObjects(token.token, expectedToken.token);
@@ -232,7 +232,7 @@ - (void)testInteropGetToken_WhenCachedTokenExpired_Success {
   // 2. Request token and verify result.
   [self.appCheck
       getTokenForcingRefresh:NO
-                  completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                  completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                     [expectation fulfill];
                     XCTAssertNotNil(token);
                     XCTAssertEqualObjects(token.token, expectedToken.token);
@@ -255,7 +255,7 @@ - (void)testInteropGetToken_AppCheckProviderError {
   // 2. Request token and verify result.
   [self.appCheck
       getTokenForcingRefresh:NO
-                  completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                  completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                     [expectation fulfill];
                     XCTAssertNil(token);
                     XCTAssertEqualObjects(error, providerError);
@@ -357,7 +357,7 @@ - (void)testLimitedUseTokenWithSuccess {
   // 5. Expect token request to be completed.
   XCTestExpectation *getTokenExpectation = [self expectationWithDescription:@"getToken"];
 
-  [self.appCheck getLimitedUseTokenWithCompletion:^(id<GACAppCheckTokenInterop> _Nullable token,
+  [self.appCheck getLimitedUseTokenWithCompletion:^(id<GACAppCheckTokenProtocol> _Nullable token,
                                                     NSError *_Nullable error) {
     [getTokenExpectation fulfill];
     XCTAssertNotNil(token);
@@ -386,7 +386,7 @@ - (void)testLimitedUseToken_WhenTokenGenerationErrors {
   // 5. Expect token request to be completed.
   XCTestExpectation *getTokenExpectation = [self expectationWithDescription:@"getToken"];
 
-  [self.appCheck getLimitedUseTokenWithCompletion:^(id<GACAppCheckTokenInterop> _Nullable token,
+  [self.appCheck getLimitedUseTokenWithCompletion:^(id<GACAppCheckTokenProtocol> _Nullable token,
                                                     NSError *_Nullable error) {
     [getTokenExpectation fulfill];
     XCTAssertNotNil(error);
@@ -426,7 +426,7 @@ - (void)testInteropGetToken_WhenCalledSeveralTimesSuccess_ThenThereIsOnlyOneOper
     // 3.2. Request token and verify result.
     [self.appCheck
         getTokenForcingRefresh:NO
-                    completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                    completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                       [getTokenExpectation fulfill];
                       XCTAssertNotNil(token);
                       XCTAssertEqualObjects(token.token, expectedToken.token);
@@ -471,7 +471,7 @@ - (void)testInteropGetToken_WhenCalledSeveralTimesError_ThenThereIsOnlyOneOperat
     // 3.2. Request token and verify result.
     [self.appCheck
         getTokenForcingRefresh:NO
-                    completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                    completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                       [getTokenExpectation fulfill];
                       XCTAssertNil(token);
                       XCTAssertEqualObjects(error, storageError);
@@ -522,7 +522,7 @@ - (void)assertGetToken_WhenCachedTokenIsValid_Success {
 
   // 2. Request token and verify result.
   [self.appCheck getTokenForcingRefresh:NO
-                             completion:^(id<GACAppCheckTokenInterop> _Nullable token,
+                             completion:^(id<GACAppCheckTokenProtocol> _Nullable token,
                                           NSError *_Nullable error) {
                                [expectation fulfill];
                                XCTAssertNotNil(token);
@@ -545,7 +545,7 @@ - (void)assertInteropGetToken_WhenCachedTokenIsValid_Success {
   // 2. Request token and verify result.
   [self.appCheck
       getTokenForcingRefresh:NO
-                  completion:^(id<GACAppCheckTokenInterop> _Nullable token, NSError *error) {
+                  completion:^(id<GACAppCheckTokenProtocol> _Nullable token, NSError *error) {
                     [expectation fulfill];
                     XCTAssertNotNil(token);
                     XCTAssertEqualObjects(token.token, cachedToken.token);