FirebaseApp: send Core Diagnostics data on appDidBecomeActive (#3437)

* FIRApp: send CoreDiagnostics data on appDidBecomeActive.

* ./scripts/style.sh

* Renaming.

* FIRAppTest: stub  FIRCoreDiagnosticsConnector to avoid invoking FIRCoreDiagnostics methods in the tests.

* Run ./scripts/style.sh

* Rename to `logCoreTelemetry`

Author: maksymmalyhin

Example/Core/Tests/FIRAppTest.m

@@ -15,11 +15,9 @@
 #import "FIRTestCase.h"
 #import "FIRTestComponents.h"
 
-#import <FirebaseCoreDiagnosticsInterop/FIRCoreDiagnosticsData.h>
-#import <FirebaseCoreDiagnosticsInterop/FIRCoreDiagnosticsInterop.h>
-
 #import <FirebaseCore/FIRAnalyticsConfiguration.h>
 #import <FirebaseCore/FIRAppInternal.h>
+#import <FirebaseCore/FIRCoreDiagnosticsConnector.h>
 #import <FirebaseCore/FIROptionsInternal.h>
 
 NSString *const kFIRTestAppName1 = @"test_app_name_1";
@@ -53,6 +51,7 @@ @interface FIRAppTest : FIRTestCase
 
 @property(nonatomic) id appClassMock;
 @property(nonatomic) id observerMock;
+@property(nonatomic) id mockCoreDiagnosticsConnector;
 @property(nonatomic) NSNotificationCenter *notificationCenter;
 
 @end
@@ -65,6 +64,11 @@ - (void)setUp {
   [FIRApp resetApps];
   _appClassMock = OCMClassMock([FIRApp class]);
   _observerMock = OCMObserverMock();
+  _mockCoreDiagnosticsConnector = OCMClassMock([FIRCoreDiagnosticsConnector class]);
+
+  OCMStub(ClassMethod([self.mockCoreDiagnosticsConnector logCoreTelemetryWithOptions:[OCMArg any]]))
+      .andDo(^(NSInvocation *invocation){
+      });
 
   // TODO: Remove all usages of defaultCenter in Core, then we can instantiate an instance here to
   //       inject instead of using defaultCenter.
@@ -76,6 +80,7 @@ - (void)tearDown {
   [_notificationCenter removeObserver:_observerMock];
   _observerMock = nil;
   _notificationCenter = nil;
+  _mockCoreDiagnosticsConnector = nil;
 
   [super tearDown];
 }
@@ -730,6 +735,24 @@ - (void)testRegisteringNonConformingLibrary {
   XCTAssertFalse([[FIRApp firebaseUserAgent] containsString:@"InvalidLibrary`/1.0.0"]);
 }
 
+#pragma mark - Core Diagnostics
+
+- (void)testCoreDiagnosticsLoggedWhenFIRAppIsConfigured {
+  [self expectCoreDiagnosticsDataLogWithOptions:[self appOptions]];
+  [self createConfiguredAppWithName:NSStringFromSelector(_cmd)];
+  OCMVerifyAll(self.mockCoreDiagnosticsConnector);
+}
+
+- (void)testCoreDiagnosticsLoggedWhenAppDidBecomeActive {
+  FIRApp *app = [self createConfiguredAppWithName:NSStringFromSelector(_cmd)];
+  [self expectCoreDiagnosticsDataLogWithOptions:app.options];
+
+  [self.notificationCenter postNotificationName:[self appDidBecomeActiveNotificationName]
+                                         object:nil];
+
+  OCMVerifyAll(self.mockCoreDiagnosticsConnector);
+}
+
 #pragma mark - private
 
 - (void)expectNotificationForObserver:(id)observer
@@ -749,4 +772,39 @@ - (void)expectNotificationForObserver:(id)observer
   };
 }
 
+- (void)expectCoreDiagnosticsDataLogWithOptions:(nullable FIROptions *)expectedOptions {
+  [self.mockCoreDiagnosticsConnector stopMocking];
+  self.mockCoreDiagnosticsConnector = nil;
+  self.mockCoreDiagnosticsConnector = OCMClassMock([FIRCoreDiagnosticsConnector class]);
+
+  OCMExpect(ClassMethod([self.mockCoreDiagnosticsConnector
+      logCoreTelemetryWithOptions:[OCMArg checkWithBlock:^BOOL(FIROptions *options) {
+        if (!expectedOptions) {
+          return YES;
+        }
+        return [options.googleAppID isEqualToString:expectedOptions.googleAppID] &&
+               [options.GCMSenderID isEqualToString:expectedOptions.GCMSenderID];
+      }]]));
+}
+
+- (NSNotificationName)appDidBecomeActiveNotificationName {
+#if TARGET_OS_IOS || TARGET_OS_TV
+  return UIApplicationDidBecomeActiveNotification;
+#endif
+
+#if TARGET_OS_OSX
+  return NSApplicationDidBecomeActiveNotification;
+#endif
+}
+
+- (FIRApp *)createConfiguredAppWithName:(NSString *)name {
+  FIROptions *options = [self appOptions];
+  [FIRApp configureWithName:name options:options];
+  return [FIRApp appNamed:name];
+}
+
+- (FIROptions *)appOptions {
+  return [[FIROptions alloc] initWithGoogleAppID:kGoogleAppID GCMSenderID:kGCMSenderID];
+}
+
 @end

