firebase · andrewheard · May 15, 2023 · May 15, 2023 · May 15, 2023 · paulb777
diff --git a/AppCheck.podspec b/AppCheck.podspec
@@ -45,6 +45,7 @@ Pod::Spec.new do |s|
   s.osx.weak_framework = 'DeviceCheck'
   s.tvos.weak_framework = 'DeviceCheck'
 
+  s.dependency 'AppCheckInterop', '~> 10.10'
   s.dependency 'FirebaseCore', '~> 10.0'
   s.dependency 'PromisesObjC', '~> 2.1'
   s.dependency 'GoogleUtilities/Environment', '~> 7.8'

diff --git a/AppCheck/Sources/Core/GACAppCheck+Internal.h b/AppCheck/Sources/Core/GACAppCheck+Internal.h
diff --git a/AppCheck/Sources/Core/GACAppCheck.m b/AppCheck/Sources/Core/GACAppCheck.m
@@ -24,10 +24,8 @@
 
 #import "AppCheck/Sources/Public/AppCheck/GACAppCheckErrors.h"
 #import "AppCheck/Sources/Public/AppCheck/GACAppCheckProvider.h"
-#import "AppCheck/Sources/Public/AppCheck/GACAppCheckProviderFactory.h"
 
 #import "AppCheck/Sources/Core/Errors/GACAppCheckErrorUtil.h"
-#import "AppCheck/Sources/Core/GACAppCheck+Internal.h"
 #import "AppCheck/Sources/Core/GACAppCheckLogger.h"
 #import "AppCheck/Sources/Core/GACAppCheckSettings.h"
 #import "AppCheck/Sources/Core/GACAppCheckToken+Internal.h"
@@ -64,14 +62,11 @@
     @"FirebaseAppCheckTokenAutoRefreshEnabled";
 // FIREBASE_APP_CHECK_ONLY_END
 
-static id<GACAppCheckProviderFactory> _providerFactory;
-
 static const NSTimeInterval kTokenExpirationThreshold = 5 * 60;  // 5 min.
 
 static NSString *const kDummyFACTokenValue = @"eyJlcnJvciI6IlVOS05PV05fRVJST1IifQ==";
 
-@interface GACAppCheck () <GACAppCheckInterop>
-@property(class, nullable) id<GACAppCheckProviderFactory> providerFactory;
+@interface GACAppCheck ()
 
 @property(nonatomic, readonly) NSString *appName;
 @property(nonatomic, readonly) id<GACAppCheckProvider> appCheckProvider;
@@ -83,33 +78,41 @@ @interface GACAppCheck () <GACAppCheckInterop>
 
 @property(nonatomic, nullable) FBLPromise<GACAppCheckToken *> *ongoingRetrieveOrRefreshTokenPromise;
 @property(nonatomic, nullable) FBLPromise<GACAppCheckToken *> *ongoingLimitedUseTokenPromise;
+
 @end
 
 @implementation GACAppCheck
 
 #pragma mark - Internal
 
