Implement Firebase CoreDiagnostics (#3129)

* Implement CoreDiagnostics interop

For use by FirebaseCore.

Please pay special attention to the changes in FIRApp, I've replaced passing FIRApp in the notification with a data object that will eventually replace the same information that FIRDiagnostics extracted.

* Add CoreDiagnosticsInterop to the Example Podfile

* Style and xcodeproj updates

* Update Podfiles that dep on FirebaseCore

So that they also have a dep on FirebaseCoreDiagnosticsInterop

* ran pod deintegrate to remove unintended xcodeproj changes

* Fix Podfile paths

* Add FCD to if_changed and travis.yml

* Fix building with Firestore

* Style

* Whitespace

* Fix a changed internal API

* Make pod paths consistent

* Restore connectivity_monitor_noop.cc style

* Remove logging prior to [FIRApp configure]

Also remove sendLogsWithServiceName:version:

* style

* Remove nil checks from diagnostics data

* Put back some deleted symbols

* Restore the sendLogsWithServiceName:version: method, but as a no-op

* Restore the original version of sendLogs...

* Allow an unused parameter

* Remove obsolete nsnotificationcenter related stuff

* Whoops, missed the header change.

* Final changes to support FIRCoreDiagnostics

These changes are necessary because FIRCore has a hard dep on FIRCoreDiagnostics (FIRCD) and FIRCoreDiagnosticsInterop.

Components can't be used because FIRCD would need to have a hard dep on FIRCore to get access to FIRLibrary, FIRComponent, FIRComponentContainer, and FIRComponentCreationBlock and this would create a dep cycle. So, an extern has been put into the interop lib and the variable is implemented in the connector class inside of FIRCore, but it's unset. FIRCD actually sets that variable in +load, allowing use of FIRCD.

FIRCD can also be removed as a dependency with no ill effect by end users setting the environment variable DISABLE_FIREBASE_DIAGNOSTICS=1

* Add nanopb and project generation infrastructure

* Convert FIRCoreDiagnostics to canonical nanopb, and move to OSS.

* Remove custom build steps for CoreDiagnostics

* Addressing review comments

* Update versions, tags, and port the relevant unit tests for FIRCD

* Version and platform fixes

* Fix podspec expected tags

* A hack to solve a chicken-and-egg problem with pod lib linting.

* Heartbeat implementation

* FIRDiagnosticsDateFileStorageTests

* Fix tests for non-iOS platforms

* Heartbeat tests

* Fix initialization.

* Cleanup Installation ID.

* Fix testProtoPopulation.

* Merge conflict fix

* Typo fix.

* Remove FIRCore dep from FIRCD unit tests and move symbols to interop

* Run ./scripts/style.sh

* Typo

* #ifdef comment

* File license header.

* Import FIRDiagnosticsDateFileStorage.h using relative path.

* FIRDiagnostics -> FIRCoreDiagnostics

* Docs syntax

* Docs

* Docs typo

* Add shared variables to the interop lib

I know this goes against the convention, but it's actually the only way to resolve this very unique problem.

* Fix comment

* Style

* Removed lib version passing.

* Remove env checking for conditional deps

* Style

* Address whitespace issues

* Add copyright notice

* Add new deps to Podfiles

* Fix trailing space

* Some changes to fix working in an extension.

* Fix type in Podfile

* GDT: begin/end background task only for iOS and TVOS applications.

* Fix typo

* Style

* Stop sharing kFIRService strings across pods

* Travis test

* Change all TARGET_OS_TVOS macros to TARGET_OS_TV

TARGET_OS_TVOS doesn't exist.

Also macro out a UIApplication reference.

* style

* Update all Podfiles with deps on FIRCore

* Fix trailing whitespace

* Update Firestore cmake

* Fix FIAM build break (#3254)

* Additional cmake changes

* Fix linker issue with deprecated CoreDiagnostics (#3257)

* Adding more deps to cmake

* Fix linker error (#3266)

* Rerun only IAM tests

* whitespace

* No xcpretty or frameworks run

* Fix typo

* Revert "No xcpretty or frameworks run"

This reverts commit afc1abb.

* Revert "whitespace"

This reverts commit fd06955.

* Revert "Rerun only IAM tests"

This reverts commit 98ce076.

* Run travis on this branch

* Add support for expanding PODS_TARGET_SRCROOT in CMake (#3267)

* Fix a few things that should have been splatted but weren't

* Define PODS_TARGET_SRCROOT in CMake for compatibility with CocoaPods

* Compile pods we depend upon with looser settings

* Rename the nanopb dependency to match what CMake actually has

* Make #include <nanopb/pb.h> work

Remove the old way of #include <pb.h> once we change the Firestore
nanopb generator to match.

* Fix warnings that fail the build

* Remove typed enum and fix a comment.

* Fix an import

* Change a line so it's not altered by Copybara

* More changes to stop copybara from altering the wrong sources

* Remove trailing whitespace

* Fix copybara modifying python.

* Add additional field in firebasecore.proto (#3273)

* Remove the dependency on interop to populate a shared variable.

* style

* Create travis jobs for FirebaseCoreDiagnostics (#3245)

* Create travis jobs for FirebaseCoreDiagnostics

And update the pod lib lints for GDT.

Remove the mph-master branch before merging to master.

* Add support for FIRCD to if_changed.sh

* Adjust tests

* Unavailable init methods should not be nullable (#3276)

* Allow firestore api to work with Codable objects + ExplicitNull + Integration tests (#3261)

* Convinience api for codables

* Integration Tests

* ExplicitNull implementation

* Update to CocoaPods 1.7.3 (#3280)

* Import GULLoggerLevel.h via public framework header (#3277)

* Put the need to include Firestore/Source/Public in the podspec (#3288)

This removes the need to munge the pods project after the fact and makes
it so that customers can click through to our headers too.

* Ensure Storage initializer doesn't get called (#3294)

* FIROptions.appGroupID introduced (#3293)

* Use a consistent set of dependencies on all platforms (#3289)

* Use a consistent set of dependencies on all platforms

* pod install for uniform dependencies

* Store the coerced base value in the BaseMutation (#3292)

* In card message: set the text color on the body text view (#3286)

* In card message: set the text color on the body text view

* Fix bug where card messages in test app were showing up with two of the same buttons

* Revert change to text color

* [docs] add missing semicolon (#3305)

Add missing semicolon to code example

* Add explicit Foundation import. (#3309)

This is causing issues when building an XCFramework.

* Pass the correct compiler flag for CoreDiagnostics. (#3312)

* Pass the correct compiler flag for CoreDiagnostics.

When CoreDiagnostics is open sourced, we'll need to ensure that the
right compiler flag is passed. This doesn't add support for Carthage yet
but allows the frameworkbuilder to pass the flag for carthage as well.
An update to the zipbuilder to allow for carthage will follow shortly.

* Remove accidental change.

* Fix and rewrite sync_project.rb (#3296)

* Fix and rewrite sync_project.rb

Ever since we added multiple platforms, removing a file has been broken.
This fixes that issue.

Also, rewrite target synchronization to make more sense. Essentially now
there's one diff between the filesystem and the groups and then an
explicit diff is done between project files and target contents.

* Run sync_project.rb on post-install

* pod lib linting should output something every minute while running

* DEBUG: This commit should be reverted

* DEBUG: This commit should be reverted

* DEBUG: This commit should be reverted

* Remove mph-master from travis

* Fix constant name conflic between old and new diagnostics (#3329)

* Rename kFIRDiagnosticsHeartbeatDateFileName -> kFIRCoreDiagnosticsHeartbeatDateFileName to avoid conflicts with FIRDiagnostics.

* Travis: temporary add `mph-master` to run tests.

* Rempve mph-master again

* Fix imports in FIRCDConnector

* Fix another import

* Fix yet another import

* Attempt to read crashing test logs from disk

* Implement printing of failed/crashed test logs.

* Print only crashed tests, rmdir between runs

* Revert reading crashing log changes

* Write CHANGELOG for all new FIRCD associated libraries

* Change all GUL deps to >= 6.2

* Revert ZipBuilder changes and do some last bits of cleanup

* Remove an assertion and populate an error instead

Author: mikehaney24

CMakeLists.txt

@@ -230,8 +230,35 @@ podspec_framework(
   SPECS Logger
 )
 
+podspec_framework(${FIREBASE_SOURCE_DIR}/GoogleDataTransport.podspec)
+
+podspec_framework(${FIREBASE_SOURCE_DIR}/GoogleDataTransportCCTSupport.podspec)
+
 podspec_framework(${FIREBASE_SOURCE_DIR}/FirebaseCore.podspec)
 
+podspec_framework(${FIREBASE_SOURCE_DIR}/FirebaseCoreDiagnostics.podspec)
+
+podspec_framework(
+  ${FIREBASE_SOURCE_DIR}/FirebaseCoreDiagnosticsInterop.podspec
+)
+
+if(APPLE)
+  # FirebaseCoreDiagnosticsInterop has no source files but CMake can't build
+  # frameworks that don't have sources. Generate an inconsequential source
+  # file so that the library can be linked.
+  file(
+    WRITE ${CMAKE_CURRENT_BINARY_DIR}/FirebaseCoreDiagnosticsInteropDummy.c
+    "// generated file for header-only CMake support.
+    __attribute__((unused))
+    static void FirebaseCoreDiagnosticsInteropFakeSymbol() {}
+    "
+  )
+  target_sources(
+    FirebaseCoreDiagnosticsInterop
+    PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/FirebaseCoreDiagnosticsInteropDummy.c
+  )
+endif()
+
 podspec_framework(${FIREBASE_SOURCE_DIR}/FirebaseAuthInterop.podspec)
 
 if(APPLE)

CocoapodsIntegrationTest/TestEnvironments/Cocoapods1_6_1_frameworks/Podfile

@@ -5,8 +5,9 @@ target 'CocoapodsIntegrationTest' do
   use_frameworks!
 
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnostics', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../'
-  pod 'FirebaseCore', :path => '../'
   pod 'FirebaseDatabase', :path => '../'
   pod 'FirebaseDynamicLinks', :path => '../'
   pod 'FirebaseFirestore', :path => '../'
@@ -15,5 +16,7 @@ target 'CocoapodsIntegrationTest' do
   pod 'FirebaseInstanceID', :path => '../'
   pod 'FirebaseMessaging', :path => '../'
   pod 'FirebaseStorage', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
+  pod 'GoogleDataTransportCCTSupport', :path => '../'
   pod 'GoogleUtilities', :path => '../'
 end

CocoapodsIntegrationTest/TestEnvironments/Cocoapods1_6_1_staticLibs/Podfile

@@ -3,8 +3,9 @@ platform :ios, '9.0'
 
 target 'CocoapodsIntegrationTest' do
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnostics', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../'
-  pod 'FirebaseCore', :path => '../'
   pod 'FirebaseDatabase', :path => '../'
   pod 'FirebaseDynamicLinks', :path => '../'
   pod 'FirebaseFirestore', :path => '../'
@@ -13,5 +14,7 @@ target 'CocoapodsIntegrationTest' do
   pod 'FirebaseInstanceID', :path => '../'
   pod 'FirebaseMessaging', :path => '../'
   pod 'FirebaseStorage', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
+  pod 'GoogleDataTransportCCTSupport', :path => '../'
   pod 'GoogleUtilities', :path => '../'
 end

CocoapodsIntegrationTest/TestEnvironments/Cocoapods1_7_0_frameworks/Podfile

@@ -5,8 +5,9 @@ target 'CocoapodsIntegrationTest' do
   use_frameworks!
 
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnostics', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../'
-  pod 'FirebaseCore', :path => '../'
   pod 'FirebaseDatabase', :path => '../'
   pod 'FirebaseDynamicLinks', :path => '../'
   pod 'FirebaseFirestore', :path => '../'
@@ -15,5 +16,7 @@ target 'CocoapodsIntegrationTest' do
   pod 'FirebaseInstanceID', :path => '../'
   pod 'FirebaseMessaging', :path => '../'
   pod 'FirebaseStorage', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
+  pod 'GoogleDataTransportCCTSupport', :path => '../'
   pod 'GoogleUtilities', :path => '../'
 end

CocoapodsIntegrationTest/TestEnvironments/Cocoapods1_7_0_multiprojects_frameworks/Podfile

@@ -6,8 +6,9 @@ target 'CocoapodsIntegrationTest' do
   use_frameworks!
 
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnostics', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../'
-  pod 'FirebaseCore', :path => '../'
   pod 'FirebaseDatabase', :path => '../'
   pod 'FirebaseDynamicLinks', :path => '../'
   pod 'FirebaseFirestore', :path => '../'
@@ -16,6 +17,8 @@ target 'CocoapodsIntegrationTest' do
   pod 'FirebaseInstanceID', :path => '../'
   pod 'FirebaseMessaging', :path => '../'
   pod 'FirebaseStorage', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
+  pod 'GoogleDataTransportCCTSupport', :path => '../'
   pod 'GoogleUtilities', :path => '../'
 end
 

CocoapodsIntegrationTest/TestEnvironments/Cocoapods1_7_0_multiprojects_staticLibs/Podfile

@@ -3,8 +3,9 @@ platform :ios, '9.0'
 
 target 'CocoapodsIntegrationTest' do
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnostics', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../'
-  pod 'FirebaseCore', :path => '../'
   pod 'FirebaseDatabase', :path => '../'
   pod 'FirebaseDynamicLinks', :path => '../'
   pod 'FirebaseFirestore', :path => '../'
@@ -13,6 +14,8 @@ target 'CocoapodsIntegrationTest' do
   pod 'FirebaseInstanceID', :path => '../'
   pod 'FirebaseMessaging', :path => '../'
   pod 'FirebaseStorage', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
+  pod 'GoogleDataTransportCCTSupport', :path => '../'
   pod 'GoogleUtilities', :path => '../'
 end
 

CocoapodsIntegrationTest/TestEnvironments/Cocoapods1_7_0_staticLibs/Podfile

@@ -3,8 +3,9 @@ platform :ios, '9.0'
 
 target 'CocoapodsIntegrationTest' do
   pod 'FirebaseCore', :path => '../'
+  pod 'FirebaseCoreDiagnostics', :path => '../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../'
   pod 'FirebaseAuth', :path => '../'
-  pod 'FirebaseCore', :path => '../'
   pod 'FirebaseDatabase', :path => '../'
   pod 'FirebaseDynamicLinks', :path => '../'
   pod 'FirebaseFirestore', :path => '../'
@@ -13,5 +14,7 @@ target 'CocoapodsIntegrationTest' do
   pod 'FirebaseInstanceID', :path => '../'
   pod 'FirebaseMessaging', :path => '../'
   pod 'FirebaseStorage', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
+  pod 'GoogleDataTransport', :path => '../'
   pod 'GoogleUtilities', :path => '../'
 end

Example/Auth/AuthSample/Podfile

@@ -9,9 +9,12 @@ use_frameworks!
 target 'AuthSample' do
   platform :ios, '8.0'
   pod 'FirebaseCore', :path => '../../../'
+  pod 'FirebaseCoreDiagnostics', :path => '../../../'
+  pod 'FirebaseCoreDiagnosticsInterop', :path => '../../../'
+  pod 'GoogleDataTransport', :path => '../../../'
+  pod 'GoogleDataTransportCCTSupport', :path => '../../../'
   pod 'GoogleUtilities', :path => '../../../'
   pod 'FirebaseAuth', :path => '../../../', :testspecs => ['unit']
-  pod 'FirebaseCore', :path => '../../../'
   pod 'FirebaseInstanceID', :path => '../../..'
   pod 'FBSDKLoginKit'
   pod 'GoogleSignIn'

Example/Core/Tests/FIRAppTest.m

@@ -15,6 +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/FIROptionsInternal.h>
@@ -262,7 +265,7 @@ - (void)testDeleteApp {
 - (void)testErrorForSubspecConfigurationFailure {
   NSError *error = [FIRApp errorForSubspecConfigurationFailureWithDomain:kFirebaseCoreErrorDomain
                                                                errorCode:-38
-                                                                 service:kFIRServiceAuth
+                                                                 service:@"Auth"
                                                                   reason:@"some reason"];
   XCTAssertNotNil(error);
   XCTAssert([error.domain isEqualToString:kFirebaseCoreErrorDomain]);
@@ -632,9 +635,6 @@ - (void)testGlobalDataCollectionNoDiagnosticsSent {
   // Ensure configure doesn't fire a notification.
   [FIRApp configure];
 
-  NSError *error = [NSError errorWithDomain:@"com.firebase" code:42 userInfo:nil];
-  [app sendLogsWithServiceName:@"Service" version:@"Version" error:error];
-
   // The observer mock is strict and will raise an exception when an unexpected notification is
   // received.
   OCMVerifyAll(self.observerMock);

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