feat(analytics, config): expose automatic screenview reporting toggle (#5948)

* Adds automatic screen reporting in firebase.json

Automatic screenview tracking can now be disabled/enabled via firebase.json through "google_analytics_automatic_screen_reporting_enabled" property.

Co-authored-by: Mike Hardy <github@mikehardy.net>

Author: se09deluca

.spellcheck.dict.txt

@@ -138,6 +138,7 @@ RNFirebase
 SafetyNet
 Salakar
 scalable
+screenview
 scrollable
 SDK
 SDK.
@@ -163,6 +164,7 @@ timezones
 triaging
 TypeDoc
 UI
+UIViewController
 uid
 uncomment
 unhandled

docs/analytics/usage/index.md

@@ -181,3 +181,17 @@ import { firebase } from '@react-native-firebase/analytics';
 // ...
 await firebase.analytics().setAnalyticsCollectionEnabled(true);
 ```
+
+## Disable screenview tracking
+
+Analytics automatically tracks some information about screens in your application, such as the class name of the UIViewController or Activity that is currently in focus.
+Automatic screenview reporting can be turned off/on through `google_analytics_automatic_screen_reporting_enabled` property of `firebase.json` file.
+
+```json
+// <project-root>/firebase.json
+{
+  "react-native": {
+    "google_analytics_automatic_screen_reporting_enabled": false
+  }
+}
+```

packages/analytics/android/build.gradle

@@ -70,6 +70,7 @@ String collectionDeactivated = 'false'
 String adidEnabled = 'true'
 String ssaidEnabled = 'true'
 String personalizationEnabled = 'true'
+String automaticScreenReportingEnabled = 'true'
 
 // If nothing is defined, data collection defaults to true
 String dataCollectionEnabled = 'true'
@@ -102,6 +103,9 @@ if (rootProject.ext && rootProject.ext.firebaseJson) {
   if (rnfbConfig.isFlagEnabled('analytics_default_allow_ad_personalization_signals', true) == false) {
     personalizationEnabled = 'false'
   }
+  if (rnfbConfig.isFlagEnabled('google_analytics_automatic_screen_reporting_enabled', true) == false) {
+    automaticScreenReportingEnabled = 'false'
+  }
 }
 
 android {
@@ -112,7 +116,8 @@ android {
       firebaseJsonCollectionDeactivated: collectionDeactivated,
       firebaseJsonAdidEnabled: adidEnabled,
       firebaseJsonSsaidEnabled: ssaidEnabled,
-      firebaseJsonPersonalizationEnabled: personalizationEnabled
+      firebaseJsonPersonalizationEnabled: personalizationEnabled,
+      firebaseJsonAutomaticScreenReportingEnabled: automaticScreenReportingEnabled
     ]
   }
   lintOptions {

packages/analytics/android/src/main/AndroidManifest.xml

@@ -12,5 +12,6 @@
     <meta-data android:name="google_analytics_adid_collection_enabled" android:value="${firebaseJsonAdidEnabled}" />
     <meta-data android:name="google_analytics_ssaid_collection_enabled" android:value="${firebaseJsonSsaidEnabled}" />
     <meta-data android:name="google_analytics_default_allow_ad_personalization_signals" android:value="${firebaseJsonPersonalizationEnabled}" />
+    <meta-data android:name="google_analytics_automatic_screen_reporting_enabled" android:value="${firebaseJsonAutomaticScreenReportingEnabled}" />
   </application>
 </manifest>

packages/app/firebase-schema.json

@@ -25,6 +25,10 @@
           "description": "If you wish to disable collection of SSAID (Settings.Secure.ANDROID_ID) in your Android app,.\n This cannot be altered at runtime once set in the config.",
           "type": "boolean"
         },
+        "google_analytics_automatic_screen_reporting_enabled": {
+          "description": "If you wish to disable automatic screen reporting in your app.\n This cannot be altered at runtime once set in the config.",
+          "type": "boolean"
+        },
         "analytics_default_allow_ad_personalization_signals": {
           "description": "Configure whether a user's Analytics data may be used for personalized advertising in other products.\n If set, may be overridden at runtime by calling setUserProperty on the key 'allow_personalized_ads'",
           "type": "boolean"
@@ -54,7 +58,7 @@
           "type": "boolean"
         },
         "crashlytics_javascript_exception_handler_chaining_enabled": {
-          "description": "By default React Native Firebase Crashlytics will preserve existing global javascript-level uhandled exception handlers by reporting to Crashlytics then passing the exception on for further handling. This could lead to duplicate reports, for example a fatal javascript-level report and a fatal native level report for the same crash. Set to false to terminate error handling after logging the javascript-level crash.",
+          "description": "By default React Native Firebase Crashlytics will preserve existing global javascript-level unhandled exception handlers by reporting to Crashlytics then passing the exception on for further handling. This could lead to duplicate reports, for example a fatal javascript-level report and a fatal native level report for the same crash. Set to false to terminate error handling after logging the javascript-level crash.",
           "type": "boolean"
         },
         "crashlytics_ndk_enabled": {

packages/app/ios_config.sh

@@ -126,6 +126,14 @@ if [[ ${_SEARCH_RESULT} ]]; then
     _PLIST_ENTRY_VALUES+=("$(jsonBoolToYesNo "$_ANALYTICS_PERSONALIZATION")")
   fi
 
+  # config.google_analytics_automatic_screen_reporting_enabled
+  _ANALYTICS_AUTO_SCREEN_REPORTING=$(getFirebaseJsonKeyValue "$_JSON_OUTPUT_RAW" "google_analytics_automatic_screen_reporting_enabled")
+  if [[ $_ANALYTICS_AUTO_SCREEN_REPORTING ]]; then
+    _PLIST_ENTRY_KEYS+=("FirebaseAutomaticScreenReportingEnabled")
+    _PLIST_ENTRY_TYPES+=("bool")
+    _PLIST_ENTRY_VALUES+=("$(jsonBoolToYesNo "$_ANALYTICS_AUTO_SCREEN_REPORTING")")
+  fi
+
   # config.perf_auto_collection_enabled
   _PERF_AUTO_COLLECTION=$(getFirebaseJsonKeyValue "$_JSON_OUTPUT_RAW" "perf_auto_collection_enabled")
   if [[ $_PERF_AUTO_COLLECTION ]]; then

tests/firebase.json

@@ -25,6 +25,7 @@
     "analytics_idfv_collection_enabled": false,
     "google_analytics_adid_collection_enabled": true,
     "google_analytics_ssaid_collection_enabled": true,
+    "google_analytics_automatic_screen_reporting_enabled": true,
     "analytics_default_allow_ad_personalization_signals": true,
 
     "perf_auto_collection_enabled": false,