-- (nullable instancetype)initWithApp:(FIRApp *)app {
-  id<GACAppCheckProviderFactory> providerFactory = [GACAppCheck providerFactory];
+- (instancetype)initWithAppName:(NSString *)appName
+               appCheckProvider:(id<GACAppCheckProvider>)appCheckProvider
+                        storage:(id<GACAppCheckStorageProtocol>)storage
+                 tokenRefresher:(id<GACAppCheckTokenRefresherProtocol>)tokenRefresher
+             notificationCenter:(NSNotificationCenter *)notificationCenter
+                       settings:(id<GACAppCheckSettingsProtocol>)settings {
+  self = [super init];
+  if (self) {
+    _appName = appName;
+    _appCheckProvider = appCheckProvider;
+    _storage = storage;
+    _tokenRefresher = tokenRefresher;
+    _notificationCenter = notificationCenter;
+    _settings = settings;
 
-  if (providerFactory == nil) {
-    GACLogError(kFIRLoggerAppCheckMessageCodeProviderFactoryIsMissing,
-                @"Cannot instantiate `GACAppCheck` for app: %@ without a provider factory. "
-                @"Please register a provider factory using "
-                @"`AppCheck.setAppCheckProviderFactory(_ ,forAppName:)` method.",
-                app.name);
-    return nil;
+    __auto_type __weak weakSelf = self;
+    tokenRefresher.tokenRefreshHandler = ^(GACAppCheckTokenRefreshCompletion _Nonnull completion) {
+      __auto_type strongSelf = weakSelf;
+      [strongSelf periodicTokenRefreshWithCompletion:completion];
+    };
   }
+  return self;
+}
 
-  id<GACAppCheckProvider> appCheckProvider = [providerFactory createProviderWithApp:app];
-  if (appCheckProvider == nil) {
-    GACLogError(kFIRLoggerAppCheckMessageCodeProviderIsMissing,
-                @"Cannot instantiate `GACAppCheck` for app: %@ without an app check provider. "
-                @"Please make sure the provider factory returns a valid app check provider.",
-                app.name);
-    return nil;
-  }
+#pragma mark - Public
 
+- (instancetype)initWithApp:(FIRApp *)app
+           appCheckProvider:(id<GACAppCheckProvider>)appCheckProvider {
   id<GACAppCheckSettingsProtocol> settings = [[GACAppCheckSettings alloc]
                        initWithUserDefaults:[NSUserDefaults standardUserDefaults]
                                  mainBundle:[NSBundle mainBundle]
@@ -137,50 +140,6 @@ - (nullable instancetype)initWithApp:(FIRApp *)app {
                       settings:settings];
 }
 
-- (instancetype)initWithAppName:(NSString *)appName
-               appCheckProvider:(id<GACAppCheckProvider>)appCheckProvider
-                        storage:(id<GACAppCheckStorageProtocol>)storage
-                 tokenRefresher:(id<GACAppCheckTokenRefresherProtocol>)tokenRefresher
-             notificationCenter:(NSNotificationCenter *)notificationCenter
-                       settings:(id<GACAppCheckSettingsProtocol>)settings {
-  self = [super init];
-  if (self) {
-    _appName = appName;
-    _appCheckProvider = appCheckProvider;
-    _storage = storage;
-    _tokenRefresher = tokenRefresher;
-    _notificationCenter = notificationCenter;
-    _settings = settings;
-
-    __auto_type __weak weakSelf = self;
-    tokenRefresher.tokenRefreshHandler = ^(GACAppCheckTokenRefreshCompletion _Nonnull completion) {
-      __auto_type strongSelf = weakSelf;
-      [strongSelf periodicTokenRefreshWithCompletion:completion];
-    };
-  }
-  return self;
-}
-
-#pragma mark - Public
-
-+ (instancetype)appCheck {
-  FIRApp *defaultApp = [FIRApp defaultApp];
-  if (!defaultApp) {
-    [NSException raise:GACAppCheckErrorDomain
-                format:@"The default FirebaseApp instance must be configured before the default"
-                       @"AppCheck instance can be initialized. One way to ensure this is to "
-                       @"call `FirebaseApp.configure()` in the App Delegate's "
-                       @"`application(_:didFinishLaunchingWithOptions:)` (or the `@main` struct's "
-                       @"initializer in SwiftUI)."];
-  }
-  return [self appCheckWithApp:defaultApp];
-}
-
-+ (nullable instancetype)appCheckWithApp:(FIRApp *)firebaseApp {
-  id<GACAppCheckInterop> appCheck = FIR_COMPONENT(GACAppCheckInterop, firebaseApp.container);
-  return (GACAppCheck *)appCheck;
-}
-
 - (void)tokenForcingRefresh:(BOOL)forcingRefresh
                  completion:(void (^)(GACAppCheckToken *_Nullable token,
                                       NSError *_Nullable error))handler {
@@ -206,10 +165,6 @@ - (void)limitedUseTokenWithCompletion:(void (^)(GACAppCheckToken *_Nullable toke
       });
 }
 
-+ (void)setAppCheckProviderFactory:(nullable id<GACAppCheckProviderFactory>)factory {
-  self.providerFactory = factory;
-}
-
 - (void)setIsTokenAutoRefreshEnabled:(BOOL)isTokenAutoRefreshEnabled {
   self.settings.isTokenAutoRefreshEnabled = isTokenAutoRefreshEnabled;
 }
@@ -218,20 +173,6 @@ - (BOOL)isTokenAutoRefreshEnabled {
   return self.settings.isTokenAutoRefreshEnabled;
 }
 
-#pragma mark - App Check Provider Ingestion
-
-+ (void)setProviderFactory:(nullable id<GACAppCheckProviderFactory>)providerFactory {
-  @synchronized(self) {
-    _providerFactory = providerFactory;
-  }
-}
-
-+ (nullable id<GACAppCheckProviderFactory>)providerFactory {
-  @synchronized(self) {
-    return _providerFactory;
-  }
-}
-
 #pragma mark - GACAppCheckInterop
 
 - (void)getTokenForcingRefresh:(BOOL)forcingRefresh

diff --git a/AppCheck/Sources/DeviceCheckProvider/GACDeviceCheckProviderFactory.m b/AppCheck/Sources/DeviceCheckProvider/GACDeviceCheckProviderFactory.m
@@ -20,15 +20,11 @@
 
 #import "AppCheck/Sources/Public/AppCheck/GACDeviceCheckProviderFactory.h"
 
-#import "AppCheck/Sources/Public/AppCheck/GACAppCheck.h"
+#import "AppCheck/Sources/Public/AppCheck/GACAppCheckProvider.h"
 #import "AppCheck/Sources/Public/AppCheck/GACDeviceCheckProvider.h"
 
 @implementation GACDeviceCheckProviderFactory
 
-+ (void)load {
-  [GACAppCheck setAppCheckProviderFactory:[[self alloc] init]];
-}
-
 - (nullable id<GACAppCheckProvider>)createProviderWithApp:(nonnull FIRApp *)app {
   return [[GACDeviceCheckProvider alloc] initWithApp:app];
 }

diff --git a/AppCheck/Sources/Public/AppCheck/GACAppCheck.h b/AppCheck/Sources/Public/AppCheck/GACAppCheck.h
@@ -16,9 +16,11 @@
 
 #import <Foundation/Foundation.h>
 
+#import <AppCheckInterop/GACAppCheckInterop.h>
+
 @class FIRApp;
 @class GACAppCheckToken;
-@protocol GACAppCheckProviderFactory;
+@protocol GACAppCheckProvider;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -35,21 +37,16 @@ FOUNDATION_EXPORT NSString *const kGACAppCheckTokenNotificationKey NS_SWIFT_NAME
 FOUNDATION_EXPORT NSString *const kGACAppCheckAppNameNotificationKey NS_SWIFT_NAME(InternalAppCheckAppNameNotificationKey);
 
 NS_SWIFT_NAME(InternalAppCheck)
-@interface GACAppCheck : NSObject
+@interface GACAppCheck : NSObject <GACAppCheckInterop>
 
 - (instancetype)init NS_UNAVAILABLE;
 
-/// Returns a default instance of `AppCheck`.
-/// @return An instance of `AppCheck` for `FirebaseApp.defaultApp()`.
-/// @throw Throws an exception if the default app is not configured yet or required `FirebaseApp`
-/// options are missing.
-+ (instancetype)appCheck NS_SWIFT_NAME(appCheck());
-
 /// Returns an instance of `AppCheck` for an application.
-/// @param firebaseApp A configured `FirebaseApp` instance if exists.
-/// @return An instance of `AppCheck` corresponding to the passed application.
-/// @throw Throws an exception if required `FirebaseApp` options are missing.
-+ (nullable instancetype)appCheckWithApp:(FIRApp *)firebaseApp NS_SWIFT_NAME(appCheck(app:));
+/// @param app A configured `FirebaseApp` instance.
+/// @param appCheckProvider  An `InternalAppCheckProvider` instance that provides App Check tokens.
+/// @return An instance of `AppCheck` corresponding to the provided `app`.
+- (instancetype)initWithApp:(FIRApp *)app
+           appCheckProvider:(id<GACAppCheckProvider>)appCheckProvider;
 
 /// Requests Firebase app check token. This method should *only* be used if you need to authorize
 /// requests to a non-Firebase backend. Requests to Firebase backend are authorized automatically if
@@ -81,19 +78,6 @@ NS_SWIFT_NAME(InternalAppCheck)
 - (void)limitedUseTokenWithCompletion:(void (^)(GACAppCheckToken *_Nullable token,
                                                 NSError *_Nullable error))handler;
 
-/// Sets the `AppCheckProviderFactory` to use to generate
-/// `AppCheckDebugProvider` objects.
-///
-/// An instance of `DeviceCheckProviderFactory` is used by default, but you can
-/// also use a custom `AppCheckProviderFactory` implementation or an
-/// instance of `AppCheckDebugProviderFactory` to test your app on a simulator
-/// on a local machine or a build server.
-///
-/// NOTE: Make sure to call this method before `FirebaseApp.configure()`. If
-/// this method is called after configuring Firebase, the changes will not take
-/// effect.
-+ (void)setAppCheckProviderFactory:(nullable id<GACAppCheckProviderFactory>)factory;
-
 /// If this flag is disabled then Firebase app check will not periodically auto-refresh the app
 /// check token. The default value of the flag is equal to
 /// `FirebaseApp.dataCollectionDefaultEnabled`. To disable the flag by default set

diff --git a/AppCheck/Tests/Unit/Core/GACAppCheckIntegrationTests.m b/AppCheck/Tests/Unit/Core/GACAppCheckIntegrationTests.m
@@ -90,11 +90,6 @@ - (void)setUp {
 - (void)tearDown {
   [FIRApp resetApps];
 
-  if (@available(iOS 11.0, macOS 10.15, macCatalyst 13.0, tvOS 11.0, watchOS 9.0, *)) {
-    // Recover default provider factory.
-    [GACAppCheck setAppCheckProviderFactory:[[GACDeviceCheckProviderFactory alloc] init]];
-  }
-
   [self.mockTokenRefresher stopMocking];
   self.mockTokenRefresher = nil;
   [self.mockProviderFactory stopMocking];
@@ -207,16 +202,15 @@ - (void)configureAppWithName:(NSString *)appName {
 }
 
 - (void)usageExample {
-  // Set a custom app check provider factory for the default FIRApp.
-  [GACAppCheck setAppCheckProviderFactory:[[AppCheckProviderFactory alloc] init]];
   [FIRApp configure];
 
   FIROptions *options = [[FIROptions alloc] initWithContentsOfFile:@"path"];
   [FIRApp configureWithName:@"AppName" options:options];
 
   FIRApp *defaultApp = [FIRApp defaultApp];
 
-  id<GACAppCheckInterop> defaultAppCheck = FIR_COMPONENT(GACAppCheckInterop, defaultApp.container);
+  id<GACAppCheckInterop> defaultAppCheck =
+      [[GACAppCheck alloc] initWithApp:defaultApp appCheckProvider:self.mockAppCheckProvider];
 
   [defaultAppCheck getTokenForcingRefresh:NO
                                completion:^(id<GACAppCheckTokenResultInterop> tokenResult) {

diff --git a/AppCheck/Tests/Unit/Core/GACAppCheckTests.m b/AppCheck/Tests/Unit/Core/GACAppCheckTests.m
@@ -46,14 +46,14 @@
 static NSString *const kDummyToken = @"eyJlcnJvciI6IlVOS05PV05fRVJST1IifQ==";
 
 @interface GACAppCheck (Tests) <GACAppCheckInterop>
+
 - (instancetype)initWithAppName:(NSString *)appName
                appCheckProvider:(id<GACAppCheckProvider>)appCheckProvider
                         storage:(id<GACAppCheckStorageProtocol>)storage
                  tokenRefresher:(id<GACAppCheckTokenRefresherProtocol>)tokenRefresher
              notificationCenter:(NSNotificationCenter *)notificationCenter
                        settings:(id<GACAppCheckSettingsProtocol>)settings;
 
-- (nullable instancetype)initWithApp:(FIRApp *)app;
 @end
 
 @interface GACAppCheckTests : XCTestCase
@@ -146,23 +146,17 @@ - (void)testInitWithApp {
   OCMExpect([mockStorage initWithTokenKey:tokenKey accessGroup:appGroupID]).andReturn(mockStorage);
 
   // 4. Stub attestation provider.
-  OCMockObject<GACAppCheckProviderFactory> *mockProviderFactory =
-      OCMProtocolMock(@protocol(GACAppCheckProviderFactory));
   OCMockObject<GACAppCheckProvider> *mockProvider = OCMProtocolMock(@protocol(GACAppCheckProvider));
-  OCMExpect([mockProviderFactory createProviderWithApp:mockApp]).andReturn(mockProvider);
-
-  [GACAppCheck setAppCheckProviderFactory:mockProviderFactory];
 
   // 5. Call init.
-  GACAppCheck *appCheck = [[GACAppCheck alloc] initWithApp:mockApp];
+  GACAppCheck *appCheck = [[GACAppCheck alloc] initWithApp:mockApp appCheckProvider:mockProvider];
   XCTAssert([appCheck isKindOfClass:[GACAppCheck class]]);
 
   // 6. Verify mocks.
   OCMVerifyAll(mockApp);
   OCMVerifyAll(mockAppOptions);
   OCMVerifyAll(mockTokenRefresher);
   OCMVerifyAll(mockStorage);
-  OCMVerifyAll(mockProviderFactory);
   OCMVerifyAll(mockProvider);
 
   // 7. Stop mocking real class mocks.