Implement Firebase CoreDiagnostics

Example/Core/Tests/FIRAppTest.m

@@ -15,6 +15,8 @@
 #import "FIRTestCase.h"
 #import "FIRTestComponents.h"
 
+#import <FirebaseCoreDiagnosticsInterop/FIRCoreDiagnosticsData.h>
+
 #import <FirebaseCore/FIRAnalyticsConfiguration.h>
 #import <FirebaseCore/FIRAppInternal.h>
 #import <FirebaseCore/FIROptionsInternal.h>
@@ -620,7 +622,7 @@ - (void)testGlobalDataCollectionNoDiagnosticsSent {
   // Add an observer for the diagnostics notification. Currently no object is sent, but in the
   // future that could change so leave it as OCMOCK_ANY.
   [self.notificationCenter addMockObserver:self.observerMock
-                                      name:kFIRAppDiagnosticsNotification
+                                      name:kFIRDiagnosticsNotification
                                     object:OCMOCK_ANY];
 
   // Stub out reading from user defaults since stubbing out the BOOL has issues. If the data

Example/Core/Tests/FIRDiagnosticsDataTest.m

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <XCTest/XCTest.h>
+
+#import <FirebaseCore/FIRDiagnosticsData.h>
+
+@interface FIRDiagnosticsDataTest : XCTestCase
+
+@end
+
+@implementation FIRDiagnosticsDataTest
+
+/** Tests initialization. */
+- (void)testInit {
+  FIRDiagnosticsData *data = [[FIRDiagnosticsData alloc] init];
+  XCTAssertNotNil(data);
+}
+
+/** Tests that -diagnosticObjects returns a valid default dictionary. */
+- (void)testFIRCoreDiagnosticsData {
+  FIRDiagnosticsData *data = [[FIRDiagnosticsData alloc] init];
+  XCTAssertNotNil(data.diagnosticObjects);
+  XCTAssertNotNil(data.diagnosticObjects[kFIRCDIsDataCollectionDefaultEnabledKey]);
+  XCTAssertNotNil(data.diagnosticObjects[kFIRCDllAppsCountKey]);
+  XCTAssertNotNil(data.diagnosticObjects[kFIRCDFirebaseUserAgentKey]);
+}
+
+/** Tests that setting diagnosticObjects throws. */
+- (void)testSettingDiagnosticObjectsThrows {
+  FIRDiagnosticsData *data = [[FIRDiagnosticsData alloc] init];
+  XCTAssertThrows(data.diagnosticObjects = @{});
+}
+
+@end

Example/Podfile

@@ -10,6 +10,7 @@ use_frameworks!
 pod 'FirebaseAnalyticsInterop', :path => '../'
 pod 'FirebaseAuthInterop', :path => '../'
 pod 'FirebaseCore', :path => '../'
+pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
 pod 'GoogleUtilities', :path => '../'
 
 target 'Core_Example_iOS' do
@@ -127,6 +128,7 @@ target 'Auth_Sample' do
   platform :ios, '8.0'
   pod 'FirebaseAuth', :path => '../'
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FBSDKLoginKit'
   pod 'GoogleSignIn'
   pod 'FirebaseInstanceID', :path => '../'
@@ -146,6 +148,7 @@ target 'Core_Example_macOS' do
   platform :osx, '10.11'
 
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
 
   target 'Core_Tests_macOS' do
     inherit! :search_paths

Example/tvOSSample/Podfile

@@ -7,6 +7,7 @@ target 'tvOSSample' do
 
   # Pods for tvOSSample
   pod 'FirebaseCore', :path => '../../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../../'
   pod 'FirebaseDatabase', :path => '../../'
   pod 'FirebaseStorage', :path => '../../'

Firebase/Core/FIRApp.m

@@ -15,11 +15,15 @@
 #include <sys/utsname.h>
 
 #import "FIRApp.h"
+
+#import <FirebaseCoreDiagnosticsInterop/FIRCoreDiagnosticsData.h>
+
 #import "Private/FIRAnalyticsConfiguration.h"
 #import "Private/FIRAppInternal.h"
 #import "Private/FIRBundleUtil.h"
 #import "Private/FIRComponentContainerInternal.h"
 #import "Private/FIRConfigurationInternal.h"
+#import "Private/FIRDiagnosticsData.h"
 #import "Private/FIRLibrary.h"
 #import "Private/FIRLogger.h"
 #import "Private/FIROptionsInternal.h"
@@ -54,10 +58,7 @@
 NSString *const kFIRGlobalAppDataCollectionEnabledPlistKey =
     @"FirebaseDataCollectionDefaultEnabled";
 
-NSString *const kFIRAppDiagnosticsNotification = @"FIRAppDiagnosticsNotification";
-
 NSString *const kFIRAppDiagnosticsConfigurationTypeKey = @"ConfigType";
-NSString *const kFIRAppDiagnosticsErrorKey = @"Error";
 NSString *const kFIRAppDiagnosticsFIRAppKey = @"FIRApp";
 NSString *const kFIRAppDiagnosticsSDKNameKey = @"SDKName";
 NSString *const kFIRAppDiagnosticsSDKVersionKey = @"SDKVersion";
@@ -107,15 +108,22 @@ + (void)configure {
     // since the app isn't configured at all, so only rely on the Info.plist value.
     NSNumber *collectionEnabledPlistValue = [[self class] readDataCollectionSwitchFromPlist];
     if (collectionEnabledPlistValue == nil || [collectionEnabledPlistValue boolValue]) {
-      [[NSNotificationCenter defaultCenter]
-          postNotificationName:kFIRAppDiagnosticsNotification
-                        object:nil
-                      userInfo:@{
-                        kFIRAppDiagnosticsConfigurationTypeKey : @(FIRConfigTypeCore),
-                        kFIRAppDiagnosticsErrorKey : [FIRApp errorForMissingOptions]
-                      }];
+      if (NSClassFromString(@"FIRDiagnostics")) {
+        FIRDiagnosticsData *diagnosticsData = [[FIRDiagnosticsData alloc] init];
+        [diagnosticsData insertValueIfNotNil:collectionEnabledPlistValue
+                                      forKey:kFIRCDIsDataCollectionDefaultEnabledKey];
+        [diagnosticsData insertValueIfNotNil:[FIRApp firebaseUserAgent]
+                                      forKey:kFIRCDFirebaseUserAgentKey];
+        [diagnosticsData insertValueIfNotNil:@(FIRConfigTypeCore)
+                                      forKey:kFIRCDConfigurationTypeKey];
+        [[NSNotificationCenter defaultCenter]
+            postNotificationName:kFIRDiagnosticsNotification
+                          object:nil
+                        userInfo:@{
+                          kFIRDiagnosticsDataNotifKey : diagnosticsData,
+                        }];
+      }
     }
-
     [NSException raise:kFirebaseCoreErrorDomain
                 format:@"`[FIRApp configure];` (`FirebaseApp.configure()` in Swift) could not find "
                        @"a valid GoogleService-Info.plist in your project. Please download one "
@@ -293,26 +301,39 @@ - (instancetype)initInstanceWithName:(NSString *)name options:(FIROptions *)opti
 - (BOOL)configureCore {
   [self checkExpectedBundleID];
   if (![self isAppIDValid]) {
-    if (_options.usingOptionsFromDefaultPlist && [self isDataCollectionDefaultEnabled]) {
+    if (_options.usingOptionsFromDefaultPlist && [self isDataCollectionDefaultEnabled] &&
+        NSClassFromString(@"FIRDiagnostics")) {
+      FIRDiagnosticsData *diagnosticsData = [[FIRDiagnosticsData alloc] init];
+      [diagnosticsData insertValueIfNotNil:@([self isDataCollectionDefaultEnabled])
+                                    forKey:kFIRCDIsDataCollectionDefaultEnabledKey];
+      [diagnosticsData insertValueIfNotNil:[FIRApp firebaseUserAgent]
+                                    forKey:kFIRCDFirebaseUserAgentKey];
+      [diagnosticsData insertValueIfNotNil:@(FIRConfigTypeCore) forKey:kFIRCDConfigurationTypeKey];
       [[NSNotificationCenter defaultCenter]
-          postNotificationName:kFIRAppDiagnosticsNotification
+          postNotificationName:kFIRDiagnosticsNotification
                         object:nil
-                      userInfo:@{
-                        kFIRAppDiagnosticsConfigurationTypeKey : @(FIRConfigTypeCore),
-                        kFIRAppDiagnosticsErrorKey : [FIRApp errorForInvalidAppID],
-                      }];
+                      userInfo:@{kFIRDiagnosticsDataNotifKey : diagnosticsData}];
     }
     return NO;
   }
 
-  if ([self isDataCollectionDefaultEnabled]) {
+  if ([self isDataCollectionDefaultEnabled] && NSClassFromString(@"FIRDiagnostics")) {
+    FIRDiagnosticsData *diagnosticsData = [[FIRDiagnosticsData alloc] init];
+    [diagnosticsData insertValueIfNotNil:@([self isDataCollectionDefaultEnabled])
+                                  forKey:kFIRCDIsDataCollectionDefaultEnabledKey];
+    [diagnosticsData insertValueIfNotNil:[FIRApp firebaseUserAgent]
+                                  forKey:kFIRCDFirebaseUserAgentKey];
+    [diagnosticsData insertValueIfNotNil:@(FIRConfigTypeCore) forKey:kFIRCDConfigurationTypeKey];
+    [diagnosticsData insertValueIfNotNil:self.options.googleAppID forKey:kFIRCDGoogleAppIDKey];
+    [diagnosticsData insertValueIfNotNil:self.options.bundleID forKey:kFIRCDBundleIDKey];
+    [diagnosticsData insertValueIfNotNil:@(self.options.usingOptionsFromDefaultPlist)
+                                  forKey:kFIRCDUsingOptionsFromDefaultPlistKey];
+    [diagnosticsData insertValueIfNotNil:self.options.libraryVersionID
+                                  forKey:kFIRCDLibraryVersionIDKey];
     [[NSNotificationCenter defaultCenter]
-        postNotificationName:kFIRAppDiagnosticsNotification
+        postNotificationName:kFIRDiagnosticsNotification
                       object:nil
-                    userInfo:@{
-                      kFIRAppDiagnosticsConfigurationTypeKey : @(FIRConfigTypeCore),
-                      kFIRAppDiagnosticsFIRAppKey : self
-                    }];
+                    userInfo:@{kFIRDiagnosticsDataNotifKey : diagnosticsData}];
   }
 
 #if TARGET_OS_IOS
@@ -817,18 +838,27 @@ - (void)sendLogsWithServiceName:(NSString *)serviceName
     return;
   }
 
-  NSMutableDictionary *userInfo = [[NSMutableDictionary alloc] initWithDictionary:@{
-    kFIRAppDiagnosticsConfigurationTypeKey : @(FIRConfigTypeSDK),
-    kFIRAppDiagnosticsSDKNameKey : serviceName,
-    kFIRAppDiagnosticsSDKVersionKey : version,
-    kFIRAppDiagnosticsFIRAppKey : self
-  }];
-  if (error) {
-    userInfo[kFIRAppDiagnosticsErrorKey] = error;
+  if (NSClassFromString(@"FIRDiagnostics")) {
+    FIRDiagnosticsData *diagnosticsData = [[FIRDiagnosticsData alloc] init];
+    [diagnosticsData insertValueIfNotNil:@([self isDataCollectionDefaultEnabled])
+                                  forKey:kFIRCDIsDataCollectionDefaultEnabledKey];
+    [diagnosticsData insertValueIfNotNil:[FIRApp firebaseUserAgent]
+                                  forKey:kFIRCDFirebaseUserAgentKey];
+    [diagnosticsData insertValueIfNotNil:@(FIRConfigTypeSDK) forKey:kFIRCDConfigurationTypeKey];
+    [diagnosticsData insertValueIfNotNil:serviceName forKey:kFIRCDSdkNameKey];
+    [diagnosticsData insertValueIfNotNil:version forKey:kFIRCDSdkVersionKey];
+    [diagnosticsData insertValueIfNotNil:self.options.googleAppID forKey:kFIRCDGoogleAppIDKey];
+    [diagnosticsData insertValueIfNotNil:self.options.bundleID forKey:kFIRCDBundleIDKey];
+    [diagnosticsData insertValueIfNotNil:@(self.options.usingOptionsFromDefaultPlist)
+                                  forKey:kFIRCDUsingOptionsFromDefaultPlistKey];
+    [diagnosticsData insertValueIfNotNil:self.options.libraryVersionID
+                                  forKey:kFIRCDLibraryVersionIDKey];
+
+    [[NSNotificationCenter defaultCenter]
+        postNotificationName:kFIRDiagnosticsNotification
+                      object:nil
+                    userInfo:@{kFIRDiagnosticsDataNotifKey : diagnosticsData}];
   }
-  [[NSNotificationCenter defaultCenter] postNotificationName:kFIRAppDiagnosticsNotification
-                                                      object:nil
-                                                    userInfo:userInfo];
 }
 
 @end

Firebase/Core/FIRDiagnosticsData.m

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "Private/FIRDiagnosticsData.h"
+
+#import <FirebaseCore/FIRApp.h>
+
+#import "Private/FIRAppInternal.h"
+#import "Private/FIROptionsInternal.h"
+
+@implementation FIRDiagnosticsData {
+  /** Backing ivar for the diagnosticObjects property. */
+  NSMutableDictionary<NSString *, id> *_diagnosticObjects;
+}
+
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    _diagnosticObjects = [[NSMutableDictionary alloc] init];
+  }
+  return self;
+}
+
+- (void)insertValueIfNotNil:(nullable id)value forKey:(NSString *)key {
+  if (value && key) {
+    _diagnosticObjects[key] = value;
+  }
+}
+
+#pragma mark - FIRCoreDiagnosticsData
+
+- (NSDictionary<NSString *, id> *)diagnosticObjects {
+  if (!_diagnosticObjects[kFIRCDllAppsCountKey]) {
+    _diagnosticObjects[kFIRCDllAppsCountKey] = @([FIRApp allApps].count);
+  }
+  if (!_diagnosticObjects[kFIRCDIsDataCollectionDefaultEnabledKey]) {
+    _diagnosticObjects[kFIRCDIsDataCollectionDefaultEnabledKey] =
+        @([[FIRApp defaultApp] isDataCollectionDefaultEnabled]);
+  }
+  if (!_diagnosticObjects[kFIRCDFirebaseUserAgentKey]) {
+    _diagnosticObjects[kFIRCDFirebaseUserAgentKey] = [FIRApp firebaseUserAgent];
+  }
+  return _diagnosticObjects;
+}
+
+- (void)setDiagnosticObjects:(NSDictionary<NSString *, id> *)diagnosticObjects {
+  NSAssert(NO, @"Please use -insertValue:forKey:");
+}
+
+@end

Firebase/Core/Private/FIRAppInternal.h

@@ -72,11 +72,6 @@ extern NSString *const kFIRGlobalAppDataCollectionEnabledDefaultsKeyFormat;
  */
 extern NSString *const kFIRGlobalAppDataCollectionEnabledPlistKey;
 
-/**
- * A notification fired containing diagnostic information when SDK errors occur.
- */
-extern NSString *const kFIRAppDiagnosticsNotification;
-
 /** @var FIRAuthStateDidChangeInternalNotification
  @brief The name of the @c NSNotificationCenter notification which is posted when the auth state
  changes (e.g. a new token has been produced, a user logs in or out). The object parameter of

Firebase/Core/Private/FIRDiagnosticsData.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <FirebaseCoreDiagnosticsInterop/FIRCoreDiagnosticsData.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** Implements the FIRCoreDiagnosticsData protocol to log diagnostics data. */
+@interface FIRDiagnosticsData : NSObject <FIRCoreDiagnosticsData>
+
+/** Inserts values into the diagnosticObjects dictionary if the value isn't nil.
+ *
+ * @param value The value to insert if it's not nil.
+ * @param key The key to associate it with.
+ */
+- (void)insertValueIfNotNil:(nullable id)value forKey:(NSString *)key;
+
+@end
+
+NS_ASSUME_NONNULL_END

FirebaseCore.podspec

@@ -30,6 +30,8 @@ Firebase Core includes FIRApp and FIROptions which provide central configuration
   s.framework = 'Foundation'
   s.dependency 'GoogleUtilities/Environment', '~> 6.0'
   s.dependency 'GoogleUtilities/Logger', '~> 6.0'
+  s.dependency 'FirebaseCoreDiagnosticsInterop', '~> 0.1'
+
   s.pod_target_xcconfig = {
     'GCC_C_LANGUAGE_STANDARD' => 'c99',
     'GCC_PREPROCESSOR_DEFINITIONS' =>

FirebaseCoreDiagnosticsInterop.podspec

@@ -0,0 +1,29 @@
+Pod::Spec.new do |s|
+  s.name             = 'FirebaseCoreDiagnosticsInterop'
+  s.version          = '0.1.0'
+  s.summary          = 'Interfaces that allow other Firebase SDKs to use CoreDiagnostics functionality.'
+
+  s.description      = <<-DESC
+  Not for public use.
+
+  A set of protocols that other Firebase SDKs can use to interoperate with FirebaseCoreDiagnostics
+  in a safe manner.
+                       DESC
+
+  s.homepage         = 'https://firebase.google.com'
+  s.license          = { :type => 'Apache', :file => 'LICENSE' }
+  s.authors          = 'Google, Inc.'
+
+  # NOTE that these should not be used externally, this is for Firebase pods to depend on each
+  # other.
+  s.source           = {
+    :git => 'https://github.com/firebase/firebase-ios-sdk.git',
+    :tag => 'CoreDiagnostics-' + s.version.to_s
+  }
+  s.social_media_url = 'https://twitter.com/Firebase'
+  s.ios.deployment_target = '8.0'
+  s.osx.deployment_target = '10.11'
+  s.tvos.deployment_target = '10.0'
+  s.source_files = 'Interop/CoreDiagnostics/**/*.h'
+  s.public_header_files = 'Interop/CoreDiagnostics/Public/*.h'
+end