Firebase/Core/FIRApp.m

@@ -14,9 +14,15 @@
 
 #include <sys/utsname.h>
 
-#import "FIRApp.h"
+#if __has_include(<UIKit/UIKit.h>)
+#import <UIKit/UIKit.h>
+#endif
+
+#if __has_include(<AppKit/AppKit.h>)
+#import <AppKit/AppKit.h>
+#endif
 
-#import <FirebaseCoreDiagnosticsInterop/FIRCoreDiagnosticsData.h>
+#import "FIRApp.h"
 
 #import "Private/FIRAnalyticsConfiguration.h"
 #import "Private/FIRAppInternal.h"
@@ -283,15 +289,17 @@ - (instancetype)initInstanceWithName:(NSString *)name options:(FIROptions *)opti
   return self;
 }
 
+- (void)dealloc {
+  [[NSNotificationCenter defaultCenter] removeObserver:self];
+}
+
 - (BOOL)configureCore {
   [self checkExpectedBundleID];
   if (![self isAppIDValid]) {
     return NO;
   }
 
-  if ([self isDataCollectionDefaultEnabled]) {
-    [FIRCoreDiagnosticsConnector logConfigureCoreWithOptions:_options];
-  }
+  [self logCoreTelemetryIfEnabled];
 
 #if TARGET_OS_IOS
   // Initialize the Analytics once there is a valid options under default app. Analytics should
@@ -316,6 +324,8 @@ - (BOOL)configureCore {
   }
 #endif
 
+  [self subscribeForAppDidBecomeActiveNotifications];
+
   return YES;
 }
 
@@ -796,4 +806,31 @@ - (void)sendLogsWithServiceName:(NSString *)serviceName
 }
 #pragma clang diagnostic pop
 
+#pragma mark - App Life Cycle
+
+- (void)subscribeForAppDidBecomeActiveNotifications {
+#if TARGET_OS_IOS || TARGET_OS_TV
+  NSNotificationName notificationName = UIApplicationDidBecomeActiveNotification;
+#endif
+
+#if TARGET_OS_OSX
+  NSNotificationName notificationName = NSApplicationDidBecomeActiveNotification;
+#endif
+
+  [[NSNotificationCenter defaultCenter] addObserver:self
+                                           selector:@selector(appDidBecomeActive:)
+                                               name:notificationName
+                                             object:nil];
+}
+
+- (void)appDidBecomeActive:(NSNotification *)notification {
+  [self logCoreTelemetryIfEnabled];
+}
+
+- (void)logCoreTelemetryIfEnabled {
+  if ([self isDataCollectionDefaultEnabled]) {
+    [FIRCoreDiagnosticsConnector logCoreTelemetryWithOptions:_options];
+  }
+}
+
 @end

Firebase/Core/FIRCoreDiagnosticsConnector.m

@@ -43,7 +43,7 @@ + (void)initialize {
   }
 }
 
-+ (void)logConfigureCoreWithOptions:(FIROptions *)options {
++ (void)logCoreTelemetryWithOptions:(FIROptions *)options {
   if (FIRCoreDiagnosticsImplementation) {
     FIRDiagnosticsData *diagnosticsData = [[FIRDiagnosticsData alloc] init];
     [diagnosticsData insertValue:@(YES) forKey:kFIRCDIsDataCollectionDefaultEnabledKey];

Firebase/Core/Private/FIRCoreDiagnosticsConnector.h

@@ -24,11 +24,11 @@ NS_ASSUME_NONNULL_BEGIN
 /** Connects FIRCore with the CoreDiagnostics library. */
 @interface FIRCoreDiagnosticsConnector : NSObject
 
-/** Logs data related to a -configureCore call.
+/** Logs FirebaseCore  related data.
  *
  * @param options The options object containing data to log.
  */
-+ (void)logConfigureCoreWithOptions:(FIROptions *)options;
++ (void)logCoreTelemetryWithOptions:(FIROptions *)options;
 
 @end