Opt-Out / Opt-In for Crashlytics - GDPR #1249

Author: EddyVerbruggen

demo/app/main-view-model.ts

@@ -421,6 +421,7 @@ export class HelloWorldModel extends Observable {
 
   public doInit(): void {
     firebase.init({
+      crashlyticsCollectionEnabled: true,
       // storageBucket: 'gs://n-plugin-test.appspot.com',
       persist: true, // optional, default false
       // analyticsCollectionEnabled: false, // default true

demo/app_resources/Android/src/main/AndroidManifest.xml

@@ -29,6 +29,10 @@
         android:name="com.google.android.gms.ads.APPLICATION_ID"
         android:value="ca-app-pub-9517346003011652~4795634921"/>
 
+    <meta-data
+        android:name="firebase_crashlytics_collection_enabled"
+        android:value="false" />
+
     <meta-data
         android:name="com.facebook.sdk.ApplicationId"
         android:value="@string/facebook_app_id"/>

demo/app_resources/iOS/Info.plist

@@ -104,5 +104,9 @@
   <string>Required for Firebase Invites</string>
   <key>GADApplicationIdentifier</key>
   <string>ca-app-pub-9517346003011652~2508636525</string>
+
+  <!-- we enable this during init, but can also do it through crashlytics.setCrashlyticsCollectionEnabled(true) after requesting the user to opt-in -->
+  <key>firebase_crashlytics_collection_enabled</key>
+  <string>false</string>
 </dict>
 </plist>

publish/scripts/installer.js

@@ -768,6 +768,7 @@ dependencies {
 
     // Cloud Messaging (FCM)
     ` + (isSelected(result.messaging) || externalPushClientOnly ? `` : `//`) + ` implementation "com.google.firebase:firebase-messaging:17.6.0"
+    // ` + (isSelected(result.messaging) || externalPushClientOnly ? `` : `//`) + ` implementation "me.leolin:ShortcutBadger:1.1.22@aar"
 
     // In-App Messaging
     ` + (isSelected(result.in_app_messaging) ? `` : `//`) + ` implementation "com.google.firebase:firebase-inappmessaging-display:17.1.1"

src/analytics/analytics.android.ts

@@ -93,7 +93,7 @@ export function logComplexEvent(options: LogComplexEventOptions): Promise<void>
       }
 
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-          appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+          appModule.android.context || com.tns.NativeScriptApplication.getInstance()
       ).logEvent(options.key, bundle);
 
       resolve();
@@ -112,7 +112,8 @@ export function setUserId(arg): Promise<void> {
         return;
       }
 
-      com.google.firebase.analytics.FirebaseAnalytics.getInstance(appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()).setUserId(arg.userId);
+      com.google.firebase.analytics.FirebaseAnalytics.getInstance(
+          appModule.android.context || com.tns.NativeScriptApplication.getInstance()).setUserId(arg.userId);
 
       resolve();
     } catch (ex) {
@@ -135,7 +136,7 @@ export function setUserProperty(options: SetUserPropertyOptions): Promise<void>
       }
 
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-          appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+          appModule.android.context || com.tns.NativeScriptApplication.getInstance()
       ).setUserProperty(options.key, options.value);
 
       resolve();
@@ -155,7 +156,7 @@ export function setScreenName(options: SetScreenNameOptions): Promise<void> {
       }
 
       com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-          appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+          appModule.android.context || com.tns.NativeScriptApplication.getInstance()
       ).setCurrentScreen(appModule.android.foregroundActivity, options.screenName, null);
 
       resolve();
@@ -168,12 +169,12 @@ export function setScreenName(options: SetScreenNameOptions): Promise<void> {
 
 export function setAnalyticsCollectionEnabled(enabled: boolean): void {
   com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-      appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+      appModule.android.context || com.tns.NativeScriptApplication.getInstance()
   ).setAnalyticsCollectionEnabled(enabled);
 }
 
 export function setSessionTimeoutDuration(seconds: number): void {
   com.google.firebase.analytics.FirebaseAnalytics.getInstance(
-      appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance()
+      appModule.android.context || com.tns.NativeScriptApplication.getInstance()
   ).setSessionTimeoutDuration(seconds * 1000); // Android expects ms
 }

src/crashlytics/crashlytics.android.ts

@@ -1,3 +1,5 @@
+import * as appModule from "tns-core-modules/application";
+
 declare const com: any;
 
 export function sendCrashLog(exception: any /* java.lang.Exception */): void {
@@ -58,6 +60,14 @@ export function crash(): void {
   }
 }
 
