Make Firebase Performance initialize using Component system. (#10692)

Author: visumickey

FirebasePerformance/Sources/FPRClient+Private.h

@@ -19,6 +19,11 @@
 @class FPRConfigurations;
 @class FIRInstallations;
 
+/// Protocol to define the Firebase performance provider for the component framework.
+@protocol FIRPerformanceProvider <NSObject>
+
+@end
+
 /**
  * Extension that is added on top of the class FPRClient to make the private properties visible
  * between the implementation file and the unit tests.

FirebasePerformance/Sources/FPRClient.m

@@ -35,7 +35,7 @@
 
 #import "FirebaseCore/Extension/FirebaseCoreInternal.h"
 
-@interface FPRClient ()
+@interface FPRClient () <FIRLibrary, FIRPerformanceProvider>
 
 /** The original configuration object used to initialize the client. */
 @property(nonatomic, strong) FPRConfiguration *config;
@@ -48,22 +48,26 @@ @interface FPRClient ()
 @implementation FPRClient
 
 + (void)load {
-  __weak NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];
-  __block id listener;
-
-  void (^observerBlock)(NSNotification *) = ^(NSNotification *aNotification) {
-    NSDictionary *appInfoDict = aNotification.userInfo;
-    NSNumber *isDefaultApp = appInfoDict[kFIRAppIsDefaultAppKey];
-    if (![isDefaultApp boolValue]) {
-      return;
+  [FIRApp registerInternalLibrary:[FPRClient class]
+                         withName:@"fire-perf"
+                      withVersion:[NSString stringWithUTF8String:kFPRSDKVersion]];
+}
+
+#pragma mark - Component registration system
+
++ (nonnull NSArray<FIRComponent *> *)componentsToRegister {
+  FIRComponentCreationBlock creationBlock =
+      ^id _Nullable(FIRComponentContainer *container, BOOL *isCacheable) {
+    if (!container.app.isDefaultApp) {
+      return nil;
     }
 
-    NSString *appName = appInfoDict[kFIRAppNameKey];
+    NSString *appName = container.app.name;
     FIRApp *app = [FIRApp appNamed:appName];
     FIROptions *options = app.options;
     NSError *error = nil;
 
-    // Based on the environment variable SDK decides if events are dispatchd to Autopush or Prod.
+    // Based on the environment variable SDK decides if events are dispatched to Autopush or Prod.
     // By default, events are sent to Prod.
     BOOL useAutoPush = NO;
     NSDictionary<NSString *, NSString *> *environment = [NSProcessInfo processInfo].environment;
@@ -79,17 +83,18 @@ + (void)load {
       FPRLogError(kFPRClientInitialize, @"Failed to initialize the client with error:  %@.", error);
     }
 
-    [notificationCenter removeObserver:listener];
-    listener = nil;
+    *isCacheable = YES;
+
+    return [self sharedInstance];
   };
 
-  // Register the Perf library for Firebase Core tracking.
-  [FIRApp registerLibrary:@"fire-perf"  // From go/firebase-sdk-platform-info
-              withVersion:[NSString stringWithUTF8String:kFPRSDKVersion]];
-  listener = [notificationCenter addObserverForName:kFIRAppReadyToConfigureSDKNotification
-                                             object:[FIRApp class]
-                                              queue:nil
-                                         usingBlock:observerBlock];
+  FIRComponent *component =
+      [FIRComponent componentWithProtocol:@protocol(FIRPerformanceProvider)
+                      instantiationTiming:FIRInstantiationTimingEagerInDefaultApp
+                             dependencies:@[]
+                            creationBlock:creationBlock];
+
+  return @[ component ];
 }
 
 + (FPRClient *)sharedInstance {

FirebasePerformance/Tests/Unit/FPRClientTest.m

@@ -14,6 +14,8 @@
 
 #import <XCTest/XCTest.h>
 
+#import "FirebaseCore/Extension/FirebaseCoreInternal.h"
+
 #import "FirebasePerformance/Sources/Configurations/FPRConfigurations+Private.h"
 #import "FirebasePerformance/Sources/FPRClient+Private.h"
 #import "FirebasePerformance/Sources/FPRClient.h"
@@ -252,4 +254,43 @@ - (void)testValidateClearcutLogDirectoryCleanupIfNotExists {
   XCTAssertNoThrow([FPRClient cleanupClearcutCacheDirectory]);
 }
 
+#pragma mark - Component Registration Tests
+
+- (void)testRegistersAsLibrary {
+  // Configure a test FIRApp.
+  NSString *appName = @"__FIRAPP_DEFAULT";
+  [FIRApp configureWithName:appName options:[self fakeOptions]];
+  FIRApp *app = [FIRApp appNamed:appName];
+
+  // Attempt to fetch the component and verify it's a valid instance.
+  id<FIRPerformanceProvider> provider = FIR_COMPONENT(FIRPerformanceProvider, app.container);
+  XCTAssertNotNil(provider);
+
+  // Ensure that the instance that comes from the container is cached.
+  id<FIRPerformanceProvider> sameProvider = FIR_COMPONENT(FIRPerformanceProvider, app.container);
+  XCTAssertNotNil(sameProvider);
+  XCTAssertEqual(provider, sameProvider);
+}
+
+- (void)testFailsRegistrationForNonDefaultApp {
+  // Configure a test FIRApp.
+  NSString *appName = @"some_random_app";
+  [FIRApp configureWithName:appName options:[self fakeOptions]];
+  FIRApp *app = [FIRApp appNamed:appName];
+
+  // Attempt to fetch the component and verify it's a valid instance.
+  id<FIRPerformanceProvider> provider = FIR_COMPONENT(FIRPerformanceProvider, app.container);
+  XCTAssertNil(provider);
+}
+
+#pragma mark - Helpers
+
+- (FIROptions *)fakeOptions {
+  FIROptions *options = [[FIROptions alloc] initWithGoogleAppID:@"1:123:ios:123abc"
+                                                    GCMSenderID:@"correct_gcm_sender_id"];
+  options.APIKey = @"AIzaSy-ApiKeyWithValidFormat_0123456789";
+  options.projectID = @"project-id";
+  return options;
+}
+
 @end