+export function setCrashlyticsCollectionEnabled(enabled: boolean): void {
+  if (isCrashlyticsAvailable()) {
+    io.fabric.sdk.android.Fabric.with(
+        appModule.android.currentContext || com.tns.NativeScriptApplication.getInstance(),
+        [new com.crashlytics.android.Crashlytics()]);
+  }
+}
+
 function isCrashlyticsAvailable(): boolean {
   if (typeof (com.crashlytics) === "undefined" || typeof (com.crashlytics.android.Crashlytics) === "undefined") {
     console.log("Add 'crashlytics: true' to firebase.nativescript.json and remove the platforms folder");

src/crashlytics/crashlytics.d.ts

@@ -18,4 +18,6 @@ export declare function setDouble(key: string, value: number): void;
 
 export declare function setUserId(userId: string): void;
 
-export declare function crash(): void;
+export declare function crash(): void;
+
+export declare function setCrashlyticsCollectionEnabled(enabled: boolean): void;

src/crashlytics/crashlytics.ios.ts

@@ -54,6 +54,13 @@ export function crash(): void {
   if (isCrashlyticsAvailable()) {
     Crashlytics.sharedInstance().crash();
   }
+  Fabric.with(NSArray.arrayWithObject(Crashlytics.class()));
+}
+
+export function setCrashlyticsCollectionEnabled(enabled: boolean): void {
+  if (isCrashlyticsAvailable()) {
+    Fabric.with(NSArray.arrayWithObject(Crashlytics.class()));
+  }
 }
 
 function isCrashlyticsAvailable(): boolean {

src/firebase.android.ts

@@ -319,6 +319,17 @@ firebase.init = arg => {
           appModule.android.context || com.tns.NativeScriptApplication.getInstance()
       ).setAnalyticsCollectionEnabled(arg.analyticsCollectionEnabled !== false);
 
+      // note that this only makes sense if crash reporting was disabled in AndroidManifest.xml
+      if (arg.crashlyticsCollectionEnabled && typeof (com.crashlytics) !== "undefined" && typeof (com.crashlytics.android.Crashlytics) !== "undefined") {
+        io.fabric.sdk.android.Fabric.with(
+            appModule.android.context || com.tns.NativeScriptApplication.getInstance(),
+            [new com.crashlytics.android.Crashlytics()]);
+      }
+
+      com.google.firebase.analytics.FirebaseAnalytics.getInstance(
+          appModule.android.context || com.tns.NativeScriptApplication.getInstance()
+      ).setAnalyticsCollectionEnabled(arg.analyticsCollectionEnabled !== false);
+
       if (typeof (com.google.firebase.database) !== "undefined" && typeof (com.google.firebase.database.ServerValue) !== "undefined") {
         firebase.ServerValue = {
           TIMESTAMP: firebase.toJsObject(com.google.firebase.database.ServerValue.TIMESTAMP)

src/firebase.d.ts

@@ -125,21 +125,33 @@ export interface InitOptions extends MessagingOptions {
    * Default true.
    */
   analyticsCollectionEnabled?: boolean;
+
+  /**
+   * Allow the app to collect Crashlytics data and send it to Firebase.
+   * Can also be set later with crashlytics.setCrashReportingEnabled.
+   * Only useful in case it was disabled in AndroidManfifest.xml and/or Info.plist,
+   * see https://firebase.google.com/docs/crashlytics/customize-crash-reports
+   */
+  crashlyticsCollectionEnabled?: boolean;
+
   /**
    * Allow disk persistence. Default true for Firestore, false for regular Firebase DB.
    */
   persist?: boolean;
+
   /**
    * Get notified when the user is logged in.
    */
   onAuthStateChanged?: (data: AuthStateData) => void;
+
   /**
    * Attempt to sign out before initializing, useful in case previous
    * project token is cached which leads to following type of error:
    *   "[FirebaseDatabase] Authentication failed: invalid_token ..."
    * Default false.
    */
   iOSEmulatorFlush?: boolean;
+
   /**
    * For Firebase Storage you can pass in something like 'gs://n-plugin-test.appspot.com'
    * here so we can cache it. Otherwise pass in the 'bucket' param when using Storage features.

src/firebase.ios.ts

@@ -383,6 +383,10 @@ firebase.init = arg => {
 
       FIRAnalyticsConfiguration.sharedInstance().setAnalyticsCollectionEnabled(arg.analyticsCollectionEnabled !== false);
 
+      if (arg.crashlyticsCollectionEnabled && typeof (Crashlytics) !== "undefined") {
+        Fabric.with(NSArray.arrayWithObject(Crashlytics.class()));
+      }
+
       if (!firebase._configured) {
         firebase._configured = true;
         if (typeof (FIRApp) !== "undefined") {

src/platforms/android/libraryproject/firebase/src/main/java/org/nativescript/plugins/firebase/FirebasePlugin.java

@@ -82,6 +82,8 @@ public static void setOnPushTokenReceivedCallback(FirebasePluginListener callbac
   }
 
   public static void setOnNotificationReceivedCallback(FirebasePluginListener callbacks) {
+    // TODO perhaps use this to set a badge: https://github.com/gogoout/nativescript-plugin-badge/blob/28e79f6d5614ec9b9b98bb07c67df32fdc42ba9a/src/badge.android.ts#L13
+    //  Default count=1, and perhaps pass it in via the notification payload (like on iOS)
     onNotificationReceivedCallback = callbacks;
     if (cachedNotification != null) {
       executeOnNotificationReceivedCallback(cachedNotification);